@serwist/recipes 9.0.0-preview.2 → 9.0.0-preview.21

package/dist/googleFontsCache.d.ts

@@ -1,4 +1,10 @@
+import { type Router } from "@serwist/sw/routing";
 export interface GoogleFontCacheOptions {
+    /**
+     * An optional `Router` instance. If not provided, the singleton `Router`
+     * will be used.
+     */
+    router?: Router;
     /**
      * Cache prefix for caching stylesheets and webfonts. Defaults to google-fonts.
      */
@@ -17,6 +23,5 @@ export interface GoogleFontCacheOptions {
  *
  * @param options
  */
-declare function googleFontsCache(options?: GoogleFontCacheOptions): void;
-export { googleFontsCache };
+export declare const googleFontsCache: ({ router, cachePrefix, maxAgeSeconds, maxEntries, }?: GoogleFontCacheOptions) => void;
 //# sourceMappingURL=googleFontsCache.d.ts.map

package/dist/googleFontsCache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"googleFontsCache.d.ts","sourceRoot":"","sources":["../src/googleFontsCache.ts"],"names":[],"mappings":"AAaA,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,iBAAS,gBAAgB,CAAC,OAAO,GAAE,sBAA2B,GAAG,IAAI,CA8BpE;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"googleFontsCache.d.ts","sourceRoot":"","sources":["../src/googleFontsCache.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,MAAM,EAAsB,MAAM,qBAAqB,CAAC;AAGtE,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,yDAK1B,sBAAsB,KAAQ,IAyBhC,CAAC"}

package/dist/imageCache.d.ts

@@ -1,5 +1,11 @@
 import type { RouteMatchCallback, SerwistPlugin } from "@serwist/core";
+import { type Router } from "@serwist/sw/routing";
 export interface ImageCacheOptions {
+    /**
+     * An optional `Router` instance. If not provided, the singleton `Router`
+     * will be used.
+     */
+    router?: Router;
     /**
      * Name for cache. Defaults to images.
      */
@@ -30,6 +36,5 @@ export interface ImageCacheOptions {
  *
  * @param options
  */
-declare function imageCache(options?: ImageCacheOptions): void;
-export { imageCache };
+export declare const imageCache: ({ router, cacheName, matchCallback, maxAgeSeconds, maxEntries, plugins, warmCache, }?: ImageCacheOptions) => void;
 //# sourceMappingURL=imageCache.d.ts.map

package/dist/imageCache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"imageCache.d.ts","sourceRoot":"","sources":["../src/imageCache.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,kBAAkB,EAA6B,aAAa,EAAE,MAAM,eAAe,CAAC;AAOlG,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;GAIG;AACH,iBAAS,UAAU,CAAC,OAAO,GAAE,iBAAsB,GAAG,IAAI,CA+BzD;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"imageCache.d.ts","sourceRoot":"","sources":["../src/imageCache.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,kBAAkB,EAA6B,aAAa,EAAE,MAAM,eAAe,CAAC;AAElG,OAAO,EAAE,KAAK,MAAM,EAAsB,MAAM,qBAAqB,CAAC;AAItE,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;GAIG;AACH,eAAO,MAAM,UAAU,0FAQpB,iBAAiB,KAAQ,IAwB3B,CAAC"}

package/dist/index.js

@@ -1,19 +1,14 @@
-import { CacheableResponsePlugin } from '@serwist/cacheable-response';
-import { ExpirationPlugin } from '@serwist/expiration';
-import { registerRoute, setCatchHandler } from '@serwist/routing';
-import { StaleWhileRevalidate, CacheFirst, NetworkFirst } from '@serwist/strategies';
-import { matchPrecache } from '@serwist/precaching';
+import { CacheableResponsePlugin, ExpirationPlugin } from '@serwist/sw/plugins';
+import { getSingletonRouter, setCatchHandler } from '@serwist/sw/routing';
+import { StaleWhileRevalidate, CacheFirst, NetworkFirst } from '@serwist/sw/strategies';
+import { getSingletonPrecacheController } from '@serwist/sw/precaching';
 
-function googleFontsCache(options = {}) {
-    const sheetCacheName = `${options.cachePrefix || "google-fonts"}-stylesheets`;
-    const fontCacheName = `${options.cachePrefix || "google-fonts"}-webfonts`;
-    const maxAgeSeconds = options.maxAgeSeconds || 60 * 60 * 24 * 365;
-    const maxEntries = options.maxEntries || 30;
-    registerRoute(({ url })=>url.origin === "https://fonts.googleapis.com", new StaleWhileRevalidate({
-        cacheName: sheetCacheName
+const googleFontsCache = ({ router = getSingletonRouter(), cachePrefix = "google-fonts", maxAgeSeconds = 60 * 60 * 24 * 365, maxEntries = 30 } = {})=>{
+    router.registerCapture(({ url })=>url.origin === "https://fonts.googleapis.com", new StaleWhileRevalidate({
+        cacheName: `${cachePrefix}-stylesheets`
     }));
-    registerRoute(({ url })=>url.origin === "https://fonts.gstatic.com", new CacheFirst({
-        cacheName: fontCacheName,
+    router.registerCapture(({ url })=>url.origin === "https://fonts.gstatic.com", new CacheFirst({
+        cacheName: `${cachePrefix}-webfonts`,
         plugins: [
             new CacheableResponsePlugin({
                 statuses: [
@@ -27,9 +22,9 @@ function googleFontsCache(options = {}) {
             })
         ]
     }));
-}
+};
 
-function warmStrategyCache(options) {
+const warmStrategyCache = (options)=>{
     self.addEventListener("install", (event)=>{
         const done = options.urls.map((path)=>options.strategy.handleAll({
                 event,
@@ -37,15 +32,9 @@ function warmStrategyCache(options) {
             })[1]);
         event.waitUntil(Promise.all(done));
     });
-}
+};
 
-function imageCache(options = {}) {
-    const defaultMatchCallback = ({ request })=>request.destination === "image";
-    const cacheName = options.cacheName || "images";
-    const matchCallback = options.matchCallback || defaultMatchCallback;
-    const maxAgeSeconds = options.maxAgeSeconds || 30 * 24 * 60 * 60;
-    const maxEntries = options.maxEntries || 60;
-    const plugins = options.plugins || [];
+const imageCache = ({ router = getSingletonRouter(), cacheName = "images", matchCallback = ({ request })=>request.destination === "image", maxAgeSeconds = 30 * 24 * 60 * 60, maxEntries = 60, plugins = [], warmCache } = {})=>{
     plugins.push(new CacheableResponsePlugin({
         statuses: [
             0,
@@ -60,19 +49,16 @@ function imageCache(options = {}) {
         cacheName,
         plugins
     });
-    registerRoute(matchCallback, strategy);
-    if (options.warmCache) {
+    router.registerCapture(matchCallback, strategy);
+    if (warmCache) {
         warmStrategyCache({
-            urls: options.warmCache,
+            urls: warmCache,
             strategy
         });
     }
-}
+};
 
-function offlineFallback(options = {}) {
-    const pageFallback = options.pageFallback || "offline.html";
-    const imageFallback = options.imageFallback || false;
-    const fontFallback = options.fontFallback || false;
+const offlineFallback = ({ precacheController = getSingletonPrecacheController(), pageFallback = "offline.html", imageFallback, fontFallback } = {})=>{
     self.addEventListener("install", (event)=>{
         const files = [
             pageFallback
@@ -89,28 +75,23 @@ function offlineFallback(options = {}) {
         const dest = options.request.destination;
         const cache = await self.caches.open("serwist-offline-fallbacks");
         if (dest === "document") {
-            const match = await matchPrecache(pageFallback) || await cache.match(pageFallback);
+            const match = await precacheController.matchPrecache(pageFallback) || await cache.match(pageFallback);
             return match || Response.error();
         }
-        if (dest === "image" && imageFallback !== false) {
-            const match = await matchPrecache(imageFallback) || await cache.match(imageFallback);
+        if (dest === "image" && imageFallback !== undefined) {
+            const match = await precacheController.matchPrecache(imageFallback) || await cache.match(imageFallback);
             return match || Response.error();
         }
-        if (dest === "font" && fontFallback !== false) {
-            const match = await matchPrecache(fontFallback) || await cache.match(fontFallback);
+        if (dest === "font" && fontFallback !== undefined) {
+            const match = await precacheController.matchPrecache(fontFallback) || await cache.match(fontFallback);
             return match || Response.error();
         }
         return Response.error();
     };
     setCatchHandler(handler);
-}
+};
 
-function pageCache(options = {}) {
-    const defaultMatchCallback = ({ request })=>request.mode === "navigate";
-    const cacheName = options.cacheName || "pages";
-    const matchCallback = options.matchCallback || defaultMatchCallback;
-    const networkTimeoutSeconds = options.networkTimeoutSeconds || 3;
-    const plugins = options.plugins || [];
+const pageCache = ({ router = getSingletonRouter(), cacheName = "pages", matchCallback = ({ request })=>request.mode === "navigate", networkTimeoutSeconds = 3, plugins = [], warmCache } = {})=>{
     plugins.push(new CacheableResponsePlugin({
         statuses: [
             0,
@@ -122,20 +103,16 @@ function pageCache(options = {}) {
         cacheName,
         plugins
     });
-    registerRoute(matchCallback, strategy);
-    if (options.warmCache) {
+    router.registerCapture(matchCallback, strategy);
+    if (warmCache) {
         warmStrategyCache({
-            urls: options.warmCache,
+            urls: warmCache,
             strategy
         });
     }
-}
+};
 
-function staticResourceCache(options = {}) {
-    const defaultMatchCallback = ({ request })=>request.destination === "style" || request.destination === "script" || request.destination === "worker";
-    const cacheName = options.cacheName || "static-resources";
-    const matchCallback = options.matchCallback || defaultMatchCallback;
-    const plugins = options.plugins || [];
+const staticResourceCache = ({ router = getSingletonRouter(), cacheName = "static-resources", matchCallback = ({ request })=>request.destination === "style" || request.destination === "script" || request.destination === "worker", plugins = [], warmCache } = {})=>{
     plugins.push(new CacheableResponsePlugin({
         statuses: [
             0,
@@ -146,13 +123,13 @@ function staticResourceCache(options = {}) {
         cacheName,
         plugins
     });
-    registerRoute(matchCallback, strategy);
-    if (options.warmCache) {
+    router.registerCapture(matchCallback, strategy);
+    if (warmCache) {
         warmStrategyCache({
-            urls: options.warmCache,
+            urls: warmCache,
             strategy
         });
     }
-}
+};
 
 export { googleFontsCache, imageCache, offlineFallback, pageCache, staticResourceCache, warmStrategyCache };

package/dist/offlineFallback.d.ts

@@ -1,4 +1,10 @@
+import { type PrecacheController } from "@serwist/sw/precaching";
 export interface OfflineFallbackOptions {
+    /**
+     * An optional `PrecacheController` instance. If not provided, the singleton
+     * `PrecacheController` will be used.
+     */
+    precacheController?: PrecacheController;
     /**
      * Precache name to match for page fallbacks. Defaults to offline.html.
      */
@@ -18,6 +24,5 @@ export interface OfflineFallbackOptions {
 
  * @param options
  */
-declare function offlineFallback(options?: OfflineFallbackOptions): void;
-export { offlineFallback };
+export declare const offlineFallback: ({ precacheController, pageFallback, imageFallback, fontFallback, }?: OfflineFallbackOptions) => void;
 //# sourceMappingURL=offlineFallback.d.ts.map

package/dist/offlineFallback.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"offlineFallback.d.ts","sourceRoot":"","sources":["../src/offlineFallback.ts"],"names":[],"mappings":"AAYA,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAKD;;;;;GAKG;AACH,iBAAS,eAAe,CAAC,OAAO,GAAE,sBAA2B,GAAG,IAAI,CAwCnE;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}
+{"version":3,"file":"offlineFallback.d.ts","sourceRoot":"","sources":["../src/offlineFallback.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,kBAAkB,EAAkC,MAAM,wBAAwB,CAAC;AAGjG,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAKD;;;;;GAKG;AACH,eAAO,MAAM,eAAe,wEAKzB,sBAAsB,KAAQ,IAoChC,CAAC"}

package/dist/pageCache.d.ts

@@ -1,5 +1,11 @@
 import type { RouteMatchCallback, SerwistPlugin } from "@serwist/core";
+import { type Router } from "@serwist/sw/routing";
 export interface PageCacheOptions {
+    /**
+     * An optional `Router` instance. If not provided, the singleton `Router`
+     * will be used.
+     */
+    router?: Router;
     /**
      * Name for cache. Defaults to pages.
      */
@@ -28,6 +34,5 @@ export interface PageCacheOptions {
  *
  * @param options
  */
-declare function pageCache(options?: PageCacheOptions): void;
-export { pageCache };
+export declare const pageCache: ({ router, cacheName, matchCallback, networkTimeoutSeconds, plugins, warmCache, }?: PageCacheOptions) => void;
 //# sourceMappingURL=pageCache.d.ts.map

package/dist/pageCache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"pageCache.d.ts","sourceRoot":"","sources":["../src/pageCache.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,kBAAkB,EAA6B,aAAa,EAAE,MAAM,eAAe,CAAC;AAMlG,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;GAIG;AACH,iBAAS,SAAS,CAAC,OAAO,GAAE,gBAAqB,GAAG,IAAI,CA0BvD;AAED,OAAO,EAAE,SAAS,EAAE,CAAC"}
+{"version":3,"file":"pageCache.d.ts","sourceRoot":"","sources":["../src/pageCache.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,kBAAkB,EAA6B,aAAa,EAAE,MAAM,eAAe,CAAC;AAElG,OAAO,EAAE,KAAK,MAAM,EAAsB,MAAM,qBAAqB,CAAC;AAItE,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;GAIG;AACH,eAAO,MAAM,SAAS,sFAOnB,gBAAgB,KAAQ,IAoB1B,CAAC"}

package/dist/staticResourceCache.d.ts

@@ -1,5 +1,11 @@
 import type { RouteMatchCallback, SerwistPlugin } from "@serwist/core";
+import { type Router } from "@serwist/sw/routing";
 export interface StaticResourceOptions {
+    /**
+     * An optional `Router` instance. If not provided, the singleton `Router`
+     * will be used.
+     */
+    router?: Router;
     /**
      * Name for cache.
      *
@@ -26,6 +32,5 @@ export interface StaticResourceOptions {
  *
  * @param options
  */
-declare function staticResourceCache(options?: StaticResourceOptions): void;
-export { staticResourceCache };
+export declare const staticResourceCache: ({ router, cacheName, matchCallback, plugins, warmCache, }?: StaticResourceOptions) => void;
 //# sourceMappingURL=staticResourceCache.d.ts.map

package/dist/staticResourceCache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"staticResourceCache.d.ts","sourceRoot":"","sources":["../src/staticResourceCache.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,kBAAkB,EAA6B,aAAa,EAAE,MAAM,eAAe,CAAC;AAMlG,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;GAIG;AACH,iBAAS,mBAAmB,CAAC,OAAO,GAAE,qBAA0B,GAAG,IAAI,CAwBtE;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}
+{"version":3,"file":"staticResourceCache.d.ts","sourceRoot":"","sources":["../src/staticResourceCache.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,kBAAkB,EAA6B,aAAa,EAAE,MAAM,eAAe,CAAC;AAElG,OAAO,EAAE,KAAK,MAAM,EAAsB,MAAM,qBAAqB,CAAC;AAItE,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;IAC1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,+DAO7B,qBAAqB,KAAQ,IAkB/B,CAAC"}

package/dist/warmStrategyCache.d.ts

@@ -1,4 +1,4 @@
-import type { Strategy } from "@serwist/strategies";
+import type { Strategy } from "@serwist/sw/strategies";
 export interface WarmStrategyCacheOptions {
     /**
      * Paths to warm the strategy's cache with.
@@ -12,6 +12,5 @@ export interface WarmStrategyCacheOptions {
 /**
  * @param options
  */
-declare function warmStrategyCache(options: WarmStrategyCacheOptions): void;
-export { warmStrategyCache };
+export declare const warmStrategyCache: (options: WarmStrategyCacheOptions) => void;
 //# sourceMappingURL=warmStrategyCache.d.ts.map

package/dist/warmStrategyCache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"warmStrategyCache.d.ts","sourceRoot":"","sources":["../src/warmStrategyCache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEpD,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAKD;;GAEG;AACH,iBAAS,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,IAAI,CAYlE;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"warmStrategyCache.d.ts","sourceRoot":"","sources":["../src/warmStrategyCache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAEvD,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;IACf;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;CACpB;AAKD;;GAEG;AACH,eAAO,MAAM,iBAAiB,YAAa,wBAAwB,KAAG,IAYrE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/recipes",
-  "version": "9.0.0-preview.2",
+  "version": "9.0.0-preview.21",
   "type": "module",
   "description": "A service worker helper library to manage common request and caching patterns",
   "files": [
@@ -17,8 +17,8 @@
   ],
   "author": "Google's Web DevRel Team, Serwist's Team",
   "license": "MIT",
-  "repository": "serwist/serwist",
-  "bugs": "https://github.com/serwist/serwist/issues",
+  "repository": "https://gitlab.com/serwist/serwist",
+  "bugs": "https://gitlab.com/serwist/serwist/issues",
   "homepage": "https://serwist.pages.dev",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -30,17 +30,13 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@serwist/cacheable-response": "9.0.0-preview.2",
-    "@serwist/core": "9.0.0-preview.2",
-    "@serwist/expiration": "9.0.0-preview.2",
-    "@serwist/precaching": "9.0.0-preview.2",
-    "@serwist/routing": "9.0.0-preview.2",
-    "@serwist/strategies": "9.0.0-preview.2"
+    "@serwist/core": "9.0.0-preview.21",
+    "@serwist/sw": "9.0.0-preview.21"
   },
   "devDependencies": {
-    "rollup": "4.9.6",
-    "typescript": "5.4.0-dev.20240206",
-    "@serwist/constants": "9.0.0-preview.2"
+    "rollup": "4.13.0",
+    "typescript": "5.5.0-dev.20240323",
+    "@serwist/constants": "9.0.0-preview.21"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"

package/src/googleFontsCache.ts

@@ -6,12 +6,16 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { CacheableResponsePlugin } from "@serwist/cacheable-response";
-import { ExpirationPlugin } from "@serwist/expiration";
-import { registerRoute } from "@serwist/routing";
-import { CacheFirst, StaleWhileRevalidate } from "@serwist/strategies";
+import { CacheableResponsePlugin, ExpirationPlugin } from "@serwist/sw/plugins";
+import { type Router, getSingletonRouter } from "@serwist/sw/routing";
+import { CacheFirst, StaleWhileRevalidate } from "@serwist/sw/strategies";
 
 export interface GoogleFontCacheOptions {
+  /**
+   * An optional `Router` instance. If not provided, the singleton `Router`
+   * will be used.
+   */
+  router?: Router;
   /**
    * Cache prefix for caching stylesheets and webfonts. Defaults to google-fonts.
    */
@@ -31,25 +35,25 @@ export interface GoogleFontCacheOptions {
  *
  * @param options
  */
-function googleFontsCache(options: GoogleFontCacheOptions = {}): void {
-  const sheetCacheName = `${options.cachePrefix || "google-fonts"}-stylesheets`;
-  const fontCacheName = `${options.cachePrefix || "google-fonts"}-webfonts`;
-  const maxAgeSeconds = options.maxAgeSeconds || 60 * 60 * 24 * 365;
-  const maxEntries = options.maxEntries || 30;
-
+export const googleFontsCache = ({
+  router = getSingletonRouter(),
+  cachePrefix = "google-fonts",
+  maxAgeSeconds = 60 * 60 * 24 * 365,
+  maxEntries = 30,
+}: GoogleFontCacheOptions = {}): void => {
   // Cache the Google Fonts stylesheets with a stale-while-revalidate strategy.
-  registerRoute(
+  router.registerCapture(
     ({ url }) => url.origin === "https://fonts.googleapis.com",
     new StaleWhileRevalidate({
-      cacheName: sheetCacheName,
+      cacheName: `${cachePrefix}-stylesheets`,
     }),
   );
 
   // Cache the underlying font files with a cache-first strategy for 1 year.
-  registerRoute(
+  router.registerCapture(
     ({ url }) => url.origin === "https://fonts.gstatic.com",
     new CacheFirst({
-      cacheName: fontCacheName,
+      cacheName: `${cachePrefix}-webfonts`,
       plugins: [
         new CacheableResponsePlugin({
           statuses: [0, 200],
@@ -61,6 +65,4 @@ function googleFontsCache(options: GoogleFontCacheOptions = {}): void {
       ],
     }),
   );
-}
-
-export { googleFontsCache };
+};

package/src/imageCache.ts

@@ -6,15 +6,18 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { CacheableResponsePlugin } from "@serwist/cacheable-response";
 import type { RouteMatchCallback, RouteMatchCallbackOptions, SerwistPlugin } from "@serwist/core";
-import { ExpirationPlugin } from "@serwist/expiration";
-import { registerRoute } from "@serwist/routing";
-import { CacheFirst } from "@serwist/strategies";
-
+import { CacheableResponsePlugin, ExpirationPlugin } from "@serwist/sw/plugins";
+import { type Router, getSingletonRouter } from "@serwist/sw/routing";
+import { CacheFirst } from "@serwist/sw/strategies";
 import { warmStrategyCache } from "./warmStrategyCache.js";
 
 export interface ImageCacheOptions {
+  /**
+   * An optional `Router` instance. If not provided, the singleton `Router`
+   * will be used.
+   */
+  router?: Router;
   /**
    * Name for cache. Defaults to images.
    */
@@ -46,14 +49,15 @@ export interface ImageCacheOptions {
  *
  * @param options
  */
-function imageCache(options: ImageCacheOptions = {}): void {
-  const defaultMatchCallback = ({ request }: RouteMatchCallbackOptions) => request.destination === "image";
-
-  const cacheName = options.cacheName || "images";
-  const matchCallback = options.matchCallback || defaultMatchCallback;
-  const maxAgeSeconds = options.maxAgeSeconds || 30 * 24 * 60 * 60;
-  const maxEntries = options.maxEntries || 60;
-  const plugins = options.plugins || [];
+export const imageCache = ({
+  router = getSingletonRouter(),
+  cacheName = "images",
+  matchCallback = ({ request }: RouteMatchCallbackOptions) => request.destination === "image",
+  maxAgeSeconds = 30 * 24 * 60 * 60,
+  maxEntries = 60,
+  plugins = [],
+  warmCache,
+}: ImageCacheOptions = {}): void => {
   plugins.push(
     new CacheableResponsePlugin({
       statuses: [0, 200],
@@ -71,12 +75,10 @@ function imageCache(options: ImageCacheOptions = {}): void {
     plugins,
   });
 
-  registerRoute(matchCallback, strategy);
+  router.registerCapture(matchCallback, strategy);
 
   // Warms the cache
-  if (options.warmCache) {
-    warmStrategyCache({ urls: options.warmCache, strategy });
+  if (warmCache) {
+    warmStrategyCache({ urls: warmCache, strategy });
   }
-}
-
-export { imageCache };
+};

package/src/offlineFallback.ts

@@ -7,10 +7,15 @@
 */
 
 import type { RouteHandler, RouteHandlerCallbackOptions } from "@serwist/core";
-import { matchPrecache } from "@serwist/precaching";
-import { setCatchHandler } from "@serwist/routing";
+import { type PrecacheController, getSingletonPrecacheController } from "@serwist/sw/precaching";
+import { setCatchHandler } from "@serwist/sw/routing";
 
 export interface OfflineFallbackOptions {
+  /**
+   * An optional `PrecacheController` instance. If not provided, the singleton
+   * `PrecacheController` will be used.
+   */
+  precacheController?: PrecacheController;
   /**
    * Precache name to match for page fallbacks. Defaults to offline.html.
    */
@@ -34,11 +39,12 @@ declare let self: ServiceWorkerGlobalScope;
 
  * @param options
  */
-function offlineFallback(options: OfflineFallbackOptions = {}): void {
-  const pageFallback = options.pageFallback || "offline.html";
-  const imageFallback = options.imageFallback || false;
-  const fontFallback = options.fontFallback || false;
-
+export const offlineFallback = ({
+  precacheController = getSingletonPrecacheController(),
+  pageFallback = "offline.html",
+  imageFallback,
+  fontFallback,
+}: OfflineFallbackOptions = {}): void => {
   self.addEventListener("install", (event) => {
     const files = [pageFallback];
     if (imageFallback) {
@@ -56,17 +62,17 @@ function offlineFallback(options: OfflineFallbackOptions = {}): void {
     const cache = await self.caches.open("serwist-offline-fallbacks");
 
     if (dest === "document") {
-      const match = (await matchPrecache(pageFallback)) || (await cache.match(pageFallback));
+      const match = (await precacheController.matchPrecache(pageFallback)) || (await cache.match(pageFallback));
       return match || Response.error();
     }
 
-    if (dest === "image" && imageFallback !== false) {
-      const match = (await matchPrecache(imageFallback)) || (await cache.match(imageFallback));
+    if (dest === "image" && imageFallback !== undefined) {
+      const match = (await precacheController.matchPrecache(imageFallback)) || (await cache.match(imageFallback));
       return match || Response.error();
     }
 
-    if (dest === "font" && fontFallback !== false) {
-      const match = (await matchPrecache(fontFallback)) || (await cache.match(fontFallback));
+    if (dest === "font" && fontFallback !== undefined) {
+      const match = (await precacheController.matchPrecache(fontFallback)) || (await cache.match(fontFallback));
       return match || Response.error();
     }
 
@@ -74,6 +80,4 @@ function offlineFallback(options: OfflineFallbackOptions = {}): void {
   };
 
   setCatchHandler(handler);
-}
-
-export { offlineFallback };
+};

package/src/pageCache.ts

@@ -6,14 +6,18 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { CacheableResponsePlugin } from "@serwist/cacheable-response";
 import type { RouteMatchCallback, RouteMatchCallbackOptions, SerwistPlugin } from "@serwist/core";
-import { registerRoute } from "@serwist/routing";
-import { NetworkFirst } from "@serwist/strategies";
-
+import { CacheableResponsePlugin } from "@serwist/sw/plugins";
+import { type Router, getSingletonRouter } from "@serwist/sw/routing";
+import { NetworkFirst } from "@serwist/sw/strategies";
 import { warmStrategyCache } from "./warmStrategyCache.js";
 
 export interface PageCacheOptions {
+  /**
+   * An optional `Router` instance. If not provided, the singleton `Router`
+   * will be used.
+   */
+  router?: Router;
   /**
    * Name for cache. Defaults to pages.
    */
@@ -43,13 +47,14 @@ export interface PageCacheOptions {
  *
  * @param options
  */
-function pageCache(options: PageCacheOptions = {}): void {
-  const defaultMatchCallback = ({ request }: RouteMatchCallbackOptions) => request.mode === "navigate";
-
-  const cacheName = options.cacheName || "pages";
-  const matchCallback = options.matchCallback || defaultMatchCallback;
-  const networkTimeoutSeconds = options.networkTimeoutSeconds || 3;
-  const plugins = options.plugins || [];
+export const pageCache = ({
+  router = getSingletonRouter(),
+  cacheName = "pages",
+  matchCallback = ({ request }: RouteMatchCallbackOptions) => request.mode === "navigate",
+  networkTimeoutSeconds = 3,
+  plugins = [],
+  warmCache,
+}: PageCacheOptions = {}): void => {
   plugins.push(
     new CacheableResponsePlugin({
       statuses: [0, 200],
@@ -63,12 +68,10 @@ function pageCache(options: PageCacheOptions = {}): void {
   });
 
   // Registers the route
-  registerRoute(matchCallback, strategy);
+  router.registerCapture(matchCallback, strategy);
 
   // Warms the cache
-  if (options.warmCache) {
-    warmStrategyCache({ urls: options.warmCache, strategy });
+  if (warmCache) {
+    warmStrategyCache({ urls: warmCache, strategy });
   }
-}
-
-export { pageCache };
+};

package/src/staticResourceCache.ts

@@ -6,14 +6,18 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { CacheableResponsePlugin } from "@serwist/cacheable-response";
 import type { RouteMatchCallback, RouteMatchCallbackOptions, SerwistPlugin } from "@serwist/core";
-import { registerRoute } from "@serwist/routing";
-import { StaleWhileRevalidate } from "@serwist/strategies";
-
+import { CacheableResponsePlugin } from "@serwist/sw/plugins";
+import { type Router, getSingletonRouter } from "@serwist/sw/routing";
+import { StaleWhileRevalidate } from "@serwist/sw/strategies";
 import { warmStrategyCache } from "./warmStrategyCache.js";
 
 export interface StaticResourceOptions {
+  /**
+   * An optional `Router` instance. If not provided, the singleton `Router`
+   * will be used.
+   */
+  router?: Router;
   /**
    * Name for cache.
    *
@@ -41,13 +45,14 @@ export interface StaticResourceOptions {
  *
  * @param options
  */
-function staticResourceCache(options: StaticResourceOptions = {}): void {
-  const defaultMatchCallback = ({ request }: RouteMatchCallbackOptions) =>
-    request.destination === "style" || request.destination === "script" || request.destination === "worker";
-
-  const cacheName = options.cacheName || "static-resources";
-  const matchCallback = options.matchCallback || defaultMatchCallback;
-  const plugins = options.plugins || [];
+export const staticResourceCache = ({
+  router = getSingletonRouter(),
+  cacheName = "static-resources",
+  matchCallback = ({ request }: RouteMatchCallbackOptions) =>
+    request.destination === "style" || request.destination === "script" || request.destination === "worker",
+  plugins = [],
+  warmCache,
+}: StaticResourceOptions = {}): void => {
   plugins.push(
     new CacheableResponsePlugin({
       statuses: [0, 200],
@@ -59,12 +64,10 @@ function staticResourceCache(options: StaticResourceOptions = {}): void {
     plugins,
   });
 
-  registerRoute(matchCallback, strategy);
+  router.registerCapture(matchCallback, strategy);
 
   // Warms the cache
-  if (options.warmCache) {
-    warmStrategyCache({ urls: options.warmCache, strategy });
+  if (warmCache) {
+    warmStrategyCache({ urls: warmCache, strategy });
   }
-}
-
-export { staticResourceCache };
+};

package/src/warmStrategyCache.ts

@@ -1,4 +1,4 @@
-import type { Strategy } from "@serwist/strategies";
+import type { Strategy } from "@serwist/sw/strategies";
 
 export interface WarmStrategyCacheOptions {
   /**
@@ -17,7 +17,7 @@ declare let self: ServiceWorkerGlobalScope;
 /**
  * @param options
  */
-function warmStrategyCache(options: WarmStrategyCacheOptions): void {
+export const warmStrategyCache = (options: WarmStrategyCacheOptions): void => {
   self.addEventListener("install", (event) => {
     const done = options.urls.map(
       (path) =>
@@ -29,6 +29,4 @@ function warmStrategyCache(options: WarmStrategyCacheOptions): void {
 
     event.waitUntil(Promise.all(done));
   });
-}
-
-export { warmStrategyCache };
+};