@smythos/sre 1.5.1 → 1.5.4

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 (193) hide show
  1. package/LICENSE +18 -0
  2. package/dist/index.js +22329 -4
  3. package/dist/index.js.map +1 -1
  4. package/dist/types/subsystems/IO/VectorDB.service/connectors/PineconeVectorDB.class.d.ts +2 -2
  5. package/dist/types/subsystems/IO/VectorDB.service/embed/BaseEmbedding.d.ts +11 -7
  6. package/dist/types/types/VectorDB.types.d.ts +13 -11
  7. package/package.json +102 -127
  8. package/src/Components/APICall/APICall.class.ts +155 -0
  9. package/src/Components/APICall/AccessTokenManager.ts +130 -0
  10. package/src/Components/APICall/ArrayBufferResponse.helper.ts +58 -0
  11. package/src/Components/APICall/OAuth.helper.ts +294 -0
  12. package/src/Components/APICall/mimeTypeCategories.ts +46 -0
  13. package/src/Components/APICall/parseData.ts +167 -0
  14. package/src/Components/APICall/parseHeaders.ts +41 -0
  15. package/src/Components/APICall/parseProxy.ts +68 -0
  16. package/src/Components/APICall/parseUrl.ts +91 -0
  17. package/src/Components/APIEndpoint.class.ts +234 -0
  18. package/src/Components/APIOutput.class.ts +58 -0
  19. package/src/Components/AgentPlugin.class.ts +102 -0
  20. package/src/Components/Async.class.ts +155 -0
  21. package/src/Components/Await.class.ts +90 -0
  22. package/src/Components/Classifier.class.ts +158 -0
  23. package/src/Components/Component.class.ts +94 -0
  24. package/src/Components/ComponentHost.class.ts +38 -0
  25. package/src/Components/DataSourceCleaner.class.ts +92 -0
  26. package/src/Components/DataSourceIndexer.class.ts +181 -0
  27. package/src/Components/DataSourceLookup.class.ts +141 -0
  28. package/src/Components/FEncDec.class.ts +29 -0
  29. package/src/Components/FHash.class.ts +33 -0
  30. package/src/Components/FSign.class.ts +80 -0
  31. package/src/Components/FSleep.class.ts +25 -0
  32. package/src/Components/FTimestamp.class.ts +25 -0
  33. package/src/Components/FileStore.class.ts +75 -0
  34. package/src/Components/ForEach.class.ts +97 -0
  35. package/src/Components/GPTPlugin.class.ts +70 -0
  36. package/src/Components/GenAILLM.class.ts +395 -0
  37. package/src/Components/HuggingFace.class.ts +314 -0
  38. package/src/Components/Image/imageSettings.config.ts +70 -0
  39. package/src/Components/ImageGenerator.class.ts +407 -0
  40. package/src/Components/JSONFilter.class.ts +54 -0
  41. package/src/Components/LLMAssistant.class.ts +213 -0
  42. package/src/Components/LogicAND.class.ts +28 -0
  43. package/src/Components/LogicAtLeast.class.ts +85 -0
  44. package/src/Components/LogicAtMost.class.ts +86 -0
  45. package/src/Components/LogicOR.class.ts +29 -0
  46. package/src/Components/LogicXOR.class.ts +34 -0
  47. package/src/Components/MCPClient.class.ts +112 -0
  48. package/src/Components/PromptGenerator.class.ts +122 -0
  49. package/src/Components/ScrapflyWebScrape.class.ts +159 -0
  50. package/src/Components/TavilyWebSearch.class.ts +98 -0
  51. package/src/Components/index.ts +77 -0
  52. package/src/Core/AgentProcess.helper.ts +240 -0
  53. package/src/Core/Connector.class.ts +123 -0
  54. package/src/Core/ConnectorsService.ts +192 -0
  55. package/src/Core/DummyConnector.ts +49 -0
  56. package/src/Core/HookService.ts +105 -0
  57. package/src/Core/SmythRuntime.class.ts +292 -0
  58. package/src/Core/SystemEvents.ts +15 -0
  59. package/src/Core/boot.ts +55 -0
  60. package/src/config.ts +15 -0
  61. package/src/constants.ts +125 -0
  62. package/src/data/hugging-face.params.json +580 -0
  63. package/src/helpers/BinaryInput.helper.ts +324 -0
  64. package/src/helpers/Conversation.helper.ts +1094 -0
  65. package/src/helpers/JsonContent.helper.ts +97 -0
  66. package/src/helpers/LocalCache.helper.ts +97 -0
  67. package/src/helpers/Log.helper.ts +234 -0
  68. package/src/helpers/OpenApiParser.helper.ts +150 -0
  69. package/src/helpers/S3Cache.helper.ts +129 -0
  70. package/src/helpers/SmythURI.helper.ts +5 -0
  71. package/src/helpers/TemplateString.helper.ts +243 -0
  72. package/src/helpers/TypeChecker.helper.ts +329 -0
  73. package/src/index.ts +179 -0
  74. package/src/index.ts.bak +179 -0
  75. package/src/subsystems/AgentManager/Agent.class.ts +1108 -0
  76. package/src/subsystems/AgentManager/Agent.helper.ts +3 -0
  77. package/src/subsystems/AgentManager/AgentData.service/AgentDataConnector.ts +230 -0
  78. package/src/subsystems/AgentManager/AgentData.service/connectors/CLIAgentDataConnector.class.ts +66 -0
  79. package/src/subsystems/AgentManager/AgentData.service/connectors/LocalAgentDataConnector.class.ts +142 -0
  80. package/src/subsystems/AgentManager/AgentData.service/connectors/NullAgentData.class.ts +39 -0
  81. package/src/subsystems/AgentManager/AgentData.service/index.ts +18 -0
  82. package/src/subsystems/AgentManager/AgentLogger.class.ts +297 -0
  83. package/src/subsystems/AgentManager/AgentRequest.class.ts +51 -0
  84. package/src/subsystems/AgentManager/AgentRuntime.class.ts +559 -0
  85. package/src/subsystems/AgentManager/AgentSSE.class.ts +101 -0
  86. package/src/subsystems/AgentManager/AgentSettings.class.ts +52 -0
  87. package/src/subsystems/AgentManager/Component.service/ComponentConnector.ts +32 -0
  88. package/src/subsystems/AgentManager/Component.service/connectors/LocalComponentConnector.class.ts +59 -0
  89. package/src/subsystems/AgentManager/Component.service/index.ts +11 -0
  90. package/src/subsystems/AgentManager/EmbodimentSettings.class.ts +47 -0
  91. package/src/subsystems/AgentManager/ForkedAgent.class.ts +153 -0
  92. package/src/subsystems/AgentManager/OSResourceMonitor.ts +77 -0
  93. package/src/subsystems/ComputeManager/Code.service/CodeConnector.ts +99 -0
  94. package/src/subsystems/ComputeManager/Code.service/connectors/AWSLambdaCode.class.ts +63 -0
  95. package/src/subsystems/ComputeManager/Code.service/index.ts +11 -0
  96. package/src/subsystems/IO/CLI.service/CLIConnector.ts +47 -0
  97. package/src/subsystems/IO/CLI.service/index.ts +9 -0
  98. package/src/subsystems/IO/Log.service/LogConnector.ts +32 -0
  99. package/src/subsystems/IO/Log.service/connectors/ConsoleLog.class.ts +28 -0
  100. package/src/subsystems/IO/Log.service/index.ts +13 -0
  101. package/src/subsystems/IO/NKV.service/NKVConnector.ts +41 -0
  102. package/src/subsystems/IO/NKV.service/connectors/NKVRAM.class.ts +204 -0
  103. package/src/subsystems/IO/NKV.service/connectors/NKVRedis.class.ts +182 -0
  104. package/src/subsystems/IO/NKV.service/index.ts +12 -0
  105. package/src/subsystems/IO/Router.service/RouterConnector.ts +21 -0
  106. package/src/subsystems/IO/Router.service/connectors/ExpressRouter.class.ts +48 -0
  107. package/src/subsystems/IO/Router.service/connectors/NullRouter.class.ts +40 -0
  108. package/src/subsystems/IO/Router.service/index.ts +11 -0
  109. package/src/subsystems/IO/Storage.service/SmythFS.class.ts +472 -0
  110. package/src/subsystems/IO/Storage.service/StorageConnector.ts +66 -0
  111. package/src/subsystems/IO/Storage.service/connectors/LocalStorage.class.ts +305 -0
  112. package/src/subsystems/IO/Storage.service/connectors/S3Storage.class.ts +418 -0
  113. package/src/subsystems/IO/Storage.service/index.ts +13 -0
  114. package/src/subsystems/IO/VectorDB.service/VectorDBConnector.ts +108 -0
  115. package/src/subsystems/IO/VectorDB.service/connectors/MilvusVectorDB.class.ts +454 -0
  116. package/src/subsystems/IO/VectorDB.service/connectors/PineconeVectorDB.class.ts +384 -0
  117. package/src/subsystems/IO/VectorDB.service/connectors/RAMVecrtorDB.class.ts +421 -0
  118. package/src/subsystems/IO/VectorDB.service/embed/BaseEmbedding.ts +107 -0
  119. package/src/subsystems/IO/VectorDB.service/embed/OpenAIEmbedding.ts +109 -0
  120. package/src/subsystems/IO/VectorDB.service/embed/index.ts +21 -0
  121. package/src/subsystems/IO/VectorDB.service/index.ts +14 -0
  122. package/src/subsystems/LLMManager/LLM.helper.ts +221 -0
  123. package/src/subsystems/LLMManager/LLM.inference.ts +335 -0
  124. package/src/subsystems/LLMManager/LLM.service/LLMConnector.ts +375 -0
  125. package/src/subsystems/LLMManager/LLM.service/LLMCredentials.helper.ts +145 -0
  126. package/src/subsystems/LLMManager/LLM.service/connectors/Anthropic.class.ts +632 -0
  127. package/src/subsystems/LLMManager/LLM.service/connectors/Bedrock.class.ts +405 -0
  128. package/src/subsystems/LLMManager/LLM.service/connectors/Echo.class.ts +81 -0
  129. package/src/subsystems/LLMManager/LLM.service/connectors/GoogleAI.class.ts +689 -0
  130. package/src/subsystems/LLMManager/LLM.service/connectors/Groq.class.ts +257 -0
  131. package/src/subsystems/LLMManager/LLM.service/connectors/OpenAI.class.ts +848 -0
  132. package/src/subsystems/LLMManager/LLM.service/connectors/Perplexity.class.ts +255 -0
  133. package/src/subsystems/LLMManager/LLM.service/connectors/VertexAI.class.ts +193 -0
  134. package/src/subsystems/LLMManager/LLM.service/index.ts +43 -0
  135. package/src/subsystems/LLMManager/ModelsProvider.service/ModelsProviderConnector.ts +281 -0
  136. package/src/subsystems/LLMManager/ModelsProvider.service/connectors/SmythModelsProvider.class.ts +229 -0
  137. package/src/subsystems/LLMManager/ModelsProvider.service/index.ts +11 -0
  138. package/src/subsystems/LLMManager/custom-models.ts +854 -0
  139. package/src/subsystems/LLMManager/models.ts +2539 -0
  140. package/src/subsystems/LLMManager/paramMappings.ts +69 -0
  141. package/src/subsystems/MemoryManager/Cache.service/CacheConnector.ts +86 -0
  142. package/src/subsystems/MemoryManager/Cache.service/connectors/LocalStorageCache.class.ts +297 -0
  143. package/src/subsystems/MemoryManager/Cache.service/connectors/RAMCache.class.ts +201 -0
  144. package/src/subsystems/MemoryManager/Cache.service/connectors/RedisCache.class.ts +252 -0
  145. package/src/subsystems/MemoryManager/Cache.service/connectors/S3Cache.class.ts +373 -0
  146. package/src/subsystems/MemoryManager/Cache.service/index.ts +15 -0
  147. package/src/subsystems/MemoryManager/LLMCache.ts +72 -0
  148. package/src/subsystems/MemoryManager/LLMContext.ts +125 -0
  149. package/src/subsystems/MemoryManager/RuntimeContext.ts +249 -0
  150. package/src/subsystems/Security/AccessControl/ACL.class.ts +208 -0
  151. package/src/subsystems/Security/AccessControl/AccessCandidate.class.ts +76 -0
  152. package/src/subsystems/Security/AccessControl/AccessRequest.class.ts +52 -0
  153. package/src/subsystems/Security/Account.service/AccountConnector.ts +41 -0
  154. package/src/subsystems/Security/Account.service/connectors/AWSAccount.class.ts +76 -0
  155. package/src/subsystems/Security/Account.service/connectors/DummyAccount.class.ts +130 -0
  156. package/src/subsystems/Security/Account.service/connectors/JSONFileAccount.class.ts +159 -0
  157. package/src/subsystems/Security/Account.service/index.ts +14 -0
  158. package/src/subsystems/Security/Credentials.helper.ts +62 -0
  159. package/src/subsystems/Security/ManagedVault.service/ManagedVaultConnector.ts +34 -0
  160. package/src/subsystems/Security/ManagedVault.service/connectors/NullManagedVault.class.ts +57 -0
  161. package/src/subsystems/Security/ManagedVault.service/connectors/SecretManagerManagedVault.ts +154 -0
  162. package/src/subsystems/Security/ManagedVault.service/index.ts +12 -0
  163. package/src/subsystems/Security/SecureConnector.class.ts +110 -0
  164. package/src/subsystems/Security/Vault.service/Vault.helper.ts +30 -0
  165. package/src/subsystems/Security/Vault.service/VaultConnector.ts +26 -0
  166. package/src/subsystems/Security/Vault.service/connectors/HashicorpVault.class.ts +46 -0
  167. package/src/subsystems/Security/Vault.service/connectors/JSONFileVault.class.ts +166 -0
  168. package/src/subsystems/Security/Vault.service/connectors/NullVault.class.ts +54 -0
  169. package/src/subsystems/Security/Vault.service/connectors/SecretsManager.class.ts +140 -0
  170. package/src/subsystems/Security/Vault.service/index.ts +12 -0
  171. package/src/types/ACL.types.ts +104 -0
  172. package/src/types/AWS.types.ts +9 -0
  173. package/src/types/Agent.types.ts +61 -0
  174. package/src/types/AgentLogger.types.ts +17 -0
  175. package/src/types/Cache.types.ts +1 -0
  176. package/src/types/Common.types.ts +3 -0
  177. package/src/types/LLM.types.ts +419 -0
  178. package/src/types/Redis.types.ts +8 -0
  179. package/src/types/SRE.types.ts +64 -0
  180. package/src/types/Security.types.ts +18 -0
  181. package/src/types/Storage.types.ts +5 -0
  182. package/src/types/VectorDB.types.ts +86 -0
  183. package/src/utils/base64.utils.ts +275 -0
  184. package/src/utils/cli.utils.ts +68 -0
  185. package/src/utils/data.utils.ts +263 -0
  186. package/src/utils/date-time.utils.ts +22 -0
  187. package/src/utils/general.utils.ts +238 -0
  188. package/src/utils/index.ts +12 -0
  189. package/src/utils/numbers.utils.ts +13 -0
  190. package/src/utils/oauth.utils.ts +35 -0
  191. package/src/utils/string.utils.ts +414 -0
  192. package/src/utils/url.utils.ts +19 -0
  193. package/src/utils/validation.utils.ts +74 -0
@@ -0,0 +1,32 @@
1
+ import { SecureConnector } from '@sre/Security/SecureConnector.class';
2
+ import { IAccessCandidate } from '@sre/types/ACL.types';
3
+ import { ACL } from '@sre/Security/AccessControl/ACL.class';
4
+ import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
5
+ import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
6
+ import { AgentCallLog } from '@sre/types/AgentLogger.types';
7
+
8
+ export interface ILogRequest {
9
+ log(logData: AgentCallLog, callId?: string): Promise<any>;
10
+ logTask(tasks: number, isUsingTestDomain: boolean): Promise<void>;
11
+ }
12
+
13
+ export abstract class LogConnector extends SecureConnector {
14
+ public abstract id: string;
15
+ public abstract getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL>;
16
+
17
+ public requester(candidate: AccessCandidate): ILogRequest {
18
+ if (candidate.role !== 'agent') throw new Error('Only agents can use Log connector');
19
+
20
+ return {
21
+ log: async (logData: AgentCallLog, callId?: string) => {
22
+ return await this.log(candidate.writeRequest, logData, callId);
23
+ },
24
+ logTask: async (tasks: number, isUsingTestDomain: boolean) => {
25
+ await this.logTask(candidate.writeRequest, tasks, isUsingTestDomain);
26
+ },
27
+ };
28
+ }
29
+
30
+ protected abstract log(acRequest: AccessRequest, logData: AgentCallLog, callId?: string): Promise<any>;
31
+ protected abstract logTask(acRequest: AccessRequest, tasks: number, isUsingTestDomain: boolean): Promise<void>;
32
+ }
@@ -0,0 +1,28 @@
1
+ import { Logger } from '@sre/helpers/Log.helper';
2
+ import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
3
+ import { ACL } from '@sre/Security/AccessControl/ACL.class';
4
+ import { IAccessCandidate } from '@sre/types/ACL.types';
5
+ import { LogConnector } from '../LogConnector';
6
+ import { AgentCallLog } from '@sre/types/AgentLogger.types';
7
+
8
+ const console = Logger('SmythLog');
9
+
10
+ export class ConsoleLog extends LogConnector {
11
+ public id: string;
12
+ public getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL> {
13
+ return Promise.resolve(new ACL());
14
+ }
15
+ protected log(acRequest: AccessRequest, logData: AgentCallLog, callId?: string): Promise<any> {
16
+ console.debug(`Log for agent ${acRequest.candidate.id}: ${typeof logData === 'string' ? logData : JSON.stringify(logData)}`);
17
+
18
+ return Promise.resolve();
19
+ }
20
+ protected logTask(acRequest: AccessRequest, tasks: number, isUsingTestDomain: boolean): Promise<void> {
21
+ console.debug(
22
+ `${tasks} Task(s) Consumed by agent ${acRequest.candidate.id}: ${isUsingTestDomain ? 'Using Test Domain' : 'Using Production Domain'}`
23
+ );
24
+
25
+ return Promise.resolve();
26
+ }
27
+ public name: string;
28
+ }
@@ -0,0 +1,13 @@
1
+ import { ConnectorService, ConnectorServiceProvider } from '@sre/Core/ConnectorsService';
2
+ import { TConnectorService } from '@sre/types/SRE.types';
3
+ import { Logger } from '@sre/helpers/Log.helper';
4
+
5
+ import { ConsoleLog } from './connectors/ConsoleLog.class';
6
+
7
+ const console = Logger('LogService');
8
+
9
+ export class LogService extends ConnectorServiceProvider {
10
+ public register() {
11
+ ConnectorService.register(TConnectorService.Log, 'ConsoleLog', ConsoleLog);
12
+ }
13
+ }
@@ -0,0 +1,41 @@
1
+ import { ACL } from '@sre/Security/AccessControl/ACL.class';
2
+ import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
3
+ import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
4
+ import { SecureConnector } from '@sre/Security/SecureConnector.class';
5
+ import { IAccessCandidate, IACL } from '@sre/types/ACL.types';
6
+ import { StorageData, StorageMetadata } from '@sre/types/Storage.types';
7
+
8
+ export interface INKVRequest {
9
+ get(namespace: string, key: string): Promise<StorageData>;
10
+ set(namespace: string, key: string, value: StorageData): Promise<void>;
11
+ delete(namespace: string, key: string): Promise<void>;
12
+ exists(namespace: string, key: string): Promise<boolean>;
13
+ deleteAll(namespace: string): Promise<void>;
14
+ list(namespace: string): Promise<{ key: string; data: StorageData }[]>;
15
+ }
16
+
17
+ /**
18
+ * NKV = Namespace-Key-Value Connector
19
+ */
20
+ export abstract class NKVConnector extends SecureConnector {
21
+ public requester(candidate: AccessCandidate): INKVRequest {
22
+ return {
23
+ get: async (namespace: string, key: string) => this.get(candidate.readRequest, namespace, key),
24
+ set: async (namespace: string, key: string, value: StorageData) => this.set(candidate.writeRequest, namespace, key, value),
25
+ delete: async (namespace: string, key: string) => this.delete(candidate.writeRequest, namespace, key),
26
+ exists: async (namespace: string, key: string) => this.exists(candidate.readRequest, namespace, key),
27
+ deleteAll: async (namespace: string) => this.deleteAll(candidate.writeRequest, namespace),
28
+ list: async (namespace: string) => this.list(candidate.readRequest, namespace),
29
+ };
30
+ }
31
+
32
+ public abstract getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL>;
33
+
34
+ protected abstract get(acRequest: AccessRequest, namespace: string, key: string): Promise<StorageData>;
35
+ protected abstract set(acRequest: AccessRequest, namespace: string, key: string, value: StorageData): Promise<void>;
36
+
37
+ protected abstract delete(acRequest: AccessRequest, namespace: string, key: string): Promise<void>;
38
+ protected abstract exists(acRequest: AccessRequest, namespace: string, key: string): Promise<boolean>;
39
+ protected abstract deleteAll(acRequest: AccessRequest, namespace: string): Promise<void>;
40
+ protected abstract list(acRequest: AccessRequest, namespace: string): Promise<{ key: string; data: StorageData }[]>;
41
+ }
@@ -0,0 +1,204 @@
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 { AccountConnector } from '@sre/Security/Account.service/AccountConnector';
11
+ import Joi from 'joi';
12
+
13
+ export class NKVRAM extends NKVConnector {
14
+ public name = 'RAM';
15
+ private storage: Map<string, any> = new Map();
16
+ private namespaces: Set<string> = new Set();
17
+ private accountConnector: AccountConnector;
18
+ private cacheConnector: CacheConnector;
19
+
20
+ constructor(protected _settings?: any) {
21
+ super(_settings);
22
+ this.accountConnector = ConnectorService.getAccountConnector();
23
+ this.cacheConnector = ConnectorService.getCacheConnector('RAM');
24
+ }
25
+
26
+ public key(...parts: string[]) {
27
+ return parts.join(':');
28
+ }
29
+
30
+ public mdKey(...parts: string[]) {
31
+ return parts.join(':');
32
+ }
33
+
34
+ @NKVRAM.Validate
35
+ @NKVRAM.NamespaceAccessControl
36
+ protected async get(acRequest: AccessRequest, namespace: string, key: string): Promise<StorageData> {
37
+ const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
38
+ const storageKey = this.key(`team_${teamId}`, namespace, key);
39
+ return this.storage.get(storageKey) || null;
40
+ }
41
+
42
+ @NKVRAM.Validate
43
+ @NKVRAM.NamespaceAccessControl
44
+ protected async set(acRequest: AccessRequest, namespace: string, key: string, value: any): Promise<void> {
45
+ const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
46
+ const storageKey = this.key(`team_${teamId}`, namespace, key);
47
+
48
+ // Store the value
49
+ this.storage.set(storageKey, value);
50
+
51
+ // Track namespace
52
+ const nsKey = this.key(`team_${teamId}`, namespace);
53
+ if (!this.namespaces.has(nsKey)) {
54
+ this.namespaces.add(nsKey);
55
+ this.storage.set(nsKey, ''); // Namespace sentinel
56
+ }
57
+ }
58
+
59
+ @NKVRAM.Validate
60
+ @NKVRAM.NamespaceAccessControl
61
+ protected async delete(acRequest: AccessRequest, namespace: string, key: string): Promise<void> {
62
+ const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
63
+ const storageKey = this.key(`team_${teamId}`, namespace, key);
64
+ this.storage.delete(storageKey);
65
+ }
66
+
67
+ @NKVRAM.Validate
68
+ @NKVRAM.NamespaceAccessControl
69
+ protected async exists(acRequest: AccessRequest, namespace: string, key: string): Promise<boolean> {
70
+ const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
71
+ const storageKey = this.key(`team_${teamId}`, namespace, key);
72
+ return this.storage.has(storageKey);
73
+ }
74
+
75
+ @NKVRAM.NamespaceAccessControl
76
+ public async list(acRequest: AccessRequest, namespace: string): Promise<{ key: string; data: StorageData }[]> {
77
+ const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
78
+ const prefix = this.key(`team_${teamId}`, namespace);
79
+ const results: { key: string; data: StorageData }[] = [];
80
+
81
+ // Find all keys that start with the prefix
82
+ for (const [storageKey, value] of this.storage.entries()) {
83
+ if (storageKey.startsWith(prefix + ':')) {
84
+ // Extract the actual key (remove prefix and separator)
85
+ const actualKey = storageKey.substring(prefix.length + 1);
86
+ results.push({
87
+ key: actualKey,
88
+ data: value as StorageData,
89
+ });
90
+ }
91
+ }
92
+
93
+ return results;
94
+ }
95
+
96
+ @NKVRAM.NamespaceAccessControl
97
+ public async deleteAll(acRequest: AccessRequest, namespace: string): Promise<void> {
98
+ const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
99
+ const prefix = this.key(`team_${teamId}`, namespace);
100
+ const keysToDelete: string[] = [];
101
+
102
+ // Find all keys that start with the prefix (excluding the namespace sentinel)
103
+ for (const storageKey of this.storage.keys()) {
104
+ if (storageKey.startsWith(prefix + ':')) {
105
+ keysToDelete.push(storageKey);
106
+ }
107
+ }
108
+
109
+ // Delete all found keys
110
+ for (const key of keysToDelete) {
111
+ this.storage.delete(key);
112
+ }
113
+ }
114
+
115
+ public async getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL> {
116
+ // Delegate ACL management to the cache connector (Redis)
117
+ return this.cacheConnector.getResourceACL(resourceId, candidate);
118
+ }
119
+
120
+ /**
121
+ * Get all keys matching a prefix (for internal use)
122
+ */
123
+ private getKeysByPrefix(prefix: string): string[] {
124
+ const keys: string[] = [];
125
+ for (const key of this.storage.keys()) {
126
+ if (key.startsWith(prefix)) {
127
+ keys.push(key);
128
+ }
129
+ }
130
+ return keys;
131
+ }
132
+
133
+ /**
134
+ * Clear all data (useful for testing)
135
+ */
136
+ public clearAll(): void {
137
+ this.storage.clear();
138
+ this.namespaces.clear();
139
+ }
140
+
141
+ /**
142
+ * Get storage statistics
143
+ */
144
+ public getStats(): { totalKeys: number; totalNamespaces: number } {
145
+ return {
146
+ totalKeys: this.storage.size,
147
+ totalNamespaces: this.namespaces.size,
148
+ };
149
+ }
150
+
151
+ static NamespaceAccessControl(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
152
+ // Store the original method in a variable
153
+ const originalMethod = descriptor.value;
154
+
155
+ // Modify the descriptor's value to wrap the original method
156
+ descriptor.value = async function (...args: any[]) {
157
+ // Extract the method arguments
158
+ let [acRequest, namespace, key] = args;
159
+ const isNamespaceSearch = key === undefined;
160
+
161
+ // Inject the access control logic
162
+ const teamId = await this.accountConnector.getCandidateTeam(acRequest.candidate);
163
+ const resourceId = isNamespaceSearch ? namespace : `${namespace}:${key}`;
164
+ const finalKey = this.key(`team_${teamId}`, resourceId);
165
+ const accessTicket = await this.getAccessTicket(finalKey, acRequest);
166
+
167
+ if (accessTicket.access !== TAccessResult.Granted) throw new ACLAccessDeniedError('Access Denied');
168
+
169
+ // Call the original method with the original arguments
170
+ return originalMethod.apply(this, args);
171
+ };
172
+
173
+ // Return the modified descriptor
174
+ return descriptor;
175
+ }
176
+
177
+ static Validate(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
178
+ // Store the original method in a variable
179
+ const originalMethod = descriptor.value;
180
+
181
+ // Modify the descriptor's value to wrap the original method
182
+ descriptor.value = async function (...args: any[]) {
183
+ // Extract the method arguments
184
+ let [acRequest, namespace, key] = args;
185
+
186
+ // Validate the arguments
187
+ const schemaValidator = Joi.object().keys({
188
+ namespace: Joi.string().min(1).required(),
189
+ key: Joi.string().min(1).required(),
190
+ });
191
+ const validationResult = schemaValidator.validate({ namespace, key });
192
+
193
+ if (validationResult.error) {
194
+ throw new Error(`Validation Error: ${validationResult.error.message}`);
195
+ }
196
+
197
+ // Call the original method with the original arguments
198
+ return originalMethod.apply(this, args);
199
+ };
200
+
201
+ // Return the modified descriptor
202
+ return descriptor;
203
+ }
204
+ }
@@ -0,0 +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
+ }
@@ -0,0 +1,12 @@
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
+ export class NKVService extends ConnectorServiceProvider {
8
+ public register() {
9
+ ConnectorService.register(TConnectorService.NKV, 'Redis', NKVRedis);
10
+ ConnectorService.register(TConnectorService.NKV, 'RAM', NKVRAM);
11
+ }
12
+ }
@@ -0,0 +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
+ }
@@ -0,0 +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
+ }
@@ -0,0 +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
+ }
@@ -0,0 +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
+ }