@orpc/openapi 0.0.0-next.f47352c → 0.0.0-next.f4ed9ab

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.
Files changed (32) hide show
  1. package/README.md +14 -17
  2. package/dist/adapters/fetch/index.d.mts +7 -1
  3. package/dist/adapters/fetch/index.d.ts +7 -1
  4. package/dist/adapters/fetch/index.mjs +13 -5
  5. package/dist/adapters/node/index.d.mts +7 -1
  6. package/dist/adapters/node/index.d.ts +7 -1
  7. package/dist/adapters/node/index.mjs +5 -9
  8. package/dist/adapters/standard/index.d.mts +2 -1
  9. package/dist/adapters/standard/index.d.ts +2 -1
  10. package/dist/adapters/standard/index.mjs +4 -2
  11. package/dist/index.d.mts +23 -32
  12. package/dist/index.d.ts +23 -32
  13. package/dist/index.mjs +31 -526
  14. package/dist/plugins/index.d.mts +70 -0
  15. package/dist/plugins/index.d.ts +70 -0
  16. package/dist/plugins/index.mjs +108 -0
  17. package/dist/shared/{openapi.sdeu0I7N.mjs → openapi.C_UtQ8Us.mjs} +41 -8
  18. package/dist/shared/openapi.CwdCLgSU.d.mts +53 -0
  19. package/dist/shared/openapi.CwdCLgSU.d.ts +53 -0
  20. package/dist/shared/openapi.D3j94c9n.d.mts +12 -0
  21. package/dist/shared/openapi.D3j94c9n.d.ts +12 -0
  22. package/dist/shared/openapi.PDTdnRIU.mjs +595 -0
  23. package/package.json +14 -19
  24. package/dist/adapters/hono/index.d.mts +0 -6
  25. package/dist/adapters/hono/index.d.ts +0 -6
  26. package/dist/adapters/hono/index.mjs +0 -10
  27. package/dist/adapters/next/index.d.mts +0 -6
  28. package/dist/adapters/next/index.d.ts +0 -6
  29. package/dist/adapters/next/index.mjs +0 -10
  30. package/dist/shared/openapi.CGZ7t-VN.mjs +0 -17
  31. package/dist/shared/openapi.IfmmOyba.d.mts +0 -8
  32. package/dist/shared/openapi.IfmmOyba.d.ts +0 -8
package/dist/plugins/index.d.ts ADDED
@@ -0,0 +1,70 @@
1
+ import { Context, HTTPPath, Router } from '@orpc/server';
2
+ import { StandardHandlerInterceptorOptions, StandardHandlerPlugin, StandardHandlerOptions } from '@orpc/server/standard';
3
+ import { Value } from '@orpc/shared';
4
+ import { OpenAPIV3_1 } from 'openapi-types';
5
+ import { O as OpenAPIGeneratorOptions, a as OpenAPIGeneratorGenerateOptions } from '../shared/openapi.CwdCLgSU.js';
6
+ import '@orpc/contract';
7
+ import '@orpc/openapi-client/standard';
8
+ import 'json-schema-typed/draft-2020-12';
9
+
10
+ interface OpenAPIReferencePluginOptions<T extends Context> extends OpenAPIGeneratorOptions {
11
+ /**
12
+ * Options to pass to the OpenAPI generate.
13
+ *
14
+ */
15
+ specGenerateOptions?: Value<OpenAPIGeneratorGenerateOptions, [StandardHandlerInterceptorOptions<T>]>;
16
+ /**
17
+ * The URL path at which to serve the OpenAPI JSON.
18
+ *
19
+ * @default '/spec.json'
20
+ */
21
+ specPath?: HTTPPath;
22
+ /**
23
+ * The URL path at which to serve the API reference UI.
24
+ *
25
+ * @default '/'
26
+ */
27
+ docsPath?: HTTPPath;
28
+ /**
29
+ * The document title for the API reference UI.
30
+ *
31
+ * @default 'API Reference'
32
+ */
33
+ docsTitle?: Value<string, [StandardHandlerInterceptorOptions<T>]>;
34
+ /**
35
+ * Arbitrary configuration object for the UI.
36
+ */
37
+ docsConfig?: Value<Record<string, unknown>, [StandardHandlerInterceptorOptions<T>]>;
38
+ /**
39
+ * HTML to inject into the <head> of the docs page.
40
+ *
41
+ * @default ''
42
+ */
43
+ docsHead?: Value<string, [StandardHandlerInterceptorOptions<T>]>;
44
+ /**
45
+ * URL of the external script bundle for the reference UI.
46
+ *
47
+ * @default 'https://cdn.jsdelivr.net/npm/@scalar/api-reference'
48
+ */
49
+ docsScriptUrl?: Value<string, [StandardHandlerInterceptorOptions<T>]>;
50
+ /**
51
+ * Override function to generate the full HTML for the docs page.
52
+ */
53
+ renderDocsHtml?: (specUrl: string, title: string, head: string, scriptUrl: string, config: Record<string, unknown> | undefined, spec: OpenAPIV3_1.Document) => string;
54
+ }
55
+ declare class OpenAPIReferencePlugin<T extends Context> implements StandardHandlerPlugin<T> {
56
+ private readonly generator;
57
+ private readonly specGenerateOptions;
58
+ private readonly specPath;
59
+ private readonly docsPath;
60
+ private readonly docsTitle;
61
+ private readonly docsHead;
62
+ private readonly docsScriptUrl;
63
+ private readonly docsConfig;
64
+ private readonly renderDocsHtml;
65
+ constructor(options?: OpenAPIReferencePluginOptions<T>);
66
+ init(options: StandardHandlerOptions<T>, router: Router<any, T>): void;
67
+ }
68
+
69
+ export { OpenAPIReferencePlugin };
70
+ export type { OpenAPIReferencePluginOptions };
package/dist/plugins/index.mjs ADDED
@@ -0,0 +1,108 @@
1
+ import { stringifyJSON, once, value } from '@orpc/shared';
2
+ import { O as OpenAPIGenerator } from '../shared/openapi.PDTdnRIU.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, "&amp;").replace(/"/g, "&quot;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
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 };
package/dist/shared/{openapi.sdeu0I7N.mjs → openapi.C_UtQ8Us.mjs} RENAMED
@@ -1,9 +1,11 @@
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 { isObject } from '@orpc/shared';
5
+ import { isObject, stringifyJSON } from '@orpc/shared';
3
6
  import { toHttpPath } from '@orpc/client/standard';
4
7
  import { traverseContractProcedures, isProcedure, getLazyMeta, unlazy, getRouter, createContractedProcedure } from '@orpc/server';
5
8
  import { createRouter, addRoute, findRoute } from 'rou3';
6
- import { standardizeHTTPPath } from '@orpc/openapi-client/standard';
7
9
 
8
10
  class StandardOpenAPICodec {
9
11
  constructor(serializer) {
@@ -51,13 +53,21 @@ class StandardOpenAPICodec {
51
53
  body: this.serializer.serialize(output)
52
54
  };
53
55
  }
54
- if (!isObject(output)) {
55
- throw new Error(
56
- 'Invalid output structure for "detailed" output. Expected format: { body: any, headers?: Record<string, string | string[] | undefined> }'
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
  };
@@ -69,6 +79,18 @@ class StandardOpenAPICodec {
69
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) {
@@ -143,4 +165,15 @@ class StandardOpenAPIMatcher {
143
165
  }
144
166
  }
145
167
 
146
- export { StandardOpenAPICodec as S, StandardOpenAPIMatcher as a, decodeParams as d, toRou3Pattern as t };
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
+ }
177
+ }
178
+
179
+ export { StandardOpenAPICodec as S, StandardOpenAPIHandler as a, StandardOpenAPIMatcher as b, decodeParams as d, toRou3Pattern as t };
package/dist/shared/openapi.CwdCLgSU.d.mts ADDED
@@ -0,0 +1,53 @@
1
+ import { AnySchema, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
2
+ import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
3
+ import { AnyProcedure, AnyRouter } from '@orpc/server';
4
+ import { OpenAPIV3_1 } from 'openapi-types';
5
+ import { Promisable } from '@orpc/shared';
6
+ import { JSONSchema } from 'json-schema-typed/draft-2020-12';
7
+
8
+ interface SchemaConvertOptions {
9
+ strategy: 'input' | 'output';
10
+ }
11
+ interface SchemaConverter {
12
+ convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
13
+ }
14
+ interface ConditionalSchemaConverter extends SchemaConverter {
15
+ condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
16
+ }
17
+ declare class CompositeSchemaConverter implements SchemaConverter {
18
+ private readonly converters;
19
+ constructor(converters: ConditionalSchemaConverter[]);
20
+ convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
21
+ }
22
+
23
+ interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
24
+ schemaConverters?: ConditionalSchemaConverter[];
25
+ }
26
+ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPIV3_1.Document, 'openapi'>> {
27
+ /**
28
+ * Exclude procedures from the OpenAPI specification.
29
+ *
30
+ * @default () => false
31
+ */
32
+ exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
33
+ }
34
+ /**
35
+ * The generator that converts oRPC routers/contracts to OpenAPI specifications.
36
+ *
37
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
38
+ */
39
+ declare class OpenAPIGenerator {
40
+ #private;
41
+ private readonly serializer;
42
+ private readonly converter;
43
+ constructor(options?: OpenAPIGeneratorOptions);
44
+ /**
45
+ * Generates OpenAPI specifications from oRPC routers/contracts.
46
+ *
47
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
48
+ */
49
+ generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPIV3_1.Document>;
50
+ }
51
+
52
+ export { OpenAPIGenerator as b, CompositeSchemaConverter as d };
53
+ export type { ConditionalSchemaConverter as C, OpenAPIGeneratorOptions as O, SchemaConvertOptions as S, OpenAPIGeneratorGenerateOptions as a, SchemaConverter as c };
package/dist/shared/openapi.CwdCLgSU.d.ts ADDED
@@ -0,0 +1,53 @@
1
+ import { AnySchema, AnyContractProcedure, AnyContractRouter } from '@orpc/contract';
2
+ import { StandardOpenAPIJsonSerializerOptions } from '@orpc/openapi-client/standard';
3
+ import { AnyProcedure, AnyRouter } from '@orpc/server';
4
+ import { OpenAPIV3_1 } from 'openapi-types';
5
+ import { Promisable } from '@orpc/shared';
6
+ import { JSONSchema } from 'json-schema-typed/draft-2020-12';
7
+
8
+ interface SchemaConvertOptions {
9
+ strategy: 'input' | 'output';
10
+ }
11
+ interface SchemaConverter {
12
+ convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<[required: boolean, jsonSchema: JSONSchema]>;
13
+ }
14
+ interface ConditionalSchemaConverter extends SchemaConverter {
15
+ condition(schema: AnySchema | undefined, options: SchemaConvertOptions): Promisable<boolean>;
16
+ }
17
+ declare class CompositeSchemaConverter implements SchemaConverter {
18
+ private readonly converters;
19
+ constructor(converters: ConditionalSchemaConverter[]);
20
+ convert(schema: AnySchema | undefined, options: SchemaConvertOptions): Promise<[required: boolean, jsonSchema: JSONSchema]>;
21
+ }
22
+
23
+ interface OpenAPIGeneratorOptions extends StandardOpenAPIJsonSerializerOptions {
24
+ schemaConverters?: ConditionalSchemaConverter[];
25
+ }
26
+ interface OpenAPIGeneratorGenerateOptions extends Partial<Omit<OpenAPIV3_1.Document, 'openapi'>> {
27
+ /**
28
+ * Exclude procedures from the OpenAPI specification.
29
+ *
30
+ * @default () => false
31
+ */
32
+ exclude?: (procedure: AnyProcedure | AnyContractProcedure, path: readonly string[]) => boolean;
33
+ }
34
+ /**
35
+ * The generator that converts oRPC routers/contracts to OpenAPI specifications.
36
+ *
37
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
38
+ */
39
+ declare class OpenAPIGenerator {
40
+ #private;
41
+ private readonly serializer;
42
+ private readonly converter;
43
+ constructor(options?: OpenAPIGeneratorOptions);
44
+ /**
45
+ * Generates OpenAPI specifications from oRPC routers/contracts.
46
+ *
47
+ * @see {@link https://orpc.unnoq.com/docs/openapi/openapi-specification OpenAPI Specification Docs}
48
+ */
49
+ generate(router: AnyContractRouter | AnyRouter, options?: OpenAPIGeneratorGenerateOptions): Promise<OpenAPIV3_1.Document>;
50
+ }
51
+
52
+ export { OpenAPIGenerator as b, CompositeSchemaConverter as d };
53
+ export type { ConditionalSchemaConverter as C, OpenAPIGeneratorOptions as O, SchemaConvertOptions as S, OpenAPIGeneratorGenerateOptions as a, SchemaConverter as c };
package/dist/shared/openapi.D3j94c9n.d.mts ADDED
@@ -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 };
package/dist/shared/openapi.D3j94c9n.d.ts ADDED
@@ -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 };