@orpc/server 0.0.0-next.96f9dd3 → 0.0.0-next.9701ec8
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 +19 -23
- package/dist/adapters/aws-lambda/index.d.mts +46 -0
- package/dist/adapters/aws-lambda/index.d.ts +46 -0
- package/dist/adapters/aws-lambda/index.mjs +42 -0
- package/dist/adapters/bun-ws/index.d.mts +36 -0
- package/dist/adapters/bun-ws/index.d.ts +36 -0
- package/dist/adapters/bun-ws/index.mjs +47 -0
- package/dist/adapters/crossws/index.d.mts +33 -0
- package/dist/adapters/crossws/index.d.ts +33 -0
- package/dist/adapters/crossws/index.mjs +45 -0
- package/dist/adapters/fetch/index.d.mts +81 -11
- package/dist/adapters/fetch/index.d.ts +81 -11
- package/dist/adapters/fetch/index.mjs +178 -8
- package/dist/adapters/message-port/index.d.mts +31 -0
- package/dist/adapters/message-port/index.d.ts +31 -0
- package/dist/adapters/message-port/index.mjs +39 -0
- package/dist/adapters/node/index.d.mts +57 -11
- package/dist/adapters/node/index.d.ts +57 -11
- package/dist/adapters/node/index.mjs +89 -22
- package/dist/adapters/standard/index.d.mts +8 -13
- package/dist/adapters/standard/index.d.ts +8 -13
- package/dist/adapters/standard/index.mjs +5 -3
- package/dist/adapters/standard-peer/index.d.mts +18 -0
- package/dist/adapters/standard-peer/index.d.ts +18 -0
- package/dist/adapters/standard-peer/index.mjs +7 -0
- package/dist/adapters/websocket/index.d.mts +54 -0
- package/dist/adapters/websocket/index.d.ts +54 -0
- package/dist/adapters/websocket/index.mjs +67 -0
- package/dist/adapters/ws/index.d.mts +31 -0
- package/dist/adapters/ws/index.d.ts +31 -0
- package/dist/adapters/ws/index.mjs +37 -0
- package/dist/helpers/index.d.mts +134 -0
- package/dist/helpers/index.d.ts +134 -0
- package/dist/helpers/index.mjs +188 -0
- package/dist/hibernation/index.d.mts +44 -0
- package/dist/hibernation/index.d.ts +44 -0
- package/dist/hibernation/index.mjs +65 -0
- package/dist/index.d.mts +563 -51
- package/dist/index.d.ts +563 -51
- package/dist/index.mjs +138 -12
- package/dist/plugins/index.d.mts +114 -11
- package/dist/plugins/index.d.ts +114 -11
- package/dist/plugins/index.mjs +147 -58
- package/dist/shared/server.B7b2w3_i.d.ts +12 -0
- package/dist/shared/server.BEFBl-Cb.d.mts +12 -0
- package/dist/shared/server.BU4WI18A.d.mts +32 -0
- package/dist/shared/server.BW-nUGgA.mjs +36 -0
- package/dist/shared/{server.C37gDhSZ.mjs → server.B_fj3X5m.mjs} +95 -51
- package/dist/shared/{server.BlxK0o8R.d.mts → server.Bmh5xd4n.d.ts} +18 -10
- package/dist/shared/{server.DLt5njUb.d.mts → server.CYNGeoCm.d.mts} +60 -9
- package/dist/shared/{server.DLt5njUb.d.ts → server.CYNGeoCm.d.ts} +60 -9
- package/dist/shared/server.CYRYFTxo.mjs +219 -0
- package/dist/shared/server.D0H-iaY3.d.ts +32 -0
- package/dist/shared/{server.BVwwTHyO.mjs → server.DZ5BIITo.mjs} +1 -1
- package/dist/shared/server.DhJj-1X9.d.mts +42 -0
- package/dist/shared/server.UVMTOWrk.mjs +26 -0
- package/dist/shared/{server.DuTpqr2w.d.ts → server.gqRxT-yN.d.mts} +18 -10
- package/dist/shared/server.jMTkVNIb.d.ts +42 -0
- package/package.json +71 -20
- package/dist/adapters/hono/index.d.mts +0 -22
- package/dist/adapters/hono/index.d.ts +0 -22
- package/dist/adapters/hono/index.mjs +0 -32
- package/dist/adapters/next/index.d.mts +0 -29
- package/dist/adapters/next/index.d.ts +0 -29
- package/dist/adapters/next/index.mjs +0 -29
- package/dist/shared/server.BFt8M4Cr.d.ts +0 -8
- package/dist/shared/server.Bc6jnvPE.d.ts +0 -10
- package/dist/shared/server.CCPFkKqC.mjs +0 -98
- package/dist/shared/server.CCgy73tk.d.mts +0 -10
- package/dist/shared/server.DJrRF9vD.mjs +0 -162
- package/dist/shared/server.JgWzFqlo.d.mts +0 -8
package/README.md
CHANGED
@@ -21,28 +21,24 @@
|
|
21
21
|
|
22
22
|
<h3 align="center">Typesafe APIs Made Simple 🪄</h3>
|
23
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
|
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
25
|
|
26
26
|
---
|
27
27
|
|
28
28
|
## Highlights
|
29
29
|
|
30
|
-
-
|
31
|
-
-
|
32
|
-
-
|
33
|
-
-
|
34
|
-
-
|
35
|
-
-
|
36
|
-
-
|
37
|
-
-
|
38
|
-
-
|
39
|
-
-
|
40
|
-
-
|
41
|
-
-
|
42
|
-
- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
|
43
|
-
- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
|
44
|
-
- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
|
45
|
-
- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
|
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
|
+
- **🔍 First-Class OpenTelemetry**: Seamlessly integrate with OpenTelemetry for observability.
|
34
|
+
- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte, Angular), Pinia Colada, and more.
|
35
|
+
- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
|
36
|
+
- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
|
37
|
+
- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
|
38
|
+
- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
|
39
|
+
- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
|
40
|
+
- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
|
41
|
+
- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
|
46
42
|
|
47
43
|
## Documentation
|
48
44
|
|
@@ -53,13 +49,13 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
53
49
|
- [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
|
54
50
|
- [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
|
55
51
|
- [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
|
52
|
+
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
53
|
+
- [@orpc/otel](https://www.npmjs.com/package/@orpc/otel): [OpenTelemetry](https://opentelemetry.io/) integration for observability.
|
54
|
+
- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with [NestJS](https://nestjs.com/).
|
56
55
|
- [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
|
57
|
-
- [@orpc/
|
58
|
-
- [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
|
59
|
-
- [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
|
60
|
-
- [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
|
56
|
+
- [@orpc/tanstack-query](https://www.npmjs.com/package/@orpc/tanstack-query): [TanStack Query](https://tanstack.com/query/latest) integration.
|
61
57
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
62
|
-
- [@orpc/
|
58
|
+
- [@orpc/hey-api](https://www.npmjs.com/package/@orpc/hey-api): [Hey API](https://heyapi.dev/) integration.
|
63
59
|
- [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
|
64
60
|
- [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
|
65
61
|
- [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
|
@@ -71,7 +67,7 @@ Build your API or implement API contract. Read the [documentation](https://orpc.
|
|
71
67
|
```ts
|
72
68
|
import type { IncomingHttpHeaders } from 'node:http'
|
73
69
|
import { ORPCError, os } from '@orpc/server'
|
74
|
-
import
|
70
|
+
import * as z from 'zod'
|
75
71
|
|
76
72
|
const PlanetSchema = z.object({
|
77
73
|
id: z.number().int().min(1),
|
@@ -0,0 +1,46 @@
|
|
1
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { SendStandardResponseOptions, APIGatewayProxyEventV2, ResponseStream } from '@orpc/standard-server-aws-lambda';
|
3
|
+
import { C as Context, R as Router } from '../../shared/server.CYNGeoCm.mjs';
|
4
|
+
import { f as StandardHandler } from '../../shared/server.gqRxT-yN.mjs';
|
5
|
+
import { F as FriendlyStandardHandleOptions } from '../../shared/server.BEFBl-Cb.mjs';
|
6
|
+
import { S as StandardRPCHandlerOptions } from '../../shared/server.BU4WI18A.mjs';
|
7
|
+
import '@orpc/client';
|
8
|
+
import '@orpc/contract';
|
9
|
+
import '@orpc/standard-server';
|
10
|
+
import '@orpc/client/standard';
|
11
|
+
import '../../shared/server.DhJj-1X9.mjs';
|
12
|
+
|
13
|
+
interface AwsLambdaHandlerOptions extends SendStandardResponseOptions {
|
14
|
+
}
|
15
|
+
type AwsLambdaHandleResult = {
|
16
|
+
matched: true;
|
17
|
+
} | {
|
18
|
+
matched: false;
|
19
|
+
};
|
20
|
+
declare class AwsLambdaHandler<T extends Context> {
|
21
|
+
private readonly standardHandler;
|
22
|
+
private readonly sendStandardResponseOptions;
|
23
|
+
constructor(standardHandler: StandardHandler<T>, options?: AwsLambdaHandlerOptions);
|
24
|
+
handle(event: APIGatewayProxyEventV2, responseStream: ResponseStream, ...rest: MaybeOptionalOptions<FriendlyStandardHandleOptions<T>>): Promise<AwsLambdaHandleResult>;
|
25
|
+
}
|
26
|
+
|
27
|
+
type RPCHandlerOptions<T extends Context> = AwsLambdaHandlerOptions & StandardRPCHandlerOptions<T> & {
|
28
|
+
/**
|
29
|
+
* Enables or disables the StrictGetMethodPlugin.
|
30
|
+
*
|
31
|
+
* @default true
|
32
|
+
*/
|
33
|
+
strictGetMethodPluginEnabled?: boolean;
|
34
|
+
};
|
35
|
+
/**
|
36
|
+
* RPC Handler for AWS Lambda.
|
37
|
+
*
|
38
|
+
* @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
|
39
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
|
40
|
+
*/
|
41
|
+
declare class RPCHandler<T extends Context> extends AwsLambdaHandler<T> {
|
42
|
+
constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
|
43
|
+
}
|
44
|
+
|
45
|
+
export { AwsLambdaHandler, RPCHandler };
|
46
|
+
export type { AwsLambdaHandleResult, AwsLambdaHandlerOptions, RPCHandlerOptions };
|
@@ -0,0 +1,46 @@
|
|
1
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { SendStandardResponseOptions, APIGatewayProxyEventV2, ResponseStream } from '@orpc/standard-server-aws-lambda';
|
3
|
+
import { C as Context, R as Router } from '../../shared/server.CYNGeoCm.js';
|
4
|
+
import { f as StandardHandler } from '../../shared/server.Bmh5xd4n.js';
|
5
|
+
import { F as FriendlyStandardHandleOptions } from '../../shared/server.B7b2w3_i.js';
|
6
|
+
import { S as StandardRPCHandlerOptions } from '../../shared/server.D0H-iaY3.js';
|
7
|
+
import '@orpc/client';
|
8
|
+
import '@orpc/contract';
|
9
|
+
import '@orpc/standard-server';
|
10
|
+
import '@orpc/client/standard';
|
11
|
+
import '../../shared/server.jMTkVNIb.js';
|
12
|
+
|
13
|
+
interface AwsLambdaHandlerOptions extends SendStandardResponseOptions {
|
14
|
+
}
|
15
|
+
type AwsLambdaHandleResult = {
|
16
|
+
matched: true;
|
17
|
+
} | {
|
18
|
+
matched: false;
|
19
|
+
};
|
20
|
+
declare class AwsLambdaHandler<T extends Context> {
|
21
|
+
private readonly standardHandler;
|
22
|
+
private readonly sendStandardResponseOptions;
|
23
|
+
constructor(standardHandler: StandardHandler<T>, options?: AwsLambdaHandlerOptions);
|
24
|
+
handle(event: APIGatewayProxyEventV2, responseStream: ResponseStream, ...rest: MaybeOptionalOptions<FriendlyStandardHandleOptions<T>>): Promise<AwsLambdaHandleResult>;
|
25
|
+
}
|
26
|
+
|
27
|
+
type RPCHandlerOptions<T extends Context> = AwsLambdaHandlerOptions & StandardRPCHandlerOptions<T> & {
|
28
|
+
/**
|
29
|
+
* Enables or disables the StrictGetMethodPlugin.
|
30
|
+
*
|
31
|
+
* @default true
|
32
|
+
*/
|
33
|
+
strictGetMethodPluginEnabled?: boolean;
|
34
|
+
};
|
35
|
+
/**
|
36
|
+
* RPC Handler for AWS Lambda.
|
37
|
+
*
|
38
|
+
* @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
|
39
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
|
40
|
+
*/
|
41
|
+
declare class RPCHandler<T extends Context> extends AwsLambdaHandler<T> {
|
42
|
+
constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
|
43
|
+
}
|
44
|
+
|
45
|
+
export { AwsLambdaHandler, RPCHandler };
|
46
|
+
export type { AwsLambdaHandleResult, AwsLambdaHandlerOptions, RPCHandlerOptions };
|
@@ -0,0 +1,42 @@
|
|
1
|
+
import { resolveMaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { toStandardLazyRequest, sendStandardResponse } from '@orpc/standard-server-aws-lambda';
|
3
|
+
import { r as resolveFriendlyStandardHandleOptions } from '../../shared/server.DZ5BIITo.mjs';
|
4
|
+
import '@orpc/standard-server';
|
5
|
+
import '@orpc/standard-server/batch';
|
6
|
+
import '@orpc/standard-server-fetch';
|
7
|
+
import '@orpc/client';
|
8
|
+
import { S as StrictGetMethodPlugin } from '../../shared/server.BW-nUGgA.mjs';
|
9
|
+
import '@orpc/contract';
|
10
|
+
import { b as StandardRPCHandler } from '../../shared/server.CYRYFTxo.mjs';
|
11
|
+
import '@orpc/client/standard';
|
12
|
+
import '../../shared/server.B_fj3X5m.mjs';
|
13
|
+
|
14
|
+
class AwsLambdaHandler {
|
15
|
+
constructor(standardHandler, options = {}) {
|
16
|
+
this.standardHandler = standardHandler;
|
17
|
+
this.sendStandardResponseOptions = options;
|
18
|
+
}
|
19
|
+
sendStandardResponseOptions;
|
20
|
+
async handle(event, responseStream, ...rest) {
|
21
|
+
const standardRequest = toStandardLazyRequest(event, responseStream);
|
22
|
+
const options = resolveFriendlyStandardHandleOptions(resolveMaybeOptionalOptions(rest));
|
23
|
+
const result = await this.standardHandler.handle(standardRequest, options);
|
24
|
+
if (!result.matched) {
|
25
|
+
return { matched: false };
|
26
|
+
}
|
27
|
+
await sendStandardResponse(responseStream, result.response, this.sendStandardResponseOptions);
|
28
|
+
return { matched: true };
|
29
|
+
}
|
30
|
+
}
|
31
|
+
|
32
|
+
class RPCHandler extends AwsLambdaHandler {
|
33
|
+
constructor(router, options = {}) {
|
34
|
+
if (options.strictGetMethodPluginEnabled ?? true) {
|
35
|
+
options.plugins ??= [];
|
36
|
+
options.plugins.push(new StrictGetMethodPlugin());
|
37
|
+
}
|
38
|
+
super(new StandardRPCHandler(router, options), options);
|
39
|
+
}
|
40
|
+
}
|
41
|
+
|
42
|
+
export { AwsLambdaHandler, RPCHandler };
|
@@ -0,0 +1,36 @@
|
|
1
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { C as Context, R as Router } from '../../shared/server.CYNGeoCm.mjs';
|
3
|
+
import { f as StandardHandler } from '../../shared/server.gqRxT-yN.mjs';
|
4
|
+
import { HandleStandardServerPeerMessageOptions } from '../standard-peer/index.mjs';
|
5
|
+
import { S as StandardRPCHandlerOptions } from '../../shared/server.BU4WI18A.mjs';
|
6
|
+
import '@orpc/client';
|
7
|
+
import '@orpc/contract';
|
8
|
+
import '@orpc/standard-server';
|
9
|
+
import '@orpc/standard-server-peer';
|
10
|
+
import '../../shared/server.BEFBl-Cb.mjs';
|
11
|
+
import '@orpc/client/standard';
|
12
|
+
import '../../shared/server.DhJj-1X9.mjs';
|
13
|
+
|
14
|
+
interface ServerWebSocket {
|
15
|
+
send(message: string | ArrayBufferLike | Uint8Array): number;
|
16
|
+
}
|
17
|
+
declare class BunWsHandler<T extends Context> {
|
18
|
+
private readonly standardHandler;
|
19
|
+
private readonly peers;
|
20
|
+
constructor(standardHandler: StandardHandler<T>);
|
21
|
+
message(ws: ServerWebSocket, message: string | ArrayBufferView, ...rest: MaybeOptionalOptions<HandleStandardServerPeerMessageOptions<T>>): Promise<void>;
|
22
|
+
close(ws: ServerWebSocket): void;
|
23
|
+
}
|
24
|
+
|
25
|
+
/**
|
26
|
+
* RPC Handler for Bun WS adapter
|
27
|
+
*
|
28
|
+
* @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
|
29
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/websocket Websocket Adapter Docs}
|
30
|
+
*/
|
31
|
+
declare class RPCHandler<T extends Context> extends BunWsHandler<T> {
|
32
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardRPCHandlerOptions<T>>);
|
33
|
+
}
|
34
|
+
|
35
|
+
export { BunWsHandler, RPCHandler };
|
36
|
+
export type { ServerWebSocket };
|
@@ -0,0 +1,36 @@
|
|
1
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { C as Context, R as Router } from '../../shared/server.CYNGeoCm.js';
|
3
|
+
import { f as StandardHandler } from '../../shared/server.Bmh5xd4n.js';
|
4
|
+
import { HandleStandardServerPeerMessageOptions } from '../standard-peer/index.js';
|
5
|
+
import { S as StandardRPCHandlerOptions } from '../../shared/server.D0H-iaY3.js';
|
6
|
+
import '@orpc/client';
|
7
|
+
import '@orpc/contract';
|
8
|
+
import '@orpc/standard-server';
|
9
|
+
import '@orpc/standard-server-peer';
|
10
|
+
import '../../shared/server.B7b2w3_i.js';
|
11
|
+
import '@orpc/client/standard';
|
12
|
+
import '../../shared/server.jMTkVNIb.js';
|
13
|
+
|
14
|
+
interface ServerWebSocket {
|
15
|
+
send(message: string | ArrayBufferLike | Uint8Array): number;
|
16
|
+
}
|
17
|
+
declare class BunWsHandler<T extends Context> {
|
18
|
+
private readonly standardHandler;
|
19
|
+
private readonly peers;
|
20
|
+
constructor(standardHandler: StandardHandler<T>);
|
21
|
+
message(ws: ServerWebSocket, message: string | ArrayBufferView, ...rest: MaybeOptionalOptions<HandleStandardServerPeerMessageOptions<T>>): Promise<void>;
|
22
|
+
close(ws: ServerWebSocket): void;
|
23
|
+
}
|
24
|
+
|
25
|
+
/**
|
26
|
+
* RPC Handler for Bun WS adapter
|
27
|
+
*
|
28
|
+
* @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
|
29
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/websocket Websocket Adapter Docs}
|
30
|
+
*/
|
31
|
+
declare class RPCHandler<T extends Context> extends BunWsHandler<T> {
|
32
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardRPCHandlerOptions<T>>);
|
33
|
+
}
|
34
|
+
|
35
|
+
export { BunWsHandler, RPCHandler };
|
36
|
+
export type { ServerWebSocket };
|
@@ -0,0 +1,47 @@
|
|
1
|
+
import { resolveMaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { ServerPeer } from '@orpc/standard-server-peer';
|
3
|
+
import { c as createServerPeerHandleRequestFn } from '../../shared/server.UVMTOWrk.mjs';
|
4
|
+
import '@orpc/client';
|
5
|
+
import '@orpc/standard-server';
|
6
|
+
import '@orpc/contract';
|
7
|
+
import { b as StandardRPCHandler } from '../../shared/server.CYRYFTxo.mjs';
|
8
|
+
import '@orpc/client/standard';
|
9
|
+
import '../../shared/server.DZ5BIITo.mjs';
|
10
|
+
import '../../shared/server.B_fj3X5m.mjs';
|
11
|
+
|
12
|
+
class BunWsHandler {
|
13
|
+
constructor(standardHandler) {
|
14
|
+
this.standardHandler = standardHandler;
|
15
|
+
}
|
16
|
+
peers = /* @__PURE__ */ new WeakMap();
|
17
|
+
async message(ws, message, ...rest) {
|
18
|
+
let peer = this.peers.get(ws);
|
19
|
+
if (!peer) {
|
20
|
+
this.peers.set(ws, peer = new ServerPeer(
|
21
|
+
(message2) => {
|
22
|
+
ws.send(message2);
|
23
|
+
}
|
24
|
+
));
|
25
|
+
}
|
26
|
+
const encodedMessage = typeof message === "string" ? message : new Uint8Array(message.buffer, message.byteOffset, message.byteLength);
|
27
|
+
await peer.message(
|
28
|
+
encodedMessage,
|
29
|
+
createServerPeerHandleRequestFn(this.standardHandler, resolveMaybeOptionalOptions(rest))
|
30
|
+
);
|
31
|
+
}
|
32
|
+
close(ws) {
|
33
|
+
const server = this.peers.get(ws);
|
34
|
+
if (server) {
|
35
|
+
server.close();
|
36
|
+
this.peers.delete(ws);
|
37
|
+
}
|
38
|
+
}
|
39
|
+
}
|
40
|
+
|
41
|
+
class RPCHandler extends BunWsHandler {
|
42
|
+
constructor(router, options = {}) {
|
43
|
+
super(new StandardRPCHandler(router, options));
|
44
|
+
}
|
45
|
+
}
|
46
|
+
|
47
|
+
export { BunWsHandler, RPCHandler };
|
@@ -0,0 +1,33 @@
|
|
1
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { Peer, Message } from 'crossws';
|
3
|
+
import { C as Context, R as Router } from '../../shared/server.CYNGeoCm.mjs';
|
4
|
+
import { f as StandardHandler } from '../../shared/server.gqRxT-yN.mjs';
|
5
|
+
import { HandleStandardServerPeerMessageOptions } from '../standard-peer/index.mjs';
|
6
|
+
import { S as StandardRPCHandlerOptions } from '../../shared/server.BU4WI18A.mjs';
|
7
|
+
import '@orpc/client';
|
8
|
+
import '@orpc/contract';
|
9
|
+
import '@orpc/standard-server';
|
10
|
+
import '@orpc/standard-server-peer';
|
11
|
+
import '../../shared/server.BEFBl-Cb.mjs';
|
12
|
+
import '@orpc/client/standard';
|
13
|
+
import '../../shared/server.DhJj-1X9.mjs';
|
14
|
+
|
15
|
+
declare class experimental_CrosswsHandler<T extends Context> {
|
16
|
+
private readonly standardHandler;
|
17
|
+
private readonly peers;
|
18
|
+
constructor(standardHandler: StandardHandler<T>);
|
19
|
+
message(ws: Pick<Peer, 'send'>, message: Pick<Message, 'rawData' | 'uint8Array'>, ...rest: MaybeOptionalOptions<HandleStandardServerPeerMessageOptions<T>>): Promise<void>;
|
20
|
+
close(ws: Pick<Peer, 'send'>): void;
|
21
|
+
}
|
22
|
+
|
23
|
+
/**
|
24
|
+
* RPC Handler for Crossws adapter
|
25
|
+
*
|
26
|
+
* @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
|
27
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/websocket Websocket Adapter Docs}
|
28
|
+
*/
|
29
|
+
declare class experimental_RPCHandler<T extends Context> extends experimental_CrosswsHandler<T> {
|
30
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardRPCHandlerOptions<T>>);
|
31
|
+
}
|
32
|
+
|
33
|
+
export { experimental_CrosswsHandler, experimental_RPCHandler };
|
@@ -0,0 +1,33 @@
|
|
1
|
+
import { MaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { Peer, Message } from 'crossws';
|
3
|
+
import { C as Context, R as Router } from '../../shared/server.CYNGeoCm.js';
|
4
|
+
import { f as StandardHandler } from '../../shared/server.Bmh5xd4n.js';
|
5
|
+
import { HandleStandardServerPeerMessageOptions } from '../standard-peer/index.js';
|
6
|
+
import { S as StandardRPCHandlerOptions } from '../../shared/server.D0H-iaY3.js';
|
7
|
+
import '@orpc/client';
|
8
|
+
import '@orpc/contract';
|
9
|
+
import '@orpc/standard-server';
|
10
|
+
import '@orpc/standard-server-peer';
|
11
|
+
import '../../shared/server.B7b2w3_i.js';
|
12
|
+
import '@orpc/client/standard';
|
13
|
+
import '../../shared/server.jMTkVNIb.js';
|
14
|
+
|
15
|
+
declare class experimental_CrosswsHandler<T extends Context> {
|
16
|
+
private readonly standardHandler;
|
17
|
+
private readonly peers;
|
18
|
+
constructor(standardHandler: StandardHandler<T>);
|
19
|
+
message(ws: Pick<Peer, 'send'>, message: Pick<Message, 'rawData' | 'uint8Array'>, ...rest: MaybeOptionalOptions<HandleStandardServerPeerMessageOptions<T>>): Promise<void>;
|
20
|
+
close(ws: Pick<Peer, 'send'>): void;
|
21
|
+
}
|
22
|
+
|
23
|
+
/**
|
24
|
+
* RPC Handler for Crossws adapter
|
25
|
+
*
|
26
|
+
* @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
|
27
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/websocket Websocket Adapter Docs}
|
28
|
+
*/
|
29
|
+
declare class experimental_RPCHandler<T extends Context> extends experimental_CrosswsHandler<T> {
|
30
|
+
constructor(router: Router<any, T>, options?: NoInfer<StandardRPCHandlerOptions<T>>);
|
31
|
+
}
|
32
|
+
|
33
|
+
export { experimental_CrosswsHandler, experimental_RPCHandler };
|
@@ -0,0 +1,45 @@
|
|
1
|
+
import { resolveMaybeOptionalOptions } from '@orpc/shared';
|
2
|
+
import { ServerPeer } from '@orpc/standard-server-peer';
|
3
|
+
import { c as createServerPeerHandleRequestFn } from '../../shared/server.UVMTOWrk.mjs';
|
4
|
+
import '@orpc/client';
|
5
|
+
import '@orpc/standard-server';
|
6
|
+
import '@orpc/contract';
|
7
|
+
import { b as StandardRPCHandler } from '../../shared/server.CYRYFTxo.mjs';
|
8
|
+
import '@orpc/client/standard';
|
9
|
+
import '../../shared/server.DZ5BIITo.mjs';
|
10
|
+
import '../../shared/server.B_fj3X5m.mjs';
|
11
|
+
|
12
|
+
class experimental_CrosswsHandler {
|
13
|
+
constructor(standardHandler) {
|
14
|
+
this.standardHandler = standardHandler;
|
15
|
+
}
|
16
|
+
peers = /* @__PURE__ */ new WeakMap();
|
17
|
+
async message(ws, message, ...rest) {
|
18
|
+
let peer = this.peers.get(ws);
|
19
|
+
if (!peer) {
|
20
|
+
this.peers.set(ws, peer = new ServerPeer((message2) => {
|
21
|
+
ws.send(message2);
|
22
|
+
}));
|
23
|
+
}
|
24
|
+
const encodedMessage = typeof message.rawData === "string" ? message.rawData : message.uint8Array();
|
25
|
+
await peer.message(
|
26
|
+
encodedMessage,
|
27
|
+
createServerPeerHandleRequestFn(this.standardHandler, resolveMaybeOptionalOptions(rest))
|
28
|
+
);
|
29
|
+
}
|
30
|
+
close(ws) {
|
31
|
+
const server = this.peers.get(ws);
|
32
|
+
if (server) {
|
33
|
+
server.close();
|
34
|
+
this.peers.delete(ws);
|
35
|
+
}
|
36
|
+
}
|
37
|
+
}
|
38
|
+
|
39
|
+
class experimental_RPCHandler extends experimental_CrosswsHandler {
|
40
|
+
constructor(router, options = {}) {
|
41
|
+
super(new StandardRPCHandler(router, options));
|
42
|
+
}
|
43
|
+
}
|
44
|
+
|
45
|
+
export { experimental_CrosswsHandler, experimental_RPCHandler };
|
@@ -1,13 +1,21 @@
|
|
1
|
-
import { C as Context, R as Router } from '../../shared/server.
|
2
|
-
import { Interceptor,
|
3
|
-
import { g as StandardHandlerPlugin, S as StandardHandleOptions, i as StandardHandler } from '../../shared/server.BlxK0o8R.mjs';
|
4
|
-
import { F as FriendlyStandardHandleOptions } from '../../shared/server.CCgy73tk.mjs';
|
1
|
+
import { C as Context, R as Router } from '../../shared/server.CYNGeoCm.mjs';
|
2
|
+
import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
|
5
3
|
import { ToFetchResponseOptions } from '@orpc/standard-server-fetch';
|
6
|
-
import {
|
4
|
+
import { g as StandardHandlerPlugin, C as CompositeStandardHandlerPlugin, b as StandardHandleOptions, f as StandardHandler } from '../../shared/server.gqRxT-yN.mjs';
|
5
|
+
import { F as FriendlyStandardHandleOptions } from '../../shared/server.BEFBl-Cb.mjs';
|
6
|
+
import { S as StandardRPCHandlerOptions } from '../../shared/server.BU4WI18A.mjs';
|
7
7
|
import '@orpc/client';
|
8
8
|
import '@orpc/contract';
|
9
9
|
import '@orpc/standard-server';
|
10
10
|
import '@orpc/client/standard';
|
11
|
+
import '../../shared/server.DhJj-1X9.mjs';
|
12
|
+
|
13
|
+
interface FetchHandlerPlugin<T extends Context> extends StandardHandlerPlugin<T> {
|
14
|
+
initRuntimeAdapter?(options: FetchHandlerOptions<T>): void;
|
15
|
+
}
|
16
|
+
declare class CompositeFetchHandlerPlugin<T extends Context, TPlugin extends FetchHandlerPlugin<T>> extends CompositeStandardHandlerPlugin<T, TPlugin> implements FetchHandlerPlugin<T> {
|
17
|
+
initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
|
18
|
+
}
|
11
19
|
|
12
20
|
type FetchHandleResult = {
|
13
21
|
matched: true;
|
@@ -16,15 +24,12 @@ type FetchHandleResult = {
|
|
16
24
|
matched: false;
|
17
25
|
response: undefined;
|
18
26
|
};
|
19
|
-
interface FetchHandlerPlugin<T extends Context> extends StandardHandlerPlugin<T> {
|
20
|
-
initRuntimeAdapter?(options: FetchHandlerOptions<T>): void;
|
21
|
-
}
|
22
27
|
interface FetchHandlerInterceptorOptions<T extends Context> extends StandardHandleOptions<T> {
|
23
28
|
request: Request;
|
24
29
|
toFetchResponseOptions: ToFetchResponseOptions;
|
25
30
|
}
|
26
31
|
interface FetchHandlerOptions<T extends Context> extends ToFetchResponseOptions {
|
27
|
-
adapterInterceptors?: Interceptor<FetchHandlerInterceptorOptions<T>, FetchHandleResult
|
32
|
+
adapterInterceptors?: Interceptor<FetchHandlerInterceptorOptions<T>, Promise<FetchHandleResult>>[];
|
28
33
|
plugins?: FetchHandlerPlugin<T>[];
|
29
34
|
}
|
30
35
|
declare class FetchHandler<T extends Context> {
|
@@ -41,14 +46,79 @@ interface BodyLimitPluginOptions {
|
|
41
46
|
*/
|
42
47
|
maxBodySize: number;
|
43
48
|
}
|
49
|
+
/**
|
50
|
+
* The Body Limit Plugin restricts the size of the request body for the Fetch Server.
|
51
|
+
*
|
52
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/body-limit Body Limit Plugin Docs}
|
53
|
+
*/
|
44
54
|
declare class BodyLimitPlugin<T extends Context> implements FetchHandlerPlugin<T> {
|
45
55
|
private readonly maxBodySize;
|
46
56
|
constructor(options: BodyLimitPluginOptions);
|
47
57
|
initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
|
48
58
|
}
|
49
59
|
|
60
|
+
/**
|
61
|
+
* This plugin is heavily inspired by the [Hono Compression Plugin](https://github.com/honojs/hono/blob/main/src/middleware/compress/index.ts)
|
62
|
+
*/
|
63
|
+
|
64
|
+
declare const ORDERED_SUPPORTED_ENCODINGS: readonly ["gzip", "deflate"];
|
65
|
+
interface CompressionPluginOptions {
|
66
|
+
/**
|
67
|
+
* The compression schemes to use for response compression.
|
68
|
+
* Schemes are prioritized by their order in this array and
|
69
|
+
* only applied if the client supports them.
|
70
|
+
*
|
71
|
+
* @default ['gzip', 'deflate']
|
72
|
+
*/
|
73
|
+
encodings?: readonly (typeof ORDERED_SUPPORTED_ENCODINGS)[number][];
|
74
|
+
/**
|
75
|
+
* The minimum response size in bytes required to trigger compression.
|
76
|
+
* Responses smaller than this threshold will not be compressed to avoid overhead.
|
77
|
+
* If the response size cannot be determined, compression will still be applied.
|
78
|
+
*
|
79
|
+
* @default 1024 (1KB)
|
80
|
+
*/
|
81
|
+
threshold?: number;
|
82
|
+
/**
|
83
|
+
* Override the default content-type filter used to determine which responses should be compressed.
|
84
|
+
*
|
85
|
+
* @warning [Event Iterator](https://orpc.unnoq.com/docs/event-iterator) responses are never compressed, regardless of this filter's return value.
|
86
|
+
* @default only responses with compressible content types are compressed.
|
87
|
+
*/
|
88
|
+
filter?: (request: Request, response: Response) => boolean;
|
89
|
+
}
|
90
|
+
/**
|
91
|
+
* The Compression Plugin adds response compression to the Fetch Server.
|
92
|
+
* Build on top of [CompressionStream](https://developer.mozilla.org/en-US/docs/Web/API/CompressionStream)
|
93
|
+
* You might need to polyfill it if your environment does not support it.
|
94
|
+
*
|
95
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/compression Compression Plugin Docs}
|
96
|
+
*/
|
97
|
+
declare class CompressionPlugin<T extends Context> implements FetchHandlerPlugin<T> {
|
98
|
+
private readonly encodings;
|
99
|
+
private readonly threshold;
|
100
|
+
private readonly filter;
|
101
|
+
constructor(options?: CompressionPluginOptions);
|
102
|
+
initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
|
103
|
+
}
|
104
|
+
|
105
|
+
type RPCHandlerOptions<T extends Context> = FetchHandlerOptions<T> & StandardRPCHandlerOptions<T> & {
|
106
|
+
/**
|
107
|
+
* Enables or disables the StrictGetMethodPlugin.
|
108
|
+
*
|
109
|
+
* @default true
|
110
|
+
*/
|
111
|
+
strictGetMethodPluginEnabled?: boolean;
|
112
|
+
};
|
113
|
+
/**
|
114
|
+
* RPC Handler for Fetch Server
|
115
|
+
*
|
116
|
+
* @see {@link https://orpc.unnoq.com/docs/rpc-handler RPC Handler Docs}
|
117
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/http HTTP Adapter Docs}
|
118
|
+
*/
|
50
119
|
declare class RPCHandler<T extends Context> extends FetchHandler<T> {
|
51
|
-
constructor(router: Router<any, T>, options?: NoInfer<
|
120
|
+
constructor(router: Router<any, T>, options?: NoInfer<RPCHandlerOptions<T>>);
|
52
121
|
}
|
53
122
|
|
54
|
-
export { BodyLimitPlugin,
|
123
|
+
export { BodyLimitPlugin, CompositeFetchHandlerPlugin, CompressionPlugin, FetchHandler, RPCHandler };
|
124
|
+
export type { BodyLimitPluginOptions, CompressionPluginOptions, FetchHandleResult, FetchHandlerInterceptorOptions, FetchHandlerOptions, FetchHandlerPlugin, RPCHandlerOptions };
|