@orpc/client 0.0.0-next.d888fab → 0.0.0-next.d92c7aa
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 +11 -8
- package/dist/adapters/fetch/index.d.mts +23 -10
- package/dist/adapters/fetch/index.d.ts +23 -10
- package/dist/adapters/fetch/index.mjs +24 -8
- package/dist/adapters/message-port/index.d.mts +80 -0
- package/dist/adapters/message-port/index.d.ts +80 -0
- package/dist/adapters/message-port/index.mjs +86 -0
- package/dist/adapters/standard/index.d.mts +6 -5
- package/dist/adapters/standard/index.d.ts +6 -5
- package/dist/adapters/standard/index.mjs +3 -2
- package/dist/adapters/websocket/index.d.mts +12 -12
- package/dist/adapters/websocket/index.d.ts +12 -12
- package/dist/adapters/websocket/index.mjs +26 -11
- package/dist/index.d.mts +86 -25
- package/dist/index.d.ts +86 -25
- package/dist/index.mjs +54 -8
- package/dist/plugins/index.d.mts +58 -17
- package/dist/plugins/index.d.ts +58 -17
- package/dist/plugins/index.mjs +143 -27
- package/dist/shared/client.BH1AYT_p.d.mts +83 -0
- package/dist/shared/client.BH1AYT_p.d.ts +83 -0
- package/dist/shared/{client.B2432-Lu.d.ts → client.BxV-mzeR.d.ts} +7 -7
- package/dist/shared/{client.DpICn1BD.mjs → client.C0heK4ll.mjs} +62 -20
- package/dist/shared/{client.7ZYxJok_.d.ts → client.CPgZaUox.d.mts} +4 -5
- package/dist/shared/{client.ClwIM_ku.d.mts → client.D8lMmWVC.d.mts} +7 -7
- package/dist/shared/{client.ds1abV85.d.mts → client.De8SW4Kw.d.ts} +4 -5
- package/dist/shared/{client.CRWEpqLB.mjs → client.o7kYI1Tg.mjs} +66 -33
- package/package.json +11 -6
- package/dist/shared/client.4TS_0JaO.d.mts +0 -29
- package/dist/shared/client.4TS_0JaO.d.ts +0 -29
package/dist/plugins/index.d.ts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
import { Value } from '@orpc/shared';
|
|
1
|
+
import { Value, Promisable } from '@orpc/shared';
|
|
2
2
|
import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
|
|
3
|
-
import {
|
|
4
|
-
import { a as
|
|
3
|
+
import { BatchResponseMode } from '@orpc/standard-server/batch';
|
|
4
|
+
import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.De8SW4Kw.js';
|
|
5
|
+
import { b as ClientContext } from '../shared/client.BH1AYT_p.js';
|
|
5
6
|
|
|
6
7
|
interface BatchLinkPluginGroup<T extends ClientContext> {
|
|
7
8
|
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
|
@@ -16,25 +17,31 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
|
16
17
|
*
|
|
17
18
|
* @default 10
|
|
18
19
|
*/
|
|
19
|
-
maxSize?: Value<number
|
|
20
|
+
maxSize?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
21
|
+
/**
|
|
22
|
+
* The batch response mode.
|
|
23
|
+
*
|
|
24
|
+
* @default 'streaming'
|
|
25
|
+
*/
|
|
26
|
+
mode?: Value<BatchResponseMode, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
20
27
|
/**
|
|
21
28
|
* Defines the URL to use for the batch request.
|
|
22
29
|
*
|
|
23
30
|
* @default the URL of the first request in the batch + '/__batch__'
|
|
24
31
|
*/
|
|
25
|
-
url?: Value<string | URL
|
|
32
|
+
url?: Value<Promisable<string | URL>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
26
33
|
/**
|
|
27
34
|
* The maximum length of the URL.
|
|
28
35
|
*
|
|
29
36
|
* @default 2083
|
|
30
37
|
*/
|
|
31
|
-
maxUrlLength?: Value<number
|
|
38
|
+
maxUrlLength?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
32
39
|
/**
|
|
33
40
|
* Defines the HTTP headers to use for the batch request.
|
|
34
41
|
*
|
|
35
42
|
* @default The same headers of all requests in the batch
|
|
36
43
|
*/
|
|
37
|
-
headers?: Value<StandardHeaders
|
|
44
|
+
headers?: Value<Promisable<StandardHeaders>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
|
38
45
|
/**
|
|
39
46
|
* Map the batch request items before sending them.
|
|
40
47
|
*
|
|
@@ -52,10 +59,10 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
|
|
|
52
59
|
exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
|
53
60
|
}
|
|
54
61
|
/**
|
|
55
|
-
* The Batch
|
|
62
|
+
* The Batch Requests Plugin allows you to combine multiple requests and responses into a single batch,
|
|
56
63
|
* reducing the overhead of sending each one separately.
|
|
57
64
|
*
|
|
58
|
-
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-
|
|
65
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-requests Batch Requests Plugin Docs}
|
|
59
66
|
*/
|
|
60
67
|
declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
|
61
68
|
#private;
|
|
@@ -66,12 +73,45 @@ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPl
|
|
|
66
73
|
private readonly batchHeaders;
|
|
67
74
|
private readonly mapRequestItem;
|
|
68
75
|
private readonly exclude;
|
|
76
|
+
private readonly mode;
|
|
69
77
|
private pending;
|
|
70
78
|
order: number;
|
|
71
79
|
constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
|
|
72
80
|
init(options: StandardLinkOptions<T>): void;
|
|
73
81
|
}
|
|
74
82
|
|
|
83
|
+
interface DedupeRequestsPluginGroup<T extends ClientContext> {
|
|
84
|
+
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
|
85
|
+
/**
|
|
86
|
+
* The context used for the rest of the request lifecycle.
|
|
87
|
+
*/
|
|
88
|
+
context: T;
|
|
89
|
+
}
|
|
90
|
+
interface DedupeRequestsPluginOptions<T extends ClientContext> {
|
|
91
|
+
/**
|
|
92
|
+
* To enable deduplication, a request must match at least one defined group.
|
|
93
|
+
* Requests that fall into the same group are considered for deduplication together.
|
|
94
|
+
*/
|
|
95
|
+
groups: readonly [DedupeRequestsPluginGroup<T>, ...DedupeRequestsPluginGroup<T>[]];
|
|
96
|
+
/**
|
|
97
|
+
* Filters requests to dedupe
|
|
98
|
+
*
|
|
99
|
+
* @default (({ request }) => request.method === 'GET')
|
|
100
|
+
*/
|
|
101
|
+
filter?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* Prevents duplicate requests by deduplicating similar ones to reduce server load.
|
|
105
|
+
*
|
|
106
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/dedupe-requests Dedupe Requests Plugin}
|
|
107
|
+
*/
|
|
108
|
+
declare class DedupeRequestsPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
|
109
|
+
#private;
|
|
110
|
+
order: number;
|
|
111
|
+
constructor(options: NoInfer<DedupeRequestsPluginOptions<T>>);
|
|
112
|
+
init(options: StandardLinkOptions<T>): void;
|
|
113
|
+
}
|
|
114
|
+
|
|
75
115
|
interface ClientRetryPluginAttemptOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
|
|
76
116
|
lastEventRetry: number | undefined;
|
|
77
117
|
attemptIndex: number;
|
|
@@ -84,19 +124,19 @@ interface ClientRetryPluginContext {
|
|
|
84
124
|
*
|
|
85
125
|
* @default 0
|
|
86
126
|
*/
|
|
87
|
-
retry?: Value<number
|
|
127
|
+
retry?: Value<Promisable<number>, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
|
|
88
128
|
/**
|
|
89
129
|
* Delay (in ms) before retrying.
|
|
90
130
|
*
|
|
91
131
|
* @default (o) => o.lastEventRetry ?? 2000
|
|
92
132
|
*/
|
|
93
|
-
retryDelay?: Value<number
|
|
133
|
+
retryDelay?: Value<Promisable<number>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
|
94
134
|
/**
|
|
95
135
|
* Determine should retry or not.
|
|
96
136
|
*
|
|
97
137
|
* @default true
|
|
98
138
|
*/
|
|
99
|
-
shouldRetry?: Value<boolean
|
|
139
|
+
shouldRetry?: Value<Promisable<boolean>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
|
100
140
|
/**
|
|
101
141
|
* The hook called when retrying, and return the unsubscribe function.
|
|
102
142
|
*/
|
|
@@ -117,6 +157,7 @@ declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements S
|
|
|
117
157
|
private readonly defaultRetryDelay;
|
|
118
158
|
private readonly defaultShouldRetry;
|
|
119
159
|
private readonly defaultOnRetry;
|
|
160
|
+
order: number;
|
|
120
161
|
constructor(options?: ClientRetryPluginOptions);
|
|
121
162
|
init(options: StandardLinkOptions<T>): void;
|
|
122
163
|
}
|
|
@@ -127,20 +168,20 @@ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
|
|
|
127
168
|
*
|
|
128
169
|
* @default 'x-csrf-token'
|
|
129
170
|
*/
|
|
130
|
-
headerName?: Value<string
|
|
171
|
+
headerName?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
|
131
172
|
/**
|
|
132
173
|
* The value of the header to check.
|
|
133
174
|
*
|
|
134
175
|
* @default 'orpc'
|
|
135
176
|
*
|
|
136
177
|
*/
|
|
137
|
-
headerValue?: Value<string
|
|
178
|
+
headerValue?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
|
138
179
|
/**
|
|
139
180
|
* Exclude a procedure from the plugin.
|
|
140
181
|
*
|
|
141
182
|
* @default false
|
|
142
183
|
*/
|
|
143
|
-
exclude?: Value<boolean
|
|
184
|
+
exclude?: Value<Promisable<boolean>, [options: StandardLinkClientInterceptorOptions<T>]>;
|
|
144
185
|
}
|
|
145
186
|
/**
|
|
146
187
|
* This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
|
|
@@ -158,5 +199,5 @@ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements
|
|
|
158
199
|
init(options: StandardLinkOptions<T>): void;
|
|
159
200
|
}
|
|
160
201
|
|
|
161
|
-
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
|
|
162
|
-
export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
|
|
202
|
+
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };
|
|
203
|
+
export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, DedupeRequestsPluginGroup, DedupeRequestsPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
|
package/dist/plugins/index.mjs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { isAsyncIteratorObject, value, splitInHalf, toArray } from '@orpc/shared';
|
|
2
|
-
import { toBatchRequest, parseBatchResponse } from '@orpc/standard-server/batch';
|
|
3
|
-
import { getEventMeta } from '@orpc/standard-server';
|
|
1
|
+
import { isAsyncIteratorObject, defer, value, splitInHalf, toArray, stringifyJSON, overlayProxy, AsyncIteratorClass } from '@orpc/shared';
|
|
2
|
+
import { toBatchRequest, parseBatchResponse, toBatchAbortSignal } from '@orpc/standard-server/batch';
|
|
3
|
+
import { replicateStandardLazyResponse, getEventMeta } from '@orpc/standard-server';
|
|
4
4
|
|
|
5
5
|
class BatchLinkPlugin {
|
|
6
6
|
groups;
|
|
@@ -10,6 +10,7 @@ class BatchLinkPlugin {
|
|
|
10
10
|
batchHeaders;
|
|
11
11
|
mapRequestItem;
|
|
12
12
|
exclude;
|
|
13
|
+
mode;
|
|
13
14
|
pending;
|
|
14
15
|
order = 5e6;
|
|
15
16
|
constructor(options) {
|
|
@@ -17,6 +18,7 @@ class BatchLinkPlugin {
|
|
|
17
18
|
this.pending = /* @__PURE__ */ new Map();
|
|
18
19
|
this.maxSize = options.maxSize ?? 10;
|
|
19
20
|
this.maxUrlLength = options.maxUrlLength ?? 2083;
|
|
21
|
+
this.mode = options.mode ?? "streaming";
|
|
20
22
|
this.batchUrl = options.url ?? (([options2]) => `${options2.request.url.origin}${options2.request.url.pathname}/__batch__`);
|
|
21
23
|
this.batchHeaders = options.headers ?? (([options2, ...rest]) => {
|
|
22
24
|
const headers = {};
|
|
@@ -62,7 +64,7 @@ class BatchLinkPlugin {
|
|
|
62
64
|
});
|
|
63
65
|
});
|
|
64
66
|
options.clientInterceptors.push((options2) => {
|
|
65
|
-
if (this.exclude(options2) || options2.request.body instanceof Blob || options2.request.body instanceof FormData || isAsyncIteratorObject(options2.request.body)) {
|
|
67
|
+
if (this.exclude(options2) || options2.request.body instanceof Blob || options2.request.body instanceof FormData || isAsyncIteratorObject(options2.request.body) || options2.request.signal?.aborted) {
|
|
66
68
|
return options2.next();
|
|
67
69
|
}
|
|
68
70
|
const group = this.groups.find((group2) => group2.condition(options2));
|
|
@@ -71,7 +73,7 @@ class BatchLinkPlugin {
|
|
|
71
73
|
}
|
|
72
74
|
return new Promise((resolve, reject) => {
|
|
73
75
|
this.#enqueueRequest(group, options2, resolve, reject);
|
|
74
|
-
|
|
76
|
+
defer(() => this.#processPendingBatches());
|
|
75
77
|
});
|
|
76
78
|
});
|
|
77
79
|
}
|
|
@@ -127,16 +129,28 @@ class BatchLinkPlugin {
|
|
|
127
129
|
this.#executeBatch(method, group, second);
|
|
128
130
|
return;
|
|
129
131
|
}
|
|
130
|
-
const
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
132
|
+
const mode = value(this.mode, options);
|
|
133
|
+
try {
|
|
134
|
+
const lazyResponse = await options[0].next({
|
|
135
|
+
request: { ...batchRequest, headers: { ...batchRequest.headers, "x-orpc-batch": mode } },
|
|
136
|
+
signal: batchRequest.signal,
|
|
137
|
+
context: group.context,
|
|
138
|
+
input: group.input,
|
|
139
|
+
path: toArray(group.path)
|
|
140
|
+
});
|
|
141
|
+
const parsed = parseBatchResponse({ ...lazyResponse, body: await lazyResponse.body() });
|
|
142
|
+
for await (const item of parsed) {
|
|
143
|
+
batchItems[item.index]?.[1]({ ...item, body: () => Promise.resolve(item.body) });
|
|
144
|
+
}
|
|
145
|
+
} catch (err) {
|
|
146
|
+
if (batchRequest.signal?.aborted && batchRequest.signal.reason === err) {
|
|
147
|
+
for (const [{ signal }, , reject] of batchItems) {
|
|
148
|
+
if (signal?.aborted) {
|
|
149
|
+
reject(signal.reason);
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
throw err;
|
|
140
154
|
}
|
|
141
155
|
throw new Error("Something went wrong make batch response not contains enough responses. This can be a bug please report it.");
|
|
142
156
|
} catch (error) {
|
|
@@ -147,6 +161,101 @@ class BatchLinkPlugin {
|
|
|
147
161
|
}
|
|
148
162
|
}
|
|
149
163
|
|
|
164
|
+
class DedupeRequestsPlugin {
|
|
165
|
+
#groups;
|
|
166
|
+
#filter;
|
|
167
|
+
order = 4e6;
|
|
168
|
+
// make sure execute before batch plugin
|
|
169
|
+
#queue = /* @__PURE__ */ new Map();
|
|
170
|
+
constructor(options) {
|
|
171
|
+
this.#groups = options.groups;
|
|
172
|
+
this.#filter = options.filter ?? (({ request }) => request.method === "GET");
|
|
173
|
+
}
|
|
174
|
+
init(options) {
|
|
175
|
+
options.clientInterceptors ??= [];
|
|
176
|
+
options.clientInterceptors.push((options2) => {
|
|
177
|
+
if (options2.request.body instanceof Blob || options2.request.body instanceof FormData || options2.request.body instanceof URLSearchParams || isAsyncIteratorObject(options2.request.body) || !this.#filter(options2)) {
|
|
178
|
+
return options2.next();
|
|
179
|
+
}
|
|
180
|
+
const group = this.#groups.find((group2) => group2.condition(options2));
|
|
181
|
+
if (!group) {
|
|
182
|
+
return options2.next();
|
|
183
|
+
}
|
|
184
|
+
return new Promise((resolve, reject) => {
|
|
185
|
+
this.#enqueue(group, options2, resolve, reject);
|
|
186
|
+
defer(() => this.#dequeue());
|
|
187
|
+
});
|
|
188
|
+
});
|
|
189
|
+
}
|
|
190
|
+
#enqueue(group, options, resolve, reject) {
|
|
191
|
+
let queue = this.#queue.get(group);
|
|
192
|
+
if (!queue) {
|
|
193
|
+
this.#queue.set(group, queue = []);
|
|
194
|
+
}
|
|
195
|
+
const matched = queue.find((item) => {
|
|
196
|
+
const requestString1 = stringifyJSON({
|
|
197
|
+
body: item.options.request.body,
|
|
198
|
+
headers: item.options.request.headers,
|
|
199
|
+
method: item.options.request.method,
|
|
200
|
+
url: item.options.request.url
|
|
201
|
+
});
|
|
202
|
+
const requestString2 = stringifyJSON({
|
|
203
|
+
body: options.request.body,
|
|
204
|
+
headers: options.request.headers,
|
|
205
|
+
method: options.request.method,
|
|
206
|
+
url: options.request.url
|
|
207
|
+
});
|
|
208
|
+
return requestString1 === requestString2;
|
|
209
|
+
});
|
|
210
|
+
if (matched) {
|
|
211
|
+
matched.signals.push(options.request.signal);
|
|
212
|
+
matched.resolves.push(resolve);
|
|
213
|
+
matched.rejects.push(reject);
|
|
214
|
+
} else {
|
|
215
|
+
queue.push({
|
|
216
|
+
options,
|
|
217
|
+
signals: [options.request.signal],
|
|
218
|
+
resolves: [resolve],
|
|
219
|
+
rejects: [reject]
|
|
220
|
+
});
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
async #dequeue() {
|
|
224
|
+
const promises = [];
|
|
225
|
+
for (const [group, items] of this.#queue) {
|
|
226
|
+
for (const { options, signals, resolves, rejects } of items) {
|
|
227
|
+
promises.push(
|
|
228
|
+
this.#execute(group, options, signals, resolves, rejects)
|
|
229
|
+
);
|
|
230
|
+
}
|
|
231
|
+
}
|
|
232
|
+
this.#queue.clear();
|
|
233
|
+
await Promise.all(promises);
|
|
234
|
+
}
|
|
235
|
+
async #execute(group, options, signals, resolves, rejects) {
|
|
236
|
+
try {
|
|
237
|
+
const dedupedRequest = {
|
|
238
|
+
...options.request,
|
|
239
|
+
signal: toBatchAbortSignal(signals)
|
|
240
|
+
};
|
|
241
|
+
const response = await options.next({
|
|
242
|
+
...options,
|
|
243
|
+
request: dedupedRequest,
|
|
244
|
+
signal: dedupedRequest.signal,
|
|
245
|
+
context: group.context
|
|
246
|
+
});
|
|
247
|
+
const replicatedResponses = replicateStandardLazyResponse(response, resolves.length);
|
|
248
|
+
for (const resolve of resolves) {
|
|
249
|
+
resolve(replicatedResponses.shift());
|
|
250
|
+
}
|
|
251
|
+
} catch (error) {
|
|
252
|
+
for (const reject of rejects) {
|
|
253
|
+
reject(error);
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
|
|
150
259
|
class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
|
151
260
|
}
|
|
152
261
|
class ClientRetryPlugin {
|
|
@@ -154,6 +263,7 @@ class ClientRetryPlugin {
|
|
|
154
263
|
defaultRetryDelay;
|
|
155
264
|
defaultShouldRetry;
|
|
156
265
|
defaultOnRetry;
|
|
266
|
+
order = 18e5;
|
|
157
267
|
constructor(options = {}) {
|
|
158
268
|
this.defaultRetry = options.default?.retry ?? 0;
|
|
159
269
|
this.defaultRetryDelay = options.default?.retryDelay ?? ((o) => o.lastEventRetry ?? 2e3);
|
|
@@ -208,7 +318,7 @@ class ClientRetryPlugin {
|
|
|
208
318
|
return await interceptorOptions.next(updatedInterceptorOptions);
|
|
209
319
|
} catch (error) {
|
|
210
320
|
currentError = { error };
|
|
211
|
-
if (updatedInterceptorOptions.signal?.aborted
|
|
321
|
+
if (updatedInterceptorOptions.signal?.aborted) {
|
|
212
322
|
throw error;
|
|
213
323
|
}
|
|
214
324
|
} finally {
|
|
@@ -221,19 +331,17 @@ class ClientRetryPlugin {
|
|
|
221
331
|
if (!isAsyncIteratorObject(output)) {
|
|
222
332
|
return output;
|
|
223
333
|
}
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
334
|
+
let current = output;
|
|
335
|
+
let isIteratorAborted = false;
|
|
336
|
+
return overlayProxy(() => current, new AsyncIteratorClass(
|
|
337
|
+
async () => {
|
|
227
338
|
while (true) {
|
|
228
339
|
try {
|
|
229
340
|
const item = await current.next();
|
|
230
341
|
const meta = getEventMeta(item.value);
|
|
231
342
|
lastEventId = meta?.id ?? lastEventId;
|
|
232
343
|
lastEventRetry = meta?.retry ?? lastEventRetry;
|
|
233
|
-
|
|
234
|
-
return item.value;
|
|
235
|
-
}
|
|
236
|
-
yield item.value;
|
|
344
|
+
return item;
|
|
237
345
|
} catch (error) {
|
|
238
346
|
const meta = getEventMeta(error);
|
|
239
347
|
lastEventId = meta?.id ?? lastEventId;
|
|
@@ -245,12 +353,20 @@ class ClientRetryPlugin {
|
|
|
245
353
|
);
|
|
246
354
|
}
|
|
247
355
|
current = maybeEventIterator;
|
|
356
|
+
if (isIteratorAborted) {
|
|
357
|
+
await current.return?.();
|
|
358
|
+
throw error;
|
|
359
|
+
}
|
|
248
360
|
}
|
|
249
361
|
}
|
|
250
|
-
}
|
|
251
|
-
|
|
362
|
+
},
|
|
363
|
+
async (reason) => {
|
|
364
|
+
isIteratorAborted = true;
|
|
365
|
+
if (reason !== "next") {
|
|
366
|
+
await current.return?.();
|
|
367
|
+
}
|
|
252
368
|
}
|
|
253
|
-
|
|
369
|
+
));
|
|
254
370
|
});
|
|
255
371
|
}
|
|
256
372
|
}
|
|
@@ -288,4 +404,4 @@ class SimpleCsrfProtectionLinkPlugin {
|
|
|
288
404
|
}
|
|
289
405
|
}
|
|
290
406
|
|
|
291
|
-
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
|
|
407
|
+
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { PromiseWithError } from '@orpc/shared';
|
|
2
|
+
|
|
3
|
+
type HTTPPath = `/${string}`;
|
|
4
|
+
type HTTPMethod = 'HEAD' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
5
|
+
type ClientContext = Record<PropertyKey, any>;
|
|
6
|
+
interface ClientOptions<T extends ClientContext> {
|
|
7
|
+
signal?: AbortSignal;
|
|
8
|
+
lastEventId?: string | undefined;
|
|
9
|
+
context: T;
|
|
10
|
+
}
|
|
11
|
+
type FriendlyClientOptions<T extends ClientContext> = Omit<ClientOptions<T>, 'context'> & (Record<never, never> extends T ? {
|
|
12
|
+
context?: T;
|
|
13
|
+
} : {
|
|
14
|
+
context: T;
|
|
15
|
+
});
|
|
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>];
|
|
17
|
+
type ClientPromiseResult<TOutput, TError> = PromiseWithError<TOutput, TError>;
|
|
18
|
+
interface Client<TClientContext extends ClientContext, TInput, TOutput, TError> {
|
|
19
|
+
(...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
|
|
20
|
+
}
|
|
21
|
+
type NestedClient<TClientContext extends ClientContext> = Client<TClientContext, any, any, any> | {
|
|
22
|
+
[k: string]: NestedClient<TClientContext>;
|
|
23
|
+
};
|
|
24
|
+
type InferClientContext<T extends NestedClient<any>> = T extends NestedClient<infer U> ? U : never;
|
|
25
|
+
interface ClientLink<TClientContext extends ClientContext> {
|
|
26
|
+
call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Recursively infers the **input types** from a client.
|
|
30
|
+
*
|
|
31
|
+
* Produces a nested map where each endpoint's input type is preserved.
|
|
32
|
+
*/
|
|
33
|
+
type InferClientInputs<T extends NestedClient<any>> = T extends Client<any, infer U, any, any> ? U : {
|
|
34
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientInputs<T[K]> : never;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* Recursively infers the **body input types** from a client.
|
|
38
|
+
*
|
|
39
|
+
* If an endpoint's input includes `{ body: ... }`, only the `body` portion is extracted.
|
|
40
|
+
* Produces a nested map of body input types.
|
|
41
|
+
*/
|
|
42
|
+
type InferClientBodyInputs<T extends NestedClient<any>> = T extends Client<any, infer U, any, any> ? U extends {
|
|
43
|
+
body: infer UBody;
|
|
44
|
+
} ? UBody : U : {
|
|
45
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientBodyInputs<T[K]> : never;
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Recursively infers the **output types** from a client.
|
|
49
|
+
*
|
|
50
|
+
* Produces a nested map where each endpoint's output type is preserved.
|
|
51
|
+
*/
|
|
52
|
+
type InferClientOutputs<T extends NestedClient<any>> = T extends Client<any, any, infer U, any> ? U : {
|
|
53
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientOutputs<T[K]> : never;
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* Recursively infers the **body output types** from a client.
|
|
57
|
+
*
|
|
58
|
+
* If an endpoint's output includes `{ body: ... }`, only the `body` portion is extracted.
|
|
59
|
+
* Produces a nested map of body output types.
|
|
60
|
+
*/
|
|
61
|
+
type InferClientBodyOutputs<T extends NestedClient<any>> = T extends Client<any, any, infer U, any> ? U extends {
|
|
62
|
+
body: infer UBody;
|
|
63
|
+
} ? UBody : U : {
|
|
64
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientBodyOutputs<T[K]> : never;
|
|
65
|
+
};
|
|
66
|
+
/**
|
|
67
|
+
* Recursively infers the **error types** from a client when you use [type-safe errors](https://orpc.unnoq.com/docs/error-handling#type‐safe-error-handling).
|
|
68
|
+
*
|
|
69
|
+
* Produces a nested map where each endpoint's error type is preserved.
|
|
70
|
+
*/
|
|
71
|
+
type InferClientErrors<T extends NestedClient<any>> = T extends Client<any, any, any, infer U> ? U : {
|
|
72
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientErrors<T[K]> : never;
|
|
73
|
+
};
|
|
74
|
+
/**
|
|
75
|
+
* Recursively infers a **union of all error types** from a client when you use [type-safe errors](https://orpc.unnoq.com/docs/error-handling#type‐safe-error-handling).
|
|
76
|
+
*
|
|
77
|
+
* Useful when you want to handle all possible errors from any endpoint at once.
|
|
78
|
+
*/
|
|
79
|
+
type InferClientErrorUnion<T extends NestedClient<any>> = T extends Client<any, any, any, infer U> ? U : {
|
|
80
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientErrorUnion<T[K]> : never;
|
|
81
|
+
}[keyof T];
|
|
82
|
+
|
|
83
|
+
export type { ClientLink as C, FriendlyClientOptions as F, HTTPPath as H, InferClientContext as I, NestedClient as N, ClientPromiseResult as a, ClientContext as b, ClientOptions as c, Client as d, ClientRest as e, HTTPMethod as f, InferClientInputs as g, InferClientBodyInputs as h, InferClientOutputs as i, InferClientBodyOutputs as j, InferClientErrors as k, InferClientErrorUnion as l };
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { PromiseWithError } from '@orpc/shared';
|
|
2
|
+
|
|
3
|
+
type HTTPPath = `/${string}`;
|
|
4
|
+
type HTTPMethod = 'HEAD' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
5
|
+
type ClientContext = Record<PropertyKey, any>;
|
|
6
|
+
interface ClientOptions<T extends ClientContext> {
|
|
7
|
+
signal?: AbortSignal;
|
|
8
|
+
lastEventId?: string | undefined;
|
|
9
|
+
context: T;
|
|
10
|
+
}
|
|
11
|
+
type FriendlyClientOptions<T extends ClientContext> = Omit<ClientOptions<T>, 'context'> & (Record<never, never> extends T ? {
|
|
12
|
+
context?: T;
|
|
13
|
+
} : {
|
|
14
|
+
context: T;
|
|
15
|
+
});
|
|
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>];
|
|
17
|
+
type ClientPromiseResult<TOutput, TError> = PromiseWithError<TOutput, TError>;
|
|
18
|
+
interface Client<TClientContext extends ClientContext, TInput, TOutput, TError> {
|
|
19
|
+
(...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
|
|
20
|
+
}
|
|
21
|
+
type NestedClient<TClientContext extends ClientContext> = Client<TClientContext, any, any, any> | {
|
|
22
|
+
[k: string]: NestedClient<TClientContext>;
|
|
23
|
+
};
|
|
24
|
+
type InferClientContext<T extends NestedClient<any>> = T extends NestedClient<infer U> ? U : never;
|
|
25
|
+
interface ClientLink<TClientContext extends ClientContext> {
|
|
26
|
+
call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Recursively infers the **input types** from a client.
|
|
30
|
+
*
|
|
31
|
+
* Produces a nested map where each endpoint's input type is preserved.
|
|
32
|
+
*/
|
|
33
|
+
type InferClientInputs<T extends NestedClient<any>> = T extends Client<any, infer U, any, any> ? U : {
|
|
34
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientInputs<T[K]> : never;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* Recursively infers the **body input types** from a client.
|
|
38
|
+
*
|
|
39
|
+
* If an endpoint's input includes `{ body: ... }`, only the `body` portion is extracted.
|
|
40
|
+
* Produces a nested map of body input types.
|
|
41
|
+
*/
|
|
42
|
+
type InferClientBodyInputs<T extends NestedClient<any>> = T extends Client<any, infer U, any, any> ? U extends {
|
|
43
|
+
body: infer UBody;
|
|
44
|
+
} ? UBody : U : {
|
|
45
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientBodyInputs<T[K]> : never;
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Recursively infers the **output types** from a client.
|
|
49
|
+
*
|
|
50
|
+
* Produces a nested map where each endpoint's output type is preserved.
|
|
51
|
+
*/
|
|
52
|
+
type InferClientOutputs<T extends NestedClient<any>> = T extends Client<any, any, infer U, any> ? U : {
|
|
53
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientOutputs<T[K]> : never;
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* Recursively infers the **body output types** from a client.
|
|
57
|
+
*
|
|
58
|
+
* If an endpoint's output includes `{ body: ... }`, only the `body` portion is extracted.
|
|
59
|
+
* Produces a nested map of body output types.
|
|
60
|
+
*/
|
|
61
|
+
type InferClientBodyOutputs<T extends NestedClient<any>> = T extends Client<any, any, infer U, any> ? U extends {
|
|
62
|
+
body: infer UBody;
|
|
63
|
+
} ? UBody : U : {
|
|
64
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientBodyOutputs<T[K]> : never;
|
|
65
|
+
};
|
|
66
|
+
/**
|
|
67
|
+
* Recursively infers the **error types** from a client when you use [type-safe errors](https://orpc.unnoq.com/docs/error-handling#type‐safe-error-handling).
|
|
68
|
+
*
|
|
69
|
+
* Produces a nested map where each endpoint's error type is preserved.
|
|
70
|
+
*/
|
|
71
|
+
type InferClientErrors<T extends NestedClient<any>> = T extends Client<any, any, any, infer U> ? U : {
|
|
72
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientErrors<T[K]> : never;
|
|
73
|
+
};
|
|
74
|
+
/**
|
|
75
|
+
* Recursively infers a **union of all error types** from a client when you use [type-safe errors](https://orpc.unnoq.com/docs/error-handling#type‐safe-error-handling).
|
|
76
|
+
*
|
|
77
|
+
* Useful when you want to handle all possible errors from any endpoint at once.
|
|
78
|
+
*/
|
|
79
|
+
type InferClientErrorUnion<T extends NestedClient<any>> = T extends Client<any, any, any, infer U> ? U : {
|
|
80
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? InferClientErrorUnion<T[K]> : never;
|
|
81
|
+
}[keyof T];
|
|
82
|
+
|
|
83
|
+
export type { ClientLink as C, FriendlyClientOptions as F, HTTPPath as H, InferClientContext as I, NestedClient as N, ClientPromiseResult as a, ClientContext as b, ClientOptions as c, Client as d, ClientRest as e, HTTPMethod as f, InferClientInputs as g, InferClientBodyInputs as h, InferClientOutputs as i, InferClientBodyOutputs as j, InferClientErrors as k, InferClientErrorUnion as l };
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.
|
|
3
|
-
import { Segment, Value } from '@orpc/shared';
|
|
1
|
+
import { b as ClientContext, c as ClientOptions, f as HTTPMethod } from './client.BH1AYT_p.js';
|
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.De8SW4Kw.js';
|
|
3
|
+
import { Segment, Value, Promisable } from '@orpc/shared';
|
|
4
4
|
import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
5
5
|
|
|
6
6
|
declare const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES: {
|
|
@@ -44,19 +44,19 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
|
|
44
44
|
/**
|
|
45
45
|
* Base url for all requests.
|
|
46
46
|
*/
|
|
47
|
-
url: Value<string | URL
|
|
47
|
+
url: Value<Promisable<string | URL>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
|
48
48
|
/**
|
|
49
49
|
* The maximum length of the URL.
|
|
50
50
|
*
|
|
51
51
|
* @default 2083
|
|
52
52
|
*/
|
|
53
|
-
maxUrlLength?: Value<number
|
|
53
|
+
maxUrlLength?: Value<Promisable<number>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
|
54
54
|
/**
|
|
55
55
|
* The method used to make the request.
|
|
56
56
|
*
|
|
57
57
|
* @default 'POST'
|
|
58
58
|
*/
|
|
59
|
-
method?: Value<Exclude<HTTPMethod, 'HEAD'
|
|
59
|
+
method?: Value<Promisable<Exclude<HTTPMethod, 'HEAD'>>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
|
60
60
|
/**
|
|
61
61
|
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
|
62
62
|
* GET is not allowed, it's very dangerous.
|
|
@@ -67,7 +67,7 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
|
|
67
67
|
/**
|
|
68
68
|
* Inject headers to the request.
|
|
69
69
|
*/
|
|
70
|
-
headers?: Value<StandardHeaders
|
|
70
|
+
headers?: Value<Promisable<StandardHeaders | Headers>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
|
71
71
|
}
|
|
72
72
|
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
|
73
73
|
private readonly serializer;
|