@php-wasm/node 0.1.60 → 0.2.0

package/index.d.ts

@@ -120,7 +120,7 @@ export interface RequestHandler {
 	 * 	}
 	 * })
 	 * php.writeFile("/www/index.php", `<?php echo file_get_contents("php://input");`);
-	 * const result = await php.run({
+	 * const result = await php.request({
 	 * 	method: "GET",
 	 * 	headers: {
 	 * 		"Content-Type": "text/plain"
@@ -350,7 +350,48 @@ export interface IsomorphicLocalPHP extends RequestHandler {
 	 * @param  options - PHP runtime options.
 	 */
 	run(options: PHPRunOptions): Promise<PHPResponse>;
+	/**
+	 * Listens to message sent by the PHP code.
+	 *
+	 * To dispatch messages, call:
+	 *
+	 *     post_message_to_js(string $data)
+	 *
+	 *     Arguments:
+	 *         $data (string) – Data to pass to JavaScript.
+	 *
+	 * @example
+	 *
+	 * ```ts
+	 * const php = await PHP.load('8.0');
+	 *
+	 * php.onMessage(
+	 *     // The data is always passed as a string
+	 *     function (data: string) {
+	 *         // Let's decode and log the data:
+	 *         console.log(JSON.parse(data));
+	 *     }
+	 * );
+	 *
+	 * // Now that we have a listener in place, let's
+	 * // dispatch a message:
+	 * await php.run({
+	 *     code: `<?php
+	 *         post_message_to_js(
+	 *             json_encode([
+	 *                 'post_id' => '15',
+	 *                 'post_title' => 'This is a blog post!'
+	 *             ])
+	 *         ));
+	 *     `,
+	 * });
+	 * ```
+	 *
+	 * @param listener Callback function to handle the message.
+	 */
+	onMessage(listener: MessageListener): void;
 }
+export type MessageListener = (data: string) => void;
 export type HTTPMethod = "GET" | "POST" | "HEAD" | "OPTIONS" | "PATCH" | "PUT" | "DELETE";
 export type PHPRequestHeaders = Record<string, string>;
 export interface PHPRequest {
@@ -550,7 +591,9 @@ export type EmscriptenOptions = {
 	quit?: (status: number, toThrow: any) => void;
 	onRuntimeInitialized?: () => void;
 	monitorRunDependencies?: (left: number) => void;
+	onMessage?: (listener: EmscriptenMessageListener) => void;
 } & Record<string, any>;
+export type EmscriptenMessageListener = (type: string, data: string) => void;
 declare const __private__dont__use: unique symbol;
 declare abstract class BasePHP implements IsomorphicLocalPHP {
 	#private;
@@ -565,6 +608,8 @@ declare abstract class BasePHP implements IsomorphicLocalPHP {
 	 */
 	constructor(PHPRuntimeId?: PHPRuntimeId, serverOptions?: PHPRequestHandlerConfiguration);
 	/** @inheritDoc */
+	onMessage(listener: MessageListener): Promise<void>;
+	/** @inheritDoc */
 	get absoluteUrl(): string;
 	/** @inheritDoc */
 	get documentRoot(): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@php-wasm/node",
-  "version": "0.1.60",
+  "version": "0.2.0",
   "description": "PHP.wasm for Node.js",
   "repository": {
     "type": "git",
@@ -28,13 +28,17 @@
   "license": "GPL-2.0-or-later",
   "main": "index.cjs",
   "types": "index.d.ts",
-  "gitHead": "3046803036b19d2c73c63cb01dfb37b1c222d847",
+  "gitHead": "cd4062de74f7f18058d3f962e124d0fdff78b5a7",
+  "engines": {
+    "node": ">=16.15.1",
+    "npm": ">=8.11.0"
+  },
   "dependencies": {
     "comlink": "^4.4.1",
     "express": "4.18.2",
     "ws": "8.13.0",
     "yargs": "17.7.2",
-    "@php-wasm/universal": "0.1.60",
-    "@php-wasm/util": "0.1.60"
+    "@php-wasm/universal": "0.2.0",
+    "@php-wasm/util": "0.2.0"
   }
 }