beeai-framework 0.1.2

package/dist/tools/custom.js

@@ -0,0 +1,118 @@
+import { Tool, StringToolOutput, ToolError } from './base.js';
+import { FrameworkError } from '../errors.js';
+import { z } from 'zod';
+import { validate } from '../internals/helpers/general.js';
+import { callCodeInterpreter } from './python/python.js';
+import { Emitter } from '../emitter/emitter.js';
+import { merge } from 'remeda';
+import { omitUndefined } from '../internals/helpers/object.js';
+
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+class CustomToolCreateError extends FrameworkError {
+  static {
+    __name(this, "CustomToolCreateError");
+  }
+}
+class CustomToolExecuteError extends FrameworkError {
+  static {
+    __name(this, "CustomToolExecuteError");
+  }
+}
+const toolOptionsSchema = z.object({
+  codeInterpreter: z.object({
+    url: z.string().url(),
+    connectionOptions: z.any().optional()
+  }),
+  sourceCode: z.string().min(1),
+  name: z.string().min(1),
+  description: z.string().min(1),
+  inputSchema: z.any()
+}).passthrough();
+class CustomTool extends Tool {
+  static {
+    __name(this, "CustomTool");
+  }
+  name;
+  description;
+  emitter = Emitter.root.child({
+    namespace: [
+      "tool",
+      "custom"
+    ],
+    creator: this
+  });
+  inputSchema() {
+    return this.options.inputSchema;
+  }
+  static {
+    this.register();
+  }
+  constructor(options) {
+    validate(options, toolOptionsSchema);
+    super(options);
+    this.name = options.name;
+    this.description = options.description;
+  }
+  async _run(input, options, run) {
+    try {
+      const result = await callCodeInterpreter({
+        url: `${this.options.codeInterpreter.url}/v1/execute-custom-tool`,
+        body: {
+          tool_source_code: this.options.sourceCode,
+          tool_input_json: JSON.stringify(input),
+          env: merge(omitUndefined(this.options.env ?? {}), omitUndefined(options.env ?? {}))
+        },
+        signal: run.signal
+      });
+      if (result.stderr) {
+        throw new CustomToolExecuteError(result.stderr);
+      }
+      return new StringToolOutput(result.tool_output_json);
+    } catch (e) {
+      if (e instanceof ToolError) {
+        throw new CustomToolExecuteError(e.message, [
+          e
+        ]);
+      } else {
+        throw e;
+      }
+    }
+  }
+  loadSnapshot(snapshot) {
+    super.loadSnapshot(snapshot);
+  }
+  static async fromSourceCode({ env, ...codeInterpreter }, sourceCode) {
+    try {
+      const result = await callCodeInterpreter({
+        url: `${codeInterpreter.url}/v1/parse-custom-tool`,
+        body: {
+          tool_source_code: sourceCode
+        }
+      });
+      if (result.error_messages) {
+        throw new CustomToolCreateError(result.error_messages.join("\n"));
+      }
+      return new CustomTool({
+        codeInterpreter,
+        sourceCode,
+        name: result.tool_name,
+        description: result.tool_description,
+        inputSchema: JSON.parse(result.tool_input_schema_json),
+        env
+      });
+    } catch (e) {
+      if (e instanceof ToolError) {
+        throw new CustomToolCreateError(e.message, [
+          e
+        ]);
+      } else {
+        throw e;
+      }
+    }
+  }
+}
+
+export { CustomTool, CustomToolCreateError, CustomToolExecuteError };
+//# sourceMappingURL=custom.js.map
+//# sourceMappingURL=custom.js.map

package/dist/tools/custom.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/tools/custom.ts"],"names":["CustomToolCreateError","FrameworkError","CustomToolExecuteError","toolOptionsSchema","z","object","codeInterpreter","url","string","connectionOptions","any","optional","sourceCode","min","name","description","inputSchema","passthrough","CustomTool","Tool","emitter","Emitter","root","child","namespace","creator","options","register","validate","_run","input","run","result","callCodeInterpreter","body","tool_source_code","tool_input_json","JSON","stringify","env","merge","omitUndefined","signal","stderr","StringToolOutput","tool_output_json","e","ToolError","message","loadSnapshot","snapshot","fromSourceCode","error_messages","join","tool_name","tool_description","parse","tool_input_schema_json"],"mappings":";;;;;;;;;;;AAkCO,MAAMA,8BAA8BC,cAAAA,CAAAA;EAlC3C;;;AAkC2D;AACpD,MAAMC,+BAA+BD,cAAAA,CAAAA;EAnC5C;;;AAmC4D;AAE5D,MAAME,iBAAAA,GAAoBC,EACvBC,MAAO,CAAA;AACNC,EAAAA,eAAAA,EAAiBF,EAAEC,MAAO,CAAA;IACxBE,GAAKH,EAAAA,CAAAA,CAAEI,MAAM,EAAA,CAAGD,GAAG,EAAA;IACnBE,iBAAmBL,EAAAA,CAAAA,CAAEM,GAAG,EAAA,CAAGC,QAAQ;GACrC,CAAA;AACAC,EAAAA,UAAAA,EAAYR,CAAEI,CAAAA,MAAAA,EAASK,CAAAA,GAAAA,CAAI,CAAA,CAAA;AAC3BC,EAAAA,IAAAA,EAAMV,CAAEI,CAAAA,MAAAA,EAASK,CAAAA,GAAAA,CAAI,CAAA,CAAA;AACrBE,EAAAA,WAAAA,EAAaX,CAAEI,CAAAA,MAAAA,EAASK,CAAAA,GAAAA,CAAI,CAAA,CAAA;AAC5BG,EAAAA,WAAAA,EAAaZ,EAAEM,GAAG;AACpB,CAAA,EACCO,WAAW,EAAA;AASP,MAAMC,mBAAmBC,IAAAA,CAAAA;EAzDhC;;;AA0DEL,EAAAA,IAAAA;AACAC,EAAAA,WAAAA;EAEgBK,OAA0DC,GAAAA,OAAAA,CAAQC,KAAKC,KAAM,CAAA;IAC3FC,SAAW,EAAA;AAAC,MAAA,MAAA;AAAQ,MAAA;;IACpBC,OAAS,EAAA;GACX,CAAA;EAEOT,WAAc,GAAA;AACnB,IAAA,OAAO,KAAKU,OAAQV,CAAAA,WAAAA;AACtB;EAEA;AACE,IAAA,IAAA,CAAKW,QAAQ,EAAA;AACf;AAEA,EAAA,WAAA,CAAmBD,OAA4B,EAAA;AAC7CE,IAAAA,QAAAA,CAASF,SAASvB,iBAAAA,CAAAA;AAClB,IAAA,KAAA,CAAMuB,OAAAA,CAAAA;AACN,IAAA,IAAA,CAAKZ,OAAOY,OAAQZ,CAAAA,IAAAA;AACpB,IAAA,IAAA,CAAKC,cAAcW,OAAQX,CAAAA,WAAAA;AAC7B;EAEA,MAAgBc,IAAAA,CACdC,KACAJ,EAAAA,OAAAA,EACAK,GACA,EAAA;AACA,IAAI,IAAA;AACF,MAAMC,MAAAA,MAAAA,GAAS,MAAMC,mBAAoB,CAAA;AACvC1B,QAAAA,GAAAA,EAAK,CAAG,EAAA,IAAA,CAAKmB,OAAQpB,CAAAA,eAAAA,CAAgBC,GAAG,CAAA,uBAAA,CAAA;QACxC2B,IAAM,EAAA;AACJC,UAAAA,gBAAAA,EAAkB,KAAKT,OAAQd,CAAAA,UAAAA;UAC/BwB,eAAiBC,EAAAA,IAAAA,CAAKC,UAAUR,KAAAA,CAAAA;AAChCS,UAAAA,GAAAA,EAAKC,KAAMC,CAAAA,aAAAA,CAAc,IAAKf,CAAAA,OAAAA,CAAQa,GAAO,IAAA,EAAC,CAAA,EAAIE,aAAcf,CAAAA,OAAAA,CAAQa,GAAO,IAAA,EAAC,CAAA;AAClF,SAAA;AACAG,QAAAA,MAAAA,EAAQX,GAAIW,CAAAA;OACd,CAAA;AAEA,MAAA,IAAIV,OAAOW,MAAQ,EAAA;AACjB,QAAM,MAAA,IAAIzC,sBAAuB8B,CAAAA,MAAAA,CAAOW,MAAM,CAAA;AAChD;AAEA,MAAO,OAAA,IAAIC,gBAAiBZ,CAAAA,MAAAA,CAAOa,gBAAgB,CAAA;AACrD,KAAA,CAAA,OAASC,CAAG,EAAA;AACV,MAAA,IAAIA,aAAaC,SAAW,EAAA;AAC1B,QAAM,MAAA,IAAI7C,sBAAuB4C,CAAAA,CAAAA,CAAEE,OAAS,EAAA;AAACF,UAAAA;AAAE,SAAA,CAAA;OAC1C,MAAA;AACL,QAAMA,MAAAA,CAAAA;AACR;AACF;AACF;AAEAG,EAAAA,YAAAA,CAAaC,QAAwD,EAAA;AACnE,IAAA,KAAA,CAAMD,aAAaC,QAAAA,CAAAA;AACrB;AAEA,EAAA,aAAaC,eACX,EAAEZ,GAAAA,EAAK,GAAGjC,eAAAA,IACVM,UACA,EAAA;AACA,IAAI,IAAA;AACF,MAAMoB,MAAAA,MAAAA,GAAS,MAAMC,mBAAoB,CAAA;QACvC1B,GAAK,EAAA,CAAA,EAAGD,gBAAgBC,GAAG,CAAA,qBAAA,CAAA;QAC3B2B,IAAM,EAAA;UACJC,gBAAkBvB,EAAAA;AACpB;OACF,CAAA;AAEA,MAAA,IAAIoB,OAAOoB,cAAgB,EAAA;AACzB,QAAA,MAAM,IAAIpD,qBAAsBgC,CAAAA,MAAAA,CAAOoB,cAAeC,CAAAA,IAAAA,CAAK,IAAA,CAAA,CAAA;AAC7D;AAEA,MAAA,OAAO,IAAInC,UAAW,CAAA;AACpBZ,QAAAA,eAAAA;AACAM,QAAAA,UAAAA;AACAE,QAAAA,IAAAA,EAAMkB,MAAOsB,CAAAA,SAAAA;AACbvC,QAAAA,WAAAA,EAAaiB,MAAOuB,CAAAA,gBAAAA;QACpBvC,WAAaqB,EAAAA,IAAAA,CAAKmB,KAAMxB,CAAAA,MAAAA,CAAOyB,sBAAsB,CAAA;AACrDlB,QAAAA;OACF,CAAA;AACF,KAAA,CAAA,OAASO,CAAG,EAAA;AACV,MAAA,IAAIA,aAAaC,SAAW,EAAA;AAC1B,QAAM,MAAA,IAAI/C,qBAAsB8C,CAAAA,CAAAA,CAAEE,OAAS,EAAA;AAACF,UAAAA;AAAE,SAAA,CAAA;OACzC,MAAA;AACL,QAAMA,MAAAA,CAAAA;AACR;AACF;AACF;AACF","file":"custom.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  ToolEmitter,\n  StringToolOutput,\n  Tool,\n  ToolInput,\n} from \"@/tools/base.js\";\nimport { FrameworkError } from \"@/errors.js\";\nimport { z } from \"zod\";\nimport { validate } from \"@/internals/helpers/general.js\";\nimport { callCodeInterpreter, CodeInterpreterOptions } from \"./python/python.js\";\nimport { RunContext } from \"@/context.js\";\nimport { Emitter } from \"@/emitter/emitter.js\";\nimport { ToolError } from \"@/tools/base.js\";\nimport { merge } from \"remeda\";\nimport { omitUndefined } from \"@/internals/helpers/object.js\";\n\nexport class CustomToolCreateError extends FrameworkError {}\nexport class CustomToolExecuteError extends FrameworkError {}\n\nconst toolOptionsSchema = z\n  .object({\n    codeInterpreter: z.object({\n      url: z.string().url(),\n      connectionOptions: z.any().optional(),\n    }),\n    sourceCode: z.string().min(1),\n    name: z.string().min(1),\n    description: z.string().min(1),\n    inputSchema: z.any(),\n  })\n  .passthrough();\n\ntype CustomToolEnv = Record<string, string | boolean | null | undefined | number>;\n\nexport type CustomToolOptions = z.output<typeof toolOptionsSchema> &\n  BaseToolOptions & { env?: CustomToolEnv };\n\nexport type CustomToolRunOptions = Pick<CustomToolOptions, \"env\"> & BaseToolRunOptions;\n\nexport class CustomTool extends Tool<StringToolOutput, CustomToolOptions, CustomToolRunOptions> {\n  name: string;\n  description: string;\n\n  public readonly emitter: ToolEmitter<ToolInput<this>, StringToolOutput> = Emitter.root.child({\n    namespace: [\"tool\", \"custom\"],\n    creator: this,\n  });\n\n  public inputSchema() {\n    return this.options.inputSchema;\n  }\n\n  static {\n    this.register();\n  }\n\n  public constructor(options: CustomToolOptions) {\n    validate(options, toolOptionsSchema);\n    super(options);\n    this.name = options.name;\n    this.description = options.description;\n  }\n\n  protected async _run(\n    input: any,\n    options: Partial<CustomToolRunOptions>,\n    run: RunContext<typeof this>,\n  ) {\n    try {\n      const result = await callCodeInterpreter({\n        url: `${this.options.codeInterpreter.url}/v1/execute-custom-tool`,\n        body: {\n          tool_source_code: this.options.sourceCode,\n          tool_input_json: JSON.stringify(input),\n          env: merge(omitUndefined(this.options.env ?? {}), omitUndefined(options.env ?? {})),\n        },\n        signal: run.signal,\n      });\n\n      if (result.stderr) {\n        throw new CustomToolExecuteError(result.stderr);\n      }\n\n      return new StringToolOutput(result.tool_output_json);\n    } catch (e) {\n      if (e instanceof ToolError) {\n        throw new CustomToolExecuteError(e.message, [e]);\n      } else {\n        throw e;\n      }\n    }\n  }\n\n  loadSnapshot(snapshot: ReturnType<typeof this.createSnapshot>): void {\n    super.loadSnapshot(snapshot);\n  }\n\n  static async fromSourceCode(\n    { env, ...codeInterpreter }: CodeInterpreterOptions & Pick<CustomToolOptions, \"env\">,\n    sourceCode: string,\n  ) {\n    try {\n      const result = await callCodeInterpreter({\n        url: `${codeInterpreter.url}/v1/parse-custom-tool`,\n        body: {\n          tool_source_code: sourceCode,\n        },\n      });\n\n      if (result.error_messages) {\n        throw new CustomToolCreateError(result.error_messages.join(\"\\n\"));\n      }\n\n      return new CustomTool({\n        codeInterpreter,\n        sourceCode,\n        name: result.tool_name,\n        description: result.tool_description,\n        inputSchema: JSON.parse(result.tool_input_schema_json),\n        env,\n      });\n    } catch (e) {\n      if (e instanceof ToolError) {\n        throw new CustomToolCreateError(e.message, [e]);\n      } else {\n        throw e;\n      }\n    }\n  }\n}\n"]}

package/dist/tools/database/elasticsearch.cjs

@@ -0,0 +1,157 @@
+'use strict';
+
+var base_cjs = require('../base.cjs');
+var decoratorCache_cjs = require('../../cache/decoratorCache.cjs');
+var zod = require('zod');
+var ajv = require('ajv');
+var schema_cjs = require('../../internals/helpers/schema.cjs');
+var elasticsearch = require('@elastic/elasticsearch');
+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 ElasticSearchAction = {
+  ListIndices: "LIST_INDICES",
+  GetIndexDetails: "GET_INDEX_DETAILS",
+  Search: "SEARCH"
+};
+class ElasticSearchTool extends base_cjs.Tool {
+  static {
+    __name(this, "ElasticSearchTool");
+  }
+  name = "ElasticSearchTool";
+  description = `Can query data from an ElasticSearch database. IMPORTANT: strictly follow this order of actions:
+   1. ${ElasticSearchAction.ListIndices} - retrieve a list of available indices
+   2. ${ElasticSearchAction.GetIndexDetails} - get details of index fields
+   3. ${ElasticSearchAction.Search} - perform search or aggregation query on a specific index or pass the original user query without modifications if it's a valid JSON ElasticSearch query after identifying the index`;
+  inputSchema() {
+    return zod.z.object({
+      action: zod.z.nativeEnum(ElasticSearchAction).describe(`The action to perform. ${ElasticSearchAction.ListIndices} lists all indices, ${ElasticSearchAction.GetIndexDetails} fetches details for a specified index, and ${ElasticSearchAction.Search} executes a search or aggregation query`),
+      indexName: zod.z.string().optional().describe(`The name of the index to query, required for ${ElasticSearchAction.GetIndexDetails} and ${ElasticSearchAction.Search}`),
+      query: zod.z.string().optional().describe(`Valid ElasticSearch JSON search or aggregation query for ${ElasticSearchAction.Search} action`),
+      start: zod.z.coerce.number().int().min(0).default(0).optional().describe("The record index from which the query will start. Increase by the size of the query to get the next page of results"),
+      size: zod.z.coerce.number().int().min(0).max(10).default(10).optional().describe("How many records will be retrieved from the ElasticSearch query. Maximum is 10")
+    });
+  }
+  emitter = emitter_cjs.Emitter.root.child({
+    namespace: [
+      "tool",
+      "database",
+      "elasticsearch"
+    ],
+    creator: this
+  });
+  validateInput(schema, input) {
+    super.validateInput(schema, input);
+    if (input.action === ElasticSearchAction.GetIndexDetails && !input.indexName) {
+      throw new base_cjs.ToolInputValidationError(`Index name is required for ${ElasticSearchAction.GetIndexDetails} action.`);
+    }
+    if (input.action === ElasticSearchAction.Search && (!input.indexName || !input.query)) {
+      throw new base_cjs.ToolInputValidationError(`Both index name and query are required for ${ElasticSearchAction.Search} action.`);
+    }
+  }
+  static {
+    this.register();
+  }
+  constructor(options) {
+    super(options);
+    if (!options.connection.cloud && !options.connection.node && !options.connection.nodes) {
+      throw new ajv.ValidationError([
+        {
+          message: "At least one of the properties must be provided",
+          propertyName: "connection.cloud, connection.node, connection.nodes"
+        }
+      ]);
+    }
+  }
+  async client() {
+    try {
+      const client = new elasticsearch.Client(this.options.connection);
+      await client.info();
+      return client;
+    } catch (error) {
+      throw new base_cjs.ToolError(`Unable to connect to ElasticSearch.`, [
+        error
+      ], {
+        isRetryable: false,
+        isFatal: true
+      });
+    }
+  }
+  async _run(input, _options, run) {
+    if (input.action === ElasticSearchAction.ListIndices) {
+      const indices = await this.listIndices(run.signal);
+      return new base_cjs.JSONToolOutput(indices);
+    } else if (input.action === ElasticSearchAction.GetIndexDetails) {
+      const indexDetails = await this.getIndexDetails(input, run.signal);
+      return new base_cjs.JSONToolOutput(indexDetails);
+    } else if (input.action === ElasticSearchAction.Search) {
+      const response = await this.search(input, run.signal);
+      if (response.aggregations) {
+        return new base_cjs.JSONToolOutput(response.aggregations);
+      } else {
+        return new base_cjs.JSONToolOutput(response.hits.hits.map((hit) => hit._source));
+      }
+    } else {
+      throw new base_cjs.ToolError(`Invalid action specified: ${input.action}`);
+    }
+  }
+  async listIndices(signal) {
+    const client = await this.client();
+    const response = await client.cat.indices({
+      expand_wildcards: "open",
+      h: "index",
+      format: "json"
+    }, {
+      signal
+    });
+    return response.filter((record) => record.index && !record.index.startsWith(".")).map((record) => ({
+      index: record.index
+    }));
+  }
+  async getIndexDetails(input, signal) {
+    const client = await this.client();
+    return await client.indices.getMapping({
+      index: input.indexName
+    }, {
+      signal
+    });
+  }
+  async search(input, signal) {
+    const parsedQuery = schema_cjs.parseBrokenJson(input.query);
+    const searchBody = {
+      ...parsedQuery,
+      from: parsedQuery.from || input.start,
+      size: parsedQuery.size || input.size
+    };
+    const client = await this.client();
+    return await client.search({
+      index: input.indexName,
+      body: searchBody
+    }, {
+      signal
+    });
+  }
+}
+_ts_decorate([
+  decoratorCache_cjs.Cache(),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", []),
+  _ts_metadata("design:returntype", Promise)
+], ElasticSearchTool.prototype, "client", null);
+
+exports.ElasticSearchAction = ElasticSearchAction;
+exports.ElasticSearchTool = ElasticSearchTool;
+//# sourceMappingURL=elasticsearch.cjs.map
+//# sourceMappingURL=elasticsearch.cjs.map

package/dist/tools/database/elasticsearch.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/tools/database/elasticsearch.ts"],"names":["ElasticSearchAction","ListIndices","GetIndexDetails","Search","ElasticSearchTool","Tool","name","description","inputSchema","z","object","action","nativeEnum","describe","indexName","string","optional","query","start","coerce","number","int","min","default","size","max","emitter","Emitter","root","child","namespace","creator","validateInput","schema","input","ToolInputValidationError","register","options","connection","cloud","node","nodes","ValidationError","message","propertyName","client","Client","info","error","ToolError","isRetryable","isFatal","_run","_options","run","indices","listIndices","signal","JSONToolOutput","indexDetails","getIndexDetails","response","search","aggregations","hits","map","hit","_source","cat","expand_wildcards","h","format","filter","record","index","startsWith","getMapping","parsedQuery","parseBrokenJson","searchBody","from","body"],"mappings":";;;;;;;;;;;;AAcC,SAAA,YAAA,CAAA,UAAA,EAAA,MAAA,EAAA,GAAA,EAAA,IAAA,EAAA;;;;;;AAAA,MAAA,CAAA,YAAA,EAAA,cAAA,CAAA;;;;;AA8BM,MAAMA,mBAAsB,GAAA;EACjCC,WAAa,EAAA,cAAA;EACbC,eAAiB,EAAA,mBAAA;EACjBC,MAAQ,EAAA;AACV;AAEO,MAAMC,0BAA0BC,aAAAA,CAAAA;EAlDvC;;;EAsDEC,IAAO,GAAA,mBAAA;EAEPC,WAAc,GAAA,CAAA;AACRP,MAAAA,EAAAA,mBAAAA,CAAoBC,WAAW,CAAA;AAC/BD,MAAAA,EAAAA,mBAAAA,CAAoBE,eAAe,CAAA;AACnCF,MAAAA,EAAAA,mBAAAA,CAAoBG,MAAM,CAAA,qLAAA,CAAA;EAEhCK,WAAc,GAAA;AACZ,IAAA,OAAOC,MAAEC,MAAO,CAAA;AACdC,MAAAA,MAAAA,EAAQF,KACLG,CAAAA,UAAAA,CAAWZ,mBAAAA,CAAAA,CACXa,SACC,CAA0Bb,uBAAAA,EAAAA,mBAAAA,CAAoBC,WAAW,CAAA,oBAAA,EAAuBD,mBAAoBE,CAAAA,eAAe,CAA+CF,4CAAAA,EAAAA,mBAAAA,CAAoBG,MAAM,CAAyC,uCAAA,CAAA,CAAA;AAEzOW,MAAAA,SAAAA,EAAWL,KACRM,CAAAA,MAAAA,EACAC,CAAAA,QAAAA,EACAH,CAAAA,QAAAA,CACC,CAAgDb,6CAAAA,EAAAA,mBAAAA,CAAoBE,eAAe,CAAA,KAAA,EAAQF,mBAAoBG,CAAAA,MAAM,CAAE,CAAA,CAAA;MAE3Hc,KAAOR,EAAAA,KAAAA,CACJM,QACAC,CAAAA,QAAAA,GACAH,QACC,CAAA,CAAA,yDAAA,EAA4Db,mBAAoBG,CAAAA,MAAM,CAAS,OAAA,CAAA,CAAA;AAEnGe,MAAAA,KAAAA,EAAOT,KAAEU,CAAAA,MAAAA,CACNC,MAAM,EAAA,CACNC,KACAC,CAAAA,GAAAA,CAAI,CAAA,CAAA,CACJC,QAAQ,CAAA,CAAA,CACRP,QAAQ,EAAA,CACRH,SACC,qHAAA,CAAA;AAEJW,MAAAA,IAAAA,EAAMf,MAAEU,MACLC,CAAAA,MAAAA,GACAC,GAAG,EAAA,CACHC,IAAI,CAAA,CAAA,CACJG,GAAI,CAAA,EAAA,EACJF,OAAQ,CAAA,EAAA,EACRP,QAAQ,EAAA,CACRH,SAAS,gFAAA;KACd,CAAA;AACF;EAEgBa,OACdC,GAAAA,mBAAAA,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,MAAMvB,MAAWX,KAAAA,mBAAAA,CAAoBE,eAAmB,IAAA,CAACgC,MAAMpB,SAAW,EAAA;AAC5E,MAAA,MAAM,IAAIqB,iCAAAA,CACR,CAA8BnC,2BAAAA,EAAAA,mBAAAA,CAAoBE,eAAe,CAAU,QAAA,CAAA,CAAA;AAE/E;AACA,IAAIgC,IAAAA,KAAAA,CAAMvB,WAAWX,mBAAoBG,CAAAA,MAAAA,KAAW,CAAC+B,KAAMpB,CAAAA,SAAAA,IAAa,CAACoB,KAAAA,CAAMjB,KAAQ,CAAA,EAAA;AACrF,MAAA,MAAM,IAAIkB,iCAAAA,CACR,CAA8CnC,2CAAAA,EAAAA,mBAAAA,CAAoBG,MAAM,CAAU,QAAA,CAAA,CAAA;AAEtF;AACF;EAEA;AACE,IAAA,IAAA,CAAKiC,QAAQ,EAAA;AACf;AAEA,EAAA,WAAA,CAAmBC,OAAmC,EAAA;AACpD,IAAA,KAAA,CAAMA,OAAAA,CAAAA;AACN,IAAI,IAAA,CAACA,OAAQC,CAAAA,UAAAA,CAAWC,KAAS,IAAA,CAACF,OAAQC,CAAAA,UAAAA,CAAWE,IAAQ,IAAA,CAACH,OAAQC,CAAAA,UAAAA,CAAWG,KAAO,EAAA;AACtF,MAAA,MAAM,IAAIC,mBAAgB,CAAA;AACxB,QAAA;UACEC,OAAS,EAAA,iDAAA;UACTC,YAAc,EAAA;AAChB;AACD,OAAA,CAAA;AACH;AACF;AAEA,EAAA,MACgBC,MAA0B,GAAA;AACxC,IAAI,IAAA;AACF,MAAA,MAAMA,MAAS,GAAA,IAAIC,oBAAO,CAAA,IAAA,CAAKT,QAAQC,UAAU,CAAA;AACjD,MAAA,MAAMO,OAAOE,IAAI,EAAA;AACjB,MAAOF,OAAAA,MAAAA;AACT,KAAA,CAAA,OAASG,KAAO,EAAA;AACd,MAAM,MAAA,IAAIC,mBAAU,CAAuC,mCAAA,CAAA,EAAA;AAACD,QAAAA;AAAQ,OAAA,EAAA;QAClEE,WAAa,EAAA,KAAA;QACbC,OAAS,EAAA;OACX,CAAA;AACF;AACF;EAEA,MAAgBC,IAAAA,CACdlB,KACAmB,EAAAA,QAAAA,EACAC,GAC8B,EAAA;AAC9B,IAAIpB,IAAAA,KAAAA,CAAMvB,MAAWX,KAAAA,mBAAAA,CAAoBC,WAAa,EAAA;AACpD,MAAA,MAAMsD,OAAU,GAAA,MAAM,IAAKC,CAAAA,WAAAA,CAAYF,IAAIG,MAAM,CAAA;AACjD,MAAO,OAAA,IAAIC,wBAAeH,OAAAA,CAAAA;KACjBrB,MAAAA,IAAAA,KAAAA,CAAMvB,MAAWX,KAAAA,mBAAAA,CAAoBE,eAAiB,EAAA;AAC/D,MAAA,MAAMyD,eAAe,MAAM,IAAA,CAAKC,eAAgB1B,CAAAA,KAAAA,EAAOoB,IAAIG,MAAM,CAAA;AACjE,MAAO,OAAA,IAAIC,wBAAeC,YAAAA,CAAAA;KACjBzB,MAAAA,IAAAA,KAAAA,CAAMvB,MAAWX,KAAAA,mBAAAA,CAAoBG,MAAQ,EAAA;AACtD,MAAA,MAAM0D,WAAW,MAAM,IAAA,CAAKC,MAAO5B,CAAAA,KAAAA,EAAOoB,IAAIG,MAAM,CAAA;AACpD,MAAA,IAAII,SAASE,YAAc,EAAA;AACzB,QAAO,OAAA,IAAIL,uBAAeG,CAAAA,QAAAA,CAASE,YAAY,CAAA;OAC1C,MAAA;AACL,QAAO,OAAA,IAAIL,uBAAeG,CAAAA,QAAAA,CAASG,IAAKA,CAAAA,IAAAA,CAAKC,IAAI,CAACC,GAAAA,KAA2BA,GAAIC,CAAAA,OAAO,CAAA,CAAA;AAC1F;KACK,MAAA;AACL,MAAA,MAAM,IAAIlB,kBAAAA,CAAU,CAA6Bf,0BAAAA,EAAAA,KAAAA,CAAMvB,MAAM,CAAE,CAAA,CAAA;AACjE;AACF;AAEA,EAAA,MAAgB6C,YAAYC,MAA2D,EAAA;AACrF,IAAMZ,MAAAA,MAAAA,GAAS,MAAM,IAAA,CAAKA,MAAM,EAAA;AAChC,IAAA,MAAMgB,QAAW,GAAA,MAAMhB,MAAOuB,CAAAA,GAAAA,CAAIb,OAChC,CAAA;MACEc,gBAAkB,EAAA,MAAA;MAClBC,CAAG,EAAA,OAAA;MACHC,MAAQ,EAAA;KAEV,EAAA;AAAEd,MAAAA;KAAe,CAAA;AAEnB,IAAA,OAAOI,QACJW,CAAAA,MAAAA,CAAO,CAACC,MAAAA,KAAWA,OAAOC,KAAS,IAAA,CAACD,MAAOC,CAAAA,KAAAA,CAAMC,WAAW,GAAA,CAAA,CAC5DV,CAAAA,GAAAA,CAAI,CAACQ,MAAY,MAAA;AAAEC,MAAAA,KAAAA,EAAOD,MAAOC,CAAAA;KAAM,CAAA,CAAA;AAC5C;EAEA,MAAgBd,eAAAA,CACd1B,OACAuB,MAC4C,EAAA;AAC5C,IAAMZ,MAAAA,MAAAA,GAAS,MAAM,IAAA,CAAKA,MAAM,EAAA;AAChC,IAAO,OAAA,MAAMA,MAAOU,CAAAA,OAAAA,CAAQqB,UAC1B,CAAA;AACEF,MAAAA,KAAAA,EAAOxC,KAAMpB,CAAAA;KAEf,EAAA;AAAE2C,MAAAA;KAAe,CAAA;AAErB;EAEA,MAAgBK,MAAAA,CACd5B,OACAuB,MACiC,EAAA;AACjC,IAAMoB,MAAAA,WAAAA,GAAcC,0BAAgB5C,CAAAA,KAAAA,CAAMjB,KAAK,CAAA;AAC/C,IAAA,MAAM8D,UAAoC,GAAA;MACxC,GAAGF,WAAAA;MACHG,IAAMH,EAAAA,WAAAA,CAAYG,QAAQ9C,KAAMhB,CAAAA,KAAAA;MAChCM,IAAMqD,EAAAA,WAAAA,CAAYrD,QAAQU,KAAMV,CAAAA;AAClC,KAAA;AACA,IAAMqB,MAAAA,MAAAA,GAAS,MAAM,IAAA,CAAKA,MAAM,EAAA;AAChC,IAAO,OAAA,MAAMA,OAAOiB,MAClB,CAAA;AACEY,MAAAA,KAAAA,EAAOxC,KAAMpB,CAAAA,SAAAA;MACbmE,IAAMF,EAAAA;KAER,EAAA;AAAEtB,MAAAA;KAAe,CAAA;AAErB;AACF","file":"elasticsearch.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 { Cache } from \"@/cache/decoratorCache.js\";\nimport { RunContext } from \"@/context.js\";\nimport { z } from \"zod\";\nimport { ValidationError } from \"ajv\";\nimport { AnyToolSchemaLike } from \"@/internals/helpers/schema.js\";\nimport { parseBrokenJson } from \"@/internals/helpers/schema.js\";\nimport { Client, ClientOptions, estypes as ESTypes } from \"@elastic/elasticsearch\";\nimport { Emitter } from \"@/emitter/emitter.js\";\n\nexport interface ElasticSearchToolOptions extends BaseToolOptions {\n  connection: ClientOptions;\n}\n\nexport type ElasticSearchToolResult =\n  | ESTypes.CatIndicesResponse\n  | ESTypes.IndicesGetMappingResponse\n  | ESTypes.SearchResponse;\n\nexport const ElasticSearchAction = {\n  ListIndices: \"LIST_INDICES\",\n  GetIndexDetails: \"GET_INDEX_DETAILS\",\n  Search: \"SEARCH\",\n} as const;\n\nexport class ElasticSearchTool extends Tool<\n  JSONToolOutput<ElasticSearchToolResult>,\n  ElasticSearchToolOptions\n> {\n  name = \"ElasticSearchTool\";\n\n  description = `Can query data from an ElasticSearch database. IMPORTANT: strictly follow this order of actions:\n   1. ${ElasticSearchAction.ListIndices} - retrieve a list of available indices\n   2. ${ElasticSearchAction.GetIndexDetails} - get details of index fields\n   3. ${ElasticSearchAction.Search} - perform search or aggregation query on a specific index or pass the original user query without modifications if it's a valid JSON ElasticSearch query after identifying the index`;\n\n  inputSchema() {\n    return z.object({\n      action: z\n        .nativeEnum(ElasticSearchAction)\n        .describe(\n          `The action to perform. ${ElasticSearchAction.ListIndices} lists all indices, ${ElasticSearchAction.GetIndexDetails} fetches details for a specified index, and ${ElasticSearchAction.Search} executes a search or aggregation query`,\n        ),\n      indexName: z\n        .string()\n        .optional()\n        .describe(\n          `The name of the index to query, required for ${ElasticSearchAction.GetIndexDetails} and ${ElasticSearchAction.Search}`,\n        ),\n      query: z\n        .string()\n        .optional()\n        .describe(\n          `Valid ElasticSearch JSON search or aggregation query for ${ElasticSearchAction.Search} action`,\n        ),\n      start: z.coerce\n        .number()\n        .int()\n        .min(0)\n        .default(0)\n        .optional()\n        .describe(\n          \"The record index from which the query will start. Increase by the size of the query to get the next page of results\",\n        ),\n      size: z.coerce\n        .number()\n        .int()\n        .min(0)\n        .max(10)\n        .default(10)\n        .optional()\n        .describe(\"How many records will be retrieved from the ElasticSearch query. Maximum is 10\"),\n    });\n  }\n\n  public readonly emitter: ToolEmitter<ToolInput<this>, JSONToolOutput<ElasticSearchToolResult>> =\n    Emitter.root.child({\n      namespace: [\"tool\", \"database\", \"elasticsearch\"],\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 === ElasticSearchAction.GetIndexDetails && !input.indexName) {\n      throw new ToolInputValidationError(\n        `Index name is required for ${ElasticSearchAction.GetIndexDetails} action.`,\n      );\n    }\n    if (input.action === ElasticSearchAction.Search && (!input.indexName || !input.query)) {\n      throw new ToolInputValidationError(\n        `Both index name and query are required for ${ElasticSearchAction.Search} action.`,\n      );\n    }\n  }\n\n  static {\n    this.register();\n  }\n\n  public constructor(options: ElasticSearchToolOptions) {\n    super(options);\n    if (!options.connection.cloud && !options.connection.node && !options.connection.nodes) {\n      throw new ValidationError([\n        {\n          message: \"At least one of the properties must be provided\",\n          propertyName: \"connection.cloud, connection.node, connection.nodes\",\n        },\n      ]);\n    }\n  }\n\n  @Cache()\n  protected async client(): Promise<Client> {\n    try {\n      const client = new Client(this.options.connection);\n      await client.info();\n      return client;\n    } catch (error) {\n      throw new ToolError(`Unable to connect to ElasticSearch.`, [error], {\n        isRetryable: false,\n        isFatal: true,\n      });\n    }\n  }\n\n  protected async _run(\n    input: ToolInput<this>,\n    _options: Partial<BaseToolRunOptions>,\n    run: RunContext<this>,\n  ): Promise<JSONToolOutput<any>> {\n    if (input.action === ElasticSearchAction.ListIndices) {\n      const indices = await this.listIndices(run.signal);\n      return new JSONToolOutput(indices);\n    } else if (input.action === ElasticSearchAction.GetIndexDetails) {\n      const indexDetails = await this.getIndexDetails(input, run.signal);\n      return new JSONToolOutput(indexDetails);\n    } else if (input.action === ElasticSearchAction.Search) {\n      const response = await this.search(input, run.signal);\n      if (response.aggregations) {\n        return new JSONToolOutput(response.aggregations);\n      } else {\n        return new JSONToolOutput(response.hits.hits.map((hit: ESTypes.SearchHit) => hit._source));\n      }\n    } else {\n      throw new ToolError(`Invalid action specified: ${input.action}`);\n    }\n  }\n\n  protected async listIndices(signal?: AbortSignal): Promise<ESTypes.CatIndicesResponse> {\n    const client = await this.client();\n    const response = await client.cat.indices(\n      {\n        expand_wildcards: \"open\",\n        h: \"index\",\n        format: \"json\",\n      },\n      { signal: signal },\n    );\n    return response\n      .filter((record) => record.index && !record.index.startsWith(\".\")) // Exclude system indices\n      .map((record) => ({ index: record.index }));\n  }\n\n  protected async getIndexDetails(\n    input: ToolInput<this>,\n    signal: AbortSignal,\n  ): Promise<ESTypes.IndicesGetMappingResponse> {\n    const client = await this.client();\n    return await client.indices.getMapping(\n      {\n        index: input.indexName,\n      },\n      { signal: signal },\n    );\n  }\n\n  protected async search(\n    input: ToolInput<this>,\n    signal: AbortSignal,\n  ): Promise<ESTypes.SearchResponse> {\n    const parsedQuery = parseBrokenJson(input.query);\n    const searchBody: ESTypes.SearchRequest = {\n      ...parsedQuery,\n      from: parsedQuery.from || input.start,\n      size: parsedQuery.size || input.size,\n    };\n    const client = await this.client();\n    return await client.search(\n      {\n        index: input.indexName,\n        body: searchBody,\n      },\n      { signal: signal },\n    );\n  }\n}\n"]}

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

@@ -0,0 +1,78 @@
+import { BaseToolOptions, Tool, JSONToolOutput, ToolEmitter, ToolInput, BaseToolRunOptions } from '../base.cjs';
+import { RunContext } from '../../context.cjs';
+import { z } from 'zod';
+import { AnyToolSchemaLike } from '../../internals/helpers/schema.cjs';
+import { ClientOptions, estypes, Client } from '@elastic/elasticsearch';
+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 '../../emitter-BWtGHYn0.cjs';
+import '../../internals/helpers/promise.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 ElasticSearchToolOptions extends BaseToolOptions {
+    connection: ClientOptions;
+}
+type ElasticSearchToolResult = estypes.CatIndicesResponse | estypes.IndicesGetMappingResponse | estypes.SearchResponse;
+declare const ElasticSearchAction: {
+    readonly ListIndices: "LIST_INDICES";
+    readonly GetIndexDetails: "GET_INDEX_DETAILS";
+    readonly Search: "SEARCH";
+};
+declare class ElasticSearchTool extends Tool<JSONToolOutput<ElasticSearchToolResult>, ElasticSearchToolOptions> {
+    name: string;
+    description: string;
+    inputSchema(): z.ZodObject<{
+        action: z.ZodNativeEnum<{
+            readonly ListIndices: "LIST_INDICES";
+            readonly GetIndexDetails: "GET_INDEX_DETAILS";
+            readonly Search: "SEARCH";
+        }>;
+        indexName: z.ZodOptional<z.ZodString>;
+        query: z.ZodOptional<z.ZodString>;
+        start: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        size: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    }, "strip", z.ZodTypeAny, {
+        action: "LIST_INDICES" | "GET_INDEX_DETAILS" | "SEARCH";
+        start?: number | undefined;
+        indexName?: string | undefined;
+        query?: string | undefined;
+        size?: number | undefined;
+    }, {
+        action: "LIST_INDICES" | "GET_INDEX_DETAILS" | "SEARCH";
+        start?: number | undefined;
+        indexName?: string | undefined;
+        query?: string | undefined;
+        size?: number | undefined;
+    }>;
+    readonly emitter: ToolEmitter<ToolInput<this>, JSONToolOutput<ElasticSearchToolResult>>;
+    protected validateInput(schema: AnyToolSchemaLike, input: unknown): asserts input is ToolInput<this>;
+    constructor(options: ElasticSearchToolOptions);
+    protected client(): Promise<Client>;
+    protected _run(input: ToolInput<this>, _options: Partial<BaseToolRunOptions>, run: RunContext<this>): Promise<JSONToolOutput<any>>;
+    protected listIndices(signal?: AbortSignal): Promise<estypes.CatIndicesResponse>;
+    protected getIndexDetails(input: ToolInput<this>, signal: AbortSignal): Promise<estypes.IndicesGetMappingResponse>;
+    protected search(input: ToolInput<this>, signal: AbortSignal): Promise<estypes.SearchResponse>;
+}
+
+export { ElasticSearchAction, ElasticSearchTool, type ElasticSearchToolOptions, type ElasticSearchToolResult };

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

@@ -0,0 +1,78 @@
+import { BaseToolOptions, Tool, JSONToolOutput, ToolEmitter, ToolInput, BaseToolRunOptions } from '../base.js';
+import { RunContext } from '../../context.js';
+import { z } from 'zod';
+import { AnyToolSchemaLike } from '../../internals/helpers/schema.js';
+import { ClientOptions, estypes, Client } from '@elastic/elasticsearch';
+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 '../../emitter-l0W9gC1A.js';
+import '../../internals/helpers/promise.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 ElasticSearchToolOptions extends BaseToolOptions {
+    connection: ClientOptions;
+}
+type ElasticSearchToolResult = estypes.CatIndicesResponse | estypes.IndicesGetMappingResponse | estypes.SearchResponse;
+declare const ElasticSearchAction: {
+    readonly ListIndices: "LIST_INDICES";
+    readonly GetIndexDetails: "GET_INDEX_DETAILS";
+    readonly Search: "SEARCH";
+};
+declare class ElasticSearchTool extends Tool<JSONToolOutput<ElasticSearchToolResult>, ElasticSearchToolOptions> {
+    name: string;
+    description: string;
+    inputSchema(): z.ZodObject<{
+        action: z.ZodNativeEnum<{
+            readonly ListIndices: "LIST_INDICES";
+            readonly GetIndexDetails: "GET_INDEX_DETAILS";
+            readonly Search: "SEARCH";
+        }>;
+        indexName: z.ZodOptional<z.ZodString>;
+        query: z.ZodOptional<z.ZodString>;
+        start: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+        size: z.ZodOptional<z.ZodDefault<z.ZodNumber>>;
+    }, "strip", z.ZodTypeAny, {
+        action: "LIST_INDICES" | "GET_INDEX_DETAILS" | "SEARCH";
+        start?: number | undefined;
+        indexName?: string | undefined;
+        query?: string | undefined;
+        size?: number | undefined;
+    }, {
+        action: "LIST_INDICES" | "GET_INDEX_DETAILS" | "SEARCH";
+        start?: number | undefined;
+        indexName?: string | undefined;
+        query?: string | undefined;
+        size?: number | undefined;
+    }>;
+    readonly emitter: ToolEmitter<ToolInput<this>, JSONToolOutput<ElasticSearchToolResult>>;
+    protected validateInput(schema: AnyToolSchemaLike, input: unknown): asserts input is ToolInput<this>;
+    constructor(options: ElasticSearchToolOptions);
+    protected client(): Promise<Client>;
+    protected _run(input: ToolInput<this>, _options: Partial<BaseToolRunOptions>, run: RunContext<this>): Promise<JSONToolOutput<any>>;
+    protected listIndices(signal?: AbortSignal): Promise<estypes.CatIndicesResponse>;
+    protected getIndexDetails(input: ToolInput<this>, signal: AbortSignal): Promise<estypes.IndicesGetMappingResponse>;
+    protected search(input: ToolInput<this>, signal: AbortSignal): Promise<estypes.SearchResponse>;
+}
+
+export { ElasticSearchAction, ElasticSearchTool, type ElasticSearchToolOptions, type ElasticSearchToolResult };

package/dist/tools/database/elasticsearch.js

@@ -0,0 +1,154 @@
+import { Tool, ToolInputValidationError, ToolError, JSONToolOutput } from '../base.js';
+import { Cache } from '../../cache/decoratorCache.js';
+import { z } from 'zod';
+import { ValidationError } from 'ajv';
+import { parseBrokenJson } from '../../internals/helpers/schema.js';
+import { Client } from '@elastic/elasticsearch';
+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 ElasticSearchAction = {
+  ListIndices: "LIST_INDICES",
+  GetIndexDetails: "GET_INDEX_DETAILS",
+  Search: "SEARCH"
+};
+class ElasticSearchTool extends Tool {
+  static {
+    __name(this, "ElasticSearchTool");
+  }
+  name = "ElasticSearchTool";
+  description = `Can query data from an ElasticSearch database. IMPORTANT: strictly follow this order of actions:
+   1. ${ElasticSearchAction.ListIndices} - retrieve a list of available indices
+   2. ${ElasticSearchAction.GetIndexDetails} - get details of index fields
+   3. ${ElasticSearchAction.Search} - perform search or aggregation query on a specific index or pass the original user query without modifications if it's a valid JSON ElasticSearch query after identifying the index`;
+  inputSchema() {
+    return z.object({
+      action: z.nativeEnum(ElasticSearchAction).describe(`The action to perform. ${ElasticSearchAction.ListIndices} lists all indices, ${ElasticSearchAction.GetIndexDetails} fetches details for a specified index, and ${ElasticSearchAction.Search} executes a search or aggregation query`),
+      indexName: z.string().optional().describe(`The name of the index to query, required for ${ElasticSearchAction.GetIndexDetails} and ${ElasticSearchAction.Search}`),
+      query: z.string().optional().describe(`Valid ElasticSearch JSON search or aggregation query for ${ElasticSearchAction.Search} action`),
+      start: z.coerce.number().int().min(0).default(0).optional().describe("The record index from which the query will start. Increase by the size of the query to get the next page of results"),
+      size: z.coerce.number().int().min(0).max(10).default(10).optional().describe("How many records will be retrieved from the ElasticSearch query. Maximum is 10")
+    });
+  }
+  emitter = Emitter.root.child({
+    namespace: [
+      "tool",
+      "database",
+      "elasticsearch"
+    ],
+    creator: this
+  });
+  validateInput(schema, input) {
+    super.validateInput(schema, input);
+    if (input.action === ElasticSearchAction.GetIndexDetails && !input.indexName) {
+      throw new ToolInputValidationError(`Index name is required for ${ElasticSearchAction.GetIndexDetails} action.`);
+    }
+    if (input.action === ElasticSearchAction.Search && (!input.indexName || !input.query)) {
+      throw new ToolInputValidationError(`Both index name and query are required for ${ElasticSearchAction.Search} action.`);
+    }
+  }
+  static {
+    this.register();
+  }
+  constructor(options) {
+    super(options);
+    if (!options.connection.cloud && !options.connection.node && !options.connection.nodes) {
+      throw new ValidationError([
+        {
+          message: "At least one of the properties must be provided",
+          propertyName: "connection.cloud, connection.node, connection.nodes"
+        }
+      ]);
+    }
+  }
+  async client() {
+    try {
+      const client = new Client(this.options.connection);
+      await client.info();
+      return client;
+    } catch (error) {
+      throw new ToolError(`Unable to connect to ElasticSearch.`, [
+        error
+      ], {
+        isRetryable: false,
+        isFatal: true
+      });
+    }
+  }
+  async _run(input, _options, run) {
+    if (input.action === ElasticSearchAction.ListIndices) {
+      const indices = await this.listIndices(run.signal);
+      return new JSONToolOutput(indices);
+    } else if (input.action === ElasticSearchAction.GetIndexDetails) {
+      const indexDetails = await this.getIndexDetails(input, run.signal);
+      return new JSONToolOutput(indexDetails);
+    } else if (input.action === ElasticSearchAction.Search) {
+      const response = await this.search(input, run.signal);
+      if (response.aggregations) {
+        return new JSONToolOutput(response.aggregations);
+      } else {
+        return new JSONToolOutput(response.hits.hits.map((hit) => hit._source));
+      }
+    } else {
+      throw new ToolError(`Invalid action specified: ${input.action}`);
+    }
+  }
+  async listIndices(signal) {
+    const client = await this.client();
+    const response = await client.cat.indices({
+      expand_wildcards: "open",
+      h: "index",
+      format: "json"
+    }, {
+      signal
+    });
+    return response.filter((record) => record.index && !record.index.startsWith(".")).map((record) => ({
+      index: record.index
+    }));
+  }
+  async getIndexDetails(input, signal) {
+    const client = await this.client();
+    return await client.indices.getMapping({
+      index: input.indexName
+    }, {
+      signal
+    });
+  }
+  async search(input, signal) {
+    const parsedQuery = parseBrokenJson(input.query);
+    const searchBody = {
+      ...parsedQuery,
+      from: parsedQuery.from || input.start,
+      size: parsedQuery.size || input.size
+    };
+    const client = await this.client();
+    return await client.search({
+      index: input.indexName,
+      body: searchBody
+    }, {
+      signal
+    });
+  }
+}
+_ts_decorate([
+  Cache(),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", []),
+  _ts_metadata("design:returntype", Promise)
+], ElasticSearchTool.prototype, "client", null);
+
+export { ElasticSearchAction, ElasticSearchTool };
+//# sourceMappingURL=elasticsearch.js.map
+//# sourceMappingURL=elasticsearch.js.map