@agentforge/tools 0.8.1 → 0.9.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import * as _agentforge_core from '@agentforge/core';
-import { HumanRequestPriority } from '@agentforge/core';
+import { LogLevel, Tool, HumanRequestPriority } from '@agentforge/core';
 import { z } from 'zod';
 
 /**
@@ -466,6 +466,300 @@ declare const webSearch: _agentforge_core.Tool<{
     preferSerper?: boolean | undefined;
 }, WebSearchOutput>;
 
+/**
+ * Slack Integration Tools
+ *
+ * Tools for interacting with Slack workspaces - send messages, notifications,
+ * list channels, and read message history.
+ *
+ * @example
+ * ```ts
+ * // Using default tools (reads from env vars)
+ * import { sendSlackMessage } from '@agentforge/tools';
+ *
+ * const result = await sendSlackMessage.execute({
+ *   channel: 'general',
+ *   message: 'Hello from AgentForge!'
+ * });
+ *
+ * // Using factory function with custom config
+ * import { createSlackTools } from '@agentforge/tools';
+ *
+ * const slackTools = createSlackTools({
+ *   token: 'xoxb-your-bot-token',
+ *   botName: 'My Custom Bot'
+ * });
+ *
+ * const result = await slackTools.sendMessage.execute({
+ *   channel: 'general',
+ *   message: 'Hello!'
+ * });
+ * ```
+ */
+
+/**
+ * Configuration options for Slack tools
+ */
+interface SlackToolsConfig {
+    /**
+     * Slack API token (bot or user token)
+     * If not provided, will fall back to SLACK_USER_TOKEN or SLACK_BOT_TOKEN env vars
+     */
+    token?: string;
+    /**
+     * Custom bot name to display in Slack
+     * @default 'AgentForge Bot'
+     */
+    botName?: string;
+    /**
+     * Custom bot icon emoji
+     * @default ':robot_face:'
+     */
+    botIcon?: string;
+    /**
+     * Log level for Slack tools
+     * @default LogLevel.INFO
+     */
+    logLevel?: LogLevel;
+}
+/**
+ * Send a message to a Slack channel
+ */
+declare const sendSlackMessage: Tool<{
+    message: string;
+    channel: string;
+}, {
+    success: boolean;
+    data?: {
+        channel: string | undefined;
+        message: string;
+        timestamp: string | undefined;
+        message_id: string | undefined;
+    } | undefined;
+    error?: string;
+}>;
+/**
+ * Send a notification to a Slack channel (with @mention support)
+ */
+declare const notifySlack: Tool<{
+    message: string;
+    channel: string;
+    mentions?: string[] | undefined;
+}, {
+    success: boolean;
+    data?: {
+        channel: string | undefined;
+        message: string;
+        mentions: string[];
+        timestamp: string | undefined;
+        notification_id: string | undefined;
+    } | undefined;
+    error?: string;
+}>;
+/**
+ * Get list of available Slack channels
+ */
+declare const getSlackChannels: Tool<{
+    include_private?: boolean | undefined;
+}, {
+    success: boolean;
+    data?: {
+        count: number;
+        channels: {
+            id: string | undefined;
+            name: string | undefined;
+            is_private: boolean;
+            num_members: number;
+        }[];
+    } | undefined;
+    error?: string;
+}>;
+/**
+ * Get message history from a Slack channel
+ */
+declare const getSlackMessages: Tool<{
+    channel: string;
+    limit?: number | undefined;
+}, {
+    success: boolean;
+    data?: {
+        channel: string;
+        count: number;
+        messages: {
+            user: string;
+            text: string;
+            timestamp: string | undefined;
+            thread_ts: string | undefined;
+            type: string | undefined;
+            subtype: string | undefined;
+        }[];
+    } | undefined;
+    error?: string;
+}>;
+/**
+ * Create Slack tools with custom configuration
+ *
+ * This factory function allows you to create Slack tools with custom configuration,
+ * such as providing a token programmatically instead of using environment variables.
+ *
+ * @param config - Configuration options for Slack tools
+ * @returns Object containing all 4 Slack tools configured with the provided options
+ *
+ * @example
+ * ```ts
+ * // Create tools with custom token
+ * const slackTools = createSlackTools({
+ *   token: 'xoxb-your-bot-token',
+ *   botName: 'My Custom Bot',
+ *   botIcon: ':rocket:'
+ * });
+ *
+ * // Use the tools
+ * await slackTools.sendMessage.execute({
+ *   channel: 'general',
+ *   message: 'Hello!'
+ * });
+ *
+ * // Or use with an agent
+ * const agent = createReActAgent({
+ *   llm,
+ *   tools: [
+ *     slackTools.sendMessage,
+ *     slackTools.notify,
+ *     slackTools.getChannels,
+ *     slackTools.getMessages
+ *   ]
+ * });
+ * ```
+ */
+declare function createSlackTools(config?: SlackToolsConfig): {
+    sendMessage: Tool<{
+        message: string;
+        channel: string;
+    }, {
+        success: boolean;
+        data?: {
+            channel: string | undefined;
+            message: string;
+            timestamp: string | undefined;
+            message_id: string | undefined;
+        } | undefined;
+        error?: string;
+    }>;
+    notify: Tool<{
+        message: string;
+        channel: string;
+        mentions?: string[] | undefined;
+    }, {
+        success: boolean;
+        data?: {
+            channel: string | undefined;
+            message: string;
+            mentions: string[];
+            timestamp: string | undefined;
+            notification_id: string | undefined;
+        } | undefined;
+        error?: string;
+    }>;
+    getChannels: Tool<{
+        include_private?: boolean | undefined;
+    }, {
+        success: boolean;
+        data?: {
+            count: number;
+            channels: {
+                id: string | undefined;
+                name: string | undefined;
+                is_private: boolean;
+                num_members: number;
+            }[];
+        } | undefined;
+        error?: string;
+    }>;
+    getMessages: Tool<{
+        channel: string;
+        limit?: number | undefined;
+    }, {
+        success: boolean;
+        data?: {
+            channel: string;
+            count: number;
+            messages: {
+                user: string;
+                text: string;
+                timestamp: string | undefined;
+                thread_ts: string | undefined;
+                type: string | undefined;
+                subtype: string | undefined;
+            }[];
+        } | undefined;
+        error?: string;
+    }>;
+};
+/**
+ * Export all Slack tools as an array for convenience
+ * These use environment variables for configuration (SLACK_USER_TOKEN or SLACK_BOT_TOKEN)
+ */
+declare const slackTools: (Tool<{
+    message: string;
+    channel: string;
+}, {
+    success: boolean;
+    data?: {
+        channel: string | undefined;
+        message: string;
+        timestamp: string | undefined;
+        message_id: string | undefined;
+    } | undefined;
+    error?: string;
+}> | Tool<{
+    message: string;
+    channel: string;
+    mentions?: string[] | undefined;
+}, {
+    success: boolean;
+    data?: {
+        channel: string | undefined;
+        message: string;
+        mentions: string[];
+        timestamp: string | undefined;
+        notification_id: string | undefined;
+    } | undefined;
+    error?: string;
+}> | Tool<{
+    include_private?: boolean | undefined;
+}, {
+    success: boolean;
+    data?: {
+        count: number;
+        channels: {
+            id: string | undefined;
+            name: string | undefined;
+            is_private: boolean;
+            num_members: number;
+        }[];
+    } | undefined;
+    error?: string;
+}> | Tool<{
+    channel: string;
+    limit?: number | undefined;
+}, {
+    success: boolean;
+    data?: {
+        channel: string;
+        count: number;
+        messages: {
+            user: string;
+            text: string;
+            timestamp: string | undefined;
+            thread_ts: string | undefined;
+            type: string | undefined;
+            subtype: string | undefined;
+        }[];
+    } | undefined;
+    error?: string;
+}>)[];
+
 /**
  * JSON Processor Tool
  *
@@ -1494,4 +1788,4 @@ declare const askHumanTool: _agentforge_core.Tool<{
     suggestions?: string[] | undefined;
 }, AskHumanOutput>;
 
-export { type AskHumanInput, AskHumanInputSchema, type AskHumanOutput, DuckDuckGoProvider, type HttpResponse, type RetryConfig, type ScraperResult, type SearchProvider, type SearchResult, SerperProvider, type UrlValidationResult, type WebSearchInput, type WebSearchOutput, arrayFilter, arrayGroupBy, arrayMap, arraySort, askHumanTool, calculator, createAskHumanTool, createDuckDuckGoProvider, createSerperProvider, creditCardValidator, csvGenerator, csvParser, csvToJson, currentDateTime, dateArithmetic, dateComparison, dateDifference, dateFormatter, directoryCreate, directoryDelete, directoryList, emailValidator, extractImages, extractLinks, fileAppend, fileDelete, fileExists, fileReader, fileSearch, fileWriter, htmlParser, httpClient, httpGet, httpPost, ipValidator, jsonMerge, jsonParser, jsonQuery, jsonStringify, jsonToCsv, jsonToXml, jsonValidator, mathFunctions, objectOmit, objectPick, pathBasename, pathDirname, pathExtension, pathJoin, pathNormalize, pathParse, pathRelative, pathResolve, phoneValidator, randomNumber, searchResultSchema, statistics, stringCaseConverter, stringJoin, stringLength, stringReplace, stringSplit, stringSubstring, stringTrim, urlBuilder, urlQueryParser, urlValidator, urlValidatorSimple, uuidValidator, webScraper, webSearch, webSearchOutputSchema, webSearchSchema, xmlGenerator, xmlParser, xmlToJson };
+export { type AskHumanInput, AskHumanInputSchema, type AskHumanOutput, DuckDuckGoProvider, type HttpResponse, type RetryConfig, type ScraperResult, type SearchProvider, type SearchResult, SerperProvider, type SlackToolsConfig, type UrlValidationResult, type WebSearchInput, type WebSearchOutput, arrayFilter, arrayGroupBy, arrayMap, arraySort, askHumanTool, calculator, createAskHumanTool, createDuckDuckGoProvider, createSerperProvider, createSlackTools, creditCardValidator, csvGenerator, csvParser, csvToJson, currentDateTime, dateArithmetic, dateComparison, dateDifference, dateFormatter, directoryCreate, directoryDelete, directoryList, emailValidator, extractImages, extractLinks, fileAppend, fileDelete, fileExists, fileReader, fileSearch, fileWriter, getSlackChannels, getSlackMessages, htmlParser, httpClient, httpGet, httpPost, ipValidator, jsonMerge, jsonParser, jsonQuery, jsonStringify, jsonToCsv, jsonToXml, jsonValidator, mathFunctions, notifySlack, objectOmit, objectPick, pathBasename, pathDirname, pathExtension, pathJoin, pathNormalize, pathParse, pathRelative, pathResolve, phoneValidator, randomNumber, searchResultSchema, sendSlackMessage, slackTools, statistics, stringCaseConverter, stringJoin, stringLength, stringReplace, stringSplit, stringSubstring, stringTrim, urlBuilder, urlQueryParser, urlValidator, urlValidatorSimple, uuidValidator, webScraper, webSearch, webSearchOutputSchema, webSearchSchema, xmlGenerator, xmlParser, xmlToJson };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _agentforge_core from '@agentforge/core';
-import { HumanRequestPriority } from '@agentforge/core';
+import { LogLevel, Tool, HumanRequestPriority } from '@agentforge/core';
 import { z } from 'zod';
 
 /**
@@ -466,6 +466,300 @@ declare const webSearch: _agentforge_core.Tool<{
     preferSerper?: boolean | undefined;
 }, WebSearchOutput>;
 
+/**
+ * Slack Integration Tools
+ *
+ * Tools for interacting with Slack workspaces - send messages, notifications,
+ * list channels, and read message history.
+ *
+ * @example
+ * ```ts
+ * // Using default tools (reads from env vars)
+ * import { sendSlackMessage } from '@agentforge/tools';
+ *
+ * const result = await sendSlackMessage.execute({
+ *   channel: 'general',
+ *   message: 'Hello from AgentForge!'
+ * });
+ *
+ * // Using factory function with custom config
+ * import { createSlackTools } from '@agentforge/tools';
+ *
+ * const slackTools = createSlackTools({
+ *   token: 'xoxb-your-bot-token',
+ *   botName: 'My Custom Bot'
+ * });
+ *
+ * const result = await slackTools.sendMessage.execute({
+ *   channel: 'general',
+ *   message: 'Hello!'
+ * });
+ * ```
+ */
+
+/**
+ * Configuration options for Slack tools
+ */
+interface SlackToolsConfig {
+    /**
+     * Slack API token (bot or user token)
+     * If not provided, will fall back to SLACK_USER_TOKEN or SLACK_BOT_TOKEN env vars
+     */
+    token?: string;
+    /**
+     * Custom bot name to display in Slack
+     * @default 'AgentForge Bot'
+     */
+    botName?: string;
+    /**
+     * Custom bot icon emoji
+     * @default ':robot_face:'
+     */
+    botIcon?: string;
+    /**
+     * Log level for Slack tools
+     * @default LogLevel.INFO
+     */
+    logLevel?: LogLevel;
+}
+/**
+ * Send a message to a Slack channel
+ */
+declare const sendSlackMessage: Tool<{
+    message: string;
+    channel: string;
+}, {
+    success: boolean;
+    data?: {
+        channel: string | undefined;
+        message: string;
+        timestamp: string | undefined;
+        message_id: string | undefined;
+    } | undefined;
+    error?: string;
+}>;
+/**
+ * Send a notification to a Slack channel (with @mention support)
+ */
+declare const notifySlack: Tool<{
+    message: string;
+    channel: string;
+    mentions?: string[] | undefined;
+}, {
+    success: boolean;
+    data?: {
+        channel: string | undefined;
+        message: string;
+        mentions: string[];
+        timestamp: string | undefined;
+        notification_id: string | undefined;
+    } | undefined;
+    error?: string;
+}>;
+/**
+ * Get list of available Slack channels
+ */
+declare const getSlackChannels: Tool<{
+    include_private?: boolean | undefined;
+}, {
+    success: boolean;
+    data?: {
+        count: number;
+        channels: {
+            id: string | undefined;
+            name: string | undefined;
+            is_private: boolean;
+            num_members: number;
+        }[];
+    } | undefined;
+    error?: string;
+}>;
+/**
+ * Get message history from a Slack channel
+ */
+declare const getSlackMessages: Tool<{
+    channel: string;
+    limit?: number | undefined;
+}, {
+    success: boolean;
+    data?: {
+        channel: string;
+        count: number;
+        messages: {
+            user: string;
+            text: string;
+            timestamp: string | undefined;
+            thread_ts: string | undefined;
+            type: string | undefined;
+            subtype: string | undefined;
+        }[];
+    } | undefined;
+    error?: string;
+}>;
+/**
+ * Create Slack tools with custom configuration
+ *
+ * This factory function allows you to create Slack tools with custom configuration,
+ * such as providing a token programmatically instead of using environment variables.
+ *
+ * @param config - Configuration options for Slack tools
+ * @returns Object containing all 4 Slack tools configured with the provided options
+ *
+ * @example
+ * ```ts
+ * // Create tools with custom token
+ * const slackTools = createSlackTools({
+ *   token: 'xoxb-your-bot-token',
+ *   botName: 'My Custom Bot',
+ *   botIcon: ':rocket:'
+ * });
+ *
+ * // Use the tools
+ * await slackTools.sendMessage.execute({
+ *   channel: 'general',
+ *   message: 'Hello!'
+ * });
+ *
+ * // Or use with an agent
+ * const agent = createReActAgent({
+ *   llm,
+ *   tools: [
+ *     slackTools.sendMessage,
+ *     slackTools.notify,
+ *     slackTools.getChannels,
+ *     slackTools.getMessages
+ *   ]
+ * });
+ * ```
+ */
+declare function createSlackTools(config?: SlackToolsConfig): {
+    sendMessage: Tool<{
+        message: string;
+        channel: string;
+    }, {
+        success: boolean;
+        data?: {
+            channel: string | undefined;
+            message: string;
+            timestamp: string | undefined;
+            message_id: string | undefined;
+        } | undefined;
+        error?: string;
+    }>;
+    notify: Tool<{
+        message: string;
+        channel: string;
+        mentions?: string[] | undefined;
+    }, {
+        success: boolean;
+        data?: {
+            channel: string | undefined;
+            message: string;
+            mentions: string[];
+            timestamp: string | undefined;
+            notification_id: string | undefined;
+        } | undefined;
+        error?: string;
+    }>;
+    getChannels: Tool<{
+        include_private?: boolean | undefined;
+    }, {
+        success: boolean;
+        data?: {
+            count: number;
+            channels: {
+                id: string | undefined;
+                name: string | undefined;
+                is_private: boolean;
+                num_members: number;
+            }[];
+        } | undefined;
+        error?: string;
+    }>;
+    getMessages: Tool<{
+        channel: string;
+        limit?: number | undefined;
+    }, {
+        success: boolean;
+        data?: {
+            channel: string;
+            count: number;
+            messages: {
+                user: string;
+                text: string;
+                timestamp: string | undefined;
+                thread_ts: string | undefined;
+                type: string | undefined;
+                subtype: string | undefined;
+            }[];
+        } | undefined;
+        error?: string;
+    }>;
+};
+/**
+ * Export all Slack tools as an array for convenience
+ * These use environment variables for configuration (SLACK_USER_TOKEN or SLACK_BOT_TOKEN)
+ */
+declare const slackTools: (Tool<{
+    message: string;
+    channel: string;
+}, {
+    success: boolean;
+    data?: {
+        channel: string | undefined;
+        message: string;
+        timestamp: string | undefined;
+        message_id: string | undefined;
+    } | undefined;
+    error?: string;
+}> | Tool<{
+    message: string;
+    channel: string;
+    mentions?: string[] | undefined;
+}, {
+    success: boolean;
+    data?: {
+        channel: string | undefined;
+        message: string;
+        mentions: string[];
+        timestamp: string | undefined;
+        notification_id: string | undefined;
+    } | undefined;
+    error?: string;
+}> | Tool<{
+    include_private?: boolean | undefined;
+}, {
+    success: boolean;
+    data?: {
+        count: number;
+        channels: {
+            id: string | undefined;
+            name: string | undefined;
+            is_private: boolean;
+            num_members: number;
+        }[];
+    } | undefined;
+    error?: string;
+}> | Tool<{
+    channel: string;
+    limit?: number | undefined;
+}, {
+    success: boolean;
+    data?: {
+        channel: string;
+        count: number;
+        messages: {
+            user: string;
+            text: string;
+            timestamp: string | undefined;
+            thread_ts: string | undefined;
+            type: string | undefined;
+            subtype: string | undefined;
+        }[];
+    } | undefined;
+    error?: string;
+}>)[];
+
 /**
  * JSON Processor Tool
  *
@@ -1494,4 +1788,4 @@ declare const askHumanTool: _agentforge_core.Tool<{
     suggestions?: string[] | undefined;
 }, AskHumanOutput>;
 
-export { type AskHumanInput, AskHumanInputSchema, type AskHumanOutput, DuckDuckGoProvider, type HttpResponse, type RetryConfig, type ScraperResult, type SearchProvider, type SearchResult, SerperProvider, type UrlValidationResult, type WebSearchInput, type WebSearchOutput, arrayFilter, arrayGroupBy, arrayMap, arraySort, askHumanTool, calculator, createAskHumanTool, createDuckDuckGoProvider, createSerperProvider, creditCardValidator, csvGenerator, csvParser, csvToJson, currentDateTime, dateArithmetic, dateComparison, dateDifference, dateFormatter, directoryCreate, directoryDelete, directoryList, emailValidator, extractImages, extractLinks, fileAppend, fileDelete, fileExists, fileReader, fileSearch, fileWriter, htmlParser, httpClient, httpGet, httpPost, ipValidator, jsonMerge, jsonParser, jsonQuery, jsonStringify, jsonToCsv, jsonToXml, jsonValidator, mathFunctions, objectOmit, objectPick, pathBasename, pathDirname, pathExtension, pathJoin, pathNormalize, pathParse, pathRelative, pathResolve, phoneValidator, randomNumber, searchResultSchema, statistics, stringCaseConverter, stringJoin, stringLength, stringReplace, stringSplit, stringSubstring, stringTrim, urlBuilder, urlQueryParser, urlValidator, urlValidatorSimple, uuidValidator, webScraper, webSearch, webSearchOutputSchema, webSearchSchema, xmlGenerator, xmlParser, xmlToJson };
+export { type AskHumanInput, AskHumanInputSchema, type AskHumanOutput, DuckDuckGoProvider, type HttpResponse, type RetryConfig, type ScraperResult, type SearchProvider, type SearchResult, SerperProvider, type SlackToolsConfig, type UrlValidationResult, type WebSearchInput, type WebSearchOutput, arrayFilter, arrayGroupBy, arrayMap, arraySort, askHumanTool, calculator, createAskHumanTool, createDuckDuckGoProvider, createSerperProvider, createSlackTools, creditCardValidator, csvGenerator, csvParser, csvToJson, currentDateTime, dateArithmetic, dateComparison, dateDifference, dateFormatter, directoryCreate, directoryDelete, directoryList, emailValidator, extractImages, extractLinks, fileAppend, fileDelete, fileExists, fileReader, fileSearch, fileWriter, getSlackChannels, getSlackMessages, htmlParser, httpClient, httpGet, httpPost, ipValidator, jsonMerge, jsonParser, jsonQuery, jsonStringify, jsonToCsv, jsonToXml, jsonValidator, mathFunctions, notifySlack, objectOmit, objectPick, pathBasename, pathDirname, pathExtension, pathJoin, pathNormalize, pathParse, pathRelative, pathResolve, phoneValidator, randomNumber, searchResultSchema, sendSlackMessage, slackTools, statistics, stringCaseConverter, stringJoin, stringLength, stringReplace, stringSplit, stringSubstring, stringTrim, urlBuilder, urlQueryParser, urlValidator, urlValidatorSimple, uuidValidator, webScraper, webSearch, webSearchOutputSchema, webSearchSchema, xmlGenerator, xmlParser, xmlToJson };