beeai-framework 0.1.2

package/dist/tools/database/sql.d.cts

@@ -0,0 +1,71 @@
+import { JSONToolOutput, Tool, ToolEmitter, ToolInput, BaseToolOptions, BaseToolRunOptions } from '../base.cjs';
+import { z } from 'zod';
+import { Sequelize, Options } from 'sequelize';
+import { Provider } from './metadata.cjs';
+import { AnyToolSchemaLike } from '../../internals/helpers/schema.cjs';
+import 'ajv';
+import '../../context.cjs';
+import '../../emitter-BWtGHYn0.cjs';
+import '../../internals/types.cjs';
+import '../../internals/helpers/guards.cjs';
+import '../../internals/serializable.cjs';
+import '../../internals/helpers/promise.cjs';
+import '../../errors.cjs';
+import 'promise-based-task';
+import '../../cache/base.cjs';
+import 'zod-to-json-schema';
+
+/**
+ * Copyright 2025 IBM Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+interface ToolOptions extends BaseToolOptions {
+    provider: Provider;
+    connection: Options;
+}
+type ToolRunOptions = BaseToolRunOptions;
+declare const SQLToolAction: {
+    readonly GetMetadata: "GET_METADATA";
+    readonly Query: "QUERY";
+};
+declare class SQLToolOutput extends JSONToolOutput<any> {
+}
+declare class SQLTool extends Tool<SQLToolOutput, ToolOptions, ToolRunOptions> {
+    name: string;
+    description: string;
+    inputSchema(): z.ZodObject<{
+        action: z.ZodNativeEnum<{
+            readonly GetMetadata: "GET_METADATA";
+            readonly Query: "QUERY";
+        }>;
+        query: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        action: "GET_METADATA" | "QUERY";
+        query?: string | undefined;
+    }, {
+        action: "GET_METADATA" | "QUERY";
+        query?: string | undefined;
+    }>;
+    readonly emitter: ToolEmitter<ToolInput<this>, SQLToolOutput>;
+    constructor(options: ToolOptions);
+    protected validateInput(schema: AnyToolSchemaLike, input: unknown): asserts input is ToolInput<this>;
+    protected connection(): Promise<Sequelize>;
+    protected _run(input: ToolInput<this>, _options: Partial<ToolRunOptions>): Promise<SQLToolOutput>;
+    protected executeQuery(query: string, provider: Provider, schema: string | undefined): Promise<SQLToolOutput>;
+    private isReadOnlyQuery;
+    destroy(): Promise<void>;
+}
+
+export { SQLTool, SQLToolAction, SQLToolOutput };

package/dist/tools/database/sql.d.ts

@@ -0,0 +1,71 @@
+import { JSONToolOutput, Tool, ToolEmitter, ToolInput, BaseToolOptions, BaseToolRunOptions } from '../base.js';
+import { z } from 'zod';
+import { Sequelize, Options } from 'sequelize';
+import { Provider } from './metadata.js';
+import { AnyToolSchemaLike } from '../../internals/helpers/schema.js';
+import 'ajv';
+import '../../context.js';
+import '../../emitter-l0W9gC1A.js';
+import '../../internals/types.js';
+import '../../internals/helpers/guards.js';
+import '../../internals/serializable.js';
+import '../../internals/helpers/promise.js';
+import '../../errors.js';
+import 'promise-based-task';
+import '../../cache/base.js';
+import 'zod-to-json-schema';
+
+/**
+ * Copyright 2025 IBM Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+interface ToolOptions extends BaseToolOptions {
+    provider: Provider;
+    connection: Options;
+}
+type ToolRunOptions = BaseToolRunOptions;
+declare const SQLToolAction: {
+    readonly GetMetadata: "GET_METADATA";
+    readonly Query: "QUERY";
+};
+declare class SQLToolOutput extends JSONToolOutput<any> {
+}
+declare class SQLTool extends Tool<SQLToolOutput, ToolOptions, ToolRunOptions> {
+    name: string;
+    description: string;
+    inputSchema(): z.ZodObject<{
+        action: z.ZodNativeEnum<{
+            readonly GetMetadata: "GET_METADATA";
+            readonly Query: "QUERY";
+        }>;
+        query: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        action: "GET_METADATA" | "QUERY";
+        query?: string | undefined;
+    }, {
+        action: "GET_METADATA" | "QUERY";
+        query?: string | undefined;
+    }>;
+    readonly emitter: ToolEmitter<ToolInput<this>, SQLToolOutput>;
+    constructor(options: ToolOptions);
+    protected validateInput(schema: AnyToolSchemaLike, input: unknown): asserts input is ToolInput<this>;
+    protected connection(): Promise<Sequelize>;
+    protected _run(input: ToolInput<this>, _options: Partial<ToolRunOptions>): Promise<SQLToolOutput>;
+    protected executeQuery(query: string, provider: Provider, schema: string | undefined): Promise<SQLToolOutput>;
+    private isReadOnlyQuery;
+    destroy(): Promise<void>;
+}
+
+export { SQLTool, SQLToolAction, SQLToolOutput };

package/dist/tools/database/sql.js

@@ -0,0 +1,170 @@
+import { JSONToolOutput, Tool, ToolInputValidationError, ToolError } from '../base.js';
+import { z } from 'zod';
+import { Sequelize } from 'sequelize';
+import { getMetadata } from './metadata.js';
+import { Cache } from '../../cache/decoratorCache.js';
+import { ValidationError } from 'ajv';
+import { Emitter } from '../../emitter/emitter.js';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+function _ts_decorate(decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+__name(_ts_decorate, "_ts_decorate");
+function _ts_metadata(k, v) {
+  if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+__name(_ts_metadata, "_ts_metadata");
+const SQLToolAction = {
+  GetMetadata: "GET_METADATA",
+  Query: "QUERY"
+};
+class SQLToolOutput extends JSONToolOutput {
+  static {
+    __name(this, "SQLToolOutput");
+  }
+}
+class SQLTool extends Tool {
+  static {
+    __name(this, "SQLTool");
+  }
+  name = "SQLTool";
+  description = `Converts natural language to SQL query and executes it. IMPORTANT: strictly follow this order of actions:
+   1. ${SQLToolAction.GetMetadata} - get database tables structure (metadata)
+   2. ${SQLToolAction.Query} - execute the generated SQL query`;
+  inputSchema() {
+    return z.object({
+      action: z.nativeEnum(SQLToolAction).describe(`The action to perform. ${SQLToolAction.GetMetadata} get database tables structure, ${SQLToolAction.Query} execute the SQL query`),
+      query: z.string().optional().describe(`The SQL query to be executed, required for ${SQLToolAction.Query} action`)
+    });
+  }
+  emitter = Emitter.root.child({
+    namespace: [
+      "tool",
+      "database",
+      "sql"
+    ],
+    creator: this
+  });
+  constructor(options) {
+    super(options);
+    if (!options.connection.dialect) {
+      throw new ValidationError([
+        {
+          message: "Property is required",
+          propertyName: "connection.dialect"
+        }
+      ]);
+    }
+    if (!options.connection.schema && (options.provider === "oracle" || options.provider === "db2")) {
+      throw new ValidationError([
+        {
+          message: `Property is required for ${options.provider}`,
+          propertyName: "connection.schema"
+        }
+      ]);
+    }
+    if (!options.connection.storage && options.provider === "sqlite") {
+      throw new ValidationError([
+        {
+          message: `Property is required for ${options.provider}`,
+          propertyName: "connection.storage"
+        }
+      ]);
+    }
+  }
+  validateInput(schema, input) {
+    super.validateInput(schema, input);
+    if (input.action === SQLToolAction.Query && !input.query) {
+      throw new ToolInputValidationError(`SQL Query is required for ${SQLToolAction.Query} action.`);
+    }
+  }
+  static {
+    this.register();
+  }
+  async connection() {
+    try {
+      const sequelize = new Sequelize(this.options.connection);
+      await sequelize.authenticate();
+      return sequelize;
+    } catch (error) {
+      throw new ToolError(`Unable to connect to database: ${error}`, [], {
+        isRetryable: false,
+        isFatal: true
+      });
+    }
+  }
+  async _run(input, _options) {
+    const { provider, connection } = this.options;
+    const { schema } = connection;
+    if (input.action === SQLToolAction.GetMetadata) {
+      const sequelize = await this.connection();
+      const metadata = await getMetadata(sequelize, provider, schema);
+      return new SQLToolOutput(metadata);
+    }
+    if (input.action === SQLToolAction.Query) {
+      return await this.executeQuery(input.query, provider, schema);
+    }
+    throw new ToolError(`Invalid action specified: ${input.action}`);
+  }
+  async executeQuery(query, provider, schema) {
+    if (!this.isReadOnlyQuery(query)) {
+      return new JSONToolOutput({
+        success: false,
+        error: "Invalid query. Only SELECT queries are allowed."
+      });
+    }
+    try {
+      const sequelize = await this.connection();
+      const [results] = await sequelize.query(query);
+      if (Array.isArray(results) && results.length > 0) {
+        return new JSONToolOutput({
+          success: true,
+          results
+        });
+      }
+      return new JSONToolOutput({
+        success: false,
+        message: `No rows selected`
+      });
+    } catch (error) {
+      const schemaHint = schema ? `Fully qualify the table names by appending the schema name "${schema}" as a prefix, for example: ${schema}.table_name` : "";
+      const errorMessage = `Generate a correct query that retrieves data using the appropriate ${provider} dialect.
+      ${schemaHint}
+      The original request was: ${query}, and the error was: ${error.message}.`;
+      throw new ToolError(errorMessage);
+    }
+  }
+  isReadOnlyQuery(query) {
+    const normalizedQuery = query.trim().toUpperCase();
+    return normalizedQuery.startsWith("SELECT") || normalizedQuery.startsWith("SHOW") || normalizedQuery.startsWith("DESC");
+  }
+  async destroy() {
+    const cache = Cache.getInstance(this, "connection");
+    const entry = cache.get();
+    if (entry) {
+      cache.clear();
+      try {
+        await entry.data.close();
+      } catch (error) {
+        throw new ToolError(`Failed to close the database connection`, [
+          error
+        ]);
+      }
+    }
+  }
+}
+_ts_decorate([
+  Cache(),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", []),
+  _ts_metadata("design:returntype", Promise)
+], SQLTool.prototype, "connection", null);
+
+export { SQLTool, SQLToolAction, SQLToolOutput };
+//# sourceMappingURL=sql.js.map
+//# sourceMappingURL=sql.js.map

package/dist/tools/database/sql.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/tools/database/sql.ts"],"names":["SQLToolAction","GetMetadata","Query","SQLToolOutput","JSONToolOutput","SQLTool","Tool","name","description","inputSchema","z","object","action","nativeEnum","describe","query","string","optional","emitter","Emitter","root","child","namespace","creator","options","connection","dialect","ValidationError","message","propertyName","schema","provider","storage","validateInput","input","ToolInputValidationError","register","sequelize","Sequelize","authenticate","error","ToolError","isRetryable","isFatal","_run","_options","metadata","getMetadata","executeQuery","isReadOnlyQuery","success","results","Array","isArray","length","schemaHint","errorMessage","normalizedQuery","trim","toUpperCase","startsWith","destroy","cache","Cache","getInstance","entry","get","clear","data","close"],"mappings":";;;;;;;;;;AAcC,SAAA,YAAA,CAAA,UAAA,EAAA,MAAA,EAAA,GAAA,EAAA,IAAA,EAAA;;;;;;AAAA,MAAA,CAAA,YAAA,EAAA,cAAA,CAAA;;;;;AA2BM,MAAMA,aAAgB,GAAA;EAC3BC,WAAa,EAAA,cAAA;EACbC,KAAO,EAAA;AACT;AAEO,MAAMC,sBAAsBC,cAAAA,CAAAA;EA9CnC;;;AA8CwD;AAEjD,MAAMC,gBAAgBC,IAAAA,CAAAA;EAhD7B;;;EAiDEC,IAAO,GAAA,SAAA;EAEPC,WAAc,GAAA,CAAA;AACRR,MAAAA,EAAAA,aAAAA,CAAcC,WAAW,CAAA;AACzBD,MAAAA,EAAAA,aAAAA,CAAcE,KAAK,CAAA,kCAAA,CAAA;EAEzBO,WAAc,GAAA;AACZ,IAAA,OAAOC,EAAEC,MAAO,CAAA;MACdC,MAAQF,EAAAA,CAAAA,CACLG,UAAWb,CAAAA,aAAAA,CACXc,CAAAA,QAAAA,CACC,CAA0Bd,uBAAAA,EAAAA,aAAAA,CAAcC,WAAW,CAAA,gCAAA,EAAmCD,aAAcE,CAAAA,KAAK,CAAwB,sBAAA,CAAA,CAAA;MAErIa,KAAOL,EAAAA,CAAAA,CACJM,QACAC,CAAAA,QAAAA,GACAH,QAAS,CAAA,CAAA,2CAAA,EAA8Cd,aAAcE,CAAAA,KAAK,CAAS,OAAA,CAAA;KACxF,CAAA;AACF;EAEgBgB,OAAuDC,GAAAA,OAAAA,CAAQC,KAAKC,KAAM,CAAA;IACxFC,SAAW,EAAA;AAAC,MAAA,MAAA;AAAQ,MAAA,UAAA;AAAY,MAAA;;IAChCC,OAAS,EAAA;GACX,CAAA;AAEA,EAAA,WAAA,CAAmBC,OAAsB,EAAA;AACvC,IAAA,KAAA,CAAMA,OAAAA,CAAAA;AACN,IAAI,IAAA,CAACA,OAAQC,CAAAA,UAAAA,CAAWC,OAAS,EAAA;AAC/B,MAAA,MAAM,IAAIC,eAAgB,CAAA;AACxB,QAAA;UACEC,OAAS,EAAA,sBAAA;UACTC,YAAc,EAAA;AAChB;AACD,OAAA,CAAA;AACH;AACA,IACE,IAAA,CAACL,QAAQC,UAAWK,CAAAA,MAAAA,KACnBN,QAAQO,QAAa,KAAA,QAAA,IAAYP,OAAQO,CAAAA,QAAAA,KAAa,KACvD,CAAA,EAAA;AACA,MAAA,MAAM,IAAIJ,eAAgB,CAAA;AACxB,QAAA;UACEC,OAAS,EAAA,CAAA,yBAAA,EAA4BJ,QAAQO,QAAQ,CAAA,CAAA;UACrDF,YAAc,EAAA;AAChB;AACD,OAAA,CAAA;AACH;AACA,IAAA,IAAI,CAACL,OAAQC,CAAAA,UAAAA,CAAWO,OAAWR,IAAAA,OAAAA,CAAQO,aAAa,QAAU,EAAA;AAChE,MAAA,MAAM,IAAIJ,eAAgB,CAAA;AACxB,QAAA;UACEC,OAAS,EAAA,CAAA,yBAAA,EAA4BJ,QAAQO,QAAQ,CAAA,CAAA;UACrDF,YAAc,EAAA;AAChB;AACD,OAAA,CAAA;AACH;AACF;AAEUI,EAAAA,aAAAA,CACRH,QACAI,KACkC,EAAA;AAClC,IAAMD,KAAAA,CAAAA,aAAAA,CAAcH,QAAQI,KAAAA,CAAAA;AAC5B,IAAA,IAAIA,MAAMtB,MAAWZ,KAAAA,aAAAA,CAAcE,KAAS,IAAA,CAACgC,MAAMnB,KAAO,EAAA;AACxD,MAAA,MAAM,IAAIoB,wBAAAA,CACR,CAA6BnC,0BAAAA,EAAAA,aAAAA,CAAcE,KAAK,CAAU,QAAA,CAAA,CAAA;AAE9D;AACF;EAEA;AACE,IAAA,IAAA,CAAKkC,QAAQ,EAAA;AACf;AAEA,EAAA,MACgBX,UAAiC,GAAA;AAC/C,IAAI,IAAA;AACF,MAAA,MAAMY,SAAY,GAAA,IAAIC,SAAU,CAAA,IAAA,CAAKd,QAAQC,UAAU,CAAA;AAEvD,MAAA,MAAMY,UAAUE,YAAY,EAAA;AAC5B,MAAOF,OAAAA,SAAAA;AACT,KAAA,CAAA,OAASG,KAAO,EAAA;AACd,MAAA,MAAM,IAAIC,SAAU,CAAA,CAAA,+BAAA,EAAkCD,KAAAA,CAAAA,CAAAA,EAAS,EAAI,EAAA;QACjEE,WAAa,EAAA,KAAA;QACbC,OAAS,EAAA;OACX,CAAA;AACF;AACF;EAEA,MAAgBC,IAAAA,CACdV,OACAW,QACwB,EAAA;AACxB,IAAA,MAAM,EAAEd,QAAAA,EAAUN,UAAU,EAAA,GAAK,IAAKD,CAAAA,OAAAA;AACtC,IAAM,MAAA,EAAEM,QAAWL,GAAAA,UAAAA;AAEnB,IAAIS,IAAAA,KAAAA,CAAMtB,MAAWZ,KAAAA,aAAAA,CAAcC,WAAa,EAAA;AAC9C,MAAMoC,MAAAA,SAAAA,GAAY,MAAM,IAAA,CAAKZ,UAAU,EAAA;AACvC,MAAA,MAAMqB,QAAW,GAAA,MAAMC,WAAYV,CAAAA,SAAAA,EAAWN,UAAUD,MAAAA,CAAAA;AACxD,MAAO,OAAA,IAAI3B,cAAc2C,QAAAA,CAAAA;AAC3B;AAEA,IAAIZ,IAAAA,KAAAA,CAAMtB,MAAWZ,KAAAA,aAAAA,CAAcE,KAAO,EAAA;AACxC,MAAA,OAAO,MAAM,IAAK8C,CAAAA,YAAAA,CAAad,KAAMnB,CAAAA,KAAAA,EAAQgB,UAAUD,MAAAA,CAAAA;AACzD;AAEA,IAAA,MAAM,IAAIW,SAAAA,CAAU,CAA6BP,0BAAAA,EAAAA,KAAAA,CAAMtB,MAAM,CAAE,CAAA,CAAA;AACjE;EAEA,MAAgBoC,YAAAA,CACdjC,KACAgB,EAAAA,QAAAA,EACAD,MACwB,EAAA;AACxB,IAAA,IAAI,CAAC,IAAA,CAAKmB,eAAgBlC,CAAAA,KAAAA,CAAQ,EAAA;AAChC,MAAA,OAAO,IAAIX,cAAe,CAAA;QACxB8C,OAAS,EAAA,KAAA;QACTV,KAAO,EAAA;OACT,CAAA;AACF;AAEA,IAAI,IAAA;AACF,MAAMH,MAAAA,SAAAA,GAAY,MAAM,IAAA,CAAKZ,UAAU,EAAA;AACvC,MAAA,MAAM,CAAC0B,OAAAA,CAAAA,GAAW,MAAMd,SAAAA,CAAUtB,MAAMA,KAAAA,CAAAA;AACxC,MAAA,IAAIqC,MAAMC,OAAQF,CAAAA,OAAAA,CAAYA,IAAAA,OAAAA,CAAQG,SAAS,CAAG,EAAA;AAChD,QAAA,OAAO,IAAIlD,cAAe,CAAA;UAAE8C,OAAS,EAAA,IAAA;AAAMC,UAAAA;SAAQ,CAAA;AACrD;AAEA,MAAA,OAAO,IAAI/C,cAAe,CAAA;QACxB8C,OAAS,EAAA,KAAA;QACTtB,OAAS,EAAA,CAAA,gBAAA;OACX,CAAA;AACF,KAAA,CAAA,OAASY,KAAO,EAAA;AACd,MAAA,MAAMe,aAAazB,MACf,GAAA,CAAA,4DAAA,EAA+DA,MAAAA,CAAAA,4BAAAA,EAAqCA,MAAAA,CACpG,WAAA,CAAA,GAAA,EAAA;AACJ,MAAM0B,MAAAA,YAAAA,GAAe,sEAAsEzB,QAAAA,CAAAA;QACzFwB,UAAAA;kCAC0BxC,KAAAA,CAAAA,qBAAAA,EAA6ByB,MAAMZ,OAAO,CAAA,CAAA,CAAA;AACtE,MAAM,MAAA,IAAIa,UAAUe,YAAAA,CAAAA;AACtB;AACF;AAEQP,EAAAA,eAAAA,CAAgBlC,KAAwB,EAAA;AAC9C,IAAA,MAAM0C,eAAkB1C,GAAAA,KAAAA,CAAM2C,IAAI,EAAA,CAAGC,WAAW,EAAA;AAChD,IACEF,OAAAA,eAAAA,CAAgBG,UAAW,CAAA,QAAA,CAC3BH,IAAAA,eAAAA,CAAgBG,WAAW,MAAA,CAAA,IAC3BH,eAAgBG,CAAAA,UAAAA,CAAW,MAAA,CAAA;AAE/B;AAEA,EAAA,MAAaC,OAAyB,GAAA;AAEpC,IAAA,MAAMC,KAAQC,GAAAA,KAAAA,CAAMC,WAAY,CAAA,IAAA,EAAM,YAAA,CAAA;AACtC,IAAMC,MAAAA,KAAAA,GAAQH,MAAMI,GAAG,EAAA;AAEvB,IAAA,IAAID,KAAO,EAAA;AACTH,MAAAA,KAAAA,CAAMK,KAAK,EAAA;AAEX,MAAI,IAAA;AACF,QAAMF,MAAAA,KAAAA,CAAMG,KAAKC,KAAK,EAAA;AACxB,OAAA,CAAA,OAAS7B,KAAO,EAAA;AACd,QAAM,MAAA,IAAIC,UAAU,CAA2C,uCAAA,CAAA,EAAA;AAACD,UAAAA;AAAM,SAAA,CAAA;AACxE;AACF;AACF;AACF","file":"sql.js","sourcesContent":["/**\n * Copyright 2025 IBM Corp.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  Tool,\n  ToolInput,\n  ToolError,\n  BaseToolOptions,\n  BaseToolRunOptions,\n  JSONToolOutput,\n  ToolInputValidationError,\n  ToolEmitter,\n} from \"@/tools/base.js\";\nimport { z } from \"zod\";\nimport { Sequelize, Options } from \"sequelize\";\nimport { Provider, getMetadata } from \"@/tools/database/metadata.js\";\nimport { Cache } from \"@/cache/decoratorCache.js\";\nimport { ValidationError } from \"ajv\";\nimport { AnyToolSchemaLike } from \"@/internals/helpers/schema.js\";\nimport { Emitter } from \"@/emitter/emitter.js\";\n\ninterface ToolOptions extends BaseToolOptions {\n  provider: Provider;\n  connection: Options;\n}\n\ntype ToolRunOptions = BaseToolRunOptions;\n\nexport const SQLToolAction = {\n  GetMetadata: \"GET_METADATA\",\n  Query: \"QUERY\",\n} as const;\n\nexport class SQLToolOutput extends JSONToolOutput<any> {}\n\nexport class SQLTool extends Tool<SQLToolOutput, ToolOptions, ToolRunOptions> {\n  name = \"SQLTool\";\n\n  description = `Converts natural language to SQL query and executes it. IMPORTANT: strictly follow this order of actions:\n   1. ${SQLToolAction.GetMetadata} - get database tables structure (metadata)\n   2. ${SQLToolAction.Query} - execute the generated SQL query`;\n\n  inputSchema() {\n    return z.object({\n      action: z\n        .nativeEnum(SQLToolAction)\n        .describe(\n          `The action to perform. ${SQLToolAction.GetMetadata} get database tables structure, ${SQLToolAction.Query} execute the SQL query`,\n        ),\n      query: z\n        .string()\n        .optional()\n        .describe(`The SQL query to be executed, required for ${SQLToolAction.Query} action`),\n    });\n  }\n\n  public readonly emitter: ToolEmitter<ToolInput<this>, SQLToolOutput> = Emitter.root.child({\n    namespace: [\"tool\", \"database\", \"sql\"],\n    creator: this,\n  });\n\n  public constructor(options: ToolOptions) {\n    super(options);\n    if (!options.connection.dialect) {\n      throw new ValidationError([\n        {\n          message: \"Property is required\",\n          propertyName: \"connection.dialect\",\n        },\n      ]);\n    }\n    if (\n      !options.connection.schema &&\n      (options.provider === \"oracle\" || options.provider === \"db2\")\n    ) {\n      throw new ValidationError([\n        {\n          message: `Property is required for ${options.provider}`,\n          propertyName: \"connection.schema\",\n        },\n      ]);\n    }\n    if (!options.connection.storage && options.provider === \"sqlite\") {\n      throw new ValidationError([\n        {\n          message: `Property is required for ${options.provider}`,\n          propertyName: \"connection.storage\",\n        },\n      ]);\n    }\n  }\n\n  protected validateInput(\n    schema: AnyToolSchemaLike,\n    input: unknown,\n  ): asserts input is ToolInput<this> {\n    super.validateInput(schema, input);\n    if (input.action === SQLToolAction.Query && !input.query) {\n      throw new ToolInputValidationError(\n        `SQL Query is required for ${SQLToolAction.Query} action.`,\n      );\n    }\n  }\n\n  static {\n    this.register();\n  }\n\n  @Cache()\n  protected async connection(): Promise<Sequelize> {\n    try {\n      const sequelize = new Sequelize(this.options.connection);\n\n      await sequelize.authenticate();\n      return sequelize;\n    } catch (error) {\n      throw new ToolError(`Unable to connect to database: ${error}`, [], {\n        isRetryable: false,\n        isFatal: true,\n      });\n    }\n  }\n\n  protected async _run(\n    input: ToolInput<this>,\n    _options: Partial<ToolRunOptions>,\n  ): Promise<SQLToolOutput> {\n    const { provider, connection } = this.options;\n    const { schema } = connection;\n\n    if (input.action === SQLToolAction.GetMetadata) {\n      const sequelize = await this.connection();\n      const metadata = await getMetadata(sequelize, provider, schema);\n      return new SQLToolOutput(metadata);\n    }\n\n    if (input.action === SQLToolAction.Query) {\n      return await this.executeQuery(input.query!, provider, schema);\n    }\n\n    throw new ToolError(`Invalid action specified: ${input.action}`);\n  }\n\n  protected async executeQuery(\n    query: string,\n    provider: Provider,\n    schema: string | undefined,\n  ): Promise<SQLToolOutput> {\n    if (!this.isReadOnlyQuery(query)) {\n      return new JSONToolOutput({\n        success: false,\n        error: \"Invalid query. Only SELECT queries are allowed.\",\n      });\n    }\n\n    try {\n      const sequelize = await this.connection();\n      const [results] = await sequelize.query(query);\n      if (Array.isArray(results) && results.length > 0) {\n        return new JSONToolOutput({ success: true, results });\n      }\n\n      return new JSONToolOutput({\n        success: false,\n        message: `No rows selected`,\n      });\n    } catch (error) {\n      const schemaHint = schema\n        ? `Fully qualify the table names by appending the schema name \"${schema}\" as a prefix, for example: ${schema}.table_name`\n        : \"\";\n      const errorMessage = `Generate a correct query that retrieves data using the appropriate ${provider} dialect.\n      ${schemaHint}\n      The original request was: ${query}, and the error was: ${error.message}.`;\n      throw new ToolError(errorMessage);\n    }\n  }\n\n  private isReadOnlyQuery(query: string): boolean {\n    const normalizedQuery = query.trim().toUpperCase();\n    return (\n      normalizedQuery.startsWith(\"SELECT\") ||\n      normalizedQuery.startsWith(\"SHOW\") ||\n      normalizedQuery.startsWith(\"DESC\")\n    );\n  }\n\n  public async destroy(): Promise<void> {\n    // @ts-expect-error protected property\n    const cache = Cache.getInstance(this, \"connection\");\n    const entry = cache.get();\n\n    if (entry) {\n      cache.clear();\n\n      try {\n        await entry.data.close();\n      } catch (error) {\n        throw new ToolError(`Failed to close the database connection`, [error]);\n      }\n    }\n  }\n}\n"]}

package/dist/tools/llm.cjs

@@ -0,0 +1,74 @@
+'use strict';
+
+var base_cjs = require('./base.cjs');
+var zod = require('zod');
+var emitter_cjs = require('../emitter/emitter.cjs');
+var template_cjs = require('../template.cjs');
+var object_cjs = require('../internals/helpers/object.cjs');
+var remeda = require('remeda');
+var message_cjs = require('../backend/message.cjs');
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+class LLMTool extends base_cjs.Tool {
+  static {
+    __name(this, "LLMTool");
+  }
+  input;
+  name;
+  description;
+  constructor(input) {
+    super(input), this.input = input, this.name = "LLM", this.description = "Uses expert LLM to work with data in the existing conversation (classification, entity extraction, summarization, ...)";
+    this.name = input?.name || this.name;
+    this.description = input?.description || this.description;
+    this.emitter = emitter_cjs.Emitter.root.child({
+      namespace: [
+        "tool",
+        "llm",
+        remeda.toCamelCase(input?.name ?? "")
+      ].filter(Boolean),
+      creator: this
+    });
+  }
+  inputSchema() {
+    return zod.z.object({
+      task: zod.z.string().min(1).describe("A clearly defined task for the LLM to complete.")
+    });
+  }
+  static template = new template_cjs.PromptTemplate({
+    schema: zod.z.object({
+      task: zod.z.string()
+    }),
+    template: `You have to accomplish a task by using Using common sense and the information contained in the conversation up to this point, complete the following task. Do not follow any previously used formats or structures.
+
+The Task: {{task}}`
+  });
+  async _run(input, _options, run) {
+    const memory = object_cjs.getProp(run.context, [
+      base_cjs.Tool.contextKeys.Memory
+    ]);
+    if (!memory) {
+      throw new base_cjs.ToolError(`No context has been provided!`, [], {
+        isFatal: true,
+        isRetryable: false
+      });
+    }
+    const template = this.options?.template ?? LLMTool.template;
+    const output = await this.input.llm.create({
+      messages: [
+        new message_cjs.SystemMessage(template.render({
+          task: input.task
+        })),
+        ...memory.messages.filter((msg) => msg.role !== message_cjs.Role.SYSTEM),
+        new message_cjs.UserMessage(template.render({
+          task: input.task
+        }))
+      ]
+    });
+    return new base_cjs.StringToolOutput(output.getTextContent());
+  }
+}
+
+exports.LLMTool = LLMTool;
+//# sourceMappingURL=llm.cjs.map
+//# sourceMappingURL=llm.cjs.map

package/dist/tools/llm.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/tools/llm.ts"],"names":["LLMTool","Tool","name","description","constructor","input","emitter","Emitter","root","child","namespace","toCamelCase","filter","Boolean","creator","inputSchema","z","object","task","string","min","describe","template","PromptTemplate","schema","_run","_options","run","memory","getProp","context","contextKeys","Memory","ToolError","isFatal","isRetryable","options","output","llm","create","messages","SystemMessage","render","msg","role","Role","SYSTEM","UserMessage","StringToolOutput","getTextContent"],"mappings":";;;;;;;;;;;;AA0CO,MAAMA,gBAAgBC,aAAAA,CAAAA;EA1C7B;;;;AA2CEC,EAAAA,IAAAA;AACAC,EAAAA,WAAAA;AAIAC,EAAAA,WAAAA,CAA+BC,KAAqB,EAAA;AAClD,IAAMA,KAAAA,CAAAA,KAAAA,GAAAA,IADuBA,CAAAA,KAAAA,GAAAA,OAAAA,IAL/BH,CAAAA,IAAAA,GAAO,KAAA,EAAA,IAAA,CACPC,WACE,GAAA,wHAAA;AAKA,IAAKD,IAAAA,CAAAA,IAAAA,GAAOG,KAAOH,EAAAA,IAAAA,IAAQ,IAAKA,CAAAA,IAAAA;AAChC,IAAKC,IAAAA,CAAAA,WAAAA,GAAcE,KAAOF,EAAAA,WAAAA,IAAe,IAAKA,CAAAA,WAAAA;AAC9C,IAAKG,IAAAA,CAAAA,OAAAA,GAAUC,mBAAQC,CAAAA,IAAAA,CAAKC,KAAM,CAAA;MAChCC,SAAW,EAAA;AAAC,QAAA,MAAA;AAAQ,QAAA,KAAA;QAAOC,kBAAYN,CAAAA,KAAAA,EAAOH,QAAQ,EAAA;AAAKU,OAAAA,CAAAA,MAAAA,CAAOC,OAAAA,CAAAA;MAClEC,OAAS,EAAA;KACX,CAAA;AACF;EAEAC,WAAc,GAAA;AACZ,IAAA,OAAOC,MAAEC,MAAO,CAAA;AACdC,MAAAA,IAAAA,EAAMF,MAAEG,MAAM,EAAA,CAAGC,IAAI,CAAA,CAAA,CAAGC,SAAS,iDAAA;KACnC,CAAA;AACF;EAEA,OAAgBC,QAAAA,GAAW,IAAIC,2BAAe,CAAA;AAC5CC,IAAAA,MAAAA,EAAQR,MAAEC,MAAO,CAAA;AACfC,MAAAA,IAAAA,EAAMF,MAAEG,MAAM;KAChB,CAAA;IACAG,QAAU,EAAA,CAAA;;;GAGZ,CAAA;EAEA,MAAgBG,IAAAA,CACdpB,KACAqB,EAAAA,QAAAA,EACAC,GACA,EAAA;AACA,IAAMC,MAAAA,MAAAA,GAASC,kBAAQF,CAAAA,GAAAA,CAAIG,OAAS,EAAA;AAAC7B,MAAAA,aAAAA,CAAK8B,WAAYC,CAAAA;AAAO,KAAA,CAAA;AAC7D,IAAA,IAAI,CAACJ,MAAQ,EAAA;AACX,MAAA,MAAM,IAAIK,kBAAAA,CAAU,CAAiC,6BAAA,CAAA,EAAA,EAAI,EAAA;QACvDC,OAAS,EAAA,IAAA;QACTC,WAAa,EAAA;OACf,CAAA;AACF;AAEA,IAAA,MAAMb,QAAW,GAAA,IAAA,CAAKc,OAASd,EAAAA,QAAAA,IAAYtB,OAAQsB,CAAAA,QAAAA;AACnD,IAAA,MAAMe,MAAS,GAAA,MAAM,IAAKhC,CAAAA,KAAAA,CAAMiC,IAAIC,MAAO,CAAA;MACzCC,QAAU,EAAA;QACR,IAAIC,yBAAAA,CACFnB,SAASoB,MAAO,CAAA;AACdxB,UAAAA,IAAAA,EAAMb,KAAMa,CAAAA;AACd,SAAA,CAAA,CAAA;AAECU,QAAAA,GAAAA,MAAAA,CAAOY,SAAS5B,MAAO,CAAA,CAAC+B,QAAQA,GAAIC,CAAAA,IAAAA,KAASC,iBAAKC,MAAM,CAAA;QAC3D,IAAIC,uBAAAA,CACFzB,SAASoB,MAAO,CAAA;AACdxB,UAAAA,IAAAA,EAAMb,KAAMa,CAAAA;AACd,SAAA,CAAA;;KAGN,CAAA;AAEA,IAAA,OAAO,IAAI8B,yBAAAA,CAAiBX,MAAOY,CAAAA,cAAAA,EAAc,CAAA;AACnD;AACF","file":"llm.cjs","sourcesContent":["/**\n * Copyright 2025 IBM Corp.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  BaseToolOptions,\n  BaseToolRunOptions,\n  StringToolOutput,\n  Tool,\n  ToolEmitter,\n  ToolError,\n  ToolInput,\n} from \"@/tools/base.js\";\nimport { z } from \"zod\";\nimport { GetRunContext } from \"@/context.js\";\nimport { Emitter } from \"@/emitter/emitter.js\";\nimport { PromptTemplate } from \"@/template.js\";\nimport { getProp } from \"@/internals/helpers/object.js\";\nimport type { BaseMemory } from \"@/memory/base.js\";\nimport { toCamelCase } from \"remeda\";\nimport { Role, SystemMessage, UserMessage } from \"@/backend/message.js\";\nimport { ChatModel } from \"@/backend/chat.js\";\n\nexport interface LLMToolInput extends BaseToolOptions {\n  llm: ChatModel;\n  name?: string;\n  description?: string;\n  template?: typeof LLMTool.template;\n}\n\nexport class LLMTool extends Tool<StringToolOutput, LLMToolInput> {\n  name = \"LLM\";\n  description =\n    \"Uses expert LLM to work with data in the existing conversation (classification, entity extraction, summarization, ...)\";\n  declare readonly emitter: ToolEmitter<ToolInput<this>, StringToolOutput>;\n\n  constructor(protected readonly input: LLMToolInput) {\n    super(input);\n    this.name = input?.name || this.name;\n    this.description = input?.description || this.description;\n    this.emitter = Emitter.root.child({\n      namespace: [\"tool\", \"llm\", toCamelCase(input?.name ?? \"\")].filter(Boolean),\n      creator: this,\n    });\n  }\n\n  inputSchema() {\n    return z.object({\n      task: z.string().min(1).describe(\"A clearly defined task for the LLM to complete.\"),\n    });\n  }\n\n  static readonly template = new PromptTemplate({\n    schema: z.object({\n      task: z.string(),\n    }),\n    template: `You have to accomplish a task by using Using common sense and the information contained in the conversation up to this point, complete the following task. Do not follow any previously used formats or structures.\n\nThe Task: {{task}}`,\n  });\n\n  protected async _run(\n    input: ToolInput<this>,\n    _options: Partial<BaseToolRunOptions>,\n    run: GetRunContext<this>,\n  ) {\n    const memory = getProp(run.context, [Tool.contextKeys.Memory]) as BaseMemory;\n    if (!memory) {\n      throw new ToolError(`No context has been provided!`, [], {\n        isFatal: true,\n        isRetryable: false,\n      });\n    }\n\n    const template = this.options?.template ?? LLMTool.template;\n    const output = await this.input.llm.create({\n      messages: [\n        new SystemMessage(\n          template.render({\n            task: input.task,\n          }),\n        ),\n        ...memory.messages.filter((msg) => msg.role !== Role.SYSTEM),\n        new UserMessage(\n          template.render({\n            task: input.task,\n          }),\n        ),\n      ],\n    });\n\n    return new StringToolOutput(output.getTextContent());\n  }\n}\n"]}

package/dist/tools/llm.d.cts

@@ -0,0 +1,68 @@
+import { BaseToolOptions, Tool, StringToolOutput, ToolEmitter, ToolInput, BaseToolRunOptions } from './base.cjs';
+import { z } from 'zod';
+import { GetRunContext } from '../context.cjs';
+import { PromptTemplate } from '../template.cjs';
+import { ChatModel } from '../backend/chat.cjs';
+import 'ajv';
+import '../errors.cjs';
+import '../internals/types.cjs';
+import '../internals/helpers/guards.cjs';
+import '../internals/serializable.cjs';
+import 'promise-based-task';
+import '../cache/base.cjs';
+import '../internals/helpers/schema.cjs';
+import 'zod-to-json-schema';
+import '../emitter-BWtGHYn0.cjs';
+import '../internals/helpers/promise.cjs';
+import '../backend/message.cjs';
+import 'ai';
+import '../backend/utils.cjs';
+import '../backend/constants.cjs';
+import '@ai-sdk/provider';
+
+/**
+ * Copyright 2025 IBM Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+interface LLMToolInput extends BaseToolOptions {
+    llm: ChatModel;
+    name?: string;
+    description?: string;
+    template?: typeof LLMTool.template;
+}
+declare class LLMTool extends Tool<StringToolOutput, LLMToolInput> {
+    protected readonly input: LLMToolInput;
+    name: string;
+    description: string;
+    readonly emitter: ToolEmitter<ToolInput<this>, StringToolOutput>;
+    constructor(input: LLMToolInput);
+    inputSchema(): z.ZodObject<{
+        task: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        task: string;
+    }, {
+        task: string;
+    }>;
+    static readonly template: PromptTemplate<z.ZodObject<{
+        task: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        task: string;
+    }, {
+        task: string;
+    }>>;
+    protected _run(input: ToolInput<this>, _options: Partial<BaseToolRunOptions>, run: GetRunContext<this>): Promise<StringToolOutput>;
+}
+
+export { LLMTool, type LLMToolInput };

package/dist/tools/llm.d.ts

@@ -0,0 +1,68 @@
+import { BaseToolOptions, Tool, StringToolOutput, ToolEmitter, ToolInput, BaseToolRunOptions } from './base.js';
+import { z } from 'zod';
+import { GetRunContext } from '../context.js';
+import { PromptTemplate } from '../template.js';
+import { ChatModel } from '../backend/chat.js';
+import 'ajv';
+import '../errors.js';
+import '../internals/types.js';
+import '../internals/helpers/guards.js';
+import '../internals/serializable.js';
+import 'promise-based-task';
+import '../cache/base.js';
+import '../internals/helpers/schema.js';
+import 'zod-to-json-schema';
+import '../emitter-l0W9gC1A.js';
+import '../internals/helpers/promise.js';
+import '../backend/message.js';
+import 'ai';
+import '../backend/utils.js';
+import '../backend/constants.js';
+import '@ai-sdk/provider';
+
+/**
+ * Copyright 2025 IBM Corp.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+interface LLMToolInput extends BaseToolOptions {
+    llm: ChatModel;
+    name?: string;
+    description?: string;
+    template?: typeof LLMTool.template;
+}
+declare class LLMTool extends Tool<StringToolOutput, LLMToolInput> {
+    protected readonly input: LLMToolInput;
+    name: string;
+    description: string;
+    readonly emitter: ToolEmitter<ToolInput<this>, StringToolOutput>;
+    constructor(input: LLMToolInput);
+    inputSchema(): z.ZodObject<{
+        task: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        task: string;
+    }, {
+        task: string;
+    }>;
+    static readonly template: PromptTemplate<z.ZodObject<{
+        task: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        task: string;
+    }, {
+        task: string;
+    }>>;
+    protected _run(input: ToolInput<this>, _options: Partial<BaseToolRunOptions>, run: GetRunContext<this>): Promise<StringToolOutput>;
+}
+
+export { LLMTool, type LLMToolInput };

package/dist/tools/llm.js

@@ -0,0 +1,72 @@
+import { Tool, ToolError, StringToolOutput } from './base.js';
+import { z } from 'zod';
+import { Emitter } from '../emitter/emitter.js';
+import { PromptTemplate } from '../template.js';
+import { getProp } from '../internals/helpers/object.js';
+import { toCamelCase } from 'remeda';
+import { SystemMessage, Role, UserMessage } from '../backend/message.js';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+class LLMTool extends Tool {
+  static {
+    __name(this, "LLMTool");
+  }
+  input;
+  name;
+  description;
+  constructor(input) {
+    super(input), this.input = input, this.name = "LLM", this.description = "Uses expert LLM to work with data in the existing conversation (classification, entity extraction, summarization, ...)";
+    this.name = input?.name || this.name;
+    this.description = input?.description || this.description;
+    this.emitter = Emitter.root.child({
+      namespace: [
+        "tool",
+        "llm",
+        toCamelCase(input?.name ?? "")
+      ].filter(Boolean),
+      creator: this
+    });
+  }
+  inputSchema() {
+    return z.object({
+      task: z.string().min(1).describe("A clearly defined task for the LLM to complete.")
+    });
+  }
+  static template = new PromptTemplate({
+    schema: z.object({
+      task: z.string()
+    }),
+    template: `You have to accomplish a task by using Using common sense and the information contained in the conversation up to this point, complete the following task. Do not follow any previously used formats or structures.
+
+The Task: {{task}}`
+  });
+  async _run(input, _options, run) {
+    const memory = getProp(run.context, [
+      Tool.contextKeys.Memory
+    ]);
+    if (!memory) {
+      throw new ToolError(`No context has been provided!`, [], {
+        isFatal: true,
+        isRetryable: false
+      });
+    }
+    const template = this.options?.template ?? LLMTool.template;
+    const output = await this.input.llm.create({
+      messages: [
+        new SystemMessage(template.render({
+          task: input.task
+        })),
+        ...memory.messages.filter((msg) => msg.role !== Role.SYSTEM),
+        new UserMessage(template.render({
+          task: input.task
+        }))
+      ]
+    });
+    return new StringToolOutput(output.getTextContent());
+  }
+}
+
+export { LLMTool };
+//# sourceMappingURL=llm.js.map
+//# sourceMappingURL=llm.js.map

package/dist/tools/llm.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/tools/llm.ts"],"names":["LLMTool","Tool","name","description","constructor","input","emitter","Emitter","root","child","namespace","toCamelCase","filter","Boolean","creator","inputSchema","z","object","task","string","min","describe","template","PromptTemplate","schema","_run","_options","run","memory","getProp","context","contextKeys","Memory","ToolError","isFatal","isRetryable","options","output","llm","create","messages","SystemMessage","render","msg","role","Role","SYSTEM","UserMessage","StringToolOutput","getTextContent"],"mappings":";;;;;;;;;;AA0CO,MAAMA,gBAAgBC,IAAAA,CAAAA;EA1C7B;;;;AA2CEC,EAAAA,IAAAA;AACAC,EAAAA,WAAAA;AAIAC,EAAAA,WAAAA,CAA+BC,KAAqB,EAAA;AAClD,IAAMA,KAAAA,CAAAA,KAAAA,GAAAA,IADuBA,CAAAA,KAAAA,GAAAA,OAAAA,IAL/BH,CAAAA,IAAAA,GAAO,KAAA,EAAA,IAAA,CACPC,WACE,GAAA,wHAAA;AAKA,IAAKD,IAAAA,CAAAA,IAAAA,GAAOG,KAAOH,EAAAA,IAAAA,IAAQ,IAAKA,CAAAA,IAAAA;AAChC,IAAKC,IAAAA,CAAAA,WAAAA,GAAcE,KAAOF,EAAAA,WAAAA,IAAe,IAAKA,CAAAA,WAAAA;AAC9C,IAAKG,IAAAA,CAAAA,OAAAA,GAAUC,OAAQC,CAAAA,IAAAA,CAAKC,KAAM,CAAA;MAChCC,SAAW,EAAA;AAAC,QAAA,MAAA;AAAQ,QAAA,KAAA;QAAOC,WAAYN,CAAAA,KAAAA,EAAOH,QAAQ,EAAA;AAAKU,OAAAA,CAAAA,MAAAA,CAAOC,OAAAA,CAAAA;MAClEC,OAAS,EAAA;KACX,CAAA;AACF;EAEAC,WAAc,GAAA;AACZ,IAAA,OAAOC,EAAEC,MAAO,CAAA;AACdC,MAAAA,IAAAA,EAAMF,EAAEG,MAAM,EAAA,CAAGC,IAAI,CAAA,CAAA,CAAGC,SAAS,iDAAA;KACnC,CAAA;AACF;EAEA,OAAgBC,QAAAA,GAAW,IAAIC,cAAe,CAAA;AAC5CC,IAAAA,MAAAA,EAAQR,EAAEC,MAAO,CAAA;AACfC,MAAAA,IAAAA,EAAMF,EAAEG,MAAM;KAChB,CAAA;IACAG,QAAU,EAAA,CAAA;;;GAGZ,CAAA;EAEA,MAAgBG,IAAAA,CACdpB,KACAqB,EAAAA,QAAAA,EACAC,GACA,EAAA;AACA,IAAMC,MAAAA,MAAAA,GAASC,OAAQF,CAAAA,GAAAA,CAAIG,OAAS,EAAA;AAAC7B,MAAAA,IAAAA,CAAK8B,WAAYC,CAAAA;AAAO,KAAA,CAAA;AAC7D,IAAA,IAAI,CAACJ,MAAQ,EAAA;AACX,MAAA,MAAM,IAAIK,SAAAA,CAAU,CAAiC,6BAAA,CAAA,EAAA,EAAI,EAAA;QACvDC,OAAS,EAAA,IAAA;QACTC,WAAa,EAAA;OACf,CAAA;AACF;AAEA,IAAA,MAAMb,QAAW,GAAA,IAAA,CAAKc,OAASd,EAAAA,QAAAA,IAAYtB,OAAQsB,CAAAA,QAAAA;AACnD,IAAA,MAAMe,MAAS,GAAA,MAAM,IAAKhC,CAAAA,KAAAA,CAAMiC,IAAIC,MAAO,CAAA;MACzCC,QAAU,EAAA;QACR,IAAIC,aAAAA,CACFnB,SAASoB,MAAO,CAAA;AACdxB,UAAAA,IAAAA,EAAMb,KAAMa,CAAAA;AACd,SAAA,CAAA,CAAA;AAECU,QAAAA,GAAAA,MAAAA,CAAOY,SAAS5B,MAAO,CAAA,CAAC+B,QAAQA,GAAIC,CAAAA,IAAAA,KAASC,KAAKC,MAAM,CAAA;QAC3D,IAAIC,WAAAA,CACFzB,SAASoB,MAAO,CAAA;AACdxB,UAAAA,IAAAA,EAAMb,KAAMa,CAAAA;AACd,SAAA,CAAA;;KAGN,CAAA;AAEA,IAAA,OAAO,IAAI8B,gBAAAA,CAAiBX,MAAOY,CAAAA,cAAAA,EAAc,CAAA;AACnD;AACF","file":"llm.js","sourcesContent":["/**\n * Copyright 2025 IBM Corp.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  BaseToolOptions,\n  BaseToolRunOptions,\n  StringToolOutput,\n  Tool,\n  ToolEmitter,\n  ToolError,\n  ToolInput,\n} from \"@/tools/base.js\";\nimport { z } from \"zod\";\nimport { GetRunContext } from \"@/context.js\";\nimport { Emitter } from \"@/emitter/emitter.js\";\nimport { PromptTemplate } from \"@/template.js\";\nimport { getProp } from \"@/internals/helpers/object.js\";\nimport type { BaseMemory } from \"@/memory/base.js\";\nimport { toCamelCase } from \"remeda\";\nimport { Role, SystemMessage, UserMessage } from \"@/backend/message.js\";\nimport { ChatModel } from \"@/backend/chat.js\";\n\nexport interface LLMToolInput extends BaseToolOptions {\n  llm: ChatModel;\n  name?: string;\n  description?: string;\n  template?: typeof LLMTool.template;\n}\n\nexport class LLMTool extends Tool<StringToolOutput, LLMToolInput> {\n  name = \"LLM\";\n  description =\n    \"Uses expert LLM to work with data in the existing conversation (classification, entity extraction, summarization, ...)\";\n  declare readonly emitter: ToolEmitter<ToolInput<this>, StringToolOutput>;\n\n  constructor(protected readonly input: LLMToolInput) {\n    super(input);\n    this.name = input?.name || this.name;\n    this.description = input?.description || this.description;\n    this.emitter = Emitter.root.child({\n      namespace: [\"tool\", \"llm\", toCamelCase(input?.name ?? \"\")].filter(Boolean),\n      creator: this,\n    });\n  }\n\n  inputSchema() {\n    return z.object({\n      task: z.string().min(1).describe(\"A clearly defined task for the LLM to complete.\"),\n    });\n  }\n\n  static readonly template = new PromptTemplate({\n    schema: z.object({\n      task: z.string(),\n    }),\n    template: `You have to accomplish a task by using Using common sense and the information contained in the conversation up to this point, complete the following task. Do not follow any previously used formats or structures.\n\nThe Task: {{task}}`,\n  });\n\n  protected async _run(\n    input: ToolInput<this>,\n    _options: Partial<BaseToolRunOptions>,\n    run: GetRunContext<this>,\n  ) {\n    const memory = getProp(run.context, [Tool.contextKeys.Memory]) as BaseMemory;\n    if (!memory) {\n      throw new ToolError(`No context has been provided!`, [], {\n        isFatal: true,\n        isRetryable: false,\n      });\n    }\n\n    const template = this.options?.template ?? LLMTool.template;\n    const output = await this.input.llm.create({\n      messages: [\n        new SystemMessage(\n          template.render({\n            task: input.task,\n          }),\n        ),\n        ...memory.messages.filter((msg) => msg.role !== Role.SYSTEM),\n        new UserMessage(\n          template.render({\n            task: input.task,\n          }),\n        ),\n      ],\n    });\n\n    return new StringToolOutput(output.getTextContent());\n  }\n}\n"]}