@orpc/client 0.0.0-next.d16a1b6 → 0.0.0-next.d17ef5e

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
@@ -32,7 +32,7 @@
32
32
  - **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
33
33
  - **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
34
34
  - **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
35
- - **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue), Pinia Colada, and more.
35
+ - **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
36
36
  - **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
37
37
  - **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
38
38
  - **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
@@ -55,9 +55,13 @@ You can find the full documentation [here](https://orpc.unnoq.com).
55
55
  - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
56
56
  - [@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
57
  - [@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
+ - [@orpc/solid-query](https://www.npmjs.com/package/@orpc/solid-query): Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview).
59
+ - [@orpc/svelte-query](https://www.npmjs.com/package/@orpc/svelte-query): Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview).
58
60
  - [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
59
61
  - [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
60
62
  - [@orpc/zod](https://www.npmjs.com/package/@orpc/zod): More schemas that [Zod](https://zod.dev/) doesn't support yet.
63
+ - [@orpc/valibot](https://www.npmjs.com/package/@orpc/valibot): OpenAPI spec generation from [Valibot](https://valibot.dev/).
64
+ - [@orpc/arktype](https://www.npmjs.com/package/@orpc/arktype): OpenAPI spec generation from [ArkType](https://arktype.io/).
61
65
 
62
66
  ## `@orpc/client`
63
67
 
@@ -83,6 +87,14 @@ const client: RouterClient<typeof router> = createORPCClient(link)
83
87
  const client: ContractRouterClient<typeof contract> = createORPCClient(link)
84
88
  ```
85
89
 
90
+ ## Sponsors
91
+
92
+ <p align="center">
93
+ <a href="https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg">
94
+ <img src='https://cdn.jsdelivr.net/gh/unnoq/unnoq/sponsors.svg'/>
95
+ </a>
96
+ </p>
97
+
86
98
  ## License
87
99
 
88
100
  Distributed under the MIT License. See [LICENSE](https://github.com/unnoq/orpc/blob/main/LICENSE) for more information.
@@ -1,29 +1,30 @@
1
- import { C as ClientContext, a as ClientOptionsOut, b as ClientLink } from '../../shared/client.D_CzLDyB.mjs';
2
- import { StandardLinkClient, StandardLinkOptions, StandardRPCLinkCodecOptions, StandardRPCLinkCodec } from '../standard/index.mjs';
3
1
  import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
+ import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
3
+ import { a as ClientContext, C as ClientOptions, b as ClientLink } from '../../shared/client.RZs5Myak.mjs';
4
+ import { b as StandardLinkClient } from '../../shared/client.CKw2tbcl.mjs';
5
+ import { StandardRPCLinkOptions } from '../standard/index.mjs';
4
6
  import '@orpc/shared';
5
7
 
6
- interface LinkFetchClientOptions<T extends ClientContext> {
7
- fetch?: (request: Request, init: Record<never, never>, options: ClientOptionsOut<T>, path: readonly string[], input: unknown) => Promise<Response>;
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>;
8
10
  }
9
11
  declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
10
12
  private readonly fetch;
13
+ private readonly toFetchRequestOptions;
11
14
  constructor(options: LinkFetchClientOptions<T>);
12
- call(request: StandardRequest, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
15
+ call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
13
16
  }
14
17
 
15
- interface RPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, LinkFetchClientOptions<T> {
16
- linkCodec?: StandardRPCLinkCodec<T>;
17
- linkClient?: LinkFetchClient<T>;
18
+ interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
18
19
  }
19
20
  declare class RPCLink<T extends ClientContext> implements ClientLink<T> {
20
21
  private readonly standardLink;
21
22
  constructor(options: RPCLinkOptions<T>);
22
- call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
23
+ call(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<unknown>;
23
24
  }
24
25
 
25
26
  interface FetchWithContext<TClientContext extends ClientContext> {
26
- (url: URL, init: RequestInit, options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown): Promise<Response>;
27
+ (url: URL, init: RequestInit, options: ClientOptions<TClientContext>, path: readonly string[], input: unknown): Promise<Response>;
27
28
  }
28
29
 
29
- export { type FetchWithContext, RPCLink, type RPCLinkOptions };
30
+ export { type FetchWithContext, LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
@@ -1,29 +1,30 @@
1
- import { C as ClientContext, a as ClientOptionsOut, b as ClientLink } from '../../shared/client.D_CzLDyB.js';
2
- import { StandardLinkClient, StandardLinkOptions, StandardRPCLinkCodecOptions, StandardRPCLinkCodec } from '../standard/index.js';
3
1
  import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
+ import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
3
+ import { a as ClientContext, C as ClientOptions, b as ClientLink } from '../../shared/client.RZs5Myak.js';
4
+ import { b as StandardLinkClient } from '../../shared/client.Bt40CWA-.js';
5
+ import { StandardRPCLinkOptions } from '../standard/index.js';
4
6
  import '@orpc/shared';
5
7
 
6
- interface LinkFetchClientOptions<T extends ClientContext> {
7
- fetch?: (request: Request, init: Record<never, never>, options: ClientOptionsOut<T>, path: readonly string[], input: unknown) => Promise<Response>;
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>;
8
10
  }
9
11
  declare class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
10
12
  private readonly fetch;
13
+ private readonly toFetchRequestOptions;
11
14
  constructor(options: LinkFetchClientOptions<T>);
12
- call(request: StandardRequest, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
15
+ call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
13
16
  }
14
17
 
15
- interface RPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, LinkFetchClientOptions<T> {
16
- linkCodec?: StandardRPCLinkCodec<T>;
17
- linkClient?: LinkFetchClient<T>;
18
+ interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
18
19
  }
19
20
  declare class RPCLink<T extends ClientContext> implements ClientLink<T> {
20
21
  private readonly standardLink;
21
22
  constructor(options: RPCLinkOptions<T>);
22
- call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
23
+ call(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<unknown>;
23
24
  }
24
25
 
25
26
  interface FetchWithContext<TClientContext extends ClientContext> {
26
- (url: URL, init: RequestInit, options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown): Promise<Response>;
27
+ (url: URL, init: RequestInit, options: ClientOptions<TClientContext>, path: readonly string[], input: unknown): Promise<Response>;
27
28
  }
28
29
 
29
- export { type FetchWithContext, RPCLink, type RPCLinkOptions };
30
+ export { type FetchWithContext, LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
@@ -1,16 +1,18 @@
1
- import { a as StandardRPCLinkCodec, S as StandardLink } from '../../shared/client.MkoaGU3v.mjs';
1
+ import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch';
2
+ import { b as StandardRPCJsonSerializer, c as StandardRPCLinkCodec, d as StandardRPCSerializer, S as StandardLink } from '../../shared/client.B1XjLWRe.mjs';
2
3
  import '@orpc/shared';
4
+ import '../../shared/client.BacCdg3F.mjs';
3
5
  import '@orpc/standard-server';
4
- import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch';
5
- import '../../shared/client.DcaJQZfy.mjs';
6
6
 
7
7
  class LinkFetchClient {
8
8
  fetch;
9
+ toFetchRequestOptions;
9
10
  constructor(options) {
10
11
  this.fetch = options?.fetch ?? globalThis.fetch.bind(globalThis);
12
+ this.toFetchRequestOptions = options;
11
13
  }
12
14
  async call(request, options, path, input) {
13
- const fetchRequest = toFetchRequest(request);
15
+ const fetchRequest = toFetchRequest(request, this.toFetchRequestOptions);
14
16
  const fetchResponse = await this.fetch(fetchRequest, {}, options, path, input);
15
17
  const lazyResponse = toStandardLazyResponse(fetchResponse);
16
18
  return lazyResponse;
@@ -20,8 +22,10 @@ class LinkFetchClient {
20
22
  class RPCLink {
21
23
  standardLink;
22
24
  constructor(options) {
23
- const linkCodec = options.linkCodec ?? new StandardRPCLinkCodec(options);
24
- const linkClient = options.linkClient ?? new LinkFetchClient(options);
25
+ const jsonSerializer = new StandardRPCJsonSerializer(options);
26
+ const serializer = new StandardRPCSerializer(jsonSerializer);
27
+ const linkCodec = new StandardRPCLinkCodec(serializer, options);
28
+ const linkClient = new LinkFetchClient(options);
25
29
  this.standardLink = new StandardLink(linkCodec, linkClient, options);
26
30
  }
27
31
  async call(path, input, options) {
@@ -29,4 +33,4 @@ class RPCLink {
29
33
  }
30
34
  }
31
35
 
32
- export { RPCLink };
36
+ export { LinkFetchClient, RPCLink };
@@ -1,89 +1,43 @@
1
- import { Value, Interceptor, Segment } from '@orpc/shared';
2
- import { StandardRequest, StandardLazyResponse, StandardHeaders } from '@orpc/standard-server';
3
- import { C as ClientContext, a as ClientOptionsOut, E as EventIteratorReconnectOptions, b as ClientLink } from '../../shared/client.D_CzLDyB.mjs';
1
+ import { c as StandardLinkCodec, a as StandardLinkOptions } from '../../shared/client.CKw2tbcl.mjs';
2
+ export { I as InvalidEventIteratorRetryResponse, d as StandardLink, b as StandardLinkClient, S as StandardLinkPlugin } from '../../shared/client.CKw2tbcl.mjs';
3
+ import { Segment, Value } from '@orpc/shared';
4
+ import { a as ClientContext, C as ClientOptions } from '../../shared/client.RZs5Myak.mjs';
5
+ import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
4
6
 
5
- interface StandardLinkCodec<T extends ClientContext> {
6
- encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
7
- decode(response: StandardLazyResponse, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<unknown>;
7
+ declare const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES: {
8
+ readonly BIGINT: 0;
9
+ readonly DATE: 1;
10
+ readonly NAN: 2;
11
+ readonly UNDEFINED: 3;
12
+ readonly URL: 4;
13
+ readonly REGEXP: 5;
14
+ readonly SET: 6;
15
+ readonly MAP: 7;
16
+ };
17
+ type StandardRPCJsonSerializedMetaItem = readonly [type: number, ...path: Segment[]];
18
+ type StandardRPCJsonSerialized = [json: unknown, meta: StandardRPCJsonSerializedMetaItem[], maps: Segment[][], blobs: Blob[]];
19
+ interface StandardRPCCustomJsonSerializer {
20
+ type: number;
21
+ condition(data: unknown): boolean;
22
+ serialize(data: any): unknown;
23
+ deserialize(serialized: any): unknown;
8
24
  }
9
- interface StandardLinkClient<T extends ClientContext> {
10
- call(request: StandardRequest, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
25
+ interface StandardRPCJsonSerializerOptions {
26
+ customJsonSerializers?: readonly StandardRPCCustomJsonSerializer[];
11
27
  }
12
-
13
- declare class InvalidEventIteratorRetryResponse extends Error {
14
- }
15
- interface StandardLinkOptions<T extends ClientContext> {
16
- /**
17
- * Maximum number of retry attempts for event iterator errors before throwing.
18
- *
19
- * @default 5
20
- */
21
- eventIteratorMaxRetries?: Value<number, [
22
- reconnectOptions: EventIteratorReconnectOptions,
23
- options: ClientOptionsOut<T>,
24
- path: readonly string[],
25
- input: unknown
26
- ]>;
27
- /**
28
- * Delay (in ms) before retrying an event iterator call.
29
- *
30
- * @default (o) => o.lastRetry ?? (1000 * 2 ** o.retryTimes)
31
- */
32
- eventIteratorRetryDelay?: Value<number, [
33
- reconnectOptions: EventIteratorReconnectOptions,
34
- options: ClientOptionsOut<T>,
35
- path: readonly string[],
36
- input: unknown
37
- ]>;
38
- /**
39
- * Function to determine if an error is retryable.
40
- *
41
- * @default true
42
- */
43
- eventIteratorShouldRetry?: Value<boolean, [
44
- reconnectOptions: EventIteratorReconnectOptions,
45
- options: ClientOptionsOut<T>,
46
- path: readonly string[],
47
- input: unknown
48
- ]>;
49
- interceptors?: Interceptor<{
50
- path: readonly string[];
51
- input: unknown;
52
- options: ClientOptionsOut<T>;
53
- }, unknown, unknown>[];
54
- clientInterceptors?: Interceptor<{
55
- request: StandardRequest;
56
- }, StandardLazyResponse, unknown>[];
57
- }
58
- declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
59
- #private;
60
- readonly codec: StandardLinkCodec<T>;
61
- readonly sender: StandardLinkClient<T>;
62
- private readonly eventIteratorMaxRetries;
63
- private readonly eventIteratorRetryDelay;
64
- private readonly eventIteratorShouldRetry;
65
- private readonly interceptors;
66
- private readonly clientInterceptors;
67
- constructor(codec: StandardLinkCodec<T>, sender: StandardLinkClient<T>, options: StandardLinkOptions<T>);
68
- call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
69
- }
70
-
71
- type RPCJsonSerializedMeta = [
72
- 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7,
73
- Segment[]
74
- ][];
75
- type RPCJsonSerialized = [json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], blobs: Blob[]];
76
- declare class RPCJsonSerializer {
77
- serialize(data: unknown, segments?: Segment[], meta?: RPCJsonSerializedMeta, maps?: Segment[][], blobs?: Blob[]): RPCJsonSerialized;
78
- deserialize(json: unknown, meta: RPCJsonSerializedMeta): unknown;
79
- deserialize(json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], getBlob: (index: number) => Blob): unknown;
28
+ declare class StandardRPCJsonSerializer {
29
+ private readonly customSerializers;
30
+ constructor(options?: StandardRPCJsonSerializerOptions);
31
+ serialize(data: unknown, segments?: Segment[], meta?: StandardRPCJsonSerializedMetaItem[], maps?: Segment[][], blobs?: Blob[]): StandardRPCJsonSerialized;
32
+ deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[]): unknown;
33
+ deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[], maps: readonly Segment[][], getBlob: (index: number) => Blob): unknown;
80
34
  }
81
35
 
82
- declare class RPCSerializer {
36
+ declare class StandardRPCSerializer {
83
37
  #private;
84
38
  private readonly jsonSerializer;
85
- constructor(jsonSerializer?: RPCJsonSerializer);
86
- serialize(data: unknown): unknown;
39
+ constructor(jsonSerializer: StandardRPCJsonSerializer);
40
+ serialize(data: unknown): object;
87
41
  deserialize(data: unknown): unknown;
88
42
  }
89
43
 
@@ -93,7 +47,7 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
93
47
  * Base url for all requests.
94
48
  */
95
49
  url: Value<string | URL, [
96
- options: ClientOptionsOut<T>,
50
+ options: ClientOptions<T>,
97
51
  path: readonly string[],
98
52
  input: unknown
99
53
  ]>;
@@ -103,7 +57,7 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
103
57
  * @default 2083
104
58
  */
105
59
  maxUrlLength?: Value<number, [
106
- options: ClientOptionsOut<T>,
60
+ options: ClientOptions<T>,
107
61
  path: readonly string[],
108
62
  input: unknown
109
63
  ]>;
@@ -113,7 +67,7 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
113
67
  * @default 'POST'
114
68
  */
115
69
  method?: Value<HTTPMethod, [
116
- options: ClientOptionsOut<T>,
70
+ options: ClientOptions<T>,
117
71
  path: readonly string[],
118
72
  input: unknown
119
73
  ]>;
@@ -128,22 +82,24 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
128
82
  * Inject headers to the request.
129
83
  */
130
84
  headers?: Value<StandardHeaders, [
131
- options: ClientOptionsOut<T>,
85
+ options: ClientOptions<T>,
132
86
  path: readonly string[],
133
87
  input: unknown
134
88
  ]>;
135
- rpcSerializer?: RPCSerializer;
136
89
  }
137
90
  declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
91
+ private readonly serializer;
138
92
  private readonly baseUrl;
139
93
  private readonly maxUrlLength;
140
94
  private readonly fallbackMethod;
141
95
  private readonly expectedMethod;
142
96
  private readonly headers;
143
- private readonly rpcSerializer;
144
- constructor(options: StandardRPCLinkCodecOptions<T>);
145
- encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
97
+ constructor(serializer: StandardRPCSerializer, options: StandardRPCLinkCodecOptions<T>);
98
+ encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
146
99
  decode(response: StandardLazyResponse): Promise<unknown>;
147
100
  }
148
101
 
149
- export { InvalidEventIteratorRetryResponse, type RPCJsonSerialized, type RPCJsonSerializedMeta, RPCJsonSerializer, RPCSerializer, StandardLink, type StandardLinkClient, type StandardLinkCodec, type StandardLinkOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions };
102
+ interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
103
+ }
104
+
105
+ export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, StandardLinkCodec, StandardLinkOptions, type StandardRPCCustomJsonSerializer, type StandardRPCJsonSerialized, type StandardRPCJsonSerializedMetaItem, StandardRPCJsonSerializer, type StandardRPCJsonSerializerOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions, type StandardRPCLinkOptions, StandardRPCSerializer };
@@ -1,89 +1,43 @@
1
- import { Value, Interceptor, Segment } from '@orpc/shared';
2
- import { StandardRequest, StandardLazyResponse, StandardHeaders } from '@orpc/standard-server';
3
- import { C as ClientContext, a as ClientOptionsOut, E as EventIteratorReconnectOptions, b as ClientLink } from '../../shared/client.D_CzLDyB.js';
1
+ import { c as StandardLinkCodec, a as StandardLinkOptions } from '../../shared/client.Bt40CWA-.js';
2
+ export { I as InvalidEventIteratorRetryResponse, d as StandardLink, b as StandardLinkClient, S as StandardLinkPlugin } from '../../shared/client.Bt40CWA-.js';
3
+ import { Segment, Value } from '@orpc/shared';
4
+ import { a as ClientContext, C as ClientOptions } from '../../shared/client.RZs5Myak.js';
5
+ import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
4
6
 
5
- interface StandardLinkCodec<T extends ClientContext> {
6
- encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
7
- decode(response: StandardLazyResponse, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<unknown>;
7
+ declare const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES: {
8
+ readonly BIGINT: 0;
9
+ readonly DATE: 1;
10
+ readonly NAN: 2;
11
+ readonly UNDEFINED: 3;
12
+ readonly URL: 4;
13
+ readonly REGEXP: 5;
14
+ readonly SET: 6;
15
+ readonly MAP: 7;
16
+ };
17
+ type StandardRPCJsonSerializedMetaItem = readonly [type: number, ...path: Segment[]];
18
+ type StandardRPCJsonSerialized = [json: unknown, meta: StandardRPCJsonSerializedMetaItem[], maps: Segment[][], blobs: Blob[]];
19
+ interface StandardRPCCustomJsonSerializer {
20
+ type: number;
21
+ condition(data: unknown): boolean;
22
+ serialize(data: any): unknown;
23
+ deserialize(serialized: any): unknown;
8
24
  }
9
- interface StandardLinkClient<T extends ClientContext> {
10
- call(request: StandardRequest, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
25
+ interface StandardRPCJsonSerializerOptions {
26
+ customJsonSerializers?: readonly StandardRPCCustomJsonSerializer[];
11
27
  }
12
-
13
- declare class InvalidEventIteratorRetryResponse extends Error {
14
- }
15
- interface StandardLinkOptions<T extends ClientContext> {
16
- /**
17
- * Maximum number of retry attempts for event iterator errors before throwing.
18
- *
19
- * @default 5
20
- */
21
- eventIteratorMaxRetries?: Value<number, [
22
- reconnectOptions: EventIteratorReconnectOptions,
23
- options: ClientOptionsOut<T>,
24
- path: readonly string[],
25
- input: unknown
26
- ]>;
27
- /**
28
- * Delay (in ms) before retrying an event iterator call.
29
- *
30
- * @default (o) => o.lastRetry ?? (1000 * 2 ** o.retryTimes)
31
- */
32
- eventIteratorRetryDelay?: Value<number, [
33
- reconnectOptions: EventIteratorReconnectOptions,
34
- options: ClientOptionsOut<T>,
35
- path: readonly string[],
36
- input: unknown
37
- ]>;
38
- /**
39
- * Function to determine if an error is retryable.
40
- *
41
- * @default true
42
- */
43
- eventIteratorShouldRetry?: Value<boolean, [
44
- reconnectOptions: EventIteratorReconnectOptions,
45
- options: ClientOptionsOut<T>,
46
- path: readonly string[],
47
- input: unknown
48
- ]>;
49
- interceptors?: Interceptor<{
50
- path: readonly string[];
51
- input: unknown;
52
- options: ClientOptionsOut<T>;
53
- }, unknown, unknown>[];
54
- clientInterceptors?: Interceptor<{
55
- request: StandardRequest;
56
- }, StandardLazyResponse, unknown>[];
57
- }
58
- declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
59
- #private;
60
- readonly codec: StandardLinkCodec<T>;
61
- readonly sender: StandardLinkClient<T>;
62
- private readonly eventIteratorMaxRetries;
63
- private readonly eventIteratorRetryDelay;
64
- private readonly eventIteratorShouldRetry;
65
- private readonly interceptors;
66
- private readonly clientInterceptors;
67
- constructor(codec: StandardLinkCodec<T>, sender: StandardLinkClient<T>, options: StandardLinkOptions<T>);
68
- call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
69
- }
70
-
71
- type RPCJsonSerializedMeta = [
72
- 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7,
73
- Segment[]
74
- ][];
75
- type RPCJsonSerialized = [json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], blobs: Blob[]];
76
- declare class RPCJsonSerializer {
77
- serialize(data: unknown, segments?: Segment[], meta?: RPCJsonSerializedMeta, maps?: Segment[][], blobs?: Blob[]): RPCJsonSerialized;
78
- deserialize(json: unknown, meta: RPCJsonSerializedMeta): unknown;
79
- deserialize(json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], getBlob: (index: number) => Blob): unknown;
28
+ declare class StandardRPCJsonSerializer {
29
+ private readonly customSerializers;
30
+ constructor(options?: StandardRPCJsonSerializerOptions);
31
+ serialize(data: unknown, segments?: Segment[], meta?: StandardRPCJsonSerializedMetaItem[], maps?: Segment[][], blobs?: Blob[]): StandardRPCJsonSerialized;
32
+ deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[]): unknown;
33
+ deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[], maps: readonly Segment[][], getBlob: (index: number) => Blob): unknown;
80
34
  }
81
35
 
82
- declare class RPCSerializer {
36
+ declare class StandardRPCSerializer {
83
37
  #private;
84
38
  private readonly jsonSerializer;
85
- constructor(jsonSerializer?: RPCJsonSerializer);
86
- serialize(data: unknown): unknown;
39
+ constructor(jsonSerializer: StandardRPCJsonSerializer);
40
+ serialize(data: unknown): object;
87
41
  deserialize(data: unknown): unknown;
88
42
  }
89
43
 
@@ -93,7 +47,7 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
93
47
  * Base url for all requests.
94
48
  */
95
49
  url: Value<string | URL, [
96
- options: ClientOptionsOut<T>,
50
+ options: ClientOptions<T>,
97
51
  path: readonly string[],
98
52
  input: unknown
99
53
  ]>;
@@ -103,7 +57,7 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
103
57
  * @default 2083
104
58
  */
105
59
  maxUrlLength?: Value<number, [
106
- options: ClientOptionsOut<T>,
60
+ options: ClientOptions<T>,
107
61
  path: readonly string[],
108
62
  input: unknown
109
63
  ]>;
@@ -113,7 +67,7 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
113
67
  * @default 'POST'
114
68
  */
115
69
  method?: Value<HTTPMethod, [
116
- options: ClientOptionsOut<T>,
70
+ options: ClientOptions<T>,
117
71
  path: readonly string[],
118
72
  input: unknown
119
73
  ]>;
@@ -128,22 +82,24 @@ interface StandardRPCLinkCodecOptions<T extends ClientContext> {
128
82
  * Inject headers to the request.
129
83
  */
130
84
  headers?: Value<StandardHeaders, [
131
- options: ClientOptionsOut<T>,
85
+ options: ClientOptions<T>,
132
86
  path: readonly string[],
133
87
  input: unknown
134
88
  ]>;
135
- rpcSerializer?: RPCSerializer;
136
89
  }
137
90
  declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
91
+ private readonly serializer;
138
92
  private readonly baseUrl;
139
93
  private readonly maxUrlLength;
140
94
  private readonly fallbackMethod;
141
95
  private readonly expectedMethod;
142
96
  private readonly headers;
143
- private readonly rpcSerializer;
144
- constructor(options: StandardRPCLinkCodecOptions<T>);
145
- encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
97
+ constructor(serializer: StandardRPCSerializer, options: StandardRPCLinkCodecOptions<T>);
98
+ encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
146
99
  decode(response: StandardLazyResponse): Promise<unknown>;
147
100
  }
148
101
 
149
- export { InvalidEventIteratorRetryResponse, type RPCJsonSerialized, type RPCJsonSerializedMeta, RPCJsonSerializer, RPCSerializer, StandardLink, type StandardLinkClient, type StandardLinkCodec, type StandardLinkOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions };
102
+ interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
103
+ }
104
+
105
+ export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, StandardLinkCodec, StandardLinkOptions, type StandardRPCCustomJsonSerializer, type StandardRPCJsonSerialized, type StandardRPCJsonSerializedMetaItem, StandardRPCJsonSerializer, type StandardRPCJsonSerializerOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions, type StandardRPCLinkOptions, StandardRPCSerializer };
@@ -1,4 +1,4 @@
1
- export { I as InvalidEventIteratorRetryResponse, R as RPCJsonSerializer, b as RPCSerializer, S as StandardLink, a as StandardRPCLinkCodec } from '../../shared/client.MkoaGU3v.mjs';
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 } from '../../shared/client.B1XjLWRe.mjs';
2
2
  import '@orpc/shared';
3
- import '../../shared/client.DcaJQZfy.mjs';
3
+ import '../../shared/client.BacCdg3F.mjs';
4
4
  import '@orpc/standard-server';
package/dist/index.d.mts CHANGED
@@ -1,6 +1,7 @@
1
- import { N as NestedClient, b as ClientLink, I as InferClientContext, C as ClientContext, a as ClientOptionsOut, c as ClientPromiseResult } from './shared/client.D_CzLDyB.mjs';
2
- export { g as Client, e as ClientOptions, f as ClientRest, E as EventIteratorReconnectOptions, d as createAutoRetryEventIterator, m as mapEventIterator } from './shared/client.D_CzLDyB.mjs';
1
+ import { N as NestedClient, b as ClientLink, I as InferClientContext, a as ClientContext, C as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.RZs5Myak.mjs';
2
+ export { e as Client, d as ClientRest } from './shared/client.RZs5Myak.mjs';
3
3
  import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
4
+ export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
4
5
  export { ErrorEvent } from '@orpc/standard-server';
5
6
 
6
7
  interface createORPCClientOptions {
@@ -17,8 +18,8 @@ declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<
17
18
  */
18
19
  declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
19
20
  private readonly linkResolver;
20
- constructor(linkResolver: (options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
21
- call(path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>): Promise<unknown>;
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>;
22
23
  }
23
24
 
24
25
  declare const COMMON_ORPC_ERROR_DEFS: {
@@ -126,14 +127,10 @@ type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>,
126
127
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
127
128
  declare function toORPCError(error: unknown): ORPCError<any, any>;
128
129
 
129
- type ConnectionStatus = 'reconnecting' | 'connected' | 'closed';
130
- interface EventIteratorState {
131
- status: ConnectionStatus;
132
- listeners: Array<(newStatus: ConnectionStatus) => void>;
133
- }
134
- declare function registerEventIteratorState(iterator: AsyncIteratorObject<unknown, unknown, void>, state: EventIteratorState): void;
135
- declare function updateEventIteratorStatus(state: EventIteratorState, status: ConnectionStatus): void;
136
- declare function onEventIteratorStatusChange(iterator: AsyncIteratorObject<unknown, unknown, void>, callback: (status: ConnectionStatus) => void, notifyImmediately?: boolean): () => void;
130
+ declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
131
+ value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
132
+ error: (error: unknown) => Promise<unknown>;
133
+ }): AsyncGenerator<TMap, TMap, TNext>;
137
134
 
138
135
  type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
139
136
  error: null;
@@ -149,5 +146,6 @@ type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, is
149
146
  isDefined: true;
150
147
  };
151
148
  declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
149
+ declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
152
150
 
153
- export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptionsOut, ClientPromiseResult, type CommonORPCErrorCode, type ConnectionStatus, DynamicLink, type EventIteratorState, InferClientContext, NestedClient, ORPCError, type ORPCErrorCode, type ORPCErrorJSON, type ORPCErrorOptions, type SafeResult, createORPCClient, type createORPCClientOptions, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, onEventIteratorStatusChange, registerEventIteratorState, safe, toORPCError, updateEventIteratorStatus };
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 };
package/dist/index.d.ts CHANGED
@@ -1,6 +1,7 @@
1
- import { N as NestedClient, b as ClientLink, I as InferClientContext, C as ClientContext, a as ClientOptionsOut, c as ClientPromiseResult } from './shared/client.D_CzLDyB.js';
2
- export { g as Client, e as ClientOptions, f as ClientRest, E as EventIteratorReconnectOptions, d as createAutoRetryEventIterator, m as mapEventIterator } from './shared/client.D_CzLDyB.js';
1
+ import { N as NestedClient, b as ClientLink, I as InferClientContext, a as ClientContext, C as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.RZs5Myak.js';
2
+ export { e as Client, d as ClientRest } from './shared/client.RZs5Myak.js';
3
3
  import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
4
+ export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
4
5
  export { ErrorEvent } from '@orpc/standard-server';
5
6
 
6
7
  interface createORPCClientOptions {
@@ -17,8 +18,8 @@ declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<
17
18
  */
18
19
  declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
19
20
  private readonly linkResolver;
20
- constructor(linkResolver: (options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
21
- call(path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>): Promise<unknown>;
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>;
22
23
  }
23
24
 
24
25
  declare const COMMON_ORPC_ERROR_DEFS: {
@@ -126,14 +127,10 @@ type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>,
126
127
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
127
128
  declare function toORPCError(error: unknown): ORPCError<any, any>;
128
129
 
129
- type ConnectionStatus = 'reconnecting' | 'connected' | 'closed';
130
- interface EventIteratorState {
131
- status: ConnectionStatus;
132
- listeners: Array<(newStatus: ConnectionStatus) => void>;
133
- }
134
- declare function registerEventIteratorState(iterator: AsyncIteratorObject<unknown, unknown, void>, state: EventIteratorState): void;
135
- declare function updateEventIteratorStatus(state: EventIteratorState, status: ConnectionStatus): void;
136
- declare function onEventIteratorStatusChange(iterator: AsyncIteratorObject<unknown, unknown, void>, callback: (status: ConnectionStatus) => void, notifyImmediately?: boolean): () => void;
130
+ declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
131
+ value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
132
+ error: (error: unknown) => Promise<unknown>;
133
+ }): AsyncGenerator<TMap, TMap, TNext>;
137
134
 
138
135
  type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
139
136
  error: null;
@@ -149,5 +146,6 @@ type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, is
149
146
  isDefined: true;
150
147
  };
151
148
  declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
149
+ declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
152
150
 
153
- export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptionsOut, ClientPromiseResult, type CommonORPCErrorCode, type ConnectionStatus, DynamicLink, type EventIteratorState, InferClientContext, NestedClient, ORPCError, type ORPCErrorCode, type ORPCErrorJSON, type ORPCErrorOptions, type SafeResult, createORPCClient, type createORPCClientOptions, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, onEventIteratorStatusChange, registerEventIteratorState, safe, toORPCError, updateEventIteratorStatus };
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 };