@wp-playground/blueprints 0.1.43 → 0.1.46

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

@@ -1,7 +1,7 @@
 import { StepHandler } from '.';
 export interface ActivatePluginStep {
     step: 'activatePlugin';
-    plugin: string;
+    pluginPath: string;
 }
 /**
  * Activates a WordPress plugin in the Playground.

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

@@ -0,0 +1,12 @@
+import { StepHandler } from '.';
+export interface ActivateThemeStep {
+    step: 'activateTheme';
+    themeFolderName: string;
+}
+/**
+ * Activates a WordPress theme in the Playground.
+ *
+ * @param playground The playground client.
+ * @param themeFolderName The theme folder name.
+ */
+export declare const activateTheme: StepHandler<ActivateThemeStep>;

package/lib/steps/handlers.d.ts

@@ -1,4 +1,5 @@
 export { activatePlugin } from './activate-plugin';
+export { activateTheme } from './activate-theme';
 export { applyWordPressPatches } from './apply-wordpress-patches';
 export { rm, cp, mkdir, rmdir, mv, setPhpIniEntry, runPHP, runPHPWithOptions, request, writeFile, } from './client-methods';
 export { defineSiteUrl } from './define-site-url';

package/lib/steps/index.d.ts

@@ -12,6 +12,7 @@ import { RunWpInstallationWizardStep, WordPressInstallationOptions } from './run
 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 & {
@@ -20,9 +21,17 @@ export type StepDefinition = Step & {
         caption?: string;
     };
 };
-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 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, 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?: {
+export type StepHandler<S extends GenericStep<File>> = (
+/**
+ * A PHP instance or Playground client.
+ */
+php: UniversalPHP, args: Omit<S, 'step'>, 
+/**
+ * Progress reporting details.
+ */
+progressArgs?: {
     tracker: ProgressTracker;
     initialCaption?: string;
 }) => any;

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

@@ -1,13 +1,18 @@
 import { StepHandler } from '.';
 /**
- * The step to install a WordPress plugin in the Playground.
- *
+ * @inheritDoc installPlugin
+ * @hasRunnableExample
+ * @needsLogin
+ * @landingPage /wp-admin/plugins.php
  * @example
  *
  * <code>
  * {
  * 	    "step": "installPlugin",
- * 		"pluginZipFile": "http://example.com/plugin.zip",
+ * 		"pluginZipFile": {
+ * 			"resource": "wordpress.org/plugins",
+ * 			"slug": "gutenberg"
+ * 		},
  * 		"options": {
  * 			"activate": true
  * 		}

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

@@ -1,8 +1,41 @@
 import { StepHandler } from '.';
+/**
+ * @inheritDoc installTheme
+ * @hasRunnableExample
+ * @needsLogin
+ * @example
+ *
+ * <code>
+ * {
+ * 		"step": "installTheme",
+ * 		"themeZipFile": {
+ * 			"resource": "wordpress.org/themes",
+ * 			"slug": "pendant"
+ * 		},
+ * 		"options": {
+ * 			"activate": true
+ * 		}
+ * }
+ * </code>
+ */
 export interface InstallThemeStep<ResourceType> {
+    /**
+     * The step identifier.
+     */
     step: 'installTheme';
+    /**
+     * The theme zip file to install.
+     */
     themeZipFile: ResourceType;
-    options?: InstallThemeOptions;
+    /**
+     * Optional installation options.
+     */
+    options?: {
+        /**
+         * Whether to activate the theme after installing it.
+         */
+        activate?: boolean;
+    };
 }
 export interface InstallThemeOptions {
     /**

package/lib/steps/login.d.ts

@@ -1,16 +1,31 @@
 import { StepHandler } from '.';
+/**
+ * @inheritDoc login
+ * @hasRunnableExample
+ * @example
+ *
+ * <code>
+ * {
+ * 	    "step": "login",
+ * 		"username": "admin",
+ * 		"password": "password"
+ * }
+ * </code>
+ */
 export type LoginStep = {
     step: 'login';
+    /**
+     * The user to log in as. Defaults to 'admin'.
+     */
     username?: string;
+    /**
+     * The password to log in with. Defaults to 'password'.
+     */
     password?: string;
 };
 /**
  * Logs in to the Playground.
  * Under the hood, this function submits the wp-login.php form
  * just like a user would.
- *
- * @param playground The playground client.
- * @param user The user to log in as. Defaults to 'admin'.
- * @param password The password to log in with. Defaults to 'password'.
  */
 export declare const login: StepHandler<LoginStep>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wp-playground/blueprints",
-	"version": "0.1.43",
+	"version": "0.1.46",
 	"exports": {
 		".": {
 			"import": "./index.js",
@@ -21,5 +21,5 @@
 		"access": "public",
 		"directory": "../../../dist/packages/playground/blueprints"
 	},
-	"gitHead": "090e1dd0de51e5d5d7106ba60611a8e9f96fa35d"
+	"gitHead": "b1e1b4b57b00fb52429f0490af4ccb943f496f74"
 }