@redocly/client-generator 0.0.0-snapshot.1784554531

package/lib/runtime-contract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-contract.d.ts","sourceRoot":"","sources":["../src/runtime-contract.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,UAAU,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAElF,YAAY,EACV,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,aAAa,GACd,MAAM,oBAAoB,CAAC;AAE5B;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EACJ,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACtB,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IACrE,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1D,UAAU,CAAC,EAAE,CACX,QAAQ,EAAE,QAAQ,EAClB,GAAG,EAAE,cAAc,KAChB,QAAQ,GAAG,IAAI,GAAG,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC;IAChD,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,cAAc,KAAK,KAAK,CAAC;IACvD,KAAK,CAAC,EAAE,WAAW,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IAAE,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAAC,UAAU,CAAC,EAAE,UAAU,EAAE,CAAA;CAAE,CAAC;AAEpF;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,WAAW,GAAG,WAAW,CAEjE"}

package/lib/runtime-contract.js

@@ -0,0 +1,14 @@
+// The public, spec-independent runtime contract a publisher's `--setup` file imports.
+// These are the runtime's own types (src/runtime/types.ts) — the very module the
+// generated client embeds (inline) or imports (package) — so the contract cannot
+// drift from the generated output.
+/**
+ * Identity helper for authoring a `--setup` module: gives full type inference and a stable
+ * call the baker recognises. `export default defineClientSetup({ config, middleware })`.
+ *
+ * @experimental The setup API may change between minor versions until stabilized.
+ */
+export function defineClientSetup(setup) {
+    return setup;
+}
+//# sourceMappingURL=runtime-contract.js.map

package/lib/runtime-contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-contract.js","sourceRoot":"","sources":["../src/runtime-contract.ts"],"names":[],"mappings":"AAAA,sFAAsF;AACtF,iFAAiF;AACjF,iFAAiF;AACjF,mCAAmC;AAkCnC;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAkB;IAClD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/lib/types.d.ts

@@ -0,0 +1,118 @@
+import type { Config as RedoclyConfig, Oas3Definition, detectSpec } from '@redocly/openapi-core';
+import type { ArgsStyle } from './emitters/emit-options.js';
+import type { PaginationConfig } from './emitters/pagination.js';
+import type { CustomGenerator, OutputMode } from './generators/types.js';
+export type GenerateClientOptions = {
+    /** Path or URL to the OpenAPI document (or an `apis:` alias from `redocly.yaml`). */
+    api: string;
+    output: string;
+    /** Resolved Redocly config for spec loading. */
+    config?: RedoclyConfig;
+    /**
+     * How the generated client is partitioned across files. Defaults to `single`
+     * (one self-contained file).
+     */
+    outputMode?: OutputMode;
+    /**
+     * How operation inputs are passed to each generated function/method:
+     * `'flat'` (default) spreads path params as positional args followed by
+     * `params`/`body`/`headers` slots; `'grouped'` bundles every input into a single
+     * `args` object. The per-call `init` argument stays separate in both styles.
+     */
+    argsStyle?: ArgsStyle;
+    /**
+     * Override the BASE URL inlined into the generated runtime. When omitted,
+     * the value is derived from `servers[0].url` in the source OpenAPI document.
+     * Validation (e.g. `new URL(value)`) is the caller's responsibility — the
+     * CLI handler validates before calling.
+     */
+    serverUrl?: string;
+    /**
+     * How named string enums are emitted. `'const-object'` (default) emits a
+     * runtime `as const` companion object alongside the union type; `'union'`
+     * emits only the string-literal union.
+     */
+    enumStyle?: 'union' | 'const-object';
+    /**
+     * Error-handling shape of the generated client. `'throw'` (default) throws
+     * `ApiError` on non-2xx responses; `'result'` returns a discriminated
+     * `{ data, error, response }` whose `error` is typed from the spec's 4xx/5xx
+     * response bodies.
+     */
+    errorMode?: 'throw' | 'result';
+    /**
+     * How `format: date-time`/`date` string fields are typed. `'string'` (default)
+     * keeps the ISO wire shape; `'Date'` emits a `Date` reference. Opt-in — pair with
+     * the `transformers` generator so the runtime value matches the type. The
+     * generated client stays zero-dep (`Date` is a web standard).
+     */
+    dateType?: 'string' | 'Date';
+    /**
+     * TanStack Query adapter the `tanstack-query` generator imports from
+     * (`@tanstack/${queryFramework}-query`). Defaults to `'react'`; only the import
+     * specifier changes — the emitted factory module is byte-identical across frameworks.
+     */
+    queryFramework?: 'react' | 'vue' | 'svelte' | 'solid';
+    /**
+     * How the `mock` generator produces data. `'baked'` (default) inlines deterministic
+     * literals (zero-dep, contract-faithful); `'faker'` emits `@faker-js/faker` calls for
+     * realistic data — making `@faker-js/faker` the consumer's dev-dep. Factory signatures
+     * are identical across modes, so a consumer can flip this without changing call sites.
+     */
+    mockData?: 'baked' | 'faker';
+    /**
+     * Seed for faker-mode mocks. When set, the mock module emits a top-level
+     * `faker.seed(<n>)` so generated data is reproducible across runs. Ignored in baked mode.
+     */
+    mockSeed?: number;
+    /**
+     * Generators to run, in order. Defaults to `['sdk']`. Each entry is a built-in name
+     * (`sdk`/`zod`/`tanstack-query`/`swr`/`transformers`/`mock`), the `name` of an inline
+     * `customGenerators` entry, or an import specifier (a path or package) for a custom generator.
+     */
+    generators?: string[];
+    /**
+     * Inline custom generators (the experimental plugin API), registered before resolution so they
+     * can be selected in `generators` by `name`. Authored with `defineGenerator` from
+     * `@redocly/client-generator`. Path/package specifiers in `generators` don't need this.
+     */
+    customGenerators?: CustomGenerator[];
+    /**
+     * Directory that relative-path generator specifiers resolve against (typically the config file's
+     * location). Defaults to the current working directory.
+     */
+    configDir?: string;
+    /**
+     * Path to a publisher setup module (`export default defineClientSetup({ config, middleware })`)
+     * baked into the generated client. Resolved against `configDir`. Works across all output modes.
+     */
+    setup?: string;
+    /** Runtime distribution: 'inline' (default, self-contained) | 'package' (imports @redocly/client-generator). */
+    runtime?: 'inline' | 'package';
+    /**
+     * Auto-pagination rules: a convention rule (applied to every operation it
+     * structurally fits), per-operation overrides, and `exclude`d operationIds —
+     * resolved together with each operation's `x-pagination` extension (per-op config >
+     * extension > convention). Paginated operations gain typed `.pages()`/`.items()`
+     * iterators. Verified statically: an explicit rule that doesn't fit its operation
+     * fails generation.
+     */
+    pagination?: PaginationConfig;
+};
+export type GenerateClientResult = {
+    /** The `--output` anchor path (the entry file in multi-file modes). */
+    outputPath: string;
+    /** Total bytes written across every generated file. */
+    bytes: number;
+    /** Every file written to disk (single-element in `single` mode). */
+    files: Array<{
+        path: string;
+        bytes: number;
+    }>;
+};
+export type LoadResult = {
+    document: Oas3Definition;
+    /** The detected input spec version (e.g. 'oas2', 'oas3_0', 'oas3_1', 'oas3_2'). */
+    version: ReturnType<typeof detectSpec>;
+};
+//# sourceMappingURL=types.d.ts.map

package/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,aAAa,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEjG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAEzE,MAAM,MAAM,qBAAqB,GAAG;IAClC,qFAAqF;IACrF,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,gDAAgD;IAChD,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB;;;OAGG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,cAAc,CAAC;IACrC;;;;;OAKG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC/B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,MAAM,CAAC;IAC7B;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;IACtD;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,gHAAgH;IAChH,OAAO,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,gBAAgB,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,uEAAuE;IACvE,UAAU,EAAE,MAAM,CAAC;IACnB,uDAAuD;IACvD,KAAK,EAAE,MAAM,CAAC;IACd,oEAAoE;IACpE,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,EAAE,cAAc,CAAC;IACzB,mFAAmF;IACnF,OAAO,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;CACxC,CAAC"}

package/lib/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@redocly/client-generator",
+  "version": "0.0.0-snapshot.1784554531",
+  "description": "Generate typed, zero-dependency TypeScript clients (fetch, auth, retries, middleware, SSE) from OpenAPI descriptions.",
+  "type": "module",
+  "types": "lib/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js",
+      "default": "./lib/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "engines": {
+    "node": ">=22.12.0 || >=20.19.0 <21.0.0",
+    "npm": ">=10"
+  },
+  "engineStrict": true,
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "examples:regen": "node scripts/regenerate-examples.mjs",
+    "prepare": "node scripts/generate-runtime-sources.mjs",
+    "typecheck:examples": "node scripts/typecheck-examples.mjs"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Redocly/redocly-cli.git"
+  },
+  "homepage": "https://github.com/Redocly/redocly-cli",
+  "keywords": [
+    "OpenAPI",
+    "Swagger",
+    "TypeScript",
+    "client",
+    "generator",
+    "codegen",
+    "fetch"
+  ],
+  "contributors": [
+    "Roman Marshevskyi <roman.marshevskyy@redocly.com> (https://redocly.com/)"
+  ],
+  "dependencies": {
+    "@redocly/openapi-core": "0.0.0-snapshot.1784554531"
+  },
+  "peerDependencies": {
+    "typescript": ">=5.5.0"
+  },
+  "devDependencies": {
+    "typescript": "6.0.2"
+  },
+  "files": [
+    "lib"
+  ]
+}