Kontract

Generators

One schema source, many targets. Each target in sumr.yaml names one generator through generator.type; that value decides what the target emits and which options it accepts. Open a generator for its options, a worked example, and its prerequisites.

Server

Emits the application-facing boundary: controllers, DTOs, typed errors, and the validation and response foundation they depend on.

typescript-nestjsOpenAPIThe largest generator. Emits the application-facing boundary and, with the matching options, the validation and response foundation it depends on.

Client SDK

Emits a typed client for the same operations. All three share one option surface and differ only in how the request is sent.

typescript-fetchOpenAPIBuilt on the platform fetch API. The default client choice: same option surface as the Axios target, without adding a package.typescript-axiosOpenAPIIdentical option surface to typescript-fetch. Choose it only when the consuming app already standardises on Axios interceptors.typescript-angularOpenAPIUse when the consumer needs the client through Angular dependency injection rather than a plain import.

Client state

Emits React data-fetching bindings on top of the same generated operations.

react-query-hooksOpenAPIAdds caching and revalidation on top of the generated operations. Pair it with a client target rather than using it alone.

Models

Emits types and schemas with no transport layer. Use when another package owns the client or server.

typescript-modelsOpenAPIUse when another package owns the client or server. Point it at the same source as a client target to keep both model sets identical.asyncapi-modelsAsyncAPIThe AsyncAPI counterpart to typescript-models. Takes no options.

Messaging

Emits broker-facing contracts from async schema sources.

asyncapi-natsAsyncAPIEmits broker-facing contracts so publishers and subscribers validate against one message definition.

Choosing a client

Pick by runtime, not by preference.

typescript-fetch and typescript-axios accept the same options and produce the same call surface; choose typescript-axios only when the consuming app already standardises on Axios interceptors, and typescript-fetch otherwise, since it adds no runtime dependency. Choose typescript-angular when the consumer needs the client through Angular dependency injection. Add react-query-hooks alongside a client when React components should own caching and revalidation rather than calling the SDK directly.