@aidejs/tools 0.1.0-alpha.0 → 0.1.0-alpha.2

package/CHANGELOG

@@ -0,0 +1,4 @@
+v0.1.0:
+    date:
+    changes:
+      - 初始化版本

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) zxl20070701 走一步，再走一步
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,107 @@
+<img src="./docs/images/logo.png" />
+
+# [Aidejs](https://github.com/NN-Studio/Aidejs)
+一个用于构建人工智能代理的JavaScript框架，它提供了一组工具和库，使创建智能应用程序变得轻松和高效
+
+## 功能列表
+
+通过类似拼积木的方式，你可以轻松地组合各个模块完成个性化的 AI 应用开发。
+
+下面是可用模块：
+
+<p>
+    <a href="https://github.com/NN-Studio/Aidejs/issues">
+        <img src="https://img.shields.io/github/issues/NN-Studio/Aidejs" alt="issue">
+    </a>
+    <a href="https://github.com/NN-Studio/Aidejs" target='_blank'>
+        <img alt="GitHub repo stars" src="https://img.shields.io/github/stars/NN-Studio/Aidejs?style=social">
+    </a>
+    <a href="https://github.com/NN-Studio/Aidejs">
+        <img src="https://img.shields.io/github/forks/NN-Studio/Aidejs" alt="forks">
+    </a>
+</p>
+
+<table>
+    <thead>
+        <tr>
+            <td>名称</td>
+            <td>简介</td>
+            <td>地址</td>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>@aidejs/core</td>
+            <td>必选项，基础库，提供了最核心的LLM交互功能和插件系统</td>
+            <td>
+                <a href="https://www.npmjs.com/package/@aidejs/core" target="_blank">访问</a>
+            </td>
+        </tr>
+        <tr>
+            <td>@aidejs/tools</td>
+            <td>非必选，工具库，提供了各种实用的工具函数</td>
+            <td>
+                <a href="https://www.npmjs.com/package/@aidejs/tools" target="_blank">访问</a>
+            </td>
+        </tr>
+    </tbody>
+</table>
+
+更多模块我们将持续维护，你也可以[ 提issue ](https://github.com/NN-Studio/Aidejs/issues)告诉我们你希望提供或丰富优化的。
+
+## 如何使用？
+
+比如我们希望智能体告诉我们 ./mailmap 文件中的内容，怎么办？
+
+首先，安装必要的依赖：
+
+```bash
+npm i @aidejs/core @aidejs/tools
+```
+
+然后在文件index.js中写入如下代码：
+
+```js
+const Aidejs = require("@aidejs/core");
+const Tools = require("@aidejs/tools");
+
+// 注册插件
+Aidejs.use(Tools);
+
+let agent = new Aidejs({
+    model: "qwen3",
+    url: "http://localhost:11434/v1",
+    apiKey: ""
+});
+
+agent.task("告诉我文件./.mailmap中的内容是什么", function (message) {
+    process.stdout.write(message);
+});
+```
+
+然后直接运行：
+
+```bash
+node ./index.js
+```
+
+运行以后，就可以看见智能体的回答了：
+
+```
+文件 `./.mailmap` 的内容如下：
+
+` ` `
+zxl20070701 <1904314465@qq.com>
+` ` `
+
+这通常是一个邮件映射配置文件，用于将作者名（`zxl20070701`）映射到具体的邮箱地址（`1904314465@qq.com`），
+常见于 Git 等工具的签名配置中。需要我帮你修改或解释吗？
+```
+
+更多细节，你可以访问[ 《Aidejs官方文档》 ](https://NN-Studio.github.io/Aidejs/)进行了解或学习。
+
+## 版权
+
+MIT License
+
+Copyright (c) [zxl20070701](https://zxl20070701.github.io/notebook/home.html) 走一步，再走一步

package/package.json

@@ -1,26 +1,36 @@
-{
-  "name": "@aidejs/tools",
-  "version": "0.1.0-alpha.0",
-  "description": "@aidejs/tools",
-  "main": "./src/index.js",
-  "typings": "./types/index.d.ts",
-  "sideEffects": false,
-  "scripts": {},
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/NN-Studio/Aidejs.git",
-    "directory": "packages/tools"
-  },
-  "author": {
-    "name": "zxl20070701",
-    "url": "https://zxl20070701.github.io/notebook/home.html"
-  },
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/NN-Studio/Aidejs/issues"
-  },
-  "homepage": "https://github.com/NN-Studio/Aidejs",
-  "dependencies": {
-    "oipage": "^2.0.0"
-  }
+{
+    "name": "@aidejs/tools",
+    "version": "0.1.0-alpha.2",
+    "description": "@aidejs/tools",
+    "main": "./src/index.js",
+    "typings": "./types/index.d.ts",
+    "sideEffects": false,
+    "scripts": {},
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/NN-Studio/Aidejs.git",
+        "directory": "packages/tools"
+    },
+    "author": {
+        "name": "zxl20070701",
+        "url": "https://zxl20070701.github.io/notebook/home.html"
+    },
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/NN-Studio/Aidejs/issues"
+    },
+    "homepage": "https://github.com/NN-Studio/Aidejs",
+    "dependencies": {
+        "oipage": "^2.0.0"
+    },
+    "keywords": [
+        "AI",
+        "Agent",
+        "ChatGPT",
+        "Aidejs",
+        "OpenClaw",
+        "skills",
+        "MCP",
+        "tools"
+    ]
 }

package/src/browser/index.js

@@ -0,0 +1,3 @@
+module.exports = [
+    require('./open'),
+];

package/src/browser/open.js

@@ -0,0 +1,47 @@
+const { exec } = require('child_process');
+const os = require('os');
+
+module.exports = {
+    "description": {
+        "type": "function",
+        "function": {
+            "name": "open",
+            "description": "用浏览器打开指定网页",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "url": {
+                        "type": "string",
+                        "description": "需要打开的网页地址",
+                    },
+                },
+                "required": ["url"],
+            },
+        },
+    },
+    "valueOf": function (args) {
+        const platform = os.platform();
+        let command;
+
+        switch (platform) {
+            case 'win32': // Windows
+                command = `start ${args.url}`;
+                break;
+            case 'darwin': // macOS
+                command = `open ${args.url}`;
+                break;
+            default: // Linux及其他
+                command = `xdg-open ${args.url}`;
+        }
+
+        return new Promise(function (resolve, reject) {
+            exec(command, (error) => {
+                if (error) {
+                    reject(`无法打开浏览器: ${error}`);
+                } else {
+                    resolve("成功打开了网页");
+                }
+            });
+        });
+    }
+};

package/src/disk/copyDisk.js

@@ -0,0 +1,26 @@
+module.exports = {
+    "description": {
+        "type": "function",
+        "function": {
+            "name": "copyDisk",
+            "description": "复制文件或文件夹",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "sourcePath": {
+                        "type": "string",
+                        "description": "需要复制的文件或文件夹的源路径",
+                    },
+                    "targetPath": {
+                        "type": "string",
+                        "description": "准备把文件或文件夹复制到的目标路径",
+                    }
+                },
+                "required": ["sourcePath", "targetPath"],
+            },
+        },
+    },
+    "valueOf": function (args) {
+        return require("oipage/nodejs/disk/index.js").copyDisk(args.sourcePath, args.targetPath, true);
+    }
+};

package/src/disk/deleteDisk.js

@@ -0,0 +1,22 @@
+module.exports = {
+    "description": {
+        "type": "function",
+        "function": {
+            "name": "deleteDisk",
+            "description": "删除文件或文件夹",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "diskPath": {
+                        "type": "string",
+                        "description": "需要删除的文件或文件夹的路径",
+                    },
+                },
+                "required": ["diskPath"],
+            },
+        },
+    },
+    "valueOf": function (args) {
+        return require("oipage/nodejs/disk/index.js").deleteDisk(args.diskPath, true);
+    }
+};

package/src/disk/index.js

@@ -0,0 +1,8 @@
+module.exports = [
+    require('./readPlain'),
+    require('./writePlain'),
+    require('./copyDisk'),
+    require('./deleteDisk'),
+    require('./linkDisk'),
+    require('./moveDisk'),
+];

package/src/disk/linkDisk.js

@@ -0,0 +1,26 @@
+module.exports = {
+    "description": {
+        "type": "function",
+        "function": {
+            "name": "linkDisk",
+            "description": "创建文件或文件夹的软链接或快捷方式",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "sourcePath": {
+                        "type": "string",
+                        "description": "需要创建软链接的文件或文件夹的源路径",
+                    },
+                    "targetPath": {
+                        "type": "string",
+                        "description": "准备把文件或文件夹软链接到的目标路径",
+                    }
+                },
+                "required": ["sourcePath", "targetPath"],
+            },
+        },
+    },
+    "valueOf": function (args) {
+        return require("oipage/nodejs/disk/index.js").linkDisk(args.sourcePath, args.targetPath, true);
+    }
+};

package/src/disk/moveDisk.js

@@ -0,0 +1,26 @@
+module.exports = {
+    "description": {
+        "type": "function",
+        "function": {
+            "name": "moveDisk",
+            "description": "移动文件或文件夹",
+            "parameters": {
+                "type": "object",
+                "properties": {
+                    "sourcePath": {
+                        "type": "string",
+                        "description": "需要移动的文件或文件夹的源路径",
+                    },
+                    "targetPath": {
+                        "type": "string",
+                        "description": "准备把文件或文件夹移动到的目标路径",
+                    }
+                },
+                "required": ["sourcePath", "targetPath"],
+            },
+        },
+    },
+    "valueOf": function (args) {
+        return require("oipage/nodejs/disk/index.js").moveDisk(args.sourcePath, args.targetPath, true);
+    }
+};

package/src/index.js

@@ -1,16 +1,22 @@
 module.exports = {
-    install(Aidejs) {
+    install(Aidejs, options) {
 
         // 工具列表
         const tools = {
-            readPlain: require('./readPlain'),
-            writePlain: require('./writePlain'),
+            disk: require("./disk/index.js"), // 磁盘操作
+            browser: require("./browser/index.js"), // 浏览器
         };
 
         // 注册工具
-        for (let toolName in tools) {
-            Aidejs.registerTool(toolName, tools[toolName]);
+        for (let toolType in tools) {
+            for (let toolItem of tools[toolType]) {
+                let functionName = toolItem.description.function.name;
+                if (!options.exclude || !options.exclude(toolType, functionName)) {
+                    let toolName = `aidejs_${toolType}_` + functionName;
+                    toolItem.description.function.name = toolName;
+                    Aidejs.registerTool(toolName, toolItem);
+                }
+            }
         }
-
     }
 };

package/types/index.d.ts

@@ -1,5 +1,14 @@
 import type Aidejs from "@aidejs/core"
 
 export default {
-    install(Aidejs: Aidejs): void
+    install(Aidejs: Aidejs, options?: {
+
+        /**
+         * 过滤若干不希望安装的工具
+         * @param toolType <string> 工具类型
+         * @param toolName <string> 工具名称
+         * @returns boolean 如果返回true，就表示当前工具不希望安装
+         */
+        exclude?: (toolType: string, toolName: string) => boolean
+    }): void
 }