@orpc/openapi 0.0.0-next.fe39bf3 → 0.0.0-next.fe5c63f

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 +99 -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/{chunk-LPBZEW4B.js → shared/openapi.BkBlt1Qf.mjs} +72 -50
  21. package/dist/shared/openapi.BtoY8ZFF.mjs +742 -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.DPAN3GVs.d.mts +108 -0
  25. package/dist/shared/openapi.DPAN3GVs.d.ts +108 -0
  26. package/package.json +31 -38
  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
@@ -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.DPAN3GVs.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.DPAN3GVs.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.BtoY8ZFF.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 };
@@ -1,15 +1,15 @@
1
- import {
2
- standardizeHTTPPath
3
- } from "./chunk-XGHV4TH3.js";
1
+ import { standardizeHTTPPath, StandardOpenAPIJsonSerializer, StandardBracketNotationSerializer, StandardOpenAPISerializer } from '@orpc/openapi-client/standard';
2
+ import { StandardHandler } from '@orpc/server/standard';
3
+ import { isORPCErrorStatus } from '@orpc/client';
4
+ import { fallbackContractConfig } from '@orpc/contract';
5
+ import { isObject, stringifyJSON, value } from '@orpc/shared';
6
+ import { toHttpPath } from '@orpc/client/standard';
7
+ import { traverseContractProcedures, isProcedure, getLazyMeta, unlazy, getRouter, createContractedProcedure } from '@orpc/server';
8
+ import { createRouter, addRoute, findRoute } from 'rou3';
4
9
 
5
- // src/adapters/standard/openapi-codec.ts
6
- import { OpenAPISerializer } from "@orpc/client/openapi";
7
- import { fallbackContractConfig } from "@orpc/contract";
8
- import { isObject } from "@orpc/shared";
9
- var OpenAPICodec = class {
10
- serializer;
11
- constructor(options) {
12
- this.serializer = options?.serializer ?? new OpenAPISerializer();
10
+ class StandardOpenAPICodec {
11
+ constructor(serializer) {
12
+ this.serializer = serializer;
13
13
  }
14
14
  async decode(request, params, procedure) {
15
15
  const inputStructure = fallbackContractConfig("defaultInputStructure", procedure["~orpc"].route.inputStructure);
@@ -53,13 +53,21 @@ var OpenAPICodec = class {
53
53
  body: this.serializer.serialize(output)
54
54
  };
55
55
  }
56
- if (!isObject(output)) {
57
- throw new Error(
58
- 'Invalid output structure for "detailed" output. Expected format: { body: any, headers?: Record<string, string | string[] | undefined> }'
59
- );
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
+ `);
60
68
  }
61
69
  return {
62
- status: successStatus,
70
+ status: output.status ?? successStatus,
63
71
  headers: output.headers ?? {},
64
72
  body: this.serializer.serialize(output.body)
65
73
  };
@@ -68,32 +76,45 @@ var OpenAPICodec = class {
68
76
  return {
69
77
  status: error.status,
70
78
  headers: {},
71
- body: this.serializer.serialize(error.toJSON())
79
+ body: this.serializer.serialize(error.toJSON(), { outputFormat: "plain" })
72
80
  };
73
81
  }
74
- };
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
+ }
94
+ }
75
95
 
76
- // src/adapters/standard/openapi-matcher.ts
77
- import { fallbackContractConfig as fallbackContractConfig2 } from "@orpc/contract";
78
- import { convertPathToHttpPath, createContractedProcedure, eachContractProcedure, getLazyRouterPrefix, getRouterChild, isProcedure, unlazy } from "@orpc/server";
79
- import { addRoute, createRouter, findRoute } from "rou3";
80
- var OpenAPIMatcher = class {
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 {
104
+ filter;
81
105
  tree = createRouter();
82
- ignoreUndefinedMethod;
83
- constructor(options) {
84
- this.ignoreUndefinedMethod = options?.ignoreUndefinedMethod ?? false;
85
- }
86
106
  pendingRouters = [];
107
+ constructor(options = {}) {
108
+ this.filter = options.filter ?? true;
109
+ }
87
110
  init(router, path = []) {
88
- const laziedOptions = eachContractProcedure({
89
- router,
90
- path
91
- }, ({ path: path2, contract }) => {
92
- if (!contract["~orpc"].route.method && this.ignoreUndefinedMethod) {
111
+ const laziedOptions = traverseContractProcedures({ router, path }, (traverseOptions) => {
112
+ if (!value(this.filter, traverseOptions)) {
93
113
  return;
94
114
  }
95
- const method = fallbackContractConfig2("defaultMethod", contract["~orpc"].route.method);
96
- const httpPath = contract["~orpc"].route.path ? toRou3Pattern(contract["~orpc"].route.path) : convertPathToHttpPath(path2);
115
+ const { path: path2, contract } = traverseOptions;
116
+ const method = fallbackContractConfig("defaultMethod", contract["~orpc"].route.method);
117
+ const httpPath = toRou3Pattern(contract["~orpc"].route.path ?? toHttpPath(path2));
97
118
  if (isProcedure(contract)) {
98
119
  addRoute(this.tree, method, httpPath, {
99
120
  path: path2,
@@ -113,8 +134,8 @@ var OpenAPIMatcher = class {
113
134
  });
114
135
  this.pendingRouters.push(...laziedOptions.map((option) => ({
115
136
  ...option,
116
- httpPathPrefix: convertPathToHttpPath(option.path),
117
- laziedPrefix: getLazyRouterPrefix(option.lazied)
137
+ httpPathPrefix: toHttpPath(option.path),
138
+ laziedPrefix: getLazyMeta(option.router).prefix
118
139
  })));
119
140
  }
120
141
  async match(method, pathname) {
@@ -122,7 +143,7 @@ var OpenAPIMatcher = class {
122
143
  const newPendingRouters = [];
123
144
  for (const pendingRouter of this.pendingRouters) {
124
145
  if (!pendingRouter.laziedPrefix || pathname.startsWith(pendingRouter.laziedPrefix) || pathname.startsWith(pendingRouter.httpPathPrefix)) {
125
- const { default: router } = await unlazy(pendingRouter.lazied);
146
+ const { default: router } = await unlazy(pendingRouter.router);
126
147
  this.init(router, pendingRouter.path);
127
148
  } else {
128
149
  newPendingRouters.push(pendingRouter);
@@ -135,14 +156,14 @@ var OpenAPIMatcher = class {
135
156
  return void 0;
136
157
  }
137
158
  if (!match.data.procedure) {
138
- const { default: maybeProcedure } = await unlazy(getRouterChild(match.data.router, ...match.data.path));
159
+ const { default: maybeProcedure } = await unlazy(getRouter(match.data.router, match.data.path));
139
160
  if (!isProcedure(maybeProcedure)) {
140
161
  throw new Error(`
141
- [Contract-First] Missing or invalid implementation for procedure at path: ${convertPathToHttpPath(match.data.path)}.
162
+ [Contract-First] Missing or invalid implementation for procedure at path: ${toHttpPath(match.data.path)}.
142
163
  Ensure that the procedure is correctly defined and matches the expected contract.
143
164
  `);
144
165
  }
145
- match.data.procedure = createContractedProcedure(match.data.contract, maybeProcedure);
166
+ match.data.procedure = createContractedProcedure(maybeProcedure, match.data.contract);
146
167
  }
147
168
  return {
148
169
  path: match.data.path,
@@ -150,16 +171,17 @@ var OpenAPIMatcher = class {
150
171
  params: match.params ? decodeParams(match.params) : void 0
151
172
  };
152
173
  }
153
- };
154
- function toRou3Pattern(path) {
155
- return standardizeHTTPPath(path).replace(/\{\+([^}]+)\}/g, "**:$1").replace(/\{([^}]+)\}/g, ":$1");
156
174
  }
157
- function decodeParams(params) {
158
- return Object.fromEntries(Object.entries(params).map(([key, value]) => [key, decodeURIComponent(value)]));
175
+
176
+ class StandardOpenAPIHandler extends StandardHandler {
177
+ constructor(router, options) {
178
+ const jsonSerializer = new StandardOpenAPIJsonSerializer(options);
179
+ const bracketNotationSerializer = new StandardBracketNotationSerializer(options);
180
+ const serializer = new StandardOpenAPISerializer(jsonSerializer, bracketNotationSerializer);
181
+ const matcher = new StandardOpenAPIMatcher(options);
182
+ const codec = new StandardOpenAPICodec(serializer);
183
+ super(router, matcher, codec, options);
184
+ }
159
185
  }
160
186
 
161
- export {
162
- OpenAPICodec,
163
- OpenAPIMatcher
164
- };
165
- //# sourceMappingURL=chunk-LPBZEW4B.js.map
187
+ export { StandardOpenAPICodec as S, StandardOpenAPIHandler as a, StandardOpenAPIMatcher as b, decodeParams as d, toRou3Pattern as t };