@php-wasm/web 0.1.60 → 0.2.0

package/.htaccess

@@ -1,5 +1 @@
 AddType application/wasm .wasm
-
-<FilesMatch "iframe-worker.html$">
-  Header set Origin-Agent-Cluster: ?1
-</FilesMatch>

package/index.d.ts

@@ -20,6 +20,7 @@ export declare function consumeAPI<APIType>(remote: Worker | Window): RemoteAPI<
 export type PublicAPI<Methods, PipedAPI = unknown> = RemoteAPI<Methods & PipedAPI>;
 export declare function exposeAPI<Methods, PipedAPI>(apiMethods?: Methods, pipedApi?: PipedAPI): [
 	() => void,
+	(e: Error) => void,
 	PublicAPI<Methods, PipedAPI>
 ];
 export interface PHPResponseData {
@@ -142,7 +143,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"
@@ -372,7 +373,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 {
@@ -577,7 +619,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;
@@ -592,6 +636,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;
@@ -676,7 +722,6 @@ export declare class WebPHP extends BasePHP {
 	static loadSync(phpVersion: SupportedPHPVersion, options?: PHPWebLoaderOptions): {
 		php: WebPHP;
 		phpReady: Promise<WebPHP>;
-		dataModules: Promise<DataModule[]>;
 	};
 }
 /**
@@ -729,6 +774,8 @@ export declare class WebPHPEndpoint implements IsomorphicLocalPHP {
 	isDir(path: string): boolean;
 	/** @inheritDoc @php-wasm/web!WebPHP.fileExists */
 	fileExists(path: string): boolean;
+	/** @inheritDoc @php-wasm/web!WebPHP.onMessage */
+	onMessage(listener: MessageListener): void;
 }
 export declare function getPHPLoaderModule(version?: SupportedPHPVersion): Promise<PHPLoaderModule>;
 /**
@@ -741,23 +788,15 @@ export declare function getPHPLoaderModule(version?: SupportedPHPVersion): Promi
  *                                 mismatched with the actual version, the service worker
  *                                 will be re-registered.
  */
-export declare function registerServiceWorker<Client extends Remote<WebPHPEndpoint>>(phpApi: Client, scope: string, scriptUrl: string, expectedVersion: string): Promise<void>;
+export declare function registerServiceWorker<Client extends Remote<WebPHPEndpoint>>(phpApi: Client, scope: string, scriptUrl: string): Promise<void>;
 export declare function parseWorkerStartupOptions<T extends Record<string, string>>(): T;
-/**
- * Recommended Worker Thread backend.
- * It's typically "webworker", but in Firefox it's "iframe"
- * because Firefox doesn't support module workers with dynamic imports.
- * See https://github.com/mdn/content/issues/24402
- */
-export declare const recommendedWorkerBackend: string;
 /**
  * Spawns a new Worker Thread.
  *
  * @param  workerUrl The absolute URL of the worker script.
- * @param  workerBackend     The Worker Thread backend to use. Either 'webworker' or 'iframe'.
  * @param  config
  * @returns The spawned Worker Thread.
  */
-export declare function spawnPHPWorkerThread(workerUrl: string, workerBackend?: "webworker" | "iframe", startupOptions?: Record<string, string>): Promise<Window | Worker>;
+export declare function spawnPHPWorkerThread(workerUrl: string, startupOptions?: Record<string, string>): Promise<Worker>;
 
 export {};