lib.d.ts

/*
 * @Description: 全局类型定义
 * @Autor: HuiSir<273250950@qq.com>
 * @Date: 2021-06-10 16:13:02
 * @LastEditTime: 2021-12-09 10:43:55
 */

/**
 * 可索引对象
 */
declare interface Index {
    [key: string]: any
}

/**
 * 系统操作
 */
declare interface ISys {
    /**
     * @description: 底层请求
     * @param {string} something 方法名
     * @param {array} parames 参数
     * @return {*}
     */
    do: (something: string, ...parames: any[]) => Promise<any>

    /**
     * @description: 窗口操作
     * @param {string} something 方法名
     * @param {array} parames 参数
     * @return {*}
     */
    win: (something: string, ...parames: any[]) => Promise<any>

    /**
     * @description: 窗口传参
     * @param {string} wid 窗口唯一id、标识符,wid作为url的query参数传入到窗口页面
     * @param {any} data 发送消息内容
     * @return {*}
     */
    postMsg: (content: IWinMessage) => Promise<any>

    /**
     * @description: 接收消息
     * @param {string} wid
     * @return {function} callback
     */
    on(wid: string, callback: (content: IWinMessage) => void): void
}

/**
 * toast提示
 */
declare interface IToastArg {
    msg?: string
    delay?: number // 延迟时间，毫秒数
    type?: ('succ' | 'err' | 'warn') // 类型icon
}

/**
 * window对象扩展
 */
declare interface Window {
    sys: ISys   // 主线程操作
    toast: (arg: string | IToastArg) => void // 提示信息
}

/**
 * 登录入参
 */
declare interface ILoginParams extends Index {
    id?: string
    core_password: string
    verify_question?: string
    verify_answer: string
}

/**
 * 重设账户数据入参
 */
declare interface IResetLoginParams extends Index {
    token: string
    old_password?: string
    core_password: string
    verify_question: string
    verify_answer: string
}

/**
 * 账户数据入参
 */
declare interface IAddAccountParams extends Index {
    id?: string // 若有id 为修改原数据，若无，则为新增
    name?: string // 名称
    account?: string // 登录账号
    password?: string // 登录密码
    email?: string // 绑定邮箱
    phone?: string // 绑定手机
    remark?: string // 备注
    secret?: string //加密数据
    update_time?: string
    create_time?: string
}

/**
 * 账户分页列表入参
 */
declare interface IGetListParams {
    name?: string // 名称
    page: number // 当前页码
    limit: number // 每页条数
}

/**
 * 系统弹窗入参
 */
declare interface IshowMessageBoxArgs {
    title?: string // 标题
    msg?: string // 内容
    type?: ('info' | 'none' | 'error' | 'question' | 'warning')
    btns?: string[] // 按钮数组
}

/**
 * 创建子窗口入参
 */
declare interface IOpenChildWinArgs {
    wid: string //窗口唯一标识
    url: string
    title?: string // 窗口标题
    width?: number
    height?: number
    backgroundColor?: string
    parent?: BrowserWindow
}

/**
 * 窗口通信协议
 */
declare interface IWinMessage {
    msg: string // 消息字符
    data?: object | any[]  // 消息数据
}

/**
 * 日志列表入参
 */
declare interface IGetOperateLogsParams {
    beginTime?: string // 开始日期 格式:"2020-02-11"
    endTime?: string // 结束日期 格式:"2020-02-11"
    page: number // 当前页码
    limit: number // 每页条数
}

/**
 * 设置选项入参
 */
interface IOptionsParams {
    id: string
    backup_path?: string
    backup_file_num?: number
    auto_backup?: number
}