@wp-playground/blueprints 0.1.29 → 0.1.30

package/src/lib/steps/login.ts

@@ -1,11 +1,10 @@
-import { UniversalPHP } from '@php-wasm/universal';
-import { BaseStep } from '.';
+import { StepHandler } from '.';
 
-export interface LoginStep extends BaseStep {
+export type LoginStep = {
 	step: 'login';
 	username?: string;
 	password?: string;
-}
+};
 
 /**
  * Logs in to the Playground.
@@ -16,11 +15,12 @@ export interface LoginStep extends BaseStep {
  * @param user The user to log in as. Defaults to 'admin'.
  * @param password The password to log in with. Defaults to 'password'.
  */
-export async function login(
-	playground: UniversalPHP,
-	user = 'admin',
-	password = 'password'
-) {
+export const login: StepHandler<LoginStep> = async (
+	playground,
+	{ username = 'admin', password = 'password' } = {},
+	progress
+) => {
+	progress?.tracker.setCaption(progress?.initialCaption || 'Logging in');
 	await playground.request({
 		url: '/wp-login.php',
 	});
@@ -29,9 +29,9 @@ export async function login(
 		url: '/wp-login.php',
 		method: 'POST',
 		formData: {
-			log: user,
+			log: username,
 			pwd: password,
 			rememberme: 'forever',
 		},
 	});
-}
+};

package/src/lib/steps/run-wp-installation-wizard.ts

@@ -1,7 +1,6 @@
-import { UniversalPHP } from '@php-wasm/universal';
-import { BaseStep } from '.';
+import { StepHandler } from '.';
 
-export interface RunWpInstallationWizardStep extends BaseStep {
+export interface RunWpInstallationWizardStep {
 	step: 'runWpInstallationWizard';
 	options: WordPressInstallationOptions;
 }
@@ -17,10 +16,9 @@ export interface WordPressInstallationOptions {
  * @param playground The playground client.
  * @param options Installation options.
  */
-export async function runWpInstallationWizard(
-	playground: UniversalPHP,
-	options: WordPressInstallationOptions
-) {
+export const runWpInstallationWizard: StepHandler<
+	RunWpInstallationWizardStep
+> = async (playground, { options }) => {
 	await playground.request({
 		url: '/wp-admin/install.php?step=2',
 		method: 'POST',
@@ -37,4 +35,4 @@ export async function runWpInstallationWizard(
 			admin_email: 'admin@localhost.com',
 		},
 	});
-}
+};

package/src/lib/steps/site-data.ts

@@ -1,24 +1,16 @@
-import { PHPResponse, UniversalPHP } from '@php-wasm/universal';
+import { PHPResponse } from '@php-wasm/universal';
 import { phpVar } from '@php-wasm/util';
-import { BaseStep } from '.';
+import { StepHandler } from '.';
 
-export type SiteOptions = Record<string, unknown>;
-
-export interface SetSiteOptionsStep extends BaseStep {
+export type SetSiteOptionsStep = {
 	step: 'setSiteOptions';
-	options: SiteOptions;
-}
-
-export interface UpdateUserMetaStep extends BaseStep {
-	step: 'updateUserMeta';
-	meta: UserMeta;
-	userId: number;
-}
+	options: Record<string, unknown>;
+};
 
-export async function setSiteOptions(
-	client: UniversalPHP,
-	options: SiteOptions
-) {
+export const setSiteOptions: StepHandler<SetSiteOptionsStep> = async (
+	client,
+	options
+) => {
 	const result = await client.run({
 		code: `<?php
 	include 'wordpress/wp-load.php';
@@ -30,14 +22,17 @@ export async function setSiteOptions(
 	`,
 	});
 	assertSuccess(result);
-}
+};
 
-export type UserMeta = Record<string, unknown>;
-export async function updateUserMeta(
-	client: UniversalPHP,
-	meta: UserMeta,
-	userId: number
-) {
+export interface UpdateUserMetaStep {
+	step: 'updateUserMeta';
+	meta: Record<string, unknown>;
+	userId: number;
+}
+export const updateUserMeta: StepHandler<UpdateUserMetaStep> = async (
+	client,
+	{ meta, userId }
+) => {
 	const result = await client.run({
 		code: `<?php
 	include 'wordpress/wp-load.php';
@@ -49,7 +44,7 @@ export async function updateUserMeta(
 	`,
 	});
 	assertSuccess(result);
-}
+};
 
 async function assertSuccess(result: PHPResponse) {
 	if (result.text !== 'Success') {

package/src/lib/run.ts

@@ -1,154 +0,0 @@
-import { UniversalPHP } from '@php-wasm/universal';
-import {
-	activatePlugin,
-	installPlugin,
-	installTheme,
-	login,
-	replaceSite,
-	setSiteOptions,
-	submitImporterForm,
-	updateUserMeta,
-} from './steps';
-import { zipNameToHumanName } from './steps/common';
-import { unzip } from './steps/import-export';
-import { CompiledBlueprint, CompiledStep } from './compile';
-import { Resource } from './resources';
-
-export async function runBlueprintSteps(
-	compiledBlueprint: CompiledBlueprint,
-	playground: UniversalPHP
-) {
-	// Start fetching resources early
-	for (const { resource } of compiledBlueprint.resources) {
-		resource.resolve();
-	}
-
-	// Run all parsed steps
-	for (const step of compiledBlueprint.steps) {
-		await runBlueprintStep(step, playground);
-	}
-}
-
-async function runBlueprintStep(step: CompiledStep, playground: UniversalPHP) {
-	step.progress.fillSlowly();
-
-	const args = step.args;
-	switch (args.step) {
-		case 'installPlugin': {
-			const name = zipNameToHumanName(args.pluginZipFile.name);
-			step.progress.setCaption(`Installing the ${name} plugin`);
-			try {
-				await installPlugin(
-					playground,
-					await args.pluginZipFile.resolve(),
-					args.options
-				);
-			} catch (error) {
-				console.error(
-					`Proceeding without the ${name} plugin. Could not install it in wp-admin. ` +
-						`The original error was: ${error}`
-				);
-				console.error(error);
-			}
-			break;
-		}
-		case 'installTheme': {
-			const name = zipNameToHumanName(args.themeZipFile.name);
-			step.progress.setCaption(`Installing the ${name} theme`);
-			try {
-				await installTheme(
-					playground,
-					await args.themeZipFile.resolve(),
-					args.options
-				);
-			} catch (error) {
-				console.error(
-					`Proceeding without the ${name} theme. Could not install it in wp-admin. ` +
-						`The original error was: ${error}`
-				);
-				console.error(error);
-			}
-			break;
-		}
-		case 'login':
-			step.progress.setCaption(
-				`Logging in${args.username ? ' as ' + args.username : ''}`
-			);
-			await login(playground, args.username, args.password);
-			break;
-		case 'activatePlugin':
-			step.progress.setCaption(`Activating ${args.plugin}`);
-			await activatePlugin(playground, args.plugin);
-			break;
-		case 'replaceSite':
-			await replaceSite(playground, await args.fullSiteZip.resolve());
-			break;
-		case 'rm':
-			await playground.unlink(args.path);
-			break;
-		case 'rmdir':
-			await playground.rmdir(args.path);
-			break;
-		case 'cp':
-			await playground.writeFile(
-				args.toPath,
-				await playground.readFileAsBuffer(args.fromPath)
-			);
-			break;
-		case 'mv':
-			await playground.mv(args.fromPath, args.toPath);
-			break;
-		case 'mkdir':
-			await playground.mkdirTree(args.path);
-			break;
-		case 'importFile':
-			await submitImporterForm(playground, await args.file.resolve());
-			break;
-		case 'setPhpIniEntry':
-			await playground.setPhpIniEntry(args.key, args.value);
-			break;
-		case 'setSiteOptions':
-			await setSiteOptions(playground, args.options);
-			break;
-		case 'updateUserMeta':
-			await updateUserMeta(playground, args.meta, args.userId);
-			break;
-		case 'request':
-			await playground.request(args.request);
-			break;
-		case 'runPHP': {
-			await playground.run({
-				code: args.code,
-			});
-			break;
-		}
-		case 'runPHPWithOptions':
-			await playground.run(args.options);
-			break;
-		case 'writeFile':
-			await playground.writeFile(
-				args.path,
-				args.data instanceof Resource
-					? await fileToUint8Array(await args.data.resolve())
-					: args.data
-			);
-			break;
-		case 'unzip':
-			await unzip(playground, args.zipPath, args.extractToPath);
-			break;
-		default:
-			throw new Error(`Invalid step: ${step.args.step}`);
-	}
-	step.progress.finish();
-}
-
-function fileToUint8Array(file: File) {
-	return new Promise<Uint8Array>((resolve, reject) => {
-		const reader = new FileReader();
-		reader.onload = () => {
-			resolve(new Uint8Array(reader.result as ArrayBuffer));
-		};
-		reader.onerror = reject;
-		reader.readAsArrayBuffer(file);
-	});
-}