swarpc 0.9.0 → 0.11.0

package/README.md

@@ -15,6 +15,24 @@ RPC for Service Workers -- move that heavy computation off of your UI thread!
 npm add swarpc arktype
 ```
 
+### Bleeding edge
+
+If you want to use the latest commit instead of a published version, you can, either by using the Git URL:
+
+```bash
+npm add git+https://github.com/gwennlbh/swarpc.git
+```
+
+Or by straight up cloning the repository and pointing to the local directory (very useful to hack on sw&rpc while testing out your changes on a more substantial project):
+
+```bash
+mkdir -p vendored
+git clone https://github.com/gwennlbh/swarpc.git vendored/swarpc
+npm add file:vendored/swarpc
+```
+
+This works thanks to the fact that `dist/` is published on the repository (and kept up to date with a CI workflow).
+
 ## Usage
 
 ### 1. Declare your procedures in a shared file

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.
@@ -14,35 +14,63 @@ export type SwarpcClient<Procedures extends ProceduresMap> = {
 } & {
     [F in keyof Procedures]: ClientMethod<Procedures[F]>;
 };
+/**
+ * Context for passing around data useful for requests
+ */
+type Context<Procedures extends ProceduresMap> = {
+    /** A logger, bound to the client */
+    logger: Logger;
+    /** The worker instance to use */
+    worker: Worker | SharedWorker | undefined;
+    /** Hooks defined by the client */
+    hooks: Hooks<Procedures>;
+    /** Local storage data defined by the client for the faux local storage */
+    localStorage: Record<string, any>;
+};
 /**
  *
  * @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.
+ * @param options.localStorage Define a in-memory localStorage with the given key-value pairs. Allows code called on the server to access localStorage (even though SharedWorkers don't have access to the browser's real localStorage)
  * @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;
+export declare function Client<Procedures extends ProceduresMap>(procedures: Procedures, { worker, loglevel, restartListener, hooks, localStorage, }?: {
+    worker?: Worker | SharedWorker;
     hooks?: Hooks<Procedures>;
     loglevel?: LogLevel;
     restartListener?: boolean;
+    localStorage?: Record<string, any>;
 }): 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
+ * @param ctx.worker if provided, the client will use this worker to listen for messages, instead of using the service worker
  * @returns
  */
-export declare function startClientListener<Procedures extends ProceduresMap>(l: Logger, worker?: Worker, hooks?: Hooks<Procedures>): Promise<void>;
+export declare function startClientListener<Procedures extends ProceduresMap>(ctx: Context<Procedures>): Promise<void>;
 /**
  * Generate a random request ID, used to identify requests between client and server.
  * @source
  * @returns a 6-character hexadecimal string
  */
 export declare function makeRequestId(): string;
+export {};
 //# sourceMappingURL=client.d.ts.map

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;AAED;;GAEG;AACH,KAAK,OAAO,CAAC,UAAU,SAAS,aAAa,IAAI;IAC/C,oCAAoC;IACpC,MAAM,EAAE,MAAM,CAAA;IACd,iCAAiC;IACjC,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAAA;IACzC,kCAAkC;IAClC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,CAAA;IACxB,0EAA0E;IAC1E,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAClC,CAAA;AAkBD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,MAAM,CAAC,UAAU,SAAS,aAAa,EACrD,UAAU,EAAE,UAAU,EACtB,EACE,MAAM,EACN,QAAkB,EAClB,eAAuB,EACvB,KAAU,EACV,YAAiB,GAClB,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;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC9B,GACL,YAAY,CAAC,UAAU,CAAC,CA2G1B;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;;;;GAIG;AACH,wBAAsB,mBAAmB,CAAC,UAAU,SAAS,aAAa,EACxE,GAAG,EAAE,OAAO,CAAC,UAAU,CAAC,iBAoFzB;AAED;;;;GAIG;AACH,wBAAgB,aAAa,IAAI,MAAM,CAEtC"}

package/dist/client.js

@@ -17,15 +17,20 @@ 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.
+ * @param options.localStorage Define a in-memory localStorage with the given key-value pairs. Allows code called on the server to access localStorage (even though SharedWorkers don't have access to the browser's real localStorage)
  * @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", restartListener = false, hooks = {}, } = {}) {
+export function Client(procedures, { worker, loglevel = "debug", restartListener = false, hooks = {}, localStorage = {}, } = {}) {
     const l = createLogger("client", loglevel);
     if (restartListener)
         _clientListenerStarted = false;
@@ -36,7 +41,13 @@ export function Client(procedures, { worker, loglevel = "debug", restartListener
             throw new Error(`[SWARPC Client] Invalid function name, don't use symbols`);
         }
         const send = async (requestId, msg, options) => {
-            return postMessage(l, worker, hooks, {
+            const ctx = {
+                logger: l,
+                worker,
+                hooks,
+                localStorage,
+            };
+            return postMessage(ctx, {
                 ...msg,
                 by: "sw&rpc",
                 requestId,
@@ -63,7 +74,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 +85,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);
                 },
             };
@@ -92,12 +108,39 @@ export function Client(procedures, { worker, loglevel = "debug", restartListener
  * Warms up the client by starting the listener and getting the worker, then posts a message to the worker.
  * @returns the worker to use
  */
-async function postMessage(l, worker, hooks, message, options) {
-    await startClientListener(l, worker, hooks);
+async function postMessage(ctx, message, options) {
+    await startClientListener(ctx);
+    const { logger: l, worker } = ctx;
     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");
     }
@@ -105,13 +148,13 @@ 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
+ * @param ctx.worker if provided, the client will use this worker to listen for messages, instead of using the service worker
  * @returns
  */
-export async function startClientListener(l, worker, hooks = {}) {
+export async function startClientListener(ctx) {
     if (_clientListenerStarted)
         return;
+    const { logger: l, worker } = ctx;
     // Get service worker registration if no worker is provided
     if (!worker) {
         const sw = await navigator.serviceWorker.ready;
@@ -124,15 +167,21 @@ 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) => {
+    l.debug(null, "Starting client listener", { w, ...ctx });
+    const listener = (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 { requestId, ...data } = eventData;
+        const payload = eventData;
+        // Ignore #initialize request, it's client->server only
+        if ("localStorageData" in payload) {
+            l.warn(null, "Ignoring unexpected #initialize from server", payload);
+            return;
+        }
+        const { requestId, ...data } = payload;
         // Sanity check in case we somehow receive a message without requestId
         if (!requestId) {
             throw new Error("[SWARPC Client] Message received without requestId");
@@ -145,21 +194,34 @@ export async function startClientListener(l, worker, hooks = {}) {
         // 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?.(data.functionName, new Error(data.error.message));
+            ctx.hooks.error?.(data.functionName, new Error(data.error.message));
             handlers.reject(new Error(data.error.message));
             pendingRequests.delete(requestId);
         }
         else if ("progress" in data) {
-            hooks.progress?.(data.functionName, data.progress);
+            ctx.hooks.progress?.(data.functionName, data.progress);
             handlers.onProgress(data.progress);
         }
         else if ("result" in data) {
-            hooks.success?.(data.functionName, data.result);
+            ctx.hooks.success?.(data.functionName, data.result);
             handlers.resolve(data.result);
             pendingRequests.delete(requestId);
         }
-    });
+    };
+    if (w instanceof SharedWorker) {
+        w.port.addEventListener("message", listener);
+        w.port.start();
+    }
+    else {
+        w.addEventListener("message", listener);
+    }
     _clientListenerStarted = true;
+    // Recursive terminal case is ensured by calling this *after* _clientListenerStarted is set to true: startClientListener() will therefore not be called in postMessage() again.
+    await postMessage(ctx, {
+        by: "sw&rpc",
+        functionName: "#initialize",
+        localStorageData: ctx.localStorage,
+    });
 }
 /**
  * Generate a random request ID, used to identify requests between client and server.

package/dist/localstorage.d.ts

@@ -0,0 +1,14 @@
+export declare class FauxLocalStorage {
+    data: Record<string, any>;
+    keysOrder: string[];
+    constructor(data: Record<string, any>);
+    setItem(key: string, value: string): void;
+    getItem(key: string): any;
+    hasItem(key: string): boolean;
+    removeItem(key: string): void;
+    clear(): void;
+    key(index: number): string;
+    get length(): number;
+    register(subject: WorkerGlobalScope | SharedWorkerGlobalScope): void;
+}
+//# sourceMappingURL=localstorage.d.ts.map

package/dist/localstorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localstorage.d.ts","sourceRoot":"","sources":["../src/localstorage.ts"],"names":[],"mappings":"AAAA,qBAAa,gBAAgB;IAC3B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACzB,SAAS,EAAE,MAAM,EAAE,CAAA;gBAEP,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAKrC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAKlC,OAAO,CAAC,GAAG,EAAE,MAAM;IAInB,OAAO,CAAC,GAAG,EAAE,MAAM;IAInB,UAAU,CAAC,GAAG,EAAE,MAAM;IAMtB,KAAK;IAKL,GAAG,CAAC,KAAK,EAAE,MAAM;IAIjB,IAAI,MAAM,WAET;IAED,QAAQ,CAAC,OAAO,EAAE,iBAAiB,GAAG,uBAAuB;CAI9D"}

package/dist/localstorage.js

@@ -0,0 +1,39 @@
+export class FauxLocalStorage {
+    data;
+    keysOrder;
+    constructor(data) {
+        this.data = data;
+        this.keysOrder = Object.keys(data);
+    }
+    setItem(key, value) {
+        if (!this.hasItem(key))
+            this.keysOrder.push(key);
+        this.data[key] = value;
+    }
+    getItem(key) {
+        return this.data[key];
+    }
+    hasItem(key) {
+        return Object.hasOwn(this.data, key);
+    }
+    removeItem(key) {
+        if (!this.hasItem(key))
+            return;
+        delete this.data[key];
+        this.keysOrder = this.keysOrder.filter((k) => k !== key);
+    }
+    clear() {
+        this.data = {};
+        this.keysOrder = [];
+    }
+    key(index) {
+        return this.keysOrder[index];
+    }
+    get length() {
+        return this.keysOrder.length;
+    }
+    register(subject) {
+        // @ts-expect-error
+        subject.localStorage = this;
+    }
+}

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.scope 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,EAMlB,uBAAuB,EACvB,gBAAgB,EAChB,WAAW,EACX,KAAK,aAAa,EACnB,MAAM,YAAY,CAAA;AAiBnB;;;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,CA0N1B"}

package/dist/server.js

@@ -2,31 +2,53 @@
  * @module
  * @mergeModuleWith <project>
  */
+/// <reference lib="webworker" />
 import { type } from "arktype";
 import { createLogger } from "./log.js";
-import { PayloadHeaderSchema, PayloadSchema, zImplementations, zProcedures, } from "./types.js";
+import { PayloadHeaderSchema, PayloadInitializeSchema, PayloadSchema, zImplementations, zProcedures, } from "./types.js";
 import { findTransferables } from "./utils.js";
+import { FauxLocalStorage } from "./localstorage.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.scope 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 +69,38 @@ 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);
+            l.debug(null, "Awaiting shared worker connection...");
+            scope.addEventListener("connect", ({ ports: [port] }) => {
+                l.debug(null, "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 if (scopeIsDedicated(scope)) {
+                scope.postMessage(data, { transfer });
             }
-            else {
-                await self.clients.matchAll().then((clients) => {
+            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) => {
+            if (PayloadInitializeSchema.allows(event.data)) {
+                const { localStorageData } = event.data;
+                l.debug(null, "Setting up faux localStorage", localStorageData);
+                new FauxLocalStorage(localStorageData).register(scope);
+                return;
+            }
             // Decode the payload
             const { requestId, functionName } = PayloadHeaderSchema(type.enumerated(...Object.keys(procedures))).assert(event.data);
             l.debug(requestId, `Received request for ${functionName}`, event.data);
@@ -92,6 +131,8 @@ export function Server(procedures, { worker, loglevel = "debug" } = {}) {
             }
             // Define payload schema for incoming messages
             const payload = PayloadSchema(type(`"${functionName}"`), schemas.input, schemas.progress, schemas.success).assert(event.data);
+            if ("localStorageData" in payload)
+                throw "Unreachable: #initialize request payload should've been handled already";
             // Handle abortion requests (pro-choice ftw!!)
             if (payload.abort) {
                 const controller = abortControllers.get(requestId);
@@ -134,7 +175,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;
 }