@php-wasm/node 0.3.1 → 0.4.0

package/index.d.ts

@@ -47,6 +47,22 @@ declare class PHPResponse implements PHPResponseData {
 	 */
 	get text(): string;
 }
+/**
+ * Represents an event related to the PHP filesystem.
+ */
+export interface PHPRequestEndEvent {
+	type: "request.end";
+}
+/**
+ * Represents an event related to the PHP instance.
+ * This is intentionally not an extension of CustomEvent
+ * to make it isomorphic between different JavaScript runtimes.
+ */
+export type PHPEvent = PHPRequestEndEvent;
+/**
+ * A callback function that handles PHP events.
+ */
+export type PHPEventListener = (event: PHPEvent) => void;
 /**
  * Handles HTTP requests using PHP runtime as a backend.
  *
@@ -178,6 +194,24 @@ export interface RequestHandler {
 	documentRoot: string;
 }
 export interface IsomorphicLocalPHP extends RequestHandler {
+	/**
+	 * Defines a constant in the PHP runtime.
+	 * @param key - The name of the constant.
+	 * @param value - The value of the constant.
+	 */
+	defineConstant(key: string, value: string | number | null): void;
+	/**
+	 * Adds an event listener for a PHP event.
+	 * @param eventType - The type of event to listen for.
+	 * @param listener - The listener function to be called when the event is triggered.
+	 */
+	addEventListener(eventType: PHPEvent["type"], listener: PHPEventListener): void;
+	/**
+	 * Removes an event listener for a PHP event.
+	 * @param eventType - The type of event to remove the listener from.
+	 * @param listener - The listener function to be removed.
+	 */
+	removeEventListener(eventType: PHPEvent["type"], listener: PHPEventListener): void;
 	/**
 	 * Sets the path to the php.ini file to use for the PHP instance.
 	 *
@@ -390,8 +424,25 @@ export interface IsomorphicLocalPHP extends RequestHandler {
 	 * @param listener Callback function to handle the message.
 	 */
 	onMessage(listener: MessageListener): void;
+	/**
+	 * Registers a handler to spawns a child process when
+	 * `proc_open()`, `popen()`, `exec()`, `system()`, or `passthru()`
+	 * is called.
+	 *
+	 * @param handler Callback function to spawn a process.
+	 */
+	setSpawnHandler(handler: SpawnHandler): void;
+}
+export type MessageListener = (data: string) => Promise<string | Uint8Array | void> | string | void;
+export interface EventEmitter {
+	on(event: string, listener: (...args: any[]) => void): this;
+	emit(event: string, ...args: any[]): boolean;
 }
-export type MessageListener = (data: string) => void;
+export type ChildProcess = EventEmitter & {
+	stdout: EventEmitter;
+	stderr: EventEmitter;
+};
+export type SpawnHandler = (command: string) => ChildProcess;
 export type HTTPMethod = "GET" | "POST" | "HEAD" | "OPTIONS" | "PATCH" | "PUT" | "DELETE";
 export type PHPRequestHeaders = Record<string, string>;
 export interface PHPRequest {
@@ -476,6 +527,7 @@ export interface ListFilesOptions {
 	prependPath: boolean;
 }
 declare const SupportedPHPVersions: readonly [
+	"8.3",
 	"8.2",
 	"8.1",
 	"8.0",
@@ -483,8 +535,7 @@ declare const SupportedPHPVersions: readonly [
 	"7.3",
 	"7.2",
 	"7.1",
-	"7.0",
-	"5.6"
+	"7.0"
 ];
 export type SupportedPHPVersion = (typeof SupportedPHPVersions)[number];
 export interface PHPRequestHandlerConfiguration {
@@ -563,6 +614,8 @@ declare class PHPBrowser implements RequestHandler {
 	get absoluteUrl(): string;
 	/** @inheritDoc */
 	get documentRoot(): string;
+	setCookies(cookies: string[]): void;
+	serializeCookies(): string;
 }
 export type PHPRuntimeId = number;
 export type PHPRuntime = any;
@@ -571,6 +624,11 @@ export type PHPLoaderModule = {
 	dependenciesTotalSize: number;
 	init: (jsRuntime: string, options: EmscriptenOptions) => PHPRuntime;
 };
+export type DataModule = {
+	dependencyFilename: string;
+	dependenciesTotalSize: number;
+	default: (phpRuntime: PHPRuntime) => void;
+};
 export type EmscriptenOptions = {
 	onAbort?: (message: string) => void;
 	/**
@@ -602,9 +660,14 @@ declare abstract class BasePHP implements IsomorphicLocalPHP {
 	 * @param  serverOptions - Optional. Options for the PHPRequestHandler. If undefined, no request handler will be initialized.
 	 */
 	constructor(PHPRuntimeId?: PHPRuntimeId, serverOptions?: PHPRequestHandlerConfiguration);
+	addEventListener(eventType: PHPEvent["type"], listener: PHPEventListener): void;
+	removeEventListener(eventType: PHPEvent["type"], listener: PHPEventListener): void;
+	dispatchEvent<Event extends PHPEvent>(event: Event): void;
 	/** @inheritDoc */
 	onMessage(listener: MessageListener): Promise<void>;
 	/** @inheritDoc */
+	setSpawnHandler(handler: SpawnHandler): Promise<void>;
+	/** @inheritDoc */
 	get absoluteUrl(): string;
 	/** @inheritDoc */
 	get documentRoot(): string;
@@ -624,6 +687,7 @@ declare abstract class BasePHP implements IsomorphicLocalPHP {
 	/** @inheritDoc */
 	run(request: PHPRunOptions): Promise<PHPResponse>;
 	addServerGlobalEntry(key: string, value: string): void;
+	defineConstant(key: string, value: string | number | null): void;
 	/** @inheritDoc */
 	mkdir(path: string): void;
 	/** @inheritDoc */
@@ -646,12 +710,14 @@ declare abstract class BasePHP implements IsomorphicLocalPHP {
 	isDir(path: string): boolean;
 	/** @inheritDoc */
 	fileExists(path: string): boolean;
+	exit(code?: number): any;
 }
 export declare function getPHPLoaderModule(version?: SupportedPHPVersion): Promise<PHPLoaderModule>;
 export declare function withNetworking(phpModuleArgs?: EmscriptenOptions): Promise<EmscriptenOptions>;
 export interface PHPLoaderOptions {
 	emscriptenOptions?: EmscriptenOptions;
 	requestHandler?: PHPRequestHandlerConfiguration;
+	dataModules?: Array<DataModule | Promise<DataModule>>;
 }
 export type MountSettings = {
 	root: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@php-wasm/node",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "PHP.wasm for Node.js",
   "repository": {
     "type": "git",
@@ -28,7 +28,7 @@
   "license": "GPL-2.0-or-later",
   "main": "index.cjs",
   "types": "index.d.ts",
-  "gitHead": "73b285f8b496c7442474fd7325b3f6b1287cbf95",
+  "gitHead": "0851e71512709843af0539f747caded8ea904fe6",
   "engines": {
     "node": ">=16.15.1",
     "npm": ">=8.11.0"
@@ -38,7 +38,8 @@
     "express": "4.18.2",
     "ws": "8.13.0",
     "yargs": "17.7.2",
-    "@php-wasm/universal": "0.3.1",
-    "@php-wasm/util": "0.3.1"
+    "@php-wasm/node-polyfills": "0.4.0",
+    "@php-wasm/universal": "0.4.0",
+    "@php-wasm/util": "0.4.0"
   }
 }