@wp-playground/client 0.6.7 → 0.6.9

package/index.d.ts

@@ -201,6 +201,14 @@ export 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.
  */
@@ -218,7 +226,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.
  */
@@ -665,11 +673,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;
 }
 /**
  * Output of the PHP.wasm runtime.
@@ -724,6 +727,10 @@ export declare const SupportedPHPVersionsList: string[];
 export type SupportedPHPVersion = (typeof SupportedPHPVersions)[number];
 export type SupportedPHPExtension = "iconv" | "mbstring" | "xml-bundle" | "gd";
 export type SupportedPHPExtensionBundle = "kitchen-sink";
+export type RewriteRule = {
+	match: RegExp;
+	replacement: string;
+};
 export interface PHPRequestHandlerConfiguration {
 	/**
 	 * The directory in the PHP filesystem where the server will look
@@ -734,10 +741,15 @@ export interface PHPRequestHandlerConfiguration {
 	 * Request Handler URL. Used to populate $_SERVER details like HTTP_HOST.
 	 */
 	absoluteUrl?: string;
+	/**
+	 * Rewrite rules
+	 */
+	rewriteRules?: RewriteRule[];
 }
 /** @inheritDoc */
 export declare class PHPRequestHandler implements RequestHandler {
 	#private;
+	rewriteRules: RewriteRule[];
 	/**
 	 * The PHP instance
 	 */
@@ -1721,8 +1733,7 @@ export declare const defineWpConfigConsts: StepHandler<DefineWpConfigConstsStep>
  * <code>
  * {
  * 		"step": "activateTheme",
- * 		"pluginName": "Storefront",
- * 		"pluginPath": "/wordpress/wp-content/themes/storefront"
+ * 		"themeFolderName": "storefront"
  * }
  * </code>
  */
@@ -1873,7 +1884,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>
@@ -1960,8 +1971,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.
 	 */
@@ -2238,6 +2272,7 @@ declare class PlaygroundWorkerEndpoint extends WebPHPEndpoint {
 		all: {
 			nightly: string;
 			beta: string;
+			"6.5": string;
 			"6.4": string;
 			"6.3": string;
 			"6.2": string;
@@ -2311,6 +2346,14 @@ export interface StartPlaygroundOptions {
 	disableProgressBar?: boolean;
 	blueprint?: Blueprint;
 	onBlueprintStepCompleted?: OnStepCompleted;
+	/**
+	 * Called when the playground client is connected, but before the blueprint
+	 * steps are run.
+	 *
+	 * @param playground
+	 * @returns
+	 */
+	onClientConnected?: (playground: PlaygroundClient) => void;
 	/**
 	 * The SAPI name PHP will use.
 	 * @internal
@@ -2325,7 +2368,7 @@ export interface StartPlaygroundOptions {
  * @param options Options for loading the playground.
  * @returns A PlaygroundClient instance.
  */
-export declare function startPlaygroundWeb({ iframe, blueprint, remoteUrl, progressTracker, disableProgressBar, onBlueprintStepCompleted, sapiName, }: StartPlaygroundOptions): Promise<PlaygroundClient>;
+export declare function startPlaygroundWeb({ iframe, blueprint, remoteUrl, progressTracker, disableProgressBar, onBlueprintStepCompleted, onClientConnected, sapiName, }: StartPlaygroundOptions): Promise<PlaygroundClient>;
 /**
  * @deprecated Use `startPlayground` instead.
  *