@wp-playground/blueprints 0.1.56 → 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,7 +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 FileWithArrayBuffer: {
+    new (fileBits: BlobPart[], fileName: string, options?: FilePropertyBag | undefined): File;
+    prototype: File;
+};
+export { FileWithArrayBuffer as File };

package/lib/steps/index.d.ts

@@ -26,15 +26,15 @@ export type StepDefinition = 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, };
-export type StepHandler<S extends GenericStep<File>> = (
-/**
- * A PHP instance or Playground client.
- */
-php: UniversalPHP, args: Omit<S, 'step'>, 
 /**
  * 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.56",
+	"version": "0.1.58",
 	"exports": {
 		".": {
 			"import": "./index.js",
@@ -21,5 +21,5 @@
 		"access": "public",
 		"directory": "../../../dist/packages/playground/blueprints"
 	},
-	"gitHead": "af3583eb7c6644a9859ea4782702c6e2c3474821"
+	"gitHead": "dbc77ed4c0b0a2625cfbe08722fade036c69a425"
 }