@orpc/client 0.0.0-next.e563486 → 0.0.0-next.e565e67
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 -22
- package/dist/adapters/fetch/index.d.mts +31 -15
- package/dist/adapters/fetch/index.d.ts +31 -15
- package/dist/adapters/fetch/index.mjs +27 -18
- 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 -103
- package/dist/adapters/standard/index.d.ts +9 -103
- package/dist/adapters/standard/index.mjs +4 -3
- 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 +107 -27
- package/dist/index.d.ts +107 -27
- package/dist/index.mjs +85 -36
- package/dist/plugins/index.d.mts +212 -25
- package/dist/plugins/index.d.ts +212 -25
- package/dist/plugins/index.mjs +419 -61
- package/dist/shared/client.BH1AYT_p.d.mts +83 -0
- package/dist/shared/client.BH1AYT_p.d.ts +83 -0
- package/dist/shared/client.BLtwTQUg.mjs +40 -0
- package/dist/shared/client.BxV-mzeR.d.ts +91 -0
- package/dist/shared/client.CPgZaUox.d.mts +45 -0
- package/dist/shared/{client.CjUckqXO.mjs → client.CdE4ChCn.mjs} +108 -47
- package/dist/shared/client.Cs5F1cjw.mjs +171 -0
- package/dist/shared/client.D8lMmWVC.d.mts +91 -0
- package/dist/shared/client.De8SW4Kw.d.ts +45 -0
- package/package.json +16 -5
- package/dist/shared/client.BacCdg3F.mjs +0 -172
- package/dist/shared/client.CupM8eRP.d.mts +0 -30
- package/dist/shared/client.CupM8eRP.d.ts +0 -30
- package/dist/shared/client.CvnV7_uV.mjs +0 -12
- package/dist/shared/client.DrOAzyMB.d.mts +0 -45
- package/dist/shared/client.aGal-uGY.d.ts +0 -45
|
@@ -1,105 +1,11 @@
|
|
|
1
|
-
|
|
2
|
-
export {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import
|
|
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.De8SW4Kw.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.BxV-mzeR.js';
|
|
3
|
+
import { StandardHeaders } from '@orpc/standard-server';
|
|
4
|
+
import { H as HTTPPath } from '../../shared/client.BH1AYT_p.js';
|
|
5
|
+
import '@orpc/shared';
|
|
6
6
|
|
|
7
|
-
declare
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
readonly NAN: 2;
|
|
11
|
-
readonly UNDEFINED: 3;
|
|
12
|
-
readonly URL: 4;
|
|
13
|
-
readonly REGEXP: 5;
|
|
14
|
-
readonly SET: 6;
|
|
15
|
-
readonly MAP: 7;
|
|
16
|
-
};
|
|
17
|
-
type StandardRPCJsonSerializedMetaItem = readonly [type: number, ...path: Segment[]];
|
|
18
|
-
type StandardRPCJsonSerialized = [json: unknown, meta: StandardRPCJsonSerializedMetaItem[], maps: Segment[][], blobs: Blob[]];
|
|
19
|
-
interface StandardRPCCustomJsonSerializer {
|
|
20
|
-
type: number;
|
|
21
|
-
condition(data: unknown): boolean;
|
|
22
|
-
serialize(data: any): unknown;
|
|
23
|
-
deserialize(serialized: any): unknown;
|
|
24
|
-
}
|
|
25
|
-
interface StandardRPCJsonSerializerOptions {
|
|
26
|
-
customJsonSerializers?: readonly StandardRPCCustomJsonSerializer[];
|
|
27
|
-
}
|
|
28
|
-
declare class StandardRPCJsonSerializer {
|
|
29
|
-
private readonly customSerializers;
|
|
30
|
-
constructor(options?: StandardRPCJsonSerializerOptions);
|
|
31
|
-
serialize(data: unknown, segments?: Segment[], meta?: StandardRPCJsonSerializedMetaItem[], maps?: Segment[][], blobs?: Blob[]): StandardRPCJsonSerialized;
|
|
32
|
-
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[]): unknown;
|
|
33
|
-
deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[], maps: readonly Segment[][], getBlob: (index: number) => Blob): unknown;
|
|
34
|
-
}
|
|
7
|
+
declare function toHttpPath(path: readonly string[]): HTTPPath;
|
|
8
|
+
declare function toStandardHeaders(headers: Headers | StandardHeaders): StandardHeaders;
|
|
9
|
+
declare function getMalformedResponseErrorCode(status: number): string;
|
|
35
10
|
|
|
36
|
-
|
|
37
|
-
#private;
|
|
38
|
-
private readonly jsonSerializer;
|
|
39
|
-
constructor(jsonSerializer: StandardRPCJsonSerializer);
|
|
40
|
-
serialize(data: unknown): unknown;
|
|
41
|
-
deserialize(data: unknown): unknown;
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
45
|
-
interface StandardRPCLinkCodecOptions<T extends ClientContext> {
|
|
46
|
-
/**
|
|
47
|
-
* Base url for all requests.
|
|
48
|
-
*/
|
|
49
|
-
url: Value<string | URL, [
|
|
50
|
-
options: ClientOptionsOut<T>,
|
|
51
|
-
path: readonly string[],
|
|
52
|
-
input: unknown
|
|
53
|
-
]>;
|
|
54
|
-
/**
|
|
55
|
-
* The maximum length of the URL.
|
|
56
|
-
*
|
|
57
|
-
* @default 2083
|
|
58
|
-
*/
|
|
59
|
-
maxUrlLength?: Value<number, [
|
|
60
|
-
options: ClientOptionsOut<T>,
|
|
61
|
-
path: readonly string[],
|
|
62
|
-
input: unknown
|
|
63
|
-
]>;
|
|
64
|
-
/**
|
|
65
|
-
* The method used to make the request.
|
|
66
|
-
*
|
|
67
|
-
* @default 'POST'
|
|
68
|
-
*/
|
|
69
|
-
method?: Value<HTTPMethod, [
|
|
70
|
-
options: ClientOptionsOut<T>,
|
|
71
|
-
path: readonly string[],
|
|
72
|
-
input: unknown
|
|
73
|
-
]>;
|
|
74
|
-
/**
|
|
75
|
-
* The method to use when the payload cannot safely pass to the server with method return from method function.
|
|
76
|
-
* GET is not allowed, it's very dangerous.
|
|
77
|
-
*
|
|
78
|
-
* @default 'POST'
|
|
79
|
-
*/
|
|
80
|
-
fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
|
|
81
|
-
/**
|
|
82
|
-
* Inject headers to the request.
|
|
83
|
-
*/
|
|
84
|
-
headers?: Value<StandardHeaders, [
|
|
85
|
-
options: ClientOptionsOut<T>,
|
|
86
|
-
path: readonly string[],
|
|
87
|
-
input: unknown
|
|
88
|
-
]>;
|
|
89
|
-
}
|
|
90
|
-
declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
|
|
91
|
-
private readonly serializer;
|
|
92
|
-
private readonly baseUrl;
|
|
93
|
-
private readonly maxUrlLength;
|
|
94
|
-
private readonly fallbackMethod;
|
|
95
|
-
private readonly expectedMethod;
|
|
96
|
-
private readonly headers;
|
|
97
|
-
constructor(serializer: StandardRPCSerializer, options: StandardRPCLinkCodecOptions<T>);
|
|
98
|
-
encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
|
|
99
|
-
decode(response: StandardLazyResponse): Promise<unknown>;
|
|
100
|
-
}
|
|
101
|
-
|
|
102
|
-
interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
|
|
103
|
-
}
|
|
104
|
-
|
|
105
|
-
export { STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, StandardLinkCodec, StandardLinkOptions, type StandardRPCCustomJsonSerializer, type StandardRPCJsonSerialized, type StandardRPCJsonSerializedMetaItem, StandardRPCJsonSerializer, type StandardRPCJsonSerializerOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions, type StandardRPCLinkOptions, StandardRPCSerializer };
|
|
11
|
+
export { getMalformedResponseErrorCode, toHttpPath, toStandardHeaders };
|
|
@@ -1,5 +1,6 @@
|
|
|
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, f as toStandardHeaders } from '../../shared/client.CdE4ChCn.mjs';
|
|
2
2
|
import '@orpc/shared';
|
|
3
|
-
import '../../shared/client.CvnV7_uV.mjs';
|
|
4
3
|
import '@orpc/standard-server';
|
|
5
|
-
import '../../shared/client.
|
|
4
|
+
import '../../shared/client.Cs5F1cjw.mjs';
|
|
5
|
+
import '@orpc/standard-server-fetch';
|
|
6
|
+
import '../../shared/client.BLtwTQUg.mjs';
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
2
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BH1AYT_p.mjs';
|
|
3
|
+
import { f as StandardLinkClient } from '../../shared/client.CPgZaUox.mjs';
|
|
4
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.D8lMmWVC.mjs';
|
|
5
|
+
import '@orpc/shared';
|
|
6
|
+
|
|
7
|
+
interface LinkWebsocketClientOptions {
|
|
8
|
+
websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
|
|
9
|
+
}
|
|
10
|
+
declare class LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
|
|
11
|
+
private readonly peer;
|
|
12
|
+
constructor(options: LinkWebsocketClientOptions);
|
|
13
|
+
call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkWebsocketClientOptions {
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* The RPC Link communicates with the server using the RPC protocol over WebSocket.
|
|
20
|
+
*
|
|
21
|
+
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
|
|
22
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/websocket WebSocket Adapter Docs}
|
|
23
|
+
*/
|
|
24
|
+
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
|
25
|
+
constructor(options: RPCLinkOptions<T>);
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
export { LinkWebsocketClient, RPCLink };
|
|
29
|
+
export type { LinkWebsocketClientOptions, RPCLinkOptions };
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
|
|
2
|
+
import { b as ClientContext, c as ClientOptions } from '../../shared/client.BH1AYT_p.js';
|
|
3
|
+
import { f as StandardLinkClient } from '../../shared/client.De8SW4Kw.js';
|
|
4
|
+
import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.BxV-mzeR.js';
|
|
5
|
+
import '@orpc/shared';
|
|
6
|
+
|
|
7
|
+
interface LinkWebsocketClientOptions {
|
|
8
|
+
websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
|
|
9
|
+
}
|
|
10
|
+
declare class LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
|
|
11
|
+
private readonly peer;
|
|
12
|
+
constructor(options: LinkWebsocketClientOptions);
|
|
13
|
+
call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkWebsocketClientOptions {
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* The RPC Link communicates with the server using the RPC protocol over WebSocket.
|
|
20
|
+
*
|
|
21
|
+
* @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
|
|
22
|
+
* @see {@link https://orpc.unnoq.com/docs/adapters/websocket WebSocket Adapter Docs}
|
|
23
|
+
*/
|
|
24
|
+
declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
|
|
25
|
+
constructor(options: RPCLinkOptions<T>);
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
export { LinkWebsocketClient, RPCLink };
|
|
29
|
+
export type { LinkWebsocketClientOptions, RPCLinkOptions };
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import { readAsBuffer } from '@orpc/shared';
|
|
2
|
+
import { ClientPeer } from '@orpc/standard-server-peer';
|
|
3
|
+
import { c as StandardRPCLink } from '../../shared/client.CdE4ChCn.mjs';
|
|
4
|
+
import '@orpc/standard-server';
|
|
5
|
+
import '../../shared/client.Cs5F1cjw.mjs';
|
|
6
|
+
import '@orpc/standard-server-fetch';
|
|
7
|
+
import '../../shared/client.BLtwTQUg.mjs';
|
|
8
|
+
|
|
9
|
+
const WEBSOCKET_CONNECTING = 0;
|
|
10
|
+
class LinkWebsocketClient {
|
|
11
|
+
peer;
|
|
12
|
+
constructor(options) {
|
|
13
|
+
const untilOpen = new Promise((resolve) => {
|
|
14
|
+
if (options.websocket.readyState === WEBSOCKET_CONNECTING) {
|
|
15
|
+
options.websocket.addEventListener("open", () => {
|
|
16
|
+
resolve();
|
|
17
|
+
}, { once: true });
|
|
18
|
+
} else {
|
|
19
|
+
resolve();
|
|
20
|
+
}
|
|
21
|
+
});
|
|
22
|
+
this.peer = new ClientPeer(async (message) => {
|
|
23
|
+
await untilOpen;
|
|
24
|
+
return options.websocket.send(message);
|
|
25
|
+
});
|
|
26
|
+
options.websocket.addEventListener("message", async (event) => {
|
|
27
|
+
const message = event.data instanceof Blob ? await readAsBuffer(event.data) : event.data;
|
|
28
|
+
this.peer.message(message);
|
|
29
|
+
});
|
|
30
|
+
options.websocket.addEventListener("close", () => {
|
|
31
|
+
this.peer.close();
|
|
32
|
+
});
|
|
33
|
+
}
|
|
34
|
+
async call(request, _options, _path, _input) {
|
|
35
|
+
const response = await this.peer.request(request);
|
|
36
|
+
return { ...response, body: () => Promise.resolve(response.body) };
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
class RPCLink extends StandardRPCLink {
|
|
41
|
+
constructor(options) {
|
|
42
|
+
const linkClient = new LinkWebsocketClient(options);
|
|
43
|
+
super(linkClient, { ...options, url: "orpc://localhost" });
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
export { LinkWebsocketClient, RPCLink };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,26 +1,21 @@
|
|
|
1
|
-
import { N as NestedClient,
|
|
2
|
-
export { f as
|
|
3
|
-
import { Promisable,
|
|
4
|
-
export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
|
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.BH1AYT_p.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.BH1AYT_p.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
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
|
6
6
|
|
|
7
7
|
interface createORPCClientOptions {
|
|
8
8
|
/**
|
|
9
9
|
* Use as base path for all procedure, useful when you only want to call a subset of the procedure.
|
|
10
10
|
*/
|
|
11
|
-
path?: string[];
|
|
11
|
+
path?: readonly string[];
|
|
12
12
|
}
|
|
13
|
-
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
|
14
|
-
|
|
15
13
|
/**
|
|
16
|
-
*
|
|
17
|
-
*
|
|
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}
|
|
18
17
|
*/
|
|
19
|
-
declare
|
|
20
|
-
private readonly linkResolver;
|
|
21
|
-
constructor(linkResolver: (options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
|
|
22
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>): Promise<unknown>;
|
|
23
|
-
}
|
|
18
|
+
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
|
24
19
|
|
|
25
20
|
declare const COMMON_ORPC_ERROR_DEFS: {
|
|
26
21
|
readonly BAD_REQUEST: {
|
|
@@ -118,33 +113,118 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
|
118
113
|
readonly code: TCode;
|
|
119
114
|
readonly status: number;
|
|
120
115
|
readonly data: TData;
|
|
121
|
-
constructor(code: TCode, ...
|
|
116
|
+
constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
|
122
117
|
toJSON(): ORPCErrorJSON<TCode, TData>;
|
|
123
|
-
|
|
124
|
-
|
|
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;
|
|
125
131
|
}
|
|
126
132
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
|
127
133
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
|
128
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>;
|
|
129
138
|
|
|
130
|
-
|
|
131
|
-
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
|
132
|
-
error: (error: unknown) => Promise<unknown>;
|
|
133
|
-
}): AsyncGenerator<TMap, TMap, TNext>;
|
|
134
|
-
|
|
135
|
-
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] & {
|
|
136
140
|
error: null;
|
|
137
141
|
data: TOutput;
|
|
138
142
|
isDefined: false;
|
|
139
|
-
|
|
143
|
+
isSuccess: true;
|
|
144
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
|
|
140
145
|
error: Exclude<TError, ORPCError<any, any>>;
|
|
141
146
|
data: undefined;
|
|
142
147
|
isDefined: false;
|
|
143
|
-
|
|
148
|
+
isSuccess: false;
|
|
149
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
|
|
144
150
|
error: Extract<TError, ORPCError<any, any>>;
|
|
145
151
|
data: undefined;
|
|
146
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;
|
|
147
195
|
};
|
|
148
|
-
|
|
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.e565e67";
|
|
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>;
|
|
149
228
|
|
|
150
|
-
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,26 +1,21 @@
|
|
|
1
|
-
import { N as NestedClient,
|
|
2
|
-
export { f as
|
|
3
|
-
import { Promisable,
|
|
4
|
-
export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
|
|
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.BH1AYT_p.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.BH1AYT_p.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
5
|
export { ErrorEvent } from '@orpc/standard-server';
|
|
6
6
|
|
|
7
7
|
interface createORPCClientOptions {
|
|
8
8
|
/**
|
|
9
9
|
* Use as base path for all procedure, useful when you only want to call a subset of the procedure.
|
|
10
10
|
*/
|
|
11
|
-
path?: string[];
|
|
11
|
+
path?: readonly string[];
|
|
12
12
|
}
|
|
13
|
-
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
|
14
|
-
|
|
15
13
|
/**
|
|
16
|
-
*
|
|
17
|
-
*
|
|
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}
|
|
18
17
|
*/
|
|
19
|
-
declare
|
|
20
|
-
private readonly linkResolver;
|
|
21
|
-
constructor(linkResolver: (options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
|
|
22
|
-
call(path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>): Promise<unknown>;
|
|
23
|
-
}
|
|
18
|
+
declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
|
|
24
19
|
|
|
25
20
|
declare const COMMON_ORPC_ERROR_DEFS: {
|
|
26
21
|
readonly BAD_REQUEST: {
|
|
@@ -118,33 +113,118 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
|
|
|
118
113
|
readonly code: TCode;
|
|
119
114
|
readonly status: number;
|
|
120
115
|
readonly data: TData;
|
|
121
|
-
constructor(code: TCode, ...
|
|
116
|
+
constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
|
|
122
117
|
toJSON(): ORPCErrorJSON<TCode, TData>;
|
|
123
|
-
|
|
124
|
-
|
|
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;
|
|
125
131
|
}
|
|
126
132
|
type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
|
|
127
133
|
declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
|
|
128
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>;
|
|
129
138
|
|
|
130
|
-
|
|
131
|
-
value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
|
|
132
|
-
error: (error: unknown) => Promise<unknown>;
|
|
133
|
-
}): AsyncGenerator<TMap, TMap, TNext>;
|
|
134
|
-
|
|
135
|
-
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] & {
|
|
136
140
|
error: null;
|
|
137
141
|
data: TOutput;
|
|
138
142
|
isDefined: false;
|
|
139
|
-
|
|
143
|
+
isSuccess: true;
|
|
144
|
+
} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
|
|
140
145
|
error: Exclude<TError, ORPCError<any, any>>;
|
|
141
146
|
data: undefined;
|
|
142
147
|
isDefined: false;
|
|
143
|
-
|
|
148
|
+
isSuccess: false;
|
|
149
|
+
} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
|
|
144
150
|
error: Extract<TError, ORPCError<any, any>>;
|
|
145
151
|
data: undefined;
|
|
146
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;
|
|
147
195
|
};
|
|
148
|
-
|
|
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.e565e67";
|
|
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>;
|
|
149
228
|
|
|
150
|
-
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 };
|