@php-wasm/universal 0.3.0 → 0.4.0

package/lib/base-php.d.ts

@@ -2,7 +2,7 @@ import { PHPBrowser } from './php-browser';
 import { PHPRequestHandlerConfiguration } from './php-request-handler';
 import { PHPResponse } from './php-response';
 import type { PHPRuntimeId } from './load-php-runtime';
-import { IsomorphicLocalPHP, MessageListener, PHPRequest, PHPRunOptions, RmDirOptions, ListFilesOptions } from './universal-php';
+import { IsomorphicLocalPHP, MessageListener, PHPRequest, PHPRequestHeaders, PHPRunOptions, RmDirOptions, ListFilesOptions, SpawnHandler, PHPEventListener, PHPEvent } from './universal-php';
 export declare const __private__dont__use: unique symbol;
 /**
  * An environment-agnostic wrapper around the Emscripten PHP runtime
@@ -24,9 +24,14 @@ export 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;
@@ -46,6 +51,7 @@ export 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 */
@@ -68,5 +74,6 @@ export declare abstract class BasePHP implements IsomorphicLocalPHP {
     isDir(path: string): boolean;
     /** @inheritDoc */
     fileExists(path: string): boolean;
+    exit(code?: number): any;
 }
-export declare function normalizeHeaders(headers: PHPRunOptions['headers']): PHPRunOptions['headers'];
+export declare function normalizeHeaders(headers: PHPRequestHeaders): PHPRequestHeaders;

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-export type { FileInfo, IsomorphicLocalPHP, IsomorphicRemotePHP, MessageListener, PHPOutput, PHPRunOptions, UniversalPHP, ListFilesOptions, RmDirOptions, HTTPMethod, PHPRequest, PHPRequestHeaders, RequestHandler, } from './universal-php';
+export type { FileInfo, IsomorphicLocalPHP, IsomorphicRemotePHP, MessageListener, PHPOutput, PHPRunOptions, UniversalPHP, ListFilesOptions, RmDirOptions, PHPEvent, PHPEventListener, HTTPMethod, PHPRequest, PHPRequestHeaders, RequestHandler, SpawnHandler, } from './universal-php';
 export { UnhandledRejectionsTarget } from './wasm-error-reporting';
 export { PHPResponse } from './php-response';
 export type { PHPResponseData } from './php-response';

package/lib/php-browser.d.ts

@@ -49,4 +49,6 @@ export declare class PHPBrowser implements RequestHandler {
     get absoluteUrl(): string;
     /** @inheritDoc */
     get documentRoot(): string;
+    setCookies(cookies: string[]): void;
+    serializeCookies(): string;
 }

package/lib/supported-php-versions.d.ts

@@ -1,4 +1,4 @@
-export declare const SupportedPHPVersions: readonly ["8.2", "8.1", "8.0", "7.4", "7.3", "7.2", "7.1", "7.0", "5.6"];
-export declare const LatestSupportedPHPVersion: "8.2";
+export declare const SupportedPHPVersions: readonly ["8.3", "8.2", "8.1", "8.0", "7.4", "7.3", "7.2", "7.1", "7.0"];
+export declare const LatestSupportedPHPVersion: "8.3";
 export declare const SupportedPHPVersionsList: string[];
 export type SupportedPHPVersion = (typeof SupportedPHPVersions)[number];

package/lib/universal-php.d.ts

@@ -1,12 +1,28 @@
 import { Remote } from 'comlink';
 import { PHPResponse } from './php-response';
+/**
+ * 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.
  *
  * @public
  * @example Use PHPRequestHandler implicitly with a new PHP instance:
  * ```js
- * import { PHP } from '@php-wasm/web';
+ * import { PHP } from '../../../web/src/index.ts';
  *
  * const php = await PHP.load( '7.4', {
  *     requestHandler: {
@@ -131,6 +147,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.
      *
@@ -343,8 +377,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;
+interface EventEmitter {
+    on(event: string, listener: (...args: any[]) => void): this;
+    emit(event: string, ...args: any[]): boolean;
 }
-export type MessageListener = (data: string) => void;
+type ChildProcess = EventEmitter & {
+    stdout: EventEmitter;
+    stderr: EventEmitter;
+};
+export type SpawnHandler = (command: string) => ChildProcess;
 export type IsomorphicRemotePHP = Remote<IsomorphicLocalPHP>;
 export type UniversalPHP = IsomorphicLocalPHP | IsomorphicRemotePHP;
 export type HTTPMethod = 'GET' | 'POST' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'PUT' | 'DELETE';
@@ -441,3 +492,4 @@ export interface ListFilesOptions {
      */
     prependPath: boolean;
 }
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@php-wasm/universal",
-	"version": "0.3.0",
+	"version": "0.4.0",
 	"description": "PHP.wasm – emscripten bindings for PHP",
 	"repository": {
 		"type": "git",
@@ -36,7 +36,7 @@
 	"main": "./index.cjs",
 	"module": "./index.js",
 	"license": "GPL-2.0-or-later",
-	"gitHead": "6890ff9243f9a10f0b86755fead101647a8c8535",
+	"gitHead": "0851e71512709843af0539f747caded8ea904fe6",
 	"engines": {
 		"node": ">=16.15.1",
 		"npm": ">=8.11.0"