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

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 (32) hide show
  1. package/README.md +23 -22
  2. package/dist/adapters/fetch/index.d.mts +31 -15
  3. package/dist/adapters/fetch/index.d.ts +31 -15
  4. package/dist/adapters/fetch/index.mjs +27 -17
  5. package/dist/adapters/message-port/index.d.mts +80 -0
  6. package/dist/adapters/message-port/index.d.ts +80 -0
  7. package/dist/adapters/message-port/index.mjs +87 -0
  8. package/dist/adapters/standard/index.d.mts +7 -5
  9. package/dist/adapters/standard/index.d.ts +7 -5
  10. package/dist/adapters/standard/index.mjs +4 -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 +47 -0
  14. package/dist/index.d.mts +106 -27
  15. package/dist/index.d.ts +106 -27
  16. package/dist/index.mjs +61 -14
  17. package/dist/plugins/index.d.mts +209 -21
  18. package/dist/plugins/index.d.ts +209 -21
  19. package/dist/plugins/index.mjs +412 -53
  20. package/dist/shared/client.BDbd8GMX.mjs +171 -0
  21. package/dist/shared/client.BH1AYT_p.d.mts +83 -0
  22. package/dist/shared/client.BH1AYT_p.d.ts +83 -0
  23. package/dist/shared/client.BLtwTQUg.mjs +40 -0
  24. package/dist/shared/{client.CZFIVTQj.d.ts → client.BxV-mzeR.d.ts} +13 -25
  25. package/dist/shared/{client.D9lmRwGB.d.mts → client.CPgZaUox.d.mts} +20 -14
  26. package/dist/shared/{client.BC0T26HA.d.mts → client.D8lMmWVC.d.mts} +13 -25
  27. package/dist/shared/{client.BaocqKnn.d.ts → client.De8SW4Kw.d.ts} +20 -14
  28. package/dist/shared/{client.F0iTxiCl.mjs → client._xOn23bS.mjs} +99 -39
  29. package/package.json +16 -5
  30. package/dist/shared/client.87WXDX8t.d.mts +0 -32
  31. package/dist/shared/client.87WXDX8t.d.ts +0 -32
  32. package/dist/shared/client.BacCdg3F.mjs +0 -172
@@ -0,0 +1,47 @@
1
+ import { readAsBuffer } from '@orpc/shared';
2
+ import { ClientPeer } from '@orpc/standard-server-peer';
3
+ import { c as StandardRPCLink } from '../../shared/client._xOn23bS.mjs';
4
+ import '@orpc/standard-server';
5
+ import '../../shared/client.BDbd8GMX.mjs';
6
+ import '@orpc/standard-server-fetch';
7
+ import '../../shared/client.BLtwTQUg.mjs';
8
+
9
+ const WEBSOCKET_CONNECTING = 0;
10
+ class LinkWebsocketClient {
11
+ peer;
12
+ constructor(options) {
13
+ const untilOpen = new Promise((resolve) => {
14
+ if (options.websocket.readyState === WEBSOCKET_CONNECTING) {
15
+ options.websocket.addEventListener("open", () => {
16
+ resolve();
17
+ }, { once: true });
18
+ } else {
19
+ resolve();
20
+ }
21
+ });
22
+ this.peer = new ClientPeer(async (message) => {
23
+ await untilOpen;
24
+ return options.websocket.send(message);
25
+ });
26
+ options.websocket.addEventListener("message", async (event) => {
27
+ const message = event.data instanceof Blob ? await readAsBuffer(event.data) : event.data;
28
+ this.peer.message(message);
29
+ });
30
+ options.websocket.addEventListener("close", () => {
31
+ this.peer.close();
32
+ });
33
+ }
34
+ async call(request, _options, _path, _input) {
35
+ const response = await this.peer.request(request);
36
+ return { ...response, body: () => Promise.resolve(response.body) };
37
+ }
38
+ }
39
+
40
+ class RPCLink extends StandardRPCLink {
41
+ constructor(options) {
42
+ const linkClient = new LinkWebsocketClient(options);
43
+ super(linkClient, { ...options, url: "orpc://localhost" });
44
+ }
45
+ }
46
+
47
+ export { LinkWebsocketClient, RPCLink };
package/dist/index.d.mts CHANGED
@@ -1,26 +1,21 @@
1
- import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.87WXDX8t.mjs';
2
- export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.87WXDX8t.mjs';
3
- import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
4
- export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
1
+ import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientPromiseResult, b as ClientContext, F as FriendlyClientOptions, c as ClientOptions, d as Client, e as ClientRest } from './shared/client.BH1AYT_p.mjs';
2
+ export { f as HTTPMethod, H as HTTPPath, h as InferClientBodyInputs, j as InferClientBodyOutputs, l as InferClientErrorUnion, k as InferClientErrors, g as InferClientInputs, i as InferClientOutputs } from './shared/client.BH1AYT_p.mjs';
3
+ import { MaybeOptionalOptions, ThrowableError, OnFinishState, Promisable, AsyncIteratorClass } from '@orpc/shared';
4
+ export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
5
5
  export { ErrorEvent } from '@orpc/standard-server';
6
6
 
7
7
  interface createORPCClientOptions {
8
8
  /**
9
9
  * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
10
10
  */
11
- path?: string[];
11
+ path?: readonly string[];
12
12
  }
13
- declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
14
-
15
13
  /**
16
- * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
17
- * based on the request path, input, and context.
14
+ * Create a oRPC client-side client from a link.
15
+ *
16
+ * @see {@link https://orpc.unnoq.com/docs/client/client-side Client-side Client Docs}
18
17
  */
19
- declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
20
- private readonly linkResolver;
21
- constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
22
- call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
23
- }
18
+ declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
24
19
 
25
20
  declare const COMMON_ORPC_ERROR_DEFS: {
26
21
  readonly BAD_REQUEST: {
@@ -118,34 +113,118 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
118
113
  readonly code: TCode;
119
114
  readonly status: number;
120
115
  readonly data: TData;
121
- constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
116
+ constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
122
117
  toJSON(): ORPCErrorJSON<TCode, TData>;
123
- static fromJSON<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
124
- static isValidJSON(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
118
+ /**
119
+ * Workaround for Next.js where different contexts use separate
120
+ * dependency graphs, causing multiple ORPCError constructors existing and breaking
121
+ * `instanceof` checks across contexts.
122
+ *
123
+ * This is particularly problematic with "Optimized SSR", where orpc-client
124
+ * executes in one context but is invoked from another. When an error is thrown
125
+ * in the execution context, `instanceof ORPCError` checks fail in the
126
+ * invocation context due to separate class constructors.
127
+ *
128
+ * @todo Remove this and related code if Next.js resolves the multiple dependency graph issue.
129
+ */
130
+ static [Symbol.hasInstance](instance: unknown): boolean;
125
131
  }
126
132
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
127
133
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
128
134
  declare function toORPCError(error: unknown): ORPCError<any, any>;
135
+ declare function isORPCErrorStatus(status: number): boolean;
136
+ declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
137
+ declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
129
138
 
130
- declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
131
- value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
132
- error: (error: unknown) => Promise<unknown>;
133
- }): AsyncGenerator<TMap, TMap, TNext>;
134
-
135
- type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
139
+ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
136
140
  error: null;
137
141
  data: TOutput;
138
142
  isDefined: false;
139
- } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false] & {
143
+ isSuccess: true;
144
+ } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
140
145
  error: Exclude<TError, ORPCError<any, any>>;
141
146
  data: undefined;
142
147
  isDefined: false;
143
- } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true] & {
148
+ isSuccess: false;
149
+ } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
144
150
  error: Extract<TError, ORPCError<any, any>>;
145
151
  data: undefined;
146
152
  isDefined: true;
153
+ isSuccess: false;
147
154
  };
148
- declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
155
+ /**
156
+ * Works like try/catch, but can infer error types.
157
+ *
158
+ * @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
159
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
160
+ */
161
+ declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
149
162
  declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
163
+ interface ConsumeEventIteratorOptions<T, TReturn, TError> {
164
+ /**
165
+ * Called on each event
166
+ */
167
+ onEvent: (event: T) => void;
168
+ /**
169
+ * Called once error happens
170
+ */
171
+ onError?: (error: TError) => void;
172
+ /**
173
+ * Called once event iterator is done
174
+ *
175
+ * @info If iterator is canceled, `undefined` can be passed on success
176
+ */
177
+ onSuccess?: (value: TReturn | undefined) => void;
178
+ /**
179
+ * Called once after onError or onSuccess
180
+ *
181
+ * @info If iterator is canceled, `undefined` can be passed on success
182
+ */
183
+ onFinish?: (state: OnFinishState<TReturn | undefined, TError>) => void;
184
+ }
185
+ /**
186
+ * Consumes an event iterator with lifecycle callbacks
187
+ *
188
+ * @warning If no `onError` or `onFinish` is provided, unhandled rejections will be thrown
189
+ * @return unsubscribe callback
190
+ */
191
+ declare function consumeEventIterator<T, TReturn, TError = ThrowableError>(iterator: AsyncIterator<T, TReturn> | ClientPromiseResult<AsyncIterator<T, TReturn>, TError>, options: ConsumeEventIteratorOptions<T, TReturn, TError>): () => Promise<void>;
192
+
193
+ type SafeClient<T extends NestedClient<any>> = T extends Client<infer UContext, infer UInput, infer UOutput, infer UError> ? (...rest: ClientRest<UContext, UInput>) => Promise<SafeResult<UOutput, UError>> : {
194
+ [K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
195
+ };
196
+ /**
197
+ * Create a safe client that automatically wraps all procedure calls with the `safe` util.
198
+ *
199
+ * @example
200
+ * ```ts
201
+ * const safeClient = createSafeClient(client)
202
+ * const { error, data, isDefined } = await safeClient.doSomething({ id: '123' })
203
+ * ```
204
+ *
205
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling#using-createsafeclient Safe Client Docs}
206
+ */
207
+ declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
208
+
209
+ declare const ORPC_CLIENT_PACKAGE_NAME = "@orpc/client";
210
+ declare const ORPC_CLIENT_PACKAGE_VERSION = "0.0.0-next.ea1d4fd";
211
+
212
+ /**
213
+ * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
214
+ * based on the request path, input, and context.
215
+ *
216
+ * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
217
+ */
218
+ declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
219
+ private readonly linkResolver;
220
+ constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
221
+ call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
222
+ }
223
+
224
+ declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
225
+ value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
226
+ error: (error: unknown) => Promise<unknown>;
227
+ }): AsyncIteratorClass<TMap, TMap, TNext>;
150
228
 
151
- export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, type CommonORPCErrorCode, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, type ORPCErrorCode, type ORPCErrorJSON, type ORPCErrorOptions, type SafeResult, createORPCClient, type createORPCClientOptions, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
229
+ export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, ORPC_CLIENT_PACKAGE_NAME, ORPC_CLIENT_PACKAGE_VERSION, consumeEventIterator, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
230
+ export type { CommonORPCErrorCode, ConsumeEventIteratorOptions, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };
package/dist/index.d.ts CHANGED
@@ -1,26 +1,21 @@
1
- import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.87WXDX8t.js';
2
- export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.87WXDX8t.js';
3
- import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
4
- export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
1
+ import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientPromiseResult, b as ClientContext, F as FriendlyClientOptions, c as ClientOptions, d as Client, e as ClientRest } from './shared/client.BH1AYT_p.js';
2
+ export { f as HTTPMethod, H as HTTPPath, h as InferClientBodyInputs, j as InferClientBodyOutputs, l as InferClientErrorUnion, k as InferClientErrors, g as InferClientInputs, i as InferClientOutputs } from './shared/client.BH1AYT_p.js';
3
+ import { MaybeOptionalOptions, ThrowableError, OnFinishState, Promisable, AsyncIteratorClass } from '@orpc/shared';
4
+ export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
5
5
  export { ErrorEvent } from '@orpc/standard-server';
6
6
 
7
7
  interface createORPCClientOptions {
8
8
  /**
9
9
  * Use as base path for all procedure, useful when you only want to call a subset of the procedure.
10
10
  */
11
- path?: string[];
11
+ path?: readonly string[];
12
12
  }
13
- declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
14
-
15
13
  /**
16
- * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
17
- * based on the request path, input, and context.
14
+ * Create a oRPC client-side client from a link.
15
+ *
16
+ * @see {@link https://orpc.unnoq.com/docs/client/client-side Client-side Client Docs}
18
17
  */
19
- declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
20
- private readonly linkResolver;
21
- constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
22
- call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
23
- }
18
+ declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
24
19
 
25
20
  declare const COMMON_ORPC_ERROR_DEFS: {
26
21
  readonly BAD_REQUEST: {
@@ -118,34 +113,118 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
118
113
  readonly code: TCode;
119
114
  readonly status: number;
120
115
  readonly data: TData;
121
- constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
116
+ constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
122
117
  toJSON(): ORPCErrorJSON<TCode, TData>;
123
- static fromJSON<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
124
- static isValidJSON(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
118
+ /**
119
+ * Workaround for Next.js where different contexts use separate
120
+ * dependency graphs, causing multiple ORPCError constructors existing and breaking
121
+ * `instanceof` checks across contexts.
122
+ *
123
+ * This is particularly problematic with "Optimized SSR", where orpc-client
124
+ * executes in one context but is invoked from another. When an error is thrown
125
+ * in the execution context, `instanceof ORPCError` checks fail in the
126
+ * invocation context due to separate class constructors.
127
+ *
128
+ * @todo Remove this and related code if Next.js resolves the multiple dependency graph issue.
129
+ */
130
+ static [Symbol.hasInstance](instance: unknown): boolean;
125
131
  }
126
132
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
127
133
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
128
134
  declare function toORPCError(error: unknown): ORPCError<any, any>;
135
+ declare function isORPCErrorStatus(status: number): boolean;
136
+ declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
137
+ declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
129
138
 
130
- declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
131
- value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
132
- error: (error: unknown) => Promise<unknown>;
133
- }): AsyncGenerator<TMap, TMap, TNext>;
134
-
135
- type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
139
+ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
136
140
  error: null;
137
141
  data: TOutput;
138
142
  isDefined: false;
139
- } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false] & {
143
+ isSuccess: true;
144
+ } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
140
145
  error: Exclude<TError, ORPCError<any, any>>;
141
146
  data: undefined;
142
147
  isDefined: false;
143
- } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true] & {
148
+ isSuccess: false;
149
+ } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
144
150
  error: Extract<TError, ORPCError<any, any>>;
145
151
  data: undefined;
146
152
  isDefined: true;
153
+ isSuccess: false;
147
154
  };
148
- declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
155
+ /**
156
+ * Works like try/catch, but can infer error types.
157
+ *
158
+ * @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
159
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
160
+ */
161
+ declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
149
162
  declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
163
+ interface ConsumeEventIteratorOptions<T, TReturn, TError> {
164
+ /**
165
+ * Called on each event
166
+ */
167
+ onEvent: (event: T) => void;
168
+ /**
169
+ * Called once error happens
170
+ */
171
+ onError?: (error: TError) => void;
172
+ /**
173
+ * Called once event iterator is done
174
+ *
175
+ * @info If iterator is canceled, `undefined` can be passed on success
176
+ */
177
+ onSuccess?: (value: TReturn | undefined) => void;
178
+ /**
179
+ * Called once after onError or onSuccess
180
+ *
181
+ * @info If iterator is canceled, `undefined` can be passed on success
182
+ */
183
+ onFinish?: (state: OnFinishState<TReturn | undefined, TError>) => void;
184
+ }
185
+ /**
186
+ * Consumes an event iterator with lifecycle callbacks
187
+ *
188
+ * @warning If no `onError` or `onFinish` is provided, unhandled rejections will be thrown
189
+ * @return unsubscribe callback
190
+ */
191
+ declare function consumeEventIterator<T, TReturn, TError = ThrowableError>(iterator: AsyncIterator<T, TReturn> | ClientPromiseResult<AsyncIterator<T, TReturn>, TError>, options: ConsumeEventIteratorOptions<T, TReturn, TError>): () => Promise<void>;
192
+
193
+ type SafeClient<T extends NestedClient<any>> = T extends Client<infer UContext, infer UInput, infer UOutput, infer UError> ? (...rest: ClientRest<UContext, UInput>) => Promise<SafeResult<UOutput, UError>> : {
194
+ [K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
195
+ };
196
+ /**
197
+ * Create a safe client that automatically wraps all procedure calls with the `safe` util.
198
+ *
199
+ * @example
200
+ * ```ts
201
+ * const safeClient = createSafeClient(client)
202
+ * const { error, data, isDefined } = await safeClient.doSomething({ id: '123' })
203
+ * ```
204
+ *
205
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling#using-createsafeclient Safe Client Docs}
206
+ */
207
+ declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
208
+
209
+ declare const ORPC_CLIENT_PACKAGE_NAME = "@orpc/client";
210
+ declare const ORPC_CLIENT_PACKAGE_VERSION = "0.0.0-next.ea1d4fd";
211
+
212
+ /**
213
+ * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
214
+ * based on the request path, input, and context.
215
+ *
216
+ * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
217
+ */
218
+ declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
219
+ private readonly linkResolver;
220
+ constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
221
+ call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
222
+ }
223
+
224
+ declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
225
+ value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
226
+ error: (error: unknown) => Promise<unknown>;
227
+ }): AsyncIteratorClass<TMap, TMap, TNext>;
150
228
 
151
- export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, type CommonORPCErrorCode, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, type ORPCErrorCode, type ORPCErrorJSON, type ORPCErrorOptions, type SafeResult, createORPCClient, type createORPCClientOptions, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
229
+ export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, ORPC_CLIENT_PACKAGE_NAME, ORPC_CLIENT_PACKAGE_VERSION, consumeEventIterator, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
230
+ export type { CommonORPCErrorCode, ConsumeEventIteratorOptions, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };
package/dist/index.mjs CHANGED
@@ -1,39 +1,70 @@
1
- import { i as isDefinedError } from './shared/client.BacCdg3F.mjs';
2
- export { C as COMMON_ORPC_ERROR_DEFS, O as ORPCError, a as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, m as mapEventIterator, t as toORPCError } from './shared/client.BacCdg3F.mjs';
3
- export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
1
+ import { preventNativeAwait, isTypescriptObject } from '@orpc/shared';
2
+ export { AsyncIteratorClass, EventPublisher, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
3
+ import { i as isDefinedError } from './shared/client.BDbd8GMX.mjs';
4
+ export { C as COMMON_ORPC_ERROR_DEFS, c as ORPCError, O as ORPC_CLIENT_PACKAGE_NAME, a as ORPC_CLIENT_PACKAGE_VERSION, g as createORPCErrorFromJson, b as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, e as isORPCErrorJson, d as isORPCErrorStatus, t as toORPCError } from './shared/client.BDbd8GMX.mjs';
5
+ export { m as mapEventIterator } from './shared/client.BLtwTQUg.mjs';
4
6
  export { ErrorEvent } from '@orpc/standard-server';
5
7
 
6
8
  async function safe(promise) {
7
9
  try {
8
10
  const output = await promise;
9
11
  return Object.assign(
10
- [null, output, false],
11
- { error: null, data: output, isDefined: false }
12
+ [null, output, false, true],
13
+ { error: null, data: output, isDefined: false, isSuccess: true }
12
14
  );
13
15
  } catch (e) {
14
16
  const error = e;
15
17
  if (isDefinedError(error)) {
16
18
  return Object.assign(
17
- [error, void 0, true],
18
- { error, data: void 0, isDefined: true }
19
+ [error, void 0, true, false],
20
+ { error, data: void 0, isDefined: true, isSuccess: false }
19
21
  );
20
22
  }
21
23
  return Object.assign(
22
- [error, void 0, false],
23
- { error, data: void 0, isDefined: false }
24
+ [error, void 0, false, false],
25
+ { error, data: void 0, isDefined: false, isSuccess: false }
24
26
  );
25
27
  }
26
28
  }
27
29
  function resolveFriendlyClientOptions(options) {
28
30
  return {
29
31
  ...options,
30
- context: options?.context ?? {}
32
+ context: options.context ?? {}
31
33
  // Context only optional if all fields are optional
32
34
  };
33
35
  }
36
+ function consumeEventIterator(iterator, options) {
37
+ void (async () => {
38
+ let onFinishState;
39
+ try {
40
+ const resolvedIterator = await iterator;
41
+ while (true) {
42
+ const { done, value } = await resolvedIterator.next();
43
+ if (done) {
44
+ const realValue = value;
45
+ onFinishState = [null, realValue, true];
46
+ options.onSuccess?.(realValue);
47
+ break;
48
+ }
49
+ options.onEvent(value);
50
+ }
51
+ } catch (error) {
52
+ onFinishState = [error, void 0, false];
53
+ if (!options.onError && !options.onFinish) {
54
+ throw error;
55
+ }
56
+ options.onError?.(error);
57
+ } finally {
58
+ options.onFinish?.(onFinishState);
59
+ }
60
+ })();
61
+ return async () => {
62
+ await (await iterator)?.return?.();
63
+ };
64
+ }
34
65
 
35
- function createORPCClient(link, options) {
36
- const path = options?.path ?? [];
66
+ function createORPCClient(link, options = {}) {
67
+ const path = options.path ?? [];
37
68
  const procedureClient = async (...[input, options2 = {}]) => {
38
69
  return await link.call(path, input, resolveFriendlyClientOptions(options2));
39
70
  };
@@ -48,7 +79,23 @@ function createORPCClient(link, options) {
48
79
  });
49
80
  }
50
81
  });
51
- return recursive;
82
+ return preventNativeAwait(recursive);
83
+ }
84
+
85
+ function createSafeClient(client) {
86
+ const proxy = new Proxy((...args) => safe(client(...args)), {
87
+ get(_, prop, receiver) {
88
+ const value = Reflect.get(client, prop, receiver);
89
+ if (typeof prop !== "string") {
90
+ return value;
91
+ }
92
+ if (!isTypescriptObject(value)) {
93
+ return value;
94
+ }
95
+ return createSafeClient(value);
96
+ }
97
+ });
98
+ return proxy;
52
99
  }
53
100
 
54
101
  class DynamicLink {
@@ -62,4 +109,4 @@ class DynamicLink {
62
109
  }
63
110
  }
64
111
 
65
- export { DynamicLink, createORPCClient, isDefinedError, resolveFriendlyClientOptions, safe };
112
+ export { DynamicLink, consumeEventIterator, createORPCClient, createSafeClient, isDefinedError, resolveFriendlyClientOptions, safe };