@orpc/client 0.0.0-next.e563486 → 0.0.0-next.e7896e2

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 (33) hide show
  1. package/README.md +26 -22
  2. package/dist/adapters/fetch/index.d.mts +16 -13
  3. package/dist/adapters/fetch/index.d.ts +16 -13
  4. package/dist/adapters/fetch/index.mjs +5 -13
  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 +8 -103
  9. package/dist/adapters/standard/index.d.ts +8 -103
  10. package/dist/adapters/standard/index.mjs +2 -3
  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 +31 -0
  14. package/dist/index.d.mts +32 -13
  15. package/dist/index.d.ts +32 -13
  16. package/dist/index.mjs +34 -32
  17. package/dist/plugins/index.d.mts +165 -25
  18. package/dist/plugins/index.d.ts +165 -25
  19. package/dist/plugins/index.mjs +313 -51
  20. package/dist/shared/client.4TS_0JaO.d.mts +29 -0
  21. package/dist/shared/client.4TS_0JaO.d.ts +29 -0
  22. package/dist/shared/client.7UM0t5o-.d.ts +91 -0
  23. package/dist/shared/client.BMoG_EdN.d.mts +46 -0
  24. package/dist/shared/client.BdD8cpjs.d.mts +91 -0
  25. package/dist/shared/client.C0KbSWlC.d.ts +46 -0
  26. package/dist/shared/{client.BacCdg3F.mjs → client.CRWEpqLB.mjs} +22 -19
  27. package/dist/shared/{client.CjUckqXO.mjs → client.DpICn1BD.mjs} +54 -36
  28. package/package.json +16 -5
  29. package/dist/shared/client.CupM8eRP.d.mts +0 -30
  30. package/dist/shared/client.CupM8eRP.d.ts +0 -30
  31. package/dist/shared/client.CvnV7_uV.mjs +0 -12
  32. package/dist/shared/client.DrOAzyMB.d.mts +0 -45
  33. package/dist/shared/client.aGal-uGY.d.ts +0 -45
@@ -0,0 +1,29 @@
1
+ import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
+ import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.mjs';
3
+ import { f as StandardLinkClient } from '../../shared/client.BMoG_EdN.mjs';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.BdD8cpjs.mjs';
5
+ import '@orpc/shared';
6
+
7
+ interface experimental_LinkWebsocketClientOptions {
8
+ websocket: Pick<WebSocket, 'addEventListener' | 'send'>;
9
+ }
10
+ declare class experimental_LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
11
+ private readonly peer;
12
+ constructor(options: experimental_LinkWebsocketClientOptions);
13
+ call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
14
+ }
15
+
16
+ interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, experimental_LinkWebsocketClientOptions {
17
+ }
18
+ /**
19
+ * The RPC Link communicates with the server using the RPC protocol over WebSocket.
20
+ *
21
+ * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
22
+ * @see {@link https://orpc.unnoq.com/docs/adapters/websocket WebSocket Adapter Docs}
23
+ */
24
+ declare class experimental_RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
25
+ constructor(options: experimental_RPCLinkOptions<T>);
26
+ }
27
+
28
+ export { experimental_LinkWebsocketClient, experimental_RPCLink };
29
+ export type { experimental_LinkWebsocketClientOptions, experimental_RPCLinkOptions };
@@ -0,0 +1,29 @@
1
+ import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
+ import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.js';
3
+ import { f as StandardLinkClient } from '../../shared/client.C0KbSWlC.js';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.7UM0t5o-.js';
5
+ import '@orpc/shared';
6
+
7
+ interface experimental_LinkWebsocketClientOptions {
8
+ websocket: Pick<WebSocket, 'addEventListener' | 'send'>;
9
+ }
10
+ declare class experimental_LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
11
+ private readonly peer;
12
+ constructor(options: experimental_LinkWebsocketClientOptions);
13
+ call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
14
+ }
15
+
16
+ interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, experimental_LinkWebsocketClientOptions {
17
+ }
18
+ /**
19
+ * The RPC Link communicates with the server using the RPC protocol over WebSocket.
20
+ *
21
+ * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
22
+ * @see {@link https://orpc.unnoq.com/docs/adapters/websocket WebSocket Adapter Docs}
23
+ */
24
+ declare class experimental_RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
25
+ constructor(options: experimental_RPCLinkOptions<T>);
26
+ }
27
+
28
+ export { experimental_LinkWebsocketClient, experimental_RPCLink };
29
+ export type { experimental_LinkWebsocketClientOptions, experimental_RPCLinkOptions };
@@ -0,0 +1,31 @@
1
+ import { ClientPeer } from '@orpc/standard-server-peer';
2
+ import '@orpc/shared';
3
+ import { c as StandardRPCLink } from '../../shared/client.DpICn1BD.mjs';
4
+ import '@orpc/standard-server';
5
+ import '../../shared/client.CRWEpqLB.mjs';
6
+
7
+ class experimental_LinkWebsocketClient {
8
+ peer;
9
+ constructor(options) {
10
+ this.peer = new ClientPeer(options.websocket.send.bind(options.websocket));
11
+ options.websocket.addEventListener("message", (event) => {
12
+ this.peer.message(event.data);
13
+ });
14
+ options.websocket.addEventListener("close", () => {
15
+ this.peer.close();
16
+ });
17
+ }
18
+ async call(request, _options, _path, _input) {
19
+ const response = await this.peer.request(request);
20
+ return { ...response, body: () => Promise.resolve(response.body) };
21
+ }
22
+ }
23
+
24
+ class experimental_RPCLink extends StandardRPCLink {
25
+ constructor(options) {
26
+ const linkClient = new experimental_LinkWebsocketClient(options);
27
+ super(linkClient, { ...options, url: "orpc:/" });
28
+ }
29
+ }
30
+
31
+ export { experimental_LinkWebsocketClient, experimental_RPCLink };
package/dist/index.d.mts CHANGED
@@ -1,7 +1,7 @@
1
- import { N as NestedClient, b as ClientLink, I as InferClientContext, a as ClientContext, C as ClientOptionsOut, c as ClientPromiseResult } from './shared/client.CupM8eRP.mjs';
2
- export { f as Client, d as ClientOptions, e as ClientRest } from './shared/client.CupM8eRP.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 ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.4TS_0JaO.mjs';
2
+ export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.4TS_0JaO.mjs';
3
+ import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
4
+ export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
5
5
  export { ErrorEvent } from '@orpc/standard-server';
6
6
 
7
7
  interface createORPCClientOptions {
@@ -10,16 +10,23 @@ interface createORPCClientOptions {
10
10
  */
11
11
  path?: string[];
12
12
  }
13
+ /**
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}
17
+ */
13
18
  declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
14
19
 
15
20
  /**
16
21
  * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
17
22
  * based on the request path, input, and context.
23
+ *
24
+ * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
18
25
  */
19
26
  declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
20
27
  private readonly linkResolver;
21
- constructor(linkResolver: (options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
22
- call(path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>): Promise<unknown>;
28
+ constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
29
+ call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
23
30
  }
24
31
 
25
32
  declare const COMMON_ORPC_ERROR_DEFS: {
@@ -120,31 +127,43 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
120
127
  readonly data: TData;
121
128
  constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
122
129
  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>;
125
130
  }
126
131
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
127
132
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
128
133
  declare function toORPCError(error: unknown): ORPCError<any, any>;
134
+ declare function isORPCErrorStatus(status: number): boolean;
135
+ declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
136
+ declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
129
137
 
130
138
  declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
131
139
  value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
132
140
  error: (error: unknown) => Promise<unknown>;
133
141
  }): AsyncGenerator<TMap, TMap, TNext>;
134
142
 
135
- type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
143
+ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
136
144
  error: null;
137
145
  data: TOutput;
138
146
  isDefined: false;
139
- } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false] & {
147
+ isSuccess: true;
148
+ } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
140
149
  error: Exclude<TError, ORPCError<any, any>>;
141
150
  data: undefined;
142
151
  isDefined: false;
143
- } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true] & {
152
+ isSuccess: false;
153
+ } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
144
154
  error: Extract<TError, ORPCError<any, any>>;
145
155
  data: undefined;
146
156
  isDefined: true;
157
+ isSuccess: false;
147
158
  };
148
- declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
159
+ /**
160
+ * Works like try/catch, but can infer error types.
161
+ *
162
+ * @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
163
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
164
+ */
165
+ declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
166
+ declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
149
167
 
150
- export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptionsOut, ClientPromiseResult, type CommonORPCErrorCode, DynamicLink, InferClientContext, NestedClient, ORPCError, type ORPCErrorCode, type ORPCErrorJSON, type ORPCErrorOptions, type SafeResult, createORPCClient, type createORPCClientOptions, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, mapEventIterator, safe, toORPCError };
168
+ 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 };
169
+ export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeResult, createORPCClientOptions };
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
- import { N as NestedClient, b as ClientLink, I as InferClientContext, a as ClientContext, C as ClientOptionsOut, c as ClientPromiseResult } from './shared/client.CupM8eRP.js';
2
- export { f as Client, d as ClientOptions, e as ClientRest } from './shared/client.CupM8eRP.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 ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.4TS_0JaO.js';
2
+ export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.4TS_0JaO.js';
3
+ import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
4
+ export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
5
5
  export { ErrorEvent } from '@orpc/standard-server';
6
6
 
7
7
  interface createORPCClientOptions {
@@ -10,16 +10,23 @@ interface createORPCClientOptions {
10
10
  */
11
11
  path?: string[];
12
12
  }
13
+ /**
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}
17
+ */
13
18
  declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
14
19
 
15
20
  /**
16
21
  * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
17
22
  * based on the request path, input, and context.
23
+ *
24
+ * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
18
25
  */
19
26
  declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
20
27
  private readonly linkResolver;
21
- constructor(linkResolver: (options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
22
- call(path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>): Promise<unknown>;
28
+ constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
29
+ call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
23
30
  }
24
31
 
25
32
  declare const COMMON_ORPC_ERROR_DEFS: {
@@ -120,31 +127,43 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
120
127
  readonly data: TData;
121
128
  constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
122
129
  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>;
125
130
  }
126
131
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
127
132
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
128
133
  declare function toORPCError(error: unknown): ORPCError<any, any>;
134
+ declare function isORPCErrorStatus(status: number): boolean;
135
+ declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
136
+ declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
129
137
 
130
138
  declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
131
139
  value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
132
140
  error: (error: unknown) => Promise<unknown>;
133
141
  }): AsyncGenerator<TMap, TMap, TNext>;
134
142
 
135
- type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
143
+ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
136
144
  error: null;
137
145
  data: TOutput;
138
146
  isDefined: false;
139
- } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false] & {
147
+ isSuccess: true;
148
+ } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
140
149
  error: Exclude<TError, ORPCError<any, any>>;
141
150
  data: undefined;
142
151
  isDefined: false;
143
- } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true] & {
152
+ isSuccess: false;
153
+ } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
144
154
  error: Extract<TError, ORPCError<any, any>>;
145
155
  data: undefined;
146
156
  isDefined: true;
157
+ isSuccess: false;
147
158
  };
148
- declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
159
+ /**
160
+ * Works like try/catch, but can infer error types.
161
+ *
162
+ * @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
163
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
164
+ */
165
+ declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
166
+ declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
149
167
 
150
- export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptionsOut, ClientPromiseResult, type CommonORPCErrorCode, DynamicLink, InferClientContext, NestedClient, ORPCError, type ORPCErrorCode, type ORPCErrorJSON, type ORPCErrorOptions, type SafeResult, createORPCClient, type createORPCClientOptions, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, mapEventIterator, safe, toORPCError };
168
+ 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 };
169
+ export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeResult, createORPCClientOptions };
package/dist/index.mjs CHANGED
@@ -1,17 +1,41 @@
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';
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
3
  export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
4
4
  export { ErrorEvent } from '@orpc/standard-server';
5
5
 
6
+ async function safe(promise) {
7
+ try {
8
+ const output = await promise;
9
+ return Object.assign(
10
+ [null, output, false, true],
11
+ { error: null, data: output, isDefined: false, isSuccess: true }
12
+ );
13
+ } catch (e) {
14
+ const error = e;
15
+ if (isDefinedError(error)) {
16
+ return Object.assign(
17
+ [error, void 0, true, false],
18
+ { error, data: void 0, isDefined: true, isSuccess: false }
19
+ );
20
+ }
21
+ return Object.assign(
22
+ [error, void 0, false, false],
23
+ { error, data: void 0, isDefined: false, isSuccess: false }
24
+ );
25
+ }
26
+ }
27
+ function resolveFriendlyClientOptions(options) {
28
+ return {
29
+ ...options,
30
+ context: options.context ?? {}
31
+ // Context only optional if all fields are optional
32
+ };
33
+ }
34
+
6
35
  function createORPCClient(link, options) {
7
36
  const path = options?.path ?? [];
8
- const procedureClient = async (...[input, options2]) => {
9
- const optionsOut = {
10
- ...options2,
11
- context: options2?.context ?? {}
12
- // options.context can be undefined when all field is optional
13
- };
14
- return await link.call(path, input, optionsOut);
37
+ const procedureClient = async (...[input, options2 = {}]) => {
38
+ return await link.call(path, input, resolveFriendlyClientOptions(options2));
15
39
  };
16
40
  const recursive = new Proxy(procedureClient, {
17
41
  get(target, key) {
@@ -38,26 +62,4 @@ class DynamicLink {
38
62
  }
39
63
  }
40
64
 
41
- async function safe(promise) {
42
- try {
43
- const output = await promise;
44
- return Object.assign(
45
- [null, output, false],
46
- { error: null, data: output, isDefined: false }
47
- );
48
- } catch (e) {
49
- const error = e;
50
- if (isDefinedError(error)) {
51
- return Object.assign(
52
- [error, void 0, true],
53
- { error, data: void 0, isDefined: true }
54
- );
55
- }
56
- return Object.assign(
57
- [error, void 0, false],
58
- { error, data: void 0, isDefined: false }
59
- );
60
- }
61
- }
62
-
63
- export { DynamicLink, createORPCClient, isDefinedError, safe };
65
+ export { DynamicLink, createORPCClient, isDefinedError, resolveFriendlyClientOptions, safe };
@@ -1,12 +1,119 @@
1
- import { C as ClientPlugin, S as StandardLinkOptions } from '../shared/client.DrOAzyMB.mjs';
2
- export { a as CompositeClientPlugin } from '../shared/client.DrOAzyMB.mjs';
3
- import { Value } from '@orpc/shared';
4
- import { C as ClientOptionsOut, a as ClientContext } from '../shared/client.CupM8eRP.mjs';
5
- import '@orpc/standard-server';
1
+ import { Value, Promisable } from '@orpc/shared';
2
+ import { StandardHeaders, StandardRequest } from '@orpc/standard-server';
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.BMoG_EdN.mjs';
5
+ import { a as ClientContext } from '../shared/client.4TS_0JaO.mjs';
6
6
 
7
- interface ClientRetryPluginAttemptOptions {
8
- eventIteratorLastRetry: number | undefined;
9
- eventIteratorLastEventId: string | undefined;
7
+ interface BatchLinkPluginGroup<T extends ClientContext> {
8
+ condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
9
+ context: T;
10
+ path?: readonly string[];
11
+ input?: unknown;
12
+ }
13
+ interface BatchLinkPluginOptions<T extends ClientContext> {
14
+ groups: readonly [BatchLinkPluginGroup<T>, ...BatchLinkPluginGroup<T>[]];
15
+ /**
16
+ * The maximum number of requests in the batch.
17
+ *
18
+ * @default 10
19
+ */
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>[]]]>;
27
+ /**
28
+ * Defines the URL to use for the batch request.
29
+ *
30
+ * @default the URL of the first request in the batch + '/__batch__'
31
+ */
32
+ url?: Value<Promisable<string | URL>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
33
+ /**
34
+ * The maximum length of the URL.
35
+ *
36
+ * @default 2083
37
+ */
38
+ maxUrlLength?: Value<Promisable<number>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
39
+ /**
40
+ * Defines the HTTP headers to use for the batch request.
41
+ *
42
+ * @default The same headers of all requests in the batch
43
+ */
44
+ headers?: Value<Promisable<StandardHeaders>, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
45
+ /**
46
+ * Map the batch request items before sending them.
47
+ *
48
+ * @default Removes headers that are duplicated in the batch headers.
49
+ */
50
+ mapRequestItem?: (options: StandardLinkClientInterceptorOptions<T> & {
51
+ batchUrl: URL;
52
+ batchHeaders: StandardHeaders;
53
+ }) => StandardRequest;
54
+ /**
55
+ * Exclude a request from the batch.
56
+ *
57
+ * @default () => false
58
+ */
59
+ exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
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
+ */
67
+ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
68
+ #private;
69
+ private readonly groups;
70
+ private readonly maxSize;
71
+ private readonly batchUrl;
72
+ private readonly maxUrlLength;
73
+ private readonly batchHeaders;
74
+ private readonly mapRequestItem;
75
+ private readonly exclude;
76
+ private readonly mode;
77
+ private pending;
78
+ order: number;
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>>);
112
+ init(options: StandardLinkOptions<T>): void;
113
+ }
114
+
115
+ interface ClientRetryPluginAttemptOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
116
+ lastEventRetry: number | undefined;
10
117
  attemptIndex: number;
11
118
  error: unknown;
12
119
  }
@@ -17,40 +124,35 @@ interface ClientRetryPluginContext {
17
124
  *
18
125
  * @default 0
19
126
  */
20
- retry?: number;
127
+ retry?: Value<Promisable<number>, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
21
128
  /**
22
129
  * Delay (in ms) before retrying.
23
130
  *
24
- * @default (o) => o.eventIteratorLastRetry ?? 2000
131
+ * @default (o) => o.lastEventRetry ?? 2000
25
132
  */
26
- retryDelay?: Value<number, [
27
- attemptOptions: ClientRetryPluginAttemptOptions,
28
- clientOptions: ClientOptionsOut<ClientRetryPluginContext>,
29
- path: readonly string[],
30
- input: unknown
31
- ]>;
133
+ retryDelay?: Value<Promisable<number>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
32
134
  /**
33
135
  * Determine should retry or not.
34
136
  *
35
137
  * @default true
36
138
  */
37
- shouldRetry?: Value<boolean, [
38
- attemptOptions: ClientRetryPluginAttemptOptions,
39
- clientOptions: ClientOptionsOut<ClientRetryPluginContext>,
40
- path: readonly string[],
41
- input: unknown
42
- ]>;
139
+ shouldRetry?: Value<Promisable<boolean>, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
43
140
  /**
44
141
  * The hook called when retrying, and return the unsubscribe function.
45
142
  */
46
- onRetry?: (options: ClientRetryPluginAttemptOptions, clientOptions: ClientOptionsOut<ClientRetryPluginContext>, path: readonly string[], input: unknown) => void | (() => void);
143
+ onRetry?: (options: ClientRetryPluginAttemptOptions<ClientRetryPluginContext>) => void | ((isSuccess: boolean) => void);
47
144
  }
48
145
  declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
49
146
  }
50
147
  interface ClientRetryPluginOptions {
51
148
  default?: ClientRetryPluginContext;
52
149
  }
53
- declare class ClientRetryPlugin<T extends ClientContext & ClientRetryPluginContext> implements ClientPlugin<T> {
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
+ */
155
+ declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements StandardLinkPlugin<T> {
54
156
  private readonly defaultRetry;
55
157
  private readonly defaultRetryDelay;
56
158
  private readonly defaultShouldRetry;
@@ -59,4 +161,42 @@ declare class ClientRetryPlugin<T extends ClientContext & ClientRetryPluginConte
59
161
  init(options: StandardLinkOptions<T>): void;
60
162
  }
61
163
 
62
- export { ClientPlugin, ClientRetryPlugin, type ClientRetryPluginAttemptOptions, type ClientRetryPluginContext, ClientRetryPluginInvalidEventIteratorRetryResponse, type ClientRetryPluginOptions };
164
+ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
165
+ /**
166
+ * The name of the header to check.
167
+ *
168
+ * @default 'x-csrf-token'
169
+ */
170
+ headerName?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
171
+ /**
172
+ * The value of the header to check.
173
+ *
174
+ * @default 'orpc'
175
+ *
176
+ */
177
+ headerValue?: Value<Promisable<string>, [options: StandardLinkClientInterceptorOptions<T>]>;
178
+ /**
179
+ * Exclude a procedure from the plugin.
180
+ *
181
+ * @default false
182
+ */
183
+ exclude?: Value<Promisable<boolean>, [options: StandardLinkClientInterceptorOptions<T>]>;
184
+ }
185
+ /**
186
+ * This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
187
+ * It helps ensure that requests to your procedures originate from JavaScript code,
188
+ * not from other sources like standard HTML forms or direct browser navigation.
189
+ *
190
+ * @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
191
+ */
192
+ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
193
+ private readonly headerName;
194
+ private readonly headerValue;
195
+ private readonly exclude;
196
+ constructor(options?: SimpleCsrfProtectionLinkPluginOptions<T>);
197
+ order: number;
198
+ init(options: StandardLinkOptions<T>): void;
199
+ }
200
+
201
+ export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, DedupeRequestsPlugin, SimpleCsrfProtectionLinkPlugin };
202
+ export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, DedupeRequestsPluginGroup, DedupeRequestsPluginOptions, SimpleCsrfProtectionLinkPluginOptions };