@wp-playground/blueprints 1.0.28 → 1.1.0

package/blueprint-schema-validator.js

@@ -3,9 +3,9 @@ export const validate = validate10;
 export default validate10;
 const schema11 = {
 	$schema: 'http://json-schema.org/schema',
-	$ref: '#/definitions/Blueprint',
+	$ref: '#/definitions/BlueprintDeclaration',
 	definitions: {
-		Blueprint: {
+		BlueprintDeclaration: {
 			type: 'object',
 			properties: {
 				landingPage: {
@@ -150,21 +150,12 @@ const schema11 = {
 				$schema: { type: 'string' },
 			},
 			additionalProperties: false,
+			description:
+				'The Blueprint declaration, typically stored in a blueprint.json file.',
 		},
 		SupportedPHPVersion: {
 			type: 'string',
-			enum: [
-				'8.4',
-				'8.3',
-				'8.2',
-				'8.1',
-				'8.0',
-				'7.4',
-				'7.3',
-				'7.2',
-				'7.1',
-				'7.0',
-			],
+			enum: ['8.4', '8.3', '8.2', '8.1', '8.0', '7.4', '7.3', '7.2'],
 		},
 		ExtraLibrary: { type: 'string', const: 'wp-cli' },
 		PHPConstants: {
@@ -178,6 +169,7 @@ const schema11 = {
 				{ $ref: '#/definitions/CoreThemeReference' },
 				{ $ref: '#/definitions/CorePluginReference' },
 				{ $ref: '#/definitions/UrlReference' },
+				{ $ref: '#/definitions/BundledReference' },
 			],
 		},
 		VFSReference: {
@@ -294,6 +286,23 @@ const schema11 = {
 			required: ['resource', 'url'],
 			additionalProperties: false,
 		},
+		BundledReference: {
+			type: 'object',
+			properties: {
+				resource: {
+					type: 'string',
+					const: 'bundled',
+					description:
+						'Identifies the file resource as a Blueprint file',
+				},
+				path: {
+					type: 'string',
+					description: 'The path to the file in the Blueprint',
+				},
+			},
+			required: ['resource', 'path'],
+			additionalProperties: false,
+		},
 		StepDefinition: {
 			type: 'object',
 			discriminator: { propertyName: 'step' },
@@ -547,7 +556,7 @@ const schema11 = {
 						},
 						pluginZipFile: {
 							$ref: '#/definitions/FileReference',
-							deprecated: '. Use `pluginData` instead.',
+							deprecated: ". Use 'pluginData' instead.",
 						},
 						options: {
 							$ref: '#/definitions/InstallPluginOptions',
@@ -589,7 +598,7 @@ const schema11 = {
 						},
 						themeZipFile: {
 							$ref: '#/definitions/FileReference',
-							deprecated: '. Use `themeData` instead.',
+							deprecated: ". Use 'themeData' instead.",
 						},
 						options: {
 							$ref: '#/definitions/InstallThemeOptions',
@@ -984,7 +993,8 @@ const schema11 = {
 						},
 						filesTree: {
 							$ref: '#/definitions/DirectoryReference',
-							description: 'The data to write',
+							description:
+								"The 'filesTree' defines the directory structure, supporting 'literal:directory' or 'git:directory' types. The 'name' represents the root directory, while 'files' is an object where keys are file paths, and values contain either file content as a string or nested objects for subdirectories.",
 						},
 					},
 					required: ['filesTree', 'step', 'writeToPath'],
@@ -1473,21 +1483,12 @@ const schema12 = {
 		$schema: { type: 'string' },
 	},
 	additionalProperties: false,
+	description:
+		'The Blueprint declaration, typically stored in a blueprint.json file.',
 };
 const schema13 = {
 	type: 'string',
-	enum: [
-		'8.4',
-		'8.3',
-		'8.2',
-		'8.1',
-		'8.0',
-		'7.4',
-		'7.3',
-		'7.2',
-		'7.1',
-		'7.0',
-	],
+	enum: ['8.4', '8.3', '8.2', '8.1', '8.0', '7.4', '7.3', '7.2'],
 };
 const schema14 = { type: 'string', const: 'wp-cli' };
 const schema15 = {
@@ -1502,6 +1503,7 @@ const schema16 = {
 		{ $ref: '#/definitions/CoreThemeReference' },
 		{ $ref: '#/definitions/CorePluginReference' },
 		{ $ref: '#/definitions/UrlReference' },
+		{ $ref: '#/definitions/BundledReference' },
 	],
 };
 const schema17 = {
@@ -1614,6 +1616,22 @@ const schema21 = {
 	required: ['resource', 'url'],
 	additionalProperties: false,
 };
+const schema22 = {
+	type: 'object',
+	properties: {
+		resource: {
+			type: 'string',
+			const: 'bundled',
+			description: 'Identifies the file resource as a Blueprint file',
+		},
+		path: {
+			type: 'string',
+			description: 'The path to the file in the Blueprint',
+		},
+	},
+	required: ['resource', 'path'],
+	additionalProperties: false,
+};
 function validate12(
 	data,
 	{ instancePath = '', parentData, parentDataProperty, rootData = data } = {}
@@ -2976,12 +2994,176 @@ function validate12(
 					}
 					var _valid0 = _errs55 === errors;
 					valid0 = valid0 || _valid0;
+					if (!valid0) {
+						const _errs65 = errors;
+						const _errs66 = errors;
+						if (errors === _errs66) {
+							if (
+								data &&
+								typeof data == 'object' &&
+								!Array.isArray(data)
+							) {
+								let missing7;
+								if (
+									(data.resource === undefined &&
+										(missing7 = 'resource')) ||
+									(data.path === undefined &&
+										(missing7 = 'path'))
+								) {
+									const err44 = {
+										instancePath,
+										schemaPath:
+											'#/definitions/BundledReference/required',
+										keyword: 'required',
+										params: { missingProperty: missing7 },
+										message:
+											"must have required property '" +
+											missing7 +
+											"'",
+									};
+									if (vErrors === null) {
+										vErrors = [err44];
+									} else {
+										vErrors.push(err44);
+									}
+									errors++;
+								} else {
+									const _errs68 = errors;
+									for (const key7 in data) {
+										if (
+											!(
+												key7 === 'resource' ||
+												key7 === 'path'
+											)
+										) {
+											const err45 = {
+												instancePath,
+												schemaPath:
+													'#/definitions/BundledReference/additionalProperties',
+												keyword: 'additionalProperties',
+												params: {
+													additionalProperty: key7,
+												},
+												message:
+													'must NOT have additional properties',
+											};
+											if (vErrors === null) {
+												vErrors = [err45];
+											} else {
+												vErrors.push(err45);
+											}
+											errors++;
+											break;
+										}
+									}
+									if (_errs68 === errors) {
+										if (data.resource !== undefined) {
+											let data19 = data.resource;
+											const _errs69 = errors;
+											if (typeof data19 !== 'string') {
+												const err46 = {
+													instancePath:
+														instancePath +
+														'/resource',
+													schemaPath:
+														'#/definitions/BundledReference/properties/resource/type',
+													keyword: 'type',
+													params: { type: 'string' },
+													message: 'must be string',
+												};
+												if (vErrors === null) {
+													vErrors = [err46];
+												} else {
+													vErrors.push(err46);
+												}
+												errors++;
+											}
+											if ('bundled' !== data19) {
+												const err47 = {
+													instancePath:
+														instancePath +
+														'/resource',
+													schemaPath:
+														'#/definitions/BundledReference/properties/resource/const',
+													keyword: 'const',
+													params: {
+														allowedValue: 'bundled',
+													},
+													message:
+														'must be equal to constant',
+												};
+												if (vErrors === null) {
+													vErrors = [err47];
+												} else {
+													vErrors.push(err47);
+												}
+												errors++;
+											}
+											var valid16 = _errs69 === errors;
+										} else {
+											var valid16 = true;
+										}
+										if (valid16) {
+											if (data.path !== undefined) {
+												const _errs71 = errors;
+												if (
+													typeof data.path !==
+													'string'
+												) {
+													const err48 = {
+														instancePath:
+															instancePath +
+															'/path',
+														schemaPath:
+															'#/definitions/BundledReference/properties/path/type',
+														keyword: 'type',
+														params: {
+															type: 'string',
+														},
+														message:
+															'must be string',
+													};
+													if (vErrors === null) {
+														vErrors = [err48];
+													} else {
+														vErrors.push(err48);
+													}
+													errors++;
+												}
+												var valid16 =
+													_errs71 === errors;
+											} else {
+												var valid16 = true;
+											}
+										}
+									}
+								}
+							} else {
+								const err49 = {
+									instancePath,
+									schemaPath:
+										'#/definitions/BundledReference/type',
+									keyword: 'type',
+									params: { type: 'object' },
+									message: 'must be object',
+								};
+								if (vErrors === null) {
+									vErrors = [err49];
+								} else {
+									vErrors.push(err49);
+								}
+								errors++;
+							}
+						}
+						var _valid0 = _errs65 === errors;
+						valid0 = valid0 || _valid0;
+					}
 				}
 			}
 		}
 	}
 	if (!valid0) {
-		const err44 = {
+		const err50 = {
 			instancePath,
 			schemaPath: '#/anyOf',
 			keyword: 'anyOf',
@@ -2989,9 +3171,9 @@ function validate12(
 			message: 'must match a schema in anyOf',
 		};
 		if (vErrors === null) {
-			vErrors = [err44];
+			vErrors = [err50];
 		} else {
-			vErrors.push(err44);
+			vErrors.push(err50);
 		}
 		errors++;
 		validate12.errors = vErrors;
@@ -3009,7 +3191,7 @@ function validate12(
 	validate12.errors = vErrors;
 	return errors === 0;
 }
-const schema22 = {
+const schema23 = {
 	type: 'object',
 	discriminator: { propertyName: 'step' },
 	required: ['step'],
@@ -3255,7 +3437,7 @@ const schema22 = {
 				},
 				pluginZipFile: {
 					$ref: '#/definitions/FileReference',
-					deprecated: '. Use `pluginData` instead.',
+					deprecated: ". Use 'pluginData' instead.",
 				},
 				options: {
 					$ref: '#/definitions/InstallPluginOptions',
@@ -3296,7 +3478,7 @@ const schema22 = {
 				},
 				themeZipFile: {
 					$ref: '#/definitions/FileReference',
-					deprecated: '. Use `themeData` instead.',
+					deprecated: ". Use 'themeData' instead.",
 				},
 				options: {
 					$ref: '#/definitions/InstallThemeOptions',
@@ -3672,7 +3854,8 @@ const schema22 = {
 				},
 				filesTree: {
 					$ref: '#/definitions/DirectoryReference',
-					description: 'The data to write',
+					description:
+						"The 'filesTree' defines the directory structure, supporting 'literal:directory' or 'git:directory' types. The 'name' represents the root directory, while 'files' is an object where keys are file paths, and values contain either file content as a string or nested objects for subdirectories.",
 				},
 			},
 			required: ['filesTree', 'step', 'writeToPath'],
@@ -3727,7 +3910,7 @@ const schema22 = {
 		},
 	],
 };
-const schema27 = {
+const schema28 = {
 	type: 'object',
 	properties: {
 		activate: {
@@ -3742,7 +3925,7 @@ const schema27 = {
 	},
 	additionalProperties: false,
 };
-const schema28 = {
+const schema29 = {
 	type: 'object',
 	properties: {
 		activate: {
@@ -3762,7 +3945,7 @@ const schema28 = {
 	},
 	additionalProperties: false,
 };
-const schema35 = {
+const schema36 = {
 	type: 'object',
 	properties: {
 		adminUsername: { type: 'string' },
@@ -3770,13 +3953,13 @@ const schema35 = {
 	},
 	additionalProperties: false,
 };
-const schema23 = {
+const schema24 = {
 	anyOf: [
 		{ $ref: '#/definitions/GitDirectoryReference' },
 		{ $ref: '#/definitions/DirectoryLiteralReference' },
 	],
 };
-const schema24 = {
+const schema25 = {
 	type: 'object',
 	properties: {
 		resource: {
@@ -3797,7 +3980,7 @@ const schema24 = {
 	required: ['resource', 'url', 'ref', 'path'],
 	additionalProperties: false,
 };
-const schema25 = {
+const schema26 = {
 	type: 'object',
 	additionalProperties: false,
 	properties: {
@@ -3811,7 +3994,7 @@ const schema25 = {
 	},
 	required: ['files', 'name', 'resource'],
 };
-const schema26 = {
+const schema27 = {
 	type: 'object',
 	additionalProperties: {
 		anyOf: [
@@ -3873,7 +4056,7 @@ function validate20(
 							schemaPath: '#/additionalProperties/anyOf/1/type',
 							keyword: 'type',
 							params: {
-								type: schema26.additionalProperties.anyOf[1]
+								type: schema27.additionalProperties.anyOf[1]
 									.type,
 							},
 							message: 'must be object,string',
@@ -4323,7 +4506,7 @@ function validate18(
 	validate18.errors = vErrors;
 	return errors === 0;
 }
-const schema29 = {
+const schema30 = {
 	type: 'object',
 	properties: {
 		method: {
@@ -4420,11 +4603,11 @@ const schema29 = {
 	required: ['url'],
 	additionalProperties: false,
 };
-const schema30 = {
+const schema31 = {
 	type: 'string',
 	enum: ['GET', 'POST', 'HEAD', 'OPTIONS', 'PATCH', 'PUT', 'DELETE'],
 };
-const schema31 = { type: 'object', additionalProperties: { type: 'string' } };
+const schema32 = { type: 'object', additionalProperties: { type: 'string' } };
 function validate28(
 	data,
 	{ instancePath = '', parentData, parentDataProperty, rootData = data } = {}
@@ -4502,7 +4685,7 @@ function validate28(
 									instancePath: instancePath + '/method',
 									schemaPath: '#/definitions/HTTPMethod/enum',
 									keyword: 'enum',
-									params: { allowedValues: schema30.enum },
+									params: { allowedValues: schema31.enum },
 									message:
 										'must be equal to one of the allowed values',
 								},
@@ -6606,7 +6789,7 @@ function validate28(
 	validate28.errors = vErrors;
 	return errors === 0;
 }
-const schema32 = {
+const schema33 = {
 	type: 'object',
 	properties: {
 		relativeUri: {
@@ -6682,7 +6865,7 @@ function validate30(
 		if (data && typeof data == 'object' && !Array.isArray(data)) {
 			const _errs1 = errors;
 			for (const key0 in data) {
-				if (!func2.call(schema32.properties, key0)) {
+				if (!func2.call(schema33.properties, key0)) {
 					validate30.errors = [
 						{
 							instancePath,
@@ -6792,7 +6975,7 @@ function validate30(
 												'#/definitions/HTTPMethod/enum',
 											keyword: 'enum',
 											params: {
-												allowedValues: schema30.enum,
+												allowedValues: schema31.enum,
 											},
 											message:
 												'must be equal to one of the allowed values',
@@ -9068,7 +9251,7 @@ function validate14(
 																			'enum',
 																		params: {
 																			allowedValues:
-																				schema22
+																				schema23
 																					.oneOf[3]
 																					.properties
 																					.method
@@ -10076,7 +10259,7 @@ function validate14(
 																			'enum',
 																		params: {
 																			allowedValues:
-																				schema22
+																				schema23
 																					.oneOf[6]
 																					.properties
 																					.importer
@@ -11011,7 +11194,7 @@ function validate14(
 															keyword: 'enum',
 															params: {
 																allowedValues:
-																	schema22
+																	schema23
 																		.oneOf[9]
 																		.properties
 																		.ifAlreadyInstalled
@@ -11677,7 +11860,7 @@ function validate14(
 															keyword: 'enum',
 															params: {
 																allowedValues:
-																	schema22
+																	schema23
 																		.oneOf[10]
 																		.properties
 																		.ifAlreadyInstalled
@@ -19338,9 +19521,7 @@ function validate11(
 															data9 === '8.0' ||
 															data9 === '7.4' ||
 															data9 === '7.3' ||
-															data9 === '7.2' ||
-															data9 === '7.1' ||
-															data9 === '7.0'
+															data9 === '7.2'
 														)
 													) {
 														const err1 = {

package/blueprint-schema.json

@@ -1,8 +1,8 @@
 {
 	"$schema": "http://json-schema.org/schema",
-	"$ref": "#/definitions/Blueprint",
+	"$ref": "#/definitions/BlueprintDeclaration",
 	"definitions": {
-		"Blueprint": {
+		"BlueprintDeclaration": {
 			"type": "object",
 			"properties": {
 				"landingPage": {
@@ -165,22 +165,12 @@
 					"type": "string"
 				}
 			},
-			"additionalProperties": false
+			"additionalProperties": false,
+			"description": "The Blueprint declaration, typically stored in a blueprint.json file."
 		},
 		"SupportedPHPVersion": {
 			"type": "string",
-			"enum": [
-				"8.4",
-				"8.3",
-				"8.2",
-				"8.1",
-				"8.0",
-				"7.4",
-				"7.3",
-				"7.2",
-				"7.1",
-				"7.0"
-			]
+			"enum": ["8.4", "8.3", "8.2", "8.1", "8.0", "7.4", "7.3", "7.2"]
 		},
 		"ExtraLibrary": {
 			"type": "string",
@@ -208,6 +198,9 @@
 				},
 				{
 					"$ref": "#/definitions/UrlReference"
+				},
+				{
+					"$ref": "#/definitions/BundledReference"
 				}
 			]
 		},
@@ -340,6 +333,22 @@
 			"required": ["resource", "url"],
 			"additionalProperties": false
 		},
+		"BundledReference": {
+			"type": "object",
+			"properties": {
+				"resource": {
+					"type": "string",
+					"const": "bundled",
+					"description": "Identifies the file resource as a Blueprint file"
+				},
+				"path": {
+					"type": "string",
+					"description": "The path to the file in the Blueprint"
+				}
+			},
+			"required": ["resource", "path"],
+			"additionalProperties": false
+		},
 		"StepDefinition": {
 			"type": "object",
 			"discriminator": {
@@ -658,7 +667,7 @@
 						},
 						"pluginZipFile": {
 							"$ref": "#/definitions/FileReference",
-							"deprecated": ". Use `pluginData` instead."
+							"deprecated": ". Use 'pluginData' instead."
 						},
 						"options": {
 							"$ref": "#/definitions/InstallPluginOptions",
@@ -706,7 +715,7 @@
 						},
 						"themeZipFile": {
 							"$ref": "#/definitions/FileReference",
-							"deprecated": ". Use `themeData` instead."
+							"deprecated": ". Use 'themeData' instead."
 						},
 						"options": {
 							"$ref": "#/definitions/InstallThemeOptions",
@@ -1215,7 +1224,7 @@
 						},
 						"filesTree": {
 							"$ref": "#/definitions/DirectoryReference",
-							"description": "The data to write"
+							"description": "The 'filesTree' defines the directory structure, supporting 'literal:directory' or 'git:directory' types. The 'name' represents the root directory, while 'files' is an object where keys are file paths, and values contain either file content as a string or nested objects for subdirectories."
 						}
 					},
 					"required": ["filesTree", "step", "writeToPath"]