@orpc/openapi 0.0.0-next.c0088c7 → 0.0.0-next.c0afbea
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 +3 -1
- package/dist/adapters/fetch/index.d.mts +1 -1
- package/dist/adapters/fetch/index.d.ts +1 -1
- package/dist/adapters/fetch/index.mjs +2 -2
- package/dist/adapters/hono/index.mjs +2 -2
- package/dist/adapters/next/index.mjs +2 -2
- package/dist/adapters/node/index.d.mts +1 -1
- package/dist/adapters/node/index.d.ts +1 -1
- package/dist/adapters/node/index.mjs +1 -1
- package/dist/adapters/standard/index.d.mts +1 -1
- package/dist/adapters/standard/index.d.ts +1 -1
- package/dist/adapters/standard/index.mjs +1 -1
- package/dist/index.d.mts +4 -4
- package/dist/index.d.ts +4 -4
- package/dist/index.mjs +3 -3
- package/dist/shared/{openapi.DFXD6scT.mjs → openapi.CJTe38Ya.mjs} +9 -12
- package/dist/shared/{openapi.C015V43J.mjs → openapi.CbzTVvGL.mjs} +1 -1
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
|
|
33
33
|
- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
|
|
34
34
|
- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
|
|
35
|
-
- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
|
|
35
|
+
- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
|
|
36
36
|
- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
|
|
37
37
|
- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
|
|
38
38
|
- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
|
|
@@ -55,6 +55,8 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
|
55
55
|
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
|
56
56
|
- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
|
|
57
57
|
- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
|
|
58
|
+
- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
|
|
59
|
+
- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
|
|
58
60
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
59
61
|
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
|
60
62
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
@@ -6,7 +6,7 @@ import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
|
|
|
6
6
|
|
|
7
7
|
declare class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
|
|
8
8
|
private readonly standardHandler;
|
|
9
|
-
constructor(router: Router<
|
|
9
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
|
|
10
10
|
handle(request: Request, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
|
|
11
11
|
}
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@ import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
|
|
|
6
6
|
|
|
7
7
|
declare class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
|
|
8
8
|
private readonly standardHandler;
|
|
9
|
-
constructor(router: Router<
|
|
9
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
|
|
10
10
|
handle(request: Request, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>): Promise<FetchHandleResult>;
|
|
11
11
|
}
|
|
12
12
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
export { O as OpenAPIHandler } from '../../shared/openapi.
|
|
1
|
+
export { O as OpenAPIHandler } from '../../shared/openapi.CbzTVvGL.mjs';
|
|
2
2
|
import '@orpc/openapi-client/standard';
|
|
3
3
|
import '@orpc/server/standard';
|
|
4
4
|
import '@orpc/standard-server-fetch';
|
|
5
|
-
import '../../shared/openapi.
|
|
5
|
+
import '../../shared/openapi.CJTe38Ya.mjs';
|
|
6
6
|
import '@orpc/contract';
|
|
7
7
|
import '@orpc/shared';
|
|
8
8
|
import '@orpc/server';
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
export { O as OpenAPIHandler } from '../../shared/openapi.
|
|
1
|
+
export { O as OpenAPIHandler } from '../../shared/openapi.CbzTVvGL.mjs';
|
|
2
2
|
import '@orpc/openapi-client/standard';
|
|
3
3
|
import '@orpc/server/standard';
|
|
4
4
|
import '@orpc/standard-server-fetch';
|
|
5
|
-
import '../../shared/openapi.
|
|
5
|
+
import '../../shared/openapi.CJTe38Ya.mjs';
|
|
6
6
|
import '@orpc/contract';
|
|
7
7
|
import '@orpc/shared';
|
|
8
8
|
import '@orpc/server';
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
export { O as OpenAPIHandler } from '../../shared/openapi.
|
|
1
|
+
export { O as OpenAPIHandler } from '../../shared/openapi.CbzTVvGL.mjs';
|
|
2
2
|
import '@orpc/openapi-client/standard';
|
|
3
3
|
import '@orpc/server/standard';
|
|
4
4
|
import '@orpc/standard-server-fetch';
|
|
5
|
-
import '../../shared/openapi.
|
|
5
|
+
import '../../shared/openapi.CJTe38Ya.mjs';
|
|
6
6
|
import '@orpc/contract';
|
|
7
7
|
import '@orpc/shared';
|
|
8
8
|
import '@orpc/server';
|
|
@@ -6,7 +6,7 @@ import { SendStandardResponseOptions } from '@orpc/standard-server-node';
|
|
|
6
6
|
|
|
7
7
|
declare class OpenAPIHandler<T extends Context> implements NodeHttpHandler<T> {
|
|
8
8
|
private readonly standardHandler;
|
|
9
|
-
constructor(router: Router<
|
|
9
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
|
|
10
10
|
handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
|
|
11
11
|
}
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@ import { SendStandardResponseOptions } from '@orpc/standard-server-node';
|
|
|
6
6
|
|
|
7
7
|
declare class OpenAPIHandler<T extends Context> implements NodeHttpHandler<T> {
|
|
8
8
|
private readonly standardHandler;
|
|
9
|
-
constructor(router: Router<
|
|
9
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardHandlerOptions<T>>);
|
|
10
10
|
handle(req: NodeHttpRequest, res: NodeHttpResponse, ...[options,]: MaybeOptionalOptions<StandardHandleOptions<T> & SendStandardResponseOptions>): Promise<NodeHttpHandleResult>;
|
|
11
11
|
}
|
|
12
12
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { OpenAPISerializer } from '@orpc/openapi-client/standard';
|
|
2
2
|
import { StandardHandler } from '@orpc/server/standard';
|
|
3
3
|
import { toStandardLazyRequest, sendStandardResponse } from '@orpc/standard-server-node';
|
|
4
|
-
import { a as OpenAPIMatcher, O as OpenAPICodec } from '../../shared/openapi.
|
|
4
|
+
import { a as OpenAPIMatcher, O as OpenAPICodec } from '../../shared/openapi.CJTe38Ya.mjs';
|
|
5
5
|
import '@orpc/shared';
|
|
6
6
|
import 'json-schema-typed/draft-2020-12';
|
|
7
7
|
import '@orpc/contract';
|
|
@@ -16,7 +16,7 @@ declare class OpenAPICodec implements StandardCodec {
|
|
|
16
16
|
declare class OpenAPIMatcher implements StandardMatcher {
|
|
17
17
|
private readonly tree;
|
|
18
18
|
private pendingRouters;
|
|
19
|
-
init(router: AnyRouter, path?: string[]): void;
|
|
19
|
+
init(router: AnyRouter, path?: readonly string[]): void;
|
|
20
20
|
match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
|
|
21
21
|
}
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@ declare class OpenAPICodec implements StandardCodec {
|
|
|
16
16
|
declare class OpenAPIMatcher implements StandardMatcher {
|
|
17
17
|
private readonly tree;
|
|
18
18
|
private pendingRouters;
|
|
19
|
-
init(router: AnyRouter, path?: string[]): void;
|
|
19
|
+
init(router: AnyRouter, path?: readonly string[]): void;
|
|
20
20
|
match(method: string, pathname: HTTPPath): Promise<StandardMatchResult>;
|
|
21
21
|
}
|
|
22
22
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { O as OpenAPICodec, a as OpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.
|
|
1
|
+
export { O as OpenAPICodec, a as OpenAPIMatcher, d as decodeParams, t as toRou3Pattern } from '../../shared/openapi.CJTe38Ya.mjs';
|
|
2
2
|
import '@orpc/contract';
|
|
3
3
|
import '@orpc/shared';
|
|
4
4
|
import '@orpc/server';
|
package/dist/index.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AnyContractProcedure,
|
|
1
|
+
import { AnyContractProcedure, AnySchema, AnyContractRouter, HTTPPath, HTTPMethod } from '@orpc/contract';
|
|
2
2
|
import { OpenAPIV3_1 } from 'openapi-types';
|
|
3
3
|
export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
|
|
4
4
|
import { AnyRouter } from '@orpc/server';
|
|
@@ -32,15 +32,15 @@ interface SchemaConvertOptions {
|
|
|
32
32
|
strategy: 'input' | 'output';
|
|
33
33
|
}
|
|
34
34
|
interface SchemaConverter {
|
|
35
|
-
convert(schema:
|
|
35
|
+
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
|
|
36
36
|
}
|
|
37
37
|
interface ConditionalSchemaConverter extends SchemaConverter {
|
|
38
|
-
condition(schema:
|
|
38
|
+
condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean;
|
|
39
39
|
}
|
|
40
40
|
declare class CompositeSchemaConverter implements SchemaConverter {
|
|
41
41
|
private readonly converters;
|
|
42
42
|
constructor(converters: ConditionalSchemaConverter[]);
|
|
43
|
-
convert(schema:
|
|
43
|
+
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
|
|
44
44
|
}
|
|
45
45
|
|
|
46
46
|
interface OpenAPIGeneratorOptions {
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AnyContractProcedure,
|
|
1
|
+
import { AnyContractProcedure, AnySchema, AnyContractRouter, HTTPPath, HTTPMethod } from '@orpc/contract';
|
|
2
2
|
import { OpenAPIV3_1 } from 'openapi-types';
|
|
3
3
|
export { OpenAPIV3_1 as OpenAPI } from 'openapi-types';
|
|
4
4
|
import { AnyRouter } from '@orpc/server';
|
|
@@ -32,15 +32,15 @@ interface SchemaConvertOptions {
|
|
|
32
32
|
strategy: 'input' | 'output';
|
|
33
33
|
}
|
|
34
34
|
interface SchemaConverter {
|
|
35
|
-
convert(schema:
|
|
35
|
+
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
|
|
36
36
|
}
|
|
37
37
|
interface ConditionalSchemaConverter extends SchemaConverter {
|
|
38
|
-
condition(schema:
|
|
38
|
+
condition(schema: AnySchema | undefined, options: SchemaConvertOptions): boolean;
|
|
39
39
|
}
|
|
40
40
|
declare class CompositeSchemaConverter implements SchemaConverter {
|
|
41
41
|
private readonly converters;
|
|
42
42
|
constructor(converters: ConditionalSchemaConverter[]);
|
|
43
|
-
convert(schema:
|
|
43
|
+
convert(schema: AnySchema | undefined, options: SchemaConvertOptions): [required: boolean, jsonSchema: JSONSchema];
|
|
44
44
|
}
|
|
45
45
|
|
|
46
46
|
interface OpenAPIGeneratorOptions {
|
package/dist/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { isProcedure,
|
|
1
|
+
import { isProcedure, resolveContractProcedures, toHttpPath } from '@orpc/server';
|
|
2
2
|
import { fallbackORPCErrorStatus, fallbackORPCErrorMessage } from '@orpc/client';
|
|
3
3
|
import { fallbackContractConfig, getEventIteratorSchemaDetails } from '@orpc/contract';
|
|
4
4
|
import { OpenAPISerializer } from '@orpc/openapi-client/standard';
|
|
@@ -79,12 +79,12 @@ class OpenAPIGenerator {
|
|
|
79
79
|
const doc = clone(base);
|
|
80
80
|
doc.openapi = "3.1.1";
|
|
81
81
|
const errors = [];
|
|
82
|
-
await
|
|
82
|
+
await resolveContractProcedures({ path: [], router }, ({ contract, path }) => {
|
|
83
83
|
const operationId = path.join(".");
|
|
84
84
|
try {
|
|
85
85
|
const def = contract["~orpc"];
|
|
86
86
|
const method = toOpenAPIMethod(fallbackContractConfig("defaultMethod", def.route.method));
|
|
87
|
-
const httpPath = toOpenAPIPath(def.route.path ??
|
|
87
|
+
const httpPath = toOpenAPIPath(def.route.path ?? toHttpPath(path));
|
|
88
88
|
const operationObjectRef = {
|
|
89
89
|
operationId,
|
|
90
90
|
summary: def.route.summary,
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { fallbackContractConfig } from '@orpc/contract';
|
|
2
2
|
import { isObject } from '@orpc/shared';
|
|
3
|
-
import {
|
|
3
|
+
import { traverseContractProcedures, toHttpPath, isProcedure, getLazyMeta, unlazy, getRouter, createContractedProcedure } from '@orpc/server';
|
|
4
4
|
import { createRouter, addRoute, findRoute } from 'rou3';
|
|
5
5
|
import { s as standardizeHTTPPath } from './openapi.DZzpQAb-.mjs';
|
|
6
6
|
|
|
@@ -81,12 +81,9 @@ class OpenAPIMatcher {
|
|
|
81
81
|
tree = createRouter();
|
|
82
82
|
pendingRouters = [];
|
|
83
83
|
init(router, path = []) {
|
|
84
|
-
const laziedOptions =
|
|
85
|
-
router,
|
|
86
|
-
path
|
|
87
|
-
}, ({ path: path2, contract }) => {
|
|
84
|
+
const laziedOptions = traverseContractProcedures({ router, path }, ({ path: path2, contract }) => {
|
|
88
85
|
const method = fallbackContractConfig("defaultMethod", contract["~orpc"].route.method);
|
|
89
|
-
const httpPath =
|
|
86
|
+
const httpPath = toRou3Pattern(contract["~orpc"].route.path ?? toHttpPath(path2));
|
|
90
87
|
if (isProcedure(contract)) {
|
|
91
88
|
addRoute(this.tree, method, httpPath, {
|
|
92
89
|
path: path2,
|
|
@@ -106,8 +103,8 @@ class OpenAPIMatcher {
|
|
|
106
103
|
});
|
|
107
104
|
this.pendingRouters.push(...laziedOptions.map((option) => ({
|
|
108
105
|
...option,
|
|
109
|
-
httpPathPrefix:
|
|
110
|
-
laziedPrefix:
|
|
106
|
+
httpPathPrefix: toHttpPath(option.path),
|
|
107
|
+
laziedPrefix: getLazyMeta(option.router).prefix
|
|
111
108
|
})));
|
|
112
109
|
}
|
|
113
110
|
async match(method, pathname) {
|
|
@@ -115,7 +112,7 @@ class OpenAPIMatcher {
|
|
|
115
112
|
const newPendingRouters = [];
|
|
116
113
|
for (const pendingRouter of this.pendingRouters) {
|
|
117
114
|
if (!pendingRouter.laziedPrefix || pathname.startsWith(pendingRouter.laziedPrefix) || pathname.startsWith(pendingRouter.httpPathPrefix)) {
|
|
118
|
-
const { default: router } = await unlazy(pendingRouter.
|
|
115
|
+
const { default: router } = await unlazy(pendingRouter.router);
|
|
119
116
|
this.init(router, pendingRouter.path);
|
|
120
117
|
} else {
|
|
121
118
|
newPendingRouters.push(pendingRouter);
|
|
@@ -128,14 +125,14 @@ class OpenAPIMatcher {
|
|
|
128
125
|
return void 0;
|
|
129
126
|
}
|
|
130
127
|
if (!match.data.procedure) {
|
|
131
|
-
const { default: maybeProcedure } = await unlazy(
|
|
128
|
+
const { default: maybeProcedure } = await unlazy(getRouter(match.data.router, match.data.path));
|
|
132
129
|
if (!isProcedure(maybeProcedure)) {
|
|
133
130
|
throw new Error(`
|
|
134
|
-
[Contract-First] Missing or invalid implementation for procedure at path: ${
|
|
131
|
+
[Contract-First] Missing or invalid implementation for procedure at path: ${toHttpPath(match.data.path)}.
|
|
135
132
|
Ensure that the procedure is correctly defined and matches the expected contract.
|
|
136
133
|
`);
|
|
137
134
|
}
|
|
138
|
-
match.data.procedure = createContractedProcedure(match.data.contract
|
|
135
|
+
match.data.procedure = createContractedProcedure(maybeProcedure, match.data.contract);
|
|
139
136
|
}
|
|
140
137
|
return {
|
|
141
138
|
path: match.data.path,
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { OpenAPISerializer } from '@orpc/openapi-client/standard';
|
|
2
2
|
import { StandardHandler } from '@orpc/server/standard';
|
|
3
3
|
import { toStandardLazyRequest, toFetchResponse } from '@orpc/standard-server-fetch';
|
|
4
|
-
import { a as OpenAPIMatcher, O as OpenAPICodec } from './openapi.
|
|
4
|
+
import { a as OpenAPIMatcher, O as OpenAPICodec } from './openapi.CJTe38Ya.mjs';
|
|
5
5
|
import '@orpc/shared';
|
|
6
6
|
import 'json-schema-typed/draft-2020-12';
|
|
7
7
|
|
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.c0afbea",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
|
7
7
|
"repository": {
|
|
@@ -52,14 +52,14 @@
|
|
|
52
52
|
"json-schema-typed": "^8.0.1",
|
|
53
53
|
"openapi-types": "^12.1.3",
|
|
54
54
|
"rou3": "^0.5.1",
|
|
55
|
-
"@orpc/client": "0.0.0-next.
|
|
56
|
-
"@orpc/contract": "0.0.0-next.
|
|
57
|
-
"@orpc/
|
|
58
|
-
"@orpc/
|
|
59
|
-
"@orpc/
|
|
60
|
-
"@orpc/
|
|
61
|
-
"@orpc/standard-server-fetch": "0.0.0-next.
|
|
62
|
-
"@orpc/standard-server-node": "0.0.0-next.
|
|
55
|
+
"@orpc/client": "0.0.0-next.c0afbea",
|
|
56
|
+
"@orpc/contract": "0.0.0-next.c0afbea",
|
|
57
|
+
"@orpc/openapi-client": "0.0.0-next.c0afbea",
|
|
58
|
+
"@orpc/server": "0.0.0-next.c0afbea",
|
|
59
|
+
"@orpc/standard-server": "0.0.0-next.c0afbea",
|
|
60
|
+
"@orpc/shared": "0.0.0-next.c0afbea",
|
|
61
|
+
"@orpc/standard-server-fetch": "0.0.0-next.c0afbea",
|
|
62
|
+
"@orpc/standard-server-node": "0.0.0-next.c0afbea"
|
|
63
63
|
},
|
|
64
64
|
"devDependencies": {
|
|
65
65
|
"zod": "^3.24.2"
|