serwist 9.1.0-preview.0 → 10.0.0-preview.2

package/src/index.ts

@@ -1,6 +1,5 @@
 import type { NavigationRouteMatchOptions } from "./NavigationRoute.js";
 import { NavigationRoute } from "./NavigationRoute.js";
-import { PrecacheRoute } from "./PrecacheRoute.js";
 import { RegExpRoute } from "./RegExpRoute.js";
 import { Route } from "./Route.js";
 import { Serwist, type SerwistOptions } from "./Serwist.js";
@@ -8,118 +7,94 @@ import { cacheNames } from "./cacheNames.js";
 import type { HTTPMethod } from "./constants.js";
 import { copyResponse } from "./copyResponse.js";
 import { disableDevLogs } from "./disableDevLogs.js";
-import { BackgroundSyncPlugin } from "./lib/backgroundSync/BackgroundSyncPlugin.js";
-import type { BackgroundSyncQueueEntry, BackgroundSyncQueueOptions } from "./lib/backgroundSync/BackgroundSyncQueue.js";
-import { BackgroundSyncQueue } from "./lib/backgroundSync/BackgroundSyncQueue.js";
-import { BackgroundSyncQueueStore } from "./lib/backgroundSync/BackgroundSyncQueueStore.js";
-import { StorableRequest } from "./lib/backgroundSync/StorableRequest.js";
-import { BroadcastCacheUpdate } from "./lib/broadcastUpdate/BroadcastCacheUpdate.js";
-import { BroadcastUpdatePlugin } from "./lib/broadcastUpdate/BroadcastUpdatePlugin.js";
-import { BROADCAST_UPDATE_DEFAULT_HEADERS } from "./lib/broadcastUpdate/constants.js";
-import { responsesAreSame } from "./lib/broadcastUpdate/responsesAreSame.js";
-import type { BroadcastCacheUpdateOptions, BroadcastMessage, BroadcastPayload, BroadcastPayloadGenerator } from "./lib/broadcastUpdate/types.js";
-import { CacheableResponse } from "./lib/cacheableResponse/CacheableResponse.js";
-import type { CacheableResponseOptions } from "./lib/cacheableResponse/CacheableResponse.js";
-import { CacheableResponsePlugin } from "./lib/cacheableResponse/CacheableResponsePlugin.js";
-import { CacheExpiration } from "./lib/expiration/CacheExpiration.js";
-import type { ExpirationPluginOptions } from "./lib/expiration/ExpirationPlugin.js";
-import { ExpirationPlugin } from "./lib/expiration/ExpirationPlugin.js";
-import { initializeGoogleAnalytics } from "./lib/googleAnalytics/initializeGoogleAnalytics.js";
-import type { GoogleAnalyticsInitializeOptions } from "./lib/googleAnalytics/initializeGoogleAnalytics.js";
-import type { PrecacheFallbackEntry, PrecacheFallbackPluginOptions } from "./lib/precaching/PrecacheFallbackPlugin.js";
-import { PrecacheFallbackPlugin } from "./lib/precaching/PrecacheFallbackPlugin.js";
-import { RangeRequestsPlugin } from "./lib/rangeRequests/RangeRequestsPlugin.js";
-import { createPartialResponse } from "./lib/rangeRequests/createPartialResponse.js";
-import { CacheFirst } from "./lib/strategies/CacheFirst.js";
-import { CacheOnly } from "./lib/strategies/CacheOnly.js";
-import type { NetworkFirstOptions } from "./lib/strategies/NetworkFirst.js";
-import { NetworkFirst } from "./lib/strategies/NetworkFirst.js";
-import type { NetworkOnlyOptions } from "./lib/strategies/NetworkOnly.js";
-import { NetworkOnly } from "./lib/strategies/NetworkOnly.js";
-import { PrecacheStrategy } from "./lib/strategies/PrecacheStrategy.js";
-import { StaleWhileRevalidate } from "./lib/strategies/StaleWhileRevalidate.js";
-import type { StrategyOptions } from "./lib/strategies/Strategy.js";
-import { Strategy } from "./lib/strategies/Strategy.js";
-import { StrategyHandler } from "./lib/strategies/StrategyHandler.js";
 import { disableNavigationPreload, enableNavigationPreload, isNavigationPreloadSupported } from "./navigationPreload.js";
 import { registerQuotaErrorCallback } from "./registerQuotaErrorCallback.js";
 import { setCacheNameDetails } from "./setCacheNameDetails.js";
 
+// Background synchronizing
 export {
-  // Core
-  Serwist,
-  cacheNames,
-  copyResponse,
-  disableDevLogs,
-  disableNavigationPreload,
-  enableNavigationPreload,
-  isNavigationPreloadSupported,
-  registerQuotaErrorCallback,
-  setCacheNameDetails,
-  // Caching strategies
-  CacheFirst,
-  CacheOnly,
-  NetworkFirst,
-  NetworkOnly,
-  PrecacheStrategy,
-  StaleWhileRevalidate,
-  Strategy,
-  StrategyHandler,
-  // Routing
-  NavigationRoute,
-  PrecacheRoute,
-  RegExpRoute,
-  Route,
-  // Background synchronizing
   BackgroundSyncPlugin,
   BackgroundSyncQueue,
   BackgroundSyncQueueStore,
   StorableRequest,
-  // Broadcasting updates
+  type BackgroundSyncQueueOptions,
+  type BackgroundSyncQueueEntry,
+} from "#lib/backgroundSync/index.js";
+
+// Broadcasting updates
+export {
   BroadcastCacheUpdate,
   BroadcastUpdatePlugin,
   BROADCAST_UPDATE_DEFAULT_HEADERS,
   responsesAreSame,
-  // Setting cacheability criteria
+  type BroadcastCacheUpdateOptions,
+  type BroadcastPayload,
+  type BroadcastPayloadGenerator,
+  type BroadcastMessage,
+} from "#lib/broadcastUpdate/index.js";
+
+// Setting cacheability criteria
+export {
   CacheableResponse,
   CacheableResponsePlugin,
-  // Expiring outdated responses
+  type CacheableResponseOptions,
+} from "#lib/cacheableResponse/index.js";
+
+// Controllers
+export { PrecacheStrategy, PrecacheRoute, RuntimeCacheController } from "#lib/controllers/index.js";
+
+// Expiring outdated responses
+export {
   CacheExpiration,
   ExpirationPlugin,
-  // Precaching
+  type ExpirationPluginOptions,
+} from "#lib/expiration/index.js";
+
+// Google Analytics
+export { initializeGoogleAnalytics, type GoogleAnalyticsInitializeOptions } from "#lib/googleAnalytics/index.js";
+
+// Precaching
+export {
   PrecacheFallbackPlugin,
-  // Google Analytics
-  initializeGoogleAnalytics,
-  // Handling range requests
+  type PrecacheFallbackEntry,
+  type PrecacheFallbackPluginOptions,
+} from "#lib/precaching/index.js";
+
+// Handling range requests
+export {
   createPartialResponse,
   RangeRequestsPlugin,
-};
-export type {
-  // Core
-  HTTPMethod,
-  SerwistOptions,
-  // Caching strategies
-  NetworkFirstOptions,
-  NetworkOnlyOptions,
-  StrategyOptions,
+} from "#lib/rangeRequests/index.js";
+
+// Built-in caching strategies
+export {
+  CacheFirst,
+  CacheOnly,
+  NetworkFirst,
+  NetworkOnly,
+  StaleWhileRevalidate,
+  Strategy,
+  StrategyHandler,
+  type NetworkFirstOptions,
+  type NetworkOnlyOptions,
+  type StrategyOptions,
+} from "#lib/strategies/index.js";
+
+// Core
+export {
+  Serwist,
+  cacheNames,
+  copyResponse,
+  disableDevLogs,
+  disableNavigationPreload,
+  enableNavigationPreload,
+  isNavigationPreloadSupported,
+  registerQuotaErrorCallback,
+  setCacheNameDetails,
   // Routing
-  NavigationRouteMatchOptions,
-  // Background synchronizing
-  BackgroundSyncQueueOptions,
-  BackgroundSyncQueueEntry,
-  // Broadcasting updates
-  BroadcastCacheUpdateOptions,
-  BroadcastPayload,
-  BroadcastPayloadGenerator,
-  BroadcastMessage,
-  // Setting cacheability criteria
-  CacheableResponseOptions,
-  // Expiring outdated responses
-  ExpirationPluginOptions,
-  // Precaching
-  PrecacheFallbackEntry,
-  PrecacheFallbackPluginOptions,
-  // Google Analytics
-  GoogleAnalyticsInitializeOptions,
+  NavigationRoute,
+  RegExpRoute,
+  Route,
 };
+export type { HTTPMethod, SerwistOptions, NavigationRouteMatchOptions };
 export type * from "./types.js";

package/src/lib/backgroundSync/BackgroundSyncPlugin.ts

@@ -6,7 +6,7 @@
   https://opensource.org/licenses/MIT.
 */
 
-import type { FetchDidFailCallbackParam, SerwistPlugin } from "../../types.js";
+import type { FetchDidFailCallbackParam, StrategyPlugin } from "../../types.js";
 import type { BackgroundSyncQueueOptions } from "./BackgroundSyncQueue.js";
 import { BackgroundSyncQueue } from "./BackgroundSyncQueue.js";
 
@@ -14,7 +14,7 @@ import { BackgroundSyncQueue } from "./BackgroundSyncQueue.js";
  * A class implementing the `fetchDidFail` lifecycle callback. This makes it
  * easier to add failed requests to a {@linkcode BackgroundSyncQueue}.
  */
-export class BackgroundSyncPlugin implements SerwistPlugin {
+export class BackgroundSyncPlugin implements StrategyPlugin {
   private readonly _queue: BackgroundSyncQueue;
 
   /**

package/src/lib/backgroundSync/BackgroundSyncQueue.ts

@@ -1,4 +1,3 @@
-import { SerwistError } from "../../utils/SerwistError.js";
 /*
   Copyright 2018 Google LLC
 
@@ -6,9 +5,10 @@ import { SerwistError } from "../../utils/SerwistError.js";
   license that can be found in the LICENSE file or at
   https://opensource.org/licenses/MIT.
 */
-import { assert } from "../../utils/assert.js";
-import { getFriendlyURL } from "../../utils/getFriendlyURL.js";
-import { logger } from "../../utils/logger.js";
+import { SerwistError } from "#utils/SerwistError.js";
+import { assert } from "#utils/assert.js";
+import { getFriendlyURL } from "#utils/getFriendlyURL.js";
+import { logger } from "#utils/logger.js";
 import type { BackgroundSyncQueueStoreEntry, UnidentifiedQueueStoreEntry } from "./BackgroundSyncQueueDb.js";
 import { BackgroundSyncQueueStore } from "./BackgroundSyncQueueStore.js";
 import { StorableRequest } from "./StorableRequest.js";

package/src/lib/backgroundSync/BackgroundSyncQueueStore.ts

@@ -5,7 +5,7 @@
   license that can be found in the LICENSE file or at
   https://opensource.org/licenses/MIT.
 */
-import { assert } from "../../utils/assert.js";
+import { assert } from "#utils/assert.js";
 import type { BackgroundSyncQueueStoreEntry, UnidentifiedQueueStoreEntry } from "./BackgroundSyncQueueDb.js";
 import { BackgroundSyncQueueDb } from "./BackgroundSyncQueueDb.js";
 

package/src/lib/backgroundSync/StorableRequest.ts

@@ -6,8 +6,8 @@
   https://opensource.org/licenses/MIT.
 */
 
+import { assert } from "#utils/assert.js";
 import type { MapLikeObject } from "../../types.js";
-import { assert } from "../../utils/assert.js";
 
 type SerializableProperties = "method" | "referrer" | "referrerPolicy" | "mode" | "credentials" | "cache" | "redirect" | "integrity" | "keepalive";
 

package/src/lib/backgroundSync/index.ts

@@ -0,0 +1,5 @@
+export { BackgroundSyncPlugin } from "./BackgroundSyncPlugin.js";
+export type { BackgroundSyncQueueEntry, BackgroundSyncQueueOptions } from "./BackgroundSyncQueue.js";
+export { BackgroundSyncQueue } from "./BackgroundSyncQueue.js";
+export { BackgroundSyncQueueStore } from "./BackgroundSyncQueueStore.js";
+export { StorableRequest } from "./StorableRequest.js";

package/src/lib/broadcastUpdate/BroadcastCacheUpdate.ts

@@ -6,11 +6,11 @@
   https://opensource.org/licenses/MIT.
 */
 
+import { assert } from "#utils/assert.js";
+import { logger } from "#utils/logger.js";
+import { resultingClientExists } from "#utils/resultingClientExists.js";
+import { timeout } from "#utils/timeout.js";
 import type { CacheDidUpdateCallbackParam } from "../../types.js";
-import { assert } from "../../utils/assert.js";
-import { logger } from "../../utils/logger.js";
-import { resultingClientExists } from "../../utils/resultingClientExists.js";
-import { timeout } from "../../utils/timeout.js";
 import {
   BROADCAST_UPDATE_DEFAULT_HEADERS,
   BROADCAST_UPDATE_DEFAULT_NOTIFY,

package/src/lib/broadcastUpdate/BroadcastUpdatePlugin.ts

@@ -6,7 +6,7 @@
   https://opensource.org/licenses/MIT.
 */
 
-import type { CacheDidUpdateCallbackParam, SerwistPlugin } from "../../types.js";
+import type { CacheDidUpdateCallbackParam, StrategyPlugin } from "../../types.js";
 import { BroadcastCacheUpdate } from "./BroadcastCacheUpdate.js";
 import type { BroadcastCacheUpdateOptions } from "./types.js";
 
@@ -14,7 +14,7 @@ import type { BroadcastCacheUpdateOptions } from "./types.js";
  * A class implementing the `cacheDidUpdate` lifecycle callback. It will automatically
  * broadcast a message whenever a cached response is updated.
  */
-export class BroadcastUpdatePlugin implements SerwistPlugin {
+export class BroadcastUpdatePlugin implements StrategyPlugin {
   private readonly _broadcastUpdate: BroadcastCacheUpdate;
 
   /**

package/src/lib/broadcastUpdate/index.ts

@@ -0,0 +1,5 @@
+export { BroadcastCacheUpdate } from "./BroadcastCacheUpdate.js";
+export { BroadcastUpdatePlugin } from "./BroadcastUpdatePlugin.js";
+export { BROADCAST_UPDATE_DEFAULT_HEADERS } from "./constants.js";
+export { responsesAreSame } from "./responsesAreSame.js";
+export type { BroadcastCacheUpdateOptions, BroadcastMessage, BroadcastPayload, BroadcastPayloadGenerator } from "./types.js";

package/src/lib/broadcastUpdate/responsesAreSame.ts

@@ -6,8 +6,8 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { SerwistError } from "../../utils/SerwistError.js";
-import { logger } from "../../utils/logger.js";
+import { SerwistError } from "#utils/SerwistError.js";
+import { logger } from "#utils/logger.js";
 
 /**
  * Given two responses, compares several header values to see if they are

package/src/lib/cacheableResponse/CacheableResponse.ts

@@ -6,10 +6,10 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { SerwistError } from "../../utils/SerwistError.js";
-import { assert } from "../../utils/assert.js";
-import { getFriendlyURL } from "../../utils/getFriendlyURL.js";
-import { logger } from "../../utils/logger.js";
+import { SerwistError } from "#utils/SerwistError.js";
+import { assert } from "#utils/assert.js";
+import { getFriendlyURL } from "#utils/getFriendlyURL.js";
+import { logger } from "#utils/logger.js";
 
 export interface CacheableResponseOptions {
   /**

package/src/lib/cacheableResponse/CacheableResponsePlugin.ts

@@ -6,7 +6,7 @@
   https://opensource.org/licenses/MIT.
 */
 
-import type { SerwistPlugin } from "../../types.js";
+import type { StrategyPlugin } from "../../types.js";
 import type { CacheableResponseOptions } from "./CacheableResponse.js";
 import { CacheableResponse } from "./CacheableResponse.js";
 
@@ -15,7 +15,7 @@ import { CacheableResponse } from "./CacheableResponse.js";
  * easier to add in cacheability checks to requests made via Serwist's built-in
  * strategies.
  */
-export class CacheableResponsePlugin implements SerwistPlugin {
+export class CacheableResponsePlugin implements StrategyPlugin {
   private readonly _cacheableResponse: CacheableResponse;
 
   /**
@@ -36,7 +36,7 @@ export class CacheableResponsePlugin implements SerwistPlugin {
    * @returns
    * @private
    */
-  cacheWillUpdate: SerwistPlugin["cacheWillUpdate"] = async ({ response }) => {
+  cacheWillUpdate: StrategyPlugin["cacheWillUpdate"] = async ({ response }) => {
     if (this._cacheableResponse.isResponseCacheable(response)) {
       return response;
     }

package/src/lib/cacheableResponse/index.ts

@@ -0,0 +1,3 @@
+export { CacheableResponse } from "./CacheableResponse.js";
+export type { CacheableResponseOptions } from "./CacheableResponse.js";
+export { CacheableResponsePlugin } from "./CacheableResponsePlugin.js";

package/src/{legacy/utils → lib/controllers/PrecacheController}/PrecacheCacheKeyPlugin.ts

@@ -5,9 +5,8 @@
   license that can be found in the LICENSE file or at
   https://opensource.org/licenses/MIT.
 */
-
-import type { SerwistPlugin, SerwistPluginCallbackParam } from "../../types.js";
-import type { PrecacheController } from "../PrecacheController.js";
+import type { StrategyPlugin, StrategyPluginCallbackParam } from "../../../types.js";
+import type { PrecacheController } from "./PrecacheController.js";
 
 /**
  * A plugin, designed to be used with PrecacheController, to translate URLs into
@@ -15,17 +14,17 @@ import type { PrecacheController } from "../PrecacheController.js";
  *
  * @private
  */
-export class PrecacheCacheKeyPlugin implements SerwistPlugin {
+export class PrecacheCacheKeyPlugin implements StrategyPlugin {
   private readonly _precacheController: PrecacheController;
 
   constructor({ precacheController }: { precacheController: PrecacheController }) {
     this._precacheController = precacheController;
   }
 
-  cacheKeyWillBeUsed: SerwistPlugin["cacheKeyWillBeUsed"] = async ({ request, params }: SerwistPluginCallbackParam["cacheKeyWillBeUsed"]) => {
+  cacheKeyWillBeUsed: StrategyPlugin["cacheKeyWillBeUsed"] = async ({ request, params }: StrategyPluginCallbackParam["cacheKeyWillBeUsed"]) => {
     // Params is type any, can't change right now.
     /* eslint-disable */
-    const cacheKey = params?.cacheKey || this._precacheController.getCacheKeyForURL(request.url);
+    const cacheKey = params?.cacheKey || this._precacheController.getPrecacheKeyForUrl(request.url);
     /* eslint-enable */
 
     return cacheKey ? new Request(cacheKey, { headers: request.headers }) : request;