@vrtmrz/livesync-commonlib 0.1.0-rc.0

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 (516) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +49 -0
  3. package/dist/API/DirectFileManipulator.d.ts +2 -0
  4. package/dist/API/DirectFileManipulator.js +4 -0
  5. package/dist/API/DirectFileManipulatorV2.d.ts +150 -0
  6. package/dist/API/DirectFileManipulatorV2.js +424 -0
  7. package/dist/API/processSetting.d.ts +41 -0
  8. package/dist/API/processSetting.js +140 -0
  9. package/dist/ContentSplitter/ContentSplitter.d.ts +28 -0
  10. package/dist/ContentSplitter/ContentSplitter.js +5 -0
  11. package/dist/ContentSplitter/ContentSplitterBase.d.ts +51 -0
  12. package/dist/ContentSplitter/ContentSplitterBase.js +83 -0
  13. package/dist/ContentSplitter/ContentSplitterRabinKarp.d.ts +9 -0
  14. package/dist/ContentSplitter/ContentSplitterRabinKarp.js +32 -0
  15. package/dist/ContentSplitter/ContentSplitterV1.d.ts +9 -0
  16. package/dist/ContentSplitter/ContentSplitterV1.js +34 -0
  17. package/dist/ContentSplitter/ContentSplitterV2.d.ts +9 -0
  18. package/dist/ContentSplitter/ContentSplitterV2.js +34 -0
  19. package/dist/ContentSplitter/ContentSplitters.d.ts +12 -0
  20. package/dist/ContentSplitter/ContentSplitters.js +29 -0
  21. package/dist/bureau/bureau.d.ts +7 -0
  22. package/dist/bureau/bureau.js +5 -0
  23. package/dist/common/ConnectionString.d.ts +30 -0
  24. package/dist/common/ConnectionString.js +179 -0
  25. package/dist/common/LSError.d.ts +48 -0
  26. package/dist/common/LSError.js +112 -0
  27. package/dist/common/configForDoc.d.ts +79 -0
  28. package/dist/common/configForDoc.js +312 -0
  29. package/dist/common/coreEnvFunctions.d.ts +21 -0
  30. package/dist/common/coreEnvFunctions.js +22 -0
  31. package/dist/common/coreEnvVars.d.ts +3 -0
  32. package/dist/common/coreEnvVars.js +6 -0
  33. package/dist/common/i18n.d.ts +18 -0
  34. package/dist/common/i18n.js +7193 -0
  35. package/dist/common/logger.d.ts +2 -0
  36. package/dist/common/logger.js +1 -0
  37. package/dist/common/messages/combinedMessages.dev.d.ts +7 -0
  38. package/dist/common/messages/combinedMessages.dev.js +44 -0
  39. package/dist/common/messages/combinedMessages.prod.d.ts +9264 -0
  40. package/dist/common/messages/combinedMessages.prod.js +9271 -0
  41. package/dist/common/messages/de.d.ts +297 -0
  42. package/dist/common/messages/de.js +7 -0
  43. package/dist/common/messages/def.d.ts +1119 -0
  44. package/dist/common/messages/def.js +7 -0
  45. package/dist/common/messages/es.d.ts +689 -0
  46. package/dist/common/messages/es.js +7 -0
  47. package/dist/common/messages/fr.d.ts +582 -0
  48. package/dist/common/messages/fr.js +7 -0
  49. package/dist/common/messages/he.d.ts +583 -0
  50. package/dist/common/messages/he.js +7 -0
  51. package/dist/common/messages/ja.d.ts +838 -0
  52. package/dist/common/messages/ja.js +7 -0
  53. package/dist/common/messages/ko.d.ts +800 -0
  54. package/dist/common/messages/ko.js +7 -0
  55. package/dist/common/messages/ru.d.ts +858 -0
  56. package/dist/common/messages/ru.js +7 -0
  57. package/dist/common/messages/zh-tw.d.ts +384 -0
  58. package/dist/common/messages/zh-tw.js +7 -0
  59. package/dist/common/messages/zh.d.ts +1093 -0
  60. package/dist/common/messages/zh.js +7 -0
  61. package/dist/common/messagesJson/de.json +295 -0
  62. package/dist/common/messagesJson/en.json +1117 -0
  63. package/dist/common/messagesJson/es.json +687 -0
  64. package/dist/common/messagesJson/fr.json +580 -0
  65. package/dist/common/messagesJson/he.json +581 -0
  66. package/dist/common/messagesJson/ja.json +836 -0
  67. package/dist/common/messagesJson/ko.json +798 -0
  68. package/dist/common/messagesJson/ru.json +856 -0
  69. package/dist/common/messagesJson/zh-tw.json +382 -0
  70. package/dist/common/messagesJson/zh.json +1091 -0
  71. package/dist/common/models/auth.type.d.ts +41 -0
  72. package/dist/common/models/auth.type.js +0 -0
  73. package/dist/common/models/db.const.d.ts +20 -0
  74. package/dist/common/models/db.const.js +28 -0
  75. package/dist/common/models/db.definition.d.ts +56 -0
  76. package/dist/common/models/db.definition.js +6 -0
  77. package/dist/common/models/db.type.d.ts +142 -0
  78. package/dist/common/models/db.type.js +0 -0
  79. package/dist/common/models/diff.definition.d.ts +16 -0
  80. package/dist/common/models/diff.definition.js +0 -0
  81. package/dist/common/models/fileaccess.const.d.ts +7 -0
  82. package/dist/common/models/fileaccess.const.js +16 -0
  83. package/dist/common/models/fileaccess.type.d.ts +72 -0
  84. package/dist/common/models/fileaccess.type.js +0 -0
  85. package/dist/common/models/redflag.const.d.ts +32 -0
  86. package/dist/common/models/redflag.const.js +27 -0
  87. package/dist/common/models/setting.const.d.ts +49 -0
  88. package/dist/common/models/setting.const.defaults.d.ts +3 -0
  89. package/dist/common/models/setting.const.defaults.js +185 -0
  90. package/dist/common/models/setting.const.js +68 -0
  91. package/dist/common/models/setting.const.preferred.d.ts +5 -0
  92. package/dist/common/models/setting.const.preferred.js +35 -0
  93. package/dist/common/models/setting.const.qr.d.ts +2 -0
  94. package/dist/common/models/setting.const.qr.js +174 -0
  95. package/dist/common/models/setting.type.d.ts +900 -0
  96. package/dist/common/models/setting.type.js +8 -0
  97. package/dist/common/models/shared.const.behabiour.d.ts +28 -0
  98. package/dist/common/models/shared.const.behabiour.js +36 -0
  99. package/dist/common/models/shared.const.d.ts +5 -0
  100. package/dist/common/models/shared.const.js +12 -0
  101. package/dist/common/models/shared.const.symbols.d.ts +9 -0
  102. package/dist/common/models/shared.const.symbols.js +20 -0
  103. package/dist/common/models/shared.definition.configNames.d.ts +36 -0
  104. package/dist/common/models/shared.definition.configNames.js +203 -0
  105. package/dist/common/models/shared.definition.d.ts +22 -0
  106. package/dist/common/models/shared.definition.js +24 -0
  107. package/dist/common/models/shared.type.util.d.ts +8 -0
  108. package/dist/common/models/shared.type.util.js +0 -0
  109. package/dist/common/models/sync.definition.d.ts +18 -0
  110. package/dist/common/models/sync.definition.js +20 -0
  111. package/dist/common/models/tweak.definition.d.ts +191 -0
  112. package/dist/common/models/tweak.definition.js +77 -0
  113. package/dist/common/rosetta.d.ts +42 -0
  114. package/dist/common/rosetta.js +57 -0
  115. package/dist/common/settingConstants.d.ts +216 -0
  116. package/dist/common/settingConstants.js +434 -0
  117. package/dist/common/typeUtils.d.ts +17 -0
  118. package/dist/common/typeUtils.js +51 -0
  119. package/dist/common/types.d.ts +107 -0
  120. package/dist/common/types.js +212 -0
  121. package/dist/common/utils.d.ts +129 -0
  122. package/dist/common/utils.doc.d.ts +11 -0
  123. package/dist/common/utils.doc.js +35 -0
  124. package/dist/common/utils.js +583 -0
  125. package/dist/common/utils.object.d.ts +2 -0
  126. package/dist/common/utils.object.js +14 -0
  127. package/dist/common/utils.patch.d.ts +8 -0
  128. package/dist/common/utils.patch.js +178 -0
  129. package/dist/common/utils.type.d.ts +1 -0
  130. package/dist/common/utils.type.js +0 -0
  131. package/dist/context.d.ts +8 -0
  132. package/dist/context.js +14 -0
  133. package/dist/databases/IndexedDBKeyValueDatabase.d.ts +26 -0
  134. package/dist/databases/IndexedDBKeyValueDatabase.js +130 -0
  135. package/dist/dataobject/StoredMap.d.ts +12 -0
  136. package/dist/dataobject/StoredMap.js +47 -0
  137. package/dist/dev/checks.d.ts +5 -0
  138. package/dist/dev/checks.js +38 -0
  139. package/dist/encryption/encryptHKDF.d.ts +3 -0
  140. package/dist/encryption/encryptHKDF.js +7 -0
  141. package/dist/encryption/stringEncryption.d.ts +27 -0
  142. package/dist/encryption/stringEncryption.js +59 -0
  143. package/dist/events/coreEvents.d.ts +54 -0
  144. package/dist/events/coreEvents.js +46 -0
  145. package/dist/hub/hub.d.ts +11 -0
  146. package/dist/hub/hub.js +7 -0
  147. package/dist/index.d.ts +1 -0
  148. package/dist/index.js +4 -0
  149. package/dist/interfaces/AsyncActivityRunner.d.ts +18 -0
  150. package/dist/interfaces/AsyncActivityRunner.js +7 -0
  151. package/dist/interfaces/Confirm.d.ts +17 -0
  152. package/dist/interfaces/Confirm.js +0 -0
  153. package/dist/interfaces/DatabaseFileAccess.d.ts +14 -0
  154. package/dist/interfaces/DatabaseFileAccess.js +0 -0
  155. package/dist/interfaces/DatabaseRebuilder.d.ts +13 -0
  156. package/dist/interfaces/DatabaseRebuilder.js +0 -0
  157. package/dist/interfaces/FileHandler.d.ts +13 -0
  158. package/dist/interfaces/FileHandler.js +0 -0
  159. package/dist/interfaces/KeyValueDatabase.d.ts +11 -0
  160. package/dist/interfaces/KeyValueDatabase.js +0 -0
  161. package/dist/interfaces/ServiceModule.d.ts +59 -0
  162. package/dist/interfaces/ServiceModule.js +19 -0
  163. package/dist/interfaces/StorageAccess.d.ts +44 -0
  164. package/dist/interfaces/StorageAccess.js +0 -0
  165. package/dist/interfaces/StorageEventManager.d.ts +16 -0
  166. package/dist/interfaces/StorageEventManager.js +5 -0
  167. package/dist/managers/ChangeManager.d.ts +61 -0
  168. package/dist/managers/ChangeManager.js +104 -0
  169. package/dist/managers/ChunkDeliveryCoordinator.d.ts +51 -0
  170. package/dist/managers/ChunkDeliveryCoordinator.js +136 -0
  171. package/dist/managers/ChunkFetcher.d.ts +44 -0
  172. package/dist/managers/ChunkFetcher.js +251 -0
  173. package/dist/managers/ChunkManager.d.ts +2 -0
  174. package/dist/managers/ChunkManager.js +4 -0
  175. package/dist/managers/ConflictManager.d.ts +37 -0
  176. package/dist/managers/ConflictManager.js +322 -0
  177. package/dist/managers/EntryManager/EntryManager.d.ts +37 -0
  178. package/dist/managers/EntryManager/EntryManager.js +73 -0
  179. package/dist/managers/EntryManager/EntryManagerImpls.d.ts +74 -0
  180. package/dist/managers/EntryManager/EntryManagerImpls.js +499 -0
  181. package/dist/managers/HashManager/HashManager.d.ts +60 -0
  182. package/dist/managers/HashManager/HashManager.js +97 -0
  183. package/dist/managers/HashManager/HashManagerCore.d.ts +114 -0
  184. package/dist/managers/HashManager/HashManagerCore.js +99 -0
  185. package/dist/managers/HashManager/PureJSHashManager.d.ts +77 -0
  186. package/dist/managers/HashManager/PureJSHashManager.js +84 -0
  187. package/dist/managers/HashManager/XXHashHashManager.d.ts +96 -0
  188. package/dist/managers/HashManager/XXHashHashManager.js +111 -0
  189. package/dist/managers/LayeredChunkManager/ArrivalWaitLayer.d.ts +30 -0
  190. package/dist/managers/LayeredChunkManager/ArrivalWaitLayer.js +115 -0
  191. package/dist/managers/LayeredChunkManager/CacheLayer.d.ts +59 -0
  192. package/dist/managers/LayeredChunkManager/CacheLayer.js +161 -0
  193. package/dist/managers/LayeredChunkManager/ChunkLayerInterfaces.d.ts +37 -0
  194. package/dist/managers/LayeredChunkManager/ChunkLayerInterfaces.js +0 -0
  195. package/dist/managers/LayeredChunkManager/DatabaseReadLayer.d.ts +14 -0
  196. package/dist/managers/LayeredChunkManager/DatabaseReadLayer.js +78 -0
  197. package/dist/managers/LayeredChunkManager/DatabaseWriteLayer.d.ts +11 -0
  198. package/dist/managers/LayeredChunkManager/DatabaseWriteLayer.js +43 -0
  199. package/dist/managers/LayeredChunkManager/HotPackLayer.d.ts +9 -0
  200. package/dist/managers/LayeredChunkManager/HotPackLayer.js +8 -0
  201. package/dist/managers/LayeredChunkManager/types.d.ts +39 -0
  202. package/dist/managers/LayeredChunkManager/types.js +0 -0
  203. package/dist/managers/LayeredChunkManager.d.ts +53 -0
  204. package/dist/managers/LayeredChunkManager.js +240 -0
  205. package/dist/managers/LiveSyncManagers.d.ts +48 -0
  206. package/dist/managers/LiveSyncManagers.js +136 -0
  207. package/dist/managers/StorageEventManager.d.ts +135 -0
  208. package/dist/managers/StorageEventManager.js +564 -0
  209. package/dist/managers/StorageProcessingManager.d.ts +14 -0
  210. package/dist/managers/StorageProcessingManager.js +48 -0
  211. package/dist/managers/adapters/IStorageEventConverterAdapter.d.ts +16 -0
  212. package/dist/managers/adapters/IStorageEventConverterAdapter.js +0 -0
  213. package/dist/managers/adapters/IStorageEventManagerAdapter.d.ts +18 -0
  214. package/dist/managers/adapters/IStorageEventManagerAdapter.js +0 -0
  215. package/dist/managers/adapters/IStorageEventPersistenceAdapter.d.ts +15 -0
  216. package/dist/managers/adapters/IStorageEventPersistenceAdapter.js +0 -0
  217. package/dist/managers/adapters/IStorageEventStatusAdapter.d.ts +13 -0
  218. package/dist/managers/adapters/IStorageEventStatusAdapter.js +0 -0
  219. package/dist/managers/adapters/IStorageEventTypeGuardAdapter.d.ts +16 -0
  220. package/dist/managers/adapters/IStorageEventTypeGuardAdapter.js +0 -0
  221. package/dist/managers/adapters/IStorageEventWatchAdapter.d.ts +21 -0
  222. package/dist/managers/adapters/IStorageEventWatchAdapter.js +0 -0
  223. package/dist/managers/adapters/index.d.ts +6 -0
  224. package/dist/managers/adapters/index.js +0 -0
  225. package/dist/mock_and_interop/stores.d.ts +21 -0
  226. package/dist/mock_and_interop/stores.js +15 -0
  227. package/dist/mock_and_interop/wrapper.d.ts +7 -0
  228. package/dist/mock_and_interop/wrapper.js +37 -0
  229. package/dist/mods.d.ts +1 -0
  230. package/dist/mods.js +18 -0
  231. package/dist/platform/browser/index.d.ts +1 -0
  232. package/dist/platform/browser/index.js +10 -0
  233. package/dist/platform/browser/storage.d.ts +35 -0
  234. package/dist/platform/browser/storage.js +139 -0
  235. package/dist/platform/node/index.d.ts +23 -0
  236. package/dist/platform/node/index.js +33 -0
  237. package/dist/platform/node/storage.d.ts +31 -0
  238. package/dist/platform/node/storage.js +104 -0
  239. package/dist/platform/storagePath.d.ts +7 -0
  240. package/dist/platform/storagePath.js +20 -0
  241. package/dist/pouchdb/LiveSyncDBFunctions.d.ts +14 -0
  242. package/dist/pouchdb/LiveSyncDBFunctions.js +129 -0
  243. package/dist/pouchdb/LiveSyncLocalDB.d.ts +196 -0
  244. package/dist/pouchdb/LiveSyncLocalDB.js +381 -0
  245. package/dist/pouchdb/PouchDBConstructor.d.ts +3 -0
  246. package/dist/pouchdb/PouchDBConstructor.js +0 -0
  247. package/dist/pouchdb/ReplicatorShim.d.ts +51 -0
  248. package/dist/pouchdb/ReplicatorShim.js +109 -0
  249. package/dist/pouchdb/StreamingFetch.d.ts +19 -0
  250. package/dist/pouchdb/StreamingFetch.js +263 -0
  251. package/dist/pouchdb/chunks.d.ts +38 -0
  252. package/dist/pouchdb/chunks.js +314 -0
  253. package/dist/pouchdb/compress.d.ts +11 -0
  254. package/dist/pouchdb/compress.js +99 -0
  255. package/dist/pouchdb/encryption.d.ts +20 -0
  256. package/dist/pouchdb/encryption.js +458 -0
  257. package/dist/pouchdb/negotiation.d.ts +9 -0
  258. package/dist/pouchdb/negotiation.js +109 -0
  259. package/dist/pouchdb/pouchdb-browser.d.ts +2 -0
  260. package/dist/pouchdb/pouchdb-browser.js +96 -0
  261. package/dist/pouchdb/pouchdb-http.d.ts +2 -0
  262. package/dist/pouchdb/pouchdb-http.js +94 -0
  263. package/dist/pouchdb/pouchdb-test.d.ts +2 -0
  264. package/dist/pouchdb/pouchdb-test.js +12 -0
  265. package/dist/pouchdb/utils_couchdb.d.ts +4 -0
  266. package/dist/pouchdb/utils_couchdb.js +38 -0
  267. package/dist/replication/LiveSyncAbstractReplicator.d.ts +69 -0
  268. package/dist/replication/LiveSyncAbstractReplicator.js +92 -0
  269. package/dist/replication/SyncParamsHandler.d.ts +35 -0
  270. package/dist/replication/SyncParamsHandler.js +118 -0
  271. package/dist/replication/couchdb/LiveSyncReplicator.d.ts +85 -0
  272. package/dist/replication/couchdb/LiveSyncReplicator.js +1132 -0
  273. package/dist/replication/httplib.d.ts +75 -0
  274. package/dist/replication/httplib.js +187 -0
  275. package/dist/replication/journal/JournalSyncCore.d.ts +70 -0
  276. package/dist/replication/journal/JournalSyncCore.js +737 -0
  277. package/dist/replication/journal/JournalSyncTypes.d.ts +9 -0
  278. package/dist/replication/journal/JournalSyncTypes.js +11 -0
  279. package/dist/replication/journal/LiveSyncJournalReplicator.d.ts +40 -0
  280. package/dist/replication/journal/LiveSyncJournalReplicator.js +294 -0
  281. package/dist/replication/journal/LiveSyncJournalReplicatorEnv.d.ts +3 -0
  282. package/dist/replication/journal/LiveSyncJournalReplicatorEnv.js +0 -0
  283. package/dist/replication/journal/objectstore/JournalStorageAdapter.d.ts +15 -0
  284. package/dist/replication/journal/objectstore/JournalStorageAdapter.js +0 -0
  285. package/dist/replication/journal/objectstore/MinioStorageAdapter.d.ts +21 -0
  286. package/dist/replication/journal/objectstore/MinioStorageAdapter.js +204 -0
  287. package/dist/replication/trystero/LiveSyncTrysteroReplicator.d.ts +90 -0
  288. package/dist/replication/trystero/LiveSyncTrysteroReplicator.js +380 -0
  289. package/dist/replication/trystero/P2PLogCollector.d.ts +8 -0
  290. package/dist/replication/trystero/P2PLogCollector.js +91 -0
  291. package/dist/replication/trystero/P2PReplicatorBase.d.ts +19 -0
  292. package/dist/replication/trystero/P2PReplicatorBase.js +0 -0
  293. package/dist/replication/trystero/P2PReplicatorCore.d.ts +12 -0
  294. package/dist/replication/trystero/P2PReplicatorCore.js +126 -0
  295. package/dist/replication/trystero/P2PReplicatorPaneCommon.d.ts +41 -0
  296. package/dist/replication/trystero/P2PReplicatorPaneCommon.js +20 -0
  297. package/dist/replication/trystero/ProxiedDB.d.ts +13 -0
  298. package/dist/replication/trystero/ProxiedDB.js +20 -0
  299. package/dist/replication/trystero/TrysteroReplicator.d.ts +152 -0
  300. package/dist/replication/trystero/TrysteroReplicator.js +683 -0
  301. package/dist/replication/trystero/TrysteroReplicatorP2PClient.d.ts +19 -0
  302. package/dist/replication/trystero/TrysteroReplicatorP2PClient.js +80 -0
  303. package/dist/replication/trystero/TrysteroReplicatorP2PConnection.d.ts +2 -0
  304. package/dist/replication/trystero/TrysteroReplicatorP2PConnection.js +4 -0
  305. package/dist/replication/trystero/TrysteroReplicatorP2PServer.d.ts +117 -0
  306. package/dist/replication/trystero/TrysteroReplicatorP2PServer.js +540 -0
  307. package/dist/replication/trystero/UseP2PReplicatorResult.d.ts +11 -0
  308. package/dist/replication/trystero/UseP2PReplicatorResult.js +0 -0
  309. package/dist/replication/trystero/addP2PEventHandlers.d.ts +35 -0
  310. package/dist/replication/trystero/addP2PEventHandlers.js +43 -0
  311. package/dist/replication/trystero/rpcCompat.d.ts +1 -0
  312. package/dist/replication/trystero/rpcCompat.js +9 -0
  313. package/dist/replication/trystero/types.d.ts +95 -0
  314. package/dist/replication/trystero/types.js +27 -0
  315. package/dist/replication/trystero/useP2PReplicatorCommands.d.ts +7 -0
  316. package/dist/replication/trystero/useP2PReplicatorCommands.js +25 -0
  317. package/dist/replication/trystero/useP2PReplicatorFeature.d.ts +17 -0
  318. package/dist/replication/trystero/useP2PReplicatorFeature.js +82 -0
  319. package/dist/rpc/RpcRoom.d.ts +24 -0
  320. package/dist/rpc/RpcRoom.js +300 -0
  321. package/dist/rpc/RpcSession.d.ts +9 -0
  322. package/dist/rpc/RpcSession.js +32 -0
  323. package/dist/rpc/chunking.d.ts +11 -0
  324. package/dist/rpc/chunking.js +58 -0
  325. package/dist/rpc/errors.d.ts +8 -0
  326. package/dist/rpc/errors.js +26 -0
  327. package/dist/rpc/index.d.ts +6 -0
  328. package/dist/rpc/index.js +12 -0
  329. package/dist/rpc/pouchdb/RpcPouchDBProxy.d.ts +75 -0
  330. package/dist/rpc/pouchdb/RpcPouchDBProxy.js +115 -0
  331. package/dist/rpc/pouchdb/RpcPouchDBServer.d.ts +16 -0
  332. package/dist/rpc/pouchdb/RpcPouchDBServer.js +55 -0
  333. package/dist/rpc/transports/DiagRTCPeerConnections.d.ts +24 -0
  334. package/dist/rpc/transports/DiagRTCPeerConnections.js +208 -0
  335. package/dist/rpc/transports/DiagRTCPeerConnections.types.d.ts +64 -0
  336. package/dist/rpc/transports/DiagRTCPeerConnections.types.js +12 -0
  337. package/dist/rpc/transports/DiagRTCPeerConnections.utils.d.ts +33 -0
  338. package/dist/rpc/transports/DiagRTCPeerConnections.utils.js +217 -0
  339. package/dist/rpc/transports/TrysteroTransport.d.ts +216 -0
  340. package/dist/rpc/transports/TrysteroTransport.js +134 -0
  341. package/dist/rpc/transports/trysteroUtils.d.ts +3 -0
  342. package/dist/rpc/transports/trysteroUtils.js +37 -0
  343. package/dist/rpc/types.d.ts +75 -0
  344. package/dist/rpc/types.js +6 -0
  345. package/dist/serviceFeatures/checkRemoteSize.d.ts +28 -0
  346. package/dist/serviceFeatures/checkRemoteSize.js +178 -0
  347. package/dist/serviceFeatures/offlineScanner.d.ts +128 -0
  348. package/dist/serviceFeatures/offlineScanner.js +553 -0
  349. package/dist/serviceFeatures/prepareDatabaseForUse.d.ts +20 -0
  350. package/dist/serviceFeatures/prepareDatabaseForUse.js +39 -0
  351. package/dist/serviceFeatures/remoteConfig.d.ts +46 -0
  352. package/dist/serviceFeatures/remoteConfig.js +247 -0
  353. package/dist/serviceFeatures/setupObsidian/qrCode.d.ts +4 -0
  354. package/dist/serviceFeatures/setupObsidian/qrCode.js +67 -0
  355. package/dist/serviceFeatures/setupObsidian/setupUri.d.ts +7 -0
  356. package/dist/serviceFeatures/setupObsidian/setupUri.js +70 -0
  357. package/dist/serviceFeatures/setupObsidian/types.d.ts +2 -0
  358. package/dist/serviceFeatures/setupObsidian/types.js +0 -0
  359. package/dist/serviceFeatures/targetFilter.d.ts +24 -0
  360. package/dist/serviceFeatures/targetFilter.js +178 -0
  361. package/dist/serviceModules/FileAccessBase.d.ts +93 -0
  362. package/dist/serviceModules/FileAccessBase.js +219 -0
  363. package/dist/serviceModules/Rebuilder.d.ts +92 -0
  364. package/dist/serviceModules/Rebuilder.js +449 -0
  365. package/dist/serviceModules/ServiceDatabaseFileAccessBase.d.ts +40 -0
  366. package/dist/serviceModules/ServiceDatabaseFileAccessBase.js +306 -0
  367. package/dist/serviceModules/ServiceFileAccessBase.d.ts +64 -0
  368. package/dist/serviceModules/ServiceFileAccessBase.js +312 -0
  369. package/dist/serviceModules/ServiceFileHandlerBase.d.ts +52 -0
  370. package/dist/serviceModules/ServiceFileHandlerBase.js +493 -0
  371. package/dist/serviceModules/ServiceModuleBase.d.ts +10 -0
  372. package/dist/serviceModules/ServiceModuleBase.js +13 -0
  373. package/dist/serviceModules/adapters/IConversionAdapter.d.ts +15 -0
  374. package/dist/serviceModules/adapters/IConversionAdapter.js +0 -0
  375. package/dist/serviceModules/adapters/IFileSystemAdapter.d.ts +47 -0
  376. package/dist/serviceModules/adapters/IFileSystemAdapter.js +0 -0
  377. package/dist/serviceModules/adapters/IPathAdapter.d.ts +15 -0
  378. package/dist/serviceModules/adapters/IPathAdapter.js +0 -0
  379. package/dist/serviceModules/adapters/IStorageAdapter.d.ts +56 -0
  380. package/dist/serviceModules/adapters/IStorageAdapter.js +0 -0
  381. package/dist/serviceModules/adapters/ITypeGuardAdapter.d.ts +14 -0
  382. package/dist/serviceModules/adapters/ITypeGuardAdapter.js +0 -0
  383. package/dist/serviceModules/adapters/IVaultAdapter.d.ts +51 -0
  384. package/dist/serviceModules/adapters/IVaultAdapter.js +0 -0
  385. package/dist/serviceModules/adapters/index.d.ts +6 -0
  386. package/dist/serviceModules/adapters/index.js +0 -0
  387. package/dist/services/BrowserServices.d.ts +36 -0
  388. package/dist/services/BrowserServices.js +123 -0
  389. package/dist/services/HeadlessServices.d.ts +14 -0
  390. package/dist/services/HeadlessServices.js +144 -0
  391. package/dist/services/InjectableServices.d.ts +1 -0
  392. package/dist/services/InjectableServices.js +4 -0
  393. package/dist/services/ServiceHub.d.ts +82 -0
  394. package/dist/services/ServiceHub.js +66 -0
  395. package/dist/services/base/APIService.d.ts +93 -0
  396. package/dist/services/base/APIService.js +44 -0
  397. package/dist/services/base/AppLifecycleService.d.ts +132 -0
  398. package/dist/services/base/AppLifecycleService.js +123 -0
  399. package/dist/services/base/ConfigService.d.ts +7 -0
  400. package/dist/services/base/ConfigService.js +6 -0
  401. package/dist/services/base/ConflictService.d.ts +54 -0
  402. package/dist/services/base/ConflictService.js +22 -0
  403. package/dist/services/base/ControlService.d.ts +54 -0
  404. package/dist/services/base/ControlService.js +103 -0
  405. package/dist/services/base/DatabaseEventService.d.ts +38 -0
  406. package/dist/services/base/DatabaseEventService.js +38 -0
  407. package/dist/services/base/DatabaseService.d.ts +40 -0
  408. package/dist/services/base/DatabaseService.js +79 -0
  409. package/dist/services/base/FileProcessingService.d.ts +25 -0
  410. package/dist/services/base/FileProcessingService.js +28 -0
  411. package/dist/services/base/IService.d.ts +284 -0
  412. package/dist/services/base/IService.js +1 -0
  413. package/dist/services/base/KeyValueDBService.d.ts +42 -0
  414. package/dist/services/base/KeyValueDBService.js +133 -0
  415. package/dist/services/base/MessageTranslator.d.ts +6 -0
  416. package/dist/services/base/MessageTranslator.js +4 -0
  417. package/dist/services/base/PathService.d.ts +38 -0
  418. package/dist/services/base/PathService.js +66 -0
  419. package/dist/services/base/RemoteService.d.ts +61 -0
  420. package/dist/services/base/RemoteService.js +212 -0
  421. package/dist/services/base/ReplicationService.d.ts +92 -0
  422. package/dist/services/base/ReplicationService.js +261 -0
  423. package/dist/services/base/ReplicatorService.d.ts +66 -0
  424. package/dist/services/base/ReplicatorService.js +164 -0
  425. package/dist/services/base/ServiceBase.d.ts +33 -0
  426. package/dist/services/base/ServiceBase.js +27 -0
  427. package/dist/services/base/SettingService.d.ts +112 -0
  428. package/dist/services/base/SettingService.js +543 -0
  429. package/dist/services/base/TestService.d.ts +28 -0
  430. package/dist/services/base/TestService.js +19 -0
  431. package/dist/services/base/TweakValueService.d.ts +40 -0
  432. package/dist/services/base/TweakValueService.js +6 -0
  433. package/dist/services/base/UnresolvedErrorManager.d.ts +15 -0
  434. package/dist/services/base/UnresolvedErrorManager.js +44 -0
  435. package/dist/services/base/VaultService.d.ts +69 -0
  436. package/dist/services/base/VaultService.js +70 -0
  437. package/dist/services/implements/base/SvelteDialog.d.ts +79 -0
  438. package/dist/services/implements/base/SvelteDialog.js +134 -0
  439. package/dist/services/implements/base/UIService.d.ts +24 -0
  440. package/dist/services/implements/base/UIService.js +37 -0
  441. package/dist/services/implements/browser/BrowserAPIService.d.ts +54 -0
  442. package/dist/services/implements/browser/BrowserAPIService.js +298 -0
  443. package/dist/services/implements/browser/BrowserDatabaseService.d.ts +7 -0
  444. package/dist/services/implements/browser/BrowserDatabaseService.js +10 -0
  445. package/dist/services/implements/browser/ConfigServiceBrowserCompat.d.ts +16 -0
  446. package/dist/services/implements/browser/ConfigServiceBrowserCompat.js +23 -0
  447. package/dist/services/implements/headless/HeadlessAPIService.d.ts +52 -0
  448. package/dist/services/implements/headless/HeadlessAPIService.js +127 -0
  449. package/dist/services/implements/headless/HeadlessDatabaseService.d.ts +7 -0
  450. package/dist/services/implements/headless/HeadlessDatabaseService.js +10 -0
  451. package/dist/services/implements/injectable/InjectableAPIService.d.ts +7 -0
  452. package/dist/services/implements/injectable/InjectableAPIService.js +18 -0
  453. package/dist/services/implements/injectable/InjectableAppLifecycleService.d.ts +11 -0
  454. package/dist/services/implements/injectable/InjectableAppLifecycleService.js +14 -0
  455. package/dist/services/implements/injectable/InjectableConflictService.d.ts +11 -0
  456. package/dist/services/implements/injectable/InjectableConflictService.js +14 -0
  457. package/dist/services/implements/injectable/InjectableDatabaseEventService.d.ts +4 -0
  458. package/dist/services/implements/injectable/InjectableDatabaseEventService.js +7 -0
  459. package/dist/services/implements/injectable/InjectableFileProcessingService.d.ts +4 -0
  460. package/dist/services/implements/injectable/InjectableFileProcessingService.js +6 -0
  461. package/dist/services/implements/injectable/InjectablePathService.d.ts +12 -0
  462. package/dist/services/implements/injectable/InjectablePathService.js +36 -0
  463. package/dist/services/implements/injectable/InjectableRemoteService.d.ts +4 -0
  464. package/dist/services/implements/injectable/InjectableRemoteService.js +7 -0
  465. package/dist/services/implements/injectable/InjectableReplicationService.d.ts +4 -0
  466. package/dist/services/implements/injectable/InjectableReplicationService.js +6 -0
  467. package/dist/services/implements/injectable/InjectableReplicatorService.d.ts +4 -0
  468. package/dist/services/implements/injectable/InjectableReplicatorService.js +7 -0
  469. package/dist/services/implements/injectable/InjectableServiceHub.d.ts +72 -0
  470. package/dist/services/implements/injectable/InjectableServiceHub.js +125 -0
  471. package/dist/services/implements/injectable/InjectableServices.d.ts +36 -0
  472. package/dist/services/implements/injectable/InjectableServices.js +1 -0
  473. package/dist/services/implements/injectable/InjectableSettingService.d.ts +11 -0
  474. package/dist/services/implements/injectable/InjectableSettingService.js +33 -0
  475. package/dist/services/implements/injectable/InjectableTestService.d.ts +5 -0
  476. package/dist/services/implements/injectable/InjectableTestService.js +8 -0
  477. package/dist/services/implements/injectable/InjectableTweakValueService.d.ts +15 -0
  478. package/dist/services/implements/injectable/InjectableTweakValueService.js +12 -0
  479. package/dist/services/implements/injectable/InjectableVaultService.d.ts +9 -0
  480. package/dist/services/implements/injectable/InjectableVaultService.js +20 -0
  481. package/dist/services/lib/HandlerUtils.d.ts +374 -0
  482. package/dist/services/lib/HandlerUtils.js +412 -0
  483. package/dist/services/lib/logUtils.d.ts +13 -0
  484. package/dist/services/lib/logUtils.js +28 -0
  485. package/dist/services/lib/remoteActivity.d.ts +13 -0
  486. package/dist/services/lib/remoteActivity.js +11 -0
  487. package/dist/string_and_binary/chunks.d.ts +10 -0
  488. package/dist/string_and_binary/chunks.js +561 -0
  489. package/dist/string_and_binary/convert.d.ts +8 -0
  490. package/dist/string_and_binary/convert.js +46 -0
  491. package/dist/string_and_binary/hash.d.ts +2 -0
  492. package/dist/string_and_binary/hash.js +1 -0
  493. package/dist/string_and_binary/path.d.ts +35 -0
  494. package/dist/string_and_binary/path.js +240 -0
  495. package/dist/worker/bg.common.d.ts +2 -0
  496. package/dist/worker/bg.common.js +6 -0
  497. package/dist/worker/bg.worker.d.ts +1 -0
  498. package/dist/worker/bg.worker.encryption.d.ts +7 -0
  499. package/dist/worker/bg.worker.encryption.js +30 -0
  500. package/dist/worker/bg.worker.js +14 -0
  501. package/dist/worker/bg.worker.splitting.d.ts +6 -0
  502. package/dist/worker/bg.worker.splitting.js +36 -0
  503. package/dist/worker/bgWorker.d.ts +25 -0
  504. package/dist/worker/bgWorker.direct.d.ts +40 -0
  505. package/dist/worker/bgWorker.direct.js +65 -0
  506. package/dist/worker/bgWorker.encryption.d.ts +22 -0
  507. package/dist/worker/bgWorker.encryption.js +40 -0
  508. package/dist/worker/bgWorker.js +348 -0
  509. package/dist/worker/bgWorker.splitting.d.ts +27 -0
  510. package/dist/worker/bgWorker.splitting.js +123 -0
  511. package/dist/worker/universalTypes.d.ts +63 -0
  512. package/dist/worker/universalTypes.js +4 -0
  513. package/docs/development.md +51 -0
  514. package/docs/platform-storage.md +60 -0
  515. package/docs/releasing.md +69 -0
  516. package/package.json +693 -0
@@ -0,0 +1,9 @@
1
+ export type CheckPointInfo = {
2
+ lastLocalSeq: number | string;
3
+ journalEpoch: string;
4
+ knownIDs: Set<string>;
5
+ sentIDs: Set<string>;
6
+ receivedFiles: Set<string>;
7
+ sentFiles: Set<string>;
8
+ };
9
+ export declare const CheckPointInfoDefault: CheckPointInfo;
@@ -0,0 +1,11 @@
1
+ const CheckPointInfoDefault = {
2
+ lastLocalSeq: 0,
3
+ journalEpoch: "",
4
+ knownIDs: /* @__PURE__ */ new Set(),
5
+ sentIDs: /* @__PURE__ */ new Set(),
6
+ receivedFiles: /* @__PURE__ */ new Set(),
7
+ sentFiles: /* @__PURE__ */ new Set()
8
+ };
9
+ export {
10
+ CheckPointInfoDefault
11
+ };
@@ -0,0 +1,40 @@
1
+ import { type RemoteDBSettings, type EntryLeaf, type ChunkVersionRange, type TweakValues, type NodeData } from "../../common/types.js";
2
+ import { JournalSyncCore } from "./JournalSyncCore.js";
3
+ import { LiveSyncAbstractReplicator, type RemoteDBStatus } from "../LiveSyncAbstractReplicator.js";
4
+ import { type ENSURE_DB_RESULT } from "../../pouchdb/LiveSyncDBFunctions.js";
5
+ import type { CheckPointInfo } from "./JournalSyncTypes.js";
6
+ import { type SimpleStore } from "../../common/utils.js";
7
+ import type { LiveSyncJournalReplicatorEnv } from "./LiveSyncJournalReplicatorEnv.js";
8
+ export declare class LiveSyncJournalReplicator extends LiveSyncAbstractReplicator {
9
+ env: LiveSyncJournalReplicatorEnv;
10
+ get isChunkSendingSupported(): boolean;
11
+ get client(): JournalSyncCore;
12
+ get simpleStore(): SimpleStore<CheckPointInfo>;
13
+ _client: JournalSyncCore;
14
+ getReplicationPBKDF2Salt(setting: RemoteDBSettings, refresh?: boolean): Promise<Uint8Array<ArrayBuffer>>;
15
+ setupJournalSyncClient(): JournalSyncCore;
16
+ ensureBucketIsCompatible(deviceNodeID: string, currentVersionRange: ChunkVersionRange): Promise<ENSURE_DB_RESULT>;
17
+ constructor(env: LiveSyncJournalReplicatorEnv);
18
+ migrate(from: number, to: number): Promise<boolean>;
19
+ terminateSync(): void;
20
+ openReplication(setting: RemoteDBSettings, _: boolean, showResult: boolean, ignoreCleanLock?: boolean): Promise<boolean>;
21
+ replicateAllToServer(setting: RemoteDBSettings, showingNotice?: boolean): Promise<boolean>;
22
+ replicateAllFromServer(setting: RemoteDBSettings, showingNotice?: boolean): Promise<boolean>;
23
+ checkReplicationConnectivity(skipCheck: boolean, ignoreCleanLock?: boolean, showMessage?: boolean): Promise<boolean>;
24
+ fetchRemoteChunks(missingChunks: string[], showResult: boolean): Promise<false | EntryLeaf[]>;
25
+ closeReplication(): void;
26
+ tryResetRemoteDatabase(setting: RemoteDBSettings): Promise<void>;
27
+ tryCreateRemoteDatabase(setting: RemoteDBSettings): Promise<void>;
28
+ markRemoteLocked(setting: RemoteDBSettings, locked: boolean, lockByClean: boolean): Promise<void>;
29
+ markRemoteResolved(setting: RemoteDBSettings): Promise<void>;
30
+ tryConnectRemote(setting: RemoteDBSettings, showResult?: boolean): Promise<boolean>;
31
+ resetRemoteTweakSettings(setting: RemoteDBSettings): Promise<void>;
32
+ setPreferredRemoteTweakSettings(setting: RemoteDBSettings): Promise<void>;
33
+ getRemotePreferredTweakValues(setting: RemoteDBSettings): Promise<false | TweakValues>;
34
+ getRemoteStatus(setting: RemoteDBSettings): Promise<false | RemoteDBStatus>;
35
+ countCompromisedChunks(): Promise<number>;
36
+ getConnectedDeviceList(setting?: RemoteDBSettings): Promise<false | {
37
+ node_info: Record<string, NodeData>;
38
+ accepted_nodes: string[];
39
+ }>;
40
+ }
@@ -0,0 +1,294 @@
1
+ import {
2
+ LOG_LEVEL_NOTICE,
3
+ LOG_LEVEL_VERBOSE,
4
+ DEVICE_ID_PREFERRED,
5
+ TweakValuesTemplate
6
+ } from "../../common/types.js";
7
+ import { Logger } from "../../common/logger.js";
8
+ import { JournalSyncCore } from "./JournalSyncCore.js";
9
+ import { MinioStorageAdapter } from "./objectstore/MinioStorageAdapter.js";
10
+ import { LiveSyncAbstractReplicator } from "../LiveSyncAbstractReplicator.js";
11
+ import { ensureRemoteIsCompatible } from "../../pouchdb/LiveSyncDBFunctions.js";
12
+ import { fireAndForget } from "../../common/utils.js";
13
+ import { extractObject } from "../../common/utils.js";
14
+ import { clearHandlers } from "../SyncParamsHandler.js";
15
+ const MILSTONE_DOCID = "_00000000-milestone.json";
16
+ const currentVersionRange = {
17
+ min: 0,
18
+ max: 2,
19
+ current: 2
20
+ };
21
+ class LiveSyncJournalReplicator extends LiveSyncAbstractReplicator {
22
+ get isChunkSendingSupported() {
23
+ return false;
24
+ }
25
+ get client() {
26
+ return this.setupJournalSyncClient();
27
+ }
28
+ get simpleStore() {
29
+ return this.env.services.keyValueDB.simpleStore;
30
+ }
31
+ _client;
32
+ async getReplicationPBKDF2Salt(setting, refresh) {
33
+ return await this.client.getReplicationPBKDF2Salt(refresh);
34
+ }
35
+ setupJournalSyncClient() {
36
+ const settings = this.currentSettings;
37
+ if (this._client) {
38
+ this._client.applyNewConfig(settings, this.simpleStore, this.env);
39
+ } else {
40
+ this._client = new JournalSyncCore(
41
+ settings,
42
+ this.simpleStore,
43
+ this.env,
44
+ new MinioStorageAdapter(settings, this.env)
45
+ );
46
+ }
47
+ return this._client;
48
+ }
49
+ async ensureBucketIsCompatible(deviceNodeID, currentVersionRange2) {
50
+ const downloadedMilestone = await this.client.downloadJson(MILSTONE_DOCID);
51
+ const cPointInfo = await this.client.getCheckpointInfo();
52
+ const progress = [...cPointInfo?.receivedFiles || []].sort().pop() || "";
53
+ return await ensureRemoteIsCompatible(
54
+ downloadedMilestone,
55
+ this.currentSettings,
56
+ deviceNodeID,
57
+ currentVersionRange2,
58
+ {
59
+ app_version: this.env.services.API.getAppVersion(),
60
+ plugin_version: this.env.services.API.getPluginVersion(),
61
+ vault_name: this.env.services.vault.vaultName(),
62
+ device_name: this.env.services.vault.getVaultName(),
63
+ progress
64
+ },
65
+ async (info) => {
66
+ await this.client.uploadJson(MILSTONE_DOCID, info);
67
+ }
68
+ );
69
+ }
70
+ constructor(env) {
71
+ super(env);
72
+ this.env = env;
73
+ fireAndForget(() => this.initializeDatabaseForReplication());
74
+ this.rawDatabase.on("close", () => {
75
+ this.closeReplication();
76
+ });
77
+ }
78
+ async migrate(from, to) {
79
+ Logger(`Database updated from ${from} to ${to}`, LOG_LEVEL_NOTICE);
80
+ return Promise.resolve(true);
81
+ }
82
+ terminateSync() {
83
+ this.client.requestStop();
84
+ }
85
+ async openReplication(setting, _, showResult, ignoreCleanLock = false) {
86
+ if (!await this.checkReplicationConnectivity(false, ignoreCleanLock, showResult)) return false;
87
+ await this.client.sync(showResult);
88
+ return true;
89
+ }
90
+ async replicateAllToServer(setting, showingNotice) {
91
+ if (!await this.checkReplicationConnectivity(false, false, !!showingNotice)) return false;
92
+ return await this.client.sendLocalJournal(showingNotice);
93
+ }
94
+ async replicateAllFromServer(setting, showingNotice) {
95
+ if (!await this.checkReplicationConnectivity(false, false, !!showingNotice)) return false;
96
+ return await this.client.receiveRemoteJournal(showingNotice);
97
+ }
98
+ async checkReplicationConnectivity(skipCheck, ignoreCleanLock = false, showMessage = false) {
99
+ if (!await this.client.isAvailable()) {
100
+ return false;
101
+ }
102
+ if (!skipCheck) {
103
+ await this.client.ensureCheckpointCachesAreFresh();
104
+ this.remoteCleaned = false;
105
+ this.remoteLocked = false;
106
+ this.remoteLockedAndDeviceNotAccepted = false;
107
+ this.tweakSettingsMismatched = false;
108
+ const ensure = await this.ensureBucketIsCompatible(this.nodeid, currentVersionRange);
109
+ if (ensure == "INCOMPATIBLE") {
110
+ Logger(
111
+ "The remote database has no compatibility with the running version. Please upgrade the plugin.",
112
+ LOG_LEVEL_NOTICE
113
+ );
114
+ return false;
115
+ } else if (ensure == "NODE_LOCKED") {
116
+ Logger(
117
+ "The remote database has been rebuilt or corrupted since we have synchronized last time. Fetch rebuilt DB, explicit unlocking or chunk clean-up is required.",
118
+ LOG_LEVEL_NOTICE
119
+ );
120
+ this.remoteLockedAndDeviceNotAccepted = true;
121
+ this.remoteLocked = true;
122
+ return false;
123
+ } else if (ensure == "LOCKED") {
124
+ this.remoteLocked = true;
125
+ } else if (ensure == "NODE_CLEANED") {
126
+ if (ignoreCleanLock) {
127
+ this.remoteLocked = true;
128
+ } else {
129
+ Logger(
130
+ "The remote database has been cleaned up. Fetch rebuilt DB, explicit unlocking or chunk clean-up is required.",
131
+ LOG_LEVEL_NOTICE
132
+ );
133
+ this.remoteLockedAndDeviceNotAccepted = true;
134
+ this.remoteLocked = true;
135
+ this.remoteCleaned = true;
136
+ return false;
137
+ }
138
+ } else if (ensure == "OK") {
139
+ } else if (ensure[0] == "MISMATCHED") {
140
+ Logger(this.translate("liveSyncReplicator.mismatchedTweakDetected"), LOG_LEVEL_NOTICE);
141
+ this.tweakSettingsMismatched = true;
142
+ this.preferredTweakValue = ensure[1];
143
+ return false;
144
+ }
145
+ }
146
+ return true;
147
+ }
148
+ async fetchRemoteChunks(missingChunks, showResult) {
149
+ return Promise.resolve([]);
150
+ }
151
+ closeReplication() {
152
+ this.client.requestStop();
153
+ this.syncStatus = "CLOSED";
154
+ Logger("Replication closed");
155
+ this.updateInfo();
156
+ }
157
+ async tryResetRemoteDatabase(setting) {
158
+ this.closeReplication();
159
+ try {
160
+ await this.client.resetBucket();
161
+ clearHandlers();
162
+ Logger("Remote Bucket Cleared", LOG_LEVEL_NOTICE);
163
+ await this.tryCreateRemoteDatabase(setting);
164
+ } catch (ex) {
165
+ Logger("Something happened on Remote Bucket Clear", LOG_LEVEL_NOTICE);
166
+ Logger(ex, LOG_LEVEL_NOTICE);
167
+ }
168
+ }
169
+ async tryCreateRemoteDatabase(setting) {
170
+ this.closeReplication();
171
+ Logger("Remote Database Created or Connected", LOG_LEVEL_NOTICE);
172
+ clearHandlers();
173
+ await this.ensurePBKDF2Salt(setting, true, false);
174
+ return await Promise.resolve();
175
+ }
176
+ async markRemoteLocked(setting, locked, lockByClean) {
177
+ const defInitPoint = {
178
+ _id: MILSTONE_DOCID,
179
+ type: "milestoneinfo",
180
+ created: Date.now(),
181
+ locked,
182
+ cleaned: lockByClean,
183
+ accepted_nodes: [this.nodeid],
184
+ node_chunk_info: { [this.nodeid]: currentVersionRange },
185
+ node_info: {},
186
+ tweak_values: {}
187
+ };
188
+ const remoteMilestone = {
189
+ ...defInitPoint,
190
+ ...await this.client.downloadJson(MILSTONE_DOCID) || {}
191
+ };
192
+ remoteMilestone.node_chunk_info = { ...defInitPoint.node_chunk_info, ...remoteMilestone.node_chunk_info };
193
+ remoteMilestone.accepted_nodes = [this.nodeid];
194
+ remoteMilestone.locked = locked;
195
+ remoteMilestone.cleaned = remoteMilestone.cleaned || lockByClean;
196
+ if (locked) {
197
+ Logger("Lock remote bucket to prevent data corruption", LOG_LEVEL_NOTICE);
198
+ } else {
199
+ Logger("Unlock remote bucket to prevent data corruption", LOG_LEVEL_NOTICE);
200
+ }
201
+ await this.client.uploadJson(MILSTONE_DOCID, remoteMilestone);
202
+ }
203
+ async markRemoteResolved(setting) {
204
+ const defInitPoint = {
205
+ _id: MILSTONE_DOCID,
206
+ type: "milestoneinfo",
207
+ created: Date.now(),
208
+ locked: false,
209
+ accepted_nodes: [this.nodeid],
210
+ node_chunk_info: { [this.nodeid]: currentVersionRange },
211
+ node_info: {},
212
+ tweak_values: {}
213
+ };
214
+ const remoteMilestone = {
215
+ ...defInitPoint,
216
+ ...await this.client.downloadJson(MILSTONE_DOCID) || {}
217
+ };
218
+ remoteMilestone.node_chunk_info = { ...defInitPoint.node_chunk_info, ...remoteMilestone.node_chunk_info };
219
+ remoteMilestone.accepted_nodes = Array.from(/* @__PURE__ */ new Set([...remoteMilestone.accepted_nodes, this.nodeid]));
220
+ Logger("Mark this device as 'resolved'.", LOG_LEVEL_NOTICE);
221
+ await this.client.uploadJson(MILSTONE_DOCID, remoteMilestone);
222
+ }
223
+ async tryConnectRemote(setting, showResult = true) {
224
+ const endpoint = setting.endpoint;
225
+ const testClient = new MinioStorageAdapter(setting, this.env);
226
+ try {
227
+ await testClient.listFiles("", 1);
228
+ Logger(`Connected to ${endpoint} successfully!`, LOG_LEVEL_NOTICE);
229
+ return true;
230
+ } catch (ex) {
231
+ Logger(`Error! Could not connected to ${endpoint}
232
+ ${ex.message}`, LOG_LEVEL_NOTICE);
233
+ Logger(ex, LOG_LEVEL_NOTICE);
234
+ return false;
235
+ }
236
+ }
237
+ async resetRemoteTweakSettings(setting) {
238
+ try {
239
+ const remoteMilestone = await this.client.downloadJson(MILSTONE_DOCID);
240
+ if (!remoteMilestone) {
241
+ throw new Error("Missing remote milestone");
242
+ }
243
+ remoteMilestone.tweak_values = {};
244
+ Logger(`tweak values on the remote database have been cleared`, LOG_LEVEL_VERBOSE);
245
+ await this.client.uploadJson(MILSTONE_DOCID, remoteMilestone);
246
+ } catch (ex) {
247
+ Logger(`Could not retrieve remote milestone`, LOG_LEVEL_NOTICE);
248
+ throw ex;
249
+ }
250
+ }
251
+ async setPreferredRemoteTweakSettings(setting) {
252
+ try {
253
+ const remoteMilestone = await this.client.downloadJson(MILSTONE_DOCID);
254
+ if (!remoteMilestone) {
255
+ throw new Error("Missing remote milestone");
256
+ }
257
+ remoteMilestone.tweak_values[DEVICE_ID_PREFERRED] = extractObject(TweakValuesTemplate, {
258
+ ...setting
259
+ });
260
+ Logger(`tweak values on the remote database have been cleared`, LOG_LEVEL_VERBOSE);
261
+ await this.client.uploadJson(MILSTONE_DOCID, remoteMilestone);
262
+ } catch (ex) {
263
+ Logger(`Could not retrieve remote milestone`, LOG_LEVEL_NOTICE);
264
+ throw ex;
265
+ }
266
+ }
267
+ async getRemotePreferredTweakValues(setting) {
268
+ try {
269
+ const remoteMilestone = await this.client.downloadJson(MILSTONE_DOCID);
270
+ if (!remoteMilestone) {
271
+ throw new Error("Missing remote milestone");
272
+ }
273
+ return remoteMilestone?.tweak_values?.[DEVICE_ID_PREFERRED] || false;
274
+ } catch (ex) {
275
+ Logger(`Could not retrieve remote milestone`, LOG_LEVEL_NOTICE);
276
+ Logger(ex, LOG_LEVEL_VERBOSE);
277
+ return false;
278
+ }
279
+ }
280
+ async getRemoteStatus(setting) {
281
+ const testClient = new MinioStorageAdapter(setting, this.env);
282
+ return await testClient.getUsage();
283
+ }
284
+ countCompromisedChunks() {
285
+ Logger(`Bucket Sync Replicator cannot count compromised chunks`, LOG_LEVEL_VERBOSE);
286
+ return Promise.resolve(0);
287
+ }
288
+ getConnectedDeviceList(setting) {
289
+ return Promise.resolve(false);
290
+ }
291
+ }
292
+ export {
293
+ LiveSyncJournalReplicator
294
+ };
@@ -0,0 +1,3 @@
1
+ import type { LiveSyncReplicatorEnv } from "../LiveSyncAbstractReplicator.js";
2
+ export interface LiveSyncJournalReplicatorEnv extends LiveSyncReplicatorEnv {
3
+ }
@@ -0,0 +1,15 @@
1
+ import type { RemoteDBStatus } from "../../LiveSyncAbstractReplicator.js";
2
+ import type { BucketSyncSetting } from "../../../common/types.js";
3
+ export interface IJournalStorage {
4
+ upload(key: string, data: Uint8Array, mime: string): Promise<boolean>;
5
+ download(key: string, ignoreCache?: boolean): Promise<Uint8Array | false>;
6
+ listFiles(from: string, limit?: number): Promise<string[]>;
7
+ deleteFiles(keys: string[]): Promise<boolean>;
8
+ isAvailable(): Promise<boolean>;
9
+ getUsage(): Promise<false | RemoteDBStatus>;
10
+ applyNewConfig(settings: BucketSyncSetting): void;
11
+ }
12
+ import type { LiveSyncJournalReplicatorEnv } from "../LiveSyncJournalReplicatorEnv.js";
13
+ export interface IJournalStorageAdapterClass {
14
+ new (settings: BucketSyncSetting, env: LiveSyncJournalReplicatorEnv): IJournalStorage;
15
+ }
@@ -0,0 +1,21 @@
1
+ import { S3 } from "@aws-sdk/client-s3";
2
+ import { type BucketSyncSetting } from "../../../common/types.js";
3
+ import type { RemoteDBStatus } from "../../LiveSyncAbstractReplicator.js";
4
+ import type { IJournalStorage } from "./JournalStorageAdapter.js";
5
+ import type { LiveSyncJournalReplicatorEnv } from "../LiveSyncJournalReplicatorEnv.js";
6
+ export declare class MinioStorageAdapter implements IJournalStorage {
7
+ _instance?: S3;
8
+ _settings: BucketSyncSetting;
9
+ _env: LiveSyncJournalReplicatorEnv;
10
+ constructor(settings: BucketSyncSetting, env: LiveSyncJournalReplicatorEnv);
11
+ private runTrackedRequest;
12
+ applyNewConfig(settings: BucketSyncSetting): void;
13
+ get customHeaders(): [string, string][];
14
+ _getClient(): S3;
15
+ upload(key: string, data: Uint8Array, mime: string): Promise<boolean>;
16
+ download(key: string, ignoreCache?: boolean): Promise<Uint8Array | false>;
17
+ listFiles(from: string, limit?: number): Promise<string[]>;
18
+ deleteFiles(keys: string[]): Promise<boolean>;
19
+ isAvailable(): Promise<boolean>;
20
+ getUsage(): Promise<false | RemoteDBStatus>;
21
+ }
@@ -0,0 +1,204 @@
1
+ import {
2
+ DeleteObjectsCommand,
3
+ GetObjectCommand,
4
+ HeadBucketCommand,
5
+ PutObjectCommand,
6
+ S3
7
+ } from "@aws-sdk/client-s3";
8
+ import { applyMd5BodyChecksumMiddleware } from "@smithy/middleware-apply-body-checksum";
9
+ import { Md5 } from "@smithy/md5-js";
10
+ import { ConfiguredRetryStrategy } from "@smithy/util-retry";
11
+ import { promiseWithResolvers } from "octagonal-wheels/promises";
12
+ import { LOG_LEVEL_NOTICE, LOG_LEVEL_VERBOSE } from "../../../common/types.js";
13
+ import { Logger } from "../../../common/logger.js";
14
+ import { parseHeaderValues } from "../../../common/utils.js";
15
+ import { runWithTrackedPhysicalRequest } from "../../../services/lib/remoteActivity.js";
16
+ class MinioStorageAdapter {
17
+ _instance;
18
+ _settings;
19
+ _env;
20
+ constructor(settings, env) {
21
+ this._settings = settings;
22
+ this._env = env;
23
+ }
24
+ async runTrackedRequest(task) {
25
+ return await runWithTrackedPhysicalRequest(this._env.services.API, task);
26
+ }
27
+ applyNewConfig(settings) {
28
+ this._settings = settings;
29
+ this._instance = void 0;
30
+ }
31
+ get customHeaders() {
32
+ return this._settings.bucketCustomHeaders.length == 0 ? [] : Object.entries(parseHeaderValues(this._settings.bucketCustomHeaders));
33
+ }
34
+ _getClient() {
35
+ if (this._instance) return this._instance;
36
+ const ep = this._settings.endpoint ? {
37
+ endpoint: this._settings.endpoint,
38
+ forcePathStyle: this._settings.forcePathStyle
39
+ } : {};
40
+ this._instance = new S3({
41
+ region: this._settings.region,
42
+ ...ep,
43
+ credentials: {
44
+ accessKeyId: this._settings.accessKey,
45
+ secretAccessKey: this._settings.secretKey
46
+ },
47
+ maxAttempts: 4,
48
+ retryStrategy: new ConfiguredRetryStrategy(4, (attempt) => 100 + attempt * 1e3),
49
+ requestHandler: this._settings.useCustomRequestHandler ? this._env.services.API.getCustomFetchHandler() : void 0,
50
+ requestChecksumCalculation: "WHEN_REQUIRED",
51
+ responseChecksumValidation: "WHEN_REQUIRED"
52
+ });
53
+ const bucketCustomHeaders = this.customHeaders;
54
+ this._instance.middlewareStack.add(
55
+ (next, context) => (args) => {
56
+ bucketCustomHeaders.forEach(([key, value]) => {
57
+ if (key && value) {
58
+ args.request.headers[key] = value;
59
+ }
60
+ });
61
+ return next(args);
62
+ },
63
+ {
64
+ name: "addBucketCustomHeadersMiddleware",
65
+ step: "finalizeRequest",
66
+ priority: "low"
67
+ }
68
+ );
69
+ const arrayBufferToBase64Sync = (buffer) => {
70
+ return btoa(String.fromCharCode(...new Uint8Array(buffer)));
71
+ };
72
+ this._instance.middlewareStack.add(
73
+ applyMd5BodyChecksumMiddleware({
74
+ md5: Md5,
75
+ base64Encoder: (data) => arrayBufferToBase64Sync(data.buffer),
76
+ streamHasher: (hashConstructor, stream) => {
77
+ const result = promiseWithResolvers();
78
+ const hash = new hashConstructor();
79
+ stream.on("data", (chunk) => {
80
+ hash.update(chunk);
81
+ });
82
+ stream.on("end", () => {
83
+ result.resolve(hash.digest());
84
+ });
85
+ return result.promise;
86
+ }
87
+ }),
88
+ {
89
+ step: "build",
90
+ name: "applyMd5BodyChecksumMiddlewareForDeleteObjects"
91
+ }
92
+ );
93
+ return this._instance;
94
+ }
95
+ async upload(key, data, mime) {
96
+ try {
97
+ const client = this._getClient();
98
+ const cmd = new PutObjectCommand({
99
+ Bucket: this._settings.bucket,
100
+ Key: `${this._settings.bucketPrefix}${key}`,
101
+ Body: data,
102
+ ContentType: mime
103
+ });
104
+ if (await this.runTrackedRequest(() => client.send(cmd))) {
105
+ return true;
106
+ }
107
+ } catch (ex) {
108
+ Logger(`Could not upload ${key}`);
109
+ Logger(ex, LOG_LEVEL_VERBOSE);
110
+ }
111
+ return false;
112
+ }
113
+ async download(key, ignoreCache = false) {
114
+ const client = this._getClient();
115
+ const cmd = new GetObjectCommand({
116
+ Bucket: this._settings.bucket,
117
+ Key: `${this._settings.bucketPrefix}${key}`,
118
+ ...ignoreCache ? { ResponseCacheControl: "no-cache" } : {}
119
+ });
120
+ try {
121
+ return await this.runTrackedRequest(async () => {
122
+ const r = await client.send(cmd);
123
+ if (r.Body) {
124
+ return new Uint8Array(await r.Body.transformToByteArray());
125
+ }
126
+ return false;
127
+ });
128
+ } catch (ex) {
129
+ Logger(`Could not download ${key}`);
130
+ Logger(ex, LOG_LEVEL_VERBOSE);
131
+ }
132
+ return false;
133
+ }
134
+ async listFiles(from, limit) {
135
+ const client = this._getClient();
136
+ const objects = await this.runTrackedRequest(
137
+ () => client.listObjectsV2({
138
+ Bucket: this._settings.bucket,
139
+ Prefix: this._settings.bucketPrefix,
140
+ StartAfter: `${this._settings.bucketPrefix || ""}${from || ""}`,
141
+ ...limit ? { MaxKeys: limit } : {}
142
+ })
143
+ );
144
+ if (!objects.Contents) return [];
145
+ return objects.Contents.filter((e) => e.Key?.startsWith(this._settings.bucketPrefix)).map(
146
+ (e) => e.Key?.substring(this._settings.bucketPrefix.length)
147
+ );
148
+ }
149
+ async deleteFiles(keys) {
150
+ if (keys.length === 0) return true;
151
+ const client = this._getClient();
152
+ try {
153
+ const cmd = new DeleteObjectsCommand({
154
+ Bucket: this._settings.bucket,
155
+ Delete: {
156
+ Objects: keys.map((e) => ({ Key: `${this._settings.bucketPrefix}${e}` }))
157
+ }
158
+ });
159
+ const r = await this.runTrackedRequest(() => client.send(cmd));
160
+ const { Deleted, Errors } = r;
161
+ const deleteCount = Deleted?.length || 0;
162
+ const errorCount = Errors?.length || 0;
163
+ Logger(
164
+ `${deleteCount} items deleted.${errorCount !== 0 ? ` (${errorCount} items failed to delete)` : ""}`,
165
+ LOG_LEVEL_VERBOSE,
166
+ "reset-bucket"
167
+ );
168
+ return errorCount === 0;
169
+ } catch (ex) {
170
+ Logger(`WARNING! Could not delete files.`, LOG_LEVEL_NOTICE, "reset-bucket");
171
+ Logger(ex, LOG_LEVEL_VERBOSE);
172
+ return false;
173
+ }
174
+ }
175
+ async isAvailable() {
176
+ const client = this._getClient();
177
+ const cmd = new HeadBucketCommand({ Bucket: this._settings.bucket });
178
+ try {
179
+ await this.runTrackedRequest(() => client.send(cmd));
180
+ return true;
181
+ } catch (ex) {
182
+ Logger(`Could not connect to the remote bucket`, LOG_LEVEL_NOTICE);
183
+ Logger(ex, LOG_LEVEL_VERBOSE);
184
+ return false;
185
+ }
186
+ }
187
+ async getUsage() {
188
+ const client = this._getClient();
189
+ try {
190
+ const objects = await this.runTrackedRequest(() => client.listObjectsV2({ Bucket: this._settings.bucket }));
191
+ if (!objects.Contents) return {};
192
+ return {
193
+ estimatedSize: objects.Contents.reduce((acc, e) => acc + (e.Size || 0), 0)
194
+ };
195
+ } catch (ex) {
196
+ Logger(`Could not get status of the remote bucket`, LOG_LEVEL_NOTICE);
197
+ Logger(ex, LOG_LEVEL_VERBOSE);
198
+ return false;
199
+ }
200
+ }
201
+ }
202
+ export {
203
+ MinioStorageAdapter
204
+ };