@serwist/background-sync 9.0.0-preview.1 → 9.0.0-preview.11

package/README.md

@@ -1 +1 @@
-This module's documentation can be found at https://developers.google.com/web/tools/workbox/modules/workbox-background-sync
+This module's documentation can be found at https://serwist.pages.dev/docs/background-sync

package/dist/BackgroundSyncPlugin.d.ts

@@ -1,10 +1,10 @@
-import type { SerwistPlugin } from "@serwist/core";
+import type { FetchDidFailCallbackParam, SerwistPlugin } from "@serwist/core";
 import type { QueueOptions } from "./Queue.js";
 /**
  * A class implementing the `fetchDidFail` lifecycle callback. This makes it
  * easier to add failed requests to a background sync Queue.
  */
-declare class BackgroundSyncPlugin implements SerwistPlugin {
+export declare class BackgroundSyncPlugin implements SerwistPlugin {
     private readonly _queue;
     /**
      * @param name See the `@serwist/background-sync.Queue`
@@ -17,7 +17,6 @@ declare class BackgroundSyncPlugin implements SerwistPlugin {
      * @param options
      * @private
      */
-    fetchDidFail: SerwistPlugin["fetchDidFail"];
+    fetchDidFail({ request }: FetchDidFailCallbackParam): Promise<void>;
 }
-export { BackgroundSyncPlugin };
 //# sourceMappingURL=BackgroundSyncPlugin.d.ts.map

package/dist/BackgroundSyncPlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BackgroundSyncPlugin.d.ts","sourceRoot":"","sources":["../src/BackgroundSyncPlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAG/C;;;GAGG;AACH,cAAM,oBAAqB,YAAW,aAAa;IACjD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAE/B;;;;;OAKG;gBACS,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;IAIhD;;;OAGG;IACH,YAAY,EAAE,aAAa,CAAC,cAAc,CAAC,CAEzC;CACH;AAED,OAAO,EAAE,oBAAoB,EAAE,CAAC"}
+{"version":3,"file":"BackgroundSyncPlugin.d.ts","sourceRoot":"","sources":["../src/BackgroundSyncPlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAE9E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAG/C;;;GAGG;AACH,qBAAa,oBAAqB,YAAW,aAAa;IACxD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAE/B;;;;;OAKG;gBACS,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY;IAIhD;;;OAGG;IACG,YAAY,CAAC,EAAE,OAAO,EAAE,EAAE,yBAAyB;CAG1D"}

package/dist/Queue.d.ts

@@ -56,7 +56,7 @@ export interface QueueEntry {
  * later. All parts of the storing and replaying process are observable via
  * callbacks.
  */
-declare class Queue {
+export declare class Queue {
     private readonly _name;
     private readonly _onSync;
     private readonly _maxRetentionTime;
@@ -94,16 +94,14 @@ declare class Queue {
     unshiftRequest(entry: QueueEntry): Promise<void>;
     /**
      * Removes and returns the last request in the queue (along with its
-     * timestamp and any metadata). The returned object takes the form:
-     * `{request, timestamp, metadata}`.
+     * timestamp and any metadata).
      *
      * @returns
      */
     popRequest(): Promise<QueueEntry | undefined>;
     /**
      * Removes and returns the first request in the queue (along with its
-     * timestamp and any metadata). The returned object takes the form:
-     * `{request, timestamp, metadata}`.
+     * timestamp and any metadata).
      *
      * @returns
      */
@@ -166,5 +164,5 @@ declare class Queue {
      */
     static get _queueNames(): Set<string>;
 }
-export { Queue };
+export {};
 //# sourceMappingURL=Queue.d.ts.map

package/dist/Queue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Queue.d.ts","sourceRoot":"","sources":["../src/Queue.ts"],"names":[],"mappings":"AAgBA,UAAU,qBAAqB;IAC7B,KAAK,EAAE,KAAK,CAAC;CACd;AAED,UAAU,cAAc;IACtB,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACxD;AAED,MAAM,WAAW,YAAY;IAC3B;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AA2BD;;;;GAIG;AACH,cAAM,KAAK;IACT,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiB;IACzC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAC3C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAa;IACzC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAU;IAC7C,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,wBAAwB,CAAS;IAEzC;;;;;;;;OAQG;gBACS,IAAI,EAAE,MAAM,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAE,YAAiB;IAgB5F;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;OAKG;IACG,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBnD;;;;;OAKG;IACG,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBtD;;;;;;OAMG;IACG,UAAU,IAAI,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAInD;;;;;;OAMG;IACG,YAAY,IAAI,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAIrD;;;;;OAKG;IACG,MAAM,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAmBrC;;;;;OAKG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;IAI7B;;;;;;OAMG;IACG,WAAW,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAsB,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAmC1H;;;;;;;OAOG;IACG,cAAc,CAAC,SAAS,EAAE,KAAK,GAAG,OAAO,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IA0BjF;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAuBrC;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAenC;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAmDxB;;;;;;OAMG;IACH,MAAM,KAAK,WAAW,IAAI,GAAG,CAAC,MAAM,CAAC,CAEpC;CACF;AAED,OAAO,EAAE,KAAK,EAAE,CAAC"}
+{"version":3,"file":"Queue.d.ts","sourceRoot":"","sources":["../src/Queue.ts"],"names":[],"mappings":"AAgBA,UAAU,qBAAqB;IAC7B,KAAK,EAAE,KAAK,CAAC;CACd;AAED,UAAU,cAAc;IACtB,CAAC,OAAO,EAAE,qBAAqB,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACxD;AAED,MAAM,WAAW,YAAY;IAC3B;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AA2BD;;;;GAIG;AACH,qBAAa,KAAK;IAChB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiB;IACzC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAC3C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAa;IACzC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAU;IAC7C,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,wBAAwB,CAAS;IAEzC;;;;;;;;OAQG;gBACS,IAAI,EAAE,MAAM,EAAE,EAAE,iBAAiB,EAAE,MAAM,EAAE,gBAAgB,EAAE,GAAE,YAAiB;IAgB5F;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;OAKG;IACG,WAAW,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBnD;;;;;OAKG;IACG,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBtD;;;;;OAKG;IACG,UAAU,IAAI,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAInD;;;;;OAKG;IACG,YAAY,IAAI,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAIrD;;;;;OAKG;IACG,MAAM,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAmBrC;;;;;OAKG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC;IAI7B;;;;;;OAMG;IACG,WAAW,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAsB,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAmC1H;;;;;;;OAOG;IACG,cAAc,CAAC,SAAS,EAAE,KAAK,GAAG,OAAO,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IA0BjF;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAuBrC;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAenC;;;;;;OAMG;IACH,OAAO,CAAC,gBAAgB;IAmDxB;;;;;;OAMG;IACH,MAAM,KAAK,WAAW,IAAI,GAAG,CAAC,MAAM,CAAC,CAEpC;CACF"}

package/dist/StorableRequest.d.ts

@@ -11,7 +11,7 @@ export interface RequestData extends MapLikeObject {
  * Most developers will not need to access this class directly;
  * it is exposed for advanced use cases.
  */
-declare class StorableRequest {
+export declare class StorableRequest {
     private readonly _requestData;
     /**
      * Converts a Request object to a plain object that can be structured
@@ -48,5 +48,4 @@ declare class StorableRequest {
      */
     clone(): StorableRequest;
 }
-export { StorableRequest };
 //# sourceMappingURL=StorableRequest.d.ts.map

package/dist/StorableRequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"StorableRequest.d.ts","sourceRoot":"","sources":["../src/StorableRequest.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAiBnD,MAAM,WAAW,WAAY,SAAQ,aAAa;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,aAAa,CAAC;IACvB,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED;;;;;;GAMG;AACH,cAAM,eAAe;IACnB,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAE3C;;;;;;OAMG;WACU,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC;IA6BpE;;;;;;OAMG;gBACS,WAAW,EAAE,WAAW;IAyBpC;;;;OAIG;IACH,QAAQ,IAAI,WAAW;IAUvB;;;;OAIG;IACH,SAAS,IAAI,OAAO;IAIpB;;;;OAIG;IACH,KAAK,IAAI,eAAe;CAGzB;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}
+{"version":3,"file":"StorableRequest.d.ts","sourceRoot":"","sources":["../src/StorableRequest.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAiBnD,MAAM,WAAW,WAAY,SAAQ,aAAa;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,aAAa,CAAC;IACvB,IAAI,CAAC,EAAE,WAAW,CAAC;CACpB;AAED;;;;;;GAMG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAE3C;;;;;;OAMG;WACU,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC;IA6BpE;;;;;;OAMG;gBACS,WAAW,EAAE,WAAW;IAyBpC;;;;OAIG;IACH,QAAQ,IAAI,WAAW;IAUvB;;;;OAIG;IACH,SAAS,IAAI,OAAO;IAIpB;;;;OAIG;IACH,KAAK,IAAI,eAAe;CAGzB"}

package/dist/index.js

@@ -431,11 +431,11 @@ class BackgroundSyncPlugin {
     constructor(name, options){
         this._queue = new Queue(name, options);
     }
-    fetchDidFail = async ({ request })=>{
+    async fetchDidFail({ request }) {
         await this._queue.pushRequest({
             request
         });
-    };
+    }
 }
 
 export { BackgroundSyncPlugin, Queue, QueueStore, StorableRequest };

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@serwist/background-sync",
-  "version": "9.0.0-preview.1",
+  "version": "9.0.0-preview.11",
   "type": "module",
-  "description": "Queues failed requests and uses the Background Sync API to replay them when the network is available",
+  "description": "A module that queues failed requests and uses the Background Synchronization API to replay them when the network is available",
   "files": [
     "src",
     "dist"
@@ -31,13 +31,13 @@
   },
   "dependencies": {
     "idb": "8.0.0",
-    "@serwist/core": "9.0.0-preview.1"
+    "@serwist/core": "9.0.0-preview.11"
   },
   "devDependencies": {
     "cross-env": "7.0.3",
     "rollup": "4.9.6",
-    "typescript": "5.4.0-dev.20240203",
-    "@serwist/constants": "9.0.0-preview.1"
+    "typescript": "5.4.0-dev.20240206",
+    "@serwist/constants": "9.0.0-preview.11"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"

package/src/BackgroundSyncPlugin.ts

@@ -6,7 +6,7 @@
   https://opensource.org/licenses/MIT.
 */
 
-import type { SerwistPlugin } from "@serwist/core";
+import type { FetchDidFailCallbackParam, SerwistPlugin } from "@serwist/core";
 
 import type { QueueOptions } from "./Queue.js";
 import { Queue } from "./Queue.js";
@@ -15,7 +15,7 @@ import { Queue } from "./Queue.js";
  * A class implementing the `fetchDidFail` lifecycle callback. This makes it
  * easier to add failed requests to a background sync Queue.
  */
-class BackgroundSyncPlugin implements SerwistPlugin {
+export class BackgroundSyncPlugin implements SerwistPlugin {
   private readonly _queue: Queue;
 
   /**
@@ -32,9 +32,7 @@ class BackgroundSyncPlugin implements SerwistPlugin {
    * @param options
    * @private
    */
-  fetchDidFail: SerwistPlugin["fetchDidFail"] = async ({ request }) => {
+  async fetchDidFail({ request }: FetchDidFailCallbackParam) {
     await this._queue.pushRequest({ request });
-  };
+  }
 }
-
-export { BackgroundSyncPlugin };

package/src/Queue.ts

@@ -101,7 +101,7 @@ const convertEntry = (queueStoreEntry: UnidentifiedQueueStoreEntry): QueueEntry
  * later. All parts of the storing and replaying process are observable via
  * callbacks.
  */
-class Queue {
+export class Queue {
   private readonly _name: string;
   private readonly _onSync: OnSyncCallback;
   private readonly _maxRetentionTime: number;
@@ -194,8 +194,7 @@ class Queue {
 
   /**
    * Removes and returns the last request in the queue (along with its
-   * timestamp and any metadata). The returned object takes the form:
-   * `{request, timestamp, metadata}`.
+   * timestamp and any metadata).
    *
    * @returns
    */
@@ -205,8 +204,7 @@ class Queue {
 
   /**
    * Removes and returns the first request in the queue (along with its
-   * timestamp and any metadata). The returned object takes the form:
-   * `{request, timestamp, metadata}`.
+   * timestamp and any metadata).
    *
    * @returns
    */
@@ -440,5 +438,3 @@ class Queue {
     return queueNames;
   }
 }
-
-export { Queue };

package/src/StorableRequest.ts

@@ -36,7 +36,7 @@ export interface RequestData extends MapLikeObject {
  * Most developers will not need to access this class directly;
  * it is exposed for advanced use cases.
  */
-class StorableRequest {
+export class StorableRequest {
   private readonly _requestData: RequestData;
 
   /**
@@ -140,5 +140,3 @@ class StorableRequest {
     return new StorableRequest(this.toObject());
   }
 }
-
-export { StorableRequest };