@orpc/server 1.14.5 → 2.0.0-beta.1
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 +75 -136
- package/dist/adapters/crossws/index.d.mts +42 -21
- package/dist/adapters/crossws/index.d.ts +42 -21
- package/dist/adapters/crossws/index.mjs +37 -18
- package/dist/adapters/fetch/index.d.mts +83 -67
- package/dist/adapters/fetch/index.d.ts +83 -67
- package/dist/adapters/fetch/index.mjs +131 -106
- package/dist/adapters/message-port/index.d.mts +51 -34
- package/dist/adapters/message-port/index.d.ts +51 -34
- package/dist/adapters/message-port/index.mjs +73 -38
- package/dist/adapters/node/index.d.mts +82 -60
- package/dist/adapters/node/index.d.ts +82 -60
- package/dist/adapters/node/index.mjs +127 -98
- package/dist/adapters/standard/index.d.mts +16 -18
- package/dist/adapters/standard/index.d.ts +16 -18
- package/dist/adapters/standard/index.mjs +5 -5
- package/dist/adapters/standard-peer/index.d.mts +12 -14
- package/dist/adapters/standard-peer/index.d.ts +12 -14
- package/dist/adapters/standard-peer/index.mjs +2 -21
- package/dist/adapters/websocket/index.d.mts +39 -34
- package/dist/adapters/websocket/index.d.ts +39 -34
- package/dist/adapters/websocket/index.mjs +42 -33
- package/dist/extensions/callable.d.mts +10 -0
- package/dist/extensions/callable.d.ts +10 -0
- package/dist/extensions/callable.mjs +11 -0
- package/dist/helpers/index.d.mts +2 -2
- package/dist/helpers/index.d.ts +2 -2
- package/dist/helpers/index.mjs +1 -1
- package/dist/index.d.mts +163 -770
- package/dist/index.d.ts +163 -770
- package/dist/index.mjs +296 -403
- package/dist/plugins/index.d.mts +105 -143
- package/dist/plugins/index.d.ts +105 -143
- package/dist/plugins/index.mjs +232 -255
- package/dist/shared/server.BB_Ik9Ph.d.mts +104 -0
- package/dist/shared/server.BL22TloH.d.mts +184 -0
- package/dist/shared/server.BL22TloH.d.ts +184 -0
- package/dist/shared/server.B_U9y00a.d.mts +66 -0
- package/dist/shared/server.BsNNjG5J.d.mts +61 -0
- package/dist/shared/server.BwHnWUuN.mjs +222 -0
- package/dist/shared/server.CX4vUnDk.mjs +11 -0
- package/dist/shared/server.CjOb6ItT.mjs +41 -0
- package/dist/shared/server.CrlKQucM.mjs +233 -0
- package/dist/shared/server.D_QauotT.mjs +30 -0
- package/dist/shared/server.EOHJ3NJr.d.ts +104 -0
- package/dist/shared/server.GDpX6Df8.mjs +271 -0
- package/dist/shared/server.Pa0F03f_.d.ts +61 -0
- package/dist/shared/server.T9F3bzZx.d.ts +66 -0
- package/dist/shared/{server.DZ5BIITo.mjs → server.W91HSRkE.mjs} +2 -2
- package/package.json +26 -55
- package/dist/adapters/aws-lambda/index.d.mts +0 -46
- package/dist/adapters/aws-lambda/index.d.ts +0 -46
- package/dist/adapters/aws-lambda/index.mjs +0 -40
- package/dist/adapters/bun-ws/index.d.mts +0 -36
- package/dist/adapters/bun-ws/index.d.ts +0 -36
- package/dist/adapters/bun-ws/index.mjs +0 -47
- package/dist/adapters/fastify/index.d.mts +0 -53
- package/dist/adapters/fastify/index.d.ts +0 -53
- package/dist/adapters/fastify/index.mjs +0 -52
- package/dist/adapters/ws/index.d.mts +0 -31
- package/dist/adapters/ws/index.d.ts +0 -31
- package/dist/adapters/ws/index.mjs +0 -37
- package/dist/hibernation/index.d.mts +0 -44
- package/dist/hibernation/index.d.ts +0 -44
- package/dist/hibernation/index.mjs +0 -65
- package/dist/shared/server.7cEtMB30.d.ts +0 -74
- package/dist/shared/server.B8gYOD5g.d.mts +0 -12
- package/dist/shared/server.BqadksTP.d.mts +0 -74
- package/dist/shared/server.C8_sRzQB.d.mts +0 -42
- package/dist/shared/server.ChUyt5-i.d.mts +0 -32
- package/dist/shared/server.ChyoA9XY.d.ts +0 -42
- package/dist/shared/server.DEBcqOjg.mjs +0 -418
- package/dist/shared/server.EfTOZ2Q7.d.ts +0 -12
- package/dist/shared/server.TEVCLCFC.mjs +0 -39
- package/dist/shared/server.ZxHCEN1h.mjs +0 -226
- package/dist/shared/server.qKsRrdxW.d.mts +0 -193
- package/dist/shared/server.qKsRrdxW.d.ts +0 -193
- package/dist/shared/server.yoEB3Fx4.d.ts +0 -32
|
@@ -1,68 +1,78 @@
|
|
|
1
|
-
import { C as Context
|
|
1
|
+
import { C as Context } from '../../shared/server.BL22TloH.mjs';
|
|
2
2
|
import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
|
|
3
|
-
import { ToFetchResponseOptions } from '@
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
3
|
+
import { ToFetchResponseOptions } from '@standardserver/fetch';
|
|
4
|
+
import { e as StandardHandlerPlugin, b as StandardHandlerHandleOptions, S as StandardHandler, a as StandardHandlerOptions } from '../../shared/server.BB_Ik9Ph.mjs';
|
|
5
|
+
import { FriendlyStandardHandlerHandleOptions } from '../standard/index.mjs';
|
|
6
|
+
import { R as Router } from '../../shared/server.BsNNjG5J.mjs';
|
|
7
|
+
import { R as RPCHandlerCodecOptions } from '../../shared/server.B_U9y00a.mjs';
|
|
7
8
|
import '@orpc/client';
|
|
8
9
|
import '@orpc/contract';
|
|
9
|
-
import '@
|
|
10
|
-
import '@orpc/client/standard';
|
|
11
|
-
import '../../shared/server.C8_sRzQB.mjs';
|
|
10
|
+
import '@standardserver/core';
|
|
12
11
|
|
|
13
12
|
interface FetchHandlerPlugin<T extends Context> extends StandardHandlerPlugin<T> {
|
|
14
|
-
|
|
13
|
+
/**
|
|
14
|
+
* Initializes the plugin and returns new fetch handler options.
|
|
15
|
+
* Called once per plugin instance during composition.
|
|
16
|
+
*
|
|
17
|
+
* This method allows plugins to wrap, extend, or transform fetch handler options
|
|
18
|
+
* such as fetch interceptors, or fetch configuration.
|
|
19
|
+
*
|
|
20
|
+
* @param options - The current handler options from previous plugins or base configuration
|
|
21
|
+
* @returns Transformed handler options with plugin's modifications applied
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* initFetchHandlerOptions(options) {
|
|
26
|
+
* return {
|
|
27
|
+
* ...options,
|
|
28
|
+
* interceptors: [...(options.interceptors || []), myInterceptor]
|
|
29
|
+
* }
|
|
30
|
+
* }
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
initFetchHandlerOptions?(options: FetchHandlerOptions<T>): FetchHandlerOptions<T>;
|
|
15
34
|
}
|
|
16
|
-
declare class CompositeFetchHandlerPlugin<T extends Context
|
|
17
|
-
|
|
35
|
+
declare class CompositeFetchHandlerPlugin<T extends Context> implements FetchHandlerPlugin<T> {
|
|
36
|
+
readonly name = "~composite/fetch-handler";
|
|
37
|
+
protected readonly plugins: FetchHandlerPlugin<T>[];
|
|
38
|
+
constructor(plugins?: FetchHandlerPlugin<T>[]);
|
|
39
|
+
initFetchHandlerOptions(options: FetchHandlerOptions<T>): FetchHandlerOptions<T>;
|
|
18
40
|
}
|
|
19
41
|
|
|
20
|
-
type
|
|
42
|
+
type FetchHandlerHandleResult = {
|
|
21
43
|
matched: true;
|
|
22
44
|
response: Response;
|
|
23
45
|
} | {
|
|
24
46
|
matched: false;
|
|
25
|
-
response
|
|
47
|
+
response?: undefined;
|
|
26
48
|
};
|
|
27
|
-
interface
|
|
49
|
+
interface FetchHandlerFetchInterceptorOptions<T extends Context> extends StandardHandlerHandleOptions<T> {
|
|
28
50
|
request: Request;
|
|
29
|
-
toFetchResponseOptions: ToFetchResponseOptions;
|
|
51
|
+
toFetchResponseOptions: ToFetchResponseOptions | undefined;
|
|
30
52
|
}
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
53
|
+
type FetchHandlerFetchInterceptor<T extends Context> = Interceptor<FetchHandlerFetchInterceptorOptions<T>, Promise<FetchHandlerHandleResult>>;
|
|
54
|
+
interface FetchHandlerOptions<T extends Context> {
|
|
55
|
+
/**
|
|
56
|
+
* Custom options for `toFetchResponse`, used to map a `Standard Response` to a `Fetch Response`.
|
|
57
|
+
*/
|
|
58
|
+
toFetchResponse?: ToFetchResponseOptions;
|
|
59
|
+
/**
|
|
60
|
+
* Interceptors that run before the mapping between the Standard API and Fetch API,
|
|
61
|
+
* useful for customizing the mapping behavior (e.g. extending the body parser).
|
|
62
|
+
*/
|
|
63
|
+
fetchInterceptors?: FetchHandlerFetchInterceptor<T>[] | undefined;
|
|
64
|
+
plugins?: FetchHandlerPlugin<T>[] | undefined;
|
|
34
65
|
}
|
|
35
66
|
declare class FetchHandler<T extends Context> {
|
|
36
67
|
private readonly standardHandler;
|
|
37
68
|
private readonly toFetchResponseOptions;
|
|
38
|
-
private readonly
|
|
69
|
+
private readonly fetchInterceptors;
|
|
39
70
|
constructor(standardHandler: StandardHandler<T>, options?: NoInfer<FetchHandlerOptions<T>>);
|
|
40
|
-
handle(request: Request, ...rest: MaybeOptionalOptions<
|
|
71
|
+
handle(request: Request, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): Promise<FetchHandlerHandleResult>;
|
|
41
72
|
}
|
|
42
73
|
|
|
43
|
-
interface BodyLimitPluginOptions {
|
|
44
|
-
/**
|
|
45
|
-
* The maximum size of the body in bytes.
|
|
46
|
-
*/
|
|
47
|
-
maxBodySize: number;
|
|
48
|
-
}
|
|
49
|
-
/**
|
|
50
|
-
* The Body Limit Plugin restricts the size of the request body for the Fetch Server.
|
|
51
|
-
*
|
|
52
|
-
* @see {@link https://orpc.dev/docs/plugins/body-limit Body Limit Plugin Docs}
|
|
53
|
-
*/
|
|
54
|
-
declare class BodyLimitPlugin<T extends Context> implements FetchHandlerPlugin<T> {
|
|
55
|
-
private readonly maxBodySize;
|
|
56
|
-
constructor(options: BodyLimitPluginOptions);
|
|
57
|
-
initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
|
|
58
|
-
}
|
|
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
74
|
declare const ORDERED_SUPPORTED_ENCODINGS: readonly ["gzip", "deflate"];
|
|
65
|
-
interface
|
|
75
|
+
interface BodyCompressionHandlerPluginOptions {
|
|
66
76
|
/**
|
|
67
77
|
* The compression schemes to use for response compression.
|
|
68
78
|
* Schemes are prioritized by their order in this array and
|
|
@@ -82,43 +92,49 @@ interface CompressionPluginOptions {
|
|
|
82
92
|
/**
|
|
83
93
|
* Override the default content-type filter used to determine which responses should be compressed.
|
|
84
94
|
*
|
|
85
|
-
* @warning
|
|
95
|
+
* @warning Event stream responses are never compressed, regardless of this filter's return value.
|
|
86
96
|
* @default only responses with compressible content types are compressed.
|
|
87
97
|
*/
|
|
88
98
|
filter?: (request: Request, response: Response) => boolean;
|
|
89
99
|
}
|
|
90
|
-
|
|
91
|
-
|
|
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.dev/docs/plugins/compression Compression Plugin Docs}
|
|
96
|
-
*/
|
|
97
|
-
declare class CompressionPlugin<T extends Context> implements FetchHandlerPlugin<T> {
|
|
100
|
+
declare class BodyCompressionHandlerPlugin<T extends Context> implements FetchHandlerPlugin<T> {
|
|
101
|
+
name: string;
|
|
98
102
|
private readonly encodings;
|
|
99
103
|
private readonly threshold;
|
|
100
104
|
private readonly filter;
|
|
101
|
-
constructor(options?:
|
|
102
|
-
|
|
105
|
+
constructor(options?: BodyCompressionHandlerPluginOptions);
|
|
106
|
+
initFetchHandlerOptions(options: FetchHandlerOptions<T>): FetchHandlerOptions<T>;
|
|
103
107
|
}
|
|
104
108
|
|
|
105
|
-
interface
|
|
109
|
+
interface BodyLimitHandlerPluginOptions {
|
|
106
110
|
/**
|
|
107
|
-
*
|
|
108
|
-
|
|
109
|
-
|
|
111
|
+
* The maximum size of the body in bytes.
|
|
112
|
+
*/
|
|
113
|
+
maxBodySize: number;
|
|
114
|
+
}
|
|
115
|
+
declare class BodyLimitHandlerPlugin<T extends Context> implements FetchHandlerPlugin<T> {
|
|
116
|
+
name: string;
|
|
117
|
+
private readonly maxBodySize;
|
|
118
|
+
constructor(options: BodyLimitHandlerPluginOptions);
|
|
119
|
+
initFetchHandlerOptions(options: FetchHandlerOptions<T>): FetchHandlerOptions<T>;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
interface RPCHandlerOptions<T extends Context> extends FetchHandlerOptions<T>, Omit<StandardHandlerOptions<T>, 'plugins'>, RPCHandlerCodecOptions<T> {
|
|
123
|
+
/**
|
|
124
|
+
* Configuration for {@link CSRFGuardHandlerPlugin}, which is enabled by default for `RPCHandler` over HTTP.
|
|
110
125
|
*/
|
|
111
|
-
|
|
126
|
+
csrfGuardHandlerPlugin?: {
|
|
127
|
+
/**
|
|
128
|
+
* If `false`, this plugin is disabled.
|
|
129
|
+
*
|
|
130
|
+
* @default true
|
|
131
|
+
*/
|
|
132
|
+
enabled?: boolean;
|
|
133
|
+
};
|
|
112
134
|
}
|
|
113
|
-
/**
|
|
114
|
-
* RPC Handler for Fetch Server
|
|
115
|
-
*
|
|
116
|
-
* @see {@link https://orpc.dev/docs/rpc-handler RPC Handler Docs}
|
|
117
|
-
* @see {@link https://orpc.dev/docs/adapters/http HTTP Adapter Docs}
|
|
118
|
-
*/
|
|
119
135
|
declare class RPCHandler<T extends Context> extends FetchHandler<T> {
|
|
120
|
-
constructor(router: Router<
|
|
136
|
+
constructor(router: Router<T>, options?: NoInfer<RPCHandlerOptions<T>>);
|
|
121
137
|
}
|
|
122
138
|
|
|
123
|
-
export {
|
|
124
|
-
export type {
|
|
139
|
+
export { BodyCompressionHandlerPlugin, BodyLimitHandlerPlugin, CompositeFetchHandlerPlugin, FetchHandler, RPCHandler };
|
|
140
|
+
export type { BodyCompressionHandlerPluginOptions, BodyLimitHandlerPluginOptions, FetchHandlerFetchInterceptor, FetchHandlerFetchInterceptorOptions, FetchHandlerHandleResult, FetchHandlerOptions, FetchHandlerPlugin, RPCHandlerOptions };
|
|
@@ -1,68 +1,78 @@
|
|
|
1
|
-
import { C as Context
|
|
1
|
+
import { C as Context } from '../../shared/server.BL22TloH.js';
|
|
2
2
|
import { Interceptor, MaybeOptionalOptions } from '@orpc/shared';
|
|
3
|
-
import { ToFetchResponseOptions } from '@
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
3
|
+
import { ToFetchResponseOptions } from '@standardserver/fetch';
|
|
4
|
+
import { e as StandardHandlerPlugin, b as StandardHandlerHandleOptions, S as StandardHandler, a as StandardHandlerOptions } from '../../shared/server.EOHJ3NJr.js';
|
|
5
|
+
import { FriendlyStandardHandlerHandleOptions } from '../standard/index.js';
|
|
6
|
+
import { R as Router } from '../../shared/server.Pa0F03f_.js';
|
|
7
|
+
import { R as RPCHandlerCodecOptions } from '../../shared/server.T9F3bzZx.js';
|
|
7
8
|
import '@orpc/client';
|
|
8
9
|
import '@orpc/contract';
|
|
9
|
-
import '@
|
|
10
|
-
import '@orpc/client/standard';
|
|
11
|
-
import '../../shared/server.ChyoA9XY.js';
|
|
10
|
+
import '@standardserver/core';
|
|
12
11
|
|
|
13
12
|
interface FetchHandlerPlugin<T extends Context> extends StandardHandlerPlugin<T> {
|
|
14
|
-
|
|
13
|
+
/**
|
|
14
|
+
* Initializes the plugin and returns new fetch handler options.
|
|
15
|
+
* Called once per plugin instance during composition.
|
|
16
|
+
*
|
|
17
|
+
* This method allows plugins to wrap, extend, or transform fetch handler options
|
|
18
|
+
* such as fetch interceptors, or fetch configuration.
|
|
19
|
+
*
|
|
20
|
+
* @param options - The current handler options from previous plugins or base configuration
|
|
21
|
+
* @returns Transformed handler options with plugin's modifications applied
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* initFetchHandlerOptions(options) {
|
|
26
|
+
* return {
|
|
27
|
+
* ...options,
|
|
28
|
+
* interceptors: [...(options.interceptors || []), myInterceptor]
|
|
29
|
+
* }
|
|
30
|
+
* }
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
initFetchHandlerOptions?(options: FetchHandlerOptions<T>): FetchHandlerOptions<T>;
|
|
15
34
|
}
|
|
16
|
-
declare class CompositeFetchHandlerPlugin<T extends Context
|
|
17
|
-
|
|
35
|
+
declare class CompositeFetchHandlerPlugin<T extends Context> implements FetchHandlerPlugin<T> {
|
|
36
|
+
readonly name = "~composite/fetch-handler";
|
|
37
|
+
protected readonly plugins: FetchHandlerPlugin<T>[];
|
|
38
|
+
constructor(plugins?: FetchHandlerPlugin<T>[]);
|
|
39
|
+
initFetchHandlerOptions(options: FetchHandlerOptions<T>): FetchHandlerOptions<T>;
|
|
18
40
|
}
|
|
19
41
|
|
|
20
|
-
type
|
|
42
|
+
type FetchHandlerHandleResult = {
|
|
21
43
|
matched: true;
|
|
22
44
|
response: Response;
|
|
23
45
|
} | {
|
|
24
46
|
matched: false;
|
|
25
|
-
response
|
|
47
|
+
response?: undefined;
|
|
26
48
|
};
|
|
27
|
-
interface
|
|
49
|
+
interface FetchHandlerFetchInterceptorOptions<T extends Context> extends StandardHandlerHandleOptions<T> {
|
|
28
50
|
request: Request;
|
|
29
|
-
toFetchResponseOptions: ToFetchResponseOptions;
|
|
51
|
+
toFetchResponseOptions: ToFetchResponseOptions | undefined;
|
|
30
52
|
}
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
53
|
+
type FetchHandlerFetchInterceptor<T extends Context> = Interceptor<FetchHandlerFetchInterceptorOptions<T>, Promise<FetchHandlerHandleResult>>;
|
|
54
|
+
interface FetchHandlerOptions<T extends Context> {
|
|
55
|
+
/**
|
|
56
|
+
* Custom options for `toFetchResponse`, used to map a `Standard Response` to a `Fetch Response`.
|
|
57
|
+
*/
|
|
58
|
+
toFetchResponse?: ToFetchResponseOptions;
|
|
59
|
+
/**
|
|
60
|
+
* Interceptors that run before the mapping between the Standard API and Fetch API,
|
|
61
|
+
* useful for customizing the mapping behavior (e.g. extending the body parser).
|
|
62
|
+
*/
|
|
63
|
+
fetchInterceptors?: FetchHandlerFetchInterceptor<T>[] | undefined;
|
|
64
|
+
plugins?: FetchHandlerPlugin<T>[] | undefined;
|
|
34
65
|
}
|
|
35
66
|
declare class FetchHandler<T extends Context> {
|
|
36
67
|
private readonly standardHandler;
|
|
37
68
|
private readonly toFetchResponseOptions;
|
|
38
|
-
private readonly
|
|
69
|
+
private readonly fetchInterceptors;
|
|
39
70
|
constructor(standardHandler: StandardHandler<T>, options?: NoInfer<FetchHandlerOptions<T>>);
|
|
40
|
-
handle(request: Request, ...rest: MaybeOptionalOptions<
|
|
71
|
+
handle(request: Request, ...rest: MaybeOptionalOptions<FriendlyStandardHandlerHandleOptions<T>>): Promise<FetchHandlerHandleResult>;
|
|
41
72
|
}
|
|
42
73
|
|
|
43
|
-
interface BodyLimitPluginOptions {
|
|
44
|
-
/**
|
|
45
|
-
* The maximum size of the body in bytes.
|
|
46
|
-
*/
|
|
47
|
-
maxBodySize: number;
|
|
48
|
-
}
|
|
49
|
-
/**
|
|
50
|
-
* The Body Limit Plugin restricts the size of the request body for the Fetch Server.
|
|
51
|
-
*
|
|
52
|
-
* @see {@link https://orpc.dev/docs/plugins/body-limit Body Limit Plugin Docs}
|
|
53
|
-
*/
|
|
54
|
-
declare class BodyLimitPlugin<T extends Context> implements FetchHandlerPlugin<T> {
|
|
55
|
-
private readonly maxBodySize;
|
|
56
|
-
constructor(options: BodyLimitPluginOptions);
|
|
57
|
-
initRuntimeAdapter(options: FetchHandlerOptions<T>): void;
|
|
58
|
-
}
|
|
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
74
|
declare const ORDERED_SUPPORTED_ENCODINGS: readonly ["gzip", "deflate"];
|
|
65
|
-
interface
|
|
75
|
+
interface BodyCompressionHandlerPluginOptions {
|
|
66
76
|
/**
|
|
67
77
|
* The compression schemes to use for response compression.
|
|
68
78
|
* Schemes are prioritized by their order in this array and
|
|
@@ -82,43 +92,49 @@ interface CompressionPluginOptions {
|
|
|
82
92
|
/**
|
|
83
93
|
* Override the default content-type filter used to determine which responses should be compressed.
|
|
84
94
|
*
|
|
85
|
-
* @warning
|
|
95
|
+
* @warning Event stream responses are never compressed, regardless of this filter's return value.
|
|
86
96
|
* @default only responses with compressible content types are compressed.
|
|
87
97
|
*/
|
|
88
98
|
filter?: (request: Request, response: Response) => boolean;
|
|
89
99
|
}
|
|
90
|
-
|
|
91
|
-
|
|
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.dev/docs/plugins/compression Compression Plugin Docs}
|
|
96
|
-
*/
|
|
97
|
-
declare class CompressionPlugin<T extends Context> implements FetchHandlerPlugin<T> {
|
|
100
|
+
declare class BodyCompressionHandlerPlugin<T extends Context> implements FetchHandlerPlugin<T> {
|
|
101
|
+
name: string;
|
|
98
102
|
private readonly encodings;
|
|
99
103
|
private readonly threshold;
|
|
100
104
|
private readonly filter;
|
|
101
|
-
constructor(options?:
|
|
102
|
-
|
|
105
|
+
constructor(options?: BodyCompressionHandlerPluginOptions);
|
|
106
|
+
initFetchHandlerOptions(options: FetchHandlerOptions<T>): FetchHandlerOptions<T>;
|
|
103
107
|
}
|
|
104
108
|
|
|
105
|
-
interface
|
|
109
|
+
interface BodyLimitHandlerPluginOptions {
|
|
106
110
|
/**
|
|
107
|
-
*
|
|
108
|
-
|
|
109
|
-
|
|
111
|
+
* The maximum size of the body in bytes.
|
|
112
|
+
*/
|
|
113
|
+
maxBodySize: number;
|
|
114
|
+
}
|
|
115
|
+
declare class BodyLimitHandlerPlugin<T extends Context> implements FetchHandlerPlugin<T> {
|
|
116
|
+
name: string;
|
|
117
|
+
private readonly maxBodySize;
|
|
118
|
+
constructor(options: BodyLimitHandlerPluginOptions);
|
|
119
|
+
initFetchHandlerOptions(options: FetchHandlerOptions<T>): FetchHandlerOptions<T>;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
interface RPCHandlerOptions<T extends Context> extends FetchHandlerOptions<T>, Omit<StandardHandlerOptions<T>, 'plugins'>, RPCHandlerCodecOptions<T> {
|
|
123
|
+
/**
|
|
124
|
+
* Configuration for {@link CSRFGuardHandlerPlugin}, which is enabled by default for `RPCHandler` over HTTP.
|
|
110
125
|
*/
|
|
111
|
-
|
|
126
|
+
csrfGuardHandlerPlugin?: {
|
|
127
|
+
/**
|
|
128
|
+
* If `false`, this plugin is disabled.
|
|
129
|
+
*
|
|
130
|
+
* @default true
|
|
131
|
+
*/
|
|
132
|
+
enabled?: boolean;
|
|
133
|
+
};
|
|
112
134
|
}
|
|
113
|
-
/**
|
|
114
|
-
* RPC Handler for Fetch Server
|
|
115
|
-
*
|
|
116
|
-
* @see {@link https://orpc.dev/docs/rpc-handler RPC Handler Docs}
|
|
117
|
-
* @see {@link https://orpc.dev/docs/adapters/http HTTP Adapter Docs}
|
|
118
|
-
*/
|
|
119
135
|
declare class RPCHandler<T extends Context> extends FetchHandler<T> {
|
|
120
|
-
constructor(router: Router<
|
|
136
|
+
constructor(router: Router<T>, options?: NoInfer<RPCHandlerOptions<T>>);
|
|
121
137
|
}
|
|
122
138
|
|
|
123
|
-
export {
|
|
124
|
-
export type {
|
|
139
|
+
export { BodyCompressionHandlerPlugin, BodyLimitHandlerPlugin, CompositeFetchHandlerPlugin, FetchHandler, RPCHandler };
|
|
140
|
+
export type { BodyCompressionHandlerPluginOptions, BodyLimitHandlerPluginOptions, FetchHandlerFetchInterceptor, FetchHandlerFetchInterceptorOptions, FetchHandlerHandleResult, FetchHandlerOptions, FetchHandlerPlugin, RPCHandlerOptions };
|