@serwist/expiration 9.0.0-preview.2 → 9.0.0-preview.20

package/dist/index.d.ts

@@ -1,6 +1,3 @@
-import { CacheExpiration } from "./CacheExpiration.js";
-import type { ExpirationPluginOptions } from "./ExpirationPlugin.js";
-import { ExpirationPlugin } from "./ExpirationPlugin.js";
-export { CacheExpiration, ExpirationPlugin };
-export type { ExpirationPluginOptions };
+export { CacheExpiration, ExpirationPlugin } from "@serwist/sw/plugins";
+export type { ExpirationPluginOptions } 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":"AAQA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,CAAC;AAE7C,YAAY,EAAE,uBAAuB,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACxE,YAAY,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -1,318 +1 @@
-import { assert, SerwistError, logger, dontWaitFor, privateCacheNames, getFriendlyURL } from '@serwist/core/internal';
-import { deleteDB, openDB } from 'idb';
-import { registerQuotaErrorCallback } from '@serwist/core';
-
-const DB_NAME = "serwist-expiration";
-const CACHE_OBJECT_STORE = "cache-entries";
-const normalizeURL = (unNormalizedUrl)=>{
-    const url = new URL(unNormalizedUrl, location.href);
-    url.hash = "";
-    return url.href;
-};
-class CacheTimestampsModel {
-    _cacheName;
-    _db = null;
-    constructor(cacheName){
-        this._cacheName = cacheName;
-    }
-    _upgradeDb(db) {
-        const objStore = db.createObjectStore(CACHE_OBJECT_STORE, {
-            keyPath: "id"
-        });
-        objStore.createIndex("cacheName", "cacheName", {
-            unique: false
-        });
-        objStore.createIndex("timestamp", "timestamp", {
-            unique: false
-        });
-    }
-    _upgradeDbAndDeleteOldDbs(db) {
-        this._upgradeDb(db);
-        if (this._cacheName) {
-            void deleteDB(this._cacheName);
-        }
-    }
-    async setTimestamp(url, timestamp) {
-        url = normalizeURL(url);
-        const entry = {
-            url,
-            timestamp,
-            cacheName: this._cacheName,
-            id: this._getId(url)
-        };
-        const db = await this.getDb();
-        const tx = db.transaction(CACHE_OBJECT_STORE, "readwrite", {
-            durability: "relaxed"
-        });
-        await tx.store.put(entry);
-        await tx.done;
-    }
-    async getTimestamp(url) {
-        const db = await this.getDb();
-        const entry = await db.get(CACHE_OBJECT_STORE, this._getId(url));
-        return entry?.timestamp;
-    }
-    async expireEntries(minTimestamp, maxCount) {
-        const db = await this.getDb();
-        let cursor = await db.transaction(CACHE_OBJECT_STORE).store.index("timestamp").openCursor(null, "prev");
-        const entriesToDelete = [];
-        let entriesNotDeletedCount = 0;
-        while(cursor){
-            const result = cursor.value;
-            if (result.cacheName === this._cacheName) {
-                if (minTimestamp && result.timestamp < minTimestamp || maxCount && entriesNotDeletedCount >= maxCount) {
-                    entriesToDelete.push(cursor.value);
-                } else {
-                    entriesNotDeletedCount++;
-                }
-            }
-            cursor = await cursor.continue();
-        }
-        const urlsDeleted = [];
-        for (const entry of entriesToDelete){
-            await db.delete(CACHE_OBJECT_STORE, entry.id);
-            urlsDeleted.push(entry.url);
-        }
-        return urlsDeleted;
-    }
-    _getId(url) {
-        return `${this._cacheName}|${normalizeURL(url)}`;
-    }
-    async getDb() {
-        if (!this._db) {
-            this._db = await openDB(DB_NAME, 1, {
-                upgrade: this._upgradeDbAndDeleteOldDbs.bind(this)
-            });
-        }
-        return this._db;
-    }
-}
-
-class CacheExpiration {
-    _isRunning = false;
-    _rerunRequested = false;
-    _maxEntries;
-    _maxAgeSeconds;
-    _matchOptions;
-    _cacheName;
-    _timestampModel;
-    constructor(cacheName, config = {}){
-        if (process.env.NODE_ENV !== "production") {
-            assert.isType(cacheName, "string", {
-                moduleName: "@serwist/expiration",
-                className: "CacheExpiration",
-                funcName: "constructor",
-                paramName: "cacheName"
-            });
-            if (!(config.maxEntries || config.maxAgeSeconds)) {
-                throw new SerwistError("max-entries-or-age-required", {
-                    moduleName: "@serwist/expiration",
-                    className: "CacheExpiration",
-                    funcName: "constructor"
-                });
-            }
-            if (config.maxEntries) {
-                assert.isType(config.maxEntries, "number", {
-                    moduleName: "@serwist/expiration",
-                    className: "CacheExpiration",
-                    funcName: "constructor",
-                    paramName: "config.maxEntries"
-                });
-            }
-            if (config.maxAgeSeconds) {
-                assert.isType(config.maxAgeSeconds, "number", {
-                    moduleName: "@serwist/expiration",
-                    className: "CacheExpiration",
-                    funcName: "constructor",
-                    paramName: "config.maxAgeSeconds"
-                });
-            }
-        }
-        this._maxEntries = config.maxEntries;
-        this._maxAgeSeconds = config.maxAgeSeconds;
-        this._matchOptions = config.matchOptions;
-        this._cacheName = cacheName;
-        this._timestampModel = new CacheTimestampsModel(cacheName);
-    }
-    async expireEntries() {
-        if (this._isRunning) {
-            this._rerunRequested = true;
-            return;
-        }
-        this._isRunning = true;
-        const minTimestamp = this._maxAgeSeconds ? Date.now() - this._maxAgeSeconds * 1000 : 0;
-        const urlsExpired = await this._timestampModel.expireEntries(minTimestamp, this._maxEntries);
-        const cache = await self.caches.open(this._cacheName);
-        for (const url of urlsExpired){
-            await cache.delete(url, this._matchOptions);
-        }
-        if (process.env.NODE_ENV !== "production") {
-            if (urlsExpired.length > 0) {
-                logger.groupCollapsed(`Expired ${urlsExpired.length} ` + `${urlsExpired.length === 1 ? "entry" : "entries"} and removed ` + `${urlsExpired.length === 1 ? "it" : "them"} from the ` + `'${this._cacheName}' cache.`);
-                logger.log(`Expired the following ${urlsExpired.length === 1 ? "URL" : "URLs"}:`);
-                for (const url of urlsExpired){
-                    logger.log(`    ${url}`);
-                }
-                logger.groupEnd();
-            } else {
-                logger.debug("Cache expiration ran and found no entries to remove.");
-            }
-        }
-        this._isRunning = false;
-        if (this._rerunRequested) {
-            this._rerunRequested = false;
-            dontWaitFor(this.expireEntries());
-        }
-    }
-    async updateTimestamp(url) {
-        if (process.env.NODE_ENV !== "production") {
-            assert.isType(url, "string", {
-                moduleName: "@serwist/expiration",
-                className: "CacheExpiration",
-                funcName: "updateTimestamp",
-                paramName: "url"
-            });
-        }
-        await this._timestampModel.setTimestamp(url, Date.now());
-    }
-    async isURLExpired(url) {
-        if (!this._maxAgeSeconds) {
-            if (process.env.NODE_ENV !== "production") {
-                throw new SerwistError("expired-test-without-max-age", {
-                    methodName: "isURLExpired",
-                    paramName: "maxAgeSeconds"
-                });
-            }
-            return false;
-        }
-        const timestamp = await this._timestampModel.getTimestamp(url);
-        const expireOlderThan = Date.now() - this._maxAgeSeconds * 1000;
-        return timestamp !== undefined ? timestamp < expireOlderThan : true;
-    }
-    async delete() {
-        this._rerunRequested = false;
-        await this._timestampModel.expireEntries(Infinity);
-    }
-}
-
-class ExpirationPlugin {
-    _config;
-    _maxAgeSeconds;
-    _cacheExpirations;
-    constructor(config = {}){
-        if (process.env.NODE_ENV !== "production") {
-            if (!(config.maxEntries || config.maxAgeSeconds)) {
-                throw new SerwistError("max-entries-or-age-required", {
-                    moduleName: "@serwist/expiration",
-                    className: "Plugin",
-                    funcName: "constructor"
-                });
-            }
-            if (config.maxEntries) {
-                assert.isType(config.maxEntries, "number", {
-                    moduleName: "@serwist/expiration",
-                    className: "Plugin",
-                    funcName: "constructor",
-                    paramName: "config.maxEntries"
-                });
-            }
-            if (config.maxAgeSeconds) {
-                assert.isType(config.maxAgeSeconds, "number", {
-                    moduleName: "@serwist/expiration",
-                    className: "Plugin",
-                    funcName: "constructor",
-                    paramName: "config.maxAgeSeconds"
-                });
-            }
-        }
-        this._config = config;
-        this._maxAgeSeconds = config.maxAgeSeconds;
-        this._cacheExpirations = new Map();
-        if (config.purgeOnQuotaError) {
-            registerQuotaErrorCallback(()=>this.deleteCacheAndMetadata());
-        }
-    }
-    _getCacheExpiration(cacheName) {
-        if (cacheName === privateCacheNames.getRuntimeName()) {
-            throw new SerwistError("expire-custom-caches-only");
-        }
-        let cacheExpiration = this._cacheExpirations.get(cacheName);
-        if (!cacheExpiration) {
-            cacheExpiration = new CacheExpiration(cacheName, this._config);
-            this._cacheExpirations.set(cacheName, cacheExpiration);
-        }
-        return cacheExpiration;
-    }
-    cachedResponseWillBeUsed = async ({ event, request, cacheName, cachedResponse })=>{
-        if (!cachedResponse) {
-            return null;
-        }
-        const isFresh = this._isResponseDateFresh(cachedResponse);
-        const cacheExpiration = this._getCacheExpiration(cacheName);
-        dontWaitFor(cacheExpiration.expireEntries());
-        const updateTimestampDone = cacheExpiration.updateTimestamp(request.url);
-        if (event) {
-            try {
-                event.waitUntil(updateTimestampDone);
-            } catch (error) {
-                if (process.env.NODE_ENV !== "production") {
-                    if ("request" in event) {
-                        logger.warn(`Unable to ensure service worker stays alive when updating cache entry for '${getFriendlyURL(event.request.url)}'.`);
-                    }
-                }
-            }
-        }
-        return isFresh ? cachedResponse : null;
-    };
-    _isResponseDateFresh(cachedResponse) {
-        if (!this._maxAgeSeconds) {
-            return true;
-        }
-        const dateHeaderTimestamp = this._getDateHeaderTimestamp(cachedResponse);
-        if (dateHeaderTimestamp === null) {
-            return true;
-        }
-        const now = Date.now();
-        return dateHeaderTimestamp >= now - this._maxAgeSeconds * 1000;
-    }
-    _getDateHeaderTimestamp(cachedResponse) {
-        if (!cachedResponse.headers.has("date")) {
-            return null;
-        }
-        const dateHeader = cachedResponse.headers.get("date");
-        const parsedDate = new Date(dateHeader);
-        const headerTime = parsedDate.getTime();
-        if (Number.isNaN(headerTime)) {
-            return null;
-        }
-        return headerTime;
-    }
-    cacheDidUpdate = async ({ cacheName, request })=>{
-        if (process.env.NODE_ENV !== "production") {
-            assert.isType(cacheName, "string", {
-                moduleName: "@serwist/expiration",
-                className: "Plugin",
-                funcName: "cacheDidUpdate",
-                paramName: "cacheName"
-            });
-            assert.isInstance(request, Request, {
-                moduleName: "@serwist/expiration",
-                className: "Plugin",
-                funcName: "cacheDidUpdate",
-                paramName: "request"
-            });
-        }
-        const cacheExpiration = this._getCacheExpiration(cacheName);
-        await cacheExpiration.updateTimestamp(request.url);
-        await cacheExpiration.expireEntries();
-    };
-    async deleteCacheAndMetadata() {
-        for (const [cacheName, cacheExpiration] of this._cacheExpirations){
-            await self.caches.delete(cacheName);
-            await cacheExpiration.delete();
-        }
-        this._cacheExpirations = new Map();
-    }
-}
-
-export { CacheExpiration, ExpirationPlugin };
+export { CacheExpiration, ExpirationPlugin } from '@serwist/sw/plugins';

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@serwist/expiration",
-  "version": "9.0.0-preview.2",
+  "version": "9.0.0-preview.20",
   "type": "module",
-  "description": "A service worker helper library that expires cached responses based on age or maximum number of entries.",
+  "description": "A module that expires cached responses based on age or maximum number of entries.",
   "files": [
     "src",
     "dist"
@@ -16,8 +16,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",
@@ -29,13 +29,12 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "idb": "8.0.0",
-    "@serwist/core": "9.0.0-preview.2"
+    "@serwist/sw": "9.0.0-preview.20"
   },
   "devDependencies": {
-    "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"
@@ -47,7 +46,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,15 +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 { CacheExpiration } from "./CacheExpiration.js";
-import type { ExpirationPluginOptions } from "./ExpirationPlugin.js";
-import { ExpirationPlugin } from "./ExpirationPlugin.js";
-
-export { CacheExpiration, ExpirationPlugin };
-
-export type { ExpirationPluginOptions };
+export { CacheExpiration, ExpirationPlugin } from "@serwist/sw/plugins";
+export type { ExpirationPluginOptions } from "@serwist/sw/plugins";

package/dist/CacheExpiration.d.ts

@@ -1,69 +0,0 @@
-interface CacheExpirationConfig {
-    /**
-     * The maximum number of entries to cache. Entries used the least will
-     * be removed as the maximum is reached.
-     */
-    maxEntries?: number;
-    /**
-     * The maximum age of an entry before it's treated as stale and removed.
-     */
-    maxAgeSeconds?: number;
-    /**
-     * The [`CacheQueryOptions`](https://developer.mozilla.org/en-US/docs/Web/API/Cache/delete#Parameters)
-     * that will be used when calling `delete()` on the cache.
-     */
-    matchOptions?: CacheQueryOptions;
-}
-/**
- * The `CacheExpiration` class allows you define an expiration and / or
- * limit on the number of responses stored in a
- * [`Cache`](https://developer.mozilla.org/en-US/docs/Web/API/Cache).
- */
-declare class CacheExpiration {
-    private _isRunning;
-    private _rerunRequested;
-    private readonly _maxEntries?;
-    private readonly _maxAgeSeconds?;
-    private readonly _matchOptions?;
-    private readonly _cacheName;
-    private readonly _timestampModel;
-    /**
-     * To construct a new CacheExpiration instance you must provide at least
-     * one of the `config` properties.
-     *
-     * @param cacheName Name of the cache to apply restrictions to.
-     * @param config
-     */
-    constructor(cacheName: string, config?: CacheExpirationConfig);
-    /**
-     * Expires entries for the given cache and given criteria.
-     */
-    expireEntries(): Promise<void>;
-    /**
-     * Update the timestamp for the given URL. This ensures the when
-     * removing entries based on maximum entries, most recently used
-     * is accurate or when expiring, the timestamp is up-to-date.
-     *
-     * @param url
-     */
-    updateTimestamp(url: string): Promise<void>;
-    /**
-     * Can be used to check if a URL has expired or not before it's used.
-     *
-     * This requires a look up from IndexedDB, so can be slow.
-     *
-     * Note: This method will not remove the cached entry, call
-     * `expireEntries()` to remove indexedDB and Cache entries.
-     *
-     * @param url
-     * @returns
-     */
-    isURLExpired(url: string): Promise<boolean>;
-    /**
-     * Removes the IndexedDB object store used to keep track of cache expiration
-     * metadata.
-     */
-    delete(): Promise<void>;
-}
-export { CacheExpiration };
-//# sourceMappingURL=CacheExpiration.d.ts.map

package/dist/CacheExpiration.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CacheExpiration.d.ts","sourceRoot":"","sources":["../src/CacheExpiration.ts"],"names":[],"mappings":"AAYA,UAAU,qBAAqB;IAC7B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,CAAC;CAClC;AAED;;;;GAIG;AACH,cAAM,eAAe;IACnB,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAoB;IACnD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;IAEvD;;;;;;OAMG;gBACS,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,qBAA0B;IA2CjE;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IA0CpC;;;;;;OAMG;IACG,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAajD;;;;;;;;;;OAUG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAejD;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CAM9B;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/dist/ExpirationPlugin.d.ts

@@ -1,116 +0,0 @@
-import type { SerwistPlugin } from "@serwist/core";
-export interface ExpirationPluginOptions {
-    /**
-     * The maximum number of entries to cache. Entries used the least will be removed
-     * as the maximum is reached.
-     */
-    maxEntries?: number;
-    /**
-     * The maximum age of an entry before it's treated as stale and removed.
-     */
-    maxAgeSeconds?: number;
-    /**
-     * The [`CacheQueryOptions`](https://developer.mozilla.org/en-US/docs/Web/API/Cache/delete#Parameters)
-     * that will be used when calling `delete()` on the cache.
-     */
-    matchOptions?: CacheQueryOptions;
-    /**
-     * Whether to opt this cache in to automatic deletion if the available storage quota has been exceeded.
-     */
-    purgeOnQuotaError?: boolean;
-}
-/**
- * This plugin can be used in a `@serwist/strategies` Strategy to regularly enforce a
- * limit on the age and / or the number of cached requests.
- *
- * It can only be used with Strategy instances that have a
- * [custom `cacheName` property set](/web/tools/workbox/guides/configure-workbox#custom_cache_names_in_strategies).
- * In other words, it can't be used to expire entries in strategy that uses the
- * default runtime cache name.
- *
- * Whenever a cached response is used or updated, this plugin will look
- * at the associated cache and remove any old or extra responses.
- *
- * When using `maxAgeSeconds`, responses may be used *once* after expiring
- * because the expiration clean up will not have occurred until *after* the
- * cached response has been used. If the response has a "Date" header, then
- * a light weight expiration check is performed and the response will not be
- * used immediately.
- *
- * When using `maxEntries`, the entry least-recently requested will be removed
- * from the cache first.
- */
-declare class ExpirationPlugin implements SerwistPlugin {
-    private readonly _config;
-    private readonly _maxAgeSeconds?;
-    private _cacheExpirations;
-    /**
-     * @param config
-     */
-    constructor(config?: ExpirationPluginOptions);
-    /**
-     * A simple helper method to return a CacheExpiration instance for a given
-     * cache name.
-     *
-     * @param cacheName
-     * @returns
-     * @private
-     */
-    private _getCacheExpiration;
-    /**
-     * A "lifecycle" callback that will be triggered automatically by the
-     * `@serwist/strategies` handlers when a `Response` is about to be returned
-     * from a [Cache](https://developer.mozilla.org/en-US/docs/Web/API/Cache) to
-     * the handler. It allows the `Response` to be inspected for freshness and
-     * prevents it from being used if the `Response`'s `Date` header value is
-     * older than the configured `maxAgeSeconds`.
-     *
-     * @param options
-     * @returns Either the `cachedResponse`, if it's fresh, or `null` if the `Response`
-     * is older than `maxAgeSeconds`.
-     * @private
-     */
-    cachedResponseWillBeUsed: SerwistPlugin["cachedResponseWillBeUsed"];
-    /**
-     * @param cachedResponse
-     * @returns
-     * @private
-     */
-    private _isResponseDateFresh;
-    /**
-     * This method will extract the data header and parse it into a useful
-     * value.
-     *
-     * @param cachedResponse
-     * @returns
-     * @private
-     */
-    private _getDateHeaderTimestamp;
-    /**
-     * A "lifecycle" callback that will be triggered automatically by the
-     * `@serwist/strategies` handlers when an entry is added to a cache.
-     *
-     * @param options
-     * @private
-     */
-    cacheDidUpdate: SerwistPlugin["cacheDidUpdate"];
-    /**
-     * This is a helper method that performs two operations:
-     *
-     * - Deletes *all* the underlying Cache instances associated with this plugin
-     * instance, by calling caches.delete() on your behalf.
-     * - Deletes the metadata from IndexedDB used to keep track of expiration
-     * details for each Cache instance.
-     *
-     * When using cache expiration, calling this method is preferable to calling
-     * `caches.delete()` directly, since this will ensure that the IndexedDB
-     * metadata is also cleanly removed and open IndexedDB instances are deleted.
-     *
-     * Note that if you're *not* using cache expiration for a given cache, calling
-     * `caches.delete()` and passing in the cache's name should be sufficient.
-     * There is no Serwist-specific method needed for cleanup in that case.
-     */
-    deleteCacheAndMetadata(): Promise<void>;
-}
-export { ExpirationPlugin };
-//# sourceMappingURL=ExpirationPlugin.d.ts.map

package/dist/ExpirationPlugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ExpirationPlugin.d.ts","sourceRoot":"","sources":["../src/ExpirationPlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAMnD,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,CAAC;IACjC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,cAAM,gBAAiB,YAAW,aAAa;IAC7C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA0B;IAClD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAS;IACzC,OAAO,CAAC,iBAAiB,CAA+B;IAExD;;OAEG;gBACS,MAAM,GAAE,uBAA4B;IAsChD;;;;;;;OAOG;IACH,OAAO,CAAC,mBAAmB;IAa3B;;;;;;;;;;;;OAYG;IACH,wBAAwB,EAAE,aAAa,CAAC,0BAA0B,CAAC,CA+BjE;IAEF;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;IAqB5B;;;;;;;OAOG;IACH,OAAO,CAAC,uBAAuB;IAkB/B;;;;;;OAMG;IACH,cAAc,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAmB7C;IAEF;;;;;;;;;;;;;;;OAeG;IACG,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;CAW9C;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/models/CacheTimestampsModel.d.ts

@@ -1,74 +0,0 @@
-/**
- * Returns the timestamp model.
- *
- * @private
- */
-declare class CacheTimestampsModel {
-    private readonly _cacheName;
-    private _db;
-    /**
-     *
-     * @param cacheName
-     *
-     * @private
-     */
-    constructor(cacheName: string);
-    /**
-     * Performs an upgrade of indexedDB.
-     *
-     * @param db
-     *
-     * @private
-     */
-    private _upgradeDb;
-    /**
-     * Performs an upgrade of indexedDB and deletes deprecated DBs.
-     *
-     * @param db
-     *
-     * @private
-     */
-    private _upgradeDbAndDeleteOldDbs;
-    /**
-     * @param url
-     * @param timestamp
-     *
-     * @private
-     */
-    setTimestamp(url: string, timestamp: number): Promise<void>;
-    /**
-     * Returns the timestamp stored for a given URL.
-     *
-     * @param url
-     * @returns
-     * @private
-     */
-    getTimestamp(url: string): Promise<number | undefined>;
-    /**
-     * Iterates through all the entries in the object store (from newest to
-     * oldest) and removes entries once either `maxCount` is reached or the
-     * entry's timestamp is less than `minTimestamp`.
-     *
-     * @param minTimestamp
-     * @param maxCount
-     * @returns
-     * @private
-     */
-    expireEntries(minTimestamp: number, maxCount?: number): Promise<string[]>;
-    /**
-     * Takes a URL and returns an ID that will be unique in the object store.
-     *
-     * @param url
-     * @returns
-     * @private
-     */
-    private _getId;
-    /**
-     * Returns an open connection to the database.
-     *
-     * @private
-     */
-    private getDb;
-}
-export { CacheTimestampsModel };
-//# sourceMappingURL=CacheTimestampsModel.d.ts.map

package/dist/models/CacheTimestampsModel.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CacheTimestampsModel.d.ts","sourceRoot":"","sources":["../../src/models/CacheTimestampsModel.ts"],"names":[],"mappings":"AAoCA;;;;GAIG;AACH,cAAM,oBAAoB;IACxB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,GAAG,CAA4C;IAEvD;;;;;OAKG;gBACS,SAAS,EAAE,MAAM;IAI7B;;;;;;OAMG;IACH,OAAO,CAAC,UAAU;IAgBlB;;;;;;OAMG;IACH,OAAO,CAAC,yBAAyB;IAOjC;;;;;OAKG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBjE;;;;;;OAMG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAM5D;;;;;;;;;OASG;IACG,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IA2C/E;;;;;;OAMG;IACH,OAAO,CAAC,MAAM;IAOd;;;;OAIG;YACW,KAAK;CAQpB;AAED,OAAO,EAAE,oBAAoB,EAAE,CAAC"}

package/src/CacheExpiration.ts

@@ -1,197 +0,0 @@
-/*
-  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 { assert, SerwistError, dontWaitFor, logger } from "@serwist/core/internal";
-
-import { CacheTimestampsModel } from "./models/CacheTimestampsModel.js";
-
-interface CacheExpirationConfig {
-  /**
-   * The maximum number of entries to cache. Entries used the least will
-   * be removed as the maximum is reached.
-   */
-  maxEntries?: number;
-  /**
-   * The maximum age of an entry before it's treated as stale and removed.
-   */
-  maxAgeSeconds?: number;
-  /**
-   * The [`CacheQueryOptions`](https://developer.mozilla.org/en-US/docs/Web/API/Cache/delete#Parameters)
-   * that will be used when calling `delete()` on the cache.
-   */
-  matchOptions?: CacheQueryOptions;
-}
-
-/**
- * The `CacheExpiration` class allows you define an expiration and / or
- * limit on the number of responses stored in a
- * [`Cache`](https://developer.mozilla.org/en-US/docs/Web/API/Cache).
- */
-class CacheExpiration {
-  private _isRunning = false;
-  private _rerunRequested = false;
-  private readonly _maxEntries?: number;
-  private readonly _maxAgeSeconds?: number;
-  private readonly _matchOptions?: CacheQueryOptions;
-  private readonly _cacheName: string;
-  private readonly _timestampModel: CacheTimestampsModel;
-
-  /**
-   * To construct a new CacheExpiration instance you must provide at least
-   * one of the `config` properties.
-   *
-   * @param cacheName Name of the cache to apply restrictions to.
-   * @param config
-   */
-  constructor(cacheName: string, config: CacheExpirationConfig = {}) {
-    if (process.env.NODE_ENV !== "production") {
-      assert!.isType(cacheName, "string", {
-        moduleName: "@serwist/expiration",
-        className: "CacheExpiration",
-        funcName: "constructor",
-        paramName: "cacheName",
-      });
-
-      if (!(config.maxEntries || config.maxAgeSeconds)) {
-        throw new SerwistError("max-entries-or-age-required", {
-          moduleName: "@serwist/expiration",
-          className: "CacheExpiration",
-          funcName: "constructor",
-        });
-      }
-
-      if (config.maxEntries) {
-        assert!.isType(config.maxEntries, "number", {
-          moduleName: "@serwist/expiration",
-          className: "CacheExpiration",
-          funcName: "constructor",
-          paramName: "config.maxEntries",
-        });
-      }
-
-      if (config.maxAgeSeconds) {
-        assert!.isType(config.maxAgeSeconds, "number", {
-          moduleName: "@serwist/expiration",
-          className: "CacheExpiration",
-          funcName: "constructor",
-          paramName: "config.maxAgeSeconds",
-        });
-      }
-    }
-
-    this._maxEntries = config.maxEntries;
-    this._maxAgeSeconds = config.maxAgeSeconds;
-    this._matchOptions = config.matchOptions;
-    this._cacheName = cacheName;
-    this._timestampModel = new CacheTimestampsModel(cacheName);
-  }
-
-  /**
-   * Expires entries for the given cache and given criteria.
-   */
-  async expireEntries(): Promise<void> {
-    if (this._isRunning) {
-      this._rerunRequested = true;
-      return;
-    }
-    this._isRunning = true;
-
-    const minTimestamp = this._maxAgeSeconds ? Date.now() - this._maxAgeSeconds * 1000 : 0;
-
-    const urlsExpired = await this._timestampModel.expireEntries(minTimestamp, this._maxEntries);
-
-    // Delete URLs from the cache
-    const cache = await self.caches.open(this._cacheName);
-    for (const url of urlsExpired) {
-      await cache.delete(url, this._matchOptions);
-    }
-
-    if (process.env.NODE_ENV !== "production") {
-      if (urlsExpired.length > 0) {
-        logger.groupCollapsed(
-          `Expired ${urlsExpired.length} ` +
-            `${urlsExpired.length === 1 ? "entry" : "entries"} and removed ` +
-            `${urlsExpired.length === 1 ? "it" : "them"} from the ` +
-            `'${this._cacheName}' cache.`,
-        );
-        logger.log(`Expired the following ${urlsExpired.length === 1 ? "URL" : "URLs"}:`);
-        for (const url of urlsExpired) {
-          logger.log(`    ${url}`);
-        }
-        logger.groupEnd();
-      } else {
-        logger.debug("Cache expiration ran and found no entries to remove.");
-      }
-    }
-
-    this._isRunning = false;
-    if (this._rerunRequested) {
-      this._rerunRequested = false;
-      dontWaitFor(this.expireEntries());
-    }
-  }
-
-  /**
-   * Update the timestamp for the given URL. This ensures the when
-   * removing entries based on maximum entries, most recently used
-   * is accurate or when expiring, the timestamp is up-to-date.
-   *
-   * @param url
-   */
-  async updateTimestamp(url: string): Promise<void> {
-    if (process.env.NODE_ENV !== "production") {
-      assert!.isType(url, "string", {
-        moduleName: "@serwist/expiration",
-        className: "CacheExpiration",
-        funcName: "updateTimestamp",
-        paramName: "url",
-      });
-    }
-
-    await this._timestampModel.setTimestamp(url, Date.now());
-  }
-
-  /**
-   * Can be used to check if a URL has expired or not before it's used.
-   *
-   * This requires a look up from IndexedDB, so can be slow.
-   *
-   * Note: This method will not remove the cached entry, call
-   * `expireEntries()` to remove indexedDB and Cache entries.
-   *
-   * @param url
-   * @returns
-   */
-  async isURLExpired(url: string): Promise<boolean> {
-    if (!this._maxAgeSeconds) {
-      if (process.env.NODE_ENV !== "production") {
-        throw new SerwistError("expired-test-without-max-age", {
-          methodName: "isURLExpired",
-          paramName: "maxAgeSeconds",
-        });
-      }
-      return false;
-    }
-    const timestamp = await this._timestampModel.getTimestamp(url);
-    const expireOlderThan = Date.now() - this._maxAgeSeconds * 1000;
-    return timestamp !== undefined ? timestamp < expireOlderThan : true;
-  }
-
-  /**
-   * Removes the IndexedDB object store used to keep track of cache expiration
-   * metadata.
-   */
-  async delete(): Promise<void> {
-    // Make sure we don't attempt another rerun if we're called in the middle of
-    // a cache expiration.
-    this._rerunRequested = false;
-    await this._timestampModel.expireEntries(Infinity); // Expires all.
-  }
-}
-
-export { CacheExpiration };

package/src/ExpirationPlugin.ts

@@ -1,279 +0,0 @@
-/*
-  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 type { SerwistPlugin } from "@serwist/core";
-import { registerQuotaErrorCallback } from "@serwist/core";
-import { assert, SerwistError, dontWaitFor, getFriendlyURL, logger, privateCacheNames } from "@serwist/core/internal";
-
-import { CacheExpiration } from "./CacheExpiration.js";
-
-export interface ExpirationPluginOptions {
-  /**
-   * The maximum number of entries to cache. Entries used the least will be removed
-   * as the maximum is reached.
-   */
-  maxEntries?: number;
-  /**
-   * The maximum age of an entry before it's treated as stale and removed.
-   */
-  maxAgeSeconds?: number;
-  /**
-   * The [`CacheQueryOptions`](https://developer.mozilla.org/en-US/docs/Web/API/Cache/delete#Parameters)
-   * that will be used when calling `delete()` on the cache.
-   */
-  matchOptions?: CacheQueryOptions;
-  /**
-   * Whether to opt this cache in to automatic deletion if the available storage quota has been exceeded.
-   */
-  purgeOnQuotaError?: boolean;
-}
-
-/**
- * This plugin can be used in a `@serwist/strategies` Strategy to regularly enforce a
- * limit on the age and / or the number of cached requests.
- *
- * It can only be used with Strategy instances that have a
- * [custom `cacheName` property set](/web/tools/workbox/guides/configure-workbox#custom_cache_names_in_strategies).
- * In other words, it can't be used to expire entries in strategy that uses the
- * default runtime cache name.
- *
- * Whenever a cached response is used or updated, this plugin will look
- * at the associated cache and remove any old or extra responses.
- *
- * When using `maxAgeSeconds`, responses may be used *once* after expiring
- * because the expiration clean up will not have occurred until *after* the
- * cached response has been used. If the response has a "Date" header, then
- * a light weight expiration check is performed and the response will not be
- * used immediately.
- *
- * When using `maxEntries`, the entry least-recently requested will be removed
- * from the cache first.
- */
-class ExpirationPlugin implements SerwistPlugin {
-  private readonly _config: ExpirationPluginOptions;
-  private readonly _maxAgeSeconds?: number;
-  private _cacheExpirations: Map<string, CacheExpiration>;
-
-  /**
-   * @param config
-   */
-  constructor(config: ExpirationPluginOptions = {}) {
-    if (process.env.NODE_ENV !== "production") {
-      if (!(config.maxEntries || config.maxAgeSeconds)) {
-        throw new SerwistError("max-entries-or-age-required", {
-          moduleName: "@serwist/expiration",
-          className: "Plugin",
-          funcName: "constructor",
-        });
-      }
-
-      if (config.maxEntries) {
-        assert!.isType(config.maxEntries, "number", {
-          moduleName: "@serwist/expiration",
-          className: "Plugin",
-          funcName: "constructor",
-          paramName: "config.maxEntries",
-        });
-      }
-
-      if (config.maxAgeSeconds) {
-        assert!.isType(config.maxAgeSeconds, "number", {
-          moduleName: "@serwist/expiration",
-          className: "Plugin",
-          funcName: "constructor",
-          paramName: "config.maxAgeSeconds",
-        });
-      }
-    }
-
-    this._config = config;
-    this._maxAgeSeconds = config.maxAgeSeconds;
-    this._cacheExpirations = new Map();
-
-    if (config.purgeOnQuotaError) {
-      registerQuotaErrorCallback(() => this.deleteCacheAndMetadata());
-    }
-  }
-
-  /**
-   * A simple helper method to return a CacheExpiration instance for a given
-   * cache name.
-   *
-   * @param cacheName
-   * @returns
-   * @private
-   */
-  private _getCacheExpiration(cacheName: string): CacheExpiration {
-    if (cacheName === privateCacheNames.getRuntimeName()) {
-      throw new SerwistError("expire-custom-caches-only");
-    }
-
-    let cacheExpiration = this._cacheExpirations.get(cacheName);
-    if (!cacheExpiration) {
-      cacheExpiration = new CacheExpiration(cacheName, this._config);
-      this._cacheExpirations.set(cacheName, cacheExpiration);
-    }
-    return cacheExpiration;
-  }
-
-  /**
-   * A "lifecycle" callback that will be triggered automatically by the
-   * `@serwist/strategies` handlers when a `Response` is about to be returned
-   * from a [Cache](https://developer.mozilla.org/en-US/docs/Web/API/Cache) to
-   * the handler. It allows the `Response` to be inspected for freshness and
-   * prevents it from being used if the `Response`'s `Date` header value is
-   * older than the configured `maxAgeSeconds`.
-   *
-   * @param options
-   * @returns Either the `cachedResponse`, if it's fresh, or `null` if the `Response`
-   * is older than `maxAgeSeconds`.
-   * @private
-   */
-  cachedResponseWillBeUsed: SerwistPlugin["cachedResponseWillBeUsed"] = async ({ event, request, cacheName, cachedResponse }) => {
-    if (!cachedResponse) {
-      return null;
-    }
-
-    const isFresh = this._isResponseDateFresh(cachedResponse);
-
-    // Expire entries to ensure that even if the expiration date has
-    // expired, it'll only be used once.
-    const cacheExpiration = this._getCacheExpiration(cacheName);
-    dontWaitFor(cacheExpiration.expireEntries());
-
-    // Update the metadata for the request URL to the current timestamp,
-    // but don't `await` it as we don't want to block the response.
-    const updateTimestampDone = cacheExpiration.updateTimestamp(request.url);
-    if (event) {
-      try {
-        event.waitUntil(updateTimestampDone);
-      } catch (error) {
-        if (process.env.NODE_ENV !== "production") {
-          // The event may not be a fetch event; only log the URL if it is.
-          if ("request" in event) {
-            logger.warn(
-              `Unable to ensure service worker stays alive when updating cache entry for '${getFriendlyURL((event as FetchEvent).request.url)}'.`,
-            );
-          }
-        }
-      }
-    }
-
-    return isFresh ? cachedResponse : null;
-  };
-
-  /**
-   * @param cachedResponse
-   * @returns
-   * @private
-   */
-  private _isResponseDateFresh(cachedResponse: Response): boolean {
-    if (!this._maxAgeSeconds) {
-      // We aren't expiring by age, so return true, it's fresh
-      return true;
-    }
-
-    // Check if the 'date' header will suffice a quick expiration check.
-    // See https://github.com/GoogleChromeLabs/sw-toolbox/issues/164 for
-    // discussion.
-    const dateHeaderTimestamp = this._getDateHeaderTimestamp(cachedResponse);
-    if (dateHeaderTimestamp === null) {
-      // Unable to parse date, so assume it's fresh.
-      return true;
-    }
-
-    // If we have a valid headerTime, then our response is fresh iff the
-    // headerTime plus maxAgeSeconds is greater than the current time.
-    const now = Date.now();
-    return dateHeaderTimestamp >= now - this._maxAgeSeconds * 1000;
-  }
-
-  /**
-   * This method will extract the data header and parse it into a useful
-   * value.
-   *
-   * @param cachedResponse
-   * @returns
-   * @private
-   */
-  private _getDateHeaderTimestamp(cachedResponse: Response): number | null {
-    if (!cachedResponse.headers.has("date")) {
-      return null;
-    }
-
-    const dateHeader = cachedResponse.headers.get("date");
-    const parsedDate = new Date(dateHeader!);
-    const headerTime = parsedDate.getTime();
-
-    // If the Date header was invalid for some reason, parsedDate.getTime()
-    // will return NaN.
-    if (Number.isNaN(headerTime)) {
-      return null;
-    }
-
-    return headerTime;
-  }
-
-  /**
-   * A "lifecycle" callback that will be triggered automatically by the
-   * `@serwist/strategies` handlers when an entry is added to a cache.
-   *
-   * @param options
-   * @private
-   */
-  cacheDidUpdate: SerwistPlugin["cacheDidUpdate"] = async ({ cacheName, request }) => {
-    if (process.env.NODE_ENV !== "production") {
-      assert!.isType(cacheName, "string", {
-        moduleName: "@serwist/expiration",
-        className: "Plugin",
-        funcName: "cacheDidUpdate",
-        paramName: "cacheName",
-      });
-      assert!.isInstance(request, Request, {
-        moduleName: "@serwist/expiration",
-        className: "Plugin",
-        funcName: "cacheDidUpdate",
-        paramName: "request",
-      });
-    }
-
-    const cacheExpiration = this._getCacheExpiration(cacheName);
-    await cacheExpiration.updateTimestamp(request.url);
-    await cacheExpiration.expireEntries();
-  };
-
-  /**
-   * This is a helper method that performs two operations:
-   *
-   * - Deletes *all* the underlying Cache instances associated with this plugin
-   * instance, by calling caches.delete() on your behalf.
-   * - Deletes the metadata from IndexedDB used to keep track of expiration
-   * details for each Cache instance.
-   *
-   * When using cache expiration, calling this method is preferable to calling
-   * `caches.delete()` directly, since this will ensure that the IndexedDB
-   * metadata is also cleanly removed and open IndexedDB instances are deleted.
-   *
-   * Note that if you're *not* using cache expiration for a given cache, calling
-   * `caches.delete()` and passing in the cache's name should be sufficient.
-   * There is no Serwist-specific method needed for cleanup in that case.
-   */
-  async deleteCacheAndMetadata(): Promise<void> {
-    // Do this one at a time instead of all at once via `Promise.all()` to
-    // reduce the chance of inconsistency if a promise rejects.
-    for (const [cacheName, cacheExpiration] of this._cacheExpirations) {
-      await self.caches.delete(cacheName);
-      await cacheExpiration.delete();
-    }
-
-    // Reset this._cacheExpirations to its initial state.
-    this._cacheExpirations = new Map();
-  }
-}
-
-export { ExpirationPlugin };

package/src/models/CacheTimestampsModel.ts

@@ -1,214 +0,0 @@
-/*
-  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 type { DBSchema, IDBPDatabase } from "idb";
-import { deleteDB, openDB } from "idb";
-
-const DB_NAME = "serwist-expiration";
-const CACHE_OBJECT_STORE = "cache-entries";
-
-const normalizeURL = (unNormalizedUrl: string) => {
-  const url = new URL(unNormalizedUrl, location.href);
-  url.hash = "";
-
-  return url.href;
-};
-
-interface CacheTimestampsModelEntry {
-  id: string;
-  cacheName: string;
-  url: string;
-  timestamp: number;
-}
-
-interface CacheDbSchema extends DBSchema {
-  "cache-entries": {
-    key: string;
-    value: CacheTimestampsModelEntry;
-    indexes: { cacheName: string; timestamp: number };
-  };
-}
-
-/**
- * Returns the timestamp model.
- *
- * @private
- */
-class CacheTimestampsModel {
-  private readonly _cacheName: string;
-  private _db: IDBPDatabase<CacheDbSchema> | null = null;
-
-  /**
-   *
-   * @param cacheName
-   *
-   * @private
-   */
-  constructor(cacheName: string) {
-    this._cacheName = cacheName;
-  }
-
-  /**
-   * Performs an upgrade of indexedDB.
-   *
-   * @param db
-   *
-   * @private
-   */
-  private _upgradeDb(db: IDBPDatabase<CacheDbSchema>) {
-    // TODO(philipwalton): EdgeHTML doesn't support arrays as a keyPath, so we
-    // have to use the `id` keyPath here and create our own values (a
-    // concatenation of `url + cacheName`) instead of simply using
-    // `keyPath: ['url', 'cacheName']`, which is supported in other browsers.
-    const objStore = db.createObjectStore(CACHE_OBJECT_STORE, {
-      keyPath: "id",
-    });
-
-    // TODO(philipwalton): once we don't have to support EdgeHTML, we can
-    // create a single index with the keyPath `['cacheName', 'timestamp']`
-    // instead of doing both these indexes.
-    objStore.createIndex("cacheName", "cacheName", { unique: false });
-    objStore.createIndex("timestamp", "timestamp", { unique: false });
-  }
-
-  /**
-   * Performs an upgrade of indexedDB and deletes deprecated DBs.
-   *
-   * @param db
-   *
-   * @private
-   */
-  private _upgradeDbAndDeleteOldDbs(db: IDBPDatabase<CacheDbSchema>) {
-    this._upgradeDb(db);
-    if (this._cacheName) {
-      void deleteDB(this._cacheName);
-    }
-  }
-
-  /**
-   * @param url
-   * @param timestamp
-   *
-   * @private
-   */
-  async setTimestamp(url: string, timestamp: number): Promise<void> {
-    url = normalizeURL(url);
-
-    const entry: CacheTimestampsModelEntry = {
-      url,
-      timestamp,
-      cacheName: this._cacheName,
-      // Creating an ID from the URL and cache name won't be necessary once
-      // Edge switches to Chromium and all browsers we support work with
-      // array keyPaths.
-      id: this._getId(url),
-    };
-    const db = await this.getDb();
-    const tx = db.transaction(CACHE_OBJECT_STORE, "readwrite", {
-      durability: "relaxed",
-    });
-    await tx.store.put(entry);
-    await tx.done;
-  }
-
-  /**
-   * Returns the timestamp stored for a given URL.
-   *
-   * @param url
-   * @returns
-   * @private
-   */
-  async getTimestamp(url: string): Promise<number | undefined> {
-    const db = await this.getDb();
-    const entry = await db.get(CACHE_OBJECT_STORE, this._getId(url));
-    return entry?.timestamp;
-  }
-
-  /**
-   * Iterates through all the entries in the object store (from newest to
-   * oldest) and removes entries once either `maxCount` is reached or the
-   * entry's timestamp is less than `minTimestamp`.
-   *
-   * @param minTimestamp
-   * @param maxCount
-   * @returns
-   * @private
-   */
-  async expireEntries(minTimestamp: number, maxCount?: number): Promise<string[]> {
-    const db = await this.getDb();
-    let cursor = await db.transaction(CACHE_OBJECT_STORE).store.index("timestamp").openCursor(null, "prev");
-    const entriesToDelete: CacheTimestampsModelEntry[] = [];
-    let entriesNotDeletedCount = 0;
-    while (cursor) {
-      const result = cursor.value;
-      // TODO(philipwalton): once we can use a multi-key index, we
-      // won't have to check `cacheName` here.
-      if (result.cacheName === this._cacheName) {
-        // Delete an entry if it's older than the max age or
-        // if we already have the max number allowed.
-        if ((minTimestamp && result.timestamp < minTimestamp) || (maxCount && entriesNotDeletedCount >= maxCount)) {
-          // TODO(philipwalton): we should be able to delete the
-          // entry right here, but doing so causes an iteration
-          // bug in Safari stable (fixed in TP). Instead we can
-          // store the keys of the entries to delete, and then
-          // delete the separate transactions.
-          // https://github.com/GoogleChrome/workbox/issues/1978
-          // cursor.delete();
-
-          // We only need to return the URL, not the whole entry.
-          entriesToDelete.push(cursor.value);
-        } else {
-          entriesNotDeletedCount++;
-        }
-      }
-      cursor = await cursor.continue();
-    }
-
-    // TODO(philipwalton): once the Safari bug in the following issue is fixed,
-    // we should be able to remove this loop and do the entry deletion in the
-    // cursor loop above:
-    // https://github.com/GoogleChrome/workbox/issues/1978
-    const urlsDeleted: string[] = [];
-    for (const entry of entriesToDelete) {
-      await db.delete(CACHE_OBJECT_STORE, entry.id);
-      urlsDeleted.push(entry.url);
-    }
-
-    return urlsDeleted;
-  }
-
-  /**
-   * Takes a URL and returns an ID that will be unique in the object store.
-   *
-   * @param url
-   * @returns
-   * @private
-   */
-  private _getId(url: string): string {
-    // Creating an ID from the URL and cache name won't be necessary once
-    // Edge switches to Chromium and all browsers we support work with
-    // array keyPaths.
-    return `${this._cacheName}|${normalizeURL(url)}`;
-  }
-
-  /**
-   * Returns an open connection to the database.
-   *
-   * @private
-   */
-  private async getDb() {
-    if (!this._db) {
-      this._db = await openDB(DB_NAME, 1, {
-        upgrade: this._upgradeDbAndDeleteOldDbs.bind(this),
-      });
-    }
-    return this._db;
-  }
-}
-
-export { CacheTimestampsModel };