@php-wasm/util 0.9.31 → 0.9.33

package/index.d.ts

@@ -0,0 +1 @@
+export * from './lib';

package/lib/create-spawn-handler.d.ts

@@ -0,0 +1,48 @@
+type Listener = (...args: any[]) => any;
+export interface ProcessOptions {
+    cwd?: string;
+    env?: Record<string, string>;
+}
+/**
+ * Usage:
+ * ```ts
+ * php.setSpawnHandler(
+ *   createSpawnHandler(function (command, processApi) {
+ *     console.log(processApi.flushStdin());
+ *     processApi.stdout('/\n/tmp\n/home');
+ *	   processApi.exit(0);
+ *   })
+ * );
+ * ```
+ * @param program
+ * @returns
+ */
+export declare function createSpawnHandler(program: (command: string[], processApi: ProcessApi, options: ProcessOptions) => void | Promise<void>): any;
+declare class EventEmitter {
+    listeners: Record<string, Listener[]>;
+    emit(eventName: string, data: any): void;
+    on(eventName: string, listener: Listener): void;
+}
+export declare class ProcessApi extends EventEmitter {
+    private childProcess;
+    private exited;
+    private stdinData;
+    constructor(childProcess: ChildProcess);
+    stdout(data: string | ArrayBuffer): void;
+    stdoutEnd(): void;
+    stderr(data: string | ArrayBuffer): void;
+    stderrEnd(): void;
+    exit(code: number): void;
+    flushStdin(): void;
+}
+export type StdIn = {
+    write: (data: string) => void;
+};
+export declare class ChildProcess extends EventEmitter {
+    pid: number;
+    stdout: EventEmitter;
+    stderr: EventEmitter;
+    stdin: StdIn;
+    constructor(pid?: number);
+}
+export {};

package/lib/index.d.ts

@@ -0,0 +1,9 @@
+import Semaphore, { AcquireTimeoutError } from './semaphore';
+export { Semaphore, AcquireTimeoutError };
+export { PhpWasmError } from './php-wasm-error';
+export type { SemaphoreOptions } from './semaphore';
+export { dirname, joinPaths, basename, normalizePath, isParentOf, } from './paths';
+export { createSpawnHandler } from './create-spawn-handler';
+export { randomString } from './random-string';
+export { randomFilename } from './random-filename';
+export * from './php-vars';

package/lib/paths.d.ts

@@ -0,0 +1,76 @@
+/**
+ * The functions in this module are mostly copied from the generated
+ * Emscripten PHP module. This enables features like filesystem journaling,
+ * which use some low-level Emscripten APIs and need access to the
+ * same path helpers.
+ */
+/**
+ * Joins paths together.
+ *
+ * For example:
+ *
+ * > joinPaths('wordpress', 'wp-content')
+ * 'wordpress/wp-content'
+ *
+ * Use this for all PHP paths and **do not** use path.join().
+ * This is important because Emscripten paths are **always**
+ * POSIX-style paths. Imagine joining paths on Windows:
+ *
+ * > path.join('wordpress', 'wp-content')
+ * '\\wordpress\\wp-content'  // invalid in PHP.wasm
+ *
+ * See the path.join issue for more details:
+ *
+ * https://github.com/WordPress/playground-tools/issues/11#issuecomment-1579074763
+ *
+ * @param paths Paths segments to join
+ * @returns A joined path
+ */
+export declare function joinPaths(...paths: string[]): string;
+/**
+ * Returns the directory name of a path.
+ *
+ * @param path
+ * @returns
+ */
+export declare function dirname(path: string): string;
+/**
+ * Returns the last portion of a path.
+ *
+ * @param path - The path to extract the basename from.
+ * @returns The basename of the path.
+ */
+export declare function basename(path: string): string;
+/**
+ * Normalizes a path.
+ *
+ * For example:
+ *
+ * > normalizePath('wordpress/wp-content/../')
+ * 'wordpress'
+ *
+ * @param path
+ * @returns
+ */
+export declare function normalizePath(path: string): string;
+/**
+ * Normalizes paths.
+ *
+ * For example:
+ *
+ * > normalizePathsArray(['wordpress', 'wp-content', '..', '', '.',
+ * 'wp-includes']) ['wordpress', 'wp-includes']
+ *
+ * @param parts parts of the path to normalize
+ * @param allowAboveRoot allow paths above the root
+ * @returns normalized paths
+ */
+export declare function normalizePathsArray(parts: string[], allowAboveRoot: boolean): string[];
+/**
+ * Checks if the given parent path is an ancestor of the given child path.
+ *
+ * @param parent The parent path to check.
+ * @param child The child path to verify against the parent.
+ * @returns Whether the `parent` path is an ancestor of the `child` path.
+ */
+export declare function isParentOf(parent: string, child: string): boolean;

package/lib/php-vars.d.ts

@@ -0,0 +1,2 @@
+export declare function phpVar(value: unknown): string;
+export declare function phpVars<T extends Record<string, unknown>>(vars: T): Record<keyof T, string>;

package/lib/php-wasm-error.d.ts

@@ -0,0 +1,4 @@
+export declare class PhpWasmError extends Error {
+    userFriendlyMessage?: string | undefined;
+    constructor(message: string, userFriendlyMessage?: string | undefined);
+}

package/lib/random-filename.d.ts

@@ -0,0 +1 @@
+export declare function randomFilename(): string;

package/lib/random-string.d.ts

@@ -0,0 +1 @@
+export declare function randomString(length?: number, specialChars?: string): string;

package/lib/semaphore.d.ts

@@ -0,0 +1,24 @@
+export interface SemaphoreOptions {
+    /**
+     * The maximum number of concurrent locks.
+     */
+    concurrency: number;
+    /**
+     * The maximum time to wait for a lock to become available.
+     */
+    timeout?: number;
+}
+export declare class AcquireTimeoutError extends Error {
+    constructor();
+}
+export default class Semaphore {
+    private _running;
+    private concurrency;
+    private timeout?;
+    private queue;
+    constructor({ concurrency, timeout }: SemaphoreOptions);
+    get remaining(): number;
+    get running(): number;
+    acquire(): Promise<() => void>;
+    run<T>(fn: () => T | Promise<T>): Promise<T>;
+}

package/lib/sleep.d.ts

@@ -0,0 +1,2 @@
+export declare const SleepFinished: unique symbol;
+export declare function sleep(ms: number): Promise<typeof SleepFinished>;

package/lib/split-shell-command.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Naive shell command parser.
+ * Ensures that commands like `wp option set blogname "My blog name"` are split
+ * into `['wp', 'option', 'set', 'blogname', 'My blog name']` instead of
+ * `['wp', 'option', 'set', 'blogname', 'My', 'blog', 'name']`.
+ *
+ * @param command
+ * @returns
+ */
+export declare function splitShellCommand(command: string): string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@php-wasm/util",
-  "version": "0.9.31",
+  "version": "0.9.33",
   "type": "module",
   "types": "index.d.ts",
   "typedoc": {
@@ -13,7 +13,7 @@
     "access": "public",
     "directory": "../../../dist/packages/php-wasm/util"
   },
-  "gitHead": "296845449383439f6304f0559eaacf14cef68989",
+  "gitHead": "bcfaa019188a6a6e381338704151566eb050638a",
   "engines": {
     "node": ">=18.18.0",
     "npm": ">=8.11.0"