@wp-playground/blueprints 0.9.45 → 1.0.0

package/blueprint-schema.json

@@ -138,11 +138,7 @@
 					"description": "User to log in as. If true, logs the user in as admin/password."
 				},
 				"phpExtensionBundles": {
-					"type": "array",
-					"items": {
-						"$ref": "#/definitions/SupportedPHPExtensionBundle"
-					},
-					"description": "The PHP extensions to use."
+					"deprecated": "No longer used. Feel free to remove it from your Blueprint."
 				},
 				"steps": {
 					"type": "array",
@@ -340,10 +336,6 @@
 			"required": ["resource", "url"],
 			"additionalProperties": false
 		},
-		"SupportedPHPExtensionBundle": {
-			"type": "string",
-			"enum": ["kitchen-sink", "light"]
-		},
 		"StepDefinition": {
 			"type": "object",
 			"discriminator": {
@@ -523,6 +515,10 @@
 						"step": {
 							"type": "string",
 							"const": "enableMultisite"
+						},
+						"wpCliPath": {
+							"type": "string",
+							"description": "wp-cli.phar path"
 						}
 					},
 					"required": ["step"]
@@ -639,16 +635,27 @@
 							"const": "installPlugin",
 							"description": "The step identifier."
 						},
+						"pluginData": {
+							"anyOf": [
+								{
+									"$ref": "#/definitions/FileReference"
+								},
+								{
+									"$ref": "#/definitions/DirectoryReference"
+								}
+							],
+							"description": "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": {
 							"$ref": "#/definitions/FileReference",
-							"description": "The plugin zip file to install."
+							"deprecated": ". Use `pluginData` instead."
 						},
 						"options": {
 							"$ref": "#/definitions/InstallPluginOptions",
 							"description": "Optional installation options."
 						}
 					},
-					"required": ["pluginZipFile", "step"]
+					"required": ["pluginData", "step"]
 				},
 				{
 					"type": "object",
@@ -676,27 +683,27 @@
 							"const": "installTheme",
 							"description": "The step identifier."
 						},
+						"themeData": {
+							"anyOf": [
+								{
+									"$ref": "#/definitions/FileReference"
+								},
+								{
+									"$ref": "#/definitions/DirectoryReference"
+								}
+							],
+							"description": "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": {
 							"$ref": "#/definitions/FileReference",
-							"description": "The theme zip file to install."
+							"deprecated": ". Use `themeData` instead."
 						},
 						"options": {
-							"type": "object",
-							"properties": {
-								"activate": {
-									"type": "boolean",
-									"description": "Whether to activate the theme after installing it."
-								},
-								"importStarterContent": {
-									"type": "boolean",
-									"description": "Whether to import the theme's starter content after installing it."
-								}
-							},
-							"additionalProperties": false,
+							"$ref": "#/definitions/InstallThemeOptions",
 							"description": "Optional installation options."
 						}
 					},
-					"required": ["step", "themeZipFile"]
+					"required": ["step", "themeData"]
 				},
 				{
 					"type": "object",
@@ -724,7 +731,7 @@
 						},
 						"password": {
 							"type": "string",
-							"description": "The password to log in with. Defaults to 'password'."
+							"deprecated": "The password field is deprecated and will be removed in a future version.\nOnly the username field is required for user authentication."
 						}
 					},
 					"required": ["step"]
@@ -1172,6 +1179,37 @@
 					},
 					"required": ["data", "path", "step"]
 				},
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"properties": {
+						"progress": {
+							"type": "object",
+							"properties": {
+								"weight": {
+									"type": "number"
+								},
+								"caption": {
+									"type": "string"
+								}
+							},
+							"additionalProperties": false
+						},
+						"step": {
+							"type": "string",
+							"const": "writeFiles"
+						},
+						"writeToPath": {
+							"type": "string",
+							"description": "The path of the file to write to"
+						},
+						"filesTree": {
+							"$ref": "#/definitions/DirectoryReference",
+							"description": "The data to write"
+						}
+					},
+					"required": ["filesTree", "step", "writeToPath"]
+				},
 				{
 					"type": "object",
 					"additionalProperties": false,
@@ -1243,12 +1281,100 @@
 				}
 			]
 		},
+		"DirectoryReference": {
+			"anyOf": [
+				{
+					"$ref": "#/definitions/GitDirectoryReference"
+				},
+				{
+					"$ref": "#/definitions/DirectoryLiteralReference"
+				}
+			]
+		},
+		"GitDirectoryReference": {
+			"type": "object",
+			"properties": {
+				"resource": {
+					"type": "string",
+					"const": "git:directory",
+					"description": "Identifies the file resource as a git directory"
+				},
+				"url": {
+					"type": "string",
+					"description": "The URL of the git repository"
+				},
+				"ref": {
+					"type": "string",
+					"description": "The branch of the git repository"
+				},
+				"path": {
+					"type": "string",
+					"description": "The path to the directory in the git repository"
+				}
+			},
+			"required": ["resource", "url", "ref", "path"],
+			"additionalProperties": false
+		},
+		"DirectoryLiteralReference": {
+			"type": "object",
+			"additionalProperties": false,
+			"properties": {
+				"resource": {
+					"type": "string",
+					"const": "literal:directory",
+					"description": "Identifies the file resource as a git directory"
+				},
+				"files": {
+					"$ref": "#/definitions/FileTree"
+				},
+				"name": {
+					"type": "string"
+				}
+			},
+			"required": ["files", "name", "resource"]
+		},
+		"FileTree": {
+			"type": "object",
+			"additionalProperties": {
+				"anyOf": [
+					{
+						"$ref": "#/definitions/FileTree"
+					},
+					{
+						"type": ["object", "string"]
+					}
+				]
+			},
+			"properties": {}
+		},
 		"InstallPluginOptions": {
 			"type": "object",
 			"properties": {
 				"activate": {
 					"type": "boolean",
 					"description": "Whether to activate the plugin after installing it."
+				},
+				"targetFolderName": {
+					"type": "string",
+					"description": "The name of the folder to install the plugin to. Defaults to guessing from pluginData"
+				}
+			},
+			"additionalProperties": false
+		},
+		"InstallThemeOptions": {
+			"type": "object",
+			"properties": {
+				"activate": {
+					"type": "boolean",
+					"description": "Whether to activate the theme after installing it."
+				},
+				"importStarterContent": {
+					"type": "boolean",
+					"description": "Whether to import the theme's starter content after installing it."
+				},
+				"targetFolderName": {
+					"type": "string",
+					"description": "The name of the folder to install the theme to. Defaults to guessing from themeData"
 				}
 			},
 			"additionalProperties": false