swarpc 0.10.0 → 0.12.0

package/dist/server.js

@@ -5,21 +5,18 @@
 /// <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";
-class MockedWorkerGlobalScope {
-    constructor() { }
-}
-const SharedWorkerGlobalScope = globalThis.SharedWorkerGlobalScope ?? MockedWorkerGlobalScope;
-const DedicatedWorkerGlobalScope = globalThis.DedicatedWorkerGlobalScope ?? MockedWorkerGlobalScope;
-const ServiceWorkerGlobalScope = globalThis.ServiceWorkerGlobalScope ?? MockedWorkerGlobalScope;
+import { FauxLocalStorage } from "./localstorage.js";
+import { scopeIsDedicated, scopeIsShared, scopeIsService } from "./scopes.js";
+import { nodeIdFromScope } from "./nodes.js";
 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 The worker scope to use, defaults to the `self` of the file where Server() is called.
+ * @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.
@@ -28,19 +25,12 @@ const abortedRequests = new Set();
  * {@includeCode ../example/src/service-worker.ts}
  */
 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";
-    }
+    // Service workers don't have a name, but it's fine anyways cuz we don't have multiple nodes when running with a SW
+    const nodeId = nodeIdFromScope(scope, _scopeType);
+    const l = createLogger("server", loglevel, nodeId);
     // 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.
@@ -59,7 +49,7 @@ export function Server(procedures, { loglevel = "debug", scope, _scopeType, } =
                 tools.abortSignal?.throwIfAborted();
                 return new Promise((resolve, reject) => {
                     tools.abortSignal?.addEventListener("abort", () => {
-                        let { requestId, reason } = tools.abortSignal?.reason;
+                        let { requestId, reason } = tools.abortSignal.reason;
                         l.debug(requestId, `Aborted ${functionName} request: ${reason}`);
                         reject({ aborted: reason });
                     });
@@ -70,11 +60,11 @@ export function Server(procedures, { loglevel = "debug", scope, _scopeType, } =
     }
     instance.start = async () => {
         const port = await new Promise((resolve) => {
-            if (!scopeIsShared(scope))
+            if (!scopeIsShared(scope, _scopeType))
                 return resolve(undefined);
-            console.log("Awaiting shared worker connection...");
+            l.debug(null, "Awaiting shared worker connection...");
             scope.addEventListener("connect", ({ ports: [port] }) => {
-                console.log("Shared worker connected with port", port);
+                l.debug(null, "Shared worker connected with port", port);
                 resolve(port);
             });
         });
@@ -84,16 +74,22 @@ export function Server(procedures, { loglevel = "debug", scope, _scopeType, } =
             if (port) {
                 port.postMessage(data, { transfer });
             }
-            else if (scopeIsDedicated(scope)) {
+            else if (scopeIsDedicated(scope, _scopeType)) {
                 scope.postMessage(data, { transfer });
             }
-            else if (scopeIsService(scope)) {
+            else if (scopeIsService(scope, _scopeType)) {
                 await scope.clients.matchAll().then((clients) => {
                     clients.forEach((client) => client.postMessage(data, { transfer }));
                 });
             }
         };
         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);
@@ -124,6 +120,8 @@ export function Server(procedures, { loglevel = "debug", scope, _scopeType, } =
             }
             // 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);
@@ -141,11 +139,11 @@ export function Server(procedures, { loglevel = "debug", scope, _scopeType, } =
             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);
+                    // l.debug(requestId, `Progress for ${functionName}`, progress);
                     await postMsg({ progress });
                 }, {
                     abortSignal: abortControllers.get(requestId)?.signal,
-                    logger: createLogger("server", loglevel, requestId),
+                    logger: createLogger("server", loglevel, nodeId, requestId),
                 });
                 // Send results
                 l.debug(requestId, `Result for ${functionName}`, result);
@@ -168,17 +166,17 @@ export function Server(procedures, { loglevel = "debug", scope, _scopeType, } =
             }
         };
         // Listen for messages from the client
-        if (scopeIsShared(scope)) {
+        if (scopeIsShared(scope, _scopeType)) {
             if (!port)
                 throw new Error("SharedWorker port not initialized");
-            console.log("Listening for shared worker messages on port", port);
+            l.info(null, "Listening for shared worker messages on port", port);
             port.addEventListener("message", listener);
             port.start();
         }
-        else if (scopeIsDedicated(scope)) {
+        else if (scopeIsDedicated(scope, _scopeType)) {
             scope.addEventListener("message", listener);
         }
-        else if (scopeIsService(scope)) {
+        else if (scopeIsService(scope, _scopeType)) {
             scope.addEventListener("message", listener);
         }
         else {

package/dist/types.d.ts

@@ -105,6 +105,12 @@ export type Hooks<Procedures extends ProceduresMap> = {
      */
     progress?: <Procedure extends keyof ProceduresMap>(procedure: Procedure, data: Procedures[Procedure]["progress"]["inferOut"]) => void;
 };
+export declare const PayloadInitializeSchema: import("arktype/internal/methods/object.ts").ObjectType<{
+    by: "sw&rpc";
+    functionName: "#initialize";
+    localStorageData: Record<string, unknown>;
+}, {}>;
+export type PayloadInitialize = typeof PayloadInitializeSchema.infer;
 /**
  * @source
  */
@@ -150,7 +156,7 @@ export type PayloadCore<PM extends ProceduresMap, Name extends keyof PM = keyof
 /**
  * @source
  */
-export declare const PayloadSchema: import("arktype").Generic<[["Name", string], ["I", unknown], ["P", unknown], ["S", unknown]], readonly ["PayloadHeaderSchema<Name>", "&", "PayloadCoreSchema<I, P, S>"], {
+export declare const PayloadSchema: import("arktype").Generic<[["Name", string], ["I", unknown], ["P", unknown], ["S", unknown]], readonly [readonly ["PayloadHeaderSchema<Name>", "&", "PayloadCoreSchema<I, P, S>"], "|", "PayloadInitializeSchema"], {
     PayloadCoreSchema: import("arktype/internal/scope.ts").bindGenericToScope<import("@ark/schema").GenericAst<[["I", unknown], ["P", unknown], ["S", unknown]], {
         readonly "input?": "I";
         readonly "progress?": "P";
@@ -178,6 +184,17 @@ export declare const PayloadSchema: import("arktype").Generic<[["Name", string],
             readonly functionName: "Name";
             readonly requestId: "string >= 1";
         }, {}, {}>;
+        PayloadInitializeSchema: import("arktype/internal/methods/object.ts").ObjectType<{
+            by: "sw&rpc";
+            functionName: "#initialize";
+            localStorageData: Record<string, unknown>;
+        }, {}> & {
+            readonly " brand": [import("arktype/internal/methods/object.ts").ObjectType<{
+                by: "sw&rpc";
+                functionName: "#initialize";
+                localStorageData: Record<string, unknown>;
+            }, {}>, "unparsed"];
+        };
     } & {}>;
     PayloadHeaderSchema: import("arktype/internal/scope.ts").bindGenericToScope<import("@ark/schema").GenericAst<[["Name", string]], {
         readonly by: "\"sw&rpc\"";
@@ -200,7 +217,23 @@ export declare const PayloadSchema: import("arktype").Generic<[["Name", string],
             readonly functionName: "Name";
             readonly requestId: "string >= 1";
         }, {}, {}>;
+        PayloadInitializeSchema: import("arktype/internal/methods/object.ts").ObjectType<{
+            by: "sw&rpc";
+            functionName: "#initialize";
+            localStorageData: Record<string, unknown>;
+        }, {}> & {
+            readonly " brand": [import("arktype/internal/methods/object.ts").ObjectType<{
+                by: "sw&rpc";
+                functionName: "#initialize";
+                localStorageData: Record<string, unknown>;
+            }, {}>, "unparsed"];
+        };
     } & {}>;
+    PayloadInitializeSchema: {
+        by: "sw&rpc";
+        functionName: "#initialize";
+        localStorageData: Record<string, unknown>;
+    };
 }, {
     PayloadCoreSchema: import("arktype/internal/scope.ts").bindGenericToScope<import("@ark/schema").GenericAst<[["I", unknown], ["P", unknown], ["S", unknown]], {
         readonly "input?": "I";
@@ -229,6 +262,17 @@ export declare const PayloadSchema: import("arktype").Generic<[["Name", string],
             readonly functionName: "Name";
             readonly requestId: "string >= 1";
         }, {}, {}>;
+        PayloadInitializeSchema: import("arktype/internal/methods/object.ts").ObjectType<{
+            by: "sw&rpc";
+            functionName: "#initialize";
+            localStorageData: Record<string, unknown>;
+        }, {}> & {
+            readonly " brand": [import("arktype/internal/methods/object.ts").ObjectType<{
+                by: "sw&rpc";
+                functionName: "#initialize";
+                localStorageData: Record<string, unknown>;
+            }, {}>, "unparsed"];
+        };
     } & {}>;
     PayloadHeaderSchema: import("arktype/internal/scope.ts").bindGenericToScope<import("@ark/schema").GenericAst<[["Name", string]], {
         readonly by: "\"sw&rpc\"";
@@ -251,12 +295,28 @@ export declare const PayloadSchema: import("arktype").Generic<[["Name", string],
             readonly functionName: "Name";
             readonly requestId: "string >= 1";
         }, {}, {}>;
+        PayloadInitializeSchema: import("arktype/internal/methods/object.ts").ObjectType<{
+            by: "sw&rpc";
+            functionName: "#initialize";
+            localStorageData: Record<string, unknown>;
+        }, {}> & {
+            readonly " brand": [import("arktype/internal/methods/object.ts").ObjectType<{
+                by: "sw&rpc";
+                functionName: "#initialize";
+                localStorageData: Record<string, unknown>;
+            }, {}>, "unparsed"];
+        };
     } & {}>;
+    PayloadInitializeSchema: {
+        by: "sw&rpc";
+        functionName: "#initialize";
+        localStorageData: Record<string, unknown>;
+    };
 }>;
 /**
  * The effective payload as sent by the server to the client
  */
-export type Payload<PM extends ProceduresMap, Name extends keyof PM = keyof PM> = PayloadHeader<PM, Name> & PayloadCore<PM, Name>;
+export type Payload<PM extends ProceduresMap, Name extends keyof PM = keyof PM> = (PayloadHeader<PM, Name> & PayloadCore<PM, Name>) | PayloadInitialize;
 /**
  * A procedure's corresponding method on the client instance -- used to call the procedure. If you want to be able to cancel the request, you can use the `cancelable` method instead of running the procedure directly.
  */
@@ -265,6 +325,16 @@ export type ClientMethod<P extends Procedure<Type, Type, Type>> = ((input: P["in
      * A method that returns a `CancelablePromise`. Cancel it by calling `.cancel(reason)` on it, and wait for the request to resolve by awaiting the `request` property on the returned object.
      */
     cancelable: (input: P["input"]["inferIn"], onProgress?: (progress: P["progress"]["inferOut"]) => void, requestId?: string) => CancelablePromise<P["success"]["inferOut"]>;
+    /**
+     * Send the request to specific nodes, or all nodes.
+     * Returns an array of results, one for each node the request was sent to.
+     * Each result is a {@link PromiseSettledResult}, with also an additional property, the node ID of the request
+     */
+    broadcast: (input: P["input"]["inferIn"], onProgress?: (progress: P["progress"]["inferOut"]) => void, 
+    /** Number of nodes to send the request to. Leave undefined to send to all nodes */
+    nodes?: number) => Promise<Array<PromiseSettledResult<P["success"]["inferOut"]> & {
+        node: string;
+    }>>;
 };
 /**
  * Symbol used as the key for the procedures map on the server instance
@@ -278,4 +348,9 @@ export declare const zImplementations: unique symbol;
  * @source
  */
 export declare const zProcedures: unique symbol;
+export type WorkerConstructor<T extends Worker | SharedWorker = Worker | SharedWorker> = {
+    new (opts?: {
+        name?: string;
+    }): T;
+};
 //# sourceMappingURL=types.d.ts.map

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,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"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAQ,KAAK,IAAI,EAAE,MAAM,SAAS,CAAC;AAC1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAE9C;;GAEG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC,SAAS,IAAI,EAAE,CAAC,SAAS,IAAI,IAAI;IACtE;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC;IACT;;;OAGG;IACH,QAAQ,EAAE,CAAC,CAAC;IACZ;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC;IACX;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,aAAa,CAAC;CACnD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,OAAO,IAAI;IAC3C,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB;;;OAGG;IACH,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CAClC,CAAC;AAEF;;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,CAAC;IAC1B;;OAEG;IACH,MAAM,EAAE,kBAAkB,CAAC;CAC5B,KACE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;AAE3B;;;;;GAKG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AAExE;;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,CAAC;AAEF;;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,CAAC;IACV;;OAEG;IACH,KAAK,CAAC,EAAE,CAAC,SAAS,SAAS,MAAM,aAAa,EAC5C,SAAS,EAAE,SAAS,EACpB,KAAK,EAAE,KAAK,KACT,IAAI,CAAC;IACV;;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,CAAC;CACX,CAAC;AAEF,eAAO,MAAM,uBAAuB;;;;MAIlC,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,OAAO,uBAAuB,CAAC,KAAK,CAAC;AAErE;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;UAI9B,CAAC;AAEH,MAAM,MAAM,aAAa,CACvB,EAAE,SAAS,aAAa,EACxB,IAAI,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,IAC9B;IACF,EAAE,EAAE,QAAQ,CAAC;IACb,YAAY,EAAE,IAAI,GAAG,MAAM,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;UAM5B,CAAC;AAEH,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,CAAC;CACtC,GACD;IACE,QAAQ,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,CAAC;CAC5C,GACD;IACE,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC;CACzC,GACD;IACE,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC3B,GACD;IACE,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAC5B,CAAC;AAEN;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAMtB,CAAC;AAEL;;GAEG;AACH,MAAM,MAAM,OAAO,CACjB,EAAE,SAAS,aAAa,EACxB,IAAI,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,IAC9B,CAAC,aAAa,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,GAAG,iBAAiB,CAAC;AAE1E;;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,CAAC;IACjD;;;;OAIG;IACH,SAAS,EAAE,CACT,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;IAC1D,mFAAmF;IACnF,KAAK,CAAC,EAAE,MAAM,KACX,OAAO,CACV,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,CAAC,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CACzE,CAAC;CACH,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,eAAmC,CAAC;AAEjE;;;;GAIG;AACH,eAAO,MAAM,WAAW,eAA8B,CAAC;AAEvD,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,MAAM,GAAG,YAAY,GAAG,MAAM,GAAG,YAAY,IACrD;IACF,KAAK,IAAI,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,CAAC,CAAC;CACnC,CAAC"}

package/dist/types.js

@@ -3,6 +3,11 @@
  * @mergeModuleWith <project>
  */
 import { type } from "arktype";
+export const PayloadInitializeSchema = type({
+    by: '"sw&rpc"',
+    functionName: '"#initialize"',
+    localStorageData: "Record<string, unknown>",
+});
 /**
  * @source
  */
@@ -25,11 +30,11 @@ export const PayloadCoreSchema = type("<I, P, S>", {
  * @source
  */
 export const PayloadSchema = type
-    .scope({ PayloadCoreSchema, PayloadHeaderSchema })
+    .scope({ PayloadCoreSchema, PayloadHeaderSchema, PayloadInitializeSchema })
     .type("<Name extends string, I, P, S>", [
-    "PayloadHeaderSchema<Name>",
-    "&",
-    "PayloadCoreSchema<I, P, S>",
+    ["PayloadHeaderSchema<Name>", "&", "PayloadCoreSchema<I, P, S>"],
+    "|",
+    "PayloadInitializeSchema",
 ]);
 /**
  * Symbol used as the key for the procedures map on the server instance

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swarpc",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "Full type-safe RPC library for service worker -- move things off of the UI thread with ease!",
   "keywords": [
     "service-workers",
@@ -31,36 +31,49 @@
     "dev": "tsc --watch",
     "typecheck": "tsc --noEmit",
     "test": "vitest",
+    "check": "oxlint",
     "typedoc": "typedoc",
     "version": "kacl release && prettier -w CHANGELOG.md && git add CHANGELOG.md",
     "typedoc:dev": "nodemon --watch src --watch README.md --watch typedoc.json --watch typedoc.css --exec npm run typedoc:withplugins",
     "typedoc:serve": "npx sirv-cli --dev docs",
     "typedoc:plugins": "node -e \"const fs=require('fs');const p=JSON.parse(fs.readFileSync('typedoc.json')).plugin||[];if(p.length)require('child_process').execSync('npm add --legacy-peer-deps -D '+p.join(' '),{stdio:'inherit'});else console.log('No plugins found');\"",
-    "typedoc:withplugins": "npm run typedoc:plugins && npm run typedoc"
+    "typedoc:withplugins": "npm run typedoc:plugins && npm run typedoc",
+    "prepare": "husky"
   },
   "dependencies": {
-    "arktype": "^2.1.20"
+    "arktype": "^2.1.22"
   },
   "devDependencies": {
     "@8hobbies/typedoc-plugin-plausible": "^2.2.0",
     "@vitest/web-worker": "^3.2.4",
+    "husky": "^9.1.7",
     "kacl": "^1.1.1",
+    "knip": "^5.63.1",
+    "lint-staged": "^16.1.6",
     "nodemon": "^3.1.10",
+    "oxlint": "^1.14.0",
+    "pkg-pr-new": "^0.0.59",
     "prettier": "^3.6.2",
     "sirv-cli": "^3.0.1",
-    "typedoc": "^0.28.9",
+    "typedoc": "^0.28.12",
     "typedoc-material-theme": "^1.4.0",
-    "typedoc-plugin-dt-links": "^2.0.13",
+    "typedoc-plugin-dt-links": "^2.0.18",
     "typedoc-plugin-extras": "^4.0.1",
     "typedoc-plugin-inline-sources": "^1.3.0",
-    "typedoc-plugin-mdn-links": "^5.0.7",
+    "typedoc-plugin-mdn-links": "^5.0.9",
     "typedoc-plugin-redirect": "^1.2.0",
     "typescript": "^5.9.2",
-    "vite": "^7.0.6",
+    "vite": "^7.1.4",
     "vitest": "^3.2.4"
   },
   "volta": {
-    "node": "22.18.0",
-    "npm": "11.5.2"
+    "node": "24.7.0",
+    "npm": "11.6.0"
+  },
+  "lint-staged": {
+    "*.{ts,js,md,json,yaml,yml}": [
+      "oxlint --fix",
+      "prettier --write"
+    ]
   }
 }