@orpc/openapi 0.0.0-next.e563486 → 0.0.0-next.e7896e2

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

@@ -0,0 +1,52 @@
+import { AnySchema, OpenAPI, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
+import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
+import { AnyProcedure, AnyRouter } from '@orpc/server';
+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<OpenAPI.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<OpenAPI.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.qZLdpE0a.d.ts

@@ -0,0 +1,52 @@
+import { AnySchema, OpenAPI, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
+import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
+import { AnyProcedure, AnyRouter } from '@orpc/server';
+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<OpenAPI.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<OpenAPI.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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/openapi",
   "type": "module",
-  "version": "0.0.0-next.e563486",
+  "version": "0.0.0-next.e7896e2",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -19,6 +19,11 @@
       "import": "./dist/index.mjs",
       "default": "./dist/index.mjs"
     },
+    "./plugins": {
+      "types": "./dist/plugins/index.d.mts",
+      "import": "./dist/plugins/index.mjs",
+      "default": "./dist/plugins/index.mjs"
+    },
     "./standard": {
       "types": "./dist/adapters/standard/index.d.mts",
       "import": "./dist/adapters/standard/index.mjs",
@@ -29,20 +34,15 @@
       "import": "./dist/adapters/fetch/index.mjs",
       "default": "./dist/adapters/fetch/index.mjs"
     },
-    "./hono": {
-      "types": "./dist/adapters/hono/index.d.mts",
-      "import": "./dist/adapters/hono/index.mjs",
-      "default": "./dist/adapters/hono/index.mjs"
-    },
-    "./next": {
-      "types": "./dist/adapters/next/index.d.mts",
-      "import": "./dist/adapters/next/index.mjs",
-      "default": "./dist/adapters/next/index.mjs"
-    },
     "./node": {
       "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": [
@@ -50,19 +50,16 @@
   ],
   "dependencies": {
     "json-schema-typed": "^8.0.1",
-    "openapi-types": "^12.1.3",
-    "rou3": "^0.5.1",
-    "@orpc/client": "0.0.0-next.e563486",
-    "@orpc/contract": "0.0.0-next.e563486",
-    "@orpc/openapi-client": "0.0.0-next.e563486",
-    "@orpc/standard-server": "0.0.0-next.e563486",
-    "@orpc/server": "0.0.0-next.e563486",
-    "@orpc/standard-server-fetch": "0.0.0-next.e563486",
-    "@orpc/standard-server-node": "0.0.0-next.e563486",
-    "@orpc/shared": "0.0.0-next.e563486"
+    "rou3": "^0.6.0",
+    "@orpc/client": "0.0.0-next.e7896e2",
+    "@orpc/openapi-client": "0.0.0-next.e7896e2",
+    "@orpc/contract": "0.0.0-next.e7896e2",
+    "@orpc/server": "0.0.0-next.e7896e2",
+    "@orpc/standard-server": "0.0.0-next.e7896e2",
+    "@orpc/shared": "0.0.0-next.e7896e2"
   },
   "devDependencies": {
-    "zod": "^3.24.2"
+    "zod": "^3.25.49"
   },
   "scripts": {
     "build": "unbuild",

package/dist/adapters/hono/index.d.mts

@@ -1,8 +0,0 @@
-export { OpenAPIHandler } from '../fetch/index.mjs';
-import '@orpc/server';
-import '@orpc/server/fetch';
-import '@orpc/server/standard';
-import '@orpc/shared';
-import '@orpc/standard-server-fetch';
-import '../../shared/openapi.IfmmOyba.mjs';
-import '@orpc/openapi-client/standard';

package/dist/adapters/hono/index.d.ts

@@ -1,8 +0,0 @@
-export { OpenAPIHandler } from '../fetch/index.js';
-import '@orpc/server';
-import '@orpc/server/fetch';
-import '@orpc/server/standard';
-import '@orpc/shared';
-import '@orpc/standard-server-fetch';
-import '../../shared/openapi.IfmmOyba.js';
-import '@orpc/openapi-client/standard';

package/dist/adapters/hono/index.mjs

@@ -1,11 +0,0 @@
-export { O as OpenAPIHandler } from '../../shared/openapi.Dv-KT_Bx.mjs';
-import '@orpc/openapi-client/standard';
-import '@orpc/server/standard';
-import '@orpc/standard-server-fetch';
-import '../../shared/openapi.BNHmrMe2.mjs';
-import '@orpc/contract';
-import '@orpc/shared';
-import '@orpc/server';
-import 'rou3';
-import '../../shared/openapi.DZzpQAb-.mjs';
-import 'json-schema-typed/draft-2020-12';

package/dist/adapters/next/index.d.mts

@@ -1,8 +0,0 @@
-export { OpenAPIHandler } from '../fetch/index.mjs';
-import '@orpc/server';
-import '@orpc/server/fetch';
-import '@orpc/server/standard';
-import '@orpc/shared';
-import '@orpc/standard-server-fetch';
-import '../../shared/openapi.IfmmOyba.mjs';
-import '@orpc/openapi-client/standard';

package/dist/adapters/next/index.d.ts

@@ -1,8 +0,0 @@
-export { OpenAPIHandler } from '../fetch/index.js';
-import '@orpc/server';
-import '@orpc/server/fetch';
-import '@orpc/server/standard';
-import '@orpc/shared';
-import '@orpc/standard-server-fetch';
-import '../../shared/openapi.IfmmOyba.js';
-import '@orpc/openapi-client/standard';

package/dist/adapters/next/index.mjs

@@ -1,11 +0,0 @@
-export { O as OpenAPIHandler } from '../../shared/openapi.Dv-KT_Bx.mjs';
-import '@orpc/openapi-client/standard';
-import '@orpc/server/standard';
-import '@orpc/standard-server-fetch';
-import '../../shared/openapi.BNHmrMe2.mjs';
-import '@orpc/contract';
-import '@orpc/shared';
-import '@orpc/server';
-import 'rou3';
-import '../../shared/openapi.DZzpQAb-.mjs';
-import 'json-schema-typed/draft-2020-12';

package/dist/shared/openapi.DZzpQAb-.mjs

@@ -1,231 +0,0 @@
-import { isObject, findDeepMatches } from '@orpc/shared';
-import 'json-schema-typed/draft-2020-12';
-
-const LOGIC_KEYWORDS = [
-  "$dynamicRef",
-  "$ref",
-  "additionalItems",
-  "additionalProperties",
-  "allOf",
-  "anyOf",
-  "const",
-  "contains",
-  "contentEncoding",
-  "contentMediaType",
-  "contentSchema",
-  "dependencies",
-  "dependentRequired",
-  "dependentSchemas",
-  "else",
-  "enum",
-  "exclusiveMaximum",
-  "exclusiveMinimum",
-  "format",
-  "if",
-  "items",
-  "maxContains",
-  "maximum",
-  "maxItems",
-  "maxLength",
-  "maxProperties",
-  "minContains",
-  "minimum",
-  "minItems",
-  "minLength",
-  "minProperties",
-  "multipleOf",
-  "not",
-  "oneOf",
-  "pattern",
-  "patternProperties",
-  "prefixItems",
-  "properties",
-  "propertyNames",
-  "required",
-  "then",
-  "type",
-  "unevaluatedItems",
-  "unevaluatedProperties",
-  "uniqueItems"
-];
-
-function isFileSchema(schema) {
-  return isObject(schema) && schema.type === "string" && typeof schema.contentMediaType === "string";
-}
-function isObjectSchema(schema) {
-  return isObject(schema) && schema.type === "object";
-}
-function isAnySchema(schema) {
-  if (schema === true) {
-    return true;
-  }
-  if (Object.keys(schema).every((k) => !LOGIC_KEYWORDS.includes(k))) {
-    return true;
-  }
-  return false;
-}
-function separateObjectSchema(schema, separatedProperties) {
-  if (Object.keys(schema).some((k) => k !== "type" && k !== "properties" && k !== "required" && LOGIC_KEYWORDS.includes(k))) {
-    return [{ type: "object" }, schema];
-  }
-  const matched = { ...schema };
-  const rest = { ...schema };
-  matched.properties = schema.properties && Object.entries(schema.properties).filter(([key]) => separatedProperties.includes(key)).reduce((acc, [key, value]) => {
-    acc[key] = value;
-    return acc;
-  }, {});
-  matched.required = schema.required?.filter((key) => separatedProperties.includes(key));
-  matched.examples = schema.examples?.map((example) => {
-    if (!isObject(example)) {
-      return example;
-    }
-    return Object.entries(example).reduce((acc, [key, value]) => {
-      if (separatedProperties.includes(key)) {
-        acc[key] = value;
-      }
-      return acc;
-    }, {});
-  });
-  rest.properties = schema.properties && Object.entries(schema.properties).filter(([key]) => !separatedProperties.includes(key)).reduce((acc, [key, value]) => {
-    acc[key] = value;
-    return acc;
-  }, {});
-  rest.required = schema.required?.filter((key) => !separatedProperties.includes(key));
-  rest.examples = schema.examples?.map((example) => {
-    if (!isObject(example)) {
-      return example;
-    }
-    return Object.entries(example).reduce((acc, [key, value]) => {
-      if (!separatedProperties.includes(key)) {
-        acc[key] = value;
-      }
-      return acc;
-    }, {});
-  });
-  return [matched, rest];
-}
-function filterSchemaBranches(schema, check, matches = []) {
-  if (check(schema)) {
-    matches.push(schema);
-    return [matches, void 0];
-  }
-  if (isObject(schema)) {
-    for (const keyword of ["anyOf", "oneOf"]) {
-      if (schema[keyword] && Object.keys(schema).every(
-        (k) => k === keyword || !LOGIC_KEYWORDS.includes(k)
-      )) {
-        const rest = schema[keyword].map((s) => filterSchemaBranches(s, check, matches)[1]).filter((v) => !!v);
-        if (rest.length === 1 && typeof rest[0] === "object") {
-          return [matches, { ...schema, [keyword]: void 0, ...rest[0] }];
-        }
-        return [matches, { ...schema, [keyword]: rest }];
-      }
-    }
-  }
-  return [matches, schema];
-}
-
-function standardizeHTTPPath(path) {
-  return `/${path.replace(/\/{2,}/g, "/").replace(/^\/|\/$/g, "")}`;
-}
-function toOpenAPIPath(path) {
-  return standardizeHTTPPath(path).replace(/\/\{\+([^}]+)\}/g, "/{$1}");
-}
-function toOpenAPIMethod(method) {
-  return method.toLocaleLowerCase();
-}
-function getDynamicParams(path) {
-  return path ? standardizeHTTPPath(path).match(/\/\{([^}]+)\}/g)?.map((v) => v.match(/\{\+?([^}]+)\}/)[1]) : void 0;
-}
-function toOpenAPIContent(schema) {
-  const content = {};
-  const [matches, restSchema] = filterSchemaBranches(schema, isFileSchema);
-  for (const file of matches) {
-    content[file.contentMediaType] = {
-      schema: toOpenAPISchema(file)
-    };
-  }
-  if (restSchema !== void 0) {
-    content["application/json"] = {
-      schema: toOpenAPISchema(restSchema)
-    };
-    const isStillHasFileSchema = findDeepMatches((v) => isObject(v) && isFileSchema(v), restSchema).values.length > 0;
-    if (isStillHasFileSchema) {
-      content["multipart/form-data"] = {
-        schema: toOpenAPISchema(restSchema)
-      };
-    }
-  }
-  return content;
-}
-function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema], [returnsRequired, returnsSchema]) {
-  return {
-    "text/event-stream": {
-      schema: toOpenAPISchema({
-        oneOf: [
-          {
-            type: "object",
-            properties: {
-              event: { const: "message" },
-              data: yieldsSchema,
-              id: { type: "string" },
-              retry: { type: "number" }
-            },
-            required: yieldsRequired ? ["event", "data"] : ["event"]
-          },
-          {
-            type: "object",
-            properties: {
-              event: { const: "done" },
-              data: returnsSchema,
-              id: { type: "string" },
-              retry: { type: "number" }
-            },
-            required: returnsRequired ? ["event", "data"] : ["event"]
-          },
-          {
-            type: "object",
-            properties: {
-              event: { const: "error" },
-              data: {},
-              id: { type: "string" },
-              retry: { type: "number" }
-            },
-            required: ["event"]
-          }
-        ]
-      })
-    }
-  };
-}
-function toOpenAPIParameters(schema, parameterIn) {
-  const parameters = [];
-  for (const key in schema.properties) {
-    const keySchema = schema.properties[key];
-    parameters.push({
-      name: key,
-      in: parameterIn,
-      required: schema.required?.includes(key),
-      style: parameterIn === "query" ? "deepObject" : void 0,
-      explode: parameterIn === "query" ? true : void 0,
-      schema: toOpenAPISchema(keySchema)
-    });
-  }
-  return parameters;
-}
-function checkParamsSchema(schema, params) {
-  const properties = Object.keys(schema.properties ?? {});
-  const required = schema.required ?? [];
-  if (properties.length !== params.length || properties.some((v) => !params.includes(v))) {
-    return false;
-  }
-  if (required.length !== params.length || required.some((v) => !params.includes(v))) {
-    return false;
-  }
-  return true;
-}
-function toOpenAPISchema(schema) {
-  return schema === true ? {} : schema === false ? { not: {} } : schema;
-}
-
-export { LOGIC_KEYWORDS as L, toOpenAPIPath as a, toOpenAPIEventIteratorContent as b, isObjectSchema as c, separateObjectSchema as d, checkParamsSchema as e, toOpenAPIParameters as f, getDynamicParams as g, toOpenAPIContent as h, isAnySchema as i, toOpenAPISchema as j, isFileSchema as k, filterSchemaBranches as l, standardizeHTTPPath as s, toOpenAPIMethod as t };

package/dist/shared/openapi.Dv-KT_Bx.mjs

@@ -1,33 +0,0 @@
-import { StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer, StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
-import { StandardHandler } from '@orpc/server/standard';
-import { toStandardLazyRequest, toFetchResponse } from '@orpc/standard-server-fetch';
-import { a as StandardOpenAPIMatcher, S as StandardOpenAPICodec } from './openapi.BNHmrMe2.mjs';
-import '@orpc/shared';
-import 'json-schema-typed/draft-2020-12';
-
-class OpenAPIHandler {
-  standardHandler;
-  constructor(router, options = {}) {
-    const jsonSerializer = new StandardOpenAPIJsonSerializer(options);
-    const bracketNotationSerializer = new StandardBracketNotationSerializer();
-    const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
-    const matcher = new StandardOpenAPIMatcher();
-    const codec = new StandardOpenAPICodec(serializer);
-    this.standardHandler = new StandardHandler(router, matcher, codec, options);
-  }
-  async handle(request, ...[
-    options = {}
-  ]) {
-    const standardRequest = toStandardLazyRequest(request);
-    const result = await this.standardHandler.handle(standardRequest, options);
-    if (!result.matched) {
-      return result;
-    }
-    return {
-      matched: true,
-      response: toFetchResponse(result.response, options)
-    };
-  }
-}
-
-export { OpenAPIHandler as O };

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

@@ -1,8 +0,0 @@
-import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
-import { Context } from '@orpc/server';
-import { StandardHandlerOptions } from '@orpc/server/standard';
-
-interface StandardOpenAPIHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardOpenAPIJsonSerializerOptions {
-}
-
-export type { StandardOpenAPIHandlerOptions as S };

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

@@ -1,8 +0,0 @@
-import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
-import { Context } from '@orpc/server';
-import { StandardHandlerOptions } from '@orpc/server/standard';
-
-interface StandardOpenAPIHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardOpenAPIJsonSerializerOptions {
-}
-
-export type { StandardOpenAPIHandlerOptions as S };