@orpc/client 0.0.0-next.d137cdf → 0.0.0-next.d5f0415

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.
package/dist/index.js CHANGED
@@ -1,83 +1,81 @@
1
- // src/procedure.ts
2
1
  import {
3
- ORPC_HEADER,
4
- ORPC_HEADER_VALUE
5
- } from "@orpc/contract";
6
- import { trim } from "@orpc/shared";
7
- import { ORPCError } from "@orpc/shared/error";
8
- import { ORPCDeserializer, ORPCSerializer } from "@orpc/transformer";
9
- function createProcedureClient(options) {
10
- const serializer = new ORPCSerializer();
11
- const deserializer = new ORPCDeserializer();
12
- const client = async (input) => {
13
- const fetch_ = options.fetch ?? fetch;
14
- const url = `${trim(options.baseURL, "/")}/${options.path.map(encodeURIComponent).join("/")}`;
15
- let headers = await options.headers?.(input);
16
- headers = headers instanceof Headers ? headers : new Headers(headers);
17
- const { body, headers: headers_ } = serializer.serialize(input);
18
- for (const [key, value] of headers_.entries()) {
19
- headers.set(key, value);
20
- }
21
- headers.set(ORPC_HEADER, ORPC_HEADER_VALUE);
22
- const response = await fetch_(url, {
23
- method: "POST",
24
- headers,
25
- body
26
- });
27
- const json = await (async () => {
28
- try {
29
- return await deserializer.deserialize(response);
30
- } catch (e) {
31
- throw new ORPCError({
32
- code: "INTERNAL_SERVER_ERROR",
33
- message: "Cannot parse response.",
34
- cause: e
35
- });
2
+ COMMON_ORPC_ERROR_DEFS,
3
+ ORPCError,
4
+ createAutoRetryEventIterator,
5
+ fallbackORPCErrorMessage,
6
+ fallbackORPCErrorStatus,
7
+ isDefinedError,
8
+ mapEventIterator,
9
+ onEventIteratorStatusChange,
10
+ registerEventIteratorState,
11
+ toORPCError,
12
+ updateEventIteratorStatus
13
+ } from "./chunk-2UPNYYFF.js";
14
+
15
+ // src/client.ts
16
+ function createORPCClient(link, options) {
17
+ const path = options?.path ?? [];
18
+ const procedureClient = async (...[input, options2]) => {
19
+ const optionsOut = {
20
+ ...options2,
21
+ context: options2?.context ?? {}
22
+ // options.context can be undefined when all field is optional
23
+ };
24
+ return await link.call(path, input, optionsOut);
25
+ };
26
+ const recursive = new Proxy(procedureClient, {
27
+ get(target, key) {
28
+ if (typeof key !== "string") {
29
+ return Reflect.get(target, key);
36
30
  }
37
- })();
38
- if (!response.ok) {
39
- throw ORPCError.fromJSON(json) ?? new ORPCError({
40
- status: response.status,
41
- code: "INTERNAL_SERVER_ERROR",
42
- message: "Internal server error"
31
+ return createORPCClient(link, {
32
+ ...options,
33
+ path: [...path, key]
43
34
  });
44
35
  }
45
- return json;
46
- };
47
- return client;
36
+ });
37
+ return recursive;
48
38
  }
49
39
 
50
- // src/router.ts
51
- function createRouterClient(options) {
52
- const path = options?.path ?? [];
53
- const client = new Proxy(
54
- createProcedureClient({
55
- baseURL: options.baseURL,
56
- fetch: options.fetch,
57
- headers: options.headers,
58
- path
59
- }),
60
- {
61
- get(target, key) {
62
- if (typeof key !== "string") {
63
- return Reflect.get(target, key);
64
- }
65
- return createRouterClient({
66
- ...options,
67
- path: [...path, key]
68
- });
69
- }
40
+ // src/dynamic-link.ts
41
+ var DynamicLink = class {
42
+ constructor(linkResolver) {
43
+ this.linkResolver = linkResolver;
44
+ }
45
+ async call(path, input, options) {
46
+ const resolvedLink = await this.linkResolver(options, path, input);
47
+ const output = await resolvedLink.call(path, input, options);
48
+ return output;
49
+ }
50
+ };
51
+
52
+ // src/utils.ts
53
+ async function safe(promise) {
54
+ try {
55
+ const output = await promise;
56
+ return [output, void 0, false];
57
+ } catch (e) {
58
+ const error = e;
59
+ if (isDefinedError(error)) {
60
+ return [void 0, error, true];
70
61
  }
71
- );
72
- return client;
62
+ return [void 0, error, false];
63
+ }
73
64
  }
74
-
75
- // src/index.ts
76
- export * from "@orpc/shared/error";
77
- var createORPCClient = createRouterClient;
78
65
  export {
66
+ COMMON_ORPC_ERROR_DEFS,
67
+ DynamicLink,
68
+ ORPCError,
69
+ createAutoRetryEventIterator,
79
70
  createORPCClient,
80
- createProcedureClient,
81
- createRouterClient
71
+ fallbackORPCErrorMessage,
72
+ fallbackORPCErrorStatus,
73
+ isDefinedError,
74
+ mapEventIterator,
75
+ onEventIteratorStatusChange,
76
+ registerEventIteratorState,
77
+ safe,
78
+ toORPCError,
79
+ updateEventIteratorStatus
82
80
  };
83
81
  //# sourceMappingURL=index.js.map
@@ -0,0 +1,329 @@
1
+ import {
2
+ ORPCError,
3
+ __export,
4
+ mapEventIterator,
5
+ toORPCError
6
+ } from "./chunk-2UPNYYFF.js";
7
+
8
+ // src/openapi/bracket-notation.ts
9
+ var bracket_notation_exports = {};
10
+ __export(bracket_notation_exports, {
11
+ deserialize: () => deserialize,
12
+ escapeSegment: () => escapeSegment,
13
+ parsePath: () => parsePath,
14
+ serialize: () => serialize,
15
+ stringifyPath: () => stringifyPath
16
+ });
17
+ import { isObject } from "@orpc/shared";
18
+ function serialize(payload, parentKey = "") {
19
+ if (!Array.isArray(payload) && !isObject(payload))
20
+ return [["", payload]];
21
+ const result = [];
22
+ function helper(value, path) {
23
+ if (Array.isArray(value)) {
24
+ value.forEach((item, index) => {
25
+ helper(item, [...path, String(index)]);
26
+ });
27
+ } else if (isObject(value)) {
28
+ for (const [key, val] of Object.entries(value)) {
29
+ helper(val, [...path, key]);
30
+ }
31
+ } else {
32
+ result.push([stringifyPath(path), value]);
33
+ }
34
+ }
35
+ helper(payload, parentKey ? [parentKey] : []);
36
+ return result;
37
+ }
38
+ function deserialize(entities) {
39
+ if (entities.length === 0) {
40
+ return void 0;
41
+ }
42
+ const isRootArray = entities.every(([path]) => path === "");
43
+ const result = isRootArray ? [] : {};
44
+ const arrayPushPaths = /* @__PURE__ */ new Set();
45
+ for (const [path, _] of entities) {
46
+ const segments = parsePath(path);
47
+ const base = segments.slice(0, -1).join(".");
48
+ const last = segments[segments.length - 1];
49
+ if (last === "") {
50
+ arrayPushPaths.add(base);
51
+ } else {
52
+ arrayPushPaths.delete(base);
53
+ }
54
+ }
55
+ function setValue(obj, segments, value, fullPath) {
56
+ const [first, ...rest_] = segments;
57
+ if (Array.isArray(obj) && first === "") {
58
+ ;
59
+ obj.push(value);
60
+ return;
61
+ }
62
+ const objAsRecord = obj;
63
+ if (rest_.length === 0) {
64
+ objAsRecord[first] = value;
65
+ return;
66
+ }
67
+ const rest = rest_;
68
+ if (rest[0] === "") {
69
+ const pathToCheck = segments.slice(0, -1).join(".");
70
+ if (rest.length === 1 && arrayPushPaths.has(pathToCheck)) {
71
+ if (!(first in objAsRecord)) {
72
+ objAsRecord[first] = [];
73
+ }
74
+ if (Array.isArray(objAsRecord[first])) {
75
+ ;
76
+ objAsRecord[first].push(value);
77
+ return;
78
+ }
79
+ }
80
+ if (!(first in objAsRecord)) {
81
+ objAsRecord[first] = {};
82
+ }
83
+ const target = objAsRecord[first];
84
+ target[""] = value;
85
+ return;
86
+ }
87
+ if (!(first in objAsRecord)) {
88
+ objAsRecord[first] = {};
89
+ }
90
+ setValue(
91
+ objAsRecord[first],
92
+ rest,
93
+ value,
94
+ fullPath
95
+ );
96
+ }
97
+ for (const [path, value] of entities) {
98
+ const segments = parsePath(path);
99
+ setValue(result, segments, value, path);
100
+ }
101
+ return result;
102
+ }
103
+ function escapeSegment(segment) {
104
+ return segment.replace(/[\\[\]]/g, (match) => {
105
+ switch (match) {
106
+ case "\\":
107
+ return "\\\\";
108
+ case "[":
109
+ return "\\[";
110
+ case "]":
111
+ return "\\]";
112
+ default:
113
+ return match;
114
+ }
115
+ });
116
+ }
117
+ function stringifyPath(path) {
118
+ const [first, ...rest] = path;
119
+ const firstSegment = escapeSegment(first);
120
+ const base = first === "" ? "" : firstSegment;
121
+ return rest.reduce(
122
+ (result, segment) => `${result}[${escapeSegment(segment)}]`,
123
+ base
124
+ );
125
+ }
126
+ function parsePath(path) {
127
+ if (path === "")
128
+ return [""];
129
+ const result = [];
130
+ let currentSegment = "";
131
+ let inBracket = false;
132
+ let bracketContent = "";
133
+ let backslashCount = 0;
134
+ for (let i = 0; i < path.length; i++) {
135
+ const char = path[i];
136
+ if (char === "\\") {
137
+ backslashCount++;
138
+ continue;
139
+ }
140
+ if (backslashCount > 0) {
141
+ const literalBackslashes = "\\".repeat(Math.floor(backslashCount / 2));
142
+ if (char === "[" || char === "]") {
143
+ if (backslashCount % 2 === 1) {
144
+ if (inBracket) {
145
+ bracketContent += literalBackslashes + char;
146
+ } else {
147
+ currentSegment += literalBackslashes + char;
148
+ }
149
+ } else {
150
+ if (inBracket) {
151
+ bracketContent += literalBackslashes;
152
+ } else {
153
+ currentSegment += literalBackslashes;
154
+ }
155
+ if (char === "[" && !inBracket) {
156
+ if (currentSegment !== "" || result.length === 0) {
157
+ result.push(currentSegment);
158
+ }
159
+ inBracket = true;
160
+ bracketContent = "";
161
+ currentSegment = "";
162
+ } else if (char === "]" && inBracket) {
163
+ result.push(bracketContent);
164
+ inBracket = false;
165
+ bracketContent = "";
166
+ } else {
167
+ if (inBracket) {
168
+ bracketContent += char;
169
+ } else {
170
+ currentSegment += char;
171
+ }
172
+ }
173
+ }
174
+ } else {
175
+ const allBackslashes = "\\".repeat(backslashCount);
176
+ if (inBracket) {
177
+ bracketContent += allBackslashes + char;
178
+ } else {
179
+ currentSegment += allBackslashes + char;
180
+ }
181
+ }
182
+ backslashCount = 0;
183
+ continue;
184
+ }
185
+ if (char === "[" && !inBracket) {
186
+ if (currentSegment !== "" || result.length === 0) {
187
+ result.push(currentSegment);
188
+ }
189
+ inBracket = true;
190
+ bracketContent = "";
191
+ currentSegment = "";
192
+ continue;
193
+ }
194
+ if (char === "]" && inBracket) {
195
+ result.push(bracketContent);
196
+ inBracket = false;
197
+ bracketContent = "";
198
+ continue;
199
+ }
200
+ if (inBracket) {
201
+ bracketContent += char;
202
+ } else {
203
+ currentSegment += char;
204
+ }
205
+ }
206
+ if (backslashCount > 0) {
207
+ const remainingBackslashes = "\\".repeat(backslashCount);
208
+ if (inBracket) {
209
+ bracketContent += remainingBackslashes;
210
+ } else {
211
+ currentSegment += remainingBackslashes;
212
+ }
213
+ }
214
+ if (inBracket) {
215
+ if (currentSegment !== "" || result.length === 0) {
216
+ result.push(currentSegment);
217
+ }
218
+ result.push(`[${bracketContent}`);
219
+ } else if (currentSegment !== "" || result.length === 0) {
220
+ result.push(currentSegment);
221
+ }
222
+ return result;
223
+ }
224
+
225
+ // src/openapi/json-serializer.ts
226
+ import { isObject as isObject2 } from "@orpc/shared";
227
+ var OpenAPIJsonSerializer = class {
228
+ serialize(payload) {
229
+ if (payload instanceof Set)
230
+ return this.serialize([...payload]);
231
+ if (payload instanceof Map)
232
+ return this.serialize([...payload.entries()]);
233
+ if (Array.isArray(payload)) {
234
+ return payload.map((v) => v === void 0 ? "undefined" : this.serialize(v));
235
+ }
236
+ if (Number.isNaN(payload))
237
+ return "NaN";
238
+ if (typeof payload === "bigint")
239
+ return payload.toString();
240
+ if (payload instanceof Date && Number.isNaN(payload.getTime())) {
241
+ return "Invalid Date";
242
+ }
243
+ if (payload instanceof RegExp)
244
+ return payload.toString();
245
+ if (payload instanceof URL)
246
+ return payload.toString();
247
+ if (!isObject2(payload))
248
+ return payload;
249
+ return Object.keys(payload).reduce(
250
+ (carry, key) => {
251
+ const val = payload[key];
252
+ carry[key] = this.serialize(val);
253
+ return carry;
254
+ },
255
+ {}
256
+ );
257
+ }
258
+ };
259
+
260
+ // src/openapi/serializer.ts
261
+ import { ErrorEvent, isAsyncIteratorObject } from "@orpc/server-standard";
262
+ import { findDeepMatches } from "@orpc/shared";
263
+ var OpenAPISerializer = class {
264
+ jsonSerializer;
265
+ constructor(options) {
266
+ this.jsonSerializer = options?.jsonSerializer ?? new OpenAPIJsonSerializer();
267
+ }
268
+ serialize(data) {
269
+ if (data instanceof Blob || data === void 0) {
270
+ return data;
271
+ }
272
+ if (isAsyncIteratorObject(data)) {
273
+ return mapEventIterator(data, {
274
+ value: async (value) => this.jsonSerializer.serialize(value),
275
+ error: async (e) => {
276
+ if (e instanceof ErrorEvent) {
277
+ return new ErrorEvent({
278
+ data: this.jsonSerializer.serialize(e.data),
279
+ cause: e
280
+ });
281
+ }
282
+ return new ErrorEvent({
283
+ data: this.jsonSerializer.serialize(toORPCError(e).toJSON()),
284
+ cause: e
285
+ });
286
+ }
287
+ });
288
+ }
289
+ const serializedJSON = this.jsonSerializer.serialize(data);
290
+ const { values: blobs } = findDeepMatches((v) => v instanceof Blob, serializedJSON);
291
+ if (blobs.length === 0) {
292
+ return serializedJSON;
293
+ }
294
+ const form = new FormData();
295
+ for (const [path, value] of serialize(serializedJSON)) {
296
+ if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
297
+ form.append(path, value.toString());
298
+ } else if (value instanceof Date) {
299
+ form.append(path, value.toISOString());
300
+ } else if (value instanceof Blob) {
301
+ form.append(path, value);
302
+ }
303
+ }
304
+ return form;
305
+ }
306
+ deserialize(serialized) {
307
+ if (serialized instanceof URLSearchParams || serialized instanceof FormData) {
308
+ return deserialize([...serialized.entries()]);
309
+ }
310
+ if (isAsyncIteratorObject(serialized)) {
311
+ return mapEventIterator(serialized, {
312
+ value: async (value) => value,
313
+ error: async (e) => {
314
+ if (e instanceof ErrorEvent && ORPCError.isValidJSON(e.data)) {
315
+ return ORPCError.fromJSON(e.data, { cause: e });
316
+ }
317
+ return e;
318
+ }
319
+ });
320
+ }
321
+ return serialized;
322
+ }
323
+ };
324
+ export {
325
+ bracket_notation_exports as BracketNotation,
326
+ OpenAPIJsonSerializer,
327
+ OpenAPISerializer
328
+ };
329
+ //# sourceMappingURL=openapi.js.map
package/dist/rpc.js ADDED
@@ -0,0 +1,10 @@
1
+ import {
2
+ RPCSerializer,
3
+ serializeRPCJson
4
+ } from "./chunk-TPEMQB7D.js";
5
+ import "./chunk-2UPNYYFF.js";
6
+ export {
7
+ RPCSerializer,
8
+ serializeRPCJson
9
+ };
10
+ //# sourceMappingURL=rpc.js.map
@@ -0,0 +1,3 @@
1
+ export * from './rpc-link';
2
+ export * from './types';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1,98 @@
1
+ import type { Value } from '@orpc/shared';
2
+ import type { ClientContext, ClientLink, ClientOptionsOut } from '../../types';
3
+ import type { FetchWithContext } from './types';
4
+ import { type EventIteratorReconnectOptions } from '../../event-iterator';
5
+ import { RPCSerializer } from '../../rpc';
6
+ type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
7
+ export declare class InvalidEventSourceRetryResponse extends Error {
8
+ }
9
+ export interface RPCLinkOptions<TClientContext extends ClientContext> {
10
+ /**
11
+ * Base url for all requests.
12
+ */
13
+ url: string;
14
+ /**
15
+ * The maximum length of the URL.
16
+ *
17
+ * @default 2083
18
+ */
19
+ maxUrlLength?: number;
20
+ /**
21
+ * The method used to make the request.
22
+ *
23
+ * @default 'POST'
24
+ */
25
+ method?: Value<HTTPMethod, [
26
+ options: ClientOptionsOut<TClientContext>,
27
+ path: readonly string[],
28
+ input: unknown
29
+ ]>;
30
+ /**
31
+ * The method to use when the payload cannot safely pass to the server with method return from method function.
32
+ * GET is not allowed, it's very dangerous.
33
+ *
34
+ * @default 'POST'
35
+ */
36
+ fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
37
+ /**
38
+ * Inject headers to the request.
39
+ */
40
+ headers?: Value<[string, string][] | Record<string, string> | Headers, [
41
+ options: ClientOptionsOut<TClientContext>,
42
+ path: readonly string[],
43
+ input: unknown
44
+ ]>;
45
+ /**
46
+ * Custom fetch implementation.
47
+ *
48
+ * @default globalThis.fetch.bind(globalThis)
49
+ */
50
+ fetch?: FetchWithContext<TClientContext>;
51
+ rpcSerializer?: RPCSerializer;
52
+ /**
53
+ * Maximum number of retry attempts for EventSource errors before throwing.
54
+ *
55
+ * @default 5
56
+ */
57
+ eventSourceMaxNumberOfRetries?: number;
58
+ /**
59
+ * Delay (in ms) before retrying an EventSource call.
60
+ *
61
+ * @default ({retryTimes, lastRetry}) => lastRetry ?? (1000 * 2 ** retryTimes)
62
+ */
63
+ eventSourceRetryDelay?: Value<number, [
64
+ reconnectOptions: EventIteratorReconnectOptions,
65
+ options: ClientOptionsOut<TClientContext>,
66
+ path: readonly string[],
67
+ input: unknown
68
+ ]>;
69
+ /**
70
+ * Function to determine if an error is retryable.
71
+ *
72
+ * @default true
73
+ */
74
+ eventSourceRetry?: Value<boolean, [
75
+ reconnectOptions: EventIteratorReconnectOptions,
76
+ options: ClientOptionsOut<TClientContext>,
77
+ path: readonly string[],
78
+ input: unknown
79
+ ]>;
80
+ }
81
+ export declare class RPCLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
82
+ private readonly fetch;
83
+ private readonly rpcSerializer;
84
+ private readonly maxUrlLength;
85
+ private readonly fallbackMethod;
86
+ private readonly method;
87
+ private readonly headers;
88
+ private readonly url;
89
+ private readonly eventSourceMaxNumberOfRetries;
90
+ private readonly eventSourceRetryDelay;
91
+ private readonly eventSourceRetry;
92
+ constructor(options: RPCLinkOptions<TClientContext>);
93
+ call(path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>): Promise<unknown>;
94
+ private performCall;
95
+ private encodeRequest;
96
+ }
97
+ export {};
98
+ //# sourceMappingURL=rpc-link.d.ts.map
@@ -0,0 +1,5 @@
1
+ import type { ClientContext, ClientOptionsOut } from '../../types';
2
+ export interface FetchWithContext<TClientContext extends ClientContext> {
3
+ (url: URL, init: RequestInit, options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown): Promise<Response>;
4
+ }
5
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1,9 @@
1
+ import type { ClientLink, InferClientContext, NestedClient } from './types';
2
+ export interface createORPCClientOptions {
3
+ /**
4
+ * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
5
+ */
6
+ path?: string[];
7
+ }
8
+ export declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
9
+ //# sourceMappingURL=client.d.ts.map
@@ -0,0 +1,12 @@
1
+ import type { Promisable } from '@orpc/shared';
2
+ import type { ClientContext, ClientLink, ClientOptionsOut } from './types';
3
+ /**
4
+ * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
5
+ * based on the request path, input, and context.
6
+ */
7
+ export declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
8
+ private readonly linkResolver;
9
+ constructor(linkResolver: (options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
10
+ call(path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>): Promise<unknown>;
11
+ }
12
+ //# sourceMappingURL=dynamic-link.d.ts.map