@orpc/client 0.0.0-next.f17a1a0 → 0.0.0-next.f21e305
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 +31 -21
- package/dist/adapters/fetch/index.d.mts +46 -0
- package/dist/adapters/fetch/index.d.ts +46 -0
- package/dist/adapters/fetch/index.mjs +45 -0
- package/dist/adapters/message-port/index.d.mts +59 -0
- package/dist/adapters/message-port/index.d.ts +59 -0
- package/dist/adapters/message-port/index.mjs +72 -0
- package/dist/adapters/standard/index.d.mts +11 -0
- package/dist/adapters/standard/index.d.ts +11 -0
- package/dist/adapters/standard/index.mjs +5 -0
- package/dist/adapters/websocket/index.d.mts +29 -0
- package/dist/adapters/websocket/index.d.ts +29 -0
- package/dist/adapters/websocket/index.mjs +46 -0
- package/dist/index.d.mts +230 -0
- package/dist/index.d.ts +230 -0
- package/dist/index.mjs +111 -0
- package/dist/plugins/index.d.mts +202 -0
- package/dist/plugins/index.d.ts +202 -0
- package/dist/plugins/index.mjs +406 -0
- package/dist/shared/client.BG98rYdO.d.ts +45 -0
- package/dist/shared/client.BIYmXux0.mjs +397 -0
- package/dist/shared/client.BOYsZIRq.d.mts +29 -0
- package/dist/shared/client.BOYsZIRq.d.ts +29 -0
- package/dist/shared/client.Bwgm6dgk.d.mts +45 -0
- package/dist/shared/client.C9Q9FzmH.mjs +208 -0
- package/dist/shared/client.CVVVqf1Y.d.ts +91 -0
- package/dist/shared/client._Y_enhib.d.mts +91 -0
- package/package.json +30 -24
- package/dist/chunk-4FUUNP74.js +0 -212
- package/dist/chunk-OGAGXWCU.js +0 -281
- package/dist/fetch.js +0 -128
- package/dist/index.js +0 -81
- package/dist/openapi.js +0 -231
- package/dist/rpc.js +0 -10
- package/dist/src/adapters/fetch/index.d.ts +0 -3
- package/dist/src/adapters/fetch/rpc-link.d.ts +0 -98
- package/dist/src/adapters/fetch/types.d.ts +0 -5
- package/dist/src/client.d.ts +0 -9
- package/dist/src/dynamic-link.d.ts +0 -12
- package/dist/src/error.d.ts +0 -106
- package/dist/src/event-iterator-state.d.ts +0 -9
- package/dist/src/event-iterator.d.ts +0 -12
- package/dist/src/index.d.ts +0 -9
- package/dist/src/openapi/bracket-notation.d.ts +0 -9
- package/dist/src/openapi/index.d.ts +0 -4
- package/dist/src/openapi/json-serializer.d.ts +0 -7
- package/dist/src/openapi/serializer.d.ts +0 -11
- package/dist/src/rpc/index.d.ts +0 -3
- package/dist/src/rpc/json-serializer.d.ts +0 -12
- package/dist/src/rpc/serializer.d.ts +0 -9
- package/dist/src/types.d.ts +0 -29
- package/dist/src/utils.d.ts +0 -5
package/dist/index.d.mts
ADDED
@@ -0,0 +1,230 @@
|
|
1
|
+
import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientPromiseResult, b as ClientContext, F as FriendlyClientOptions, c as ClientOptions, d as Client, e as ClientRest } from './shared/client.BOYsZIRq.mjs';
|
2
|
+
export { f as HTTPMethod, H as HTTPPath } from './shared/client.BOYsZIRq.mjs';
|
3
|
+
import { MaybeOptionalOptions, ThrowableError, OnFinishState, Promisable, AsyncIteratorClass } from '@orpc/shared';
|
4
|
+
export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
5
|
+
export { ErrorEvent } from '@orpc/standard-server';
|
6
|
+
|
7
|
+
interface createORPCClientOptions {
|
8
|
+
/**
|
9
|
+
* Use as base path for all procedure, useful when you only want to call a subset of the procedure.
|
10
|
+
*/
|
11
|
+
path?: readonly string[];
|
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
|
+
*/
|
18
|
+
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
19
|
+
|
20
|
+
declare const COMMON_ORPC_ERROR_DEFS: {
|
21
|
+
readonly BAD_REQUEST: {
|
22
|
+
readonly status: 400;
|
23
|
+
readonly message: "Bad Request";
|
24
|
+
};
|
25
|
+
readonly UNAUTHORIZED: {
|
26
|
+
readonly status: 401;
|
27
|
+
readonly message: "Unauthorized";
|
28
|
+
};
|
29
|
+
readonly FORBIDDEN: {
|
30
|
+
readonly status: 403;
|
31
|
+
readonly message: "Forbidden";
|
32
|
+
};
|
33
|
+
readonly NOT_FOUND: {
|
34
|
+
readonly status: 404;
|
35
|
+
readonly message: "Not Found";
|
36
|
+
};
|
37
|
+
readonly METHOD_NOT_SUPPORTED: {
|
38
|
+
readonly status: 405;
|
39
|
+
readonly message: "Method Not Supported";
|
40
|
+
};
|
41
|
+
readonly NOT_ACCEPTABLE: {
|
42
|
+
readonly status: 406;
|
43
|
+
readonly message: "Not Acceptable";
|
44
|
+
};
|
45
|
+
readonly TIMEOUT: {
|
46
|
+
readonly status: 408;
|
47
|
+
readonly message: "Request Timeout";
|
48
|
+
};
|
49
|
+
readonly CONFLICT: {
|
50
|
+
readonly status: 409;
|
51
|
+
readonly message: "Conflict";
|
52
|
+
};
|
53
|
+
readonly PRECONDITION_FAILED: {
|
54
|
+
readonly status: 412;
|
55
|
+
readonly message: "Precondition Failed";
|
56
|
+
};
|
57
|
+
readonly PAYLOAD_TOO_LARGE: {
|
58
|
+
readonly status: 413;
|
59
|
+
readonly message: "Payload Too Large";
|
60
|
+
};
|
61
|
+
readonly UNSUPPORTED_MEDIA_TYPE: {
|
62
|
+
readonly status: 415;
|
63
|
+
readonly message: "Unsupported Media Type";
|
64
|
+
};
|
65
|
+
readonly UNPROCESSABLE_CONTENT: {
|
66
|
+
readonly status: 422;
|
67
|
+
readonly message: "Unprocessable Content";
|
68
|
+
};
|
69
|
+
readonly TOO_MANY_REQUESTS: {
|
70
|
+
readonly status: 429;
|
71
|
+
readonly message: "Too Many Requests";
|
72
|
+
};
|
73
|
+
readonly CLIENT_CLOSED_REQUEST: {
|
74
|
+
readonly status: 499;
|
75
|
+
readonly message: "Client Closed Request";
|
76
|
+
};
|
77
|
+
readonly INTERNAL_SERVER_ERROR: {
|
78
|
+
readonly status: 500;
|
79
|
+
readonly message: "Internal Server Error";
|
80
|
+
};
|
81
|
+
readonly NOT_IMPLEMENTED: {
|
82
|
+
readonly status: 501;
|
83
|
+
readonly message: "Not Implemented";
|
84
|
+
};
|
85
|
+
readonly BAD_GATEWAY: {
|
86
|
+
readonly status: 502;
|
87
|
+
readonly message: "Bad Gateway";
|
88
|
+
};
|
89
|
+
readonly SERVICE_UNAVAILABLE: {
|
90
|
+
readonly status: 503;
|
91
|
+
readonly message: "Service Unavailable";
|
92
|
+
};
|
93
|
+
readonly GATEWAY_TIMEOUT: {
|
94
|
+
readonly status: 504;
|
95
|
+
readonly message: "Gateway Timeout";
|
96
|
+
};
|
97
|
+
};
|
98
|
+
type CommonORPCErrorCode = keyof typeof COMMON_ORPC_ERROR_DEFS;
|
99
|
+
type ORPCErrorCode = CommonORPCErrorCode | (string & {});
|
100
|
+
declare function fallbackORPCErrorStatus(code: ORPCErrorCode, status: number | undefined): number;
|
101
|
+
declare function fallbackORPCErrorMessage(code: ORPCErrorCode, message: string | undefined): string;
|
102
|
+
type ORPCErrorOptions<TData> = ErrorOptions & {
|
103
|
+
defined?: boolean;
|
104
|
+
status?: number;
|
105
|
+
message?: string;
|
106
|
+
} & (undefined extends TData ? {
|
107
|
+
data?: TData;
|
108
|
+
} : {
|
109
|
+
data: TData;
|
110
|
+
});
|
111
|
+
declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
112
|
+
readonly defined: boolean;
|
113
|
+
readonly code: TCode;
|
114
|
+
readonly status: number;
|
115
|
+
readonly data: TData;
|
116
|
+
constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
117
|
+
toJSON(): ORPCErrorJSON<TCode, TData>;
|
118
|
+
/**
|
119
|
+
* Workaround for Next.js where different contexts use separate
|
120
|
+
* dependency graphs, causing multiple ORPCError constructors existing and breaking
|
121
|
+
* `instanceof` checks across contexts.
|
122
|
+
*
|
123
|
+
* This is particularly problematic with "Optimized SSR", where orpc-client
|
124
|
+
* executes in one context but is invoked from another. When an error is thrown
|
125
|
+
* in the execution context, `instanceof ORPCError` checks fail in the
|
126
|
+
* invocation context due to separate class constructors.
|
127
|
+
*
|
128
|
+
* @todo Remove this and related code if Next.js resolves the multiple dependency graph issue.
|
129
|
+
*/
|
130
|
+
static [Symbol.hasInstance](instance: unknown): boolean;
|
131
|
+
}
|
132
|
+
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
133
|
+
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
134
|
+
declare function toORPCError(error: unknown): ORPCError<any, any>;
|
135
|
+
declare function isORPCErrorStatus(status: number): boolean;
|
136
|
+
declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
137
|
+
declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
138
|
+
|
139
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
140
|
+
error: null;
|
141
|
+
data: TOutput;
|
142
|
+
isDefined: false;
|
143
|
+
isSuccess: true;
|
144
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
|
145
|
+
error: Exclude<TError, ORPCError<any, any>>;
|
146
|
+
data: undefined;
|
147
|
+
isDefined: false;
|
148
|
+
isSuccess: false;
|
149
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
|
150
|
+
error: Extract<TError, ORPCError<any, any>>;
|
151
|
+
data: undefined;
|
152
|
+
isDefined: true;
|
153
|
+
isSuccess: false;
|
154
|
+
};
|
155
|
+
/**
|
156
|
+
* Works like try/catch, but can infer error types.
|
157
|
+
*
|
158
|
+
* @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
|
159
|
+
* @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
|
160
|
+
*/
|
161
|
+
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
162
|
+
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
163
|
+
interface ConsumeEventIteratorOptions<T, TReturn, TError> {
|
164
|
+
/**
|
165
|
+
* Called on each event
|
166
|
+
*/
|
167
|
+
onEvent: (event: T) => void;
|
168
|
+
/**
|
169
|
+
* Called once error happens
|
170
|
+
*/
|
171
|
+
onError?: (error: TError) => void;
|
172
|
+
/**
|
173
|
+
* Called once event iterator is done
|
174
|
+
*
|
175
|
+
* @info If iterator is canceled, `undefined` can be passed on success
|
176
|
+
*/
|
177
|
+
onSuccess?: (value: TReturn | undefined) => void;
|
178
|
+
/**
|
179
|
+
* Called once after onError or onSuccess
|
180
|
+
*
|
181
|
+
* @info If iterator is canceled, `undefined` can be passed on success
|
182
|
+
*/
|
183
|
+
onFinish?: (state: OnFinishState<TReturn | undefined, TError>) => void;
|
184
|
+
}
|
185
|
+
/**
|
186
|
+
* Consumes an event iterator with lifecycle callbacks
|
187
|
+
*
|
188
|
+
* @warning If no `onError` or `onFinish` is provided, unhandled rejections will be thrown
|
189
|
+
* @return unsubscribe callback
|
190
|
+
*/
|
191
|
+
declare function consumeEventIterator<T, TReturn, TError = ThrowableError>(iterator: AsyncIterator<T, TReturn> | ClientPromiseResult<AsyncIterator<T, TReturn>, TError>, options: ConsumeEventIteratorOptions<T, TReturn, TError>): () => Promise<void>;
|
192
|
+
|
193
|
+
type SafeClient<T extends NestedClient<any>> = T extends Client<infer UContext, infer UInput, infer UOutput, infer UError> ? (...rest: ClientRest<UContext, UInput>) => Promise<SafeResult<UOutput, UError>> : {
|
194
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
|
195
|
+
};
|
196
|
+
/**
|
197
|
+
* Create a safe client that automatically wraps all procedure calls with the `safe` util.
|
198
|
+
*
|
199
|
+
* @example
|
200
|
+
* ```ts
|
201
|
+
* const safeClient = createSafeClient(client)
|
202
|
+
* const { error, data, isDefined } = await safeClient.doSomething({ id: '123' })
|
203
|
+
* ```
|
204
|
+
*
|
205
|
+
* @see {@link https://orpc.unnoq.com/docs/client/error-handling#using-createsafeclient Safe Client Docs}
|
206
|
+
*/
|
207
|
+
declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
|
208
|
+
|
209
|
+
declare const ORPC_CLIENT_PACKAGE_NAME = "@orpc/client";
|
210
|
+
declare const ORPC_CLIENT_PACKAGE_VERSION = "0.0.0-next.f21e305";
|
211
|
+
|
212
|
+
/**
|
213
|
+
* DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
|
214
|
+
* based on the request path, input, and context.
|
215
|
+
*
|
216
|
+
* @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
|
217
|
+
*/
|
218
|
+
declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
|
219
|
+
private readonly linkResolver;
|
220
|
+
constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
|
221
|
+
call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
|
222
|
+
}
|
223
|
+
|
224
|
+
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
225
|
+
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
226
|
+
error: (error: unknown) => Promise<unknown>;
|
227
|
+
}): AsyncIteratorClass<TMap, TMap, TNext>;
|
228
|
+
|
229
|
+
export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, ORPC_CLIENT_PACKAGE_NAME, ORPC_CLIENT_PACKAGE_VERSION, consumeEventIterator, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
230
|
+
export type { CommonORPCErrorCode, ConsumeEventIteratorOptions, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };
|
package/dist/index.d.ts
ADDED
@@ -0,0 +1,230 @@
|
|
1
|
+
import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientPromiseResult, b as ClientContext, F as FriendlyClientOptions, c as ClientOptions, d as Client, e as ClientRest } from './shared/client.BOYsZIRq.js';
|
2
|
+
export { f as HTTPMethod, H as HTTPPath } from './shared/client.BOYsZIRq.js';
|
3
|
+
import { MaybeOptionalOptions, ThrowableError, OnFinishState, Promisable, AsyncIteratorClass } from '@orpc/shared';
|
4
|
+
export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
5
|
+
export { ErrorEvent } from '@orpc/standard-server';
|
6
|
+
|
7
|
+
interface createORPCClientOptions {
|
8
|
+
/**
|
9
|
+
* Use as base path for all procedure, useful when you only want to call a subset of the procedure.
|
10
|
+
*/
|
11
|
+
path?: readonly string[];
|
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
|
+
*/
|
18
|
+
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
19
|
+
|
20
|
+
declare const COMMON_ORPC_ERROR_DEFS: {
|
21
|
+
readonly BAD_REQUEST: {
|
22
|
+
readonly status: 400;
|
23
|
+
readonly message: "Bad Request";
|
24
|
+
};
|
25
|
+
readonly UNAUTHORIZED: {
|
26
|
+
readonly status: 401;
|
27
|
+
readonly message: "Unauthorized";
|
28
|
+
};
|
29
|
+
readonly FORBIDDEN: {
|
30
|
+
readonly status: 403;
|
31
|
+
readonly message: "Forbidden";
|
32
|
+
};
|
33
|
+
readonly NOT_FOUND: {
|
34
|
+
readonly status: 404;
|
35
|
+
readonly message: "Not Found";
|
36
|
+
};
|
37
|
+
readonly METHOD_NOT_SUPPORTED: {
|
38
|
+
readonly status: 405;
|
39
|
+
readonly message: "Method Not Supported";
|
40
|
+
};
|
41
|
+
readonly NOT_ACCEPTABLE: {
|
42
|
+
readonly status: 406;
|
43
|
+
readonly message: "Not Acceptable";
|
44
|
+
};
|
45
|
+
readonly TIMEOUT: {
|
46
|
+
readonly status: 408;
|
47
|
+
readonly message: "Request Timeout";
|
48
|
+
};
|
49
|
+
readonly CONFLICT: {
|
50
|
+
readonly status: 409;
|
51
|
+
readonly message: "Conflict";
|
52
|
+
};
|
53
|
+
readonly PRECONDITION_FAILED: {
|
54
|
+
readonly status: 412;
|
55
|
+
readonly message: "Precondition Failed";
|
56
|
+
};
|
57
|
+
readonly PAYLOAD_TOO_LARGE: {
|
58
|
+
readonly status: 413;
|
59
|
+
readonly message: "Payload Too Large";
|
60
|
+
};
|
61
|
+
readonly UNSUPPORTED_MEDIA_TYPE: {
|
62
|
+
readonly status: 415;
|
63
|
+
readonly message: "Unsupported Media Type";
|
64
|
+
};
|
65
|
+
readonly UNPROCESSABLE_CONTENT: {
|
66
|
+
readonly status: 422;
|
67
|
+
readonly message: "Unprocessable Content";
|
68
|
+
};
|
69
|
+
readonly TOO_MANY_REQUESTS: {
|
70
|
+
readonly status: 429;
|
71
|
+
readonly message: "Too Many Requests";
|
72
|
+
};
|
73
|
+
readonly CLIENT_CLOSED_REQUEST: {
|
74
|
+
readonly status: 499;
|
75
|
+
readonly message: "Client Closed Request";
|
76
|
+
};
|
77
|
+
readonly INTERNAL_SERVER_ERROR: {
|
78
|
+
readonly status: 500;
|
79
|
+
readonly message: "Internal Server Error";
|
80
|
+
};
|
81
|
+
readonly NOT_IMPLEMENTED: {
|
82
|
+
readonly status: 501;
|
83
|
+
readonly message: "Not Implemented";
|
84
|
+
};
|
85
|
+
readonly BAD_GATEWAY: {
|
86
|
+
readonly status: 502;
|
87
|
+
readonly message: "Bad Gateway";
|
88
|
+
};
|
89
|
+
readonly SERVICE_UNAVAILABLE: {
|
90
|
+
readonly status: 503;
|
91
|
+
readonly message: "Service Unavailable";
|
92
|
+
};
|
93
|
+
readonly GATEWAY_TIMEOUT: {
|
94
|
+
readonly status: 504;
|
95
|
+
readonly message: "Gateway Timeout";
|
96
|
+
};
|
97
|
+
};
|
98
|
+
type CommonORPCErrorCode = keyof typeof COMMON_ORPC_ERROR_DEFS;
|
99
|
+
type ORPCErrorCode = CommonORPCErrorCode | (string & {});
|
100
|
+
declare function fallbackORPCErrorStatus(code: ORPCErrorCode, status: number | undefined): number;
|
101
|
+
declare function fallbackORPCErrorMessage(code: ORPCErrorCode, message: string | undefined): string;
|
102
|
+
type ORPCErrorOptions<TData> = ErrorOptions & {
|
103
|
+
defined?: boolean;
|
104
|
+
status?: number;
|
105
|
+
message?: string;
|
106
|
+
} & (undefined extends TData ? {
|
107
|
+
data?: TData;
|
108
|
+
} : {
|
109
|
+
data: TData;
|
110
|
+
});
|
111
|
+
declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
112
|
+
readonly defined: boolean;
|
113
|
+
readonly code: TCode;
|
114
|
+
readonly status: number;
|
115
|
+
readonly data: TData;
|
116
|
+
constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
117
|
+
toJSON(): ORPCErrorJSON<TCode, TData>;
|
118
|
+
/**
|
119
|
+
* Workaround for Next.js where different contexts use separate
|
120
|
+
* dependency graphs, causing multiple ORPCError constructors existing and breaking
|
121
|
+
* `instanceof` checks across contexts.
|
122
|
+
*
|
123
|
+
* This is particularly problematic with "Optimized SSR", where orpc-client
|
124
|
+
* executes in one context but is invoked from another. When an error is thrown
|
125
|
+
* in the execution context, `instanceof ORPCError` checks fail in the
|
126
|
+
* invocation context due to separate class constructors.
|
127
|
+
*
|
128
|
+
* @todo Remove this and related code if Next.js resolves the multiple dependency graph issue.
|
129
|
+
*/
|
130
|
+
static [Symbol.hasInstance](instance: unknown): boolean;
|
131
|
+
}
|
132
|
+
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
133
|
+
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
134
|
+
declare function toORPCError(error: unknown): ORPCError<any, any>;
|
135
|
+
declare function isORPCErrorStatus(status: number): boolean;
|
136
|
+
declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
|
137
|
+
declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
|
138
|
+
|
139
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
140
|
+
error: null;
|
141
|
+
data: TOutput;
|
142
|
+
isDefined: false;
|
143
|
+
isSuccess: true;
|
144
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
|
145
|
+
error: Exclude<TError, ORPCError<any, any>>;
|
146
|
+
data: undefined;
|
147
|
+
isDefined: false;
|
148
|
+
isSuccess: false;
|
149
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
|
150
|
+
error: Extract<TError, ORPCError<any, any>>;
|
151
|
+
data: undefined;
|
152
|
+
isDefined: true;
|
153
|
+
isSuccess: false;
|
154
|
+
};
|
155
|
+
/**
|
156
|
+
* Works like try/catch, but can infer error types.
|
157
|
+
*
|
158
|
+
* @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
|
159
|
+
* @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
|
160
|
+
*/
|
161
|
+
declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
|
162
|
+
declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
|
163
|
+
interface ConsumeEventIteratorOptions<T, TReturn, TError> {
|
164
|
+
/**
|
165
|
+
* Called on each event
|
166
|
+
*/
|
167
|
+
onEvent: (event: T) => void;
|
168
|
+
/**
|
169
|
+
* Called once error happens
|
170
|
+
*/
|
171
|
+
onError?: (error: TError) => void;
|
172
|
+
/**
|
173
|
+
* Called once event iterator is done
|
174
|
+
*
|
175
|
+
* @info If iterator is canceled, `undefined` can be passed on success
|
176
|
+
*/
|
177
|
+
onSuccess?: (value: TReturn | undefined) => void;
|
178
|
+
/**
|
179
|
+
* Called once after onError or onSuccess
|
180
|
+
*
|
181
|
+
* @info If iterator is canceled, `undefined` can be passed on success
|
182
|
+
*/
|
183
|
+
onFinish?: (state: OnFinishState<TReturn | undefined, TError>) => void;
|
184
|
+
}
|
185
|
+
/**
|
186
|
+
* Consumes an event iterator with lifecycle callbacks
|
187
|
+
*
|
188
|
+
* @warning If no `onError` or `onFinish` is provided, unhandled rejections will be thrown
|
189
|
+
* @return unsubscribe callback
|
190
|
+
*/
|
191
|
+
declare function consumeEventIterator<T, TReturn, TError = ThrowableError>(iterator: AsyncIterator<T, TReturn> | ClientPromiseResult<AsyncIterator<T, TReturn>, TError>, options: ConsumeEventIteratorOptions<T, TReturn, TError>): () => Promise<void>;
|
192
|
+
|
193
|
+
type SafeClient<T extends NestedClient<any>> = T extends Client<infer UContext, infer UInput, infer UOutput, infer UError> ? (...rest: ClientRest<UContext, UInput>) => Promise<SafeResult<UOutput, UError>> : {
|
194
|
+
[K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
|
195
|
+
};
|
196
|
+
/**
|
197
|
+
* Create a safe client that automatically wraps all procedure calls with the `safe` util.
|
198
|
+
*
|
199
|
+
* @example
|
200
|
+
* ```ts
|
201
|
+
* const safeClient = createSafeClient(client)
|
202
|
+
* const { error, data, isDefined } = await safeClient.doSomething({ id: '123' })
|
203
|
+
* ```
|
204
|
+
*
|
205
|
+
* @see {@link https://orpc.unnoq.com/docs/client/error-handling#using-createsafeclient Safe Client Docs}
|
206
|
+
*/
|
207
|
+
declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
|
208
|
+
|
209
|
+
declare const ORPC_CLIENT_PACKAGE_NAME = "@orpc/client";
|
210
|
+
declare const ORPC_CLIENT_PACKAGE_VERSION = "0.0.0-next.f21e305";
|
211
|
+
|
212
|
+
/**
|
213
|
+
* DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
|
214
|
+
* based on the request path, input, and context.
|
215
|
+
*
|
216
|
+
* @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
|
217
|
+
*/
|
218
|
+
declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
|
219
|
+
private readonly linkResolver;
|
220
|
+
constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
|
221
|
+
call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
|
222
|
+
}
|
223
|
+
|
224
|
+
declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
|
225
|
+
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
226
|
+
error: (error: unknown) => Promise<unknown>;
|
227
|
+
}): AsyncIteratorClass<TMap, TMap, TNext>;
|
228
|
+
|
229
|
+
export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, ORPC_CLIENT_PACKAGE_NAME, ORPC_CLIENT_PACKAGE_VERSION, consumeEventIterator, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
|
230
|
+
export type { CommonORPCErrorCode, ConsumeEventIteratorOptions, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };
|
package/dist/index.mjs
ADDED
@@ -0,0 +1,111 @@
|
|
1
|
+
import { preventNativeAwait, isTypescriptObject } from '@orpc/shared';
|
2
|
+
export { AsyncIteratorClass, EventPublisher, asyncIteratorToStream as eventIteratorToStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
3
|
+
import { i as isDefinedError } from './shared/client.C9Q9FzmH.mjs';
|
4
|
+
export { C as COMMON_ORPC_ERROR_DEFS, c as ORPCError, O as ORPC_CLIENT_PACKAGE_NAME, a as ORPC_CLIENT_PACKAGE_VERSION, g as createORPCErrorFromJson, b as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, e as isORPCErrorJson, d as isORPCErrorStatus, m as mapEventIterator, t as toORPCError } from './shared/client.C9Q9FzmH.mjs';
|
5
|
+
export { ErrorEvent } from '@orpc/standard-server';
|
6
|
+
|
7
|
+
async function safe(promise) {
|
8
|
+
try {
|
9
|
+
const output = await promise;
|
10
|
+
return Object.assign(
|
11
|
+
[null, output, false, true],
|
12
|
+
{ error: null, data: output, isDefined: false, isSuccess: true }
|
13
|
+
);
|
14
|
+
} catch (e) {
|
15
|
+
const error = e;
|
16
|
+
if (isDefinedError(error)) {
|
17
|
+
return Object.assign(
|
18
|
+
[error, void 0, true, false],
|
19
|
+
{ error, data: void 0, isDefined: true, isSuccess: false }
|
20
|
+
);
|
21
|
+
}
|
22
|
+
return Object.assign(
|
23
|
+
[error, void 0, false, false],
|
24
|
+
{ error, data: void 0, isDefined: false, isSuccess: false }
|
25
|
+
);
|
26
|
+
}
|
27
|
+
}
|
28
|
+
function resolveFriendlyClientOptions(options) {
|
29
|
+
return {
|
30
|
+
...options,
|
31
|
+
context: options.context ?? {}
|
32
|
+
// Context only optional if all fields are optional
|
33
|
+
};
|
34
|
+
}
|
35
|
+
function consumeEventIterator(iterator, options) {
|
36
|
+
void (async () => {
|
37
|
+
let onFinishState;
|
38
|
+
try {
|
39
|
+
const resolvedIterator = await iterator;
|
40
|
+
while (true) {
|
41
|
+
const { done, value } = await resolvedIterator.next();
|
42
|
+
if (done) {
|
43
|
+
const realValue = value;
|
44
|
+
onFinishState = [null, realValue, true];
|
45
|
+
options.onSuccess?.(realValue);
|
46
|
+
break;
|
47
|
+
}
|
48
|
+
options.onEvent(value);
|
49
|
+
}
|
50
|
+
} catch (error) {
|
51
|
+
onFinishState = [error, void 0, false];
|
52
|
+
if (!options.onError && !options.onFinish) {
|
53
|
+
throw error;
|
54
|
+
}
|
55
|
+
options.onError?.(error);
|
56
|
+
} finally {
|
57
|
+
options.onFinish?.(onFinishState);
|
58
|
+
}
|
59
|
+
})();
|
60
|
+
return async () => {
|
61
|
+
await (await iterator)?.return?.();
|
62
|
+
};
|
63
|
+
}
|
64
|
+
|
65
|
+
function createORPCClient(link, options = {}) {
|
66
|
+
const path = options.path ?? [];
|
67
|
+
const procedureClient = async (...[input, options2 = {}]) => {
|
68
|
+
return await link.call(path, input, resolveFriendlyClientOptions(options2));
|
69
|
+
};
|
70
|
+
const recursive = new Proxy(procedureClient, {
|
71
|
+
get(target, key) {
|
72
|
+
if (typeof key !== "string") {
|
73
|
+
return Reflect.get(target, key);
|
74
|
+
}
|
75
|
+
return createORPCClient(link, {
|
76
|
+
...options,
|
77
|
+
path: [...path, key]
|
78
|
+
});
|
79
|
+
}
|
80
|
+
});
|
81
|
+
return preventNativeAwait(recursive);
|
82
|
+
}
|
83
|
+
|
84
|
+
function createSafeClient(client) {
|
85
|
+
const proxy = new Proxy((...args) => safe(client(...args)), {
|
86
|
+
get(_, prop, receiver) {
|
87
|
+
const value = Reflect.get(client, prop, receiver);
|
88
|
+
if (typeof prop !== "string") {
|
89
|
+
return value;
|
90
|
+
}
|
91
|
+
if (!isTypescriptObject(value)) {
|
92
|
+
return value;
|
93
|
+
}
|
94
|
+
return createSafeClient(value);
|
95
|
+
}
|
96
|
+
});
|
97
|
+
return proxy;
|
98
|
+
}
|
99
|
+
|
100
|
+
class DynamicLink {
|
101
|
+
constructor(linkResolver) {
|
102
|
+
this.linkResolver = linkResolver;
|
103
|
+
}
|
104
|
+
async call(path, input, options) {
|
105
|
+
const resolvedLink = await this.linkResolver(options, path, input);
|
106
|
+
const output = await resolvedLink.call(path, input, options);
|
107
|
+
return output;
|
108
|
+
}
|
109
|
+
}
|
110
|
+
|
111
|
+
export { DynamicLink, consumeEventIterator, createORPCClient, createSafeClient, isDefinedError, resolveFriendlyClientOptions, safe };
|