beeai-framework 0.1.2

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

@@ -0,0 +1,89 @@
+import { BaseToolOptions, Tool, JSONToolOutput, ToolEmitter, ToolInput, BaseToolRunOptions } from '../base.cjs';
+import { AnyToolSchemaLike } from '../../internals/helpers/schema.cjs';
+import { ClientConfig, ShowCollectionsResponse, DescribeCollectionResponse, SearchRes, MilvusClient } from '@zilliz/milvus2-sdk-node';
+import { z } from 'zod';
+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 MilvusToolOptions extends BaseToolOptions {
+    connection: ClientConfig;
+}
+type MilvusSearchToolResult = ShowCollectionsResponse | DescribeCollectionResponse | SearchRes;
+declare enum MilvusAction {
+    ListCollections = "ListCollections",
+    GetCollectionInfo = "GetCollectionInfo",
+    Search = "Search",
+    Insert = "Insert",
+    Delete = "Delete"
+}
+declare class MilvusDatabaseTool extends Tool<JSONToolOutput<MilvusSearchToolResult>, MilvusToolOptions> {
+    name: string;
+    description: string;
+    inputSchema(): z.ZodObject<{
+        action: z.ZodNativeEnum<typeof MilvusAction>;
+        collectionName: z.ZodOptional<z.ZodString>;
+        vector: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
+        vectors: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodNumber, "many">, "many">>;
+        topK: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        filter: z.ZodOptional<z.ZodString>;
+        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        ids: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">>;
+        searchOutput: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        action: MilvusAction;
+        filter?: string | undefined;
+        topK?: number | undefined;
+        metadata?: Record<string, any> | undefined;
+        collectionName?: string | undefined;
+        vector?: number[] | undefined;
+        vectors?: number[][] | undefined;
+        ids?: (string | number)[] | undefined;
+        searchOutput?: string[] | undefined;
+    }, {
+        action: MilvusAction;
+        filter?: string | undefined;
+        topK?: number | undefined;
+        metadata?: Record<string, any> | undefined;
+        collectionName?: string | undefined;
+        vector?: number[] | undefined;
+        vectors?: number[][] | undefined;
+        ids?: (string | number)[] | undefined;
+        searchOutput?: string[] | undefined;
+    }>;
+    readonly emitter: ToolEmitter<ToolInput<this>, JSONToolOutput<MilvusSearchToolResult>>;
+    protected validateInput(schema: AnyToolSchemaLike, input: unknown): asserts input is ToolInput<this>;
+    protected client(): Promise<MilvusClient>;
+    protected _run(input: ToolInput<this>, _options: Partial<BaseToolRunOptions>): Promise<JSONToolOutput<any>>;
+    protected listCollections(): Promise<string[]>;
+    protected getCollectionInfo(collectionName: string): Promise<any>;
+    protected insert(input: ToolInput<this>): Promise<any>;
+    protected search(input: ToolInput<this>): Promise<any>;
+    protected delete(input: ToolInput<this>): Promise<any>;
+}
+
+export { MilvusAction, MilvusDatabaseTool, type MilvusSearchToolResult, type MilvusToolOptions };

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

@@ -0,0 +1,89 @@
+import { BaseToolOptions, Tool, JSONToolOutput, ToolEmitter, ToolInput, BaseToolRunOptions } from '../base.js';
+import { AnyToolSchemaLike } from '../../internals/helpers/schema.js';
+import { ClientConfig, ShowCollectionsResponse, DescribeCollectionResponse, SearchRes, MilvusClient } from '@zilliz/milvus2-sdk-node';
+import { z } from 'zod';
+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 MilvusToolOptions extends BaseToolOptions {
+    connection: ClientConfig;
+}
+type MilvusSearchToolResult = ShowCollectionsResponse | DescribeCollectionResponse | SearchRes;
+declare enum MilvusAction {
+    ListCollections = "ListCollections",
+    GetCollectionInfo = "GetCollectionInfo",
+    Search = "Search",
+    Insert = "Insert",
+    Delete = "Delete"
+}
+declare class MilvusDatabaseTool extends Tool<JSONToolOutput<MilvusSearchToolResult>, MilvusToolOptions> {
+    name: string;
+    description: string;
+    inputSchema(): z.ZodObject<{
+        action: z.ZodNativeEnum<typeof MilvusAction>;
+        collectionName: z.ZodOptional<z.ZodString>;
+        vector: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
+        vectors: z.ZodOptional<z.ZodArray<z.ZodArray<z.ZodNumber, "many">, "many">>;
+        topK: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        filter: z.ZodOptional<z.ZodString>;
+        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        ids: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber]>, "many">>;
+        searchOutput: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        action: MilvusAction;
+        filter?: string | undefined;
+        topK?: number | undefined;
+        metadata?: Record<string, any> | undefined;
+        collectionName?: string | undefined;
+        vector?: number[] | undefined;
+        vectors?: number[][] | undefined;
+        ids?: (string | number)[] | undefined;
+        searchOutput?: string[] | undefined;
+    }, {
+        action: MilvusAction;
+        filter?: string | undefined;
+        topK?: number | undefined;
+        metadata?: Record<string, any> | undefined;
+        collectionName?: string | undefined;
+        vector?: number[] | undefined;
+        vectors?: number[][] | undefined;
+        ids?: (string | number)[] | undefined;
+        searchOutput?: string[] | undefined;
+    }>;
+    readonly emitter: ToolEmitter<ToolInput<this>, JSONToolOutput<MilvusSearchToolResult>>;
+    protected validateInput(schema: AnyToolSchemaLike, input: unknown): asserts input is ToolInput<this>;
+    protected client(): Promise<MilvusClient>;
+    protected _run(input: ToolInput<this>, _options: Partial<BaseToolRunOptions>): Promise<JSONToolOutput<any>>;
+    protected listCollections(): Promise<string[]>;
+    protected getCollectionInfo(collectionName: string): Promise<any>;
+    protected insert(input: ToolInput<this>): Promise<any>;
+    protected search(input: ToolInput<this>): Promise<any>;
+    protected delete(input: ToolInput<this>): Promise<any>;
+}
+
+export { MilvusAction, MilvusDatabaseTool, type MilvusSearchToolResult, type MilvusToolOptions };

package/dist/tools/database/milvus.js

@@ -0,0 +1,188 @@
+import { Tool, ToolInputValidationError, ToolError, JSONToolOutput } from '../base.js';
+import { Cache } from '../../cache/decoratorCache.js';
+import { MilvusClient } from '@zilliz/milvus2-sdk-node';
+import { z } from 'zod';
+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");
+var MilvusAction = /* @__PURE__ */ function(MilvusAction2) {
+  MilvusAction2["ListCollections"] = "ListCollections";
+  MilvusAction2["GetCollectionInfo"] = "GetCollectionInfo";
+  MilvusAction2["Search"] = "Search";
+  MilvusAction2["Insert"] = "Insert";
+  MilvusAction2["Delete"] = "Delete";
+  return MilvusAction2;
+}({});
+class MilvusDatabaseTool extends Tool {
+  static {
+    __name(this, "MilvusDatabaseTool");
+  }
+  name = "MilvusDatabaseTool";
+  description = `Can query data from a Milvus database. IMPORTANT: strictly follow this order of actions:
+   1. ${"ListCollections"} - List all the Milvus collections
+   2. ${"GetCollectionInfo"} - Get information about into a Milvus collection
+   3. ${"Insert"} - Insert data into a Milvus collection
+   3. ${"Search"} - Perform search on a Milvus collection
+   4. ${"Delete"} - Delete from a Milvus collection`;
+  inputSchema() {
+    return z.object({
+      action: z.nativeEnum(MilvusAction).describe(`The action to perform. ${"ListCollections"} lists all collections, ${"GetCollectionInfo"} fetches details for a specified collection, ${"Search"} executes a vector search, ${"Insert"} inserts new vectors, and ${"Delete"} removes vectors.`),
+      collectionName: z.string().optional().describe(`The name of the collection to query, required for ${"GetCollectionInfo"}, ${"Search"}, ${"Insert"}, and ${"Delete"}`),
+      vector: z.array(z.number()).optional().describe(`The vector to search for or insert, required for ${"Search"}`),
+      vectors: z.array(z.array(z.number())).optional().describe(`The vectors to insert, required for ${"Insert"}`),
+      topK: z.coerce.number().int().min(1).max(1e3).default(10).optional().describe(`The number of nearest neighbors to return for ${"Search"}. Maximum is 1000`),
+      filter: z.string().optional().describe(`Optional filter expression for ${"Search"}`),
+      metadata: z.record(z.string(), z.any()).optional().describe(`Additional metadata to insert with vectors for ${"Insert"}`),
+      ids: z.array(z.string().or(z.number())).optional().describe(`Array of IDs to delete for ${"Delete"}`),
+      searchOutput: z.array(z.string()).optional().describe(`Fields to return in search results for ${"Search"}`)
+    });
+  }
+  emitter = Emitter.root.child({
+    namespace: [
+      "tool",
+      "database",
+      "milvus"
+    ],
+    creator: this
+  });
+  validateInput(schema, input) {
+    super.validateInput(schema, input);
+    if (input.action === "GetCollectionInfo" && !input.collectionName) {
+      throw new ToolInputValidationError(`Collection name is required for ${"GetCollectionInfo"}, ${"Search"}, ${"Insert"}, and ${"Delete"} actions.`);
+    }
+    if (input.action === "Search" && (!input.collectionName || !input.vector)) {
+      throw new ToolInputValidationError(`Both collection name and vector are required for ${"Search"} action.`);
+    }
+    if (input.action === "Insert" && (!input.collectionName || !input.vectors)) {
+      throw new ToolInputValidationError(`Both collection name and vectors are required for ${"Insert"} action.`);
+    }
+  }
+  static {
+    this.register();
+  }
+  async client() {
+    try {
+      const client = new MilvusClient(this.options.connection);
+      await client.listCollections();
+      return client;
+    } catch (error) {
+      throw new ToolError(`Unable to connect to Milvus.`, [
+        error
+      ], {
+        isRetryable: false,
+        isFatal: true
+      });
+    }
+  }
+  async _run(input, _options) {
+    switch (input.action) {
+      case "ListCollections": {
+        const collections = await this.listCollections();
+        return new JSONToolOutput(collections);
+      }
+      case "GetCollectionInfo": {
+        if (!input.collectionName) {
+          throw new ToolError("A collection name is required for Milvus GetCollectionInfo action");
+        }
+        const collectionInfo = await this.getCollectionInfo(input.collectionName);
+        return new JSONToolOutput(collectionInfo);
+      }
+      case "Search": {
+        if (!input.collectionName || !input.vector) {
+          throw new ToolError("A collection name and vector are required for Milvus Search action");
+        }
+        const searchResults = await this.search(input);
+        return new JSONToolOutput(searchResults);
+      }
+      case "Insert": {
+        if (!input.collectionName || !input.vectors) {
+          throw new ToolError("A collection name and vectors are required for Milvus Insert action");
+        }
+        const insertResults = await this.insert(input);
+        return new JSONToolOutput(insertResults);
+      }
+      case "Delete": {
+        if (!input.collectionName || !input.ids) {
+          throw new ToolError("Collection name and ids are required for Milvus Delete action");
+        }
+        const deleteResults = await this.delete(input);
+        return new JSONToolOutput(deleteResults);
+      }
+      default: {
+        throw new ToolError(`Invalid action specified: ${input.action}`);
+      }
+    }
+  }
+  async listCollections() {
+    try {
+      const client = await this.client();
+      const response = await client.listCollections({});
+      if (response && response.data && Array.isArray(response.data)) {
+        return response.data.map((collection) => collection.name);
+      } else {
+        return [];
+      }
+    } catch (error) {
+      throw new ToolError(`Failed to list collections from Milvus: ${error}`);
+    }
+  }
+  async getCollectionInfo(collectionName) {
+    const client = await this.client();
+    const response = client.describeCollection({
+      collection_name: collectionName
+    });
+    return response;
+  }
+  async insert(input) {
+    const client = await this.client();
+    const response = await client.insert({
+      collection_name: input.collectionName,
+      fields_data: input.vectors.map((vector, index) => ({
+        vector,
+        ...input.metadata?.[index]
+      }))
+    });
+    return response;
+  }
+  async search(input) {
+    const client = await this.client();
+    const response = await client.search({
+      collection_name: input.collectionName,
+      vector: input.vector,
+      limit: input.topK || 10,
+      filter: input.filter,
+      output_fields: input.searchOutput
+    });
+    return response.results;
+  }
+  async delete(input) {
+    const client = await this.client();
+    const response = client.delete({
+      collection_name: input.collectionName,
+      filter: `id in [${input.ids?.join(",")}]`
+    });
+    return response;
+  }
+}
+_ts_decorate([
+  Cache(),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", []),
+  _ts_metadata("design:returntype", Promise)
+], MilvusDatabaseTool.prototype, "client", null);
+
+export { MilvusAction, MilvusDatabaseTool };
+//# sourceMappingURL=milvus.js.map
+//# sourceMappingURL=milvus.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/tools/database/milvus.ts"],"names":["MilvusAction","MilvusDatabaseTool","Tool","name","description","inputSchema","z","object","action","nativeEnum","describe","collectionName","string","optional","vector","array","number","vectors","topK","coerce","int","min","max","default","filter","metadata","record","any","ids","or","searchOutput","emitter","Emitter","root","child","namespace","creator","validateInput","schema","input","ToolInputValidationError","register","client","MilvusClient","options","connection","listCollections","error","ToolError","isRetryable","isFatal","_run","_options","collections","JSONToolOutput","collectionInfo","getCollectionInfo","searchResults","search","insertResults","insert","deleteResults","delete","response","data","Array","isArray","map","collection","describeCollection","collection_name","fields_data","index","limit","output_fields","results","join"],"mappings":";;;;;;;;AAcC,SAAA,YAAA,CAAA,UAAA,EAAA,MAAA,EAAA,GAAA,EAAA,IAAA,EAAA;;;;;;AAAA,MAAA,CAAA,YAAA,EAAA,cAAA,CAAA;;;;;AAiCWA,IAAAA,YAAAA,4BAAAA,aAAAA,EAAAA;;;;;;AAAAA,EAAAA,OAAAA,aAAAA;;AAQL,MAAMC,2BAA2BC,IAAAA,CAAAA;EAvDxC;;;EA2DEC,IAAO,GAAA,oBAAA;EAEPC,WAAc,GAAA,CAAA;QACV,iBAAA,CAAA;QACA,mBAAA,CAAA;QACA,QAAA,CAAA;QACA,QAAA,CAAA;QACA,QAAA,CAAA,kCAAA,CAAA;EAEJC,WAAc,GAAA;AACZ,IAAA,OAAOC,EAAEC,MAAO,CAAA;AACdC,MAAAA,MAAAA,EAAQF,CACLG,CAAAA,UAAAA,CAAWT,YAAAA,CAAAA,CACXU,SACC,CAAwB,uBAAA,EAAA,iBAAA,CAAuD,wBAAA,EAAA,mBAAA,gDAA8E,QAAA,CAAA,2BAAA,EAAiD,QAAA,CAAA,0BAAA,EAAgD,QAAA,CAAwC,iBAAA,CAAA,CAAA;AAE1SC,MAAAA,cAAAA,EAAgBL,CACbM,CAAAA,MAAAA,EACAC,CAAAA,QAAAA,GACAH,QACC,CAAA,CAAA,kDAAA,EAAmD,mBAAA,CAAA,EAAA,EAAmC,QAAA,CAAA,EAAA,EAAwB,QAAA,CAAA,MAAA,EAA4B,QAAA,CAAuB,CAAA,CAAA;MAErKI,MAAQR,EAAAA,CAAAA,CACLS,KAAMT,CAAAA,CAAAA,CAAEU,MAAM,EAAA,CACdH,CAAAA,QAAAA,EACAH,CAAAA,QAAAA,CAAS,CAAkD,iDAAA,EAAA,QAAA,CAAuB,CAAA,CAAA;AACrFO,MAAAA,OAAAA,EAASX,CACNS,CAAAA,KAAAA,CAAMT,CAAES,CAAAA,KAAAA,CAAMT,EAAEU,MAAM,EAAA,CAAA,CAAA,CACtBH,QAAQ,EAAA,CACRH,QAAS,CAAA,CAAA,oCAAA,EAAqC,QAAA,CAAuB,CAAA,CAAA;MACxEQ,IAAMZ,EAAAA,CAAAA,CAAEa,OACLH,MAAM,EAAA,CACNI,KACAC,CAAAA,GAAAA,CAAI,CAAA,CACJC,CAAAA,GAAAA,CAAI,GAAA,CACJC,CAAAA,OAAAA,CAAQ,EAAA,CACRV,CAAAA,QAAAA,GACAH,QACC,CAAA,CAAA,8CAAA,EAA+C,QAAA,CAAwC,iBAAA,CAAA,CAAA;MAE3Fc,MAAQlB,EAAAA,CAAAA,CACLM,QACAC,CAAAA,QAAAA,GACAH,QAAS,CAAA,CAAA,+BAAA,EAAgC,QAAA,CAAuB,CAAA,CAAA;AACnEe,MAAAA,QAAAA,EAAUnB,CACPoB,CAAAA,MAAAA,CAAOpB,CAAEM,CAAAA,MAAAA,IAAUN,CAAEqB,CAAAA,GAAAA,EAAG,CAAA,CACxBd,QAAQ,EAAA,CACRH,QAAS,CAAA,CAAA,+CAAA,EAAgD,QAAA,CAAuB,CAAA,CAAA;AACnFkB,MAAAA,GAAAA,EAAKtB,EACFS,KAAMT,CAAAA,CAAAA,CAAEM,MAAM,EAAA,CAAGiB,GAAGvB,CAAEU,CAAAA,MAAAA,EAAM,CAAA,EAC5BH,QAAQ,EAAA,CACRH,QAAS,CAAA,CAAA,2BAAA,EAA4B,QAAA,CAAuB,CAAA,CAAA;MAC/DoB,YAAcxB,EAAAA,CAAAA,CACXS,KAAMT,CAAAA,CAAAA,CAAEM,MAAM,EAAA,CACdC,CAAAA,QAAAA,EACAH,CAAAA,QAAAA,CAAS,CAAwC,uCAAA,EAAA,QAAA,CAAuB,CAAA;KAC7E,CAAA;AACF;EAEgBqB,OACdC,GAAAA,OAAAA,CAAQC,KAAKC,KAAM,CAAA;IACjBC,SAAW,EAAA;AAAC,MAAA,MAAA;AAAQ,MAAA,UAAA;AAAY,MAAA;;IAChCC,OAAS,EAAA;GACX,CAAA;AAEQC,EAAAA,aAAAA,CACRC,QACAC,KACkC,EAAA;AAClC,IAAMF,KAAAA,CAAAA,aAAAA,CAAcC,QAAQC,KAAAA,CAAAA;AAC5B,IAAA,IAAIA,KAAM/B,CAAAA,MAAAA,KAAM,mBAAuC,IAAA,CAAC+B,MAAM5B,cAAgB,EAAA;AAC5E,MAAM,MAAA,IAAI6B,wBACR,CAAA,CAAA,gCAAA,EAAiC,mBAAA,CAAA,EAAA,EAAmC,QAAA,CAAwB,EAAA,EAAA,QAAA,CAA4B,MAAA,EAAA,QAAA,CAAgC,SAAA,CAAA,CAAA;AAE5J;AACA,IAAID,IAAAA,KAAAA,CAAM/B,WAAM,QAA6B,KAAA,CAAC+B,MAAM5B,cAAkB,IAAA,CAAC4B,MAAMzB,MAAS,CAAA,EAAA;AACpF,MAAA,MAAM,IAAI0B,wBAAAA,CACR,CAAkD,iDAAA,EAAA,QAAA,CAA+B,QAAA,CAAA,CAAA;AAErF;AACA,IAAID,IAAAA,KAAAA,CAAM/B,WAAM,QAA6B,KAAA,CAAC+B,MAAM5B,cAAkB,IAAA,CAAC4B,MAAMtB,OAAU,CAAA,EAAA;AACrF,MAAA,MAAM,IAAIuB,wBAAAA,CACR,CAAmD,kDAAA,EAAA,QAAA,CAA+B,QAAA,CAAA,CAAA;AAEtF;AACF;EAEA;AACE,IAAA,IAAA,CAAKC,QAAQ,EAAA;AACf;AAEA,EAAA,MACgBC,MAAgC,GAAA;AAC9C,IAAI,IAAA;AACF,MAAA,MAAMA,MAAS,GAAA,IAAIC,YAAa,CAAA,IAAA,CAAKC,QAAQC,UAAU,CAAA;AAEvD,MAAA,MAAMH,OAAOI,eAAe,EAAA;AAC5B,MAAOJ,OAAAA,MAAAA;AACT,KAAA,CAAA,OAASK,KAAO,EAAA;AACd,MAAM,MAAA,IAAIC,UAAU,CAAgC,4BAAA,CAAA,EAAA;AAACD,QAAAA;AAAQ,OAAA,EAAA;QAC3DE,WAAa,EAAA,KAAA;QACbC,OAAS,EAAA;OACX,CAAA;AACF;AACF;EAEA,MAAgBC,IAAAA,CACdZ,OACAa,QAC8B,EAAA;AAC9B,IAAA,QAAQb,MAAM/B,MAAM;AAClB,MAAA,KAAA,iBAAmC,EAAA;AACjC,QAAM6C,MAAAA,WAAAA,GAAc,MAAM,IAAA,CAAKP,eAAe,EAAA;AAC9C,QAAO,OAAA,IAAIQ,eAAeD,WAAAA,CAAAA;AAC5B;AAEA,MAAA,KAAA,mBAAqC,EAAA;AACnC,QAAI,IAAA,CAACd,MAAM5B,cAAgB,EAAA;AACzB,UAAM,MAAA,IAAIqC,UAAU,mEAAA,CAAA;AACtB;AACA,QAAA,MAAMO,cAAiB,GAAA,MAAM,IAAKC,CAAAA,iBAAAA,CAAkBjB,MAAM5B,cAAc,CAAA;AACxE,QAAO,OAAA,IAAI2C,eAAeC,cAAAA,CAAAA;AAC5B;AAEA,MAAA,KAAA,QAA0B,EAAA;AACxB,QAAA,IAAI,CAAChB,KAAAA,CAAM5B,cAAkB,IAAA,CAAC4B,MAAMzB,MAAQ,EAAA;AAC1C,UAAM,MAAA,IAAIkC,UAAU,oEAAA,CAAA;AACtB;AACA,QAAA,MAAMS,aAAgB,GAAA,MAAM,IAAKC,CAAAA,MAAAA,CAAOnB,KAAAA,CAAAA;AACxC,QAAO,OAAA,IAAIe,eAAeG,aAAAA,CAAAA;AAC5B;AAEA,MAAA,KAAA,QAA0B,EAAA;AACxB,QAAA,IAAI,CAAClB,KAAAA,CAAM5B,cAAkB,IAAA,CAAC4B,MAAMtB,OAAS,EAAA;AAC3C,UAAM,MAAA,IAAI+B,UACR,qEAAA,CAAA;AAEJ;AACA,QAAA,MAAMW,aAAgB,GAAA,MAAM,IAAKC,CAAAA,MAAAA,CAAOrB,KAAAA,CAAAA;AACxC,QAAO,OAAA,IAAIe,eAAeK,aAAAA,CAAAA;AAC5B;AAEA,MAAA,KAAA,QAA0B,EAAA;AACxB,QAAA,IAAI,CAACpB,KAAAA,CAAM5B,cAAkB,IAAA,CAAC4B,MAAMX,GAAK,EAAA;AACvC,UAAM,MAAA,IAAIoB,UAAU,+DAAA,CAAA;AACtB;AACA,QAAA,MAAMa,aAAgB,GAAA,MAAM,IAAKC,CAAAA,MAAAA,CAAOvB,KAAAA,CAAAA;AACxC,QAAO,OAAA,IAAIe,eAAeO,aAAAA,CAAAA;AAC5B;MAEA,SAAS;AACP,QAAA,MAAM,IAAIb,SAAAA,CAAU,CAA6BT,0BAAAA,EAAAA,KAAAA,CAAM/B,MAAM,CAAE,CAAA,CAAA;AACjE;AACF;AACF;AAEA,EAAA,MAAgBsC,eAAqC,GAAA;AACnD,IAAI,IAAA;AACF,MAAMJ,MAAAA,MAAAA,GAAS,MAAM,IAAA,CAAKA,MAAM,EAAA;AAChC,MAAA,MAAMqB,QAAW,GAAA,MAAMrB,MAAOI,CAAAA,eAAAA,CAAgB,EAAC,CAAA;AAE/C,MAAA,IAAIiB,YAAYA,QAASC,CAAAA,IAAAA,IAAQC,MAAMC,OAAQH,CAAAA,QAAAA,CAASC,IAAI,CAAG,EAAA;AAC7D,QAAA,OAAOD,SAASC,IAAKG,CAAAA,GAAAA,CAAI,CAACC,UAAAA,KAAeA,WAAWjE,IAAI,CAAA;OACnD,MAAA;AACL,QAAA,OAAO,EAAA;AACT;AACF,KAAA,CAAA,OAAS4C,KAAO,EAAA;AACd,MAAA,MAAM,IAAIC,SAAAA,CAAU,CAA2CD,wCAAAA,EAAAA,KAAAA,CAAO,CAAA,CAAA;AACxE;AACF;AAEA,EAAA,MAAgBS,kBAAkB7C,cAAsC,EAAA;AACtE,IAAM+B,MAAAA,MAAAA,GAAS,MAAM,IAAA,CAAKA,MAAM,EAAA;AAChC,IAAMqB,MAAAA,QAAAA,GAAWrB,OAAO2B,kBAAmB,CAAA;MAAEC,eAAiB3D,EAAAA;KAAe,CAAA;AAC7E,IAAOoD,OAAAA,QAAAA;AACT;AAEA,EAAA,MAAgBH,OAAOrB,KAAsC,EAAA;AAC3D,IAAMG,MAAAA,MAAAA,GAAS,MAAM,IAAA,CAAKA,MAAM,EAAA;AAChC,IAAMqB,MAAAA,QAAAA,GAAW,MAAMrB,MAAAA,CAAOkB,MAAO,CAAA;AACnCU,MAAAA,eAAAA,EAAiB/B,KAAM5B,CAAAA,cAAAA;AACvB4D,MAAAA,WAAAA,EAAahC,KAAMtB,CAAAA,OAAAA,CAASkD,GAAI,CAAA,CAACrD,QAAQ0D,KAAW,MAAA;AAClD1D,QAAAA,MAAAA;QACA,GAAGyB,KAAAA,CAAMd,WAAW+C,KAAAA;OACtB,CAAA;KACF,CAAA;AACA,IAAOT,OAAAA,QAAAA;AACT;AAEA,EAAA,MAAgBL,OAAOnB,KAAsC,EAAA;AAC3D,IAAMG,MAAAA,MAAAA,GAAS,MAAM,IAAA,CAAKA,MAAM,EAAA;AAChC,IAAMqB,MAAAA,QAAAA,GAAW,MAAMrB,MAAAA,CAAOgB,MAAO,CAAA;AACnCY,MAAAA,eAAAA,EAAiB/B,KAAM5B,CAAAA,cAAAA;AACvBG,MAAAA,MAAAA,EAAQyB,KAAMzB,CAAAA,MAAAA;AACd2D,MAAAA,KAAAA,EAAOlC,MAAMrB,IAAQ,IAAA,EAAA;AACrBM,MAAAA,MAAAA,EAAQe,KAAMf,CAAAA,MAAAA;AACdkD,MAAAA,aAAAA,EAAenC,KAAMT,CAAAA;KACvB,CAAA;AACA,IAAA,OAAOiC,QAASY,CAAAA,OAAAA;AAClB;AAEA,EAAA,MAAgBb,OAAOvB,KAAsC,EAAA;AAC3D,IAAMG,MAAAA,MAAAA,GAAS,MAAM,IAAA,CAAKA,MAAM,EAAA;AAChC,IAAMqB,MAAAA,QAAAA,GAAWrB,OAAOoB,MAAO,CAAA;AAC7BQ,MAAAA,eAAAA,EAAiB/B,KAAM5B,CAAAA,cAAAA;AACvBa,MAAAA,MAAAA,EAAQ,CAAUe,OAAAA,EAAAA,KAAAA,CAAMX,GAAKgD,EAAAA,IAAAA,CAAK,GAAA,CAAA,CAAA,CAAA;KACpC,CAAA;AACA,IAAOb,OAAAA,QAAAA;AACT;AACF","file":"milvus.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 { Cache } from \"@/cache/decoratorCache.js\";\nimport { AnyToolSchemaLike } from \"@/internals/helpers/schema.js\";\nimport {\n  ClientConfig,\n  MilvusClient,\n  SearchRes,\n  ShowCollectionsResponse,\n  DescribeCollectionResponse,\n} from \"@zilliz/milvus2-sdk-node\";\nimport { z } from \"zod\";\nimport { Emitter } from \"@/emitter/emitter.js\";\n\nexport interface MilvusToolOptions extends BaseToolOptions {\n  connection: ClientConfig;\n}\n\nexport type MilvusSearchToolResult =\n  | ShowCollectionsResponse\n  | DescribeCollectionResponse\n  | SearchRes;\n\nexport enum MilvusAction {\n  ListCollections = \"ListCollections\",\n  GetCollectionInfo = \"GetCollectionInfo\",\n  Search = \"Search\",\n  Insert = \"Insert\",\n  Delete = \"Delete\",\n}\n\nexport class MilvusDatabaseTool extends Tool<\n  JSONToolOutput<MilvusSearchToolResult>,\n  MilvusToolOptions\n> {\n  name = \"MilvusDatabaseTool\";\n\n  description = `Can query data from a Milvus database. IMPORTANT: strictly follow this order of actions:\n   1. ${MilvusAction.ListCollections} - List all the Milvus collections\n   2. ${MilvusAction.GetCollectionInfo} - Get information about into a Milvus collection\n   3. ${MilvusAction.Insert} - Insert data into a Milvus collection\n   3. ${MilvusAction.Search} - Perform search on a Milvus collection\n   4. ${MilvusAction.Delete} - Delete from a Milvus collection`;\n\n  inputSchema() {\n    return z.object({\n      action: z\n        .nativeEnum(MilvusAction)\n        .describe(\n          `The action to perform. ${MilvusAction.ListCollections} lists all collections, ${MilvusAction.GetCollectionInfo} fetches details for a specified collection, ${MilvusAction.Search} executes a vector search, ${MilvusAction.Insert} inserts new vectors, and ${MilvusAction.Delete} removes vectors.`,\n        ),\n      collectionName: z\n        .string()\n        .optional()\n        .describe(\n          `The name of the collection to query, required for ${MilvusAction.GetCollectionInfo}, ${MilvusAction.Search}, ${MilvusAction.Insert}, and ${MilvusAction.Delete}`,\n        ),\n      vector: z\n        .array(z.number())\n        .optional()\n        .describe(`The vector to search for or insert, required for ${MilvusAction.Search}`),\n      vectors: z\n        .array(z.array(z.number()))\n        .optional()\n        .describe(`The vectors to insert, required for ${MilvusAction.Insert}`),\n      topK: z.coerce\n        .number()\n        .int()\n        .min(1)\n        .max(1000)\n        .default(10)\n        .optional()\n        .describe(\n          `The number of nearest neighbors to return for ${MilvusAction.Search}. Maximum is 1000`,\n        ),\n      filter: z\n        .string()\n        .optional()\n        .describe(`Optional filter expression for ${MilvusAction.Search}`),\n      metadata: z\n        .record(z.string(), z.any())\n        .optional()\n        .describe(`Additional metadata to insert with vectors for ${MilvusAction.Insert}`),\n      ids: z\n        .array(z.string().or(z.number()))\n        .optional()\n        .describe(`Array of IDs to delete for ${MilvusAction.Delete}`),\n      searchOutput: z\n        .array(z.string())\n        .optional()\n        .describe(`Fields to return in search results for ${MilvusAction.Search}`),\n    });\n  }\n\n  public readonly emitter: ToolEmitter<ToolInput<this>, JSONToolOutput<MilvusSearchToolResult>> =\n    Emitter.root.child({\n      namespace: [\"tool\", \"database\", \"milvus\"],\n      creator: this,\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 === MilvusAction.GetCollectionInfo && !input.collectionName) {\n      throw new ToolInputValidationError(\n        `Collection name is required for ${MilvusAction.GetCollectionInfo}, ${MilvusAction.Search}, ${MilvusAction.Insert}, and ${MilvusAction.Delete} actions.`,\n      );\n    }\n    if (input.action === MilvusAction.Search && (!input.collectionName || !input.vector)) {\n      throw new ToolInputValidationError(\n        `Both collection name and vector are required for ${MilvusAction.Search} action.`,\n      );\n    }\n    if (input.action === MilvusAction.Insert && (!input.collectionName || !input.vectors)) {\n      throw new ToolInputValidationError(\n        `Both collection name and vectors are required for ${MilvusAction.Insert} action.`,\n      );\n    }\n  }\n\n  static {\n    this.register();\n  }\n\n  @Cache()\n  protected async client(): Promise<MilvusClient> {\n    try {\n      const client = new MilvusClient(this.options.connection);\n      // operation expected to fail if connection is not established correctly.\n      await client.listCollections();\n      return client;\n    } catch (error) {\n      throw new ToolError(`Unable to connect to Milvus.`, [error], {\n        isRetryable: false,\n        isFatal: true,\n      });\n    }\n  }\n\n  protected async _run(\n    input: ToolInput<this>,\n    _options: Partial<BaseToolRunOptions>,\n  ): Promise<JSONToolOutput<any>> {\n    switch (input.action) {\n      case MilvusAction.ListCollections: {\n        const collections = await this.listCollections();\n        return new JSONToolOutput(collections);\n      }\n\n      case MilvusAction.GetCollectionInfo: {\n        if (!input.collectionName) {\n          throw new ToolError(\"A collection name is required for Milvus GetCollectionInfo action\");\n        }\n        const collectionInfo = await this.getCollectionInfo(input.collectionName);\n        return new JSONToolOutput(collectionInfo);\n      }\n\n      case MilvusAction.Search: {\n        if (!input.collectionName || !input.vector) {\n          throw new ToolError(\"A collection name and vector are required for Milvus Search action\");\n        }\n        const searchResults = await this.search(input);\n        return new JSONToolOutput(searchResults);\n      }\n\n      case MilvusAction.Insert: {\n        if (!input.collectionName || !input.vectors) {\n          throw new ToolError(\n            \"A collection name and vectors are required for Milvus Insert action\",\n          );\n        }\n        const insertResults = await this.insert(input);\n        return new JSONToolOutput(insertResults);\n      }\n\n      case MilvusAction.Delete: {\n        if (!input.collectionName || !input.ids) {\n          throw new ToolError(\"Collection name and ids are required for Milvus Delete action\");\n        }\n        const deleteResults = await this.delete(input);\n        return new JSONToolOutput(deleteResults);\n      }\n\n      default: {\n        throw new ToolError(`Invalid action specified: ${input.action}`);\n      }\n    }\n  }\n\n  protected async listCollections(): Promise<string[]> {\n    try {\n      const client = await this.client();\n      const response = await client.listCollections({});\n\n      if (response && response.data && Array.isArray(response.data)) {\n        return response.data.map((collection) => collection.name);\n      } else {\n        return [];\n      }\n    } catch (error) {\n      throw new ToolError(`Failed to list collections from Milvus: ${error}`);\n    }\n  }\n\n  protected async getCollectionInfo(collectionName: string): Promise<any> {\n    const client = await this.client();\n    const response = client.describeCollection({ collection_name: collectionName });\n    return response;\n  }\n\n  protected async insert(input: ToolInput<this>): Promise<any> {\n    const client = await this.client();\n    const response = await client.insert({\n      collection_name: input.collectionName as string,\n      fields_data: input.vectors!.map((vector, index) => ({\n        vector: vector,\n        ...input.metadata?.[index],\n      })),\n    });\n    return response;\n  }\n\n  protected async search(input: ToolInput<this>): Promise<any> {\n    const client = await this.client();\n    const response = await client.search({\n      collection_name: input.collectionName as string,\n      vector: input.vector,\n      limit: input.topK || 10,\n      filter: input.filter,\n      output_fields: input.searchOutput,\n    });\n    return response.results;\n  }\n\n  protected async delete(input: ToolInput<this>): Promise<any> {\n    const client = await this.client();\n    const response = client.delete({\n      collection_name: input.collectionName as string,\n      filter: `id in [${input.ids?.join(\",\")}]`,\n    });\n    return response;\n  }\n}\n"]}

package/dist/tools/database/sql.cjs

@@ -0,0 +1,174 @@
+'use strict';
+
+var base_cjs = require('../base.cjs');
+var zod = require('zod');
+var sequelize = require('sequelize');
+var metadata_cjs = require('./metadata.cjs');
+var decoratorCache_cjs = require('../../cache/decoratorCache.cjs');
+var ajv = require('ajv');
+var emitter_cjs = require('../../emitter/emitter.cjs');
+
+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 base_cjs.JSONToolOutput {
+  static {
+    __name(this, "SQLToolOutput");
+  }
+}
+class SQLTool extends base_cjs.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 zod.z.object({
+      action: zod.z.nativeEnum(SQLToolAction).describe(`The action to perform. ${SQLToolAction.GetMetadata} get database tables structure, ${SQLToolAction.Query} execute the SQL query`),
+      query: zod.z.string().optional().describe(`The SQL query to be executed, required for ${SQLToolAction.Query} action`)
+    });
+  }
+  emitter = emitter_cjs.Emitter.root.child({
+    namespace: [
+      "tool",
+      "database",
+      "sql"
+    ],
+    creator: this
+  });
+  constructor(options) {
+    super(options);
+    if (!options.connection.dialect) {
+      throw new ajv.ValidationError([
+        {
+          message: "Property is required",
+          propertyName: "connection.dialect"
+        }
+      ]);
+    }
+    if (!options.connection.schema && (options.provider === "oracle" || options.provider === "db2")) {
+      throw new ajv.ValidationError([
+        {
+          message: `Property is required for ${options.provider}`,
+          propertyName: "connection.schema"
+        }
+      ]);
+    }
+    if (!options.connection.storage && options.provider === "sqlite") {
+      throw new ajv.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 base_cjs.ToolInputValidationError(`SQL Query is required for ${SQLToolAction.Query} action.`);
+    }
+  }
+  static {
+    this.register();
+  }
+  async connection() {
+    try {
+      const sequelize$1 = new sequelize.Sequelize(this.options.connection);
+      await sequelize$1.authenticate();
+      return sequelize$1;
+    } catch (error) {
+      throw new base_cjs.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 metadata_cjs.getMetadata(sequelize, provider, schema);
+      return new SQLToolOutput(metadata);
+    }
+    if (input.action === SQLToolAction.Query) {
+      return await this.executeQuery(input.query, provider, schema);
+    }
+    throw new base_cjs.ToolError(`Invalid action specified: ${input.action}`);
+  }
+  async executeQuery(query, provider, schema) {
+    if (!this.isReadOnlyQuery(query)) {
+      return new base_cjs.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 base_cjs.JSONToolOutput({
+          success: true,
+          results
+        });
+      }
+      return new base_cjs.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 base_cjs.ToolError(errorMessage);
+    }
+  }
+  isReadOnlyQuery(query) {
+    const normalizedQuery = query.trim().toUpperCase();
+    return normalizedQuery.startsWith("SELECT") || normalizedQuery.startsWith("SHOW") || normalizedQuery.startsWith("DESC");
+  }
+  async destroy() {
+    const cache = decoratorCache_cjs.Cache.getInstance(this, "connection");
+    const entry = cache.get();
+    if (entry) {
+      cache.clear();
+      try {
+        await entry.data.close();
+      } catch (error) {
+        throw new base_cjs.ToolError(`Failed to close the database connection`, [
+          error
+        ]);
+      }
+    }
+  }
+}
+_ts_decorate([
+  decoratorCache_cjs.Cache(),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", []),
+  _ts_metadata("design:returntype", Promise)
+], SQLTool.prototype, "connection", null);
+
+exports.SQLTool = SQLTool;
+exports.SQLToolAction = SQLToolAction;
+exports.SQLToolOutput = SQLToolOutput;
+//# sourceMappingURL=sql.cjs.map
+//# sourceMappingURL=sql.cjs.map

package/dist/tools/database/sql.cjs.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,uBAAAA,CAAAA;EA9CnC;;;AA8CwD;AAEjD,MAAMC,gBAAgBC,aAAAA,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,MAAEC,MAAO,CAAA;MACdC,MAAQF,EAAAA,KAAAA,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,KAAAA,CACJM,QACAC,CAAAA,QAAAA,GACAH,QAAS,CAAA,CAAA,2CAAA,EAA8Cd,aAAcE,CAAAA,KAAK,CAAS,OAAA,CAAA;KACxF,CAAA;AACF;EAEgBgB,OAAuDC,GAAAA,mBAAAA,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,mBAAgB,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,mBAAgB,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,mBAAgB,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,iCAAAA,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,WAAY,GAAA,IAAIC,mBAAU,CAAA,IAAA,CAAKd,QAAQC,UAAU,CAAA;AAEvD,MAAA,MAAMY,YAAUE,YAAY,EAAA;AAC5B,MAAOF,OAAAA,WAAAA;AACT,KAAA,CAAA,OAASG,KAAO,EAAA;AACd,MAAA,MAAM,IAAIC,kBAAU,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,wBAAYV,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,kBAAAA,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,uBAAe,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,uBAAe,CAAA;UAAE8C,OAAS,EAAA,IAAA;AAAMC,UAAAA;SAAQ,CAAA;AACrD;AAEA,MAAA,OAAO,IAAI/C,uBAAe,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,mBAAUe,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,wBAAAA,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,mBAAU,CAA2C,uCAAA,CAAA,EAAA;AAACD,UAAAA;AAAM,SAAA,CAAA;AACxE;AACF;AACF;AACF","file":"sql.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  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"]}