utools-api-types 4.0.0 → 5.2.0

package/README.md

@@ -1,6 +1,17 @@
-## uTools API 代码提示
+# uTools 官方类型辅助文件
+
+## 提供代码提示文件
+
+- [utools.api.d.ts](./utools.api.d.ts) `window.utools` 对象类型提示
+- [electron.d.ts](./electron.d.ts) preload 内 `electron` 模块导入提示
+- [resource/utools.schema](./resource/utools.schema.json) 配置文件 JSON Schema
+
+## `window.utools` 对象类型提示
+
+目前将 utools 挂载到全局 window 下，提供在渲染层跟 preload 层的群体代码提示
+
+第一步
 
-第一步 
 ```bash
 npm install utools-api-types --save-dev
 ```
@@ -10,38 +21,82 @@ npm install utools-api-types --save-dev
 ```json
 {
   "compilerOptions": {
-    "types": [
-      "utools-api-types"
-    ]
-  }
+    "types": ["utools-api-types"]
+  },
+  "includes": [
+    // 如果使用ts或者框架，请添加需要类型提示的文件范围
+    // 案例：
+    // src/**/*.ts
+    // preload.js
+  ]
 }
 ```
 
-## API 代码示例
+### API 代码示例
 
 ```javascript
 // 默认浏览器打开网页
-window.utools.shellOpenExternal('https://u.tools')
+window.utools.shellOpenExternal("https://u.tools");
 
 // 在资源管理器中显示文件
-window.utools.shellShowItemInFolder('d:\\test')
+window.utools.shellShowItemInFolder("d:\\test");
 
 // ubrowser 网页自动化
-window.utools.ubrowser.goto('https://cn.bing.com')
-  .value('#sb_form_q', 'uTools')
-  .click('#sb_form_go')
-  .run({ width: 1000, height: 600 })
+window.utools.ubrowser
+  .goto("https://cn.bing.com")
+  .value("#sb_form_q", "uTools")
+  .click("#sb_form_go")
+  .run({ width: 1000, height: 600 });
 
 // 值键对方式存储数据
-window.utools.dbStorage.setItem('key', 'value')
+window.utools.dbStorage.setItem("key", "value");
 
 // 执行截图
 window.utools.screenCapture((imagebase64) => {
   // 截图完的回调
-})
+});
 
 // 执行取色
 window.utools.screenColorPick(({ hex, rgb }) => {
   // 取色完的回调
-})
-```
+});
+```
+
+## `electron` 模块代码提示
+
+引入此类型文件后，支持在 cjs 模式下也提供定制化的 `electron` 模块 api 提示
+
+> 在 uTools 中，可以通过 cjs 的形式直接使用部分 `electron` 的 api ，但是此部分支持是直接通过 uTools 内置的 nodejs 实现，因此请勿下载额外的 `electron` 依赖。
+
+### API 代码示例
+
+```javascript
+// preload.js
+
+const { ipcRenderer } = require("electron");
+
+window.onMyChannel = (callback) => {
+  ipcRenderer.on("myChannel", (e, data) => {
+    callback?.({
+      ...data,
+      senderId: e.senderId,
+    });
+  });
+};
+
+window.ipc = ipcRenderer;
+```
+
+## 配置文件 JSON Schema
+
+通过 JSON Schema 实现了在 `plugin.json` 内的代码提示
+
+引入 JSON Schema 需要在 `plugin.json` 的第一行添加 `$schema` 字段：
+
+```json
+{
+  "$schema": "./node_modules/utools-api-types/resource/utools.schema.json"
+}
+```
+
+> 添加 `$schema` 时，需要注意跟 `plugin.json` 所在的文件位置有关系，必须是相对于 `plugin.json` 的位置

package/electron.d.ts

@@ -0,0 +1,66 @@
+declare module "electron" {
+  type ClipboardType = 'selection' | 'clipboard'
+  module clipboard {
+    function availableFormats(type?: ClipboardType): void
+    function clear(type?: ClipboardType): void
+    function has(fmt: string, type?: ClipboardType): boolean
+    function read(fmt: string): string
+    function readBookmark(): {
+      title: string
+      url: string
+    }
+
+    function readBuffer(fmt: string): Uint8Array
+    function readHTML(type?: ClipboardType): string
+    function readImage(type?: ClipboardType): BrowserWindow.NativeImage
+    function readRTF(type?: ClipboardType): string
+    function readText(type?: ClipboardType): string
+    function write(data: {
+      text?: string
+      html?: string
+      image?: BrowserWindow.NativeImage
+      rtf?: string
+      bookmark?: string
+    }, type?: ClipboardType): void
+    function writeBookmark(title: string, url: string, type?: ClipboardType): void
+    function writeBuffer(fmt: string, buffer: Uint8Array, type?: ClipboardType): void
+    function writeHTML(markup: string, type?: ClipboardType): void
+    function writeImage(img: BrowserWindow.NativeImage, type?: ClipboardType): void
+    function writeRTF(text: string, type?: ClipboardType): void
+    function writeText(text: string, type?: ClipboardType): void
+  }
+  interface UIpcSendEventInit {
+    senderId: number
+  }
+  type UIpcSendEventListener<T extends any[]> = (event: UIpcSendEventInit, ...args: T) => void
+  module ipcRenderer {
+    function on<T extends any[] = any[]>(channel: string, listener: UIpcSendEventListener<T>): void
+    function once<T extends any[] = any[]>(channel: string, listener: UIpcSendEventListener<T>): void
+    function off<T extends any[] = any[]>(channel: string, listener: UIpcSendEventListener<T>): void
+    function sendTo<T extends any[] = any[]>(id: number, channel: string, ...args: T): void
+  }
+
+  module contextBridge { }
+
+  module webFrame { }
+
+  module shell { }
+
+  module nativeImage {
+    type NativeImage = BrowserWindow.NativeImage
+    function createEmpty(): NativeImage
+    function createFromPath(path: string): NativeImage
+    function createFromBitmap(buffer: Uint8Array, options: {
+      width: number
+      height: number
+      scaleFator?: number
+    }): NativeImage
+    function createFromBuffer(buffer: Uint8Array, options?: {
+      width?: number
+      height?: number
+      scaleFator?: number
+    }): NativeImage
+    function createFromDataURL(dataURL: string): NativeImage
+
+  }
+}

package/package.json

@@ -1,20 +1,23 @@
 {
   "name": "utools-api-types",
-  "version": "4.0.0",
+  "version": "5.2.0",
   "description": "TypeScript definitions for uTools API",
   "repository": {
     "type": "git",
-    "url": "https://github.com/uTools-Labs/utools-api-types.git"
+    "url": "https://github.com/uTools-Labs/utools-api-types"
   },
   "keywords": [
     "uTools"
   ],
-  "author": "utools-labs",
+  "author": "utools-core",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/uTools-Labs/utools-api-types/issues"
   },
   "homepage": "https://github.com/uTools-Labs/utools-api-types#readme",
-  "main": "",
-  "types": "index.d.ts"
+  "exports": {
+    "default": {
+      "types": "./utools.api.d.ts"
+    }
+  }
 }

package/resource/utools.schema.json

@@ -0,0 +1,159 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://u.tools/docs/plugin.json",
+  "title": "uTools 插件配置文件",
+  "description": "uTools 插件配置文件，用于描述插件的基本信息，以及插件的入口文件。",
+  "type": "object",
+  "properties": {
+    "main": {
+      "type": "string",
+      "description": "入口文件，当该配置为空时，表示插件应用为模板插件应用。 main 与 preload 至少存在其一。"
+    },
+    "preload": {
+      "type": "string",
+      "description": "这是一个关键文件，你可以在此文件内调用 uTools、 nodejs、 electron 提供的 api。 main 与 preload 至少存在其一。"
+    },
+    "logo": {
+      "type": "string",
+      "description": "插件图标，支持png,jpg格式"
+    },
+    "platform": {
+      "type": "array",
+      "description": "插件支持的平台，默认为所有平台。",
+      "items": {
+        "type": "string",
+        "enum": [
+          "win32",
+          "darwin",
+          "linux"
+        ]
+      }
+    },
+    "development": {
+      "type": "object",
+      "properties": {
+        "main": {
+          "type": "string",
+          "description": "入口文件，当该配置为空时，表示插件应用为模板插件应用。 main 与 preload 至少存在其一。"
+        }
+      }
+    },
+    "pluginSetting": {
+      "type": "object",
+      "properties": {
+        "single": {
+          "type": "boolean",
+          "description": "插件应用是否允许多开（默认不允许）。多开方式：分离插件应用后，再次创建。"
+        },
+        "height": {
+          "type": "number",
+          "description": "插件应用高度。可动态修改（参考），该项被设置后，用户则不能再调整高度。最小值为 1 。"
+        }
+      }
+    },
+    "features": {
+      "type": "array",
+      "description": "features 描述了当 uTools 主输入框内容产生变化时，此插件应用是否显示在搜索结果列表中，一个插件应用可以有多个功能，一个功能可以提供多个命令供用户搜索。",
+      "items": {
+        "type": "object",
+        "properties": {
+          "code": {
+            "type": "string",
+            "description": "插件应用提供的某个功能的唯一标示，此为必选项，且插件应用内不可重复。"
+          },
+          "explain": {
+            "type": "string",
+            "description": "对此功能的说明，将在搜索列表对应位置中显示。"
+          },
+          "icon": {
+            "type": "string",
+            "description": "此功能的图标，支持png,jpg,svg格式。"
+          },
+          "mainPush": {
+            "type": "boolean"
+          },
+          "platform": {
+            "type": "array",
+            "description": "此功能的支持平台，默认为所有平台。",
+            "items": {
+              "type": "string",
+              "enum": [
+                "win32",
+                "darwin",
+                "linux"
+              ]
+            }
+          },
+          "cmds": {
+            "type": "array",
+            "description": "该功能下可响应的命令集，支持 6 种类型，由 cmds 的类型或 cmds.type 决定。",
+            "items": {
+              "type": [
+                "string",
+                "object"
+              ],
+              "properties": {
+                "type": {
+                  "type": "string",
+                  "description": "类型",
+                  "enum": [
+                    "regex",
+                    "over",
+                    "img",
+                    "files",
+                    "window"
+                  ]
+                },
+                "label": {
+                  "type": "string",
+                  "description": "关键字"
+                },
+                "match": {
+                  "type": [
+                    "string",
+                    "object"
+                  ],
+                  "description": "匹配模式",
+                  "properties": {
+                    "app": {
+                      "type": "array"
+                    },
+                    "title": {
+                      "type": "string"
+                    },
+                    "class": {
+                      "type": "array"
+                    }
+                  }
+                },
+                "minLength": {
+                  "type": "number",
+                  "description": "最小匹配长度",
+                  "minimum": 1
+                },
+                "maxLength": {
+                  "type": "number",
+                  "description": "最大匹配长度",
+                  "minimum": 1,
+                  "maximum": 10000
+                },
+                "fileType": {
+                  "type": "string",
+                  "description": "文件类型",
+                  "enum": [
+                    "file",
+                    "directory"
+                  ]
+                }
+              }
+            }
+          },
+          "mainHide":{
+            "type":"boolean",
+            "description": "设置为 `true` 时，启动对应的 `feature` 不会弹出主面板"
+          }
+        }
+      }
+    }
+  }
+}

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "module": "CommonJS",
+    "lib": [
+      "ES6",
+      "DOM"
+    ],
+    "target": "ES6",
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "types": [],
+    "noEmit": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "files": [
+    "index.d.ts",
+    "utools.api.d.ts"
+  ]
+}

package/ubw.d.ts

@@ -0,0 +1,211 @@
+declare module BrowserWindow {
+  interface WebPreferences {
+    devTools?: boolean
+    preload?: string
+    zoomFactor: number
+    [key: string]: any
+  }
+
+  interface InitOptions {
+    width?: number,
+    height?: number,
+    webPreferences: WebPreferences
+    show?: boolean
+    title?: string
+    x?: number
+    y?: number
+    center?: boolean
+    resizable?: boolean
+    fullscreen?: boolean
+    fullscreenable?: boolean
+    skipTaskbar?: true
+    closable?: boolean
+    frame?: boolean
+    alwayOnTop?: boolean
+    [key: string]: any
+  }
+
+  interface NativeImage {
+    toPng: (options?: { scaleFator?: number }) => Uint8Array
+    toJPEG: (options?: { quality?: number }) => Uint8Array
+    isEmpty: () => boolean
+    [key: string]: any
+  }
+
+  interface PrinterSync {
+    description: string
+    displayName: string
+    isDefault: boolean
+    status: number
+    options?: {
+      'printer-location'?: string
+      'printer-make-and-model'?: string
+      'system_driverinfo'?: string
+    }
+  }
+
+  type WebRTCIPHandlingPolicy =
+    | 'default'
+    | 'default_public_interface_only'
+    | 'default_public_and_private_interfaces'
+    | 'disable_non_proxied_udp'
+
+  interface WebContents {
+    id: number
+    capturePage: () => Promise<NativeImage>
+    closeDevTools: () => void
+    copy: () => void
+    copyImageAt: (x: number, y: number) => void
+    cut: () => void
+    /**
+     * @deprecated
+     */
+    decrementCapturerCount: () => any
+    delete: () => void
+    disableDeviceEmulation: () => void
+    enableDeviceEmulation: () => void
+    executeJavaScript: <T>(code: string, userGesture?: boolean) => Promise<T>
+    findInPage: (text: string, options?: {
+      forward?: boolean
+      findNext?: boolean
+      matchCase?: boolean
+    }) => number
+    focus: () => void
+    getBackgroundThrottling: () => boolean
+    getFrameRate: () => number
+    getOSProcessId: () => number
+    getPrinters: () => PrinterSync[]
+    getProcessId: () => number
+    getUserAgent: () => string
+    getWebRTCIPHandlingPolicy: () => WebRTCIPHandlingPolicy
+    getZoomFactor: () => number
+    /**
+     * @deprecated
+     */
+    incrementCapturerCount: () => any
+    insertCSS: (css: string, options?: {
+      /**
+       * @default 'author'
+       */
+      cssOrigin?: 'user' | 'author'
+    }) => Promise<string>
+    insertText: (text: string) => Promise<void>
+    invalidate: () => void
+    isAudioMuted: () => boolean
+    isBeingCaptured: () => boolean
+    isCrashed: () => boolean
+    isCurrentlyAudible: () => boolean
+    isDestroyed: () => boolean
+    isDevToolsFocused: () => boolean
+    isDevToolsOpened: () => boolean
+    isFocused: () => boolean
+    isLoading: () => boolean
+    isLoadingMainFrame: () => boolean
+    isOffscreen: () => boolean
+    isPainting: () => void
+    isWaitingForResponse: () => boolean
+    openDevTools: (options?: {
+      mode: 'left' | 'right' | 'bottom' | 'undocked' | 'detach'
+      activate?: boolean
+      title?: string
+    }) => void
+    paste: () => void
+    pasteAndMatchStyle: () => void
+    print: (options?: Record<string, any>, callback?: (success: boolean, errorType?: string) => void) => void
+    printToPDF: (options: Record<string, any>) => Promise<Uint8Array>
+    redo: () => void
+    removeInsertedCSS: (key: string) => Promise<void>
+    replace: (text: string) => void
+    replaceMisspelling: (text: string) => void
+    savePage: (fullPath: string, saveType: 'HTMLOnly' | 'HTMLComplete' | 'MHTML') => Promise<void>
+    selectAll: () => void
+    sendInputEvent: (e: any) => void
+    setAudioMuted: (muted: boolean) => void
+    setBackgroundThrottling: (allowed: boolean) => void
+    setFrameRate: (fps: number) => void
+    setIgnoreMenuShortcuts: (ignore: boolean) => void
+    setUserAgent: (userAgent: string) => void
+    setWebRTCIPHandlingPolicy: (policy: WebRTCIPHandlingPolicy) => void
+    setZoomFactor: (factor: number) => void
+    startPainting: () => void
+    stopFindInPage: (action: 'clearSelection' | 'keepSelection' | 'activateSelection') => void
+    stopPainting: () => void
+    takeHeapSnapshot: (filePath: string) => Promise<void>
+    toggleDevTools: () => void
+    undo: () => void
+    unselect: () => void
+
+    [key: string]: any
+  }
+
+  interface Rectangle {
+    x: number
+    y: number
+    width: number
+    height: number
+  }
+
+  interface WindowInstance {
+    id: number
+    webContents: WebContents
+    show: () => void
+    hide: () => void
+    destory: () => void
+    close: () => void
+    isFocused: () => boolean
+    isDestroyed: () => boolean
+    setResizable: (resizable: boolean) => void
+    setSize: (width: number, height: number) => void
+    getSize: () => [width: number, height: number]
+    isVisible: () => boolean
+    maximize: () => void
+    unmaximize: () => void
+    isMaximized: () => void
+    minimize: () => void
+    restore: () => void
+    isMinimized: () => boolean
+    setFullScreen: (flag: boolean) => void
+    isFullScreen: () => boolean
+    isNormal: () => boolean
+    setAspectRatio: (aspectiRotio: number) => void
+    setBackgroundColor: (backgroundColor: string) => void
+    getBounds: () => Rectangle
+    getBackgroundColor: () => string
+    setContentBounds: (bounds: Rectangle) => void
+    getContentBounds: () => Rectangle
+    getNormalBounds: () => Rectangle
+    setEnabled: (enable: boolean) => void
+    isEnabled: () => boolean
+    setContentSize: (width: number, height: number) => void
+    getContentSize: () => [width: number, height: number]
+    setMinimumSize: (width: number, height: number) => void
+    getMinimumSize: () => [width: number, height: number]
+    setMaximumSize: (width: number, height: number) => void
+    getMaximumSize: () => [width: number, height: number]
+    isResizable: () => boolean
+    setFullScreenable: (fullscreenable: boolean) => void
+    isFullScreenable: () => boolean
+    setClosable: (closable: boolean) => void
+    isClosable: () => boolean
+    setAlwaysOnTop: (flag: boolean) => void
+    isAlwaysOnTop: () => boolean
+    moveTop: () => void
+    setPosition: (x: number, y: number) => void
+    getPosition: () => [x: number, y: number]
+    setTitle: (title: string) => void
+    getTitle: () => string
+    flashFrame: (flag: boolean) => void
+    setKiosk: (flag: boolean) => void
+    isKiosk: () => boolean
+    focusOnWebView: () => void
+    blurWebView: () => void
+    capturePage: (rect?: Rectangle, options?: {
+      stayHidden?: boolean
+      stayAwake?: boolean
+    }) => Promise<NativeImage>
+    reload: () => void
+
+    [key: string]: any
+  }
+}
+

package/utools.api.d.ts

@@ -1,3 +1,5 @@
+/// <reference path="ubw.d.ts"/>
+/// <reference path="electron.d.ts"/>
 interface UBrowser {
   /**
    * 设置 User-Agent
@@ -82,7 +84,7 @@ interface UBrowser {
    * @param func 在目标网页中执行
    * @param params 传到 func 中的参数
    */
-  evaluate(func: (...params: any[]) => any, ...params: any[]): this;
+  evaluate<T extends any[]>(func: (...params: T) => any, ...params: T): this;
   /**
    * 等待时间
    * @param ms 毫秒
@@ -100,7 +102,7 @@ interface UBrowser {
    * @param timeout 超时 默认60000 ms(60秒)
    * @param params 传到 func 中的参数
    */
-  wait(func: (...params: any[]) => boolean, timeout?: number, ...params: any[]): this;
+  wait<T extends any[]>(func: (...params: T) => boolean, timeout?: number, ...params: T): this;
   /**
    * 当元素存在时执行直到碰到 end
    * @param selector DOM元素
@@ -111,7 +113,7 @@ interface UBrowser {
    * @param func 执行的JS函数
    * @param params 传到 func 中的参数
    */
-  when(func: (...params: any[]) => boolean, ...params: any[]): this;
+  when<T extends any[]>(func: (...params: T) => boolean, ...params: T): this;
   /**
    * 配合 when 使用
    */
@@ -167,7 +169,7 @@ interface UBrowser {
    * 当运行结束后，窗口如果为隐藏状态将自动销毁窗口
    * @param options
    */
-  run(options: {
+  run<T extends any = any[]>(options: {
     show?: boolean,
     width?: number,
     height?: number,
@@ -187,12 +189,12 @@ interface UBrowser {
     fullscreenable?: boolean,
     enableLargerThanScreen?: boolean,
     opacity?: number
-  }): Promise<any[]>;
+  }): Promise<T>;
   /**
    * 运行在闲置的 ubrowser 上
    * @param ubrowserId 1. run(options) 运行结束后, 当 ubrowser 实例窗口仍然显示时返回 2. utools.getIdleUBrowsers() 中获得
    */
-  run(ubrowserId: number): Promise<any[]>;
+  run<T extends any = any[]>(ubrowserId: number): Promise<T>;
 }
 
 interface Display {
@@ -212,11 +214,10 @@ interface Display {
   workAreaSize: { width: number, height: number };
 }
 
-interface DbDoc {
+type DbDoc<T extends {} = Record<string, any>> = {
   _id: string,
   _rev?: string,
-  [key: string]: any
-}
+} & T
 
 interface DbReturn {
   id: string,
@@ -227,15 +228,38 @@ interface DbReturn {
   message?: string
 }
 
+interface PluginFeature {
+  code: string,
+  explain?: string,
+  platform?: ('darwin' | 'win32' | 'linux') | (Array<'darwin' | 'win32' | 'linux'>),
+  icon?: string,
+  cmds: (string | {
+    type: 'img' | 'files' | 'regex' | 'over' | 'window',
+    label: string
+  })[]
+  /**
+   * @version >= 5.2.0
+   * 设置为 `true` 时，启动对应的 `feature` 不会弹出主面板
+   */
+  mainHide?: boolean
+  mainPush?: boolean
+}
+
+type PluginEnterFrom =
+  | 'main'
+  | 'panel'
+  | 'hotkey'
+  | 'redirect'
+
 interface UToolsApi {
   /**
    * 插件应用进入时触发
    */
-  onPluginEnter(callback: (action: {code: string, type: string, payload: any, option: any }) => void): void;
+  onPluginEnter<T = any, L = any>(callback: (action: { code: string, type: string, payload: T, option: L, from?: PluginEnterFrom }) => void): void;
   /**
   * 向搜索面板推送消息
   */
-  onMainPush(callback: (action: {code: string, type: string, payload: any }) => { icon?: string, text: string, title?: string }[], selectCallback: (action: {code: string, type: string, payload: any,  option: { icon?: string, text: string, title?: string }}) => void): void;
+  onMainPush<T = any>(callback: (action: { code: string, type: string, payload: T }) => { icon?: string, text: string, title?: string }[], selectCallback: (action: { code: string, type: string, payload: any, option: { icon?: string, text: string, title?: string } }) => void): void;
   /**
    * 插件应用隐藏后台或完全退出时触发
    */
@@ -247,7 +271,7 @@ interface UToolsApi {
   /**
    * 插件应用从云端拉取到数据时触发
    */
-  onDbPull(callback: (docs: { _id: string, _rev: string }[]) => void): void;
+  onDbPull<T extends {} = Record<string, any>>(callback: (docs: DbDoc<T>[]) => void): void;
   /**
    * 隐藏主窗口
    * @param isRestorePreWindow 是否焦点回归到前面的活动窗口，默认 true
@@ -267,7 +291,7 @@ interface UToolsApi {
    * @param placeholder 占位符， 默认为空
    * @param isFocus 是否获得焦点，默认为 true
    */
-  setSubInput(onChange: (text: string) => void, placeholder?: string, isFocus?: boolean): boolean;
+  setSubInput(onChange: (input: { text: string }) => void, placeholder?: string, isFocus?: boolean): boolean;
   /**
    * 移除子输入框
    */
@@ -294,11 +318,12 @@ interface UToolsApi {
    * @param options 参考 https://www.electronjs.org/docs/api/browser-window#new-browserwindowoptions
    * @param callback url 加载完成时的回调
    */
-  createBrowserWindow(url: string, options: { width?: number, height?: number }, callback?: () => void): { id: number, [key: string]: any, webContents: { id: number, [key: string]: any } };
+  createBrowserWindow(url: string, options: BrowserWindow.InitOptions, callback?: () => void): BrowserWindow.WindowInstance;
   /**
    * 隐藏插件应用到后台
+   * @param {boolean|undefined} isKill 设置为 `true` 时，会将插件进程杀死
    */
-  outPlugin(): boolean;
+  outPlugin(isKill?: boolean): boolean;
   /**
    * 是否深色模式
    */
@@ -334,7 +359,7 @@ interface UToolsApi {
     attach?: string
   }, callback?: () => void): void;
   /**
-   * 打开支付 (付费付费)
+   * 打开支付 (付费)
    * @param callback 支付成功触发
    */
   openPayment(options: {
@@ -358,16 +383,7 @@ interface UToolsApi {
   /**
    * 设置插件应用动态功能
    */
-  setFeature(feature: {
-    code: string,
-    explain: string,
-    platform: ('darwin' | 'win32' | 'linux') | (Array<'darwin' | 'win32' | 'linux'>),
-    icon?: string,
-    cmds: (string | {
-      type: 'img' | 'files' | 'regex' | 'over' | 'window',
-      label: string
-    })[]
-  }): boolean;
+  setFeature(feature: PluginFeature): boolean;
   /**
    * 移除插件应用动态功能
    */
@@ -375,28 +391,20 @@ interface UToolsApi {
   /**
    * 获取插件应用动态功能，参数为空获取所有动态功能
    */
-  getFeatures(codes?: string[]): {
-    code: string,
-    explain: string,
-    platform: ('darwin' | 'win32' | 'linux') | (Array<'darwin' | 'win32' | 'linux'>),
-    icon?: string,
-    cmds: string | {
-      type: 'img' | 'files' | 'regex' | 'over' | 'window',
-      label: string
-    }[]
-  }[];
+  getFeatures(codes?: string[]): PluginFeature[];
   /**
    * 插件应用间跳转
+   * @todo 创建针对type的多个重载
    */
   redirect(label: string | string[], payload: string | { type: 'text' | 'img' | 'files', data: any }): void;
   /**
    * 获取闲置的 ubrowser
    */
-  getIdleUBrowsers(): { id: number, title: string, url: string}[];
+  getIdleUBrowsers(): { id: number, title: string, url: string }[];
   /**
    * 设置 ubrowser 代理 https://www.electronjs.org/docs/api/session#sessetproxyconfig
    */
-  setUBrowserProxy(config: {pacScript?: string, proxyRules?: string, proxyBypassRules?: string}): boolean;
+  setUBrowserProxy(config: { pacScript?: string, proxyRules?: string, proxyBypassRules?: string }): boolean;
   /**
    * 清空 ubrowser 缓存
    */
@@ -404,7 +412,7 @@ interface UToolsApi {
   /**
    * 显示系统通知
    */
-  showNotification(body: string): void;
+  showNotification(body: string, featureName?: string): void;
   /**
    * 弹出文件选择框
    */
@@ -444,7 +452,7 @@ interface UToolsApi {
   /**
    * 停止插件应用页面中查找
    */
-  stopFindInPage (action: 'clearSelection' | 'keepSelection' | 'activateSelection'): void;
+  stopFindInPage(action: 'clearSelection' | 'keepSelection' | 'activateSelection'): void;
   /**
    * 拖拽文件
    */
@@ -477,6 +485,10 @@ interface UToolsApi {
    * 获取文件图标
    */
   getFileIcon(filePath: string): string;
+  /**
+   * 获取当前窗口类型, 'main' 主窗口 | 'detach' 分离窗口 | 'browser' 由 createBrowserWindow 创建的窗口
+   */
+  getWindowType(): 'main' | 'detach' | 'browser';
   /**
    * 复制文件到剪贴板
    */
@@ -509,6 +521,10 @@ interface UToolsApi {
    * 默认方式打开给定的文件
    */
   shellOpenPath(fullPath: string): void;
+  /**
+   * 删除文件到回收站
+   */
+  shellTrashItem(filename: string): Promise<void>;
   /**
    * 在文件管理器中显示给定的文件
    */
@@ -532,7 +548,7 @@ interface UToolsApi {
   /*
   * 粘贴图像
   */
-  hideMainWindowPasteImage(img: string): void;
+  hideMainWindowPasteImage(img: string | Uint8Array): void;
   /*
   * 粘贴文本
   */
@@ -577,10 +593,26 @@ interface UToolsApi {
    * 获取矩形所在的显示器
    */
   getDisplayMatching(rect: { x: number, y: number, width: number, height: number }): Display;
+  /**
+   * 屏幕物理坐标转 DIP 坐标
+   */
+  screenToDipPoint(point: { x: number, y: number }): { x: number, y: number };
+  /**
+   * 屏幕 DIP 坐标转物理坐标
+   */
+  dipToScreenPoint(point: { x: number, y: number }): { x: number, y: number };
+  /**
+   * 屏幕物理区域转 DIP 区域
+   */
+  screenToDipRect(rect: { x: number, y: number, width: number, height: number }): { x: number, y: number, width: number, height: number };
+  /**
+ * 屏幕 DIP 区域转物理区域
+ */
+  dipToScreenRect(rect: { x: number, y: number, width: number, height: number }): { x: number, y: number, width: number, height: number };
   /**
    * 录屏源
    */
-  desktopCaptureSources(options: { types: string[], thumbnailSize?: { width: number, height: number }, fetchWindowIcons?: boolean }):Promise<{appIcon: {}, display_id: string, id: string, name: string, thumbnail: {} }>;
+  desktopCaptureSources(options: { types: string[], thumbnailSize?: { width: number, height: number }, fetchWindowIcons?: boolean }): Promise<{ appIcon: {}, display_id: string, id: string, name: string, thumbnail: {} }>;
   /**
    * 是否开发中
    */
@@ -606,7 +638,7 @@ interface UToolsApi {
     /**
      * 获取文档
      */
-    get(id: string): DbDoc | null;
+    get<T extends {} = Record<string, any>>(id: string): DbDoc<T> | null;
     /**
      * 删除文档
      */
@@ -618,7 +650,7 @@ interface UToolsApi {
     /**
      * 获取所有文档 可根据文档id前缀查找
      */
-    allDocs(key?: string): DbDoc[];
+    allDocs<T extends {} = Record<string, any>>(key?: string): DbDoc<T>[];
     /**
      * 存储附件到新文档
      * @param docId 文档ID
@@ -694,15 +726,15 @@ interface UToolsApi {
      * @param key 键名(同时为文档ID)
      * @param value 键值
      */
-    setItem (key: string, value: any): void;
+    setItem(key: string, value: any): void;
     /**
      * 获取键名对应的值
      */
-    getItem (key: string): any;
+    getItem<T = any>(key: string): T;
     /**
      * 删除键值对(删除文档)
      */
-    removeItem (key: string): void;
+    removeItem(key: string): void;
   };
 
   ubrowser: UBrowser;