swarpc 0.9.0 → 0.11.0

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
@@ -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.
  */

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,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAE7C;;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,eAAO,MAAM,uBAAuB;;;;MAIlC,CAAA;AAEF,MAAM,MAAM,iBAAiB,GAAG,OAAO,uBAAuB,CAAC,KAAK,CAAA;AAEpE;;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,CAAC,aAAa,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,WAAW,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,GAAG,iBAAiB,CAAA;AAEzE;;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/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.9.0",
+  "version": "0.11.0",
   "description": "Full type-safe RPC library for service worker -- move things off of the UI thread with ease!",
   "keywords": [
     "service-workers",
@@ -48,15 +48,15 @@
     "nodemon": "^3.1.10",
     "prettier": "^3.6.2",
     "sirv-cli": "^3.0.1",
-    "typedoc": "^0.28.9",
+    "typedoc": "^0.28.11",
     "typedoc-material-theme": "^1.4.0",
-    "typedoc-plugin-dt-links": "^2.0.12",
+    "typedoc-plugin-dt-links": "^2.0.16",
     "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.9",
     "typedoc-plugin-redirect": "^1.2.0",
     "typescript": "^5.9.2",
-    "vite": "^7.0.6",
+    "vite": "^7.1.3",
     "vitest": "^3.2.4"
   },
   "volta": {

package/src/client.ts

@@ -25,6 +25,20 @@ 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>
+}
+
 /**
  * Pending requests are stored in a map, where the key is the request ID.
  * Each request has a set of handlers: resolve, reject, and onProgress.
@@ -45,9 +59,14 @@ 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:
@@ -60,11 +79,13 @@ export function Client<Procedures extends ProceduresMap>(
     loglevel = "debug",
     restartListener = false,
     hooks = {},
+    localStorage = {},
   }: {
-    worker?: Worker
+    worker?: Worker | SharedWorker
     hooks?: Hooks<Procedures>
     loglevel?: LogLevel
     restartListener?: boolean
+    localStorage?: Record<string, any>
   } = {}
 ): SwarpcClient<Procedures> {
   const l = createLogger("client", loglevel)
@@ -90,10 +111,15 @@ export function Client<Procedures extends ProceduresMap>(
       msg: PayloadCore<Procedures, typeof functionName>,
       options?: StructuredSerializeOptions
     ) => {
-      return postMessage(
-        l,
+      const ctx: Context<Procedures> = {
+        logger: l,
         worker,
         hooks,
+        localStorage,
+      }
+
+      return postMessage(
+        ctx,
         {
           ...msg,
           by: "sw&rpc",
@@ -133,7 +159,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 +171,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 +181,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)
         },
       }
@@ -170,20 +201,56 @@ export function Client<Procedures extends ProceduresMap>(
  * @returns the worker to use
  */
 async function postMessage<Procedures extends ProceduresMap>(
-  l: Logger,
-  worker: Worker | undefined,
-  hooks: Hooks<Procedures>,
+  ctx: Context<Procedures>,
   message: Payload<Procedures>,
   options?: StructuredSerializeOptions
 ) {
-  await startClientListener(l, worker, hooks)
+  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))
+    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")
@@ -194,17 +261,16 @@ async function postMessage<Procedures extends ProceduresMap>(
 
 /**
  * Starts the client listener, which listens for messages from the sw&rpc server.
- * @param worker if provided, the client will use this worker to listen for messages, instead of using the service worker
- * @param force if true, will force the listener to restart even if it has already been started
+ * @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<Procedures extends ProceduresMap>(
-  l: Logger,
-  worker?: Worker,
-  hooks: Hooks<Procedures> = {}
+  ctx: Context<Procedures>
 ) {
   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
@@ -220,8 +286,8 @@ export async function startClientListener<Procedures extends ProceduresMap>(
   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: Event): void => {
     // Get the data from the event
     const eventData = (event as MessageEvent).data || {}
 
@@ -229,7 +295,15 @@ export async function startClientListener<Procedures extends ProceduresMap>(
     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 as Payload<Procedures>
+    const payload = eventData as Payload<Procedures>
+
+    // 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) {
@@ -240,27 +314,41 @@ 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)}`
       )
     }
 
     // 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,
+  })
 }
 
 /**

package/src/localstorage.ts

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