@wp-playground/client 0.6.13 → 0.6.15

package/index.d.ts

@@ -1172,16 +1172,9 @@ export interface ActivatePluginStep {
  */
 export declare const activatePlugin: StepHandler<ActivatePluginStep>;
 /**
- * @inheritDoc defineSiteUrl
- * @hasRunnableExample
- * @example
+ * Changes the site URL of the WordPress installation.
  *
- * <code>
- * {
- * 		"step": "defineSiteUrl",
- * 		"siteUrl": "https://playground.wordpress.net"
- * }
- * </code>
+ * @inheritDoc defineSiteUrl
  */
 export interface DefineSiteUrlStep {
 	step: "defineSiteUrl";
@@ -1191,10 +1184,33 @@ export interface DefineSiteUrlStep {
 /**
  * Sets WP_HOME and WP_SITEURL constants for the WordPress installation.
  *
+ * Beware: Using this step makes no sense on playground.wordpress.net.
+ * It is useful when you're building a custom Playground-based tool like wp-now,
+ * or deploying Playground on a custom domain.
+ *
  * @param playground The playground client.
  * @param siteUrl
  */
 export declare const defineSiteUrl: StepHandler<DefineSiteUrlStep>;
+export interface InstallAssetOptions {
+	/**
+	 * The zip file to install.
+	 */
+	zipFile: File;
+	/**
+	 * Target path to extract the main folder.
+	 * @example
+	 *
+	 * <code>
+	 * const targetPath = `${await playground.documentRoot}/wp-content/plugins`;
+	 * </code>
+	 */
+	targetPath: string;
+	/**
+	 * What to do if the asset already exists.
+	 */
+	ifAlreadyInstalled?: "overwrite" | "skip" | "error";
+}
 /**
  * @inheritDoc installPlugin
  * @hasRunnableExample
@@ -1215,7 +1231,7 @@ export declare const defineSiteUrl: StepHandler<DefineSiteUrlStep>;
  * }
  * </code>
  */
-export interface InstallPluginStep<ResourceType> {
+export interface InstallPluginStep<ResourceType> extends Pick<InstallAssetOptions, "ifAlreadyInstalled"> {
 	/**
 	 * The step identifier.
 	 */
@@ -1262,7 +1278,7 @@ export declare const installPlugin: StepHandler<InstallPluginStep<File>>;
  * }
  * </code>
  */
-export interface InstallThemeStep<ResourceType> {
+export interface InstallThemeStep<ResourceType> extends Pick<InstallAssetOptions, "ifAlreadyInstalled"> {
 	/**
 	 * The step identifier.
 	 */