@wp-playground/blueprints 0.6.7 → 0.6.9

package/index.d.ts

@@ -187,6 +187,14 @@ declare class PHPResponse implements PHPResponseData {
 export interface PHPRequestEndEvent {
 	type: "request.end";
 }
+/**
+ * Represents an error event related to the PHP request.
+ */
+export interface PHPRequestErrorEvent {
+	type: "request.error";
+	error: Error;
+	source?: "request" | "php-wasm";
+}
 /**
  * Represents a PHP runtime initialization event.
  */
@@ -204,7 +212,7 @@ export interface PHPRuntimeBeforeDestroyEvent {
  * This is intentionally not an extension of CustomEvent
  * to make it isomorphic between different JavaScript runtimes.
  */
-export type PHPEvent = PHPRequestEndEvent | PHPRuntimeInitializedEvent | PHPRuntimeBeforeDestroyEvent;
+export type PHPEvent = PHPRequestEndEvent | PHPRequestErrorEvent | PHPRuntimeInitializedEvent | PHPRuntimeBeforeDestroyEvent;
 /**
  * A callback function that handles PHP events.
  */
@@ -651,11 +659,6 @@ export interface PHPRunOptions {
 	 * The code snippet to eval instead of a php file.
 	 */
 	code?: string;
-	/**
-	 * Whether to throw an error if the PHP process exits with a non-zero code
-	 * or outputs to stderr.
-	 */
-	throwOnError?: boolean;
 }
 export interface RmDirOptions {
 	/**
@@ -1490,8 +1493,7 @@ export declare const defineWpConfigConsts: StepHandler<DefineWpConfigConstsStep>
  * <code>
  * {
  * 		"step": "activateTheme",
- * 		"pluginName": "Storefront",
- * 		"pluginPath": "/wordpress/wp-content/themes/storefront"
+ * 		"themeFolderName": "storefront"
  * }
  * </code>
  */
@@ -1642,7 +1644,7 @@ export declare const enableMultisite: StepHandler<EnableMultisiteStep>;
  *
  * <code>
  * {
- * 		"step": "wpCLI",
+ * 		"step": "wp-cli",
  * 		"command": "wp post create --post_title='Test post' --post_excerpt='Some content'"
  * }
  * </code>
@@ -1729,8 +1731,31 @@ export interface Blueprint {
 	 * 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.
+	 *
+	 * @deprecated Use meta.description instead.
 	 */
 	description?: string;
+	/**
+	 * Optional metadata. Used by the Blueprints gallery at https://github.com/WordPress/blueprints
+	 */
+	meta?: {
+		/**
+		 * A clear and concise name for your Blueprint.
+		 */
+		title: string;
+		/**
+		 * A brief explanation of what your Blueprint offers.
+		 */
+		description?: string;
+		/**
+		 * A GitHub username of the author of this Blueprint.
+		 */
+		author: string;
+		/**
+		 * Relevant categories to help users find your Blueprint in the future Blueprints section on WordPress.org.
+		 */
+		categories?: string[];
+	};
 	/**
 	 * The preferred PHP and WordPress versions to use.
 	 */