@orpc/client 0.0.0-next.25e937d → 0.0.0-next.283e153
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 +0 -2
- package/dist/adapters/fetch/index.d.mts +2 -3
- package/dist/adapters/fetch/index.d.ts +2 -3
- package/dist/adapters/fetch/index.mjs +2 -3
- package/dist/adapters/standard/index.d.mts +71 -7
- package/dist/adapters/standard/index.d.ts +71 -7
- package/dist/adapters/standard/index.mjs +2 -3
- package/dist/index.d.mts +13 -7
- package/dist/index.d.ts +13 -7
- package/dist/index.mjs +2 -2
- package/dist/shared/{client.Be-O_tdu.mjs → client.CPmBUYbj.mjs} +39 -19
- package/dist/shared/{client.CupM8eRP.d.mts → client.D_CzLDyB.d.mts} +13 -1
- package/dist/shared/{client.CupM8eRP.d.ts → client.D_CzLDyB.d.ts} +13 -1
- package/dist/shared/{client.BacCdg3F.mjs → client.XAn8cDTM.mjs} +96 -2
- package/package.json +4 -9
- package/dist/plugins/index.d.mts +0 -62
- package/dist/plugins/index.d.ts +0 -62
- package/dist/plugins/index.mjs +0 -127
- package/dist/shared/client.CvnV7_uV.mjs +0 -12
- package/dist/shared/client.DrOAzyMB.d.mts +0 -45
- package/dist/shared/client.aGal-uGY.d.ts +0 -45
package/README.md
CHANGED
|
@@ -60,8 +60,6 @@ You can find the full documentation [here](https://orpc.unnoq.com).
|
|
|
60
60
|
- [@orpc/vue-colada](https://www.npmjs.com/package/@orpc/vue-colada): Integration with [Pinia Colada](https://pinia-colada.esm.dev/).
|
|
61
61
|
- [@orpc/openapi](https://www.npmjs.com/package/@orpc/openapi): Generate OpenAPI specs and handle OpenAPI requests.
|
|
62
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/).
|
|
65
63
|
|
|
66
64
|
## `@orpc/client`
|
|
67
65
|
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import { StandardRPCLinkOptions } from '../standard/index.mjs';
|
|
3
|
+
import { C as ClientContext, a as ClientOptionsOut, b as ClientLink } from '../../shared/client.D_CzLDyB.mjs';
|
|
4
|
+
import { StandardLinkClient, StandardRPCLinkOptions } from '../standard/index.mjs';
|
|
6
5
|
import '@orpc/shared';
|
|
7
6
|
|
|
8
7
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import { StandardRPCLinkOptions } from '../standard/index.js';
|
|
3
|
+
import { C as ClientContext, a as ClientOptionsOut, b as ClientLink } from '../../shared/client.D_CzLDyB.js';
|
|
4
|
+
import { StandardLinkClient, StandardRPCLinkOptions } from '../standard/index.js';
|
|
6
5
|
import '@orpc/shared';
|
|
7
6
|
|
|
8
7
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
|
@@ -1,9 +1,8 @@
|
|
|
1
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.
|
|
2
|
+
import { b as StandardRPCJsonSerializer, c as StandardRPCLinkCodec, d as StandardRPCSerializer, S as StandardLink } from '../../shared/client.CPmBUYbj.mjs';
|
|
3
3
|
import '@orpc/shared';
|
|
4
|
-
import '../../shared/client.
|
|
4
|
+
import '../../shared/client.XAn8cDTM.mjs';
|
|
5
5
|
import '@orpc/standard-server';
|
|
6
|
-
import '../../shared/client.BacCdg3F.mjs';
|
|
7
6
|
|
|
8
7
|
class LinkFetchClient {
|
|
9
8
|
fetch;
|
|
@@ -1,8 +1,72 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
import {
|
|
4
|
-
|
|
5
|
-
|
|
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';
|
|
4
|
+
|
|
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>;
|
|
8
|
+
}
|
|
9
|
+
interface StandardLinkClient<T extends ClientContext> {
|
|
10
|
+
call(request: StandardRequest, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
declare class InvalidEventIteratorRetryResponse extends Error {
|
|
14
|
+
}
|
|
15
|
+
interface StandardLinkOptions<T extends ClientContext> {
|
|
16
|
+
/**
|
|
17
|
+
* Maximum retry attempts for **consecutive failures** 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
|
+
}
|
|
6
70
|
|
|
7
71
|
declare const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES: {
|
|
8
72
|
readonly BIGINT: 0;
|
|
@@ -37,7 +101,7 @@ declare class StandardRPCSerializer {
|
|
|
37
101
|
#private;
|
|
38
102
|
private readonly jsonSerializer;
|
|
39
103
|
constructor(jsonSerializer: StandardRPCJsonSerializer);
|
|
40
|
-
serialize(data: unknown):
|
|
104
|
+
serialize(data: unknown): unknown;
|
|
41
105
|
deserialize(data: unknown): unknown;
|
|
42
106
|
}
|
|
43
107
|
|
|
@@ -102,4 +166,4 @@ declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardL
|
|
|
102
166
|
interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
|
|
103
167
|
}
|
|
104
168
|
|
|
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 };
|
|
169
|
+
export { InvalidEventIteratorRetryResponse, STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, StandardLink, type StandardLinkClient, type StandardLinkCodec, type StandardLinkOptions, type StandardRPCCustomJsonSerializer, type StandardRPCJsonSerialized, type StandardRPCJsonSerializedMetaItem, StandardRPCJsonSerializer, type StandardRPCJsonSerializerOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions, type StandardRPCLinkOptions, StandardRPCSerializer };
|
|
@@ -1,8 +1,72 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
import {
|
|
4
|
-
|
|
5
|
-
|
|
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';
|
|
4
|
+
|
|
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>;
|
|
8
|
+
}
|
|
9
|
+
interface StandardLinkClient<T extends ClientContext> {
|
|
10
|
+
call(request: StandardRequest, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
declare class InvalidEventIteratorRetryResponse extends Error {
|
|
14
|
+
}
|
|
15
|
+
interface StandardLinkOptions<T extends ClientContext> {
|
|
16
|
+
/**
|
|
17
|
+
* Maximum retry attempts for **consecutive failures** 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
|
+
}
|
|
6
70
|
|
|
7
71
|
declare const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES: {
|
|
8
72
|
readonly BIGINT: 0;
|
|
@@ -37,7 +101,7 @@ declare class StandardRPCSerializer {
|
|
|
37
101
|
#private;
|
|
38
102
|
private readonly jsonSerializer;
|
|
39
103
|
constructor(jsonSerializer: StandardRPCJsonSerializer);
|
|
40
|
-
serialize(data: unknown):
|
|
104
|
+
serialize(data: unknown): unknown;
|
|
41
105
|
deserialize(data: unknown): unknown;
|
|
42
106
|
}
|
|
43
107
|
|
|
@@ -102,4 +166,4 @@ declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardL
|
|
|
102
166
|
interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
|
|
103
167
|
}
|
|
104
168
|
|
|
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 };
|
|
169
|
+
export { InvalidEventIteratorRetryResponse, STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, StandardLink, type StandardLinkClient, type StandardLinkCodec, type StandardLinkOptions, type StandardRPCCustomJsonSerializer, type StandardRPCJsonSerialized, type StandardRPCJsonSerializedMetaItem, StandardRPCJsonSerializer, type StandardRPCJsonSerializerOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions, type StandardRPCLinkOptions, StandardRPCSerializer };
|
|
@@ -1,5 +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 } from '../../shared/client.
|
|
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.CPmBUYbj.mjs';
|
|
2
2
|
import '@orpc/shared';
|
|
3
|
-
import '../../shared/client.
|
|
3
|
+
import '../../shared/client.XAn8cDTM.mjs';
|
|
4
4
|
import '@orpc/standard-server';
|
|
5
|
-
import '../../shared/client.BacCdg3F.mjs';
|
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { N as NestedClient, b as ClientLink, I as InferClientContext,
|
|
2
|
-
export {
|
|
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';
|
|
3
3
|
import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
|
|
4
4
|
export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
|
@@ -127,10 +127,16 @@ type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>,
|
|
|
127
127
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
|
128
128
|
declare function toORPCError(error: unknown): ORPCError<any, any>;
|
|
129
129
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
130
|
+
type ConnectionStatus = 'reconnecting' | 'connected' | 'closed';
|
|
131
|
+
interface EventIteratorState {
|
|
132
|
+
status: ConnectionStatus;
|
|
133
|
+
listeners: Array<(newStatus: ConnectionStatus) => void>;
|
|
134
|
+
}
|
|
135
|
+
declare function registerEventIteratorState(iterator: AsyncIteratorObject<unknown, unknown, void>, state: EventIteratorState): void;
|
|
136
|
+
declare function updateEventIteratorStatus(state: EventIteratorState, status: ConnectionStatus): void;
|
|
137
|
+
declare function onEventIteratorStatusChange(iterator: AsyncIteratorObject<unknown, unknown, void>, callback: (status: ConnectionStatus) => void, options?: {
|
|
138
|
+
notifyImmediately?: boolean;
|
|
139
|
+
}): () => void;
|
|
134
140
|
|
|
135
141
|
type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
|
|
136
142
|
error: null;
|
|
@@ -147,4 +153,4 @@ type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, is
|
|
|
147
153
|
};
|
|
148
154
|
declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
|
149
155
|
|
|
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,
|
|
156
|
+
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 };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { N as NestedClient, b as ClientLink, I as InferClientContext,
|
|
2
|
-
export {
|
|
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';
|
|
3
3
|
import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
|
|
4
4
|
export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
|
@@ -127,10 +127,16 @@ type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>,
|
|
|
127
127
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
|
128
128
|
declare function toORPCError(error: unknown): ORPCError<any, any>;
|
|
129
129
|
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
130
|
+
type ConnectionStatus = 'reconnecting' | 'connected' | 'closed';
|
|
131
|
+
interface EventIteratorState {
|
|
132
|
+
status: ConnectionStatus;
|
|
133
|
+
listeners: Array<(newStatus: ConnectionStatus) => void>;
|
|
134
|
+
}
|
|
135
|
+
declare function registerEventIteratorState(iterator: AsyncIteratorObject<unknown, unknown, void>, state: EventIteratorState): void;
|
|
136
|
+
declare function updateEventIteratorStatus(state: EventIteratorState, status: ConnectionStatus): void;
|
|
137
|
+
declare function onEventIteratorStatusChange(iterator: AsyncIteratorObject<unknown, unknown, void>, callback: (status: ConnectionStatus) => void, options?: {
|
|
138
|
+
notifyImmediately?: boolean;
|
|
139
|
+
}): () => void;
|
|
134
140
|
|
|
135
141
|
type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
|
|
136
142
|
error: null;
|
|
@@ -147,4 +153,4 @@ type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, is
|
|
|
147
153
|
};
|
|
148
154
|
declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
|
149
155
|
|
|
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,
|
|
156
|
+
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 };
|
package/dist/index.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { i as isDefinedError } from './shared/client.
|
|
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.
|
|
1
|
+
import { i as isDefinedError } from './shared/client.XAn8cDTM.mjs';
|
|
2
|
+
export { C as COMMON_ORPC_ERROR_DEFS, O as ORPCError, c as createAutoRetryEventIterator, a as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, m as mapEventIterator, o as onEventIteratorStatusChange, r as registerEventIteratorState, t as toORPCError, u as updateEventIteratorStatus } from './shared/client.XAn8cDTM.mjs';
|
|
3
3
|
export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
|
4
4
|
export { ErrorEvent } from '@orpc/standard-server';
|
|
5
5
|
|
|
@@ -1,25 +1,48 @@
|
|
|
1
|
-
import { intercept,
|
|
2
|
-
import {
|
|
1
|
+
import { intercept, isAsyncIteratorObject, value, isObject, trim, stringifyJSON } from '@orpc/shared';
|
|
2
|
+
import { c as createAutoRetryEventIterator, O as ORPCError, m as mapEventIterator, t as toORPCError } from './client.XAn8cDTM.mjs';
|
|
3
3
|
import { ErrorEvent } from '@orpc/standard-server';
|
|
4
|
-
import { O as ORPCError, m as mapEventIterator, t as toORPCError } from './client.BacCdg3F.mjs';
|
|
5
4
|
|
|
6
5
|
class InvalidEventIteratorRetryResponse extends Error {
|
|
7
6
|
}
|
|
8
7
|
class StandardLink {
|
|
9
|
-
constructor(codec, sender, options
|
|
8
|
+
constructor(codec, sender, options) {
|
|
10
9
|
this.codec = codec;
|
|
11
10
|
this.sender = sender;
|
|
12
|
-
|
|
13
|
-
|
|
11
|
+
this.eventIteratorMaxRetries = options.eventIteratorMaxRetries ?? 5;
|
|
12
|
+
this.eventIteratorRetryDelay = options.eventIteratorRetryDelay ?? ((o) => o.lastRetry ?? 1e3 * 2 ** o.retryTimes);
|
|
13
|
+
this.eventIteratorShouldRetry = options.eventIteratorShouldRetry ?? true;
|
|
14
14
|
this.interceptors = options.interceptors ?? [];
|
|
15
15
|
this.clientInterceptors = options.clientInterceptors ?? [];
|
|
16
16
|
}
|
|
17
|
+
eventIteratorMaxRetries;
|
|
18
|
+
eventIteratorRetryDelay;
|
|
19
|
+
eventIteratorShouldRetry;
|
|
17
20
|
interceptors;
|
|
18
21
|
clientInterceptors;
|
|
19
22
|
call(path, input, options) {
|
|
20
23
|
return intercept(this.interceptors, { path, input, options }, async ({ path: path2, input: input2, options: options2 }) => {
|
|
21
24
|
const output = await this.#call(path2, input2, options2);
|
|
22
|
-
|
|
25
|
+
if (!isAsyncIteratorObject(output)) {
|
|
26
|
+
return output;
|
|
27
|
+
}
|
|
28
|
+
return createAutoRetryEventIterator(output, async (reconnectOptions) => {
|
|
29
|
+
const maxRetries = await value(this.eventIteratorMaxRetries, reconnectOptions, options2, path2, input2);
|
|
30
|
+
if (options2.signal?.aborted || reconnectOptions.retryTimes > maxRetries) {
|
|
31
|
+
return null;
|
|
32
|
+
}
|
|
33
|
+
const shouldRetry = await value(this.eventIteratorShouldRetry, reconnectOptions, options2, path2, input2);
|
|
34
|
+
if (!shouldRetry) {
|
|
35
|
+
return null;
|
|
36
|
+
}
|
|
37
|
+
const retryDelay = await value(this.eventIteratorRetryDelay, reconnectOptions, options2, path2, input2);
|
|
38
|
+
await new Promise((resolve) => setTimeout(resolve, retryDelay));
|
|
39
|
+
const updatedOptions = { ...options2, lastEventId: reconnectOptions.lastEventId };
|
|
40
|
+
const maybeIterator = await this.#call(path2, input2, updatedOptions);
|
|
41
|
+
if (!isAsyncIteratorObject(maybeIterator)) {
|
|
42
|
+
throw new InvalidEventIteratorRetryResponse("Invalid Event Iterator retry response");
|
|
43
|
+
}
|
|
44
|
+
return maybeIterator;
|
|
45
|
+
}, options2.lastEventId);
|
|
23
46
|
});
|
|
24
47
|
}
|
|
25
48
|
async #call(path, input, options) {
|
|
@@ -193,23 +216,14 @@ class StandardRPCLinkCodec {
|
|
|
193
216
|
headers;
|
|
194
217
|
async encode(path, input, options) {
|
|
195
218
|
const expectedMethod = await value(this.expectedMethod, options, path, input);
|
|
196
|
-
const headers =
|
|
219
|
+
const headers = await value(this.headers, options, path, input);
|
|
197
220
|
const baseUrl = await value(this.baseUrl, options, path, input);
|
|
198
221
|
const url = new URL(`${trim(baseUrl.toString(), "/")}/${path.map(encodeURIComponent).join("/")}`);
|
|
199
|
-
if (options.lastEventId !== void 0) {
|
|
200
|
-
if (Array.isArray(headers["last-event-id"])) {
|
|
201
|
-
headers["last-event-id"] = [...headers["last-event-id"], options.lastEventId];
|
|
202
|
-
} else if (headers["last-event-id"] !== void 0) {
|
|
203
|
-
headers["last-event-id"] = [headers["last-event-id"], options.lastEventId];
|
|
204
|
-
} else {
|
|
205
|
-
headers["last-event-id"] = options.lastEventId;
|
|
206
|
-
}
|
|
207
|
-
}
|
|
208
222
|
const serialized = this.serializer.serialize(input);
|
|
209
|
-
if (expectedMethod === "GET" && !(serialized instanceof FormData) && !isAsyncIteratorObject(serialized)) {
|
|
223
|
+
if (expectedMethod === "GET" && !(serialized instanceof FormData) && !(serialized instanceof Blob) && !isAsyncIteratorObject(serialized)) {
|
|
210
224
|
const maxUrlLength = await value(this.maxUrlLength, options, path, input);
|
|
211
225
|
const getUrl = new URL(url);
|
|
212
|
-
getUrl.searchParams.append("data", stringifyJSON(serialized));
|
|
226
|
+
getUrl.searchParams.append("data", stringifyJSON(serialized) ?? "");
|
|
213
227
|
if (getUrl.toString().length <= maxUrlLength) {
|
|
214
228
|
return {
|
|
215
229
|
body: void 0,
|
|
@@ -278,6 +292,9 @@ class StandardRPCSerializer {
|
|
|
278
292
|
return this.#serialize(data, true);
|
|
279
293
|
}
|
|
280
294
|
#serialize(data, enableFormData) {
|
|
295
|
+
if (data === void 0 || data instanceof Blob) {
|
|
296
|
+
return data;
|
|
297
|
+
}
|
|
281
298
|
const [json, meta_, maps, blobs] = this.jsonSerializer.serialize(data);
|
|
282
299
|
const meta = meta_.length === 0 ? void 0 : meta_;
|
|
283
300
|
if (!enableFormData || blobs.length === 0) {
|
|
@@ -315,6 +332,9 @@ class StandardRPCSerializer {
|
|
|
315
332
|
return this.#deserialize(data);
|
|
316
333
|
}
|
|
317
334
|
#deserialize(data) {
|
|
335
|
+
if (data === void 0 || data instanceof Blob) {
|
|
336
|
+
return data;
|
|
337
|
+
}
|
|
318
338
|
if (!(data instanceof FormData)) {
|
|
319
339
|
return this.jsonSerializer.deserialize(data.json, data.meta ?? []);
|
|
320
340
|
}
|
|
@@ -27,4 +27,16 @@ interface ClientLink<TClientContext extends ClientContext> {
|
|
|
27
27
|
call: (path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>) => Promise<unknown>;
|
|
28
28
|
}
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
|
31
|
+
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
|
32
|
+
error: (error: unknown) => Promise<unknown>;
|
|
33
|
+
}): AsyncGenerator<TMap, TMap, TNext>;
|
|
34
|
+
interface EventIteratorReconnectOptions {
|
|
35
|
+
lastRetry: number | undefined;
|
|
36
|
+
lastEventId: string | undefined;
|
|
37
|
+
retryTimes: number;
|
|
38
|
+
error: unknown;
|
|
39
|
+
}
|
|
40
|
+
declare function createAutoRetryEventIterator<TYield, TReturn>(initial: AsyncIterator<TYield, TReturn, void>, reconnect: (options: EventIteratorReconnectOptions) => Promise<AsyncIterator<TYield, TReturn, void> | null>, initialLastEventId: string | undefined): AsyncGenerator<TYield, TReturn, void>;
|
|
41
|
+
|
|
42
|
+
export { type ClientContext as C, type EventIteratorReconnectOptions as E, type InferClientContext as I, type NestedClient as N, type ClientOptionsOut as a, type ClientLink as b, type ClientPromiseResult as c, createAutoRetryEventIterator as d, type ClientOptions as e, type ClientRest as f, type Client as g, mapEventIterator as m };
|
|
@@ -27,4 +27,16 @@ interface ClientLink<TClientContext extends ClientContext> {
|
|
|
27
27
|
call: (path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>) => Promise<unknown>;
|
|
28
28
|
}
|
|
29
29
|
|
|
30
|
-
|
|
30
|
+
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
|
31
|
+
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
|
32
|
+
error: (error: unknown) => Promise<unknown>;
|
|
33
|
+
}): AsyncGenerator<TMap, TMap, TNext>;
|
|
34
|
+
interface EventIteratorReconnectOptions {
|
|
35
|
+
lastRetry: number | undefined;
|
|
36
|
+
lastEventId: string | undefined;
|
|
37
|
+
retryTimes: number;
|
|
38
|
+
error: unknown;
|
|
39
|
+
}
|
|
40
|
+
declare function createAutoRetryEventIterator<TYield, TReturn>(initial: AsyncIterator<TYield, TReturn, void>, reconnect: (options: EventIteratorReconnectOptions) => Promise<AsyncIterator<TYield, TReturn, void> | null>, initialLastEventId: string | undefined): AsyncGenerator<TYield, TReturn, void>;
|
|
41
|
+
|
|
42
|
+
export { type ClientContext as C, type EventIteratorReconnectOptions as E, type InferClientContext as I, type NestedClient as N, type ClientOptionsOut as a, type ClientLink as b, type ClientPromiseResult as c, createAutoRetryEventIterator as d, type ClientOptions as e, type ClientRest as f, type Client as g, mapEventIterator as m };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { isObject, isTypescriptObject } from '@orpc/shared';
|
|
1
|
+
import { isObject, isTypescriptObject, retry } from '@orpc/shared';
|
|
2
2
|
import { getEventMeta, withEventMeta } from '@orpc/standard-server';
|
|
3
3
|
|
|
4
4
|
const COMMON_ORPC_ERROR_DEFS = {
|
|
@@ -137,6 +137,34 @@ function toORPCError(error) {
|
|
|
137
137
|
});
|
|
138
138
|
}
|
|
139
139
|
|
|
140
|
+
const iteratorStates = /* @__PURE__ */ new WeakMap();
|
|
141
|
+
function registerEventIteratorState(iterator, state) {
|
|
142
|
+
iteratorStates.set(iterator, state);
|
|
143
|
+
}
|
|
144
|
+
function updateEventIteratorStatus(state, status) {
|
|
145
|
+
if (state.status !== status) {
|
|
146
|
+
state.status = status;
|
|
147
|
+
state.listeners.forEach((cb) => cb(status));
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
function onEventIteratorStatusChange(iterator, callback, options = {}) {
|
|
151
|
+
const notifyImmediately = options.notifyImmediately ?? true;
|
|
152
|
+
const state = iteratorStates.get(iterator);
|
|
153
|
+
if (!state) {
|
|
154
|
+
throw new Error("Iterator is not registered.");
|
|
155
|
+
}
|
|
156
|
+
if (notifyImmediately) {
|
|
157
|
+
callback(state.status);
|
|
158
|
+
}
|
|
159
|
+
state.listeners.push(callback);
|
|
160
|
+
return () => {
|
|
161
|
+
const index = state.listeners.indexOf(callback);
|
|
162
|
+
if (index !== -1) {
|
|
163
|
+
state.listeners.splice(index, 1);
|
|
164
|
+
}
|
|
165
|
+
};
|
|
166
|
+
}
|
|
167
|
+
|
|
140
168
|
function mapEventIterator(iterator, maps) {
|
|
141
169
|
return async function* () {
|
|
142
170
|
try {
|
|
@@ -168,5 +196,71 @@ function mapEventIterator(iterator, maps) {
|
|
|
168
196
|
}
|
|
169
197
|
}();
|
|
170
198
|
}
|
|
199
|
+
const MAX_ALLOWED_RETRY_TIMES = 99;
|
|
200
|
+
function createAutoRetryEventIterator(initial, reconnect, initialLastEventId) {
|
|
201
|
+
const state = {
|
|
202
|
+
status: "connected",
|
|
203
|
+
listeners: []
|
|
204
|
+
};
|
|
205
|
+
const iterator = async function* () {
|
|
206
|
+
let current = initial;
|
|
207
|
+
let lastEventId = initialLastEventId;
|
|
208
|
+
let lastRetry;
|
|
209
|
+
let retryTimes = 0;
|
|
210
|
+
try {
|
|
211
|
+
while (true) {
|
|
212
|
+
try {
|
|
213
|
+
updateEventIteratorStatus(state, "connected");
|
|
214
|
+
const { done, value } = await current.next();
|
|
215
|
+
const meta = getEventMeta(value);
|
|
216
|
+
lastEventId = meta?.id ?? lastEventId;
|
|
217
|
+
lastRetry = meta?.retry ?? lastRetry;
|
|
218
|
+
retryTimes = 0;
|
|
219
|
+
if (done) {
|
|
220
|
+
return value;
|
|
221
|
+
}
|
|
222
|
+
yield value;
|
|
223
|
+
} catch (e) {
|
|
224
|
+
updateEventIteratorStatus(state, "reconnecting");
|
|
225
|
+
const meta = getEventMeta(e);
|
|
226
|
+
lastEventId = meta?.id ?? lastEventId;
|
|
227
|
+
lastRetry = meta?.retry ?? lastRetry;
|
|
228
|
+
let currentError = e;
|
|
229
|
+
current = await retry({ times: MAX_ALLOWED_RETRY_TIMES }, async (exit) => {
|
|
230
|
+
retryTimes += 1;
|
|
231
|
+
if (retryTimes > MAX_ALLOWED_RETRY_TIMES) {
|
|
232
|
+
throw exit(new Error(
|
|
233
|
+
`Exceeded maximum retry attempts (${MAX_ALLOWED_RETRY_TIMES}) for event iterator. Possible infinite retry loop detected. Please review the retry logic.`,
|
|
234
|
+
{ cause: currentError }
|
|
235
|
+
));
|
|
236
|
+
}
|
|
237
|
+
const reconnected = await (async () => {
|
|
238
|
+
try {
|
|
239
|
+
return await reconnect({
|
|
240
|
+
lastRetry,
|
|
241
|
+
lastEventId,
|
|
242
|
+
retryTimes,
|
|
243
|
+
error: currentError
|
|
244
|
+
});
|
|
245
|
+
} catch (e2) {
|
|
246
|
+
currentError = e2;
|
|
247
|
+
throw e2;
|
|
248
|
+
}
|
|
249
|
+
})();
|
|
250
|
+
if (!reconnected) {
|
|
251
|
+
throw exit(currentError);
|
|
252
|
+
}
|
|
253
|
+
return reconnected;
|
|
254
|
+
});
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
} finally {
|
|
258
|
+
updateEventIteratorStatus(state, "closed");
|
|
259
|
+
await current.return?.();
|
|
260
|
+
}
|
|
261
|
+
}();
|
|
262
|
+
registerEventIteratorState(iterator, state);
|
|
263
|
+
return iterator;
|
|
264
|
+
}
|
|
171
265
|
|
|
172
|
-
export { COMMON_ORPC_ERROR_DEFS as C, ORPCError as O, fallbackORPCErrorMessage as a, fallbackORPCErrorStatus as f, isDefinedError as i, mapEventIterator as m, toORPCError as t };
|
|
266
|
+
export { COMMON_ORPC_ERROR_DEFS as C, ORPCError as O, fallbackORPCErrorMessage as a, createAutoRetryEventIterator as c, fallbackORPCErrorStatus as f, isDefinedError as i, mapEventIterator as m, onEventIteratorStatusChange as o, registerEventIteratorState as r, toORPCError as t, updateEventIteratorStatus as u };
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@orpc/client",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.0.0-next.
|
|
4
|
+
"version": "0.0.0-next.283e153",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"homepage": "https://orpc.unnoq.com",
|
|
7
7
|
"repository": {
|
|
@@ -19,11 +19,6 @@
|
|
|
19
19
|
"import": "./dist/index.mjs",
|
|
20
20
|
"default": "./dist/index.mjs"
|
|
21
21
|
},
|
|
22
|
-
"./plugins": {
|
|
23
|
-
"types": "./dist/plugins/index.d.mts",
|
|
24
|
-
"import": "./dist/plugins/index.mjs",
|
|
25
|
-
"default": "./dist/plugins/index.mjs"
|
|
26
|
-
},
|
|
27
22
|
"./standard": {
|
|
28
23
|
"types": "./dist/adapters/standard/index.d.mts",
|
|
29
24
|
"import": "./dist/adapters/standard/index.mjs",
|
|
@@ -39,9 +34,9 @@
|
|
|
39
34
|
"dist"
|
|
40
35
|
],
|
|
41
36
|
"dependencies": {
|
|
42
|
-
"@orpc/
|
|
43
|
-
"@orpc/standard-server
|
|
44
|
-
"@orpc/
|
|
37
|
+
"@orpc/shared": "0.0.0-next.283e153",
|
|
38
|
+
"@orpc/standard-server": "0.0.0-next.283e153",
|
|
39
|
+
"@orpc/standard-server-fetch": "0.0.0-next.283e153"
|
|
45
40
|
},
|
|
46
41
|
"devDependencies": {
|
|
47
42
|
"zod": "^3.24.2"
|
package/dist/plugins/index.d.mts
DELETED
|
@@ -1,62 +0,0 @@
|
|
|
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';
|
|
6
|
-
|
|
7
|
-
interface ClientRetryPluginAttemptOptions {
|
|
8
|
-
eventIteratorLastRetry: number | undefined;
|
|
9
|
-
eventIteratorLastEventId: string | undefined;
|
|
10
|
-
attemptIndex: number;
|
|
11
|
-
error: unknown;
|
|
12
|
-
}
|
|
13
|
-
interface ClientRetryPluginContext {
|
|
14
|
-
/**
|
|
15
|
-
* Maximum retry attempts before throwing
|
|
16
|
-
* Use `Number.POSITIVE_INFINITY` for infinite retries (e.g., when handling Server-Sent Events).
|
|
17
|
-
*
|
|
18
|
-
* @default 0
|
|
19
|
-
*/
|
|
20
|
-
retry?: number;
|
|
21
|
-
/**
|
|
22
|
-
* Delay (in ms) before retrying.
|
|
23
|
-
*
|
|
24
|
-
* @default (o) => o.eventIteratorLastRetry ?? 2000
|
|
25
|
-
*/
|
|
26
|
-
retryDelay?: Value<number, [
|
|
27
|
-
attemptOptions: ClientRetryPluginAttemptOptions,
|
|
28
|
-
clientOptions: ClientOptionsOut<ClientRetryPluginContext>,
|
|
29
|
-
path: readonly string[],
|
|
30
|
-
input: unknown
|
|
31
|
-
]>;
|
|
32
|
-
/**
|
|
33
|
-
* Determine should retry or not.
|
|
34
|
-
*
|
|
35
|
-
* @default true
|
|
36
|
-
*/
|
|
37
|
-
shouldRetry?: Value<boolean, [
|
|
38
|
-
attemptOptions: ClientRetryPluginAttemptOptions,
|
|
39
|
-
clientOptions: ClientOptionsOut<ClientRetryPluginContext>,
|
|
40
|
-
path: readonly string[],
|
|
41
|
-
input: unknown
|
|
42
|
-
]>;
|
|
43
|
-
/**
|
|
44
|
-
* The hook called when retrying, and return the unsubscribe function.
|
|
45
|
-
*/
|
|
46
|
-
onRetry?: (options: ClientRetryPluginAttemptOptions, clientOptions: ClientOptionsOut<ClientRetryPluginContext>, path: readonly string[], input: unknown) => void | (() => void);
|
|
47
|
-
}
|
|
48
|
-
declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
|
49
|
-
}
|
|
50
|
-
interface ClientRetryPluginOptions {
|
|
51
|
-
default?: ClientRetryPluginContext;
|
|
52
|
-
}
|
|
53
|
-
declare class ClientRetryPlugin<T extends ClientContext & ClientRetryPluginContext> implements ClientPlugin<T> {
|
|
54
|
-
private readonly defaultRetry;
|
|
55
|
-
private readonly defaultRetryDelay;
|
|
56
|
-
private readonly defaultShouldRetry;
|
|
57
|
-
private readonly defaultOnRetry;
|
|
58
|
-
constructor(options?: ClientRetryPluginOptions);
|
|
59
|
-
init(options: StandardLinkOptions<T>): void;
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
export { ClientPlugin, ClientRetryPlugin, type ClientRetryPluginAttemptOptions, type ClientRetryPluginContext, ClientRetryPluginInvalidEventIteratorRetryResponse, type ClientRetryPluginOptions };
|
package/dist/plugins/index.d.ts
DELETED
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
import { C as ClientPlugin, S as StandardLinkOptions } from '../shared/client.aGal-uGY.js';
|
|
2
|
-
export { a as CompositeClientPlugin } from '../shared/client.aGal-uGY.js';
|
|
3
|
-
import { Value } from '@orpc/shared';
|
|
4
|
-
import { C as ClientOptionsOut, a as ClientContext } from '../shared/client.CupM8eRP.js';
|
|
5
|
-
import '@orpc/standard-server';
|
|
6
|
-
|
|
7
|
-
interface ClientRetryPluginAttemptOptions {
|
|
8
|
-
eventIteratorLastRetry: number | undefined;
|
|
9
|
-
eventIteratorLastEventId: string | undefined;
|
|
10
|
-
attemptIndex: number;
|
|
11
|
-
error: unknown;
|
|
12
|
-
}
|
|
13
|
-
interface ClientRetryPluginContext {
|
|
14
|
-
/**
|
|
15
|
-
* Maximum retry attempts before throwing
|
|
16
|
-
* Use `Number.POSITIVE_INFINITY` for infinite retries (e.g., when handling Server-Sent Events).
|
|
17
|
-
*
|
|
18
|
-
* @default 0
|
|
19
|
-
*/
|
|
20
|
-
retry?: number;
|
|
21
|
-
/**
|
|
22
|
-
* Delay (in ms) before retrying.
|
|
23
|
-
*
|
|
24
|
-
* @default (o) => o.eventIteratorLastRetry ?? 2000
|
|
25
|
-
*/
|
|
26
|
-
retryDelay?: Value<number, [
|
|
27
|
-
attemptOptions: ClientRetryPluginAttemptOptions,
|
|
28
|
-
clientOptions: ClientOptionsOut<ClientRetryPluginContext>,
|
|
29
|
-
path: readonly string[],
|
|
30
|
-
input: unknown
|
|
31
|
-
]>;
|
|
32
|
-
/**
|
|
33
|
-
* Determine should retry or not.
|
|
34
|
-
*
|
|
35
|
-
* @default true
|
|
36
|
-
*/
|
|
37
|
-
shouldRetry?: Value<boolean, [
|
|
38
|
-
attemptOptions: ClientRetryPluginAttemptOptions,
|
|
39
|
-
clientOptions: ClientOptionsOut<ClientRetryPluginContext>,
|
|
40
|
-
path: readonly string[],
|
|
41
|
-
input: unknown
|
|
42
|
-
]>;
|
|
43
|
-
/**
|
|
44
|
-
* The hook called when retrying, and return the unsubscribe function.
|
|
45
|
-
*/
|
|
46
|
-
onRetry?: (options: ClientRetryPluginAttemptOptions, clientOptions: ClientOptionsOut<ClientRetryPluginContext>, path: readonly string[], input: unknown) => void | (() => void);
|
|
47
|
-
}
|
|
48
|
-
declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
|
49
|
-
}
|
|
50
|
-
interface ClientRetryPluginOptions {
|
|
51
|
-
default?: ClientRetryPluginContext;
|
|
52
|
-
}
|
|
53
|
-
declare class ClientRetryPlugin<T extends ClientContext & ClientRetryPluginContext> implements ClientPlugin<T> {
|
|
54
|
-
private readonly defaultRetry;
|
|
55
|
-
private readonly defaultRetryDelay;
|
|
56
|
-
private readonly defaultShouldRetry;
|
|
57
|
-
private readonly defaultOnRetry;
|
|
58
|
-
constructor(options?: ClientRetryPluginOptions);
|
|
59
|
-
init(options: StandardLinkOptions<T>): void;
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
export { ClientPlugin, ClientRetryPlugin, type ClientRetryPluginAttemptOptions, type ClientRetryPluginContext, ClientRetryPluginInvalidEventIteratorRetryResponse, type ClientRetryPluginOptions };
|
package/dist/plugins/index.mjs
DELETED
|
@@ -1,127 +0,0 @@
|
|
|
1
|
-
export { C as CompositeClientPlugin } from '../shared/client.CvnV7_uV.mjs';
|
|
2
|
-
import { isAsyncIteratorObject, value } from '@orpc/shared';
|
|
3
|
-
import { getEventMeta } from '@orpc/standard-server';
|
|
4
|
-
|
|
5
|
-
class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
|
6
|
-
}
|
|
7
|
-
class ClientRetryPlugin {
|
|
8
|
-
defaultRetry;
|
|
9
|
-
defaultRetryDelay;
|
|
10
|
-
defaultShouldRetry;
|
|
11
|
-
defaultOnRetry;
|
|
12
|
-
constructor(options = {}) {
|
|
13
|
-
this.defaultRetry = options.default?.retry ?? 0;
|
|
14
|
-
this.defaultRetryDelay = options.default?.retryDelay ?? ((o) => o.eventIteratorLastRetry ?? 2e3);
|
|
15
|
-
this.defaultShouldRetry = options.default?.shouldRetry ?? true;
|
|
16
|
-
this.defaultOnRetry = options.default?.onRetry;
|
|
17
|
-
}
|
|
18
|
-
init(options) {
|
|
19
|
-
options.interceptors ??= [];
|
|
20
|
-
options.interceptors.push(async (interceptorOptions) => {
|
|
21
|
-
const maxAttempts = interceptorOptions.options.context.retry ?? this.defaultRetry;
|
|
22
|
-
const retryDelay = interceptorOptions.options.context.retryDelay ?? this.defaultRetryDelay;
|
|
23
|
-
const shouldRetry = interceptorOptions.options.context.shouldRetry ?? this.defaultShouldRetry;
|
|
24
|
-
const onRetry = interceptorOptions.options.context.onRetry ?? this.defaultOnRetry;
|
|
25
|
-
if (maxAttempts <= 0) {
|
|
26
|
-
return interceptorOptions.next();
|
|
27
|
-
}
|
|
28
|
-
let eventIteratorLastEventId = interceptorOptions.options.lastEventId;
|
|
29
|
-
let eventIteratorLastRetry;
|
|
30
|
-
let unsubscribe;
|
|
31
|
-
let attemptIndex = 0;
|
|
32
|
-
const next = async (initial) => {
|
|
33
|
-
let current = initial;
|
|
34
|
-
while (true) {
|
|
35
|
-
if (current) {
|
|
36
|
-
if (attemptIndex >= maxAttempts) {
|
|
37
|
-
throw current.error;
|
|
38
|
-
}
|
|
39
|
-
const attemptOptions = {
|
|
40
|
-
attemptIndex,
|
|
41
|
-
error: current.error,
|
|
42
|
-
eventIteratorLastEventId,
|
|
43
|
-
eventIteratorLastRetry
|
|
44
|
-
};
|
|
45
|
-
const shouldRetryBool = await value(
|
|
46
|
-
shouldRetry,
|
|
47
|
-
attemptOptions,
|
|
48
|
-
interceptorOptions.options,
|
|
49
|
-
interceptorOptions.path,
|
|
50
|
-
interceptorOptions.input
|
|
51
|
-
);
|
|
52
|
-
if (!shouldRetryBool) {
|
|
53
|
-
throw current.error;
|
|
54
|
-
}
|
|
55
|
-
unsubscribe = onRetry?.(
|
|
56
|
-
attemptOptions,
|
|
57
|
-
interceptorOptions.options,
|
|
58
|
-
interceptorOptions.path,
|
|
59
|
-
interceptorOptions.input
|
|
60
|
-
);
|
|
61
|
-
const retryDelayMs = await value(
|
|
62
|
-
retryDelay,
|
|
63
|
-
attemptOptions,
|
|
64
|
-
interceptorOptions.options,
|
|
65
|
-
interceptorOptions.path,
|
|
66
|
-
interceptorOptions.input
|
|
67
|
-
);
|
|
68
|
-
await new Promise((resolve) => setTimeout(resolve, retryDelayMs));
|
|
69
|
-
attemptIndex++;
|
|
70
|
-
}
|
|
71
|
-
try {
|
|
72
|
-
const newClientOptions = { ...interceptorOptions.options, lastEventId: eventIteratorLastEventId };
|
|
73
|
-
const output2 = await interceptorOptions.next({
|
|
74
|
-
...interceptorOptions,
|
|
75
|
-
options: newClientOptions
|
|
76
|
-
});
|
|
77
|
-
return output2;
|
|
78
|
-
} catch (error) {
|
|
79
|
-
if (interceptorOptions.options.signal?.aborted === true) {
|
|
80
|
-
throw error;
|
|
81
|
-
}
|
|
82
|
-
current = { error };
|
|
83
|
-
} finally {
|
|
84
|
-
unsubscribe?.();
|
|
85
|
-
unsubscribe = void 0;
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
};
|
|
89
|
-
const output = await next();
|
|
90
|
-
if (!isAsyncIteratorObject(output)) {
|
|
91
|
-
return output;
|
|
92
|
-
}
|
|
93
|
-
return async function* () {
|
|
94
|
-
let current = output;
|
|
95
|
-
try {
|
|
96
|
-
while (true) {
|
|
97
|
-
try {
|
|
98
|
-
const item = await current.next();
|
|
99
|
-
const meta = getEventMeta(item.value);
|
|
100
|
-
eventIteratorLastEventId = meta?.id ?? eventIteratorLastEventId;
|
|
101
|
-
eventIteratorLastRetry = meta?.retry ?? eventIteratorLastRetry;
|
|
102
|
-
if (item.done) {
|
|
103
|
-
return item.value;
|
|
104
|
-
}
|
|
105
|
-
yield item.value;
|
|
106
|
-
} catch (error) {
|
|
107
|
-
const meta = getEventMeta(error);
|
|
108
|
-
eventIteratorLastEventId = meta?.id ?? eventIteratorLastEventId;
|
|
109
|
-
eventIteratorLastRetry = meta?.retry ?? eventIteratorLastRetry;
|
|
110
|
-
const maybeEventIterator = await next({ error });
|
|
111
|
-
if (!isAsyncIteratorObject(maybeEventIterator)) {
|
|
112
|
-
throw new ClientRetryPluginInvalidEventIteratorRetryResponse(
|
|
113
|
-
"RetryPlugin: Expected an Event Iterator, got a non-Event Iterator"
|
|
114
|
-
);
|
|
115
|
-
}
|
|
116
|
-
current = maybeEventIterator;
|
|
117
|
-
}
|
|
118
|
-
}
|
|
119
|
-
} finally {
|
|
120
|
-
await current.return?.();
|
|
121
|
-
}
|
|
122
|
-
}();
|
|
123
|
-
});
|
|
124
|
-
}
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
export { ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse };
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
import { Interceptor } from '@orpc/shared';
|
|
2
|
-
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
3
|
-
import { a as ClientContext, C as ClientOptionsOut, b as ClientLink } from './client.CupM8eRP.mjs';
|
|
4
|
-
|
|
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>;
|
|
8
|
-
}
|
|
9
|
-
interface StandardLinkClient<T extends ClientContext> {
|
|
10
|
-
call(request: StandardRequest, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
declare class InvalidEventIteratorRetryResponse extends Error {
|
|
14
|
-
}
|
|
15
|
-
interface StandardLinkOptions<T extends ClientContext> {
|
|
16
|
-
interceptors?: Interceptor<{
|
|
17
|
-
path: readonly string[];
|
|
18
|
-
input: unknown;
|
|
19
|
-
options: ClientOptionsOut<T>;
|
|
20
|
-
}, unknown, unknown>[];
|
|
21
|
-
clientInterceptors?: Interceptor<{
|
|
22
|
-
request: StandardRequest;
|
|
23
|
-
}, StandardLazyResponse, unknown>[];
|
|
24
|
-
plugins?: ClientPlugin<T>[];
|
|
25
|
-
}
|
|
26
|
-
declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
|
27
|
-
#private;
|
|
28
|
-
readonly codec: StandardLinkCodec<T>;
|
|
29
|
-
readonly sender: StandardLinkClient<T>;
|
|
30
|
-
private readonly interceptors;
|
|
31
|
-
private readonly clientInterceptors;
|
|
32
|
-
constructor(codec: StandardLinkCodec<T>, sender: StandardLinkClient<T>, options?: StandardLinkOptions<T>);
|
|
33
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
interface ClientPlugin<T extends ClientContext> {
|
|
37
|
-
init?(options: StandardLinkOptions<T>): void;
|
|
38
|
-
}
|
|
39
|
-
declare class CompositeClientPlugin<T extends ClientContext> implements ClientPlugin<T> {
|
|
40
|
-
private readonly plugins;
|
|
41
|
-
constructor(plugins?: ClientPlugin<T>[]);
|
|
42
|
-
init(options: StandardLinkOptions<T>): void;
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
export { type ClientPlugin as C, InvalidEventIteratorRetryResponse as I, type StandardLinkOptions as S, CompositeClientPlugin as a, type StandardLinkClient as b, type StandardLinkCodec as c, StandardLink as d };
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
import { Interceptor } from '@orpc/shared';
|
|
2
|
-
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
3
|
-
import { a as ClientContext, C as ClientOptionsOut, b as ClientLink } from './client.CupM8eRP.js';
|
|
4
|
-
|
|
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>;
|
|
8
|
-
}
|
|
9
|
-
interface StandardLinkClient<T extends ClientContext> {
|
|
10
|
-
call(request: StandardRequest, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
declare class InvalidEventIteratorRetryResponse extends Error {
|
|
14
|
-
}
|
|
15
|
-
interface StandardLinkOptions<T extends ClientContext> {
|
|
16
|
-
interceptors?: Interceptor<{
|
|
17
|
-
path: readonly string[];
|
|
18
|
-
input: unknown;
|
|
19
|
-
options: ClientOptionsOut<T>;
|
|
20
|
-
}, unknown, unknown>[];
|
|
21
|
-
clientInterceptors?: Interceptor<{
|
|
22
|
-
request: StandardRequest;
|
|
23
|
-
}, StandardLazyResponse, unknown>[];
|
|
24
|
-
plugins?: ClientPlugin<T>[];
|
|
25
|
-
}
|
|
26
|
-
declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
|
27
|
-
#private;
|
|
28
|
-
readonly codec: StandardLinkCodec<T>;
|
|
29
|
-
readonly sender: StandardLinkClient<T>;
|
|
30
|
-
private readonly interceptors;
|
|
31
|
-
private readonly clientInterceptors;
|
|
32
|
-
constructor(codec: StandardLinkCodec<T>, sender: StandardLinkClient<T>, options?: StandardLinkOptions<T>);
|
|
33
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
interface ClientPlugin<T extends ClientContext> {
|
|
37
|
-
init?(options: StandardLinkOptions<T>): void;
|
|
38
|
-
}
|
|
39
|
-
declare class CompositeClientPlugin<T extends ClientContext> implements ClientPlugin<T> {
|
|
40
|
-
private readonly plugins;
|
|
41
|
-
constructor(plugins?: ClientPlugin<T>[]);
|
|
42
|
-
init(options: StandardLinkOptions<T>): void;
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
export { type ClientPlugin as C, InvalidEventIteratorRetryResponse as I, type StandardLinkOptions as S, CompositeClientPlugin as a, type StandardLinkClient as b, type StandardLinkCodec as c, StandardLink as d };
|