@done-coding/admin-core 0.0.1-alpha.0

package/types/components/table/TableMain.vue.d.ts

@@ -0,0 +1,35 @@
+import { TableMainProps, TableMainInstance, ElTableColumnProps } from './types';
+
+declare const _default: <T extends Record<string, any>, SQ extends Record<string, any>, F extends Record<string, any>>(__VLS_props: Awaited<typeof __VLS_setup>["props"], __VLS_ctx?: __VLS_Prettify<Pick<Awaited<typeof __VLS_setup>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: __VLS_Prettify<__VLS_OmitKeepDiscriminatedUnion<(Partial<{}> & Omit<{
+        readonly onLoadingChange?: ((value: boolean) => any) | undefined;
+        readonly onPageChange?: ((value: number) => any) | undefined;
+        readonly onPageSizeChange?: ((value: number) => any) | undefined;
+        readonly onDataChange?: ((data: T[]) => any) | undefined;
+    } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>) & TableMainProps<T, SQ, F>, keyof import('vue').VNodeProps | keyof import('vue').AllowedComponentProps>> & {} & (import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps);
+    expose(exposed: import('vue').ShallowUnwrapRef<TableMainInstance>): void;
+    attrs: any;
+    slots: ReturnType<() => Partial<Record<NonNullable<Uppercase<string> | Extract<keyof T, string> | undefined>, (_: {
+        row: T;
+        column: ElTableColumnProps<T, F>;
+        $index: number;
+        injectInfo: F;
+        exposeInfo: TableMainInstance;
+    }) => any>> & Partial<Record<NonNullable<"header-undefined" | `header-${Uppercase<string>}` | `header-${Extract<keyof T, string>}`>, (_: {
+        column: ElTableColumnProps<T, F>;
+        $index: number;
+        injectInfo: F;
+        exposeInfo: TableMainInstance;
+    }) => any>>>;
+    emit: {
+        (e: "pageChange" | "pageSizeChange", value: number): void;
+        (e: "dataChange", data: T[]): void;
+        (e: "loadingChange", value: boolean): void;
+    };
+}>) => import('vue').VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/types/components/table/index.d.ts

@@ -0,0 +1,6 @@
+import { Plugin } from 'vue';
+import { default as TableMain } from './TableMain.vue';
+
+export * from './types';
+export { TableMain };
+export declare const tableInstall: Plugin;

package/types/components/table/types.d.ts

@@ -0,0 +1,90 @@
+import { ElTableColumn as ETC, TableInstance, TableProps } from 'element-plus';
+import { APP_API_LIST_MODEL_KEY_CONFIG, BuildListParams } from '../../config';
+import { DotToObject, UnionToIntersection } from '../../types';
+import { ExtractPropTypes, VNode } from 'vue';
+
+/**
+ * 表格请求参数
+ * ---
+ * 静态参数 SQ + KEY_CONFIG 推导出的 page.page / page.pageSize 嵌套
+ */
+export type TableApiParams<
+/** 静态参数 */
+SQ extends Record<string, any> = Record<string, any>> = BuildListParams<typeof APP_API_LIST_MODEL_KEY_CONFIG, SQ>;
+/**
+ * 表格响应结果
+ * ---
+ * items 列表 + page.totalRecord 总数（仅 2 字段子集，不带 page.page / page.pageSize）
+ */
+export type TableApiResult<T extends Record<string, any> = Record<string, any>> = UnionToIntersection<DotToObject<typeof APP_API_LIST_MODEL_KEY_CONFIG.LIST_KEY, T[]> | DotToObject<typeof APP_API_LIST_MODEL_KEY_CONFIG.TOTAL_KEY, number>>;
+export interface TableMainInstance {
+    refresh: (silent?: boolean) => void;
+    reload: (slice?: boolean) => void;
+    getTableInstance: () => TableInstance | undefined;
+}
+/** 表格列默认作用域 */
+export interface TableColumnDefaultScope<T extends Record<string, any>, F extends Record<string, any>> {
+    row: T;
+    column: ElTableColumnProps<T, F>;
+    $index: number;
+    injectInfo: F;
+    exposeInfo: TableMainInstance;
+}
+/** 表格列组件props[$开头的属性vue报错] */
+export type TableColumnComponentProps<T extends Record<string, any>, F extends Record<string, any>> = Omit<TableColumnDefaultScope<T, F>, "$index"> & {
+    _index: TableColumnDefaultScope<T, F>["$index"];
+};
+/** 表格列header作用域 */
+export interface TableColumnHeaderScope<T extends Record<string, any>, F extends Record<string, any>> {
+    column: ElTableColumnProps<T, F>;
+    $index: number;
+    injectInfo: F;
+    exposeInfo: TableMainInstance;
+}
+export type ExtractElTableColumnProps = ExtractPropTypes<typeof ETC>;
+export type ElTableColumnProps<T extends Record<string, any> = Record<string, any>, 
+/** 期望注入到表格列插槽上的额外内容 */
+F extends Record<string, any> = {}> = Omit<ExtractPropTypes<typeof ETC>, "prop" | "columnKey" | "type"> & Partial<{
+    prop: Extract<keyof T, string> | `${Uppercase<string>}`;
+    columnKey: ElTableColumnProps<T>["prop"];
+    type: "default" | "selection" | "index" | "expand";
+    fixed: "left" | "right" | boolean;
+    align: "left" | "center" | "right";
+    headerAlign: "left" | "center" | "right";
+    filterPlacement: "top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end" | "left" | "left-start" | "left-end" | "right" | "right-start" | "right-end";
+    /** 插槽render */
+    render: string | Record<string, any> | ((props: TableColumnComponentProps<T, F>) => VNode);
+    /** 表头插槽render */
+    headerRender: string | Record<string, any> | ((props: TableColumnHeaderScope<T, F>) => VNode);
+}>;
+export interface TableMainProps<
+/** 行数据结构 */
+T extends Record<string, any>, 
+/** 静态参数 */
+SQ extends Record<string, any>, 
+/** 期望注入到表格列插槽上的额外内容 */
+F extends Record<string, any>> {
+    /** 展示分页器 */
+    showPager?: boolean;
+    /** 参数 */
+    query?: SQ;
+    /** 每页条数 */
+    pageSizeInit?: number;
+    pageSizeOptions?: number[];
+    pageLayout?: string;
+    rowKey: Extract<keyof T, string> | ((row: T) => string);
+    /** 请求api */
+    api: (params: TableApiParams<SQ>) => Promise<TableApiResult<T>>;
+    tableProps?: Omit<TableProps<T>, "data" | "maxHeight" | "rowKey"> & Record<`on${Capitalize<string>}`, (...args: any[]) => any>;
+    columns: ElTableColumnProps<T, F>[];
+    /** 最大高度 */
+    maxHeight?: number;
+    /** 表头背景色 */
+    headerColor?: string;
+    /** 精细化布局 */
+    refine?: boolean;
+    /** 精细化预留高度 */
+    refineReduceHeight?: number;
+    /** 给插槽注入的方法 */
+    injectInfo?: F;
+}

package/types/config/index.d.ts

@@ -0,0 +1,2 @@
+export * from './list-model';
+export * from './route';

package/types/config/list-model.d.ts

@@ -0,0 +1,48 @@
+import { DotToObject, UnionToIntersection } from '../types';
+
+/**
+ * 列表 KEY 配置接口
+ * ---
+ * 约束消费方传入的 KEY_CONFIG 对象 shape，后续 BuildListModel / BuildListParams 工具基于本接口推导
+ */
+export interface ListModelKeyConfig {
+    PAGE_SIZE_KEY: string;
+    CURRENT_PAGE_KEY: string;
+    TOTAL_KEY: string;
+    LIST_KEY: string;
+}
+/**
+ * 基于 KEY_CONFIG 联合推导完整列表响应模型
+ * ---
+ * @example
+ *   BuildListModel<typeof APP_API_LIST_MODEL_KEY_CONFIG, User>
+ *     -> { items: User[]; page: { page: number; pageSize: number; totalRecord: number } }
+ */
+export type BuildListModel<KC extends ListModelKeyConfig, T> = UnionToIntersection<DotToObject<KC["LIST_KEY"], T[]> | DotToObject<KC["TOTAL_KEY"], number> | DotToObject<KC["CURRENT_PAGE_KEY"], number> | DotToObject<KC["PAGE_SIZE_KEY"], number>>;
+/**
+ * 基于 KEY_CONFIG 联合推导列表请求参数模型
+ * ---
+ * @example
+ *   BuildListParams<typeof APP_API_LIST_MODEL_KEY_CONFIG, { keyword?: string }>
+ *     -> { keyword?: string } & { page: { page: number; pageSize: number } }
+ */
+export type BuildListParams<KC extends ListModelKeyConfig, P extends Record<string, any> = Record<string, any>> = P & UnionToIntersection<DotToObject<KC["CURRENT_PAGE_KEY"], number> | DotToObject<KC["PAGE_SIZE_KEY"], number>>;
+/** 应用接口列表模型配置（core 单一来源） */
+export declare const APP_API_LIST_MODEL_KEY_CONFIG: Readonly<{
+    /** 当前页码 key */
+    CURRENT_PAGE_KEY: "page.page";
+    /** 每页条数 key */
+    PAGE_SIZE_KEY: "page.pageSize";
+    /** 总数 key */
+    TOTAL_KEY: "page.totalRecord";
+    /** 数据列表 key */
+    LIST_KEY: "items";
+}>;
+/** 应用接口列表模型 */
+export type AppApiListModel<T = any> = BuildListModel<typeof APP_API_LIST_MODEL_KEY_CONFIG, T>;
+/** 应用接口列表分页参数 key */
+export type AppApiListPageParamsKey = typeof APP_API_LIST_MODEL_KEY_CONFIG.PAGE_SIZE_KEY | typeof APP_API_LIST_MODEL_KEY_CONFIG.CURRENT_PAGE_KEY;
+/** 应用接口列表 排除分页参数的 key */
+export type AppApiListNoPageParamsKey = Exclude<string, AppApiListPageParamsKey>;
+/** 应用接口列表请求参数模型 */
+export type AppApiListParamsModel<P extends Record<AppApiListNoPageParamsKey, any> = Record<AppApiListNoPageParamsKey, any>> = BuildListParams<typeof APP_API_LIST_MODEL_KEY_CONFIG, Partial<P>>;

package/types/config/route.d.ts

@@ -0,0 +1,2 @@
+/** 模块级别的路由 */
+export declare const ROUTE_MODULE_LEVEL = 1;

package/types/helpers/form.d.ts

@@ -0,0 +1,11 @@
+import { FormItemRule } from 'element-plus';
+
+/**
+ * 密码规则
+ */
+export declare const passwordRule: FormItemRule;
+export declare const getConfirmPasswordRule: (getPassword: () => string) => FormItemRule;
+/** 选择框全选值 */
+export declare const FORM_CONFIG_SELECT_ALL_VALUE: string;
+/** 设置表单组件类型 */
+export declare const setFormComponentType: () => void;

package/types/helpers/index.d.ts

@@ -0,0 +1,4 @@
+export * from './form';
+export * from './storage';
+export * from './state';
+export * from './route';

package/types/helpers/route.d.ts

@@ -0,0 +1,37 @@
+import { RouteRecordRaw } from 'vue-router';
+import { RouteMetaResolveRaw } from '../types';
+
+/** 路由元信息默认配置（工厂参数最小 shape） */
+export interface RouteMetaDefaultConfig {
+    /** 各路由[未配置情况下]默认是否展示在菜单 */
+    menuShow: boolean;
+    /** 各路由[未配置情况下]默认是否需要登录 */
+    needLogin: boolean;
+}
+/**
+ * 创建路由元信息解析 raw 树生成器
+ * ---
+ * 工厂模式：app 层传入 metaDefault 配置（含 menuShow / needLogin 默认值）
+ *
+ * @example
+ *   const generateRouteMetaRawTree = createGenerateRouteMetaRawTree(APP_ROUTER_META_DEFAULT_CONFIG);
+ *   const tree = generateRouteMetaRawTree(routes, { ... });
+ */
+export declare const createGenerateRouteMetaRawTree: (metaDefault: RouteMetaDefaultConfig) => <T extends {
+    children: T[];
+} = RouteMetaResolveRaw>(routesList: RouteRecordRaw[], { parentPath, parentPathList, routeLevel, sortFn, mapFn, filterFn, }?: Partial<Pick<RouteMetaResolveRaw, "parentPath" | "parentPathList" | "routeLevel"> & {
+    /** 排序函数 */
+    sortFn?: (a: T, b: T) => number;
+    /** 映射函数 */
+    mapFn: (route: Omit<RouteMetaResolveRaw, "children"> & {
+        children: T[];
+    }) => T;
+    /** 过滤函数 */
+    filterFn: (raw: Omit<RouteMetaResolveRaw, "children"> & {
+        children: T[];
+    }, 
+    /** 是否有符合过滤条件的子路由 */
+    haveChildren: boolean, 
+    /** [原始配置]是否有子路由 */
+    haveChildrenRaw: boolean) => boolean;
+}>) => T[];

package/types/helpers/state.d.ts

@@ -0,0 +1,26 @@
+export interface UseStateOptions {
+    /** 是否调试  */
+    debug: boolean;
+    /** 模块命名空间 */
+    moduleKey: string;
+    /** 缓存 */
+    cache?: boolean;
+    /** 缓存实现 */
+    storage?: Storage;
+}
+/**
+ * 创建 useState 工厂
+ * ---
+ * 工厂模式：app 层传入命名空间，core 不感知具体值
+ *
+ * @example
+ *   const useState = createUseState("myapp");
+ *   const moduleState = useState({ count: 0 }, { debug: true, moduleKey: "counter" });
+ *   // cacheKey 形如 "myapp/useState/counter"
+ */
+export declare const createUseState: (factoryNamespace: string) => <S extends Record<string, any> = Record<string, any>>(initState: S | (() => S), { debug, moduleKey, cache, storage }?: UseStateOptions) => {
+    state: any;
+    getStateInit: () => S;
+    resetState: () => void;
+    updateState: (newStateObj?: Partial<S>) => void;
+};

package/types/helpers/storage.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 创建带命名空间的 localStorage 实例
+ * ---
+ * 工厂模式：app 层传入命名空间，core 不感知具体值
+ *
+ * @example
+ *   const myStorage = createStorageWithNamespace("myapp");
+ *   myStorage.setItem("token", "xxx"); // 实际写入 localStorage 的 key 为 "myapp/token"
+ */
+export declare const createStorageWithNamespace: (namespace: string) => Storage;

package/types/hooks/activated.d.ts

@@ -0,0 +1,8 @@
+/** 是否激活 */
+export declare const useActivated: () => {
+    isActivated: globalThis.Ref<boolean, boolean>;
+};
+/** 激活时执行时间 */
+export declare const useActivatedExec: (callback: () => void) => void;
+/** 激活时监听事件 */
+export declare const useActivatedEvent: (bind: () => void, unbind: () => void) => void;

package/types/hooks/feel-size.d.ts

@@ -0,0 +1,10 @@
+/** 感知元素尺寸变化 */
+export declare const useFeelSize: () => {
+    unwatchDom: () => void;
+    watchDom: (dom: HTMLElement) => void;
+    /** 元素尺寸信息只读属性 */
+    sizeInfo: globalThis.ComputedRef<{
+        width: number;
+        height: number;
+    } | undefined>;
+};

package/types/hooks/index.d.ts

@@ -0,0 +1,3 @@
+export * from './activated';
+export * from './feel-size';
+export * from './menus-dispatch';

package/types/hooks/menus-dispatch.d.ts

@@ -0,0 +1,33 @@
+import { RouteMetaResolveRaw } from '../types';
+
+/** 应用菜单数据分发 */
+export declare const useMenusDataDispatch: ({ getMenus, getMenuFlatList, getExtractLevel1ToHeader, }: {
+    /** 菜单树 */
+    getMenus: () => RouteMetaResolveRaw[];
+    /** 扁平化菜单列表 */
+    getMenuFlatList: () => RouteMetaResolveRaw[];
+    /** 判断是否提取1级路由模块到HEADER */
+    getExtractLevel1ToHeader: () => boolean;
+}) => {
+    sidebarMenus: globalThis.ComputedRef<RouteMetaResolveRaw[]>;
+    headerMenus: globalThis.ComputedRef<{
+        children: never[];
+        path: string;
+        title: string;
+        routeLevel: number;
+        redirectToFirstChildRoute: boolean;
+        menuShow: boolean;
+        menuIcon?: import('vue').DefineComponent;
+        menuSort: number;
+        childrenRaw: import('vue-router').RouteRecordRaw[];
+        parentPath: string;
+        parentPathList: string[];
+        permissionKey?: string | number;
+        checkPermission: boolean;
+        permissionEditShow: boolean;
+        needLogin: boolean;
+    }[]>;
+    activeMenu: globalThis.ComputedRef<RouteMetaResolveRaw | undefined>;
+    activeModuleMenu: globalThis.ComputedRef<RouteMetaResolveRaw | undefined>;
+    needRedirectToFirstChildMenu: globalThis.ComputedRef<RouteMetaResolveRaw | undefined>;
+};

package/types/index.d.ts

@@ -0,0 +1,24 @@
+import { Plugin } from 'vue';
+import { formInstall } from './components/form';
+import { menuInstall } from './components/menu';
+import { displayInstall } from './components/display';
+import { miscInstall } from './components/misc';
+import { modalInstall } from './components/modal';
+import { tableInstall } from './components/table';
+import { listPageInstall } from './components/list-page';
+
+export * from './components/form';
+export * from './components/menu';
+export * from './components/display';
+export * from './components/misc';
+export * from './components/modal';
+export * from './components/table';
+export * from './components/list-page';
+export * from './utils';
+export * from './hooks';
+export * from './types';
+export * from './config';
+export * from './inject';
+export * from './helpers';
+export { formInstall, menuInstall, displayInstall, miscInstall, modalInstall, tableInstall, listPageInstall, };
+export declare const installComponents: Plugin;

package/types/inject/index.d.ts

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

package/types/inject/key.d.ts

@@ -0,0 +1,11 @@
+/**
+ * body 视口高度
+ * ---
+ * AppBody（留 app）通过 provide 写入；
+ * TableMain / ListPage / Page1（核内或核外消费方）通过 inject 读取；
+ * ---
+ * 使用 `Symbol.for` 全局注册表保证跨包 / 跨 chunk / 跨 ESM 实例的 Symbol 唯一性。
+ * `Symbol(key)` 每次调用产生新实例；vite chunk split 或多次模块 evaluate 可能
+ * 产生多个 Symbol → inject/provide 失配 → 列表精细化高度计算塌陷至 fallback。
+ */
+export declare const BODY_CONTENT_VIEWPORT_HEIGHT: unique symbol;

package/types/types/dot-path.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 字符串点路径转嵌套对象类型
+ * ---
+ * @example
+ *   DotToObject<"page.page", number>     -> { page: { page: number } }
+ *   DotToObject<"items", T[]>            -> { items: T[] }
+ *   DotToObject<"a.b.c", string>         -> { a: { b: { c: string } } }
+ */
+export type DotToObject<P extends string, V> = P extends `${infer Head}.${infer Tail}` ? {
+    [K in Head]: DotToObject<Tail, V>;
+} : {
+    [K in P]: V;
+};

package/types/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './route';
+export * from './dot-path';
+export * from './utility-types';

package/types/types/route.d.ts

@@ -0,0 +1,92 @@
+import { RouteRecordRaw } from 'vue-router';
+import { DefineComponent } from 'vue';
+
+/** 路由权限配置 */
+export type RoutePermission = Partial<{
+    /** 是否需要登录 */
+    login: boolean;
+    /**
+     * 权限key
+     * 若为number 期望!=0
+     * 若为string 期望!=""
+     */
+    key: number | string;
+    /** 权限key使用路径 */
+    keyUsePath: boolean;
+    /** 权限编辑时是否展示 默认配置权限key就会展示 */
+    editShow: boolean;
+}>;
+/**
+ * 路由 meta 扩展形状（与 app 端 vue-router declaration merging 对齐）
+ * ---
+ * core 不做全局 declaration merging,仅作 core 内部类型自洽用;
+ * app 端仍通过自身 router-meta.d.ts 做 vue-router declaration merging,获得 vue-router RouteMeta 的扩展类型
+ */
+export interface AppRouteMeta {
+    /** 页面名称 */
+    title: string;
+    /** 是否缓存 */
+    keepAlive?: boolean;
+    /** 是否重定向到第一个有权限的子路由 */
+    redirectToFirstChildRoute?: boolean;
+    /** 页面布局 */
+    layout?: Partial<{
+        header: boolean;
+        sidebar: boolean;
+        footer: boolean;
+        breadcrumb: boolean;
+        bodyShimPadding: number;
+    }>;
+    /** 菜单 */
+    menu?: Partial<{
+        show: boolean;
+        sort: number;
+        /** 图标 (element-plus 等图标实例的 DefineComponent 签名差异较大,这里用 any 兼容) */
+        icon: any;
+    }>;
+    /** 权限 */
+    permission?: RoutePermission;
+}
+/** 获取路由权限key入参 */
+export interface GetRoutePermissionParams {
+    /** 路由路径 */
+    path: string;
+    /** 权限配置 */
+    permission: RoutePermission | undefined;
+}
+/** 路由元信息解析raw */
+export interface RouteMetaResolveRaw {
+    /** 路由地址 */
+    path: string;
+    /** 页面名称 */
+    title: string;
+    /** 路由级别 */
+    routeLevel: number;
+    /**
+     * 是否重定向到第一个有权限的子路由
+     * 详见 RouteMeta.redirectToFirstChildRoute
+     */
+    redirectToFirstChildRoute: boolean;
+    /** 是否在菜单展示 */
+    menuShow: boolean;
+    /** 菜单icon */
+    menuIcon?: DefineComponent;
+    /** 菜单排序 */
+    menuSort: number;
+    /** 子路由原始配置 */
+    childrenRaw: RouteRecordRaw[];
+    /** 子路由元信息解析raw */
+    children: RouteMetaResolveRaw[];
+    /** 父路由地址 */
+    parentPath: string;
+    /** 父路由地址列表 */
+    parentPathList: string[];
+    /** 权限key */
+    permissionKey?: string | number;
+    /** 是否检测权限 */
+    checkPermission: boolean;
+    /** (配置权限的前提下)权限编辑时是否展示 */
+    permissionEditShow: boolean;
+    /** 是否需要登录 */
+    needLogin: boolean;
+}

package/types/types/utility-types.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 联合类型转交叉类型
+ * ---
+ * 用于多个 DotToObject 结果合并：
+ *   { page: { page: number } } | { page: { pageSize: number } }
+ *     -> { page: { page: number; pageSize: number } }
+ */
+export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;

package/types/utils/id.d.ts

@@ -0,0 +1,2 @@
+/** 获取不重复的值[单次生命周期中] */
+export declare const getId: (prefix?: string) => string;

package/types/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './time';
+export * from './id';
+export * from './router';

package/types/utils/router.d.ts

@@ -0,0 +1,8 @@
+import { GetRoutePermissionParams } from '../types';
+
+/** 获取路由权限key */
+export declare const getRoutePermissionKey: ({ path, permission: permissionConfig, }: GetRoutePermissionParams) => string | number | undefined;
+/** 扁平化路由元信息解析raw */
+export declare const flatRouteMetaResolveRaw: <T extends {
+    children: T[];
+}>(list: T[], arr?: T[]) => T[];

package/types/utils/time.d.ts

@@ -0,0 +1,2 @@
+/** 倒计时 */
+export declare const timeCountDown: (time: number, handler: (t: number) => void, endHandler: () => void) => () => void;