@wp-playground/blueprints 0.9.26 → 0.9.28

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.
@@ -54,6 +55,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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wp-playground/blueprints",
-  "version": "0.9.26",
+  "version": "0.9.28",
   "exports": {
     ".": {
       "import": "./index.js",
@@ -21,7 +21,7 @@
     "access": "public",
     "directory": "../../../dist/packages/playground/blueprints"
   },
-  "gitHead": "03453bf7ca06857dc31c496ded43ca2857023021",
+  "gitHead": "15d87898b0a7f8a0cf322425923336df1d84843b",
   "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.26",
-    "@php-wasm/universal": "0.9.26",
-    "@wp-playground/common": "0.9.26",
-    "@php-wasm/node": "0.9.26",
-    "@php-wasm/progress": "0.9.26",
-    "@php-wasm/util": "0.9.26",
-    "@php-wasm/logger": "0.9.26",
-    "@wp-playground/wordpress": "0.9.26",
-    "@php-wasm/scopes": "0.9.26"
+    "@php-wasm/node-polyfills": "0.9.28",
+    "@php-wasm/universal": "0.9.28",
+    "@wp-playground/common": "0.9.28",
+    "@php-wasm/node": "0.9.28",
+    "@php-wasm/progress": "0.9.28",
+    "@php-wasm/util": "0.9.28",
+    "@php-wasm/logger": "0.9.28",
+    "@wp-playground/wordpress": "0.9.28",
+    "@php-wasm/scopes": "0.9.28"
   }
 }

package/schema-readme.md

@@ -1,9 +1,13 @@
-The JSON schema stored in this directory is used to validate the Blueprints
-and is autogenerated from the Blueprints TypeScript types.
+The JSON schema stored in this directory describes how to validate
+the Blueprints and is autogenerated from the Blueprints TypeScript types.
 
-Whenever the types are modified, the schema needs to be rebuilt using
-`nx build playground-blueprints` and then committed to the repository.
+The Blueprint schema validator stored in this directory is used to validate
+Blueprints and is autogenerated from the Blueprints JSON schema.
 
-Unfortunately, it is not auto-rebuilt in `npm run dev` mode as the
-`dts-bundle-generator` utility we use for type rollups does not support
+Whenever the types are modified, the schema and validator need to be
+rebuilt using `nx build playground-blueprints` and then committed to
+the repository.
+
+Unfortunately, they are not auto-rebuilt in `npm run dev` mode as the
+`dts-bundle-generator` utility we use for type rollyps does not support
 watching for changes.