@orpc/openapi 0.0.0-next.4e27480 → 0.0.0-next.4f28b69

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 (65) hide show
  1. package/README.md +101 -0
  2. package/dist/adapters/aws-lambda/index.d.mts +19 -0
  3. package/dist/adapters/aws-lambda/index.d.ts +19 -0
  4. package/dist/adapters/aws-lambda/index.mjs +18 -0
  5. package/dist/adapters/fetch/index.d.mts +22 -0
  6. package/dist/adapters/fetch/index.d.ts +22 -0
  7. package/dist/adapters/fetch/index.mjs +18 -0
  8. package/dist/adapters/node/index.d.mts +22 -0
  9. package/dist/adapters/node/index.d.ts +22 -0
  10. package/dist/adapters/node/index.mjs +18 -0
  11. package/dist/adapters/standard/index.d.mts +29 -0
  12. package/dist/adapters/standard/index.d.ts +29 -0
  13. package/dist/adapters/standard/index.mjs +9 -0
  14. package/dist/index.d.mts +110 -0
  15. package/dist/index.d.ts +110 -0
  16. package/dist/index.mjs +41 -0
  17. package/dist/plugins/index.d.mts +84 -0
  18. package/dist/plugins/index.d.ts +84 -0
  19. package/dist/plugins/index.mjs +148 -0
  20. package/dist/shared/openapi.1iT1iSZi.mjs +750 -0
  21. package/dist/shared/openapi.BVXcB0u4.mjs +187 -0
  22. package/dist/shared/openapi.CQmjvnb0.d.mts +31 -0
  23. package/dist/shared/openapi.CQmjvnb0.d.ts +31 -0
  24. package/dist/shared/openapi.CfjfVeBJ.d.mts +108 -0
  25. package/dist/shared/openapi.CfjfVeBJ.d.ts +108 -0
  26. package/package.json +33 -38
  27. package/dist/chunk-GEDPF5HA.js +0 -25
  28. package/dist/chunk-UG6W4GSA.js +0 -653
  29. package/dist/chunk-V4HFPIEN.js +0 -107
  30. package/dist/fetch.js +0 -34
  31. package/dist/hono.js +0 -34
  32. package/dist/index.js +0 -550
  33. package/dist/next.js +0 -34
  34. package/dist/node.js +0 -46
  35. package/dist/src/adapters/fetch/bracket-notation.d.ts +0 -84
  36. package/dist/src/adapters/fetch/index.d.ts +0 -10
  37. package/dist/src/adapters/fetch/input-structure-compact.d.ts +0 -6
  38. package/dist/src/adapters/fetch/input-structure-detailed.d.ts +0 -11
  39. package/dist/src/adapters/fetch/openapi-handler-server.d.ts +0 -7
  40. package/dist/src/adapters/fetch/openapi-handler-serverless.d.ts +0 -7
  41. package/dist/src/adapters/fetch/openapi-handler.d.ts +0 -32
  42. package/dist/src/adapters/fetch/openapi-payload-codec.d.ts +0 -15
  43. package/dist/src/adapters/fetch/openapi-procedure-matcher.d.ts +0 -19
  44. package/dist/src/adapters/fetch/schema-coercer.d.ts +0 -10
  45. package/dist/src/adapters/hono/index.d.ts +0 -2
  46. package/dist/src/adapters/next/index.d.ts +0 -2
  47. package/dist/src/adapters/node/index.d.ts +0 -5
  48. package/dist/src/adapters/node/openapi-handler-server.d.ts +0 -7
  49. package/dist/src/adapters/node/openapi-handler-serverless.d.ts +0 -7
  50. package/dist/src/adapters/node/openapi-handler.d.ts +0 -11
  51. package/dist/src/adapters/node/types.d.ts +0 -2
  52. package/dist/src/index.d.ts +0 -12
  53. package/dist/src/json-serializer.d.ts +0 -5
  54. package/dist/src/openapi-content-builder.d.ts +0 -10
  55. package/dist/src/openapi-error.d.ts +0 -3
  56. package/dist/src/openapi-generator.d.ts +0 -67
  57. package/dist/src/openapi-input-structure-parser.d.ts +0 -22
  58. package/dist/src/openapi-output-structure-parser.d.ts +0 -18
  59. package/dist/src/openapi-parameters-builder.d.ts +0 -12
  60. package/dist/src/openapi-path-parser.d.ts +0 -8
  61. package/dist/src/openapi.d.ts +0 -3
  62. package/dist/src/schema-converter.d.ts +0 -16
  63. package/dist/src/schema-utils.d.ts +0 -11
  64. package/dist/src/schema.d.ts +0 -12
  65. package/dist/src/utils.d.ts +0 -18
package/dist/plugins/index.d.mts ADDED
@@ -0,0 +1,84 @@
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.CfjfVeBJ.mjs';
6
+ import '@orpc/openapi-client/standard';
7
+ import '@orpc/interop/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
+ * The UI library to use for rendering the API reference.
35
+ *
36
+ * @default 'scalar'
37
+ */
38
+ docsProvider?: 'scalar' | 'swagger';
39
+ /**
40
+ * Arbitrary configuration object for the UI.
41
+ */
42
+ docsConfig?: Value<Promisable<Record<string, unknown>>, [StandardHandlerInterceptorOptions<T>]>;
43
+ /**
44
+ * HTML to inject into the <head> of the docs page.
45
+ *
46
+ * @default ''
47
+ */
48
+ docsHead?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
49
+ /**
50
+ * URL of the external script bundle for the reference UI.
51
+ *
52
+ * - For Scalar: defaults to 'https://cdn.jsdelivr.net/npm/@scalar/api-reference'
53
+ * - For Swagger UI: defaults to 'https://unpkg.com/swagger-ui-dist@5.17.14/swagger-ui-bundle.js'
54
+ */
55
+ docsScriptUrl?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
56
+ /**
57
+ * URL of the external CSS bundle for the reference UI (used by Swagger UI).
58
+ *
59
+ * @default 'https://unpkg.com/swagger-ui-dist@5.17.14/swagger-ui.css' (if swagger)
60
+ */
61
+ docsCssUrl?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
62
+ /**
63
+ * Override function to generate the full HTML for the docs page.
64
+ */
65
+ renderDocsHtml?: (specUrl: string, title: string, head: string, scriptUrl: string, config: Record<string, unknown> | undefined, spec: OpenAPI.Document, docsProvider: 'scalar' | 'swagger', cssUrl: string | undefined) => string;
66
+ }
67
+ declare class OpenAPIReferencePlugin<T extends Context> implements StandardHandlerPlugin<T> {
68
+ private readonly generator;
69
+ private readonly specGenerateOptions;
70
+ private readonly specPath;
71
+ private readonly docsPath;
72
+ private readonly docsTitle;
73
+ private readonly docsHead;
74
+ private readonly docsProvider;
75
+ private readonly docsScriptUrl;
76
+ private readonly docsCssUrl;
77
+ private readonly docsConfig;
78
+ private readonly renderDocsHtml;
79
+ constructor(options?: OpenAPIReferencePluginOptions<T>);
80
+ init(options: StandardHandlerOptions<T>, router: Router<any, T>): void;
81
+ }
82
+
83
+ export { OpenAPIReferencePlugin };
84
+ export type { OpenAPIReferencePluginOptions };
package/dist/plugins/index.d.ts ADDED
@@ -0,0 +1,84 @@
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.CfjfVeBJ.js';
6
+ import '@orpc/openapi-client/standard';
7
+ import '@orpc/interop/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
+ * The UI library to use for rendering the API reference.
35
+ *
36
+ * @default 'scalar'
37
+ */
38
+ docsProvider?: 'scalar' | 'swagger';
39
+ /**
40
+ * Arbitrary configuration object for the UI.
41
+ */
42
+ docsConfig?: Value<Promisable<Record<string, unknown>>, [StandardHandlerInterceptorOptions<T>]>;
43
+ /**
44
+ * HTML to inject into the <head> of the docs page.
45
+ *
46
+ * @default ''
47
+ */
48
+ docsHead?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
49
+ /**
50
+ * URL of the external script bundle for the reference UI.
51
+ *
52
+ * - For Scalar: defaults to 'https://cdn.jsdelivr.net/npm/@scalar/api-reference'
53
+ * - For Swagger UI: defaults to 'https://unpkg.com/swagger-ui-dist@5.17.14/swagger-ui-bundle.js'
54
+ */
55
+ docsScriptUrl?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
56
+ /**
57
+ * URL of the external CSS bundle for the reference UI (used by Swagger UI).
58
+ *
59
+ * @default 'https://unpkg.com/swagger-ui-dist@5.17.14/swagger-ui.css' (if swagger)
60
+ */
61
+ docsCssUrl?: Value<Promisable<string>, [StandardHandlerInterceptorOptions<T>]>;
62
+ /**
63
+ * Override function to generate the full HTML for the docs page.
64
+ */
65
+ renderDocsHtml?: (specUrl: string, title: string, head: string, scriptUrl: string, config: Record<string, unknown> | undefined, spec: OpenAPI.Document, docsProvider: 'scalar' | 'swagger', cssUrl: string | undefined) => string;
66
+ }
67
+ declare class OpenAPIReferencePlugin<T extends Context> implements StandardHandlerPlugin<T> {
68
+ private readonly generator;
69
+ private readonly specGenerateOptions;
70
+ private readonly specPath;
71
+ private readonly docsPath;
72
+ private readonly docsTitle;
73
+ private readonly docsHead;
74
+ private readonly docsProvider;
75
+ private readonly docsScriptUrl;
76
+ private readonly docsCssUrl;
77
+ private readonly docsConfig;
78
+ private readonly renderDocsHtml;
79
+ constructor(options?: OpenAPIReferencePluginOptions<T>);
80
+ init(options: StandardHandlerOptions<T>, router: Router<any, T>): void;
81
+ }
82
+
83
+ export { OpenAPIReferencePlugin };
84
+ export type { OpenAPIReferencePluginOptions };
package/dist/plugins/index.mjs ADDED
@@ -0,0 +1,148 @@
1
+ import { stringifyJSON, once, value } from '@orpc/shared';
2
+ import { O as OpenAPIGenerator } from '../shared/openapi.1iT1iSZi.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 '@orpc/interop/json-schema-typed/draft-2020-12';
9
+
10
+ class OpenAPIReferencePlugin {
11
+ generator;
12
+ specGenerateOptions;
13
+ specPath;
14
+ docsPath;
15
+ docsTitle;
16
+ docsHead;
17
+ docsProvider;
18
+ docsScriptUrl;
19
+ docsCssUrl;
20
+ docsConfig;
21
+ renderDocsHtml;
22
+ constructor(options = {}) {
23
+ this.specGenerateOptions = options.specGenerateOptions;
24
+ this.docsPath = options.docsPath ?? "/";
25
+ this.docsTitle = options.docsTitle ?? "API Reference";
26
+ this.docsConfig = options.docsConfig ?? void 0;
27
+ this.docsProvider = options.docsProvider ?? "scalar";
28
+ this.docsScriptUrl = options.docsScriptUrl ?? (this.docsProvider === "swagger" ? "https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js" : "https://cdn.jsdelivr.net/npm/@scalar/api-reference");
29
+ this.docsCssUrl = options.docsCssUrl ?? (this.docsProvider === "swagger" ? "https://unpkg.com/swagger-ui-dist/swagger-ui.css" : void 0);
30
+ this.docsHead = options.docsHead ?? "";
31
+ this.specPath = options.specPath ?? "/spec.json";
32
+ this.generator = new OpenAPIGenerator(options);
33
+ const esc = (s) => s.replace(/&/g, "&amp;").replace(/"/g, "&quot;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
34
+ this.renderDocsHtml = options.renderDocsHtml ?? ((specUrl, title, head, scriptUrl, config, spec, docsProvider, cssUrl) => {
35
+ let body;
36
+ if (docsProvider === "swagger") {
37
+ const swaggerConfig = {
38
+ dom_id: "#app",
39
+ spec,
40
+ deepLinking: true,
41
+ presets: [
42
+ "SwaggerUIBundle.presets.apis",
43
+ "SwaggerUIBundle.presets.standalone"
44
+ ],
45
+ plugins: [
46
+ "SwaggerUIBundle.plugins.DownloadUrl"
47
+ ],
48
+ ...config
49
+ };
50
+ body = `
51
+ <body>
52
+ <div id="app"></div>
53
+
54
+ <script src="${esc(scriptUrl)}"><\/script>
55
+
56
+ <script>
57
+ window.onload = () => {
58
+ window.ui = SwaggerUIBundle(${stringifyJSON(swaggerConfig).replace(/"(SwaggerUIBundle\.[^"]+)"/g, "$1")})
59
+ }
60
+ <\/script>
61
+ </body>
62
+ `;
63
+ } else {
64
+ const scalarConfig = {
65
+ content: stringifyJSON(spec),
66
+ ...config
67
+ };
68
+ body = `
69
+ <body>
70
+ <div id="app" data-config="${esc(stringifyJSON(scalarConfig))}"></div>
71
+
72
+ <script src="${esc(scriptUrl)}"><\/script>
73
+
74
+ <script>
75
+ Scalar.createApiReference('#app', JSON.parse(document.getElementById('app').dataset.config))
76
+ <\/script>
77
+ </body>
78
+ `;
79
+ }
80
+ return `
81
+ <!doctype html>
82
+ <html>
83
+ <head>
84
+ <meta charset="utf-8" />
85
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
86
+ <title>${esc(title)}</title>
87
+ ${cssUrl ? `<link rel="stylesheet" type="text/css" href="${esc(cssUrl)}" />` : ""}
88
+ ${head}
89
+ </head>
90
+ ${body}
91
+ </html>
92
+ `;
93
+ });
94
+ }
95
+ init(options, router) {
96
+ options.interceptors ??= [];
97
+ options.interceptors.push(async (options2) => {
98
+ const res = await options2.next();
99
+ if (res.matched || options2.request.method !== "GET") {
100
+ return res;
101
+ }
102
+ const prefix = options2.prefix ?? "";
103
+ const requestPathname = options2.request.url.pathname.replace(/\/$/, "") || "/";
104
+ const docsUrl = new URL(`${prefix}${this.docsPath}`.replace(/\/$/, ""), options2.request.url.origin);
105
+ const specUrl = new URL(`${prefix}${this.specPath}`.replace(/\/$/, ""), options2.request.url.origin);
106
+ const generateSpec = once(async () => {
107
+ return await this.generator.generate(router, {
108
+ servers: [{ url: new URL(prefix, options2.request.url.origin).toString() }],
109
+ ...await value(this.specGenerateOptions, options2)
110
+ });
111
+ });
112
+ if (requestPathname === specUrl.pathname) {
113
+ const spec = await generateSpec();
114
+ return {
115
+ matched: true,
116
+ response: {
117
+ status: 200,
118
+ headers: {},
119
+ body: new File([stringifyJSON(spec)], "spec.json", { type: "application/json" })
120
+ }
121
+ };
122
+ }
123
+ if (requestPathname === docsUrl.pathname) {
124
+ const html = this.renderDocsHtml(
125
+ specUrl.toString(),
126
+ await value(this.docsTitle, options2),
127
+ await value(this.docsHead, options2),
128
+ await value(this.docsScriptUrl, options2),
129
+ await value(this.docsConfig, options2),
130
+ await generateSpec(),
131
+ this.docsProvider,
132
+ await value(this.docsCssUrl, options2)
133
+ );
134
+ return {
135
+ matched: true,
136
+ response: {
137
+ status: 200,
138
+ headers: {},
139
+ body: new File([html], "api-reference.html", { type: "text/html" })
140
+ }
141
+ };
142
+ }
143
+ return res;
144
+ });
145
+ }
146
+ }
147
+
148
+ export { OpenAPIReferencePlugin };