@serwist/broadcast-update 9.0.0-preview.17 → 9.0.0-preview.19

package/dist/index.d.ts

@@ -1,8 +1,3 @@
-import { BroadcastCacheUpdate } from "./BroadcastCacheUpdate.js";
-import { BroadcastUpdatePlugin } from "./BroadcastUpdatePlugin.js";
-import { CACHE_UPDATED_MESSAGE_META, CACHE_UPDATED_MESSAGE_TYPE, defaultHeadersToCheck } from "./constants.js";
-import { responsesAreSame } from "./responsesAreSame.js";
-import type { BroadcastCacheUpdateOptions, BroadcastMessage, BroadcastPayload, BroadcastPayloadGenerator } from "./types.js";
-export { BroadcastCacheUpdate, BroadcastUpdatePlugin, responsesAreSame, CACHE_UPDATED_MESSAGE_META, CACHE_UPDATED_MESSAGE_TYPE, defaultHeadersToCheck, };
-export type { BroadcastCacheUpdateOptions, BroadcastPayload, BroadcastPayloadGenerator, BroadcastMessage };
+export { BroadcastCacheUpdate, BroadcastUpdatePlugin, responsesAreSame, BROADCAST_UPDATE_MESSAGE_META as CACHE_UPDATED_MESSAGE_META, BROADCAST_UPDATE_MESSAGE_TYPE as CACHE_UPDATED_MESSAGE_TYPE, BROADCAST_UPDATE_DEFAULT_HEADERS as defaultHeadersToCheck, } from "@serwist/sw/plugins";
+export type { BroadcastCacheUpdateOptions, BroadcastPayload, BroadcastPayloadGenerator, BroadcastMessage } from "@serwist/sw/plugins";
 //# 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":"AAQA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAC/G,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,KAAK,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAE7H,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,0BAA0B,EAC1B,0BAA0B,EAC1B,qBAAqB,GACtB,CAAC;AAEF,YAAY,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,6BAA6B,IAAI,0BAA0B,EAC3D,6BAA6B,IAAI,0BAA0B,EAC3D,gCAAgC,IAAI,qBAAqB,GAC1D,MAAM,qBAAqB,CAAC;AAC7B,YAAY,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -1,121 +1 @@
-import { SerwistError, logger, assert, resultingClientExists, timeout } from '@serwist/core/internal';
-
-const CACHE_UPDATED_MESSAGE_TYPE = "CACHE_UPDATED";
-const CACHE_UPDATED_MESSAGE_META = "serwist-broadcast-update";
-const defaultNotifyAllClients = true;
-const defaultHeadersToCheck = [
-    "content-length",
-    "etag",
-    "last-modified"
-];
-
-const responsesAreSame = (firstResponse, secondResponse, headersToCheck)=>{
-    if (process.env.NODE_ENV !== "production") {
-        if (!(firstResponse instanceof Response && secondResponse instanceof Response)) {
-            throw new SerwistError("invalid-responses-are-same-args");
-        }
-    }
-    const atLeastOneHeaderAvailable = headersToCheck.some((header)=>{
-        return firstResponse.headers.has(header) && secondResponse.headers.has(header);
-    });
-    if (!atLeastOneHeaderAvailable) {
-        if (process.env.NODE_ENV !== "production") {
-            logger.warn("Unable to determine where the response has been updated because none of the headers that would be checked are present.");
-            logger.debug("Attempting to compare the following: ", firstResponse, secondResponse, headersToCheck);
-        }
-        return true;
-    }
-    return headersToCheck.every((header)=>{
-        const headerStateComparison = firstResponse.headers.has(header) === secondResponse.headers.has(header);
-        const headerValueComparison = firstResponse.headers.get(header) === secondResponse.headers.get(header);
-        return headerStateComparison && headerValueComparison;
-    });
-};
-
-const isSafari = typeof navigator !== "undefined" && /^((?!chrome|android).)*safari/i.test(navigator.userAgent);
-const defaultPayloadGenerator = (data)=>{
-    return {
-        cacheName: data.cacheName,
-        updatedURL: data.request.url
-    };
-};
-class BroadcastCacheUpdate {
-    _headersToCheck;
-    _generatePayload;
-    _notifyAllClients;
-    constructor({ generatePayload, headersToCheck, notifyAllClients } = {}){
-        this._headersToCheck = headersToCheck || defaultHeadersToCheck;
-        this._generatePayload = generatePayload || defaultPayloadGenerator;
-        this._notifyAllClients = notifyAllClients ?? defaultNotifyAllClients;
-    }
-    async notifyIfUpdated(options) {
-        if (process.env.NODE_ENV !== "production") {
-            assert.isType(options.cacheName, "string", {
-                moduleName: "@serwist/broadcast-update",
-                className: "BroadcastCacheUpdate",
-                funcName: "notifyIfUpdated",
-                paramName: "cacheName"
-            });
-            assert.isInstance(options.newResponse, Response, {
-                moduleName: "@serwist/broadcast-update",
-                className: "BroadcastCacheUpdate",
-                funcName: "notifyIfUpdated",
-                paramName: "newResponse"
-            });
-            assert.isInstance(options.request, Request, {
-                moduleName: "@serwist/broadcast-update",
-                className: "BroadcastCacheUpdate",
-                funcName: "notifyIfUpdated",
-                paramName: "request"
-            });
-        }
-        if (!options.oldResponse) {
-            return;
-        }
-        if (!responsesAreSame(options.oldResponse, options.newResponse, this._headersToCheck)) {
-            if (process.env.NODE_ENV !== "production") {
-                logger.log("Newer response found (and cached) for:", options.request.url);
-            }
-            const messageData = {
-                type: CACHE_UPDATED_MESSAGE_TYPE,
-                meta: CACHE_UPDATED_MESSAGE_META,
-                payload: this._generatePayload(options)
-            };
-            if (options.request.mode === "navigate") {
-                let resultingClientId;
-                if (options.event instanceof FetchEvent) {
-                    resultingClientId = options.event.resultingClientId;
-                }
-                const resultingWin = await resultingClientExists(resultingClientId);
-                if (!resultingWin || isSafari) {
-                    await timeout(3500);
-                }
-            }
-            if (this._notifyAllClients) {
-                const windows = await self.clients.matchAll({
-                    type: "window"
-                });
-                for (const win of windows){
-                    win.postMessage(messageData);
-                }
-            } else {
-                if (options.event instanceof FetchEvent) {
-                    const client = await self.clients.get(options.event.clientId);
-                    client?.postMessage(messageData);
-                }
-            }
-        }
-    }
-}
-
-class BroadcastUpdatePlugin {
-    _broadcastUpdate;
-    constructor(options){
-        this._broadcastUpdate = new BroadcastCacheUpdate(options);
-    }
-    cacheDidUpdate(options) {
-        void this._broadcastUpdate.notifyIfUpdated(options);
-    }
-}
-
-export { BroadcastCacheUpdate, BroadcastUpdatePlugin, CACHE_UPDATED_MESSAGE_META, CACHE_UPDATED_MESSAGE_TYPE, defaultHeadersToCheck, responsesAreSame };
+export { BroadcastCacheUpdate, BroadcastUpdatePlugin, BROADCAST_UPDATE_MESSAGE_META as CACHE_UPDATED_MESSAGE_META, BROADCAST_UPDATE_MESSAGE_TYPE as CACHE_UPDATED_MESSAGE_TYPE, BROADCAST_UPDATE_DEFAULT_HEADERS as defaultHeadersToCheck, responsesAreSame } from '@serwist/sw/plugins';

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@serwist/broadcast-update",
-  "version": "9.0.0-preview.17",
+  "version": "9.0.0-preview.19",
   "type": "module",
-  "description": "A module that uses the Broadcast Channel API to announce when a cached response has updated",
+  "description": "A module that uses the Broadcast Channel API to announce when a cached response has updated.",
   "files": [
     "src",
     "dist"
@@ -17,8 +17,8 @@
   ],
   "author": "Google's Web DevRel Team, Serwist's Team",
   "license": "MIT",
-  "repository": "serwist/serwist",
-  "bugs": "https://github.com/serwist/serwist/issues",
+  "repository": "https://gitlab.com/serwist/serwist",
+  "bugs": "https://gitlab.com/serwist/serwist/issues",
   "homepage": "https://serwist.pages.dev",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -29,12 +29,12 @@
     }
   },
   "dependencies": {
-    "@serwist/core": "9.0.0-preview.17"
+    "@serwist/sw": "9.0.0-preview.19"
   },
   "devDependencies": {
     "rollup": "4.13.0",
     "typescript": "5.5.0-dev.20240323",
-    "@serwist/constants": "9.0.0-preview.17"
+    "@serwist/constants": "9.0.0-preview.19"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"

package/src/index.ts

@@ -6,19 +6,12 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { BroadcastCacheUpdate } from "./BroadcastCacheUpdate.js";
-import { BroadcastUpdatePlugin } from "./BroadcastUpdatePlugin.js";
-import { CACHE_UPDATED_MESSAGE_META, CACHE_UPDATED_MESSAGE_TYPE, defaultHeadersToCheck } from "./constants.js";
-import { responsesAreSame } from "./responsesAreSame.js";
-import type { BroadcastCacheUpdateOptions, BroadcastMessage, BroadcastPayload, BroadcastPayloadGenerator } from "./types.js";
-
 export {
   BroadcastCacheUpdate,
   BroadcastUpdatePlugin,
   responsesAreSame,
-  CACHE_UPDATED_MESSAGE_META,
-  CACHE_UPDATED_MESSAGE_TYPE,
-  defaultHeadersToCheck,
-};
-
-export type { BroadcastCacheUpdateOptions, BroadcastPayload, BroadcastPayloadGenerator, BroadcastMessage };
+  BROADCAST_UPDATE_MESSAGE_META as CACHE_UPDATED_MESSAGE_META,
+  BROADCAST_UPDATE_MESSAGE_TYPE as CACHE_UPDATED_MESSAGE_TYPE,
+  BROADCAST_UPDATE_DEFAULT_HEADERS as defaultHeadersToCheck,
+} from "@serwist/sw/plugins";
+export type { BroadcastCacheUpdateOptions, BroadcastPayload, BroadcastPayloadGenerator, BroadcastMessage } from "@serwist/sw/plugins";

package/dist/BroadcastCacheUpdate.d.ts

@@ -1,45 +0,0 @@
-import type { CacheDidUpdateCallbackParam } from "@serwist/core";
-import type { BroadcastCacheUpdateOptions } from "./types.js";
-/**
- * A class that uses the `postMessage()` API to inform any open windows/tabs when
- * a cached response has been updated.
- *
- * For efficiency's sake, the underlying response bodies are not compared;
- * only specific response headers are checked.
- */
-export declare class BroadcastCacheUpdate {
-    private readonly _headersToCheck;
-    private readonly _generatePayload;
-    private readonly _notifyAllClients;
-    /**
-     * Construct a BroadcastCacheUpdate instance with a specific `channelName` to
-     * broadcast messages on
-     *
-     * @param options
-     */
-    constructor({ generatePayload, headersToCheck, notifyAllClients }?: BroadcastCacheUpdateOptions);
-    /**
-     * Compares two responses and sends a message (via `postMessage()`) to all window clients if the
-     * responses differ. Neither of the Responses can be opaque.
-     *
-     * The message that's posted has the following format (where `payload` can
-     * be customized via the `generatePayload` option the instance is created
-     * with):
-     *
-     * ```
-     * {
-     *   type: 'CACHE_UPDATED',
-     *   meta: 'workbox-broadcast-update',
-     *   payload: {
-     *     cacheName: 'the-cache-name',
-     *     updatedURL: 'https://example.com/'
-     *   }
-     * }
-     * ```
-     *
-     * @param options
-     * @returns Resolves once the update is sent.
-     */
-    notifyIfUpdated(options: CacheDidUpdateCallbackParam): Promise<void>;
-}
-//# sourceMappingURL=BroadcastCacheUpdate.d.ts.map

package/dist/BroadcastCacheUpdate.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"BroadcastCacheUpdate.d.ts","sourceRoot":"","sources":["../src/BroadcastCacheUpdate.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAC;AAKjE,OAAO,KAAK,EAAE,2BAA2B,EAAiE,MAAM,YAAY,CAAC;AAuB7H;;;;;;GAMG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAW;IAC3C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA4B;IAC7D,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAU;IAE5C;;;;;OAKG;gBACS,EAAE,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,GAAE,2BAAgC;IAMnG;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,eAAe,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;CA4E3E"}

package/dist/BroadcastUpdatePlugin.d.ts

@@ -1,27 +0,0 @@
-import type { CacheDidUpdateCallbackParam, SerwistPlugin } from "@serwist/core";
-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 declare class BroadcastUpdatePlugin implements SerwistPlugin {
-    private readonly _broadcastUpdate;
-    /**
-     * Construct a `@serwist/broadcast-update.BroadcastCacheUpdate` instance with
-     * the passed options and calls its `notifyIfUpdated` method whenever the
-     * plugin's `cacheDidUpdate` callback is invoked.
-     *
-     * @param options
-     */
-    constructor(options?: BroadcastCacheUpdateOptions);
-    /**
-     * A "lifecycle" callback that will be triggered automatically by
-     * `@serwist/build.RuntimeCaching` handlers when an entry is
-     * added to a cache.
-     *
-     * @private
-     * @param options The input object to this function.
-     */
-    cacheDidUpdate(options: CacheDidUpdateCallbackParam): void;
-}
-//# sourceMappingURL=BroadcastUpdatePlugin.d.ts.map

package/dist/BroadcastUpdatePlugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"BroadcastUpdatePlugin.d.ts","sourceRoot":"","sources":["../src/BroadcastUpdatePlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,2BAA2B,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAGhF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AAE9D;;;GAGG;AACH,qBAAa,qBAAsB,YAAW,aAAa;IACzD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAuB;IAExD;;;;;;OAMG;gBACS,OAAO,CAAC,EAAE,2BAA2B;IAIjD;;;;;;;OAOG;IACH,cAAc,CAAC,OAAO,EAAE,2BAA2B;CAGpD"}

package/dist/constants.d.ts

@@ -1,5 +0,0 @@
-export declare const CACHE_UPDATED_MESSAGE_TYPE = "CACHE_UPDATED";
-export declare const CACHE_UPDATED_MESSAGE_META = "serwist-broadcast-update";
-export declare const defaultNotifyAllClients = true;
-export declare const defaultHeadersToCheck: string[];
-//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,0BAA0B,kBAAkB,CAAC;AAC1D,eAAO,MAAM,0BAA0B,6BAA6B,CAAC;AACrE,eAAO,MAAM,uBAAuB,OAAO,CAAC;AAC5C,eAAO,MAAM,qBAAqB,UAA8C,CAAC"}

package/dist/responsesAreSame.d.ts

@@ -1,11 +0,0 @@
-/**
- * Given two responses, compares several header values to see if they are
- * the same or not.
- *
- * @param firstResponse The first response.
- * @param secondResponse The second response.
- * @param headersToCheck A list of headers to check.
- * @returns
- */
-export declare const responsesAreSame: (firstResponse: Response, secondResponse: Response, headersToCheck: string[]) => boolean;
-//# sourceMappingURL=responsesAreSame.d.ts.map

package/dist/responsesAreSame.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"responsesAreSame.d.ts","sourceRoot":"","sources":["../src/responsesAreSame.ts"],"names":[],"mappings":"AAUA;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,kBAAmB,QAAQ,kBAAkB,QAAQ,kBAAkB,MAAM,EAAE,KAAG,OA4B9G,CAAC"}

package/dist/types.d.ts

@@ -1,34 +0,0 @@
-import type { CacheDidUpdateCallbackParam } from "@serwist/core";
-import type { CACHE_UPDATED_MESSAGE_META, CACHE_UPDATED_MESSAGE_TYPE } from "./constants.js";
-export interface BroadcastCacheUpdateOptions {
-    /**
-     * A list of headers that will be used to determine whether the responses
-     * differ.
-     *
-     * @default ['content-length', 'etag', 'last-modified']
-     */
-    headersToCheck?: string[];
-    /**
-     * A function whose return value
-     * will be used as the `payload` field in any cache update messages sent
-     * to the window clients.
-     * @param options
-     * @returns
-     */
-    generatePayload?: (options: CacheDidUpdateCallbackParam) => Record<string, any>;
-    /**
-     * If `true` (the default) then all open clients will receive a message. If `false`,
-     * then only the client that make the original request will be notified of the update.
-     *
-     * @default true
-     */
-    notifyAllClients?: boolean;
-}
-export type BroadcastPayload = Record<string, any>;
-export type BroadcastPayloadGenerator = (options: CacheDidUpdateCallbackParam) => BroadcastPayload;
-export interface BroadcastMessage {
-    type: typeof CACHE_UPDATED_MESSAGE_TYPE;
-    meta: typeof CACHE_UPDATED_MESSAGE_META;
-    payload: BroadcastPayload;
-}
-//# 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,2BAA2B,EAAE,MAAM,eAAe,CAAC;AACjE,OAAO,KAAK,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAC;AAE7F,MAAM,WAAW,2BAA2B;IAC1C;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChF;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;AAEnD,MAAM,MAAM,yBAAyB,GAAG,CAAC,OAAO,EAAE,2BAA2B,KAAK,gBAAgB,CAAC;AAEnG,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,0BAA0B,CAAC;IACxC,IAAI,EAAE,OAAO,0BAA0B,CAAC;IACxC,OAAO,EAAE,gBAAgB,CAAC;CAC3B"}

package/src/BroadcastCacheUpdate.ts

@@ -1,159 +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 { CacheDidUpdateCallbackParam } from "@serwist/core";
-import { assert, logger, resultingClientExists, timeout } from "@serwist/core/internal";
-
-import { CACHE_UPDATED_MESSAGE_META, CACHE_UPDATED_MESSAGE_TYPE, defaultHeadersToCheck, defaultNotifyAllClients } from "./constants.js";
-import { responsesAreSame } from "./responsesAreSame.js";
-import type { BroadcastCacheUpdateOptions, BroadcastMessage, BroadcastPayload, BroadcastPayloadGenerator } from "./types.js";
-
-// UA-sniff Safari: https://stackoverflow.com/questions/7944460/detect-safari-browser
-// TODO(philipwalton): remove once this Safari bug fix has been released.
-// https://bugs.webkit.org/show_bug.cgi?id=201169
-const isSafari = typeof navigator !== "undefined" && /^((?!chrome|android).)*safari/i.test(navigator.userAgent);
-
-// Give TypeScript the correct global.
-declare let self: ServiceWorkerGlobalScope;
-/**
- * Generates the default payload used in update messages. By default the
- * payload includes the `cacheName` and `updatedURL` fields.
- *
- * @returns
- * @private
- */
-const defaultPayloadGenerator = (data: CacheDidUpdateCallbackParam): BroadcastPayload => {
-  return {
-    cacheName: data.cacheName,
-    updatedURL: data.request.url,
-  };
-};
-
-/**
- * A class that uses the `postMessage()` API to inform any open windows/tabs when
- * a cached response has been updated.
- *
- * For efficiency's sake, the underlying response bodies are not compared;
- * only specific response headers are checked.
- */
-export class BroadcastCacheUpdate {
-  private readonly _headersToCheck: string[];
-  private readonly _generatePayload: BroadcastPayloadGenerator;
-  private readonly _notifyAllClients: boolean;
-
-  /**
-   * Construct a BroadcastCacheUpdate instance with a specific `channelName` to
-   * broadcast messages on
-   *
-   * @param options
-   */
-  constructor({ generatePayload, headersToCheck, notifyAllClients }: BroadcastCacheUpdateOptions = {}) {
-    this._headersToCheck = headersToCheck || defaultHeadersToCheck;
-    this._generatePayload = generatePayload || defaultPayloadGenerator;
-    this._notifyAllClients = notifyAllClients ?? defaultNotifyAllClients;
-  }
-
-  /**
-   * Compares two responses and sends a message (via `postMessage()`) to all window clients if the
-   * responses differ. Neither of the Responses can be opaque.
-   *
-   * The message that's posted has the following format (where `payload` can
-   * be customized via the `generatePayload` option the instance is created
-   * with):
-   *
-   * ```
-   * {
-   *   type: 'CACHE_UPDATED',
-   *   meta: 'workbox-broadcast-update',
-   *   payload: {
-   *     cacheName: 'the-cache-name',
-   *     updatedURL: 'https://example.com/'
-   *   }
-   * }
-   * ```
-   *
-   * @param options
-   * @returns Resolves once the update is sent.
-   */
-  async notifyIfUpdated(options: CacheDidUpdateCallbackParam): Promise<void> {
-    if (process.env.NODE_ENV !== "production") {
-      assert!.isType(options.cacheName, "string", {
-        moduleName: "@serwist/broadcast-update",
-        className: "BroadcastCacheUpdate",
-        funcName: "notifyIfUpdated",
-        paramName: "cacheName",
-      });
-      assert!.isInstance(options.newResponse, Response, {
-        moduleName: "@serwist/broadcast-update",
-        className: "BroadcastCacheUpdate",
-        funcName: "notifyIfUpdated",
-        paramName: "newResponse",
-      });
-      assert!.isInstance(options.request, Request, {
-        moduleName: "@serwist/broadcast-update",
-        className: "BroadcastCacheUpdate",
-        funcName: "notifyIfUpdated",
-        paramName: "request",
-      });
-    }
-
-    // Without two responses there is nothing to compare.
-    if (!options.oldResponse) {
-      return;
-    }
-
-    if (!responsesAreSame(options.oldResponse, options.newResponse, this._headersToCheck)) {
-      if (process.env.NODE_ENV !== "production") {
-        logger.log("Newer response found (and cached) for:", options.request.url);
-      }
-
-      const messageData = {
-        type: CACHE_UPDATED_MESSAGE_TYPE,
-        meta: CACHE_UPDATED_MESSAGE_META,
-        payload: this._generatePayload(options),
-      } satisfies BroadcastMessage;
-
-      // For navigation requests, wait until the new window client exists
-      // before sending the message
-      if (options.request.mode === "navigate") {
-        let resultingClientId: string | undefined;
-        if (options.event instanceof FetchEvent) {
-          resultingClientId = options.event.resultingClientId;
-        }
-
-        const resultingWin = await resultingClientExists(resultingClientId);
-
-        // Safari does not currently implement postMessage buffering and
-        // there's no good way to feature detect that, so to increase the
-        // chances of the message being delivered in Safari, we add a timeout.
-        // We also do this if `resultingClientExists()` didn't return a client,
-        // which means it timed out, so it's worth waiting a bit longer.
-        if (!resultingWin || isSafari) {
-          // 3500 is chosen because (according to CrUX data) 80% of mobile
-          // websites hit the DOMContentLoaded event in less than 3.5 seconds.
-          // And presumably sites implementing service worker are on the
-          // higher end of the performance spectrum.
-          await timeout(3500);
-        }
-      }
-
-      if (this._notifyAllClients) {
-        const windows = await self.clients.matchAll({ type: "window" });
-        for (const win of windows) {
-          win.postMessage(messageData);
-        }
-      } else {
-        // See https://github.com/GoogleChrome/workbox/issues/2895
-        if (options.event instanceof FetchEvent) {
-          const client = await self.clients.get(options.event.clientId);
-          client?.postMessage(messageData);
-        }
-      }
-    }
-  }
-}

package/src/BroadcastUpdatePlugin.ts

@@ -1,43 +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 { CacheDidUpdateCallbackParam, SerwistPlugin } from "@serwist/core";
-
-import { BroadcastCacheUpdate } from "./BroadcastCacheUpdate.js";
-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 {
-  private readonly _broadcastUpdate: BroadcastCacheUpdate;
-
-  /**
-   * Construct a `@serwist/broadcast-update.BroadcastCacheUpdate` instance with
-   * the passed options and calls its `notifyIfUpdated` method whenever the
-   * plugin's `cacheDidUpdate` callback is invoked.
-   *
-   * @param options
-   */
-  constructor(options?: BroadcastCacheUpdateOptions) {
-    this._broadcastUpdate = new BroadcastCacheUpdate(options);
-  }
-
-  /**
-   * A "lifecycle" callback that will be triggered automatically by
-   * `@serwist/build.RuntimeCaching` handlers when an entry is
-   * added to a cache.
-   *
-   * @private
-   * @param options The input object to this function.
-   */
-  cacheDidUpdate(options: CacheDidUpdateCallbackParam) {
-    void this._broadcastUpdate.notifyIfUpdated(options);
-  }
-}

package/src/constants.ts

@@ -1,12 +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.
-*/
-
-export const CACHE_UPDATED_MESSAGE_TYPE = "CACHE_UPDATED";
-export const CACHE_UPDATED_MESSAGE_META = "serwist-broadcast-update";
-export const defaultNotifyAllClients = true;
-export const defaultHeadersToCheck = ["content-length", "etag", "last-modified"];

package/src/responsesAreSame.ts

@@ -1,48 +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 { SerwistError, logger } from "@serwist/core/internal";
-
-/**
- * Given two responses, compares several header values to see if they are
- * the same or not.
- *
- * @param firstResponse The first response.
- * @param secondResponse The second response.
- * @param headersToCheck A list of headers to check.
- * @returns
- */
-export const responsesAreSame = (firstResponse: Response, secondResponse: Response, headersToCheck: string[]): boolean => {
-  if (process.env.NODE_ENV !== "production") {
-    if (!(firstResponse instanceof Response && secondResponse instanceof Response)) {
-      throw new SerwistError("invalid-responses-are-same-args");
-    }
-  }
-
-  const atLeastOneHeaderAvailable = headersToCheck.some((header) => {
-    return firstResponse.headers.has(header) && secondResponse.headers.has(header);
-  });
-
-  if (!atLeastOneHeaderAvailable) {
-    if (process.env.NODE_ENV !== "production") {
-      logger.warn("Unable to determine where the response has been updated because none of the headers that would be checked are present.");
-      logger.debug("Attempting to compare the following: ", firstResponse, secondResponse, headersToCheck);
-    }
-
-    // Just return true, indicating the that responses are the same, since we
-    // can't determine otherwise.
-    return true;
-  }
-
-  return headersToCheck.every((header) => {
-    const headerStateComparison = firstResponse.headers.has(header) === secondResponse.headers.has(header);
-    const headerValueComparison = firstResponse.headers.get(header) === secondResponse.headers.get(header);
-
-    return headerStateComparison && headerValueComparison;
-  });
-};

package/src/types.ts

@@ -1,37 +0,0 @@
-import type { CacheDidUpdateCallbackParam } from "@serwist/core";
-import type { CACHE_UPDATED_MESSAGE_META, CACHE_UPDATED_MESSAGE_TYPE } from "./constants.js";
-
-export interface BroadcastCacheUpdateOptions {
-  /**
-   * A list of headers that will be used to determine whether the responses
-   * differ.
-   *
-   * @default ['content-length', 'etag', 'last-modified']
-   */
-  headersToCheck?: string[];
-  /**
-   * A function whose return value
-   * will be used as the `payload` field in any cache update messages sent
-   * to the window clients.
-   * @param options
-   * @returns
-   */
-  generatePayload?: (options: CacheDidUpdateCallbackParam) => Record<string, any>;
-  /**
-   * If `true` (the default) then all open clients will receive a message. If `false`,
-   * then only the client that make the original request will be notified of the update.
-   *
-   * @default true
-   */
-  notifyAllClients?: boolean;
-}
-
-export type BroadcastPayload = Record<string, any>;
-
-export type BroadcastPayloadGenerator = (options: CacheDidUpdateCallbackParam) => BroadcastPayload;
-
-export interface BroadcastMessage {
-  type: typeof CACHE_UPDATED_MESSAGE_TYPE;
-  meta: typeof CACHE_UPDATED_MESSAGE_META;
-  payload: BroadcastPayload;
-}