CHANGELOG.md

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

0.18.0 (2024-12-22)

Bug Fixes

• client-sdks: handle 204 empty responses with runtime validation (#288) (d3be20e), closes #285

• intersected union schemas (#283) (2a610c5), closes #282

• typescript-fetch: runtime validation works (#287) (cead53a), closes #286

• fix(joi)!: switch from @hapi/joi to joi (#284) (6693e1d), closes #284

• fix(typescript-axios)!: remove unused exports (#281) (7b34fd4), closes #281

• feat(typescript-fetch)!: simplify response types (#280) (4340caf), closes #280

BREAKING CHANGES

• peerDependency changed to joi for users of --schema-builder joi
• unused symbols Res and StatusCode dropped from typescript-axios-runtime
• TypedFetchResponse is removed, use Res directly if needed

0.17.0 (2024-12-11)

Bug Fixes

• support exactOptionalPropertyTypes on client SDKs (#278) (5483b12), closes #131

• fix!: angular modules have unique export names (#270) (2d4d43b), closes #270

Features

• defaultHeaders is optional (#274) (fc7cc62)
• support http verb 'head' (#271) (4841fed)
• support servers at path / operation level + variables (#272) (969ca68)

BREAKING CHANGES

• angular service exports suffixed with Service

0.16.0 (2024-11-02)

Bug Fixes

• format/emit in parallel (#265) (8f9c009)

• feat!: dynamic filename conventions / no spaces in filenames (#259) (c6a72b5), closes #259

Features

• safer identifier transformation (#260) (2bad95c)
• unique client export names (#263) (205ee94), closes #259

BREAKING CHANGES

• emitted filenames may change if not already in kebab-case format. Use --filename-convention if an alternative convention such as camel-case is preferred.

0.15.0 (2024-10-27)

Bug Fixes

• docs: improve meta tags (#255) (345b0d8)
• validator uses new yaml sources (a41dbd4)

Features

• emit unique symbol names for Implementation / createRouter functions (#258) (390bf7d), closes #111
• support emitting abstract classes for implementation types (#256) (d2b8276)

0.14.0 (2024-10-12)

Bug Fixes

• allow $ref to be used as a schema property (#250) (9c09191)
• docs: use absolute url for og:image (#253) (d704219)
• handle type: "null" in anyOf / oneOf / allOf (#252) (9713c96)

Features

• support loading relative remote uris (#254) (4dc855c), closes #43

0.13.0 (2024-09-20)

• feat!: parse/validate request headers (#247) (682d0c9), closes #247

Features

• include urls from servers array in basePath type (#246) (212c434)
• suppport default values (#241) (6127cc8)

BREAKING CHANGES

• requests receiving incorrect request header parameters will now fail with a validation error

0.12.1 (2024-08-17)

Bug Fixes

• allow number array query param (#236) (3ace597), closes #235
• fetch/axios: correctly merge headers from opts (#231) (5efc36e)

Features

• add e2e test suite (#235) (9209a3f)

0.12.0 (2024-08-05)

Features

• support remote specs with authentication (#230) (5beee35), closes #229

0.11.2 (2024-07-29)

Bug Fixes

• improve seo, use plausible (#226) (e32afd5)
• include schemas from all documents in dependency graph (#227) (5fa614d)

0.11.1 (2024-07-27)

Bug Fixes

• peer dependency (#224) (ea0d044), closes #223

0.11.0 (2024-06-08)

Bug Fixes

• axios: always apply default headers (#218) (9177ae0)
• decouple typespec loader from readline (#215) (6678381), closes #212
• decouple validator from readline (#212) (8d37c0b)
• make logger compatible with web (#211) (204b6a8)
• move tsconfig loading (#214) (48526f3)

Features

• add a prettier based formatter (#213) (8b0c015)

0.10.0 (2024-05-25)

Bug Fixes

• an {} schema should be an unknown/any type (#204) (b56ac4f), closes #200
• deps: update angular monorepo (#175) (245f62a)
• deps: update dependency @biomejs/biome to v1.7.2 (#176) (f754a4a)
• deps: update dependency ajv to v8.13.0 (#183) (a215cd1)
• docs: correct header level (#209) (e22bc24)
• improve handling of cli boolean params (#205) (24cd899)
• joi supports email / date-time string formats (#206) (1981108)
• make renovate less noisy (#197) (88d0a57)
• move script to _app (#167) (04bf9bb)
• only allow publish of releases from latest main (#161) (8f2d698)
• provide a user (#164) (a935611)
• replace default nextra meta descriptions (#168) (4c8bf6c)
• set url (#166) (6c62f65), closes /github.com/tschaub/gh-pages/issues/384#issuecomment-1236047843
• try git config (#165) (b6a6715)

Features

• new documentation website (#162) (ba002cf)
• publish docs from ci, add ga to docs (#163) (f935bb5)

0.9.0 (2024-04-27)

Bug Fixes

• allow options (#151) (5d45385)

Features

• support loading input from uri (#150) (cce87ba), closes #43
• support typespec as an input format (#158) (b1cdbf4), closes #148

0.8.0 (2024-04-07)

Features

• joi number min/max validation (#143) (179ea58), closes #140
• support basic array validation (#147) (1dcb0a8), closes /datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6
• support exclusive min/max and multipleOf (#144) (0f473bd), closes #140 #143 #51 /datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6
• support minimum / maximum for numbers (#140) (21f2a76), closes #51
• support string validation (#145) (1602764), closes /datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#section-6 /github.com/nodejs/node/issues/2503#issuecomment-133842814
• use pre-compiled ajv validators at runtime (#141) (5439e9d)

0.7.0 (2024-03-03)

Features

• adopt biome for code formatting (#129) (b75bc65)
• eliminate unused imports (#132) (c3d87ce)
• experimental support for splitting code by tags / route segments (#134) (9a23e4f)
• use strict typescript settings (#131) (39758e2), closes #129

0.6.0 (2024-02-19)

Features

• improve additional properties support (#126) (7a8c289), closes #125 #44
• support response validation for joi (#127) (30f22a8), closes #112

0.5.0 (2024-02-10)

Bug Fixes

• use RouterContext rather than plain Context (a13c1b7)

Features

• client generators support experimental runtime response validation (#112) (f3c3610), closes #82
• experimental support for extracting inline schemas (#123) (1c11d77)

0.4.0 (2024-01-05)

Bug Fixes

• incorrect .d.ts path for zod (#119) (f0d737d), closes #117
• koa: don't camel-case route placeholders (#120) (59e1438), closes #118 #118

Features

• typescript-koa: introduce optional "respond" pattern (c6595a1)

0.3.0 (2023-12-02)

Bug Fixes

• decouple schema builders from typescript-koa (#113) (f75a80c), closes #112

• feat!: throw discriminable errors indicating point of failure (#95) (4badd41), closes #95 /github.com/mnahkies/openapi-code-generator/pull/95/files#diff-b82e27c39ae18163c6d5547d0bf1c5dd9a92302ae047f160a76ea0c7af5ad7b0

Features

• add typescript-axios template (#83) (c3e045d)
• include schema builder in client generators (#114) (9beb268), closes #112

BREAKING CHANGES

• ** errors thrown are now wrapped in KoaRuntimeError objects.

0.2.0 (2023-11-12)

Bug Fixes

• allow numeric header values (#105) (7feab98)
• handle " in string enum values (#107) (5b2c341), closes /github.com/APIs-guru/openapi-directory/blob/dec74da7a6785d5d5b83bc6a4cebc07336d67ec9/APIs/vercel.com/0.0.1/openapi.yaml#L4810
• handle null in enums (#106) (b235a7e), closes /github.com/APIs-guru/openapi-directory/blob/dec74da7a6785d5d5b83bc6a4cebc07336d67ec9/APIs/vercel.com/0.0.1/openapi.yaml#L4648-L4655
• optional oneOf / allOf / anyOf / $ref's (#110) (2ff114a)
• skip broken openapi 3.1 validation for now (#104) (f6e7956), closes #103
• use numerical enums when creating zod schema (#108) (7564c10), closes /github.com/colinhacks/zod/issues/2686#issuecomment-1807096385

Features

• basic support for openapi 3.1 (#109) (60838d9)

0.1.1 (2023-11-11)

Bug Fixes

• avoid warning for non-nullable paths (#90) (b857182)
• delete files missed in #92 (#93) (9ccdd50)
• don't coerce strings (e579295)
• unused imports (#97) (c2a0ae5)

0.1.0 (2023-10-01)

Bug Fixes

• avoid type conflict between jasmine and mocha (bc471ca)
• dependency graph handles oneOf allOf nesting (#73) (52ca608)
• eslint disable in generated files (#30) (1ee33c4), closes /eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1
• implicit any (74952a7)
• improve null support (#40) (c2c3c1f)
• improve support for nullable types (#33) (bedfee0)
• improve validation to switch between 3.1.0 / 3.0.0 (#34) (915456f)
• lint (fe704fa)
• lint errors (92a69a8)
• logger goes straight to stdout/stderr (0c39a04)
• master -> main (#77) (dade840)
• plumb through middleware (#80) (d02813e)
• remove broken functionality (#78) (3e5dad1)
• remove unused, tidy ups (0be1033)
• replace . in identifiers (#50) (ac4ce9b)
• request bodies can be optional (#24) (810619c)
• respect optional $ref properties (#22) (32e80d8)
• share requestBodyAsParameter implementation (2f7477b)
• stop angular integration tests building with packages (feb776d)
• surface status code -> body relationship in angular template (#63) (7b1ffe9)
• switch to qs and add tests for query string (#56) (dbcec86)
• try using wildcard version to work around lerna publish bug (#84) (e35abac)
• typescript-fetch mostly generating (e798731)
• typescript-fetch: omit optional query params (#2) (fd10e9b)
• use built-in / global fetch (44eb83e)
• use long form if (f9b5af4)
• use merge instead of intersection (#28) (062455a)
• use request body (#32) (c0eba77)

Features

• add script consuming github fetch client (#4) (a22d835)
• better support for additional properties (#57) (e69881b)
• clients default params to {} when none are required (#36) (1ffdc52)
• config flag to switch schema parser (#39) (336e923), closes #13
• fetch client supports abort signals (#65) (e646771)
• improve client generation (#35) (48a806a)
• initial support for anyOf (#55) (a61cbb9), closes #46
• initial support for oneOf (#23) (1619bf7)
• move more static code into koa runtime (#21) (0b175af)
• move static code to normal files (#20) (2897680)
• new approach to server stubs (#9) (aff4835)
• order schemas correctly (#37) (9f899dd)
• overhaul docs / publish to npm (#75) (f9386ab)
• response body validation and types (#29) (ffc8f20), closes #11
• rework input schema parsing (#25) (7bae0ad)
• support circular references (#58) (48f8d89), closes #49
• support loading from literal (5e47ed0)
• support string enums in zod parsing (efe2e2e)
• support zod for parsing inputs (e0c1b88)
• use commander for cli args for better ux (#76) (26d7401)
• zod schema builder supports allOf (#27) (b09fcc9)