@php-wasm/web 0.1.45 → 0.1.49

package/{index-57df7e41.js → index-40326b86.js}

@@ -143,12 +143,12 @@ function fe(t) {
     return [];
   }
 }
-class v {
+class b {
   constructor(e, r, n, s = "", o = 0) {
     this.httpStatusCode = e, this.headers = r, this.bytes = n, this.exitCode = o, this.errors = s;
   }
   static fromRawData(e) {
-    return new v(
+    return new b(
       e.httpStatusCode,
       e.headers,
       e.bytes,
@@ -384,13 +384,13 @@ class be {
   #c(e) {
     const r = `${this.#e}${e}`;
     if (!this.php.fileExists(r))
-      return new v(
+      return new b(
         404,
         {},
         new TextEncoder().encode("404 File not found")
       );
     const n = this.php.readFileAsBuffer(r);
-    return new v(
+    return new b(
       200,
       {
         "content-length": [`${n.byteLength}`],
@@ -425,13 +425,13 @@ class be {
       }, i = [];
       if (e.files && Object.keys(e.files).length) {
         s = "POST";
-        for (const l in e.files) {
-          const c = e.files[l];
+        for (const c in e.files) {
+          const h = e.files[c];
           i.push({
-            key: l,
-            name: c.name,
-            type: c.type,
-            data: new Uint8Array(await c.arrayBuffer())
+            key: c,
+            name: h.name,
+            type: h.type,
+            data: new Uint8Array(await h.arrayBuffer())
           });
         }
         o["content-type"]?.startsWith("multipart/form-data") && (e.formData = Ee(
@@ -439,9 +439,20 @@ class be {
         ), o["content-type"] = "application/x-www-form-urlencoded", delete e.body);
       }
       let a;
-      return e.formData !== void 0 ? (s = "POST", o["content-type"] = o["content-type"] || "application/x-www-form-urlencoded", a = new URLSearchParams(
+      e.formData !== void 0 ? (s = "POST", o["content-type"] = o["content-type"] || "application/x-www-form-urlencoded", a = new URLSearchParams(
         e.formData
-      ).toString()) : a = e.body, await this.php.run({
+      ).toString()) : a = e.body;
+      let l;
+      try {
+        l = this.#h(r.pathname);
+      } catch {
+        return new b(
+          404,
+          {},
+          new TextEncoder().encode("404 File not found")
+        );
+      }
+      return await this.php.run({
         relativeUri: Pe(
           j(r),
           this.#s
@@ -450,7 +461,7 @@ class be {
         method: e.method || s,
         body: a,
         fileInfos: i,
-        scriptPath: this.#h(r.pathname),
+        scriptPath: l,
         headers: o
       });
     } finally {
@@ -463,13 +474,18 @@ class be {
    * Fall back to index.php as if there was a url rewriting rule in place.
    *
    * @param  requestedPath - The requested pathname.
+   * @throws {Error} If the requested path doesn't exist.
    * @returns The resolved filesystem path.
    */
   #h(e) {
     let r = G(e, this.#s);
     r.includes(".php") ? r = r.split(".php")[0] + ".php" : (r.endsWith("/") || (r += "/"), r.endsWith("index.php") || (r += "index.php"));
     const n = `${this.#e}${r}`;
-    return this.php.fileExists(n) ? n : `${this.#e}/index.php`;
+    if (this.php.fileExists(n))
+      return n;
+    if (!this.php.fileExists(`${this.#e}/index.php`))
+      throw new Error(`File not found: ${n}`);
+    return `${this.#e}/index.php`;
   }
 }
 function Ee(t) {
@@ -665,7 +681,7 @@ var xe = Object.defineProperty, Te = Object.getOwnPropertyDescriptor, w = (t, e,
     (i = t[o]) && (s = (n ? i(e, r, s) : i(s)) || s);
   return n && s && xe(e, r, s), s;
 };
-const f = "string", b = "number", u = Symbol("__private__dont__use");
+const f = "string", E = "number", u = Symbol("__private__dont__use");
 class m {
   /**
    * Initializes a PHP runtime.
@@ -812,7 +828,7 @@ class m {
     (!n || isNaN(n) || n === 80) && (n = r === "https" ? 443 : 80), this[u].ccall(
       "wasm_set_request_port",
       null,
-      [b],
+      [E],
       [n]
     ), (r === "https" || !r && n === 443) && this.addServerGlobalEntry("HTTPS", "on");
   }
@@ -838,7 +854,7 @@ class m {
     ), e["content-length"] && this[u].ccall(
       "wasm_set_content_length",
       null,
-      [b],
+      [E],
       [parseInt(e["content-length"], 10)]
     );
     for (const r in e)
@@ -856,7 +872,7 @@ class m {
     ), this[u].ccall(
       "wasm_set_content_length",
       null,
-      [b],
+      [E],
       [new TextEncoder().encode(e).length]
     );
   }
@@ -896,7 +912,7 @@ class m {
     this[u].ccall(
       "wasm_add_uploaded_file",
       null,
-      [f, f, f, f, b, b],
+      [f, f, f, f, E, E],
       [r, n, s, i, a, o.byteLength]
     );
   }
@@ -911,32 +927,21 @@ class m {
   async #m() {
     let e, r;
     try {
-      e = await new Promise(async (o, i) => {
-        r = (a) => {
-          const l = new Error("Rethrown");
-          l.cause = a.error, l.betterMessage = a.message, i(l);
+      e = await new Promise((o, i) => {
+        r = (l) => {
+          const c = new Error("Rethrown");
+          c.cause = l.error, c.betterMessage = l.message, i(c);
         }, this.#n?.addEventListener(
           "error",
           r
         );
-        try {
-          o(
-            /**
-             * This is awkward, but Asyncify makes wasm_sapi_handle_request return
-             * Promise<Promise<number>>.
-             *
-             * @TODO: Determine whether this is a bug in emscripten or in our code.
-             */
-            await await this[u].ccall(
-              "wasm_sapi_handle_request",
-              b,
-              [],
-              []
-            )
-          );
-        } catch (a) {
-          i(a);
-        }
+        const a = this[u].ccall(
+          "wasm_sapi_handle_request",
+          E,
+          [],
+          []
+        );
+        return a instanceof Promise ? a.then(o, i) : o(a);
       });
     } catch (o) {
       for (const c in this)
@@ -952,7 +957,7 @@ class m {
       this.#n?.removeEventListener("error", r), this.#r = {};
     }
     const { headers: n, httpStatusCode: s } = this.#s();
-    return new v(
+    return new b(
       s,
       n,
       this.readFileAsBuffer("/tmp/stdout"),
@@ -1159,7 +1164,7 @@ function k(t) {
     throw new Error("Proxy has been released and is not useable");
 }
 function ee(t) {
-  return E(t, {
+  return v(t, {
     type: "RELEASE"
   }).then(() => {
     Z(t);
@@ -1188,7 +1193,7 @@ function O(t, e = [], r = function() {
       if (i === "then") {
         if (e.length === 0)
           return { then: () => s };
-        const a = E(t, {
+        const a = v(t, {
           type: "GET",
           path: e.map((l) => l.toString())
         }).then(P);
@@ -1199,7 +1204,7 @@ function O(t, e = [], r = function() {
     set(o, i, a) {
       k(n);
       const [l, c] = C(a);
-      return E(t, {
+      return v(t, {
         type: "SET",
         path: [...e, i].map((h) => h.toString()),
         value: l
@@ -1209,13 +1214,13 @@ function O(t, e = [], r = function() {
       k(n);
       const l = e[e.length - 1];
       if (l === _e)
-        return E(t, {
+        return v(t, {
           type: "ENDPOINT"
         }).then(P);
       if (l === "bind")
         return O(t, e.slice(0, -1));
       const [c, h] = Y(a);
-      return E(t, {
+      return v(t, {
         type: "APPLY",
         path: e.map((g) => g.toString()),
         argumentList: c
@@ -1224,7 +1229,7 @@ function O(t, e = [], r = function() {
     construct(o, i) {
       k(n);
       const [a, l] = Y(i);
-      return E(t, {
+      return v(t, {
         type: "CONSTRUCT",
         path: e.map((c) => c.toString()),
         argumentList: a
@@ -1283,7 +1288,7 @@ function P(t) {
       return t.value;
   }
 }
-function E(t, e, r) {
+function v(t, e, r) {
   return new Promise((n) => {
     const s = Ne();
     t.addEventListener("message", function o(i) {
@@ -1342,7 +1347,7 @@ function se() {
       return [t.toRawData(), []];
     },
     deserialize(t) {
-      return v.fromRawData(t);
+      return b.fromRawData(t);
     }
   }));
 }
@@ -1443,22 +1448,25 @@ class Ge {
       monitor: r
     }), this.absoluteUrl = e.absoluteUrl, this.documentRoot = e.documentRoot;
   }
-  /** @inheritDoc */
+  /** @inheritDoc @php-wasm/universal!RequestHandler.pathToInternalUrl  */
   pathToInternalUrl(e) {
     return d.get(this).php.pathToInternalUrl(e);
   }
-  /** @inheritDoc */
+  /** @inheritDoc @php-wasm/universal!RequestHandler.internalUrlToPath  */
   internalUrlToPath(e) {
     return d.get(this).php.internalUrlToPath(e);
   }
+  /**
+   * The onDownloadProgress event listener.
+   */
   async onDownloadProgress(e) {
     return d.get(this).monitor?.addEventListener("progress", e);
   }
-  /** @inheritDoc */
+  /** @inheritDoc @php-wasm/universal!IsomorphicLocalPHP.mv  */
   mv(e, r) {
     return d.get(this).php.mv(e, r);
   }
-  /** @inheritDoc */
+  /** @inheritDoc @php-wasm/universal!IsomorphicLocalPHP.rmdir  */
   rmdir(e, r) {
     return d.get(this).php.rmdir(e, r);
   }

package/index.d.ts

@@ -15,7 +15,7 @@ export type WithAPIState = {
 	 */
 	isReady: () => Promise<void>;
 };
-export type RemoteAPI<T> = Comlink.Remote<T & WithAPIState>;
+export type RemoteAPI<T> = Comlink.Remote<T> & WithAPIState;
 export declare function consumeAPI<APIType>(remote: Worker | Window): RemoteAPI<APIType>;
 export type PublicAPI<Methods, PipedAPI = unknown> = RemoteAPI<Methods & PipedAPI>;
 export declare function exposeAPI<Methods, PipedAPI>(apiMethods?: Methods, pipedApi?: PipedAPI): [
@@ -127,7 +127,33 @@ export interface RequestHandler {
 	/**
 	 * Serves the request – either by serving a static file, or by
 	 * dispatching it to the PHP runtime.
-	 * Cannot be used in conjunction with `cli()`.
+	 *
+	 * The request() method mode behaves like a web server and only works if
+	 * the PHP was initialized with a `requestHandler` option (which the online version
+	 * of WordPress Playground does by default).
+	 *
+	 * In the request mode, you pass an object containing the request information
+	 * (method, headers, body, etc.) and the path to the PHP file to run:
+	 *
+	 * ```ts
+	 * const php = PHP.load('7.4', {
+	 * 	requestHandler: {
+	 * 		documentRoot: "/www"
+	 * 	}
+	 * })
+	 * php.writeFile("/www/index.php", `<?php echo file_get_contents("php://input");`);
+	 * const result = await php.run({
+	 * 	method: "GET",
+	 * 	headers: {
+	 * 		"Content-Type": "text/plain"
+	 * 	},
+	 * 	body: "Hello world!",
+	 * 	path: "/www/index.php"
+	 * });
+	 * // result.text === "Hello world!"
+	 * ```
+	 *
+	 * The `request()` method cannot be used in conjunction with `cli()`.
 	 *
 	 * @example
 	 * ```js
@@ -174,7 +200,18 @@ export interface RequestHandler {
 	documentRoot: string;
 }
 export interface IsomorphicLocalPHP extends RequestHandler {
+	/**
+	 * Sets the path to the php.ini file to use for the PHP instance.
+	 *
+	 * @param path - The path to the php.ini file.
+	 */
 	setPhpIniPath(path: string): void;
+	/**
+	 * Sets a value for a specific key in the php.ini file for the PHP instance.
+	 *
+	 * @param key - The key to set the value for.
+	 * @param value - The value to set for the key.
+	 */
 	setPhpIniEntry(key: string, value: string): void;
 	/**
 	 * Recursively creates a directory with the given path in the PHP filesystem.
@@ -266,24 +303,72 @@ export interface IsomorphicLocalPHP extends RequestHandler {
 	chdir(path: string): void;
 	/**
 	 * Runs PHP code.
-	 * Cannot be used in conjunction with `cli()`.
 	 *
-	 * @example
-	 * ```js
-	 * const output = await php.run('<?php echo "Hello world!";');
-	 * console.log(output.stdout); // "Hello world!"
+	 * This low-level method directly interacts with the WebAssembly
+	 * PHP interpreter.
+	 *
+	 * Every time you call run(), it prepares the PHP
+	 * environment and:
+	 *
+	 * * Resets the internal PHP state
+	 * * Populates superglobals ($_SERVER, $_GET, etc.)
+	 * * Handles file uploads
+	 * * Populates input streams (stdin, argv, etc.)
+	 * * Sets the current working directory
+	 *
+	 * You can use run() in two primary modes:
+	 *
+	 * ### Code snippet mode
+	 *
+	 * In this mode, you pass a string containing PHP code to run.
+	 *
+	 * ```ts
+	 * const result = await php.run({
+	 * 	code: `<?php echo "Hello world!";`
+	 * });
+	 * // result.text === "Hello world!"
 	 * ```
 	 *
+	 * In this mode, information like __DIR__ or __FILE__ isn't very
+	 * useful because the code is not associated with any file.
+	 *
+	 * Under the hood, the PHP snippet is passed to the `zend_eval_string`
+	 * C function.
+	 *
+	 * ### File mode
+	 *
+	 * In the file mode, you pass a scriptPath and PHP executes a file
+	 * found at a that path:
+	 *
+	 * ```ts
+	 * php.writeFile(
+	 * 	"/www/index.php",
+	 * 	`<?php echo "Hello world!";"`
+	 * );
+	 * const result = await php.run({
+	 * 	scriptPath: "/www/index.php"
+	 * });
+	 * // result.text === "Hello world!"
+	 * ```
+	 *
+	 * In this mode, you can rely on path-related information like __DIR__
+	 * or __FILE__.
+	 *
+	 * Under the hood, the PHP file is executed with the `php_execute_script`
+	 * C function.
+	 *
+	 * The `run()` method cannot be used in conjunction with `cli()`.
+	 *
 	 * @example
 	 * ```js
-	 * console.log(await php.run(`<?php
+	 * const result = await php.run(`<?php
 	 *  $fp = fopen('php://stderr', 'w');
 	 *  fwrite($fp, "Hello, world!");
-	 * `));
-	 * // {"exitCode":0,"stdout":"","stderr":["Hello, world!"]}
+	 * `);
+	 * // result.errors === "Hello, world!"
 	 * ```
 	 *
-	 * @param  options - PHP run options.
+	 * @param  options - PHP runtime options.
 	 */
 	run(options: PHPRunOptions): Promise<PHPResponse>;
 }
@@ -590,20 +675,23 @@ export declare class WebPHP extends BasePHP {
  * A PHP client that can be used to run PHP code in the browser.
  */
 export declare class WebPHPEndpoint implements IsomorphicLocalPHP {
-	/** @inheritDoc */
+	/** @inheritDoc @php-wasm/universal!RequestHandler.absoluteUrl  */
 	absoluteUrl: string;
-	/** @inheritDoc */
+	/** @inheritDoc @php-wasm/universal!RequestHandler.documentRoot  */
 	documentRoot: string;
 	/** @inheritDoc */
 	constructor(php: BasePHP, monitor?: EmscriptenDownloadMonitor);
-	/** @inheritDoc */
+	/** @inheritDoc @php-wasm/universal!RequestHandler.pathToInternalUrl  */
 	pathToInternalUrl(path: string): string;
-	/** @inheritDoc */
+	/** @inheritDoc @php-wasm/universal!RequestHandler.internalUrlToPath  */
 	internalUrlToPath(internalUrl: string): string;
+	/**
+	 * The onDownloadProgress event listener.
+	 */
 	onDownloadProgress(callback: (progress: CustomEvent<ProgressEvent>) => void): Promise<void>;
-	/** @inheritDoc */
+	/** @inheritDoc @php-wasm/universal!IsomorphicLocalPHP.mv  */
 	mv(fromPath: string, toPath: string): void;
-	/** @inheritDoc */
+	/** @inheritDoc @php-wasm/universal!IsomorphicLocalPHP.rmdir  */
 	rmdir(path: string, options?: RmDirOptions): void;
 	/** @inheritDoc @php-wasm/universal!RequestHandler.request */
 	request(request: PHPRequest, redirects?: number): Promise<PHPResponse>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@php-wasm/web",
-	"version": "0.1.45",
+	"version": "0.1.49",
 	"description": "PHP.wasm for the web",
 	"repository": {
 		"type": "git",
@@ -29,5 +29,5 @@
 	"type": "module",
 	"main": "index.js",
 	"types": "index.d.ts",
-	"gitHead": "ca75514c17b912dc8b5dc529f6d123295671320a"
+	"gitHead": "93834fa77a89c21be2ade4c1d67430981ed92c83"
 }