@serwist/recipes 9.5.11 → 9.5.12

package/dist/index.d.mts

@@ -1,5 +1,4 @@
 import { RouteMatchCallback, Serwist, SerwistPlugin, Strategy } from "serwist";
-
 //#region src/googleFontsCache.d.ts
 interface GoogleFontCacheOptions {
   /**
@@ -24,12 +23,7 @@ interface GoogleFontCacheOptions {
  *
  * @param options
  */
-declare const googleFontsCache: ({
-  serwist,
-  cachePrefix,
-  maxAgeSeconds,
-  maxEntries
-}: GoogleFontCacheOptions) => void;
+declare const googleFontsCache: ({ serwist, cachePrefix, maxAgeSeconds, maxEntries }: GoogleFontCacheOptions) => void;
 //#endregion
 //#region src/imageCache.d.ts
 interface ImageCacheOptions {
@@ -67,15 +61,7 @@ interface ImageCacheOptions {
  *
  * @param options
  */
-declare const imageCache: ({
-  serwist,
-  cacheName,
-  matchCallback,
-  maxAgeSeconds,
-  maxEntries,
-  plugins,
-  warmCache
-}: ImageCacheOptions) => void;
+declare const imageCache: ({ serwist, cacheName, matchCallback, maxAgeSeconds, maxEntries, plugins, warmCache }: ImageCacheOptions) => void;
 //#endregion
 //#region src/offlineFallback.d.ts
 interface OfflineFallbackOptions {
@@ -99,15 +85,9 @@ interface OfflineFallbackOptions {
 /**
  * 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
  */
-declare const offlineFallback: ({
-  serwist,
-  pageFallback,
-  imageFallback,
-  fontFallback
-}: OfflineFallbackOptions) => void;
+declare const offlineFallback: ({ serwist, pageFallback, imageFallback, fontFallback }: OfflineFallbackOptions) => void;
 //#endregion
 //#region src/pageCache.d.ts
 interface PageCacheOptions {
@@ -143,14 +123,7 @@ interface PageCacheOptions {
  *
  * @param options
  */
-declare const pageCache: ({
-  serwist,
-  cacheName,
-  matchCallback,
-  networkTimeoutSeconds,
-  plugins,
-  warmCache
-}: PageCacheOptions) => void;
+declare const pageCache: ({ serwist, cacheName, matchCallback, networkTimeoutSeconds, plugins, warmCache }: PageCacheOptions) => void;
 //#endregion
 //#region src/staticResourceCache.d.ts
 interface StaticResourceOptions {
@@ -184,13 +157,7 @@ interface StaticResourceOptions {
  *
  * @param options
  */
-declare const staticResourceCache: ({
-  serwist,
-  cacheName,
-  matchCallback,
-  plugins,
-  warmCache
-}: StaticResourceOptions) => void;
+declare const staticResourceCache: ({ serwist, cacheName, matchCallback, plugins, warmCache }: StaticResourceOptions) => void;
 //#endregion
 //#region src/warmStrategyCache.d.ts
 interface WarmStrategyCacheOptions {

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/googleFontsCache.ts","../src/imageCache.ts","../src/offlineFallback.ts","../src/pageCache.ts","../src/staticResourceCache.ts","../src/warmStrategyCache.ts"],"mappings":";;;UASiB,sBAAA;;AAAjB;;EAIE,OAAA,EAAS,OAAA;EAAO;;;EAIhB,WAAA;EAIA;;;EAAA,aAAA;EAYW;;;EARX,UAAA;AAAA;;;;;;cAQW,gBAAA;EAAoB,OAAA;EAAA,WAAA;EAAA,aAAA;EAAA;AAAA,GAK9B,sBAAA;;;UC1Bc,iBAAA;EDHA;;;ECOf,OAAA,EAAS,OAAA;EDHT;;;ECOA,SAAA;EDKA;;;ECDA,aAAA,GAAgB,kBAAA;EDuCjB;;;ECnCC,aAAA;EDK+B;;;ECD/B,UAAA;EDMuB;;;ECFvB,OAAA,GAAU,aAAA;EDHqB;;;ECO/B,SAAA;AAAA;;;;;;cAQW,UAAA;EAAc,OAAA;EAAA,SAAA;EAAA,aAAA;EAAA,aAAA;EAAA,UAAA;EAAA,OAAA;EAAA;AAAA,GAQxB,iBAAA;;;UC9Cc,sBAAA;;AFDjB;;EEKE,OAAA,EAAS,OAAA;EFDO;;;EEKhB,YAAA;EFGA;;;EECA,aAAA;EFWW;;;EEPX,YAAA;AAAA;;;;;;;cAYW,eAAA;EAAmB,OAAA;EAAA,YAAA;EAAA,aAAA;EAAA;AAAA,GAAyE,sBAAA;;;UC1BxF,gBAAA;EHHA;;;EGOf,OAAA,EAAS,OAAA;EHHT;;;EGOA,SAAA;EHKA;;;EGDA,aAAA,GAAgB,kBAAA;EHuCjB;;;;;EGjCC,qBAAA;EHQC;;;EGJD,OAAA,GAAU,aAAA;EHDqB;;;EGK/B,SAAA;AAAA;;;;;;cAQW,SAAA;EAAa,OAAA;EAAA,SAAA;EAAA,aAAA;EAAA,qBAAA;EAAA,OAAA;EAAA;AAAA,GAOvB,gBAAA;;;UCzCc,qBAAA;EJHA;;;EIOf,OAAA,EAAS,OAAA;EJHT;;;;;EISA,SAAA;EJGU;AAQZ;;;;EILE,aAAA,GAAgB,kBAAA;EJKe;;;EID/B,OAAA,GAAU,aAAA;EJMa;;;EIFvB,SAAA;AAAA;;;;;;cAQW,mBAAA;EAAuB,OAAA;EAAA,SAAA;EAAA,aAAA;EAAA,OAAA;EAAA;AAAA,GAOjC,qBAAA;;;UCjDc,wBAAA;;ALOjB;;EKHE,IAAA;ELOgB;;;EKHhB,QAAA,EAAU,QAAA;AAAA;;;;cASC,iBAAA,GAAqB,OAAA,EAAS,wBAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/googleFontsCache.ts","../src/imageCache.ts","../src/offlineFallback.ts","../src/pageCache.ts","../src/staticResourceCache.ts","../src/warmStrategyCache.ts"],"mappings":";;UASiB;;;;EAIf,SAAS;;;;EAIT;;;;EAIA;;;;EAIA;;;;;;;cAQW,qBAAgB,SAAA,aAAA,eAAA,cAK1B;;;UC1Bc;;;;EAIf,SAAS;;;;EAIT;;;;EAIA,gBAAgB;;;;EAIhB;;;;EAIA;;;;EAIA,UAAU;;;;EAIV;;;;;;;cAQW,eAAU,SAAA,WAAA,eAAA,eAAA,YAAA,SAAA,aAQpB;;;UC9Cc;;;;EAIf,SAAS;;;;EAIT;;;;EAIA;;;;EAIA;;;;;;;cAYW,oBAAe,SAAA,cAAA,eAAA,gBAA6E;;;UC1BxF;;;;EAIf,SAAS;;;;EAIT;;;;EAIA,gBAAgB;;;;;;EAMhB;;;;EAIA,UAAU;;;;EAIV;;;;;;;cAQW,cAAS,SAAA,WAAA,eAAA,uBAAA,SAAA,aAOnB;;;UCzCc;;;;EAIf,SAAS;;;;;;EAMT;;;;;;EAMA,gBAAgB;;;;EAIhB,UAAU;;;;EAIV;;;;;;;cAQW,wBAAmB,SAAA,WAAA,eAAA,SAAA,aAO7B;;;UCjDc;;;;EAIf;;;;EAIA,UAAU;;;;;cASC,oBAAiB,SAAa"}

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/googleFontsCache.ts","../src/warmStrategyCache.ts","../src/imageCache.ts","../src/offlineFallback.ts","../src/pageCache.ts","../src/staticResourceCache.ts"],"sourcesContent":["/*\n  Copyright 2020 Google LLC\n\n  Use of this source code is governed by an MIT-style\n  license that can be found in the LICENSE file or at\n  https://opensource.org/licenses/MIT.\n*/\nimport { CacheableResponsePlugin, CacheFirst, ExpirationPlugin, type Serwist, StaleWhileRevalidate } from \"serwist\";\n\nexport interface GoogleFontCacheOptions {\n  /**\n   * A {@linkcode Serwist} instance.\n   */\n  serwist: Serwist;\n  /**\n   * Cache prefix for caching stylesheets and webfonts. Defaults to google-fonts.\n   */\n  cachePrefix?: string;\n  /**\n   * Maximum age, in seconds, that font entries will be cached for. Defaults to 1 year.\n   */\n  maxAgeSeconds?: number;\n  /**\n   * Maximum number of fonts that will be cached. Defaults to 30.\n   */\n  maxEntries?: number;\n}\n\n/**\n * An implementation of the [Google fonts](https://developers.google.com/web/tools/workbox/guides/common-recipes#google_fonts) caching recipe.\n *\n * @param options\n */\nexport const googleFontsCache = ({\n  serwist,\n  cachePrefix = \"google-fonts\",\n  maxAgeSeconds = 60 * 60 * 24 * 365,\n  maxEntries = 30,\n}: GoogleFontCacheOptions): void => {\n  // Cache the Google Fonts stylesheets with a stale-while-revalidate strategy.\n  serwist.registerCapture(\n    ({ url }) => url.origin === \"https://fonts.googleapis.com\",\n    new StaleWhileRevalidate({\n      cacheName: `${cachePrefix}-stylesheets`,\n    }),\n  );\n\n  // Cache the underlying font files with a cache-first strategy for 1 year.\n  serwist.registerCapture(\n    ({ url }) => url.origin === \"https://fonts.gstatic.com\",\n    new CacheFirst({\n      cacheName: `${cachePrefix}-webfonts`,\n      plugins: [\n        new CacheableResponsePlugin({\n          statuses: [0, 200],\n        }),\n        new ExpirationPlugin({\n          maxAgeSeconds,\n          maxEntries,\n        }),\n      ],\n    }),\n  );\n};\n","import type { Strategy } from \"serwist\";\n\nexport interface WarmStrategyCacheOptions {\n  /**\n   * Paths to warm the strategy's cache with.\n   */\n  urls: string[];\n  /**\n   * Strategy to use.\n   */\n  strategy: Strategy;\n}\n\n// Give TypeScript the correct global.\ndeclare let self: ServiceWorkerGlobalScope;\n\n/**\n * @param options\n */\nexport const warmStrategyCache = (options: WarmStrategyCacheOptions): void => {\n  self.addEventListener(\"install\", (event) => {\n    const done = options.urls.map(\n      (path) =>\n        options.strategy.handleAll({\n          event,\n          request: new Request(path),\n        })[1],\n    );\n\n    event.waitUntil(Promise.all(done));\n  });\n};\n","/*\n  Copyright 2020 Google LLC\n\n  Use of this source code is governed by an MIT-style\n  license that can be found in the LICENSE file or at\n  https://opensource.org/licenses/MIT.\n*/\n\nimport type { RouteMatchCallback, RouteMatchCallbackOptions, SerwistPlugin } from \"serwist\";\nimport { CacheableResponsePlugin, CacheFirst, ExpirationPlugin, type Serwist } from \"serwist\";\nimport { warmStrategyCache } from \"./warmStrategyCache.js\";\n\nexport interface ImageCacheOptions {\n  /**\n   * A {@linkcode Serwist} instance.\n   */\n  serwist: Serwist;\n  /**\n   * Name for cache. Defaults to images.\n   */\n  cacheName?: string;\n  /**\n   * Serwist callback function to call to match to. Defaults to request.destination === 'image'.\n   */\n  matchCallback?: RouteMatchCallback;\n  /**\n   * Maximum age, in seconds, that image entries will be cached for. Defaults to 30 days.\n   */\n  maxAgeSeconds?: number;\n  /**\n   * Maximum number of images that will be cached. Defaults to 60.\n   */\n  maxEntries?: number;\n  /**\n   * Additional plugins to use for this recipe.\n   */\n  plugins?: SerwistPlugin[];\n  /**\n   * Paths to call to use to warm this cache.\n   */\n  warmCache?: string[];\n}\n\n/**\n * An implementation of the [image caching recipe](https://developers.google.com/web/tools/workbox/guides/common-recipes#caching_images).\n *\n * @param options\n */\nexport const imageCache = ({\n  serwist,\n  cacheName = \"images\",\n  matchCallback = ({ request }: RouteMatchCallbackOptions) => request.destination === \"image\",\n  maxAgeSeconds = 30 * 24 * 60 * 60,\n  maxEntries = 60,\n  plugins = [],\n  warmCache,\n}: ImageCacheOptions): void => {\n  plugins.push(\n    new CacheableResponsePlugin({\n      statuses: [0, 200],\n    }),\n  );\n  plugins.push(\n    new ExpirationPlugin({\n      maxEntries,\n      maxAgeSeconds,\n    }),\n  );\n\n  const strategy = new CacheFirst({\n    cacheName,\n    plugins,\n  });\n\n  serwist.registerCapture(matchCallback, strategy);\n\n  // Warms the cache\n  if (warmCache) {\n    warmStrategyCache({ urls: warmCache, strategy });\n  }\n};\n","/*\n  Copyright 2020 Google LLC\n\n  Use of this source code is governed by an MIT-style\n  license that can be found in the LICENSE file or at\n  https://opensource.org/licenses/MIT.\n*/\n\nimport type { RouteHandler, RouteHandlerCallbackOptions, Serwist } from \"serwist\";\n\nexport interface OfflineFallbackOptions {\n  /**\n   * A {@linkcode Serwist} instance.\n   */\n  serwist: Serwist;\n  /**\n   * Precache name to match for page fallbacks. Defaults to offline.html.\n   */\n  pageFallback?: string;\n  /**\n   * Precache name to match for image fallbacks.\n   */\n  imageFallback?: string;\n  /**\n   * Precache name to match for font fallbacks.\n   */\n  fontFallback?: string;\n}\n\n// Give TypeScript the correct global.\ndeclare let self: ServiceWorkerGlobalScope;\n\n/**\n * An implementation of the [comprehensive fallbacks recipe](https://developers.google.com/web/tools/workbox/guides/advanced-recipes#comprehensive_fallbacks). \n * Be sure to include the fallbacks in your precache injection.\n\n * @param options\n */\nexport const offlineFallback = ({ serwist, pageFallback = \"offline.html\", imageFallback, fontFallback }: OfflineFallbackOptions): void => {\n  self.addEventListener(\"install\", (event) => {\n    const files = [pageFallback];\n    if (imageFallback) {\n      files.push(imageFallback);\n    }\n    if (fontFallback) {\n      files.push(fontFallback);\n    }\n\n    event.waitUntil(self.caches.open(\"serwist-offline-fallbacks\").then((cache) => cache.addAll(files)));\n  });\n\n  const handler: RouteHandler = async (options: RouteHandlerCallbackOptions) => {\n    const dest = options.request.destination;\n    const cache = await self.caches.open(\"serwist-offline-fallbacks\");\n\n    if (dest === \"document\") {\n      const match = (await serwist.matchPrecache(pageFallback)) || (await cache.match(pageFallback));\n      return match || Response.error();\n    }\n\n    if (dest === \"image\" && imageFallback !== undefined) {\n      const match = (await serwist.matchPrecache(imageFallback)) || (await cache.match(imageFallback));\n      return match || Response.error();\n    }\n\n    if (dest === \"font\" && fontFallback !== undefined) {\n      const match = (await serwist.matchPrecache(fontFallback)) || (await cache.match(fontFallback));\n      return match || Response.error();\n    }\n\n    return Response.error();\n  };\n\n  serwist.setCatchHandler(handler);\n};\n","/*\n  Copyright 2020 Google LLC\n\n  Use of this source code is governed by an MIT-style\n  license that can be found in the LICENSE file or at\n  https://opensource.org/licenses/MIT.\n*/\n\nimport type { RouteMatchCallback, RouteMatchCallbackOptions, SerwistPlugin } from \"serwist\";\nimport { CacheableResponsePlugin, NetworkFirst, type Serwist } from \"serwist\";\nimport { warmStrategyCache } from \"./warmStrategyCache.js\";\n\nexport interface PageCacheOptions {\n  /**\n   * A {@linkcode Serwist} instance.\n   */\n  serwist: Serwist;\n  /**\n   * Name for cache. Defaults to pages.\n   */\n  cacheName?: string;\n  /**\n   * Serwist callback function to call to match to. Defaults to request.mode === 'navigate'.\n   */\n  matchCallback?: RouteMatchCallback;\n  /**\n   * Maximum amount of time, in seconds, to wait on the network before falling back to cache.\n   *\n   * @default 3\n   */\n  networkTimeoutSeconds?: number;\n  /**\n   * Additional plugins to use for this recipe.\n   */\n  plugins?: SerwistPlugin[];\n  /**\n   * Paths to call to use to warm this cache\n   */\n  warmCache?: string[];\n}\n\n/**\n * An implementation of a page caching recipe with a network timeout.\n *\n * @param options\n */\nexport const pageCache = ({\n  serwist,\n  cacheName = \"pages\",\n  matchCallback = ({ request }: RouteMatchCallbackOptions) => request.mode === \"navigate\",\n  networkTimeoutSeconds = 3,\n  plugins = [],\n  warmCache,\n}: PageCacheOptions): void => {\n  plugins.push(\n    new CacheableResponsePlugin({\n      statuses: [0, 200],\n    }),\n  );\n\n  const strategy = new NetworkFirst({\n    networkTimeoutSeconds,\n    cacheName,\n    plugins,\n  });\n\n  // Registers the route\n  serwist.registerCapture(matchCallback, strategy);\n\n  // Warms the cache\n  if (warmCache) {\n    warmStrategyCache({ urls: warmCache, strategy });\n  }\n};\n","/*\n  Copyright 2020 Google LLC\n\n  Use of this source code is governed by an MIT-style\n  license that can be found in the LICENSE file or at\n  https://opensource.org/licenses/MIT.\n*/\n\nimport type { RouteMatchCallback, RouteMatchCallbackOptions, SerwistPlugin } from \"serwist\";\nimport { CacheableResponsePlugin, type Serwist, StaleWhileRevalidate } from \"serwist\";\nimport { warmStrategyCache } from \"./warmStrategyCache.js\";\n\nexport interface StaticResourceOptions {\n  /**\n   * A {@linkcode Serwist} instance.\n   */\n  serwist: Serwist;\n  /**\n   * Name for cache.\n   *\n   * @default \"static-resources\"\n   */\n  cacheName?: string;\n  /**\n   * Serwist callback function to call to match to.\n   *\n   * @default request.destination === 'style' || request.destination === 'script' || request.destination === 'worker'\n   */\n  matchCallback?: RouteMatchCallback;\n  /**\n   * Additional plugins to use for this recipe.\n   */\n  plugins?: SerwistPlugin[];\n  /**\n   * Paths to call to use to warm this cache.\n   */\n  warmCache?: string[];\n}\n\n/**\n * An implementation of the [CSS and JavaScript files recipe](https://developers.google.com/web/tools/workbox/guides/common-recipes#cache_css_and_javascript_files).\n *\n * @param options\n */\nexport const staticResourceCache = ({\n  serwist,\n  cacheName = \"static-resources\",\n  matchCallback = ({ request }: RouteMatchCallbackOptions) =>\n    request.destination === \"style\" || request.destination === \"script\" || request.destination === \"worker\",\n  plugins = [],\n  warmCache,\n}: StaticResourceOptions): void => {\n  plugins.push(\n    new CacheableResponsePlugin({\n      statuses: [0, 200],\n    }),\n  );\n\n  const strategy = new StaleWhileRevalidate({\n    cacheName,\n    plugins,\n  });\n\n  serwist.registerCapture(matchCallback, strategy);\n\n  // Warms the cache\n  if (warmCache) {\n    warmStrategyCache({ urls: warmCache, strategy });\n  }\n};\n"],"mappings":";;;;;;;AAiCA,MAAa,oBAAoB,EAC/B,SACA,cAAc,gBACd,gBAAgB,OAAU,KAAK,KAC/B,aAAa,SACqB;AAElC,SAAQ,iBACL,EAAE,UAAU,IAAI,WAAW,gCAC5B,IAAI,qBAAqB,EACvB,WAAW,GAAG,YAAY,eAC3B,CAAC,CACH;AAGD,SAAQ,iBACL,EAAE,UAAU,IAAI,WAAW,6BAC5B,IAAI,WAAW;EACb,WAAW,GAAG,YAAY;EAC1B,SAAS,CACP,IAAI,wBAAwB,EAC1B,UAAU,CAAC,GAAG,IAAI,EACnB,CAAC,EACF,IAAI,iBAAiB;GACnB;GACA;GACD,CAAC,CACH;EACF,CAAC,CACH;;;;;;;AC3CH,MAAa,qBAAqB,YAA4C;AAC5E,MAAK,iBAAiB,YAAY,UAAU;EAC1C,MAAM,OAAO,QAAQ,KAAK,KACvB,SACC,QAAQ,SAAS,UAAU;GACzB;GACA,SAAS,IAAI,QAAQ,KAAK;GAC3B,CAAC,CAAC,GACN;AAED,QAAM,UAAU,QAAQ,IAAI,KAAK,CAAC;GAClC;;;;;;;;;ACkBJ,MAAa,cAAc,EACzB,SACA,YAAY,UACZ,iBAAiB,EAAE,cAAyC,QAAQ,gBAAgB,SACpF,gBAAgB,MAAU,KAAK,IAC/B,aAAa,IACb,UAAU,EAAE,EACZ,gBAC6B;AAC7B,SAAQ,KACN,IAAI,wBAAwB,EAC1B,UAAU,CAAC,GAAG,IAAI,EACnB,CAAC,CACH;AACD,SAAQ,KACN,IAAI,iBAAiB;EACnB;EACA;EACD,CAAC,CACH;CAED,MAAM,WAAW,IAAI,WAAW;EAC9B;EACA;EACD,CAAC;AAEF,SAAQ,gBAAgB,eAAe,SAAS;AAGhD,KAAI,UACF,mBAAkB;EAAE,MAAM;EAAW;EAAU,CAAC;;;;;;;;;;ACxCpD,MAAa,mBAAmB,EAAE,SAAS,eAAe,gBAAgB,eAAe,mBAAiD;AACxI,MAAK,iBAAiB,YAAY,UAAU;EAC1C,MAAM,QAAQ,CAAC,aAAa;AAC5B,MAAI,cACF,OAAM,KAAK,cAAc;AAE3B,MAAI,aACF,OAAM,KAAK,aAAa;AAG1B,QAAM,UAAU,KAAK,OAAO,KAAK,4BAA4B,CAAC,MAAM,UAAU,MAAM,OAAO,MAAM,CAAC,CAAC;GACnG;CAEF,MAAM,UAAwB,OAAO,YAAyC;EAC5E,MAAM,OAAO,QAAQ,QAAQ;EAC7B,MAAM,QAAQ,MAAM,KAAK,OAAO,KAAK,4BAA4B;AAEjE,MAAI,SAAS,WAEX,QADe,MAAM,QAAQ,cAAc,aAAa,IAAM,MAAM,MAAM,MAAM,aAAa,IAC7E,SAAS,OAAO;AAGlC,MAAI,SAAS,WAAW,kBAAkB,KAAA,EAExC,QADe,MAAM,QAAQ,cAAc,cAAc,IAAM,MAAM,MAAM,MAAM,cAAc,IAC/E,SAAS,OAAO;AAGlC,MAAI,SAAS,UAAU,iBAAiB,KAAA,EAEtC,QADe,MAAM,QAAQ,cAAc,aAAa,IAAM,MAAM,MAAM,MAAM,aAAa,IAC7E,SAAS,OAAO;AAGlC,SAAO,SAAS,OAAO;;AAGzB,SAAQ,gBAAgB,QAAQ;;;;;;;;;AC3BlC,MAAa,aAAa,EACxB,SACA,YAAY,SACZ,iBAAiB,EAAE,cAAyC,QAAQ,SAAS,YAC7E,wBAAwB,GACxB,UAAU,EAAE,EACZ,gBAC4B;AAC5B,SAAQ,KACN,IAAI,wBAAwB,EAC1B,UAAU,CAAC,GAAG,IAAI,EACnB,CAAC,CACH;CAED,MAAM,WAAW,IAAI,aAAa;EAChC;EACA;EACA;EACD,CAAC;AAGF,SAAQ,gBAAgB,eAAe,SAAS;AAGhD,KAAI,UACF,mBAAkB;EAAE,MAAM;EAAW;EAAU,CAAC;;;;;;;;;AC3BpD,MAAa,uBAAuB,EAClC,SACA,YAAY,oBACZ,iBAAiB,EAAE,cACjB,QAAQ,gBAAgB,WAAW,QAAQ,gBAAgB,YAAY,QAAQ,gBAAgB,UACjG,UAAU,EAAE,EACZ,gBACiC;AACjC,SAAQ,KACN,IAAI,wBAAwB,EAC1B,UAAU,CAAC,GAAG,IAAI,EACnB,CAAC,CACH;CAED,MAAM,WAAW,IAAI,qBAAqB;EACxC;EACA;EACD,CAAC;AAEF,SAAQ,gBAAgB,eAAe,SAAS;AAGhD,KAAI,UACF,mBAAkB;EAAE,MAAM;EAAW;EAAU,CAAC"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/googleFontsCache.ts","../src/warmStrategyCache.ts","../src/imageCache.ts","../src/offlineFallback.ts","../src/pageCache.ts","../src/staticResourceCache.ts"],"sourcesContent":["/*\n  Copyright 2020 Google LLC\n\n  Use of this source code is governed by an MIT-style\n  license that can be found in the LICENSE file or at\n  https://opensource.org/licenses/MIT.\n*/\nimport { CacheableResponsePlugin, CacheFirst, ExpirationPlugin, type Serwist, StaleWhileRevalidate } from \"serwist\";\n\nexport interface GoogleFontCacheOptions {\n  /**\n   * A {@linkcode Serwist} instance.\n   */\n  serwist: Serwist;\n  /**\n   * Cache prefix for caching stylesheets and webfonts. Defaults to google-fonts.\n   */\n  cachePrefix?: string;\n  /**\n   * Maximum age, in seconds, that font entries will be cached for. Defaults to 1 year.\n   */\n  maxAgeSeconds?: number;\n  /**\n   * Maximum number of fonts that will be cached. Defaults to 30.\n   */\n  maxEntries?: number;\n}\n\n/**\n * An implementation of the [Google fonts](https://developers.google.com/web/tools/workbox/guides/common-recipes#google_fonts) caching recipe.\n *\n * @param options\n */\nexport const googleFontsCache = ({\n  serwist,\n  cachePrefix = \"google-fonts\",\n  maxAgeSeconds = 60 * 60 * 24 * 365,\n  maxEntries = 30,\n}: GoogleFontCacheOptions): void => {\n  // Cache the Google Fonts stylesheets with a stale-while-revalidate strategy.\n  serwist.registerCapture(\n    ({ url }) => url.origin === \"https://fonts.googleapis.com\",\n    new StaleWhileRevalidate({\n      cacheName: `${cachePrefix}-stylesheets`,\n    }),\n  );\n\n  // Cache the underlying font files with a cache-first strategy for 1 year.\n  serwist.registerCapture(\n    ({ url }) => url.origin === \"https://fonts.gstatic.com\",\n    new CacheFirst({\n      cacheName: `${cachePrefix}-webfonts`,\n      plugins: [\n        new CacheableResponsePlugin({\n          statuses: [0, 200],\n        }),\n        new ExpirationPlugin({\n          maxAgeSeconds,\n          maxEntries,\n        }),\n      ],\n    }),\n  );\n};\n","import type { Strategy } from \"serwist\";\n\nexport interface WarmStrategyCacheOptions {\n  /**\n   * Paths to warm the strategy's cache with.\n   */\n  urls: string[];\n  /**\n   * Strategy to use.\n   */\n  strategy: Strategy;\n}\n\n// Give TypeScript the correct global.\ndeclare let self: ServiceWorkerGlobalScope;\n\n/**\n * @param options\n */\nexport const warmStrategyCache = (options: WarmStrategyCacheOptions): void => {\n  self.addEventListener(\"install\", (event) => {\n    const done = options.urls.map(\n      (path) =>\n        options.strategy.handleAll({\n          event,\n          request: new Request(path),\n        })[1],\n    );\n\n    event.waitUntil(Promise.all(done));\n  });\n};\n","/*\n  Copyright 2020 Google LLC\n\n  Use of this source code is governed by an MIT-style\n  license that can be found in the LICENSE file or at\n  https://opensource.org/licenses/MIT.\n*/\n\nimport type { RouteMatchCallback, RouteMatchCallbackOptions, SerwistPlugin } from \"serwist\";\nimport { CacheableResponsePlugin, CacheFirst, ExpirationPlugin, type Serwist } from \"serwist\";\nimport { warmStrategyCache } from \"./warmStrategyCache.js\";\n\nexport interface ImageCacheOptions {\n  /**\n   * A {@linkcode Serwist} instance.\n   */\n  serwist: Serwist;\n  /**\n   * Name for cache. Defaults to images.\n   */\n  cacheName?: string;\n  /**\n   * Serwist callback function to call to match to. Defaults to request.destination === 'image'.\n   */\n  matchCallback?: RouteMatchCallback;\n  /**\n   * Maximum age, in seconds, that image entries will be cached for. Defaults to 30 days.\n   */\n  maxAgeSeconds?: number;\n  /**\n   * Maximum number of images that will be cached. Defaults to 60.\n   */\n  maxEntries?: number;\n  /**\n   * Additional plugins to use for this recipe.\n   */\n  plugins?: SerwistPlugin[];\n  /**\n   * Paths to call to use to warm this cache.\n   */\n  warmCache?: string[];\n}\n\n/**\n * An implementation of the [image caching recipe](https://developers.google.com/web/tools/workbox/guides/common-recipes#caching_images).\n *\n * @param options\n */\nexport const imageCache = ({\n  serwist,\n  cacheName = \"images\",\n  matchCallback = ({ request }: RouteMatchCallbackOptions) => request.destination === \"image\",\n  maxAgeSeconds = 30 * 24 * 60 * 60,\n  maxEntries = 60,\n  plugins = [],\n  warmCache,\n}: ImageCacheOptions): void => {\n  plugins.push(\n    new CacheableResponsePlugin({\n      statuses: [0, 200],\n    }),\n  );\n  plugins.push(\n    new ExpirationPlugin({\n      maxEntries,\n      maxAgeSeconds,\n    }),\n  );\n\n  const strategy = new CacheFirst({\n    cacheName,\n    plugins,\n  });\n\n  serwist.registerCapture(matchCallback, strategy);\n\n  // Warms the cache\n  if (warmCache) {\n    warmStrategyCache({ urls: warmCache, strategy });\n  }\n};\n","/*\n  Copyright 2020 Google LLC\n\n  Use of this source code is governed by an MIT-style\n  license that can be found in the LICENSE file or at\n  https://opensource.org/licenses/MIT.\n*/\n\nimport type { RouteHandler, RouteHandlerCallbackOptions, Serwist } from \"serwist\";\n\nexport interface OfflineFallbackOptions {\n  /**\n   * A {@linkcode Serwist} instance.\n   */\n  serwist: Serwist;\n  /**\n   * Precache name to match for page fallbacks. Defaults to offline.html.\n   */\n  pageFallback?: string;\n  /**\n   * Precache name to match for image fallbacks.\n   */\n  imageFallback?: string;\n  /**\n   * Precache name to match for font fallbacks.\n   */\n  fontFallback?: string;\n}\n\n// Give TypeScript the correct global.\ndeclare let self: ServiceWorkerGlobalScope;\n\n/**\n * An implementation of the [comprehensive fallbacks recipe](https://developers.google.com/web/tools/workbox/guides/advanced-recipes#comprehensive_fallbacks). \n * Be sure to include the fallbacks in your precache injection.\n\n * @param options\n */\nexport const offlineFallback = ({ serwist, pageFallback = \"offline.html\", imageFallback, fontFallback }: OfflineFallbackOptions): void => {\n  self.addEventListener(\"install\", (event) => {\n    const files = [pageFallback];\n    if (imageFallback) {\n      files.push(imageFallback);\n    }\n    if (fontFallback) {\n      files.push(fontFallback);\n    }\n\n    event.waitUntil(self.caches.open(\"serwist-offline-fallbacks\").then((cache) => cache.addAll(files)));\n  });\n\n  const handler: RouteHandler = async (options: RouteHandlerCallbackOptions) => {\n    const dest = options.request.destination;\n    const cache = await self.caches.open(\"serwist-offline-fallbacks\");\n\n    if (dest === \"document\") {\n      const match = (await serwist.matchPrecache(pageFallback)) || (await cache.match(pageFallback));\n      return match || Response.error();\n    }\n\n    if (dest === \"image\" && imageFallback !== undefined) {\n      const match = (await serwist.matchPrecache(imageFallback)) || (await cache.match(imageFallback));\n      return match || Response.error();\n    }\n\n    if (dest === \"font\" && fontFallback !== undefined) {\n      const match = (await serwist.matchPrecache(fontFallback)) || (await cache.match(fontFallback));\n      return match || Response.error();\n    }\n\n    return Response.error();\n  };\n\n  serwist.setCatchHandler(handler);\n};\n","/*\n  Copyright 2020 Google LLC\n\n  Use of this source code is governed by an MIT-style\n  license that can be found in the LICENSE file or at\n  https://opensource.org/licenses/MIT.\n*/\n\nimport type { RouteMatchCallback, RouteMatchCallbackOptions, SerwistPlugin } from \"serwist\";\nimport { CacheableResponsePlugin, NetworkFirst, type Serwist } from \"serwist\";\nimport { warmStrategyCache } from \"./warmStrategyCache.js\";\n\nexport interface PageCacheOptions {\n  /**\n   * A {@linkcode Serwist} instance.\n   */\n  serwist: Serwist;\n  /**\n   * Name for cache. Defaults to pages.\n   */\n  cacheName?: string;\n  /**\n   * Serwist callback function to call to match to. Defaults to request.mode === 'navigate'.\n   */\n  matchCallback?: RouteMatchCallback;\n  /**\n   * Maximum amount of time, in seconds, to wait on the network before falling back to cache.\n   *\n   * @default 3\n   */\n  networkTimeoutSeconds?: number;\n  /**\n   * Additional plugins to use for this recipe.\n   */\n  plugins?: SerwistPlugin[];\n  /**\n   * Paths to call to use to warm this cache\n   */\n  warmCache?: string[];\n}\n\n/**\n * An implementation of a page caching recipe with a network timeout.\n *\n * @param options\n */\nexport const pageCache = ({\n  serwist,\n  cacheName = \"pages\",\n  matchCallback = ({ request }: RouteMatchCallbackOptions) => request.mode === \"navigate\",\n  networkTimeoutSeconds = 3,\n  plugins = [],\n  warmCache,\n}: PageCacheOptions): void => {\n  plugins.push(\n    new CacheableResponsePlugin({\n      statuses: [0, 200],\n    }),\n  );\n\n  const strategy = new NetworkFirst({\n    networkTimeoutSeconds,\n    cacheName,\n    plugins,\n  });\n\n  // Registers the route\n  serwist.registerCapture(matchCallback, strategy);\n\n  // Warms the cache\n  if (warmCache) {\n    warmStrategyCache({ urls: warmCache, strategy });\n  }\n};\n","/*\n  Copyright 2020 Google LLC\n\n  Use of this source code is governed by an MIT-style\n  license that can be found in the LICENSE file or at\n  https://opensource.org/licenses/MIT.\n*/\n\nimport type { RouteMatchCallback, RouteMatchCallbackOptions, SerwistPlugin } from \"serwist\";\nimport { CacheableResponsePlugin, type Serwist, StaleWhileRevalidate } from \"serwist\";\nimport { warmStrategyCache } from \"./warmStrategyCache.js\";\n\nexport interface StaticResourceOptions {\n  /**\n   * A {@linkcode Serwist} instance.\n   */\n  serwist: Serwist;\n  /**\n   * Name for cache.\n   *\n   * @default \"static-resources\"\n   */\n  cacheName?: string;\n  /**\n   * Serwist callback function to call to match to.\n   *\n   * @default request.destination === 'style' || request.destination === 'script' || request.destination === 'worker'\n   */\n  matchCallback?: RouteMatchCallback;\n  /**\n   * Additional plugins to use for this recipe.\n   */\n  plugins?: SerwistPlugin[];\n  /**\n   * Paths to call to use to warm this cache.\n   */\n  warmCache?: string[];\n}\n\n/**\n * An implementation of the [CSS and JavaScript files recipe](https://developers.google.com/web/tools/workbox/guides/common-recipes#cache_css_and_javascript_files).\n *\n * @param options\n */\nexport const staticResourceCache = ({\n  serwist,\n  cacheName = \"static-resources\",\n  matchCallback = ({ request }: RouteMatchCallbackOptions) =>\n    request.destination === \"style\" || request.destination === \"script\" || request.destination === \"worker\",\n  plugins = [],\n  warmCache,\n}: StaticResourceOptions): void => {\n  plugins.push(\n    new CacheableResponsePlugin({\n      statuses: [0, 200],\n    }),\n  );\n\n  const strategy = new StaleWhileRevalidate({\n    cacheName,\n    plugins,\n  });\n\n  serwist.registerCapture(matchCallback, strategy);\n\n  // Warms the cache\n  if (warmCache) {\n    warmStrategyCache({ urls: warmCache, strategy });\n  }\n};\n"],"mappings":";;;;;;;AAiCA,MAAa,oBAAoB,EAC/B,SACA,cAAc,gBACd,gBAAgB,OAAU,KAAK,KAC/B,aAAa,SACqB;CAElC,QAAQ,iBACL,EAAE,UAAU,IAAI,WAAW,gCAC5B,IAAI,qBAAqB,EACvB,WAAW,GAAG,YAAY,cAC5B,CAAC,CACH;CAGA,QAAQ,iBACL,EAAE,UAAU,IAAI,WAAW,6BAC5B,IAAI,WAAW;EACb,WAAW,GAAG,YAAY;EAC1B,SAAS,CACP,IAAI,wBAAwB,EAC1B,UAAU,CAAC,GAAG,GAAG,EACnB,CAAC,GACD,IAAI,iBAAiB;GACnB;GACA;EACF,CAAC,CACH;CACF,CAAC,CACH;AACF;;;;;;AC5CA,MAAa,qBAAqB,YAA4C;CAC5E,KAAK,iBAAiB,YAAY,UAAU;EAC1C,MAAM,OAAO,QAAQ,KAAK,KACvB,SACC,QAAQ,SAAS,UAAU;GACzB;GACA,SAAS,IAAI,QAAQ,IAAI;EAC3B,CAAC,CAAC,CAAC,EACP;EAEA,MAAM,UAAU,QAAQ,IAAI,IAAI,CAAC;CACnC,CAAC;AACH;;;;;;;;ACiBA,MAAa,cAAc,EACzB,SACA,YAAY,UACZ,iBAAiB,EAAE,cAAyC,QAAQ,gBAAgB,SACpF,gBAAgB,MAAU,KAAK,IAC/B,aAAa,IACb,UAAU,CAAC,GACX,gBAC6B;CAC7B,QAAQ,KACN,IAAI,wBAAwB,EAC1B,UAAU,CAAC,GAAG,GAAG,EACnB,CAAC,CACH;CACA,QAAQ,KACN,IAAI,iBAAiB;EACnB;EACA;CACF,CAAC,CACH;CAEA,MAAM,WAAW,IAAI,WAAW;EAC9B;EACA;CACF,CAAC;CAED,QAAQ,gBAAgB,eAAe,QAAQ;CAG/C,IAAI,WACF,kBAAkB;EAAE,MAAM;EAAW;CAAS,CAAC;AAEnD;;;;;;;;;AC1CA,MAAa,mBAAmB,EAAE,SAAS,eAAe,gBAAgB,eAAe,mBAAiD;CACxI,KAAK,iBAAiB,YAAY,UAAU;EAC1C,MAAM,QAAQ,CAAC,YAAY;EAC3B,IAAI,eACF,MAAM,KAAK,aAAa;EAE1B,IAAI,cACF,MAAM,KAAK,YAAY;EAGzB,MAAM,UAAU,KAAK,OAAO,KAAK,2BAA2B,CAAC,CAAC,MAAM,UAAU,MAAM,OAAO,KAAK,CAAC,CAAC;CACpG,CAAC;CAED,MAAM,UAAwB,OAAO,YAAyC;EAC5E,MAAM,OAAO,QAAQ,QAAQ;EAC7B,MAAM,QAAQ,MAAM,KAAK,OAAO,KAAK,2BAA2B;EAEhE,IAAI,SAAS,YAEX,OADe,MAAM,QAAQ,cAAc,YAAY,KAAO,MAAM,MAAM,MAAM,YAAY,KAC5E,SAAS,MAAM;EAGjC,IAAI,SAAS,WAAW,kBAAkB,KAAA,GAExC,OADe,MAAM,QAAQ,cAAc,aAAa,KAAO,MAAM,MAAM,MAAM,aAAa,KAC9E,SAAS,MAAM;EAGjC,IAAI,SAAS,UAAU,iBAAiB,KAAA,GAEtC,OADe,MAAM,QAAQ,cAAc,YAAY,KAAO,MAAM,MAAM,MAAM,YAAY,KAC5E,SAAS,MAAM;EAGjC,OAAO,SAAS,MAAM;CACxB;CAEA,QAAQ,gBAAgB,OAAO;AACjC;;;;;;;;AC5BA,MAAa,aAAa,EACxB,SACA,YAAY,SACZ,iBAAiB,EAAE,cAAyC,QAAQ,SAAS,YAC7E,wBAAwB,GACxB,UAAU,CAAC,GACX,gBAC4B;CAC5B,QAAQ,KACN,IAAI,wBAAwB,EAC1B,UAAU,CAAC,GAAG,GAAG,EACnB,CAAC,CACH;CAEA,MAAM,WAAW,IAAI,aAAa;EAChC;EACA;EACA;CACF,CAAC;CAGD,QAAQ,gBAAgB,eAAe,QAAQ;CAG/C,IAAI,WACF,kBAAkB;EAAE,MAAM;EAAW;CAAS,CAAC;AAEnD;;;;;;;;AC7BA,MAAa,uBAAuB,EAClC,SACA,YAAY,oBACZ,iBAAiB,EAAE,cACjB,QAAQ,gBAAgB,WAAW,QAAQ,gBAAgB,YAAY,QAAQ,gBAAgB,UACjG,UAAU,CAAC,GACX,gBACiC;CACjC,QAAQ,KACN,IAAI,wBAAwB,EAC1B,UAAU,CAAC,GAAG,GAAG,EACnB,CAAC,CACH;CAEA,MAAM,WAAW,IAAI,qBAAqB;EACxC;EACA;CACF,CAAC;CAED,QAAQ,gBAAgB,eAAe,QAAQ;CAG/C,IAAI,WACF,kBAAkB;EAAE,MAAM;EAAW;CAAS,CAAC;AAEnD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/recipes",
-  "version": "9.5.11",
+  "version": "9.5.12",
   "type": "module",
   "description": "A service worker helper library to manage common request and caching patterns",
   "files": [
@@ -20,7 +20,10 @@
     "Serwist <ducanh2912.rusty@gmail.com> (https://serwist.pages.dev/)"
   ],
   "license": "MIT",
-  "repository": "https://github.com/serwist/serwist",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/serwist/serwist"
+  },
   "bugs": "https://github.com/serwist/serwist/issues",
   "homepage": "https://serwist.pages.dev",
   "main": "./dist/index.mjs",
@@ -33,11 +36,11 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "serwist": "9.5.11"
+    "serwist": "9.5.12"
   },
   "devDependencies": {
-    "tsdown": "0.21.10",
-    "typescript": "6.0.3"
+    "tsdown": "0.22.12",
+    "typescript": "7.0.2"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"