utools-api-types 6.0.0 → 6.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "utools-api-types",
-  "version": "6.0.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
@@ -54,10 +65,15 @@ interface UBrowser {
    */
   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
    */
@@ -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
    */
@@ -756,7 +795,7 @@ interface UToolsApi {
 
   team: {
     /**
-     * 获取团队信息 
+     * 获取团队信息
      */
     info(): {
       teamId: string,
@@ -777,6 +816,13 @@ interface UToolsApi {
   }
 
   ubrowser: UBrowser;
+
+  /**
+   * 运行 ffmpeg
+   * @param args ffmpeg 命令行参数
+   * @param onProgress 进度回调
+   */
+  runFFmpeg(args: string[], onProgress?: () => FfmpegRunProgress): FfmpegPromise;
 }
 
 declare var utools: UToolsApi;