# @leancodepl/contractsgenerator-typescript > TypeScript Contracts Generator is an utility for generating contracts/clients/schema based on backend contracts and config file. Latest version **1.1.3** (published 2025-10-13) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install @leancodepl/contractsgenerator-typescript pnpm add @leancodepl/contractsgenerator-typescript yarn add @leancodepl/contractsgenerator-typescript bun add @leancodepl/contractsgenerator-typescript ``` Provides the command `contractsgenerator-typescript`. ## Health **Score 45/100 (D)** — status: stable. Positive: has types; no vulnerabilities; has provenance. Warnings: low downloads; no esm support. Negative: stale. ## Facts | | | |---|---| | Version | 1.1.3 | | Published | 2025-10-13 | | First published | 2021-12-02 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 10 | | Unpacked size | 30.6 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 1 | | Maintainers | konowrockis, leancode-npm | ## Links - npm: https://www.npmjs.com/package/@leancodepl/contractsgenerator-typescript - Repository: https://github.com/leancodepl/contractsgenerator-typescript - Homepage: https://github.com/leancodepl/contractsgenerator-typescript#readme - Issues: https://github.com/leancodepl/contractsgenerator-typescript/issues - npm.io page: https://npm.io/package/@leancodepl/contractsgenerator-typescript ## Dependencies (10) - [zod](https://npm.io/package/zod.md) >=3.22.0 - [yaml](https://npm.io/package/yaml.md) 2.8.0 - [yargs](https://npm.io/package/yargs.md) 18.0.0 - [lodash](https://npm.io/package/lodash.md) ^4.0.0 - [lilconfig](https://npm.io/package/lilconfig.md) 3.1.3 - [node-cache](https://npm.io/package/node-cache.md) 5.1.2 - [object-hash](https://npm.io/package/object-hash.md) 3.0.0 - [@leancodepl/utils](https://npm.io/package/@leancodepl/utils.md) >=7.2.3 - [@leancodepl/contractsgenerator-typescript-plugin](https://npm.io/package/@leancodepl/contractsgenerator-typescript-plugin.md) 1.1.3 - [@leancodepl/contractsgenerator-typescript-schema](https://npm.io/package/@leancodepl/contractsgenerator-typescript-schema.md) 1.1.3 ## Recent versions - 1.1.3 (latest) — 2025-10-13 - 1.1.2 (alpha) — 2025-10-13 - 1.1.1 — 2025-10-02 - 1.1.0 — 2025-06-23 - 1.1.0-alpha.7 — 2024-12-19 - 1.1.0-alpha.6 — 2024-11-26 - 1.1.0-alpha.5 — 2024-10-07 - 1.1.0-alpha.4 — 2024-08-19 - 1.1.0-alpha.3 — 2024-08-14 - 1.1.0-alpha.2 — 2024-01-16 - 1.1.0-alpha.1 — 2023-12-08 - 1.1.0-alpha.0 — 2023-12-01 - 1.0.0-alpha.2 — 2023-11-15 - 1.0.0-alpha.1 — 2023-11-13 - 1.0.0-alpha.0 — 2023-11-13 - … 7 more at https://npm.io/package/@leancodepl/contractsgenerator-typescript/versions ## README # @leancodepl/contractsgenerator - LeanCode TypeScript Contracts Generator TypeScript Contracts Generator is an utility for generating contracts/clients/schema based on backend contracts and config file. ## Usage ```sh # you also have to install all plugins used by your config e.g. # @leancodepl/contractsgenerator-typescript-plugin-contracts @leancodepl/contractsgenerator-typescript-plugin-client @leancodepl/contractsgenerator-typescript-plugin-raw npm i -D @leancodepl/contractsgenerator-typescript npx @leancodepl/contractsgenerator-typescript ``` One thing to remember is that TypeScript Contracts Generator relies on [Contracts Generator Server](https://github.com/leancodepl/contractsgenerator). Consequently Contracts Generator Server needs `dotnet` as its runtime. That means in order for generator to work you need to have `dotnet` runtime installed. ## Configuration file Contracts generator is configured using [lilconfig](https://github.com/antonk52/lilconfig). Valid configuration sources include: - `contractsgenerator-typescript` property in `package.json`, - `.contractsgenerator-typescriptrc.json` for raw JSON - `contractsgenerator-typescript.config.js`, `contractsgenerator-typescript.config.cjs`, `.contractsgenerator-typescriptrc.js`, `.contractsgenerator-typescriptrc.cjs` for configuration using JavaScript. Those files need to export the configuration object. - path to JavaScript/JSON/YAML config file passed via `--config/-c` parameter ## Example config ```js const preamble = ` /*eslint-disable import/no-anonymous-default-export, @typescript-eslint/no-unused-vars, @typescript-eslint/ban-types, @typescript-eslint/no-empty-interface, @typescript-eslint/no-namespace*/ import type { ApiDateTimeOffset } from "@leancodepl/api-date-dayjs" import type { ReactQueryCqrs as CQRS } from "."; export type Query = {} export type Command = {} export type Operation = {} export type Topic = {} `.trimStart() module.exports = { generates: { "src/api/api-components-schema.ts": { plugins: ["admin"] }, "src/api/cqrs.ts": { plugins: [{ raw: { prepend: preamble } }, "contracts", "client"] }, }, config: { customTypes: { DateOnly: "ApiDateOnly", TimeOnly: "ApiTimeOnly", DateTimeOffset: "ApiDateTimeOffset" }, input: { base: "../../../backend/src", project: [ "Core/Project.Core.Contracts/Project.Core.Contracts.csproj", "Clients/Project.Clients.Contracts/Project.Clients.Contracts.csproj", ], }, nameTransform: nameWithNamespace => nameWithNamespace.split(".").at(-1), }, } ``` ## Configuration options Contracts generator config supports two options: - `config` (root-level config) - options we would like to provide to all plugins for all output files - `generates`**\*** - dictionary of files to generate where key is path to output file and value is file config. File configuration consists of `plugins` field and optional `config` field - `config` (output-level config) - same as config, but only applies for the specific file - `plugins`**\*** - list of plugins. Plugin is specified either by it's name or dictionary whose only key is plugin name and value is plugin-level config. Specified config is the same as root/output config, but only applies for the specific plugin ### `config` field The `config` field is used to pass configuration to plugins. There are 3 levels at which `config` can be specified: - Root level - options are passed to every plugin for each output file ```js module.exports = { generates: { // ... }, config: { input: { base: "../../../backend/src", project: ["Core/Project.Core.Contracts/Project.Core.Contracts.csproj"] }, }, } ``` - Output level - options are passed to every plugin for the specified output file. Each field in output level config overrides root-level config for that field ```js module.exports = { generates: { "src/api/cqrs.ts": { plugins: [ /* ... */ ], config: { input: { base: "../../../backend/src", project: ["Extended/Project.Extended.Contracts/Project.Extended.Contracts.csproj"], }, }, }, }, config: { // overridden by output-level-config input: { base: "../../../backend/src", project: ["Core/Project.Core.Contracts/Project.Core.Contracts.csproj"] }, }, } ``` - Plugin level - options are passed to specified plugin. Each field in plugin level config overrides root-level and output-level config for that field ```js module.exports = { generates: { "src/api/cqrs.ts": { plugins: [ { contracts: { input: "../../../backend/src", project: ["Extended/Project.Extended.Contracts/Project.Extended.Contracts.csproj"], }, }, ], config: { // overridden by plugin-level config input: { base: "../../../backend/src", project: ["Extended/Project.Extended.Contracts/Project.Extended.Contracts.csproj"], }, }, }, }, config: { // overridden by output-level and then plugin-level config input: { base: "../../../backend/src", project: ["Core/Project.Core.Contracts/Project.Core.Contracts.csproj"] }, }, } ``` --- _Source: https://npm.io/package/@leancodepl/contractsgenerator-typescript · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._