@wp-playground/client 0.6.8 → 0.6.9

package/index.d.ts

@@ -207,6 +207,7 @@ export interface PHPRequestEndEvent {
 export interface PHPRequestErrorEvent {
 	type: "request.error";
 	error: Error;
+	source?: "request" | "php-wasm";
 }
 /**
  * Represents a PHP runtime initialization event.
@@ -672,11 +673,6 @@ export interface PHPRunOptions {
 	 * The code snippet to eval instead of a php file.
 	 */
 	code?: string;
-	/**
-	 * Whether to throw an error if the PHP process exits with a non-zero code
-	 * or outputs to stderr.
-	 */
-	throwOnError?: boolean;
 }
 /**
  * Output of the PHP.wasm runtime.
@@ -1888,7 +1884,7 @@ export declare const enableMultisite: StepHandler<EnableMultisiteStep>;
  *
  * <code>
  * {
- * 		"step": "wpCLI",
+ * 		"step": "wp-cli",
  * 		"command": "wp post create --post_title='Test post' --post_excerpt='Some content'"
  * }
  * </code>
@@ -2276,6 +2272,7 @@ declare class PlaygroundWorkerEndpoint extends WebPHPEndpoint {
 		all: {
 			nightly: string;
 			beta: string;
+			"6.5": string;
 			"6.4": string;
 			"6.3": string;
 			"6.2": string;
@@ -2349,6 +2346,14 @@ export interface StartPlaygroundOptions {
 	disableProgressBar?: boolean;
 	blueprint?: Blueprint;
 	onBlueprintStepCompleted?: OnStepCompleted;
+	/**
+	 * Called when the playground client is connected, but before the blueprint
+	 * steps are run.
+	 *
+	 * @param playground
+	 * @returns
+	 */
+	onClientConnected?: (playground: PlaygroundClient) => void;
 	/**
 	 * The SAPI name PHP will use.
 	 * @internal
@@ -2363,7 +2368,7 @@ export interface StartPlaygroundOptions {
  * @param options Options for loading the playground.
  * @returns A PlaygroundClient instance.
  */
-export declare function startPlaygroundWeb({ iframe, blueprint, remoteUrl, progressTracker, disableProgressBar, onBlueprintStepCompleted, sapiName, }: StartPlaygroundOptions): Promise<PlaygroundClient>;
+export declare function startPlaygroundWeb({ iframe, blueprint, remoteUrl, progressTracker, disableProgressBar, onBlueprintStepCompleted, onClientConnected, sapiName, }: StartPlaygroundOptions): Promise<PlaygroundClient>;
 /**
  * @deprecated Use `startPlayground` instead.
  *

package/index.js

@@ -269,7 +269,6 @@ const activatePlugin = async (e, { pluginPath: t, pluginName: r }, n) => {
   n == null || n.tracker.setCaption(`Activating ${r || t}`);
   const s = await e.documentRoot;
   await e.run({
-    throwOnError: !0,
     code: `<?php
 define( 'WP_ADMIN', true );
 require_once( ${phpVar(s)}. "/wp-load.php" );
@@ -301,7 +300,6 @@ exit(1);
   r == null || r.tracker.setCaption(`Activating ${t}`);
   const n = await e.documentRoot;
   await e.run({
-    throwOnError: !0,
     code: `<?php
 define( 'WP_ADMIN', true );
 require_once( ${phpVar(n)}. "/wp-load.php" );
@@ -312,7 +310,7 @@ set_current_user( get_users(array('role' => 'Administrator') )[0] );
 switch_theme( ${phpVar(t)} );
 `
   });
-}, runPHP = async (e, { code: t }) => await e.run({ code: t, throwOnError: !0 }), runPHPWithOptions = async (e, { options: t }) => await e.run(t), rm = async (e, { path: t }) => {
+}, runPHP = async (e, { code: t }) => await e.run({ code: t }), runPHPWithOptions = async (e, { options: t }) => await e.run(t), rm = async (e, { path: t }) => {
   await e.unlink(t);
 }, runSql = async (e, { sql: t }, r) => {
   r == null || r.tracker.setCaption("Executing SQL Queries");
@@ -712,7 +710,6 @@ async function rewriteDefineCalls(e, t, r) {
     consts: r
   });
   return await e.run({
-    throwOnError: !0,
     code: `${rewriteWpConfigToDefineConstants}
 	$wp_config_path = '/tmp/code.php';
 	$wp_config = file_get_contents($wp_config_path);
@@ -745,7 +742,6 @@ const login = async (e, { username: t = "admin", password: r = "password" } = {}
 }, setSiteOptions = async (e, { options: t }) => {
   const r = await e.documentRoot;
   await e.run({
-    throwOnError: !0,
     code: `<?php
 		include ${phpVar(r)} . '/wp-load.php';
 		$site_options = ${phpVar(t)};
@@ -758,7 +754,6 @@ const login = async (e, { username: t = "admin", password: r = "password" } = {}
 }, updateUserMeta = async (e, { meta: t, userId: r }) => {
   const n = await e.documentRoot;
   await e.run({
-    throwOnError: !0,
     code: `<?php
 		include ${phpVar(n)} . '/wp-load.php';
 		$meta = ${phpVar(t)};
@@ -794,7 +789,6 @@ const enableMultisite = async (e) => {
     }
   }), await login(e, {});
   const s = await e.documentRoot, o = (await e.run({
-    throwOnError: !0,
     code: `<?php
 define( 'WP_ADMIN', true );
 require_once(${phpVar(s)} . "/wp-load.php");
@@ -1035,7 +1029,6 @@ function delTree($dir)
 `;
 async function runPhpWithZipFunctions(e, t) {
   return await e.run({
-    throwOnError: !0,
     code: zipFunctions + t
   });
 }
@@ -1101,7 +1094,6 @@ const tmpPath = "/tmp/file.zip", unzip = async (e, { zipFile: t, zipPath: r, ext
     joinPaths(n, "wp-admin", "upgrade.php")
   );
   await e.run({
-    throwOnError: !0,
     code: `<?php
             $_GET['step'] = 'upgrade_db';
             require ${u};
@@ -1942,7 +1934,8 @@ class PHPRequestHandler {
   /** @inheritDoc */
   async request(t) {
     const r = t.url.startsWith("http://") || t.url.startsWith("https://"), n = new URL(
-      t.url,
+      // Remove the hash part of the URL as it's not meant for the server.
+      t.url.split("#")[0],
       r ? void 0 : DEFAULT_BASE_URL
     ), s = applyRewriteRules(
       removePathPrefix(n.pathname, H(this, ve)),
@@ -2353,7 +2346,7 @@ class BasePHP {
       for (const c in i)
         ce(this, Tt, rr).call(this, c, i[c]);
       const o = await ce(this, Ct, sr).call(this);
-      if (e.throwOnError && o.exitCode !== 0) {
+      if (o.exitCode !== 0) {
         const c = {
           stdout: o.text,
           stderr: o.errors
@@ -2362,13 +2355,15 @@ class BasePHP {
         const d = new Error(
           `PHP.run() failed with exit code ${o.exitCode} and the following output: ` + o.errors
         );
-        throw d.output = c, console.error(d), d;
+        throw d.output = c, d.source = "request", console.error(d), d;
       }
       return o;
     } catch (n) {
       throw this.dispatchEvent({
         type: "request.error",
-        error: n
+        error: n,
+        // Distinguish between PHP request and PHP-wasm errors
+        source: n.source ?? "php-wasm"
       }), n;
     } finally {
       try {
@@ -9182,10 +9177,6 @@ for existing apps using this option.`
       code: {
         type: "string",
         description: "The code snippet to eval instead of a php file."
-      },
-      throwOnError: {
-        type: "boolean",
-        description: "Whether to throw an error if the PHP process exits with a non-zero code or outputs to stderr."
       }
     },
     additionalProperties: !1
@@ -9764,7 +9755,10 @@ class Logger extends EventTarget {
    * @param PromiseRejectionEvent event
    */
   logUnhandledRejection(t) {
-    this.log(`${t.reason.stack}`, "Error");
+    if (!(t != null && t.reason))
+      return;
+    const r = (t == null ? void 0 : t.reason.stack) ?? t.reason;
+    this.log(r, "Error");
   }
   /**
    * Register a listener for the window error events and log the data.
@@ -9794,7 +9788,8 @@ class Logger extends EventTarget {
       ), this.dispatchEvent(
         new CustomEvent(this.fatalErrorEvent, {
           detail: {
-            logs: this.getLogs()
+            logs: this.getLogs(),
+            source: r.source
           }
         })
       ));
@@ -9872,27 +9867,35 @@ async function startPlaygroundWeb({
   progressTracker: n = new ProgressTracker(),
   disableProgressBar: s,
   onBlueprintStepCompleted: i,
-  sapiName: o
+  onClientConnected: o = () => {
+  },
+  sapiName: c
 }) {
   if (assertValidRemote(r), allowStorageAccessByUserActivation(e), r = setQueryParams(r, {
     progressbar: !s
-  }), n.setCaption("Preparing WordPress"), !t)
-    return doStartPlaygroundWeb(e, r, n);
-  const c = compileBlueprint(t, {
+  }), n.setCaption("Preparing WordPress"), !t) {
+    const p = await doStartPlaygroundWeb(
+      e,
+      r,
+      n
+    );
+    return o(p), p;
+  }
+  const d = compileBlueprint(t, {
     progress: n.stage(0.5),
     onStepCompleted: i
-  }), d = await doStartPlaygroundWeb(
+  }), u = await doStartPlaygroundWeb(
     e,
     setQueryParams(r, {
-      php: c.versions.php,
-      wp: c.versions.wp,
-      "sapi-name": o,
-      "php-extension": c.phpExtensions,
-      networking: c.features.networking ? "yes" : "no"
+      php: d.versions.php,
+      wp: d.versions.wp,
+      "sapi-name": c,
+      "php-extension": d.phpExtensions,
+      networking: d.features.networking ? "yes" : "no"
     }),
     n
   );
-  return collectPhpLogs(logger, d), await runBlueprintSteps(c, d), n.finish(), d;
+  return collectPhpLogs(logger, u), o(u), await runBlueprintSteps(d, u), n.finish(), u;
 }
 function allowStorageAccessByUserActivation(e) {
   var t, r;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wp-playground/client",
-	"version": "0.6.8",
+	"version": "0.6.9",
 	"description": "WordPress Playground client",
 	"repository": {
 		"type": "git",
@@ -37,7 +37,7 @@
 	"main": "./index.cjs",
 	"module": "./index.js",
 	"types": "index.d.ts",
-	"gitHead": "cb7b1af260489022238495a2fc0d96f767a1294a",
+	"gitHead": "f6b98ad6d05617ee8cb1234c21318fdde17a6e56",
 	"engines": {
 		"node": ">=18.18.2",
 		"npm": ">=8.11.0"