@wp-playground/client 0.6.9 → 0.6.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/index.cjs +31 -14
  2. package/index.d.ts +13 -23
  3. package/index.js +1033 -996
  4. package/package.json +2 -2
package/index.d.ts CHANGED
@@ -726,7 +726,7 @@ export declare const LatestSupportedPHPVersion: "8.3";
726
726
  export declare const SupportedPHPVersionsList: string[];
727
727
  export type SupportedPHPVersion = (typeof SupportedPHPVersions)[number];
728
728
  export type SupportedPHPExtension = "iconv" | "mbstring" | "xml-bundle" | "gd";
729
- export type SupportedPHPExtensionBundle = "kitchen-sink";
729
+ export type SupportedPHPExtensionBundle = "kitchen-sink" | "light";
730
730
  export type RewriteRule = {
731
731
  match: RegExp;
732
732
  replacement: string;
@@ -1792,11 +1792,11 @@ export declare const unzip: StepHandler<UnzipStep<File>>;
1792
1792
  *
1793
1793
  * <code>
1794
1794
  * {
1795
- * "step": "importWordPressFilesStep",
1795
+ * "step": "importWordPressFiles",
1796
1796
  * "wordPressFilesZip": {
1797
- * "resource": "fetch",
1798
- * "url": "https://mysite.com/import.zip"
1799
- * }
1797
+ * "resource": "url",
1798
+ * "url": "https://mysite.com/import.zip"
1799
+ * }
1800
1800
  * }
1801
1801
  * </code>
1802
1802
  */
@@ -1827,33 +1827,31 @@ export interface ImportWordPressFilesStep<ResourceType> {
1827
1827
  */
1828
1828
  export declare const importWordPressFiles: StepHandler<ImportWordPressFilesStep<File>>;
1829
1829
  /**
1830
- * @inheritDoc importFile
1830
+ * @inheritDoc importWxr
1831
1831
  * @example
1832
1832
  *
1833
1833
  * <code>
1834
1834
  * {
1835
- * "step": "importFile",
1835
+ * "step": "importWxr",
1836
1836
  * "file": {
1837
1837
  * "resource": "url",
1838
- * "url": "https://your-site.com/starter-content.wxz"
1838
+ * "url": "https://your-site.com/starter-content.wxr"
1839
1839
  * }
1840
1840
  * }
1841
1841
  * </code>
1842
1842
  */
1843
- export interface ImportFileStep<ResourceType> {
1844
- step: "importFile";
1843
+ export interface ImportWxrStep<ResourceType> {
1844
+ step: "importWxr";
1845
1845
  /** The file to import */
1846
1846
  file: ResourceType;
1847
1847
  }
1848
1848
  /**
1849
- * Uploads a file to the WordPress importer and returns the response.
1850
- * Supports both WXR and WXZ files.
1849
+ * Imports a WXR file into WordPress.
1851
1850
  *
1852
- * @see https://github.com/WordPress/wordpress-importer/compare/master...akirk:wordpress-importer:import-wxz.patch
1853
1851
  * @param playground Playground client.
1854
1852
  * @param file The file to import.
1855
1853
  */
1856
- export declare const importFile: StepHandler<ImportFileStep<File>>;
1854
+ export declare const importWxr: StepHandler<ImportWxrStep<File>>;
1857
1855
  /**
1858
1856
  * @inheritDoc enableMultisite
1859
1857
  * @hasRunnableExample
@@ -1918,7 +1916,7 @@ export type StepDefinition = Step & {
1918
1916
  * If you add a step here, make sure to also
1919
1917
  * add it to the exports below.
1920
1918
  */
1921
- 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;
1919
+ 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;
1922
1920
  /**
1923
1921
  * Progress reporting details.
1924
1922
  */
@@ -1939,14 +1937,6 @@ php: UniversalPHP, args: Omit<S, "step">, progressArgs?: StepProgress) => Return
1939
1937
  * @returns WXR file
1940
1938
  */
1941
1939
  export declare function exportWXR(playground: UniversalPHP): Promise<File>;
1942
- /**
1943
- * Exports the WordPress database as a WXZ file using
1944
- * the export-wxz plugin from https://github.com/akirk/export-wxz.
1945
- *
1946
- * @param playground Playground client
1947
- * @returns WXZ file
1948
- */
1949
- export declare function exportWXZ(playground: UniversalPHP): Promise<File>;
1950
1940
  export interface ZipWpContentOptions {
1951
1941
  /**
1952
1942
  * @private