@orpc/client 0.0.0-next.999d654 → 0.0.0-next.99d5d75

package/dist/adapters/message-port/index.mjs

@@ -0,0 +1,87 @@
+import { value, isObject } from '@orpc/shared';
+import { experimental_ClientPeerWithoutCodec, serializeRequestMessage, encodeRequestMessage, deserializeResponseMessage, decodeResponseMessage } from '@orpc/standard-server-peer';
+import { c as StandardRPCLink } from '../../shared/client.C6Bgyn6F.mjs';
+import '@orpc/standard-server';
+import '../../shared/client.CPTihQgC.mjs';
+import '@orpc/standard-server-fetch';
+import '../../shared/client.BLtwTQUg.mjs';
+
+function postMessagePortMessage(port, data, transfer) {
+  if (transfer) {
+    port.postMessage(data, transfer);
+  } else {
+    port.postMessage(data);
+  }
+}
+function onMessagePortMessage(port, callback) {
+  if ("addEventListener" in port) {
+    port.addEventListener("message", (event) => {
+      callback(event.data);
+    });
+  } else if ("on" in port) {
+    port.on("message", (event) => {
+      callback(event?.data);
+    });
+  } else if ("onMessage" in port) {
+    port.onMessage.addListener((data) => {
+      callback(data);
+    });
+  } else {
+    throw new Error("Cannot find a addEventListener/on/onMessage method on the port");
+  }
+}
+function onMessagePortClose(port, callback) {
+  if ("addEventListener" in port) {
+    port.addEventListener("close", async () => {
+      callback();
+    });
+  } else if ("on" in port) {
+    port.on("close", async () => {
+      callback();
+    });
+  } else if ("onDisconnect" in port) {
+    port.onDisconnect.addListener(() => {
+      callback();
+    });
+  } else {
+    throw new Error("Cannot find a addEventListener/on/onDisconnect method on the port");
+  }
+}
+
+class LinkMessagePortClient {
+  peer;
+  constructor(options) {
+    this.peer = new experimental_ClientPeerWithoutCodec(async (message) => {
+      const [id, type, payload] = message;
+      const transfer = await value(options.experimental_transfer, message, options.port);
+      if (transfer) {
+        postMessagePortMessage(options.port, serializeRequestMessage(id, type, payload), transfer);
+      } else {
+        postMessagePortMessage(options.port, await encodeRequestMessage(id, type, payload));
+      }
+    });
+    onMessagePortMessage(options.port, async (message) => {
+      if (isObject(message)) {
+        await this.peer.message(deserializeResponseMessage(message));
+      } else {
+        await this.peer.message(await decodeResponseMessage(message));
+      }
+    });
+    onMessagePortClose(options.port, () => {
+      this.peer.close();
+    });
+  }
+  async call(request, _options, _path, _input) {
+    const response = await this.peer.request(request);
+    return { ...response, body: () => Promise.resolve(response.body) };
+  }
+}
+
+class RPCLink extends StandardRPCLink {
+  constructor(options) {
+    const linkClient = new LinkMessagePortClient(options);
+    super(linkClient, { ...options, url: "http://orpc" });
+  }
+}
+
+export { LinkMessagePortClient, RPCLink, onMessagePortClose, onMessagePortMessage, postMessagePortMessage };

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

@@ -1,148 +1,11 @@
-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.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.CpCa3si8.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.BFAVy68H.mjs';
+import { StandardHeaders } from '@orpc/standard-server';
+import { H as HTTPPath } from '../../shared/client.i2uoJbEp.mjs';
+import '@orpc/shared';
 
-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 toStandardHeaders(headers: Headers | StandardHeaders): StandardHeaders;
+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>;
-}
-
-type RPCJsonSerializedMeta = [
-    0 | 1 | 2 | 3 | 4 | 5 | 6 | 7,
-    Segment[]
-][];
-type RPCJsonSerialized = [json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], blobs: Blob[]];
-declare class RPCJsonSerializer {
-    serialize(data: unknown, segments?: Segment[], meta?: RPCJsonSerializedMeta, maps?: Segment[][], blobs?: Blob[]): RPCJsonSerialized;
-    deserialize(json: unknown, meta: RPCJsonSerializedMeta): unknown;
-    deserialize(json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], getBlob: (index: number) => Blob): unknown;
-}
-
-declare class RPCSerializer {
-    #private;
-    private readonly jsonSerializer;
-    constructor(jsonSerializer?: RPCJsonSerializer);
-    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: RPCSerializer, options: StandardRPCLinkCodecOptions<T>);
-    encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
-    decode(response: StandardLazyResponse): Promise<unknown>;
-}
-
-export { InvalidEventIteratorRetryResponse, type RPCJsonSerialized, type RPCJsonSerializedMeta, RPCJsonSerializer, RPCSerializer, StandardLink, type StandardLinkClient, type StandardLinkCodec, type StandardLinkOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions };
+export { getMalformedResponseErrorCode, toHttpPath, toStandardHeaders };

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

@@ -1,148 +1,11 @@
-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.2jUAqzYU.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.B3pNRBih.js';
+import { StandardHeaders } from '@orpc/standard-server';
+import { H as HTTPPath } from '../../shared/client.i2uoJbEp.js';
+import '@orpc/shared';
 
-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 toStandardHeaders(headers: Headers | StandardHeaders): StandardHeaders;
+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>;
-}
-
-type RPCJsonSerializedMeta = [
-    0 | 1 | 2 | 3 | 4 | 5 | 6 | 7,
-    Segment[]
-][];
-type RPCJsonSerialized = [json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], blobs: Blob[]];
-declare class RPCJsonSerializer {
-    serialize(data: unknown, segments?: Segment[], meta?: RPCJsonSerializedMeta, maps?: Segment[][], blobs?: Blob[]): RPCJsonSerialized;
-    deserialize(json: unknown, meta: RPCJsonSerializedMeta): unknown;
-    deserialize(json: unknown, meta: RPCJsonSerializedMeta, maps: Segment[][], getBlob: (index: number) => Blob): unknown;
-}
-
-declare class RPCSerializer {
-    #private;
-    private readonly jsonSerializer;
-    constructor(jsonSerializer?: RPCJsonSerializer);
-    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: RPCSerializer, options: StandardRPCLinkCodecOptions<T>);
-    encode(path: readonly string[], input: unknown, options: ClientOptionsOut<any>): Promise<StandardRequest>;
-    decode(response: StandardLazyResponse): Promise<unknown>;
-}
-
-export { InvalidEventIteratorRetryResponse, type RPCJsonSerialized, type RPCJsonSerializedMeta, RPCJsonSerializer, RPCSerializer, StandardLink, type StandardLinkClient, type StandardLinkCodec, type StandardLinkOptions, StandardRPCLinkCodec, type StandardRPCLinkCodecOptions };
+export { getMalformedResponseErrorCode, toHttpPath, toStandardHeaders };

package/dist/adapters/standard/index.mjs

@@ -1,4 +1,6 @@
-export { I as InvalidEventIteratorRetryResponse, R as RPCJsonSerializer, b as RPCSerializer, S as StandardLink, a as StandardRPCLinkCodec } from '../../shared/client.Df5pd75N.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, f as toStandardHeaders } from '../../shared/client.C6Bgyn6F.mjs';
 import '@orpc/shared';
-import '../../shared/client.XAn8cDTM.mjs';
 import '@orpc/standard-server';
+import '../../shared/client.CPTihQgC.mjs';
+import '@orpc/standard-server-fetch';
+import '../../shared/client.BLtwTQUg.mjs';

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

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

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

@@ -0,0 +1,29 @@
+import { StandardRequest, StandardLazyResponse } from '@orpc/standard-server';
+import { b as ClientContext, c as ClientOptions } from '../../shared/client.i2uoJbEp.js';
+import { f as StandardLinkClient } from '../../shared/client.2jUAqzYU.js';
+import { f as StandardRPCLinkOptions, g as StandardRPCLink } from '../../shared/client.B3pNRBih.js';
+import '@orpc/shared';
+
+interface LinkWebsocketClientOptions {
+    websocket: Pick<WebSocket, 'addEventListener' | 'send' | 'readyState'>;
+}
+declare class LinkWebsocketClient<T extends ClientContext> implements StandardLinkClient<T> {
+    private readonly peer;
+    constructor(options: LinkWebsocketClientOptions);
+    call(request: StandardRequest, _options: ClientOptions<T>, _path: readonly string[], _input: unknown): Promise<StandardLazyResponse>;
+}
+
+interface RPCLinkOptions<T extends ClientContext> extends Omit<StandardRPCLinkOptions<T>, 'url' | 'method' | 'fallbackMethod' | 'maxUrlLength'>, LinkWebsocketClientOptions {
+}
+/**
+ * The RPC Link communicates with the server using the RPC protocol over WebSocket.
+ *
+ * @see {@link https://orpc.dev/docs/client/rpc-link RPC Link Docs}
+ * @see {@link https://orpc.dev/docs/adapters/websocket WebSocket Adapter Docs}
+ */
+declare class RPCLink<T extends ClientContext> extends StandardRPCLink<T> {
+    constructor(options: RPCLinkOptions<T>);
+}
+
+export { LinkWebsocketClient, RPCLink };
+export type { LinkWebsocketClientOptions, RPCLinkOptions };

package/dist/adapters/websocket/index.mjs

@@ -0,0 +1,47 @@
+import { readAsBuffer } from '@orpc/shared';
+import { ClientPeer } from '@orpc/standard-server-peer';
+import { c as StandardRPCLink } from '../../shared/client.C6Bgyn6F.mjs';
+import '@orpc/standard-server';
+import '../../shared/client.CPTihQgC.mjs';
+import '@orpc/standard-server-fetch';
+import '../../shared/client.BLtwTQUg.mjs';
+
+const WEBSOCKET_CONNECTING = 0;
+class LinkWebsocketClient {
+  peer;
+  constructor(options) {
+    const untilOpen = new Promise((resolve) => {
+      if (options.websocket.readyState === WEBSOCKET_CONNECTING) {
+        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 readAsBuffer(event.data) : 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 RPCLink extends StandardRPCLink {
+  constructor(options) {
+    const linkClient = new LinkWebsocketClient(options);
+    super(linkClient, { ...options, url: "http://orpc" });
+  }
+}
+
+export { LinkWebsocketClient, RPCLink };