@redocly/cli 0.0.0-snapshot.1785230554 → 0.0.0-snapshot.1785244920

package/README.md

@@ -139,6 +139,21 @@ Respect is Redocly's community-edition product. Looking for something more? We a
 
 Learn more about [Respect](https://redocly.com/respect) and [get started with API contract testing](https://redocly.com/docs/respect/get-started).
 
+### Generate a TypeScript client
+
+> ⚠️ **Experimental** — flags, output, and configuration may change in any minor release until declared stable.
+
+Turn an OpenAPI description (3.0/3.1/3.2 or Swagger 2.0) into a typed TypeScript client with the `generate-client` command.
+The emitted client has zero runtime dependencies and runs in browsers, Node, Bun, Deno, and edge runtimes.
+
+```sh
+redocly generate-client openapi.yaml --output src/client.ts
+```
+
+Inline types plus a typed client instance and one async function per operation, with auth, opt-in abort-aware retries, middleware, and typed Server-Sent Events.
+The same command can also emit Zod schemas, TanStack Query / SWR hooks, MSW mocks, and more via `--generators`.
+For detailed information, read the [ `generate-client` docs](./docs/@v2/commands/generate-client.md).
+
 ### Transform an OpenAPI description
 
 If your OpenAPI description isn't everything you hoped it would be, enhance it with the Redocly [decorators](https://redocly.com/docs/cli/decorators) feature.

package/THIRD_PARTY_NOTICES

@@ -229,6 +229,7 @@ Packages:
   @opentelemetry/semantic-conventions@1.41.1 — copyright owner or entity authorized by
   better-ajv-errors@2.0.3 — Copyright 2018 Atlassian Pty Ltd
   jsonpath-rfc9535@1.3.0 — copyright owner or entity authorized by
+  typescript@6.0.2 — copyright owner or entity authorized by the copyright owner that is granting the License.
   yaml-ast-parser@0.0.43
 
 License text:
@@ -690,7 +691,7 @@ Packages:
   mobx@6.12.3 — Copyright (c) 2015 Michel Weststrate
   ms@2.1.3
   object-assign@4.1.1
-  openapi-sampler@1.7.1 — Copyright (c) 2017 Roman Hotsiy <gotsijroman@gmail.com>
+  openapi-sampler@1.7.4 — Copyright (c) 2017 Roman Hotsiy <gotsijroman@gmail.com>
   outdent@0.8.0 — Copyright (c) 2016 Andrew Bradley
   perfect-scrollbar@1.5.6 — Copyright (c) 2012-2019 Hyunje Jun, MDBootstrap.com and other contributors
   picomatch@4.0.4 — Copyright (c) 2017-present, Jon Schlinkert.

package/lib/chunks/{OX5JLHET.js → 2TLLJTMW.js}

@@ -1,8 +1,12 @@
 import { createRequire as __createRequire } from 'node:module';
+import { fileURLToPath as __fileURLToPath } from 'node:url';
+import { dirname as __pathDirname } from 'node:path';
 const require = __createRequire(import.meta.url);
+var __filename = __fileURLToPath(import.meta.url);
+var __dirname = __pathDirname(__filename);
 import {
   selectTrafficParser
-} from "./OEBTCJXO.js";
+} from "./VDSSC4ZQ.js";
 import {
   getPathWithoutTrailingSlash,
   isJsonMime,
@@ -12,14 +16,14 @@ import {
   normalizeFsPath,
   normalizeServerPrefix,
   resolvePathForServer
-} from "./PAZIZVGW.js";
+} from "./G7NJ4MRM.js";
 import {
   OPENAPI3_METHOD_NAMES,
   Spinner
-} from "./64PJUTGH.js";
+} from "./X4HWZFPQ.js";
 import {
   exitWithError
-} from "./CUWLBJXP.js";
+} from "./34BWH3JM.js";
 import {
   createConfig,
   isPlainObject,
@@ -28,9 +32,9 @@ import {
   parseYaml,
   pluralize,
   stringifyYaml
-} from "./Z3EJWJEX.js";
-import "./Z2I5YXYN.js";
-import "./5ILQMFXK.js";
+} from "./4U73KS2P.js";
+import "./HRYOF224.js";
+import "./YDPUXTSG.js";
 
 // src/commands/generate-spec/index.ts
 import { mkdir, writeFile } from "node:fs/promises";

package/lib/chunks/{A6JSOHCP.js → 33L3PA3A.js}

@@ -1,16 +1,20 @@
 import { createRequire as __createRequire } from 'node:module';
+import { fileURLToPath as __fileURLToPath } from 'node:url';
+import { dirname as __pathDirname } from 'node:path';
 const require = __createRequire(import.meta.url);
+var __filename = __fileURLToPath(import.meta.url);
+var __dirname = __pathDirname(__filename);
 import {
   require_execAsync
-} from "./AIT3U3JT.js";
+} from "./AVTQDJLQ.js";
 import {
   esm_exports,
   init_esm
-} from "./XHPY6UJF.js";
+} from "./LJH34AHG.js";
 import {
   __commonJS,
   __toCommonJS
-} from "./5ILQMFXK.js";
+} from "./YDPUXTSG.js";
 
 // ../../node_modules/@opentelemetry/resources/build/src/detectors/platform/node/machine-id/getMachineId-darwin.js
 var require_getMachineId_darwin = __commonJS({

package/lib/chunks/{CUWLBJXP.js → 34BWH3JM.js}

@@ -1,8 +1,12 @@
 import { createRequire as __createRequire } from 'node:module';
+import { fileURLToPath as __fileURLToPath } from 'node:url';
+import { dirname as __pathDirname } from 'node:path';
 const require = __createRequire(import.meta.url);
+var __filename = __fileURLToPath(import.meta.url);
+var __dirname = __pathDirname(__filename);
 import {
   HandledError
-} from "./Z3EJWJEX.js";
+} from "./4U73KS2P.js";
 
 // src/utils/error.ts
 var AbortFlowError = class extends Error {

package/lib/chunks/{ZCF2YWSB.js → 3CBCJ5DL.js}

@@ -1,27 +1,31 @@
 import { createRequire as __createRequire } from 'node:module';
+import { fileURLToPath as __fileURLToPath } from 'node:url';
+import { dirname as __pathDirname } from 'node:path';
 const require = __createRequire(import.meta.url);
+var __filename = __fileURLToPath(import.meta.url);
+var __dirname = __pathDirname(__filename);
 import {
   selectTrafficParser
-} from "./OEBTCJXO.js";
+} from "./VDSSC4ZQ.js";
 import {
   ValidationSession,
   loadOpenApiIndex,
   parseCsv,
   renderReport
-} from "./RMTDGHBP.js";
+} from "./D7VQZUMB.js";
 import {
   listFilesRecursively,
   normalizeFsPath
-} from "./PAZIZVGW.js";
+} from "./G7NJ4MRM.js";
 import {
   AbortFlowError,
   exitWithError
-} from "./CUWLBJXP.js";
+} from "./34BWH3JM.js";
 import {
   logger
-} from "./Z3EJWJEX.js";
-import "./Z2I5YXYN.js";
-import "./5ILQMFXK.js";
+} from "./4U73KS2P.js";
+import "./HRYOF224.js";
+import "./YDPUXTSG.js";
 
 // src/commands/drift/index.ts
 import { mkdir, writeFile } from "node:fs/promises";

package/lib/chunks/{Z3EJWJEX.js → 4U73KS2P.js}

@@ -1,16 +1,20 @@
 import { createRequire as __createRequire } from 'node:module';
+import { fileURLToPath as __fileURLToPath } from 'node:url';
+import { dirname as __pathDirname } from 'node:path';
 const require = __createRequire(import.meta.url);
+var __filename = __fileURLToPath(import.meta.url);
+var __dirname = __pathDirname(__filename);
 import {
   initRules,
   isDefined,
   require_graphql
-} from "./Z2I5YXYN.js";
+} from "./HRYOF224.js";
 import {
   __commonJS,
   __export,
   __require,
   __toESM
-} from "./5ILQMFXK.js";
+} from "./YDPUXTSG.js";
 
 // ../../node_modules/pluralize/pluralize.js
 var require_pluralize = __commonJS({
@@ -28378,6 +28382,7 @@ var createConfigRoot = (nodeTypes) => ({
     ...ConfigGovernance.properties,
     apis: "ConfigApis",
     // Override apis with internal format
+    client: "Client",
     telemetry: { enum: ["on", "off"] },
     resolve: {
       properties: {
@@ -28397,8 +28402,10 @@ var createConfigApisProperties = (nodeTypes) => ({
   ...nodeTypes["rootRedoclyConfigSchema.apis_additionalProperties"],
   properties: {
     ...nodeTypes["rootRedoclyConfigSchema.apis_additionalProperties"]?.properties,
-    ...omit(ConfigGovernance.properties, ["plugins"])
+    ...omit(ConfigGovernance.properties, ["plugins"]),
     // plugins are not allowed in apis
+    client: "Client",
+    clientOutput: { type: "string" }
   }
 });
 var ConfigHTTP = {
@@ -28411,6 +28418,41 @@ var ConfigHTTP = {
     }
   }
 };
+var Client = {
+  properties: {
+    generators: { type: "array", items: { type: "string" } },
+    argsStyle: { enum: ["flat", "grouped"] },
+    serverUrl: { type: "string" },
+    outputMode: { enum: ["single", "split"] },
+    runtime: { enum: ["inline", "package"] },
+    importExt: { enum: ["js", "ts"] },
+    errorMode: { enum: ["throw", "result"] },
+    dateType: { enum: ["string", "Date"] },
+    mockData: { enum: ["static", "faker"] },
+    mockSeed: { type: "number" },
+    queryKeyPrefix: { type: "string" },
+    setup: { type: "string" },
+    pagination: "ClientPagination"
+  }
+};
+var ClientPaginationRule = {
+  properties: {
+    style: { enum: ["cursor", "offset", "page", "link"] },
+    cursorParam: { type: "string" },
+    nextCursor: { type: "string" },
+    hasMore: { type: "string" },
+    offsetParam: { type: "string" },
+    limitParam: { type: "string" },
+    items: { type: "string" }
+  }
+};
+var ClientPagination = {
+  properties: {
+    ...ClientPaginationRule.properties,
+    exclude: { type: "array", items: { type: "string" } },
+    operations: mapOf("ClientPaginationRule")
+  }
+};
 var Rules = {
   properties: {},
   description: "The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.",
@@ -28761,6 +28803,9 @@ var CoreConfigTypes = {
   ConfigApis,
   ConfigGovernance,
   ConfigHTTP,
+  Client,
+  ClientPagination,
+  ClientPaginationRule,
   Where,
   BuiltinRule,
   CustomRule,
@@ -38192,6 +38237,30 @@ async function loadPluginModule(absolutePluginPath) {
 }
 
 // ../core/lib/config/config-resolvers.js
+function mergeClientBlocks(base, overrides) {
+  const merged = { ...base, ...overrides };
+  const basePagination = base.pagination;
+  const overridePagination = overrides.pagination;
+  if (isPlainObject(basePagination) && isPlainObject(overridePagination)) {
+    const pagination = { ...basePagination, ...overridePagination };
+    if (basePagination.operations || overridePagination.operations) {
+      pagination.operations = {
+        ...isPlainObject(basePagination.operations) ? basePagination.operations : {},
+        ...isPlainObject(overridePagination.operations) ? overridePagination.operations : {}
+      };
+    }
+    if (Array.isArray(basePagination.exclude) || Array.isArray(overridePagination.exclude)) {
+      pagination.exclude = [
+        .../* @__PURE__ */ new Set([
+          ...Array.isArray(basePagination.exclude) ? basePagination.exclude : [],
+          ...Array.isArray(overridePagination.exclude) ? overridePagination.exclude : []
+        ])
+      ];
+    }
+    merged.pagination = pagination;
+  }
+  return merged;
+}
 async function resolveConfig({ rawConfigDocument, configPath, externalRefResolver, customExtends }) {
   const config = rawConfigDocument === void 0 ? DEFAULT_CONFIG : rawConfigDocument.parsed;
   if (customExtends !== void 0 && isPlainObject(config)) {
@@ -38225,7 +38294,8 @@ async function resolveConfig({ rawConfigDocument, configPath, externalRefResolve
   if (bundledConfig.apis) {
     bundledConfig.apis = Object.fromEntries(Object.entries(bundledConfig.apis).map(([key, apiConfig]) => {
       const mergedConfig = mergeExtends([bundledConfig, apiConfig]);
-      return [key, { ...apiConfig, ...mergedConfig }];
+      const client = isPlainObject(bundledConfig.client) && isPlainObject(apiConfig.client) ? { client: mergeClientBlocks(bundledConfig.client, apiConfig.client) } : {};
+      return [key, { ...apiConfig, ...mergedConfig, ...client }];
     }));
   }
   const pluginPaths = pluginsOrPaths.length ? pluginsOrPaths.map((p2) => isPluginResolveInfo(p2) && p2.isModule ? p2.rawPath : p2.absolutePath && path8.relative(rootConfigDir, p2.absolutePath)).filter(isDefined) : void 0;
@@ -39163,7 +39233,7 @@ async function lintFromString(opts) {
 async function lintDocument(opts) {
   const { document, customTypes, externalRefResolver, config } = opts;
   if (isGraphqlRef(document.source.absoluteRef)) {
-    const { lintGraphqlDocument } = await import("./ZK3QRKL5.js");
+    const { lintGraphqlDocument } = await import("./TWBSRL2M.js");
     return lintGraphqlDocument({ document, config });
   }
   const specVersion = detectSpec(document.parsed);

package/lib/chunks/{Y6DTFCLS.js → 7COZBK76.js}

@@ -1,5 +1,9 @@
 import { createRequire as __createRequire } from 'node:module';
+import { fileURLToPath as __fileURLToPath } from 'node:url';
+import { dirname as __pathDirname } from 'node:path';
 const require = __createRequire(import.meta.url);
+var __filename = __fileURLToPath(import.meta.url);
+var __dirname = __pathDirname(__filename);
 
 // src/utils/constants.ts
 var OTEL_URL = "https://otel.cloud.redocly.com";

package/lib/chunks/{TS33ZDKX.js → 7J52NJGJ.js}

@@ -1,14 +1,18 @@
 import { createRequire as __createRequire } from 'node:module';
+import { fileURLToPath as __fileURLToPath } from 'node:url';
+import { dirname as __pathDirname } from 'node:path';
 const require = __createRequire(import.meta.url);
+var __filename = __fileURLToPath(import.meta.url);
+var __dirname = __pathDirname(__filename);
 import {
   esm_exports,
   init_esm
-} from "./XHPY6UJF.js";
+} from "./LJH34AHG.js";
 import {
   __commonJS,
   __require,
   __toCommonJS
-} from "./5ILQMFXK.js";
+} from "./YDPUXTSG.js";
 
 // ../../node_modules/@opentelemetry/resources/build/src/detectors/platform/node/machine-id/getMachineId-linux.js
 var require_getMachineId_linux = __commonJS({

package/lib/chunks/{AIT3U3JT.js → AVTQDJLQ.js}

@@ -1,9 +1,13 @@
 import { createRequire as __createRequire } from 'node:module';
+import { fileURLToPath as __fileURLToPath } from 'node:url';
+import { dirname as __pathDirname } from 'node:path';
 const require = __createRequire(import.meta.url);
+var __filename = __fileURLToPath(import.meta.url);
+var __dirname = __pathDirname(__filename);
 import {
   __commonJS,
   __require
-} from "./5ILQMFXK.js";
+} from "./YDPUXTSG.js";
 
 // ../../node_modules/@opentelemetry/resources/build/src/detectors/platform/node/machine-id/execAsync.js
 var require_execAsync = __commonJS({