@agentforge/tools 0.9.1 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.cts CHANGED
@@ -760,6 +760,104 @@ declare const slackTools: (Tool<{
760
760
  error?: string;
761
761
  }>)[];
762
762
 
763
+ /**
764
+ * Type definitions for Confluence tools
765
+ */
766
+
767
+ /**
768
+ * Configuration options for Confluence tools
769
+ */
770
+ interface ConfluenceToolsConfig {
771
+ /**
772
+ * Atlassian API key
773
+ * If not provided, will fall back to ATLASSIAN_API_KEY env var
774
+ */
775
+ apiKey?: string;
776
+ /**
777
+ * Atlassian account email
778
+ * If not provided, will fall back to ATLASSIAN_EMAIL env var
779
+ */
780
+ email?: string;
781
+ /**
782
+ * Atlassian site URL (e.g., 'https://your-domain.atlassian.net')
783
+ * If not provided, will fall back to ATLASSIAN_SITE_URL env var
784
+ */
785
+ siteUrl?: string;
786
+ /**
787
+ * Custom log level for Confluence tools
788
+ * @default LogLevel.INFO
789
+ */
790
+ logLevel?: LogLevel;
791
+ }
792
+ /**
793
+ * Confluence authentication credentials
794
+ */
795
+ interface ConfluenceAuth {
796
+ ATLASSIAN_API_KEY: string;
797
+ ATLASSIAN_EMAIL: string;
798
+ ATLASSIAN_SITE_URL: string;
799
+ }
800
+
801
+ /**
802
+ * Default Confluence tools using environment variables
803
+ */
804
+ declare const searchConfluence: _agentforge_core.Tool<unknown, unknown>;
805
+ declare const getConfluencePage: _agentforge_core.Tool<unknown, unknown>;
806
+ declare const listConfluenceSpaces: _agentforge_core.Tool<unknown, unknown>;
807
+ declare const getSpacePages: _agentforge_core.Tool<unknown, unknown>;
808
+ declare const createConfluencePage: _agentforge_core.Tool<unknown, unknown>;
809
+ declare const updateConfluencePage: _agentforge_core.Tool<unknown, unknown>;
810
+ declare const archiveConfluencePage: _agentforge_core.Tool<unknown, unknown>;
811
+ /**
812
+ * Export all Confluence tools
813
+ *
814
+ * Includes 7 tools for Confluence integration:
815
+ * - 4 read tools: search, get-page, list-spaces, get-space-pages
816
+ * - 3 write tools: create-page, update-page, archive-page
817
+ */
818
+ declare const confluenceTools: _agentforge_core.Tool<unknown, unknown>[];
819
+ /**
820
+ * Create Confluence tools with custom configuration
821
+ *
822
+ * This factory function allows you to create Confluence tools with programmatic configuration
823
+ * instead of relying solely on environment variables.
824
+ *
825
+ * @param config - Optional configuration for Confluence tools
826
+ * @returns Object containing all 7 Confluence tools configured with the provided settings
827
+ *
828
+ * @example
829
+ * ```ts
830
+ * // Create tools with custom credentials
831
+ * const tools = createConfluenceTools({
832
+ * apiKey: 'your-api-key',
833
+ * email: 'your-email@example.com',
834
+ * siteUrl: 'https://your-domain.atlassian.net'
835
+ * });
836
+ *
837
+ * // Use the tools
838
+ * const result = await tools.searchConfluence.execute({
839
+ * query: 'payment processing'
840
+ * });
841
+ * ```
842
+ *
843
+ * @example
844
+ * ```ts
845
+ * // Create tools with custom log level
846
+ * const tools = createConfluenceTools({
847
+ * logLevel: LogLevel.DEBUG
848
+ * });
849
+ * ```
850
+ */
851
+ declare function createConfluenceTools(config?: ConfluenceToolsConfig): {
852
+ searchConfluence: _agentforge_core.Tool<unknown, unknown>;
853
+ getConfluencePage: _agentforge_core.Tool<unknown, unknown>;
854
+ listConfluenceSpaces: _agentforge_core.Tool<unknown, unknown>;
855
+ getSpacePages: _agentforge_core.Tool<unknown, unknown>;
856
+ createConfluencePage: _agentforge_core.Tool<unknown, unknown>;
857
+ updateConfluencePage: _agentforge_core.Tool<unknown, unknown>;
858
+ archiveConfluencePage: _agentforge_core.Tool<unknown, unknown>;
859
+ };
860
+
763
861
  /**
764
862
  * JSON Processor Tool
765
863
  *
@@ -1788,4 +1886,4 @@ declare const askHumanTool: _agentforge_core.Tool<{
1788
1886
  suggestions?: string[] | undefined;
1789
1887
  }, AskHumanOutput>;
1790
1888
 
1791
- 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 };
1889
+ export { type AskHumanInput, AskHumanInputSchema, type AskHumanOutput, type ConfluenceAuth, type ConfluenceToolsConfig, DuckDuckGoProvider, type HttpResponse, type RetryConfig, type ScraperResult, type SearchProvider, type SearchResult, SerperProvider, type SlackToolsConfig, type UrlValidationResult, type WebSearchInput, type WebSearchOutput, archiveConfluencePage, arrayFilter, arrayGroupBy, arrayMap, arraySort, askHumanTool, calculator, confluenceTools, createAskHumanTool, createConfluencePage, createConfluenceTools, createDuckDuckGoProvider, createSerperProvider, createSlackTools, creditCardValidator, csvGenerator, csvParser, csvToJson, currentDateTime, dateArithmetic, dateComparison, dateDifference, dateFormatter, directoryCreate, directoryDelete, directoryList, emailValidator, extractImages, extractLinks, fileAppend, fileDelete, fileExists, fileReader, fileSearch, fileWriter, getConfluencePage, getSlackChannels, getSlackMessages, getSpacePages, htmlParser, httpClient, httpGet, httpPost, ipValidator, jsonMerge, jsonParser, jsonQuery, jsonStringify, jsonToCsv, jsonToXml, jsonValidator, listConfluenceSpaces, mathFunctions, notifySlack, objectOmit, objectPick, pathBasename, pathDirname, pathExtension, pathJoin, pathNormalize, pathParse, pathRelative, pathResolve, phoneValidator, randomNumber, searchConfluence, searchResultSchema, sendSlackMessage, slackTools, statistics, stringCaseConverter, stringJoin, stringLength, stringReplace, stringSplit, stringSubstring, stringTrim, updateConfluencePage, urlBuilder, urlQueryParser, urlValidator, urlValidatorSimple, uuidValidator, webScraper, webSearch, webSearchOutputSchema, webSearchSchema, xmlGenerator, xmlParser, xmlToJson };
package/dist/index.d.ts CHANGED
@@ -760,6 +760,104 @@ declare const slackTools: (Tool<{
760
760
  error?: string;
761
761
  }>)[];
762
762
 
763
+ /**
764
+ * Type definitions for Confluence tools
765
+ */
766
+
767
+ /**
768
+ * Configuration options for Confluence tools
769
+ */
770
+ interface ConfluenceToolsConfig {
771
+ /**
772
+ * Atlassian API key
773
+ * If not provided, will fall back to ATLASSIAN_API_KEY env var
774
+ */
775
+ apiKey?: string;
776
+ /**
777
+ * Atlassian account email
778
+ * If not provided, will fall back to ATLASSIAN_EMAIL env var
779
+ */
780
+ email?: string;
781
+ /**
782
+ * Atlassian site URL (e.g., 'https://your-domain.atlassian.net')
783
+ * If not provided, will fall back to ATLASSIAN_SITE_URL env var
784
+ */
785
+ siteUrl?: string;
786
+ /**
787
+ * Custom log level for Confluence tools
788
+ * @default LogLevel.INFO
789
+ */
790
+ logLevel?: LogLevel;
791
+ }
792
+ /**
793
+ * Confluence authentication credentials
794
+ */
795
+ interface ConfluenceAuth {
796
+ ATLASSIAN_API_KEY: string;
797
+ ATLASSIAN_EMAIL: string;
798
+ ATLASSIAN_SITE_URL: string;
799
+ }
800
+
801
+ /**
802
+ * Default Confluence tools using environment variables
803
+ */
804
+ declare const searchConfluence: _agentforge_core.Tool<unknown, unknown>;
805
+ declare const getConfluencePage: _agentforge_core.Tool<unknown, unknown>;
806
+ declare const listConfluenceSpaces: _agentforge_core.Tool<unknown, unknown>;
807
+ declare const getSpacePages: _agentforge_core.Tool<unknown, unknown>;
808
+ declare const createConfluencePage: _agentforge_core.Tool<unknown, unknown>;
809
+ declare const updateConfluencePage: _agentforge_core.Tool<unknown, unknown>;
810
+ declare const archiveConfluencePage: _agentforge_core.Tool<unknown, unknown>;
811
+ /**
812
+ * Export all Confluence tools
813
+ *
814
+ * Includes 7 tools for Confluence integration:
815
+ * - 4 read tools: search, get-page, list-spaces, get-space-pages
816
+ * - 3 write tools: create-page, update-page, archive-page
817
+ */
818
+ declare const confluenceTools: _agentforge_core.Tool<unknown, unknown>[];
819
+ /**
820
+ * Create Confluence tools with custom configuration
821
+ *
822
+ * This factory function allows you to create Confluence tools with programmatic configuration
823
+ * instead of relying solely on environment variables.
824
+ *
825
+ * @param config - Optional configuration for Confluence tools
826
+ * @returns Object containing all 7 Confluence tools configured with the provided settings
827
+ *
828
+ * @example
829
+ * ```ts
830
+ * // Create tools with custom credentials
831
+ * const tools = createConfluenceTools({
832
+ * apiKey: 'your-api-key',
833
+ * email: 'your-email@example.com',
834
+ * siteUrl: 'https://your-domain.atlassian.net'
835
+ * });
836
+ *
837
+ * // Use the tools
838
+ * const result = await tools.searchConfluence.execute({
839
+ * query: 'payment processing'
840
+ * });
841
+ * ```
842
+ *
843
+ * @example
844
+ * ```ts
845
+ * // Create tools with custom log level
846
+ * const tools = createConfluenceTools({
847
+ * logLevel: LogLevel.DEBUG
848
+ * });
849
+ * ```
850
+ */
851
+ declare function createConfluenceTools(config?: ConfluenceToolsConfig): {
852
+ searchConfluence: _agentforge_core.Tool<unknown, unknown>;
853
+ getConfluencePage: _agentforge_core.Tool<unknown, unknown>;
854
+ listConfluenceSpaces: _agentforge_core.Tool<unknown, unknown>;
855
+ getSpacePages: _agentforge_core.Tool<unknown, unknown>;
856
+ createConfluencePage: _agentforge_core.Tool<unknown, unknown>;
857
+ updateConfluencePage: _agentforge_core.Tool<unknown, unknown>;
858
+ archiveConfluencePage: _agentforge_core.Tool<unknown, unknown>;
859
+ };
860
+
763
861
  /**
764
862
  * JSON Processor Tool
765
863
  *
@@ -1788,4 +1886,4 @@ declare const askHumanTool: _agentforge_core.Tool<{
1788
1886
  suggestions?: string[] | undefined;
1789
1887
  }, AskHumanOutput>;
1790
1888
 
1791
- 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 };
1889
+ export { type AskHumanInput, AskHumanInputSchema, type AskHumanOutput, type ConfluenceAuth, type ConfluenceToolsConfig, DuckDuckGoProvider, type HttpResponse, type RetryConfig, type ScraperResult, type SearchProvider, type SearchResult, SerperProvider, type SlackToolsConfig, type UrlValidationResult, type WebSearchInput, type WebSearchOutput, archiveConfluencePage, arrayFilter, arrayGroupBy, arrayMap, arraySort, askHumanTool, calculator, confluenceTools, createAskHumanTool, createConfluencePage, createConfluenceTools, createDuckDuckGoProvider, createSerperProvider, createSlackTools, creditCardValidator, csvGenerator, csvParser, csvToJson, currentDateTime, dateArithmetic, dateComparison, dateDifference, dateFormatter, directoryCreate, directoryDelete, directoryList, emailValidator, extractImages, extractLinks, fileAppend, fileDelete, fileExists, fileReader, fileSearch, fileWriter, getConfluencePage, getSlackChannels, getSlackMessages, getSpacePages, htmlParser, httpClient, httpGet, httpPost, ipValidator, jsonMerge, jsonParser, jsonQuery, jsonStringify, jsonToCsv, jsonToXml, jsonValidator, listConfluenceSpaces, mathFunctions, notifySlack, objectOmit, objectPick, pathBasename, pathDirname, pathExtension, pathJoin, pathNormalize, pathParse, pathRelative, pathResolve, phoneValidator, randomNumber, searchConfluence, searchResultSchema, sendSlackMessage, slackTools, statistics, stringCaseConverter, stringJoin, stringLength, stringReplace, stringSplit, stringSubstring, stringTrim, updateConfluencePage, urlBuilder, urlQueryParser, urlValidator, urlValidatorSimple, uuidValidator, webScraper, webSearch, webSearchOutputSchema, webSearchSchema, xmlGenerator, xmlParser, xmlToJson };