@wp-playground/blueprints 0.1.51 → 0.1.58

package/lib/steps/activate-plugin.d.ts

@@ -2,11 +2,11 @@ import { StepHandler } from '.';
 export interface ActivatePluginStep {
     step: 'activatePlugin';
     pluginPath: string;
+    pluginName?: string;
 }
 /**
  * Activates a WordPress plugin in the Playground.
  *
  * @param playground The playground client.
- * @param plugin The plugin slug.
  */
 export declare const activatePlugin: StepHandler<ActivatePluginStep>;

package/lib/steps/client-methods.d.ts

@@ -31,7 +31,7 @@ export declare const runPHP: StepHandler<RunPHPStep>;
  * {
  * 		"step": "runPHP",
  * 		"options": {
- * 			"code": "<?php echo $_SERVER['HTTP_CONTENT_TYPE']; ?>",
+ * 			"code": "<?php echo $_SERVER['CONTENT_TYPE']; ?>",
  * 			"headers": {
  * 				"Content-type": "text/plain"
  * 			}

package/lib/steps/common.d.ts

@@ -1,9 +1,10 @@
-import type { PHPResponse, UniversalPHP } from '@php-wasm/universal';
-export declare function asDOM(response: PHPResponse): Document;
+import type { UniversalPHP } from '@php-wasm/universal';
 export declare function zipNameToHumanName(zipName: string): string;
 type PatchFileCallback = (contents: string) => string | Uint8Array;
 export declare function updateFile(php: UniversalPHP, path: string, callback: PatchFileCallback): Promise<void>;
 export declare function fileToUint8Array(file: File): Promise<Uint8Array>;
-export declare const VFS_CONFIG_FILE_BASENAME = "/vfs-blueprints";
-export declare const VFS_CONFIG_FILE_PATH = "/vfs-blueprints/wp-config-consts.php";
-export {};
+declare const FileWithArrayBuffer: {
+    new (fileBits: BlobPart[], fileName: string, options?: FilePropertyBag | undefined): File;
+    prototype: File;
+};
+export { FileWithArrayBuffer as File };

package/lib/steps/define-wp-config-consts.d.ts

@@ -1,4 +1,5 @@
 import { StepHandler } from '.';
+export declare const VFS_TMP_DIRECTORY = "/vfs-blueprints";
 /**
  * The step object for defining constants in the wp-config.php file of a WordPress installation.
  */
@@ -6,11 +7,19 @@ export interface DefineWpConfigConstsStep {
     step: 'defineWpConfigConsts';
     /** The constants to define */
     consts: Record<string, unknown>;
+    /**
+     * Enables the virtualization of wp-config.php and playground-consts.json files, leaving the local system files untouched.
+     * The variables defined in the /vfs-blueprints/playground-consts.json file are loaded via the auto_prepend_file directive in the php.ini file.
+     * @default false
+     * @see https://www.php.net/manual/en/ini.core.php#ini.auto-prepend-file
+     */
+    virtualize?: boolean;
 }
 /**
  * Sets site URL of the WordPress installation.
  *
  * @param playground The playground client.
- * @param wpConfigConst
+ * @param wpConfigConst An object containing the constants to be defined and the optional virtual file system configuration file path.
+ * @returns Returns the virtual file system configuration file path.
  */
 export declare const defineWpConfigConsts: StepHandler<DefineWpConfigConstsStep>;

package/lib/steps/handlers.d.ts

@@ -10,4 +10,3 @@ export { login } from './login';
 export { runWpInstallationWizard } from './run-wp-installation-wizard';
 export { setSiteOptions, updateUserMeta } from './site-data';
 export { defineWpConfigConsts } from './define-wp-config-consts';
-export { defineVirtualWpConfigConsts } from './define-virtual-wp-config-consts';

package/lib/steps/index.d.ts

@@ -13,7 +13,6 @@ import { SetSiteOptionsStep, UpdateUserMetaStep } from './site-data';
 import { RmStep, CpStep, MkdirStep, RmdirStep, MvStep, SetPhpIniEntryStep, RunPHPStep, RunPHPWithOptionsStep, RequestStep, WriteFileStep } from './client-methods';
 import { DefineWpConfigConstsStep } from './define-wp-config-consts';
 import { ActivateThemeStep } from './activate-theme';
-import { DefineVirtualWpConfigConstsStep } from './define-virtual-wp-config-consts';
 export type Step = GenericStep<FileReference>;
 export type StepDefinition = Step & {
     progress?: {
@@ -25,17 +24,17 @@ 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 | ApplyWordPressPatchesStep | CpStep | DefineWpConfigConstsStep | DefineVirtualWpConfigConstsStep | DefineSiteUrlStep | ImportFileStep<Resource> | InstallPluginStep<Resource> | InstallThemeStep<Resource> | LoginStep | MkdirStep | MvStep | RequestStep | ReplaceSiteStep<Resource> | RmStep | RmdirStep | RunPHPStep | RunPHPWithOptionsStep | RunWpInstallationWizardStep | SetPhpIniEntryStep | SetSiteOptionsStep | UnzipStep | UpdateUserMetaStep | WriteFileStep<Resource>;
-export type { ActivatePluginStep, ActivateThemeStep, ApplyWordPressPatchesStep, CpStep, DefineWpConfigConstsStep, DefineVirtualWpConfigConstsStep, DefineSiteUrlStep, ImportFileStep, InstallPluginStep, InstallPluginOptions, InstallThemeStep, InstallThemeOptions, LoginStep, MkdirStep, MvStep, RequestStep, ReplaceSiteStep, RmStep, RmdirStep, RunPHPStep, RunPHPWithOptionsStep, RunWpInstallationWizardStep, WordPressInstallationOptions, SetPhpIniEntryStep, SetSiteOptionsStep, UnzipStep, UpdateUserMetaStep, WriteFileStep, };
-export type StepHandler<S extends GenericStep<File>> = (
-/**
- * A PHP instance or Playground client.
- */
-php: UniversalPHP, args: Omit<S, 'step'>, 
+export type GenericStep<Resource> = ActivatePluginStep | ActivateThemeStep | ApplyWordPressPatchesStep | CpStep | DefineWpConfigConstsStep | DefineSiteUrlStep | ImportFileStep<Resource> | InstallPluginStep<Resource> | InstallThemeStep<Resource> | LoginStep | MkdirStep | MvStep | RequestStep | ReplaceSiteStep<Resource> | RmStep | RmdirStep | RunPHPStep | RunPHPWithOptionsStep | RunWpInstallationWizardStep | SetPhpIniEntryStep | SetSiteOptionsStep | UnzipStep | UpdateUserMetaStep | WriteFileStep<Resource>;
+export type { ActivatePluginStep, ActivateThemeStep, ApplyWordPressPatchesStep, CpStep, DefineWpConfigConstsStep, DefineSiteUrlStep, ImportFileStep, InstallPluginStep, InstallPluginOptions, InstallThemeStep, InstallThemeOptions, LoginStep, MkdirStep, MvStep, RequestStep, ReplaceSiteStep, RmStep, RmdirStep, RunPHPStep, RunPHPWithOptionsStep, RunWpInstallationWizardStep, WordPressInstallationOptions, SetPhpIniEntryStep, SetSiteOptionsStep, UnzipStep, UpdateUserMetaStep, WriteFileStep, };
 /**
  * Progress reporting details.
  */
-progressArgs?: {
+export type StepProgress = {
     tracker: ProgressTracker;
     initialCaption?: string;
-}) => any;
+};
+export type StepHandler<S extends GenericStep<File>> = (
+/**
+ * A PHP instance or Playground client.
+ */
+php: UniversalPHP, args: Omit<S, 'step'>, progressArgs?: StepProgress) => any;

package/lib/steps/install-asset.d.ts

@@ -0,0 +1,23 @@
+import type { UniversalPHP } from '@php-wasm/universal';
+export interface InstallAssetOptions {
+    /**
+     * The zip file to install.
+     */
+    zipFile: File;
+    /**
+     * Target path to extract the main folder.
+     * @example
+     *
+     * <code>
+     * const targetPath = `${await playground.documentRoot}/wp-content/plugins`;
+     * </code>
+     */
+    targetPath: string;
+}
+/**
+ * Install asset: Extract folder from zip file and move it to target
+ */
+export declare function installAsset(playground: UniversalPHP, { targetPath, zipFile }: InstallAssetOptions): Promise<{
+    assetFolderPath: string;
+    assetFolderName: string;
+}>;

package/lib/steps/install-plugin.d.ts

@@ -41,8 +41,6 @@ export interface InstallPluginOptions {
 }
 /**
  * Installs a WordPress plugin in the Playground.
- * Technically, it uses the same plugin upload form as a WordPress user
- * would, and then activates the plugin if needed.
  *
  * @param playground The playground client.
  * @param pluginZipFile The plugin zip file.

package/lib/steps/install-theme.d.ts

@@ -45,8 +45,6 @@ export interface InstallThemeOptions {
 }
 /**
  * Installs a WordPress theme in the Playground.
- * Technically, it uses the same theme upload form as a WordPress user
- * would, and then activates the theme if needed.
  *
  * @param playground The playground client.
  * @param themeZipFile The theme zip file.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wp-playground/blueprints",
-	"version": "0.1.51",
+	"version": "0.1.58",
 	"exports": {
 		".": {
 			"import": "./index.js",
@@ -21,5 +21,5 @@
 		"access": "public",
 		"directory": "../../../dist/packages/playground/blueprints"
 	},
-	"gitHead": "756f9e316b51bc1496982fa4ed9310a16701afa5"
+	"gitHead": "dbc77ed4c0b0a2625cfbe08722fade036c69a425"
 }

package/lib/steps/define-virtual-wp-config-consts.d.ts

@@ -1,19 +0,0 @@
-import { StepHandler } from '.';
-/**
- * The step object for defining constants in the VFS_CONFIG_FILE_PATH php file and loaded using the auto_prepend_file php.ini directive.
- */
-export interface DefineVirtualWpConfigConstsStep {
-    step: 'defineVirtualWpConfigConsts';
-    /** The constants to define */
-    consts: Record<string, unknown>;
-}
-/**
- * Function to define constants in the virtual VFS_CONFIG_FILE_PATH php file of a WordPress installation.
- * The file should be dynamically loaded using the auto_prepend_file php.ini directive after this step.
- *
- * @param playground The playground client.
- * @param wpConfigConst An object containing the constants to be defined and the optional virtual file system configuration file path.
- * @returns Returns the virtual file system configuration file path.
- * @see {@link https://www.php.net/manual/en/ini.core.php#ini.auto-prepend-file}
- */
-export declare const defineVirtualWpConfigConsts: StepHandler<DefineVirtualWpConfigConstsStep>;