@orpc/client 0.0.0-next.e0f01a5 → 0.0.0-next.e27e0c1

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 (30) hide show
  1. package/README.md +22 -22
  2. package/dist/adapters/fetch/index.d.mts +29 -10
  3. package/dist/adapters/fetch/index.d.ts +29 -10
  4. package/dist/adapters/fetch/index.mjs +24 -8
  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 +86 -0
  8. package/dist/adapters/standard/index.d.mts +6 -5
  9. package/dist/adapters/standard/index.d.ts +6 -5
  10. package/dist/adapters/standard/index.mjs +3 -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 +46 -0
  14. package/dist/index.d.mts +96 -22
  15. package/dist/index.d.ts +96 -22
  16. package/dist/index.mjs +54 -8
  17. package/dist/plugins/index.d.mts +75 -16
  18. package/dist/plugins/index.d.ts +75 -16
  19. package/dist/plugins/index.mjs +143 -27
  20. package/dist/shared/client.BH1AYT_p.d.mts +83 -0
  21. package/dist/shared/client.BH1AYT_p.d.ts +83 -0
  22. package/dist/shared/{client.DpICn1BD.mjs → client.BRztoawb.mjs} +62 -20
  23. package/dist/shared/{client.8TjrVhkC.d.ts → client.BxV-mzeR.d.ts} +8 -8
  24. package/dist/shared/{client.C9U9n1f3.d.ts → client.CPgZaUox.d.mts} +4 -5
  25. package/dist/shared/{client.BjJBZryq.d.mts → client.D8lMmWVC.d.mts} +8 -8
  26. package/dist/shared/{client.FXep-a3a.d.mts → client.De8SW4Kw.d.ts} +4 -5
  27. package/dist/shared/{client.CRWEpqLB.mjs → client.DhC7qN6c.mjs} +66 -33
  28. package/package.json +16 -5
  29. package/dist/shared/client.CipPQkhk.d.mts +0 -29
  30. package/dist/shared/client.CipPQkhk.d.ts +0 -29
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.CipPQkhk.mjs';
2
- export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.CipPQkhk.mjs';
3
- import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
4
- export { Registry, ThrowableError, 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,8 +113,21 @@ 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>;
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;
123
131
  }
124
132
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
125
133
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
@@ -128,11 +136,6 @@ declare function isORPCErrorStatus(status: number): boolean;
128
136
  declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
129
137
  declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
130
138
 
131
- declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
132
- value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
133
- error: (error: unknown) => Promise<unknown>;
134
- }): AsyncGenerator<TMap, TMap, TNext>;
135
-
136
139
  type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
137
140
  error: null;
138
141
  data: TOutput;
@@ -149,8 +152,79 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
149
152
  isDefined: true;
150
153
  isSuccess: false;
151
154
  };
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
+ */
152
161
  declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
153
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.e27e0c1";
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>;
154
228
 
155
- export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
156
- export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeResult, createORPCClientOptions };
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.CipPQkhk.js';
2
- export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.CipPQkhk.js';
3
- import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
4
- export { Registry, ThrowableError, 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,8 +113,21 @@ 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>;
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;
123
131
  }
124
132
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
125
133
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
@@ -128,11 +136,6 @@ declare function isORPCErrorStatus(status: number): boolean;
128
136
  declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
129
137
  declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
130
138
 
131
- declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
132
- value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
133
- error: (error: unknown) => Promise<unknown>;
134
- }): AsyncGenerator<TMap, TMap, TNext>;
135
-
136
139
  type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
137
140
  error: null;
138
141
  data: TOutput;
@@ -149,8 +152,79 @@ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false
149
152
  isDefined: true;
150
153
  isSuccess: false;
151
154
  };
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
+ */
152
161
  declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
153
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.e27e0c1";
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>;
154
228
 
155
- export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
156
- export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeResult, createORPCClientOptions };
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,6 +1,7 @@
1
- import { i as isDefinedError } from './shared/client.CRWEpqLB.mjs';
2
- export { C as COMMON_ORPC_ERROR_DEFS, O as ORPCError, d as createORPCErrorFromJson, a as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, c as isORPCErrorJson, b as isORPCErrorStatus, m as mapEventIterator, t as toORPCError } from './shared/client.CRWEpqLB.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.DhC7qN6c.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, m as mapEventIterator, t as toORPCError } from './shared/client.DhC7qN6c.mjs';
4
5
  export { ErrorEvent } from '@orpc/standard-server';
5
6
 
6
7
  async function safe(promise) {
@@ -27,13 +28,42 @@ async function safe(promise) {
27
28
  function resolveFriendlyClientOptions(options) {
28
29
  return {
29
30
  ...options,
30
- context: options?.context ?? {}
31
+ context: options.context ?? {}
31
32
  // Context only optional if all fields are optional
32
33
  };
33
34
  }
35
+ function consumeEventIterator(iterator, options) {
36
+ void (async () => {
37
+ let onFinishState;
38
+ try {
39
+ const resolvedIterator = await iterator;
40
+ while (true) {
41
+ const { done, value } = await resolvedIterator.next();
42
+ if (done) {
43
+ const realValue = value;
44
+ onFinishState = [null, realValue, true];
45
+ options.onSuccess?.(realValue);
46
+ break;
47
+ }
48
+ options.onEvent(value);
49
+ }
50
+ } catch (error) {
51
+ onFinishState = [error, void 0, false];
52
+ if (!options.onError && !options.onFinish) {
53
+ throw error;
54
+ }
55
+ options.onError?.(error);
56
+ } finally {
57
+ options.onFinish?.(onFinishState);
58
+ }
59
+ })();
60
+ return async () => {
61
+ await (await iterator)?.return?.();
62
+ };
63
+ }
34
64
 
35
- function createORPCClient(link, options) {
36
- const path = options?.path ?? [];
65
+ function createORPCClient(link, options = {}) {
66
+ const path = options.path ?? [];
37
67
  const procedureClient = async (...[input, options2 = {}]) => {
38
68
  return await link.call(path, input, resolveFriendlyClientOptions(options2));
39
69
  };
@@ -48,7 +78,23 @@ function createORPCClient(link, options) {
48
78
  });
49
79
  }
50
80
  });
51
- return recursive;
81
+ return preventNativeAwait(recursive);
82
+ }
83
+
84
+ function createSafeClient(client) {
85
+ const proxy = new Proxy((...args) => safe(client(...args)), {
86
+ get(_, prop, receiver) {
87
+ const value = Reflect.get(client, prop, receiver);
88
+ if (typeof prop !== "string") {
89
+ return value;
90
+ }
91
+ if (!isTypescriptObject(value)) {
92
+ return value;
93
+ }
94
+ return createSafeClient(value);
95
+ }
96
+ });
97
+ return proxy;
52
98
  }
53
99
 
54
100
  class DynamicLink {
@@ -62,4 +108,4 @@ class DynamicLink {
62
108
  }
63
109
  }
64
110
 
65
- export { DynamicLink, createORPCClient, isDefinedError, resolveFriendlyClientOptions, safe };
111
+ export { DynamicLink, consumeEventIterator, createORPCClient, createSafeClient, isDefinedError, resolveFriendlyClientOptions, safe };
@@ -1,7 +1,8 @@
1
- import { Value } from '@orpc/shared';
1
+ import { Value, Promisable } from '@orpc/shared';
2
2
  import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
3
- import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.FXep-a3a.mjs';
4
- import { a as ClientContext } from '../shared/client.CipPQkhk.mjs';
3
+ import { BatchResponseMode } from '@orpc/standard-server/batch';
4
+ import { S as StandardLinkClientInterceptorOptions, a as StandardLinkPlugin, b as StandardLinkOptions, c as StandardLinkInterceptorOptions } from '../shared/client.CPgZaUox.mjs';
5
+ import { b as ClientContext } from '../shared/client.BH1AYT_p.mjs';
5
6
 
6
7
  interface BatchLinkPluginGroup<T extends ClientContext> {
7
8
  condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
@@ -16,25 +17,31 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
16
17
  *
17
18
  * @default 10
18
19
  */
19
- maxSize?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
20
+ maxSize?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
21
+ /**
22
+ * The batch response mode.
23
+ *
24
+ * @default 'streaming'
25
+ */
26
+ mode?: Value<BatchResponseMode, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
20
27
  /**
21
28
  * Defines the URL to use for the batch request.
22
29
  *
23
30
  * @default the URL of the first request in the batch + '/__batch__'
24
31
  */
25
- url?: Value<string | URL, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
32
+ url?: Value<Promisable<string | URL>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
26
33
  /**
27
34
  * The maximum length of the URL.
28
35
  *
29
36
  * @default 2083
30
37
  */
31
- maxUrlLength?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
38
+ maxUrlLength?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
32
39
  /**
33
40
  * Defines the HTTP headers to use for the batch request.
34
41
  *
35
42
  * @default The same headers of all requests in the batch
36
43
  */
37
- headers?: Value<StandardHeaders, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
44
+ headers?: Value<Promisable<StandardHeaders>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
38
45
  /**
39
46
  * Map the batch request items before sending them.
40
47
  *
@@ -51,6 +58,12 @@ interface BatchLinkPluginOptions<T extends ClientContext> {
51
58
  */
52
59
  exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
53
60
  }
61
+ /**
62
+ * The Batch Requests Plugin allows you to combine multiple requests and responses into a single batch,
63
+ * reducing the overhead of sending each one separately.
64
+ *
65
+ * @see {@link https://orpc.unnoq.com/docs/plugins/batch-requests Batch Requests Plugin Docs}
66
+ */
54
67
  declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
55
68
  #private;
56
69
  private readonly groups;
@@ -60,9 +73,42 @@ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPl
60
73
  private readonly batchHeaders;
61
74
  private readonly mapRequestItem;
62
75
  private readonly exclude;
76
+ private readonly mode;
63
77
  private pending;
64
78
  order: number;
65
- constructor(options: BatchLinkPluginOptions<T>);
79
+ constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
80
+ init(options: StandardLinkOptions<T>): void;
81
+ }
82
+
83
+ interface DedupeRequestsPluginGroup<T extends ClientContext> {
84
+ condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
85
+ /**
86
+ * The context used for the rest of the request lifecycle.
87
+ */
88
+ context: T;
89
+ }
90
+ interface DedupeRequestsPluginOptions<T extends ClientContext> {
91
+ /**
92
+ * To enable deduplication, a request must match at least one defined group.
93
+ * Requests that fall into the same group are considered for deduplication together.
94
+ */
95
+ groups: readonly [DedupeRequestsPluginGroup<T>, ...DedupeRequestsPluginGroup<T>[]];
96
+ /**
97
+ * Filters requests to dedupe
98
+ *
99
+ * @default (({ request }) => request.method === 'GET')
100
+ */
101
+ filter?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
102
+ }
103
+ /**
104
+ * Prevents duplicate requests by deduplicating similar ones to reduce server load.
105
+ *
106
+ * @see {@link https://orpc.unnoq.com/docs/plugins/dedupe-requests Dedupe Requests Plugin}
107
+ */
108
+ declare class DedupeRequestsPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
109
+ #private;
110
+ order: number;
111
+ constructor(options: NoInfer<DedupeRequestsPluginOptions<T>>);
66
112
  init(options: StandardLinkOptions<T>): void;
67
113
  }
68
114
 
@@ -78,19 +124,19 @@ interface ClientRetryPluginContext {
78
124
  *
79
125
  * @default 0
80
126
  */
81
- retry?: Value<number, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
127
+ retry?: Value<Promisable<number>, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
82
128
  /**
83
129
  * Delay (in ms) before retrying.
84
130
  *
85
131
  * @default (o) => o.lastEventRetry ?? 2000
86
132
  */
87
- retryDelay?: Value<number, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
133
+ retryDelay?: Value<Promisable<number>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
88
134
  /**
89
135
  * Determine should retry or not.
90
136
  *
91
137
  * @default true
92
138
  */
93
- shouldRetry?: Value<boolean, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
139
+ shouldRetry?: Value<Promisable<boolean>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
94
140
  /**
95
141
  * The hook called when retrying, and return the unsubscribe function.
96
142
  */
@@ -101,11 +147,17 @@ declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
101
147
  interface ClientRetryPluginOptions {
102
148
  default?: ClientRetryPluginContext;
103
149
  }
150
+ /**
151
+ * The Client Retry Plugin enables retrying client calls when errors occur.
152
+ *
153
+ * @see {@link https://orpc.unnoq.com/docs/plugins/client-retry Client Retry Plugin Docs}
154
+ */
104
155
  declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements StandardLinkPlugin<T> {
105
156
  private readonly defaultRetry;
106
157
  private readonly defaultRetryDelay;
107
158
  private readonly defaultShouldRetry;
108
159
  private readonly defaultOnRetry;
160
+ order: number;
109
161
  constructor(options?: ClientRetryPluginOptions);
110
162
  init(options: StandardLinkOptions<T>): void;
111
163
  }
@@ -116,21 +168,28 @@ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
116
168
  *
117
169
  * @default 'x-csrf-token'
118
170
  */
119
- headerName?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
171
+ headerName?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
120
172
  /**
121
173
  * The value of the header to check.
122
174
  *
123
175
  * @default 'orpc'
124
176
  *
125
177
  */
126
- headerValue?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
178
+ headerValue?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
127
179
  /**
128
180
  * Exclude a procedure from the plugin.
129
181
  *
130
182
  * @default false
131
183
  */
132
- exclude?: Value<boolean, [options: StandardLinkClientInterceptorOptions<T>]>;
184
+ exclude?: Value<Promisable<boolean>, [options: StandardLinkClientInterceptorOptions<T>]>;
133
185
  }
186
+ /**
187
+ * This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
188
+ * It helps ensure that requests to your procedures originate from JavaScript code,
189
+ * not from other sources like standard HTML forms or direct browser navigation.
190
+ *
191
+ * @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
192
+ */
134
193
  declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
135
194
  private readonly headerName;
136
195
  private readonly headerValue;
@@ -140,5 +199,5 @@ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements
140
199
  init(options: StandardLinkOptions<T>): void;
141
200
  }
142
201
 
143
- export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
144
- export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
202
+ export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };
203
+ export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, DedupeRequestsPluginGroup, DedupeRequestsPluginOptions, SimpleCsrfProtectionLinkPluginOptions };