@serwist/sw 9.0.0-preview.1 → 9.0.0-preview.2

package/dist/disableDevLogs.d.ts

@@ -1,2 +1,5 @@
+/**
+ * Disables Serwist's logging in development mode.
+ */
 export declare const disableDevLogs: () => void;
 //# sourceMappingURL=disableDevLogs.d.ts.map

package/dist/disableDevLogs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"disableDevLogs.d.ts","sourceRoot":"","sources":["../src/disableDevLogs.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,cAAc,YAE1B,CAAC"}
+{"version":3,"file":"disableDevLogs.d.ts","sourceRoot":"","sources":["../src/disableDevLogs.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,eAAO,MAAM,cAAc,YAE1B,CAAC"}

package/dist/fallbacks.d.ts

@@ -25,9 +25,26 @@ export interface FallbackEntry {
     cacheMatchOptions?: MultiCacheQueryOptions;
 }
 export interface FallbacksOptions {
+    /**
+     * Your previous `RuntimeCaching` array.
+     */
     runtimeCaching: RuntimeCaching[];
+    /**
+     * A list of fallback entries.
+     */
     entries: FallbackEntry[];
+    /**
+     * Precache options that will be used for your
+     * fallback entries.
+     */
     precacheOptions?: PrecacheRouteOptions;
 }
+/**
+ * Precaches routes so that they can be used as a fallback when
+ * a `RuntimeCaching` handler fails.
+ * @param options
+ * @returns The modified `RuntimeCaching` array. Using this value
+ * is not needed, as it is simply the provided array.
+ */
 export declare const fallbacks: ({ runtimeCaching, entries, precacheOptions }: FallbacksOptions) => RuntimeCaching[];
 //# sourceMappingURL=fallbacks.d.ts.map

package/dist/fallbacks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fallbacks.d.ts","sourceRoot":"","sources":["../src/fallbacks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAGhE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,EAAE,4BAA4B,KAAK,OAAO,CAAC;AAE3E,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,OAAO,EAAE,eAAe,CAAC;IACzB;;OAEG;IACH,GAAG,EAAE,GAAG,GAAG,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,sBAAsB,CAAC;CAC5C;AAED,MAAM,WAAW,gBAAgB;IAC/B,cAAc,EAAE,cAAc,EAAE,CAAC;IACjC,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,eAAe,CAAC,EAAE,oBAAoB,CAAC;CACxC;AAED,eAAO,MAAM,SAAS,iDAAkD,gBAAgB,qBA4BvF,CAAC"}
+{"version":3,"file":"fallbacks.d.ts","sourceRoot":"","sources":["../src/fallbacks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAGhE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,EAAE,4BAA4B,KAAK,OAAO,CAAC;AAE3E,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,OAAO,EAAE,eAAe,CAAC;IACzB;;OAEG;IACH,GAAG,EAAE,GAAG,GAAG,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,sBAAsB,CAAC;CAC5C;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IACjC;;OAEG;IACH,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB;;;OAGG;IACH,eAAe,CAAC,EAAE,oBAAoB,CAAC;CACxC;AAED;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,iDAAkD,gBAAgB,KAAG,cAAc,EA4BxG,CAAC"}

package/dist/handlePrecaching.d.ts

@@ -1,14 +1,41 @@
 import type { PrecacheEntry, PrecacheRouteOptions } from "@serwist/precaching";
 export type HandlePrecachingOptions = {
+    /**
+     * A list of fallback entries.
+     */
     precacheEntries?: (PrecacheEntry | string)[];
+    /**
+     * Precache options for the provided entries.
+     */
     precacheOptions?: PrecacheRouteOptions;
+    /**
+     * Whether outdated caches should be removed.
+     *
+     * @default false
+     */
     cleanupOutdatedCaches?: boolean;
 } & ({
+    /**
+     * An URL that should point to a HTML
+     * file with which navigation requests for URLs that aren't precached will be fulfilled.
+     * For more complex cases, consider `@serwist/sw.fallbacks`instead.
+     */
     navigateFallback: string;
+    /**
+     * URLs that should be allowed to use the `navigateFallback` handler.
+     */
     navigateFallbackAllowlist?: RegExp[];
+    /**
+     * URLs that should not be allowed to use the `navigateFallback` handler. This takes precedence
+     * over `navigateFallbackAllowlist`.
+     */
     navigateFallbackDenylist?: RegExp[];
 } | {
     navigateFallback?: never;
 });
-export declare const handlePrecaching: ({ precacheEntries, precacheOptions, cleanupOutdatedCaches: shouldCleanupOutdatedCaches, ...options }: HandlePrecachingOptions) => void;
+/**
+ * Handles a list of precache entries and cleans up outdated caches.
+ * @param options
+ */
+export declare const handlePrecaching: ({ precacheEntries, precacheOptions, cleanupOutdatedCaches, ...options }: HandlePrecachingOptions) => void;
 //# sourceMappingURL=handlePrecaching.d.ts.map

package/dist/handlePrecaching.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handlePrecaching.d.ts","sourceRoot":"","sources":["../src/handlePrecaching.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAI/E,MAAM,MAAM,uBAAuB,GAAG;IACpC,eAAe,CAAC,EAAE,CAAC,aAAa,GAAG,MAAM,CAAC,EAAE,CAAC;IAC7C,eAAe,CAAC,EAAE,oBAAoB,CAAC;IAEvC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,GAAG,CAAC;IAAE,gBAAgB,EAAE,MAAM,CAAC;IAAC,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;IAAC,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAA;CAAE,GAAG;IAAE,gBAAgB,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC,CAAC;AAE7I,eAAO,MAAM,gBAAgB,yGAK1B,uBAAuB,SAoBzB,CAAC"}
+{"version":3,"file":"handlePrecaching.d.ts","sourceRoot":"","sources":["../src/handlePrecaching.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAI/E,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,eAAe,CAAC,EAAE,CAAC,aAAa,GAAG,MAAM,CAAC,EAAE,CAAC;IAC7C;;OAEG;IACH,eAAe,CAAC,EAAE,oBAAoB,CAAC;IACvC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,GAAG,CACA;IACE;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;IACrC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;CACrC,GACD;IAAE,gBAAgB,CAAC,EAAE,KAAK,CAAA;CAAE,CAC/B,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,gBAAgB,4EAAqF,uBAAuB,SAoBxI,CAAC"}

package/dist/index.js

@@ -44,11 +44,11 @@ const fallbacks = ({ runtimeCaching, entries, precacheOptions })=>{
     return runtimeCaching;
 };
 
-const handlePrecaching = ({ precacheEntries, precacheOptions, cleanupOutdatedCaches: shouldCleanupOutdatedCaches = false, ...options })=>{
+const handlePrecaching = ({ precacheEntries, precacheOptions, cleanupOutdatedCaches: cleanupOutdatedCaches$1 = false, ...options })=>{
     if (!!precacheEntries && precacheEntries.length > 0) {
         precacheAndRoute(precacheEntries, precacheOptions);
     }
-    if (shouldCleanupOutdatedCaches) cleanupOutdatedCaches();
+    if (cleanupOutdatedCaches$1) cleanupOutdatedCaches();
     if (options.navigateFallback) {
         registerRoute(new NavigationRoute(createHandlerBoundToURL(options.navigateFallback), {
             allowlist: options.navigateFallbackAllowlist,
@@ -71,7 +71,7 @@ const registerRuntimeCaching = (...runtimeCachingList)=>{
         self.__WB_FORCE_RUNTIME_CACHING = false;
     }
     if (!self.__WB_FORCE_RUNTIME_CACHING && process.env.NODE_ENV !== "production") {
-        logger.info("registerRuntimeCaching is disabled in development mode.");
+        logger.log("registerRuntimeCaching is disabled in development mode.");
         return;
     }
     for (const rcEntry of runtimeCachingList){
@@ -135,7 +135,7 @@ const installSerwist = ({ precacheEntries, precacheOptions, cleanupOutdatedCache
             self.__WB_FORCE_RUNTIME_CACHING = false;
         }
         if (!self.__WB_FORCE_RUNTIME_CACHING && process.env.NODE_ENV !== "production") {
-            logger.info("runtimeCaching and fallbacks are disabled in development mode.");
+            logger.log("runtimeCaching and fallbacks are disabled in development mode.");
         } else {
             if (fallbacks$1 !== undefined) {
                 runtimeCaching = fallbacks({

package/dist/registerRuntimeCaching.d.ts

@@ -1,3 +1,9 @@
 import type { RuntimeCaching } from "./types.js";
+/**
+ * Registers caching strategies to a singleton Router instance. It is a simple
+ * syntatic sugar for `@serwist/routing.registerRoute`.
+ * @param runtimeCachingList
+ * @returns
+ */
 export declare const registerRuntimeCaching: (...runtimeCachingList: RuntimeCaching[]) => void;
 //# sourceMappingURL=registerRuntimeCaching.d.ts.map

package/dist/registerRuntimeCaching.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"registerRuntimeCaching.d.ts","sourceRoot":"","sources":["../src/registerRuntimeCaching.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,cAAc,EAAgB,MAAM,YAAY,CAAC;AAY/D,eAAO,MAAM,sBAAsB,0BAA2B,cAAc,EAAE,SAsD7E,CAAC"}
+{"version":3,"file":"registerRuntimeCaching.d.ts","sourceRoot":"","sources":["../src/registerRuntimeCaching.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAAE,cAAc,EAAgB,MAAM,YAAY,CAAC;AAY/D;;;;;GAKG;AACH,eAAO,MAAM,sBAAsB,0BAA2B,cAAc,EAAE,SAsD7E,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/sw",
-  "version": "9.0.0-preview.1",
+  "version": "9.0.0-preview.2",
   "type": "module",
   "description": "This module makes it easy to get started with the Serwist service worker libraries.",
   "files": [
@@ -28,23 +28,23 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@serwist/background-sync": "9.0.0-preview.1",
-    "@serwist/broadcast-update": "9.0.0-preview.1",
-    "@serwist/cacheable-response": "9.0.0-preview.1",
-    "@serwist/core": "9.0.0-preview.1",
-    "@serwist/expiration": "9.0.0-preview.1",
-    "@serwist/google-analytics": "9.0.0-preview.1",
-    "@serwist/navigation-preload": "9.0.0-preview.1",
-    "@serwist/precaching": "9.0.0-preview.1",
-    "@serwist/range-requests": "9.0.0-preview.1",
-    "@serwist/routing": "9.0.0-preview.1",
-    "@serwist/strategies": "9.0.0-preview.1"
+    "@serwist/background-sync": "9.0.0-preview.2",
+    "@serwist/broadcast-update": "9.0.0-preview.2",
+    "@serwist/cacheable-response": "9.0.0-preview.2",
+    "@serwist/core": "9.0.0-preview.2",
+    "@serwist/expiration": "9.0.0-preview.2",
+    "@serwist/google-analytics": "9.0.0-preview.2",
+    "@serwist/navigation-preload": "9.0.0-preview.2",
+    "@serwist/precaching": "9.0.0-preview.2",
+    "@serwist/range-requests": "9.0.0-preview.2",
+    "@serwist/routing": "9.0.0-preview.2",
+    "@serwist/strategies": "9.0.0-preview.2"
   },
   "devDependencies": {
     "rollup": "4.9.6",
-    "typescript": "5.4.0-dev.20240203",
-    "@serwist/constants": "9.0.0-preview.1",
-    "@serwist/utils": "9.0.0-preview.1"
+    "typescript": "5.4.0-dev.20240206",
+    "@serwist/constants": "9.0.0-preview.2",
+    "@serwist/utils": "9.0.0-preview.2"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"

package/src/disableDevLogs.ts

@@ -2,6 +2,9 @@ declare const self: WorkerGlobalScope & {
   __WB_DISABLE_DEV_LOGS: boolean;
 };
 
+/**
+ * Disables Serwist's logging in development mode.
+ */
 export const disableDevLogs = () => {
   self.__WB_DISABLE_DEV_LOGS = true;
 };

package/src/fallbacks.ts

@@ -30,12 +30,29 @@ export interface FallbackEntry {
 }
 
 export interface FallbacksOptions {
+  /**
+   * Your previous `RuntimeCaching` array.
+   */
   runtimeCaching: RuntimeCaching[];
+  /**
+   * A list of fallback entries.
+   */
   entries: FallbackEntry[];
+  /**
+   * Precache options that will be used for your
+   * fallback entries.
+   */
   precacheOptions?: PrecacheRouteOptions;
 }
 
-export const fallbacks = ({ runtimeCaching, entries, precacheOptions }: FallbacksOptions) => {
+/**
+ * Precaches routes so that they can be used as a fallback when 
+ * a `RuntimeCaching` handler fails.
+ * @param options
+ * @returns The modified `RuntimeCaching` array. Using this value 
+ * is not needed, as it is simply the provided array.
+ */
+export const fallbacks = ({ runtimeCaching, entries, precacheOptions }: FallbacksOptions): RuntimeCaching[] => {
   precacheAndRoute(
     entries.map(({ url, revision }) => ({ url: typeof url === "string" ? url : url.toString(), revision })),
     precacheOptions,

package/src/handlePrecaching.ts

@@ -1,20 +1,48 @@
 import type { PrecacheEntry, PrecacheRouteOptions } from "@serwist/precaching";
-import { cleanupOutdatedCaches, createHandlerBoundToURL, precacheAndRoute } from "@serwist/precaching";
+import { cleanupOutdatedCaches as cleanupOutdatedCachesImpl, createHandlerBoundToURL, precacheAndRoute } from "@serwist/precaching";
 import { NavigationRoute, registerRoute } from "@serwist/routing";
 
 export type HandlePrecachingOptions = {
+  /**
+   * A list of fallback entries.
+   */
   precacheEntries?: (PrecacheEntry | string)[];
+  /**
+   * Precache options for the provided entries.
+   */
   precacheOptions?: PrecacheRouteOptions;
-
+  /**
+   * Whether outdated caches should be removed.
+   * 
+   * @default false
+   */
   cleanupOutdatedCaches?: boolean;
-} & ({ navigateFallback: string; navigateFallbackAllowlist?: RegExp[]; navigateFallbackDenylist?: RegExp[] } | { navigateFallback?: never });
+} & (
+  | {
+      /**
+       * An URL that should point to a HTML
+       * file with which navigation requests for URLs that aren't precached will be fulfilled.
+       * For more complex cases, consider `@serwist/sw.fallbacks`instead.
+       */
+      navigateFallback: string;
+      /**
+       * URLs that should be allowed to use the `navigateFallback` handler.
+       */
+      navigateFallbackAllowlist?: RegExp[];
+      /**
+       * URLs that should not be allowed to use the `navigateFallback` handler. This takes precedence
+       * over `navigateFallbackAllowlist`.
+       */
+      navigateFallbackDenylist?: RegExp[];
+    }
+  | { navigateFallback?: never }
+);
 
-export const handlePrecaching = ({
-  precacheEntries,
-  precacheOptions,
-  cleanupOutdatedCaches: shouldCleanupOutdatedCaches = false,
-  ...options
-}: HandlePrecachingOptions) => {
+/**
+ * Handles a list of precache entries and cleans up outdated caches.
+ * @param options
+ */
+export const handlePrecaching = ({ precacheEntries, precacheOptions, cleanupOutdatedCaches = false, ...options }: HandlePrecachingOptions) => {
   if (!!precacheEntries && precacheEntries.length > 0) {
     /**
      * The precacheAndRoute() method efficiently caches and responds to
@@ -24,7 +52,7 @@ export const handlePrecaching = ({
     precacheAndRoute(precacheEntries, precacheOptions);
   }
 
-  if (shouldCleanupOutdatedCaches) cleanupOutdatedCaches();
+  if (cleanupOutdatedCaches) cleanupOutdatedCachesImpl();
 
   if (options.navigateFallback) {
     registerRoute(

package/src/installSerwist.ts

@@ -82,7 +82,7 @@ export const installSerwist = ({
       self.__WB_FORCE_RUNTIME_CACHING = false;
     }
     if (!self.__WB_FORCE_RUNTIME_CACHING && process.env.NODE_ENV !== "production") {
-      logger.info("runtimeCaching and fallbacks are disabled in development mode.");
+      logger.log("runtimeCaching and fallbacks are disabled in development mode.");
     } else {
       if (fallbacks !== undefined) {
         runtimeCaching = fallbacksImpl({

package/src/registerRuntimeCaching.ts

@@ -21,13 +21,19 @@ const HANDLER_NAME_TO_METHOD = {
   StaleWhileRevalidate,
 } satisfies Record<StrategyName, unknown>;
 
+/**
+ * Registers caching strategies to a singleton Router instance. It is a simple
+ * syntatic sugar for `@serwist/routing.registerRoute`.
+ * @param runtimeCachingList
+ * @returns
+ */
 export const registerRuntimeCaching = (...runtimeCachingList: RuntimeCaching[]) => {
   if (!("__WB_FORCE_RUNTIME_CACHING" in globalThis)) {
     self.__WB_FORCE_RUNTIME_CACHING = false;
   }
 
   if (!self.__WB_FORCE_RUNTIME_CACHING && process.env.NODE_ENV !== "production") {
-    logger.info("registerRuntimeCaching is disabled in development mode.");
+    logger.log("registerRuntimeCaching is disabled in development mode.");
     return;
   }