@litianxiang/portal-core 0.1.21 → 0.1.23

package/dist/index.d.ts

@@ -1,13 +1,16 @@
 import * as vue_router from 'vue-router';
 import { RouteRecordRaw } from 'vue-router';
 import { Dayjs } from 'dayjs';
+import { App, Plugin } from 'vue';
+import * as vue_i18n from 'vue-i18n';
 
 interface AppRouterOptions {
     staticRoutes: RouteRecordRaw[];
     getUserStore: () => any;
-    getTabStore: () => any;
-    getFirstPage: (allMenu: any[]) => string | null | undefined;
+    getFirstPage?: (allMenu: any[]) => string | null | undefined;
     authLoginUrl?: string;
+    /** 是否开启从 URL 参数恢复 token，默认关闭 */
+    enableUrlTokenRecovery?: boolean;
 }
 /**
  * 创建带统一登录、动态菜单和 Tab 管理的 Router
@@ -24,11 +27,13 @@ interface LogoutToAuthOptions {
     };
     authLoginUrl?: string;
     ssoStorageKey?: string;
+    legacySsoStorageKey?: string;
+    fallbackAccessTokenKey?: string;
 }
 /**
  * 创建统一退出方法：
  * - 清除当前子系统的用户信息
- * - 清除统一登录站点的本地缓存（默认 key: user-store）
+ * - 清除统一登录站点的本地缓存（默认 key: auth-user-store）
  * - 跳转到统一登录地址，携带 redirect
  */
 declare function createLogoutToAuth(options: LogoutToAuthOptions): () => void;
@@ -89,6 +94,9 @@ interface PermissionHelper {
      */
     hasAnyPermission: (codesOrPaths: string[]) => boolean;
 }
+/**
+ * 创建统一权限判断工具，提供页面权限、按钮权限和任意权限判断。
+ */
 declare function createPermissionHelper(options: PermissionHelperOptions): PermissionHelper;
 
 interface MenuHelperOptions {
@@ -121,6 +129,9 @@ interface MenuHelper {
      */
     getBreadcrumb: (path: string) => BreadcrumbItem[];
 }
+/**
+ * 创建菜单辅助工具，统一提供查找、标题、链路、父级与面包屑能力。
+ */
 declare function createMenuHelper(options: MenuHelperOptions): MenuHelper;
 /**
  * 标准化后的菜单节点结构，供各前端站点复用
@@ -207,6 +218,9 @@ declare function getPresetRange(key: PresetRangeKey, now?: TimeInput): TimeRange
  * 判断某个时间是否在区间内（含边界）
  */
 declare function isInRange(value: TimeInput, range: TimeRange<TimeInput>): boolean;
+/**
+ * 组合导出时间工具方法，便于在业务中按对象方式使用。
+ */
 declare function useTime(): {
     formatTime: typeof formatTime;
     humanizeTime: typeof humanizeTime;
@@ -257,23 +271,132 @@ interface TabItem {
     keepAlive: boolean;
 }
 declare const DEFAULT_HOME_PATH = "/main/home";
+/**
+ * 向标签页列表追加新标签；若路径已存在则保持原列表。
+ */
 declare function addTab(tabs: TabItem[], tab: TabItem): TabItem[];
+/**
+ * 根据路径移除指定标签页。
+ */
 declare function removeTab(tabs: TabItem[], path: string): TabItem[];
+/**
+ * 关闭除当前与首页外的其他标签页。
+ */
 declare function closeOthers(tabs: TabItem[], path: string, homePath?: string): TabItem[];
+/**
+ * 关闭当前标签左侧的标签页（首页始终保留）。
+ */
 declare function closeLeft(tabs: TabItem[], path: string, homePath?: string): TabItem[];
+/**
+ * 关闭当前标签右侧的标签页（首页始终保留）。
+ */
 declare function closeRight(tabs: TabItem[], path: string, homePath?: string): TabItem[];
+/**
+ * 关闭所有可关闭标签，仅保留不可关闭项。
+ */
 declare function closeAll(tabs: TabItem[]): TabItem[];
+/**
+ * 为 Pinia 创建通用的 Tab Store 配置
+ * @param homePath 首页路径，默认 /main/home
+ */
+declare function createTabStoreOptions(homePath?: string): {
+    state: () => {
+        tabs: TabItem[];
+    };
+    actions: {
+        addTab(this: {
+            tabs: TabItem[];
+        }, tab: TabItem): void;
+        removeTab(this: {
+            tabs: TabItem[];
+        }, path: string): void;
+        closeOthers(this: {
+            tabs: TabItem[];
+        }, path: string): void;
+        closeLeft(this: {
+            tabs: TabItem[];
+        }, path: string): void;
+        closeRight(this: {
+            tabs: TabItem[];
+        }, path: string): void;
+        closeAll(this: {
+            tabs: TabItem[];
+        }): void;
+    };
+};
 
-interface CoreUserStoreLike {
+interface BaseUserStoreLike {
     userno: string;
     username: string;
     access_token: string;
     refresh_token: string;
     lastActiveTime: number | null;
+}
+/**
+ * 创建基础用户状态（不含菜单）。
+ * 适用于 portal.web、portal.auth.web 等轻量站点。
+ */
+declare function createBaseUserState(): BaseUserStoreLike;
+/**
+ * 创建基础用户 getters（不含菜单）。
+ */
+declare function createBaseUserGetters(): {
+    getUserInfo: (state: any) => {
+        userno: any;
+        username: any;
+        access_token: any;
+        refresh_token: any;
+        lastActiveTime: any;
+    };
+    getUserNo: (state: any) => any;
+    getUserName: (state: any) => any;
+    getUserAccessToken: (state: any) => any;
+    getUserRefreshToken: (state: any) => any;
+    getUserLastActiveTime: (state: any) => any;
+};
+interface CreateBaseUserActionsOptions {
+    /** SSO 缓存 key，默认读取 AUTH_CONFIG.ssoStorageKey */
+    ssoStorageKey?: string;
+}
+/**
+ * 创建基础用户 actions（不含菜单）。
+ */
+declare function createBaseUserActions(options?: CreateBaseUserActionsOptions): {
+    setUserInfo(this: BaseUserStoreLike, userInfo: any): void;
+    setUserAccessToken(this: BaseUserStoreLike, access_token: string): void;
+    setUserRefreshToken(this: BaseUserStoreLike, refresh_token: string): void;
+    setUserLastActiveTime(this: BaseUserStoreLike, lastActiveTime: number): void;
+    syncFromAuthStore(this: BaseUserStoreLike): boolean;
+    clearUserInfo(this: BaseUserStoreLike): void;
+};
+interface CoreUserStoreLike extends BaseUserStoreLike {
     all_menu: any[];
     sidebar_menu: any[];
     menuLoaded: boolean;
 }
+interface CoreMenuUserState<TMenu = any> extends CoreUserStoreLike {
+    all_menu: TMenu[];
+    sidebar_menu: TMenu[];
+}
+/**
+ * 创建管理站点用户状态（含菜单）。
+ * 适用于带动态菜单的后台系统。
+ */
+declare function createMenuUserState<TMenu = any>(): CoreMenuUserState<TMenu>;
+/**
+ * 创建管理站点用户 getters（含菜单）。
+ */
+declare function createMenuUserGetters<TUserInfo = any>(): {
+    getUserInfo: (state: any) => TUserInfo;
+    getUserNo: (state: any) => any;
+    getUserName: (state: any) => any;
+    getUserAccessToken: (state: any) => any;
+    getUserRefreshToken: (state: any) => any;
+    getUserLastActiveTime: (state: any) => any;
+    getUserALLMenu: (state: any) => any;
+    getUserSidebarMenu: (state: any) => any;
+    isMenuLoaded: (state: any) => any;
+};
 interface SidebarMenuFilterOptions {
     /** 需要排除的菜单类别 */
     excludeCategories?: string[];
@@ -283,8 +406,12 @@ interface SidebarMenuFilterOptions {
  */
 declare function filterSidebarMenu(menus: any[], options?: SidebarMenuFilterOptions): any[];
 interface SyncFromAuthStoreOptions {
-    /** 统一登录站点在 localStorage 中使用的 key，默认 user-store */
+    /** 统一登录站点在 localStorage 中使用的 key，默认 auth-user-store */
     storageKey?: string;
+    /** 历史兼容 key，默认 user-store */
+    legacyStorageKey?: string;
+    /** 仅 access_token 的兜底 key，默认 portal_access_token */
+    fallbackAccessTokenKey?: string;
 }
 /**
  * 从统一登录站点的本地缓存中恢复用户基础信息
@@ -297,6 +424,28 @@ interface FetchUserMenuForStoreOptions {
     getALLMenu: (menuTree: any[]) => any[];
     filterOptions?: SidebarMenuFilterOptions;
 }
+interface CreateMenuUserActionsOptions {
+    http: any;
+    site: string;
+    transformMenuData: (data: any[]) => any[];
+    getALLMenu: (menuTree: any[]) => any[];
+    filterOptions?: SidebarMenuFilterOptions;
+    ssoStorageKey?: string;
+}
+/**
+ * 创建管理站点用户 actions（含菜单请求、菜单状态维护、SSO 恢复）。
+ */
+declare function createMenuUserActions(options: CreateMenuUserActionsOptions): {
+    setUserInfo(this: CoreUserStoreLike, userInfo: any): void;
+    setUserAccessToken(this: CoreUserStoreLike, access_token: string): void;
+    setUserRefreshToken(this: CoreUserStoreLike, refresh_token: string): void;
+    setUserLastActiveTime(this: CoreUserStoreLike, lastActiveTime: number): void;
+    syncFromAuthStore(this: CoreUserStoreLike): boolean;
+    setLoadUserMenulist(this: CoreUserStoreLike): void;
+    fetchUserMenu(this: CoreUserStoreLike): Promise<boolean>;
+    resetMenuLoaded(this: CoreUserStoreLike): void;
+    clearUserInfo(this: CoreUserStoreLike): void;
+};
 /**
  * 为指定站点拉取并设置用户菜单（包含完整菜单树和侧边栏菜单）
  */
@@ -325,7 +474,7 @@ declare function createLoadingStoreOptions(): {
  * - DEFAULT_AUTH_LOGIN_ENV_KEY: 前端项目中约定的统一登录地址环境变量名
  * - DEFAULT_AUTH_LOGIN_PATH: 统一登录站点在当前域下的默认路径
  */
-declare const DEFAULT_SSO_STORAGE_KEY = "user-store";
+declare const DEFAULT_SSO_STORAGE_KEY = "auth-user-store";
 declare const DEFAULT_AUTH_LOGIN_ENV_KEY = "VITE_AUTH_LOGIN_URL";
 declare const DEFAULT_AUTH_LOGIN_PATH = "/auth/#/login";
 /**
@@ -335,7 +484,7 @@ declare const DEFAULT_AUTH_LOGIN_PATH = "/auth/#/login";
  */
 declare function getDefaultAuthLoginUrl(): string;
 interface AuthConfig {
-    /** 统一登录站点在 localStorage 中使用的 key，默认 user-store */
+    /** 统一登录站点在 localStorage 中使用的 key，默认 auth-user-store */
     ssoStorageKey: string;
     /** 前端项目中约定的统一登录地址环境变量名，默认 VITE_AUTH_LOGIN_URL */
     authLoginEnvKey: string;
@@ -344,4 +493,38 @@ interface AuthConfig {
 }
 declare const AUTH_CONFIG: AuthConfig;
 
-export { AUTH_CONFIG, type AppRouterOptions, type AuthConfig, type BreadcrumbItem, type CoreMenuItem, type CoreUserStoreLike, type CreateAuthHttpClientOptions, DEFAULT_AUTH_LOGIN_ENV_KEY, DEFAULT_AUTH_LOGIN_PATH, DEFAULT_HOME_PATH, DEFAULT_SSO_STORAGE_KEY, type FetchUserMenuForStoreOptions, type FontSize, type InactivityConfig, type InactivityResult, type LoadingState, type LogoutToAuthOptions, type MenuHelper, type MenuHelperOptions, type PermissionHelper, type PermissionHelperOptions, type PresetRangeKey, type SidebarMenuFilterOptions, type SyncFromAuthStoreOptions, type TabItem, type ThemeConfig, type ThemeMode, type TimeInput, type TimeRange, type TransformMenuOptions, addTab, applyTheme, buildAllMenuTree, buildPageMenuList, calcInactivityAction, closeAll, closeLeft, closeOthers, closeRight, createAppRouter, createAuthHttpClient, createLoadingStoreOptions, createLogoutToAuth, createMenuHelper, createPermissionHelper, createRange, fetchUserMenuForStore, filterSidebarMenu, findFirstPagePath, formatRange, formatTime, formatToMonthDay, formatToWanShou, formatToYi, formatWanYuanToYi, getDefaultAuthLoginUrl, getPresetRange, humanizeTime, initTheme, isInRange, removeTab, syncFromAuthStoreToStore, timeDiff, transformMenuTree, useThemeWatcher, useTime };
+type PluginTuple = [Plugin, ...unknown[]];
+type UsePluginItem = Plugin | PluginTuple;
+interface SetupPortalAppOptions {
+    app: App;
+    plugins?: UsePluginItem[];
+    elementIcons?: Record<string, unknown>;
+    beforeMount?: () => void;
+    mountSelector?: string;
+}
+/**
+ * 按 Portal 约定完成应用启动编排：
+ * 1. 注册插件
+ * 2. 注册 Element Plus 图标
+ * 3. 执行挂载前回调
+ * 4. 挂载应用
+ */
+declare function setupPortalApp(options: SetupPortalAppOptions): void;
+
+interface CreateI18nOptions {
+    /** 翻译消息，key 为 locale（如 'zh-CN'），value 为翻译对象 */
+    messages: Record<string, any>;
+    /** localStorage 中存储语言偏好的 key，默认 'locale' */
+    storageKey?: string;
+    /** 默认语言，默认 'zh-CN' */
+    defaultLocale?: string;
+    /** 回退语言，默认 'zh-CN' */
+    fallbackLocale?: string;
+}
+/**
+ * 创建统一配置的 vue-i18n 实例
+ * 四个站点的初始化逻辑完全相同，只有翻译内容不同
+ */
+declare function createPortalI18n(options: CreateI18nOptions): vue_i18n.I18n<Record<string, any>, {}, {}, string, false>;
+
+export { AUTH_CONFIG, type AppRouterOptions, type AuthConfig, type BaseUserStoreLike, type BreadcrumbItem, type CoreMenuItem, type CoreMenuUserState, type CoreUserStoreLike, type CreateAuthHttpClientOptions, type CreateBaseUserActionsOptions, type CreateI18nOptions, type CreateMenuUserActionsOptions, DEFAULT_AUTH_LOGIN_ENV_KEY, DEFAULT_AUTH_LOGIN_PATH, DEFAULT_HOME_PATH, DEFAULT_SSO_STORAGE_KEY, type FetchUserMenuForStoreOptions, type FontSize, type InactivityConfig, type InactivityResult, type LoadingState, type LogoutToAuthOptions, type MenuHelper, type MenuHelperOptions, type PermissionHelper, type PermissionHelperOptions, type PresetRangeKey, type SetupPortalAppOptions, type SidebarMenuFilterOptions, type SyncFromAuthStoreOptions, type TabItem, type ThemeConfig, type ThemeMode, type TimeInput, type TimeRange, type TransformMenuOptions, addTab, applyTheme, buildAllMenuTree, buildPageMenuList, calcInactivityAction, closeAll, closeLeft, closeOthers, closeRight, createAppRouter, createAuthHttpClient, createBaseUserActions, createBaseUserGetters, createBaseUserState, createLoadingStoreOptions, createLogoutToAuth, createMenuHelper, createMenuUserActions, createMenuUserGetters, createMenuUserState, createPermissionHelper, createPortalI18n, createRange, createTabStoreOptions, fetchUserMenuForStore, filterSidebarMenu, findFirstPagePath, formatRange, formatTime, formatToMonthDay, formatToWanShou, formatToYi, formatWanYuanToYi, getDefaultAuthLoginUrl, getPresetRange, humanizeTime, initTheme, isInRange, removeTab, setupPortalApp, syncFromAuthStoreToStore, timeDiff, transformMenuTree, useThemeWatcher, useTime };