utools-api-types 5.2.0 → 6.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "utools-api-types",
-  "version": "5.2.0",
+  "version": "6.1.0",
   "description": "TypeScript definitions for uTools API",
   "repository": {
     "type": "git",
@@ -15,6 +15,7 @@
     "url": "https://github.com/uTools-Labs/utools-api-types/issues"
   },
   "homepage": "https://github.com/uTools-Labs/utools-api-types#readme",
+  "readme": "./README.md",
   "exports": {
     "default": {
       "types": "./utools.api.d.ts"

package/resource/utools.schema.json

@@ -17,18 +17,6 @@
       "type": "string",
       "description": "插件图标，支持png,jpg格式"
     },
-    "platform": {
-      "type": "array",
-      "description": "插件支持的平台，默认为所有平台。",
-      "items": {
-        "type": "string",
-        "enum": [
-          "win32",
-          "darwin",
-          "linux"
-        ]
-      }
-    },
     "development": {
       "type": "object",
       "properties": {
@@ -72,18 +60,6 @@
           "mainPush": {
             "type": "boolean"
           },
-          "platform": {
-            "type": "array",
-            "description": "此功能的支持平台，默认为所有平台。",
-            "items": {
-              "type": "string",
-              "enum": [
-                "win32",
-                "darwin",
-                "linux"
-              ]
-            }
-          },
           "cmds": {
             "type": "array",
             "description": "该功能下可响应的命令集，支持 6 种类型，由 cmds 的类型或 cmds.type 决定。",
@@ -148,9 +124,9 @@
               }
             }
           },
-          "mainHide":{
-            "type":"boolean",
-            "description": "设置为 `true` 时，启动对应的 `feature` 不会弹出主面板"
+          "mainHide": {
+            "type": "boolean",
+            "description": "设置为 `true` 时，打开对应的 `feature` 不主动弹出搜索框面板"
           }
         }
       }

package/utools.api.d.ts

@@ -1,5 +1,16 @@
 /// <reference path="ubw.d.ts"/>
 /// <reference path="electron.d.ts"/>
+
+interface CookieFilter {
+  url ?: string;
+  name?: string;
+  domain?: string;
+  path?: string;
+  secure?: boolean;
+  session?: boolean;
+  httpOnly?: boolean;
+}
+
 interface UBrowser {
   /**
    * 设置 User-Agent
@@ -52,12 +63,17 @@ interface UBrowser {
   /**
    * 模拟设备
    */
-  device(arg: ('iPhone 11' | 'iPhone X' | 'iPad' | 'iPhone 6/7/8 Plus' | 'iPhone 6/7/8' | 'iPhone 5/SE' | 'HUAWEI Mate10' | 'HUAWEI Mate20' | 'HUAWEI Mate30' | 'HUAWEI Mate30 Pro') | { size: { width: number, height: number }, useragent: string }): this;
+  device(arg: { size: { width: number, height: number }, useragent: string }): this;
   /**
-   * 获取 cookie
-   * @param name 为空获取全部cookie
+   * 在当前 url 根据名称获取 cookie
+   * @param name 为空获取当前 url 全部 cookie
    */
   cookies(name?: string): this;
+  /**
+   * 根据条件获取 ubrowser cookies
+   * @param filter 条件过滤对象
+   */
+  cookies(filter: CookieFilter): this;
   /**
    * 设置Cookie
    */
@@ -104,7 +120,7 @@ interface UBrowser {
    */
   wait<T extends any[]>(func: (...params: T) => boolean, timeout?: number, ...params: T): this;
   /**
-   * 当元素存在时执行直到碰到 end
+   * 当元素存在时执行，直到碰到 end
    * @param selector DOM元素
    */
   when(selector: string): this;
@@ -164,6 +180,10 @@ interface UBrowser {
    * 下载文件
    */
   download(url: string, savePath?: string): this;
+  /**
+   * 下载文件
+   */
+  download(func: (...params: any[]) => string, savePath: string | null, ...params: any[]): this;
   /**
    * 启动一个 ubrowser 运行
    * 当运行结束后，窗口如果为隐藏状态将自动销毁窗口
@@ -237,10 +257,6 @@ interface PluginFeature {
     type: 'img' | 'files' | 'regex' | 'over' | 'window',
     label: string
   })[]
-  /**
-   * @version >= 5.2.0
-   * 设置为 `true` 时，启动对应的 `feature` 不会弹出主面板
-   */
   mainHide?: boolean
   mainPush?: boolean
 }
@@ -251,6 +267,22 @@ type PluginEnterFrom =
   | 'hotkey'
   | 'redirect'
 
+interface FfmpegRunProgress {
+  bitrate: string;
+  fps: number;
+  frame: number;
+  percent?: number;
+  q: number | string;
+  size: string;
+  speed: string;
+  time: string;
+}
+
+interface FfmpegPromise extends Promise<void> {
+  kill(): void;
+  quit(): void;
+}
+
 interface UToolsApi {
   /**
    * 插件应用进入时触发
@@ -319,6 +351,13 @@ interface UToolsApi {
    * @param callback url 加载完成时的回调
    */
   createBrowserWindow(url: string, options: BrowserWindow.InitOptions, callback?: () => void): BrowserWindow.WindowInstance;
+  /**
+   * 发送消息到父窗口
+   * **仅在 `createBrowserWindow` 创建的窗口中使用有效**
+   * @param channel 通道名
+   * @param params 发送的数据
+   */
+  sendToParent(channel: string, ...params: any[]): void;
   /**
    * 隐藏插件应用到后台
    * @param {boolean|undefined} isKill 设置为 `true` 时，会将插件进程杀死
@@ -396,7 +435,7 @@ interface UToolsApi {
    * 插件应用间跳转
    * @todo 创建针对type的多个重载
    */
-  redirect(label: string | string[], payload: string | { type: 'text' | 'img' | 'files', data: any }): void;
+  redirect(label: string | string[], payload: string | { type: 'text' | 'img' | 'files', data: any }): boolean;
   /**
    * 获取闲置的 ubrowser
    */
@@ -737,7 +776,53 @@ interface UToolsApi {
     removeItem(key: string): void;
   };
 
+  dbCryptoStorage: {
+    /**
+     * 键值对加密存储，如果键名存在，则更新其对应的值
+     * @param key 键名(同时为文档ID)
+     * @param value 键值
+     */
+    setItem(key: string, value: any): void;
+    /**
+     * 获取键名对应的值
+     */
+    getItem<T = any>(key: string): T;
+    /**
+     * 删除键值对(删除文档)
+     */
+    removeItem(key: string): void;
+  };
+
+  team: {
+    /**
+     * 获取团队信息
+     */
+    info(): {
+      teamId: string,
+      teamName: string,
+      teamLogo: string,
+      userId: string,
+      userName: string,
+      userAvatar: string
+    };
+    /**
+     * 获取团队版预设键名对应的值
+     */
+    preset<T = any>(key: string): T;
+    /**
+     * 获取团队版预设的所有数据
+     */
+    allPresets(): Promise<{ key: string, value: any }[]>;
+  }
+
   ubrowser: UBrowser;
+
+  /**
+   * 运行 ffmpeg
+   * @param args ffmpeg 命令行参数
+   * @param onProgress 进度回调
+   */
+  runFFmpeg(args: string[], onProgress?: () => FfmpegRunProgress): FfmpegPromise;
 }
 
 declare var utools: UToolsApi;