v0.13.0

What's Changed

This release adds support for schemas specifying default values, and begins validating / parsing incoming request headers. Note: this may be a breaking change if your server currently accepts requests with invalid request headers.

Features

• feat: support default values by @mnahkies in #241
• feat!: parse/validate request headers by @mnahkies in #247
• feat: include urls from servers array in basePath type by @mnahkies in #246

Docs

• docs: add compatibility tables by @mnahkies in #248

Misc

• chore(deps): update all dependencies by @renovate in #239
• chore(deps): Bump micromatch from 4.0.7 to 4.0.8 by @dependabot in #240
• chore: update dependencies and refresh data files by @mnahkies in #244
• chore: upgrade typescript by @mnahkies in #245

Full Changelog: v0.12.1...v0.13.0

v0.12.1

What's Changed

This release fixes a small typing mistake preventing queries parameters of type number[] from building properly, and fixes bugs in the handling of header parameters / defaults and the "escape hatch" parameters allowing arbitrary fetch / axios request options to be passed.

It's also the first release with automated end-to-end tests in place, though the coverage is still low - this will be improved during the course of development going forward.

Bug fixes

• fix: allow number array query param by @mnahkies in #236
• fix(fetch/axios): correctly merge headers from opts by @mnahkies in #231

Testing

• feat: add e2e test suite by @mnahkies in #235

Misc

• chore(deps): update dependency axios to v1.7.4 [security] by @renovate in #232
• chore: dependencies / refresh data by @mnahkies in #233
• chore: tweak npm metadata by @mnahkies in #234
• chore: use node 22 by default by @mnahkies in #237

Full Changelog: v0.12.0...v0.12.1

v0.12.0

What's Changed

Another small release, adding a new CLI parameter OPENAPI_REMOTE_SPEC_REQUEST_HEADERS / --remote-spec-request-headers that allows request headers to be sent when fetching specifications from remote URI's.

This makes it possible to generate from a remote URI that is behind some form of header based authentication, eg: Authorization: Bearer <bla> (which includes cookie based authentication since cookies are just a Cookie header, and basic auth as this is just Authorization: Basic <credentials>).

The headers are scoped to specific domains/urls such that you can mix and match sources without leaking tokens to the wrong servers.

Features

• feat: support remote specs with authentication by @mnahkies in #230

Misc

• chore(deps): update all dependencies by @renovate in #228

Full Changelog: v0.11.2...v0.12.0

v0.11.2

What's Changed

This is a bug fix release, solving an issue with the order schemas were output when generating from specifications that are split over multiple files, causing variable used before declaration issues.

Bug fixes

• fix: include schemas from all documents in dependency graph by @mnahkies in #227

Documentation

• fix: improve seo, use plausible by @mnahkies in #226

Full Changelog: v0.11.1...v0.11.2

v0.11.1

What's Changed

This is a bug fix release, containing a solution for #217.

Previously query parameters of an array type did not work when a single element was provided, now this will be parsed and handed to the route handler as an array of one element.

Bug fixes

• fix: support array of 1 for query parameter arrays (round 2) by @mnahkies in #225

Misc

• chore(deps): update all dependencies by @renovate in #210
• chore(deps): update all dependencies by @renovate in #221
• chore: refresh data / use new okta specs by @mnahkies in #222
• chore: update dependencies by @mnahkies in #223
• fix: peer dependency by @mnahkies in #224

Full Changelog: v0.11.0...v0.11.1

v0.11.0

What's Changed

This release contains 1 bug fix for default header handling in typescript-axios and several internal refactoring changes required to facilitate the work-in-progress documentation playground

Also dropped eslint for biome because I can't be bothered figuring out the eslint@^9 upgrade / configuration migration.

Bug fixes

• fix(axios): always apply default headers by @mnahkies in #218

Internal refactoring

• fix: make logger compatible with web by @mnahkies in #211
• fix: decouple validator from readline by @mnahkies in #212
• feat: add a prettier based formatter by @mnahkies in #213
• fix: move tsconfig loading by @mnahkies in #214
• fix: decouple typespec loader from readline by @mnahkies in #215

Misc

• chore: ditch eslint by @mnahkies in #219

Full Changelog: v0.10.0...v0.11.0

v0.10.0

What's Changed

This release is primarily bug fixes, and internal refactoring to facilitate improvements to documentation. Most effort has gone into the new documentation site live at https://openapi-code-generator.nahkies.co.nz/

It also splits the cli from the library entrypoint such that you can now import {generate} from '@nahkies/openapi-code-generator' for programmatic usage if you wish, and improves handling of boolean cli flags.

BREAKING CHANGES
There are several potentially breaking changes here:

• Dropped the "safe edit region" functionality, I doubt anyone was using this and it wasn't particularly robust
• Improved handling of additionalProperties / {} schemas to better align with the specification
• Joi validation became stricter for strings with format email / date-time

This may make some schemas / types change type to unknown, and start serializing/deserializing values that were previously stripped (see #200). If you want more permissive types (any) in these situations rather than unknown you can use the --ts-allow-any cli flag.

Bug fixes

• fix!: an {} schema should be an unknown/any type by @mnahkies in #204
• fix!: drop safe edit regions by @mnahkies in #198
• fix!: joi supports email / date-time string formats by @mnahkies in #206
• fix: improve handling of cli boolean params by @mnahkies in #205
• fix: only allow publish of releases from latest main by @mnahkies in #161

Internal refactoring

• refactor: create TypescriptFormatter class by @mnahkies in #199
• refactor: isolate filesystem interaction by @mnahkies in #201
• refactor: split cli to allow programmatic use by @mnahkies in #202

Docs

• feat: new documentation website by @mnahkies in #162
• feat: publish docs from ci, add ga to docs by @mnahkies in #163
• fix: provide a user by @mnahkies in #164
• fix: try git config by @mnahkies in #165
• fix: set url by @mnahkies in #166
• fix: move script to _app by @mnahkies in #167
• fix: replace default nextra meta descriptions by @mnahkies in #168
• docs: show typespec shell snippets, mention runtime response validation by @mnahkies in #169
• docs: move architecture into nextra site by @mnahkies in #186
• docs: update readme by @mnahkies in #187
• fix(docs): correct header level by @mnahkies in #209

Misc

• chore: upgrade dependencies / angular v18 by @mnahkies in #207
• chore: refresh data and regenerate by @mnahkies in #208
• chore: bump lerna by @mnahkies in #203
• fix: make renovate less noisy by @mnahkies in #197
• chore: Configure Renovate by @renovate in #170
• chore(deps): update dependency @azure-tools/typespec-client-generator-core to v0.41.8 by @renovate in #171
• chore(deps): update dependency @types/node to v20.12.8 by @renovate in #172
• fix(deps): update angular monorepo by @renovate in #175
• chore(deps): update dependency typescript to ~5.4.0 by @renovate in #180
• chore(deps): update dependency node to v20.12.2 by @renovate in #179
• chore(deps): update yarn to v4.2.1 by @renovate in #182
• chore(deps): update dependency zod to v3.23.6 by @renovate in #174
• chore(deps): update typescript-eslint monorepo to v7.8.0 by @renovate in #181
• fix(deps): update dependency ajv to v8.13.0 by @renovate in #183
• chore(deps): update dependency eslint-plugin-jest to v28.5.0 by @renovate in #178
• fix(deps): update dependency @biomejs/biome to v1.7.2 by @renovate in #176

New Contributors

• @renovate made their first contribution in #170

Full Changelog: v0.9.0...v0.10.0

v0.9.0

What's Changed

There are two new features in this release:

• Typespec can now be used as an input file by passing --input-type=typespec as an additional arg
• You can now use a url for your input file (openapi specs only, typespec must be local files)

Features

• feat: support typespec as an input format by @mnahkies in #158
• feat: support loading input from uri by @mnahkies in #150

Bug fixes

• fix: allow options by @mnahkies in #151

Full Changelog: v0.8.0...v0.9.0

v0.8.0

What's Changed

There are three main features in this release:

• Improve json schema validation support for string, number, array (min / max / etc)
• Make boolean schema validation stricter
• Start using a pre-compiled ajv validator for better performance

BREAKING CHANGES
Previously any truthy value would be accepted for a boolean, eg: any-string would parse to true. Now its parsed like:

• true | "true" | 1 -> true
• false | "false" | 0 -> false
• anything else -> error

Features

• feat: support minimum / maximum for numbers by @mnahkies in #140
• feat: use pre-compiled ajv validators at runtime by @mnahkies in #141
• feat: joi number min/max validation by @mnahkies in #143
• feat: support exclusive min/max and multipleOf by @mnahkies in #144
• feat: support string validation by @mnahkies in #145
• fix!: stricter booleans by @mnahkies in #146
• feat: support basic array validation by @mnahkies in #147

Misc

• chore(deps): Bump follow-redirects from 1.15.5 to 1.15.6 by @dependabot in #136
• chore(deps): Bump webpack-dev-middleware from 5.3.3 to 5.3.4 by @dependabot in #137
• chore(deps): Bump express from 4.18.3 to 4.19.2 by @dependabot in #138
• chore: deps by @mnahkies in #139
• chore: refresh data by @mnahkies in #142
• chore: bump deps by @mnahkies in #149

Full Changelog: v0.7.0...v0.8.0

v0.7.0

What's Changed

Features

• feat: experimental support for splitting code by tags / route segments by @mnahkies in #134
• feat: eliminate unused imports by @mnahkies in #132
• feat: use strict typescript settings by @mnahkies in #131
• feat: adopt biome for code formatting by @mnahkies in #129

Misc

• chore: update dependencies by @mnahkies in #133
• chore(deps): Bump ip from 2.0.0 to 2.0.1 by @dependabot in #130

Full Changelog: v0.6.0...v0.7.0