@orpc/client 0.0.0-next.4fc998d → 0.0.0-next.54ba24c

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,48 +1,25 @@
1
- import { intercept, isAsyncIteratorObject, value, isObject, trim, stringifyJSON } from '@orpc/shared';
2
- import { c as createAutoRetryEventIterator, O as ORPCError, m as mapEventIterator, t as toORPCError } from './client.XAn8cDTM.mjs';
3
- import { ErrorEvent } from '@orpc/standard-server';
1
+ import { toArray, intercept, isObject, value, isAsyncIteratorObject, stringifyJSON } from '@orpc/shared';
2
+ import { mergeStandardHeaders, ErrorEvent } from '@orpc/standard-server';
3
+ import { b as isORPCErrorStatus, O as ORPCError, m as mapEventIterator, t as toORPCError } from './client.jKEwIsRd.mjs';
4
4
 
5
5
  class InvalidEventIteratorRetryResponse extends Error {
6
6
  }
7
7
  class StandardLink {
8
- constructor(codec, sender, options) {
8
+ constructor(codec, sender, options = {}) {
9
9
  this.codec = codec;
10
10
  this.sender = sender;
11
- this.eventIteratorMaxRetries = options.eventIteratorMaxRetries ?? 5;
12
- this.eventIteratorRetryDelay = options.eventIteratorRetryDelay ?? ((o) => o.lastRetry ?? 1e3 * 2 ** o.retryTimes);
13
- this.eventIteratorShouldRetry = options.eventIteratorShouldRetry ?? true;
14
- this.interceptors = options.interceptors ?? [];
15
- this.clientInterceptors = options.clientInterceptors ?? [];
11
+ for (const plugin of toArray(options.plugins)) {
12
+ plugin.init?.(options);
13
+ }
14
+ this.interceptors = toArray(options.interceptors);
15
+ this.clientInterceptors = toArray(options.clientInterceptors);
16
16
  }
17
- eventIteratorMaxRetries;
18
- eventIteratorRetryDelay;
19
- eventIteratorShouldRetry;
20
17
  interceptors;
21
18
  clientInterceptors;
22
19
  call(path, input, options) {
23
20
  return intercept(this.interceptors, { path, input, options }, async ({ path: path2, input: input2, options: options2 }) => {
24
21
  const output = await this.#call(path2, input2, options2);
25
- if (!isAsyncIteratorObject(output)) {
26
- return output;
27
- }
28
- return createAutoRetryEventIterator(output, async (reconnectOptions) => {
29
- const maxRetries = await value(this.eventIteratorMaxRetries, reconnectOptions, options2, path2, input2);
30
- if (options2.signal?.aborted || reconnectOptions.retryTimes > maxRetries) {
31
- return null;
32
- }
33
- const shouldRetry = await value(this.eventIteratorShouldRetry, reconnectOptions, options2, path2, input2);
34
- if (!shouldRetry) {
35
- return null;
36
- }
37
- const retryDelay = await value(this.eventIteratorRetryDelay, reconnectOptions, options2, path2, input2);
38
- await new Promise((resolve) => setTimeout(resolve, retryDelay));
39
- const updatedOptions = { ...options2, lastEventId: reconnectOptions.lastEventId };
40
- const maybeIterator = await this.#call(path2, input2, updatedOptions);
41
- if (!isAsyncIteratorObject(maybeIterator)) {
42
- throw new InvalidEventIteratorRetryResponse("Invalid Event Iterator retry response");
43
- }
44
- return maybeIterator;
45
- }, options2.lastEventId);
22
+ return output;
46
23
  });
47
24
  }
48
25
  async #call(path, input, options) {
@@ -134,6 +111,9 @@ class StandardRPCJsonSerializer {
134
111
  if (isObject(data)) {
135
112
  const json = {};
136
113
  for (const k in data) {
114
+ if (k === "toJSON" && typeof data[k] === "function") {
115
+ continue;
116
+ }
137
117
  json[k] = this.serialize(data[k], [...segments, k], meta, maps, blobs)[0];
138
118
  }
139
119
  return [json, meta, maps, blobs];
@@ -200,6 +180,10 @@ class StandardRPCJsonSerializer {
200
180
  }
201
181
  }
202
182
 
183
+ function toHttpPath(path) {
184
+ return `/${path.map(encodeURIComponent).join("/")}`;
185
+ }
186
+
203
187
  class StandardRPCLinkCodec {
204
188
  constructor(serializer, options) {
205
189
  this.serializer = serializer;
@@ -216,14 +200,17 @@ class StandardRPCLinkCodec {
216
200
  headers;
217
201
  async encode(path, input, options) {
218
202
  const expectedMethod = await value(this.expectedMethod, options, path, input);
219
- const headers = await value(this.headers, options, path, input);
203
+ let headers = await value(this.headers, options, path, input);
220
204
  const baseUrl = await value(this.baseUrl, options, path, input);
221
- const url = new URL(`${trim(baseUrl.toString(), "/")}/${path.map(encodeURIComponent).join("/")}`);
205
+ const url = new URL(`${baseUrl.toString().replace(/\/$/, "")}${toHttpPath(path)}`);
206
+ if (options.lastEventId !== void 0) {
207
+ headers = mergeStandardHeaders(headers, { "last-event-id": options.lastEventId });
208
+ }
222
209
  const serialized = this.serializer.serialize(input);
223
- if (expectedMethod === "GET" && !(serialized instanceof FormData) && !(serialized instanceof Blob) && !isAsyncIteratorObject(serialized)) {
210
+ if (expectedMethod === "GET" && !(serialized instanceof FormData) && !isAsyncIteratorObject(serialized)) {
224
211
  const maxUrlLength = await value(this.maxUrlLength, options, path, input);
225
212
  const getUrl = new URL(url);
226
- getUrl.searchParams.append("data", stringifyJSON(serialized) ?? "");
213
+ getUrl.searchParams.append("data", stringifyJSON(serialized));
227
214
  if (getUrl.toString().length <= maxUrlLength) {
228
215
  return {
229
216
  body: void 0,
@@ -243,7 +230,7 @@ class StandardRPCLinkCodec {
243
230
  };
244
231
  }
245
232
  async decode(response) {
246
- const isOk = response.status >= 200 && response.status < 300;
233
+ const isOk = !isORPCErrorStatus(response.status);
247
234
  const deserialized = await (async () => {
248
235
  let isBodyOk = false;
249
236
  try {
@@ -265,8 +252,9 @@ class StandardRPCLinkCodec {
265
252
  if (ORPCError.isValidJSON(deserialized)) {
266
253
  throw ORPCError.fromJSON(deserialized);
267
254
  }
268
- throw new Error("Invalid RPC error response format.", {
269
- cause: deserialized
255
+ throw new ORPCError("MALFORMED_ORPC_ERROR_RESPONSE", {
256
+ status: response.status,
257
+ data: deserialized
270
258
  });
271
259
  }
272
260
  return deserialized;
@@ -292,9 +280,6 @@ class StandardRPCSerializer {
292
280
  return this.#serialize(data, true);
293
281
  }
294
282
  #serialize(data, enableFormData) {
295
- if (data === void 0 || data instanceof Blob) {
296
- return data;
297
- }
298
283
  const [json, meta_, maps, blobs] = this.jsonSerializer.serialize(data);
299
284
  const meta = meta_.length === 0 ? void 0 : meta_;
300
285
  if (!enableFormData || blobs.length === 0) {
@@ -332,9 +317,6 @@ class StandardRPCSerializer {
332
317
  return this.#deserialize(data);
333
318
  }
334
319
  #deserialize(data) {
335
- if (data === void 0 || data instanceof Blob) {
336
- return data;
337
- }
338
320
  if (!(data instanceof FormData)) {
339
321
  return this.jsonSerializer.deserialize(data.json, data.meta ?? []);
340
322
  }
@@ -348,4 +330,4 @@ class StandardRPCSerializer {
348
330
  }
349
331
  }
350
332
 
351
- export { InvalidEventIteratorRetryResponse as I, StandardLink as S, STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as a, StandardRPCJsonSerializer as b, StandardRPCLinkCodec as c, StandardRPCSerializer as d };
333
+ export { InvalidEventIteratorRetryResponse as I, StandardLink as S, STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as a, StandardRPCJsonSerializer as b, StandardRPCLinkCodec as c, StandardRPCSerializer as d, toHttpPath as t };
@@ -0,0 +1,39 @@
1
+ import { Interceptor } from '@orpc/shared';
2
+ import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
3
+ import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.87WXDX8t.mjs';
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
+ }
12
+
13
+ declare class InvalidEventIteratorRetryResponse extends Error {
14
+ }
15
+ interface StandardLinkPlugin<T extends ClientContext> {
16
+ init?(options: StandardLinkOptions<T>): void;
17
+ }
18
+ interface StandardLinkOptions<T extends ClientContext> {
19
+ interceptors?: Interceptor<{
20
+ path: readonly string[];
21
+ input: unknown;
22
+ options: ClientOptions<T>;
23
+ }, unknown, unknown>[];
24
+ clientInterceptors?: Interceptor<{
25
+ request: StandardRequest;
26
+ }, StandardLazyResponse, unknown>[];
27
+ plugins?: StandardLinkPlugin<T>[];
28
+ }
29
+ declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
30
+ #private;
31
+ readonly codec: StandardLinkCodec<T>;
32
+ readonly sender: StandardLinkClient<T>;
33
+ private readonly interceptors;
34
+ private readonly clientInterceptors;
35
+ constructor(codec: StandardLinkCodec<T>, sender: StandardLinkClient<T>, options?: StandardLinkOptions<T>);
36
+ call(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<unknown>;
37
+ }
38
+
39
+ export { InvalidEventIteratorRetryResponse as I, type StandardLinkPlugin as S, type StandardLinkOptions as a, StandardLink as b, type StandardLinkCodec as c, type StandardLinkClient as d };
@@ -1,4 +1,4 @@
1
- import { isObject, isTypescriptObject, retry } from '@orpc/shared';
1
+ import { isObject, isTypescriptObject } from '@orpc/shared';
2
2
  import { getEventMeta, withEventMeta } from '@orpc/standard-server';
3
3
 
4
4
  const COMMON_ORPC_ERROR_DEFS = {
@@ -91,8 +91,8 @@ class ORPCError extends Error {
91
91
  status;
92
92
  data;
93
93
  constructor(code, ...[options]) {
94
- if (options?.status && (options.status < 400 || options.status >= 600)) {
95
- throw new Error("[ORPCError] The error status code must be in the 400-599 range.");
94
+ if (options?.status && !isORPCErrorStatus(options.status)) {
95
+ throw new Error("[ORPCError] Invalid error status code.");
96
96
  }
97
97
  const message = fallbackORPCErrorMessage(code, options?.message);
98
98
  super(message, options);
@@ -136,33 +136,8 @@ function toORPCError(error) {
136
136
  cause: error
137
137
  });
138
138
  }
139
-
140
- const iteratorStates = /* @__PURE__ */ new WeakMap();
141
- function registerEventIteratorState(iterator, state) {
142
- iteratorStates.set(iterator, state);
143
- }
144
- function updateEventIteratorStatus(state, status) {
145
- if (state.status !== status) {
146
- state.status = status;
147
- state.listeners.forEach((cb) => cb(status));
148
- }
149
- }
150
- function onEventIteratorStatusChange(iterator, callback, options = {}) {
151
- const notifyImmediately = options.notifyImmediately ?? true;
152
- const state = iteratorStates.get(iterator);
153
- if (!state) {
154
- throw new Error("Iterator is not registered.");
155
- }
156
- if (notifyImmediately) {
157
- callback(state.status);
158
- }
159
- state.listeners.push(callback);
160
- return () => {
161
- const index = state.listeners.indexOf(callback);
162
- if (index !== -1) {
163
- state.listeners.splice(index, 1);
164
- }
165
- };
139
+ function isORPCErrorStatus(status) {
140
+ return status < 200 || status >= 400;
166
141
  }
167
142
 
168
143
  function mapEventIterator(iterator, maps) {
@@ -196,71 +171,5 @@ function mapEventIterator(iterator, maps) {
196
171
  }
197
172
  }();
198
173
  }
199
- const MAX_ALLOWED_RETRY_TIMES = 99;
200
- function createAutoRetryEventIterator(initial, reconnect, initialLastEventId) {
201
- const state = {
202
- status: "connected",
203
- listeners: []
204
- };
205
- const iterator = async function* () {
206
- let current = initial;
207
- let lastEventId = initialLastEventId;
208
- let lastRetry;
209
- let retryTimes = 0;
210
- try {
211
- while (true) {
212
- try {
213
- updateEventIteratorStatus(state, "connected");
214
- const { done, value } = await current.next();
215
- const meta = getEventMeta(value);
216
- lastEventId = meta?.id ?? lastEventId;
217
- lastRetry = meta?.retry ?? lastRetry;
218
- retryTimes = 0;
219
- if (done) {
220
- return value;
221
- }
222
- yield value;
223
- } catch (e) {
224
- updateEventIteratorStatus(state, "reconnecting");
225
- const meta = getEventMeta(e);
226
- lastEventId = meta?.id ?? lastEventId;
227
- lastRetry = meta?.retry ?? lastRetry;
228
- let currentError = e;
229
- current = await retry({ times: MAX_ALLOWED_RETRY_TIMES }, async (exit) => {
230
- retryTimes += 1;
231
- if (retryTimes > MAX_ALLOWED_RETRY_TIMES) {
232
- throw exit(new Error(
233
- `Exceeded maximum retry attempts (${MAX_ALLOWED_RETRY_TIMES}) for event iterator. Possible infinite retry loop detected. Please review the retry logic.`,
234
- { cause: currentError }
235
- ));
236
- }
237
- const reconnected = await (async () => {
238
- try {
239
- return await reconnect({
240
- lastRetry,
241
- lastEventId,
242
- retryTimes,
243
- error: currentError
244
- });
245
- } catch (e2) {
246
- currentError = e2;
247
- throw e2;
248
- }
249
- })();
250
- if (!reconnected) {
251
- throw exit(currentError);
252
- }
253
- return reconnected;
254
- });
255
- }
256
- }
257
- } finally {
258
- updateEventIteratorStatus(state, "closed");
259
- await current.return?.();
260
- }
261
- }();
262
- registerEventIteratorState(iterator, state);
263
- return iterator;
264
- }
265
174
 
266
- export { COMMON_ORPC_ERROR_DEFS as C, ORPCError as O, fallbackORPCErrorMessage as a, createAutoRetryEventIterator as c, fallbackORPCErrorStatus as f, isDefinedError as i, mapEventIterator as m, onEventIteratorStatusChange as o, registerEventIteratorState as r, toORPCError as t, updateEventIteratorStatus as u };
175
+ export { COMMON_ORPC_ERROR_DEFS as C, ORPCError as O, fallbackORPCErrorMessage as a, isORPCErrorStatus as b, fallbackORPCErrorStatus as f, isDefinedError as i, mapEventIterator as m, toORPCError as t };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/client",
3
3
  "type": "module",
4
- "version": "0.0.0-next.4fc998d",
4
+ "version": "0.0.0-next.54ba24c",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -19,6 +19,11 @@
19
19
  "import": "./dist/index.mjs",
20
20
  "default": "./dist/index.mjs"
21
21
  },
22
+ "./plugins": {
23
+ "types": "./dist/plugins/index.d.mts",
24
+ "import": "./dist/plugins/index.mjs",
25
+ "default": "./dist/plugins/index.mjs"
26
+ },
22
27
  "./standard": {
23
28
  "types": "./dist/adapters/standard/index.d.mts",
24
29
  "import": "./dist/adapters/standard/index.mjs",
@@ -34,9 +39,9 @@
34
39
  "dist"
35
40
  ],
36
41
  "dependencies": {
37
- "@orpc/shared": "0.0.0-next.4fc998d",
38
- "@orpc/standard-server": "0.0.0-next.4fc998d",
39
- "@orpc/standard-server-fetch": "0.0.0-next.4fc998d"
42
+ "@orpc/shared": "0.0.0-next.54ba24c",
43
+ "@orpc/standard-server": "0.0.0-next.54ba24c",
44
+ "@orpc/standard-server-fetch": "0.0.0-next.54ba24c"
40
45
  },
41
46
  "devDependencies": {
42
47
  "zod": "^3.24.2"
@@ -1,42 +0,0 @@
1
- type ClientContext = Record<string, any>;
2
- type ClientOptions<TClientContext extends ClientContext> = {
3
- signal?: AbortSignal;
4
- lastEventId?: string | undefined;
5
- } & (Record<never, never> extends TClientContext ? {
6
- context?: TClientContext;
7
- } : {
8
- context: TClientContext;
9
- });
10
- type ClientRest<TClientContext extends ClientContext, TInput> = Record<never, never> extends TClientContext ? undefined extends TInput ? [input?: TInput, options?: ClientOptions<TClientContext>] : [input: TInput, options?: ClientOptions<TClientContext>] : [input: TInput, options: ClientOptions<TClientContext>];
11
- type ClientPromiseResult<TOutput, TError extends Error> = Promise<TOutput> & {
12
- __error?: {
13
- type: TError;
14
- };
15
- };
16
- interface Client<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> {
17
- (...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
18
- }
19
- type NestedClient<TClientContext extends ClientContext> = Client<TClientContext, any, any, any> | {
20
- [k: string]: NestedClient<TClientContext>;
21
- };
22
- type InferClientContext<T extends NestedClient<any>> = T extends NestedClient<infer U> ? U : never;
23
- type ClientOptionsOut<TClientContext extends ClientContext> = ClientOptions<TClientContext> & {
24
- context: TClientContext;
25
- };
26
- interface ClientLink<TClientContext extends ClientContext> {
27
- call: (path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>) => Promise<unknown>;
28
- }
29
-
30
- declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
31
- value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
32
- error: (error: unknown) => Promise<unknown>;
33
- }): AsyncGenerator<TMap, TMap, TNext>;
34
- interface EventIteratorReconnectOptions {
35
- lastRetry: number | undefined;
36
- lastEventId: string | undefined;
37
- retryTimes: number;
38
- error: unknown;
39
- }
40
- declare function createAutoRetryEventIterator<TYield, TReturn>(initial: AsyncIterator<TYield, TReturn, void>, reconnect: (options: EventIteratorReconnectOptions) => Promise<AsyncIterator<TYield, TReturn, void> | null>, initialLastEventId: string | undefined): AsyncGenerator<TYield, TReturn, void>;
41
-
42
- export { type ClientContext as C, type EventIteratorReconnectOptions as E, type InferClientContext as I, type NestedClient as N, type ClientOptionsOut as a, type ClientLink as b, type ClientPromiseResult as c, createAutoRetryEventIterator as d, type ClientOptions as e, type ClientRest as f, type Client as g, mapEventIterator as m };
@@ -1,42 +0,0 @@
1
- type ClientContext = Record<string, any>;
2
- type ClientOptions<TClientContext extends ClientContext> = {
3
- signal?: AbortSignal;
4
- lastEventId?: string | undefined;
5
- } & (Record<never, never> extends TClientContext ? {
6
- context?: TClientContext;
7
- } : {
8
- context: TClientContext;
9
- });
10
- type ClientRest<TClientContext extends ClientContext, TInput> = Record<never, never> extends TClientContext ? undefined extends TInput ? [input?: TInput, options?: ClientOptions<TClientContext>] : [input: TInput, options?: ClientOptions<TClientContext>] : [input: TInput, options: ClientOptions<TClientContext>];
11
- type ClientPromiseResult<TOutput, TError extends Error> = Promise<TOutput> & {
12
- __error?: {
13
- type: TError;
14
- };
15
- };
16
- interface Client<TClientContext extends ClientContext, TInput, TOutput, TError extends Error> {
17
- (...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
18
- }
19
- type NestedClient<TClientContext extends ClientContext> = Client<TClientContext, any, any, any> | {
20
- [k: string]: NestedClient<TClientContext>;
21
- };
22
- type InferClientContext<T extends NestedClient<any>> = T extends NestedClient<infer U> ? U : never;
23
- type ClientOptionsOut<TClientContext extends ClientContext> = ClientOptions<TClientContext> & {
24
- context: TClientContext;
25
- };
26
- interface ClientLink<TClientContext extends ClientContext> {
27
- call: (path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>) => Promise<unknown>;
28
- }
29
-
30
- declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
31
- value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
32
- error: (error: unknown) => Promise<unknown>;
33
- }): AsyncGenerator<TMap, TMap, TNext>;
34
- interface EventIteratorReconnectOptions {
35
- lastRetry: number | undefined;
36
- lastEventId: string | undefined;
37
- retryTimes: number;
38
- error: unknown;
39
- }
40
- declare function createAutoRetryEventIterator<TYield, TReturn>(initial: AsyncIterator<TYield, TReturn, void>, reconnect: (options: EventIteratorReconnectOptions) => Promise<AsyncIterator<TYield, TReturn, void> | null>, initialLastEventId: string | undefined): AsyncGenerator<TYield, TReturn, void>;
41
-
42
- export { type ClientContext as C, type EventIteratorReconnectOptions as E, type InferClientContext as I, type NestedClient as N, type ClientOptionsOut as a, type ClientLink as b, type ClientPromiseResult as c, createAutoRetryEventIterator as d, type ClientOptions as e, type ClientRest as f, type Client as g, mapEventIterator as m };