@open-e2ee/signal-protocol-sdk 11.0.0 → 12.0.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 (583) hide show
  1. package/ADAPTERS.md +4 -4
  2. package/ARCHITECTURE.md +6 -8
  3. package/CHANGELOG.md +1315 -0
  4. package/README.md +1 -1
  5. package/SECURITY.md +2 -2
  6. package/TROUBLESHOOTING.md +1 -1
  7. package/client/README.md +70 -37
  8. package/device/README.md +39 -85
  9. package/dist/client/client.d.ts +334 -63
  10. package/dist/client/client.d.ts.map +1 -1
  11. package/dist/client/client.js +1168 -184
  12. package/dist/client/client.js.map +1 -1
  13. package/dist/client/config.d.ts +40 -32
  14. package/dist/client/config.d.ts.map +1 -1
  15. package/dist/client/config.js +1 -1
  16. package/dist/client/config.js.map +1 -1
  17. package/dist/client/constants.d.ts +42 -8
  18. package/dist/client/constants.d.ts.map +1 -1
  19. package/dist/client/constants.js +48 -3
  20. package/dist/client/constants.js.map +1 -1
  21. package/dist/client/content-adapter.d.ts +80 -0
  22. package/dist/client/content-adapter.d.ts.map +1 -1
  23. package/dist/client/content-adapter.js +225 -12
  24. package/dist/client/content-adapter.js.map +1 -1
  25. package/dist/client/delivery-error.d.ts +150 -0
  26. package/dist/client/delivery-error.d.ts.map +1 -0
  27. package/dist/client/delivery-error.js +226 -0
  28. package/dist/client/delivery-error.js.map +1 -0
  29. package/dist/client/delivery-status.d.ts +32 -6
  30. package/dist/client/delivery-status.d.ts.map +1 -1
  31. package/dist/client/delivery-status.js +61 -13
  32. package/dist/client/delivery-status.js.map +1 -1
  33. package/dist/client/device-set-reconciliation.d.ts +196 -0
  34. package/dist/client/device-set-reconciliation.d.ts.map +1 -0
  35. package/dist/client/device-set-reconciliation.js +282 -0
  36. package/dist/client/device-set-reconciliation.js.map +1 -0
  37. package/dist/client/distribution-records.d.ts +29 -0
  38. package/dist/client/distribution-records.d.ts.map +1 -0
  39. package/dist/client/distribution-records.js +33 -0
  40. package/dist/client/distribution-records.js.map +1 -0
  41. package/dist/client/event-hooks.d.ts +280 -14
  42. package/dist/client/event-hooks.d.ts.map +1 -1
  43. package/dist/client/event-hooks.js +8 -0
  44. package/dist/client/event-hooks.js.map +1 -1
  45. package/dist/client/group-device-set.d.ts +47 -0
  46. package/dist/client/group-device-set.d.ts.map +1 -0
  47. package/dist/client/group-device-set.js +65 -0
  48. package/dist/client/group-device-set.js.map +1 -0
  49. package/dist/client/group-fetcher.d.ts +116 -0
  50. package/dist/client/group-fetcher.d.ts.map +1 -0
  51. package/dist/client/group-fetcher.js +598 -0
  52. package/dist/client/group-fetcher.js.map +1 -0
  53. package/dist/client/group-outbox.d.ts +172 -10
  54. package/dist/client/group-outbox.d.ts.map +1 -1
  55. package/dist/client/group-outbox.js +915 -74
  56. package/dist/client/group-outbox.js.map +1 -1
  57. package/dist/client/group-receive-authorization.d.ts +127 -4
  58. package/dist/client/group-receive-authorization.d.ts.map +1 -1
  59. package/dist/client/group-receive-authorization.js +270 -20
  60. package/dist/client/group-receive-authorization.js.map +1 -1
  61. package/dist/client/group-sealed-sender.d.ts +3 -0
  62. package/dist/client/group-sealed-sender.d.ts.map +1 -1
  63. package/dist/client/group-sealed-sender.js +1 -0
  64. package/dist/client/group-sealed-sender.js.map +1 -1
  65. package/dist/client/group-sender-key-operations.d.ts +14 -3
  66. package/dist/client/group-sender-key-operations.d.ts.map +1 -1
  67. package/dist/client/group-sender-key-operations.js +26 -5
  68. package/dist/client/group-sender-key-operations.js.map +1 -1
  69. package/dist/client/groups.d.ts +5 -5
  70. package/dist/client/groups.d.ts.map +1 -1
  71. package/dist/client/groups.js +5 -4
  72. package/dist/client/groups.js.map +1 -1
  73. package/dist/client/hosted-anonymous-delivery.d.ts +61 -9
  74. package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -1
  75. package/dist/client/hosted-anonymous-delivery.js +242 -48
  76. package/dist/client/hosted-anonymous-delivery.js.map +1 -1
  77. package/dist/client/hosted-assertion-id.d.ts +7 -0
  78. package/dist/client/hosted-assertion-id.d.ts.map +1 -0
  79. package/dist/client/hosted-assertion-id.js +51 -0
  80. package/dist/client/hosted-assertion-id.js.map +1 -0
  81. package/dist/client/hosted-mailbox-subscription.d.ts +34 -2
  82. package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -1
  83. package/dist/client/hosted-mailbox-subscription.js +87 -17
  84. package/dist/client/hosted-mailbox-subscription.js.map +1 -1
  85. package/dist/client/hosted-push.d.ts +22 -4
  86. package/dist/client/hosted-push.d.ts.map +1 -1
  87. package/dist/client/hosted-push.js +75 -22
  88. package/dist/client/hosted-push.js.map +1 -1
  89. package/dist/client/hosted-transport.d.ts +22 -28
  90. package/dist/client/hosted-transport.d.ts.map +1 -1
  91. package/dist/client/hosted-transport.js +115 -55
  92. package/dist/client/hosted-transport.js.map +1 -1
  93. package/dist/client/hosted.d.ts +10 -4
  94. package/dist/client/hosted.d.ts.map +1 -1
  95. package/dist/client/hosted.js +10 -4
  96. package/dist/client/hosted.js.map +1 -1
  97. package/dist/client/index.d.ts +5 -3
  98. package/dist/client/index.d.ts.map +1 -1
  99. package/dist/client/index.js +2 -0
  100. package/dist/client/index.js.map +1 -1
  101. package/dist/client/messages.d.ts +25 -3
  102. package/dist/client/messages.d.ts.map +1 -1
  103. package/dist/client/messages.js +111 -20
  104. package/dist/client/messages.js.map +1 -1
  105. package/dist/client/receive-admission.d.ts +58 -0
  106. package/dist/client/receive-admission.d.ts.map +1 -0
  107. package/dist/client/receive-admission.js +78 -0
  108. package/dist/client/receive-admission.js.map +1 -0
  109. package/dist/client/receive-expiry.d.ts +31 -0
  110. package/dist/client/receive-expiry.d.ts.map +1 -0
  111. package/dist/client/receive-expiry.js +35 -0
  112. package/dist/client/receive-expiry.js.map +1 -0
  113. package/dist/client/receive-hook-bound.d.ts +50 -0
  114. package/dist/client/receive-hook-bound.d.ts.map +1 -0
  115. package/dist/client/receive-hook-bound.js +115 -0
  116. package/dist/client/receive-hook-bound.js.map +1 -0
  117. package/dist/client/receive-queue.d.ts +299 -0
  118. package/dist/client/receive-queue.d.ts.map +1 -0
  119. package/dist/client/receive-queue.js +1420 -0
  120. package/dist/client/receive-queue.js.map +1 -0
  121. package/dist/client/receive-work-seed.d.ts +54 -0
  122. package/dist/client/receive-work-seed.d.ts.map +1 -0
  123. package/dist/client/receive-work-seed.js +116 -0
  124. package/dist/client/receive-work-seed.js.map +1 -0
  125. package/dist/client/recovery-driver.d.ts +25 -0
  126. package/dist/client/recovery-driver.d.ts.map +1 -0
  127. package/dist/client/recovery-driver.js +121 -0
  128. package/dist/client/recovery-driver.js.map +1 -0
  129. package/dist/client/relay-acceptance.d.ts +20 -7
  130. package/dist/client/relay-acceptance.d.ts.map +1 -1
  131. package/dist/client/relay-acceptance.js +30 -12
  132. package/dist/client/relay-acceptance.js.map +1 -1
  133. package/dist/client/relay-device-refusal.d.ts +18 -0
  134. package/dist/client/relay-device-refusal.d.ts.map +1 -1
  135. package/dist/client/relay-device-refusal.js +31 -0
  136. package/dist/client/relay-device-refusal.js.map +1 -1
  137. package/dist/client/relay-sealed-route.d.ts +36 -0
  138. package/dist/client/relay-sealed-route.d.ts.map +1 -0
  139. package/dist/client/relay-sealed-route.js +45 -0
  140. package/dist/client/relay-sealed-route.js.map +1 -0
  141. package/dist/client/relay-subscription.d.ts +56 -13
  142. package/dist/client/relay-subscription.d.ts.map +1 -1
  143. package/dist/client/relay-subscription.js +193 -123
  144. package/dist/client/relay-subscription.js.map +1 -1
  145. package/dist/client/resendable-content.d.ts +98 -0
  146. package/dist/client/resendable-content.d.ts.map +1 -0
  147. package/dist/client/resendable-content.js +136 -0
  148. package/dist/client/resendable-content.js.map +1 -0
  149. package/dist/client/retry-family.d.ts +57 -10
  150. package/dist/client/retry-family.d.ts.map +1 -1
  151. package/dist/client/retry-family.js +54 -12
  152. package/dist/client/retry-family.js.map +1 -1
  153. package/dist/client/retry-request-envelope.d.ts +107 -8
  154. package/dist/client/retry-request-envelope.d.ts.map +1 -1
  155. package/dist/client/retry-request-envelope.js +172 -23
  156. package/dist/client/retry-request-envelope.js.map +1 -1
  157. package/dist/client/retry-request-lifecycle.d.ts +70 -14
  158. package/dist/client/retry-request-lifecycle.d.ts.map +1 -1
  159. package/dist/client/retry-request-lifecycle.js +162 -32
  160. package/dist/client/retry-request-lifecycle.js.map +1 -1
  161. package/dist/client/retry-terminal-recovery.d.ts +100 -0
  162. package/dist/client/retry-terminal-recovery.d.ts.map +1 -0
  163. package/dist/client/retry-terminal-recovery.js +164 -0
  164. package/dist/client/retry-terminal-recovery.js.map +1 -0
  165. package/dist/client/retry-utils.d.ts +27 -0
  166. package/dist/client/retry-utils.d.ts.map +1 -1
  167. package/dist/client/retry-utils.js +46 -0
  168. package/dist/client/retry-utils.js.map +1 -1
  169. package/dist/client/retry.d.ts +100 -12
  170. package/dist/client/retry.d.ts.map +1 -1
  171. package/dist/client/retry.js +619 -116
  172. package/dist/client/retry.js.map +1 -1
  173. package/dist/client/sealed-sender.d.ts +23 -6
  174. package/dist/client/sealed-sender.d.ts.map +1 -1
  175. package/dist/client/sealed-sender.js +30 -6
  176. package/dist/client/sealed-sender.js.map +1 -1
  177. package/dist/client/sessions.d.ts +2 -2
  178. package/dist/client/sessions.js +2 -2
  179. package/dist/client/signal-service-cipher.d.ts +726 -19
  180. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  181. package/dist/client/signal-service-cipher.js +2260 -342
  182. package/dist/client/signal-service-cipher.js.map +1 -1
  183. package/dist/client/state.d.ts +5 -0
  184. package/dist/client/state.d.ts.map +1 -1
  185. package/dist/client/state.js +11 -1
  186. package/dist/client/state.js.map +1 -1
  187. package/dist/client/storage-protection.d.ts +64 -0
  188. package/dist/client/storage-protection.d.ts.map +1 -0
  189. package/dist/client/storage-protection.js +150 -0
  190. package/dist/client/storage-protection.js.map +1 -0
  191. package/dist/client/types.d.ts +149 -15
  192. package/dist/client/types.d.ts.map +1 -1
  193. package/dist/client/types.js +1 -1
  194. package/dist/client/types.js.map +1 -1
  195. package/dist/device/constants.d.ts +0 -5
  196. package/dist/device/constants.d.ts.map +1 -1
  197. package/dist/device/constants.js +0 -5
  198. package/dist/device/constants.js.map +1 -1
  199. package/dist/device/expo/index.d.ts +4 -17
  200. package/dist/device/expo/index.d.ts.map +1 -1
  201. package/dist/device/expo/index.js +4 -23
  202. package/dist/device/expo/index.js.map +1 -1
  203. package/dist/device/index.d.ts +0 -2
  204. package/dist/device/index.d.ts.map +1 -1
  205. package/dist/device/index.js +0 -7
  206. package/dist/device/index.js.map +1 -1
  207. package/dist/device/lifecycle/manager.d.ts +5 -4
  208. package/dist/device/lifecycle/manager.d.ts.map +1 -1
  209. package/dist/device/lifecycle/manager.js +16 -16
  210. package/dist/device/lifecycle/manager.js.map +1 -1
  211. package/dist/device/lifecycle/types.d.ts +2 -2
  212. package/dist/device/lifecycle/types.d.ts.map +1 -1
  213. package/dist/device/react-native/index.d.ts +4 -15
  214. package/dist/device/react-native/index.d.ts.map +1 -1
  215. package/dist/device/react-native/index.js +4 -21
  216. package/dist/device/react-native/index.js.map +1 -1
  217. package/dist/device/types.d.ts +1 -1
  218. package/dist/groups/index.d.ts +1 -1
  219. package/dist/groups/index.d.ts.map +1 -1
  220. package/dist/index.d.ts +8 -6
  221. package/dist/index.d.ts.map +1 -1
  222. package/dist/index.js +2 -1
  223. package/dist/index.js.map +1 -1
  224. package/dist/internal/crypto/ec/x25519-validation.d.ts +0 -1
  225. package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
  226. package/dist/internal/crypto/ec/x25519-validation.js +0 -1
  227. package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
  228. package/dist/internal/crypto/validation.d.ts +2 -2
  229. package/dist/internal/groups/index.d.ts +1 -0
  230. package/dist/internal/groups/index.d.ts.map +1 -1
  231. package/dist/internal/groups/index.js +1 -0
  232. package/dist/internal/groups/index.js.map +1 -1
  233. package/dist/internal/groups/manager.d.ts +37 -16
  234. package/dist/internal/groups/manager.d.ts.map +1 -1
  235. package/dist/internal/groups/manager.js +46 -1
  236. package/dist/internal/groups/manager.js.map +1 -1
  237. package/dist/internal/groups/receive-record.d.ts +78 -0
  238. package/dist/internal/groups/receive-record.d.ts.map +1 -0
  239. package/dist/internal/groups/receive-record.js +43 -0
  240. package/dist/internal/groups/receive-record.js.map +1 -0
  241. package/dist/internal/groups/sdk-store.d.ts +27 -3
  242. package/dist/internal/groups/sdk-store.d.ts.map +1 -1
  243. package/dist/internal/groups/sdk-store.js +151 -19
  244. package/dist/internal/groups/sdk-store.js.map +1 -1
  245. package/dist/internal/groups/wire.d.ts +12 -1
  246. package/dist/internal/groups/wire.d.ts.map +1 -1
  247. package/dist/internal/groups/wire.js +36 -0
  248. package/dist/internal/groups/wire.js.map +1 -1
  249. package/dist/internal/manager/index.d.ts +1 -1
  250. package/dist/internal/manager/manager.d.ts +20 -19
  251. package/dist/internal/manager/manager.d.ts.map +1 -1
  252. package/dist/internal/manager/manager.js +56 -39
  253. package/dist/internal/manager/manager.js.map +1 -1
  254. package/dist/internal/protocol/double-ratchet/chains.d.ts +4 -18
  255. package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
  256. package/dist/internal/protocol/double-ratchet/chains.js +23 -74
  257. package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
  258. package/dist/internal/protocol/double-ratchet/index.d.ts +1 -1
  259. package/dist/internal/protocol/double-ratchet/index.d.ts.map +1 -1
  260. package/dist/internal/protocol/double-ratchet/index.js +1 -1
  261. package/dist/internal/protocol/double-ratchet/index.js.map +1 -1
  262. package/dist/internal/protocol/double-ratchet/ratchet.d.ts +5 -7
  263. package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
  264. package/dist/internal/protocol/double-ratchet/ratchet.js +4 -6
  265. package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
  266. package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
  267. package/dist/internal/protocol/pqxdh/pqxdh.js +2 -1
  268. package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
  269. package/dist/internal/protocol/sealed-sender/types.d.ts +6 -8
  270. package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
  271. package/dist/internal/protocol/sealed-sender/types.js +8 -9
  272. package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
  273. package/dist/internal/protocol/sender-keys/handoff-ledger.d.ts +110 -0
  274. package/dist/internal/protocol/sender-keys/handoff-ledger.d.ts.map +1 -0
  275. package/dist/internal/protocol/sender-keys/handoff-ledger.js +124 -0
  276. package/dist/internal/protocol/sender-keys/handoff-ledger.js.map +1 -0
  277. package/dist/internal/protocol/sender-keys/manager.d.ts +71 -62
  278. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  279. package/dist/internal/protocol/sender-keys/manager.js +228 -175
  280. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  281. package/dist/internal/protocol/spqr/index.d.ts +2 -2
  282. package/dist/internal/protocol/spqr/index.d.ts.map +1 -1
  283. package/dist/internal/protocol/spqr/index.js +2 -2
  284. package/dist/internal/protocol/spqr/index.js.map +1 -1
  285. package/dist/internal/protocol/spqr/serialize.d.ts +9 -1
  286. package/dist/internal/protocol/spqr/serialize.d.ts.map +1 -1
  287. package/dist/internal/protocol/spqr/serialize.js +56 -16
  288. package/dist/internal/protocol/spqr/serialize.js.map +1 -1
  289. package/dist/internal/protocol/spqr/spqr.d.ts +1 -14
  290. package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
  291. package/dist/internal/protocol/spqr/spqr.js +54 -42
  292. package/dist/internal/protocol/spqr/spqr.js.map +1 -1
  293. package/dist/internal/protocol/spqr/validate.d.ts +26 -6
  294. package/dist/internal/protocol/spqr/validate.d.ts.map +1 -1
  295. package/dist/internal/protocol/spqr/validate.js +49 -21
  296. package/dist/internal/protocol/spqr/validate.js.map +1 -1
  297. package/dist/internal/sesame/index.d.ts +1 -1
  298. package/dist/internal/sesame/index.d.ts.map +1 -1
  299. package/dist/internal/sesame/index.js.map +1 -1
  300. package/dist/internal/sesame/manager.d.ts +66 -13
  301. package/dist/internal/sesame/manager.d.ts.map +1 -1
  302. package/dist/internal/sesame/manager.js +221 -87
  303. package/dist/internal/sesame/manager.js.map +1 -1
  304. package/dist/internal/sesame/types.d.ts +95 -17
  305. package/dist/internal/sesame/types.d.ts.map +1 -1
  306. package/dist/internal/sesame/types.js +17 -0
  307. package/dist/internal/sesame/types.js.map +1 -1
  308. package/dist/internal/session/builder.d.ts +5 -5
  309. package/dist/internal/session/builder.d.ts.map +1 -1
  310. package/dist/internal/session/builder.js +12 -17
  311. package/dist/internal/session/builder.js.map +1 -1
  312. package/dist/internal/session/cipher.d.ts +13 -11
  313. package/dist/internal/session/cipher.d.ts.map +1 -1
  314. package/dist/internal/session/cipher.js +40 -22
  315. package/dist/internal/session/cipher.js.map +1 -1
  316. package/dist/internal/session/factory.d.ts +5 -5
  317. package/dist/internal/session/factory.d.ts.map +1 -1
  318. package/dist/internal/session/factory.js +4 -4
  319. package/dist/internal/session/factory.js.map +1 -1
  320. package/dist/internal/session/handshake.d.ts +14 -16
  321. package/dist/internal/session/handshake.d.ts.map +1 -1
  322. package/dist/internal/session/handshake.js +18 -75
  323. package/dist/internal/session/handshake.js.map +1 -1
  324. package/dist/internal/session/index.d.ts +1 -1
  325. package/dist/internal/session/index.js +1 -1
  326. package/dist/internal/session/record-locks.d.ts +17 -6
  327. package/dist/internal/session/record-locks.d.ts.map +1 -1
  328. package/dist/internal/session/record-locks.js +43 -7
  329. package/dist/internal/session/record-locks.js.map +1 -1
  330. package/dist/internal/session/session-resolver.d.ts +1 -1
  331. package/dist/internal/session/session-resolver.js +1 -1
  332. package/dist/internal/session/state.d.ts +2 -2
  333. package/dist/internal/session/state.js +1 -1
  334. package/dist/internal/session/types.d.ts +4 -12
  335. package/dist/internal/session/types.d.ts.map +1 -1
  336. package/dist/internal/session/types.js +1 -1
  337. package/dist/keys/generation.d.ts +2 -2
  338. package/dist/keys/generation.js +2 -2
  339. package/dist/keys/types.d.ts +5 -5
  340. package/dist/keys/types.d.ts.map +1 -1
  341. package/dist/keys/types.js +1 -1
  342. package/dist/layers.d.ts +1 -1
  343. package/dist/layers.js +2 -2
  344. package/dist/layers.js.map +1 -1
  345. package/dist/local/store/expo/adapter.d.ts.map +1 -1
  346. package/dist/local/store/expo/adapter.js +12 -8
  347. package/dist/local/store/expo/adapter.js.map +1 -1
  348. package/dist/local/store/key-value/adapter.d.ts +76 -10
  349. package/dist/local/store/key-value/adapter.d.ts.map +1 -1
  350. package/dist/local/store/key-value/adapter.js +367 -61
  351. package/dist/local/store/key-value/adapter.js.map +1 -1
  352. package/dist/local/store/key-value/backend-conformance.d.ts.map +1 -1
  353. package/dist/local/store/key-value/backend-conformance.js +74 -0
  354. package/dist/local/store/key-value/backend-conformance.js.map +1 -1
  355. package/dist/local/store/key-value/batch.d.ts +2 -0
  356. package/dist/local/store/key-value/batch.d.ts.map +1 -1
  357. package/dist/local/store/key-value/batch.js +26 -0
  358. package/dist/local/store/key-value/batch.js.map +1 -1
  359. package/dist/local/store/key-value/receive-work.d.ts +55 -0
  360. package/dist/local/store/key-value/receive-work.d.ts.map +1 -0
  361. package/dist/local/store/key-value/receive-work.js +162 -0
  362. package/dist/local/store/key-value/receive-work.js.map +1 -0
  363. package/dist/local/store/key-value/send-log.d.ts +61 -0
  364. package/dist/local/store/key-value/send-log.d.ts.map +1 -0
  365. package/dist/local/store/key-value/send-log.js +430 -0
  366. package/dist/local/store/key-value/send-log.js.map +1 -0
  367. package/dist/local/store/key-value/sender-key-handoff.d.ts +68 -0
  368. package/dist/local/store/key-value/sender-key-handoff.d.ts.map +1 -0
  369. package/dist/local/store/key-value/sender-key-handoff.js +189 -0
  370. package/dist/local/store/key-value/sender-key-handoff.js.map +1 -0
  371. package/dist/local/store/key-value/storage.d.ts +15 -0
  372. package/dist/local/store/key-value/storage.d.ts.map +1 -1
  373. package/dist/local/store/keyed-index.d.ts +23 -0
  374. package/dist/local/store/keyed-index.d.ts.map +1 -0
  375. package/dist/local/store/keyed-index.js +41 -0
  376. package/dist/local/store/keyed-index.js.map +1 -0
  377. package/dist/local/store/memory/adapter.d.ts +44 -12
  378. package/dist/local/store/memory/adapter.d.ts.map +1 -1
  379. package/dist/local/store/memory/adapter.js +197 -46
  380. package/dist/local/store/memory/adapter.js.map +1 -1
  381. package/dist/local/store/memory/send-log.d.ts +42 -0
  382. package/dist/local/store/memory/send-log.d.ts.map +1 -0
  383. package/dist/local/store/memory/send-log.js +190 -0
  384. package/dist/local/store/memory/send-log.js.map +1 -0
  385. package/dist/local/store/node/adapter.d.ts.map +1 -1
  386. package/dist/local/store/node/adapter.js +8 -6
  387. package/dist/local/store/node/adapter.js.map +1 -1
  388. package/dist/local/store/react-native/adapter.d.ts.map +1 -1
  389. package/dist/local/store/react-native/adapter.js +12 -8
  390. package/dist/local/store/react-native/adapter.js.map +1 -1
  391. package/dist/local/store/receive-work.d.ts +87 -0
  392. package/dist/local/store/receive-work.d.ts.map +1 -0
  393. package/dist/local/store/receive-work.js +204 -0
  394. package/dist/local/store/receive-work.js.map +1 -0
  395. package/dist/local/store/received-content.d.ts +3 -3
  396. package/dist/local/store/received-content.d.ts.map +1 -1
  397. package/dist/local/store/received-content.js +2 -11
  398. package/dist/local/store/received-content.js.map +1 -1
  399. package/dist/local/store/reliability.d.ts +317 -18
  400. package/dist/local/store/reliability.d.ts.map +1 -1
  401. package/dist/local/store/reliability.js +371 -46
  402. package/dist/local/store/reliability.js.map +1 -1
  403. package/dist/local/store/send-log-order.d.ts +15 -0
  404. package/dist/local/store/send-log-order.d.ts.map +1 -0
  405. package/dist/local/store/send-log-order.js +24 -0
  406. package/dist/local/store/send-log-order.js.map +1 -0
  407. package/dist/local/store/sender-key-handoff-index.d.ts +38 -0
  408. package/dist/local/store/sender-key-handoff-index.d.ts.map +1 -0
  409. package/dist/local/store/sender-key-handoff-index.js +101 -0
  410. package/dist/local/store/sender-key-handoff-index.js.map +1 -0
  411. package/dist/local/store/sender-key-handoff-table.d.ts +29 -0
  412. package/dist/local/store/sender-key-handoff-table.d.ts.map +1 -0
  413. package/dist/local/store/sender-key-handoff-table.js +97 -0
  414. package/dist/local/store/sender-key-handoff-table.js.map +1 -0
  415. package/dist/local/store/sqlite/encryption.d.ts +8 -1
  416. package/dist/local/store/sqlite/encryption.d.ts.map +1 -1
  417. package/dist/local/store/sqlite/encryption.js +9 -0
  418. package/dist/local/store/sqlite/encryption.js.map +1 -1
  419. package/dist/local/store/sqlite/key-storage/index.d.ts +25 -4
  420. package/dist/local/store/sqlite/key-storage/index.d.ts.map +1 -1
  421. package/dist/local/store/sqlite/key-storage/index.js +68 -7
  422. package/dist/local/store/sqlite/key-storage/index.js.map +1 -1
  423. package/dist/local/store/sqlite/key-storage/message-records.d.ts +16 -4
  424. package/dist/local/store/sqlite/key-storage/message-records.d.ts.map +1 -1
  425. package/dist/local/store/sqlite/key-storage/message-records.js +49 -6
  426. package/dist/local/store/sqlite/key-storage/message-records.js.map +1 -1
  427. package/dist/local/store/sqlite/key-storage/metadata.d.ts +8 -7
  428. package/dist/local/store/sqlite/key-storage/metadata.d.ts.map +1 -1
  429. package/dist/local/store/sqlite/key-storage/metadata.js +17 -15
  430. package/dist/local/store/sqlite/key-storage/metadata.js.map +1 -1
  431. package/dist/local/store/sqlite/key-storage/receive-work.d.ts +27 -0
  432. package/dist/local/store/sqlite/key-storage/receive-work.d.ts.map +1 -0
  433. package/dist/local/store/sqlite/key-storage/receive-work.js +98 -0
  434. package/dist/local/store/sqlite/key-storage/receive-work.js.map +1 -0
  435. package/dist/local/store/sqlite/key-storage/send-log.d.ts +27 -0
  436. package/dist/local/store/sqlite/key-storage/send-log.d.ts.map +1 -0
  437. package/dist/local/store/sqlite/key-storage/send-log.js +178 -0
  438. package/dist/local/store/sqlite/key-storage/send-log.js.map +1 -0
  439. package/dist/local/store/sqlite/key-storage/sender-key-handoff.d.ts +27 -0
  440. package/dist/local/store/sqlite/key-storage/sender-key-handoff.d.ts.map +1 -0
  441. package/dist/local/store/sqlite/key-storage/sender-key-handoff.js +75 -0
  442. package/dist/local/store/sqlite/key-storage/sender-key-handoff.js.map +1 -0
  443. package/dist/local/store/sqlite/key-storage/session-trust.d.ts +2 -2
  444. package/dist/local/store/sqlite/key-storage/session-trust.js +5 -5
  445. package/dist/local/store/sqlite/key-storage/session-trust.js.map +1 -1
  446. package/dist/local/store/sqlite/migrations.d.ts.map +1 -1
  447. package/dist/local/store/sqlite/migrations.js +101 -0
  448. package/dist/local/store/sqlite/migrations.js.map +1 -1
  449. package/dist/local/store/sqlite/models/index.d.ts +2 -1
  450. package/dist/local/store/sqlite/models/index.d.ts.map +1 -1
  451. package/dist/local/store/sqlite/models/index.js +5 -1
  452. package/dist/local/store/sqlite/models/index.js.map +1 -1
  453. package/dist/local/store/sqlite/models/message-record.d.ts +15 -0
  454. package/dist/local/store/sqlite/models/message-record.d.ts.map +1 -1
  455. package/dist/local/store/sqlite/models/message-record.js +24 -0
  456. package/dist/local/store/sqlite/models/message-record.js.map +1 -1
  457. package/dist/local/store/sqlite/models/send-log.d.ts +51 -0
  458. package/dist/local/store/sqlite/models/send-log.d.ts.map +1 -0
  459. package/dist/local/store/sqlite/models/send-log.js +206 -0
  460. package/dist/local/store/sqlite/models/send-log.js.map +1 -0
  461. package/dist/local/store/sqlite/open-store.d.ts +9 -1
  462. package/dist/local/store/sqlite/open-store.d.ts.map +1 -1
  463. package/dist/local/store/sqlite/open-store.js +20 -1
  464. package/dist/local/store/sqlite/open-store.js.map +1 -1
  465. package/dist/local/store/sqlite/schema.d.ts +34 -1
  466. package/dist/local/store/sqlite/schema.d.ts.map +1 -1
  467. package/dist/local/store/sqlite/schema.js +14 -0
  468. package/dist/local/store/sqlite/schema.js.map +1 -1
  469. package/dist/local/store/sqlite/store.d.ts +61 -11
  470. package/dist/local/store/sqlite/store.d.ts.map +1 -1
  471. package/dist/local/store/sqlite/store.js +191 -27
  472. package/dist/local/store/sqlite/store.js.map +1 -1
  473. package/dist/local/store/web/adapter.d.ts +76 -8
  474. package/dist/local/store/web/adapter.d.ts.map +1 -1
  475. package/dist/local/store/web/adapter.js +579 -127
  476. package/dist/local/store/web/adapter.js.map +1 -1
  477. package/dist/local/store/web/receive-work.d.ts +57 -0
  478. package/dist/local/store/web/receive-work.d.ts.map +1 -0
  479. package/dist/local/store/web/receive-work.js +99 -0
  480. package/dist/local/store/web/receive-work.js.map +1 -0
  481. package/dist/local/store/web/send-log.d.ts +92 -0
  482. package/dist/local/store/web/send-log.d.ts.map +1 -0
  483. package/dist/local/store/web/send-log.js +267 -0
  484. package/dist/local/store/web/send-log.js.map +1 -0
  485. package/dist/local/store/web/sender-key-handoff.d.ts +81 -0
  486. package/dist/local/store/web/sender-key-handoff.d.ts.map +1 -0
  487. package/dist/local/store/web/sender-key-handoff.js +156 -0
  488. package/dist/local/store/web/sender-key-handoff.js.map +1 -0
  489. package/dist/local/store/web-sqlite/adapter.d.ts +2 -0
  490. package/dist/local/store/web-sqlite/adapter.d.ts.map +1 -1
  491. package/dist/local/store/web-sqlite/adapter.js +12 -6
  492. package/dist/local/store/web-sqlite/adapter.js.map +1 -1
  493. package/dist/local/vault/custody.d.ts +8 -0
  494. package/dist/local/vault/custody.d.ts.map +1 -0
  495. package/dist/local/vault/custody.js +9 -0
  496. package/dist/local/vault/custody.js.map +1 -0
  497. package/dist/local/vault/electron-safe-storage.d.ts +3 -1
  498. package/dist/local/vault/electron-safe-storage.d.ts.map +1 -1
  499. package/dist/local/vault/electron-safe-storage.js +2 -0
  500. package/dist/local/vault/electron-safe-storage.js.map +1 -1
  501. package/dist/local/vault/expo-secure-store.d.ts +3 -1
  502. package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
  503. package/dist/local/vault/expo-secure-store.js +2 -0
  504. package/dist/local/vault/expo-secure-store.js.map +1 -1
  505. package/dist/local/vault/indexed-db.d.ts +3 -1
  506. package/dist/local/vault/indexed-db.d.ts.map +1 -1
  507. package/dist/local/vault/indexed-db.js +2 -0
  508. package/dist/local/vault/indexed-db.js.map +1 -1
  509. package/dist/local/vault/react-native-keychain.d.ts +3 -1
  510. package/dist/local/vault/react-native-keychain.d.ts.map +1 -1
  511. package/dist/local/vault/react-native-keychain.js +2 -0
  512. package/dist/local/vault/react-native-keychain.js.map +1 -1
  513. package/dist/remote/relay/device-set.d.ts +94 -0
  514. package/dist/remote/relay/device-set.d.ts.map +1 -0
  515. package/dist/remote/relay/device-set.js +156 -0
  516. package/dist/remote/relay/device-set.js.map +1 -0
  517. package/dist/remote/relay/types.d.ts +92 -107
  518. package/dist/remote/relay/types.d.ts.map +1 -1
  519. package/dist/safety/core.d.ts +15 -6
  520. package/dist/safety/core.d.ts.map +1 -1
  521. package/dist/safety/core.js +41 -27
  522. package/dist/safety/core.js.map +1 -1
  523. package/dist/safety/index.d.ts +2 -1
  524. package/dist/safety/index.d.ts.map +1 -1
  525. package/dist/safety/index.js +12 -18
  526. package/dist/safety/index.js.map +1 -1
  527. package/dist/types/api.d.ts +707 -62
  528. package/dist/types/api.d.ts.map +1 -1
  529. package/dist/types/errors.d.ts +14 -33
  530. package/dist/types/errors.d.ts.map +1 -1
  531. package/dist/types/errors.js +14 -24
  532. package/dist/types/errors.js.map +1 -1
  533. package/dist/types/messages.d.ts +2 -2
  534. package/dist/types/messages.js +1 -1
  535. package/dist/types/protocol-config.d.ts +175 -42
  536. package/dist/types/protocol-config.d.ts.map +1 -1
  537. package/dist/types/protocol-config.js +19 -38
  538. package/dist/types/protocol-config.js.map +1 -1
  539. package/dist/types/protocol-constants.d.ts +6 -6
  540. package/dist/types/protocol-constants.js +6 -6
  541. package/dist/types/session.d.ts +7 -7
  542. package/dist/types/session.d.ts.map +1 -1
  543. package/dist/types/session.js +39 -21
  544. package/dist/types/session.js.map +1 -1
  545. package/dist/username/link.d.ts +2 -2
  546. package/dist/username/link.js +2 -2
  547. package/dist/utils/origin-lock.d.ts +45 -0
  548. package/dist/utils/origin-lock.d.ts.map +1 -0
  549. package/dist/utils/origin-lock.js +80 -0
  550. package/dist/utils/origin-lock.js.map +1 -0
  551. package/docs/ASSURANCE.md +6 -6
  552. package/docs/CLIENT_COMPOSITION.md +2 -2
  553. package/docs/DEVIATIONS.md +677 -182
  554. package/docs/E2EE.md +1 -1
  555. package/docs/ERROR_HANDLING.md +165 -2
  556. package/docs/GETTING_STARTED.md +7 -4
  557. package/docs/INTERFACES.md +1 -1
  558. package/docs/PACKAGE_SURFACE.md +6 -5
  559. package/docs/PROTOCOL_POLICY.md +102 -22
  560. package/docs/RECIPES.md +3 -15
  561. package/docs/SECURITY.md +90 -5
  562. package/keys/README.md +3 -3
  563. package/local/store/README.md +78 -14
  564. package/local/store/key-value/README.md +14 -3
  565. package/local/store/node/README.md +8 -3
  566. package/local/store/web/README.md +9 -0
  567. package/local/store/web-sqlite/README.md +14 -2
  568. package/local/vault/README.md +21 -0
  569. package/package.json +1 -6
  570. package/remote/README.md +0 -1
  571. package/remote/relay/README.md +2 -2
  572. package/dist/device/provisioning.d.ts +0 -242
  573. package/dist/device/provisioning.d.ts.map +0 -1
  574. package/dist/device/provisioning.js +0 -421
  575. package/dist/device/provisioning.js.map +0 -1
  576. package/dist/internal/protocol/x3dh/index.d.ts +0 -15
  577. package/dist/internal/protocol/x3dh/index.d.ts.map +0 -1
  578. package/dist/internal/protocol/x3dh/index.js +0 -13
  579. package/dist/internal/protocol/x3dh/index.js.map +0 -1
  580. package/dist/internal/protocol/x3dh/x3dh.d.ts +0 -131
  581. package/dist/internal/protocol/x3dh/x3dh.d.ts.map +0 -1
  582. package/dist/internal/protocol/x3dh/x3dh.js +0 -261
  583. package/dist/internal/protocol/x3dh/x3dh.js.map +0 -1
@@ -0,0 +1,162 @@
1
+ /**
2
+ * The receive records of the key-value store.
3
+ *
4
+ * Each record is one value under `@signal:receive-work:<workId>`. The value
5
+ * is a JSON envelope. The index fields stay in the clear: the revision, the
6
+ * arrival order, the stage, the due time, the size, and, for a record that
7
+ * waits for its group, the group key (a keyed hash, not the group ID). The
8
+ * record JSON is encrypted in `data`. A listing filters on the clear fields
9
+ * and decrypts only the records that it returns. A usage count reads only the
10
+ * clear fields.
11
+ *
12
+ * A write that depends on the stored revision is one `atomicWrite` with a
13
+ * `check` on the value that it read, so a concurrent writer makes the write
14
+ * fail instead of losing an update.
15
+ */
16
+ import { assertReceiveWork, indexMatchesReceiveWorkQuery, parseReceiveWork, receiveWorkGroupKey, receiveWorkIndex, receiveWorkLimit, } from '../receive-work.js';
17
+ /** The key prefix of the receive records. */
18
+ export const RECEIVE_WORK_PREFIX = '@signal:receive-work:';
19
+ /** The key prefix of the legacy received-content rows. */
20
+ export const LEGACY_RECEIVED_CONTENT_PREFIX = '@signal:received-content:';
21
+ function receiveWorkKey(workId) {
22
+ return `${RECEIVE_WORK_PREFIX}${workId}`;
23
+ }
24
+ function parseEnvelope(value) {
25
+ const envelope = JSON.parse(value);
26
+ if (envelope === null ||
27
+ typeof envelope !== 'object' ||
28
+ !Number.isSafeInteger(envelope.revision) ||
29
+ !Number.isSafeInteger(envelope.arrivalSeq) ||
30
+ !Number.isSafeInteger(envelope.dueAt) ||
31
+ !Number.isSafeInteger(envelope.sizeBytes) ||
32
+ typeof envelope.data !== 'string') {
33
+ throw new Error('Invalid receive-work envelope');
34
+ }
35
+ return envelope;
36
+ }
37
+ function isQuotaExceededError(error) {
38
+ return (!!error && typeof error === 'object' && 'name' in error && error.name === 'QuotaExceededError');
39
+ }
40
+ export class KeyValueReceiveWork {
41
+ backend;
42
+ cipher;
43
+ constructor(backend, cipher) {
44
+ this.backend = backend;
45
+ this.cipher = cipher;
46
+ }
47
+ /** The write of one record, for a batch that commits it with other changes. */
48
+ async seal(record) {
49
+ assertReceiveWork(record);
50
+ const envelope = {
51
+ ...(await receiveWorkIndex(record, await this.cipher.databaseKey())),
52
+ data: await this.cipher.encrypt(JSON.stringify(record)),
53
+ };
54
+ return { type: 'set', key: receiveWorkKey(record.workId), value: JSON.stringify(envelope) };
55
+ }
56
+ async get(workId) {
57
+ const value = await this.backend.getItem(receiveWorkKey(workId));
58
+ return value === null ? null : this.open(workId, parseEnvelope(value));
59
+ }
60
+ async put(record, expectedRevision) {
61
+ const write = await this.seal(record);
62
+ return this.writeIfRevision(record.workId, expectedRevision, [write]);
63
+ }
64
+ async list(query = {}) {
65
+ const limit = receiveWorkLimit(query);
66
+ const matches = [];
67
+ for (const key of await this.backend.getAllKeys()) {
68
+ if (!key.startsWith(RECEIVE_WORK_PREFIX))
69
+ continue;
70
+ const value = await this.backend.getItem(key);
71
+ if (value === null)
72
+ continue;
73
+ const envelope = parseEnvelope(value);
74
+ const workId = key.slice(RECEIVE_WORK_PREFIX.length);
75
+ if (!indexMatchesReceiveWorkQuery(envelope, workId, query))
76
+ continue;
77
+ matches.push({ workId, envelope });
78
+ }
79
+ matches.sort((a, b) => a.envelope.arrivalSeq - b.envelope.arrivalSeq ||
80
+ (a.workId < b.workId ? -1 : a.workId > b.workId ? 1 : 0));
81
+ const page = [];
82
+ for (const { workId, envelope } of matches.slice(0, limit)) {
83
+ page.push(await this.open(workId, envelope));
84
+ }
85
+ return page;
86
+ }
87
+ async usage(query = {}) {
88
+ const groupKey = query.groupId === undefined
89
+ ? undefined
90
+ : await receiveWorkGroupKey(await this.cipher.databaseKey(), query.groupId);
91
+ let items = 0;
92
+ let bytes = 0;
93
+ for (const key of await this.backend.getAllKeys()) {
94
+ if (!key.startsWith(RECEIVE_WORK_PREFIX))
95
+ continue;
96
+ const value = await this.backend.getItem(key);
97
+ if (value === null)
98
+ continue;
99
+ const envelope = parseEnvelope(value);
100
+ if (groupKey !== undefined && envelope.blockedGroup !== groupKey)
101
+ continue;
102
+ items += 1;
103
+ bytes += envelope.sizeBytes;
104
+ }
105
+ return { items, bytes };
106
+ }
107
+ /**
108
+ * Delete one record and apply the given writes in one batch, when the
109
+ * record holds the expected revision.
110
+ */
111
+ async complete(workId, expectedRevision, writes) {
112
+ return this.writeIfRevision(workId, expectedRevision, [
113
+ { type: 'remove', key: receiveWorkKey(workId) },
114
+ ...writes,
115
+ ]);
116
+ }
117
+ /** The legacy received-content rows of this backend. Their values are encrypted. */
118
+ legacySource() {
119
+ return {
120
+ listIds: async () => (await this.backend.getAllKeys())
121
+ .filter((key) => key.startsWith(LEGACY_RECEIVED_CONTENT_PREFIX))
122
+ .map((key) => key.slice(LEGACY_RECEIVED_CONTENT_PREFIX.length))
123
+ .sort(),
124
+ read: async (id) => {
125
+ const value = await this.backend.getItem(`${LEGACY_RECEIVED_CONTENT_PREFIX}${id}`);
126
+ return value === null ? null : this.cipher.decrypt(value);
127
+ },
128
+ delete: (id) => this.backend.removeItem(`${LEGACY_RECEIVED_CONTENT_PREFIX}${id}`),
129
+ };
130
+ }
131
+ /**
132
+ * Apply the operations when the stored record holds the expected revision.
133
+ * Null expects no record. The batch checks the value that was read.
134
+ */
135
+ async writeIfRevision(workId, expectedRevision, operations) {
136
+ const key = receiveWorkKey(workId);
137
+ const observed = await this.backend.getItem(key);
138
+ const revision = observed === null ? null : parseEnvelope(observed).revision;
139
+ if (revision !== expectedRevision)
140
+ return false;
141
+ try {
142
+ await this.backend.atomicWrite([{ type: 'check', key, expectedValue: observed }, ...operations]);
143
+ return true;
144
+ }
145
+ catch (error) {
146
+ // A failed batch commits nothing. Do not report capacity failure as contention.
147
+ if (isQuotaExceededError(error))
148
+ throw error;
149
+ if ((await this.backend.getItem(key)) !== observed)
150
+ return false;
151
+ throw error;
152
+ }
153
+ }
154
+ async open(workId, envelope) {
155
+ const record = parseReceiveWork(await this.cipher.decrypt(envelope.data), workId);
156
+ if (record.revision !== envelope.revision) {
157
+ throw new Error('Invalid receive-work record');
158
+ }
159
+ return record;
160
+ }
161
+ }
162
+ //# sourceMappingURL=receive-work.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"receive-work.js","sourceRoot":"","sources":["../../../../local/store/key-value/receive-work.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAGH,OAAO,EACL,iBAAiB,EACjB,4BAA4B,EAC5B,gBAAgB,EAChB,mBAAmB,EACnB,gBAAgB,EAChB,gBAAgB,GAGjB,MAAM,iBAAiB,CAAC;AAGzB,6CAA6C;AAC7C,MAAM,CAAC,MAAM,mBAAmB,GAAG,uBAAuB,CAAC;AAE3D,0DAA0D;AAC1D,MAAM,CAAC,MAAM,8BAA8B,GAAG,2BAA2B,CAAC;AAe1E,SAAS,cAAc,CAAC,MAAc;IACpC,OAAO,GAAG,mBAAmB,GAAG,MAAM,EAAE,CAAC;AAC3C,CAAC;AAED,SAAS,aAAa,CAAC,KAAa;IAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAsB,CAAC;IACxD,IACE,QAAQ,KAAK,IAAI;QACjB,OAAO,QAAQ,KAAK,QAAQ;QAC5B,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACxC,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,UAAU,CAAC;QAC1C,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,KAAK,CAAC;QACrC,CAAC,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC;QACzC,OAAO,QAAQ,CAAC,IAAI,KAAK,QAAQ,EACjC,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAc;IAC1C,OAAO,CACL,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,oBAAoB,CAC/F,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,mBAAmB;IAEX,OAAO;IACP,MAAM;IAFzB,YACmB,OAAwB,EACxB,MAAiC;uBADjC,OAAO;sBACP,MAAM;IACtB,CAAC;IAEJ,+EAA+E;IAC/E,KAAK,CAAC,IAAI,CAAC,MAAyB;QAClC,iBAAiB,CAAC,MAAM,CAAC,CAAC;QAC1B,MAAM,QAAQ,GAAsB;YAClC,GAAG,CAAC,MAAM,gBAAgB,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;YACpE,IAAI,EAAE,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;SACxD,CAAC;QACF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC9F,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,MAAc;QACtB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC;QACjE,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,MAAyB,EAAE,gBAA+B;QAClE,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IACxE,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,KAAK,GAAqB,EAAE;QACrC,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,OAAO,GAA2D,EAAE,CAAC;QAC3E,KAAK,MAAM,GAAG,IAAI,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;YAClD,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,mBAAmB,CAAC;gBAAE,SAAS;YACnD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC9C,IAAI,KAAK,KAAK,IAAI;gBAAE,SAAS;YAC7B,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;YACtC,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;YACrD,IAAI,CAAC,4BAA4B,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC;gBAAE,SAAS;YACrE,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,CAAC,IAAI,CACV,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACP,CAAC,CAAC,QAAQ,CAAC,UAAU,GAAG,CAAC,CAAC,QAAQ,CAAC,UAAU;YAC7C,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAC3D,CAAC;QACF,MAAM,IAAI,GAAwB,EAAE,CAAC;QACrC,KAAK,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;YAC3D,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC/C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,KAAK,GAAyB,EAAE;QAC1C,MAAM,QAAQ,GACZ,KAAK,CAAC,OAAO,KAAK,SAAS;YACzB,CAAC,CAAC,SAAS;YACX,CAAC,CAAC,MAAM,mBAAmB,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QAChF,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,KAAK,MAAM,GAAG,IAAI,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;YAClD,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,mBAAmB,CAAC;gBAAE,SAAS;YACnD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC9C,IAAI,KAAK,KAAK,IAAI;gBAAE,SAAS;YAC7B,MAAM,QAAQ,GAAG,aAAa,CAAC,KAAK,CAAC,CAAC;YACtC,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,CAAC,YAAY,KAAK,QAAQ;gBAAE,SAAS;YAC3E,KAAK,IAAI,CAAC,CAAC;YACX,KAAK,IAAI,QAAQ,CAAC,SAAS,CAAC;QAC9B,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;IAC1B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ,CACZ,MAAc,EACd,gBAAwB,EACxB,MAAoC;QAEpC,OAAO,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,gBAAgB,EAAE;YACpD,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,cAAc,CAAC,MAAM,CAAC,EAAE;YAC/C,GAAG,MAAM;SACV,CAAC,CAAC;IACL,CAAC;IAED,oFAAoF;IACpF,YAAY;QACV,OAAO;YACL,OAAO,EAAE,KAAK,IAAI,EAAE,CAClB,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;iBAC9B,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,8BAA8B,CAAC,CAAC;iBAC/D,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC;iBAC9D,IAAI,EAAE;YACX,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE;gBACjB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,8BAA8B,GAAG,EAAE,EAAE,CAAC,CAAC;gBACnF,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC5D,CAAC;YACD,MAAM,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,8BAA8B,GAAG,EAAE,EAAE,CAAC;SAClF,CAAC;IACJ,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,eAAe,CAC3B,MAAc,EACd,gBAA+B,EAC/B,UAAwC;QAExC,MAAM,GAAG,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;QACnC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjD,MAAM,QAAQ,GAAG,QAAQ,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC;QAC7E,IAAI,QAAQ,KAAK,gBAAgB;YAAE,OAAO,KAAK,CAAC;QAChD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,aAAa,EAAE,QAAQ,EAAE,EAAE,GAAG,UAAU,CAAC,CAAC,CAAC;YACjG,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,gFAAgF;YAChF,IAAI,oBAAoB,CAAC,KAAK,CAAC;gBAAE,MAAM,KAAK,CAAC;YAC7C,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,QAAQ;gBAAE,OAAO,KAAK,CAAC;YACjE,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,IAAI,CAAC,MAAc,EAAE,QAA2B;QAC5D,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;QAClF,IAAI,MAAM,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjD,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}
@@ -0,0 +1,61 @@
1
+ /**
2
+ * The send log of the key-value store: resendable group content, its
3
+ * recipient rows, and the persisted resend jobs.
4
+ *
5
+ * Key layout, under `@signal:send-log:`:
6
+ *
7
+ * - `payload:<send>` holds the encrypted payload.
8
+ * - `created:<createdAt>:<send>` is a clear index of the store clock, so
9
+ * retention runs without a decryption.
10
+ * - `recipient:<user>:<device>:<clientTimestamp>:<send>` is the row of one
11
+ * device. Its value is the clear resend count. The key is the by-device
12
+ * index that a retry request reads.
13
+ * - `job:<jobId>` holds an encrypted resend job.
14
+ *
15
+ * The send ID, the user, the device, and the timestamps stay in the clear for
16
+ * the indexes, as the message record keys do. The content and the group stay
17
+ * encrypted. Each key component is URI-encoded, so it holds no `:`.
18
+ *
19
+ * Each write runs under one in-process lock per backend, and each change of
20
+ * more than one key is one `atomicWrite`. A `check` operation guards each
21
+ * value that a write read, so a second store over the same backend fails its
22
+ * write instead of losing an update.
23
+ */
24
+ import type { NewSendLogPayload, SendLogDevice, SendLogEntry, SendLogRecipient, SendLogResendJob, SendLogResendJobState, SendLogStore } from '../../../types/api.js';
25
+ import type { KeyValueStorage } from './storage.js';
26
+ /** The value cipher of the owning store. */
27
+ export interface KeyValueSendLogCipher {
28
+ encrypt(plaintext: string): Promise<string>;
29
+ decrypt(encrypted: string): Promise<string>;
30
+ }
31
+ export declare class KeyValueSendLog implements SendLogStore {
32
+ private readonly backend;
33
+ private readonly cipher;
34
+ constructor(backend: KeyValueStorage, cipher: KeyValueSendLogCipher);
35
+ storeSendLogEntry(payload: NewSendLogPayload, recipients: readonly SendLogDevice[]): Promise<void>;
36
+ appendSendLogRecipients(clientMessageId: string, recipients: readonly SendLogDevice[]): Promise<void>;
37
+ markSendLogComplete(clientMessageId: string): Promise<void>;
38
+ getSendLogEntry(clientMessageId: string, recipient: SendLogDevice): Promise<SendLogEntry | null>;
39
+ findSendLogEntries(recipient: SendLogDevice, clientTimestamp: number): Promise<SendLogEntry[]>;
40
+ getSendLogRecipients(clientMessageId: string): Promise<SendLogRecipient[]>;
41
+ deleteSendLogRecipient(clientMessageId: string, recipient: SendLogDevice): Promise<boolean>;
42
+ deleteSendLogRecipientsByTimestamp(recipient: SendLogDevice, clientTimestamps: readonly number[]): Promise<number>;
43
+ incrementSendLogResendCount(clientMessageId: string, recipient: SendLogDevice): Promise<number | null>;
44
+ deleteSendLogEntry(clientMessageId: string): Promise<boolean>;
45
+ deleteExpiredSendLog(maxAgeMs: number): Promise<number>;
46
+ clearSendLog(): Promise<number>;
47
+ storeResendJob(job: SendLogResendJob): Promise<void>;
48
+ getResendJob(jobId: string): Promise<SendLogResendJob | null>;
49
+ getPendingResendJobs(): Promise<SendLogResendJob[]>;
50
+ completeResendJob(jobId: string, state: Exclude<SendLogResendJobState, 'pending'>): Promise<void>;
51
+ private write;
52
+ private readPayload;
53
+ private setPayload;
54
+ private decodeJob;
55
+ private deviceRows;
56
+ /** Remove the payload, its index key, and its rows. */
57
+ private removeEntry;
58
+ /** Remove a finished payload when every one of its rows is in `removed`. */
59
+ private removeIfFinished;
60
+ }
61
+ //# sourceMappingURL=send-log.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"send-log.d.ts","sourceRoot":"","sources":["../../../../local/store/key-value/send-log.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,OAAO,KAAK,EACV,iBAAiB,EACjB,aAAa,EACb,YAAY,EAEZ,gBAAgB,EAChB,gBAAgB,EAChB,qBAAqB,EACrB,YAAY,EACb,MAAM,oBAAoB,CAAC;AAM5B,OAAO,KAAK,EAAqB,eAAe,EAAE,MAAM,WAAW,CAAC;AA8BpE,4CAA4C;AAC5C,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,OAAO,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC7C;AAiGD,qBAAa,eAAgB,YAAW,YAAY;IAEhD,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFzB,YACmB,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,qBAAqB,EAC5C;IAEE,iBAAiB,CACrB,OAAO,EAAE,iBAAiB,EAC1B,UAAU,EAAE,SAAS,aAAa,EAAE,GACnC,OAAO,CAAC,IAAI,CAAC,CAef;IAEK,uBAAuB,CAC3B,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,SAAS,aAAa,EAAE,GACnC,OAAO,CAAC,IAAI,CAAC,CAYf;IAEK,mBAAmB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAchE;IAEK,eAAe,CACnB,eAAe,EAAE,MAAM,EACvB,SAAS,EAAE,aAAa,GACvB,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,CAkB9B;IAEK,kBAAkB,CACtB,SAAS,EAAE,aAAa,EACxB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,YAAY,EAAE,CAAC,CAQzB;IAEK,oBAAoB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAc/E;IAEK,sBAAsB,CAC1B,eAAe,EAAE,MAAM,EACvB,SAAS,EAAE,aAAa,GACvB,OAAO,CAAC,OAAO,CAAC,CAgBlB;IAEK,kCAAkC,CACtC,SAAS,EAAE,aAAa,EACxB,gBAAgB,EAAE,SAAS,MAAM,EAAE,GAClC,OAAO,CAAC,MAAM,CAAC,CAyBjB;IAEK,2BAA2B,CAC/B,eAAe,EAAE,MAAM,EACvB,SAAS,EAAE,aAAa,GACvB,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAcxB;IAEK,kBAAkB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAWlE;IAEK,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CA+B5D;IAEK,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC,CAQpC;IAEK,cAAc,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAUzD;IAEK,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAGlE;IAEK,oBAAoB,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAUxD;IAEK,iBAAiB,CACrB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,OAAO,CAAC,qBAAqB,EAAE,SAAS,CAAC,GAC/C,OAAO,CAAC,IAAI,CAAC,CAWf;IAED,OAAO,CAAC,KAAK;YAIC,WAAW;YASX,UAAU;YAgBV,SAAS;IAIvB,OAAO,CAAC,UAAU;IAelB,uDAAuD;IACvD,OAAO,CAAC,WAAW;IAUnB,4EAA4E;IAC5E,OAAO,CAAC,gBAAgB;CAWzB"}
@@ -0,0 +1,430 @@
1
+ /**
2
+ * The send log of the key-value store: resendable group content, its
3
+ * recipient rows, and the persisted resend jobs.
4
+ *
5
+ * Key layout, under `@signal:send-log:`:
6
+ *
7
+ * - `payload:<send>` holds the encrypted payload.
8
+ * - `created:<createdAt>:<send>` is a clear index of the store clock, so
9
+ * retention runs without a decryption.
10
+ * - `recipient:<user>:<device>:<clientTimestamp>:<send>` is the row of one
11
+ * device. Its value is the clear resend count. The key is the by-device
12
+ * index that a retry request reads.
13
+ * - `job:<jobId>` holds an encrypted resend job.
14
+ *
15
+ * The send ID, the user, the device, and the timestamps stay in the clear for
16
+ * the indexes, as the message record keys do. The content and the group stay
17
+ * encrypted. Each key component is URI-encoded, so it holds no `:`.
18
+ *
19
+ * Each write runs under one in-process lock per backend, and each change of
20
+ * more than one key is one `atomicWrite`. A `check` operation guards each
21
+ * value that a write read, so a second store over the same backend fails its
22
+ * write instead of losing an update.
23
+ */
24
+ import { base64ToBytes, bytesToBase64 } from '../../../internal/crypto/utils.js';
25
+ import { asBase64 } from '../../../types/utils.js';
26
+ import { createKeyedLocks, withKeyedLock } from '../../../utils/keyed-lock.js';
27
+ import { compareResendJobs, compareSendLogDevices, compareSendLogEntries } from '../send-log-order.js';
28
+ const PREFIX = '@signal:send-log:';
29
+ const PAYLOAD_PREFIX = `${PREFIX}payload:`;
30
+ const CREATED_PREFIX = `${PREFIX}created:`;
31
+ const RECIPIENT_PREFIX = `${PREFIX}recipient:`;
32
+ const JOB_PREFIX = `${PREFIX}job:`;
33
+ /** One lock per backend, so two stores over one backend in one process take turns. */
34
+ const sendLogLocks = createKeyedLocks();
35
+ const SEND_LOG_LOCK = 'send-log';
36
+ function component(value) {
37
+ return encodeURIComponent(value);
38
+ }
39
+ function payloadKey(clientMessageId) {
40
+ return `${PAYLOAD_PREFIX}${component(clientMessageId)}`;
41
+ }
42
+ function createdKey(createdAt, clientMessageId) {
43
+ return `${CREATED_PREFIX}${createdAt}:${component(clientMessageId)}`;
44
+ }
45
+ function deviceTimestampPrefix(device, clientTimestamp) {
46
+ return `${RECIPIENT_PREFIX}${component(device.userId)}:${device.deviceId}:${clientTimestamp}:`;
47
+ }
48
+ function recipientKey(device, clientTimestamp, clientMessageId) {
49
+ return `${deviceTimestampPrefix(device, clientTimestamp)}${component(clientMessageId)}`;
50
+ }
51
+ function jobKey(jobId) {
52
+ return `${JOB_PREFIX}${component(jobId)}`;
53
+ }
54
+ function parseRowKey(key) {
55
+ if (!key.startsWith(RECIPIENT_PREFIX))
56
+ return null;
57
+ const parts = key.slice(RECIPIENT_PREFIX.length).split(':');
58
+ if (parts.length !== 4)
59
+ return null;
60
+ const [userId, deviceId, clientTimestamp, clientMessageId] = parts;
61
+ return {
62
+ key,
63
+ userId: decodeURIComponent(userId),
64
+ deviceId: Number(deviceId),
65
+ clientTimestamp: Number(clientTimestamp),
66
+ clientMessageId: decodeURIComponent(clientMessageId),
67
+ };
68
+ }
69
+ function rowKeysOf(allKeys, clientMessageId) {
70
+ const rows = [];
71
+ for (const key of allKeys) {
72
+ const row = parseRowKey(key);
73
+ if (row?.clientMessageId === clientMessageId)
74
+ rows.push(row);
75
+ }
76
+ return rows;
77
+ }
78
+ function createdKeysOf(allKeys, clientMessageId) {
79
+ const suffix = `:${component(clientMessageId)}`;
80
+ return allKeys.filter((key) => key.startsWith(CREATED_PREFIX) && key.endsWith(suffix));
81
+ }
82
+ function parseCount(value) {
83
+ const count = Number(value);
84
+ if (!Number.isSafeInteger(count) || count < 0) {
85
+ throw new Error('Send log row holds an invalid resend count');
86
+ }
87
+ return count;
88
+ }
89
+ /**
90
+ * The final operations of one write. A later operation on a key replaces an
91
+ * earlier one, and every `check` runs before every write.
92
+ */
93
+ class WriteBatch {
94
+ checks = [];
95
+ writes = new Map();
96
+ check(key, expectedValue) {
97
+ this.checks.push({ type: 'check', key, expectedValue });
98
+ }
99
+ set(key, value) {
100
+ this.writes.set(key, { type: 'set', key, value });
101
+ }
102
+ remove(key) {
103
+ this.writes.set(key, { type: 'remove', key });
104
+ }
105
+ async commit(backend) {
106
+ if (this.writes.size === 0)
107
+ return;
108
+ await backend.atomicWrite([...this.checks, ...this.writes.values()]);
109
+ }
110
+ }
111
+ export class KeyValueSendLog {
112
+ backend;
113
+ cipher;
114
+ constructor(backend, cipher) {
115
+ this.backend = backend;
116
+ this.cipher = cipher;
117
+ }
118
+ async storeSendLogEntry(payload, recipients) {
119
+ await this.write(async () => {
120
+ const allKeys = await this.backend.getAllKeys();
121
+ const key = payloadKey(payload.clientMessageId);
122
+ const batch = new WriteBatch();
123
+ batch.check(key, await this.backend.getItem(key));
124
+ this.removeEntry(batch, allKeys, payload.clientMessageId);
125
+ const stored = { ...payload, createdAt: Date.now(), sendComplete: false };
126
+ await this.setPayload(batch, stored);
127
+ batch.set(createdKey(stored.createdAt, stored.clientMessageId), '');
128
+ for (const device of recipients) {
129
+ batch.set(recipientKey(device, stored.clientTimestamp, stored.clientMessageId), '0');
130
+ }
131
+ await batch.commit(this.backend);
132
+ });
133
+ }
134
+ async appendSendLogRecipients(clientMessageId, recipients) {
135
+ await this.write(async () => {
136
+ const read = await this.readPayload(clientMessageId);
137
+ if (!read)
138
+ return;
139
+ const batch = new WriteBatch();
140
+ batch.check(payloadKey(clientMessageId), read.raw);
141
+ for (const device of recipients) {
142
+ const key = recipientKey(device, read.payload.clientTimestamp, clientMessageId);
143
+ if ((await this.backend.getItem(key)) === null)
144
+ batch.set(key, '0');
145
+ }
146
+ await batch.commit(this.backend);
147
+ });
148
+ }
149
+ async markSendLogComplete(clientMessageId) {
150
+ await this.write(async () => {
151
+ const read = await this.readPayload(clientMessageId);
152
+ if (!read)
153
+ return;
154
+ const allKeys = await this.backend.getAllKeys();
155
+ const batch = new WriteBatch();
156
+ batch.check(payloadKey(clientMessageId), read.raw);
157
+ if (rowKeysOf(allKeys, clientMessageId).length === 0) {
158
+ this.removeEntry(batch, allKeys, clientMessageId);
159
+ }
160
+ else {
161
+ await this.setPayload(batch, { ...read.payload, sendComplete: true });
162
+ }
163
+ await batch.commit(this.backend);
164
+ });
165
+ }
166
+ async getSendLogEntry(clientMessageId, recipient) {
167
+ const read = await this.readPayload(clientMessageId);
168
+ if (!read)
169
+ return null;
170
+ const { clientTimestamp } = read.payload;
171
+ const value = await this.backend.getItem(recipientKey(recipient, clientTimestamp, clientMessageId));
172
+ if (value === null)
173
+ return null;
174
+ return {
175
+ payload: read.payload,
176
+ recipient: {
177
+ clientMessageId,
178
+ userId: recipient.userId,
179
+ deviceId: recipient.deviceId,
180
+ clientTimestamp,
181
+ responses: parseCount(value),
182
+ },
183
+ };
184
+ }
185
+ async findSendLogEntries(recipient, clientTimestamp) {
186
+ const entries = [];
187
+ const allKeys = await this.backend.getAllKeys();
188
+ for (const row of this.deviceRows(allKeys, recipient, clientTimestamp)) {
189
+ const entry = await this.getSendLogEntry(row.clientMessageId, recipient);
190
+ if (entry)
191
+ entries.push(entry);
192
+ }
193
+ return entries.sort(compareSendLogEntries);
194
+ }
195
+ async getSendLogRecipients(clientMessageId) {
196
+ const rows = [];
197
+ for (const row of rowKeysOf(await this.backend.getAllKeys(), clientMessageId)) {
198
+ const value = await this.backend.getItem(row.key);
199
+ if (value === null)
200
+ continue;
201
+ rows.push({
202
+ clientMessageId,
203
+ userId: row.userId,
204
+ deviceId: row.deviceId,
205
+ clientTimestamp: row.clientTimestamp,
206
+ responses: parseCount(value),
207
+ });
208
+ }
209
+ return rows.sort(compareSendLogDevices);
210
+ }
211
+ async deleteSendLogRecipient(clientMessageId, recipient) {
212
+ return this.write(async () => {
213
+ const read = await this.readPayload(clientMessageId);
214
+ if (!read)
215
+ return false;
216
+ const key = recipientKey(recipient, read.payload.clientTimestamp, clientMessageId);
217
+ const value = await this.backend.getItem(key);
218
+ if (value === null)
219
+ return false;
220
+ const allKeys = await this.backend.getAllKeys();
221
+ const batch = new WriteBatch();
222
+ batch.check(payloadKey(clientMessageId), read.raw);
223
+ batch.check(key, value);
224
+ batch.remove(key);
225
+ this.removeIfFinished(batch, allKeys, read.payload, new Set([key]));
226
+ await batch.commit(this.backend);
227
+ return true;
228
+ });
229
+ }
230
+ async deleteSendLogRecipientsByTimestamp(recipient, clientTimestamps) {
231
+ return this.write(async () => {
232
+ const allKeys = await this.backend.getAllKeys();
233
+ const removed = new Set();
234
+ const touched = new Set();
235
+ for (const clientTimestamp of new Set(clientTimestamps)) {
236
+ for (const row of this.deviceRows(allKeys, recipient, clientTimestamp)) {
237
+ removed.add(row.key);
238
+ touched.add(row.clientMessageId);
239
+ }
240
+ }
241
+ const batch = new WriteBatch();
242
+ for (const key of removed) {
243
+ batch.check(key, await this.backend.getItem(key));
244
+ batch.remove(key);
245
+ }
246
+ for (const clientMessageId of touched) {
247
+ const read = await this.readPayload(clientMessageId);
248
+ if (!read)
249
+ continue;
250
+ batch.check(payloadKey(clientMessageId), read.raw);
251
+ this.removeIfFinished(batch, allKeys, read.payload, removed);
252
+ }
253
+ await batch.commit(this.backend);
254
+ return removed.size;
255
+ });
256
+ }
257
+ async incrementSendLogResendCount(clientMessageId, recipient) {
258
+ return this.write(async () => {
259
+ const read = await this.readPayload(clientMessageId);
260
+ if (!read)
261
+ return null;
262
+ const key = recipientKey(recipient, read.payload.clientTimestamp, clientMessageId);
263
+ const value = await this.backend.getItem(key);
264
+ if (value === null)
265
+ return null;
266
+ const responses = parseCount(value) + 1;
267
+ const batch = new WriteBatch();
268
+ batch.check(key, value);
269
+ batch.set(key, String(responses));
270
+ await batch.commit(this.backend);
271
+ return responses;
272
+ });
273
+ }
274
+ async deleteSendLogEntry(clientMessageId) {
275
+ return this.write(async () => {
276
+ const key = payloadKey(clientMessageId);
277
+ const raw = await this.backend.getItem(key);
278
+ if (raw === null)
279
+ return false;
280
+ const batch = new WriteBatch();
281
+ batch.check(key, raw);
282
+ this.removeEntry(batch, await this.backend.getAllKeys(), clientMessageId);
283
+ await batch.commit(this.backend);
284
+ return true;
285
+ });
286
+ }
287
+ async deleteExpiredSendLog(maxAgeMs) {
288
+ return this.write(async () => {
289
+ const cutoff = Date.now() - maxAgeMs;
290
+ const allKeys = await this.backend.getAllKeys();
291
+ const expired = new Set();
292
+ for (const key of allKeys) {
293
+ if (!key.startsWith(CREATED_PREFIX))
294
+ continue;
295
+ const [createdAt, clientMessageId] = key.slice(CREATED_PREFIX.length).split(':');
296
+ if (Number(createdAt) < cutoff && clientMessageId !== undefined) {
297
+ expired.add(decodeURIComponent(clientMessageId));
298
+ }
299
+ }
300
+ const present = new Set(allKeys);
301
+ const batch = new WriteBatch();
302
+ let deleted = 0;
303
+ for (const clientMessageId of expired) {
304
+ if (present.has(payloadKey(clientMessageId)))
305
+ deleted++;
306
+ this.removeEntry(batch, allKeys, clientMessageId);
307
+ }
308
+ for (const key of allKeys) {
309
+ if (!key.startsWith(JOB_PREFIX))
310
+ continue;
311
+ const raw = await this.backend.getItem(key);
312
+ if (raw === null)
313
+ continue;
314
+ if ((await this.decodeJob(raw)).createdAt < cutoff) {
315
+ batch.check(key, raw);
316
+ batch.remove(key);
317
+ }
318
+ }
319
+ await batch.commit(this.backend);
320
+ return deleted;
321
+ });
322
+ }
323
+ async clearSendLog() {
324
+ return this.write(async () => {
325
+ const keys = (await this.backend.getAllKeys()).filter((key) => key.startsWith(PREFIX));
326
+ const batch = new WriteBatch();
327
+ for (const key of keys)
328
+ batch.remove(key);
329
+ await batch.commit(this.backend);
330
+ return keys.filter((key) => key.startsWith(PAYLOAD_PREFIX)).length;
331
+ });
332
+ }
333
+ async storeResendJob(job) {
334
+ await this.write(async () => {
335
+ const key = jobKey(job.jobId);
336
+ const raw = await this.backend.getItem(key);
337
+ const createdAt = raw === null ? Date.now() : (await this.decodeJob(raw)).createdAt;
338
+ const batch = new WriteBatch();
339
+ batch.check(key, raw);
340
+ batch.set(key, await this.cipher.encrypt(JSON.stringify({ ...job, createdAt })));
341
+ await batch.commit(this.backend);
342
+ });
343
+ }
344
+ async getResendJob(jobId) {
345
+ const raw = await this.backend.getItem(jobKey(jobId));
346
+ return raw === null ? null : this.decodeJob(raw);
347
+ }
348
+ async getPendingResendJobs() {
349
+ const jobs = [];
350
+ for (const key of await this.backend.getAllKeys()) {
351
+ if (!key.startsWith(JOB_PREFIX))
352
+ continue;
353
+ const raw = await this.backend.getItem(key);
354
+ if (raw === null)
355
+ continue;
356
+ const job = await this.decodeJob(raw);
357
+ if (job.state === 'pending')
358
+ jobs.push(job);
359
+ }
360
+ return jobs.sort(compareResendJobs);
361
+ }
362
+ async completeResendJob(jobId, state) {
363
+ await this.write(async () => {
364
+ const key = jobKey(jobId);
365
+ const raw = await this.backend.getItem(key);
366
+ if (raw === null)
367
+ return;
368
+ const batch = new WriteBatch();
369
+ batch.check(key, raw);
370
+ const job = await this.decodeJob(raw);
371
+ batch.set(key, await this.cipher.encrypt(JSON.stringify({ ...job, state })));
372
+ await batch.commit(this.backend);
373
+ });
374
+ }
375
+ write(operation) {
376
+ return withKeyedLock(sendLogLocks, this.backend, SEND_LOG_LOCK, operation);
377
+ }
378
+ async readPayload(clientMessageId) {
379
+ const raw = await this.backend.getItem(payloadKey(clientMessageId));
380
+ if (raw === null)
381
+ return null;
382
+ const stored = JSON.parse(await this.cipher.decrypt(raw));
383
+ return { raw, payload: { ...stored, plaintext: base64ToBytes(asBase64(stored.plaintext)) } };
384
+ }
385
+ async setPayload(batch, payload) {
386
+ const stored = {
387
+ clientMessageId: payload.clientMessageId,
388
+ groupId: payload.groupId,
389
+ clientTimestamp: payload.clientTimestamp,
390
+ contentHint: payload.contentHint,
391
+ plaintext: bytesToBase64(payload.plaintext),
392
+ createdAt: payload.createdAt,
393
+ sendComplete: payload.sendComplete,
394
+ };
395
+ batch.set(payloadKey(payload.clientMessageId), await this.cipher.encrypt(JSON.stringify(stored)));
396
+ }
397
+ async decodeJob(raw) {
398
+ return JSON.parse(await this.cipher.decrypt(raw));
399
+ }
400
+ deviceRows(allKeys, device, clientTimestamp) {
401
+ const prefix = deviceTimestampPrefix(device, clientTimestamp);
402
+ const rows = [];
403
+ for (const key of allKeys) {
404
+ if (!key.startsWith(prefix))
405
+ continue;
406
+ const row = parseRowKey(key);
407
+ if (row)
408
+ rows.push(row);
409
+ }
410
+ return rows;
411
+ }
412
+ /** Remove the payload, its index key, and its rows. */
413
+ removeEntry(batch, allKeys, clientMessageId) {
414
+ batch.remove(payloadKey(clientMessageId));
415
+ for (const key of createdKeysOf(allKeys, clientMessageId))
416
+ batch.remove(key);
417
+ for (const row of rowKeysOf(allKeys, clientMessageId))
418
+ batch.remove(row.key);
419
+ }
420
+ /** Remove a finished payload when every one of its rows is in `removed`. */
421
+ removeIfFinished(batch, allKeys, payload, removed) {
422
+ if (!payload.sendComplete)
423
+ return;
424
+ const rows = rowKeysOf(allKeys, payload.clientMessageId);
425
+ if (rows.some((row) => !removed.has(row.key)))
426
+ return;
427
+ this.removeEntry(batch, allKeys, payload.clientMessageId);
428
+ }
429
+ }
430
+ //# sourceMappingURL=send-log.js.map