@orpc/client 0.0.0-next.ba53a01 → 0.0.0-next.bb51745

package/dist/adapters/standard/index.d.ts

@@ -1,169 +1,10 @@
-import { Value, Interceptor, Segment } from '@orpc/shared';
-import { StandardRequest, StandardLazyResponse, StandardHeaders } from '@orpc/standard-server';
-import { C as ClientContext, a as ClientOptionsOut, E as EventIteratorReconnectOptions, b as ClientLink } from '../../shared/client.D_CzLDyB.js';
+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.C0KbSWlC.js';
+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.7UM0t5o-.js';
+import { H as HTTPPath } from '../../shared/client.4TS_0JaO.js';
+import '@orpc/shared';
+import '@orpc/standard-server';
 
-interface StandardLinkCodec<T extends ClientContext> {
-    encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
-    decode(response: StandardLazyResponse, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<unknown>;
-}
-interface StandardLinkClient<T extends ClientContext> {
-    call(request: StandardRequest, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse>;
-}
+declare function toHttpPath(path: readonly string[]): HTTPPath;
+declare function getMalformedResponseErrorCode(status: number): string;
 
-declare class InvalidEventIteratorRetryResponse extends Error {
-}
-interface StandardLinkOptions<T extends ClientContext> {
-    /**
-     * Maximum number of retry attempts for event iterator errors before throwing.
-     *
-     * @default 5
-     */
-    eventIteratorMaxRetries?: Value<number, [
-        reconnectOptions: EventIteratorReconnectOptions,
-        options: ClientOptionsOut<T>,
-        path: readonly string[],
-        input: unknown
-    ]>;
-    /**
-     * Delay (in ms) before retrying an event iterator call.
-     *
-     * @default (o) => o.lastRetry ?? (1000 * 2 ** o.retryTimes)
-     */
-    eventIteratorRetryDelay?: Value<number, [
-        reconnectOptions: EventIteratorReconnectOptions,
-        options: ClientOptionsOut<T>,
-        path: readonly string[],
-        input: unknown
-    ]>;
-    /**
-     * Function to determine if an error is retryable.
-     *
-     * @default true
-     */
-    eventIteratorShouldRetry?: Value<boolean, [
-        reconnectOptions: EventIteratorReconnectOptions,
-        options: ClientOptionsOut<T>,
-        path: readonly string[],
-        input: unknown
-    ]>;
-    interceptors?: Interceptor<{
-        path: readonly string[];
-        input: unknown;
-        options: ClientOptionsOut<T>;
-    }, unknown, unknown>[];
-    clientInterceptors?: Interceptor<{
-        request: StandardRequest;
-    }, StandardLazyResponse, unknown>[];
-}
-declare class StandardLink<T extends ClientContext> implements ClientLink<T> {
-    #private;
-    readonly codec: StandardLinkCodec<T>;
-    readonly sender: StandardLinkClient<T>;
-    private readonly eventIteratorMaxRetries;
-    private readonly eventIteratorRetryDelay;
-    private readonly eventIteratorShouldRetry;
-    private readonly interceptors;
-    private readonly clientInterceptors;
-    constructor(codec: StandardLinkCodec<T>, sender: StandardLinkClient<T>, options: StandardLinkOptions<T>);
-    call(path: readonly string[], input: unknown, options: ClientOptionsOut<T>): Promise<unknown>;
-}
-
-declare const STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES: {
-    readonly BIGINT: 0;
-    readonly DATE: 1;
-    readonly NAN: 2;
-    readonly UNDEFINED: 3;
-    readonly URL: 4;
-    readonly REGEXP: 5;
-    readonly SET: 6;
-    readonly MAP: 7;
-};
-type StandardRPCJsonSerializedMetaItem = readonly [type: number, ...path: Segment[]];
-type StandardRPCJsonSerialized = [json: unknown, meta: StandardRPCJsonSerializedMetaItem[], maps: Segment[][], blobs: Blob[]];
-interface StandardRPCCustomJsonSerializer {
-    type: number;
-    condition(data: unknown): boolean;
-    serialize(data: any): unknown;
-    deserialize(serialized: any): unknown;
-}
-interface StandardRPCJsonSerializerOptions {
-    customJsonSerializers?: readonly StandardRPCCustomJsonSerializer[];
-}
-declare class StandardRPCJsonSerializer {
-    private readonly customSerializers;
-    constructor(options?: StandardRPCJsonSerializerOptions);
-    serialize(data: unknown, segments?: Segment[], meta?: StandardRPCJsonSerializedMetaItem[], maps?: Segment[][], blobs?: Blob[]): StandardRPCJsonSerialized;
-    deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[]): unknown;
-    deserialize(json: unknown, meta: readonly StandardRPCJsonSerializedMetaItem[], maps: readonly Segment[][], getBlob: (index: number) => Blob): unknown;
-}
-
-declare class StandardRPCSerializer {
-    #private;
-    private readonly jsonSerializer;
-    constructor(jsonSerializer: StandardRPCJsonSerializer);
-    serialize(data: unknown): unknown;
-    deserialize(data: unknown): unknown;
-}
-
-type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
-interface StandardRPCLinkCodecOptions<T extends ClientContext> {
-    /**
-     * Base url for all requests.
-     */
-    url: Value<string | URL, [
-        options: ClientOptionsOut<T>,
-        path: readonly string[],
-        input: unknown
-    ]>;
-    /**
-     * The maximum length of the URL.
-     *
-     * @default 2083
-     */
-    maxUrlLength?: Value<number, [
-        options: ClientOptionsOut<T>,
-        path: readonly string[],
-        input: unknown
-    ]>;
-    /**
-     * The method used to make the request.
-     *
-     * @default 'POST'
-     */
-    method?: Value<HTTPMethod, [
-        options: ClientOptionsOut<T>,
-        path: readonly string[],
-        input: unknown
-    ]>;
-    /**
-     * The method to use when the payload cannot safely pass to the server with method return from method function.
-     * GET is not allowed, it's very dangerous.
-     *
-     * @default 'POST'
-     */
-    fallbackMethod?: Exclude<HTTPMethod, 'GET'>;
-    /**
-     * Inject headers to the request.
-     */
-    headers?: Value<StandardHeaders, [
-        options: ClientOptionsOut<T>,
-        path: readonly string[],
-        input: unknown
-    ]>;
-}
-declare class StandardRPCLinkCodec<T extends ClientContext> implements StandardLinkCodec<T> {
-    private readonly serializer;
-    private readonly baseUrl;
-    private readonly maxUrlLength;
-    private readonly fallbackMethod;
-    private readonly expectedMethod;
-    private readonly headers;
-    constructor(serializer: StandardRPCSerializer, options: StandardRPCLinkCodecOptions<T>);
-    encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
-    decode(response: StandardLazyResponse): Promise<unknown>;
-}
-
-interface StandardRPCLinkOptions<T extends ClientContext> extends StandardLinkOptions<T>, StandardRPCLinkCodecOptions<T>, StandardRPCJsonSerializerOptions {
-}
-
-export { InvalidEventIteratorRetryResponse, STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, StandardLink, type StandardLinkClient, type StandardLinkCodec, type StandardLinkOptions, type StandardRPCCustomJsonSerializer, type StandardRPCJsonSerialized, type StandardRPCJsonSerializedMetaItem, StandardRPCJsonSerializer, type StandardRPCJsonSerializerOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions, type StandardRPCLinkOptions, StandardRPCSerializer };
+export { getMalformedResponseErrorCode, toHttpPath };

package/dist/adapters/standard/index.mjs

@@ -1,4 +1,4 @@
-export { I as InvalidEventIteratorRetryResponse, a as STANDARD_RPC_JSON_SERIALIZER_BUILT_IN_TYPES, S as StandardLink, b as StandardRPCJsonSerializer, c as StandardRPCLinkCodec, d as StandardRPCSerializer } from '../../shared/client.CPmBUYbj.mjs';
+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 } from '../../shared/client.CQCGVpTM.mjs';
 import '@orpc/shared';
-import '../../shared/client.XAn8cDTM.mjs';
 import '@orpc/standard-server';
+import '../../shared/client.BX0_8bnM.mjs';

package/dist/adapters/websocket/index.d.mts

@@ -0,0 +1,29 @@
+import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
+import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.mjs';
+import { f as StandardLinkClient } from '../../shared/client.BMoG_EdN.mjs';
+import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.BdD8cpjs.mjs';
+import '@orpc/shared';
+
+interface experimental_LinkWebsocketClientOptions {
+    websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
+}
+declare class experimental_LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
+    private readonly peer;
+    constructor(options: experimental_LinkWebsocketClientOptions);
+    call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
+}
+
+interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, experimental_LinkWebsocketClientOptions {
+}
+/**
+ * The RPC Link communicates with the server using the RPC protocol over WebSocket.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
+ * @see {@link https://orpc.unnoq.com/docs/adapters/websocket WebSocket Adapter Docs}
+ */
+declare class experimental_RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
+    constructor(options: experimental_RPCLinkOptions<T>);
+}
+
+export { experimental_LinkWebsocketClient, experimental_RPCLink };
+export type { experimental_LinkWebsocketClientOptions, experimental_RPCLinkOptions };

package/dist/adapters/websocket/index.d.ts

@@ -0,0 +1,29 @@
+import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
+import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.js';
+import { f as StandardLinkClient } from '../../shared/client.C0KbSWlC.js';
+import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.7UM0t5o-.js';
+import '@orpc/shared';
+
+interface experimental_LinkWebsocketClientOptions {
+    websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
+}
+declare class experimental_LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
+    private readonly peer;
+    constructor(options: experimental_LinkWebsocketClientOptions);
+    call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
+}
+
+interface experimental_RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'headers' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, experimental_LinkWebsocketClientOptions {
+}
+/**
+ * The RPC Link communicates with the server using the RPC protocol over WebSocket.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
+ * @see {@link https://orpc.unnoq.com/docs/adapters/websocket WebSocket Adapter Docs}
+ */
+declare class experimental_RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
+    constructor(options: experimental_RPCLinkOptions<T>);
+}
+
+export { experimental_LinkWebsocketClient, experimental_RPCLink };
+export type { experimental_LinkWebsocketClientOptions, experimental_RPCLinkOptions };

package/dist/adapters/websocket/index.mjs

@@ -0,0 +1,44 @@
+import { ClientPeer } from '@orpc/standard-server-peer';
+import '@orpc/shared';
+import { c as StandardRPCLink } from '../../shared/client.CQCGVpTM.mjs';
+import '@orpc/standard-server';
+import '../../shared/client.BX0_8bnM.mjs';
+
+class experimental_LinkWebsocketClient {
+  peer;
+  constructor(options) {
+    const untilOpen = new Promise((resolve) => {
+      if (options.websocket.readyState === 0) {
+        options.websocket.addEventListener("open", () => {
+          resolve();
+        }, { once: true });
+      } else {
+        resolve();
+      }
+    });
+    this.peer = new ClientPeer(async (message) => {
+      await untilOpen;
+      return options.websocket.send(message);
+    });
+    options.websocket.addEventListener("message", async (event) => {
+      const message = event.data instanceof Blob ? await event.data.arrayBuffer() : event.data;
+      this.peer.message(message);
+    });
+    options.websocket.addEventListener("close", () => {
+      this.peer.close();
+    });
+  }
+  async call(request, _options, _path, _input) {
+    const response = await this.peer.request(request);
+    return { ...response, body: () => Promise.resolve(response.body) };
+  }
+}
+
+class experimental_RPCLink extends StandardRPCLink {
+  constructor(options) {
+    const linkClient = new experimental_LinkWebsocketClient(options);
+    super(linkClient, { ...options, url: "orpc:/" });
+  }
+}
+
+export { experimental_LinkWebsocketClient, experimental_RPCLink };

package/dist/index.d.mts

@@ -1,7 +1,7 @@
-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';
-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';
-import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
-export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
+import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.4TS_0JaO.mjs';
+export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.4TS_0JaO.mjs';
+import { Promisable, MaybeOptionalOptions, AsyncIteratorClass, ThrowableError } from '@orpc/shared';
+export { EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
 export { ErrorEvent } from '@orpc/standard-server';
 
 interface createORPCClientOptions {
@@ -10,16 +10,23 @@ interface createORPCClientOptions {
      */
     path?: string[];
 }
+/**
+ * Create a oRPC client-side client from a link.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/client/client-side Client-side Client Docs}
+ */
 declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
 
 /**
  * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
  * based on the request path, input, and context.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
  */
 declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
     private readonly linkResolver;
-    constructor(linkResolver: (options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
-    call(path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>): Promise<unknown>;
+    constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
+    call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
 }
 
 declare const COMMON_ORPC_ERROR_DEFS: {
@@ -120,37 +127,43 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
     readonly data: TData;
     constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
     toJSON(): ORPCErrorJSON<TCode, TData>;
-    static fromJSON<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
-    static isValidJSON(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
 }
 type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
 declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
 declare function toORPCError(error: unknown): ORPCError<any, any>;
+declare function isORPCErrorStatus(status: number): boolean;
+declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
+declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
 
-type ConnectionStatus = 'reconnecting' | 'connected' | 'closed';
-interface EventIteratorState {
-    status: ConnectionStatus;
-    listeners: Array<(newStatus: ConnectionStatus) => void>;
-}
-declare function registerEventIteratorState(iterator: AsyncIteratorObject<unknown, unknown, void>, state: EventIteratorState): void;
-declare function updateEventIteratorStatus(state: EventIteratorState, status: ConnectionStatus): void;
-declare function onEventIteratorStatusChange(iterator: AsyncIteratorObject<unknown, unknown, void>, callback: (status: ConnectionStatus) => void, options?: {
-    notifyImmediately?: boolean;
-}): () => void;
+declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
+    value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
+    error: (error: unknown) => Promise<unknown>;
+}): AsyncIteratorClass<TMap, TMap, TNext>;
 
-type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
+type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
     error: null;
     data: TOutput;
     isDefined: false;
-} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false] & {
+    isSuccess: true;
+} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
     error: Exclude<TError, ORPCError<any, any>>;
     data: undefined;
     isDefined: false;
-} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true] & {
+    isSuccess: false;
+} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
     error: Extract<TError, ORPCError<any, any>>;
     data: undefined;
     isDefined: true;
+    isSuccess: false;
 };
-declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
+/**
+ * Works like try/catch, but can infer error types.
+ *
+ * @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
+ */
+declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
+declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
 
-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 };
+export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
+export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeResult, createORPCClientOptions };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-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';
-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';
-import { Promisable, MaybeOptionalOptions } from '@orpc/shared';
-export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
+import { N as NestedClient, C as ClientLink, I as InferClientContext, a as ClientContext, b as ClientOptions, c as ClientPromiseResult, F as FriendlyClientOptions } from './shared/client.4TS_0JaO.js';
+export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.4TS_0JaO.js';
+import { Promisable, MaybeOptionalOptions, AsyncIteratorClass, ThrowableError } from '@orpc/shared';
+export { EventPublisher, EventPublisherOptions, EventPublisherSubscribeIteratorOptions, Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
 export { ErrorEvent } from '@orpc/standard-server';
 
 interface createORPCClientOptions {
@@ -10,16 +10,23 @@ interface createORPCClientOptions {
      */
     path?: string[];
 }
+/**
+ * Create a oRPC client-side client from a link.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/client/client-side Client-side Client Docs}
+ */
 declare function createORPCClient<T extends NestedClient<any>>(link: ClientLink<InferClientContext<T>>, options?: createORPCClientOptions): T;
 
 /**
  * DynamicLink provides a way to dynamically resolve and delegate calls to other ClientLinks
  * based on the request path, input, and context.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/client/dynamic-link Dynamic Link Docs}
  */
 declare class DynamicLink<TClientContext extends ClientContext> implements ClientLink<TClientContext> {
     private readonly linkResolver;
-    constructor(linkResolver: (options: ClientOptionsOut<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
-    call(path: readonly string[], input: unknown, options: ClientOptionsOut<TClientContext>): Promise<unknown>;
+    constructor(linkResolver: (options: ClientOptions<TClientContext>, path: readonly string[], input: unknown) => Promisable<ClientLink<TClientContext>>);
+    call(path: readonly string[], input: unknown, options: ClientOptions<TClientContext>): Promise<unknown>;
 }
 
 declare const COMMON_ORPC_ERROR_DEFS: {
@@ -120,37 +127,43 @@ declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
     readonly data: TData;
     constructor(code: TCode, ...[options]: MaybeOptionalOptions<ORPCErrorOptions<TData>>);
     toJSON(): ORPCErrorJSON<TCode, TData>;
-    static fromJSON<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
-    static isValidJSON(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
 }
 type ORPCErrorJSON<TCode extends string, TData> = Pick<ORPCError<TCode, TData>, 'defined' | 'code' | 'status' | 'message' | 'data'>;
 declare function isDefinedError<T>(error: T): error is Extract<T, ORPCError<any, any>>;
 declare function toORPCError(error: unknown): ORPCError<any, any>;
+declare function isORPCErrorStatus(status: number): boolean;
+declare function isORPCErrorJson(json: unknown): json is ORPCErrorJSON<ORPCErrorCode, unknown>;
+declare function createORPCErrorFromJson<TCode extends ORPCErrorCode, TData>(json: ORPCErrorJSON<TCode, TData>, options?: ErrorOptions): ORPCError<TCode, TData>;
 
-type ConnectionStatus = 'reconnecting' | 'connected' | 'closed';
-interface EventIteratorState {
-    status: ConnectionStatus;
-    listeners: Array<(newStatus: ConnectionStatus) => void>;
-}
-declare function registerEventIteratorState(iterator: AsyncIteratorObject<unknown, unknown, void>, state: EventIteratorState): void;
-declare function updateEventIteratorStatus(state: EventIteratorState, status: ConnectionStatus): void;
-declare function onEventIteratorStatusChange(iterator: AsyncIteratorObject<unknown, unknown, void>, callback: (status: ConnectionStatus) => void, options?: {
-    notifyImmediately?: boolean;
-}): () => void;
+declare function mapEventIterator<TYield, TReturn, TNext, TMap = TYield | TReturn>(iterator: AsyncIterator<TYield, TReturn, TNext>, maps: {
+    value: (value: NoInfer<TYield | TReturn>, done: boolean | undefined) => Promise<TMap>;
+    error: (error: unknown) => Promise<unknown>;
+}): AsyncIteratorClass<TMap, TMap, TNext>;
 
-type SafeResult<TOutput, TError extends Error> = [error: null, data: TOutput, isDefined: false] & {
+type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
     error: null;
     data: TOutput;
     isDefined: false;
-} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false] & {
+    isSuccess: true;
+} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, isSuccess: false] & {
     error: Exclude<TError, ORPCError<any, any>>;
     data: undefined;
     isDefined: false;
-} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true] & {
+    isSuccess: false;
+} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
     error: Extract<TError, ORPCError<any, any>>;
     data: undefined;
     isDefined: true;
+    isSuccess: false;
 };
-declare function safe<TOutput, TError extends Error>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
+/**
+ * Works like try/catch, but can infer error types.
+ *
+ * @info support both tuple `[error, data, isDefined, isSuccess]` and object `{ error, data, isDefined, isSuccess }` styles.
+ * @see {@link https://orpc.unnoq.com/docs/client/error-handling Client Error Handling Docs}
+ */
+declare function safe<TOutput, TError = ThrowableError>(promise: ClientPromiseResult<TOutput, TError>): Promise<SafeResult<TOutput, TError>>;
+declare function resolveFriendlyClientOptions<T extends ClientContext>(options: FriendlyClientOptions<T>): ClientOptions<T>;
 
-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 };
+export { COMMON_ORPC_ERROR_DEFS, ClientContext, ClientLink, ClientOptions, ClientPromiseResult, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, createORPCClient, createORPCErrorFromJson, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorJson, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
+export type { CommonORPCErrorCode, ORPCErrorCode, ORPCErrorJSON, ORPCErrorOptions, SafeResult, createORPCClientOptions };

package/dist/index.mjs

@@ -1,17 +1,41 @@
-import { i as isDefinedError } from './shared/client.XAn8cDTM.mjs';
-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.XAn8cDTM.mjs';
-export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
+import { i as isDefinedError } from './shared/client.BX0_8bnM.mjs';
+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.BX0_8bnM.mjs';
+export { EventPublisher, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
 export { ErrorEvent } from '@orpc/standard-server';
 
+async function safe(promise) {
+  try {
+    const output = await promise;
+    return Object.assign(
+      [null, output, false, true],
+      { error: null, data: output, isDefined: false, isSuccess: true }
+    );
+  } catch (e) {
+    const error = e;
+    if (isDefinedError(error)) {
+      return Object.assign(
+        [error, void 0, true, false],
+        { error, data: void 0, isDefined: true, isSuccess: false }
+      );
+    }
+    return Object.assign(
+      [error, void 0, false, false],
+      { error, data: void 0, isDefined: false, isSuccess: false }
+    );
+  }
+}
+function resolveFriendlyClientOptions(options) {
+  return {
+    ...options,
+    context: options.context ?? {}
+    // Context only optional if all fields are optional
+  };
+}
+
 function createORPCClient(link, options) {
   const path = options?.path ?? [];
-  const procedureClient = async (...[input, options2]) => {
-    const optionsOut = {
-      ...options2,
-      context: options2?.context ?? {}
-      // options.context can be undefined when all field is optional
-    };
-    return await link.call(path, input, optionsOut);
+  const procedureClient = async (...[input, options2 = {}]) => {
+    return await link.call(path, input, resolveFriendlyClientOptions(options2));
   };
   const recursive = new Proxy(procedureClient, {
     get(target, key) {
@@ -38,26 +62,4 @@ class DynamicLink {
   }
 }
 
-async function safe(promise) {
-  try {
-    const output = await promise;
-    return Object.assign(
-      [null, output, false],
-      { error: null, data: output, isDefined: false }
-    );
-  } catch (e) {
-    const error = e;
-    if (isDefinedError(error)) {
-      return Object.assign(
-        [error, void 0, true],
-        { error, data: void 0, isDefined: true }
-      );
-    }
-    return Object.assign(
-      [error, void 0, false],
-      { error, data: void 0, isDefined: false }
-    );
-  }
-}
-
-export { DynamicLink, createORPCClient, isDefinedError, safe };
+export { DynamicLink, createORPCClient, isDefinedError, resolveFriendlyClientOptions, safe };