@wp-playground/blueprints 0.9.27 → 0.9.29

package/lib/blueprint.d.ts

@@ -1,6 +1,7 @@
 import { SupportedPHPExtensionBundle, SupportedPHPVersion } from '../../../../php-wasm/universal/src/index.ts';
 import { StepDefinition } from './steps';
 import { FileReference } from './resources';
+export type ExtraLibrary = 'wp-cli';
 export interface Blueprint {
     /**
      * The URL to navigate to after the blueprint has been run.
@@ -31,7 +32,8 @@ export interface Blueprint {
          */
         author: string;
         /**
-         * Relevant categories to help users find your Blueprint in the future Blueprints section on WordPress.org.
+         * Relevant categories to help users find your Blueprint in the future
+         * Blueprints section on WordPress.org.
          */
         categories?: string[];
     };
@@ -54,6 +56,10 @@ export interface Blueprint {
         /** Should boot with support for network request via wp_safe_remote_get? */
         networking?: boolean;
     };
+    /**
+     * Extra libraries to preload into the Playground instance.
+     */
+    extraLibraries?: ExtraLibrary[];
     /**
      * PHP Constants to define on every request
      */

package/lib/compile.d.ts

@@ -2,7 +2,7 @@ import { ProgressTracker } from '../../../../php-wasm/progress/src/index.ts';
 import { Semaphore } from '../../../../php-wasm/util/src/index.ts';
 import { SupportedPHPExtension, SupportedPHPVersion, UniversalPHP } from '../../../../php-wasm/universal/src/index.ts';
 import { StepDefinition } from './steps';
-import { Blueprint } from './blueprint';
+import { Blueprint, ExtraLibrary } from './blueprint';
 export type CompiledStep = (php: UniversalPHP) => Promise<void> | void;
 export interface CompiledBlueprint {
     /** The requested versions of PHP and WordPress for the blueprint */
@@ -16,6 +16,7 @@ export interface CompiledBlueprint {
         /** Should boot with support for network request via wp_safe_remote_get? */
         networking: boolean;
     };
+    extraLibraries: ExtraLibrary[];
     /** The compiled steps for the blueprint */
     run: (playground: UniversalPHP) => Promise<void>;
 }

package/lib/resources.d.ts

@@ -69,7 +69,8 @@ export declare abstract class Resource {
     get isAsync(): boolean;
 }
 /**
- * A `Resource` that represents a file in the VFS (virtual file system) of the playground.
+ * A `Resource` that represents a file in the VFS (virtual file system) of the
+ * playground.
  */
 export declare class VFSResource extends Resource {
     private resource;
@@ -173,7 +174,8 @@ export declare class CorePluginResource extends FetchResource {
  */
 export declare function toDirectoryZipName(rawInput: string): string;
 /**
- * A decorator for a resource that adds functionality such as progress tracking and caching.
+ * A decorator for a resource that adds functionality such as progress tracking
+ * and caching.
  */
 export declare class DecoratedResource<T extends Resource> extends Resource {
     private resource;
@@ -200,7 +202,8 @@ export declare class CachedResource<T extends Resource> extends DecoratedResourc
     resolve(): Promise<File>;
 }
 /**
- * A decorator for a resource that adds concurrency control functionality through a semaphore.
+ * A decorator for a resource that adds concurrency control functionality
+ * through a semaphore.
  */
 export declare class SemaphoreResource<T extends Resource> extends DecoratedResource<T> {
     private readonly semaphore;

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

@@ -13,7 +13,11 @@ import { StepHandler } from '.';
  */
 export interface ActivatePluginStep {
     step: 'activatePlugin';
-    /** Path to the plugin directory as absolute path (/wordpress/wp-content/plugins/plugin-name); or the plugin entry file relative to the plugins directory (plugin-name/plugin-name.php). */
+    /**
+     * Path to the plugin directory as absolute path
+     * (/wordpress/wp-content/plugins/plugin-name); or the plugin entry file
+     * relative to the plugins directory (plugin-name/plugin-name.php).
+     */
     pluginPath: string;
     /** Optional. Plugin name to display in the progress bar. */
     pluginName?: string;

package/lib/steps/request.d.ts

@@ -24,7 +24,8 @@ import { StepHandler } from '.';
 export interface RequestStep {
     step: 'request';
     /**
-     * Request details (See /wordpress-playground/api/universal/interface/PHPRequest)
+     * Request details (See
+     * /wordpress-playground/api/universal/interface/PHPRequest)
      */
     request: PHPRequest;
 }

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

@@ -1,10 +1,5 @@
 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
  *
@@ -18,6 +13,9 @@ export interface ResetDataStep {
     step: 'resetData';
 }
 /**
+ * Deletes WordPress posts and comments and sets the auto increment sequence
+ * for the posts and comments tables to 0.
+ *
  * @param playground Playground client.
  */
 export declare const resetData: StepHandler<ResetDataStep>;

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

@@ -20,7 +20,8 @@ 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

@@ -8,7 +8,9 @@ import { StepHandler } from '.';
  * <code>
  * {
  * 		"step": "runPHP",
- * 		"code": "<?php require_once 'wordpress/wp-load.php'; wp_insert_post(array('post_title' => 'wp-load.php required for WP functionality', 'post_status' => 'publish')); ?>"
+ * 		"code": "<?php require_once 'wordpress/wp-load.php';
+ * 		wp_insert_post(array('post_title' => 'wp-load.php required for WP
+ * 		functionality', 'post_status' => 'publish')); ?>"
  * }
  * </code>
  */

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

@@ -8,7 +8,8 @@ import { StepHandler } from '.';
  * <code>
  * {
  * 		"step": "wp-cli",
- * 		"command": "wp post create --post_title='Test post' --post_excerpt='Some content'"
+ * 		"command": "wp post create --post_title='Test post' --post_excerpt='Some
+ * 		content'"
  * }
  * </code>
  */
@@ -26,8 +27,8 @@ export interface WPCLIStep {
 export declare const wpCLI: StepHandler<WPCLIStep, Promise<PHPResponse>>;
 /**
  * Naive shell command parser.
- * Ensures that commands like `wp option set blogname "My blog name"` are split into
- * `['wp', 'option', 'set', 'blogname', 'My blog name']` instead of
+ * Ensures that commands like `wp option set blogname "My blog name"` are split
+ * into `['wp', 'option', 'set', 'blogname', 'My blog name']` instead of
  * `['wp', 'option', 'set', 'blogname', 'My', 'blog', 'name']`.
  *
  * @param command

package/lib/utils/flatten-directory.d.ts

@@ -1,8 +1,8 @@
 import type { UniversalPHP } from '../../../../../php-wasm/universal/src/index.ts';
 /**
  * Flattens a directory.
- * If the directory contains only one file, it will be moved to the parent directory.
- * Otherwise, the directory will be renamed to the default name.
+ * If the directory contains only one file, it will be moved to the parent
+ * directory. Otherwise, the directory will be renamed to the default name.
  *
  * @param php Playground client.
  * @param directoryPath The directory to flatten.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wp-playground/blueprints",
-  "version": "0.9.27",
+  "version": "0.9.29",
   "exports": {
     ".": {
       "import": "./index.js",
@@ -21,7 +21,7 @@
     "access": "public",
     "directory": "../../../dist/packages/playground/blueprints"
   },
-  "gitHead": "a0856a3e94aec6e95add6e828d66cc90ff47ff95",
+  "gitHead": "79ef61d98407b1a90f622f6bef8f91001c568d00",
   "engines": {
     "node": ">=18.18.0",
     "npm": ">=8.11.0"
@@ -30,14 +30,14 @@
     "ajv": "8.12.0",
     "comlink": "^4.4.1",
     "ini": "4.1.2",
-    "@php-wasm/node-polyfills": "0.9.27",
-    "@php-wasm/universal": "0.9.27",
-    "@wp-playground/common": "0.9.27",
-    "@php-wasm/node": "0.9.27",
-    "@php-wasm/progress": "0.9.27",
-    "@php-wasm/util": "0.9.27",
-    "@php-wasm/logger": "0.9.27",
-    "@wp-playground/wordpress": "0.9.27",
-    "@php-wasm/scopes": "0.9.27"
+    "@php-wasm/node-polyfills": "0.9.29",
+    "@php-wasm/universal": "0.9.29",
+    "@wp-playground/common": "0.9.29",
+    "@php-wasm/node": "0.9.29",
+    "@php-wasm/progress": "0.9.29",
+    "@php-wasm/util": "0.9.29",
+    "@php-wasm/logger": "0.9.29",
+    "@wp-playground/wordpress": "0.9.29",
+    "@php-wasm/scopes": "0.9.29"
   }
 }