@wp-playground/client 0.2.0 → 0.3.0

package/index.d.ts

@@ -668,6 +668,8 @@ export declare const SupportedPHPVersions: readonly [
 export declare const LatestSupportedPHPVersion: "8.2";
 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 interface PHPRequestHandlerConfiguration {
 	/**
 	 * The directory in the PHP filesystem where the server will look
@@ -678,11 +680,6 @@ export interface PHPRequestHandlerConfiguration {
 	 * Request Handler URL. Used to populate $_SERVER details like HTTP_HOST.
 	 */
 	absoluteUrl?: string;
-	/**
-	 * Callback used by the PHPRequestHandler to decide whether
-	 * the requested path refers to a PHP file or a static file.
-	 */
-	isStaticFilePath?: (path: string) => boolean;
 }
 /** @inheritDoc */
 export declare class PHPRequestHandler implements RequestHandler {
@@ -1064,6 +1061,15 @@ export declare class SemaphoreResource<T extends Resource> extends DecoratedReso
 }
 /**
  * @inheritDoc activatePlugin
+ * @example
+ *
+ * <code>
+ * {
+ * 		"step": "activatePlugin",
+ * 		"pluginName": "Gutenberg",
+ * 		"pluginPath": "/wordpress/wp-content/plugins/gutenberg"
+ * }
+ * </code>
  */
 export interface ActivatePluginStep {
 	step: "activatePlugin";
@@ -1089,6 +1095,8 @@ export interface ApplyWordPressPatchesStep {
 	patchSecrets?: boolean;
 	disableSiteHealth?: boolean;
 	disableWpNewBlogNotification?: boolean;
+	makeEditorFrameControlled?: boolean;
+	prepareForRunningInsideWebBrowser?: boolean;
 }
 export declare const applyWordPressPatches: StepHandler<ApplyWordPressPatchesStep>;
 /**
@@ -1126,6 +1134,14 @@ export declare const defineSiteUrl: StepHandler<DefineSiteUrlStep>;
 export declare function zipEntireSite(playground: UniversalPHP): Promise<File>;
 /**
  * @inheritDoc replaceSite
+ * @example
+ *
+ * <code>
+ * {
+ * 		"step": "replaceSite",
+ * 		"fullSiteZip": "https://mysite.com/import.zip"
+ * }
+ * </code>
  */
 export interface ReplaceSiteStep<ResourceType> {
 	step: "replaceSite";
@@ -1143,6 +1159,15 @@ export interface ReplaceSiteStep<ResourceType> {
 export declare const replaceSite: StepHandler<ReplaceSiteStep<File>>;
 /**
  * @inheritDoc unzip
+ * @example
+ *
+ * <code>
+ * {
+ * 		"step": "unzip",
+ * 		"zipPath": "/wordpress/data.zip",
+ * 		"extractToPath": "/wordpress"
+ * }
+ * </code>
  */
 export interface UnzipStep {
 	step: "unzip";
@@ -1161,6 +1186,14 @@ export interface UnzipStep {
 export declare const unzip: StepHandler<UnzipStep>;
 /**
  * @inheritDoc importFile
+ * @example
+ *
+ * <code>
+ * {
+ * 		"step": "importFile",
+ * 		"file": "https://mysite.com/import.WXR"
+ * }
+ * </code>
  */
 export interface ImportFileStep<ResourceType> {
 	step: "importFile";
@@ -1381,225 +1414,225 @@ export interface UpdateUserMetaStep {
  */
 export declare const updateUserMeta: StepHandler<UpdateUserMetaStep>;
 /**
- * @inheritDoc runPHP
+ * @inheritDoc rm
  * @hasRunnableExample
+ * @landingPage /index.php
  * @example
  *
  * <code>
  * {
- * 		"step": "runPHP",
- * 		"code": "<?php echo 'Hello World'; ?>"
+ * 		"step": "rm",
+ * 		"path": "/wordpress/index.php"
  * }
  * </code>
  */
-export interface RunPHPStep {
-	/** The step identifier. */
-	step: "runPHP";
-	/** The PHP code to run. */
-	code: string;
+export interface RmStep {
+	step: "rm";
+	/** The path to remove */
+	path: string;
 }
 /**
- * Runs PHP code.
+ * Removes a file at the specified path.
  */
-export declare const runPHP: StepHandler<RunPHPStep>;
+export declare const rm: StepHandler<RmStep>;
 /**
- * @inheritDoc runPHP
+ * @inheritDoc cp
  * @hasRunnableExample
+ * @landingPage /index2.php
  * @example
  *
  * <code>
  * {
- * 		"step": "runPHP",
- * 		"options": {
- * 			"code": "<?php echo $_SERVER['CONTENT_TYPE']; ?>",
- * 			"headers": {
- * 				"Content-type": "text/plain"
- * 			}
- * 		}
+ * 		"step": "cp",
+ * 		"fromPath": "/wordpress/index.php",
+ * 		"toPath": "/wordpress/index2.php"
  * }
  * </code>
  */
-export interface RunPHPWithOptionsStep {
-	step: "runPHPWithOptions";
-	/**
-	 * Run options (See /wordpress-playground/api/universal/interface/PHPRunOptions)
-	 */
-	options: PHPRunOptions;
+export interface CpStep {
+	step: "cp";
+	/** Source path */
+	fromPath: string;
+	/** Target path */
+	toPath: string;
 }
 /**
- * Runs PHP code with the given options.
+ * Copies a file from one path to another.
  */
-export declare const runPHPWithOptions: StepHandler<RunPHPWithOptionsStep>;
+export declare const cp: StepHandler<CpStep>;
 /**
- * @inheritDoc setPhpIniEntry
+ * @inheritDoc rmdir
  * @hasRunnableExample
+ * @landingPage /wp-admin/
  * @example
  *
  * <code>
  * {
- * 		"step": "setPhpIniEntry",
- * 		"key": "display_errors",
- * 		"value": "1"
+ * 		"step": "rmdir",
+ * 		"path": "/wordpress/wp-admin"
  * }
  * </code>
  */
-export interface SetPhpIniEntryStep {
-	step: "setPhpIniEntry";
-	/** Entry name e.g. "display_errors" */
-	key: string;
-	/** Entry value as a string e.g. "1" */
-	value: string;
+export interface RmdirStep {
+	step: "rmdir";
+	/** The path to remove */
+	path: string;
 }
 /**
- * Sets a PHP ini entry.
+ * Removes a directory at the specified path.
  */
-export declare const setPhpIniEntry: StepHandler<SetPhpIniEntryStep>;
+export declare const rmdir: StepHandler<RmdirStep>;
 /**
- * @inheritDoc request
- * @needsLogin
+ * @inheritDoc mkdir
  * @hasRunnableExample
  * @example
  *
  * <code>
  * {
- * 		"step": "request",
- * 		"request": {
- * 			"method": "POST",
- * 			"url": "/wp-admin/admin-ajax.php",
- * 			"formData": {
- * 				"action": "my_action",
- * 				"foo": "bar"
- * 			}
- * 		}
+ * 		"step": "mkdir",
+ * 		"path": "/wordpress/my-new-folder"
  * }
  * </code>
  */
-export interface RequestStep {
-	step: "request";
-	/**
-	 * Request details (See /wordpress-playground/api/universal/interface/PHPRequest)
-	 */
-	request: PHPRequest;
+export interface MkdirStep {
+	step: "mkdir";
+	/** The path of the directory you want to create */
+	path: string;
 }
 /**
- * Sends a HTTP request to the Playground.
+ * Creates a directory at the specified path.
  */
-export declare const request: StepHandler<RequestStep>;
+export declare const mkdir: StepHandler<MkdirStep>;
 /**
- * @inheritDoc cp
+ * @inheritDoc mv
  * @hasRunnableExample
  * @landingPage /index2.php
  * @example
  *
  * <code>
  * {
- * 		"step": "cp",
+ * 		"step": "mv",
  * 		"fromPath": "/wordpress/index.php",
  * 		"toPath": "/wordpress/index2.php"
  * }
  * </code>
  */
-export interface CpStep {
-	step: "cp";
+export interface MvStep {
+	step: "mv";
 	/** Source path */
 	fromPath: string;
 	/** Target path */
 	toPath: string;
 }
 /**
- * Copies a file from one path to another.
+ * Moves a file or directory from one path to another.
  */
-export declare const cp: StepHandler<CpStep>;
+export declare const mv: StepHandler<MvStep>;
 /**
- * @inheritDoc mv
+ * @inheritDoc setPhpIniEntry
  * @hasRunnableExample
- * @landingPage /index2.php
  * @example
  *
  * <code>
  * {
- * 		"step": "mv",
- * 		"fromPath": "/wordpress/index.php",
- * 		"toPath": "/wordpress/index2.php"
+ * 		"step": "setPhpIniEntry",
+ * 		"key": "display_errors",
+ * 		"value": "1"
  * }
  * </code>
  */
-export interface MvStep {
-	step: "mv";
-	/** Source path */
-	fromPath: string;
-	/** Target path */
-	toPath: string;
+export interface SetPhpIniEntryStep {
+	step: "setPhpIniEntry";
+	/** Entry name e.g. "display_errors" */
+	key: string;
+	/** Entry value as a string e.g. "1" */
+	value: string;
 }
 /**
- * Moves a file or directory from one path to another.
+ * Sets a PHP ini entry.
  */
-export declare const mv: StepHandler<MvStep>;
+export declare const setPhpIniEntry: StepHandler<SetPhpIniEntryStep>;
 /**
- * @inheritDoc mkdir
+ * @inheritDoc runPHP
  * @hasRunnableExample
  * @example
  *
  * <code>
  * {
- * 		"step": "mkdir",
- * 		"path": "/wordpress/my-new-folder"
+ * 		"step": "runPHP",
+ * 		"code": "<?php require_once 'wordpress/wp-load.php'; wp_insert_post(array('post_title' => 'wp-load.php required for WP functionality', 'post_status' => 'publish')); ?>"
  * }
  * </code>
  */
-export interface MkdirStep {
-	step: "mkdir";
-	/** The path of the directory you want to create */
-	path: string;
+export interface RunPHPStep {
+	/** The step identifier. */
+	step: "runPHP";
+	/** The PHP code to run. */
+	code: string;
 }
 /**
- * Creates a directory at the specified path.
+ * Runs PHP code.
  */
-export declare const mkdir: StepHandler<MkdirStep>;
+export declare const runPHP: StepHandler<RunPHPStep>;
 /**
- * @inheritDoc rm
+ * @inheritDoc runPHP
  * @hasRunnableExample
- * @landingPage /index.php
  * @example
  *
  * <code>
  * {
- * 		"step": "rm",
- * 		"path": "/wordpress/index.php"
+ * 		"step": "runPHP",
+ * 		"options": {
+ * 			"code": "<?php echo $_SERVER['CONTENT_TYPE']; ?>",
+ * 			"headers": {
+ * 				"Content-type": "text/plain"
+ * 			}
+ * 		}
  * }
  * </code>
  */
-export interface RmStep {
-	step: "rm";
-	/** The path to remove */
-	path: string;
+export interface RunPHPWithOptionsStep {
+	step: "runPHPWithOptions";
+	/**
+	 * Run options (See /wordpress-playground/api/universal/interface/PHPRunOptions)
+	 */
+	options: PHPRunOptions;
 }
 /**
- * Removes a file at the specified path.
+ * Runs PHP code with the given options.
  */
-export declare const rm: StepHandler<RmStep>;
+export declare const runPHPWithOptions: StepHandler<RunPHPWithOptionsStep>;
 /**
- * @inheritDoc rmdir
+ * @inheritDoc request
+ * @needsLogin
  * @hasRunnableExample
- * @landingPage /wp-admin/
  * @example
  *
  * <code>
  * {
- * 		"step": "rm",
- * 		"path": "/wordpress/wp-admin"
+ * 		"step": "request",
+ * 		"request": {
+ * 			"method": "POST",
+ * 			"url": "/wp-admin/admin-ajax.php",
+ * 			"formData": {
+ * 				"action": "my_action",
+ * 				"foo": "bar"
+ * 			}
+ * 		}
  * }
  * </code>
  */
-export interface RmdirStep {
-	step: "rmdir";
-	/** The path to remove */
-	path: string;
+export interface RequestStep {
+	step: "request";
+	/**
+	 * Request details (See /wordpress-playground/api/universal/interface/PHPRequest)
+	 */
+	request: PHPRequest;
 }
 /**
- * Removes a directory at the specified path.
+ * Sends a HTTP request to the Playground.
  */
-export declare const rmdir: StepHandler<RmdirStep>;
+export declare const request: StepHandler<RequestStep>;
 /**
  * @inheritDoc writeFile
  * @hasRunnableExample
@@ -1661,6 +1694,15 @@ export interface DefineWpConfigConstsStep {
 export declare const defineWpConfigConsts: StepHandler<DefineWpConfigConstsStep>;
 /**
  * @inheritDoc activateTheme
+ * @example
+ *
+ * <code>
+ * {
+ * 		"step": "activateTheme",
+ * 		"pluginName": "Storefront",
+ * 		"pluginPath": "/wordpress/wp-content/themes/storefront"
+ * }
+ * </code>
  */
 export interface ActivateThemeStep {
 	step: "activateTheme";
@@ -1720,26 +1762,24 @@ export interface Blueprint {
 		 */
 		wp: string | "latest";
 	};
+	/**
+	 * The PHP extensions to use.
+	 */
+	phpExtensionBundles?: SupportedPHPExtensionBundle[];
 	/**
 	 * The steps to run.
 	 */
 	steps?: Array<StepDefinition | string | undefined | false | null>;
 }
 export type CompiledStep = (php: UniversalPHP) => Promise<void> | void;
-declare const supportedWordPressVersions: readonly [
-	"6.2",
-	"6.1",
-	"6.0",
-	"5.9",
-	"nightly"
-];
-export type supportedWordPressVersion = (typeof supportedWordPressVersions)[number];
 export interface CompiledBlueprint {
 	/** The requested versions of PHP and WordPress for the blueprint */
 	versions: {
 		php: SupportedPHPVersion;
-		wp: supportedWordPressVersion;
+		wp: string;
 	};
+	/** The requested PHP extensions to load */
+	phpExtensions: SupportedPHPExtension[];
 	/** The compiled steps for the blueprint */
 	run: (playground: UniversalPHP) => Promise<void>;
 }
@@ -1780,6 +1820,8 @@ export interface PHPWebLoaderOptions {
 	downloadMonitor?: EmscriptenDownloadMonitor;
 	requestHandler?: PHPRequestHandlerConfiguration;
 	dataModules?: Array<DataModule | Promise<DataModule>>;
+	/** @deprecated To be replaced with `extensions` in the future */
+	loadAllExtensions?: boolean;
 }
 declare class WebPHP extends BasePHP {
 	/**
@@ -1884,7 +1926,17 @@ declare class PlaygroundWorkerEndpoint extends WebPHPEndpoint {
 	getWordPressModuleDetails(): Promise<{
 		majorVersion: string;
 		staticAssetsDirectory: string;
-		defaultTheme: any;
+	}>;
+	getSupportedWordPressVersions(): Promise<{
+		all: {
+			nightly: string;
+			beta: string;
+			"6.3": string;
+			"6.2": string;
+			"6.1": string;
+			"6.0": string;
+		};
+		latest: string;
 	}>;
 	resetVirtualOpfs(): Promise<void>;
 	reloadFilesFromOpfs(): Promise<void>;