@serwist/recipes 9.0.0-preview.0 → 9.0.0-preview.1

package/dist/index.js

@@ -4,20 +4,14 @@ import { registerRoute, setCatchHandler } from '@serwist/routing';
 import { StaleWhileRevalidate, CacheFirst, NetworkFirst } from '@serwist/strategies';
 import { matchPrecache } from '@serwist/precaching';
 
-/**
- * An implementation of the [Google fonts](https://developers.google.com/web/tools/workbox/guides/common-recipes#google_fonts) caching recipe.
- *
- * @param options
- */ function googleFontsCache(options = {}) {
+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;
-    // Cache the Google Fonts stylesheets with a stale-while-revalidate strategy.
     registerRoute(({ url })=>url.origin === "https://fonts.googleapis.com", new StaleWhileRevalidate({
         cacheName: sheetCacheName
     }));
-    // Cache the underlying font files with a cache-first strategy for 1 year.
     registerRoute(({ url })=>url.origin === "https://fonts.gstatic.com", new CacheFirst({
         cacheName: fontCacheName,
         plugins: [
@@ -35,9 +29,7 @@ import { matchPrecache } from '@serwist/precaching';
     }));
 }
 
-/**
- * @param options
- */ function warmStrategyCache(options) {
+function warmStrategyCache(options) {
     self.addEventListener("install", (event)=>{
         const done = options.urls.map((path)=>options.strategy.handleAll({
                 event,
@@ -47,11 +39,7 @@ import { matchPrecache } from '@serwist/precaching';
     });
 }
 
-/**
- * An implementation of the [image caching recipe](https://developers.google.com/web/tools/workbox/guides/common-recipes#caching_images).
- *
- * @param options
- */ function imageCache(options = {}) {
+function imageCache(options = {}) {
     const defaultMatchCallback = ({ request })=>request.destination === "image";
     const cacheName = options.cacheName || "images";
     const matchCallback = options.matchCallback || defaultMatchCallback;
@@ -73,7 +61,6 @@ import { matchPrecache } from '@serwist/precaching';
         plugins
     });
     registerRoute(matchCallback, strategy);
-    // Warms the cache
     if (options.warmCache) {
         warmStrategyCache({
             urls: options.warmCache,
@@ -82,12 +69,7 @@ import { matchPrecache } from '@serwist/precaching';
     }
 }
 
-/**
- * An implementation of the [comprehensive fallbacks recipe](https://developers.google.com/web/tools/workbox/guides/advanced-recipes#comprehensive_fallbacks). 
- * Be sure to include the fallbacks in your precache injection.
-
- * @param options
- */ function offlineFallback(options = {}) {
+function offlineFallback(options = {}) {
     const pageFallback = options.pageFallback || "offline.html";
     const imageFallback = options.imageFallback || false;
     const fontFallback = options.fontFallback || false;
@@ -123,11 +105,7 @@ import { matchPrecache } from '@serwist/precaching';
     setCatchHandler(handler);
 }
 
-/**
- * An implementation of a page caching recipe with a network timeout.
- *
- * @param options
- */ function pageCache(options = {}) {
+function pageCache(options = {}) {
     const defaultMatchCallback = ({ request })=>request.mode === "navigate";
     const cacheName = options.cacheName || "pages";
     const matchCallback = options.matchCallback || defaultMatchCallback;
@@ -144,9 +122,7 @@ import { matchPrecache } from '@serwist/precaching';
         cacheName,
         plugins
     });
-    // Registers the route
     registerRoute(matchCallback, strategy);
-    // Warms the cache
     if (options.warmCache) {
         warmStrategyCache({
             urls: options.warmCache,
@@ -155,11 +131,7 @@ import { matchPrecache } from '@serwist/precaching';
     }
 }
 
-/**
- * An implementation of the [CSS and JavaScript files recipe](https://developers.google.com/web/tools/workbox/guides/common-recipes#cache_css_and_javascript_files).
- *
- * @param options
- */ function staticResourceCache(options = {}) {
+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;
@@ -175,7 +147,6 @@ import { matchPrecache } from '@serwist/precaching';
         plugins
     });
     registerRoute(matchCallback, strategy);
-    // Warms the cache
     if (options.warmCache) {
         warmStrategyCache({
             urls: options.warmCache,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/recipes",
-  "version": "9.0.0-preview.0",
+  "version": "9.0.0-preview.1",
   "type": "module",
   "description": "A service worker helper library to manage common request and caching patterns",
   "files": [
@@ -30,17 +30,17 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@serwist/cacheable-response": "9.0.0-preview.0",
-    "@serwist/core": "9.0.0-preview.0",
-    "@serwist/expiration": "9.0.0-preview.0",
-    "@serwist/precaching": "9.0.0-preview.0",
-    "@serwist/routing": "9.0.0-preview.0",
-    "@serwist/strategies": "9.0.0-preview.0"
+    "@serwist/cacheable-response": "9.0.0-preview.1",
+    "@serwist/core": "9.0.0-preview.1",
+    "@serwist/expiration": "9.0.0-preview.1",
+    "@serwist/precaching": "9.0.0-preview.1",
+    "@serwist/routing": "9.0.0-preview.1",
+    "@serwist/strategies": "9.0.0-preview.1"
   },
   "devDependencies": {
     "rollup": "4.9.6",
     "typescript": "5.4.0-dev.20240203",
-    "@serwist/constants": "9.0.0-preview.0"
+    "@serwist/constants": "9.0.0-preview.1"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"