@smythos/sre 1.5.46 → 1.5.50

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 (224) hide show
  1. package/CHANGELOG +98 -90
  2. package/LICENSE +18 -18
  3. package/README.md +135 -135
  4. package/dist/bundle-analysis-lazy.html +4949 -0
  5. package/dist/bundle-analysis.html +4949 -0
  6. package/dist/index.js +3 -3
  7. package/dist/index.js.map +1 -1
  8. package/dist/types/Components/MCPClient.class.d.ts +1 -0
  9. package/dist/types/subsystems/LLMManager/LLM.service/connectors/openai/OpenAIConnector.class.d.ts +1 -6
  10. package/dist/types/utils/package-manager.utils.d.ts +26 -0
  11. package/package.json +1 -1
  12. package/src/Components/APICall/APICall.class.ts +156 -156
  13. package/src/Components/APICall/AccessTokenManager.ts +130 -130
  14. package/src/Components/APICall/ArrayBufferResponse.helper.ts +58 -58
  15. package/src/Components/APICall/OAuth.helper.ts +294 -294
  16. package/src/Components/APICall/mimeTypeCategories.ts +46 -46
  17. package/src/Components/APICall/parseData.ts +167 -167
  18. package/src/Components/APICall/parseHeaders.ts +41 -41
  19. package/src/Components/APICall/parseProxy.ts +68 -68
  20. package/src/Components/APICall/parseUrl.ts +91 -91
  21. package/src/Components/APIEndpoint.class.ts +234 -234
  22. package/src/Components/APIOutput.class.ts +58 -58
  23. package/src/Components/AgentPlugin.class.ts +102 -102
  24. package/src/Components/Async.class.ts +155 -155
  25. package/src/Components/Await.class.ts +90 -90
  26. package/src/Components/Classifier.class.ts +158 -158
  27. package/src/Components/Component.class.ts +132 -132
  28. package/src/Components/ComponentHost.class.ts +38 -38
  29. package/src/Components/DataSourceCleaner.class.ts +92 -92
  30. package/src/Components/DataSourceIndexer.class.ts +181 -181
  31. package/src/Components/DataSourceLookup.class.ts +161 -161
  32. package/src/Components/ECMASandbox.class.ts +71 -71
  33. package/src/Components/FEncDec.class.ts +29 -29
  34. package/src/Components/FHash.class.ts +33 -33
  35. package/src/Components/FSign.class.ts +80 -80
  36. package/src/Components/FSleep.class.ts +25 -25
  37. package/src/Components/FTimestamp.class.ts +25 -25
  38. package/src/Components/FileStore.class.ts +78 -78
  39. package/src/Components/ForEach.class.ts +97 -97
  40. package/src/Components/GPTPlugin.class.ts +70 -70
  41. package/src/Components/GenAILLM.class.ts +586 -586
  42. package/src/Components/HuggingFace.class.ts +314 -314
  43. package/src/Components/Image/imageSettings.config.ts +70 -70
  44. package/src/Components/ImageGenerator.class.ts +502 -502
  45. package/src/Components/JSONFilter.class.ts +54 -54
  46. package/src/Components/LLMAssistant.class.ts +213 -213
  47. package/src/Components/LogicAND.class.ts +28 -28
  48. package/src/Components/LogicAtLeast.class.ts +85 -85
  49. package/src/Components/LogicAtMost.class.ts +86 -86
  50. package/src/Components/LogicOR.class.ts +29 -29
  51. package/src/Components/LogicXOR.class.ts +34 -34
  52. package/src/Components/MCPClient.class.ts +138 -112
  53. package/src/Components/MemoryDeleteKeyVal.class.ts +70 -70
  54. package/src/Components/MemoryReadKeyVal.class.ts +66 -66
  55. package/src/Components/MemoryWriteKeyVal.class.ts +62 -62
  56. package/src/Components/MemoryWriteObject.class.ts +97 -97
  57. package/src/Components/MultimodalLLM.class.ts +128 -128
  58. package/src/Components/OpenAPI.class.ts +72 -72
  59. package/src/Components/PromptGenerator.class.ts +122 -122
  60. package/src/Components/ScrapflyWebScrape.class.ts +159 -159
  61. package/src/Components/ServerlessCode.class.ts +123 -123
  62. package/src/Components/TavilyWebSearch.class.ts +98 -98
  63. package/src/Components/VisionLLM.class.ts +104 -104
  64. package/src/Components/ZapierAction.class.ts +127 -127
  65. package/src/Components/index.ts +97 -97
  66. package/src/Core/AgentProcess.helper.ts +240 -240
  67. package/src/Core/Connector.class.ts +123 -123
  68. package/src/Core/ConnectorsService.ts +197 -197
  69. package/src/Core/DummyConnector.ts +49 -49
  70. package/src/Core/HookService.ts +105 -105
  71. package/src/Core/SmythRuntime.class.ts +235 -235
  72. package/src/Core/SystemEvents.ts +16 -16
  73. package/src/Core/boot.ts +56 -56
  74. package/src/config.ts +15 -15
  75. package/src/constants.ts +126 -126
  76. package/src/data/hugging-face.params.json +579 -579
  77. package/src/helpers/AWSLambdaCode.helper.ts +587 -587
  78. package/src/helpers/BinaryInput.helper.ts +331 -331
  79. package/src/helpers/Conversation.helper.ts +1119 -1119
  80. package/src/helpers/ECMASandbox.helper.ts +54 -54
  81. package/src/helpers/JsonContent.helper.ts +97 -97
  82. package/src/helpers/LocalCache.helper.ts +97 -97
  83. package/src/helpers/Log.helper.ts +274 -274
  84. package/src/helpers/OpenApiParser.helper.ts +150 -150
  85. package/src/helpers/S3Cache.helper.ts +147 -147
  86. package/src/helpers/SmythURI.helper.ts +5 -5
  87. package/src/helpers/Sysconfig.helper.ts +77 -77
  88. package/src/helpers/TemplateString.helper.ts +243 -243
  89. package/src/helpers/TypeChecker.helper.ts +329 -329
  90. package/src/index.ts +3 -3
  91. package/src/index.ts.bak +3 -3
  92. package/src/subsystems/AgentManager/Agent.class.ts +1114 -1114
  93. package/src/subsystems/AgentManager/Agent.helper.ts +3 -3
  94. package/src/subsystems/AgentManager/AgentData.service/AgentDataConnector.ts +230 -230
  95. package/src/subsystems/AgentManager/AgentData.service/connectors/CLIAgentDataConnector.class.ts +66 -66
  96. package/src/subsystems/AgentManager/AgentData.service/connectors/LocalAgentDataConnector.class.ts +142 -142
  97. package/src/subsystems/AgentManager/AgentData.service/connectors/NullAgentData.class.ts +39 -39
  98. package/src/subsystems/AgentManager/AgentData.service/index.ts +18 -18
  99. package/src/subsystems/AgentManager/AgentLogger.class.ts +297 -297
  100. package/src/subsystems/AgentManager/AgentRequest.class.ts +51 -51
  101. package/src/subsystems/AgentManager/AgentRuntime.class.ts +559 -559
  102. package/src/subsystems/AgentManager/AgentSSE.class.ts +101 -101
  103. package/src/subsystems/AgentManager/AgentSettings.class.ts +52 -52
  104. package/src/subsystems/AgentManager/Component.service/ComponentConnector.ts +32 -32
  105. package/src/subsystems/AgentManager/Component.service/connectors/LocalComponentConnector.class.ts +60 -60
  106. package/src/subsystems/AgentManager/Component.service/index.ts +11 -11
  107. package/src/subsystems/AgentManager/EmbodimentSettings.class.ts +47 -47
  108. package/src/subsystems/AgentManager/ForkedAgent.class.ts +154 -154
  109. package/src/subsystems/AgentManager/OSResourceMonitor.ts +77 -77
  110. package/src/subsystems/ComputeManager/Code.service/CodeConnector.ts +98 -98
  111. package/src/subsystems/ComputeManager/Code.service/connectors/AWSLambdaCode.class.ts +172 -172
  112. package/src/subsystems/ComputeManager/Code.service/connectors/ECMASandbox.class.ts +131 -131
  113. package/src/subsystems/ComputeManager/Code.service/index.ts +13 -13
  114. package/src/subsystems/IO/CLI.service/CLIConnector.ts +47 -47
  115. package/src/subsystems/IO/CLI.service/index.ts +9 -9
  116. package/src/subsystems/IO/Log.service/LogConnector.ts +32 -32
  117. package/src/subsystems/IO/Log.service/connectors/ConsoleLog.class.ts +28 -28
  118. package/src/subsystems/IO/Log.service/index.ts +13 -13
  119. package/src/subsystems/IO/NKV.service/NKVConnector.ts +43 -43
  120. package/src/subsystems/IO/NKV.service/connectors/NKVLocalStorage.class.ts +234 -234
  121. package/src/subsystems/IO/NKV.service/connectors/NKVRAM.class.ts +204 -204
  122. package/src/subsystems/IO/NKV.service/connectors/NKVRedis.class.ts +182 -182
  123. package/src/subsystems/IO/NKV.service/index.ts +14 -14
  124. package/src/subsystems/IO/Router.service/RouterConnector.ts +21 -21
  125. package/src/subsystems/IO/Router.service/connectors/ExpressRouter.class.ts +48 -48
  126. package/src/subsystems/IO/Router.service/connectors/NullRouter.class.ts +40 -40
  127. package/src/subsystems/IO/Router.service/index.ts +11 -11
  128. package/src/subsystems/IO/Storage.service/SmythFS.class.ts +489 -489
  129. package/src/subsystems/IO/Storage.service/StorageConnector.ts +66 -66
  130. package/src/subsystems/IO/Storage.service/connectors/LocalStorage.class.ts +327 -327
  131. package/src/subsystems/IO/Storage.service/connectors/S3Storage.class.ts +482 -482
  132. package/src/subsystems/IO/Storage.service/index.ts +13 -13
  133. package/src/subsystems/IO/VectorDB.service/VectorDBConnector.ts +108 -108
  134. package/src/subsystems/IO/VectorDB.service/connectors/MilvusVectorDB.class.ts +454 -454
  135. package/src/subsystems/IO/VectorDB.service/connectors/PineconeVectorDB.class.ts +384 -384
  136. package/src/subsystems/IO/VectorDB.service/connectors/RAMVecrtorDB.class.ts +421 -421
  137. package/src/subsystems/IO/VectorDB.service/embed/BaseEmbedding.ts +107 -107
  138. package/src/subsystems/IO/VectorDB.service/embed/OpenAIEmbedding.ts +109 -109
  139. package/src/subsystems/IO/VectorDB.service/embed/index.ts +21 -21
  140. package/src/subsystems/IO/VectorDB.service/index.ts +14 -14
  141. package/src/subsystems/LLMManager/LLM.helper.ts +251 -251
  142. package/src/subsystems/LLMManager/LLM.inference.ts +339 -339
  143. package/src/subsystems/LLMManager/LLM.service/LLMConnector.ts +489 -489
  144. package/src/subsystems/LLMManager/LLM.service/LLMCredentials.helper.ts +171 -171
  145. package/src/subsystems/LLMManager/LLM.service/connectors/Anthropic.class.ts +659 -659
  146. package/src/subsystems/LLMManager/LLM.service/connectors/Bedrock.class.ts +400 -400
  147. package/src/subsystems/LLMManager/LLM.service/connectors/Echo.class.ts +77 -77
  148. package/src/subsystems/LLMManager/LLM.service/connectors/GoogleAI.class.ts +757 -757
  149. package/src/subsystems/LLMManager/LLM.service/connectors/Groq.class.ts +304 -304
  150. package/src/subsystems/LLMManager/LLM.service/connectors/Perplexity.class.ts +250 -250
  151. package/src/subsystems/LLMManager/LLM.service/connectors/VertexAI.class.ts +423 -423
  152. package/src/subsystems/LLMManager/LLM.service/connectors/openai/OpenAIConnector.class.ts +488 -488
  153. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/ChatCompletionsApiInterface.ts +524 -524
  154. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/OpenAIApiInterface.ts +100 -100
  155. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/OpenAIApiInterfaceFactory.ts +81 -81
  156. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/ResponsesApiInterface.ts +1145 -1145
  157. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/constants.ts +13 -13
  158. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/index.ts +4 -4
  159. package/src/subsystems/LLMManager/LLM.service/connectors/openai/apiInterfaces/utils.ts +11 -11
  160. package/src/subsystems/LLMManager/LLM.service/connectors/openai/types.ts +32 -32
  161. package/src/subsystems/LLMManager/LLM.service/connectors/xAI.class.ts +471 -471
  162. package/src/subsystems/LLMManager/LLM.service/index.ts +44 -44
  163. package/src/subsystems/LLMManager/ModelsProvider.service/ModelsProviderConnector.ts +300 -300
  164. package/src/subsystems/LLMManager/ModelsProvider.service/connectors/JSONModelsProvider.class.ts +252 -252
  165. package/src/subsystems/LLMManager/ModelsProvider.service/index.ts +11 -11
  166. package/src/subsystems/LLMManager/custom-models.ts +854 -854
  167. package/src/subsystems/LLMManager/models.ts +2540 -2540
  168. package/src/subsystems/LLMManager/paramMappings.ts +69 -69
  169. package/src/subsystems/MemoryManager/Cache.service/CacheConnector.ts +86 -86
  170. package/src/subsystems/MemoryManager/Cache.service/connectors/LocalStorageCache.class.ts +297 -297
  171. package/src/subsystems/MemoryManager/Cache.service/connectors/RAMCache.class.ts +201 -201
  172. package/src/subsystems/MemoryManager/Cache.service/connectors/RedisCache.class.ts +252 -252
  173. package/src/subsystems/MemoryManager/Cache.service/connectors/S3Cache.class.ts +373 -373
  174. package/src/subsystems/MemoryManager/Cache.service/index.ts +15 -15
  175. package/src/subsystems/MemoryManager/LLMCache.ts +72 -72
  176. package/src/subsystems/MemoryManager/LLMContext.ts +124 -124
  177. package/src/subsystems/MemoryManager/LLMMemory.service/LLMMemoryConnector.ts +26 -26
  178. package/src/subsystems/MemoryManager/RuntimeContext.ts +266 -266
  179. package/src/subsystems/Security/AccessControl/ACL.class.ts +208 -208
  180. package/src/subsystems/Security/AccessControl/AccessCandidate.class.ts +82 -82
  181. package/src/subsystems/Security/AccessControl/AccessRequest.class.ts +52 -52
  182. package/src/subsystems/Security/Account.service/AccountConnector.ts +44 -44
  183. package/src/subsystems/Security/Account.service/connectors/AWSAccount.class.ts +76 -76
  184. package/src/subsystems/Security/Account.service/connectors/DummyAccount.class.ts +130 -130
  185. package/src/subsystems/Security/Account.service/connectors/JSONFileAccount.class.ts +159 -159
  186. package/src/subsystems/Security/Account.service/index.ts +14 -14
  187. package/src/subsystems/Security/Credentials.helper.ts +62 -62
  188. package/src/subsystems/Security/ManagedVault.service/ManagedVaultConnector.ts +38 -38
  189. package/src/subsystems/Security/ManagedVault.service/connectors/NullManagedVault.class.ts +53 -53
  190. package/src/subsystems/Security/ManagedVault.service/connectors/SecretManagerManagedVault.ts +154 -154
  191. package/src/subsystems/Security/ManagedVault.service/index.ts +12 -12
  192. package/src/subsystems/Security/SecureConnector.class.ts +110 -110
  193. package/src/subsystems/Security/Vault.service/Vault.helper.ts +30 -30
  194. package/src/subsystems/Security/Vault.service/VaultConnector.ts +29 -29
  195. package/src/subsystems/Security/Vault.service/connectors/HashicorpVault.class.ts +46 -46
  196. package/src/subsystems/Security/Vault.service/connectors/JSONFileVault.class.ts +221 -221
  197. package/src/subsystems/Security/Vault.service/connectors/NullVault.class.ts +54 -54
  198. package/src/subsystems/Security/Vault.service/connectors/SecretsManager.class.ts +140 -140
  199. package/src/subsystems/Security/Vault.service/index.ts +12 -12
  200. package/src/types/ACL.types.ts +104 -104
  201. package/src/types/AWS.types.ts +10 -10
  202. package/src/types/Agent.types.ts +61 -61
  203. package/src/types/AgentLogger.types.ts +17 -17
  204. package/src/types/Cache.types.ts +1 -1
  205. package/src/types/Common.types.ts +2 -2
  206. package/src/types/LLM.types.ts +496 -496
  207. package/src/types/Redis.types.ts +8 -8
  208. package/src/types/SRE.types.ts +64 -64
  209. package/src/types/Security.types.ts +14 -14
  210. package/src/types/Storage.types.ts +5 -5
  211. package/src/types/VectorDB.types.ts +86 -86
  212. package/src/utils/base64.utils.ts +275 -275
  213. package/src/utils/cli.utils.ts +68 -68
  214. package/src/utils/data.utils.ts +322 -322
  215. package/src/utils/date-time.utils.ts +22 -22
  216. package/src/utils/general.utils.ts +238 -238
  217. package/src/utils/index.ts +12 -12
  218. package/src/utils/lazy-client.ts +261 -261
  219. package/src/utils/numbers.utils.ts +13 -13
  220. package/src/utils/oauth.utils.ts +35 -35
  221. package/src/utils/string.utils.ts +414 -414
  222. package/src/utils/url.utils.ts +19 -19
  223. package/src/utils/validation.utils.ts +74 -74
  224. package/dist/types/subsystems/LLMManager/ModelsProvider.service/connectors/SmythModelsProvider.class.d.ts +0 -39
@@ -1,297 +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
- }
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
+ }