@serwist/sw 9.0.0-preview.20 → 9.0.0-preview.24

package/src/abstractions/fallbacks.ts

@@ -1,65 +0,0 @@
-import type { HandlerDidErrorCallbackParam } from "@serwist/core";
-import { PrecacheFallbackPlugin } from "../plugins/precaching/PrecacheFallbackPlugin.js";
-import type { PrecacheFallbackEntry } from "../plugins/precaching/PrecacheFallbackPlugin.js";
-import { precacheAndRoute } from "../precaching/precacheAndRoute.js";
-import type { PrecacheRouteOptions } from "../precaching/types.js";
-import { Strategy } from "../strategies/Strategy.js";
-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/abstractions/handlePrecaching.ts

@@ -1,65 +0,0 @@
-import { cleanupOutdatedCaches as cleanupOutdatedCachesImpl } from "../precaching/cleanupOutdatedCaches.js";
-import { createHandlerBoundToURL } from "../precaching/createHandlerBoundToURL.js";
-import { precacheAndRoute } from "../precaching/precacheAndRoute.js";
-import type { PrecacheEntry, PrecacheRouteOptions } from "../precaching/types.js";
-import { NavigationRoute } from "../routing/NavigationRoute.js";
-import { registerRoute } from "../routing/registerRoute.js";
-
-export interface 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.
-   */
-  navigateFallback?: string;
-  /**
-   * URLs that should be allowed to use the `navigateFallback` handler.
-   */
-  navigateFallbackAllowlist?: RegExp[];
-  /**
-   * URLs that should not be allowed to use the `navigateFallback` handler. This takes precedence
-   * over `navigateFallbackAllowlist`.
-   */
-  navigateFallbackDenylist?: RegExp[];
-}
-
-/**
- * Handles a list of precache entries and cleans up outdated caches.
- *
- * @see https://serwist.pages.dev/docs/sw/handle-precaching
- * @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/abstractions/installSerwist.ts

@@ -1,28 +0,0 @@
-import { logger } from "@serwist/core/internal";
-import { getSingletonPrecacheController } from "../precaching/singletonPrecacheController.js";
-import { getSingletonRouter } from "../routing/singletonRouter.js";
-import { Serwist, type SerwistInstallOptions } from "./Serwist.js";
-
-/**
- * Options for `installSerwist`.
- *
- * @deprecated
- */
-export type InstallSerwistOptions = SerwistInstallOptions;
-
-/**
- * Abstracts away the core APIs of Serwist.
- *
- * @param options - `installSerwist` options.
- * @deprecated
- */
-export const installSerwist = (options: InstallSerwistOptions): void => {
-  if (process.env.NODE_ENV !== "production") {
-    logger.warn("'installSerwist' has been deprecated. Please migrate to 'new Serwist().install()'.");
-  }
-  const serwist = new Serwist({
-    precacheController: getSingletonPrecacheController(),
-    router: getSingletonRouter(),
-  });
-  serwist.install(options);
-};

package/src/abstractions/navigationPreload.ts

@@ -1,64 +0,0 @@
-import { logger } from "@serwist/core/internal";
-
-declare const self: ServiceWorkerGlobalScope;
-
-/**
- * Checks whether the current browser supports
- * navigation preloading.
- *
- * @returns
- */
-export const isNavigationPreloadSupported = (): boolean => {
-  return Boolean(self.registration?.navigationPreload);
-};
-
-/**
- * If the browser supports navigation preloading, then this will enable it.
- *
- * @param headerValue Optional. Allows developers to override the value of
- * the `Service-Worker-Navigation-Preload` header which will be sent to the
- * server when making the navigation request.
- */
-export const enableNavigationPreload = (headerValue?: string): void => {
-  if (isNavigationPreloadSupported()) {
-    self.addEventListener("activate", (event) => {
-      event.waitUntil(
-        self.registration.navigationPreload.enable().then(() => {
-          // Defaults to Service-Worker-Navigation-Preload: true if not set.
-          if (headerValue) {
-            void self.registration.navigationPreload.setHeaderValue(headerValue);
-          }
-
-          if (process.env.NODE_ENV !== "production") {
-            logger.log("Navigation preloading is enabled.");
-          }
-        }),
-      );
-    });
-  } else {
-    if (process.env.NODE_ENV !== "production") {
-      logger.log("Navigation preloading is not supported in this browser.");
-    }
-  }
-};
-
-/**
- * If the browser supports navigation preloading, then this will disable it.
- */
-export const disableNavigationPreload = (): void => {
-  if (isNavigationPreloadSupported()) {
-    self.addEventListener("activate", (event: ExtendableEvent) => {
-      event.waitUntil(
-        self.registration.navigationPreload.disable().then(() => {
-          if (process.env.NODE_ENV !== "production") {
-            logger.log("Navigation preloading is disabled.");
-          }
-        }),
-      );
-    });
-  } else {
-    if (process.env.NODE_ENV !== "production") {
-      logger.log("Navigation preloading is not supported in this browser.");
-    }
-  }
-};

package/src/abstractions/registerRuntimeCaching.ts

@@ -1,17 +0,0 @@
-import { registerRoute } from "../routing/registerRoute.js";
-
-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/register-runtime-caching
- * @param runtimeCachingList
- * @returns
- */
-export const registerRuntimeCaching = (...runtimeCachingList: RuntimeCaching[]): void => {
-  for (const entry of runtimeCachingList) {
-    registerRoute(entry.matcher, entry.handler, entry.method);
-  }
-};

package/src/abstractions/types.ts

@@ -1,29 +0,0 @@
-import type { RouteHandler, RouteMatchCallback } from "@serwist/core";
-import type { HTTPMethod } from "../routing/utils/constants.js";
-
-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;
-}

package/src/index.plugins.ts

@@ -1,95 +0,0 @@
-import { BackgroundSyncPlugin } from "./plugins/backgroundSync/BackgroundSyncPlugin.js";
-import type { QueueEntry as BackgroundSyncQueueEntry, QueueOptions as BackgroundSyncQueueOptions } from "./plugins/backgroundSync/Queue.js";
-import { Queue as BackgroundSyncQueue } from "./plugins/backgroundSync/Queue.js";
-import { QueueStore as BackgroundSyncQueueStore } from "./plugins/backgroundSync/QueueStore.js";
-import { StorableRequest } from "./plugins/backgroundSync/StorableRequest.js";
-import { BroadcastCacheUpdate } from "./plugins/broadcastUpdate/BroadcastCacheUpdate.js";
-import { BroadcastUpdatePlugin } from "./plugins/broadcastUpdate/BroadcastUpdatePlugin.js";
-import {
-  CACHE_UPDATED_MESSAGE_META as BROADCAST_UPDATE_MESSAGE_META,
-  CACHE_UPDATED_MESSAGE_TYPE as BROADCAST_UPDATE_MESSAGE_TYPE,
-  defaultHeadersToCheck as BROADCAST_UPDATE_DEFAULT_HEADERS,
-} from "./plugins/broadcastUpdate/constants.js";
-import { responsesAreSame } from "./plugins/broadcastUpdate/responsesAreSame.js";
-import type { BroadcastCacheUpdateOptions, BroadcastMessage, BroadcastPayload, BroadcastPayloadGenerator } from "./plugins/broadcastUpdate/types.js";
-import type { CacheableResponseOptions } from "./plugins/cacheableResponse/CacheableResponse.js";
-import { CacheableResponse } from "./plugins/cacheableResponse/CacheableResponse.js";
-import { CacheableResponsePlugin } from "./plugins/cacheableResponse/CacheableResponsePlugin.js";
-import { CacheExpiration } from "./plugins/expiration/CacheExpiration.js";
-import type { ExpirationPluginOptions } from "./plugins/expiration/ExpirationPlugin.js";
-import { ExpirationPlugin } from "./plugins/expiration/ExpirationPlugin.js";
-import type { GoogleAnalyticsInitializeOptions } from "./plugins/googleAnalytics/initialize.js";
-import { initialize as initializeGoogleAnalytics } from "./plugins/googleAnalytics/initialize.js";
-import type { PrecacheFallbackEntry, PrecacheFallbackPluginOptions } from "./plugins/precaching/PrecacheFallbackPlugin.js";
-import { PrecacheFallbackPlugin } from "./plugins/precaching/PrecacheFallbackPlugin.js";
-import { RangeRequestsPlugin } from "./plugins/rangeRequests/RangeRequestsPlugin.js";
-import { createPartialResponse } from "./plugins/rangeRequests/createPartialResponse.js";
-
-// See https://github.com/GoogleChrome/workbox/issues/2946
-interface SyncManager {
-  getTags(): Promise<string[]>;
-  register(tag: string): Promise<void>;
-}
-
-declare global {
-  interface ServiceWorkerRegistration {
-    readonly sync: SyncManager;
-  }
-
-  interface SyncEvent extends ExtendableEvent {
-    readonly lastChance: boolean;
-    readonly tag: string;
-  }
-
-  interface ServiceWorkerGlobalScopeEventMap {
-    sync: SyncEvent;
-  }
-}
-
-export {
-  // Background synchronization
-  BackgroundSyncPlugin,
-  BackgroundSyncQueue,
-  BackgroundSyncQueueStore,
-  StorableRequest,
-  // Update broadcasting
-  BroadcastCacheUpdate,
-  BroadcastUpdatePlugin,
-  responsesAreSame,
-  BROADCAST_UPDATE_MESSAGE_META,
-  BROADCAST_UPDATE_MESSAGE_TYPE,
-  BROADCAST_UPDATE_DEFAULT_HEADERS,
-  // Cacheable responses
-  CacheableResponse,
-  CacheableResponsePlugin,
-  // Expiration
-  CacheExpiration,
-  ExpirationPlugin,
-  // Precaching
-  PrecacheFallbackPlugin,
-  // Range requests
-  createPartialResponse,
-  RangeRequestsPlugin,
-  // Google Analytics
-  initializeGoogleAnalytics,
-};
-
-export type {
-  // Background synchronization
-  BackgroundSyncQueueOptions,
-  BackgroundSyncQueueEntry,
-  // Update broadcasting
-  BroadcastCacheUpdateOptions,
-  BroadcastPayload,
-  BroadcastPayloadGenerator,
-  BroadcastMessage,
-  // Cacheable responses
-  CacheableResponseOptions,
-  // Expiration
-  ExpirationPluginOptions,
-  // Precaching
-  PrecacheFallbackEntry,
-  PrecacheFallbackPluginOptions,
-  // Google Analytics
-  GoogleAnalyticsInitializeOptions,
-};

package/src/index.precaching.ts

@@ -1,41 +0,0 @@
-import { PrecacheController } from "./precaching/PrecacheController.js";
-import { PrecacheRoute } from "./precaching/PrecacheRoute.js";
-import { PrecacheStrategy } from "./precaching/PrecacheStrategy.js";
-import { addPlugins } from "./precaching/addPlugins.js";
-import { addRoute } from "./precaching/addRoute.js";
-import { cleanupOutdatedCaches } from "./precaching/cleanupOutdatedCaches.js";
-import { createHandlerBoundToURL } from "./precaching/createHandlerBoundToURL.js";
-import { getCacheKeyForURL } from "./precaching/getCacheKeyForURL.js";
-import { matchPrecache } from "./precaching/matchPrecache.js";
-import { precache } from "./precaching/precache.js";
-import { precacheAndRoute } from "./precaching/precacheAndRoute.js";
-import { getSingletonPrecacheController, setSingletonPrecacheController } from "./precaching/singletonPrecacheController.js";
-
-/**
- * Most consumers of this module will want to use the
- * `@serwist/sw/precaching.precacheAndRoute`
- * method to add assets to the cache and respond to network requests with these
- * cached assets.
- *
- * If you require more control over caching and routing, you can use the
- * `@serwist/precaching.PrecacheController`
- * interface.
- */
-
-export {
-  addPlugins,
-  addRoute,
-  cleanupOutdatedCaches,
-  createHandlerBoundToURL,
-  getCacheKeyForURL,
-  matchPrecache,
-  precache,
-  precacheAndRoute,
-  PrecacheController,
-  PrecacheRoute,
-  PrecacheStrategy,
-  getSingletonPrecacheController,
-  setSingletonPrecacheController,
-};
-
-export type * from "./precaching/types.js";

package/src/index.routing.ts

@@ -1,28 +0,0 @@
-import type { NavigationRouteMatchOptions } from "./routing/NavigationRoute.js";
-import { NavigationRoute } from "./routing/NavigationRoute.js";
-import { RegExpRoute } from "./routing/RegExpRoute.js";
-import { Route } from "./routing/Route.js";
-import { Router } from "./routing/Router.js";
-import { parseRoute } from "./routing/parseRoute.js";
-import { registerRoute } from "./routing/registerRoute.js";
-import { setCatchHandler } from "./routing/setCatchHandler.js";
-import { setDefaultHandler } from "./routing/setDefaultHandler.js";
-import { getSingletonRouter, setSingletonRouter } from "./routing/singletonRouter.js";
-import { unregisterRoute } from "./routing/unregisterRoute.js";
-import type { HTTPMethod } from "./routing/utils/constants.js";
-
-export {
-  NavigationRoute,
-  RegExpRoute,
-  parseRoute,
-  registerRoute,
-  Route,
-  Router,
-  setCatchHandler,
-  setDefaultHandler,
-  getSingletonRouter,
-  setSingletonRouter,
-  unregisterRoute,
-};
-
-export type { HTTPMethod, NavigationRouteMatchOptions };

package/src/index.strategies.ts

@@ -1,26 +0,0 @@
-import { CacheFirst } from "./strategies/CacheFirst.js";
-import { CacheOnly } from "./strategies/CacheOnly.js";
-import type { NetworkFirstOptions } from "./strategies/NetworkFirst.js";
-import { NetworkFirst } from "./strategies/NetworkFirst.js";
-import type { NetworkOnlyOptions } from "./strategies/NetworkOnly.js";
-import { NetworkOnly } from "./strategies/NetworkOnly.js";
-import { StaleWhileRevalidate } from "./strategies/StaleWhileRevalidate.js";
-import type { StrategyOptions } from "./strategies/Strategy.js";
-import { Strategy } from "./strategies/Strategy.js";
-import { StrategyHandler } from "./strategies/StrategyHandler.js";
-
-// See https://github.com/GoogleChrome/workbox/issues/2946
-declare global {
-  interface FetchEvent {
-    // See https://github.com/GoogleChrome/workbox/issues/2974
-    readonly preloadResponse: Promise<any>;
-  }
-}
-
-/**
- * There are common caching strategies that most service workers will need
- * and use. This module provides simple implementations of these strategies.
- */
-export { CacheFirst, CacheOnly, NetworkFirst, NetworkOnly, StaleWhileRevalidate, Strategy, StrategyHandler };
-
-export type { NetworkFirstOptions, NetworkOnlyOptions, StrategyOptions };

package/src/plugins/backgroundSync/BackgroundSyncPlugin.ts

@@ -1,39 +0,0 @@
-/*
-  Copyright 2018 Google LLC
-
-  Use of this source code is governed by an MIT-style
-  license that can be found in the LICENSE file or at
-  https://opensource.org/licenses/MIT.
-*/
-
-import type { FetchDidFailCallbackParam, SerwistPlugin } from "@serwist/core";
-
-import type { QueueOptions } from "./Queue.js";
-import { Queue } from "./Queue.js";
-
-/**
- * A class implementing the `fetchDidFail` lifecycle callback. This makes it
- * easier to add failed requests to a background sync Queue.
- */
-export class BackgroundSyncPlugin implements SerwistPlugin {
-  private readonly _queue: Queue;
-
-  /**
-   * @param name See the `@serwist/sw/plugins.BackgroundSyncQueue`
-   * documentation for parameter details.
-   * @param options See the `@serwist/sw/plugins.BackgroundSyncQueue`
-   * documentation for parameter details.
-   * @see https://serwist.pages.dev/docs/background-sync/queue
-   */
-  constructor(name: string, options?: QueueOptions) {
-    this._queue = new Queue(name, options);
-  }
-
-  /**
-   * @param options
-   * @private
-   */
-  async fetchDidFail({ request }: FetchDidFailCallbackParam) {
-    await this._queue.pushRequest({ request });
-  }
-}