@open-e2ee/signal-protocol-sdk 11.0.0 → 12.0.1

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 (590) hide show
  1. package/ADAPTERS.md +4 -4
  2. package/ARCHITECTURE.md +6 -8
  3. package/CHANGELOG.md +1348 -0
  4. package/README.md +1 -1
  5. package/SECURITY.md +2 -2
  6. package/TROUBLESHOOTING.md +8 -8
  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 +1175 -186
  12. package/dist/client/client.js.map +1 -1
  13. package/dist/client/config.d.ts +57 -42
  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 +26 -20
  251. package/dist/internal/manager/manager.d.ts.map +1 -1
  252. package/dist/internal/manager/manager.js +64 -41
  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 +15 -13
  313. package/dist/internal/session/cipher.d.ts.map +1 -1
  314. package/dist/internal/session/cipher.js +41 -23
  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 +5 -13
  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/driver.d.ts +9 -0
  416. package/dist/local/store/sqlite/driver.d.ts.map +1 -1
  417. package/dist/local/store/sqlite/encryption.d.ts +8 -1
  418. package/dist/local/store/sqlite/encryption.d.ts.map +1 -1
  419. package/dist/local/store/sqlite/encryption.js +9 -0
  420. package/dist/local/store/sqlite/encryption.js.map +1 -1
  421. package/dist/local/store/sqlite/key-storage/index.d.ts +25 -4
  422. package/dist/local/store/sqlite/key-storage/index.d.ts.map +1 -1
  423. package/dist/local/store/sqlite/key-storage/index.js +68 -7
  424. package/dist/local/store/sqlite/key-storage/index.js.map +1 -1
  425. package/dist/local/store/sqlite/key-storage/message-records.d.ts +16 -4
  426. package/dist/local/store/sqlite/key-storage/message-records.d.ts.map +1 -1
  427. package/dist/local/store/sqlite/key-storage/message-records.js +49 -6
  428. package/dist/local/store/sqlite/key-storage/message-records.js.map +1 -1
  429. package/dist/local/store/sqlite/key-storage/metadata.d.ts +8 -7
  430. package/dist/local/store/sqlite/key-storage/metadata.d.ts.map +1 -1
  431. package/dist/local/store/sqlite/key-storage/metadata.js +17 -15
  432. package/dist/local/store/sqlite/key-storage/metadata.js.map +1 -1
  433. package/dist/local/store/sqlite/key-storage/receive-work.d.ts +27 -0
  434. package/dist/local/store/sqlite/key-storage/receive-work.d.ts.map +1 -0
  435. package/dist/local/store/sqlite/key-storage/receive-work.js +98 -0
  436. package/dist/local/store/sqlite/key-storage/receive-work.js.map +1 -0
  437. package/dist/local/store/sqlite/key-storage/send-log.d.ts +27 -0
  438. package/dist/local/store/sqlite/key-storage/send-log.d.ts.map +1 -0
  439. package/dist/local/store/sqlite/key-storage/send-log.js +178 -0
  440. package/dist/local/store/sqlite/key-storage/send-log.js.map +1 -0
  441. package/dist/local/store/sqlite/key-storage/sender-key-handoff.d.ts +27 -0
  442. package/dist/local/store/sqlite/key-storage/sender-key-handoff.d.ts.map +1 -0
  443. package/dist/local/store/sqlite/key-storage/sender-key-handoff.js +75 -0
  444. package/dist/local/store/sqlite/key-storage/sender-key-handoff.js.map +1 -0
  445. package/dist/local/store/sqlite/key-storage/session-trust.d.ts +2 -2
  446. package/dist/local/store/sqlite/key-storage/session-trust.js +5 -5
  447. package/dist/local/store/sqlite/key-storage/session-trust.js.map +1 -1
  448. package/dist/local/store/sqlite/migrations.d.ts.map +1 -1
  449. package/dist/local/store/sqlite/migrations.js +101 -0
  450. package/dist/local/store/sqlite/migrations.js.map +1 -1
  451. package/dist/local/store/sqlite/models/index.d.ts +2 -1
  452. package/dist/local/store/sqlite/models/index.d.ts.map +1 -1
  453. package/dist/local/store/sqlite/models/index.js +5 -1
  454. package/dist/local/store/sqlite/models/index.js.map +1 -1
  455. package/dist/local/store/sqlite/models/message-record.d.ts +15 -0
  456. package/dist/local/store/sqlite/models/message-record.d.ts.map +1 -1
  457. package/dist/local/store/sqlite/models/message-record.js +24 -0
  458. package/dist/local/store/sqlite/models/message-record.js.map +1 -1
  459. package/dist/local/store/sqlite/models/send-log.d.ts +51 -0
  460. package/dist/local/store/sqlite/models/send-log.d.ts.map +1 -0
  461. package/dist/local/store/sqlite/models/send-log.js +206 -0
  462. package/dist/local/store/sqlite/models/send-log.js.map +1 -0
  463. package/dist/local/store/sqlite/open-store.d.ts +9 -1
  464. package/dist/local/store/sqlite/open-store.d.ts.map +1 -1
  465. package/dist/local/store/sqlite/open-store.js +20 -1
  466. package/dist/local/store/sqlite/open-store.js.map +1 -1
  467. package/dist/local/store/sqlite/schema.d.ts +34 -1
  468. package/dist/local/store/sqlite/schema.d.ts.map +1 -1
  469. package/dist/local/store/sqlite/schema.js +14 -0
  470. package/dist/local/store/sqlite/schema.js.map +1 -1
  471. package/dist/local/store/sqlite/store.d.ts +61 -11
  472. package/dist/local/store/sqlite/store.d.ts.map +1 -1
  473. package/dist/local/store/sqlite/store.js +191 -27
  474. package/dist/local/store/sqlite/store.js.map +1 -1
  475. package/dist/local/store/sqlite/web/sqlite3mc/sqlite3.mjs +2 -1
  476. package/dist/local/store/sqlite/web/worker.d.ts +8 -0
  477. package/dist/local/store/sqlite/web/worker.d.ts.map +1 -1
  478. package/dist/local/store/sqlite/web/worker.js +64 -2
  479. package/dist/local/store/sqlite/web/worker.js.map +1 -1
  480. package/dist/local/store/web/adapter.d.ts +76 -8
  481. package/dist/local/store/web/adapter.d.ts.map +1 -1
  482. package/dist/local/store/web/adapter.js +579 -127
  483. package/dist/local/store/web/adapter.js.map +1 -1
  484. package/dist/local/store/web/receive-work.d.ts +57 -0
  485. package/dist/local/store/web/receive-work.d.ts.map +1 -0
  486. package/dist/local/store/web/receive-work.js +99 -0
  487. package/dist/local/store/web/receive-work.js.map +1 -0
  488. package/dist/local/store/web/send-log.d.ts +92 -0
  489. package/dist/local/store/web/send-log.d.ts.map +1 -0
  490. package/dist/local/store/web/send-log.js +267 -0
  491. package/dist/local/store/web/send-log.js.map +1 -0
  492. package/dist/local/store/web/sender-key-handoff.d.ts +81 -0
  493. package/dist/local/store/web/sender-key-handoff.d.ts.map +1 -0
  494. package/dist/local/store/web/sender-key-handoff.js +156 -0
  495. package/dist/local/store/web/sender-key-handoff.js.map +1 -0
  496. package/dist/local/store/web-sqlite/adapter.d.ts +2 -0
  497. package/dist/local/store/web-sqlite/adapter.d.ts.map +1 -1
  498. package/dist/local/store/web-sqlite/adapter.js +12 -6
  499. package/dist/local/store/web-sqlite/adapter.js.map +1 -1
  500. package/dist/local/vault/custody.d.ts +8 -0
  501. package/dist/local/vault/custody.d.ts.map +1 -0
  502. package/dist/local/vault/custody.js +9 -0
  503. package/dist/local/vault/custody.js.map +1 -0
  504. package/dist/local/vault/electron-safe-storage.d.ts +3 -1
  505. package/dist/local/vault/electron-safe-storage.d.ts.map +1 -1
  506. package/dist/local/vault/electron-safe-storage.js +2 -0
  507. package/dist/local/vault/electron-safe-storage.js.map +1 -1
  508. package/dist/local/vault/expo-secure-store.d.ts +3 -1
  509. package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
  510. package/dist/local/vault/expo-secure-store.js +2 -0
  511. package/dist/local/vault/expo-secure-store.js.map +1 -1
  512. package/dist/local/vault/indexed-db.d.ts +3 -1
  513. package/dist/local/vault/indexed-db.d.ts.map +1 -1
  514. package/dist/local/vault/indexed-db.js +2 -0
  515. package/dist/local/vault/indexed-db.js.map +1 -1
  516. package/dist/local/vault/react-native-keychain.d.ts +3 -1
  517. package/dist/local/vault/react-native-keychain.d.ts.map +1 -1
  518. package/dist/local/vault/react-native-keychain.js +2 -0
  519. package/dist/local/vault/react-native-keychain.js.map +1 -1
  520. package/dist/remote/relay/device-set.d.ts +94 -0
  521. package/dist/remote/relay/device-set.d.ts.map +1 -0
  522. package/dist/remote/relay/device-set.js +156 -0
  523. package/dist/remote/relay/device-set.js.map +1 -0
  524. package/dist/remote/relay/types.d.ts +92 -107
  525. package/dist/remote/relay/types.d.ts.map +1 -1
  526. package/dist/safety/core.d.ts +15 -6
  527. package/dist/safety/core.d.ts.map +1 -1
  528. package/dist/safety/core.js +41 -27
  529. package/dist/safety/core.js.map +1 -1
  530. package/dist/safety/index.d.ts +2 -1
  531. package/dist/safety/index.d.ts.map +1 -1
  532. package/dist/safety/index.js +12 -18
  533. package/dist/safety/index.js.map +1 -1
  534. package/dist/types/api.d.ts +707 -62
  535. package/dist/types/api.d.ts.map +1 -1
  536. package/dist/types/errors.d.ts +14 -33
  537. package/dist/types/errors.d.ts.map +1 -1
  538. package/dist/types/errors.js +14 -24
  539. package/dist/types/errors.js.map +1 -1
  540. package/dist/types/messages.d.ts +2 -2
  541. package/dist/types/messages.js +1 -1
  542. package/dist/types/protocol-config.d.ts +175 -42
  543. package/dist/types/protocol-config.d.ts.map +1 -1
  544. package/dist/types/protocol-config.js +19 -38
  545. package/dist/types/protocol-config.js.map +1 -1
  546. package/dist/types/protocol-constants.d.ts +6 -6
  547. package/dist/types/protocol-constants.js +6 -6
  548. package/dist/types/session.d.ts +7 -7
  549. package/dist/types/session.d.ts.map +1 -1
  550. package/dist/types/session.js +39 -21
  551. package/dist/types/session.js.map +1 -1
  552. package/dist/username/link.d.ts +2 -2
  553. package/dist/username/link.js +2 -2
  554. package/dist/utils/origin-lock.d.ts +45 -0
  555. package/dist/utils/origin-lock.d.ts.map +1 -0
  556. package/dist/utils/origin-lock.js +80 -0
  557. package/dist/utils/origin-lock.js.map +1 -0
  558. package/docs/ASSURANCE.md +6 -6
  559. package/docs/CLIENT_COMPOSITION.md +2 -2
  560. package/docs/DEVIATIONS.md +677 -182
  561. package/docs/E2EE.md +1 -1
  562. package/docs/ERROR_HANDLING.md +165 -2
  563. package/docs/GETTING_STARTED.md +7 -4
  564. package/docs/INTERFACES.md +1 -1
  565. package/docs/PACKAGE_SURFACE.md +6 -5
  566. package/docs/PROTOCOL_POLICY.md +102 -22
  567. package/docs/RECIPES.md +3 -15
  568. package/docs/SECURITY.md +90 -5
  569. package/keys/README.md +3 -3
  570. package/local/store/README.md +78 -14
  571. package/local/store/key-value/README.md +14 -3
  572. package/local/store/node/README.md +8 -3
  573. package/local/store/web/README.md +9 -0
  574. package/local/store/web-sqlite/README.md +14 -2
  575. package/local/vault/README.md +21 -0
  576. package/package.json +1 -6
  577. package/remote/README.md +0 -1
  578. package/remote/relay/README.md +2 -2
  579. package/dist/device/provisioning.d.ts +0 -242
  580. package/dist/device/provisioning.d.ts.map +0 -1
  581. package/dist/device/provisioning.js +0 -421
  582. package/dist/device/provisioning.js.map +0 -1
  583. package/dist/internal/protocol/x3dh/index.d.ts +0 -15
  584. package/dist/internal/protocol/x3dh/index.d.ts.map +0 -1
  585. package/dist/internal/protocol/x3dh/index.js +0 -13
  586. package/dist/internal/protocol/x3dh/index.js.map +0 -1
  587. package/dist/internal/protocol/x3dh/x3dh.d.ts +0 -131
  588. package/dist/internal/protocol/x3dh/x3dh.d.ts.map +0 -1
  589. package/dist/internal/protocol/x3dh/x3dh.js +0 -261
  590. package/dist/internal/protocol/x3dh/x3dh.js.map +0 -1
@@ -1,16 +1,82 @@
1
1
  import type { SignalProtocolLocalStore } from '../types/index.js';
2
+ import { ContentHint } from '../types/messages.js';
2
3
  import type { GroupMemberDevice, SignalProtocolRelayServer, SealedSenderAuth } from '../remote/relay/types.js';
3
4
  import { type StoredOutgoingDeviceMessage, type StoredOutgoingMessageIntent } from '../local/store/reliability.js';
5
+ import { type DeviceSetAccountRepair, type DeviceSetDevice, type DeviceSetUnresolved, type DeclaredPostReceipt, type DeclaredSyncOutcome } from './device-set-reconciliation.js';
4
6
  import type { SendOptions, SendResult } from './types.js';
5
7
  import { type RelayPostAcceptance } from './relay-acceptance.js';
6
8
  /** The relay phases of a group send, in their order. */
7
9
  export type GroupSendPhase = 'pre-message' | 'device' | 'sync';
10
+ /** The transport of one sender-key pre-message for one dispatch. */
11
+ export interface PreMessageTransport {
12
+ /** The pre-message as the intent stores it. */
13
+ message: StoredOutgoingDeviceMessage;
14
+ /** The sealed-sender authorization of the post. Absent for an identified post. */
15
+ auth?: SealedSenderAuth;
16
+ }
17
+ /**
18
+ * The pre-message of one post, and whether the Relay accepted it, the send
19
+ * dropped it, or the send dropped it because the device list no longer shows
20
+ * the device.
21
+ */
22
+ export interface PreMessagePostResult {
23
+ message: StoredOutgoingDeviceMessage;
24
+ outcome: 'accepted' | 'dropped' | 'removed';
25
+ /**
26
+ * True when a repair in the post refreshed the session of the device. The
27
+ * stored device message of the send then names the earlier registration.
28
+ */
29
+ refreshed?: boolean;
30
+ }
31
+ /**
32
+ * The work of a group send on a relay that compares device sets (§5.5 of the
33
+ * device-set contract). The cipher gives it only for such a relay.
34
+ */
35
+ export interface GroupDeviceSetContext {
36
+ /**
37
+ * Repair the refused devices of one account in the repair turn of the
38
+ * account. `postedRegistration` gives the registration that the refused
39
+ * post named for a device. `unposted` is true when the pass refused the
40
+ * account here, because each of its stored devices lacked a bundle. Then a
41
+ * device that still has no bundle leaves the send, and each other device
42
+ * that the account record still holds is ready when it has a session or a
43
+ * bundle. An account left with no device record gets one list read. Resolves to
44
+ * the devices that leave the send, the refreshed or added devices that
45
+ * have a current session, and the devices that got no session.
46
+ */
47
+ repairDevices(repair: DeviceSetAccountRepair, postedRegistration: (device: DeviceSetDevice) => number | undefined, unposted: boolean): Promise<{
48
+ removed: DeviceSetDevice[];
49
+ ready: DeviceSetDevice[];
50
+ bundleMissing: DeviceSetDevice[];
51
+ }>;
52
+ /** Read the own device list, for a receipt that sets `needsSync` when no own device has a record. */
53
+ readOwnDevices(): Promise<GroupMemberDevice[]>;
54
+ /**
55
+ * Run the declared sync phase of a completed intent. A failure or an
56
+ * unresolved end is logged and leaves the phase pending. The outcome keeps
57
+ * the receipt of each accepted sync post, also when the phase fails.
58
+ */
59
+ runSyncPhase(intent: StoredOutgoingMessageIntent, rebuild: (device: DeviceSetDevice) => Promise<StoredOutgoingDeviceMessage | undefined>): Promise<DeclaredSyncOutcome>;
60
+ /** Record the terminal state of the recipient phase. */
61
+ unresolve(clientMessageId: string, unresolved: DeviceSetUnresolved): Promise<void>;
62
+ /** Wait before the next pass. Rejects when the send stops. */
63
+ wait(milliseconds: number): Promise<void>;
64
+ /** Log a failed post of a pass that does not decide the phase. */
65
+ logFailure(device: DeviceSetDevice, error: unknown): void;
66
+ /** Log a failure that does not fail the send. */
67
+ warn(message: string, error: unknown): void;
68
+ /**
69
+ * Mark a result whose relay accepted a declared post without the
70
+ * `deviceSetChecked` mark. The result does not change otherwise.
71
+ */
72
+ markUnchecked<T extends object>(result: T, receipts: readonly DeclaredPostReceipt[], clientMessageId: string): T;
73
+ }
8
74
  /**
9
75
  * The work of one group send.
10
76
  *
11
77
  * The phases of a send run in order, with a barrier between phases: the
12
- * pre-messages, then the sender-key confirmation, then the group message and
13
- * its device posts, then the sync copies. Inside a phase, the items run at the
78
+ * pre-messages and their handoff rows, then the group message and its device
79
+ * posts, then the sync copies. Inside a phase, the items run at the
14
80
  * same time. Each relay request takes a slot of the client's relay request
15
81
  * bound, and a phase holds no slot.
16
82
  */
@@ -21,9 +87,10 @@ export interface GroupOutboxContext {
21
87
  senderDeviceId: number;
22
88
  deliveryMode: 'preferred' | 'required' | 'disabled';
23
89
  /**
24
- * Prepare the sender-key payload. When a sender-key distribution is
25
- * pending, the preparation gets the member devices from readMembers, so the
26
- * send reads each member's device list once.
90
+ * Prepare the sender-key payload and a distribution pre-message for each
91
+ * member device that needs the current key. The preparation gets the
92
+ * member devices from readMembers, so the send reads each member's device
93
+ * list once.
27
94
  */
28
95
  preparePayload(groupId: string, plaintextBytes: Uint8Array, options: SendOptions & {
29
96
  clientMessageId: string;
@@ -33,18 +100,108 @@ export interface GroupOutboxContext {
33
100
  preMessages: StoredOutgoingDeviceMessage[];
34
101
  senderKeyDistributionId?: string;
35
102
  }>;
36
- confirmSenderKeyDistributionSent(groupId: string, senderKeyId: string): Promise<void>;
103
+ /**
104
+ * Record the handoff row of a pre-message that the Relay accepted. It runs
105
+ * after the acceptance and before the intent confirms the pre-message.
106
+ */
107
+ recordSenderKeyHandoff(groupId: string, message: StoredOutgoingDeviceMessage): Promise<void>;
108
+ /**
109
+ * The content of a new send as the group gets it: with the group context
110
+ * of a managed group in it, or unchanged. The payload, the sent-sync
111
+ * transcript, and the send log entry all carry the result.
112
+ */
113
+ prepareContent(groupId: string, plaintextBytes: Uint8Array): Promise<Uint8Array>;
37
114
  resolveMemberDevices(groupId: string, options: SendOptions & {
38
115
  clientMessageId: string;
39
116
  }): Promise<GroupMemberDevice[]>;
40
- prepareSharedMessage(groupId: string, members: GroupMemberDevice[], ciphertext: string): Promise<StoredOutgoingMessageIntent['groupSharedMessage']>;
41
- prepareDeviceMessage(member: GroupMemberDevice, groupId: string, ciphertext: string, timestamp: number): Promise<StoredOutgoingDeviceMessage>;
42
- prepareSyncMessages(groupId: string, plaintextBytes: Uint8Array, timestamp: number, clientMessageId: string): Promise<StoredOutgoingDeviceMessage[]>;
117
+ /** Seal the group message for every member with a known identity. The seal carries the hint. */
118
+ prepareSharedMessage(groupId: string, members: GroupMemberDevice[], ciphertext: string, contentHint: ContentHint | undefined): Promise<StoredOutgoingMessageIntent['groupSharedMessage']>;
119
+ /** Prepare the group message for one device. A sealed copy carries the hint. */
120
+ prepareDeviceMessage(member: GroupMemberDevice, groupId: string, ciphertext: string, timestamp: number, contentHint: ContentHint | undefined): Promise<StoredOutgoingDeviceMessage>;
121
+ /**
122
+ * Read the device list of the sender's own account. Each listed own device
123
+ * other than the sending device gets a session first, and each own device
124
+ * record that the list does not show is removed. Resolves to the listed own
125
+ * devices other than the sending device.
126
+ */
127
+ resolveOwnDevices(): Promise<GroupMemberDevice[]>;
128
+ /** Prepare a sent-sync transcript of the content for each device in `ownDevices`. */
129
+ prepareSyncMessages(groupId: string, plaintextBytes: Uint8Array, timestamp: number, clientMessageId: string, ownDevices: readonly GroupMemberDevice[]): Promise<StoredOutgoingDeviceMessage[]>;
43
130
  resolveGroupAuthorization(groupId: string, recipientUserIds: string[]): Promise<Extract<SealedSenderAuth, {
44
131
  type: 'groupSendToken';
45
132
  }> | null>;
46
133
  reportIdentifiedFallback(recipientUserId: string): Promise<void>;
47
- sendPreparedSealedDevice(intent: StoredOutgoingMessageIntent, message: StoredOutgoingDeviceMessage, auth: SealedSenderAuth): Promise<RelayPostAcceptance>;
134
+ /**
135
+ * Refresh the group's endorsements for the recipients of a dispatch before
136
+ * its pre-messages resolve their transports. A membership change clears
137
+ * the endorsements, and a pre-message to a member with no access key needs
138
+ * one to stay sealed.
139
+ */
140
+ refreshPreMessageEndorsements(groupId: string, recipientUserIds: string[]): Promise<void>;
141
+ /**
142
+ * Resolve the transport of one stored pre-message before any post of the
143
+ * dispatch. A pre-message with no sealed transport is sealed from its
144
+ * stored ciphertext, with no new ratchet effect. When `required` is true
145
+ * and the pre-message cannot be sealed, it throws SEALED_SENDER_REQUIRED.
146
+ */
147
+ authorizePreMessage(groupId: string, message: StoredOutgoingDeviceMessage, required: boolean): Promise<PreMessageTransport>;
148
+ /**
149
+ * Post one pre-message. A rejected access key falls back to the group
150
+ * endorsement. A preferred sealed post goes identified only after each
151
+ * sealed authorization is rejected. A conclusive refusal of the device
152
+ * refreshes its session once, and the repair replaces the stored
153
+ * pre-message before it posts. A NOT_FOUND refusal of a device that the
154
+ * device list no longer shows removes the device from the send, and the
155
+ * result names no refresh. Resolves to the pre-message that the relay
156
+ * accepted or that the send dropped, with the outcome.
157
+ */
158
+ postPreMessage(intent: StoredOutgoingMessageIntent, transport: PreMessageTransport, required: boolean): Promise<PreMessagePostResult>;
159
+ /**
160
+ * The sender-key pre-messages that give the key of the send to the listed
161
+ * devices of other members that have no handoff row. `listed` holds only
162
+ * the devices that can get a pre-message. Three outbox steps call this
163
+ * method. The device additions of a post and the device-list change of a
164
+ * replay pass the complete list of each member that they name. The
165
+ * shared-body leave passes only the leaving devices. The stale-device
166
+ * repair does not call this method: it calls the cipher preparer directly
167
+ * with only the refused device. Each device of such a subset has a
168
+ * session, so the preparation reads no device list. Only the listed
169
+ * devices count for the failure rule. The attempt fails for a member when
170
+ * each listed device of the member that needs the key fails, and no other
171
+ * listed device of the member has the key. A listed device has the key
172
+ * when it has a handoff row, or when a pending pre-message of the send
173
+ * targets it. A failed repair fails by the same rule.
174
+ */
175
+ prepareSenderKeyHandoffs(intent: StoredOutgoingMessageIntent, listed: readonly GroupMemberDevice[]): Promise<StoredOutgoingDeviceMessage[]>;
176
+ /** The registration of the current session of a device, or undefined with no session. */
177
+ remoteRegistrationId(device: GroupMemberDevice): Promise<number | undefined>;
178
+ /** True when the relay refused a one-device post because of its device. */
179
+ isConclusiveDeviceRejection(error: unknown): boolean;
180
+ /**
181
+ * Repair the device of a refused group device post. Resolves to the
182
+ * pre-messages that give the device the key of the send, and to a new
183
+ * device message with the registration of the current session.
184
+ */
185
+ repairStaleDevice(intent: StoredOutgoingMessageIntent, message: StoredOutgoingDeviceMessage): Promise<{
186
+ preMessages: StoredOutgoingDeviceMessage[];
187
+ deviceMessage: StoredOutgoingDeviceMessage;
188
+ }>;
189
+ /**
190
+ * Post one sync copy to an own device. When the relay refuses the device as
191
+ * stale, the session of the device is refreshed once, `rebuild` encrypts
192
+ * the transcript again for the device, the new copy replaces the refused
193
+ * copy in the intent, and the new copy is posted under a repair ID. When
194
+ * the relay refuses the new copy as stale too, the session is archived,
195
+ * the copy leaves the intent, and the post resolves, so the send completes
196
+ * without it. When the refresh fails or the rebuild gives no copy, the
197
+ * post throws, and the copy and the refreshed session stay.
198
+ */
199
+ postSyncMessage(intent: StoredOutgoingMessageIntent, message: StoredOutgoingDeviceMessage, rebuild: (deviceId: number) => Promise<StoredOutgoingDeviceMessage | undefined>): Promise<void>;
200
+ /**
201
+ * Post one sealed device message. With `declaredDeviceIds`, the post
202
+ * declares the devices of its account.
203
+ */
204
+ sendPreparedSealedDevice(intent: StoredOutgoingMessageIntent, message: StoredOutgoingDeviceMessage, auth: SealedSenderAuth, declaredDeviceIds?: readonly number[]): Promise<RelayPostAcceptance>;
48
205
  /**
49
206
  * Run local work for each item at the same time. It rejects after every
50
207
  * item settles, with the error of the first failed item in input order. A
@@ -59,6 +216,11 @@ export interface GroupOutboxContext {
59
216
  sendPhase<R>(messages: readonly StoredOutgoingDeviceMessage[], task: (message: StoredOutgoingDeviceMessage) => Promise<R>, phase: GroupSendPhase): Promise<R[]>;
60
217
  /** Send one relay request of a device post under a slot of the bound. */
61
218
  postToRelay<T>(send: () => Promise<T>, sealed: boolean): Promise<T>;
219
+ /**
220
+ * The declared work of the send. Present only for a relay that compares
221
+ * device sets. Without it, the send keeps the per-send device list reads.
222
+ */
223
+ deviceSets?: GroupDeviceSetContext;
62
224
  }
63
225
  export declare function sendGroupWithExactOutbox(context: GroupOutboxContext, groupId: string, plaintextBytes: Uint8Array, options: SendOptions & {
64
226
  clientMessageId: string;
@@ -1 +1 @@
1
- {"version":3,"file":"group-outbox.d.ts","sourceRoot":"","sources":["../../client/group-outbox.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAC;AAIzD,OAAO,KAAK,EACV,iBAAiB,EACjB,yBAAyB,EACzB,gBAAgB,EACjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAOL,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EACjC,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACvD,OAAO,EAA4B,KAAK,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAExF,wDAAwD;AACxD,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE/D;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,wBAAwB,CAAC;IAClC,KAAK,CAAC,EAAE,yBAAyB,CAAC;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IACpD;;;;OAIG;IACH,cAAc,CACZ,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,UAAU,EAC1B,OAAO,EAAE,WAAW,GAAG;QAAE,eAAe,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,EACrE,WAAW,EAAE,MAAM,OAAO,CAAC,iBAAiB,EAAE,CAAC,GAC9C,OAAO,CAAC;QACT,UAAU,EAAE,MAAM,CAAC;QACnB,WAAW,EAAE,2BAA2B,EAAE,CAAC;QAC3C,uBAAuB,CAAC,EAAE,MAAM,CAAC;KAClC,CAAC,CAAC;IACH,gCAAgC,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtF,oBAAoB,CAClB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,WAAW,GAAG;QAAE,eAAe,EAAE,MAAM,CAAA;KAAE,GACjD,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAChC,oBAAoB,CAClB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,iBAAiB,EAAE,EAC5B,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,2BAA2B,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAC9D,oBAAoB,CAClB,MAAM,EAAE,iBAAiB,EACzB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,2BAA2B,CAAC,CAAC;IACxC,mBAAmB,CACjB,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,UAAU,EAC1B,SAAS,EAAE,MAAM,EACjB,eAAe,EAAE,MAAM,GACtB,OAAO,CAAC,2BAA2B,EAAE,CAAC,CAAC;IAC1C,yBAAyB,CACvB,OAAO,EAAE,MAAM,EACf,gBAAgB,EAAE,MAAM,EAAE,GACzB,OAAO,CAAC,OAAO,CAAC,gBAAgB,EAAE;QAAE,IAAI,EAAE,gBAAgB,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC,CAAC;IACzE,wBAAwB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE,wBAAwB,CACtB,MAAM,EAAE,2BAA2B,EACnC,OAAO,EAAE,2BAA2B,EACpC,IAAI,EAAE,gBAAgB,GACrB,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChC;;;;OAIG;IACH,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IACpF;;;;OAIG;IACH,SAAS,CAAC,CAAC,EACT,QAAQ,EAAE,SAAS,2BAA2B,EAAE,EAChD,IAAI,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,OAAO,CAAC,CAAC,CAAC,EAC1D,KAAK,EAAE,cAAc,GACpB,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAChB,yEAAyE;IACzE,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CACrE;AA6QD,wBAAsB,wBAAwB,CAC5C,OAAO,EAAE,kBAAkB,EAC3B,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,UAAU,EAC1B,OAAO,EAAE,WAAW,GAAG;IAAE,eAAe,EAAE,MAAM,CAAA;CAAE,GACjD,OAAO,CAAC,UAAU,CAAC,CA8ErB"}
1
+ {"version":3,"file":"group-outbox.d.ts","sourceRoot":"","sources":["../../client/group-outbox.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAiB,wBAAwB,EAAE,MAAM,UAAU,CAAC;AAGxE,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,KAAK,EACV,iBAAiB,EACjB,yBAAyB,EACzB,gBAAgB,EACjB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAeL,KAAK,2BAA2B,EAChC,KAAK,2BAA2B,EACjC,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAEL,KAAK,sBAAsB,EAC3B,KAAK,eAAe,EAEpB,KAAK,mBAAmB,EAGxB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACzB,MAAM,6BAA6B,CAAC;AAErC,OAAO,KAAK,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAOvD,OAAO,EAA4B,KAAK,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAExF,wDAAwD;AACxD,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG,QAAQ,GAAG,MAAM,CAAC;AAE/D,oEAAoE;AACpE,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,OAAO,EAAE,2BAA2B,CAAC;IACrC,kFAAkF;IAClF,IAAI,CAAC,EAAE,gBAAgB,CAAC;CACzB;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,2BAA2B,CAAC;IACrC,OAAO,EAAE,UAAU,GAAG,SAAS,GAAG,SAAS,CAAC;IAC5C;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;;;;;OAUG;IACH,aAAa,CACX,MAAM,EAAE,sBAAsB,EAC9B,kBAAkB,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,MAAM,GAAG,SAAS,EACnE,QAAQ,EAAE,OAAO,GAChB,OAAO,CAAC;QACT,OAAO,EAAE,eAAe,EAAE,CAAC;QAC3B,KAAK,EAAE,eAAe,EAAE,CAAC;QACzB,aAAa,EAAE,eAAe,EAAE,CAAC;KAClC,CAAC,CAAC;IACH,qGAAqG;IACrG,cAAc,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAC/C;;;;OAIG;IACH,YAAY,CACV,MAAM,EAAE,2BAA2B,EACnC,OAAO,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAAC,GACrF,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChC,wDAAwD;IACxD,SAAS,CAAC,eAAe,EAAE,MAAM,EAAE,UAAU,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnF,8DAA8D;IAC9D,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1C,kEAAkE;IAClE,UAAU,CAAC,MAAM,EAAE,eAAe,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1D,iDAAiD;IACjD,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5C;;;OAGG;IACH,aAAa,CAAC,CAAC,SAAS,MAAM,EAC5B,MAAM,EAAE,CAAC,EACT,QAAQ,EAAE,SAAS,mBAAmB,EAAE,EACxC,eAAe,EAAE,MAAM,GACtB,CAAC,CAAC;CACN;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,wBAAwB,CAAC;IAClC,KAAK,CAAC,EAAE,yBAAyB,CAAC;IAClC,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC;IACpD;;;;;OAKG;IACH,cAAc,CACZ,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,UAAU,EAC1B,OAAO,EAAE,WAAW,GAAG;QAAE,eAAe,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,EACrE,WAAW,EAAE,MAAM,OAAO,CAAC,iBAAiB,EAAE,CAAC,GAC9C,OAAO,CAAC;QACT,UAAU,EAAE,MAAM,CAAC;QACnB,WAAW,EAAE,2BAA2B,EAAE,CAAC;QAC3C,uBAAuB,CAAC,EAAE,MAAM,CAAC;KAClC,CAAC,CAAC;IACH;;;OAGG;IACH,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,2BAA2B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7F;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACjF,oBAAoB,CAClB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,WAAW,GAAG;QAAE,eAAe,EAAE,MAAM,CAAA;KAAE,GACjD,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAChC,gGAAgG;IAChG,oBAAoB,CAClB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,iBAAiB,EAAE,EAC5B,UAAU,EAAE,MAAM,EAClB,WAAW,EAAE,WAAW,GAAG,SAAS,GACnC,OAAO,CAAC,2BAA2B,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAC9D,gFAAgF;IAChF,oBAAoB,CAClB,MAAM,EAAE,iBAAiB,EACzB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,WAAW,GAAG,SAAS,GACnC,OAAO,CAAC,2BAA2B,CAAC,CAAC;IACxC;;;;;OAKG;IACH,iBAAiB,IAAI,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAClD,qFAAqF;IACrF,mBAAmB,CACjB,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,UAAU,EAC1B,SAAS,EAAE,MAAM,EACjB,eAAe,EAAE,MAAM,EACvB,UAAU,EAAE,SAAS,iBAAiB,EAAE,GACvC,OAAO,CAAC,2BAA2B,EAAE,CAAC,CAAC;IAC1C,yBAAyB,CACvB,OAAO,EAAE,MAAM,EACf,gBAAgB,EAAE,MAAM,EAAE,GACzB,OAAO,CAAC,OAAO,CAAC,gBAAgB,EAAE;QAAE,IAAI,EAAE,gBAAgB,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC,CAAC;IACzE,wBAAwB,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE;;;;;OAKG;IACH,6BAA6B,CAAC,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1F;;;;;OAKG;IACH,mBAAmB,CACjB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,2BAA2B,EACpC,QAAQ,EAAE,OAAO,GAChB,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChC;;;;;;;;;OASG;IACH,cAAc,CACZ,MAAM,EAAE,2BAA2B,EACnC,SAAS,EAAE,mBAAmB,EAC9B,QAAQ,EAAE,OAAO,GAChB,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC;;;;;;;;;;;;;;;OAeG;IACH,wBAAwB,CACtB,MAAM,EAAE,2BAA2B,EACnC,MAAM,EAAE,SAAS,iBAAiB,EAAE,GACnC,OAAO,CAAC,2BAA2B,EAAE,CAAC,CAAC;IAC1C,yFAAyF;IACzF,oBAAoB,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC7E,2EAA2E;IAC3E,2BAA2B,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC;IACrD;;;;OAIG;IACH,iBAAiB,CACf,MAAM,EAAE,2BAA2B,EACnC,OAAO,EAAE,2BAA2B,GACnC,OAAO,CAAC;QACT,WAAW,EAAE,2BAA2B,EAAE,CAAC;QAC3C,aAAa,EAAE,2BAA2B,CAAC;KAC5C,CAAC,CAAC;IACH;;;;;;;;;OASG;IACH,eAAe,CACb,MAAM,EAAE,2BAA2B,EACnC,OAAO,EAAE,2BAA2B,EACpC,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAAC,GAC9E,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB;;;OAGG;IACH,wBAAwB,CACtB,MAAM,EAAE,2BAA2B,EACnC,OAAO,EAAE,2BAA2B,EACpC,IAAI,EAAE,gBAAgB,EACtB,iBAAiB,CAAC,EAAE,SAAS,MAAM,EAAE,GACpC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAChC;;;;OAIG;IACH,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,EAAE,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IACpF;;;;OAIG;IACH,SAAS,CAAC,CAAC,EACT,QAAQ,EAAE,SAAS,2BAA2B,EAAE,EAChD,IAAI,EAAE,CAAC,OAAO,EAAE,2BAA2B,KAAK,OAAO,CAAC,CAAC,CAAC,EAC1D,KAAK,EAAE,cAAc,GACpB,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAChB,yEAAyE;IACzE,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACpE;;;OAGG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAC;CACpC;AA82CD,wBAAsB,wBAAwB,CAC5C,OAAO,EAAE,kBAAkB,EAC3B,OAAO,EAAE,MAAM,EACf,cAAc,EAAE,UAAU,EAC1B,OAAO,EAAE,WAAW,GAAG;IAAE,eAAe,EAAE,MAAM,CAAA;CAAE,GACjD,OAAO,CAAC,UAAU,CAAC,CAwGrB"}