Skip to content

CHANGELOG.md

Latest commit

 

History

History
1172 lines (633 loc) · 52.8 KB

CHANGELOG.md

File metadata and controls

1172 lines (633 loc) · 52.8 KB

openapi-typescript

7.14.0

Minor Changes

Patch Changes

  • #2415 f55fb72 Thanks @remy90! - Support additionalProperties: true on string enums by generating a loose autocomplete union ((enum literals) | (string & {})), preserving editor suggestions while still accepting arbitrary string values.

7.13.0

Minor Changes

  • #2549 a690e52 Thanks @abumalick! - Add readOnly/writeOnly support via --read-write-markers flag. When enabled, readOnly properties are wrapped with $Read<T> and writeOnly properties with $Write<T>. openapi-fetch uses Readable<T> and Writable<T> helpers to exclude these properties from responses and request bodies respectively.

7.12.0

Minor Changes

Patch Changes

  • #2536 e3c05a4 Thanks @darkbasic! - Fix enumValues: true output for schemas that use oneOf/anyOf unions by narrowing union types with Extract<> before accessing variant-specific properties. This prevents invalid type paths when an accessed property only exists on some union members.

7.11.0

Minor Changes

7.10.2

Patch Changes

  • #2139 12f9c29 Thanks @darkbasic! - All kinds of enum related fixes (enums in arrays, in optional props, in unions, in request body, with record types...)

  • #2548 4385590 Thanks @mynnx! - Fixes the --redocly flag so that it no longer hangs and is able to lookup the Redocly file at a custom path

7.10.1

Patch Changes

7.10.0

Minor Changes

7.9.1

Patch Changes

7.9.0

Minor Changes

7.8.0

Minor Changes

7.7.3

Patch Changes

7.7.2

Patch Changes

7.7.1

Patch Changes

  • #2260 7205e12 Thanks @zrosenbauer! - Prevents a TypeError due to a bad in operator for type: "array" when a boolean is set on items

7.7.0

Minor Changes

Patch Changes

7.6.1

Patch Changes

7.6.0

Minor Changes

7.5.2

Patch Changes

7.5.1

Patch Changes

7.5.0

Minor Changes

7.4.4

Patch Changes

7.4.3

Patch Changes

7.4.2

Patch Changes

7.4.1

Patch Changes

7.4.0

Minor Changes

7.3.3

Patch Changes

  • #1877 94592a4 Thanks @phk422! - fix: replace special characters using SPECIAL_CHARACTER_MAP for duplicate-identifiers

7.3.2

Patch Changes

  • #1867 21fb8b0 Thanks @phk422! - fix(openapi-typescript): type errors generated under enumValues

7.3.1

Patch Changes

7.3.0

Minor Changes

7.2.0

Minor Changes

7.1.2

Patch Changes

7.1.1

Patch Changes

  • #1784 c2f8655 Thanks @yoshi2no! - Fix: Correct handling of identical minItems and maxItems in array schemas when arrayLength option is true

7.1.0

Minor Changes

Patch Changes

7.0.4

Patch Changes

  • #1746 e705909 Thanks @phk422! - fix: Correct handling of default parameter values in referenced component schema

7.0.3

Patch Changes

  • #1761 8043c5d Thanks @yoshi2no! - fix: Enum option cannot generate enums if values are not valid property names

7.0.2

Patch Changes

7.0.1

Patch Changes

7.0.0

Major Changes

  • 6d1eb32 Thanks @drwpow! - ⚠️ Breaking: The Node.js API now returns the TypeScript AST for the main method as well as transform() and postTransform(). To migrate, you’ll have to use the typescript compiler API:

    + import ts from "typescript";

+ const DATE = ts.factory.createIdentifier("Date");
+ const NULL = ts.factory.createLiteralTypeNode(ts.factory.createNull());

  const ast = await openapiTS(mySchema, {
    transform(schemaObject, metadata) {
      if (schemaObject.format === "date-time") {
-       return schemaObject.nullable ? "Date | null" : "Date";
+       return schemaObject.nullable
+         ? ts.factory.createUnionTypeNode([DATE, NULL])
+         : DATE;
      }
    },
  };

    Though it’s more verbose, it’s also more powerful, as now you have access to additional properties of the generated code you didn’t before (such as injecting comments).

    For example syntax, search this codebae to see how the TypeScript AST is used.

    Also see AST Explorer’s typescript parser to inspect how TypeScript is interpreted as an AST.

  • 6d1eb32 Thanks @drwpow! - ⚠️ Breaking: Changing of several CLI flags and Node.js API options

    • The --auth, --httpHeaders, --httpMethod, and fetch (Node.js-only) options were all removed from the CLI and Node.js API
    • --immutable-types has been renamed to --immutable
    • --support-array-length has been renamed to --array-length

  • fbaf96d Thanks @drwpow! - ⚠️ Breaking: Remove globbing schemas in favor of redocly.yaml config. Specify multiple schemas with outputs in there instead. See Multiple schemas for more info.

  • 6d1eb32 Thanks @drwpow! - ⚠️ Breaking: Most optional objects are now always present in types, just typed as :never. This includes keys of the Components Object as well as HTTP methods.

  • 6d1eb32 Thanks @drwpow! - ⚠️ Breaking: No more external export in schemas anymore. Everything gets flattened into the components object instead (if referencing a schema object from a remote partial, note it may have had a minor name change to avoid conflict).

  • 6d1eb32 Thanks @drwpow! - ⚠️ Breaking defaultNonNullable option now defaults to true. You’ll now need to manually set false to return to old behavior.

  • 799194d Thanks @drwpow~ - ⚠️ Breaking TypeScript is now a peerDependency and must be installed alongside openapi-typescript

Minor Changes

  • 6d1eb32 Thanks @drwpow! - ✨ Feature: automatically validate schemas with Redocly CLI (docs). No more need for external tools to report errors! 🎉

    • By default, it will only throw on actual schema errors (uses Redocly’s default settings)
    • For stricter linting or custom rules, you can create a redocly.yaml config

  • 312b7ba Thanks @drwpow! - ✨ Feature: allow configuration of schemas via apis key in redocly.config.yaml. See docs for more info.

  • 6d1eb32 Thanks @drwpow! - ✨ Feature: add enum option to export top-level enums from schemas

  • 6d1eb32 Thanks @drwpow! - ✨ Feature: add formatOptions to allow formatting TS output

  • 6d1eb32 Thanks @drwpow! - ✨ Feature: header responses add [key: string]: unknown index type to allow for additional untyped headers

  • 6d1eb32 Thanks @drwpow! - ✨ Feature: bundle schemas with Redocly CLI

  • 6d1eb32 Thanks @drwpow! - ✨ Feature: Added debugger that lets you profile performance and see more in-depth messages

  • #1374 7ac5174 Thanks @ElForastero! - Add support for x-enum-varnames and x-enum-descriptions

  • #1545 9158b81 Thanks @jaredLunde! - Replace # characters in operation IDs with a slash

Patch Changes

  • 6d1eb32 Thanks @drwpow! - Refactor internals to use TypeScript AST rather than string mashing

  • 6d1eb32 Thanks @drwpow! - 🧹 Cleaned up and reorganized all tests

  • #1602 9da96cd Thanks @JeanRemiDelteil! - Do not add readonly on Typescript enum when the --immutable option is used.

6.7.0

Minor Changes

6.6.2

Patch Changes

6.6.1

Patch Changes

6.6.0

Minor Changes

6.5.5

Patch Changes

6.5.4

Patch Changes

  • #1324 0357325 Thanks @drwpow! - Fix accidental quote appearing in components/responses with $refs

6.5.3

Patch Changes

6.5.2

Patch Changes

6.5.1

Patch Changes

  • #1308 ebb73b6 Thanks @drwpow! - Fix bugs with remote $refs, add cwd option for JSON schema parsing

6.5.0

Minor Changes

6.4.5

Patch Changes

  • #1280 50441d0 Thanks @pvanagtmaal! - Fix invalid typescript for empty request bodies, fix headers being left out when response body is omitted

  • #1289 7f452fa Thanks @adamschoenemann! - Fixed a bug where references to types with discriminators with implicit mappings would generate incorrect types

6.4.4

Patch Changes

6.4.3

Patch Changes

6.4.2

Patch Changes

6.4.1

Patch Changes

6.4.0

Minor Changes

6.3.9

Patch Changes

6.3.8

Patch Changes

6.3.7

Patch Changes

6.3.6

Patch Changes

6.3.5

Patch Changes

6.3.4

Patch Changes

6.3.3

Patch Changes

  • #1200 4fc8c20 Thanks @toomuchdesign! - Remove unexpected empty string in generated nullable polymophic enum types (["string", "null"])

6.3.2

Patch Changes

6.3.1

Patch Changes

6.3.0

Minor Changes

Patch Changes

6.2.9

Patch Changes

6.2.8

Patch Changes

6.2.7

Patch Changes

6.2.6

Patch Changes

6.2.5

Patch Changes

  • 7d09c3b: Support nested path parameters in --path-params-as-types (#1130). Thanks, barakalon!

6.2.4

Patch changes

  • Fix remote $refs to complete schemas (#1087)
  • Fix incorrect check for protocol by @happycollision (#1088)
  • Fix missing parameters in operation object (#1090)

6.2.3

Patch changes

6.2.2

Patch changes

  • Fix path generation by @HiiiiD (#991)
  • If no type is specified, type as unknown by @mitchell-merry (#1049)
  • Ensure not required parameters are created as optional properties by @AplusKminus (#1053)
  • Fix missing type defs (#1072)
  • Deduplicate unions by @mitchell-merry (#1069)
  • Fix tuples type generation support by @liangskyli (#1011)

6.2.1

Patch changes

  • Fix $ref’d parameters missing (#1061)
  • Fix oneOf number const (#1056) by @qnp

6.2.0

Minor changes

  • New --empty-objects-unknown flag for better control over unspecified object types’ default shape by @duncanbeevers (#1032)

Patch changes

  • JSDoc improvements by @mitchell-merry (#1029)
  • Fix readonly nullable properties by @mtth (#1036)
  • Tiny QoL improvements to invalid schema errors (#1043)

6.1.1

Patch changes

  • Fix response key for HTTP ranges (#1010) @stefanmaric
  • Escape constant string in generated schema (#1014) @mvdbeek
  • Support fully-qualified refs as discriminator mapping values (#1017) @sgrimm
  • Improve behavior of allOf + required properties (#1027) @Swiftwork
  • Make params non-nullable even if all params are optional (#1022) @sgrimm

6.1.0

Minor changes

  • Adds webhook typings by @yacinehmito (#1001)
  • Use undici’s fetch() instead of request() which can be overridden locally by @yacinehmito (#1002)
  • Adds type helpers only when used by @imagoiq (#992)

Patch changes

  • Fixes bug in glob output by @BTMPL (#999)
  • Fixes header casing by @HiiiiD (#990)
  • Fixed multiple causes of bug #988 “cannot read properties of undefined” by @HiiiiD and @yacinehmito (#990 and #1002)

6.0.3

Patch changes

  • Fixed nullable: true (#983)
  • Fixed additionalProperties bug (#983)

6.0.2

Patch changes

  • Fixes #975 where #/components/examples were being parsed as schema objects

6.0.1

Patch changes

  • Remove postinstall hook only meant for dev

6.0.0

⚠️ Breaking changes

  • Dropped Prettier formatting and all formatting options. Now, simply format at your discretion (or not at all!)
  • Dropped support for Swagger 2.0
  • Dropped Node 14 support (it still works for now, but Node 14 bugs won’t be fixed if any arise)
  • --version was changed to return the version of this library (also by dropping Swagger 2.0 support the old usage was no longer needed)
  • Dropped --raw-schema. Your entry schema MUST be valid and complete (however, your $refs to subschemas may be partials).
  • Dropped --make-paths-enum because it was incompatible with --path-params-as-types
  • Dropped the CLI aliases -it and -ap (specify the full --immutable-types or --additional-properties flag)
  • Empty content: {} now returns never. Dropped the --content-never flag as this is now the default behavior.
  • Renamed and upgraded the Node API’s formatter() function to transform() and postTransform(). It’s an overall improvement on the original concept with even more power than before.

Major changes

  • Sped up type generation by 3× by dropping Prettier & optimizing deep-object crawl speed
  • OpenAPI 3.1 support for discriminator and polymorphic types
  • Complete codebase rewrite and cleanup
  • Now ships modern ESNext code rather than ES2018
  • Improved internal types & documentation
  • Test cleanup, now powered by Vitest
  • New transform() and postTransform() hooks give you more control in overriding/extending generated types

Minor changes

  • More accurate types for oneOf / anyOf / allOf (#894)
  • --immutable-types has a new -t alias
  • Addition of path.default types
  • Support nullable as type arrays for OpenAPI 3.1 (#898)

Patch changes

  • Fixed multiple bugs with deep-linked remote schemas and complex $refs
  • Fixed anyOf intersections resulting in unexpected type signatures
  • Fixed [string, null] generating as unknown
  • Fixed { property: unknown; } with allOf union
  • Fixed requestBody missing content property
  • Fixed headers missing remote $refs

5.4.0

Minor changes

  • New --content-never flag forces never response body by @duncanbeevers (#905)

Patch changes

  • Empty strings are now allowed for properties like @default by @duncanbeevers (#906)
  • Throws friendlier error on bad --prettier-config path by @duncanbeevers (#909)
  • Objects are now allowed for properties like @default by @duncanbeevers (#910)
  • Fixes enum export of operation paths by @duncanbeevers (#912)

5.3.0

Minor changes

  • New --make-paths-enum CLI flag by @berzi (#883)
  • New --path-params-as-types CLI flag by @Powell-v2 (#891)
  • Supports /** @constant */ JSDoc comments by @PhilipTrauner (#896)
  • You can now add your own custom comment header at the top of every generated doc (#904)

Patch changes

  • Fixes inconsistent comment title (#904)

5.2.0

Minor changes

  • The --export-type flag was added to generate type instead of interface by @dominikdosoudil (#868)
  • Updated schemas & examples

Patch changes

  • Tiny optimizations for a little speed boost (#881)
  • Fixes CommonJS error for undici on older versions of Node (#879)

5.1.1

Patch changes

  • Removes CJS version from npm (to use CJS, use openapi-typescript@4). Version 5 switched to ESM as default anyway, and since tests are now testing ESM, the reliability of CJS was dubious (and there were TypeScript problems as well)
  • Fixes type error when using TypeScript nightly (#847)
  • Patches security vulnerability with node-fetch (by replacing with undici)

5.1.0

Minor changes

Patch changes

  • Fixes a syntax error caused by an empty oneOf by @sadfsdfdsa (#830)

5.0.1

Patch changes

  • Adds missing types for CJS build (#861)

5.0.0

⚠️ Breaking changes

  • 5.x drops support for Node 12. If you’re still on Node 12, be sure to lock your version to 4.x.

Major changes

  • Updates this library to full ESM! ✨ This is the future of JavaScript, and is now natively supported in Node 14+.

Minor changes

  • Now supports a URL() as input to make ESM usage easier (see example)

4.5.0

Minor changes

  • Significantly-enhanced JSDoc output by @sadfsdfdsa (#797)

4.4.0

Minor changes

  • Adds TypeScript @deprecated comment to deprecated schema objects by @bunkscene

4.3.0

Minor changes

  • In many areas, changed out any with unknown (#769). See #554 for more explanation / context

Patch changes

  • An old bug is now gone! openapi-typescript would incorrectly generate { [key: string]: unknown } for a type when it may have been a string or number. Now it will generate a more generic unknown type, unless it knows it’s dealing with an object for sure.

4.2.0

Minor changes

  • Reference arbitrary data on generated types via the properties key by @Peteck (#626)

4.1.1

Patch changes

  • Fixes the remote schema URL cache being too long-lived by @mbelsky (#708)

4.1.0

Minor changes

  • New --headersObject and --headers CLI flags by @ericzorn93 (#764)

Patch changes

  • "type": "file" no longer generates unexpected results (#766)

4.0.2

Patch changes

  • Loading in-memory schemas through the JS API resulted in broken $refs (#689)

4.0.1

Patch changes

  • Fixes properties + anyOf with only required properties by @gr2m (#643)

4.0.0

⚠️ Breaking changes

  • The Node.js API now returns a promise, and can no longer be run synchronously (a necessity because resolving remote schemas can never be synchronous). Other than that, there are no other breaking changes. CLI users are unaffected, and the types generated are backwards-compatible with previous versions.

Major changes

  • Now supports remote references ($ref: "remote.yaml#/components/schemas/User) 🎉 (#602)!

3.4.1

Patch changes

  • Fix glob accidentally generating empty folders alongside single-file schemas (#633)

3.4.0

Minor changes

  • Adds glob support thanks to @sharmarajdaksh (#615)
  • Reverts #613 and adds a --default-non-nullable flag (#631)

3.3.1

Patch changes

  • Schema objects that have a default: property shouldn’t be marked as nullable (#613)

3.3.0

Minor changes

  • Changes default behavior of #585 to require an opt-in --additional-properties flag (#607)
  • Adds -c shortcut alias for --prettier-config (#607)
  • Adds -it shortcut alias for --immutable-types (#607)

3.2.4

Patch changes

  • additionalProperties now default to true per the OpenAPI 3.0 spec by @mehalter (#583)

3.2.3

Patch changes

  • Fixed a parse error on enum: [] (#563)
  • Fixed another parse error on responses missing schemas (#565)
  • Fixed a bug with the latest version of Prettier and options.prettierConfig (#566)

3.2.2

Patch changes

  • RequestBodies that had hyphens in their name would generate an error (#550). Thanks (again), @ashsmith!

3.2.1

Patch changes

  • Fixed an issue where a comment within a schema definition would break type gen (#548). Thanks, @ashsmith!

3.2.0

Minor changes

Patch changes

  • The operations interface inherits parameters properly by @henhal (#530)

3.1.2

Patch changes

  • Fixes package types for TypeScript projects (#520)

3.1.1

Patch changes

  • Better handles remote schema content types (#516)

3.1.0

Minor changes

  • Remote schema loading now follows redirects (#510)
  • New --auth flag to access private schemas (#508)
  • npm version now ships with ESM package exports for better interop between ESM & CommonJS (#509)

Patch changes

  • Fixes an OpenAPI V2 parameter bug by @yamacent (#489)

3.0.4

Patch changes

  • If using OpenAPI 2.0, and you didn’t have definitions, an unexpected error was encountered. This is now fixed.

3.0.3

Patch changes

  • Improves handling of complex oneOf by @gr2m (#491)

3.0.2

Patch changes

  • Fixed requestBodies transform by @radist2s (#474)
  • Fixed enum bug containing null by @FedeBev (#492)

3.0.1

Patch changes

  • Fixed generation bug where responseBodies that contained both a $ref and operationId generated invalid TypeScript (#464)

3.0.0

Major changes

  • This is marked as a breaking version for safety. Swagger v2 users should be able to migrate to 3.0.0 with no problems; OpenAPI v3 users will either experience no changes or minor changes that should be an overall improvement.

Minor changes

  • Adds long-requested paths support to Swagger v2 schemas
  • Adds more compact comments, resulting more readable generated types

Patch changes

  • Fixes bugs in paths generation (missing $refs support in areas, inconsistent generation)

2.5.0

Minor changes

  • Comments can now be single-line, saving some needed space in the specs (#443)

Patch changes

  • additionalProperties.oneOf is now generating as expected (#442)

2.4.2

Patch changes

  • Fixes paths.requestBody.content possibly missing by @robertmassaioli (#369)
  • Fix: check if path item is method operation by @rendall (#366)

2.4.1

Patch changes

  • escape quotes in enum string values by @gr2m (#365)

2.4.0

Minor changes

  • Add operations interface by @gr2m (#353)

2.3.4

Patch changes

  • Allow $ref: 'foo.yaml#bar' syntax, but cast to any type (TODO: full external schema support) (#354)

2.3.3

Patch changes

  • $refs in paths now respect optional parameters (#352) by @gr2m

2.3.2

Patch changes

  • Handle parameters on paths as well as methods by @samdbmg (#347)

2.3.1

Patch changes

  • Set index type to all possible values (#348)

2.3.0

Minor changes

  • requestBody and $ref-type parameters added in response types by @gr2m

🐣 Minor Changes

  • responses without content schemas changed from any to never or unknown by @gr2m

2.2.0

Minor changes

  • New name! Now published at openapi-typescript.
  • Added paths support (#328)

2.1.0

Minor changes

  • Support for components.responses (#258)
  • Adds tuple support (#293)

Patch changes

  • Fix missing port bug (#252)
  • additionalProperties interpolation, primitive enums (#266)
  • bubble up the error message / improve error message when failing to parse the schema (#269)
  • Improve error message when server is unreachable (#288)

2.0.0

Major changes

  • OpenAPI 3.0 support (#223)
  • Schema names are no longer transformed (e.g. UserRole is now definitions['user']['role']). See README for migration instructions. (#223)
  • Flags with “deprecated” warnings in 1.x were dropped and no longer work (#223)

Minor changes

  • Adds support for JSDoc comments (#223)
  • Support for null values (#223)
  • Improves Prettier config resolution (#224)
  • Improves array and object handling (#226)

1.7.1

Patch changes

  • Now handles the @ character in namespaces thanks to @sorin-davidoi 🎉
  • Updates Prettier to 2.0

1.7.0

Minor changes

  • Swagger v3 is no longer unsupported! 🎉 But it’s in beta. Which means errors will probably arise. Please test it out on your existing v3 schema, and file any bugs here.
  • The --swagger flag is now deprecated; this library will automatically parse the version from the schema.

Minor changes

  • Fixes a bug where additionalProperties weren’t respected for nested properties (#92).

1.6.2

  • Fixes an issue where --camelcase wouldn’t camelCase $refs properly

1.6.1

Patch changes

  • Fixes a bug where a definition with a missing type would be skipped, rather than assume it’s an object like Swagger does by default.

1.6.0

Minor changes

  • Adds Property mapper function (see README) that supports x-nullable and other properties by @atlefren (#118)

1.5.0

Minor changes

  • Convert names containing spaces to use underscores (#75) thanks to @svnv

1.4.0

Minor changes

1.3.1

Patch changes

  • Fix nested arrays (#54)

1.3.0

Minor changes

  • The --nowrapper flag was added to the CLI, courtesy of @scvnathan (#33). Now you don’t have to wrap your interfaces if you don’t want to!

1.2.2

Patch changes

  • This fixes underscores from accidentally appearing in some TypeScript interface names (#29)

1.2.1

Patch changes

  • Swagger properties in kebab-case would break generation unless they were converted to --camelcase (#13). This has been fixed! 🎉 You still have the option of converting to --camelcase, but now you can keep kebab-case too if needed

1.2.0

Minor changes

  • Adds --wrapper option, letting you specify any namespace or module wrapper for exporting types. See the README for full description

⚠️ Breaking changes

  • --namespace and --export options are now deprecated, in favor of the more versatile --wrapper

1.1.3

Patch changes

  • Now supports an --export option to export namespaces thanks to @tpdewolf

1.1.2

Patch changes

  • No longer generates empty interfaces (caused by top-level definitions being array types, referencing other definitions)

1.1.1

Patch changes

  • Improves enum generation to be simpler-to-use (values are now just hardcoded inline, rather than trying to use TypeScript enums).

1.1.0

Major changes

  • Changes default behavior to preserve snake_case properties (you can still convert with --camelcase)

Minor changes

0.3.1

Patch changes

  • Falls back to object if it can’t grab properties

0.3.0

Minor changes

  • Different API, now requires namespace as 2nd parameter. Because namespacing is good.

Patch changes

  • Maybe a bug; maybe not—if a Swagger spec had a common name like Error it would break your build if another type extended from it

0.2.1

Patch changes

  • Fixes bug where number enums names could be generated.

0.2.0

Minor changes

  • Supports TypeScript enums

0.1.0

Minor changes

  • Exists