@wp-playground/client 0.6.8 → 0.6.10

package/index.d.ts

@@ -207,6 +207,7 @@ export interface PHPRequestEndEvent {
 export interface PHPRequestErrorEvent {
 	type: "request.error";
 	error: Error;
+	source?: "request" | "php-wasm";
 }
 /**
  * Represents a PHP runtime initialization event.
@@ -672,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.
@@ -730,7 +726,7 @@ export declare const LatestSupportedPHPVersion: "8.3";
 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 SupportedPHPExtensionBundle = "kitchen-sink" | "light";
 export type RewriteRule = {
 	match: RegExp;
 	replacement: string;
@@ -1831,33 +1827,31 @@ export interface ImportWordPressFilesStep<ResourceType> {
  */
 export declare const importWordPressFiles: StepHandler<ImportWordPressFilesStep<File>>;
 /**
- * @inheritDoc importFile
+ * @inheritDoc importWxr
  * @example
  *
  * <code>
  * {
- * 		"step": "importFile",
+ * 		"step": "importWxr",
  * 		"file": {
  * 			"resource": "url",
- * 			"url": "https://your-site.com/starter-content.wxz"
+ * 			"url": "https://your-site.com/starter-content.wxr"
  * 		}
  * }
  * </code>
  */
-export interface ImportFileStep<ResourceType> {
-	step: "importFile";
+export interface ImportWxrStep<ResourceType> {
+	step: "importWxr";
 	/** The file to import */
 	file: ResourceType;
 }
 /**
- * Uploads a file to the WordPress importer and returns the response.
- * Supports both WXR and WXZ files.
+ * Imports a WXR file into WordPress.
  *
- * @see https://github.com/WordPress/wordpress-importer/compare/master...akirk:wordpress-importer:import-wxz.patch
  * @param playground Playground client.
  * @param file The file to import.
  */
-export declare const importFile: StepHandler<ImportFileStep<File>>;
+export declare const importWxr: StepHandler<ImportWxrStep<File>>;
 /**
  * @inheritDoc enableMultisite
  * @hasRunnableExample
@@ -1888,7 +1882,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>
@@ -1922,7 +1916,7 @@ export type StepDefinition = Step & {
  * If you add a step here, make sure to also
  * add it to the exports below.
  */
-export type GenericStep<Resource> = ActivatePluginStep | ActivateThemeStep | CpStep | DefineWpConfigConstsStep | DefineSiteUrlStep | EnableMultisiteStep | ImportFileStep<Resource> | ImportWordPressFilesStep<Resource> | InstallPluginStep<Resource> | InstallThemeStep<Resource> | LoginStep | MkdirStep | MvStep | RequestStep | RmStep | RmdirStep | RunPHPStep | RunPHPWithOptionsStep | RunWpInstallationWizardStep | RunSqlStep<Resource> | SetPhpIniEntryStep | SetSiteOptionsStep | UnzipStep<Resource> | UpdateUserMetaStep | WriteFileStep<Resource> | WPCLIStep;
+export type GenericStep<Resource> = ActivatePluginStep | ActivateThemeStep | CpStep | DefineWpConfigConstsStep | DefineSiteUrlStep | EnableMultisiteStep | ImportWxrStep<Resource> | ImportWordPressFilesStep<Resource> | InstallPluginStep<Resource> | InstallThemeStep<Resource> | LoginStep | MkdirStep | MvStep | RequestStep | RmStep | RmdirStep | RunPHPStep | RunPHPWithOptionsStep | RunWpInstallationWizardStep | RunSqlStep<Resource> | SetPhpIniEntryStep | SetSiteOptionsStep | UnzipStep<Resource> | UpdateUserMetaStep | WriteFileStep<Resource> | WPCLIStep;
 /**
  * Progress reporting details.
  */
@@ -1943,14 +1937,6 @@ php: UniversalPHP, args: Omit<S, "step">, progressArgs?: StepProgress) => Return
  * @returns WXR file
  */
 export declare function exportWXR(playground: UniversalPHP): Promise<File>;
-/**
- * Exports the WordPress database as a WXZ file using
- * the export-wxz plugin from https://github.com/akirk/export-wxz.
- *
- * @param playground Playground client
- * @returns WXZ file
- */
-export declare function exportWXZ(playground: UniversalPHP): Promise<File>;
 export interface ZipWpContentOptions {
 	/**
 	 * @private
@@ -2276,6 +2262,7 @@ declare class PlaygroundWorkerEndpoint extends WebPHPEndpoint {
 		all: {
 			nightly: string;
 			beta: string;
+			"6.5": string;
 			"6.4": string;
 			"6.3": string;
 			"6.2": string;
@@ -2349,6 +2336,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
@@ -2363,7 +2358,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.
  *