donobu 2.20.0 → 2.20.1

package/dist/tools/Tool.d.ts

@@ -1,36 +1,33 @@
-import { JSONSchema7 } from 'json-schema';
 import { ToolCallContext } from '../models/ToolCallContext';
 import { ToolCallResult } from '../models/ToolCallResult';
+import { z } from 'zod';
 /** Represents a tool call to be invoked by a DonobuFlow. */
-export declare abstract class Tool<NonGptParameters, GptParameters> {
-    /**
-     * This is the name for the tool that will be shared with the LLM when making requests.
-     */
+export declare abstract class Tool<CallSchema extends z.ZodObject<any>, CallFromGptSchema extends z.ZodObject<any>> {
     readonly name: string;
-    /** This is the description that will be shared with the LLM when making requests. */
     readonly description: string;
-    /** This is the JSON-schema for the tool when it is invoked by a non-LLM. */
-    readonly inputSchema: JSONSchema7;
-    /**
-     * This is the JSON-schema that will be shared with the LLM when making
-     * requests during autonomous flows.
-     **/
-    readonly inputSchemaForGpt: JSONSchema7;
+    readonly inputSchema: CallSchema;
+    readonly inputSchemaForGpt: CallFromGptSchema;
+    readonly requiresGpt: boolean;
+    readonly controlPanelMessage: string;
     /**
-     * This is the message that will be displayed in the front-end control panel when this tool is
-     * invoked, assuming the control panel is enabled.
+     * @param name This is the name for the tool that will be shared with the LLM when making requests.
+     * @param description This is the description that will be shared with the LLM when making requests.
+     * @param inputSchema This is the JSON-schema for the tool when it is invoked by a non-LLM.
+     * @param inputSchemaForGpt This is the JSON-schema that will be shared with the LLM when making
+     *                          requests during autonomous flows.
+     * @param requiresGpt Set to true if this tool requires the usage of a GPT.
+     * @param controlPanelMessage This is the message that will be displayed in the front-end control
+     *                            panel when this tool is invoked, assuming the control panel is enabled.
+     *                            If not provided, it will be automatically generated from the name.
      */
-    readonly controlPanelMessage: string;
-    /** Returns true if this tool requires the usage of a GPT. */
-    readonly requiresGpt: boolean;
-    protected constructor(name: string, description: string, parametersTypeNameForNonGptSchema: string, parametersTypeNameForGptSchema: string, requiresGpt?: boolean);
+    protected constructor(name: string, description: string, inputSchema: CallSchema, inputSchemaForGpt: CallFromGptSchema, requiresGpt?: boolean, controlPanelMessage?: string);
     /**
      * Invoke the tool with the given context and parameters.
      */
-    abstract call(_context: ToolCallContext, _parameters: NonGptParameters): Promise<ToolCallResult>;
+    abstract call(context: ToolCallContext, parameters: z.infer<CallSchema>): Promise<ToolCallResult>;
     /**
      * Invoke the tool as made from a GPT with the given context and parameters.
      */
-    abstract callFromGpt(_context: ToolCallContext, _parameters: GptParameters): Promise<ToolCallResult>;
+    abstract callFromGpt(context: ToolCallContext, parameters: z.infer<CallFromGptSchema>): Promise<ToolCallResult>;
 }
 //# sourceMappingURL=Tool.d.ts.map

package/dist/tools/Tool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Tool.d.ts","sourceRoot":"","sources":["../../src/tools/Tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAI1D,4DAA4D;AAC5D,8BAAsB,IAAI,CAAC,gBAAgB,EAAE,aAAa;IACxD;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B,qFAAqF;IACrF,SAAgB,WAAW,EAAE,MAAM,CAAC;IAEpC,4EAA4E;IAC5E,SAAgB,WAAW,EAAE,WAAW,CAAC;IAEzC;;;QAGI;IACJ,SAAgB,iBAAiB,EAAE,WAAW,CAAC;IAE/C;;;OAGG;IACH,SAAgB,mBAAmB,EAAE,MAAM,CAAC;IAE5C,6DAA6D;IAC7D,SAAgB,WAAW,EAAE,OAAO,CAAC;IAErC,SAAS,aACP,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,iCAAiC,EAAE,MAAM,EACzC,8BAA8B,EAAE,MAAM,EACtC,WAAW,UAAQ;IAcrB;;OAEG;aACa,IAAI,CAClB,QAAQ,EAAE,eAAe,EACzB,WAAW,EAAE,gBAAgB,GAC5B,OAAO,CAAC,cAAc,CAAC;IAE1B;;OAEG;aACa,WAAW,CACzB,QAAQ,EAAE,eAAe,EACzB,WAAW,EAAE,aAAa,GACzB,OAAO,CAAC,cAAc,CAAC;CAC3B"}
+{"version":3,"file":"Tool.d.ts","sourceRoot":"","sources":["../../src/tools/Tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,4DAA4D;AAC5D,8BAAsB,IAAI,CACxB,UAAU,SAAS,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,EACnC,iBAAiB,SAAS,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC;aAcxB,IAAI,EAAE,MAAM;aACZ,WAAW,EAAE,MAAM;aACnB,WAAW,EAAE,UAAU;aACvB,iBAAiB,EAAE,iBAAiB;aACpC,WAAW,EAAE,OAAO;aACpB,mBAAmB,EAAE,MAAM;IAjB7C;;;;;;;;;;OAUG;IACH,SAAS,aACS,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,WAAW,EAAE,UAAU,EACvB,iBAAiB,EAAE,iBAAiB,EACpC,WAAW,GAAE,OAAe,EAC5B,mBAAmB,GAAE,MAEpC;IAGH;;OAEG;aACa,IAAI,CAClB,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,GAC9B,OAAO,CAAC,cAAc,CAAC;IAE1B;;OAEG;aACa,WAAW,CACzB,OAAO,EAAE,eAAe,EACxB,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC,GACrC,OAAO,CAAC,cAAc,CAAC;CAC3B"}

package/dist/tools/Tool.js

@@ -2,16 +2,26 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Tool = void 0;
 const VerbConverter_1 = require("../utils/VerbConverter");
-const JsonUtils_1 = require("../utils/JsonUtils");
 /** Represents a tool call to be invoked by a DonobuFlow. */
 class Tool {
-    constructor(name, description, parametersTypeNameForNonGptSchema, parametersTypeNameForGptSchema, requiresGpt = false) {
+    /**
+     * @param name This is the name for the tool that will be shared with the LLM when making requests.
+     * @param description This is the description that will be shared with the LLM when making requests.
+     * @param inputSchema This is the JSON-schema for the tool when it is invoked by a non-LLM.
+     * @param inputSchemaForGpt This is the JSON-schema that will be shared with the LLM when making
+     *                          requests during autonomous flows.
+     * @param requiresGpt Set to true if this tool requires the usage of a GPT.
+     * @param controlPanelMessage This is the message that will be displayed in the front-end control
+     *                            panel when this tool is invoked, assuming the control panel is enabled.
+     *                            If not provided, it will be automatically generated from the name.
+     */
+    constructor(name, description, inputSchema, inputSchemaForGpt, requiresGpt = false, controlPanelMessage = VerbConverter_1.VerbConverter.toPresentTenseAction(name)) {
         this.name = name;
         this.description = description;
-        this.inputSchema = JsonUtils_1.JsonUtils.getJsonSchemaFromTypeName(parametersTypeNameForNonGptSchema);
-        this.inputSchemaForGpt = JsonUtils_1.JsonUtils.getJsonSchemaFromTypeName(parametersTypeNameForGptSchema);
+        this.inputSchema = inputSchema;
+        this.inputSchemaForGpt = inputSchemaForGpt;
         this.requiresGpt = requiresGpt;
-        this.controlPanelMessage = VerbConverter_1.VerbConverter.toPresentTenseAction(this.name);
+        this.controlPanelMessage = controlPanelMessage;
     }
 }
 exports.Tool = Tool;

package/dist/tools/Tool.js.map

@@ -1 +1 @@
-{"version":3,"file":"Tool.js","sourceRoot":"","sources":["../../src/tools/Tool.ts"],"names":[],"mappings":";;;AAGA,0DAAuD;AACvD,kDAA+C;AAE/C,4DAA4D;AAC5D,MAAsB,IAAI;IA2BxB,YACE,IAAY,EACZ,WAAmB,EACnB,iCAAyC,EACzC,8BAAsC,EACtC,WAAW,GAAG,KAAK;QAEnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,WAAW,GAAG,qBAAS,CAAC,yBAAyB,CACpD,iCAAiC,CACjC,CAAC;QACH,IAAI,CAAC,iBAAiB,GAAG,qBAAS,CAAC,yBAAyB,CAC1D,8BAA8B,CAC9B,CAAC;QACH,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,mBAAmB,GAAG,6BAAa,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC3E,CAAC;CAiBF;AA7DD,oBA6DC"}
+{"version":3,"file":"Tool.js","sourceRoot":"","sources":["../../src/tools/Tool.ts"],"names":[],"mappings":";;;AAEA,0DAAuD;AAGvD,4DAA4D;AAC5D,MAAsB,IAAI;IAIxB;;;;;;;;;;OAUG;IACH,YACkB,IAAY,EACZ,WAAmB,EACnB,WAAuB,EACvB,iBAAoC,EACpC,cAAuB,KAAK,EAC5B,sBAA8B,6BAAa,CAAC,oBAAoB,CAC9E,IAAI,CACL;QAPe,SAAI,GAAJ,IAAI,CAAQ;QACZ,gBAAW,GAAX,WAAW,CAAQ;QACnB,gBAAW,GAAX,WAAW,CAAY;QACvB,sBAAiB,GAAjB,iBAAiB,CAAmB;QACpC,gBAAW,GAAX,WAAW,CAAiB;QAC5B,wBAAmB,GAAnB,mBAAmB,CAElC;IACA,CAAC;CAiBL;AAzCD,oBAyCC"}