@done-coding/admin-core 0.3.1-alpha.0 → 0.4.0

package/types/inject/key.d.ts

@@ -1,5 +1,6 @@
 import { InjectionKey } from 'vue';
 import { ModalLevel, ShelfController } from '../components/modal';
+import { AppLayoutAppStoreSlice, AppLayoutUserStoreSlice, AppLayoutBridgeSlice } from '../components/app-layout';
 
 /**
  * body 视口高度
@@ -28,3 +29,27 @@ export declare function getModalShelfInjectionKey(level: ModalLevel): InjectionK
  * setup 期一次性 provide number（不响应式）；Symbol.for 跨包/chunk/ESM 实例唯一（同上）。
  */
 export declare const TABS_MAIN_VISUAL_LEVEL: InjectionKey<number>;
+/**
+ * AppLayout 族 app store 窄化消费契约 inject key。
+ * ---
+ * AppLayout（唯一 `useAppStore()` 调用方）provide；子组件
+ * （AppBody / AppHeader / AppSidebar / AppFooter）inject 自取。
+ * Symbol.for 保证跨包同一性（同 BODY_CONTENT_VIEWPORT_HEIGHT）。
+ */
+export declare const APP_LAYOUT_APP_STORE_KEY: InjectionKey<AppLayoutAppStoreSlice>;
+/**
+ * AppLayout 族 user store 窄化消费契约 inject key。
+ * ---
+ * AppLayout 集中 provide；AppHeader inject 自取（取 userInfo / isLogin / logout 等）。
+ * Symbol.for 保证跨包同一性。
+ */
+export declare const APP_LAYOUT_USER_STORE_KEY: InjectionKey<AppLayoutUserStoreSlice>;
+/**
+ * AppLayout 族 admin bridge 窄化消费契约 inject key（#7.6 期挂载）。
+ * ---
+ * AppLayout 通过 `props.adminBridge` 接收注入后 provide；子组件
+ * （AppBody/AppHeader/AppSidebar/AppLayout 内菜单派生）inject 自取 12 readonly
+ * 配置属性 + getRoutes / generateRouteMetaRawTree 派生方法。
+ * Symbol.for 保证跨包同一性（同 APP_LAYOUT_APP_STORE_KEY / APP_LAYOUT_USER_STORE_KEY）。
+ */
+export declare const APP_LAYOUT_BRIDGE_KEY: InjectionKey<AppLayoutBridgeSlice>;

package/types/router/guard/index.d.ts

@@ -0,0 +1,21 @@
+import { Router } from 'vue-router';
+import { checkLogin } from './login';
+import { checkPermission } from './permission';
+import { CreateGuardOptions } from './types';
+
+/**
+ * 路由守卫工厂——给 router 装登录守卫 + 权限守卫 + document.title 写入。
+ *
+ * 1:1 镜像原 app `router/guard/index.ts` 行为：
+ * - beforeEach: checkLogin → 跳 loginPath；checkPermission → 跳 noPermissionPath
+ * - beforeResolve: document.title = to.meta.title
+ *
+ * @example
+ *   createGuard(router, {
+ *     bridge: appAdminBridge,
+ *     useRoutePermission,
+ *   });
+ */
+export declare const createGuard: (router: Router, options: CreateGuardOptions) => void;
+export { checkLogin, checkPermission };
+export type { CreateGuardOptions, GuardBridgeSlice, GuardRoutePermissionStore, } from './types';

package/types/router/guard/login.d.ts

@@ -0,0 +1,5 @@
+import { RouteLocationNormalized } from 'vue-router';
+import { GuardRoutePermissionStore } from './types';
+
+/** 登录检测壳子——复用 store.checkNeedGoToLoginPage */
+export declare const checkLogin: (to: RouteLocationNormalized, store: GuardRoutePermissionStore) => Promise<boolean>;

package/types/router/guard/permission.d.ts

@@ -0,0 +1,5 @@
+import { RouteLocationNormalized } from 'vue-router';
+import { GuardRoutePermissionStore } from './types';
+
+/** 权限检测壳子——复用 store.checkNeedGoToAuthPage */
+export declare const checkPermission: (to: RouteLocationNormalized, store: GuardRoutePermissionStore) => Promise<boolean>;

package/types/router/guard/types.d.ts

@@ -0,0 +1,15 @@
+import { RouteLocationNormalized } from 'vue-router';
+import { AdminBridge } from '../../bridge';
+
+/** guard 仅依赖 bridge 的路径配置切片（Pick 表达 → 必 type alias，无法 interface） */
+export type GuardBridgeSlice = Pick<AdminBridge, "APP_ROUTER_PATHS_CONFIG">;
+/** guard 仅依赖 route-permission store 的 2 个 check 方法 */
+export interface GuardRoutePermissionStore {
+    checkNeedGoToLoginPage: (route: RouteLocationNormalized) => boolean;
+    checkNeedGoToAuthPage: (route: Pick<RouteLocationNormalized, "path">) => boolean;
+}
+/** createGuard 入参 */
+export interface CreateGuardOptions {
+    bridge: GuardBridgeSlice;
+    useRoutePermission: () => GuardRoutePermissionStore;
+}

package/types/router/index.d.ts

@@ -0,0 +1 @@
+export * from './guard';

package/types/store/app.d.ts

@@ -0,0 +1,149 @@
+import { AdminBridge } from '../bridge';
+
+/**
+ * createAppStore 工厂依赖（#A 期，与 createUserStore deps 收敛单字段 `{ bridge }` 范式对齐）。
+ *
+ * 业务无泛型消费——layout/theme 配置全经 bridge 12 readonly 属性直读，业务 shape
+ * 不渗透 core；UserInfo / LoginParams 双泛型纯透传给入参 `AdminBridge` 签名
+ * （避免 app 侧具体类型 bridge 赋给 `AdminBridge<unknown,unknown>` 时的逆变位置
+ * 类型冲突，与 createUserStore 范式对齐），core setup 内 [MUST NOT] 消费双泛型字段。
+ * #C 期：删第 3 泛型 RefreshTokenParams 透传（bridge 签名已删第 3 泛型）。
+ */
+export interface CreateAppStoreDeps<UserInfo = unknown, LoginParams = unknown> {
+    /** app 侧 admin bridge 单例（注入而非 core 持单例，守规则 8；layout/theme/persist storage 全经此读） */
+    bridge: AdminBridge<UserInfo, LoginParams>;
+}
+/**
+ * app store 工厂下沉 core。
+ *
+ * 返回 `defineStore("APP", setup, { persist })` 结果（store id 保持 `"APP"`；
+ * core 工厂无状态，store 实例由 app 侧 pinia 管理，规则 8）。setup 内 1:1 镜像
+ * 原 `packages/app/src/store/app.ts` 全部运行时行为（layout/theme/persist/
+ * watch isDarkTheme DOM class 切换），[MUST NOT] 重构 / 精简 / 调整顺序。
+ *
+ * persist storage 走 `bridge.getStorage()` 惰性代理（沿用 app 端 appPersistStorage
+ * 范式）——defineStore 第三参在模块求值时执行，此时尚 pre-init，直接
+ * `bridge.getStorage()` 会同步 throw；包惰性代理使 bridge 解析推迟到每次 persist
+ * 读写时（届时已 post-init），行为字节等价。
+ *
+ * @example
+ *   export const useAppStore = createAppStore({ bridge: appAdminBridge });
+ */
+export declare function createAppStore<UserInfo = unknown, LoginParams = unknown>(deps: CreateAppStoreDeps<UserInfo, LoginParams>): import('pinia').StoreDefinition<"APP", Pick<{
+    name: globalThis.Ref<string, string>;
+    isDarkTheme: globalThis.ComputedRef<boolean>;
+    theme: globalThis.ComputedRef<import('../bridge').AppThemeColor>;
+    extractLevel1ToHeader: globalThis.Ref<boolean, boolean>;
+    showHeader: globalThis.ComputedRef<boolean>;
+    showFooter: globalThis.ComputedRef<boolean>;
+    showSidebar: globalThis.ComputedRef<boolean>;
+    showBreadcrumb: globalThis.ComputedRef<boolean>;
+    keepAlive: globalThis.ComputedRef<boolean | undefined>;
+    headerStyle: globalThis.ComputedRef<{
+        height: string;
+        backgroundColor: string;
+        color: string;
+    }>;
+    footerStyle: globalThis.ComputedRef<{
+        height: string;
+        backgroundColor: string;
+    }>;
+    sidebarStyle: globalThis.ComputedRef<{
+        width: string;
+        paddingTop: string;
+        backgroundColor: string;
+        color: string;
+    }>;
+    bodyStyle: globalThis.ComputedRef<{
+        paddingLeft: string;
+        paddingTop: string;
+        backgroundColor: string;
+    }>;
+    bodyShimPadding: globalThis.ComputedRef<number>;
+    bodyShimStyle: globalThis.ComputedRef<{
+        minHeight: string;
+        padding: string;
+    }>;
+    sidebarIsCollapse: globalThis.ComputedRef<boolean>;
+    changeSidebarCollapseStatus: (status: boolean) => void;
+    changeSidebarHasMenusStatus: (status: boolean) => void;
+    changeIsDarkTheme: (status: boolean) => void;
+}, "name" | "extractLevel1ToHeader">, Pick<{
+    name: globalThis.Ref<string, string>;
+    isDarkTheme: globalThis.ComputedRef<boolean>;
+    theme: globalThis.ComputedRef<import('../bridge').AppThemeColor>;
+    extractLevel1ToHeader: globalThis.Ref<boolean, boolean>;
+    showHeader: globalThis.ComputedRef<boolean>;
+    showFooter: globalThis.ComputedRef<boolean>;
+    showSidebar: globalThis.ComputedRef<boolean>;
+    showBreadcrumb: globalThis.ComputedRef<boolean>;
+    keepAlive: globalThis.ComputedRef<boolean | undefined>;
+    headerStyle: globalThis.ComputedRef<{
+        height: string;
+        backgroundColor: string;
+        color: string;
+    }>;
+    footerStyle: globalThis.ComputedRef<{
+        height: string;
+        backgroundColor: string;
+    }>;
+    sidebarStyle: globalThis.ComputedRef<{
+        width: string;
+        paddingTop: string;
+        backgroundColor: string;
+        color: string;
+    }>;
+    bodyStyle: globalThis.ComputedRef<{
+        paddingLeft: string;
+        paddingTop: string;
+        backgroundColor: string;
+    }>;
+    bodyShimPadding: globalThis.ComputedRef<number>;
+    bodyShimStyle: globalThis.ComputedRef<{
+        minHeight: string;
+        padding: string;
+    }>;
+    sidebarIsCollapse: globalThis.ComputedRef<boolean>;
+    changeSidebarCollapseStatus: (status: boolean) => void;
+    changeSidebarHasMenusStatus: (status: boolean) => void;
+    changeIsDarkTheme: (status: boolean) => void;
+}, "showHeader" | "keepAlive" | "bodyShimPadding" | "isDarkTheme" | "theme" | "showFooter" | "showSidebar" | "showBreadcrumb" | "headerStyle" | "footerStyle" | "sidebarStyle" | "bodyStyle" | "bodyShimStyle" | "sidebarIsCollapse">, Pick<{
+    name: globalThis.Ref<string, string>;
+    isDarkTheme: globalThis.ComputedRef<boolean>;
+    theme: globalThis.ComputedRef<import('../bridge').AppThemeColor>;
+    extractLevel1ToHeader: globalThis.Ref<boolean, boolean>;
+    showHeader: globalThis.ComputedRef<boolean>;
+    showFooter: globalThis.ComputedRef<boolean>;
+    showSidebar: globalThis.ComputedRef<boolean>;
+    showBreadcrumb: globalThis.ComputedRef<boolean>;
+    keepAlive: globalThis.ComputedRef<boolean | undefined>;
+    headerStyle: globalThis.ComputedRef<{
+        height: string;
+        backgroundColor: string;
+        color: string;
+    }>;
+    footerStyle: globalThis.ComputedRef<{
+        height: string;
+        backgroundColor: string;
+    }>;
+    sidebarStyle: globalThis.ComputedRef<{
+        width: string;
+        paddingTop: string;
+        backgroundColor: string;
+        color: string;
+    }>;
+    bodyStyle: globalThis.ComputedRef<{
+        paddingLeft: string;
+        paddingTop: string;
+        backgroundColor: string;
+    }>;
+    bodyShimPadding: globalThis.ComputedRef<number>;
+    bodyShimStyle: globalThis.ComputedRef<{
+        minHeight: string;
+        padding: string;
+    }>;
+    sidebarIsCollapse: globalThis.ComputedRef<boolean>;
+    changeSidebarCollapseStatus: (status: boolean) => void;
+    changeSidebarHasMenusStatus: (status: boolean) => void;
+    changeIsDarkTheme: (status: boolean) => void;
+}, "changeSidebarCollapseStatus" | "changeSidebarHasMenusStatus" | "changeIsDarkTheme">>;

package/types/store/index.d.ts

@@ -1 +1,3 @@
 export * from './user';
+export * from './app';
+export * from './router-permission';

package/types/store/router-permission.d.ts

@@ -0,0 +1,80 @@
+import { RouteLocationNormalizedLoaded } from 'vue-router';
+import { AdminBridge } from '../bridge';
+
+/**
+ * createRoutePermissionStore 工厂依赖（#B 期；与 createUserStore / createAppStore
+ * deps 范式对齐——bridge 经 init 注入，业务 hook / 业务路径常量经 deps 注入）。
+ *
+ * `useUserStore` 采用 hook 注入（方案 A）——业务层传入 createUserStore 实例化结果，
+ * core setup 内调 `useUserStore()` 取响应式 store 实例。方案 B（store 实例注入）
+ * 在 createRoutePermissionStore 模块求值期调 hook 会 throw "pinia not active"，故采纳 A。
+ * Hook 返回的 store 实例形状用结构最小约束 `{ isLogin, havePermissionByPath, noApiLogout }`
+ * 表达——避免 core 反向耦合 createUserStore 三泛型 + 与 createUserStore 返回的具体
+ * store 结构自动结构兼容（业务侧零摩擦传入 useUserStore）。
+ *
+ * `paths` 4 业务路径经 deps 注入而非 bridge schema——业务路径非通用 layout config，
+ * 不内化到 bridge（产研统筹勘察结论；保 bridge schema 0 扩张）。
+ *
+ * 双泛型 `<UserInfo, LoginParams>` 纯透传给入参 `AdminBridge` 签名（避免 app 侧
+ * 具体类型 bridge 赋给 `AdminBridge<unknown,unknown>` 时的逆变位置类型冲突，
+ * 与 createUserStore / createAppStore 范式对齐），core setup 内 [MUST NOT] 消费双泛型字段。
+ * #C 期：删第 3 泛型 RefreshTokenParams 透传（bridge 签名已删第 3 泛型）。
+ */
+export interface CreateRoutePermissionStoreDeps<UserInfo = unknown, LoginParams = unknown> {
+    /** app 侧 admin bridge 单例（注入而非 core 持单例，守规则 8；APP_ROUTER_META_DEFAULT_CONFIG 经此直读 + register goToLogin 经此注册） */
+    bridge: AdminBridge<UserInfo, LoginParams>;
+    /**
+     * 业务侧 createUserStore 实例化结果（hook 形态）。
+     * core setup 内调 `useUserStore()` 取响应式 store 实例；本字段仅约束最小消费面，
+     * [MUST NOT] 扩展为全 user store API surface（保 core 对 UserInfo shape 不透明）。
+     */
+    useUserStore: () => {
+        isLogin: boolean;
+        havePermissionByPath: (path: string) => boolean;
+        noApiLogout: () => void;
+    };
+    /**
+     * 4 业务路径常量（业务路径非通用 layout config，[MUST NOT] 内化到 bridge schema）。
+     * core 不知具体路径值，经 deps 注入；业务层在 packages/app/src/router/config.ts 维护。
+     */
+    paths: {
+        /** 登录路径 */
+        login: string;
+        /** 无权限路径 */
+        noPermission: string;
+        /** 登录免检路径列表 */
+        loginNoCheck: string[];
+        /** 权限免检路径列表 */
+        authNoCheck: string[];
+    };
+}
+/**
+ * 路由权限 store 泛型工厂下沉 core。
+ *
+ * 返回 `defineStore("ROUTE_PERMISSION", setup)` 结果（store id 保持 `"ROUTE_PERMISSION"`；
+ * core 工厂无状态，store 实例由 app 侧 pinia 管理，规则 8）。setup 内 1:1 镜像原
+ * `packages/app/src/store/router-permission.ts` 全部 139 行运行时行为
+ * （checkRouteNeedLogin / checkNeedGoToLoginPage / needGoToLoginPage /
+ * checkNeedGoToAuthPage / needGoToAuthPage / goToLoginPage / register goToLogin /
+ * 2 watch redirect），[MUST NOT] 重构 / 精简 / 调整顺序。
+ *
+ * `bridge.APP_ROUTER_META_DEFAULT_CONFIG` 直读取代原 `from "@/config"` import；
+ * `getRoutePermissionKey` 走 `@/utils` 复用。
+ *
+ * @example
+ *   export const useRoutePermission = createRoutePermissionStore({
+ *     bridge: appAdminBridge,
+ *     useUserStore,
+ *     paths: { login: loginPath, noPermission: noPermissionPath, loginNoCheck: loginNoCheckPath, authNoCheck: authNoCheckPath },
+ *   });
+ */
+export declare function createRoutePermissionStore<UserInfo = unknown, LoginParams = unknown>(deps: CreateRoutePermissionStoreDeps<UserInfo, LoginParams>): import('pinia').StoreDefinition<"ROUTE_PERMISSION", Pick<{
+    checkNeedGoToAuthPage: (routeInfo: Pick<RouteLocationNormalizedLoaded, "path">) => boolean;
+    checkNeedGoToLoginPage: (routeInfo: RouteLocationNormalizedLoaded) => boolean;
+}, never>, Pick<{
+    checkNeedGoToAuthPage: (routeInfo: Pick<RouteLocationNormalizedLoaded, "path">) => boolean;
+    checkNeedGoToLoginPage: (routeInfo: RouteLocationNormalizedLoaded) => boolean;
+}, never>, Pick<{
+    checkNeedGoToAuthPage: (routeInfo: Pick<RouteLocationNormalizedLoaded, "path">) => boolean;
+    checkNeedGoToLoginPage: (routeInfo: RouteLocationNormalizedLoaded) => boolean;
+}, "checkNeedGoToAuthPage" | "checkNeedGoToLoginPage">>;

package/types/store/user.d.ts

@@ -7,13 +7,15 @@ import { RoutePermission } from '../types';
  *
  * 业务类型 shape 经泛型 `<UserInfo, LoginParams>` 注入（core 不锁 shape，规则 8）；
  * 运行时配置 + 注入面全部经 `bridge`——`getAppConfig` / `getRoutes` / 4 业务 api /
- * `getUserInfoInitFn()`（用户信息空保底工厂，替代 0fd94cc `userInfoInit` deps 字段）/
- * `getUserInfoAccess()`（token/refreshToken 取写访问器，core 对 UserInfo 不透明）。
- * permission 不入访问器——core route-permission-tree 经固定约定路径 `"permission"`
- * 读（用户终锁 4，design D-a 记账）。
+ * `getUserInfoInitFn()`（用户信息空保底工厂，替代 0fd94cc `userInfoInit` deps 字段）。
+ *
+ * #C 期：删 `userInfoAccess` access pattern + `buildRefreshTokenParams` deps，
+ * token / refresh_token / permission 三字段对称为固定字面字符串经 lodash path 读写
+ * （与 permission design D-a 同模式），refreshTokenApi 直传 refreshToken string 由
+ * 业务方 wrap 内自打包业务 shape。
  */
 export interface CreateUserStoreDeps<UserInfo, LoginParams = unknown> {
-    /** app 侧 admin bridge 单例（注入而非 core 持单例，守规则 8；userInfoInit/userInfoAccess 经 bridge.init 注入，本工厂经 bridge.getUserInfoInitFn()/getUserInfoAccess() 读） */
+    /** app 侧 admin bridge 单例（注入而非 core 持单例，守规则 8；getUserInfoInitFn 经 bridge.init 注入，本工厂经 bridge.getUserInfoInitFn() 读） */
     bridge: AdminBridge<UserInfo, LoginParams>;
 }
 /**
@@ -36,7 +38,7 @@ export declare function createUserStore<UserInfo, LoginParams = unknown>(deps: C
     login: (params: LoginParams) => Promise<void>;
     logout: () => Promise<void>;
     noApiLogout: () => void;
-    getInfo: () => Promise<UserInfo>;
+    getInfo: () => Promise<Partial<UserInfo>>;
     havePermissionByPath: (path: string) => boolean;
     havePermissionByKey: (key?: RoutePermission["key"]) => boolean;
 }, never>, Pick<{
@@ -46,17 +48,17 @@ export declare function createUserStore<UserInfo, LoginParams = unknown>(deps: C
     login: (params: LoginParams) => Promise<void>;
     logout: () => Promise<void>;
     noApiLogout: () => void;
-    getInfo: () => Promise<UserInfo>;
+    getInfo: () => Promise<Partial<UserInfo>>;
     havePermissionByPath: (path: string) => boolean;
     havePermissionByKey: (key?: RoutePermission["key"]) => boolean;
-}, "userInfo" | "token" | "isLogin">, Pick<{
+}, "token" | "userInfo" | "isLogin">, Pick<{
     userInfo: ComputedRef<UserInfo>;
     token: ComputedRef<string | undefined>;
     isLogin: ComputedRef<boolean>;
     login: (params: LoginParams) => Promise<void>;
     logout: () => Promise<void>;
     noApiLogout: () => void;
-    getInfo: () => Promise<UserInfo>;
+    getInfo: () => Promise<Partial<UserInfo>>;
     havePermissionByPath: (path: string) => boolean;
     havePermissionByKey: (key?: RoutePermission["key"]) => boolean;
 }, "login" | "logout" | "noApiLogout" | "getInfo" | "havePermissionByPath" | "havePermissionByKey">>;