@orpc/server 2.0.0-beta.47 → 2.0.0-beta.48
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 +2 -3
- package/dist/adapters/aws-lambda/handler.d.mts +25 -0
- package/dist/adapters/aws-lambda/handler.mjs +21 -0
- package/dist/adapters/aws-lambda/index.d.mts +14 -49
- package/dist/adapters/aws-lambda/index.mjs +2 -39
- package/dist/adapters/aws-lambda/rpc-handler.d.mts +18 -0
- package/dist/adapters/aws-lambda/rpc-handler.mjs +10 -0
- package/dist/adapters/crossws/handler.d.mts +41 -0
- package/dist/adapters/crossws/handler.mjs +38 -0
- package/dist/adapters/crossws/index.d.mts +2 -63
- package/dist/adapters/crossws/index.mjs +2 -68
- package/dist/adapters/crossws/rpc-handler.d.mts +15 -0
- package/dist/adapters/crossws/rpc-handler.mjs +10 -0
- package/dist/adapters/fastify/handler.d.mts +21 -0
- package/dist/adapters/fastify/handler.mjs +20 -0
- package/dist/adapters/fastify/index.d.mts +2 -42
- package/dist/adapters/fastify/index.mjs +2 -39
- package/dist/adapters/fastify/rpc-handler.d.mts +14 -0
- package/dist/adapters/fastify/rpc-handler.mjs +10 -0
- package/dist/adapters/fetch/handler.d.mts +23 -0
- package/dist/adapters/fetch/handler.mjs +22 -0
- package/dist/adapters/fetch/index.d.mts +6 -46
- package/dist/adapters/fetch/index.mjs +4 -41
- package/dist/adapters/fetch/rpc-handler.d.mts +16 -0
- package/dist/adapters/fetch/rpc-handler.mjs +10 -0
- package/dist/adapters/message-port/handler.d.mts +57 -0
- package/dist/adapters/message-port/handler.mjs +62 -0
- package/dist/adapters/message-port/index.d.mts +2 -77
- package/dist/adapters/message-port/index.mjs +2 -87
- package/dist/adapters/message-port/rpc-handler.d.mts +15 -0
- package/dist/adapters/message-port/rpc-handler.mjs +10 -0
- package/dist/adapters/node/handler.d.mts +21 -0
- package/dist/adapters/node/handler.mjs +20 -0
- package/dist/adapters/node/index.d.mts +6 -43
- package/dist/adapters/node/index.mjs +4 -40
- package/dist/adapters/node/rpc-handler.d.mts +15 -0
- package/dist/adapters/node/rpc-handler.mjs +10 -0
- package/dist/adapters/standard/codec.d.mts +16 -0
- package/dist/adapters/standard/codec.mjs +1 -0
- package/dist/adapters/standard/handler.d.mts +68 -0
- package/dist/adapters/standard/handler.mjs +185 -0
- package/dist/adapters/standard/index.d.mts +6 -95
- package/dist/adapters/standard/index.mjs +5 -8
- package/dist/adapters/standard/plugin.d.mts +32 -0
- package/dist/adapters/standard/plugin.mjs +16 -0
- package/dist/adapters/standard/rpc-handler-codec.d.mts +42 -0
- package/dist/adapters/standard/rpc-handler-codec.mjs +51 -0
- package/dist/adapters/standard/rpc-matcher.d.mts +53 -0
- package/dist/adapters/standard/rpc-matcher.mjs +140 -0
- package/dist/adapters/standard/utils.d.mts +10 -0
- package/dist/adapters/standard/utils.mjs +6 -0
- package/dist/adapters/standard-peer/index.d.mts +1 -11
- package/dist/adapters/standard-peer/index.mjs +1 -10
- package/dist/adapters/standard-peer/utils.d.mts +4 -0
- package/dist/adapters/standard-peer/utils.mjs +11 -0
- package/dist/adapters/websocket/handler.d.mts +55 -0
- package/dist/adapters/websocket/handler.mjs +55 -0
- package/dist/adapters/websocket/index.d.mts +2 -77
- package/dist/adapters/websocket/index.mjs +2 -87
- package/dist/adapters/websocket/rpc-handler.d.mts +15 -0
- package/dist/adapters/websocket/rpc-handler.mjs +10 -0
- package/dist/builder-variants.d.mts +267 -0
- package/dist/builder-variants.mjs +1 -0
- package/dist/builder.d.mts +141 -0
- package/dist/builder.mjs +145 -0
- package/dist/constants.d.mts +2 -0
- package/dist/constants.mjs +2 -0
- package/dist/context.d.mts +13 -0
- package/dist/context.mjs +1 -0
- package/dist/extensions/callable.d.mts +16 -9
- package/dist/extensions/callable.mjs +5 -9
- package/dist/helpers/base64url.d.mts +31 -0
- package/dist/helpers/base64url.mjs +25 -0
- package/dist/helpers/cookie.d.mts +50 -0
- package/dist/helpers/cookie.mjs +35 -0
- package/dist/helpers/encryption.d.mts +28 -0
- package/dist/helpers/encryption.mjs +62 -0
- package/dist/helpers/index.d.mts +4 -167
- package/dist/helpers/index.mjs +4 -200
- package/dist/helpers/signing.d.mts +50 -0
- package/dist/helpers/signing.mjs +43 -0
- package/dist/implementer-procedure.d.mts +36 -0
- package/dist/implementer-procedure.mjs +38 -0
- package/dist/implementer-router.d.mts +78 -0
- package/dist/implementer-router.mjs +77 -0
- package/dist/implementer.d.mts +22 -0
- package/dist/implementer.mjs +30 -0
- package/dist/index.d.mts +57 -476
- package/dist/index.mjs +25 -458
- package/dist/lazy.d.mts +20 -0
- package/dist/lazy.mjs +22 -0
- package/dist/middleware-decorated.d.mts +27 -0
- package/dist/middleware-decorated.mjs +65 -0
- package/dist/middleware.d.mts +70 -0
- package/dist/middleware.mjs +1 -0
- package/dist/plugins/batch.d.mts +104 -0
- package/dist/plugins/batch.mjs +373 -0
- package/dist/plugins/cors.d.mts +67 -0
- package/dist/plugins/cors.mjs +134 -0
- package/dist/plugins/get-method-csrf-protection.d.mts +23 -0
- package/dist/plugins/get-method-csrf-protection.mjs +45 -0
- package/dist/plugins/head-method.d.mts +23 -0
- package/dist/plugins/head-method.mjs +95 -0
- package/dist/plugins/index.d.mts +39 -432
- package/dist/plugins/index.mjs +23 -965
- package/dist/plugins/method-override.d.mts +38 -0
- package/dist/plugins/method-override.mjs +50 -0
- package/dist/plugins/request-compression.d.mts +16 -0
- package/dist/plugins/request-compression.mjs +67 -0
- package/dist/plugins/request-headers.d.mts +22 -0
- package/dist/plugins/request-headers.mjs +21 -0
- package/dist/plugins/request-limit.d.mts +30 -0
- package/dist/plugins/request-limit.mjs +53 -0
- package/dist/plugins/response-compression.d.mts +59 -0
- package/dist/plugins/response-compression.mjs +172 -0
- package/dist/plugins/response-headers.d.mts +30 -0
- package/dist/plugins/response-headers.mjs +34 -0
- package/dist/plugins/rethrow.d.mts +33 -0
- package/dist/plugins/rethrow.mjs +46 -0
- package/dist/plugins/signal-sync.d.mts +13 -0
- package/dist/plugins/signal-sync.mjs +84 -0
- package/dist/plugins/timeout.d.mts +37 -0
- package/dist/plugins/timeout.mjs +56 -0
- package/dist/procedure-client.d.mts +41 -0
- package/dist/procedure-client.mjs +157 -0
- package/dist/procedure-decorated.d.mts +20 -0
- package/dist/procedure-decorated.mjs +41 -0
- package/dist/procedure-utils.d.mts +52 -0
- package/dist/procedure-utils.mjs +33 -0
- package/dist/procedure.d.mts +93 -0
- package/dist/procedure.mjs +20 -0
- package/dist/router-client.d.mts +27 -0
- package/dist/router-client.mjs +35 -0
- package/dist/router-hidden.d.mts +5 -0
- package/dist/router-hidden.mjs +12 -0
- package/dist/router-utils.d.mts +59 -0
- package/dist/router-utils.mjs +191 -0
- package/dist/router.d.mts +61 -0
- package/dist/router.mjs +1 -0
- package/package.json +11 -11
- package/dist/adapters/aws-lambda/index.d.ts +0 -51
- package/dist/adapters/crossws/index.d.ts +0 -63
- package/dist/adapters/fastify/index.d.ts +0 -42
- package/dist/adapters/fetch/index.d.ts +0 -47
- package/dist/adapters/message-port/index.d.ts +0 -77
- package/dist/adapters/node/index.d.ts +0 -44
- package/dist/adapters/standard/index.d.ts +0 -95
- package/dist/adapters/standard-peer/index.d.ts +0 -11
- package/dist/adapters/websocket/index.d.ts +0 -77
- package/dist/extensions/callable.d.ts +0 -10
- package/dist/helpers/index.d.ts +0 -167
- package/dist/index.d.ts +0 -476
- package/dist/plugins/index.d.ts +0 -432
- package/dist/shared/server.1ExWFMze.mjs +0 -69
- package/dist/shared/server.9B1jEm5a.d.mts +0 -105
- package/dist/shared/server.BB464y-6.mjs +0 -207
- package/dist/shared/server.BC5BIu02.d.mts +0 -73
- package/dist/shared/server.BSYGskId.d.ts +0 -14
- package/dist/shared/server.BvG3boBj.d.mts +0 -14
- package/dist/shared/server.CTV_mC2P.d.mts +0 -34
- package/dist/shared/server.CYbIpHbH.mjs +0 -239
- package/dist/shared/server.CgBF3Vj1.d.ts +0 -34
- package/dist/shared/server.Chq5FpXf.mjs +0 -353
- package/dist/shared/server.DFPxP2v3.d.mts +0 -166
- package/dist/shared/server.DFPxP2v3.d.ts +0 -166
- package/dist/shared/server.DOg7ke6y.d.ts +0 -105
- package/dist/shared/server.Dz7j9BEh.d.ts +0 -73
- package/dist/shared/server.W91HSRkE.mjs +0 -9
- package/dist/shared/server.sBQSgqK3.mjs +0 -41
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
import { normalizeHttpPath, pathToHttpPath, value } from "@orpc/shared";
|
|
2
|
+
import { unlazy } from "../../lazy.mjs";
|
|
3
|
+
import { Procedure } from "../../procedure.mjs";
|
|
4
|
+
import { resolveContractProcedure, walkProcedureContractsSync } from "../../router-utils.mjs";
|
|
5
|
+
|
|
6
|
+
export const RPC_DEFAULT_ALLOW_METHODS = [
|
|
7
|
+
"POST",
|
|
8
|
+
"PUT",
|
|
9
|
+
"PATCH",
|
|
10
|
+
"DELETE"
|
|
11
|
+
];
|
|
12
|
+
|
|
13
|
+
const NORMALIZABLE_PATHNAME_REGEX = /[^\w\-.!~*'()/]/;
|
|
14
|
+
export class RPCMatcher {
|
|
15
|
+
filter;
|
|
16
|
+
allowMethodsSet;
|
|
17
|
+
allowMethodsFn;
|
|
18
|
+
rootRouter;
|
|
19
|
+
tree = new Map();
|
|
20
|
+
pendingLazyRouters = new Map();
|
|
21
|
+
|
|
22
|
+
maxPendingLazyRouterDepth = 0;
|
|
23
|
+
constructor(router, options = {}) {
|
|
24
|
+
this.filter = options.filter ?? true;
|
|
25
|
+
const allowMethods = options.allowMethods ?? RPC_DEFAULT_ALLOW_METHODS;
|
|
26
|
+
if (typeof allowMethods !== "function") {
|
|
27
|
+
this.allowMethodsSet = new Set(allowMethods);
|
|
28
|
+
} else {
|
|
29
|
+
this.allowMethodsFn = allowMethods;
|
|
30
|
+
}
|
|
31
|
+
this.rootRouter = router;
|
|
32
|
+
this.index(router);
|
|
33
|
+
}
|
|
34
|
+
index(router, path = []) {
|
|
35
|
+
const lazyResults = walkProcedureContractsSync(router, (procedure, procedurePath) => {
|
|
36
|
+
if (!value(this.filter, procedure, procedurePath)) {
|
|
37
|
+
return;
|
|
38
|
+
}
|
|
39
|
+
this.tree.set(pathToHttpPath(procedurePath), {
|
|
40
|
+
path: procedurePath,
|
|
41
|
+
contract: procedure,
|
|
42
|
+
|
|
43
|
+
procedure: procedure instanceof Procedure ? procedure : undefined
|
|
44
|
+
});
|
|
45
|
+
}, path);
|
|
46
|
+
for (const result of lazyResults) {
|
|
47
|
+
this.pendingLazyRouters.set(pathToHttpPath(result.path), result);
|
|
48
|
+
this.maxPendingLazyRouterDepth = Math.max(this.maxPendingLazyRouterDepth, result.path.length);
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
async match(method, pathname, prefix) {
|
|
52
|
+
if (this.allowMethodsSet && !this.allowMethodsSet.has(method)) {
|
|
53
|
+
return undefined;
|
|
54
|
+
}
|
|
55
|
+
if (prefix) {
|
|
56
|
+
if (!pathname.startsWith(prefix)) {
|
|
57
|
+
return undefined;
|
|
58
|
+
}
|
|
59
|
+
const charAfterPrefix = pathname[prefix.length];
|
|
60
|
+
if (charAfterPrefix === "/") {
|
|
61
|
+
pathname = pathname.slice(prefix.length);
|
|
62
|
+
} else if (charAfterPrefix === undefined) {
|
|
63
|
+
pathname = "/";
|
|
64
|
+
} else if (prefix[prefix.length - 1] === "/") {
|
|
65
|
+
pathname = pathname.slice(prefix.length - 1);
|
|
66
|
+
} else {
|
|
67
|
+
return undefined;
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
if (pathname.length > 1 && pathname.endsWith("/")) {
|
|
71
|
+
pathname = pathname.slice(0, -1);
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
const loading = this.resolvePendingLazyRouters(pathname);
|
|
75
|
+
if (loading !== undefined) {
|
|
76
|
+
await loading;
|
|
77
|
+
}
|
|
78
|
+
let entry = this.tree.get(pathname);
|
|
79
|
+
if (entry === undefined && NORMALIZABLE_PATHNAME_REGEX.test(pathname)) {
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
const normalizedPathname = normalizeHttpPath(pathname);
|
|
84
|
+
|
|
85
|
+
const normalizedLoading = this.resolvePendingLazyRouters(normalizedPathname);
|
|
86
|
+
if (normalizedLoading !== undefined) {
|
|
87
|
+
await normalizedLoading;
|
|
88
|
+
}
|
|
89
|
+
entry = this.tree.get(normalizedPathname);
|
|
90
|
+
}
|
|
91
|
+
if (entry === undefined) {
|
|
92
|
+
return undefined;
|
|
93
|
+
}
|
|
94
|
+
const procedure = entry.procedure ?? await this.resolveProcedure(entry);
|
|
95
|
+
if (this.allowMethodsFn && !this.allowMethodsFn(method, procedure, entry.path)) {
|
|
96
|
+
return undefined;
|
|
97
|
+
}
|
|
98
|
+
return {
|
|
99
|
+
path: entry.path,
|
|
100
|
+
procedure
|
|
101
|
+
};
|
|
102
|
+
}
|
|
103
|
+
resolvePendingLazyRouters(pathname) {
|
|
104
|
+
if (this.pendingLazyRouters.size === 0) {
|
|
105
|
+
return;
|
|
106
|
+
}
|
|
107
|
+
let slashIndex = 0;
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
for (let depth = 1; slashIndex !== -1 && depth <= this.maxPendingLazyRouterDepth; depth++) {
|
|
111
|
+
const nextSlashIndex = pathname.indexOf("/", slashIndex + 1);
|
|
112
|
+
const httpPathPrefix = nextSlashIndex === -1 ? pathname : pathname.slice(0, nextSlashIndex);
|
|
113
|
+
const pending = this.pendingLazyRouters.get(httpPathPrefix);
|
|
114
|
+
if (pending !== undefined) {
|
|
115
|
+
return this.loadPendingLazyRouter(httpPathPrefix, pending).then(() => this.resolvePendingLazyRouters(pathname));
|
|
116
|
+
}
|
|
117
|
+
slashIndex = nextSlashIndex;
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
loadPendingLazyRouter(httpPathPrefix, pending) {
|
|
121
|
+
if (pending.loading === undefined) {
|
|
122
|
+
pending.loading = this.indexPendingLazyRouter(httpPathPrefix, pending).catch((error) => {
|
|
123
|
+
pending.loading = undefined;
|
|
124
|
+
throw error;
|
|
125
|
+
});
|
|
126
|
+
}
|
|
127
|
+
return pending.loading;
|
|
128
|
+
}
|
|
129
|
+
async indexPendingLazyRouter(httpPathPrefix, pending) {
|
|
130
|
+
const { default: router } = await unlazy(pending.router);
|
|
131
|
+
this.index(router, pending.path);
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
this.pendingLazyRouters.delete(httpPathPrefix);
|
|
135
|
+
}
|
|
136
|
+
async resolveProcedure(entry) {
|
|
137
|
+
entry.procedure = await resolveContractProcedure(this.rootRouter, entry.contract, entry.path);
|
|
138
|
+
return entry.procedure;
|
|
139
|
+
}
|
|
140
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { Promisable, Value } from "@orpc/shared";
|
|
2
|
+
import type { StandardLazyRequest } from "@standard-server/core";
|
|
3
|
+
import type { Context } from "../../context.mjs";
|
|
4
|
+
import type { StandardHandlerHandleOptions } from "./handler.mjs";
|
|
5
|
+
export type FriendlyStandardHandlerHandleOptions<T extends Context> = Omit<StandardHandlerHandleOptions<T>, "context"> & (object extends T ? {
|
|
6
|
+
context?: Value<Promisable<T>, [request: StandardLazyRequest]> | undefined;
|
|
7
|
+
} : {
|
|
8
|
+
context: Value<Promisable<T>, [request: StandardLazyRequest]>;
|
|
9
|
+
});
|
|
10
|
+
export declare function resolveFriendlyStandardHandlerHandleOptions<T extends Context>(options: FriendlyStandardHandlerHandleOptions<T>): StandardHandlerHandleOptions<T>;
|
|
@@ -1,11 +1 @@
|
|
|
1
|
-
|
|
2
|
-
import { Context } from '../../index.mjs';
|
|
3
|
-
import { StandardHandler } from '../standard/index.mjs';
|
|
4
|
-
import { FriendlyStandardHandlerHandleOptions } from '../standard/index.mjs';
|
|
5
|
-
import '@orpc/client';
|
|
6
|
-
import '@orpc/contract';
|
|
7
|
-
import '@orpc/shared';
|
|
8
|
-
|
|
9
|
-
declare function createStandardPeerRequestHandler<T extends Context>(handler: StandardHandler<T>, options: FriendlyStandardHandlerHandleOptions<T>): (request: StandardLazyRequest) => Promise<StandardResponse>;
|
|
10
|
-
|
|
11
|
-
export { createStandardPeerRequestHandler };
|
|
1
|
+
export * from "./utils.mjs";
|
|
@@ -1,10 +1 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
function createStandardPeerRequestHandler(handler, options) {
|
|
4
|
-
return async (request) => {
|
|
5
|
-
const { response } = await handler.handle(request, resolveFriendlyStandardHandlerHandleOptions(options));
|
|
6
|
-
return response ?? { status: 404, headers: {}, body: "No procedure matched" };
|
|
7
|
-
};
|
|
8
|
-
}
|
|
9
|
-
|
|
10
|
-
export { createStandardPeerRequestHandler };
|
|
1
|
+
export * from "./utils.mjs";
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { StandardLazyRequest, StandardResponse } from "@standard-server/core";
|
|
2
|
+
import type { Context } from "../../context.mjs";
|
|
3
|
+
import type { FriendlyStandardHandlerHandleOptions, StandardHandler } from "../standard/index.mjs";
|
|
4
|
+
export declare function createStandardPeerRequestHandler<T extends Context>(handler: StandardHandler<T>, options: FriendlyStandardHandlerHandleOptions<T>): (request: StandardLazyRequest) => Promise<StandardResponse>;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { resolveFriendlyStandardHandlerHandleOptions } from "../standard/index.mjs";
|
|
2
|
+
export function createStandardPeerRequestHandler(handler, options) {
|
|
3
|
+
return async (request) => {
|
|
4
|
+
const { response } = await handler.handle(request, resolveFriendlyStandardHandlerHandleOptions(options));
|
|
5
|
+
return response ?? {
|
|
6
|
+
status: 404,
|
|
7
|
+
headers: {},
|
|
8
|
+
body: "No procedure matched"
|
|
9
|
+
};
|
|
10
|
+
};
|
|
11
|
+
}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import type { Arrayable, MaybeOptionalOptions } from "@orpc/shared";
|
|
2
|
+
import type { DecodePeerMessageOptions, EncodePeerMessageOptions } from "@standard-server/peer";
|
|
3
|
+
import type { Context } from "../../context.mjs";
|
|
4
|
+
import type { FriendlyStandardHandlerHandleOptions, StandardHandler } from "../standard/index.mjs";
|
|
5
|
+
/**
|
|
6
|
+
* Supports standard WebSocket instances, Bun ServerWebSocket, "ws" ServerWebSocket,
|
|
7
|
+
* Cloudflare WebSocket Hibernation, and similar implementations.
|
|
8
|
+
*/
|
|
9
|
+
export type WebSocketLike = {
|
|
10
|
+
send: (data: string | Uint8Array<ArrayBuffer>) => unknown;
|
|
11
|
+
};
|
|
12
|
+
export interface WebSocketHandlerOptions<_T extends Context> {
|
|
13
|
+
/**
|
|
14
|
+
* Options for encoding peer messages. such as `prefix` for distinguishing messages on the same channel..
|
|
15
|
+
*/
|
|
16
|
+
encodePeerMessage?: EncodePeerMessageOptions | undefined;
|
|
17
|
+
/**
|
|
18
|
+
* Options for decoding peer messages. such as `prefix` for distinguishing messages on the same channel..
|
|
19
|
+
*/
|
|
20
|
+
decodePeerMessage?: DecodePeerMessageOptions | undefined;
|
|
21
|
+
}
|
|
22
|
+
export declare class WebSocketHandler<T extends Context> {
|
|
23
|
+
private readonly handler;
|
|
24
|
+
private readonly peers;
|
|
25
|
+
private readonly encodePeerMessageOptions;
|
|
26
|
+
private readonly decodePeerMessageOptions;
|
|
27
|
+
constructor(handler: StandardHandler<T>, options?: NoInfer<WebSocketHandlerOptions<T>>);
|
|
28
|
+
/**
|
|
29
|
+
* Handles a single WebSocket message.
|
|
30
|
+
*
|
|
31
|
+
* Message order matters. Call this immediately after receiving a message,
|
|
32
|
+
* before any other async work, to preserve ordering.
|
|
33
|
+
*
|
|
34
|
+
* To avoid async Blob reads, configure `ws.binaryType` to return binary data
|
|
35
|
+
* directly (for example, `arraybuffer`).
|
|
36
|
+
*
|
|
37
|
+
* @param ws The WebSocket instance. Use the same instance for all messages.
|
|
38
|
+
* @param data The received message. Binary data should already be loaded (not a `Blob`).
|
|
39
|
+
*/
|
|
40
|
+
message(ws: WebSocketLike, data: Arrayable<string | ArrayBuffer | Pick<Uint8Array<ArrayBuffer>, "buffer" | "byteOffset" | "byteLength">>, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): Promise<{
|
|
41
|
+
matched: boolean;
|
|
42
|
+
}>;
|
|
43
|
+
/**
|
|
44
|
+
* Cleans up peer state for a closed WebSocket.
|
|
45
|
+
*
|
|
46
|
+
* @param ws The same WebSocket instance passed to `.message()`.
|
|
47
|
+
*/
|
|
48
|
+
close(ws: WebSocketLike): Promise<void>;
|
|
49
|
+
/**
|
|
50
|
+
* Attaches message, close, and error event listeners to a WebSocket.
|
|
51
|
+
*
|
|
52
|
+
* Prefer this over calling `.message()` and `.close()` manually.
|
|
53
|
+
*/
|
|
54
|
+
upgrade(ws: Pick<WebSocket, "send" | "addEventListener" | "removeEventListener">, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): void;
|
|
55
|
+
}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { loadBytes, resolveMaybeOptionalOptions, sequential, toStringOrBytes } from "@orpc/shared";
|
|
2
|
+
import { decodePeerMessage, encodePeerMessage, isClientPeerSendMessage, ServerPeer } from "@standard-server/peer";
|
|
3
|
+
import { createStandardPeerRequestHandler } from "../standard-peer/index.mjs";
|
|
4
|
+
export class WebSocketHandler {
|
|
5
|
+
handler;
|
|
6
|
+
peers = new WeakMap();
|
|
7
|
+
encodePeerMessageOptions;
|
|
8
|
+
decodePeerMessageOptions;
|
|
9
|
+
constructor(handler, options = {}) {
|
|
10
|
+
this.handler = handler;
|
|
11
|
+
this.encodePeerMessageOptions = options.encodePeerMessage;
|
|
12
|
+
this.decodePeerMessageOptions = options.decodePeerMessage;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
async message(ws, data, ...rest) {
|
|
16
|
+
let peer = this.peers.get(ws);
|
|
17
|
+
if (!peer) {
|
|
18
|
+
this.peers.set(ws, peer = new ServerPeer(async (message) => {
|
|
19
|
+
const encoded = await encodePeerMessage(message, this.encodePeerMessageOptions);
|
|
20
|
+
await ws.send(encoded);
|
|
21
|
+
}));
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
const encoded = toStringOrBytes(data);
|
|
25
|
+
const result = decodePeerMessage(encoded, this.decodePeerMessageOptions);
|
|
26
|
+
if (result.matched && isClientPeerSendMessage(result.message)) {
|
|
27
|
+
await peer.message(result.message, createStandardPeerRequestHandler(this.handler, resolveMaybeOptionalOptions(rest)));
|
|
28
|
+
}
|
|
29
|
+
return result;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
async close(ws) {
|
|
33
|
+
const peer = this.peers.get(ws);
|
|
34
|
+
if (peer) {
|
|
35
|
+
|
|
36
|
+
this.peers.delete(ws);
|
|
37
|
+
await peer.close();
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
upgrade(ws, ...rest) {
|
|
42
|
+
|
|
43
|
+
ws.addEventListener("message", sequential(async (event) => {
|
|
44
|
+
|
|
45
|
+
const data = event.data instanceof Blob ? await loadBytes(event.data) : event.data;
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
this.message(ws, data, ...rest);
|
|
49
|
+
}));
|
|
50
|
+
ws.addEventListener("close", () => this.close(ws));
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
ws.addEventListener("error", () => {});
|
|
54
|
+
}
|
|
55
|
+
}
|
|
@@ -1,77 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
import { Context } from '../../index.mjs';
|
|
4
|
-
import { StandardHandler, StandardHandlerOptions } from '../standard/index.mjs';
|
|
5
|
-
import { FriendlyStandardHandlerHandleOptions } from '../standard/index.mjs';
|
|
6
|
-
import { Router } from '../../index.mjs';
|
|
7
|
-
import { RPCHandlerCodecOptions } from '../standard/index.mjs';
|
|
8
|
-
import '@orpc/client';
|
|
9
|
-
import '@orpc/contract';
|
|
10
|
-
import '@standard-server/core';
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* Supports standard WebSocket instances, Bun ServerWebSocket, "ws" ServerWebSocket,
|
|
14
|
-
* Cloudflare WebSocket Hibernation, and similar implementations.
|
|
15
|
-
*/
|
|
16
|
-
type WebSocketLike = {
|
|
17
|
-
send: (data: string | Uint8Array<ArrayBuffer>) => unknown;
|
|
18
|
-
};
|
|
19
|
-
interface WebSocketHandlerOptions<_T extends Context> {
|
|
20
|
-
/**
|
|
21
|
-
* Options for encoding peer messages. such as `prefix` for distinguishing messages on the same channel..
|
|
22
|
-
*/
|
|
23
|
-
encodePeerMessage?: EncodePeerMessageOptions | undefined;
|
|
24
|
-
/**
|
|
25
|
-
* Options for decoding peer messages. such as `prefix` for distinguishing messages on the same channel..
|
|
26
|
-
*/
|
|
27
|
-
decodePeerMessage?: DecodePeerMessageOptions | undefined;
|
|
28
|
-
}
|
|
29
|
-
declare class WebSocketHandler<T extends Context> {
|
|
30
|
-
private readonly handler;
|
|
31
|
-
private readonly peers;
|
|
32
|
-
private readonly encodePeerMessageOptions;
|
|
33
|
-
private readonly decodePeerMessageOptions;
|
|
34
|
-
constructor(handler: StandardHandler<T>, options?: NoInfer<WebSocketHandlerOptions<T>>);
|
|
35
|
-
/**
|
|
36
|
-
* Handles a single WebSocket message.
|
|
37
|
-
*
|
|
38
|
-
* Message order matters. Call this immediately after receiving a message,
|
|
39
|
-
* before any other async work, to preserve ordering.
|
|
40
|
-
*
|
|
41
|
-
* To avoid async Blob reads, configure `ws.binaryType` to return binary data
|
|
42
|
-
* directly (for example, `arraybuffer`).
|
|
43
|
-
*
|
|
44
|
-
* @param ws The WebSocket instance. Use the same instance for all messages.
|
|
45
|
-
* @param data The received message. Binary data should already be loaded (not a `Blob`).
|
|
46
|
-
*/
|
|
47
|
-
message(ws: WebSocketLike, data: Arrayable<string | ArrayBuffer | Pick<Uint8Array<ArrayBuffer>, 'buffer' | 'byteOffset' | 'byteLength'>>, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): Promise<{
|
|
48
|
-
matched: boolean;
|
|
49
|
-
}>;
|
|
50
|
-
/**
|
|
51
|
-
* Cleans up peer state for a closed WebSocket.
|
|
52
|
-
*
|
|
53
|
-
* @param ws The same WebSocket instance passed to `.message()`.
|
|
54
|
-
*/
|
|
55
|
-
close(ws: WebSocketLike): Promise<void>;
|
|
56
|
-
/**
|
|
57
|
-
* Attaches message, close, and error event listeners to a WebSocket.
|
|
58
|
-
*
|
|
59
|
-
* Prefer this over calling `.message()` and `.close()` manually.
|
|
60
|
-
*/
|
|
61
|
-
upgrade(ws: Pick<WebSocket, 'send' | 'addEventListener' | 'removeEventListener'>, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): void;
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
interface RPCHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, RPCHandlerCodecOptions<T>, WebSocketHandlerOptions<T> {
|
|
65
|
-
}
|
|
66
|
-
/**
|
|
67
|
-
* Serves an oRPC router over the RPC protocol on a standard WebSocket
|
|
68
|
-
* connection (Deno, Bun, Cloudflare Durable Objects, and more).
|
|
69
|
-
*
|
|
70
|
-
* @see {@link https://orpc.dev/docs/adapters/websocket | WebSocket Adapters}
|
|
71
|
-
*/
|
|
72
|
-
declare class RPCHandler<T extends Context> extends WebSocketHandler<T> {
|
|
73
|
-
constructor(router: Router<T>, options?: NoInfer<RPCHandlerOptions<T>>);
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
export { RPCHandler, WebSocketHandler };
|
|
77
|
-
export type { RPCHandlerOptions, WebSocketHandlerOptions, WebSocketLike };
|
|
1
|
+
export * from "./handler.mjs";
|
|
2
|
+
export * from "./rpc-handler.mjs";
|
|
@@ -1,87 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
import { createStandardPeerRequestHandler } from '../standard-peer/index.mjs';
|
|
4
|
-
import { R as RPCHandlerCodec, S as StandardHandler } from '../../shared/server.Chq5FpXf.mjs';
|
|
5
|
-
import '../../shared/server.W91HSRkE.mjs';
|
|
6
|
-
import '@orpc/client';
|
|
7
|
-
import '@standard-server/core';
|
|
8
|
-
import '../../shared/server.BB464y-6.mjs';
|
|
9
|
-
import '@orpc/contract';
|
|
10
|
-
import '../../shared/server.CYbIpHbH.mjs';
|
|
11
|
-
|
|
12
|
-
class WebSocketHandler {
|
|
13
|
-
constructor(handler, options = {}) {
|
|
14
|
-
this.handler = handler;
|
|
15
|
-
this.encodePeerMessageOptions = options.encodePeerMessage;
|
|
16
|
-
this.decodePeerMessageOptions = options.decodePeerMessage;
|
|
17
|
-
}
|
|
18
|
-
peers = /* @__PURE__ */ new WeakMap();
|
|
19
|
-
encodePeerMessageOptions;
|
|
20
|
-
decodePeerMessageOptions;
|
|
21
|
-
/**
|
|
22
|
-
* Handles a single WebSocket message.
|
|
23
|
-
*
|
|
24
|
-
* Message order matters. Call this immediately after receiving a message,
|
|
25
|
-
* before any other async work, to preserve ordering.
|
|
26
|
-
*
|
|
27
|
-
* To avoid async Blob reads, configure `ws.binaryType` to return binary data
|
|
28
|
-
* directly (for example, `arraybuffer`).
|
|
29
|
-
*
|
|
30
|
-
* @param ws The WebSocket instance. Use the same instance for all messages.
|
|
31
|
-
* @param data The received message. Binary data should already be loaded (not a `Blob`).
|
|
32
|
-
*/
|
|
33
|
-
async message(ws, data, ...rest) {
|
|
34
|
-
let peer = this.peers.get(ws);
|
|
35
|
-
if (!peer) {
|
|
36
|
-
this.peers.set(ws, peer = new ServerPeer(async (message) => {
|
|
37
|
-
const encoded2 = await encodePeerMessage(message, this.encodePeerMessageOptions);
|
|
38
|
-
await ws.send(encoded2);
|
|
39
|
-
}));
|
|
40
|
-
}
|
|
41
|
-
const encoded = toStringOrBytes(data);
|
|
42
|
-
const result = decodePeerMessage(encoded, this.decodePeerMessageOptions);
|
|
43
|
-
if (result.matched && isClientPeerSendMessage(result.message)) {
|
|
44
|
-
await peer.message(
|
|
45
|
-
result.message,
|
|
46
|
-
createStandardPeerRequestHandler(this.handler, resolveMaybeOptionalOptions(rest))
|
|
47
|
-
);
|
|
48
|
-
}
|
|
49
|
-
return result;
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* Cleans up peer state for a closed WebSocket.
|
|
53
|
-
*
|
|
54
|
-
* @param ws The same WebSocket instance passed to `.message()`.
|
|
55
|
-
*/
|
|
56
|
-
async close(ws) {
|
|
57
|
-
const peer = this.peers.get(ws);
|
|
58
|
-
if (peer) {
|
|
59
|
-
this.peers.delete(ws);
|
|
60
|
-
await peer.close();
|
|
61
|
-
}
|
|
62
|
-
}
|
|
63
|
-
/**
|
|
64
|
-
* Attaches message, close, and error event listeners to a WebSocket.
|
|
65
|
-
*
|
|
66
|
-
* Prefer this over calling `.message()` and `.close()` manually.
|
|
67
|
-
*/
|
|
68
|
-
upgrade(ws, ...rest) {
|
|
69
|
-
ws.addEventListener("message", sequential(async (event) => {
|
|
70
|
-
const data = event.data instanceof Blob ? await loadBytes(event.data) : event.data;
|
|
71
|
-
this.message(ws, data, ...rest);
|
|
72
|
-
}));
|
|
73
|
-
ws.addEventListener("close", () => this.close(ws));
|
|
74
|
-
ws.addEventListener("error", () => {
|
|
75
|
-
});
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
|
|
79
|
-
class RPCHandler extends WebSocketHandler {
|
|
80
|
-
constructor(router, options = {}) {
|
|
81
|
-
const codec = new RPCHandlerCodec(router, options);
|
|
82
|
-
const handler = new StandardHandler(codec, options);
|
|
83
|
-
super(handler, options);
|
|
84
|
-
}
|
|
85
|
-
}
|
|
86
|
-
|
|
87
|
-
export { RPCHandler, WebSocketHandler };
|
|
1
|
+
export * from "./handler.mjs";
|
|
2
|
+
export * from "./rpc-handler.mjs";
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { Context } from "../../context.mjs";
|
|
2
|
+
import type { Router } from "../../router.mjs";
|
|
3
|
+
import type { RPCHandlerCodecOptions, StandardHandlerOptions } from "../standard/index.mjs";
|
|
4
|
+
import type { WebSocketHandlerOptions } from "./handler.mjs";
|
|
5
|
+
import { WebSocketHandler } from "./handler.mjs";
|
|
6
|
+
export interface RPCHandlerOptions<T extends Context> extends StandardHandlerOptions<T>, RPCHandlerCodecOptions<T>, WebSocketHandlerOptions<T> {}
|
|
7
|
+
/**
|
|
8
|
+
* Serves an oRPC router over the RPC protocol on a standard WebSocket
|
|
9
|
+
* connection (Deno, Bun, Cloudflare Durable Objects, and more).
|
|
10
|
+
*
|
|
11
|
+
* @see {@link https://orpc.dev/docs/adapters/websocket | WebSocket Adapters}
|
|
12
|
+
*/
|
|
13
|
+
export declare class RPCHandler<T extends Context> extends WebSocketHandler<T> {
|
|
14
|
+
constructor(router: Router<T>, options?: NoInfer<RPCHandlerOptions<T>>);
|
|
15
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { RPCHandlerCodec, StandardHandler } from "../standard/index.mjs";
|
|
2
|
+
import { WebSocketHandler } from "./handler.mjs";
|
|
3
|
+
|
|
4
|
+
export class RPCHandler extends WebSocketHandler {
|
|
5
|
+
constructor(router, options = {}) {
|
|
6
|
+
const codec = new RPCHandlerCodec(router, options);
|
|
7
|
+
const handler = new StandardHandler(codec, options);
|
|
8
|
+
super(handler, options);
|
|
9
|
+
}
|
|
10
|
+
}
|