@smythos/sre 1.5.50 → 1.5.52

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.
Files changed (225) hide show
  1. package/CHANGELOG +98 -98
  2. package/LICENSE +18 -18
  3. package/README.md +135 -135
  4. package/dist/index.js +3 -3
  5. package/dist/index.js.map +1 -1
  6. package/dist/types/Components/APICall/AccessTokenManager.d.ts +3 -2
  7. package/dist/types/Components/APICall/OAuth.helper.d.ts +3 -2
  8. package/dist/types/subsystems/LLMManager/LLM.service/connectors/openai/OpenAIConnector.class.d.ts +6 -1
  9. package/dist/types/subsystems/LLMManager/ModelsProvider.service/connectors/SmythModelsProvider.class.d.ts +39 -0
  10. package/package.json +1 -1
  11. package/src/Components/APICall/APICall.class.ts +156 -156
  12. package/src/Components/APICall/AccessTokenManager.ts +166 -130
  13. package/src/Components/APICall/ArrayBufferResponse.helper.ts +58 -58
  14. package/src/Components/APICall/OAuth.helper.ts +446 -294
  15. package/src/Components/APICall/mimeTypeCategories.ts +46 -46
  16. package/src/Components/APICall/parseData.ts +167 -167
  17. package/src/Components/APICall/parseHeaders.ts +41 -41
  18. package/src/Components/APICall/parseProxy.ts +68 -68
  19. package/src/Components/APICall/parseUrl.ts +91 -91
  20. package/src/Components/APIEndpoint.class.ts +234 -234
  21. package/src/Components/APIOutput.class.ts +58 -58
  22. package/src/Components/AgentPlugin.class.ts +102 -102
  23. package/src/Components/Async.class.ts +155 -155
  24. package/src/Components/Await.class.ts +90 -90
  25. package/src/Components/Classifier.class.ts +158 -158
  26. package/src/Components/Component.class.ts +132 -132
  27. package/src/Components/ComponentHost.class.ts +38 -38
  28. package/src/Components/DataSourceCleaner.class.ts +92 -92
  29. package/src/Components/DataSourceIndexer.class.ts +181 -181
  30. package/src/Components/DataSourceLookup.class.ts +161 -161
  31. package/src/Components/ECMASandbox.class.ts +71 -71
  32. package/src/Components/FEncDec.class.ts +29 -29
  33. package/src/Components/FHash.class.ts +33 -33
  34. package/src/Components/FSign.class.ts +80 -80
  35. package/src/Components/FSleep.class.ts +25 -25
  36. package/src/Components/FTimestamp.class.ts +25 -25
  37. package/src/Components/FileStore.class.ts +78 -78
  38. package/src/Components/ForEach.class.ts +97 -97
  39. package/src/Components/GPTPlugin.class.ts +70 -70
  40. package/src/Components/GenAILLM.class.ts +586 -586
  41. package/src/Components/HuggingFace.class.ts +314 -314
  42. package/src/Components/Image/imageSettings.config.ts +70 -70
  43. package/src/Components/ImageGenerator.class.ts +502 -502
  44. package/src/Components/JSONFilter.class.ts +54 -54
  45. package/src/Components/LLMAssistant.class.ts +213 -213
  46. package/src/Components/LogicAND.class.ts +28 -28
  47. package/src/Components/LogicAtLeast.class.ts +85 -85
  48. package/src/Components/LogicAtMost.class.ts +86 -86
  49. package/src/Components/LogicOR.class.ts +29 -29
  50. package/src/Components/LogicXOR.class.ts +34 -34
  51. package/src/Components/MCPClient.class.ts +138 -138
  52. package/src/Components/MemoryDeleteKeyVal.class.ts +70 -70
  53. package/src/Components/MemoryReadKeyVal.class.ts +66 -66
  54. package/src/Components/MemoryWriteKeyVal.class.ts +62 -62
  55. package/src/Components/MemoryWriteObject.class.ts +97 -97
  56. package/src/Components/MultimodalLLM.class.ts +128 -128
  57. package/src/Components/OpenAPI.class.ts +72 -72
  58. package/src/Components/PromptGenerator.class.ts +122 -122
  59. package/src/Components/ScrapflyWebScrape.class.ts +159 -159
  60. package/src/Components/ServerlessCode.class.ts +123 -123
  61. package/src/Components/TavilyWebSearch.class.ts +98 -98
  62. package/src/Components/VisionLLM.class.ts +104 -104
  63. package/src/Components/ZapierAction.class.ts +127 -127
  64. package/src/Components/index.ts +97 -97
  65. package/src/Core/AgentProcess.helper.ts +240 -240
  66. package/src/Core/Connector.class.ts +123 -123
  67. package/src/Core/ConnectorsService.ts +197 -197
  68. package/src/Core/DummyConnector.ts +49 -49
  69. package/src/Core/HookService.ts +105 -105
  70. package/src/Core/SmythRuntime.class.ts +235 -235
  71. package/src/Core/SystemEvents.ts +16 -16
  72. package/src/Core/boot.ts +56 -56
  73. package/src/config.ts +15 -15
  74. package/src/constants.ts +126 -126
  75. package/src/data/hugging-face.params.json +579 -579
  76. package/src/helpers/AWSLambdaCode.helper.ts +590 -587
  77. package/src/helpers/BinaryInput.helper.ts +331 -331
  78. package/src/helpers/Conversation.helper.ts +1119 -1119
  79. package/src/helpers/ECMASandbox.helper.ts +54 -54
  80. package/src/helpers/JsonContent.helper.ts +97 -97
  81. package/src/helpers/LocalCache.helper.ts +97 -97
  82. package/src/helpers/Log.helper.ts +274 -274
  83. package/src/helpers/OpenApiParser.helper.ts +150 -150
  84. package/src/helpers/S3Cache.helper.ts +147 -147
  85. package/src/helpers/SmythURI.helper.ts +5 -5
  86. package/src/helpers/Sysconfig.helper.ts +77 -77
  87. package/src/helpers/TemplateString.helper.ts +243 -243
  88. package/src/helpers/TypeChecker.helper.ts +329 -329
  89. package/src/index.ts +3 -3
  90. package/src/index.ts.bak +3 -3
  91. package/src/subsystems/AgentManager/Agent.class.ts +1114 -1114
  92. package/src/subsystems/AgentManager/Agent.helper.ts +3 -3
  93. package/src/subsystems/AgentManager/AgentData.service/AgentDataConnector.ts +230 -230
  94. package/src/subsystems/AgentManager/AgentData.service/connectors/CLIAgentDataConnector.class.ts +66 -66
  95. package/src/subsystems/AgentManager/AgentData.service/connectors/LocalAgentDataConnector.class.ts +142 -142
  96. package/src/subsystems/AgentManager/AgentData.service/connectors/NullAgentData.class.ts +39 -39
  97. package/src/subsystems/AgentManager/AgentData.service/index.ts +18 -18
  98. package/src/subsystems/AgentManager/AgentLogger.class.ts +297 -297
  99. package/src/subsystems/AgentManager/AgentRequest.class.ts +51 -51
  100. package/src/subsystems/AgentManager/AgentRuntime.class.ts +559 -559
  101. package/src/subsystems/AgentManager/AgentSSE.class.ts +101 -101
  102. package/src/subsystems/AgentManager/AgentSettings.class.ts +52 -52
  103. package/src/subsystems/AgentManager/Component.service/ComponentConnector.ts +32 -32
  104. package/src/subsystems/AgentManager/Component.service/connectors/LocalComponentConnector.class.ts +60 -60
  105. package/src/subsystems/AgentManager/Component.service/index.ts +11 -11
  106. package/src/subsystems/AgentManager/EmbodimentSettings.class.ts +47 -47
  107. package/src/subsystems/AgentManager/ForkedAgent.class.ts +154 -154
  108. package/src/subsystems/AgentManager/OSResourceMonitor.ts +77 -77
  109. package/src/subsystems/ComputeManager/Code.service/CodeConnector.ts +98 -98
  110. package/src/subsystems/ComputeManager/Code.service/connectors/AWSLambdaCode.class.ts +172 -172
  111. package/src/subsystems/ComputeManager/Code.service/connectors/ECMASandbox.class.ts +131 -131
  112. package/src/subsystems/ComputeManager/Code.service/index.ts +13 -13
  113. package/src/subsystems/IO/CLI.service/CLIConnector.ts +47 -47
  114. package/src/subsystems/IO/CLI.service/index.ts +9 -9
  115. package/src/subsystems/IO/Log.service/LogConnector.ts +32 -32
  116. package/src/subsystems/IO/Log.service/connectors/ConsoleLog.class.ts +28 -28
  117. package/src/subsystems/IO/Log.service/index.ts +13 -13
  118. package/src/subsystems/IO/NKV.service/NKVConnector.ts +43 -43
  119. package/src/subsystems/IO/NKV.service/connectors/NKVLocalStorage.class.ts +234 -234
  120. package/src/subsystems/IO/NKV.service/connectors/NKVRAM.class.ts +204 -204
  121. package/src/subsystems/IO/NKV.service/connectors/NKVRedis.class.ts +182 -182
  122. package/src/subsystems/IO/NKV.service/index.ts +14 -14
  123. package/src/subsystems/IO/Router.service/RouterConnector.ts +21 -21
  124. package/src/subsystems/IO/Router.service/connectors/ExpressRouter.class.ts +48 -48
  125. package/src/subsystems/IO/Router.service/connectors/NullRouter.class.ts +40 -40
  126. package/src/subsystems/IO/Router.service/index.ts +11 -11
  127. package/src/subsystems/IO/Storage.service/SmythFS.class.ts +489 -489
  128. package/src/subsystems/IO/Storage.service/StorageConnector.ts +66 -66
  129. package/src/subsystems/IO/Storage.service/connectors/LocalStorage.class.ts +327 -327
  130. package/src/subsystems/IO/Storage.service/connectors/S3Storage.class.ts +482 -482
  131. package/src/subsystems/IO/Storage.service/index.ts +13 -13
  132. package/src/subsystems/IO/VectorDB.service/VectorDBConnector.ts +108 -108
  133. package/src/subsystems/IO/VectorDB.service/connectors/MilvusVectorDB.class.ts +454 -454
  134. package/src/subsystems/IO/VectorDB.service/connectors/PineconeVectorDB.class.ts +384 -384
  135. package/src/subsystems/IO/VectorDB.service/connectors/RAMVecrtorDB.class.ts +421 -421
  136. package/src/subsystems/IO/VectorDB.service/embed/BaseEmbedding.ts +107 -107
  137. package/src/subsystems/IO/VectorDB.service/embed/OpenAIEmbedding.ts +109 -109
  138. package/src/subsystems/IO/VectorDB.service/embed/index.ts +21 -21
  139. package/src/subsystems/IO/VectorDB.service/index.ts +14 -14
  140. package/src/subsystems/LLMManager/LLM.helper.ts +251 -251
  141. package/src/subsystems/LLMManager/LLM.inference.ts +339 -339
  142. package/src/subsystems/LLMManager/LLM.service/LLMConnector.ts +489 -489
  143. package/src/subsystems/LLMManager/LLM.service/LLMCredentials.helper.ts +171 -171
  144. package/src/subsystems/LLMManager/LLM.service/connectors/Anthropic.class.ts +659 -659
  145. package/src/subsystems/LLMManager/LLM.service/connectors/Bedrock.class.ts +400 -400
  146. package/src/subsystems/LLMManager/LLM.service/connectors/Echo.class.ts +77 -77
  147. package/src/subsystems/LLMManager/LLM.service/connectors/GoogleAI.class.ts +757 -757
  148. package/src/subsystems/LLMManager/LLM.service/connectors/Groq.class.ts +304 -304
  149. package/src/subsystems/LLMManager/LLM.service/connectors/Perplexity.class.ts +250 -250
  150. package/src/subsystems/LLMManager/LLM.service/connectors/VertexAI.class.ts +423 -423
  151. package/src/subsystems/LLMManager/LLM.service/connectors/openai/OpenAIConnector.class.ts +488 -488
  152. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/ChatCompletionsApiInterface.ts +524 -524
  153. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/OpenAIApiInterface.ts +100 -100
  154. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/OpenAIApiInterfaceFactory.ts +81 -81
  155. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/ResponsesApiInterface.ts +1145 -1145
  156. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/constants.ts +13 -13
  157. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/index.ts +4 -4
  158. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/utils.ts +11 -11
  159. package/src/subsystems/LLMManager/LLM.service/connectors/openai/types.ts +32 -32
  160. package/src/subsystems/LLMManager/LLM.service/connectors/xAI.class.ts +471 -471
  161. package/src/subsystems/LLMManager/LLM.service/index.ts +44 -44
  162. package/src/subsystems/LLMManager/ModelsProvider.service/ModelsProviderConnector.ts +300 -300
  163. package/src/subsystems/LLMManager/ModelsProvider.service/connectors/JSONModelsProvider.class.ts +252 -252
  164. package/src/subsystems/LLMManager/ModelsProvider.service/index.ts +11 -11
  165. package/src/subsystems/LLMManager/custom-models.ts +854 -854
  166. package/src/subsystems/LLMManager/models.ts +2540 -2540
  167. package/src/subsystems/LLMManager/paramMappings.ts +69 -69
  168. package/src/subsystems/MemoryManager/Cache.service/CacheConnector.ts +86 -86
  169. package/src/subsystems/MemoryManager/Cache.service/connectors/LocalStorageCache.class.ts +297 -297
  170. package/src/subsystems/MemoryManager/Cache.service/connectors/RAMCache.class.ts +201 -201
  171. package/src/subsystems/MemoryManager/Cache.service/connectors/RedisCache.class.ts +252 -252
  172. package/src/subsystems/MemoryManager/Cache.service/connectors/S3Cache.class.ts +373 -373
  173. package/src/subsystems/MemoryManager/Cache.service/index.ts +15 -15
  174. package/src/subsystems/MemoryManager/LLMCache.ts +72 -72
  175. package/src/subsystems/MemoryManager/LLMContext.ts +124 -124
  176. package/src/subsystems/MemoryManager/LLMMemory.service/LLMMemoryConnector.ts +26 -26
  177. package/src/subsystems/MemoryManager/RuntimeContext.ts +266 -266
  178. package/src/subsystems/Security/AccessControl/ACL.class.ts +208 -208
  179. package/src/subsystems/Security/AccessControl/AccessCandidate.class.ts +82 -82
  180. package/src/subsystems/Security/AccessControl/AccessRequest.class.ts +52 -52
  181. package/src/subsystems/Security/Account.service/AccountConnector.ts +44 -44
  182. package/src/subsystems/Security/Account.service/connectors/AWSAccount.class.ts +76 -76
  183. package/src/subsystems/Security/Account.service/connectors/DummyAccount.class.ts +130 -130
  184. package/src/subsystems/Security/Account.service/connectors/JSONFileAccount.class.ts +159 -159
  185. package/src/subsystems/Security/Account.service/index.ts +14 -14
  186. package/src/subsystems/Security/Credentials.helper.ts +62 -62
  187. package/src/subsystems/Security/ManagedVault.service/ManagedVaultConnector.ts +38 -38
  188. package/src/subsystems/Security/ManagedVault.service/connectors/NullManagedVault.class.ts +53 -53
  189. package/src/subsystems/Security/ManagedVault.service/connectors/SecretManagerManagedVault.ts +154 -154
  190. package/src/subsystems/Security/ManagedVault.service/index.ts +12 -12
  191. package/src/subsystems/Security/SecureConnector.class.ts +110 -110
  192. package/src/subsystems/Security/Vault.service/Vault.helper.ts +30 -30
  193. package/src/subsystems/Security/Vault.service/VaultConnector.ts +29 -29
  194. package/src/subsystems/Security/Vault.service/connectors/HashicorpVault.class.ts +46 -46
  195. package/src/subsystems/Security/Vault.service/connectors/JSONFileVault.class.ts +221 -221
  196. package/src/subsystems/Security/Vault.service/connectors/NullVault.class.ts +54 -54
  197. package/src/subsystems/Security/Vault.service/connectors/SecretsManager.class.ts +140 -140
  198. package/src/subsystems/Security/Vault.service/index.ts +12 -12
  199. package/src/types/ACL.types.ts +104 -104
  200. package/src/types/AWS.types.ts +10 -10
  201. package/src/types/Agent.types.ts +61 -61
  202. package/src/types/AgentLogger.types.ts +17 -17
  203. package/src/types/Cache.types.ts +1 -1
  204. package/src/types/Common.types.ts +2 -2
  205. package/src/types/LLM.types.ts +496 -496
  206. package/src/types/Redis.types.ts +8 -8
  207. package/src/types/SRE.types.ts +64 -64
  208. package/src/types/Security.types.ts +14 -14
  209. package/src/types/Storage.types.ts +5 -5
  210. package/src/types/VectorDB.types.ts +86 -86
  211. package/src/utils/base64.utils.ts +275 -275
  212. package/src/utils/cli.utils.ts +68 -68
  213. package/src/utils/data.utils.ts +322 -322
  214. package/src/utils/date-time.utils.ts +22 -22
  215. package/src/utils/general.utils.ts +238 -238
  216. package/src/utils/index.ts +12 -12
  217. package/src/utils/lazy-client.ts +261 -261
  218. package/src/utils/numbers.utils.ts +13 -13
  219. package/src/utils/oauth.utils.ts +35 -35
  220. package/src/utils/string.utils.ts +414 -414
  221. package/src/utils/url.utils.ts +19 -19
  222. package/src/utils/validation.utils.ts +74 -74
  223. package/dist/bundle-analysis-lazy.html +0 -4949
  224. package/dist/bundle-analysis.html +0 -4949
  225. package/dist/types/utils/package-manager.utils.d.ts +0 -26
@@ -6,11 +6,12 @@ declare class AccessTokenManager {
6
6
  private secondaryToken;
7
7
  private tokenUrl;
8
8
  private expires_in;
9
- private data;
9
+ private tokensData;
10
10
  private keyId;
11
11
  private logger;
12
12
  private agent;
13
- constructor(clientId: string, clientSecret: string, secondaryToken: string, tokenUrl: string, expires_in: any, primaryToken: string, data: any, keyId: any, logger: any, agent: Agent);
13
+ private isNewStructure;
14
+ constructor(clientId: string, clientSecret: string, secondaryToken: string, tokenUrl: string, expires_in: any, primaryToken: string, tokensData: any, keyId: any, logger: any, agent: Agent, isNewStructure?: boolean);
14
15
  getAccessToken(): Promise<string>;
15
16
  refreshAccessToken(): Promise<string>;
16
17
  }
@@ -4,7 +4,8 @@ export declare function extractAdditionalParamsForOAuth1(reqConfig?: AxiosReques
4
4
  export declare const buildOAuth1Header: (url: any, method: any, oauth1Credentials: any, additionalParams?: {}) => OAuth.Header;
5
5
  export declare const retrieveOAuthTokens: (agent: any, config: any) => Promise<{
6
6
  responseData: any;
7
- data: any;
7
+ tokensData: any;
8
8
  keyId: any;
9
+ isNewStructure: boolean;
9
10
  }>;
10
- export declare const handleOAuthHeaders: (agent: any, config: any, reqConfig: any, logger: any, additionalParams: {}, rootUrl: any) => Promise<{}>;
11
+ export declare const handleOAuthHeaders: (agent: any, config: any, reqConfig: any, logger: any, additionalParams?: {}) => Promise<{}>;
@@ -42,7 +42,12 @@ export declare class OpenAIConnector extends LLMConnector {
42
42
  }[] | Array<import("@anthropic-ai/sdk/resources/messages").TextBlockParam | import("@anthropic-ai/sdk/resources/messages").ImageBlockParam | import("@anthropic-ai/sdk/resources/messages").ToolUseBlockParam | import("@anthropic-ai/sdk/resources/messages").ToolResultBlockParam>;
43
43
  parts?: {
44
44
  text?: string;
45
- functionCall?: {
45
+ functionCall? /**
46
+ * Safely compute prompt token count across different interfaces (Chat Completions, Responses)
47
+ * - Normalizes message content to strings for encodeChat
48
+ * - Handles vision prompts when files are present
49
+ * - Never throws; defaults to 0 on failure
50
+ */: {
46
51
  name: string;
47
52
  args: string;
48
53
  };
@@ -0,0 +1,39 @@
1
+ import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
2
+ import { ModelsProviderConnector } from '../ModelsProviderConnector';
3
+ import { IAccessCandidate } from '@sre/types/ACL.types';
4
+ import { ACL } from '@sre/Security/AccessControl/ACL.class';
5
+ import { TLLMModelsList } from '@sre/types/LLM.types';
6
+ type SmythModelsProviderConfig = {
7
+ /**
8
+ * The models to be used.
9
+ *
10
+ * If a string is provided, it will be used as the directory name to load the models from.
11
+ * If a TLLMModelsList is provided, it will be used as the models to be used.
12
+ *
13
+ */
14
+ models?: string | TLLMModelsList;
15
+ /**
16
+ * The mode to be used.
17
+ *
18
+ * If 'append' is used, the models will be appended to the existing models.
19
+ * If 'replace' is used, the existing models will be replaced with the new models.
20
+ */
21
+ mode?: 'merge' | 'replace';
22
+ };
23
+ export declare class SmythModelsProvider extends ModelsProviderConnector {
24
+ protected _settings?: SmythModelsProviderConfig;
25
+ name: string;
26
+ private models;
27
+ constructor(_settings?: SmythModelsProviderConfig);
28
+ start(): Promise<void>;
29
+ addModels(acRequest: AccessRequest, models: TLLMModelsList): Promise<void>;
30
+ getModels(acRequest: AccessRequest): Promise<any>;
31
+ getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL>;
32
+ private reindexModels;
33
+ private scanDirectoryForModels;
34
+ private getValidModels;
35
+ private isValidSingleModel;
36
+ private isValidModel;
37
+ private initDirWatcher;
38
+ }
39
+ export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@smythos/sre",
3
- "version": "1.5.50",
3
+ "version": "1.5.52",
4
4
  "description": "Smyth Runtime Environment",
5
5
  "author": "Alaa-eddine KADDOURI",
6
6
  "license": "MIT",
@@ -1,156 +1,156 @@
1
- import axios, { AxiosRequestConfig } from 'axios';
2
- import Joi from 'joi';
3
-
4
- import { Agent } from '@sre/AgentManager/Agent.class';
5
- import { Component } from '../Component.class';
6
- import { parseHeaders } from './parseHeaders';
7
- import { parseUrl, parseSmythFsUrl, destroyPublicUrls } from './parseUrl';
8
- import { parseData } from './parseData';
9
- import { parseProxy } from './parseProxy';
10
- import { parseArrayBufferResponse } from './ArrayBufferResponse.helper';
11
- import { extractAdditionalParamsForOAuth1, handleOAuthHeaders as generateOAuthHeaders } from './OAuth.helper';
12
- import { SocksProxyAgent } from 'socks-proxy-agent';
13
- import { formatDataForDebug } from '@sre/utils/data.utils';
14
- import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
15
-
16
- export class APICall extends Component {
17
- protected schema = {
18
- name: 'APICall',
19
- description: 'Use this component to make an API call',
20
- inputs: {},
21
- outputs: {
22
- Headers: {
23
- description: 'The headers of the API call response',
24
- default: true,
25
- },
26
- Response: {
27
- description: 'The response of the API call',
28
- default: true,
29
- },
30
- },
31
- };
32
-
33
- protected configSchema = Joi.object({
34
- method: Joi.string().valid('GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS').required().label('Method'),
35
- url: Joi.string()
36
- .max(8192) /*.custom(isUrlValid, 'URL validation')*/
37
- .required()
38
- .label('URL'),
39
- headers: Joi.any().allow('').label('Headers'),
40
- contentType: Joi.string()
41
- .valid('none', 'application/json', 'multipart/form-data', 'binary', 'application/x-www-form-urlencoded', 'text/plain', 'application/xml')
42
- .label('Content-Type'),
43
- body: Joi.any().allow('').label('Body'),
44
- _templateSettings: Joi.object().allow(null).label('Template Settings'),
45
- _templateVars: Joi.object().allow(null).label('Template Variables'),
46
- proxy: Joi.string().allow('').label('Proxy'),
47
- oauthService: Joi.string().allow('').label('OAuth Service'),
48
- scope: Joi.string().allow('').label('Scope'),
49
- authorizationURL: Joi.string().allow('').label('Authorization URL'),
50
- tokenURL: Joi.string().allow('').label('Token URL'),
51
- clientID: Joi.string().allow('').label('Client ID'),
52
- clientSecret: Joi.string().allow('').label('Client Secret'),
53
- oauth2CallbackURL: Joi.string().allow('').label('OAuth2 Callback URL'),
54
- callbackURL: Joi.string().allow('').label('Callback URL'), // !TEMP: prevent validation error
55
- requestTokenURL: Joi.string().allow('').label('Request Token URL'),
56
- accessTokenURL: Joi.string().allow('').label('Access Token URL'),
57
- userAuthorizationURL: Joi.string().allow('').label('User Authorization URL'),
58
- consumerKey: Joi.string().allow('').label('Consumer Key'),
59
- consumerSecret: Joi.string().allow('').label('Consumer Secret'),
60
- oauth1CallbackURL: Joi.string().allow('').label('OAuth1 Callback URL'),
61
- authenticate: Joi.string().allow('').label('Authenticate'),
62
- });
63
- constructor() {
64
- super();
65
- }
66
-
67
- init() {}
68
-
69
- async process(input, config, agent: Agent) {
70
- await super.process(input, config, agent);
71
-
72
- const logger = this.createComponentLogger(agent, config);
73
-
74
- let publicUrls: string[] = [];
75
-
76
- try {
77
- logger.debug(`=== API Call Log ===`);
78
-
79
- const method = config?.data?.method || 'get';
80
-
81
- const reqConfig: AxiosRequestConfig = {};
82
- reqConfig.method = method;
83
-
84
- reqConfig.url = await parseUrl(input, config, agent);
85
-
86
- // We generate public URLs for any resources specified with the smythfs protocol in the request URL.
87
- ({ url: reqConfig.url, publicUrls } = await parseSmythFsUrl(reqConfig.url, agent));
88
-
89
- const { data, headers } = await parseData(input, config, agent);
90
-
91
- // If the data is null, the request may fail. We encountered an issue where a request failed due to null data being provided.
92
- let dataForDebug;
93
- if (data) {
94
- reqConfig.data = data;
95
-
96
- dataForDebug = await formatDataForDebug(data, AccessCandidate.agent(agent.id));
97
- }
98
-
99
- reqConfig.headers = (await parseHeaders(input, config, agent)).concat({ ...headers });
100
-
101
- const proxyConfig = await parseProxy(input, config, agent);
102
-
103
- if (proxyConfig) {
104
- if (proxyConfig instanceof SocksProxyAgent) {
105
- const isSecureEndpoint = reqConfig.url?.startsWith('https://');
106
- reqConfig[isSecureEndpoint ? 'httpsAgent' : 'httpAgent'] = proxyConfig;
107
- } else {
108
- reqConfig.proxy = proxyConfig;
109
- }
110
- }
111
-
112
- let Response: any = {};
113
- let Headers: any = {};
114
- let _error: any = undefined;
115
- try {
116
- if (config?.data?.oauthService && config?.data?.oauthService !== 'None') {
117
- const rootUrl = new URL(reqConfig.url).origin;
118
- const additionalParams = extractAdditionalParamsForOAuth1(reqConfig);
119
- const oauthHeaders = await generateOAuthHeaders(agent, config, reqConfig, logger, additionalParams, rootUrl);
120
- //reqConfig.headers = { ...reqConfig.headers, ...oauthHeaders };
121
- reqConfig.headers = reqConfig.headers.concat({ ...oauthHeaders });
122
- }
123
-
124
- // in order to handle binary data automatically, we need to set responseType to 'arraybuffer' for all requests, then parse the response data based on content-type
125
- reqConfig.responseType = 'arraybuffer';
126
-
127
- logger.debug('Making API call', { ...reqConfig, data: dataForDebug });
128
-
129
- const response = await axios.request(reqConfig);
130
-
131
- const parsedRes = await parseArrayBufferResponse(response, agent);
132
-
133
- // log response headers
134
- logger.debug('API call Response Headers', response.headers);
135
- Response = parsedRes;
136
-
137
- logger.debug('API call Response\n', Response);
138
-
139
- Headers = Object.fromEntries(Object.entries(response.headers));
140
- } catch (error) {
141
- logger.debug(`Error making API call: ${error.message}`);
142
- Headers = error?.response?.headers ? Object.fromEntries(Object.entries(error.response.headers)) : {};
143
- Response = await parseArrayBufferResponse(error.response, agent);
144
- _error = error.message;
145
- }
146
-
147
- return { Response, Headers, _error, _debug: logger.output };
148
- } catch (error) {
149
- return { _error: error.message, _debug: logger.output };
150
- } finally {
151
- if (publicUrls.length > 0) {
152
- await destroyPublicUrls(publicUrls);
153
- }
154
- }
155
- }
156
- }
1
+ import axios, { AxiosRequestConfig } from 'axios';
2
+ import Joi from 'joi';
3
+
4
+ import { Agent } from '@sre/AgentManager/Agent.class';
5
+ import { Component } from '../Component.class';
6
+ import { parseHeaders } from './parseHeaders';
7
+ import { parseUrl, parseSmythFsUrl, destroyPublicUrls } from './parseUrl';
8
+ import { parseData } from './parseData';
9
+ import { parseProxy } from './parseProxy';
10
+ import { parseArrayBufferResponse } from './ArrayBufferResponse.helper';
11
+ import { extractAdditionalParamsForOAuth1, handleOAuthHeaders as generateOAuthHeaders } from './OAuth.helper';
12
+ import { SocksProxyAgent } from 'socks-proxy-agent';
13
+ import { formatDataForDebug } from '@sre/utils/data.utils';
14
+ import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
15
+
16
+ export class APICall extends Component {
17
+ protected schema = {
18
+ name: 'APICall',
19
+ description: 'Use this component to make an API call',
20
+ inputs: {},
21
+ outputs: {
22
+ Headers: {
23
+ description: 'The headers of the API call response',
24
+ default: true,
25
+ },
26
+ Response: {
27
+ description: 'The response of the API call',
28
+ default: true,
29
+ },
30
+ },
31
+ };
32
+
33
+ protected configSchema = Joi.object({
34
+ method: Joi.string().valid('GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS').required().label('Method'),
35
+ url: Joi.string()
36
+ .max(8192) /*.custom(isUrlValid, 'URL validation')*/
37
+ .required()
38
+ .label('URL'),
39
+ headers: Joi.any().allow('').label('Headers'),
40
+ contentType: Joi.string()
41
+ .valid('none', 'application/json', 'multipart/form-data', 'binary', 'application/x-www-form-urlencoded', 'text/plain', 'application/xml')
42
+ .label('Content-Type'),
43
+ body: Joi.any().allow('').label('Body'),
44
+ _templateSettings: Joi.object().allow(null).label('Template Settings'),
45
+ _templateVars: Joi.object().allow(null).label('Template Variables'),
46
+ proxy: Joi.string().allow('').label('Proxy'),
47
+ oauthService: Joi.string().allow('').label('OAuth Service'),
48
+ scope: Joi.string().allow('').label('Scope'),
49
+ authorizationURL: Joi.string().allow('').label('Authorization URL'),
50
+ tokenURL: Joi.string().allow('').label('Token URL'),
51
+ clientID: Joi.string().allow('').label('Client ID'),
52
+ clientSecret: Joi.string().allow('').label('Client Secret'),
53
+ oauth2CallbackURL: Joi.string().allow('').label('OAuth2 Callback URL'),
54
+ callbackURL: Joi.string().allow('').label('Callback URL'), // !TEMP: prevent validation error
55
+ requestTokenURL: Joi.string().allow('').label('Request Token URL'),
56
+ accessTokenURL: Joi.string().allow('').label('Access Token URL'),
57
+ userAuthorizationURL: Joi.string().allow('').label('User Authorization URL'),
58
+ consumerKey: Joi.string().allow('').label('Consumer Key'),
59
+ consumerSecret: Joi.string().allow('').label('Consumer Secret'),
60
+ oauth1CallbackURL: Joi.string().allow('').label('OAuth1 Callback URL'),
61
+ authenticate: Joi.string().allow('').label('Authenticate'),
62
+ oauth_con_id: Joi.string().allow('').label('OAuth Connection ID'),
63
+ });
64
+ constructor() {
65
+ super();
66
+ }
67
+
68
+ init() { }
69
+
70
+ async process(input, config, agent: Agent) {
71
+ await super.process(input, config, agent);
72
+
73
+ const logger = this.createComponentLogger(agent, config);
74
+
75
+ let publicUrls: string[] = [];
76
+
77
+ try {
78
+ logger.debug(`=== API Call Log ===`);
79
+
80
+ const method = config?.data?.method || 'get';
81
+
82
+ const reqConfig: AxiosRequestConfig = {};
83
+ reqConfig.method = method;
84
+
85
+ reqConfig.url = await parseUrl(input, config, agent);
86
+
87
+ // We generate public URLs for any resources specified with the smythfs protocol in the request URL.
88
+ ({ url: reqConfig.url, publicUrls } = await parseSmythFsUrl(reqConfig.url, agent));
89
+
90
+ const { data, headers } = await parseData(input, config, agent);
91
+
92
+ // If the data is null, the request may fail. We encountered an issue where a request failed due to null data being provided.
93
+ let dataForDebug;
94
+ if (data) {
95
+ reqConfig.data = data;
96
+
97
+ dataForDebug = await formatDataForDebug(data, AccessCandidate.agent(agent.id));
98
+ }
99
+
100
+ reqConfig.headers = (await parseHeaders(input, config, agent)).concat({ ...headers });
101
+
102
+ const proxyConfig = await parseProxy(input, config, agent);
103
+
104
+ if (proxyConfig) {
105
+ if (proxyConfig instanceof SocksProxyAgent) {
106
+ const isSecureEndpoint = reqConfig.url?.startsWith('https://');
107
+ reqConfig[isSecureEndpoint ? 'httpsAgent' : 'httpAgent'] = proxyConfig;
108
+ } else {
109
+ reqConfig.proxy = proxyConfig;
110
+ }
111
+ }
112
+
113
+ let Response: any = {};
114
+ let Headers: any = {};
115
+ let _error: any = undefined;
116
+ try {
117
+ if (config?.data?.oauth_con_id !== '' && config?.data?.oauth_con_id !== 'None') {
118
+ const additionalParams = extractAdditionalParamsForOAuth1(reqConfig);
119
+ const oauthHeaders = await generateOAuthHeaders(agent, config, reqConfig, logger, additionalParams);
120
+ //reqConfig.headers = { ...reqConfig.headers, ...oauthHeaders };
121
+ reqConfig.headers = reqConfig.headers.concat({ ...oauthHeaders });
122
+ }
123
+
124
+ // in order to handle binary data automatically, we need to set responseType to 'arraybuffer' for all requests, then parse the response data based on content-type
125
+ reqConfig.responseType = 'arraybuffer';
126
+
127
+ logger.debug('Making API call', { ...reqConfig, data: dataForDebug });
128
+
129
+ const response = await axios.request(reqConfig);
130
+
131
+ const parsedRes = await parseArrayBufferResponse(response, agent);
132
+
133
+ // log response headers
134
+ logger.debug('API call Response Headers', response.headers);
135
+ Response = parsedRes;
136
+
137
+ logger.debug('API call Response\n', Response);
138
+
139
+ Headers = Object.fromEntries(Object.entries(response.headers));
140
+ } catch (error) {
141
+ logger.debug(`Error making API call: ${error.message}`);
142
+ Headers = error?.response?.headers ? Object.fromEntries(Object.entries(error.response.headers)) : {};
143
+ Response = await parseArrayBufferResponse(error.response, agent);
144
+ _error = error.message;
145
+ }
146
+
147
+ return { Response, Headers, _error, _debug: logger.output };
148
+ } catch (error) {
149
+ return { _error: error.message, _debug: logger.output };
150
+ } finally {
151
+ if (publicUrls.length > 0) {
152
+ await destroyPublicUrls(publicUrls);
153
+ }
154
+ }
155
+ }
156
+ }