swarpc 0.8.0 → 0.9.0

package/dist/client.d.ts

@@ -2,7 +2,7 @@
  * @module
  * @mergeModuleWith <project>
  */
-import { type LogLevel } from "./log.js";
+import { type Logger, type LogLevel } from "./log.js";
 import { ClientMethod, Hooks, zProcedures, type ProceduresMap } from "./types.js";
 /**
  * The sw&rpc client instance, which provides {@link ClientMethod | methods to call procedures}.
@@ -20,16 +20,25 @@ export type SwarpcClient<Procedures extends ProceduresMap> = {
  * @param options various options
  * @param options.worker if provided, the client will use this worker to post messages.
  * @param options.hooks hooks to run on messages received from the server
+ * @param options.restartListener if true, will force the listener to restart even if it has already been started
  * @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, see {@link ClientMethod}
  *
  * An example of defining and using a client:
  * {@includeCode ../example/src/routes/+page.svelte}
  */
-export declare function Client<Procedures extends ProceduresMap>(procedures: Procedures, { worker, loglevel, hooks, }?: {
+export declare function Client<Procedures extends ProceduresMap>(procedures: Procedures, { worker, loglevel, restartListener, hooks, }?: {
     worker?: Worker;
     hooks?: Hooks<Procedures>;
     loglevel?: LogLevel;
+    restartListener?: boolean;
 }): SwarpcClient<Procedures>;
+/**
+ * Starts the client listener, which listens for messages from the sw&rpc server.
+ * @param worker if provided, the client will use this worker to listen for messages, instead of using the service worker
+ * @param force if true, will force the listener to restart even if it has already been started
+ * @returns
+ */
+export declare function startClientListener<Procedures extends ProceduresMap>(l: Logger, worker?: Worker, hooks?: Hooks<Procedures>): Promise<void>;
 /**
  * Generate a random request ID, used to identify requests between client and server.
  * @source

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAA6B,KAAK,QAAQ,EAAE,MAAM,UAAU,CAAA;AACnE,OAAO,EACL,YAAY,EACZ,KAAK,EAGL,WAAW,EACX,KAAK,aAAa,EACnB,MAAM,YAAY,CAAA;AAGnB;;;;GAIG;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;AAkBD;;;;;;;;;;GAUG;AACH,wBAAgB,MAAM,CAAC,UAAU,SAAS,aAAa,EACrD,UAAU,EAAE,UAAU,EACtB,EACE,MAAM,EACN,QAAkB,EAClB,KAAU,GACX,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAAC,QAAQ,CAAC,EAAE,QAAQ,CAAA;CAAO,GAC1E,YAAY,CAAC,UAAU,CAAC,CA+F1B;AAmGD;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,MAAM,CAEtC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAgB,KAAK,MAAM,EAAE,KAAK,QAAQ,EAAE,MAAM,UAAU,CAAA;AACnE,OAAO,EACL,YAAY,EACZ,KAAK,EAGL,WAAW,EACX,KAAK,aAAa,EACnB,MAAM,YAAY,CAAA;AAGnB;;;;GAIG;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;AAkBD;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CAAC,UAAU,SAAS,aAAa,EACrD,UAAU,EAAE,UAAU,EACtB,EACE,MAAM,EACN,QAAkB,EAClB,eAAuB,EACvB,KAAU,GACX,GAAE;IACD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAA;IACzB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,eAAe,CAAC,EAAE,OAAO,CAAA;CACrB,GACL,YAAY,CAAC,UAAU,CAAC,CAiG1B;AA6BD;;;;;GAKG;AACH,wBAAsB,mBAAmB,CAAC,UAAU,SAAS,aAAa,EACxE,CAAC,EAAE,MAAM,EACT,MAAM,CAAC,EAAE,MAAM,EACf,KAAK,GAAE,KAAK,CAAC,UAAU,CAAM,iBA4D9B;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,MAAM,CAEtC"}

package/dist/client.js

@@ -19,13 +19,16 @@ let _clientListenerStarted = false;
  * @param options various options
  * @param options.worker if provided, the client will use this worker to post messages.
  * @param options.hooks hooks to run on messages received from the server
+ * @param options.restartListener if true, will force the listener to restart even if it has already been started
  * @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, see {@link ClientMethod}
  *
  * An example of defining and using a client:
  * {@includeCode ../example/src/routes/+page.svelte}
  */
-export function Client(procedures, { worker, loglevel = "debug", hooks = {}, } = {}) {
+export function Client(procedures, { worker, loglevel = "debug", restartListener = false, hooks = {}, } = {}) {
     const l = createLogger("client", loglevel);
+    if (restartListener)
+        _clientListenerStarted = false;
     // Store procedures on a symbol key, to avoid conflicts with procedure names
     const instance = { [zProcedures]: procedures };
     for (const functionName of Object.keys(procedures)) {
@@ -103,9 +106,10 @@ async function postMessage(l, worker, hooks, message, options) {
 /**
  * Starts the client listener, which listens for messages from the sw&rpc server.
  * @param worker if provided, the client will use this worker to listen for messages, instead of using the service worker
+ * @param force if true, will force the listener to restart even if it has already been started
  * @returns
  */
-async function startClientListener(l, worker, hooks = {}) {
+export async function startClientListener(l, worker, hooks = {}) {
     if (_clientListenerStarted)
         return;
     // Get service worker registration if no worker is provided
@@ -120,7 +124,7 @@ async function startClientListener(l, worker, hooks = {}) {
     }
     const w = worker ?? navigator.serviceWorker;
     // Start listening for messages
-    l.debug("", "Starting client listener on", w);
+    l.debug(null, "Starting client listener", { worker, w, hooks });
     w.addEventListener("message", (event) => {
         // Get the data from the event
         const eventData = event.data || {};
@@ -136,7 +140,7 @@ async function startClientListener(l, worker, hooks = {}) {
         // Get the associated pending request handlers
         const handlers = pendingRequests.get(requestId);
         if (!handlers) {
-            throw new Error(`[SWARPC Client] ${requestId} has no active request handlers`);
+            throw new Error(`[SWARPC Client] ${requestId} has no active request handlers, cannot process ${JSON.stringify(data)}`);
         }
         // React to the data received: call hook, call handler,
         // and remove the request from pendingRequests (unless it's a progress update)

package/dist/server.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAgB,KAAK,QAAQ,EAAE,MAAM,UAAU,CAAA;AACtD,OAAO,EACL,kBAAkB,EAKlB,uBAAuB,EACvB,gBAAgB,EAChB,WAAW,EACX,KAAK,aAAa,EACnB,MAAM,YAAY,CAAA;AAGnB;;;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,MAAM,GAAG,IAAI,CAAA;CACnC,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;AAKD;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CAAC,UAAU,SAAS,aAAa,EACrD,UAAU,EAAE,UAAU,EACtB,EAAE,MAAM,EAAE,QAAkB,EAAE,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,QAAQ,CAAA;CAAO,GAC5E,YAAY,CAAC,UAAU,CAAC,CA+J1B"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAgB,KAAK,QAAQ,EAAE,MAAM,UAAU,CAAA;AACtD,OAAO,EACL,kBAAkB,EAKlB,uBAAuB,EACvB,gBAAgB,EAChB,WAAW,EACX,KAAK,aAAa,EACnB,MAAM,YAAY,CAAA;AAGnB;;;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,MAAM,GAAG,IAAI,CAAA;CACnC,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;AAKD;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CAAC,UAAU,SAAS,aAAa,EACrD,UAAU,EAAE,UAAU,EACtB,EAAE,MAAM,EAAE,QAAkB,EAAE,GAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,QAAQ,CAAA;CAAO,GAC5E,YAAY,CAAC,UAAU,CAAC,CA8J1B"}

package/dist/server.js

@@ -106,16 +106,21 @@ export function Server(procedures, { worker, loglevel = "debug" } = {}) {
                 await postError("No input provided");
                 return;
             }
-            // Call the implementation with the input and a progress callback
-            await implementation(payload.input, async (progress) => {
-                l.debug(requestId, `Progress for ${functionName}`, progress);
-                await postMsg({ progress });
-            }, {
-                abortSignal: abortControllers.get(requestId)?.signal,
-                logger: createLogger("server", loglevel, requestId),
-            })
+            try {
+                // Call the implementation with the input and a progress callback
+                const result = await implementation(payload.input, async (progress) => {
+                    l.debug(requestId, `Progress for ${functionName}`, progress);
+                    await postMsg({ progress });
+                }, {
+                    abortSignal: abortControllers.get(requestId)?.signal,
+                    logger: createLogger("server", loglevel, requestId),
+                });
+                // Send results
+                l.debug(requestId, `Result for ${functionName}`, result);
+                await postMsg({ result });
+            }
+            catch (error) {
                 // Send errors
-                .catch(async (error) => {
                 // Handle errors caused by abortions
                 if ("aborted" in error) {
                     l.debug(requestId, `Received abort error for ${functionName}`, error.aborted);
@@ -123,17 +128,12 @@ export function Server(procedures, { worker, loglevel = "debug" } = {}) {
                     abortControllers.delete(requestId);
                     return;
                 }
-                l.error(requestId, `Error in ${functionName}`, error);
+                l.info(requestId, `Error in ${functionName}`, error);
                 await postError(error);
-            })
-                // Send results
-                .then(async (result) => {
-                l.debug(requestId, `Result for ${functionName}`, result);
-                await postMsg({ result });
-            })
-                .finally(() => {
+            }
+            finally {
                 abortedRequests.delete(requestId);
-            });
+            }
         });
     };
     return instance;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swarpc",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Full type-safe RPC library for service worker -- move things off of the UI thread with ease!",
   "keywords": [
     "service-workers",
@@ -58,5 +58,9 @@
     "typescript": "^5.9.2",
     "vite": "^7.0.6",
     "vitest": "^3.2.4"
+  },
+  "volta": {
+    "node": "22.18.0",
+    "npm": "11.5.2"
   }
 }

package/src/client.ts

@@ -1,5 +1,5 @@
 /**
- * @module 
+ * @module
  * @mergeModuleWith <project>
  */
 
@@ -47,8 +47,9 @@ let _clientListenerStarted = false
  * @param options various options
  * @param options.worker if provided, the client will use this worker to post messages.
  * @param options.hooks hooks to run on messages received from the server
+ * @param options.restartListener if true, will force the listener to restart even if it has already been started
  * @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, see {@link ClientMethod}
- * 
+ *
  * An example of defining and using a client:
  * {@includeCode ../example/src/routes/+page.svelte}
  */
@@ -57,11 +58,19 @@ export function Client<Procedures extends ProceduresMap>(
   {
     worker,
     loglevel = "debug",
+    restartListener = false,
     hooks = {},
-  }: { worker?: Worker; hooks?: Hooks<Procedures>; loglevel?: LogLevel } = {}
+  }: {
+    worker?: Worker
+    hooks?: Hooks<Procedures>
+    loglevel?: LogLevel
+    restartListener?: boolean
+  } = {}
 ): SwarpcClient<Procedures> {
   const l = createLogger("client", loglevel)
 
+  if (restartListener) _clientListenerStarted = false
+
   // Store procedures on a symbol key, to avoid conflicts with procedure names
   const instance = { [zProcedures]: procedures } as Partial<
     SwarpcClient<Procedures>
@@ -186,9 +195,10 @@ async function postMessage<Procedures extends ProceduresMap>(
 /**
  * Starts the client listener, which listens for messages from the sw&rpc server.
  * @param worker if provided, the client will use this worker to listen for messages, instead of using the service worker
+ * @param force if true, will force the listener to restart even if it has already been started
  * @returns
  */
-async function startClientListener<Procedures extends ProceduresMap>(
+export async function startClientListener<Procedures extends ProceduresMap>(
   l: Logger,
   worker?: Worker,
   hooks: Hooks<Procedures> = {}
@@ -210,7 +220,7 @@ async function startClientListener<Procedures extends ProceduresMap>(
   const w = worker ?? navigator.serviceWorker
 
   // Start listening for messages
-  l.debug("", "Starting client listener on", w)
+  l.debug(null, "Starting client listener", { worker, w, hooks })
   w.addEventListener("message", (event) => {
     // Get the data from the event
     const eventData = (event as MessageEvent).data || {}
@@ -230,7 +240,7 @@ async function startClientListener<Procedures extends ProceduresMap>(
     const handlers = pendingRequests.get(requestId)
     if (!handlers) {
       throw new Error(
-        `[SWARPC Client] ${requestId} has no active request handlers`
+        `[SWARPC Client] ${requestId} has no active request handlers, cannot process ${JSON.stringify(data)}`,
       )
     }
 
@@ -255,7 +265,7 @@ async function startClientListener<Procedures extends ProceduresMap>(
 
 /**
  * Generate a random request ID, used to identify requests between client and server.
- * @source 
+ * @source
  * @returns a 6-character hexadecimal string
  */
 export function makeRequestId(): string {

package/src/server.ts

@@ -45,7 +45,7 @@ const abortedRequests = new Set<string>()
  * @param options various options
  * @param options.worker if provided, the server will use this worker to post messages, instead of sending it to all clients
  * @returns a SwarpcServer instance. Each property of the procedures map will be a method, that accepts a function implementing the procedure (see {@link ProcedureImplementation}). There is also .start(), to be called after implementing all procedures.
- * 
+ *
  * An example of defining a server:
  * {@includeCode ../example/src/service-worker.ts}
  */
@@ -170,43 +170,42 @@ export function Server<Procedures extends ProceduresMap>(
         return
       }
 
-      // Call the implementation with the input and a progress callback
-      await implementation(
-        payload.input,
-        async (progress: any) => {
-          l.debug(requestId, `Progress for ${functionName}`, progress)
-          await postMsg({ progress })
-        },
-        {
-          abortSignal: abortControllers.get(requestId)?.signal,
-          logger: createLogger("server", loglevel, requestId),
-        }
-      )
-        // Send errors
-        .catch(async (error: any) => {
-          // Handle errors caused by abortions
-          if ("aborted" in error) {
-            l.debug(
-              requestId,
-              `Received abort error for ${functionName}`,
-              error.aborted
-            )
-            abortedRequests.add(requestId)
-            abortControllers.delete(requestId)
-            return
+      try {
+        // Call the implementation with the input and a progress callback
+        const result = await implementation(
+          payload.input,
+          async (progress: any) => {
+            l.debug(requestId, `Progress for ${functionName}`, progress)
+            await postMsg({ progress })
+          },
+          {
+            abortSignal: abortControllers.get(requestId)?.signal,
+            logger: createLogger("server", loglevel, requestId),
           }
+        )
 
-          l.error(requestId, `Error in ${functionName}`, error)
-          await postError(error)
-        })
         // Send results
-        .then(async (result: any) => {
-          l.debug(requestId, `Result for ${functionName}`, result)
-          await postMsg({ result })
-        })
-        .finally(() => {
-          abortedRequests.delete(requestId)
-        })
+        l.debug(requestId, `Result for ${functionName}`, result)
+        await postMsg({ result })
+      } catch (error: any) {
+        // Send errors
+        // Handle errors caused by abortions
+        if ("aborted" in error) {
+          l.debug(
+            requestId,
+            `Received abort error for ${functionName}`,
+            error.aborted
+          )
+          abortedRequests.add(requestId)
+          abortControllers.delete(requestId)
+          return
+        }
+
+        l.info(requestId, `Error in ${functionName}`, error)
+        await postError(error)
+      } finally {
+        abortedRequests.delete(requestId)
+      }
     })
   }