@orpc/client 1.0.0-beta.5 → 1.0.0-beta.6
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/dist/adapters/fetch/index.d.mts +4 -4
- package/dist/adapters/fetch/index.d.ts +4 -4
- package/dist/adapters/fetch/index.mjs +4 -7
- package/dist/adapters/standard/index.d.mts +3 -3
- package/dist/adapters/standard/index.d.ts +3 -3
- package/dist/adapters/standard/index.mjs +2 -2
- package/dist/index.d.mts +11 -11
- package/dist/index.d.ts +11 -11
- package/dist/index.mjs +5 -5
- package/dist/plugins/index.d.mts +102 -20
- package/dist/plugins/index.d.ts +102 -20
- package/dist/plugins/index.mjs +196 -32
- package/dist/shared/{client.grRbC25r.d.ts → client.Bt2hFtM_.d.mts} +18 -12
- package/dist/shared/{client.jKEwIsRd.mjs → client.CRWEpqLB.mjs} +17 -17
- package/dist/shared/{client.C0lT7w02.d.mts → client.CipPQkhk.d.mts} +6 -7
- package/dist/shared/{client.C0lT7w02.d.ts → client.CipPQkhk.d.ts} +6 -7
- package/dist/shared/{client.Bt94sjrK.d.mts → client.DXvQo1nS.d.mts} +10 -23
- package/dist/shared/{client.D-jrSuDb.d.ts → client.Dc8eXpCj.d.ts} +10 -23
- package/dist/shared/{client.DhAxdT4W.mjs → client.DpICn1BD.mjs} +34 -15
- package/dist/shared/{client.5813Ufvs.d.mts → client.FvDtk0Vr.d.ts} +18 -12
- package/package.json +4 -4
@@ -1,8 +1,8 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
-
import { a as ClientContext, b as ClientOptions } from '../../shared/client.
|
4
|
-
import {
|
5
|
-
import { f as StandardRPCLinkOptions } from '../../shared/client.
|
3
|
+
import { a as ClientContext, b as ClientOptions } from '../../shared/client.CipPQkhk.mjs';
|
4
|
+
import { f as StandardLinkClient } from '../../shared/client.Bt2hFtM_.mjs';
|
5
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.DXvQo1nS.mjs';
|
6
6
|
import '@orpc/shared';
|
7
7
|
|
8
8
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
@@ -19,7 +19,7 @@ declare class LinkFetchClient<T extends ClientContext> implements StandardLinkCl
|
|
19
19
|
|
20
20
|
interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
|
21
21
|
}
|
22
|
-
declare class RPCLink<T extends ClientContext> extends
|
22
|
+
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
23
23
|
constructor(options: RPCLinkOptions<T>);
|
24
24
|
}
|
25
25
|
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
2
2
|
import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
|
3
|
-
import { a as ClientContext, b as ClientOptions } from '../../shared/client.
|
4
|
-
import {
|
5
|
-
import { f as StandardRPCLinkOptions } from '../../shared/client.
|
3
|
+
import { a as ClientContext, b as ClientOptions } from '../../shared/client.CipPQkhk.js';
|
4
|
+
import { f as StandardLinkClient } from '../../shared/client.FvDtk0Vr.js';
|
5
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.Dc8eXpCj.js';
|
6
6
|
import '@orpc/shared';
|
7
7
|
|
8
8
|
interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
|
@@ -19,7 +19,7 @@ declare class LinkFetchClient<T extends ClientContext> implements StandardLinkCl
|
|
19
19
|
|
20
20
|
interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
|
21
21
|
}
|
22
|
-
declare class RPCLink<T extends ClientContext> extends
|
22
|
+
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
23
23
|
constructor(options: RPCLinkOptions<T>);
|
24
24
|
}
|
25
25
|
|
@@ -1,8 +1,8 @@
|
|
1
1
|
import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch';
|
2
|
-
import { S as StandardLink, b as StandardRPCJsonSerializer, c as StandardRPCLinkCodec, d as StandardRPCSerializer } from '../../shared/client.DhAxdT4W.mjs';
|
3
2
|
import '@orpc/shared';
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.DpICn1BD.mjs';
|
4
4
|
import '@orpc/standard-server';
|
5
|
-
import '../../shared/client.
|
5
|
+
import '../../shared/client.CRWEpqLB.mjs';
|
6
6
|
|
7
7
|
class LinkFetchClient {
|
8
8
|
fetch;
|
@@ -19,13 +19,10 @@ class LinkFetchClient {
|
|
19
19
|
}
|
20
20
|
}
|
21
21
|
|
22
|
-
class RPCLink extends
|
22
|
+
class RPCLink extends StandardRPCLink {
|
23
23
|
constructor(options) {
|
24
|
-
const jsonSerializer = new StandardRPCJsonSerializer(options);
|
25
|
-
const serializer = new StandardRPCSerializer(jsonSerializer);
|
26
|
-
const linkCodec = new StandardRPCLinkCodec(serializer, options);
|
27
24
|
const linkClient = new LinkFetchClient(options);
|
28
|
-
super(
|
25
|
+
super(linkClient, options);
|
29
26
|
}
|
30
27
|
}
|
31
28
|
|
@@ -1,6 +1,6 @@
|
|
1
|
-
export {
|
2
|
-
export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions,
|
3
|
-
import { H as HTTPPath } from '../../shared/client.
|
1
|
+
export { C as CompositeStandardLinkPlugin, d as StandardLink, f as StandardLinkClient, S as StandardLinkClientInterceptorOptions, e as StandardLinkCodec, c as StandardLinkInterceptorOptions, b as StandardLinkOptions, a as StandardLinkPlugin } from '../../shared/client.Bt2hFtM_.mjs';
|
2
|
+
export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, g as StandardRPCLink, i as StandardRPCLinkCodec, h as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, j as StandardRPCSerializer } from '../../shared/client.DXvQo1nS.mjs';
|
3
|
+
import { H as HTTPPath } from '../../shared/client.CipPQkhk.mjs';
|
4
4
|
import '@orpc/shared';
|
5
5
|
import '@orpc/standard-server';
|
6
6
|
|
@@ -1,6 +1,6 @@
|
|
1
|
-
export {
|
2
|
-
export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions,
|
3
|
-
import { H as HTTPPath } from '../../shared/client.
|
1
|
+
export { C as CompositeStandardLinkPlugin, d as StandardLink, f as StandardLinkClient, S as StandardLinkClientInterceptorOptions, e as StandardLinkCodec, c as StandardLinkInterceptorOptions, b as StandardLinkOptions, a as StandardLinkPlugin } from '../../shared/client.FvDtk0Vr.js';
|
2
|
+
export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, g as StandardRPCLink, i as StandardRPCLinkCodec, h as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, j as StandardRPCSerializer } from '../../shared/client.Dc8eXpCj.js';
|
3
|
+
import { H as HTTPPath } from '../../shared/client.CipPQkhk.js';
|
4
4
|
import '@orpc/shared';
|
5
5
|
import '@orpc/standard-server';
|
6
6
|
|
@@ -1,4 +1,4 @@
|
|
1
|
-
export {
|
1
|
+
export { C as CompositeStandardLinkPlugin, a as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, S as StandardLink, b as StandardRPCJsonSerializer, c as StandardRPCLink, d as StandardRPCLinkCodec, e as StandardRPCSerializer, g as getMalformedResponseErrorCode, t as toHttpPath } from '../../shared/client.DpICn1BD.mjs';
|
2
2
|
import '@orpc/shared';
|
3
3
|
import '@orpc/standard-server';
|
4
|
-
import '../../shared/client.
|
4
|
+
import '../../shared/client.CRWEpqLB.mjs';
|
package/dist/index.d.mts
CHANGED
@@ -1,5 +1,5 @@
|
|
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.
|
2
|
-
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.
|
1
|
+
import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.CipPQkhk.mjs';
|
2
|
+
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.CipPQkhk.mjs';
|
3
3
|
import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
|
4
4
|
export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
@@ -120,36 +120,36 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
120
120
|
readonly data: TData;
|
121
121
|
constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
122
122
|
toJSON(): ORPCErrorJSON<TCode, TData>;
|
123
|
-
static fromJSON<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
124
|
-
static isValidJSON(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
125
123
|
}
|
126
124
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
127
125
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
128
126
|
declare function toORPCError(error: unknown): ORPCError<any, any>;
|
129
127
|
declare function isORPCErrorStatus(status: number): boolean;
|
128
|
+
declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
129
|
+
declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
130
130
|
|
131
131
|
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
132
132
|
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
133
133
|
error: (error: unknown) => Promise<unknown>;
|
134
134
|
}): AsyncGenerator<TMap, TMap, TNext>;
|
135
135
|
|
136
|
-
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false,
|
136
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
137
137
|
error: null;
|
138
138
|
data: TOutput;
|
139
139
|
isDefined: false;
|
140
|
-
|
141
|
-
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false,
|
140
|
+
isSuccess: true;
|
141
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
|
142
142
|
error: Exclude<TError, ORPCError<any, any>>;
|
143
143
|
data: undefined;
|
144
144
|
isDefined: false;
|
145
|
-
|
146
|
-
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true,
|
145
|
+
isSuccess: false;
|
146
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
|
147
147
|
error: Extract<TError, ORPCError<any, any>>;
|
148
148
|
data: undefined;
|
149
149
|
isDefined: true;
|
150
|
-
|
150
|
+
isSuccess: false;
|
151
151
|
};
|
152
152
|
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
153
153
|
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
154
154
|
|
155
|
-
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, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
155
|
+
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, createORPCErrorFromJson, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
package/dist/index.d.ts
CHANGED
@@ -1,5 +1,5 @@
|
|
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.
|
2
|
-
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.
|
1
|
+
import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.CipPQkhk.js';
|
2
|
+
export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.CipPQkhk.js';
|
3
3
|
import { Promisable, MaybeOptionalOptions, ThrowableError } from '@orpc/shared';
|
4
4
|
export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
5
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
@@ -120,36 +120,36 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
120
120
|
readonly data: TData;
|
121
121
|
constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
122
122
|
toJSON(): ORPCErrorJSON<TCode, TData>;
|
123
|
-
static fromJSON<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
124
|
-
static isValidJSON(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
125
123
|
}
|
126
124
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
127
125
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
128
126
|
declare function toORPCError(error: unknown): ORPCError<any, any>;
|
129
127
|
declare function isORPCErrorStatus(status: number): boolean;
|
128
|
+
declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
129
|
+
declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
130
130
|
|
131
131
|
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
132
132
|
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
133
133
|
error: (error: unknown) => Promise<unknown>;
|
134
134
|
}): AsyncGenerator<TMap, TMap, TNext>;
|
135
135
|
|
136
|
-
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false,
|
136
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
137
137
|
error: null;
|
138
138
|
data: TOutput;
|
139
139
|
isDefined: false;
|
140
|
-
|
141
|
-
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false,
|
140
|
+
isSuccess: true;
|
141
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
|
142
142
|
error: Exclude<TError, ORPCError<any, any>>;
|
143
143
|
data: undefined;
|
144
144
|
isDefined: false;
|
145
|
-
|
146
|
-
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true,
|
145
|
+
isSuccess: false;
|
146
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
|
147
147
|
error: Extract<TError, ORPCError<any, any>>;
|
148
148
|
data: undefined;
|
149
149
|
isDefined: true;
|
150
|
-
|
150
|
+
isSuccess: false;
|
151
151
|
};
|
152
152
|
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
153
153
|
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
154
154
|
|
155
|
-
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, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
155
|
+
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, createORPCErrorFromJson, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
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, b as isORPCErrorStatus, m as mapEventIterator, t as toORPCError } from './shared/client.
|
1
|
+
import { i as isDefinedError } from './shared/client.CRWEpqLB.mjs';
|
2
|
+
export { C as COMMON_ORPC_ERROR_DEFS, O as ORPCError, d as createORPCErrorFromJson, a as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, c as isORPCErrorJson, b as isORPCErrorStatus, m as mapEventIterator, t as toORPCError } from './shared/client.CRWEpqLB.mjs';
|
3
3
|
export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
4
4
|
export { ErrorEvent } from '@orpc/standard-server';
|
5
5
|
|
@@ -8,19 +8,19 @@ async function safe(promise) {
|
|
8
8
|
const output = await promise;
|
9
9
|
return Object.assign(
|
10
10
|
[null, output, false, true],
|
11
|
-
{ error: null, data: output, isDefined: false,
|
11
|
+
{ error: null, data: output, isDefined: false, isSuccess: true }
|
12
12
|
);
|
13
13
|
} catch (e) {
|
14
14
|
const error = e;
|
15
15
|
if (isDefinedError(error)) {
|
16
16
|
return Object.assign(
|
17
17
|
[error, void 0, true, false],
|
18
|
-
{ error, data: void 0, isDefined: true,
|
18
|
+
{ error, data: void 0, isDefined: true, isSuccess: false }
|
19
19
|
);
|
20
20
|
}
|
21
21
|
return Object.assign(
|
22
22
|
[error, void 0, false, false],
|
23
|
-
{ error, data: void 0, isDefined: false,
|
23
|
+
{ error, data: void 0, isDefined: false, isSuccess: false }
|
24
24
|
);
|
25
25
|
}
|
26
26
|
}
|
package/dist/plugins/index.d.mts
CHANGED
@@ -1,11 +1,73 @@
|
|
1
1
|
import { Value } from '@orpc/shared';
|
2
|
-
import {
|
3
|
-
import { b as
|
4
|
-
import '
|
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.Bt2hFtM_.mjs';
|
4
|
+
import { a as ClientContext } from '../shared/client.CipPQkhk.mjs';
|
5
5
|
|
6
|
-
interface
|
6
|
+
interface BatchLinkPluginGroup<T extends ClientContext> {
|
7
|
+
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
8
|
+
context: T;
|
9
|
+
path?: readonly string[];
|
10
|
+
input?: unknown;
|
11
|
+
}
|
12
|
+
interface BatchLinkPluginOptions<T extends ClientContext> {
|
13
|
+
groups: readonly [BatchLinkPluginGroup<T>, ...BatchLinkPluginGroup<T>[]];
|
14
|
+
/**
|
15
|
+
* The maximum number of requests in the batch.
|
16
|
+
*
|
17
|
+
* @default 10
|
18
|
+
*/
|
19
|
+
maxSize?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
20
|
+
/**
|
21
|
+
* Defines the URL to use for the batch request.
|
22
|
+
*
|
23
|
+
* @default the URL of the first request in the batch + '/__batch__'
|
24
|
+
*/
|
25
|
+
url?: Value<string | URL, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
26
|
+
/**
|
27
|
+
* The maximum length of the URL.
|
28
|
+
*
|
29
|
+
* @default 2083
|
30
|
+
*/
|
31
|
+
maxUrlLength?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
32
|
+
/**
|
33
|
+
* Defines the HTTP headers to use for the batch request.
|
34
|
+
*
|
35
|
+
* @default The same headers of all requests in the batch
|
36
|
+
*/
|
37
|
+
headers?: Value<StandardHeaders, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
38
|
+
/**
|
39
|
+
* Map the batch request items before sending them.
|
40
|
+
*
|
41
|
+
* @default Removes headers that are duplicated in the batch headers.
|
42
|
+
*/
|
43
|
+
mapRequestItem?: (options: StandardLinkClientInterceptorOptions<T> & {
|
44
|
+
batchUrl: URL;
|
45
|
+
batchHeaders: StandardHeaders;
|
46
|
+
}) => StandardRequest;
|
47
|
+
/**
|
48
|
+
* Exclude a request from the batch.
|
49
|
+
*
|
50
|
+
* @default () => false
|
51
|
+
*/
|
52
|
+
exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
53
|
+
}
|
54
|
+
declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
55
|
+
#private;
|
56
|
+
private readonly groups;
|
57
|
+
private readonly maxSize;
|
58
|
+
private readonly batchUrl;
|
59
|
+
private readonly maxUrlLength;
|
60
|
+
private readonly batchHeaders;
|
61
|
+
private readonly mapRequestItem;
|
62
|
+
private readonly exclude;
|
63
|
+
private pending;
|
64
|
+
order: number;
|
65
|
+
constructor(options: BatchLinkPluginOptions<T>);
|
66
|
+
init(options: StandardLinkOptions<T>): void;
|
67
|
+
}
|
68
|
+
|
69
|
+
interface ClientRetryPluginAttemptOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
|
7
70
|
lastEventRetry: number | undefined;
|
8
|
-
lastEventId: string | undefined;
|
9
71
|
attemptIndex: number;
|
10
72
|
error: unknown;
|
11
73
|
}
|
@@ -16,33 +78,23 @@ interface ClientRetryPluginContext {
|
|
16
78
|
*
|
17
79
|
* @default 0
|
18
80
|
*/
|
19
|
-
retry?: number
|
81
|
+
retry?: Value<number, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
|
20
82
|
/**
|
21
83
|
* Delay (in ms) before retrying.
|
22
84
|
*
|
23
85
|
* @default (o) => o.lastEventRetry ?? 2000
|
24
86
|
*/
|
25
|
-
retryDelay?: Value<number, [
|
26
|
-
attemptOptions: ClientRetryPluginAttemptOptions,
|
27
|
-
clientOptions: ClientOptions<ClientRetryPluginContext>,
|
28
|
-
path: readonly string[],
|
29
|
-
input: unknown
|
30
|
-
]>;
|
87
|
+
retryDelay?: Value<number, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
31
88
|
/**
|
32
89
|
* Determine should retry or not.
|
33
90
|
*
|
34
91
|
* @default true
|
35
92
|
*/
|
36
|
-
shouldRetry?: Value<boolean, [
|
37
|
-
attemptOptions: ClientRetryPluginAttemptOptions,
|
38
|
-
clientOptions: ClientOptions<ClientRetryPluginContext>,
|
39
|
-
path: readonly string[],
|
40
|
-
input: unknown
|
41
|
-
]>;
|
93
|
+
shouldRetry?: Value<boolean, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
42
94
|
/**
|
43
95
|
* The hook called when retrying, and return the unsubscribe function.
|
44
96
|
*/
|
45
|
-
onRetry?: (options: ClientRetryPluginAttemptOptions
|
97
|
+
onRetry?: (options: ClientRetryPluginAttemptOptions<ClientRetryPluginContext>) => void | (() => void);
|
46
98
|
}
|
47
99
|
declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
48
100
|
}
|
@@ -58,4 +110,34 @@ declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements S
|
|
58
110
|
init(options: StandardLinkOptions<T>): void;
|
59
111
|
}
|
60
112
|
|
61
|
-
|
113
|
+
interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
|
114
|
+
/**
|
115
|
+
* The name of the header to check.
|
116
|
+
*
|
117
|
+
* @default 'x-csrf-token'
|
118
|
+
*/
|
119
|
+
headerName?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
|
120
|
+
/**
|
121
|
+
* The value of the header to check.
|
122
|
+
*
|
123
|
+
* @default 'orpc'
|
124
|
+
*
|
125
|
+
*/
|
126
|
+
headerValue?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
|
127
|
+
/**
|
128
|
+
* Exclude a procedure from the plugin.
|
129
|
+
*
|
130
|
+
* @default false
|
131
|
+
*/
|
132
|
+
exclude?: Value<boolean, [options: StandardLinkClientInterceptorOptions<T>]>;
|
133
|
+
}
|
134
|
+
declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
135
|
+
private readonly headerName;
|
136
|
+
private readonly headerValue;
|
137
|
+
private readonly exclude;
|
138
|
+
constructor(options?: SimpleCsrfProtectionLinkPluginOptions<T>);
|
139
|
+
order: number;
|
140
|
+
init(options: StandardLinkOptions<T>): void;
|
141
|
+
}
|
142
|
+
|
143
|
+
export { BatchLinkPlugin, type BatchLinkPluginGroup, type BatchLinkPluginOptions, ClientRetryPlugin, type ClientRetryPluginAttemptOptions, type ClientRetryPluginContext, ClientRetryPluginInvalidEventIteratorRetryResponse, type ClientRetryPluginOptions, SimpleCsrfProtectionLinkPlugin, type SimpleCsrfProtectionLinkPluginOptions };
|
package/dist/plugins/index.d.ts
CHANGED
@@ -1,11 +1,73 @@
|
|
1
1
|
import { Value } from '@orpc/shared';
|
2
|
-
import {
|
3
|
-
import { b as
|
4
|
-
import '
|
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.FvDtk0Vr.js';
|
4
|
+
import { a as ClientContext } from '../shared/client.CipPQkhk.js';
|
5
5
|
|
6
|
-
interface
|
6
|
+
interface BatchLinkPluginGroup<T extends ClientContext> {
|
7
|
+
condition(options: StandardLinkClientInterceptorOptions<T>): boolean;
|
8
|
+
context: T;
|
9
|
+
path?: readonly string[];
|
10
|
+
input?: unknown;
|
11
|
+
}
|
12
|
+
interface BatchLinkPluginOptions<T extends ClientContext> {
|
13
|
+
groups: readonly [BatchLinkPluginGroup<T>, ...BatchLinkPluginGroup<T>[]];
|
14
|
+
/**
|
15
|
+
* The maximum number of requests in the batch.
|
16
|
+
*
|
17
|
+
* @default 10
|
18
|
+
*/
|
19
|
+
maxSize?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
20
|
+
/**
|
21
|
+
* Defines the URL to use for the batch request.
|
22
|
+
*
|
23
|
+
* @default the URL of the first request in the batch + '/__batch__'
|
24
|
+
*/
|
25
|
+
url?: Value<string | URL, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
26
|
+
/**
|
27
|
+
* The maximum length of the URL.
|
28
|
+
*
|
29
|
+
* @default 2083
|
30
|
+
*/
|
31
|
+
maxUrlLength?: Value<number, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
32
|
+
/**
|
33
|
+
* Defines the HTTP headers to use for the batch request.
|
34
|
+
*
|
35
|
+
* @default The same headers of all requests in the batch
|
36
|
+
*/
|
37
|
+
headers?: Value<StandardHeaders, [readonly [StandardLinkClientInterceptorOptions<T>, ...StandardLinkClientInterceptorOptions<T>[]]]>;
|
38
|
+
/**
|
39
|
+
* Map the batch request items before sending them.
|
40
|
+
*
|
41
|
+
* @default Removes headers that are duplicated in the batch headers.
|
42
|
+
*/
|
43
|
+
mapRequestItem?: (options: StandardLinkClientInterceptorOptions<T> & {
|
44
|
+
batchUrl: URL;
|
45
|
+
batchHeaders: StandardHeaders;
|
46
|
+
}) => StandardRequest;
|
47
|
+
/**
|
48
|
+
* Exclude a request from the batch.
|
49
|
+
*
|
50
|
+
* @default () => false
|
51
|
+
*/
|
52
|
+
exclude?: (options: StandardLinkClientInterceptorOptions<T>) => boolean;
|
53
|
+
}
|
54
|
+
declare class BatchLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
55
|
+
#private;
|
56
|
+
private readonly groups;
|
57
|
+
private readonly maxSize;
|
58
|
+
private readonly batchUrl;
|
59
|
+
private readonly maxUrlLength;
|
60
|
+
private readonly batchHeaders;
|
61
|
+
private readonly mapRequestItem;
|
62
|
+
private readonly exclude;
|
63
|
+
private pending;
|
64
|
+
order: number;
|
65
|
+
constructor(options: BatchLinkPluginOptions<T>);
|
66
|
+
init(options: StandardLinkOptions<T>): void;
|
67
|
+
}
|
68
|
+
|
69
|
+
interface ClientRetryPluginAttemptOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
|
7
70
|
lastEventRetry: number | undefined;
|
8
|
-
lastEventId: string | undefined;
|
9
71
|
attemptIndex: number;
|
10
72
|
error: unknown;
|
11
73
|
}
|
@@ -16,33 +78,23 @@ interface ClientRetryPluginContext {
|
|
16
78
|
*
|
17
79
|
* @default 0
|
18
80
|
*/
|
19
|
-
retry?: number
|
81
|
+
retry?: Value<number, [StandardLinkInterceptorOptions<ClientRetryPluginContext>]>;
|
20
82
|
/**
|
21
83
|
* Delay (in ms) before retrying.
|
22
84
|
*
|
23
85
|
* @default (o) => o.lastEventRetry ?? 2000
|
24
86
|
*/
|
25
|
-
retryDelay?: Value<number, [
|
26
|
-
attemptOptions: ClientRetryPluginAttemptOptions,
|
27
|
-
clientOptions: ClientOptions<ClientRetryPluginContext>,
|
28
|
-
path: readonly string[],
|
29
|
-
input: unknown
|
30
|
-
]>;
|
87
|
+
retryDelay?: Value<number, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
31
88
|
/**
|
32
89
|
* Determine should retry or not.
|
33
90
|
*
|
34
91
|
* @default true
|
35
92
|
*/
|
36
|
-
shouldRetry?: Value<boolean, [
|
37
|
-
attemptOptions: ClientRetryPluginAttemptOptions,
|
38
|
-
clientOptions: ClientOptions<ClientRetryPluginContext>,
|
39
|
-
path: readonly string[],
|
40
|
-
input: unknown
|
41
|
-
]>;
|
93
|
+
shouldRetry?: Value<boolean, [ClientRetryPluginAttemptOptions<ClientRetryPluginContext>]>;
|
42
94
|
/**
|
43
95
|
* The hook called when retrying, and return the unsubscribe function.
|
44
96
|
*/
|
45
|
-
onRetry?: (options: ClientRetryPluginAttemptOptions
|
97
|
+
onRetry?: (options: ClientRetryPluginAttemptOptions<ClientRetryPluginContext>) => void | (() => void);
|
46
98
|
}
|
47
99
|
declare class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
48
100
|
}
|
@@ -58,4 +110,34 @@ declare class ClientRetryPlugin<T extends ClientRetryPluginContext> implements S
|
|
58
110
|
init(options: StandardLinkOptions<T>): void;
|
59
111
|
}
|
60
112
|
|
61
|
-
|
113
|
+
interface SimpleCsrfProtectionLinkPluginOptions<T extends ClientContext> {
|
114
|
+
/**
|
115
|
+
* The name of the header to check.
|
116
|
+
*
|
117
|
+
* @default 'x-csrf-token'
|
118
|
+
*/
|
119
|
+
headerName?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
|
120
|
+
/**
|
121
|
+
* The value of the header to check.
|
122
|
+
*
|
123
|
+
* @default 'orpc'
|
124
|
+
*
|
125
|
+
*/
|
126
|
+
headerValue?: Value<string, [options: StandardLinkClientInterceptorOptions<T>]>;
|
127
|
+
/**
|
128
|
+
* Exclude a procedure from the plugin.
|
129
|
+
*
|
130
|
+
* @default false
|
131
|
+
*/
|
132
|
+
exclude?: Value<boolean, [options: StandardLinkClientInterceptorOptions<T>]>;
|
133
|
+
}
|
134
|
+
declare class SimpleCsrfProtectionLinkPlugin<T extends ClientContext> implements StandardLinkPlugin<T> {
|
135
|
+
private readonly headerName;
|
136
|
+
private readonly headerValue;
|
137
|
+
private readonly exclude;
|
138
|
+
constructor(options?: SimpleCsrfProtectionLinkPluginOptions<T>);
|
139
|
+
order: number;
|
140
|
+
init(options: StandardLinkOptions<T>): void;
|
141
|
+
}
|
142
|
+
|
143
|
+
export { BatchLinkPlugin, type BatchLinkPluginGroup, type BatchLinkPluginOptions, ClientRetryPlugin, type ClientRetryPluginAttemptOptions, type ClientRetryPluginContext, ClientRetryPluginInvalidEventIteratorRetryResponse, type ClientRetryPluginOptions, SimpleCsrfProtectionLinkPlugin, type SimpleCsrfProtectionLinkPluginOptions };
|