@orpc/openapi 0.0.0-next.ff5907c → 0.0.0-next.ff7ad2e

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 (58) 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 +19 -0
  6. package/dist/adapters/fetch/index.d.ts +19 -0
  7. package/dist/adapters/fetch/index.mjs +18 -0
  8. package/dist/adapters/node/index.d.mts +19 -0
  9. package/dist/adapters/node/index.d.ts +19 -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 +69 -0
  18. package/dist/plugins/index.d.ts +69 -0
  19. package/dist/plugins/index.mjs +108 -0
  20. package/dist/shared/openapi.1iT1iSZi.mjs +750 -0
  21. package/dist/{chunk-LPBZEW4B.js → shared/openapi.BVXcB0u4.mjs} +72 -50
  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 +32 -39
  27. package/dist/chunk-UU2TTVB2.js +0 -32
  28. package/dist/chunk-XGHV4TH3.js +0 -13
  29. package/dist/fetch.js +0 -9
  30. package/dist/hono.js +0 -9
  31. package/dist/index.js +0 -701
  32. package/dist/next.js +0 -9
  33. package/dist/node.js +0 -30
  34. package/dist/src/adapters/fetch/index.d.ts +0 -2
  35. package/dist/src/adapters/fetch/openapi-handler.d.ts +0 -11
  36. package/dist/src/adapters/hono/index.d.ts +0 -2
  37. package/dist/src/adapters/next/index.d.ts +0 -2
  38. package/dist/src/adapters/node/index.d.ts +0 -2
  39. package/dist/src/adapters/node/openapi-handler.d.ts +0 -11
  40. package/dist/src/adapters/standard/index.d.ts +0 -4
  41. package/dist/src/adapters/standard/openapi-codec.d.ts +0 -16
  42. package/dist/src/adapters/standard/openapi-handler.d.ts +0 -7
  43. package/dist/src/adapters/standard/openapi-matcher.d.ts +0 -20
  44. package/dist/src/index.d.ts +0 -16
  45. package/dist/src/openapi-content-builder.d.ts +0 -10
  46. package/dist/src/openapi-error.d.ts +0 -3
  47. package/dist/src/openapi-generator.d.ts +0 -67
  48. package/dist/src/openapi-input-structure-parser.d.ts +0 -22
  49. package/dist/src/openapi-operation-extender.d.ts +0 -7
  50. package/dist/src/openapi-output-structure-parser.d.ts +0 -18
  51. package/dist/src/openapi-parameters-builder.d.ts +0 -12
  52. package/dist/src/openapi-path-parser.d.ts +0 -8
  53. package/dist/src/openapi.d.ts +0 -3
  54. package/dist/src/schema-converter.d.ts +0 -16
  55. package/dist/src/schema-utils.d.ts +0 -11
  56. package/dist/src/schema.d.ts +0 -12
  57. package/dist/src/utils.d.ts +0 -4
  58. package/dist/standard.js +0 -10
package/dist/plugins/index.d.mts ADDED
@@ -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.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
+ * 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 };
package/dist/plugins/index.d.ts ADDED
@@ -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.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
+ * 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 };
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.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
+ 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 };