Changelog

2.12.3

(chore): Updated retry strategy; in particular, don’t jitter for retry-after header.

2.12.2

(fix): Generate correct types for pagination with inline types.

2.12.1

(fix): Generate property accessors for auth and pagination with ?. if the property is optional or nullable, and . if the property is required and non-nullable.

2.12.0

(feat): Add support for custom sections in the README.md via customSections config option.

2.11.2

(fix): Websocket client generation compiles when there are no query parameters and when the auth scheme has custom authentication headers.

2.11.1

(fix): The _getAuthorizationHeader method now returns Promise<string | undefined> when oauth is enabled. This prevents compilation errors in the TypeScript SDK.

2.11.0

(feat): Generate Request and Response types variations for types that have readonly and/or writeonly properties. For example, a type User will have a User.Request type that omits readonly properties and a User.Response type that omits writeonly properties.

Set experimentalGenerateReadWriteOnlyTypes to true in the config of your generator configuration to enable this feature.

1
import { User, FooClient } from "foo";
2
3
const client = new FooClient(...);
4
const createUser: User.Request = {
5
  name: "Jon",
6
  // id: "123", // Error: id is read-only and thus omitted
7
};
8
const createdUser: User.Response = await client.createUser(createUser);
9
// createdUser.id is available here

2.10.4

(feat): Use cached prettier to format project instead of yarn/pnpm installing all dependencies during generation.

(feat): Generate lockfile without installing dependencies and using --prefer-offline to avoid network requests.

2.10.3

(feat): Retries now check Retry-After and X-RateLimit-Reset before defaulting to exponential backoff.

2.10.2

(fix): Allow null values in headers in addition to undefined to explicitly unset a header.

2.10.1

(fix): Use autogenerated error examples if user does not provide error examples for generating wire tests.

2.10.0

(fix): Do not set a default Content-Type header when creating a HTTP response for wire test mocking.

(feat): Generate wire tests for HTTP endpoint error examples.

2.9.5

(feat): Introduce a custom configuration called exportAllRequestsAtRoot which exposes all request types through the root-level namespace.

2.9.4

(fix): Grab overrideable root header value from Client as default.

2.9.2

(fix): Do not throw an error if example properties are mismatched with the schema definition.

2.9.3

(feat): Add support for autogenerating simple tests for pagination endpoints.