@orpc/server 0.0.0-next.f99e554 → 0.0.0-next.fb0d07c
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 +128 -0
- package/dist/adapters/bun-ws/index.d.mts +35 -0
- package/dist/adapters/bun-ws/index.d.ts +35 -0
- package/dist/adapters/bun-ws/index.mjs +51 -0
- package/dist/adapters/crossws/index.d.mts +30 -0
- package/dist/adapters/crossws/index.d.ts +30 -0
- package/dist/adapters/crossws/index.mjs +51 -0
- package/dist/adapters/fetch/index.d.mts +78 -0
- package/dist/adapters/fetch/index.d.ts +78 -0
- package/dist/adapters/fetch/index.mjs +110 -0
- package/dist/adapters/node/index.d.mts +77 -0
- package/dist/adapters/node/index.d.ts +77 -0
- package/dist/adapters/node/index.mjs +95 -0
- package/dist/adapters/standard/index.d.mts +26 -0
- package/dist/adapters/standard/index.d.ts +26 -0
- package/dist/adapters/standard/index.mjs +7 -0
- package/dist/adapters/websocket/index.d.mts +27 -0
- package/dist/adapters/websocket/index.d.ts +27 -0
- package/dist/adapters/websocket/index.mjs +38 -0
- package/dist/adapters/ws/index.d.mts +28 -0
- package/dist/adapters/ws/index.d.ts +28 -0
- package/dist/adapters/ws/index.mjs +38 -0
- package/dist/index.d.mts +829 -0
- package/dist/index.d.ts +829 -0
- package/dist/index.mjs +475 -0
- package/dist/plugins/index.d.mts +156 -0
- package/dist/plugins/index.d.ts +156 -0
- package/dist/plugins/index.mjs +251 -0
- package/dist/shared/server.-ACo36I0.d.ts +74 -0
- package/dist/shared/server.4FnxLwwr.mjs +186 -0
- package/dist/shared/server.BPAWobQg.d.ts +12 -0
- package/dist/shared/server.BVwwTHyO.mjs +9 -0
- package/dist/shared/server.BW-nUGgA.mjs +36 -0
- package/dist/shared/server.Bd52nNaH.d.mts +12 -0
- package/dist/shared/server.BliFSTnG.d.mts +10 -0
- package/dist/shared/server.DD2C4ujN.d.mts +192 -0
- package/dist/shared/server.DD2C4ujN.d.ts +192 -0
- package/dist/shared/server.DG7Tamti.mjs +367 -0
- package/dist/shared/server.Dq8xr7PQ.d.mts +74 -0
- package/dist/shared/server.IG2MjhrD.d.ts +10 -0
- package/package.json +64 -19
- package/dist/chunk-6A7XHEBH.js +0 -189
- package/dist/chunk-B2EZJB7X.js +0 -303
- package/dist/fetch.js +0 -32
- package/dist/index.js +0 -518
- package/dist/node.js +0 -45
- package/dist/src/adapters/fetch/composite-handler.d.ts +0 -8
- package/dist/src/adapters/fetch/index.d.ts +0 -7
- package/dist/src/adapters/fetch/orpc-handler.d.ts +0 -20
- package/dist/src/adapters/fetch/orpc-payload-codec.d.ts +0 -16
- package/dist/src/adapters/fetch/orpc-procedure-matcher.d.ts +0 -12
- package/dist/src/adapters/fetch/super-json.d.ts +0 -12
- package/dist/src/adapters/fetch/types.d.ts +0 -16
- package/dist/src/adapters/node/composite-handler.d.ts +0 -9
- package/dist/src/adapters/node/index.d.ts +0 -5
- package/dist/src/adapters/node/orpc-handler.d.ts +0 -12
- package/dist/src/adapters/node/types.d.ts +0 -21
- package/dist/src/builder.d.ts +0 -35
- package/dist/src/hidden.d.ts +0 -6
- package/dist/src/implementer-chainable.d.ts +0 -10
- package/dist/src/index.d.ts +0 -23
- package/dist/src/lazy-decorated.d.ts +0 -10
- package/dist/src/lazy-utils.d.ts +0 -4
- package/dist/src/lazy.d.ts +0 -18
- package/dist/src/middleware-decorated.d.ts +0 -8
- package/dist/src/middleware.d.ts +0 -23
- package/dist/src/procedure-builder.d.ts +0 -22
- package/dist/src/procedure-client.d.ts +0 -34
- package/dist/src/procedure-decorated.d.ts +0 -14
- package/dist/src/procedure-implementer.d.ts +0 -18
- package/dist/src/procedure.d.ts +0 -23
- package/dist/src/router-builder.d.ts +0 -29
- package/dist/src/router-client.d.ts +0 -25
- package/dist/src/router-implementer.d.ts +0 -21
- package/dist/src/router.d.ts +0 -16
- package/dist/src/types.d.ts +0 -12
- package/dist/src/utils.d.ts +0 -3
package/README.md
ADDED
@@ -0,0 +1,128 @@
|
|
1
|
+
<div align="center">
|
2
|
+
<image align="center" src="https://orpc.unnoq.com/logo.webp" width=280 alt="oRPC logo" />
|
3
|
+
</div>
|
4
|
+
|
5
|
+
<h1></h1>
|
6
|
+
|
7
|
+
<div align="center">
|
8
|
+
<a href="https://codecov.io/gh/unnoq/orpc">
|
9
|
+
<img alt="codecov" src="https://codecov.io/gh/unnoq/orpc/branch/main/graph/badge.svg">
|
10
|
+
</a>
|
11
|
+
<a href="https://www.npmjs.com/package/@orpc/server">
|
12
|
+
<img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fserver?logo=npm" />
|
13
|
+
</a>
|
14
|
+
<a href="https://github.com/unnoq/orpc/blob/main/LICENSE">
|
15
|
+
<img alt="MIT License" src="https://img.shields.io/github/license/unnoq/orpc?logo=open-source-initiative" />
|
16
|
+
</a>
|
17
|
+
<a href="https://discord.gg/TXEbwRBvQn">
|
18
|
+
<img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
|
19
|
+
</a>
|
20
|
+
</div>
|
21
|
+
|
22
|
+
<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
|
23
|
+
|
24
|
+
**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
|
25
|
+
|
26
|
+
---
|
27
|
+
|
28
|
+
## Highlights
|
29
|
+
|
30
|
+
- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
|
31
|
+
- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
|
32
|
+
- **📝 Contract-First Development**: Optionally define your API contract before implementation.
|
33
|
+
- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
|
34
|
+
- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
|
35
|
+
- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
|
36
|
+
- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
|
37
|
+
- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
|
38
|
+
- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
|
39
|
+
- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
|
40
|
+
- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
|
41
|
+
- **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
|
42
|
+
|
43
|
+
## Documentation
|
44
|
+
|
45
|
+
You can find the full documentation [here](https://orpc.unnoq.com).
|
46
|
+
|
47
|
+
## Packages
|
48
|
+
|
49
|
+
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
50
|
+
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
51
|
+
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
52
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with NestJS.
|
53
|
+
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
54
|
+
- [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
|
55
|
+
- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
|
56
|
+
- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
|
57
|
+
- [@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
|
+
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
59
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
60
|
+
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
61
|
+
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
62
|
+
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
63
|
+
|
64
|
+
## `@orpc/server`
|
65
|
+
|
66
|
+
Build your API or implement API contract. Read the [documentation](https://orpc.unnoq.com/docs/getting-started) for more information.
|
67
|
+
|
68
|
+
```ts
|
69
|
+
import type { IncomingHttpHeaders } from 'node:http'
|
70
|
+
import { ORPCError, os } from '@orpc/server'
|
71
|
+
import { z } from 'zod'
|
72
|
+
|
73
|
+
const PlanetSchema = z.object({
|
74
|
+
id: z.number().int().min(1),
|
75
|
+
name: z.string(),
|
76
|
+
description: z.string().optional(),
|
77
|
+
})
|
78
|
+
|
79
|
+
export const listPlanet = os
|
80
|
+
.input(
|
81
|
+
z.object({
|
82
|
+
limit: z.number().int().min(1).max(100).optional(),
|
83
|
+
cursor: z.number().int().min(0).default(0),
|
84
|
+
}),
|
85
|
+
)
|
86
|
+
.handler(async ({ input }) => {
|
87
|
+
// your list code here
|
88
|
+
return [{ id: 1, name: 'name' }]
|
89
|
+
})
|
90
|
+
|
91
|
+
export const findPlanet = os
|
92
|
+
.input(PlanetSchema.pick({ id: true }))
|
93
|
+
.handler(async ({ input }) => {
|
94
|
+
// your find code here
|
95
|
+
return { id: 1, name: 'name' }
|
96
|
+
})
|
97
|
+
|
98
|
+
export const createPlanet = os
|
99
|
+
.$context<{ headers: IncomingHttpHeaders }>()
|
100
|
+
.use(({ context, next }) => {
|
101
|
+
const user = parseJWT(context.headers.authorization?.split(' ')[1])
|
102
|
+
|
103
|
+
if (user) {
|
104
|
+
return next({ context: { user } })
|
105
|
+
}
|
106
|
+
|
107
|
+
throw new ORPCError('UNAUTHORIZED')
|
108
|
+
})
|
109
|
+
.input(PlanetSchema.omit({ id: true }))
|
110
|
+
.handler(async ({ input, context }) => {
|
111
|
+
// your create code here
|
112
|
+
return { id: 1, name: 'name' }
|
113
|
+
})
|
114
|
+
|
115
|
+
export const router = { planet: { list: listPlanet, find: findPlanet, create: createPlanet } }
|
116
|
+
```
|
117
|
+
|
118
|
+
## Sponsors
|
119
|
+
|
120
|
+
<p align="center">
|
121
|
+
<a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
|
122
|
+
<img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
|
123
|
+
</a>
|
124
|
+
</p>
|
125
|
+
|
126
|
+
## License
|
127
|
+
|
128
|
+
Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
|
@@ -0,0 +1,35 @@
|
|
1
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { C as Context, R as Router } from '../../shared/server.DD2C4ujN.mjs';
|
3
|
+
import { i as StandardHandler } from '../../shared/server.Dq8xr7PQ.mjs';
|
4
|
+
import { F as FriendlyStandardHandleOptions } from '../../shared/server.BliFSTnG.mjs';
|
5
|
+
import { S as StandardRPCHandlerOptions } from '../../shared/server.Bd52nNaH.mjs';
|
6
|
+
import '@orpc/client';
|
7
|
+
import '@orpc/contract';
|
8
|
+
import '@orpc/standard-server';
|
9
|
+
import '@orpc/client/standard';
|
10
|
+
|
11
|
+
interface ServerWebSocket {
|
12
|
+
send(message: string | ArrayBufferLike): number;
|
13
|
+
}
|
14
|
+
declare class experimental_BunWsHandler<T extends Context> {
|
15
|
+
private readonly standardHandler;
|
16
|
+
private readonly peers;
|
17
|
+
constructor(standardHandler: StandardHandler<T>);
|
18
|
+
message(ws: ServerWebSocket, message: string | {
|
19
|
+
buffer: ArrayBufferLike;
|
20
|
+
}, ...rest: MaybeOptionalOptions<Omit<FriendlyStandardHandleOptions<T>, 'prefix'>>): Promise<void>;
|
21
|
+
close(ws: ServerWebSocket): void;
|
22
|
+
}
|
23
|
+
|
24
|
+
/**
|
25
|
+
* RPC Handler for Bun WS adapter
|
26
|
+
*
|
27
|
+
* @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
|
28
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/websocket Websocket Adapter Docs}
|
29
|
+
*/
|
30
|
+
declare class experimental_RPCHandler<T extends Context> extends experimental_BunWsHandler<T> {
|
31
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardRPCHandlerOptions<T>>);
|
32
|
+
}
|
33
|
+
|
34
|
+
export { experimental_BunWsHandler, experimental_RPCHandler };
|
35
|
+
export type { ServerWebSocket };
|
@@ -0,0 +1,35 @@
|
|
1
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { C as Context, R as Router } from '../../shared/server.DD2C4ujN.js';
|
3
|
+
import { i as StandardHandler } from '../../shared/server.-ACo36I0.js';
|
4
|
+
import { F as FriendlyStandardHandleOptions } from '../../shared/server.IG2MjhrD.js';
|
5
|
+
import { S as StandardRPCHandlerOptions } from '../../shared/server.BPAWobQg.js';
|
6
|
+
import '@orpc/client';
|
7
|
+
import '@orpc/contract';
|
8
|
+
import '@orpc/standard-server';
|
9
|
+
import '@orpc/client/standard';
|
10
|
+
|
11
|
+
interface ServerWebSocket {
|
12
|
+
send(message: string | ArrayBufferLike): number;
|
13
|
+
}
|
14
|
+
declare class experimental_BunWsHandler<T extends Context> {
|
15
|
+
private readonly standardHandler;
|
16
|
+
private readonly peers;
|
17
|
+
constructor(standardHandler: StandardHandler<T>);
|
18
|
+
message(ws: ServerWebSocket, message: string | {
|
19
|
+
buffer: ArrayBufferLike;
|
20
|
+
}, ...rest: MaybeOptionalOptions<Omit<FriendlyStandardHandleOptions<T>, 'prefix'>>): Promise<void>;
|
21
|
+
close(ws: ServerWebSocket): void;
|
22
|
+
}
|
23
|
+
|
24
|
+
/**
|
25
|
+
* RPC Handler for Bun WS adapter
|
26
|
+
*
|
27
|
+
* @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
|
28
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/websocket Websocket Adapter Docs}
|
29
|
+
*/
|
30
|
+
declare class experimental_RPCHandler<T extends Context> extends experimental_BunWsHandler<T> {
|
31
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardRPCHandlerOptions<T>>);
|
32
|
+
}
|
33
|
+
|
34
|
+
export { experimental_BunWsHandler, experimental_RPCHandler };
|
35
|
+
export type { ServerWebSocket };
|
@@ -0,0 +1,51 @@
|
|
1
|
+
import { resolveMaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { ServerPeer } from '@orpc/standard-server-peer';
|
3
|
+
import { r as resolveFriendlyStandardHandleOptions } from '../../shared/server.BVwwTHyO.mjs';
|
4
|
+
import '@orpc/client';
|
5
|
+
import '@orpc/standard-server';
|
6
|
+
import '@orpc/contract';
|
7
|
+
import { b as StandardRPCHandler } from '../../shared/server.4FnxLwwr.mjs';
|
8
|
+
import '@orpc/client/standard';
|
9
|
+
import '../../shared/server.DG7Tamti.mjs';
|
10
|
+
|
11
|
+
class experimental_BunWsHandler {
|
12
|
+
constructor(standardHandler) {
|
13
|
+
this.standardHandler = standardHandler;
|
14
|
+
}
|
15
|
+
peers = /* @__PURE__ */ new WeakMap();
|
16
|
+
async message(ws, message, ...rest) {
|
17
|
+
let peer = this.peers.get(ws);
|
18
|
+
if (!peer) {
|
19
|
+
this.peers.set(ws, peer = new ServerPeer(async (raw) => {
|
20
|
+
if (raw instanceof Blob) {
|
21
|
+
const buffer = await raw.arrayBuffer();
|
22
|
+
ws.send(buffer);
|
23
|
+
} else {
|
24
|
+
ws.send(raw);
|
25
|
+
}
|
26
|
+
}));
|
27
|
+
}
|
28
|
+
const [id, request] = await peer.message(typeof message === "string" ? message : message.buffer);
|
29
|
+
if (!request) {
|
30
|
+
return;
|
31
|
+
}
|
32
|
+
const options = resolveFriendlyStandardHandleOptions(resolveMaybeOptionalOptions(rest));
|
33
|
+
const { response } = await this.standardHandler.handle({ ...request, body: () => Promise.resolve(request.body) }, options);
|
34
|
+
await peer.response(id, response ?? { status: 404, headers: {}, body: "No procedure matched" });
|
35
|
+
}
|
36
|
+
close(ws) {
|
37
|
+
const server = this.peers.get(ws);
|
38
|
+
if (server) {
|
39
|
+
server.close();
|
40
|
+
this.peers.delete(ws);
|
41
|
+
}
|
42
|
+
}
|
43
|
+
}
|
44
|
+
|
45
|
+
class experimental_RPCHandler extends experimental_BunWsHandler {
|
46
|
+
constructor(router, options = {}) {
|
47
|
+
super(new StandardRPCHandler(router, options));
|
48
|
+
}
|
49
|
+
}
|
50
|
+
|
51
|
+
export { experimental_BunWsHandler, experimental_RPCHandler };
|
@@ -0,0 +1,30 @@
|
|
1
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { Peer, Message } from 'crossws';
|
3
|
+
import { C as Context, R as Router } from '../../shared/server.DD2C4ujN.mjs';
|
4
|
+
import { i as StandardHandler } from '../../shared/server.Dq8xr7PQ.mjs';
|
5
|
+
import { F as FriendlyStandardHandleOptions } from '../../shared/server.BliFSTnG.mjs';
|
6
|
+
import { S as StandardRPCHandlerOptions } from '../../shared/server.Bd52nNaH.mjs';
|
7
|
+
import '@orpc/client';
|
8
|
+
import '@orpc/contract';
|
9
|
+
import '@orpc/standard-server';
|
10
|
+
import '@orpc/client/standard';
|
11
|
+
|
12
|
+
declare class experimental_CrosswsHandler<T extends Context> {
|
13
|
+
private readonly standardHandler;
|
14
|
+
private readonly peers;
|
15
|
+
constructor(standardHandler: StandardHandler<T>);
|
16
|
+
message(ws: Pick<Peer, 'send'>, message: Pick<Message, 'rawData' | 'uint8Array'>, ...rest: MaybeOptionalOptions<Omit<FriendlyStandardHandleOptions<T>, 'prefix'>>): Promise<void>;
|
17
|
+
close(ws: Pick<Peer, 'send'>): void;
|
18
|
+
}
|
19
|
+
|
20
|
+
/**
|
21
|
+
* RPC Handler for Crossws adapter
|
22
|
+
*
|
23
|
+
* @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
|
24
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/websocket Websocket Adapter Docs}
|
25
|
+
*/
|
26
|
+
declare class experimental_RPCHandler<T extends Context> extends experimental_CrosswsHandler<T> {
|
27
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardRPCHandlerOptions<T>>);
|
28
|
+
}
|
29
|
+
|
30
|
+
export { experimental_CrosswsHandler, experimental_RPCHandler };
|
@@ -0,0 +1,30 @@
|
|
1
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { Peer, Message } from 'crossws';
|
3
|
+
import { C as Context, R as Router } from '../../shared/server.DD2C4ujN.js';
|
4
|
+
import { i as StandardHandler } from '../../shared/server.-ACo36I0.js';
|
5
|
+
import { F as FriendlyStandardHandleOptions } from '../../shared/server.IG2MjhrD.js';
|
6
|
+
import { S as StandardRPCHandlerOptions } from '../../shared/server.BPAWobQg.js';
|
7
|
+
import '@orpc/client';
|
8
|
+
import '@orpc/contract';
|
9
|
+
import '@orpc/standard-server';
|
10
|
+
import '@orpc/client/standard';
|
11
|
+
|
12
|
+
declare class experimental_CrosswsHandler<T extends Context> {
|
13
|
+
private readonly standardHandler;
|
14
|
+
private readonly peers;
|
15
|
+
constructor(standardHandler: StandardHandler<T>);
|
16
|
+
message(ws: Pick<Peer, 'send'>, message: Pick<Message, 'rawData' | 'uint8Array'>, ...rest: MaybeOptionalOptions<Omit<FriendlyStandardHandleOptions<T>, 'prefix'>>): Promise<void>;
|
17
|
+
close(ws: Pick<Peer, 'send'>): void;
|
18
|
+
}
|
19
|
+
|
20
|
+
/**
|
21
|
+
* RPC Handler for Crossws adapter
|
22
|
+
*
|
23
|
+
* @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
|
24
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/websocket Websocket Adapter Docs}
|
25
|
+
*/
|
26
|
+
declare class experimental_RPCHandler<T extends Context> extends experimental_CrosswsHandler<T> {
|
27
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardRPCHandlerOptions<T>>);
|
28
|
+
}
|
29
|
+
|
30
|
+
export { experimental_CrosswsHandler, experimental_RPCHandler };
|
@@ -0,0 +1,51 @@
|
|
1
|
+
import { resolveMaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { ServerPeer } from '@orpc/standard-server-peer';
|
3
|
+
import { r as resolveFriendlyStandardHandleOptions } from '../../shared/server.BVwwTHyO.mjs';
|
4
|
+
import '@orpc/client';
|
5
|
+
import '@orpc/standard-server';
|
6
|
+
import '@orpc/contract';
|
7
|
+
import { b as StandardRPCHandler } from '../../shared/server.4FnxLwwr.mjs';
|
8
|
+
import '@orpc/client/standard';
|
9
|
+
import '../../shared/server.DG7Tamti.mjs';
|
10
|
+
|
11
|
+
class experimental_CrosswsHandler {
|
12
|
+
constructor(standardHandler) {
|
13
|
+
this.standardHandler = standardHandler;
|
14
|
+
}
|
15
|
+
peers = /* @__PURE__ */ new WeakMap();
|
16
|
+
async message(ws, message, ...rest) {
|
17
|
+
let peer = this.peers.get(ws);
|
18
|
+
if (!peer) {
|
19
|
+
this.peers.set(ws, peer = new ServerPeer(async (raw) => {
|
20
|
+
if (raw instanceof Blob) {
|
21
|
+
const buffer = await raw.arrayBuffer();
|
22
|
+
ws.send(buffer);
|
23
|
+
} else {
|
24
|
+
ws.send(raw);
|
25
|
+
}
|
26
|
+
}));
|
27
|
+
}
|
28
|
+
const [id, request] = await peer.message(typeof message.rawData === "string" ? message.rawData : message.uint8Array());
|
29
|
+
if (!request) {
|
30
|
+
return;
|
31
|
+
}
|
32
|
+
const options = resolveFriendlyStandardHandleOptions(resolveMaybeOptionalOptions(rest));
|
33
|
+
const { response } = await this.standardHandler.handle({ ...request, body: () => Promise.resolve(request.body) }, options);
|
34
|
+
await peer.response(id, response ?? { status: 404, headers: {}, body: "No procedure matched" });
|
35
|
+
}
|
36
|
+
close(ws) {
|
37
|
+
const server = this.peers.get(ws);
|
38
|
+
if (server) {
|
39
|
+
server.close();
|
40
|
+
this.peers.delete(ws);
|
41
|
+
}
|
42
|
+
}
|
43
|
+
}
|
44
|
+
|
45
|
+
class experimental_RPCHandler extends experimental_CrosswsHandler {
|
46
|
+
constructor(router, options = {}) {
|
47
|
+
super(new StandardRPCHandler(router, options));
|
48
|
+
}
|
49
|
+
}
|
50
|
+
|
51
|
+
export { experimental_CrosswsHandler, experimental_RPCHandler };
|
@@ -0,0 +1,78 @@
|
|
1
|
+
import { C as Context, R as Router } from '../../shared/server.DD2C4ujN.mjs';
|
2
|
+
import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
|
3
|
+
import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
|
4
|
+
import { a as StandardHandlerPlugin, C as CompositeStandardHandlerPlugin, g as StandardHandleOptions, i as StandardHandler } from '../../shared/server.Dq8xr7PQ.mjs';
|
5
|
+
import { F as FriendlyStandardHandleOptions } from '../../shared/server.BliFSTnG.mjs';
|
6
|
+
import { S as StandardRPCHandlerOptions } from '../../shared/server.Bd52nNaH.mjs';
|
7
|
+
import '@orpc/client';
|
8
|
+
import '@orpc/contract';
|
9
|
+
import '@orpc/standard-server';
|
10
|
+
import '@orpc/client/standard';
|
11
|
+
|
12
|
+
interface FetchHandlerPlugin<T extends Context> extends StandardHandlerPlugin<T> {
|
13
|
+
initRuntimeAdapter?(options: FetchHandlerOptions<T>): void;
|
14
|
+
}
|
15
|
+
declare class CompositeFetchHandlerPlugin<T extends Context, TPlugin extends FetchHandlerPlugin<T>> extends CompositeStandardHandlerPlugin<T, TPlugin> implements FetchHandlerPlugin<T> {
|
16
|
+
initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
|
17
|
+
}
|
18
|
+
|
19
|
+
type FetchHandleResult = {
|
20
|
+
matched: true;
|
21
|
+
response: Response;
|
22
|
+
} | {
|
23
|
+
matched: false;
|
24
|
+
response: undefined;
|
25
|
+
};
|
26
|
+
interface FetchHandlerInterceptorOptions<T extends Context> extends StandardHandleOptions<T> {
|
27
|
+
request: Request;
|
28
|
+
toFetchResponseOptions: ToFetchResponseOptions;
|
29
|
+
}
|
30
|
+
interface FetchHandlerOptions<T extends Context> extends ToFetchResponseOptions {
|
31
|
+
adapterInterceptors?: Interceptor<FetchHandlerInterceptorOptions<T>, Promise<FetchHandleResult>>[];
|
32
|
+
plugins?: FetchHandlerPlugin<T>[];
|
33
|
+
}
|
34
|
+
declare class FetchHandler<T extends Context> {
|
35
|
+
private readonly standardHandler;
|
36
|
+
private readonly toFetchResponseOptions;
|
37
|
+
private readonly adapterInterceptors;
|
38
|
+
constructor(standardHandler: StandardHandler<T>, options?: NoInfer<FetchHandlerOptions<T>>);
|
39
|
+
handle(request: Request, ...rest: MaybeOptionalOptions<FriendlyStandardHandleOptions<T>>): Promise<FetchHandleResult>;
|
40
|
+
}
|
41
|
+
|
42
|
+
interface BodyLimitPluginOptions {
|
43
|
+
/**
|
44
|
+
* The maximum size of the body in bytes.
|
45
|
+
*/
|
46
|
+
maxBodySize: number;
|
47
|
+
}
|
48
|
+
/**
|
49
|
+
* The Body Limit Plugin restricts the size of the request body for the Fetch Server.
|
50
|
+
*
|
51
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/body-limit Body Limit Plugin Docs}
|
52
|
+
*/
|
53
|
+
declare class BodyLimitPlugin<T extends Context> implements FetchHandlerPlugin<T> {
|
54
|
+
private readonly maxBodySize;
|
55
|
+
constructor(options: BodyLimitPluginOptions);
|
56
|
+
initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
|
57
|
+
}
|
58
|
+
|
59
|
+
type RPCHandlerOptions<T extends Context> = FetchHandlerOptions<T> & StandardRPCHandlerOptions<T> & {
|
60
|
+
/**
|
61
|
+
* Enables or disables the StrictGetMethodPlugin.
|
62
|
+
*
|
63
|
+
* @default true
|
64
|
+
*/
|
65
|
+
strictGetMethodPluginEnabled?: boolean;
|
66
|
+
};
|
67
|
+
/**
|
68
|
+
* RPC Handler for Fetch Server
|
69
|
+
*
|
70
|
+
* @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
|
71
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
|
72
|
+
*/
|
73
|
+
declare class RPCHandler<T extends Context> extends FetchHandler<T> {
|
74
|
+
constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
|
75
|
+
}
|
76
|
+
|
77
|
+
export { BodyLimitPlugin, CompositeFetchHandlerPlugin, FetchHandler, RPCHandler };
|
78
|
+
export type { BodyLimitPluginOptions, FetchHandleResult, FetchHandlerInterceptorOptions, FetchHandlerOptions, FetchHandlerPlugin, RPCHandlerOptions };
|
@@ -0,0 +1,78 @@
|
|
1
|
+
import { C as Context, R as Router } from '../../shared/server.DD2C4ujN.js';
|
2
|
+
import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
|
3
|
+
import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
|
4
|
+
import { a as StandardHandlerPlugin, C as CompositeStandardHandlerPlugin, g as StandardHandleOptions, i as StandardHandler } from '../../shared/server.-ACo36I0.js';
|
5
|
+
import { F as FriendlyStandardHandleOptions } from '../../shared/server.IG2MjhrD.js';
|
6
|
+
import { S as StandardRPCHandlerOptions } from '../../shared/server.BPAWobQg.js';
|
7
|
+
import '@orpc/client';
|
8
|
+
import '@orpc/contract';
|
9
|
+
import '@orpc/standard-server';
|
10
|
+
import '@orpc/client/standard';
|
11
|
+
|
12
|
+
interface FetchHandlerPlugin<T extends Context> extends StandardHandlerPlugin<T> {
|
13
|
+
initRuntimeAdapter?(options: FetchHandlerOptions<T>): void;
|
14
|
+
}
|
15
|
+
declare class CompositeFetchHandlerPlugin<T extends Context, TPlugin extends FetchHandlerPlugin<T>> extends CompositeStandardHandlerPlugin<T, TPlugin> implements FetchHandlerPlugin<T> {
|
16
|
+
initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
|
17
|
+
}
|
18
|
+
|
19
|
+
type FetchHandleResult = {
|
20
|
+
matched: true;
|
21
|
+
response: Response;
|
22
|
+
} | {
|
23
|
+
matched: false;
|
24
|
+
response: undefined;
|
25
|
+
};
|
26
|
+
interface FetchHandlerInterceptorOptions<T extends Context> extends StandardHandleOptions<T> {
|
27
|
+
request: Request;
|
28
|
+
toFetchResponseOptions: ToFetchResponseOptions;
|
29
|
+
}
|
30
|
+
interface FetchHandlerOptions<T extends Context> extends ToFetchResponseOptions {
|
31
|
+
adapterInterceptors?: Interceptor<FetchHandlerInterceptorOptions<T>, Promise<FetchHandleResult>>[];
|
32
|
+
plugins?: FetchHandlerPlugin<T>[];
|
33
|
+
}
|
34
|
+
declare class FetchHandler<T extends Context> {
|
35
|
+
private readonly standardHandler;
|
36
|
+
private readonly toFetchResponseOptions;
|
37
|
+
private readonly adapterInterceptors;
|
38
|
+
constructor(standardHandler: StandardHandler<T>, options?: NoInfer<FetchHandlerOptions<T>>);
|
39
|
+
handle(request: Request, ...rest: MaybeOptionalOptions<FriendlyStandardHandleOptions<T>>): Promise<FetchHandleResult>;
|
40
|
+
}
|
41
|
+
|
42
|
+
interface BodyLimitPluginOptions {
|
43
|
+
/**
|
44
|
+
* The maximum size of the body in bytes.
|
45
|
+
*/
|
46
|
+
maxBodySize: number;
|
47
|
+
}
|
48
|
+
/**
|
49
|
+
* The Body Limit Plugin restricts the size of the request body for the Fetch Server.
|
50
|
+
*
|
51
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/body-limit Body Limit Plugin Docs}
|
52
|
+
*/
|
53
|
+
declare class BodyLimitPlugin<T extends Context> implements FetchHandlerPlugin<T> {
|
54
|
+
private readonly maxBodySize;
|
55
|
+
constructor(options: BodyLimitPluginOptions);
|
56
|
+
initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
|
57
|
+
}
|
58
|
+
|
59
|
+
type RPCHandlerOptions<T extends Context> = FetchHandlerOptions<T> & StandardRPCHandlerOptions<T> & {
|
60
|
+
/**
|
61
|
+
* Enables or disables the StrictGetMethodPlugin.
|
62
|
+
*
|
63
|
+
* @default true
|
64
|
+
*/
|
65
|
+
strictGetMethodPluginEnabled?: boolean;
|
66
|
+
};
|
67
|
+
/**
|
68
|
+
* RPC Handler for Fetch Server
|
69
|
+
*
|
70
|
+
* @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
|
71
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
|
72
|
+
*/
|
73
|
+
declare class RPCHandler<T extends Context> extends FetchHandler<T> {
|
74
|
+
constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
|
75
|
+
}
|
76
|
+
|
77
|
+
export { BodyLimitPlugin, CompositeFetchHandlerPlugin, FetchHandler, RPCHandler };
|
78
|
+
export type { BodyLimitPluginOptions, FetchHandleResult, FetchHandlerInterceptorOptions, FetchHandlerOptions, FetchHandlerPlugin, RPCHandlerOptions };
|
@@ -0,0 +1,110 @@
|
|
1
|
+
import { ORPCError } from '@orpc/client';
|
2
|
+
import { toArray, intercept, resolveMaybeOptionalOptions } from '@orpc/shared';
|
3
|
+
import { toStandardLazyRequest, toFetchResponse } from '@orpc/standard-server-fetch';
|
4
|
+
import { r as resolveFriendlyStandardHandleOptions } from '../../shared/server.BVwwTHyO.mjs';
|
5
|
+
import '@orpc/standard-server';
|
6
|
+
import '@orpc/contract';
|
7
|
+
import { C as CompositeStandardHandlerPlugin, b as StandardRPCHandler } from '../../shared/server.4FnxLwwr.mjs';
|
8
|
+
import '@orpc/client/standard';
|
9
|
+
import '@orpc/standard-server/batch';
|
10
|
+
import { S as StrictGetMethodPlugin } from '../../shared/server.BW-nUGgA.mjs';
|
11
|
+
import '../../shared/server.DG7Tamti.mjs';
|
12
|
+
|
13
|
+
class BodyLimitPlugin {
|
14
|
+
maxBodySize;
|
15
|
+
constructor(options) {
|
16
|
+
this.maxBodySize = options.maxBodySize;
|
17
|
+
}
|
18
|
+
initRuntimeAdapter(options) {
|
19
|
+
options.adapterInterceptors ??= [];
|
20
|
+
options.adapterInterceptors.push(async (options2) => {
|
21
|
+
if (!options2.request.body) {
|
22
|
+
return options2.next();
|
23
|
+
}
|
24
|
+
let currentBodySize = 0;
|
25
|
+
const rawReader = options2.request.body.getReader();
|
26
|
+
const reader = new ReadableStream({
|
27
|
+
start: async (controller) => {
|
28
|
+
try {
|
29
|
+
if (Number(options2.request.headers.get("content-length")) > this.maxBodySize) {
|
30
|
+
controller.error(new ORPCError("PAYLOAD_TOO_LARGE"));
|
31
|
+
return;
|
32
|
+
}
|
33
|
+
while (true) {
|
34
|
+
const { done, value } = await rawReader.read();
|
35
|
+
if (done) {
|
36
|
+
break;
|
37
|
+
}
|
38
|
+
currentBodySize += value.length;
|
39
|
+
if (currentBodySize > this.maxBodySize) {
|
40
|
+
controller.error(new ORPCError("PAYLOAD_TOO_LARGE"));
|
41
|
+
break;
|
42
|
+
}
|
43
|
+
controller.enqueue(value);
|
44
|
+
}
|
45
|
+
} finally {
|
46
|
+
controller.close();
|
47
|
+
}
|
48
|
+
}
|
49
|
+
});
|
50
|
+
const requestInit = { body: reader, duplex: "half" };
|
51
|
+
return options2.next({
|
52
|
+
...options2,
|
53
|
+
request: new Request(options2.request, requestInit)
|
54
|
+
});
|
55
|
+
});
|
56
|
+
}
|
57
|
+
}
|
58
|
+
|
59
|
+
class CompositeFetchHandlerPlugin extends CompositeStandardHandlerPlugin {
|
60
|
+
initRuntimeAdapter(options) {
|
61
|
+
for (const plugin of this.plugins) {
|
62
|
+
plugin.initRuntimeAdapter?.(options);
|
63
|
+
}
|
64
|
+
}
|
65
|
+
}
|
66
|
+
|
67
|
+
class FetchHandler {
|
68
|
+
constructor(standardHandler, options = {}) {
|
69
|
+
this.standardHandler = standardHandler;
|
70
|
+
const plugin = new CompositeFetchHandlerPlugin(options.plugins);
|
71
|
+
plugin.initRuntimeAdapter(options);
|
72
|
+
this.adapterInterceptors = toArray(options.adapterInterceptors);
|
73
|
+
this.toFetchResponseOptions = options;
|
74
|
+
}
|
75
|
+
toFetchResponseOptions;
|
76
|
+
adapterInterceptors;
|
77
|
+
async handle(request, ...rest) {
|
78
|
+
return intercept(
|
79
|
+
this.adapterInterceptors,
|
80
|
+
{
|
81
|
+
...resolveFriendlyStandardHandleOptions(resolveMaybeOptionalOptions(rest)),
|
82
|
+
request,
|
83
|
+
toFetchResponseOptions: this.toFetchResponseOptions
|
84
|
+
},
|
85
|
+
async ({ request: request2, toFetchResponseOptions, ...options }) => {
|
86
|
+
const standardRequest = toStandardLazyRequest(request2);
|
87
|
+
const result = await this.standardHandler.handle(standardRequest, options);
|
88
|
+
if (!result.matched) {
|
89
|
+
return result;
|
90
|
+
}
|
91
|
+
return {
|
92
|
+
matched: true,
|
93
|
+
response: toFetchResponse(result.response, toFetchResponseOptions)
|
94
|
+
};
|
95
|
+
}
|
96
|
+
);
|
97
|
+
}
|
98
|
+
}
|
99
|
+
|
100
|
+
class RPCHandler extends FetchHandler {
|
101
|
+
constructor(router, options = {}) {
|
102
|
+
if (options.strictGetMethodPluginEnabled ?? true) {
|
103
|
+
options.plugins ??= [];
|
104
|
+
options.plugins.push(new StrictGetMethodPlugin());
|
105
|
+
}
|
106
|
+
super(new StandardRPCHandler(router, options), options);
|
107
|
+
}
|
108
|
+
}
|
109
|
+
|
110
|
+
export { BodyLimitPlugin, CompositeFetchHandlerPlugin, FetchHandler, RPCHandler };
|