@orpc/openapi 0.0.0-next.ccd4e42 → 0.0.0-next.ce2f84d
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.
- package/README.md +104 -0
- package/dist/adapters/fetch/index.d.mts +11 -0
- package/dist/adapters/fetch/index.d.ts +11 -0
- package/dist/adapters/fetch/index.mjs +10 -0
- package/dist/adapters/hono/index.d.mts +6 -0
- package/dist/adapters/hono/index.d.ts +6 -0
- package/dist/adapters/hono/index.mjs +10 -0
- package/dist/adapters/next/index.d.mts +6 -0
- package/dist/adapters/next/index.d.ts +6 -0
- package/dist/adapters/next/index.mjs +10 -0
- package/dist/adapters/node/index.d.mts +11 -0
- package/dist/adapters/node/index.d.ts +11 -0
- package/dist/adapters/node/index.mjs +22 -0
- package/dist/adapters/standard/index.d.mts +34 -0
- package/dist/adapters/standard/index.d.ts +34 -0
- package/dist/adapters/standard/index.mjs +7 -0
- package/dist/index.d.mts +114 -0
- package/dist/index.d.ts +114 -0
- package/dist/index.mjs +536 -0
- package/dist/shared/openapi.CGZ7t-VN.mjs +17 -0
- package/dist/shared/openapi.IfmmOyba.d.mts +8 -0
- package/dist/shared/openapi.IfmmOyba.d.ts +8 -0
- package/dist/shared/openapi.sdeu0I7N.mjs +146 -0
- package/package.json +28 -37
- package/dist/chunk-BHJYKXQL.js +0 -52
- package/dist/chunk-HQ34JZI7.js +0 -32
- package/dist/chunk-M5HOHBLW.js +0 -432
- package/dist/fetch.js +0 -9
- package/dist/hono.js +0 -9
- package/dist/index.js +0 -546
- package/dist/next.js +0 -9
- package/dist/node.js +0 -30
- package/dist/src/adapters/fetch/index.d.ts +0 -2
- package/dist/src/adapters/fetch/openapi-handler.d.ts +0 -10
- package/dist/src/adapters/hono/index.d.ts +0 -2
- package/dist/src/adapters/next/index.d.ts +0 -2
- package/dist/src/adapters/node/index.d.ts +0 -2
- package/dist/src/adapters/node/openapi-handler.d.ts +0 -10
- package/dist/src/adapters/standard/bracket-notation.d.ts +0 -84
- package/dist/src/adapters/standard/index.d.ts +0 -7
- package/dist/src/adapters/standard/openapi-codec.d.ts +0 -18
- package/dist/src/adapters/standard/openapi-handler.d.ts +0 -7
- package/dist/src/adapters/standard/openapi-matcher.d.ts +0 -20
- package/dist/src/adapters/standard/openapi-serializer.d.ts +0 -11
- package/dist/src/adapters/standard/schema-coercer.d.ts +0 -10
- package/dist/src/index.d.ts +0 -12
- package/dist/src/json-serializer.d.ts +0 -5
- package/dist/src/openapi-content-builder.d.ts +0 -10
- package/dist/src/openapi-error.d.ts +0 -3
- package/dist/src/openapi-generator.d.ts +0 -67
- package/dist/src/openapi-input-structure-parser.d.ts +0 -22
- package/dist/src/openapi-output-structure-parser.d.ts +0 -18
- package/dist/src/openapi-parameters-builder.d.ts +0 -12
- package/dist/src/openapi-path-parser.d.ts +0 -8
- package/dist/src/openapi.d.ts +0 -3
- package/dist/src/schema-converter.d.ts +0 -16
- package/dist/src/schema-utils.d.ts +0 -11
- package/dist/src/schema.d.ts +0 -12
- package/dist/src/utils.d.ts +0 -3
- package/dist/standard.js +0 -16
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
import { fallbackContractConfig } from '@orpc/contract';
|
|
2
|
+
import { isObject } from '@orpc/shared';
|
|
3
|
+
import { toHttpPath } from '@orpc/client/standard';
|
|
4
|
+
import { traverseContractProcedures, isProcedure, getLazyMeta, unlazy, getRouter, createContractedProcedure } from '@orpc/server';
|
|
5
|
+
import { createRouter, addRoute, findRoute } from 'rou3';
|
|
6
|
+
import { standardizeHTTPPath } from '@orpc/openapi-client/standard';
|
|
7
|
+
|
|
8
|
+
class StandardOpenAPICodec {
|
|
9
|
+
constructor(serializer) {
|
|
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(), { outputFormat: "plain" })
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
function toRou3Pattern(path) {
|
|
75
|
+
return standardizeHTTPPath(path).replace(/\/\{\+([^}]+)\}/g, "/**:$1").replace(/\/\{([^}]+)\}/g, "/:$1");
|
|
76
|
+
}
|
|
77
|
+
function decodeParams(params) {
|
|
78
|
+
return Object.fromEntries(Object.entries(params).map(([key, value]) => [key, decodeURIComponent(value)]));
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
class StandardOpenAPIMatcher {
|
|
82
|
+
tree = createRouter();
|
|
83
|
+
pendingRouters = [];
|
|
84
|
+
init(router, path = []) {
|
|
85
|
+
const laziedOptions = traverseContractProcedures({ router, path }, ({ path: path2, contract }) => {
|
|
86
|
+
const method = fallbackContractConfig("defaultMethod", contract["~orpc"].route.method);
|
|
87
|
+
const httpPath = toRou3Pattern(contract["~orpc"].route.path ?? toHttpPath(path2));
|
|
88
|
+
if (isProcedure(contract)) {
|
|
89
|
+
addRoute(this.tree, method, httpPath, {
|
|
90
|
+
path: path2,
|
|
91
|
+
contract,
|
|
92
|
+
procedure: contract,
|
|
93
|
+
// this mean dev not used contract-first so we can used contract as procedure directly
|
|
94
|
+
router
|
|
95
|
+
});
|
|
96
|
+
} else {
|
|
97
|
+
addRoute(this.tree, method, httpPath, {
|
|
98
|
+
path: path2,
|
|
99
|
+
contract,
|
|
100
|
+
procedure: void 0,
|
|
101
|
+
router
|
|
102
|
+
});
|
|
103
|
+
}
|
|
104
|
+
});
|
|
105
|
+
this.pendingRouters.push(...laziedOptions.map((option) => ({
|
|
106
|
+
...option,
|
|
107
|
+
httpPathPrefix: toHttpPath(option.path),
|
|
108
|
+
laziedPrefix: getLazyMeta(option.router).prefix
|
|
109
|
+
})));
|
|
110
|
+
}
|
|
111
|
+
async match(method, pathname) {
|
|
112
|
+
if (this.pendingRouters.length) {
|
|
113
|
+
const newPendingRouters = [];
|
|
114
|
+
for (const pendingRouter of this.pendingRouters) {
|
|
115
|
+
if (!pendingRouter.laziedPrefix || pathname.startsWith(pendingRouter.laziedPrefix) || pathname.startsWith(pendingRouter.httpPathPrefix)) {
|
|
116
|
+
const { default: router } = await unlazy(pendingRouter.router);
|
|
117
|
+
this.init(router, pendingRouter.path);
|
|
118
|
+
} else {
|
|
119
|
+
newPendingRouters.push(pendingRouter);
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
this.pendingRouters = newPendingRouters;
|
|
123
|
+
}
|
|
124
|
+
const match = findRoute(this.tree, method, pathname);
|
|
125
|
+
if (!match) {
|
|
126
|
+
return void 0;
|
|
127
|
+
}
|
|
128
|
+
if (!match.data.procedure) {
|
|
129
|
+
const { default: maybeProcedure } = await unlazy(getRouter(match.data.router, match.data.path));
|
|
130
|
+
if (!isProcedure(maybeProcedure)) {
|
|
131
|
+
throw new Error(`
|
|
132
|
+
[Contract-First] Missing or invalid implementation for procedure at path: ${toHttpPath(match.data.path)}.
|
|
133
|
+
Ensure that the procedure is correctly defined and matches the expected contract.
|
|
134
|
+
`);
|
|
135
|
+
}
|
|
136
|
+
match.data.procedure = createContractedProcedure(maybeProcedure, match.data.contract);
|
|
137
|
+
}
|
|
138
|
+
return {
|
|
139
|
+
path: match.data.path,
|
|
140
|
+
procedure: match.data.procedure,
|
|
141
|
+
params: match.params ? decodeParams(match.params) : void 0
|
|
142
|
+
};
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
export { StandardOpenAPICodec as S, StandardOpenAPIMatcher as a, decodeParams as d, toRou3Pattern as t };
|
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.
|
|
4
|
+
"version": "0.0.0-next.ce2f84d",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
|
7
7
|
"repository": {
|
|
@@ -15,64 +15,55 @@
|
|
|
15
15
|
],
|
|
16
16
|
"exports": {
|
|
17
17
|
".": {
|
|
18
|
-
"types": "./dist/
|
|
19
|
-
"import": "./dist/index.
|
|
20
|
-
"default": "./dist/index.
|
|
18
|
+
"types": "./dist/index.d.mts",
|
|
19
|
+
"import": "./dist/index.mjs",
|
|
20
|
+
"default": "./dist/index.mjs"
|
|
21
21
|
},
|
|
22
22
|
"./standard": {
|
|
23
|
-
"types": "./dist/
|
|
24
|
-
"import": "./dist/standard.
|
|
25
|
-
"default": "./dist/standard.
|
|
23
|
+
"types": "./dist/adapters/standard/index.d.mts",
|
|
24
|
+
"import": "./dist/adapters/standard/index.mjs",
|
|
25
|
+
"default": "./dist/adapters/standard/index.mjs"
|
|
26
26
|
},
|
|
27
27
|
"./fetch": {
|
|
28
|
-
"types": "./dist/
|
|
29
|
-
"import": "./dist/fetch.
|
|
30
|
-
"default": "./dist/fetch.
|
|
28
|
+
"types": "./dist/adapters/fetch/index.d.mts",
|
|
29
|
+
"import": "./dist/adapters/fetch/index.mjs",
|
|
30
|
+
"default": "./dist/adapters/fetch/index.mjs"
|
|
31
31
|
},
|
|
32
32
|
"./hono": {
|
|
33
|
-
"types": "./dist/
|
|
34
|
-
"import": "./dist/hono.
|
|
35
|
-
"default": "./dist/hono.
|
|
33
|
+
"types": "./dist/adapters/hono/index.d.mts",
|
|
34
|
+
"import": "./dist/adapters/hono/index.mjs",
|
|
35
|
+
"default": "./dist/adapters/hono/index.mjs"
|
|
36
36
|
},
|
|
37
37
|
"./next": {
|
|
38
|
-
"types": "./dist/
|
|
39
|
-
"import": "./dist/next.
|
|
40
|
-
"default": "./dist/next.
|
|
38
|
+
"types": "./dist/adapters/next/index.d.mts",
|
|
39
|
+
"import": "./dist/adapters/next/index.mjs",
|
|
40
|
+
"default": "./dist/adapters/next/index.mjs"
|
|
41
41
|
},
|
|
42
42
|
"./node": {
|
|
43
|
-
"types": "./dist/
|
|
44
|
-
"import": "./dist/node.
|
|
45
|
-
"default": "./dist/node.
|
|
46
|
-
},
|
|
47
|
-
"./🔒/*": {
|
|
48
|
-
"types": "./dist/src/*.d.ts"
|
|
43
|
+
"types": "./dist/adapters/node/index.d.mts",
|
|
44
|
+
"import": "./dist/adapters/node/index.mjs",
|
|
45
|
+
"default": "./dist/adapters/node/index.mjs"
|
|
49
46
|
}
|
|
50
47
|
},
|
|
51
48
|
"files": [
|
|
52
|
-
"!**/*.map",
|
|
53
|
-
"!**/*.tsbuildinfo",
|
|
54
49
|
"dist"
|
|
55
50
|
],
|
|
56
51
|
"dependencies": {
|
|
57
|
-
"@standard-schema/spec": "1.0.0-beta.4",
|
|
58
|
-
"@types/content-disposition": "^0.5.8",
|
|
59
|
-
"content-disposition": "^0.5.4",
|
|
60
|
-
"escape-string-regexp": "^5.0.0",
|
|
61
|
-
"fast-content-type-parse": "^2.0.0",
|
|
62
52
|
"json-schema-typed": "^8.0.1",
|
|
63
|
-
"
|
|
53
|
+
"openapi-types": "^12.1.3",
|
|
64
54
|
"rou3": "^0.5.1",
|
|
65
|
-
"
|
|
66
|
-
"@orpc/contract": "0.0.0-next.
|
|
67
|
-
"@orpc/
|
|
68
|
-
"@orpc/server": "0.0.0-next.
|
|
55
|
+
"@orpc/client": "0.0.0-next.ce2f84d",
|
|
56
|
+
"@orpc/contract": "0.0.0-next.ce2f84d",
|
|
57
|
+
"@orpc/openapi-client": "0.0.0-next.ce2f84d",
|
|
58
|
+
"@orpc/server": "0.0.0-next.ce2f84d",
|
|
59
|
+
"@orpc/shared": "0.0.0-next.ce2f84d",
|
|
60
|
+
"@orpc/standard-server": "0.0.0-next.ce2f84d"
|
|
69
61
|
},
|
|
70
62
|
"devDependencies": {
|
|
71
|
-
"
|
|
72
|
-
"zod": "^3.24.1"
|
|
63
|
+
"zod": "^3.24.2"
|
|
73
64
|
},
|
|
74
65
|
"scripts": {
|
|
75
|
-
"build": "
|
|
66
|
+
"build": "unbuild",
|
|
76
67
|
"build:watch": "pnpm run build --watch",
|
|
77
68
|
"type:check": "tsc -b"
|
|
78
69
|
}
|
package/dist/chunk-BHJYKXQL.js
DELETED
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
var __defProp = Object.defineProperty;
|
|
2
|
-
var __export = (target, all) => {
|
|
3
|
-
for (var name in all)
|
|
4
|
-
__defProp(target, name, { get: all[name], enumerable: true });
|
|
5
|
-
};
|
|
6
|
-
|
|
7
|
-
// src/json-serializer.ts
|
|
8
|
-
import { isPlainObject } from "@orpc/shared";
|
|
9
|
-
var JSONSerializer = class {
|
|
10
|
-
serialize(payload) {
|
|
11
|
-
if (payload instanceof Set)
|
|
12
|
-
return this.serialize([...payload]);
|
|
13
|
-
if (payload instanceof Map)
|
|
14
|
-
return this.serialize([...payload.entries()]);
|
|
15
|
-
if (Array.isArray(payload)) {
|
|
16
|
-
return payload.map((v) => v === void 0 ? "undefined" : this.serialize(v));
|
|
17
|
-
}
|
|
18
|
-
if (Number.isNaN(payload))
|
|
19
|
-
return "NaN";
|
|
20
|
-
if (typeof payload === "bigint")
|
|
21
|
-
return payload.toString();
|
|
22
|
-
if (payload instanceof Date && Number.isNaN(payload.getTime())) {
|
|
23
|
-
return "Invalid Date";
|
|
24
|
-
}
|
|
25
|
-
if (payload instanceof RegExp)
|
|
26
|
-
return payload.toString();
|
|
27
|
-
if (payload instanceof URL)
|
|
28
|
-
return payload.toString();
|
|
29
|
-
if (!isPlainObject(payload))
|
|
30
|
-
return payload;
|
|
31
|
-
return Object.keys(payload).reduce(
|
|
32
|
-
(carry, key) => {
|
|
33
|
-
const val = payload[key];
|
|
34
|
-
carry[key] = this.serialize(val);
|
|
35
|
-
return carry;
|
|
36
|
-
},
|
|
37
|
-
{}
|
|
38
|
-
);
|
|
39
|
-
}
|
|
40
|
-
};
|
|
41
|
-
|
|
42
|
-
// src/utils.ts
|
|
43
|
-
function standardizeHTTPPath(path) {
|
|
44
|
-
return `/${path.replace(/\/{2,}/g, "/").replace(/^\/|\/$/g, "")}`;
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
export {
|
|
48
|
-
__export,
|
|
49
|
-
JSONSerializer,
|
|
50
|
-
standardizeHTTPPath
|
|
51
|
-
};
|
|
52
|
-
//# sourceMappingURL=chunk-BHJYKXQL.js.map
|
package/dist/chunk-HQ34JZI7.js
DELETED
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
import {
|
|
2
|
-
OpenAPICodec,
|
|
3
|
-
OpenAPIMatcher
|
|
4
|
-
} from "./chunk-M5HOHBLW.js";
|
|
5
|
-
|
|
6
|
-
// src/adapters/fetch/openapi-handler.ts
|
|
7
|
-
import { fetchRequestToStandardRequest, standardResponseToFetchResponse } from "@orpc/server/fetch";
|
|
8
|
-
import { StandardHandler } from "@orpc/server/standard";
|
|
9
|
-
var OpenAPIHandler = class {
|
|
10
|
-
standardHandler;
|
|
11
|
-
constructor(router, options) {
|
|
12
|
-
const matcher = options?.matcher ?? new OpenAPIMatcher(options);
|
|
13
|
-
const codec = options?.codec ?? new OpenAPICodec(options);
|
|
14
|
-
this.standardHandler = new StandardHandler(router, matcher, codec, options);
|
|
15
|
-
}
|
|
16
|
-
async handle(request, ...rest) {
|
|
17
|
-
const standardRequest = fetchRequestToStandardRequest(request);
|
|
18
|
-
const result = await this.standardHandler.handle(standardRequest, ...rest);
|
|
19
|
-
if (!result.matched) {
|
|
20
|
-
return result;
|
|
21
|
-
}
|
|
22
|
-
return {
|
|
23
|
-
matched: true,
|
|
24
|
-
response: standardResponseToFetchResponse(result.response)
|
|
25
|
-
};
|
|
26
|
-
}
|
|
27
|
-
};
|
|
28
|
-
|
|
29
|
-
export {
|
|
30
|
-
OpenAPIHandler
|
|
31
|
-
};
|
|
32
|
-
//# sourceMappingURL=chunk-HQ34JZI7.js.map
|