@lark-apaas/fullstack-rspack-preset 1.0.57-alpha.0 → 1.0.57-alpha.1

package/lib/preset.js

@@ -21,6 +21,7 @@ const css_legacy_plugin_1 = __importDefault(require("./rspack-plugins/css-legacy
 const polyfill_plugin_1 = __importDefault(require("./rspack-plugins/polyfill-plugin"));
 const static_assets_plugin_1 = __importDefault(require("./rspack-plugins/static-assets-plugin"));
 const source_map_upload_plugin_1 = __importDefault(require("./rspack-plugins/source-map-upload-plugin"));
+const capabilities_plugin_1 = require("./rspack-plugins/capabilities-plugin");
 const dev_server_snapdom_proxy_1 = require("./utils/dev-server-snapdom-proxy");
 function sendBackendUnavailable502(_err, _req, res) {
     if (res.headersSent)
@@ -221,6 +222,13 @@ function createRecommendRspackConfig(options) {
             ],
         },
         plugins: [
+            // virtual:capabilities —— client-toolkit 经 client-capability 强依赖的虚拟模块。
+            // 即便业务工程没有 capability JSON 也必须把虚拟模块注册成空 map,否则下游
+            // node_modules/@lark-apaas/client-capability/dist/index.js 的
+            // `import 'virtual:capabilities'` 在 rspack 解析阶段直接 fail。
+            // 必须放在 RuntimeInjectionPlugin 前面 —— RuntimeInjectionPlugin 注入的
+            // client-toolkit/runtime 入口会间接 import 到 client-capability。
+            new capabilities_plugin_1.CapabilitiesPlugin({ rootDir }),
             // 运行时注入插件 - 自动将 @lark-apaas/client-toolkit/runtime 注入到所有入口之前
             new runtime_injection_plugin_1.default(),
             // basename 运行时注入 - 改写入口文件 process.env.CLIENT_BASE_PATH 为运行时读 window.__BASENAME__

package/lib/rspack-plugins/capabilities-plugin.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Capabilities Plugin for Rspack
+ *
+ * 解析 `virtual:capabilities` 虚拟模块——`@lark-apaas/client-capability` SDK
+ * (经 client-toolkit 间接消费)把 `virtual:capabilities` 标 tsup external 保留
+ * 在 dist 里,下游构建工具必须自己提供解析,否则 rspack build / dev 直接 fail:
+ *
+ *   Module not found: Can't resolve 'virtual:capabilities' in
+ *     node_modules/@lark-apaas/client-capability/dist/index.js
+ *
+ * 实现策略(参考同目录 static-assets-plugin 的虚拟模块模式):
+ *   - 扫 <rootDir>/server/capabilities/*.json + <rootDir>/shared/capabilities/*.json
+ *     生成 capability map(都不存在时空 map,SDK 在 dev 预览 / 沙箱也能正常加载)
+ *   - 写虚拟模块文件到 node_modules/.cache/capabilities-virtual/index.js
+ *   - 通过 `compiler.hooks.normalModuleFactory + beforeResolve` 拦截
+ *     `virtual:capabilities` import,把 resolveData.request 改写为虚拟模块文件路径
+ *
+ * 跟 vite 版本的语义保持一致:DEFAULT_DIRS 顺序、capability 合并规则(后 id 覆盖前 id)、
+ * 没有 id 的 JSON 跳过 + warn、JSON 解析失败跳过 + warn。
+ */
+import type { Compiler } from '@rspack/core';
+export interface CapabilitiesPluginOptions {
+    /** 覆盖扫描目录(相对项目根)。不传按 DEFAULT_DIRS 依次扫描。 */
+    dir?: string;
+    /** 项目根目录,不传走 compiler.options.context || process.cwd() */
+    rootDir?: string;
+}
+export declare class CapabilitiesPlugin {
+    private options;
+    constructor(options?: CapabilitiesPluginOptions);
+    private listDirs;
+    private loadMap;
+    apply(compiler: Compiler): void;
+}
+export default CapabilitiesPlugin;

package/lib/rspack-plugins/capabilities-plugin.js

@@ -0,0 +1,153 @@
+"use strict";
+/**
+ * Capabilities Plugin for Rspack
+ *
+ * 解析 `virtual:capabilities` 虚拟模块——`@lark-apaas/client-capability` SDK
+ * (经 client-toolkit 间接消费)把 `virtual:capabilities` 标 tsup external 保留
+ * 在 dist 里,下游构建工具必须自己提供解析,否则 rspack build / dev 直接 fail:
+ *
+ *   Module not found: Can't resolve 'virtual:capabilities' in
+ *     node_modules/@lark-apaas/client-capability/dist/index.js
+ *
+ * 实现策略(参考同目录 static-assets-plugin 的虚拟模块模式):
+ *   - 扫 <rootDir>/server/capabilities/*.json + <rootDir>/shared/capabilities/*.json
+ *     生成 capability map(都不存在时空 map,SDK 在 dev 预览 / 沙箱也能正常加载)
+ *   - 写虚拟模块文件到 node_modules/.cache/capabilities-virtual/index.js
+ *   - 通过 `compiler.hooks.normalModuleFactory + beforeResolve` 拦截
+ *     `virtual:capabilities` import,把 resolveData.request 改写为虚拟模块文件路径
+ *
+ * 跟 vite 版本的语义保持一致:DEFAULT_DIRS 顺序、capability 合并规则(后 id 覆盖前 id)、
+ * 没有 id 的 JSON 跳过 + warn、JSON 解析失败跳过 + warn。
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CapabilitiesPlugin = void 0;
+const fs = __importStar(require("node:fs"));
+const path = __importStar(require("node:path"));
+const VIRTUAL_ID = 'virtual:capabilities';
+const PLUGIN_NAME = 'MiaodaCapabilitiesPlugin';
+// fullstack 模板把 capability JSON 放在 `server/capabilities`。
+// 同时兼容 jsPage 风格 `shared/capabilities`。
+const DEFAULT_DIRS = ['server/capabilities', 'shared/capabilities'];
+class CapabilitiesPlugin {
+    constructor(options = {}) {
+        this.options = options;
+    }
+    listDirs(rootDir) {
+        if (this.options.dir)
+            return [path.resolve(rootDir, this.options.dir)];
+        return DEFAULT_DIRS.map((d) => path.resolve(rootDir, d));
+    }
+    loadMap(rootDir) {
+        const map = {};
+        for (const abs of this.listDirs(rootDir)) {
+            if (!fs.existsSync(abs))
+                continue;
+            for (const f of fs.readdirSync(abs)) {
+                if (!f.endsWith('.json'))
+                    continue;
+                try {
+                    const cfg = JSON.parse(fs.readFileSync(path.join(abs, f), 'utf-8'));
+                    if (cfg?.id)
+                        map[cfg.id] = cfg;
+                }
+                catch (e) {
+                    console.warn(`[miaoda-capabilities] skip invalid json: ${path.join(abs, f)}: ${e instanceof Error ? e.message : String(e)}`);
+                }
+            }
+        }
+        return map;
+    }
+    apply(compiler) {
+        const rootDir = this.options.rootDir || compiler.options.context || process.cwd();
+        // 临时虚拟模块目录(跟 static-assets-plugin 同款模式)
+        const virtualModulesDir = path.join(rootDir, 'node_modules', '.cache', 'capabilities-virtual');
+        if (!fs.existsSync(virtualModulesDir)) {
+            fs.mkdirSync(virtualModulesDir, { recursive: true });
+        }
+        const virtualFile = path.join(virtualModulesDir, 'index.js');
+        // 构建期写一次虚拟模块内容;dev 期 capability JSON 变更触发 watch 重写。
+        // 虚拟文件内容输出 ESM `export default ...` —— 跟 vite 版本严格对齐,避免
+        // 未来 client-capability 改用 `import * as caps` 等 NS 形态时,CJS/ESM
+        // 互操作产生的差异(CJS 会嵌一层 default)。rspack 默认把 .js 当 module 类型
+        // 解析,ESM 语法可直接消费。
+        const writeVirtualFile = () => {
+            const map = this.loadMap(rootDir);
+            const content = `export default ${JSON.stringify(map)};\n`;
+            // 仅当内容变化时写盘,避免无意义触发 watcher
+            let existing = null;
+            try {
+                existing = fs.readFileSync(virtualFile, 'utf-8');
+            }
+            catch {
+                existing = null;
+            }
+            if (existing !== content) {
+                fs.writeFileSync(virtualFile, content);
+            }
+        };
+        writeVirtualFile();
+        // rootDir fallback 静默退化排查难,启动期检查一次实际有没有扫到 capability 目录
+        const foundDirs = this.listDirs(rootDir).filter((d) => fs.existsSync(d));
+        if (foundDirs.length === 0) {
+            console.info(`[miaoda-capabilities] no capability dirs found under ${rootDir}, registering empty map. Scanned: ${this.listDirs(rootDir).join(', ')}`);
+        }
+        // 拦截 `virtual:capabilities` import 改写到虚拟文件
+        compiler.hooks.normalModuleFactory.tap(PLUGIN_NAME, (factory) => {
+            factory.hooks.beforeResolve.tap(PLUGIN_NAME, (resolveData) => {
+                if (resolveData.request === VIRTUAL_ID) {
+                    resolveData.request = virtualFile;
+                }
+            });
+        });
+        // dev 期监听 capability JSON 变更:每次 compile 把 capability 目录加入
+        // contextDependencies(rspack watcher 会观察其下文件创建 / 修改 / 删除)。
+        // 不在 afterEnvironment 一次性快照 —— 那样 startup 时还没建的目录永远抓不到。
+        // 每次 compile 重新 listDirs() 让新建目录也能被加入监听。
+        compiler.hooks.afterCompile.tap(PLUGIN_NAME, (compilation) => {
+            for (const dir of this.listDirs(rootDir)) {
+                // contextDependencies 接受不存在的路径,rspack 会观察父目录的创建事件
+                compilation.contextDependencies.add(dir);
+            }
+            compilation.fileDependencies.add(virtualFile);
+        });
+        // 每次 watchRun 前重写虚拟文件(覆盖 dev 期新增 / 修改 capability)
+        compiler.hooks.watchRun.tap(PLUGIN_NAME, () => {
+            writeVirtualFile();
+        });
+    }
+}
+exports.CapabilitiesPlugin = CapabilitiesPlugin;
+exports.default = CapabilitiesPlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-apaas/fullstack-rspack-preset",
-  "version": "1.0.57-alpha.0",
+  "version": "1.0.57-alpha.1",
   "files": [
     "lib",
     "patches",