@wp-playground/blueprints 0.7.19 → 0.9.1

package/lib/steps/define-site-url.d.ts

@@ -10,10 +10,10 @@ export interface DefineSiteUrlStep {
     siteUrl: string;
 }
 /**
- * Sets WP_HOME and WP_SITEURL constants for the WordPress installation.
+ * Sets [`WP_HOME`](https://developer.wordpress.org/advanced-administration/wordpress/wp-config/#blog-address-url) and [`WP_SITEURL`](https://developer.wordpress.org/advanced-administration/wordpress/wp-config/#wp-siteurl) constants for the WordPress installation.
  *
- * Beware: Using this step makes no sense on playground.wordpress.net.
- * It is useful when you're building a custom Playground-based tool like wp-now,
+ * Using this step on playground.wordpress.net is moot.
+ * It is useful when building a custom Playground-based tool, like [`wp-now`](https://www.npmjs.com/package/@wp-now/wp-now),
  * or deploying Playground on a custom domain.
  *
  * @param playground The playground client.

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

@@ -19,13 +19,14 @@ export interface DefineWpConfigConstsStep {
     /** The constants to define */
     consts: Record<string, unknown>;
     /**
-     * The method of defining the constants. Possible values are:
+     * The method of defining the constants in wp-config.php. Possible values are:
      *
      * - rewrite-wp-config: Default. Rewrites the wp-config.php file to
      *                      explicitly call define() with the requested
      *                      name and value. This method alters the file
      *                      on the disk, but it doesn't conflict with
      *                      existing define() calls in wp-config.php.
+     *
      * - define-before-run: Defines the constant before running the requested
      *                      script. It doesn't alter any files on the disk, but
      *                      constants defined this way may conflict with existing
@@ -40,7 +41,7 @@ export interface DefineWpConfigConstsStep {
     virtualize?: boolean;
 }
 /**
- * Defines constants in a wp-config.php file.
+ * Defines constants in a [`wp-config.php`](https://developer.wordpress.org/advanced-administration/wordpress/wp-config/) file.
  *
  * This step can be called multiple times, and the constants will be merged.
  *

package/lib/steps/enable-multisite.d.ts

@@ -14,7 +14,7 @@ export interface EnableMultisiteStep {
     step: 'enableMultisite';
 }
 /**
- * Defines constants in a wp-config.php file.
+ * Defines the [Multisite](https://developer.wordpress.org/advanced-administration/multisite/create-network/) constants in a `wp-config.php` file.
  *
  * This step can be called multiple times, and the constants will be merged.
  *

package/lib/steps/handlers.d.ts

@@ -19,6 +19,7 @@ export { unzip } from './unzip';
 export { installPlugin } from './install-plugin';
 export { installTheme } from './install-theme';
 export { login } from './login';
+export { resetData } from './reset-data';
 export { runWpInstallationWizard } from './run-wp-installation-wizard';
 export { setSiteOptions, updateUserMeta } from './site-data';
 export { defineWpConfigConsts } from './define-wp-config-consts';

package/lib/steps/import-wordpress-files.d.ts

@@ -27,9 +27,9 @@ export interface ImportWordPressFilesStep<ResourceType> {
 }
 /**
  * Imports top-level WordPress files from a given zip file into
- * the documentRoot. For example, if a zip file contains the
+ * the `documentRoot`. For example, if a zip file contains the
  * `wp-content` and `wp-includes` directories, they will replace
- * the corresponding directories in Playground's documentRoot.
+ * the corresponding directories in Playground's `documentRoot`.
  *
  * Any files that Playground recognizes as "excluded from the export"
  * will carry over from the existing document root into the imported

package/lib/steps/index.d.ts

@@ -25,6 +25,7 @@ import { ImportWordPressFilesStep } from './import-wordpress-files';
 import { ImportWxrStep } from './import-wxr';
 import { EnableMultisiteStep } from './enable-multisite';
 import { WPCLIStep } from './wp-cli';
+import { ResetDataStep } from './reset-data';
 export type Step = GenericStep<FileReference>;
 export type StepDefinition = Step & {
     progress?: {
@@ -37,8 +38,8 @@ export { wpContentFilesExcludedFromExport } from '../utils/wp-content-files-excl
  * If you add a step here, make sure to also
  * add it to the exports below.
  */
-export type GenericStep<Resource> = ActivatePluginStep | ActivateThemeStep | CpStep | DefineWpConfigConstsStep | DefineSiteUrlStep | EnableMultisiteStep | ImportWxrStep<Resource> | ImportWordPressFilesStep<Resource> | InstallPluginStep<Resource> | InstallThemeStep<Resource> | LoginStep | MkdirStep | MvStep | RequestStep | RmStep | RmdirStep | RunPHPStep | RunPHPWithOptionsStep | RunWpInstallationWizardStep | RunSqlStep<Resource> | SetSiteOptionsStep | UnzipStep<Resource> | UpdateUserMetaStep | WriteFileStep<Resource> | WPCLIStep;
-export type { ActivatePluginStep, ActivateThemeStep, CpStep, DefineWpConfigConstsStep, DefineSiteUrlStep, EnableMultisiteStep, ImportWxrStep, ImportWordPressFilesStep, InstallPluginStep, InstallPluginOptions, InstallThemeStep, InstallThemeOptions, LoginStep, MkdirStep, MvStep, RequestStep, RmStep, RmdirStep, RunPHPStep, RunPHPWithOptionsStep, RunWpInstallationWizardStep, RunSqlStep, WordPressInstallationOptions, SetSiteOptionsStep, UnzipStep, UpdateUserMetaStep, WriteFileStep, WPCLIStep, };
+export type GenericStep<Resource> = ActivatePluginStep | ActivateThemeStep | CpStep | DefineWpConfigConstsStep | DefineSiteUrlStep | EnableMultisiteStep | ImportWxrStep<Resource> | ImportWordPressFilesStep<Resource> | InstallPluginStep<Resource> | InstallThemeStep<Resource> | LoginStep | MkdirStep | MvStep | ResetDataStep | RequestStep | RmStep | RmdirStep | RunPHPStep | RunPHPWithOptionsStep | RunWpInstallationWizardStep | RunSqlStep<Resource> | SetSiteOptionsStep | UnzipStep<Resource> | UpdateUserMetaStep | WriteFileStep<Resource> | WPCLIStep;
+export type { ActivatePluginStep, ActivateThemeStep, CpStep, DefineWpConfigConstsStep, DefineSiteUrlStep, EnableMultisiteStep, ImportWxrStep, ImportWordPressFilesStep, InstallPluginStep, InstallPluginOptions, InstallThemeStep, InstallThemeOptions, LoginStep, MkdirStep, MvStep, ResetDataStep, RequestStep, RmStep, RmdirStep, RunPHPStep, RunPHPWithOptionsStep, RunWpInstallationWizardStep, RunSqlStep, WordPressInstallationOptions, SetSiteOptionsStep, UnzipStep, UpdateUserMetaStep, WriteFileStep, WPCLIStep, };
 /**
  * Progress reporting details.
  */

package/lib/steps/login.d.ts

@@ -24,8 +24,8 @@ export type LoginStep = {
     password?: string;
 };
 /**
- * Logs in to the Playground.
- * Under the hood, this function submits the wp-login.php form
+ * Logs in to Playground.
+ * Under the hood, this function submits the [`wp-login.php`](https://developer.wordpress.org/reference/files/wp-login.php/) [form](https://developer.wordpress.org/reference/functions/wp_login_form/)
  * just like a user would.
  */
 export declare const login: StepHandler<LoginStep>;

package/lib/steps/request.d.ts

@@ -29,6 +29,6 @@ export interface RequestStep {
     request: PHPRequest;
 }
 /**
- * Sends a HTTP request to the Playground.
+ * Sends a HTTP request to Playground.
  */
 export declare const request: StepHandler<RequestStep, Promise<PHPResponse>>;

package/lib/steps/reset-data.d.ts

@@ -0,0 +1,23 @@
+import { StepHandler } from '.';
+/**
+ * Deletes WordPress posts and comments and sets the auto increment sequence for the
+ * posts and comments tables to 0.
+ *
+ * @private
+ * @internal
+ * @inheritDoc resetData
+ * @example
+ *
+ * <code>
+ * {
+ * 		"step": "resetData"
+ * }
+ * </code>
+ */
+export interface ResetDataStep {
+    step: 'resetData';
+}
+/**
+ * @param playground Playground client.
+ */
+export declare const resetData: StepHandler<ResetDataStep>;

package/lib/steps/run-php-with-options.d.ts

@@ -20,7 +20,7 @@ import { PHPRunOptions } from '../../../../../php-wasm/universal/src/index.ts';
 export interface RunPHPWithOptionsStep {
     step: 'runPHPWithOptions';
     /**
-     * Run options (See /wordpress-playground/api/universal/interface/PHPRunOptions)
+     * Run options (See /wordpress-playground/api/universal/interface/PHPRunOptions/))
      */
     options: PHPRunOptions;
 }

package/lib/steps/run-php.d.ts

@@ -20,5 +20,6 @@ export interface RunPHPStep {
 }
 /**
  * Runs PHP code.
+ * When running WordPress functions, the `code` key must first load [`wp-load.php`](https://github.com/WordPress/WordPress/blob/master/wp-load.php) and start with `"<?php require_once 'wordpress/wp-load.php'; "`.
  */
 export declare const runPHP: StepHandler<RunPHPStep, Promise<PHPResponse>>;

package/lib/steps/site-data.d.ts

@@ -22,8 +22,8 @@ export type SetSiteOptionsStep = {
     options: Record<string, unknown>;
 };
 /**
- * Sets site options. This is equivalent to calling `update_option` for each
- * option in the `options` object.
+ * Sets site options. This is equivalent to calling [`update_option`](https://developer.wordpress.org/reference/functions/update_option/) for each
+ * option in the [`options`](https://developer.wordpress.org/apis/options/#available-options-by-category) object.
  */
 export declare const setSiteOptions: StepHandler<SetSiteOptionsStep>;
 /**
@@ -51,7 +51,7 @@ export interface UpdateUserMetaStep {
     userId: number;
 }
 /**
- * Updates user meta. This is equivalent to calling `update_user_meta` for each
+ * Updates user meta. This is equivalent to calling [`update_user_meta`](https://developer.wordpress.org/reference/functions/update_user_meta/) for each
  * meta value in the `meta` object.
  */
 export declare const updateUserMeta: StepHandler<UpdateUserMetaStep>;

package/lib/steps/wp-cli.d.ts

@@ -21,7 +21,7 @@ export interface WPCLIStep {
     wpCliPath?: string;
 }
 /**
- * Runs PHP code.
+ * Runs PHP code using [WP-CLI](https://developer.wordpress.org/cli/commands/).
  */
 export declare const wpCLI: StepHandler<WPCLIStep, Promise<PHPResponse>>;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wp-playground/blueprints",
-	"version": "0.7.19",
+	"version": "0.9.1",
 	"exports": {
 		".": {
 			"import": "./index.js",
@@ -21,7 +21,7 @@
 		"access": "public",
 		"directory": "../../../dist/packages/playground/blueprints"
 	},
-	"gitHead": "687ec237085853ff5c808814c28be349146a5d1a",
+	"gitHead": "1097764159c71f5fd9f215f46385d1c83428fe01",
 	"engines": {
 		"node": ">=18.18.0",
 		"npm": ">=8.11.0"

package/lib/utils/run-php-with-zip-functions.d.ts

@@ -1,2 +0,0 @@
-import { UniversalPHP } from '../../../../../php-wasm/universal/src/index.ts';
-export declare function runPhpWithZipFunctions(playground: UniversalPHP, code: string): Promise<import('../../../../../php-wasm/universal/src/index.ts').PHPResponse>;