@serwist/broadcast-update 9.0.0-preview.0 → 9.0.0-preview.10

package/dist/BroadcastCacheUpdate.d.ts

@@ -1,28 +1,5 @@
 import type { CacheDidUpdateCallbackParam } from "@serwist/core";
-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;
-}
+import type { BroadcastCacheUpdateOptions } from "./types.js";
 /**
  * Uses the `postMessage()` API to inform any open windows/tabs when a cached
  * response has been updated.
@@ -30,7 +7,7 @@ export interface BroadcastCacheUpdateOptions {
  * For efficiency's sake, the underlying response bodies are not compared;
  * only specific response headers are checked.
  */
-declare class BroadcastCacheUpdate {
+export declare class BroadcastCacheUpdate {
     private readonly _headersToCheck;
     private readonly _generatePayload;
     private readonly _notifyAllClients;
@@ -67,5 +44,4 @@ declare class BroadcastCacheUpdate {
      */
     notifyIfUpdated(options: CacheDidUpdateCallbackParam): Promise<void>;
 }
-export { BroadcastCacheUpdate };
 //# sourceMappingURL=BroadcastCacheUpdate.d.ts.map

package/dist/BroadcastCacheUpdate.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BroadcastCacheUpdate.d.ts","sourceRoot":"","sources":["../src/BroadcastCacheUpdate.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,eAAe,CAAC;AAcjE,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;AAgBD;;;;;;GAMG;AACH,cAAM,oBAAoB;IACxB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAW;IAC3C,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAgE;IACjG,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAU;IAE5C;;;;;OAKG;gBACS,EAAE,eAAe,EAAE,cAAc,EAAE,gBAAgB,EAAE,GAAE,2BAAgC;IAMnG;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,eAAe,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;CA4E3E;AAED,OAAO,EAAE,oBAAoB,EAAE,CAAC"}
+{"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;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,eAAe,CAAC,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;CA4E3E"}

package/dist/BroadcastUpdatePlugin.d.ts

@@ -1,10 +1,10 @@
-import type { SerwistPlugin } from "@serwist/core";
-import type { BroadcastCacheUpdateOptions } from "./BroadcastCacheUpdate.js";
+import type { CacheDidUpdateCallbackParam, SerwistPlugin } from "@serwist/core";
+import type { BroadcastCacheUpdateOptions } from "./types.js";
 /**
  * This plugin will automatically broadcast a message whenever a cached response
  * is updated.
  */
-declare class BroadcastUpdatePlugin implements SerwistPlugin {
+export declare class BroadcastUpdatePlugin implements SerwistPlugin {
     private readonly _broadcastUpdate;
     /**
      * Construct a `@serwist/broadcast-update.BroadcastCacheUpdate` instance with
@@ -22,7 +22,6 @@ declare class BroadcastUpdatePlugin implements SerwistPlugin {
      * @private
      * @param options The input object to this function.
      */
-    cacheDidUpdate: SerwistPlugin["cacheDidUpdate"];
+    cacheDidUpdate(options: CacheDidUpdateCallbackParam): void;
 }
-export { BroadcastUpdatePlugin };
 //# sourceMappingURL=BroadcastUpdatePlugin.d.ts.map

package/dist/BroadcastUpdatePlugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BroadcastUpdatePlugin.d.ts","sourceRoot":"","sources":["../src/BroadcastUpdatePlugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAGnD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAC;AAG7E;;;GAGG;AACH,cAAM,qBAAsB,YAAW,aAAa;IAClD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAuB;IAExD;;;;;;OAMG;gBACS,OAAO,CAAC,EAAE,2BAA2B;IAIjD;;;;;;;OAOG;IACH,cAAc,EAAE,aAAa,CAAC,gBAAgB,CAAC,CAE7C;CACH;AAED,OAAO,EAAE,qBAAqB,EAAE,CAAC"}
+{"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

@@ -0,0 +1,5 @@
+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

@@ -0,0 +1 @@
+{"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/index.d.ts

@@ -1,10 +1,7 @@
-import type { BroadcastCacheUpdateOptions } from "./BroadcastCacheUpdate.js";
 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";
-/**
- * @module workbox-broadcast-update
- */
-export { BroadcastCacheUpdate, BroadcastUpdatePlugin, responsesAreSame };
-export type { BroadcastCacheUpdateOptions };
+export { BroadcastCacheUpdate, BroadcastUpdatePlugin, responsesAreSame, CACHE_UPDATED_MESSAGE_META, CACHE_UPDATED_MESSAGE_TYPE, defaultHeadersToCheck, };
+export type * from "./types.js";
 //# 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,KAAK,EAAE,2BAA2B,EAAE,MAAM,2BAA2B,CAAC;AAC7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD;;GAEG;AAEH,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,CAAC;AAEzE,YAAY,EAAE,2BAA2B,EAAE,CAAC"}
+{"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;AAEzD,OAAO,EACL,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,0BAA0B,EAC1B,0BAA0B,EAC1B,qBAAqB,GACtB,CAAC;AAEF,mBAAmB,YAAY,CAAC"}

package/dist/index.js

@@ -1,14 +1,15 @@
-import { SerwistError, logger, assert, resultingClientExists, timeout, dontWaitFor } from '@serwist/core/internal';
+import { SerwistError, logger, assert, resultingClientExists, timeout } from '@serwist/core/internal';
 
-/**
- * Given two `Response's`, compares several header values to see if they are
- * the same or not.
- *
- * @param firstResponse
- * @param secondResponse
- * @param headersToCheck
- * @returns
- */ const responsesAreSame = (firstResponse, secondResponse, headersToCheck)=>{
+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");
@@ -22,8 +23,6 @@ import { SerwistError, logger, assert, resultingClientExists, timeout, dontWaitF
             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)=>{
@@ -33,81 +32,23 @@ import { SerwistError, logger, assert, resultingClientExists, timeout, dontWaitF
     });
 };
 
-/*
-  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.
-*/ const CACHE_UPDATED_MESSAGE_TYPE = "CACHE_UPDATED";
-const CACHE_UPDATED_MESSAGE_META = "serwist-broadcast-update";
-const NOTIFY_ALL_CLIENTS = true;
-const DEFAULT_HEADERS_TO_CHECK = [
-    "content-length",
-    "etag",
-    "last-modified"
-];
-
-// 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);
-/**
- * Generates the default payload used in update messages. By default the
- * payload includes the `cacheName` and `updatedURL` fields.
- *
- * @returns
- * @private
- */ function defaultPayloadGenerator(data) {
+const defaultPayloadGenerator = (data)=>{
     return {
         cacheName: data.cacheName,
         updatedURL: data.request.url
     };
-}
-/**
- * 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.
- */ class BroadcastCacheUpdate {
+};
+class BroadcastCacheUpdate {
     _headersToCheck;
     _generatePayload;
     _notifyAllClients;
-    /**
-   * Construct a BroadcastCacheUpdate instance with a specific `channelName` to
-   * broadcast messages on
-   *
-   * @param options
-   */ constructor({ generatePayload, headersToCheck, notifyAllClients } = {}){
-        this._headersToCheck = headersToCheck || DEFAULT_HEADERS_TO_CHECK;
+    constructor({ generatePayload, headersToCheck, notifyAllClients } = {}){
+        this._headersToCheck = headersToCheck || defaultHeadersToCheck;
         this._generatePayload = generatePayload || defaultPayloadGenerator;
-        this._notifyAllClients = notifyAllClients ?? NOTIFY_ALL_CLIENTS;
+        this._notifyAllClients = notifyAllClients ?? defaultNotifyAllClients;
     }
-    /**
-   * Compares two [Responses](https://developer.mozilla.org/en-US/docs/Web/API/Response)
-   * and sends a message (via `postMessage()`) to all window clients if the
-   * responses differ. Neither of the Responses can be
-   * [opaque](https://developer.chrome.com/docs/workbox/caching-resources-during-runtime/#opaque-responses).
-   *
-   * 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) {
+    async notifyIfUpdated(options) {
         if (process.env.NODE_ENV !== "production") {
             assert.isType(options.cacheName, "string", {
                 moduleName: "@serwist/broadcast-update",
@@ -128,7 +69,6 @@ const isSafari = typeof navigator !== "undefined" && /^((?!chrome|android).)*saf
                 paramName: "request"
             });
         }
-        // Without two responses there is nothing to compare.
         if (!options.oldResponse) {
             return;
         }
@@ -141,24 +81,13 @@ const isSafari = typeof navigator !== "undefined" && /^((?!chrome|android).)*saf
                 meta: CACHE_UPDATED_MESSAGE_META,
                 payload: this._generatePayload(options)
             };
-            // For navigation requests, wait until the new window client exists
-            // before sending the message
             if (options.request.mode === "navigate") {
                 let resultingClientId;
                 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);
                 }
             }
@@ -170,7 +99,6 @@ const isSafari = typeof navigator !== "undefined" && /^((?!chrome|android).)*saf
                     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);
@@ -180,30 +108,14 @@ const isSafari = typeof navigator !== "undefined" && /^((?!chrome|android).)*saf
     }
 }
 
-/**
- * This plugin will automatically broadcast a message whenever a cached response
- * is updated.
- */ class BroadcastUpdatePlugin {
+class BroadcastUpdatePlugin {
     _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){
+    constructor(options){
         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 = async (options)=>{
-        dontWaitFor(this._broadcastUpdate.notifyIfUpdated(options));
-    };
+    cacheDidUpdate(options) {
+        void this._broadcastUpdate.notifyIfUpdated(options);
+    }
 }
 
-export { BroadcastCacheUpdate, BroadcastUpdatePlugin, responsesAreSame };
+export { BroadcastCacheUpdate, BroadcastUpdatePlugin, CACHE_UPDATED_MESSAGE_META, CACHE_UPDATED_MESSAGE_TYPE, defaultHeadersToCheck, responsesAreSame };

package/dist/types.d.ts

@@ -0,0 +1,36 @@
+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 interface 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

@@ -0,0 +1 @@
+{"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,WAAW,yBAAyB;IACxC,CAAC,OAAO,EAAE,2BAA2B,GAAG,gBAAgB,CAAC;CAC1D;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,OAAO,0BAA0B,CAAC;IACxC,IAAI,EAAE,OAAO,0BAA0B,CAAC;IACxC,OAAO,EAAE,gBAAgB,CAAC;CAC3B"}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@serwist/broadcast-update",
-  "version": "9.0.0-preview.0",
+  "version": "9.0.0-preview.10",
   "type": "module",
-  "description": "A service worker helper library 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"
@@ -29,12 +29,12 @@
     }
   },
   "dependencies": {
-    "@serwist/core": "9.0.0-preview.0"
+    "@serwist/core": "9.0.0-preview.10"
   },
   "devDependencies": {
     "rollup": "4.9.6",
-    "typescript": "5.4.0-dev.20240203",
-    "@serwist/constants": "9.0.0-preview.0"
+    "typescript": "5.4.0-dev.20240206",
+    "@serwist/constants": "9.0.0-preview.10"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"

package/src/BroadcastCacheUpdate.ts

@@ -9,8 +9,9 @@
 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 { CACHE_UPDATED_MESSAGE_META, CACHE_UPDATED_MESSAGE_TYPE, DEFAULT_HEADERS_TO_CHECK, NOTIFY_ALL_CLIENTS } from "./utils/constants.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.
@@ -19,32 +20,6 @@ const isSafari = typeof navigator !== "undefined" && /^((?!chrome|android).)*saf
 
 // Give TypeScript the correct global.
 declare let self: ServiceWorkerGlobalScope;
-
-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;
-}
-
 /**
  * Generates the default payload used in update messages. By default the
  * payload includes the `cacheName` and `updatedURL` fields.
@@ -52,12 +27,12 @@ export interface BroadcastCacheUpdateOptions {
  * @returns
  * @private
  */
-function defaultPayloadGenerator(data: CacheDidUpdateCallbackParam): Record<string, any> {
+const defaultPayloadGenerator = (data: CacheDidUpdateCallbackParam): BroadcastPayload => {
   return {
     cacheName: data.cacheName,
     updatedURL: data.request.url,
   };
-}
+};
 
 /**
  * Uses the `postMessage()` API to inform any open windows/tabs when a cached
@@ -66,9 +41,9 @@ function defaultPayloadGenerator(data: CacheDidUpdateCallbackParam): Record<stri
  * For efficiency's sake, the underlying response bodies are not compared;
  * only specific response headers are checked.
  */
-class BroadcastCacheUpdate {
+export class BroadcastCacheUpdate {
   private readonly _headersToCheck: string[];
-  private readonly _generatePayload: (options: CacheDidUpdateCallbackParam) => Record<string, any>;
+  private readonly _generatePayload: BroadcastPayloadGenerator;
   private readonly _notifyAllClients: boolean;
 
   /**
@@ -78,9 +53,9 @@ class BroadcastCacheUpdate {
    * @param options
    */
   constructor({ generatePayload, headersToCheck, notifyAllClients }: BroadcastCacheUpdateOptions = {}) {
-    this._headersToCheck = headersToCheck || DEFAULT_HEADERS_TO_CHECK;
+    this._headersToCheck = headersToCheck || defaultHeadersToCheck;
     this._generatePayload = generatePayload || defaultPayloadGenerator;
-    this._notifyAllClients = notifyAllClients ?? NOTIFY_ALL_CLIENTS;
+    this._notifyAllClients = notifyAllClients ?? defaultNotifyAllClients;
   }
 
   /**
@@ -143,7 +118,7 @@ class BroadcastCacheUpdate {
         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
@@ -184,5 +159,3 @@ class BroadcastCacheUpdate {
     }
   }
 }
-
-export { BroadcastCacheUpdate };

package/src/BroadcastUpdatePlugin.ts

@@ -6,17 +6,16 @@
   https://opensource.org/licenses/MIT.
 */
 
-import type { SerwistPlugin } from "@serwist/core";
-import { dontWaitFor } from "@serwist/core/internal";
+import type { CacheDidUpdateCallbackParam, SerwistPlugin } from "@serwist/core";
 
-import type { BroadcastCacheUpdateOptions } from "./BroadcastCacheUpdate.js";
 import { BroadcastCacheUpdate } from "./BroadcastCacheUpdate.js";
+import type { BroadcastCacheUpdateOptions } from "./types.js";
 
 /**
  * This plugin will automatically broadcast a message whenever a cached response
  * is updated.
  */
-class BroadcastUpdatePlugin implements SerwistPlugin {
+export class BroadcastUpdatePlugin implements SerwistPlugin {
   private readonly _broadcastUpdate: BroadcastCacheUpdate;
 
   /**
@@ -38,9 +37,7 @@ class BroadcastUpdatePlugin implements SerwistPlugin {
    * @private
    * @param options The input object to this function.
    */
-  cacheDidUpdate: SerwistPlugin["cacheDidUpdate"] = async (options) => {
-    dontWaitFor(this._broadcastUpdate.notifyIfUpdated(options));
-  };
+  cacheDidUpdate(options: CacheDidUpdateCallbackParam) {
+    void this._broadcastUpdate.notifyIfUpdated(options);
+  }
 }
-
-export { BroadcastUpdatePlugin };

package/src/{utils/constants.ts → constants.ts}

@@ -8,5 +8,5 @@
 
 export const CACHE_UPDATED_MESSAGE_TYPE = "CACHE_UPDATED";
 export const CACHE_UPDATED_MESSAGE_META = "serwist-broadcast-update";
-export const NOTIFY_ALL_CLIENTS = true;
-export const DEFAULT_HEADERS_TO_CHECK: string[] = ["content-length", "etag", "last-modified"];
+export const defaultNotifyAllClients = true;
+export const defaultHeadersToCheck = ["content-length", "etag", "last-modified"];

package/src/index.ts

@@ -6,15 +6,18 @@
   https://opensource.org/licenses/MIT.
 */
 
-import type { BroadcastCacheUpdateOptions } from "./BroadcastCacheUpdate.js";
 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";
 
-/**
- * @module workbox-broadcast-update
- */
+export {
+  BroadcastCacheUpdate,
+  BroadcastUpdatePlugin,
+  responsesAreSame,
+  CACHE_UPDATED_MESSAGE_META,
+  CACHE_UPDATED_MESSAGE_TYPE,
+  defaultHeadersToCheck,
+};
 
-export { BroadcastCacheUpdate, BroadcastUpdatePlugin, responsesAreSame };
-
-export type { BroadcastCacheUpdateOptions };
+export type * from "./types.js";

package/src/types.ts

@@ -0,0 +1,39 @@
+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 interface BroadcastPayloadGenerator {
+  (options: CacheDidUpdateCallbackParam): BroadcastPayload;
+}
+
+export interface BroadcastMessage {
+  type: typeof CACHE_UPDATED_MESSAGE_TYPE;
+  meta: typeof CACHE_UPDATED_MESSAGE_META;
+  payload: BroadcastPayload;
+}

package/dist/utils/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 NOTIFY_ALL_CLIENTS = true;
-export declare const DEFAULT_HEADERS_TO_CHECK: string[];
-//# sourceMappingURL=constants.d.ts.map

package/dist/utils/constants.d.ts.map

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