@orpc/openapi 1.0.3 → 1.1.1

package/dist/shared/openapi.fMEQd3Yd.mjs

@@ -0,0 +1,544 @@
+import { fallbackORPCErrorStatus, fallbackORPCErrorMessage } from '@orpc/client';
+import { toHttpPath } from '@orpc/client/standard';
+import { fallbackContractConfig, getEventIteratorSchemaDetails } from '@orpc/contract';
+import { standardizeHTTPPath, StandardOpenAPIJsonSerializer, getDynamicParams } from '@orpc/openapi-client/standard';
+import { isProcedure, resolveContractProcedures } from '@orpc/server';
+import { isObject, findDeepMatches, toArray, clone } from '@orpc/shared';
+import 'json-schema-typed/draft-2020-12';
+
+const OPERATION_EXTENDER_SYMBOL = Symbol("ORPC_OPERATION_EXTENDER");
+function customOpenAPIOperation(o, extend) {
+  return new Proxy(o, {
+    get(target, prop, receiver) {
+      if (prop === OPERATION_EXTENDER_SYMBOL) {
+        return extend;
+      }
+      return Reflect.get(target, prop, receiver);
+    }
+  });
+}
+function getCustomOpenAPIOperation(o) {
+  return o[OPERATION_EXTENDER_SYMBOL];
+}
+function applyCustomOpenAPIOperation(operation, contract) {
+  const operationCustoms = [];
+  for (const errorItem of Object.values(contract["~orpc"].errorMap)) {
+    const maybeExtender = errorItem ? getCustomOpenAPIOperation(errorItem) : void 0;
+    if (maybeExtender) {
+      operationCustoms.push(maybeExtender);
+    }
+  }
+  if (isProcedure(contract)) {
+    for (const middleware of contract["~orpc"].middlewares) {
+      const maybeExtender = getCustomOpenAPIOperation(middleware);
+      if (maybeExtender) {
+        operationCustoms.push(maybeExtender);
+      }
+    }
+  }
+  let currentOperation = operation;
+  for (const custom of operationCustoms) {
+    if (typeof custom === "function") {
+      currentOperation = custom(currentOperation, contract);
+    } else {
+      currentOperation = {
+        ...currentOperation,
+        ...custom
+      };
+    }
+  }
+  return currentOperation;
+}
+
+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 applySchemaOptionality(required, schema) {
+  if (required) {
+    return schema;
+  }
+  return {
+    anyOf: [
+      schema,
+      { not: {} }
+    ]
+  };
+}
+
+function toOpenAPIPath(path) {
+  return standardizeHTTPPath(path).replace(/\/\{\+([^}]+)\}/g, "/{$1}");
+}
+function toOpenAPIMethod(method) {
+  return method.toLocaleLowerCase();
+}
+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;
+}
+
+class CompositeSchemaConverter {
+  converters;
+  constructor(converters) {
+    this.converters = converters;
+  }
+  async convert(schema, options) {
+    for (const converter of this.converters) {
+      if (await converter.condition(schema, options)) {
+        return converter.convert(schema, options);
+      }
+    }
+    return [false, {}];
+  }
+}
+
+class OpenAPIGeneratorError extends Error {
+}
+class OpenAPIGenerator {
+  serializer;
+  converter;
+  constructor(options = {}) {
+    this.serializer = new StandardOpenAPIJsonSerializer(options);
+    this.converter = new CompositeSchemaConverter(toArray(options.schemaConverters));
+  }
+  /**
+   * Generates OpenAPI specifications from oRPC routers/contracts.
+   *
+   * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
+   */
+  async generate(router, options = {}) {
+    const doc = {
+      ...clone(options),
+      info: options.info ?? { title: "API Reference", version: "0.0.0" },
+      openapi: "3.1.1"
+    };
+    const contracts = [];
+    await resolveContractProcedures({ path: [], router }, ({ contract, path }) => {
+      contracts.push({ contract, path });
+    });
+    const errors = [];
+    for (const { contract, path } of contracts) {
+      const operationId = path.join(".");
+      try {
+        const def = contract["~orpc"];
+        const method = toOpenAPIMethod(fallbackContractConfig("defaultMethod", def.route.method));
+        const httpPath = toOpenAPIPath(def.route.path ?? toHttpPath(path));
+        const operationObjectRef = {
+          operationId,
+          summary: def.route.summary,
+          description: def.route.description,
+          deprecated: def.route.deprecated,
+          tags: def.route.tags?.map((tag) => tag)
+        };
+        await this.#request(operationObjectRef, def);
+        await this.#successResponse(operationObjectRef, def);
+        await this.#errorResponse(operationObjectRef, def);
+        doc.paths ??= {};
+        doc.paths[httpPath] ??= {};
+        doc.paths[httpPath][method] = applyCustomOpenAPIOperation(operationObjectRef, contract);
+      } catch (e) {
+        if (!(e instanceof OpenAPIGeneratorError)) {
+          throw e;
+        }
+        errors.push(
+          `[OpenAPIGenerator] Error occurred while generating OpenAPI for procedure at path: ${operationId}
+${e.message}`
+        );
+      }
+    }
+    if (errors.length) {
+      throw new OpenAPIGeneratorError(
+        `Some error occurred during OpenAPI generation:
+
+${errors.join("\n\n")}`
+      );
+    }
+    return this.serializer.serialize(doc)[0];
+  }
+  async #request(ref, def) {
+    const method = fallbackContractConfig("defaultMethod", def.route.method);
+    const details = getEventIteratorSchemaDetails(def.inputSchema);
+    if (details) {
+      ref.requestBody = {
+        required: true,
+        content: toOpenAPIEventIteratorContent(
+          await this.converter.convert(details.yields, { strategy: "input" }),
+          await this.converter.convert(details.returns, { strategy: "input" })
+        )
+      };
+      return;
+    }
+    const dynamicParams = getDynamicParams(def.route.path)?.map((v) => v.name);
+    const inputStructure = fallbackContractConfig("defaultInputStructure", def.route.inputStructure);
+    let [required, schema] = await this.converter.convert(def.inputSchema, { strategy: "input" });
+    if (isAnySchema(schema) && !dynamicParams?.length) {
+      return;
+    }
+    if (inputStructure === "compact") {
+      if (dynamicParams?.length) {
+        const error2 = new OpenAPIGeneratorError(
+          'When input structure is "compact", and path has dynamic params, input schema must be an object with all dynamic params as required.'
+        );
+        if (!isObjectSchema(schema)) {
+          throw error2;
+        }
+        const [paramsSchema, rest] = separateObjectSchema(schema, dynamicParams);
+        schema = rest;
+        required = rest.required ? rest.required.length !== 0 : false;
+        if (!checkParamsSchema(paramsSchema, dynamicParams)) {
+          throw error2;
+        }
+        ref.parameters ??= [];
+        ref.parameters.push(...toOpenAPIParameters(paramsSchema, "path"));
+      }
+      if (method === "GET") {
+        if (!isObjectSchema(schema)) {
+          throw new OpenAPIGeneratorError(
+            'When method is "GET", input schema must satisfy: object | any | unknown'
+          );
+        }
+        ref.parameters ??= [];
+        ref.parameters.push(...toOpenAPIParameters(schema, "query"));
+      } else {
+        ref.requestBody = {
+          required,
+          content: toOpenAPIContent(schema)
+        };
+      }
+      return;
+    }
+    const error = new OpenAPIGeneratorError(
+      'When input structure is "detailed", input schema must satisfy: { params?: Record<string, unknown>, query?: Record<string, unknown>, headers?: Record<string, unknown>, body?: unknown }'
+    );
+    if (!isObjectSchema(schema)) {
+      throw error;
+    }
+    if (dynamicParams?.length && (schema.properties?.params === void 0 || !isObjectSchema(schema.properties.params) || !checkParamsSchema(schema.properties.params, dynamicParams))) {
+      throw new OpenAPIGeneratorError(
+        'When input structure is "detailed" and path has dynamic params, the "params" schema must be an object with all dynamic params as required.'
+      );
+    }
+    for (const from of ["params", "query", "headers"]) {
+      const fromSchema = schema.properties?.[from];
+      if (fromSchema !== void 0) {
+        if (!isObjectSchema(fromSchema)) {
+          throw error;
+        }
+        const parameterIn = from === "params" ? "path" : from === "headers" ? "header" : "query";
+        ref.parameters ??= [];
+        ref.parameters.push(...toOpenAPIParameters(fromSchema, parameterIn));
+      }
+    }
+    if (schema.properties?.body !== void 0) {
+      ref.requestBody = {
+        required: schema.required?.includes("body"),
+        content: toOpenAPIContent(schema.properties.body)
+      };
+    }
+  }
+  async #successResponse(ref, def) {
+    const outputSchema = def.outputSchema;
+    const status = fallbackContractConfig("defaultSuccessStatus", def.route.successStatus);
+    const description = fallbackContractConfig("defaultSuccessDescription", def.route?.successDescription);
+    const eventIteratorSchemaDetails = getEventIteratorSchemaDetails(outputSchema);
+    const outputStructure = fallbackContractConfig("defaultOutputStructure", def.route.outputStructure);
+    if (eventIteratorSchemaDetails) {
+      ref.responses ??= {};
+      ref.responses[status] = {
+        description,
+        content: toOpenAPIEventIteratorContent(
+          await this.converter.convert(eventIteratorSchemaDetails.yields, { strategy: "output" }),
+          await this.converter.convert(eventIteratorSchemaDetails.returns, { strategy: "output" })
+        )
+      };
+      return;
+    }
+    const [required, json] = await this.converter.convert(outputSchema, { strategy: "output" });
+    ref.responses ??= {};
+    ref.responses[status] = {
+      description
+    };
+    if (outputStructure === "compact") {
+      ref.responses[status].content = toOpenAPIContent(applySchemaOptionality(required, json));
+      return;
+    }
+    const error = new OpenAPIGeneratorError(
+      'When output structure is "detailed", output schema must satisfy: { headers?: Record<string, unknown>, body?: unknown }'
+    );
+    if (!isObjectSchema(json)) {
+      throw error;
+    }
+    if (json.properties?.headers !== void 0) {
+      if (!isObjectSchema(json.properties.headers)) {
+        throw error;
+      }
+      for (const key in json.properties.headers.properties) {
+        ref.responses[status].headers ??= {};
+        ref.responses[status].headers[key] = {
+          schema: toOpenAPISchema(json.properties.headers.properties[key]),
+          required: json.properties.headers.required?.includes(key)
+        };
+      }
+    }
+    if (json.properties?.body !== void 0) {
+      ref.responses[status].content = toOpenAPIContent(
+        applySchemaOptionality(json.required?.includes("body") ?? false, json.properties.body)
+      );
+    }
+  }
+  async #errorResponse(ref, def) {
+    const errorMap = def.errorMap;
+    const errors = {};
+    for (const code in errorMap) {
+      const config = errorMap[code];
+      if (!config) {
+        continue;
+      }
+      const status = fallbackORPCErrorStatus(code, config.status);
+      const message = fallbackORPCErrorMessage(code, config.message);
+      const [dataRequired, dataSchema] = await this.converter.convert(config.data, { strategy: "output" });
+      errors[status] ??= [];
+      errors[status].push({
+        type: "object",
+        properties: {
+          defined: { const: true },
+          code: { const: code },
+          status: { const: status },
+          message: { type: "string", default: message },
+          data: dataSchema
+        },
+        required: dataRequired ? ["defined", "code", "status", "message", "data"] : ["defined", "code", "status", "message"]
+      });
+    }
+    ref.responses ??= {};
+    for (const status in errors) {
+      const schemas = errors[status];
+      ref.responses[status] = {
+        description: status,
+        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"]
+            }
+          ]
+        })
+      };
+    }
+  }
+}
+
+export { CompositeSchemaConverter as C, LOGIC_KEYWORDS as L, OpenAPIGenerator as O, applyCustomOpenAPIOperation as a, toOpenAPIMethod as b, customOpenAPIOperation as c, toOpenAPIContent as d, toOpenAPIEventIteratorContent as e, toOpenAPIParameters as f, getCustomOpenAPIOperation as g, checkParamsSchema as h, toOpenAPISchema as i, isFileSchema as j, isObjectSchema as k, isAnySchema as l, filterSchemaBranches as m, applySchemaOptionality as n, separateObjectSchema as s, toOpenAPIPath as t };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/openapi",
   "type": "module",
-  "version": "1.0.3",
+  "version": "1.1.1",
   "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",
@@ -41,13 +46,13 @@
   "dependencies": {
     "json-schema-typed": "^8.0.1",
     "openapi-types": "^12.1.3",
-    "rou3": "^0.5.1",
-    "@orpc/client": "1.0.3",
-    "@orpc/openapi-client": "1.0.3",
-    "@orpc/server": "1.0.3",
-    "@orpc/shared": "1.0.3",
-    "@orpc/contract": "1.0.3",
-    "@orpc/standard-server": "1.0.3"
+    "rou3": "^0.6.0",
+    "@orpc/client": "1.1.1",
+    "@orpc/openapi-client": "1.1.1",
+    "@orpc/server": "1.1.1",
+    "@orpc/contract": "1.1.1",
+    "@orpc/standard-server": "1.1.1",
+    "@orpc/shared": "1.1.1"
   },
   "devDependencies": {
     "zod": "^3.24.2"