@orpc/client 0.0.0-next.999d654 → 0.0.0-next.99d5d75
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 +145 -30
- package/dist/adapters/fetch/index.d.mts +31 -14
- package/dist/adapters/fetch/index.d.ts +31 -14
- package/dist/adapters/fetch/index.mjs +27 -16
- package/dist/adapters/message-port/index.d.mts +80 -0
- package/dist/adapters/message-port/index.d.ts +80 -0
- package/dist/adapters/message-port/index.mjs +87 -0
- package/dist/adapters/standard/index.d.mts +9 -146
- package/dist/adapters/standard/index.d.ts +9 -146
- package/dist/adapters/standard/index.mjs +4 -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 +47 -0
- package/dist/index.d.mts +108 -33
- package/dist/index.d.ts +108 -33
- package/dist/index.mjs +86 -37
- package/dist/plugins/index.d.mts +249 -0
- package/dist/plugins/index.d.ts +249 -0
- package/dist/plugins/index.mjs +485 -0
- package/dist/shared/client.2jUAqzYU.d.ts +45 -0
- package/dist/shared/client.B3pNRBih.d.ts +91 -0
- package/dist/shared/client.BFAVy68H.d.mts +91 -0
- package/dist/shared/client.BLtwTQUg.mjs +40 -0
- package/dist/shared/client.C6Bgyn6F.mjs +404 -0
- package/dist/shared/client.CPTihQgC.mjs +171 -0
- package/dist/shared/client.CpCa3si8.d.mts +45 -0
- package/dist/shared/client.i2uoJbEp.d.mts +83 -0
- package/dist/shared/client.i2uoJbEp.d.ts +83 -0
- package/package.json +23 -8
- package/dist/shared/client.D_CzLDyB.d.mts +0 -42
- package/dist/shared/client.D_CzLDyB.d.ts +0 -42
- package/dist/shared/client.Df5pd75N.mjs +0 -320
- package/dist/shared/client.XAn8cDTM.mjs +0 -266
package/dist/index.d.mts
CHANGED
|
@@ -1,25 +1,21 @@
|
|
|
1
|
-
import { N as NestedClient,
|
|
2
|
-
export {
|
|
3
|
-
import { Promisable,
|
|
4
|
-
export {
|
|
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.i2uoJbEp.mjs';
|
|
2
|
+
export { f as HTTPMethod, H as HTTPPath, h as InferClientBodyInputs, j as InferClientBodyOutputs, l as InferClientErrorUnion, k as InferClientErrors, g as InferClientInputs, i as InferClientOutputs } from './shared/client.i2uoJbEp.mjs';
|
|
3
|
+
import { MaybeOptionalOptions, ThrowableError, OnFinishState, Promisable, AsyncIteratorClass } from '@orpc/shared';
|
|
4
|
+
export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
|
5
|
+
export { ErrorEvent, EventMeta, getEventMeta, withEventMeta } from '@orpc/standard-server';
|
|
5
6
|
|
|
6
7
|
interface createORPCClientOptions {
|
|
7
8
|
/**
|
|
8
9
|
* Use as base path for all procedure, useful when you only want to call a subset of the procedure.
|
|
9
10
|
*/
|
|
10
|
-
path?: string[];
|
|
11
|
+
path?: readonly string[];
|
|
11
12
|
}
|
|
12
|
-
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
|
13
|
-
|
|
14
13
|
/**
|
|
15
|
-
*
|
|
16
|
-
*
|
|
14
|
+
* Create a oRPC client-side client from a link.
|
|
15
|
+
*
|
|
16
|
+
* @see {@link https://orpc.dev/docs/client/client-side Client-side Client Docs}
|
|
17
17
|
*/
|
|
18
|
-
declare
|
|
19
|
-
private readonly linkResolver;
|
|
20
|
-
constructor(linkResolver: (options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
|
|
21
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>): Promise<unknown>;
|
|
22
|
-
}
|
|
18
|
+
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
|
23
19
|
|
|
24
20
|
declare const COMMON_ORPC_ERROR_DEFS: {
|
|
25
21
|
readonly BAD_REQUEST: {
|
|
@@ -117,39 +113,118 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
|
117
113
|
readonly code: TCode;
|
|
118
114
|
readonly status: number;
|
|
119
115
|
readonly data: TData;
|
|
120
|
-
constructor(code: TCode, ...
|
|
116
|
+
constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
|
121
117
|
toJSON(): ORPCErrorJSON<TCode, TData>;
|
|
122
|
-
|
|
123
|
-
|
|
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;
|
|
124
131
|
}
|
|
125
132
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
|
126
133
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
|
127
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>;
|
|
128
138
|
|
|
129
|
-
type
|
|
130
|
-
interface EventIteratorState {
|
|
131
|
-
status: ConnectionStatus;
|
|
132
|
-
listeners: Array<(newStatus: ConnectionStatus) => void>;
|
|
133
|
-
}
|
|
134
|
-
declare function registerEventIteratorState(iterator: AsyncIteratorObject<unknown, unknown, void>, state: EventIteratorState): void;
|
|
135
|
-
declare function updateEventIteratorStatus(state: EventIteratorState, status: ConnectionStatus): void;
|
|
136
|
-
declare function onEventIteratorStatusChange(iterator: AsyncIteratorObject<unknown, unknown, void>, callback: (status: ConnectionStatus) => void, options?: {
|
|
137
|
-
notifyImmediately?: boolean;
|
|
138
|
-
}): () => void;
|
|
139
|
-
|
|
140
|
-
type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
|
|
139
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
|
141
140
|
error: null;
|
|
142
141
|
data: TOutput;
|
|
143
142
|
isDefined: false;
|
|
144
|
-
|
|
143
|
+
isSuccess: true;
|
|
144
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
|
|
145
145
|
error: Exclude<TError, ORPCError<any, any>>;
|
|
146
146
|
data: undefined;
|
|
147
147
|
isDefined: false;
|
|
148
|
-
|
|
148
|
+
isSuccess: false;
|
|
149
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
|
|
149
150
|
error: Extract<TError, ORPCError<any, any>>;
|
|
150
151
|
data: undefined;
|
|
151
152
|
isDefined: true;
|
|
153
|
+
isSuccess: false;
|
|
152
154
|
};
|
|
153
|
-
|
|
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.dev/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.dev/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.99d5d75";
|
|
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.dev/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>;
|
|
154
228
|
|
|
155
|
-
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink,
|
|
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
CHANGED
|
@@ -1,25 +1,21 @@
|
|
|
1
|
-
import { N as NestedClient,
|
|
2
|
-
export {
|
|
3
|
-
import { Promisable,
|
|
4
|
-
export {
|
|
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.i2uoJbEp.js';
|
|
2
|
+
export { f as HTTPMethod, H as HTTPPath, h as InferClientBodyInputs, j as InferClientBodyOutputs, l as InferClientErrorUnion, k as InferClientErrors, g as InferClientInputs, i as InferClientOutputs } from './shared/client.i2uoJbEp.js';
|
|
3
|
+
import { MaybeOptionalOptions, ThrowableError, OnFinishState, Promisable, AsyncIteratorClass } from '@orpc/shared';
|
|
4
|
+
export { AsyncIteratorClass, EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
|
5
|
+
export { ErrorEvent, EventMeta, getEventMeta, withEventMeta } from '@orpc/standard-server';
|
|
5
6
|
|
|
6
7
|
interface createORPCClientOptions {
|
|
7
8
|
/**
|
|
8
9
|
* Use as base path for all procedure, useful when you only want to call a subset of the procedure.
|
|
9
10
|
*/
|
|
10
|
-
path?: string[];
|
|
11
|
+
path?: readonly string[];
|
|
11
12
|
}
|
|
12
|
-
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
|
13
|
-
|
|
14
13
|
/**
|
|
15
|
-
*
|
|
16
|
-
*
|
|
14
|
+
* Create a oRPC client-side client from a link.
|
|
15
|
+
*
|
|
16
|
+
* @see {@link https://orpc.dev/docs/client/client-side Client-side Client Docs}
|
|
17
17
|
*/
|
|
18
|
-
declare
|
|
19
|
-
private readonly linkResolver;
|
|
20
|
-
constructor(linkResolver: (options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
|
|
21
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>): Promise<unknown>;
|
|
22
|
-
}
|
|
18
|
+
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
|
23
19
|
|
|
24
20
|
declare const COMMON_ORPC_ERROR_DEFS: {
|
|
25
21
|
readonly BAD_REQUEST: {
|
|
@@ -117,39 +113,118 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
|
117
113
|
readonly code: TCode;
|
|
118
114
|
readonly status: number;
|
|
119
115
|
readonly data: TData;
|
|
120
|
-
constructor(code: TCode, ...
|
|
116
|
+
constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
|
121
117
|
toJSON(): ORPCErrorJSON<TCode, TData>;
|
|
122
|
-
|
|
123
|
-
|
|
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;
|
|
124
131
|
}
|
|
125
132
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
|
126
133
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
|
127
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>;
|
|
128
138
|
|
|
129
|
-
type
|
|
130
|
-
interface EventIteratorState {
|
|
131
|
-
status: ConnectionStatus;
|
|
132
|
-
listeners: Array<(newStatus: ConnectionStatus) => void>;
|
|
133
|
-
}
|
|
134
|
-
declare function registerEventIteratorState(iterator: AsyncIteratorObject<unknown, unknown, void>, state: EventIteratorState): void;
|
|
135
|
-
declare function updateEventIteratorStatus(state: EventIteratorState, status: ConnectionStatus): void;
|
|
136
|
-
declare function onEventIteratorStatusChange(iterator: AsyncIteratorObject<unknown, unknown, void>, callback: (status: ConnectionStatus) => void, options?: {
|
|
137
|
-
notifyImmediately?: boolean;
|
|
138
|
-
}): () => void;
|
|
139
|
-
|
|
140
|
-
type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
|
|
139
|
+
type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
|
|
141
140
|
error: null;
|
|
142
141
|
data: TOutput;
|
|
143
142
|
isDefined: false;
|
|
144
|
-
|
|
143
|
+
isSuccess: true;
|
|
144
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
|
|
145
145
|
error: Exclude<TError, ORPCError<any, any>>;
|
|
146
146
|
data: undefined;
|
|
147
147
|
isDefined: false;
|
|
148
|
-
|
|
148
|
+
isSuccess: false;
|
|
149
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
|
|
149
150
|
error: Extract<TError, ORPCError<any, any>>;
|
|
150
151
|
data: undefined;
|
|
151
152
|
isDefined: true;
|
|
153
|
+
isSuccess: false;
|
|
152
154
|
};
|
|
153
|
-
|
|
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.dev/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.dev/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.99d5d75";
|
|
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.dev/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>;
|
|
154
228
|
|
|
155
|
-
export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink,
|
|
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
CHANGED
|
@@ -1,17 +1,72 @@
|
|
|
1
|
-
import {
|
|
2
|
-
export {
|
|
3
|
-
|
|
4
|
-
|
|
1
|
+
import { preventNativeAwait, isTypescriptObject } from '@orpc/shared';
|
|
2
|
+
export { AsyncIteratorClass, EventPublisher, asyncIteratorToStream as eventIteratorToStream, asyncIteratorToUnproxiedDataStream as eventIteratorToUnproxiedDataStream, onError, onFinish, onStart, onSuccess, streamToAsyncIteratorClass as streamToEventIterator } from '@orpc/shared';
|
|
3
|
+
import { i as isDefinedError } from './shared/client.CPTihQgC.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, t as toORPCError } from './shared/client.CPTihQgC.mjs';
|
|
5
|
+
export { m as mapEventIterator } from './shared/client.BLtwTQUg.mjs';
|
|
6
|
+
export { ErrorEvent, getEventMeta, withEventMeta } from '@orpc/standard-server';
|
|
5
7
|
|
|
6
|
-
function
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
8
|
+
async function safe(promise) {
|
|
9
|
+
try {
|
|
10
|
+
const output = await promise;
|
|
11
|
+
return Object.assign(
|
|
12
|
+
[null, output, false, true],
|
|
13
|
+
{ error: null, data: output, isDefined: false, isSuccess: true }
|
|
14
|
+
);
|
|
15
|
+
} catch (e) {
|
|
16
|
+
const error = e;
|
|
17
|
+
if (isDefinedError(error)) {
|
|
18
|
+
return Object.assign(
|
|
19
|
+
[error, void 0, true, false],
|
|
20
|
+
{ error, data: void 0, isDefined: true, isSuccess: false }
|
|
21
|
+
);
|
|
22
|
+
}
|
|
23
|
+
return Object.assign(
|
|
24
|
+
[error, void 0, false, false],
|
|
25
|
+
{ error, data: void 0, isDefined: false, isSuccess: false }
|
|
26
|
+
);
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
function resolveFriendlyClientOptions(options) {
|
|
30
|
+
return {
|
|
31
|
+
...options,
|
|
32
|
+
context: options.context ?? {}
|
|
33
|
+
// Context only optional if all fields are optional
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
function consumeEventIterator(iterator, options) {
|
|
37
|
+
void (async () => {
|
|
38
|
+
let onFinishState;
|
|
39
|
+
try {
|
|
40
|
+
const resolvedIterator = await iterator;
|
|
41
|
+
while (true) {
|
|
42
|
+
const { done, value } = await resolvedIterator.next();
|
|
43
|
+
if (done) {
|
|
44
|
+
const realValue = value;
|
|
45
|
+
onFinishState = [null, realValue, true];
|
|
46
|
+
options.onSuccess?.(realValue);
|
|
47
|
+
break;
|
|
48
|
+
}
|
|
49
|
+
options.onEvent(value);
|
|
50
|
+
}
|
|
51
|
+
} catch (error) {
|
|
52
|
+
onFinishState = [error, void 0, false];
|
|
53
|
+
if (!options.onError && !options.onFinish) {
|
|
54
|
+
throw error;
|
|
55
|
+
}
|
|
56
|
+
options.onError?.(error);
|
|
57
|
+
} finally {
|
|
58
|
+
options.onFinish?.(onFinishState);
|
|
59
|
+
}
|
|
60
|
+
})();
|
|
61
|
+
return async () => {
|
|
62
|
+
await (await iterator)?.return?.();
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
function createORPCClient(link, options = {}) {
|
|
67
|
+
const path = options.path ?? [];
|
|
68
|
+
const procedureClient = async (...[input, options2 = {}]) => {
|
|
69
|
+
return await link.call(path, input, resolveFriendlyClientOptions(options2));
|
|
15
70
|
};
|
|
16
71
|
const recursive = new Proxy(procedureClient, {
|
|
17
72
|
get(target, key) {
|
|
@@ -24,7 +79,23 @@ function createORPCClient(link, options) {
|
|
|
24
79
|
});
|
|
25
80
|
}
|
|
26
81
|
});
|
|
27
|
-
return recursive;
|
|
82
|
+
return preventNativeAwait(recursive);
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
function createSafeClient(client) {
|
|
86
|
+
const proxy = new Proxy((...args) => safe(client(...args)), {
|
|
87
|
+
get(_, prop, receiver) {
|
|
88
|
+
const value = Reflect.get(client, prop, receiver);
|
|
89
|
+
if (typeof prop !== "string") {
|
|
90
|
+
return value;
|
|
91
|
+
}
|
|
92
|
+
if (!isTypescriptObject(value)) {
|
|
93
|
+
return value;
|
|
94
|
+
}
|
|
95
|
+
return createSafeClient(value);
|
|
96
|
+
}
|
|
97
|
+
});
|
|
98
|
+
return proxy;
|
|
28
99
|
}
|
|
29
100
|
|
|
30
101
|
class DynamicLink {
|
|
@@ -38,26 +109,4 @@ class DynamicLink {
|
|
|
38
109
|
}
|
|
39
110
|
}
|
|
40
111
|
|
|
41
|
-
|
|
42
|
-
try {
|
|
43
|
-
const output = await promise;
|
|
44
|
-
return Object.assign(
|
|
45
|
-
[null, output, false],
|
|
46
|
-
{ error: null, data: output, isDefined: false }
|
|
47
|
-
);
|
|
48
|
-
} catch (e) {
|
|
49
|
-
const error = e;
|
|
50
|
-
if (isDefinedError(error)) {
|
|
51
|
-
return Object.assign(
|
|
52
|
-
[error, void 0, true],
|
|
53
|
-
{ error, data: void 0, isDefined: true }
|
|
54
|
-
);
|
|
55
|
-
}
|
|
56
|
-
return Object.assign(
|
|
57
|
-
[error, void 0, false],
|
|
58
|
-
{ error, data: void 0, isDefined: false }
|
|
59
|
-
);
|
|
60
|
-
}
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
export { DynamicLink, createORPCClient, isDefinedError, safe };
|
|
112
|
+
export { DynamicLink, consumeEventIterator, createORPCClient, createSafeClient, isDefinedError, resolveFriendlyClientOptions, safe };
|