@wp-playground/blueprints 2.0.21 → 3.0.1

package/lib/resolve-remote-blueprint.d.ts

@@ -1,4 +1,4 @@
-import type { BlueprintBundle } from './blueprint';
+import type { BlueprintBundle } from './types';
 /**
  * Resolves a remote blueprint from a URL.
  *

package/lib/steps/index.d.ts

@@ -1,6 +1,6 @@
 import type { ProgressTracker } from '@php-wasm/progress';
 import type { UniversalPHP } from '@php-wasm/universal';
-import type { FileReference, DirectoryReference, Directory } from '../resources';
+import type { FileReference, DirectoryReference, Directory } from '../v1/resources';
 import type { ActivatePluginStep } from './activate-plugin';
 import type { DefineSiteUrlStep } from './define-site-url';
 import type { InstallPluginStep, InstallPluginOptions } from './install-plugin';

package/lib/steps/install-plugin.d.ts

@@ -1,6 +1,6 @@
 import type { StepHandler } from '.';
 import type { InstallAssetOptions } from './install-asset';
-import type { Directory } from '../resources';
+import type { Directory } from '../v1/resources';
 /**
  * @inheritDoc installPlugin
  * @hasRunnableExample

package/lib/steps/install-theme.d.ts

@@ -1,6 +1,6 @@
 import type { StepHandler } from '.';
 import type { InstallAssetOptions } from './install-asset';
-import type { Directory } from '../resources';
+import type { Directory } from '../v1/resources';
 /**
  * @inheritDoc installTheme
  * @hasRunnableExample

package/lib/steps/wp-cli.d.ts

@@ -1,6 +1,6 @@
 import type { PHPResponse, UniversalPHP } from '@php-wasm/universal';
 import type { StepHandler } from '.';
-import type { FileReference } from '../resources';
+import type { FileReference } from '../v1/resources';
 export declare const defaultWpCliPath = "/tmp/wp-cli.phar";
 export declare const defaultWpCliResource: FileReference;
 export declare const assertWpCli: (playground: UniversalPHP, wpCliPath?: string) => Promise<void>;

package/lib/steps/write-files.d.ts

@@ -1,5 +1,5 @@
 import type { StepHandler } from '.';
-import type { Directory } from '../resources';
+import type { Directory } from '../v1/resources';
 /**
  * @inheritDoc writeFiles
  * @hasRunnableExample

package/lib/types.d.ts

@@ -0,0 +1,11 @@
+import type { Filesystem } from '@wp-playground/storage';
+import type { V2Schema } from './v2/wep-1-blueprint-v2-schema/appendix-A-blueprint-v2-schema';
+import type { BlueprintV1, BlueprintV1Declaration } from './v1/types';
+import type { RawBlueprintV2Data } from './v2/blueprint-v2-declaration';
+/**
+ * A filesystem structure containing a /blueprint.json file and any
+ * resources referenced by that blueprint.
+ */
+export type BlueprintBundle = Filesystem;
+export type BlueprintDeclaration = BlueprintV1Declaration | RawBlueprintV2Data;
+export type Blueprint = BlueprintV1 | V2Schema.BlueprintV2;

package/lib/{compile.d.ts → v1/compile.d.ts}

@@ -1,10 +1,11 @@
 import { ProgressTracker } from '@php-wasm/progress';
 import { Semaphore } from '@php-wasm/util';
 import type { SupportedPHPVersion, UniversalPHP } from '@php-wasm/universal';
-import type { StepDefinition } from './steps';
-import type { BlueprintDeclaration, BlueprintBundle, ExtraLibrary, StreamBundledFile, Blueprint } from './blueprint';
-export type CompiledStep = (php: UniversalPHP) => Promise<void> | void;
-export interface CompiledBlueprint {
+import type { StepDefinition } from '../steps';
+import type { BlueprintV1Declaration, ExtraLibrary, StreamBundledFile, BlueprintV1 } from './types';
+import type { BlueprintBundle } from '../types';
+export type CompiledV1Step = (php: UniversalPHP) => Promise<void> | void;
+export interface CompiledBlueprintV1 {
     /** The requested versions of PHP and WordPress for the blueprint */
     versions: {
         php: SupportedPHPVersion;
@@ -20,13 +21,15 @@ export interface CompiledBlueprint {
     run: (playground: UniversalPHP) => Promise<void>;
 }
 export type OnStepCompleted = (output: any, step: StepDefinition) => any;
-export interface CompileBlueprintOptions {
+export interface CompileBlueprintV1Options {
     /** Optional progress tracker to monitor progress */
     progress?: ProgressTracker;
     /** Optional semaphore to control access to a shared resource */
     semaphore?: Semaphore;
     /** Optional callback with step output */
     onStepCompleted?: OnStepCompleted;
+    /** Optional callback with blueprint validation result */
+    onBlueprintValidated?: (blueprint: BlueprintV1Declaration) => void;
     /**
      * Proxy URL to use for cross-origin requests.
      *
@@ -44,9 +47,9 @@ export interface CompileBlueprintOptions {
      */
     additionalSteps?: any[];
 }
-export declare function compileBlueprint(input: BlueprintDeclaration | BlueprintBundle, options?: Omit<CompileBlueprintOptions, 'streamBundledFile'>): Promise<CompiledBlueprint>;
+export declare function compileBlueprintV1(input: BlueprintV1Declaration | BlueprintBundle, options?: Omit<CompileBlueprintV1Options, 'streamBundledFile'>): Promise<CompiledBlueprintV1>;
 export declare function isBlueprintBundle(input: any): input is BlueprintBundle;
-export declare function getBlueprintDeclaration(blueprint: Blueprint): Promise<BlueprintDeclaration>;
+export declare function getBlueprintDeclaration(blueprint: BlueprintV1 | BlueprintBundle): Promise<BlueprintV1Declaration>;
 export declare function validateBlueprint(blueprintMaybe: object): {
     valid: true;
     errors?: undefined;
@@ -54,4 +57,4 @@ export declare function validateBlueprint(blueprintMaybe: object): {
     valid: false;
     errors: import("ajv").ErrorObject<string, Record<string, any>, unknown>[] | undefined;
 };
-export declare function runBlueprintSteps(compiledBlueprint: CompiledBlueprint, playground: UniversalPHP): Promise<void>;
+export declare function runBlueprintV1Steps(compiledBlueprint: CompiledBlueprintV1, playground: UniversalPHP): Promise<void>;

package/lib/{resources.d.ts → v1/resources.d.ts}

@@ -2,7 +2,7 @@ import type { ProgressTracker } from '@php-wasm/progress';
 import type { FileTree, UniversalPHP } from '@php-wasm/universal';
 import type { Semaphore } from '@php-wasm/util';
 import { StreamedFile } from '@php-wasm/stream-compression';
-import type { StreamBundledFile } from './blueprint';
+import type { StreamBundledFile } from './types';
 export type { FileTree };
 export declare const ResourceTypes: readonly ["vfs", "literal", "wordpress.org/themes", "wordpress.org/plugins", "url", "git:directory", "bundled"];
 export type VFSReference = {

package/lib/{blueprint.d.ts → v1/types.d.ts}

@@ -1,21 +1,16 @@
 import type { SupportedPHPVersion } from '@php-wasm/universal';
-import type { StepDefinition } from './steps';
+import type { StepDefinition } from '../steps';
 import type { FileReference } from './resources';
 import type { StreamedFile } from '@php-wasm/stream-compression';
-import type { Filesystem } from '@wp-playground/storage';
+import type { BlueprintBundle } from '../types';
 export type ExtraLibrary = 'wp-cli';
 export type PHPConstants = Record<string, string | boolean | number>;
 export type StreamBundledFile = (relativePath: string) => Promise<StreamedFile>;
-export type Blueprint = BlueprintBundle | BlueprintDeclaration;
-/**
- * A filesystem structure containing a /blueprint.json file and any
- * resources referenced by that blueprint.
- */
-export type BlueprintBundle = Filesystem;
+export type BlueprintV1 = BlueprintV1Declaration | BlueprintBundle;
 /**
  * The Blueprint declaration, typically stored in a blueprint.json file.
  */
-export type BlueprintDeclaration = {
+export type BlueprintV1Declaration = {
     /**
      * The URL to navigate to after the blueprint has been run.
      */

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

@@ -1,10 +1,10 @@
-import type { BlueprintDeclaration } from '../blueprint';
-export type BlueprintV2Declaration = string | BlueprintDeclaration | undefined;
-export type ParsedBlueprintV2Declaration = {
+import type { BlueprintV1Declaration } from '../v1/types';
+export type RawBlueprintV2Data = string | BlueprintV1Declaration | undefined;
+export type ParsedBlueprintV2String = {
     type: 'inline-file';
     contents: string;
 } | {
     type: 'file-reference';
     reference: string;
 };
-export declare function parseBlueprintDeclaration(source: BlueprintV2Declaration | ParsedBlueprintV2Declaration): ParsedBlueprintV2Declaration;
+export declare function parseBlueprintDeclaration(source: RawBlueprintV2Data | ParsedBlueprintV2String): ParsedBlueprintV2String;

package/lib/v2/run-blueprint-v2.d.ts

@@ -1,5 +1,5 @@
 import { type StreamedPHPResponse, type UniversalPHP } from '@php-wasm/universal';
-import { type BlueprintV2Declaration, type ParsedBlueprintV2Declaration } from './blueprint-v2-declaration';
+import { type RawBlueprintV2Data, type ParsedBlueprintV2String } from './blueprint-v2-declaration';
 export type PHPExceptionDetails = {
     exception: string;
     message: string;
@@ -24,7 +24,7 @@ export type BlueprintMessage = {
 interface RunV2Options {
     php: UniversalPHP;
     cliArgs?: string[];
-    blueprint: BlueprintV2Declaration | ParsedBlueprintV2Declaration;
+    blueprint: RawBlueprintV2Data | ParsedBlueprintV2String;
     blueprintOverrides?: {
         wordpressVersion?: string;
         additionalSteps?: any[];