swarpc 0.1.2 → 0.2.0

package/README.md

@@ -1,5 +1,7 @@
 <div align=center>
-<h1>sw&rpc</h1>
+<h1>
+  <img src="./logo.svg" alt="sw&rpc" />
+</h1>
 
 RPC for Service Workers -- move that heavy computation off of your UI thread!
 

package/dist/swarpc.d.ts

@@ -10,9 +10,13 @@ export function Server<Procedures extends ProceduresMap>(procedures: Procedures)
 /**
  * @template {ProceduresMap} Procedures
  * @param {Procedures} procedures
+ * @param {object} [options]
+ * @param {Worker} [options.worker] the worker instance to connect to -- uses the navigator's service worker if not provided
  * @returns {SwarpcClient<Procedures>}
  */
-export function Client<Procedures extends ProceduresMap>(procedures: Procedures): SwarpcClient<Procedures>;
+export function Client<Procedures extends ProceduresMap>(procedures: Procedures, { worker }?: {
+    worker?: Worker;
+}): SwarpcClient<Procedures>;
 import type { ProceduresMap } from './typings.js';
 import type { SwarpcServer } from './typings.js';
 import type { SwarpcClient } from './typings.js';

package/dist/swarpc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"swarpc.d.ts","sourceRoot":"","sources":["../src/swarpc.js"],"names":[],"mappings":"AAEA;;GAEG;AAEH;;;;GAIG;AACH,uBAJ6B,UAAU,SAA1B,aAAe,cACjB,UAAU,GACR,aAAa,UAAU,CAAC,CAgFpC;AAED;;;;GAIG;AACH,uBAJ6B,UAAU,SAA1B,aAAe,cACjB,UAAU,GACR,aAAa,UAAU,CAAC,CA+BpC;mCA1H6D,cAAc;kCAAd,cAAc;kCAAd,cAAc"}
+{"version":3,"file":"swarpc.d.ts","sourceRoot":"","sources":["../src/swarpc.js"],"names":[],"mappings":"AAEA;;GAEG;AAEH;;;;GAIG;AACH,uBAJ6B,UAAU,SAA1B,aAAe,cACjB,UAAU,GACR,aAAa,UAAU,CAAC,CAsGpC;AA0DD;;;;;;GAMG;AACH,uBAN6B,UAAU,SAA1B,aAAe,cACjB,UAAU,eAElB;IAAyB,MAAM,GAAvB,MAAM;CACd,GAAU,aAAa,UAAU,CAAC,CAiCpC;mCA5M6D,cAAc;kCAAd,cAAc;kCAAd,cAAc"}

package/dist/typings.d.ts

@@ -5,7 +5,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["inferOut"]) => void) => Promise<NoInfer<S>["inferOut"] | NoInfer<S>["inferOut"]>;
 export type ProceduresMap = Record<string, Procedure<Type, Type, Type>>;
-export type ClientMethod<P extends Procedure<Type, Type, Type>> = (input: P["input"]["inferOut"], onProgress?: (progress: P["progress"]["inferOut"]) => void) => Promise<P["success"]["inferOut"]>;
+export type ClientMethod<P extends Procedure<Type, Type, Type>> = (input: P["input"]["inferIn"], onProgress?: (progress: P["progress"]["inferOut"]) => void) => Promise<P["success"]["inferOut"]>;
 export type SwarpcClient<Procedures extends ProceduresMap> = {
     procedures: Procedures;
 } & { [F in keyof Procedures]: ClientMethod<Procedures[F]>; };

package/dist/typings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typings.d.ts","sourceRoot":"","sources":["../src/typings.js"],"names":[],"mappings":"sBAKoB,CAAC,SAAR,IAAM,EACC,CAAC,SAAR,IAAM,EACC,CAAC,SAAR,IAAM;WAEL,CAAC;cACD,CAAC;aACD,CAAC;;oCAIK,CAAC,SAAR,IAAM,EACC,CAAC,SAAR,IAAM,EACC,CAAC,SAAR,IAAM,IACN,CAAC,KAAK,EAAE,CAAC,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,KAAK,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;4BAIjI,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;yBAIb,CAAC,SAA9B,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAE,IAC7B,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,KAAK,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC;yBAIhH,UAAU,SAAzB,aAAc,IACf;IAAE,UAAU,EAAE,UAAU,CAAA;CAAE,GAAG,GAAG,CAAC,IAAI,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAE;yBAIrE,UAAU,SAAzB,aAAc,IACf;IAAE,UAAU,EAAE,UAAU,CAAC;IAAC,eAAe,EAAE,GAAE,CAAC,IAAI,MAAM,UAAU,GAAG,uBAAuB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAE,CAAC;IAAC,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;CAAG,GAAG,GAAG,CAAC,IAAI,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAE,CAAC,KAAK,IAAI,GAAE;0BApC/V,SAAS"}
+{"version":3,"file":"typings.d.ts","sourceRoot":"","sources":["../src/typings.js"],"names":[],"mappings":"sBAKoB,CAAC,SAAR,IAAM,EACC,CAAC,SAAR,IAAM,EACC,CAAC,SAAR,IAAM;WAEL,CAAC;cACD,CAAC;aACD,CAAC;;oCAIK,CAAC,SAAR,IAAM,EACC,CAAC,SAAR,IAAM,EACC,CAAC,SAAR,IAAM,IACN,CAAC,KAAK,EAAE,CAAC,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,KAAK,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;4BAIjI,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;yBAIb,CAAC,SAA9B,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAE,IAC7B,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,KAAK,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC;yBAI/G,UAAU,SAAzB,aAAc,IACf;IAAE,UAAU,EAAE,UAAU,CAAA;CAAE,GAAG,GAAG,CAAC,IAAI,MAAM,UAAU,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAE;yBAIrE,UAAU,SAAzB,aAAc,IACf;IAAE,UAAU,EAAE,UAAU,CAAC;IAAC,eAAe,EAAE,GAAE,CAAC,IAAI,MAAM,UAAU,GAAG,uBAAuB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,GAAE,CAAC;IAAC,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAA;CAAG,GAAG,GAAG,CAAC,IAAI,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,OAAO,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAE,CAAC,KAAK,IAAI,GAAE;0BApC/V,SAAS"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swarpc",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Full type-safe RPC library for service worker -- move things off of the UI thread with ease!",
   "keywords": [
     "service-workers",
@@ -28,12 +28,14 @@
   "types": "dist/swarpc.d.ts",
   "scripts": {
     "build": "tsc",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "typedoc": "typedoc src/swarpc.js src/typings.js --readme README.md"
   },
   "dependencies": {
     "arktype": "^2.1.20"
   },
   "devDependencies": {
+    "typedoc": "^0.28.7",
     "typescript": "^5.8.3"
   }
 }

package/src/swarpc.js

@@ -7,9 +7,11 @@ import { type } from "arktype"
 /**
  * @template {ProceduresMap} Procedures
  * @param {Procedures} procedures
+ * @param {object} [options]
+ * @param {Worker} [options.worker] the worker instance to connect to -- uses the navigator's service worker if not provided
  * @returns {SwarpcServer<Procedures>}
  */
-export function Server(procedures) {
+export function Server(procedures, { worker } = { worker: undefined }) {
   /** @type {SwarpcServer<Procedures>}  */
   // @ts-expect-error
   const instance = {
@@ -35,6 +37,7 @@ export function Server(procedures) {
   const PayloadSchema = type.or(
     ...Object.entries(procedures).map(([functionName, { input }]) => ({
       functionName: type(`"${functionName}"`),
+      requestId: type("string >= 1"),
       input,
     }))
   )
@@ -48,18 +51,26 @@ export function Server(procedures) {
      * @param {{functionName: string} & Partial<{ result: any; error: any; progress: any }>} data
      */
     const postMessage = async (data) => {
-      await self.clients
-        .matchAll()
-        .then((clients) =>
+      if (worker) {
+        self.postMessage(data)
+      } else {
+        await self.clients.matchAll().then((clients) => {
+          console.debug(`[SWARPC Server] Posting message to clients`, clients)
           clients.forEach((client) => client.postMessage(data))
-        )
+        })
+      }
     }
 
     console.log("[SWARPC Server] Starting message listener on", self)
 
     self.addEventListener("message", async (event) => {
-      const { functionName, input } = PayloadSchema.assert(event.data)
-      console.log("[SWARPC Server] Running", functionName, "with", input)
+      const { functionName, requestId, input } = PayloadSchema.assert(
+        event.data
+      )
+      console.log(
+        `[SWARPC Server] ${requestId} Running ${functionName} with`,
+        input
+      )
 
       /**
        * @param {*} error
@@ -67,6 +78,7 @@ export function Server(procedures) {
       const postError = async (error) =>
         postMessage({
           functionName,
+          requestId,
           error: {
             message: "message" in error ? error.message : String(error),
           },
@@ -78,23 +90,97 @@ export function Server(procedures) {
         return
       }
 
-      await implementation(input, async (progress) =>
-        postMessage({ functionName, progress })
-      )
-        .catch(async (error) => postError(error))
-        .then(async (result) => postMessage({ functionName, result }))
+      await implementation(input, async (progress) => {
+        console.debug(
+          `[SWARPC Server] ${requestId} Progress for ${functionName}:`,
+          progress
+        )
+        await postMessage({ functionName, requestId, progress })
+      })
+        .catch(async (error) => {
+          console.debug(
+            `[SWARPC Server] ${requestId} Error in ${functionName}:`,
+            error
+          )
+          await postError(error)
+        })
+        .then(async (result) => {
+          console.debug(
+            `[SWARPC Server] ${requestId} Result for ${functionName}:`,
+            result
+          )
+          await postMessage({ functionName, requestId, result })
+        })
     })
   }
 
   return instance
 }
 
+function generateRequestId() {
+  return Math.random().toString(36).substring(2, 15)
+}
+
+/**
+ * @type {Map<string, { reject: (err: Error) => void; onProgress: (progress: any) => void; resolve: (result: any) => void }>}
+ */
+const pendingRequests = new Map()
+
+let _clientListenerStarted = false
+/**
+ * @param {Worker} [worker] the worker instance to connect to -- uses the navigator's service worker if not provided
+ */
+async function startClientListener(worker) {
+  if (_clientListenerStarted) return
+
+  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) {
+      console.warn("[SWARPC Client] Service Worker is not controlling the page")
+    }
+  }
+
+  const w = worker ?? navigator.serviceWorker
+  console.debug("[SWARPC Client] Registering message listener for client", w)
+
+  w.addEventListener("message", (event) => {
+    const { functionName, requestId, ...data } = event.data || {}
+    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`
+      )
+    }
+
+    if ("error" in data) {
+      handlers.reject(new Error(data.error.message))
+      pendingRequests.delete(requestId)
+    } else if ("progress" in data) {
+      handlers.onProgress(data.progress)
+    } else if ("result" in data) {
+      handlers.resolve(data.result)
+      pendingRequests.delete(requestId)
+    }
+  })
+
+  _clientListenerStarted = true
+}
+
 /**
  * @template {ProceduresMap} Procedures
  * @param {Procedures} procedures
+ * @param {object} [options]
+ * @param {Worker} [options.worker] the worker instance to connect to -- uses the navigator's service worker if not provided
  * @returns {SwarpcClient<Procedures>}
  */
-export function Client(procedures) {
+export function Client(procedures, { worker } = { worker: undefined }) {
   /** @type {SwarpcClient<Procedures>} */
   // @ts-expect-error
   const instance = { procedures }
@@ -102,22 +188,25 @@ export function Client(procedures) {
   for (const functionName of Object.keys(procedures)) {
     instance[functionName] = async (input, onProgress = () => {}) => {
       procedures[functionName].input.assert(input)
-      console.log("[SWARPC Client] Calling", functionName, "with", input)
-      navigator.serviceWorker.controller?.postMessage({ functionName, input })
+      await startClientListener(worker)
+
+      const w =
+        worker ?? (await navigator.serviceWorker.ready.then((r) => r.active))
       return new Promise((resolve, reject) => {
-        navigator.serviceWorker.addEventListener("message", (event) => {
-          const { functionName: fn, ...data } = event.data
-
-          if (fn !== functionName) return
-
-          if ("error" in data) {
-            reject(new Error(data.error.message))
-          } else if ("progress" in data) {
-            onProgress(data.progress)
-          } else if ("result" in data) {
-            resolve(data.result)
-          }
-        })
+        if (!worker && !navigator.serviceWorker.controller)
+          console.warn(
+            "[SWARPC Client] Service Worker is not controlling the page"
+          )
+
+        const requestId = generateRequestId()
+
+        pendingRequests.set(requestId, { resolve, onProgress, reject })
+
+        console.log(
+          `[SWARPC Client] ${requestId} Requesting ${functionName} with`,
+          input
+        )
+        w.postMessage({ functionName, input, requestId })
       })
     }
   }

package/src/typings.js

@@ -25,7 +25,7 @@
 
 /**
  * @template {Procedure<Type, Type, Type>} P
- * @typedef {(input: P['input']['inferOut'], onProgress?: (progress: P['progress']['inferOut']) => void) => Promise<P['success']['inferOut']>} ClientMethod
+ * @typedef {(input: P['input']['inferIn'], onProgress?: (progress: P['progress']['inferOut']) => void) => Promise<P['success']['inferOut']>} ClientMethod
  */
 
 /**