@wp-playground/blueprints 0.6.2 → 0.6.4

package/index.d.ts

@@ -303,7 +303,7 @@ export interface RequestHandler {
 	 * 	headers: {
 	 * 		'X-foo': 'bar',
 	 * 	},
-	 * 	formData: {
+	 * 	body: {
 	 * 		foo: 'bar',
 	 * 	},
 	 * });
@@ -612,18 +612,11 @@ export interface PHPRequest {
 	 */
 	headers?: PHPRequestHeaders;
 	/**
-	 * Uploaded files
+	 * Request body.
+	 * If an object is given, the request will be encoded as multipart
+	 * and sent with a `multipart/form-data` header.
 	 */
-	files?: Record<string, File>;
-	/**
-	 * Request body without the files.
-	 */
-	body?: string;
-	/**
-	 * Form data. If set, the request body will be ignored and
-	 * the content-type header will be set to `application/x-www-form-urlencoded`.
-	 */
-	formData?: Record<string, unknown>;
+	body?: string | Uint8Array | Record<string, string | Uint8Array | File>;
 }
 export interface PHPRunOptions {
 	/**
@@ -647,13 +640,13 @@ export interface PHPRunOptions {
 	 */
 	headers?: PHPRequestHeaders;
 	/**
-	 * Request body without the files.
+	 * Request body.
 	 */
-	body?: string;
+	body?: string | Uint8Array;
 	/**
-	 * Uploaded files.
+	 * Environment variables to set for this run.
 	 */
-	fileInfos?: FileInfo[];
+	env?: Record<string, string>;
 	/**
 	 * The code snippet to eval instead of a php file.
 	 */
@@ -664,12 +657,6 @@ export interface PHPRunOptions {
 	 */
 	throwOnError?: boolean;
 }
-export interface FileInfo {
-	key: string;
-	name: string;
-	type: string;
-	data: Uint8Array;
-}
 export interface RmDirOptions {
 	/**
 	 * If true, recursively removes the directory and all its contents.
@@ -1648,6 +1635,30 @@ export interface EnableMultisiteStep {
  * @param enableMultisite
  */
 export declare const enableMultisite: StepHandler<EnableMultisiteStep>;
+/**
+ * @inheritDoc wpCLI
+ * @hasRunnableExample
+ * @example
+ *
+ * <code>
+ * {
+ * 		"step": "wpCLI",
+ * 		"command": "wp post create --post_title='Test post' --post_excerpt='Some content'"
+ * }
+ * </code>
+ */
+export interface WPCLIStep {
+	/** The step identifier. */
+	step: "wp-cli";
+	/** The WP CLI command to run. */
+	command: string | string[];
+	/** wp-cli.phar path */
+	wpCliPath?: string;
+}
+/**
+ * Runs PHP code.
+ */
+export declare const wpCLI: StepHandler<WPCLIStep, Promise<PHPResponse>>;
 /**
  * Used by the export step to exclude the Playground-specific files
  * from the zip file. Keep it in sync with the list of files created
@@ -1665,7 +1676,7 @@ export type StepDefinition = Step & {
  * 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 | ImportFileStep<Resource> | ImportWordPressFilesStep<Resource> | InstallPluginStep<Resource> | InstallThemeStep<Resource> | LoginStep | MkdirStep | MvStep | RequestStep | RmStep | RmdirStep | RunPHPStep | RunPHPWithOptionsStep | RunWpInstallationWizardStep | RunSqlStep<Resource> | SetPhpIniEntryStep | SetSiteOptionsStep | UnzipStep<Resource> | UpdateUserMetaStep | WriteFileStep<Resource>;
+export type GenericStep<Resource> = ActivatePluginStep | ActivateThemeStep | CpStep | DefineWpConfigConstsStep | DefineSiteUrlStep | EnableMultisiteStep | ImportFileStep<Resource> | ImportWordPressFilesStep<Resource> | InstallPluginStep<Resource> | InstallThemeStep<Resource> | LoginStep | MkdirStep | MvStep | RequestStep | RmStep | RmdirStep | RunPHPStep | RunPHPWithOptionsStep | RunWpInstallationWizardStep | RunSqlStep<Resource> | SetPhpIniEntryStep | SetSiteOptionsStep | UnzipStep<Resource> | UpdateUserMetaStep | WriteFileStep<Resource> | WPCLIStep;
 /**
  * Progress reporting details.
  */