@wp-playground/blueprints 1.0.29 → 1.1.1

package/lib/blueprint.d.ts

@@ -1,9 +1,21 @@
-import { SupportedPHPVersion } from '@php-wasm/universal';
-import { StepDefinition } from './steps';
-import { FileReference } from './resources';
+import type { SupportedPHPVersion } from '@php-wasm/universal';
+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';
 export type ExtraLibrary = 'wp-cli';
 export type PHPConstants = Record<string, string | boolean | number>;
-export interface Blueprint {
+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;
+/**
+ * The Blueprint declaration, typically stored in a blueprint.json file.
+ */
+export type BlueprintDeclaration = {
     /**
      * The URL to navigate to after the blueprint has been run.
      */
@@ -93,4 +105,4 @@ export interface Blueprint {
      * executed.
      */
     steps?: Array<StepDefinition | string | undefined | false | null>;
-}
+};

package/lib/compile.d.ts

@@ -1,8 +1,8 @@
 import { ProgressTracker } from '@php-wasm/progress';
 import { Semaphore } from '@php-wasm/util';
-import { SupportedPHPVersion, UniversalPHP } from '@php-wasm/universal';
-import { StepDefinition } from './steps';
-import { Blueprint, ExtraLibrary } from './blueprint';
+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 {
     /** The requested versions of PHP and WordPress for the blueprint */
@@ -34,16 +34,14 @@ export interface CompileBlueprintOptions {
      * be made to https://cors.wordpress.net/proxy.php?https://github.com/WordPress/gutenberg.git.
      */
     corsProxy?: string;
+    /**
+     * A filesystem to use for the blueprint.
+     */
+    streamBundledFile?: StreamBundledFile;
 }
-/**
- * Compiles Blueprint into a form that can be executed.
- *
- * @param playground The PlaygroundClient to use for the compilation
- * @param blueprint The bBueprint to compile
- * @param options Additional options for the compilation
- * @returns The compiled blueprint
- */
-export declare function compileBlueprint(blueprint: Blueprint, { progress, semaphore, onStepCompleted, corsProxy, }?: CompileBlueprintOptions): CompiledBlueprint;
+export declare function compileBlueprint(input: BlueprintDeclaration | BlueprintBundle, options?: Omit<CompileBlueprintOptions, 'streamBundledFile'>): Promise<CompiledBlueprint>;
+export declare function isBlueprintBundle(input: any): input is BlueprintBundle;
+export declare function getBlueprintDeclaration(blueprint: Blueprint): Promise<BlueprintDeclaration>;
 export declare function validateBlueprint(blueprintMaybe: object): {
     valid: true;
     errors?: undefined;

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

@@ -0,0 +1,8 @@
+import type { BlueprintBundle } from './blueprint';
+/**
+ * Resolves a remote blueprint from a URL.
+ *
+ * @param url - The URL of the blueprint to resolve.
+ * @returns A promise that resolves to the resolved blueprint.
+ */
+export declare function resolveRemoteBlueprint(url: string): Promise<BlueprintBundle>;

package/lib/resources.d.ts

@@ -1,8 +1,10 @@
-import { ProgressTracker } from '@php-wasm/progress';
-import { FileTree, UniversalPHP } from '@php-wasm/universal';
-import { Semaphore } from '@php-wasm/util';
+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';
 export type { FileTree };
-export declare const ResourceTypes: readonly ["vfs", "literal", "wordpress.org/themes", "wordpress.org/plugins", "url", "git:directory"];
+export declare const ResourceTypes: readonly ["vfs", "literal", "wordpress.org/themes", "wordpress.org/plugins", "url", "git:directory", "bundled"];
 export type VFSReference = {
     /** Identifies the file resource as Virtual File System (VFS) */
     resource: 'vfs';
@@ -55,7 +57,13 @@ export type DirectoryLiteralReference = Directory & {
     /** Identifies the file resource as a git directory */
     resource: 'literal:directory';
 };
-export type FileReference = VFSReference | LiteralReference | CoreThemeReference | CorePluginReference | UrlReference;
+export type BundledReference = {
+    /** Identifies the file resource as a Blueprint file */
+    resource: 'bundled';
+    /** The path to the file in the Blueprint */
+    path: string;
+};
+export type FileReference = VFSReference | LiteralReference | CoreThemeReference | CorePluginReference | UrlReference | BundledReference;
 export type DirectoryReference = GitDirectoryReference | DirectoryLiteralReference;
 export declare function isResourceReference(ref: any): ref is FileReference;
 export declare abstract class Resource<T extends File | Directory> {
@@ -79,11 +87,12 @@ export declare abstract class Resource<T extends File | Directory> {
      * @param options Additional options for the Resource
      * @returns A new Resource instance
      */
-    static create(ref: FileReference | DirectoryReference, { semaphore, progress, corsProxy, }: {
+    static create(ref: FileReference | DirectoryReference, { semaphore, progress, corsProxy, streamBundledFile, }: {
         /** Optional semaphore to limit concurrent downloads */
         semaphore?: Semaphore;
         progress?: ProgressTracker;
         corsProxy?: string;
+        streamBundledFile?: StreamBundledFile;
     }): Resource<File | Directory>;
 }
 export declare abstract class ResourceDecorator<T extends File | Directory> extends Resource<T> {
@@ -108,14 +117,13 @@ export declare abstract class ResourceDecorator<T extends File | Directory> exte
  */
 export declare class VFSResource extends Resource<File> {
     private resource;
-    _progress?: ProgressTracker | undefined;
     /**
      * Creates a new instance of `VFSResource`.
      * @param playground The playground client.
      * @param resource The VFS reference.
      * @param progress The progress tracker.
      */
-    constructor(resource: VFSReference, _progress?: ProgressTracker | undefined);
+    constructor(resource: VFSReference, _progress?: ProgressTracker);
     /** @inheritDoc */
     resolve(): Promise<File>;
     /** @inheritDoc */
@@ -126,13 +134,12 @@ export declare class VFSResource extends Resource<File> {
  */
 export declare class LiteralResource extends Resource<File> {
     private resource;
-    _progress?: ProgressTracker | undefined;
     /**
      * Creates a new instance of `LiteralResource`.
      * @param resource The literal reference.
      * @param progress The progress tracker.
      */
-    constructor(resource: LiteralReference, _progress?: ProgressTracker | undefined);
+    constructor(resource: LiteralReference, _progress?: ProgressTracker);
     /** @inheritDoc */
     resolve(): Promise<File>;
     /** @inheritDoc */
@@ -142,13 +149,12 @@ export declare class LiteralResource extends Resource<File> {
  * A base class for `Resource`s that require fetching data from a remote URL.
  */
 export declare abstract class FetchResource extends Resource<File> {
-    _progress?: ProgressTracker | undefined;
     private corsProxy?;
     /**
      * Creates a new instance of `FetchResource`.
      * @param progress The progress tracker.
      */
-    constructor(_progress?: ProgressTracker | undefined, corsProxy?: string | undefined);
+    constructor(_progress?: ProgressTracker, corsProxy?: string);
     /** @inheritDoc */
     resolve(): Promise<File>;
     /**
@@ -178,8 +184,8 @@ export declare class UrlResource extends FetchResource {
      * @param progress The progress tracker.
      */
     constructor(resource: UrlReference, progress?: ProgressTracker, options?: {
-        corsProxy?: string | undefined;
-    } | undefined);
+        corsProxy?: string;
+    });
     /** @inheritDoc */
     getURL(): string;
     /** @inheritDoc */
@@ -190,11 +196,10 @@ export declare class UrlResource extends FetchResource {
  */
 export declare class GitDirectoryResource extends Resource<Directory> {
     private reference;
-    _progress?: ProgressTracker | undefined;
     private options?;
-    constructor(reference: GitDirectoryReference, _progress?: ProgressTracker | undefined, options?: {
-        corsProxy?: string | undefined;
-    } | undefined);
+    constructor(reference: GitDirectoryReference, _progress?: ProgressTracker, options?: {
+        corsProxy?: string;
+    });
     resolve(): Promise<{
         name: string;
         files: Record<string, any>;
@@ -207,8 +212,7 @@ export declare class GitDirectoryResource extends Resource<Directory> {
  */
 export declare class LiteralDirectoryResource extends Resource<Directory> {
     private reference;
-    _progress?: ProgressTracker | undefined;
-    constructor(reference: DirectoryLiteralReference, _progress?: ProgressTracker | undefined);
+    constructor(reference: DirectoryLiteralReference, _progress?: ProgressTracker);
     resolve(): Promise<DirectoryLiteralReference>;
     /** @inheritDoc */
     get name(): string;
@@ -257,3 +261,23 @@ export declare class SemaphoreResource<T extends File | Directory> extends Resou
     /** @inheritDoc */
     resolve(): Promise<T>;
 }
+/**
+ * A `Resource` that represents a file bundled with the Blueprint.
+ */
+export declare class BundledResource extends Resource<File> {
+    private resource;
+    private streamBundledFile;
+    /**
+     * Creates a new instance of `BlueprintResource`.
+     * @param resource The blueprint reference.
+     * @param filesystem The filesystem to read from.
+     * @param progress The progress tracker.
+     */
+    constructor(resource: BundledReference, streamBundledFile: StreamBundledFile, _progress?: ProgressTracker);
+    /** @inheritDoc */
+    resolve(): Promise<StreamedFile>;
+    /** @inheritDoc */
+    get name(): string;
+    /** @inheritDoc */
+    get isAsync(): boolean;
+}

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

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc activatePlugin
  * @example

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

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc activateTheme
  * @example

package/lib/steps/cp.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc cp
  * @hasRunnableExample

package/lib/steps/define-site-url.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * Changes the site URL of the WordPress installation.
  *

package/lib/steps/define-wp-config-consts.d.ts

@@ -1,5 +1,5 @@
-import { StepHandler } from '.';
-import { UniversalPHP } from '@php-wasm/universal';
+import type { StepHandler } from '.';
+import type { UniversalPHP } from '@php-wasm/universal';
 /**
  * @inheritDoc defineWpConfigConsts
  * @hasRunnableExample
@@ -50,4 +50,3 @@ export interface DefineWpConfigConstsStep {
  */
 export declare const defineWpConfigConsts: StepHandler<DefineWpConfigConstsStep>;
 export declare function defineBeforeRun(playground: UniversalPHP, consts: Record<string, unknown>): Promise<void>;
-export declare function rewriteDefineCalls(playground: UniversalPHP, phpCode: string, consts: Record<string, unknown>): Promise<string>;

package/lib/steps/enable-multisite.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc enableMultisite
  * @hasRunnableExample

package/lib/steps/export-wxr.d.ts

@@ -1,4 +1,4 @@
-import { UniversalPHP } from '@php-wasm/universal';
+import type { UniversalPHP } from '@php-wasm/universal';
 /**
  * Exports the WordPress database as a WXR file using
  * the core WordPress export tool.

package/lib/steps/import-theme-starter-content.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc importThemeStarterContent
  * @example

package/lib/steps/import-wordpress-files.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc importWordPressFiles
  * @example

package/lib/steps/import-wxr.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc importWxr
  * @example

package/lib/steps/index.d.ts

@@ -1,34 +1,34 @@
-import { ProgressTracker } from '@php-wasm/progress';
-import { UniversalPHP } from '@php-wasm/universal';
-import { FileReference, DirectoryReference, Directory } from '../resources';
-import { ActivatePluginStep } from './activate-plugin';
-import { DefineSiteUrlStep } from './define-site-url';
-import { InstallPluginStep, InstallPluginOptions } from './install-plugin';
-import { InstallThemeStep, InstallThemeOptions } from './install-theme';
-import { LoginStep } from './login';
-import { RunWpInstallationWizardStep, WordPressInstallationOptions } from './run-wp-installation-wizard';
-import { SetSiteOptionsStep, UpdateUserMetaStep } from './site-data';
-import { RmStep } from './rm';
-import { CpStep } from './cp';
-import { RmdirStep } from './rmdir';
-import { RunSqlStep } from './run-sql';
-import { MkdirStep } from './mkdir';
-import { MvStep } from './mv';
-import { RunPHPStep } from './run-php';
-import { RunPHPWithOptionsStep } from './run-php-with-options';
-import { RequestStep } from './request';
-import { WriteFileStep } from './write-file';
-import { WriteFilesStep } from './write-files';
-import { DefineWpConfigConstsStep } from './define-wp-config-consts';
-import { ActivateThemeStep } from './activate-theme';
-import { UnzipStep } from './unzip';
-import { ImportWordPressFilesStep } from './import-wordpress-files';
-import { ImportThemeStarterContentStep } from './import-theme-starter-content';
-import { ImportWxrStep } from './import-wxr';
-import { EnableMultisiteStep } from './enable-multisite';
-import { WPCLIStep } from './wp-cli';
-import { ResetDataStep } from './reset-data';
-import { SetSiteLanguageStep } from './set-site-language';
+import type { ProgressTracker } from '@php-wasm/progress';
+import type { UniversalPHP } from '@php-wasm/universal';
+import type { FileReference, DirectoryReference, Directory } from '../resources';
+import type { ActivatePluginStep } from './activate-plugin';
+import type { DefineSiteUrlStep } from './define-site-url';
+import type { InstallPluginStep, InstallPluginOptions } from './install-plugin';
+import type { InstallThemeStep, InstallThemeOptions } from './install-theme';
+import type { LoginStep } from './login';
+import type { RunWpInstallationWizardStep, WordPressInstallationOptions } from './run-wp-installation-wizard';
+import type { SetSiteOptionsStep, UpdateUserMetaStep } from './site-data';
+import type { RmStep } from './rm';
+import type { CpStep } from './cp';
+import type { RmdirStep } from './rmdir';
+import type { RunSqlStep } from './run-sql';
+import type { MkdirStep } from './mkdir';
+import type { MvStep } from './mv';
+import type { RunPHPStep } from './run-php';
+import type { RunPHPWithOptionsStep } from './run-php-with-options';
+import type { RequestStep } from './request';
+import type { WriteFileStep } from './write-file';
+import type { WriteFilesStep } from './write-files';
+import type { DefineWpConfigConstsStep } from './define-wp-config-consts';
+import type { ActivateThemeStep } from './activate-theme';
+import type { UnzipStep } from './unzip';
+import type { ImportWordPressFilesStep } from './import-wordpress-files';
+import type { ImportThemeStarterContentStep } from './import-theme-starter-content';
+import type { ImportWxrStep } from './import-wxr';
+import type { EnableMultisiteStep } from './enable-multisite';
+import type { WPCLIStep } from './wp-cli';
+import type { ResetDataStep } from './reset-data';
+import type { SetSiteLanguageStep } from './set-site-language';
 export type Step = GenericStep<FileReference, DirectoryReference>;
 export type StepDefinition = Step & {
     progress?: {

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

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

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

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

package/lib/steps/login.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc login
  * @hasRunnableExample

package/lib/steps/mkdir.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc mkdir
  * @hasRunnableExample

package/lib/steps/mv.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc mv
  * @hasRunnableExample

package/lib/steps/request.d.ts

@@ -1,5 +1,5 @@
-import { PHPRequest, PHPResponse } from '@php-wasm/universal';
-import { StepHandler } from '.';
+import type { PHPRequest, PHPResponse } from '@php-wasm/universal';
+import type { StepHandler } from '.';
 /**
  * @private
  * @inheritDoc request

package/lib/steps/reset-data.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc resetData
  * @example

package/lib/steps/rm.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc rm
  * @hasRunnableExample

package/lib/steps/rmdir.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc rmdir
  * @hasRunnableExample

package/lib/steps/run-php-with-options.d.ts

@@ -1,5 +1,5 @@
-import { StepHandler } from '.';
-import { PHPRunOptions } from '@php-wasm/universal';
+import type { StepHandler } from '.';
+import type { PHPRunOptions } from '@php-wasm/universal';
 /**
  * @inheritDoc runPHP
  * @hasRunnableExample

package/lib/steps/run-php.d.ts

@@ -1,5 +1,5 @@
-import { PHPResponse } from '@php-wasm/universal';
-import { StepHandler } from '.';
+import type { PHPResponse } from '@php-wasm/universal';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc runPHP
  * @hasRunnableExample

package/lib/steps/run-sql.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc runSql
  * @hasRunnableExample

package/lib/steps/run-wp-installation-wizard.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @private
  */

package/lib/steps/set-site-language.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc setSiteLanguage
  * @hasRunnableExample
@@ -17,11 +17,13 @@ export interface SetSiteLanguageStep {
     language: string;
 }
 /**
- * Infers the translation package URL for a given WordPress version.
+ * Get the translation package URL for a given WordPress version and language.
+ * The translation package URL is fetched from the WordPress.org API based on
+ * the provided WordPress version.
  *
- * If it cannot be inferred, the latest translation package will be used instead.
+ * If the translation package is not found, an error is thrown.
  */
-export declare const getWordPressTranslationUrl: (wpVersion: string, language: string, latestBetaWordPressVersion?: string, latestStableWordPressVersion?: string) => Promise<string>;
+export declare const getWordPressTranslationUrl: (wpVersion: string, language: string) => Promise<string>;
 /**
  * Sets the site language and download translations.
  */

package/lib/steps/site-data.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc setSiteOptions
  * @hasRunnableExample

package/lib/steps/unzip.d.ts

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc unzip
  * @example

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

@@ -1,6 +1,6 @@
-import { PHPResponse, UniversalPHP } from '@php-wasm/universal';
-import { StepHandler } from '.';
-import { FileReference } from '../resources';
+import type { PHPResponse, UniversalPHP } from '@php-wasm/universal';
+import type { StepHandler } from '.';
+import type { FileReference } from '../resources';
 export declare const defaultWpCliPath = "/tmp/wp-cli.phar";
 export declare const defaultWpCliResource: FileReference;
 export declare const assertWpCli: (playground: UniversalPHP, wpCliPath?: string) => Promise<void>;
@@ -12,8 +12,7 @@ export declare const assertWpCli: (playground: UniversalPHP, wpCliPath?: string)
  * <code>
  * {
  * 		"step": "wp-cli",
- * 		"command": "wp post create --post_title='Test post' --post_excerpt='Some
- * 		content'"
+ * 		"command": "wp post create --post_title='Test post' --post_excerpt='Some content'"
  * }
  * </code>
  */

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

@@ -1,4 +1,4 @@
-import { StepHandler } from '.';
+import type { StepHandler } from '.';
 /**
  * @inheritDoc writeFile
  * @hasRunnableExample

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

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

package/lib/steps/zip-wp-content.d.ts

@@ -1,4 +1,4 @@
-import { UniversalPHP } from '@php-wasm/universal';
+import type { UniversalPHP } from '@php-wasm/universal';
 interface ZipWpContentOptions {
     /**
      * @private