@orpc/openapi 0.0.0-next.e7ee5a9 → 0.0.0-next.e8524dc
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 +28 -20
- package/dist/adapters/aws-lambda/index.d.mts +17 -0
- package/dist/adapters/aws-lambda/index.d.ts +17 -0
- package/dist/adapters/aws-lambda/index.mjs +18 -0
- package/dist/adapters/fetch/index.d.mts +12 -9
- package/dist/adapters/fetch/index.d.ts +12 -9
- package/dist/adapters/fetch/index.mjs +14 -6
- package/dist/adapters/node/index.d.mts +12 -9
- package/dist/adapters/node/index.d.ts +12 -9
- package/dist/adapters/node/index.mjs +9 -20
- package/dist/adapters/standard/index.d.mts +22 -11
- package/dist/adapters/standard/index.d.ts +22 -11
- package/dist/adapters/standard/index.mjs +5 -3
- package/dist/index.d.mts +96 -155
- package/dist/index.d.ts +96 -155
- package/dist/index.mjs +34 -654
- package/dist/plugins/index.d.mts +69 -0
- package/dist/plugins/index.d.ts +69 -0
- package/dist/plugins/index.mjs +108 -0
- package/dist/shared/openapi.B3hexduL.d.mts +101 -0
- package/dist/shared/openapi.B3hexduL.d.ts +101 -0
- package/dist/shared/{openapi.CDsfPHgw.mjs → openapi.C_UtQ8Us.mjs} +61 -30
- package/dist/shared/openapi.D3j94c9n.d.mts +12 -0
- package/dist/shared/openapi.D3j94c9n.d.ts +12 -0
- package/dist/shared/openapi.DrrBsJ0w.mjs +738 -0
- package/package.json +19 -22
- package/dist/adapters/hono/index.d.mts +0 -7
- package/dist/adapters/hono/index.d.ts +0 -7
- package/dist/adapters/hono/index.mjs +0 -10
- package/dist/adapters/next/index.d.mts +0 -7
- package/dist/adapters/next/index.d.ts +0 -7
- package/dist/adapters/next/index.mjs +0 -10
- package/dist/shared/openapi.BHG_gu5Z.mjs +0 -8
- package/dist/shared/openapi.D0VMNR6V.mjs +0 -25
- package/dist/shared/openapi.Dz_6xooR.d.mts +0 -7
- package/dist/shared/openapi.Dz_6xooR.d.ts +0 -7
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
import { OpenAPI } from '@orpc/contract';
|
|
2
|
+
import { Context, HTTPPath, Router } from '@orpc/server';
|
|
3
|
+
import { StandardHandlerInterceptorOptions, StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
|
|
4
|
+
import { Value, Promisable } from '@orpc/shared';
|
|
5
|
+
import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.B3hexduL.mjs';
|
|
6
|
+
import '@orpc/openapi-client/standard';
|
|
7
|
+
import 'json-schema-typed/draft-2020-12';
|
|
8
|
+
|
|
9
|
+
interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGeneratorOptions {
|
|
10
|
+
/**
|
|
11
|
+
* Options to pass to the OpenAPI generate.
|
|
12
|
+
*
|
|
13
|
+
*/
|
|
14
|
+
specGenerateOptions?: Value<Promisable<OpenAPIGeneratorGenerateOptions>, [StandardHandlerInterceptorOptions<T>]>;
|
|
15
|
+
/**
|
|
16
|
+
* The URL path at which to serve the OpenAPI JSON.
|
|
17
|
+
*
|
|
18
|
+
* @default '/spec.json'
|
|
19
|
+
*/
|
|
20
|
+
specPath?: HTTPPath;
|
|
21
|
+
/**
|
|
22
|
+
* The URL path at which to serve the API reference UI.
|
|
23
|
+
*
|
|
24
|
+
* @default '/'
|
|
25
|
+
*/
|
|
26
|
+
docsPath?: HTTPPath;
|
|
27
|
+
/**
|
|
28
|
+
* The document title for the API reference UI.
|
|
29
|
+
*
|
|
30
|
+
* @default 'API Reference'
|
|
31
|
+
*/
|
|
32
|
+
docsTitle?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
|
|
33
|
+
/**
|
|
34
|
+
* Arbitrary configuration object for the UI.
|
|
35
|
+
*/
|
|
36
|
+
docsConfig?: Value<Promisable<Record<string, unknown>>, [StandardHandlerInterceptorOptions<T>]>;
|
|
37
|
+
/**
|
|
38
|
+
* HTML to inject into the <head> of the docs page.
|
|
39
|
+
*
|
|
40
|
+
* @default ''
|
|
41
|
+
*/
|
|
42
|
+
docsHead?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
|
|
43
|
+
/**
|
|
44
|
+
* URL of the external script bundle for the reference UI.
|
|
45
|
+
*
|
|
46
|
+
* @default 'https://cdn.jsdelivr.net/npm/@scalar/api-reference'
|
|
47
|
+
*/
|
|
48
|
+
docsScriptUrl?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
|
|
49
|
+
/**
|
|
50
|
+
* Override function to generate the full HTML for the docs page.
|
|
51
|
+
*/
|
|
52
|
+
renderDocsHtml?: (specUrl: string, title: string, head: string, scriptUrl: string, config: Record<string, unknown> | undefined, spec: OpenAPI.Document) => string;
|
|
53
|
+
}
|
|
54
|
+
declare class OpenAPIReferencePlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
|
55
|
+
private readonly generator;
|
|
56
|
+
private readonly specGenerateOptions;
|
|
57
|
+
private readonly specPath;
|
|
58
|
+
private readonly docsPath;
|
|
59
|
+
private readonly docsTitle;
|
|
60
|
+
private readonly docsHead;
|
|
61
|
+
private readonly docsScriptUrl;
|
|
62
|
+
private readonly docsConfig;
|
|
63
|
+
private readonly renderDocsHtml;
|
|
64
|
+
constructor(options?: OpenAPIReferencePluginOptions<T>);
|
|
65
|
+
init(options: StandardHandlerOptions<T>, router: Router<any, T>): void;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export { OpenAPIReferencePlugin };
|
|
69
|
+
export type { OpenAPIReferencePluginOptions };
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
import { OpenAPI } from '@orpc/contract';
|
|
2
|
+
import { Context, HTTPPath, Router } from '@orpc/server';
|
|
3
|
+
import { StandardHandlerInterceptorOptions, StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
|
|
4
|
+
import { Value, Promisable } from '@orpc/shared';
|
|
5
|
+
import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.B3hexduL.js';
|
|
6
|
+
import '@orpc/openapi-client/standard';
|
|
7
|
+
import 'json-schema-typed/draft-2020-12';
|
|
8
|
+
|
|
9
|
+
interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGeneratorOptions {
|
|
10
|
+
/**
|
|
11
|
+
* Options to pass to the OpenAPI generate.
|
|
12
|
+
*
|
|
13
|
+
*/
|
|
14
|
+
specGenerateOptions?: Value<Promisable<OpenAPIGeneratorGenerateOptions>, [StandardHandlerInterceptorOptions<T>]>;
|
|
15
|
+
/**
|
|
16
|
+
* The URL path at which to serve the OpenAPI JSON.
|
|
17
|
+
*
|
|
18
|
+
* @default '/spec.json'
|
|
19
|
+
*/
|
|
20
|
+
specPath?: HTTPPath;
|
|
21
|
+
/**
|
|
22
|
+
* The URL path at which to serve the API reference UI.
|
|
23
|
+
*
|
|
24
|
+
* @default '/'
|
|
25
|
+
*/
|
|
26
|
+
docsPath?: HTTPPath;
|
|
27
|
+
/**
|
|
28
|
+
* The document title for the API reference UI.
|
|
29
|
+
*
|
|
30
|
+
* @default 'API Reference'
|
|
31
|
+
*/
|
|
32
|
+
docsTitle?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
|
|
33
|
+
/**
|
|
34
|
+
* Arbitrary configuration object for the UI.
|
|
35
|
+
*/
|
|
36
|
+
docsConfig?: Value<Promisable<Record<string, unknown>>, [StandardHandlerInterceptorOptions<T>]>;
|
|
37
|
+
/**
|
|
38
|
+
* HTML to inject into the <head> of the docs page.
|
|
39
|
+
*
|
|
40
|
+
* @default ''
|
|
41
|
+
*/
|
|
42
|
+
docsHead?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
|
|
43
|
+
/**
|
|
44
|
+
* URL of the external script bundle for the reference UI.
|
|
45
|
+
*
|
|
46
|
+
* @default 'https://cdn.jsdelivr.net/npm/@scalar/api-reference'
|
|
47
|
+
*/
|
|
48
|
+
docsScriptUrl?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
|
|
49
|
+
/**
|
|
50
|
+
* Override function to generate the full HTML for the docs page.
|
|
51
|
+
*/
|
|
52
|
+
renderDocsHtml?: (specUrl: string, title: string, head: string, scriptUrl: string, config: Record<string, unknown> | undefined, spec: OpenAPI.Document) => string;
|
|
53
|
+
}
|
|
54
|
+
declare class OpenAPIReferencePlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
|
55
|
+
private readonly generator;
|
|
56
|
+
private readonly specGenerateOptions;
|
|
57
|
+
private readonly specPath;
|
|
58
|
+
private readonly docsPath;
|
|
59
|
+
private readonly docsTitle;
|
|
60
|
+
private readonly docsHead;
|
|
61
|
+
private readonly docsScriptUrl;
|
|
62
|
+
private readonly docsConfig;
|
|
63
|
+
private readonly renderDocsHtml;
|
|
64
|
+
constructor(options?: OpenAPIReferencePluginOptions<T>);
|
|
65
|
+
init(options: StandardHandlerOptions<T>, router: Router<any, T>): void;
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export { OpenAPIReferencePlugin };
|
|
69
|
+
export type { OpenAPIReferencePluginOptions };
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import { stringifyJSON, once, value } from '@orpc/shared';
|
|
2
|
+
import { O as OpenAPIGenerator } from '../shared/openapi.DrrBsJ0w.mjs';
|
|
3
|
+
import '@orpc/client';
|
|
4
|
+
import '@orpc/client/standard';
|
|
5
|
+
import '@orpc/contract';
|
|
6
|
+
import '@orpc/openapi-client/standard';
|
|
7
|
+
import '@orpc/server';
|
|
8
|
+
import 'json-schema-typed/draft-2020-12';
|
|
9
|
+
|
|
10
|
+
class OpenAPIReferencePlugin {
|
|
11
|
+
generator;
|
|
12
|
+
specGenerateOptions;
|
|
13
|
+
specPath;
|
|
14
|
+
docsPath;
|
|
15
|
+
docsTitle;
|
|
16
|
+
docsHead;
|
|
17
|
+
docsScriptUrl;
|
|
18
|
+
docsConfig;
|
|
19
|
+
renderDocsHtml;
|
|
20
|
+
constructor(options = {}) {
|
|
21
|
+
this.specGenerateOptions = options.specGenerateOptions;
|
|
22
|
+
this.docsPath = options.docsPath ?? "/";
|
|
23
|
+
this.docsTitle = options.docsTitle ?? "API Reference";
|
|
24
|
+
this.docsConfig = options.docsConfig ?? void 0;
|
|
25
|
+
this.docsScriptUrl = options.docsScriptUrl ?? "https://cdn.jsdelivr.net/npm/@scalar/api-reference";
|
|
26
|
+
this.docsHead = options.docsHead ?? "";
|
|
27
|
+
this.specPath = options.specPath ?? "/spec.json";
|
|
28
|
+
this.generator = new OpenAPIGenerator(options);
|
|
29
|
+
const esc = (s) => s.replace(/&/g, "&").replace(/"/g, """).replace(/</g, "<").replace(/>/g, ">");
|
|
30
|
+
this.renderDocsHtml = options.renderDocsHtml ?? ((specUrl, title, head, scriptUrl, config, spec) => {
|
|
31
|
+
const finalConfig = {
|
|
32
|
+
content: stringifyJSON(spec),
|
|
33
|
+
...config
|
|
34
|
+
};
|
|
35
|
+
return `
|
|
36
|
+
<!doctype html>
|
|
37
|
+
<html>
|
|
38
|
+
<head>
|
|
39
|
+
<meta charset="utf-8" />
|
|
40
|
+
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
41
|
+
<title>${esc(title)}</title>
|
|
42
|
+
${head}
|
|
43
|
+
</head>
|
|
44
|
+
<body>
|
|
45
|
+
<div id="app" data-config="${esc(stringifyJSON(finalConfig))}"></div>
|
|
46
|
+
|
|
47
|
+
<script src="${esc(scriptUrl)}"><\/script>
|
|
48
|
+
|
|
49
|
+
<script>
|
|
50
|
+
Scalar.createApiReference('#app', JSON.parse(document.getElementById('app').dataset.config))
|
|
51
|
+
<\/script>
|
|
52
|
+
</body>
|
|
53
|
+
</html>
|
|
54
|
+
`;
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
init(options, router) {
|
|
58
|
+
options.interceptors ??= [];
|
|
59
|
+
options.interceptors.push(async (options2) => {
|
|
60
|
+
const res = await options2.next();
|
|
61
|
+
if (res.matched || options2.request.method !== "GET") {
|
|
62
|
+
return res;
|
|
63
|
+
}
|
|
64
|
+
const prefix = options2.prefix ?? "";
|
|
65
|
+
const requestPathname = options2.request.url.pathname.replace(/\/$/, "") || "/";
|
|
66
|
+
const docsUrl = new URL(`${prefix}${this.docsPath}`.replace(/\/$/, ""), options2.request.url.origin);
|
|
67
|
+
const specUrl = new URL(`${prefix}${this.specPath}`.replace(/\/$/, ""), options2.request.url.origin);
|
|
68
|
+
const generateSpec = once(async () => {
|
|
69
|
+
return await this.generator.generate(router, {
|
|
70
|
+
servers: [{ url: new URL(prefix, options2.request.url.origin).toString() }],
|
|
71
|
+
...await value(this.specGenerateOptions, options2)
|
|
72
|
+
});
|
|
73
|
+
});
|
|
74
|
+
if (requestPathname === specUrl.pathname) {
|
|
75
|
+
const spec = await generateSpec();
|
|
76
|
+
return {
|
|
77
|
+
matched: true,
|
|
78
|
+
response: {
|
|
79
|
+
status: 200,
|
|
80
|
+
headers: {},
|
|
81
|
+
body: new File([stringifyJSON(spec)], "spec.json", { type: "application/json" })
|
|
82
|
+
}
|
|
83
|
+
};
|
|
84
|
+
}
|
|
85
|
+
if (requestPathname === docsUrl.pathname) {
|
|
86
|
+
const html = this.renderDocsHtml(
|
|
87
|
+
specUrl.toString(),
|
|
88
|
+
await value(this.docsTitle, options2),
|
|
89
|
+
await value(this.docsHead, options2),
|
|
90
|
+
await value(this.docsScriptUrl, options2),
|
|
91
|
+
await value(this.docsConfig, options2),
|
|
92
|
+
await generateSpec()
|
|
93
|
+
);
|
|
94
|
+
return {
|
|
95
|
+
matched: true,
|
|
96
|
+
response: {
|
|
97
|
+
status: 200,
|
|
98
|
+
headers: {},
|
|
99
|
+
body: new File([html], "api-reference.html", { type: "text/html" })
|
|
100
|
+
}
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
return res;
|
|
104
|
+
});
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
export { OpenAPIReferencePlugin };
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import { AnySchema, OpenAPI, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
|
|
2
|
+
import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
|
|
3
|
+
import { AnyProcedure, AnyRouter } from '@orpc/server';
|
|
4
|
+
import { Promisable } from '@orpc/shared';
|
|
5
|
+
import { JSONSchema } from 'json-schema-typed/draft-2020-12';
|
|
6
|
+
|
|
7
|
+
interface SchemaConverterComponent {
|
|
8
|
+
allowedStrategies: readonly SchemaConvertOptions['strategy'][];
|
|
9
|
+
schema: AnySchema;
|
|
10
|
+
required: boolean;
|
|
11
|
+
ref: string;
|
|
12
|
+
}
|
|
13
|
+
interface SchemaConvertOptions {
|
|
14
|
+
strategy: 'input' | 'output';
|
|
15
|
+
/**
|
|
16
|
+
* Common components should use `$ref` to represent themselves if matched.
|
|
17
|
+
*/
|
|
18
|
+
components?: readonly SchemaConverterComponent[];
|
|
19
|
+
/**
|
|
20
|
+
* Minimum schema structure depth required before using `$ref` for components.
|
|
21
|
+
*
|
|
22
|
+
* For example, if set to 2, `$ref` will only be used for schemas nested at depth 2 or greater.
|
|
23
|
+
*
|
|
24
|
+
* @default 0 - No depth limit;
|
|
25
|
+
*/
|
|
26
|
+
minStructureDepthForRef?: number;
|
|
27
|
+
}
|
|
28
|
+
interface SchemaConverter {
|
|
29
|
+
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
|
|
30
|
+
}
|
|
31
|
+
interface ConditionalSchemaConverter extends SchemaConverter {
|
|
32
|
+
condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
|
|
33
|
+
}
|
|
34
|
+
declare class CompositeSchemaConverter implements SchemaConverter {
|
|
35
|
+
private readonly converters;
|
|
36
|
+
constructor(converters: ConditionalSchemaConverter[]);
|
|
37
|
+
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
|
|
41
|
+
schemaConverters?: ConditionalSchemaConverter[];
|
|
42
|
+
}
|
|
43
|
+
interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document, 'openapi'>> {
|
|
44
|
+
/**
|
|
45
|
+
* Exclude procedures from the OpenAPI specification.
|
|
46
|
+
*
|
|
47
|
+
* @default () => false
|
|
48
|
+
*/
|
|
49
|
+
exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
|
|
50
|
+
/**
|
|
51
|
+
* Common schemas to be used for $ref resolution.
|
|
52
|
+
*/
|
|
53
|
+
commonSchemas?: Record<string, {
|
|
54
|
+
/**
|
|
55
|
+
* Determines which schema definition to use when input and output schemas differ.
|
|
56
|
+
* This is needed because some schemas transform data differently between input and output,
|
|
57
|
+
* making it impossible to use a single $ref for both cases.
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```ts
|
|
61
|
+
* // This schema transforms a string input into a number output
|
|
62
|
+
* const Schema = z.string()
|
|
63
|
+
* .transform(v => Number(v))
|
|
64
|
+
* .pipe(z.number())
|
|
65
|
+
*
|
|
66
|
+
* // Input schema: { type: 'string' }
|
|
67
|
+
* // Output schema: { type: 'number' }
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* When schemas differ between input and output, you must explicitly choose
|
|
71
|
+
* which version to use for the OpenAPI specification.
|
|
72
|
+
*
|
|
73
|
+
* @default 'input' - Uses the input schema definition by default
|
|
74
|
+
*/
|
|
75
|
+
strategy?: SchemaConvertOptions['strategy'];
|
|
76
|
+
schema: AnySchema;
|
|
77
|
+
} | {
|
|
78
|
+
error: 'UndefinedError';
|
|
79
|
+
schema?: never;
|
|
80
|
+
}>;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* The generator that converts oRPC routers/contracts to OpenAPI specifications.
|
|
84
|
+
*
|
|
85
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
|
|
86
|
+
*/
|
|
87
|
+
declare class OpenAPIGenerator {
|
|
88
|
+
#private;
|
|
89
|
+
private readonly serializer;
|
|
90
|
+
private readonly converter;
|
|
91
|
+
constructor(options?: OpenAPIGeneratorOptions);
|
|
92
|
+
/**
|
|
93
|
+
* Generates OpenAPI specifications from oRPC routers/contracts.
|
|
94
|
+
*
|
|
95
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
|
|
96
|
+
*/
|
|
97
|
+
generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
export { OpenAPIGenerator as b, CompositeSchemaConverter as e };
|
|
101
|
+
export type { ConditionalSchemaConverter as C, OpenAPIGeneratorOptions as O, SchemaConverterComponent as S, OpenAPIGeneratorGenerateOptions as a, SchemaConvertOptions as c, SchemaConverter as d };
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
import { AnySchema, OpenAPI, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
|
|
2
|
+
import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
|
|
3
|
+
import { AnyProcedure, AnyRouter } from '@orpc/server';
|
|
4
|
+
import { Promisable } from '@orpc/shared';
|
|
5
|
+
import { JSONSchema } from 'json-schema-typed/draft-2020-12';
|
|
6
|
+
|
|
7
|
+
interface SchemaConverterComponent {
|
|
8
|
+
allowedStrategies: readonly SchemaConvertOptions['strategy'][];
|
|
9
|
+
schema: AnySchema;
|
|
10
|
+
required: boolean;
|
|
11
|
+
ref: string;
|
|
12
|
+
}
|
|
13
|
+
interface SchemaConvertOptions {
|
|
14
|
+
strategy: 'input' | 'output';
|
|
15
|
+
/**
|
|
16
|
+
* Common components should use `$ref` to represent themselves if matched.
|
|
17
|
+
*/
|
|
18
|
+
components?: readonly SchemaConverterComponent[];
|
|
19
|
+
/**
|
|
20
|
+
* Minimum schema structure depth required before using `$ref` for components.
|
|
21
|
+
*
|
|
22
|
+
* For example, if set to 2, `$ref` will only be used for schemas nested at depth 2 or greater.
|
|
23
|
+
*
|
|
24
|
+
* @default 0 - No depth limit;
|
|
25
|
+
*/
|
|
26
|
+
minStructureDepthForRef?: number;
|
|
27
|
+
}
|
|
28
|
+
interface SchemaConverter {
|
|
29
|
+
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
|
|
30
|
+
}
|
|
31
|
+
interface ConditionalSchemaConverter extends SchemaConverter {
|
|
32
|
+
condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
|
|
33
|
+
}
|
|
34
|
+
declare class CompositeSchemaConverter implements SchemaConverter {
|
|
35
|
+
private readonly converters;
|
|
36
|
+
constructor(converters: ConditionalSchemaConverter[]);
|
|
37
|
+
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
|
|
41
|
+
schemaConverters?: ConditionalSchemaConverter[];
|
|
42
|
+
}
|
|
43
|
+
interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPI.Document, 'openapi'>> {
|
|
44
|
+
/**
|
|
45
|
+
* Exclude procedures from the OpenAPI specification.
|
|
46
|
+
*
|
|
47
|
+
* @default () => false
|
|
48
|
+
*/
|
|
49
|
+
exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
|
|
50
|
+
/**
|
|
51
|
+
* Common schemas to be used for $ref resolution.
|
|
52
|
+
*/
|
|
53
|
+
commonSchemas?: Record<string, {
|
|
54
|
+
/**
|
|
55
|
+
* Determines which schema definition to use when input and output schemas differ.
|
|
56
|
+
* This is needed because some schemas transform data differently between input and output,
|
|
57
|
+
* making it impossible to use a single $ref for both cases.
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* ```ts
|
|
61
|
+
* // This schema transforms a string input into a number output
|
|
62
|
+
* const Schema = z.string()
|
|
63
|
+
* .transform(v => Number(v))
|
|
64
|
+
* .pipe(z.number())
|
|
65
|
+
*
|
|
66
|
+
* // Input schema: { type: 'string' }
|
|
67
|
+
* // Output schema: { type: 'number' }
|
|
68
|
+
* ```
|
|
69
|
+
*
|
|
70
|
+
* When schemas differ between input and output, you must explicitly choose
|
|
71
|
+
* which version to use for the OpenAPI specification.
|
|
72
|
+
*
|
|
73
|
+
* @default 'input' - Uses the input schema definition by default
|
|
74
|
+
*/
|
|
75
|
+
strategy?: SchemaConvertOptions['strategy'];
|
|
76
|
+
schema: AnySchema;
|
|
77
|
+
} | {
|
|
78
|
+
error: 'UndefinedError';
|
|
79
|
+
schema?: never;
|
|
80
|
+
}>;
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* The generator that converts oRPC routers/contracts to OpenAPI specifications.
|
|
84
|
+
*
|
|
85
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
|
|
86
|
+
*/
|
|
87
|
+
declare class OpenAPIGenerator {
|
|
88
|
+
#private;
|
|
89
|
+
private readonly serializer;
|
|
90
|
+
private readonly converter;
|
|
91
|
+
constructor(options?: OpenAPIGeneratorOptions);
|
|
92
|
+
/**
|
|
93
|
+
* Generates OpenAPI specifications from oRPC routers/contracts.
|
|
94
|
+
*
|
|
95
|
+
* @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
|
|
96
|
+
*/
|
|
97
|
+
generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPI.Document>;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
export { OpenAPIGenerator as b, CompositeSchemaConverter as e };
|
|
101
|
+
export type { ConditionalSchemaConverter as C, OpenAPIGeneratorOptions as O, SchemaConverterComponent as S, OpenAPIGeneratorGenerateOptions as a, SchemaConvertOptions as c, SchemaConverter as d };
|
|
@@ -1,12 +1,14 @@
|
|
|
1
|
+
import { standardizeHTTPPath, StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer, StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
|
|
2
|
+
import { StandardHandler } from '@orpc/server/standard';
|
|
3
|
+
import { isORPCErrorStatus } from '@orpc/client';
|
|
1
4
|
import { fallbackContractConfig } from '@orpc/contract';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
+
import { isObject, stringifyJSON } from '@orpc/shared';
|
|
6
|
+
import { toHttpPath } from '@orpc/client/standard';
|
|
7
|
+
import { traverseContractProcedures, isProcedure, getLazyMeta, unlazy, getRouter, createContractedProcedure } from '@orpc/server';
|
|
5
8
|
import { createRouter, addRoute, findRoute } from 'rou3';
|
|
6
|
-
import { s as standardizeHTTPPath } from './openapi.BHG_gu5Z.mjs';
|
|
7
9
|
|
|
8
|
-
class
|
|
9
|
-
constructor(serializer
|
|
10
|
+
class StandardOpenAPICodec {
|
|
11
|
+
constructor(serializer) {
|
|
10
12
|
this.serializer = serializer;
|
|
11
13
|
}
|
|
12
14
|
async decode(request, params, procedure) {
|
|
@@ -51,13 +53,21 @@ class OpenAPICodec {
|
|
|
51
53
|
body: this.serializer.serialize(output)
|
|
52
54
|
};
|
|
53
55
|
}
|
|
54
|
-
if (!
|
|
55
|
-
throw new Error(
|
|
56
|
-
|
|
57
|
-
|
|
56
|
+
if (!this.#isDetailedOutput(output)) {
|
|
57
|
+
throw new Error(`
|
|
58
|
+
Invalid "detailed" output structure:
|
|
59
|
+
\u2022 Expected an object with optional properties:
|
|
60
|
+
- status (number 200-399)
|
|
61
|
+
- headers (Record<string, string | string[]>)
|
|
62
|
+
- body (any)
|
|
63
|
+
\u2022 No extra keys allowed.
|
|
64
|
+
|
|
65
|
+
Actual value:
|
|
66
|
+
${stringifyJSON(output)}
|
|
67
|
+
`);
|
|
58
68
|
}
|
|
59
69
|
return {
|
|
60
|
-
status: successStatus,
|
|
70
|
+
status: output.status ?? successStatus,
|
|
61
71
|
headers: output.headers ?? {},
|
|
62
72
|
body: this.serializer.serialize(output.body)
|
|
63
73
|
};
|
|
@@ -66,21 +76,37 @@ class OpenAPICodec {
|
|
|
66
76
|
return {
|
|
67
77
|
status: error.status,
|
|
68
78
|
headers: {},
|
|
69
|
-
body: this.serializer.serialize(error.toJSON())
|
|
79
|
+
body: this.serializer.serialize(error.toJSON(), { outputFormat: "plain" })
|
|
70
80
|
};
|
|
71
81
|
}
|
|
82
|
+
#isDetailedOutput(output) {
|
|
83
|
+
if (!isObject(output)) {
|
|
84
|
+
return false;
|
|
85
|
+
}
|
|
86
|
+
if (output.headers && !isObject(output.headers)) {
|
|
87
|
+
return false;
|
|
88
|
+
}
|
|
89
|
+
if (output.status !== void 0 && (typeof output.status !== "number" || !Number.isInteger(output.status) || isORPCErrorStatus(output.status))) {
|
|
90
|
+
return false;
|
|
91
|
+
}
|
|
92
|
+
return true;
|
|
93
|
+
}
|
|
72
94
|
}
|
|
73
95
|
|
|
74
|
-
|
|
96
|
+
function toRou3Pattern(path) {
|
|
97
|
+
return standardizeHTTPPath(path).replace(/\/\{\+([^}]+)\}/g, "/**:$1").replace(/\/\{([^}]+)\}/g, "/:$1");
|
|
98
|
+
}
|
|
99
|
+
function decodeParams(params) {
|
|
100
|
+
return Object.fromEntries(Object.entries(params).map(([key, value]) => [key, decodeURIComponent(value)]));
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
class StandardOpenAPIMatcher {
|
|
75
104
|
tree = createRouter();
|
|
76
105
|
pendingRouters = [];
|
|
77
106
|
init(router, path = []) {
|
|
78
|
-
const laziedOptions =
|
|
79
|
-
router,
|
|
80
|
-
path
|
|
81
|
-
}, ({ path: path2, contract }) => {
|
|
107
|
+
const laziedOptions = traverseContractProcedures({ router, path }, ({ path: path2, contract }) => {
|
|
82
108
|
const method = fallbackContractConfig("defaultMethod", contract["~orpc"].route.method);
|
|
83
|
-
const httpPath =
|
|
109
|
+
const httpPath = toRou3Pattern(contract["~orpc"].route.path ?? toHttpPath(path2));
|
|
84
110
|
if (isProcedure(contract)) {
|
|
85
111
|
addRoute(this.tree, method, httpPath, {
|
|
86
112
|
path: path2,
|
|
@@ -100,8 +126,8 @@ class OpenAPIMatcher {
|
|
|
100
126
|
});
|
|
101
127
|
this.pendingRouters.push(...laziedOptions.map((option) => ({
|
|
102
128
|
...option,
|
|
103
|
-
httpPathPrefix:
|
|
104
|
-
laziedPrefix:
|
|
129
|
+
httpPathPrefix: toHttpPath(option.path),
|
|
130
|
+
laziedPrefix: getLazyMeta(option.router).prefix
|
|
105
131
|
})));
|
|
106
132
|
}
|
|
107
133
|
async match(method, pathname) {
|
|
@@ -109,7 +135,7 @@ class OpenAPIMatcher {
|
|
|
109
135
|
const newPendingRouters = [];
|
|
110
136
|
for (const pendingRouter of this.pendingRouters) {
|
|
111
137
|
if (!pendingRouter.laziedPrefix || pathname.startsWith(pendingRouter.laziedPrefix) || pathname.startsWith(pendingRouter.httpPathPrefix)) {
|
|
112
|
-
const { default: router } = await unlazy(pendingRouter.
|
|
138
|
+
const { default: router } = await unlazy(pendingRouter.router);
|
|
113
139
|
this.init(router, pendingRouter.path);
|
|
114
140
|
} else {
|
|
115
141
|
newPendingRouters.push(pendingRouter);
|
|
@@ -122,14 +148,14 @@ class OpenAPIMatcher {
|
|
|
122
148
|
return void 0;
|
|
123
149
|
}
|
|
124
150
|
if (!match.data.procedure) {
|
|
125
|
-
const { default: maybeProcedure } = await unlazy(
|
|
151
|
+
const { default: maybeProcedure } = await unlazy(getRouter(match.data.router, match.data.path));
|
|
126
152
|
if (!isProcedure(maybeProcedure)) {
|
|
127
153
|
throw new Error(`
|
|
128
|
-
[Contract-First] Missing or invalid implementation for procedure at path: ${
|
|
154
|
+
[Contract-First] Missing or invalid implementation for procedure at path: ${toHttpPath(match.data.path)}.
|
|
129
155
|
Ensure that the procedure is correctly defined and matches the expected contract.
|
|
130
156
|
`);
|
|
131
157
|
}
|
|
132
|
-
match.data.procedure = createContractedProcedure(match.data.contract
|
|
158
|
+
match.data.procedure = createContractedProcedure(maybeProcedure, match.data.contract);
|
|
133
159
|
}
|
|
134
160
|
return {
|
|
135
161
|
path: match.data.path,
|
|
@@ -138,11 +164,16 @@ class OpenAPIMatcher {
|
|
|
138
164
|
};
|
|
139
165
|
}
|
|
140
166
|
}
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
167
|
+
|
|
168
|
+
class StandardOpenAPIHandler extends StandardHandler {
|
|
169
|
+
constructor(router, options) {
|
|
170
|
+
const jsonSerializer = new StandardOpenAPIJsonSerializer(options);
|
|
171
|
+
const bracketNotationSerializer = new StandardBracketNotationSerializer();
|
|
172
|
+
const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
|
|
173
|
+
const matcher = new StandardOpenAPIMatcher();
|
|
174
|
+
const codec = new StandardOpenAPICodec(serializer);
|
|
175
|
+
super(router, matcher, codec, options);
|
|
176
|
+
}
|
|
146
177
|
}
|
|
147
178
|
|
|
148
|
-
export {
|
|
179
|
+
export { StandardOpenAPICodec as S, StandardOpenAPIHandler as a, StandardOpenAPIMatcher as b, decodeParams as d, toRou3Pattern as t };
|
|
@@ -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 };
|