@wp-playground/blueprints 0.1.42 → 0.1.45

package/lib/steps/common.d.ts

@@ -4,4 +4,6 @@ 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 {};

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

@@ -0,0 +1,19 @@
+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>;

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

@@ -1,6 +1,10 @@
 import { StepHandler } from '.';
+/**
+ * The step object for defining constants in the wp-config.php file of a WordPress installation.
+ */
 export interface DefineWpConfigConstsStep {
     step: 'defineWpConfigConsts';
+    /** The constants to define */
     consts: Record<string, unknown>;
 }
 /**

package/lib/steps/handlers.d.ts

@@ -9,3 +9,4 @@ 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

@@ -5,13 +5,14 @@ import { ActivatePluginStep } from './activate-plugin';
 import { ApplyWordPressPatchesStep } from './apply-wordpress-patches';
 import { DefineSiteUrlStep } from './define-site-url';
 import { ImportFileStep, ReplaceSiteStep, UnzipStep } from './import-export';
-import { InstallPluginStep } from './install-plugin';
-import { InstallThemeStep } from './install-theme';
+import { InstallPluginStep, InstallPluginOptions } from './install-plugin';
+import { InstallThemeStep, InstallThemeOptions } from './install-theme';
 import { LoginStep } from './login';
-import { RunWpInstallationWizardStep } from './run-wp-installation-wizard';
+import { RunWpInstallationWizardStep, WordPressInstallationOptions } from './run-wp-installation-wizard';
 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 { DefineVirtualWpConfigConstsStep } from './define-virtual-wp-config-consts';
 export type Step = GenericStep<FileReference>;
 export type StepDefinition = Step & {
     progress?: {
@@ -19,7 +20,8 @@ export type StepDefinition = Step & {
         caption?: string;
     };
 };
-export type GenericStep<Resource> = ActivatePluginStep | 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 GenericStep<Resource> = ActivatePluginStep | 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, 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, };
 export type StepHandler<S extends GenericStep<File>> = (php: UniversalPHP, args: Omit<S, 'step'>, progressArgs?: {
     tracker: ProgressTracker;
     initialCaption?: string;

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

@@ -1,7 +1,31 @@
 import { StepHandler } from '.';
+/**
+ * The step to install a WordPress plugin in the Playground.
+ *
+ * @example
+ *
+ * <code>
+ * {
+ * 	    "step": "installPlugin",
+ * 		"pluginZipFile": "http://example.com/plugin.zip",
+ * 		"options": {
+ * 			"activate": true
+ * 		}
+ * }
+ * </code>
+ */
 export interface InstallPluginStep<ResourceType> {
+    /**
+     * The step identifier.
+     */
     step: 'installPlugin';
+    /**
+     * The plugin zip file to install.
+     */
     pluginZipFile: ResourceType;
+    /**
+     * Optional installation options.
+     */
     options?: InstallPluginOptions;
 }
 export interface InstallPluginOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wp-playground/blueprints",
-	"version": "0.1.42",
+	"version": "0.1.45",
 	"exports": {
 		".": {
 			"import": "./index.js",
@@ -21,5 +21,5 @@
 		"access": "public",
 		"directory": "../../../dist/packages/playground/blueprints"
 	},
-	"gitHead": "14707001dbf7738ca8f173f3040559c6c165110e"
+	"gitHead": "ca75514c17b912dc8b5dc529f6d123295671320a"
 }