@orpc/openapi 0.0.0-next.1d3318c → 0.0.0-next.1e104eb

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 (34) hide show
  1. package/README.md +30 -20
  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 +17 -8
  6. package/dist/adapters/fetch/index.d.ts +17 -8
  7. package/dist/adapters/fetch/index.mjs +14 -7
  8. package/dist/adapters/node/index.d.mts +17 -8
  9. package/dist/adapters/node/index.d.ts +17 -8
  10. package/dist/adapters/node/index.mjs +9 -24
  11. package/dist/adapters/standard/index.d.mts +10 -15
  12. package/dist/adapters/standard/index.d.ts +10 -15
  13. package/dist/adapters/standard/index.mjs +5 -3
  14. package/dist/index.d.mts +38 -47
  15. package/dist/index.d.ts +38 -47
  16. package/dist/index.mjs +30 -292
  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.CJTe38Ya.mjs → openapi.BVXcB0u4.mjs} +56 -14
  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 +20 -23
  27. package/dist/adapters/hono/index.d.mts +0 -6
  28. package/dist/adapters/hono/index.d.ts +0 -6
  29. package/dist/adapters/hono/index.mjs +0 -11
  30. package/dist/adapters/next/index.d.mts +0 -6
  31. package/dist/adapters/next/index.d.ts +0 -6
  32. package/dist/adapters/next/index.mjs +0 -11
  33. package/dist/shared/openapi.CbzTVvGL.mjs +0 -31
  34. package/dist/shared/openapi.DZzpQAb-.mjs +0 -231
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 };