@smythos/sre 1.5.0 → 1.5.2

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 (189) hide show
  1. package/CHANGELOG +62 -0
  2. package/LICENSE +18 -0
  3. package/package.json +127 -115
  4. package/src/Components/APICall/APICall.class.ts +155 -0
  5. package/src/Components/APICall/AccessTokenManager.ts +130 -0
  6. package/src/Components/APICall/ArrayBufferResponse.helper.ts +58 -0
  7. package/src/Components/APICall/OAuth.helper.ts +294 -0
  8. package/src/Components/APICall/mimeTypeCategories.ts +46 -0
  9. package/src/Components/APICall/parseData.ts +167 -0
  10. package/src/Components/APICall/parseHeaders.ts +41 -0
  11. package/src/Components/APICall/parseProxy.ts +68 -0
  12. package/src/Components/APICall/parseUrl.ts +91 -0
  13. package/src/Components/APIEndpoint.class.ts +234 -0
  14. package/src/Components/APIOutput.class.ts +58 -0
  15. package/src/Components/AgentPlugin.class.ts +102 -0
  16. package/src/Components/Async.class.ts +155 -0
  17. package/src/Components/Await.class.ts +90 -0
  18. package/src/Components/Classifier.class.ts +158 -0
  19. package/src/Components/Component.class.ts +94 -0
  20. package/src/Components/ComponentHost.class.ts +38 -0
  21. package/src/Components/DataSourceCleaner.class.ts +92 -0
  22. package/src/Components/DataSourceIndexer.class.ts +181 -0
  23. package/src/Components/DataSourceLookup.class.ts +141 -0
  24. package/src/Components/FEncDec.class.ts +29 -0
  25. package/src/Components/FHash.class.ts +33 -0
  26. package/src/Components/FSign.class.ts +80 -0
  27. package/src/Components/FSleep.class.ts +25 -0
  28. package/src/Components/FTimestamp.class.ts +25 -0
  29. package/src/Components/FileStore.class.ts +75 -0
  30. package/src/Components/ForEach.class.ts +97 -0
  31. package/src/Components/GPTPlugin.class.ts +70 -0
  32. package/src/Components/GenAILLM.class.ts +395 -0
  33. package/src/Components/HuggingFace.class.ts +314 -0
  34. package/src/Components/Image/imageSettings.config.ts +70 -0
  35. package/src/Components/ImageGenerator.class.ts +407 -0
  36. package/src/Components/JSONFilter.class.ts +54 -0
  37. package/src/Components/LLMAssistant.class.ts +213 -0
  38. package/src/Components/LogicAND.class.ts +28 -0
  39. package/src/Components/LogicAtLeast.class.ts +85 -0
  40. package/src/Components/LogicAtMost.class.ts +86 -0
  41. package/src/Components/LogicOR.class.ts +29 -0
  42. package/src/Components/LogicXOR.class.ts +34 -0
  43. package/src/Components/MCPClient.class.ts +112 -0
  44. package/src/Components/PromptGenerator.class.ts +122 -0
  45. package/src/Components/ScrapflyWebScrape.class.ts +159 -0
  46. package/src/Components/TavilyWebSearch.class.ts +98 -0
  47. package/src/Components/index.ts +77 -0
  48. package/src/Core/AgentProcess.helper.ts +240 -0
  49. package/src/Core/Connector.class.ts +123 -0
  50. package/src/Core/ConnectorsService.ts +192 -0
  51. package/src/Core/DummyConnector.ts +49 -0
  52. package/src/Core/HookService.ts +105 -0
  53. package/src/Core/SmythRuntime.class.ts +292 -0
  54. package/src/Core/SystemEvents.ts +15 -0
  55. package/src/Core/boot.ts +55 -0
  56. package/src/config.ts +15 -0
  57. package/src/constants.ts +125 -0
  58. package/src/data/hugging-face.params.json +580 -0
  59. package/src/helpers/BinaryInput.helper.ts +324 -0
  60. package/src/helpers/Conversation.helper.ts +1094 -0
  61. package/src/helpers/JsonContent.helper.ts +97 -0
  62. package/src/helpers/LocalCache.helper.ts +97 -0
  63. package/src/helpers/Log.helper.ts +234 -0
  64. package/src/helpers/OpenApiParser.helper.ts +150 -0
  65. package/src/helpers/S3Cache.helper.ts +129 -0
  66. package/src/helpers/SmythURI.helper.ts +5 -0
  67. package/src/helpers/TemplateString.helper.ts +243 -0
  68. package/src/helpers/TypeChecker.helper.ts +329 -0
  69. package/src/index.ts +179 -0
  70. package/src/index.ts.bak +179 -0
  71. package/src/subsystems/AgentManager/Agent.class.ts +1108 -0
  72. package/src/subsystems/AgentManager/Agent.helper.ts +3 -0
  73. package/src/subsystems/AgentManager/AgentData.service/AgentDataConnector.ts +230 -0
  74. package/src/subsystems/AgentManager/AgentData.service/connectors/CLIAgentDataConnector.class.ts +66 -0
  75. package/src/subsystems/AgentManager/AgentData.service/connectors/LocalAgentDataConnector.class.ts +142 -0
  76. package/src/subsystems/AgentManager/AgentData.service/connectors/NullAgentData.class.ts +39 -0
  77. package/src/subsystems/AgentManager/AgentData.service/index.ts +18 -0
  78. package/src/subsystems/AgentManager/AgentLogger.class.ts +297 -0
  79. package/src/subsystems/AgentManager/AgentRequest.class.ts +51 -0
  80. package/src/subsystems/AgentManager/AgentRuntime.class.ts +559 -0
  81. package/src/subsystems/AgentManager/AgentSSE.class.ts +101 -0
  82. package/src/subsystems/AgentManager/AgentSettings.class.ts +52 -0
  83. package/src/subsystems/AgentManager/Component.service/ComponentConnector.ts +32 -0
  84. package/src/subsystems/AgentManager/Component.service/connectors/LocalComponentConnector.class.ts +59 -0
  85. package/src/subsystems/AgentManager/Component.service/index.ts +11 -0
  86. package/src/subsystems/AgentManager/EmbodimentSettings.class.ts +47 -0
  87. package/src/subsystems/AgentManager/ForkedAgent.class.ts +153 -0
  88. package/src/subsystems/AgentManager/OSResourceMonitor.ts +77 -0
  89. package/src/subsystems/ComputeManager/Code.service/CodeConnector.ts +99 -0
  90. package/src/subsystems/ComputeManager/Code.service/connectors/AWSLambdaCode.class.ts +63 -0
  91. package/src/subsystems/ComputeManager/Code.service/index.ts +11 -0
  92. package/src/subsystems/IO/CLI.service/CLIConnector.ts +47 -0
  93. package/src/subsystems/IO/CLI.service/index.ts +9 -0
  94. package/src/subsystems/IO/Log.service/LogConnector.ts +32 -0
  95. package/src/subsystems/IO/Log.service/connectors/ConsoleLog.class.ts +28 -0
  96. package/src/subsystems/IO/Log.service/index.ts +13 -0
  97. package/src/subsystems/IO/NKV.service/NKVConnector.ts +41 -0
  98. package/src/subsystems/IO/NKV.service/connectors/NKVRAM.class.ts +204 -0
  99. package/src/subsystems/IO/NKV.service/connectors/NKVRedis.class.ts +182 -0
  100. package/src/subsystems/IO/NKV.service/index.ts +12 -0
  101. package/src/subsystems/IO/Router.service/RouterConnector.ts +21 -0
  102. package/src/subsystems/IO/Router.service/connectors/ExpressRouter.class.ts +48 -0
  103. package/src/subsystems/IO/Router.service/connectors/NullRouter.class.ts +40 -0
  104. package/src/subsystems/IO/Router.service/index.ts +11 -0
  105. package/src/subsystems/IO/Storage.service/SmythFS.class.ts +472 -0
  106. package/src/subsystems/IO/Storage.service/StorageConnector.ts +66 -0
  107. package/src/subsystems/IO/Storage.service/connectors/LocalStorage.class.ts +305 -0
  108. package/src/subsystems/IO/Storage.service/connectors/S3Storage.class.ts +418 -0
  109. package/src/subsystems/IO/Storage.service/index.ts +13 -0
  110. package/src/subsystems/IO/VectorDB.service/VectorDBConnector.ts +108 -0
  111. package/src/subsystems/IO/VectorDB.service/connectors/MilvusVectorDB.class.ts +450 -0
  112. package/src/subsystems/IO/VectorDB.service/connectors/PineconeVectorDB.class.ts +373 -0
  113. package/src/subsystems/IO/VectorDB.service/connectors/RAMVecrtorDB.class.ts +420 -0
  114. package/src/subsystems/IO/VectorDB.service/embed/BaseEmbedding.ts +106 -0
  115. package/src/subsystems/IO/VectorDB.service/embed/OpenAIEmbedding.ts +109 -0
  116. package/src/subsystems/IO/VectorDB.service/embed/index.ts +21 -0
  117. package/src/subsystems/IO/VectorDB.service/index.ts +14 -0
  118. package/src/subsystems/LLMManager/LLM.helper.ts +221 -0
  119. package/src/subsystems/LLMManager/LLM.inference.ts +335 -0
  120. package/src/subsystems/LLMManager/LLM.service/LLMConnector.ts +374 -0
  121. package/src/subsystems/LLMManager/LLM.service/LLMCredentials.helper.ts +145 -0
  122. package/src/subsystems/LLMManager/LLM.service/connectors/Anthropic.class.ts +632 -0
  123. package/src/subsystems/LLMManager/LLM.service/connectors/Bedrock.class.ts +405 -0
  124. package/src/subsystems/LLMManager/LLM.service/connectors/Echo.class.ts +81 -0
  125. package/src/subsystems/LLMManager/LLM.service/connectors/GoogleAI.class.ts +689 -0
  126. package/src/subsystems/LLMManager/LLM.service/connectors/Groq.class.ts +257 -0
  127. package/src/subsystems/LLMManager/LLM.service/connectors/OpenAI.class.ts +848 -0
  128. package/src/subsystems/LLMManager/LLM.service/connectors/Perplexity.class.ts +255 -0
  129. package/src/subsystems/LLMManager/LLM.service/connectors/VertexAI.class.ts +193 -0
  130. package/src/subsystems/LLMManager/LLM.service/index.ts +43 -0
  131. package/src/subsystems/LLMManager/ModelsProvider.service/ModelsProviderConnector.ts +281 -0
  132. package/src/subsystems/LLMManager/ModelsProvider.service/connectors/SmythModelsProvider.class.ts +229 -0
  133. package/src/subsystems/LLMManager/ModelsProvider.service/index.ts +11 -0
  134. package/src/subsystems/LLMManager/custom-models.ts +854 -0
  135. package/src/subsystems/LLMManager/models.ts +2539 -0
  136. package/src/subsystems/LLMManager/paramMappings.ts +69 -0
  137. package/src/subsystems/MemoryManager/Cache.service/CacheConnector.ts +86 -0
  138. package/src/subsystems/MemoryManager/Cache.service/connectors/LocalStorageCache.class.ts +297 -0
  139. package/src/subsystems/MemoryManager/Cache.service/connectors/RAMCache.class.ts +201 -0
  140. package/src/subsystems/MemoryManager/Cache.service/connectors/RedisCache.class.ts +252 -0
  141. package/src/subsystems/MemoryManager/Cache.service/connectors/S3Cache.class.ts +373 -0
  142. package/src/subsystems/MemoryManager/Cache.service/index.ts +15 -0
  143. package/src/subsystems/MemoryManager/LLMCache.ts +72 -0
  144. package/src/subsystems/MemoryManager/LLMContext.ts +125 -0
  145. package/src/subsystems/MemoryManager/RuntimeContext.ts +249 -0
  146. package/src/subsystems/Security/AccessControl/ACL.class.ts +208 -0
  147. package/src/subsystems/Security/AccessControl/AccessCandidate.class.ts +76 -0
  148. package/src/subsystems/Security/AccessControl/AccessRequest.class.ts +52 -0
  149. package/src/subsystems/Security/Account.service/AccountConnector.ts +41 -0
  150. package/src/subsystems/Security/Account.service/connectors/AWSAccount.class.ts +76 -0
  151. package/src/subsystems/Security/Account.service/connectors/DummyAccount.class.ts +130 -0
  152. package/src/subsystems/Security/Account.service/connectors/JSONFileAccount.class.ts +159 -0
  153. package/src/subsystems/Security/Account.service/index.ts +14 -0
  154. package/src/subsystems/Security/Credentials.helper.ts +62 -0
  155. package/src/subsystems/Security/ManagedVault.service/ManagedVaultConnector.ts +34 -0
  156. package/src/subsystems/Security/ManagedVault.service/connectors/NullManagedVault.class.ts +57 -0
  157. package/src/subsystems/Security/ManagedVault.service/connectors/SecretManagerManagedVault.ts +154 -0
  158. package/src/subsystems/Security/ManagedVault.service/index.ts +12 -0
  159. package/src/subsystems/Security/SecureConnector.class.ts +110 -0
  160. package/src/subsystems/Security/Vault.service/Vault.helper.ts +30 -0
  161. package/src/subsystems/Security/Vault.service/VaultConnector.ts +26 -0
  162. package/src/subsystems/Security/Vault.service/connectors/HashicorpVault.class.ts +46 -0
  163. package/src/subsystems/Security/Vault.service/connectors/JSONFileVault.class.ts +166 -0
  164. package/src/subsystems/Security/Vault.service/connectors/NullVault.class.ts +54 -0
  165. package/src/subsystems/Security/Vault.service/connectors/SecretsManager.class.ts +140 -0
  166. package/src/subsystems/Security/Vault.service/index.ts +12 -0
  167. package/src/types/ACL.types.ts +104 -0
  168. package/src/types/AWS.types.ts +9 -0
  169. package/src/types/Agent.types.ts +61 -0
  170. package/src/types/AgentLogger.types.ts +17 -0
  171. package/src/types/Cache.types.ts +1 -0
  172. package/src/types/Common.types.ts +3 -0
  173. package/src/types/LLM.types.ts +419 -0
  174. package/src/types/Redis.types.ts +8 -0
  175. package/src/types/SRE.types.ts +64 -0
  176. package/src/types/Security.types.ts +18 -0
  177. package/src/types/Storage.types.ts +5 -0
  178. package/src/types/VectorDB.types.ts +78 -0
  179. package/src/utils/base64.utils.ts +275 -0
  180. package/src/utils/cli.utils.ts +68 -0
  181. package/src/utils/data.utils.ts +263 -0
  182. package/src/utils/date-time.utils.ts +22 -0
  183. package/src/utils/general.utils.ts +238 -0
  184. package/src/utils/index.ts +12 -0
  185. package/src/utils/numbers.utils.ts +13 -0
  186. package/src/utils/oauth.utils.ts +35 -0
  187. package/src/utils/string.utils.ts +414 -0
  188. package/src/utils/url.utils.ts +19 -0
  189. package/src/utils/validation.utils.ts +74 -0
@@ -0,0 +1,69 @@
1
+ // ! DEPRECATED: will be removed this file
2
+ export default {
3
+ Echo: {
4
+ maxTokens: 'max_tokens',
5
+ temperature: 'temperature',
6
+ stopSequences: 'stop',
7
+ topP: 'top_p',
8
+ frequencyPenalty: 'frequency_penalty',
9
+ presencePenalty: 'presence_penalty',
10
+ },
11
+ OpenAI: {
12
+ maxTokens: 'max_tokens',
13
+ temperature: 'temperature',
14
+ stopSequences: 'stop',
15
+ topP: 'top_p',
16
+ frequencyPenalty: 'frequency_penalty',
17
+ presencePenalty: 'presence_penalty',
18
+ },
19
+ cohere: {
20
+ maxTokens: 'max_tokens',
21
+ temperature: 'temperature',
22
+ stopSequences: 'stop_sequences',
23
+ topP: 'p',
24
+ topK: 'k',
25
+ frequencyPenalty: 'frequency_penalty',
26
+ presencePenalty: 'presence_penalty',
27
+ },
28
+ TogetherAI: {
29
+ maxTokens: 'max_tokens',
30
+ temperature: 'temperature',
31
+ stopSequences: 'stop',
32
+ topP: 'top_p',
33
+ topK: 'top_k',
34
+ frequencyPenalty: 'repetition_penalty',
35
+ },
36
+ Anthropic: {
37
+ maxTokens: 'max_tokens',
38
+ temperature: 'temperature',
39
+ stopSequences: 'stop_sequences',
40
+ topP: 'top_p',
41
+ topK: 'top_k',
42
+ },
43
+ GoogleAI: {
44
+ maxTokens: 'maxOutputTokens',
45
+ temperature: 'temperature',
46
+ stopSequences: 'stopSequences',
47
+ topP: 'topP',
48
+ topK: 'topK',
49
+ },
50
+ Groq: {
51
+ maxTokens: 'max_tokens',
52
+ temperature: 'temperature',
53
+ stopSequences: 'stop',
54
+ topP: 'top_p',
55
+ },
56
+ Bedrock: {
57
+ maxTokens: 'maxTokens',
58
+ temperature: 'temperature',
59
+ stopSequences: 'stopSequences',
60
+ topP: 'topP',
61
+ },
62
+ VertexAI: {
63
+ maxTokens: 'maxOutputTokens',
64
+ temperature: 'temperature',
65
+ stopSequences: 'stopSequences',
66
+ topP: 'topP',
67
+ topK: 'topK',
68
+ },
69
+ };
@@ -0,0 +1,86 @@
1
+ import { Connector } from '@sre/Core/Connector.class';
2
+ import { AccessCandidate } from '@sre/Security/AccessControl/AccessCandidate.class';
3
+ import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
4
+ import { ACL } from '@sre/Security/AccessControl/ACL.class';
5
+ import { SecureConnector } from '@sre/Security/SecureConnector.class';
6
+ import { IACL, IAccessCandidate, IAccessRequest } from '@sre/types/ACL.types';
7
+ import { CacheMetadata } from '@sre/types/Cache.types';
8
+
9
+ export interface ICacheRequest {
10
+ get: (key: string) => Promise<any>;
11
+
12
+ /**
13
+ * Set a value in the cache
14
+ * @param key
15
+ * @param data
16
+ * @param acl
17
+ * @param metadata
18
+ * @param ttl Cache time to live in seconds
19
+ * @returns
20
+ */
21
+ set: (key: string, data: any, acl?: IACL, metadata?: CacheMetadata, ttl?: number) => Promise<boolean>;
22
+ delete: (key: string) => Promise<void>;
23
+ exists: (key: string) => Promise<boolean>;
24
+
25
+ getMetadata: (key: string) => Promise<CacheMetadata | undefined>;
26
+ setMetadata: (key: string, metadata: CacheMetadata) => Promise<void>;
27
+
28
+ updateTTL: (key: string, ttl?: number) => Promise<void>;
29
+ getTTL: (key: string) => Promise<number>;
30
+
31
+ getACL: (key: string) => Promise<IACL | undefined>;
32
+ setACL: (key: string, acl: IACL) => Promise<void>;
33
+ }
34
+
35
+ export abstract class CacheConnector extends SecureConnector {
36
+ public abstract getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL>;
37
+ public requester(candidate: AccessCandidate): ICacheRequest {
38
+ return {
39
+ get: async (key: string) => {
40
+ return await this.get(candidate.readRequest, key);
41
+ },
42
+ set: async (key: string, data: any, acl?: IACL, metadata?: CacheMetadata, ttl?: number) => {
43
+ return await this.set(candidate.writeRequest, key, data, acl, metadata, ttl);
44
+ },
45
+ delete: async (key: string) => {
46
+ await this.delete(candidate.writeRequest, key);
47
+ },
48
+ exists: async (key: string) => {
49
+ return await this.exists(candidate.readRequest, key);
50
+ },
51
+
52
+ getMetadata: async (key: string) => {
53
+ return await this.getMetadata(candidate.readRequest, key);
54
+ },
55
+ setMetadata: async (key: string, metadata: CacheMetadata) => {
56
+ await this.setMetadata(candidate.writeRequest, key, metadata);
57
+ },
58
+ updateTTL: async (key: string, ttl?: number) => {
59
+ await this.updateTTL(candidate.writeRequest, key, ttl);
60
+ },
61
+ getTTL: async (key: string) => {
62
+ return await this.getTTL(candidate.readRequest, key);
63
+ },
64
+ getACL: async (key: string) => {
65
+ return await this.getACL(candidate.readRequest, key);
66
+ },
67
+ setACL: async (key: string, acl: IACL) => {
68
+ await this.setACL(candidate.writeRequest, key, acl);
69
+ },
70
+ };
71
+ }
72
+
73
+ abstract get(acRequest: AccessRequest, key: string): Promise<any>;
74
+ abstract set(acRequest: AccessRequest, key: string, data: any, acl?: IACL, metadata?: CacheMetadata, ttl?: number): Promise<boolean>;
75
+ abstract delete(acRequest: AccessRequest, key: string): Promise<void>;
76
+ abstract exists(acRequest: AccessRequest, key: string): Promise<boolean>;
77
+
78
+ abstract getMetadata(acRequest: AccessRequest, key: string): Promise<CacheMetadata | undefined>;
79
+ abstract setMetadata(acRequest: AccessRequest, key: string, metadata: CacheMetadata): Promise<void>;
80
+
81
+ abstract updateTTL(acRequest: AccessRequest, key: string, ttl?: number): Promise<void>;
82
+ abstract getTTL(acRequest: AccessRequest, key: string): Promise<number>;
83
+
84
+ abstract getACL(acRequest: AccessRequest, key: string): Promise<IACL | undefined>;
85
+ abstract setACL(acRequest: AccessRequest, key: string, acl: IACL): Promise<void>;
86
+ }
@@ -0,0 +1,297 @@
1
+ import { Logger } from '@sre/helpers/Log.helper';
2
+ import { IAccessCandidate, IACL, TAccessLevel } from '@sre/types/ACL.types';
3
+ import { CacheMetadata } from '@sre/types/Cache.types';
4
+ import { CacheConnector } from '../CacheConnector';
5
+ import { ACL } from '@sre/Security/AccessControl/ACL.class';
6
+ import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
7
+ import { SecureConnector } from '@sre/Security/SecureConnector.class';
8
+ import os from 'os';
9
+
10
+ import { existsSync, mkdirSync, readFileSync, unlinkSync, writeFileSync } from 'fs';
11
+ import path from 'path';
12
+ import { LocalStorageConfig } from '@sre/IO/Storage.service/connectors/LocalStorage.class';
13
+
14
+ const console = Logger('LocalStorageCache');
15
+
16
+ export class LocalStorageCache extends CacheConnector {
17
+ public name: string = 'LocalStorageCache';
18
+ private folder: string;
19
+ private _prefix: string = 'cache';
20
+ private _mdPrefix: string = 'cache.metadata';
21
+ private isInitialized: boolean = false;
22
+ constructor(_settings: LocalStorageConfig) {
23
+ super(_settings);
24
+ this.folder = _settings.folder || `${os.tmpdir()}/.smyth/cache`;
25
+ this.initialize();
26
+ }
27
+
28
+ private async initialize() {
29
+ if (!existsSync(this.folder)) {
30
+ mkdirSync(this.folder, { recursive: true });
31
+ }
32
+ const cacheFolderPath = path.join(this.folder, this._prefix);
33
+ if (!existsSync(cacheFolderPath)) {
34
+ mkdirSync(cacheFolderPath, { recursive: true });
35
+ }
36
+ const metadataFolderPath = path.join(this.folder, this._mdPrefix);
37
+ if (!existsSync(metadataFolderPath)) {
38
+ mkdirSync(metadataFolderPath, { recursive: true });
39
+ writeFileSync(
40
+ path.join(metadataFolderPath, 'README_IMPORTANT.txt'),
41
+ 'This folder is used for smythOS metadata, do not delete it, it will break SmythOS cache functionality'
42
+ );
43
+ }
44
+ this.isInitialized = true;
45
+ }
46
+
47
+ public get prefix() {
48
+ return this._prefix;
49
+ }
50
+
51
+ public get mdPrefix() {
52
+ return this._mdPrefix;
53
+ }
54
+
55
+ @SecureConnector.AccessControl
56
+ public async get(acRequest: AccessRequest, key: string): Promise<string | null> {
57
+ if (!this.isInitialized) {
58
+ await this.initialize();
59
+ }
60
+ try {
61
+ const filePath = this.getStorageFilePath(acRequest.candidate.id, key);
62
+ if (!existsSync(filePath)) return undefined;
63
+ const data = readFileSync(filePath, 'utf-8');
64
+ const metadataFilePath = this.getMetadataFilePath(acRequest.candidate.id, key);
65
+ const metadata = readFileSync(metadataFilePath, 'utf-8');
66
+ const metadataObject = JSON.parse(metadata);
67
+ if (metadataObject['expiresAt'] && metadataObject['expiresAt'] < Date.now()) {
68
+ await this.delete(acRequest, key);
69
+ return undefined;
70
+ }
71
+ return data;
72
+ } catch (error) {
73
+ console.error(`Error reading object from local storage`, error.name, error.message);
74
+ throw error;
75
+ }
76
+ }
77
+
78
+ @SecureConnector.AccessControl
79
+ public async set(acRequest: AccessRequest, key: string, data: any, acl?: IACL, metadata?: CacheMetadata, ttl?: number): Promise<boolean> {
80
+ // ttl is in seconds
81
+ if (!this.isInitialized) {
82
+ await this.initialize();
83
+ }
84
+ const accessCandidate = acRequest.candidate;
85
+
86
+ let amzACL = ACL.from(acl).addAccess(accessCandidate.role, accessCandidate.id, TAccessLevel.Owner).ACL;
87
+ let fileMetadata = {
88
+ ...metadata,
89
+ acl: amzACL,
90
+ ...(ttl ? { expiresAt: Date.now() + ttl * 1000 } : {}),
91
+ };
92
+ // To create the directories for the resource we need to know the full path of the resource
93
+ const storageFolderPath = this.getStorageFilePath(acRequest.candidate.id, key, true);
94
+ this.createDirectories(storageFolderPath, key);
95
+ //now we can write the file
96
+ const filePath = this.getStorageFilePath(acRequest.candidate.id, key);
97
+ writeFileSync(filePath, data as Buffer);
98
+ //now we can write the metadata
99
+ await this.setMetadata(acRequest, key, fileMetadata);
100
+ return true;
101
+ }
102
+
103
+ @SecureConnector.AccessControl
104
+ public async delete(acRequest: AccessRequest, key: string): Promise<void> {
105
+ try {
106
+ const filePath = this.getStorageFilePath(acRequest.candidate.id, key);
107
+ if (!existsSync(filePath)) return;
108
+ unlinkSync(filePath);
109
+ const metadataFilePath = this.getMetadataFilePath(acRequest.candidate.id, key);
110
+ unlinkSync(metadataFilePath);
111
+ } catch (error) {
112
+ console.error(`Error deleting object from local storage`, error.name, error.message);
113
+ throw error;
114
+ }
115
+ }
116
+ @SecureConnector.AccessControl
117
+ public async exists(acRequest: AccessRequest, key: string): Promise<boolean> {
118
+ if (!this.isInitialized) {
119
+ await this.initialize();
120
+ }
121
+ const filePath = this.getStorageFilePath(acRequest.candidate.id, key);
122
+ if (!existsSync(filePath)) return false;
123
+ const metadataFilePath = this.getMetadataFilePath(acRequest.candidate.id, key);
124
+ if (!existsSync(metadataFilePath)) return false;
125
+ const metadata = readFileSync(metadataFilePath, 'utf-8');
126
+ const metadataObject = JSON.parse(metadata);
127
+ if (metadataObject['expiresAt'] && metadataObject['expiresAt'] < Date.now()) {
128
+ await this.delete(acRequest, key);
129
+ return false;
130
+ }
131
+ return true;
132
+ }
133
+
134
+ @SecureConnector.AccessControl
135
+ public async getMetadata(acRequest: AccessRequest, key: string): Promise<CacheMetadata> {
136
+ try {
137
+ const metadataFilePath = this.getMetadataFilePath(acRequest.candidate.id, key);
138
+ if (!existsSync(metadataFilePath)) return undefined;
139
+ const data = readFileSync(metadataFilePath, 'utf-8');
140
+ return this.deserializeMetadata(JSON.parse(data)) as CacheMetadata;
141
+ } catch (error) {
142
+ console.error(`Error reading metadata from LocalStorage`, error.name, error.message);
143
+ throw error;
144
+ }
145
+ }
146
+
147
+ @SecureConnector.AccessControl
148
+ public async setMetadata(acRequest: AccessRequest, key: string, metadata: CacheMetadata): Promise<void> {
149
+ try {
150
+ let fileMetadata = await this.getMetadata(acRequest, key);
151
+ if (!fileMetadata) fileMetadata = {};
152
+
153
+ fileMetadata = { ...fileMetadata, ...metadata };
154
+ // To create the directories for the resource we need to know the full path of the resource
155
+ const metadataFolderPath = this.getMetadataFilePath(acRequest.candidate.id, key, true);
156
+ this.createDirectories(metadataFolderPath, key);
157
+ //now we can write the metadata
158
+ const metadataFilePath = this.getMetadataFilePath(acRequest.candidate.id, key);
159
+ const serializedMetadata = this.serializeMetadata(fileMetadata);
160
+ writeFileSync(metadataFilePath, JSON.stringify(serializedMetadata));
161
+ } catch (error) {
162
+ console.error(`Error setting metadata in local storage`, error.name, error.message);
163
+ throw error;
164
+ }
165
+ }
166
+
167
+ @SecureConnector.AccessControl
168
+ public async updateTTL(acRequest: AccessRequest, key: string, ttl?: number): Promise<void> {
169
+ // ttl is in seconds
170
+ if (ttl) {
171
+ const metadataFilePath = this.getMetadataFilePath(acRequest.candidate.id, key);
172
+ const metadata = readFileSync(metadataFilePath, 'utf-8');
173
+ const metadataObject = JSON.parse(metadata);
174
+ metadataObject['expiresAt'] = Date.now() + ttl * 1000;
175
+ writeFileSync(metadataFilePath, JSON.stringify(metadataObject));
176
+ }
177
+ }
178
+
179
+ @SecureConnector.AccessControl
180
+ public async getTTL(acRequest: AccessRequest, key: string): Promise<number> {
181
+ const metadataFilePath = this.getMetadataFilePath(acRequest.candidate.id, key);
182
+ const metadata = readFileSync(metadataFilePath, 'utf-8');
183
+ const metadataObject = JSON.parse(metadata);
184
+ return metadataObject['expiresAt'] && metadataObject['expiresAt'] > Date.now()
185
+ ? Math.floor((metadataObject['expiresAt'] - Date.now()) / 1000)
186
+ : 0;
187
+ }
188
+
189
+ public async getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL> {
190
+ if (!this.isInitialized) {
191
+ await this.initialize();
192
+ }
193
+ const metadataFilePath = this.getMetadataFilePath(candidate.id, resourceId);
194
+ if (!existsSync(metadataFilePath)) return new ACL().addAccess(candidate.role, candidate.id, TAccessLevel.Owner);
195
+ const metadata = readFileSync(metadataFilePath, 'utf-8');
196
+ const exists = metadata !== undefined; //undefined metadata means the resource does not exist
197
+
198
+ if (!exists) {
199
+ //the resource does not exist yet, we grant write access to the candidate in order to allow the resource creation
200
+ return new ACL().addAccess(candidate.role, candidate.id, TAccessLevel.Owner);
201
+ }
202
+ try {
203
+ let metadataObject = JSON.parse(metadata);
204
+ return ACL.from(metadataObject?.['acl'] as IACL);
205
+ } catch (error) {
206
+ console.error(`Error parsing metadata in local storage`, error.name, error.message);
207
+ throw error;
208
+ }
209
+ }
210
+
211
+ @SecureConnector.AccessControl
212
+ async getACL(acRequest: AccessRequest, key: string): Promise<IACL> {
213
+ try {
214
+ const fileMetadata = await this.getMetadata(acRequest, key);
215
+ return ACL.from(fileMetadata?.['acl'] as IACL);
216
+ } catch (error) {
217
+ console.error(`Error getting access rights in local storage`, error.name, error.message);
218
+ throw error;
219
+ }
220
+ }
221
+
222
+ @SecureConnector.AccessControl
223
+ async setACL(acRequest: AccessRequest, key: string, acl: IACL) {
224
+ try {
225
+ let fileMetadata = await this.getMetadata(acRequest, key);
226
+ if (!fileMetadata) fileMetadata = {};
227
+ //when setting ACL make sure to not lose ownership
228
+ fileMetadata['acl'] = ACL.from(acl).addAccess(acRequest.candidate.role, acRequest.candidate.id, TAccessLevel.Owner).ACL;
229
+ await this.setMetadata(acRequest, key, fileMetadata);
230
+ } catch (error) {
231
+ console.error(`Error setting access rights in local storage`, error);
232
+ throw error;
233
+ }
234
+ }
235
+ private serializeMetadata(metadata: Record<string, any>): Record<string, string> {
236
+ let updatedMetadata = {};
237
+ if (metadata['acl']) {
238
+ if (metadata['acl']) {
239
+ updatedMetadata['acl'] = typeof metadata['acl'] == 'string' ? metadata['acl'] : ACL.from(metadata['acl']).serializedACL;
240
+ }
241
+
242
+ delete metadata['acl'];
243
+ }
244
+
245
+ for (let key in metadata) {
246
+ if (key == 'ContentType') continue; //skip ContentType as it can only be set when writing the object
247
+ updatedMetadata[key] = typeof metadata[key] === 'string' ? metadata[key] : JSON.stringify(metadata[key]);
248
+ }
249
+
250
+ return updatedMetadata;
251
+ }
252
+
253
+ private deserializeMetadata(metadata: Record<string, string>): Record<string, any> {
254
+ let deserializedMetadata: Record<string, any> = {};
255
+
256
+ for (let key in metadata) {
257
+ if (key === 'acl') {
258
+ deserializedMetadata[key] = ACL.from(metadata[key]).ACL;
259
+ continue;
260
+ }
261
+
262
+ try {
263
+ deserializedMetadata[key] = JSON.parse(metadata[key]);
264
+ } catch (error) {
265
+ deserializedMetadata[key] = metadata[key];
266
+ }
267
+ }
268
+ return deserializedMetadata;
269
+ }
270
+
271
+ private getStorageFilePath(teamId: string, resourceId: string, returnBasePath: boolean = false) {
272
+ if (!existsSync(path.join(this.folder, this._prefix, teamId))) {
273
+ mkdirSync(path.join(this.folder, this._prefix, teamId));
274
+ }
275
+ if (returnBasePath) return path.join(this.folder, this._prefix, teamId);
276
+ return path.join(this.folder, this._prefix, teamId, resourceId);
277
+ }
278
+
279
+ private getMetadataFilePath(teamId: string, resourceId: string, returnBasePath: boolean = false) {
280
+ if (!existsSync(path.join(this.folder, this._mdPrefix, teamId))) {
281
+ mkdirSync(path.join(this.folder, this._mdPrefix, teamId));
282
+ }
283
+ if (returnBasePath) return path.join(this.folder, this._mdPrefix, teamId);
284
+ return path.join(this.folder, this._mdPrefix, teamId, resourceId);
285
+ }
286
+
287
+ private createDirectories(basePath: string, resourceId: string) {
288
+ const folders = resourceId.split('/').slice(0, -1);
289
+ let currentPath = basePath;
290
+ for (let folder of folders) {
291
+ currentPath = path.join(currentPath, folder);
292
+ if (!existsSync(currentPath)) {
293
+ mkdirSync(currentPath);
294
+ }
295
+ }
296
+ }
297
+ }
@@ -0,0 +1,201 @@
1
+ import { Logger } from '@sre/helpers/Log.helper';
2
+ import { IAccessCandidate, IACL, TAccessLevel } from '@sre/types/ACL.types';
3
+ import { CacheMetadata } from '@sre/types/Cache.types';
4
+ import { CacheConnector } from '../CacheConnector';
5
+ import { ACL } from '@sre/Security/AccessControl/ACL.class';
6
+ import { AccessRequest } from '@sre/Security/AccessControl/AccessRequest.class';
7
+ import { SecureConnector } from '@sre/Security/SecureConnector.class';
8
+ import { debounce } from '@sre/utils/general.utils';
9
+
10
+ const console = Logger('RAMCache');
11
+
12
+ interface CacheEntry {
13
+ value: any;
14
+ metadata: CacheMetadata;
15
+ expiresAt?: number;
16
+ }
17
+
18
+ export class RAMCache extends CacheConnector {
19
+ public name: string = 'RAMCache';
20
+ private _prefix: string = 'smyth:cache';
21
+ private _mdPrefix: string = 'smyth:metadata';
22
+ private cache: Map<string, CacheEntry> = new Map();
23
+ private cleanupInterval: NodeJS.Timeout;
24
+
25
+ constructor(protected _settings: any) {
26
+ super(_settings);
27
+ // Set up cleanup interval to remove expired entries
28
+
29
+ this.cleanupInterval = setInterval(() => this.cleanupExpiredEntries(), 60000); // Clean up every minute
30
+ this.cleanupInterval.unref();
31
+ }
32
+
33
+ public get prefix() {
34
+ return this._prefix;
35
+ }
36
+
37
+ public get mdPrefix() {
38
+ return this._mdPrefix;
39
+ }
40
+
41
+ private getFullKey(key: string): string {
42
+ return `${this._prefix}:${key}`;
43
+ }
44
+
45
+ private getFullMetadataKey(key: string): string {
46
+ return `${this._mdPrefix}:${key}`;
47
+ }
48
+
49
+ private cleanupExpiredEntries() {
50
+ const now = Date.now();
51
+ for (const [key, entry] of this.cache.entries()) {
52
+ if (entry.expiresAt && entry.expiresAt < now) {
53
+ this.cache.delete(key);
54
+ }
55
+ }
56
+ }
57
+
58
+ @SecureConnector.AccessControl
59
+ public async get(acRequest: AccessRequest, key: string): Promise<string | null> {
60
+ const fullKey = this.getFullKey(key);
61
+ const entry = this.cache.get(fullKey);
62
+
63
+ if (!entry) return null;
64
+
65
+ if (entry.expiresAt && entry.expiresAt < Date.now()) {
66
+ this.cache.delete(fullKey);
67
+ return null;
68
+ }
69
+
70
+ return entry.value;
71
+ }
72
+
73
+ @SecureConnector.AccessControl
74
+ public async set(acRequest: AccessRequest, key: string, data: any, acl?: IACL, metadata?: CacheMetadata, ttl?: number): Promise<boolean> {
75
+ const accessCandidate = acRequest.candidate;
76
+ const fullKey = this.getFullKey(key);
77
+ const fullMetadataKey = this.getFullMetadataKey(key);
78
+
79
+ const newMetadata: CacheMetadata = metadata || {};
80
+ newMetadata.acl = ACL.from(acl).addAccess(accessCandidate.role, accessCandidate.id, TAccessLevel.Owner).ACL;
81
+
82
+ const entry: CacheEntry = {
83
+ value: data,
84
+ metadata: newMetadata,
85
+ expiresAt: ttl ? Date.now() + ttl * 1000 : undefined,
86
+ };
87
+
88
+ this.cache.set(fullKey, entry);
89
+ this.cache.set(fullMetadataKey, entry);
90
+
91
+ return true;
92
+ }
93
+
94
+ @SecureConnector.AccessControl
95
+ public async delete(acRequest: AccessRequest, key: string): Promise<void> {
96
+ const fullKey = this.getFullKey(key);
97
+ const fullMetadataKey = this.getFullMetadataKey(key);
98
+ this.cache.delete(fullKey);
99
+ this.cache.delete(fullMetadataKey);
100
+ }
101
+
102
+ @SecureConnector.AccessControl
103
+ public async exists(acRequest: AccessRequest, key: string): Promise<boolean> {
104
+ const fullKey = this.getFullKey(key);
105
+ const entry = this.cache.get(fullKey);
106
+
107
+ if (!entry) return false;
108
+
109
+ if (entry.expiresAt && entry.expiresAt < Date.now()) {
110
+ this.cache.delete(fullKey);
111
+ return false;
112
+ }
113
+
114
+ return true;
115
+ }
116
+
117
+ @SecureConnector.AccessControl
118
+ public async getMetadata(acRequest: AccessRequest, key: string): Promise<CacheMetadata> {
119
+ if (!(await this.exists(acRequest, key))) return undefined;
120
+
121
+ const fullMetadataKey = this.getFullMetadataKey(key);
122
+ const entry = this.cache.get(fullMetadataKey);
123
+ return entry?.metadata || {};
124
+ }
125
+
126
+ @SecureConnector.AccessControl
127
+ public async setMetadata(acRequest: AccessRequest, key: string, metadata: CacheMetadata): Promise<void> {
128
+ const fullMetadataKey = this.getFullMetadataKey(key);
129
+ const entry = this.cache.get(fullMetadataKey);
130
+
131
+ if (entry) {
132
+ entry.metadata = metadata;
133
+ this.cache.set(fullMetadataKey, entry);
134
+ }
135
+ }
136
+
137
+ @SecureConnector.AccessControl
138
+ public async updateTTL(acRequest: AccessRequest, key: string, ttl?: number): Promise<void> {
139
+ const fullKey = this.getFullKey(key);
140
+ const fullMetadataKey = this.getFullMetadataKey(key);
141
+ const entry = this.cache.get(fullKey);
142
+
143
+ if (entry) {
144
+ entry.expiresAt = ttl ? Date.now() + ttl * 1000 : undefined;
145
+ this.cache.set(fullKey, entry);
146
+ this.cache.set(fullMetadataKey, entry);
147
+ }
148
+ }
149
+
150
+ @SecureConnector.AccessControl
151
+ public async getTTL(acRequest: AccessRequest, key: string): Promise<number> {
152
+ const fullKey = this.getFullKey(key);
153
+ const entry = this.cache.get(fullKey);
154
+
155
+ if (!entry || !entry.expiresAt) return -1;
156
+
157
+ const remaining = Math.ceil((entry.expiresAt - Date.now()) / 1000);
158
+ return remaining > 0 ? remaining : -1;
159
+ }
160
+
161
+ public async getResourceACL(resourceId: string, candidate: IAccessCandidate): Promise<ACL> {
162
+ const fullMetadataKey = this.getFullMetadataKey(resourceId);
163
+ const entry = this.cache.get(fullMetadataKey);
164
+
165
+ if (!entry) {
166
+ return new ACL().addAccess(candidate.role, candidate.id, TAccessLevel.Owner);
167
+ }
168
+
169
+ return ACL.from(entry.metadata?.acl as IACL);
170
+ }
171
+
172
+ @SecureConnector.AccessControl
173
+ async getACL(acRequest: AccessRequest, key: string): Promise<IACL> {
174
+ try {
175
+ const metadata = await this.getMetadata(acRequest, key);
176
+ return (metadata?.acl as IACL) || {};
177
+ } catch (error) {
178
+ console.error(`Error getting access rights in RAMCache`, error.name, error.message);
179
+ throw error;
180
+ }
181
+ }
182
+
183
+ @SecureConnector.AccessControl
184
+ async setACL(acRequest: AccessRequest, key: string, acl: IACL) {
185
+ try {
186
+ let metadata = await this.getMetadata(acRequest, key);
187
+ if (!metadata) metadata = {};
188
+ metadata.acl = ACL.from(acl).addAccess(acRequest.candidate.role, acRequest.candidate.id, TAccessLevel.Owner).ACL;
189
+ await this.setMetadata(acRequest, key, metadata);
190
+ } catch (error) {
191
+ console.error(`Error setting access rights in RAMCache`, error);
192
+ throw error;
193
+ }
194
+ }
195
+
196
+ public async stop() {
197
+ super.stop();
198
+ clearInterval(this.cleanupInterval);
199
+ this.cache.clear();
200
+ }
201
+ }