cosey 0.10.21 → 0.10.22

package/config/api.d.ts

@@ -12,10 +12,6 @@ export declare const defaultApiConfig: {
      * 登录
      */
     login: ((data: any, config?: AxiosRequestConfig) => Promise<string>) | null;
-    /**
-     * 获取用户详情
-     */
-    getUserInfo: ((config?: AxiosRequestConfig) => Promise<any>) | null;
     /**
      * 修改密码
      */

package/config/api.js

@@ -7,10 +7,6 @@ const defaultApiConfig = {
    * 登录
    */
   login: null,
-  /**
-   * 获取用户详情
-   */
-  getUserInfo: null,
   /**
    * 修改密码
    */

package/config/index.d.ts

@@ -8,6 +8,7 @@ import { type PersistConfig } from './persist';
 import { type I18nConfig } from './i18n';
 import { type RouteRecordRaw } from 'vue-router';
 import { type CoseyRouterOptions } from '../router';
+import { type UserInfo } from '../store';
 export interface LayoutComponents {
     base?: string | Component;
     sidebar?: string | Component;
@@ -48,15 +49,18 @@ export interface LayoutSlots {
     afterToggle?: () => VNodeChild;
 }
 type FilterRouteHandler = (route: RouteRecordRaw) => RouteRecordRaw | void | boolean | undefined | null;
-type DefineAuthorityHandler = (userInfo: Record<any, any>) => void | Promise<void>;
+type InitializeDataHandler = (handlers: {
+    setUserInfo: (userInfo: UserInfo) => void;
+    setRoutes: (route: RouteRecordRaw | RouteRecordRaw[]) => void;
+}) => void | Promise<void>;
 export type CoseyOptions = {
     router?: CoseyRouterOptions & RouterConfig;
     http?: HttpConfig;
     layout?: LayoutConfig;
     site?: SiteConfig;
     api?: ApiConfig;
+    initializeData?: InitializeDataHandler;
     filterRoute?: FilterRouteHandler;
-    defineAuthority?: DefineAuthorityHandler;
     components?: LayoutComponents;
     slots?: LayoutSlots;
     persist?: PersistConfig;
@@ -68,8 +72,8 @@ export interface GlobalConfig {
     layout: RequiredLayoutConfig;
     site: RequiredSiteConfig;
     api: RequiredApiConfig;
+    initializeData: NonNullable<CoseyOptions['initializeData']>;
     filterRoute: NonNullable<CoseyOptions['filterRoute']>;
-    defineAuthority: NonNullable<CoseyOptions['defineAuthority']>;
     components: NonNullable<CoseyOptions['components']>;
     slots: NonNullable<CoseyOptions['slots']>;
 }

package/config/index.js

@@ -17,8 +17,8 @@ function launchGlobalConfig(app, options) {
     layout = {},
     site = {},
     api = {},
+    initializeData = () => void 0,
     filterRoute = () => true,
-    defineAuthority = () => void 0,
     components = {},
     slots = {},
     persist = {},
@@ -30,8 +30,8 @@ function launchGlobalConfig(app, options) {
     layout: defaultsDeep(layout, defaultLayoutConfig),
     site: defaultsDeep(site, defaultSiteConfig),
     api: defaultsDeep(api, defaultApiConfig),
+    initializeData,
     filterRoute,
-    defineAuthority,
     components,
     slots
   };

package/layout/layout-user-menu/layout-user-menu.vue.js

@@ -46,7 +46,7 @@ var stdin_default = /* @__PURE__ */defineComponent({
         lock: true,
         text: t("co.auth.loggingOut")
       });
-      userStore.logout().finally(() => {
+      userStore.logout(router.currentRoute.value.fullPath).finally(() => {
         fullscreenLoading.value = false;
         loading.close();
       });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cosey",
-  "version": "0.10.21",
+  "version": "0.10.22",
   "description": "基于 Vue3 + vite 的后台管理系统框架",
   "type": "module",
   "main": "index.js",

package/router/guard/auth.js

@@ -4,7 +4,6 @@ import { TOKEN_NAME, ROUTER_TO } from '../../constant.js';
 import { persist } from '../../persist/index.js';
 
 function registerAuthGuard(router) {
-  let firstTimeAddRoutes = false;
   router.beforeEach(async (to) => {
     const { router: routerConfig } = globalConfig;
     const token = persist.get(TOKEN_NAME);
@@ -13,14 +12,11 @@ function registerAuthGuard(router) {
       return routerConfig.homePath;
     }
     if (token) {
-      if (!userStore.requestedUserInfo) {
+      if (!userStore.initialized) {
         try {
           persist.set(ROUTER_TO, to.fullPath);
-          await userStore.getUserInfo();
-          await userStore.setAuthorization();
-          await userStore.addDynamicRoutes();
-          firstTimeAddRoutes = true;
-          userStore.requestedUserInfo = true;
+          await userStore.initializeData();
+          return to.fullPath;
         } catch {
           return false;
         } finally {
@@ -30,21 +26,16 @@ function registerAuthGuard(router) {
       if (to.path === routerConfig.loginPath) {
         return routerConfig.homePath;
       }
-      if (firstTimeAddRoutes) {
-        firstTimeAddRoutes = false;
-        return to.path;
+    } else {
+      if (to.meta.authentication) {
+        return {
+          path: routerConfig.loginPath,
+          query: {
+            redirect: to.path
+          }
+        };
       }
-      return true;
     }
-    if (!to.meta.authentication) {
-      return true;
-    }
-    return {
-      path: routerConfig.loginPath,
-      query: {
-        redirect: to.path
-      }
-    };
   });
 }
 

package/router/utils.js

@@ -30,7 +30,7 @@ function defineRoutes(route) {
 }
 const mergeRouteModules = (modules) => {
   return Object.keys(modules).reduce((result, key) => {
-    const module = modules[key].default;
+    const module = modules[key].default || [];
     return result.concat(module);
   }, []);
 };

package/store/layout.d.ts

@@ -165,7 +165,7 @@ export declare const useLayoutStore: import("pinia").StoreDefinition<"cosey-layo
     topbarHeight: import("vue").Ref<number, number>;
     tabbarHeight: import("vue").Ref<number, number>;
     headerHeight: import("vue").ComputedRef<number>;
-}, "menus" | "keepAlive" | "isHorizontal" | "includeHorizontal" | "isVertical" | "isBiserial" | "isHorizontalVertical" | "isHorizontalBiserial" | "menusMap" | "firstLevelMenus" | "secondLevelMenus" | "thirdLevelMenus" | "topMenus" | "snugMenus" | "snugActive" | "defaultMenus" | "iframeTabList" | "keepAliveExclude" | "sidebarWidth" | "headerHeight">, Pick<{
+}, "menus" | "keepAlive" | "includeHorizontal" | "isVertical" | "isBiserial" | "isHorizontal" | "isHorizontalVertical" | "isHorizontalBiserial" | "menusMap" | "firstLevelMenus" | "secondLevelMenus" | "thirdLevelMenus" | "topMenus" | "snugMenus" | "snugActive" | "defaultMenus" | "iframeTabList" | "keepAliveExclude" | "sidebarWidth" | "headerHeight">, Pick<{
     sidebarVisible: import("vue").Ref<boolean, boolean>;
     collapse: import("vue").Ref<boolean, boolean>;
     isMobile: import("vue").Ref<boolean, boolean>;
@@ -249,31 +249,25 @@ export declare const useLayoutStore: import("pinia").StoreDefinition<"cosey-layo
 export declare const useOuterLayoutStore: (hot?: StoreGeneric) => import("pinia").Store<"cosey-user", Pick<{
     dynamicRoutes: import("vue").ShallowRef<any[], any[]>;
     userInfo: import("vue").Ref<import("./user").UserInfo | undefined, import("./user").UserInfo | undefined>;
-    requestedUserInfo: import("vue").Ref<boolean, boolean>;
+    initialized: import("vue").ComputedRef<boolean>;
     login: (data: any) => Promise<void>;
-    getUserInfo: () => Promise<import("./user").UserInfo | undefined>;
+    initializeData: () => Promise<void>;
     changePassword: (data: any) => Promise<void>;
-    setAuthorization: () => Promise<void>;
-    addDynamicRoutes: () => Promise<void>;
     logout: (lastPath?: string) => Promise<void>;
-}, "dynamicRoutes" | "userInfo" | "requestedUserInfo">, Pick<{
+}, "dynamicRoutes" | "userInfo">, Pick<{
     dynamicRoutes: import("vue").ShallowRef<any[], any[]>;
     userInfo: import("vue").Ref<import("./user").UserInfo | undefined, import("./user").UserInfo | undefined>;
-    requestedUserInfo: import("vue").Ref<boolean, boolean>;
+    initialized: import("vue").ComputedRef<boolean>;
     login: (data: any) => Promise<void>;
-    getUserInfo: () => Promise<import("./user").UserInfo | undefined>;
+    initializeData: () => Promise<void>;
     changePassword: (data: any) => Promise<void>;
-    setAuthorization: () => Promise<void>;
-    addDynamicRoutes: () => Promise<void>;
     logout: (lastPath?: string) => Promise<void>;
-}, never>, Pick<{
+}, "initialized">, Pick<{
     dynamicRoutes: import("vue").ShallowRef<any[], any[]>;
     userInfo: import("vue").Ref<import("./user").UserInfo | undefined, import("./user").UserInfo | undefined>;
-    requestedUserInfo: import("vue").Ref<boolean, boolean>;
+    initialized: import("vue").ComputedRef<boolean>;
     login: (data: any) => Promise<void>;
-    getUserInfo: () => Promise<import("./user").UserInfo | undefined>;
+    initializeData: () => Promise<void>;
     changePassword: (data: any) => Promise<void>;
-    setAuthorization: () => Promise<void>;
-    addDynamicRoutes: () => Promise<void>;
     logout: (lastPath?: string) => Promise<void>;
-}, "changePassword" | "login" | "logout" | "getUserInfo" | "setAuthorization" | "addDynamicRoutes">>;
+}, "changePassword" | "login" | "logout" | "initializeData">>;

package/store/user.d.ts

@@ -1,7 +1,5 @@
 import { type StoreGeneric } from 'pinia';
 export interface UserInfo {
-    id?: number;
-    username?: string;
     nickname: string;
     avatar: string;
     [key: PropertyKey]: any;
@@ -9,62 +7,50 @@ export interface UserInfo {
 export declare const useUserStore: import("pinia").StoreDefinition<"cosey-user", Pick<{
     dynamicRoutes: import("vue").ShallowRef<any[], any[]>;
     userInfo: import("vue").Ref<UserInfo | undefined, UserInfo | undefined>;
-    requestedUserInfo: import("vue").Ref<boolean, boolean>;
+    initialized: import("vue").ComputedRef<boolean>;
     login: (data: any) => Promise<void>;
-    getUserInfo: () => Promise<UserInfo | undefined>;
+    initializeData: () => Promise<void>;
     changePassword: (data: any) => Promise<void>;
-    setAuthorization: () => Promise<void>;
-    addDynamicRoutes: () => Promise<void>;
     logout: (lastPath?: string) => Promise<void>;
-}, "dynamicRoutes" | "userInfo" | "requestedUserInfo">, Pick<{
+}, "dynamicRoutes" | "userInfo">, Pick<{
     dynamicRoutes: import("vue").ShallowRef<any[], any[]>;
     userInfo: import("vue").Ref<UserInfo | undefined, UserInfo | undefined>;
-    requestedUserInfo: import("vue").Ref<boolean, boolean>;
+    initialized: import("vue").ComputedRef<boolean>;
     login: (data: any) => Promise<void>;
-    getUserInfo: () => Promise<UserInfo | undefined>;
+    initializeData: () => Promise<void>;
     changePassword: (data: any) => Promise<void>;
-    setAuthorization: () => Promise<void>;
-    addDynamicRoutes: () => Promise<void>;
     logout: (lastPath?: string) => Promise<void>;
-}, never>, Pick<{
+}, "initialized">, Pick<{
     dynamicRoutes: import("vue").ShallowRef<any[], any[]>;
     userInfo: import("vue").Ref<UserInfo | undefined, UserInfo | undefined>;
-    requestedUserInfo: import("vue").Ref<boolean, boolean>;
+    initialized: import("vue").ComputedRef<boolean>;
     login: (data: any) => Promise<void>;
-    getUserInfo: () => Promise<UserInfo | undefined>;
+    initializeData: () => Promise<void>;
     changePassword: (data: any) => Promise<void>;
-    setAuthorization: () => Promise<void>;
-    addDynamicRoutes: () => Promise<void>;
     logout: (lastPath?: string) => Promise<void>;
-}, "changePassword" | "login" | "logout" | "getUserInfo" | "setAuthorization" | "addDynamicRoutes">>;
+}, "changePassword" | "login" | "logout" | "initializeData">>;
 export declare const useOuterUserStore: (hot?: StoreGeneric) => import("pinia").Store<"cosey-user", Pick<{
     dynamicRoutes: import("vue").ShallowRef<any[], any[]>;
     userInfo: import("vue").Ref<UserInfo | undefined, UserInfo | undefined>;
-    requestedUserInfo: import("vue").Ref<boolean, boolean>;
+    initialized: import("vue").ComputedRef<boolean>;
     login: (data: any) => Promise<void>;
-    getUserInfo: () => Promise<UserInfo | undefined>;
+    initializeData: () => Promise<void>;
     changePassword: (data: any) => Promise<void>;
-    setAuthorization: () => Promise<void>;
-    addDynamicRoutes: () => Promise<void>;
     logout: (lastPath?: string) => Promise<void>;
-}, "dynamicRoutes" | "userInfo" | "requestedUserInfo">, Pick<{
+}, "dynamicRoutes" | "userInfo">, Pick<{
     dynamicRoutes: import("vue").ShallowRef<any[], any[]>;
     userInfo: import("vue").Ref<UserInfo | undefined, UserInfo | undefined>;
-    requestedUserInfo: import("vue").Ref<boolean, boolean>;
+    initialized: import("vue").ComputedRef<boolean>;
     login: (data: any) => Promise<void>;
-    getUserInfo: () => Promise<UserInfo | undefined>;
+    initializeData: () => Promise<void>;
     changePassword: (data: any) => Promise<void>;
-    setAuthorization: () => Promise<void>;
-    addDynamicRoutes: () => Promise<void>;
     logout: (lastPath?: string) => Promise<void>;
-}, never>, Pick<{
+}, "initialized">, Pick<{
     dynamicRoutes: import("vue").ShallowRef<any[], any[]>;
     userInfo: import("vue").Ref<UserInfo | undefined, UserInfo | undefined>;
-    requestedUserInfo: import("vue").Ref<boolean, boolean>;
+    initialized: import("vue").ComputedRef<boolean>;
     login: (data: any) => Promise<void>;
-    getUserInfo: () => Promise<UserInfo | undefined>;
+    initializeData: () => Promise<void>;
     changePassword: (data: any) => Promise<void>;
-    setAuthorization: () => Promise<void>;
-    addDynamicRoutes: () => Promise<void>;
     logout: (lastPath?: string) => Promise<void>;
-}, "changePassword" | "login" | "logout" | "getUserInfo" | "setAuthorization" | "addDynamicRoutes">>;
+}, "changePassword" | "login" | "logout" | "initializeData">>;

package/store/user.js

@@ -1,54 +1,37 @@
-import { shallowRef, ref } from 'vue';
+import { shallowRef, ref, computed } from 'vue';
 import { defineStore } from 'pinia';
-import { getAllDynamicRoutes, router } from '../router/index.js';
+import { router, getAllDynamicRoutes } from '../router/index.js';
 import { TOKEN_NAME } from '../constant.js';
 import { NOT_FOUND_ROUTE_NAME, NotFoundRoute } from '../router/not-found.js';
 import { persist } from '../persist/index.js';
 import { pinia } from './pinia.js';
 import { globalConfig } from '../config/index.js';
+import { defineRoutes } from '../router/utils.js';
 import { warningOnce } from '../utils/warning.js';
 
 const useUserStore = defineStore("cosey-user", () => {
-  const { router: routerConfig, api: apiConfig, filterRoute, defineAuthority } = globalConfig;
+  const {
+    router: routerConfig,
+    api: apiConfig,
+    filterRoute,
+    initializeData: _initializeData
+  } = globalConfig;
   if (!apiConfig?.login) {
     warningOnce(!!apiConfig?.login, 'The "login" api is required.');
   }
-  if (!apiConfig?.getUserInfo) {
-    warningOnce(!!apiConfig?.getUserInfo, 'The "getUserInfo" api is required.');
-  }
   const loginApi = apiConfig?.login;
-  const getUserInfoApi = apiConfig?.getUserInfo;
   const changePasswordApi = apiConfig?.changePassword;
   const logoutApi = apiConfig?.logout;
   const dynamicRoutes = shallowRef([]);
+  const remoteDynamicRoutes = shallowRef([]);
   const userInfo = ref();
-  const requestedUserInfo = ref(false);
+  const initialized = ref(false);
   const login = async (data) => {
     await loginApi?.(data).then((token) => {
       persist.set(TOKEN_NAME, token);
       router.push(router.currentRoute.value.query.redirect || routerConfig.homePath);
     });
   };
-  const getUserInfo = async () => {
-    return getUserInfoApi?.().then((res) => {
-      const nickname = res.nickname;
-      const avatar = res.avatar;
-      userInfo.value = {
-        ...res,
-        nickname,
-        avatar
-      };
-      return userInfo.value;
-    });
-  };
-  const changePassword = async (data) => {
-    await changePasswordApi?.(data).then(() => {
-      router.back();
-    });
-  };
-  const setAuthorization = async () => {
-    return defineAuthority(userInfo.value);
-  };
   const mapRoute = (routes) => {
     return routes.map((route) => {
       const result = filterRoute(route);
@@ -63,7 +46,7 @@ const useUserStore = defineStore("cosey-user", () => {
     return mapRoute(routes);
   };
   const addDynamicRoutes = async () => {
-    const filteredRoutes = filterRoutes(getAllDynamicRoutes());
+    const filteredRoutes = filterRoutes([...getAllDynamicRoutes(), ...remoteDynamicRoutes.value]);
     router.removeRoute(NOT_FOUND_ROUTE_NAME);
     filteredRoutes.forEach((route) => {
       router.addRoute(route);
@@ -71,20 +54,42 @@ const useUserStore = defineStore("cosey-user", () => {
     router.addRoute("Exception", NotFoundRoute);
     dynamicRoutes.value = filteredRoutes;
   };
+  const initializeData = async () => {
+    const setUserInfo = (_userInfo) => {
+      userInfo.value = _userInfo;
+    };
+    const setRoutes = (route) => {
+      remoteDynamicRoutes.value = defineRoutes(route);
+    };
+    if (!initialized.value) {
+      await _initializeData({
+        setUserInfo,
+        setRoutes
+      });
+      await addDynamicRoutes();
+      initialized.value = true;
+    }
+  };
+  const changePassword = async (data) => {
+    await changePasswordApi?.(data).then(() => {
+      router.back();
+    });
+  };
   const flush = async (lastPath) => {
     persist.remove(TOKEN_NAME);
     userInfo.value = void 0;
-    requestedUserInfo.value = false;
+    dynamicRoutes.value.forEach((route) => {
+      router.removeRoute(route.name);
+    });
+    dynamicRoutes.value = [];
+    remoteDynamicRoutes.value = [];
+    initialized.value = false;
     await router.push({
       path: routerConfig.loginPath,
       query: {
         redirect: lastPath
       }
     });
-    dynamicRoutes.value.forEach((route) => {
-      router.removeRoute(route.name);
-    });
-    dynamicRoutes.value = [];
   };
   const logout = async (lastPath) => {
     await logoutApi?.();
@@ -93,12 +98,10 @@ const useUserStore = defineStore("cosey-user", () => {
   return {
     dynamicRoutes,
     userInfo,
-    requestedUserInfo,
+    initialized: computed(() => initialized.value),
     login,
-    getUserInfo,
+    initializeData,
     changePassword,
-    setAuthorization,
-    addDynamicRoutes,
     logout
   };
 });