@orpc/client 0.0.0-next.a246703 → 0.0.0-next.a2b3a55

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -53,6 +53,7 @@ You can find the full documentation [here](https://orpc.unnoq.com).
53
53
  - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
54
54
  - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
55
55
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
56
+ - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
56
57
  - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
57
58
  - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).
58
59
  - [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
@@ -1,12 +1,14 @@
1
1
  import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
2
  import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
3
- import { a as ClientContext, b as ClientOptions } from '../../shared/client.87WXDX8t.mjs';
4
- import { d as StandardLinkClient, b as StandardLink } from '../../shared/client.D9lmRwGB.mjs';
5
- import { f as StandardRPCLinkOptions } from '../../shared/client.BC0T26HA.mjs';
3
+ import { a as ClientContext, b as ClientOptions } from '../../shared/client.CipPQkhk.mjs';
4
+ import { f as StandardLinkClient } from '../../shared/client.FXep-a3a.mjs';
5
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.BjJBZryq.mjs';
6
6
  import '@orpc/shared';
7
7
 
8
8
  interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
9
- fetch?: (request: Request, init: Record<never, never>, options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
9
+ fetch?: (request: Request, init: {
10
+ redirect?: Request['redirect'];
11
+ }, options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
10
12
  }
11
13
  declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
12
14
  private readonly fetch;
@@ -17,12 +19,9 @@ declare class LinkFetchClient<T extends ClientContext> implements StandardLinkCl
17
19
 
18
20
  interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
19
21
  }
20
- declare class RPCLink<T extends ClientContext> extends StandardLink<T> {
22
+ declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
21
23
  constructor(options: RPCLinkOptions<T>);
22
24
  }
23
25
 
24
- interface FetchWithContext<TClientContext extends ClientContext> {
25
- (url: URL, init: RequestInit, options: ClientOptions<TClientContext>, path: readonly string[], input: unknown): Promise<Response>;
26
- }
27
-
28
- export { type FetchWithContext, LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
26
+ export { LinkFetchClient, RPCLink };
27
+ export type { LinkFetchClientOptions, RPCLinkOptions };
@@ -1,12 +1,14 @@
1
1
  import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
2
  import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
3
- import { a as ClientContext, b as ClientOptions } from '../../shared/client.87WXDX8t.js';
4
- import { d as StandardLinkClient, b as StandardLink } from '../../shared/client.BaocqKnn.js';
5
- import { f as StandardRPCLinkOptions } from '../../shared/client.CZFIVTQj.js';
3
+ import { a as ClientContext, b as ClientOptions } from '../../shared/client.CipPQkhk.js';
4
+ import { f as StandardLinkClient } from '../../shared/client.C9U9n1f3.js';
5
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.8TjrVhkC.js';
6
6
  import '@orpc/shared';
7
7
 
8
8
  interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
9
- fetch?: (request: Request, init: Record<never, never>, options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
9
+ fetch?: (request: Request, init: {
10
+ redirect?: Request['redirect'];
11
+ }, options: ClientOptions<T>, path: readonly string[], input: unknown) => Promise<Response>;
10
12
  }
11
13
  declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
12
14
  private readonly fetch;
@@ -17,12 +19,9 @@ declare class LinkFetchClient<T extends ClientContext> implements StandardLinkCl
17
19
 
18
20
  interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
19
21
  }
20
- declare class RPCLink<T extends ClientContext> extends StandardLink<T> {
22
+ declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
21
23
  constructor(options: RPCLinkOptions<T>);
22
24
  }
23
25
 
24
- interface FetchWithContext<TClientContext extends ClientContext> {
25
- (url: URL, init: RequestInit, options: ClientOptions<TClientContext>, path: readonly string[], input: unknown): Promise<Response>;
26
- }
27
-
28
- export { type FetchWithContext, LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
26
+ export { LinkFetchClient, RPCLink };
27
+ export type { LinkFetchClientOptions, RPCLinkOptions };
@@ -1,8 +1,8 @@
1
1
  import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch';
2
- import { S as StandardLink, b as StandardRPCJsonSerializer, c as StandardRPCLinkCodec, d as StandardRPCSerializer } from '../../shared/client._CYwsI7p.mjs';
3
2
  import '@orpc/shared';
3
+ import { c as StandardRPCLink } from '../../shared/client.DpICn1BD.mjs';
4
4
  import '@orpc/standard-server';
5
- import '../../shared/client.0FH21c3Z.mjs';
5
+ import '../../shared/client.CRWEpqLB.mjs';
6
6
 
7
7
  class LinkFetchClient {
8
8
  fetch;
@@ -13,19 +13,16 @@ class LinkFetchClient {
13
13
  }
14
14
  async call(request, options, path, input) {
15
15
  const fetchRequest = toFetchRequest(request, this.toFetchRequestOptions);
16
- const fetchResponse = await this.fetch(fetchRequest, {}, options, path, input);
16
+ const fetchResponse = await this.fetch(fetchRequest, { redirect: "manual" }, options, path, input);
17
17
  const lazyResponse = toStandardLazyResponse(fetchResponse);
18
18
  return lazyResponse;
19
19
  }
20
20
  }
21
21
 
22
- class RPCLink extends StandardLink {
22
+ class RPCLink extends StandardRPCLink {
23
23
  constructor(options) {
24
- const jsonSerializer = new StandardRPCJsonSerializer(options);
25
- const serializer = new StandardRPCSerializer(jsonSerializer);
26
- const linkCodec = new StandardRPCLinkCodec(serializer, options);
27
24
  const linkClient = new LinkFetchClient(options);
28
- super(linkCodec, linkClient, options);
25
+ super(linkClient, options);
29
26
  }
30
27
  }
31
28
 
@@ -1,9 +1,10 @@
1
- export { I as InvalidEventIteratorRetryResponse, b as StandardLink, d as StandardLinkClient, c as StandardLinkCodec, a as StandardLinkOptions, S as StandardLinkPlugin } from '../../shared/client.D9lmRwGB.mjs';
2
- export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, h as StandardRPCLinkCodec, g as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, i as StandardRPCSerializer } from '../../shared/client.BC0T26HA.mjs';
3
- import { H as HTTPPath } from '../../shared/client.87WXDX8t.mjs';
1
+ export { C as CompositeStandardLinkPlugin, d as StandardLink, f as StandardLinkClient, S as StandardLinkClientInterceptorOptions, e as StandardLinkCodec, c as StandardLinkInterceptorOptions, b as StandardLinkOptions, a as StandardLinkPlugin } from '../../shared/client.FXep-a3a.mjs';
2
+ export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, g as StandardRPCLink, i as StandardRPCLinkCodec, h as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, j as StandardRPCSerializer } from '../../shared/client.BjJBZryq.mjs';
3
+ import { H as HTTPPath } from '../../shared/client.CipPQkhk.mjs';
4
4
  import '@orpc/shared';
5
5
  import '@orpc/standard-server';
6
6
 
7
7
  declare function toHttpPath(path: readonly string[]): HTTPPath;
8
+ declare function getMalformedResponseErrorCode(status: number): string;
8
9
 
9
- export { toHttpPath };
10
+ export { getMalformedResponseErrorCode, toHttpPath };
@@ -1,9 +1,10 @@
1
- export { I as InvalidEventIteratorRetryResponse, b as StandardLink, d as StandardLinkClient, c as StandardLinkCodec, a as StandardLinkOptions, S as StandardLinkPlugin } from '../../shared/client.BaocqKnn.js';
2
- export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, h as StandardRPCLinkCodec, g as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, i as StandardRPCSerializer } from '../../shared/client.CZFIVTQj.js';
3
- import { H as HTTPPath } from '../../shared/client.87WXDX8t.js';
1
+ export { C as CompositeStandardLinkPlugin, d as StandardLink, f as StandardLinkClient, S as StandardLinkClientInterceptorOptions, e as StandardLinkCodec, c as StandardLinkInterceptorOptions, b as StandardLinkOptions, a as StandardLinkPlugin } from '../../shared/client.C9U9n1f3.js';
2
+ export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, g as StandardRPCLink, i as StandardRPCLinkCodec, h as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, j as StandardRPCSerializer } from '../../shared/client.8TjrVhkC.js';
3
+ import { H as HTTPPath } from '../../shared/client.CipPQkhk.js';
4
4
  import '@orpc/shared';
5
5
  import '@orpc/standard-server';
6
6
 
7
7
  declare function toHttpPath(path: readonly string[]): HTTPPath;
8
+ declare function getMalformedResponseErrorCode(status: number): string;
8
9
 
9
- export { toHttpPath };
10
+ export { getMalformedResponseErrorCode, toHttpPath };
@@ -1,4 +1,4 @@
1
- export { I as InvalidEventIteratorRetryResponse, a as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, S as StandardLink, b as StandardRPCJsonSerializer, c as StandardRPCLinkCodec, d as StandardRPCSerializer, t as toHttpPath } from '../../shared/client._CYwsI7p.mjs';
1
+ export { C as CompositeStandardLinkPlugin, a as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, S as StandardLink, b as StandardRPCJsonSerializer, c as StandardRPCLink, d as StandardRPCLinkCodec, e as StandardRPCSerializer, g as getMalformedResponseErrorCode, t as toHttpPath } from '../../shared/client.DpICn1BD.mjs';
2
2
  import '@orpc/shared';
3
3
  import '@orpc/standard-server';
4
- import '../../shared/client.0FH21c3Z.mjs';
4
+ import '../../shared/client.CRWEpqLB.mjs';
package/dist/index.d.mts CHANGED
@@ -1,7 +1,7 @@
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 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';
5
5
  export { ErrorEvent } from '@orpc/standard-server';
6
6
 
7
7
  interface createORPCClientOptions {
@@ -120,32 +120,37 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
120
120
  readonly data: TData;
121
121
  constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
122
122
  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
123
  }
126
124
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
127
125
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
128
126
  declare function toORPCError(error: unknown): ORPCError<any, any>;
127
+ declare function isORPCErrorStatus(status: number): boolean;
128
+ declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
129
+ declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
129
130
 
130
131
  declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
131
132
  value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
132
133
  error: (error: unknown) => Promise<unknown>;
133
134
  }): AsyncGenerator<TMap, TMap, TNext>;
134
135
 
135
- type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
136
+ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
136
137
  error: null;
137
138
  data: TOutput;
138
139
  isDefined: false;
139
- } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false] & {
140
+ isSuccess: true;
141
+ } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
140
142
  error: Exclude<TError, ORPCError<any, any>>;
141
143
  data: undefined;
142
144
  isDefined: false;
143
- } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true] & {
145
+ isSuccess: false;
146
+ } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
144
147
  error: Extract<TError, ORPCError<any, any>>;
145
148
  data: undefined;
146
149
  isDefined: true;
150
+ isSuccess: false;
147
151
  };
148
- declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
152
+ declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
149
153
  declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
150
154
 
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 };
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 };
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
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 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';
5
5
  export { ErrorEvent } from '@orpc/standard-server';
6
6
 
7
7
  interface createORPCClientOptions {
@@ -120,32 +120,37 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
120
120
  readonly data: TData;
121
121
  constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
122
122
  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
123
  }
126
124
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
127
125
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
128
126
  declare function toORPCError(error: unknown): ORPCError<any, any>;
127
+ declare function isORPCErrorStatus(status: number): boolean;
128
+ declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
129
+ declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
129
130
 
130
131
  declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
131
132
  value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
132
133
  error: (error: unknown) => Promise<unknown>;
133
134
  }): AsyncGenerator<TMap, TMap, TNext>;
134
135
 
135
- type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
136
+ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
136
137
  error: null;
137
138
  data: TOutput;
138
139
  isDefined: false;
139
- } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false] & {
140
+ isSuccess: true;
141
+ } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
140
142
  error: Exclude<TError, ORPCError<any, any>>;
141
143
  data: undefined;
142
144
  isDefined: false;
143
- } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true] & {
145
+ isSuccess: false;
146
+ } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
144
147
  error: Extract<TError, ORPCError<any, any>>;
145
148
  data: undefined;
146
149
  isDefined: true;
150
+ isSuccess: false;
147
151
  };
148
- declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
152
+ declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
149
153
  declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
150
154
 
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 };
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 };
package/dist/index.mjs CHANGED
@@ -1,5 +1,5 @@
1
- import { i as isDefinedError } from './shared/client.0FH21c3Z.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.0FH21c3Z.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
 
@@ -7,20 +7,20 @@ async function safe(promise) {
7
7
  try {
8
8
  const output = await promise;
9
9
  return Object.assign(
10
- [null, output, false],
11
- { error: null, data: output, isDefined: false }
10
+ [null, output, false, true],
11
+ { error: null, data: output, isDefined: false, isSuccess: true }
12
12
  );
13
13
  } catch (e) {
14
14
  const error = e;
15
15
  if (isDefinedError(error)) {
16
16
  return Object.assign(
17
- [error, void 0, true],
18
- { error, data: void 0, isDefined: true }
17
+ [error, void 0, true, false],
18
+ { error, data: void 0, isDefined: true, isSuccess: false }
19
19
  );
20
20
  }
21
21
  return Object.assign(
22
- [error, void 0, false],
23
- { error, data: void 0, isDefined: false }
22
+ [error, void 0, false, false],
23
+ { error, data: void 0, isDefined: false, isSuccess: false }
24
24
  );
25
25
  }
26
26
  }
@@ -1,11 +1,73 @@
1
1
  import { Value } from '@orpc/shared';
2
- import { S as StandardLinkPlugin, a as StandardLinkOptions } from '../shared/client.D9lmRwGB.mjs';
3
- import { b as ClientOptions } from '../shared/client.87WXDX8t.mjs';
4
- import '@orpc/standard-server';
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';
5
5
 
6
- interface ClientRetryPluginAttemptOptions {
6
+ interface BatchLinkPluginGroup<T extends ClientContext> {
7
+ condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
8
+ context: T;
9
+ path?: readonly string[];
10
+ input?: unknown;
11
+ }
12
+ interface BatchLinkPluginOptions<T extends ClientContext> {
13
+ groups: readonly [BatchLinkPluginGroup<T>, ...BatchLinkPluginGroup<T>[]];
14
+ /**
15
+ * The maximum number of requests in the batch.
16
+ *
17
+ * @default 10
18
+ */
19
+ maxSize?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
20
+ /**
21
+ * Defines the URL to use for the batch request.
22
+ *
23
+ * @default the URL of the first request in the batch + '/__batch__'
24
+ */
25
+ url?: Value<string | URL, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
26
+ /**
27
+ * The maximum length of the URL.
28
+ *
29
+ * @default 2083
30
+ */
31
+ maxUrlLength?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
32
+ /**
33
+ * Defines the HTTP headers to use for the batch request.
34
+ *
35
+ * @default The same headers of all requests in the batch
36
+ */
37
+ headers?: Value<StandardHeaders, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
38
+ /**
39
+ * Map the batch request items before sending them.
40
+ *
41
+ * @default Removes headers that are duplicated in the batch headers.
42
+ */
43
+ mapRequestItem?: (options: StandardLinkClientInterceptorOptions<T> & {
44
+ batchUrl: URL;
45
+ batchHeaders: StandardHeaders;
46
+ }) => StandardRequest;
47
+ /**
48
+ * Exclude a request from the batch.
49
+ *
50
+ * @default () => false
51
+ */
52
+ exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
53
+ }
54
+ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
55
+ #private;
56
+ private readonly groups;
57
+ private readonly maxSize;
58
+ private readonly batchUrl;
59
+ private readonly maxUrlLength;
60
+ private readonly batchHeaders;
61
+ private readonly mapRequestItem;
62
+ private readonly exclude;
63
+ private pending;
64
+ order: number;
65
+ constructor(options: BatchLinkPluginOptions<T>);
66
+ init(options: StandardLinkOptions<T>): void;
67
+ }
68
+
69
+ interface ClientRetryPluginAttemptOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
7
70
  lastEventRetry: number | undefined;
8
- lastEventId: string | undefined;
9
71
  attemptIndex: number;
10
72
  error: unknown;
11
73
  }
@@ -16,33 +78,23 @@ interface ClientRetryPluginContext {
16
78
  *
17
79
  * @default 0
18
80
  */
19
- retry?: number;
81
+ retry?: Value<number, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
20
82
  /**
21
83
  * Delay (in ms) before retrying.
22
84
  *
23
85
  * @default (o) => o.lastEventRetry ?? 2000
24
86
  */
25
- retryDelay?: Value<number, [
26
- attemptOptions: ClientRetryPluginAttemptOptions,
27
- clientOptions: ClientOptions<ClientRetryPluginContext>,
28
- path: readonly string[],
29
- input: unknown
30
- ]>;
87
+ retryDelay?: Value<number, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
31
88
  /**
32
89
  * Determine should retry or not.
33
90
  *
34
91
  * @default true
35
92
  */
36
- shouldRetry?: Value<boolean, [
37
- attemptOptions: ClientRetryPluginAttemptOptions,
38
- clientOptions: ClientOptions<ClientRetryPluginContext>,
39
- path: readonly string[],
40
- input: unknown
41
- ]>;
93
+ shouldRetry?: Value<boolean, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
42
94
  /**
43
95
  * The hook called when retrying, and return the unsubscribe function.
44
96
  */
45
- onRetry?: (options: ClientRetryPluginAttemptOptions, clientOptions: ClientOptions<ClientRetryPluginContext>, path: readonly string[], input: unknown) => void | (() => void);
97
+ onRetry?: (options: ClientRetryPluginAttemptOptions<ClientRetryPluginContext>) => void | ((isSuccess: boolean) => void);
46
98
  }
47
99
  declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
48
100
  }
@@ -58,4 +110,35 @@ declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements S
58
110
  init(options: StandardLinkOptions<T>): void;
59
111
  }
60
112
 
61
- export { ClientRetryPlugin, type ClientRetryPluginAttemptOptions, type ClientRetryPluginContext, ClientRetryPluginInvalidEventIteratorRetryResponse, type ClientRetryPluginOptions };
113
+ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
114
+ /**
115
+ * The name of the header to check.
116
+ *
117
+ * @default 'x-csrf-token'
118
+ */
119
+ headerName?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
120
+ /**
121
+ * The value of the header to check.
122
+ *
123
+ * @default 'orpc'
124
+ *
125
+ */
126
+ headerValue?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
127
+ /**
128
+ * Exclude a procedure from the plugin.
129
+ *
130
+ * @default false
131
+ */
132
+ exclude?: Value<boolean, [options: StandardLinkClientInterceptorOptions<T>]>;
133
+ }
134
+ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
135
+ private readonly headerName;
136
+ private readonly headerValue;
137
+ private readonly exclude;
138
+ constructor(options?: SimpleCsrfProtectionLinkPluginOptions<T>);
139
+ order: number;
140
+ init(options: StandardLinkOptions<T>): void;
141
+ }
142
+
143
+ export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
144
+ export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
@@ -1,11 +1,73 @@
1
1
  import { Value } from '@orpc/shared';
2
- import { S as StandardLinkPlugin, a as StandardLinkOptions } from '../shared/client.BaocqKnn.js';
3
- import { b as ClientOptions } from '../shared/client.87WXDX8t.js';
4
- import '@orpc/standard-server';
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.C9U9n1f3.js';
4
+ import { a as ClientContext } from '../shared/client.CipPQkhk.js';
5
5
 
6
- interface ClientRetryPluginAttemptOptions {
6
+ interface BatchLinkPluginGroup<T extends ClientContext> {
7
+ condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
8
+ context: T;
9
+ path?: readonly string[];
10
+ input?: unknown;
11
+ }
12
+ interface BatchLinkPluginOptions<T extends ClientContext> {
13
+ groups: readonly [BatchLinkPluginGroup<T>, ...BatchLinkPluginGroup<T>[]];
14
+ /**
15
+ * The maximum number of requests in the batch.
16
+ *
17
+ * @default 10
18
+ */
19
+ maxSize?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
20
+ /**
21
+ * Defines the URL to use for the batch request.
22
+ *
23
+ * @default the URL of the first request in the batch + '/__batch__'
24
+ */
25
+ url?: Value<string | URL, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
26
+ /**
27
+ * The maximum length of the URL.
28
+ *
29
+ * @default 2083
30
+ */
31
+ maxUrlLength?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
32
+ /**
33
+ * Defines the HTTP headers to use for the batch request.
34
+ *
35
+ * @default The same headers of all requests in the batch
36
+ */
37
+ headers?: Value<StandardHeaders, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
38
+ /**
39
+ * Map the batch request items before sending them.
40
+ *
41
+ * @default Removes headers that are duplicated in the batch headers.
42
+ */
43
+ mapRequestItem?: (options: StandardLinkClientInterceptorOptions<T> & {
44
+ batchUrl: URL;
45
+ batchHeaders: StandardHeaders;
46
+ }) => StandardRequest;
47
+ /**
48
+ * Exclude a request from the batch.
49
+ *
50
+ * @default () => false
51
+ */
52
+ exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
53
+ }
54
+ declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
55
+ #private;
56
+ private readonly groups;
57
+ private readonly maxSize;
58
+ private readonly batchUrl;
59
+ private readonly maxUrlLength;
60
+ private readonly batchHeaders;
61
+ private readonly mapRequestItem;
62
+ private readonly exclude;
63
+ private pending;
64
+ order: number;
65
+ constructor(options: BatchLinkPluginOptions<T>);
66
+ init(options: StandardLinkOptions<T>): void;
67
+ }
68
+
69
+ interface ClientRetryPluginAttemptOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
7
70
  lastEventRetry: number | undefined;
8
- lastEventId: string | undefined;
9
71
  attemptIndex: number;
10
72
  error: unknown;
11
73
  }
@@ -16,33 +78,23 @@ interface ClientRetryPluginContext {
16
78
  *
17
79
  * @default 0
18
80
  */
19
- retry?: number;
81
+ retry?: Value<number, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
20
82
  /**
21
83
  * Delay (in ms) before retrying.
22
84
  *
23
85
  * @default (o) => o.lastEventRetry ?? 2000
24
86
  */
25
- retryDelay?: Value<number, [
26
- attemptOptions: ClientRetryPluginAttemptOptions,
27
- clientOptions: ClientOptions<ClientRetryPluginContext>,
28
- path: readonly string[],
29
- input: unknown
30
- ]>;
87
+ retryDelay?: Value<number, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
31
88
  /**
32
89
  * Determine should retry or not.
33
90
  *
34
91
  * @default true
35
92
  */
36
- shouldRetry?: Value<boolean, [
37
- attemptOptions: ClientRetryPluginAttemptOptions,
38
- clientOptions: ClientOptions<ClientRetryPluginContext>,
39
- path: readonly string[],
40
- input: unknown
41
- ]>;
93
+ shouldRetry?: Value<boolean, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
42
94
  /**
43
95
  * The hook called when retrying, and return the unsubscribe function.
44
96
  */
45
- onRetry?: (options: ClientRetryPluginAttemptOptions, clientOptions: ClientOptions<ClientRetryPluginContext>, path: readonly string[], input: unknown) => void | (() => void);
97
+ onRetry?: (options: ClientRetryPluginAttemptOptions<ClientRetryPluginContext>) => void | ((isSuccess: boolean) => void);
46
98
  }
47
99
  declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
48
100
  }
@@ -58,4 +110,35 @@ declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements S
58
110
  init(options: StandardLinkOptions<T>): void;
59
111
  }
60
112
 
61
- export { ClientRetryPlugin, type ClientRetryPluginAttemptOptions, type ClientRetryPluginContext, ClientRetryPluginInvalidEventIteratorRetryResponse, type ClientRetryPluginOptions };
113
+ interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
114
+ /**
115
+ * The name of the header to check.
116
+ *
117
+ * @default 'x-csrf-token'
118
+ */
119
+ headerName?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
120
+ /**
121
+ * The value of the header to check.
122
+ *
123
+ * @default 'orpc'
124
+ *
125
+ */
126
+ headerValue?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
127
+ /**
128
+ * Exclude a procedure from the plugin.
129
+ *
130
+ * @default false
131
+ */
132
+ exclude?: Value<boolean, [options: StandardLinkClientInterceptorOptions<T>]>;
133
+ }
134
+ declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
135
+ private readonly headerName;
136
+ private readonly headerValue;
137
+ private readonly exclude;
138
+ constructor(options?: SimpleCsrfProtectionLinkPluginOptions<T>);
139
+ order: number;
140
+ init(options: StandardLinkOptions<T>): void;
141
+ }
142
+
143
+ export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
144
+ export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, SimpleCsrfProtectionLinkPluginOptions };