@orpc/openapi 0.0.0-next.2546825 → 0.0.0-next.25532a8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -32,7 +32,7 @@
32
32
  - **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
33
33
  - **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
34
34
  - **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
35
- - **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
35
+ - **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
36
36
  - **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
37
37
  - **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
38
38
  - **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
@@ -53,11 +53,16 @@ You can find the full documentation [here](https://orpc.unnoq.com).
53
53
  - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
54
54
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
55
55
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
56
+ - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
56
57
  - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
57
58
  - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
59
+ - [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
60
+ - [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
58
61
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
59
62
  - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
60
63
  - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
64
+ - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
65
+ - [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
61
66
 
62
67
  ## `@orpc/openapi`
63
68
 
@@ -86,6 +91,14 @@ const server = createServer(async (req, res) => {
86
91
  server.listen(3000, '127.0.0.1', () => console.log('Listening on 127.0.0.1:3000'))
87
92
  ```
88
93
 
94
+ ## Sponsors
95
+
96
+ <p align="center">
97
+ <a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
98
+ <img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
99
+ </a>
100
+ </p>
101
+
89
102
  ## License
90
103
 
91
104
  Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
@@ -1,13 +1,11 @@
1
1
  import { Context, Router } from '@orpc/server';
2
- import { FetchHandler, FetchHandleResult } from '@orpc/server/fetch';
3
- import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
4
- import { MaybeOptionalOptions } from '@orpc/shared';
5
- import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
2
+ import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.IfmmOyba.mjs';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
6
6
 
7
- declare class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
8
- private readonly standardHandler;
9
- constructor(router: Router<T, any>, options?: NoInfer<StandardHandlerOptions<T>>);
10
- handle(request: Request, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
7
+ declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
8
+ constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);
11
9
  }
12
10
 
13
11
  export { OpenAPIHandler };
@@ -1,13 +1,11 @@
1
1
  import { Context, Router } from '@orpc/server';
2
- import { FetchHandler, FetchHandleResult } from '@orpc/server/fetch';
3
- import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
4
- import { MaybeOptionalOptions } from '@orpc/shared';
5
- import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
2
+ import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.IfmmOyba.js';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
6
6
 
7
- declare class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
8
- private readonly standardHandler;
9
- constructor(router: Router<T, any>, options?: NoInfer<StandardHandlerOptions<T>>);
10
- handle(request: Request, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
7
+ declare class OpenAPIHandler<T extends Context> extends FetchHandler<T> {
8
+ constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & FetchHandlerOptions<T>>);
11
9
  }
12
10
 
13
11
  export { OpenAPIHandler };
@@ -1,11 +1,10 @@
1
- export { O as OpenAPIHandler } from '../../shared/openapi.C015V43J.mjs';
1
+ export { O as OpenAPIHandler } from '../../shared/openapi.CGZ7t-VN.mjs';
2
2
  import '@orpc/openapi-client/standard';
3
+ import '@orpc/server/fetch';
3
4
  import '@orpc/server/standard';
4
- import '@orpc/standard-server-fetch';
5
- import '../../shared/openapi.DFXD6scT.mjs';
5
+ import '../../shared/openapi.sdeu0I7N.mjs';
6
6
  import '@orpc/contract';
7
7
  import '@orpc/shared';
8
+ import '@orpc/client/standard';
8
9
  import '@orpc/server';
9
10
  import 'rou3';
10
- import '../../shared/openapi.DZzpQAb-.mjs';
11
- import 'json-schema-typed/draft-2020-12';
@@ -1,6 +1,6 @@
1
1
  export { OpenAPIHandler } from '../fetch/index.mjs';
2
2
  import '@orpc/server';
3
3
  import '@orpc/server/fetch';
4
+ import '../../shared/openapi.IfmmOyba.mjs';
5
+ import '@orpc/openapi-client/standard';
4
6
  import '@orpc/server/standard';
5
- import '@orpc/shared';
6
- import '@orpc/standard-server-fetch';
@@ -1,6 +1,6 @@
1
1
  export { OpenAPIHandler } from '../fetch/index.js';
2
2
  import '@orpc/server';
3
3
  import '@orpc/server/fetch';
4
+ import '../../shared/openapi.IfmmOyba.js';
5
+ import '@orpc/openapi-client/standard';
4
6
  import '@orpc/server/standard';
5
- import '@orpc/shared';
6
- import '@orpc/standard-server-fetch';
@@ -1,11 +1,10 @@
1
- export { O as OpenAPIHandler } from '../../shared/openapi.C015V43J.mjs';
1
+ export { O as OpenAPIHandler } from '../../shared/openapi.CGZ7t-VN.mjs';
2
2
  import '@orpc/openapi-client/standard';
3
+ import '@orpc/server/fetch';
3
4
  import '@orpc/server/standard';
4
- import '@orpc/standard-server-fetch';
5
- import '../../shared/openapi.DFXD6scT.mjs';
5
+ import '../../shared/openapi.sdeu0I7N.mjs';
6
6
  import '@orpc/contract';
7
7
  import '@orpc/shared';
8
+ import '@orpc/client/standard';
8
9
  import '@orpc/server';
9
10
  import 'rou3';
10
- import '../../shared/openapi.DZzpQAb-.mjs';
11
- import 'json-schema-typed/draft-2020-12';
@@ -1,6 +1,6 @@
1
1
  export { OpenAPIHandler } from '../fetch/index.mjs';
2
2
  import '@orpc/server';
3
3
  import '@orpc/server/fetch';
4
+ import '../../shared/openapi.IfmmOyba.mjs';
5
+ import '@orpc/openapi-client/standard';
4
6
  import '@orpc/server/standard';
5
- import '@orpc/shared';
6
- import '@orpc/standard-server-fetch';
@@ -1,6 +1,6 @@
1
1
  export { OpenAPIHandler } from '../fetch/index.js';
2
2
  import '@orpc/server';
3
3
  import '@orpc/server/fetch';
4
+ import '../../shared/openapi.IfmmOyba.js';
5
+ import '@orpc/openapi-client/standard';
4
6
  import '@orpc/server/standard';
5
- import '@orpc/shared';
6
- import '@orpc/standard-server-fetch';
@@ -1,11 +1,10 @@
1
- export { O as OpenAPIHandler } from '../../shared/openapi.C015V43J.mjs';
1
+ export { O as OpenAPIHandler } from '../../shared/openapi.CGZ7t-VN.mjs';
2
2
  import '@orpc/openapi-client/standard';
3
+ import '@orpc/server/fetch';
3
4
  import '@orpc/server/standard';
4
- import '@orpc/standard-server-fetch';
5
- import '../../shared/openapi.DFXD6scT.mjs';
5
+ import '../../shared/openapi.sdeu0I7N.mjs';
6
6
  import '@orpc/contract';
7
7
  import '@orpc/shared';
8
+ import '@orpc/client/standard';
8
9
  import '@orpc/server';
9
10
  import 'rou3';
10
- import '../../shared/openapi.DZzpQAb-.mjs';
11
- import 'json-schema-typed/draft-2020-12';
@@ -1,13 +1,11 @@
1
1
  import { Context, Router } from '@orpc/server';
2
- import { NodeHttpHandler, NodeHttpRequest, NodeHttpResponse, NodeHttpHandleResult } from '@orpc/server/node';
3
- import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
4
- import { MaybeOptionalOptions } from '@orpc/shared';
5
- import { SendStandardResponseOptions } from '@orpc/standard-server-node';
2
+ import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.IfmmOyba.mjs';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
6
6
 
7
- declare class OpenAPIHandler<T extends Context> implements NodeHttpHandler<T> {
8
- private readonly standardHandler;
9
- constructor(router: Router<T, any>, options?: NoInfer<StandardHandlerOptions<T>>);
10
- handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
7
+ declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
8
+ constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);
11
9
  }
12
10
 
13
11
  export { OpenAPIHandler };
@@ -1,13 +1,11 @@
1
1
  import { Context, Router } from '@orpc/server';
2
- import { NodeHttpHandler, NodeHttpRequest, NodeHttpResponse, NodeHttpHandleResult } from '@orpc/server/node';
3
- import { StandardHandlerOptions, StandardHandleOptions } from '@orpc/server/standard';
4
- import { MaybeOptionalOptions } from '@orpc/shared';
5
- import { SendStandardResponseOptions } from '@orpc/standard-server-node';
2
+ import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
3
+ import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.IfmmOyba.js';
4
+ import '@orpc/openapi-client/standard';
5
+ import '@orpc/server/standard';
6
6
 
7
- declare class OpenAPIHandler<T extends Context> implements NodeHttpHandler<T> {
8
- private readonly standardHandler;
9
- constructor(router: Router<T, any>, options?: NoInfer<StandardHandlerOptions<T>>);
10
- handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
7
+ declare class OpenAPIHandler<T extends Context> extends NodeHttpHandler<T> {
8
+ constructor(router: Router<any, T>, options?: NoInfer<StandardOpenAPIHandlerOptions<T> & NodeHttpHandlerOptions<T>>);
11
9
  }
12
10
 
13
11
  export { OpenAPIHandler };
@@ -1,32 +1,21 @@
1
- import { OpenAPISerializer } from '@orpc/openapi-client/standard';
1
+ import { StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer, StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
2
+ import { NodeHttpHandler } from '@orpc/server/node';
2
3
  import { StandardHandler } from '@orpc/server/standard';
3
- import { toStandardLazyRequest, sendStandardResponse } from '@orpc/standard-server-node';
4
- import { a as OpenAPIMatcher, O as OpenAPICodec } from '../../shared/openapi.DFXD6scT.mjs';
5
- import '@orpc/shared';
6
- import 'json-schema-typed/draft-2020-12';
4
+ import { a as StandardOpenAPIMatcher, S as StandardOpenAPICodec } from '../../shared/openapi.sdeu0I7N.mjs';
7
5
  import '@orpc/contract';
6
+ import '@orpc/shared';
7
+ import '@orpc/client/standard';
8
8
  import '@orpc/server';
9
9
  import 'rou3';
10
- import '../../shared/openapi.DZzpQAb-.mjs';
11
10
 
12
- class OpenAPIHandler {
13
- standardHandler;
11
+ class OpenAPIHandler extends NodeHttpHandler {
14
12
  constructor(router, options = {}) {
15
- const serializer = new OpenAPISerializer();
16
- const matcher = new OpenAPIMatcher();
17
- const codec = new OpenAPICodec(serializer);
18
- this.standardHandler = new StandardHandler(router, matcher, codec, options);
19
- }
20
- async handle(req, res, ...[
21
- options = {}
22
- ]) {
23
- const standardRequest = toStandardLazyRequest(req, res);
24
- const result = await this.standardHandler.handle(standardRequest, options);
25
- if (!result.matched) {
26
- return { matched: false };
27
- }
28
- await sendStandardResponse(res, result.response, options);
29
- return { matched: true };
13
+ const jsonSerializer = new StandardOpenAPIJsonSerializer(options);
14
+ const bracketNotationSerializer = new StandardBracketNotationSerializer();
15
+ const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
16
+ const matcher = new StandardOpenAPIMatcher();
17
+ const codec = new StandardOpenAPICodec(serializer);
18
+ super(new StandardHandler(router, matcher, codec, options), options);
30
19
  }
31
20
  }
32
21
 
@@ -1,22 +1,22 @@
1
- import { ORPCError } from '@orpc/client';
2
- import { OpenAPISerializer } from '@orpc/openapi-client/standard';
1
+ import { ORPCError, HTTPPath } from '@orpc/client';
2
+ import { StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
3
3
  import { AnyProcedure, AnyRouter } from '@orpc/server';
4
4
  import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
5
5
  import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
6
- import { HTTPPath } from '@orpc/contract';
6
+ export { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.IfmmOyba.mjs';
7
7
 
8
- declare class OpenAPICodec implements StandardCodec {
8
+ declare class StandardOpenAPICodec implements StandardCodec {
9
9
  private readonly serializer;
10
- constructor(serializer: OpenAPISerializer);
10
+ constructor(serializer: StandardOpenAPISerializer);
11
11
  decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
12
12
  encode(output: unknown, procedure: AnyProcedure): StandardResponse;
13
13
  encodeError(error: ORPCError<any, any>): StandardResponse;
14
14
  }
15
15
 
16
- declare class OpenAPIMatcher implements StandardMatcher {
16
+ declare class StandardOpenAPIMatcher implements StandardMatcher {
17
17
  private readonly tree;
18
18
  private pendingRouters;
19
- init(router: AnyRouter, path?: string[]): void;
19
+ init(router: AnyRouter, path?: readonly string[]): void;
20
20
  match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
21
21
  }
22
22
 
@@ -31,4 +31,4 @@ declare function toRou3Pattern(path: HTTPPath): string;
31
31
  */
32
32
  declare function decodeParams(params: Record<string, string>): Record<string, string>;
33
33
 
34
- export { OpenAPICodec, OpenAPIMatcher, decodeParams, toRou3Pattern };
34
+ export { StandardOpenAPICodec, StandardOpenAPIMatcher, decodeParams, toRou3Pattern };
@@ -1,22 +1,22 @@
1
- import { ORPCError } from '@orpc/client';
2
- import { OpenAPISerializer } from '@orpc/openapi-client/standard';
1
+ import { ORPCError, HTTPPath } from '@orpc/client';
2
+ import { StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
3
3
  import { AnyProcedure, AnyRouter } from '@orpc/server';
4
4
  import { StandardCodec, StandardParams, StandardMatcher, StandardMatchResult } from '@orpc/server/standard';
5
5
  import { StandardLazyRequest, StandardResponse } from '@orpc/standard-server';
6
- import { HTTPPath } from '@orpc/contract';
6
+ export { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.IfmmOyba.js';
7
7
 
8
- declare class OpenAPICodec implements StandardCodec {
8
+ declare class StandardOpenAPICodec implements StandardCodec {
9
9
  private readonly serializer;
10
- constructor(serializer: OpenAPISerializer);
10
+ constructor(serializer: StandardOpenAPISerializer);
11
11
  decode(request: StandardLazyRequest, params: StandardParams | undefined, procedure: AnyProcedure): Promise<unknown>;
12
12
  encode(output: unknown, procedure: AnyProcedure): StandardResponse;
13
13
  encodeError(error: ORPCError<any, any>): StandardResponse;
14
14
  }
15
15
 
16
- declare class OpenAPIMatcher implements StandardMatcher {
16
+ declare class StandardOpenAPIMatcher implements StandardMatcher {
17
17
  private readonly tree;
18
18
  private pendingRouters;
19
- init(router: AnyRouter, path?: string[]): void;
19
+ init(router: AnyRouter, path?: readonly string[]): void;
20
20
  match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
21
21
  }
22
22
 
@@ -31,4 +31,4 @@ declare function toRou3Pattern(path: HTTPPath): string;
31
31
  */
32
32
  declare function decodeParams(params: Record<string, string>): Record<string, string>;
33
33
 
34
- export { OpenAPICodec, OpenAPIMatcher, decodeParams, toRou3Pattern };
34
+ export { StandardOpenAPICodec, StandardOpenAPIMatcher, decodeParams, toRou3Pattern };
@@ -1,7 +1,7 @@
1
- export { O as OpenAPICodec, a as OpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.DFXD6scT.mjs';
1
+ export { S as StandardOpenAPICodec, a as StandardOpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.sdeu0I7N.mjs';
2
2
  import '@orpc/contract';
3
3
  import '@orpc/shared';
4
+ import '@orpc/client/standard';
4
5
  import '@orpc/server';
5
6
  import 'rou3';
6
- import '../../shared/openapi.DZzpQAb-.mjs';
7
- import 'json-schema-typed/draft-2020-12';
7
+ import '@orpc/openapi-client/standard';
package/dist/index.d.mts CHANGED
@@ -1,9 +1,11 @@
1
- import { AnyContractProcedure, Schema, AnyContractRouter, HTTPPath, HTTPMethod } from '@orpc/contract';
1
+ import { AnyContractProcedure, AnySchema, AnyContractRouter } from '@orpc/contract';
2
2
  import { OpenAPIV3_1 } from 'openapi-types';
3
3
  export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
4
+ import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
4
5
  import { AnyRouter } from '@orpc/server';
5
6
  import { JSONSchema } from 'json-schema-typed/draft-2020-12';
6
7
  export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
8
+ import { HTTPPath, HTTPMethod } from '@orpc/client';
7
9
 
8
10
  type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
9
11
  declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
@@ -32,18 +34,18 @@ interface SchemaConvertOptions {
32
34
  strategy: 'input' | 'output';
33
35
  }
34
36
  interface SchemaConverter {
35
- convert(schema: Schema, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
37
+ convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
36
38
  }
37
39
  interface ConditionalSchemaConverter extends SchemaConverter {
38
- condition(schema: Schema, options: SchemaConvertOptions): boolean;
40
+ condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean;
39
41
  }
40
42
  declare class CompositeSchemaConverter implements SchemaConverter {
41
43
  private readonly converters;
42
44
  constructor(converters: ConditionalSchemaConverter[]);
43
- convert(schema: Schema, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
45
+ convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
44
46
  }
45
47
 
46
- interface OpenAPIGeneratorOptions {
48
+ interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
47
49
  schemaConverters?: ConditionalSchemaConverter[];
48
50
  }
49
51
  declare class OpenAPIGenerator {
@@ -54,10 +56,6 @@ declare class OpenAPIGenerator {
54
56
  generate(router: AnyContractRouter | AnyRouter, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
55
57
  }
56
58
 
57
- /**
58
- * @internal
59
- */
60
- declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
61
59
  /**
62
60
  * @internal
63
61
  */
@@ -66,10 +64,6 @@ declare function toOpenAPIPath(path: HTTPPath): string;
66
64
  * @internal
67
65
  */
68
66
  declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
69
- /**
70
- * @internal
71
- */
72
- declare function getDynamicParams(path: HTTPPath | undefined): string[] | undefined;
73
67
  /**
74
68
  * @internal
75
69
  */
@@ -111,9 +105,10 @@ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties:
111
105
  * @internal
112
106
  */
113
107
  declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
108
+ declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
114
109
 
115
110
  declare const oo: {
116
111
  spec: typeof customOpenAPIOperation;
117
112
  };
118
113
 
119
- 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 };
114
+ export { CompositeSchemaConverter, type ConditionalSchemaConverter, type FileSchema, LOGIC_KEYWORDS, type ObjectSchema, OpenAPIGenerator, type OpenAPIGeneratorOptions, type OverrideOperationValue, type SchemaConvertOptions, type SchemaConverter, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
package/dist/index.d.ts CHANGED
@@ -1,9 +1,11 @@
1
- import { AnyContractProcedure, Schema, AnyContractRouter, HTTPPath, HTTPMethod } from '@orpc/contract';
1
+ import { AnyContractProcedure, AnySchema, AnyContractRouter } from '@orpc/contract';
2
2
  import { OpenAPIV3_1 } from 'openapi-types';
3
3
  export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
4
+ import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
4
5
  import { AnyRouter } from '@orpc/server';
5
6
  import { JSONSchema } from 'json-schema-typed/draft-2020-12';
6
7
  export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
8
+ import { HTTPPath, HTTPMethod } from '@orpc/client';
7
9
 
8
10
  type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
9
11
  declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
@@ -32,18 +34,18 @@ interface SchemaConvertOptions {
32
34
  strategy: 'input' | 'output';
33
35
  }
34
36
  interface SchemaConverter {
35
- convert(schema: Schema, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
37
+ convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
36
38
  }
37
39
  interface ConditionalSchemaConverter extends SchemaConverter {
38
- condition(schema: Schema, options: SchemaConvertOptions): boolean;
40
+ condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean;
39
41
  }
40
42
  declare class CompositeSchemaConverter implements SchemaConverter {
41
43
  private readonly converters;
42
44
  constructor(converters: ConditionalSchemaConverter[]);
43
- convert(schema: Schema, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
45
+ convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
44
46
  }
45
47
 
46
- interface OpenAPIGeneratorOptions {
48
+ interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
47
49
  schemaConverters?: ConditionalSchemaConverter[];
48
50
  }
49
51
  declare class OpenAPIGenerator {
@@ -54,10 +56,6 @@ declare class OpenAPIGenerator {
54
56
  generate(router: AnyContractRouter | AnyRouter, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
55
57
  }
56
58
 
57
- /**
58
- * @internal
59
- */
60
- declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
61
59
  /**
62
60
  * @internal
63
61
  */
@@ -66,10 +64,6 @@ declare function toOpenAPIPath(path: HTTPPath): string;
66
64
  * @internal
67
65
  */
68
66
  declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
69
- /**
70
- * @internal
71
- */
72
- declare function getDynamicParams(path: HTTPPath | undefined): string[] | undefined;
73
67
  /**
74
68
  * @internal
75
69
  */
@@ -111,9 +105,10 @@ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties:
111
105
  * @internal
112
106
  */
113
107
  declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
108
+ declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
114
109
 
115
110
  declare const oo: {
116
111
  spec: typeof customOpenAPIOperation;
117
112
  };
118
113
 
119
- 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 };
114
+ export { CompositeSchemaConverter, type ConditionalSchemaConverter, type FileSchema, LOGIC_KEYWORDS, type ObjectSchema, OpenAPIGenerator, type OpenAPIGeneratorOptions, type OverrideOperationValue, type SchemaConvertOptions, type SchemaConverter, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
package/dist/index.mjs CHANGED
@@ -1,10 +1,9 @@
1
- import { isProcedure, eachAllContractProcedure, convertPathToHttpPath } from '@orpc/server';
1
+ import { isProcedure, resolveContractProcedures } from '@orpc/server';
2
2
  import { fallbackORPCErrorStatus, fallbackORPCErrorMessage } from '@orpc/client';
3
+ import { toHttpPath } from '@orpc/client/standard';
3
4
  import { fallbackContractConfig, getEventIteratorSchemaDetails } from '@orpc/contract';
4
- import { OpenAPISerializer } from '@orpc/openapi-client/standard';
5
- import { clone } from '@orpc/shared';
6
- import { t as toOpenAPIMethod, a as toOpenAPIPath, b as toOpenAPIEventIteratorContent, g as getDynamicParams, i as isAnySchema, c as isObjectSchema, d as separateObjectSchema, e as checkParamsSchema, f as toOpenAPIParameters, h as toOpenAPIContent, j as toOpenAPISchema } from './shared/openapi.DZzpQAb-.mjs';
7
- export { L as LOGIC_KEYWORDS, l as filterSchemaBranches, k as isFileSchema, s as standardizeHTTPPath } from './shared/openapi.DZzpQAb-.mjs';
5
+ import { standardizeHTTPPath, StandardOpenAPIJsonSerializer, getDynamicParams } from '@orpc/openapi-client/standard';
6
+ import { isObject, findDeepMatches, toArray, clone } from '@orpc/shared';
8
7
  export { Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
9
8
 
10
9
  const OPERATION_EXTENDER_SYMBOL = Symbol("ORPC_OPERATION_EXTENDER");
@@ -51,6 +50,238 @@ function applyCustomOpenAPIOperation(operation, contract) {
51
50
  return currentOperation;
52
51
  }
53
52
 
53
+ const LOGIC_KEYWORDS = [
54
+ "$dynamicRef",
55
+ "$ref",
56
+ "additionalItems",
57
+ "additionalProperties",
58
+ "allOf",
59
+ "anyOf",
60
+ "const",
61
+ "contains",
62
+ "contentEncoding",
63
+ "contentMediaType",
64
+ "contentSchema",
65
+ "dependencies",
66
+ "dependentRequired",
67
+ "dependentSchemas",
68
+ "else",
69
+ "enum",
70
+ "exclusiveMaximum",
71
+ "exclusiveMinimum",
72
+ "format",
73
+ "if",
74
+ "items",
75
+ "maxContains",
76
+ "maximum",
77
+ "maxItems",
78
+ "maxLength",
79
+ "maxProperties",
80
+ "minContains",
81
+ "minimum",
82
+ "minItems",
83
+ "minLength",
84
+ "minProperties",
85
+ "multipleOf",
86
+ "not",
87
+ "oneOf",
88
+ "pattern",
89
+ "patternProperties",
90
+ "prefixItems",
91
+ "properties",
92
+ "propertyNames",
93
+ "required",
94
+ "then",
95
+ "type",
96
+ "unevaluatedItems",
97
+ "unevaluatedProperties",
98
+ "uniqueItems"
99
+ ];
100
+
101
+ function isFileSchema(schema) {
102
+ return isObject(schema) && schema.type === "string" && typeof schema.contentMediaType === "string";
103
+ }
104
+ function isObjectSchema(schema) {
105
+ return isObject(schema) && schema.type === "object";
106
+ }
107
+ function isAnySchema(schema) {
108
+ if (schema === true) {
109
+ return true;
110
+ }
111
+ if (Object.keys(schema).every((k) => !LOGIC_KEYWORDS.includes(k))) {
112
+ return true;
113
+ }
114
+ return false;
115
+ }
116
+ function separateObjectSchema(schema, separatedProperties) {
117
+ if (Object.keys(schema).some((k) => k !== "type" && k !== "properties" && k !== "required" && LOGIC_KEYWORDS.includes(k))) {
118
+ return [{ type: "object" }, schema];
119
+ }
120
+ const matched = { ...schema };
121
+ const rest = { ...schema };
122
+ matched.properties = schema.properties && Object.entries(schema.properties).filter(([key]) => separatedProperties.includes(key)).reduce((acc, [key, value]) => {
123
+ acc[key] = value;
124
+ return acc;
125
+ }, {});
126
+ matched.required = schema.required?.filter((key) => separatedProperties.includes(key));
127
+ matched.examples = schema.examples?.map((example) => {
128
+ if (!isObject(example)) {
129
+ return example;
130
+ }
131
+ return Object.entries(example).reduce((acc, [key, value]) => {
132
+ if (separatedProperties.includes(key)) {
133
+ acc[key] = value;
134
+ }
135
+ return acc;
136
+ }, {});
137
+ });
138
+ rest.properties = schema.properties && Object.entries(schema.properties).filter(([key]) => !separatedProperties.includes(key)).reduce((acc, [key, value]) => {
139
+ acc[key] = value;
140
+ return acc;
141
+ }, {});
142
+ rest.required = schema.required?.filter((key) => !separatedProperties.includes(key));
143
+ rest.examples = schema.examples?.map((example) => {
144
+ if (!isObject(example)) {
145
+ return example;
146
+ }
147
+ return Object.entries(example).reduce((acc, [key, value]) => {
148
+ if (!separatedProperties.includes(key)) {
149
+ acc[key] = value;
150
+ }
151
+ return acc;
152
+ }, {});
153
+ });
154
+ return [matched, rest];
155
+ }
156
+ function filterSchemaBranches(schema, check, matches = []) {
157
+ if (check(schema)) {
158
+ matches.push(schema);
159
+ return [matches, void 0];
160
+ }
161
+ if (isObject(schema)) {
162
+ for (const keyword of ["anyOf", "oneOf"]) {
163
+ if (schema[keyword] && Object.keys(schema).every(
164
+ (k) => k === keyword || !LOGIC_KEYWORDS.includes(k)
165
+ )) {
166
+ const rest = schema[keyword].map((s) => filterSchemaBranches(s, check, matches)[1]).filter((v) => !!v);
167
+ if (rest.length === 1 && typeof rest[0] === "object") {
168
+ return [matches, { ...schema, [keyword]: void 0, ...rest[0] }];
169
+ }
170
+ return [matches, { ...schema, [keyword]: rest }];
171
+ }
172
+ }
173
+ }
174
+ return [matches, schema];
175
+ }
176
+ function applySchemaOptionality(required, schema) {
177
+ if (required) {
178
+ return schema;
179
+ }
180
+ return {
181
+ anyOf: [
182
+ schema,
183
+ { not: {} }
184
+ ]
185
+ };
186
+ }
187
+
188
+ function toOpenAPIPath(path) {
189
+ return standardizeHTTPPath(path).replace(/\/\{\+([^}]+)\}/g, "/{$1}");
190
+ }
191
+ function toOpenAPIMethod(method) {
192
+ return method.toLocaleLowerCase();
193
+ }
194
+ function toOpenAPIContent(schema) {
195
+ const content = {};
196
+ const [matches, restSchema] = filterSchemaBranches(schema, isFileSchema);
197
+ for (const file of matches) {
198
+ content[file.contentMediaType] = {
199
+ schema: toOpenAPISchema(file)
200
+ };
201
+ }
202
+ if (restSchema !== void 0) {
203
+ content["application/json"] = {
204
+ schema: toOpenAPISchema(restSchema)
205
+ };
206
+ const isStillHasFileSchema = findDeepMatches((v) => isObject(v) && isFileSchema(v), restSchema).values.length > 0;
207
+ if (isStillHasFileSchema) {
208
+ content["multipart/form-data"] = {
209
+ schema: toOpenAPISchema(restSchema)
210
+ };
211
+ }
212
+ }
213
+ return content;
214
+ }
215
+ function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema], [returnsRequired, returnsSchema]) {
216
+ return {
217
+ "text/event-stream": {
218
+ schema: toOpenAPISchema({
219
+ oneOf: [
220
+ {
221
+ type: "object",
222
+ properties: {
223
+ event: { const: "message" },
224
+ data: yieldsSchema,
225
+ id: { type: "string" },
226
+ retry: { type: "number" }
227
+ },
228
+ required: yieldsRequired ? ["event", "data"] : ["event"]
229
+ },
230
+ {
231
+ type: "object",
232
+ properties: {
233
+ event: { const: "done" },
234
+ data: returnsSchema,
235
+ id: { type: "string" },
236
+ retry: { type: "number" }
237
+ },
238
+ required: returnsRequired ? ["event", "data"] : ["event"]
239
+ },
240
+ {
241
+ type: "object",
242
+ properties: {
243
+ event: { const: "error" },
244
+ data: {},
245
+ id: { type: "string" },
246
+ retry: { type: "number" }
247
+ },
248
+ required: ["event"]
249
+ }
250
+ ]
251
+ })
252
+ }
253
+ };
254
+ }
255
+ function toOpenAPIParameters(schema, parameterIn) {
256
+ const parameters = [];
257
+ for (const key in schema.properties) {
258
+ const keySchema = schema.properties[key];
259
+ parameters.push({
260
+ name: key,
261
+ in: parameterIn,
262
+ required: schema.required?.includes(key),
263
+ style: parameterIn === "query" ? "deepObject" : void 0,
264
+ explode: parameterIn === "query" ? true : void 0,
265
+ schema: toOpenAPISchema(keySchema)
266
+ });
267
+ }
268
+ return parameters;
269
+ }
270
+ function checkParamsSchema(schema, params) {
271
+ const properties = Object.keys(schema.properties ?? {});
272
+ const required = schema.required ?? [];
273
+ if (properties.length !== params.length || properties.some((v) => !params.includes(v))) {
274
+ return false;
275
+ }
276
+ if (required.length !== params.length || required.some((v) => !params.includes(v))) {
277
+ return false;
278
+ }
279
+ return true;
280
+ }
281
+ function toOpenAPISchema(schema) {
282
+ return schema === true ? {} : schema === false ? { not: {} } : schema;
283
+ }
284
+
54
285
  class CompositeSchemaConverter {
55
286
  converters;
56
287
  constructor(converters) {
@@ -72,19 +303,19 @@ class OpenAPIGenerator {
72
303
  serializer;
73
304
  converter;
74
305
  constructor(options = {}) {
75
- this.serializer = new OpenAPISerializer();
76
- this.converter = new CompositeSchemaConverter(options.schemaConverters ?? []);
306
+ this.serializer = new StandardOpenAPIJsonSerializer(options);
307
+ this.converter = new CompositeSchemaConverter(toArray(options.schemaConverters));
77
308
  }
78
309
  async generate(router, base) {
79
310
  const doc = clone(base);
80
311
  doc.openapi = "3.1.1";
81
312
  const errors = [];
82
- await eachAllContractProcedure({ path: [], router }, ({ contract, path }) => {
313
+ await resolveContractProcedures({ path: [], router }, ({ contract, path }) => {
83
314
  const operationId = path.join(".");
84
315
  try {
85
316
  const def = contract["~orpc"];
86
317
  const method = toOpenAPIMethod(fallbackContractConfig("defaultMethod", def.route.method));
87
- const httpPath = toOpenAPIPath(def.route.path ?? convertPathToHttpPath(path));
318
+ const httpPath = toOpenAPIPath(def.route.path ?? toHttpPath(path));
88
319
  const operationObjectRef = {
89
320
  operationId,
90
321
  summary: def.route.summary,
@@ -115,7 +346,7 @@ ${e.message}`
115
346
  ${errors.join("\n\n")}`
116
347
  );
117
348
  }
118
- return this.serializer.serialize(doc);
349
+ return this.serializer.serialize(doc)[0];
119
350
  }
120
351
  #request(ref, def) {
121
352
  const method = fallbackContractConfig("defaultMethod", def.route.method);
@@ -130,7 +361,7 @@ ${errors.join("\n\n")}`
130
361
  };
131
362
  return;
132
363
  }
133
- const dynamicParams = getDynamicParams(def.route.path);
364
+ const dynamicParams = getDynamicParams(def.route.path)?.map((v) => v.name);
134
365
  const inputStructure = fallbackContractConfig("defaultInputStructure", def.route.inputStructure);
135
366
  let [required, schema] = this.converter.convert(def.inputSchema, { strategy: "input" });
136
367
  if (isAnySchema(schema) && !dynamicParams?.length) {
@@ -215,13 +446,13 @@ ${errors.join("\n\n")}`
215
446
  };
216
447
  return;
217
448
  }
218
- const [_, json] = this.converter.convert(outputSchema, { strategy: "output" });
449
+ const [required, json] = this.converter.convert(outputSchema, { strategy: "output" });
219
450
  ref.responses ??= {};
220
451
  ref.responses[status] = {
221
452
  description
222
453
  };
223
454
  if (outputStructure === "compact") {
224
- ref.responses[status].content = toOpenAPIContent(json);
455
+ ref.responses[status].content = toOpenAPIContent(applySchemaOptionality(required, json));
225
456
  return;
226
457
  }
227
458
  const error = new OpenAPIGeneratorError(
@@ -243,7 +474,9 @@ ${errors.join("\n\n")}`
243
474
  }
244
475
  }
245
476
  if (json.properties?.body !== void 0) {
246
- ref.responses[status].content = toOpenAPIContent(json.properties.body);
477
+ ref.responses[status].content = toOpenAPIContent(
478
+ applySchemaOptionality(json.required?.includes("body") ?? false, json.properties.body)
479
+ );
247
480
  }
248
481
  }
249
482
  #errorResponse(ref, def) {
@@ -300,4 +533,4 @@ const oo = {
300
533
  spec: customOpenAPIOperation
301
534
  };
302
535
 
303
- export { CompositeSchemaConverter, OpenAPIGenerator, applyCustomOpenAPIOperation, checkParamsSchema, customOpenAPIOperation, getCustomOpenAPIOperation, getDynamicParams, isAnySchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
536
+ export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
@@ -0,0 +1,17 @@
1
+ import { StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer, StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
2
+ import { FetchHandler } from '@orpc/server/fetch';
3
+ import { StandardHandler } from '@orpc/server/standard';
4
+ import { a as StandardOpenAPIMatcher, S as StandardOpenAPICodec } from './openapi.sdeu0I7N.mjs';
5
+
6
+ class OpenAPIHandler extends FetchHandler {
7
+ constructor(router, options = {}) {
8
+ const jsonSerializer = new StandardOpenAPIJsonSerializer(options);
9
+ const bracketNotationSerializer = new StandardBracketNotationSerializer();
10
+ const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
11
+ const matcher = new StandardOpenAPIMatcher();
12
+ const codec = new StandardOpenAPICodec(serializer);
13
+ super(new StandardHandler(router, matcher, codec, options), options);
14
+ }
15
+ }
16
+
17
+ export { OpenAPIHandler as O };
@@ -0,0 +1,8 @@
1
+ import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
2
+ import { Context } from '@orpc/server';
3
+ import { StandardHandlerOptions } from '@orpc/server/standard';
4
+
5
+ interface StandardOpenAPIHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardOpenAPIJsonSerializerOptions {
6
+ }
7
+
8
+ export type { StandardOpenAPIHandlerOptions as S };
@@ -0,0 +1,8 @@
1
+ import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
2
+ import { Context } from '@orpc/server';
3
+ import { StandardHandlerOptions } from '@orpc/server/standard';
4
+
5
+ interface StandardOpenAPIHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardOpenAPIJsonSerializerOptions {
6
+ }
7
+
8
+ export type { StandardOpenAPIHandlerOptions as S };
@@ -1,10 +1,11 @@
1
1
  import { fallbackContractConfig } from '@orpc/contract';
2
2
  import { isObject } from '@orpc/shared';
3
- import { eachContractProcedure, convertPathToHttpPath, isProcedure, getLazyRouterPrefix, unlazy, getRouterChild, createContractedProcedure } from '@orpc/server';
3
+ import { toHttpPath } from '@orpc/client/standard';
4
+ import { traverseContractProcedures, isProcedure, getLazyMeta, unlazy, getRouter, createContractedProcedure } from '@orpc/server';
4
5
  import { createRouter, addRoute, findRoute } from 'rou3';
5
- import { s as standardizeHTTPPath } from './openapi.DZzpQAb-.mjs';
6
+ import { standardizeHTTPPath } from '@orpc/openapi-client/standard';
6
7
 
7
- class OpenAPICodec {
8
+ class StandardOpenAPICodec {
8
9
  constructor(serializer) {
9
10
  this.serializer = serializer;
10
11
  }
@@ -65,7 +66,7 @@ class OpenAPICodec {
65
66
  return {
66
67
  status: error.status,
67
68
  headers: {},
68
- body: this.serializer.serialize(error.toJSON())
69
+ body: this.serializer.serialize(error.toJSON(), { outputFormat: "plain" })
69
70
  };
70
71
  }
71
72
  }
@@ -77,16 +78,13 @@ function decodeParams(params) {
77
78
  return Object.fromEntries(Object.entries(params).map(([key, value]) => [key, decodeURIComponent(value)]));
78
79
  }
79
80
 
80
- class OpenAPIMatcher {
81
+ class StandardOpenAPIMatcher {
81
82
  tree = createRouter();
82
83
  pendingRouters = [];
83
84
  init(router, path = []) {
84
- const laziedOptions = eachContractProcedure({
85
- router,
86
- path
87
- }, ({ path: path2, contract }) => {
85
+ const laziedOptions = traverseContractProcedures({ router, path }, ({ path: path2, contract }) => {
88
86
  const method = fallbackContractConfig("defaultMethod", contract["~orpc"].route.method);
89
- const httpPath = contract["~orpc"].route.path ? toRou3Pattern(contract["~orpc"].route.path) : convertPathToHttpPath(path2);
87
+ const httpPath = toRou3Pattern(contract["~orpc"].route.path ?? toHttpPath(path2));
90
88
  if (isProcedure(contract)) {
91
89
  addRoute(this.tree, method, httpPath, {
92
90
  path: path2,
@@ -106,8 +104,8 @@ class OpenAPIMatcher {
106
104
  });
107
105
  this.pendingRouters.push(...laziedOptions.map((option) => ({
108
106
  ...option,
109
- httpPathPrefix: convertPathToHttpPath(option.path),
110
- laziedPrefix: getLazyRouterPrefix(option.lazied)
107
+ httpPathPrefix: toHttpPath(option.path),
108
+ laziedPrefix: getLazyMeta(option.router).prefix
111
109
  })));
112
110
  }
113
111
  async match(method, pathname) {
@@ -115,7 +113,7 @@ class OpenAPIMatcher {
115
113
  const newPendingRouters = [];
116
114
  for (const pendingRouter of this.pendingRouters) {
117
115
  if (!pendingRouter.laziedPrefix || pathname.startsWith(pendingRouter.laziedPrefix) || pathname.startsWith(pendingRouter.httpPathPrefix)) {
118
- const { default: router } = await unlazy(pendingRouter.lazied);
116
+ const { default: router } = await unlazy(pendingRouter.router);
119
117
  this.init(router, pendingRouter.path);
120
118
  } else {
121
119
  newPendingRouters.push(pendingRouter);
@@ -128,14 +126,14 @@ class OpenAPIMatcher {
128
126
  return void 0;
129
127
  }
130
128
  if (!match.data.procedure) {
131
- const { default: maybeProcedure } = await unlazy(getRouterChild(match.data.router, ...match.data.path));
129
+ const { default: maybeProcedure } = await unlazy(getRouter(match.data.router, match.data.path));
132
130
  if (!isProcedure(maybeProcedure)) {
133
131
  throw new Error(`
134
- [Contract-First] Missing or invalid implementation for procedure at path: ${convertPathToHttpPath(match.data.path)}.
132
+ [Contract-First] Missing or invalid implementation for procedure at path: ${toHttpPath(match.data.path)}.
135
133
  Ensure that the procedure is correctly defined and matches the expected contract.
136
134
  `);
137
135
  }
138
- match.data.procedure = createContractedProcedure(match.data.contract, maybeProcedure);
136
+ match.data.procedure = createContractedProcedure(maybeProcedure, match.data.contract);
139
137
  }
140
138
  return {
141
139
  path: match.data.path,
@@ -145,4 +143,4 @@ class OpenAPIMatcher {
145
143
  }
146
144
  }
147
145
 
148
- export { OpenAPICodec as O, OpenAPIMatcher as a, decodeParams as d, toRou3Pattern as t };
146
+ export { StandardOpenAPICodec as S, StandardOpenAPIMatcher as a, decodeParams as d, toRou3Pattern as t };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/openapi",
3
3
  "type": "module",
4
- "version": "0.0.0-next.2546825",
4
+ "version": "0.0.0-next.25532a8",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -52,14 +52,12 @@
52
52
  "json-schema-typed": "^8.0.1",
53
53
  "openapi-types": "^12.1.3",
54
54
  "rou3": "^0.5.1",
55
- "@orpc/client": "0.0.0-next.2546825",
56
- "@orpc/contract": "0.0.0-next.2546825",
57
- "@orpc/openapi-client": "0.0.0-next.2546825",
58
- "@orpc/server": "0.0.0-next.2546825",
59
- "@orpc/shared": "0.0.0-next.2546825",
60
- "@orpc/standard-server-fetch": "0.0.0-next.2546825",
61
- "@orpc/standard-server": "0.0.0-next.2546825",
62
- "@orpc/standard-server-node": "0.0.0-next.2546825"
55
+ "@orpc/client": "0.0.0-next.25532a8",
56
+ "@orpc/server": "0.0.0-next.25532a8",
57
+ "@orpc/contract": "0.0.0-next.25532a8",
58
+ "@orpc/openapi-client": "0.0.0-next.25532a8",
59
+ "@orpc/shared": "0.0.0-next.25532a8",
60
+ "@orpc/standard-server": "0.0.0-next.25532a8"
63
61
  },
64
62
  "devDependencies": {
65
63
  "zod": "^3.24.2"
@@ -1,31 +0,0 @@
1
- import { OpenAPISerializer } from '@orpc/openapi-client/standard';
2
- import { StandardHandler } from '@orpc/server/standard';
3
- import { toStandardLazyRequest, toFetchResponse } from '@orpc/standard-server-fetch';
4
- import { a as OpenAPIMatcher, O as OpenAPICodec } from './openapi.DFXD6scT.mjs';
5
- import '@orpc/shared';
6
- import 'json-schema-typed/draft-2020-12';
7
-
8
- class OpenAPIHandler {
9
- standardHandler;
10
- constructor(router, options = {}) {
11
- const serializer = new OpenAPISerializer();
12
- const matcher = new OpenAPIMatcher();
13
- const codec = new OpenAPICodec(serializer);
14
- this.standardHandler = new StandardHandler(router, matcher, codec, options);
15
- }
16
- async handle(request, ...[
17
- options = {}
18
- ]) {
19
- const standardRequest = toStandardLazyRequest(request);
20
- const result = await this.standardHandler.handle(standardRequest, options);
21
- if (!result.matched) {
22
- return result;
23
- }
24
- return {
25
- matched: true,
26
- response: toFetchResponse(result.response, options)
27
- };
28
- }
29
- }
30
-
31
- export { OpenAPIHandler as O };
@@ -1,231 +0,0 @@
1
- import { isObject, findDeepMatches } from '@orpc/shared';
2
- import 'json-schema-typed/draft-2020-12';
3
-
4
- const LOGIC_KEYWORDS = [
5
- "$dynamicRef",
6
- "$ref",
7
- "additionalItems",
8
- "additionalProperties",
9
- "allOf",
10
- "anyOf",
11
- "const",
12
- "contains",
13
- "contentEncoding",
14
- "contentMediaType",
15
- "contentSchema",
16
- "dependencies",
17
- "dependentRequired",
18
- "dependentSchemas",
19
- "else",
20
- "enum",
21
- "exclusiveMaximum",
22
- "exclusiveMinimum",
23
- "format",
24
- "if",
25
- "items",
26
- "maxContains",
27
- "maximum",
28
- "maxItems",
29
- "maxLength",
30
- "maxProperties",
31
- "minContains",
32
- "minimum",
33
- "minItems",
34
- "minLength",
35
- "minProperties",
36
- "multipleOf",
37
- "not",
38
- "oneOf",
39
- "pattern",
40
- "patternProperties",
41
- "prefixItems",
42
- "properties",
43
- "propertyNames",
44
- "required",
45
- "then",
46
- "type",
47
- "unevaluatedItems",
48
- "unevaluatedProperties",
49
- "uniqueItems"
50
- ];
51
-
52
- function isFileSchema(schema) {
53
- return isObject(schema) && schema.type === "string" && typeof schema.contentMediaType === "string";
54
- }
55
- function isObjectSchema(schema) {
56
- return isObject(schema) && schema.type === "object";
57
- }
58
- function isAnySchema(schema) {
59
- if (schema === true) {
60
- return true;
61
- }
62
- if (Object.keys(schema).every((k) => !LOGIC_KEYWORDS.includes(k))) {
63
- return true;
64
- }
65
- return false;
66
- }
67
- function separateObjectSchema(schema, separatedProperties) {
68
- if (Object.keys(schema).some((k) => k !== "type" && k !== "properties" && k !== "required" && LOGIC_KEYWORDS.includes(k))) {
69
- return [{ type: "object" }, schema];
70
- }
71
- const matched = { ...schema };
72
- const rest = { ...schema };
73
- matched.properties = schema.properties && Object.entries(schema.properties).filter(([key]) => separatedProperties.includes(key)).reduce((acc, [key, value]) => {
74
- acc[key] = value;
75
- return acc;
76
- }, {});
77
- matched.required = schema.required?.filter((key) => separatedProperties.includes(key));
78
- matched.examples = schema.examples?.map((example) => {
79
- if (!isObject(example)) {
80
- return example;
81
- }
82
- return Object.entries(example).reduce((acc, [key, value]) => {
83
- if (separatedProperties.includes(key)) {
84
- acc[key] = value;
85
- }
86
- return acc;
87
- }, {});
88
- });
89
- rest.properties = schema.properties && Object.entries(schema.properties).filter(([key]) => !separatedProperties.includes(key)).reduce((acc, [key, value]) => {
90
- acc[key] = value;
91
- return acc;
92
- }, {});
93
- rest.required = schema.required?.filter((key) => !separatedProperties.includes(key));
94
- rest.examples = schema.examples?.map((example) => {
95
- if (!isObject(example)) {
96
- return example;
97
- }
98
- return Object.entries(example).reduce((acc, [key, value]) => {
99
- if (!separatedProperties.includes(key)) {
100
- acc[key] = value;
101
- }
102
- return acc;
103
- }, {});
104
- });
105
- return [matched, rest];
106
- }
107
- function filterSchemaBranches(schema, check, matches = []) {
108
- if (check(schema)) {
109
- matches.push(schema);
110
- return [matches, void 0];
111
- }
112
- if (isObject(schema)) {
113
- for (const keyword of ["anyOf", "oneOf"]) {
114
- if (schema[keyword] && Object.keys(schema).every(
115
- (k) => k === keyword || !LOGIC_KEYWORDS.includes(k)
116
- )) {
117
- const rest = schema[keyword].map((s) => filterSchemaBranches(s, check, matches)[1]).filter((v) => !!v);
118
- if (rest.length === 1 && typeof rest[0] === "object") {
119
- return [matches, { ...schema, [keyword]: void 0, ...rest[0] }];
120
- }
121
- return [matches, { ...schema, [keyword]: rest }];
122
- }
123
- }
124
- }
125
- return [matches, schema];
126
- }
127
-
128
- function standardizeHTTPPath(path) {
129
- return `/${path.replace(/\/{2,}/g, "/").replace(/^\/|\/$/g, "")}`;
130
- }
131
- function toOpenAPIPath(path) {
132
- return standardizeHTTPPath(path).replace(/\/\{\+([^}]+)\}/g, "/{$1}");
133
- }
134
- function toOpenAPIMethod(method) {
135
- return method.toLocaleLowerCase();
136
- }
137
- function getDynamicParams(path) {
138
- return path ? standardizeHTTPPath(path).match(/\/\{([^}]+)\}/g)?.map((v) => v.match(/\{\+?([^}]+)\}/)[1]) : void 0;
139
- }
140
- function toOpenAPIContent(schema) {
141
- const content = {};
142
- const [matches, restSchema] = filterSchemaBranches(schema, isFileSchema);
143
- for (const file of matches) {
144
- content[file.contentMediaType] = {
145
- schema: toOpenAPISchema(file)
146
- };
147
- }
148
- if (restSchema !== void 0) {
149
- content["application/json"] = {
150
- schema: toOpenAPISchema(restSchema)
151
- };
152
- const isStillHasFileSchema = findDeepMatches((v) => isObject(v) && isFileSchema(v), restSchema).values.length > 0;
153
- if (isStillHasFileSchema) {
154
- content["multipart/form-data"] = {
155
- schema: toOpenAPISchema(restSchema)
156
- };
157
- }
158
- }
159
- return content;
160
- }
161
- function toOpenAPIEventIteratorContent([yieldsRequired, yieldsSchema], [returnsRequired, returnsSchema]) {
162
- return {
163
- "text/event-stream": {
164
- schema: toOpenAPISchema({
165
- oneOf: [
166
- {
167
- type: "object",
168
- properties: {
169
- event: { const: "message" },
170
- data: yieldsSchema,
171
- id: { type: "string" },
172
- retry: { type: "number" }
173
- },
174
- required: yieldsRequired ? ["event", "data"] : ["event"]
175
- },
176
- {
177
- type: "object",
178
- properties: {
179
- event: { const: "done" },
180
- data: returnsSchema,
181
- id: { type: "string" },
182
- retry: { type: "number" }
183
- },
184
- required: returnsRequired ? ["event", "data"] : ["event"]
185
- },
186
- {
187
- type: "object",
188
- properties: {
189
- event: { const: "error" },
190
- data: {},
191
- id: { type: "string" },
192
- retry: { type: "number" }
193
- },
194
- required: ["event"]
195
- }
196
- ]
197
- })
198
- }
199
- };
200
- }
201
- function toOpenAPIParameters(schema, parameterIn) {
202
- const parameters = [];
203
- for (const key in schema.properties) {
204
- const keySchema = schema.properties[key];
205
- parameters.push({
206
- name: key,
207
- in: parameterIn,
208
- required: schema.required?.includes(key),
209
- style: parameterIn === "query" ? "deepObject" : void 0,
210
- explode: parameterIn === "query" ? true : void 0,
211
- schema: toOpenAPISchema(keySchema)
212
- });
213
- }
214
- return parameters;
215
- }
216
- function checkParamsSchema(schema, params) {
217
- const properties = Object.keys(schema.properties ?? {});
218
- const required = schema.required ?? [];
219
- if (properties.length !== params.length || properties.some((v) => !params.includes(v))) {
220
- return false;
221
- }
222
- if (required.length !== params.length || required.some((v) => !params.includes(v))) {
223
- return false;
224
- }
225
- return true;
226
- }
227
- function toOpenAPISchema(schema) {
228
- return schema === true ? {} : schema === false ? { not: {} } : schema;
229
- }
230
-
231
- export { LOGIC_KEYWORDS as L, toOpenAPIPath as a, toOpenAPIEventIteratorContent as b, isObjectSchema as c, separateObjectSchema as d, checkParamsSchema as e, toOpenAPIParameters as f, getDynamicParams as g, toOpenAPIContent as h, isAnySchema as i, toOpenAPISchema as j, isFileSchema as k, filterSchemaBranches as l, standardizeHTTPPath as s, toOpenAPIMethod as t };