@orpc/client 0.0.0-next.dcc6c29 → 0.0.0-next.dd705fc

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.
@@ -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 { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.FvDtk0Vr.js';
4
- import { a as ClientContext } from '../shared/client.CipPQkhk.js';
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.BG98rYdO.js';
5
+ import { b as ClientContext } from '../shared/client.BOYsZIRq.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, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
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, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
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, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
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, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
44
+ headers?: Value<Promisable<StandardHeaders>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
38
45
  /**
39
46
  * Map the batch request items before sending them.
40
47
  *
@@ -51,6 +58,12 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
51
58
  */
52
59
  exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
53
60
  }
61
+ /**
62
+ * The Batch Requests Plugin allows you to combine multiple requests and responses into a single batch,
63
+ * reducing the overhead of sending each one separately.
64
+ *
65
+ * @see {@link https://orpc.unnoq.com/docs/plugins/batch-requests Batch Requests Plugin Docs}
66
+ */
54
67
  declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
55
68
  #private;
56
69
  private readonly groups;
@@ -60,9 +73,42 @@ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPl
60
73
  private readonly batchHeaders;
61
74
  private readonly mapRequestItem;
62
75
  private readonly exclude;
76
+ private readonly mode;
63
77
  private pending;
64
78
  order: number;
65
- constructor(options: BatchLinkPluginOptions<T>);
79
+ constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
80
+ init(options: StandardLinkOptions<T>): void;
81
+ }
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>>);
66
112
  init(options: StandardLinkOptions<T>): void;
67
113
  }
68
114
 
@@ -78,29 +124,34 @@ interface ClientRetryPluginContext {
78
124
  *
79
125
  * @default 0
80
126
  */
81
- retry?: Value<number, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
127
+ retry?: Value<Promisable<number>, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
82
128
  /**
83
129
  * Delay (in ms) before retrying.
84
130
  *
85
131
  * @default (o) => o.lastEventRetry ?? 2000
86
132
  */
87
- retryDelay?: Value<number, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
133
+ retryDelay?: Value<Promisable<number>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
88
134
  /**
89
135
  * Determine should retry or not.
90
136
  *
91
137
  * @default true
92
138
  */
93
- shouldRetry?: Value<boolean, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
139
+ shouldRetry?: Value<Promisable<boolean>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
94
140
  /**
95
141
  * The hook called when retrying, and return the unsubscribe function.
96
142
  */
97
- onRetry?: (options: ClientRetryPluginAttemptOptions<ClientRetryPluginContext>) => void | (() => void);
143
+ onRetry?: (options: ClientRetryPluginAttemptOptions<ClientRetryPluginContext>) => void | ((isSuccess: boolean) => void);
98
144
  }
99
145
  declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
100
146
  }
101
147
  interface ClientRetryPluginOptions {
102
148
  default?: ClientRetryPluginContext;
103
149
  }
150
+ /**
151
+ * The Client Retry Plugin enables retrying client calls when errors occur.
152
+ *
153
+ * @see {@link https://orpc.unnoq.com/docs/plugins/client-retry Client Retry Plugin Docs}
154
+ */
104
155
  declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements StandardLinkPlugin<T> {
105
156
  private readonly defaultRetry;
106
157
  private readonly defaultRetryDelay;
@@ -116,21 +167,28 @@ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
116
167
  *
117
168
  * @default 'x-csrf-token'
118
169
  */
119
- headerName?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
170
+ headerName?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
120
171
  /**
121
172
  * The value of the header to check.
122
173
  *
123
174
  * @default 'orpc'
124
175
  *
125
176
  */
126
- headerValue?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
177
+ headerValue?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
127
178
  /**
128
179
  * Exclude a procedure from the plugin.
129
180
  *
130
181
  * @default false
131
182
  */
132
- exclude?: Value<boolean, [options: StandardLinkClientInterceptorOptions<T>]>;
183
+ exclude?: Value<Promisable<boolean>, [options: StandardLinkClientInterceptorOptions<T>]>;
133
184
  }
185
+ /**
186
+ * This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
187
+ * It helps ensure that requests to your procedures originate from JavaScript code,
188
+ * not from other sources like standard HTML forms or direct browser navigation.
189
+ *
190
+ * @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
191
+ */
134
192
  declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
135
193
  private readonly headerName;
136
194
  private readonly headerValue;
@@ -140,4 +198,5 @@ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements
140
198
  init(options: StandardLinkOptions<T>): void;
141
199
  }
142
200
 
143
- export { BatchLinkPlugin, type BatchLinkPluginGroup, type BatchLinkPluginOptions, ClientRetryPlugin, type ClientRetryPluginAttemptOptions, type ClientRetryPluginContext, ClientRetryPluginInvalidEventIteratorRetryResponse, type ClientRetryPluginOptions, SimpleCsrfProtectionLinkPlugin, type SimpleCsrfProtectionLinkPluginOptions };
201
+ export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };
202
+ export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, DedupeRequestsPluginGroup, DedupeRequestsPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
@@ -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, 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
- setTimeout(() => this.#processPendingBatches());
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 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) });
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 {
@@ -175,20 +284,20 @@ class ClientRetryPlugin {
175
284
  }
176
285
  let lastEventId = interceptorOptions.lastEventId;
177
286
  let lastEventRetry;
178
- let unsubscribe;
287
+ let callback;
179
288
  let attemptIndex = 0;
180
- const next = async (initial) => {
181
- let current = initial;
289
+ const next = async (initialError) => {
290
+ let currentError = initialError;
182
291
  while (true) {
183
292
  const updatedInterceptorOptions = { ...interceptorOptions, lastEventId };
184
- if (current) {
293
+ if (currentError) {
185
294
  if (attemptIndex >= maxAttempts) {
186
- throw current.error;
295
+ throw currentError.error;
187
296
  }
188
297
  const attemptOptions = {
189
298
  ...updatedInterceptorOptions,
190
299
  attemptIndex,
191
- error: current.error,
300
+ error: currentError.error,
192
301
  lastEventRetry
193
302
  };
194
303
  const shouldRetryBool = await value(
@@ -196,23 +305,24 @@ class ClientRetryPlugin {
196
305
  attemptOptions
197
306
  );
198
307
  if (!shouldRetryBool) {
199
- throw current.error;
308
+ throw currentError.error;
200
309
  }
201
- unsubscribe = onRetry?.(attemptOptions);
310
+ callback = onRetry?.(attemptOptions);
202
311
  const retryDelayMs = await value(retryDelay, attemptOptions);
203
312
  await new Promise((resolve) => setTimeout(resolve, retryDelayMs));
204
313
  attemptIndex++;
205
314
  }
206
315
  try {
316
+ currentError = void 0;
207
317
  return await interceptorOptions.next(updatedInterceptorOptions);
208
318
  } catch (error) {
209
- if (updatedInterceptorOptions.signal?.aborted === true) {
319
+ currentError = { error };
320
+ if (updatedInterceptorOptions.signal?.aborted) {
210
321
  throw error;
211
322
  }
212
- current = { error };
213
323
  } finally {
214
- unsubscribe?.();
215
- unsubscribe = void 0;
324
+ callback?.(!currentError);
325
+ callback = void 0;
216
326
  }
217
327
  }
218
328
  };
@@ -220,19 +330,17 @@ class ClientRetryPlugin {
220
330
  if (!isAsyncIteratorObject(output)) {
221
331
  return output;
222
332
  }
223
- return async function* () {
224
- let current = output;
225
- try {
333
+ let current = output;
334
+ let isIteratorAborted = false;
335
+ return new AsyncIteratorClass(
336
+ async () => {
226
337
  while (true) {
227
338
  try {
228
339
  const item = await current.next();
229
340
  const meta = getEventMeta(item.value);
230
341
  lastEventId = meta?.id ?? lastEventId;
231
342
  lastEventRetry = meta?.retry ?? lastEventRetry;
232
- if (item.done) {
233
- return item.value;
234
- }
235
- yield item.value;
343
+ return item;
236
344
  } catch (error) {
237
345
  const meta = getEventMeta(error);
238
346
  lastEventId = meta?.id ?? lastEventId;
@@ -244,12 +352,20 @@ class ClientRetryPlugin {
244
352
  );
245
353
  }
246
354
  current = maybeEventIterator;
355
+ if (isIteratorAborted) {
356
+ await current.return?.();
357
+ throw error;
358
+ }
247
359
  }
248
360
  }
249
- } finally {
250
- await current.return?.();
361
+ },
362
+ async (reason) => {
363
+ isIteratorAborted = true;
364
+ if (reason !== "next") {
365
+ await current.return?.();
366
+ }
251
367
  }
252
- }();
368
+ );
253
369
  });
254
370
  }
255
371
  }
@@ -287,4 +403,4 @@ class SimpleCsrfProtectionLinkPlugin {
287
403
  }
288
404
  }
289
405
 
290
- export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
406
+ export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };
@@ -1,14 +1,6 @@
1
- import { Interceptor, ThrowableError } from '@orpc/shared';
1
+ import { Interceptor } 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.CipPQkhk.js';
4
-
5
- interface StandardLinkCodec<T extends ClientContext> {
6
- encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
7
- decode(response: StandardLazyResponse, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<unknown>;
8
- }
9
- interface StandardLinkClient<T extends ClientContext> {
10
- call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
11
- }
3
+ import { b as ClientContext, c as ClientOptions, C as ClientLink } from './client.BOYsZIRq.js';
12
4
 
13
5
  interface StandardLinkPlugin<T extends ClientContext> {
14
6
  order?: number;
@@ -20,6 +12,14 @@ declare class CompositeStandardLinkPlugin<T extends ClientContext, TPlugin exten
20
12
  init(options: StandardLinkOptions<T>): void;
21
13
  }
22
14
 
15
+ interface StandardLinkCodec<T extends ClientContext> {
16
+ encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
17
+ decode(response: StandardLazyResponse, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<unknown>;
18
+ }
19
+ interface StandardLinkClient<T extends ClientContext> {
20
+ call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
21
+ }
22
+
23
23
  interface StandardLinkInterceptorOptions<T extends ClientContext> extends ClientOptions<T> {
24
24
  path: readonly string[];
25
25
  input: unknown;
@@ -28,12 +28,11 @@ interface StandardLinkClientInterceptorOptions<T extends ClientContext> extends
28
28
  request: StandardRequest;
29
29
  }
30
30
  interface StandardLinkOptions<T extends ClientContext> {
31
- interceptors?: Interceptor<StandardLinkInterceptorOptions<T>, unknown, ThrowableError>[];
32
- clientInterceptors?: Interceptor<StandardLinkClientInterceptorOptions<T>, StandardLazyResponse, ThrowableError>[];
31
+ interceptors?: Interceptor<StandardLinkInterceptorOptions<T>, Promise<unknown>>[];
32
+ clientInterceptors?: Interceptor<StandardLinkClientInterceptorOptions<T>, Promise<StandardLazyResponse>>[];
33
33
  plugins?: StandardLinkPlugin<T>[];
34
34
  }
35
35
  declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
36
- #private;
37
36
  readonly codec: StandardLinkCodec<T>;
38
37
  readonly sender: StandardLinkClient<T>;
39
38
  private readonly interceptors;
@@ -42,4 +41,5 @@ declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
42
41
  call(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<unknown>;
43
42
  }
44
43
 
45
- export { CompositeStandardLinkPlugin as C, type StandardLinkClientInterceptorOptions as S, type StandardLinkPlugin as a, type StandardLinkOptions as b, type StandardLinkInterceptorOptions as c, StandardLink as d, type StandardLinkCodec as e, type StandardLinkClient as f };
44
+ export { CompositeStandardLinkPlugin as C, StandardLink as d };
45
+ export type { StandardLinkClientInterceptorOptions as S, StandardLinkPlugin as a, StandardLinkOptions as b, StandardLinkInterceptorOptions as c, StandardLinkCodec as e, StandardLinkClient as f };
@@ -1,7 +1,7 @@
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;
@@ -26,4 +26,4 @@ interface ClientLink<TClientContext extends ClientContext> {
26
26
  call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
27
27
  }
28
28
 
29
- export type { ClientLink as C, FriendlyClientOptions as F, HTTPPath as H, InferClientContext as I, NestedClient as N, ClientContext as a, ClientOptions as b, ClientPromiseResult as c, HTTPMethod as d, ClientRest as e, Client as f };
29
+ 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 };
@@ -1,7 +1,7 @@
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;
@@ -26,4 +26,4 @@ interface ClientLink<TClientContext extends ClientContext> {
26
26
  call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
27
27
  }
28
28
 
29
- export type { ClientLink as C, FriendlyClientOptions as F, HTTPPath as H, InferClientContext as I, NestedClient as N, ClientContext as a, ClientOptions as b, ClientPromiseResult as c, HTTPMethod as d, ClientRest as e, Client as f };
29
+ 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 };