Install packages

Author: c121914yu

bun.lock

@@ -68,6 +68,8 @@
       },
       "devDependencies": {
         "@babel/preset-typescript": "^7.27.1",
+        "@types/babel__generator": "^7.27.0",
+        "@types/babel__traverse": "^7.28.0",
       },
     },
     "runtime": {
@@ -417,6 +419,10 @@
 
     "@ts-rest/open-api": ["@ts-rest/[email protected]", "", { "dependencies": { "@anatine/zod-openapi": "^1.12.0", "openapi3-ts": "^2.0.2" }, "peerDependencies": { "@ts-rest/core": "~3.52.0", "zod": "^3.22.3" } }, "sha512-VY91g6HFzCe1/fNgX4Y3HzaJbIdztCGHTg34drkh7bKgtNOizLJLXV0wwIkMwLGvjhRHojJxnwYxHjGMIkScwg=="],
 
+    "@types/babel__generator": ["@types/[email protected]", "", { "dependencies": { "@babel/types": "^7.0.0" } }, "sha512-ufFd2Xi92OAVPYsy+P4n7/U7e68fex0+Ee8gSG9KX7eo084CWiQ4sdxktvdl0bOPupXtVJPY19zk6EwWqUQ8lg=="],
+
+    "@types/babel__traverse": ["@types/[email protected]", "", { "dependencies": { "@babel/types": "^7.28.2" } }, "sha512-8PvcXf70gTDZBgt9ptxJ8elBeBjcLOAcOtoO/mPJjtji1+CdGbHgm77om1GrsPxsiE+uXIpNSK64UYaIwQXd4Q=="],
+
     "@types/body-parser": ["@types/[email protected]", "", { "dependencies": { "@types/connect": "*", "@types/node": "*" } }, "sha512-HLFeCYgz89uk22N5Qg3dvGvsv46B8GLvKKo1zKG4NybA8U2DiEO3w9lqGg29t/tfLRJpJ6iQxnVw4OnB7MoM9g=="],
 
     "@types/bun": ["@types/[email protected]", "", { "dependencies": { "bun-types": "1.2.23" } }, "sha512-le8ueOY5b6VKYf19xT3McVbXqLqmxzPXHsQT/q9JHgikJ2X22wyTW3g3ohz2ZMnp7dod6aduIiq8A14Xyimm0A=="],

modules/tool/package.json

@@ -5,7 +5,9 @@
     "build:marketplace": "bun run ./build/build-json.ts"
   },
   "devDependencies": {
-    "@babel/preset-typescript": "^7.27.1"
+    "@babel/preset-typescript": "^7.27.1",
+    "@types/babel__generator": "^7.27.0",
+    "@types/babel__traverse": "^7.28.0"
   },
   "dependencies": {
     "@babel/generator": "^7.28.3",

modules/tool/packages/test1/DESIGN.md

@@ -0,0 +1,24 @@
+# xxx 系统工具
+
+## 参考信息
+
+### 参考文档
+
+### 测试密钥环境变量名
+
+### 工具集/子工具列表
+
+描述工具集名称，以及子工具，子工具需要包含 ID,名字，哪些输入输出，例如：
+
+```
+工具集名：Redis 操作，需要填写 redis 链接字符串做为密钥。
+
+子工具列表：
+1. get；获取缓存了；输入 key；输出 value和是否存在
+2. set；设置缓存；输入 key，value，ttl；输出是否成功
+3. del；删除缓存；输入 key；输出是否成功
+```
+
+---
+
+下面由 AI 生成完整的设计文档

modules/tool/packages/test1/README.md

@@ -0,0 +1,13 @@
+# example tool
+
+Write the introduction for your tool here.
+
+You can insert a picture with following markdown
+
+```markdown
+Insert a assets picture (you need to put you picture file in the assets dir)
+![](./assets/pic.png)
+
+Or insert a public pic
+![](https://picsum.photos/200)
+```

modules/tool/packages/test1/config.ts

@@ -0,0 +1,52 @@
+import { defineTool } from '@tool/type';
+import {
+  FlowNodeInputTypeEnum,
+  FlowNodeOutputTypeEnum,
+  WorkflowIOValueTypeEnum
+} from '@tool/type/fastgpt';
+import { ToolTagEnum } from '@tool/type/tags';
+
+export default defineTool({
+  name: {
+    'zh-CN': '模版工具',
+    en: 'Template tool'
+  },
+  tags: [ToolTagEnum.enum.tools],
+  description: {
+    'zh-CN': '描述',
+    en: 'description'
+  },
+  toolDescription:
+    'tool description for ai to use, fallback to English description if not provided',
+  secretInputConfig: [
+    {
+      key: 'apiKey',
+      label: 'API Key',
+      description: '可以在 xxx 获取',
+      required: true,
+      inputType: 'secret'
+    }
+  ],
+  versionList: [
+    {
+      value: '0.1.0',
+      description: 'Default version',
+      inputs: [
+        {
+          key: 'formatStr',
+          label: '格式化字符串',
+          renderTypeList: [FlowNodeInputTypeEnum.input, FlowNodeInputTypeEnum.reference],
+          valueType: WorkflowIOValueTypeEnum.string
+        }
+      ],
+      outputs: [
+        {
+          valueType: WorkflowIOValueTypeEnum.string,
+          key: 'time',
+          label: '时间',
+          description: '当前时间'
+        }
+      ]
+    }
+  ]
+});

modules/tool/packages/test1/index.ts

@@ -0,0 +1,10 @@
+import config from './config';
+import { InputType, OutputType, tool as toolCb } from './src';
+import { exportTool } from '@tool/utils/tool';
+
+export default exportTool({
+  toolCb,
+  InputType,
+  OutputType,
+  config
+});

modules/tool/packages/test1/logo.svg

@@ -0,0 +1,17 @@
+{
+  "name": "@fastgpt-plugins/tool-test1",
+  "module": "index.ts",
+  "type": "module",
+  "scripts": {
+    "build": "bun ../../../../scripts/build.ts"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "dependencies": {
+    "zod": "^3.24.3"
+  }
+}

modules/tool/packages/test1/package.json

@@ -0,0 +1,28 @@
+import { format } from 'date-fns';
+import { z } from 'zod';
+import axios from 'next';
+export const InputType = z.object({
+  apiKey: z.string(),
+  formatStr: z.string().optional().default('yyyy-MM-dd HH:mm:ss')
+});
+
+export const OutputType = z.object({
+  time: z.string()
+});
+
+export async function tool({
+  apiKey,
+  formatStr
+}: z.infer<typeof InputType>): Promise<z.infer<typeof OutputType>> {
+  // 请求数据
+  // const result = await fetch('https://api.example.com/data', {
+  //   method: 'POST',
+  //   body: JSON.stringify({
+  //     apiKey
+  //   })
+  // });
+
+  return {
+    time: format(new Date(), formatStr)
+  };
+}

modules/tool/packages/test1/src/index.ts

@@ -0,0 +1,8 @@
+import { expect, test } from 'vitest';
+import tool from '..';
+
+test(async () => {
+  expect(tool.name).toBeDefined();
+  expect(tool.description).toBeDefined();
+  expect(tool.cb).toBeDefined();
+});