@smythos/sre 1.6.1 → 1.6.8

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 (234) hide show
  1. package/CHANGELOG +111 -111
  2. package/LICENSE +18 -18
  3. package/README.md +135 -135
  4. package/dist/index.js +2 -2
  5. package/dist/index.js.map +1 -1
  6. package/dist/types/subsystems/LLMManager/ModelsProvider.service/connectors/SmythModelsProvider.class.d.ts +39 -0
  7. package/package.json +1 -1
  8. package/src/Components/APICall/APICall.class.ts +161 -161
  9. package/src/Components/APICall/AccessTokenManager.ts +166 -166
  10. package/src/Components/APICall/ArrayBufferResponse.helper.ts +58 -58
  11. package/src/Components/APICall/OAuth.helper.ts +447 -447
  12. package/src/Components/APICall/mimeTypeCategories.ts +46 -46
  13. package/src/Components/APICall/parseData.ts +167 -167
  14. package/src/Components/APICall/parseHeaders.ts +41 -41
  15. package/src/Components/APICall/parseProxy.ts +68 -68
  16. package/src/Components/APICall/parseUrl.ts +91 -91
  17. package/src/Components/APIEndpoint.class.ts +234 -234
  18. package/src/Components/APIOutput.class.ts +58 -58
  19. package/src/Components/AgentPlugin.class.ts +102 -102
  20. package/src/Components/Async.class.ts +155 -155
  21. package/src/Components/Await.class.ts +90 -90
  22. package/src/Components/Classifier.class.ts +158 -158
  23. package/src/Components/Component.class.ts +147 -147
  24. package/src/Components/ComponentHost.class.ts +38 -38
  25. package/src/Components/DataSourceCleaner.class.ts +92 -92
  26. package/src/Components/DataSourceIndexer.class.ts +181 -181
  27. package/src/Components/DataSourceLookup.class.ts +161 -161
  28. package/src/Components/ECMASandbox.class.ts +72 -72
  29. package/src/Components/FEncDec.class.ts +29 -29
  30. package/src/Components/FHash.class.ts +33 -33
  31. package/src/Components/FSign.class.ts +80 -80
  32. package/src/Components/FSleep.class.ts +25 -25
  33. package/src/Components/FTimestamp.class.ts +66 -66
  34. package/src/Components/FileStore.class.ts +78 -78
  35. package/src/Components/ForEach.class.ts +97 -97
  36. package/src/Components/GPTPlugin.class.ts +70 -70
  37. package/src/Components/GenAILLM.class.ts +586 -586
  38. package/src/Components/HuggingFace.class.ts +313 -313
  39. package/src/Components/Image/imageSettings.config.ts +70 -70
  40. package/src/Components/ImageGenerator.class.ts +483 -483
  41. package/src/Components/JSONFilter.class.ts +54 -54
  42. package/src/Components/LLMAssistant.class.ts +213 -213
  43. package/src/Components/LogicAND.class.ts +28 -28
  44. package/src/Components/LogicAtLeast.class.ts +85 -85
  45. package/src/Components/LogicAtMost.class.ts +86 -86
  46. package/src/Components/LogicOR.class.ts +29 -29
  47. package/src/Components/LogicXOR.class.ts +34 -34
  48. package/src/Components/MCPClient.class.ts +137 -137
  49. package/src/Components/MemoryDeleteKeyVal.class.ts +70 -70
  50. package/src/Components/MemoryReadKeyVal.class.ts +67 -67
  51. package/src/Components/MemoryWriteKeyVal.class.ts +62 -62
  52. package/src/Components/MemoryWriteObject.class.ts +97 -97
  53. package/src/Components/MultimodalLLM.class.ts +128 -128
  54. package/src/Components/OpenAPI.class.ts +72 -72
  55. package/src/Components/PromptGenerator.class.ts +122 -122
  56. package/src/Components/ScrapflyWebScrape.class.ts +183 -183
  57. package/src/Components/ServerlessCode.class.ts +123 -123
  58. package/src/Components/TavilyWebSearch.class.ts +103 -103
  59. package/src/Components/VisionLLM.class.ts +104 -104
  60. package/src/Components/ZapierAction.class.ts +127 -127
  61. package/src/Components/index.ts +97 -97
  62. package/src/Core/AgentProcess.helper.ts +240 -240
  63. package/src/Core/Connector.class.ts +123 -123
  64. package/src/Core/ConnectorsService.ts +197 -197
  65. package/src/Core/DummyConnector.ts +49 -49
  66. package/src/Core/HookService.ts +105 -105
  67. package/src/Core/SmythRuntime.class.ts +241 -241
  68. package/src/Core/SystemEvents.ts +16 -16
  69. package/src/Core/boot.ts +56 -56
  70. package/src/config.ts +15 -15
  71. package/src/constants.ts +126 -126
  72. package/src/data/hugging-face.params.json +579 -579
  73. package/src/helpers/AWSLambdaCode.helper.ts +624 -599
  74. package/src/helpers/BinaryInput.helper.ts +331 -331
  75. package/src/helpers/Conversation.helper.ts +1157 -1157
  76. package/src/helpers/ECMASandbox.helper.ts +64 -64
  77. package/src/helpers/JsonContent.helper.ts +97 -97
  78. package/src/helpers/LocalCache.helper.ts +97 -97
  79. package/src/helpers/Log.helper.ts +274 -274
  80. package/src/helpers/OpenApiParser.helper.ts +150 -150
  81. package/src/helpers/S3Cache.helper.ts +147 -147
  82. package/src/helpers/SmythURI.helper.ts +5 -5
  83. package/src/helpers/Sysconfig.helper.ts +95 -95
  84. package/src/helpers/TemplateString.helper.ts +243 -243
  85. package/src/helpers/TypeChecker.helper.ts +329 -329
  86. package/src/index.ts +198 -198
  87. package/src/index.ts.bak +198 -198
  88. package/src/subsystems/AgentManager/Agent.class.ts +1114 -1114
  89. package/src/subsystems/AgentManager/Agent.helper.ts +3 -3
  90. package/src/subsystems/AgentManager/AgentData.service/AgentDataConnector.ts +230 -230
  91. package/src/subsystems/AgentManager/AgentData.service/connectors/CLIAgentDataConnector.class.ts +66 -66
  92. package/src/subsystems/AgentManager/AgentData.service/connectors/LocalAgentDataConnector.class.ts +145 -145
  93. package/src/subsystems/AgentManager/AgentData.service/connectors/NullAgentData.class.ts +39 -39
  94. package/src/subsystems/AgentManager/AgentData.service/index.ts +18 -18
  95. package/src/subsystems/AgentManager/AgentLogger.class.ts +301 -301
  96. package/src/subsystems/AgentManager/AgentRequest.class.ts +51 -51
  97. package/src/subsystems/AgentManager/AgentRuntime.class.ts +557 -557
  98. package/src/subsystems/AgentManager/AgentSSE.class.ts +101 -101
  99. package/src/subsystems/AgentManager/AgentSettings.class.ts +52 -52
  100. package/src/subsystems/AgentManager/Component.service/ComponentConnector.ts +32 -32
  101. package/src/subsystems/AgentManager/Component.service/connectors/LocalComponentConnector.class.ts +60 -60
  102. package/src/subsystems/AgentManager/Component.service/index.ts +11 -11
  103. package/src/subsystems/AgentManager/EmbodimentSettings.class.ts +47 -47
  104. package/src/subsystems/AgentManager/ForkedAgent.class.ts +154 -154
  105. package/src/subsystems/AgentManager/OSResourceMonitor.ts +77 -77
  106. package/src/subsystems/ComputeManager/Code.service/CodeConnector.ts +98 -98
  107. package/src/subsystems/ComputeManager/Code.service/connectors/AWSLambdaCode.class.ts +171 -172
  108. package/src/subsystems/ComputeManager/Code.service/connectors/ECMASandbox.class.ts +131 -131
  109. package/src/subsystems/ComputeManager/Code.service/index.ts +13 -13
  110. package/src/subsystems/IO/CLI.service/CLIConnector.ts +47 -47
  111. package/src/subsystems/IO/CLI.service/index.ts +9 -9
  112. package/src/subsystems/IO/Log.service/LogConnector.ts +32 -32
  113. package/src/subsystems/IO/Log.service/connectors/ConsoleLog.class.ts +28 -28
  114. package/src/subsystems/IO/Log.service/index.ts +13 -13
  115. package/src/subsystems/IO/NKV.service/NKVConnector.ts +43 -43
  116. package/src/subsystems/IO/NKV.service/connectors/NKVLocalStorage.class.ts +234 -234
  117. package/src/subsystems/IO/NKV.service/connectors/NKVRAM.class.ts +204 -204
  118. package/src/subsystems/IO/NKV.service/connectors/NKVRedis.class.ts +182 -182
  119. package/src/subsystems/IO/NKV.service/index.ts +14 -14
  120. package/src/subsystems/IO/Router.service/RouterConnector.ts +21 -21
  121. package/src/subsystems/IO/Router.service/connectors/ExpressRouter.class.ts +48 -48
  122. package/src/subsystems/IO/Router.service/connectors/NullRouter.class.ts +40 -40
  123. package/src/subsystems/IO/Router.service/index.ts +11 -11
  124. package/src/subsystems/IO/Storage.service/SmythFS.class.ts +488 -488
  125. package/src/subsystems/IO/Storage.service/StorageConnector.ts +66 -66
  126. package/src/subsystems/IO/Storage.service/connectors/LocalStorage.class.ts +327 -327
  127. package/src/subsystems/IO/Storage.service/connectors/S3Storage.class.ts +482 -482
  128. package/src/subsystems/IO/Storage.service/index.ts +13 -13
  129. package/src/subsystems/IO/VectorDB.service/VectorDBConnector.ts +108 -108
  130. package/src/subsystems/IO/VectorDB.service/connectors/MilvusVectorDB.class.ts +465 -465
  131. package/src/subsystems/IO/VectorDB.service/connectors/PineconeVectorDB.class.ts +387 -387
  132. package/src/subsystems/IO/VectorDB.service/connectors/RAMVecrtorDB.class.ts +408 -408
  133. package/src/subsystems/IO/VectorDB.service/embed/BaseEmbedding.ts +107 -107
  134. package/src/subsystems/IO/VectorDB.service/embed/GoogleEmbedding.ts +118 -118
  135. package/src/subsystems/IO/VectorDB.service/embed/OpenAIEmbedding.ts +109 -109
  136. package/src/subsystems/IO/VectorDB.service/embed/index.ts +26 -26
  137. package/src/subsystems/IO/VectorDB.service/index.ts +14 -14
  138. package/src/subsystems/LLMManager/LLM.helper.ts +251 -251
  139. package/src/subsystems/LLMManager/LLM.inference.ts +345 -345
  140. package/src/subsystems/LLMManager/LLM.service/LLMConnector.ts +492 -492
  141. package/src/subsystems/LLMManager/LLM.service/LLMCredentials.helper.ts +171 -171
  142. package/src/subsystems/LLMManager/LLM.service/connectors/Anthropic.class.ts +666 -666
  143. package/src/subsystems/LLMManager/LLM.service/connectors/Bedrock.class.ts +407 -407
  144. package/src/subsystems/LLMManager/LLM.service/connectors/Echo.class.ts +92 -92
  145. package/src/subsystems/LLMManager/LLM.service/connectors/GoogleAI.class.ts +983 -983
  146. package/src/subsystems/LLMManager/LLM.service/connectors/Groq.class.ts +319 -319
  147. package/src/subsystems/LLMManager/LLM.service/connectors/Ollama.class.ts +361 -361
  148. package/src/subsystems/LLMManager/LLM.service/connectors/Perplexity.class.ts +257 -257
  149. package/src/subsystems/LLMManager/LLM.service/connectors/VertexAI.class.ts +430 -430
  150. package/src/subsystems/LLMManager/LLM.service/connectors/openai/OpenAIConnector.class.ts +503 -503
  151. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/ChatCompletionsApiInterface.ts +524 -524
  152. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/OpenAIApiInterface.ts +100 -100
  153. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/OpenAIApiInterfaceFactory.ts +81 -81
  154. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/ResponsesApiInterface.ts +1145 -1145
  155. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/constants.ts +13 -13
  156. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/index.ts +4 -4
  157. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/utils.ts +11 -11
  158. package/src/subsystems/LLMManager/LLM.service/connectors/openai/types.ts +32 -32
  159. package/src/subsystems/LLMManager/LLM.service/connectors/xAI.class.ts +478 -478
  160. package/src/subsystems/LLMManager/LLM.service/index.ts +47 -47
  161. package/src/subsystems/LLMManager/ModelsProvider.service/ModelsProviderConnector.ts +303 -303
  162. package/src/subsystems/LLMManager/ModelsProvider.service/connectors/JSONModelsProvider.class.ts +271 -271
  163. package/src/subsystems/LLMManager/ModelsProvider.service/index.ts +11 -11
  164. package/src/subsystems/LLMManager/custom-models.ts +854 -854
  165. package/src/subsystems/LLMManager/models.ts +2540 -2540
  166. package/src/subsystems/LLMManager/paramMappings.ts +69 -69
  167. package/src/subsystems/MemoryManager/Cache.service/CacheConnector.ts +86 -86
  168. package/src/subsystems/MemoryManager/Cache.service/connectors/LocalStorageCache.class.ts +297 -297
  169. package/src/subsystems/MemoryManager/Cache.service/connectors/RAMCache.class.ts +214 -214
  170. package/src/subsystems/MemoryManager/Cache.service/connectors/RedisCache.class.ts +252 -252
  171. package/src/subsystems/MemoryManager/Cache.service/connectors/S3Cache.class.ts +373 -373
  172. package/src/subsystems/MemoryManager/Cache.service/index.ts +15 -15
  173. package/src/subsystems/MemoryManager/LLMCache.ts +72 -72
  174. package/src/subsystems/MemoryManager/LLMContext.ts +124 -124
  175. package/src/subsystems/MemoryManager/LLMMemory.service/LLMMemoryConnector.ts +26 -26
  176. package/src/subsystems/MemoryManager/RuntimeContext.ts +277 -277
  177. package/src/subsystems/Security/AccessControl/ACL.class.ts +208 -208
  178. package/src/subsystems/Security/AccessControl/AccessCandidate.class.ts +82 -82
  179. package/src/subsystems/Security/AccessControl/AccessRequest.class.ts +52 -52
  180. package/src/subsystems/Security/Account.service/AccountConnector.ts +44 -44
  181. package/src/subsystems/Security/Account.service/connectors/DummyAccount.class.ts +130 -130
  182. package/src/subsystems/Security/Account.service/connectors/JSONFileAccount.class.ts +170 -170
  183. package/src/subsystems/Security/Account.service/connectors/MySQLAccount.class.ts +76 -76
  184. package/src/subsystems/Security/Account.service/index.ts +14 -14
  185. package/src/subsystems/Security/Credentials.helper.ts +62 -62
  186. package/src/subsystems/Security/ManagedVault.service/ManagedVaultConnector.ts +38 -38
  187. package/src/subsystems/Security/ManagedVault.service/connectors/NullManagedVault.class.ts +53 -53
  188. package/src/subsystems/Security/ManagedVault.service/connectors/SecretManagerManagedVault.ts +154 -154
  189. package/src/subsystems/Security/ManagedVault.service/index.ts +12 -12
  190. package/src/subsystems/Security/SecureConnector.class.ts +110 -110
  191. package/src/subsystems/Security/Vault.service/Vault.helper.ts +30 -30
  192. package/src/subsystems/Security/Vault.service/VaultConnector.ts +29 -29
  193. package/src/subsystems/Security/Vault.service/connectors/HashicorpVault.class.ts +46 -46
  194. package/src/subsystems/Security/Vault.service/connectors/JSONFileVault.class.ts +221 -221
  195. package/src/subsystems/Security/Vault.service/connectors/NullVault.class.ts +54 -54
  196. package/src/subsystems/Security/Vault.service/connectors/SecretsManager.class.ts +140 -140
  197. package/src/subsystems/Security/Vault.service/index.ts +12 -12
  198. package/src/types/ACL.types.ts +104 -104
  199. package/src/types/AWS.types.ts +10 -10
  200. package/src/types/Agent.types.ts +61 -61
  201. package/src/types/AgentLogger.types.ts +17 -17
  202. package/src/types/Cache.types.ts +1 -1
  203. package/src/types/Common.types.ts +2 -2
  204. package/src/types/LLM.types.ts +520 -520
  205. package/src/types/Redis.types.ts +8 -8
  206. package/src/types/SRE.types.ts +64 -64
  207. package/src/types/Security.types.ts +14 -14
  208. package/src/types/Storage.types.ts +5 -5
  209. package/src/types/VectorDB.types.ts +86 -86
  210. package/src/utils/base64.utils.ts +275 -275
  211. package/src/utils/cli.utils.ts +68 -68
  212. package/src/utils/data.utils.ts +322 -322
  213. package/src/utils/date-time.utils.ts +22 -22
  214. package/src/utils/general.utils.ts +238 -238
  215. package/src/utils/index.ts +12 -12
  216. package/src/utils/lazy-client.ts +261 -261
  217. package/src/utils/numbers.utils.ts +13 -13
  218. package/src/utils/oauth.utils.ts +35 -35
  219. package/src/utils/string.utils.ts +414 -414
  220. package/src/utils/url.utils.ts +19 -19
  221. package/src/utils/validation.utils.ts +74 -74
  222. package/dist/bundle-analysis-lazy.html +0 -4949
  223. package/dist/bundle-analysis.html +0 -4949
  224. package/dist/types/Components/Triggers/GmailTrigger.class.d.ts +0 -13
  225. package/dist/types/Components/Triggers/Trigger.class.d.ts +0 -3
  226. package/dist/types/helpers/AIPerformanceAnalyzer.helper.d.ts +0 -45
  227. package/dist/types/helpers/AIPerformanceCollector.helper.d.ts +0 -111
  228. package/dist/types/subsystems/IO/Storage.service/connectors/AzureBlobStorage.class.d.ts +0 -211
  229. package/dist/types/subsystems/IO/VectorDB.service/connectors/WeaviateVectorDB.class.d.ts +0 -187
  230. package/dist/types/subsystems/PerformanceManager/Performance.service/PerformanceConnector.d.ts +0 -102
  231. package/dist/types/subsystems/PerformanceManager/Performance.service/connectors/LocalPerformanceConnector.class.d.ts +0 -100
  232. package/dist/types/subsystems/PerformanceManager/Performance.service/index.d.ts +0 -22
  233. package/dist/types/types/Performance.types.d.ts +0 -468
  234. package/dist/types/utils/package-manager.utils.d.ts +0 -26
@@ -1,182 +1,182 @@
1
- import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
2
- import { INKVRequest, NKVConnector } from '../NKVConnector';
3
- import { ACLAccessDeniedError, IAccessCandidate, TAccessLevel, TAccessResult } from '@sre/types/ACL.types';
4
- import { ACL } from '@sre/Security/AccessControl/ACL.class';
5
- import { CacheConnector } from '@sre/MemoryManager/Cache.service/CacheConnector';
6
- import { ConnectorService } from '@sre/Core/ConnectorsService';
7
- import { SecureConnector } from '@sre/Security/SecureConnector.class';
8
- import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
9
- import { StorageData } from '@sre/types/Storage.types';
10
- import { RedisCache } from '@sre/MemoryManager/Cache.service/connectors/RedisCache.class';
11
- import { AccountConnector } from '@sre/Security/Account.service/AccountConnector';
12
- import Joi from 'joi';
13
-
14
- export class NKVRedis extends NKVConnector {
15
- public name = 'Redis';
16
- private redisCacheConnector: RedisCache;
17
- private accountConnector: AccountConnector;
18
- constructor(protected _settings?: any) {
19
- super(_settings);
20
- this.redisCacheConnector = ConnectorService.getCacheConnector('Redis') as RedisCache;
21
- this.accountConnector = ConnectorService.getAccountConnector();
22
- }
23
-
24
- public key(...parts: string[]) {
25
- return parts.join(':');
26
- }
27
-
28
- public mdKey(...parts: string[]) {
29
- return parts.join(':');
30
- }
31
-
32
- @NKVRedis.Validate
33
- @NKVRedis.NamespaceAccessControl
34
- protected async get(acRequest: AccessRequest, namespace: string, key: string): Promise<StorageData> {
35
- const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
36
- return await this.redisCacheConnector.requester(AccessCandidate.team(teamId)).get(this.key(`team_${teamId}`, namespace, key));
37
- }
38
-
39
- @NKVRedis.Validate
40
- @NKVRedis.NamespaceAccessControl
41
- protected async set(acRequest: AccessRequest, namespace: string, key: string, value: any) {
42
- const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
43
-
44
- const setKey = this.key(`team_${teamId}`, namespace, key);
45
- await this.redisCacheConnector.requester(AccessCandidate.team(teamId)).set(setKey, value);
46
- // to set namespace ownership
47
- const isNewNs = !(await this.redisCacheConnector.requester(AccessCandidate.team(teamId)).exists(namespace));
48
- if (isNewNs) {
49
- await this.redisCacheConnector
50
- .requester(AccessCandidate.team(teamId))
51
- .set(this.key(`team_${teamId}`, namespace), '', undefined, { ns: true });
52
- }
53
- }
54
-
55
- @NKVRedis.Validate
56
- @NKVRedis.NamespaceAccessControl
57
- protected async delete(acRequest: AccessRequest, namespace: string, key: string): Promise<void> {
58
- const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
59
- await this.redisCacheConnector.requester(AccessCandidate.team(teamId)).delete(this.key(`team_${teamId}`, namespace, key));
60
- }
61
-
62
- @NKVRedis.Validate
63
- @NKVRedis.NamespaceAccessControl
64
- protected async exists(acRequest: AccessRequest, namespace: string, key: string): Promise<boolean> {
65
- const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
66
- return await this.redisCacheConnector.requester(AccessCandidate.team(teamId)).exists(this.key(`team_${teamId}`, namespace, key));
67
- }
68
-
69
- @NKVRedis.NamespaceAccessControl
70
- public async list(acRequest: AccessRequest, namespace: string): Promise<{ key: string; data: StorageData }[]> {
71
- const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
72
- let keys = await this.fetchKeysByPrefix(this.key(this.redisCacheConnector.prefix, `team_${teamId}`, namespace));
73
-
74
- // filter out metadata keys & namespace sentinel keys
75
- keys = keys.filter(
76
- (key) => key !== this.key(this.redisCacheConnector.prefix, `team_${teamId}`, namespace) // if not the namespace sentinel key
77
- );
78
-
79
- if (keys.length <= 0) return [];
80
- // Start a transaction
81
- const pipeline = this.redisCacheConnector.client.pipeline();
82
-
83
- // Add get commands for all keys to the transaction
84
- keys.forEach((key) => {
85
- pipeline.get(key);
86
- });
87
-
88
- // Execute the transaction
89
- const results = await pipeline.exec();
90
-
91
- // Combine the keys and their corresponding values
92
- return keys.map((key, index) => {
93
- return {
94
- key: key.replace(`${this.key(this.redisCacheConnector.prefix, `team_${teamId}`, namespace)}:`, ''),
95
- data: results[index][1] as StorageData,
96
- };
97
- });
98
- }
99
-
100
- @NKVRedis.NamespaceAccessControl
101
- public async deleteAll(acRequest: AccessRequest, namespace: string): Promise<void> {
102
- const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
103
- let keys = await this.fetchKeysByPrefix(this.key(this.redisCacheConnector.prefix, `team_${teamId}`, namespace));
104
- // filter out namespace sentinel key + namespace metadata key metadata key
105
- keys = keys.filter((key) => {
106
- return ![this.key(this.redisCacheConnector.prefix, `team_${teamId}`, namespace)].includes(key);
107
- });
108
- await this.redisCacheConnector.client.del(keys);
109
- }
110
-
111
- public async getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL> {
112
- return this.redisCacheConnector.getResourceACL(resourceId, candidate);
113
- }
114
-
115
- private async fetchKeysByPrefix(prefix: string): Promise<string[]> {
116
- let cursor = '0';
117
- const keys = [];
118
-
119
- do {
120
- // SCAN with match for the prefix and count for batch size (optional)
121
- const result = await this.redisCacheConnector.client.scan(cursor, 'MATCH', `${prefix}*`, 'COUNT', 10000);
122
- cursor = result[0];
123
- keys.push(...result[1]);
124
- } while (cursor !== '0');
125
-
126
- return keys;
127
- }
128
-
129
- static NamespaceAccessControl(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
130
- // Store the original method in a variable
131
- const originalMethod = descriptor.value;
132
-
133
- // Modify the descriptor's value to wrap the original method
134
- descriptor.value = async function (...args: any[]) {
135
- // Extract the method arguments
136
- let [acRequest, namespace, key] = args;
137
- const isNamespaceSearch = key === undefined;
138
-
139
- // Inject the access control logic
140
- const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
141
- const resourceId = isNamespaceSearch ? namespace : `${namespace}:${key}`;
142
- const finalKey = this.key(this.redisCacheConnector.prefix, `team_${teamId}`, resourceId);
143
- const accessTicket = await this.getAccessTicket(finalKey, acRequest);
144
-
145
- if (accessTicket.access !== TAccessResult.Granted) throw new ACLAccessDeniedError('Access Denied');
146
-
147
- // Call the original method with the original arguments
148
- return originalMethod.apply(this, args);
149
- };
150
-
151
- // Return the modified descriptor
152
- return descriptor;
153
- }
154
-
155
- static Validate(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
156
- // Store the original method in a variable
157
- const originalMethod = descriptor.value;
158
-
159
- // Modify the descriptor's value to wrap the original method
160
- descriptor.value = async function (...args: any[]) {
161
- // Extract the method arguments
162
- let [acRequest, namespace, key] = args;
163
-
164
- // Validate the arguments
165
- const schemaValidator = Joi.object().keys({
166
- namespace: Joi.string().min(1).required(),
167
- key: Joi.string().min(1).required(),
168
- });
169
- const validationResult = schemaValidator.validate({ namespace, key });
170
-
171
- if (validationResult.error) {
172
- throw new Error(`Validation Error: ${validationResult.error.message}`);
173
- }
174
-
175
- // Call the original method with the original arguments
176
- return originalMethod.apply(this, args);
177
- };
178
-
179
- // Return the modified descriptor
180
- return descriptor;
181
- }
182
- }
1
+ import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
2
+ import { INKVRequest, NKVConnector } from '../NKVConnector';
3
+ import { ACLAccessDeniedError, IAccessCandidate, TAccessLevel, TAccessResult } from '@sre/types/ACL.types';
4
+ import { ACL } from '@sre/Security/AccessControl/ACL.class';
5
+ import { CacheConnector } from '@sre/MemoryManager/Cache.service/CacheConnector';
6
+ import { ConnectorService } from '@sre/Core/ConnectorsService';
7
+ import { SecureConnector } from '@sre/Security/SecureConnector.class';
8
+ import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
9
+ import { StorageData } from '@sre/types/Storage.types';
10
+ import { RedisCache } from '@sre/MemoryManager/Cache.service/connectors/RedisCache.class';
11
+ import { AccountConnector } from '@sre/Security/Account.service/AccountConnector';
12
+ import Joi from 'joi';
13
+
14
+ export class NKVRedis extends NKVConnector {
15
+ public name = 'Redis';
16
+ private redisCacheConnector: RedisCache;
17
+ private accountConnector: AccountConnector;
18
+ constructor(protected _settings?: any) {
19
+ super(_settings);
20
+ this.redisCacheConnector = ConnectorService.getCacheConnector('Redis') as RedisCache;
21
+ this.accountConnector = ConnectorService.getAccountConnector();
22
+ }
23
+
24
+ public key(...parts: string[]) {
25
+ return parts.join(':');
26
+ }
27
+
28
+ public mdKey(...parts: string[]) {
29
+ return parts.join(':');
30
+ }
31
+
32
+ @NKVRedis.Validate
33
+ @NKVRedis.NamespaceAccessControl
34
+ protected async get(acRequest: AccessRequest, namespace: string, key: string): Promise<StorageData> {
35
+ const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
36
+ return await this.redisCacheConnector.requester(AccessCandidate.team(teamId)).get(this.key(`team_${teamId}`, namespace, key));
37
+ }
38
+
39
+ @NKVRedis.Validate
40
+ @NKVRedis.NamespaceAccessControl
41
+ protected async set(acRequest: AccessRequest, namespace: string, key: string, value: any) {
42
+ const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
43
+
44
+ const setKey = this.key(`team_${teamId}`, namespace, key);
45
+ await this.redisCacheConnector.requester(AccessCandidate.team(teamId)).set(setKey, value);
46
+ // to set namespace ownership
47
+ const isNewNs = !(await this.redisCacheConnector.requester(AccessCandidate.team(teamId)).exists(namespace));
48
+ if (isNewNs) {
49
+ await this.redisCacheConnector
50
+ .requester(AccessCandidate.team(teamId))
51
+ .set(this.key(`team_${teamId}`, namespace), '', undefined, { ns: true });
52
+ }
53
+ }
54
+
55
+ @NKVRedis.Validate
56
+ @NKVRedis.NamespaceAccessControl
57
+ protected async delete(acRequest: AccessRequest, namespace: string, key: string): Promise<void> {
58
+ const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
59
+ await this.redisCacheConnector.requester(AccessCandidate.team(teamId)).delete(this.key(`team_${teamId}`, namespace, key));
60
+ }
61
+
62
+ @NKVRedis.Validate
63
+ @NKVRedis.NamespaceAccessControl
64
+ protected async exists(acRequest: AccessRequest, namespace: string, key: string): Promise<boolean> {
65
+ const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
66
+ return await this.redisCacheConnector.requester(AccessCandidate.team(teamId)).exists(this.key(`team_${teamId}`, namespace, key));
67
+ }
68
+
69
+ @NKVRedis.NamespaceAccessControl
70
+ public async list(acRequest: AccessRequest, namespace: string): Promise<{ key: string; data: StorageData }[]> {
71
+ const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
72
+ let keys = await this.fetchKeysByPrefix(this.key(this.redisCacheConnector.prefix, `team_${teamId}`, namespace));
73
+
74
+ // filter out metadata keys & namespace sentinel keys
75
+ keys = keys.filter(
76
+ (key) => key !== this.key(this.redisCacheConnector.prefix, `team_${teamId}`, namespace) // if not the namespace sentinel key
77
+ );
78
+
79
+ if (keys.length <= 0) return [];
80
+ // Start a transaction
81
+ const pipeline = this.redisCacheConnector.client.pipeline();
82
+
83
+ // Add get commands for all keys to the transaction
84
+ keys.forEach((key) => {
85
+ pipeline.get(key);
86
+ });
87
+
88
+ // Execute the transaction
89
+ const results = await pipeline.exec();
90
+
91
+ // Combine the keys and their corresponding values
92
+ return keys.map((key, index) => {
93
+ return {
94
+ key: key.replace(`${this.key(this.redisCacheConnector.prefix, `team_${teamId}`, namespace)}:`, ''),
95
+ data: results[index][1] as StorageData,
96
+ };
97
+ });
98
+ }
99
+
100
+ @NKVRedis.NamespaceAccessControl
101
+ public async deleteAll(acRequest: AccessRequest, namespace: string): Promise<void> {
102
+ const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
103
+ let keys = await this.fetchKeysByPrefix(this.key(this.redisCacheConnector.prefix, `team_${teamId}`, namespace));
104
+ // filter out namespace sentinel key + namespace metadata key metadata key
105
+ keys = keys.filter((key) => {
106
+ return ![this.key(this.redisCacheConnector.prefix, `team_${teamId}`, namespace)].includes(key);
107
+ });
108
+ await this.redisCacheConnector.client.del(keys);
109
+ }
110
+
111
+ public async getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL> {
112
+ return this.redisCacheConnector.getResourceACL(resourceId, candidate);
113
+ }
114
+
115
+ private async fetchKeysByPrefix(prefix: string): Promise<string[]> {
116
+ let cursor = '0';
117
+ const keys = [];
118
+
119
+ do {
120
+ // SCAN with match for the prefix and count for batch size (optional)
121
+ const result = await this.redisCacheConnector.client.scan(cursor, 'MATCH', `${prefix}*`, 'COUNT', 10000);
122
+ cursor = result[0];
123
+ keys.push(...result[1]);
124
+ } while (cursor !== '0');
125
+
126
+ return keys;
127
+ }
128
+
129
+ static NamespaceAccessControl(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
130
+ // Store the original method in a variable
131
+ const originalMethod = descriptor.value;
132
+
133
+ // Modify the descriptor's value to wrap the original method
134
+ descriptor.value = async function (...args: any[]) {
135
+ // Extract the method arguments
136
+ let [acRequest, namespace, key] = args;
137
+ const isNamespaceSearch = key === undefined;
138
+
139
+ // Inject the access control logic
140
+ const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
141
+ const resourceId = isNamespaceSearch ? namespace : `${namespace}:${key}`;
142
+ const finalKey = this.key(this.redisCacheConnector.prefix, `team_${teamId}`, resourceId);
143
+ const accessTicket = await this.getAccessTicket(finalKey, acRequest);
144
+
145
+ if (accessTicket.access !== TAccessResult.Granted) throw new ACLAccessDeniedError('Access Denied');
146
+
147
+ // Call the original method with the original arguments
148
+ return originalMethod.apply(this, args);
149
+ };
150
+
151
+ // Return the modified descriptor
152
+ return descriptor;
153
+ }
154
+
155
+ static Validate(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
156
+ // Store the original method in a variable
157
+ const originalMethod = descriptor.value;
158
+
159
+ // Modify the descriptor's value to wrap the original method
160
+ descriptor.value = async function (...args: any[]) {
161
+ // Extract the method arguments
162
+ let [acRequest, namespace, key] = args;
163
+
164
+ // Validate the arguments
165
+ const schemaValidator = Joi.object().keys({
166
+ namespace: Joi.string().min(1).required(),
167
+ key: Joi.string().min(1).required(),
168
+ });
169
+ const validationResult = schemaValidator.validate({ namespace, key });
170
+
171
+ if (validationResult.error) {
172
+ throw new Error(`Validation Error: ${validationResult.error.message}`);
173
+ }
174
+
175
+ // Call the original method with the original arguments
176
+ return originalMethod.apply(this, args);
177
+ };
178
+
179
+ // Return the modified descriptor
180
+ return descriptor;
181
+ }
182
+ }
@@ -1,14 +1,14 @@
1
- //==[ SRE: Storage ]======================
2
-
3
- import { ConnectorService, ConnectorServiceProvider } from '@sre/Core/ConnectorsService';
4
- import { TConnectorService } from '@sre/types/SRE.types';
5
- import { NKVRedis } from './connectors/NKVRedis.class';
6
- import { NKVRAM } from './connectors/NKVRAM.class';
7
- import { NKVLocalStorage } from './connectors/NKVLocalStorage.class';
8
- export class NKVService extends ConnectorServiceProvider {
9
- public register() {
10
- ConnectorService.register(TConnectorService.NKV, 'Redis', NKVRedis);
11
- ConnectorService.register(TConnectorService.NKV, 'RAM', NKVRAM);
12
- ConnectorService.register(TConnectorService.NKV, 'LocalStorage', NKVLocalStorage);
13
- }
14
- }
1
+ //==[ SRE: Storage ]======================
2
+
3
+ import { ConnectorService, ConnectorServiceProvider } from '@sre/Core/ConnectorsService';
4
+ import { TConnectorService } from '@sre/types/SRE.types';
5
+ import { NKVRedis } from './connectors/NKVRedis.class';
6
+ import { NKVRAM } from './connectors/NKVRAM.class';
7
+ import { NKVLocalStorage } from './connectors/NKVLocalStorage.class';
8
+ export class NKVService extends ConnectorServiceProvider {
9
+ public register() {
10
+ ConnectorService.register(TConnectorService.NKV, 'Redis', NKVRedis);
11
+ ConnectorService.register(TConnectorService.NKV, 'RAM', NKVRAM);
12
+ ConnectorService.register(TConnectorService.NKV, 'LocalStorage', NKVLocalStorage);
13
+ }
14
+ }
@@ -1,21 +1,21 @@
1
- import { Connector } from '@sre/Core/Connector.class';
2
- import { SmythFS } from '../Storage.service/SmythFS.class';
3
- import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
4
-
5
- export type GenericRequestHandler = (...args: any[]) => void | Promise<void>;
6
-
7
- /*
8
- This Connector is highly discouraged to be used because by design, SRE should not handle any kind of HTTP requests
9
- Currently it is only used to serve the temp files for external services to retrieve them.
10
- */
11
-
12
- export abstract class RouterConnector extends Connector {
13
- public abstract baseUrl: string;
14
-
15
- abstract get(path: string, ...handlers: GenericRequestHandler[]): this;
16
- abstract post(path: string, ...handlers: GenericRequestHandler[]): this;
17
- abstract put(path: string, ...handlers: GenericRequestHandler[]): this;
18
- abstract delete(path: string, ...handlers: GenericRequestHandler[]): this;
19
- abstract useFn(...handlers: GenericRequestHandler[]): this;
20
- abstract use(path: string, ...handlers: GenericRequestHandler[]): this;
21
- }
1
+ import { Connector } from '@sre/Core/Connector.class';
2
+ import { SmythFS } from '../Storage.service/SmythFS.class';
3
+ import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
4
+
5
+ export type GenericRequestHandler = (...args: any[]) => void | Promise<void>;
6
+
7
+ /*
8
+ This Connector is highly discouraged to be used because by design, SRE should not handle any kind of HTTP requests
9
+ Currently it is only used to serve the temp files for external services to retrieve them.
10
+ */
11
+
12
+ export abstract class RouterConnector extends Connector {
13
+ public abstract baseUrl: string;
14
+
15
+ abstract get(path: string, ...handlers: GenericRequestHandler[]): this;
16
+ abstract post(path: string, ...handlers: GenericRequestHandler[]): this;
17
+ abstract put(path: string, ...handlers: GenericRequestHandler[]): this;
18
+ abstract delete(path: string, ...handlers: GenericRequestHandler[]): this;
19
+ abstract useFn(...handlers: GenericRequestHandler[]): this;
20
+ abstract use(path: string, ...handlers: GenericRequestHandler[]): this;
21
+ }
@@ -1,48 +1,48 @@
1
- import { Router } from 'express';
2
- import { RouterConnector, GenericRequestHandler } from '../RouterConnector';
3
-
4
- export class ExpressRouter extends RouterConnector {
5
- private router: Router;
6
- public baseUrl: string;
7
-
8
- constructor(protected _settings?: { router: Router; baseUrl: string }) {
9
- super(_settings);
10
- this.name = 'ExpressRouter';
11
- this.router = _settings.router;
12
- this.baseUrl = _settings.baseUrl;
13
- }
14
-
15
- get(path: string, ...handlers: GenericRequestHandler[]): this {
16
- this.router.get(path, ...handlers);
17
- return this;
18
- }
19
-
20
- post(path: string, ...handlers: GenericRequestHandler[]): this {
21
- this.router.post(path, ...handlers);
22
- return this;
23
- }
24
-
25
- put(path: string, ...handlers: GenericRequestHandler[]): this {
26
- this.router.put(path, ...handlers);
27
- return this;
28
- }
29
-
30
- delete(path: string, ...handlers: GenericRequestHandler[]): this {
31
- this.router.delete(path, ...handlers);
32
- return this;
33
- }
34
-
35
- useFn(...handlers: GenericRequestHandler[]): this {
36
- this.router.use(...handlers);
37
- return this;
38
- }
39
-
40
- use(path: string, ...handlers: GenericRequestHandler[]): this {
41
- this.router.use(path, ...handlers);
42
- return this;
43
- }
44
-
45
- getRouter(): Router {
46
- return this.router;
47
- }
48
- }
1
+ import { Router } from 'express';
2
+ import { RouterConnector, GenericRequestHandler } from '../RouterConnector';
3
+
4
+ export class ExpressRouter extends RouterConnector {
5
+ private router: Router;
6
+ public baseUrl: string;
7
+
8
+ constructor(protected _settings?: { router: Router; baseUrl: string }) {
9
+ super(_settings);
10
+ this.name = 'ExpressRouter';
11
+ this.router = _settings.router;
12
+ this.baseUrl = _settings.baseUrl;
13
+ }
14
+
15
+ get(path: string, ...handlers: GenericRequestHandler[]): this {
16
+ this.router.get(path, ...handlers);
17
+ return this;
18
+ }
19
+
20
+ post(path: string, ...handlers: GenericRequestHandler[]): this {
21
+ this.router.post(path, ...handlers);
22
+ return this;
23
+ }
24
+
25
+ put(path: string, ...handlers: GenericRequestHandler[]): this {
26
+ this.router.put(path, ...handlers);
27
+ return this;
28
+ }
29
+
30
+ delete(path: string, ...handlers: GenericRequestHandler[]): this {
31
+ this.router.delete(path, ...handlers);
32
+ return this;
33
+ }
34
+
35
+ useFn(...handlers: GenericRequestHandler[]): this {
36
+ this.router.use(...handlers);
37
+ return this;
38
+ }
39
+
40
+ use(path: string, ...handlers: GenericRequestHandler[]): this {
41
+ this.router.use(path, ...handlers);
42
+ return this;
43
+ }
44
+
45
+ getRouter(): Router {
46
+ return this.router;
47
+ }
48
+ }
@@ -1,40 +1,40 @@
1
- import { Logger } from '@sre/helpers/Log.helper';
2
- import { RouterConnector, GenericRequestHandler } from '../RouterConnector';
3
-
4
- const console = Logger('NullRouter');
5
- export class NullRouter extends RouterConnector {
6
- public baseUrl: string;
7
- constructor(protected _settings?: any) {
8
- super(_settings);
9
- this.baseUrl = 'http://nullrouter.local';
10
- }
11
-
12
- get(path: string, ...handlers: GenericRequestHandler[]): this {
13
- console.debug(`Ignored operation:NullRouter.get: ${path}`);
14
- return this;
15
- }
16
-
17
- post(path: string, ...handlers: GenericRequestHandler[]): this {
18
- console.debug(`Ignored operation:NullRouter.post: ${path}`);
19
- return this;
20
- }
21
-
22
- put(path: string, ...handlers: GenericRequestHandler[]): this {
23
- console.debug(`Ignored operation:NullRouter.put: ${path}`);
24
- return this;
25
- }
26
-
27
- delete(path: string, ...handlers: GenericRequestHandler[]): this {
28
- console.debug(`Ignored operation:NullRouter.delete: ${path}`);
29
- return this;
30
- }
31
-
32
- useFn(...handlers: GenericRequestHandler[]): this {
33
- console.debug(`Ignored operation:NullRouter.useFn`);
34
- return this;
35
- }
36
-
37
- use(path: string, ...handlers: GenericRequestHandler[]): this {
38
- return this;
39
- }
40
- }
1
+ import { Logger } from '@sre/helpers/Log.helper';
2
+ import { RouterConnector, GenericRequestHandler } from '../RouterConnector';
3
+
4
+ const console = Logger('NullRouter');
5
+ export class NullRouter extends RouterConnector {
6
+ public baseUrl: string;
7
+ constructor(protected _settings?: any) {
8
+ super(_settings);
9
+ this.baseUrl = 'http://nullrouter.local';
10
+ }
11
+
12
+ get(path: string, ...handlers: GenericRequestHandler[]): this {
13
+ console.debug(`Ignored operation:NullRouter.get: ${path}`);
14
+ return this;
15
+ }
16
+
17
+ post(path: string, ...handlers: GenericRequestHandler[]): this {
18
+ console.debug(`Ignored operation:NullRouter.post: ${path}`);
19
+ return this;
20
+ }
21
+
22
+ put(path: string, ...handlers: GenericRequestHandler[]): this {
23
+ console.debug(`Ignored operation:NullRouter.put: ${path}`);
24
+ return this;
25
+ }
26
+
27
+ delete(path: string, ...handlers: GenericRequestHandler[]): this {
28
+ console.debug(`Ignored operation:NullRouter.delete: ${path}`);
29
+ return this;
30
+ }
31
+
32
+ useFn(...handlers: GenericRequestHandler[]): this {
33
+ console.debug(`Ignored operation:NullRouter.useFn`);
34
+ return this;
35
+ }
36
+
37
+ use(path: string, ...handlers: GenericRequestHandler[]): this {
38
+ return this;
39
+ }
40
+ }
@@ -1,11 +1,11 @@
1
- import { ConnectorService, ConnectorServiceProvider } from '@sre/Core/ConnectorsService';
2
- import { TConnectorService } from '@sre/types/SRE.types';
3
- import { ExpressRouter } from './connectors/ExpressRouter.class';
4
- import { NullRouter } from './connectors/NullRouter.class';
5
-
6
- export class RouterService extends ConnectorServiceProvider {
7
- public register() {
8
- ConnectorService.register(TConnectorService.Router, 'ExpressRouter', ExpressRouter);
9
- ConnectorService.register(TConnectorService.Router, 'NullRouter', NullRouter);
10
- }
11
- }
1
+ import { ConnectorService, ConnectorServiceProvider } from '@sre/Core/ConnectorsService';
2
+ import { TConnectorService } from '@sre/types/SRE.types';
3
+ import { ExpressRouter } from './connectors/ExpressRouter.class';
4
+ import { NullRouter } from './connectors/NullRouter.class';
5
+
6
+ export class RouterService extends ConnectorServiceProvider {
7
+ public register() {
8
+ ConnectorService.register(TConnectorService.Router, 'ExpressRouter', ExpressRouter);
9
+ ConnectorService.register(TConnectorService.Router, 'NullRouter', NullRouter);
10
+ }
11
+ }