web-extend-plugin-vue2 0.2.5 → 0.3.0

package/dist/index.mjs

@@ -338,15 +338,9 @@ function resolveRuntimeOptions$1(user = {}) {
         return String(DEF.devFallbackStaticManifestUrl).trim();
     })();
     const hostLayoutComponent = user.hostLayoutComponent;
-    const pluginRoutesParentName = (() => {
-        if (user.pluginRoutesParentName !== undefined) {
-            return String(user.pluginRoutesParentName).trim();
-        }
-        if (hostLayoutComponent != null) {
-            return String(DEF.pluginRoutesParentName).trim();
-        }
-        return '';
-    })();
+    const pluginRoutesParentName = user.pluginRoutesParentName !== undefined && String(user.pluginRoutesParentName).trim() !== ''
+        ? String(user.pluginRoutesParentName).trim()
+        : '';
     const pluginMountRaw = user.pluginMountPath !== undefined && String(user.pluginMountPath).trim() !== ''
         ? String(user.pluginMountPath).trim()
         : String(resolveBundledEnv(EK.mountPath, '') || DEF.pluginMountPath).trim();
@@ -354,7 +348,7 @@ function resolveRuntimeOptions$1(user = {}) {
     const pluginHostRouteMeta = user.pluginHostRouteMeta !== undefined && user.pluginHostRouteMeta !== null
         ? user.pluginHostRouteMeta
         : undefined;
-    const ensurePluginHostRoute = user.ensurePluginHostRoute !== false;
+    const ensurePluginHostRoute = user.ensurePluginHostRoute === true;
     const devManifestFallback = (() => {
         if (manifestMode === 'static') {
             return false;
@@ -417,12 +411,6 @@ function resolveRuntimeOptions$1(user = {}) {
         ...(typeof user.adaptRouteDeclarations === 'function'
             ? { adaptRouteDeclarations: user.adaptRouteDeclarations }
             : {}),
-        ...(typeof user.applyPluginMenuItems === 'function'
-            ? { applyPluginMenuItems: user.applyPluginMenuItems }
-            : {}),
-        ...(typeof user.revokePluginMenuItems === 'function'
-            ? { revokePluginMenuItems: user.revokePluginMenuItems }
-            : {}),
         ...(user.hostContext !== undefined &&
             user.hostContext !== null &&
             typeof user.hostContext === 'object' &&
@@ -3214,21 +3202,18 @@ var semverExports = requireSemver();
 var semver = /*@__PURE__*/getDefaultExportFromCjs(semverExports);
 
 /**
- * `disposeWebPlugin` 使用的菜单撤销钩子：在 `bootstrapPlugins` 中用 `resolveRuntimeOptions` 结果注册。
+ * 引导时注入的 router 引用，供 disposeWebPlugin 按插件批量 removeRoute。
  */
-let revokePluginMenuItems;
-function setRevokePluginMenuItems(fn) {
-    revokePluginMenuItems = fn;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+let bootstrapRouter;
+/** 由 bootstrapPlugins 在浏览器环境调用 */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function setPluginBootstrapRouter(router) {
+    bootstrapRouter = router;
 }
-function revokePluginMenusIfConfigured(pluginId) {
-    if (typeof revokePluginMenuItems === 'function') {
-        try {
-            revokePluginMenuItems(pluginId);
-        }
-        catch (e) {
-            console.warn('[wep] revokePluginMenuItems failed', pluginId, e);
-        }
-    }
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function getPluginBootstrapRouter() {
+    return bootstrapRouter;
 }
 
 /**
@@ -3485,7 +3470,8 @@ async function fetchStaticManifestViaHttp(ctx) {
 }
 
 /**
- * 开箱：在未手工配置时，注册 `/plugin` + 宿主 Layout 的命名父路由，供 `router.addRoute(parentName, child)` 挂载插件页。
+ * 当 `ensurePluginHostRoute === true` 且提供 `pluginRoutesParentName` + `hostLayoutComponent` 时，
+ * 注册 `pluginMountPath` + Layout 的命名父路由，供 `router.addRoute(parentName, child)` 挂载插件页。
  */
 function routeNameExists(router, name) {
     if (!name) {
@@ -3512,7 +3498,7 @@ function walkRouteNames(routes, name) {
     return false;
 }
 function ensurePluginHostRoute$1(router, opts) {
-    if (opts.ensurePluginHostRoute === false) {
+    if (opts.ensurePluginHostRoute !== true) {
         return;
     }
     if (!router || typeof router.addRoute !== 'function') {
@@ -3641,7 +3627,7 @@ createHostApiFactory, runtimeOptions) {
     }
     printRuntimeBannerOnce();
     const opts = resolveRuntimeOptions$1(runtimeOptions || {});
-    setRevokePluginMenuItems(typeof opts.revokePluginMenuItems === 'function' ? opts.revokePluginMenuItems : undefined);
+    setPluginBootstrapRouter(router);
     ensurePluginHostRoute$1(router, opts);
     const base = String(opts.manifestBase).replace(/\/$/, '');
     const isStatic = opts.manifestMode === 'static';
@@ -3718,12 +3704,6 @@ createHostApiFactory, runtimeOptions) {
             : {}),
         ...(typeof opts.adaptRouteDeclarations === 'function'
             ? { adaptRouteDeclarations: opts.adaptRouteDeclarations }
-            : {}),
-        ...(typeof opts.applyPluginMenuItems === 'function'
-            ? { applyPluginMenuItems: opts.applyPluginMenuItems }
-            : {}),
-        ...(typeof opts.revokePluginMenuItems === 'function'
-            ? { revokePluginMenuItems: opts.revokePluginMenuItems }
             : {})
     };
     if (!manifestResult.ok) {
@@ -4013,7 +3993,7 @@ var manifestComposer = /*#__PURE__*/Object.freeze({
 
 /**
  * 宿主侧响应式注册表：扩展点槽位（供布局与 `ExtensionPoint` 消费）。
- * 菜单数据由宿主在 `applyPluginMenuItems` 中自行并入其路由/菜单 state，框架不维护平行菜单列表。
+ * 菜单由宿主从路由 `meta` 推导（见 `buildMenuDescriptorsFromRoutes`），框架不维护平行菜单列表。
  */
 const registries = Vue.observable({
     slots: {},
@@ -4076,6 +4056,47 @@ function createRequestBridge(config = {}) {
     };
 }
 
+/**
+ * 记录各插件通过 registerRoutes 挂到 router 上的顶层 route name，便于 dispose 时 removeRoute。
+ */
+const pluginIdToRouteNames = new Map();
+function recordPluginTopRouteNames(pluginId, names) {
+    if (!pluginId || names.length === 0) {
+        return;
+    }
+    const cur = pluginIdToRouteNames.get(pluginId) || [];
+    pluginIdToRouteNames.set(pluginId, cur.concat(names));
+}
+/**
+ * 从 matcher 移除该插件登记过的顶层路由（含其子树）。
+ * 需 vue-router ≥3.5 的 removeRoute；否则静默跳过。
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function removeRegisteredRoutesForPlugin(router, pluginId) {
+    const names = pluginIdToRouteNames.get(pluginId);
+    if (!names || names.length === 0) {
+        return;
+    }
+    if (!router || typeof router.removeRoute !== 'function') {
+        console.warn('[wep] router.removeRoute 不可用，跳过动态路由卸载', pluginId);
+        pluginIdToRouteNames.delete(pluginId);
+        return;
+    }
+    for (let i = names.length - 1; i >= 0; i--) {
+        try {
+            router.removeRoute(names[i]);
+        }
+        catch (e) {
+            console.warn('[wep] removeRoute failed', names[i], e);
+        }
+    }
+    pluginIdToRouteNames.delete(pluginId);
+}
+/** 测试或宿主高级场景：查询已登记 name（勿依赖顺序语义） */
+function getRegisteredTopRouteNamesForPlugin(pluginId) {
+    return [...(pluginIdToRouteNames.get(pluginId) || [])];
+}
+
 /**
  * 构造插件 `activator(hostApi)` 使用的宿主 API：路由、菜单、扩展点、资源与受控请求桥。
  */
@@ -4131,6 +4152,7 @@ function createHostApi(pluginId, router, hostKitOptions = {}) {
         if (typeof router.addRoute !== 'function') {
             throw new Error('[wep] vue-router 3.5+ 必需：请使用 router.addRoute（不再支持 addRoutes）');
         }
+        recordPluginTopRouteNames(pluginId, wrapped.map((r) => String(r.name)));
         if (parentName) {
             for (const r of wrapped) {
                 router.addRoute(parentName, r);
@@ -4210,16 +4232,6 @@ function createHostApi(pluginId, router, hostKitOptions = {}) {
                 applyInternalRegister(configs);
             }
         },
-        registerMenuItems(items) {
-            const apply = hostKitOptions.applyPluginMenuItems;
-            if (typeof apply !== 'function') {
-                throw new Error('[wep] registerMenuItems 需要宿主在 resolveRuntimeOptions 中提供 applyPluginMenuItems，将菜单数据并入宿主侧栏/目录 state（框架不再维护 registries.menus）');
-            }
-            const list = Array.isArray(items) ? items : [];
-            const enriched = list.map((item) => ({ ...item, pluginId }));
-            enriched.sort((a, b) => (a.order != null ? Number(a.order) : 0) - (b.order != null ? Number(b.order) : 0));
-            apply({ pluginId, items: enriched });
-        },
         registerSlotComponents(pointId, components) {
             if (!pointId) {
                 return;
@@ -4263,15 +4275,15 @@ function createHostApi(pluginId, router, hostKitOptions = {}) {
 }
 
 /**
- * 卸载单个插件：执行 teardown、清理注册表与 activator、移除带 `data-plugin-asset` 的 DOM。
- * 注意：Vue Router 3 无公开 `removeRoute`，动态路由通常需整页刷新或宿主自行维护。
+ * 卸载单个插件：执行 teardown、按登记 name 批量 removeRoute、清理注册表与 activator、移除带 `data-plugin-asset` 的 DOM。
+ * 依赖 vue-router ≥3.5 的 removeRoute；引导时由 bootstrapPlugins 注入 router。
  */
 function disposeWebPlugin(pluginId) {
     if (!pluginId || typeof pluginId !== 'string') {
         return;
     }
     runPluginTeardowns(pluginId);
-    revokePluginMenusIfConfigured(pluginId);
+    removeRegisteredRoutesForPlugin(getPluginBootstrapRouter(), pluginId);
     const slots = registries.slots;
     for (const pointId of Object.keys(slots)) {
         const list = slots[pointId];
@@ -4299,6 +4311,75 @@ function disposeWebPlugin(pluginId) {
     }
 }
 
+/**
+ * 从路由配置（含 meta）推导侧栏/目录用菜单描述，与 registerRoutes 入参同源。
+ *
+ * 约定：
+ * - `meta.menu === false`：该节点及其子树不参与菜单
+ * - 节点出现条件：`meta.title` 或 `meta.menuTitle` 非空字符串，或存在非空的子菜单列表
+ * - `meta.order` 数字越小越靠前；缺省为 0
+ * - 可选：`meta.icon`、`meta.permission`、`meta.hidden`、`meta.external`
+ */
+function pickTitle(meta, route) {
+    if (typeof meta.menuTitle === 'string' && meta.menuTitle) {
+        return meta.menuTitle;
+    }
+    if (typeof meta.title === 'string' && meta.title) {
+        return meta.title;
+    }
+    if (route.name != null && String(route.name)) {
+        return String(route.name);
+    }
+    return String(route.path || '');
+}
+function sortDescriptors(items) {
+    items.sort((a, b) => a.order - b.order || a.path.localeCompare(b.path));
+    for (const x of items) {
+        if (x.children && x.children.length) {
+            sortDescriptors(x.children);
+        }
+    }
+}
+/**
+ * 从插件侧 RouteConfig 树构建菜单描述（不含 component，便于并入宿主菜单 state）。
+ */
+function buildMenuDescriptorsFromRoutes(routes, pluginId) {
+    const out = [];
+    function walk(route) {
+        const meta = (route.meta || {});
+        if (meta.menu === false) {
+            return null;
+        }
+        const chIn = Array.isArray(route.children) ? route.children : [];
+        const childMenus = chIn.map(walk).filter(Boolean);
+        const hasTitle = typeof meta.title === 'string' || typeof meta.menuTitle === 'string';
+        if (!hasTitle && childMenus.length === 0) {
+            return null;
+        }
+        const item = {
+            path: String(route.path || ''),
+            name: route.name,
+            title: pickTitle(meta, route),
+            order: meta.order != null ? Number(meta.order) : 0,
+            ...(pluginId ? { pluginId } : {}),
+            ...(meta.icon !== undefined ? { icon: meta.icon } : {}),
+            ...(meta.permission !== undefined ? { permission: meta.permission } : {}),
+            ...(meta.hidden === true ? { hidden: true } : {}),
+            ...(meta.external === true ? { external: true } : {}),
+            ...(childMenus.length ? { children: childMenus } : {})
+        };
+        return item;
+    }
+    for (const r of routes) {
+        const m = walk(r);
+        if (m) {
+            out.push(m);
+        }
+    }
+    sortDescriptors(out);
+    return out;
+}
+
 /**
  * 布局中的扩展点占位；插件通过 `hostApi.registerSlotComponents(pointId, ...)` 注入组件。
  * 样式由宿主全局 CSS 覆盖 `.extension-point` / `.plugin-point-error`。
@@ -4469,7 +4550,7 @@ function createVueCliAxiosInstallOptions(deps, extra = {}) {
 function createVueCliAxiosQuickInstallOptions(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 router, deps, extra = {}) {
-    const { request, hostLayoutComponent, store, hostContext: depHostContext, applyPluginMenuItems, revokePluginMenuItems } = deps;
+    const { request, hostLayoutComponent, store, hostContext: depHostContext } = deps;
     const { hostContext: extraHostContext, isDev: extraIsDev, manifestListPath: extraListPath, ...restExtra } = extra;
     const hostContext = {
         router,
@@ -4483,8 +4564,6 @@ router, deps, extra = {}) {
     return createVueCliAxiosInstallOptions({ request }, {
         hostLayoutComponent,
         hostContext,
-        applyPluginMenuItems,
-        revokePluginMenuItems,
         isDev: extraIsDev !== undefined ? Boolean(extraIsDev) : resolveBundledIsDev(),
         manifestListPath,
         ...restExtra
@@ -4505,7 +4584,8 @@ const presetVueCliAxios = Object.freeze({
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function installVueCliAxiosWebPlugins(Vue, router, deps, extra) {
-    const exposeGlobalVue = extra?.exposeGlobalVue !== false;
+    /** 避免输出 `?.`：Vue CLI 4 / Webpack 4 默认不转译 node_modules */
+    const exposeGlobalVue = extra == null || extra.exposeGlobalVue !== false;
     if (exposeGlobalVue && typeof window !== 'undefined') {
         window.Vue = Vue;
     }
@@ -4534,7 +4614,9 @@ const WebExtendPluginVue2 = Object.freeze({
         createHostApi,
         disposeWebPlugin,
         createRequestBridge,
-        registries
+        registries,
+        buildMenuDescriptorsFromRoutes,
+        getRegisteredTopRouteNamesForPlugin
     }),
     config: Object.freeze({
         defaultWebExtendPluginRuntime,
@@ -4557,5 +4639,5 @@ const WebExtendPluginVue2 = Object.freeze({
     })
 });
 
-export { ExtensionPoint, HOST_PLUGIN_API_VERSION, RUNTIME_CONSOLE_LABEL, WebExtendPluginVue2, bootstrapPlugins, composeManifestFetch, createHostApi, createRequestBridge, createVueCliAxiosInstallOptions, createVueCliAxiosQuickInstallOptions, defaultFetchWebPluginManifest, defaultManifestFetchCache, defaultManifestMode, defaultVueCliJavaManifestListPath, defaultWebExtendPluginRuntime, disposeWebPlugin, ensurePluginHostRoute, installVueCliAxiosWebPlugins, installWebExtendPluginVue2, manifestFetchCacheMiddleware, peerMinimumVersions, presetVueCliAxios, registries, resolveManifestPathUnderApiBase, resolveRuntimeOptions, routeSynthNamePrefix, setWebExtendPluginEnv, unwrapNestedManifestBody, webExtendPluginEnvKeys, wrapManifestFetchWithCache };
+export { ExtensionPoint, HOST_PLUGIN_API_VERSION, RUNTIME_CONSOLE_LABEL, WebExtendPluginVue2, bootstrapPlugins, buildMenuDescriptorsFromRoutes, composeManifestFetch, createHostApi, createRequestBridge, createVueCliAxiosInstallOptions, createVueCliAxiosQuickInstallOptions, defaultFetchWebPluginManifest, defaultManifestFetchCache, defaultManifestMode, defaultVueCliJavaManifestListPath, defaultWebExtendPluginRuntime, disposeWebPlugin, ensurePluginHostRoute, getRegisteredTopRouteNamesForPlugin, installVueCliAxiosWebPlugins, installWebExtendPluginVue2, manifestFetchCacheMiddleware, peerMinimumVersions, presetVueCliAxios, registries, resolveManifestPathUnderApiBase, resolveRuntimeOptions, routeSynthNamePrefix, setWebExtendPluginEnv, unwrapNestedManifestBody, webExtendPluginEnvKeys, wrapManifestFetchWithCache };
 //# sourceMappingURL=index.mjs.map