swarpc 0.19.0 → 0.20.1

package/dist/client.js

@@ -1,11 +1,10 @@
-import { createLogger, } from "./log.js";
+import { createLogger } from "./log.js";
 import { broadcastNodes, makeNodeId, nodeIdOrSW, whoToSendTo, } from "./nodes.js";
+import { _clientListeners, makeRequestId, pendingRequests, postMessage, postMessageSync, } from "./messaging.js";
 import { RequestCancelledError, zProcedures, } from "./types.js";
-import { findTransferables, extractFulfilleds, extractRejecteds, sizedArray, } from "./utils.js";
+import { findTransferables, extractFulfilleds, extractRejecteds, sizedArray, isSharedWorker, } from "./utils.js";
 export const RESERVED_PROCEDURE_NAMES = ["onceBy", "destroy"];
-const pendingRequests = new Map();
 const emptyProgressCallback = () => { };
-let _clientListeners = new Map();
 export function Client(procedures, { worker, nodes: nodeCount, loglevel = "debug", restartListener = false, hooks = {}, localStorage = {}, nodeIds = [], } = {}) {
     const l = createLogger("client", loglevel);
     if (restartListener)
@@ -35,7 +34,7 @@ export function Client(procedures, { worker, nodes: nodeCount, loglevel = "debug
             }
             for (const [nodeId, node] of Object.entries(nodes ?? {})) {
                 l.debug(null, `Terminating worker for node ${nodeId}`);
-                if (node instanceof SharedWorker) {
+                if (isSharedWorker(node)) {
                     node.port.close();
                 }
                 else {
@@ -120,6 +119,7 @@ export function Client(procedures, { worker, nodes: nodeCount, loglevel = "debug
                 pendingRequests.set(requestId, {
                     nodeId,
                     functionName,
+                    startedAt: performance.now(),
                     concurrencyKey,
                     resolve,
                     onProgress: onProgress ?? emptyProgressCallback,
@@ -260,119 +260,6 @@ export function Client(procedures, { worker, nodes: nodeCount, loglevel = "debug
     };
     return instance;
 }
-async function postMessage(ctx, message, options) {
-    await startClientListener(ctx);
-    const { logger: l, node: worker } = ctx;
-    if (!worker && !navigator.serviceWorker.controller)
-        l.warn("", "Service Worker is not controlling the page");
-    const w = worker instanceof SharedWorker
-        ? worker.port
-        : worker === undefined
-            ? await navigator.serviceWorker.ready.then((r) => r.active)
-            : worker;
-    if (!w) {
-        throw new Error("[SWARPC Client] No active service worker found");
-    }
-    w.postMessage(message, options);
-}
-function postMessageSync(l, worker, message, options) {
-    if (!worker && !navigator.serviceWorker.controller)
-        l.warn("Service Worker is not controlling the page");
-    const w = worker instanceof SharedWorker
-        ? worker.port
-        : worker === undefined
-            ? navigator.serviceWorker.controller
-            : worker;
-    if (!w) {
-        throw new Error("[SWARPC Client] No active service worker found");
-    }
-    w.postMessage(message, options);
-}
-async function startClientListener(ctx) {
-    if (_clientListeners.has(nodeIdOrSW(ctx.nodeId)))
-        return;
-    const { logger: l, node: worker } = ctx;
-    if (!worker) {
-        const sw = await navigator.serviceWorker.ready;
-        if (!sw?.active) {
-            throw new Error("[SWARPC Client] Service Worker is not active");
-        }
-        if (!navigator.serviceWorker.controller) {
-            l.warn("", "Service Worker is not controlling the page");
-        }
-    }
-    const w = worker ?? navigator.serviceWorker;
-    l.debug(null, "Starting client listener", { w, ...ctx });
-    const listener = (event) => {
-        const eventData = event.data || {};
-        if (eventData?.by !== "sw&rpc")
-            return;
-        const payload = eventData;
-        if ("isInitializeRequest" in payload) {
-            l.warn(null, "Ignoring unexpected #initialize from server", payload);
-            return;
-        }
-        const { requestId, ...data } = payload;
-        if (!requestId) {
-            throw new Error("[SWARPC Client] Message received without requestId");
-        }
-        const handlers = pendingRequests.get(requestId);
-        if (!handlers) {
-            throw new Error(`[SWARPC Client] ${requestId} has no active request handlers, cannot process ${JSON.stringify(data)}`);
-        }
-        if ("error" in data) {
-            ctx.hooks.error?.({
-                procedure: data.functionName,
-                error: new Error(data.error.message),
-            });
-            handlers.reject(new Error(data.error.message));
-            pendingRequests.delete(requestId);
-        }
-        else if ("progress" in data) {
-            ctx.hooks.progress?.({
-                procedure: data.functionName,
-                data: data.progress,
-            });
-            handlers.onProgress(data.progress);
-        }
-        else if ("result" in data) {
-            ctx.hooks.success?.({
-                procedure: data.functionName,
-                data: data.result,
-            });
-            handlers.resolve(data.result);
-            pendingRequests.delete(requestId);
-        }
-    };
-    if (w instanceof SharedWorker) {
-        w.port.addEventListener("message", listener);
-        w.port.start();
-    }
-    else {
-        w.addEventListener("message", listener);
-    }
-    _clientListeners.set(nodeIdOrSW(ctx.nodeId), {
-        disconnect() {
-            if (w instanceof SharedWorker) {
-                w.port.removeEventListener("message", listener);
-            }
-            else {
-                w.removeEventListener("message", listener);
-            }
-        },
-    });
-    await postMessage(ctx, {
-        by: "sw&rpc",
-        functionName: "#initialize",
-        isInitializeRequest: true,
-        localStorageData: ctx.localStorage,
-        nodeId: nodeIdOrSW(ctx.nodeId),
-        allNodeIDs: ctx.allNodeIDs,
-    });
-}
-function makeRequestId() {
-    return Math.random().toString(16).substring(2, 8).toUpperCase();
-}
 function handleBroadcastOrThrowResults(results) {
     if (results.ok) {
         return results.successes;

package/dist/messaging.d.ts

@@ -0,0 +1,44 @@
+import { type Logger, type RequestBoundLogger } from "./log.js";
+import { type Payload } from "./payload.js";
+import { type Hooks, type PendingRequest, type ProceduresMap } from "./types.js";
+/**
+ * Context for passing around data useful for requests
+ */
+export type Context<Procedures extends ProceduresMap> = {
+    /** A logger, bound to the client */
+    logger: Logger;
+    /** The node to use */
+    node: Worker | SharedWorker | undefined;
+    /** The ID of the node to use */
+    nodeId: string | undefined;
+    /** Set of all available nodes' IDs */
+    allNodeIDs: Set<string>;
+    /** Hooks defined by the client */
+    hooks: Hooks<Procedures>;
+    /** Local storage data defined by the client for the faux local storage */
+    localStorage: Record<string, any>;
+};
+/**
+ * Pending requests are stored in a map, where the key is the request ID.
+ * Each request has a set of handlers: resolve, reject, and onProgress.
+ * This allows having a single listener for the client, and having multiple in-flight calls to the same procedure.
+ */
+export declare const pendingRequests: Map<string, PendingRequest>;
+export declare let _clientListeners: Map<string, {
+    disconnect: () => void;
+}>;
+/**
+ * Warms up the client by starting the listener and getting the worker, then posts a message to the worker.
+ */
+export declare function postMessage<Procedures extends ProceduresMap>(ctx: Context<Procedures>, message: Payload<Procedures>, options?: StructuredSerializeOptions): Promise<void>;
+/**
+ * A quicker version of postMessage that does not try to start the client listener, await the service worker, etc.
+ * esp. useful for abort logic that needs to not be... put behind everything else on the event loop.
+ */
+export declare function postMessageSync<Procedures extends ProceduresMap>(l: RequestBoundLogger, worker: Worker | SharedWorker | undefined, message: Payload<Procedures>, options?: StructuredSerializeOptions): void;
+/**
+ * Generate a random request ID, used to identify requests between client and server.
+ * @source
+ * @returns a 6-character hexadecimal string
+ */
+export declare function makeRequestId(): string;

package/dist/messaging.js

@@ -0,0 +1,121 @@
+import { nodeIdOrSW } from "./nodes.js";
+import { isSharedWorker } from "./utils.js";
+export const pendingRequests = new Map();
+export let _clientListeners = new Map();
+export async function postMessage(ctx, message, options) {
+    await startClientListener(ctx);
+    const { logger: l, node: worker } = ctx;
+    if (!worker && !navigator.serviceWorker.controller)
+        l.warn("", "Service Worker is not controlling the page");
+    const w = isSharedWorker(worker)
+        ? worker.port
+        : worker === undefined
+            ? await navigator.serviceWorker.ready.then((r) => r.active)
+            : worker;
+    if (!w) {
+        throw new Error("[SWARPC Client] No active service worker found");
+    }
+    w.postMessage(message, options);
+}
+export function postMessageSync(l, worker, message, options) {
+    if (!worker && !navigator.serviceWorker.controller)
+        l.warn("Service Worker is not controlling the page");
+    const w = isSharedWorker(worker)
+        ? worker.port
+        : worker === undefined
+            ? navigator.serviceWorker.controller
+            : worker;
+    if (!w) {
+        throw new Error("[SWARPC Client] No active service worker found");
+    }
+    w.postMessage(message, options);
+}
+async function startClientListener(ctx) {
+    if (_clientListeners.has(nodeIdOrSW(ctx.nodeId)))
+        return;
+    const { logger: l, node: worker } = ctx;
+    if (!worker) {
+        const sw = await navigator.serviceWorker.ready;
+        if (!sw?.active) {
+            throw new Error("[SWARPC Client] Service Worker is not active");
+        }
+        if (!navigator.serviceWorker.controller) {
+            l.warn("", "Service Worker is not controlling the page");
+        }
+    }
+    const w = worker ?? navigator.serviceWorker;
+    l.debug(null, "Starting client listener", { w, ...ctx });
+    const listener = (event) => {
+        const eventData = event.data || {};
+        if (eventData?.by !== "sw&rpc")
+            return;
+        const payload = eventData;
+        if ("isInitializeRequest" in payload) {
+            l.warn(null, "Ignoring unexpected #initialize from server", payload);
+            return;
+        }
+        const { requestId, ...data } = payload;
+        if (!requestId) {
+            throw new Error("[SWARPC Client] Message received without requestId");
+        }
+        const handlers = pendingRequests.get(requestId);
+        if (!handlers) {
+            throw new Error(`[SWARPC Client] ${requestId} has no active request handlers, cannot process ${JSON.stringify(data)}`);
+        }
+        const duration = performance.now() - handlers.startedAt;
+        if ("error" in data) {
+            ctx.hooks.error?.({
+                procedure: data.functionName,
+                error: new Error(data.error.message),
+                duration,
+            });
+            handlers.reject(new Error(data.error.message));
+            pendingRequests.delete(requestId);
+        }
+        else if ("progress" in data) {
+            ctx.hooks.progress?.({
+                procedure: data.functionName,
+                data: data.progress,
+                duration,
+            });
+            handlers.onProgress(data.progress);
+        }
+        else if ("result" in data) {
+            ctx.hooks.success?.({
+                procedure: data.functionName,
+                data: data.result,
+                duration,
+            });
+            handlers.resolve(data.result);
+            pendingRequests.delete(requestId);
+        }
+    };
+    if (isSharedWorker(w)) {
+        w.port.addEventListener("message", listener);
+        w.port.start();
+    }
+    else {
+        w.addEventListener("message", listener);
+    }
+    _clientListeners.set(nodeIdOrSW(ctx.nodeId), {
+        disconnect() {
+            if (isSharedWorker(w)) {
+                w.port.removeEventListener("message", listener);
+            }
+            else {
+                w.removeEventListener("message", listener);
+            }
+        },
+    });
+    await postMessage(ctx, {
+        by: "sw&rpc",
+        functionName: "#initialize",
+        isInitializeRequest: true,
+        localStorageData: ctx.localStorage,
+        nodeId: nodeIdOrSW(ctx.nodeId),
+        allNodeIDs: ctx.allNodeIDs,
+    });
+}
+export function makeRequestId() {
+    return Math.random().toString(16).substring(2, 8).toUpperCase();
+}

package/dist/payload.d.ts

@@ -0,0 +1,17 @@
+import type { StandardSchemaV1 as Schema } from "./standardschema.js";
+import type { ProceduresMap } from "./types.js";
+export type PayloadCore<PM extends ProceduresMap, Name extends keyof PM = keyof PM> = {
+    input: Schema.InferOutput<PM[Name]["input"]>;
+} | {
+    progress: Schema.InferOutput<PM[Name]["progress"]>;
+} | {
+    result: Schema.InferOutput<PM[Name]["success"]>;
+} | {
+    abort: {
+        reason: string;
+    };
+} | {
+    error: {
+        message: string;
+    };
+};

package/dist/payload.js

@@ -0,0 +1,88 @@
+export function isPayloadInitialize(payload) {
+    if (typeof payload !== "object")
+        return false;
+    if (payload === null)
+        return false;
+    if (!("by" in payload))
+        return false;
+    if (!("nodeId" in payload))
+        return false;
+    if (!("functionName" in payload))
+        return false;
+    if (!("localStorageData" in payload))
+        return false;
+    if (!("isInitializeRequest" in payload))
+        return false;
+    if (!("allNodeIDs" in payload))
+        return false;
+    if (payload.by !== "sw&rpc")
+        return false;
+    if (payload.functionName !== "#initialize")
+        return false;
+    if (payload.isInitializeRequest !== true)
+        return false;
+    if (typeof payload.nodeId !== "string")
+        return false;
+    if (typeof payload.localStorageData !== "object")
+        return false;
+    if (payload.localStorageData === null)
+        return false;
+    return true;
+}
+export function isPayloadHeader(procedures, payload) {
+    if (typeof payload !== "object")
+        return false;
+    if (payload === null)
+        return false;
+    if (!("by" in payload))
+        return false;
+    if (!("requestId" in payload))
+        return false;
+    if (!("functionName" in payload))
+        return false;
+    if (payload.by !== "sw&rpc")
+        return false;
+    if (typeof payload.requestId !== "string")
+        return false;
+    if (typeof payload.functionName !== "string")
+        return false;
+    if (!Object.keys(procedures).includes(payload.functionName))
+        return false;
+    return true;
+}
+export function validatePayloadCore(procedure, payload) {
+    if (typeof payload !== "object")
+        throw new Error("payload is not an object");
+    if (payload === null)
+        throw new Error("payload is null");
+    if ("input" in payload) {
+        const input = procedure.input["~standard"].validate(payload.input);
+        if ("value" in input)
+            return { input: input.value };
+    }
+    if ("progress" in payload) {
+        const progress = procedure.progress["~standard"].validate(payload.progress);
+        if ("value" in progress)
+            return { progress: progress.value };
+    }
+    if ("result" in payload) {
+        const result = procedure.success["~standard"].validate(payload.result);
+        if ("value" in result)
+            return { result: result.value };
+    }
+    if ("abort" in payload &&
+        typeof payload.abort === "object" &&
+        payload.abort !== null &&
+        "reason" in payload.abort &&
+        typeof payload.abort.reason === "string") {
+        return { abort: { reason: payload.abort.reason } };
+    }
+    if ("error" in payload &&
+        typeof payload.error === "object" &&
+        payload.error !== null &&
+        "message" in payload.error &&
+        typeof payload.error.message === "string") {
+        return { error: { message: payload.error.message } };
+    }
+    throw new Error("invalid payload");
+}

package/dist/server.js

@@ -1,5 +1,6 @@
 import { createLogger, injectIntoConsoleGlobal } from "./log.js";
-import { isPayloadHeader, isPayloadInitialize, RequestCancelledError, validatePayloadCore, zImplementations, zProcedures, } from "./types.js";
+import { RequestCancelledError, zImplementations, zProcedures, } from "./types.js";
+import { isPayloadHeader, isPayloadInitialize, validatePayloadCore, } from "./payload.js";
 import { findTransferables } from "./utils.js";
 import { FauxLocalStorage } from "./localstorage.js";
 import { scopeIsDedicated, scopeIsShared, scopeIsService } from "./scopes.js";

package/dist/types.d.ts

@@ -90,6 +90,8 @@ type ProcedureNameAndData<Procedures extends ProceduresMap, Key extends "progres
     [K in keyof Procedures]: {
         procedure: K;
         data: Schema.InferOutput<Procedures[K][Key]>;
+        /** Time in milliseconds the procedure call took */
+        duration: number;
     };
 }[keyof Procedures];
 /**
@@ -102,9 +104,12 @@ export type Hooks<Procedures extends ProceduresMap> = {
     success?: (arg: ProcedureNameAndData<Procedures, "success">) => void;
     /**
      * Called when a procedure call has failed.
+     * @param arg
+     * @param arg.duration time in milliseconds the procedure call took
      */
     error?: (arg: {
         procedure: keyof Procedures;
+        duration: number;
         error: Error;
     }) => void;
     /**
@@ -112,21 +117,6 @@ export type Hooks<Procedures extends ProceduresMap> = {
      */
     progress?: (arg: ProcedureNameAndData<Procedures, "progress">) => void;
 };
-export type PayloadCore<PM extends ProceduresMap, Name extends keyof PM = keyof PM> = {
-    input: Schema.InferOutput<PM[Name]["input"]>;
-} | {
-    progress: Schema.InferOutput<PM[Name]["progress"]>;
-} | {
-    result: Schema.InferOutput<PM[Name]["success"]>;
-} | {
-    abort: {
-        reason: string;
-    };
-} | {
-    error: {
-        message: string;
-    };
-};
 /**
  * The callable function signature for a client method
  */
@@ -200,7 +190,7 @@ export type BroadcasterResultExtrasFailure = {
     successes: [];
     byNode: Map<string, PromiseRejectedResult>;
 };
-type ClientMethodExtraCallables<P extends Procedure<Schema, Schema, Schema>> = {
+export type ClientMethodExtraCallables<P extends Procedure<Schema, Schema, Schema>> = {
     /**
      * A method that returns a `CancelablePromise`. Cancel it by calling `.cancel(reason)` on it, and wait for the request to resolve by awaiting the `request` property on the returned object.
      */

package/dist/types.js

@@ -1,91 +1,3 @@
-export function isPayloadInitialize(payload) {
-    if (typeof payload !== "object")
-        return false;
-    if (payload === null)
-        return false;
-    if (!("by" in payload))
-        return false;
-    if (!("nodeId" in payload))
-        return false;
-    if (!("functionName" in payload))
-        return false;
-    if (!("localStorageData" in payload))
-        return false;
-    if (!("isInitializeRequest" in payload))
-        return false;
-    if (!("allNodeIDs" in payload))
-        return false;
-    if (payload.by !== "sw&rpc")
-        return false;
-    if (payload.functionName !== "#initialize")
-        return false;
-    if (payload.isInitializeRequest !== true)
-        return false;
-    if (typeof payload.nodeId !== "string")
-        return false;
-    if (typeof payload.localStorageData !== "object")
-        return false;
-    if (payload.localStorageData === null)
-        return false;
-    return true;
-}
-export function isPayloadHeader(procedures, payload) {
-    if (typeof payload !== "object")
-        return false;
-    if (payload === null)
-        return false;
-    if (!("by" in payload))
-        return false;
-    if (!("requestId" in payload))
-        return false;
-    if (!("functionName" in payload))
-        return false;
-    if (payload.by !== "sw&rpc")
-        return false;
-    if (typeof payload.requestId !== "string")
-        return false;
-    if (typeof payload.functionName !== "string")
-        return false;
-    if (!Object.keys(procedures).includes(payload.functionName))
-        return false;
-    return true;
-}
-export function validatePayloadCore(procedure, payload) {
-    if (typeof payload !== "object")
-        throw new Error("payload is not an object");
-    if (payload === null)
-        throw new Error("payload is null");
-    if ("input" in payload) {
-        const input = procedure.input["~standard"].validate(payload.input);
-        if ("value" in input)
-            return { input: input.value };
-    }
-    if ("progress" in payload) {
-        const progress = procedure.progress["~standard"].validate(payload.progress);
-        if ("value" in progress)
-            return { progress: progress.value };
-    }
-    if ("result" in payload) {
-        const result = procedure.success["~standard"].validate(payload.result);
-        if ("value" in result)
-            return { result: result.value };
-    }
-    if ("abort" in payload &&
-        typeof payload.abort === "object" &&
-        payload.abort !== null &&
-        "reason" in payload.abort &&
-        typeof payload.abort.reason === "string") {
-        return { abort: { reason: payload.abort.reason } };
-    }
-    if ("error" in payload &&
-        typeof payload.error === "object" &&
-        payload.error !== null &&
-        "message" in payload.error &&
-        typeof payload.error.message === "string") {
-        return { error: { message: payload.error.message } };
-    }
-    throw new Error("invalid payload");
-}
 export const zImplementations = Symbol("SWARPC implementations");
 export const zProcedures = Symbol("SWARPC procedures");
 export class RequestCancelledError extends Error {

package/dist/utils.js

@@ -35,3 +35,8 @@ export function extractFulfilleds(settleds) {
 export function extractRejecteds(settleds) {
     return settleds.filter((settled) => settled.status === "rejected");
 }
+export function isSharedWorker(worker) {
+    if (!SharedWorker)
+        return false;
+    return worker instanceof SharedWorker;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swarpc",
-  "version": "0.19.0",
+  "version": "0.20.1",
   "description": "Full type-safe RPC library for service worker -- move things off of the UI thread with ease!",
   "keywords": [
     "service-workers",
@@ -47,38 +47,41 @@
   },
   "devDependencies": {
     "@8hobbies/typedoc-plugin-plausible": "^2.2.0",
-    "@playwright/test": "^1.57.0",
-    "@size-limit/esbuild-why": "^12.0.0",
-    "@size-limit/preset-small-lib": "^12.0.0",
-    "@vitest/web-worker": "^4.0.17",
-    "arktype": "^2.1.29",
+    "@playwright/test": "^1.59.1",
+    "@size-limit/esbuild-why": "^12.1.0",
+    "@size-limit/preset-small-lib": "^12.1.0",
+    "@vitest/web-worker": "^4.1.4",
+    "arktype": "^2.2.0",
     "date-fns": "^4.1.0",
     "husky": "^9.1.7",
     "kacl": "^1.1.1",
-    "knip": "^5.82.1",
-    "lint-staged": "^16.2.7",
-    "nodemon": "^3.1.11",
-    "oxlint": "^1.40.0",
-    "pkg-pr-new": "^0.0.62",
-    "prettier": "^3.8.0",
+    "knip": "^6.5.0",
+    "lint-staged": "^16.4.0",
+    "nodemon": "^3.1.14",
+    "oxlint": "^1.60.0",
+    "pkg-pr-new": "^0.0.66",
+    "prettier": "^3.8.3",
     "sirv-cli": "^3.0.1",
-    "size-limit": "^12.0.0",
-    "typedoc": "^0.28.16",
+    "size-limit": "^12.1.0",
+    "typedoc": "^0.28.19",
     "typedoc-material-theme": "^1.4.1",
-    "typedoc-plugin-dt-links": "^2.0.38",
+    "typedoc-plugin-dt-links": "^2.0.51",
     "typedoc-plugin-extras": "^4.0.1",
     "typedoc-plugin-inline-sources": "^1.3.0",
-    "typedoc-plugin-mdn-links": "^5.1.0",
-    "typedoc-plugin-redirect": "^1.2.1",
-    "typescript": "^5.9.3",
-    "vite": "^7.3.1",
-    "vitest": "^4.0.17"
+    "typedoc-plugin-mdn-links": "^5.1.1",
+    "typedoc-plugin-redirect": "^1.3.0",
+    "typescript": "^6.0.3",
+    "vite": "^8.0.9",
+    "vitest": "^4.1.4"
   },
   "volta": {
-    "node": "24.13.0",
-    "npm": "11.7.0"
+    "node": "24.15.0",
+    "npm": "11.12.1"
   },
   "lint-staged": {
+    ".prettierrc": [
+      "prettier --write"
+    ],
     "*.{ts,js,md,json,yaml,yml}": [
       "oxlint --fix",
       "prettier --write"