@php-wasm/universal 0.1.40 → 0.1.41

package/lib/base-php.d.ts

@@ -0,0 +1,70 @@
+import { PHPBrowser } from './php-browser';
+import { PHPRequestHandlerConfiguration } from './php-request-handler';
+import { PHPResponse } from './php-response';
+import type { PHPRuntimeId } from './load-php-runtime';
+import { IsomorphicLocalPHP, PHPRequest, PHPRunOptions, RmDirOptions } from './universal-php';
+export declare const __private__dont__use: unique symbol;
+/**
+ * An environment-agnostic wrapper around the Emscripten PHP runtime
+ * that universals the super low-level API and provides a more convenient
+ * higher-level API.
+ *
+ * It exposes a minimal set of methods to run PHP scripts and to
+ * interact with the PHP filesystem.
+ */
+export declare abstract class BasePHP implements IsomorphicLocalPHP {
+    #private;
+    protected [__private__dont__use]: any;
+    requestHandler?: PHPBrowser;
+    /**
+     * Initializes a PHP runtime.
+     *
+     * @internal
+     * @param  PHPRuntime - Optional. PHP Runtime ID as initialized by loadPHPRuntime.
+     * @param  serverOptions - Optional. Options for the PHPRequestHandler. If undefined, no request handler will be initialized.
+     */
+    constructor(PHPRuntimeId?: PHPRuntimeId, serverOptions?: PHPRequestHandlerConfiguration);
+    /** @inheritDoc */
+    get absoluteUrl(): string;
+    /** @inheritDoc */
+    get documentRoot(): string;
+    /** @inheritDoc */
+    pathToInternalUrl(path: string): string;
+    /** @inheritDoc */
+    internalUrlToPath(internalUrl: string): string;
+    initializeRuntime(runtimeId: PHPRuntimeId): void;
+    /** @inheritDoc */
+    setPhpIniPath(path: string): void;
+    /** @inheritDoc */
+    setPhpIniEntry(key: string, value: string): void;
+    /** @inheritDoc */
+    chdir(path: string): void;
+    /** @inheritDoc */
+    request(request: PHPRequest, maxRedirects?: number): Promise<PHPResponse>;
+    /** @inheritDoc */
+    run(request: PHPRunOptions): Promise<PHPResponse>;
+    addServerGlobalEntry(key: string, value: string): void;
+    /** @inheritDoc */
+    mkdir(path: string): void;
+    /** @inheritDoc */
+    mkdirTree(path: string): void;
+    /** @inheritDoc */
+    readFileAsText(path: string): string;
+    /** @inheritDoc */
+    readFileAsBuffer(path: string): Uint8Array;
+    /** @inheritDoc */
+    writeFile(path: string, data: string | Uint8Array): void;
+    /** @inheritDoc */
+    unlink(path: string): void;
+    /** @inheritDoc */
+    mv(fromPath: string, toPath: string): void;
+    /** @inheritDoc */
+    rmdir(path: string, options?: RmDirOptions): void;
+    /** @inheritDoc */
+    listFiles(path: string): string[];
+    /** @inheritDoc */
+    isDir(path: string): boolean;
+    /** @inheritDoc */
+    fileExists(path: string): boolean;
+}
+export declare function normalizeHeaders(headers: PHPRunOptions['headers']): PHPRunOptions['headers'];

package/lib/error-event-polyfill.d.ts

@@ -0,0 +1,30 @@
+declare const kError: unique symbol;
+declare const kMessage: unique symbol;
+interface ErrorEventOptions {
+    error?: Error;
+    message?: string;
+}
+/**
+ * Class representing an error event.
+ *
+ * @extends Event
+ */
+declare class ErrorEvent2 extends Event {
+    [kError]: any;
+    [kMessage]: any;
+    /**
+     * Create a new `ErrorEvent`.
+     *
+     * @param type The name of the event
+     * @param options A dictionary object that allows for setting
+     *                  attributes via object members of the same name.
+     */
+    constructor(type: 'error', options?: ErrorEventOptions);
+    get error(): any;
+    get message(): any;
+}
+export declare const ErrorEvent: typeof ErrorEvent2 | {
+    new (type: string, eventInitDict?: ErrorEventInit | undefined): ErrorEvent;
+    prototype: ErrorEvent;
+};
+export {};

package/{src/lib/index.ts → lib/index.d.ts}

@@ -1,49 +1,17 @@
-export type {
-	FileInfo,
-	IsomorphicLocalPHP,
-	IsomorphicRemotePHP,
-	PHPOutput,
-	PHPRunOptions,
-	UniversalPHP,
-	RmDirOptions,
-	HTTPMethod,
-	PHPRequest,
-	PHPRequestHeaders,
-	RequestHandler,
-} from './universal-php';
-
+export type { FileInfo, IsomorphicLocalPHP, IsomorphicRemotePHP, PHPOutput, PHPRunOptions, UniversalPHP, RmDirOptions, HTTPMethod, PHPRequest, PHPRequestHeaders, RequestHandler, } from './universal-php';
 export { PHPResponse } from './php-response';
 export type { PHPResponseData } from './php-response';
 export type { ErrnoError } from './rethrow-file-system-error';
-export {
-	LatestSupportedPHPVersion,
-	SupportedPHPVersions,
-	SupportedPHPVersionsList,
-} from './supported-php-versions';
+export { LatestSupportedPHPVersion, SupportedPHPVersions, SupportedPHPVersionsList, } from './supported-php-versions';
 export type { SupportedPHPVersion } from './supported-php-versions';
 export { BasePHP, __private__dont__use } from './base-php';
 export { loadPHPRuntime } from './load-php-runtime';
-export type {
-	DataModule,
-	EmscriptenOptions,
-	PHPLoaderModule,
-	PHPRuntime,
-	PHPRuntimeId,
-	RuntimeType,
-} from './load-php-runtime';
+export type { DataModule, EmscriptenOptions, PHPLoaderModule, PHPRuntime, PHPRuntimeId, RuntimeType, } from './load-php-runtime';
 export { rethrowFileSystemError } from './rethrow-file-system-error';
-
 export { isLocalPHP } from './is-local-php';
 export { isRemotePHP } from './is-remote-php';
-
 export type { PHPRequestHandlerConfiguration } from './php-request-handler';
 export { PHPRequestHandler } from './php-request-handler';
 export type { PHPBrowserConfiguration } from './php-browser';
 export { PHPBrowser } from './php-browser';
-
-export {
-	DEFAULT_BASE_URL,
-	ensurePathPrefix,
-	removePathPrefix,
-	toRelativeUrl,
-} from './urls';
+export { DEFAULT_BASE_URL, ensurePathPrefix, removePathPrefix, toRelativeUrl, } from './urls';

package/lib/is-local-php.d.ts

@@ -0,0 +1,2 @@
+import { IsomorphicLocalPHP, UniversalPHP } from './universal-php';
+export declare function isLocalPHP(playground: UniversalPHP): playground is IsomorphicLocalPHP;

package/lib/is-remote-php.d.ts

@@ -0,0 +1,2 @@
+import { IsomorphicRemotePHP, UniversalPHP } from './universal-php';
+export declare function isRemotePHP(playground: UniversalPHP): playground is IsomorphicRemotePHP;

package/{src/lib/load-php-runtime.ts → lib/load-php-runtime.d.ts}

@@ -115,113 +115,35 @@
  * @param  dataDependenciesModules - A list of the ESM-wrapped Emscripten data dependency modules.
  * @returns Loaded runtime id.
  */
-
-export async function loadPHPRuntime(
-	phpLoaderModule: PHPLoaderModule,
-	phpModuleArgs: EmscriptenOptions = {},
-	dataDependenciesModules: DataModule[] = []
-): Promise<number> {
-	let resolvePhpReady: any, resolveDepsReady: any;
-	const depsReady = new Promise((resolve) => {
-		resolveDepsReady = resolve;
-	});
-	const phpReady = new Promise((resolve) => {
-		resolvePhpReady = resolve;
-	});
-
-	const PHPRuntime = phpLoaderModule.init(currentJsRuntime, {
-		onAbort(reason) {
-			console.error('WASM aborted: ');
-			console.error(reason);
-		},
-		ENV: {},
-		// Emscripten sometimes prepends a '/' to the path, which
-		// breaks vite dev mode. An identity `locateFile` function
-		// fixes it.
-		locateFile: (path) => path,
-		...phpModuleArgs,
-		noInitialRun: true,
-		onRuntimeInitialized() {
-			if (phpModuleArgs.onRuntimeInitialized) {
-				phpModuleArgs.onRuntimeInitialized();
-			}
-			resolvePhpReady();
-		},
-		monitorRunDependencies(nbLeft) {
-			if (nbLeft === 0) {
-				delete PHPRuntime.monitorRunDependencies;
-				resolveDepsReady();
-			}
-		},
-	});
-	for (const { default: loadDataModule } of dataDependenciesModules) {
-		loadDataModule(PHPRuntime);
-	}
-	if (!dataDependenciesModules.length) {
-		resolveDepsReady();
-	}
-
-	await depsReady;
-	await phpReady;
-
-	loadedRuntimes.push(PHPRuntime);
-	return loadedRuntimes.length - 1;
-}
-
+export declare function loadPHPRuntime(phpLoaderModule: PHPLoaderModule, phpModuleArgs?: EmscriptenOptions, dataDependenciesModules?: DataModule[]): Promise<number>;
 export type RuntimeType = 'NODE' | 'WEB' | 'WORKER';
-
-declare const self: WindowOrWorkerGlobalScope;
-declare const WorkerGlobalScope: object | undefined;
-
 export type PHPRuntimeId = number;
-const loadedRuntimes: PHPRuntime[] = [];
-
-export function getLoadedRuntime(id: PHPRuntimeId): PHPRuntime {
-	return loadedRuntimes[id];
-}
-
-export const currentJsRuntime = (function () {
-	if (typeof process !== 'undefined' && process.release?.name === 'node') {
-		return 'NODE';
-	} else if (typeof window !== 'undefined') {
-		return 'WEB';
-	} else if (
-		typeof WorkerGlobalScope !== 'undefined' &&
-		self instanceof (WorkerGlobalScope as any)
-	) {
-		return 'WORKER';
-	} else {
-		return 'NODE';
-	}
-})();
-
+export declare function getLoadedRuntime(id: PHPRuntimeId): PHPRuntime;
+export declare const currentJsRuntime: string;
 export type PHPRuntime = any;
-
 export type PHPLoaderModule = {
-	dependencyFilename: string;
-	dependenciesTotalSize: number;
-	init: (jsRuntime: string, options: EmscriptenOptions) => PHPRuntime;
+    dependencyFilename: string;
+    dependenciesTotalSize: number;
+    init: (jsRuntime: string, options: EmscriptenOptions) => PHPRuntime;
 };
-
 export type DataModule = {
-	dependencyFilename: string;
-	dependenciesTotalSize: number;
-	default: (phpRuntime: PHPRuntime) => void;
+    dependencyFilename: string;
+    dependenciesTotalSize: number;
+    default: (phpRuntime: PHPRuntime) => void;
 };
-
 export type EmscriptenOptions = {
-	onAbort?: (message: string) => void;
-	/**
-	 * Set to true for debugging tricky WebAssembly errors.
-	 */
-	debug?: boolean;
-	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;
-	onRuntimeInitialized?: () => void;
-	monitorRunDependencies?: (left: number) => void;
+    onAbort?: (message: string) => void;
+    /**
+     * Set to true for debugging tricky WebAssembly errors.
+     */
+    debug?: boolean;
+    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;
+    onRuntimeInitialized?: () => void;
+    monitorRunDependencies?: (left: number) => void;
 } & Record<string, any>;

package/lib/php-browser.d.ts

@@ -0,0 +1,52 @@
+import type { PHPRequestHandler } from './php-request-handler';
+import type { PHPResponse } from './php-response';
+import { PHPRequest, RequestHandler } from './universal-php';
+export interface PHPBrowserConfiguration {
+    /**
+     * Should handle redirects internally?
+     */
+    handleRedirects?: boolean;
+    /**
+     * The maximum number of redirects to follow internally. Once
+     * exceeded, request() will return the redirecting response.
+     */
+    maxRedirects?: number;
+}
+/**
+ * A fake web browser that handles PHPRequestHandler's cookies and redirects
+ * internally without exposing them to the consumer.
+ *
+ * @public
+ */
+export declare class PHPBrowser implements RequestHandler {
+    #private;
+    requestHandler: PHPRequestHandler;
+    /**
+     * @param  server - The PHP server to browse.
+     * @param  config - The browser configuration.
+     */
+    constructor(requestHandler: PHPRequestHandler, config?: PHPBrowserConfiguration);
+    /**
+     * Sends the request to the server.
+     *
+     * When cookies are present in the response, this method stores
+     * them and sends them with any subsequent requests.
+     *
+     * When a redirection is present in the response, this method
+     * follows it by discarding a response and sending a subsequent
+     * request.
+     *
+     * @param  request   - The request.
+     * @param  redirects - Internal. The number of redirects handled so far.
+     * @returns PHPRequestHandler response.
+     */
+    request(request: PHPRequest, redirects?: number): Promise<PHPResponse>;
+    /** @inheritDoc */
+    pathToInternalUrl(path: string): string;
+    /** @inheritDoc */
+    internalUrlToPath(internalUrl: string): string;
+    /** @inheritDoc */
+    get absoluteUrl(): string;
+    /** @inheritDoc */
+    get documentRoot(): string;
+}

package/lib/php-request-handler.d.ts

@@ -0,0 +1,43 @@
+import { BasePHP } from './base-php';
+import { PHPResponse } from './php-response';
+import { PHPRequest, RequestHandler } from './universal-php';
+export interface PHPRequestHandlerConfiguration {
+    /**
+     * The directory in the PHP filesystem where the server will look
+     * for the files to serve. Default: `/var/www`.
+     */
+    documentRoot?: string;
+    /**
+     * 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;
+}
+/** @inheritDoc */
+export declare class PHPRequestHandler implements RequestHandler {
+    #private;
+    /**
+     * The PHP instance
+     */
+    php: BasePHP;
+    /**
+     * @param  php    - The PHP instance.
+     * @param  config - Request Handler configuration.
+     */
+    constructor(php: BasePHP, config?: PHPRequestHandlerConfiguration);
+    /** @inheritDoc */
+    pathToInternalUrl(path: string): string;
+    /** @inheritDoc */
+    internalUrlToPath(internalUrl: string): string;
+    get isRequestRunning(): boolean;
+    /** @inheritDoc */
+    get absoluteUrl(): string;
+    /** @inheritDoc */
+    get documentRoot(): string;
+    /** @inheritDoc */
+    request(request: PHPRequest): Promise<PHPResponse>;
+}

package/lib/php-response.d.ts

@@ -0,0 +1,54 @@
+export interface PHPResponseData {
+    /**
+     * Response headers.
+     */
+    readonly headers: Record<string, string[]>;
+    /**
+     * Response body. Contains the output from `echo`,
+     * `print`, inline HTML etc.
+     */
+    readonly bytes: ArrayBuffer;
+    /**
+     * Stderr contents, if any.
+     */
+    readonly errors: string;
+    /**
+     * The exit code of the script. `0` is a success, while
+     * `1` and `2` indicate an error.
+     */
+    readonly exitCode: number;
+    /**
+     * 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.
+     */
+    get json(): any;
+    /**
+     * Response body as text.
+     */
+    get text(): string;
+}

package/lib/rethrow-file-system-error.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Emscripten's filesystem-related Exception.
+ *
+ * @see https://emscripten.org/docs/api_reference/Filesystem-API.html
+ * @see https://github.com/emscripten-core/emscripten/blob/main/system/lib/libc/musl/arch/emscripten/bits/errno.h
+ * @see https://github.com/emscripten-core/emscripten/blob/38eedc630f17094b3202fd48ac0c2c585dbea31e/system/include/wasi/api.h#L336
+ */
+export interface ErrnoError extends Error {
+    node?: any;
+    errno: number;
+    message: string;
+}
+export declare function rethrowFileSystemError(messagePrefix?: string): (target: any, methodName: string, descriptor: PropertyDescriptor) => void;

package/lib/supported-php-versions.d.ts

@@ -0,0 +1,4 @@
+export declare const SupportedPHPVersions: readonly ["8.2", "8.1", "8.0", "7.4", "7.3", "7.2", "7.1", "7.0", "5.6"];
+export declare const LatestSupportedPHPVersion: "8.2";
+export declare const SupportedPHPVersionsList: string[];
+export type SupportedPHPVersion = (typeof SupportedPHPVersions)[number];