@orpc/trpc 1.14.11 → 1.14.12
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 +48 -52
- package/dist/index.d.mts +10 -34
- package/dist/index.d.ts +10 -34
- package/dist/index.mjs +39 -42
- package/package.json +6 -7
package/README.md
CHANGED
|
@@ -1,16 +1,17 @@
|
|
|
1
|
-
<
|
|
1
|
+
<div align="center">
|
|
2
|
+
<image align="center" src="https://orpc.dev/logo.webp" width=280 alt="oRPC logo" />
|
|
3
|
+
</div>
|
|
4
|
+
|
|
5
|
+
<h1></h1>
|
|
2
6
|
|
|
3
7
|
<div align="center">
|
|
4
8
|
<a href="https://codecov.io/gh/middleapi/orpc">
|
|
5
|
-
<img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/
|
|
9
|
+
<img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/1.x/graph/badge.svg">
|
|
6
10
|
</a>
|
|
7
11
|
<a href="https://www.npmjs.com/package/@orpc/trpc">
|
|
8
12
|
<img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Ftrpc?logo=npm" />
|
|
9
13
|
</a>
|
|
10
|
-
<a href="https://
|
|
11
|
-
<img alt="CodSpeed" src="https://img.shields.io/endpoint?url=https://codspeed.io/badge.json" />
|
|
12
|
-
</a>
|
|
13
|
-
<a href="https://github.com/middleapi/orpc/blob/main/LICENSE">
|
|
14
|
+
<a href="https://github.com/middleapi/orpc/blob/1.x/LICENSE">
|
|
14
15
|
<img alt="MIT License" src="https://img.shields.io/github/license/middleapi/orpc?logo=open-source-initiative" />
|
|
15
16
|
</a>
|
|
16
17
|
<a href="https://discord.gg/TXEbwRBvQn">
|
|
@@ -21,53 +22,55 @@
|
|
|
21
22
|
</a>
|
|
22
23
|
</div>
|
|
23
24
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
You can read the documentation [here](https://orpc.dev).
|
|
27
|
-
|
|
28
|
-
## Packages
|
|
29
|
-
|
|
30
|
-
**Core**
|
|
25
|
+
<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
|
|
31
26
|
|
|
32
|
-
|
|
33
|
-
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build APIs or implement contracts.
|
|
34
|
-
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume APIs with end-to-end type safety.
|
|
35
|
-
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Add OpenAPI compatibility to APIs.
|
|
27
|
+
**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
|
|
36
28
|
|
|
37
|
-
|
|
29
|
+
---
|
|
38
30
|
|
|
39
|
-
|
|
40
|
-
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): Integrate with [Valibot](https://valibot.dev/).
|
|
41
|
-
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): Integrate with [ArkType](https://arktype.io/).
|
|
31
|
+
## Highlights
|
|
42
32
|
|
|
43
|
-
|
|
33
|
+
- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
|
|
34
|
+
- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
|
|
35
|
+
- **📝 Contract-First Development**: Optionally define your API contract before implementation.
|
|
36
|
+
- **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
|
|
37
|
+
- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), SWR, Pinia Colada, and more.
|
|
38
|
+
- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
|
|
39
|
+
- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
|
|
40
|
+
- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
|
|
41
|
+
- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
|
|
42
|
+
- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
|
|
43
|
+
- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
|
|
44
|
+
- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
|
|
44
45
|
|
|
45
|
-
|
|
46
|
-
- [@orpc/ratelimit](https://www.npmjs.com/package/@orpc/ratelimit): Rate limiting with memory, Redis, and Upstash adapters.
|
|
47
|
-
- [@orpc/json-schema](https://www.npmjs.com/package/@orpc/json-schema): Smart coercion for OpenAPI requests.
|
|
48
|
-
|
|
49
|
-
**Framework & ecosystem integrations**
|
|
46
|
+
## Documentation
|
|
50
47
|
|
|
51
|
-
|
|
52
|
-
- [@orpc/ai-sdk](https://www.npmjs.com/package/@orpc/ai-sdk): Turn contracts and procedures into [AI SDK](https://ai-sdk.dev/) tools.
|
|
53
|
-
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): Integrate with [TanStack Query](https://tanstack.com/query/latest).
|
|
54
|
-
- [@orpc/pinia-colada](https://www.npmjs.com/package/@orpc/pinia-colada): Integrate with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
55
|
-
- [@orpc/swr](https://www.npmjs.com/package/@orpc/swr): Integrate with [SWR](https://swr.vercel.app/).
|
|
56
|
-
- [@orpc/experimental-effect](https://www.npmjs.com/package/@orpc/experimental-effect): Integrate with [Effect](https://effect.website/).
|
|
57
|
-
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Implement your contract with [NestJS](https://nestjs.com/).
|
|
58
|
-
- [@orpc/bun](https://www.npmjs.com/package/@orpc/bun): Adapters for [Bun's Redis](https://bun.sh/).
|
|
59
|
-
- [@orpc/cloudflare](https://www.npmjs.com/package/@orpc/cloudflare): Adapters for [Cloudflare's RateLimit and Durable Objects](https://developers.cloudflare.com/workers/).
|
|
60
|
-
- [@orpc/trpc](https://www.npmjs.com/package/@orpc/trpc): Reuse existing [tRPC](https://trpc.io/) routers within oRPC.
|
|
48
|
+
You can find the full documentation [here](https://orpc.dev).
|
|
61
49
|
|
|
62
|
-
|
|
50
|
+
## Packages
|
|
63
51
|
|
|
64
|
-
- [@orpc/
|
|
65
|
-
- [@orpc/
|
|
66
|
-
- [@orpc/
|
|
52
|
+
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
|
53
|
+
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
|
54
|
+
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
|
55
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
|
56
|
+
- [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
|
|
57
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
|
|
58
|
+
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
|
59
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
|
|
60
|
+
- [@orpc/experimental-react-swr](https://www.npmjs.com/package/@orpc/experimental-react-swr): [SWR](https://swr.vercel.app/) integration.
|
|
61
|
+
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
62
|
+
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
|
63
|
+
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
|
64
|
+
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
|
65
|
+
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
|
66
|
+
|
|
67
|
+
## `@orpc/trpc`
|
|
68
|
+
|
|
69
|
+
Bridge between [tRPC](https://trpc.io/) and oRPC
|
|
67
70
|
|
|
68
71
|
## Sponsors
|
|
69
72
|
|
|
70
|
-
|
|
73
|
+
If you find oRPC valuable and would like to support its development, you can do so here: [GitHub Sponsors](https://github.com/sponsors/dinwwwh).
|
|
71
74
|
|
|
72
75
|
### 🏆 Platinum Sponsor
|
|
73
76
|
|
|
@@ -109,10 +112,11 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
109
112
|
<td align="center"><a href="https://github.com/valerii15298?ref=orpc" target="_blank" rel="noopener" title="Valerii Petryniak"><img src="https://avatars.githubusercontent.com/u/44531564?u=88ac74d9bacd20401518441907acad21063cd397&v=4" width="139" alt="Valerii Petryniak"/><br />Valerii Petryniak</a></td>
|
|
110
113
|
<td align="center"><a href="https://github.com/letstri?ref=orpc" target="_blank" rel="noopener" title="Valerii Strilets"><img src="https://avatars.githubusercontent.com/u/13253748?u=c7b10399ccc8f8081e24db94ec32cd9858e86ac3&v=4" width="139" alt="Valerii Strilets"/><br />Valerii Strilets</a></td>
|
|
111
114
|
<td align="center"><a href="https://github.com/K-Mistele?ref=orpc" target="_blank" rel="noopener" title="Kyle Mistele"><img src="https://avatars.githubusercontent.com/u/18430555?u=3afebeb81de666e35aaac3ed46f14159d7603ffb&v=4" width="139" alt="Kyle Mistele"/><br />Kyle Mistele</a></td>
|
|
115
|
+
<td align="center"><a href="https://github.com/R44VC0RP?ref=orpc" target="_blank" rel="noopener" title="Ryan Vogel"><img src="https://avatars.githubusercontent.com/u/89211796?u=1857347b9787d8d8a7ea5bfc333f96be92d5a683&v=4" width="139" alt="Ryan Vogel"/><br />Ryan Vogel</a></td>
|
|
112
116
|
<td align="center"><a href="https://github.com/christ12938?ref=orpc" target="_blank" rel="noopener" title="christ12938"><img src="https://avatars.githubusercontent.com/u/25758598?v=4" width="139" alt="christ12938"/><br />christ12938</a></td>
|
|
113
|
-
<td align="center"><a href="https://github.com/Ryanjso?ref=orpc" target="_blank" rel="noopener" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&v=4" width="139" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
|
|
114
117
|
</tr>
|
|
115
118
|
<tr>
|
|
119
|
+
<td align="center"><a href="https://github.com/Ryanjso?ref=orpc" target="_blank" rel="noopener" title="Ryan Soderberg"><img src="https://avatars.githubusercontent.com/u/39172778?u=5ed913c31d57e7221b75784abcad48c7ebddde27&v=4" width="139" alt="Ryan Soderberg"/><br />Ryan Soderberg</a></td>
|
|
116
120
|
<td align="center"><a href="https://github.com/itigoore01?ref=orpc" target="_blank" rel="noopener" title="shota"><img src="https://avatars.githubusercontent.com/u/11831107?u=c976a6dc7e055eb026304c46c99100ed22b0c8e0&v=4" width="139" alt="shota"/><br />shota</a></td>
|
|
117
121
|
</tr>
|
|
118
122
|
</table>
|
|
@@ -172,7 +176,6 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
172
176
|
<a href="https://github.com/nguyenlc1993?ref=orpc" target="_blank" rel="noopener" title="Lê Cao Nguyên"><img src="https://avatars.githubusercontent.com/u/13871971?u=83c8b69d9e35b589c4e1f066cc113b1d9461386f&v=4" width="32" height="32" alt="Lê Cao Nguyên" /></a>
|
|
173
177
|
<a href="https://github.com/wobsoriano?ref=orpc" target="_blank" rel="noopener" title="Robert Soriano"><img src="https://avatars.githubusercontent.com/u/13049130?u=6d72104182e7c9ed25934815313fb69107332111&v=4" width="32" height="32" alt="Robert Soriano" /></a>
|
|
174
178
|
<a href="https://github.com/andrewpeters9?ref=orpc" target="_blank" rel="noopener" title="Andrew Peters"><img src="https://avatars.githubusercontent.com/u/36251325?v=4" width="32" height="32" alt="Andrew Peters" /></a>
|
|
175
|
-
<a href="https://github.com/R44VC0RP?ref=orpc" target="_blank" rel="noopener" title="Ryan Vogel"><img src="https://avatars.githubusercontent.com/u/89211796?u=1857347b9787d8d8a7ea5bfc333f96be92d5a683&v=4" width="32" height="32" alt="Ryan Vogel" /></a>
|
|
176
179
|
<a href="https://github.com/SKostyukovich?ref=orpc" target="_blank" rel="noopener" title="SKostyukovich"><img src="https://avatars.githubusercontent.com/u/10700067?v=4" width="32" height="32" alt="SKostyukovich" /></a>
|
|
177
180
|
<a href="https://github.com/peter-adam-dy?ref=orpc" target="_blank" rel="noopener" title="Peter Adam"><img src="https://avatars.githubusercontent.com/u/132129459?u=4f3dbbb3b443990b56acb7d6a5d11ed2c555f6db&v=4" width="32" height="32" alt="Peter Adam" /></a>
|
|
178
181
|
<a href="https://github.com/FabworksHQ?ref=orpc" target="_blank" rel="noopener" title="Fabworks"><img src="https://avatars.githubusercontent.com/u/160179500?v=4" width="32" height="32" alt="Fabworks" /></a>
|
|
@@ -187,13 +190,6 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
|
|
|
187
190
|
<a href="https://github.com/plancraft?ref=orpc" target="_blank" rel="noopener" title="plancraft"><img src="https://avatars.githubusercontent.com/u/46482287?v=4" width="32" height="32" alt="plancraft" /></a>
|
|
188
191
|
</p>
|
|
189
192
|
|
|
190
|
-
## References
|
|
191
|
-
|
|
192
|
-
oRPC is inspired by existing solutions that prioritize type safety and developer experience. Special acknowledgments to:
|
|
193
|
-
|
|
194
|
-
- [tRPC](https://trpc.io): For pioneering the concept of end-to-end type-safe RPC and influencing the development of type-safe APIs.
|
|
195
|
-
- [ts-rest](https://ts-rest.com): For its emphasis on contract-first development and OpenAPI integration, which have greatly inspired oRPC's feature set.
|
|
196
|
-
|
|
197
193
|
## License
|
|
198
194
|
|
|
199
|
-
Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/
|
|
195
|
+
Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/1.x/LICENSE) for more information.
|
package/dist/index.d.mts
CHANGED
|
@@ -1,45 +1,21 @@
|
|
|
1
1
|
import { AsyncIteratorClass } from '@orpc/shared';
|
|
2
2
|
import { AnyProcedure, AnyRouter, inferRouterContext } from '@trpc/server';
|
|
3
|
+
import { inferRouterMeta } from '@trpc/server/unstable-core-do-not-import';
|
|
3
4
|
import * as ORPC from '@orpc/server';
|
|
4
|
-
import { AnyMetaPlugin } from '@orpc/contract';
|
|
5
5
|
|
|
6
|
+
interface ORPCMeta {
|
|
7
|
+
route?: ORPC.Route;
|
|
8
|
+
}
|
|
6
9
|
type ToORPCOutput<T> = T extends AsyncIterable<infer TData, infer TReturn, infer TNext> ? AsyncIteratorClass<TData, TReturn, TNext> : T;
|
|
7
|
-
type ToORPCRouterResult<TContext extends ORPC.Context, TRecord extends Record<string, any>> = {
|
|
8
|
-
[K in keyof TRecord]: TRecord[K] extends AnyProcedure ? ORPC.Procedure<TContext, object, ORPC.Schema<TRecord[K]['_def']['$types']['input'], unknown>, ORPC.Schema<unknown, ToORPCOutput<TRecord[K]['_def']['$types']['output']>>, object,
|
|
10
|
+
type ToORPCRouterResult<TContext extends ORPC.Context, TMeta extends ORPC.Meta, TRecord extends Record<string, any>> = {
|
|
11
|
+
[K in keyof TRecord]: TRecord[K] extends AnyProcedure ? ORPC.Procedure<TContext, object, ORPC.Schema<TRecord[K]['_def']['$types']['input'], unknown>, ORPC.Schema<unknown, ToORPCOutput<TRecord[K]['_def']['$types']['output']>>, object, TMeta> : TRecord[K] extends Record<string, any> ? ToORPCRouterResult<TContext, TMeta, TRecord[K]> : never;
|
|
9
12
|
};
|
|
10
13
|
/**
|
|
11
14
|
* Convert a tRPC router to an oRPC router.
|
|
12
|
-
*/
|
|
13
|
-
declare function toORPCRouter<T extends AnyRouter>(router: T): ToORPCRouterResult<inferRouterContext<T>, T['_def']['record']>;
|
|
14
|
-
|
|
15
|
-
/**
|
|
16
|
-
* Resolve oRPC meta plugins into a plain meta object usable as tRPC meta.
|
|
17
|
-
*
|
|
18
|
-
* This simulates how oRPC builders apply meta plugins, so well-known plugins
|
|
19
|
-
* like `openapi` from `@orpc/openapi` can be used with tRPC builders.
|
|
20
|
-
*
|
|
21
|
-
* @example
|
|
22
|
-
* ```ts
|
|
23
|
-
* const example = t.procedure
|
|
24
|
-
* .meta(toTRPCMeta(openapi({ path: '/hello' })))
|
|
25
|
-
* .query(() => 'Hello, World!')
|
|
26
|
-
*
|
|
27
|
-
* const merged = t.procedure
|
|
28
|
-
* .meta({
|
|
29
|
-
* ...toTRPCMeta(
|
|
30
|
-
* openapi({ path: '/hello' }),
|
|
31
|
-
* openapi({ method: 'POST' }),
|
|
32
|
-
* ),
|
|
33
|
-
* other: 'value',
|
|
34
|
-
* })
|
|
35
|
-
* .mutation(() => 'Hello, World!')
|
|
36
|
-
* ```
|
|
37
15
|
*
|
|
38
|
-
* @warning
|
|
39
|
-
* (e.g. accumulating openapi `tags`) only works within a single `toTRPCMeta`
|
|
40
|
-
* call.
|
|
16
|
+
* @warning You should set the `meta` type to `ORPCMeta` when creating your tRPC builder, to ensure OpenAPI features work correctly.
|
|
41
17
|
*/
|
|
42
|
-
declare function
|
|
18
|
+
declare function toORPCRouter<T extends AnyRouter>(router: T): ToORPCRouterResult<inferRouterContext<T>, inferRouterMeta<T>, T['_def']['record']>;
|
|
43
19
|
|
|
44
|
-
export { toORPCRouter
|
|
45
|
-
export type { ToORPCOutput, ToORPCRouterResult };
|
|
20
|
+
export { toORPCRouter };
|
|
21
|
+
export type { ORPCMeta, ToORPCOutput, ToORPCRouterResult };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,45 +1,21 @@
|
|
|
1
1
|
import { AsyncIteratorClass } from '@orpc/shared';
|
|
2
2
|
import { AnyProcedure, AnyRouter, inferRouterContext } from '@trpc/server';
|
|
3
|
+
import { inferRouterMeta } from '@trpc/server/unstable-core-do-not-import';
|
|
3
4
|
import * as ORPC from '@orpc/server';
|
|
4
|
-
import { AnyMetaPlugin } from '@orpc/contract';
|
|
5
5
|
|
|
6
|
+
interface ORPCMeta {
|
|
7
|
+
route?: ORPC.Route;
|
|
8
|
+
}
|
|
6
9
|
type ToORPCOutput<T> = T extends AsyncIterable<infer TData, infer TReturn, infer TNext> ? AsyncIteratorClass<TData, TReturn, TNext> : T;
|
|
7
|
-
type ToORPCRouterResult<TContext extends ORPC.Context, TRecord extends Record<string, any>> = {
|
|
8
|
-
[K in keyof TRecord]: TRecord[K] extends AnyProcedure ? ORPC.Procedure<TContext, object, ORPC.Schema<TRecord[K]['_def']['$types']['input'], unknown>, ORPC.Schema<unknown, ToORPCOutput<TRecord[K]['_def']['$types']['output']>>, object,
|
|
10
|
+
type ToORPCRouterResult<TContext extends ORPC.Context, TMeta extends ORPC.Meta, TRecord extends Record<string, any>> = {
|
|
11
|
+
[K in keyof TRecord]: TRecord[K] extends AnyProcedure ? ORPC.Procedure<TContext, object, ORPC.Schema<TRecord[K]['_def']['$types']['input'], unknown>, ORPC.Schema<unknown, ToORPCOutput<TRecord[K]['_def']['$types']['output']>>, object, TMeta> : TRecord[K] extends Record<string, any> ? ToORPCRouterResult<TContext, TMeta, TRecord[K]> : never;
|
|
9
12
|
};
|
|
10
13
|
/**
|
|
11
14
|
* Convert a tRPC router to an oRPC router.
|
|
12
|
-
*/
|
|
13
|
-
declare function toORPCRouter<T extends AnyRouter>(router: T): ToORPCRouterResult<inferRouterContext<T>, T['_def']['record']>;
|
|
14
|
-
|
|
15
|
-
/**
|
|
16
|
-
* Resolve oRPC meta plugins into a plain meta object usable as tRPC meta.
|
|
17
|
-
*
|
|
18
|
-
* This simulates how oRPC builders apply meta plugins, so well-known plugins
|
|
19
|
-
* like `openapi` from `@orpc/openapi` can be used with tRPC builders.
|
|
20
|
-
*
|
|
21
|
-
* @example
|
|
22
|
-
* ```ts
|
|
23
|
-
* const example = t.procedure
|
|
24
|
-
* .meta(toTRPCMeta(openapi({ path: '/hello' })))
|
|
25
|
-
* .query(() => 'Hello, World!')
|
|
26
|
-
*
|
|
27
|
-
* const merged = t.procedure
|
|
28
|
-
* .meta({
|
|
29
|
-
* ...toTRPCMeta(
|
|
30
|
-
* openapi({ path: '/hello' }),
|
|
31
|
-
* openapi({ method: 'POST' }),
|
|
32
|
-
* ),
|
|
33
|
-
* other: 'value',
|
|
34
|
-
* })
|
|
35
|
-
* .mutation(() => 'Hello, World!')
|
|
36
|
-
* ```
|
|
37
15
|
*
|
|
38
|
-
* @warning
|
|
39
|
-
* (e.g. accumulating openapi `tags`) only works within a single `toTRPCMeta`
|
|
40
|
-
* call.
|
|
16
|
+
* @warning You should set the `meta` type to `ORPCMeta` when creating your tRPC builder, to ensure OpenAPI features work correctly.
|
|
41
17
|
*/
|
|
42
|
-
declare function
|
|
18
|
+
declare function toORPCRouter<T extends AnyRouter>(router: T): ToORPCRouterResult<inferRouterContext<T>, inferRouterMeta<T>, T['_def']['record']>;
|
|
43
19
|
|
|
44
|
-
export { toORPCRouter
|
|
45
|
-
export type { ToORPCOutput, ToORPCRouterResult };
|
|
20
|
+
export { toORPCRouter };
|
|
21
|
+
export type { ORPCMeta, ToORPCOutput, ToORPCRouterResult };
|
package/dist/index.mjs
CHANGED
|
@@ -1,22 +1,26 @@
|
|
|
1
|
+
import { mapEventIterator } from '@orpc/client';
|
|
1
2
|
import * as ORPC from '@orpc/server';
|
|
2
|
-
import {
|
|
3
|
+
import { get, isObject, isTypescriptObject } from '@orpc/shared';
|
|
3
4
|
import { isTrackedEnvelope, TRPCError } from '@trpc/server';
|
|
4
|
-
import {
|
|
5
|
-
import { resolveMetaPlugins } from '@orpc/contract';
|
|
5
|
+
import { isAsyncIterable, getHTTPStatusCodeFromError } from '@trpc/server/unstable-core-do-not-import';
|
|
6
6
|
|
|
7
7
|
function toORPCRouter(router) {
|
|
8
|
-
const result =
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
8
|
+
const result = {
|
|
9
|
+
...lazyToORPCRouter(router._def.lazy),
|
|
10
|
+
...recordToORPCRouterRecord(router._def.record)
|
|
11
|
+
};
|
|
12
|
+
return result;
|
|
13
|
+
}
|
|
14
|
+
function lazyToORPCRouter(lazies) {
|
|
15
|
+
const orpcRouter = {};
|
|
16
|
+
for (const key in lazies) {
|
|
17
|
+
const item = lazies[key];
|
|
18
|
+
orpcRouter[key] = ORPC.createAccessibleLazyRouter(ORPC.lazy(async () => {
|
|
19
|
+
const router = await item.ref();
|
|
20
|
+
return { default: toORPCRouter(router) };
|
|
17
21
|
}));
|
|
18
22
|
}
|
|
19
|
-
return
|
|
23
|
+
return orpcRouter;
|
|
20
24
|
}
|
|
21
25
|
function recordToORPCRouterRecord(records) {
|
|
22
26
|
const orpcRouter = {};
|
|
@@ -31,18 +35,17 @@ function recordToORPCRouterRecord(records) {
|
|
|
31
35
|
return orpcRouter;
|
|
32
36
|
}
|
|
33
37
|
function toORPCProcedure(procedure) {
|
|
34
|
-
const inputSchema = toStandardSchema(procedure._def.inputs.at(-1));
|
|
35
|
-
const outputSchema = toStandardSchema(procedure._def.output);
|
|
36
38
|
return new ORPC.Procedure({
|
|
37
39
|
errorMap: {},
|
|
38
40
|
meta: procedure._def.meta ?? {},
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
41
|
+
route: get(procedure._def.meta, ["route"]) ?? {},
|
|
42
|
+
middlewares: [],
|
|
43
|
+
inputSchema: toStandardSchema(procedure._def.inputs.at(-1)),
|
|
44
|
+
outputSchema: toStandardSchema(procedure._def.output),
|
|
45
|
+
inputValidationIndex: Number.NaN,
|
|
46
|
+
// disable input validation
|
|
47
|
+
outputValidationIndex: Number.NaN,
|
|
48
|
+
// disable output validation
|
|
46
49
|
handler: async ({ context, signal, path, input, lastEventId }) => {
|
|
47
50
|
try {
|
|
48
51
|
const trpcInput = lastEventId !== void 0 && (input === void 0 || isObject(input)) ? { ...input, lastEventId } : input;
|
|
@@ -57,21 +60,19 @@ function toORPCProcedure(procedure) {
|
|
|
57
60
|
batchIndex: 0
|
|
58
61
|
});
|
|
59
62
|
if (isAsyncIterable(output)) {
|
|
60
|
-
return
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
})
|
|
72
|
-
};
|
|
63
|
+
return mapEventIterator(output[Symbol.asyncIterator](), {
|
|
64
|
+
error: async (error) => error,
|
|
65
|
+
value: (value) => {
|
|
66
|
+
if (isTrackedEnvelope(value)) {
|
|
67
|
+
const [id, data] = value;
|
|
68
|
+
return ORPC.withEventMeta({
|
|
69
|
+
id,
|
|
70
|
+
data
|
|
71
|
+
}, {
|
|
72
|
+
id
|
|
73
|
+
});
|
|
73
74
|
}
|
|
74
|
-
return
|
|
75
|
+
return value;
|
|
75
76
|
}
|
|
76
77
|
});
|
|
77
78
|
}
|
|
@@ -79,6 +80,7 @@ function toORPCProcedure(procedure) {
|
|
|
79
80
|
} catch (cause) {
|
|
80
81
|
if (cause instanceof TRPCError) {
|
|
81
82
|
throw new ORPC.ORPCError(cause.code, {
|
|
83
|
+
status: getHTTPStatusCodeFromError(cause),
|
|
82
84
|
message: cause.message,
|
|
83
85
|
cause
|
|
84
86
|
});
|
|
@@ -95,9 +97,4 @@ function toStandardSchema(schema) {
|
|
|
95
97
|
return schema;
|
|
96
98
|
}
|
|
97
99
|
|
|
98
|
-
|
|
99
|
-
const [meta] = resolveMetaPlugins({}, void 0, plugins);
|
|
100
|
-
return meta;
|
|
101
|
-
}
|
|
102
|
-
|
|
103
|
-
export { toORPCRouter, toTRPCMeta };
|
|
100
|
+
export { toORPCRouter };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/trpc",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "1.14.
|
|
4
|
+
"version": "1.14.12",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://orpc.dev",
|
|
7
7
|
"repository": {
|
|
@@ -15,7 +15,6 @@
|
|
|
15
15
|
],
|
|
16
16
|
"sideEffects": false,
|
|
17
17
|
"exports": {
|
|
18
|
-
"./package.json": "./package.json",
|
|
19
18
|
".": {
|
|
20
19
|
"types": "./dist/index.d.mts",
|
|
21
20
|
"import": "./dist/index.mjs",
|
|
@@ -29,17 +28,17 @@
|
|
|
29
28
|
"@trpc/server": ">=11.4.2"
|
|
30
29
|
},
|
|
31
30
|
"dependencies": {
|
|
32
|
-
"@orpc/
|
|
33
|
-
"@orpc/server": "1.14.
|
|
34
|
-
"@orpc/shared": "1.14.
|
|
31
|
+
"@orpc/client": "1.14.12",
|
|
32
|
+
"@orpc/server": "1.14.12",
|
|
33
|
+
"@orpc/shared": "1.14.12"
|
|
35
34
|
},
|
|
36
35
|
"devDependencies": {
|
|
37
36
|
"@trpc/server": "^11.12.0",
|
|
38
|
-
"zod": "^4.
|
|
39
|
-
"@orpc/openapi": "1.14.11"
|
|
37
|
+
"zod": "^4.3.6"
|
|
40
38
|
},
|
|
41
39
|
"scripts": {
|
|
42
40
|
"build": "unbuild",
|
|
41
|
+
"build:watch": "pnpm run build --watch",
|
|
43
42
|
"type:check": "tsc -b"
|
|
44
43
|
}
|
|
45
44
|
}
|