@serwist/background-sync 9.0.0-preview.2 → 9.0.0-preview.20

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/index.d.ts

@@ -1,24 +1,3 @@
-import { BackgroundSyncPlugin } from "./BackgroundSyncPlugin.js";
-import type { QueueEntry, QueueOptions } from "./Queue.js";
-import { Queue } from "./Queue.js";
-import { QueueStore } from "./QueueStore.js";
-import { StorableRequest } from "./StorableRequest.js";
-interface SyncManager {
-    getTags(): Promise<string[]>;
-    register(tag: string): Promise<void>;
-}
-declare global {
-    interface ServiceWorkerRegistration {
-        readonly sync: SyncManager;
-    }
-    interface SyncEvent extends ExtendableEvent {
-        readonly lastChance: boolean;
-        readonly tag: string;
-    }
-    interface ServiceWorkerGlobalScopeEventMap {
-        sync: SyncEvent;
-    }
-}
-export { BackgroundSyncPlugin, Queue, QueueStore, StorableRequest };
-export type { QueueOptions, QueueEntry };
+export { BackgroundSyncPlugin, BackgroundSyncQueue as Queue, BackgroundSyncQueueStore as QueueStore, StorableRequest } from "@serwist/sw/plugins";
+export type { BackgroundSyncQueueOptions as QueueOptions, BackgroundSyncQueueEntry as QueueEntry } from "@serwist/sw/plugins";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC3D,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAGvD,UAAU,WAAW;IACnB,OAAO,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7B,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtC;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,yBAAyB;QACjC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;KAC5B;IAED,UAAU,SAAU,SAAQ,eAAe;QACzC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;QAC7B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;KACtB;IAED,UAAU,gCAAgC;QACxC,IAAI,EAAE,SAAS,CAAC;KACjB;CACF;AAED,OAAO,EAAE,oBAAoB,EAAE,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC;AAEpE,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,IAAI,KAAK,EAAE,wBAAwB,IAAI,UAAU,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAClJ,YAAY,EAAE,0BAA0B,IAAI,YAAY,EAAE,wBAAwB,IAAI,UAAU,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -1,441 +1 @@
-import { assert, SerwistError, logger, getFriendlyURL } from '@serwist/core/internal';
-import { openDB } from 'idb';
-
-const DB_VERSION = 3;
-const DB_NAME = "serwist-background-sync";
-const REQUEST_OBJECT_STORE_NAME = "requests";
-const QUEUE_NAME_INDEX = "queueName";
-class QueueDb {
-    _db = null;
-    async addEntry(entry) {
-        const db = await this.getDb();
-        const tx = db.transaction(REQUEST_OBJECT_STORE_NAME, "readwrite", {
-            durability: "relaxed"
-        });
-        await tx.store.add(entry);
-        await tx.done;
-    }
-    async getFirstEntryId() {
-        const db = await this.getDb();
-        const cursor = await db.transaction(REQUEST_OBJECT_STORE_NAME).store.openCursor();
-        return cursor?.value.id;
-    }
-    async getAllEntriesByQueueName(queueName) {
-        const db = await this.getDb();
-        const results = await db.getAllFromIndex(REQUEST_OBJECT_STORE_NAME, QUEUE_NAME_INDEX, IDBKeyRange.only(queueName));
-        return results ? results : new Array();
-    }
-    async getEntryCountByQueueName(queueName) {
-        const db = await this.getDb();
-        return db.countFromIndex(REQUEST_OBJECT_STORE_NAME, QUEUE_NAME_INDEX, IDBKeyRange.only(queueName));
-    }
-    async deleteEntry(id) {
-        const db = await this.getDb();
-        await db.delete(REQUEST_OBJECT_STORE_NAME, id);
-    }
-    async getFirstEntryByQueueName(queueName) {
-        return await this.getEndEntryFromIndex(IDBKeyRange.only(queueName), "next");
-    }
-    async getLastEntryByQueueName(queueName) {
-        return await this.getEndEntryFromIndex(IDBKeyRange.only(queueName), "prev");
-    }
-    async getEndEntryFromIndex(query, direction) {
-        const db = await this.getDb();
-        const cursor = await db.transaction(REQUEST_OBJECT_STORE_NAME).store.index(QUEUE_NAME_INDEX).openCursor(query, direction);
-        return cursor?.value;
-    }
-    async getDb() {
-        if (!this._db) {
-            this._db = await openDB(DB_NAME, DB_VERSION, {
-                upgrade: this._upgradeDb
-            });
-        }
-        return this._db;
-    }
-    _upgradeDb(db, oldVersion) {
-        if (oldVersion > 0 && oldVersion < DB_VERSION) {
-            if (db.objectStoreNames.contains(REQUEST_OBJECT_STORE_NAME)) {
-                db.deleteObjectStore(REQUEST_OBJECT_STORE_NAME);
-            }
-        }
-        const objStore = db.createObjectStore(REQUEST_OBJECT_STORE_NAME, {
-            autoIncrement: true,
-            keyPath: "id"
-        });
-        objStore.createIndex(QUEUE_NAME_INDEX, QUEUE_NAME_INDEX, {
-            unique: false
-        });
-    }
-}
-
-class QueueStore {
-    _queueName;
-    _queueDb;
-    constructor(queueName){
-        this._queueName = queueName;
-        this._queueDb = new QueueDb();
-    }
-    async pushEntry(entry) {
-        if (process.env.NODE_ENV !== "production") {
-            assert.isType(entry, "object", {
-                moduleName: "@serwist/background-sync",
-                className: "QueueStore",
-                funcName: "pushEntry",
-                paramName: "entry"
-            });
-            assert.isType(entry.requestData, "object", {
-                moduleName: "@serwist/background-sync",
-                className: "QueueStore",
-                funcName: "pushEntry",
-                paramName: "entry.requestData"
-            });
-        }
-        delete entry.id;
-        entry.queueName = this._queueName;
-        await this._queueDb.addEntry(entry);
-    }
-    async unshiftEntry(entry) {
-        if (process.env.NODE_ENV !== "production") {
-            assert.isType(entry, "object", {
-                moduleName: "@serwist/background-sync",
-                className: "QueueStore",
-                funcName: "unshiftEntry",
-                paramName: "entry"
-            });
-            assert.isType(entry.requestData, "object", {
-                moduleName: "@serwist/background-sync",
-                className: "QueueStore",
-                funcName: "unshiftEntry",
-                paramName: "entry.requestData"
-            });
-        }
-        const firstId = await this._queueDb.getFirstEntryId();
-        if (firstId) {
-            entry.id = firstId - 1;
-        } else {
-            delete entry.id;
-        }
-        entry.queueName = this._queueName;
-        await this._queueDb.addEntry(entry);
-    }
-    async popEntry() {
-        return this._removeEntry(await this._queueDb.getLastEntryByQueueName(this._queueName));
-    }
-    async shiftEntry() {
-        return this._removeEntry(await this._queueDb.getFirstEntryByQueueName(this._queueName));
-    }
-    async getAll() {
-        return await this._queueDb.getAllEntriesByQueueName(this._queueName);
-    }
-    async size() {
-        return await this._queueDb.getEntryCountByQueueName(this._queueName);
-    }
-    async deleteEntry(id) {
-        await this._queueDb.deleteEntry(id);
-    }
-    async _removeEntry(entry) {
-        if (entry) {
-            await this.deleteEntry(entry.id);
-        }
-        return entry;
-    }
-}
-
-const serializableProperties = [
-    "method",
-    "referrer",
-    "referrerPolicy",
-    "mode",
-    "credentials",
-    "cache",
-    "redirect",
-    "integrity",
-    "keepalive"
-];
-class StorableRequest {
-    _requestData;
-    static async fromRequest(request) {
-        const requestData = {
-            url: request.url,
-            headers: {}
-        };
-        if (request.method !== "GET") {
-            requestData.body = await request.clone().arrayBuffer();
-        }
-        request.headers.forEach((value, key)=>{
-            requestData.headers[key] = value;
-        });
-        for (const prop of serializableProperties){
-            if (request[prop] !== undefined) {
-                requestData[prop] = request[prop];
-            }
-        }
-        return new StorableRequest(requestData);
-    }
-    constructor(requestData){
-        if (process.env.NODE_ENV !== "production") {
-            assert.isType(requestData, "object", {
-                moduleName: "@serwist/background-sync",
-                className: "StorableRequest",
-                funcName: "constructor",
-                paramName: "requestData"
-            });
-            assert.isType(requestData.url, "string", {
-                moduleName: "@serwist/background-sync",
-                className: "StorableRequest",
-                funcName: "constructor",
-                paramName: "requestData.url"
-            });
-        }
-        if (requestData.mode === "navigate") {
-            requestData.mode = "same-origin";
-        }
-        this._requestData = requestData;
-    }
-    toObject() {
-        const requestData = Object.assign({}, this._requestData);
-        requestData.headers = Object.assign({}, this._requestData.headers);
-        if (requestData.body) {
-            requestData.body = requestData.body.slice(0);
-        }
-        return requestData;
-    }
-    toRequest() {
-        return new Request(this._requestData.url, this._requestData);
-    }
-    clone() {
-        return new StorableRequest(this.toObject());
-    }
-}
-
-const TAG_PREFIX = "serwist-background-sync";
-const MAX_RETENTION_TIME = 60 * 24 * 7;
-const queueNames = new Set();
-const convertEntry = (queueStoreEntry)=>{
-    const queueEntry = {
-        request: new StorableRequest(queueStoreEntry.requestData).toRequest(),
-        timestamp: queueStoreEntry.timestamp
-    };
-    if (queueStoreEntry.metadata) {
-        queueEntry.metadata = queueStoreEntry.metadata;
-    }
-    return queueEntry;
-};
-class Queue {
-    _name;
-    _onSync;
-    _maxRetentionTime;
-    _queueStore;
-    _forceSyncFallback;
-    _syncInProgress = false;
-    _requestsAddedDuringSync = false;
-    constructor(name, { forceSyncFallback, onSync, maxRetentionTime } = {}){
-        if (queueNames.has(name)) {
-            throw new SerwistError("duplicate-queue-name", {
-                name
-            });
-        }
-        queueNames.add(name);
-        this._name = name;
-        this._onSync = onSync || this.replayRequests;
-        this._maxRetentionTime = maxRetentionTime || MAX_RETENTION_TIME;
-        this._forceSyncFallback = Boolean(forceSyncFallback);
-        this._queueStore = new QueueStore(this._name);
-        this._addSyncListener();
-    }
-    get name() {
-        return this._name;
-    }
-    async pushRequest(entry) {
-        if (process.env.NODE_ENV !== "production") {
-            assert.isType(entry, "object", {
-                moduleName: "@serwist/background-sync",
-                className: "Queue",
-                funcName: "pushRequest",
-                paramName: "entry"
-            });
-            assert.isInstance(entry.request, Request, {
-                moduleName: "@serwist/background-sync",
-                className: "Queue",
-                funcName: "pushRequest",
-                paramName: "entry.request"
-            });
-        }
-        await this._addRequest(entry, "push");
-    }
-    async unshiftRequest(entry) {
-        if (process.env.NODE_ENV !== "production") {
-            assert.isType(entry, "object", {
-                moduleName: "@serwist/background-sync",
-                className: "Queue",
-                funcName: "unshiftRequest",
-                paramName: "entry"
-            });
-            assert.isInstance(entry.request, Request, {
-                moduleName: "@serwist/background-sync",
-                className: "Queue",
-                funcName: "unshiftRequest",
-                paramName: "entry.request"
-            });
-        }
-        await this._addRequest(entry, "unshift");
-    }
-    async popRequest() {
-        return this._removeRequest("pop");
-    }
-    async shiftRequest() {
-        return this._removeRequest("shift");
-    }
-    async getAll() {
-        const allEntries = await this._queueStore.getAll();
-        const now = Date.now();
-        const unexpiredEntries = [];
-        for (const entry of allEntries){
-            const maxRetentionTimeInMs = this._maxRetentionTime * 60 * 1000;
-            if (now - entry.timestamp > maxRetentionTimeInMs) {
-                await this._queueStore.deleteEntry(entry.id);
-            } else {
-                unexpiredEntries.push(convertEntry(entry));
-            }
-        }
-        return unexpiredEntries;
-    }
-    async size() {
-        return await this._queueStore.size();
-    }
-    async _addRequest({ request, metadata, timestamp = Date.now() }, operation) {
-        const storableRequest = await StorableRequest.fromRequest(request.clone());
-        const entry = {
-            requestData: storableRequest.toObject(),
-            timestamp
-        };
-        if (metadata) {
-            entry.metadata = metadata;
-        }
-        switch(operation){
-            case "push":
-                await this._queueStore.pushEntry(entry);
-                break;
-            case "unshift":
-                await this._queueStore.unshiftEntry(entry);
-                break;
-        }
-        if (process.env.NODE_ENV !== "production") {
-            logger.log(`Request for '${getFriendlyURL(request.url)}' has ` + `been added to background sync queue '${this._name}'.`);
-        }
-        if (this._syncInProgress) {
-            this._requestsAddedDuringSync = true;
-        } else {
-            await this.registerSync();
-        }
-    }
-    async _removeRequest(operation) {
-        const now = Date.now();
-        let entry;
-        switch(operation){
-            case "pop":
-                entry = await this._queueStore.popEntry();
-                break;
-            case "shift":
-                entry = await this._queueStore.shiftEntry();
-                break;
-        }
-        if (entry) {
-            const maxRetentionTimeInMs = this._maxRetentionTime * 60 * 1000;
-            if (now - entry.timestamp > maxRetentionTimeInMs) {
-                return this._removeRequest(operation);
-            }
-            return convertEntry(entry);
-        }
-        return undefined;
-    }
-    async replayRequests() {
-        let entry = undefined;
-        while(entry = await this.shiftRequest()){
-            try {
-                await fetch(entry.request.clone());
-                if (process.env.NODE_ENV !== "production") {
-                    logger.log(`Request for '${getFriendlyURL(entry.request.url)}' ` + `has been replayed in queue '${this._name}'`);
-                }
-            } catch (error) {
-                await this.unshiftRequest(entry);
-                if (process.env.NODE_ENV !== "production") {
-                    logger.log(`Request for '${getFriendlyURL(entry.request.url)}' ` + `failed to replay, putting it back in queue '${this._name}'`);
-                }
-                throw new SerwistError("queue-replay-failed", {
-                    name: this._name
-                });
-            }
-        }
-        if (process.env.NODE_ENV !== "production") {
-            logger.log(`All requests in queue '${this.name}' have successfully replayed; the queue is now empty!`);
-        }
-    }
-    async registerSync() {
-        if ("sync" in self.registration && !this._forceSyncFallback) {
-            try {
-                await self.registration.sync.register(`${TAG_PREFIX}:${this._name}`);
-            } catch (err) {
-                if (process.env.NODE_ENV !== "production") {
-                    logger.warn(`Unable to register sync event for '${this._name}'.`, err);
-                }
-            }
-        }
-    }
-    _addSyncListener() {
-        if ("sync" in self.registration && !this._forceSyncFallback) {
-            self.addEventListener("sync", (event)=>{
-                if (event.tag === `${TAG_PREFIX}:${this._name}`) {
-                    if (process.env.NODE_ENV !== "production") {
-                        logger.log(`Background sync for tag '${event.tag}' has been received`);
-                    }
-                    const syncComplete = async ()=>{
-                        this._syncInProgress = true;
-                        let syncError = undefined;
-                        try {
-                            await this._onSync({
-                                queue: this
-                            });
-                        } catch (error) {
-                            if (error instanceof Error) {
-                                syncError = error;
-                                throw syncError;
-                            }
-                        } finally{
-                            if (this._requestsAddedDuringSync && !(syncError && !event.lastChance)) {
-                                await this.registerSync();
-                            }
-                            this._syncInProgress = false;
-                            this._requestsAddedDuringSync = false;
-                        }
-                    };
-                    event.waitUntil(syncComplete());
-                }
-            });
-        } else {
-            if (process.env.NODE_ENV !== "production") {
-                logger.log("Background sync replaying without background sync event");
-            }
-            void this._onSync({
-                queue: this
-            });
-        }
-    }
-    static get _queueNames() {
-        return queueNames;
-    }
-}
-
-class BackgroundSyncPlugin {
-    _queue;
-    constructor(name, options){
-        this._queue = new Queue(name, options);
-    }
-    fetchDidFail = async ({ request })=>{
-        await this._queue.pushRequest({
-            request
-        });
-    };
-}
-
-export { BackgroundSyncPlugin, Queue, QueueStore, StorableRequest };
+export { BackgroundSyncPlugin, BackgroundSyncQueue as Queue, BackgroundSyncQueueStore as QueueStore, StorableRequest } from '@serwist/sw/plugins';

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@serwist/background-sync",
-  "version": "9.0.0-preview.2",
+  "version": "9.0.0-preview.20",
   "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"
@@ -18,8 +18,8 @@
   ],
   "author": "Google's Web DevRel Team, Serwist's Team",
   "license": "MIT",
-  "repository": "serwist/serwist",
-  "bugs": "https://github.com/serwist/serwist/issues",
+  "repository": "https://gitlab.com/serwist/serwist",
+  "bugs": "https://gitlab.com/serwist/serwist/issues",
   "homepage": "https://serwist.pages.dev",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -30,14 +30,13 @@
     }
   },
   "dependencies": {
-    "idb": "8.0.0",
-    "@serwist/core": "9.0.0-preview.2"
+    "@serwist/sw": "9.0.0-preview.20"
   },
   "devDependencies": {
     "cross-env": "7.0.3",
-    "rollup": "4.9.6",
-    "typescript": "5.4.0-dev.20240206",
-    "@serwist/constants": "9.0.0-preview.2"
+    "rollup": "4.13.0",
+    "typescript": "5.5.0-dev.20240323",
+    "@serwist/constants": "9.0.0-preview.20"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"
@@ -49,7 +48,6 @@
   },
   "scripts": {
     "build": "rimraf dist && cross-env NODE_ENV=production rollup --config rollup.config.js",
-    "dev": "rollup --config rollup.config.js --watch",
     "lint": "biome lint ./src",
     "typecheck": "tsc"
   }

package/src/index.ts

@@ -1,37 +1,2 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-import { BackgroundSyncPlugin } from "./BackgroundSyncPlugin.js";
-import type { QueueEntry, QueueOptions } from "./Queue.js";
-import { Queue } from "./Queue.js";
-import { QueueStore } from "./QueueStore.js";
-import { StorableRequest } from "./StorableRequest.js";
-
-// See https://github.com/GoogleChrome/workbox/issues/2946
-interface SyncManager {
-  getTags(): Promise<string[]>;
-  register(tag: string): Promise<void>;
-}
-
-declare global {
-  interface ServiceWorkerRegistration {
-    readonly sync: SyncManager;
-  }
-
-  interface SyncEvent extends ExtendableEvent {
-    readonly lastChance: boolean;
-    readonly tag: string;
-  }
-
-  interface ServiceWorkerGlobalScopeEventMap {
-    sync: SyncEvent;
-  }
-}
-
-export { BackgroundSyncPlugin, Queue, QueueStore, StorableRequest };
-
-export type { QueueOptions, QueueEntry };
+export { BackgroundSyncPlugin, BackgroundSyncQueue as Queue, BackgroundSyncQueueStore as QueueStore, StorableRequest } from "@serwist/sw/plugins";
+export type { BackgroundSyncQueueOptions as QueueOptions, BackgroundSyncQueueEntry as QueueEntry } from "@serwist/sw/plugins";

package/dist/BackgroundSyncPlugin.d.ts

@@ -1,23 +0,0 @@
-import type { 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 {
-    private readonly _queue;
-    /**
-     * @param name See the `@serwist/background-sync.Queue`
-     * documentation for parameter details.
-     * @param options See the `@serwist/background-sync.Queue`
-     * documentation for parameter details.
-     */
-    constructor(name: string, options?: QueueOptions);
-    /**
-     * @param options
-     * @private
-     */
-    fetchDidFail: SerwistPlugin["fetchDidFail"];
-}
-export { BackgroundSyncPlugin };
-//# sourceMappingURL=BackgroundSyncPlugin.d.ts.map

package/dist/BackgroundSyncPlugin.d.ts.map

@@ -1 +0,0 @@
-{"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"}