@shuvi/platform-web 1.0.63 → 2.0.0-dev.6

package/lib/node/features/html-render/lib/webpack/build-manifest-plugin.rspack.d.ts

@@ -0,0 +1,249 @@
+import * as Rspack from '@shuvi/toolpack/lib/webpack';
+interface RspackPlugin {
+    apply: (compiler: Rspack.Compiler) => void;
+}
+/**
+ * Configuration options for RspackBuildManifestPlugin
+ */
+interface Options {
+    /** Output filename for the build manifest JSON file */
+    filename: string;
+    /** Whether to include module information in the manifest */
+    modules: boolean;
+    /** Whether to include chunk request information */
+    chunkRequest: boolean;
+}
+/**
+ * Rspack plugin that generates a build manifest JSON file containing mappings
+ * of entry filenames to their actual output filenames (which may be hashed in production).
+ *
+ * This plugin is adapted from the webpack version to work with Rspack's API.
+ * It provides the same functionality for frameworks that need to know the relationship
+ * between entry points and their corresponding built assets.
+ *
+ * ## Features
+ * - Maps entry points to their output files
+ * - Tracks bundle files and their relationships
+ * - Collects polyfill files
+ * - Supports loadable modules/chunks
+ * - Handles both development and production builds
+ *
+ * ## Generated Manifest Structure
+ * ```json
+ * {
+ *   "entries": {
+ *     "main": {
+ *       "js": ["/static/js/main.abc123.js"],
+ *       "css": ["/static/css/main.def456.css"]
+ *     }
+ *   },
+ *   "bundles": {
+ *     "main": "/static/js/main.abc123.js"
+ *   },
+ *   "chunkRequest": {
+ *     "/static/js/chunk.xyz789.js": "/pages/about"
+ *   },
+ *   "loadble": {
+ *     "/pages/about": {
+ *       "files": ["/static/js/chunk.xyz789.js"],
+ *       "children": [
+ *         {
+ *           "id": "module-id",
+ *           "name": "AboutPage"
+ *         }
+ *       ]
+ *     }
+ *   },
+ *   "polyfillFiles": ["/static/js/polyfills.ghi012.js"]
+ * }
+ * ```
+ *
+ * ## Usage Example
+ * ```typescript
+ * // In rspack configuration
+ * const RspackBuildManifestPlugin = require('./rspack-build-manifest-plugin');
+ *
+ * module.exports = {
+ *   plugins: [
+ *     new RspackBuildManifestPlugin({
+ *       filename: 'build-manifest.json',
+ *       modules: true,
+ *       chunkRequest: true
+ *     })
+ *   ]
+ * };
+ * ```
+ *
+ * ## Use Cases
+ * - **SSR Frameworks**: Map entry points to built assets for server-side rendering
+ * - **Asset Loading**: Determine which files to load for specific routes
+ * - **Cache Management**: Track hashed filenames for cache invalidation
+ * - **Code Splitting**: Understand relationships between chunks and their requests
+ *
+ * ## Differences from Webpack Version
+ * - Uses Rspack's API instead of Webpack's
+ * - Simplified module collection (Rspack has different module APIs)
+ * - Adapted to Rspack's chunk and compilation structure
+ * - Some features are marked with TODO comments for future Rspack API support
+ */
+export default class RspackBuildManifestPlugin implements RspackPlugin {
+    private _options;
+    private _manifest;
+    /**
+     * Creates a new RspackBuildManifestPlugin instance
+     * @param options - Configuration options for the plugin
+     *
+     * @example
+     * ```typescript
+     * // Basic usage with default options
+     * new RspackBuildManifestPlugin()
+     *
+     * // Custom configuration
+     * new RspackBuildManifestPlugin({
+     *   filename: 'assets-manifest.json',
+     *   modules: true,
+     *   chunkRequest: true
+     * })
+     * ```
+     */
+    constructor(options?: Partial<Options>);
+    /**
+     * Creates the build manifest by analyzing compilation assets and chunks
+     * @param compiler - Rspack compiler instance
+     * @param compilation - Rspack compilation instance
+     * @returns The generated manifest object
+     *
+     * This method performs the following operations:
+     * 1. Initializes the manifest structure
+     * 2. Collects entry point information
+     * 3. Processes chunk groups and their assets
+     * 4. Identifies polyfill files
+     * 5. Sorts and organizes loadable modules
+     */
+    createAssets(compiler: Rspack.Compiler, compilation: Rspack.Compilation): {
+        entries: {};
+        bundles: {};
+        chunkRequest: {};
+        loadble: {};
+    };
+    /**
+     * Applies the plugin to the rspack compiler
+     * @param compiler - Rspack compiler instance
+     *
+     * This method hooks into the rspack compilation process to:
+     * 1. Listen for the 'make' hook to prepare for asset processing
+     * 2. Hook into 'processAssets' to generate the manifest file
+     * 3. Create the JSON file as a compilation asset
+     */
+    apply(compiler: Rspack.Compiler): void;
+    /**
+     * Get the raw request of the chunk
+     * @param compilation - Rspack compilation instance
+     * @param chunk - Rspack chunk instance
+     * @returns The raw request of the chunk
+     */
+    private _getFirstRawRequest;
+    /**
+     * Collects entry point information from chunk groups
+     * @param entrypoint - The entry point chunk group to process
+     *
+     * This method processes entry points and maps them to their output files,
+     * filtering out source maps and hot update files.
+     */
+    private _collectEntries;
+    /**
+     * Collects information from chunk groups including chunks and modules
+     * @param chunkGroup - The chunk group to process
+     * @param compiler - Rspack compiler instance
+     * @param compilation - Rspack compilation instance
+     *
+     * This method processes chunk groups to collect:
+     * - Chunk information (files, requests)
+     * - Module information (if enabled)
+     * - Loadable modules and their relationships
+     */
+    private _collect;
+    /**
+     * Collects information from individual chunks
+     * @param chunk - The rspack chunk to process
+     * @param request - The request that generated this chunk
+     *
+     * This method processes chunks to:
+     * - Identify bundle files
+     * - Map chunk requests to files
+     * - Filter out source maps and hot update files
+     */
+    private _collectChunk;
+    /**
+     * Collects module information from chunks (when modules option is enabled)
+     * @param chunk - The rspack chunk to process
+     * @param request - The request that generated this chunk
+     * @param compiler - Rspack compiler instance
+     * @param compilation - Rspack compilation instance
+     *
+     * This method processes chunks to collect:
+     * - Loadable module files (JS and CSS)
+     * - Module metadata (ID, name) - simplified for Rspack
+     * - Root modules for code splitting analysis
+     */
+    private _collectChunkModule;
+    /**
+     * Adds entry information to the manifest
+     * @param name - Entry point name
+     * @param ext - File extension
+     * @param value - File path
+     *
+     * @example
+     * ```typescript
+     * this._pushEntries('main', 'js', '/static/js/main.abc123.js')
+     * // Results in: { entries: { main: { js: ['/static/js/main.abc123.js'] } } }
+     * ```
+     */
+    private _pushEntries;
+    /**
+     * Adds bundle information to the manifest
+     * @param name - Bundle name
+     * @param file - Bundle file path
+     *
+     * @example
+     * ```typescript
+     * this._pushBundle({ name: 'main', file: '/static/js/main.abc123.js' })
+     * // Results in: { bundles: { main: '/static/js/main.abc123.js' } }
+     * ```
+     */
+    private _pushBundle;
+    /**
+     * Adds chunk request information to the manifest (when chunkRequest option is enabled)
+     * @param file - Chunk file path
+     * @param request - Request that generated the chunk
+     *
+     * @example
+     * ```typescript
+     * this._pushChunkRequest({
+     *   file: '/static/js/chunk.xyz789.js',
+     *   request: '/pages/about'
+     * })
+     * // Results in: { chunkRequest: { '/static/js/chunk.xyz789.js': '/pages/about' } }
+     * ```
+     */
+    private _pushChunkRequest;
+    /**
+     * Adds loadable module information to the manifest
+     * @param request - The request that generated the loadable module
+     * @param module - Module item with ID and name
+     *
+     * @example
+     * ```typescript
+     * // Adding a file
+     * this._pushLoadableModules('/pages/about', '/static/js/chunk.xyz789.js')
+     *
+     * // Adding a module
+     * this._pushLoadableModules('/pages/about', {
+     *   id: 'module-id',
+     *   name: 'AboutPage'
+     * })
+     * ```
+     */
+    private _pushLoadableModules;
+}
+export {};