@php-wasm/node 0.9.33 → 0.9.34

package/index.d.ts

@@ -0,0 +1,2 @@
+import '@php-wasm/node-polyfills';
+export * from './lib';

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

@@ -0,0 +1,2 @@
+import type { PHPLoaderModule, SupportedPHPVersion } from '@php-wasm/universal';
+export declare function getPHPLoaderModule(version?: SupportedPHPVersion): Promise<PHPLoaderModule>;

package/lib/index.d.ts

@@ -0,0 +1,5 @@
+export * from './get-php-loader-module';
+export * from './networking/with-networking';
+export * from './load-runtime';
+export * from './use-host-filesystem';
+export * from './node-fs-mount';

package/lib/load-runtime.d.ts

@@ -0,0 +1,12 @@
+import { SupportedPHPVersion, EmscriptenOptions } from '@php-wasm/universal';
+export interface PHPLoaderOptions {
+    emscriptenOptions?: EmscriptenOptions;
+}
+/**
+ * Does what load() does, but synchronously returns
+ * an object with the PHP instance and a promise that
+ * resolves when the PHP instance is ready.
+ *
+ * @see load
+ */
+export declare function loadNodeRuntime(phpVersion: SupportedPHPVersion, options?: PHPLoaderOptions): Promise<number>;

package/lib/networking/inbound-tcp-to-ws-proxy.d.ts

@@ -0,0 +1,8 @@
+import { WebSocketServer } from 'ws';
+export declare function addTCPServerToWebSocketServerClass(wsListenPort: number, WSServer: typeof WebSocketServer): any;
+export interface InboundTcpToWsProxyOptions {
+    tcpListenPort: number;
+    wsConnectHost?: string;
+    wsConnectPort: number;
+}
+export declare function listenTCPToWSProxy(options: InboundTcpToWsProxyOptions): void;

package/lib/networking/outbound-ws-to-tcp-proxy.d.ts

@@ -0,0 +1,58 @@
+import * as http from 'http';
+/**
+ * Send a chunk of data to the remote server.
+ */
+export declare const COMMAND_CHUNK = 1;
+/**
+ * Set a TCP socket option.
+ */
+export declare const COMMAND_SET_SOCKETOPT = 2;
+/**
+ * Adds support for TCP socket options to WebSocket class.
+ *
+ * Socket options are implemented by adopting a specific data transmission
+ * protocol between WS client and WS server The first byte
+ * of every message is a command type, and the remaining bytes
+ * are the actual data.
+ *
+ * @param  WebSocketConstructor
+ * @returns Decorated constructor
+ */
+export declare function addSocketOptionsSupportToWebSocketClass(WebSocketConstructor: typeof WebSocket): {
+    new (url: string | URL, protocols?: string | string[]): {
+        send(chunk: any, callback: any): any;
+        setSocketOpt(optionClass: number, optionName: number, optionValue: number): any;
+        sendCommand(commandType: number, chunk: string | ArrayBuffer | ArrayLike<number>, callback: any): any;
+        binaryType: BinaryType;
+        readonly bufferedAmount: number;
+        readonly extensions: string;
+        onclose: ((this: WebSocket, ev: CloseEvent) => any) | null;
+        onerror: ((this: WebSocket, ev: Event) => any) | null;
+        onmessage: ((this: WebSocket, ev: MessageEvent) => any) | null;
+        onopen: ((this: WebSocket, ev: Event) => any) | null;
+        readonly protocol: string;
+        readonly readyState: number;
+        readonly url: string;
+        close(code?: number, reason?: string): void;
+        close(code?: number, reason?: string): void;
+        readonly CONNECTING: 0;
+        readonly OPEN: 1;
+        readonly CLOSING: 2;
+        readonly CLOSED: 3;
+        addEventListener<K extends keyof WebSocketEventMap>(type: K, listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof WebSocketEventMap>(type: K, listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof WebSocketEventMap>(type: K, listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof WebSocketEventMap>(type: K, listener: (this: WebSocket, ev: WebSocketEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+        dispatchEvent(event: Event): boolean;
+        dispatchEvent(event: Event): boolean;
+    };
+    readonly CONNECTING: 0;
+    readonly OPEN: 1;
+    readonly CLOSING: 2;
+    readonly CLOSED: 3;
+};
+export declare function initOutboundWebsocketProxyServer(listenPort: number, listenHost?: string): Promise<http.Server>;

package/lib/networking/utils.d.ts

@@ -0,0 +1,2 @@
+export declare function debugLog(message: any, ...args: any[]): void;
+export declare function findFreePorts(n: number): Promise<number[]>;

package/lib/networking/with-networking.d.ts

@@ -0,0 +1,2 @@
+import { EmscriptenOptions } from '@php-wasm/universal';
+export declare function withNetworking(phpModuleArgs?: EmscriptenOptions): Promise<EmscriptenOptions>;

package/lib/node-fs-mount.d.ts

@@ -0,0 +1,2 @@
+import { MountHandler } from '@php-wasm/universal';
+export declare function createNodeFsMountHandler(localPath: string): MountHandler;

package/lib/use-host-filesystem.d.ts

@@ -0,0 +1,9 @@
+import { PHP } from '@php-wasm/universal';
+/**
+ * Enables host filesystem usage by mounting root
+ * directories (e.g. /, /home, /var) into the in-memory
+ * virtual filesystem used by this PHP instance, and
+ * setting the current working directory to one used by
+ * the current node.js process.
+ */
+export declare function useHostFilesystem(php: PHP): void;

package/noop.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A dummy entrypoint is needed for the @nx/esbuild:esbuild
+ * to work properly. See https://github.com/nrwl/nx/pull/14636/files
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@php-wasm/node",
-  "version": "0.9.33",
+  "version": "0.9.34",
   "description": "PHP.wasm for Node.js",
   "repository": {
     "type": "git",
@@ -38,7 +38,7 @@
   },
   "license": "GPL-2.0-or-later",
   "types": "index.d.ts",
-  "gitHead": "bcfaa019188a6a6e381338704151566eb050638a",
+  "gitHead": "7bb2d07709cc230bf3c940b80ef39fa643e53916",
   "engines": {
     "node": ">=18.18.0",
     "npm": ">=8.11.0"
@@ -49,11 +49,11 @@
     "ini": "4.1.2",
     "ws": "8.18.0",
     "yargs": "17.7.2",
-    "@php-wasm/node-polyfills": "0.9.33",
-    "@php-wasm/universal": "0.9.33",
-    "@php-wasm/logger": "0.9.33",
-    "@php-wasm/util": "0.9.33",
-    "@wp-playground/common": "0.9.33",
-    "@wp-playground/wordpress": "0.9.33"
+    "@php-wasm/node-polyfills": "0.9.34",
+    "@php-wasm/universal": "0.9.34",
+    "@php-wasm/logger": "0.9.34",
+    "@php-wasm/util": "0.9.34",
+    "@wp-playground/common": "0.9.34",
+    "@wp-playground/wordpress": "0.9.34"
   }
 }