@php-wasm/node 3.1.20 → 3.1.22

package/lib/extensions/load-extensions.d.ts

@@ -0,0 +1,59 @@
+import type { EmscriptenOptions, PHPExtensionInstallOptions, PHPWasmAsyncMode, SupportedPHPVersion } from '@php-wasm/universal';
+export interface PathMapping {
+    hostPath: string;
+    vfsPath: string;
+}
+export interface XdebugOptions {
+    ideKey?: string;
+    pathMappings?: PathMapping[];
+    pathSkippings?: string[];
+}
+/**
+ * Built-in PHP extensions shipped with `@php-wasm/node`.
+ */
+export type BuiltInPHPExtensionName = 'intl' | 'xdebug' | 'redis' | 'memcached';
+/**
+ * External PHP extension source that can be installed before PHP starts.
+ *
+ * The runtime supplies the active PHP version and async mode before resolving
+ * the source, so callers only provide the artifact source and install options.
+ */
+export type RuntimePHPExtensionSource = PHPExtensionInstallOptions;
+/**
+ * Built-in PHP extension request accepted by `loadNodeRuntime()`.
+ *
+ * Pass a string for defaults, or an object when a built-in extension exposes
+ * options. Currently only `xdebug` has options.
+ */
+export type BuiltInPHPExtension = BuiltInPHPExtensionName | {
+    name: 'xdebug';
+    options?: XdebugOptions;
+} | {
+    name: Exclude<BuiltInPHPExtensionName, 'xdebug'>;
+};
+/**
+ * PHP extension request accepted by `loadNodeRuntime()`.
+ *
+ * The array may mix built-in extension names with external extension sources:
+ *
+ * ```ts
+ * await loadNodeRuntime('8.4', {
+ *   extensions: [
+ *     'intl',
+ *     { source: { format: 'manifest', manifestUrl: './manifest.json' } },
+ *   ],
+ * });
+ * ```
+ *
+ * In Node, local manifest and artifact files work without a custom `fetch`
+ * implementation. Pass `manifestUrl` as a filesystem path, a `file:` URL, or
+ * an HTTP URL.
+ */
+export type PHPExtension = BuiltInPHPExtension | RuntimePHPExtensionSource;
+/**
+ * Adds PHP extensions to Emscripten options before the Node runtime starts.
+ *
+ * Extension sources are resolved in parallel so multiple manifest or artifact
+ * downloads do not block each other.
+ */
+export declare function withPHPExtensions(version: SupportedPHPVersion, asyncMode: PHPWasmAsyncMode, options: EmscriptenOptions, extensions?: PHPExtension[]): Promise<EmscriptenOptions>;

package/lib/extensions/node-extension-resources.d.ts

@@ -0,0 +1,20 @@
+import type { PHPExtensionSource } from '@php-wasm/universal';
+/**
+ * Converts extension sources accepted by the Node runtime into URL-shaped
+ * resources before the universal resolver sees them.
+ *
+ * The universal resolver deals in URLs because browsers can only fetch
+ * extension bytes from URLs. Node callers often pass local paths instead, so
+ * this function rewrites direct artifact URLs, manifest URLs, and inline
+ * manifest base URLs into `URL` objects while leaving byte sources unchanged.
+ */
+export declare function normalizeNodeExtensionSource(source: PHPExtensionSource): PHPExtensionSource;
+/**
+ * Fetch implementation used by Node extension loading.
+ *
+ * It behaves like global `fetch()` for HTTP(S) resources and adds `file:`
+ * support for local manifests and artifacts. This lets callers use the same
+ * extension API for packages installed on disk and for artifacts hosted
+ * remotely.
+ */
+export declare function fetchNodeExtensionResource(input: RequestInfo | URL): Promise<Response>;

package/lib/get-php-loader-module.d.ts

@@ -1,4 +1,4 @@
-import type { PHPLoaderModule, SupportedPHPVersion } from '@php-wasm/universal';
+import type { AllPHPVersion, PHPLoaderModule } from '@php-wasm/universal';
 /**
  * Loads the PHP loader module for the given PHP version.
  *
@@ -11,4 +11,4 @@ import type { PHPLoaderModule, SupportedPHPVersion } from '@php-wasm/universal';
  * @param version The PHP version to load.
  * @returns The PHP loader module.
  */
-export declare function getPHPLoaderModule(version?: SupportedPHPVersion | string): Promise<PHPLoaderModule>;
+export declare function getPHPLoaderModule(version?: AllPHPVersion): Promise<PHPLoaderModule>;

package/lib/index.d.ts

@@ -5,6 +5,6 @@ export * from './use-host-filesystem';
 export * from './node-fs-mount';
 export * from './file-lock-manager-for-posix';
 export * from './file-lock-manager-for-windows';
-export * from './extensions/xdebug/with-xdebug';
+export type { BuiltInPHPExtension, BuiltInPHPExtensionName, PathMapping, PHPExtension, RuntimePHPExtensionSource, XdebugOptions, } from './extensions/load-extensions';
 export * from './wasm-user-space';
 export * from './wasm-kernel-space';

package/lib/load-runtime.d.ts

@@ -1,11 +1,31 @@
-import { type SupportedPHPVersion, type EmscriptenOptions, type FileLockManager } from '@php-wasm/universal';
+import { type AllPHPVersion, type EmscriptenOptions, type FileLockManager } from '@php-wasm/universal';
 import type { WasmUserSpaceAPI, WasmUserSpaceContext } from './wasm-user-space';
-import { type XdebugOptions } from './extensions/xdebug/with-xdebug';
+import { type PHPExtension, type XdebugOptions } from './extensions/load-extensions';
 export interface PHPLoaderOptions {
     followSymlinks?: boolean;
+    /**
+     * PHP extensions to install before the runtime starts.
+     *
+     * Use built-in names such as `intl`, `xdebug`, `redis`, and `memcached`,
+     * or pass an external extension source such as a manifest.
+     */
+    extensions?: PHPExtension[];
+    /**
+     * @deprecated Use `extensions: ['xdebug']` or
+     * `extensions: [{ name: 'xdebug', options }]` instead.
+     */
     withXdebug?: boolean | XdebugOptions;
+    /**
+     * @deprecated Use `extensions: ['intl']` instead.
+     */
     withIntl?: boolean;
+    /**
+     * @deprecated Use `extensions: ['redis']` instead.
+     */
     withRedis?: boolean;
+    /**
+     * @deprecated Use `extensions: ['memcached']` instead.
+     */
     withMemcached?: boolean;
 }
 export type PHPLoaderOptionsForNode = PHPLoaderOptions & {
@@ -54,4 +74,4 @@ export type PHPLoaderOptionsForNode = PHPLoaderOptions & {
  *
  * @see load
  */
-export declare function loadNodeRuntime(phpVersion: SupportedPHPVersion, options?: PHPLoaderOptionsForNode): Promise<number>;
+export declare function loadNodeRuntime(phpVersion: AllPHPVersion, options?: PHPLoaderOptionsForNode): Promise<number>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@php-wasm/node",
-  "version": "3.1.20",
+  "version": "3.1.22",
   "description": "PHP.wasm for Node.js",
   "repository": {
     "type": "git",
@@ -38,11 +38,6 @@
   },
   "license": "GPL-2.0-or-later",
   "types": "index.d.ts",
-  "gitHead": "98cfca0a050ef1dacce25710d6ebdf816e80b764",
-  "engines": {
-    "node": ">=20.10.0",
-    "npm": ">=10.2.3"
-  },
   "dependencies": {
     "express": "4.22.0",
     "fast-xml-parser": "^5.5.1",
@@ -52,18 +47,24 @@
     "wasm-feature-detect": "1.8.0",
     "ws": "8.18.0",
     "yargs": "17.7.2",
-    "@php-wasm/universal": "3.1.20",
-    "@php-wasm/node-8-5": "3.1.20",
-    "@php-wasm/node-8-4": "3.1.20",
-    "@php-wasm/node-8-3": "3.1.20",
-    "@php-wasm/node-8-2": "3.1.20",
-    "@php-wasm/node-8-1": "3.1.20",
-    "@php-wasm/node-8-0": "3.1.20",
-    "@php-wasm/node-7-4": "3.1.20",
-    "@php-wasm/cli-util": "3.1.20",
-    "@php-wasm/logger": "3.1.20",
-    "@php-wasm/util": "3.1.20",
-    "@wp-playground/common": "3.1.20"
+    "@php-wasm/universal": "3.1.22",
+    "@php-wasm/node-8-5": "3.1.22",
+    "@php-wasm/node-8-4": "3.1.22",
+    "@php-wasm/node-8-3": "3.1.22",
+    "@php-wasm/node-8-2": "3.1.22",
+    "@php-wasm/node-8-1": "3.1.22",
+    "@php-wasm/node-8-0": "3.1.22",
+    "@php-wasm/node-7-4": "3.1.22",
+    "@php-wasm/cli-util": "3.1.22",
+    "@php-wasm/logger": "3.1.22",
+    "@php-wasm/node-5-2": "3.1.22",
+    "@php-wasm/util": "3.1.22",
+    "@wp-playground/common": "3.1.22"
+  },
+  "gitHead": "04c986b63dd56fe74e4ed0cf04d00cae7ac050bf",
+  "engines": {
+    "node": ">=20.10.0",
+    "npm": ">=10.2.3"
   },
   "packageManager": "npm@10.9.2",
   "overrides": {

package/lib/extensions/intl/with-intl.d.ts

@@ -1,2 +0,0 @@
-import type { EmscriptenOptions } from '@php-wasm/universal';
-export declare function withIntl(version: "8.5" | "8.4" | "8.3" | "8.2" | "8.1" | "8.0" | "7.4" | undefined, options: EmscriptenOptions): Promise<EmscriptenOptions>;

package/lib/extensions/memcached/with-memcached.d.ts

@@ -1,2 +0,0 @@
-import type { EmscriptenOptions } from '@php-wasm/universal';
-export declare function withMemcached(version: "8.5" | "8.4" | "8.3" | "8.2" | "8.1" | "8.0" | "7.4" | undefined, options: EmscriptenOptions): Promise<EmscriptenOptions>;

package/lib/extensions/redis/with-redis.d.ts

@@ -1,2 +0,0 @@
-import type { EmscriptenOptions } from '@php-wasm/universal';
-export declare function withRedis(version: "8.5" | "8.4" | "8.3" | "8.2" | "8.1" | "8.0" | "7.4" | undefined, options: EmscriptenOptions): Promise<EmscriptenOptions>;

package/lib/extensions/xdebug/with-xdebug.d.ts

@@ -1,11 +0,0 @@
-import { type EmscriptenOptions } from '@php-wasm/universal';
-export interface PathMapping {
-    hostPath: string;
-    vfsPath: string;
-}
-export interface XdebugOptions {
-    ideKey?: string;
-    pathMappings?: PathMapping[];
-    pathSkippings?: string[];
-}
-export declare function withXdebug(version: "8.5" | "8.4" | "8.3" | "8.2" | "8.1" | "8.0" | "7.4" | undefined, options: EmscriptenOptions, xdebugOptions: XdebugOptions): Promise<EmscriptenOptions>;