@trpc/openapi 11.22.2-canary.9.85bcf328a → 11.23.1-canary.10.8a0997add

package/README.md

@@ -39,14 +39,6 @@ The generator statically analyses your router's TypeScript types — it never ex
 
 Full documentation is available at [trpc.io/docs/openapi](https://trpc.io/docs/openapi).
 
-## AI Agents
-
-If you use an AI coding agent, install tRPC skills for better code generation:
-
-```bash
-npx @tanstack/intent@latest install
-```
-
 ## TODO
 
 - [ ] SSE subscriptions

package/dist/cli.mjs

@@ -1027,12 +1027,20 @@ function buildOpenAPIDocument(procedures, options, meta = { errorSchema: null })
 	};
 }
 /**
-* Analyse the given TypeScript router file using the TypeScript compiler and
-* return an OpenAPI 3.1 document describing all query and mutation procedures.
+* Reads your router file with the TypeScript compiler and returns an OpenAPI
+* 3.1 document for its queries and mutations.
 *
-* @param routerFilePath - Absolute or relative path to the file that exports
-*   the AppRouter.
-* @param options - Optional generation settings (export name, title, version).
+* @param routerFilePath - Path to the file that exports your router type.
+* @param options - Export name, title, version and servers.
+*
+* @example
+* ```ts
+* const doc = await generateOpenAPIDocument('./src/server/router.ts', {
+*   title: 'My API',
+* });
+* ```
+*
+* @see https://trpc.io/docs/openapi#programmatic
 */
 async function generateOpenAPIDocument(routerFilePath, options = {}) {
 	const resolvedPath = path.resolve(routerFilePath);

package/dist/heyapi/index.cjs

@@ -48,6 +48,8 @@ function resolveTransformer(transformer) {
 *   ],
 * });
 * ```
+*
+* @see https://trpc.io/docs/openapi#hey-api-typescript
 */
 function createTRPCHeyApiTypeResolvers() {
 	return {
@@ -113,6 +115,8 @@ function createTRPCErrorInterceptor(transformerOpts) {
 *   transformer: superjson,
 * });
 * ```
+*
+* @see https://trpc.io/docs/openapi#with-a-transformer-superjson-devalue-etc
 */
 function configureTRPCHeyApiClient(client, opts) {
 	const { transformer } = opts, heyConfig = _objectWithoutProperties(opts, _excluded);

package/dist/heyapi/index.d.cts

@@ -1,12 +1,33 @@
 import { Plugins } from "@hey-api/openapi-ts";
 import { TRPCCombinedDataTransformer, TRPCDataTransformer } from "@trpc/server";
 //#region src/heyapi/index.d.ts
+/**
+ * A tRPC data transformer, such as `superjson`.
+ * @see https://trpc.io/docs/openapi#transformers
+ */
 export type DataTransformerOptions = TRPCDataTransformer | TRPCCombinedDataTransformer;
+/**
+ * tRPC options for {@link configureTRPCHeyApiClient}.
+ */
 export interface TRPCHeyApiClientOptions {
+  /**
+   * The data transformer your tRPC server uses. Leave it out if the server
+   * has none.
+   * @see https://trpc.io/docs/openapi#with-a-transformer-superjson-devalue-etc
+   */
   transformer?: DataTransformerOptions;
 }
+/**
+ * The `~resolvers` type of the `@hey-api/typescript` plugin.
+ */
 export type HeyAPIResolvers = Plugins.HeyApiTypeScript.Resolvers;
+/**
+ * The config of a hey-api fetch client.
+ */
 export type HeyApiConfig = ReturnType<Plugins.HeyApiClientFetch.Client['getConfig']>;
+/**
+ * The parts of a hey-api client config that tRPC sets.
+ */
 export type TRPCHeyApiClientConfig = Required<Pick<HeyApiConfig, 'querySerializer'>> & Pick<HeyApiConfig, 'bodySerializer' | 'responseTransformer'>;
 /**
  * Returns the `~resolvers` object for the `@hey-api/typescript` plugin.
@@ -25,6 +46,8 @@ export type TRPCHeyApiClientConfig = Required<Pick<HeyApiConfig, 'querySerialize
  *   ],
  * });
  * ```
+ *
+ * @see https://trpc.io/docs/openapi#hey-api-typescript
  */
 export declare function createTRPCHeyApiTypeResolvers(): HeyAPIResolvers;
 /**
@@ -57,6 +80,8 @@ export declare function createTRPCErrorInterceptor(transformerOpts: DataTransfor
  *   transformer: superjson,
  * });
  * ```
+ *
+ * @see https://trpc.io/docs/openapi#with-a-transformer-superjson-devalue-etc
  */
 export declare function configureTRPCHeyApiClient(client: Plugins.HeyApiClientFetch.Client, opts: TRPCHeyApiClientOptions & Omit<HeyApiConfig, keyof TRPCHeyApiClientConfig>): void;
 //#endregion

package/dist/heyapi/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/heyapi/index.ts"],"mappings":";;;YAMY,yBACV,sBAAsB;iBACP;EACf,cAAc;;YAGJ,kBAAkB,QAAQ,iBAAiB;YAE3C,eAAe,WACzB,QAAQ,kBAAkB;YAGhB,yBAAyB,SACnC,KAAK,oCAEL,KAAK;;;;;;;;;;;;;;;;;;;wBA6BS,iCAAiC;;;;wBAoBjC,6BAA6B,OAAO;WA4BvB,mBAAA;WAIW,wBAAA,kBAAO;WA1BlB,kBAAA,OAAA;;;;;wBA2Cb,2BACd,iBAAiB,0BAGT;;;;;;;;;;;;;;;;;;;;wBA6BM,0BACd,QAAQ,QAAQ,kBAAkB,QAClC,MAAM,0BACJ,KAAK,oBAAoB"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/heyapi/index.ts"],"mappings":";;;;;;;YAUY,yBACR,sBACA;;;;iBAIa;;;;;;EAMf,cAAc;;;;;YAMJ,kBAAkB,QAAQ,iBAAiB;;;;YAK3C,eAAe,WACzB,QAAQ,kBAAkB;;;;YAMhB,yBAAyB,SACnC,KAAK,oCAEL,KAAK;;;;;;;;;;;;;;;;;;;;;wBA+BS,iCAAiC;;;;wBAoBjC,6BAA6B,OAAO;WA4BvB,mBAAA;WAIW,wBAAA,kBAAO;WA1BlB,kBAAA,OAAA;;;;;wBA2Cb,2BACd,iBAAiB,0BAGT;;;;;;;;;;;;;;;;;;;;;;wBA+BM,0BACd,QAAQ,QAAQ,kBAAkB,QAClC,MAAM,0BACJ,KAAK,oBAAoB"}

package/dist/heyapi/index.d.mts

@@ -1,12 +1,33 @@
 import { Plugins } from "@hey-api/openapi-ts";
 import { TRPCCombinedDataTransformer, TRPCDataTransformer } from "@trpc/server";
 //#region src/heyapi/index.d.ts
+/**
+ * A tRPC data transformer, such as `superjson`.
+ * @see https://trpc.io/docs/openapi#transformers
+ */
 export type DataTransformerOptions = TRPCDataTransformer | TRPCCombinedDataTransformer;
+/**
+ * tRPC options for {@link configureTRPCHeyApiClient}.
+ */
 export interface TRPCHeyApiClientOptions {
+  /**
+   * The data transformer your tRPC server uses. Leave it out if the server
+   * has none.
+   * @see https://trpc.io/docs/openapi#with-a-transformer-superjson-devalue-etc
+   */
   transformer?: DataTransformerOptions;
 }
+/**
+ * The `~resolvers` type of the `@hey-api/typescript` plugin.
+ */
 export type HeyAPIResolvers = Plugins.HeyApiTypeScript.Resolvers;
+/**
+ * The config of a hey-api fetch client.
+ */
 export type HeyApiConfig = ReturnType<Plugins.HeyApiClientFetch.Client['getConfig']>;
+/**
+ * The parts of a hey-api client config that tRPC sets.
+ */
 export type TRPCHeyApiClientConfig = Required<Pick<HeyApiConfig, 'querySerializer'>> & Pick<HeyApiConfig, 'bodySerializer' | 'responseTransformer'>;
 /**
  * Returns the `~resolvers` object for the `@hey-api/typescript` plugin.
@@ -25,6 +46,8 @@ export type TRPCHeyApiClientConfig = Required<Pick<HeyApiConfig, 'querySerialize
  *   ],
  * });
  * ```
+ *
+ * @see https://trpc.io/docs/openapi#hey-api-typescript
  */
 export declare function createTRPCHeyApiTypeResolvers(): HeyAPIResolvers;
 /**
@@ -57,6 +80,8 @@ export declare function createTRPCErrorInterceptor(transformerOpts: DataTransfor
  *   transformer: superjson,
  * });
  * ```
+ *
+ * @see https://trpc.io/docs/openapi#with-a-transformer-superjson-devalue-etc
  */
 export declare function configureTRPCHeyApiClient(client: Plugins.HeyApiClientFetch.Client, opts: TRPCHeyApiClientOptions & Omit<HeyApiConfig, keyof TRPCHeyApiClientConfig>): void;
 //#endregion

package/dist/heyapi/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/heyapi/index.ts"],"mappings":";;;YAMY,yBACV,sBAAsB;iBACP;EACf,cAAc;;YAGJ,kBAAkB,QAAQ,iBAAiB;YAE3C,eAAe,WACzB,QAAQ,kBAAkB;YAGhB,yBAAyB,SACnC,KAAK,oCAEL,KAAK;;;;;;;;;;;;;;;;;;;wBA6BS,iCAAiC;;;;wBAoBjC,6BAA6B,OAAO;WA4BvB,mBAAA;WAIW,wBAAA,kBAAO;WA1BlB,kBAAA,OAAA;;;;;wBA2Cb,2BACd,iBAAiB,0BAGT;;;;;;;;;;;;;;;;;;;;wBA6BM,0BACd,QAAQ,QAAQ,kBAAkB,QAClC,MAAM,0BACJ,KAAK,oBAAoB"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/heyapi/index.ts"],"mappings":";;;;;;;YAUY,yBACR,sBACA;;;;iBAIa;;;;;;EAMf,cAAc;;;;;YAMJ,kBAAkB,QAAQ,iBAAiB;;;;YAK3C,eAAe,WACzB,QAAQ,kBAAkB;;;;YAMhB,yBAAyB,SACnC,KAAK,oCAEL,KAAK;;;;;;;;;;;;;;;;;;;;;wBA+BS,iCAAiC;;;;wBAoBjC,6BAA6B,OAAO;WA4BvB,mBAAA;WAIW,wBAAA,kBAAO;WA1BlB,kBAAA,OAAA;;;;;wBA2Cb,2BACd,iBAAiB,0BAGT;;;;;;;;;;;;;;;;;;;;;;wBA+BM,0BACd,QAAQ,QAAQ,kBAAkB,QAClC,MAAM,0BACJ,KAAK,oBAAoB"}

package/dist/heyapi/index.mjs

@@ -47,6 +47,8 @@ function resolveTransformer(transformer) {
 *   ],
 * });
 * ```
+*
+* @see https://trpc.io/docs/openapi#hey-api-typescript
 */
 function createTRPCHeyApiTypeResolvers() {
 	return {
@@ -112,6 +114,8 @@ function createTRPCErrorInterceptor(transformerOpts) {
 *   transformer: superjson,
 * });
 * ```
+*
+* @see https://trpc.io/docs/openapi#with-a-transformer-superjson-devalue-etc
 */
 function configureTRPCHeyApiClient(client, opts) {
 	const { transformer } = opts, heyConfig = _objectWithoutProperties(opts, _excluded);

package/dist/heyapi/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../../src/heyapi/index.ts"],"sourcesContent":["import type { Plugins } from '@hey-api/openapi-ts';\nimport type {\n  TRPCCombinedDataTransformer,\n  TRPCDataTransformer,\n} from '@trpc/server';\n\nexport type DataTransformerOptions =\n  TRPCDataTransformer | TRPCCombinedDataTransformer;\nexport interface TRPCHeyApiClientOptions {\n  transformer?: DataTransformerOptions;\n}\n\nexport type HeyAPIResolvers = Plugins.HeyApiTypeScript.Resolvers;\n\nexport type HeyApiConfig = ReturnType<\n  Plugins.HeyApiClientFetch.Client['getConfig']\n>;\n\nexport type TRPCHeyApiClientConfig = Required<\n  Pick<HeyApiConfig, 'querySerializer'>\n> &\n  Pick<HeyApiConfig, 'bodySerializer' | 'responseTransformer'>;\n\nfunction resolveTransformer(\n  transformer: DataTransformerOptions,\n): TRPCCombinedDataTransformer {\n  if ('input' in transformer) {\n    return transformer;\n  }\n  return { input: transformer, output: transformer };\n}\n\n/**\n * Returns the `~resolvers` object for the `@hey-api/typescript` plugin.\n *\n * Maps `date` and `date-time` string formats to `Date` so that the\n * generated SDK uses `Date` instead of `string` for those fields.\n *\n * @example\n * ```ts\n * import { createClient } from '@hey-api/openapi-ts';\n * import { createTRPCHeyApiTypeResolvers } from '@trpc/openapi/heyapi';\n *\n * await createClient({\n *   plugins: [\n *     { name: '@hey-api/typescript', '~resolvers': createTRPCHeyApiTypeResolvers() },\n *   ],\n * });\n * ```\n */\nexport function createTRPCHeyApiTypeResolvers(): HeyAPIResolvers {\n  return {\n    string(ctx) {\n      if (ctx.schema.format === 'date-time' || ctx.schema.format === 'date') {\n        return ctx.$.type('Date');\n      }\n      return undefined;\n    },\n    number(ctx) {\n      if (ctx.schema.format === 'bigint') {\n        return ctx.$.type('bigint');\n      }\n      return undefined;\n    },\n  };\n}\n\n/**\n * @internal - Prefer `configureTRPCHeyApiClient`\n */\nexport function createTRPCHeyApiClientConfig(opts?: TRPCHeyApiClientOptions) {\n  const transformer = opts?.transformer\n    ? resolveTransformer(opts.transformer)\n    : undefined;\n\n  return {\n    querySerializer: (query: Record<string, unknown>) => {\n      const params = new URLSearchParams();\n\n      for (const [key, value] of Object.entries(query)) {\n        if (value === undefined) {\n          continue;\n        }\n\n        if (key === 'input' && transformer) {\n          params.append(\n            key,\n            JSON.stringify(transformer.input.serialize(value)),\n          );\n        } else {\n          params.append(key, JSON.stringify(value));\n        }\n      }\n\n      return params.toString();\n    },\n\n    ...(transformer && {\n      bodySerializer: (body: unknown) => {\n        return JSON.stringify(transformer.input.serialize(body));\n      },\n\n      responseTransformer: async (data: unknown) => {\n        if (!!data && typeof data === 'object' && 'result' in data) {\n          const result = (data as any).result;\n          if (!result.type || result.type === 'data') {\n            result.data = transformer.output.deserialize(result.data);\n          }\n        }\n\n        return data;\n      },\n    }),\n  } as const satisfies TRPCHeyApiClientConfig;\n}\n\n/**\n * @internal - Prefer `configureTRPCHeyApiClient`\n */\nexport function createTRPCErrorInterceptor(\n  transformerOpts: DataTransformerOptions,\n) {\n  const transformer = resolveTransformer(transformerOpts);\n  return (error: unknown) => {\n    if (!!error && typeof error === 'object' && 'error' in error) {\n      (error as any).error = transformer.output.deserialize(\n        (error as any).error,\n      );\n    }\n    return error;\n  };\n}\n\n/**\n * Configures a hey-api client for use with a tRPC OpenAPI backend.\n *\n * Sets up querySerializer, bodySerializer, responseTransformer, and\n * an error interceptor (for transformer-based error deserialization)\n * in a single call.\n *\n * @example\n * ```ts\n * import { configureTRPCHeyApiClient } from '@trpc/openapi/heyapi';\n * import superjson from 'superjson';\n * import { client } from './generated/client.gen';\n *\n * configureTRPCHeyApiClient(client, {\n *   baseUrl: 'http://localhost:3000',\n *   transformer: superjson,\n * });\n * ```\n */\nexport function configureTRPCHeyApiClient(\n  client: Plugins.HeyApiClientFetch.Client,\n  opts: TRPCHeyApiClientOptions &\n    Omit<HeyApiConfig, keyof TRPCHeyApiClientConfig>,\n) {\n  const { transformer, ...heyConfig } = opts;\n  const trpcConfig = createTRPCHeyApiClientConfig({ transformer });\n\n  client.setConfig({ ...heyConfig, ...trpcConfig });\n\n  if (transformer) {\n    client.interceptors.error.use(createTRPCErrorInterceptor(transformer));\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AA6JU,MAAA,YAAA,CAAA,aAAA;AAtIV,SAAS,mBACP,aAC6B;CAC7B,IAAI,WAAW,aACb,OAAO;CAET,OAAO;EAAE,OAAO;EAAa,QAAQ;CAAY;AACnD;;;;;;;;;;;;;;;;;;;AAoBA,SAAgB,gCAAiD;CAC/D,OAAO;EACL,OAAO,KAAK;GACV,IAAI,IAAI,OAAO,WAAW,eAAe,IAAI,OAAO,WAAW,QAC7D,OAAO,IAAI,EAAE,KAAK,MAAM;EAG5B;EACA,OAAO,KAAK;GACV,IAAI,IAAI,OAAO,WAAW,UACxB,OAAO,IAAI,EAAE,KAAK,QAAQ;EAG9B;CACF;AACF;;;;AAKA,SAAgB,6BAA6B,MAAgC;CAC3E,MAAM,eAAA,SAAA,QAAA,SAAA,KAAA,IAAA,KAAA,IAAc,KAAM,eACtB,mBAAmB,KAAK,WAAW,IACnC,KAAA;CAEJ,OAAA,eAAA,EACE,kBAAkB,UAAmC;EACnD,MAAM,SAAS,IAAI,gBAAgB;EAEnC,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,KAAK,GAAG;GAChD,IAAI,UAAU,KAAA,GACZ;GAGF,IAAI,QAAQ,WAAW,aACrB,OAAO,OACL,KACA,KAAK,UAAU,YAAY,MAAM,UAAU,KAAK,CAAC,CACnD;QAEA,OAAO,OAAO,KAAK,KAAK,UAAU,KAAK,CAAC;EAE5C;EAEA,OAAO,OAAO,SAAS;CACzB,EAAA,GAEI,eAAe;EACjB,iBAAiB,SAAkB;GACjC,OAAO,KAAK,UAAU,YAAY,MAAM,UAAU,IAAI,CAAC;EACzD;EAEA,qBAAqB,OAAO,SAAkB;GAC5C,IAAI,CAAC,CAAC,QAAQ,OAAO,SAAS,YAAY,YAAY,MAAM;IAC1D,MAAM,SAAU,KAAa;IAC7B,IAAI,CAAC,OAAO,QAAQ,OAAO,SAAS,QAClC,OAAO,OAAO,YAAY,OAAO,YAAY,OAAO,IAAI;GAE5D;GAEA,OAAO;EACT;CACF,CACF;AACF;;;;AAKA,SAAgB,2BACd,iBACA;CACA,MAAM,cAAc,mBAAmB,eAAe;CACtD,QAAQ,UAAmB;EACzB,IAAI,CAAC,CAAC,SAAS,OAAO,UAAU,YAAY,WAAW,OACrD,MAAe,QAAQ,YAAY,OAAO,YACvC,MAAc,KACjB;EAEF,OAAO;CACT;AACF;;;;;;;;;;;;;;;;;;;;AAqBA,SAAgB,0BACd,QACA,MAEA;CACA,MAAM,EAAE,gBAAA,MAAgB,YAAA,yBAAc,MAAA,SAAA;CACtC,MAAM,aAAa,6BAA6B,EAAE,YAAY,CAAC;CAE/D,OAAO,UAAA,eAAA,eAAA,CAAA,GAAe,SAAA,GAAc,UAAW,CAAC;CAEhD,IAAI,aACF,OAAO,aAAa,MAAM,IAAI,2BAA2B,WAAW,CAAC;AAEzE"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../../src/heyapi/index.ts"],"sourcesContent":["import type { Plugins } from '@hey-api/openapi-ts';\nimport type {\n  TRPCCombinedDataTransformer,\n  TRPCDataTransformer,\n} from '@trpc/server';\n\n/**\n * A tRPC data transformer, such as `superjson`.\n * @see https://trpc.io/docs/openapi#transformers\n */\nexport type DataTransformerOptions =\n  | TRPCDataTransformer\n  | TRPCCombinedDataTransformer;\n/**\n * tRPC options for {@link configureTRPCHeyApiClient}.\n */\nexport interface TRPCHeyApiClientOptions {\n  /**\n   * The data transformer your tRPC server uses. Leave it out if the server\n   * has none.\n   * @see https://trpc.io/docs/openapi#with-a-transformer-superjson-devalue-etc\n   */\n  transformer?: DataTransformerOptions;\n}\n\n/**\n * The `~resolvers` type of the `@hey-api/typescript` plugin.\n */\nexport type HeyAPIResolvers = Plugins.HeyApiTypeScript.Resolvers;\n\n/**\n * The config of a hey-api fetch client.\n */\nexport type HeyApiConfig = ReturnType<\n  Plugins.HeyApiClientFetch.Client['getConfig']\n>;\n\n/**\n * The parts of a hey-api client config that tRPC sets.\n */\nexport type TRPCHeyApiClientConfig = Required<\n  Pick<HeyApiConfig, 'querySerializer'>\n> &\n  Pick<HeyApiConfig, 'bodySerializer' | 'responseTransformer'>;\n\nfunction resolveTransformer(\n  transformer: DataTransformerOptions,\n): TRPCCombinedDataTransformer {\n  if ('input' in transformer) {\n    return transformer;\n  }\n  return { input: transformer, output: transformer };\n}\n\n/**\n * Returns the `~resolvers` object for the `@hey-api/typescript` plugin.\n *\n * Maps `date` and `date-time` string formats to `Date` so that the\n * generated SDK uses `Date` instead of `string` for those fields.\n *\n * @example\n * ```ts\n * import { createClient } from '@hey-api/openapi-ts';\n * import { createTRPCHeyApiTypeResolvers } from '@trpc/openapi/heyapi';\n *\n * await createClient({\n *   plugins: [\n *     { name: '@hey-api/typescript', '~resolvers': createTRPCHeyApiTypeResolvers() },\n *   ],\n * });\n * ```\n *\n * @see https://trpc.io/docs/openapi#hey-api-typescript\n */\nexport function createTRPCHeyApiTypeResolvers(): HeyAPIResolvers {\n  return {\n    string(ctx) {\n      if (ctx.schema.format === 'date-time' || ctx.schema.format === 'date') {\n        return ctx.$.type('Date');\n      }\n      return undefined;\n    },\n    number(ctx) {\n      if (ctx.schema.format === 'bigint') {\n        return ctx.$.type('bigint');\n      }\n      return undefined;\n    },\n  };\n}\n\n/**\n * @internal - Prefer `configureTRPCHeyApiClient`\n */\nexport function createTRPCHeyApiClientConfig(opts?: TRPCHeyApiClientOptions) {\n  const transformer = opts?.transformer\n    ? resolveTransformer(opts.transformer)\n    : undefined;\n\n  return {\n    querySerializer: (query: Record<string, unknown>) => {\n      const params = new URLSearchParams();\n\n      for (const [key, value] of Object.entries(query)) {\n        if (value === undefined) {\n          continue;\n        }\n\n        if (key === 'input' && transformer) {\n          params.append(\n            key,\n            JSON.stringify(transformer.input.serialize(value)),\n          );\n        } else {\n          params.append(key, JSON.stringify(value));\n        }\n      }\n\n      return params.toString();\n    },\n\n    ...(transformer && {\n      bodySerializer: (body: unknown) => {\n        return JSON.stringify(transformer.input.serialize(body));\n      },\n\n      responseTransformer: async (data: unknown) => {\n        if (!!data && typeof data === 'object' && 'result' in data) {\n          const result = (data as any).result;\n          if (!result.type || result.type === 'data') {\n            result.data = transformer.output.deserialize(result.data);\n          }\n        }\n\n        return data;\n      },\n    }),\n  } as const satisfies TRPCHeyApiClientConfig;\n}\n\n/**\n * @internal - Prefer `configureTRPCHeyApiClient`\n */\nexport function createTRPCErrorInterceptor(\n  transformerOpts: DataTransformerOptions,\n) {\n  const transformer = resolveTransformer(transformerOpts);\n  return (error: unknown) => {\n    if (!!error && typeof error === 'object' && 'error' in error) {\n      (error as any).error = transformer.output.deserialize(\n        (error as any).error,\n      );\n    }\n    return error;\n  };\n}\n\n/**\n * Configures a hey-api client for use with a tRPC OpenAPI backend.\n *\n * Sets up querySerializer, bodySerializer, responseTransformer, and\n * an error interceptor (for transformer-based error deserialization)\n * in a single call.\n *\n * @example\n * ```ts\n * import { configureTRPCHeyApiClient } from '@trpc/openapi/heyapi';\n * import superjson from 'superjson';\n * import { client } from './generated/client.gen';\n *\n * configureTRPCHeyApiClient(client, {\n *   baseUrl: 'http://localhost:3000',\n *   transformer: superjson,\n * });\n * ```\n *\n * @see https://trpc.io/docs/openapi#with-a-transformer-superjson-devalue-etc\n */\nexport function configureTRPCHeyApiClient(\n  client: Plugins.HeyApiClientFetch.Client,\n  opts: TRPCHeyApiClientOptions &\n    Omit<HeyApiConfig, keyof TRPCHeyApiClientConfig>,\n) {\n  const { transformer, ...heyConfig } = opts;\n  const trpcConfig = createTRPCHeyApiClientConfig({ transformer });\n\n  client.setConfig({ ...heyConfig, ...trpcConfig });\n\n  if (transformer) {\n    client.interceptors.error.use(createTRPCErrorInterceptor(transformer));\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAuLU,MAAA,YAAA,CAAA,aAAA;AA1IV,SAAS,mBACP,aAC6B;CAC7B,IAAI,WAAW,aACb,OAAO;CAET,OAAO;EAAE,OAAO;EAAa,QAAQ;CAAY;AACnD;;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,gCAAiD;CAC/D,OAAO;EACL,OAAO,KAAK;GACV,IAAI,IAAI,OAAO,WAAW,eAAe,IAAI,OAAO,WAAW,QAC7D,OAAO,IAAI,EAAE,KAAK,MAAM;EAG5B;EACA,OAAO,KAAK;GACV,IAAI,IAAI,OAAO,WAAW,UACxB,OAAO,IAAI,EAAE,KAAK,QAAQ;EAG9B;CACF;AACF;;;;AAKA,SAAgB,6BAA6B,MAAgC;CAC3E,MAAM,eAAA,SAAA,QAAA,SAAA,KAAA,IAAA,KAAA,IAAc,KAAM,eACtB,mBAAmB,KAAK,WAAW,IACnC,KAAA;CAEJ,OAAA,eAAA,EACE,kBAAkB,UAAmC;EACnD,MAAM,SAAS,IAAI,gBAAgB;EAEnC,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,KAAK,GAAG;GAChD,IAAI,UAAU,KAAA,GACZ;GAGF,IAAI,QAAQ,WAAW,aACrB,OAAO,OACL,KACA,KAAK,UAAU,YAAY,MAAM,UAAU,KAAK,CAAC,CACnD;QAEA,OAAO,OAAO,KAAK,KAAK,UAAU,KAAK,CAAC;EAE5C;EAEA,OAAO,OAAO,SAAS;CACzB,EAAA,GAEI,eAAe;EACjB,iBAAiB,SAAkB;GACjC,OAAO,KAAK,UAAU,YAAY,MAAM,UAAU,IAAI,CAAC;EACzD;EAEA,qBAAqB,OAAO,SAAkB;GAC5C,IAAI,CAAC,CAAC,QAAQ,OAAO,SAAS,YAAY,YAAY,MAAM;IAC1D,MAAM,SAAU,KAAa;IAC7B,IAAI,CAAC,OAAO,QAAQ,OAAO,SAAS,QAClC,OAAO,OAAO,YAAY,OAAO,YAAY,OAAO,IAAI;GAE5D;GAEA,OAAO;EACT;CACF,CACF;AACF;;;;AAKA,SAAgB,2BACd,iBACA;CACA,MAAM,cAAc,mBAAmB,eAAe;CACtD,QAAQ,UAAmB;EACzB,IAAI,CAAC,CAAC,SAAS,OAAO,UAAU,YAAY,WAAW,OACrD,MAAe,QAAQ,YAAY,OAAO,YACvC,MAAc,KACjB;EAEF,OAAO;CACT;AACF;;;;;;;;;;;;;;;;;;;;;;AAuBA,SAAgB,0BACd,QACA,MAEA;CACA,MAAM,EAAE,gBAAA,MAAgB,YAAA,yBAAc,MAAA,SAAA;CACtC,MAAM,aAAa,6BAA6B,EAAE,YAAY,CAAC;CAE/D,OAAO,UAAA,eAAA,eAAA,CAAA,GAAe,SAAA,GAAc,UAAW,CAAC;CAEhD,IAAI,aACF,OAAO,aAAa,MAAM,IAAI,2BAA2B,WAAW,CAAC;AAEzE"}

package/dist/index.cjs

@@ -1083,12 +1083,20 @@ function buildOpenAPIDocument(procedures, options, meta = { errorSchema: null })
 	});
 }
 /**
-* Analyse the given TypeScript router file using the TypeScript compiler and
-* return an OpenAPI 3.1 document describing all query and mutation procedures.
+* Reads your router file with the TypeScript compiler and returns an OpenAPI
+* 3.1 document for its queries and mutations.
 *
-* @param routerFilePath - Absolute or relative path to the file that exports
-*   the AppRouter.
-* @param options - Optional generation settings (export name, title, version).
+* @param routerFilePath - Path to the file that exports your router type.
+* @param options - Export name, title, version and servers.
+*
+* @example
+* ```ts
+* const doc = await generateOpenAPIDocument('./src/server/router.ts', {
+*   title: 'My API',
+* });
+* ```
+*
+* @see https://trpc.io/docs/openapi#programmatic
 */
 async function generateOpenAPIDocument(routerFilePath, options = {}) {
 	var _options$exportName;

package/dist/index.d.cts

@@ -92,6 +92,10 @@ type Document<T extends {} = {}> = Replace<OpenAPIV3_1.Document<T>, {
 }>;
 //#endregion
 //#region src/generate.d.ts
+/**
+ * Options for {@link generateOpenAPIDocument}.
+ * @see https://trpc.io/docs/openapi#programmatic
+ */
 interface GenerateOptions {
   /**
    * The name of the exported router symbol.
@@ -111,12 +115,20 @@ interface GenerateOptions {
   servers?: ServerObject[];
 }
 /**
- * Analyse the given TypeScript router file using the TypeScript compiler and
- * return an OpenAPI 3.1 document describing all query and mutation procedures.
+ * Reads your router file with the TypeScript compiler and returns an OpenAPI
+ * 3.1 document for its queries and mutations.
+ *
+ * @param routerFilePath - Path to the file that exports your router type.
+ * @param options - Export name, title, version and servers.
+ *
+ * @example
+ * ```ts
+ * const doc = await generateOpenAPIDocument('./src/server/router.ts', {
+ *   title: 'My API',
+ * });
+ * ```
  *
- * @param routerFilePath - Absolute or relative path to the file that exports
- *   the AppRouter.
- * @param options - Optional generation settings (export name, title, version).
+ * @see https://trpc.io/docs/openapi#programmatic
  */
 export declare function generateOpenAPIDocument(routerFilePath: string, options?: GenerateOptions): Promise<Document>;
 //#endregion

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types.ts","../src/generate.ts"],"mappings":";;;;KAEY,QAAQ,SAAS,gBAAgB,KAAK,eAAe,gBAC/D;KAEU;KAGA,sBAAsB;KAEtB,cAAc,YAAgB;KAC9B,kBAAkB,YAAgB;KAClC,gBAAgB,YAAgB;KAChC,sBAAsB,YAAgB;KACtC,8BACV,YAAgB;KACN,YAAY,YAAgB;KAC5B,aAAa,YAAgB;KAC7B,uBAAuB,YAAgB;KACvC,eAAe,YAAgB;KAE/B,eAAe,QACzB,YAAgB;EAEd;EACA,QAAQ,eAAe;EACvB;EACA;EACA,aAAa,eAAe;EAC5B;EACA,QAAQ;EACR,cAAc;EACd;EACA;EACA,QAAQ;EACR,QAAQ;EACR,QAAQ;EACR,MAAM;EACN,iCAAiC;EACjC,gBAAgB;EAChB,eAAe;EACf,MAAM;EACN;EACA;EACA;;KAIQ,aAAa;UAER,0BAA0B;EACzC;EACA,OAAO;;KAGG,kBAAkB,QAC5B,YAAgB;EAEd,SAAS,eAAe;EACxB,WAAW,eAAe,kBAAkB;;UAI/B,4BAA4B,QAC3C,YAAgB;EAEd,SAAS,eAAe;EACxB,WAAW,eAAe,kBAAkB;EAC5C,UAAU,eAAe;;UAIZ,wBAAwB;EACvC;EACA;;KAGU,eAAe;KAEf,oBAAoB,QAC9B,YAAgB;EAEd,SAAS,eAAe;;KAIhB,iBAAiB,QAC3B,YAAgB;EAEd,UAAU,eAAe,kBAAkB;EAC3C,UAAU,eAAe;EACzB,QAAQ,eAAe,kBAAkB;;KAIjC,kBAAkB,eAAe,kBAAkB;KAEnD,gBAAgB,qBAAqB,QAC/C,YAAgB,gBAAgB;EAE9B,cAAc,kBAAkB;EAChC,cAAc,kBAAkB;EAChC,YAAY;EACZ,YAAY,eAAe,kBAAkB;KAG/C;KAEU,eAAe,qBAAqB,QAC9C,YAAgB,eAAe;EAE7B,cAAc,kBAAkB;QAGjC,UAAU,eAAe,gBAAgB;KAGhC,YAAY,mBAAmB,yBAAyB,gBAEjE,eAAe,KAAK;KAGX,iBAAiB,eAAe,iBAAiB;KAEjD,mBAAmB,QAC7B,YAAgB;EAEd,UAAU,eAAe;EACzB,YAAY,eAAe,kBAAkB;EAC7C,aAAa,eAAe,kBAAkB;EAC9C,gBAAgB,eAAe,kBAAkB;EACjD,UAAU,eAAe,kBAAkB;EAC3C,QAAQ,eAAe,kBAAkB;EACzC,YAAY,eAAe,kBAAkB;EAC7C,YAAY,eAAe,kBAAkB;;KAIrC,SAAS,qBAAqB,QACxC,YAAgB,SAAS;EAEvB,QAAQ,YAAY;EACpB,aAAa;;;;UC5GA;;;;;EAKf;;EAEA;;EAEA;;;;;;;EAOA,UAAU;;;;;;;;;;wBAqoDU,wBACpB,wBACA,UAAS,kBACR,QAAQ"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types.ts","../src/generate.ts"],"mappings":";;;;KAEY,QAAQ,SAAS,gBAAgB,KAAK,eAAe,gBAC/D;KAEU;KASA,sBAAsB;KAEtB,cAAc,YAAgB;KAC9B,kBAAkB,YAAgB;KAClC,gBAAgB,YAAgB;KAChC,sBAAsB,YAAgB;KACtC,8BACV,YAAgB;KACN,YAAY,YAAgB;KAC5B,aAAa,YAAgB;KAC7B,uBAAuB,YAAgB;KACvC,eAAe,YAAgB;KAE/B,eAAe,QACzB,YAAgB;EAEd;EACA,QAAQ,eAAe;EACvB;EACA;EACA,aAAa,eAAe;EAC5B;EACA,QAAQ;EACR,cAAc;EACd;EACA;EACA,QAAQ;EACR,QAAQ;EACR,QAAQ;EACR,MAAM;EACN,iCAAiC;EACjC,gBAAgB;EAChB,eAAe;EACf,MAAM;EACN;EACA;EACA;;KAIQ,aAAa;UAER,0BAA0B;EACzC;EACA,OAAO;;KAGG,kBAAkB,QAC5B,YAAgB;EAEd,SAAS,eAAe;EACxB,WAAW,eAAe,kBAAkB;;UAI/B,4BAA4B,QAC3C,YAAgB;EAEd,SAAS,eAAe;EACxB,WAAW,eAAe,kBAAkB;EAC5C,UAAU,eAAe;;UAIZ,wBAAwB;EACvC;EACA;;KAGU,eAAe;KAEf,oBAAoB,QAC9B,YAAgB;EAEd,SAAS,eAAe;;KAIhB,iBAAiB,QAC3B,YAAgB;EAEd,UAAU,eAAe,kBAAkB;EAC3C,UAAU,eAAe;EACzB,QAAQ,eAAe,kBAAkB;;KAIjC,kBAAkB,eAAe,kBAAkB;KAEnD,gBAAgB,qBAAqB,QAC/C,YAAgB,gBAAgB;EAE9B,cAAc,kBAAkB;EAChC,cAAc,kBAAkB;EAChC,YAAY;EACZ,YAAY,eAAe,kBAAkB;KAG/C;KAEU,eAAe,qBAAqB,QAC9C,YAAgB,eAAe;EAE7B,cAAc,kBAAkB;QAGjC,UAAU,eAAe,gBAAgB;KAGhC,YAAY,mBAAmB,yBAAyB,gBAEjE,eAAe,KAAK;KAGX,iBAAiB,eAAe,iBAAiB;KAEjD,mBAAmB,QAC7B,YAAgB;EAEd,UAAU,eAAe;EACzB,YAAY,eAAe,kBAAkB;EAC7C,aAAa,eAAe,kBAAkB;EAC9C,gBAAgB,eAAe,kBAAkB;EACjD,UAAU,eAAe,kBAAkB;EAC3C,QAAQ,eAAe,kBAAkB;EACzC,YAAY,eAAe,kBAAkB;EAC7C,YAAY,eAAe,kBAAkB;;KAIrC,SAAS,qBAAqB,QACxC,YAAgB,SAAS;EAEvB,QAAQ,YAAY;EACpB,aAAa;;;;;;;;UC9GA;;;;;EAKf;;EAEA;;EAEA;;;;;;;EAOA,UAAU;;;;;;;;;;;;;;;;;;wBA6oDU,wBACpB,wBACA,UAAS,kBACR,QAAQ"}

package/dist/index.d.mts

@@ -92,6 +92,10 @@ type Document<T extends {} = {}> = Replace<OpenAPIV3_1.Document<T>, {
 }>;
 //#endregion
 //#region src/generate.d.ts
+/**
+ * Options for {@link generateOpenAPIDocument}.
+ * @see https://trpc.io/docs/openapi#programmatic
+ */
 interface GenerateOptions {
   /**
    * The name of the exported router symbol.
@@ -111,12 +115,20 @@ interface GenerateOptions {
   servers?: ServerObject[];
 }
 /**
- * Analyse the given TypeScript router file using the TypeScript compiler and
- * return an OpenAPI 3.1 document describing all query and mutation procedures.
+ * Reads your router file with the TypeScript compiler and returns an OpenAPI
+ * 3.1 document for its queries and mutations.
+ *
+ * @param routerFilePath - Path to the file that exports your router type.
+ * @param options - Export name, title, version and servers.
+ *
+ * @example
+ * ```ts
+ * const doc = await generateOpenAPIDocument('./src/server/router.ts', {
+ *   title: 'My API',
+ * });
+ * ```
  *
- * @param routerFilePath - Absolute or relative path to the file that exports
- *   the AppRouter.
- * @param options - Optional generation settings (export name, title, version).
+ * @see https://trpc.io/docs/openapi#programmatic
  */
 export declare function generateOpenAPIDocument(routerFilePath: string, options?: GenerateOptions): Promise<Document>;
 //#endregion

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/generate.ts"],"mappings":";;;;KAEY,QAAQ,SAAS,gBAAgB,KAAK,eAAe,gBAC/D;KAEU;KAGA,sBAAsB;KAEtB,cAAc,YAAgB;KAC9B,kBAAkB,YAAgB;KAClC,gBAAgB,YAAgB;KAChC,sBAAsB,YAAgB;KACtC,8BACV,YAAgB;KACN,YAAY,YAAgB;KAC5B,aAAa,YAAgB;KAC7B,uBAAuB,YAAgB;KACvC,eAAe,YAAgB;KAE/B,eAAe,QACzB,YAAgB;EAEd;EACA,QAAQ,eAAe;EACvB;EACA;EACA,aAAa,eAAe;EAC5B;EACA,QAAQ;EACR,cAAc;EACd;EACA;EACA,QAAQ;EACR,QAAQ;EACR,QAAQ;EACR,MAAM;EACN,iCAAiC;EACjC,gBAAgB;EAChB,eAAe;EACf,MAAM;EACN;EACA;EACA;;KAIQ,aAAa;UAER,0BAA0B;EACzC;EACA,OAAO;;KAGG,kBAAkB,QAC5B,YAAgB;EAEd,SAAS,eAAe;EACxB,WAAW,eAAe,kBAAkB;;UAI/B,4BAA4B,QAC3C,YAAgB;EAEd,SAAS,eAAe;EACxB,WAAW,eAAe,kBAAkB;EAC5C,UAAU,eAAe;;UAIZ,wBAAwB;EACvC;EACA;;KAGU,eAAe;KAEf,oBAAoB,QAC9B,YAAgB;EAEd,SAAS,eAAe;;KAIhB,iBAAiB,QAC3B,YAAgB;EAEd,UAAU,eAAe,kBAAkB;EAC3C,UAAU,eAAe;EACzB,QAAQ,eAAe,kBAAkB;;KAIjC,kBAAkB,eAAe,kBAAkB;KAEnD,gBAAgB,qBAAqB,QAC/C,YAAgB,gBAAgB;EAE9B,cAAc,kBAAkB;EAChC,cAAc,kBAAkB;EAChC,YAAY;EACZ,YAAY,eAAe,kBAAkB;KAG/C;KAEU,eAAe,qBAAqB,QAC9C,YAAgB,eAAe;EAE7B,cAAc,kBAAkB;QAGjC,UAAU,eAAe,gBAAgB;KAGhC,YAAY,mBAAmB,yBAAyB,gBAEjE,eAAe,KAAK;KAGX,iBAAiB,eAAe,iBAAiB;KAEjD,mBAAmB,QAC7B,YAAgB;EAEd,UAAU,eAAe;EACzB,YAAY,eAAe,kBAAkB;EAC7C,aAAa,eAAe,kBAAkB;EAC9C,gBAAgB,eAAe,kBAAkB;EACjD,UAAU,eAAe,kBAAkB;EAC3C,QAAQ,eAAe,kBAAkB;EACzC,YAAY,eAAe,kBAAkB;EAC7C,YAAY,eAAe,kBAAkB;;KAIrC,SAAS,qBAAqB,QACxC,YAAgB,SAAS;EAEvB,QAAQ,YAAY;EACpB,aAAa;;;;UC5GA;;;;;EAKf;;EAEA;;EAEA;;;;;;;EAOA,UAAU;;;;;;;;;;wBAqoDU,wBACpB,wBACA,UAAS,kBACR,QAAQ"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/generate.ts"],"mappings":";;;;KAEY,QAAQ,SAAS,gBAAgB,KAAK,eAAe,gBAC/D;KAEU;KASA,sBAAsB;KAEtB,cAAc,YAAgB;KAC9B,kBAAkB,YAAgB;KAClC,gBAAgB,YAAgB;KAChC,sBAAsB,YAAgB;KACtC,8BACV,YAAgB;KACN,YAAY,YAAgB;KAC5B,aAAa,YAAgB;KAC7B,uBAAuB,YAAgB;KACvC,eAAe,YAAgB;KAE/B,eAAe,QACzB,YAAgB;EAEd;EACA,QAAQ,eAAe;EACvB;EACA;EACA,aAAa,eAAe;EAC5B;EACA,QAAQ;EACR,cAAc;EACd;EACA;EACA,QAAQ;EACR,QAAQ;EACR,QAAQ;EACR,MAAM;EACN,iCAAiC;EACjC,gBAAgB;EAChB,eAAe;EACf,MAAM;EACN;EACA;EACA;;KAIQ,aAAa;UAER,0BAA0B;EACzC;EACA,OAAO;;KAGG,kBAAkB,QAC5B,YAAgB;EAEd,SAAS,eAAe;EACxB,WAAW,eAAe,kBAAkB;;UAI/B,4BAA4B,QAC3C,YAAgB;EAEd,SAAS,eAAe;EACxB,WAAW,eAAe,kBAAkB;EAC5C,UAAU,eAAe;;UAIZ,wBAAwB;EACvC;EACA;;KAGU,eAAe;KAEf,oBAAoB,QAC9B,YAAgB;EAEd,SAAS,eAAe;;KAIhB,iBAAiB,QAC3B,YAAgB;EAEd,UAAU,eAAe,kBAAkB;EAC3C,UAAU,eAAe;EACzB,QAAQ,eAAe,kBAAkB;;KAIjC,kBAAkB,eAAe,kBAAkB;KAEnD,gBAAgB,qBAAqB,QAC/C,YAAgB,gBAAgB;EAE9B,cAAc,kBAAkB;EAChC,cAAc,kBAAkB;EAChC,YAAY;EACZ,YAAY,eAAe,kBAAkB;KAG/C;KAEU,eAAe,qBAAqB,QAC9C,YAAgB,eAAe;EAE7B,cAAc,kBAAkB;QAGjC,UAAU,eAAe,gBAAgB;KAGhC,YAAY,mBAAmB,yBAAyB,gBAEjE,eAAe,KAAK;KAGX,iBAAiB,eAAe,iBAAiB;KAEjD,mBAAmB,QAC7B,YAAgB;EAEd,UAAU,eAAe;EACzB,YAAY,eAAe,kBAAkB;EAC7C,aAAa,eAAe,kBAAkB;EAC9C,gBAAgB,eAAe,kBAAkB;EACjD,UAAU,eAAe,kBAAkB;EAC3C,QAAQ,eAAe,kBAAkB;EACzC,YAAY,eAAe,kBAAkB;EAC7C,YAAY,eAAe,kBAAkB;;KAIrC,SAAS,qBAAqB,QACxC,YAAgB,SAAS;EAEvB,QAAQ,YAAY;EACpB,aAAa;;;;;;;;UC9GA;;;;;EAKf;;EAEA;;EAEA;;;;;;;EAOA,UAAU;;;;;;;;;;;;;;;;;;wBA6oDU,wBACpB,wBACA,UAAS,kBACR,QAAQ"}

package/dist/index.mjs

@@ -1049,12 +1049,20 @@ function buildOpenAPIDocument(procedures, options, meta = { errorSchema: null })
 	});
 }
 /**
-* Analyse the given TypeScript router file using the TypeScript compiler and
-* return an OpenAPI 3.1 document describing all query and mutation procedures.
+* Reads your router file with the TypeScript compiler and returns an OpenAPI
+* 3.1 document for its queries and mutations.
 *
-* @param routerFilePath - Absolute or relative path to the file that exports
-*   the AppRouter.
-* @param options - Optional generation settings (export name, title, version).
+* @param routerFilePath - Path to the file that exports your router type.
+* @param options - Export name, title, version and servers.
+*
+* @example
+* ```ts
+* const doc = await generateOpenAPIDocument('./src/server/router.ts', {
+*   title: 'My API',
+* });
+* ```
+*
+* @see https://trpc.io/docs/openapi#programmatic
 */
 async function generateOpenAPIDocument(routerFilePath, options = {}) {
 	var _options$exportName;