morghulis 1.0.31 → 1.0.33

package/dist/index.d.ts

@@ -1,374 +1,230 @@
 import type { App } from 'vue';
-import type { ElDialog, ElButton, ElText, ElDivider, ElSpace } from 'element-plus';
 
-// 导入Vue组件实例类型
-import type { DefineComponent, ComponentOptionsMixin, VNodeProps, AllowedComponentProps, ComponentCustomProps, EmitsOptions, Component } from 'vue';
-
-// 如果这些类型错误是由于TypeScript版本不匹配导致的，我们可以使用更灵活的导入方式
-declare namespace Vue {
-  interface App {}
-  interface Component {}
-  interface ComponentOptionsMixin {}
-  interface VNodeProps {}
-  interface AllowedComponentProps {}
-  interface ComponentCustomProps {}
-  interface EmitsOptions {}
-  interface DefineComponent<P = {}, S = {}, M = {}> {
-    new (): {
-      $props: P
-    }
-  }
-}
-
-type DefineComponent<P = {}> = Vue.DefineComponent<P>;
-
-// 基础类型定义
-export type UIFeedbackTypes = "success" | "info" | "warning" | "error";
-export type UITextTypes = "success" | "info" | "warning" | "danger" | 'primary';
-export type UISizeTypes = 'default' | 'small' | 'large' | "";
-
-// 直接在类型定义文件中定义MorDialogProps，避免相对路径引用
-export interface MorDialogProps {
-  modelValue?: boolean,
-  title?: string,
-  subTitle?: string,
-  width?: string | number,
-  fullscreen?: boolean,
-  top?: string,
-  modal?: boolean,
-  modalClass?: string,
-  headerClass?: string,
-  bodyClass?: string,
-  footerClass?: string,
-  appendToBody?: boolean,
-  appendTo?: string,
-  lockScroll?: boolean,
-  openDelay?: number,
-  closeDelay?: number,
-  closeOnClickModal?: boolean,
-  closeOnPressEscape?: boolean,
-  showClose?: boolean,
-  beforeClose?: (done: () => void) => void,
-  draggable?: boolean,
-  overFlow?: boolean,
-  center?: boolean,
-  alignCenter?: boolean,
-  destroyOnClose?: boolean,
-  closeIcon?: string,
-  zIndex?: number,
-  headerAriaLevel?: string,
-  confirm?: (data: any, done: () => void) => void,
-  cancel?: (data: any, done: () => void) => void,
-  confirmButtonText?: string,
-  cancelButtonText?: string,
-  data?: any
-}
-
-// 定义MorDialogConfig接口
-export interface MorDialogConfig {
-  title?: string,
-  subTitle?: string
-}
-
-// 定义MorOption接口
-export interface MorOption {
-  baseURL?: string,
-  minioURL?: string,
-  [key: string]: any
-}
-
-// 定义表格相关类型
-export interface DataItem {
-  [key: string]: any;
-}
-
-export type Orders = Array<{
-  column: string;
-  asc?: boolean;
-}>;
-
-export interface DaoTypes {
-  add: (entity: string, bean: DataItem) => Promise<any>;
-  update: (entity: string, bean: DataItem) => Promise<any>;
-  delete: (entity: string, id: string | number) => Promise<any>;
-  get: (entity: string, id: string | number, options?: any) => Promise<any>;
-  list: (entity: string, options?: any) => Promise<any>;
-  page: (entity: string, page: number, size: number, options?: any) => Promise<any>;
-}
-
-export interface MetaField {
-  code: string;
-  name: string;
-  type: string;
-  options?: any[];
-  required?: boolean;
-  readonly?: boolean;
-  hidden?: boolean;
-  [key: string]: any;
-}
-
-export interface MetaView {
-  code: string;
-  name: string;
-  fields: MetaField[];
-  [key: string]: any;
-}
-
-export type SortableCallbackFn = (newIndex: number, oldIndex: number) => void;
-
-export type MTableButton = {
-  size?: UISizeTypes;
-  handler?: (row: any, event?: Event) => void;
-  title?: string | Function;
-  type?: UITextTypes | Function;
-  link?: boolean | Function;
-  plain?: boolean | Function;
-  text?: boolean | Function;
-  round?: boolean | Function;
-  circle?: boolean | Function;
-  disabled?: boolean | Function;
-  dark?: boolean | Function;
-  color?: string | Function;
-  tag?: string | Function;
+/**
+ * Morghulis库的主配置选项
+ */
+export interface MOptions {
+    /**
+     * API请求的基础URL
+     */
+    baseURL: string;
+    /**
+     * Minio对象存储的基础URL
+     */
+    minioURL: string;
+}
+
+/**
+ * 反馈类型
+ */
+export type MFeedback = "success" | "info" | "warning" | "error";
+
+/**
+ * 消息提示工具类型
+ */
+export interface MMsg {
+    /**
+     * 显示信息提示
+     * @param content 提示内容
+     */
+    info: (content: string) => void;
+    
+    /**
+     * 显示成功提示
+     * @param content 提示内容
+     */
+    success: (content: string) => void;
+    
+    /**
+     * 显示警告提示
+     * @param content 提示内容
+     */
+    warning: (content: string) => void;
+    
+    /**
+     * 显示错误提示
+     * @param content 提示内容
+     */
+    error: (content: string) => void;
+    
+    /**
+     * 自定义类型提示
+     * @param content 提示内容
+     * @param type 提示类型
+     */
+    show: (content: string, type?: MFeedback) => void;
+}
+
+/**
+ * 对话框工具类型
+ */
+export interface MBox {
+    /**
+     * 显示信息对话框
+     * @param content 内容
+     * @param title 标题
+     */
+    info: (content: string, title?: string) => Promise<any>;
+    
+    /**
+     * 显示成功对话框
+     * @param content 内容
+     * @param title 标题
+     */
+    success: (content: string, title?: string) => Promise<any>;
+    
+    /**
+     * 显示警告对话框
+     * @param content 内容
+     * @param title 标题
+     */
+    warning: (content: string, title?: string) => Promise<any>;
+    
+    /**
+     * 显示错误对话框
+     * @param content 内容
+     * @param title 标题
+     */
+    error: (content: string, title?: string) => Promise<any>;
+    
+    /**
+     * 自定义类型对话框
+     * @param content 内容
+     * @param title 标题
+     * @param type 类型
+     */
+    show: (content: string, title?: string, type?: MFeedback) => void;
+}
+
+/**
+ * 系统关键字常量
+ */
+export const SYSTEM_KEY: {
+    /** 客户端标识 */
+    CLIENT: string;
+    /** 用户ID */
+    USER: string;
+    /** 认证令牌 */
+    AUTH: string;
 };
 
-export type MTableColumn = {
-  label: string;
-  component: Component;
-  width?: string | number;
+/**
+ * 消息提示工具
+ * 用于显示轻量级的反馈信息
+ */
+export const $message: MMsg;
+
+/**
+ * 警告框工具
+ * 用于显示需要用户确认的信息
+ */
+export const $alert: MBox;
+
+/**
+ * 确认框工具
+ * 用于显示需要用户确认的提示
+ */
+export const $confirm: MBox;
+
+/**
+ * Cookie管理工具钩子
+ * @returns Cookie操作方法集合
+ */
+export function useMCookies(): {
+    /**
+     * 获取Cookie值
+     * @param path 路径，可以是简单的key或者点分隔的路径
+     * @returns 对应路径的值
+     */
+    get: (path: string) => any;
+    
+    /**
+     * 设置Cookie值
+     * @param path 路径，可以是简单的key或者点分隔的路径
+     * @param value 需要存储的值，如果为null则删除该路径
+     */
+    set: (path: string, value?: any) => void;
+    
+    /**
+     * 加载Cookie值，如果不存在则设置默认值
+     * @param key Cookie键
+     * @param value 默认值
+     * @returns 加载的值或默认值
+     */
+    load: (key: string, value?: any) => any;
+    
+    /**
+     * 删除Cookie值
+     * @param path 路径，可以是简单的key或者点分隔的路径
+     */
+    remove: (path: string) => void;
 };
 
-export interface TableProps {
-  data?: any[];
-  height?: string | number;
-  maxHeight?: string | number;
-  stripe?: boolean;
-  border?: boolean;
-  size?: string;
-  fit?: boolean;
-  showHeader?: boolean;
-  highlightCurrentRow?: boolean;
-  currentRowKey?: string | number;
-  rowClassName?: string | ((param: { row: any, rowIndex: number }) => string);
-  rowStyle?: object | ((param: { row: any, rowIndex: number }) => object);
-  cellClassName?: string | ((param: { row: any, column: any, rowIndex: number, columnIndex: number }) => string);
-  cellStyle?: object | ((param: { row: any, column: any, rowIndex: number, columnIndex: number }) => object);
-  headerRowClassName?: string | ((param: { row: any, rowIndex: number }) => string);
-  headerRowStyle?: object | ((param: { row: any, rowIndex: number }) => object);
-  headerCellClassName?: string | ((param: { row: any, column: any, rowIndex: number, columnIndex: number }) => string);
-  headerCellStyle?: object | ((param: { row: any, column: any, rowIndex: number, columnIndex: number }) => object);
-  rowKey?: string | ((row: any) => string);
-  emptyText?: string;
-  defaultExpandAll?: boolean;
-  expandRowKeys?: any[];
-  defaultSort?: { prop: string, order: string };
-  tooltipEffect?: string;
-  showSummary?: boolean;
-  sumText?: string;
-  summaryMethod?: (param: { columns: any[], data: any[] }) => any[];
-  spanMethod?: (param: { row: any, column: any, rowIndex: number, columnIndex: number }) => number[] | { rowspan: number, colspan: number };
-  selectOnIndeterminate?: boolean;
-  indent?: number;
-  lazy?: boolean;
-  load?: (row: any, treeNode: any, resolve: (data: any[]) => void) => void;
-  treeProps?: { children: string, hasChildren: string };
-}
-
-export interface MorghulisTableProps extends TableProps {
-  loading?: boolean;
-  view: MetaView;
-  buttons?: MTableButton[];
-  columns?: MTableColumn[];
-  sortableCallback?: SortableCallbackFn;
-}
-
-export interface DTableProps {
-  auth?: boolean;
-  db: DaoTypes;
-  entity: string;
-  code?: string;
-  size?: number;
-  page?: number;
-  includes?: DataItem;
-  excludes?: DataItem;
-  orders?: Orders;
-  buttons?: MTableButton[];
-  columns?: MTableColumn[];
-}
-
-export interface DCellProps {
-  view: MetaView;
-  prop: string;
-  bean: DataItem;
-  db: DaoTypes;
-  disabled?: boolean;
-}
-
-// 定义MFormProps接口
-export interface MFormProps {
-  item: DataItem;
-  view: MetaView;
-  db: DaoTypes;
-}
-
-// 定义DFormProps接口
-export interface DFormProps {
-  selection: any[];
-  view: MetaView;
-  db: DaoTypes;
-  bean: DataItem;
-}
-
-// 定义useMorghulisAuthorize函数的返回类型
-export interface MorghulisAuthorize {
-  $client: string;
-  user: () => any;
-  check: (uid?: any) => boolean;
-  login: (uid: any) => void;
-  logout: () => void;
-  bearer: () => string | null;
-}
-
-// 创建库的入口函数
-export declare function createMorghulis(options?: MorOption): {
-  install: (Vue: App) => void;
+/**
+ * 授权管理工具钩子
+ * @returns 授权相关的方法集合
+ */
+export function useMAuthorize(): {
+    /**
+     * 客户端ID
+     */
+    $client: string;
+    
+    /**
+     * 获取当前用户ID
+     * @returns 用户ID
+     */
+    user: () => any;
+    
+    /**
+     * 检查用户ID是否匹配当前用户
+     * @param uid 用户ID
+     * @returns 是否匹配
+     */
+    check: (uid?: any) => boolean;
+    
+    /**
+     * 登录用户
+     * @param uid 用户ID
+     */
+    login: (uid: any) => void;
+    
+    /**
+     * 登出当前用户
+     */
+    logout: () => void;
+    
+    /**
+     * 获取认证令牌
+     * @returns Bearer认证令牌或null
+     */
+    bearer: () => string | null;
 };
 
-// 导出更详细的组件类型
-
-// 导出MDialog组件类型增强
-export declare interface MDialogInstance {
-  open: (data?: any, config?: MorDialogConfig) => void;
-  close: () => void;
-}
-
-// 添加v-model和事件支持
-export interface ModelDirectives {
-  'v-model'?: any;
-  'v-model:modelValue'?: any;
-  'v-model:title'?: string;
-  'v-model:subTitle'?: string;
-}
-
-// 更新MDialog类型
-export declare const MDialog: DefineComponent<MorDialogProps & {
-  'onUpdate:modelValue'?: (value: boolean) => any;
-  'onUpdate:title'?: (value: string) => any;
-  'onUpdate:subTitle'?: (value: string) => any;
-  'onClose'?: () => any;
-} & ModelDirectives> & MDialogInstance;
-
-// 导出MTable组件类型增强
-export declare interface MTableInstance {
-  getSelection: () => any[];
-  setSelection: (rows: any[]) => void;
-  closePopover: () => void;
-}
-
-// 更新MTable类型
-export declare const MTable: DefineComponent<MorghulisTableProps & {
-  'onSelection-change'?: (selection: any[]) => any;
-  'onSort'?: (column: any, prop: string, order: string) => any;
-}> & MTableInstance;
-
-// 导出MForm组件类型增强
-export declare interface MFormInstance {
-  getData: () => any;
-  reset: (prop: string) => void;
-}
-export declare const MForm: DefineComponent<MFormProps> & MFormInstance;
-
-// 导出DTable组件类型增强
-export declare interface DTableInstance {
-  refresh: () => void;
-  add: () => void;
-  edit: (row: any) => void;
-  remove: (row: any) => void;
-  handlePageSizeChange: (size: number) => void;
-  handleCurrentPageChange: (page: number) => void;
-  load: () => void;
-  upload: (data: any[]) => void;
-}
-export declare const DTable: DefineComponent<DTableProps> & DTableInstance;
-
-// 导出DForm组件类型增强
-export declare interface DFormInstance {
-  getData: () => any[];
-}
-export declare const DForm: DefineComponent<DFormProps> & DFormInstance;
-
-// 导出DCell组件类型增强
-export declare interface DCellEvents {
-  onCancel: (...args: any[]) => any;
-  onSave: (...args: any[]) => any;
-}
-export declare const DCell: DefineComponent<DCellProps & DCellEvents>;
-
-// 导出MCell组件
-export declare const MCell: DefineComponent;
-
-// 导出DController组件
-export declare const DController: DefineComponent;
-
-// 声明useMorghulisAuthorize函数
-export declare function useMorghulisAuthorize(): MorghulisAuthorize;
-
-// 其他hooks
-export declare function useMorghulisChannel(): any;
-export declare function useMorghulisSockets(baseURL?: string): any;
-export declare function loadMorghulisSockets(baseURL?: string): any;
-export declare function useMorghulisRequest(): {
-  get: <T = any>(url: string, params?: any, config?: any) => Promise<T>;
-  post: <T = any>(url: string, data?: any, config?: any) => Promise<T>;
-  put: <T = any>(url: string, data?: any, config?: any) => Promise<T>;
-  delete: <T = any>(url: string, data?: any, config?: any) => Promise<T>;
-};
-export declare function useMorghulisCookies(): {
-  get: (key: string, defaultValue?: any) => any;
-  set: (key: string, value: any, options?: any) => void;
-  remove: (key: string, options?: any) => void;
-  load: (key: string, defaultValue?: any) => any;
+/**
+ * 请求工具钩子
+ * @returns 请求相关的方法集合
+ */
+export function useMoRequest(): {
+    /**
+     * 获取HTTP请求实例
+     * @param auth 是否需要授权
+     * @returns Axios实例
+     */
+    getHttpRequest: (auth?: boolean) => any;
+    
+    /**
+     * 获取Minio请求实例
+     * @returns Axios实例
+     */
+    getMinioRequest: () => any;
 };
 
-// 声明全局组件类型
-declare module '@vue/runtime-core' {
-  export interface GlobalComponents {
-    // Morghulis组件
-    MDialog: typeof MDialog;
-    MTable: typeof MTable;
-    MForm: typeof MForm;
-    MCell: typeof MCell;
-    DTable: typeof DTable;
-    DCell: typeof DCell;
-    DForm: typeof DForm;
-    DController: typeof DController;
-    
-    // Element Plus组件
-    ElButton: typeof ElButton;
-    ElDialog: typeof ElDialog;
-    ElText: typeof ElText;
-    ElDivider: typeof ElDivider;
-    ElSpace: typeof ElSpace;
-    // 可以根据需要添加更多Element Plus组件
-    
-    // PascalCase 形式
-    MTable: typeof import('morghulis')['MTable']
-    MDialog: typeof import('morghulis')['MDialog']
-    MForm: typeof import('morghulis')['MForm']
-    DTable: typeof import('morghulis')['DTable']
-    DCell: typeof import('morghulis')['DCell']
-    DForm: typeof import('morghulis')['DForm']
-    DController: typeof import('morghulis')['DController']
-    MCell: typeof import('morghulis')['MCell']
-    
-    // kebab-case 形式
-    'm-table': typeof import('morghulis')['MTable']
-    'm-dialog': typeof import('morghulis')['MDialog']
-    'm-form': typeof import('morghulis')['MForm']
-    'd-table': typeof import('morghulis')['DTable']
-    'd-cell': typeof import('morghulis')['DCell']
-    'd-form': typeof import('morghulis')['DForm']
-    'd-controller': typeof import('morghulis')['DController']
-    'm-cell': typeof import('morghulis')['MCell']
-  }
-} 
+/**
+ * 创建Morghulis实例
+ * @param options 配置选项
+ * @returns Vue插件对象
+ */
+export function createMorghulis(options?: MOptions): {
+    install: (Vue: App) => void;
+};