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

package/README.md

@@ -1 +1 @@
-This module's documentation can be found at https://developers.google.com/web/tools/workbox/modules/workbox-broadcast-update
+This module's documentation can be found at https://serwist.pages.dev/docs/broadcast-update

package/dist/BroadcastCacheUpdate.d.ts

@@ -1,8 +1,8 @@
 import type { CacheDidUpdateCallbackParam } from "@serwist/core";
 import type { BroadcastCacheUpdateOptions } from "./types.js";
 /**
- * Uses the `postMessage()` API to inform any open windows/tabs when a cached
- * response has been updated.
+ * 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.
@@ -19,10 +19,8 @@ export declare class BroadcastCacheUpdate {
      */
     constructor({ generatePayload, headersToCheck, notifyAllClients }?: BroadcastCacheUpdateOptions);
     /**
-     * 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).
+     * 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

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;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"}
+{"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,8 +1,8 @@
 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.
+ * 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;

package/dist/index.js

@@ -20,7 +20,7 @@ const responsesAreSame = (firstResponse, secondResponse, headersToCheck)=>{
     });
     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.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;

package/dist/responsesAreSame.d.ts

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

package/dist/responsesAreSame.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responsesAreSame.d.ts","sourceRoot":"","sources":["../src/responsesAreSame.ts"],"names":[],"mappings":"AAUA;;;;;;;;GAQG;AACH,QAAA,MAAM,gBAAgB,kBAAmB,QAAQ,kBAAkB,QAAQ,kBAAkB,MAAM,EAAE,KAAG,OA4BvG,CAAC;AAEF,OAAO,EAAE,gBAAgB,EAAE,CAAC"}
+{"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

@@ -17,7 +17,7 @@ export interface BroadcastCacheUpdateOptions {
      */
     generatePayload?: (options: CacheDidUpdateCallbackParam) => Record<string, any>;
     /**
-     * If true (the default) then all open clients will receive a message. If false,
+     * 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/broadcast-update",
-  "version": "9.0.0-preview.10",
+  "version": "9.0.0-preview.12",
   "type": "module",
   "description": "A module that uses the Broadcast Channel API to announce when a cached response has updated",
   "files": [
@@ -29,12 +29,12 @@
     }
   },
   "dependencies": {
-    "@serwist/core": "9.0.0-preview.10"
+    "@serwist/core": "9.0.0-preview.12"
   },
   "devDependencies": {
     "rollup": "4.9.6",
     "typescript": "5.4.0-dev.20240206",
-    "@serwist/constants": "9.0.0-preview.10"
+    "@serwist/constants": "9.0.0-preview.12"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"

package/src/BroadcastCacheUpdate.ts

@@ -35,8 +35,8 @@ const defaultPayloadGenerator = (data: CacheDidUpdateCallbackParam): BroadcastPa
 };
 
 /**
- * Uses the `postMessage()` API to inform any open windows/tabs when a cached
- * response has been updated.
+ * 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.
@@ -59,10 +59,8 @@ export class BroadcastCacheUpdate {
   }
 
   /**
-   * 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).
+   * 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

package/src/BroadcastUpdatePlugin.ts

@@ -12,8 +12,8 @@ import { BroadcastCacheUpdate } from "./BroadcastCacheUpdate.js";
 import type { BroadcastCacheUpdateOptions } from "./types.js";
 
 /**
- * This plugin will automatically broadcast a message whenever a cached response
- * is updated.
+ * 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;

package/src/responsesAreSame.ts

@@ -12,12 +12,12 @@ import { SerwistError, logger } 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
+ * @param firstResponse The first response.
+ * @param secondResponse The second response.
+ * @param headersToCheck A list of headers to check.
  * @returns
  */
-const responsesAreSame = (firstResponse: Response, secondResponse: Response, headersToCheck: string[]): boolean => {
+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");
@@ -30,7 +30,7 @@ const responsesAreSame = (firstResponse: Response, secondResponse: Response, hea
 
   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.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);
     }
 
@@ -46,5 +46,3 @@ const responsesAreSame = (firstResponse: Response, secondResponse: Response, hea
     return headerStateComparison && headerValueComparison;
   });
 };
-
-export { responsesAreSame };

package/src/types.ts

@@ -18,7 +18,7 @@ export interface BroadcastCacheUpdateOptions {
    */
   generatePayload?: (options: CacheDidUpdateCallbackParam) => Record<string, any>;
   /**
-   * If true (the default) then all open clients will receive a message. If false,
+   * 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