@php-wasm/universal 0.7.18 → 0.7.20

package/lib/base-php.d.ts

@@ -1,14 +1,26 @@
+/// <reference types="emscripten" />
 import { PHPResponse } from './php-response';
 import type { PHPRuntimeId } from './load-php-runtime';
 import { IsomorphicLocalPHP, MessageListener, PHPRequest, PHPRequestHeaders, PHPRunOptions, RmDirOptions, ListFilesOptions, SpawnHandler, PHPEventListener, PHPEvent } from './universal-php';
 import { Semaphore } from '../../../util/src/index.ts';
 import { PHPRequestHandler } from './php-request-handler';
+declare namespace Emscripten {
+    type NamespaceToInstance<T> = {
+        [K in keyof T]: T[K] extends (...args: any[]) => any ? T[K] : never;
+    };
+    export type FileSystemInstance = NamespaceToInstance<typeof FS> & {
+        mkdirTree(path: string): void;
+        lookupPath(path: string, opts?: any): FS.Lookup;
+    };
+    export {};
+}
 export declare const __private__dont__use: unique symbol;
 export declare class PHPExecutionFailureError extends Error {
     response: PHPResponse;
     source: 'request' | 'php-wasm';
     constructor(message: string, response: PHPResponse, source: 'request' | 'php-wasm');
 }
+export declare const PHP_INI_PATH = "/internal/shared/php.ini";
 /**
  * An environment-agnostic wrapper around the Emscripten PHP runtime
  * that universals the super low-level API and provides a more convenient
@@ -53,10 +65,6 @@ export declare abstract class BasePHP implements IsomorphicLocalPHP, Disposable
     /** @inheritDoc */
     setSapiName(newName: string): Promise<void>;
     /** @inheritDoc */
-    setPhpIniPath(path: string): void;
-    /** @inheritDoc */
-    setPhpIniEntry(key: string, value: string): void;
-    /** @inheritDoc */
     chdir(path: string): void;
     /**
      * Do not use. Use new PHPRequestHandler() instead.
@@ -103,11 +111,10 @@ export declare abstract class BasePHP implements IsomorphicLocalPHP, Disposable
     [Symbol.dispose](): void;
 }
 export declare function normalizeHeaders(headers: PHPRequestHeaders): PHPRequestHeaders;
-type EmscriptenFS = any;
 export declare function syncFSTo(source: BasePHP, target: BasePHP, path?: string | null): void;
 /**
  * Copies the MEMFS directory structure from one FS in another FS.
  * Non-MEMFS nodes are ignored.
  */
-export declare function copyFS(source: EmscriptenFS, target: EmscriptenFS, path: string): void;
+export declare function copyFS(source: Emscripten.FileSystemInstance, target: Emscripten.FileSystemInstance, path: string): void;
 export {};

package/lib/index.d.ts

@@ -1,4 +1,5 @@
 export type { IsomorphicLocalPHP, IsomorphicRemotePHP, MessageListener, PHPOutput, PHPRunOptions, UniversalPHP, ListFilesOptions, RmDirOptions, PHPEvent, PHPEventListener, HTTPMethod, PHPRequest, PHPRequestHeaders, SpawnHandler, } from './universal-php';
+export { getPhpIniEntries, setPhpIniEntries, withPHPIniValues } from './ini';
 export { UnhandledRejectionsTarget } from './wasm-error-reporting';
 export { HttpCookieStore } from './http-cookie-store';
 export type { IteratePhpFilesOptions as IterateFilesOptions } from './iterate-files';
@@ -25,3 +26,4 @@ export { rotatePHPRuntime } from './rotate-php-runtime';
 export { writeFiles } from './write-files';
 export { DEFAULT_BASE_URL, ensurePathPrefix, removePathPrefix, toRelativeUrl, } from './urls';
 export { isExitCodeZero } from './is-exit-code-zero';
+export { proxyFileSystem } from './proxy-file-system';

package/lib/ini.d.ts

@@ -0,0 +1,45 @@
+import { UniversalPHP } from './universal-php';
+/**
+ * Reads the php.ini file and returns its entries.
+ *
+ * @param php The PHP instance.
+ * @param entries Optional. If provided, only the specified entries will be returned.
+ * @returns The php.ini entries.
+ */
+export declare function getPhpIniEntries(php: UniversalPHP, entries?: string[]): Promise<{
+    [key: string]: any;
+}>;
+/**
+ * Rewrites the php.ini file with the given entries.
+ *
+ * @param php The PHP instance.
+ * @param entries The entries to write to the php.ini file.
+ */
+export declare function setPhpIniEntries(php: UniversalPHP, entries: Record<string, unknown>): Promise<void>;
+/**
+ * Sets php.ini values to the given values, executes a callback,
+ * and restores the original php.ini values. This is useful for
+ * running code with temporary php.ini values, such as when
+ * disabling network-related PHP functions just to run WordPress
+ * installer.
+ *
+ * @example
+ * ```ts
+ *	await withPHPIniValues(
+ *		php,
+ *		{
+ *			disable_functions: 'fsockopen',
+ *			allow_url_fopen: '0',
+ *		},
+ *		async () => await runWpInstallationWizard(php, {
+ *			options: {},
+ *		})
+ *	);
+ *	```
+ *
+ * @param php The PHP instance.
+ * @param phpIniValues The php.ini values to set.
+ * @param callback The callback to execute.
+ * @returns The result of the callback.
+ */
+export declare function withPHPIniValues(php: UniversalPHP, phpIniValues: Record<string, string>, callback: () => Promise<void>): Promise<void>;

package/lib/proxy-file-system.d.ts

@@ -0,0 +1,7 @@
+import { BasePHP } from './base-php';
+/**
+ * Proxy specific paths to the parent's MEMFS instance.
+ * This is useful for sharing the WordPress installation
+ * between the parent and child processes.
+ */
+export declare function proxyFileSystem(sourceOfTruth: BasePHP, replica: BasePHP, paths: string[]): void;

package/lib/universal-php.d.ts

@@ -70,19 +70,6 @@ export interface IsomorphicLocalPHP {
      * @param listener - The listener function to be removed.
      */
     removeEventListener(eventType: PHPEvent['type'], listener: PHPEventListener): void;
-    /**
-     * Sets the path to the php.ini file to use for the PHP instance.
-     *
-     * @param path - The path to the php.ini file.
-     */
-    setPhpIniPath(path: string): void;
-    /**
-     * Sets a value for a specific key in the php.ini file for the PHP instance.
-     *
-     * @param key - The key to set the value for.
-     * @param value - The value to set for the key.
-     */
-    setPhpIniEntry(key: string, value: string): void;
     /**
      * Recursively creates a directory with the given path in the PHP filesystem.
      * For example, if the path is `/root/php/data`, and `/root` already exists,
@@ -299,7 +286,7 @@ export type SpawnHandler = (command: string, args: string[]) => ChildProcess;
  * that can't be serialized over a remote connection. Therefeore,
  * they don't make sense in a remote PHP instance.
  */
-export type IsomorphicRemotePHP = Remote<Omit<IsomorphicLocalPHP, 'setSapiName' | 'setPhpIniEntry' | 'setPhpIniPath'>>;
+export type IsomorphicRemotePHP = Remote<Omit<IsomorphicLocalPHP, 'setSapiName'>>;
 export type UniversalPHP = IsomorphicLocalPHP | IsomorphicRemotePHP;
 export type HTTPMethod = 'GET' | 'POST' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'PUT' | 'DELETE';
 export type PHPRequestHeaders = Record<string, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@php-wasm/universal",
-	"version": "0.7.18",
+	"version": "0.7.20",
 	"description": "PHP.wasm – emscripten bindings for PHP",
 	"repository": {
 		"type": "git",
@@ -36,7 +36,7 @@
 	"main": "./index.cjs",
 	"module": "./index.js",
 	"license": "GPL-2.0-or-later",
-	"gitHead": "44ba621a9ca5e78acd5d6995da44ac460f8adc50",
+	"gitHead": "5915ef756c88da8dcb665f9f0e49ddc0c0b10d50",
 	"engines": {
 		"node": ">=18.18.0",
 		"npm": ">=8.11.0"