@php-wasm/node 0.1.18 → 0.1.20

package/index.d.ts

@@ -1,10 +1,6 @@
 // Generated by dts-bundle-generator v7.2.0
 
-/**
- * PHP response. Body is an `ArrayBuffer` because it can
- * contain binary data.
- */
-export declare class PHPResponse {
+export interface PHPResponseData {
 	/**
 	 * Response headers.
 	 */
@@ -13,7 +9,7 @@ export declare class PHPResponse {
 	 * Response body. Contains the output from `echo`,
 	 * `print`, inline HTML etc.
 	 */
-	private readonly body;
+	readonly bytes: ArrayBuffer;
 	/**
 	 * Stderr contents, if any.
 	 */
@@ -27,7 +23,28 @@ export declare class PHPResponse {
 	 * Response HTTP status code, e.g. 200.
 	 */
 	readonly httpStatusCode: number;
+}
+/**
+ * PHP response. Body is an `ArrayBuffer` because it can
+ * contain binary data.
+ *
+ * This type is used in Comlink.transferHandlers.set('PHPResponse', { ... })
+ * so be sure to update that if you change this type.
+ */
+export declare class PHPResponse implements PHPResponseData {
+	/** @inheritDoc */
+	readonly headers: Record<string, string[]>;
+	/** @inheritDoc */
+	readonly bytes: ArrayBuffer;
+	/** @inheritDoc */
+	readonly errors: string;
+	/** @inheritDoc */
+	readonly exitCode: number;
+	/** @inheritDoc */
+	readonly httpStatusCode: number;
 	constructor(httpStatusCode: number, headers: Record<string, string[]>, body: ArrayBuffer, errors?: string, exitCode?: number);
+	static fromRawData(data: PHPResponseData): PHPResponse;
+	toRawData(): PHPResponseData;
 	/**
 	 * Response body as JSON.
 	 */
@@ -36,20 +53,36 @@ export declare class PHPResponse {
 	 * Response body as text.
 	 */
 	get text(): string;
+}
+export type HTTPMethod = "GET" | "POST" | "HEAD" | "OPTIONS" | "PATCH" | "PUT" | "DELETE";
+export type PHPRequestHeaders = Record<string, string>;
+export interface PHPRequest {
 	/**
-	 * Response body as bytes.
+	 * Request method. Default: `GET`.
+	 */
+	method?: HTTPMethod;
+	/**
+	 * Request path or absolute URL.
 	 */
-	get bytes(): ArrayBuffer;
-}
-export type PHPRequest = Pick<PHPRunOptions, "method" | "headers"> & {
 	url: string;
+	/**
+	 * Request headers.
+	 */
+	headers?: PHPRequestHeaders;
+	/**
+	 * Uploaded files
+	 */
 	files?: Record<string, File>;
-} & ((Pick<PHPRunOptions, "body"> & {
-	formData?: never;
-}) | {
-	body?: never;
-	formData: Record<string, unknown>;
-});
+	/**
+	 * Request body without the files.
+	 */
+	body?: string;
+	/**
+	 * Form data. If set, the request body will be ignored and
+	 * the content-type header will be set to `application/x-www-form-urlencoded`.
+	 */
+	formData?: Record<string, unknown>;
+}
 export interface PHPRequestHandlerConfiguration {
 	/**
 	 * The directory in the PHP filesystem where the server will look
@@ -66,7 +99,62 @@ export interface PHPRequestHandlerConfiguration {
 	 */
 	isStaticFilePath?: (path: string) => boolean;
 }
-declare class PHPRequestHandler {
+/**
+ * A fake PHP server that handles HTTP requests but does not
+ * bind to any port.
+ *
+ * @public
+ * @example Use PHPRequestHandler implicitly with a new PHP instance:
+ * ```js
+ * import { PHP } from '@php-wasm/web';
+ *
+ * const php = await PHP.load( '7.4', {
+ *     requestHandler: {
+ *         // PHP FS path to serve the files from:
+ *         documentRoot: '/www',
+ *
+ *         // Used to populate $_SERVER['SERVER_NAME'] etc.:
+ *         absoluteUrl: 'http://127.0.0.1'
+ *     }
+ * } );
+ *
+ * php.mkdirTree('/www');
+ * php.writeFile('/www/index.php', '<?php echo "Hi from PHP!"; ');
+ *
+ * const response = await php.request({ path: '/index.php' });
+ * console.log(response.text);
+ * // "Hi from PHP!"
+ * ```
+ *
+ * @example Explicitly create a PHPRequestHandler instance and run a PHP script:
+ * ```js
+ * import {
+ *   loadPHPRuntime,
+ *   PHP,
+ *   PHPRequestHandler,
+ *   getPHPLoaderModule,
+ * } from '@php-wasm/web';
+ *
+ * const runtime = await loadPHPRuntime( await getPHPLoaderModule('7.4') );
+ * const php = new PHP( runtime );
+ *
+ * php.mkdirTree('/www');
+ * php.writeFile('/www/index.php', '<?php echo "Hi from PHP!"; ');
+ *
+ * const server = new PHPRequestHandler(php, {
+ *     // PHP FS path to serve the files from:
+ *     documentRoot: '/www',
+ *
+ *     // Used to populate $_SERVER['SERVER_NAME'] etc.:
+ *     absoluteUrl: 'http://127.0.0.1'
+ * });
+ *
+ * const response = server.request({ path: '/index.php' });
+ * console.log(response.text);
+ * // "Hi from PHP!"
+ * ```
+ */
+export declare class PHPRequestHandler {
 	#private;
 	/**
 	 * The PHP instance
@@ -153,7 +241,6 @@ export declare class PHPBrowser implements WithRequestHandler {
 	request(request: PHPRequest, redirects?: number): Promise<PHPResponse>;
 }
 export type RuntimeType = "NODE" | "WEB" | "WORKER";
-export type PHPRequestHeaders = Record<string, string>;
 export interface FileInfo {
 	key: string;
 	name: string;
@@ -176,7 +263,7 @@ export interface PHPRunOptions {
 	/**
 	 * Request method. Default: `GET`.
 	 */
-	method?: "GET" | "POST" | "HEAD" | "OPTIONS" | "PATCH" | "PUT" | "DELETE";
+	method?: HTTPMethod;
 	/**
 	 * Request headers.
 	 */
@@ -215,11 +302,11 @@ export interface WithNodeFilesystem {
 	/**
 	 * Mounts a Node.js filesystem to a given path in the PHP filesystem.
 	 *
-	 * @param  settings - The Node.js filesystem settings.
-	 * @param  path     - The path to mount the filesystem to.
+	 * @param  localPath - The path of a real local directory you want to mount.
+	 * @param  virtualFSPath - Where to mount it in the virtual filesystem.
 	 * @see {@link https://emscripten.org/docs/api_reference/Filesystem-API.html#FS.mount}
 	 */
-	mount(settings: any, path: string): void;
+	mount(localPath: string | MountSettings, virtualFSPath: string): void;
 }
 export interface WithFilesystem {
 	/**
@@ -229,6 +316,10 @@ export interface WithFilesystem {
 	 *
 	 * @param  path - The directory path to create.
 	 */
+	mkdir(path: string): void;
+	/**
+	 * @deprecated Use mkdir instead.
+	 */
 	mkdirTree(path: string): void;
 	/**
 	 * Reads a file from the PHP filesystem and returns it as a string.
@@ -391,6 +482,8 @@ declare abstract class BasePHP implements WithPHPIniBindings, WithFilesystem, Wi
 	setSkipShebang(shouldSkip: boolean): void;
 	addServerGlobalEntry(key: string, value: string): void;
 	/** @inheritDoc */
+	mkdir(path: string): void;
+	/** @inheritDoc */
 	mkdirTree(path: string): void;
 	/** @inheritDoc */
 	readFileAsText(path: string): string;
@@ -407,7 +500,7 @@ declare abstract class BasePHP implements WithPHPIniBindings, WithFilesystem, Wi
 	/** @inheritDoc */
 	fileExists(path: string): boolean;
 	/** @inheritDoc */
-	mount(settings: MountSettings, path: string): void;
+	mount(localPath: string | MountSettings, virtualFSPath: string): void;
 }
 /**
  * Output of the PHP.wasm runtime.
@@ -474,7 +567,6 @@ export declare class PHP extends BasePHP {
 	 * resolves when the PHP instance is ready.
 	 *
 	 * @see load
-	 * @inheritdoc load
 	 */
 	static loadSync(phpVersion: SupportedPHPVersion, options?: PHPLoaderOptions): {
 		php: PHP;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@php-wasm/node",
-  "version": "0.1.18",
+  "version": "0.1.20",
   "description": "PHP.wasm for Node.js",
   "repository": {
     "type": "git",
@@ -15,16 +15,23 @@
       "url": "https://github.com/adamziel"
     }
   ],
+  "typedoc": {
+    "entryPoint": "./src/index.ts",
+    "readmeFile": "./README.md",
+    "displayName": "@php-wasm/node",
+    "tsconfig": "./tsconfig.lib.json"
+  },
   "publishConfig": {
     "access": "public",
     "directory": "../../../dist/packages/php-wasm/node"
   },
   "license": "(GPL-2.0-or-later OR MPL-2.0)",
-  "gitHead": "2de8f9182b249b7e87694efaa06e7f25b64b7bb3",
+  "main": "index.cjs",
+  "types": "index.d.ts",
+  "gitHead": "bbe56ef04fa9740506efed428ef8c89de7223d96",
   "dependencies": {
     "comlink": "4.4.1",
     "express": "4.18.2",
     "ws": "8.13.0"
-  },
-  "main": "index.cjs"
+  }
 }