@orpc/server 0.0.0-next.a4ecb29 → 0.0.0-next.a5a8281
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 +32 -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/fastify/index.d.mts +53 -0
- package/dist/adapters/fastify/index.d.ts +53 -0
- package/dist/adapters/fastify/index.mjs +54 -0
- package/dist/adapters/fetch/index.d.mts +107 -11
- package/dist/adapters/fetch/index.d.ts +107 -11
- package/dist/adapters/fetch/index.mjs +179 -8
- package/dist/adapters/message-port/index.d.mts +57 -0
- package/dist/adapters/message-port/index.d.ts +57 -0
- package/dist/adapters/message-port/index.mjs +55 -0
- package/dist/adapters/node/index.d.mts +85 -22
- package/dist/adapters/node/index.d.ts +85 -22
- package/dist/adapters/node/index.mjs +144 -24
- 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 +56 -0
- package/dist/adapters/websocket/index.d.ts +56 -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 +149 -0
- package/dist/helpers/index.d.ts +149 -0
- package/dist/helpers/index.mjs +198 -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 +609 -84
- package/dist/index.d.ts +609 -84
- package/dist/index.mjs +167 -17
- package/dist/plugins/index.d.mts +157 -16
- package/dist/plugins/index.d.ts +157 -16
- package/dist/plugins/index.mjs +200 -16
- package/dist/shared/{server.BYTulgUc.d.mts → server.B4BGqy3Y.d.mts} +66 -17
- package/dist/shared/{server.BYTulgUc.d.ts → server.B4BGqy3Y.d.ts} +66 -17
- package/dist/shared/server.Bxx6tqNe.mjs +219 -0
- package/dist/shared/server.COL12UTb.d.ts +32 -0
- package/dist/shared/server.CVKCo60T.d.mts +12 -0
- package/dist/shared/server.Cb6yD7DZ.d.ts +42 -0
- package/dist/shared/server.Ck-gOLzq.d.mts +32 -0
- package/dist/shared/server.DBCUJijK.d.mts +74 -0
- package/dist/shared/server.DNtJ-p60.d.ts +12 -0
- package/dist/shared/server.DPIFWpxG.d.ts +74 -0
- package/dist/shared/server.DZ5BIITo.mjs +9 -0
- package/dist/shared/{server.BtxZnWJ9.mjs → server.Ds4HPpvH.mjs} +125 -90
- package/dist/shared/server.DzV1hr3z.d.mts +42 -0
- package/dist/shared/server.TEVCLCFC.mjs +39 -0
- package/dist/shared/server.UVMTOWrk.mjs +26 -0
- package/package.json +80 -20
- package/dist/adapters/hono/index.d.mts +0 -21
- package/dist/adapters/hono/index.d.ts +0 -21
- package/dist/adapters/hono/index.mjs +0 -32
- package/dist/adapters/next/index.d.mts +0 -28
- package/dist/adapters/next/index.d.ts +0 -28
- package/dist/adapters/next/index.mjs +0 -29
- package/dist/shared/server.B52eKaNe.d.mts +0 -8
- package/dist/shared/server.BA-onDGB.d.ts +0 -8
- package/dist/shared/server.BY9sDlwl.mjs +0 -158
- package/dist/shared/server.CDzXh8DM.d.mts +0 -75
- package/dist/shared/server.CkGvC2T0.d.ts +0 -75
- package/dist/shared/server.Dba3Iiyp.mjs +0 -12
- package/dist/shared/server.Del5OmaY.mjs +0 -29
package/dist/plugins/index.d.ts
CHANGED
|
@@ -1,31 +1,172 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import '
|
|
6
|
-
import '@orpc/
|
|
7
|
-
import '@orpc/client';
|
|
1
|
+
import { Value, Promisable } from '@orpc/shared';
|
|
2
|
+
import { StandardRequest, StandardHeaders } from '@orpc/standard-server';
|
|
3
|
+
import { BatchResponseBodyItem } from '@orpc/standard-server/batch';
|
|
4
|
+
import { d as StandardHandlerInterceptorOptions, g as StandardHandlerPlugin, e as StandardHandlerOptions } from '../shared/server.DPIFWpxG.js';
|
|
5
|
+
import { C as Context, d as ProcedureClientInterceptorOptions } from '../shared/server.B4BGqy3Y.js';
|
|
6
|
+
import { Meta, ORPCError as ORPCError$1 } from '@orpc/contract';
|
|
7
|
+
import { ORPCError } from '@orpc/client';
|
|
8
8
|
|
|
9
|
-
interface
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
interface BatchHandlerOptions<T extends Context> {
|
|
10
|
+
/**
|
|
11
|
+
* The max size of the batch allowed.
|
|
12
|
+
*
|
|
13
|
+
* @default 10
|
|
14
|
+
*/
|
|
15
|
+
maxSize?: Value<Promisable<number>, [StandardHandlerInterceptorOptions<T>]>;
|
|
16
|
+
/**
|
|
17
|
+
* Map the request before processing it.
|
|
18
|
+
*
|
|
19
|
+
* @default merged back batch request headers into the request
|
|
20
|
+
*/
|
|
21
|
+
mapRequestItem?(request: StandardRequest, batchOptions: StandardHandlerInterceptorOptions<T>): StandardRequest;
|
|
22
|
+
/**
|
|
23
|
+
* Success batch response status code.
|
|
24
|
+
*
|
|
25
|
+
* @default 207
|
|
26
|
+
*/
|
|
27
|
+
successStatus?: Value<Promisable<number>, [responses: Promise<BatchResponseBodyItem>[], batchOptions: StandardHandlerInterceptorOptions<T>]>;
|
|
28
|
+
/**
|
|
29
|
+
* success batch response headers.
|
|
30
|
+
*
|
|
31
|
+
* @default {}
|
|
32
|
+
*/
|
|
33
|
+
headers?: Value<Promisable<StandardHeaders>, [responses: Promise<BatchResponseBodyItem>[], batchOptions: StandardHandlerInterceptorOptions<T>]>;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* The Batch Requests Plugin allows you to combine multiple requests and responses into a single batch,
|
|
37
|
+
* reducing the overhead of sending each one separately.
|
|
38
|
+
*
|
|
39
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-requests Batch Requests Plugin Docs}
|
|
40
|
+
*/
|
|
41
|
+
declare class BatchHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
|
42
|
+
private readonly maxSize;
|
|
43
|
+
private readonly mapRequestItem;
|
|
44
|
+
private readonly successStatus;
|
|
45
|
+
private readonly headers;
|
|
46
|
+
order: number;
|
|
47
|
+
constructor(options?: BatchHandlerOptions<T>);
|
|
48
|
+
init(options: StandardHandlerOptions<T>): void;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
interface CORSOptions<T extends Context> {
|
|
52
|
+
origin?: Value<Promisable<string | readonly string[] | null | undefined>, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
|
|
53
|
+
timingOrigin?: Value<Promisable<string | readonly string[] | null | undefined>, [origin: string, options: StandardHandlerInterceptorOptions<T>]>;
|
|
12
54
|
allowMethods?: readonly string[];
|
|
13
55
|
allowHeaders?: readonly string[];
|
|
14
56
|
maxAge?: number;
|
|
15
57
|
credentials?: boolean;
|
|
16
58
|
exposeHeaders?: readonly string[];
|
|
17
59
|
}
|
|
18
|
-
|
|
60
|
+
/**
|
|
61
|
+
* CORSPlugin is a plugin for oRPC that allows you to configure CORS for your API.
|
|
62
|
+
*
|
|
63
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/cors CORS Plugin Docs}
|
|
64
|
+
*/
|
|
65
|
+
declare class CORSPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
|
19
66
|
private readonly options;
|
|
20
|
-
|
|
21
|
-
|
|
67
|
+
order: number;
|
|
68
|
+
constructor(options?: CORSOptions<T>);
|
|
69
|
+
init(options: StandardHandlerOptions<T>): void;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
interface RequestHeadersPluginContext {
|
|
73
|
+
reqHeaders?: Headers;
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* The Request Headers Plugin injects a `reqHeaders` instance into the context,
|
|
77
|
+
* allowing access to request headers in oRPC.
|
|
78
|
+
*
|
|
79
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/request-headers Request Headers Plugin Docs}
|
|
80
|
+
*/
|
|
81
|
+
declare class RequestHeadersPlugin<T extends RequestHeadersPluginContext> implements StandardHandlerPlugin<T> {
|
|
82
|
+
init(options: StandardHandlerOptions<T>): void;
|
|
22
83
|
}
|
|
23
84
|
|
|
24
85
|
interface ResponseHeadersPluginContext {
|
|
25
86
|
resHeaders?: Headers;
|
|
26
87
|
}
|
|
27
|
-
|
|
28
|
-
|
|
88
|
+
/**
|
|
89
|
+
* The Response Headers Plugin allows you to set response headers in oRPC.
|
|
90
|
+
* It injects a resHeaders instance into the context, enabling you to modify response headers easily.
|
|
91
|
+
*
|
|
92
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/response-headers Response Headers Plugin Docs}
|
|
93
|
+
*/
|
|
94
|
+
declare class ResponseHeadersPlugin<T extends ResponseHeadersPluginContext> implements StandardHandlerPlugin<T> {
|
|
95
|
+
init(options: StandardHandlerOptions<T>): void;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
interface SimpleCsrfProtectionHandlerPluginOptions<T extends Context> {
|
|
99
|
+
/**
|
|
100
|
+
* The name of the header to check.
|
|
101
|
+
*
|
|
102
|
+
* @default 'x-csrf-token'
|
|
103
|
+
*/
|
|
104
|
+
headerName?: Value<Promisable<string>, [options: StandardHandlerInterceptorOptions<T>]>;
|
|
105
|
+
/**
|
|
106
|
+
* The value of the header to check.
|
|
107
|
+
*
|
|
108
|
+
* @default 'orpc'
|
|
109
|
+
*
|
|
110
|
+
*/
|
|
111
|
+
headerValue?: Value<Promisable<string>, [options: StandardHandlerInterceptorOptions<T>]>;
|
|
112
|
+
/**
|
|
113
|
+
* Exclude a procedure from the plugin.
|
|
114
|
+
*
|
|
115
|
+
* @default false
|
|
116
|
+
*
|
|
117
|
+
*/
|
|
118
|
+
exclude?: Value<Promisable<boolean>, [options: ProcedureClientInterceptorOptions<T, Record<never, never>, Meta>]>;
|
|
119
|
+
/**
|
|
120
|
+
* The error thrown when the CSRF token is invalid.
|
|
121
|
+
*
|
|
122
|
+
* @default new ORPCError('CSRF_TOKEN_MISMATCH', {
|
|
123
|
+
* status: 403,
|
|
124
|
+
* message: 'Invalid CSRF token',
|
|
125
|
+
* })
|
|
126
|
+
*/
|
|
127
|
+
error?: InstanceType<typeof ORPCError>;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
|
|
131
|
+
* It helps ensure that requests to your procedures originate from JavaScript code,
|
|
132
|
+
* not from other sources like standard HTML forms or direct browser navigation.
|
|
133
|
+
*
|
|
134
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
|
|
135
|
+
*/
|
|
136
|
+
declare class SimpleCsrfProtectionHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
|
137
|
+
private readonly headerName;
|
|
138
|
+
private readonly headerValue;
|
|
139
|
+
private readonly exclude;
|
|
140
|
+
private readonly error;
|
|
141
|
+
constructor(options?: SimpleCsrfProtectionHandlerPluginOptions<T>);
|
|
142
|
+
order: number;
|
|
143
|
+
init(options: StandardHandlerOptions<T>): void;
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
interface StrictGetMethodPluginOptions {
|
|
147
|
+
/**
|
|
148
|
+
* The error thrown when a GET request is made to a procedure that doesn't allow GET.
|
|
149
|
+
*
|
|
150
|
+
* @default new ORPCError('METHOD_NOT_SUPPORTED')
|
|
151
|
+
*/
|
|
152
|
+
error?: InstanceType<typeof ORPCError$1>;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* This plugin enhances security by ensuring only procedures explicitly marked to accept GET requests
|
|
156
|
+
* can be called using the HTTP GET method for RPC Protocol. This helps prevent certain types of
|
|
157
|
+
* Cross-Site Request Forgery (CSRF) attacks.
|
|
158
|
+
*
|
|
159
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/strict-get-method Strict Get Method Plugin Docs}
|
|
160
|
+
*/
|
|
161
|
+
declare class StrictGetMethodPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
|
162
|
+
private readonly error;
|
|
163
|
+
/**
|
|
164
|
+
* make sure execute before batch plugin to get real method
|
|
165
|
+
*/
|
|
166
|
+
order: number;
|
|
167
|
+
constructor(options?: StrictGetMethodPluginOptions);
|
|
168
|
+
init(options: StandardHandlerOptions<T>): void;
|
|
29
169
|
}
|
|
30
170
|
|
|
31
|
-
export {
|
|
171
|
+
export { BatchHandlerPlugin, CORSPlugin, RequestHeadersPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin, StrictGetMethodPlugin };
|
|
172
|
+
export type { BatchHandlerOptions, CORSOptions, RequestHeadersPluginContext, ResponseHeadersPluginContext, SimpleCsrfProtectionHandlerPluginOptions, StrictGetMethodPluginOptions };
|
package/dist/plugins/index.mjs
CHANGED
|
@@ -1,8 +1,124 @@
|
|
|
1
|
-
|
|
2
|
-
import {
|
|
1
|
+
import { runWithSpan, value, setSpanError, isAsyncIteratorObject, AsyncIteratorClass, clone } from '@orpc/shared';
|
|
2
|
+
import { flattenHeader } from '@orpc/standard-server';
|
|
3
|
+
import { parseBatchRequest, toBatchResponse } from '@orpc/standard-server/batch';
|
|
4
|
+
import { toFetchHeaders } from '@orpc/standard-server-fetch';
|
|
5
|
+
import { ORPCError } from '@orpc/client';
|
|
6
|
+
export { S as StrictGetMethodPlugin } from '../shared/server.TEVCLCFC.mjs';
|
|
7
|
+
import '@orpc/contract';
|
|
8
|
+
|
|
9
|
+
class BatchHandlerPlugin {
|
|
10
|
+
maxSize;
|
|
11
|
+
mapRequestItem;
|
|
12
|
+
successStatus;
|
|
13
|
+
headers;
|
|
14
|
+
order = 5e6;
|
|
15
|
+
constructor(options = {}) {
|
|
16
|
+
this.maxSize = options.maxSize ?? 10;
|
|
17
|
+
this.mapRequestItem = options.mapRequestItem ?? ((request, { request: batchRequest }) => ({
|
|
18
|
+
...request,
|
|
19
|
+
headers: {
|
|
20
|
+
...batchRequest.headers,
|
|
21
|
+
...request.headers
|
|
22
|
+
}
|
|
23
|
+
}));
|
|
24
|
+
this.successStatus = options.successStatus ?? 207;
|
|
25
|
+
this.headers = options.headers ?? {};
|
|
26
|
+
}
|
|
27
|
+
init(options) {
|
|
28
|
+
options.rootInterceptors ??= [];
|
|
29
|
+
options.rootInterceptors.unshift(async (options2) => {
|
|
30
|
+
const xHeader = flattenHeader(options2.request.headers["x-orpc-batch"]);
|
|
31
|
+
if (xHeader === void 0) {
|
|
32
|
+
return options2.next();
|
|
33
|
+
}
|
|
34
|
+
let isParsing = false;
|
|
35
|
+
try {
|
|
36
|
+
return await runWithSpan({ name: "handle_batch_request" }, async (span) => {
|
|
37
|
+
const mode = xHeader === "buffered" ? "buffered" : "streaming";
|
|
38
|
+
isParsing = true;
|
|
39
|
+
const parsed = parseBatchRequest({ ...options2.request, body: await options2.request.body() });
|
|
40
|
+
isParsing = false;
|
|
41
|
+
span?.setAttribute("batch.mode", mode);
|
|
42
|
+
span?.setAttribute("batch.size", parsed.length);
|
|
43
|
+
const maxSize = await value(this.maxSize, options2);
|
|
44
|
+
if (parsed.length > maxSize) {
|
|
45
|
+
const message = "Batch request size exceeds the maximum allowed size";
|
|
46
|
+
setSpanError(span, message);
|
|
47
|
+
return {
|
|
48
|
+
matched: true,
|
|
49
|
+
response: {
|
|
50
|
+
status: 413,
|
|
51
|
+
headers: {},
|
|
52
|
+
body: message
|
|
53
|
+
}
|
|
54
|
+
};
|
|
55
|
+
}
|
|
56
|
+
const responses = parsed.map(
|
|
57
|
+
(request, index) => {
|
|
58
|
+
const mapped = this.mapRequestItem(request, options2);
|
|
59
|
+
return options2.next({ ...options2, request: { ...mapped, body: () => Promise.resolve(mapped.body) } }).then(({ response: response2, matched }) => {
|
|
60
|
+
span?.addEvent(`response.${index}.${matched ? "success" : "not_matched"}`);
|
|
61
|
+
if (matched) {
|
|
62
|
+
if (response2.body instanceof Blob || response2.body instanceof FormData || isAsyncIteratorObject(response2.body)) {
|
|
63
|
+
return {
|
|
64
|
+
index,
|
|
65
|
+
status: 500,
|
|
66
|
+
headers: {},
|
|
67
|
+
body: "Batch responses do not support file/blob, or event-iterator. Please call this procedure separately outside of the batch request."
|
|
68
|
+
};
|
|
69
|
+
}
|
|
70
|
+
return { ...response2, index };
|
|
71
|
+
}
|
|
72
|
+
return { index, status: 404, headers: {}, body: "No procedure matched" };
|
|
73
|
+
}).catch((err) => {
|
|
74
|
+
Promise.reject(err);
|
|
75
|
+
return { index, status: 500, headers: {}, body: "Internal server error" };
|
|
76
|
+
});
|
|
77
|
+
}
|
|
78
|
+
);
|
|
79
|
+
await Promise.race(responses);
|
|
80
|
+
const status = await value(this.successStatus, responses, options2);
|
|
81
|
+
const headers = await value(this.headers, responses, options2);
|
|
82
|
+
const promises = [...responses];
|
|
83
|
+
const response = await toBatchResponse({
|
|
84
|
+
status,
|
|
85
|
+
headers,
|
|
86
|
+
mode,
|
|
87
|
+
body: new AsyncIteratorClass(
|
|
88
|
+
async () => {
|
|
89
|
+
const handling = promises.filter((p) => p !== void 0);
|
|
90
|
+
if (handling.length <= 0) {
|
|
91
|
+
return { done: true, value: void 0 };
|
|
92
|
+
}
|
|
93
|
+
const value2 = await Promise.race(handling);
|
|
94
|
+
promises[value2.index] = void 0;
|
|
95
|
+
return { done: false, value: value2 };
|
|
96
|
+
},
|
|
97
|
+
async () => {
|
|
98
|
+
}
|
|
99
|
+
)
|
|
100
|
+
});
|
|
101
|
+
return {
|
|
102
|
+
matched: true,
|
|
103
|
+
response
|
|
104
|
+
};
|
|
105
|
+
});
|
|
106
|
+
} catch (cause) {
|
|
107
|
+
if (isParsing) {
|
|
108
|
+
return {
|
|
109
|
+
matched: true,
|
|
110
|
+
response: { status: 400, headers: {}, body: "Invalid batch request, this could be caused by a malformed request body or a missing header" }
|
|
111
|
+
};
|
|
112
|
+
}
|
|
113
|
+
throw cause;
|
|
114
|
+
}
|
|
115
|
+
});
|
|
116
|
+
}
|
|
117
|
+
}
|
|
3
118
|
|
|
4
119
|
class CORSPlugin {
|
|
5
120
|
options;
|
|
121
|
+
order = 9e6;
|
|
6
122
|
constructor(options = {}) {
|
|
7
123
|
const defaults = {
|
|
8
124
|
origin: (origin) => origin,
|
|
@@ -22,13 +138,11 @@ class CORSPlugin {
|
|
|
22
138
|
resHeaders["access-control-max-age"] = this.options.maxAge.toString();
|
|
23
139
|
}
|
|
24
140
|
if (this.options.allowMethods?.length) {
|
|
25
|
-
resHeaders["access-control-allow-methods"] = this.options.allowMethods
|
|
141
|
+
resHeaders["access-control-allow-methods"] = flattenHeader(this.options.allowMethods);
|
|
26
142
|
}
|
|
27
143
|
const allowHeaders = this.options.allowHeaders ?? interceptorOptions.request.headers["access-control-request-headers"];
|
|
28
|
-
if (
|
|
29
|
-
resHeaders["access-control-allow-headers"] = allowHeaders
|
|
30
|
-
} else if (typeof allowHeaders === "string") {
|
|
31
|
-
resHeaders["access-control-allow-headers"] = allowHeaders;
|
|
144
|
+
if (typeof allowHeaders === "string" || allowHeaders?.length) {
|
|
145
|
+
resHeaders["access-control-allow-headers"] = flattenHeader(allowHeaders);
|
|
32
146
|
}
|
|
33
147
|
return {
|
|
34
148
|
matched: true,
|
|
@@ -46,7 +160,7 @@ class CORSPlugin {
|
|
|
46
160
|
if (!result.matched) {
|
|
47
161
|
return result;
|
|
48
162
|
}
|
|
49
|
-
const origin =
|
|
163
|
+
const origin = flattenHeader(interceptorOptions.request.headers.origin) ?? "";
|
|
50
164
|
const allowedOrigin = await value(this.options.origin, origin, interceptorOptions);
|
|
51
165
|
const allowedOriginArr = Array.isArray(allowedOrigin) ? allowedOrigin : [allowedOrigin];
|
|
52
166
|
if (allowedOriginArr.includes("*")) {
|
|
@@ -68,25 +182,46 @@ class CORSPlugin {
|
|
|
68
182
|
result.response.headers["access-control-allow-credentials"] = "true";
|
|
69
183
|
}
|
|
70
184
|
if (this.options.exposeHeaders?.length) {
|
|
71
|
-
result.response.headers["access-control-expose-headers"] = this.options.exposeHeaders
|
|
185
|
+
result.response.headers["access-control-expose-headers"] = flattenHeader(this.options.exposeHeaders);
|
|
72
186
|
}
|
|
73
187
|
return result;
|
|
74
188
|
});
|
|
75
189
|
}
|
|
76
190
|
}
|
|
77
191
|
|
|
192
|
+
class RequestHeadersPlugin {
|
|
193
|
+
init(options) {
|
|
194
|
+
options.rootInterceptors ??= [];
|
|
195
|
+
options.rootInterceptors.push((interceptorOptions) => {
|
|
196
|
+
const reqHeaders = interceptorOptions.context.reqHeaders ?? toFetchHeaders(interceptorOptions.request.headers);
|
|
197
|
+
return interceptorOptions.next({
|
|
198
|
+
...interceptorOptions,
|
|
199
|
+
context: {
|
|
200
|
+
...interceptorOptions.context,
|
|
201
|
+
reqHeaders
|
|
202
|
+
}
|
|
203
|
+
});
|
|
204
|
+
});
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
|
|
78
208
|
class ResponseHeadersPlugin {
|
|
79
209
|
init(options) {
|
|
80
210
|
options.rootInterceptors ??= [];
|
|
81
211
|
options.rootInterceptors.push(async (interceptorOptions) => {
|
|
82
|
-
const
|
|
83
|
-
|
|
84
|
-
|
|
212
|
+
const resHeaders = interceptorOptions.context.resHeaders ?? new Headers();
|
|
213
|
+
const result = await interceptorOptions.next({
|
|
214
|
+
...interceptorOptions,
|
|
215
|
+
context: {
|
|
216
|
+
...interceptorOptions.context,
|
|
217
|
+
resHeaders
|
|
218
|
+
}
|
|
219
|
+
});
|
|
85
220
|
if (!result.matched) {
|
|
86
221
|
return result;
|
|
87
222
|
}
|
|
88
|
-
const responseHeaders = result.response.headers;
|
|
89
|
-
for (const [key, value] of
|
|
223
|
+
const responseHeaders = clone(result.response.headers);
|
|
224
|
+
for (const [key, value] of resHeaders) {
|
|
90
225
|
if (Array.isArray(responseHeaders[key])) {
|
|
91
226
|
responseHeaders[key].push(value);
|
|
92
227
|
} else if (responseHeaders[key] !== void 0) {
|
|
@@ -95,9 +230,58 @@ class ResponseHeadersPlugin {
|
|
|
95
230
|
responseHeaders[key] = value;
|
|
96
231
|
}
|
|
97
232
|
}
|
|
98
|
-
return
|
|
233
|
+
return {
|
|
234
|
+
...result,
|
|
235
|
+
response: {
|
|
236
|
+
...result.response,
|
|
237
|
+
headers: responseHeaders
|
|
238
|
+
}
|
|
239
|
+
};
|
|
240
|
+
});
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
const SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL = Symbol("SIMPLE_CSRF_PROTECTION_CONTEXT");
|
|
245
|
+
class SimpleCsrfProtectionHandlerPlugin {
|
|
246
|
+
headerName;
|
|
247
|
+
headerValue;
|
|
248
|
+
exclude;
|
|
249
|
+
error;
|
|
250
|
+
constructor(options = {}) {
|
|
251
|
+
this.headerName = options.headerName ?? "x-csrf-token";
|
|
252
|
+
this.headerValue = options.headerValue ?? "orpc";
|
|
253
|
+
this.exclude = options.exclude ?? false;
|
|
254
|
+
this.error = options.error ?? new ORPCError("CSRF_TOKEN_MISMATCH", {
|
|
255
|
+
status: 403,
|
|
256
|
+
message: "Invalid CSRF token"
|
|
257
|
+
});
|
|
258
|
+
}
|
|
259
|
+
order = 8e6;
|
|
260
|
+
init(options) {
|
|
261
|
+
options.rootInterceptors ??= [];
|
|
262
|
+
options.clientInterceptors ??= [];
|
|
263
|
+
options.rootInterceptors.unshift(async (options2) => {
|
|
264
|
+
const headerName = await value(this.headerName, options2);
|
|
265
|
+
const headerValue = await value(this.headerValue, options2);
|
|
266
|
+
return options2.next({
|
|
267
|
+
...options2,
|
|
268
|
+
context: {
|
|
269
|
+
...options2.context,
|
|
270
|
+
[SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL]: options2.request.headers[headerName] === headerValue
|
|
271
|
+
}
|
|
272
|
+
});
|
|
273
|
+
});
|
|
274
|
+
options.clientInterceptors.unshift(async (options2) => {
|
|
275
|
+
if (typeof options2.context[SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL] !== "boolean") {
|
|
276
|
+
throw new TypeError("[SimpleCsrfProtectionHandlerPlugin] CSRF protection context has been corrupted or modified by another plugin or interceptor");
|
|
277
|
+
}
|
|
278
|
+
const excluded = await value(this.exclude, options2);
|
|
279
|
+
if (!excluded && !options2.context[SIMPLE_CSRF_PROTECTION_CONTEXT_SYMBOL]) {
|
|
280
|
+
throw this.error;
|
|
281
|
+
}
|
|
282
|
+
return options2.next();
|
|
99
283
|
});
|
|
100
284
|
}
|
|
101
285
|
}
|
|
102
286
|
|
|
103
|
-
export { CORSPlugin, ResponseHeadersPlugin };
|
|
287
|
+
export { BatchHandlerPlugin, CORSPlugin, RequestHeadersPlugin, ResponseHeadersPlugin, SimpleCsrfProtectionHandlerPlugin };
|
|
@@ -1,12 +1,11 @@
|
|
|
1
|
-
import { ORPCErrorCode, ORPCErrorOptions, ORPCError, ClientContext, Client } from '@orpc/client';
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
1
|
+
import { ORPCErrorCode, ORPCErrorOptions, ORPCError, HTTPPath, ClientContext, Client } from '@orpc/client';
|
|
2
|
+
import { ErrorMap, ErrorMapItem, InferSchemaInput, AnySchema, Meta, ContractProcedureDef, InferSchemaOutput, ErrorFromErrorMap, AnyContractRouter, ContractProcedure } from '@orpc/contract';
|
|
3
|
+
import { MaybeOptionalOptions, Promisable, Interceptor, PromiseWithError, Value } from '@orpc/shared';
|
|
4
4
|
|
|
5
|
-
type Context = Record<
|
|
5
|
+
type Context = Record<PropertyKey, any>;
|
|
6
6
|
type MergedInitialContext<TInitial extends Context, TAdditional extends Context, TCurrent extends Context> = TInitial & Omit<TAdditional, keyof TCurrent>;
|
|
7
7
|
type MergedCurrentContext<T extends Context, U extends Context> = Omit<T, keyof U> & U;
|
|
8
8
|
declare function mergeCurrentContext<T extends Context, U extends Context>(context: T, other: U): MergedCurrentContext<T, U>;
|
|
9
|
-
type ContextExtendsGuard<T extends Context, U extends Context> = T extends U ? unknown : never;
|
|
10
9
|
|
|
11
10
|
type ORPCErrorConstructorMapItemOptions<TData> = Omit<ORPCErrorOptions<TData>, 'defined' | 'status'>;
|
|
12
11
|
type ORPCErrorConstructorMapItem<TCode extends ORPCErrorCode, TInData> = (...rest: MaybeOptionalOptions<ORPCErrorConstructorMapItemOptions<TInData>>) => ORPCError<TCode, TInData>;
|
|
@@ -14,7 +13,6 @@ type ORPCErrorConstructorMap<T extends ErrorMap> = {
|
|
|
14
13
|
[K in keyof T]: K extends ORPCErrorCode ? T[K] extends ErrorMapItem<infer UInputSchema> ? ORPCErrorConstructorMapItem<K, InferSchemaInput<UInputSchema>> : never : never;
|
|
15
14
|
};
|
|
16
15
|
declare function createORPCErrorConstructorMap<T extends ErrorMap>(errors: T): ORPCErrorConstructorMap<T>;
|
|
17
|
-
declare function validateORPCError(map: ErrorMap, error: ORPCError<any, any>): Promise<ORPCError<string, unknown>>;
|
|
18
16
|
|
|
19
17
|
declare const LAZY_SYMBOL: unique symbol;
|
|
20
18
|
interface LazyMeta {
|
|
@@ -29,6 +27,11 @@ interface Lazy<T> {
|
|
|
29
27
|
};
|
|
30
28
|
}
|
|
31
29
|
type Lazyable<T> = T | Lazy<T>;
|
|
30
|
+
/**
|
|
31
|
+
* Creates a lazy-loaded item.
|
|
32
|
+
*
|
|
33
|
+
* @warning The `prefix` in `meta` only holds metadata and does not apply the prefix to the lazy router, use `os.prefix(...).lazy(...)` instead.
|
|
34
|
+
*/
|
|
32
35
|
declare function lazy<T>(loader: () => Promise<{
|
|
33
36
|
default: T;
|
|
34
37
|
}>, meta?: LazyMeta): Lazy<T>;
|
|
@@ -57,7 +60,15 @@ interface ProcedureDef<TInitialContext extends Context, TCurrentContext extends
|
|
|
57
60
|
outputValidationIndex: number;
|
|
58
61
|
handler: ProcedureHandler<TCurrentContext, any, any, any, any>;
|
|
59
62
|
}
|
|
63
|
+
/**
|
|
64
|
+
* This class represents a procedure.
|
|
65
|
+
*
|
|
66
|
+
* @see {@link https://orpc.unnoq.com/docs/procedure Procedure Docs}
|
|
67
|
+
*/
|
|
60
68
|
declare class Procedure<TInitialContext extends Context, TCurrentContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
69
|
+
/**
|
|
70
|
+
* This property holds the defined options.
|
|
71
|
+
*/
|
|
61
72
|
'~orpc': ProcedureDef<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>;
|
|
62
73
|
constructor(def: ProcedureDef<TInitialContext, TCurrentContext, TInputSchema, TOutputSchema, TErrorMap, TMeta>);
|
|
63
74
|
}
|
|
@@ -88,6 +99,11 @@ interface MiddlewareOptions<TInContext extends Context, TOutput, TErrorConstruct
|
|
|
88
99
|
next: MiddlewareNextFn<TOutput>;
|
|
89
100
|
errors: TErrorConstructorMap;
|
|
90
101
|
}
|
|
102
|
+
/**
|
|
103
|
+
* A function that represents a middleware.
|
|
104
|
+
*
|
|
105
|
+
* @see {@link https://orpc.unnoq.com/docs/middleware Middleware Docs}
|
|
106
|
+
*/
|
|
91
107
|
interface Middleware<TInContext extends Context, TOutContext extends Context, TInput, TOutput, TErrorConstructorMap extends ORPCErrorConstructorMap<any>, TMeta extends Meta> {
|
|
92
108
|
(options: MiddlewareOptions<TInContext, TOutput, TErrorConstructorMap, TMeta>, input: TInput, output: MiddlewareOutputFn<TOutput>): Promisable<MiddlewareResult<TOutContext, TOutput>>;
|
|
93
109
|
}
|
|
@@ -98,47 +114,80 @@ interface MapInputMiddleware<TInput, TMappedInput> {
|
|
|
98
114
|
declare function middlewareOutputFn<TOutput>(output: TOutput): MiddlewareResult<Record<never, never>, TOutput>;
|
|
99
115
|
|
|
100
116
|
type ProcedureClient<TClientContext extends ClientContext, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap> = Client<TClientContext, InferSchemaInput<TInputSchema>, InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>;
|
|
101
|
-
interface ProcedureClientInterceptorOptions<TInitialContext extends Context,
|
|
117
|
+
interface ProcedureClientInterceptorOptions<TInitialContext extends Context, TErrorMap extends ErrorMap, TMeta extends Meta> {
|
|
102
118
|
context: TInitialContext;
|
|
103
|
-
input:
|
|
119
|
+
input: unknown;
|
|
104
120
|
errors: ORPCErrorConstructorMap<TErrorMap>;
|
|
105
121
|
path: readonly string[];
|
|
106
122
|
procedure: Procedure<Context, Context, AnySchema, AnySchema, ErrorMap, TMeta>;
|
|
107
123
|
signal?: AbortSignal;
|
|
108
124
|
lastEventId: string | undefined;
|
|
109
125
|
}
|
|
110
|
-
|
|
111
|
-
* Options for creating a procedure caller with comprehensive type safety
|
|
112
|
-
*/
|
|
113
|
-
type CreateProcedureClientOptions<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TClientContext extends ClientContext> = {
|
|
126
|
+
type CreateProcedureClientOptions<TInitialContext extends Context, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TClientContext extends ClientContext> = {
|
|
114
127
|
/**
|
|
115
128
|
* This is helpful for logging and analytics.
|
|
116
129
|
*/
|
|
117
130
|
path?: readonly string[];
|
|
118
|
-
interceptors?: Interceptor<ProcedureClientInterceptorOptions<TInitialContext,
|
|
131
|
+
interceptors?: Interceptor<ProcedureClientInterceptorOptions<TInitialContext, TErrorMap, TMeta>, PromiseWithError<InferSchemaOutput<TOutputSchema>, ErrorFromErrorMap<TErrorMap>>>[];
|
|
119
132
|
} & (Record<never, never> extends TInitialContext ? {
|
|
120
|
-
context?: Value<TInitialContext
|
|
133
|
+
context?: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
|
|
121
134
|
} : {
|
|
122
|
-
context: Value<TInitialContext
|
|
135
|
+
context: Value<Promisable<TInitialContext>, [clientContext: TClientContext]>;
|
|
123
136
|
});
|
|
124
|
-
|
|
137
|
+
/**
|
|
138
|
+
* Create Server-side client from a procedure.
|
|
139
|
+
*
|
|
140
|
+
* @see {@link https://orpc.unnoq.com/docs/client/server-side Server-side Client Docs}
|
|
141
|
+
*/
|
|
142
|
+
declare function createProcedureClient<TInitialContext extends Context, TInputSchema extends AnySchema, TOutputSchema extends AnySchema, TErrorMap extends ErrorMap, TMeta extends Meta, TClientContext extends ClientContext>(lazyableProcedure: Lazyable<Procedure<TInitialContext, any, TInputSchema, TOutputSchema, TErrorMap, TMeta>>, ...rest: MaybeOptionalOptions<CreateProcedureClientOptions<TInitialContext, TOutputSchema, TErrorMap, TMeta, TClientContext>>): ProcedureClient<TClientContext, TInputSchema, TOutputSchema, TErrorMap>;
|
|
125
143
|
|
|
144
|
+
/**
|
|
145
|
+
* Represents a router, which defines a hierarchical structure of procedures.
|
|
146
|
+
*
|
|
147
|
+
* @info A procedure is a router too.
|
|
148
|
+
* @see {@link https://orpc.unnoq.com/docs/contract-first/define-contract#contract-router Contract Router Docs}
|
|
149
|
+
*/
|
|
126
150
|
type Router<T extends AnyContractRouter, TInitialContext extends Context> = T extends ContractProcedure<infer UInputSchema, infer UOutputSchema, infer UErrorMap, infer UMeta> ? Procedure<TInitialContext, any, UInputSchema, UOutputSchema, UErrorMap, UMeta> : {
|
|
127
151
|
[K in keyof T]: T[K] extends AnyContractRouter ? Lazyable<Router<T[K], TInitialContext>> : never;
|
|
128
152
|
};
|
|
129
153
|
type AnyRouter = Router<any, any>;
|
|
130
154
|
type InferRouterInitialContext<T extends AnyRouter> = T extends Router<any, infer UInitialContext> ? UInitialContext : never;
|
|
155
|
+
/**
|
|
156
|
+
* Infer all initial context of the router.
|
|
157
|
+
*
|
|
158
|
+
* @info A procedure is a router too.
|
|
159
|
+
* @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
|
|
160
|
+
*/
|
|
131
161
|
type InferRouterInitialContexts<T extends AnyRouter> = T extends Procedure<infer UInitialContext, any, any, any, any, any> ? UInitialContext : {
|
|
132
162
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterInitialContexts<U> : never;
|
|
133
163
|
};
|
|
164
|
+
/**
|
|
165
|
+
* Infer all current context of the router.
|
|
166
|
+
*
|
|
167
|
+
* @info A procedure is a router too.
|
|
168
|
+
* @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
|
|
169
|
+
*/
|
|
134
170
|
type InferRouterCurrentContexts<T extends AnyRouter> = T extends Procedure<any, infer UCurrentContext, any, any, any, any> ? UCurrentContext : {
|
|
135
171
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterCurrentContexts<U> : never;
|
|
136
172
|
};
|
|
173
|
+
/**
|
|
174
|
+
* Infer all router inputs
|
|
175
|
+
*
|
|
176
|
+
* @info A procedure is a router too.
|
|
177
|
+
* @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
|
|
178
|
+
*/
|
|
137
179
|
type InferRouterInputs<T extends AnyRouter> = T extends Procedure<any, any, infer UInputSchema, any, any, any> ? InferSchemaInput<UInputSchema> : {
|
|
138
180
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterInputs<U> : never;
|
|
139
181
|
};
|
|
182
|
+
/**
|
|
183
|
+
* Infer all router outputs
|
|
184
|
+
*
|
|
185
|
+
* @info A procedure is a router too.
|
|
186
|
+
* @see {@link https://orpc.unnoq.com/docs/router#utilities Router Utilities Docs}
|
|
187
|
+
*/
|
|
140
188
|
type InferRouterOutputs<T extends AnyRouter> = T extends Procedure<any, any, any, infer UOutputSchema, any, any> ? InferSchemaOutput<UOutputSchema> : {
|
|
141
189
|
[K in keyof T]: T[K] extends Lazyable<infer U extends AnyRouter> ? InferRouterOutputs<U> : never;
|
|
142
190
|
};
|
|
143
191
|
|
|
144
|
-
export {
|
|
192
|
+
export { isProcedure as E, createProcedureClient as F, Procedure as P, mergeCurrentContext as m, createORPCErrorConstructorMap as n, LAZY_SYMBOL as o, lazy as q, isLazy as r, getLazyMeta as s, unlazy as u, middlewareOutputFn as z };
|
|
193
|
+
export type { AnyProcedure as A, ProcedureHandlerOptions as B, Context as C, ProcedureDef as D, InferRouterInitialContexts as G, InferRouterCurrentContexts as H, InferRouterInitialContext as I, InferRouterInputs as J, InferRouterOutputs as K, Lazyable as L, MergedInitialContext as M, ORPCErrorConstructorMap as O, Router as R, AnyMiddleware as a, AnyRouter as b, Lazy as c, ProcedureClientInterceptorOptions as d, Middleware as e, MergedCurrentContext as f, MapInputMiddleware as g, CreateProcedureClientOptions as h, ProcedureClient as i, ProcedureHandler as j, ORPCErrorConstructorMapItemOptions as k, ORPCErrorConstructorMapItem as l, LazyMeta as p, MiddlewareResult as t, MiddlewareNextFnOptions as v, MiddlewareNextFn as w, MiddlewareOutputFn as x, MiddlewareOptions as y };
|