swarpc 0.9.0 → 0.10.0

package/dist/client.d.ts

@@ -3,7 +3,7 @@
  * @mergeModuleWith <project>
  */
 import { type Logger, type LogLevel } from "./log.js";
-import { ClientMethod, Hooks, zProcedures, type ProceduresMap } from "./types.js";
+import { ClientMethod, Hooks, Payload, zProcedures, type ProceduresMap } from "./types.js";
 /**
  * The sw&rpc client instance, which provides {@link ClientMethod | methods to call procedures}.
  * Each property of the procedures map will be a method, that accepts an input, an optional onProgress callback and an optional request ID.
@@ -18,27 +18,40 @@ export type SwarpcClient<Procedures extends ProceduresMap> = {
  *
  * @param procedures procedures the client will be able to call, see {@link 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
+ * @param options.worker The instantiated worker object. If not provided, the client will use the service worker.
+ * Example: `new Worker("./worker.js")`
+ * See {@link Worker} (used by both dedicated workers and service workers), {@link SharedWorker}, and
+ * the different [worker types](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API#worker_types) that exist
+ * @param options.hooks Hooks to run on messages received from the server. See {@link Hooks}
+ * @param options.loglevel Maximum log level to use, defaults to "debug" (shows everything). "info" will not show debug messages, "warn" will only show warnings and errors, "error" will only show errors.
+ * @param options.restartListener If true, will force the listener to restart even if it has already been started. You should probably leave this to false, unless you are testing and want to reset the client state.
  * @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, restartListener, hooks, }?: {
-    worker?: Worker;
+    worker?: Worker | SharedWorker;
     hooks?: Hooks<Procedures>;
     loglevel?: LogLevel;
     restartListener?: boolean;
 }): SwarpcClient<Procedures>;
+/**
+ * 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.
+ * @param l
+ * @param worker
+ * @param message
+ * @param options
+ */
+export declare function postMessageSync<Procedures extends ProceduresMap>(l: Logger, worker: Worker | SharedWorker | undefined, message: Payload<Procedures>, options?: StructuredSerializeOptions): void;
 /**
  * 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>;
+export declare function startClientListener<Procedures extends ProceduresMap>(l: Logger, worker?: Worker | SharedWorker, 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,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"}
+{"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,EACL,OAAO,EAEP,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;;;;;;;;;;;;;;;GAeG;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,GAAG,YAAY,CAAA;IAC9B,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,CAsG1B;AAiCD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,UAAU,SAAS,aAAa,EAC9D,CAAC,EAAE,MAAM,EACT,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,EACzC,OAAO,EAAE,OAAO,CAAC,UAAU,CAAC,EAC5B,OAAO,CAAC,EAAE,0BAA0B,GACnC,IAAI,CAiBN;AAED;;;;;GAKG;AACH,wBAAsB,mBAAmB,CAAC,UAAU,SAAS,aAAa,EACxE,CAAC,EAAE,MAAM,EACT,MAAM,CAAC,EAAE,MAAM,GAAG,YAAY,EAC9B,KAAK,GAAE,KAAK,CAAC,UAAU,CAAM,iBAmE9B;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,MAAM,CAEtC"}

package/dist/client.js

@@ -17,9 +17,13 @@ let _clientListenerStarted = false;
  *
  * @param procedures procedures the client will be able to call, see {@link 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
+ * @param options.worker The instantiated worker object. If not provided, the client will use the service worker.
+ * Example: `new Worker("./worker.js")`
+ * See {@link Worker} (used by both dedicated workers and service workers), {@link SharedWorker}, and
+ * the different [worker types](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API#worker_types) that exist
+ * @param options.hooks Hooks to run on messages received from the server. See {@link Hooks}
+ * @param options.loglevel Maximum log level to use, defaults to "debug" (shows everything). "info" will not show debug messages, "warn" will only show warnings and errors, "error" will only show errors.
+ * @param options.restartListener If true, will force the listener to restart even if it has already been started. You should probably leave this to false, unless you are testing and want to reset the client state.
  * @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:
@@ -63,7 +67,7 @@ export function Client(procedures, { worker, loglevel = "debug", restartListener
                     : [];
                 // Post the message to the server
                 l.debug(requestId, `Requesting ${functionName} with`, input);
-                send(requestId, { input }, { transfer })
+                return send(requestId, { input }, { transfer })
                     .then(() => { })
                     .catch(reject);
             });
@@ -74,13 +78,18 @@ export function Client(procedures, { worker, loglevel = "debug", restartListener
             const requestId = makeRequestId();
             return {
                 request: _runProcedure(input, onProgress, requestId),
-                async cancel(reason) {
+                cancel(reason) {
                     if (!pendingRequests.has(requestId)) {
                         l.warn(requestId, `Cannot cancel ${functionName} request, it has already been resolved or rejected`);
                         return;
                     }
                     l.debug(requestId, `Cancelling ${functionName} with`, reason);
-                    await send(requestId, { abort: { reason } });
+                    postMessageSync(l, worker, {
+                        by: "sw&rpc",
+                        requestId,
+                        functionName,
+                        abort: { reason },
+                    });
                     pendingRequests.delete(requestId);
                 },
             };
@@ -97,7 +106,33 @@ async function postMessage(l, worker, hooks, message, options) {
     if (!worker && !navigator.serviceWorker.controller)
         l.warn("", "Service Worker is not controlling the page");
     // If no worker is provided, we use the service worker
-    const w = worker ?? (await navigator.serviceWorker.ready.then((r) => r.active));
+    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);
+}
+/**
+ * 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.
+ * @param l
+ * @param worker
+ * @param message
+ * @param options
+ */
+export function postMessageSync(l, worker, message, options) {
+    if (!worker && !navigator.serviceWorker.controller)
+        l.warn("", "Service Worker is not controlling the page");
+    // If no worker is provided, we use the service worker
+    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");
     }
@@ -125,7 +160,7 @@ export async function startClientListener(l, worker, hooks = {}) {
     const w = worker ?? navigator.serviceWorker;
     // Start listening for messages
     l.debug(null, "Starting client listener", { worker, w, hooks });
-    w.addEventListener("message", (event) => {
+    const listener = (event) => {
         // Get the data from the event
         const eventData = event.data || {};
         // Ignore other messages that aren't for us
@@ -158,7 +193,14 @@ export async function startClientListener(l, worker, hooks = {}) {
             handlers.resolve(data.result);
             pendingRequests.delete(requestId);
         }
-    });
+    };
+    if (w instanceof SharedWorker) {
+        w.port.addEventListener("message", listener);
+        w.port.start();
+    }
+    else {
+        w.addEventListener("message", listener);
+    }
     _clientListenerStarted = true;
 }
 /**

package/dist/server.d.ts

@@ -11,7 +11,7 @@ import { ImplementationsMap, ProcedureImplementation, zImplementations, zProcedu
 export type SwarpcServer<Procedures extends ProceduresMap> = {
     [zProcedures]: Procedures;
     [zImplementations]: ImplementationsMap<Procedures>;
-    start(self: Window | Worker): void;
+    start(): Promise<void>;
 } & {
     [F in keyof Procedures]: (impl: ProcedureImplementation<Procedures[F]["input"], Procedures[F]["progress"], Procedures[F]["success"]>) => void;
 };
@@ -19,14 +19,17 @@ export type SwarpcServer<Procedures extends ProceduresMap> = {
  * Creates a sw&rpc server instance.
  * @param procedures procedures the server will implement, see {@link ProceduresMap}
  * @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
+ * @param options.worker The worker scope to use, defaults to the `self` of the file where Server() is called.
+ * @param options.loglevel Maximum log level to use, defaults to "debug" (shows everything). "info" will not show debug messages, "warn" will only show warnings and errors, "error" will only show errors.
+ * @param options._scopeType @internal Don't touch, this is used in testing environments because the mock is subpar. Manually overrides worker scope type detection.
  * @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}
  */
-export declare function Server<Procedures extends ProceduresMap>(procedures: Procedures, { worker, loglevel }?: {
-    worker?: Worker;
+export declare function Server<Procedures extends ProceduresMap>(procedures: Procedures, { loglevel, scope, _scopeType, }?: {
+    scope?: WorkerGlobalScope;
     loglevel?: LogLevel;
+    _scopeType?: "dedicated" | "shared" | "service";
 }): SwarpcServer<Procedures>;
 //# sourceMappingURL=server.d.ts.map

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,CA8J1B"}
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,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;AAgBnB;;;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,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CACvB,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;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CAAC,UAAU,SAAS,aAAa,EACrD,UAAU,EAAE,UAAU,EACtB,EACE,QAAkB,EAClB,KAAK,EACL,UAAU,GACX,GAAE;IACD,KAAK,CAAC,EAAE,iBAAiB,CAAA;IACzB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,UAAU,CAAC,EAAE,WAAW,GAAG,QAAQ,GAAG,SAAS,CAAA;CAC3C,GACL,YAAY,CAAC,UAAU,CAAC,CAgN1B"}

package/dist/server.js

@@ -2,31 +2,52 @@
  * @module
  * @mergeModuleWith <project>
  */
+/// <reference lib="webworker" />
 import { type } from "arktype";
 import { createLogger } from "./log.js";
 import { PayloadHeaderSchema, PayloadSchema, zImplementations, zProcedures, } from "./types.js";
 import { findTransferables } from "./utils.js";
+class MockedWorkerGlobalScope {
+    constructor() { }
+}
+const SharedWorkerGlobalScope = globalThis.SharedWorkerGlobalScope ?? MockedWorkerGlobalScope;
+const DedicatedWorkerGlobalScope = globalThis.DedicatedWorkerGlobalScope ?? MockedWorkerGlobalScope;
+const ServiceWorkerGlobalScope = globalThis.ServiceWorkerGlobalScope ?? MockedWorkerGlobalScope;
 const abortControllers = new Map();
 const abortedRequests = new Set();
 /**
  * Creates a sw&rpc server instance.
  * @param procedures procedures the server will implement, see {@link ProceduresMap}
  * @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
+ * @param options.worker The worker scope to use, defaults to the `self` of the file where Server() is called.
+ * @param options.loglevel Maximum log level to use, defaults to "debug" (shows everything). "info" will not show debug messages, "warn" will only show warnings and errors, "error" will only show errors.
+ * @param options._scopeType @internal Don't touch, this is used in testing environments because the mock is subpar. Manually overrides worker scope type detection.
  * @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}
  */
-export function Server(procedures, { worker, loglevel = "debug" } = {}) {
+export function Server(procedures, { loglevel = "debug", scope, _scopeType, } = {}) {
     const l = createLogger("server", loglevel);
+    // If scope is not provided, use the global scope
+    // This function is meant to be used in a worker, so `self` is a WorkerGlobalScope
+    scope ??= self;
+    function scopeIsShared(scope) {
+        return scope instanceof SharedWorkerGlobalScope || _scopeType === "shared";
+    }
+    function scopeIsDedicated(scope) {
+        return (scope instanceof DedicatedWorkerGlobalScope || _scopeType === "dedicated");
+    }
+    function scopeIsService(scope) {
+        return scope instanceof ServiceWorkerGlobalScope || _scopeType === "service";
+    }
     // Initialize the instance.
     // Procedures and implementations are stored on properties with symbol keys,
     // to avoid any conflicts with procedure names, and also discourage direct access to them.
     const instance = {
         [zProcedures]: procedures,
         [zImplementations]: {},
-        start: (self) => { },
+        start: async () => { },
     };
     // Set all implementation-setter methods
     for (const functionName in procedures) {
@@ -47,21 +68,32 @@ export function Server(procedures, { worker, loglevel = "debug" } = {}) {
             };
         });
     }
-    instance.start = (self) => {
+    instance.start = async () => {
+        const port = await new Promise((resolve) => {
+            if (!scopeIsShared(scope))
+                return resolve(undefined);
+            console.log("Awaiting shared worker connection...");
+            scope.addEventListener("connect", ({ ports: [port] }) => {
+                console.log("Shared worker connected with port", port);
+                resolve(port);
+            });
+        });
         // Used to post messages back to the client
         const postMessage = async (autotransfer, data) => {
             const transfer = autotransfer ? [] : findTransferables(data);
-            if (worker) {
-                self.postMessage(data, { transfer });
+            if (port) {
+                port.postMessage(data, { transfer });
             }
-            else {
-                await self.clients.matchAll().then((clients) => {
+            else if (scopeIsDedicated(scope)) {
+                scope.postMessage(data, { transfer });
+            }
+            else if (scopeIsService(scope)) {
+                await scope.clients.matchAll().then((clients) => {
                     clients.forEach((client) => client.postMessage(data, { transfer }));
                 });
             }
         };
-        // Listen for messages from the client
-        self.addEventListener("message", async (event) => {
+        const listener = async (event) => {
             // Decode the payload
             const { requestId, functionName } = PayloadHeaderSchema(type.enumerated(...Object.keys(procedures))).assert(event.data);
             l.debug(requestId, `Received request for ${functionName}`, event.data);
@@ -134,7 +166,24 @@ export function Server(procedures, { worker, loglevel = "debug" } = {}) {
             finally {
                 abortedRequests.delete(requestId);
             }
-        });
+        };
+        // Listen for messages from the client
+        if (scopeIsShared(scope)) {
+            if (!port)
+                throw new Error("SharedWorker port not initialized");
+            console.log("Listening for shared worker messages on port", port);
+            port.addEventListener("message", listener);
+            port.start();
+        }
+        else if (scopeIsDedicated(scope)) {
+            scope.addEventListener("message", listener);
+        }
+        else if (scopeIsService(scope)) {
+            scope.addEventListener("message", listener);
+        }
+        else {
+            throw new Error(`Unsupported worker scope ${scope}`);
+        }
     };
     return instance;
 }

package/dist/types.d.ts

@@ -48,7 +48,7 @@ export type CancelablePromise<T = unknown> = {
      * Abort the request.
      * @param reason The reason for cancelling the request.
      */
-    cancel: (reason: string) => Promise<void>;
+    cancel: (reason: string) => void;
 };
 /**
  * An implementation of a procedure

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAQ,KAAK,IAAI,EAAE,MAAM,SAAS,CAAA;AACzC,OAAO,EAAU,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAErD;;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;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,OAAO,IAAI;IAC3C,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;IACnB;;;OAGG;IACH,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1C,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,CACjC,CAAC,SAAS,IAAI,EACd,CAAC,SAAS,IAAI,EACd,CAAC,SAAS,IAAI,IACZ;AACF;;GAEG;AACH,KAAK,EAAE,CAAC,CAAC,UAAU,CAAC;AACpB;;GAEG;AACH,UAAU,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI;AAC5C;;GAEG;AACH,KAAK,EAAE;IACL;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAA;CAC3B,KACE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAA;AAE1B;;;;;GAKG;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;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;UAI9B,CAAA;AAEF,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;CAClB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;UAM5B,CAAA;AAEF,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,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CAC1B,GACD;IACE,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAC3B,CAAA;AAEL;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMtB,CAAA;AAEJ;;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,CAAC,CACjE,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,CAAC,GAAG;IACxC;;OAEG;IACH,UAAU,EAAE,CACV,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,EAC1D,SAAS,CAAC,EAAE,MAAM,KACf,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC,CAAA;CACjD,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,eAAmC,CAAA;AAEhE;;;;GAIG;AACH,eAAO,MAAM,WAAW,eAA8B,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAQ,KAAK,IAAI,EAAE,MAAM,SAAS,CAAA;AACzC,OAAO,EAAU,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAErD;;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;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,OAAO,IAAI;IAC3C,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;IACnB;;;OAGG;IACH,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAA;CACjC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,CACjC,CAAC,SAAS,IAAI,EACd,CAAC,SAAS,IAAI,EACd,CAAC,SAAS,IAAI,IACZ;AACF;;GAEG;AACH,KAAK,EAAE,CAAC,CAAC,UAAU,CAAC;AACpB;;GAEG;AACH,UAAU,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI;AAC5C;;GAEG;AACH,KAAK,EAAE;IACL;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAA;IACzB;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAA;CAC3B,KACE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAA;AAE1B;;;;;GAKG;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;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;UAI9B,CAAA;AAEF,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;CAClB,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;UAM5B,CAAA;AAEF,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,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CAC1B,GACD;IACE,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAC3B,CAAA;AAEL;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMtB,CAAA;AAEJ;;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,CAAC,CACjE,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,CAAC,GAAG;IACxC;;OAEG;IACH,UAAU,EAAE,CACV,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,EAC1D,SAAS,CAAC,EAAE,MAAM,KACf,iBAAiB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC,CAAA;CACjD,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,eAAmC,CAAA;AAEhE;;;;GAIG;AACH,eAAO,MAAM,WAAW,eAA8B,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swarpc",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Full type-safe RPC library for service worker -- move things off of the UI thread with ease!",
   "keywords": [
     "service-workers",
@@ -50,10 +50,10 @@
     "sirv-cli": "^3.0.1",
     "typedoc": "^0.28.9",
     "typedoc-material-theme": "^1.4.0",
-    "typedoc-plugin-dt-links": "^2.0.12",
+    "typedoc-plugin-dt-links": "^2.0.13",
     "typedoc-plugin-extras": "^4.0.1",
     "typedoc-plugin-inline-sources": "^1.3.0",
-    "typedoc-plugin-mdn-links": "^5.0.6",
+    "typedoc-plugin-mdn-links": "^5.0.7",
     "typedoc-plugin-redirect": "^1.2.0",
     "typescript": "^5.9.2",
     "vite": "^7.0.6",

package/src/client.ts

@@ -45,9 +45,13 @@ let _clientListenerStarted = false
  *
  * @param procedures procedures the client will be able to call, see {@link 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
+ * @param options.worker The instantiated worker object. If not provided, the client will use the service worker.
+ * Example: `new Worker("./worker.js")`
+ * See {@link Worker} (used by both dedicated workers and service workers), {@link SharedWorker}, and
+ * the different [worker types](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API#worker_types) that exist
+ * @param options.hooks Hooks to run on messages received from the server. See {@link Hooks}
+ * @param options.loglevel Maximum log level to use, defaults to "debug" (shows everything). "info" will not show debug messages, "warn" will only show warnings and errors, "error" will only show errors.
+ * @param options.restartListener If true, will force the listener to restart even if it has already been started. You should probably leave this to false, unless you are testing and want to reset the client state.
  * @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:
@@ -61,7 +65,7 @@ export function Client<Procedures extends ProceduresMap>(
     restartListener = false,
     hooks = {},
   }: {
-    worker?: Worker
+    worker?: Worker | SharedWorker
     hooks?: Hooks<Procedures>
     loglevel?: LogLevel
     restartListener?: boolean
@@ -133,7 +137,7 @@ export function Client<Procedures extends ProceduresMap>(
 
         // Post the message to the server
         l.debug(requestId, `Requesting ${functionName} with`, input)
-        send(requestId, { input }, { transfer })
+        return send(requestId, { input }, { transfer })
           .then(() => {})
           .catch(reject)
       })
@@ -145,7 +149,7 @@ export function Client<Procedures extends ProceduresMap>(
       const requestId = makeRequestId()
       return {
         request: _runProcedure(input, onProgress, requestId),
-        async cancel(reason: string) {
+        cancel(reason: string) {
           if (!pendingRequests.has(requestId)) {
             l.warn(
               requestId,
@@ -155,7 +159,12 @@ export function Client<Procedures extends ProceduresMap>(
           }
 
           l.debug(requestId, `Cancelling ${functionName} with`, reason)
-          await send(requestId, { abort: { reason } })
+          postMessageSync(l, worker, {
+            by: "sw&rpc",
+            requestId,
+            functionName,
+            abort: { reason },
+          })
           pendingRequests.delete(requestId)
         },
       }
@@ -171,7 +180,7 @@ export function Client<Procedures extends ProceduresMap>(
  */
 async function postMessage<Procedures extends ProceduresMap>(
   l: Logger,
-  worker: Worker | undefined,
+  worker: Worker | SharedWorker | undefined,
   hooks: Hooks<Procedures>,
   message: Payload<Procedures>,
   options?: StructuredSerializeOptions
@@ -183,7 +192,43 @@ async function postMessage<Procedures extends ProceduresMap>(
 
   // If no worker is provided, we use the service worker
   const w =
-    worker ?? (await navigator.serviceWorker.ready.then((r) => r.active))
+    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)
+}
+
+/**
+ * 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.
+ * @param l
+ * @param worker
+ * @param message
+ * @param options
+ */
+export function postMessageSync<Procedures extends ProceduresMap>(
+  l: Logger,
+  worker: Worker | SharedWorker | undefined,
+  message: Payload<Procedures>,
+  options?: StructuredSerializeOptions
+): void {
+  if (!worker && !navigator.serviceWorker.controller)
+    l.warn("", "Service Worker is not controlling the page")
+
+  // If no worker is provided, we use the service worker
+  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")
@@ -200,7 +245,7 @@ async function postMessage<Procedures extends ProceduresMap>(
  */
 export async function startClientListener<Procedures extends ProceduresMap>(
   l: Logger,
-  worker?: Worker,
+  worker?: Worker | SharedWorker,
   hooks: Hooks<Procedures> = {}
 ) {
   if (_clientListenerStarted) return
@@ -221,7 +266,7 @@ export async function startClientListener<Procedures extends ProceduresMap>(
 
   // Start listening for messages
   l.debug(null, "Starting client listener", { worker, w, hooks })
-  w.addEventListener("message", (event) => {
+  const listener = (event: Event): void => {
     // Get the data from the event
     const eventData = (event as MessageEvent).data || {}
 
@@ -240,7 +285,7 @@ export async function startClientListener<Procedures extends ProceduresMap>(
     const handlers = pendingRequests.get(requestId)
     if (!handlers) {
       throw new Error(
-        `[SWARPC Client] ${requestId} has no active request handlers, cannot process ${JSON.stringify(data)}`,
+        `[SWARPC Client] ${requestId} has no active request handlers, cannot process ${JSON.stringify(data)}`
       )
     }
 
@@ -258,7 +303,14 @@ export async function startClientListener<Procedures extends ProceduresMap>(
       handlers.resolve(data.result)
       pendingRequests.delete(requestId)
     }
-  })
+  }
+
+  if (w instanceof SharedWorker) {
+    w.port.addEventListener("message", listener)
+    w.port.start()
+  } else {
+    w.addEventListener("message", listener)
+  }
 
   _clientListenerStarted = true
 }

package/src/server.ts

@@ -3,6 +3,7 @@
  * @mergeModuleWith <project>
  */
 
+/// <reference lib="webworker" />
 import { type } from "arktype"
 import { createLogger, type LogLevel } from "./log.js"
 import {
@@ -18,6 +19,19 @@ import {
 } from "./types.js"
 import { findTransferables } from "./utils.js"
 
+class MockedWorkerGlobalScope {
+  constructor() {}
+}
+
+const SharedWorkerGlobalScope =
+  globalThis.SharedWorkerGlobalScope ?? MockedWorkerGlobalScope
+
+const DedicatedWorkerGlobalScope =
+  globalThis.DedicatedWorkerGlobalScope ?? MockedWorkerGlobalScope
+
+const ServiceWorkerGlobalScope =
+  globalThis.ServiceWorkerGlobalScope ?? MockedWorkerGlobalScope
+
 /**
  * The sw&rpc server instance, which provides methods to register {@link ProcedureImplementation | procedure implementations},
  * and listens for incoming messages that call those procedures
@@ -25,7 +39,7 @@ import { findTransferables } from "./utils.js"
 export type SwarpcServer<Procedures extends ProceduresMap> = {
   [zProcedures]: Procedures
   [zImplementations]: ImplementationsMap<Procedures>
-  start(self: Window | Worker): void
+  start(): Promise<void>
 } & {
   [F in keyof Procedures]: (
     impl: ProcedureImplementation<
@@ -43,7 +57,9 @@ const abortedRequests = new Set<string>()
  * Creates a sw&rpc server instance.
  * @param procedures procedures the server will implement, see {@link ProceduresMap}
  * @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
+ * @param options.worker The worker scope to use, defaults to the `self` of the file where Server() is called.
+ * @param options.loglevel Maximum log level to use, defaults to "debug" (shows everything). "info" will not show debug messages, "warn" will only show warnings and errors, "error" will only show errors.
+ * @param options._scopeType @internal Don't touch, this is used in testing environments because the mock is subpar. Manually overrides worker scope type detection.
  * @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:
@@ -51,17 +67,49 @@ const abortedRequests = new Set<string>()
  */
 export function Server<Procedures extends ProceduresMap>(
   procedures: Procedures,
-  { worker, loglevel = "debug" }: { worker?: Worker; loglevel?: LogLevel } = {}
+  {
+    loglevel = "debug",
+    scope,
+    _scopeType,
+  }: {
+    scope?: WorkerGlobalScope
+    loglevel?: LogLevel
+    _scopeType?: "dedicated" | "shared" | "service"
+  } = {}
 ): SwarpcServer<Procedures> {
   const l = createLogger("server", loglevel)
 
+  // If scope is not provided, use the global scope
+  // This function is meant to be used in a worker, so `self` is a WorkerGlobalScope
+  scope ??= self as WorkerGlobalScope
+
+  function scopeIsShared(
+    scope: WorkerGlobalScope
+  ): scope is SharedWorkerGlobalScope {
+    return scope instanceof SharedWorkerGlobalScope || _scopeType === "shared"
+  }
+
+  function scopeIsDedicated(
+    scope: WorkerGlobalScope
+  ): scope is DedicatedWorkerGlobalScope {
+    return (
+      scope instanceof DedicatedWorkerGlobalScope || _scopeType === "dedicated"
+    )
+  }
+
+  function scopeIsService(
+    scope: WorkerGlobalScope
+  ): scope is ServiceWorkerGlobalScope {
+    return scope instanceof ServiceWorkerGlobalScope || _scopeType === "service"
+  }
+
   // Initialize the instance.
   // Procedures and implementations are stored on properties with symbol keys,
   // to avoid any conflicts with procedure names, and also discourage direct access to them.
   const instance = {
     [zProcedures]: procedures,
     [zImplementations]: {} as ImplementationsMap<Procedures>,
-    start: (self: Window) => {},
+    start: async () => {},
   } as SwarpcServer<Procedures>
 
   // Set all implementation-setter methods
@@ -85,7 +133,16 @@ export function Server<Procedures extends ProceduresMap>(
     }) as SwarpcServer<Procedures>[typeof functionName]
   }
 
-  instance.start = (self: Window) => {
+  instance.start = async () => {
+    const port = await new Promise<MessagePort | undefined>((resolve) => {
+      if (!scopeIsShared(scope)) return resolve(undefined)
+      console.log("Awaiting shared worker connection...")
+      scope.addEventListener("connect", ({ ports: [port] }) => {
+        console.log("Shared worker connected with port", port)
+        resolve(port)
+      })
+    })
+
     // Used to post messages back to the client
     const postMessage = async (
       autotransfer: boolean,
@@ -93,17 +150,20 @@ export function Server<Procedures extends ProceduresMap>(
     ) => {
       const transfer = autotransfer ? [] : findTransferables(data)
 
-      if (worker) {
-        self.postMessage(data, { transfer })
-      } else {
-        await (self as any).clients.matchAll().then((clients: any[]) => {
+      if (port) {
+        port.postMessage(data, { transfer })
+      } else if (scopeIsDedicated(scope)) {
+        scope.postMessage(data, { transfer })
+      } else if (scopeIsService(scope)) {
+        await scope.clients.matchAll().then((clients) => {
           clients.forEach((client) => client.postMessage(data, { transfer }))
         })
       }
     }
 
-    // Listen for messages from the client
-    self.addEventListener("message", async (event: MessageEvent) => {
+    const listener = async (
+      event: MessageEvent<any> | ExtendableMessageEvent
+    ): Promise<void> => {
       // Decode the payload
       const { requestId, functionName } = PayloadHeaderSchema(
         type.enumerated(...Object.keys(procedures))
@@ -206,7 +266,21 @@ export function Server<Procedures extends ProceduresMap>(
       } finally {
         abortedRequests.delete(requestId)
       }
-    })
+    }
+
+    // Listen for messages from the client
+    if (scopeIsShared(scope)) {
+      if (!port) throw new Error("SharedWorker port not initialized")
+      console.log("Listening for shared worker messages on port", port)
+      port.addEventListener("message", listener)
+      port.start()
+    } else if (scopeIsDedicated(scope)) {
+      scope.addEventListener("message", listener)
+    } else if (scopeIsService(scope)) {
+      scope.addEventListener("message", listener)
+    } else {
+      throw new Error(`Unsupported worker scope ${scope}`)
+    }
   }
 
   return instance

package/src/types.ts

@@ -51,7 +51,7 @@ export type CancelablePromise<T = unknown> = {
    * Abort the request.
    * @param reason The reason for cancelling the request.
    */
-  cancel: (reason: string) => Promise<void>
+  cancel: (reason: string) => void
 }
 
 /**
@@ -87,7 +87,7 @@ export type ProcedureImplementation<
 
 /**
  * Declarations of procedures by name.
- * 
+ *
  * An example of declaring procedures:
  * {@includeCode ../example/src/lib/procedures.ts}
  */