@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
@@ -0,0 +1,291 @@
|
|
1
|
+
import { isAsyncIteratorObject, value, splitInHalf, toArray } from '@orpc/shared';
|
2
|
+
import { toBatchRequest, parseBatchResponse } from '@orpc/standard-server/batch';
|
3
|
+
import { getEventMeta } from '@orpc/standard-server';
|
4
|
+
|
5
|
+
class BatchLinkPlugin {
|
6
|
+
groups;
|
7
|
+
maxSize;
|
8
|
+
batchUrl;
|
9
|
+
maxUrlLength;
|
10
|
+
batchHeaders;
|
11
|
+
mapRequestItem;
|
12
|
+
exclude;
|
13
|
+
pending;
|
14
|
+
order = 5e6;
|
15
|
+
constructor(options) {
|
16
|
+
this.groups = options.groups;
|
17
|
+
this.pending = /* @__PURE__ */ new Map();
|
18
|
+
this.maxSize = options.maxSize ?? 10;
|
19
|
+
this.maxUrlLength = options.maxUrlLength ?? 2083;
|
20
|
+
this.batchUrl = options.url ?? (([options2]) => `${options2.request.url.origin}${options2.request.url.pathname}/__batch__`);
|
21
|
+
this.batchHeaders = options.headers ?? (([options2, ...rest]) => {
|
22
|
+
const headers = {};
|
23
|
+
for (const [key, value2] of Object.entries(options2.request.headers)) {
|
24
|
+
if (rest.every((item) => item.request.headers[key] === value2)) {
|
25
|
+
headers[key] = value2;
|
26
|
+
}
|
27
|
+
}
|
28
|
+
return headers;
|
29
|
+
});
|
30
|
+
this.mapRequestItem = options.mapRequestItem ?? (({ request, batchHeaders }) => {
|
31
|
+
const headers = {};
|
32
|
+
for (const [key, value2] of Object.entries(request.headers)) {
|
33
|
+
if (batchHeaders[key] !== value2) {
|
34
|
+
headers[key] = value2;
|
35
|
+
}
|
36
|
+
}
|
37
|
+
return {
|
38
|
+
method: request.method,
|
39
|
+
url: request.url,
|
40
|
+
headers,
|
41
|
+
body: request.body,
|
42
|
+
signal: request.signal
|
43
|
+
};
|
44
|
+
});
|
45
|
+
this.exclude = options.exclude ?? (() => false);
|
46
|
+
}
|
47
|
+
init(options) {
|
48
|
+
options.clientInterceptors ??= [];
|
49
|
+
options.clientInterceptors.push((options2) => {
|
50
|
+
if (options2.request.headers["x-orpc-batch"] !== "1") {
|
51
|
+
return options2.next();
|
52
|
+
}
|
53
|
+
return options2.next({
|
54
|
+
...options2,
|
55
|
+
request: {
|
56
|
+
...options2.request,
|
57
|
+
headers: {
|
58
|
+
...options2.request.headers,
|
59
|
+
"x-orpc-batch": void 0
|
60
|
+
}
|
61
|
+
}
|
62
|
+
});
|
63
|
+
});
|
64
|
+
options.clientInterceptors.push((options2) => {
|
65
|
+
if (this.exclude(options2) || options2.request.body instanceof Blob || options2.request.body instanceof FormData || isAsyncIteratorObject(options2.request.body)) {
|
66
|
+
return options2.next();
|
67
|
+
}
|
68
|
+
const group = this.groups.find((group2) => group2.condition(options2));
|
69
|
+
if (!group) {
|
70
|
+
return options2.next();
|
71
|
+
}
|
72
|
+
return new Promise((resolve, reject) => {
|
73
|
+
this.#enqueueRequest(group, options2, resolve, reject);
|
74
|
+
setTimeout(() => this.#processPendingBatches());
|
75
|
+
});
|
76
|
+
});
|
77
|
+
}
|
78
|
+
#enqueueRequest(group, options, resolve, reject) {
|
79
|
+
const items = this.pending.get(group);
|
80
|
+
if (items) {
|
81
|
+
items.push([options, resolve, reject]);
|
82
|
+
} else {
|
83
|
+
this.pending.set(group, [[options, resolve, reject]]);
|
84
|
+
}
|
85
|
+
}
|
86
|
+
async #processPendingBatches() {
|
87
|
+
const pending = this.pending;
|
88
|
+
this.pending = /* @__PURE__ */ new Map();
|
89
|
+
for (const [group, items] of pending) {
|
90
|
+
const getItems = items.filter(([options]) => options.request.method === "GET");
|
91
|
+
const restItems = items.filter(([options]) => options.request.method !== "GET");
|
92
|
+
this.#executeBatch("GET", group, getItems);
|
93
|
+
this.#executeBatch("POST", group, restItems);
|
94
|
+
}
|
95
|
+
}
|
96
|
+
async #executeBatch(method, group, groupItems) {
|
97
|
+
if (!groupItems.length) {
|
98
|
+
return;
|
99
|
+
}
|
100
|
+
const batchItems = groupItems;
|
101
|
+
if (batchItems.length === 1) {
|
102
|
+
batchItems[0][0].next().then(batchItems[0][1]).catch(batchItems[0][2]);
|
103
|
+
return;
|
104
|
+
}
|
105
|
+
try {
|
106
|
+
const options = batchItems.map(([options2]) => options2);
|
107
|
+
const maxSize = await value(this.maxSize, options);
|
108
|
+
if (batchItems.length > maxSize) {
|
109
|
+
const [first, second] = splitInHalf(batchItems);
|
110
|
+
this.#executeBatch(method, group, first);
|
111
|
+
this.#executeBatch(method, group, second);
|
112
|
+
return;
|
113
|
+
}
|
114
|
+
const batchUrl = new URL(await value(this.batchUrl, options));
|
115
|
+
const batchHeaders = await value(this.batchHeaders, options);
|
116
|
+
const mappedItems = batchItems.map(([options2]) => this.mapRequestItem({ ...options2, batchUrl, batchHeaders }));
|
117
|
+
const batchRequest = toBatchRequest({
|
118
|
+
method,
|
119
|
+
url: batchUrl,
|
120
|
+
headers: batchHeaders,
|
121
|
+
requests: mappedItems
|
122
|
+
});
|
123
|
+
const maxUrlLength = await value(this.maxUrlLength, options);
|
124
|
+
if (batchRequest.url.toString().length > maxUrlLength) {
|
125
|
+
const [first, second] = splitInHalf(batchItems);
|
126
|
+
this.#executeBatch(method, group, first);
|
127
|
+
this.#executeBatch(method, group, second);
|
128
|
+
return;
|
129
|
+
}
|
130
|
+
const lazyResponse = await options[0].next({
|
131
|
+
request: { ...batchRequest, headers: { ...batchRequest.headers, "x-orpc-batch": "1" } },
|
132
|
+
signal: batchRequest.signal,
|
133
|
+
context: group.context,
|
134
|
+
input: group.input,
|
135
|
+
path: toArray(group.path)
|
136
|
+
});
|
137
|
+
const parsed = parseBatchResponse({ ...lazyResponse, body: await lazyResponse.body() });
|
138
|
+
for await (const item of parsed) {
|
139
|
+
batchItems[item.index]?.[1]({ ...item, body: () => Promise.resolve(item.body) });
|
140
|
+
}
|
141
|
+
throw new Error("Something went wrong make batch response not contains enough responses. This can be a bug please report it.");
|
142
|
+
} catch (error) {
|
143
|
+
for (const [, , reject] of batchItems) {
|
144
|
+
reject(error);
|
145
|
+
}
|
146
|
+
}
|
147
|
+
}
|
148
|
+
}
|
149
|
+
|
150
|
+
class ClientRetryPluginInvalidEventIteratorRetryResponse extends Error {
|
151
|
+
}
|
152
|
+
class ClientRetryPlugin {
|
153
|
+
defaultRetry;
|
154
|
+
defaultRetryDelay;
|
155
|
+
defaultShouldRetry;
|
156
|
+
defaultOnRetry;
|
157
|
+
constructor(options = {}) {
|
158
|
+
this.defaultRetry = options.default?.retry ?? 0;
|
159
|
+
this.defaultRetryDelay = options.default?.retryDelay ?? ((o) => o.lastEventRetry ?? 2e3);
|
160
|
+
this.defaultShouldRetry = options.default?.shouldRetry ?? true;
|
161
|
+
this.defaultOnRetry = options.default?.onRetry;
|
162
|
+
}
|
163
|
+
init(options) {
|
164
|
+
options.interceptors ??= [];
|
165
|
+
options.interceptors.push(async (interceptorOptions) => {
|
166
|
+
const maxAttempts = await value(
|
167
|
+
interceptorOptions.context.retry ?? this.defaultRetry,
|
168
|
+
interceptorOptions
|
169
|
+
);
|
170
|
+
const retryDelay = interceptorOptions.context.retryDelay ?? this.defaultRetryDelay;
|
171
|
+
const shouldRetry = interceptorOptions.context.shouldRetry ?? this.defaultShouldRetry;
|
172
|
+
const onRetry = interceptorOptions.context.onRetry ?? this.defaultOnRetry;
|
173
|
+
if (maxAttempts <= 0) {
|
174
|
+
return interceptorOptions.next();
|
175
|
+
}
|
176
|
+
let lastEventId = interceptorOptions.lastEventId;
|
177
|
+
let lastEventRetry;
|
178
|
+
let callback;
|
179
|
+
let attemptIndex = 0;
|
180
|
+
const next = async (initialError) => {
|
181
|
+
let currentError = initialError;
|
182
|
+
while (true) {
|
183
|
+
const updatedInterceptorOptions = { ...interceptorOptions, lastEventId };
|
184
|
+
if (currentError) {
|
185
|
+
if (attemptIndex >= maxAttempts) {
|
186
|
+
throw currentError.error;
|
187
|
+
}
|
188
|
+
const attemptOptions = {
|
189
|
+
...updatedInterceptorOptions,
|
190
|
+
attemptIndex,
|
191
|
+
error: currentError.error,
|
192
|
+
lastEventRetry
|
193
|
+
};
|
194
|
+
const shouldRetryBool = await value(
|
195
|
+
shouldRetry,
|
196
|
+
attemptOptions
|
197
|
+
);
|
198
|
+
if (!shouldRetryBool) {
|
199
|
+
throw currentError.error;
|
200
|
+
}
|
201
|
+
callback = onRetry?.(attemptOptions);
|
202
|
+
const retryDelayMs = await value(retryDelay, attemptOptions);
|
203
|
+
await new Promise((resolve) => setTimeout(resolve, retryDelayMs));
|
204
|
+
attemptIndex++;
|
205
|
+
}
|
206
|
+
try {
|
207
|
+
currentError = void 0;
|
208
|
+
return await interceptorOptions.next(updatedInterceptorOptions);
|
209
|
+
} catch (error) {
|
210
|
+
currentError = { error };
|
211
|
+
if (updatedInterceptorOptions.signal?.aborted === true) {
|
212
|
+
throw error;
|
213
|
+
}
|
214
|
+
} finally {
|
215
|
+
callback?.(!currentError);
|
216
|
+
callback = void 0;
|
217
|
+
}
|
218
|
+
}
|
219
|
+
};
|
220
|
+
const output = await next();
|
221
|
+
if (!isAsyncIteratorObject(output)) {
|
222
|
+
return output;
|
223
|
+
}
|
224
|
+
return async function* () {
|
225
|
+
let current = output;
|
226
|
+
try {
|
227
|
+
while (true) {
|
228
|
+
try {
|
229
|
+
const item = await current.next();
|
230
|
+
const meta = getEventMeta(item.value);
|
231
|
+
lastEventId = meta?.id ?? lastEventId;
|
232
|
+
lastEventRetry = meta?.retry ?? lastEventRetry;
|
233
|
+
if (item.done) {
|
234
|
+
return item.value;
|
235
|
+
}
|
236
|
+
yield item.value;
|
237
|
+
} catch (error) {
|
238
|
+
const meta = getEventMeta(error);
|
239
|
+
lastEventId = meta?.id ?? lastEventId;
|
240
|
+
lastEventRetry = meta?.retry ?? lastEventRetry;
|
241
|
+
const maybeEventIterator = await next({ error });
|
242
|
+
if (!isAsyncIteratorObject(maybeEventIterator)) {
|
243
|
+
throw new ClientRetryPluginInvalidEventIteratorRetryResponse(
|
244
|
+
"RetryPlugin: Expected an Event Iterator, got a non-Event Iterator"
|
245
|
+
);
|
246
|
+
}
|
247
|
+
current = maybeEventIterator;
|
248
|
+
}
|
249
|
+
}
|
250
|
+
} finally {
|
251
|
+
await current.return?.();
|
252
|
+
}
|
253
|
+
}();
|
254
|
+
});
|
255
|
+
}
|
256
|
+
}
|
257
|
+
|
258
|
+
class SimpleCsrfProtectionLinkPlugin {
|
259
|
+
headerName;
|
260
|
+
headerValue;
|
261
|
+
exclude;
|
262
|
+
constructor(options = {}) {
|
263
|
+
this.headerName = options.headerName ?? "x-csrf-token";
|
264
|
+
this.headerValue = options.headerValue ?? "orpc";
|
265
|
+
this.exclude = options.exclude ?? false;
|
266
|
+
}
|
267
|
+
order = 8e6;
|
268
|
+
init(options) {
|
269
|
+
options.clientInterceptors ??= [];
|
270
|
+
options.clientInterceptors.push(async (options2) => {
|
271
|
+
const excluded = await value(this.exclude, options2);
|
272
|
+
if (excluded) {
|
273
|
+
return options2.next();
|
274
|
+
}
|
275
|
+
const headerName = await value(this.headerName, options2);
|
276
|
+
const headerValue = await value(this.headerValue, options2);
|
277
|
+
return options2.next({
|
278
|
+
...options2,
|
279
|
+
request: {
|
280
|
+
...options2.request,
|
281
|
+
headers: {
|
282
|
+
...options2.request.headers,
|
283
|
+
[headerName]: headerValue
|
284
|
+
}
|
285
|
+
}
|
286
|
+
});
|
287
|
+
});
|
288
|
+
}
|
289
|
+
}
|
290
|
+
|
291
|
+
export { BatchLinkPlugin, ClientRetryPlugin, ClientRetryPluginInvalidEventIteratorRetryResponse, SimpleCsrfProtectionLinkPlugin };
|
@@ -0,0 +1,29 @@
|
|
1
|
+
import { PromiseWithError } from '@orpc/shared';
|
2
|
+
|
3
|
+
type HTTPPath = `/${string}`;
|
4
|
+
type HTTPMethod = 'HEAD' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
5
|
+
type ClientContext = Record<PropertyKey, any>;
|
6
|
+
interface ClientOptions<T extends ClientContext> {
|
7
|
+
signal?: AbortSignal;
|
8
|
+
lastEventId?: string | undefined;
|
9
|
+
context: T;
|
10
|
+
}
|
11
|
+
type FriendlyClientOptions<T extends ClientContext> = Omit<ClientOptions<T>, 'context'> & (Record<never, never> extends T ? {
|
12
|
+
context?: T;
|
13
|
+
} : {
|
14
|
+
context: T;
|
15
|
+
});
|
16
|
+
type ClientRest<TClientContext extends ClientContext, TInput> = Record<never, never> extends TClientContext ? undefined extends TInput ? [input?: TInput, options?: FriendlyClientOptions<TClientContext>] : [input: TInput, options?: FriendlyClientOptions<TClientContext>] : [input: TInput, options: FriendlyClientOptions<TClientContext>];
|
17
|
+
type ClientPromiseResult<TOutput, TError> = PromiseWithError<TOutput, TError>;
|
18
|
+
interface Client<TClientContext extends ClientContext, TInput, TOutput, TError> {
|
19
|
+
(...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
|
20
|
+
}
|
21
|
+
type NestedClient<TClientContext extends ClientContext> = Client<TClientContext, any, any, any> | {
|
22
|
+
[k: string]: NestedClient<TClientContext>;
|
23
|
+
};
|
24
|
+
type InferClientContext<T extends NestedClient<any>> = T extends NestedClient<infer U> ? U : never;
|
25
|
+
interface ClientLink<TClientContext extends ClientContext> {
|
26
|
+
call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
|
27
|
+
}
|
28
|
+
|
29
|
+
export type { ClientLink as C, FriendlyClientOptions as F, HTTPPath as H, InferClientContext as I, NestedClient as N, ClientContext as a, ClientOptions as b, ClientPromiseResult as c, HTTPMethod as d, ClientRest as e, Client as f };
|
@@ -0,0 +1,29 @@
|
|
1
|
+
import { PromiseWithError } from '@orpc/shared';
|
2
|
+
|
3
|
+
type HTTPPath = `/${string}`;
|
4
|
+
type HTTPMethod = 'HEAD' | 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
5
|
+
type ClientContext = Record<PropertyKey, any>;
|
6
|
+
interface ClientOptions<T extends ClientContext> {
|
7
|
+
signal?: AbortSignal;
|
8
|
+
lastEventId?: string | undefined;
|
9
|
+
context: T;
|
10
|
+
}
|
11
|
+
type FriendlyClientOptions<T extends ClientContext> = Omit<ClientOptions<T>, 'context'> & (Record<never, never> extends T ? {
|
12
|
+
context?: T;
|
13
|
+
} : {
|
14
|
+
context: T;
|
15
|
+
});
|
16
|
+
type ClientRest<TClientContext extends ClientContext, TInput> = Record<never, never> extends TClientContext ? undefined extends TInput ? [input?: TInput, options?: FriendlyClientOptions<TClientContext>] : [input: TInput, options?: FriendlyClientOptions<TClientContext>] : [input: TInput, options: FriendlyClientOptions<TClientContext>];
|
17
|
+
type ClientPromiseResult<TOutput, TError> = PromiseWithError<TOutput, TError>;
|
18
|
+
interface Client<TClientContext extends ClientContext, TInput, TOutput, TError> {
|
19
|
+
(...rest: ClientRest<TClientContext, TInput>): ClientPromiseResult<TOutput, TError>;
|
20
|
+
}
|
21
|
+
type NestedClient<TClientContext extends ClientContext> = Client<TClientContext, any, any, any> | {
|
22
|
+
[k: string]: NestedClient<TClientContext>;
|
23
|
+
};
|
24
|
+
type InferClientContext<T extends NestedClient<any>> = T extends NestedClient<infer U> ? U : never;
|
25
|
+
interface ClientLink<TClientContext extends ClientContext> {
|
26
|
+
call: (path: readonly string[], input: unknown, options: ClientOptions<TClientContext>) => Promise<unknown>;
|
27
|
+
}
|
28
|
+
|
29
|
+
export type { ClientLink as C, FriendlyClientOptions as F, HTTPPath as H, InferClientContext as I, NestedClient as N, ClientContext as a, ClientOptions as b, ClientPromiseResult as c, HTTPMethod as d, ClientRest as e, Client as f };
|
@@ -0,0 +1,46 @@
|
|
1
|
+
import { Interceptor, ThrowableError } from '@orpc/shared';
|
2
|
+
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
3
|
+
import { a as ClientContext, b as ClientOptions, C as ClientLink } from './client.4TS_0JaO.js';
|
4
|
+
|
5
|
+
interface StandardLinkPlugin<T extends ClientContext> {
|
6
|
+
order?: number;
|
7
|
+
init?(options: StandardLinkOptions<T>): void;
|
8
|
+
}
|
9
|
+
declare class CompositeStandardLinkPlugin<T extends ClientContext, TPlugin extends StandardLinkPlugin<T>> implements StandardLinkPlugin<T> {
|
10
|
+
protected readonly plugins: TPlugin[];
|
11
|
+
constructor(plugins?: readonly TPlugin[]);
|
12
|
+
init(options: StandardLinkOptions<T>): void;
|
13
|
+
}
|
14
|
+
|
15
|
+
interface StandardLinkCodec<T extends ClientContext> {
|
16
|
+
encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
|
17
|
+
decode(response: StandardLazyResponse, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<unknown>;
|
18
|
+
}
|
19
|
+
interface StandardLinkClient<T extends ClientContext> {
|
20
|
+
call(request: StandardRequest, options: ClientOptions<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
|
21
|
+
}
|
22
|
+
|
23
|
+
interface StandardLinkInterceptorOptions<T extends ClientContext> extends ClientOptions<T> {
|
24
|
+
path: readonly string[];
|
25
|
+
input: unknown;
|
26
|
+
}
|
27
|
+
interface StandardLinkClientInterceptorOptions<T extends ClientContext> extends StandardLinkInterceptorOptions<T> {
|
28
|
+
request: StandardRequest;
|
29
|
+
}
|
30
|
+
interface StandardLinkOptions<T extends ClientContext> {
|
31
|
+
interceptors?: Interceptor<StandardLinkInterceptorOptions<T>, unknown, ThrowableError>[];
|
32
|
+
clientInterceptors?: Interceptor<StandardLinkClientInterceptorOptions<T>, StandardLazyResponse, ThrowableError>[];
|
33
|
+
plugins?: StandardLinkPlugin<T>[];
|
34
|
+
}
|
35
|
+
declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
|
36
|
+
#private;
|
37
|
+
readonly codec: StandardLinkCodec<T>;
|
38
|
+
readonly sender: StandardLinkClient<T>;
|
39
|
+
private readonly interceptors;
|
40
|
+
private readonly clientInterceptors;
|
41
|
+
constructor(codec: StandardLinkCodec<T>, sender: StandardLinkClient<T>, options?: StandardLinkOptions<T>);
|
42
|
+
call(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<unknown>;
|
43
|
+
}
|
44
|
+
|
45
|
+
export { CompositeStandardLinkPlugin as C, StandardLink as d };
|
46
|
+
export type { StandardLinkClientInterceptorOptions as S, StandardLinkPlugin as a, StandardLinkOptions as b, StandardLinkInterceptorOptions as c, StandardLinkCodec as e, StandardLinkClient as f };
|
@@ -0,0 +1,91 @@
|
|
1
|
+
import { a as ClientContext, b as ClientOptions, d as HTTPMethod } from './client.4TS_0JaO.js';
|
2
|
+
import { e as StandardLinkCodec, b as StandardLinkOptions, d as StandardLink, f as StandardLinkClient } from './client.7ZYxJok_.js';
|
3
|
+
import { Segment, Value } from '@orpc/shared';
|
4
|
+
import { StandardHeaders, StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
5
|
+
|
6
|
+
declare const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES: {
|
7
|
+
readonly BIGINT: 0;
|
8
|
+
readonly DATE: 1;
|
9
|
+
readonly NAN: 2;
|
10
|
+
readonly UNDEFINED: 3;
|
11
|
+
readonly URL: 4;
|
12
|
+
readonly REGEXP: 5;
|
13
|
+
readonly SET: 6;
|
14
|
+
readonly MAP: 7;
|
15
|
+
};
|
16
|
+
type StandardRPCJsonSerializedMetaItem = readonly [type: number, ...path: Segment[]];
|
17
|
+
type StandardRPCJsonSerialized = [json: unknown, meta: StandardRPCJsonSerializedMetaItem[], maps: Segment[][], blobs: Blob[]];
|
18
|
+
interface StandardRPCCustomJsonSerializer {
|
19
|
+
type: number;
|
20
|
+
condition(data: unknown): boolean;
|
21
|
+
serialize(data: any): unknown;
|
22
|
+
deserialize(serialized: any): unknown;
|
23
|
+
}
|
24
|
+
interface StandardRPCJsonSerializerOptions {
|
25
|
+
customJsonSerializers?: readonly StandardRPCCustomJsonSerializer[];
|
26
|
+
}
|
27
|
+
declare class StandardRPCJsonSerializer {
|
28
|
+
private readonly customSerializers;
|
29
|
+
constructor(options?: StandardRPCJsonSerializerOptions);
|
30
|
+
serialize(data: unknown, segments?: Segment[], meta?: StandardRPCJsonSerializedMetaItem[], maps?: Segment[][], blobs?: Blob[]): StandardRPCJsonSerialized;
|
31
|
+
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[]): unknown;
|
32
|
+
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[], maps: readonly Segment[][], getBlob: (index: number) => Blob): unknown;
|
33
|
+
}
|
34
|
+
|
35
|
+
declare class StandardRPCSerializer {
|
36
|
+
#private;
|
37
|
+
private readonly jsonSerializer;
|
38
|
+
constructor(jsonSerializer: StandardRPCJsonSerializer);
|
39
|
+
serialize(data: unknown): object;
|
40
|
+
deserialize(data: unknown): unknown;
|
41
|
+
}
|
42
|
+
|
43
|
+
interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
44
|
+
/**
|
45
|
+
* Base url for all requests.
|
46
|
+
*/
|
47
|
+
url: Value<string | URL, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
48
|
+
/**
|
49
|
+
* The maximum length of the URL.
|
50
|
+
*
|
51
|
+
* @default 2083
|
52
|
+
*/
|
53
|
+
maxUrlLength?: Value<number, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
54
|
+
/**
|
55
|
+
* The method used to make the request.
|
56
|
+
*
|
57
|
+
* @default 'POST'
|
58
|
+
*/
|
59
|
+
method?: Value<Exclude<HTTPMethod, 'HEAD'>, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
60
|
+
/**
|
61
|
+
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
62
|
+
* GET is not allowed, it's very dangerous.
|
63
|
+
*
|
64
|
+
* @default 'POST'
|
65
|
+
*/
|
66
|
+
fallbackMethod?: Exclude<HTTPMethod, 'HEAD' | 'GET'>;
|
67
|
+
/**
|
68
|
+
* Inject headers to the request.
|
69
|
+
*/
|
70
|
+
headers?: Value<StandardHeaders, [options: ClientOptions<T>, path: readonly string[], input: unknown]>;
|
71
|
+
}
|
72
|
+
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
73
|
+
private readonly serializer;
|
74
|
+
private readonly baseUrl;
|
75
|
+
private readonly maxUrlLength;
|
76
|
+
private readonly fallbackMethod;
|
77
|
+
private readonly expectedMethod;
|
78
|
+
private readonly headers;
|
79
|
+
constructor(serializer: StandardRPCSerializer, options: StandardRPCLinkCodecOptions<T>);
|
80
|
+
encode(path: readonly string[], input: unknown, options: ClientOptions<T>): Promise<StandardRequest>;
|
81
|
+
decode(response: StandardLazyResponse): Promise<unknown>;
|
82
|
+
}
|
83
|
+
|
84
|
+
interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
|
85
|
+
}
|
86
|
+
declare class StandardRPCLink<T extends ClientContext> extends StandardLink<T> {
|
87
|
+
constructor(linkClient: StandardLinkClient<T>, options: StandardRPCLinkOptions<T>);
|
88
|
+
}
|
89
|
+
|
90
|
+
export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES as S, StandardRPCJsonSerializer as e, StandardRPCLink as g, StandardRPCLinkCodec as i, StandardRPCSerializer as j };
|
91
|
+
export type { StandardRPCJsonSerializedMetaItem as a, StandardRPCJsonSerialized as b, StandardRPCCustomJsonSerializer as c, StandardRPCJsonSerializerOptions as d, StandardRPCLinkOptions as f, StandardRPCLinkCodecOptions as h };
|
@@ -0,0 +1,175 @@
|
|
1
|
+
import { isObject, isTypescriptObject } from '@orpc/shared';
|
2
|
+
import { getEventMeta, withEventMeta } from '@orpc/standard-server';
|
3
|
+
|
4
|
+
const COMMON_ORPC_ERROR_DEFS = {
|
5
|
+
BAD_REQUEST: {
|
6
|
+
status: 400,
|
7
|
+
message: "Bad Request"
|
8
|
+
},
|
9
|
+
UNAUTHORIZED: {
|
10
|
+
status: 401,
|
11
|
+
message: "Unauthorized"
|
12
|
+
},
|
13
|
+
FORBIDDEN: {
|
14
|
+
status: 403,
|
15
|
+
message: "Forbidden"
|
16
|
+
},
|
17
|
+
NOT_FOUND: {
|
18
|
+
status: 404,
|
19
|
+
message: "Not Found"
|
20
|
+
},
|
21
|
+
METHOD_NOT_SUPPORTED: {
|
22
|
+
status: 405,
|
23
|
+
message: "Method Not Supported"
|
24
|
+
},
|
25
|
+
NOT_ACCEPTABLE: {
|
26
|
+
status: 406,
|
27
|
+
message: "Not Acceptable"
|
28
|
+
},
|
29
|
+
TIMEOUT: {
|
30
|
+
status: 408,
|
31
|
+
message: "Request Timeout"
|
32
|
+
},
|
33
|
+
CONFLICT: {
|
34
|
+
status: 409,
|
35
|
+
message: "Conflict"
|
36
|
+
},
|
37
|
+
PRECONDITION_FAILED: {
|
38
|
+
status: 412,
|
39
|
+
message: "Precondition Failed"
|
40
|
+
},
|
41
|
+
PAYLOAD_TOO_LARGE: {
|
42
|
+
status: 413,
|
43
|
+
message: "Payload Too Large"
|
44
|
+
},
|
45
|
+
UNSUPPORTED_MEDIA_TYPE: {
|
46
|
+
status: 415,
|
47
|
+
message: "Unsupported Media Type"
|
48
|
+
},
|
49
|
+
UNPROCESSABLE_CONTENT: {
|
50
|
+
status: 422,
|
51
|
+
message: "Unprocessable Content"
|
52
|
+
},
|
53
|
+
TOO_MANY_REQUESTS: {
|
54
|
+
status: 429,
|
55
|
+
message: "Too Many Requests"
|
56
|
+
},
|
57
|
+
CLIENT_CLOSED_REQUEST: {
|
58
|
+
status: 499,
|
59
|
+
message: "Client Closed Request"
|
60
|
+
},
|
61
|
+
INTERNAL_SERVER_ERROR: {
|
62
|
+
status: 500,
|
63
|
+
message: "Internal Server Error"
|
64
|
+
},
|
65
|
+
NOT_IMPLEMENTED: {
|
66
|
+
status: 501,
|
67
|
+
message: "Not Implemented"
|
68
|
+
},
|
69
|
+
BAD_GATEWAY: {
|
70
|
+
status: 502,
|
71
|
+
message: "Bad Gateway"
|
72
|
+
},
|
73
|
+
SERVICE_UNAVAILABLE: {
|
74
|
+
status: 503,
|
75
|
+
message: "Service Unavailable"
|
76
|
+
},
|
77
|
+
GATEWAY_TIMEOUT: {
|
78
|
+
status: 504,
|
79
|
+
message: "Gateway Timeout"
|
80
|
+
}
|
81
|
+
};
|
82
|
+
function fallbackORPCErrorStatus(code, status) {
|
83
|
+
return status ?? COMMON_ORPC_ERROR_DEFS[code]?.status ?? 500;
|
84
|
+
}
|
85
|
+
function fallbackORPCErrorMessage(code, message) {
|
86
|
+
return message || COMMON_ORPC_ERROR_DEFS[code]?.message || code;
|
87
|
+
}
|
88
|
+
class ORPCError extends Error {
|
89
|
+
defined;
|
90
|
+
code;
|
91
|
+
status;
|
92
|
+
data;
|
93
|
+
constructor(code, ...[options]) {
|
94
|
+
if (options?.status && !isORPCErrorStatus(options.status)) {
|
95
|
+
throw new Error("[ORPCError] Invalid error status code.");
|
96
|
+
}
|
97
|
+
const message = fallbackORPCErrorMessage(code, options?.message);
|
98
|
+
super(message, options);
|
99
|
+
this.code = code;
|
100
|
+
this.status = fallbackORPCErrorStatus(code, options?.status);
|
101
|
+
this.defined = options?.defined ?? false;
|
102
|
+
this.data = options?.data;
|
103
|
+
}
|
104
|
+
toJSON() {
|
105
|
+
return {
|
106
|
+
defined: this.defined,
|
107
|
+
code: this.code,
|
108
|
+
status: this.status,
|
109
|
+
message: this.message,
|
110
|
+
data: this.data
|
111
|
+
};
|
112
|
+
}
|
113
|
+
}
|
114
|
+
function isDefinedError(error) {
|
115
|
+
return error instanceof ORPCError && error.defined;
|
116
|
+
}
|
117
|
+
function toORPCError(error) {
|
118
|
+
return error instanceof ORPCError ? error : new ORPCError("INTERNAL_SERVER_ERROR", {
|
119
|
+
message: "Internal server error",
|
120
|
+
cause: error
|
121
|
+
});
|
122
|
+
}
|
123
|
+
function isORPCErrorStatus(status) {
|
124
|
+
return status < 200 || status >= 400;
|
125
|
+
}
|
126
|
+
function isORPCErrorJson(json) {
|
127
|
+
if (!isObject(json)) {
|
128
|
+
return false;
|
129
|
+
}
|
130
|
+
const validKeys = ["defined", "code", "status", "message", "data"];
|
131
|
+
if (Object.keys(json).some((k) => !validKeys.includes(k))) {
|
132
|
+
return false;
|
133
|
+
}
|
134
|
+
return "defined" in json && typeof json.defined === "boolean" && "code" in json && typeof json.code === "string" && "status" in json && typeof json.status === "number" && isORPCErrorStatus(json.status) && "message" in json && typeof json.message === "string";
|
135
|
+
}
|
136
|
+
function createORPCErrorFromJson(json, options = {}) {
|
137
|
+
return new ORPCError(json.code, {
|
138
|
+
...options,
|
139
|
+
...json
|
140
|
+
});
|
141
|
+
}
|
142
|
+
|
143
|
+
function mapEventIterator(iterator, maps) {
|
144
|
+
return async function* () {
|
145
|
+
try {
|
146
|
+
while (true) {
|
147
|
+
const { done, value } = await iterator.next();
|
148
|
+
let mappedValue = await maps.value(value, done);
|
149
|
+
if (mappedValue !== value) {
|
150
|
+
const meta = getEventMeta(value);
|
151
|
+
if (meta && isTypescriptObject(mappedValue)) {
|
152
|
+
mappedValue = withEventMeta(mappedValue, meta);
|
153
|
+
}
|
154
|
+
}
|
155
|
+
if (done) {
|
156
|
+
return mappedValue;
|
157
|
+
}
|
158
|
+
yield mappedValue;
|
159
|
+
}
|
160
|
+
} catch (error) {
|
161
|
+
let mappedError = await maps.error(error);
|
162
|
+
if (mappedError !== error) {
|
163
|
+
const meta = getEventMeta(error);
|
164
|
+
if (meta && isTypescriptObject(mappedError)) {
|
165
|
+
mappedError = withEventMeta(mappedError, meta);
|
166
|
+
}
|
167
|
+
}
|
168
|
+
throw mappedError;
|
169
|
+
} finally {
|
170
|
+
await iterator.return?.();
|
171
|
+
}
|
172
|
+
}();
|
173
|
+
}
|
174
|
+
|
175
|
+
export { COMMON_ORPC_ERROR_DEFS as C, ORPCError as O, fallbackORPCErrorMessage as a, isORPCErrorStatus as b, isORPCErrorJson as c, createORPCErrorFromJson as d, fallbackORPCErrorStatus as f, isDefinedError as i, mapEventIterator as m, toORPCError as t };
|