@litianxiang/portal-core 0.1.3 → 0.1.4

package/README.md

@@ -1,19 +1,21 @@
 # @litianxiang/portal-core 使用说明
 
-`@litianxiang/portal-core` 是一套门户子系统通用的路由内核，负责统一处理：
+`@litianxiang/portal-core` 是一套门户子系统通用的路由/认证内核，负责统一处理：
 
 - 登录态校验 + SSO 恢复
 - 菜单加载与动态路由挂载
 - 根路径重定向到第一个业务页面
-- Tab 状态重置与配合各系统的 Tab Store
+- 统一退出到认证站、空闲超时判断等通用认证逻辑
 
-各子系统只需注入自己的静态路由、用户 Store、Tab Store 和“第一个页面”的计算函数，即可接入。
+各子系统只需注入自己的静态路由、用户 Store、（可选）Tab Store 和“第一个页面”的计算函数，即可接入。
 
 ## 安装
 
 ```bash
 pnpm add @litianxiang/portal-core
 # 或
+pnpm update @litianxiang/portal-core
+# 或
 npm install @litianxiang/portal-core
 ```
 
@@ -24,13 +26,17 @@ npm install @litianxiang/portal-core
 
 ## 导出的能力
 
-当前仅导出一个工厂函数：
+当前主要导出以下能力：
 
 ```ts
-import { createAppRouter } from '@litianxiang/portal-core'
+import {
+  createAppRouter,
+  createLogoutToAuth,
+  calcInactivityAction
+} from '@litianxiang/portal-core'
 ```
 
-类型签名简化说明：
+`createAppRouter` 类型签名简化说明：
 
 ```ts
 interface AppRouterOptions {
@@ -42,6 +48,38 @@ interface AppRouterOptions {
 }
 
 function createAppRouter(options: AppRouterOptions): Router
+
+`auth` 相关工具简化说明：
+
+```ts
+interface LogoutOptions {
+  getUserStore: () => any          // 返回当前系统的 userStore（需提供 clearUserInfo 等方法）
+  getLoadingStore?: () => any      // 返回 loadingStore（可选，用于全局 loading 结束）
+  authLoginUrl?: string            // 统一登录地址（不传则默认 /auth/#/login）
+  ssoStorageKey?: string           // 统一登录本地缓存 key，默认 'user-store'
+}
+
+// 生成一个“退出到统一登录”的函数，一般在 http 拦截器或手动退出按钮中调用
+function createLogoutToAuth(options: LogoutOptions): () => void
+
+// 计算基于最后一次操作时间的“是否需要退出/刷新 token”等动作
+interface InactivityOptions {
+  expireMs?: number   // token 允许的最大空闲时间，默认 2 小时
+  bufferMs?: number   // 提前刷新 token 的缓冲时间，默认 5 分钟
+}
+
+function calcInactivityAction(
+  lastActiveTime: number | null | undefined,
+  now: number,
+  options?: InactivityOptions
+): {
+  shouldLogout: boolean
+  shouldRefresh: boolean
+  inactiveMs: number
+  expireMs: number
+  bufferMs: number
+}
+```
 ```
 
 ## 子系统接入步骤
@@ -119,11 +157,13 @@ export const useUserStore = defineStore('user', {
 })
 ```
 
-### 3. 准备 Tab Store（可选但推荐）
+### 3. 准备 Tab Store（可选）
+
+Tab Store 主要用于和各系统的 Tab 控件协作，例如在“手动退出”时统一清理 Tab。当前路由内核在菜单加载 / 刷新场景下不会自动清空 Tab。
 
-Tab Store 主要用于在根路径访问时清空 Tab，接口建议包含：
+建议至少包含：
 
-- `clearAll()`：清空所有 Tab
+- `clearAll()`：清空当前系统的所有 Tab
 
 示例：
 
@@ -171,8 +211,61 @@ const router = createAppRouter({
 
 export default router
 ```
+### 6.（可选）接入统一退出与空闲超时控制
+
+在各子系统的 http 封装中，可以结合 `createLogoutToAuth` 和 `calcInactivityAction` 实现统一退出与“2 小时未操作自动退出”的逻辑。例如：
+
+```ts
+// src/utils/http.ts
+import axios from 'axios'
+import { createLogoutToAuth, calcInactivityAction } from '@litianxiang/portal-core'
+import { useUserStore } from '@/stores/user'
+import { useLoadingStore } from '@/stores/loading'
+
+const logoutToAuth = createLogoutToAuth({
+  getUserStore: () => useUserStore(),
+  getLoadingStore: () => useLoadingStore(),
+  authLoginUrl: import.meta.env.VITE_AUTH_LOGIN_URL
+})
+
+axios.interceptors.request.use(async config => {
+  const userStore = useUserStore()
+  const { shouldLogout, shouldRefresh } = calcInactivityAction(
+    userStore.lastActiveTime,
+    Date.now()
+  )
+
+  if (shouldLogout) {
+    logoutToAuth()
+    return Promise.reject(new Error('登录已过期'))
+  }
+
+  if (shouldRefresh) {
+    // 此处调用后端刷新 token 接口，成功后更新 userStore 中的 token
+  }
+
+  // 正常附带 Authorization 头，并更新 lastActiveTime
+  if (userStore.getUserAccessToken) {
+    config.headers = config.headers || {}
+    config.headers.Authorization = `Bearer ${userStore.getUserAccessToken}`
+    userStore.updateLastActiveTime?.()
+  }
+
+  return config
+})
+
+axios.interceptors.response.use(
+  res => res,
+  error => {
+    if (error.response?.status === 401) {
+      logoutToAuth()
+    }
+    return Promise.reject(error)
+  }
+)
+```
 
-### 6. 项目视图目录约定
+### 7. 项目视图目录约定
 
 `portal-core` 会根据后端菜单返回的 `path` 去匹配前端视图，规则如下：
 
@@ -196,15 +289,16 @@ export default router
   - 若本地无 token，会尝试通过 `syncFromAuthStore()` 从统一登录站点恢复；
   - 若仍无 token，则跳转到 `authLoginUrl`，并携带当前地址作为 `redirect`；
 - 若用户已登录但菜单未加载：
-  - 会清空之前的动态路由和 Tab；
+  - 会清空之前的动态路由，并通过 `resetMenuLoaded()` 重置菜单状态；
   - 调用 `fetchUserMenu()` 拉取菜单，成功后：
     - 按菜单生成动态路由并挂到 `main` 下；
-    - 根据 `getFirstPage(allMenu)` 计算首页路径并重定向过去；
+    - 若当前访问的是根路径 `/`，会根据 `getFirstPage(allMenu)` 计算首页路径并重定向过去；
+    - 若当前访问的是具体业务路径（例如刷新了某个子页面），则保持在当前路径，不强制跳转，Tab 也不会被清空；
 - 若菜单已加载且访问根路径 `/`：
-  - 会先清空 Tab，再跳转到 `getFirstPage(allMenu)` 对应的页面。
+  - 仅将 `/` 映射到 `getFirstPage(allMenu)` 对应的页面，不再清空 Tab。
 
 这样可以保证：
 
 - 登录后总是落在第一个业务页面；
-- 刷新页面或重新打开浏览器时，能自动恢复登录并重新加载菜单；
+- 刷新页面或重新打开浏览器时，能自动恢复登录并重新加载菜单，同时尽量停留在当前业务页面和已有 Tab 上；
 - 不同子系统之间互不干扰，只共享统一登录站点。

package/dist/index.js

@@ -98,8 +98,6 @@ function createAppRouter(options) {
       return;
     }
     if (userStore.isMenuLoaded && (to.path === "/" || to.path === "")) {
-      const tabStore = getTabStore();
-      tabStore.clearAll();
       const allMenu = userStore.getUserALLMenu;
       if (allMenu && allMenu.length > 0) {
         const firstPage = getFirstPage(allMenu);
@@ -119,8 +117,6 @@ function createAppRouter(options) {
     }
     if (!userStore.isMenuLoaded) {
       clearDynamicRoutes();
-      const tabStore = getTabStore();
-      tabStore.clearAll();
       userStore.resetMenuLoaded();
       const success = await userStore.fetchUserMenu();
       if (!success) {
@@ -130,19 +126,21 @@ function createAppRouter(options) {
       const allMenu = userStore.getUserALLMenu;
       if (allMenu && allMenu.length > 0) {
         addDynamicRoutes(allMenu);
-        const firstPage = getFirstPage(allMenu);
-        if (firstPage) {
-          const [basePath, queryString] = firstPage.split("?");
-          const query = {};
-          if (queryString) {
-            queryString.split("&").forEach((param) => {
-              const [key, value] = param.split("=");
-              if (key) query[key] = value || "";
-            });
+        if (to.path === "/" || to.path === "") {
+          const firstPage = getFirstPage(allMenu);
+          if (firstPage) {
+            const [basePath, queryString] = firstPage.split("?");
+            const query = {};
+            if (queryString) {
+              queryString.split("&").forEach((param) => {
+                const [key, value] = param.split("=");
+                if (key) query[key] = value || "";
+              });
+            }
+            justLoadedMenu = true;
+            next({ path: basePath, query, replace: true });
+            return;
           }
-          justLoadedMenu = true;
-          next({ path: basePath, query, replace: true });
-          return;
         }
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@litianxiang/portal-core",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "private": false,
   "type": "module",
   "main": "dist/index.js",