@orpc/client 0.0.0-next.d1f8ea3 → 0.0.0-next.d31094d

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.
Files changed (28) hide show
  1. package/README.md +18 -22
  2. package/dist/adapters/fetch/index.d.mts +12 -5
  3. package/dist/adapters/fetch/index.d.ts +12 -5
  4. package/dist/adapters/fetch/index.mjs +5 -8
  5. package/dist/adapters/message-port/index.d.mts +59 -0
  6. package/dist/adapters/message-port/index.d.ts +59 -0
  7. package/dist/adapters/message-port/index.mjs +71 -0
  8. package/dist/adapters/standard/index.d.mts +5 -4
  9. package/dist/adapters/standard/index.d.ts +5 -4
  10. package/dist/adapters/standard/index.mjs +2 -2
  11. package/dist/adapters/websocket/index.d.mts +29 -0
  12. package/dist/adapters/websocket/index.d.ts +29 -0
  13. package/dist/adapters/websocket/index.mjs +45 -0
  14. package/dist/index.d.mts +59 -29
  15. package/dist/index.d.ts +59 -29
  16. package/dist/index.mjs +27 -10
  17. package/dist/plugins/index.d.mts +162 -21
  18. package/dist/plugins/index.d.ts +162 -21
  19. package/dist/plugins/index.mjs +317 -43
  20. package/dist/shared/{client.DZhZ5QON.d.ts → client.BG98rYdO.d.ts} +21 -15
  21. package/dist/shared/{client.3Fsj0tpH.d.mts → client.BOYsZIRq.d.mts} +9 -10
  22. package/dist/shared/{client.3Fsj0tpH.d.ts → client.BOYsZIRq.d.ts} +9 -10
  23. package/dist/shared/{client.Dpozrd9X.d.mts → client.Bwgm6dgk.d.mts} +21 -15
  24. package/dist/shared/{client.CQMGo-9I.d.ts → client.C176log5.d.ts} +13 -25
  25. package/dist/shared/{client.D77bw0hs.mjs → client.DKmRtVO2.mjs} +84 -27
  26. package/dist/shared/{client.D0qRuwQp.d.mts → client.Ycwr4Tuo.d.mts} +13 -25
  27. package/dist/shared/{client.jKEwIsRd.mjs → client.txdq_i5V.mjs} +54 -49
  28. package/package.json +16 -5
@@ -1,36 +1,77 @@
1
- import { toArray, intercept, isObject, value, isAsyncIteratorObject, stringifyJSON } from '@orpc/shared';
1
+ import { toArray, runWithSpan, ORPC_NAME, isAsyncIteratorObject, asyncIteratorWithSpan, intercept, getGlobalOtelConfig, isObject, value, stringifyJSON } from '@orpc/shared';
2
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';
3
+ import { C as COMMON_ORPC_ERROR_DEFS, b as isORPCErrorStatus, c as isORPCErrorJson, d as createORPCErrorFromJson, O as ORPCError, m as mapEventIterator, t as toORPCError } from './client.txdq_i5V.mjs';
4
4
 
5
- class InvalidEventIteratorRetryResponse extends Error {
5
+ class CompositeStandardLinkPlugin {
6
+ plugins;
7
+ constructor(plugins = []) {
8
+ this.plugins = [...plugins].sort((a, b) => (a.order ?? 0) - (b.order ?? 0));
9
+ }
10
+ init(options) {
11
+ for (const plugin of this.plugins) {
12
+ plugin.init?.(options);
13
+ }
14
+ }
6
15
  }
16
+
7
17
  class StandardLink {
8
18
  constructor(codec, sender, options = {}) {
9
19
  this.codec = codec;
10
20
  this.sender = sender;
11
- for (const plugin of toArray(options.plugins)) {
12
- plugin.init?.(options);
13
- }
21
+ const plugin = new CompositeStandardLinkPlugin(options.plugins);
22
+ plugin.init(options);
14
23
  this.interceptors = toArray(options.interceptors);
15
24
  this.clientInterceptors = toArray(options.clientInterceptors);
16
25
  }
17
26
  interceptors;
18
27
  clientInterceptors;
19
28
  call(path, input, options) {
20
- return intercept(this.interceptors, { path, input, options }, async ({ path: path2, input: input2, options: options2 }) => {
21
- const output = await this.#call(path2, input2, options2);
22
- return output;
23
- });
24
- }
25
- async #call(path, input, options) {
26
- const request = await this.codec.encode(path, input, options);
27
- const response = await intercept(
28
- this.clientInterceptors,
29
- { request },
30
- ({ request: request2 }) => this.sender.call(request2, options, path, input)
29
+ return runWithSpan(
30
+ { name: `${ORPC_NAME}.${path.join("/")}`, signal: options.signal },
31
+ (span) => {
32
+ span?.setAttribute("rpc.system", ORPC_NAME);
33
+ span?.setAttribute("rpc.method", path.join("."));
34
+ if (isAsyncIteratorObject(input)) {
35
+ input = asyncIteratorWithSpan(
36
+ { name: "consume_event_iterator_input", signal: options.signal },
37
+ input
38
+ );
39
+ }
40
+ return intercept(this.interceptors, { ...options, path, input }, async ({ path: path2, input: input2, ...options2 }) => {
41
+ const otelConfig = getGlobalOtelConfig();
42
+ let otelContext;
43
+ const currentSpan = otelConfig?.trace.getActiveSpan() ?? span;
44
+ if (currentSpan && otelConfig) {
45
+ otelContext = otelConfig?.trace.setSpan(otelConfig.context.active(), currentSpan);
46
+ }
47
+ const request = await runWithSpan(
48
+ { name: "encode_request", context: otelContext },
49
+ () => this.codec.encode(path2, input2, options2)
50
+ );
51
+ const response = await intercept(
52
+ this.clientInterceptors,
53
+ { ...options2, input: input2, path: path2, request },
54
+ ({ input: input3, path: path3, request: request2, ...options3 }) => {
55
+ return runWithSpan(
56
+ { name: "send_request", signal: options3.signal, context: otelContext },
57
+ () => this.sender.call(request2, options3, path3, input3)
58
+ );
59
+ }
60
+ );
61
+ const output = await runWithSpan(
62
+ { name: "decode_response", context: otelContext },
63
+ () => this.codec.decode(response, options2, path2, input2)
64
+ );
65
+ if (isAsyncIteratorObject(output)) {
66
+ return asyncIteratorWithSpan(
67
+ { name: "consume_event_iterator_output", signal: options2.signal },
68
+ output
69
+ );
70
+ }
71
+ return output;
72
+ });
73
+ }
31
74
  );
32
- const output = await this.codec.decode(response, options, path, input);
33
- return output;
34
75
  }
35
76
  }
36
77
 
@@ -183,6 +224,9 @@ class StandardRPCJsonSerializer {
183
224
  function toHttpPath(path) {
184
225
  return `/${path.map(encodeURIComponent).join("/")}`;
185
226
  }
227
+ function getMalformedResponseErrorCode(status) {
228
+ return Object.entries(COMMON_ORPC_ERROR_DEFS).find(([, def]) => def.status === status)?.[0] ?? "MALFORMED_ORPC_ERROR_RESPONSE";
229
+ }
186
230
 
187
231
  class StandardRPCLinkCodec {
188
232
  constructor(serializer, options) {
@@ -202,7 +246,8 @@ class StandardRPCLinkCodec {
202
246
  const expectedMethod = await value(this.expectedMethod, options, path, input);
203
247
  let headers = await value(this.headers, options, path, input);
204
248
  const baseUrl = await value(this.baseUrl, options, path, input);
205
- const url = new URL(`${baseUrl.toString().replace(/\/$/, "")}${toHttpPath(path)}`);
249
+ const url = new URL(baseUrl);
250
+ url.pathname = `${url.pathname.replace(/\/$/, "")}${toHttpPath(path)}`;
206
251
  if (options.lastEventId !== void 0) {
207
252
  headers = mergeStandardHeaders(headers, { "last-event-id": options.lastEventId });
208
253
  }
@@ -249,12 +294,12 @@ class StandardRPCLinkCodec {
249
294
  }
250
295
  })();
251
296
  if (!isOk) {
252
- if (ORPCError.isValidJSON(deserialized)) {
253
- throw ORPCError.fromJSON(deserialized);
297
+ if (isORPCErrorJson(deserialized)) {
298
+ throw createORPCErrorFromJson(deserialized);
254
299
  }
255
- throw new ORPCError("MALFORMED_ORPC_ERROR_RESPONSE", {
300
+ throw new ORPCError(getMalformedResponseErrorCode(response.status), {
256
301
  status: response.status,
257
- data: deserialized
302
+ data: { ...response, body: deserialized }
258
303
  });
259
304
  }
260
305
  return deserialized;
@@ -304,8 +349,8 @@ class StandardRPCSerializer {
304
349
  return e;
305
350
  }
306
351
  const deserialized = this.#deserialize(e.data);
307
- if (ORPCError.isValidJSON(deserialized)) {
308
- return ORPCError.fromJSON(deserialized, { cause: e });
352
+ if (isORPCErrorJson(deserialized)) {
353
+ return createORPCErrorFromJson(deserialized, { cause: e });
309
354
  }
310
355
  return new ErrorEvent({
311
356
  data: deserialized,
@@ -317,6 +362,9 @@ class StandardRPCSerializer {
317
362
  return this.#deserialize(data);
318
363
  }
319
364
  #deserialize(data) {
365
+ if (data === void 0) {
366
+ return void 0;
367
+ }
320
368
  if (!(data instanceof FormData)) {
321
369
  return this.jsonSerializer.deserialize(data.json, data.meta ?? []);
322
370
  }
@@ -330,4 +378,13 @@ class StandardRPCSerializer {
330
378
  }
331
379
  }
332
380
 
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 };
381
+ class StandardRPCLink extends StandardLink {
382
+ constructor(linkClient, options) {
383
+ const jsonSerializer = new StandardRPCJsonSerializer(options);
384
+ const serializer = new StandardRPCSerializer(jsonSerializer);
385
+ const linkCodec = new StandardRPCLinkCodec(serializer, options);
386
+ super(linkCodec, linkClient, options);
387
+ }
388
+ }
389
+
390
+ export { CompositeStandardLinkPlugin as C, StandardLink as S, STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as a, StandardRPCJsonSerializer as b, StandardRPCLink as c, StandardRPCLinkCodec as d, StandardRPCSerializer as e, getMalformedResponseErrorCode as g, toHttpPath as t };
@@ -1,6 +1,6 @@
1
- import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.3Fsj0tpH.mjs';
2
- import { c as StandardLinkCodec, a as StandardLinkOptions } from './client.Dpozrd9X.mjs';
3
- import { Segment, Value } from '@orpc/shared';
1
+ import { b as ClientContext, c as ClientOptions, f as HTTPMethod } from './client.BOYsZIRq.mjs';
2
+ import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.Bwgm6dgk.mjs';
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,46 +44,30 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
44
44
  /**
45
45
  * Base url for all requests.
46
46
  */
47
- url: Value<string | URL, [
48
- options: ClientOptions<T>,
49
- path: readonly string[],
50
- input: unknown
51
- ]>;
47
+ url: Value<Promisable<string | URL>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
52
48
  /**
53
49
  * The maximum length of the URL.
54
50
  *
55
51
  * @default 2083
56
52
  */
57
- maxUrlLength?: Value<number, [
58
- options: ClientOptions<T>,
59
- path: readonly string[],
60
- input: unknown
61
- ]>;
53
+ maxUrlLength?: Value<Promisable<number>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
62
54
  /**
63
55
  * The method used to make the request.
64
56
  *
65
57
  * @default 'POST'
66
58
  */
67
- method?: Value<HTTPMethod, [
68
- options: ClientOptions<T>,
69
- path: readonly string[],
70
- input: unknown
71
- ]>;
59
+ method?: Value<Promisable<Exclude<HTTPMethod, 'HEAD'>>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
72
60
  /**
73
61
  * The method to use when the payload cannot safely pass to the server with method return from method function.
74
62
  * GET is not allowed, it's very dangerous.
75
63
  *
76
64
  * @default 'POST'
77
65
  */
78
- fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
66
+ fallbackMethod?: Exclude<HTTPMethod, 'HEAD' | 'GET'>;
79
67
  /**
80
68
  * Inject headers to the request.
81
69
  */
82
- headers?: Value<StandardHeaders, [
83
- options: ClientOptions<T>,
84
- path: readonly string[],
85
- input: unknown
86
- ]>;
70
+ headers?: Value<Promisable<StandardHeaders>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
87
71
  }
88
72
  declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
89
73
  private readonly serializer;
@@ -99,5 +83,9 @@ declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardL
99
83
 
100
84
  interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
101
85
  }
86
+ declare class StandardRPCLink<T extends ClientContext> extends StandardLink<T> {
87
+ constructor(linkClient: StandardLinkClient<T>, options: StandardRPCLinkOptions<T>);
88
+ }
102
89
 
103
- export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as S, type StandardRPCJsonSerializedMetaItem as a, type StandardRPCJsonSerialized as b, type StandardRPCCustomJsonSerializer as c, type StandardRPCJsonSerializerOptions as d, StandardRPCJsonSerializer as e, type StandardRPCLinkOptions as f, type StandardRPCLinkCodecOptions as g, StandardRPCLinkCodec as h, StandardRPCSerializer as i };
90
+ export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as S, StandardRPCJsonSerializer as e, StandardRPCLink as g, StandardRPCLinkCodec as i, StandardRPCSerializer as j };
91
+ export type { StandardRPCJsonSerializedMetaItem as a, StandardRPCJsonSerialized as b, StandardRPCCustomJsonSerializer as c, StandardRPCJsonSerializerOptions as d, StandardRPCLinkOptions as f, StandardRPCLinkCodecOptions as h };
@@ -1,4 +1,4 @@
1
- import { isObject, isTypescriptObject } from '@orpc/shared';
1
+ import { resolveMaybeOptionalOptions, isObject, AsyncIteratorClass, isTypescriptObject } from '@orpc/shared';
2
2
  import { getEventMeta, withEventMeta } from '@orpc/standard-server';
3
3
 
4
4
  const COMMON_ORPC_ERROR_DEFS = {
@@ -90,16 +90,17 @@ class ORPCError extends Error {
90
90
  code;
91
91
  status;
92
92
  data;
93
- constructor(code, ...[options]) {
94
- if (options?.status && !isORPCErrorStatus(options.status)) {
93
+ constructor(code, ...rest) {
94
+ const options = resolveMaybeOptionalOptions(rest);
95
+ if (options.status !== void 0 && !isORPCErrorStatus(options.status)) {
95
96
  throw new Error("[ORPCError] Invalid error status code.");
96
97
  }
97
- const message = fallbackORPCErrorMessage(code, options?.message);
98
+ const message = fallbackORPCErrorMessage(code, options.message);
98
99
  super(message, options);
99
100
  this.code = code;
100
- this.status = fallbackORPCErrorStatus(code, options?.status);
101
- this.defined = options?.defined ?? false;
102
- this.data = options?.data;
101
+ this.status = fallbackORPCErrorStatus(code, options.status);
102
+ this.defined = options.defined ?? false;
103
+ this.data = options.data;
103
104
  }
104
105
  toJSON() {
105
106
  return {
@@ -110,22 +111,6 @@ class ORPCError extends Error {
110
111
  data: this.data
111
112
  };
112
113
  }
113
- static fromJSON(json, options) {
114
- return new ORPCError(json.code, {
115
- ...options,
116
- ...json
117
- });
118
- }
119
- static isValidJSON(json) {
120
- if (!isObject(json)) {
121
- return false;
122
- }
123
- const validKeys = ["defined", "code", "status", "message", "data"];
124
- if (Object.keys(json).some((k) => !validKeys.includes(k))) {
125
- return false;
126
- }
127
- return "defined" in json && typeof json.defined === "boolean" && "code" in json && typeof json.code === "string" && "status" in json && typeof json.status === "number" && "message" in json && typeof json.message === "string";
128
- }
129
114
  }
130
115
  function isDefinedError(error) {
131
116
  return error instanceof ORPCError && error.defined;
@@ -139,37 +124,57 @@ function toORPCError(error) {
139
124
  function isORPCErrorStatus(status) {
140
125
  return status < 200 || status >= 400;
141
126
  }
127
+ function isORPCErrorJson(json) {
128
+ if (!isObject(json)) {
129
+ return false;
130
+ }
131
+ const validKeys = ["defined", "code", "status", "message", "data"];
132
+ if (Object.keys(json).some((k) => !validKeys.includes(k))) {
133
+ return false;
134
+ }
135
+ return "defined" in json && typeof json.defined === "boolean" && "code" in json && typeof json.code === "string" && "status" in json && typeof json.status === "number" && isORPCErrorStatus(json.status) && "message" in json && typeof json.message === "string";
136
+ }
137
+ function createORPCErrorFromJson(json, options = {}) {
138
+ return new ORPCError(json.code, {
139
+ ...options,
140
+ ...json
141
+ });
142
+ }
142
143
 
143
144
  function mapEventIterator(iterator, maps) {
144
- return async function* () {
145
- try {
146
- while (true) {
147
- const { done, value } = await iterator.next();
148
- let mappedValue = await maps.value(value, done);
149
- if (mappedValue !== value) {
150
- const meta = getEventMeta(value);
151
- if (meta && isTypescriptObject(mappedValue)) {
152
- mappedValue = withEventMeta(mappedValue, meta);
153
- }
154
- }
155
- if (done) {
156
- return mappedValue;
157
- }
158
- yield mappedValue;
145
+ const mapError = async (error) => {
146
+ let mappedError = await maps.error(error);
147
+ if (mappedError !== error) {
148
+ const meta = getEventMeta(error);
149
+ if (meta && isTypescriptObject(mappedError)) {
150
+ mappedError = withEventMeta(mappedError, meta);
159
151
  }
160
- } catch (error) {
161
- let mappedError = await maps.error(error);
162
- if (mappedError !== error) {
163
- const meta = getEventMeta(error);
164
- if (meta && isTypescriptObject(mappedError)) {
165
- mappedError = withEventMeta(mappedError, meta);
166
- }
152
+ }
153
+ return mappedError;
154
+ };
155
+ return new AsyncIteratorClass(async () => {
156
+ const { done, value } = await (async () => {
157
+ try {
158
+ return await iterator.next();
159
+ } catch (error) {
160
+ throw await mapError(error);
161
+ }
162
+ })();
163
+ let mappedValue = await maps.value(value, done);
164
+ if (mappedValue !== value) {
165
+ const meta = getEventMeta(value);
166
+ if (meta && isTypescriptObject(mappedValue)) {
167
+ mappedValue = withEventMeta(mappedValue, meta);
167
168
  }
168
- throw mappedError;
169
- } finally {
169
+ }
170
+ return { done, value: mappedValue };
171
+ }, async () => {
172
+ try {
170
173
  await iterator.return?.();
174
+ } catch (error) {
175
+ throw await mapError(error);
171
176
  }
172
- }();
177
+ });
173
178
  }
174
179
 
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 };
180
+ export { COMMON_ORPC_ERROR_DEFS as C, ORPCError as O, fallbackORPCErrorMessage as a, isORPCErrorStatus as b, isORPCErrorJson as c, createORPCErrorFromJson as d, 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.d1f8ea3",
4
+ "version": "0.0.0-next.d31094d",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -33,18 +33,29 @@
33
33
  "types": "./dist/adapters/fetch/index.d.mts",
34
34
  "import": "./dist/adapters/fetch/index.mjs",
35
35
  "default": "./dist/adapters/fetch/index.mjs"
36
+ },
37
+ "./websocket": {
38
+ "types": "./dist/adapters/websocket/index.d.mts",
39
+ "import": "./dist/adapters/websocket/index.mjs",
40
+ "default": "./dist/adapters/websocket/index.mjs"
41
+ },
42
+ "./message-port": {
43
+ "types": "./dist/adapters/message-port/index.d.mts",
44
+ "import": "./dist/adapters/message-port/index.mjs",
45
+ "default": "./dist/adapters/message-port/index.mjs"
36
46
  }
37
47
  },
38
48
  "files": [
39
49
  "dist"
40
50
  ],
41
51
  "dependencies": {
42
- "@orpc/standard-server": "0.0.0-next.d1f8ea3",
43
- "@orpc/shared": "0.0.0-next.d1f8ea3",
44
- "@orpc/standard-server-fetch": "0.0.0-next.d1f8ea3"
52
+ "@orpc/standard-server-fetch": "0.0.0-next.d31094d",
53
+ "@orpc/standard-server-peer": "0.0.0-next.d31094d",
54
+ "@orpc/standard-server": "0.0.0-next.d31094d",
55
+ "@orpc/shared": "0.0.0-next.d31094d"
45
56
  },
46
57
  "devDependencies": {
47
- "zod": "^3.24.2"
58
+ "zod": "^4.0.17"
48
59
  },
49
60
  "scripts": {
50
61
  "build": "unbuild",