20 Jun 03:48

drwpow

d7494ba

[email protected]

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
  - To migrate, you’ll need to create a redocly.yaml config that specifies your auth options in the http setting
  - You can also set your fetch client in redocly.yaml as well.
- --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.
- Any options passed into your redocly.yaml config are respected
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.

Assets 2

20 Jun 03:47

github-actions

[email protected]

b43f815

[email protected]

Minor Changes

⚠️ Breaking Change: openapi-typescript@7 is needed to work. You’ll get type errors with openapi-typescript@6 and below.
⚠️ Breaking Change: The Middleware API has changed to be an object rather than (request, options) or (response, options). See Middleware docs for updated API.
⚠️ Breaking Change: The Content-Type header is no longer sent by default if a body payload is attached.
⚠️ Breaking Change: The customFetch type now calls fetch(input: string, init: RequestInit) and the types have been updated, rather than fetch(input: Request) introduced in 0.9.0. Edit: this has been reverted due to errors reported in some environments. The 0.9.0 behavior is still present where fetch(input: Request) is called for the final request.
⚠️ Breaking Change: the error type no longer is a union of all possible values; it will take the first it finds (due to some error type in some schemas being missing or incomplete, resulting in an unresolvable union)

Patch Changes

Added id to middleware handlers that create a unique ID per-fetch

Assets 2

19 Jun 19:59

drwpow

[email protected]

41ea873

[email protected]

Patch Changes

#1697 e77ce50 Thanks @armandabric! - Expose original request on Middleware.onResponse

Assets 2

24 May 17:41

drwpow

[email protected]

467f19d

[email protected]

Patch Changes

#1648 37885c2aec15d406720c5457da5bcaf7a142ab75 Thanks @nzapponi! - Fix SecurityRequirementsObject to allow partial security schemes

Assets 2

19 May 19:22

github-actions

[email protected]

24eca72

[email protected]

Patch Changes

#1672 64cb619 Thanks @jaredLunde! - Fixes issue where native properties were not excluded from custom properties in the CustomRequest class

Assets 2

19 May 19:01

github-actions

[email protected]

bda737c

[email protected] Pre-release

Pre-release

openapi-typescript

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
  - To migrate, you’ll need to create a redocly.yaml config that specifies your auth options in the http setting
  - You can also set your fetch client in redocly.yaml as well.
- --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.
- Any options passed into your redocly.yaml config are respected
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

#1355 7568941 Thanks @drwpow! - Revert optional parameters breaking change (v6.6.0, #1335)

6.6.2

Patch Changes

#1348 f6fdd2f Thanks @drwpow! - Improve YAML vs JSON parsing
#1352 33b2c4f Thanks @drwpow! - Fix all parameters optional
#1345 6f078c1 Thanks @SchabaJo! - Mirror directory structure of input files if output is a directory to prevent overwriting the same file again and again.

6.6.1

Patch Changes

#1342 c17669d Thanks @drwpow! - Fix discriminator propertyName inference

6.6.0

Minor Changes

#1335 7cb02ac Thanks @duncanbeevers! - Request parameters member is optional when all parameters are optional.

6.5.5

Patch Changes

#1332 8e8ebfd Thanks @drwpow! - Restore original .d.ts module-resolution behavior

6.5.4

Patch Changes

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

6.5.3

Patch Changes

#1320 [3cf78b9](3cf78b920ab23624c0524e0d5833...

Assets 2

16 May 17:08

github-actions

[email protected]

a7dbe90

[email protected]

Patch Changes

#1653 4f4253a Thanks @FreeAoi! - Let request object have custom properties

Assets 2

28 Apr 22:57

github-actions

[email protected]

7e3df85

[email protected]

Patch Changes

#1639 645f436 Thanks @FreeAoi! - fix request option types don't showing optional props correctly

Assets 2

23 Apr 19:02

github-actions

[email protected]

a5d5836

[email protected]

Patch Changes

#1597 1f7ad9d Thanks @armandabric! - Allow to select the response content type
#1585 4e06f86 Thanks @mikestopcontinues! - Update types for path-methods object
#1610 cc8073b Thanks @illright! - Fix data/error discrimination when there are empty-body errors
#1587 2a66a64 Thanks @JE-lee! - Fix the custom fetch type

Assets 2

12 Mar 20:16

drwpow

[email protected]

9a9a9ef

[email protected]

Patch Changes

#1535 48ca069fd889acd469955589ff3ec74e775ca9fd Thanks @tvanier! - Support single operation parameter
#1524 fe6c6d1526c59e4f9021d71cad74feba315f337f Thanks @WickyNilliams! - Keep type information for nullable fields when possible

Assets 2

Uh oh!

Releases: openapi-ts/openapi-typescript

Major Changes

Minor Changes

Patch Changes

Uh oh!

Minor Changes

Patch Changes

Uh oh!

Patch Changes

Uh oh!

Patch Changes

Uh oh!

Patch Changes

Uh oh!

openapi-typescript

7.0.0

Major Changes

Minor Changes

Patch Changes

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

6.5.3

Patch Changes

Uh oh!

Patch Changes

Uh oh!

Patch Changes

Uh oh!

Patch Changes

Uh oh!

Patch Changes

Uh oh!