utools-api-types 6.0.0 → 7.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "utools-api-types",
-  "version": "6.0.0",
+  "version": "7.0.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,52 @@
 /// <reference path="ubw.d.ts"/>
 /// <reference path="electron.d.ts"/>
+
+interface UtoolsAiModel {
+  id: string;
+  label: string;
+  description: string;
+  icon: string;
+  cost: number;
+}
+interface UtoolsAiResult<T> extends Promise<T> {
+  abort(): void;
+}
+
+interface UtoolsAiMessage {
+  role: "system" | "user" | "assistant";
+  content?: string;
+  reasoning_content?: string;
+}
+
+interface UtoolsAiTool {
+  type: "function";
+  function?: {
+    name: string;
+    description: string;
+    parameters: {
+      type: "object";
+      properties: Record<string, any>;
+    };
+    required?: string[];
+  };
+}
+
+interface UtoolsAiOption {
+  model?: string;
+  messages: UtoolsAiMessage[];
+  tools?: UtoolsAiTool[];
+}
+
+interface CookieFilter {
+  url?: string;
+  name?: string;
+  domain?: string;
+  path?: string;
+  secure?: boolean;
+  session?: boolean;
+  httpOnly?: boolean;
+}
+
 interface UBrowser {
   /**
    * 设置 User-Agent
@@ -43,6 +90,11 @@ interface UBrowser {
    * @param savePath 截图保存路径，可以是文件夹 或 .png文件完全路径, 默认保存临时目录
    */
   screenshot(arg: string | { x: number, y: number, width: number, height: number }, savePath?: string): this;
+  /**
+   * 转为 markdown 文本
+   * @param selector css 选择器或者XPATH
+   */
+  markdown(selector?: string): this;
   /**
    * 保存为PDF
    * @param options 选项
@@ -54,10 +106,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
    */
@@ -174,25 +231,34 @@ interface UBrowser {
    * @param options
    */
   run<T extends any = any[]>(options: {
-    show?: boolean,
-    width?: number,
-    height?: number,
-    x?: number,
-    y?: number,
-    center?: boolean,
-    minWidth?: number,
-    minHeight?: number,
-    maxWidth?: number,
-    maxHeight?: number,
-    resizable?: boolean,
-    movable?: boolean,
-    minimizable?: boolean,
-    maximizable?: boolean,
-    alwaysOnTop?: boolean,
-    fullscreen?: boolean,
-    fullscreenable?: boolean,
-    enableLargerThanScreen?: boolean,
-    opacity?: number
+    show?: boolean;
+    width?: number;
+    height?: number;
+    x?: number;
+    y?: number;
+    center?: boolean;
+    minWidth?: number;
+    minHeight?: number;
+    maxWidth?: number;
+    maxHeight?: number;
+    resizable?: boolean;
+    movable?: boolean;
+    minimizable?: boolean;
+    maximizable?: boolean;
+    alwaysOnTop?: boolean;
+    fullscreen?: boolean;
+    fullscreenable?: boolean;
+    enableLargerThanScreen?: boolean;
+    opacity?: number;
+    frame?: boolean;
+    closable?: boolean;
+    focusable?: boolean;
+    skipTaskbar?: boolean;
+    backgroundColor?: string;
+    hasShadow?: boolean;
+    transparent?: boolean;
+    titleBarStyle?: string;
+    thickFrame?: boolean;
   }): Promise<T>;
   /**
    * 运行在闲置的 ubrowser 上
@@ -251,6 +317,30 @@ 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 MainPushResult {
+  icon?: string,
+  text: string,
+  title?: string
+}
+
+type MainPushResultList = MainPushResult[] | Promise<MainPushResult[]>
+
 interface UToolsApi {
   /**
    * 插件应用进入时触发
@@ -259,7 +349,7 @@ interface UToolsApi {
   /**
   * 向搜索面板推送消息
   */
-  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;
+  onMainPush<T = any>(callback: (action: { code: string, type: string, payload: T }) => MainPushResultList, selectCallback: (action: { code: string, type: string, payload: any, option: MainPushResult }) => void): void;
   /**
    * 插件应用隐藏后台或完全退出时触发
    */
@@ -319,6 +409,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 +493,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 +853,7 @@ interface UToolsApi {
 
   team: {
     /**
-     * 获取团队信息 
+     * 获取团队信息
      */
     info(): {
       teamId: string,
@@ -777,6 +874,36 @@ interface UToolsApi {
   }
 
   ubrowser: UBrowser;
+
+  /**
+   * 运行 ffmpeg
+   * @param args ffmpeg 命令行参数
+   * @param onProgress 进度回调
+   */
+  runFFmpeg(args: string[], onProgress?: (progress: FfmpegRunProgress) => void): FfmpegPromise;
+
+  /**
+   * 流式调用 AI
+   * @param option 选项参数
+   * @param option.model 模型
+   * @param option.messages 消息
+   * @param option.tools 工具集合，使用 function calling 配置
+   * @param streamCallback 流式回调
+   */
+  ai(
+    option: UtoolsAiOption,
+    streamCallback: (chunk: UtoolsAiMessage) => void
+  ): UtoolsAiResult<void>
+  /**
+   * 非流式调用 AI
+   * @param option 选项参数
+   */
+  ai(option: UtoolsAiOption): UtoolsAiResult<UtoolsAiMessage>
+
+  /**
+   * 获取所有 AI 模型
+   */
+  allAiModels(): Promise<UtoolsAiModel[]>;
 }
 
 declare var utools: UToolsApi;