@wp-playground/blueprints 0.5.2 → 0.5.3

package/lib/steps/define-wp-config-consts.d.ts

@@ -1,4 +1,5 @@
 import { StepHandler } from '.';
+import { UniversalPHP } from '../../../../../php-wasm/universal/src/index.ts';
 /**
  * @inheritDoc defineWpConfigConsts
  * @hasRunnableExample
@@ -17,6 +18,20 @@ export interface DefineWpConfigConstsStep {
     step: 'defineWpConfigConsts';
     /** The constants to define */
     consts: Record<string, unknown>;
+    /**
+     * The method of defining the constants. Possible values are:
+     *
+     * - rewrite-wp-config: Default. Rewrites the wp-config.php file to
+     *                      explicitly call define() with the requested
+     *                      name and value. This method alters the file
+     *                      on the disk, but it doesn't conflict with
+     *                      existing define() calls in wp-config.php.
+     * - define-before-run: Defines the constant before running the requested
+     *                      script. It doesn't alter any files on the disk, but
+     *                      constants defined this way may conflict with existing
+     *                      define() calls in wp-config.php.
+     */
+    method?: 'rewrite-wp-config' | 'define-before-run';
     /**
      * @deprecated This option is noop and will be removed in a future version.
      * This option is only kept in here to avoid breaking Blueprint schema validation
@@ -25,7 +40,7 @@ export interface DefineWpConfigConstsStep {
     virtualize?: boolean;
 }
 /**
- * Defines constants to be used in wp-config.php file.
+ * Defines constants in a wp-config.php file.
  *
  * This step can be called multiple times, and the constants will be merged.
  *
@@ -33,3 +48,5 @@ export interface DefineWpConfigConstsStep {
  * @param wpConfigConst
  */
 export declare const defineWpConfigConsts: StepHandler<DefineWpConfigConstsStep>;
+export declare function defineBeforeRun(playground: UniversalPHP, consts: Record<string, unknown>): Promise<void>;
+export declare function rewriteDefineCalls(playground: UniversalPHP, phpCode: string, consts: Record<string, unknown>): Promise<string>;

package/lib/steps/index.d.ts

@@ -32,7 +32,7 @@ export type StepDefinition = Step & {
         caption?: string;
     };
 };
-export { wpContentFilesExcludedFromExport } from './common';
+export { wpContentFilesExcludedFromExport } from '../utils/wp-content-files-excluded-from-exports';
 /**
  * If you add a step here, make sure to also
  * add it to the exports below.

package/lib/utils/flatten-directory.d.ts

@@ -0,0 +1,12 @@
+import type { UniversalPHP } from '../../../../../php-wasm/universal/src/index.ts';
+/**
+ * Flattens a directory.
+ * If the directory contains only one file, it will be moved to the parent directory.
+ * Otherwise, the directory will be renamed to the default name.
+ *
+ * @param php Playground client.
+ * @param directoryPath The directory to flatten.
+ * @param defaultName The name to use if the directory contains only one file.
+ * @returns The final path of the directory.
+ */
+export declare function flattenDirectory(php: UniversalPHP, directoryPath: string, defaultName: string): Promise<string>;

package/lib/utils/run-php-with-zip-functions.d.ts

@@ -0,0 +1,2 @@
+import { UniversalPHP } from '../../../../../php-wasm/universal/src/index.ts';
+export declare function runPhpWithZipFunctions(playground: UniversalPHP, code: string): Promise<import('../../../../../php-wasm/universal/src/index.ts').PHPResponse>;

package/lib/utils/update-file.d.ts

@@ -0,0 +1,12 @@
+import type { UniversalPHP } from '../../../../../php-wasm/universal/src/index.ts';
+type PatchFileCallback = (contents: string) => string | Uint8Array;
+/**
+ * Updates a file in the PHP filesystem.
+ * If the file does not exist, it will be created.
+ *
+ * @param php The PHP instance.
+ * @param path The path to the file.
+ * @param callback A function that maps the old file contents to the new file contents.
+ */
+export declare function updateFile(php: UniversalPHP, path: string, callback: PatchFileCallback): Promise<void>;
+export {};

package/lib/utils/wp-content-files-excluded-from-exports.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Used by the export step to exclude the Playground-specific files
+ * from the zip file. Keep it in sync with the list of files created
+ * by WordPressPatcher.
+ */
+export declare const wpContentFilesExcludedFromExport: string[];

package/lib/utils/zip-name-to-human-name.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Converts a zip file name to a nice, human-readable name.
+ *
+ * @example	`hello-dolly.zip` -> `Hello dolly`
+ *
+ * @param zipName A zip filename.
+ * @returns A nice, human-readable name.
+ */
+export declare function zipNameToHumanName(zipName: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wp-playground/blueprints",
-	"version": "0.5.2",
+	"version": "0.5.3",
 	"exports": {
 		".": {
 			"import": "./index.js",
@@ -21,9 +21,9 @@
 		"access": "public",
 		"directory": "../../../dist/packages/playground/blueprints"
 	},
-	"gitHead": "630288218e307d9a5e93d92b428ed30ae6a5fa2f",
+	"gitHead": "3d0f04ee35f15e9a7906818352f6ccdd34f46fbe",
 	"engines": {
-		"node": ">=16.15.1",
+		"node": ">=18.18.2",
 		"npm": ">=8.11.0"
 	}
 }

package/lib/steps/common.d.ts

@@ -1,13 +0,0 @@
-import type { UniversalPHP } from '../../../../../php-wasm/universal/src/index.ts';
-/**
- * Used by the export step to exclude the Playground-specific files
- * from the zip file. Keep it in sync with the list of files created
- * by WordPressPatcher.
- */
-export declare const wpContentFilesExcludedFromExport: string[];
-export declare function zipNameToHumanName(zipName: string): string;
-type PatchFileCallback = (contents: string) => string | Uint8Array;
-export declare function updateFile(php: UniversalPHP, path: string, callback: PatchFileCallback): Promise<void>;
-export declare function fileToUint8Array(file: File): Promise<Uint8Array>;
-export declare function runPhpWithZipFunctions(playground: UniversalPHP, code: string): Promise<import('../../../../../php-wasm/universal/src/index.ts').PHPResponse>;
-export {};