@orpc/client 0.0.0-next.e98b833 → 0.0.0-next.ea0903c

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.
@@ -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,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';
1
+ import { toArray, intercept, isObject, value, isAsyncIteratorObject, stringifyJSON } from '@orpc/shared';
2
+ import { O as ORPCError, m as mapEventIterator, t as toORPCError } from './client.BacCdg3F.mjs';
3
3
  import { ErrorEvent } from '@orpc/standard-server';
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) {
@@ -57,50 +34,74 @@ class StandardLink {
57
34
  }
58
35
  }
59
36
 
60
- class RPCJsonSerializer {
37
+ const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES = {
38
+ BIGINT: 0,
39
+ DATE: 1,
40
+ NAN: 2,
41
+ UNDEFINED: 3,
42
+ URL: 4,
43
+ REGEXP: 5,
44
+ SET: 6,
45
+ MAP: 7
46
+ };
47
+ class StandardRPCJsonSerializer {
48
+ customSerializers;
49
+ constructor(options = {}) {
50
+ this.customSerializers = options.customJsonSerializers ?? [];
51
+ if (this.customSerializers.length !== new Set(this.customSerializers.map((custom) => custom.type)).size) {
52
+ throw new Error("Custom serializer type must be unique.");
53
+ }
54
+ }
61
55
  serialize(data, segments = [], meta = [], maps = [], blobs = []) {
56
+ for (const custom of this.customSerializers) {
57
+ if (custom.condition(data)) {
58
+ const result = this.serialize(custom.serialize(data), segments, meta, maps, blobs);
59
+ meta.push([custom.type, ...segments]);
60
+ return result;
61
+ }
62
+ }
62
63
  if (data instanceof Blob) {
63
64
  maps.push(segments);
64
65
  blobs.push(data);
65
66
  return [data, meta, maps, blobs];
66
67
  }
67
68
  if (typeof data === "bigint") {
68
- meta.push([0, segments]);
69
+ meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.BIGINT, ...segments]);
69
70
  return [data.toString(), meta, maps, blobs];
70
71
  }
71
72
  if (data instanceof Date) {
72
- meta.push([1, segments]);
73
+ meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.DATE, ...segments]);
73
74
  if (Number.isNaN(data.getTime())) {
74
75
  return [null, meta, maps, blobs];
75
76
  }
76
77
  return [data.toISOString(), meta, maps, blobs];
77
78
  }
78
79
  if (Number.isNaN(data)) {
79
- meta.push([2, segments]);
80
+ meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.NAN, ...segments]);
80
81
  return [null, meta, maps, blobs];
81
82
  }
82
83
  if (data instanceof URL) {
83
- meta.push([4, segments]);
84
+ meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.URL, ...segments]);
84
85
  return [data.toString(), meta, maps, blobs];
85
86
  }
86
87
  if (data instanceof RegExp) {
87
- meta.push([5, segments]);
88
+ meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.REGEXP, ...segments]);
88
89
  return [data.toString(), meta, maps, blobs];
89
90
  }
90
91
  if (data instanceof Set) {
91
92
  const result = this.serialize(Array.from(data), segments, meta, maps, blobs);
92
- meta.push([6, segments]);
93
+ meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.SET, ...segments]);
93
94
  return result;
94
95
  }
95
96
  if (data instanceof Map) {
96
97
  const result = this.serialize(Array.from(data.entries()), segments, meta, maps, blobs);
97
- meta.push([7, segments]);
98
+ meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.MAP, ...segments]);
98
99
  return result;
99
100
  }
100
101
  if (Array.isArray(data)) {
101
102
  const json = data.map((v, i) => {
102
103
  if (v === void 0) {
103
- meta.push([3, [...segments, i]]);
104
+ meta.push([STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.UNDEFINED, ...segments, i]);
104
105
  return v;
105
106
  }
106
107
  return this.serialize(v, [...segments, i], meta, maps, blobs)[0];
@@ -110,6 +111,9 @@ class RPCJsonSerializer {
110
111
  if (isObject(data)) {
111
112
  const json = {};
112
113
  for (const k in data) {
114
+ if (k === "toJSON" && typeof data[k] === "function") {
115
+ continue;
116
+ }
113
117
  json[k] = this.serialize(data[k], [...segments, k], meta, maps, blobs)[0];
114
118
  }
115
119
  return [json, meta, maps, blobs];
@@ -129,38 +133,45 @@ class RPCJsonSerializer {
129
133
  currentRef[preSegment] = getBlob(i);
130
134
  });
131
135
  }
132
- for (const [type, segments] of meta) {
136
+ for (const item of meta) {
137
+ const type = item[0];
133
138
  let currentRef = ref;
134
139
  let preSegment = "data";
135
- segments.forEach((segment) => {
140
+ for (let i = 1; i < item.length; i++) {
136
141
  currentRef = currentRef[preSegment];
137
- preSegment = segment;
138
- });
142
+ preSegment = item[i];
143
+ }
144
+ for (const custom of this.customSerializers) {
145
+ if (custom.type === type) {
146
+ currentRef[preSegment] = custom.deserialize(currentRef[preSegment]);
147
+ break;
148
+ }
149
+ }
139
150
  switch (type) {
140
- case 0:
151
+ case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.BIGINT:
141
152
  currentRef[preSegment] = BigInt(currentRef[preSegment]);
142
153
  break;
143
- case 1:
154
+ case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.DATE:
144
155
  currentRef[preSegment] = new Date(currentRef[preSegment] ?? "Invalid Date");
145
156
  break;
146
- case 2:
157
+ case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.NAN:
147
158
  currentRef[preSegment] = Number.NaN;
148
159
  break;
149
- case 3:
160
+ case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.UNDEFINED:
150
161
  currentRef[preSegment] = void 0;
151
162
  break;
152
- case 4:
163
+ case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.URL:
153
164
  currentRef[preSegment] = new URL(currentRef[preSegment]);
154
165
  break;
155
- case 5: {
166
+ case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.REGEXP: {
156
167
  const [, pattern, flags] = currentRef[preSegment].match(/^\/(.*)\/([a-z]*)$/);
157
168
  currentRef[preSegment] = new RegExp(pattern, flags);
158
169
  break;
159
170
  }
160
- case 6:
171
+ case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.SET:
161
172
  currentRef[preSegment] = new Set(currentRef[preSegment]);
162
173
  break;
163
- case 7:
174
+ case STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES.MAP:
164
175
  currentRef[preSegment] = new Map(currentRef[preSegment]);
165
176
  break;
166
177
  }
@@ -169,6 +180,10 @@ class RPCJsonSerializer {
169
180
  }
170
181
  }
171
182
 
183
+ function toHttpPath(path) {
184
+ return `/${path.map(encodeURIComponent).join("/")}`;
185
+ }
186
+
172
187
  class StandardRPCLinkCodec {
173
188
  constructor(serializer, options) {
174
189
  this.serializer = serializer;
@@ -185,14 +200,23 @@ class StandardRPCLinkCodec {
185
200
  headers;
186
201
  async encode(path, input, options) {
187
202
  const expectedMethod = await value(this.expectedMethod, options, path, input);
188
- const headers = await value(this.headers, options, path, input);
203
+ const headers = { ...await value(this.headers, options, path, input) };
189
204
  const baseUrl = await value(this.baseUrl, options, path, input);
190
- 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
+ if (Array.isArray(headers["last-event-id"])) {
208
+ headers["last-event-id"] = [...headers["last-event-id"], options.lastEventId];
209
+ } else if (headers["last-event-id"] !== void 0) {
210
+ headers["last-event-id"] = [headers["last-event-id"], options.lastEventId];
211
+ } else {
212
+ headers["last-event-id"] = options.lastEventId;
213
+ }
214
+ }
191
215
  const serialized = this.serializer.serialize(input);
192
- if (expectedMethod === "GET" && !(serialized instanceof FormData) && !(serialized instanceof Blob) && !isAsyncIteratorObject(serialized)) {
216
+ if (expectedMethod === "GET" && !(serialized instanceof FormData) && !isAsyncIteratorObject(serialized)) {
193
217
  const maxUrlLength = await value(this.maxUrlLength, options, path, input);
194
218
  const getUrl = new URL(url);
195
- getUrl.searchParams.append("data", stringifyJSON(serialized) ?? "");
219
+ getUrl.searchParams.append("data", stringifyJSON(serialized));
196
220
  if (getUrl.toString().length <= maxUrlLength) {
197
221
  return {
198
222
  body: void 0,
@@ -242,8 +266,8 @@ class StandardRPCLinkCodec {
242
266
  }
243
267
  }
244
268
 
245
- class RPCSerializer {
246
- constructor(jsonSerializer = new RPCJsonSerializer()) {
269
+ class StandardRPCSerializer {
270
+ constructor(jsonSerializer) {
247
271
  this.jsonSerializer = jsonSerializer;
248
272
  }
249
273
  serialize(data) {
@@ -261,9 +285,6 @@ class RPCSerializer {
261
285
  return this.#serialize(data, true);
262
286
  }
263
287
  #serialize(data, enableFormData) {
264
- if (data === void 0 || data instanceof Blob) {
265
- return data;
266
- }
267
288
  const [json, meta_, maps, blobs] = this.jsonSerializer.serialize(data);
268
289
  const meta = meta_.length === 0 ? void 0 : meta_;
269
290
  if (!enableFormData || blobs.length === 0) {
@@ -301,9 +322,6 @@ class RPCSerializer {
301
322
  return this.#deserialize(data);
302
323
  }
303
324
  #deserialize(data) {
304
- if (data === void 0 || data instanceof Blob) {
305
- return data;
306
- }
307
325
  if (!(data instanceof FormData)) {
308
326
  return this.jsonSerializer.deserialize(data.json, data.meta ?? []);
309
327
  }
@@ -317,4 +335,4 @@ class RPCSerializer {
317
335
  }
318
336
  }
319
337
 
320
- export { InvalidEventIteratorRetryResponse as I, RPCJsonSerializer as R, StandardLink as S, StandardRPCLinkCodec as a, RPCSerializer as b };
338
+ 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 };
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.e98b833",
4
+ "version": "0.0.0-next.ea0903c",
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.e98b833",
38
- "@orpc/standard-server-fetch": "0.0.0-next.e98b833",
39
- "@orpc/standard-server": "0.0.0-next.e98b833"
42
+ "@orpc/shared": "0.0.0-next.ea0903c",
43
+ "@orpc/standard-server-fetch": "0.0.0-next.ea0903c",
44
+ "@orpc/standard-server": "0.0.0-next.ea0903c"
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 };