@orpc/openapi 0.0.0-next.f22c7ec → 0.0.0-next.f356b86

package/dist/index.js

@@ -1,550 +0,0 @@
-import {
-  JSONSerializer,
-  forEachAllContractProcedure,
-  forEachContractProcedure,
-  standardizeHTTPPath
-} from "./chunk-V4HFPIEN.js";
-
-// src/openapi.ts
-import { OpenApiBuilder } from "openapi3-ts/oas31";
-
-// src/openapi-content-builder.ts
-import { findDeepMatches } from "@orpc/shared";
-var OpenAPIContentBuilder = class {
-  constructor(schemaUtils) {
-    this.schemaUtils = schemaUtils;
-  }
-  build(jsonSchema, options) {
-    const isFileSchema = this.schemaUtils.isFileSchema.bind(this.schemaUtils);
-    const [matches, schema] = this.schemaUtils.filterSchemaBranches(jsonSchema, isFileSchema);
-    const files = matches;
-    const content = {};
-    for (const file of files) {
-      content[file.contentMediaType] = {
-        schema: file
-      };
-    }
-    const isStillHasFileSchema = findDeepMatches(isFileSchema, schema).values.length > 0;
-    if (schema !== void 0) {
-      content[isStillHasFileSchema ? "multipart/form-data" : "application/json"] = {
-        schema,
-        ...options
-      };
-    }
-    return content;
-  }
-};
-
-// src/openapi-generator.ts
-import { fallbackORPCErrorStatus, fallbackToGlobalConfig as fallbackToGlobalConfig2 } from "@orpc/contract";
-import { group } from "@orpc/shared";
-
-// src/openapi-error.ts
-var OpenAPIError = class extends Error {
-};
-
-// src/openapi-input-structure-parser.ts
-import { fallbackToGlobalConfig } from "@orpc/contract";
-var OpenAPIInputStructureParser = class {
-  constructor(schemaConverter, schemaUtils, pathParser) {
-    this.schemaConverter = schemaConverter;
-    this.schemaUtils = schemaUtils;
-    this.pathParser = pathParser;
-  }
-  parse(contract, structure) {
-    const inputSchema = this.schemaConverter.convert(contract["~orpc"].InputSchema, { strategy: "input" });
-    const method = fallbackToGlobalConfig("defaultMethod", contract["~orpc"].route?.method);
-    const httpPath = contract["~orpc"].route?.path;
-    if (this.schemaUtils.isAnySchema(inputSchema)) {
-      return {
-        paramsSchema: void 0,
-        querySchema: void 0,
-        headersSchema: void 0,
-        bodySchema: void 0
-      };
-    }
-    if (structure === "detailed") {
-      return this.parseDetailedSchema(inputSchema);
-    } else {
-      return this.parseCompactSchema(inputSchema, method, httpPath);
-    }
-  }
-  parseDetailedSchema(inputSchema) {
-    if (!this.schemaUtils.isObjectSchema(inputSchema)) {
-      throw new OpenAPIError(`When input structure is 'detailed', input schema must be an object.`);
-    }
-    if (inputSchema.properties && Object.keys(inputSchema.properties).some((key) => !["params", "query", "headers", "body"].includes(key))) {
-      throw new OpenAPIError(`When input structure is 'detailed', input schema must be only can contain 'params', 'query', 'headers' and 'body' properties.`);
-    }
-    let paramsSchema = inputSchema.properties?.params;
-    let querySchema = inputSchema.properties?.query;
-    let headersSchema = inputSchema.properties?.headers;
-    const bodySchema = inputSchema.properties?.body;
-    if (paramsSchema !== void 0 && this.schemaUtils.isAnySchema(paramsSchema)) {
-      paramsSchema = void 0;
-    }
-    if (paramsSchema !== void 0 && !this.schemaUtils.isObjectSchema(paramsSchema)) {
-      throw new OpenAPIError(`When input structure is 'detailed', params schema in input schema must be an object.`);
-    }
-    if (querySchema !== void 0 && this.schemaUtils.isAnySchema(querySchema)) {
-      querySchema = void 0;
-    }
-    if (querySchema !== void 0 && !this.schemaUtils.isObjectSchema(querySchema)) {
-      throw new OpenAPIError(`When input structure is 'detailed', query schema in input schema must be an object.`);
-    }
-    if (headersSchema !== void 0 && this.schemaUtils.isAnySchema(headersSchema)) {
-      headersSchema = void 0;
-    }
-    if (headersSchema !== void 0 && !this.schemaUtils.isObjectSchema(headersSchema)) {
-      throw new OpenAPIError(`When input structure is 'detailed', headers schema in input schema must be an object.`);
-    }
-    return { paramsSchema, querySchema, headersSchema, bodySchema };
-  }
-  parseCompactSchema(inputSchema, method, httpPath) {
-    const dynamic = httpPath ? this.pathParser.parseDynamicParams(httpPath) : [];
-    if (dynamic.length === 0) {
-      if (method === "GET") {
-        let querySchema = inputSchema;
-        if (querySchema !== void 0 && this.schemaUtils.isAnySchema(querySchema)) {
-          querySchema = void 0;
-        }
-        if (querySchema !== void 0 && !this.schemaUtils.isObjectSchema(querySchema)) {
-          throw new OpenAPIError(`When input structure is 'compact' and method is 'GET', input schema must be an object.`);
-        }
-        return {
-          paramsSchema: void 0,
-          querySchema,
-          headersSchema: void 0,
-          bodySchema: void 0
-        };
-      }
-      return {
-        paramsSchema: void 0,
-        querySchema: void 0,
-        headersSchema: void 0,
-        bodySchema: inputSchema
-      };
-    }
-    if (!this.schemaUtils.isObjectSchema(inputSchema)) {
-      throw new OpenAPIError(`When input structure is 'compact' and path has dynamic parameters, input schema must be an object.`);
-    }
-    const [params, rest] = this.schemaUtils.separateObjectSchema(inputSchema, dynamic.map((v) => v.name));
-    return {
-      paramsSchema: params,
-      querySchema: method === "GET" ? rest : void 0,
-      headersSchema: void 0,
-      bodySchema: method !== "GET" ? rest : void 0
-    };
-  }
-};
-
-// src/openapi-output-structure-parser.ts
-var OpenAPIOutputStructureParser = class {
-  constructor(schemaConverter, schemaUtils) {
-    this.schemaConverter = schemaConverter;
-    this.schemaUtils = schemaUtils;
-  }
-  parse(contract, structure) {
-    const outputSchema = this.schemaConverter.convert(contract["~orpc"].OutputSchema, { strategy: "output" });
-    if (this.schemaUtils.isAnySchema(outputSchema)) {
-      return {
-        headersSchema: void 0,
-        bodySchema: void 0
-      };
-    }
-    if (structure === "detailed") {
-      return this.parseDetailedSchema(outputSchema);
-    } else {
-      return this.parseCompactSchema(outputSchema);
-    }
-  }
-  parseDetailedSchema(outputSchema) {
-    if (!this.schemaUtils.isObjectSchema(outputSchema)) {
-      throw new OpenAPIError(`When output structure is 'detailed', output schema must be an object.`);
-    }
-    if (outputSchema.properties && Object.keys(outputSchema.properties).some((key) => !["headers", "body"].includes(key))) {
-      throw new OpenAPIError(`When output structure is 'detailed', output schema must be only can contain 'headers' and 'body' properties.`);
-    }
-    let headersSchema = outputSchema.properties?.headers;
-    const bodySchema = outputSchema.properties?.body;
-    if (headersSchema !== void 0 && this.schemaUtils.isAnySchema(headersSchema)) {
-      headersSchema = void 0;
-    }
-    if (headersSchema !== void 0 && !this.schemaUtils.isObjectSchema(headersSchema)) {
-      throw new OpenAPIError(`When output structure is 'detailed', headers schema in output schema must be an object.`);
-    }
-    return { headersSchema, bodySchema };
-  }
-  parseCompactSchema(outputSchema) {
-    return {
-      headersSchema: void 0,
-      bodySchema: outputSchema
-    };
-  }
-};
-
-// src/openapi-parameters-builder.ts
-import { get, isPlainObject, omit } from "@orpc/shared";
-var OpenAPIParametersBuilder = class {
-  build(paramIn, jsonSchema, options) {
-    const parameters = [];
-    for (const name in jsonSchema.properties) {
-      const schema = jsonSchema.properties[name];
-      const paramExamples = jsonSchema.examples?.filter((example) => {
-        return isPlainObject(example) && name in example;
-      }).map((example) => {
-        return example[name];
-      });
-      const paramSchema = {
-        examples: paramExamples?.length ? paramExamples : void 0,
-        ...schema === true ? {} : schema === false ? { not: {} } : schema
-      };
-      const paramExample = get(options?.example, [name]);
-      parameters.push({
-        name,
-        in: paramIn,
-        required: typeof options?.required === "boolean" ? options.required : jsonSchema.required?.includes(name) ?? false,
-        schema: paramSchema,
-        example: paramExample,
-        style: options?.style
-      });
-    }
-    return parameters;
-  }
-  buildHeadersObject(jsonSchema, options) {
-    const parameters = this.build("header", jsonSchema, options);
-    const headersObject = {};
-    for (const param of parameters) {
-      headersObject[param.name] = omit(param, ["name", "in"]);
-    }
-    return headersObject;
-  }
-};
-
-// src/openapi-path-parser.ts
-var OpenAPIPathParser = class {
-  parseDynamicParams(path) {
-    const raws = path.match(/\{([^}]+)\}/g) ?? [];
-    return raws.map((raw) => {
-      const name = raw.slice(1, -1).split(":")[0];
-      return { name, raw };
-    });
-  }
-};
-
-// src/schema-converter.ts
-var CompositeSchemaConverter = class {
-  converters;
-  constructor(converters) {
-    this.converters = converters;
-  }
-  condition() {
-    return true;
-  }
-  convert(schema, options) {
-    for (const converter of this.converters) {
-      if (converter.condition(schema, options)) {
-        return converter.convert(schema, options);
-      }
-    }
-    return {};
-  }
-};
-
-// src/schema-utils.ts
-import { isPlainObject as isPlainObject2 } from "@orpc/shared";
-
-// src/schema.ts
-import * as JSONSchema from "json-schema-typed/draft-2020-12";
-import { Format } from "json-schema-typed/draft-2020-12";
-var NON_LOGIC_KEYWORDS = [
-  // Core Documentation Keywords
-  "$anchor",
-  "$comment",
-  "$defs",
-  "$id",
-  "title",
-  "description",
-  // Value Keywords
-  "default",
-  "deprecated",
-  "examples",
-  // Metadata Keywords
-  "$schema",
-  "definitions",
-  // Legacy, but still used
-  "readOnly",
-  "writeOnly",
-  // Display and UI Hints
-  "contentMediaType",
-  "contentEncoding",
-  "format",
-  // Custom Extensions
-  "$vocabulary",
-  "$dynamicAnchor",
-  "$dynamicRef"
-];
-
-// src/schema-utils.ts
-var SchemaUtils = class {
-  isFileSchema(schema) {
-    return typeof schema === "object" && schema.type === "string" && typeof schema.contentMediaType === "string";
-  }
-  isObjectSchema(schema) {
-    return typeof schema === "object" && schema.type === "object";
-  }
-  isAnySchema(schema) {
-    return schema === true || Object.keys(schema).filter((key) => !NON_LOGIC_KEYWORDS.includes(key)).length === 0;
-  }
-  isUndefinableSchema(schema) {
-    const [matches] = this.filterSchemaBranches(schema, (schema2) => {
-      if (typeof schema2 === "boolean") {
-        return schema2;
-      }
-      return Object.keys(schema2).filter((key) => !NON_LOGIC_KEYWORDS.includes(key)).length === 0;
-    });
-    return matches.length > 0;
-  }
-  separateObjectSchema(schema, separatedProperties) {
-    const matched = { ...schema };
-    const rest = { ...schema };
-    matched.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 (!isPlainObject2(example)) {
-        return example;
-      }
-      return Object.entries(example).reduce((acc, [key, value]) => {
-        if (separatedProperties.includes(key)) {
-          acc[key] = value;
-        }
-        return acc;
-      }, {});
-    });
-    rest.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 (!isPlainObject2(example)) {
-        return example;
-      }
-      return Object.entries(example).reduce((acc, [key, value]) => {
-        if (!separatedProperties.includes(key)) {
-          acc[key] = value;
-        }
-        return acc;
-      }, {});
-    });
-    return [matched, rest];
-  }
-  filterSchemaBranches(schema, check, matches = []) {
-    if (check(schema)) {
-      matches.push(schema);
-      return [matches, void 0];
-    }
-    if (typeof schema === "boolean") {
-      return [matches, schema];
-    }
-    if (schema.anyOf && Object.keys(schema).every(
-      (k) => k === "anyOf" || NON_LOGIC_KEYWORDS.includes(k)
-    )) {
-      const anyOf = schema.anyOf.map((s) => this.filterSchemaBranches(s, check, matches)[1]).filter((v) => !!v);
-      if (anyOf.length === 1 && typeof anyOf[0] === "object") {
-        return [matches, { ...schema, anyOf: void 0, ...anyOf[0] }];
-      }
-      return [matches, { ...schema, anyOf }];
-    }
-    if (schema.oneOf && Object.keys(schema).every(
-      (k) => k === "oneOf" || NON_LOGIC_KEYWORDS.includes(k)
-    )) {
-      const oneOf = schema.oneOf.map((s) => this.filterSchemaBranches(s, check, matches)[1]).filter((v) => !!v);
-      if (oneOf.length === 1 && typeof oneOf[0] === "object") {
-        return [matches, { ...schema, oneOf: void 0, ...oneOf[0] }];
-      }
-      return [matches, { ...schema, oneOf }];
-    }
-    return [matches, schema];
-  }
-};
-
-// src/openapi-generator.ts
-var OpenAPIGenerator = class {
-  contentBuilder;
-  parametersBuilder;
-  schemaConverter;
-  schemaUtils;
-  jsonSerializer;
-  pathParser;
-  inputStructureParser;
-  outputStructureParser;
-  errorHandlerStrategy;
-  ignoreUndefinedPathProcedures;
-  considerMissingTagDefinitionAsError;
-  strictErrorResponses;
-  constructor(options) {
-    this.parametersBuilder = options?.parametersBuilder ?? new OpenAPIParametersBuilder();
-    this.schemaConverter = new CompositeSchemaConverter(options?.schemaConverters ?? []);
-    this.schemaUtils = options?.schemaUtils ?? new SchemaUtils();
-    this.jsonSerializer = options?.jsonSerializer ?? new JSONSerializer();
-    this.contentBuilder = options?.contentBuilder ?? new OpenAPIContentBuilder(this.schemaUtils);
-    this.pathParser = new OpenAPIPathParser();
-    this.inputStructureParser = options?.inputStructureParser ?? new OpenAPIInputStructureParser(this.schemaConverter, this.schemaUtils, this.pathParser);
-    this.outputStructureParser = options?.outputStructureParser ?? new OpenAPIOutputStructureParser(this.schemaConverter, this.schemaUtils);
-    this.errorHandlerStrategy = options?.errorHandlerStrategy ?? "throw";
-    this.ignoreUndefinedPathProcedures = options?.ignoreUndefinedPathProcedures ?? false;
-    this.considerMissingTagDefinitionAsError = options?.considerMissingTagDefinitionAsError ?? false;
-    this.strictErrorResponses = options?.strictErrorResponses ?? true;
-  }
-  async generate(router, doc) {
-    const builder = new OpenApiBuilder({
-      ...doc,
-      openapi: "3.1.1"
-    });
-    const rootTags = doc.tags?.map((tag) => tag.name) ?? [];
-    await forEachAllContractProcedure(router, ({ contract, path }) => {
-      try {
-        const def = contract["~orpc"];
-        if (this.ignoreUndefinedPathProcedures && def.route?.path === void 0) {
-          return;
-        }
-        const method = fallbackToGlobalConfig2("defaultMethod", def.route?.method);
-        const httpPath = def.route?.path ? standardizeHTTPPath(def.route?.path) : `/${path.map(encodeURIComponent).join("/")}`;
-        const inputStructure = fallbackToGlobalConfig2("defaultInputStructure", def.route?.inputStructure);
-        const outputStructure = fallbackToGlobalConfig2("defaultOutputStructure", def.route?.outputStructure);
-        const { paramsSchema, querySchema, headersSchema, bodySchema } = this.inputStructureParser.parse(contract, inputStructure);
-        const { headersSchema: resHeadersSchema, bodySchema: resBodySchema } = this.outputStructureParser.parse(contract, outputStructure);
-        const params = paramsSchema ? this.parametersBuilder.build("path", paramsSchema, {
-          required: true
-        }) : [];
-        const query = querySchema ? this.parametersBuilder.build("query", querySchema) : [];
-        const headers = headersSchema ? this.parametersBuilder.build("header", headersSchema) : [];
-        const parameters = [...params, ...query, ...headers];
-        const requestBody = bodySchema !== void 0 ? {
-          required: this.schemaUtils.isUndefinableSchema(bodySchema),
-          content: this.contentBuilder.build(bodySchema)
-        } : void 0;
-        const responses = {};
-        responses[fallbackToGlobalConfig2("defaultSuccessStatus", def.route?.successStatus)] = {
-          description: fallbackToGlobalConfig2("defaultSuccessDescription", def.route?.successDescription),
-          content: resBodySchema !== void 0 ? this.contentBuilder.build(resBodySchema, {
-            example: def.outputExample
-          }) : void 0,
-          headers: resHeadersSchema !== void 0 ? this.parametersBuilder.buildHeadersObject(resHeadersSchema, {
-            example: def.outputExample
-          }) : void 0
-        };
-        const errors = group(Object.entries(def.errorMap ?? {}).filter(([_, config]) => config).map(([code, config]) => ({
-          ...config,
-          code,
-          status: fallbackORPCErrorStatus(code, config?.status)
-        })), (error) => error.status);
-        for (const status in errors) {
-          const configs = errors[status];
-          if (!configs || configs.length === 0) {
-            continue;
-          }
-          const schemas = configs.map(({ data, code, message }) => {
-            const json = {
-              type: "object",
-              properties: {
-                defined: { const: true },
-                code: { const: code },
-                status: { const: Number(status) },
-                message: { type: "string", default: message },
-                data: {}
-              },
-              required: ["defined", "code", "status", "message"]
-            };
-            if (data) {
-              const dataJson = this.schemaConverter.convert(data, { strategy: "output" });
-              json.properties.data = dataJson;
-              if (!this.schemaUtils.isUndefinableSchema(dataJson)) {
-                json.required.push("data");
-              }
-            }
-            return json;
-          });
-          if (this.strictErrorResponses) {
-            schemas.push({
-              type: "object",
-              properties: {
-                defined: { const: false },
-                code: { type: "string" },
-                status: { type: "number" },
-                message: { type: "string" },
-                data: {}
-              },
-              required: ["defined", "code", "status", "message"]
-            });
-          }
-          const contentSchema = schemas.length === 1 ? schemas[0] : {
-            oneOf: schemas
-          };
-          responses[status] = {
-            description: status,
-            content: this.contentBuilder.build(contentSchema)
-          };
-        }
-        if (this.considerMissingTagDefinitionAsError && def.route?.tags) {
-          const missingTag = def.route?.tags.find((tag) => !rootTags.includes(tag));
-          if (missingTag !== void 0) {
-            throw new OpenAPIError(
-              `Tag "${missingTag}" is missing definition. Please define it in OpenAPI root tags object`
-            );
-          }
-        }
-        const operation = {
-          summary: def.route?.summary,
-          description: def.route?.description,
-          deprecated: def.route?.deprecated,
-          tags: def.route?.tags ? [...def.route.tags] : void 0,
-          operationId: path.join("."),
-          parameters: parameters.length ? parameters : void 0,
-          requestBody,
-          responses
-        };
-        builder.addPath(httpPath, {
-          [method.toLocaleLowerCase()]: operation
-        });
-      } catch (e) {
-        if (e instanceof OpenAPIError) {
-          const error = new OpenAPIError(`
-            Generate OpenAPI Error: ${e.message}
-            Happened at path: ${path.join(".")}
-          `, { cause: e });
-          if (this.errorHandlerStrategy === "throw") {
-            throw error;
-          }
-          if (this.errorHandlerStrategy === "log") {
-            console.error(error);
-          }
-        } else {
-          throw e;
-        }
-      }
-    });
-    return this.jsonSerializer.serialize(builder.getSpec());
-  }
-};
-export {
-  CompositeSchemaConverter,
-  JSONSchema,
-  Format as JSONSchemaFormat,
-  JSONSerializer,
-  NON_LOGIC_KEYWORDS,
-  OpenAPIContentBuilder,
-  OpenAPIGenerator,
-  OpenAPIParametersBuilder,
-  OpenAPIPathParser,
-  OpenApiBuilder,
-  SchemaUtils,
-  forEachAllContractProcedure,
-  forEachContractProcedure,
-  standardizeHTTPPath
-};
-//# sourceMappingURL=index.js.map

package/dist/next.js

@@ -1,34 +0,0 @@
-import {
-  OpenAPIServerHandler,
-  OpenAPIServerlessHandler
-} from "./chunk-N7JLIFHD.js";
-import {
-  CompositeSchemaCoercer,
-  InputStructureCompact,
-  InputStructureDetailed,
-  OpenAPIHandler,
-  OpenAPIPayloadCodec,
-  OpenAPIProcedureMatcher,
-  deserialize,
-  escapeSegment,
-  parsePath,
-  serialize,
-  stringifyPath
-} from "./chunk-TW72MGM2.js";
-import "./chunk-V4HFPIEN.js";
-export {
-  CompositeSchemaCoercer,
-  InputStructureCompact,
-  InputStructureDetailed,
-  OpenAPIHandler,
-  OpenAPIPayloadCodec,
-  OpenAPIProcedureMatcher,
-  OpenAPIServerHandler,
-  OpenAPIServerlessHandler,
-  deserialize,
-  escapeSegment,
-  parsePath,
-  serialize,
-  stringifyPath
-};
-//# sourceMappingURL=next.js.map

package/dist/node.js

@@ -1,46 +0,0 @@
-import {
-  OpenAPIHandler
-} from "./chunk-TW72MGM2.js";
-import "./chunk-V4HFPIEN.js";
-
-// src/adapters/node/openapi-handler.ts
-import { createRequest, sendResponse } from "@orpc/server/node";
-var OpenAPIHandler2 = class {
-  openapiFetchHandler;
-  constructor(hono, router, options) {
-    this.openapiFetchHandler = new OpenAPIHandler(hono, router, options);
-  }
-  async handle(req, res, ...[options]) {
-    const request = createRequest(req, res);
-    const castedOptions = options ?? {};
-    const result = await this.openapiFetchHandler.handle(request, castedOptions);
-    if (result.matched === false) {
-      return { matched: false };
-    }
-    await options?.beforeSend?.(result.response, castedOptions.context);
-    await sendResponse(res, result.response);
-    return { matched: true };
-  }
-};
-
-// src/adapters/node/openapi-handler-server.ts
-import { TrieRouter } from "hono/router/trie-router";
-var OpenAPIServerHandler = class extends OpenAPIHandler2 {
-  constructor(router, options) {
-    super(new TrieRouter(), router, options);
-  }
-};
-
-// src/adapters/node/openapi-handler-serverless.ts
-import { LinearRouter } from "hono/router/linear-router";
-var OpenAPIServerlessHandler = class extends OpenAPIHandler2 {
-  constructor(router, options) {
-    super(new LinearRouter(), router, options);
-  }
-};
-export {
-  OpenAPIHandler2 as OpenAPIHandler,
-  OpenAPIServerHandler,
-  OpenAPIServerlessHandler
-};
-//# sourceMappingURL=node.js.map