@orpc/openapi 0.0.0-next.af8ac85 → 0.0.0-next.b0f324e

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 (49) hide show
  1. package/README.md +91 -0
  2. package/dist/adapters/fetch/index.d.mts +14 -0
  3. package/dist/adapters/fetch/index.d.ts +14 -0
  4. package/dist/adapters/fetch/index.mjs +10 -0
  5. package/dist/adapters/hono/index.d.mts +7 -0
  6. package/dist/adapters/hono/index.d.ts +7 -0
  7. package/dist/adapters/hono/index.mjs +10 -0
  8. package/dist/adapters/next/index.d.mts +7 -0
  9. package/dist/adapters/next/index.d.ts +7 -0
  10. package/dist/adapters/next/index.mjs +10 -0
  11. package/dist/adapters/node/index.d.mts +14 -0
  12. package/dist/adapters/node/index.d.ts +14 -0
  13. package/dist/adapters/node/index.mjs +29 -0
  14. package/dist/adapters/standard/index.d.mts +24 -0
  15. package/dist/adapters/standard/index.d.ts +24 -0
  16. package/dist/adapters/standard/index.mjs +7 -0
  17. package/dist/index.d.mts +169 -0
  18. package/dist/index.d.ts +169 -0
  19. package/dist/index.mjs +661 -0
  20. package/dist/shared/openapi.BHG_gu5Z.mjs +8 -0
  21. package/dist/shared/openapi.CDsfPHgw.mjs +148 -0
  22. package/dist/shared/openapi.D0VMNR6V.mjs +25 -0
  23. package/dist/shared/openapi.Dz_6xooR.d.mts +7 -0
  24. package/dist/shared/openapi.Dz_6xooR.d.ts +7 -0
  25. package/package.json +36 -23
  26. package/dist/chunk-KNYXLM77.js +0 -107
  27. package/dist/fetch.js +0 -594
  28. package/dist/index.js +0 -362
  29. package/dist/src/fetch/bracket-notation.d.ts +0 -84
  30. package/dist/src/fetch/index.d.ts +0 -10
  31. package/dist/src/fetch/input-builder-full.d.ts +0 -11
  32. package/dist/src/fetch/input-builder-simple.d.ts +0 -6
  33. package/dist/src/fetch/openapi-handler-server.d.ts +0 -7
  34. package/dist/src/fetch/openapi-handler-serverless.d.ts +0 -7
  35. package/dist/src/fetch/openapi-handler.d.ts +0 -30
  36. package/dist/src/fetch/openapi-payload-codec.d.ts +0 -15
  37. package/dist/src/fetch/openapi-procedure-matcher.d.ts +0 -19
  38. package/dist/src/fetch/schema-coercer.d.ts +0 -10
  39. package/dist/src/index.d.ts +0 -12
  40. package/dist/src/json-serializer.d.ts +0 -5
  41. package/dist/src/openapi-content-builder.d.ts +0 -10
  42. package/dist/src/openapi-generator.d.ts +0 -51
  43. package/dist/src/openapi-parameters-builder.d.ts +0 -9
  44. package/dist/src/openapi-path-parser.d.ts +0 -8
  45. package/dist/src/openapi.d.ts +0 -3
  46. package/dist/src/schema-converter.d.ts +0 -16
  47. package/dist/src/schema-utils.d.ts +0 -11
  48. package/dist/src/schema.d.ts +0 -12
  49. package/dist/src/utils.d.ts +0 -18
@@ -0,0 +1,148 @@
1
+ import { fallbackContractConfig } from '@orpc/contract';
2
+ import { OpenAPISerializer } from '@orpc/openapi-client/standard';
3
+ import { isObject } from '@orpc/shared';
4
+ import { eachContractProcedure, convertPathToHttpPath, isProcedure, getLazyRouterPrefix, unlazy, getRouterChild, createContractedProcedure } from '@orpc/server';
5
+ import { createRouter, addRoute, findRoute } from 'rou3';
6
+ import { s as standardizeHTTPPath } from './openapi.BHG_gu5Z.mjs';
7
+
8
+ class OpenAPICodec {
9
+ constructor(serializer = new OpenAPISerializer()) {
10
+ this.serializer = serializer;
11
+ }
12
+ async decode(request, params, procedure) {
13
+ const inputStructure = fallbackContractConfig("defaultInputStructure", procedure["~orpc"].route.inputStructure);
14
+ if (inputStructure === "compact") {
15
+ const data = request.method === "GET" ? this.serializer.deserialize(request.url.searchParams) : this.serializer.deserialize(await request.body());
16
+ if (data === void 0) {
17
+ return params;
18
+ }
19
+ if (isObject(data)) {
20
+ return {
21
+ ...params,
22
+ ...data
23
+ };
24
+ }
25
+ return data;
26
+ }
27
+ const deserializeSearchParams = () => {
28
+ return this.serializer.deserialize(request.url.searchParams);
29
+ };
30
+ return {
31
+ params,
32
+ get query() {
33
+ const value = deserializeSearchParams();
34
+ Object.defineProperty(this, "query", { value, writable: true });
35
+ return value;
36
+ },
37
+ set query(value) {
38
+ Object.defineProperty(this, "query", { value, writable: true });
39
+ },
40
+ headers: request.headers,
41
+ body: this.serializer.deserialize(await request.body())
42
+ };
43
+ }
44
+ encode(output, procedure) {
45
+ const successStatus = fallbackContractConfig("defaultSuccessStatus", procedure["~orpc"].route.successStatus);
46
+ const outputStructure = fallbackContractConfig("defaultOutputStructure", procedure["~orpc"].route.outputStructure);
47
+ if (outputStructure === "compact") {
48
+ return {
49
+ status: successStatus,
50
+ headers: {},
51
+ body: this.serializer.serialize(output)
52
+ };
53
+ }
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
+ );
58
+ }
59
+ return {
60
+ status: successStatus,
61
+ headers: output.headers ?? {},
62
+ body: this.serializer.serialize(output.body)
63
+ };
64
+ }
65
+ encodeError(error) {
66
+ return {
67
+ status: error.status,
68
+ headers: {},
69
+ body: this.serializer.serialize(error.toJSON())
70
+ };
71
+ }
72
+ }
73
+
74
+ class OpenAPIMatcher {
75
+ tree = createRouter();
76
+ pendingRouters = [];
77
+ init(router, path = []) {
78
+ const laziedOptions = eachContractProcedure({
79
+ router,
80
+ path
81
+ }, ({ path: path2, contract }) => {
82
+ const method = fallbackContractConfig("defaultMethod", contract["~orpc"].route.method);
83
+ const httpPath = contract["~orpc"].route.path ? toRou3Pattern(contract["~orpc"].route.path) : convertPathToHttpPath(path2);
84
+ if (isProcedure(contract)) {
85
+ addRoute(this.tree, method, httpPath, {
86
+ path: path2,
87
+ contract,
88
+ procedure: contract,
89
+ // this mean dev not used contract-first so we can used contract as procedure directly
90
+ router
91
+ });
92
+ } else {
93
+ addRoute(this.tree, method, httpPath, {
94
+ path: path2,
95
+ contract,
96
+ procedure: void 0,
97
+ router
98
+ });
99
+ }
100
+ });
101
+ this.pendingRouters.push(...laziedOptions.map((option) => ({
102
+ ...option,
103
+ httpPathPrefix: convertPathToHttpPath(option.path),
104
+ laziedPrefix: getLazyRouterPrefix(option.lazied)
105
+ })));
106
+ }
107
+ async match(method, pathname) {
108
+ if (this.pendingRouters.length) {
109
+ const newPendingRouters = [];
110
+ for (const pendingRouter of this.pendingRouters) {
111
+ if (!pendingRouter.laziedPrefix || pathname.startsWith(pendingRouter.laziedPrefix) || pathname.startsWith(pendingRouter.httpPathPrefix)) {
112
+ const { default: router } = await unlazy(pendingRouter.lazied);
113
+ this.init(router, pendingRouter.path);
114
+ } else {
115
+ newPendingRouters.push(pendingRouter);
116
+ }
117
+ }
118
+ this.pendingRouters = newPendingRouters;
119
+ }
120
+ const match = findRoute(this.tree, method, pathname);
121
+ if (!match) {
122
+ return void 0;
123
+ }
124
+ if (!match.data.procedure) {
125
+ const { default: maybeProcedure } = await unlazy(getRouterChild(match.data.router, ...match.data.path));
126
+ if (!isProcedure(maybeProcedure)) {
127
+ throw new Error(`
128
+ [Contract-First] Missing or invalid implementation for procedure at path: ${convertPathToHttpPath(match.data.path)}.
129
+ Ensure that the procedure is correctly defined and matches the expected contract.
130
+ `);
131
+ }
132
+ match.data.procedure = createContractedProcedure(match.data.contract, maybeProcedure);
133
+ }
134
+ return {
135
+ path: match.data.path,
136
+ procedure: match.data.procedure,
137
+ params: match.params ? decodeParams(match.params) : void 0
138
+ };
139
+ }
140
+ }
141
+ function toRou3Pattern(path) {
142
+ return standardizeHTTPPath(path).replace(/\{\+([^}]+)\}/g, "**:$1").replace(/\{([^}]+)\}/g, ":$1");
143
+ }
144
+ function decodeParams(params) {
145
+ return Object.fromEntries(Object.entries(params).map(([key, value]) => [key, decodeURIComponent(value)]));
146
+ }
147
+
148
+ export { OpenAPICodec as O, OpenAPIMatcher as a };
@@ -0,0 +1,25 @@
1
+ import { StandardHandler } from '@orpc/server/standard';
2
+ import { toStandardRequest, toFetchResponse } from '@orpc/standard-server-fetch';
3
+ import { a as OpenAPIMatcher, O as OpenAPICodec } from './openapi.CDsfPHgw.mjs';
4
+
5
+ class OpenAPIHandler {
6
+ standardHandler;
7
+ constructor(router, options) {
8
+ const matcher = options?.matcher ?? new OpenAPIMatcher();
9
+ const codec = options?.codec ?? new OpenAPICodec();
10
+ this.standardHandler = new StandardHandler(router, matcher, codec, options);
11
+ }
12
+ async handle(request, ...[options]) {
13
+ const standardRequest = toStandardRequest(request);
14
+ const result = await this.standardHandler.handle(standardRequest, options);
15
+ if (!result.matched) {
16
+ return result;
17
+ }
18
+ return {
19
+ matched: true,
20
+ response: toFetchResponse(result.response, options)
21
+ };
22
+ }
23
+ }
24
+
25
+ export { OpenAPIHandler as O };
@@ -0,0 +1,7 @@
1
+ import { Context } from '@orpc/server';
2
+ import { RPCHandlerOptions } from '@orpc/server/standard';
3
+
4
+ interface OpenAPIHandlerOptions<T extends Context> extends RPCHandlerOptions<T> {
5
+ }
6
+
7
+ export type { OpenAPIHandlerOptions as O };
@@ -0,0 +1,7 @@
1
+ import { Context } from '@orpc/server';
2
+ import { RPCHandlerOptions } from '@orpc/server/standard';
3
+
4
+ interface OpenAPIHandlerOptions<T extends Context> extends RPCHandlerOptions<T> {
5
+ }
6
+
7
+ export type { OpenAPIHandlerOptions as O };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/openapi",
3
3
  "type": "module",
4
- "version": "0.0.0-next.af8ac85",
4
+ "version": "0.0.0-next.b0f324e",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -15,44 +15,57 @@
15
15
  ],
16
16
  "exports": {
17
17
  ".": {
18
- "types": "./dist/src/index.d.ts",
19
- "import": "./dist/index.js",
20
- "default": "./dist/index.js"
18
+ "types": "./dist/index.d.mts",
19
+ "import": "./dist/index.mjs",
20
+ "default": "./dist/index.mjs"
21
+ },
22
+ "./standard": {
23
+ "types": "./dist/adapters/standard/index.d.mts",
24
+ "import": "./dist/adapters/standard/index.mjs",
25
+ "default": "./dist/adapters/standard/index.mjs"
21
26
  },
22
27
  "./fetch": {
23
- "types": "./dist/src/fetch/index.d.ts",
24
- "import": "./dist/fetch.js",
25
- "default": "./dist/fetch.js"
28
+ "types": "./dist/adapters/fetch/index.d.mts",
29
+ "import": "./dist/adapters/fetch/index.mjs",
30
+ "default": "./dist/adapters/fetch/index.mjs"
31
+ },
32
+ "./hono": {
33
+ "types": "./dist/adapters/hono/index.d.mts",
34
+ "import": "./dist/adapters/hono/index.mjs",
35
+ "default": "./dist/adapters/hono/index.mjs"
36
+ },
37
+ "./next": {
38
+ "types": "./dist/adapters/next/index.d.mts",
39
+ "import": "./dist/adapters/next/index.mjs",
40
+ "default": "./dist/adapters/next/index.mjs"
26
41
  },
27
- "./🔒/*": {
28
- "types": "./dist/src/*.d.ts"
42
+ "./node": {
43
+ "types": "./dist/adapters/node/index.d.mts",
44
+ "import": "./dist/adapters/node/index.mjs",
45
+ "default": "./dist/adapters/node/index.mjs"
29
46
  }
30
47
  },
31
48
  "files": [
32
- "!**/*.map",
33
- "!**/*.tsbuildinfo",
34
49
  "dist"
35
50
  ],
36
51
  "dependencies": {
37
- "@standard-schema/spec": "1.0.0-beta.4",
38
- "@types/content-disposition": "^0.5.8",
39
- "content-disposition": "^0.5.4",
40
- "escape-string-regexp": "^5.0.0",
41
- "fast-content-type-parse": "^2.0.0",
42
- "hono": "^4.6.12",
43
52
  "json-schema-typed": "^8.0.1",
44
53
  "openapi3-ts": "^4.4.0",
45
- "wildcard-match": "^5.1.3",
46
- "@orpc/contract": "0.0.0-next.af8ac85",
47
- "@orpc/server": "0.0.0-next.af8ac85",
48
- "@orpc/shared": "0.0.0-next.af8ac85"
54
+ "rou3": "^0.5.1",
55
+ "@orpc/contract": "0.0.0-next.b0f324e",
56
+ "@orpc/openapi-client": "0.0.0-next.b0f324e",
57
+ "@orpc/client": "0.0.0-next.b0f324e",
58
+ "@orpc/server": "0.0.0-next.b0f324e",
59
+ "@orpc/standard-server-fetch": "0.0.0-next.b0f324e",
60
+ "@orpc/shared": "0.0.0-next.b0f324e",
61
+ "@orpc/standard-server-node": "0.0.0-next.b0f324e",
62
+ "@orpc/standard-server": "0.0.0-next.b0f324e"
49
63
  },
50
64
  "devDependencies": {
51
- "@readme/openapi-parser": "^2.6.0",
52
65
  "zod": "^3.24.1"
53
66
  },
54
67
  "scripts": {
55
- "build": "tsup --clean --sourcemap --entry.index=src/index.ts --entry.fetch=src/fetch/index.ts --format=esm --onSuccess='tsc -b --noCheck'",
68
+ "build": "unbuild",
56
69
  "build:watch": "pnpm run build --watch",
57
70
  "type:check": "tsc -b"
58
71
  }
@@ -1,107 +0,0 @@
1
- // src/json-serializer.ts
2
- import { isPlainObject } from "@orpc/shared";
3
- var JSONSerializer = class {
4
- serialize(payload) {
5
- if (payload instanceof Set)
6
- return this.serialize([...payload]);
7
- if (payload instanceof Map)
8
- return this.serialize([...payload.entries()]);
9
- if (Array.isArray(payload)) {
10
- return payload.map((v) => v === void 0 ? "undefined" : this.serialize(v));
11
- }
12
- if (Number.isNaN(payload))
13
- return "NaN";
14
- if (typeof payload === "bigint")
15
- return payload.toString();
16
- if (payload instanceof Date && Number.isNaN(payload.getTime())) {
17
- return "Invalid Date";
18
- }
19
- if (payload instanceof RegExp)
20
- return payload.toString();
21
- if (payload instanceof URL)
22
- return payload.toString();
23
- if (!isPlainObject(payload))
24
- return payload;
25
- return Object.keys(payload).reduce(
26
- (carry, key) => {
27
- const val = payload[key];
28
- carry[key] = this.serialize(val);
29
- return carry;
30
- },
31
- {}
32
- );
33
- }
34
- };
35
-
36
- // src/utils.ts
37
- import { isContractProcedure } from "@orpc/contract";
38
- import { getRouterContract, isLazy, isProcedure, unlazy } from "@orpc/server";
39
- function forEachContractProcedure(options, callback, result = [], isCurrentRouterContract = false) {
40
- const hiddenContract = getRouterContract(options.router);
41
- if (!isCurrentRouterContract && hiddenContract) {
42
- return forEachContractProcedure(
43
- {
44
- path: options.path,
45
- router: hiddenContract
46
- },
47
- callback,
48
- result,
49
- true
50
- );
51
- }
52
- if (isLazy(options.router)) {
53
- result.push({
54
- router: options.router,
55
- path: options.path
56
- });
57
- } else if (isProcedure(options.router)) {
58
- callback({
59
- contract: options.router["~orpc"].contract,
60
- path: options.path
61
- });
62
- } else if (isContractProcedure(options.router)) {
63
- callback({
64
- contract: options.router,
65
- path: options.path
66
- });
67
- } else {
68
- for (const key in options.router) {
69
- forEachContractProcedure(
70
- {
71
- router: options.router[key],
72
- path: [...options.path, key]
73
- },
74
- callback,
75
- result
76
- );
77
- }
78
- }
79
- return result;
80
- }
81
- async function forEachAllContractProcedure(router, callback) {
82
- const pending = [{
83
- path: [],
84
- router
85
- }];
86
- for (const item of pending) {
87
- const lazies = forEachContractProcedure(item, callback);
88
- for (const lazy of lazies) {
89
- const { default: router2 } = await unlazy(lazy.router);
90
- pending.push({
91
- path: lazy.path,
92
- router: router2
93
- });
94
- }
95
- }
96
- }
97
- function standardizeHTTPPath(path) {
98
- return `/${path.replace(/\/{2,}/g, "/").replace(/^\/|\/$/g, "")}`;
99
- }
100
-
101
- export {
102
- JSONSerializer,
103
- forEachContractProcedure,
104
- forEachAllContractProcedure,
105
- standardizeHTTPPath
106
- };
107
- //# sourceMappingURL=chunk-KNYXLM77.js.map