@orpc/openapi 1.5.1 → 1.6.0

package/README.md

@@ -30,7 +30,7 @@
 - **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
 - **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
 - **📝 Contract-First Development**: Optionally define your API contract before implementation.
-- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
+- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), Pinia Colada, and more.
 - **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
 - **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
 - **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { OpenAPI, AnyContractProcedure } from '@orpc/contract';
 export { OpenAPI } from '@orpc/contract';
-export { e as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, c as SchemaConvertOptions, d as SchemaConverter, S as SchemaConverterComponent } from './shared/openapi.CbIlrReM.mjs';
+export { e as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, c as SchemaConvertOptions, d as SchemaConverter, S as SchemaConverterComponent } from './shared/openapi.B3hexduL.mjs';
 import { HTTPPath, HTTPMethod } from '@orpc/client';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from 'json-schema-typed/draft-2020-12';

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { OpenAPI, AnyContractProcedure } from '@orpc/contract';
 export { OpenAPI } from '@orpc/contract';
-export { e as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, c as SchemaConvertOptions, d as SchemaConverter, S as SchemaConverterComponent } from './shared/openapi.CbIlrReM.js';
+export { e as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, c as SchemaConvertOptions, d as SchemaConverter, S as SchemaConverterComponent } from './shared/openapi.B3hexduL.js';
 import { HTTPPath, HTTPMethod } from '@orpc/client';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat, TypeName as JSONSchemaTypeName } from 'json-schema-typed/draft-2020-12';

package/dist/index.mjs

@@ -1,5 +1,5 @@
-import { c as customOpenAPIOperation } from './shared/openapi.C_3bk7bB.mjs';
-export { C as CompositeSchemaConverter, L as LOGIC_KEYWORDS, O as OpenAPIGenerator, a as applyCustomOpenAPIOperation, n as applySchemaOptionality, h as checkParamsSchema, p as expandArrayableSchema, o as expandUnionSchema, m as filterSchemaBranches, g as getCustomOpenAPIOperation, l as isAnySchema, j as isFileSchema, k as isObjectSchema, q as isPrimitiveSchema, r as resolveOpenAPIJsonSchemaRef, s as separateObjectSchema, d as toOpenAPIContent, e as toOpenAPIEventIteratorContent, b as toOpenAPIMethod, f as toOpenAPIParameters, t as toOpenAPIPath, i as toOpenAPISchema } from './shared/openapi.C_3bk7bB.mjs';
+import { c as customOpenAPIOperation } from './shared/openapi.DrrBsJ0w.mjs';
+export { C as CompositeSchemaConverter, L as LOGIC_KEYWORDS, O as OpenAPIGenerator, a as applyCustomOpenAPIOperation, n as applySchemaOptionality, h as checkParamsSchema, p as expandArrayableSchema, o as expandUnionSchema, m as filterSchemaBranches, g as getCustomOpenAPIOperation, l as isAnySchema, j as isFileSchema, k as isObjectSchema, q as isPrimitiveSchema, r as resolveOpenAPIJsonSchemaRef, s as separateObjectSchema, d as toOpenAPIContent, e as toOpenAPIEventIteratorContent, b as toOpenAPIMethod, f as toOpenAPIParameters, t as toOpenAPIPath, i as toOpenAPISchema } from './shared/openapi.DrrBsJ0w.mjs';
 import { createORPCErrorFromJson } from '@orpc/client';
 import { StandardOpenAPISerializer, StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer } from '@orpc/openapi-client/standard';
 import { ORPCError, createRouterClient } from '@orpc/server';

package/dist/plugins/index.d.mts

@@ -2,7 +2,7 @@ import { OpenAPI } from '@orpc/contract';
 import { Context, HTTPPath, Router } from '@orpc/server';
 import { StandardHandlerInterceptorOptions, StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
 import { Value, Promisable } from '@orpc/shared';
-import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.CbIlrReM.mjs';
+import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.B3hexduL.mjs';
 import '@orpc/openapi-client/standard';
 import 'json-schema-typed/draft-2020-12';
 

package/dist/plugins/index.d.ts

@@ -2,7 +2,7 @@ import { OpenAPI } from '@orpc/contract';
 import { Context, HTTPPath, Router } from '@orpc/server';
 import { StandardHandlerInterceptorOptions, StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
 import { Value, Promisable } from '@orpc/shared';
-import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.CbIlrReM.js';
+import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.B3hexduL.js';
 import '@orpc/openapi-client/standard';
 import 'json-schema-typed/draft-2020-12';
 

package/dist/plugins/index.mjs

@@ -1,5 +1,5 @@
 import { stringifyJSON, once, value } from '@orpc/shared';
-import { O as OpenAPIGenerator } from '../shared/openapi.C_3bk7bB.mjs';
+import { O as OpenAPIGenerator } from '../shared/openapi.DrrBsJ0w.mjs';
 import '@orpc/client';
 import '@orpc/client/standard';
 import '@orpc/contract';

package/dist/shared/{openapi.CbIlrReM.d.mts → openapi.B3hexduL.d.mts}

@@ -5,7 +5,7 @@ import { Promisable } from '@orpc/shared';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 
 interface SchemaConverterComponent {
-    allowedStrategies: SchemaConvertOptions['strategy'][];
+    allowedStrategies: readonly SchemaConvertOptions['strategy'][];
     schema: AnySchema;
     required: boolean;
     ref: string;
@@ -15,7 +15,7 @@ interface SchemaConvertOptions {
     /**
      * Common components should use `$ref` to represent themselves if matched.
      */
-    components?: SchemaConverterComponent[];
+    components?: readonly SchemaConverterComponent[];
     /**
      * Minimum schema structure depth required before using `$ref` for components.
      *
@@ -74,6 +74,9 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
          */
         strategy?: SchemaConvertOptions['strategy'];
         schema: AnySchema;
+    } | {
+        error: 'UndefinedError';
+        schema?: never;
     }>;
 }
 /**

package/dist/shared/{openapi.CbIlrReM.d.ts → openapi.B3hexduL.d.ts}

@@ -5,7 +5,7 @@ import { Promisable } from '@orpc/shared';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
 
 interface SchemaConverterComponent {
-    allowedStrategies: SchemaConvertOptions['strategy'][];
+    allowedStrategies: readonly SchemaConvertOptions['strategy'][];
     schema: AnySchema;
     required: boolean;
     ref: string;
@@ -15,7 +15,7 @@ interface SchemaConvertOptions {
     /**
      * Common components should use `$ref` to represent themselves if matched.
      */
-    components?: SchemaConverterComponent[];
+    components?: readonly SchemaConverterComponent[];
     /**
      * Minimum schema structure depth required before using `$ref` for components.
      *
@@ -74,6 +74,9 @@ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document,
          */
         strategy?: SchemaConvertOptions['strategy'];
         schema: AnySchema;
+    } | {
+        error: 'UndefinedError';
+        schema?: never;
     }>;
 }
 /**

package/dist/shared/{openapi.C_3bk7bB.mjs → openapi.DrrBsJ0w.mjs}

@@ -393,7 +393,7 @@ class OpenAPIGenerator {
       exclude: void 0,
       commonSchemas: void 0
     };
-    const baseSchemaConvertOptions = await this.#resolveCommonSchemas(doc, options.commonSchemas);
+    const { baseSchemaConvertOptions, undefinedErrorJsonSchema } = await this.#resolveCommonSchemas(doc, options.commonSchemas);
     const contracts = [];
     await resolveContractProcedures({ path: [], router }, ({ contract, path }) => {
       if (!exclude(contract, path)) {
@@ -420,7 +420,7 @@ class OpenAPIGenerator {
           };
           await this.#request(doc, operationObjectRef, def, baseSchemaConvertOptions);
           await this.#successResponse(doc, operationObjectRef, def, baseSchemaConvertOptions);
-          await this.#errorResponse(operationObjectRef, def, baseSchemaConvertOptions);
+          await this.#errorResponse(operationObjectRef, def, baseSchemaConvertOptions, undefinedErrorJsonSchema);
         }
         doc.paths ??= {};
         doc.paths[httpPath] ??= {};
@@ -445,11 +445,26 @@ ${errors.join("\n\n")}`
     return this.serializer.serialize(doc)[0];
   }
   async #resolveCommonSchemas(doc, commonSchemas) {
-    const baseOptions = {};
+    let undefinedErrorJsonSchema = {
+      type: "object",
+      properties: {
+        defined: { const: false },
+        code: { type: "string" },
+        status: { type: "number" },
+        message: { type: "string" },
+        data: {}
+      },
+      required: ["defined", "code", "status", "message"]
+    };
+    const baseSchemaConvertOptions = {};
     if (commonSchemas) {
-      baseOptions.components = [];
+      baseSchemaConvertOptions.components = [];
       for (const key in commonSchemas) {
-        const { schema, strategy = "input" } = commonSchemas[key];
+        const options = commonSchemas[key];
+        if (options.schema === void 0) {
+          continue;
+        }
+        const { schema, strategy = "input" } = options;
         const [required, json] = await this.converter.convert(schema, { strategy });
         const allowedStrategies = [strategy];
         if (strategy === "input") {
@@ -463,7 +478,7 @@ ${errors.join("\n\n")}`
             allowedStrategies.push("input");
           }
         }
-        baseOptions.components.push({
+        baseSchemaConvertOptions.components.push({
           schema,
           required,
           ref: `#/components/schemas/${key}`,
@@ -473,11 +488,19 @@ ${errors.join("\n\n")}`
       doc.components ??= {};
       doc.components.schemas ??= {};
       for (const key in commonSchemas) {
-        const { schema, strategy = "input" } = commonSchemas[key];
+        const options = commonSchemas[key];
+        if (options.schema === void 0) {
+          if (options.error === "UndefinedError") {
+            doc.components.schemas[key] = toOpenAPISchema(undefinedErrorJsonSchema);
+            undefinedErrorJsonSchema = { $ref: `#/components/schemas/${key}` };
+          }
+          continue;
+        }
+        const { schema, strategy = "input" } = options;
         const [, json] = await this.converter.convert(
           schema,
           {
-            ...baseOptions,
+            ...baseSchemaConvertOptions,
             strategy,
             minStructureDepthForRef: 1
             // not allow use $ref for root schemas
@@ -486,7 +509,7 @@ ${errors.join("\n\n")}`
         doc.components.schemas[key] = toOpenAPISchema(json);
       }
     }
-    return baseOptions;
+    return { baseSchemaConvertOptions, undefinedErrorJsonSchema };
   }
   async #request(doc, ref, def, baseSchemaConvertOptions) {
     const method = fallbackContractConfig("defaultMethod", def.route.method);
@@ -672,7 +695,7 @@ ${errors.join("\n\n")}`
       }
     }
   }
-  async #errorResponse(ref, def, baseSchemaConvertOptions) {
+  async #errorResponse(ref, def, baseSchemaConvertOptions, undefinedErrorSchema) {
     const errorMap = def.errorMap;
     const errors = {};
     for (const code in errorMap) {
@@ -704,17 +727,7 @@ ${errors.join("\n\n")}`
         content: toOpenAPIContent({
           oneOf: [
             ...schemas,
-            {
-              type: "object",
-              properties: {
-                defined: { const: false },
-                code: { type: "string" },
-                status: { type: "number" },
-                message: { type: "string" },
-                data: {}
-              },
-              required: ["defined", "code", "status", "message"]
-            }
+            undefinedErrorSchema
           ]
         })
       };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/openapi",
   "type": "module",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -50,16 +50,16 @@
   ],
   "dependencies": {
     "json-schema-typed": "^8.0.1",
-    "rou3": "^0.6.0",
-    "@orpc/contract": "1.5.1",
-    "@orpc/client": "1.5.1",
-    "@orpc/openapi-client": "1.5.1",
-    "@orpc/shared": "1.5.1",
-    "@orpc/standard-server": "1.5.1",
-    "@orpc/server": "1.5.1"
+    "rou3": "^0.7.2",
+    "@orpc/client": "1.6.0",
+    "@orpc/contract": "1.6.0",
+    "@orpc/openapi-client": "1.6.0",
+    "@orpc/server": "1.6.0",
+    "@orpc/shared": "1.6.0",
+    "@orpc/standard-server": "1.6.0"
   },
   "devDependencies": {
-    "zod": "^3.25.63"
+    "zod": "^3.25.67"
   },
   "scripts": {
     "build": "unbuild",