@litianxiang/portal-core 0.2.4 → 0.2.6

package/README.md

@@ -71,18 +71,31 @@ export const { http, logoutToAuth } = createAuthHttpClient({
 })
 ```
 
+如果业务项目只需要一个标准站点 http 模块，也可以直接使用更薄的封装：
+
+```ts
+import { createSiteHttpModule } from '@litianxiang/portal-core'
+
+export const { http, logoutToAuth } = createSiteHttpModule({
+  getUserStore: () => useUserStore(),
+  getLoadingStore: () => useLoadingStore(),
+  onShowError: (msg) => console.error(msg)
+})
+```
+
 ## 导出方法说明（逐方法）
 
 ### app
 
-- `setupPortalApp(options)`：统一执行应用启动编排（插件注册、图标注册、beforeMount、mount）。
+- `setupApp(options)`：统一执行应用启动编排（插件注册、图标注册、beforeMount、mount）。
+- `setupRuntime(options)`：统一执行挂载前的运行时初始化（i18n、登录态同步、菜单状态、portal-ui http 绑定）。
 
 最小示例：
 
 ```ts
-import { setupPortalApp } from '@litianxiang/portal-core'
+import { setupApp } from '@litianxiang/portal-core'
 
-setupPortalApp({
+setupApp({
   app,
   plugins: [router, pinia],
   elementIcons: ElementPlusIconsVue,
@@ -108,6 +121,20 @@ const router = createAppRouter({
 })
 ```
 
+- `createStaticAppRouter(options)`：创建静态站点路由，可选统一登录守卫，适用于 portal.web、portal.auth.web 这类无动态菜单站点。
+
+最小示例：
+
+```ts
+import { createStaticAppRouter } from '@litianxiang/portal-core'
+
+const router = createStaticAppRouter({
+  staticRoutes,
+  getUserStore: () => useUserStore(),
+  requireAuth: true
+})
+```
+
 ### auth
 
 - `createLogoutToAuth(options)`：生成统一退出函数，负责清理用户态并跳转到认证站。

package/dist/index.d.ts

@@ -1,22 +1,32 @@
 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[];
+    staticRoutes: any[];
     getUserStore: () => any;
     getFirstPage?: (allMenu: any[]) => string | null | undefined;
     authLoginUrl?: string;
     /** 是否开启从 URL 参数恢复 token，默认关闭 */
     enableUrlTokenRecovery?: boolean;
 }
+interface StaticAppRouterOptions {
+    staticRoutes: any[];
+    getUserStore?: () => any;
+    authLoginUrl?: string;
+    requireAuth?: boolean;
+}
 /**
  * 创建带统一登录、动态菜单和 Tab 管理的 Router
  * 各站点只需注入各自的 userStore / tabStore / getFirstPage 即可复用
  */
 declare function createAppRouter(options: AppRouterOptions): vue_router.Router;
+/**
+ * 创建静态站点路由：
+ * - 可选统一登录守卫
+ * - 适用于 portal.web / portal.auth.web 这类无动态菜单站点
+ */
+declare function createStaticAppRouter(options: StaticAppRouterOptions): vue_router.Router;
 
 interface LogoutToAuthOptions {
     getUserStore: () => {
@@ -69,10 +79,16 @@ interface CreateAuthHttpClientOptions {
     inactiveBufferMs?: number;
     onShowError?: (msg: string) => void;
 }
+interface CreateSiteHttpModuleOptions extends CreateAuthHttpClientOptions {
+}
 declare function createAuthHttpClient(options: CreateAuthHttpClientOptions): {
     http: any;
     logoutToAuth: () => void;
 };
+declare function createSiteHttpModule(options: CreateSiteHttpModuleOptions): {
+    http: any;
+    logoutToAuth: () => void;
+};
 
 interface PermissionHelperOptions {
     /** 返回用户 Store 实例，需至少提供 getUserALLMenu 或 getUserPageMenu */
@@ -146,6 +162,7 @@ interface CoreMenuItem {
     icon?: string;
     order_num?: number;
     site?: string;
+    is_blank_page?: boolean;
     children?: CoreMenuItem[];
 }
 interface TransformMenuOptions {
@@ -503,15 +520,38 @@ interface AuthConfig {
 }
 declare const AUTH_CONFIG: AuthConfig;
 
-type PluginTuple = [Plugin, ...unknown[]];
-type UsePluginItem = Plugin | PluginTuple;
-interface SetupPortalAppOptions {
-    app: App;
+type AppLike = {
+    use: (plugin: any, ...args: any[]) => unknown;
+    component: (name: string, component: any) => unknown;
+    mount: (rootContainer: string | Element, ...args: any[]) => unknown;
+};
+type PluginTuple = [any, ...unknown[]];
+type UsePluginItem = any | PluginTuple;
+interface PortalBootstrapUserStoreLike {
+    syncFromAuthStore?: () => unknown;
+    setLoadUserMenulist?: () => unknown;
+}
+interface SetupAppOptions {
+    app: AppLike;
     plugins?: UsePluginItem[];
     elementIcons?: Record<string, unknown>;
     beforeMount?: () => void;
     mountSelector?: string;
 }
+interface SetupRuntimeOptions {
+    initI18n?: () => void;
+    getUserStore?: () => PortalBootstrapUserStoreLike | null | undefined;
+    bindPortalUiHttp?: () => void;
+    beforeReady?: () => void;
+}
+/**
+ * 统一处理业务前端在挂载前的常见初始化：
+ * 1. 绑定 i18n 工具
+ * 2. 恢复统一登录缓存
+ * 3. 重置菜单加载状态
+ * 4. 注入 portal-ui http 实例
+ */
+declare function setupRuntime(options: SetupRuntimeOptions): void;
 /**
  * 按 Portal 约定完成应用启动编排：
  * 1. 注册插件
@@ -519,7 +559,7 @@ interface SetupPortalAppOptions {
  * 3. 执行挂载前回调
  * 4. 挂载应用
  */
-declare function setupPortalApp(options: SetupPortalAppOptions): void;
+declare function setupApp(options: SetupAppOptions): void;
 
 interface CreateI18nOptions {
     /** 翻译消息，key 为 locale（如 'zh-CN'），value 为翻译对象 */
@@ -537,4 +577,4 @@ interface CreateI18nOptions {
  */
 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 };
+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, type CreateSiteHttpModuleOptions, 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 PortalBootstrapUserStoreLike, type PresetRangeKey, type SetupAppOptions, type SetupRuntimeOptions, type SidebarMenuFilterOptions, type StaticAppRouterOptions, 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, createSiteHttpModule, createStaticAppRouter, createTabStoreOptions, fetchUserMenuForStore, filterSidebarMenu, findFirstPagePath, formatRange, formatTime, formatToMonthDay, formatToWanShou, formatToYi, formatWanYuanToYi, getDefaultAuthLoginUrl, getPresetRange, humanizeTime, initTheme, isInRange, removeTab, setupApp, setupRuntime, syncFromAuthStoreToStore, timeDiff, transformMenuTree, useThemeWatcher, useTime };

package/dist/index.js

@@ -101,6 +101,7 @@ function transformMenuTree(menuList, options) {
       icon: item?.icon,
       order_num: item?.order_num,
       site: item?.site ?? defaultSite,
+      is_blank_page: item?.is_blank_page,
       children
     };
   });
@@ -117,6 +118,7 @@ function buildAllMenuTree(menuList) {
       icon: item.icon,
       order_num: item.order_num,
       site: item.site,
+      is_blank_page: item.is_blank_page,
       children: item.children && item.children.length > 0 ? buildAllMenuTree(item.children) : []
     });
   }
@@ -135,6 +137,7 @@ function buildPageMenuList(menuList) {
         icon: item.icon,
         order_num: item.order_num,
         site: item.site,
+        is_blank_page: item.is_blank_page,
         children: item.children ? buildPageMenuList(item.children) : []
       });
     } else if (item.children && item.children.length > 0) {
@@ -150,6 +153,7 @@ function buildPageMenuList(menuList) {
             icon: child.icon,
             order_num: child.order_num,
             site: child.site,
+            is_blank_page: child.is_blank_page,
             children: child.children
           });
         }
@@ -172,6 +176,9 @@ function findFirstPagePath(menuList) {
 }
 
 // src/router/router.ts
+function resolveAuthLoginUrl(authLoginUrl) {
+  return authLoginUrl || `${window.location.origin}/auth/#/login`;
+}
 function createAppRouter(options) {
   const {
     staticRoutes,
@@ -207,7 +214,7 @@ function createAppRouter(options) {
     history: createWebHashHistory(),
     routes: staticRoutes
   });
-  const AUTH_LOGIN_URL = authLoginUrl || `${window.location.origin}/auth/#/login`;
+  const AUTH_LOGIN_URL = resolveAuthLoginUrl(authLoginUrl);
   const modules = import.meta.glob("@/views/**/*.vue");
   const registeredPaths = /* @__PURE__ */ new Set();
   const resolveRouteAndView = (item) => {
@@ -369,6 +376,43 @@ function createAppRouter(options) {
   });
   return router;
 }
+function createStaticAppRouter(options) {
+  const {
+    staticRoutes,
+    getUserStore,
+    authLoginUrl,
+    requireAuth = false
+  } = options;
+  const router = createRouter({
+    history: createWebHashHistory(),
+    routes: staticRoutes
+  });
+  if (!requireAuth || !getUserStore) {
+    return router;
+  }
+  const AUTH_LOGIN_URL = resolveAuthLoginUrl(authLoginUrl);
+  router.beforeEach((_to, _from, next) => {
+    const userStore = getUserStore();
+    let accessToken = userStore.getUserAccessToken;
+    if (accessToken && !userStore.getUserName) {
+      userStore.syncFromAuthStore?.();
+      accessToken = userStore.getUserAccessToken;
+    }
+    if (!accessToken) {
+      const restored = userStore.syncFromAuthStore?.();
+      if (restored) {
+        accessToken = userStore.getUserAccessToken;
+      }
+    }
+    if (!accessToken) {
+      const currentUrl = encodeURIComponent(window.location.href);
+      window.location.href = `${AUTH_LOGIN_URL}?redirect=${currentUrl}`;
+      return;
+    }
+    next();
+  });
+  return router;
+}
 
 // src/config/auth-config.ts
 var DEFAULT_SSO_STORAGE_KEY = "auth-user-store";
@@ -612,6 +656,13 @@ function createAuthHttpClient(options) {
   );
   return { http, logoutToAuth };
 }
+function createSiteHttpModule(options) {
+  const { http, logoutToAuth } = createAuthHttpClient(options);
+  return {
+    http,
+    logoutToAuth
+  };
+}
 
 // src/permission/permission.ts
 function normalizePath2(raw) {
@@ -1006,9 +1057,12 @@ function createMenuUserGetters() {
     isMenuLoaded: (state) => state.menuLoaded
   };
 }
+function isBlankPageMenu(item) {
+  return item?.is_blank_page === true || item?.is_blank_page === "true" || item?.is_blank_page === 1;
+}
 function filterSidebarMenu(menus, options) {
   const exclude = options?.excludeCategories ?? ["button", "flow-module", "flow-page"];
-  return (menus || []).filter((item) => !exclude.includes(item?.category)).map((item) => ({
+  return (menus || []).filter((item) => !exclude.includes(item?.category) && !isBlankPageMenu(item)).map((item) => ({
     ...item,
     children: item.children && item.children.length > 0 ? filterSidebarMenu(item.children, options) : []
   }));
@@ -1173,7 +1227,21 @@ function usePlugin(app, plugin) {
   }
   app.use(plugin);
 }
-function setupPortalApp(options) {
+function setupRuntime(options) {
+  const {
+    initI18n,
+    getUserStore,
+    bindPortalUiHttp,
+    beforeReady
+  } = options;
+  initI18n?.();
+  const userStore = getUserStore?.();
+  userStore?.syncFromAuthStore?.();
+  userStore?.setLoadUserMenulist?.();
+  bindPortalUiHttp?.();
+  beforeReady?.();
+}
+function setupApp(options) {
   const {
     app,
     plugins = [],
@@ -1242,6 +1310,8 @@ export {
   createPermissionHelper,
   createPortalI18n,
   createRange,
+  createSiteHttpModule,
+  createStaticAppRouter,
   createTabStoreOptions,
   fetchUserMenuForStore,
   filterSidebarMenu,
@@ -1258,7 +1328,8 @@ export {
   initTheme,
   isInRange,
   removeTab,
-  setupPortalApp,
+  setupApp,
+  setupRuntime,
   syncFromAuthStoreToStore,
   timeDiff,
   transformMenuTree,

package/package.json

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