uTools

https://www.u-tools.cn/docs/developer/
Admin
uTools is a plugin-based application platform that combines Node.js native capabilities with web...
Tokens:25,088
Snippets:424
Trust Score:7.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### Desktop Capture Sources Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/screen.html

An asynchronous example demonstrating how to get desktop capture sources (windows or screens) and set up a media stream for recording.

```javascript
(async () => {
  const ousrces = await utools.desktopCaptureSources({
    types: ["window", "screen"],
  });
  const stream = await navigator.mediaDevices.getUserMedia({
    audio: false,
    video: {
      mandatory: {
        chromeMediaSource: "desktop",
        chromeMediaSourceId: ousrces[0].id,
        minWidth: 1280,
        maxWidth: 1280,
        minHeight: 720,
        maxHeight: 720,
      },
    },
  });
  const video = document.querySelector("video");
  video.srcObject = stream;
  video.onloadedmetadata = (e) => video.play();
})();
```

--------------------------------

### Installing Third-Party Modules via npm

Source: https://www.u-tools.cn/docs/developer/information/preload-js/nodejs.html

Example of installing and using the 'colord' third-party module in preload.js.

```bash
npm install colord
```

```javascript
const { getFormat, colord } = require("colord");

window.services = {
  colord: {
    darken(text) {
      const fmt = getFormat(text);
      if (!fmt) {
        return [null, "请输入一个有效的颜色值，比如 #000 或 rgb(0,0,0)"];
      } else {
        const darkColor = colord(text).darken(0.1);
        return [darkColor, null];
      }
    },
  },
};
```

--------------------------------

### Get All Docs with Prefix (Synchronous)

Source: https://www.u-tools.cn/docs/developer/api-reference/db/local-db.html

Example of fetching all documents that start with a specific prefix using the synchronous allDocs method.

```typescript
// 获取所有 id 以 "test/" 作为前缀的文档
const docs1 = utools.db.allDocs("test/");
// 根据 id 数组获取对应文档数组
const docs2 = utools.db.allDocs(["test/doc-2", "test/doc-3"]);
// 获取插件应用所有文档
const docs3 = utools.db.allDocs();
console.log(docs1, docs2, docs3)
```

--------------------------------

### Get All Docs with Prefix (Asynchronous)

Source: https://www.u-tools.cn/docs/developer/api-reference/db/local-db.html

Example of fetching all documents that start with a specific prefix using the asynchronous promises.allDocs method.

```typescript
// 获取所有 id 以 "test/" 作为前缀的文档
const docs1 = await utools.db.promises.allDocs("test/");
// 根据 id 数组获取对应文档数组
const docs2 = await utools.db.promises.allDocs(["test/doc-2", "test/doc-3"]);
// 获取插件应用所有文档
const docs3 = await utools.db.promises.allDocs();
console.log(docs1, docs2, docs3)
```

--------------------------------

### Get User Basic Information - Making the Request (PHP)

Source: https://www.u-tools.cn/docs/developer/api-reference/server.html

PHP code example for making the GET /baseinfo API request.

```php
$ch = curl_init();
$url = "https://open.u-tools.cn/baseinfo?" . http_build_query($params);
$headers = array(
  "Content-Type: application/json",
  "Accept: application/json",
)
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
if (!curl_errno($ch)) {
  $json = json_decode($response, true);
  echo $json;
}
curl_close($ch);

```

--------------------------------

### Get User Basic Information - Making the Request (Node.js)

Source: https://www.u-tools.cn/docs/developer/api-reference/server.html

Node.js code example for making the GET /baseinfo API request.

```js
const fetch = require('node-fetch')
const params = {
  plugin_id: "zueadppw", // 可在开发者插件应用中获得
  access_token: "user access_token 32位",
  timestamp: "1624329435",
  sign: "xxx"
}
fetch('https://open.u-tools.cn/baseinfo?' + new URLSearchParams(params), {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  },
).then(res => res.json()).then(data => {
  console.log(data)
})

```

--------------------------------

### Start Project with Vite

Source: https://www.u-tools.cn/docs/developer/basic/debug-plugin.html

Command to start the development server for a Vite project.

```shell
npm run dev
```

--------------------------------

### Get All Displays Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/screen.html

Fetches and logs information about all connected displays using `utools.getAllDisplays()`.

```javascript
const displays = utools.getAllDisplays();
console.log(displays);
```

--------------------------------

### Basic Usage Example

Source: https://www.u-tools.cn/docs/developer/utools-api/ubrowser.html

An example demonstrating the chained method calls for navigating, inputting text, and pressing enter.

```javascript
utools.ubrowser.goto('https://www.baidu.com').input('uTools').press('enter').run({ width: 1200, height: 800 })
```

--------------------------------

### Start Webpack Dev Server

Source: https://www.u-tools.cn/docs/developer/basic/debug-plugin.html

Command to start the webpack-dev-server.

```shell
npm run serve
```

--------------------------------

### Get Current Window Type Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/window.html

Demonstrates how to get the type of the current window ('main', 'detach', or 'browser').

```javascript
utools.onPluginEnter(({ code, type, payload }) => {
  if (utools.getWindowType() === "main") {
    utools.showNotification("当前窗口为主窗口");
  }
});
```

--------------------------------

### Create Browser Window Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/window.html

Demonstrates how to create a new browser window, set its properties, and interact with its webContents.

```javascript
const ubWindow = utools.createBrowserWindow(
  "test.html",
  {
    show: false,
    title: "测试窗口",
    webPreferences: {
      preload: "preload.js",
    },
  },
  () => {
    // 显示
    ubWindow.show();
    // 置顶
    ubWindow.setAlwaysOnTop(true);
    // 窗口全屏
    ubWindow.setFullScreen(true);
    // 向子窗口发送消息
    ubWindow.webContents.send("ping", "test");
    // 执行脚本
    ubWindow.webContents.executeJavaScript('fetch("https://jsonplaceholder.typicode.com/users/1").then(resp => resp.json())').then((result) => {
      console.log(result); // Will be the JSON object from the fetch call
    });
  }
);
console.log(ubWindow);
```

--------------------------------

### Example: Applying theme based on dark mode

Source: https://www.u-tools.cn/docs/developer/utools-api/window.html

Demonstrates how to use isDarkColors to apply a dark theme to the body.

```javascript
utools.onPluginEnter(({ code, type, payload }) => {
  document.body.className = utools.isDarkColors() ? "dark-mode" : "";
});
```

--------------------------------

### Screen Color Pick Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/screen.html

Demonstrates how to use `utools.screenColorPick` to get a color from the screen and log its hex and RGB values.

```javascript
// 取色
utools.screenColorPick((colors) => {
  const { hex, rgb } = colors;
  console.log(hex, rgb);
});
```

--------------------------------

### Get All AI Models

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/ai.html

Example of how to retrieve a list of all available AI models.

```javascript
const models = await utools.allAiModels();
console.log(models);
```

--------------------------------

### Example: Creating a standalone window with preload script

Source: https://www.u-tools.cn/docs/developer/utools-api/window.html

Demonstrates how to create a new browser window, set its properties, and handle callbacks.

```javascript
const win = utools.createBrowserWindow(
  "test.html",
  {
    show: false,
    title: "测试窗口",
    webPreferences: {
      preload: "test_preload.js",
    },
  },
  () => {
    // 显示
    win.show();
    // 置顶
    win.setAlwaysOnTop(true);
    // 窗口全屏
    win.setFullScreen(true);
    // 向子窗口发送消息
    win.webContents.send("ping", "test");
    // 执行脚本
    win.webContents.executeJavaScript('fetch("https://jsonplaceholder.typicode.com/users/1").then(resp => resp.json())').then((result) => {
      console.log(result); // Will be the JSON object from the fetch call
    });
  }
);
```

--------------------------------

### Get Application Version

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/system.html

Example of retrieving the version of the current application.

```javascript
console.log(utools.getAppVersion());
```

--------------------------------

### Get All Dynamic Features

Source: https://www.u-tools.cn/docs/developer/utools-api/features.html

Example of how to retrieve all dynamic features available in the plugin.

```javascript
// Get all dynamic features
const features = utools.getFeatures();
console.log(features);
```

--------------------------------

### Get User Basic Information - Response Data (Error)

Source: https://www.u-tools.cn/docs/developer/api-reference/server.html

Example JSON response when the GET /baseinfo request fails.

```json
{
  "message": "The given data was invalid.", // message 字段始终存在
  "errors": {
    // 可能没有详细错误信息
    "access_token": ["access token 必须是 32 个字符。"]
  }
}
```

--------------------------------

### Get User Basic Information - Response Data (Success)

Source: https://www.u-tools.cn/docs/developer/api-reference/server.html

Example JSON response when the GET /baseinfo request is successful (status 200).

```json
{
  "resource": {
    "avatar": "https://res.u-tools.cn/assets/avatars/eZCBIawAkspLw8Xg.png",
    "member": 1, // 是否 uTools 会员（0: 否，1: 是）
    "nickname": "却步.",
    "open_id": "00a50cd81c37c4e381e8161b2d762158", // uTools 用户 ID, 对于此插件应用不变且唯一
    "timestamp": 1624329616
  },
  "sign": "4dbf21a9d5a0f0e3906a0180522fd6393b4e91f738d57cafddf309afc6c547bb" // 签名算法与 1.3 相同
}
```

--------------------------------

### Example: Sending a message to the parent window

Source: https://www.u-tools.cn/docs/developer/utools-api/window.html

Illustrates how to use sendToParent to send messages from a child window to its parent.

```javascript
// 通过 utools.createBrowserWindow 创建的窗口调用
utools.sendToParent("pong", "hello", 123);
```

--------------------------------

### Get Application Name

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/system.html

Example of retrieving the name of the current application.

```javascript
console.log(utools.getAppName());
```

--------------------------------

### Sharp Instance Creation

Source: https://www.u-tools.cn/docs/developer/utools-api/sharp.html

Demonstrates how to get a Sharp instance object, which can then be used for chained image processing operations.

```typescript
function sharp(input?: Buffer | Uint8Array | ArrayBuffer | string | Object | Array, options?: SharpOptions): Sharp;
```

```javascript
const image = utools.sharp('input.png') .resize(200, 200).rotate(90).toBuffer();
```

--------------------------------

### Send Message to Parent Window Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/window.html

Example of how to send a message to the parent window from a window created by `utools.createBrowserWindow`.

```javascript
// 通过 utools.createBrowserWindow 创建的窗口调用
utools.sendToParent("pong", "hello", 123); // 版本：>= 6.1.0
```

--------------------------------

### WebM Screen Recording

Source: https://www.u-tools.cn/docs/developer/utools-api/screen.html

Example code for recording the screen in WebM format.

```js
async function screenRecording() {
  const ousrces = await utools.desktopCaptureSources({
    types: ["window", "screen"],
  });
  const stream = await navigator.mediaDevices.getUserMedia({
    audio: false,
    video: {
      mandatory: {
        chromeMediaSource: "desktop",
        chromeMediaSourceId: ousrces[0].id,
        minWidth: 1280,
        maxWidth: 1280,
        minHeight: 720,
        maxHeight: 720,
      },
    },
  });
  const video = document.querySelector("video");
  video.srcObject = stream;
  video.onloadedmetadata = (e) => video.play();
}
```

--------------------------------

### Importing Electron Renderer Process API

Source: https://www.u-tools.cn/docs/developer/information/preload-js/nodejs.html

Example of importing and using Electron's 'clipboard' and 'nativeImage' APIs in preload.js.

```javascript
const { clipboard, nativeImage } = require("electron");

window.services = {
  copyImage: (imageFilePath) => {
    clipboard.writeImage(nativeImage.createFromPath(imageFilePath))
  },
};
```

--------------------------------

### Get All Dynamic Features

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/features.html

Example of how to retrieve all dynamically created features for a plugin.

```javascript
// 获取所有动态功能
const features = utools.getFeatures();
console.log(features);
```

--------------------------------

### Get Primary Display Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/screen.html

Retrieves and logs the primary display information using `utools.getPrimaryDisplay()`.

```javascript
const display = utools.getPrimaryDisplay();
console.log(display);
```

--------------------------------

### Screen Capture Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/screen.html

Shows how to use `utools.screenCapture` to capture the screen and then redirect to 'OCR Text Recognition' for translation.

```javascript
// 截图完将图片发送到「OCR 文字识别」再跳转到进行翻译
utools.screenCapture((image) => {
  utools.redirect(['OCR 文字识别', '文字识别+翻译'], image)
});
```

--------------------------------

### Creating a fullscreen transparent window

Source: https://www.u-tools.cn/docs/developer/utools-api/window.html

Example of creating a fullscreen, transparent, always-on-top window, useful for screen effects or capturing.

```javascript
// 创建全屏透明置顶窗口，可用于做一些屏幕特效或拖动区域截取屏幕等功能
function createFullScreenTransparentWindow () {
  const cursorPoint = window.utools.getCursorScreenPoint()
  const currentDisplay = window.utools.getDisplayNearestPoint(cursorPoint)
  const displayBounds = currentDisplay.bounds
  const fullscreenable = window.utools.isWindows()
  const regionWindow = window.utools.createBrowserWindow('foo.html?params=', {
    show: true,
    x: displayBounds.x,
    y: displayBounds.y,
    width: displayBounds.width,
    height: displayBounds.height,
    backgroundColor: '#00000000', // 如果要接收鼠标事件请设置为 'rgba(255,255,255,0.01)',
    thickFrame: false,
    resizable: false,
    fullscreenable,
    fullscreen: fullscreenable,
    minimizable: false,
    maximizable: false,
    movable: false,
    autoHideMenuBar: true,
    frame: false,
    transparent: true,
    skipTaskbar: true,
    enableLargerThanScreen: true,
    alwaysOnTop: true,
    roundedCorners: false,
    hasShadow: false,
    webPreferences: {
      preload: 'foo_preload.js'
    }
  })
  try { regionWindow.setAlwaysOnTop(true, 'screen-saver') } catch {}
}
```

--------------------------------

### Get File Icon

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/system.html

Examples of retrieving system icons for file extensions, folders, or specific files.

```javascript
// System icon for .txt file extension
const txtIcon = utools.getFileIcon(".txt");
// System icon for a folder
const folderIcon = utools.getFileIcon("folder");
// Icon for a WeChat shortcut file
const folderIcon = utools.getFileIcon("C:\\Users\\Public\\Desktop\\微信.lnk");
```

--------------------------------

### Get User Basic Information - Signature Generation (PHP)

Source: https://www.u-tools.cn/docs/developer/api-reference/server.html

PHP code example for generating the signature required for API requests.

```php
$params = [
  "plugin_id" => "zueadppw", // 可在开发者插件应用中获得
  "access_token" => "user access_token 32位",
  "timestamp" => "1624329435",
];
// 1. 按照键名对数组进行升序排序
ksort($params);
// 2. 生成 URL-encode 之后的请求字符串
$str = http_build_query($params);
// 3. 使用 HMAC 方法生成带有密钥的哈希值
$secret = "your secret 32位"; // secret 在开发者插件应用中通过重置获取
$sign = hash_hmac("sha256", $str, $secret);

```

--------------------------------

### Process Image Based on Metadata

Source: https://www.u-tools.cn/docs/developer/utools-api/sharp.html

An example demonstrating how to retrieve image metadata and use it to perform subsequent operations, like resizing.

```javascript
const image = utools.sharp('/path/to/input.jpg');
image
  .metadata()
  .then(function(metadata) {
    return image
      .resize(Math.round(metadata.width / 2))
      .webp()
      .toBuffer();
  })
  .then(function(data) {
    // data contains a WebP image half the width and height of the original JPEG
  });
```

--------------------------------

### Redirect to Hotkey Setting

Source: https://www.u-tools.cn/docs/developer/utools-api/features.html

Example of how to navigate the user to the uTools settings to configure global hotkeys for a command.

```javascript
utools.redirectHotKeySetting("Clipboard");
utools.redirectHotKeySetting("Ask AI", true);
```

--------------------------------

### HTTP POST Request Example

Source: https://www.u-tools.cn/docs/developer/api-reference/server.html

This shows the HTTP method and content type for the callback request.

```http
POST /<*api_path>
Content-Type: application/json
```

--------------------------------

### Request Parameters Example

Source: https://www.u-tools.cn/docs/developer/api-reference/server.html

This JSON object illustrates the parameters sent to the callback URL upon successful payment.

```json
{
  "resource": {
    "attach": "", // 附加数据
    "body": "支付内容", // 支付内容
    "created_at": "2021-06-18 16:42:16", // 订单生成时间
    "goods_id": "xxx", // 商品ID
    "open_id": "xxx", // uTools 用户 ID
    "order_id": "xxx", // uTools 订单号
    "out_order_id": "123456", // 外部订单号
    "paid_at": "2021-06-18 16:42:36", // 用户支付时间
    "pay_fee": 1, // 支付金额（分）
    "plugin_id": "FFFFFFFF",
    "status": 10, // 是否支付（0: 未支付，10: 已支付）
    "timestamp": 1624346603 // 请求发送时间戳
  },
  "sign": "xxx"
}
```

--------------------------------

### Webpack Dev Server Script

Source: https://www.u-tools.cn/docs/developer/basic/debug-plugin.html

Script in package.json to start the webpack-dev-server.

```json
//package.json script
"scripts": {
    "serve": "webpack serve",
  }
```

--------------------------------

### Function Calling (Streaming)

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/ai.html

Example of a streaming AI call using Function Calling to get system information.

```javascript
const messages = [
  {
    role: "user",
    content: "我电脑的 CPU 是什么，内存多大",
  },
];
const tools = [
  {
    type: "function",
    function: {
      name: "getSystemInfo",
      description: "获取用户的电脑信息",
      parameters: {
        type: "object",
        properties: {},
      },
    },
  },
];

// 流式调用
await utools.ai({ messages, tools }, (delta) => {
  console.log(delta);
});
// 非流式调用
const result = await utools.ai({ messages, tools });
console.log(result.content);
```

--------------------------------

### Get User Basic Information - Signature Generation (Node.js)

Source: https://www.u-tools.cn/docs/developer/api-reference/server.html

Node.js code example for generating the signature required for API requests.

```js
const crypto = require("crypto");
const params = {
  plugin_id: "zueadppw", // 可在开发者插件应用中获得
  access_token: "user access_token 32位",
  timestamp: "1624329435",
};
// 1. 按照键名对数组进行升序排序
const keys = Object.keys(params).sort();
const sortedParams = keys.reduce((acc, key) => {
  acc[key] = params[key];
  return acc;
}, {});
// 2. 生成 URL-encode 之后的请求字符串
const str = new URLSearchParams(sortedParams).toString();
// 3. 使用 HMAC 方法生成带有密钥的哈希值
const secret = "your secret 32位"; // secret 在开发者插件应用中通过重置获取
const sign = crypto.createHmac("sha256", secret).update(str).digest("hex");

```

--------------------------------

### Get Display Matching Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/screen.html

Identifies and logs the display that contains a given rectangular area using `utools.getDisplayMatching()`.

```javascript
const display = utools.getDisplayMatching({
  x: 100,
  y: 100,
  width: 200,
  height: 200,
});
console.log(display);
```

--------------------------------

### Importing Custom Modules

Source: https://www.u-tools.cn/docs/developer/information/preload-js/nodejs.html

Example of importing a custom module ('writeText.js') in preload.js.

```javascript
const writeText = require("./libs/writeText.js");

window.services = {
  writeText,
};
```

```javascript
const fs = require("fs");
const path = require("path");

module.exports = function writeText(text, filePath) {
  const dir = path.dirname(filePath);
  if (!fs.existsSync(dir)) {
    fs.mkdirSync(dir, { recursive: true });
    fs.writeFileSync(filePath, text);
    return true;
  }
  return false;
};
```

--------------------------------

### Example Usage of utools.team.preset()

Source: https://www.u-tools.cn/docs/developer/api-reference/team.html

Shows how to read a team configuration value using utools.team.preset() with a specific key.

```javascript
// 读取配置
const configValue = utools.team.preset("config-key");
console.log(configValue);
```

--------------------------------

### Create Goods Interface - Response Data

Source: https://www.u-tools.cn/docs/developer/api-reference/server.html

Example JSON response when creating a good.

```json
{
  "message": "ZyxrbSpWBH360pSWG0ueYI3rKSWXMcic"
}
```

--------------------------------

### Simulate Mouse Move

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/simulate.html

Example of simulating mouse movement to a specified position.

```javascript
// Move the mouse to the top-left corner of the screen
utools.simulateMouseMove(50, 50);
```

--------------------------------

### Get Specific Dynamic Features by Code

Source: https://www.u-tools.cn/docs/developer/utools-api/features.html

Example of how to retrieve specific dynamic features by providing an array of their codes.

```javascript
// Get specific code
const features = utools.getFeatures(["code-1", "code-2"]);
console.log(features);
```

--------------------------------

### Show System Notification

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/system.html

Example of how to display a system notification with a message.

```javascript
utools.showNotification("hello test");
```

--------------------------------

### Get User Basic Information - Making the Request (cURL)

Source: https://www.u-tools.cn/docs/developer/api-reference/server.html

cURL command to make the GET /baseinfo API request.

```bash
curl --location --request GET 'https://open.u-tools.cn/baseinfo' \
--header 'Content-Type: application/json' \
--data-raw '{
  "plugin_id": "zueadppw", // 可在开发者插件应用中获得
  "access_token": "user access_token 32位",
  "timestamp": "1624329435",
  "sign": "xxx"
  }'

```

--------------------------------

### Start Drag

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/window.html

Initiates a file drag operation from the plugin to other windows. This generates a series of native files.

```javascript
utools.startDrag("/path/to/abc.txt");
utools.startDrag(["/path/to/1.txt", "/path/to/2.txt"]);
```

--------------------------------

### Check Development Environment

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/system.html

Example of checking if the plugin is running in a development environment.

```javascript
if (utools.isDev()) {
  console.log("Plugin development environment");
}
```

--------------------------------

### Screenshot (Capture Entire Screen)

Source: https://www.u-tools.cn/docs/developer/utools-api/screen.html

Example code for capturing a screenshot of the entire screen.

```js
async function captureScreen() {
  const sources = await utools.desktopCaptureSources({ types: ['screen'] });
  // 获取第一个屏幕（通常是主屏）
  const screenSource = sources[0];

  // 使用 MediaStream API 获取视频流
  const stream = await navigator.mediaDevices.getUserMedia({
    audio: false,
    video: {
      mandatory: {
        chromeMediaSource: 'desktop',
        chromeMediaSourceId: screenSource.id,
      }
    }
  });

  // 创建一个 <video> 元素播放这个流
  const video = document.createElement('video');
  video.srcObject = stream;
  await video.play();

  // 等待视频加载完毕
  await new Promise(resolve => video.onplaying = resolve);

  // 创建 canvas 并绘制当前帧
  const canvas = document.createElement('canvas');
  canvas.width = video.videoWidth;
  canvas.height = video.videoHeight;
  const ctx = canvas.getContext('2d');
  ctx.drawImage(video, 0, 0, canvas.width, canvas.height);

  // 将截图转为 base64
  const imageData = canvas.toDataURL('image/png');

  // 停止视频流释放资源
  stream.getTracks().forEach(track => track.stop());

  console.log('截图完成:', imageData);
  return imageData;
}
```

--------------------------------

### Importing Third-Party Modules from Source

Source: https://www.u-tools.cn/docs/developer/information/preload-js/nodejs.html

Example of cloning a module from GitHub (e.g., 'nodemailer') and importing it in preload.js.

```bash
git clone https://github.com/nodemailer/nodemailer.git
```

```javascript
const nodemailer = require("./nodemailer");
const _setImmediate = setImmediate;
process.once("loaded", function () {
  global.setImmediate = _setImmediate;
});
const sendMail = () => {
  let transporter = require("./nodemailer").createTransport({
    host: "smtp.qq.com",
    port: 465,
    secure: true,
    auth: {
      user: "aaa@qq.com",
      pass: "xxx",
    },
  });
  let mailOptions = {
    from: "aaa@qq.com",
    to: "bbb@gmail.com",
    subject: "Sending Email using Node.js",
    text: "That was easy!",
  };

  transporter.sendMail(mailOptions, function (error, info) {
    if (error) {
      console.log(error);
    } else {
      console.log("Email sent: " + info.response);
    }
  });
};
window.services = {
  sendMail: () => {
    return sendMail();
  },
};
```

--------------------------------

### Get Device ID and Store Data

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/system.html

Example of retrieving a unique device ID and using it to store device-specific information.

```javascript
// Store information specific to the current device
const nativeId = utools.getNativeId();
utools.dbStorage.setItem(nativeId + "/key", "native value");
```

--------------------------------

### Open File Path

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/system.html

Example of opening a file or folder using the system's default application.

```javascript
utools.shellOpenPath("C:\\Users\\Public\\Desktop\\test.txt");
```

--------------------------------

### Show Item in Folder

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/system.html

Example of revealing a file or folder in the system's file explorer.

```javascript
utools.shellShowItemInFolder("C:\\Users\\Public\\Desktop\\test.txt");
```

--------------------------------

### Install Webpack HMR Plugin

Source: https://www.u-tools.cn/docs/developer/basic/debug-plugin.html

Command to install the webpack-dev-server package for Webpack HMR.

```shell
npm install webpack-dev-server --save-dev
```

--------------------------------

### Generate Image from Text

Source: https://www.u-tools.cn/docs/developer/utools-api/sharp.html

Example of creating an image from a text string, specifying dimensions.

```javascript
await utools.sharp({
  text: {
    text: 'Hello, world!',
    width: 400, // max width
    height: 300 // max height
  }
}).toFile('/path/to/text_bw.png');
```

--------------------------------

### Set a Dynamic Feature

Source: https://www.u-tools.cn/docs/developer/utools-api/features.html

Example of how to add a new dynamic feature with its properties like code, explain, icon, platform, and commands.

```javascript
utools.setFeature({
  code: Date.now().toString(),
  explain: "Test dynamic feature",
  // "icon": "res/xxx.png",
  // "icon": "data:image/png;base64,xxx...",
  // "platform": ["win32", "darwin", "linux"]
  cmds: ["Test"],
});
```

--------------------------------

### Example Usage of utools.team.info()

Source: https://www.u-tools.cn/docs/developer/api-reference/team.html

Demonstrates how to retrieve and log the current team's name using utools.team.info().

```javascript
const { teamName } = utools.team.info();

console.log(`当前团队为：${teamName}`);
```

--------------------------------

### onPluginOut Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/events.html

Logs whether the plugin application was killed or hidden in the background when the user exits.

```javascript
utools.onPluginOut((isKill) => {
  if (isKill) {
    console.log("用户结束运行插件应用");
  } else {
    console.log("插件应用被隐藏后台");
  }
});
```

--------------------------------

### Get Attachment Type (Asynchronous)

Source: https://www.u-tools.cn/docs/developer/api-reference/db/local-db.html

Example of getting the MIME type of an attachment using the asynchronous promises.getAttachmentType method.

```typescript
const type = await utools.db.promises.getAttachmentType("test-image-file");
console.log("附件类型为", type);
```

--------------------------------

### Play System Beep

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/system.html

Example of playing the system's default notification sound.

```javascript
utools.shellBeep();
```

--------------------------------

### Post Attachment (Synchronous)

Source: https://www.u-tools.cn/docs/developer/api-reference/db/local-db.html

Example of storing an attachment to a new document using the synchronous postAttachment method.

```typescript
const fileBuffer = fs.readFileSync("/path/to/test.png");
const result = utools.db.postAttachment("test-image-file", fileBuffer, "image/png");
if (result.ok) {
  console.log("附件存储成功");
} else if (result.error) {
  // 存储失败，打印错误原因
  console.log(result.message);
}
```

--------------------------------

### Get Attachment Type (Synchronous)

Source: https://www.u-tools.cn/docs/developer/api-reference/db/local-db.html

Example of getting the MIME type of an attachment using the synchronous getAttachmentType method.

```typescript
const type = utools.db.getAttachmentType("test-image-file");
console.log("附件类型为", type);
```

--------------------------------

### Simulate Mouse Click

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/simulate.html

Example of simulating a left mouse click at a specified position.

```javascript
// Click at a position 100 pixels from the left and 100 pixels from the top of the screen
utools.simulateMouseClick(100, 100);
```

--------------------------------

### Check Operating System (Windows)

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/system.html

Example of checking if the current operating system is Windows.

```javascript
if (utools.isWindows()) {
  console.log("Current system is Windows");
}
```

--------------------------------

### Resize JPG Image

Source: https://www.u-tools.cn/docs/developer/utools-api/sharp.html

Example of resizing a JPG image to specific dimensions and saving it to a new file.

```javascript
await utools.sharp('/path/to/input.jpg').resize(300, 200).toFile('/path/to/output.jpg');
```

--------------------------------

### Get Cursor Screen Point Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/screen.html

Gets and logs the absolute screen coordinates of the mouse cursor using `utools.getCursorScreenPoint()`.

```javascript
const { x, y } = utools.getCursorScreenPoint();
console.log(x, y);
```

--------------------------------

### Simulate Keyboard Tap

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/simulate.html

Examples of simulating keyboard taps with and without modifiers.

```javascript
// Simulate keyboard tap Enter
utools.simulateKeyboardTap("enter");
// windows linux simulate paste
utools.simulateKeyboardTap("v", "ctrl");
// macOS simulate paste
utools.simulateKeyboardTap("v", "command");
// Simulate Ctrl + Alt + A
utools.simulateKeyboardTap("a", "ctrl", "alt");
```

--------------------------------

### onMainPush Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/events.html

Demonstrates how to push content to the search bar and handle user selection. The callback returns content to display, and the onSelect callback determines whether to enter the plugin or perform another action.

```javascript
function callback({ code, type, payload }) {
  return [
    {
      icon: "icon.png",
      text: "选项1",
      title: "help text",
    },
    {
      text: "选项2",
      anyField: "xxxx",
    },
  ];
}
function selectCallback({ code, type, payload, option }) {
  if (option.xxx) {
    // 返回 true 表示需要进入插件应用处理
    return true;
  }
  // 不进入插件应用 "执行粘贴文本"
  utools.hideMainWindowPasteText(option.text);
}
utools.onMainPush(callback, selectCallback);
```

--------------------------------

### Check Operating System (Linux)

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/system.html

Example of checking if the current operating system is Linux.

```javascript
if (utools.isLinux()) {
  console.log("Current system is Linux");
}
```

--------------------------------

### Move Item to Trash

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/system.html

Example of deleting a file and moving it to the system's recycle bin.

```javascript
utools.shellTrashItem("C:\\Users\\Public\\Desktop\\test.txt");
```

--------------------------------

### Open External URL

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/system.html

Example of opening a URL with the system's default protocol handler, including mailto links.

```javascript
// Open uTools official website
utools.shellOpenExternal("https://www.u-tools.cn");
```

--------------------------------

### Example Usage of utools.team.allPresets()

Source: https://www.u-tools.cn/docs/developer/api-reference/team.html

Illustrates different ways to use utools.team.allPresets() to fetch team configurations, including filtering by a key prefix, specific keys, or fetching all configurations.

```javascript
// 获取 key 是 "config-" 开头的所有配置
const allPresets1 = utools.team.allPresets("config-");
// 获取 key 数组对应的配置
const allPresets2 = utools.team.allPresets(["config-key-1", "config-key-2"]);
// 获取所有配置
const allPresets3 = utools.team.allPresets();
```

--------------------------------

### Alternative: Using web native methods for theme detection

Source: https://www.u-tools.cn/docs/developer/utools-api/window.html

Recommends using native web APIs like matchMedia for theme detection and listening to changes.

```javascript
  let theme
  // 是否深色主题
  const isDark = window.matchMedia('(prefers-color-scheme: dark)').matches
  theme = isDark ? 'dark' : 'light'
  // 监听主题切换
  window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', e => {
    theme = e.matches ? 'dark' : 'light'
  })
```

--------------------------------

### Replicate State From Cloud (Synchronous)

Source: https://www.u-tools.cn/docs/developer/api-reference/db/local-db.html

Example of checking the cloud data synchronization status using the synchronous replicateStateFromCloud method.

```typescript
const state = utools.db.replicateStateFromCloud();
if (state === 1) {
  console.log("数据从云端拉取同步中...");
} else {
  console.log("数据已从云端同步完成");
}
```

--------------------------------

### Redirect to Hotkey Settings

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/features.html

Example of redirecting the user to the uTools settings interface to configure global hotkeys for a command.

```javascript
utools.redirectHotKeySetting("剪贴板");
utools.redirectHotKeySetting("问 AI", true);
```

--------------------------------

### Simulate Mouse Right Click

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/simulate.html

Example of simulating a right mouse click at a specified position.

```javascript
// Right-click at a position 100 pixels from the left and 100 pixels from the top of the screen
utools.simulateMouseRightClick(100, 100);
```

--------------------------------

### Post Attachment (Asynchronous)

Source: https://www.u-tools.cn/docs/developer/api-reference/db/local-db.html

Example of storing an attachment to a new document using the asynchronous promises.postAttachment method.

```typescript
const fileBuffer = fs.promises.readFile("/path/to/test.png");
const result = await utools.db.promises.postAttachment("test-image-file", fileBuffer, "image/png");
if (result.ok) {
  console.log("附件存储成功");
} else if (result.error) {
  // 存储失败，打印错误原因
  console.log(result.message);
}
```

--------------------------------

### Replicate State From Cloud (Asynchronous)

Source: https://www.u-tools.cn/docs/developer/api-reference/db/local-db.html

Example of checking the cloud data synchronization status using the asynchronous promises.replicateStateFromCloud method.

```typescript
const state = await utools.db.promises.replicateStateFromCloud();
if (state === 1) {
  console.log("数据从云端拉取同步中...");
} else {
  console.log("数据已从云端同步完成");
}
```

--------------------------------

### Simulate Mouse Double Click

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/simulate.html

Example of simulating a left mouse double-click at a specified position.

```javascript
// Double-click at a position 100 pixels from the left and 100 pixels from the top of the screen
utools.simulateMouseDoubleClick(100, 100);
```

--------------------------------

### Screen to DIP Point Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/screen.html

Converts screen physical coordinates to DIP coordinates using `utools.screenToDipPoint()`.

```javascript
const dipPoint = utools.screenToDipPoint({ x: 200, y: 200 });
console.log(dipPoint);
```

--------------------------------

### onPluginEnter Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/events.html

Logs information about the user entering a plugin application, including the code, type, payload, and the method of entry.

```javascript
utools.onPluginEnter(({ code, type, payload, option, from }) => {
  console.log("用户进入插件应用", code, type, payload);
  console.log("用户inrush插件的方式：", from);
});
```

--------------------------------

### Get Attachment (Asynchronous)

Source: https://www.u-tools.cn/docs/developer/api-reference/db/local-db.html

Example of retrieving an attachment from the database using the asynchronous promises.getAttachment method.

```typescript
const buf = await utools.db.promises.getAttachment("test-image-file");
if (buf) {
  await fs.promises.writeFile(utools.getPath('downloads') + "/test.png", buf);
}
```

--------------------------------

### Get Attachment (Synchronous)

Source: https://www.u-tools.cn/docs/developer/api-reference/db/local-db.html

Example of retrieving an attachment from the database using the synchronous getAttachment method.

```typescript
const buf = utools.db.getAttachment("test-image-file");
if (buf) {
  fs.writeFileSync(utools.getPath('downloads') + "/test.png", buf);
}
```

--------------------------------

### Get Specific Features by Code

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/features.html

Example of retrieving specific dynamic features by providing an array of their codes.

```javascript
// 获取特定 code
const features = utools.getFeatures(["code-1", "code-2"]);
console.log(features);
```

--------------------------------

### Bulk Create Documents (Synchronous)

Source: https://www.u-tools.cn/docs/developer/api-reference/db/local-db.html

Demonstrates how to create multiple documents in the local database using the synchronous bulkDocs method.

```typescript
// 批量创建文档
const docs = [
  { _id: "test/doc-2", a: "a 2222222", b: "b 2222222" },
  { _id: "test/doc-3", b: "a 3333333", b: "b 3333333" }
];
const results = utools.db.bulkDocs(docs);
results.forEach(ret => {
  // 更新文档版本
  if (ret.ok) {
    docs.find(x => x._id === ret.id)?._rev = ret.rev;
  }
})
```

--------------------------------

### Importing Node.js Native Modules

Source: https://www.u-tools.cn/docs/developer/information/preload-js/nodejs.html

Example of importing and using Node.js native modules like 'fs', 'path', 'os', and 'child_process' in preload.js.

```javascript
const fs = require("node:fs");
const path = require("node:path");
const os = require("node:os");
const { execSync } = require("node:child_process");

window.services = {
  readFile: (filename) => {
    return fs.readFileSync(filename, { encoding: "utf-8" });
  },
  getFolder: (filepath) => {
    return path.dirname(filepath);
  },
  getOSInfo: () => {
    return { arch: os.arch(), cpus: os.cpus(), release: os.release() };
  },
  execCommand: (command) => {
    execSync(command);
  },
};
```

--------------------------------

### Get Display Nearest Point Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/screen.html

Finds and logs the display that contains a specific point using `utools.getDisplayNearestPoint()`.

```javascript
const display = utools.getDisplayNearestPoint({ x: 100, y: 100 });
console.log(display);
```

--------------------------------

### Show Open Dialog

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/window.html

Pops up a file selection dialog. Returns an array of file paths, or undefined if the user cancels.

```javascript
const files = utools.showOpenDialog({
  filters: [{ name: "plugin.json", extensions: ["json"] }],
  properties: ["openFile"],
});

console.log(files);
```

--------------------------------

### Bulk Create Documents (Asynchronous)

Source: https://www.u-tools.cn/docs/developer/api-reference/db/local-db.html

Demonstrates how to create multiple documents in the local database using the asynchronous promises.bulkDocs method.

```typescript
// 批量创建文档
const docs = [
  { _id: "test/doc-2", a: "a 2222222", b: "b 2222222" },
  { _id: "test/doc-3", b: "a 3333333", b: "b 3333333" }
];
const results = await utools.db.promises.bulkDocs(docs);
results.forEach(ret => {
  // 更新文档版本
  if (ret.ok) {
    docs.find(x => x._id === ret.id)?._rev = ret.rev;
  }
})
```

--------------------------------

### Get Document (Asynchronous)

Source: https://www.u-tools.cn/docs/developer/api-reference/db/local-db.html

Demonstrates retrieving a document by its ID using the asynchronous `utools.db.promises.get()` method. It includes an example of modifying and re-saving the retrieved document.

```typescript
// 获取文档
const doc = await utools.db.promises.get("test/doc-1");
console.log(doc);
if (doc) {
  // 修改文档
  doc.c = 123;
  result = await utools.db.promises.put(doc);
  if (result.ok) {
    // 保存成功, 更新文档版本
    doc._rev = result.rev;
  } else if (result.error) {
    // 保存出错，打印错误原因
    console.log(result.message);
  }
}
```

--------------------------------

### Get Document (Synchronous)

Source: https://www.u-tools.cn/docs/developer/api-reference/db/local-db.html

Shows how to retrieve a document by its ID using the synchronous `utools.db.get()` method. It also includes an example of modifying and re-saving the retrieved document.

```typescript
// 获取文档
const doc = utools.db.get("test/doc-1");
console.log(doc);
if (doc) {
  // 修改文档
  doc.c = 123;
  result = utools.db.put(doc);
  if (result.ok) {
    // 保存成功, 更新文档版本
    doc._rev = result.rev;
  } else if (result.error) {
    // 保存出错，打印错误原因
    console.log(result.message);
  }
}
```

--------------------------------

### Get User Basic Information - Request Parameters

Source: https://www.u-tools.cn/docs/developer/api-reference/server.html

Parameters required for the GET /baseinfo API call to retrieve user information.

```http
GET https://open.u-tools.cn/baseinfo
Accept: application/json
```

--------------------------------

### Save Raw Pixel Array as PNG

Source: https://www.u-tools.cn/docs/developer/utools-api/sharp.html

Example of creating a Sharp instance from raw pixel data (Uint8Array) and saving it as a PNG file.

```javascript
const input = Uint8Array.from([255, 255, 255, 0, 0, 0]); // or Uint8ClampedArray
const image = utools.sharp(input, {
  raw: {
    width: 2,
    height: 1,
    channels: 3
  }
});
await image.toFile('/path/to/my-two-pixels.png');
```

--------------------------------

### Create Empty PNG Image

Source: https://www.u-tools.cn/docs/developer/utools-api/sharp.html

Code to create a new, empty PNG image with a specified background color and dimensions, then convert it to a buffer.

```javascript
await utools.sharp({
  create: {
    width: 300,
    height: 200,
    channels: 4,
    background: { r: 255, g: 0, b: 0, alpha: 0.5 }
  }
}).png().toBuffer();
```

--------------------------------

### onPluginDetach Example

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/events.html

Logs a message when the plugin application is detached into a separate window.

```javascript
utools.onPluginDetach(() => {
  console.log("插件应用分离为独立窗口");
});
```

--------------------------------

### Convert GIF Animation to WebP

Source: https://www.u-tools.cn/docs/developer/utools-api/sharp.html

Demonstrates converting an animated GIF file to the WebP format, preserving animation.

```javascript
await utools.sharp('/path/to/in.gif', { animated: true }).toFile('/path/to/out.webp');
```

--------------------------------

### AI Chat (Non-Streaming)

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/ai.html

Example of a non-streaming AI chat call for translation.

```javascript
const messages = [
  {
    role: "system",
    content:
      "你是一个英文翻译专家，将用户的任何内容都翻译成英文，翻译结果要符合英文语言习惯",
  },
  {
    role: "user",
    content: "uTools 是一种高效工作方式",
  },
];

const result = await utools.ai({ messages });
console.log(result.content);
```

--------------------------------

### AI Chat (Streaming)

Source: https://www.u-tools.cn/docs/developer/api-reference/utools/ai.html

Example of a streaming AI chat call for translation.

```javascript
const messages = [
  {
    role: "system",
    content:
      "你是一个英文翻译专家，将用户的任何内容都翻译成英文，翻译结果要符合英文语言习惯",
  },
  {
    role: "user",
    content: "uTools 是一种高效工作方式",
  },
];

await utools.ai({ messages }, (chunk) => {
  console.log(chunk);
});
```

--------------------------------

### Open the payment interface

Source: https://www.u-tools.cn/docs/developer/api-reference/payment.html

This example demonstrates how to use `utools.openPayment()` to open the service payment interface for users to purchase services based on usage.

```javascript
// 1. 配置好服务端支付通知地址
// 2. 打开支付
utools.openPayment({ goodsId: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }, () => {
  console.log("支付成功");
  // 重新从服务器获取已购买商品量
});
```
Tokens:
Raw