@serwist/window 9.0.0-preview.9 → 9.0.1

package/dist/Serwist.d.ts

@@ -95,23 +95,21 @@ export declare class Serwist extends SerwistEventTarget {
     getSW(): Promise<ServiceWorker>;
     /**
      * Sends the passed data object to the service worker registered by this
-     * instance (via `@serwist/window.Serwist.getSW`) and resolves
-     * with a response (if any).
+     * instance (via `getSW`) and resolves with a response (if any).
      *
-     * A response can be set in a message handler in the service worker by
-     * calling `event.ports[0].postMessage(...)`, which will resolve the promise
-     * returned by `messageSW()`. If no response is set, the promise will never
-     * resolve.
+     * A response can be sent by calling `event.ports[0].postMessage(...)`, which will
+     * resolve the promise returned by `messageSW()`. If no response is sent, the promise
+     * will never resolve.
      *
      * @param data An object to send to the service worker
      * @returns
      */
     messageSW(data: any): Promise<any>;
     /**
-     * Sends a `{type: 'SKIP_WAITING'}` message to the service worker that's
-     * currently in the `waiting` state associated with the current registration.
+     * Sends a `{ type: "SKIP_WAITING" }` message to the service worker that is
+     * currently waiting and associated with the current registration.
      *
-     * If there is no current registration or no service worker is `waiting`,
+     * If there is no current registration, or no service worker is waiting,
      * calling this will have no effect.
      */
     messageSkipWaiting(): void;

package/dist/Serwist.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Serwist.d.ts","sourceRoot":"","sources":["../src/Serwist.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAK1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAgBnE;;;;;;;;;;GAUG;AACH,qBAAa,OAAQ,SAAQ,kBAAkB;IAC7C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA4B;IACvD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA2B;IAC5D,OAAO,CAAC,iBAAiB,CAAK;IAG9B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2C;IACvE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA2C;IAC3E,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA2C;IAEhF,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,SAAS,CAAC,CAAU;IAC5B,OAAO,CAAC,wBAAwB,CAAC,CAAgB;IACjD,OAAO,CAAC,aAAa,CAAC,CAA4B;IAClD,OAAO,CAAC,GAAG,CAAC,CAAgB;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiC;IACzD,OAAO,CAAC,WAAW,CAAC,CAAgB;IACpC,OAAO,CAAC,eAAe,CAAC,CAAS;IAEjC;;;;;;;;OAQG;gBACS,SAAS,EAAE,MAAM,GAAG,gBAAgB,EAAE,eAAe,GAAE,mBAAwB;IAY3F;;;;;;OAMG;IACG,QAAQ,CAAC,EACb,SAAiB,GAClB,GAAE;QACD;;;WAGG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;KAChB,GAAG,OAAO,CAAC,yBAAyB,GAAG,SAAS,CAAC;IA8FvD;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAY7B;;;;;;;;OAQG;IACH,IAAI,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,CAEnC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,WAAW,IAAI,OAAO,CAAC,aAAa,CAAC,CAExC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,IAAI,OAAO,CAAC,aAAa,CAAC;IAM/B;;;;;;;;;;;;OAYG;IAEG,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAKxC;;;;;;OAMG;IACH,kBAAkB,IAAI,IAAI;IAM1B;;;;;;OAMG;IACH,OAAO,CAAC,6BAA6B;IAQrC;;;;;OAKG;YACW,eAAe;IAsB7B;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,cAAc,CAsE7B;IAEF;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,cAAc,CAqF7B;IAEF;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAuBlC;IAEF;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,UAAU,CAuBzB;CACH;AAKD;;;;;;;;;;;GAWG;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;;;;;;;;;GAeG;AAEH;;;;;;;;;;;;;GAaG"}
+{"version":3,"file":"Serwist.d.ts","sourceRoot":"","sources":["../src/Serwist.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAK1D,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAiBnE;;;;;;;;;;GAUG;AACH,qBAAa,OAAQ,SAAQ,kBAAkB;IAC7C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA4B;IACvD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA2B;IAC5D,OAAO,CAAC,iBAAiB,CAAK;IAG9B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2C;IACvE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA2C;IAC3E,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAA2C;IAEhF,OAAO,CAAC,iBAAiB,CAA0B;IACnD,OAAO,CAAC,SAAS,CAAC,CAAU;IAC5B,OAAO,CAAC,wBAAwB,CAAC,CAAgB;IACjD,OAAO,CAAC,aAAa,CAAC,CAA4B;IAClD,OAAO,CAAC,GAAG,CAAC,CAAgB;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAiC;IACzD,OAAO,CAAC,WAAW,CAAC,CAAgB;IACpC,OAAO,CAAC,eAAe,CAAC,CAAS;IAEjC;;;;;;;;OAQG;gBACS,SAAS,EAAE,MAAM,GAAG,gBAAgB,EAAE,eAAe,GAAE,mBAAwB;IAY3F;;;;;;OAMG;IACG,QAAQ,CAAC,EACb,SAAiB,GAClB,GAAE;QACD;;;WAGG;QACH,SAAS,CAAC,EAAE,OAAO,CAAC;KAChB,GAAG,OAAO,CAAC,yBAAyB,GAAG,SAAS,CAAC;IAyFvD;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAY7B;;;;;;;;OAQG;IACH,IAAI,MAAM,IAAI,OAAO,CAAC,aAAa,CAAC,CAEnC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,WAAW,IAAI,OAAO,CAAC,aAAa,CAAC,CAExC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,IAAI,OAAO,CAAC,aAAa,CAAC;IAM/B;;;;;;;;;;OAUG;IAEG,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAKxC;;;;;;OAMG;IACH,kBAAkB,IAAI,IAAI;IAM1B;;;;;;OAMG;IACH,OAAO,CAAC,6BAA6B;IAQrC;;;;;OAKG;YACW,eAAe;IAsB7B;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,cAAc,CAsE7B;IAEF;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,cAAc,CAqF7B;IAEF;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAuBlC;IAEF;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,UAAU,CAuBzB;CACH;AAKD;;;;;;;;;;;GAWG;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH;;;;;;;;;;;;;;;;;GAiBG;AAEH;;;;;;;;;;;;;;;GAeG;AAEH;;;;;;;;;;;;;GAaG"}

package/dist/index.internal.d.ts

@@ -0,0 +1,3 @@
+import { isCurrentPageOutOfScope } from "./utils/isCurrentPageOutOfScope.js";
+export { isCurrentPageOutOfScope };
+//# sourceMappingURL=index.internal.d.ts.map

package/dist/index.internal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.internal.d.ts","sourceRoot":"","sources":["../src/index.internal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAE7E,OAAO,EAAE,uBAAuB,EAAE,CAAC"}

package/dist/index.internal.js

@@ -0,0 +1,7 @@
+const isCurrentPageOutOfScope = (scope)=>{
+    const scopeURL = new URL(scope, document.baseURI);
+    const scopeURLBasePath = new URL("./", scopeURL.href).pathname;
+    return !location.pathname.startsWith(scopeURLBasePath);
+};
+
+export { isCurrentPageOutOfScope };

package/dist/index.js

@@ -1,4 +1,5 @@
-import { Deferred, logger } from '@serwist/core/internal';
+import { Deferred, logger } from 'serwist/internal';
+import { isCurrentPageOutOfScope } from './index.internal.js';
 
 const messageSW = (sw, data)=>{
     return new Promise((resolve)=>{
@@ -126,12 +127,7 @@ class Serwist extends SerwistEventTarget {
                     logger.debug("A service worker with a different script URL is currently controlling the page. The browser is now fetching the new script now...");
                 }
             }
-            const currentPageIsOutOfScope = ()=>{
-                const scopeURL = new URL(this._registerOptions.scope || this._scriptURL.toString(), document.baseURI);
-                const scopeURLBasePath = new URL("./", scopeURL.href).pathname;
-                return !location.pathname.startsWith(scopeURLBasePath);
-            };
-            if (currentPageIsOutOfScope()) {
+            if (isCurrentPageOutOfScope(this._registerOptions.scope || this._scriptURL.toString())) {
                 logger.warn("The current page is not in scope for the registered service worker. Was this a mistake?");
             }
         }

package/dist/messageSW.d.ts

@@ -2,10 +2,9 @@
  * Sends a data object to a service worker via `postMessage` and resolves with
  * a response (if any).
  *
- * A response can be set in a message handler in the service worker by
- * calling `event.ports[0].postMessage(...)`, which will resolve the promise
- * returned by `messageSW()`. If no response is set, the promise will not
- * resolve.
+ * A response can be sent by calling `event.ports[0].postMessage(...)`, which will
+ * resolve the promise returned by `messageSW()`. If no response is sent, the promise
+ * will never resolve.
  *
  * @param sw The service worker to send the message to.
  * @param data An object to send to the service worker.

package/dist/messageSW.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"messageSW.d.ts","sourceRoot":"","sources":["../src/messageSW.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,SAAS,OAAQ,aAAa,QAAQ,GAAG,KAAG,QAAQ,GAAG,CAQnE,CAAC"}
+{"version":3,"file":"messageSW.d.ts","sourceRoot":"","sources":["../src/messageSW.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,SAAS,OAAQ,aAAa,QAAQ,GAAG,KAAG,QAAQ,GAAG,CAQnE,CAAC"}

package/dist/utils/isCurrentPageOutOfScope.d.ts

@@ -0,0 +1,2 @@
+export declare const isCurrentPageOutOfScope: (scope: string) => boolean;
+//# sourceMappingURL=isCurrentPageOutOfScope.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"isCurrentPageOutOfScope.d.ts","sourceRoot":"","sources":["../../src/utils/isCurrentPageOutOfScope.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,uBAAuB,UAAW,MAAM,YAIpD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/window",
-  "version": "9.0.0-preview.9",
+  "version": "9.0.1",
   "type": "module",
   "description": "Simplifies communications with Serwist packages running in the service worker",
   "files": [
@@ -18,26 +18,37 @@
   ],
   "author": "Google's Web DevRel Team, Serwist's Team",
   "license": "MIT",
-  "repository": "serwist/serwist",
+  "repository": "https://github.com/serwist/serwist",
   "bugs": "https://github.com/serwist/serwist/issues",
   "homepage": "https://serwist.pages.dev",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "internal": [
+        "./dist/index.internal.d.ts"
+      ]
+    }
+  },
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },
+    "./internal": {
+      "types": "./dist/index.internal.d.ts",
+      "default": "./dist/index.internal.js"
+    },
     "./package.json": "./package.json"
   },
   "dependencies": {
     "@types/trusted-types": "2.0.7",
-    "@serwist/core": "9.0.0-preview.9"
+    "serwist": "9.0.0"
   },
   "devDependencies": {
-    "rollup": "4.9.6",
-    "typescript": "5.4.0-dev.20240206",
-    "@serwist/constants": "9.0.0-preview.9"
+    "rollup": "4.14.3",
+    "typescript": "5.5.0-dev.20240415",
+    "@serwist/configs": "9.0.1"
   },
   "peerDependencies": {
     "typescript": ">=5.0.0"

package/src/Serwist.ts

@@ -6,13 +6,14 @@
   https://opensource.org/licenses/MIT.
 */
 
-import { Deferred, logger } from "@serwist/core/internal";
+import { Deferred, logger } from "serwist/internal";
 import type { TrustedScriptURL } from "trusted-types/lib";
 
 import { messageSW } from "./messageSW.js";
 import type { SerwistLifecycleEventMap } from "./utils/SerwistEvent.js";
 import { SerwistEvent } from "./utils/SerwistEvent.js";
 import { SerwistEventTarget } from "./utils/SerwistEventTarget.js";
+import { isCurrentPageOutOfScope } from "./utils/isCurrentPageOutOfScope.js";
 import { urlsMatch } from "./utils/urlsMatch.js";
 
 // The time a SW must be in the waiting phase before we can conclude
@@ -172,12 +173,7 @@ export class Serwist extends SerwistEventTarget {
         }
       }
 
-      const currentPageIsOutOfScope = () => {
-        const scopeURL = new URL(this._registerOptions.scope || this._scriptURL.toString(), document.baseURI);
-        const scopeURLBasePath = new URL("./", scopeURL.href).pathname;
-        return !location.pathname.startsWith(scopeURLBasePath);
-      };
-      if (currentPageIsOutOfScope()) {
+      if (isCurrentPageOutOfScope(this._registerOptions.scope || this._scriptURL.toString())) {
         logger.warn("The current page is not in scope for the registered service worker. Was this a mistake?");
       }
     }
@@ -255,13 +251,11 @@ export class Serwist extends SerwistEventTarget {
 
   /**
    * Sends the passed data object to the service worker registered by this
-   * instance (via `@serwist/window.Serwist.getSW`) and resolves
-   * with a response (if any).
+   * instance (via `getSW`) and resolves with a response (if any).
    *
-   * A response can be set in a message handler in the service worker by
-   * calling `event.ports[0].postMessage(...)`, which will resolve the promise
-   * returned by `messageSW()`. If no response is set, the promise will never
-   * resolve.
+   * A response can be sent by calling `event.ports[0].postMessage(...)`, which will
+   * resolve the promise returned by `messageSW()`. If no response is sent, the promise
+   * will never resolve.
    *
    * @param data An object to send to the service worker
    * @returns
@@ -273,10 +267,10 @@ export class Serwist extends SerwistEventTarget {
   }
 
   /**
-   * Sends a `{type: 'SKIP_WAITING'}` message to the service worker that's
-   * currently in the `waiting` state associated with the current registration.
+   * Sends a `{ type: "SKIP_WAITING" }` message to the service worker that is
+   * currently waiting and associated with the current registration.
    *
-   * If there is no current registration or no service worker is `waiting`,
+   * If there is no current registration, or no service worker is waiting,
    * calling this will have no effect.
    */
   messageSkipWaiting(): void {

package/src/index.internal.ts

@@ -0,0 +1,3 @@
+import { isCurrentPageOutOfScope } from "./utils/isCurrentPageOutOfScope.js";
+
+export { isCurrentPageOutOfScope };

package/src/messageSW.ts

@@ -10,10 +10,9 @@
  * Sends a data object to a service worker via `postMessage` and resolves with
  * a response (if any).
  *
- * A response can be set in a message handler in the service worker by
- * calling `event.ports[0].postMessage(...)`, which will resolve the promise
- * returned by `messageSW()`. If no response is set, the promise will not
- * resolve.
+ * A response can be sent by calling `event.ports[0].postMessage(...)`, which will
+ * resolve the promise returned by `messageSW()`. If no response is sent, the promise
+ * will never resolve.
  *
  * @param sw The service worker to send the message to.
  * @param data An object to send to the service worker.

package/src/utils/isCurrentPageOutOfScope.ts

@@ -0,0 +1,5 @@
+export const isCurrentPageOutOfScope = (scope: string) => {
+  const scopeURL = new URL(scope, document.baseURI);
+  const scopeURLBasePath = new URL("./", scopeURL.href).pathname;
+  return !location.pathname.startsWith(scopeURLBasePath);
+};