@wp-playground/blueprints 0.5.5 → 0.6.0

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

@@ -0,0 +1,24 @@
+import { StepHandler } from '.';
+/**
+ * @inheritDoc enableMultisite
+ * @hasRunnableExample
+ * @example
+ *
+ * <code>
+ * {
+ * 		"step": "enableMultisite",
+ * }
+ * </code>
+ */
+export interface EnableMultisiteStep {
+    step: 'enableMultisite';
+}
+/**
+ * Defines constants in a wp-config.php file.
+ *
+ * This step can be called multiple times, and the constants will be merged.
+ *
+ * @param playground The playground client.
+ * @param enableMultisite
+ */
+export declare const enableMultisite: StepHandler<EnableMultisiteStep>;

package/lib/steps/handlers.d.ts

@@ -6,6 +6,7 @@ export { runPHPWithOptions } from './run-php-with-options';
 export { runSql } from './run-sql';
 export { setPhpIniEntry } from './set-php-ini-entry';
 export { request } from './request';
+export { enableMultisite } from './enable-multisite';
 export { cp } from './cp';
 export { mv } from './mv';
 export { rm } from './rm';

package/lib/steps/index.d.ts

@@ -25,6 +25,7 @@ import { ActivateThemeStep } from './activate-theme';
 import { UnzipStep } from './unzip';
 import { ImportWordPressFilesStep } from './import-wordpress-files';
 import { ImportFileStep } from './import-file';
+import { EnableMultisiteStep } from './enable-multisite';
 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 | ApplyWordPressPatchesStep | CpStep | DefineWpConfigConstsStep | DefineSiteUrlStep | ImportFileStep<Resource> | ImportWordPressFilesStep<Resource> | InstallPluginStep<Resource> | InstallThemeStep<Resource> | LoginStep | MkdirStep | MvStep | RequestStep | RmStep | RmdirStep | RunPHPStep | RunPHPWithOptionsStep | RunWpInstallationWizardStep | RunSqlStep<Resource> | SetPhpIniEntryStep | SetSiteOptionsStep | UnzipStep | UpdateUserMetaStep | WriteFileStep<Resource>;
-export type { ActivatePluginStep, ActivateThemeStep, ApplyWordPressPatchesStep, CpStep, DefineWpConfigConstsStep, DefineSiteUrlStep, ImportFileStep, ImportWordPressFilesStep, InstallPluginStep, InstallPluginOptions, InstallThemeStep, InstallThemeOptions, LoginStep, MkdirStep, MvStep, RequestStep, RmStep, RmdirStep, RunPHPStep, RunPHPWithOptionsStep, RunWpInstallationWizardStep, RunSqlStep, WordPressInstallationOptions, SetPhpIniEntryStep, SetSiteOptionsStep, UnzipStep, UpdateUserMetaStep, WriteFileStep, };
+export type GenericStep<Resource> = ActivatePluginStep | ActivateThemeStep | ApplyWordPressPatchesStep | CpStep | DefineWpConfigConstsStep | DefineSiteUrlStep | EnableMultisiteStep | ImportFileStep<Resource> | ImportWordPressFilesStep<Resource> | InstallPluginStep<Resource> | InstallThemeStep<Resource> | LoginStep | MkdirStep | MvStep | RequestStep | RmStep | RmdirStep | RunPHPStep | RunPHPWithOptionsStep | RunWpInstallationWizardStep | RunSqlStep<Resource> | SetPhpIniEntryStep | SetSiteOptionsStep | UnzipStep<Resource> | UpdateUserMetaStep | WriteFileStep<Resource>;
+export type { ActivatePluginStep, ActivateThemeStep, ApplyWordPressPatchesStep, CpStep, DefineWpConfigConstsStep, DefineSiteUrlStep, EnableMultisiteStep, ImportFileStep, ImportWordPressFilesStep, InstallPluginStep, InstallPluginOptions, InstallThemeStep, InstallThemeOptions, LoginStep, MkdirStep, MvStep, RequestStep, RmStep, RmdirStep, RunPHPStep, RunPHPWithOptionsStep, RunWpInstallationWizardStep, RunSqlStep, WordPressInstallationOptions, SetPhpIniEntryStep, SetSiteOptionsStep, UnzipStep, UpdateUserMetaStep, WriteFileStep, };
 /**
  * Progress reporting details.
  */
@@ -46,8 +47,8 @@ export type StepProgress = {
     tracker: ProgressTracker;
     initialCaption?: string;
 };
-export type StepHandler<S extends GenericStep<File>> = (
+export type StepHandler<S extends GenericStep<File>, Return = any> = (
 /**
  * A PHP instance or Playground client.
  */
-php: UniversalPHP, args: Omit<S, 'step'>, progressArgs?: StepProgress) => any;
+php: UniversalPHP, args: Omit<S, 'step'>, progressArgs?: StepProgress) => Return;

package/lib/steps/request.d.ts

@@ -1,4 +1,4 @@
-import { PHPRequest } from '../../../../../php-wasm/universal/src/index.ts';
+import { PHPRequest, PHPResponse } from '../../../../../php-wasm/universal/src/index.ts';
 import { StepHandler } from '.';
 /**
  * @inheritDoc request
@@ -30,4 +30,4 @@ export interface RequestStep {
 /**
  * Sends a HTTP request to the Playground.
  */
-export declare const request: StepHandler<RequestStep>;
+export declare const request: StepHandler<RequestStep, Promise<PHPResponse>>;

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

@@ -1,3 +1,4 @@
+import { PHPResponse } from '../../../../../php-wasm/universal/src/index.ts';
 import { StepHandler } from '.';
 /**
  * @inheritDoc runPHP
@@ -20,4 +21,4 @@ export interface RunPHPStep {
 /**
  * Runs PHP code.
  */
-export declare const runPHP: StepHandler<RunPHPStep>;
+export declare const runPHP: StepHandler<RunPHPStep, Promise<PHPResponse>>;

package/lib/steps/unzip.d.ts

@@ -6,15 +6,23 @@ import { StepHandler } from '.';
  * <code>
  * {
  * 		"step": "unzip",
- * 		"zipPath": "/wordpress/data.zip",
+ * 		"zipFile": {
+ * 			"resource": "vfs",
+ * 			"path": "/wordpress/data.zip"
+ * 		},
  * 		"extractToPath": "/wordpress"
  * }
  * </code>
  */
-export interface UnzipStep {
+export interface UnzipStep<ResourceType> {
     step: 'unzip';
     /** The zip file to extract */
-    zipPath: string;
+    zipFile?: ResourceType;
+    /**
+     * The path of the zip file to extract
+     * @deprecated Use zipFile instead.
+     */
+    zipPath?: string;
     /** The path to extract the zip file to */
     extractToPath: string;
 }
@@ -25,4 +33,4 @@ export interface UnzipStep {
  * @param zipPath The zip file to unzip.
  * @param extractTo The directory to extract the zip file to.
  */
-export declare const unzip: StepHandler<UnzipStep>;
+export declare const unzip: StepHandler<UnzipStep<File>>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wp-playground/blueprints",
-	"version": "0.5.5",
+	"version": "0.6.0",
 	"exports": {
 		".": {
 			"import": "./index.js",
@@ -21,7 +21,7 @@
 		"access": "public",
 		"directory": "../../../dist/packages/playground/blueprints"
 	},
-	"gitHead": "1ec8131ad189a9d77ec1ecbfdf0f82abb6aeb96a",
+	"gitHead": "3f137306ec8e3b10ec0674a1fe69ee43349edb4a",
 	"engines": {
 		"node": ">=18.18.2",
 		"npm": ">=8.11.0"