@wp-playground/cli 1.2.3 → 2.0.0

package/blueprints-v1/blueprints-v1-handler.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { PlaygroundCliBlueprintV1Worker } from './worker-thread-v1';
+import type { MessagePort as NodeMessagePort } from 'worker_threads';
+import type { RunCLIArgs, SpawnedWorker } from '../run-cli';
+/**
+ * Boots Playground CLI workers using Blueprint version 1.
+ *
+ * Progress tracking, downloads, steps, and all other features are
+ * implemented in TypeScript and orchestrated by this class.
+ */
+export declare class BlueprintsV1Handler {
+    private phpVersion;
+    private lastProgressMessage;
+    private siteUrl;
+    private processIdSpaceLength;
+    private args;
+    constructor(args: RunCLIArgs, options: {
+        siteUrl: string;
+        processIdSpaceLength: number;
+    });
+    getWorkerUrl(): any;
+    bootPrimaryWorker(phpPort: NodeMessagePort, fileLockManagerPort: NodeMessagePort): Promise<import("@php-wasm/universal").RemoteAPI<PlaygroundCliBlueprintV1Worker>>;
+    bootSecondaryWorker({ worker, fileLockManagerPort, firstProcessId, }: {
+        worker: SpawnedWorker;
+        fileLockManagerPort: NodeMessagePort;
+        firstProcessId: number;
+    }): Promise<import("@php-wasm/universal").RemoteAPI<PlaygroundCliBlueprintV1Worker>>;
+    compileInputBlueprint(additionalBlueprintSteps: any[]): Promise<import("@wp-playground/blueprints").CompiledBlueprint>;
+    writeProgressUpdate(writeStream: NodeJS.WriteStream, message: string, finalUpdate: boolean): void;
+}

package/{worker-thread.d.ts → blueprints-v1/worker-thread-v1.d.ts}

@@ -8,7 +8,7 @@ export interface Mount {
     hostPath: string;
     vfsPath: string;
 }
-export type PrimaryWorkerBootOptions = {
+export type WorkerBootOptions = {
     wpVersion?: string;
     phpVersion?: SupportedPHPVersion;
     absoluteUrl: string;
@@ -31,7 +31,7 @@ export type PrimaryWorkerBootOptions = {
     internalCookieStore?: boolean;
     withXdebug?: boolean;
 };
-export declare class PlaygroundCliWorker extends PHPWorker {
+export declare class PlaygroundCliBlueprintV1Worker extends PHPWorker {
     booted: boolean;
     fileLockManager: RemoteAPI<FileLockManager> | FileLockManager | undefined;
     constructor(monitor: EmscriptenDownloadMonitor);
@@ -45,6 +45,7 @@ export declare class PlaygroundCliWorker extends PHPWorker {
      * @see phpwasm-emscripten-library-file-locking-for-node.js
      */
     useFileLockManager(port: MessagePort): Promise<void>;
-    boot({ absoluteUrl, mountsBeforeWpInstall, mountsAfterWpInstall, phpVersion, wordPressZip, sqliteIntegrationPluginZip, firstProcessId, processIdSpaceLength, dataSqlPath, followSymlinks, trace, internalCookieStore, withXdebug, }: PrimaryWorkerBootOptions): Promise<void>;
+    bootAsPrimaryWorker({ absoluteUrl, mountsBeforeWpInstall, mountsAfterWpInstall, phpVersion, wordPressZip, sqliteIntegrationPluginZip, firstProcessId, processIdSpaceLength, dataSqlPath, followSymlinks, trace, internalCookieStore, withXdebug, }: WorkerBootOptions): Promise<void>;
+    bootAsSecondaryWorker(args: WorkerBootOptions): Promise<void>;
     dispose(): Promise<void>;
 }

package/blueprints-v2/blueprint-v2-declaration.d.ts

@@ -0,0 +1,10 @@
+import type { BlueprintDeclaration } from '@wp-playground/blueprints';
+export type BlueprintV2Declaration = string | BlueprintDeclaration | undefined;
+export type ParsedBlueprintV2Declaration = {
+    type: 'inline-file';
+    contents: string;
+} | {
+    type: 'file-reference';
+    reference: string;
+};
+export declare function parseBlueprintDeclaration(source: BlueprintV2Declaration | ParsedBlueprintV2Declaration): ParsedBlueprintV2Declaration;

package/blueprints-v2/blueprints-v2-handler.d.ts

@@ -0,0 +1,31 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { RemoteAPI } from '@php-wasm/universal';
+import type { PlaygroundCliBlueprintV2Worker } from './worker-thread-v2';
+import type { MessagePort as NodeMessagePort } from 'worker_threads';
+import type { RunCLIArgs, SpawnedWorker } from '../run-cli';
+/**
+ * Boots Playground CLI workers using Blueprint version 2.
+ *
+ * Progress tracking, downloads, steps, and all other features are
+ * implemented in PHP and orchestrated by the worker thread.
+ */
+export declare class BlueprintsV2Handler {
+    private phpVersion;
+    private lastProgressMessage;
+    private siteUrl;
+    private processIdSpaceLength;
+    private args;
+    constructor(args: RunCLIArgs, options: {
+        siteUrl: string;
+        processIdSpaceLength: number;
+    });
+    getWorkerUrl(): any;
+    bootPrimaryWorker(phpPort: NodeMessagePort, fileLockManagerPort: NodeMessagePort): Promise<RemoteAPI<PlaygroundCliBlueprintV2Worker>>;
+    bootSecondaryWorker({ worker, fileLockManagerPort, firstProcessId, }: {
+        worker: SpawnedWorker;
+        fileLockManagerPort: NodeMessagePort;
+        firstProcessId: number;
+    }): Promise<RemoteAPI<PlaygroundCliBlueprintV2Worker>>;
+    writeProgressUpdate(writeStream: NodeJS.WriteStream, message: string, finalUpdate: boolean): void;
+}

package/blueprints-v2/get-v2-runner.d.ts

@@ -0,0 +1 @@
+export declare function getV2Runner(): Promise<File>;

package/{v2.d.ts → blueprints-v2/run-blueprint-v2.d.ts}

@@ -1,5 +1,5 @@
 import { type StreamedPHPResponse, type UniversalPHP } from '@php-wasm/universal';
-import type { BlueprintDeclaration } from '@wp-playground/blueprints';
+import { type BlueprintV2Declaration, type ParsedBlueprintV2Declaration } from './blueprint-v2-declaration';
 export type PHPExceptionDetails = {
     exception: string;
     message: string;
@@ -31,15 +31,5 @@ interface RunV2Options {
     };
     onMessage?: (message: BlueprintMessage) => void | Promise<void>;
 }
-export type BlueprintV2Declaration = string | BlueprintDeclaration | undefined;
-export type ParsedBlueprintV2Declaration = {
-    type: 'inline-file';
-    contents: string;
-} | {
-    type: 'file-reference';
-    reference: string;
-};
-export declare function parseBlueprintDeclaration(source: BlueprintV2Declaration | ParsedBlueprintV2Declaration): ParsedBlueprintV2Declaration;
-export declare function getV2Runner(): Promise<File>;
 export declare function runBlueprintV2(options: RunV2Options): Promise<StreamedPHPResponse>;
 export {};

package/blueprints-v2/worker-thread-v2.d.ts

@@ -0,0 +1,49 @@
+/// <reference types="node" />
+import type { FileLockManager } from '@php-wasm/node';
+import { EmscriptenDownloadMonitor } from '@php-wasm/progress';
+import type { RemoteAPI, SupportedPHPVersion } from '@php-wasm/universal';
+import { PHPWorker } from '@php-wasm/universal';
+import { type ParsedBlueprintV2Declaration, type BlueprintV2Declaration } from './blueprint-v2-declaration';
+import { type MessagePort } from 'worker_threads';
+import { type RunCLIArgs } from '../run-cli';
+export type WorkerBootArgs = RunCLIArgs & {
+    php: SupportedPHPVersion;
+    siteUrl: string;
+    firstProcessId: number;
+    processIdSpaceLength: number;
+    trace: boolean;
+    blueprint: BlueprintV2Declaration | ParsedBlueprintV2Declaration;
+};
+type WorkerRunBlueprintArgs = RunCLIArgs & {
+    siteUrl: string;
+    blueprint: BlueprintV2Declaration | ParsedBlueprintV2Declaration;
+};
+interface WorkerBootRequestHandlerOptions {
+    siteUrl: string;
+    php: SupportedPHPVersion;
+    allow?: string;
+    firstProcessId: number;
+    processIdSpaceLength: number;
+    trace: boolean;
+}
+export declare class PlaygroundCliBlueprintV2Worker extends PHPWorker {
+    booted: boolean;
+    fileLockManager: RemoteAPI<FileLockManager> | FileLockManager | undefined;
+    constructor(monitor: EmscriptenDownloadMonitor);
+    /**
+     * Call this method before boot() to use file locking.
+     *
+     * This method is separate from boot() to simplify the related Comlink.transferHandlers
+     * setup – if an argument is a MessagePort, we're transferring it, not copying it.
+     *
+     * @see comlink-sync.ts
+     * @see phpwasm-emscripten-library-file-locking-for-node.js
+     */
+    useFileLockManager(port: MessagePort): Promise<void>;
+    bootAsPrimaryWorker(args: WorkerBootArgs): Promise<void>;
+    bootAsSecondaryWorker(args: WorkerBootArgs): Promise<void>;
+    runBlueprintV2(args: WorkerRunBlueprintArgs): Promise<void>;
+    bootRequestHandler({ siteUrl, allow, php, firstProcessId, processIdSpaceLength, trace, }: WorkerBootRequestHandlerOptions): Promise<void>;
+    dispose(): Promise<void>;
+}
+export {};

package/cli.cjs

@@ -1,2 +1,2 @@
-"use strict";const s=require("./run-cli-B5BfXxxJ.cjs");s.parseOptionsAndRunCLI().catch(()=>{process.exit(1)});
+"use strict";const n=require("./run-cli-opqDVXKw.cjs");n.parseOptionsAndRunCLI();
 //# sourceMappingURL=cli.cjs.map

package/cli.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"cli.cjs","sources":["../../../../packages/playground/cli/src/cli.ts"],"sourcesContent":["import { parseOptionsAndRunCLI } from './run-cli';\n\n// Do not await this as top-level await is not supported in all environments.\nparseOptionsAndRunCLI().catch(() => {\n\t// process.exit(1); is here and not in parseOptionsAndRunCLI()\n\t// so that we can unit test the failure modes with try/catch.\n\tprocess.exit(1);\n});\n"],"names":["parseOptionsAndRunCLI"],"mappings":"uDAGAA,EAAAA,sBAAsB,EAAE,MAAM,IAAM,CAGnC,QAAQ,KAAK,CAAC,CACf,CAAC"}
+{"version":3,"file":"cli.cjs","sources":["../../../../packages/playground/cli/src/cli.ts"],"sourcesContent":["import { parseOptionsAndRunCLI } from './run-cli';\n\n// Do not await this as top-level await is not supported in all environments.\nparseOptionsAndRunCLI();\n"],"names":["parseOptionsAndRunCLI"],"mappings":"uDAGAA,EAAAA,sBAAsB"}

package/cli.js

@@ -1,5 +1,3 @@
-import { p } from "./run-cli-W9VNXESj.js";
-p().catch(() => {
-  process.exit(1);
-});
+import { p } from "./run-cli-CY1lYIJH.js";
+p();
 //# sourceMappingURL=cli.js.map

package/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sources":["../../../../packages/playground/cli/src/cli.ts"],"sourcesContent":["import { parseOptionsAndRunCLI } from './run-cli';\n\n// Do not await this as top-level await is not supported in all environments.\nparseOptionsAndRunCLI().catch(() => {\n\t// process.exit(1); is here and not in parseOptionsAndRunCLI()\n\t// so that we can unit test the failure modes with try/catch.\n\tprocess.exit(1);\n});\n"],"names":["parseOptionsAndRunCLI"],"mappings":";AAGAA,EAAsB,EAAE,MAAM,MAAM;AAGnC,UAAQ,KAAK,CAAC;AACf,CAAC;"}
+{"version":3,"file":"cli.js","sources":["../../../../packages/playground/cli/src/cli.ts"],"sourcesContent":["import { parseOptionsAndRunCLI } from './run-cli';\n\n// Do not await this as top-level await is not supported in all environments.\nparseOptionsAndRunCLI();\n"],"names":["parseOptionsAndRunCLI"],"mappings":";AAGAA,EAAsB;"}

package/index.cjs

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const n=require("./run-cli-B5BfXxxJ.cjs");exports.parseOptionsAndRunCLI=n.parseOptionsAndRunCLI;exports.runCLI=n.runCLI;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const n=require("./run-cli-opqDVXKw.cjs");exports.parseOptionsAndRunCLI=n.parseOptionsAndRunCLI;exports.runCLI=n.runCLI;
 //# sourceMappingURL=index.cjs.map

package/index.js

@@ -1,4 +1,4 @@
-import { p, r as s } from "./run-cli-W9VNXESj.js";
+import { p, r as s } from "./run-cli-CY1lYIJH.js";
 export {
   p as parseOptionsAndRunCLI,
   s as runCLI

package/load-balancer.d.ts

@@ -1,5 +1,7 @@
 import type { PHPRequest, PHPResponse, RemoteAPI } from '@php-wasm/universal';
-import type { PlaygroundCliWorker } from './worker-thread';
+import type { PlaygroundCliBlueprintV1Worker as PlaygroundCliWorkerV1 } from './blueprints-v1/worker-thread-v1';
+import type { PlaygroundCliBlueprintV2Worker as PlaygroundCliWorkerV2 } from './blueprints-v2/worker-thread-v2';
+type PlaygroundCliWorker = PlaygroundCliWorkerV1 | PlaygroundCliWorkerV2;
 type WorkerLoad = {
     worker: RemoteAPI<PlaygroundCliWorker>;
     activeRequests: Set<Promise<PHPResponse>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wp-playground/cli",
-  "version": "1.2.3",
+  "version": "2.0.0",
   "description": "WordPress Playground CLI",
   "repository": {
     "type": "git",
@@ -32,7 +32,7 @@
   "module": "./index.js",
   "types": "index.d.ts",
   "bin": "wp-playground.js",
-  "gitHead": "a6624a5390d899d164f887dc915a0ba1dbc31c83",
+  "gitHead": "4aa6ec4f0fe23920f735c0050228a509d94ce077",
   "dependencies": {
     "@zip.js/zip.js": "2.7.57",
     "ajv": "8.12.0",
@@ -55,15 +55,15 @@
     "wasm-feature-detect": "1.8.0",
     "ws": "8.18.1",
     "yargs": "17.7.2",
-    "@php-wasm/progress": "1.2.3",
-    "@php-wasm/universal": "1.2.3",
-    "@php-wasm/node": "1.2.3",
-    "@php-wasm/logger": "1.2.3",
-    "@wp-playground/storage": "1.2.3",
-    "@wp-playground/blueprints": "1.2.3",
-    "@wp-playground/common": "1.2.3",
-    "@wp-playground/wordpress": "1.2.3",
-    "@php-wasm/util": "1.2.3"
+    "@php-wasm/logger": "2.0.0",
+    "@php-wasm/progress": "2.0.0",
+    "@php-wasm/universal": "2.0.0",
+    "@wp-playground/blueprints": "2.0.0",
+    "@wp-playground/common": "2.0.0",
+    "@wp-playground/wordpress": "2.0.0",
+    "@php-wasm/node": "2.0.0",
+    "@php-wasm/util": "2.0.0",
+    "@wp-playground/storage": "2.0.0"
   },
   "overrides": {
     "rollup": "^4.34.6",