@orpc/client 0.0.0-next.b45a533 → 0.0.0-next.b47b94e
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 +25 -17
- package/dist/adapters/fetch/index.d.mts +17 -13
- package/dist/adapters/fetch/index.d.ts +17 -13
- package/dist/adapters/fetch/index.mjs +5 -11
- package/dist/adapters/standard/index.d.mts +8 -146
- package/dist/adapters/standard/index.d.ts +8 -146
- package/dist/adapters/standard/index.mjs +2 -2
- package/dist/adapters/websocket/index.d.mts +29 -0
- package/dist/adapters/websocket/index.d.ts +29 -0
- package/dist/adapters/websocket/index.mjs +31 -0
- package/dist/index.d.mts +36 -22
- package/dist/index.d.ts +36 -22
- package/dist/index.mjs +35 -33
- package/dist/plugins/index.d.mts +162 -0
- package/dist/plugins/index.d.ts +162 -0
- package/dist/plugins/index.mjs +291 -0
- package/dist/shared/client.4TS_0JaO.d.mts +29 -0
- package/dist/shared/client.4TS_0JaO.d.ts +29 -0
- package/dist/shared/client.7ZYxJok_.d.ts +46 -0
- package/dist/shared/client.B2432-Lu.d.ts +91 -0
- package/dist/shared/client.CRWEpqLB.mjs +175 -0
- package/dist/shared/client.ClwIM_ku.d.mts +91 -0
- package/dist/shared/{client.Df5pd75N.mjs → client.DpICn1BD.mjs} +113 -78
- package/dist/shared/client.ds1abV85.d.mts +46 -0
- package/package.json +15 -4
- package/dist/shared/client.D_CzLDyB.d.mts +0 -42
- package/dist/shared/client.D_CzLDyB.d.ts +0 -42
- package/dist/shared/client.XAn8cDTM.mjs +0 -266
package/dist/index.d.mts
CHANGED
@@ -1,6 +1,7 @@
|
|
1
|
-
import { N as NestedClient,
|
2
|
-
export {
|
3
|
-
import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
|
1
|
+
import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.4TS_0JaO.mjs';
|
2
|
+
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.4TS_0JaO.mjs';
|
3
|
+
import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
|
4
|
+
export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
4
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
5
6
|
|
6
7
|
interface createORPCClientOptions {
|
@@ -9,16 +10,23 @@ interface createORPCClientOptions {
|
|
9
10
|
*/
|
10
11
|
path?: string[];
|
11
12
|
}
|
13
|
+
/**
|
14
|
+
* Create a oRPC client-side client from a link.
|
15
|
+
*
|
16
|
+
* @see {@link https://orpc.unnoq.com/docs/client/client-side Client-side Client Docs}
|
17
|
+
*/
|
12
18
|
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
13
19
|
|
14
20
|
/**
|
15
21
|
* DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
|
16
22
|
* based on the request path, input, and context.
|
23
|
+
*
|
24
|
+
* @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
|
17
25
|
*/
|
18
26
|
declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
|
19
27
|
private readonly linkResolver;
|
20
|
-
constructor(linkResolver: (options:
|
21
|
-
call(path: readonly string[], input: unknown, options:
|
28
|
+
constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
|
29
|
+
call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
|
22
30
|
}
|
23
31
|
|
24
32
|
declare const COMMON_ORPC_ERROR_DEFS: {
|
@@ -119,37 +127,43 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
119
127
|
readonly data: TData;
|
120
128
|
constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
121
129
|
toJSON(): ORPCErrorJSON<TCode, TData>;
|
122
|
-
static fromJSON<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
123
|
-
static isValidJSON(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
124
130
|
}
|
125
131
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
126
132
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
127
133
|
declare function toORPCError(error: unknown): ORPCError<any, any>;
|
134
|
+
declare function isORPCErrorStatus(status: number): boolean;
|
135
|
+
declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
136
|
+
declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
128
137
|
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
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, options?: {
|
137
|
-
notifyImmediately?: boolean;
|
138
|
-
}): () => void;
|
138
|
+
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
139
|
+
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
140
|
+
error: (error: unknown) => Promise<unknown>;
|
141
|
+
}): AsyncGenerator<TMap, TMap, TNext>;
|
139
142
|
|
140
|
-
type SafeResult<TOutput, TError
|
143
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
141
144
|
error: null;
|
142
145
|
data: TOutput;
|
143
146
|
isDefined: false;
|
144
|
-
|
147
|
+
isSuccess: true;
|
148
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
|
145
149
|
error: Exclude<TError, ORPCError<any, any>>;
|
146
150
|
data: undefined;
|
147
151
|
isDefined: false;
|
148
|
-
|
152
|
+
isSuccess: false;
|
153
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
|
149
154
|
error: Extract<TError, ORPCError<any, any>>;
|
150
155
|
data: undefined;
|
151
156
|
isDefined: true;
|
157
|
+
isSuccess: false;
|
152
158
|
};
|
153
|
-
|
159
|
+
/**
|
160
|
+
* Works like try/catch, but can infer error types.
|
161
|
+
*
|
162
|
+
* @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
|
163
|
+
* @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
|
164
|
+
*/
|
165
|
+
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
166
|
+
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
154
167
|
|
155
|
-
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink,
|
168
|
+
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
169
|
+
export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeResult, createORPCClientOptions };
|
package/dist/index.d.ts
CHANGED
@@ -1,6 +1,7 @@
|
|
1
|
-
import { N as NestedClient,
|
2
|
-
export {
|
3
|
-
import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
|
1
|
+
import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.4TS_0JaO.js';
|
2
|
+
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.4TS_0JaO.js';
|
3
|
+
import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
|
4
|
+
export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
4
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
5
6
|
|
6
7
|
interface createORPCClientOptions {
|
@@ -9,16 +10,23 @@ interface createORPCClientOptions {
|
|
9
10
|
*/
|
10
11
|
path?: string[];
|
11
12
|
}
|
13
|
+
/**
|
14
|
+
* Create a oRPC client-side client from a link.
|
15
|
+
*
|
16
|
+
* @see {@link https://orpc.unnoq.com/docs/client/client-side Client-side Client Docs}
|
17
|
+
*/
|
12
18
|
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
13
19
|
|
14
20
|
/**
|
15
21
|
* DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
|
16
22
|
* based on the request path, input, and context.
|
23
|
+
*
|
24
|
+
* @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
|
17
25
|
*/
|
18
26
|
declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
|
19
27
|
private readonly linkResolver;
|
20
|
-
constructor(linkResolver: (options:
|
21
|
-
call(path: readonly string[], input: unknown, options:
|
28
|
+
constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
|
29
|
+
call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
|
22
30
|
}
|
23
31
|
|
24
32
|
declare const COMMON_ORPC_ERROR_DEFS: {
|
@@ -119,37 +127,43 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
119
127
|
readonly data: TData;
|
120
128
|
constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
121
129
|
toJSON(): ORPCErrorJSON<TCode, TData>;
|
122
|
-
static fromJSON<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
123
|
-
static isValidJSON(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
124
130
|
}
|
125
131
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
126
132
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
127
133
|
declare function toORPCError(error: unknown): ORPCError<any, any>;
|
134
|
+
declare function isORPCErrorStatus(status: number): boolean;
|
135
|
+
declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
136
|
+
declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
128
137
|
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
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, options?: {
|
137
|
-
notifyImmediately?: boolean;
|
138
|
-
}): () => void;
|
138
|
+
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
139
|
+
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
140
|
+
error: (error: unknown) => Promise<unknown>;
|
141
|
+
}): AsyncGenerator<TMap, TMap, TNext>;
|
139
142
|
|
140
|
-
type SafeResult<TOutput, TError
|
143
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
141
144
|
error: null;
|
142
145
|
data: TOutput;
|
143
146
|
isDefined: false;
|
144
|
-
|
147
|
+
isSuccess: true;
|
148
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
|
145
149
|
error: Exclude<TError, ORPCError<any, any>>;
|
146
150
|
data: undefined;
|
147
151
|
isDefined: false;
|
148
|
-
|
152
|
+
isSuccess: false;
|
153
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
|
149
154
|
error: Extract<TError, ORPCError<any, any>>;
|
150
155
|
data: undefined;
|
151
156
|
isDefined: true;
|
157
|
+
isSuccess: false;
|
152
158
|
};
|
153
|
-
|
159
|
+
/**
|
160
|
+
* Works like try/catch, but can infer error types.
|
161
|
+
*
|
162
|
+
* @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
|
163
|
+
* @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
|
164
|
+
*/
|
165
|
+
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
166
|
+
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
154
167
|
|
155
|
-
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink,
|
168
|
+
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
169
|
+
export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeResult, createORPCClientOptions };
|
package/dist/index.mjs
CHANGED
@@ -1,17 +1,41 @@
|
|
1
|
-
import { i as isDefinedError } from './shared/client.
|
2
|
-
export { C as COMMON_ORPC_ERROR_DEFS, O as ORPCError,
|
1
|
+
import { i as isDefinedError } from './shared/client.CRWEpqLB.mjs';
|
2
|
+
export { C as COMMON_ORPC_ERROR_DEFS, O as ORPCError, d as createORPCErrorFromJson, a as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, c as isORPCErrorJson, b as isORPCErrorStatus, m as mapEventIterator, t as toORPCError } from './shared/client.CRWEpqLB.mjs';
|
3
|
+
export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
3
4
|
export { ErrorEvent } from '@orpc/standard-server';
|
4
|
-
|
5
|
+
|
6
|
+
async function safe(promise) {
|
7
|
+
try {
|
8
|
+
const output = await promise;
|
9
|
+
return Object.assign(
|
10
|
+
[null, output, false, true],
|
11
|
+
{ error: null, data: output, isDefined: false, isSuccess: true }
|
12
|
+
);
|
13
|
+
} catch (e) {
|
14
|
+
const error = e;
|
15
|
+
if (isDefinedError(error)) {
|
16
|
+
return Object.assign(
|
17
|
+
[error, void 0, true, false],
|
18
|
+
{ error, data: void 0, isDefined: true, isSuccess: false }
|
19
|
+
);
|
20
|
+
}
|
21
|
+
return Object.assign(
|
22
|
+
[error, void 0, false, false],
|
23
|
+
{ error, data: void 0, isDefined: false, isSuccess: false }
|
24
|
+
);
|
25
|
+
}
|
26
|
+
}
|
27
|
+
function resolveFriendlyClientOptions(options) {
|
28
|
+
return {
|
29
|
+
...options,
|
30
|
+
context: options?.context ?? {}
|
31
|
+
// Context only optional if all fields are optional
|
32
|
+
};
|
33
|
+
}
|
5
34
|
|
6
35
|
function createORPCClient(link, options) {
|
7
36
|
const path = options?.path ?? [];
|
8
|
-
const procedureClient = async (...[input, options2]) => {
|
9
|
-
|
10
|
-
...options2,
|
11
|
-
context: options2?.context ?? {}
|
12
|
-
// options.context can be undefined when all field is optional
|
13
|
-
};
|
14
|
-
return await link.call(path, input, optionsOut);
|
37
|
+
const procedureClient = async (...[input, options2 = {}]) => {
|
38
|
+
return await link.call(path, input, resolveFriendlyClientOptions(options2));
|
15
39
|
};
|
16
40
|
const recursive = new Proxy(procedureClient, {
|
17
41
|
get(target, key) {
|
@@ -38,26 +62,4 @@ class DynamicLink {
|
|
38
62
|
}
|
39
63
|
}
|
40
64
|
|
41
|
-
|
42
|
-
try {
|
43
|
-
const output = await promise;
|
44
|
-
return Object.assign(
|
45
|
-
[null, output, false],
|
46
|
-
{ error: null, data: output, isDefined: false }
|
47
|
-
);
|
48
|
-
} catch (e) {
|
49
|
-
const error = e;
|
50
|
-
if (isDefinedError(error)) {
|
51
|
-
return Object.assign(
|
52
|
-
[error, void 0, true],
|
53
|
-
{ error, data: void 0, isDefined: true }
|
54
|
-
);
|
55
|
-
}
|
56
|
-
return Object.assign(
|
57
|
-
[error, void 0, false],
|
58
|
-
{ error, data: void 0, isDefined: false }
|
59
|
-
);
|
60
|
-
}
|
61
|
-
}
|
62
|
-
|
63
|
-
export { DynamicLink, createORPCClient, isDefinedError, safe };
|
65
|
+
export { DynamicLink, createORPCClient, isDefinedError, resolveFriendlyClientOptions, safe };
|
@@ -0,0 +1,162 @@
|
|
1
|
+
import { Value } from '@orpc/shared';
|
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.ds1abV85.mjs';
|
4
|
+
import { a as ClientContext } from '../shared/client.4TS_0JaO.mjs';
|
5
|
+
|
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
|
+
/**
|
55
|
+
* The Batch Request/Response Plugin allows you to combine multiple requests and responses into a single batch,
|
56
|
+
* reducing the overhead of sending each one separately.
|
57
|
+
*
|
58
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-request-response Batch Request/Response Plugin Docs}
|
59
|
+
*/
|
60
|
+
declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
61
|
+
#private;
|
62
|
+
private readonly groups;
|
63
|
+
private readonly maxSize;
|
64
|
+
private readonly batchUrl;
|
65
|
+
private readonly maxUrlLength;
|
66
|
+
private readonly batchHeaders;
|
67
|
+
private readonly mapRequestItem;
|
68
|
+
private readonly exclude;
|
69
|
+
private pending;
|
70
|
+
order: number;
|
71
|
+
constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
|
72
|
+
init(options: StandardLinkOptions<T>): void;
|
73
|
+
}
|
74
|
+
|
75
|
+
interface ClientRetryPluginAttemptOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
|
76
|
+
lastEventRetry: number | undefined;
|
77
|
+
attemptIndex: number;
|
78
|
+
error: unknown;
|
79
|
+
}
|
80
|
+
interface ClientRetryPluginContext {
|
81
|
+
/**
|
82
|
+
* Maximum retry attempts before throwing
|
83
|
+
* Use `Number.POSITIVE_INFINITY` for infinite retries (e.g., when handling Server-Sent Events).
|
84
|
+
*
|
85
|
+
* @default 0
|
86
|
+
*/
|
87
|
+
retry?: Value<number, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
|
88
|
+
/**
|
89
|
+
* Delay (in ms) before retrying.
|
90
|
+
*
|
91
|
+
* @default (o) => o.lastEventRetry ?? 2000
|
92
|
+
*/
|
93
|
+
retryDelay?: Value<number, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
94
|
+
/**
|
95
|
+
* Determine should retry or not.
|
96
|
+
*
|
97
|
+
* @default true
|
98
|
+
*/
|
99
|
+
shouldRetry?: Value<boolean, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
100
|
+
/**
|
101
|
+
* The hook called when retrying, and return the unsubscribe function.
|
102
|
+
*/
|
103
|
+
onRetry?: (options: ClientRetryPluginAttemptOptions<ClientRetryPluginContext>) => void | ((isSuccess: boolean) => void);
|
104
|
+
}
|
105
|
+
declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
106
|
+
}
|
107
|
+
interface ClientRetryPluginOptions {
|
108
|
+
default?: ClientRetryPluginContext;
|
109
|
+
}
|
110
|
+
/**
|
111
|
+
* The Client Retry Plugin enables retrying client calls when errors occur.
|
112
|
+
*
|
113
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/client-retry Client Retry Plugin Docs}
|
114
|
+
*/
|
115
|
+
declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements StandardLinkPlugin<T> {
|
116
|
+
private readonly defaultRetry;
|
117
|
+
private readonly defaultRetryDelay;
|
118
|
+
private readonly defaultShouldRetry;
|
119
|
+
private readonly defaultOnRetry;
|
120
|
+
constructor(options?: ClientRetryPluginOptions);
|
121
|
+
init(options: StandardLinkOptions<T>): void;
|
122
|
+
}
|
123
|
+
|
124
|
+
interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
|
125
|
+
/**
|
126
|
+
* The name of the header to check.
|
127
|
+
*
|
128
|
+
* @default 'x-csrf-token'
|
129
|
+
*/
|
130
|
+
headerName?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
|
131
|
+
/**
|
132
|
+
* The value of the header to check.
|
133
|
+
*
|
134
|
+
* @default 'orpc'
|
135
|
+
*
|
136
|
+
*/
|
137
|
+
headerValue?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
|
138
|
+
/**
|
139
|
+
* Exclude a procedure from the plugin.
|
140
|
+
*
|
141
|
+
* @default false
|
142
|
+
*/
|
143
|
+
exclude?: Value<boolean, [options: StandardLinkClientInterceptorOptions<T>]>;
|
144
|
+
}
|
145
|
+
/**
|
146
|
+
* This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
|
147
|
+
* It helps ensure that requests to your procedures originate from JavaScript code,
|
148
|
+
* not from other sources like standard HTML forms or direct browser navigation.
|
149
|
+
*
|
150
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
|
151
|
+
*/
|
152
|
+
declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
153
|
+
private readonly headerName;
|
154
|
+
private readonly headerValue;
|
155
|
+
private readonly exclude;
|
156
|
+
constructor(options?: SimpleCsrfProtectionLinkPluginOptions<T>);
|
157
|
+
order: number;
|
158
|
+
init(options: StandardLinkOptions<T>): void;
|
159
|
+
}
|
160
|
+
|
161
|
+
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
|
162
|
+
export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
|
@@ -0,0 +1,162 @@
|
|
1
|
+
import { Value } from '@orpc/shared';
|
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.7ZYxJok_.js';
|
4
|
+
import { a as ClientContext } from '../shared/client.4TS_0JaO.js';
|
5
|
+
|
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
|
+
/**
|
55
|
+
* The Batch Request/Response Plugin allows you to combine multiple requests and responses into a single batch,
|
56
|
+
* reducing the overhead of sending each one separately.
|
57
|
+
*
|
58
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/batch-request-response Batch Request/Response Plugin Docs}
|
59
|
+
*/
|
60
|
+
declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
61
|
+
#private;
|
62
|
+
private readonly groups;
|
63
|
+
private readonly maxSize;
|
64
|
+
private readonly batchUrl;
|
65
|
+
private readonly maxUrlLength;
|
66
|
+
private readonly batchHeaders;
|
67
|
+
private readonly mapRequestItem;
|
68
|
+
private readonly exclude;
|
69
|
+
private pending;
|
70
|
+
order: number;
|
71
|
+
constructor(options: NoInfer<BatchLinkPluginOptions<T>>);
|
72
|
+
init(options: StandardLinkOptions<T>): void;
|
73
|
+
}
|
74
|
+
|
75
|
+
interface ClientRetryPluginAttemptOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
|
76
|
+
lastEventRetry: number | undefined;
|
77
|
+
attemptIndex: number;
|
78
|
+
error: unknown;
|
79
|
+
}
|
80
|
+
interface ClientRetryPluginContext {
|
81
|
+
/**
|
82
|
+
* Maximum retry attempts before throwing
|
83
|
+
* Use `Number.POSITIVE_INFINITY` for infinite retries (e.g., when handling Server-Sent Events).
|
84
|
+
*
|
85
|
+
* @default 0
|
86
|
+
*/
|
87
|
+
retry?: Value<number, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
|
88
|
+
/**
|
89
|
+
* Delay (in ms) before retrying.
|
90
|
+
*
|
91
|
+
* @default (o) => o.lastEventRetry ?? 2000
|
92
|
+
*/
|
93
|
+
retryDelay?: Value<number, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
94
|
+
/**
|
95
|
+
* Determine should retry or not.
|
96
|
+
*
|
97
|
+
* @default true
|
98
|
+
*/
|
99
|
+
shouldRetry?: Value<boolean, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
100
|
+
/**
|
101
|
+
* The hook called when retrying, and return the unsubscribe function.
|
102
|
+
*/
|
103
|
+
onRetry?: (options: ClientRetryPluginAttemptOptions<ClientRetryPluginContext>) => void | ((isSuccess: boolean) => void);
|
104
|
+
}
|
105
|
+
declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
106
|
+
}
|
107
|
+
interface ClientRetryPluginOptions {
|
108
|
+
default?: ClientRetryPluginContext;
|
109
|
+
}
|
110
|
+
/**
|
111
|
+
* The Client Retry Plugin enables retrying client calls when errors occur.
|
112
|
+
*
|
113
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/client-retry Client Retry Plugin Docs}
|
114
|
+
*/
|
115
|
+
declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements StandardLinkPlugin<T> {
|
116
|
+
private readonly defaultRetry;
|
117
|
+
private readonly defaultRetryDelay;
|
118
|
+
private readonly defaultShouldRetry;
|
119
|
+
private readonly defaultOnRetry;
|
120
|
+
constructor(options?: ClientRetryPluginOptions);
|
121
|
+
init(options: StandardLinkOptions<T>): void;
|
122
|
+
}
|
123
|
+
|
124
|
+
interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
|
125
|
+
/**
|
126
|
+
* The name of the header to check.
|
127
|
+
*
|
128
|
+
* @default 'x-csrf-token'
|
129
|
+
*/
|
130
|
+
headerName?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
|
131
|
+
/**
|
132
|
+
* The value of the header to check.
|
133
|
+
*
|
134
|
+
* @default 'orpc'
|
135
|
+
*
|
136
|
+
*/
|
137
|
+
headerValue?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
|
138
|
+
/**
|
139
|
+
* Exclude a procedure from the plugin.
|
140
|
+
*
|
141
|
+
* @default false
|
142
|
+
*/
|
143
|
+
exclude?: Value<boolean, [options: StandardLinkClientInterceptorOptions<T>]>;
|
144
|
+
}
|
145
|
+
/**
|
146
|
+
* This plugin adds basic Cross-Site Request Forgery (CSRF) protection to your oRPC application.
|
147
|
+
* It helps ensure that requests to your procedures originate from JavaScript code,
|
148
|
+
* not from other sources like standard HTML forms or direct browser navigation.
|
149
|
+
*
|
150
|
+
* @see {@link https://orpc.unnoq.com/docs/plugins/simple-csrf-protection Simple CSRF Protection Plugin Docs}
|
151
|
+
*/
|
152
|
+
declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
153
|
+
private readonly headerName;
|
154
|
+
private readonly headerValue;
|
155
|
+
private readonly exclude;
|
156
|
+
constructor(options?: SimpleCsrfProtectionLinkPluginOptions<T>);
|
157
|
+
order: number;
|
158
|
+
init(options: StandardLinkOptions<T>): void;
|
159
|
+
}
|
160
|
+
|
161
|
+
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
|
162
|
+
export type { BatchLinkPluginGroup, BatchLinkPluginOptions, ClientRetryPluginAttemptOptions, ClientRetryPluginContext, ClientRetryPluginOptions, SimpleCsrfProtectionLinkPluginOptions };
|