@serwist/precaching 9.0.0-preview.15 → 9.0.0-preview.17

package/dist/chunks/getOrCreatePrecacheController.js

@@ -0,0 +1,436 @@
+import { privateCacheNames, logger, getFriendlyURL, SerwistError, assert, waitUntil } from '@serwist/core/internal';
+import { copyResponse } from '@serwist/core';
+import { Strategy } from '@serwist/strategies';
+
+const parallel = async (limit, array, func)=>{
+    const work = array.map((item, index)=>({
+            index,
+            item
+        }));
+    const processor = async (res)=>{
+        const results = [];
+        while(true){
+            const next = work.pop();
+            if (!next) {
+                return res(results);
+            }
+            const result = await func(next.item);
+            results.push({
+                result: result,
+                index: next.index
+            });
+        }
+    };
+    const queues = Array.from({
+        length: limit
+    }, ()=>new Promise(processor));
+    const results = (await Promise.all(queues)).flat().sort((a, b)=>a.index < b.index ? -1 : 1).map((res)=>res.result);
+    return results;
+};
+
+class PrecacheStrategy extends Strategy {
+    _fallbackToNetwork;
+    static defaultPrecacheCacheabilityPlugin = {
+        async cacheWillUpdate ({ response }) {
+            if (!response || response.status >= 400) {
+                return null;
+            }
+            return response;
+        }
+    };
+    static copyRedirectedCacheableResponsesPlugin = {
+        async cacheWillUpdate ({ response }) {
+            return response.redirected ? await copyResponse(response) : response;
+        }
+    };
+    constructor(options = {}){
+        options.cacheName = privateCacheNames.getPrecacheName(options.cacheName);
+        super(options);
+        this._fallbackToNetwork = options.fallbackToNetwork === false ? false : true;
+        this.plugins.push(PrecacheStrategy.copyRedirectedCacheableResponsesPlugin);
+    }
+    async _handle(request, handler) {
+        const response = await handler.cacheMatch(request);
+        if (response) {
+            return response;
+        }
+        if (handler.event && handler.event.type === "install") {
+            return await this._handleInstall(request, handler);
+        }
+        return await this._handleFetch(request, handler);
+    }
+    async _handleFetch(request, handler) {
+        let response = undefined;
+        const params = handler.params || {};
+        if (this._fallbackToNetwork) {
+            if (process.env.NODE_ENV !== "production") {
+                logger.warn(`The precached response for ${getFriendlyURL(request.url)} in ${this.cacheName} was not found. Falling back to the network.`);
+            }
+            const integrityInManifest = params.integrity;
+            const integrityInRequest = request.integrity;
+            const noIntegrityConflict = !integrityInRequest || integrityInRequest === integrityInManifest;
+            response = await handler.fetch(new Request(request, {
+                integrity: request.mode !== "no-cors" ? integrityInRequest || integrityInManifest : undefined
+            }));
+            if (integrityInManifest && noIntegrityConflict && request.mode !== "no-cors") {
+                this._useDefaultCacheabilityPluginIfNeeded();
+                const wasCached = await handler.cachePut(request, response.clone());
+                if (process.env.NODE_ENV !== "production") {
+                    if (wasCached) {
+                        logger.log(`A response for ${getFriendlyURL(request.url)} was used to "repair" the precache.`);
+                    }
+                }
+            }
+        } else {
+            throw new SerwistError("missing-precache-entry", {
+                cacheName: this.cacheName,
+                url: request.url
+            });
+        }
+        if (process.env.NODE_ENV !== "production") {
+            const cacheKey = params.cacheKey || await handler.getCacheKey(request, "read");
+            logger.groupCollapsed(`Precaching is responding to: ${getFriendlyURL(request.url)}`);
+            logger.log(`Serving the precached url: ${getFriendlyURL(cacheKey instanceof Request ? cacheKey.url : cacheKey)}`);
+            logger.groupCollapsed("View request details here.");
+            logger.log(request);
+            logger.groupEnd();
+            logger.groupCollapsed("View response details here.");
+            logger.log(response);
+            logger.groupEnd();
+            logger.groupEnd();
+        }
+        return response;
+    }
+    async _handleInstall(request, handler) {
+        this._useDefaultCacheabilityPluginIfNeeded();
+        const response = await handler.fetch(request);
+        const wasCached = await handler.cachePut(request, response.clone());
+        if (!wasCached) {
+            throw new SerwistError("bad-precaching-response", {
+                url: request.url,
+                status: response.status
+            });
+        }
+        return response;
+    }
+    _useDefaultCacheabilityPluginIfNeeded() {
+        let defaultPluginIndex = null;
+        let cacheWillUpdatePluginCount = 0;
+        for (const [index, plugin] of this.plugins.entries()){
+            if (plugin === PrecacheStrategy.copyRedirectedCacheableResponsesPlugin) {
+                continue;
+            }
+            if (plugin === PrecacheStrategy.defaultPrecacheCacheabilityPlugin) {
+                defaultPluginIndex = index;
+            }
+            if (plugin.cacheWillUpdate) {
+                cacheWillUpdatePluginCount++;
+            }
+        }
+        if (cacheWillUpdatePluginCount === 0) {
+            this.plugins.push(PrecacheStrategy.defaultPrecacheCacheabilityPlugin);
+        } else if (cacheWillUpdatePluginCount > 1 && defaultPluginIndex !== null) {
+            this.plugins.splice(defaultPluginIndex, 1);
+        }
+    }
+}
+
+class PrecacheCacheKeyPlugin {
+    _precacheController;
+    constructor({ precacheController }){
+        this._precacheController = precacheController;
+    }
+    cacheKeyWillBeUsed = async ({ request, params })=>{
+        const cacheKey = params?.cacheKey || this._precacheController.getCacheKeyForURL(request.url);
+        return cacheKey ? new Request(cacheKey, {
+            headers: request.headers
+        }) : request;
+    };
+}
+
+class PrecacheInstallReportPlugin {
+    updatedURLs = [];
+    notUpdatedURLs = [];
+    handlerWillStart = async ({ request, state })=>{
+        if (state) {
+            state.originalRequest = request;
+        }
+    };
+    cachedResponseWillBeUsed = async ({ event, state, cachedResponse })=>{
+        if (event.type === "install") {
+            if (state?.originalRequest && state.originalRequest instanceof Request) {
+                const url = state.originalRequest.url;
+                if (cachedResponse) {
+                    this.notUpdatedURLs.push(url);
+                } else {
+                    this.updatedURLs.push(url);
+                }
+            }
+        }
+        return cachedResponse;
+    };
+}
+
+const REVISION_SEARCH_PARAM = "__WB_REVISION__";
+function createCacheKey(entry) {
+    if (!entry) {
+        throw new SerwistError("add-to-cache-list-unexpected-type", {
+            entry
+        });
+    }
+    if (typeof entry === "string") {
+        const urlObject = new URL(entry, location.href);
+        return {
+            cacheKey: urlObject.href,
+            url: urlObject.href
+        };
+    }
+    const { revision, url } = entry;
+    if (!url) {
+        throw new SerwistError("add-to-cache-list-unexpected-type", {
+            entry
+        });
+    }
+    if (!revision) {
+        const urlObject = new URL(url, location.href);
+        return {
+            cacheKey: urlObject.href,
+            url: urlObject.href
+        };
+    }
+    const cacheKeyURL = new URL(url, location.href);
+    const originalURL = new URL(url, location.href);
+    cacheKeyURL.searchParams.set(REVISION_SEARCH_PARAM, revision);
+    return {
+        cacheKey: cacheKeyURL.href,
+        url: originalURL.href
+    };
+}
+
+const logGroup = (groupTitle, deletedURLs)=>{
+    logger.groupCollapsed(groupTitle);
+    for (const url of deletedURLs){
+        logger.log(url);
+    }
+    logger.groupEnd();
+};
+function printCleanupDetails(deletedURLs) {
+    const deletionCount = deletedURLs.length;
+    if (deletionCount > 0) {
+        logger.groupCollapsed(`During precaching cleanup, ${deletionCount} cached request${deletionCount === 1 ? " was" : "s were"} deleted.`);
+        logGroup("Deleted Cache Requests", deletedURLs);
+        logger.groupEnd();
+    }
+}
+
+function _nestedGroup(groupTitle, urls) {
+    if (urls.length === 0) {
+        return;
+    }
+    logger.groupCollapsed(groupTitle);
+    for (const url of urls){
+        logger.log(url);
+    }
+    logger.groupEnd();
+}
+function printInstallDetails(urlsToPrecache, urlsAlreadyPrecached) {
+    const precachedCount = urlsToPrecache.length;
+    const alreadyPrecachedCount = urlsAlreadyPrecached.length;
+    if (precachedCount || alreadyPrecachedCount) {
+        let message = `Precaching ${precachedCount} file${precachedCount === 1 ? "" : "s"}.`;
+        if (alreadyPrecachedCount > 0) {
+            message += ` ${alreadyPrecachedCount} ` + `file${alreadyPrecachedCount === 1 ? " is" : "s are"} already cached.`;
+        }
+        logger.groupCollapsed(message);
+        _nestedGroup("View newly precached URLs.", urlsToPrecache);
+        _nestedGroup("View previously precached URLs.", urlsAlreadyPrecached);
+        logger.groupEnd();
+    }
+}
+
+class PrecacheController {
+    _installAndActiveListenersAdded;
+    _concurrentPrecaching;
+    _strategy;
+    _urlsToCacheKeys = new Map();
+    _urlsToCacheModes = new Map();
+    _cacheKeysToIntegrities = new Map();
+    constructor({ cacheName, plugins = [], fallbackToNetwork = true, concurrentPrecaching } = {}){
+        this._strategy = new PrecacheStrategy({
+            cacheName: privateCacheNames.getPrecacheName(cacheName),
+            plugins: [
+                ...plugins,
+                new PrecacheCacheKeyPlugin({
+                    precacheController: this
+                })
+            ],
+            fallbackToNetwork
+        });
+        this._concurrentPrecaching = concurrentPrecaching;
+        this.install = this.install.bind(this);
+        this.activate = this.activate.bind(this);
+    }
+    get strategy() {
+        return this._strategy;
+    }
+    precache(entries) {
+        this.addToCacheList(entries);
+        if (!this._installAndActiveListenersAdded) {
+            self.addEventListener("install", this.install);
+            self.addEventListener("activate", this.activate);
+            this._installAndActiveListenersAdded = true;
+        }
+    }
+    addToCacheList(entries) {
+        if (process.env.NODE_ENV !== "production") {
+            assert.isArray(entries, {
+                moduleName: "@serwist/precaching",
+                className: "PrecacheController",
+                funcName: "addToCacheList",
+                paramName: "entries"
+            });
+        }
+        const urlsToWarnAbout = [];
+        for (const entry of entries){
+            if (typeof entry === "string") {
+                urlsToWarnAbout.push(entry);
+            } else if (entry && !entry.integrity && entry.revision === undefined) {
+                urlsToWarnAbout.push(entry.url);
+            }
+            const { cacheKey, url } = createCacheKey(entry);
+            const cacheMode = typeof entry !== "string" && entry.revision ? "reload" : "default";
+            if (this._urlsToCacheKeys.has(url) && this._urlsToCacheKeys.get(url) !== cacheKey) {
+                throw new SerwistError("add-to-cache-list-conflicting-entries", {
+                    firstEntry: this._urlsToCacheKeys.get(url),
+                    secondEntry: cacheKey
+                });
+            }
+            if (typeof entry !== "string" && entry.integrity) {
+                if (this._cacheKeysToIntegrities.has(cacheKey) && this._cacheKeysToIntegrities.get(cacheKey) !== entry.integrity) {
+                    throw new SerwistError("add-to-cache-list-conflicting-integrities", {
+                        url
+                    });
+                }
+                this._cacheKeysToIntegrities.set(cacheKey, entry.integrity);
+            }
+            this._urlsToCacheKeys.set(url, cacheKey);
+            this._urlsToCacheModes.set(url, cacheMode);
+            if (urlsToWarnAbout.length > 0) {
+                const warningMessage = `Serwist is precaching URLs without revision info: ${urlsToWarnAbout.join(", ")}\nThis is generally NOT safe. Learn more at https://bit.ly/wb-precache`;
+                if (process.env.NODE_ENV === "production") {
+                    console.warn(warningMessage);
+                } else {
+                    logger.warn(warningMessage);
+                }
+            }
+        }
+    }
+    install(event) {
+        return waitUntil(event, async ()=>{
+            const installReportPlugin = new PrecacheInstallReportPlugin();
+            this.strategy.plugins.push(installReportPlugin);
+            let concurrents = this._concurrentPrecaching;
+            if (concurrents === undefined) {
+                if (!("__WB_CONCURRENT_PRECACHING" in globalThis)) {
+                    self.__WB_CONCURRENT_PRECACHING = 1;
+                }
+                concurrents = self.__WB_CONCURRENT_PRECACHING;
+            }
+            await parallel(concurrents, Array.from(this._urlsToCacheKeys.entries()), async ([url, cacheKey])=>{
+                const integrity = this._cacheKeysToIntegrities.get(cacheKey);
+                const cacheMode = this._urlsToCacheModes.get(url);
+                const request = new Request(url, {
+                    integrity,
+                    cache: cacheMode,
+                    credentials: "same-origin"
+                });
+                await Promise.all(this.strategy.handleAll({
+                    event,
+                    request,
+                    url: new URL(request.url),
+                    params: {
+                        cacheKey
+                    }
+                }));
+            });
+            const { updatedURLs, notUpdatedURLs } = installReportPlugin;
+            if (process.env.NODE_ENV !== "production") {
+                printInstallDetails(updatedURLs, notUpdatedURLs);
+            }
+            return {
+                updatedURLs,
+                notUpdatedURLs
+            };
+        });
+    }
+    activate(event) {
+        return waitUntil(event, async ()=>{
+            const cache = await self.caches.open(this.strategy.cacheName);
+            const currentlyCachedRequests = await cache.keys();
+            const expectedCacheKeys = new Set(this._urlsToCacheKeys.values());
+            const deletedCacheRequests = [];
+            for (const request of currentlyCachedRequests){
+                if (!expectedCacheKeys.has(request.url)) {
+                    await cache.delete(request);
+                    deletedCacheRequests.push(request.url);
+                }
+            }
+            if (process.env.NODE_ENV !== "production") {
+                printCleanupDetails(deletedCacheRequests);
+            }
+            return {
+                deletedCacheRequests
+            };
+        });
+    }
+    getURLsToCacheKeys() {
+        return this._urlsToCacheKeys;
+    }
+    getCachedURLs() {
+        return [
+            ...this._urlsToCacheKeys.keys()
+        ];
+    }
+    getCacheKeyForURL(url) {
+        const urlObject = new URL(url, location.href);
+        return this._urlsToCacheKeys.get(urlObject.href);
+    }
+    getIntegrityForCacheKey(cacheKey) {
+        return this._cacheKeysToIntegrities.get(cacheKey);
+    }
+    async matchPrecache(request) {
+        const url = request instanceof Request ? request.url : request;
+        const cacheKey = this.getCacheKeyForURL(url);
+        if (cacheKey) {
+            const cache = await self.caches.open(this.strategy.cacheName);
+            return cache.match(cacheKey);
+        }
+        return undefined;
+    }
+    createHandlerBoundToURL(url) {
+        const cacheKey = this.getCacheKeyForURL(url);
+        if (!cacheKey) {
+            throw new SerwistError("non-precached-url", {
+                url
+            });
+        }
+        return (options)=>{
+            options.request = new Request(url);
+            options.params = {
+                cacheKey,
+                ...options.params
+            };
+            return this.strategy.handle(options);
+        };
+    }
+}
+
+let precacheController;
+const getOrCreatePrecacheController = ()=>{
+    if (!precacheController) {
+        precacheController = new PrecacheController();
+    }
+    return precacheController;
+};
+
+export { PrecacheController as P, PrecacheStrategy as a, getOrCreatePrecacheController as g };

package/dist/index.internal.d.ts

@@ -0,0 +1,3 @@
+import { getOrCreatePrecacheController } from "./utils/getOrCreatePrecacheController.js";
+export { getOrCreatePrecacheController };
+//# sourceMappingURL=index.internal.d.ts.map

package/dist/index.internal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.internal.d.ts","sourceRoot":"","sources":["../src/index.internal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,6BAA6B,EAAE,MAAM,0CAA0C,CAAC;AAEzF,OAAO,EAAE,6BAA6B,EAAE,CAAC"}

package/dist/index.internal.js

@@ -0,0 +1,4 @@
+export { g as getOrCreatePrecacheController } from './chunks/getOrCreatePrecacheController.js';
+import '@serwist/core/internal';
+import '@serwist/core';
+import '@serwist/strategies';

package/dist/index.js

@@ -1,438 +1,9 @@
-import { privateCacheNames, logger, getFriendlyURL, SerwistError, assert, waitUntil } from '@serwist/core/internal';
-import { copyResponse } from '@serwist/core';
-import { Strategy } from '@serwist/strategies';
+import { g as getOrCreatePrecacheController } from './chunks/getOrCreatePrecacheController.js';
+export { P as PrecacheController, a as PrecacheStrategy } from './chunks/getOrCreatePrecacheController.js';
+import { logger, getFriendlyURL, privateCacheNames } from '@serwist/core/internal';
 import { Route, registerRoute } from '@serwist/routing';
-
-const parallel = async (limit, array, func)=>{
-    const work = array.map((item, index)=>({
-            index,
-            item
-        }));
-    const processor = async (res)=>{
-        const results = [];
-        while(true){
-            const next = work.pop();
-            if (!next) {
-                return res(results);
-            }
-            const result = await func(next.item);
-            results.push({
-                result: result,
-                index: next.index
-            });
-        }
-    };
-    const queues = Array.from({
-        length: limit
-    }, ()=>new Promise(processor));
-    const results = (await Promise.all(queues)).flat().sort((a, b)=>a.index < b.index ? -1 : 1).map((res)=>res.result);
-    return results;
-};
-
-class PrecacheStrategy extends Strategy {
-    _fallbackToNetwork;
-    static defaultPrecacheCacheabilityPlugin = {
-        async cacheWillUpdate ({ response }) {
-            if (!response || response.status >= 400) {
-                return null;
-            }
-            return response;
-        }
-    };
-    static copyRedirectedCacheableResponsesPlugin = {
-        async cacheWillUpdate ({ response }) {
-            return response.redirected ? await copyResponse(response) : response;
-        }
-    };
-    constructor(options = {}){
-        options.cacheName = privateCacheNames.getPrecacheName(options.cacheName);
-        super(options);
-        this._fallbackToNetwork = options.fallbackToNetwork === false ? false : true;
-        this.plugins.push(PrecacheStrategy.copyRedirectedCacheableResponsesPlugin);
-    }
-    async _handle(request, handler) {
-        const response = await handler.cacheMatch(request);
-        if (response) {
-            return response;
-        }
-        if (handler.event && handler.event.type === "install") {
-            return await this._handleInstall(request, handler);
-        }
-        return await this._handleFetch(request, handler);
-    }
-    async _handleFetch(request, handler) {
-        let response = undefined;
-        const params = handler.params || {};
-        if (this._fallbackToNetwork) {
-            if (process.env.NODE_ENV !== "production") {
-                logger.warn(`The precached response for ${getFriendlyURL(request.url)} in ${this.cacheName} was not found. Falling back to the network.`);
-            }
-            const integrityInManifest = params.integrity;
-            const integrityInRequest = request.integrity;
-            const noIntegrityConflict = !integrityInRequest || integrityInRequest === integrityInManifest;
-            response = await handler.fetch(new Request(request, {
-                integrity: request.mode !== "no-cors" ? integrityInRequest || integrityInManifest : undefined
-            }));
-            if (integrityInManifest && noIntegrityConflict && request.mode !== "no-cors") {
-                this._useDefaultCacheabilityPluginIfNeeded();
-                const wasCached = await handler.cachePut(request, response.clone());
-                if (process.env.NODE_ENV !== "production") {
-                    if (wasCached) {
-                        logger.log(`A response for ${getFriendlyURL(request.url)} was used to "repair" the precache.`);
-                    }
-                }
-            }
-        } else {
-            throw new SerwistError("missing-precache-entry", {
-                cacheName: this.cacheName,
-                url: request.url
-            });
-        }
-        if (process.env.NODE_ENV !== "production") {
-            const cacheKey = params.cacheKey || await handler.getCacheKey(request, "read");
-            logger.groupCollapsed(`Precaching is responding to: ${getFriendlyURL(request.url)}`);
-            logger.log(`Serving the precached url: ${getFriendlyURL(cacheKey instanceof Request ? cacheKey.url : cacheKey)}`);
-            logger.groupCollapsed("View request details here.");
-            logger.log(request);
-            logger.groupEnd();
-            logger.groupCollapsed("View response details here.");
-            logger.log(response);
-            logger.groupEnd();
-            logger.groupEnd();
-        }
-        return response;
-    }
-    async _handleInstall(request, handler) {
-        this._useDefaultCacheabilityPluginIfNeeded();
-        const response = await handler.fetch(request);
-        const wasCached = await handler.cachePut(request, response.clone());
-        if (!wasCached) {
-            throw new SerwistError("bad-precaching-response", {
-                url: request.url,
-                status: response.status
-            });
-        }
-        return response;
-    }
-    _useDefaultCacheabilityPluginIfNeeded() {
-        let defaultPluginIndex = null;
-        let cacheWillUpdatePluginCount = 0;
-        for (const [index, plugin] of this.plugins.entries()){
-            if (plugin === PrecacheStrategy.copyRedirectedCacheableResponsesPlugin) {
-                continue;
-            }
-            if (plugin === PrecacheStrategy.defaultPrecacheCacheabilityPlugin) {
-                defaultPluginIndex = index;
-            }
-            if (plugin.cacheWillUpdate) {
-                cacheWillUpdatePluginCount++;
-            }
-        }
-        if (cacheWillUpdatePluginCount === 0) {
-            this.plugins.push(PrecacheStrategy.defaultPrecacheCacheabilityPlugin);
-        } else if (cacheWillUpdatePluginCount > 1 && defaultPluginIndex !== null) {
-            this.plugins.splice(defaultPluginIndex, 1);
-        }
-    }
-}
-
-class PrecacheCacheKeyPlugin {
-    _precacheController;
-    constructor({ precacheController }){
-        this._precacheController = precacheController;
-    }
-    cacheKeyWillBeUsed = async ({ request, params })=>{
-        const cacheKey = params?.cacheKey || this._precacheController.getCacheKeyForURL(request.url);
-        return cacheKey ? new Request(cacheKey, {
-            headers: request.headers
-        }) : request;
-    };
-}
-
-class PrecacheInstallReportPlugin {
-    updatedURLs = [];
-    notUpdatedURLs = [];
-    handlerWillStart = async ({ request, state })=>{
-        if (state) {
-            state.originalRequest = request;
-        }
-    };
-    cachedResponseWillBeUsed = async ({ event, state, cachedResponse })=>{
-        if (event.type === "install") {
-            if (state?.originalRequest && state.originalRequest instanceof Request) {
-                const url = state.originalRequest.url;
-                if (cachedResponse) {
-                    this.notUpdatedURLs.push(url);
-                } else {
-                    this.updatedURLs.push(url);
-                }
-            }
-        }
-        return cachedResponse;
-    };
-}
-
-const REVISION_SEARCH_PARAM = "__WB_REVISION__";
-function createCacheKey(entry) {
-    if (!entry) {
-        throw new SerwistError("add-to-cache-list-unexpected-type", {
-            entry
-        });
-    }
-    if (typeof entry === "string") {
-        const urlObject = new URL(entry, location.href);
-        return {
-            cacheKey: urlObject.href,
-            url: urlObject.href
-        };
-    }
-    const { revision, url } = entry;
-    if (!url) {
-        throw new SerwistError("add-to-cache-list-unexpected-type", {
-            entry
-        });
-    }
-    if (!revision) {
-        const urlObject = new URL(url, location.href);
-        return {
-            cacheKey: urlObject.href,
-            url: urlObject.href
-        };
-    }
-    const cacheKeyURL = new URL(url, location.href);
-    const originalURL = new URL(url, location.href);
-    cacheKeyURL.searchParams.set(REVISION_SEARCH_PARAM, revision);
-    return {
-        cacheKey: cacheKeyURL.href,
-        url: originalURL.href
-    };
-}
-
-const logGroup = (groupTitle, deletedURLs)=>{
-    logger.groupCollapsed(groupTitle);
-    for (const url of deletedURLs){
-        logger.log(url);
-    }
-    logger.groupEnd();
-};
-function printCleanupDetails(deletedURLs) {
-    const deletionCount = deletedURLs.length;
-    if (deletionCount > 0) {
-        logger.groupCollapsed(`During precaching cleanup, ${deletionCount} cached request${deletionCount === 1 ? " was" : "s were"} deleted.`);
-        logGroup("Deleted Cache Requests", deletedURLs);
-        logger.groupEnd();
-    }
-}
-
-function _nestedGroup(groupTitle, urls) {
-    if (urls.length === 0) {
-        return;
-    }
-    logger.groupCollapsed(groupTitle);
-    for (const url of urls){
-        logger.log(url);
-    }
-    logger.groupEnd();
-}
-function printInstallDetails(urlsToPrecache, urlsAlreadyPrecached) {
-    const precachedCount = urlsToPrecache.length;
-    const alreadyPrecachedCount = urlsAlreadyPrecached.length;
-    if (precachedCount || alreadyPrecachedCount) {
-        let message = `Precaching ${precachedCount} file${precachedCount === 1 ? "" : "s"}.`;
-        if (alreadyPrecachedCount > 0) {
-            message += ` ${alreadyPrecachedCount} ` + `file${alreadyPrecachedCount === 1 ? " is" : "s are"} already cached.`;
-        }
-        logger.groupCollapsed(message);
-        _nestedGroup("View newly precached URLs.", urlsToPrecache);
-        _nestedGroup("View previously precached URLs.", urlsAlreadyPrecached);
-        logger.groupEnd();
-    }
-}
-
-class PrecacheController {
-    _installAndActiveListenersAdded;
-    _concurrentPrecaching;
-    _strategy;
-    _urlsToCacheKeys = new Map();
-    _urlsToCacheModes = new Map();
-    _cacheKeysToIntegrities = new Map();
-    constructor({ cacheName, plugins = [], fallbackToNetwork = true, concurrentPrecaching } = {}){
-        this._strategy = new PrecacheStrategy({
-            cacheName: privateCacheNames.getPrecacheName(cacheName),
-            plugins: [
-                ...plugins,
-                new PrecacheCacheKeyPlugin({
-                    precacheController: this
-                })
-            ],
-            fallbackToNetwork
-        });
-        this._concurrentPrecaching = concurrentPrecaching;
-        this.install = this.install.bind(this);
-        this.activate = this.activate.bind(this);
-    }
-    get strategy() {
-        return this._strategy;
-    }
-    precache(entries) {
-        this.addToCacheList(entries);
-        if (!this._installAndActiveListenersAdded) {
-            self.addEventListener("install", this.install);
-            self.addEventListener("activate", this.activate);
-            this._installAndActiveListenersAdded = true;
-        }
-    }
-    addToCacheList(entries) {
-        if (process.env.NODE_ENV !== "production") {
-            assert.isArray(entries, {
-                moduleName: "@serwist/precaching",
-                className: "PrecacheController",
-                funcName: "addToCacheList",
-                paramName: "entries"
-            });
-        }
-        const urlsToWarnAbout = [];
-        for (const entry of entries){
-            if (typeof entry === "string") {
-                urlsToWarnAbout.push(entry);
-            } else if (entry && entry.revision === undefined) {
-                urlsToWarnAbout.push(entry.url);
-            }
-            const { cacheKey, url } = createCacheKey(entry);
-            const cacheMode = typeof entry !== "string" && entry.revision ? "reload" : "default";
-            if (this._urlsToCacheKeys.has(url) && this._urlsToCacheKeys.get(url) !== cacheKey) {
-                throw new SerwistError("add-to-cache-list-conflicting-entries", {
-                    firstEntry: this._urlsToCacheKeys.get(url),
-                    secondEntry: cacheKey
-                });
-            }
-            if (typeof entry !== "string" && entry.integrity) {
-                if (this._cacheKeysToIntegrities.has(cacheKey) && this._cacheKeysToIntegrities.get(cacheKey) !== entry.integrity) {
-                    throw new SerwistError("add-to-cache-list-conflicting-integrities", {
-                        url
-                    });
-                }
-                this._cacheKeysToIntegrities.set(cacheKey, entry.integrity);
-            }
-            this._urlsToCacheKeys.set(url, cacheKey);
-            this._urlsToCacheModes.set(url, cacheMode);
-            if (urlsToWarnAbout.length > 0) {
-                const warningMessage = `Serwist is precaching URLs without revision info: ${urlsToWarnAbout.join(", ")}\nThis is generally NOT safe. Learn more at https://bit.ly/wb-precache`;
-                if (process.env.NODE_ENV === "production") {
-                    console.warn(warningMessage);
-                } else {
-                    logger.warn(warningMessage);
-                }
-            }
-        }
-    }
-    install(event) {
-        return waitUntil(event, async ()=>{
-            const installReportPlugin = new PrecacheInstallReportPlugin();
-            this.strategy.plugins.push(installReportPlugin);
-            let concurrents = this._concurrentPrecaching;
-            if (concurrents === undefined) {
-                if (!("__WB_CONCURRENT_PRECACHING" in globalThis)) {
-                    self.__WB_CONCURRENT_PRECACHING = 1;
-                }
-                concurrents = self.__WB_CONCURRENT_PRECACHING;
-            }
-            await parallel(concurrents, Array.from(this._urlsToCacheKeys.entries()), async ([url, cacheKey])=>{
-                const integrity = this._cacheKeysToIntegrities.get(cacheKey);
-                const cacheMode = this._urlsToCacheModes.get(url);
-                const request = new Request(url, {
-                    integrity,
-                    cache: cacheMode,
-                    credentials: "same-origin"
-                });
-                await Promise.all(this.strategy.handleAll({
-                    event,
-                    request,
-                    url: new URL(request.url),
-                    params: {
-                        cacheKey
-                    }
-                }));
-            });
-            const { updatedURLs, notUpdatedURLs } = installReportPlugin;
-            if (process.env.NODE_ENV !== "production") {
-                printInstallDetails(updatedURLs, notUpdatedURLs);
-            }
-            return {
-                updatedURLs,
-                notUpdatedURLs
-            };
-        });
-    }
-    activate(event) {
-        return waitUntil(event, async ()=>{
-            const cache = await self.caches.open(this.strategy.cacheName);
-            const currentlyCachedRequests = await cache.keys();
-            const expectedCacheKeys = new Set(this._urlsToCacheKeys.values());
-            const deletedCacheRequests = [];
-            for (const request of currentlyCachedRequests){
-                if (!expectedCacheKeys.has(request.url)) {
-                    await cache.delete(request);
-                    deletedCacheRequests.push(request.url);
-                }
-            }
-            if (process.env.NODE_ENV !== "production") {
-                printCleanupDetails(deletedCacheRequests);
-            }
-            return {
-                deletedCacheRequests
-            };
-        });
-    }
-    getURLsToCacheKeys() {
-        return this._urlsToCacheKeys;
-    }
-    getCachedURLs() {
-        return [
-            ...this._urlsToCacheKeys.keys()
-        ];
-    }
-    getCacheKeyForURL(url) {
-        const urlObject = new URL(url, location.href);
-        return this._urlsToCacheKeys.get(urlObject.href);
-    }
-    getIntegrityForCacheKey(cacheKey) {
-        return this._cacheKeysToIntegrities.get(cacheKey);
-    }
-    async matchPrecache(request) {
-        const url = request instanceof Request ? request.url : request;
-        const cacheKey = this.getCacheKeyForURL(url);
-        if (cacheKey) {
-            const cache = await self.caches.open(this.strategy.cacheName);
-            return cache.match(cacheKey);
-        }
-        return undefined;
-    }
-    createHandlerBoundToURL(url) {
-        const cacheKey = this.getCacheKeyForURL(url);
-        if (!cacheKey) {
-            throw new SerwistError("non-precached-url", {
-                url
-            });
-        }
-        return (options)=>{
-            options.request = new Request(url);
-            options.params = {
-                cacheKey,
-                ...options.params
-            };
-            return this.strategy.handle(options);
-        };
-    }
-}
-
-let precacheController;
-const getOrCreatePrecacheController = ()=>{
-    if (!precacheController) {
-        precacheController = new PrecacheController();
-    }
-    return precacheController;
-};
+import '@serwist/core';
+import '@serwist/strategies';
 
 class PrecacheFallbackPlugin {
     _fallbackUrls;
@@ -581,4 +152,4 @@ const precacheAndRoute = (entries, options)=>{
     addRoute(options);
 };
 
-export { PrecacheController, PrecacheFallbackPlugin, PrecacheRoute, PrecacheStrategy, addPlugins, addRoute, cleanupOutdatedCaches, createHandlerBoundToURL, getCacheKeyForURL, matchPrecache, precache, precacheAndRoute };
+export { PrecacheFallbackPlugin, PrecacheRoute, addPlugins, addRoute, cleanupOutdatedCaches, createHandlerBoundToURL, getCacheKeyForURL, matchPrecache, precache, precacheAndRoute };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/precaching",
-  "version": "9.0.0-preview.15",
+  "version": "9.0.0-preview.17",
   "type": "module",
   "description": "A module that efficiently precaches assets.",
   "files": [
@@ -20,23 +20,34 @@
   "homepage": "https://serwist.pages.dev",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "internal": [
+        "./dist/index.internal.d.ts"
+      ]
+    }
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./internal": {
+      "types": "./dist/index.internal.d.ts",
+      "default": "./dist/index.internal.js"
+    },
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@serwist/routing": "9.0.0-preview.15",
-    "@serwist/core": "9.0.0-preview.15",
-    "@serwist/strategies": "9.0.0-preview.15"
+    "@serwist/core": "9.0.0-preview.17",
+    "@serwist/routing": "9.0.0-preview.17",
+    "@serwist/strategies": "9.0.0-preview.17"
   },
   "devDependencies": {
     "rollup": "4.13.0",
     "typescript": "5.5.0-dev.20240323",
-    "@serwist/constants": "9.0.0-preview.15",
-    "@serwist/utils": "9.0.0-preview.15"
+    "@serwist/constants": "9.0.0-preview.17",
+    "@serwist/utils": "9.0.0-preview.17"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"

package/src/PrecacheController.ts

@@ -123,7 +123,7 @@ export class PrecacheController {
       // See https://github.com/GoogleChrome/workbox/issues/2259
       if (typeof entry === "string") {
         urlsToWarnAbout.push(entry);
-      } else if (entry && entry.revision === undefined) {
+      } else if (entry && !entry.integrity && entry.revision === undefined) {
         urlsToWarnAbout.push(entry.url);
       }
 

package/src/index.internal.ts

@@ -0,0 +1,3 @@
+import { getOrCreatePrecacheController } from "./utils/getOrCreatePrecacheController.js";
+
+export { getOrCreatePrecacheController };