@php-wasm/web 0.5.6 → 0.6.0

package/index.d.ts

@@ -71,17 +71,29 @@ declare class PHPResponse implements PHPResponseData {
 	get text(): string;
 }
 /**
- * Represents an event related to the PHP filesystem.
+ * Represents an event related to the PHP request.
  */
 export interface PHPRequestEndEvent {
 	type: "request.end";
 }
+/**
+ * Represents a PHP runtime initialization event.
+ */
+export interface PHPRuntimeInitializedEvent {
+	type: "runtime.initialized";
+}
+/**
+ * Represents a PHP runtime destruction event.
+ */
+export interface PHPRuntimeBeforeDestroyEvent {
+	type: "runtime.beforedestroy";
+}
 /**
  * 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;
+export type PHPEvent = PHPRequestEndEvent | PHPRuntimeInitializedEvent | PHPRuntimeBeforeDestroyEvent;
 /**
  * A callback function that handles PHP events.
  */
@@ -217,6 +229,11 @@ export interface RequestHandler {
 	documentRoot: string;
 }
 export interface IsomorphicLocalPHP extends RequestHandler {
+	/**
+	 * Sets the SAPI name exposed by the PHP module.
+	 * @param newName - The new SAPI name.
+	 */
+	setSapiName(newName: string): void;
 	/**
 	 * Defines a constant in the PHP runtime.
 	 * @param key - The name of the constant.
@@ -454,7 +471,7 @@ export interface IsomorphicLocalPHP extends RequestHandler {
 	 *
 	 * @param handler Callback function to spawn a process.
 	 */
-	setSpawnHandler(handler: SpawnHandler): void;
+	setSpawnHandler(handler: SpawnHandler | string): void;
 }
 export type MessageListener = (data: string) => Promise<string | Uint8Array | void> | string | void;
 export interface EventEmitter {
@@ -465,7 +482,7 @@ export type ChildProcess = EventEmitter & {
 	stdout: EventEmitter;
 	stderr: EventEmitter;
 };
-export type SpawnHandler = (command: string) => ChildProcess;
+export type SpawnHandler = (command: string, args: string[]) => ChildProcess;
 export type HTTPMethod = "GET" | "POST" | "HEAD" | "OPTIONS" | "PATCH" | "PUT" | "DELETE";
 export type PHPRequestHeaders = Record<string, string>;
 export interface PHPRequest {
@@ -528,6 +545,11 @@ 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;
 }
 export interface FileInfo {
 	key: string;
@@ -661,7 +683,6 @@ export type EmscriptenOptions = {
 	ENV?: Record<string, string>;
 	locateFile?: (path: string) => string;
 	noInitialRun?: boolean;
-	dataFileDownloads?: Record<string, number>;
 	print?: (message: string) => void;
 	printErr?: (message: string) => void;
 	quit?: (status: number, toThrow: any) => void;
@@ -670,11 +691,28 @@ export type EmscriptenOptions = {
 	onMessage?: (listener: EmscriptenMessageListener) => void;
 } & Record<string, any>;
 export type EmscriptenMessageListener = (type: string, data: string) => void;
+export interface SemaphoreOptions {
+	concurrency: number;
+}
+declare class Semaphore {
+	private _running;
+	private concurrency;
+	private queue;
+	constructor({ concurrency }: SemaphoreOptions);
+	get running(): number;
+	acquire(): Promise<() => void>;
+	run<T>(fn: () => T | Promise<T>): Promise<T>;
+}
 declare const __private__dont__use: unique symbol;
 declare abstract class BasePHP implements IsomorphicLocalPHP {
 	#private;
 	protected [__private__dont__use]: any;
 	requestHandler?: PHPBrowser;
+	/**
+	 * An exclusive lock that prevent multiple requests from running at
+	 * the same time.
+	 */
+	semaphore: Semaphore;
 	/**
 	 * Initializes a PHP runtime.
 	 *
@@ -689,7 +727,7 @@ declare abstract class BasePHP implements IsomorphicLocalPHP {
 	/** @inheritDoc */
 	onMessage(listener: MessageListener): Promise<void>;
 	/** @inheritDoc */
-	setSpawnHandler(handler: SpawnHandler): Promise<void>;
+	setSpawnHandler(handler: SpawnHandler | string): Promise<void>;
 	/** @inheritDoc */
 	get absoluteUrl(): string;
 	/** @inheritDoc */
@@ -700,6 +738,8 @@ declare abstract class BasePHP implements IsomorphicLocalPHP {
 	internalUrlToPath(internalUrl: string): string;
 	initializeRuntime(runtimeId: PHPRuntimeId): void;
 	/** @inheritDoc */
+	setSapiName(newName: string): Promise<void>;
+	/** @inheritDoc */
 	setPhpIniPath(path: string): void;
 	/** @inheritDoc */
 	setPhpIniEntry(key: string, value: string): void;
@@ -710,7 +750,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;
+	defineConstant(key: string, value: string | boolean | number | null): void;
 	/** @inheritDoc */
 	mkdir(path: string): void;
 	/** @inheritDoc */
@@ -733,19 +773,20 @@ declare abstract class BasePHP implements IsomorphicLocalPHP {
 	isDir(path: string): boolean;
 	/** @inheritDoc */
 	fileExists(path: string): boolean;
-	exit(code?: number): any;
-}
-export interface MonitoredModule {
-	dependencyFilename: string;
-	dependenciesTotalSize: number;
+	/**
+	 * Hot-swaps the PHP runtime for a new one without
+	 * interrupting the operations of this PHP instance.
+	 *
+	 * @param runtime
+	 */
+	hotSwapPHPRuntime(runtime: number): void;
+	exit(code?: number): void;
 }
 declare class EmscriptenDownloadMonitor extends EventTarget {
 	#private;
-	constructor(modules?: MonitoredModule[]);
-	getEmscriptenOptions(): {
-		dataFileDownloads: Record<string, any>;
-	};
-	setModules(modules: MonitoredModule[]): void;
+	constructor();
+	expectAssets(assets: Record<string, number>): void;
+	monitorFetch(fetchPromise: Promise<Response>): Promise<Response>;
 }
 export interface PHPWebLoaderOptions {
 	emscriptenOptions?: EmscriptenOptions;
@@ -769,17 +810,7 @@ export declare class WebPHP extends BasePHP {
 	 * @returns A new PHP instance
 	 */
 	static load(phpVersion: SupportedPHPVersion, options?: PHPWebLoaderOptions): Promise<WebPHP>;
-	/**
-	 * Does what load() does, but synchronously returns
-	 * an object with the PHP instance and a promise that
-	 * resolves when the PHP instance is ready.
-	 *
-	 * @see load
-	 */
-	static loadSync(phpVersion: SupportedPHPVersion, options?: PHPWebLoaderOptions): {
-		php: WebPHP;
-		phpReady: Promise<WebPHP>;
-	};
+	static loadRuntime(phpVersion: SupportedPHPVersion, options?: PHPWebLoaderOptions): Promise<number>;
 }
 /**
  * A PHP client that can be used to run PHP code in the browser.
@@ -808,9 +839,11 @@ export declare class WebPHPEndpoint implements IsomorphicLocalPHP {
 	/** @inheritDoc @php-wasm/web!WebPHP.run */
 	run(request: PHPRunOptions): Promise<PHPResponse>;
 	/** @inheritDoc @php-wasm/web!WebPHP.setSpawnHandler */
-	setSpawnHandler(listener: SpawnHandler): void;
+	setSpawnHandler(listener: string | SpawnHandler): void;
 	/** @inheritDoc @php-wasm/web!WebPHP.chdir */
 	chdir(path: string): void;
+	/** @inheritDoc @php-wasm/web!WebPHP.setSapiName */
+	setSapiName(newName: string): void;
 	/** @inheritDoc @php-wasm/web!WebPHP.setPhpIniPath */
 	setPhpIniPath(path: string): void;
 	/** @inheritDoc @php-wasm/web!WebPHP.setPhpIniEntry */
@@ -836,7 +869,7 @@ export declare class WebPHPEndpoint implements IsomorphicLocalPHP {
 	/** @inheritDoc @php-wasm/web!WebPHP.onMessage */
 	onMessage(listener: MessageListener): void;
 	/** @inheritDoc @php-wasm/web!WebPHP.defineConstant */
-	defineConstant(key: string, value: string | number | null): void;
+	defineConstant(key: string, value: string | boolean | number | null): void;
 	/** @inheritDoc @php-wasm/web!WebPHP.addEventListener */
 	addEventListener(eventType: PHPEvent["type"], listener: PHPEventListener): void;
 	/** @inheritDoc @php-wasm/web!WebPHP.removeEventListener */