@php-wasm/web 0.9.45 → 0.9.46

package/index.js

@@ -1,6 +1,6 @@
 import { PHPResponse as D, LatestSupportedPHPVersion as R, loadPHPRuntime as L, FSHelpers as p, __private__dont__use as P } from "@php-wasm/universal";
 import * as f from "comlink";
-import { PhpWasmError as y, Semaphore as z, joinPaths as W } from "@php-wasm/util";
+import { PhpWasmError as y, Semaphore as z, joinPaths as T } from "@php-wasm/util";
 import { responseTo as M } from "@php-wasm/web-service-worker";
 import { logger as h } from "@php-wasm/logger";
 import { journalFSEvents as O } from "@php-wasm/fs-journal";
@@ -169,33 +169,48 @@ function ee(r) {
     throw new y("PHP API client must be a valid client object.");
   b(r);
 }
-async function te(r, t) {
-  const e = navigator.serviceWorker;
-  if (!e)
+async function te(r) {
+  const t = navigator.serviceWorker;
+  if (!t)
     throw window.isSecureContext ? new y(
       "Service workers are not supported in your browser."
     ) : new y(
       "WordPress Playground uses service workers and may only work on HTTPS and http://localhost/ sites, but the current site is neither."
     );
-  const n = await e.register(t, {
+  const e = await t.register(r, {
     type: "module",
     // Always bypass HTTP cache when fetching the new Service Worker script:
     updateViaCache: "none"
   });
   try {
-    await n.update();
-  } catch (a) {
-    h.error("Failed to update service worker.", a);
+    await e.update();
+  } catch (n) {
+    h.error("Failed to update service worker.", n);
   }
-  navigator.serviceWorker.addEventListener(
-    "message",
-    async function(i) {
-      if (r && i.data.scope !== r)
-        return;
-      const s = await $, o = i.data.args || [], c = i.data.method, u = await s[c](...o);
-      i.source.postMessage(M(i.data.requestId, u));
+  return {
+    /**
+     * Establishes the communication bridge between the service worker and the web worker
+     * where the current site is running.
+     *
+     * @param scope The string prefix used in the site URL served by the currently
+     *              running remote.html. E.g. for a prefix like `/scope:playground/`,
+     * 			    the scope would be `playground`. See the `@php-wasm/scopes` package
+     *              for more details.
+     */
+    startServiceWorkerCommunicationBridge({ scope: n }) {
+      navigator.serviceWorker.addEventListener(
+        "message",
+        async function(i) {
+          if (n && i.data.scope !== n)
+            return;
+          const s = await $, o = i.data.args || [], c = i.data.method, u = await s[c](...o);
+          i.source.postMessage(
+            M(i.data.requestId, u)
+          );
+        }
+      ), t.startMessages();
     }
-  ), e.startMessages();
+  };
 }
 function re(r, t) {
   window.addEventListener("message", (e) => {
@@ -247,7 +262,7 @@ async function q(r, t, e) {
     const [s, o] = i.pop();
     for await (const c of s.values()) {
       const u = n.run(async () => {
-        const w = W(
+        const w = T(
           o,
           c.name
         );
@@ -286,7 +301,7 @@ async function x(r, t, e, n) {
       r.readdir(w).filter(
         (d) => d !== "." && d !== ".."
       ).map(async (d) => {
-        const m = W(w, d);
+        const m = T(w, d);
         if (!F(r, m)) {
           a.push([l, m, d]);
           return;
@@ -300,7 +315,7 @@ async function x(r, t, e, n) {
   }
   await i(e, t);
   let s = 0;
-  const o = n && N(n, 100), c = 100, u = /* @__PURE__ */ new Set();
+  const o = n && B(n, 100), c = 100, u = /* @__PURE__ */ new Set();
   try {
     for (const [w, l, d] of a) {
       const m = C(
@@ -375,7 +390,7 @@ class j {
   async processEntry(t) {
     if (!t.path.startsWith(this.memfsRoot) || t.path === this.memfsRoot)
       return;
-    const e = this.toOpfsPath(t.path), n = await T(this.opfs, e), a = H(e);
+    const e = this.toOpfsPath(t.path), n = await W(this.opfs, e), a = H(e);
     if (a)
       try {
         if (t.operation === "DELETE")
@@ -399,7 +414,7 @@ class j {
             t.path
           );
         else if (t.operation === "RENAME" && t.toPath.startsWith(this.memfsRoot)) {
-          const i = this.toOpfsPath(t.toPath), s = await T(
+          const i = this.toOpfsPath(t.toPath), s = await W(
             this.opfs,
             i
           ), o = H(i);
@@ -431,7 +446,7 @@ function k(r) {
 function H(r) {
   return r.substring(r.lastIndexOf("/") + 1);
 }
-async function T(r, t) {
+async function W(r, t) {
   const e = t.replace(/^\/+|\/+$/g, "").replace(/\/+/, "/");
   if (!e)
     return r;
@@ -443,7 +458,7 @@ async function T(r, t) {
   }
   return a;
 }
-function N(r, t) {
+function B(r, t) {
   let e = 0, n, a;
   return function(...s) {
     a = s;

package/lib/register-service-worker.d.ts

@@ -15,10 +15,19 @@ export declare function setPhpInstanceUsedByServiceWorker(api: Client): void;
  * reload the registered worker if the app expects a different version
  * than the currently registered one.
  *
- * @param scope       The numeric value used in the path prefix of the site
- *                    this service worker is meant to serve. E.g. for a prefix
- *                    like `/scope:793/`, the scope would be `793`. See the
- *                    `@php-wasm/scopes` package for more details.
  * @param scriptUrl   The URL of the service worker script.
  */
-export declare function registerServiceWorker(scope: string, scriptUrl: string): Promise<void>;
+export declare function registerServiceWorker(scriptUrl: string): Promise<{
+    /**
+     * Establishes the communication bridge between the service worker and the web worker
+     * where the current site is running.
+     *
+     * @param scope The string prefix used in the site URL served by the currently
+     *              running remote.html. E.g. for a prefix like `/scope:playground/`,
+     * 			    the scope would be `playground`. See the `@php-wasm/scopes` package
+     *              for more details.
+     */
+    startServiceWorkerCommunicationBridge({ scope }: {
+        scope: string;
+    }): void;
+}>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@php-wasm/web",
-  "version": "0.9.45",
+  "version": "0.9.46",
   "description": "PHP.wasm for the web",
   "repository": {
     "type": "git",
@@ -29,7 +29,7 @@
   "type": "module",
   "main": "index.js",
   "types": "index.d.ts",
-  "gitHead": "0c51051f503936c8bc92974ed660bd83f1957922",
+  "gitHead": "fa393bcf69536e421246aa8e321e3e9af4b61c7b",
   "engines": {
     "node": ">=16.15.1",
     "npm": ">=8.11.0"
@@ -40,10 +40,10 @@
     "ini": "4.1.2",
     "ws": "8.18.0",
     "yargs": "17.7.2",
-    "@php-wasm/universal": "0.9.45",
-    "@php-wasm/util": "0.9.45",
-    "@php-wasm/logger": "0.9.45",
-    "@php-wasm/fs-journal": "0.9.45",
-    "@php-wasm/web-service-worker": "0.9.45"
+    "@php-wasm/universal": "0.9.46",
+    "@php-wasm/util": "0.9.46",
+    "@php-wasm/logger": "0.9.46",
+    "@php-wasm/fs-journal": "0.9.46",
+    "@php-wasm/web-service-worker": "0.9.46"
   }
 }