@wp-playground/blueprints 0.3.1 → 0.5.2

package/blueprint-schema.json

@@ -9,6 +9,10 @@
 					"type": "string",
 					"description": "The URL to navigate to after the blueprint has been run."
 				},
+				"description": {
+					"type": "string",
+					"description": "Optional description. It doesn't do anything but is exposed as a courtesy to developers who may want to document which blueprint file does what."
+				},
 				"preferredVersions": {
 					"type": "object",
 					"properties": {
@@ -33,6 +37,74 @@
 					"additionalProperties": false,
 					"description": "The preferred PHP and WordPress versions to use."
 				},
+				"features": {
+					"type": "object",
+					"properties": {
+						"networking": {
+							"type": "boolean",
+							"description": "Should boot with support for network request via wp_safe_remote_get?"
+						}
+					},
+					"additionalProperties": false
+				},
+				"constants": {
+					"type": "object",
+					"additionalProperties": {
+						"type": "string"
+					},
+					"description": "PHP Constants to define on every request",
+					"deprecated": "This experimental option will change without warning.\nUse `steps` instead."
+				},
+				"plugins": {
+					"type": "array",
+					"items": {
+						"anyOf": [
+							{
+								"type": "string"
+							},
+							{
+								"$ref": "#/definitions/FileReference"
+							}
+						]
+					},
+					"description": "WordPress plugins to install and activate",
+					"deprecated": "This experimental option will change without warning.\nUse `steps` instead."
+				},
+				"siteOptions": {
+					"type": "object",
+					"additionalProperties": {
+						"type": "string"
+					},
+					"properties": {
+						"blogname": {
+							"type": "string",
+							"description": "The site title"
+						}
+					},
+					"description": "WordPress site options to define",
+					"deprecated": "This experimental option will change without warning.\nUse `steps` instead."
+				},
+				"login": {
+					"anyOf": [
+						{
+							"type": "boolean"
+						},
+						{
+							"type": "object",
+							"properties": {
+								"username": {
+									"type": "string"
+								},
+								"password": {
+									"type": "string"
+								}
+							},
+							"required": ["username", "password"],
+							"additionalProperties": false
+						}
+					],
+					"description": "User to log in as. If true, logs the user in as admin/password."
+				},
 				"phpExtensionBundles": {
 					"type": "array",
 					"items": {
@@ -62,7 +134,7 @@
 							}
 						]
 					},
-					"description": "The steps to run."
+					"description": "The steps to run after every other operation in this Blueprint was executed."
 				},
 				"$schema": {
 					"type": "string"
@@ -73,6 +145,7 @@
 		"SupportedPHPVersion": {
 			"type": "string",
 			"enum": [
+				"8.3",
 				"8.2",
 				"8.1",
 				"8.0",
@@ -80,10 +153,157 @@
 				"7.3",
 				"7.2",
 				"7.1",
-				"7.0",
-				"5.6"
+				"7.0"
 			]
 		},
+		"FileReference": {
+			"anyOf": [
+				{
+					"$ref": "#/definitions/VFSReference"
+				},
+				{
+					"$ref": "#/definitions/LiteralReference"
+				},
+				{
+					"$ref": "#/definitions/CoreThemeReference"
+				},
+				{
+					"$ref": "#/definitions/CorePluginReference"
+				},
+				{
+					"$ref": "#/definitions/UrlReference"
+				}
+			]
+		},
+		"VFSReference": {
+			"type": "object",
+			"properties": {
+				"resource": {
+					"type": "string",
+					"const": "vfs",
+					"description": "Identifies the file resource as Virtual File System (VFS)"
+				},
+				"path": {
+					"type": "string",
+					"description": "The path to the file in the VFS"
+				}
+			},
+			"required": ["resource", "path"],
+			"additionalProperties": false
+		},
+		"LiteralReference": {
+			"type": "object",
+			"properties": {
+				"resource": {
+					"type": "string",
+					"const": "literal",
+					"description": "Identifies the file resource as a literal file"
+				},
+				"name": {
+					"type": "string",
+					"description": "The name of the file"
+				},
+				"contents": {
+					"anyOf": [
+						{
+							"type": "string"
+						},
+						{
+							"type": "object",
+							"properties": {
+								"BYTES_PER_ELEMENT": {
+									"type": "number"
+								},
+								"buffer": {
+									"type": "object",
+									"properties": {
+										"byteLength": {
+											"type": "number"
+										}
+									},
+									"required": ["byteLength"],
+									"additionalProperties": false
+								},
+								"byteLength": {
+									"type": "number"
+								},
+								"byteOffset": {
+									"type": "number"
+								},
+								"length": {
+									"type": "number"
+								}
+							},
+							"required": [
+								"BYTES_PER_ELEMENT",
+								"buffer",
+								"byteLength",
+								"byteOffset",
+								"length"
+							],
+							"additionalProperties": {
+								"type": "number"
+							}
+						}
+					],
+					"description": "The contents of the file"
+				}
+			},
+			"required": ["resource", "name", "contents"],
+			"additionalProperties": false
+		},
+		"CoreThemeReference": {
+			"type": "object",
+			"properties": {
+				"resource": {
+					"type": "string",
+					"const": "wordpress.org/themes",
+					"description": "Identifies the file resource as a WordPress Core theme"
+				},
+				"slug": {
+					"type": "string",
+					"description": "The slug of the WordPress Core theme"
+				}
+			},
+			"required": ["resource", "slug"],
+			"additionalProperties": false
+		},
+		"CorePluginReference": {
+			"type": "object",
+			"properties": {
+				"resource": {
+					"type": "string",
+					"const": "wordpress.org/plugins",
+					"description": "Identifies the file resource as a WordPress Core plugin"
+				},
+				"slug": {
+					"type": "string",
+					"description": "The slug of the WordPress Core plugin"
+				}
+			},
+			"required": ["resource", "slug"],
+			"additionalProperties": false
+		},
+		"UrlReference": {
+			"type": "object",
+			"properties": {
+				"resource": {
+					"type": "string",
+					"const": "url",
+					"description": "Identifies the file resource as a URL"
+				},
+				"url": {
+					"type": "string",
+					"description": "The URL of the file"
+				},
+				"caption": {
+					"type": "string",
+					"description": "Optional caption for displaying a progress message"
+				}
+			},
+			"required": ["resource", "url"],
+			"additionalProperties": false
+		},
 		"SupportedPHPExtensionBundle": {
 			"type": "string",
 			"const": "kitchen-sink"
@@ -196,6 +416,9 @@
 						},
 						"prepareForRunningInsideWebBrowser": {
 							"type": "boolean"
+						},
+						"addFetchNetworkTransport": {
+							"type": "boolean"
 						}
 					},
 					"required": ["step"]
@@ -258,8 +481,7 @@
 						},
 						"virtualize": {
 							"type": "boolean",
-							"description": "Enables the virtualization of wp-config.php and playground-consts.json files, leaving the local system files untouched. The variables defined in the /vfs-blueprints/playground-consts.json file are loaded via the auto_prepend_file directive in the php.ini file.",
-							"default": false
+							"deprecated": "This option is noop and will be removed in a future version.\nThis option is only kept in here to avoid breaking Blueprint schema validation\nfor existing apps using this option."
 						}
 					},
 					"required": ["consts", "step"]
@@ -318,6 +540,37 @@
 					},
 					"required": ["file", "step"]
 				},
+				{
+					"type": "object",
+					"additionalProperties": false,
+					"properties": {
+						"progress": {
+							"type": "object",
+							"properties": {
+								"weight": {
+									"type": "number"
+								},
+								"caption": {
+									"type": "string"
+								}
+							},
+							"additionalProperties": false
+						},
+						"step": {
+							"type": "string",
+							"const": "importWordPressFiles"
+						},
+						"wordPressFilesZip": {
+							"$ref": "#/definitions/FileReference",
+							"description": "The zip file containing the top-level WordPress files and directories."
+						},
+						"pathInZip": {
+							"type": "string",
+							"description": "The path inside the zip file where the WordPress files are."
+						}
+					},
+					"required": ["step", "wordPressFilesZip"]
+				},
 				{
 					"type": "object",
 					"additionalProperties": false,
@@ -523,14 +776,14 @@
 						},
 						"step": {
 							"type": "string",
-							"const": "replaceSite"
+							"const": "rm"
 						},
-						"fullSiteZip": {
-							"$ref": "#/definitions/FileReference",
-							"description": "The zip file containing the new WordPress site"
+						"path": {
+							"type": "string",
+							"description": "The path to remove"
 						}
 					},
-					"required": ["fullSiteZip", "step"]
+					"required": ["path", "step"]
 				},
 				{
 					"type": "object",
@@ -550,7 +803,7 @@
 						},
 						"step": {
 							"type": "string",
-							"const": "rm"
+							"const": "rmdir"
 						},
 						"path": {
 							"type": "string",
@@ -577,14 +830,15 @@
 						},
 						"step": {
 							"type": "string",
-							"const": "rmdir"
+							"const": "runPHP",
+							"description": "The step identifier."
 						},
-						"path": {
+						"code": {
 							"type": "string",
-							"description": "The path to remove"
+							"description": "The PHP code to run."
 						}
 					},
-					"required": ["path", "step"]
+					"required": ["code", "step"]
 				},
 				{
 					"type": "object",
@@ -604,15 +858,14 @@
 						},
 						"step": {
 							"type": "string",
-							"const": "runPHP",
-							"description": "The step identifier."
+							"const": "runPHPWithOptions"
 						},
-						"code": {
-							"type": "string",
-							"description": "The PHP code to run."
+						"options": {
+							"$ref": "#/definitions/PHPRunOptions",
+							"description": "Run options (See /wordpress-playground/api/universal/interface/PHPRunOptions)"
 						}
 					},
-					"required": ["code", "step"]
+					"required": ["options", "step"]
 				},
 				{
 					"type": "object",
@@ -632,11 +885,10 @@
 						},
 						"step": {
 							"type": "string",
-							"const": "runPHPWithOptions"
+							"const": "runWpInstallationWizard"
 						},
 						"options": {
-							"$ref": "#/definitions/PHPRunOptions",
-							"description": "Run options (See /wordpress-playground/api/universal/interface/PHPRunOptions)"
+							"$ref": "#/definitions/WordPressInstallationOptions"
 						}
 					},
 					"required": ["options", "step"]
@@ -659,13 +911,15 @@
 						},
 						"step": {
 							"type": "string",
-							"const": "runWpInstallationWizard"
+							"const": "runSql",
+							"description": "The step identifier."
 						},
-						"options": {
-							"$ref": "#/definitions/WordPressInstallationOptions"
+						"sql": {
+							"$ref": "#/definitions/FileReference",
+							"description": "The SQL to run. Each non-empty line must contain a valid SQL query."
 						}
 					},
-					"required": ["options", "step"]
+					"required": ["sql", "step"]
 				},
 				{
 					"type": "object",
@@ -867,154 +1121,6 @@
 				}
 			]
 		},
-		"FileReference": {
-			"anyOf": [
-				{
-					"$ref": "#/definitions/VFSReference"
-				},
-				{
-					"$ref": "#/definitions/LiteralReference"
-				},
-				{
-					"$ref": "#/definitions/CoreThemeReference"
-				},
-				{
-					"$ref": "#/definitions/CorePluginReference"
-				},
-				{
-					"$ref": "#/definitions/UrlReference"
-				}
-			]
-		},
-		"VFSReference": {
-			"type": "object",
-			"properties": {
-				"resource": {
-					"type": "string",
-					"const": "vfs",
-					"description": "Identifies the file resource as Virtual File System (VFS)"
-				},
-				"path": {
-					"type": "string",
-					"description": "The path to the file in the VFS"
-				}
-			},
-			"required": ["resource", "path"],
-			"additionalProperties": false
-		},
-		"LiteralReference": {
-			"type": "object",
-			"properties": {
-				"resource": {
-					"type": "string",
-					"const": "literal",
-					"description": "Identifies the file resource as a literal file"
-				},
-				"name": {
-					"type": "string",
-					"description": "The name of the file"
-				},
-				"contents": {
-					"anyOf": [
-						{
-							"type": "string"
-						},
-						{
-							"type": "object",
-							"properties": {
-								"BYTES_PER_ELEMENT": {
-									"type": "number"
-								},
-								"buffer": {
-									"type": "object",
-									"properties": {
-										"byteLength": {
-											"type": "number"
-										}
-									},
-									"required": ["byteLength"],
-									"additionalProperties": false
-								},
-								"byteLength": {
-									"type": "number"
-								},
-								"byteOffset": {
-									"type": "number"
-								},
-								"length": {
-									"type": "number"
-								}
-							},
-							"required": [
-								"BYTES_PER_ELEMENT",
-								"buffer",
-								"byteLength",
-								"byteOffset",
-								"length"
-							],
-							"additionalProperties": {
-								"type": "number"
-							}
-						}
-					],
-					"description": "The contents of the file"
-				}
-			},
-			"required": ["resource", "name", "contents"],
-			"additionalProperties": false
-		},
-		"CoreThemeReference": {
-			"type": "object",
-			"properties": {
-				"resource": {
-					"type": "string",
-					"const": "wordpress.org/themes",
-					"description": "Identifies the file resource as a WordPress Core theme"
-				},
-				"slug": {
-					"type": "string",
-					"description": "The slug of the WordPress Core theme"
-				}
-			},
-			"required": ["resource", "slug"],
-			"additionalProperties": false
-		},
-		"CorePluginReference": {
-			"type": "object",
-			"properties": {
-				"resource": {
-					"type": "string",
-					"const": "wordpress.org/plugins",
-					"description": "Identifies the file resource as a WordPress Core plugin"
-				},
-				"slug": {
-					"type": "string",
-					"description": "The slug of the WordPress Core plugin"
-				}
-			},
-			"required": ["resource", "slug"],
-			"additionalProperties": false
-		},
-		"UrlReference": {
-			"type": "object",
-			"properties": {
-				"resource": {
-					"type": "string",
-					"const": "url",
-					"description": "Identifies the file resource as a URL"
-				},
-				"url": {
-					"type": "string",
-					"description": "The URL of the file"
-				},
-				"caption": {
-					"type": "string",
-					"description": "Optional caption for displaying a progress message"
-				}
-			},
-			"required": ["resource", "url"],
-			"additionalProperties": false
-		},
 		"InstallPluginOptions": {
 			"type": "object",
 			"properties": {