@wp-playground/blueprints 0.9.46 → 1.0.0

package/lib/blueprint.d.ts

@@ -1,4 +1,4 @@
-import { SupportedPHPExtensionBundle, SupportedPHPVersion } from '@php-wasm/universal';
+import { SupportedPHPVersion } from '@php-wasm/universal';
 import { StepDefinition } from './steps';
 import { FileReference } from './resources';
 export type ExtraLibrary = 'wp-cli';
@@ -84,9 +84,9 @@ export interface Blueprint {
         password: string;
     };
     /**
-     * The PHP extensions to use.
+     * @deprecated No longer used. Feel free to remove it from your Blueprint.
      */
-    phpExtensionBundles?: SupportedPHPExtensionBundle[];
+    phpExtensionBundles?: any;
     /**
      * The steps to run after every other operation in this Blueprint was
      * executed.

package/lib/compile.d.ts

@@ -1,6 +1,6 @@
 import { ProgressTracker } from '@php-wasm/progress';
 import { Semaphore } from '@php-wasm/util';
-import { SupportedPHPExtension, SupportedPHPVersion, UniversalPHP } from '@php-wasm/universal';
+import { SupportedPHPVersion, UniversalPHP } from '@php-wasm/universal';
 import { StepDefinition } from './steps';
 import { Blueprint, ExtraLibrary } from './blueprint';
 export type CompiledStep = (php: UniversalPHP) => Promise<void> | void;
@@ -10,8 +10,6 @@ export interface CompiledBlueprint {
         php: SupportedPHPVersion;
         wp: string;
     };
-    /** The requested PHP extensions to load */
-    phpExtensions: SupportedPHPExtension[];
     features: {
         /** Should boot with support for network request via wp_safe_remote_get? */
         networking: boolean;
@@ -28,6 +26,14 @@ export interface CompileBlueprintOptions {
     semaphore?: Semaphore;
     /** Optional callback with step output */
     onStepCompleted?: OnStepCompleted;
+    /**
+     * Proxy URL to use for cross-origin requests.
+     *
+     * For example, if corsProxy is set to "https://cors.wordpress.net/proxy.php",
+     * then the CORS requests to https://github.com/WordPress/gutenberg.git would actually
+     * be made to https://cors.wordpress.net/proxy.php/https://github.com/WordPress/gutenberg.git.
+     */
+    corsProxy?: string;
 }
 /**
  * Compiles Blueprint into a form that can be executed.
@@ -37,7 +43,7 @@ export interface CompileBlueprintOptions {
  * @param options Additional options for the compilation
  * @returns The compiled blueprint
  */
-export declare function compileBlueprint(blueprint: Blueprint, { progress, semaphore, onStepCompleted, }?: CompileBlueprintOptions): CompiledBlueprint;
+export declare function compileBlueprint(blueprint: Blueprint, { progress, semaphore, onStepCompleted, corsProxy, }?: CompileBlueprintOptions): CompiledBlueprint;
 export declare function validateBlueprint(blueprintMaybe: object): {
     valid: true;
     errors?: undefined;

package/lib/resources.d.ts

@@ -1,7 +1,8 @@
 import { ProgressTracker } from '@php-wasm/progress';
-import { UniversalPHP } from '@php-wasm/universal';
+import { FileTree, UniversalPHP } from '@php-wasm/universal';
 import { Semaphore } from '@php-wasm/util';
-export declare const ResourceTypes: readonly ["vfs", "literal", "wordpress.org/themes", "wordpress.org/plugins", "url"];
+export type { FileTree };
+export declare const ResourceTypes: readonly ["vfs", "literal", "wordpress.org/themes", "wordpress.org/plugins", "url", "git:directory"];
 export type VFSReference = {
     /** Identifies the file resource as Virtual File System (VFS) */
     resource: 'vfs';
@@ -36,19 +37,41 @@ export type UrlReference = {
     /** Optional caption for displaying a progress message */
     caption?: string;
 };
-export type FileReference = VFSReference | LiteralReference | CoreThemeReference | CorePluginReference | UrlReference;
-export declare function isFileReference(ref: any): ref is FileReference;
-export interface ResourceOptions {
-    /** Optional semaphore to limit concurrent downloads */
-    semaphore?: Semaphore;
-    progress?: ProgressTracker;
+export type GitDirectoryReference = {
+    /** Identifies the file resource as a git directory */
+    resource: 'git:directory';
+    /** The URL of the git repository */
+    url: string;
+    /** The branch of the git repository */
+    ref: string;
+    /** The path to the directory in the git repository */
+    path: string;
+};
+export interface Directory {
+    files: FileTree;
+    name: string;
 }
-export declare abstract class Resource {
+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 DirectoryReference = GitDirectoryReference | DirectoryLiteralReference;
+export declare function isResourceReference(ref: any): ref is FileReference;
+export declare abstract class Resource<T extends File | Directory> {
     /** Optional progress tracker to monitor progress */
-    abstract progress?: ProgressTracker;
+    protected _progress?: ProgressTracker;
+    get progress(): ProgressTracker | undefined;
+    set progress(value: ProgressTracker | undefined);
     /** A Promise that resolves to the file contents */
-    protected promise?: Promise<File>;
+    protected promise?: Promise<T>;
     protected playground?: UniversalPHP;
+    setPlayground(playground: UniversalPHP): void;
+    abstract resolve(): Promise<T>;
+    /** The name of the referenced file */
+    abstract get name(): string;
+    /** Whether this Resource is loaded asynchronously */
+    get isAsync(): boolean;
     /**
      * Creates a new Resource based on the given file reference
      *
@@ -56,32 +79,43 @@ export declare abstract class Resource {
      * @param options Additional options for the Resource
      * @returns A new Resource instance
      */
-    static create(ref: FileReference, { semaphore, progress }: ResourceOptions): Resource;
-    setPlayground(playground: UniversalPHP): void;
-    /**
-     * Resolves the file contents
-     * @returns The resolved file.
-     */
-    abstract resolve(): Promise<File>;
-    /** The name of the referenced file */
-    abstract get name(): string;
-    /** Whether this Resource is loaded asynchronously */
+    static create(ref: FileReference | DirectoryReference, { semaphore, progress, corsProxy, }: {
+        /** Optional semaphore to limit concurrent downloads */
+        semaphore?: Semaphore;
+        progress?: ProgressTracker;
+        corsProxy?: string;
+    }): Resource<File | Directory>;
+}
+export declare abstract class ResourceDecorator<T extends File | Directory> extends Resource<T> {
+    protected resource: Resource<T>;
+    constructor(resource: Resource<T>);
+    /** @inheritDoc */
+    get progress(): ProgressTracker | undefined;
+    /** @inheritDoc */
+    set progress(value: ProgressTracker | undefined);
+    /** @inheritDoc */
+    abstract resolve(): Promise<T>;
+    /** @inheritDoc */
+    get name(): string;
+    /** @inheritDoc */
     get isAsync(): boolean;
+    /** @inheritDoc */
+    setPlayground(playground: UniversalPHP): void;
 }
 /**
  * A `Resource` that represents a file in the VFS (virtual file system) of the
  * playground.
  */
-export declare class VFSResource extends Resource {
+export declare class VFSResource extends Resource<File> {
     private resource;
-    progress?: ProgressTracker | undefined;
+    _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 | undefined);
     /** @inheritDoc */
     resolve(): Promise<File>;
     /** @inheritDoc */
@@ -90,15 +124,15 @@ export declare class VFSResource extends Resource {
 /**
  * A `Resource` that represents a literal file.
  */
-export declare class LiteralResource extends Resource {
+export declare class LiteralResource extends Resource<File> {
     private resource;
-    progress?: ProgressTracker | undefined;
+    _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 | undefined);
     /** @inheritDoc */
     resolve(): Promise<File>;
     /** @inheritDoc */
@@ -107,13 +141,13 @@ export declare class LiteralResource extends Resource {
 /**
  * A base class for `Resource`s that require fetching data from a remote URL.
  */
-export declare abstract class FetchResource extends Resource {
-    progress?: ProgressTracker | undefined;
+export declare abstract class FetchResource extends Resource<File> {
+    _progress?: ProgressTracker | undefined;
     /**
      * Creates a new instance of `FetchResource`.
      * @param progress The progress tracker.
      */
-    constructor(progress?: ProgressTracker | undefined);
+    constructor(_progress?: ProgressTracker | undefined);
     /** @inheritDoc */
     resolve(): Promise<File>;
     /**
@@ -147,6 +181,34 @@ export declare class UrlResource extends FetchResource {
     /** @inheritDoc */
     protected get caption(): string;
 }
+/**
+ * A `Resource` that represents a git directory.
+ */
+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);
+    resolve(): Promise<{
+        name: string;
+        files: Record<string, any>;
+    }>;
+    /** @inheritDoc */
+    get name(): string;
+}
+/**
+ * A `Resource` that represents a git directory.
+ */
+export declare class LiteralDirectoryResource extends Resource<Directory> {
+    private reference;
+    _progress?: ProgressTracker | undefined;
+    constructor(reference: DirectoryLiteralReference, _progress?: ProgressTracker | undefined);
+    resolve(): Promise<DirectoryLiteralReference>;
+    /** @inheritDoc */
+    get name(): string;
+}
 /**
  * A `Resource` that represents a WordPress core theme.
  */
@@ -173,41 +235,21 @@ export declare class CorePluginResource extends FetchResource {
  * Otherwise, appends ".latest-stable.zip".
  */
 export declare function toDirectoryZipName(rawInput: string): string;
-/**
- * A decorator for a resource that adds functionality such as progress tracking
- * and caching.
- */
-export declare class DecoratedResource<T extends Resource> extends Resource {
-    private resource;
-    constructor(resource: T);
-    /** @inheritDoc */
-    resolve(): Promise<File>;
-    /** @inheritDoc */
-    setPlayground(playground: UniversalPHP): Promise<void>;
-    /** @inheritDoc */
-    get progress(): ProgressTracker | undefined;
-    /** @inheritDoc */
-    set progress(value: ProgressTracker | undefined);
-    /** @inheritDoc */
-    get name(): string;
-    /** @inheritDoc */
-    get isAsync(): boolean;
-}
 /**
  * A decorator for a resource that adds caching functionality.
  */
-export declare class CachedResource<T extends Resource> extends DecoratedResource<T> {
-    protected promise?: Promise<File>;
+export declare class CachedResource<T extends File | Directory> extends ResourceDecorator<T> {
+    protected promise?: Promise<T>;
     /** @inheritDoc */
-    resolve(): Promise<File>;
+    resolve(): Promise<T>;
 }
 /**
  * A decorator for a resource that adds concurrency control functionality
  * through a semaphore.
  */
-export declare class SemaphoreResource<T extends Resource> extends DecoratedResource<T> {
+export declare class SemaphoreResource<T extends File | Directory> extends ResourceDecorator<T> {
     private readonly semaphore;
-    constructor(resource: T, semaphore: Semaphore);
+    constructor(resource: Resource<T>, semaphore: Semaphore);
     /** @inheritDoc */
-    resolve(): Promise<File>;
+    resolve(): Promise<T>;
 }

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

@@ -12,6 +12,8 @@ import { StepHandler } from '.';
  */
 export interface EnableMultisiteStep {
     step: 'enableMultisite';
+    /** wp-cli.phar path */
+    wpCliPath?: string;
 }
 /**
  * Defines the [Multisite](https://developer.wordpress.org/advanced-administration/multisite/create-network/) constants in a `wp-config.php` file.

package/lib/steps/handlers.d.ts

@@ -11,6 +11,7 @@ export { rm } from './rm';
 export { mkdir } from './mkdir';
 export { rmdir } from './rmdir';
 export { writeFile } from './write-file';
+export { writeFiles } from './write-files';
 export { defineSiteUrl } from './define-site-url';
 export { importWxr as importWxr } from './import-wxr';
 export { importThemeStarterContent as importThemeStarterContent } from './import-theme-starter-content';

package/lib/steps/index.d.ts

@@ -1,6 +1,6 @@
 import { ProgressTracker } from '@php-wasm/progress';
 import { UniversalPHP } from '@php-wasm/universal';
-import { FileReference } from '../resources';
+import { FileReference, DirectoryReference, Directory } from '../resources';
 import { ActivatePluginStep } from './activate-plugin';
 import { DefineSiteUrlStep } from './define-site-url';
 import { InstallPluginStep, InstallPluginOptions } from './install-plugin';
@@ -18,6 +18,7 @@ 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';
@@ -28,7 +29,7 @@ import { EnableMultisiteStep } from './enable-multisite';
 import { WPCLIStep } from './wp-cli';
 import { ResetDataStep } from './reset-data';
 import { SetSiteLanguageStep } from './set-site-language';
-export type Step = GenericStep<FileReference>;
+export type Step = GenericStep<FileReference, DirectoryReference>;
 export type StepDefinition = Step & {
     progress?: {
         weight?: number;
@@ -40,8 +41,8 @@ export { wpContentFilesExcludedFromExport } from '../utils/wp-content-files-excl
  * If you add a step here, make sure to also
  * add it to the exports below.
  */
-export type GenericStep<Resource> = ActivatePluginStep | ActivateThemeStep | CpStep | DefineWpConfigConstsStep | DefineSiteUrlStep | EnableMultisiteStep | ImportWxrStep<Resource> | ImportThemeStarterContentStep | ImportWordPressFilesStep<Resource> | InstallPluginStep<Resource> | InstallThemeStep<Resource> | LoginStep | MkdirStep | MvStep | ResetDataStep | RequestStep | RmStep | RmdirStep | RunPHPStep | RunPHPWithOptionsStep | RunWpInstallationWizardStep | RunSqlStep<Resource> | SetSiteOptionsStep | UnzipStep<Resource> | UpdateUserMetaStep | WriteFileStep<Resource> | WPCLIStep | SetSiteLanguageStep;
-export type { ActivatePluginStep, ActivateThemeStep, CpStep, DefineWpConfigConstsStep, DefineSiteUrlStep, EnableMultisiteStep, ImportWxrStep, ImportThemeStarterContentStep, ImportWordPressFilesStep, InstallPluginStep, InstallPluginOptions, InstallThemeStep, InstallThemeOptions, LoginStep, MkdirStep, MvStep, ResetDataStep, RequestStep, RmStep, RmdirStep, RunPHPStep, RunPHPWithOptionsStep, RunWpInstallationWizardStep, RunSqlStep, WordPressInstallationOptions, SetSiteOptionsStep, UnzipStep, UpdateUserMetaStep, WriteFileStep, WPCLIStep, SetSiteLanguageStep, };
+export type GenericStep<FileResource, DirectoryResource> = ActivatePluginStep | ActivateThemeStep | CpStep | DefineWpConfigConstsStep | DefineSiteUrlStep | EnableMultisiteStep | ImportWxrStep<FileResource> | ImportThemeStarterContentStep | ImportWordPressFilesStep<FileResource> | InstallPluginStep<FileResource, DirectoryResource> | InstallThemeStep<FileResource, DirectoryResource> | LoginStep | MkdirStep | MvStep | ResetDataStep | RequestStep | RmStep | RmdirStep | RunPHPStep | RunPHPWithOptionsStep | RunWpInstallationWizardStep | RunSqlStep<FileResource> | SetSiteOptionsStep | UnzipStep<FileResource> | UpdateUserMetaStep | WriteFileStep<FileResource> | WriteFilesStep<DirectoryResource> | WPCLIStep | SetSiteLanguageStep;
+export type { ActivatePluginStep, ActivateThemeStep, CpStep, DefineWpConfigConstsStep, DefineSiteUrlStep, EnableMultisiteStep, ImportWxrStep, ImportThemeStarterContentStep, ImportWordPressFilesStep, InstallPluginStep, InstallPluginOptions, InstallThemeStep, InstallThemeOptions, LoginStep, MkdirStep, MvStep, ResetDataStep, RequestStep, RmStep, RmdirStep, RunPHPStep, RunPHPWithOptionsStep, RunWpInstallationWizardStep, RunSqlStep, WordPressInstallationOptions, SetSiteOptionsStep, UnzipStep, UpdateUserMetaStep, WriteFileStep, WriteFilesStep, WPCLIStep, SetSiteLanguageStep, };
 /**
  * Progress reporting details.
  */
@@ -49,7 +50,7 @@ export type StepProgress = {
     tracker: ProgressTracker;
     initialCaption?: string;
 };
-export type StepHandler<S extends GenericStep<File>, Return = any> = (
+export type StepHandler<S extends GenericStep<File, Directory>, Return = any> = (
 /**
  * A PHP instance or Playground client.
  */

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

@@ -13,6 +13,10 @@ export interface InstallAssetOptions {
      * </code>
      */
     targetPath: string;
+    /**
+     * Target folder name to install the asset into.
+     */
+    targetFolderName?: string;
     /**
      * What to do if the asset already exists.
      */
@@ -21,7 +25,7 @@ export interface InstallAssetOptions {
 /**
  * Install asset: Extract folder from zip file and move it to target
  */
-export declare function installAsset(playground: UniversalPHP, { targetPath, zipFile, ifAlreadyInstalled, }: InstallAssetOptions): Promise<{
+export declare function installAsset(playground: UniversalPHP, { targetPath, zipFile, ifAlreadyInstalled, targetFolderName }: InstallAssetOptions): Promise<{
     assetFolderPath: string;
     assetFolderName: string;
 }>;

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

@@ -1,5 +1,6 @@
 import { StepHandler } from '.';
 import { InstallAssetOptions } from './install-asset';
+import { Directory } from '../resources';
 /**
  * @inheritDoc installPlugin
  * @hasRunnableExample
@@ -9,8 +10,8 @@ import { InstallAssetOptions } from './install-asset';
  *
  * <code>
  * {
- * 	    "step": "installPlugin",
- * 		"pluginZipFile": {
+ * 		"step": "installPlugin",
+ * 		"pluginData": {
  * 			"resource": "wordpress.org/plugins",
  * 			"slug": "gutenberg"
  * 		},
@@ -19,16 +20,38 @@ import { InstallAssetOptions } from './install-asset';
  * 		}
  * }
  * </code>
+ *
+ * @example
+ *
+ * <code>
+ * {
+ * 		"step": "installPlugin",
+ * 		"pluginData": {
+ * 			"resource": "git:directory",
+ * 			"url": "https://github.com/wordpress/wordpress-playground.git",
+ * 				"ref": "HEAD",
+ * 				"path": "wp-content/plugins/hello-dolly"
+ * 		},
+ * 		"options": {
+ * 			"activate": true
+ * 		}
+ * }
+ * </code>
  */
-export interface InstallPluginStep<ResourceType> extends Pick<InstallAssetOptions, 'ifAlreadyInstalled'> {
+export interface InstallPluginStep<FileResource, DirectoryResource> extends Pick<InstallAssetOptions, 'ifAlreadyInstalled'> {
     /**
      * The step identifier.
      */
     step: 'installPlugin';
     /**
-     * The plugin zip file to install.
+     * The plugin files to install. It can be either a plugin zip file, or a
+     * directory containing all the plugin files at its root.
      */
-    pluginZipFile: ResourceType;
+    pluginData: FileResource | DirectoryResource;
+    /**
+     * @deprecated. Use `pluginData` instead.
+     */
+    pluginZipFile?: FileResource;
     /**
      * Optional installation options.
      */
@@ -39,12 +62,16 @@ export interface InstallPluginOptions {
      * Whether to activate the plugin after installing it.
      */
     activate?: boolean;
+    /**
+     * The name of the folder to install the plugin to. Defaults to guessing from pluginData
+     */
+    targetFolderName?: string;
 }
 /**
  * Installs a WordPress plugin in the Playground.
  *
  * @param playground The playground client.
- * @param pluginZipFile The plugin zip file.
+ * @param pluginData The plugin zip file.
  * @param options Optional. Set `activate` to false if you don't want to activate the plugin.
  */
-export declare const installPlugin: StepHandler<InstallPluginStep<File>>;
+export declare const installPlugin: StepHandler<InstallPluginStep<File, Directory>>;

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

@@ -1,5 +1,6 @@
 import { StepHandler } from '.';
 import { InstallAssetOptions } from './install-asset';
+import { Directory } from '../resources';
 /**
  * @inheritDoc installTheme
  * @hasRunnableExample
@@ -9,7 +10,7 @@ import { InstallAssetOptions } from './install-asset';
  * <code>
  * {
  * 		"step": "installTheme",
- * 		"themeZipFile": {
+ * 		"themeData": {
  * 			"resource": "wordpress.org/themes",
  * 			"slug": "pendant"
  * 		},
@@ -20,34 +21,38 @@ import { InstallAssetOptions } from './install-asset';
  * }
  * </code>
  */
-export interface InstallThemeStep<ResourceType> extends Pick<InstallAssetOptions, 'ifAlreadyInstalled'> {
+export interface InstallThemeStep<FileResource, DirectoryResource> extends Pick<InstallAssetOptions, 'ifAlreadyInstalled'> {
     /**
      * The step identifier.
      */
     step: 'installTheme';
     /**
-     * The theme zip file to install.
+     * The theme files to install. It can be either a theme zip file, or a
+     * directory containing all the theme files at its root.
      */
-    themeZipFile: ResourceType;
+    themeData: FileResource | DirectoryResource;
+    /**
+     * @deprecated. Use `themeData` instead.
+     */
+    themeZipFile?: FileResource;
     /**
      * Optional installation options.
      */
-    options?: {
-        /**
-         * Whether to activate the theme after installing it.
-         */
-        activate?: boolean;
-        /**
-         * Whether to import the theme's starter content after installing it.
-         */
-        importStarterContent?: boolean;
-    };
+    options?: InstallThemeOptions;
 }
 export interface InstallThemeOptions {
     /**
      * Whether to activate the theme after installing it.
      */
     activate?: boolean;
+    /**
+     * Whether to import the theme's starter content after installing it.
+     */
+    importStarterContent?: boolean;
+    /**
+     * The name of the folder to install the theme to. Defaults to guessing from themeData
+     */
+    targetFolderName?: string;
 }
 /**
  * Installs a WordPress theme in the Playground.
@@ -56,4 +61,4 @@ export interface InstallThemeOptions {
  * @param themeZipFile The theme zip file.
  * @param options Optional. Set `activate` to false if you don't want to activate the theme.
  */
-export declare const installTheme: StepHandler<InstallThemeStep<File>>;
+export declare const installTheme: StepHandler<InstallThemeStep<File, Directory>>;

package/lib/steps/login.d.ts

@@ -8,7 +8,6 @@ import { StepHandler } from '.';
  * {
  * 	    "step": "login",
  * 		"username": "admin",
- * 		"password": "password"
  * }
  * </code>
  */
@@ -19,13 +18,16 @@ export type LoginStep = {
      */
     username?: string;
     /**
-     * The password to log in with. Defaults to 'password'.
+     * @deprecated The password field is deprecated and will be removed in a future version.
+     * Only the username field is required for user authentication.
      */
     password?: string;
 };
 /**
  * Logs in to Playground.
- * Under the hood, this function submits the [`wp-login.php`](https://developer.wordpress.org/reference/files/wp-login.php/) [form](https://developer.wordpress.org/reference/functions/wp_login_form/)
- * just like a user would.
+ * Under the hood, this function sets the `PLAYGROUND_AUTO_LOGIN_AS_USER` constant.
+ * The `0-auto-login.php` mu-plugin uses that constant to log in the user on the first load.
+ * This step depends on the `@wp-playground/wordpress` package because
+ * the plugin is located in and loaded automatically by the `@wp-playground/wordpress` package.
  */
 export declare const login: StepHandler<LoginStep>;

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

@@ -1,5 +1,9 @@
-import { PHPResponse } from '@php-wasm/universal';
+import { PHPResponse, UniversalPHP } from '@php-wasm/universal';
 import { StepHandler } from '.';
+import { 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>;
 /**
  * @inheritDoc wpCLI
  * @hasRunnableExample

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

@@ -13,12 +13,12 @@ import { StepHandler } from '.';
  * }
  * </code>
  */
-export interface WriteFileStep<ResourceType> {
+export interface WriteFileStep<FileResource> {
     step: 'writeFile';
     /** The path of the file to write to */
     path: string;
     /** The data to write */
-    data: ResourceType | string | Uint8Array;
+    data: FileResource | string | Uint8Array;
 }
 /**
  * Writes data to a file at the specified path.

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

@@ -0,0 +1,36 @@
+import { StepHandler } from '.';
+import { Directory } from '../resources';
+/**
+ * @inheritDoc writeFiles
+ * @hasRunnableExample
+ * @landingPage /test.php
+ * @example
+ *
+ * <code>
+ * {
+ * 		"step": "writeFiles",
+ * 		"writeToPath": "/wordpress/wp-content/plugins/my-plugin",
+ * 		"filesTree": {
+ * 			"name": "my-plugin",
+ * 			"files": {
+ * 				"index.php": "<?php echo '<a>Hello World!</a>'; ?>",
+ * 				"public": {
+ * 					"style.css": "a { color: red; }"
+ * 				}
+ * 			}
+ * 		}
+ * }
+ * </code>
+ */
+export interface WriteFilesStep<DirectoryResource> {
+    step: 'writeFiles';
+    /** The path of the file to write to */
+    writeToPath: string;
+    /** The data to write */
+    filesTree: DirectoryResource;
+}
+/**
+ * Writes multiple files to a specified directory in the Playground
+ * filesystem.
+ */
+export declare const writeFiles: StepHandler<WriteFilesStep<Directory>>;