@orpc/openapi 0.0.0-next.999d654 → 0.0.0-next.99d5d75

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

@@ -1,24 +1,10 @@
-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>;
-}
+export { a as StandardOpenAPICodec, S as StandardOpenAPICodecOptions, c as StandardOpenAPIHandler, b as StandardOpenAPIHandlerOptions, e as StandardOpenAPIMatcher, d as StandardOpenAPIMatcherOptions } from '../../shared/openapi.DwaweYRb.mjs';
+import { HTTPPath } from '@orpc/client';
+import '@orpc/openapi-client/standard';
+import '@orpc/server';
+import '@orpc/server/standard';
+import '@orpc/standard-server';
+import '@orpc/shared';
 
 /**
  * {@link https://github.com/unjs/rou3}
@@ -31,4 +17,4 @@ declare function toRou3Pattern(path: HTTPPath): string;
  */
 declare function decodeParams(params: Record<string, string>): Record<string, string>;
 
-export { OpenAPICodec, OpenAPIMatcher, decodeParams, toRou3Pattern };
+export { decodeParams, toRou3Pattern };

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

@@ -1,24 +1,10 @@
-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>;
-}
+export { a as StandardOpenAPICodec, S as StandardOpenAPICodecOptions, c as StandardOpenAPIHandler, b as StandardOpenAPIHandlerOptions, e as StandardOpenAPIMatcher, d as StandardOpenAPIMatcherOptions } from '../../shared/openapi.DwaweYRb.js';
+import { HTTPPath } from '@orpc/client';
+import '@orpc/openapi-client/standard';
+import '@orpc/server';
+import '@orpc/server/standard';
+import '@orpc/standard-server';
+import '@orpc/shared';
 
 /**
  * {@link https://github.com/unjs/rou3}
@@ -31,4 +17,4 @@ declare function toRou3Pattern(path: HTTPPath): string;
  */
 declare function decodeParams(params: Record<string, string>): Record<string, string>;
 
-export { OpenAPICodec, OpenAPIMatcher, decodeParams, toRou3Pattern };
+export { decodeParams, toRou3Pattern };

package/dist/adapters/standard/index.mjs

@@ -1,7 +1,9 @@
-export { O as OpenAPICodec, a as OpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.CJTe38Ya.mjs';
+export { S as StandardOpenAPICodec, a as StandardOpenAPIHandler, b as StandardOpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.DIt-Z9W1.mjs';
+import '@orpc/openapi-client/standard';
+import '@orpc/server/standard';
+import '@orpc/client';
 import '@orpc/contract';
 import '@orpc/shared';
+import '@orpc/client/standard';
 import '@orpc/server';
 import 'rou3';
-import '../../shared/openapi.DZzpQAb-.mjs';
-import 'json-schema-typed/draft-2020-12';

package/dist/index.d.mts

@@ -1,14 +1,23 @@
-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 { 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.BGy4N6eR.mjs';
+import { HTTPPath, HTTPMethod } from '@orpc/client';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
-export { JSONSchema, Format as JSONSchemaFormat } 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';
+import { JsonifiedClient } from '@orpc/openapi-client';
+import { AnyRouter, ClientContext, Lazyable, CreateProcedureClientOptions, InferRouterInitialContext, Schema, ErrorMap, Meta, RouterClient } from '@orpc/server';
+import { MaybeOptionalOptions } from '@orpc/shared';
+import '@orpc/openapi-client/standard';
 
-type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
+type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: OpenAPI.OperationObject, procedure: AnyContractProcedure) => OpenAPI.OperationObject);
+/**
+ * Customize The Operation Object by proxy an error map item or a middleware.
+ *
+ * @see {@link https://orpc.dev/docs/openapi/openapi-specification#customizing-operation-objects Customizing Operation Objects Docs}
+ */
 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;
+declare function applyCustomOpenAPIOperation(operation: OpenAPI.OperationObject, contract: AnyContractProcedure): OpenAPI.OperationObject;
 
 /**
  * @internal
@@ -28,36 +37,6 @@ type FileSchema = JSONSchema & {
  */
 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
  */
@@ -69,27 +48,32 @@ declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
 /**
  * @internal
  */
-declare function getDynamicParams(path: HTTPPath | undefined): string[] | undefined;
+declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPI.MediaTypeObject>;
 /**
  * @internal
  */
-declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPIV3_1.MediaTypeObject>;
+declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPI.MediaTypeObject>;
 /**
  * @internal
  */
-declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPIV3_1.MediaTypeObject>;
+declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPI.ParameterObject[];
 /**
  * @internal
  */
-declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPIV3_1.ParameterObject[];
+declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
 /**
  * @internal
  */
-declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
+declare function toOpenAPISchema(schema: JSONSchema): OpenAPI.SchemaObject & object;
+declare function resolveOpenAPIJsonSchemaRef(doc: OpenAPI.Document, schema: JSONSchema): JSONSchema;
 /**
- * @internal
+ * Simplifies composed object JSON Schemas (using anyOf, oneOf, allOf) by flattening nested compositions
+ *
+ * @warning The result is looser than the original schema and may not fully validate the same data.
  */
-declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
+declare function simplifyComposedObjectJsonSchemasAndRefs(schema: JSONSchema, doc?: OpenAPI.Document): JSONSchema;
+
+declare function createJsonifiedRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown, unknown>, ErrorMap, Meta, TClientContext>>): JsonifiedClient<RouterClient<T, TClientContext>>;
 
 /**
  *@internal
@@ -111,9 +95,22 @@ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties:
  * @internal
  */
 declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
+declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
+/**
+ * Takes a JSON schema and, if it's primarily a union type (anyOf, oneOf),
+ * recursively expands it into an array of its constituent, non-union base schemas.
+ * If the schema is not a simple union or is a base type, it's returned as a single-element array.
+ */
+declare function expandUnionSchema(schema: JSONSchema): JSONSchema[];
+declare function expandArrayableSchema(schema: JSONSchema): undefined | [items: JSONSchema, array: JSONSchema & {
+    type: 'array';
+    items?: JSONSchema;
+}];
+declare function isPrimitiveSchema(schema: JSONSchema): boolean;
 
 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 };
+export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, simplifyComposedObjectJsonSchemasAndRefs, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export type { FileSchema, ObjectSchema, OverrideOperationValue };

package/dist/index.d.ts

@@ -1,14 +1,23 @@
-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 { 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.BGy4N6eR.js';
+import { HTTPPath, HTTPMethod } from '@orpc/client';
 import { JSONSchema } from 'json-schema-typed/draft-2020-12';
-export { JSONSchema, Format as JSONSchemaFormat } 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';
+import { JsonifiedClient } from '@orpc/openapi-client';
+import { AnyRouter, ClientContext, Lazyable, CreateProcedureClientOptions, InferRouterInitialContext, Schema, ErrorMap, Meta, RouterClient } from '@orpc/server';
+import { MaybeOptionalOptions } from '@orpc/shared';
+import '@orpc/openapi-client/standard';
 
-type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
+type OverrideOperationValue = Partial<OpenAPI.OperationObject> | ((current: OpenAPI.OperationObject, procedure: AnyContractProcedure) => OpenAPI.OperationObject);
+/**
+ * Customize The Operation Object by proxy an error map item or a middleware.
+ *
+ * @see {@link https://orpc.dev/docs/openapi/openapi-specification#customizing-operation-objects Customizing Operation Objects Docs}
+ */
 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;
+declare function applyCustomOpenAPIOperation(operation: OpenAPI.OperationObject, contract: AnyContractProcedure): OpenAPI.OperationObject;
 
 /**
  * @internal
@@ -28,36 +37,6 @@ type FileSchema = JSONSchema & {
  */
 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
  */
@@ -69,27 +48,32 @@ declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
 /**
  * @internal
  */
-declare function getDynamicParams(path: HTTPPath | undefined): string[] | undefined;
+declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPI.MediaTypeObject>;
 /**
  * @internal
  */
-declare function toOpenAPIContent(schema: JSONSchema): Record<string, OpenAPIV3_1.MediaTypeObject>;
+declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPI.MediaTypeObject>;
 /**
  * @internal
  */
-declare function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema]: [boolean, JSONSchema], [returnsRequired, returnsSchema]: [boolean, JSONSchema]): Record<string, OpenAPIV3_1.MediaTypeObject>;
+declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPI.ParameterObject[];
 /**
  * @internal
  */
-declare function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPIV3_1.ParameterObject[];
+declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
 /**
  * @internal
  */
-declare function checkParamsSchema(schema: ObjectSchema, params: string[]): boolean;
+declare function toOpenAPISchema(schema: JSONSchema): OpenAPI.SchemaObject & object;
+declare function resolveOpenAPIJsonSchemaRef(doc: OpenAPI.Document, schema: JSONSchema): JSONSchema;
 /**
- * @internal
+ * Simplifies composed object JSON Schemas (using anyOf, oneOf, allOf) by flattening nested compositions
+ *
+ * @warning The result is looser than the original schema and may not fully validate the same data.
  */
-declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
+declare function simplifyComposedObjectJsonSchemasAndRefs(schema: JSONSchema, doc?: OpenAPI.Document): JSONSchema;
+
+declare function createJsonifiedRouterClient<T extends AnyRouter, TClientContext extends ClientContext>(router: Lazyable<T | undefined>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<InferRouterInitialContext<T>, Schema<unknown, unknown>, ErrorMap, Meta, TClientContext>>): JsonifiedClient<RouterClient<T, TClientContext>>;
 
 /**
  *@internal
@@ -111,9 +95,22 @@ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties:
  * @internal
  */
 declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
+declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
+/**
+ * Takes a JSON schema and, if it's primarily a union type (anyOf, oneOf),
+ * recursively expands it into an array of its constituent, non-union base schemas.
+ * If the schema is not a simple union or is a base type, it's returned as a single-element array.
+ */
+declare function expandUnionSchema(schema: JSONSchema): JSONSchema[];
+declare function expandArrayableSchema(schema: JSONSchema): undefined | [items: JSONSchema, array: JSONSchema & {
+    type: 'array';
+    items?: JSONSchema;
+}];
+declare function isPrimitiveSchema(schema: JSONSchema): boolean;
 
 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 };
+export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, expandArrayableSchema, expandUnionSchema, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, isPrimitiveSchema, oo, resolveOpenAPIJsonSchemaRef, separateObjectSchema, simplifyComposedObjectJsonSchemasAndRefs, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export type { FileSchema, ObjectSchema, OverrideOperationValue };