@wp-playground/blueprints 0.6.13 → 0.6.15

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

@@ -1,15 +1,8 @@
 import { StepHandler } from '.';
 /**
- * @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';
@@ -19,6 +12,10 @@ 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
  */

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

@@ -13,11 +13,15 @@ export interface InstallAssetOptions {
      * </code>
      */
     targetPath: string;
+    /**
+     * What to do if the asset already exists.
+     */
+    ifAlreadyInstalled?: 'overwrite' | 'skip' | 'error';
 }
 /**
  * Install asset: Extract folder from zip file and move it to target
  */
-export declare function installAsset(playground: UniversalPHP, { targetPath, zipFile }: InstallAssetOptions): Promise<{
+export declare function installAsset(playground: UniversalPHP, { targetPath, zipFile, ifAlreadyInstalled, }: InstallAssetOptions): Promise<{
     assetFolderPath: string;
     assetFolderName: string;
 }>;

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

@@ -1,4 +1,5 @@
 import { StepHandler } from '.';
+import { InstallAssetOptions } from './install-asset';
 /**
  * @inheritDoc installPlugin
  * @hasRunnableExample
@@ -19,7 +20,7 @@ import { StepHandler } from '.';
  * }
  * </code>
  */
-export interface InstallPluginStep<ResourceType> {
+export interface InstallPluginStep<ResourceType> extends Pick<InstallAssetOptions, 'ifAlreadyInstalled'> {
     /**
      * The step identifier.
      */

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

@@ -1,4 +1,5 @@
 import { StepHandler } from '.';
+import { InstallAssetOptions } from './install-asset';
 /**
  * @inheritDoc installTheme
  * @hasRunnableExample
@@ -18,7 +19,7 @@ import { StepHandler } from '.';
  * }
  * </code>
  */
-export interface InstallThemeStep<ResourceType> {
+export interface InstallThemeStep<ResourceType> extends Pick<InstallAssetOptions, 'ifAlreadyInstalled'> {
     /**
      * The step identifier.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wp-playground/blueprints",
-	"version": "0.6.13",
+	"version": "0.6.15",
 	"exports": {
 		".": {
 			"import": "./index.js",
@@ -21,9 +21,9 @@
 		"access": "public",
 		"directory": "../../../dist/packages/playground/blueprints"
 	},
-	"gitHead": "68a91861e3f6abb26606c6ef4b162981d3619615",
+	"gitHead": "e05126da329a26535905b0ab65415d20118f0197",
 	"engines": {
-		"node": ">=18.18.2",
+		"node": ">=18.18.0",
 		"npm": ">=8.11.0"
 	}
 }