@orpc/openapi 0.0.0-next.6d75718 → 0.0.0-next.6f0af5e
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 +1 -0
- package/dist/adapters/fetch/index.d.mts +1 -1
- package/dist/adapters/fetch/index.d.ts +1 -1
- package/dist/adapters/fetch/index.mjs +13 -7
- package/dist/adapters/node/index.d.mts +1 -1
- package/dist/adapters/node/index.d.ts +1 -1
- package/dist/adapters/node/index.mjs +6 -12
- package/dist/adapters/standard/index.d.mts +2 -3
- package/dist/adapters/standard/index.d.ts +2 -3
- package/dist/adapters/standard/index.mjs +4 -3
- package/dist/index.d.mts +9 -13
- package/dist/index.d.ts +9 -13
- package/dist/index.mjs +264 -27
- package/dist/shared/openapi.D3j94c9n.d.mts +12 -0
- package/dist/shared/openapi.D3j94c9n.d.ts +12 -0
- package/dist/shared/{openapi.BNHmrMe2.mjs → openapi.p5tsmBXx.mjs} +17 -4
- package/package.json +7 -17
- package/dist/adapters/hono/index.d.mts +0 -6
- package/dist/adapters/hono/index.d.ts +0 -6
- package/dist/adapters/hono/index.mjs +0 -11
- package/dist/adapters/next/index.d.mts +0 -6
- package/dist/adapters/next/index.d.ts +0 -6
- package/dist/adapters/next/index.mjs +0 -11
- package/dist/shared/openapi.DZzpQAb-.mjs +0 -231
- package/dist/shared/openapi.G9ZZkQ6q.mjs +0 -19
- package/dist/shared/openapi.IfmmOyba.d.mts +0 -8
- package/dist/shared/openapi.IfmmOyba.d.ts +0 -8
package/README.md
CHANGED
|
@@ -53,6 +53,7 @@ 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).
|
|
58
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).
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
2
|
import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
|
|
3
|
-
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.
|
|
3
|
+
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
|
|
4
4
|
import '@orpc/openapi-client/standard';
|
|
5
5
|
import '@orpc/server/standard';
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
2
|
import { FetchHandler, FetchHandlerOptions } from '@orpc/server/fetch';
|
|
3
|
-
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.
|
|
3
|
+
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
|
|
4
4
|
import '@orpc/openapi-client/standard';
|
|
5
5
|
import '@orpc/server/standard';
|
|
6
6
|
|
|
@@ -1,11 +1,17 @@
|
|
|
1
|
-
|
|
2
|
-
import '@orpc/openapi-client/standard';
|
|
3
|
-
import '@orpc/server/fetch';
|
|
4
|
-
import '@orpc/server/standard';
|
|
5
|
-
import '../../shared/openapi.BNHmrMe2.mjs';
|
|
1
|
+
import { FetchHandler } from '@orpc/server/fetch';
|
|
6
2
|
import '@orpc/contract';
|
|
7
3
|
import '@orpc/shared';
|
|
4
|
+
import { a as StandardOpenAPIHandler } from '../../shared/openapi.p5tsmBXx.mjs';
|
|
5
|
+
import '@orpc/client/standard';
|
|
8
6
|
import '@orpc/server';
|
|
9
7
|
import 'rou3';
|
|
10
|
-
import '
|
|
11
|
-
import '
|
|
8
|
+
import '@orpc/openapi-client/standard';
|
|
9
|
+
import '@orpc/server/standard';
|
|
10
|
+
|
|
11
|
+
class OpenAPIHandler extends FetchHandler {
|
|
12
|
+
constructor(router, options = {}) {
|
|
13
|
+
super(new StandardOpenAPIHandler(router, options), options);
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
export { OpenAPIHandler };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
2
|
import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
|
|
3
|
-
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.
|
|
3
|
+
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
|
|
4
4
|
import '@orpc/openapi-client/standard';
|
|
5
5
|
import '@orpc/server/standard';
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Context, Router } from '@orpc/server';
|
|
2
2
|
import { NodeHttpHandler, NodeHttpHandlerOptions } from '@orpc/server/node';
|
|
3
|
-
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.
|
|
3
|
+
import { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
|
|
4
4
|
import '@orpc/openapi-client/standard';
|
|
5
5
|
import '@orpc/server/standard';
|
|
6
6
|
|
|
@@ -1,22 +1,16 @@
|
|
|
1
|
-
import { StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer, StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
|
|
2
1
|
import { NodeHttpHandler } from '@orpc/server/node';
|
|
3
|
-
import { StandardHandler } from '@orpc/server/standard';
|
|
4
|
-
import { a as StandardOpenAPIMatcher, S as StandardOpenAPICodec } from '../../shared/openapi.BNHmrMe2.mjs';
|
|
5
|
-
import '@orpc/shared';
|
|
6
|
-
import 'json-schema-typed/draft-2020-12';
|
|
7
2
|
import '@orpc/contract';
|
|
3
|
+
import '@orpc/shared';
|
|
4
|
+
import { a as StandardOpenAPIHandler } from '../../shared/openapi.p5tsmBXx.mjs';
|
|
5
|
+
import '@orpc/client/standard';
|
|
8
6
|
import '@orpc/server';
|
|
9
7
|
import 'rou3';
|
|
10
|
-
import '
|
|
8
|
+
import '@orpc/openapi-client/standard';
|
|
9
|
+
import '@orpc/server/standard';
|
|
11
10
|
|
|
12
11
|
class OpenAPIHandler extends NodeHttpHandler {
|
|
13
12
|
constructor(router, options = {}) {
|
|
14
|
-
|
|
15
|
-
const bracketNotationSerializer = new StandardBracketNotationSerializer();
|
|
16
|
-
const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
|
|
17
|
-
const matcher = new StandardOpenAPIMatcher();
|
|
18
|
-
const codec = new StandardOpenAPICodec(serializer);
|
|
19
|
-
super(new StandardHandler(router, matcher, codec, options), options);
|
|
13
|
+
super(new StandardOpenAPIHandler(router, options), options);
|
|
20
14
|
}
|
|
21
15
|
}
|
|
22
16
|
|
|
@@ -1,10 +1,9 @@
|
|
|
1
|
-
import { ORPCError } from '@orpc/client';
|
|
1
|
+
import { ORPCError, HTTPPath } from '@orpc/client';
|
|
2
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
|
-
export { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.
|
|
7
|
-
import { HTTPPath } from '@orpc/contract';
|
|
6
|
+
export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.mjs';
|
|
8
7
|
|
|
9
8
|
declare class StandardOpenAPICodec implements StandardCodec {
|
|
10
9
|
private readonly serializer;
|
|
@@ -1,10 +1,9 @@
|
|
|
1
|
-
import { ORPCError } from '@orpc/client';
|
|
1
|
+
import { ORPCError, HTTPPath } from '@orpc/client';
|
|
2
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
|
-
export { S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.
|
|
7
|
-
import { HTTPPath } from '@orpc/contract';
|
|
6
|
+
export { a as StandardOpenAPIHandler, S as StandardOpenAPIHandlerOptions } from '../../shared/openapi.D3j94c9n.js';
|
|
8
7
|
|
|
9
8
|
declare class StandardOpenAPICodec implements StandardCodec {
|
|
10
9
|
private readonly serializer;
|
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
export { S as StandardOpenAPICodec, a as StandardOpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.
|
|
1
|
+
export { S as StandardOpenAPICodec, a as StandardOpenAPIHandler, b as StandardOpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.p5tsmBXx.mjs';
|
|
2
|
+
import '@orpc/openapi-client/standard';
|
|
3
|
+
import '@orpc/server/standard';
|
|
2
4
|
import '@orpc/contract';
|
|
3
5
|
import '@orpc/shared';
|
|
6
|
+
import '@orpc/client/standard';
|
|
4
7
|
import '@orpc/server';
|
|
5
8
|
import 'rou3';
|
|
6
|
-
import '../../shared/openapi.DZzpQAb-.mjs';
|
|
7
|
-
import 'json-schema-typed/draft-2020-12';
|
package/dist/index.d.mts
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
|
-
import { AnyContractProcedure, AnySchema, AnyContractRouter
|
|
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
4
|
import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
|
|
5
5
|
import { AnyRouter } from '@orpc/server';
|
|
6
|
+
import { Promisable } from '@orpc/shared';
|
|
6
7
|
import { JSONSchema } from 'json-schema-typed/draft-2020-12';
|
|
7
8
|
export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
|
|
9
|
+
import { HTTPPath, HTTPMethod } from '@orpc/client';
|
|
8
10
|
|
|
9
11
|
type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
|
|
10
12
|
declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
|
|
@@ -33,15 +35,15 @@ interface SchemaConvertOptions {
|
|
|
33
35
|
strategy: 'input' | 'output';
|
|
34
36
|
}
|
|
35
37
|
interface SchemaConverter {
|
|
36
|
-
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema]
|
|
38
|
+
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
|
|
37
39
|
}
|
|
38
40
|
interface ConditionalSchemaConverter extends SchemaConverter {
|
|
39
|
-
condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean
|
|
41
|
+
condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
|
|
40
42
|
}
|
|
41
43
|
declare class CompositeSchemaConverter implements SchemaConverter {
|
|
42
44
|
private readonly converters;
|
|
43
45
|
constructor(converters: ConditionalSchemaConverter[]);
|
|
44
|
-
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema]
|
|
46
|
+
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
|
|
45
47
|
}
|
|
46
48
|
|
|
47
49
|
interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
|
|
@@ -55,10 +57,6 @@ declare class OpenAPIGenerator {
|
|
|
55
57
|
generate(router: AnyContractRouter | AnyRouter, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
|
|
56
58
|
}
|
|
57
59
|
|
|
58
|
-
/**
|
|
59
|
-
* @internal
|
|
60
|
-
*/
|
|
61
|
-
declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
|
|
62
60
|
/**
|
|
63
61
|
* @internal
|
|
64
62
|
*/
|
|
@@ -67,10 +65,6 @@ declare function toOpenAPIPath(path: HTTPPath): string;
|
|
|
67
65
|
* @internal
|
|
68
66
|
*/
|
|
69
67
|
declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
|
|
70
|
-
/**
|
|
71
|
-
* @internal
|
|
72
|
-
*/
|
|
73
|
-
declare function getDynamicParams(path: HTTPPath | undefined): string[] | undefined;
|
|
74
68
|
/**
|
|
75
69
|
* @internal
|
|
76
70
|
*/
|
|
@@ -112,9 +106,11 @@ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties:
|
|
|
112
106
|
* @internal
|
|
113
107
|
*/
|
|
114
108
|
declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
|
|
109
|
+
declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
|
|
115
110
|
|
|
116
111
|
declare const oo: {
|
|
117
112
|
spec: typeof customOpenAPIOperation;
|
|
118
113
|
};
|
|
119
114
|
|
|
120
|
-
export { CompositeSchemaConverter,
|
|
115
|
+
export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
|
|
116
|
+
export type { ConditionalSchemaConverter, FileSchema, ObjectSchema, OpenAPIGeneratorOptions, OverrideOperationValue, SchemaConvertOptions, SchemaConverter };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
|
-
import { AnyContractProcedure, AnySchema, AnyContractRouter
|
|
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
4
|
import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
|
|
5
5
|
import { AnyRouter } from '@orpc/server';
|
|
6
|
+
import { Promisable } from '@orpc/shared';
|
|
6
7
|
import { JSONSchema } from 'json-schema-typed/draft-2020-12';
|
|
7
8
|
export { JSONSchema, Format as JSONSchemaFormat } from 'json-schema-typed/draft-2020-12';
|
|
9
|
+
import { HTTPPath, HTTPMethod } from '@orpc/client';
|
|
8
10
|
|
|
9
11
|
type OverrideOperationValue = Partial<OpenAPIV3_1.OperationObject> | ((current: OpenAPIV3_1.OperationObject, procedure: AnyContractProcedure) => OpenAPIV3_1.OperationObject);
|
|
10
12
|
declare function customOpenAPIOperation<T extends object>(o: T, extend: OverrideOperationValue): T;
|
|
@@ -33,15 +35,15 @@ interface SchemaConvertOptions {
|
|
|
33
35
|
strategy: 'input' | 'output';
|
|
34
36
|
}
|
|
35
37
|
interface SchemaConverter {
|
|
36
|
-
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema]
|
|
38
|
+
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
|
|
37
39
|
}
|
|
38
40
|
interface ConditionalSchemaConverter extends SchemaConverter {
|
|
39
|
-
condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean
|
|
41
|
+
condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
|
|
40
42
|
}
|
|
41
43
|
declare class CompositeSchemaConverter implements SchemaConverter {
|
|
42
44
|
private readonly converters;
|
|
43
45
|
constructor(converters: ConditionalSchemaConverter[]);
|
|
44
|
-
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema]
|
|
46
|
+
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
|
|
45
47
|
}
|
|
46
48
|
|
|
47
49
|
interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
|
|
@@ -55,10 +57,6 @@ declare class OpenAPIGenerator {
|
|
|
55
57
|
generate(router: AnyContractRouter | AnyRouter, base: Omit<OpenAPIV3_1.Document, 'openapi'>): Promise<OpenAPIV3_1.Document>;
|
|
56
58
|
}
|
|
57
59
|
|
|
58
|
-
/**
|
|
59
|
-
* @internal
|
|
60
|
-
*/
|
|
61
|
-
declare function standardizeHTTPPath(path: HTTPPath): HTTPPath;
|
|
62
60
|
/**
|
|
63
61
|
* @internal
|
|
64
62
|
*/
|
|
@@ -67,10 +65,6 @@ declare function toOpenAPIPath(path: HTTPPath): string;
|
|
|
67
65
|
* @internal
|
|
68
66
|
*/
|
|
69
67
|
declare function toOpenAPIMethod(method: HTTPMethod): Lowercase<HTTPMethod>;
|
|
70
|
-
/**
|
|
71
|
-
* @internal
|
|
72
|
-
*/
|
|
73
|
-
declare function getDynamicParams(path: HTTPPath | undefined): string[] | undefined;
|
|
74
68
|
/**
|
|
75
69
|
* @internal
|
|
76
70
|
*/
|
|
@@ -112,9 +106,11 @@ declare function separateObjectSchema(schema: ObjectSchema, separatedProperties:
|
|
|
112
106
|
* @internal
|
|
113
107
|
*/
|
|
114
108
|
declare function filterSchemaBranches(schema: JSONSchema, check: (schema: JSONSchema) => boolean, matches?: JSONSchema[]): [matches: JSONSchema[], rest: JSONSchema | undefined];
|
|
109
|
+
declare function applySchemaOptionality(required: boolean, schema: JSONSchema): JSONSchema;
|
|
115
110
|
|
|
116
111
|
declare const oo: {
|
|
117
112
|
spec: typeof customOpenAPIOperation;
|
|
118
113
|
};
|
|
119
114
|
|
|
120
|
-
export { CompositeSchemaConverter,
|
|
115
|
+
export { CompositeSchemaConverter, LOGIC_KEYWORDS, OpenAPIGenerator, applyCustomOpenAPIOperation, applySchemaOptionality, checkParamsSchema, customOpenAPIOperation, filterSchemaBranches, getCustomOpenAPIOperation, isAnySchema, isFileSchema, isObjectSchema, oo, separateObjectSchema, toOpenAPIContent, toOpenAPIEventIteratorContent, toOpenAPIMethod, toOpenAPIParameters, toOpenAPIPath, toOpenAPISchema };
|
|
116
|
+
export type { ConditionalSchemaConverter, FileSchema, ObjectSchema, OpenAPIGeneratorOptions, OverrideOperationValue, SchemaConvertOptions, SchemaConverter };
|
package/dist/index.mjs
CHANGED
|
@@ -1,10 +1,9 @@
|
|
|
1
|
-
import { isProcedure, resolveContractProcedures
|
|
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 { StandardOpenAPIJsonSerializer } 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,14 +50,246 @@ 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) {
|
|
57
288
|
this.converters = converters;
|
|
58
289
|
}
|
|
59
|
-
convert(schema, options) {
|
|
290
|
+
async convert(schema, options) {
|
|
60
291
|
for (const converter of this.converters) {
|
|
61
|
-
if (converter.condition(schema, options)) {
|
|
292
|
+
if (await converter.condition(schema, options)) {
|
|
62
293
|
return converter.convert(schema, options);
|
|
63
294
|
}
|
|
64
295
|
}
|
|
@@ -73,13 +304,17 @@ class OpenAPIGenerator {
|
|
|
73
304
|
converter;
|
|
74
305
|
constructor(options = {}) {
|
|
75
306
|
this.serializer = new StandardOpenAPIJsonSerializer(options);
|
|
76
|
-
this.converter = new CompositeSchemaConverter(options.schemaConverters
|
|
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
|
-
const
|
|
312
|
+
const contracts = [];
|
|
82
313
|
await resolveContractProcedures({ path: [], router }, ({ contract, path }) => {
|
|
314
|
+
contracts.push({ contract, path });
|
|
315
|
+
});
|
|
316
|
+
const errors = [];
|
|
317
|
+
for (const { contract, path } of contracts) {
|
|
83
318
|
const operationId = path.join(".");
|
|
84
319
|
try {
|
|
85
320
|
const def = contract["~orpc"];
|
|
@@ -92,9 +327,9 @@ class OpenAPIGenerator {
|
|
|
92
327
|
deprecated: def.route.deprecated,
|
|
93
328
|
tags: def.route.tags?.map((tag) => tag)
|
|
94
329
|
};
|
|
95
|
-
this.#request(operationObjectRef, def);
|
|
96
|
-
this.#successResponse(operationObjectRef, def);
|
|
97
|
-
this.#errorResponse(operationObjectRef, def);
|
|
330
|
+
await this.#request(operationObjectRef, def);
|
|
331
|
+
await this.#successResponse(operationObjectRef, def);
|
|
332
|
+
await this.#errorResponse(operationObjectRef, def);
|
|
98
333
|
doc.paths ??= {};
|
|
99
334
|
doc.paths[httpPath] ??= {};
|
|
100
335
|
doc.paths[httpPath][method] = applyCustomOpenAPIOperation(operationObjectRef, contract);
|
|
@@ -107,7 +342,7 @@ class OpenAPIGenerator {
|
|
|
107
342
|
${e.message}`
|
|
108
343
|
);
|
|
109
344
|
}
|
|
110
|
-
}
|
|
345
|
+
}
|
|
111
346
|
if (errors.length) {
|
|
112
347
|
throw new OpenAPIGeneratorError(
|
|
113
348
|
`Some error occurred during OpenAPI generation:
|
|
@@ -117,22 +352,22 @@ ${errors.join("\n\n")}`
|
|
|
117
352
|
}
|
|
118
353
|
return this.serializer.serialize(doc)[0];
|
|
119
354
|
}
|
|
120
|
-
#request(ref, def) {
|
|
355
|
+
async #request(ref, def) {
|
|
121
356
|
const method = fallbackContractConfig("defaultMethod", def.route.method);
|
|
122
357
|
const details = getEventIteratorSchemaDetails(def.inputSchema);
|
|
123
358
|
if (details) {
|
|
124
359
|
ref.requestBody = {
|
|
125
360
|
required: true,
|
|
126
361
|
content: toOpenAPIEventIteratorContent(
|
|
127
|
-
this.converter.convert(details.yields, { strategy: "input" }),
|
|
128
|
-
this.converter.convert(details.returns, { strategy: "input" })
|
|
362
|
+
await this.converter.convert(details.yields, { strategy: "input" }),
|
|
363
|
+
await this.converter.convert(details.returns, { strategy: "input" })
|
|
129
364
|
)
|
|
130
365
|
};
|
|
131
366
|
return;
|
|
132
367
|
}
|
|
133
|
-
const dynamicParams = getDynamicParams(def.route.path);
|
|
368
|
+
const dynamicParams = getDynamicParams(def.route.path)?.map((v) => v.name);
|
|
134
369
|
const inputStructure = fallbackContractConfig("defaultInputStructure", def.route.inputStructure);
|
|
135
|
-
let [required, schema] = this.converter.convert(def.inputSchema, { strategy: "input" });
|
|
370
|
+
let [required, schema] = await this.converter.convert(def.inputSchema, { strategy: "input" });
|
|
136
371
|
if (isAnySchema(schema) && !dynamicParams?.length) {
|
|
137
372
|
return;
|
|
138
373
|
}
|
|
@@ -198,7 +433,7 @@ ${errors.join("\n\n")}`
|
|
|
198
433
|
};
|
|
199
434
|
}
|
|
200
435
|
}
|
|
201
|
-
#successResponse(ref, def) {
|
|
436
|
+
async #successResponse(ref, def) {
|
|
202
437
|
const outputSchema = def.outputSchema;
|
|
203
438
|
const status = fallbackContractConfig("defaultSuccessStatus", def.route.successStatus);
|
|
204
439
|
const description = fallbackContractConfig("defaultSuccessDescription", def.route?.successDescription);
|
|
@@ -209,19 +444,19 @@ ${errors.join("\n\n")}`
|
|
|
209
444
|
ref.responses[status] = {
|
|
210
445
|
description,
|
|
211
446
|
content: toOpenAPIEventIteratorContent(
|
|
212
|
-
this.converter.convert(eventIteratorSchemaDetails.yields, { strategy: "output" }),
|
|
213
|
-
this.converter.convert(eventIteratorSchemaDetails.returns, { strategy: "output" })
|
|
447
|
+
await this.converter.convert(eventIteratorSchemaDetails.yields, { strategy: "output" }),
|
|
448
|
+
await this.converter.convert(eventIteratorSchemaDetails.returns, { strategy: "output" })
|
|
214
449
|
)
|
|
215
450
|
};
|
|
216
451
|
return;
|
|
217
452
|
}
|
|
218
|
-
const [
|
|
453
|
+
const [required, json] = await this.converter.convert(outputSchema, { strategy: "output" });
|
|
219
454
|
ref.responses ??= {};
|
|
220
455
|
ref.responses[status] = {
|
|
221
456
|
description
|
|
222
457
|
};
|
|
223
458
|
if (outputStructure === "compact") {
|
|
224
|
-
ref.responses[status].content = toOpenAPIContent(json);
|
|
459
|
+
ref.responses[status].content = toOpenAPIContent(applySchemaOptionality(required, json));
|
|
225
460
|
return;
|
|
226
461
|
}
|
|
227
462
|
const error = new OpenAPIGeneratorError(
|
|
@@ -243,10 +478,12 @@ ${errors.join("\n\n")}`
|
|
|
243
478
|
}
|
|
244
479
|
}
|
|
245
480
|
if (json.properties?.body !== void 0) {
|
|
246
|
-
ref.responses[status].content = toOpenAPIContent(
|
|
481
|
+
ref.responses[status].content = toOpenAPIContent(
|
|
482
|
+
applySchemaOptionality(json.required?.includes("body") ?? false, json.properties.body)
|
|
483
|
+
);
|
|
247
484
|
}
|
|
248
485
|
}
|
|
249
|
-
#errorResponse(ref, def) {
|
|
486
|
+
async #errorResponse(ref, def) {
|
|
250
487
|
const errorMap = def.errorMap;
|
|
251
488
|
const errors = {};
|
|
252
489
|
for (const code in errorMap) {
|
|
@@ -256,7 +493,7 @@ ${errors.join("\n\n")}`
|
|
|
256
493
|
}
|
|
257
494
|
const status = fallbackORPCErrorStatus(code, config.status);
|
|
258
495
|
const message = fallbackORPCErrorMessage(code, config.message);
|
|
259
|
-
const [dataRequired, dataSchema] = this.converter.convert(config.data, { strategy: "output" });
|
|
496
|
+
const [dataRequired, dataSchema] = await this.converter.convert(config.data, { strategy: "output" });
|
|
260
497
|
errors[status] ??= [];
|
|
261
498
|
errors[status].push({
|
|
262
499
|
type: "object",
|
|
@@ -300,4 +537,4 @@ const oo = {
|
|
|
300
537
|
spec: customOpenAPIOperation
|
|
301
538
|
};
|
|
302
539
|
|
|
303
|
-
export { CompositeSchemaConverter, OpenAPIGenerator, applyCustomOpenAPIOperation, checkParamsSchema, customOpenAPIOperation,
|
|
540
|
+
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,12 @@
|
|
|
1
|
+
import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
|
|
2
|
+
import { Context, Router } from '@orpc/server';
|
|
3
|
+
import { StandardHandlerOptions, StandardHandler } from '@orpc/server/standard';
|
|
4
|
+
|
|
5
|
+
interface StandardOpenAPIHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardOpenAPIJsonSerializerOptions {
|
|
6
|
+
}
|
|
7
|
+
declare class StandardOpenAPIHandler<T extends Context> extends StandardHandler<T> {
|
|
8
|
+
constructor(router: Router<any, T>, options: NoInfer<StandardOpenAPIHandlerOptions<T>>);
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
export { StandardOpenAPIHandler as a };
|
|
12
|
+
export type { StandardOpenAPIHandlerOptions as S };
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
|
|
2
|
+
import { Context, Router } from '@orpc/server';
|
|
3
|
+
import { StandardHandlerOptions, StandardHandler } from '@orpc/server/standard';
|
|
4
|
+
|
|
5
|
+
interface StandardOpenAPIHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, StandardOpenAPIJsonSerializerOptions {
|
|
6
|
+
}
|
|
7
|
+
declare class StandardOpenAPIHandler<T extends Context> extends StandardHandler<T> {
|
|
8
|
+
constructor(router: Router<any, T>, options: NoInfer<StandardOpenAPIHandlerOptions<T>>);
|
|
9
|
+
}
|
|
10
|
+
|
|
11
|
+
export { StandardOpenAPIHandler as a };
|
|
12
|
+
export type { StandardOpenAPIHandlerOptions as S };
|
|
@@ -1,8 +1,10 @@
|
|
|
1
|
+
import { standardizeHTTPPath, StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer, StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
|
|
2
|
+
import { StandardHandler } from '@orpc/server/standard';
|
|
1
3
|
import { fallbackContractConfig } from '@orpc/contract';
|
|
2
4
|
import { isObject } from '@orpc/shared';
|
|
3
|
-
import {
|
|
5
|
+
import { toHttpPath } from '@orpc/client/standard';
|
|
6
|
+
import { traverseContractProcedures, isProcedure, getLazyMeta, unlazy, getRouter, createContractedProcedure } from '@orpc/server';
|
|
4
7
|
import { createRouter, addRoute, findRoute } from 'rou3';
|
|
5
|
-
import { s as standardizeHTTPPath } from './openapi.DZzpQAb-.mjs';
|
|
6
8
|
|
|
7
9
|
class StandardOpenAPICodec {
|
|
8
10
|
constructor(serializer) {
|
|
@@ -65,7 +67,7 @@ class StandardOpenAPICodec {
|
|
|
65
67
|
return {
|
|
66
68
|
status: error.status,
|
|
67
69
|
headers: {},
|
|
68
|
-
body: this.serializer.serialize(error.toJSON())
|
|
70
|
+
body: this.serializer.serialize(error.toJSON(), { outputFormat: "plain" })
|
|
69
71
|
};
|
|
70
72
|
}
|
|
71
73
|
}
|
|
@@ -142,4 +144,15 @@ class StandardOpenAPIMatcher {
|
|
|
142
144
|
}
|
|
143
145
|
}
|
|
144
146
|
|
|
145
|
-
|
|
147
|
+
class StandardOpenAPIHandler extends StandardHandler {
|
|
148
|
+
constructor(router, options) {
|
|
149
|
+
const jsonSerializer = new StandardOpenAPIJsonSerializer(options);
|
|
150
|
+
const bracketNotationSerializer = new StandardBracketNotationSerializer();
|
|
151
|
+
const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
|
|
152
|
+
const matcher = new StandardOpenAPIMatcher();
|
|
153
|
+
const codec = new StandardOpenAPICodec(serializer);
|
|
154
|
+
super(router, matcher, codec, options);
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
export { StandardOpenAPICodec as S, StandardOpenAPIHandler as a, StandardOpenAPIMatcher as b, 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.
|
|
4
|
+
"version": "0.0.0-next.6f0af5e",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
|
7
7
|
"repository": {
|
|
@@ -29,16 +29,6 @@
|
|
|
29
29
|
"import": "./dist/adapters/fetch/index.mjs",
|
|
30
30
|
"default": "./dist/adapters/fetch/index.mjs"
|
|
31
31
|
},
|
|
32
|
-
"./hono": {
|
|
33
|
-
"types": "./dist/adapters/hono/index.d.mts",
|
|
34
|
-
"import": "./dist/adapters/hono/index.mjs",
|
|
35
|
-
"default": "./dist/adapters/hono/index.mjs"
|
|
36
|
-
},
|
|
37
|
-
"./next": {
|
|
38
|
-
"types": "./dist/adapters/next/index.d.mts",
|
|
39
|
-
"import": "./dist/adapters/next/index.mjs",
|
|
40
|
-
"default": "./dist/adapters/next/index.mjs"
|
|
41
|
-
},
|
|
42
32
|
"./node": {
|
|
43
33
|
"types": "./dist/adapters/node/index.d.mts",
|
|
44
34
|
"import": "./dist/adapters/node/index.mjs",
|
|
@@ -52,12 +42,12 @@
|
|
|
52
42
|
"json-schema-typed": "^8.0.1",
|
|
53
43
|
"openapi-types": "^12.1.3",
|
|
54
44
|
"rou3": "^0.5.1",
|
|
55
|
-
"@orpc/client": "0.0.0-next.
|
|
56
|
-
"@orpc/contract": "0.0.0-next.
|
|
57
|
-
"@orpc/openapi-client": "0.0.0-next.
|
|
58
|
-
"@orpc/
|
|
59
|
-
"@orpc/
|
|
60
|
-
"@orpc/server": "0.0.0-next.
|
|
45
|
+
"@orpc/client": "0.0.0-next.6f0af5e",
|
|
46
|
+
"@orpc/contract": "0.0.0-next.6f0af5e",
|
|
47
|
+
"@orpc/openapi-client": "0.0.0-next.6f0af5e",
|
|
48
|
+
"@orpc/server": "0.0.0-next.6f0af5e",
|
|
49
|
+
"@orpc/shared": "0.0.0-next.6f0af5e",
|
|
50
|
+
"@orpc/standard-server": "0.0.0-next.6f0af5e"
|
|
61
51
|
},
|
|
62
52
|
"devDependencies": {
|
|
63
53
|
"zod": "^3.24.2"
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
export { O as OpenAPIHandler } from '../../shared/openapi.G9ZZkQ6q.mjs';
|
|
2
|
-
import '@orpc/openapi-client/standard';
|
|
3
|
-
import '@orpc/server/fetch';
|
|
4
|
-
import '@orpc/server/standard';
|
|
5
|
-
import '../../shared/openapi.BNHmrMe2.mjs';
|
|
6
|
-
import '@orpc/contract';
|
|
7
|
-
import '@orpc/shared';
|
|
8
|
-
import '@orpc/server';
|
|
9
|
-
import 'rou3';
|
|
10
|
-
import '../../shared/openapi.DZzpQAb-.mjs';
|
|
11
|
-
import 'json-schema-typed/draft-2020-12';
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
export { O as OpenAPIHandler } from '../../shared/openapi.G9ZZkQ6q.mjs';
|
|
2
|
-
import '@orpc/openapi-client/standard';
|
|
3
|
-
import '@orpc/server/fetch';
|
|
4
|
-
import '@orpc/server/standard';
|
|
5
|
-
import '../../shared/openapi.BNHmrMe2.mjs';
|
|
6
|
-
import '@orpc/contract';
|
|
7
|
-
import '@orpc/shared';
|
|
8
|
-
import '@orpc/server';
|
|
9
|
-
import 'rou3';
|
|
10
|
-
import '../../shared/openapi.DZzpQAb-.mjs';
|
|
11
|
-
import 'json-schema-typed/draft-2020-12';
|
|
@@ -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 };
|
|
@@ -1,19 +0,0 @@
|
|
|
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.BNHmrMe2.mjs';
|
|
5
|
-
import '@orpc/shared';
|
|
6
|
-
import 'json-schema-typed/draft-2020-12';
|
|
7
|
-
|
|
8
|
-
class OpenAPIHandler extends FetchHandler {
|
|
9
|
-
constructor(router, options = {}) {
|
|
10
|
-
const jsonSerializer = new StandardOpenAPIJsonSerializer(options);
|
|
11
|
-
const bracketNotationSerializer = new StandardBracketNotationSerializer();
|
|
12
|
-
const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
|
|
13
|
-
const matcher = new StandardOpenAPIMatcher();
|
|
14
|
-
const codec = new StandardOpenAPICodec(serializer);
|
|
15
|
-
super(new StandardHandler(router, matcher, codec, options), options);
|
|
16
|
-
}
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
export { OpenAPIHandler as O };
|
|
@@ -1,8 +0,0 @@
|
|
|
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,8 +0,0 @@
|
|
|
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 };
|