@orpc/openapi 0.0.0-next.cc4cb21 → 0.0.0-next.cc8802c

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 />
+  <image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
 </div>
 
 <h1></h1>

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

@@ -0,0 +1,13 @@
+import { Context, Router } from '@orpc/server';
+import { FetchHandler, FetchHandleResult } from '@orpc/server/fetch';
+import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
+import { MaybeOptionalOptions } from '@orpc/shared';
+import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
+
+declare class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
+    private readonly standardHandler;
+    constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
+    handle(request: Request, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
+}
+
+export { OpenAPIHandler };

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

@@ -0,0 +1,13 @@
+import { Context, Router } from '@orpc/server';
+import { FetchHandler, FetchHandleResult } from '@orpc/server/fetch';
+import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
+import { MaybeOptionalOptions } from '@orpc/shared';
+import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
+
+declare class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
+    private readonly standardHandler;
+    constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
+    handle(request: Request, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
+}
+
+export { OpenAPIHandler };

package/dist/adapters/fetch/index.mjs

@@ -0,0 +1,11 @@
+export { O as OpenAPIHandler } from '../../shared/openapi.CbzTVvGL.mjs';
+import '@orpc/openapi-client/standard';
+import '@orpc/server/standard';
+import '@orpc/standard-server-fetch';
+import '../../shared/openapi.CJTe38Ya.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/hono/index.d.mts

@@ -0,0 +1,6 @@
+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';

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

@@ -0,0 +1,6 @@
+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';

package/dist/adapters/hono/index.mjs

@@ -0,0 +1,11 @@
+export { O as OpenAPIHandler } from '../../shared/openapi.CbzTVvGL.mjs';
+import '@orpc/openapi-client/standard';
+import '@orpc/server/standard';
+import '@orpc/standard-server-fetch';
+import '../../shared/openapi.CJTe38Ya.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

@@ -0,0 +1,6 @@
+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';

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

@@ -0,0 +1,6 @@
+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';

package/dist/adapters/next/index.mjs

@@ -0,0 +1,11 @@
+export { O as OpenAPIHandler } from '../../shared/openapi.CbzTVvGL.mjs';
+import '@orpc/openapi-client/standard';
+import '@orpc/server/standard';
+import '@orpc/standard-server-fetch';
+import '../../shared/openapi.CJTe38Ya.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/node/index.d.mts

@@ -0,0 +1,13 @@
+import { Context, Router } from '@orpc/server';
+import { NodeHttpHandler, NodeHttpRequest, NodeHttpResponse, NodeHttpHandleResult } from '@orpc/server/node';
+import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
+import { MaybeOptionalOptions } from '@orpc/shared';
+import { SendStandardResponseOptions } from '@orpc/standard-server-node';
+
+declare class OpenAPIHandler<T extends Context> implements NodeHttpHandler<T> {
+    private readonly standardHandler;
+    constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
+    handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
+}
+
+export { OpenAPIHandler };

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

@@ -0,0 +1,13 @@
+import { Context, Router } from '@orpc/server';
+import { NodeHttpHandler, NodeHttpRequest, NodeHttpResponse, NodeHttpHandleResult } from '@orpc/server/node';
+import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
+import { MaybeOptionalOptions } from '@orpc/shared';
+import { SendStandardResponseOptions } from '@orpc/standard-server-node';
+
+declare class OpenAPIHandler<T extends Context> implements NodeHttpHandler<T> {
+    private readonly standardHandler;
+    constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
+    handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
+}
+
+export { OpenAPIHandler };

package/dist/adapters/node/index.mjs

@@ -0,0 +1,33 @@
+import { OpenAPISerializer } from '@orpc/openapi-client/standard';
+import { StandardHandler } from '@orpc/server/standard';
+import { toStandardLazyRequest, sendStandardResponse } from '@orpc/standard-server-node';
+import { a as OpenAPIMatcher, O as OpenAPICodec } from '../../shared/openapi.CJTe38Ya.mjs';
+import '@orpc/shared';
+import 'json-schema-typed/draft-2020-12';
+import '@orpc/contract';
+import '@orpc/server';
+import 'rou3';
+import '../../shared/openapi.DZzpQAb-.mjs';
+
+class OpenAPIHandler {
+  standardHandler;
+  constructor(router, options = {}) {
+    const serializer = new OpenAPISerializer();
+    const matcher = new OpenAPIMatcher();
+    const codec = new OpenAPICodec(serializer);
+    this.standardHandler = new StandardHandler(router, matcher, codec, options);
+  }
+  async handle(req, res, ...[
+    options = {}
+  ]) {
+    const standardRequest = toStandardLazyRequest(req, res);
+    const result = await this.standardHandler.handle(standardRequest, options);
+    if (!result.matched) {
+      return { matched: false };
+    }
+    await sendStandardResponse(res, result.response, options);
+    return { matched: true };
+  }
+}
+
+export { OpenAPIHandler };

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

@@ -0,0 +1,34 @@
+import { ORPCError } from '@orpc/client';
+import { OpenAPISerializer } from '@orpc/openapi-client/standard';
+import { AnyProcedure, AnyRouter } from '@orpc/server';
+import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
+import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
+import { HTTPPath } from '@orpc/contract';
+
+declare class OpenAPICodec implements StandardCodec {
+    private readonly serializer;
+    constructor(serializer: OpenAPISerializer);
+    decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
+    encode(output: unknown, procedure: AnyProcedure): StandardResponse;
+    encodeError(error: ORPCError<any, any>): StandardResponse;
+}
+
+declare class OpenAPIMatcher implements StandardMatcher {
+    private readonly tree;
+    private pendingRouters;
+    init(router: AnyRouter, path?: readonly string[]): void;
+    match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
+}
+
+/**
+ * {@link https://github.com/unjs/rou3}
+ *
+ * @internal
+ */
+declare function toRou3Pattern(path: HTTPPath): string;
+/**
+ * @internal
+ */
+declare function decodeParams(params: Record<string, string>): Record<string, string>;
+
+export { OpenAPICodec, OpenAPIMatcher, decodeParams, toRou3Pattern };

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

@@ -0,0 +1,34 @@
+import { ORPCError } from '@orpc/client';
+import { OpenAPISerializer } from '@orpc/openapi-client/standard';
+import { AnyProcedure, AnyRouter } from '@orpc/server';
+import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
+import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
+import { HTTPPath } from '@orpc/contract';
+
+declare class OpenAPICodec implements StandardCodec {
+    private readonly serializer;
+    constructor(serializer: OpenAPISerializer);
+    decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
+    encode(output: unknown, procedure: AnyProcedure): StandardResponse;
+    encodeError(error: ORPCError<any, any>): StandardResponse;
+}
+
+declare class OpenAPIMatcher implements StandardMatcher {
+    private readonly tree;
+    private pendingRouters;
+    init(router: AnyRouter, path?: readonly string[]): void;
+    match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
+}
+
+/**
+ * {@link https://github.com/unjs/rou3}
+ *
+ * @internal
+ */
+declare function toRou3Pattern(path: HTTPPath): string;
+/**
+ * @internal
+ */
+declare function decodeParams(params: Record<string, string>): Record<string, string>;
+
+export { OpenAPICodec, OpenAPIMatcher, decodeParams, toRou3Pattern };

package/dist/adapters/standard/index.mjs

@@ -0,0 +1,7 @@
+export { O as OpenAPICodec, a as OpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.CJTe38Ya.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/index.d.mts

@@ -0,0 +1,119 @@
+import { AnyContractProcedure, AnySchema, AnyContractRouter, HTTPPath, HTTPMethod } from '@orpc/contract';
+import { OpenAPIV3_1 } from 'openapi-types';
+export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
+import { AnyRouter } from '@orpc/server';
+import { JSONSchema } from 'json-schema-typed/draft-2020-12';
+export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
+
+type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
+declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
+declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
+declare function applyCustomOpenAPIOperation(operation: OpenAPIV3_1.OperationObject, contract: AnyContractProcedure): OpenAPIV3_1.OperationObject;
+
+/**
+ * @internal
+ */
+type ObjectSchema = JSONSchema & {
+    type: 'object';
+} & object;
+/**
+ * @internal
+ */
+type FileSchema = JSONSchema & {
+    type: 'string';
+    contentMediaType: string;
+} & object;
+/**
+ * @internal
+ */
+declare const LOGIC_KEYWORDS: string[];
+
+interface SchemaConvertOptions {
+    strategy: 'input' | 'output';
+}
+interface SchemaConverter {
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
+}
+interface ConditionalSchemaConverter extends SchemaConverter {
+    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean;
+}
+declare class CompositeSchemaConverter implements SchemaConverter {
+    private readonly converters;
+    constructor(converters: ConditionalSchemaConverter[]);
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
+}
+
+interface OpenAPIGeneratorOptions {
+    schemaConverters?: ConditionalSchemaConverter[];
+}
+declare class OpenAPIGenerator {
+    #private;
+    private readonly serializer;
+    private readonly converter;
+    constructor(options?: OpenAPIGeneratorOptions);
+    generate(router: AnyContractRouter | AnyRouter, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
+}
+
+/**
+ * @internal
+ */
+declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
+/**
+ * @internal
+ */
+declare function toOpenAPIPath(path: HTTPPath): string;
+/**
+ * @internal
+ */
+declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
+/**
+ * @internal
+ */
+declare function getDynamicParams(path: HTTPPath | undefined): string[] | undefined;
+/**
+ * @internal
+ */
+declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPIV3_1.MediaTypeObject>;
+/**
+ * @internal
+ */
+declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPIV3_1.MediaTypeObject>;
+/**
+ * @internal
+ */
+declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPIV3_1.ParameterObject[];
+/**
+ * @internal
+ */
+declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
+/**
+ * @internal
+ */
+declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
+
+/**
+ *@internal
+ */
+declare function isFileSchema(schema: JSONSchema): schema is FileSchema;
+/**
+ * @internal
+ */
+declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
+/**
+ * @internal
+ */
+declare function isAnySchema(schema: JSONSchema): boolean;
+/**
+ * @internal
+ */
+declare function separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
+/**
+ * @internal
+ */
+declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
+
+declare const oo: {
+    spec: typeof customOpenAPIOperation;
+};
+
+export { CompositeSchemaConverter, type ConditionalSchemaConverter, type FileSchema, LOGIC_KEYWORDS, type ObjectSchema, OpenAPIGenerator, type OpenAPIGeneratorOptions, type OverrideOperationValue, type SchemaConvertOptions, type SchemaConverter, applyCustomOpenAPIOperation, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, getDynamicParams, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, standardizeHTTPPath, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };

package/dist/index.d.ts

@@ -0,0 +1,119 @@
+import { AnyContractProcedure, AnySchema, AnyContractRouter, HTTPPath, HTTPMethod } from '@orpc/contract';
+import { OpenAPIV3_1 } from 'openapi-types';
+export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
+import { AnyRouter } from '@orpc/server';
+import { JSONSchema } from 'json-schema-typed/draft-2020-12';
+export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
+
+type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
+declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
+declare function getCustomOpenAPIOperation(o: object): OverrideOperationValue | undefined;
+declare function applyCustomOpenAPIOperation(operation: OpenAPIV3_1.OperationObject, contract: AnyContractProcedure): OpenAPIV3_1.OperationObject;
+
+/**
+ * @internal
+ */
+type ObjectSchema = JSONSchema & {
+    type: 'object';
+} & object;
+/**
+ * @internal
+ */
+type FileSchema = JSONSchema & {
+    type: 'string';
+    contentMediaType: string;
+} & object;
+/**
+ * @internal
+ */
+declare const LOGIC_KEYWORDS: string[];
+
+interface SchemaConvertOptions {
+    strategy: 'input' | 'output';
+}
+interface SchemaConverter {
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
+}
+interface ConditionalSchemaConverter extends SchemaConverter {
+    condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean;
+}
+declare class CompositeSchemaConverter implements SchemaConverter {
+    private readonly converters;
+    constructor(converters: ConditionalSchemaConverter[]);
+    convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
+}
+
+interface OpenAPIGeneratorOptions {
+    schemaConverters?: ConditionalSchemaConverter[];
+}
+declare class OpenAPIGenerator {
+    #private;
+    private readonly serializer;
+    private readonly converter;
+    constructor(options?: OpenAPIGeneratorOptions);
+    generate(router: AnyContractRouter | AnyRouter, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
+}
+
+/**
+ * @internal
+ */
+declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
+/**
+ * @internal
+ */
+declare function toOpenAPIPath(path: HTTPPath): string;
+/**
+ * @internal
+ */
+declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
+/**
+ * @internal
+ */
+declare function getDynamicParams(path: HTTPPath | undefined): string[] | undefined;
+/**
+ * @internal
+ */
+declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPIV3_1.MediaTypeObject>;
+/**
+ * @internal
+ */
+declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPIV3_1.MediaTypeObject>;
+/**
+ * @internal
+ */
+declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPIV3_1.ParameterObject[];
+/**
+ * @internal
+ */
+declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
+/**
+ * @internal
+ */
+declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
+
+/**
+ *@internal
+ */
+declare function isFileSchema(schema: JSONSchema): schema is FileSchema;
+/**
+ * @internal
+ */
+declare function isObjectSchema(schema: JSONSchema): schema is ObjectSchema;
+/**
+ * @internal
+ */
+declare function isAnySchema(schema: JSONSchema): boolean;
+/**
+ * @internal
+ */
+declare function separateObjectSchema(schema: ObjectSchema, separatedProperties: string[]): [matched: ObjectSchema, rest: ObjectSchema];
+/**
+ * @internal
+ */
+declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
+
+declare const oo: {
+    spec: typeof customOpenAPIOperation;
+};
+
+export { CompositeSchemaConverter, type ConditionalSchemaConverter, type FileSchema, LOGIC_KEYWORDS, type ObjectSchema, OpenAPIGenerator, type OpenAPIGeneratorOptions, type OverrideOperationValue, type SchemaConvertOptions, type SchemaConverter, applyCustomOpenAPIOperation, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, getDynamicParams, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, standardizeHTTPPath, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };