@php-wasm/web 0.2.0 → 0.3.0

package/README.md

@@ -0,0 +1,35 @@
+# WebAssembly PHP for the web
+
+This package ships WebAssembly PHP binaries and the JavaScript API optimized for the web and a low bundle size. It comes with the Libzip extension and the SQLite extension.
+
+Here's how to use it:
+
+```js
+import { PHP } from '@php-wasm/web';
+
+// PHP.load() calls import('php.wasm') internally
+// Your bundler must resolve import('php.wasm') as a static file URL.
+// If you use Webpack, you can use the file-loader to do so.
+const php = await PHP.load('8.0', {
+	requestHandler: {
+		documentRoot: '/www',
+	},
+});
+
+// Create and run a script directly
+php.mkdirTree('/www');
+php.writeFile('/www/index.php', `<?php echo "Hello " . $_POST['name']; ?>`);
+await php.run({ scriptPath: './index.php' });
+
+// Or use the familiar HTTP concepts:
+const response = await php.request({
+	method: 'POST',
+	url: '/index.php',
+	data: { name: 'John' },
+});
+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

@@ -520,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;
@@ -697,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 {
 	/**
@@ -777,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
@@ -789,7 +793,6 @@ export declare function getPHPLoaderModule(version?: SupportedPHPVersion): Promi
  *                                 will be re-registered.
  */
 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;
 /**
  * Spawns a new Worker Thread.
  *
@@ -797,6 +800,6 @@ export declare function parseWorkerStartupOptions<T extends Record<string, strin
  * @param  config
  * @returns The spawned Worker Thread.
  */
-export declare function spawnPHPWorkerThread(workerUrl: string, startupOptions?: Record<string, string>): Promise<Worker>;
+export declare function spawnPHPWorkerThread(workerUrl: string, startupOptions?: Record<string, string | string[]>): Promise<Worker>;
 
 export {};