@wp-playground/client 3.1.27 → 3.1.29

package/index.d.ts

@@ -5156,13 +5156,17 @@ export declare class BlueprintFetchError extends Error {
 	readonly url: string;
 	constructor(message: string, url: string, options?: ErrorOptions);
 }
+export interface ResolveRemoteBlueprintOptions {
+	fetch?: typeof fetch;
+	corsProxy?: string;
+}
 /**
  * Resolves a remote blueprint from a URL.
  *
  * @param url - The URL of the blueprint to resolve.
  * @returns A promise that resolves to the resolved blueprint.
  */
-export declare function resolveRemoteBlueprint(url: string): Promise<BlueprintBundle>;
+export declare function resolveRemoteBlueprint(url: string, options?: ResolveRemoteBlueprintOptions): Promise<BlueprintBundle>;
 export declare function resolveRuntimeConfiguration(blueprint: Blueprint): Promise<RuntimeConfiguration>;
 /**
  * @deprecated This function is a no-op. Playground no longer uses a proxy to download plugins and themes.
@@ -5270,6 +5274,7 @@ export type WorkerBootOptions = {
 	withNetworking: boolean;
 	mounts?: Array<MountDescriptor>;
 	shouldInstallWordPress?: boolean;
+	shouldBootWordPress?: boolean;
 	corsProxyUrl?: string;
 	/** When true, skip default WP install and run Blueprints v2 in the worker */
 	experimentalBlueprintsV2Runner?: boolean;
@@ -5444,7 +5449,27 @@ export interface StartPlaygroundOptions {
 	 */
 	sapiName?: string;
 	mounts?: Array<MountDescriptor>;
+	/**
+	 * Whether to download/install WordPress files.
+	 *
+	 * Set this to `false` when WordPress files are already available, for example
+	 * from `mounts` or a saved site.
+	 *
+	 * This option cannot be set to `true` when `shouldBootWordPress` is `false`,
+	 * because installing WordPress requires running the WordPress boot setup.
+	 */
 	shouldInstallWordPress?: boolean;
+	/**
+	 * Whether to run WordPress boot setup.
+	 *
+	 * This is separate from `shouldInstallWordPress` because saved sites can boot
+	 * from existing WordPress files without downloading or installing a fresh copy.
+	 * Set this to `false` for PHP-only Playgrounds.
+	 *
+	 * If `shouldInstallWordPress` is `false` and this option is `true`, WordPress
+	 * files must already be present, for example via `mounts` or a saved site.
+	 */
+	shouldBootWordPress?: boolean;
 	/**
 	 * The string prefix used in the site URL served by the currently
 	 * running remote.html. E.g. for a prefix like `/scope:playground/`,