@serwist/sw 9.0.0-preview.16 → 9.0.0-preview.17

package/dist/Serwist.d.ts

@@ -0,0 +1,93 @@
+import { type GoogleAnalyticsInitializeOptions } from "@serwist/google-analytics/initialize";
+import { PrecacheController } from "@serwist/precaching";
+import { Router } from "@serwist/routing";
+import type { FallbacksOptions } from "./fallbacks.js";
+import { type HandlePrecachingOptions } from "./handlePrecaching.js";
+import type { RuntimeCaching } from "./types.js";
+export interface SerwistOptions {
+    /**
+     * The precache controller that will be used to perform efficient
+     * precaching of assets.
+     * @default
+     * ```js
+     * new PrecacheController()
+     * ```
+     * @see https://serwist.pages.dev/docs/sw/precache-controller
+     */
+    precacheController?: PrecacheController;
+    /**
+     * The router that will be used to process a `FetchEvent`, responding
+     * with a `Response` if a matching route exists.
+     *
+     * @default
+     * ```js
+     * new Router()
+     * ```
+     * @see https://serwist.pages.dev/docs/sw/router
+     */
+    router?: Router;
+}
+export interface SerwistInstallOptions extends HandlePrecachingOptions {
+    /**
+     * Forces the waiting service worker to become the active one.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope/skipWaiting
+     */
+    skipWaiting?: boolean;
+    /**
+     * Imports external scripts. They are executed in the order they
+     * are passed.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope/importScripts
+     */
+    importScripts?: string[];
+    /**
+     * Enables navigation preloading if it is supported.
+     *
+     * @see https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/navigationPreload
+     */
+    navigationPreload?: boolean;
+    /**
+     * Modifies the prefix of the default cache names used by Serwist packages.
+     */
+    cacheId?: string | undefined;
+    /**
+     * Claims any currently available clients once the service worker
+     * becomes active. This is normally used in conjunction with `skipWaiting()`.
+     *
+     * @default false
+     */
+    clientsClaim?: boolean;
+    /**
+     * A list of caching strategies.
+     *
+     * @see https://serwist.pages.dev/docs/sw/runtime-caching
+     */
+    runtimeCaching?: RuntimeCaching[];
+    /**
+     * Your configuration for `@serwist/google-analytics`. This plugin is
+     * only initialized when this option is not `undefined` or `false`.
+     */
+    offlineAnalyticsConfig?: GoogleAnalyticsInitializeOptions | boolean;
+    /**
+     * Disables Serwist's logging in development mode.
+     *
+     * @default falseOmit<SerwistOptions, "precacheController">
+     */
+    disableDevLogs?: boolean;
+    /**
+     * Precaches routes so that they can be used as a fallback when
+     * a Strategy fails to generate a response.
+     * Note: This option mutates `runtimeCaching`!
+     *
+     * @see https://serwist.pages.dev/docs/sw/fallbacks
+     */
+    fallbacks?: Omit<FallbacksOptions, "runtimeCaching">;
+}
+export declare class Serwist {
+    private _precacheController;
+    private _router;
+    constructor({ precacheController, router }?: SerwistOptions);
+    install({ precacheEntries, precacheOptions, cleanupOutdatedCaches, navigateFallback, navigateFallbackAllowlist, navigateFallbackDenylist, skipWaiting, importScripts, navigationPreload, cacheId, clientsClaim, runtimeCaching, offlineAnalyticsConfig, disableDevLogs, fallbacks, }: SerwistInstallOptions): void;
+}
+//# sourceMappingURL=Serwist.d.ts.map

package/dist/Serwist.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Serwist.d.ts","sourceRoot":"","sources":["../src/Serwist.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,gCAAgC,EAAc,MAAM,sCAAsC,CAAC;AAEzG,OAAO,EAAE,kBAAkB,EAA8F,MAAM,qBAAqB,CAAC;AACrJ,OAAO,EAAmB,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAI3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,KAAK,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AACrE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAIjD,MAAM,WAAW,cAAc;IAC7B;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,qBAAsB,SAAQ,uBAAuB;IACpE;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,cAAc,EAAE,CAAC;IAClC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,gCAAgC,GAAG,OAAO,CAAC;IACpE;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;CACtD;AAED,qBAAa,OAAO;IAClB,OAAO,CAAC,mBAAmB,CAAqB;IAChD,OAAO,CAAC,OAAO,CAAS;gBACZ,EAAE,kBAA6C,EAAE,MAAqB,EAAE,GAAE,cAAmB;IAIzG,OAAO,CAAC,EACN,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAChB,yBAAyB,EACzB,wBAAwB,EACxB,WAAmB,EACnB,aAAa,EACb,iBAAyB,EACzB,OAAO,EACP,YAAoB,EACpB,cAAc,EACd,sBAAsB,EACtB,cAAsB,EACtB,SAAS,GACV,EAAE,qBAAqB;CA8DzB"}

package/dist/handlePrecaching.d.ts

@@ -1,5 +1,5 @@
 import type { PrecacheEntry, PrecacheRouteOptions } from "@serwist/precaching";
-export type HandlePrecachingOptions = {
+export interface HandlePrecachingOptions {
     /**
      * A list of fallback entries.
      */
@@ -14,12 +14,11 @@ export type HandlePrecachingOptions = {
      * @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.
      */
-    navigateFallback: string;
+    navigateFallback?: string;
     /**
      * URLs that should be allowed to use the `navigateFallback` handler.
      */
@@ -29,13 +28,11 @@ export type HandlePrecachingOptions = {
      * over `navigateFallbackAllowlist`.
      */
     navigateFallbackDenylist?: RegExp[];
-} | {
-    navigateFallback?: never;
-});
+}
 /**
  * Handles a list of precache entries and cleans up outdated caches.
  *
- * @see https://serwist.pages.dev/docs/sw/handlePrecaching
+ * @see https://serwist.pages.dev/docs/sw/handle-precaching
  * @param options
  */
 export declare const handlePrecaching: ({ precacheEntries, precacheOptions, cleanupOutdatedCaches, ...options }: HandlePrecachingOptions) => void;

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;;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;;;OAGG;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;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,4EAAqF,uBAAuB,KAAG,IAoB3I,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,WAAW,uBAAuB;IACtC;;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;IAChC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,yBAAyB,CAAC,EAAE,MAAM,EAAE,CAAC;IACrC;;;OAGG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;CACrC;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,4EAAqF,uBAAuB,KAAG,IAoB3I,CAAC"}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { Serwist, type SerwistOptions, type SerwistInstallOptions } from "./Serwist.js";
 import { disableDevLogs } from "./disableDevLogs.js";
 import type { FallbackEntry, FallbackMatcher, FallbacksOptions } from "./fallbacks.js";
 import { fallbacks } from "./fallbacks.js";
@@ -5,6 +6,6 @@ import { type HandlePrecachingOptions, handlePrecaching } from "./handlePrecachi
 import { type InstallSerwistOptions, installSerwist } from "./installSerwist.js";
 import { registerRuntimeCaching } from "./registerRuntimeCaching.js";
 import type { RuntimeCaching } from "./types.js";
-export { disableDevLogs, fallbacks, handlePrecaching, installSerwist, registerRuntimeCaching };
-export type { FallbackEntry, FallbackMatcher, FallbacksOptions, HandlePrecachingOptions, InstallSerwistOptions as SerwistOptions, RuntimeCaching };
+export { disableDevLogs, fallbacks, handlePrecaching, installSerwist, Serwist, registerRuntimeCaching };
+export type { FallbackEntry, FallbackMatcher, FallbacksOptions, HandlePrecachingOptions, InstallSerwistOptions, SerwistOptions, SerwistInstallOptions, RuntimeCaching, };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvF,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,KAAK,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACvF,OAAO,EAAE,KAAK,qBAAqB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,gBAAgB,EAAE,cAAc,EAAE,sBAAsB,EAAE,CAAC;AAC/F,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,EAAE,uBAAuB,EAAE,qBAAqB,IAAI,cAAc,EAAE,cAAc,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACxF,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvF,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,KAAK,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACvF,OAAO,EAAE,KAAK,qBAAqB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACjF,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,gBAAgB,EAAE,cAAc,EAAE,OAAO,EAAE,sBAAsB,EAAE,CAAC;AACxG,YAAY,EACV,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,uBAAuB,EACvB,qBAAqB,EACrB,cAAc,EACd,qBAAqB,EACrB,cAAc,GACf,CAAC"}

package/dist/index.js

@@ -1,9 +1,12 @@
-import { precacheAndRoute, PrecacheFallbackPlugin, cleanupOutdatedCaches, createHandlerBoundToURL } from '@serwist/precaching';
-import { Strategy } from '@serwist/strategies';
-import { registerRoute, NavigationRoute } from '@serwist/routing';
 import { setCacheNameDetails, clientsClaim } from '@serwist/core';
 import { initialize } from '@serwist/google-analytics/initialize';
 import { enable } from '@serwist/navigation-preload';
+import { precacheAndRoute, PrecacheFallbackPlugin, PrecacheController, PrecacheRoute, cleanupOutdatedCaches, createHandlerBoundToURL } from '@serwist/precaching';
+import { Router, NavigationRoute, registerRoute } from '@serwist/routing';
+import { parseRoute, getOrCreateDefaultRouter } from '@serwist/routing/internal';
+import { Strategy } from '@serwist/strategies';
+import { logger } from '@serwist/core/internal';
+import { getOrCreatePrecacheController } from '@serwist/precaching/internal';
 
 const disableDevLogs = ()=>{
     self.__WB_DISABLE_DEV_LOGS = true;
@@ -23,6 +26,64 @@ const fallbacks = ({ runtimeCaching, entries, precacheOptions })=>{
     return runtimeCaching;
 };
 
+class Serwist {
+    _precacheController;
+    _router;
+    constructor({ precacheController = new PrecacheController(), router = new Router() } = {}){
+        this._precacheController = precacheController;
+        this._router = router;
+    }
+    install({ precacheEntries, precacheOptions, cleanupOutdatedCaches: cleanupOutdatedCaches$1, navigateFallback, navigateFallbackAllowlist, navigateFallbackDenylist, skipWaiting = false, importScripts, navigationPreload = false, cacheId, clientsClaim: clientsClaim$1 = false, runtimeCaching, offlineAnalyticsConfig, disableDevLogs: disableDevLogs$1 = false, fallbacks: fallbacks$1 }) {
+        if (!!importScripts && importScripts.length > 0) self.importScripts(...importScripts);
+        if (navigationPreload) enable();
+        if (cacheId !== undefined) {
+            setCacheNameDetails({
+                prefix: cacheId
+            });
+        }
+        if (skipWaiting) {
+            self.skipWaiting();
+        } else {
+            self.addEventListener("message", (event)=>{
+                if (event.data && event.data.type === "SKIP_WAITING") {
+                    self.skipWaiting();
+                }
+            });
+        }
+        if (clientsClaim$1) clientsClaim();
+        if (!!precacheEntries && precacheEntries.length > 0) {
+            this._precacheController.precache(precacheEntries);
+            this._router.registerRoute(new PrecacheRoute(this._precacheController, precacheOptions));
+            if (cleanupOutdatedCaches$1) cleanupOutdatedCaches();
+            if (navigateFallback) {
+                this._router.registerRoute(new NavigationRoute(createHandlerBoundToURL(navigateFallback), {
+                    allowlist: navigateFallbackAllowlist,
+                    denylist: navigateFallbackDenylist
+                }));
+            }
+        }
+        if (offlineAnalyticsConfig !== undefined) {
+            if (typeof offlineAnalyticsConfig === "boolean") {
+                offlineAnalyticsConfig && initialize();
+            } else {
+                initialize(offlineAnalyticsConfig);
+            }
+        }
+        if (runtimeCaching !== undefined) {
+            if (fallbacks$1 !== undefined) {
+                fallbacks({
+                    ...fallbacks$1,
+                    runtimeCaching
+                });
+            }
+            for (const entry of runtimeCaching){
+                this._router.registerRoute(parseRoute(entry.matcher, entry.handler, entry.method));
+            }
+        }
+        if (disableDevLogs$1) disableDevLogs();
+    }
+}
+
 const handlePrecaching = ({ precacheEntries, precacheOptions, cleanupOutdatedCaches: cleanupOutdatedCaches$1 = false, ...options })=>{
     if (!!precacheEntries && precacheEntries.length > 0) {
         precacheAndRoute(precacheEntries, precacheOptions);
@@ -36,57 +97,21 @@ const handlePrecaching = ({ precacheEntries, precacheOptions, cleanupOutdatedCac
     }
 };
 
-const registerRuntimeCaching = (...runtimeCachingList)=>{
-    for (const entry of runtimeCachingList){
-        registerRoute(entry.matcher, entry.handler, entry.method);
+const installSerwist = (options)=>{
+    if (process.env.NODE_ENV !== "production") {
+        logger.warn("'installSerwist' has been deprecated. Please migrate to 'new Serwist().install()'.");
     }
+    const serwist = new Serwist({
+        precacheController: getOrCreatePrecacheController(),
+        router: getOrCreateDefaultRouter()
+    });
+    serwist.install(options);
 };
 
-const installSerwist = ({ precacheEntries, precacheOptions, cleanupOutdatedCaches, skipWaiting = false, importScripts, navigationPreload = false, cacheId, clientsClaim: clientsClaim$1 = false, runtimeCaching, offlineAnalyticsConfig, disableDevLogs: disableDevLogs$1 = false, fallbacks: fallbacks$1, ...options })=>{
-    if (!!importScripts && importScripts.length > 0) self.importScripts(...importScripts);
-    if (navigationPreload) enable();
-    if (cacheId !== undefined) {
-        setCacheNameDetails({
-            prefix: cacheId
-        });
-    }
-    if (skipWaiting) {
-        self.skipWaiting();
-    } else {
-        self.addEventListener("message", (event)=>{
-            if (event.data && event.data.type === "SKIP_WAITING") {
-                self.skipWaiting();
-            }
-        });
-    }
-    if (clientsClaim$1) clientsClaim();
-    handlePrecaching({
-        precacheEntries,
-        precacheOptions,
-        cleanupOutdatedCaches,
-        ...options.navigateFallback && {
-            navigateFallback: options.navigateFallback,
-            navigateFallbackAllowlist: options.navigateFallbackAllowlist,
-            navigateFallbackDenylist: options.navigateFallbackDenylist
-        }
-    });
-    if (offlineAnalyticsConfig !== undefined) {
-        if (typeof offlineAnalyticsConfig === "boolean") {
-            offlineAnalyticsConfig && initialize();
-        } else {
-            initialize(offlineAnalyticsConfig);
-        }
-    }
-    if (runtimeCaching !== undefined) {
-        if (fallbacks$1 !== undefined) {
-            fallbacks({
-                ...fallbacks$1,
-                runtimeCaching
-            });
-        }
-        registerRuntimeCaching(...runtimeCaching);
+const registerRuntimeCaching = (...runtimeCachingList)=>{
+    for (const entry of runtimeCachingList){
+        registerRoute(entry.matcher, entry.handler, entry.method);
     }
-    if (disableDevLogs$1) disableDevLogs();
 };
 
-export { disableDevLogs, fallbacks, handlePrecaching, installSerwist, registerRuntimeCaching };
+export { Serwist, disableDevLogs, fallbacks, handlePrecaching, installSerwist, registerRuntimeCaching };

package/dist/installSerwist.d.ts

@@ -1,68 +1,15 @@
-import { type GoogleAnalyticsInitializeOptions } from "@serwist/google-analytics/initialize";
-import type { FallbacksOptions } from "./fallbacks.js";
-import { type HandlePrecachingOptions } from "./handlePrecaching.js";
-import type { RuntimeCaching } from "./types.js";
-export type InstallSerwistOptions = HandlePrecachingOptions & {
-    /**
-     * Forces the waiting service worker to become the active one.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope/skipWaiting
-     */
-    skipWaiting?: boolean;
-    /**
-     * Imports external scripts. They are executed in the order they
-     * are passed.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope/importScripts
-     */
-    importScripts?: string[];
-    /**
-     * Enables navigation preloading if it is supported.
-     *
-     * @see https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/navigationPreload
-     */
-    navigationPreload?: boolean;
-    /**
-     * Modifies the prefix of the default cache names used by Serwist packages.
-     */
-    cacheId?: string | undefined;
-    /**
-     * Claims any currently available clients once the service worker
-     * becomes active. This is normally used in conjunction with `skipWaiting()`.
-     *
-     * @default false
-     */
-    clientsClaim?: boolean;
-    /**
-     * A list of caching strategies.
-     *
-     * @see https://serwist.pages.dev/docs/sw/register-runtime-caching
-     */
-    runtimeCaching?: RuntimeCaching[];
-    /**
-     * Your configuration for `@serwist/google-analytics`. This plugin is
-     * only initialized when this option is not `undefined` or `false`.
-     */
-    offlineAnalyticsConfig?: GoogleAnalyticsInitializeOptions | boolean;
-    /**
-     * Disables Serwist's logging in development mode.
-     *
-     * @default false
-     * @see https://serwist.pages.dev/docs/sw/disable-dev-logs
-     */
-    disableDevLogs?: boolean;
-    /**
-     * Precaches routes so that they can be used as a fallback when
-     * a Strategy fails to generate a response.
-     * Note: This option mutates `runtimeCaching`!
-     *
-     * @see https://serwist.pages.dev/docs/sw/fallbacks
-     */
-    fallbacks?: Omit<FallbacksOptions, "runtimeCaching">;
-};
+import { type SerwistInstallOptions } from "./Serwist.js";
+/**
+ * Options for `installSerwist`.
+ *
+ * @deprecated
+ */
+export type InstallSerwistOptions = SerwistInstallOptions;
 /**
  * Abstracts away the core APIs of Serwist.
+ *
  * @param options - `installSerwist` options.
+ * @deprecated
  */
-export declare const installSerwist: ({ precacheEntries, precacheOptions, cleanupOutdatedCaches, skipWaiting, importScripts, navigationPreload, cacheId, clientsClaim, runtimeCaching, offlineAnalyticsConfig, disableDevLogs, fallbacks, ...options }: InstallSerwistOptions) => void;
+export declare const installSerwist: (options: InstallSerwistOptions) => void;
 //# sourceMappingURL=installSerwist.d.ts.map

package/dist/installSerwist.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"installSerwist.d.ts","sourceRoot":"","sources":["../src/installSerwist.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,gCAAgC,EAAc,MAAM,sCAAsC,CAAC;AAKzG,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,KAAK,uBAAuB,EAAoB,MAAM,uBAAuB,CAAC;AAEvF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAIjD,MAAM,MAAM,qBAAqB,GAAG,uBAAuB,GAAG;IAC5D;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,cAAc,EAAE,CAAC;IAClC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,gCAAgC,GAAG,OAAO,CAAC;IACpE;;;;;OAKG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;CACtD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,cAAc,qNAexB,qBAAqB,KAAG,IAkD1B,CAAC"}
+{"version":3,"file":"installSerwist.d.ts","sourceRoot":"","sources":["../src/installSerwist.ts"],"names":[],"mappings":"AAGA,OAAO,EAAW,KAAK,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAEnE;;;;GAIG;AACH,MAAM,MAAM,qBAAqB,GAAG,qBAAqB,CAAC;AAE1D;;;;;GAKG;AACH,eAAO,MAAM,cAAc,YAAa,qBAAqB,KAAG,IAS/D,CAAC"}

package/dist/registerRuntimeCaching.d.ts

@@ -3,7 +3,7 @@ import type { RuntimeCaching } from "./types.js";
  * Registers caching strategies to a singleton Router instance. It is a simple
  * syntatic sugar for `@serwist/routing.registerRoute`.
  *
- * @see https://serwist.pages.dev/docs/sw/registerRuntimeCaching
+ * @see https://serwist.pages.dev/docs/sw/register-runtime-caching
  * @param runtimeCachingList
  * @returns
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/sw",
-  "version": "9.0.0-preview.16",
+  "version": "9.0.0-preview.17",
   "type": "module",
   "description": "A module that makes it easy to get started with the Serwist service worker libraries.",
   "files": [
@@ -46,23 +46,23 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@serwist/background-sync": "9.0.0-preview.16",
-    "@serwist/broadcast-update": "9.0.0-preview.16",
-    "@serwist/cacheable-response": "9.0.0-preview.16",
-    "@serwist/core": "9.0.0-preview.16",
-    "@serwist/expiration": "9.0.0-preview.16",
-    "@serwist/google-analytics": "9.0.0-preview.16",
-    "@serwist/navigation-preload": "9.0.0-preview.16",
-    "@serwist/precaching": "9.0.0-preview.16",
-    "@serwist/range-requests": "9.0.0-preview.16",
-    "@serwist/routing": "9.0.0-preview.16",
-    "@serwist/strategies": "9.0.0-preview.16"
+    "@serwist/background-sync": "9.0.0-preview.17",
+    "@serwist/broadcast-update": "9.0.0-preview.17",
+    "@serwist/cacheable-response": "9.0.0-preview.17",
+    "@serwist/core": "9.0.0-preview.17",
+    "@serwist/expiration": "9.0.0-preview.17",
+    "@serwist/google-analytics": "9.0.0-preview.17",
+    "@serwist/navigation-preload": "9.0.0-preview.17",
+    "@serwist/precaching": "9.0.0-preview.17",
+    "@serwist/range-requests": "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.16",
-    "@serwist/utils": "9.0.0-preview.16"
+    "@serwist/constants": "9.0.0-preview.17",
+    "@serwist/utils": "9.0.0-preview.17"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"

package/src/Serwist.ts

@@ -0,0 +1,182 @@
+import { clientsClaim as clientsClaimImpl, setCacheNameDetails } from "@serwist/core";
+import { type GoogleAnalyticsInitializeOptions, initialize } from "@serwist/google-analytics/initialize";
+import { enable } from "@serwist/navigation-preload";
+import { PrecacheController, PrecacheRoute, cleanupOutdatedCaches as cleanupOutdatedCachesImpl, createHandlerBoundToURL } from "@serwist/precaching";
+import { NavigationRoute, Router } from "@serwist/routing";
+import { parseRoute } from "@serwist/routing/internal";
+import { disableDevLogs as disableDevLogsImpl } from "./disableDevLogs.js";
+import { fallbacks as fallbacksImpl } from "./fallbacks.js";
+import type { FallbacksOptions } from "./fallbacks.js";
+import { type HandlePrecachingOptions } from "./handlePrecaching.js";
+import type { RuntimeCaching } from "./types.js";
+
+declare const self: ServiceWorkerGlobalScope;
+
+export interface SerwistOptions {
+  /**
+   * The precache controller that will be used to perform efficient
+   * precaching of assets.
+   * @default
+   * ```js
+   * new PrecacheController()
+   * ```
+   * @see https://serwist.pages.dev/docs/sw/precache-controller
+   */
+  precacheController?: PrecacheController;
+  /**
+   * The router that will be used to process a `FetchEvent`, responding
+   * with a `Response` if a matching route exists.
+   *
+   * @default
+   * ```js
+   * new Router()
+   * ```
+   * @see https://serwist.pages.dev/docs/sw/router
+   */
+  router?: Router;
+}
+
+export interface SerwistInstallOptions extends HandlePrecachingOptions {
+  /**
+   * Forces the waiting service worker to become the active one.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope/skipWaiting
+   */
+  skipWaiting?: boolean;
+  /**
+   * Imports external scripts. They are executed in the order they
+   * are passed.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope/importScripts
+   */
+  importScripts?: string[];
+  /**
+   * Enables navigation preloading if it is supported.
+   *
+   * @see https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/navigationPreload
+   */
+  navigationPreload?: boolean;
+  /**
+   * Modifies the prefix of the default cache names used by Serwist packages.
+   */
+  cacheId?: string | undefined;
+  /**
+   * Claims any currently available clients once the service worker
+   * becomes active. This is normally used in conjunction with `skipWaiting()`.
+   *
+   * @default false
+   */
+  clientsClaim?: boolean;
+  /**
+   * A list of caching strategies.
+   *
+   * @see https://serwist.pages.dev/docs/sw/runtime-caching
+   */
+  runtimeCaching?: RuntimeCaching[];
+  /**
+   * Your configuration for `@serwist/google-analytics`. This plugin is
+   * only initialized when this option is not `undefined` or `false`.
+   */
+  offlineAnalyticsConfig?: GoogleAnalyticsInitializeOptions | boolean;
+  /**
+   * Disables Serwist's logging in development mode.
+   *
+   * @default falseOmit<SerwistOptions, "precacheController">
+   */
+  disableDevLogs?: boolean;
+  /**
+   * Precaches routes so that they can be used as a fallback when
+   * a Strategy fails to generate a response.
+   * Note: This option mutates `runtimeCaching`!
+   *
+   * @see https://serwist.pages.dev/docs/sw/fallbacks
+   */
+  fallbacks?: Omit<FallbacksOptions, "runtimeCaching">;
+}
+
+export class Serwist {
+  private _precacheController: PrecacheController;
+  private _router: Router;
+  constructor({ precacheController = new PrecacheController(), router = new Router() }: SerwistOptions = {}) {
+    this._precacheController = precacheController;
+    this._router = router;
+  }
+  install({
+    precacheEntries,
+    precacheOptions,
+    cleanupOutdatedCaches,
+    navigateFallback,
+    navigateFallbackAllowlist,
+    navigateFallbackDenylist,
+    skipWaiting = false,
+    importScripts,
+    navigationPreload = false,
+    cacheId,
+    clientsClaim = false,
+    runtimeCaching,
+    offlineAnalyticsConfig,
+    disableDevLogs = false,
+    fallbacks,
+  }: SerwistInstallOptions) {
+    if (!!importScripts && importScripts.length > 0) self.importScripts(...importScripts);
+
+    if (navigationPreload) enable();
+
+    if (cacheId !== undefined) {
+      setCacheNameDetails({
+        prefix: cacheId,
+      });
+    }
+
+    if (skipWaiting) {
+      self.skipWaiting();
+    } else {
+      self.addEventListener("message", (event) => {
+        if (event.data && event.data.type === "SKIP_WAITING") {
+          self.skipWaiting();
+        }
+      });
+    }
+
+    if (clientsClaim) clientsClaimImpl();
+
+    if (!!precacheEntries && precacheEntries.length > 0) {
+      /**
+       * The precacheAndRoute() method efficiently caches and responds to
+       * requests for URLs in the manifest.
+       * See https://goo.gl/S9QRab
+       */
+      this._precacheController.precache(precacheEntries);
+      this._router.registerRoute(new PrecacheRoute(this._precacheController, precacheOptions));
+
+      if (cleanupOutdatedCaches) cleanupOutdatedCachesImpl();
+
+      if (navigateFallback) {
+        this._router.registerRoute(
+          new NavigationRoute(createHandlerBoundToURL(navigateFallback), {
+            allowlist: navigateFallbackAllowlist,
+            denylist: navigateFallbackDenylist,
+          }),
+        );
+      }
+    }
+
+    if (offlineAnalyticsConfig !== undefined) {
+      if (typeof offlineAnalyticsConfig === "boolean") {
+        offlineAnalyticsConfig && initialize();
+      } else {
+        initialize(offlineAnalyticsConfig);
+      }
+    }
+    if (runtimeCaching !== undefined) {
+      if (fallbacks !== undefined) {
+        fallbacksImpl({ ...fallbacks, runtimeCaching });
+      }
+      for (const entry of runtimeCaching) {
+        this._router.registerRoute(parseRoute(entry.matcher, entry.handler, entry.method));
+      }
+    }
+
+    if (disableDevLogs) disableDevLogsImpl();
+  }
+}

package/src/handlePrecaching.ts

@@ -2,7 +2,7 @@ import type { PrecacheEntry, PrecacheRouteOptions } from "@serwist/precaching";
 import { cleanupOutdatedCaches as cleanupOutdatedCachesImpl, createHandlerBoundToURL, precacheAndRoute } from "@serwist/precaching";
 import { NavigationRoute, registerRoute } from "@serwist/routing";
 
-export type HandlePrecachingOptions = {
+export interface HandlePrecachingOptions {
   /**
    * A list of fallback entries.
    */
@@ -17,30 +17,26 @@ export type HandlePrecachingOptions = {
    * @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.
-       */
-      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 }
-);
+  /**
+   * An URL that should point to a HTML file with which navigation requests for URLs that aren't
+   * precached will be fulfilled.
+   */
+  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[];
+}
 
 /**
  * Handles a list of precache entries and cleans up outdated caches.
  *
- * @see https://serwist.pages.dev/docs/sw/handlePrecaching
+ * @see https://serwist.pages.dev/docs/sw/handle-precaching
  * @param options
  */
 export const handlePrecaching = ({ precacheEntries, precacheOptions, cleanupOutdatedCaches = false, ...options }: HandlePrecachingOptions): void => {

package/src/index.ts

@@ -1,3 +1,4 @@
+import { Serwist, type SerwistOptions, type SerwistInstallOptions } from "./Serwist.js";
 import { disableDevLogs } from "./disableDevLogs.js";
 import type { FallbackEntry, FallbackMatcher, FallbacksOptions } from "./fallbacks.js";
 import { fallbacks } from "./fallbacks.js";
@@ -6,5 +7,14 @@ import { type InstallSerwistOptions, installSerwist } from "./installSerwist.js"
 import { registerRuntimeCaching } from "./registerRuntimeCaching.js";
 import type { RuntimeCaching } from "./types.js";
 
-export { disableDevLogs, fallbacks, handlePrecaching, installSerwist, registerRuntimeCaching };
-export type { FallbackEntry, FallbackMatcher, FallbacksOptions, HandlePrecachingOptions, InstallSerwistOptions as SerwistOptions, RuntimeCaching };
+export { disableDevLogs, fallbacks, handlePrecaching, installSerwist, Serwist, registerRuntimeCaching };
+export type {
+  FallbackEntry,
+  FallbackMatcher,
+  FallbacksOptions,
+  HandlePrecachingOptions,
+  InstallSerwistOptions,
+  SerwistOptions,
+  SerwistInstallOptions,
+  RuntimeCaching,
+};

package/src/installSerwist.ts

@@ -1,142 +1,28 @@
-import { clientsClaim as clientsClaimImpl, setCacheNameDetails } from "@serwist/core";
-import { type GoogleAnalyticsInitializeOptions, initialize } from "@serwist/google-analytics/initialize";
-import { enable } from "@serwist/navigation-preload";
+import { logger } from "@serwist/core/internal";
+import { getOrCreatePrecacheController } from "@serwist/precaching/internal";
+import { getOrCreateDefaultRouter } from "@serwist/routing/internal";
+import { Serwist, type SerwistInstallOptions } from "./Serwist.js";
 
-import { disableDevLogs as disableDevLogsImpl } from "./disableDevLogs.js";
-import { fallbacks as fallbacksImpl } from "./fallbacks.js";
-import type { FallbacksOptions } from "./fallbacks.js";
-import { type HandlePrecachingOptions, handlePrecaching } from "./handlePrecaching.js";
-import { registerRuntimeCaching } from "./registerRuntimeCaching.js";
-import type { RuntimeCaching } from "./types.js";
-
-declare const self: ServiceWorkerGlobalScope;
-
-export type InstallSerwistOptions = HandlePrecachingOptions & {
-  /**
-   * Forces the waiting service worker to become the active one.
-   *
-   * @see https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope/skipWaiting
-   */
-  skipWaiting?: boolean;
-  /**
-   * Imports external scripts. They are executed in the order they
-   * are passed.
-   *
-   * @see https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope/importScripts
-   */
-  importScripts?: string[];
-  /**
-   * Enables navigation preloading if it is supported.
-   *
-   * @see https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/navigationPreload
-   */
-  navigationPreload?: boolean;
-  /**
-   * Modifies the prefix of the default cache names used by Serwist packages.
-   */
-  cacheId?: string | undefined;
-  /**
-   * Claims any currently available clients once the service worker
-   * becomes active. This is normally used in conjunction with `skipWaiting()`.
-   *
-   * @default false
-   */
-  clientsClaim?: boolean;
-  /**
-   * A list of caching strategies.
-   *
-   * @see https://serwist.pages.dev/docs/sw/register-runtime-caching
-   */
-  runtimeCaching?: RuntimeCaching[];
-  /**
-   * Your configuration for `@serwist/google-analytics`. This plugin is
-   * only initialized when this option is not `undefined` or `false`.
-   */
-  offlineAnalyticsConfig?: GoogleAnalyticsInitializeOptions | boolean;
-  /**
-   * Disables Serwist's logging in development mode.
-   *
-   * @default false
-   * @see https://serwist.pages.dev/docs/sw/disable-dev-logs
-   */
-  disableDevLogs?: boolean;
-  /**
-   * Precaches routes so that they can be used as a fallback when
-   * a Strategy fails to generate a response.
-   * Note: This option mutates `runtimeCaching`!
-   *
-   * @see https://serwist.pages.dev/docs/sw/fallbacks
-   */
-  fallbacks?: Omit<FallbacksOptions, "runtimeCaching">;
-};
+/**
+ * Options for `installSerwist`.
+ *
+ * @deprecated
+ */
+export type InstallSerwistOptions = SerwistInstallOptions;
 
 /**
  * Abstracts away the core APIs of Serwist.
+ *
  * @param options - `installSerwist` options.
+ * @deprecated
  */
-export const installSerwist = ({
-  precacheEntries,
-  precacheOptions,
-  cleanupOutdatedCaches,
-
-  skipWaiting = false,
-  importScripts,
-  navigationPreload = false,
-  cacheId,
-  clientsClaim = false,
-  runtimeCaching,
-  offlineAnalyticsConfig,
-  disableDevLogs = false,
-  fallbacks,
-  ...options
-}: InstallSerwistOptions): void => {
-  if (!!importScripts && importScripts.length > 0) self.importScripts(...importScripts);
-
-  if (navigationPreload) enable();
-
-  if (cacheId !== undefined) {
-    setCacheNameDetails({
-      prefix: cacheId,
-    });
+export const installSerwist = (options: InstallSerwistOptions): void => {
+  if (process.env.NODE_ENV !== "production") {
+    logger.warn("'installSerwist' has been deprecated. Please migrate to 'new Serwist().install()'.");
   }
-
-  if (skipWaiting) {
-    self.skipWaiting();
-  } else {
-    self.addEventListener("message", (event) => {
-      if (event.data && event.data.type === "SKIP_WAITING") {
-        self.skipWaiting();
-      }
-    });
-  }
-
-  if (clientsClaim) clientsClaimImpl();
-
-  handlePrecaching({
-    precacheEntries,
-    precacheOptions,
-    cleanupOutdatedCaches,
-    ...(options.navigateFallback && {
-      navigateFallback: options.navigateFallback,
-      navigateFallbackAllowlist: options.navigateFallbackAllowlist,
-      navigateFallbackDenylist: options.navigateFallbackDenylist,
-    }),
+  const serwist = new Serwist({
+    precacheController: getOrCreatePrecacheController(),
+    router: getOrCreateDefaultRouter(),
   });
-
-  if (offlineAnalyticsConfig !== undefined) {
-    if (typeof offlineAnalyticsConfig === "boolean") {
-      offlineAnalyticsConfig && initialize();
-    } else {
-      initialize(offlineAnalyticsConfig);
-    }
-  }
-
-  if (runtimeCaching !== undefined) {
-    if (fallbacks !== undefined) {
-      fallbacksImpl({ ...fallbacks, runtimeCaching });
-    }
-    registerRuntimeCaching(...runtimeCaching);
-  }
-
-  if (disableDevLogs) disableDevLogsImpl();
+  serwist.install(options);
 };

package/src/registerRuntimeCaching.ts

@@ -6,7 +6,7 @@ import type { RuntimeCaching } from "./types.js";
  * Registers caching strategies to a singleton Router instance. It is a simple
  * syntatic sugar for `@serwist/routing.registerRoute`.
  *
- * @see https://serwist.pages.dev/docs/sw/registerRuntimeCaching
+ * @see https://serwist.pages.dev/docs/sw/register-runtime-caching
  * @param runtimeCachingList
  * @returns
  */