swarpc 0.5.0 → 0.6.1

package/dist/swarpc.d.ts

@@ -1,4 +1,4 @@
-import { type ProceduresMap, type SwarpcClient, type SwarpcServer } from "./types.js";
+import { Hooks, type ProceduresMap, type SwarpcClient, type SwarpcServer } from "./types.js";
 export type { ProceduresMap, SwarpcClient, SwarpcServer } from "./types.js";
 /**
  * Creates a sw&rpc server instance.
@@ -15,9 +15,11 @@ export declare function Server<Procedures extends ProceduresMap>(procedures: Pro
  * @param procedures procedures the client will be able to call
  * @param param1 various options
  * @param param1.worker if provided, the client will use this worker to post messages.
+ * @param param1.hooks hooks to run on messages received from the server
  * @returns a sw&rpc client instance. Each property of the procedures map will be a method, that accepts an input and an optional onProgress callback.
  */
-export declare function Client<Procedures extends ProceduresMap>(procedures: Procedures, { worker }?: {
+export declare function Client<Procedures extends ProceduresMap>(procedures: Procedures, { worker, hooks }?: {
     worker?: Worker;
+    hooks?: Hooks<Procedures>;
 }): SwarpcClient<Procedures>;
 //# sourceMappingURL=swarpc.d.ts.map

package/dist/swarpc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"swarpc.d.ts","sourceRoot":"","sources":["../src/swarpc.ts"],"names":[],"mappings":"AACA,OAAO,EAKL,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,YAAY,EAClB,MAAM,YAAY,CAAA;AAGnB,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAE3E;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,UAAU,SAAS,aAAa,EACrD,UAAU,EAAE,UAAU,EACtB,EAAE,MAAM,EAAE,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GACnC,YAAY,CAAC,UAAU,CAAC,CA0G1B;AAoFD;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,UAAU,SAAS,aAAa,EACrD,UAAU,EAAE,UAAU,EACtB,EAAE,MAAM,EAAE,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GACnC,YAAY,CAAC,UAAU,CAAC,CA0D1B"}
+{"version":3,"file":"swarpc.d.ts","sourceRoot":"","sources":["../src/swarpc.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,EAML,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,YAAY,EAClB,MAAM,YAAY,CAAA;AAGnB,YAAY,EAAE,aAAa,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAE3E;;;;;;GAMG;AACH,wBAAgB,MAAM,CAAC,UAAU,SAAS,aAAa,EACrD,UAAU,EAAE,UAAU,EACtB,EAAE,MAAM,EAAE,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GACnC,YAAY,CAAC,UAAU,CAAC,CAuG1B;AA+FD;;;;;;;GAOG;AACH,wBAAgB,MAAM,CAAC,UAAU,SAAS,aAAa,EACrD,UAAU,EAAE,UAAU,EACtB,EAAE,MAAM,EAAE,KAAU,EAAE,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAA;CAAO,GAC1E,YAAY,CAAC,UAAU,CAAC,CA0D1B"}

package/dist/swarpc.js

@@ -53,7 +53,13 @@ export function Server(procedures, { worker } = {}) {
             // Get autotransfer preference from the procedure definition
             const { autotransfer = "output-only" } = instance[zProcedures][functionName];
             // Shorthand function with functionName, requestId, etc. set
-            const postMsg = async (data) => postMessage({ functionName, requestId, autotransfer, ...data });
+            const postMsg = async (data) => postMessage({
+                by: "sw&rpc",
+                functionName,
+                requestId,
+                autotransfer,
+                ...data,
+            });
             // Prepare a function to post errors back to the client
             const postError = async (error) => postMsg({
                 error: {
@@ -105,7 +111,7 @@ let _clientListenerStarted = false;
  * @param worker if provided, the client will use this worker to listen for messages, instead of using the service worker
  * @returns
  */
-async function startClientListener(worker) {
+async function startClientListener(worker, hooks = {}) {
     if (_clientListenerStarted)
         return;
     // Get service worker registration if no worker is provided
@@ -123,8 +129,12 @@ async function startClientListener(worker) {
     l.client.debug("", "Starting client listener on", w);
     w.addEventListener("message", (event) => {
         // Get the data from the event
+        const eventData = event.data || {};
+        // Ignore other messages that aren't for us
+        if (eventData?.by !== "sw&rpc")
+            return;
         // We don't use a arktype schema here, we trust the server to send valid data
-        const { functionName, requestId, ...data } = event.data || {};
+        const { functionName, requestId, ...data } = eventData;
         // Sanity check in case we somehow receive a message without requestId
         if (!requestId) {
             throw new Error("[SWARPC Client] Message received without requestId");
@@ -134,16 +144,19 @@ async function startClientListener(worker) {
         if (!handlers) {
             throw new Error(`[SWARPC Client] ${requestId} has no active request handlers`);
         }
-        // React to the data received
-        // Unless it's a progress update, the request is finished, thus we can remove it from the pending requests
+        // React to the data received: call hook, call handler,
+        // and remove the request from pendingRequests (unless it's a progress update)
         if ("error" in data) {
+            hooks.error?.(functionName, new Error(data.error.message));
             handlers.reject(new Error(data.error.message));
             pendingRequests.delete(requestId);
         }
         else if ("progress" in data) {
+            hooks.progress?.(functionName, data.progress);
             handlers.onProgress(data.progress);
         }
         else if ("result" in data) {
+            hooks.success?.(functionName, data.result);
             handlers.resolve(data.result);
             pendingRequests.delete(requestId);
         }
@@ -155,9 +168,10 @@ async function startClientListener(worker) {
  * @param procedures procedures the client will be able to call
  * @param param1 various options
  * @param param1.worker if provided, the client will use this worker to post messages.
+ * @param param1.hooks hooks to run on messages received from the server
  * @returns a sw&rpc client instance. Each property of the procedures map will be a method, that accepts an input and an optional onProgress callback.
  */
-export function Client(procedures, { worker } = {}) {
+export function Client(procedures, { worker, hooks = {} } = {}) {
     // Store procedures on a symbol key, to avoid conflicts with procedure names
     const instance = { [zProcedures]: procedures };
     for (const functionName of Object.keys(procedures)) {
@@ -170,7 +184,7 @@ export function Client(procedures, { worker } = {}) {
             // Validate the input against the procedure's input schema
             procedures[functionName].input.assert(input);
             // Ensure that we're listening for messages from the server
-            await startClientListener(worker);
+            await startClientListener(worker, hooks);
             // If no worker is provided, we use the service worker
             const w = worker ?? (await navigator.serviceWorker.ready.then((r) => r.active));
             if (!w) {

package/dist/types.d.ts

@@ -33,7 +33,7 @@ export type Procedure<I extends Type, P extends Type, S extends Type> = {
  */
 export type ProcedureImplementation<I extends Type, P extends Type, S extends Type> = (input: I["inferOut"], onProgress: (progress: P["inferIn"]) => void) => Promise<S["inferIn"]>;
 /**
- * Declarations of procedures by name
+ * Declarations of procedures by name.
  */
 export type ProceduresMap = Record<string, Procedure<Type, Type, Type>>;
 /**
@@ -42,6 +42,44 @@ export type ProceduresMap = Record<string, Procedure<Type, Type, Type>>;
 export type ImplementationsMap<Procedures extends ProceduresMap> = {
     [F in keyof Procedures]: ProcedureImplementation<Procedures[F]["input"], Procedures[F]["progress"], Procedures[F]["success"]>;
 };
+/**
+ * Declaration of hooks to run on messages received from the server
+ */
+export type Hooks<Procedures extends ProceduresMap> = {
+    /**
+     * Called when a procedure call has been successful.
+     */
+    success?: <Procedure extends keyof ProceduresMap>(procedure: Procedure, data: Procedures[Procedure]["success"]["inferOut"]) => void;
+    /**
+     * Called when a procedure call has failed.
+     */
+    error?: <Procedure extends keyof ProceduresMap>(procedure: Procedure, error: Error) => void;
+    /**
+     * Called when a procedure call sends progress updates.
+     */
+    progress?: <Procedure extends keyof ProceduresMap>(procedure: Procedure, data: Procedures[Procedure]["progress"]["inferOut"]) => void;
+};
+export type PayloadHeader<PM extends ProceduresMap, Name extends keyof PM = keyof PM> = {
+    by: "sw&rpc";
+    functionName: Name & string;
+    requestId: string;
+    autotransfer: PM[Name]["autotransfer"];
+};
+export type PayloadCore<PM extends ProceduresMap, Name extends keyof PM = keyof PM> = {
+    input: PM[Name]["input"]["inferOut"];
+} | {
+    progress: PM[Name]["progress"]["inferOut"];
+} | {
+    result: PM[Name]["success"]["inferOut"];
+} | {
+    error: {
+        message: string;
+    };
+};
+/**
+ * The effective payload as sent by the server to the client
+ */
+export type Payload<PM extends ProceduresMap, Name extends keyof PM = keyof PM> = PayloadHeader<PM, Name> & PayloadCore<PM, Name>;
 /**
  * A procedure's corresponding method on the client instance -- used to call the procedure
  */

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAEnC;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,SAAS,IAAI,EAAE,CAAC,SAAS,IAAI,IAAI;IACtE;;OAEG;IACH,KAAK,EAAE,CAAC,CAAA;IACR;;;OAGG;IACH,QAAQ,EAAE,CAAC,CAAA;IACX;;OAEG;IACH,OAAO,EAAE,CAAC,CAAA;IACV;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,aAAa,CAAA;CAClD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,CACjC,CAAC,SAAS,IAAI,EACd,CAAC,SAAS,IAAI,EACd,CAAC,SAAS,IAAI,IACZ,CACF,KAAK,EAAE,CAAC,CAAC,UAAU,CAAC,EACpB,UAAU,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI,KACzC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAA;AAE1B;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;AAEvE;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,UAAU,SAAS,aAAa,IAAI;KAChE,CAAC,IAAI,MAAM,UAAU,GAAG,uBAAuB,CAC9C,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EACtB,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EACzB,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CACzB;CACF,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAChE,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,EAC5B,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,KAAK,IAAI,KACvD,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC,CAAA;AAEtC;;GAEG;AACH,eAAO,MAAM,gBAAgB,eAAmC,CAAA;AAChE;;GAEG;AACH,eAAO,MAAM,WAAW,eAA8B,CAAA;AAEtD;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,UAAU,SAAS,aAAa,IAAI;IAC3D,CAAC,WAAW,CAAC,EAAE,UAAU,CAAA;CAC1B,GAAG;KACD,CAAC,IAAI,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;CACrD,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,UAAU,SAAS,aAAa,IAAI;IAC3D,CAAC,WAAW,CAAC,EAAE,UAAU,CAAA;IACzB,CAAC,gBAAgB,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,CAAA;IAClD,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B,GAAG;KACD,CAAC,IAAI,MAAM,UAAU,GAAG,CACvB,IAAI,EAAE,uBAAuB,CAC3B,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EACtB,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EACzB,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CACzB,KACE,IAAI;CACV,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAEnC;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,SAAS,IAAI,EAAE,CAAC,SAAS,IAAI,IAAI;IACtE;;OAEG;IACH,KAAK,EAAE,CAAC,CAAA;IACR;;;OAGG;IACH,QAAQ,EAAE,CAAC,CAAA;IACX;;OAEG;IACH,OAAO,EAAE,CAAC,CAAA;IACV;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,aAAa,CAAA;CAClD,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,CACjC,CAAC,SAAS,IAAI,EACd,CAAC,SAAS,IAAI,EACd,CAAC,SAAS,IAAI,IACZ,CACF,KAAK,EAAE,CAAC,CAAC,UAAU,CAAC,EACpB,UAAU,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI,KACzC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAA;AAE1B;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;AAEvE;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,UAAU,SAAS,aAAa,IAAI;KAChE,CAAC,IAAI,MAAM,UAAU,GAAG,uBAAuB,CAC9C,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EACtB,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EACzB,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CACzB;CACF,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,UAAU,SAAS,aAAa,IAAI;IACpD;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,SAAS,SAAS,MAAM,aAAa,EAC9C,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,KAC/C,IAAI,CAAA;IACT;;OAEG;IACH,KAAK,CAAC,EAAE,CAAC,SAAS,SAAS,MAAM,aAAa,EAC5C,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,KAAK,KACT,IAAI,CAAA;IACT;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,SAAS,SAAS,MAAM,aAAa,EAC/C,SAAS,EAAE,SAAS,EACpB,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,KAChD,IAAI,CAAA;CACV,CAAA;AAED,MAAM,MAAM,aAAa,CACvB,EAAE,SAAS,aAAa,EACxB,IAAI,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,IAC9B;IACF,EAAE,EAAE,QAAQ,CAAA;IACZ,YAAY,EAAE,IAAI,GAAG,MAAM,CAAA;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,WAAW,CACrB,EAAE,SAAS,aAAa,EACxB,IAAI,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,IAE9B;IACE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,CAAA;CACrC,GACD;IACE,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,CAAA;CAC3C,GACD;IACE,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAA;CACxC,GACD;IACE,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAC3B,CAAA;AAEL;;GAEG;AACH,MAAM,MAAM,OAAO,CACjB,EAAE,SAAS,aAAa,EACxB,IAAI,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,IAC9B,aAAa,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC,CAAA;AAEnD;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAChE,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,EAC5B,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,KAAK,IAAI,KACvD,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC,CAAA;AAEtC;;GAEG;AACH,eAAO,MAAM,gBAAgB,eAAmC,CAAA;AAChE;;GAEG;AACH,eAAO,MAAM,WAAW,eAA8B,CAAA;AAEtD;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,UAAU,SAAS,aAAa,IAAI;IAC3D,CAAC,WAAW,CAAC,EAAE,UAAU,CAAA;CAC1B,GAAG;KACD,CAAC,IAAI,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;CACrD,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,UAAU,SAAS,aAAa,IAAI;IAC3D,CAAC,WAAW,CAAC,EAAE,UAAU,CAAA;IACzB,CAAC,gBAAgB,CAAC,EAAE,kBAAkB,CAAC,UAAU,CAAC,CAAA;IAClD,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B,GAAG;KACD,CAAC,IAAI,MAAM,UAAU,GAAG,CACvB,IAAI,EAAE,uBAAuB,CAC3B,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EACtB,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EACzB,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CACzB,KACE,IAAI;CACV,CAAA"}

package/dist/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAiBA,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,GAAG,GAAG,YAAY,EAAE,CAsB5D"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAWA,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,GAAG,GAAG,YAAY,EAAE,CAsB5D"}

package/dist/utils.js

@@ -1,15 +1,9 @@
 // TODO: keep it in sync with web standards, how?
 const transferableClasses = [
-    OffscreenCanvas,
-    ImageBitmap,
     MessagePort,
-    MediaSourceHandle,
     ReadableStream,
     WritableStream,
     TransformStream,
-    AudioData,
-    VideoFrame,
-    RTCDataChannel,
     ArrayBuffer,
 ];
 export function findTransferables(value) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swarpc",
-  "version": "0.5.0",
+  "version": "0.6.1",
   "description": "Full type-safe RPC library for service worker -- move things off of the UI thread with ease!",
   "keywords": [
     "service-workers",
@@ -30,12 +30,15 @@
     "build": "tsc",
     "dev": "tsc --watch",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "typedoc": "typedoc src/swarpc.ts src/types.ts --readme README.md"
+    "typedoc": "typedoc src/swarpc.ts src/types.ts --readme README.md",
+    "version": "kacl release && prettier -w CHANGELOG.md && git add CHANGELOG.md"
   },
   "dependencies": {
     "arktype": "^2.1.20"
   },
   "devDependencies": {
+    "kacl": "^1.1.1",
+    "prettier": "^3.6.2",
     "typedoc": "^0.28.7",
     "typescript": "^5.8.3"
   }

package/src/swarpc.ts

@@ -1,7 +1,9 @@
-import { type, type Type } from "arktype"
+import { type } from "arktype"
 import {
+  Hooks,
   ImplementationsMap,
-  Procedure,
+  Payload,
+  PayloadCore,
   zImplementations,
   zProcedures,
   type ProceduresMap,
@@ -53,17 +55,7 @@ export function Server<Procedures extends ProceduresMap>(
 
   instance.start = (self: Window) => {
     // Used to post messages back to the client
-    const postMessage = async (
-      data: {
-        functionName: string
-        requestId: string
-        autotransfer: Procedure<Type, Type, Type>["autotransfer"]
-      } & Partial<{
-        result: any
-        error: any
-        progress: any
-      }>
-    ) => {
+    const postMessage = async (data: Payload<Procedures>) => {
       const transfer =
         data.autotransfer === "never" ? [] : findTransferables(data)
 
@@ -91,8 +83,15 @@ export function Server<Procedures extends ProceduresMap>(
 
       // Shorthand function with functionName, requestId, etc. set
       const postMsg = async (
-        data: { result: any } | { error: any } | { progress: any }
-      ) => postMessage({ functionName, requestId, autotransfer, ...data })
+        data: PayloadCore<Procedures, typeof functionName>
+      ) =>
+        postMessage({
+          by: "sw&rpc",
+          functionName,
+          requestId,
+          autotransfer,
+          ...data,
+        })
 
       // Prepare a function to post errors back to the client
       const postError = async (error: any) =>
@@ -158,7 +157,10 @@ let _clientListenerStarted = false
  * @param worker if provided, the client will use this worker to listen for messages, instead of using the service worker
  * @returns
  */
-async function startClientListener(worker?: Worker) {
+async function startClientListener<Procedures extends ProceduresMap>(
+  worker?: Worker,
+  hooks: Hooks<Procedures> = {}
+) {
   if (_clientListenerStarted) return
 
   // Get service worker registration if no worker is provided
@@ -179,9 +181,14 @@ async function startClientListener(worker?: Worker) {
   l.client.debug("", "Starting client listener on", w)
   w.addEventListener("message", (event) => {
     // Get the data from the event
+    const eventData = (event as MessageEvent).data || {}
+
+    // Ignore other messages that aren't for us
+    if (eventData?.by !== "sw&rpc") return
+
     // We don't use a arktype schema here, we trust the server to send valid data
     const { functionName, requestId, ...data } =
-      (event as MessageEvent).data || {}
+      eventData as Payload<Procedures>
 
     // Sanity check in case we somehow receive a message without requestId
     if (!requestId) {
@@ -196,14 +203,17 @@ async function startClientListener(worker?: Worker) {
       )
     }
 
-    // React to the data received
-    // Unless it's a progress update, the request is finished, thus we can remove it from the pending requests
+    // React to the data received: call hook, call handler,
+    // and remove the request from pendingRequests (unless it's a progress update)
     if ("error" in data) {
+      hooks.error?.(functionName, new Error(data.error.message))
       handlers.reject(new Error(data.error.message))
       pendingRequests.delete(requestId)
     } else if ("progress" in data) {
+      hooks.progress?.(functionName, data.progress)
       handlers.onProgress(data.progress)
     } else if ("result" in data) {
+      hooks.success?.(functionName, data.result)
       handlers.resolve(data.result)
       pendingRequests.delete(requestId)
     }
@@ -217,11 +227,12 @@ async function startClientListener(worker?: Worker) {
  * @param procedures procedures the client will be able to call
  * @param param1 various options
  * @param param1.worker if provided, the client will use this worker to post messages.
+ * @param param1.hooks hooks to run on messages received from the server
  * @returns a sw&rpc client instance. Each property of the procedures map will be a method, that accepts an input and an optional onProgress callback.
  */
 export function Client<Procedures extends ProceduresMap>(
   procedures: Procedures,
-  { worker }: { worker?: Worker } = {}
+  { worker, hooks = {} }: { worker?: Worker; hooks?: Hooks<Procedures> } = {}
 ): SwarpcClient<Procedures> {
   // Store procedures on a symbol key, to avoid conflicts with procedure names
   const instance = { [zProcedures]: procedures } as Partial<
@@ -243,7 +254,7 @@ export function Client<Procedures extends ProceduresMap>(
       // Validate the input against the procedure's input schema
       procedures[functionName].input.assert(input)
       // Ensure that we're listening for messages from the server
-      await startClientListener(worker)
+      await startClientListener(worker, hooks)
 
       // If no worker is provided, we use the service worker
       const w =

package/src/types.ts

@@ -43,7 +43,7 @@ export type ProcedureImplementation<
 ) => Promise<S["inferIn"]>
 
 /**
- * Declarations of procedures by name
+ * Declarations of procedures by name.
  */
 export type ProceduresMap = Record<string, Procedure<Type, Type, Type>>
 
@@ -58,6 +58,68 @@ export type ImplementationsMap<Procedures extends ProceduresMap> = {
   >
 }
 
+/**
+ * Declaration of hooks to run on messages received from the server
+ */
+export type Hooks<Procedures extends ProceduresMap> = {
+  /**
+   * Called when a procedure call has been successful.
+   */
+  success?: <Procedure extends keyof ProceduresMap>(
+    procedure: Procedure,
+    data: Procedures[Procedure]["success"]["inferOut"]
+  ) => void
+  /**
+   * Called when a procedure call has failed.
+   */
+  error?: <Procedure extends keyof ProceduresMap>(
+    procedure: Procedure,
+    error: Error
+  ) => void
+  /**
+   * Called when a procedure call sends progress updates.
+   */
+  progress?: <Procedure extends keyof ProceduresMap>(
+    procedure: Procedure,
+    data: Procedures[Procedure]["progress"]["inferOut"]
+  ) => void
+}
+
+export type PayloadHeader<
+  PM extends ProceduresMap,
+  Name extends keyof PM = keyof PM
+> = {
+  by: "sw&rpc"
+  functionName: Name & string
+  requestId: string
+  autotransfer: PM[Name]["autotransfer"]
+}
+
+export type PayloadCore<
+  PM extends ProceduresMap,
+  Name extends keyof PM = keyof PM
+> =
+  | {
+      input: PM[Name]["input"]["inferOut"]
+    }
+  | {
+      progress: PM[Name]["progress"]["inferOut"]
+    }
+  | {
+      result: PM[Name]["success"]["inferOut"]
+    }
+  | {
+      error: { message: string }
+    }
+
+/**
+ * The effective payload as sent by the server to the client
+ */
+export type Payload<
+  PM extends ProceduresMap,
+  Name extends keyof PM = keyof PM
+> = PayloadHeader<PM, Name> & PayloadCore<PM, Name>
+
 /**
  * A procedure's corresponding method on the client instance -- used to call the procedure
  */

package/src/utils.ts

@@ -2,16 +2,10 @@ type Constructor<T> = new (...args: any[]) => T
 
 // TODO: keep it in sync with web standards, how?
 const transferableClasses: Constructor<Transferable>[] = [
-  OffscreenCanvas,
-  ImageBitmap,
   MessagePort,
-  MediaSourceHandle,
   ReadableStream,
   WritableStream,
   TransformStream,
-  AudioData,
-  VideoFrame,
-  RTCDataChannel,
   ArrayBuffer,
 ]