@serwist/window 8.2.0 → 8.3.0

package/dist/Serwist.d.ts

@@ -134,6 +134,7 @@ export declare class Serwist extends SerwistEventTarget {
     private _registerScript;
     /**
      * @private
+     * @param originalEvent
      */
     private readonly _onUpdateFound;
     /**
@@ -268,3 +269,17 @@ export declare class Serwist extends SerwistEventTarget {
  * @property {string} type `redundant`.
  * @property {Workbox} target The `Workbox` instance.
  */
+/**
+ * The `installing` event is dispatched if the service worker
+ * finds the new version and starts installing.
+ *
+ * @event workbox-window.Workbox#installing
+ * @type {SerwistEvent}
+ * @property {ServiceWorker} sw The installing service worker instance.
+ * @property {Event} originalEvent The original [`statechange`]{@link https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorker/onstatechange}
+ *     event.
+ * @property {boolean|undefined} isUpdate True if a service worker was already
+ *     controlling when this `Workbox` instance called `register()`.
+ * @property {string} type `installing`.
+ * @property {Workbox} target The `Workbox` instance.
+ */

package/dist/index.cjs

@@ -395,7 +395,8 @@ const SKIP_WAITING_MESSAGE = {
     }
     /**
    * @private
-   */ _onUpdateFound = ()=>{
+   * @param originalEvent
+   */ _onUpdateFound = (originalEvent)=>{
         // `this._registration` will never be `undefined` after an update is found.
         const registration = this._registration;
         const installingSW = registration.installing;
@@ -432,16 +433,21 @@ const SKIP_WAITING_MESSAGE = {
             this._sw = installingSW;
             this._ownSWs.add(installingSW);
             this._swDeferred.resolve(installingSW);
-            // The `installing` state isn't something we have a dedicated
-            // callback for, but we do log messages for it in development.
             if (process.env.NODE_ENV !== "production") {
-                if (navigator.serviceWorker.controller) {
+                if (this._isUpdate) {
                     internal.logger.log("Updated service worker found. Installing now...");
                 } else {
                     internal.logger.log("Service worker is installing...");
                 }
             }
         }
+        // Dispatch the `installing` event when the SW is installing.
+        this.dispatchEvent(new SerwistEvent("installing", {
+            sw: installingSW,
+            originalEvent,
+            isExternal: updateLikelyTriggeredExternally,
+            isUpdate: this._isUpdate
+        }));
         // Increment the `updatefound` count, so future invocations of this
         // method can be sure they were triggered externally.
         ++this._updateFoundCount;
@@ -686,6 +692,19 @@ const SKIP_WAITING_MESSAGE = {
  *     controlling when this `Workbox` instance called `register()`.
  * @property {string} type `redundant`.
  * @property {Workbox} target The `Workbox` instance.
+ */  /**
+ * The `installing` event is dispatched if the service worker
+ * finds the new version and starts installing.
+ *
+ * @event workbox-window.Workbox#installing
+ * @type {SerwistEvent}
+ * @property {ServiceWorker} sw The installing service worker instance.
+ * @property {Event} originalEvent The original [`statechange`]{@link https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorker/onstatechange}
+ *     event.
+ * @property {boolean|undefined} isUpdate True if a service worker was already
+ *     controlling when this `Workbox` instance called `register()`.
+ * @property {string} type `installing`.
+ * @property {Workbox} target The `Workbox` instance.
  */
 
 exports.Serwist = Serwist;

package/dist/index.js

@@ -393,7 +393,8 @@ const SKIP_WAITING_MESSAGE = {
     }
     /**
    * @private
-   */ _onUpdateFound = ()=>{
+   * @param originalEvent
+   */ _onUpdateFound = (originalEvent)=>{
         // `this._registration` will never be `undefined` after an update is found.
         const registration = this._registration;
         const installingSW = registration.installing;
@@ -430,16 +431,21 @@ const SKIP_WAITING_MESSAGE = {
             this._sw = installingSW;
             this._ownSWs.add(installingSW);
             this._swDeferred.resolve(installingSW);
-            // The `installing` state isn't something we have a dedicated
-            // callback for, but we do log messages for it in development.
             if (process.env.NODE_ENV !== "production") {
-                if (navigator.serviceWorker.controller) {
+                if (this._isUpdate) {
                     logger.log("Updated service worker found. Installing now...");
                 } else {
                     logger.log("Service worker is installing...");
                 }
             }
         }
+        // Dispatch the `installing` event when the SW is installing.
+        this.dispatchEvent(new SerwistEvent("installing", {
+            sw: installingSW,
+            originalEvent,
+            isExternal: updateLikelyTriggeredExternally,
+            isUpdate: this._isUpdate
+        }));
         // Increment the `updatefound` count, so future invocations of this
         // method can be sure they were triggered externally.
         ++this._updateFoundCount;
@@ -684,6 +690,19 @@ const SKIP_WAITING_MESSAGE = {
  *     controlling when this `Workbox` instance called `register()`.
  * @property {string} type `redundant`.
  * @property {Workbox} target The `Workbox` instance.
+ */  /**
+ * The `installing` event is dispatched if the service worker
+ * finds the new version and starts installing.
+ *
+ * @event workbox-window.Workbox#installing
+ * @type {SerwistEvent}
+ * @property {ServiceWorker} sw The installing service worker instance.
+ * @property {Event} originalEvent The original [`statechange`]{@link https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorker/onstatechange}
+ *     event.
+ * @property {boolean|undefined} isUpdate True if a service worker was already
+ *     controlling when this `Workbox` instance called `register()`.
+ * @property {string} type `installing`.
+ * @property {Workbox} target The `Workbox` instance.
  */
 
 export { Serwist, SerwistEvent, messageSW };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/window",
-  "version": "8.2.0",
+  "version": "8.3.0",
   "type": "module",
   "description": "Simplifies communications with Serwist packages running in the service worker",
   "files": [
@@ -39,11 +39,11 @@
   },
   "dependencies": {
     "@types/trusted-types": "2.0.7",
-    "@serwist/core": "8.2.0"
+    "@serwist/core": "8.3.0"
   },
   "devDependencies": {
     "rollup": "4.9.1",
-    "@serwist/constants": "8.2.0"
+    "@serwist/constants": "8.3.0"
   },
   "scripts": {
     "build": "rimraf dist && cross-env NODE_ENV=production rollup --config rollup.config.js",