@orpc/openapi 0.0.0-next.4a2200e → 0.0.0-next.4a7a06a

package/README.md

@@ -49,6 +49,7 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
 - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
 - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with NestJS.
 - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
 - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
 - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).

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

@@ -8,7 +8,7 @@ import '@orpc/server/standard';
  * OpenAPI Handler for Fetch Server
  *
  * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
- * @see {@link https://orpc.unnoq.com/docs/integrations/fetch-server Fetch Server Integration Docs}
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
  */
 declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);

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

@@ -8,7 +8,7 @@ import '@orpc/server/standard';
  * OpenAPI Handler for Fetch Server
  *
  * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
- * @see {@link https://orpc.unnoq.com/docs/integrations/fetch-server Fetch Server Integration Docs}
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
  */
 declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);

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

@@ -8,7 +8,7 @@ import '@orpc/server/standard';
  * OpenAPI Handler for Node Server
  *
  * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
- * @see {@link https://orpc.unnoq.com/docs/integrations/node Node Integration Docs}
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
  */
 declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);

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

@@ -8,7 +8,7 @@ import '@orpc/server/standard';
  * OpenAPI Handler for Node Server
  *
  * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-handler OpenAPI Handler Docs}
- * @see {@link https://orpc.unnoq.com/docs/integrations/node Node Integration Docs}
+ * @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
  */
 declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
     constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);

package/dist/index.d.mts

@@ -1,12 +1,14 @@
-import { AnyContractProcedure, AnySchema, AnyContractRouter } from '@orpc/contract';
+import { AnyContractProcedure } from '@orpc/contract';
 import { OpenAPIV3_1 } from 'openapi-types';
 export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
-import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
-import { AnyRouter } from '@orpc/server';
-import { Promisable } from '@orpc/shared';
-import { JSONSchema } from 'json-schema-typed/draft-2020-12';
-export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
+export { d as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, S as SchemaConvertOptions, c as SchemaConverter } from './shared/openapi.DP97kr00.mjs';
 import { HTTPPath, HTTPMethod } from '@orpc/client';
+import { JSONSchema } from 'json-schema-typed/draft-2020-12';
+export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat } 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);
 /**
@@ -36,42 +38,6 @@ type FileSchema = JSONSchema & {
  */
 declare const LOGIC_KEYWORDS: string[];
 
-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[];
-}
-/**
- * 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, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
-}
-
 /**
  * @internal
  */
@@ -101,6 +67,8 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
  */
 declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
 
+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
  */
@@ -127,5 +95,5 @@ declare const oo: {
     spec: typeof customOpenAPIOperation;
 };
 
-export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
-export type { ConditionalSchemaConverter, FileSchema, ObjectSchema, OpenAPIGeneratorOptions, OverrideOperationValue, SchemaConvertOptions, SchemaConverter };
+export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export type { FileSchema, ObjectSchema, OverrideOperationValue };

package/dist/index.d.ts

@@ -1,12 +1,14 @@
-import { AnyContractProcedure, AnySchema, AnyContractRouter } from '@orpc/contract';
+import { AnyContractProcedure } from '@orpc/contract';
 import { OpenAPIV3_1 } from 'openapi-types';
 export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
-import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
-import { AnyRouter } from '@orpc/server';
-import { Promisable } from '@orpc/shared';
-import { JSONSchema } from 'json-schema-typed/draft-2020-12';
-export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
+export { d as CompositeSchemaConverter, C as ConditionalSchemaConverter, b as OpenAPIGenerator, a as OpenAPIGeneratorGenerateOptions, O as OpenAPIGeneratorOptions, S as SchemaConvertOptions, c as SchemaConverter } from './shared/openapi.DP97kr00.js';
 import { HTTPPath, HTTPMethod } from '@orpc/client';
+import { JSONSchema } from 'json-schema-typed/draft-2020-12';
+export { JSONSchema, ContentEncoding as JSONSchemaContentEncoding, Format as JSONSchemaFormat } 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);
 /**
@@ -36,42 +38,6 @@ type FileSchema = JSONSchema & {
  */
 declare const LOGIC_KEYWORDS: string[];
 
-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[];
-}
-/**
- * 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, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
-}
-
 /**
  * @internal
  */
@@ -101,6 +67,8 @@ declare function checkParamsSchema(schema: ObjectSchema, params: string[]): bool
  */
 declare function toOpenAPISchema(schema: JSONSchema): OpenAPIV3_1.SchemaObject & object;
 
+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
  */
@@ -127,5 +95,5 @@ declare const oo: {
     spec: typeof customOpenAPIOperation;
 };
 
-export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
-export type { ConditionalSchemaConverter, FileSchema, ObjectSchema, OpenAPIGeneratorOptions, OverrideOperationValue, SchemaConvertOptions, SchemaConverter };
+export { LOGIC_KEYWORDS, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, createJsonifiedRouterClient, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
+export type { FileSchema, ObjectSchema, OverrideOperationValue };