morghulis 1.0.32 → 1.0.33

package/dist/index.d.ts

@@ -1 +1,230 @@
-export { }
+import type { App } from 'vue';
+
+/**
+ * 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 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;
+};
+
+/**
+ * 授权管理工具钩子
+ * @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;
+};
+
+/**
+ * 请求工具钩子
+ * @returns 请求相关的方法集合
+ */
+export function useMoRequest(): {
+    /**
+     * 获取HTTP请求实例
+     * @param auth 是否需要授权
+     * @returns Axios实例
+     */
+    getHttpRequest: (auth?: boolean) => any;
+    
+    /**
+     * 获取Minio请求实例
+     * @returns Axios实例
+     */
+    getMinioRequest: () => any;
+};
+
+/**
+ * 创建Morghulis实例
+ * @param options 配置选项
+ * @returns Vue插件对象
+ */
+export function createMorghulis(options?: MOptions): {
+    install: (Vue: App) => void;
+};