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

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 +15 -12
  3. package/dist/adapters/fetch/index.d.ts +15 -12
  4. package/dist/adapters/fetch/index.mjs +5 -12
  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 +44 -0
  14. package/dist/index.d.mts +30 -12
  15. package/dist/index.d.ts +30 -12
  16. package/dist/index.mjs +10 -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 +306 -43
  20. package/dist/shared/{client.87WXDX8t.d.mts → client.4TS_0JaO.d.mts} +12 -15
  21. package/dist/shared/{client.87WXDX8t.d.ts → client.4TS_0JaO.d.ts} +12 -15
  22. package/dist/shared/{client.CZFIVTQj.d.ts → client.7UM0t5o-.d.ts} +13 -25
  23. package/dist/shared/{client.D9lmRwGB.d.mts → client.BMoG_EdN.d.mts} +20 -13
  24. package/dist/shared/{client.BacCdg3F.mjs → client.BX0_8bnM.mjs} +35 -35
  25. package/dist/shared/{client.BC0T26HA.d.mts → client.BdD8cpjs.d.mts} +13 -25
  26. package/dist/shared/{client.BaocqKnn.d.ts → client.C0KbSWlC.d.ts} +20 -13
  27. package/dist/shared/{client.F0iTxiCl.mjs → client.CQCGVpTM.mjs} +43 -26
  28. package/package.json +16 -5
@@ -1,4 +1,4 @@
1
- import { isObject, isTypescriptObject } from '@orpc/shared';
1
+ import { isObject, AsyncIteratorClass, 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);
@@ -110,22 +110,6 @@ class ORPCError extends Error {
110
110
  data: this.data
111
111
  };
112
112
  }
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
113
  }
130
114
  function isDefinedError(error) {
131
115
  return error instanceof ORPCError && error.defined;
@@ -136,24 +120,38 @@ function toORPCError(error) {
136
120
  cause: error
137
121
  });
138
122
  }
123
+ function isORPCErrorStatus(status) {
124
+ return status < 200 || status >= 400;
125
+ }
126
+ function isORPCErrorJson(json) {
127
+ if (!isObject(json)) {
128
+ return false;
129
+ }
130
+ const validKeys = ["defined", "code", "status", "message", "data"];
131
+ if (Object.keys(json).some((k) => !validKeys.includes(k))) {
132
+ return false;
133
+ }
134
+ 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";
135
+ }
136
+ function createORPCErrorFromJson(json, options = {}) {
137
+ return new ORPCError(json.code, {
138
+ ...options,
139
+ ...json
140
+ });
141
+ }
139
142
 
140
143
  function mapEventIterator(iterator, maps) {
141
- return async function* () {
144
+ return new AsyncIteratorClass(async () => {
142
145
  try {
143
- while (true) {
144
- const { done, value } = await iterator.next();
145
- let mappedValue = await maps.value(value, done);
146
- if (mappedValue !== value) {
147
- const meta = getEventMeta(value);
148
- if (meta && isTypescriptObject(mappedValue)) {
149
- mappedValue = withEventMeta(mappedValue, meta);
150
- }
146
+ const { done, value } = await iterator.next();
147
+ let mappedValue = await maps.value(value, done);
148
+ if (mappedValue !== value) {
149
+ const meta = getEventMeta(value);
150
+ if (meta && isTypescriptObject(mappedValue)) {
151
+ mappedValue = withEventMeta(mappedValue, meta);
151
152
  }
152
- if (done) {
153
- return mappedValue;
154
- }
155
- yield mappedValue;
156
153
  }
154
+ return { done, value: mappedValue };
157
155
  } catch (error) {
158
156
  let mappedError = await maps.error(error);
159
157
  if (mappedError !== error) {
@@ -163,10 +161,12 @@ function mapEventIterator(iterator, maps) {
163
161
  }
164
162
  }
165
163
  throw mappedError;
166
- } finally {
164
+ }
165
+ }, async (reason) => {
166
+ if (reason !== "next") {
167
167
  await iterator.return?.();
168
168
  }
169
- }();
169
+ });
170
170
  }
171
171
 
172
- export { COMMON_ORPC_ERROR_DEFS as C, ORPCError as O, fallbackORPCErrorMessage as a, fallbackORPCErrorStatus as f, isDefinedError as i, mapEventIterator as m, toORPCError as t };
172
+ 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 };
@@ -1,6 +1,6 @@
1
- import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.87WXDX8t.mjs';
2
- import { c as StandardLinkCodec, a as StandardLinkOptions } from './client.D9lmRwGB.mjs';
3
- import { Segment, Value } from '@orpc/shared';
1
+ import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.4TS_0JaO.mjs';
2
+ import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.BMoG_EdN.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,6 +1,16 @@
1
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.87WXDX8t.js';
3
+ import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.4TS_0JaO.js';
4
+
5
+ interface StandardLinkPlugin<T extends ClientContext> {
6
+ order?: number;
7
+ init?(options: StandardLinkOptions<T>): void;
8
+ }
9
+ declare class CompositeStandardLinkPlugin<T extends ClientContext, TPlugin extends StandardLinkPlugin<T>> implements StandardLinkPlugin<T> {
10
+ protected readonly plugins: TPlugin[];
11
+ constructor(plugins?: readonly TPlugin[]);
12
+ init(options: StandardLinkOptions<T>): void;
13
+ }
4
14
 
5
15
  interface StandardLinkCodec<T extends ClientContext> {
6
16
  encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
@@ -10,20 +20,16 @@ interface StandardLinkClient<T extends ClientContext> {
10
20
  call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
11
21
  }
12
22
 
13
- declare class InvalidEventIteratorRetryResponse extends Error {
23
+ interface StandardLinkInterceptorOptions<T extends ClientContext> extends ClientOptions<T> {
24
+ path: readonly string[];
25
+ input: unknown;
14
26
  }
15
- interface StandardLinkPlugin<T extends ClientContext> {
16
- init?(options: StandardLinkOptions<T>): void;
27
+ interface StandardLinkClientInterceptorOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
28
+ request: StandardRequest;
17
29
  }
18
30
  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>[];
31
+ interceptors?: Interceptor<StandardLinkInterceptorOptions<T>, Promise<unknown>>[];
32
+ clientInterceptors?: Interceptor<StandardLinkClientInterceptorOptions<T>, Promise<StandardLazyResponse>>[];
27
33
  plugins?: StandardLinkPlugin<T>[];
28
34
  }
29
35
  declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
@@ -36,4 +42,5 @@ declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
36
42
  call(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<unknown>;
37
43
  }
38
44
 
39
- export { InvalidEventIteratorRetryResponse as I, type StandardLinkPlugin as S, type StandardLinkOptions as a, StandardLink as b, type StandardLinkCodec as c, type StandardLinkClient as d };
45
+ export { CompositeStandardLinkPlugin as C, StandardLink as d };
46
+ export type { StandardLinkClientInterceptorOptions as S, StandardLinkPlugin as a, StandardLinkOptions as b, StandardLinkInterceptorOptions as c, StandardLinkCodec as e, StandardLinkClient as f };
@@ -1,23 +1,32 @@
1
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
- import { ErrorEvent } from '@orpc/standard-server';
2
+ import { mergeStandardHeaders, ErrorEvent } from '@orpc/standard-server';
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.BX0_8bnM.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 }) => {
29
+ return intercept(this.interceptors, { ...options, path, input }, async ({ path: path2, input: input2, ...options2 }) => {
21
30
  const output = await this.#call(path2, input2, options2);
22
31
  return output;
23
32
  });
@@ -26,8 +35,8 @@ class StandardLink {
26
35
  const request = await this.codec.encode(path, input, options);
27
36
  const response = await intercept(
28
37
  this.clientInterceptors,
29
- { request },
30
- ({ request: request2 }) => this.sender.call(request2, options, path, input)
38
+ { ...options, input, path, request },
39
+ ({ input: input2, path: path2, request: request2, ...options2 }) => this.sender.call(request2, options2, path2, input2)
31
40
  );
32
41
  const output = await this.codec.decode(response, options, path, input);
33
42
  return output;
@@ -183,6 +192,9 @@ class StandardRPCJsonSerializer {
183
192
  function toHttpPath(path) {
184
193
  return `/${path.map(encodeURIComponent).join("/")}`;
185
194
  }
195
+ function getMalformedResponseErrorCode(status) {
196
+ return Object.entries(COMMON_ORPC_ERROR_DEFS).find(([, def]) => def.status === status)?.[0] ?? "MALFORMED_ORPC_ERROR_RESPONSE";
197
+ }
186
198
 
187
199
  class StandardRPCLinkCodec {
188
200
  constructor(serializer, options) {
@@ -200,17 +212,12 @@ class StandardRPCLinkCodec {
200
212
  headers;
201
213
  async encode(path, input, options) {
202
214
  const expectedMethod = await value(this.expectedMethod, options, path, input);
203
- const headers = { ...await value(this.headers, options, path, input) };
215
+ let headers = await value(this.headers, options, path, input);
204
216
  const baseUrl = await value(this.baseUrl, options, path, input);
205
- const url = new URL(`${baseUrl.toString().replace(/\/$/, "")}${toHttpPath(path)}`);
217
+ const url = new URL(baseUrl);
218
+ url.pathname = `${url.pathname.replace(/\/$/, "")}${toHttpPath(path)}`;
206
219
  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
- }
220
+ headers = mergeStandardHeaders(headers, { "last-event-id": options.lastEventId });
214
221
  }
215
222
  const serialized = this.serializer.serialize(input);
216
223
  if (expectedMethod === "GET" && !(serialized instanceof FormData) && !isAsyncIteratorObject(serialized)) {
@@ -236,7 +243,7 @@ class StandardRPCLinkCodec {
236
243
  };
237
244
  }
238
245
  async decode(response) {
239
- const isOk = response.status >= 200 && response.status < 300;
246
+ const isOk = !isORPCErrorStatus(response.status);
240
247
  const deserialized = await (async () => {
241
248
  let isBodyOk = false;
242
249
  try {
@@ -255,11 +262,12 @@ class StandardRPCLinkCodec {
255
262
  }
256
263
  })();
257
264
  if (!isOk) {
258
- if (ORPCError.isValidJSON(deserialized)) {
259
- throw ORPCError.fromJSON(deserialized);
265
+ if (isORPCErrorJson(deserialized)) {
266
+ throw createORPCErrorFromJson(deserialized);
260
267
  }
261
- throw new Error("Invalid RPC error response format.", {
262
- cause: deserialized
268
+ throw new ORPCError(getMalformedResponseErrorCode(response.status), {
269
+ status: response.status,
270
+ data: { ...response, body: deserialized }
263
271
  });
264
272
  }
265
273
  return deserialized;
@@ -309,8 +317,8 @@ class StandardRPCSerializer {
309
317
  return e;
310
318
  }
311
319
  const deserialized = this.#deserialize(e.data);
312
- if (ORPCError.isValidJSON(deserialized)) {
313
- return ORPCError.fromJSON(deserialized, { cause: e });
320
+ if (isORPCErrorJson(deserialized)) {
321
+ return createORPCErrorFromJson(deserialized, { cause: e });
314
322
  }
315
323
  return new ErrorEvent({
316
324
  data: deserialized,
@@ -335,4 +343,13 @@ class StandardRPCSerializer {
335
343
  }
336
344
  }
337
345
 
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 };
346
+ class StandardRPCLink extends StandardLink {
347
+ constructor(linkClient, options) {
348
+ const jsonSerializer = new StandardRPCJsonSerializer(options);
349
+ const serializer = new StandardRPCSerializer(jsonSerializer);
350
+ const linkCodec = new StandardRPCLinkCodec(serializer, options);
351
+ super(linkCodec, linkClient, options);
352
+ }
353
+ }
354
+
355
+ 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 };
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.ea0903c",
4
+ "version": "0.0.0-next.eaf61c7",
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/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"
52
+ "@orpc/standard-server": "0.0.0-next.eaf61c7",
53
+ "@orpc/standard-server-fetch": "0.0.0-next.eaf61c7",
54
+ "@orpc/shared": "0.0.0-next.eaf61c7",
55
+ "@orpc/standard-server-peer": "0.0.0-next.eaf61c7"
45
56
  },
46
57
  "devDependencies": {
47
- "zod": "^3.24.2"
58
+ "zod": "^3.25.57"
48
59
  },
49
60
  "scripts": {
50
61
  "build": "unbuild",