@orpc/client 0.0.0-next.b0f324e → 0.0.0-next.b12bcdb

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.
@@ -0,0 +1,72 @@
1
+ import { ClientPeer } from '@orpc/standard-server-peer';
2
+ import '@orpc/shared';
3
+ import { c as StandardRPCLink } from '../../shared/client.Bp1jlnBk.mjs';
4
+ import '@orpc/standard-server';
5
+ import '@orpc/standard-server-fetch';
6
+ import '../../shared/client.txdq_i5V.mjs';
7
+
8
+ function postMessagePortMessage(port, data) {
9
+ port.postMessage(data);
10
+ }
11
+ function onMessagePortMessage(port, callback) {
12
+ if ("addEventListener" in port) {
13
+ port.addEventListener("message", (event) => {
14
+ callback(event.data);
15
+ });
16
+ } else if ("on" in port) {
17
+ port.on("message", (event) => {
18
+ callback(event?.data);
19
+ });
20
+ } else if ("onMessage" in port) {
21
+ port.onMessage.addListener((data) => {
22
+ callback(data);
23
+ });
24
+ } else {
25
+ throw new Error("Cannot find a addEventListener/on/onMessage method on the port");
26
+ }
27
+ }
28
+ function onMessagePortClose(port, callback) {
29
+ if ("addEventListener" in port) {
30
+ port.addEventListener("close", async () => {
31
+ callback();
32
+ });
33
+ } else if ("on" in port) {
34
+ port.on("close", async () => {
35
+ callback();
36
+ });
37
+ } else if ("onDisconnect" in port) {
38
+ port.onDisconnect.addListener(() => {
39
+ callback();
40
+ });
41
+ } else {
42
+ throw new Error("Cannot find a addEventListener/on/onDisconnect method on the port");
43
+ }
44
+ }
45
+
46
+ class LinkMessagePortClient {
47
+ peer;
48
+ constructor(options) {
49
+ this.peer = new ClientPeer((message) => {
50
+ return postMessagePortMessage(options.port, message);
51
+ });
52
+ onMessagePortMessage(options.port, async (message) => {
53
+ await this.peer.message(message);
54
+ });
55
+ onMessagePortClose(options.port, () => {
56
+ this.peer.close();
57
+ });
58
+ }
59
+ async call(request, _options, _path, _input) {
60
+ const response = await this.peer.request(request);
61
+ return { ...response, body: () => Promise.resolve(response.body) };
62
+ }
63
+ }
64
+
65
+ class RPCLink extends StandardRPCLink {
66
+ constructor(options) {
67
+ const linkClient = new LinkMessagePortClient(options);
68
+ super(linkClient, { ...options, url: "orpc:/" });
69
+ }
70
+ }
71
+
72
+ export { LinkMessagePortClient, RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };
@@ -1,22 +1,11 @@
1
- import { Segment } from '@orpc/shared';
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.Bwgm6dgk.mjs';
2
+ export { S as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, c as StandardRPCCustomJsonSerializer, b as StandardRPCJsonSerialized, a as StandardRPCJsonSerializedMetaItem, e as StandardRPCJsonSerializer, d as StandardRPCJsonSerializerOptions, g as StandardRPCLink, i as StandardRPCLinkCodec, h as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, j as StandardRPCSerializer } from '../../shared/client._Y_enhib.mjs';
3
+ import { StandardHeaders } from '@orpc/standard-server';
4
+ import { H as HTTPPath } from '../../shared/client.BOYsZIRq.mjs';
5
+ import '@orpc/shared';
2
6
 
3
- type RPCJsonSerializedMeta = [
4
- 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7,
5
- Segment[]
6
- ][];
7
- type RPCJsonSerialized = [json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], blobs: Blob[]];
8
- declare class RPCJsonSerializer {
9
- serialize(data: unknown, segments?: Segment[], meta?: RPCJsonSerializedMeta, maps?: Segment[][], blobs?: Blob[]): RPCJsonSerialized;
10
- deserialize(json: unknown, meta: RPCJsonSerializedMeta): unknown;
11
- deserialize(json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], getBlob: (index: number) => Blob): unknown;
12
- }
7
+ declare function toHttpPath(path: readonly string[]): HTTPPath;
8
+ declare function toStandardHeaders(headers: Headers | StandardHeaders): StandardHeaders;
9
+ declare function getMalformedResponseErrorCode(status: number): string;
13
10
 
14
- declare class RPCSerializer {
15
- #private;
16
- private readonly jsonSerializer;
17
- constructor(jsonSerializer?: RPCJsonSerializer);
18
- serialize(data: unknown): unknown;
19
- deserialize(data: unknown): unknown;
20
- }
21
-
22
- export { type RPCJsonSerialized, type RPCJsonSerializedMeta, RPCJsonSerializer, RPCSerializer };
11
+ export { getMalformedResponseErrorCode, toHttpPath, toStandardHeaders };
@@ -1,22 +1,11 @@
1
- import { Segment } from '@orpc/shared';
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.BG98rYdO.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.CVVVqf1Y.js';
3
+ import { StandardHeaders } from '@orpc/standard-server';
4
+ import { H as HTTPPath } from '../../shared/client.BOYsZIRq.js';
5
+ import '@orpc/shared';
2
6
 
3
- type RPCJsonSerializedMeta = [
4
- 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7,
5
- Segment[]
6
- ][];
7
- type RPCJsonSerialized = [json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], blobs: Blob[]];
8
- declare class RPCJsonSerializer {
9
- serialize(data: unknown, segments?: Segment[], meta?: RPCJsonSerializedMeta, maps?: Segment[][], blobs?: Blob[]): RPCJsonSerialized;
10
- deserialize(json: unknown, meta: RPCJsonSerializedMeta): unknown;
11
- deserialize(json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], getBlob: (index: number) => Blob): unknown;
12
- }
7
+ declare function toHttpPath(path: readonly string[]): HTTPPath;
8
+ declare function toStandardHeaders(headers: Headers | StandardHeaders): StandardHeaders;
9
+ declare function getMalformedResponseErrorCode(status: number): string;
13
10
 
14
- declare class RPCSerializer {
15
- #private;
16
- private readonly jsonSerializer;
17
- constructor(jsonSerializer?: RPCJsonSerializer);
18
- serialize(data: unknown): unknown;
19
- deserialize(data: unknown): unknown;
20
- }
21
-
22
- export { type RPCJsonSerialized, type RPCJsonSerializedMeta, RPCJsonSerializer, RPCSerializer };
11
+ export { getMalformedResponseErrorCode, toHttpPath, toStandardHeaders };
@@ -1,4 +1,5 @@
1
- export { R as RPCJsonSerializer, a as RPCSerializer } from '../../shared/client.DHJ8vRIG.mjs';
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.Bp1jlnBk.mjs';
2
2
  import '@orpc/shared';
3
3
  import '@orpc/standard-server';
4
- import '../../shared/client.Ly4zGQrc.mjs';
4
+ import '../../shared/client.txdq_i5V.mjs';
5
+ import '@orpc/standard-server-fetch';
@@ -0,0 +1,29 @@
1
+ import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
2
+ import { b as ClientContext, c as ClientOptions } from '../../shared/client.BOYsZIRq.mjs';
3
+ import { f as StandardLinkClient } from '../../shared/client.Bwgm6dgk.mjs';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client._Y_enhib.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.BOYsZIRq.js';
3
+ import { f as StandardLinkClient } from '../../shared/client.BG98rYdO.js';
4
+ import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.CVVVqf1Y.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,46 @@
1
+ import { readAsBuffer } from '@orpc/shared';
2
+ import { ClientPeer } from '@orpc/standard-server-peer';
3
+ import { c as StandardRPCLink } from '../../shared/client.Bp1jlnBk.mjs';
4
+ import '@orpc/standard-server';
5
+ import '@orpc/standard-server-fetch';
6
+ import '../../shared/client.txdq_i5V.mjs';
7
+
8
+ const WEBSOCKET_CONNECTING = 0;
9
+ class LinkWebsocketClient {
10
+ peer;
11
+ constructor(options) {
12
+ const untilOpen = new Promise((resolve) => {
13
+ if (options.websocket.readyState === WEBSOCKET_CONNECTING) {
14
+ options.websocket.addEventListener("open", () => {
15
+ resolve();
16
+ }, { once: true });
17
+ } else {
18
+ resolve();
19
+ }
20
+ });
21
+ this.peer = new ClientPeer(async (message) => {
22
+ await untilOpen;
23
+ return options.websocket.send(message);
24
+ });
25
+ options.websocket.addEventListener("message", async (event) => {
26
+ const message = event.data instanceof Blob ? await readAsBuffer(event.data) : event.data;
27
+ this.peer.message(message);
28
+ });
29
+ options.websocket.addEventListener("close", () => {
30
+ this.peer.close();
31
+ });
32
+ }
33
+ async call(request, _options, _path, _input) {
34
+ const response = await this.peer.request(request);
35
+ return { ...response, body: () => Promise.resolve(response.body) };
36
+ }
37
+ }
38
+
39
+ class RPCLink extends StandardRPCLink {
40
+ constructor(options) {
41
+ const linkClient = new LinkWebsocketClient(options);
42
+ super(linkClient, { ...options, url: "orpc:/" });
43
+ }
44
+ }
45
+
46
+ export { LinkWebsocketClient, RPCLink };
package/dist/index.d.mts CHANGED
@@ -1,25 +1,21 @@
1
- import { N as NestedClient, b as ClientLink, I as InferClientContext, C as ClientContext, a as ClientOptionsOut, c as ClientPromiseResult } from './shared/client.D_CzLDyB.mjs';
2
- export { g as Client, e as ClientOptions, f as ClientRest, E as EventIteratorReconnectOptions, d as createAutoRetryEventIterator, m as mapEventIterator } from './shared/client.D_CzLDyB.mjs';
3
- import { Promisable, MaybeOptionalOptions } 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.BOYsZIRq.mjs';
2
+ export { f as HTTPMethod, H as HTTPPath } from './shared/client.BOYsZIRq.mjs';
3
+ import { MaybeOptionalOptions, ThrowableError, 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';
4
5
  export { ErrorEvent } 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
- * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
16
- * based on the request path, input, and context.
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
17
  */
18
- declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
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,37 +113,73 @@ 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, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
116
+ constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
121
117
  toJSON(): ORPCErrorJSON<TCode, TData>;
122
- static fromJSON<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
123
- static isValidJSON(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
124
118
  }
125
119
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
126
120
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
127
121
  declare function toORPCError(error: unknown): ORPCError<any, any>;
122
+ declare function isORPCErrorStatus(status: number): boolean;
123
+ declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
124
+ declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
128
125
 
129
- type ConnectionStatus = 'reconnecting' | 'connected' | 'closed';
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, notifyImmediately?: boolean): () => void;
137
-
138
- type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
126
+ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
139
127
  error: null;
140
128
  data: TOutput;
141
129
  isDefined: false;
142
- } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false] & {
130
+ isSuccess: true;
131
+ } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
143
132
  error: Exclude<TError, ORPCError<any, any>>;
144
133
  data: undefined;
145
134
  isDefined: false;
146
- } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true] & {
135
+ isSuccess: false;
136
+ } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
147
137
  error: Extract<TError, ORPCError<any, any>>;
148
138
  data: undefined;
149
139
  isDefined: true;
140
+ isSuccess: false;
150
141
  };
151
- declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
142
+ /**
143
+ * Works like try/catch, but can infer error types.
144
+ *
145
+ * @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
146
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
147
+ */
148
+ declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
149
+ declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
150
+
151
+ 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>> : {
152
+ [K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
153
+ };
154
+ /**
155
+ * Create a safe client that automatically wraps all procedure calls with the `safe` util.
156
+ *
157
+ * @example
158
+ * ```ts
159
+ * const safeClient = createSafeClient(client)
160
+ * const { error, data, isDefined } = await safeClient.doSomething({ id: '123' })
161
+ * ```
162
+ *
163
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling#using-createsafeclient Safe Client Docs}
164
+ */
165
+ declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
166
+
167
+ /**
168
+ * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
169
+ * based on the request path, input, and context.
170
+ *
171
+ * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
172
+ */
173
+ declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
174
+ private readonly linkResolver;
175
+ constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
176
+ call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
177
+ }
178
+
179
+ declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
180
+ value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
181
+ error: (error: unknown) => Promise<unknown>;
182
+ }): AsyncIteratorClass<TMap, TMap, TNext>;
152
183
 
153
- export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptionsOut, ClientPromiseResult, type CommonORPCErrorCode, type ConnectionStatus, DynamicLink, type EventIteratorState, InferClientContext, NestedClient, ORPCError, type ORPCErrorCode, type ORPCErrorJSON, type ORPCErrorOptions, type SafeResult, createORPCClient, type createORPCClientOptions, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, onEventIteratorStatusChange, registerEventIteratorState, safe, toORPCError, updateEventIteratorStatus };
184
+ export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
185
+ export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };
package/dist/index.d.ts CHANGED
@@ -1,25 +1,21 @@
1
- import { N as NestedClient, b as ClientLink, I as InferClientContext, C as ClientContext, a as ClientOptionsOut, c as ClientPromiseResult } from './shared/client.D_CzLDyB.js';
2
- export { g as Client, e as ClientOptions, f as ClientRest, E as EventIteratorReconnectOptions, d as createAutoRetryEventIterator, m as mapEventIterator } from './shared/client.D_CzLDyB.js';
3
- import { Promisable, MaybeOptionalOptions } 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.BOYsZIRq.js';
2
+ export { f as HTTPMethod, H as HTTPPath } from './shared/client.BOYsZIRq.js';
3
+ import { MaybeOptionalOptions, ThrowableError, 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';
4
5
  export { ErrorEvent } 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
- * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
16
- * based on the request path, input, and context.
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
17
  */
18
- declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
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,37 +113,73 @@ 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, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
116
+ constructor(code: TCode, ...rest: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
121
117
  toJSON(): ORPCErrorJSON<TCode, TData>;
122
- static fromJSON<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
123
- static isValidJSON(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
124
118
  }
125
119
  type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
126
120
  declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
127
121
  declare function toORPCError(error: unknown): ORPCError<any, any>;
122
+ declare function isORPCErrorStatus(status: number): boolean;
123
+ declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
124
+ declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
128
125
 
129
- type ConnectionStatus = 'reconnecting' | 'connected' | 'closed';
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, notifyImmediately?: boolean): () => void;
137
-
138
- type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
126
+ type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
139
127
  error: null;
140
128
  data: TOutput;
141
129
  isDefined: false;
142
- } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false] & {
130
+ isSuccess: true;
131
+ } | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
143
132
  error: Exclude<TError, ORPCError<any, any>>;
144
133
  data: undefined;
145
134
  isDefined: false;
146
- } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true] & {
135
+ isSuccess: false;
136
+ } | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
147
137
  error: Extract<TError, ORPCError<any, any>>;
148
138
  data: undefined;
149
139
  isDefined: true;
140
+ isSuccess: false;
150
141
  };
151
- declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
142
+ /**
143
+ * Works like try/catch, but can infer error types.
144
+ *
145
+ * @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
146
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
147
+ */
148
+ declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
149
+ declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
150
+
151
+ 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>> : {
152
+ [K in keyof T]: T[K] extends NestedClient<any> ? SafeClient<T[K]> : never;
153
+ };
154
+ /**
155
+ * Create a safe client that automatically wraps all procedure calls with the `safe` util.
156
+ *
157
+ * @example
158
+ * ```ts
159
+ * const safeClient = createSafeClient(client)
160
+ * const { error, data, isDefined } = await safeClient.doSomething({ id: '123' })
161
+ * ```
162
+ *
163
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling#using-createsafeclient Safe Client Docs}
164
+ */
165
+ declare function createSafeClient<T extends NestedClient<any>>(client: T): SafeClient<T>;
166
+
167
+ /**
168
+ * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
169
+ * based on the request path, input, and context.
170
+ *
171
+ * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
172
+ */
173
+ declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
174
+ private readonly linkResolver;
175
+ constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
176
+ call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
177
+ }
178
+
179
+ declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
180
+ value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
181
+ error: (error: unknown) => Promise<unknown>;
182
+ }): AsyncIteratorClass<TMap, TMap, TNext>;
152
183
 
153
- export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptionsOut, ClientPromiseResult, type CommonORPCErrorCode, type ConnectionStatus, DynamicLink, type EventIteratorState, InferClientContext, NestedClient, ORPCError, type ORPCErrorCode, type ORPCErrorJSON, type ORPCErrorOptions, type SafeResult, createORPCClient, type createORPCClientOptions, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, onEventIteratorStatusChange, registerEventIteratorState, safe, toORPCError, updateEventIteratorStatus };
184
+ export { COMMON_ORPC_ERROR_DEFS, Client, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, ClientRest, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, createSafeClient, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
185
+ export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeClient, SafeResult, createORPCClientOptions };
package/dist/index.mjs CHANGED
@@ -1,17 +1,42 @@
1
- import { i as isDefinedError } from './shared/client.Ly4zGQrc.mjs';
2
- export { C as COMMON_ORPC_ERROR_DEFS, O as ORPCError, c as createAutoRetryEventIterator, a as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, m as mapEventIterator, o as onEventIteratorStatusChange, r as registerEventIteratorState, t as toORPCError, u as updateEventIteratorStatus } from './shared/client.Ly4zGQrc.mjs';
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.txdq_i5V.mjs';
4
+ export { C as COMMON_ORPC_ERROR_DEFS, O as ORPCError, d as createORPCErrorFromJson, a as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, c as isORPCErrorJson, b as isORPCErrorStatus, m as mapEventIterator, t as toORPCError } from './shared/client.txdq_i5V.mjs';
3
5
  export { ErrorEvent } from '@orpc/standard-server';
4
- import '@orpc/shared';
5
6
 
6
- function createORPCClient(link, options) {
7
- const path = options?.path ?? [];
8
- const procedureClient = async (...[input, options2]) => {
9
- const optionsOut = {
10
- ...options2,
11
- context: options2?.context ?? {}
12
- // options.context can be undefined when all field is optional
13
- };
14
- return await link.call(path, input, optionsOut);
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
+
36
+ function createORPCClient(link, options = {}) {
37
+ const path = options.path ?? [];
38
+ const procedureClient = async (...[input, options2 = {}]) => {
39
+ return await link.call(path, input, resolveFriendlyClientOptions(options2));
15
40
  };
16
41
  const recursive = new Proxy(procedureClient, {
17
42
  get(target, key) {
@@ -24,7 +49,23 @@ function createORPCClient(link, options) {
24
49
  });
25
50
  }
26
51
  });
27
- return recursive;
52
+ return preventNativeAwait(recursive);
53
+ }
54
+
55
+ function createSafeClient(client) {
56
+ const proxy = new Proxy((...args) => safe(client(...args)), {
57
+ get(_, prop, receiver) {
58
+ const value = Reflect.get(client, prop, receiver);
59
+ if (typeof prop !== "string") {
60
+ return value;
61
+ }
62
+ if (!isTypescriptObject(value)) {
63
+ return value;
64
+ }
65
+ return createSafeClient(value);
66
+ }
67
+ });
68
+ return proxy;
28
69
  }
29
70
 
30
71
  class DynamicLink {
@@ -38,26 +79,4 @@ class DynamicLink {
38
79
  }
39
80
  }
40
81
 
41
- async function safe(promise) {
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 };
82
+ export { DynamicLink, createORPCClient, createSafeClient, isDefinedError, resolveFriendlyClientOptions, safe };