@serwist/sw 9.0.0-preview.17 → 9.0.0-preview.19

package/src/index.plugins.ts

@@ -1,46 +1,95 @@
-import type { QueueEntry, QueueOptions } from "@serwist/background-sync";
-import { BackgroundSyncPlugin, Queue, QueueStore, StorableRequest } from "@serwist/background-sync";
-import type { BroadcastCacheUpdateOptions, BroadcastMessage, BroadcastPayload, BroadcastPayloadGenerator } from "@serwist/broadcast-update";
+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 {
-  BroadcastCacheUpdate,
-  BroadcastUpdatePlugin,
   CACHE_UPDATED_MESSAGE_META as BROADCAST_UPDATE_MESSAGE_META,
   CACHE_UPDATED_MESSAGE_TYPE as BROADCAST_UPDATE_MESSAGE_TYPE,
   defaultHeadersToCheck as BROADCAST_UPDATE_DEFAULT_HEADERS,
-  responsesAreSame,
-} from "@serwist/broadcast-update";
-import type { CacheableResponseOptions } from "@serwist/cacheable-response";
-import { CacheableResponse, CacheableResponsePlugin } from "@serwist/cacheable-response";
-import type { ExpirationPluginOptions } from "@serwist/expiration";
-import { CacheExpiration, ExpirationPlugin } from "@serwist/expiration";
-import { RangeRequestsPlugin, createPartialResponse } from "@serwist/range-requests";
+} 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,
-  Queue as BackgroundSyncQueue,
-  QueueStore as BackgroundSyncQueueStore,
+  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 {
-  QueueOptions as BackgroundSyncQueueOptions,
-  QueueEntry as BackgroundSyncQueueEntry,
+  // 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

@@ -0,0 +1,38 @@
+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";
+
+/**
+ * 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,
+};
+
+export type * from "./precaching/types.js";

package/src/index.routing.ts

@@ -0,0 +1,14 @@
+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 { registerRoute } from "./routing/registerRoute.js";
+import { setCatchHandler } from "./routing/setCatchHandler.js";
+import { setDefaultHandler } from "./routing/setDefaultHandler.js";
+import { unregisterRoute } from "./routing/unregisterRoute.js";
+import type { HTTPMethod } from "./routing/utils/constants.js";
+
+export { NavigationRoute, RegExpRoute, registerRoute, Route, Router, setCatchHandler, setDefaultHandler, unregisterRoute };
+
+export type { HTTPMethod, NavigationRouteMatchOptions };

package/src/index.strategies.ts

@@ -1,6 +1,26 @@
-import type { NetworkFirstOptions, NetworkOnlyOptions, StrategyOptions } from "@serwist/strategies";
-import { CacheFirst, CacheOnly, NetworkFirst, NetworkOnly, StaleWhileRevalidate, Strategy, StrategyHandler } from "@serwist/strategies";
+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/index.ts

@@ -1,13 +1,25 @@
-import { Serwist, type SerwistOptions, type SerwistInstallOptions } from "./Serwist.js";
-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";
+import { Serwist, type SerwistInstallOptions, type SerwistOptions } from "./abstractions/Serwist.js";
+import { disableDevLogs } from "./abstractions/disableDevLogs.js";
+import type { FallbackEntry, FallbackMatcher, FallbacksOptions } from "./abstractions/fallbacks.js";
+import { fallbacks } from "./abstractions/fallbacks.js";
+import { type HandlePrecachingOptions, handlePrecaching } from "./abstractions/handlePrecaching.js";
+import { type InstallSerwistOptions, installSerwist } from "./abstractions/installSerwist.js";
+import { disableNavigationPreload, enableNavigationPreload, isNavigationPreloadSupported } from "./abstractions/navigationPreload.js";
+import { registerRuntimeCaching } from "./abstractions/registerRuntimeCaching.js";
+import type { RuntimeCaching } from "./abstractions/types.js";
 
-export { disableDevLogs, fallbacks, handlePrecaching, installSerwist, Serwist, registerRuntimeCaching };
+export {
+  disableDevLogs,
+  fallbacks,
+  handlePrecaching,
+  installSerwist,
+  Serwist,
+  registerRuntimeCaching,
+  // Navigation preloading
+  disableNavigationPreload,
+  enableNavigationPreload,
+  isNavigationPreloadSupported,
+};
 export type {
   FallbackEntry,
   FallbackMatcher,

package/src/plugins/backgroundSync/BackgroundSyncPlugin.ts

@@ -0,0 +1,39 @@
+/*
+  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 });
+  }
+}