@orpc/client 0.0.0-next.c40d0c9 → 0.0.0-next.c4671e3
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 +13 -17
- package/dist/adapters/fetch/index.d.mts +12 -5
- package/dist/adapters/fetch/index.d.ts +12 -5
- package/dist/adapters/fetch/index.mjs +4 -7
- package/dist/adapters/standard/index.d.mts +3 -3
- package/dist/adapters/standard/index.d.ts +3 -3
- package/dist/adapters/standard/index.mjs +2 -2
- package/dist/adapters/websocket/index.d.mts +29 -0
- package/dist/adapters/websocket/index.d.ts +29 -0
- package/dist/adapters/websocket/index.mjs +31 -0
- package/dist/index.d.mts +25 -11
- package/dist/index.d.ts +25 -11
- package/dist/index.mjs +5 -5
- package/dist/plugins/index.d.mts +121 -24
- package/dist/plugins/index.d.ts +121 -24
- package/dist/plugins/index.mjs +205 -45
- package/dist/shared/{client.C0lT7w02.d.mts → client.4TS_0JaO.d.mts} +7 -8
- package/dist/shared/{client.C0lT7w02.d.ts → client.4TS_0JaO.d.ts} +7 -8
- package/dist/shared/{client.5813Ufvs.d.mts → client.7ZYxJok_.d.ts} +20 -13
- package/dist/shared/{client.D-jrSuDb.d.ts → client.B2432-Lu.d.ts} +12 -24
- package/dist/shared/{client.jKEwIsRd.mjs → client.CRWEpqLB.mjs} +17 -17
- package/dist/shared/{client.Bt94sjrK.d.mts → client.ClwIM_ku.d.mts} +12 -24
- package/dist/shared/{client.DSPm2IGZ.mjs → client.DpICn1BD.mjs} +32 -14
- package/dist/shared/{client.grRbC25r.d.ts → client.ds1abV85.d.mts} +20 -13
- package/package.json +10 -4
package/dist/plugins/index.d.ts
CHANGED
@@ -1,11 +1,79 @@
|
|
1
1
|
import { Value } from '@orpc/shared';
|
2
|
-
import {
|
3
|
-
import { b as
|
4
|
-
import '
|
2
|
+
import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
|
3
|
+
import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.7ZYxJok_.js';
|
4
|
+
import { a as ClientContext } from '../shared/client.4TS_0JaO.js';
|
5
5
|
|
6
|
-
interface
|
6
|
+
interface BatchLinkPluginGroup<T extends ClientContext> {
|
7
|
+
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
8
|
+
context: T;
|
9
|
+
path?: readonly string[];
|
10
|
+
input?: unknown;
|
11
|
+
}
|
12
|
+
interface BatchLinkPluginOptions<T extends ClientContext> {
|
13
|
+
groups: readonly [BatchLinkPluginGroup<T>, ...BatchLinkPluginGroup<T>[]];
|
14
|
+
/**
|
15
|
+
* The maximum number of requests in the batch.
|
16
|
+
*
|
17
|
+
* @default 10
|
18
|
+
*/
|
19
|
+
maxSize?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
20
|
+
/**
|
21
|
+
* Defines the URL to use for the batch request.
|
22
|
+
*
|
23
|
+
* @default the URL of the first request in the batch + '/__batch__'
|
24
|
+
*/
|
25
|
+
url?: Value<string | URL, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
26
|
+
/**
|
27
|
+
* The maximum length of the URL.
|
28
|
+
*
|
29
|
+
* @default 2083
|
30
|
+
*/
|
31
|
+
maxUrlLength?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
32
|
+
/**
|
33
|
+
* Defines the HTTP headers to use for the batch request.
|
34
|
+
*
|
35
|
+
* @default The same headers of all requests in the batch
|
36
|
+
*/
|
37
|
+
headers?: Value<StandardHeaders, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
38
|
+
/**
|
39
|
+
* Map the batch request items before sending them.
|
40
|
+
*
|
41
|
+
* @default Removes headers that are duplicated in the batch headers.
|
42
|
+
*/
|
43
|
+
mapRequestItem?: (options: StandardLinkClientInterceptorOptions<T> & {
|
44
|
+
batchUrl: URL;
|
45
|
+
batchHeaders: StandardHeaders;
|
46
|
+
}) => StandardRequest;
|
47
|
+
/**
|
48
|
+
* Exclude a request from the batch.
|
49
|
+
*
|
50
|
+
* @default () => false
|
51
|
+
*/
|
52
|
+
exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
53
|
+
}
|
54
|
+
/**
|
55
|
+
* The Batch Request/Response Plugin allows you to combine multiple requests and responses into a single batch,
|
56
|
+
* reducing the overhead of sending each one separately.
|
57
|
+
*
|
58
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-request-response Batch Request/Response Plugin Docs}
|
59
|
+
*/
|
60
|
+
declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
61
|
+
#private;
|
62
|
+
private readonly groups;
|
63
|
+
private readonly maxSize;
|
64
|
+
private readonly batchUrl;
|
65
|
+
private readonly maxUrlLength;
|
66
|
+
private readonly batchHeaders;
|
67
|
+
private readonly mapRequestItem;
|
68
|
+
private readonly exclude;
|
69
|
+
private pending;
|
70
|
+
order: number;
|
71
|
+
constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
|
72
|
+
init(options: StandardLinkOptions<T>): void;
|
73
|
+
}
|
74
|
+
|
75
|
+
interface ClientRetryPluginAttemptOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
|
7
76
|
lastEventRetry: number | undefined;
|
8
|
-
lastEventId: string | undefined;
|
9
77
|
attemptIndex: number;
|
10
78
|
error: unknown;
|
11
79
|
}
|
@@ -16,43 +84,34 @@ interface ClientRetryPluginContext {
|
|
16
84
|
*
|
17
85
|
* @default 0
|
18
86
|
*/
|
19
|
-
retry?: Value<number, [
|
20
|
-
clientOptions: ClientOptions<ClientRetryPluginContext>,
|
21
|
-
path: readonly string[],
|
22
|
-
input: unknown
|
23
|
-
]>;
|
87
|
+
retry?: Value<number, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
|
24
88
|
/**
|
25
89
|
* Delay (in ms) before retrying.
|
26
90
|
*
|
27
91
|
* @default (o) => o.lastEventRetry ?? 2000
|
28
92
|
*/
|
29
|
-
retryDelay?: Value<number, [
|
30
|
-
attemptOptions: ClientRetryPluginAttemptOptions,
|
31
|
-
clientOptions: ClientOptions<ClientRetryPluginContext>,
|
32
|
-
path: readonly string[],
|
33
|
-
input: unknown
|
34
|
-
]>;
|
93
|
+
retryDelay?: Value<number, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
35
94
|
/**
|
36
95
|
* Determine should retry or not.
|
37
96
|
*
|
38
97
|
* @default true
|
39
98
|
*/
|
40
|
-
shouldRetry?: Value<boolean, [
|
41
|
-
attemptOptions: ClientRetryPluginAttemptOptions,
|
42
|
-
clientOptions: ClientOptions<ClientRetryPluginContext>,
|
43
|
-
path: readonly string[],
|
44
|
-
input: unknown
|
45
|
-
]>;
|
99
|
+
shouldRetry?: Value<boolean, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
46
100
|
/**
|
47
101
|
* The hook called when retrying, and return the unsubscribe function.
|
48
102
|
*/
|
49
|
-
onRetry?: (options: ClientRetryPluginAttemptOptions
|
103
|
+
onRetry?: (options: ClientRetryPluginAttemptOptions<ClientRetryPluginContext>) => void | ((isSuccess: boolean) => void);
|
50
104
|
}
|
51
105
|
declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
52
106
|
}
|
53
107
|
interface ClientRetryPluginOptions {
|
54
108
|
default?: ClientRetryPluginContext;
|
55
109
|
}
|
110
|
+
/**
|
111
|
+
* The Client Retry Plugin enables retrying client calls when errors occur.
|
112
|
+
*
|
113
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/client-retry Client Retry Plugin Docs}
|
114
|
+
*/
|
56
115
|
declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements StandardLinkPlugin<T> {
|
57
116
|
private readonly defaultRetry;
|
58
117
|
private readonly defaultRetryDelay;
|
@@ -62,4 +121,42 @@ declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements S
|
|
62
121
|
init(options: StandardLinkOptions<T>): void;
|
63
122
|
}
|
64
123
|
|
65
|
-
|
124
|
+
interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
|
125
|
+
/**
|
126
|
+
* The name of the header to check.
|
127
|
+
*
|
128
|
+
* @default 'x-csrf-token'
|
129
|
+
*/
|
130
|
+
headerName?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
|
131
|
+
/**
|
132
|
+
* The value of the header to check.
|
133
|
+
*
|
134
|
+
* @default 'orpc'
|
135
|
+
*
|
136
|
+
*/
|
137
|
+
headerValue?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
|
138
|
+
/**
|
139
|
+
* Exclude a procedure from the plugin.
|
140
|
+
*
|
141
|
+
* @default false
|
142
|
+
*/
|
143
|
+
exclude?: Value<boolean, [options: StandardLinkClientInterceptorOptions<T>]>;
|
144
|
+
}
|
145
|
+
/**
|
146
|
+
* This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
|
147
|
+
* It helps ensure that requests to your procedures originate from JavaScript code,
|
148
|
+
* not from other sources like standard HTML forms or direct browser navigation.
|
149
|
+
*
|
150
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
|
151
|
+
*/
|
152
|
+
declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
153
|
+
private readonly headerName;
|
154
|
+
private readonly headerValue;
|
155
|
+
private readonly exclude;
|
156
|
+
constructor(options?: SimpleCsrfProtectionLinkPluginOptions<T>);
|
157
|
+
order: number;
|
158
|
+
init(options: StandardLinkOptions<T>): void;
|
159
|
+
}
|
160
|
+
|
161
|
+
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
|
162
|
+
export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
|
package/dist/plugins/index.mjs
CHANGED
@@ -1,6 +1,152 @@
|
|
1
|
-
import { value,
|
1
|
+
import { isAsyncIteratorObject, value, splitInHalf, toArray } from '@orpc/shared';
|
2
|
+
import { toBatchRequest, parseBatchResponse } from '@orpc/standard-server/batch';
|
2
3
|
import { getEventMeta } from '@orpc/standard-server';
|
3
4
|
|
5
|
+
class BatchLinkPlugin {
|
6
|
+
groups;
|
7
|
+
maxSize;
|
8
|
+
batchUrl;
|
9
|
+
maxUrlLength;
|
10
|
+
batchHeaders;
|
11
|
+
mapRequestItem;
|
12
|
+
exclude;
|
13
|
+
pending;
|
14
|
+
order = 5e6;
|
15
|
+
constructor(options) {
|
16
|
+
this.groups = options.groups;
|
17
|
+
this.pending = /* @__PURE__ */ new Map();
|
18
|
+
this.maxSize = options.maxSize ?? 10;
|
19
|
+
this.maxUrlLength = options.maxUrlLength ?? 2083;
|
20
|
+
this.batchUrl = options.url ?? (([options2]) => `${options2.request.url.origin}${options2.request.url.pathname}/__batch__`);
|
21
|
+
this.batchHeaders = options.headers ?? (([options2, ...rest]) => {
|
22
|
+
const headers = {};
|
23
|
+
for (const [key, value2] of Object.entries(options2.request.headers)) {
|
24
|
+
if (rest.every((item) => item.request.headers[key] === value2)) {
|
25
|
+
headers[key] = value2;
|
26
|
+
}
|
27
|
+
}
|
28
|
+
return headers;
|
29
|
+
});
|
30
|
+
this.mapRequestItem = options.mapRequestItem ?? (({ request, batchHeaders }) => {
|
31
|
+
const headers = {};
|
32
|
+
for (const [key, value2] of Object.entries(request.headers)) {
|
33
|
+
if (batchHeaders[key] !== value2) {
|
34
|
+
headers[key] = value2;
|
35
|
+
}
|
36
|
+
}
|
37
|
+
return {
|
38
|
+
method: request.method,
|
39
|
+
url: request.url,
|
40
|
+
headers,
|
41
|
+
body: request.body,
|
42
|
+
signal: request.signal
|
43
|
+
};
|
44
|
+
});
|
45
|
+
this.exclude = options.exclude ?? (() => false);
|
46
|
+
}
|
47
|
+
init(options) {
|
48
|
+
options.clientInterceptors ??= [];
|
49
|
+
options.clientInterceptors.push((options2) => {
|
50
|
+
if (options2.request.headers["x-orpc-batch"] !== "1") {
|
51
|
+
return options2.next();
|
52
|
+
}
|
53
|
+
return options2.next({
|
54
|
+
...options2,
|
55
|
+
request: {
|
56
|
+
...options2.request,
|
57
|
+
headers: {
|
58
|
+
...options2.request.headers,
|
59
|
+
"x-orpc-batch": void 0
|
60
|
+
}
|
61
|
+
}
|
62
|
+
});
|
63
|
+
});
|
64
|
+
options.clientInterceptors.push((options2) => {
|
65
|
+
if (this.exclude(options2) || options2.request.body instanceof Blob || options2.request.body instanceof FormData || isAsyncIteratorObject(options2.request.body)) {
|
66
|
+
return options2.next();
|
67
|
+
}
|
68
|
+
const group = this.groups.find((group2) => group2.condition(options2));
|
69
|
+
if (!group) {
|
70
|
+
return options2.next();
|
71
|
+
}
|
72
|
+
return new Promise((resolve, reject) => {
|
73
|
+
this.#enqueueRequest(group, options2, resolve, reject);
|
74
|
+
setTimeout(() => this.#processPendingBatches());
|
75
|
+
});
|
76
|
+
});
|
77
|
+
}
|
78
|
+
#enqueueRequest(group, options, resolve, reject) {
|
79
|
+
const items = this.pending.get(group);
|
80
|
+
if (items) {
|
81
|
+
items.push([options, resolve, reject]);
|
82
|
+
} else {
|
83
|
+
this.pending.set(group, [[options, resolve, reject]]);
|
84
|
+
}
|
85
|
+
}
|
86
|
+
async #processPendingBatches() {
|
87
|
+
const pending = this.pending;
|
88
|
+
this.pending = /* @__PURE__ */ new Map();
|
89
|
+
for (const [group, items] of pending) {
|
90
|
+
const getItems = items.filter(([options]) => options.request.method === "GET");
|
91
|
+
const restItems = items.filter(([options]) => options.request.method !== "GET");
|
92
|
+
this.#executeBatch("GET", group, getItems);
|
93
|
+
this.#executeBatch("POST", group, restItems);
|
94
|
+
}
|
95
|
+
}
|
96
|
+
async #executeBatch(method, group, groupItems) {
|
97
|
+
if (!groupItems.length) {
|
98
|
+
return;
|
99
|
+
}
|
100
|
+
const batchItems = groupItems;
|
101
|
+
if (batchItems.length === 1) {
|
102
|
+
batchItems[0][0].next().then(batchItems[0][1]).catch(batchItems[0][2]);
|
103
|
+
return;
|
104
|
+
}
|
105
|
+
try {
|
106
|
+
const options = batchItems.map(([options2]) => options2);
|
107
|
+
const maxSize = await value(this.maxSize, options);
|
108
|
+
if (batchItems.length > maxSize) {
|
109
|
+
const [first, second] = splitInHalf(batchItems);
|
110
|
+
this.#executeBatch(method, group, first);
|
111
|
+
this.#executeBatch(method, group, second);
|
112
|
+
return;
|
113
|
+
}
|
114
|
+
const batchUrl = new URL(await value(this.batchUrl, options));
|
115
|
+
const batchHeaders = await value(this.batchHeaders, options);
|
116
|
+
const mappedItems = batchItems.map(([options2]) => this.mapRequestItem({ ...options2, batchUrl, batchHeaders }));
|
117
|
+
const batchRequest = toBatchRequest({
|
118
|
+
method,
|
119
|
+
url: batchUrl,
|
120
|
+
headers: batchHeaders,
|
121
|
+
requests: mappedItems
|
122
|
+
});
|
123
|
+
const maxUrlLength = await value(this.maxUrlLength, options);
|
124
|
+
if (batchRequest.url.toString().length > maxUrlLength) {
|
125
|
+
const [first, second] = splitInHalf(batchItems);
|
126
|
+
this.#executeBatch(method, group, first);
|
127
|
+
this.#executeBatch(method, group, second);
|
128
|
+
return;
|
129
|
+
}
|
130
|
+
const lazyResponse = await options[0].next({
|
131
|
+
request: { ...batchRequest, headers: { ...batchRequest.headers, "x-orpc-batch": "1" } },
|
132
|
+
signal: batchRequest.signal,
|
133
|
+
context: group.context,
|
134
|
+
input: group.input,
|
135
|
+
path: toArray(group.path)
|
136
|
+
});
|
137
|
+
const parsed = parseBatchResponse({ ...lazyResponse, body: await lazyResponse.body() });
|
138
|
+
for await (const item of parsed) {
|
139
|
+
batchItems[item.index]?.[1]({ ...item, body: () => Promise.resolve(item.body) });
|
140
|
+
}
|
141
|
+
throw new Error("Something went wrong make batch response not contains enough responses. This can be a bug please report it.");
|
142
|
+
} catch (error) {
|
143
|
+
for (const [, , reject] of batchItems) {
|
144
|
+
reject(error);
|
145
|
+
}
|
146
|
+
}
|
147
|
+
}
|
148
|
+
}
|
149
|
+
|
4
150
|
class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
5
151
|
}
|
6
152
|
class ClientRetryPlugin {
|
@@ -18,75 +164,56 @@ class ClientRetryPlugin {
|
|
18
164
|
options.interceptors ??= [];
|
19
165
|
options.interceptors.push(async (interceptorOptions) => {
|
20
166
|
const maxAttempts = await value(
|
21
|
-
interceptorOptions.
|
22
|
-
interceptorOptions
|
23
|
-
interceptorOptions.path,
|
24
|
-
interceptorOptions.input
|
167
|
+
interceptorOptions.context.retry ?? this.defaultRetry,
|
168
|
+
interceptorOptions
|
25
169
|
);
|
26
|
-
const retryDelay = interceptorOptions.
|
27
|
-
const shouldRetry = interceptorOptions.
|
28
|
-
const onRetry = interceptorOptions.
|
170
|
+
const retryDelay = interceptorOptions.context.retryDelay ?? this.defaultRetryDelay;
|
171
|
+
const shouldRetry = interceptorOptions.context.shouldRetry ?? this.defaultShouldRetry;
|
172
|
+
const onRetry = interceptorOptions.context.onRetry ?? this.defaultOnRetry;
|
29
173
|
if (maxAttempts <= 0) {
|
30
174
|
return interceptorOptions.next();
|
31
175
|
}
|
32
|
-
let lastEventId = interceptorOptions.
|
176
|
+
let lastEventId = interceptorOptions.lastEventId;
|
33
177
|
let lastEventRetry;
|
34
|
-
let
|
178
|
+
let callback;
|
35
179
|
let attemptIndex = 0;
|
36
|
-
const next = async (
|
37
|
-
let
|
180
|
+
const next = async (initialError) => {
|
181
|
+
let currentError = initialError;
|
38
182
|
while (true) {
|
39
|
-
const
|
40
|
-
if (
|
183
|
+
const updatedInterceptorOptions = { ...interceptorOptions, lastEventId };
|
184
|
+
if (currentError) {
|
41
185
|
if (attemptIndex >= maxAttempts) {
|
42
|
-
throw
|
186
|
+
throw currentError.error;
|
43
187
|
}
|
44
188
|
const attemptOptions = {
|
189
|
+
...updatedInterceptorOptions,
|
45
190
|
attemptIndex,
|
46
|
-
error:
|
47
|
-
lastEventId,
|
191
|
+
error: currentError.error,
|
48
192
|
lastEventRetry
|
49
193
|
};
|
50
194
|
const shouldRetryBool = await value(
|
51
195
|
shouldRetry,
|
52
|
-
attemptOptions
|
53
|
-
newClientOptions,
|
54
|
-
interceptorOptions.path,
|
55
|
-
interceptorOptions.input
|
196
|
+
attemptOptions
|
56
197
|
);
|
57
198
|
if (!shouldRetryBool) {
|
58
|
-
throw
|
199
|
+
throw currentError.error;
|
59
200
|
}
|
60
|
-
|
61
|
-
|
62
|
-
newClientOptions,
|
63
|
-
interceptorOptions.path,
|
64
|
-
interceptorOptions.input
|
65
|
-
);
|
66
|
-
const retryDelayMs = await value(
|
67
|
-
retryDelay,
|
68
|
-
attemptOptions,
|
69
|
-
newClientOptions,
|
70
|
-
interceptorOptions.path,
|
71
|
-
interceptorOptions.input
|
72
|
-
);
|
201
|
+
callback = onRetry?.(attemptOptions);
|
202
|
+
const retryDelayMs = await value(retryDelay, attemptOptions);
|
73
203
|
await new Promise((resolve) => setTimeout(resolve, retryDelayMs));
|
74
204
|
attemptIndex++;
|
75
205
|
}
|
76
206
|
try {
|
77
|
-
|
78
|
-
|
79
|
-
options: newClientOptions
|
80
|
-
});
|
81
|
-
return output2;
|
207
|
+
currentError = void 0;
|
208
|
+
return await interceptorOptions.next(updatedInterceptorOptions);
|
82
209
|
} catch (error) {
|
83
|
-
|
210
|
+
currentError = { error };
|
211
|
+
if (updatedInterceptorOptions.signal?.aborted === true) {
|
84
212
|
throw error;
|
85
213
|
}
|
86
|
-
current = { error };
|
87
214
|
} finally {
|
88
|
-
|
89
|
-
|
215
|
+
callback?.(!currentError);
|
216
|
+
callback = void 0;
|
90
217
|
}
|
91
218
|
}
|
92
219
|
};
|
@@ -128,4 +255,37 @@ class ClientRetryPlugin {
|
|
128
255
|
}
|
129
256
|
}
|
130
257
|
|
131
|
-
|
258
|
+
class SimpleCsrfProtectionLinkPlugin {
|
259
|
+
headerName;
|
260
|
+
headerValue;
|
261
|
+
exclude;
|
262
|
+
constructor(options = {}) {
|
263
|
+
this.headerName = options.headerName ?? "x-csrf-token";
|
264
|
+
this.headerValue = options.headerValue ?? "orpc";
|
265
|
+
this.exclude = options.exclude ?? false;
|
266
|
+
}
|
267
|
+
order = 8e6;
|
268
|
+
init(options) {
|
269
|
+
options.clientInterceptors ??= [];
|
270
|
+
options.clientInterceptors.push(async (options2) => {
|
271
|
+
const excluded = await value(this.exclude, options2);
|
272
|
+
if (excluded) {
|
273
|
+
return options2.next();
|
274
|
+
}
|
275
|
+
const headerName = await value(this.headerName, options2);
|
276
|
+
const headerValue = await value(this.headerValue, options2);
|
277
|
+
return options2.next({
|
278
|
+
...options2,
|
279
|
+
request: {
|
280
|
+
...options2.request,
|
281
|
+
headers: {
|
282
|
+
...options2.request.headers,
|
283
|
+
[headerName]: headerValue
|
284
|
+
}
|
285
|
+
}
|
286
|
+
});
|
287
|
+
});
|
288
|
+
}
|
289
|
+
}
|
290
|
+
|
291
|
+
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
|
@@ -1,15 +1,17 @@
|
|
1
1
|
import { PromiseWithError } from '@orpc/shared';
|
2
2
|
|
3
3
|
type HTTPPath = `/${string}`;
|
4
|
-
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
4
|
+
type HTTPMethod = 'HEAD' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
5
5
|
type ClientContext = Record<PropertyKey, any>;
|
6
|
-
|
6
|
+
interface ClientOptions<T extends ClientContext> {
|
7
7
|
signal?: AbortSignal;
|
8
8
|
lastEventId?: string | undefined;
|
9
|
-
|
10
|
-
|
9
|
+
context: T;
|
10
|
+
}
|
11
|
+
type FriendlyClientOptions<T extends ClientContext> = Omit<ClientOptions<T>, 'context'> & (Record<never, never> extends T ? {
|
12
|
+
context?: T;
|
11
13
|
} : {
|
12
|
-
context:
|
14
|
+
context: T;
|
13
15
|
});
|
14
16
|
type ClientRest<TClientContext extends ClientContext, TInput> = Record<never, never> extends TClientContext ? undefined extends TInput ? [input?: TInput, options?: FriendlyClientOptions<TClientContext>] : [input: TInput, options?: FriendlyClientOptions<TClientContext>] : [input: TInput, options: FriendlyClientOptions<TClientContext>];
|
15
17
|
type ClientPromiseResult<TOutput, TError> = PromiseWithError<TOutput, TError>;
|
@@ -20,9 +22,6 @@ type NestedClient<TClientContext extends ClientContext> = Client<TClientContext,
|
|
20
22
|
[k: string]: NestedClient<TClientContext>;
|
21
23
|
};
|
22
24
|
type InferClientContext<T extends NestedClient<any>> = T extends NestedClient<infer U> ? U : never;
|
23
|
-
type ClientOptions<TClientContext extends ClientContext> = FriendlyClientOptions<TClientContext> & {
|
24
|
-
context: TClientContext;
|
25
|
-
};
|
26
25
|
interface ClientLink<TClientContext extends ClientContext> {
|
27
26
|
call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
|
28
27
|
}
|
@@ -1,15 +1,17 @@
|
|
1
1
|
import { PromiseWithError } from '@orpc/shared';
|
2
2
|
|
3
3
|
type HTTPPath = `/${string}`;
|
4
|
-
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
4
|
+
type HTTPMethod = 'HEAD' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
5
5
|
type ClientContext = Record<PropertyKey, any>;
|
6
|
-
|
6
|
+
interface ClientOptions<T extends ClientContext> {
|
7
7
|
signal?: AbortSignal;
|
8
8
|
lastEventId?: string | undefined;
|
9
|
-
|
10
|
-
|
9
|
+
context: T;
|
10
|
+
}
|
11
|
+
type FriendlyClientOptions<T extends ClientContext> = Omit<ClientOptions<T>, 'context'> & (Record<never, never> extends T ? {
|
12
|
+
context?: T;
|
11
13
|
} : {
|
12
|
-
context:
|
14
|
+
context: T;
|
13
15
|
});
|
14
16
|
type ClientRest<TClientContext extends ClientContext, TInput> = Record<never, never> extends TClientContext ? undefined extends TInput ? [input?: TInput, options?: FriendlyClientOptions<TClientContext>] : [input: TInput, options?: FriendlyClientOptions<TClientContext>] : [input: TInput, options: FriendlyClientOptions<TClientContext>];
|
15
17
|
type ClientPromiseResult<TOutput, TError> = PromiseWithError<TOutput, TError>;
|
@@ -20,9 +22,6 @@ type NestedClient<TClientContext extends ClientContext> = Client<TClientContext,
|
|
20
22
|
[k: string]: NestedClient<TClientContext>;
|
21
23
|
};
|
22
24
|
type InferClientContext<T extends NestedClient<any>> = T extends NestedClient<infer U> ? U : never;
|
23
|
-
type ClientOptions<TClientContext extends ClientContext> = FriendlyClientOptions<TClientContext> & {
|
24
|
-
context: TClientContext;
|
25
|
-
};
|
26
25
|
interface ClientLink<TClientContext extends ClientContext> {
|
27
26
|
call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
|
28
27
|
}
|
@@ -1,6 +1,16 @@
|
|
1
1
|
import { Interceptor, ThrowableError } from '@orpc/shared';
|
2
2
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
3
|
-
import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.
|
3
|
+
import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.4TS_0JaO.js';
|
4
|
+
|
5
|
+
interface StandardLinkPlugin<T extends ClientContext> {
|
6
|
+
order?: number;
|
7
|
+
init?(options: StandardLinkOptions<T>): void;
|
8
|
+
}
|
9
|
+
declare class CompositeStandardLinkPlugin<T extends ClientContext, TPlugin extends StandardLinkPlugin<T>> implements StandardLinkPlugin<T> {
|
10
|
+
protected readonly plugins: TPlugin[];
|
11
|
+
constructor(plugins?: readonly TPlugin[]);
|
12
|
+
init(options: StandardLinkOptions<T>): void;
|
13
|
+
}
|
4
14
|
|
5
15
|
interface StandardLinkCodec<T extends ClientContext> {
|
6
16
|
encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
|
@@ -10,20 +20,16 @@ interface StandardLinkClient<T extends ClientContext> {
|
|
10
20
|
call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
11
21
|
}
|
12
22
|
|
13
|
-
|
23
|
+
interface StandardLinkInterceptorOptions<T extends ClientContext> extends ClientOptions<T> {
|
24
|
+
path: readonly string[];
|
25
|
+
input: unknown;
|
14
26
|
}
|
15
|
-
interface
|
16
|
-
|
27
|
+
interface StandardLinkClientInterceptorOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
|
28
|
+
request: StandardRequest;
|
17
29
|
}
|
18
30
|
interface StandardLinkOptions<T extends ClientContext> {
|
19
|
-
interceptors?: Interceptor<
|
20
|
-
|
21
|
-
input: unknown;
|
22
|
-
options: ClientOptions<T>;
|
23
|
-
}, unknown, ThrowableError>[];
|
24
|
-
clientInterceptors?: Interceptor<{
|
25
|
-
request: StandardRequest;
|
26
|
-
}, StandardLazyResponse, ThrowableError>[];
|
31
|
+
interceptors?: Interceptor<StandardLinkInterceptorOptions<T>, unknown, ThrowableError>[];
|
32
|
+
clientInterceptors?: Interceptor<StandardLinkClientInterceptorOptions<T>, StandardLazyResponse, ThrowableError>[];
|
27
33
|
plugins?: StandardLinkPlugin<T>[];
|
28
34
|
}
|
29
35
|
declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
@@ -36,4 +42,5 @@ declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
|
36
42
|
call(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<unknown>;
|
37
43
|
}
|
38
44
|
|
39
|
-
export {
|
45
|
+
export { CompositeStandardLinkPlugin as C, StandardLink as d };
|
46
|
+
export type { StandardLinkClientInterceptorOptions as S, StandardLinkPlugin as a, StandardLinkOptions as b, StandardLinkInterceptorOptions as c, StandardLinkCodec as e, StandardLinkClient as f };
|
@@ -1,5 +1,5 @@
|
|
1
|
-
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.
|
2
|
-
import {
|
1
|
+
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.4TS_0JaO.js';
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.7ZYxJok_.js';
|
3
3
|
import { Segment, Value } from '@orpc/shared';
|
4
4
|
import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
5
5
|
|
@@ -44,46 +44,30 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
|
44
44
|
/**
|
45
45
|
* Base url for all requests.
|
46
46
|
*/
|
47
|
-
url: Value<string | URL, [
|
48
|
-
options: ClientOptions<T>,
|
49
|
-
path: readonly string[],
|
50
|
-
input: unknown
|
51
|
-
]>;
|
47
|
+
url: Value<string | URL, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
52
48
|
/**
|
53
49
|
* The maximum length of the URL.
|
54
50
|
*
|
55
51
|
* @default 2083
|
56
52
|
*/
|
57
|
-
maxUrlLength?: Value<number, [
|
58
|
-
options: ClientOptions<T>,
|
59
|
-
path: readonly string[],
|
60
|
-
input: unknown
|
61
|
-
]>;
|
53
|
+
maxUrlLength?: Value<number, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
62
54
|
/**
|
63
55
|
* The method used to make the request.
|
64
56
|
*
|
65
57
|
* @default 'POST'
|
66
58
|
*/
|
67
|
-
method?: Value<HTTPMethod, [
|
68
|
-
options: ClientOptions<T>,
|
69
|
-
path: readonly string[],
|
70
|
-
input: unknown
|
71
|
-
]>;
|
59
|
+
method?: Value<Exclude<HTTPMethod, 'HEAD'>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
72
60
|
/**
|
73
61
|
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
74
62
|
* GET is not allowed, it's very dangerous.
|
75
63
|
*
|
76
64
|
* @default 'POST'
|
77
65
|
*/
|
78
|
-
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
66
|
+
fallbackMethod?: Exclude<HTTPMethod, 'HEAD' | 'GET'>;
|
79
67
|
/**
|
80
68
|
* Inject headers to the request.
|
81
69
|
*/
|
82
|
-
headers?: Value<StandardHeaders, [
|
83
|
-
options: ClientOptions<T>,
|
84
|
-
path: readonly string[],
|
85
|
-
input: unknown
|
86
|
-
]>;
|
70
|
+
headers?: Value<StandardHeaders, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
87
71
|
}
|
88
72
|
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
89
73
|
private readonly serializer;
|
@@ -99,5 +83,9 @@ declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardL
|
|
99
83
|
|
100
84
|
interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
|
101
85
|
}
|
86
|
+
declare class StandardRPCLink<T extends ClientContext> extends StandardLink<T> {
|
87
|
+
constructor(linkClient: StandardLinkClient<T>, options: StandardRPCLinkOptions<T>);
|
88
|
+
}
|
102
89
|
|
103
|
-
export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as S,
|
90
|
+
export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as S, StandardRPCJsonSerializer as e, StandardRPCLink as g, StandardRPCLinkCodec as i, StandardRPCSerializer as j };
|
91
|
+
export type { StandardRPCJsonSerializedMetaItem as a, StandardRPCJsonSerialized as b, StandardRPCCustomJsonSerializer as c, StandardRPCJsonSerializerOptions as d, StandardRPCLinkOptions as f, StandardRPCLinkCodecOptions as h };
|