@orpc/openapi 0.0.0-next.f4ed9ab → 0.0.0-next.f50512c

package/dist/shared/openapi.DPAN3GVs.d.ts

@@ -0,0 +1,108 @@
+import { AnySchema, OpenAPI, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
+import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
+import { AnyProcedure, TraverseContractProcedureCallbackOptions, AnyRouter } from '@orpc/server';
+import { Promisable, Value } from '@orpc/shared';
+import { JSONSchema } from 'json-schema-typed/draft-2020-12';
+
+interface SchemaConverterComponent {
+    allowedStrategies: readonly SchemaConvertOptions['strategy'][];
+    schema: AnySchema;
+    required: boolean;
+    ref: string;
+}
+interface SchemaConvertOptions {
+    strategy: 'input' | 'output';
+    /**
+     * Common components should use `$ref` to represent themselves if matched.
+     */
+    components?: readonly SchemaConverterComponent[];
+    /**
+     * Minimum schema structure depth required before using `$ref` for components.
+     *
+     * For example, if set to 2, `$ref` will only be used for schemas nested at depth 2 or greater.
+     *
+     * @default 0 - No depth limit;
+     */
+    minStructureDepthForRef?: number;
+}
+interface SchemaConverter {
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
+}
+interface ConditionalSchemaConverter extends SchemaConverter {
+    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
+}
+declare class CompositeSchemaConverter implements SchemaConverter {
+    private readonly converters;
+    constructor(converters: readonly ConditionalSchemaConverter[]);
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
+}
+
+interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
+    schemaConverters?: ConditionalSchemaConverter[];
+}
+interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document, 'openapi'>> {
+    /**
+     * Exclude procedures from the OpenAPI specification.
+     *
+     * @deprecated Use `filter` option instead.
+     * @default () => false
+     */
+    exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
+    /**
+     * Filter procedures. Return `false` to exclude a procedure from the OpenAPI specification.
+     *
+     * @default true
+     */
+    filter?: Value<boolean, [options: TraverseContractProcedureCallbackOptions]>;
+    /**
+     * Common schemas to be used for $ref resolution.
+     */
+    commonSchemas?: Record<string, {
+        /**
+         * Determines which schema definition to use when input and output schemas differ.
+         * This is needed because some schemas transform data differently between input and output,
+         * making it impossible to use a single $ref for both cases.
+         *
+         * @example
+         * ```ts
+         * // This schema transforms a string input into a number output
+         * const Schema = z.string()
+         *   .transform(v => Number(v))
+         *   .pipe(z.number())
+         *
+         * // Input schema:  { type: 'string' }
+         * // Output schema: { type: 'number' }
+         * ```
+         *
+         * When schemas differ between input and output, you must explicitly choose
+         * which version to use for the OpenAPI specification.
+         *
+         * @default 'input' - Uses the input schema definition by default
+         */
+        strategy?: SchemaConvertOptions['strategy'];
+        schema: AnySchema;
+    } | {
+        error: 'UndefinedError';
+        schema?: never;
+    }>;
+}
+/**
+ * The generator that converts oRPC routers/contracts to OpenAPI specifications.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
+ */
+declare class OpenAPIGenerator {
+    #private;
+    private readonly serializer;
+    private readonly converter;
+    constructor(options?: OpenAPIGeneratorOptions);
+    /**
+     * Generates OpenAPI specifications from oRPC routers/contracts.
+     *
+     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
+     */
+    generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
+}
+
+export { OpenAPIGenerator as b, CompositeSchemaConverter as e };
+export type { ConditionalSchemaConverter as C, OpenAPIGeneratorOptions as O, SchemaConverterComponent as S, OpenAPIGeneratorGenerateOptions as a, SchemaConvertOptions as c, SchemaConverter as d };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/openapi",
   "type": "module",
-  "version": "0.0.0-next.f4ed9ab",
+  "version": "0.0.0-next.f50512c",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -38,6 +38,11 @@
       "types": "./dist/adapters/node/index.d.mts",
       "import": "./dist/adapters/node/index.mjs",
       "default": "./dist/adapters/node/index.mjs"
+    },
+    "./aws-lambda": {
+      "types": "./dist/adapters/aws-lambda/index.d.mts",
+      "import": "./dist/adapters/aws-lambda/index.mjs",
+      "default": "./dist/adapters/aws-lambda/index.mjs"
     }
   },
   "files": [
@@ -45,17 +50,16 @@
   ],
   "dependencies": {
     "json-schema-typed": "^8.0.1",
-    "openapi-types": "^12.1.3",
-    "rou3": "^0.6.0",
-    "@orpc/contract": "0.0.0-next.f4ed9ab",
-    "@orpc/openapi-client": "0.0.0-next.f4ed9ab",
-    "@orpc/shared": "0.0.0-next.f4ed9ab",
-    "@orpc/standard-server": "0.0.0-next.f4ed9ab",
-    "@orpc/server": "0.0.0-next.f4ed9ab",
-    "@orpc/client": "0.0.0-next.f4ed9ab"
+    "rou3": "^0.7.3",
+    "@orpc/contract": "0.0.0-next.f50512c",
+    "@orpc/openapi-client": "0.0.0-next.f50512c",
+    "@orpc/client": "0.0.0-next.f50512c",
+    "@orpc/server": "0.0.0-next.f50512c",
+    "@orpc/shared": "0.0.0-next.f50512c",
+    "@orpc/standard-server": "0.0.0-next.f50512c"
   },
   "devDependencies": {
-    "zod": "3.25.0-beta.20250516T005923"
+    "zod": "^4.0.5"
   },
   "scripts": {
     "build": "unbuild",

package/dist/shared/openapi.CwdCLgSU.d.mts

@@ -1,53 +0,0 @@
-import { AnySchema, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
-import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
-import { AnyProcedure, AnyRouter } from '@orpc/server';
-import { OpenAPIV3_1 } from 'openapi-types';
-import { Promisable } from '@orpc/shared';
-import { JSONSchema } from 'json-schema-typed/draft-2020-12';
-
-interface SchemaConvertOptions {
-    strategy: 'input' | 'output';
-}
-interface SchemaConverter {
-    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
-}
-interface ConditionalSchemaConverter extends SchemaConverter {
-    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
-}
-declare class CompositeSchemaConverter implements SchemaConverter {
-    private readonly converters;
-    constructor(converters: ConditionalSchemaConverter[]);
-    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
-}
-
-interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
-    schemaConverters?: ConditionalSchemaConverter[];
-}
-interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPIV3_1.Document, 'openapi'>> {
-    /**
-     * Exclude procedures from the OpenAPI specification.
-     *
-     * @default () => false
-     */
-    exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
-}
-/**
- * The generator that converts oRPC routers/contracts to OpenAPI specifications.
- *
- * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
- */
-declare class OpenAPIGenerator {
-    #private;
-    private readonly serializer;
-    private readonly converter;
-    constructor(options?: OpenAPIGeneratorOptions);
-    /**
-     * Generates OpenAPI specifications from oRPC routers/contracts.
-     *
-     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
-     */
-    generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPIV3_1.Document>;
-}
-
-export { OpenAPIGenerator as b, CompositeSchemaConverter as d };
-export type { ConditionalSchemaConverter as C, OpenAPIGeneratorOptions as O, SchemaConvertOptions as S, OpenAPIGeneratorGenerateOptions as a, SchemaConverter as c };

package/dist/shared/openapi.CwdCLgSU.d.ts

@@ -1,53 +0,0 @@
-import { AnySchema, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
-import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
-import { AnyProcedure, AnyRouter } from '@orpc/server';
-import { OpenAPIV3_1 } from 'openapi-types';
-import { Promisable } from '@orpc/shared';
-import { JSONSchema } from 'json-schema-typed/draft-2020-12';
-
-interface SchemaConvertOptions {
-    strategy: 'input' | 'output';
-}
-interface SchemaConverter {
-    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
-}
-interface ConditionalSchemaConverter extends SchemaConverter {
-    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
-}
-declare class CompositeSchemaConverter implements SchemaConverter {
-    private readonly converters;
-    constructor(converters: ConditionalSchemaConverter[]);
-    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
-}
-
-interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
-    schemaConverters?: ConditionalSchemaConverter[];
-}
-interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPIV3_1.Document, 'openapi'>> {
-    /**
-     * Exclude procedures from the OpenAPI specification.
-     *
-     * @default () => false
-     */
-    exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
-}
-/**
- * The generator that converts oRPC routers/contracts to OpenAPI specifications.
- *
- * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
- */
-declare class OpenAPIGenerator {
-    #private;
-    private readonly serializer;
-    private readonly converter;
-    constructor(options?: OpenAPIGeneratorOptions);
-    /**
-     * Generates OpenAPI specifications from oRPC routers/contracts.
-     *
-     * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
-     */
-    generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPIV3_1.Document>;
-}
-
-export { OpenAPIGenerator as b, CompositeSchemaConverter as d };
-export type { ConditionalSchemaConverter as C, OpenAPIGeneratorOptions as O, SchemaConvertOptions as S, OpenAPIGeneratorGenerateOptions as a, SchemaConverter as c };

package/dist/shared/openapi.D3j94c9n.d.mts

@@ -1,12 +0,0 @@
-import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
-import { Context, Router } from '@orpc/server';
-import { StandardHandlerOptions, StandardHandler } from '@orpc/server/standard';
-
-interface StandardOpenAPIHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardOpenAPIJsonSerializerOptions {
-}
-declare class StandardOpenAPIHandler<T extends Context> extends StandardHandler<T> {
-    constructor(router: Router<any, T>, options: NoInfer<StandardOpenAPIHandlerOptions<T>>);
-}
-
-export { StandardOpenAPIHandler as a };
-export type { StandardOpenAPIHandlerOptions as S };

package/dist/shared/openapi.D3j94c9n.d.ts

@@ -1,12 +0,0 @@
-import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
-import { Context, Router } from '@orpc/server';
-import { StandardHandlerOptions, StandardHandler } from '@orpc/server/standard';
-
-interface StandardOpenAPIHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardOpenAPIJsonSerializerOptions {
-}
-declare class StandardOpenAPIHandler<T extends Context> extends StandardHandler<T> {
-    constructor(router: Router<any, T>, options: NoInfer<StandardOpenAPIHandlerOptions<T>>);
-}
-
-export { StandardOpenAPIHandler as a };
-export type { StandardOpenAPIHandlerOptions as S };