@wp-playground/blueprints 1.0.28 → 1.0.29

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.
@@ -49,7 +49,7 @@ export interface InstallPluginStep<FileResource, DirectoryResource> extends Pick
49
49
  */
50
50
  pluginData: FileResource | DirectoryResource;
51
51
  /**
52
- * @deprecated. Use `pluginData` instead.
52
+ * @deprecated. Use 'pluginData' instead.
53
53
  */
54
54
  pluginZipFile?: FileResource;
55
55
  /**
@@ -32,7 +32,7 @@ export interface InstallThemeStep<FileResource, DirectoryResource> extends Pick<
32
32
  */
33
33
  themeData: FileResource | DirectoryResource;
34
34
  /**
35
- * @deprecated. Use `themeData` instead.
35
+ * @deprecated. Use 'themeData' instead.
36
36
  */
37
37
  themeZipFile?: FileResource;
38
38
  /**
@@ -26,11 +26,22 @@ export interface WriteFilesStep<DirectoryResource> {
26
26
  step: 'writeFiles';
27
27
  /** The path of the file to write to */
28
28
  writeToPath: string;
29
- /** The data to write */
29
+ /**
30
+ * The 'filesTree' defines the directory structure, supporting 'literal:directory' or
31
+ * 'git:directory' types. The 'name' represents the root directory, while 'files' is an object
32
+ * where keys are file paths, and values contain either file content as a string or nested objects
33
+ * for subdirectories.
34
+ */
30
35
  filesTree: DirectoryResource;
31
36
  }
32
37
  /**
33
38
  * Writes multiple files to a specified directory in the Playground
34
39
  * filesystem.
40
+ * ```
41
+ * my-plugin/
42
+ * ├── index.php
43
+ * └── public/
44
+ * └── style.css
45
+ * ```
35
46
  */
36
47
  export declare const writeFiles: StepHandler<WriteFilesStep<Directory>>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wp-playground/blueprints",
3
- "version": "1.0.28",
3
+ "version": "1.0.29",
4
4
  "exports": {
5
5
  ".": {
6
6
  "import": "./index.js",
@@ -21,7 +21,7 @@
21
21
  "access": "public",
22
22
  "directory": "../../../dist/packages/playground/blueprints"
23
23
  },
24
- "gitHead": "ed7171a91717c70dd7162e3d93283f66d21c001d",
24
+ "gitHead": "173e69f62e1b43bd7353b875054bb1ef5e394de8",
25
25
  "engines": {
26
26
  "node": ">=18.18.0",
27
27
  "npm": ">=8.11.0"
@@ -48,15 +48,15 @@
48
48
  "wasm-feature-detect": "1.8.0",
49
49
  "ws": "8.18.0",
50
50
  "yargs": "17.7.2",
51
- "@php-wasm/node-polyfills": "1.0.28",
52
- "@php-wasm/universal": "1.0.28",
53
- "@wp-playground/common": "1.0.28",
54
- "@php-wasm/node": "1.0.28",
55
- "@php-wasm/progress": "1.0.28",
56
- "@php-wasm/util": "1.0.28",
57
- "@php-wasm/logger": "1.0.28",
58
- "@wp-playground/storage": "1.0.28",
59
- "@php-wasm/web": "1.0.28",
60
- "@wp-playground/wordpress": "1.0.28"
51
+ "@php-wasm/node-polyfills": "1.0.29",
52
+ "@php-wasm/universal": "1.0.29",
53
+ "@wp-playground/common": "1.0.29",
54
+ "@php-wasm/node": "1.0.29",
55
+ "@php-wasm/progress": "1.0.29",
56
+ "@php-wasm/util": "1.0.29",
57
+ "@php-wasm/logger": "1.0.29",
58
+ "@wp-playground/storage": "1.0.29",
59
+ "@php-wasm/web": "1.0.29",
60
+ "@wp-playground/wordpress": "1.0.29"
61
61
  }
62
62
  }