@fastgpt-plugin/cli 0.1.0-beta.1 → 0.1.0-beta.2

package/dist/index.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import{consola as e}from"consola/basic";import{Command as t}from"commander";import n from"node:path";import r from"node:fs/promises";import{build as i}from"tsdown";import{Visitor as a,parseSync as o}from"oxc-parser";import{createHash as s}from"node:crypto";import{input as c,select as l}from"@inquirer/prompts";import{kebabCase as u}from"es-toolkit";import{createWriteStream as d}from"node:fs";import{ZipFile as f}from"yazl";const p=e;var m=`@fastgpt-plugin/cli`,h=`0.1.0-beta.1`;const g=m,_=h,v=`This is a FastGPT plugin`,y=n.join(import.meta.dirname,`../templates`);var b=class{};async function x(e){let t=n.join(e.rootDir,`src`);if(!await C(t))return w(``);let i=[],a=async t=>{let o=await r.readdir(t,{withFileTypes:!0});for(let r of o){let o=n.join(t,r.name);if(r.isDirectory()){if(r.name===`__tests__`)continue;await a(o);continue}if(!r.isFile())continue;let s=r.name;if(s.includes(`.test.`)||s.includes(`.spec.`))continue;let c=n.relative(e.rootDir,o).split(n.sep).join(`/`);c.startsWith(`src/`)&&i.push({rel:c,abs:o})}};await a(t),i.sort((e,t)=>e.rel.localeCompare(t.rel));let o=``;for(let e of i){let t=w(await r.readFile(e.abs));o+=`${e.rel}:${t}\n`}return w(o)}async function S(e){let{rootDir:t,toolId:r}=e,i=[...e.children].sort(),a=[];for(let e of i){let i=await x({rootDir:n.join(t,`children`,e)});a.push(`${r}/${e}:${i}`)}return w(a.length>0?`${a.join(`
+import{consola as e}from"consola/basic";import{Command as t}from"commander";import n from"node:path";import r from"node:fs/promises";import{build as i}from"tsdown";import{Visitor as a,parseSync as o}from"oxc-parser";import{createHash as s}from"node:crypto";import{input as c,select as l}from"@inquirer/prompts";import{kebabCase as u}from"es-toolkit";import{createWriteStream as d}from"node:fs";import{ZipFile as f}from"yazl";const p=e;var m=`@fastgpt-plugin/cli`,h=`0.1.0-beta.2`;const g=m,_=h,v=`This is a FastGPT plugin`,y=n.join(import.meta.dirname,`../templates`);var b=class{};async function x(e){let t=n.join(e.rootDir,`src`);if(!await C(t))return w(``);let i=[],a=async t=>{let o=await r.readdir(t,{withFileTypes:!0});for(let r of o){let o=n.join(t,r.name);if(r.isDirectory()){if(r.name===`__tests__`)continue;await a(o);continue}if(!r.isFile())continue;let s=r.name;if(s.includes(`.test.`)||s.includes(`.spec.`))continue;let c=n.relative(e.rootDir,o).split(n.sep).join(`/`);c.startsWith(`src/`)&&i.push({rel:c,abs:o})}};await a(t),i.sort((e,t)=>e.rel.localeCompare(t.rel));let o=``;for(let e of i){let t=w(await r.readFile(e.abs));o+=`${e.rel}:${t}\n`}return w(o)}async function S(e){let{rootDir:t,toolId:r}=e,i=[...e.children].sort(),a=[];for(let e of i){let i=await x({rootDir:n.join(t,`children`,e)});a.push(`${r}/${e}:${i}`)}return w(a.length>0?`${a.join(`
 `)}\n`:``)}async function C(e){try{return await r.access(e),!0}catch{return!1}}function w(e){let t=s(`md5`);return t.update(e),t.digest(`hex`)}function T(e){let t=e.split(`/`);return t.at(-3)===`children`?`${t.at(-4)}/${t.at(-2)}`:t.at(-2)||`unknown`}async function E(e){let t=n.join(e,`children`);try{await r.access(t)}catch{return[]}try{return await r.readdir(t)}catch{return[]}}function D(e,t){return e.some(e=>e.type===`Property`&&e.key?.type===`Identifier`&&e.key?.name===t)}function O(e,t){let n=t.sort((e,t)=>t.start-e.start),r=e;for(let e of n)r=r.slice(0,e.start)+e.content+r.slice(e.end);return r}async function k({sourceCode:e,filePath:t}){if(e.includes(`toolId:`))return{code:e,hasToolId:!0};let r=T(t),i=n.dirname(t),s=await E(i),c=await x({rootDir:i}),l=s.length>0?await S({rootDir:i,toolId:r,children:s}):null,u=o(n.basename(t),e,{sourceType:`module`});if(u.errors.length>0)throw Error(`Parse errors: ${u.errors.map(e=>e.message).join(`, `)}`);let d=[],f=[];new a({CallExpression(e){e.callee?.type===`Identifier`&&(e.callee.name===`defineTool`||e.callee.name===`defineToolSet`)&&e.arguments?.[0]?.type===`ObjectExpression`&&f.push(e)}}).visit(u.program);for(let e of f){let t=e.arguments[0];if(t?.type!==`ObjectExpression`)continue;let n=t,i=n.properties||[],a=e.callee?.type===`Identifier`&&e.callee.name===`defineToolSet`,o=!D(i,`toolId`),u=!D(i,`etag`),f=a&&!D(i,`children`)&&s.length>0;if(!o&&!u&&!f)continue;let p=i[i.length-1],m=p?p.end:(n.start??0)+1,h=[];if(o&&h.push(`toolId: '${r}'`),u){let e=a&&l?l:c;h.push(`etag: '${e}'`)}if(f){let e=s.map(e=>e).join(`, `);h.push(`children: [${e}]`);let t=s.map(e=>`import ${e} from './children/${e}';`).join(`
 `);d.push({start:0,end:0,content:t+`
 `})}if(h.length>0){let e=(p?`,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastgpt-plugin/cli",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0-beta.2",
   "type": "module",
   "private": false,
   "publishConfig": {
@@ -22,12 +22,13 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
+    "@fastgpt-plugin/helpers": "0.0.1-alpha.3",
     "@oxc-parser/binding-wasm32-wasi": "^0.112.0",
-    "oxc-parser": "^0.112.0",
     "@inquirer/prompts": "^8.2.0",
     "commander": "^14.0.3",
     "consola": "^3.4.2",
     "es-toolkit": "^1.44.0",
+    "oxc-parser": "^0.112.0",
     "tsdown": "^0.20.1",
     "yazl": "^3.3.1"
   },

package/templates/tool/config.ts

@@ -1,7 +1,7 @@
 import { defineTool, WorkflowIOValueTypeEnum, ToolTagEnum } from '@fastgpt-plugin/helpers';
 
 export default defineTool({
-  tags: [ToolTagEnum.enum.tools],
+  tags: [ToolTagEnum.tools],
   name: {
     'zh-CN': '{{name}}',
     en: '{{name}}'
@@ -18,10 +18,10 @@ export default defineTool({
       inputs: [],
       outputs: [
         {
-          key: 'message',
-          valueType: WorkflowIOValueTypeEnum.enum.string,
-          label: 'Message',
-          description: 'Tool output message'
+          key: 'time',
+          valueType: WorkflowIOValueTypeEnum.string,
+          label: '时间',
+          description: '当前时间'
         }
       ]
     }

package/templates/tool/index.ts

@@ -1,11 +1,11 @@
 import { exportTool } from '@fastgpt-plugin/helpers/tools/helper';
 import config from './config';
-import { tool as toolCb } from './src/tool';
-import { InputType, OutputType } from './src/schemas';
+import { InputSchema, OutputSchema } from './src/schemas';
+import { handler } from './src/tool';
 
 export default exportTool({
-  toolCb,
-  InputType,
-  OutputType,
+  handler,
+  InputSchema,
+  OutputSchema,
   config
 });

package/templates/tool/package.json

@@ -5,16 +5,17 @@
   "type": "module",
   "main": "dist/index.js",
   "scripts": {
-    "build": "npx @fastgpt-plugin/cli build",
+    "build": "npx @fastgpt-plugin/cli build --minify",
+    "build:dev": "npx @fastgpt-plugin/cli build",
+    "pack": "npx @fastgpt-plugin/cli pack",
     "test": "vitest run"
   },
-  "dependencies": {
-    "@fastgpt-plugin/helpers": "catalog:",
-    "zod": "catalog:"
-  },
+  "dependencies": {},
   "devDependencies": {
     "@fastgpt-plugin/cli": "catalog:",
+    "@fastgpt-plugin/helpers": "catalog:",
     "typescript": "catalog:",
-    "vitest": "catalog:"
+    "vitest": "catalog:",
+    "zod": "catalog:"
   }
 }

package/templates/tool/src/schemas.ts

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
-export const InputType = z.object({});
+export const InputSchema = z.object({});
+export type Input = z.infer<typeof InputSchema>;
 
-export const OutputType = z.object({
-  message: z.string()
+export const OutputSchema = z.object({
+  time: z.string().nonempty()
 });
+export type Output = z.infer<typeof OutputSchema>;

package/templates/tool/src/tool.test.ts

@@ -1,37 +1,17 @@
 import { describe, expect, it } from 'vitest';
-import { InputType, OutputType } from './schemas';
+import { InputSchema, OutputSchema } from './schemas';
 import { tool } from './tool';
+import { mockedEventEmitter, mockedSystemVar } from '@fastgpt-plugin/helpers/tools/mocks';
 
 describe('get-time', () => {
   it('should run with valid IO schemas', async () => {
-    const input = InputType.parse({});
+    const input = InputSchema.parse({});
     const result = await tool(input, {
-      systemVar: {
-        user: {
-          id: 'test',
-          username: 'test',
-          contact: 'test',
-          membername: 'test',
-          teamName: 'test',
-          teamId: 'test',
-          name: 'test'
-        },
-        app: {
-          id: 'test',
-          name: 'test'
-        },
-        tool: {
-          id: 'test',
-          version: '0.0.1'
-        },
-        time: new Date().toISOString()
-      },
-      streamResponse: () => {
-        // noop
-      }
+      systemVar: mockedSystemVar,
+      emitter: mockedEventEmitter
     });
 
-    const output = OutputType.parse(result);
+    const output = OutputSchema.parse(result);
     expect(output).toBeDefined();
   });
 });

package/templates/tool/src/tool.ts

@@ -1,10 +1,8 @@
-import type { RunToolSecondParamsType } from '@fastgpt-plugin/helpers/tools/schemas/req';
-import type { z } from 'zod';
-import type { InputType, OutputType } from './schemas';
+import type { ToolContextType } from '@fastgpt-plugin/helpers/tools/schemas/req';
+import type { Input, Output } from './schemas';
 
-export async function tool(
-  _input: z.infer<typeof InputType>,
-  _ctx: RunToolSecondParamsType
-): Promise<z.infer<typeof OutputType>> {
-  return { message: 'Hello from {{name}}' };
+export async function handler(_: Input, ctx: ToolContextType): Promise<Output> {
+  const { systemVar } = ctx;
+
+  return { time: systemVar.time };
 }

package/templates/tool-suite/children/tool/config.ts

@@ -1,7 +1,7 @@
-import { defineTool, WorkflowIOValueTypeEnum, ToolTagEnum } from '@fastgpt-plugin/helpers';
+import { defineTool, ToolTagEnum, WorkflowIOValueTypeEnum } from '@fastgpt-plugin/helpers';
 
 export default defineTool({
-  tags: [ToolTagEnum.enum.tools],
+  tags: [ToolTagEnum.tools],
   name: {
     'zh-CN': '{{name}}',
     en: '{{name}}'
@@ -14,14 +14,14 @@ export default defineTool({
   versionList: [
     {
       value: '0.0.1',
-      description: 'Initial version',
+      description: 'Default version',
       inputs: [],
       outputs: [
         {
-          key: 'message',
-          valueType: WorkflowIOValueTypeEnum.enum.string,
-          label: 'Message',
-          description: 'Tool output message'
+          key: 'time',
+          valueType: WorkflowIOValueTypeEnum.string,
+          label: '时间',
+          description: '当前时间'
         }
       ]
     }

package/templates/tool-suite/children/tool/index.ts

@@ -1,11 +1,11 @@
 import { exportTool } from '@fastgpt-plugin/helpers/tools/helper';
 import config from './config';
-import { tool as toolCb } from './src/tool';
-import { InputType, OutputType } from './src/schemas';
+import { InputSchema, OutputSchema } from './src/schemas';
+import { handler } from './src/tool';
 
 export default exportTool({
-  toolCb,
-  InputType,
-  OutputType,
+  handler,
+  InputSchema,
+  OutputSchema,
   config
 });

package/templates/tool-suite/children/tool/src/schemas.ts

@@ -1,7 +1,9 @@
 import { z } from 'zod';
 
-export const InputType = z.object({});
+export const InputSchema = z.object({});
+export type Input = z.infer<typeof InputSchema>;
 
-export const OutputType = z.object({
-  message: z.string()
+export const OutputSchema = z.object({
+  time: z.string().nonempty()
 });
+export type Output = z.infer<typeof OutputSchema>;

package/templates/tool-suite/children/tool/src/tool.ts

@@ -1,10 +1,8 @@
-import type { RunToolSecondParamsType } from '@fastgpt-plugin/helpers/tools/schemas/req';
-import type { z } from 'zod';
-import { InputType, OutputType } from './schemas';
+import type { ToolContextType } from '@fastgpt-plugin/helpers/tools/schemas/req';
+import type { Input, Output } from './schemas';
 
-export async function tool(
-  _input: z.infer<typeof InputType>,
-  _ctx: RunToolSecondParamsType
-): Promise<z.infer<typeof OutputType>> {
-  return { message: 'Hello from {{name}}' };
+export async function handler(_: Input, ctx: ToolContextType): Promise<Output> {
+  const { systemVar } = ctx;
+
+  return { time: systemVar.time };
 }

package/templates/tool-suite/config.ts

@@ -1,7 +1,7 @@
-import { defineToolSet, ToolTagEnum } from '@fastgpt-plugin/helpers';
+import { defineTool, ToolTagEnum, WorkflowIOValueTypeEnum } from '@fastgpt-plugin/helpers';
 
-export default defineToolSet({
-  tags: [ToolTagEnum.enum.tools],
+export default defineTool({
+  tags: [ToolTagEnum.tools],
   name: {
     'zh-CN': '{{name}}',
     en: '{{name}}'
@@ -9,5 +9,21 @@ export default defineToolSet({
   description: {
     'zh-CN': '{{description}}',
     en: '{{description}}'
-  }
+  },
+  icon: 'core/workflow/template/{{name}}',
+  versionList: [
+    {
+      value: '0.0.1',
+      description: 'Default version',
+      inputs: [],
+      outputs: [
+        {
+          key: 'time',
+          valueType: WorkflowIOValueTypeEnum.string,
+          label: '时间',
+          description: '当前时间'
+        }
+      ]
+    }
+  ]
 });

package/templates/tool-suite/package.json

@@ -5,16 +5,17 @@
   "type": "module",
   "main": "dist/index.js",
   "scripts": {
-    "build": "npx @fastgpt-plugin/cli build",
+    "build": "npx @fastgpt-plugin/cli build --minify",
+    "build:dev": "npx @fastgpt-plugin/cli build",
+    "pack": "npx @fastgpt-plugin/cli pack",
     "test": "vitest run"
   },
-  "dependencies": {
-    "@fastgpt-plugin/helpers": "catalog:",
-    "zod": "catalog:"
-  },
+  "dependencies": {},
   "devDependencies": {
     "@fastgpt-plugin/cli": "catalog:",
+    "@fastgpt-plugin/helpers": "catalog:",
     "typescript": "catalog:",
-    "vitest": "catalog:"
+    "vitest": "catalog:",
+    "zod": "catalog:"
   }
 }

package/templates/tool-suite/vitest.config.ts

@@ -5,4 +5,3 @@ export default defineConfig({
     environment: 'node'
   }
 });
-