@serwist/sw 9.0.0-preview.8 → 9.0.0

package/dist/index.d.ts

@@ -1,10 +1,5 @@
-import { disableDevLogs } from "./disableDevLogs.js";
-import type { FallbackEntry, FallbackMatcher, FallbacksOptions } from "./fallbacks.js";
-import { fallbacks } from "./fallbacks.js";
-import { type HandlePrecachingOptions, handlePrecaching } from "./handlePrecaching.js";
-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 } from "serwist";
+export { fallbacks, handlePrecaching, installSerwist, registerRuntimeCaching, } from "serwist/legacy";
+export type { RuntimeCaching } from "serwist";
+export type { FallbackEntry, FallbacksOptions, HandlePrecachingOptions, InstallSerwistOptions, InstallSerwistOptions as SerwistOptions, } from "serwist/legacy";
 //# 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,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,EACL,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,sBAAsB,GACvB,MAAM,gBAAgB,CAAC;AACxB,YAAY,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAC9C,YAAY,EACV,aAAa,EACb,gBAAgB,EAChB,uBAAuB,EACvB,qBAAqB,EACrB,qBAAqB,IAAI,cAAc,GACxC,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -1,107 +1,2 @@
-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 { logger } from '@serwist/core/internal';
-
-const disableDevLogs = ()=>{
-    self.__WB_DISABLE_DEV_LOGS = true;
-};
-
-const fallbacks = ({ runtimeCaching, entries, precacheOptions })=>{
-    precacheAndRoute(entries, precacheOptions);
-    const fallbackPlugin = new PrecacheFallbackPlugin({
-        fallbackUrls: entries
-    });
-    runtimeCaching.forEach((cacheEntry)=>{
-        if (cacheEntry.handler instanceof Strategy && !cacheEntry.handler.plugins.some((plugin)=>"handlerDidError" in plugin)) {
-            cacheEntry.handler.plugins.push(fallbackPlugin);
-        }
-        return cacheEntry;
-    });
-    return runtimeCaching;
-};
-
-const handlePrecaching = ({ precacheEntries, precacheOptions, cleanupOutdatedCaches: cleanupOutdatedCaches$1 = false, ...options })=>{
-    if (!!precacheEntries && precacheEntries.length > 0) {
-        precacheAndRoute(precacheEntries, precacheOptions);
-    }
-    if (cleanupOutdatedCaches$1) cleanupOutdatedCaches();
-    if (options.navigateFallback) {
-        registerRoute(new NavigationRoute(createHandlerBoundToURL(options.navigateFallback), {
-            allowlist: options.navigateFallbackAllowlist,
-            denylist: options.navigateFallbackDenylist
-        }));
-    }
-};
-
-const registerRuntimeCaching = (...runtimeCachingList)=>{
-    if (!("__WB_FORCE_RUNTIME_CACHING" in globalThis)) {
-        self.__WB_FORCE_RUNTIME_CACHING = false;
-    }
-    if (!self.__WB_FORCE_RUNTIME_CACHING && process.env.NODE_ENV !== "production") {
-        logger.log("registerRuntimeCaching is disabled in development mode.");
-    } else {
-        for (const entry of runtimeCachingList){
-            registerRoute(entry.matcher, entry.handler, entry.method);
-        }
-    }
-};
-
-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 (runtimeCaching !== undefined) {
-        if (!("__WB_FORCE_RUNTIME_CACHING" in globalThis)) {
-            self.__WB_FORCE_RUNTIME_CACHING = false;
-        }
-        if (!self.__WB_FORCE_RUNTIME_CACHING && process.env.NODE_ENV !== "production") {
-            logger.log("runtimeCaching and fallbacks are disabled in development mode.");
-        } else {
-            if (fallbacks$1 !== undefined) {
-                fallbacks({
-                    ...fallbacks$1,
-                    runtimeCaching
-                });
-            }
-            registerRuntimeCaching(...runtimeCaching);
-        }
-    }
-    if (offlineAnalyticsConfig !== undefined) {
-        if (typeof offlineAnalyticsConfig === "boolean") {
-            offlineAnalyticsConfig && initialize();
-        } else {
-            initialize(offlineAnalyticsConfig);
-        }
-    }
-    if (disableDevLogs$1) disableDevLogs();
-};
-
-export { disableDevLogs, fallbacks, handlePrecaching, installSerwist, registerRuntimeCaching };
+export { disableDevLogs } from 'serwist';
+export { fallbacks, handlePrecaching, installSerwist, registerRuntimeCaching } from 'serwist/legacy';

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@serwist/sw",
-  "version": "9.0.0-preview.8",
+  "version": "9.0.0",
   "type": "module",
-  "description": "This module makes it easy to get started with the Serwist service worker libraries.",
+  "description": "A service worker helper module.",
   "files": [
     "src",
     "dist"
@@ -15,7 +15,7 @@
   ],
   "author": "Google's Web DevRel Team, Serwist's Team",
   "license": "MIT",
-  "repository": "serwist/serwist",
+  "repository": "https://github.com/serwist/serwist",
   "bugs": "https://github.com/serwist/serwist/issues",
   "homepage": "https://serwist.pages.dev",
   "main": "./dist/index.js",
@@ -28,23 +28,12 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@serwist/background-sync": "9.0.0-preview.8",
-    "@serwist/broadcast-update": "9.0.0-preview.8",
-    "@serwist/cacheable-response": "9.0.0-preview.8",
-    "@serwist/core": "9.0.0-preview.8",
-    "@serwist/expiration": "9.0.0-preview.8",
-    "@serwist/google-analytics": "9.0.0-preview.8",
-    "@serwist/navigation-preload": "9.0.0-preview.8",
-    "@serwist/precaching": "9.0.0-preview.8",
-    "@serwist/range-requests": "9.0.0-preview.8",
-    "@serwist/routing": "9.0.0-preview.8",
-    "@serwist/strategies": "9.0.0-preview.8"
+    "serwist": "9.0.0"
   },
   "devDependencies": {
-    "rollup": "4.9.6",
-    "typescript": "5.4.0-dev.20240206",
-    "@serwist/constants": "9.0.0-preview.8",
-    "@serwist/utils": "9.0.0-preview.8"
+    "rollup": "4.14.3",
+    "typescript": "5.5.0-dev.20240415",
+    "@serwist/configs": "9.0.0"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"
@@ -56,7 +45,6 @@
   },
   "scripts": {
     "build": "rimraf dist && cross-env NODE_ENV=production rollup --config rollup.config.js",
-    "dev": "rollup --config rollup.config.js --watch",
     "lint": "biome lint ./src",
     "typecheck": "tsc"
   }

package/src/index.ts

@@ -1,10 +1,15 @@
-import { disableDevLogs } from "./disableDevLogs.js";
-import type { FallbackEntry, FallbackMatcher, FallbacksOptions } from "./fallbacks.js";
-import { fallbacks } from "./fallbacks.js";
-import { type HandlePrecachingOptions, handlePrecaching } from "./handlePrecaching.js";
-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 } from "serwist";
+export {
+  fallbacks,
+  handlePrecaching,
+  installSerwist,
+  registerRuntimeCaching,
+} from "serwist/legacy";
+export type { RuntimeCaching } from "serwist";
+export type {
+  FallbackEntry,
+  FallbacksOptions,
+  HandlePrecachingOptions,
+  InstallSerwistOptions,
+  InstallSerwistOptions as SerwistOptions,
+} from "serwist/legacy";

package/README.md

@@ -1 +0,0 @@
-This module's documentation can be found at https://serwist.pages.dev/docs/sw

package/dist/disableDevLogs.d.ts

@@ -1,7 +0,0 @@
-/**
- * Disables Serwist's logging in development mode.
- *
- * @see https://serwist.pages.dev/docs/sw/disable-dev-logs
- */
-export declare const disableDevLogs: () => void;
-//# sourceMappingURL=disableDevLogs.d.ts.map

package/dist/disableDevLogs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"disableDevLogs.d.ts","sourceRoot":"","sources":["../src/disableDevLogs.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,eAAO,MAAM,cAAc,QAAO,IAEjC,CAAC"}

package/dist/fallbacks.d.ts

@@ -1,39 +0,0 @@
-import type { HandlerDidErrorCallbackParam } from "@serwist/core";
-import type { PrecacheRouteOptions } from "@serwist/precaching";
-import type { PrecacheFallbackEntry } from "@serwist/precaching";
-import type { RuntimeCaching } from "./types.js";
-export type FallbackMatcher = (_: HandlerDidErrorCallbackParam) => boolean;
-export interface FallbackEntry extends PrecacheFallbackEntry {
-    /**
-     * The revision used for precaching.
-     */
-    revision: string;
-}
-export interface FallbacksOptions {
-    /**
-     * Your previous `RuntimeCaching` array.
-     */
-    runtimeCaching: RuntimeCaching[];
-    /**
-     * A list of fallback entries.
-     */
-    entries: FallbackEntry[];
-    /**
-     * Precache options that will be used for your
-     * fallback entries.
-     */
-    precacheOptions?: PrecacheRouteOptions;
-}
-/**
- * Precaches routes so that they can be used as a fallback when
- * a Strategy fails to generate a response.
- *
- * Note: This function mutates `runtimeCaching`!
- *
- * @see https://serwist.pages.dev/docs/sw/fallbacks
- * @param options
- * @returns The modified `RuntimeCaching` array. Using this value
- * is not needed, as it is simply the array in `options`.
- */
-export declare const fallbacks: ({ runtimeCaching, entries, precacheOptions }: FallbacksOptions) => RuntimeCaching[];
-//# sourceMappingURL=fallbacks.d.ts.map

package/dist/fallbacks.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"fallbacks.d.ts","sourceRoot":"","sources":["../src/fallbacks.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,eAAe,CAAC;AAClE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAEhE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAGjE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,EAAE,4BAA4B,KAAK,OAAO,CAAC;AAE3E,MAAM,WAAW,aAAc,SAAQ,qBAAqB;IAC1D;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,cAAc,EAAE,cAAc,EAAE,CAAC;IACjC;;OAEG;IACH,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB;;;OAGG;IACH,eAAe,CAAC,EAAE,oBAAoB,CAAC;CACxC;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,SAAS,iDAAkD,gBAAgB,KAAG,cAAc,EAoBxG,CAAC"}

package/dist/handlePrecaching.d.ts

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

package/dist/handlePrecaching.d.ts.map

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

package/dist/installSerwist.d.ts

@@ -1,68 +0,0 @@
-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 Preload 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">;
-};
-/**
- * A function that abstracts away the core APIs of Serwist.
- * @param options - `installSerwist` options.
- */
-export declare const installSerwist: ({ precacheEntries, precacheOptions, cleanupOutdatedCaches, skipWaiting, importScripts, navigationPreload, cacheId, clientsClaim, runtimeCaching, offlineAnalyticsConfig, disableDevLogs, fallbacks, ...options }: InstallSerwistOptions) => void;
-//# sourceMappingURL=installSerwist.d.ts.map

package/dist/installSerwist.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"installSerwist.d.ts","sourceRoot":"","sources":["../src/installSerwist.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,gCAAgC,EAAc,MAAM,sCAAsC,CAAC;AAMzG,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,IAyD1B,CAAC"}

package/dist/registerRuntimeCaching.d.ts

@@ -1,11 +0,0 @@
-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
- * @param runtimeCachingList
- * @returns
- */
-export declare const registerRuntimeCaching: (...runtimeCachingList: RuntimeCaching[]) => void;
-//# sourceMappingURL=registerRuntimeCaching.d.ts.map

package/dist/registerRuntimeCaching.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"registerRuntimeCaching.d.ts","sourceRoot":"","sources":["../src/registerRuntimeCaching.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAIjD;;;;;;;GAOG;AACH,eAAO,MAAM,sBAAsB,0BAA2B,cAAc,EAAE,KAAG,IAYhF,CAAC"}

package/dist/types.d.ts

@@ -1,29 +0,0 @@
-import type { RouteHandler, RouteMatchCallback } from "@serwist/core";
-import type { HTTPMethod } from "@serwist/routing";
-export interface RuntimeCaching {
-    /**
-     * The HTTP method to match against. The default value of `'GET'` is normally
-     * sufficient, unless you explicitly need to match `'POST'`, `'PUT'`, or
-     * another type of request.
-     * @default "GET"
-     */
-    method?: HTTPMethod;
-    /**
-     * This match criteria determines whether the configured handler will
-     * generate a response for any requests that don't match one of the precached
-     * URLs. If multiple `RuntimeCaching` routes are defined, then the first one
-     * whose `matcher` matches will be the one that responds.
-     *
-     * This value directly maps to the first parameter passed to
-     * `@serwist/routing.registerRoute`. It's recommended to use a
-     * `@serwist/core.RouteMatchCallback` function for greatest flexibility.
-     */
-    matcher: RegExp | string | RouteMatchCallback;
-    /**
-     * This determines how the runtime route will generate a response. It
-     * can be a `@serwist/core.RouteHandler` callback function with custom
-     * response logic.
-     */
-    handler: RouteHandler;
-}
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAEnD,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;;;;;;;;OASG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,kBAAkB,CAAC;IAC9C;;;;OAIG;IACH,OAAO,EAAE,YAAY,CAAC;CACvB"}

package/src/disableDevLogs.ts

@@ -1,10 +0,0 @@
-declare const self: ServiceWorkerGlobalScope;
-
-/**
- * Disables Serwist's logging in development mode.
- *
- * @see https://serwist.pages.dev/docs/sw/disable-dev-logs
- */
-export const disableDevLogs = (): void => {
-  self.__WB_DISABLE_DEV_LOGS = true;
-};

package/src/fallbacks.ts

@@ -1,65 +0,0 @@
-import type { HandlerDidErrorCallbackParam } from "@serwist/core";
-import type { PrecacheRouteOptions } from "@serwist/precaching";
-import { PrecacheFallbackPlugin, precacheAndRoute } from "@serwist/precaching";
-import type { PrecacheFallbackEntry } from "@serwist/precaching";
-
-import { Strategy } from "@serwist/strategies";
-import type { RuntimeCaching } from "./types.js";
-
-export type FallbackMatcher = (_: HandlerDidErrorCallbackParam) => boolean;
-
-export interface FallbackEntry extends PrecacheFallbackEntry {
-  /**
-   * The revision used for precaching.
-   */
-  revision: string;
-}
-
-export interface FallbacksOptions {
-  /**
-   * Your previous `RuntimeCaching` array.
-   */
-  runtimeCaching: RuntimeCaching[];
-  /**
-   * A list of fallback entries.
-   */
-  entries: FallbackEntry[];
-  /**
-   * Precache options that will be used for your
-   * fallback entries.
-   */
-  precacheOptions?: PrecacheRouteOptions;
-}
-
-/**
- * Precaches routes so that they can be used as a fallback when
- * a Strategy fails to generate a response.
- *
- * Note: This function mutates `runtimeCaching`!
- *
- * @see https://serwist.pages.dev/docs/sw/fallbacks
- * @param options
- * @returns The modified `RuntimeCaching` array. Using this value
- * is not needed, as it is simply the array in `options`.
- */
-export const fallbacks = ({ runtimeCaching, entries, precacheOptions }: FallbacksOptions): RuntimeCaching[] => {
-  precacheAndRoute(entries, precacheOptions);
-
-  const fallbackPlugin = new PrecacheFallbackPlugin({
-    fallbackUrls: entries,
-  });
-
-  runtimeCaching.forEach((cacheEntry) => {
-    if (
-      cacheEntry.handler instanceof Strategy &&
-      // PrecacheFallbackPlugin also has `handlerDidError`, so we don't need to check for its instances.
-      !cacheEntry.handler.plugins.some((plugin) => "handlerDidError" in plugin)
-    ) {
-      cacheEntry.handler.plugins.push(fallbackPlugin);
-    }
-
-    return cacheEntry;
-  });
-
-  return runtimeCaching;
-};

package/src/handlePrecaching.ts

@@ -1,67 +0,0 @@
-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 = {
-  /**
-   * A list of fallback entries.
-   */
-  precacheEntries?: (PrecacheEntry | string)[];
-  /**
-   * Precache options for the provided entries.
-   */
-  precacheOptions?: PrecacheRouteOptions;
-  /**
-   * Whether outdated caches should be removed.
-   *
-   * @default false
-   */
-  cleanupOutdatedCaches?: boolean;
-} & (
-  | {
-      /**
-       * An URL that should point to a HTML
-       * file with which navigation requests for URLs that aren't precached will be fulfilled.
-       * For more complex cases, consider `@serwist/sw.fallbacks`instead.
-       */
-      navigateFallback: string;
-      /**
-       * URLs that should be allowed to use the `navigateFallback` handler.
-       */
-      navigateFallbackAllowlist?: RegExp[];
-      /**
-       * URLs that should not be allowed to use the `navigateFallback` handler. This takes precedence
-       * over `navigateFallbackAllowlist`.
-       */
-      navigateFallbackDenylist?: RegExp[];
-    }
-  | { navigateFallback?: never }
-);
-
-/**
- * Handles a list of precache entries and cleans up outdated caches.
- *
- * @see https://serwist.pages.dev/docs/sw/handlePrecaching
- * @param options
- */
-export const handlePrecaching = ({ precacheEntries, precacheOptions, cleanupOutdatedCaches = false, ...options }: HandlePrecachingOptions): void => {
-  if (!!precacheEntries && precacheEntries.length > 0) {
-    /**
-     * The precacheAndRoute() method efficiently caches and responds to
-     * requests for URLs in the manifest.
-     * See https://goo.gl/S9QRab
-     */
-    precacheAndRoute(precacheEntries, precacheOptions);
-  }
-
-  if (cleanupOutdatedCaches) cleanupOutdatedCachesImpl();
-
-  if (options.navigateFallback) {
-    registerRoute(
-      new NavigationRoute(createHandlerBoundToURL(options.navigateFallback), {
-        allowlist: options.navigateFallbackAllowlist,
-        denylist: options.navigateFallbackDenylist,
-      }),
-    );
-  }
-};

package/src/installSerwist.ts

@@ -1,150 +0,0 @@
-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 { 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 Preload 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">;
-};
-
-/**
- * A function that abstracts away the core APIs of Serwist.
- * @param options - `installSerwist` options.
- */
-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,
-    });
-  }
-
-  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,
-    }),
-  });
-
-  if (runtimeCaching !== undefined) {
-    if (!("__WB_FORCE_RUNTIME_CACHING" in globalThis)) {
-      self.__WB_FORCE_RUNTIME_CACHING = false;
-    }
-    if (!self.__WB_FORCE_RUNTIME_CACHING && process.env.NODE_ENV !== "production") {
-      logger.log("runtimeCaching and fallbacks are disabled in development mode.");
-    } else {
-      if (fallbacks !== undefined) {
-        fallbacksImpl({ ...fallbacks, runtimeCaching });
-      }
-      registerRuntimeCaching(...runtimeCaching);
-    }
-  }
-
-  if (offlineAnalyticsConfig !== undefined) {
-    if (typeof offlineAnalyticsConfig === "boolean") {
-      offlineAnalyticsConfig && initialize();
-    } else {
-      initialize(offlineAnalyticsConfig);
-    }
-  }
-
-  if (disableDevLogs) disableDevLogsImpl();
-};

package/src/registerRuntimeCaching.ts

@@ -1,28 +0,0 @@
-import { logger } from "@serwist/core/internal";
-import { registerRoute } from "@serwist/routing";
-
-import type { RuntimeCaching } from "./types.js";
-
-declare const self: ServiceWorkerGlobalScope;
-
-/**
- * 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
- * @param runtimeCachingList
- * @returns
- */
-export const registerRuntimeCaching = (...runtimeCachingList: RuntimeCaching[]): void => {
-  if (!("__WB_FORCE_RUNTIME_CACHING" in globalThis)) {
-    self.__WB_FORCE_RUNTIME_CACHING = false;
-  }
-
-  if (!self.__WB_FORCE_RUNTIME_CACHING && process.env.NODE_ENV !== "production") {
-    logger.log("registerRuntimeCaching is disabled in development mode.");
-  } else {
-    for (const entry of runtimeCachingList) {
-      registerRoute(entry.matcher, entry.handler, entry.method);
-    }
-  }
-};

package/src/types.ts

@@ -1,29 +0,0 @@
-import type { RouteHandler, RouteMatchCallback } from "@serwist/core";
-import type { HTTPMethod } from "@serwist/routing";
-
-export interface RuntimeCaching {
-  /**
-   * The HTTP method to match against. The default value of `'GET'` is normally
-   * sufficient, unless you explicitly need to match `'POST'`, `'PUT'`, or
-   * another type of request.
-   * @default "GET"
-   */
-  method?: HTTPMethod;
-  /**
-   * This match criteria determines whether the configured handler will
-   * generate a response for any requests that don't match one of the precached
-   * URLs. If multiple `RuntimeCaching` routes are defined, then the first one
-   * whose `matcher` matches will be the one that responds.
-   *
-   * This value directly maps to the first parameter passed to
-   * `@serwist/routing.registerRoute`. It's recommended to use a
-   * `@serwist/core.RouteMatchCallback` function for greatest flexibility.
-   */
-  matcher: RegExp | string | RouteMatchCallback;
-  /**
-   * This determines how the runtime route will generate a response. It
-   * can be a `@serwist/core.RouteHandler` callback function with custom
-   * response logic.
-   */
-  handler: RouteHandler;
-}