@wordpress/build 0.2.1-next.2f1c7c01b.0 → 0.3.0

package/src/php-generator.mjs

@@ -9,7 +9,6 @@ import { fileURLToPath } from 'url';
  * Internal dependencies
  */
 import { getPackageInfoFromFile } from './package-utils.mjs';
-import { getAllRoutes, getRouteFiles } from './route-utils.mjs';
 
 const __dirname = path.dirname( fileURLToPath( import.meta.url ) );
 
@@ -41,133 +40,57 @@ export async function getPhpReplacements( rootDir ) {
 }
 
 /**
- * Generate a PHP file from a template with replacements.
+ * Apply template replacements to a template string.
  *
- * @param {string}                 templateName Template file name.
- * @param {string}                 outputPath   Full output path.
+ * @param {string}                 template     Template string with placeholders.
  * @param {Record<string, string>} replacements Replacements object (e.g. {'{{PREFIX}}': 'gutenberg'}).
+ * @return {string} Template with replacements applied.
  */
-export async function generatePhpFromTemplate(
-	templateName,
-	outputPath,
-	replacements
-) {
-	// Templates directory
-	const templatesDir = path.join( __dirname, '..', 'templates' );
-
-	// Read template
-	const template = await readFile(
-		path.join( templatesDir, templateName ),
-		'utf8'
-	);
-
-	// Apply all replacements
+export function applyTemplateReplacements( template, replacements ) {
 	let content = template;
 	for ( const [ placeholder, value ] of Object.entries( replacements ) ) {
 		content = content.replaceAll( placeholder, value );
 	}
-
-	// Write output file
-	await mkdir( path.dirname( outputPath ), { recursive: true } );
-	await writeFile( outputPath, content );
+	return content;
 }
 
 /**
- * Generate routes/index.php file with route registry data.
+ * Render a template to a string with replacements.
  *
- * @param {string} rootDir  Root directory path.
- * @param {string} buildDir Build directory path.
- * @param {string} prefix   Package prefix.
+ * @param {string}                 templateName Template file name.
+ * @param {Record<string, string>} replacements Replacements object (e.g. {'{{PREFIX}}': 'gutenberg'}).
+ * @return {Promise<string>} Rendered template string.
  */
-export async function generateRoutesRegistry( rootDir, buildDir, prefix ) {
-	const routeNames = getAllRoutes( rootDir );
-
-	if ( routeNames.length === 0 ) {
-		// No routes to register, skip generating routes registry
-		return;
-	}
-
-	// Build routes array
-	const routes = routeNames.map( ( routeName ) => {
-		// Read package.json to get route path
-		const routePackageJson =
-			/** @type {import('./package-utils.mjs').RoutePackageJson} */ (
-				getPackageInfoFromFile(
-					path.join( rootDir, 'routes', routeName, 'package.json' )
-				)
-			);
-		const routePath = routePackageJson.route.path;
-
-		// Check if route.js exists
-		const routeFiles = getRouteFiles(
-			path.join( rootDir, 'routes', routeName )
-		);
-
-		return {
-			name: routeName,
-			path: routePath,
-			has_route: routeFiles.hasRoute,
-		};
-	} );
-
-	// Generate PHP array entries
-	const routeEntries = routes
-		.map( ( route ) => {
-			const hasRouteStr = route.has_route ? 'true' : 'false';
-			return `\tarray(
-		'name'      => '${ route.name }',
-		'path'      => '${ route.path }',
-		'has_route' => ${ hasRouteStr },
-	)`;
-		} )
-		.join( ',\n' );
-
-	// Generate routes/index.php
-	const replacements = {
-		'{{PREFIX}}': prefix,
-		'{{ROUTES}}': routeEntries,
-	};
+export async function renderTemplateToString( templateName, replacements ) {
+	// Templates directory
+	const templatesDir = path.join( __dirname, '..', 'templates' );
 
-	await generatePhpFromTemplate(
-		'route-registry.php.template',
-		path.join( buildDir, 'routes', 'index.php' ),
-		replacements
+	// Read template
+	const template = await readFile(
+		path.join( templatesDir, templateName ),
+		'utf8'
 	);
+
+	// Apply replacements
+	return applyTemplateReplacements( template, replacements );
 }
 
 /**
- * Generate routes.php file with route registration logic.
+ * Generate a PHP file from a template with replacements.
  *
- * @param {string} rootDir      Root directory path.
- * @param {string} buildDir     Build directory path.
- * @param {string} handlePrefix Handle prefix for script modules.
- * @param {string} prefix       Package prefix.
+ * @param {string}                 templateName Template file name.
+ * @param {string}                 outputPath   Full output path.
+ * @param {Record<string, string>} replacements Replacements object (e.g. {'{{PREFIX}}': 'gutenberg'}).
  */
-export async function generateRoutesPhp(
-	rootDir,
-	buildDir,
-	handlePrefix,
-	prefix
+export async function generatePhpFromTemplate(
+	templateName,
+	outputPath,
+	replacements
 ) {
-	const routeNames = getAllRoutes( rootDir );
-
-	if ( routeNames.length === 0 ) {
-		// No routes to register, skip generating routes.php
-		return;
-	}
-
-	const namespace = handlePrefix.replace( /-/g, '_' );
+	// Render template to string
+	const content = await renderTemplateToString( templateName, replacements );
 
-	// Generate routes.php
-	const replacements = {
-		'{{PREFIX}}': prefix,
-		'{{NAMESPACE}}': namespace,
-		'{{HANDLE_PREFIX}}': handlePrefix,
-	};
-
-	await generatePhpFromTemplate(
-		'routes.php.template',
-		path.join( buildDir, 'routes.php' ),
-		replacements
-	);
+	// Write output file
+	await mkdir( path.dirname( outputPath ), { recursive: true } );
+	await writeFile( outputPath, content );
 }

package/src/route-utils.mjs

@@ -4,6 +4,11 @@
 import { readdirSync } from 'fs';
 import path from 'path';
 
+/**
+ * Internal dependencies
+ */
+import { getPackageInfoFromFile } from './package-utils.mjs';
+
 /**
  * Get all route names from the routes directory.
  *
@@ -23,6 +28,39 @@ export function getAllRoutes( rootDir ) {
 	}
 }
 
+/**
+ * @typedef {Object} RouteMetadata
+ * @property {string}      name Route name.
+ * @property {string}      path Route path.
+ * @property {string|null} page Page slug this route belongs to.
+ */
+
+/**
+ * Get route metadata from package.json.
+ *
+ * @param {string} rootDir   Root directory of the project.
+ * @param {string} routeName Route name.
+ * @return {RouteMetadata|null} Route metadata object or null if not found.
+ */
+export function getRouteMetadata( rootDir, routeName ) {
+	const routePackageJson =
+		/** @type {import('./package-utils.mjs').RoutePackageJson|null} */ (
+			getPackageInfoFromFile(
+				path.join( rootDir, 'routes', routeName, 'package.json' )
+			)
+		);
+
+	if ( ! routePackageJson || ! routePackageJson.route ) {
+		return null;
+	}
+
+	return {
+		name: routeName,
+		path: routePackageJson.route.path,
+		page: routePackageJson.route.page || null,
+	};
+}
+
 /**
  * @typedef {Object} RouteFiles
  * @property {boolean} hasRoute     Whether route file exists.

package/templates/index.php.template

@@ -35,3 +35,9 @@ $routes_file = __DIR__ . '/routes.php';
 if ( file_exists( $routes_file ) ) {
 	require_once $routes_file;
 }
+
+// Load pages registration.
+$pages_file = __DIR__ . '/pages.php';
+if ( file_exists( $pages_file ) ) {
+	require_once $pages_file;
+}

package/templates/page-wp-admin.php.template

@@ -0,0 +1,252 @@
+<?php
+/**
+ * Page: {{PAGE_SLUG}} (wp-admin integrated)
+ * Auto-generated by build process.
+ * Do not edit this file manually.
+ *
+ * This version integrates with the standard WordPress admin interface,
+ * keeping the wp-admin sidebar and scripts/styles intact.
+ *
+ * @package {{PREFIX}}
+ */
+
+// Global storage for {{PAGE_SLUG}} routes and menu items
+global ${{PREFIX}}_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_routes, ${{PREFIX}}_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_menu_items;
+${{PREFIX}}_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_routes = array();
+${{PREFIX}}_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_menu_items = array();
+
+if ( ! function_exists( 'register_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_route' ) ) {
+	/**
+	 * Register a route for the {{PAGE_SLUG}}-wp-admin page.
+	 *
+	 * @param string      $path           Route path (e.g., '/types/$type/edit/$id').
+	 * @param string|null $content_module Script module ID for content (stage/inspector).
+	 * @param string|null $route_module   Script module ID for route lifecycle hooks.
+	 */
+	function register_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_route( $path, $content_module = null, $route_module = null ) {
+		global ${{PREFIX}}_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_routes;
+
+		$route = array( 'path' => $path );
+		if ( ! empty( $content_module ) ) {
+			$route['content_module'] = $content_module;
+		}
+		if ( ! empty( $route_module ) ) {
+			$route['route_module'] = $route_module;
+		}
+
+		${{PREFIX}}_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_routes[] = $route;
+	}
+}
+
+if ( ! function_exists( 'register_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_menu_item' ) ) {
+	/**
+	 * Register a menu item for the {{PAGE_SLUG}}-wp-admin page.
+	 * Note: Menu items are registered but not displayed in single-page mode.
+	 *
+	 * @param string $id        Menu item ID.
+	 * @param string $label     Display label.
+	 * @param string $to        Route path to navigate to.
+	 * @param string $parent_id Optional. Parent menu item ID.
+	 */
+	function register_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_menu_item( $id, $label, $to, $parent_id = '' ) {
+		global ${{PREFIX}}_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_menu_items;
+
+		$menu_item = array(
+			'id'    => $id,
+			'label' => $label,
+			'to'    => $to,
+		);
+
+		if ( ! empty( $parent_id ) ) {
+			$menu_item['parent'] = $parent_id;
+		}
+
+		${{PREFIX}}_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_menu_items[] = $menu_item;
+	}
+}
+
+if ( ! function_exists( 'get_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_routes' ) ) {
+	/**
+	 * Get all registered routes for the {{PAGE_SLUG}}-wp-admin page.
+	 *
+	 * @return array Array of route objects.
+	 */
+	function get_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_routes() {
+		global ${{PREFIX}}_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_routes;
+		return ${{PREFIX}}_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_routes ?? array();
+	}
+}
+
+if ( ! function_exists( 'get_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_menu_items' ) ) {
+	/**
+	 * Get all registered menu items for the {{PAGE_SLUG}}-wp-admin page.
+	 *
+	 * @return array Array of menu item objects.
+	 */
+	function get_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_menu_items() {
+		global ${{PREFIX}}_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_menu_items;
+		return ${{PREFIX}}_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_menu_items ?? array();
+	}
+}
+
+if ( ! function_exists( '{{PAGE_SLUG_UNDERSCORE}}_wp_admin_preload_data' ) ) {
+	/**
+	 * Preload REST API data for the {{PAGE_SLUG}}-wp-admin page.
+	 * Automatically called during page rendering.
+	 */
+	function {{PAGE_SLUG_UNDERSCORE}}_wp_admin_preload_data() {
+		// Define paths to preload - same for all pages
+		$preload_paths = array(
+			'/?_fields=description,gmt_offset,home,name,site_icon,site_icon_url,site_logo,timezone_string,url,page_for_posts,page_on_front,show_on_front',
+			array( '/wp/v2/settings', 'OPTIONS' ),
+		);
+
+		// Use rest_preload_api_request to gather the preloaded data
+		$preload_data = array_reduce(
+			$preload_paths,
+			'rest_preload_api_request',
+			array()
+		);
+
+		// Register the preloading middleware with wp-api-fetch
+		wp_add_inline_script(
+			'wp-api-fetch',
+			sprintf(
+				'wp.apiFetch.use( wp.apiFetch.createPreloadingMiddleware( %s ) );',
+				wp_json_encode( $preload_data )
+			),
+			'after'
+		);
+	}
+}
+
+if ( ! function_exists( '{{PAGE_SLUG_UNDERSCORE}}_wp_admin_enqueue_scripts' ) ) {
+	/**
+	 * Enqueue scripts and styles for the {{PAGE_SLUG}}-wp-admin page.
+	 * Hooked to admin_enqueue_scripts.
+	 *
+	 * @param string $hook_suffix The current admin page.
+	 */
+	function {{PAGE_SLUG_UNDERSCORE}}_wp_admin_enqueue_scripts( $hook_suffix ) {
+		// Only enqueue on our page
+		if ( ! isset( $_GET['page'] ) || '{{PAGE_SLUG}}-wp-admin' !== $_GET['page'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			return;
+		}
+
+		// Fire init action for extensions to register routes and menu items
+		do_action( '{{PAGE_SLUG}}-wp-admin_init' );
+
+		// Preload REST API data
+		{{PAGE_SLUG_UNDERSCORE}}_wp_admin_preload_data();
+
+		// Get all registered routes
+		$routes = get_{{PAGE_SLUG_UNDERSCORE}}_wp_admin_routes();
+
+		// Get boot module asset file for dependencies
+		$asset_file = plugin_dir_path( __FILE__ ) . '../../modules/boot/index.min.asset.php';
+		if ( file_exists( $asset_file ) ) {
+			$asset = require $asset_file;
+
+			// This script serves two purposes:
+			// 1. It ensures all the globals that are made available to the modules are loaded.
+			// 2. It initializes the boot module as an inline script.
+			wp_register_script( '{{PAGE_SLUG}}-wp-admin-prerequisites', '', $asset['dependencies'], $asset['version'], true );
+
+			// Add inline script to initialize the app using initSinglePage (no menuItems)
+			wp_add_inline_script(
+				'{{PAGE_SLUG}}-wp-admin-prerequisites',
+				sprintf(
+					'import("@wordpress/boot").then(mod => mod.initSinglePage({mountId: "%s", routes: %s}));',
+					'{{PAGE_SLUG}}-wp-admin-app',
+					wp_json_encode( $routes, JSON_HEX_TAG | JSON_UNESCAPED_SLASHES )
+				)
+			);
+
+			// Register prerequisites style by filtering script dependencies to find registered styles
+			$style_dependencies = array_filter(
+				$asset['dependencies'],
+				function ( $handle ) {
+					return wp_style_is( $handle, 'registered' );
+				}
+			);
+			wp_register_style( '{{PAGE_SLUG}}-wp-admin-prerequisites', false, $style_dependencies, $asset['version'] );
+
+			// Build dependencies for {{PAGE_SLUG}}-wp-admin module
+			$boot_dependencies = array(
+				array(
+					'import' => 'static',
+					'id'     => '@wordpress/boot',
+				),
+			);
+
+			// Add all registered routes as dependencies
+			foreach ( $routes as $route ) {
+				if ( isset( $route['route_module'] ) ) {
+					$boot_dependencies[] = array(
+						'import' => 'static',
+						'id'     => $route['route_module'],
+					);
+				}
+				if ( isset( $route['content_module'] ) ) {
+					$boot_dependencies[] = array(
+						'import' => 'dynamic',
+						'id'     => $route['content_module'],
+					);
+				}
+			}
+
+			// Dummy script module to ensure dependencies are loaded
+			wp_register_script_module(
+				'{{PAGE_SLUG}}-wp-admin',
+				plugin_dir_url( __FILE__ ) . 'loader.js',
+				$boot_dependencies
+			);
+
+			// Enqueue the boot scripts and styles
+			wp_enqueue_script( '{{PAGE_SLUG}}-wp-admin-prerequisites' );
+			wp_enqueue_script_module( '{{PAGE_SLUG}}-wp-admin' );
+			wp_enqueue_style( '{{PAGE_SLUG}}-wp-admin-prerequisites' );
+		}
+	}
+}
+
+if ( ! function_exists( '{{PAGE_SLUG_UNDERSCORE}}_wp_admin_render_page' ) ) {
+	/**
+	 * Render the {{PAGE_SLUG}}-wp-admin page.
+	 * Call this function from add_menu_page or add_submenu_page.
+	 * This renders within the normal WordPress admin interface.
+	 */
+	function {{PAGE_SLUG_UNDERSCORE}}_wp_admin_render_page() {
+		?>
+		<div id="{{PAGE_SLUG}}-wp-admin-app" class="boot-layout-container"></div>
+		<?php
+	}
+}
+
+// Hook the enqueue function to admin_enqueue_scripts
+add_action( 'admin_enqueue_scripts', '{{PAGE_SLUG_UNDERSCORE}}_wp_admin_enqueue_scripts' );
+
+if ( ! function_exists( '{{PAGE_SLUG_UNDERSCORE}}_wp_admin_register_page' ) ) {
+	/**
+	 * Register the {{PAGE_SLUG}}-wp-admin base page handler.
+	 * This is hidden from the menu but provides the page callback for URL routing.
+	 * Visible menu items should use the full URL pattern with query parameters.
+	 *
+	 * Example:
+	 * $url = admin_url( 'admin.php?page={{PAGE_SLUG}}-wp-admin&p=' . urlencode( '/your/route' ) );
+	 * add_menu_page( 'Title', 'Menu', 'capability', $url, '', 'icon', 10 );
+	 */
+	function {{PAGE_SLUG_UNDERSCORE}}_wp_admin_register_page() {
+		add_submenu_page(
+			'nothing-{{PAGE_SLUG}}',                        // Hidden page (no parent)
+			__( '{{PAGE_SLUG}} (WP Admin)', '{{PREFIX}}' ), // Page title
+			__( '{{PAGE_SLUG}} (WP Admin)', '{{PREFIX}}' ), // Menu title (not visible)
+			'read',                                          // Minimum capability
+			'{{PAGE_SLUG}}-wp-admin',                       // Menu slug for URL routing
+			'{{PAGE_SLUG_UNDERSCORE}}_wp_admin_render_page' // Callback function
+		);
+	}
+}
+
+// Hook the registration to admin_menu
+add_action( 'admin_menu', '{{PAGE_SLUG_UNDERSCORE}}_wp_admin_register_page' );