@serwist/core 8.1.0 → 8.2.0

package/dist/{index.internal.old.cjs → quotaErrorCallbacks-efexit-Y.js}

@@ -1,4 +1,83 @@
-'use strict';
+/*
+  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.
+*/ const _cacheNameDetails = {
+    googleAnalytics: "googleAnalytics",
+    precache: "precache-v2",
+    prefix: "serwist",
+    runtime: "runtime",
+    suffix: typeof registration !== "undefined" ? registration.scope : ""
+};
+const _createCacheName = (cacheName)=>{
+    return [
+        _cacheNameDetails.prefix,
+        cacheName,
+        _cacheNameDetails.suffix
+    ].filter((value)=>value && value.length > 0).join("-");
+};
+const eachCacheNameDetail = (fn)=>{
+    for (const key of Object.keys(_cacheNameDetails)){
+        fn(key);
+    }
+};
+const cacheNames = {
+    updateDetails: (details)=>{
+        eachCacheNameDetail((key)=>{
+            const detail = details[key];
+            if (typeof detail === "string") {
+                _cacheNameDetails[key] = detail;
+            }
+        });
+    },
+    getGoogleAnalyticsName: (userCacheName)=>{
+        return userCacheName || _createCacheName(_cacheNameDetails.googleAnalytics);
+    },
+    getPrecacheName: (userCacheName)=>{
+        return userCacheName || _createCacheName(_cacheNameDetails.precache);
+    },
+    getPrefix: ()=>{
+        return _cacheNameDetails.prefix;
+    },
+    getRuntimeName: (userCacheName)=>{
+        return userCacheName || _createCacheName(_cacheNameDetails.runtime);
+    },
+    getSuffix: ()=>{
+        return _cacheNameDetails.suffix;
+    }
+};
+
+/*
+  Copyright 2019 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.
+*/ let supportStatus;
+/**
+ * A utility function that determines whether the current browser supports
+ * constructing a new `Response` from a `response.body` stream.
+ *
+ * @returns `true`, if the current browser can successfully construct
+ * a `Response` from a `response.body` stream, `false` otherwise.
+ * @private
+ */ function canConstructResponseFromBodyStream() {
+    if (supportStatus === undefined) {
+        const testResponse = new Response("");
+        if ("body" in testResponse) {
+            try {
+                new Response(testResponse.body);
+                supportStatus = true;
+            } catch (error) {
+                supportStatus = false;
+            }
+        }
+        supportStatus = false;
+    }
+    return supportStatus;
+}
 
 /*
   Copyright 2018 Google LLC
@@ -268,202 +347,6 @@ const finalAssertExports = process.env.NODE_ENV === "production" ? null : {
     isArrayOfClass
 };
 
-/*
-  Copyright 2020 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.
-*/ function stripParams(fullURL, ignoreParams) {
-    const strippedURL = new URL(fullURL);
-    for (const param of ignoreParams){
-        strippedURL.searchParams.delete(param);
-    }
-    return strippedURL.href;
-}
-/**
- * Matches an item in the cache, ignoring specific URL params. This is similar
- * to the `ignoreSearch` option, but it allows you to ignore just specific
- * params (while continuing to match on the others).
- *
- * @private
- * @param cache
- * @param request
- * @param matchOptions
- * @param ignoreParams
- * @returns
- */ async function cacheMatchIgnoreParams(cache, request, ignoreParams, matchOptions) {
-    const strippedRequestURL = stripParams(request.url, ignoreParams);
-    // If the request doesn't include any ignored params, match as normal.
-    if (request.url === strippedRequestURL) {
-        return cache.match(request, matchOptions);
-    }
-    // Otherwise, match by comparing keys
-    const keysOptions = {
-        ...matchOptions,
-        ignoreSearch: true
-    };
-    const cacheKeys = await cache.keys(request, keysOptions);
-    for (const cacheKey of cacheKeys){
-        const strippedCacheKeyURL = stripParams(cacheKey.url, ignoreParams);
-        if (strippedRequestURL === strippedCacheKeyURL) {
-            return cache.match(cacheKey, matchOptions);
-        }
-    }
-    return;
-}
-
-/*
-  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.
-*/ const _cacheNameDetails = {
-    googleAnalytics: "googleAnalytics",
-    precache: "precache-v2",
-    prefix: "serwist",
-    runtime: "runtime",
-    suffix: typeof registration !== "undefined" ? registration.scope : ""
-};
-const _createCacheName = (cacheName)=>{
-    return [
-        _cacheNameDetails.prefix,
-        cacheName,
-        _cacheNameDetails.suffix
-    ].filter((value)=>value && value.length > 0).join("-");
-};
-const eachCacheNameDetail = (fn)=>{
-    for (const key of Object.keys(_cacheNameDetails)){
-        fn(key);
-    }
-};
-const cacheNames = {
-    updateDetails: (details)=>{
-        eachCacheNameDetail((key)=>{
-            const detail = details[key];
-            if (typeof detail === "string") {
-                _cacheNameDetails[key] = detail;
-            }
-        });
-    },
-    getGoogleAnalyticsName: (userCacheName)=>{
-        return userCacheName || _createCacheName(_cacheNameDetails.googleAnalytics);
-    },
-    getPrecacheName: (userCacheName)=>{
-        return userCacheName || _createCacheName(_cacheNameDetails.precache);
-    },
-    getPrefix: ()=>{
-        return _cacheNameDetails.prefix;
-    },
-    getRuntimeName: (userCacheName)=>{
-        return userCacheName || _createCacheName(_cacheNameDetails.runtime);
-    },
-    getSuffix: ()=>{
-        return _cacheNameDetails.suffix;
-    }
-};
-
-/*
-  Copyright 2019 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.
-*/ let supportStatus$1;
-/**
- * A utility function that determines whether the current browser supports
- * constructing a [`ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream/ReadableStream)
- * object.
- *
- * @returns `true`, if the current browser can successfully construct a `ReadableStream`, `false` otherwise.
- *
- * @private
- */ function canConstructReadableStream() {
-    if (supportStatus$1 === undefined) {
-        // See https://github.com/GoogleChrome/workbox/issues/1473
-        try {
-            new ReadableStream({
-                start () {}
-            });
-            supportStatus$1 = true;
-        } catch (error) {
-            supportStatus$1 = false;
-        }
-    }
-    return supportStatus$1;
-}
-
-/*
-  Copyright 2019 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.
-*/ let supportStatus;
-/**
- * A utility function that determines whether the current browser supports
- * constructing a new `Response` from a `response.body` stream.
- *
- * @returns `true`, if the current browser can successfully construct
- * a `Response` from a `response.body` stream, `false` otherwise.
- * @private
- */ function canConstructResponseFromBodyStream() {
-    if (supportStatus === undefined) {
-        const testResponse = new Response("");
-        if ("body" in testResponse) {
-            try {
-                new Response(testResponse.body);
-                supportStatus = true;
-            } catch (error) {
-                supportStatus = false;
-            }
-        }
-        supportStatus = false;
-    }
-    return supportStatus;
-}
-
-/*
-  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.
-*/ /**
- * The Deferred class composes Promises in a way that allows for them to be
- * resolved or rejected from outside the constructor. In most cases promises
- * should be used directly, but Deferreds can be necessary when the logic to
- * resolve a promise must be separate.
- *
- * @private
- */ class Deferred {
-    promise;
-    resolve;
-    reject;
-    /**
-   * Creates a promise and exposes its resolve and reject functions as methods.
-   */ constructor(){
-        this.promise = new Promise((resolve, reject)=>{
-            this.resolve = resolve;
-            this.reject = reject;
-        });
-    }
-}
-
-/*
-  Copyright 2019 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.
-*/ /**
- * A helper function that prevents a promise from being flagged as unused.
- *
- * @private
- **/ function dontWaitFor(promise) {
-    // Effective no-op.
-    void promise.then(()=>{});
-}
-
 /*
   Copyright 2019 Google LLC
   Use of this source code is governed by an MIT-style
@@ -540,128 +423,4 @@ const logger = process.env.NODE_ENV === "production" ? null : (()=>{
 // eslint-disable-next-line @typescript-eslint/ban-types
 const quotaErrorCallbacks = new Set();
 
-/**
- * Runs all of the callback functions, one at a time sequentially, in the order
- * in which they were registered.
- *
- * @private
- */ async function executeQuotaErrorCallbacks() {
-    if (process.env.NODE_ENV !== "production") {
-        logger.log(`About to run ${quotaErrorCallbacks.size} ` + `callbacks to clean up caches.`);
-    }
-    for (const callback of quotaErrorCallbacks){
-        await callback();
-        if (process.env.NODE_ENV !== "production") {
-            logger.log(callback, "is complete.");
-        }
-    }
-    if (process.env.NODE_ENV !== "production") {
-        logger.log("Finished running callbacks.");
-    }
-}
-
-/*
-  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.
-*/ const getFriendlyURL = (url)=>{
-    const urlObj = new URL(String(url), location.href);
-    // See https://github.com/GoogleChrome/workbox/issues/2323
-    // We want to include everything, except for the origin if it's same-origin.
-    return urlObj.href.replace(new RegExp(`^${location.origin}`), "");
-};
-
-/*
-  Copyright 2019 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.
-*/ /**
- * Returns a promise that resolves and the passed number of milliseconds.
- * This utility is an async/await-friendly version of `setTimeout`.
- *
- * @param ms
- * @returns
- * @private
- */ function timeout(ms) {
-    return new Promise((resolve)=>setTimeout(resolve, ms));
-}
-
-const MAX_RETRY_TIME = 2000;
-/**
- * Returns a promise that resolves to a window client matching the passed
- * `resultingClientId`. For browsers that don't support `resultingClientId`
- * or if waiting for the resulting client to apper takes too long, resolve to
- * `undefined`.
- *
- * @param resultingClientId
- * @returns
- * @private
- */ async function resultingClientExists(resultingClientId) {
-    if (!resultingClientId) {
-        return;
-    }
-    let existingWindows = await self.clients.matchAll({
-        type: "window"
-    });
-    const existingWindowIds = new Set(existingWindows.map((w)=>w.id));
-    let resultingWindow;
-    const startTime = performance.now();
-    // Only wait up to `MAX_RETRY_TIME` to find a matching client.
-    while(performance.now() - startTime < MAX_RETRY_TIME){
-        existingWindows = await self.clients.matchAll({
-            type: "window"
-        });
-        resultingWindow = existingWindows.find((w)=>{
-            if (resultingClientId) {
-                // If we have a `resultingClientId`, we can match on that.
-                return w.id === resultingClientId;
-            } else {
-                // Otherwise match on finding a window not in `existingWindowIds`.
-                return !existingWindowIds.has(w.id);
-            }
-        });
-        if (resultingWindow) {
-            break;
-        }
-        // Sleep for 100ms and retry.
-        await timeout(100);
-    }
-    return resultingWindow;
-}
-
-/*
-  Copyright 2020 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.
-*/ /**
- * A utility method that makes it easier to use `event.waitUntil` with
- * async functions and return the result.
- *
- * @param event
- * @param asyncFn
- * @returns
- * @private
- */ function waitUntil(event, asyncFn) {
-    const returnPromise = asyncFn();
-    event.waitUntil(returnPromise);
-    return returnPromise;
-}
-
-exports.Deferred = Deferred;
-exports.SerwistError = SerwistError;
-exports.assert = finalAssertExports;
-exports.cacheMatchIgnoreParams = cacheMatchIgnoreParams;
-exports.canConstructReadableStream = canConstructReadableStream;
-exports.canConstructResponseFromBodyStream = canConstructResponseFromBodyStream;
-exports.dontWaitFor = dontWaitFor;
-exports.executeQuotaErrorCallbacks = executeQuotaErrorCallbacks;
-exports.getFriendlyURL = getFriendlyURL;
-exports.logger = logger;
-exports.privateCacheNames = cacheNames;
-exports.resultingClientExists = resultingClientExists;
-exports.timeout = timeout;
-exports.waitUntil = waitUntil;
+export { SerwistError as S, canConstructResponseFromBodyStream as a, cacheNames as c, finalAssertExports as f, logger as l, quotaErrorCallbacks as q };

package/dist/{index.old.cjs → quotaErrorCallbacks-t3P-jWKl.js}

@@ -25,7 +25,7 @@ const eachCacheNameDetail = (fn)=>{
         fn(key);
     }
 };
-const cacheNames$1 = {
+const cacheNames = {
     updateDetails: (details)=>{
         eachCacheNameDetail((key)=>{
             const detail = details[key];
@@ -51,49 +51,6 @@ const cacheNames$1 = {
     }
 };
 
-/**
- * Get the current cache names and prefix/suffix used by Workbox.
- *
- * `cacheNames.precache` is used for precached assets,
- * `cacheNames.googleAnalytics` is used by `@serwist/google-analytics` to
- * store `analytics.js`, and `cacheNames.runtime` is used for everything else.
- *
- * `cacheNames.prefix` can be used to retrieve just the current prefix value.
- * `cacheNames.suffix` can be used to retrieve just the current suffix value.
- *
- * @returns An object with `precache`, `runtime`, `prefix`, and `googleAnalytics` properties.
- */ const cacheNames = {
-    get googleAnalytics () {
-        return cacheNames$1.getGoogleAnalyticsName();
-    },
-    get precache () {
-        return cacheNames$1.getPrecacheName();
-    },
-    get prefix () {
-        return cacheNames$1.getPrefix();
-    },
-    get runtime () {
-        return cacheNames$1.getRuntimeName();
-    },
-    get suffix () {
-        return cacheNames$1.getSuffix();
-    }
-};
-
-/*
-  Copyright 2019 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.
-*/ // Give TypeScript the correct global.
-/**
- * Claim any currently available clients once the service worker
- * becomes active. This is normally used in conjunction with `skipWaiting()`.
- */ function clientsClaim() {
-    self.addEventListener("activate", ()=>self.clients.claim());
-}
-
 /*
   Copyright 2019 Google LLC
 
@@ -334,51 +291,6 @@ const messageGenerator = process.env.NODE_ENV === "production" ? fallback : gene
     }
 }
 
-/**
- * Allows developers to copy a response and modify its `headers`, `status`,
- * or `statusText` values (the values settable via a
- * [`ResponseInit`](https://developer.mozilla.org/en-US/docs/Web/API/Response/Response#Syntax)
- * object in the constructor).
- * To modify these values, pass a function as the second argument. That
- * function will be invoked with a single object with the response properties
- * `{headers, status, statusText}`. The return value of this function will
- * be used as the `ResponseInit` for the new `Response`. To change the values
- * either modify the passed parameter(s) and return it, or return a totally
- * new object.
- *
- * This method is intentionally limited to same-origin responses, regardless of
- * whether CORS was used or not.
- *
- * @param response
- * @param modifier
- */ async function copyResponse(response, modifier) {
-    let origin = null;
-    // If response.url isn't set, assume it's cross-origin and keep origin null.
-    if (response.url) {
-        const responseURL = new URL(response.url);
-        origin = responseURL.origin;
-    }
-    if (origin !== self.location.origin) {
-        throw new SerwistError("cross-origin-copy-response", {
-            origin
-        });
-    }
-    const clonedResponse = response.clone();
-    // Create a fresh `ResponseInit` object by cloning the headers.
-    const responseInit = {
-        headers: new Headers(clonedResponse.headers),
-        status: clonedResponse.status,
-        statusText: clonedResponse.statusText
-    };
-    // Apply any user modifications.
-    const modifiedResponseInit = modifier ? modifier(responseInit) : responseInit;
-    // Create the new response from the body stream and `ResponseInit`
-    // modifications. Note: not all browsers support the Response.body stream,
-    // so fall back to reading the entire body into memory as a blob.
-    const body = canConstructResponseFromBodyStream() ? clonedResponse.body : await clonedResponse.blob();
-    return new Response(body, modifiedResponseInit);
-}
-
 /*
  * This method throws if the supplied value is not an array.
  * The destructed values are required to produce a meaningful error for users.
@@ -513,65 +425,9 @@ const logger = process.env.NODE_ENV === "production" ? null : (()=>{
 // eslint-disable-next-line @typescript-eslint/ban-types
 const quotaErrorCallbacks = new Set();
 
-/**
- * Adds a function to the set of quotaErrorCallbacks that will be executed if
- * there's a quota error.
- *
- * @param callback
- */ // Can't change Function type
-// eslint-disable-next-line @typescript-eslint/ban-types
-function registerQuotaErrorCallback(callback) {
-    if (process.env.NODE_ENV !== "production") {
-        finalAssertExports.isType(callback, "function", {
-            moduleName: "@serwist/core",
-            funcName: "register",
-            paramName: "callback"
-        });
-    }
-    quotaErrorCallbacks.add(callback);
-    if (process.env.NODE_ENV !== "production") {
-        logger.log("Registered a callback to respond to quota errors.", callback);
-    }
-}
-
-/**
- * Modifies the default cache names used by the Serwist packages.
- * Cache names are generated as `<prefix>-<Cache Name>-<suffix>`.
- *
- * @param details
- */ function setCacheNameDetails(details) {
-    if (process.env.NODE_ENV !== "production") {
-        Object.keys(details).forEach((key)=>{
-            finalAssertExports.isType(details[key], "string", {
-                moduleName: "@serwist/core",
-                funcName: "setCacheNameDetails",
-                paramName: `details.${key}`
-            });
-        });
-        if (details["precache"]?.length === 0) {
-            throw new SerwistError("invalid-cache-name", {
-                cacheNameId: "precache",
-                value: details["precache"]
-            });
-        }
-        if (details["runtime"]?.length === 0) {
-            throw new SerwistError("invalid-cache-name", {
-                cacheNameId: "runtime",
-                value: details["runtime"]
-            });
-        }
-        if (details["googleAnalytics"]?.length === 0) {
-            throw new SerwistError("invalid-cache-name", {
-                cacheNameId: "googleAnalytics",
-                value: details["googleAnalytics"]
-            });
-        }
-    }
-    cacheNames$1.updateDetails(details);
-}
-
+exports.SerwistError = SerwistError;
 exports.cacheNames = cacheNames;
-exports.clientsClaim = clientsClaim;
-exports.copyResponse = copyResponse;
-exports.registerQuotaErrorCallback = registerQuotaErrorCallback;
-exports.setCacheNameDetails = setCacheNameDetails;
+exports.canConstructResponseFromBodyStream = canConstructResponseFromBodyStream;
+exports.finalAssertExports = finalAssertExports;
+exports.logger = logger;
+exports.quotaErrorCallbacks = quotaErrorCallbacks;

package/dist/registerQuotaErrorCallback.d.cts

@@ -0,0 +1,8 @@
+/**
+ * Adds a function to the set of quotaErrorCallbacks that will be executed if
+ * there's a quota error.
+ *
+ * @param callback
+ */
+declare function registerQuotaErrorCallback(callback: Function): void;
+export { registerQuotaErrorCallback };

package/dist/setCacheNameDetails.d.cts

@@ -0,0 +1,9 @@
+import type { PartialCacheNameDetails } from "./_private/cacheNames.js";
+/**
+ * Modifies the default cache names used by the Serwist packages.
+ * Cache names are generated as `<prefix>-<Cache Name>-<suffix>`.
+ *
+ * @param details
+ */
+declare function setCacheNameDetails(details: PartialCacheNameDetails): void;
+export { setCacheNameDetails };