web-extend-plugin-vue2 0.2.5 → 0.3.0

package/index.d.ts

@@ -48,16 +48,6 @@ export type AdaptRouteDeclarationsFn = (ctx: {
   declarations: ReadonlyArray<RouteDeclaration>
 }) => VueRouteConfig[]
 
-/** 将插件 `registerMenuItems` 提交的数据并入宿主用于渲染侧栏/目录的 state（映射规则由宿主实现） */
-export type ApplyPluginMenuItemsFn = (ctx: {
-  pluginId: string
-  /** 已在各条上附带 `pluginId`，并按 `order` 升序 */
-  items: Array<Record<string, unknown>>
-}) => void
-
-/** 卸载插件时移除该插件贡献的菜单数据 */
-export type RevokePluginMenuItemsFn = (pluginId: string) => void
-
 /** 宿主在 `resolveRuntimeOptions({ hostContext })` 中注入；经浅冻结后由 `hostApi.hostContext` 只读暴露 */
 export type HostContext = Readonly<Record<string, unknown>>
 
@@ -88,8 +78,6 @@ export type VueCliAxiosQuickDeps = {
   hostLayoutComponent: unknown
   store?: unknown
   hostContext?: Record<string, unknown>
-  applyPluginMenuItems?: (ctx: { pluginId: string; items: Array<Record<string, unknown>> }) => void
-  revokePluginMenuItems?: (pluginId: string) => void
 }
 
 export type HostKitOptions = {
@@ -100,10 +88,6 @@ export type HostKitOptions = {
   transformRoutes?: TransformRoutesFn
   interceptRegisterRoutes?: InterceptRegisterRoutesFn
   adaptRouteDeclarations?: AdaptRouteDeclarationsFn
-  /** 必填：插件调用 `registerMenuItems` 时由此写入宿主菜单/路由树等数据结构 */
-  applyPluginMenuItems?: ApplyPluginMenuItemsFn
-  /** 建议与 `applyPluginMenuItems` 成对配置；`disposeWebPlugin` 会调用以撤销该插件菜单 */
-  revokePluginMenuItems?: RevokePluginMenuItemsFn
   /** 由引导流程浅冻结后传入各插件的 `hostApi.hostContext` */
   hostContext?: HostContext
 }
@@ -128,7 +112,7 @@ export type WebExtendPluginRuntimeOptions = HostKitOptions &
     pluginMountPath?: string
     /** 壳路由 meta */
     pluginHostRouteMeta?: Record<string, unknown>
-    /** 是否执行自动壳路由注册，默认 true */
+    /** 为 true 时且配置了 `pluginRoutesParentName` + `hostLayoutComponent` 才自动注册壳路由；默认 false */
     ensurePluginHostRoute?: boolean
     isDev?: boolean
     webPluginDevOrigin?: string
@@ -163,11 +147,6 @@ export interface HostApi {
    * 流水线：`adaptRouteDeclarations` → `transformRoutes` → `interceptRegisterRoutes` 或默认注册。
    */
   registerRoutes(routes: VueRouteConfig[] | RouteDeclaration[]): void
-  /**
-   * 向宿主登记侧栏/目录菜单意图；由 `applyPluginMenuItems` 写入宿主 state。
-   * 未配置 `applyPluginMenuItems` 时调用会抛错。
-   */
-  registerMenuItems(items: Record<string, unknown>[]): void
   registerSlotComponents(
     pointId: string,
     components: Array<{ component: unknown; priority?: number }>
@@ -202,6 +181,29 @@ export type ManifestFetchCacheOptions = {
   now?: () => number
 }
 
+/** 从路由 meta 推导的菜单节点（供宿主侧栏；与 `buildMenuDescriptorsFromRoutes` 配套） */
+export type PluginMenuDescriptor = {
+  path: string
+  name?: string | symbol
+  title: string
+  order: number
+  pluginId?: string
+  icon?: unknown
+  permission?: unknown
+  hidden?: boolean
+  external?: boolean
+  children?: PluginMenuDescriptor[]
+}
+
+/** 由插件 `RouteConfig` 树生成菜单描述（不含 component） */
+export function buildMenuDescriptorsFromRoutes(
+  routes: VueRouteConfig[],
+  pluginId?: string
+): PluginMenuDescriptor[]
+
+/** 调试：返回 `registerRoutes` 为该插件登记的顶层 route name */
+export function getRegisteredTopRouteNamesForPlugin(pluginId: string): string[]
+
 /** 命名空间聚合对象，按领域分组 */
 export const WebExtendPluginVue2: Readonly<{
   install: (Vue: unknown, router: unknown, options?: WebExtendPluginRuntimeOptions) => Promise<void>
@@ -232,6 +234,8 @@ export const WebExtendPluginVue2: Readonly<{
       request: (path: string, init?: RequestInit) => Promise<Response>
     }
     registries: unknown
+    buildMenuDescriptorsFromRoutes: typeof buildMenuDescriptorsFromRoutes
+    getRegisteredTopRouteNamesForPlugin: typeof getRegisteredTopRouteNamesForPlugin
   }>
   config: Readonly<{
     defaultWebExtendPluginRuntime: Record<string, unknown>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "web-extend-plugin-vue2",
-  "version": "0.2.5",
+  "version": "0.3.0",
   "publishConfig": {
     "access": "public"
   },