serwist 9.0.0-preview.24 → 9.0.0-preview.25

package/src/{strategies → lib/strategies}/NetworkFirst.ts

@@ -6,9 +6,9 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { assert } from "../utils/assert.js";
-import { SerwistError } from "../utils/SerwistError.js";
-import { logger } from "../utils/logger.js";
+import { SerwistError } from "../../utils/SerwistError.js";
+import { assert } from "../../utils/assert.js";
+import { logger } from "../../utils/logger.js";
 import type { StrategyOptions } from "./Strategy.js";
 import { Strategy } from "./Strategy.js";
 import type { StrategyHandler } from "./StrategyHandler.js";
@@ -55,7 +55,7 @@ export class NetworkFirst extends Strategy {
     if (process.env.NODE_ENV !== "production") {
       if (this._networkTimeoutSeconds) {
         assert!.isType(this._networkTimeoutSeconds, "number", {
-          moduleName: "serwist/strategies",
+          moduleName: "serwist",
           className: this.constructor.name,
           funcName: "constructor",
           paramName: "networkTimeoutSeconds",
@@ -75,7 +75,7 @@ export class NetworkFirst extends Strategy {
 
     if (process.env.NODE_ENV !== "production") {
       assert!.isInstance(request, Request, {
-        moduleName: "serwist/strategies",
+        moduleName: "serwist",
         className: this.constructor.name,
         funcName: "handle",
         paramName: "makeRequest",

package/src/{strategies → lib/strategies}/NetworkOnly.ts

@@ -6,10 +6,10 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { assert } from "../utils/assert.js";
-import { SerwistError } from "../utils/SerwistError.js";
-import { logger } from "../utils/logger.js";
-import { timeout } from "../utils/timeout.js";
+import { SerwistError } from "../../utils/SerwistError.js";
+import { assert } from "../../utils/assert.js";
+import { logger } from "../../utils/logger.js";
+import { timeout } from "../../utils/timeout.js";
 import type { StrategyOptions } from "./Strategy.js";
 import { Strategy } from "./Strategy.js";
 import type { StrategyHandler } from "./StrategyHandler.js";
@@ -51,7 +51,7 @@ export class NetworkOnly extends Strategy {
   async _handle(request: Request, handler: StrategyHandler): Promise<Response> {
     if (process.env.NODE_ENV !== "production") {
       assert!.isInstance(request, Request, {
-        moduleName: "serwist/strategies",
+        moduleName: "serwist",
         className: this.constructor.name,
         funcName: "_handle",
         paramName: "request",

package/src/{PrecacheStrategy.ts → lib/strategies/PrecacheOnly.ts}

@@ -6,15 +6,15 @@
   https://opensource.org/licenses/MIT.
 */
 
-import type { SerwistPlugin } from "./types.js";
-import { copyResponse } from "./copyResponse.js";
-import { SerwistError } from "./utils/SerwistError.js";
-import { getFriendlyURL } from "./utils/getFriendlyURL.js";
-import { logger } from "./utils/logger.js";
-import { cacheNames as privateCacheNames } from "./utils/cacheNames.js";
-import type { StrategyOptions } from "./strategies/Strategy.js";
-import { Strategy } from "./strategies/Strategy.js";
-import type { StrategyHandler } from "./strategies/StrategyHandler.js";
+import { copyResponse } from "../../copyResponse.js";
+import type { SerwistPlugin } from "../../types.js";
+import { SerwistError } from "../../utils/SerwistError.js";
+import { cacheNames as privateCacheNames } from "../../utils/cacheNames.js";
+import { getFriendlyURL } from "../../utils/getFriendlyURL.js";
+import { logger } from "../../utils/logger.js";
+import type { StrategyOptions } from "./Strategy.js";
+import { Strategy } from "./Strategy.js";
+import type { StrategyHandler } from "./StrategyHandler.js";
 
 interface PrecacheStrategyOptions extends StrategyOptions {
   /**
@@ -29,9 +29,9 @@ interface PrecacheStrategyOptions extends StrategyOptions {
  * specifically designed to both cache and fetch precached assets.
  *
  * Note: an instance of this class is created automatically when creating a
- * `PrecacheController`; it's generally not necessary to create this yourself.
+ * `Serwist` instance; it's generally not necessary to create this yourself.
  */
-export class PrecacheStrategy extends Strategy {
+export class PrecacheOnly extends Strategy {
   private readonly _fallbackToNetwork: boolean;
 
   static readonly defaultPrecacheCacheabilityPlugin: SerwistPlugin = {
@@ -55,6 +55,7 @@ export class PrecacheStrategy extends Strategy {
    */
   constructor(options: PrecacheStrategyOptions = {}) {
     options.cacheName = privateCacheNames.getPrecacheName(options.cacheName);
+
     super(options);
 
     this._fallbackToNetwork = options.fallbackToNetwork === false ? false : true;
@@ -63,7 +64,7 @@ export class PrecacheStrategy extends Strategy {
     // any redirected response must be "copied" rather than cloned, so the new
     // response doesn't contain the `redirected` flag. See:
     // https://bugs.chromium.org/p/chromium/issues/detail?id=669363&desc=2#c1
-    this.plugins.push(PrecacheStrategy.copyRedirectedCacheableResponsesPlugin);
+    this.plugins.push(PrecacheOnly.copyRedirectedCacheableResponsesPlugin);
   }
 
   /**
@@ -74,6 +75,7 @@ export class PrecacheStrategy extends Strategy {
    */
   async _handle(request: Request, handler: StrategyHandler): Promise<Response> {
     const response = await handler.cacheMatch(request);
+
     if (response) {
       return response;
     }
@@ -91,6 +93,7 @@ export class PrecacheStrategy extends Strategy {
 
   async _handleFetch(request: Request, handler: StrategyHandler): Promise<Response> {
     let response: Response | undefined = undefined;
+
     const params = (handler.params || {}) as {
       cacheKey?: string;
       integrity?: string;
@@ -169,6 +172,7 @@ export class PrecacheStrategy extends Strategy {
     // Make sure we defer cachePut() until after we know the response
     // should be cached; see https://github.com/GoogleChrome/workbox/issues/2737
     const wasCached = await handler.cachePut(request, response.clone());
+
     if (!wasCached) {
       // Throwing here will lead to the `install` handler failing, which
       // we want to do if *any* of the responses aren't safe to cache.
@@ -214,12 +218,12 @@ export class PrecacheStrategy extends Strategy {
 
     for (const [index, plugin] of this.plugins.entries()) {
       // Ignore the copy redirected plugin when determining what to do.
-      if (plugin === PrecacheStrategy.copyRedirectedCacheableResponsesPlugin) {
+      if (plugin === PrecacheOnly.copyRedirectedCacheableResponsesPlugin) {
         continue;
       }
 
       // Save the default plugin's index, in case it needs to be removed.
-      if (plugin === PrecacheStrategy.defaultPrecacheCacheabilityPlugin) {
+      if (plugin === PrecacheOnly.defaultPrecacheCacheabilityPlugin) {
         defaultPluginIndex = index;
       }
 
@@ -229,7 +233,7 @@ export class PrecacheStrategy extends Strategy {
     }
 
     if (cacheWillUpdatePluginCount === 0) {
-      this.plugins.push(PrecacheStrategy.defaultPrecacheCacheabilityPlugin);
+      this.plugins.push(PrecacheOnly.defaultPrecacheCacheabilityPlugin);
     } else if (cacheWillUpdatePluginCount > 1 && defaultPluginIndex !== null) {
       // Only remove the default plugin; multiple custom plugins are allowed.
       this.plugins.splice(defaultPluginIndex, 1);

package/src/{strategies → lib/strategies}/StaleWhileRevalidate.ts

@@ -6,9 +6,9 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { assert } from "../utils/assert.js";
-import { SerwistError } from "../utils/SerwistError.js";
-import { logger } from "../utils/logger.js";
+import { SerwistError } from "../../utils/SerwistError.js";
+import { assert } from "../../utils/assert.js";
+import { logger } from "../../utils/logger.js";
 import type { StrategyOptions } from "./Strategy.js";
 import { Strategy } from "./Strategy.js";
 import type { StrategyHandler } from "./StrategyHandler.js";
@@ -58,7 +58,7 @@ export class StaleWhileRevalidate extends Strategy {
 
     if (process.env.NODE_ENV !== "production") {
       assert!.isInstance(request, Request, {
-        moduleName: "serwist/strategies",
+        moduleName: "serwist",
         className: this.constructor.name,
         funcName: "handle",
         paramName: "request",

package/src/{strategies → lib/strategies}/Strategy.ts

@@ -6,11 +6,11 @@
   https://opensource.org/licenses/MIT.
 */
 
-import type { HandlerCallbackOptions, RouteHandlerObject, SerwistPlugin } from "../types.js";
-import { SerwistError } from "../utils/SerwistError.js";
-import { getFriendlyURL } from "../utils/getFriendlyURL.js";
-import { logger } from "../utils/logger.js";
-import { cacheNames as privateCacheNames } from "../utils/cacheNames.js";
+import type { HandlerCallbackOptions, RouteHandlerObject, SerwistPlugin } from "../../types.js";
+import { SerwistError } from "../../utils/SerwistError.js";
+import { cacheNames as privateCacheNames } from "../../utils/cacheNames.js";
+import { getFriendlyURL } from "../../utils/getFriendlyURL.js";
+import { logger } from "../../utils/logger.js";
 import { StrategyHandler } from "./StrategyHandler.js";
 
 export interface StrategyOptions {

package/src/{strategies → lib/strategies}/StrategyHandler.ts

@@ -6,15 +6,15 @@
   https://opensource.org/licenses/MIT.
 */
 
-import type { HandlerCallbackOptions, MapLikeObject, SerwistPlugin, SerwistPluginCallbackParam } from "../types.js";
-import { assert } from "../utils/assert.js";
-import { Deferred } from "../utils/Deferred.js";
-import { SerwistError } from "../utils/SerwistError.js";
-import { cacheMatchIgnoreParams } from "../utils/cacheMatchIgnoreParams.js";
-import { executeQuotaErrorCallbacks } from "../utils/executeQuotaErrorCallbacks.js";
-import { getFriendlyURL } from "../utils/getFriendlyURL.js";
-import { logger } from "../utils/logger.js";
-import { timeout } from "../utils/timeout.js";
+import type { HandlerCallbackOptions, MapLikeObject, SerwistPlugin, SerwistPluginCallbackParam } from "../../types.js";
+import { Deferred } from "../../utils/Deferred.js";
+import { SerwistError } from "../../utils/SerwistError.js";
+import { assert } from "../../utils/assert.js";
+import { cacheMatchIgnoreParams } from "../../utils/cacheMatchIgnoreParams.js";
+import { executeQuotaErrorCallbacks } from "../../utils/executeQuotaErrorCallbacks.js";
+import { getFriendlyURL } from "../../utils/getFriendlyURL.js";
+import { logger } from "../../utils/logger.js";
+import { timeout } from "../../utils/timeout.js";
 import type { Strategy } from "./Strategy.js";
 
 function toRequest(input: RequestInfo) {
@@ -78,13 +78,13 @@ export class StrategyHandler {
   ) {
     if (process.env.NODE_ENV !== "production") {
       assert!.isInstance(options.event, ExtendableEvent, {
-        moduleName: "serwist/strategies",
+        moduleName: "serwist",
         className: "StrategyHandler",
         funcName: "constructor",
         paramName: "options.event",
       });
       assert!.isInstance(options.request, Request, {
-        moduleName: "serwist/strategies",
+        moduleName: "serwist",
         className: "StrategyHandler",
         funcName: "constructor",
         paramName: "options.request",

package/src/{strategies → lib/strategies}/plugins/cacheOkAndOpaquePlugin.ts

@@ -6,7 +6,7 @@
   https://opensource.org/licenses/MIT.
 */
 
-import type { SerwistPlugin } from "../../types.js";
+import type { SerwistPlugin } from "../../../types.js";
 
 export const cacheOkAndOpaquePlugin: SerwistPlugin = {
   /**

package/src/{strategies → lib/strategies}/utils/messages.ts

@@ -6,8 +6,8 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { getFriendlyURL } from "../../utils/getFriendlyURL.js";
-import { logger } from "../../utils/logger.js";
+import { getFriendlyURL } from "../../../utils/getFriendlyURL.js";
+import { logger } from "../../../utils/logger.js";
 
 export const messages = {
   strategyStart: (strategyName: string, request: Request): string => `Using ${strategyName} to respond to '${getFriendlyURL(request.url)}'`,

package/src/models/messages/messages.ts

@@ -112,7 +112,7 @@ export const messages = {
   },
 
   "duplicate-queue-name": ({ name }) => {
-    return `The Queue name '${name}' is already being used. All instances of backgroundSync.Queue must be given unique names.`;
+    return `The queue name '${name}' is already being used. All instances of 'serwist.BackgroundSyncQueue' must be given unique names.`;
   },
 
   "expired-test-without-max-age": ({ methodName, paramName }) => {

package/src/navigationPreload.ts

@@ -7,7 +7,7 @@ declare const self: ServiceWorkerGlobalScope;
  * navigation preloading.
  *
  * @returns
- * @see https://serwist.pages.dev/docs/sw/navigation-preloading/is-navigation-preload-supported
+ * @see https://serwist.pages.dev/docs/serwist/core/is-navigation-preload-supported
  */
 export const isNavigationPreloadSupported = (): boolean => {
   return Boolean(self.registration?.navigationPreload);
@@ -19,7 +19,7 @@ export const isNavigationPreloadSupported = (): boolean => {
  * @param headerValue Optional. Allows developers to override the value of
  * the `Service-Worker-Navigation-Preload` header which will be sent to the
  * server when making the navigation request.
- * @see https://serwist.pages.dev/docs/sw/navigation-preloading/enable-navigation-preload
+ * @see https://serwist.pages.dev/docs/serwist/core/enable-navigation-preload
  */
 export const enableNavigationPreload = (headerValue?: string): void => {
   if (isNavigationPreloadSupported()) {
@@ -47,7 +47,7 @@ export const enableNavigationPreload = (headerValue?: string): void => {
 /**
  * If the browser supports navigation preloading, then this will disable it.
  *
- * @see https://serwist.pages.dev/docs/sw/navigation-preloading/disable-navigation-preload
+ * @see https://serwist.pages.dev/docs/serwist/core/disable-navigation-preload
  */
 export const disableNavigationPreload = (): void => {
   if (isNavigationPreloadSupported()) {

package/src/parseRoute.ts

@@ -1,9 +1,9 @@
-import type { RouteHandler, RouteMatchCallback } from "./types.js";
-import { SerwistError } from "./utils/SerwistError.js";
-import { logger } from "./utils/logger.js";
 import { RegExpRoute } from "./RegExpRoute.js";
 import { Route } from "./Route.js";
 import type { HTTPMethod } from "./constants.js";
+import type { RouteHandler, RouteMatchCallback } from "./types.js";
+import { SerwistError } from "./utils/SerwistError.js";
+import { logger } from "./utils/logger.js";
 
 /**
  * Parses a `RegExp`, string, or function with a caching strategy into a `Route`. This is for

package/src/registerQuotaErrorCallback.ts

@@ -6,9 +6,9 @@
   https://opensource.org/licenses/MIT.
 */
 
+import { quotaErrorCallbacks } from "./models/quotaErrorCallbacks.js";
 import { assert } from "./utils/assert.js";
 import { logger } from "./utils/logger.js";
-import { quotaErrorCallbacks } from "./models/quotaErrorCallbacks.js";
 
 /**
  * Adds a function to the set of quotaErrorCallbacks that will be executed if

package/src/types.ts

@@ -335,22 +335,27 @@ export declare interface PrecacheEntry {
 
 export interface PrecacheRouteOptions {
   /**
-   * The `directoryIndex` will check cache entries for a URL ending with '/'
-   * to see if there is a hit when appending the `directoryIndex` value.
+   * Tells Serwist to check the precache for an entry whose URL is the request URL appended
+   * with the specified value. Only applies if the request URL ends with "/".
+   *
+   * @default "index.html"
    */
   directoryIndex?: string | null;
   /**
-   * An array of RegExp's to remove search params when looking for a cache match.
+   * An array of `RegExp` objects matching search params that should be removed when looking
+   * for a precache match.
    */
   ignoreURLParametersMatching?: RegExp[];
   /**
-   * The `cleanURLs` option will check the cache for the URL with a `.html` added
-   * to the end of the end.
+   * Tells Serwist to check the precache for an entry whose URL is the request URL appended
+   * with ".html".
+   *
+   * @default true
    */
   cleanURLs?: boolean;
   /**
-   * This is a function that should take a URL and return an array of
-   * alternative URLs that should be checked for precache matches.
+   * A function that should take a URL and return an array of alternative URLs that should
+   * be checked for precache matches.
    */
   urlManipulation?: UrlManipulation;
 }

package/src/utils/PrecacheCacheKeyPlugin.ts

@@ -6,8 +6,8 @@
   https://opensource.org/licenses/MIT.
 */
 
-import type { SerwistPlugin, SerwistPluginCallbackParam } from "../types.js";
 import type { Serwist } from "../Serwist.js";
+import type { SerwistPlugin, SerwistPluginCallbackParam } from "../types.js";
 
 /**
  * A plugin, designed to be used with PrecacheController, to translate URLs into

package/src/utils/assert.ts

@@ -6,8 +6,8 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { SerwistError } from "./SerwistError.js";
 import type { MapLikeObject } from "../types.js";
+import { SerwistError } from "./SerwistError.js";
 
 /*
  * This method throws if the supplied value is not an array.

package/src/utils/executeQuotaErrorCallbacks.ts

@@ -6,8 +6,8 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { logger } from "./logger.js";
 import { quotaErrorCallbacks } from "../models/quotaErrorCallbacks.js";
+import { logger } from "./logger.js";
 
 /**
  * Runs all of the callback functions, one at a time sequentially, in the order

package/src/utils/welcome.ts

@@ -14,6 +14,6 @@ if (process.env.NODE_ENV !== "production") {
   const padding = "   ";
   logger.groupCollapsed("Welcome to Serwist!");
   logger.log(`📖 Read the guides and documentation\n${padding}https://serwist.pages.dev/`);
-  logger.log(`🐛 Found a bug or want to ask a question? Open a new issue on GitLab\n${padding}https://gitlab.com/serwist/serwist/issues/new`);
+  logger.log(`🐛 Found a bug or want to ask a question? Open a new issue on GitHub\n${padding}https://github.com/serwist/serwist/issues/new/choose`);
   logger.groupEnd();
 }

package/dist/PrecacheStrategy.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PrecacheStrategy.d.ts","sourceRoot":"","sources":["../src/PrecacheStrategy.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAMhD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAEvE,UAAU,uBAAwB,SAAQ,eAAe;IACvD;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,QAAQ;IAC5C,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAU;IAE7C,MAAM,CAAC,QAAQ,CAAC,iCAAiC,EAAE,aAAa,CAQ9D;IAEF,MAAM,CAAC,QAAQ,CAAC,sCAAsC,EAAE,aAAa,CAInE;IAEF;;OAEG;gBACS,OAAO,GAAE,uBAA4B;IAajD;;;;;OAKG;IACG,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAiBtE,YAAY,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAwE3E,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,QAAQ,CAAC;IAoBnF;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,qCAAqC,IAAI,IAAI;CA4B9C"}