@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
@@ -19,10 +19,12 @@ export const RELIABILITY_RECORD_TTL_MS = 30 * DAY_MS;
19
19
  */
20
20
  export const RETRY_REQUESTER_RECORD_TTL_MS = 2 * RELIABILITY_RECORD_TTL_MS;
21
21
  /**
22
- * The time from attempt 1 of a retry request to the end of its attempts. A
23
- * request with no answer at this time ends as `expired-content`.
22
+ * The time from the first failure of a retry request to its end: 14 days,
23
+ * the default retention of resendable content of a sender,
24
+ * `RESENDABLE_CONTENT_RETENTION_MS`. A request whose content did not come
25
+ * at this time ends as `expired-content`.
24
26
  */
25
- export const RETRY_REQUEST_DEADLINE_MS = DAY_MS;
27
+ export const RETRY_REQUEST_DEADLINE_MS = 14 * DAY_MS;
26
28
  const mutationTails = new WeakMap();
27
29
  const outgoingIntentLocks = createKeyedLocks();
28
30
  const incomingEnvelopeLocks = createKeyedLocks();
@@ -144,33 +146,193 @@ function sameIntent(a, b) {
144
146
  a.groupSenderKeyDistributionId === b.groupSenderKeyDistributionId &&
145
147
  JSON.stringify(a.groupSharedMessage) === JSON.stringify(b.groupSharedMessage));
146
148
  }
147
- export async function appendOutgoingGroupDeviceMessages(store, clientMessageId, messages) {
149
+ /**
150
+ * Apply a change of the device set to a group intent in one write. Each
151
+ * removed device first loses all of its messages. Then each new message is
152
+ * appended to its list. A new message for a device that still has a message
153
+ * in the same list must be equal to it, and is not appended again. The same
154
+ * write replaces or removes the shared body when the change names one.
155
+ */
156
+ export async function reconcileOutgoingGroupDeviceSet(store, clientMessageId, change) {
148
157
  return serializeMutation(store, async () => {
149
158
  const key = recordKey('outbox', clientMessageId);
150
159
  const existing = parseJson(await store.getMetadata(key), null);
151
160
  if (!existing || existing.kind !== 'group' || existing.result) {
152
- throw new Error('Cannot extend a missing or completed group outbox intent');
161
+ throw new Error('Cannot change the devices of a missing or completed group outbox intent');
153
162
  }
154
- for (const message of messages) {
155
- const prior = existing.deviceMessages.find((candidate) => candidate.recipientUserId === message.recipientUserId &&
156
- candidate.recipientDeviceId === message.recipientDeviceId);
157
- if (prior) {
158
- if (JSON.stringify(prior) !== JSON.stringify(message)) {
159
- throw new Error('Cannot replace a persisted group repair transmission');
160
- }
161
- continue;
162
- }
163
- existing.deviceMessages.push(cloneReliabilityValue(message));
163
+ const removed = new Set(change.removed.map(outgoingDeviceKey));
164
+ const kept = (messages) => messages.filter((message) => !removed.has(outgoingMessageDeviceKey(message)));
165
+ const preMessages = appendOutgoingDeviceMessages(kept(existing.preMessages ?? []), change.preMessages);
166
+ existing.deviceMessages = appendOutgoingDeviceMessages(kept(existing.deviceMessages), change.deviceMessages);
167
+ existing.syncMessages = appendOutgoingDeviceMessages(kept(existing.syncMessages), change.syncMessages);
168
+ if (preMessages.length > 0)
169
+ existing.preMessages = preMessages;
170
+ else
171
+ delete existing.preMessages;
172
+ applyGroupSharedMessage(existing, change.groupSharedMessage);
173
+ await store.setMetadata(key, JSON.stringify(existing));
174
+ return cloneReliabilityValue(existing);
175
+ });
176
+ }
177
+ /**
178
+ * Replace the shared body of a group intent, or remove it with null. An
179
+ * absent body leaves the stored body.
180
+ */
181
+ function applyGroupSharedMessage(intent, groupSharedMessage) {
182
+ if (groupSharedMessage === null)
183
+ delete intent.groupSharedMessage;
184
+ else if (groupSharedMessage) {
185
+ intent.groupSharedMessage = cloneReliabilityValue(groupSharedMessage);
186
+ }
187
+ }
188
+ /**
189
+ * Commit the repair of a declared send phase and its restart count in one
190
+ * write. Each removed device first loses all of its messages. Then each new
191
+ * message is appended to its list. A completed intent takes a repair only of
192
+ * its pending sync phase, and a terminal intent takes none.
193
+ */
194
+ export async function repairOutgoingDeviceSet(store, clientMessageId, repair) {
195
+ return serializeMutation(store, async () => {
196
+ const key = recordKey('outbox', clientMessageId);
197
+ const existing = parseJson(await store.getMetadata(key), null);
198
+ if (!existing || (existing.result && !(repair.phase === 'sync' && existing.syncPending))) {
199
+ throw new Error('Cannot repair the device set of a missing or completed outbox intent');
200
+ }
201
+ if (existing.deviceSetUnresolved) {
202
+ throw new Error('Cannot repair the device set of a terminal outbox intent');
203
+ }
204
+ const restarts = existing.deviceSetRestarts?.[repair.phase] ?? 0;
205
+ if (repair.restarts !== restarts + 1) {
206
+ throw new Error('Cannot repair the device set of an outbox intent from a different restart');
207
+ }
208
+ const removed = new Set(repair.removed.map(outgoingDeviceKey));
209
+ const kept = (messages) => messages.filter((message) => !removed.has(outgoingMessageDeviceKey(message)));
210
+ const preMessages = appendOutgoingDeviceMessages(kept(existing.preMessages ?? []), repair.preMessages ?? []);
211
+ existing.deviceMessages = appendOutgoingDeviceMessages(kept(existing.deviceMessages), repair.deviceMessages ?? []);
212
+ existing.syncMessages = appendOutgoingDeviceMessages(kept(existing.syncMessages), repair.syncMessages ?? [], 'Cannot replace a persisted sync transmission');
213
+ if (preMessages.length > 0)
214
+ existing.preMessages = preMessages;
215
+ else
216
+ delete existing.preMessages;
217
+ applyGroupSharedMessage(existing, repair.groupSharedMessage);
218
+ existing.deviceSetRestarts = { ...existing.deviceSetRestarts, [repair.phase]: repair.restarts };
219
+ const bundleMissing = (repair.bundleMissing ?? []).map((device) => ({
220
+ userId: device.userId,
221
+ deviceId: device.deviceId,
222
+ }));
223
+ const otherPhase = repair.phase === 'recipient' ? 'sync' : 'recipient';
224
+ const otherMissing = existing.deviceSetBundleMissing?.[otherPhase];
225
+ if (bundleMissing.length === 0 && !otherMissing)
226
+ delete existing.deviceSetBundleMissing;
227
+ else {
228
+ existing.deviceSetBundleMissing = {
229
+ ...(otherMissing && { [otherPhase]: otherMissing }),
230
+ ...(bundleMissing.length > 0 && { [repair.phase]: bundleMissing }),
231
+ };
232
+ }
233
+ await store.setMetadata(key, JSON.stringify(existing));
234
+ return cloneReliabilityValue(existing);
235
+ });
236
+ }
237
+ /**
238
+ * Record that a phase of a declared send ended without reconciliation. The
239
+ * restart counts stay. The SDK does not post the phase again until the
240
+ * application calls `send()` with the same `clientMessageId`.
241
+ */
242
+ export async function markOutgoingDeviceSetUnresolved(store, clientMessageId, unresolved) {
243
+ return serializeMutation(store, async () => {
244
+ const key = recordKey('outbox', clientMessageId);
245
+ const existing = parseJson(await store.getMetadata(key), null);
246
+ if (!existing || (existing.result && !(unresolved.phase === 'sync' && existing.syncPending))) {
247
+ throw new Error('Cannot end the device set of a missing or completed outbox intent');
164
248
  }
249
+ existing.deviceSetUnresolved = cloneReliabilityValue(unresolved);
165
250
  await store.setMetadata(key, JSON.stringify(existing));
166
251
  return cloneReliabilityValue(existing);
167
252
  });
168
253
  }
169
254
  /**
170
- * Remove the pre-messages that the relay accepted from a group intent, so a
171
- * replay posts only the pre-messages that the relay did not accept.
255
+ * Start a new run of a terminal declared send at 0 restarts: remove the
256
+ * terminal record and the restart counts in one write. An intent that is not
257
+ * terminal keeps its counts.
258
+ */
259
+ export async function restartOutgoingDeviceSet(store, clientMessageId) {
260
+ return serializeMutation(store, async () => {
261
+ const key = recordKey('outbox', clientMessageId);
262
+ const existing = parseJson(await store.getMetadata(key), null);
263
+ if (!existing)
264
+ throw new Error('Cannot restart a missing outbox intent');
265
+ if (existing.deviceSetUnresolved) {
266
+ delete existing.deviceSetUnresolved;
267
+ delete existing.deviceSetRestarts;
268
+ await store.setMetadata(key, JSON.stringify(existing));
269
+ }
270
+ return cloneReliabilityValue(existing);
271
+ });
272
+ }
273
+ /**
274
+ * Complete the pending sync phase of a completed intent: remove its sync
275
+ * messages, its restart counts, and its terminal record.
276
+ */
277
+ export async function completeOutgoingSyncPhase(store, clientMessageId) {
278
+ await serializeMutation(store, async () => {
279
+ const key = recordKey('outbox', clientMessageId);
280
+ const existing = parseJson(await store.getMetadata(key), null);
281
+ if (!existing?.result)
282
+ throw new Error('Cannot complete the sync phase of an open intent');
283
+ delete existing.syncPending;
284
+ delete existing.deviceSetRestarts;
285
+ delete existing.deviceSetUnresolved;
286
+ delete existing.deviceSetBundleMissing;
287
+ existing.syncMessages = [];
288
+ await store.setMetadata(key, JSON.stringify(existing));
289
+ });
290
+ }
291
+ /**
292
+ * The result of a completed intent as a send returns it. A pending sync
293
+ * phase gives `syncPending`.
294
+ */
295
+ export function outgoingMessageIntentResult(intent) {
296
+ if (!intent.result)
297
+ return undefined;
298
+ return {
299
+ ...cloneReliabilityValue(intent.result),
300
+ ...(intent.syncPending && { syncPending: true }),
301
+ };
302
+ }
303
+ function outgoingDeviceKey({ userId, deviceId }) {
304
+ return `${userId}\u0000${String(deviceId)}`;
305
+ }
306
+ function outgoingMessageDeviceKey(message) {
307
+ return outgoingDeviceKey({
308
+ userId: message.recipientUserId,
309
+ deviceId: message.recipientDeviceId,
310
+ });
311
+ }
312
+ /**
313
+ * The messages with each new message appended once. A stored message of the
314
+ * same device must be equal to the new message.
315
+ */
316
+ function appendOutgoingDeviceMessages(messages, additions, refusal = 'Cannot replace a persisted group transmission') {
317
+ for (const message of additions) {
318
+ const prior = messages.find((candidate) => outgoingMessageDeviceKey(candidate) === outgoingMessageDeviceKey(message));
319
+ if (prior) {
320
+ if (JSON.stringify(prior) !== JSON.stringify(message)) {
321
+ throw new Error(refusal);
322
+ }
323
+ continue;
324
+ }
325
+ messages.push(cloneReliabilityValue(message));
326
+ }
327
+ return messages;
328
+ }
329
+ /**
330
+ * Remove the pre-messages that the relay accepted or that the send dropped
331
+ * from a group intent, so a replay posts only the pre-messages that the relay
332
+ * did not accept. Each device in `removedDevices` loses all of its messages
333
+ * in the same write.
172
334
  */
173
- export async function confirmOutgoingPreMessages(store, clientMessageId, acceptedClientMessageIds) {
335
+ export async function confirmOutgoingPreMessages(store, clientMessageId, acceptedClientMessageIds, removedDevices = []) {
174
336
  return serializeMutation(store, async () => {
175
337
  const key = recordKey('outbox', clientMessageId);
176
338
  const existing = parseJson(await store.getMetadata(key), null);
@@ -178,7 +340,11 @@ export async function confirmOutgoingPreMessages(store, clientMessageId, accepte
178
340
  throw new Error('Cannot confirm pre-messages of a missing or completed group outbox intent');
179
341
  }
180
342
  const accepted = new Set(acceptedClientMessageIds);
181
- const remaining = (existing.preMessages ?? []).filter((message) => message.clientMessageId === undefined || !accepted.has(message.clientMessageId));
343
+ const removed = new Set(removedDevices.map(outgoingDeviceKey));
344
+ const kept = (messages) => messages.filter((message) => !removed.has(outgoingMessageDeviceKey(message)));
345
+ const remaining = kept(existing.preMessages ?? []).filter((message) => message.clientMessageId === undefined || !accepted.has(message.clientMessageId));
346
+ existing.deviceMessages = kept(existing.deviceMessages);
347
+ existing.syncMessages = kept(existing.syncMessages);
182
348
  if (remaining.length > 0)
183
349
  existing.preMessages = remaining;
184
350
  else
@@ -187,6 +353,36 @@ export async function confirmOutgoingPreMessages(store, clientMessageId, accepte
187
353
  return cloneReliabilityValue(existing);
188
354
  });
189
355
  }
356
+ /**
357
+ * Replace stored pre-messages of a group intent in one write. Each
358
+ * replacement keeps the target and the timestamp of the pre-message that it
359
+ * replaces, and the stored pre-message must still equal the expected one.
360
+ */
361
+ export async function replaceOutgoingGroupPreMessages(store, clientMessageId, replacements) {
362
+ return serializeMutation(store, async () => {
363
+ const key = recordKey('outbox', clientMessageId);
364
+ const existing = parseJson(await store.getMetadata(key), null);
365
+ if (!existing || existing.kind !== 'group' || existing.result) {
366
+ throw new Error('Cannot replace pre-messages of a missing or completed group outbox intent');
367
+ }
368
+ const preMessages = existing.preMessages ?? [];
369
+ for (const { expected, replacement } of replacements) {
370
+ const index = preMessages.findIndex((candidate) => candidate.recipientUserId === expected.recipientUserId &&
371
+ candidate.recipientDeviceId === expected.recipientDeviceId);
372
+ if (index < 0 || JSON.stringify(preMessages[index]) !== JSON.stringify(expected)) {
373
+ throw new Error('Cannot replace an unexpected group pre-message');
374
+ }
375
+ if (replacement.recipientUserId !== expected.recipientUserId ||
376
+ replacement.recipientDeviceId !== expected.recipientDeviceId ||
377
+ replacement.timestamp !== expected.timestamp) {
378
+ throw new Error('A group pre-message replacement cannot change its target or timestamp');
379
+ }
380
+ preMessages[index] = cloneReliabilityValue(replacement);
381
+ }
382
+ await store.setMetadata(key, JSON.stringify(existing));
383
+ return cloneReliabilityValue(existing);
384
+ });
385
+ }
190
386
  /**
191
387
  * Apply the recipient's device list to a direct intent in one write: remove
192
388
  * the messages of the devices that the list no longer shows, append a message
@@ -218,6 +414,25 @@ export async function reconcileOutgoingDirectDeviceMessages(store, clientMessage
218
414
  return cloneReliabilityValue(existing);
219
415
  });
220
416
  }
417
+ /**
418
+ * Change the sync copies of a direct or group intent in one write. The sync
419
+ * copies of each removed own device leave the intent first. Then each new
420
+ * sync copy is appended. A new copy for a device that still has a copy must
421
+ * be equal to it, and is not appended again. A completed intent accepts the
422
+ * change only while its sync phase is pending.
423
+ */
424
+ export async function reconcileOutgoingSyncMessages(store, clientMessageId, removedDeviceIds, additions) {
425
+ return serializeMutation(store, async () => {
426
+ const key = recordKey('outbox', clientMessageId);
427
+ const existing = parseJson(await store.getMetadata(key), null);
428
+ if (!existing || (existing.result && !existing.syncPending)) {
429
+ throw new Error('Cannot change the sync copies of a missing or completed outbox intent');
430
+ }
431
+ existing.syncMessages = appendOutgoingDeviceMessages(existing.syncMessages.filter((message) => !removedDeviceIds.includes(message.recipientDeviceId)), additions, 'Cannot replace a persisted sync transmission');
432
+ await store.setMetadata(key, JSON.stringify(existing));
433
+ return cloneReliabilityValue(existing);
434
+ });
435
+ }
221
436
  export async function replaceOutgoingDirectDeviceMessage(store, clientMessageId, expected, replacement) {
222
437
  return serializeMutation(store, async () => {
223
438
  const key = recordKey('outbox', clientMessageId);
@@ -314,7 +529,14 @@ export async function updateDeliveryStatus(store, clientMessageId, update, now =
314
529
  return value;
315
530
  });
316
531
  }
317
- export async function completeOutgoingMessageIntent(store, clientMessageId, result) {
532
+ /**
533
+ * Complete an outgoing intent with its Relay result. With `syncPending`,
534
+ * the recipient phase completed and the sync phase did not: the intent keeps
535
+ * its sync messages and the restart count of its sync phase, so a replay
536
+ * posts only the sync messages. With `syncPending` and no sync messages, the
537
+ * read of the own device list failed, and a replay reads it.
538
+ */
539
+ export async function completeOutgoingMessageIntent(store, clientMessageId, result, options = {}) {
318
540
  await serializeMutation(store, async () => {
319
541
  const key = recordKey('outbox', clientMessageId);
320
542
  const existing = parseJson(await store.getMetadata(key), null);
@@ -327,7 +549,28 @@ export async function completeOutgoingMessageIntent(store, clientMessageId, resu
327
549
  delete existing.reconcilePending;
328
550
  delete existing.preMessages;
329
551
  existing.deviceMessages = [];
330
- existing.syncMessages = [];
552
+ if (options.syncPending) {
553
+ existing.syncPending = true;
554
+ const sync = existing.deviceSetRestarts?.sync;
555
+ if (sync === undefined)
556
+ delete existing.deviceSetRestarts;
557
+ else
558
+ existing.deviceSetRestarts = { sync };
559
+ if (existing.deviceSetUnresolved?.phase !== 'sync')
560
+ delete existing.deviceSetUnresolved;
561
+ const syncMissing = existing.deviceSetBundleMissing?.sync;
562
+ if (syncMissing)
563
+ existing.deviceSetBundleMissing = { sync: syncMissing };
564
+ else
565
+ delete existing.deviceSetBundleMissing;
566
+ }
567
+ else {
568
+ existing.syncMessages = [];
569
+ delete existing.syncPending;
570
+ delete existing.deviceSetRestarts;
571
+ delete existing.deviceSetUnresolved;
572
+ delete existing.deviceSetBundleMissing;
573
+ }
331
574
  delete existing.sealedSenderAuth;
332
575
  delete existing.groupCiphertext;
333
576
  delete existing.groupSenderKeyDistributionId;
@@ -337,7 +580,9 @@ export async function completeOutgoingMessageIntent(store, clientMessageId, resu
337
580
  }
338
581
  /** The lifetime of one processed-envelope record. */
339
582
  function processedEnvelopeTtl(record) {
340
- return record.fulfilled ? RETRY_REQUESTER_RECORD_TTL_MS : RELIABILITY_RECORD_TTL_MS;
583
+ return record.fulfilled || record.completed
584
+ ? RETRY_REQUESTER_RECORD_TTL_MS
585
+ : RELIABILITY_RECORD_TTL_MS;
341
586
  }
342
587
  /**
343
588
  * The time that the incoming ledger indexes one record at. The ledger
@@ -351,16 +596,20 @@ async function readProcessedEnvelope(store, envelopeId) {
351
596
  const value = await store.getMetadata(recordKey('incoming', envelopeId));
352
597
  if (value === null)
353
598
  return null;
354
- const { processedAt, fingerprint, fulfilled } = JSON.parse(value);
599
+ const { processedAt, fingerprint, fulfilled, completed, outcome } = JSON.parse(value);
355
600
  if (!Number.isFinite(processedAt) ||
356
601
  (fingerprint !== undefined && typeof fingerprint !== 'string') ||
357
- (fulfilled !== undefined && fulfilled !== true)) {
602
+ (fulfilled !== undefined && fulfilled !== true) ||
603
+ (completed !== undefined && completed !== true) ||
604
+ (outcome !== undefined && outcome !== 'denied' && outcome !== 'expired')) {
358
605
  throw new Error('Corrupt processed-envelope record');
359
606
  }
360
607
  return {
361
608
  processedAt,
362
609
  ...(fingerprint !== undefined && { fingerprint }),
363
610
  ...(fulfilled === true && { fulfilled }),
611
+ ...(completed === true && { completed }),
612
+ ...(outcome !== undefined && { outcome }),
364
613
  };
365
614
  }
366
615
  /**
@@ -385,7 +634,7 @@ export async function hasProcessedEnvelope(store, envelopeId, now = Date.now())
385
634
  }
386
635
  /**
387
636
  * Record that the local device processed one envelope ID. The write keeps
388
- * the fingerprint and the fulfilled flag of a record that counts, so a
637
+ * the fingerprint, the flags, and the outcome of a record that counts, so a
389
638
  * later store for the same ID never clears them.
390
639
  *
391
640
  * @param fulfilled - True when the application got the content of this
@@ -393,28 +642,75 @@ export async function hasProcessedEnvelope(store, envelopeId, now = Date.now())
393
642
  * one write.
394
643
  */
395
644
  export async function storeProcessedEnvelope(store, envelopeId, processedAt = Date.now(), fingerprint, fulfilled) {
645
+ await serializeMutation(store, () => writeProcessedEnvelope(store, processedAt, {
646
+ envelopeId,
647
+ ...(fingerprint !== undefined && { fingerprint }),
648
+ ...(fulfilled && { fulfilled }),
649
+ }));
650
+ }
651
+ /**
652
+ * Write several processed-envelope records in one turn of the mutation
653
+ * queue. A denial with no receive record uses it: the denied outcome and
654
+ * the processed fact of the envelope land together.
655
+ */
656
+ export async function writeProcessedEnvelopes(store, writes, processedAt = Date.now()) {
396
657
  await serializeMutation(store, async () => {
397
- const existing = await readProcessedEnvelope(store, envelopeId);
398
- const current = existing && existing.processedAt >= processedAt - processedEnvelopeTtl(existing)
399
- ? existing
400
- : null;
401
- const keptFingerprint = fingerprint ?? current?.fingerprint;
402
- const record = {
403
- processedAt,
404
- ...(keptFingerprint !== undefined && { fingerprint: keptFingerprint }),
405
- ...((fulfilled || current?.fulfilled) && { fulfilled: true }),
406
- };
407
- const indexTime = processedEnvelopeIndexTime(record);
408
- const retainedDays = await pruneExpiredBuckets(store, 'incoming', processedAt);
409
- await store.setMetadata(recordKey('incoming', envelopeId), JSON.stringify(record));
410
- await indexRecord(store, 'incoming', envelopeId, indexTime, retainedDays);
411
- // The bucket of the earlier record would prune the new record early.
412
- if (existing) {
413
- const existingIndexTime = processedEnvelopeIndexTime(existing);
414
- if (dayFor(existingIndexTime) !== dayFor(indexTime)) {
415
- await unindexRecord(store, 'incoming', envelopeId, existingIndexTime);
416
- }
658
+ for (const write of writes)
659
+ await writeProcessedEnvelope(store, processedAt, write);
660
+ });
661
+ }
662
+ /** Write one processed-envelope record. The caller holds the mutation queue. */
663
+ async function writeProcessedEnvelope(store, processedAt, write) {
664
+ const { envelopeId } = write;
665
+ const existing = await readProcessedEnvelope(store, envelopeId);
666
+ const current = existing && existing.processedAt >= processedAt - processedEnvelopeTtl(existing)
667
+ ? existing
668
+ : null;
669
+ const keptFingerprint = write.fingerprint ?? current?.fingerprint;
670
+ const keptOutcome = write.outcome ?? current?.outcome;
671
+ const record = {
672
+ processedAt,
673
+ ...(keptFingerprint !== undefined && { fingerprint: keptFingerprint }),
674
+ ...((write.fulfilled || current?.fulfilled) && { fulfilled: true }),
675
+ ...((write.completed || current?.completed) && { completed: true }),
676
+ ...(keptOutcome !== undefined && { outcome: keptOutcome }),
677
+ };
678
+ const indexTime = processedEnvelopeIndexTime(record);
679
+ const retainedDays = await pruneExpiredBuckets(store, 'incoming', processedAt);
680
+ await store.setMetadata(recordKey('incoming', envelopeId), JSON.stringify(record));
681
+ await indexRecord(store, 'incoming', envelopeId, indexTime, retainedDays);
682
+ // The bucket of the earlier record would prune the new record early.
683
+ if (existing) {
684
+ const existingIndexTime = processedEnvelopeIndexTime(existing);
685
+ if (dayFor(existingIndexTime) !== dayFor(indexTime)) {
686
+ await unindexRecord(store, 'incoming', envelopeId, existingIndexTime);
417
687
  }
688
+ }
689
+ }
690
+ /**
691
+ * Complete one receive record: delete it and write its processed-envelope
692
+ * records in one atomic store write. The writes run against a buffer over
693
+ * the store, so the ledger index and the records commit with the delete or
694
+ * not at all.
695
+ *
696
+ * @returns False, with nothing written, when the stored revision of the
697
+ * receive record is not `expectedRevision`.
698
+ */
699
+ export async function completeReceiveRecord(store, workId, expectedRevision, writes, processedAt = Date.now()) {
700
+ return serializeMutation(store, async () => {
701
+ const buffer = new Map();
702
+ const buffered = {
703
+ getMetadata: async (key) => (buffer.has(key) ? buffer.get(key) : store.getMetadata(key)),
704
+ setMetadata: async (key, value) => {
705
+ buffer.set(key, value);
706
+ },
707
+ deleteMetadata: async (key) => {
708
+ buffer.set(key, null);
709
+ },
710
+ };
711
+ for (const write of writes)
712
+ await writeProcessedEnvelope(buffered, processedAt, write);
713
+ return store.completeReceiveWork(workId, expectedRevision, [...buffer].map(([key, value]) => ({ key, value })));
418
714
  });
419
715
  }
420
716
  /**
@@ -539,13 +835,17 @@ export async function resolveRetryFamilyMember(store, envelopeId, now = Date.now
539
835
  return undefined;
540
836
  return { retryId: member.retryId, failedEnvelopeId, kind: member.kind, attempt: member.attempt };
541
837
  }
838
+ /** The shortest time between two session reset null messages to one device. */
839
+ export const RETRY_TERMINAL_NULL_MESSAGE_INTERVAL_MS = 60 * 60 * 1_000;
542
840
  const RETRY_TERMINAL_CLASSES = new Set([
543
841
  'missing-sender',
544
842
  'missing-prekey',
545
843
  'revoked-authority',
546
844
  'expired-content',
845
+ 'attempts-exhausted',
547
846
  'deletion',
548
847
  'abuse-allowance-exhausted',
848
+ 'membership-refused',
549
849
  ]);
550
850
  function isRetryTerminal(value) {
551
851
  if (value === null || typeof value !== 'object')
@@ -556,6 +856,22 @@ function isRetryTerminal(value) {
556
856
  Number.isFinite(terminal.at) &&
557
857
  typeof terminal.emitted === 'boolean');
558
858
  }
859
+ function isRetryTerminalRecovery(value) {
860
+ if (value === null || typeof value !== 'object')
861
+ return false;
862
+ const recovery = value;
863
+ const nullMessage = recovery.nullMessage;
864
+ return (typeof recovery.userId === 'string' &&
865
+ Number.isSafeInteger(recovery.deviceId) &&
866
+ (recovery.senderKey === 'applied' || recovery.senderKey === 'skipped') &&
867
+ (nullMessage === undefined ||
868
+ (typeof nullMessage === 'object' &&
869
+ nullMessage !== null &&
870
+ (nullMessage.outcome === 'sent' ||
871
+ nullMessage.outcome === 'limited' ||
872
+ nullMessage.outcome === 'failed') &&
873
+ Number.isFinite(nullMessage.at))));
874
+ }
559
875
  /**
560
876
  * Get the stored retry request for one failed envelope. A record older than
561
877
  * `RETRY_REQUESTER_RECORD_TTL_MS` does not count.
@@ -579,7 +895,16 @@ export async function getRetryRequest(store, failedEnvelopeId, now = Date.now(),
579
895
  record.lastFailureClass !== 'transport-outage' &&
580
896
  record.lastFailureClass !== 'rate-refusal') ||
581
897
  (record.terminal !== undefined && !isRetryTerminal(record.terminal)) ||
582
- (record.envelope === undefined && record.terminal === undefined)) {
898
+ (record.envelope === undefined && record.terminal === undefined) ||
899
+ (record.receivedAt !== undefined && !Number.isFinite(record.receivedAt)) ||
900
+ (record.errorShown !== undefined && typeof record.errorShown !== 'boolean') ||
901
+ (record.recoveredEmitted !== undefined && typeof record.recoveredEmitted !== 'boolean') ||
902
+ (record.groupId !== undefined && (typeof record.groupId !== 'string' || !record.groupId)) ||
903
+ (record.failedSender !== undefined &&
904
+ (typeof record.failedSender?.userId !== 'string' ||
905
+ !Number.isSafeInteger(record.failedSender.deviceId))) ||
906
+ (record.recovery !== undefined &&
907
+ (record.terminal?.class !== 'expired-content' || !isRetryTerminalRecovery(record.recovery)))) {
583
908
  throw new Error('Corrupt retry-request record');
584
909
  }
585
910
  if (record.requestedAt < now - RETRY_REQUESTER_RECORD_TTL_MS)