@php-wasm/web 0.1.61 → 0.3.0

package/.htaccess

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

package/README.md

@@ -29,3 +29,7 @@ const response = await php.request({
 });
 console.log(response.text);
 ```
+
+## Attribution
+
+`@php-wasm/web` started as a fork of the original PHP to WebAssembly build published by Oraoto in https://github.com/oraoto/pib and modified by Sean Morris in https://github.com/seanmorris/php-wasm.

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"
@@ -380,7 +381,7 @@ export interface IsomorphicLocalPHP extends RequestHandler {
 	 *     post_message_to_js(string $data)
 	 *
 	 *     Arguments:
-	 *         $data – any extra information as a string
+	 *         $data (string) – Data to pass to JavaScript.
 	 *
 	 * @example
 	 *
@@ -519,11 +520,6 @@ export interface PHPRequestHandlerConfiguration {
 	 * Request Handler URL. Used to populate $_SERVER details like HTTP_HOST.
 	 */
 	absoluteUrl?: string;
-	/**
-	 * Callback used by the PHPRequestHandler to decide whether
-	 * the requested path refers to a PHP file or a static file.
-	 */
-	isStaticFilePath?: (path: string) => boolean;
 }
 declare class PHPRequestHandler implements RequestHandler {
 	#private;
@@ -696,6 +692,8 @@ export interface PHPWebLoaderOptions {
 	downloadMonitor?: EmscriptenDownloadMonitor;
 	requestHandler?: PHPRequestHandlerConfiguration;
 	dataModules?: Array<DataModule | Promise<DataModule>>;
+	/** @deprecated To be replaced with `extensions` in the future */
+	loadAllExtensions?: boolean;
 }
 export declare class WebPHP extends BasePHP {
 	/**
@@ -776,7 +774,14 @@ export declare class WebPHPEndpoint implements IsomorphicLocalPHP {
 	/** @inheritDoc @php-wasm/web!WebPHP.onMessage */
 	onMessage(listener: MessageListener): void;
 }
-export declare function getPHPLoaderModule(version?: SupportedPHPVersion): Promise<PHPLoaderModule>;
+/**
+ * Loads the PHP loader module for the given PHP version.
+ *
+ * @param version The PHP version to load.
+ * @param variant Internal. Do not use.
+ * @returns The PHP loader module.
+ */
+export declare function getPHPLoaderModule(version?: SupportedPHPVersion, variant?: "light" | "kitchen-sink"): Promise<PHPLoaderModule>;
 /**
  * Run this in the main application to register the service worker or
  * reload the registered worker if the app expects a different version
@@ -787,23 +792,14 @@ 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 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;
+export declare function registerServiceWorker<Client extends Remote<WebPHPEndpoint>>(phpApi: Client, scope: string, scriptUrl: string): Promise<void>;
 /**
  * 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 | string[]>): Promise<Worker>;
 
 export {};