@orpc/client 0.0.0-next.f47352c → 0.0.0-next.f4ed9ab

package/README.md

@@ -21,28 +21,24 @@
 
 <h3 align="center">Typesafe APIs Made Simple 🪄</h3>
 
-**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards, ensuring a smooth and enjoyable developer experience.
+**oRPC is a powerful combination of RPC and OpenAPI**, makes it easy to build APIs that are end-to-end type-safe and adhere to OpenAPI standards
 
 ---
 
 ## Highlights
 
-- **End-to-End Type Safety 🔒**: Ensure complete type safety from inputs to outputs and errors, bridging server and client seamlessly.
-- **First-Class OpenAPI 📄**: Adheres to the OpenAPI standard out of the box, ensuring seamless integration and comprehensive API documentation.
-- **Contract-First Development 📜**: (Optional) Define your API contract upfront and implement it with confidence.
-- **Exceptional Developer Experience ✨**: Enjoy a streamlined workflow with robust typing and clear, in-code documentation.
-- **Multi-Runtime Support 🌍**: Run your code seamlessly on Cloudflare, Deno, Bun, Node.js, and more.
-- **Framework Integrations 🧩**: Supports Tanstack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
-- **Server Actions ⚡️**: Fully compatible with React Server Actions on Next.js, TanStack Start, and more.
-- **Standard Schema Support 🗂️**: Effortlessly work with Zod, Valibot, ArkType, and others right out of the box.
-- **Fast & Lightweight 💨**: Built on native APIs across all runtimes – optimized for speed and efficiency.
-- **Native Types 📦**: Enjoy built-in support for Date, File, Blob, BigInt, URL and more with no extra setup.
-- **Lazy Router ⏱️**: Improve cold start times with our lazy routing feature.
-- **SSE & Streaming 📡**: Provides SSE and streaming features – perfect for real-time notifications and AI-powered streaming responses.
-- **Reusability 🔄**: Write once and reuse your code across multiple purposes effortlessly.
-- **Extendability 🔌**: Easily enhance oRPC with plugins, middleware, and interceptors.
-- **Reliability 🛡️**: Well-tested, fully TypeScript, production-ready, and MIT licensed for peace of mind.
-- **Simplicity 💡**: Enjoy straightforward, clean code with no hidden magic.
+- **🔗 End-to-End Type Safety**: Ensure type-safe inputs, outputs, and errors from client to server.
+- **📘 First-Class OpenAPI**: Built-in support that fully adheres to the OpenAPI standard.
+- **📝 Contract-First Development**: Optionally define your API contract before implementation.
+- **⚙️ Framework Integrations**: Seamlessly integrate with TanStack Query (React, Vue, Solid, Svelte), Pinia Colada, and more.
+- **🚀 Server Actions**: Fully compatible with React Server Actions on Next.js, TanStack Start, and other platforms.
+- **🔠 Standard Schema Support**: Works out of the box with Zod, Valibot, ArkType, and other schema validators.
+- **🗃️ Native Types**: Supports native types like Date, File, Blob, BigInt, URL, and more.
+- **⏱️ Lazy Router**: Enhance cold start times with our lazy routing feature.
+- **📡 SSE & Streaming**: Enjoy full type-safe support for SSE and streaming.
+- **🌍 Multi-Runtime Support**: Fast and lightweight on Cloudflare, Deno, Bun, Node.js, and beyond.
+- **🔌 Extendability**: Easily extend functionality with plugins, middleware, and interceptors.
+- **🛡️ Reliability**: Well-tested, TypeScript-based, production-ready, and MIT licensed.
 
 ## Documentation
 
@@ -53,6 +49,7 @@ You can find the full documentation [here](https://orpc.unnoq.com).
 - [@orpc/contract](https://www.npmjs.com/package/@orpc/contract): Build your API contract.
 - [@orpc/server](https://www.npmjs.com/package/@orpc/server): Build your API or implement API contract.
 - [@orpc/client](https://www.npmjs.com/package/@orpc/client): Consume your API on the client with type-safety.
+- [@orpc/nest](https://www.npmjs.com/package/@orpc/nest): Deeply integrate oRPC with NestJS.
 - [@orpc/react](https://www.npmjs.com/package/@orpc/react): Utilities for integrating oRPC with React and React Server Actions.
 - [@orpc/react-query](https://www.npmjs.com/package/@orpc/react-query): Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview).
 - [@orpc/vue-query](https://www.npmjs.com/package/@orpc/vue-query): Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview).

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

@@ -1,8 +1,8 @@
 import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
 import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
-import { a as ClientContext, b as ClientOptions } from '../../shared/client.C0lT7w02.mjs';
-import { d as StandardLinkClient, b as StandardLink } from '../../shared/client.5813Ufvs.mjs';
-import { f as StandardRPCLinkOptions } from '../../shared/client.Bt94sjrK.mjs';
+import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.mjs';
+import { f as StandardLinkClient } from '../../shared/client.ds1abV85.mjs';
+import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.ClwIM_ku.mjs';
 import '@orpc/shared';
 
 interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
@@ -19,8 +19,15 @@ declare class LinkFetchClient<T extends ClientContext> implements StandardLinkCl
 
 interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
 }
-declare class RPCLink<T extends ClientContext> extends StandardLink<T> {
+/**
+ * The RPC Link communicates with the server using the RPC protocol.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
+ * @see {@link https://orpc.unnoq.com/docs/advanced/rpc-protocol RPC Protocol Docs}
+ */
+declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
     constructor(options: RPCLinkOptions<T>);
 }
 
-export { LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
+export { LinkFetchClient, RPCLink };
+export type { LinkFetchClientOptions, RPCLinkOptions };

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

@@ -1,8 +1,8 @@
 import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
 import { ToFetchRequestOptions } from '@orpc/standard-server-fetch';
-import { a as ClientContext, b as ClientOptions } from '../../shared/client.C0lT7w02.js';
-import { d as StandardLinkClient, b as StandardLink } from '../../shared/client.grRbC25r.js';
-import { f as StandardRPCLinkOptions } from '../../shared/client.D-jrSuDb.js';
+import { a as ClientContext, b as ClientOptions } from '../../shared/client.4TS_0JaO.js';
+import { f as StandardLinkClient } from '../../shared/client.7ZYxJok_.js';
+import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.B2432-Lu.js';
 import '@orpc/shared';
 
 interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
@@ -19,8 +19,15 @@ declare class LinkFetchClient<T extends ClientContext> implements StandardLinkCl
 
 interface RPCLinkOptions<T extends ClientContext> extends StandardRPCLinkOptions<T>, LinkFetchClientOptions<T> {
 }
-declare class RPCLink<T extends ClientContext> extends StandardLink<T> {
+/**
+ * The RPC Link communicates with the server using the RPC protocol.
+ *
+ * @see {@link https://orpc.unnoq.com/docs/client/rpc-link RPC Link Docs}
+ * @see {@link https://orpc.unnoq.com/docs/advanced/rpc-protocol RPC Protocol Docs}
+ */
+declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
     constructor(options: RPCLinkOptions<T>);
 }
 
-export { LinkFetchClient, type LinkFetchClientOptions, RPCLink, type RPCLinkOptions };
+export { LinkFetchClient, RPCLink };
+export type { LinkFetchClientOptions, RPCLinkOptions };

package/dist/adapters/fetch/index.mjs

@@ -1,8 +1,8 @@
 import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch';
-import { S as StandardLink, b as StandardRPCJsonSerializer, c as StandardRPCLinkCodec, d as StandardRPCSerializer } from '../../shared/client.DhAxdT4W.mjs';
 import '@orpc/shared';
+import { c as StandardRPCLink } from '../../shared/client.DpICn1BD.mjs';
 import '@orpc/standard-server';
-import '../../shared/client.jKEwIsRd.mjs';
+import '../../shared/client.CRWEpqLB.mjs';
 
 class LinkFetchClient {
   fetch;
@@ -19,13 +19,10 @@ class LinkFetchClient {
   }
 }
 
-class RPCLink extends StandardLink {
+class RPCLink extends StandardRPCLink {
   constructor(options) {
-    const jsonSerializer = new StandardRPCJsonSerializer(options);
-    const serializer = new StandardRPCSerializer(jsonSerializer);
-    const linkCodec = new StandardRPCLinkCodec(serializer, options);
     const linkClient = new LinkFetchClient(options);
-    super(linkCodec, linkClient, options);
+    super(linkClient, options);
   }
 }
 

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

@@ -1,6 +1,6 @@
-export { I as InvalidEventIteratorRetryResponse, b as StandardLink, d as StandardLinkClient, c as StandardLinkCodec, a as StandardLinkOptions, S as StandardLinkPlugin } from '../../shared/client.5813Ufvs.mjs';
-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, h as StandardRPCLinkCodec, g as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, i as StandardRPCSerializer } from '../../shared/client.Bt94sjrK.mjs';
-import { H as HTTPPath } from '../../shared/client.C0lT7w02.mjs';
+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.ds1abV85.mjs';
+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.ClwIM_ku.mjs';
+import { H as HTTPPath } from '../../shared/client.4TS_0JaO.mjs';
 import '@orpc/shared';
 import '@orpc/standard-server';
 

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

@@ -1,6 +1,6 @@
-export { I as InvalidEventIteratorRetryResponse, b as StandardLink, d as StandardLinkClient, c as StandardLinkCodec, a as StandardLinkOptions, S as StandardLinkPlugin } from '../../shared/client.grRbC25r.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, h as StandardRPCLinkCodec, g as StandardRPCLinkCodecOptions, f as StandardRPCLinkOptions, i as StandardRPCSerializer } from '../../shared/client.D-jrSuDb.js';
-import { H as HTTPPath } from '../../shared/client.C0lT7w02.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.7ZYxJok_.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.B2432-Lu.js';
+import { H as HTTPPath } from '../../shared/client.4TS_0JaO.js';
 import '@orpc/shared';
 import '@orpc/standard-server';
 

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, g as getMalformedResponseErrorCode, t as toHttpPath } from '../../shared/client.DhAxdT4W.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.DpICn1BD.mjs';
 import '@orpc/shared';
 import '@orpc/standard-server';
-import '../../shared/client.jKEwIsRd.mjs';
+import '../../shared/client.CRWEpqLB.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.ds1abV85.mjs';
+import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.ClwIM_ku.mjs';
+import '@orpc/shared';
+
+interface experimental_LinkWebsocketClientOptions {
+    websocket: Pick<WebSocket, 'addEventListener' | 'send'>;
+}
+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.7ZYxJok_.js';
+import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.B2432-Lu.js';
+import '@orpc/shared';
+
+interface experimental_LinkWebsocketClientOptions {
+    websocket: Pick<WebSocket, 'addEventListener' | 'send'>;
+}
+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,31 @@
+import { ClientPeer } from '@orpc/standard-server-peer';
+import '@orpc/shared';
+import { c as StandardRPCLink } from '../../shared/client.DpICn1BD.mjs';
+import '@orpc/standard-server';
+import '../../shared/client.CRWEpqLB.mjs';
+
+class experimental_LinkWebsocketClient {
+  peer;
+  constructor(options) {
+    this.peer = new ClientPeer(options.websocket.send.bind(options.websocket));
+    options.websocket.addEventListener("message", (event) => {
+      this.peer.message(event.data);
+    });
+    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,5 +1,5 @@
-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.C0lT7w02.mjs';
-export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.C0lT7w02.mjs';
+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, ThrowableError } from '@orpc/shared';
 export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
 export { ErrorEvent } from '@orpc/standard-server';
@@ -10,11 +10,18 @@ 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;
@@ -120,36 +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>;
 
 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>;
 }): AsyncGenerator<TMap, TMap, TNext>;
 
-type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, success: true] & {
+type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
     error: null;
     data: TOutput;
     isDefined: false;
-    success: true;
-} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, success: 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;
-    success: false;
-} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, success: false] & {
+    isSuccess: false;
+} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
     error: Extract<TError, ORPCError<any, any>>;
     data: undefined;
     isDefined: true;
-    success: false;
+    isSuccess: false;
 };
+/**
+ * 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, ClientOptions, ClientPromiseResult, type CommonORPCErrorCode, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, type ORPCErrorCode, type ORPCErrorJSON, type ORPCErrorOptions, type SafeResult, createORPCClient, type createORPCClientOptions, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
+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,5 +1,5 @@
-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.C0lT7w02.js';
-export { f as Client, e as ClientRest, d as HTTPMethod, H as HTTPPath } from './shared/client.C0lT7w02.js';
+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, ThrowableError } from '@orpc/shared';
 export { Registry, ThrowableError, onError, onFinish, onStart, onSuccess } from '@orpc/shared';
 export { ErrorEvent } from '@orpc/standard-server';
@@ -10,11 +10,18 @@ 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;
@@ -120,36 +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>;
 
 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>;
 }): AsyncGenerator<TMap, TMap, TNext>;
 
-type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, success: true] & {
+type SafeResult<TOutput, TError> = [error: null, data: TOutput, isDefined: false, isSuccess: true] & {
     error: null;
     data: TOutput;
     isDefined: false;
-    success: true;
-} | [error: Exclude<TError, ORPCError<any, any>>, data: undefined, isDefined: false, success: 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;
-    success: false;
-} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, success: false] & {
+    isSuccess: false;
+} | [error: Extract<TError, ORPCError<any, any>>, data: undefined, isDefined: true, isSuccess: false] & {
     error: Extract<TError, ORPCError<any, any>>;
     data: undefined;
     isDefined: true;
-    success: false;
+    isSuccess: false;
 };
+/**
+ * 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, ClientOptions, ClientPromiseResult, type CommonORPCErrorCode, DynamicLink, FriendlyClientOptions, InferClientContext, NestedClient, ORPCError, type ORPCErrorCode, type ORPCErrorJSON, type ORPCErrorOptions, type SafeResult, createORPCClient, type createORPCClientOptions, fallbackORPCErrorMessage, fallbackORPCErrorStatus, isDefinedError, isORPCErrorStatus, mapEventIterator, resolveFriendlyClientOptions, safe, toORPCError };
+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,5 +1,5 @@
-import { i as isDefinedError } from './shared/client.jKEwIsRd.mjs';
-export { C as COMMON_ORPC_ERROR_DEFS, O as ORPCError, a as fallbackORPCErrorMessage, f as fallbackORPCErrorStatus, b as isORPCErrorStatus, m as mapEventIterator, t as toORPCError } from './shared/client.jKEwIsRd.mjs';
+import { i as isDefinedError } from './shared/client.CRWEpqLB.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.CRWEpqLB.mjs';
 export { onError, onFinish, onStart, onSuccess } from '@orpc/shared';
 export { ErrorEvent } from '@orpc/standard-server';
 
@@ -8,19 +8,19 @@ async function safe(promise) {
     const output = await promise;
     return Object.assign(
       [null, output, false, true],
-      { error: null, data: output, isDefined: false, success: 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, success: false }
+        { error, data: void 0, isDefined: true, isSuccess: false }
       );
     }
     return Object.assign(
       [error, void 0, false, false],
-      { error, data: void 0, isDefined: false, success: false }
+      { error, data: void 0, isDefined: false, isSuccess: false }
     );
   }
 }