swarpc 0.6.1 → 0.7.1

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { Type } from "arktype";
+import { type Type } from "arktype";
 /**
  * A procedure declaration
  */
@@ -28,10 +28,27 @@ export type Procedure<I extends Type, P extends Type, S extends Type> = {
      */
     autotransfer?: "always" | "never" | "output-only";
 };
+/**
+ * A promise that you can cancel by calling `.cancel(reason)` on it:
+ *
+ * ```js
+ * const { request, cancel } = client.runProcedure.cancelable(input, onProgress)
+ * setTimeout(() => cancel("Cancelled by user"), 1000)
+ * const result = await request
+ * ```
+ */
+export type CancelablePromise<T> = {
+    request: Promise<T>;
+    /**
+     * Abort the request.
+     * @param reason The reason for cancelling the request.
+     */
+    cancel: (reason: string) => Promise<void>;
+};
 /**
  * An implementation of a procedure
  */
-export type ProcedureImplementation<I extends Type, P extends Type, S extends Type> = (input: I["inferOut"], onProgress: (progress: P["inferIn"]) => void) => Promise<S["inferIn"]>;
+export type ProcedureImplementation<I extends Type, P extends Type, S extends Type> = (input: I["inferOut"], onProgress: (progress: P["inferIn"]) => void, abortSignal?: AbortSignal) => Promise<S["inferIn"]>;
 /**
  * Declarations of procedures by name.
  */
@@ -59,31 +76,158 @@ export type Hooks<Procedures extends ProceduresMap> = {
      */
     progress?: <Procedure extends keyof ProceduresMap>(procedure: Procedure, data: Procedures[Procedure]["progress"]["inferOut"]) => void;
 };
+export declare const PayloadHeaderSchema: import("arktype").Generic<[["Name", string]], {
+    readonly by: "\"sw&rpc\"";
+    readonly functionName: "Name";
+    readonly requestId: "string >= 1";
+}, {}, {}>;
 export type PayloadHeader<PM extends ProceduresMap, Name extends keyof PM = keyof PM> = {
     by: "sw&rpc";
     functionName: Name & string;
     requestId: string;
-    autotransfer: PM[Name]["autotransfer"];
 };
+export declare const PayloadCoreSchema: import("arktype").Generic<[["I", unknown], ["P", unknown], ["S", unknown]], {
+    readonly "input?": "I";
+    readonly "progress?": "P";
+    readonly "result?": "S";
+    readonly "abort?": {
+        readonly reason: "string";
+    };
+    readonly "error?": {
+        readonly message: "string";
+    };
+}, {}, {}>;
 export type PayloadCore<PM extends ProceduresMap, Name extends keyof PM = keyof PM> = {
     input: PM[Name]["input"]["inferOut"];
 } | {
     progress: PM[Name]["progress"]["inferOut"];
 } | {
     result: PM[Name]["success"]["inferOut"];
+} | {
+    abort: {
+        reason: string;
+    };
 } | {
     error: {
         message: string;
     };
 };
+export declare const PayloadSchema: import("arktype").Generic<[["Name", string], ["I", unknown], ["P", unknown], ["S", unknown]], readonly ["PayloadHeaderSchema<Name>", "&", "PayloadCoreSchema<I, P, S>"], {
+    PayloadCoreSchema: import("arktype/internal/scope.ts").bindGenericToScope<import("@ark/schema").GenericAst<[["I", unknown], ["P", unknown], ["S", unknown]], {
+        readonly "input?": "I";
+        readonly "progress?": "P";
+        readonly "result?": "S";
+        readonly "abort?": {
+            readonly reason: "string";
+        };
+        readonly "error?": {
+            readonly message: "string";
+        };
+    }, {}, {}>, {
+        PayloadCoreSchema: import("@ark/schema").GenericAst<[["I", unknown], ["P", unknown], ["S", unknown]], {
+            readonly "input?": "I";
+            readonly "progress?": "P";
+            readonly "result?": "S";
+            readonly "abort?": {
+                readonly reason: "string";
+            };
+            readonly "error?": {
+                readonly message: "string";
+            };
+        }, {}, {}>;
+        PayloadHeaderSchema: import("@ark/schema").GenericAst<[["Name", string]], {
+            readonly by: "\"sw&rpc\"";
+            readonly functionName: "Name";
+            readonly requestId: "string >= 1";
+        }, {}, {}>;
+    } & {}>;
+    PayloadHeaderSchema: import("arktype/internal/scope.ts").bindGenericToScope<import("@ark/schema").GenericAst<[["Name", string]], {
+        readonly by: "\"sw&rpc\"";
+        readonly functionName: "Name";
+        readonly requestId: "string >= 1";
+    }, {}, {}>, {
+        PayloadCoreSchema: import("@ark/schema").GenericAst<[["I", unknown], ["P", unknown], ["S", unknown]], {
+            readonly "input?": "I";
+            readonly "progress?": "P";
+            readonly "result?": "S";
+            readonly "abort?": {
+                readonly reason: "string";
+            };
+            readonly "error?": {
+                readonly message: "string";
+            };
+        }, {}, {}>;
+        PayloadHeaderSchema: import("@ark/schema").GenericAst<[["Name", string]], {
+            readonly by: "\"sw&rpc\"";
+            readonly functionName: "Name";
+            readonly requestId: "string >= 1";
+        }, {}, {}>;
+    } & {}>;
+}, {
+    PayloadCoreSchema: import("arktype/internal/scope.ts").bindGenericToScope<import("@ark/schema").GenericAst<[["I", unknown], ["P", unknown], ["S", unknown]], {
+        readonly "input?": "I";
+        readonly "progress?": "P";
+        readonly "result?": "S";
+        readonly "abort?": {
+            readonly reason: "string";
+        };
+        readonly "error?": {
+            readonly message: "string";
+        };
+    }, {}, {}>, {
+        PayloadCoreSchema: import("@ark/schema").GenericAst<[["I", unknown], ["P", unknown], ["S", unknown]], {
+            readonly "input?": "I";
+            readonly "progress?": "P";
+            readonly "result?": "S";
+            readonly "abort?": {
+                readonly reason: "string";
+            };
+            readonly "error?": {
+                readonly message: "string";
+            };
+        }, {}, {}>;
+        PayloadHeaderSchema: import("@ark/schema").GenericAst<[["Name", string]], {
+            readonly by: "\"sw&rpc\"";
+            readonly functionName: "Name";
+            readonly requestId: "string >= 1";
+        }, {}, {}>;
+    } & {}>;
+    PayloadHeaderSchema: import("arktype/internal/scope.ts").bindGenericToScope<import("@ark/schema").GenericAst<[["Name", string]], {
+        readonly by: "\"sw&rpc\"";
+        readonly functionName: "Name";
+        readonly requestId: "string >= 1";
+    }, {}, {}>, {
+        PayloadCoreSchema: import("@ark/schema").GenericAst<[["I", unknown], ["P", unknown], ["S", unknown]], {
+            readonly "input?": "I";
+            readonly "progress?": "P";
+            readonly "result?": "S";
+            readonly "abort?": {
+                readonly reason: "string";
+            };
+            readonly "error?": {
+                readonly message: "string";
+            };
+        }, {}, {}>;
+        PayloadHeaderSchema: import("@ark/schema").GenericAst<[["Name", string]], {
+            readonly by: "\"sw&rpc\"";
+            readonly functionName: "Name";
+            readonly requestId: "string >= 1";
+        }, {}, {}>;
+    } & {}>;
+}>;
 /**
  * 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>;
 /**
- * A procedure's corresponding method on the client instance -- used to call the procedure
+ * 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.
  */
-export type ClientMethod<P extends Procedure<Type, Type, Type>> = (input: P["input"]["inferIn"], onProgress?: (progress: P["progress"]["inferOut"]) => void) => Promise<P["success"]["inferOut"]>;
+export type ClientMethod<P extends Procedure<Type, Type, Type>> = ((input: P["input"]["inferIn"], onProgress?: (progress: P["progress"]["inferOut"]) => void) => Promise<P["success"]["inferOut"]>) & {
+    /**
+     * 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"]>;
+};
 /**
  * Symbol used as the key for the procedures map on the server instance
  */
@@ -93,7 +237,9 @@ export declare const zImplementations: unique symbol;
  */
 export declare const zProcedures: unique symbol;
 /**
- * The sw&rpc client instance, which provides methods to call procedures
+ * The sw&rpc client instance, which provides 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.
+ * If you want to be able to cancel the request, you can set the request's ID yourself, and call `.abort(requestId, reason)` on the client instance to cancel it.
  */
 export type SwarpcClient<Procedures extends ProceduresMap> = {
     [zProcedures]: Procedures;
@@ -107,7 +253,7 @@ export type SwarpcClient<Procedures extends ProceduresMap> = {
 export type SwarpcServer<Procedures extends ProceduresMap> = {
     [zProcedures]: Procedures;
     [zImplementations]: ImplementationsMap<Procedures>;
-    start(self: Window): void;
+    start(self: Window | Worker): void;
 } & {
     [F in keyof Procedures]: (impl: ProcedureImplementation<Procedures[F]["input"], Procedures[F]["progress"], Procedures[F]["success"]>) => void;
 };

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAEnC;;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;;GAEG;AACH,MAAM,MAAM,uBAAuB,CACjC,CAAC,SAAS,IAAI,EACd,CAAC,SAAS,IAAI,EACd,CAAC,SAAS,IAAI,IACZ,CACF,KAAK,EAAE,CAAC,CAAC,UAAU,CAAC,EACpB,UAAU,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI,KACzC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAA;AAE1B;;GAEG;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,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;IACjB,YAAY,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,CAAA;CACvC,CAAA;AAED,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,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAC3B,CAAA;AAEL;;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,CAChE,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,CAAA;AAEtC;;GAEG;AACH,eAAO,MAAM,gBAAgB,eAAmC,CAAA;AAChE;;GAEG;AACH,eAAO,MAAM,WAAW,eAA8B,CAAA;AAEtD;;GAEG;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;;;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,IAAI,CAAA;CAC1B,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"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,KAAK,IAAI,EAAE,MAAM,SAAS,CAAA;AAEzC;;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,IAAI;IACjC,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,CACF,KAAK,EAAE,CAAC,CAAC,UAAU,CAAC,EACpB,UAAU,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI,EAC5C,WAAW,CAAC,EAAE,WAAW,KACtB,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAA;AAE1B;;GAEG;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,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,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,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;;GAEG;AACH,eAAO,MAAM,gBAAgB,eAAmC,CAAA;AAChE;;GAEG;AACH,eAAO,MAAM,WAAW,eAA8B,CAAA;AAEtD;;;;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;;;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"}

package/dist/types.js

@@ -1,3 +1,23 @@
+import { type } from "arktype";
+export const PayloadHeaderSchema = type("<Name extends string>", {
+    by: '"sw&rpc"',
+    functionName: "Name",
+    requestId: "string >= 1",
+});
+export const PayloadCoreSchema = type("<I, P, S>", {
+    "input?": "I",
+    "progress?": "P",
+    "result?": "S",
+    "abort?": { reason: "string" },
+    "error?": { message: "string" },
+});
+export const PayloadSchema = type
+    .scope({ PayloadCoreSchema, PayloadHeaderSchema })
+    .type("<Name extends string, I, P, S>", [
+    "PayloadHeaderSchema<Name>",
+    "&",
+    "PayloadCoreSchema<I, P, S>",
+]);
 /**
  * Symbol used as the key for the procedures map on the server instance
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swarpc",
-  "version": "0.6.1",
+  "version": "0.7.1",
   "description": "Full type-safe RPC library for service worker -- move things off of the UI thread with ease!",
   "keywords": [
     "service-workers",
@@ -24,22 +24,26 @@
     "dist",
     "src"
   ],
-  "main": "dist/swarpc.js",
-  "types": "dist/swarpc.d.ts",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
     "dev": "tsc --watch",
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "typedoc": "typedoc src/swarpc.ts src/types.ts --readme README.md",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest",
+    "typedoc": "typedoc src/index.ts src/types.ts --readme README.md",
     "version": "kacl release && prettier -w CHANGELOG.md && git add CHANGELOG.md"
   },
   "dependencies": {
     "arktype": "^2.1.20"
   },
   "devDependencies": {
+    "@vitest/web-worker": "^3.2.4",
     "kacl": "^1.1.1",
     "prettier": "^3.6.2",
-    "typedoc": "^0.28.7",
-    "typescript": "^5.8.3"
+    "typedoc": "^0.28.9",
+    "typescript": "^5.9.2",
+    "vite": "^7.0.6",
+    "vitest": "^3.2.4"
   }
 }

package/src/client.ts

@@ -0,0 +1,245 @@
+import { createLogger, type Logger, type LogLevel } from "./log.js"
+import {
+  Hooks,
+  Payload,
+  PayloadCore,
+  zProcedures,
+  type ProceduresMap,
+  type SwarpcClient
+} from "./types.js"
+import { findTransferables } from "./utils.js"
+
+export type { SwarpcClient } from "./types.js"
+
+/**
+ * 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.
+ * This allows having a single listener for the client, and having multiple in-flight calls to the same procedure.
+ */
+const pendingRequests = new Map<string, PendingRequest>()
+type PendingRequest = {
+  functionName: string
+  reject: (err: Error) => void
+  onProgress: (progress: any) => void
+  resolve: (result: any) => void
+}
+
+// Have we started the client listener?
+let _clientListenerStarted = false
+
+/**
+ *
+ * @param procedures procedures the client will be able to call
+ * @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
+ * @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.
+ */
+export function Client<Procedures extends ProceduresMap>(
+  procedures: Procedures,
+  {
+    worker,
+    loglevel = "debug",
+    hooks = {},
+  }: { worker?: Worker; hooks?: Hooks<Procedures>; loglevel?: LogLevel } = {}
+): SwarpcClient<Procedures> {
+  const l = createLogger("client", loglevel)
+
+  // Store procedures on a symbol key, to avoid conflicts with procedure names
+  const instance = { [zProcedures]: procedures } as Partial<
+    SwarpcClient<Procedures>
+  >
+
+  for (const functionName of Object.keys(procedures) as Array<
+    keyof Procedures
+  >) {
+    if (typeof functionName !== "string") {
+      throw new Error(
+        `[SWARPC Client] Invalid function name, don't use symbols`
+      )
+    }
+
+    const send = async (
+      requestId: string,
+      msg: PayloadCore<Procedures, typeof functionName>,
+      options?: StructuredSerializeOptions
+    ) => {
+      return postMessage(
+        l,
+        worker,
+        hooks,
+        {
+          ...msg,
+          by: "sw&rpc",
+          requestId,
+          functionName,
+        },
+        options
+      )
+    }
+
+    // Set the method on the instance
+    const _runProcedure = async (
+      input: unknown,
+      onProgress: (progress: unknown) => void | Promise<void> = () => {},
+      reqid?: string
+    ) => {
+      // Validate the input against the procedure's input schema
+      procedures[functionName].input.assert(input)
+
+      const requestId = reqid ?? makeRequestId()
+
+      return new Promise((resolve, reject) => {
+        // Store promise handlers (as well as progress updates handler)
+        // so the client listener can resolve/reject the promise (and react to progress updates)
+        // when the server sends messages back
+        pendingRequests.set(requestId, {
+          functionName,
+          resolve,
+          onProgress,
+          reject,
+        })
+
+        const transfer =
+          procedures[functionName].autotransfer === "always"
+            ? findTransferables(input)
+            : []
+
+        // Post the message to the server
+        l.debug(requestId, `Requesting ${functionName} with`, input)
+        send(requestId, { input }, { transfer })
+          .then(() => {})
+          .catch(reject)
+      })
+    }
+
+    // @ts-expect-error
+    instance[functionName] = _runProcedure
+    instance[functionName]!.cancelable = (input, onProgress) => {
+      const requestId = makeRequestId()
+      return {
+        request: _runProcedure(input, onProgress, requestId),
+        async cancel(reason: string) {
+          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 } })
+          pendingRequests.delete(requestId)
+        },
+      }
+    }
+  }
+
+  return instance as SwarpcClient<Procedures>
+}
+
+/**
+ * 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<Procedures extends ProceduresMap>(
+  l: Logger,
+  worker: Worker | undefined,
+  hooks: Hooks<Procedures>,
+  message: Payload<Procedures>,
+  options?: StructuredSerializeOptions
+) {
+  await startClientListener(l, worker, hooks)
+
+  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))
+
+  if (!w) {
+    throw new Error("[SWARPC Client] No active service worker found")
+  }
+
+  w.postMessage(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
+ * @returns
+ */
+async function startClientListener<Procedures extends ProceduresMap>(
+  l: Logger,
+  worker?: Worker,
+  hooks: Hooks<Procedures> = {}
+) {
+  if (_clientListenerStarted) return
+
+  // Get service worker registration if no worker is provided
+  if (!worker) {
+    const sw = await navigator.serviceWorker.ready
+    if (!sw?.active) {
+      throw new Error("[SWARPC Client] Service Worker is not active")
+    }
+
+    if (!navigator.serviceWorker.controller) {
+      l.warn("", "Service Worker is not controlling the page")
+    }
+  }
+
+  const w = worker ?? navigator.serviceWorker
+
+  // Start listening for messages
+  l.debug("", "Starting client listener on", w)
+  w.addEventListener("message", (event) => {
+    // Get the data from the event
+    const eventData = (event as MessageEvent).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 as Payload<Procedures>
+
+    // Sanity check in case we somehow receive a message without requestId
+    if (!requestId) {
+      throw new Error("[SWARPC Client] Message received without requestId")
+    }
+
+    // Get the associated pending request handlers
+    const handlers = pendingRequests.get(requestId)
+    if (!handlers) {
+      throw new Error(
+        `[SWARPC Client] ${requestId} has no active request handlers`
+      )
+    }
+
+    // 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))
+      handlers.reject(new Error(data.error.message))
+      pendingRequests.delete(requestId)
+    } else if ("progress" in data) {
+      hooks.progress?.(data.functionName, data.progress)
+      handlers.onProgress(data.progress)
+    } else if ("result" in data) {
+      hooks.success?.(data.functionName, data.result)
+      handlers.resolve(data.result)
+      pendingRequests.delete(requestId)
+    }
+  })
+
+  _clientListenerStarted = true
+}
+
+/**
+ * Generate a random request ID, used to identify requests between client and server.
+ * @returns a 6-character hexadecimal string
+ */
+export function makeRequestId(): string {
+  return Math.random().toString(16).substring(2, 8).toUpperCase()
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from "./client.js"
+export * from "./server.js"
+export type { ProceduresMap, CancelablePromise } from "./types.js"

package/src/log.ts

@@ -0,0 +1,62 @@
+export function createLogger(
+  side: "server" | "client",
+  level: LogLevel = "debug"
+) {
+  const enabledLevels = LOG_LEVELS.slice(LOG_LEVELS.indexOf(level))
+
+  return {
+    debug: enabledLevels.includes("debug") ? logger("debug", side) : () => {},
+    info: enabledLevels.includes("info") ? logger("info", side) : () => {},
+    warn: enabledLevels.includes("warn") ? logger("warn", side) : () => {},
+    error: enabledLevels.includes("error") ? logger("error", side) : () => {},
+  }
+}
+
+export type Logger = ReturnType<typeof createLogger>
+
+const LOG_LEVELS = ["debug", "info", "warn", "error"] as const
+export type LogLevel = (typeof LOG_LEVELS)[number]
+
+/**
+ * Creates partially-applied logging functions given the first 2 args
+ * @param severity
+ * @param side
+ * @returns
+ */
+function logger(severity: LogLevel, side: "server" | "client") {
+  return (rqid: string | null, message: string, ...args: any[]) =>
+    log(severity, side, rqid, message, ...args)
+}
+
+/**
+ * Send log messages to the console, with a helpful prefix.
+ * @param severity
+ * @param side
+ * @param rqid request ID
+ * @param message
+ * @param args passed to console methods directly
+ */
+export function log(
+  severity: "debug" | "info" | "warn" | "error",
+  side: "server" | "client",
+  rqid: string | null,
+  message: string,
+  ...args: any[]
+) {
+  const prefix =
+    "[" +
+    ["SWARPC", side, rqid ? `%c${rqid}%c` : ""].filter(Boolean).join(" ") +
+    "]"
+
+  const prefixStyles = rqid ? ["color: cyan;", "color: inherit;"] : []
+
+  if (severity === "debug") {
+    console.debug(prefix, ...prefixStyles, message, ...args)
+  } else if (severity === "info") {
+    console.info(prefix, ...prefixStyles, message, ...args)
+  } else if (severity === "warn") {
+    console.warn(prefix, ...prefixStyles, message, ...args)
+  } else if (severity === "error") {
+    console.error(prefix, ...prefixStyles, message, ...args)
+  }
+}