@wp-playground/blueprints 0.6.8 → 0.6.10

package/lib/steps/handlers.d.ts

@@ -13,10 +13,9 @@ export { mkdir } from './mkdir';
 export { rmdir } from './rmdir';
 export { writeFile } from './write-file';
 export { defineSiteUrl } from './define-site-url';
-export { importFile } from './import-file';
+export { importWxr as importWxr } from './import-wxr';
 export { importWordPressFiles } from './import-wordpress-files';
 export { exportWXR } from './export-wxr';
-export { exportWXZ } from './export-wxz';
 export { unzip } from './unzip';
 export { installPlugin } from './install-plugin';
 export { installTheme } from './install-theme';

package/lib/steps/import-wxr.d.ts

@@ -0,0 +1,27 @@
+import { StepHandler } from '.';
+/**
+ * @inheritDoc importWxr
+ * @example
+ *
+ * <code>
+ * {
+ * 		"step": "importWxr",
+ * 		"file": {
+ * 			"resource": "url",
+ * 			"url": "https://your-site.com/starter-content.wxr"
+ * 		}
+ * }
+ * </code>
+ */
+export interface ImportWxrStep<ResourceType> {
+    step: 'importWxr';
+    /** The file to import */
+    file: ResourceType;
+}
+/**
+ * Imports a WXR file into WordPress.
+ *
+ * @param playground Playground client.
+ * @param file The file to import.
+ */
+export declare const importWxr: StepHandler<ImportWxrStep<File>>;

package/lib/steps/index.d.ts

@@ -23,7 +23,7 @@ import { DefineWpConfigConstsStep } from './define-wp-config-consts';
 import { ActivateThemeStep } from './activate-theme';
 import { UnzipStep } from './unzip';
 import { ImportWordPressFilesStep } from './import-wordpress-files';
-import { ImportFileStep } from './import-file';
+import { ImportWxrStep } from './import-wxr';
 import { EnableMultisiteStep } from './enable-multisite';
 import { WPCLIStep } from './wp-cli';
 export type Step = GenericStep<FileReference>;
@@ -38,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 | 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> | WPCLIStep;
-export type { ActivatePluginStep, ActivateThemeStep, 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, WPCLIStep, };
+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> | SetPhpIniEntryStep | 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, SetPhpIniEntryStep, SetSiteOptionsStep, UnzipStep, UpdateUserMetaStep, WriteFileStep, WPCLIStep, };
 /**
  * Progress reporting details.
  */

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

@@ -7,7 +7,7 @@ import { StepHandler } from '.';
  *
  * <code>
  * {
- * 		"step": "wpCLI",
+ * 		"step": "wp-cli",
  * 		"command": "wp post create --post_title='Test post' --post_excerpt='Some content'"
  * }
  * </code>

package/package.json

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

package/schema-readme.md

@@ -5,5 +5,5 @@ Whenever the types are modified, the schema needs to be rebuilt using
 `nx build playground-blueprints` and then committed to the repository.
 
 Unfortunately, it is not auto-rebuilt in `npm run dev` mode as the
-`dts-bundle-generator` utility we use for type rollyps does not support
+`dts-bundle-generator` utility we use for type rollups does not support
 watching for changes.

package/lib/steps/export-wxz.d.ts

@@ -1,9 +0,0 @@
-import { UniversalPHP } from '../../../../../php-wasm/universal/src/index.ts';
-/**
- * Exports the WordPress database as a WXZ file using
- * the export-wxz plugin from https://github.com/akirk/export-wxz.
- *
- * @param playground Playground client
- * @returns WXZ file
- */
-export declare function exportWXZ(playground: UniversalPHP): Promise<File>;

package/lib/steps/import-file.d.ts

@@ -1,29 +0,0 @@
-import { StepHandler } from '.';
-/**
- * @inheritDoc importFile
- * @example
- *
- * <code>
- * {
- * 		"step": "importFile",
- * 		"file": {
- * 			"resource": "url",
- * 			"url": "https://your-site.com/starter-content.wxz"
- * 		}
- * }
- * </code>
- */
-export interface ImportFileStep<ResourceType> {
-    step: 'importFile';
-    /** The file to import */
-    file: ResourceType;
-}
-/**
- * Uploads a file to the WordPress importer and returns the response.
- * Supports both WXR and WXZ files.
- *
- * @see https://github.com/WordPress/wordpress-importer/compare/master...akirk:wordpress-importer:import-wxz.patch
- * @param playground Playground client.
- * @param file The file to import.
- */
-export declare const importFile: StepHandler<ImportFileStep<File>>;