@serwist/core 9.0.0-preview.0 → 9.0.0-preview.2

package/dist/_private/logger.d.ts

@@ -6,6 +6,12 @@ declare global {
         __WB_DISABLE_DEV_LOGS: boolean;
     }
 }
-declare const logger: Console;
-export { logger };
+export declare const logger: {
+    error: (...args: any[]) => void;
+    debug: (...args: any[]) => void;
+    log: (...args: any[]) => void;
+    warn: (...args: any[]) => void;
+    groupCollapsed: (...args: any[]) => void;
+    groupEnd: (...args: any[]) => void;
+};
 //# sourceMappingURL=logger.d.ts.map

package/dist/_private/logger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/_private/logger.ts"],"names":[],"mappings":"AAQA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,iBAAiB;QACzB,qBAAqB,EAAE,OAAO,CAAC;KAChC;IAED,UAAU,MAAM;QACd,qBAAqB,EAAE,OAAO,CAAC;KAChC;CACF;AAID,QAAA,MAAM,MAAM,SAqEA,CAAC;AAEb,OAAO,EAAE,MAAM,EAAE,CAAC"}
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/_private/logger.ts"],"names":[],"mappings":"AAQA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,iBAAiB;QACzB,qBAAqB,EAAE,OAAO,CAAC;KAChC;IAED,UAAU,MAAM;QACd,qBAAqB,EAAE,OAAO,CAAC;KAChC;CACF;AAED,eAAO,MAAM,MAAM;qBAmEoC,GAAG,EAAE,KAAK,IAAI;qBAAd,GAAG,EAAE,KAAK,IAAI;mBAAd,GAAG,EAAE,KAAK,IAAI;oBAAd,GAAG,EAAE,KAAK,IAAI;8BAAd,GAAG,EAAE,KAAK,IAAI;wBAAd,GAAG,EAAE,KAAK,IAAI;CAE3D,CAAC"}

package/dist/chunks/quotaErrorCallbacks.js

@@ -1,10 +1,4 @@
-/*
-  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 = {
+const _cacheNameDetails = {
     googleAnalytics: "googleAnalytics",
     precache: "precache-v2",
     prefix: "serwist",
@@ -49,13 +43,7 @@ const cacheNames = {
     }
 };
 
-/*
-  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 messages = {
+const messages = {
     "invalid-value": ({ paramName, validValueDescription, value })=>{
         if (!paramName || !validValueDescription) {
             throw new Error(`Unexpected input to 'invalid-value' error.`);
@@ -234,24 +222,9 @@ const generatorFunction = (code, details = {})=>{
 };
 const messageGenerator = process.env.NODE_ENV === "production" ? fallback : generatorFunction;
 
-/**
- * Serwist errors should be thrown with this class.
- * This allows use to ensure the type easily in tests,
- * helps developers identify errors from Serwist
- * easily and allows use to optimise error
- * messages correctly.
- *
- * @private
- */ class SerwistError extends Error {
+class SerwistError extends Error {
     details;
-    /**
-   *
-   * @param errorCode The error code that
-   * identifies this particular error.
-   * @param details Any relevant arguments
-   * that will help developers identify issues should
-   * be added as a key on the context object.
-   */ constructor(errorCode, details){
+    constructor(errorCode, details){
         const message = messageGenerator(errorCode, details);
         super(message);
         this.name = errorCode;
@@ -259,21 +232,8 @@ const messageGenerator = process.env.NODE_ENV === "production" ? fallback : gene
     }
 }
 
-/*
-  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() {
+let supportStatus;
+function canConstructResponseFromBodyStream() {
     if (supportStatus === undefined) {
         const testResponse = new Response("");
         if ("body" in testResponse) {
@@ -289,12 +249,7 @@ const messageGenerator = process.env.NODE_ENV === "production" ? fallback : gene
     return supportStatus;
 }
 
-/*
- * This method throws if the supplied value is not an array.
- * The destructed values are required to produce a meaningful error for users.
- * The destructed and restructured object is so it's clear what is
- * needed.
- */ const isArray = (value, details)=>{
+const isArray = (value, details)=>{
     if (!Array.isArray(value)) {
         throw new SerwistError("not-an-array", details);
     }
@@ -307,14 +262,12 @@ const hasMethod = (object, expectedMethod, details)=>{
     }
 };
 const isType = (object, expectedType, details)=>{
-    // biome-ignore lint/suspicious/useValidTypeof: Know to not make a mistake...
     if (typeof object !== expectedType) {
         details.expectedType = expectedType;
         throw new SerwistError("incorrect-type", details);
     }
 };
-const isInstance = (object, // biome-ignore lint/complexity/noBannedTypes: Need the general type to do the check later.
-expectedClass, details)=>{
+const isInstance = (object, expectedClass, details)=>{
     if (!(object instanceof expectedClass)) {
         details.expectedClassName = expectedClass.name;
         throw new SerwistError("incorrect-class", details);
@@ -326,8 +279,7 @@ const isOneOf = (value, validValues, details)=>{
         throw new SerwistError("invalid-value", details);
     }
 };
-const isArrayOfClass = (value, // biome-ignore lint/complexity/noBannedTypes: Need general type to do check later.
-expectedClass, details)=>{
+const isArrayOfClass = (value, expectedClass, details)=>{
     const error = new SerwistError("not-array-of-class", details);
     if (!Array.isArray(value)) {
         throw error;
@@ -347,15 +299,7 @@ const finalAssertExports = process.env.NODE_ENV === "production" ? null : {
     isArrayOfClass
 };
 
-/*
-  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.
-*/ // logger is used inside of both service workers and the window global scope.
 const logger = process.env.NODE_ENV === "production" ? null : (()=>{
-    // Don't overwrite this value if it's already set.
-    // See https://github.com/GoogleChrome/workbox/pull/2284#issuecomment-560470923
     if (!("__WB_DISABLE_DEV_LOGS" in globalThis)) {
         self.__WB_DISABLE_DEV_LOGS = false;
     }
@@ -373,8 +317,6 @@ const logger = process.env.NODE_ENV === "production" ? null : (()=>{
             return;
         }
         if (method === "groupCollapsed") {
-            // Safari doesn't print all console.groupCollapsed() arguments:
-            // https://bugs.webkit.org/show_bug.cgi?id=182754
             if (typeof navigator !== "undefined" && /^((?!chrome|android).)*safari/i.test(navigator.userAgent)) {
                 console[method](...args);
                 return;
@@ -387,7 +329,6 @@ const logger = process.env.NODE_ENV === "production" ? null : (()=>{
             "font-weight: bold",
             "padding: 2px 0.5em"
         ];
-        // When in a group, the serwist prefix is not displayed.
         const logPrefix = inGroup ? [] : [
             "%cserwist",
             styles.join(";")
@@ -400,26 +341,15 @@ const logger = process.env.NODE_ENV === "production" ? null : (()=>{
             inGroup = false;
         }
     };
-    // biome-ignore lint/complexity/noBannedTypes: Unknown reason
-    const api = {};
     const loggerMethods = Object.keys(methodToColorMap);
-    for (const key of loggerMethods){
-        const method = key;
+    return loggerMethods.reduce((api, method)=>{
         api[method] = (...args)=>{
             print(method, args);
         };
-    }
-    return api;
+        return api;
+    }, {});
 })();
 
-/*
-  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.
-*/ // Callbacks to be executed whenever there's a quota error.
-// biome-ignore lint/complexity/noBannedTypes: Can't change Function type right now.
 const quotaErrorCallbacks = new Set();
 
 export { SerwistError as S, canConstructResponseFromBodyStream as a, cacheNames as c, finalAssertExports as f, logger as l, quotaErrorCallbacks as q };

package/dist/index.internal.js

@@ -1,26 +1,11 @@
 import { l as logger, q as quotaErrorCallbacks } from './chunks/quotaErrorCallbacks.js';
 export { S as SerwistError, f as assert, a as canConstructResponseFromBodyStream, c as privateCacheNames } from './chunks/quotaErrorCallbacks.js';
 
-/*
-  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 {
+class Deferred {
     promise;
     resolve;
     reject;
-    /**
-   * Creates a promise and exposes its resolve and reject functions as methods.
-   */ constructor(){
+    constructor(){
         this.promise = new Promise((resolve, reject)=>{
             this.resolve = resolve;
             this.reject = reject;
@@ -28,36 +13,18 @@ export { S as SerwistError, f as assert, a as canConstructResponseFromBodyStream
     }
 }
 
-/*
-  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) {
+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) {
+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
@@ -72,24 +39,9 @@ export { S as SerwistError, f as assert, a as canConstructResponseFromBodyStream
     return;
 }
 
-/*
-  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 [`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() {
+let supportStatus;
+function canConstructReadableStream() {
     if (supportStatus === undefined) {
-        // See https://github.com/GoogleChrome/workbox/issues/1473
         try {
             new ReadableStream({
                 start () {}
@@ -102,26 +54,11 @@ export { S as SerwistError, f as assert, a as canConstructResponseFromBodyStream
     return supportStatus;
 }
 
-/*
-  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.
+function dontWaitFor(promise) {
     void promise.then(()=>{});
 }
 
-/**
- * Runs all of the callback functions, one at a time sequentially, in the order
- * in which they were registered.
- *
- * @private
- */ async function executeQuotaErrorCallbacks() {
+async function executeQuotaErrorCallbacks() {
     if (process.env.NODE_ENV !== "production") {
         logger.log(`About to run ${quotaErrorCallbacks.size} callbacks to clean up caches.`);
     }
@@ -136,46 +73,17 @@ export { S as SerwistError, f as assert, a as canConstructResponseFromBodyStream
     }
 }
 
-/*
-  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 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) {
+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) {
+async function resultingClientExists(resultingClientId) {
     if (!resultingClientId) {
         return;
     }
@@ -185,42 +93,25 @@ const MAX_RETRY_TIME = 2000;
     const existingWindowIds = new Set(existingWindows.map((w)=>w.id));
     let resultingWindow = undefined;
     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;
             }
-            // 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) {
+function waitUntil(event, asyncFn) {
     const returnPromise = asyncFn();
     event.waitUntil(returnPromise);
     return returnPromise;

package/dist/index.js

@@ -1,17 +1,6 @@
 import { c as cacheNames$1, S as SerwistError, a as canConstructResponseFromBodyStream, f as finalAssertExports, q as quotaErrorCallbacks, l as logger } from './chunks/quotaErrorCallbacks.js';
 
-/**
- * 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 = {
+const cacheNames = {
     get googleAnalytics () {
         return cacheNames$1.getGoogleAnalyticsName();
     },
@@ -29,40 +18,12 @@ import { c as cacheNames$1, S as SerwistError, a as canConstructResponseFromBody
     }
 };
 
-/*
-  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() {
+function clientsClaim() {
     self.addEventListener("activate", ()=>self.clients.claim());
 }
 
-/**
- * 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) {
+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;
@@ -73,27 +34,16 @@ import { c as cacheNames$1, S as SerwistError, a as canConstructResponseFromBody
         });
     }
     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);
 }
 
-/**
- * Adds a function to the set of quotaErrorCallbacks that will be executed if
- * there's a quota error.
- *
- * @param callback
- */ // biome-ignore lint/complexity/noBannedTypes: Can't change Function type
 function registerQuotaErrorCallback(callback) {
     if (process.env.NODE_ENV !== "production") {
         finalAssertExports.isType(callback, "function", {
@@ -108,12 +58,7 @@ function registerQuotaErrorCallback(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) {
+function setCacheNameDetails(details) {
     if (process.env.NODE_ENV !== "production") {
         for (const key of Object.keys(details)){
             finalAssertExports.isType(details[key], "string", {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/core",
-  "version": "9.0.0-preview.0",
+  "version": "9.0.0-preview.2",
   "type": "module",
   "description": "This module is used by a number of the other Serwist modules to share common code.",
   "files": [
@@ -39,8 +39,8 @@
   },
   "devDependencies": {
     "rollup": "4.9.6",
-    "typescript": "5.4.0-dev.20240203",
-    "@serwist/constants": "9.0.0-preview.0"
+    "typescript": "5.4.0-dev.20240206",
+    "@serwist/constants": "9.0.0-preview.2"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"

package/src/_private/logger.ts

@@ -16,11 +16,9 @@ declare global {
   }
 }
 
-type LoggerMethods = "debug" | "log" | "warn" | "error" | "groupCollapsed" | "groupEnd";
-
-const logger = (
+export const logger =
   process.env.NODE_ENV === "production"
-    ? null
+    ? null!
     : (() => {
         // Don't overwrite this value if it's already set.
         // See https://github.com/GoogleChrome/workbox/pull/2284#issuecomment-560470923
@@ -30,7 +28,7 @@ const logger = (
 
         let inGroup = false;
 
-        const methodToColorMap: { [methodName: string]: string | null } = {
+        const methodToColorMap = {
           debug: "#7f8c8d", // Gray
           log: "#2ecc71", // Green
           warn: "#f39c12", // Yellow
@@ -39,6 +37,8 @@ const logger = (
           groupEnd: null, // No colored prefix on groupEnd
         };
 
+        type LoggerMethods = keyof typeof methodToColorMap;
+
         const print = (method: LoggerMethods, args: any[]) => {
           if (self.__WB_DISABLE_DEV_LOGS) {
             return;
@@ -73,20 +73,16 @@ const logger = (
             inGroup = false;
           }
         };
-        // biome-ignore lint/complexity/noBannedTypes: Unknown reason
-        const api: { [methodName: string]: Function } = {};
-        const loggerMethods = Object.keys(methodToColorMap);
-
-        for (const key of loggerMethods) {
-          const method = key as LoggerMethods;
-
-          api[method] = (...args: any[]) => {
-            print(method, args);
-          };
-        }
-
-        return api as unknown;
-      })()
-) as Console;
 
-export { logger };
+        const loggerMethods = Object.keys(methodToColorMap) as LoggerMethods[];
+
+        return loggerMethods.reduce(
+          (api, method) => {
+            api[method] = (...args: any[]) => {
+              print(method, args);
+            };
+            return api;
+          },
+          {} as { [method in LoggerMethods]: (...args: any[]) => void },
+        );
+      })();