@open-e2ee/signal-protocol-sdk 2.0.2 → 4.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 (576) hide show
  1. package/ADAPTERS.md +14 -21
  2. package/ARCHITECTURE.md +1 -2
  3. package/CHANGELOG.md +90 -0
  4. package/LICENSE +11 -655
  5. package/LICENSE-APACHE +201 -0
  6. package/LICENSE-MIT +21 -0
  7. package/NOTICE +5 -7
  8. package/README.md +11 -11
  9. package/SECURITY.md +2 -2
  10. package/TROUBLESHOOTING.md +6 -10
  11. package/client/README.md +36 -18
  12. package/device/README.md +1 -1
  13. package/dist/blocking/manager.d.ts +2 -2
  14. package/dist/blocking/manager.d.ts.map +1 -1
  15. package/dist/blocking/manager.js.map +1 -1
  16. package/dist/client/client.d.ts +45 -34
  17. package/dist/client/client.d.ts.map +1 -1
  18. package/dist/client/client.js +178 -115
  19. package/dist/client/client.js.map +1 -1
  20. package/dist/client/compose.d.ts +7 -7
  21. package/dist/client/compose.d.ts.map +1 -1
  22. package/dist/client/compose.js +2 -2
  23. package/dist/client/compose.js.map +1 -1
  24. package/dist/client/config.d.ts +24 -28
  25. package/dist/client/config.d.ts.map +1 -1
  26. package/dist/client/config.js.map +1 -1
  27. package/dist/client/content-adapter.d.ts +2 -0
  28. package/dist/client/content-adapter.d.ts.map +1 -1
  29. package/dist/client/content-adapter.js +4 -0
  30. package/dist/client/content-adapter.js.map +1 -1
  31. package/dist/client/dual-store.d.ts +5 -5
  32. package/dist/client/dual-store.d.ts.map +1 -1
  33. package/dist/client/dual-store.js.map +1 -1
  34. package/dist/client/endorsement-manager.d.ts +6 -3
  35. package/dist/client/endorsement-manager.d.ts.map +1 -1
  36. package/dist/client/endorsement-manager.js +14 -6
  37. package/dist/client/endorsement-manager.js.map +1 -1
  38. package/dist/client/files.d.ts +1 -1
  39. package/dist/client/files.js +1 -1
  40. package/dist/client/group-authority.d.ts +8 -0
  41. package/dist/client/group-authority.d.ts.map +1 -0
  42. package/dist/client/group-authority.js +2 -0
  43. package/dist/client/group-authority.js.map +1 -0
  44. package/dist/client/group-outbox.d.ts +4 -4
  45. package/dist/client/group-outbox.d.ts.map +1 -1
  46. package/dist/client/group-sealed-sender.d.ts +2 -2
  47. package/dist/client/group-sealed-sender.d.ts.map +1 -1
  48. package/dist/client/groups.d.ts +1 -1
  49. package/dist/client/groups.js +1 -1
  50. package/dist/client/headless.d.ts +11 -16
  51. package/dist/client/headless.d.ts.map +1 -1
  52. package/dist/client/headless.js +4 -9
  53. package/dist/client/headless.js.map +1 -1
  54. package/dist/client/hosted-anonymous-delivery.d.ts +32 -0
  55. package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -0
  56. package/dist/client/hosted-anonymous-delivery.js +239 -0
  57. package/dist/client/hosted-anonymous-delivery.js.map +1 -0
  58. package/dist/client/hosted-connection.d.ts +1 -1
  59. package/dist/client/hosted-connection.d.ts.map +1 -1
  60. package/dist/client/hosted-connection.js +18 -51
  61. package/dist/client/hosted-connection.js.map +1 -1
  62. package/dist/client/hosted-group-authority.d.ts +11 -0
  63. package/dist/client/hosted-group-authority.d.ts.map +1 -0
  64. package/dist/client/hosted-group-authority.js +96 -0
  65. package/dist/client/hosted-group-authority.js.map +1 -0
  66. package/dist/client/hosted-groups.d.ts +31 -0
  67. package/dist/client/hosted-groups.d.ts.map +1 -0
  68. package/dist/client/hosted-groups.js +217 -0
  69. package/dist/client/hosted-groups.js.map +1 -0
  70. package/dist/client/hosted-mailbox-subscription.d.ts +34 -0
  71. package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -0
  72. package/dist/client/hosted-mailbox-subscription.js +257 -0
  73. package/dist/client/hosted-mailbox-subscription.js.map +1 -0
  74. package/dist/client/hosted-prekey-publication.d.ts +51 -0
  75. package/dist/client/hosted-prekey-publication.d.ts.map +1 -0
  76. package/dist/client/hosted-prekey-publication.js +249 -0
  77. package/dist/client/hosted-prekey-publication.js.map +1 -0
  78. package/dist/client/hosted-push.d.ts +5 -6
  79. package/dist/client/hosted-push.d.ts.map +1 -1
  80. package/dist/client/hosted-push.js +22 -22
  81. package/dist/client/hosted-push.js.map +1 -1
  82. package/dist/client/hosted-transport.d.ts +62 -40
  83. package/dist/client/hosted-transport.d.ts.map +1 -1
  84. package/dist/client/hosted-transport.js +666 -341
  85. package/dist/client/hosted-transport.js.map +1 -1
  86. package/dist/client/hosted-trust.d.ts +29 -0
  87. package/dist/client/hosted-trust.d.ts.map +1 -0
  88. package/dist/client/hosted-trust.js +28 -0
  89. package/dist/client/hosted-trust.js.map +1 -0
  90. package/dist/client/hosted.d.ts +26 -21
  91. package/dist/client/hosted.d.ts.map +1 -1
  92. package/dist/client/hosted.js +80 -36
  93. package/dist/client/hosted.js.map +1 -1
  94. package/dist/client/index.d.ts +15 -15
  95. package/dist/client/index.d.ts.map +1 -1
  96. package/dist/client/index.js +7 -7
  97. package/dist/client/index.js.map +1 -1
  98. package/dist/client/key-rotation-core.d.ts +16 -8
  99. package/dist/client/key-rotation-core.d.ts.map +1 -1
  100. package/dist/client/key-rotation-core.js +14 -3
  101. package/dist/client/key-rotation-core.js.map +1 -1
  102. package/dist/client/key-rotation.d.ts +3 -2
  103. package/dist/client/key-rotation.d.ts.map +1 -1
  104. package/dist/client/key-rotation.js +5 -5
  105. package/dist/client/key-rotation.js.map +1 -1
  106. package/dist/client/media-queue-persistence.d.ts +14 -0
  107. package/dist/client/media-queue-persistence.d.ts.map +1 -0
  108. package/dist/client/media-queue-persistence.js +123 -0
  109. package/dist/client/media-queue-persistence.js.map +1 -0
  110. package/dist/client/media-upload-budget.d.ts +3 -0
  111. package/dist/client/media-upload-budget.d.ts.map +1 -0
  112. package/dist/client/media-upload-budget.js +27 -0
  113. package/dist/client/media-upload-budget.js.map +1 -0
  114. package/dist/client/media.d.ts +51 -15
  115. package/dist/client/media.d.ts.map +1 -1
  116. package/dist/client/media.js +541 -73
  117. package/dist/client/media.js.map +1 -1
  118. package/dist/client/messages.d.ts +1 -1
  119. package/dist/client/messages.d.ts.map +1 -1
  120. package/dist/client/messages.js +14 -15
  121. package/dist/client/messages.js.map +1 -1
  122. package/dist/client/multi-device.d.ts +1 -1
  123. package/dist/client/multi-device.js +1 -1
  124. package/dist/client/prekeys.d.ts +1 -1
  125. package/dist/client/prekeys.d.ts.map +1 -1
  126. package/dist/client/prekeys.js +132 -44
  127. package/dist/client/prekeys.js.map +1 -1
  128. package/dist/client/relay-subscription.d.ts +5 -1
  129. package/dist/client/relay-subscription.d.ts.map +1 -1
  130. package/dist/client/relay-subscription.js +59 -26
  131. package/dist/client/relay-subscription.js.map +1 -1
  132. package/dist/client/retry.d.ts +3 -3
  133. package/dist/client/retry.d.ts.map +1 -1
  134. package/dist/client/retry.js +1 -1
  135. package/dist/client/retry.js.map +1 -1
  136. package/dist/client/sealed-sender.d.ts +5 -5
  137. package/dist/client/sealed-sender.d.ts.map +1 -1
  138. package/dist/client/sealed-sender.js.map +1 -1
  139. package/dist/client/sender-key-distribution.d.ts +8 -0
  140. package/dist/client/sender-key-distribution.d.ts.map +1 -0
  141. package/dist/client/sender-key-distribution.js +59 -0
  142. package/dist/client/sender-key-distribution.js.map +1 -0
  143. package/dist/client/sessions.d.ts +3 -3
  144. package/dist/client/sessions.d.ts.map +1 -1
  145. package/dist/client/sessions.js +1 -1
  146. package/dist/client/sessions.js.map +1 -1
  147. package/dist/client/signal-service-cipher.d.ts +12 -8
  148. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  149. package/dist/client/signal-service-cipher.js +41 -16
  150. package/dist/client/signal-service-cipher.js.map +1 -1
  151. package/dist/client/state.d.ts +1 -1
  152. package/dist/client/state.js +1 -1
  153. package/dist/client/types.d.ts +10 -10
  154. package/dist/client/types.d.ts.map +1 -1
  155. package/dist/client/types.js +1 -1
  156. package/dist/device/connection.d.ts.map +1 -1
  157. package/dist/device/connection.js.map +1 -1
  158. package/dist/device/device-id.d.ts +2 -2
  159. package/dist/device/device-id.d.ts.map +1 -1
  160. package/dist/device/device-id.js.map +1 -1
  161. package/dist/device/{expo-metadata.d.ts → expo/index.d.ts} +3 -3
  162. package/dist/device/expo/index.d.ts.map +1 -0
  163. package/dist/device/{expo-metadata.js → expo/index.js} +2 -2
  164. package/dist/device/expo/index.js.map +1 -0
  165. package/dist/device/index.d.ts +1 -1
  166. package/dist/device/index.d.ts.map +1 -1
  167. package/dist/device/index.js +1 -1
  168. package/dist/device/index.js.map +1 -1
  169. package/dist/device/lifecycle/index.d.ts +1 -1
  170. package/dist/device/lifecycle/index.d.ts.map +1 -1
  171. package/dist/device/lifecycle/types.d.ts +8 -8
  172. package/dist/device/lifecycle/types.d.ts.map +1 -1
  173. package/dist/device/provisioning.d.ts +13 -13
  174. package/dist/device/provisioning.d.ts.map +1 -1
  175. package/dist/device/provisioning.js +1 -1
  176. package/dist/device/provisioning.js.map +1 -1
  177. package/dist/device/transfer.d.ts +13 -13
  178. package/dist/device/transfer.d.ts.map +1 -1
  179. package/dist/device/transfer.js.map +1 -1
  180. package/dist/device/types.d.ts +3 -3
  181. package/dist/device/types.d.ts.map +1 -1
  182. package/dist/groups/index.d.ts +1 -1
  183. package/dist/groups/index.d.ts.map +1 -1
  184. package/dist/groups/server.d.ts +10 -0
  185. package/dist/groups/server.d.ts.map +1 -0
  186. package/dist/groups/server.js +6 -0
  187. package/dist/groups/server.js.map +1 -0
  188. package/dist/hooks/use-connection-presence.d.ts +6 -8
  189. package/dist/hooks/use-connection-presence.d.ts.map +1 -1
  190. package/dist/hooks/use-connection-presence.js +2 -4
  191. package/dist/hooks/use-connection-presence.js.map +1 -1
  192. package/dist/hooks/use-group-membership.d.ts +2 -2
  193. package/dist/hooks/use-group-membership.d.ts.map +1 -1
  194. package/dist/hooks/use-group-membership.js.map +1 -1
  195. package/dist/hooks/use-key-rotation.d.ts +2 -2
  196. package/dist/hooks/use-key-rotation.d.ts.map +1 -1
  197. package/dist/hooks/use-session-health.d.ts +2 -2
  198. package/dist/hooks/use-session-health.d.ts.map +1 -1
  199. package/dist/index.d.ts +57 -55
  200. package/dist/index.d.ts.map +1 -1
  201. package/dist/index.js +27 -26
  202. package/dist/index.js.map +1 -1
  203. package/dist/internal/crypto/ec/x25519-validation.d.ts +4 -4
  204. package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
  205. package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
  206. package/dist/internal/groups/authority-certificate.d.ts +22 -0
  207. package/dist/internal/groups/authority-certificate.d.ts.map +1 -0
  208. package/dist/internal/groups/authority-certificate.js +99 -0
  209. package/dist/internal/groups/authority-certificate.js.map +1 -0
  210. package/dist/internal/groups/error-details.d.ts +9 -0
  211. package/dist/internal/groups/error-details.d.ts.map +1 -0
  212. package/dist/internal/groups/error-details.js +30 -0
  213. package/dist/internal/groups/error-details.js.map +1 -0
  214. package/dist/internal/groups/index.d.ts +1 -1
  215. package/dist/internal/groups/index.d.ts.map +1 -1
  216. package/dist/internal/groups/manager.d.ts +9 -4
  217. package/dist/internal/groups/manager.d.ts.map +1 -1
  218. package/dist/internal/groups/manager.js +3 -0
  219. package/dist/internal/groups/manager.js.map +1 -1
  220. package/dist/internal/groups/sdk-store.d.ts +4 -4
  221. package/dist/internal/groups/sdk-store.d.ts.map +1 -1
  222. package/dist/internal/groups/sdk-store.js.map +1 -1
  223. package/dist/internal/groups/server-engine.d.ts +9 -2
  224. package/dist/internal/groups/server-engine.d.ts.map +1 -1
  225. package/dist/internal/groups/server-engine.js +51 -19
  226. package/dist/internal/groups/server-engine.js.map +1 -1
  227. package/dist/internal/groups/wire.d.ts.map +1 -1
  228. package/dist/internal/groups/wire.js +10 -9
  229. package/dist/internal/groups/wire.js.map +1 -1
  230. package/dist/internal/manager/index.d.ts +2 -2
  231. package/dist/internal/manager/index.d.ts.map +1 -1
  232. package/dist/internal/manager/index.js +1 -1
  233. package/dist/internal/manager/index.js.map +1 -1
  234. package/dist/internal/manager/manager.d.ts +23 -23
  235. package/dist/internal/manager/manager.d.ts.map +1 -1
  236. package/dist/internal/manager/manager.js +40 -43
  237. package/dist/internal/manager/manager.js.map +1 -1
  238. package/dist/internal/protocol/double-ratchet/chains.d.ts +9 -9
  239. package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
  240. package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
  241. package/dist/internal/protocol/double-ratchet/ratchet.d.ts +2 -2
  242. package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
  243. package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
  244. package/dist/internal/protocol/pqxdh/pqxdh.d.ts +3 -3
  245. package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
  246. package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
  247. package/dist/internal/protocol/sender-keys/manager.d.ts +4 -4
  248. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  249. package/dist/internal/protocol/sender-keys/manager.js +27 -14
  250. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  251. package/dist/internal/protocol/spqr/ml-kem-braid/authenticator.d.ts +3 -3
  252. package/dist/internal/protocol/spqr/ml-kem-braid/authenticator.d.ts.map +1 -1
  253. package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.d.ts +3 -3
  254. package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.d.ts.map +1 -1
  255. package/dist/internal/protocol/spqr/ml-kem-braid/index.d.ts +2 -2
  256. package/dist/internal/protocol/spqr/ml-kem-braid/index.d.ts.map +1 -1
  257. package/dist/internal/protocol/spqr/ml-kem-braid/index.js +1 -1
  258. package/dist/internal/protocol/spqr/ml-kem-braid/index.js.map +1 -1
  259. package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.d.ts +3 -3
  260. package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.d.ts.map +1 -1
  261. package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js +2 -2
  262. package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js.map +1 -1
  263. package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts +3 -3
  264. package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts.map +1 -1
  265. package/dist/internal/protocol/spqr/spqr.d.ts +5 -5
  266. package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
  267. package/dist/internal/protocol/spqr/spqr.js.map +1 -1
  268. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +4 -4
  269. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +1 -1
  270. package/dist/internal/protocol/triple-ratchet/ratchet.js.map +1 -1
  271. package/dist/internal/protocol/x3dh/x3dh.d.ts +3 -3
  272. package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
  273. package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
  274. package/dist/internal/sesame/device-registry.d.ts +16 -16
  275. package/dist/internal/sesame/device-registry.d.ts.map +1 -1
  276. package/dist/internal/sesame/device-registry.js +6 -6
  277. package/dist/internal/sesame/device-registry.js.map +1 -1
  278. package/dist/internal/sesame/index.d.ts +4 -4
  279. package/dist/internal/sesame/index.d.ts.map +1 -1
  280. package/dist/internal/sesame/index.js +2 -2
  281. package/dist/internal/sesame/index.js.map +1 -1
  282. package/dist/internal/sesame/manager.d.ts +10 -10
  283. package/dist/internal/sesame/manager.d.ts.map +1 -1
  284. package/dist/internal/sesame/manager.js +13 -13
  285. package/dist/internal/sesame/manager.js.map +1 -1
  286. package/dist/internal/sesame/types.d.ts +5 -5
  287. package/dist/internal/sesame/types.d.ts.map +1 -1
  288. package/dist/internal/session/cipher.d.ts +4 -4
  289. package/dist/internal/session/cipher.d.ts.map +1 -1
  290. package/dist/internal/session/cipher.js +31 -28
  291. package/dist/internal/session/cipher.js.map +1 -1
  292. package/dist/internal/session/decryption.js.map +1 -1
  293. package/dist/internal/session/factory.d.ts +3 -3
  294. package/dist/internal/session/factory.d.ts.map +1 -1
  295. package/dist/internal/session/factory.js.map +1 -1
  296. package/dist/internal/session/handshake.d.ts +2 -2
  297. package/dist/internal/session/handshake.d.ts.map +1 -1
  298. package/dist/internal/session/handshake.js.map +1 -1
  299. package/dist/internal/session/ratchet.d.ts +4 -4
  300. package/dist/internal/session/ratchet.d.ts.map +1 -1
  301. package/dist/internal/session/ratchet.js.map +1 -1
  302. package/dist/internal/session/types.d.ts +5 -5
  303. package/dist/internal/session/types.d.ts.map +1 -1
  304. package/dist/internal/session/validation.d.ts +3 -3
  305. package/dist/internal/session/validation.d.ts.map +1 -1
  306. package/dist/internal/session/validation.js.map +1 -1
  307. package/dist/layers.d.ts +4 -4
  308. package/dist/layers.d.ts.map +1 -1
  309. package/dist/layers.js +12 -12
  310. package/dist/layers.js.map +1 -1
  311. package/dist/local/store/expo/adapter.d.ts +15 -9
  312. package/dist/local/store/expo/adapter.d.ts.map +1 -1
  313. package/dist/local/store/expo/adapter.js +29 -10
  314. package/dist/local/store/expo/adapter.js.map +1 -1
  315. package/dist/local/store/expo/database-key.d.ts +5 -5
  316. package/dist/local/store/expo/database-key.d.ts.map +1 -1
  317. package/dist/local/store/expo/database-key.js.map +1 -1
  318. package/dist/local/store/expo/index.d.ts +3 -3
  319. package/dist/local/store/expo/index.d.ts.map +1 -1
  320. package/dist/local/store/expo/key-storage.d.ts +11 -5
  321. package/dist/local/store/expo/key-storage.d.ts.map +1 -1
  322. package/dist/local/store/expo/key-storage.js +82 -17
  323. package/dist/local/store/expo/key-storage.js.map +1 -1
  324. package/dist/local/store/expo/models/kyber-prekey-used.d.ts +1 -4
  325. package/dist/local/store/expo/models/kyber-prekey-used.d.ts.map +1 -1
  326. package/dist/local/store/expo/models/kyber-prekey-used.js +23 -9
  327. package/dist/local/store/expo/models/kyber-prekey-used.js.map +1 -1
  328. package/dist/local/store/expo/models/kyber-prekey.d.ts +4 -4
  329. package/dist/local/store/expo/models/kyber-prekey.d.ts.map +1 -1
  330. package/dist/local/store/expo/models/kyber-prekey.js +67 -26
  331. package/dist/local/store/expo/models/kyber-prekey.js.map +1 -1
  332. package/dist/local/store/expo/schema.d.ts +21 -2
  333. package/dist/local/store/expo/schema.d.ts.map +1 -1
  334. package/dist/local/store/expo/schema.js +10 -2
  335. package/dist/local/store/expo/schema.js.map +1 -1
  336. package/dist/local/store/index.d.ts +3 -3
  337. package/dist/local/store/index.d.ts.map +1 -1
  338. package/dist/local/store/index.js +1 -1
  339. package/dist/local/store/kyber-prekey-lifecycle.d.ts +46 -0
  340. package/dist/local/store/kyber-prekey-lifecycle.d.ts.map +1 -0
  341. package/dist/local/store/kyber-prekey-lifecycle.js +88 -0
  342. package/dist/local/store/kyber-prekey-lifecycle.js.map +1 -0
  343. package/dist/local/store/memory/adapter.d.ts +14 -6
  344. package/dist/local/store/memory/adapter.d.ts.map +1 -1
  345. package/dist/local/store/memory/adapter.js +114 -29
  346. package/dist/local/store/memory/adapter.js.map +1 -1
  347. package/dist/local/store/node/adapter.d.ts +9 -3
  348. package/dist/local/store/node/adapter.d.ts.map +1 -1
  349. package/dist/local/store/node/adapter.js +31 -13
  350. package/dist/local/store/node/adapter.js.map +1 -1
  351. package/dist/local/store/node/database-file-commit.d.ts +8 -0
  352. package/dist/local/store/node/database-file-commit.d.ts.map +1 -0
  353. package/dist/local/store/node/database-file-commit.js +62 -0
  354. package/dist/local/store/node/database-file-commit.js.map +1 -0
  355. package/dist/local/store/node/database-key.d.ts +6 -1
  356. package/dist/local/store/node/database-key.d.ts.map +1 -1
  357. package/dist/local/store/node/database-key.js +79 -44
  358. package/dist/local/store/node/database-key.js.map +1 -1
  359. package/dist/local/store/node/database-lock.d.ts +8 -0
  360. package/dist/local/store/node/database-lock.d.ts.map +1 -0
  361. package/dist/local/store/node/database-lock.js +44 -0
  362. package/dist/local/store/node/database-lock.js.map +1 -0
  363. package/dist/local/store/node/database.d.ts +17 -16
  364. package/dist/local/store/node/database.d.ts.map +1 -1
  365. package/dist/local/store/node/database.js +197 -202
  366. package/dist/local/store/node/database.js.map +1 -1
  367. package/dist/local/store/react-native/adapter.d.ts +10 -4
  368. package/dist/local/store/react-native/adapter.d.ts.map +1 -1
  369. package/dist/local/store/react-native/adapter.js +151 -66
  370. package/dist/local/store/react-native/adapter.js.map +1 -1
  371. package/dist/local/store/received-content.d.ts +9 -0
  372. package/dist/local/store/received-content.d.ts.map +1 -0
  373. package/dist/local/store/received-content.js +46 -0
  374. package/dist/local/store/received-content.js.map +1 -0
  375. package/dist/local/store/reliability.d.ts +4 -4
  376. package/dist/local/store/reliability.d.ts.map +1 -1
  377. package/dist/local/store/reliability.js +7 -4
  378. package/dist/local/store/reliability.js.map +1 -1
  379. package/dist/local/store/web/adapter.d.ts +11 -5
  380. package/dist/local/store/web/adapter.d.ts.map +1 -1
  381. package/dist/local/store/web/adapter.js +207 -74
  382. package/dist/local/store/web/adapter.js.map +1 -1
  383. package/dist/local/vault/expo-secure-store.d.ts +2 -2
  384. package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
  385. package/dist/local/vault/index.d.ts +1 -1
  386. package/dist/local/vault/index.d.ts.map +1 -1
  387. package/dist/logger.d.ts +4 -4
  388. package/dist/logger.d.ts.map +1 -1
  389. package/dist/logger.js.map +1 -1
  390. package/dist/media/index.d.ts +71 -61
  391. package/dist/media/index.d.ts.map +1 -1
  392. package/dist/media/index.js +550 -386
  393. package/dist/media/index.js.map +1 -1
  394. package/dist/media/prepared-upload.d.ts +37 -0
  395. package/dist/media/prepared-upload.d.ts.map +1 -0
  396. package/dist/media/prepared-upload.js +46 -0
  397. package/dist/media/prepared-upload.js.map +1 -0
  398. package/dist/profile/contact-state.d.ts +2 -2
  399. package/dist/profile/contact-state.d.ts.map +1 -1
  400. package/dist/profile/contact-state.js.map +1 -1
  401. package/dist/profile/profile-key.d.ts +2 -2
  402. package/dist/profile/profile-key.d.ts.map +1 -1
  403. package/dist/profile/profile-key.js.map +1 -1
  404. package/dist/profile/update-service.d.ts +2 -2
  405. package/dist/profile/update-service.d.ts.map +1 -1
  406. package/dist/profile/update-service.js.map +1 -1
  407. package/dist/remote/object-store/convex-r2/server.d.ts +2 -1
  408. package/dist/remote/object-store/convex-r2/server.d.ts.map +1 -1
  409. package/dist/remote/object-store/convex-r2/server.js +4 -0
  410. package/dist/remote/object-store/convex-r2/server.js.map +1 -1
  411. package/dist/remote/object-store/convex-r2/storage.d.ts.map +1 -1
  412. package/dist/remote/object-store/convex-r2/storage.js +1 -0
  413. package/dist/remote/object-store/convex-r2/storage.js.map +1 -1
  414. package/dist/remote/object-store/index.d.ts +3 -1
  415. package/dist/remote/object-store/index.d.ts.map +1 -1
  416. package/dist/remote/object-store/index.js +1 -1
  417. package/dist/remote/object-store/index.js.map +1 -1
  418. package/dist/remote/object-store/s3/storage.d.ts +3 -1
  419. package/dist/remote/object-store/s3/storage.d.ts.map +1 -1
  420. package/dist/remote/object-store/s3/storage.js +9 -2
  421. package/dist/remote/object-store/s3/storage.js.map +1 -1
  422. package/dist/remote/object-store/types.d.ts +33 -4
  423. package/dist/remote/object-store/types.d.ts.map +1 -1
  424. package/dist/remote/object-store/upload-error.d.ts +23 -0
  425. package/dist/remote/object-store/upload-error.d.ts.map +1 -0
  426. package/dist/remote/object-store/upload-error.js +33 -0
  427. package/dist/remote/object-store/upload-error.js.map +1 -0
  428. package/dist/remote/object-store/validation.d.ts +7 -1
  429. package/dist/remote/object-store/validation.d.ts.map +1 -1
  430. package/dist/remote/object-store/validation.js +39 -25
  431. package/dist/remote/object-store/validation.js.map +1 -1
  432. package/dist/remote/relay/index.d.ts +7 -14
  433. package/dist/remote/relay/index.d.ts.map +1 -1
  434. package/dist/remote/relay/index.js +6 -13
  435. package/dist/remote/relay/index.js.map +1 -1
  436. package/dist/remote/relay/memory/adapter.d.ts +5 -4
  437. package/dist/remote/relay/memory/adapter.d.ts.map +1 -1
  438. package/dist/remote/relay/memory/adapter.js +14 -4
  439. package/dist/remote/relay/memory/adapter.js.map +1 -1
  440. package/dist/remote/relay/types.d.ts +36 -25
  441. package/dist/remote/relay/types.d.ts.map +1 -1
  442. package/dist/remote/relay/types.js +1 -1
  443. package/dist/types/api.d.ts +59 -24
  444. package/dist/types/api.d.ts.map +1 -1
  445. package/dist/types/index.js +1 -1
  446. package/dist/types/index.js.map +1 -1
  447. package/dist/types/session.d.ts +6 -0
  448. package/dist/types/session.d.ts.map +1 -1
  449. package/dist/types/session.js.map +1 -1
  450. package/docs/ASSURANCE.md +7 -7
  451. package/docs/CLIENT_COMPOSITION.md +16 -23
  452. package/docs/DEVIATIONS.md +1 -1
  453. package/docs/DOCUMENTATION_STANDARDS.md +4 -0
  454. package/docs/ERROR_HANDLING.md +2 -2
  455. package/docs/GETTING_STARTED.md +23 -38
  456. package/docs/INTERFACES.md +36 -27
  457. package/docs/PACKAGE_SURFACE.md +9 -16
  458. package/docs/RECIPES.md +10 -23
  459. package/examples/browser/index.html +2 -2
  460. package/groups/README.md +4 -4
  461. package/local/store/README.md +22 -7
  462. package/local/store/expo/README.md +24 -20
  463. package/local/store/memory/README.md +1 -1
  464. package/local/store/node/README.md +31 -2
  465. package/local/store/react-native/README.md +1 -1
  466. package/local/store/web/README.md +1 -1
  467. package/local/vault/README.md +1 -1
  468. package/media/README.md +94 -0
  469. package/package.json +17 -27
  470. package/remote/README.md +24 -24
  471. package/remote/object-store/README.md +8 -0
  472. package/remote/object-store/s3/README.md +10 -1
  473. package/remote/relay/README.md +4 -3
  474. package/remote/relay/memory/README.md +1 -1
  475. package/types/README.md +2 -2
  476. package/COMMERCIAL.md +0 -56
  477. package/dist/device/expo-metadata.d.ts.map +0 -1
  478. package/dist/device/expo-metadata.js.map +0 -1
  479. package/dist/remote/relay/convex/backend.d.ts +0 -394
  480. package/dist/remote/relay/convex/backend.d.ts.map +0 -1
  481. package/dist/remote/relay/convex/backend.js +0 -678
  482. package/dist/remote/relay/convex/backend.js.map +0 -1
  483. package/dist/remote/relay/convex/component/_generated/api.d.ts +0 -58
  484. package/dist/remote/relay/convex/component/_generated/api.d.ts.map +0 -1
  485. package/dist/remote/relay/convex/component/_generated/api.js +0 -31
  486. package/dist/remote/relay/convex/component/_generated/api.js.map +0 -1
  487. package/dist/remote/relay/convex/component/_generated/component.d.ts +0 -475
  488. package/dist/remote/relay/convex/component/_generated/component.d.ts.map +0 -1
  489. package/dist/remote/relay/convex/component/_generated/component.js +0 -11
  490. package/dist/remote/relay/convex/component/_generated/component.js.map +0 -1
  491. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts +0 -46
  492. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts.map +0 -1
  493. package/dist/remote/relay/convex/component/_generated/dataModel.js +0 -11
  494. package/dist/remote/relay/convex/component/_generated/dataModel.js.map +0 -1
  495. package/dist/remote/relay/convex/component/_generated/server.d.ts +0 -129
  496. package/dist/remote/relay/convex/component/_generated/server.d.ts.map +0 -1
  497. package/dist/remote/relay/convex/component/_generated/server.js +0 -79
  498. package/dist/remote/relay/convex/component/_generated/server.js.map +0 -1
  499. package/dist/remote/relay/convex/component/accounts.d.ts +0 -45
  500. package/dist/remote/relay/convex/component/accounts.d.ts.map +0 -1
  501. package/dist/remote/relay/convex/component/accounts.js +0 -184
  502. package/dist/remote/relay/convex/component/accounts.js.map +0 -1
  503. package/dist/remote/relay/convex/component/certificates.d.ts +0 -10
  504. package/dist/remote/relay/convex/component/certificates.d.ts.map +0 -1
  505. package/dist/remote/relay/convex/component/certificates.js +0 -126
  506. package/dist/remote/relay/convex/component/certificates.js.map +0 -1
  507. package/dist/remote/relay/convex/component/cleanup.d.ts +0 -32
  508. package/dist/remote/relay/convex/component/cleanup.d.ts.map +0 -1
  509. package/dist/remote/relay/convex/component/cleanup.js +0 -146
  510. package/dist/remote/relay/convex/component/cleanup.js.map +0 -1
  511. package/dist/remote/relay/convex/component/convex.config.d.ts +0 -5
  512. package/dist/remote/relay/convex/component/convex.config.d.ts.map +0 -1
  513. package/dist/remote/relay/convex/component/convex.config.js +0 -35
  514. package/dist/remote/relay/convex/component/convex.config.js.map +0 -1
  515. package/dist/remote/relay/convex/component/crons.d.ts +0 -3
  516. package/dist/remote/relay/convex/component/crons.d.ts.map +0 -1
  517. package/dist/remote/relay/convex/component/crons.js +0 -10
  518. package/dist/remote/relay/convex/component/crons.js.map +0 -1
  519. package/dist/remote/relay/convex/component/devices.d.ts +0 -102
  520. package/dist/remote/relay/convex/component/devices.d.ts.map +0 -1
  521. package/dist/remote/relay/convex/component/devices.js +0 -300
  522. package/dist/remote/relay/convex/component/devices.js.map +0 -1
  523. package/dist/remote/relay/convex/component/errors.d.ts +0 -22
  524. package/dist/remote/relay/convex/component/errors.d.ts.map +0 -1
  525. package/dist/remote/relay/convex/component/errors.js +0 -17
  526. package/dist/remote/relay/convex/component/errors.js.map +0 -1
  527. package/dist/remote/relay/convex/component/groups.d.ts +0 -63
  528. package/dist/remote/relay/convex/component/groups.d.ts.map +0 -1
  529. package/dist/remote/relay/convex/component/groups.js +0 -341
  530. package/dist/remote/relay/convex/component/groups.js.map +0 -1
  531. package/dist/remote/relay/convex/component/keys.d.ts +0 -130
  532. package/dist/remote/relay/convex/component/keys.d.ts.map +0 -1
  533. package/dist/remote/relay/convex/component/keys.js +0 -578
  534. package/dist/remote/relay/convex/component/keys.js.map +0 -1
  535. package/dist/remote/relay/convex/component/messages.d.ts +0 -105
  536. package/dist/remote/relay/convex/component/messages.d.ts.map +0 -1
  537. package/dist/remote/relay/convex/component/messages.js +0 -702
  538. package/dist/remote/relay/convex/component/messages.js.map +0 -1
  539. package/dist/remote/relay/convex/component/provisioning.d.ts +0 -92
  540. package/dist/remote/relay/convex/component/provisioning.d.ts.map +0 -1
  541. package/dist/remote/relay/convex/component/provisioning.js +0 -360
  542. package/dist/remote/relay/convex/component/provisioning.js.map +0 -1
  543. package/dist/remote/relay/convex/component/runtime.d.ts +0 -18
  544. package/dist/remote/relay/convex/component/runtime.d.ts.map +0 -1
  545. package/dist/remote/relay/convex/component/runtime.js +0 -144
  546. package/dist/remote/relay/convex/component/runtime.js.map +0 -1
  547. package/dist/remote/relay/convex/component/schema.d.ts +0 -358
  548. package/dist/remote/relay/convex/component/schema.d.ts.map +0 -1
  549. package/dist/remote/relay/convex/component/schema.js +0 -288
  550. package/dist/remote/relay/convex/component/schema.js.map +0 -1
  551. package/dist/remote/relay/convex/component/zkAuth.d.ts +0 -18
  552. package/dist/remote/relay/convex/component/zkAuth.d.ts.map +0 -1
  553. package/dist/remote/relay/convex/component/zkAuth.js +0 -86
  554. package/dist/remote/relay/convex/component/zkAuth.js.map +0 -1
  555. package/dist/remote/relay/convex/constants.d.ts +0 -3
  556. package/dist/remote/relay/convex/constants.d.ts.map +0 -1
  557. package/dist/remote/relay/convex/constants.js +0 -3
  558. package/dist/remote/relay/convex/constants.js.map +0 -1
  559. package/dist/remote/relay/convex/group-server.d.ts +0 -123
  560. package/dist/remote/relay/convex/group-server.d.ts.map +0 -1
  561. package/dist/remote/relay/convex/group-server.js +0 -184
  562. package/dist/remote/relay/convex/group-server.js.map +0 -1
  563. package/dist/remote/relay/convex/index.d.ts +0 -42
  564. package/dist/remote/relay/convex/index.d.ts.map +0 -1
  565. package/dist/remote/relay/convex/index.js +0 -38
  566. package/dist/remote/relay/convex/index.js.map +0 -1
  567. package/dist/remote/relay/convex/relay.d.ts +0 -323
  568. package/dist/remote/relay/convex/relay.d.ts.map +0 -1
  569. package/dist/remote/relay/convex/relay.js +0 -1144
  570. package/dist/remote/relay/convex/relay.js.map +0 -1
  571. package/dist/remote/relay/convex/types.d.ts +0 -24
  572. package/dist/remote/relay/convex/types.d.ts.map +0 -1
  573. package/dist/remote/relay/convex/types.js +0 -14
  574. package/dist/remote/relay/convex/types.js.map +0 -1
  575. package/remote/relay/convex/README.md +0 -61
  576. package/remote/relay/convex/component/README.md +0 -462
@@ -1,18 +1,24 @@
1
- import { createMediaAttachmentId, createMediaAttachmentPointer, executeMediaAttachmentJob, generateMediaAttachmentUploadRequestId, MediaAttachmentJobExecutionStatus, MediaAttachmentJobOperation, MediaAttachmentJobPriority, MediaAttachmentJobSource, planMediaAttachmentCleanupJobs, planMediaAttachmentDownloadJob, planMediaAttachmentUploadJob, } from '../media/index.js';
2
- const SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_METADATA_KEY = 'signal:mediaQueue:v1';
1
+ import { isRemoteObjectUploadFailureCode, remoteObjectUploadFailure, RemoteObjectUploadError, } from "../remote/object-store/upload-error.js";
2
+ import { matchesUploadReceipt } from "../remote/object-store/validation.js";
3
+ import { assertPreparedUploadByteLimit } from "./media-upload-budget.js";
4
+ import { MediaQueuePersistence, MediaQueueConcurrentUpdateError, } from "./media-queue-persistence.js";
5
+ import { bytesToBase64, sha256 } from "../internal/crypto/index.js";
6
+ import { createMediaAttachmentId, createMediaAttachmentPointer, executeMediaAttachmentJob, generateMediaAttachmentUploadRequestId, prepareMediaAttachmentUploadData, validateMediaAttachmentPolicy, MediaAttachmentError, MediaAttachmentErrorCode, MediaAttachmentJobExecutionStatus, MediaAttachmentJobOperation, MediaAttachmentJobPriority, MediaAttachmentJobSource, planMediaAttachmentCleanupJobs, planMediaAttachmentDownloadJob, planMediaAttachmentUploadJob, } from "../media/index.js";
7
+ import { preparedUploadFingerprint, preparedUploadCiphertextSize, samePreparedUploadIntent, } from "../media/prepared-upload.js";
8
+ const SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_METADATA_KEY = "signal:mediaQueue:v1";
3
9
  const SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_JOBS_DEFAULT = 200;
4
10
  const SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_ATTEMPTS_DEFAULT = 5;
5
11
  const SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_BASE_RETRY_DELAY_MS_DEFAULT = 30_000;
6
12
  const SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_RETRY_DELAY_MS_DEFAULT = 60 * 60 * 1000;
7
13
  const localOnlyObjectStore = {
8
14
  async createUpload() {
9
- throw new Error('Signal Protocol media operation requires remoteObjectStore for upload');
15
+ throw new Error("Signal Protocol media operation requires remoteObjectStore for upload");
10
16
  },
11
17
  async createDownload() {
12
- throw new Error('Signal Protocol media operation requires remoteObjectStore for download');
18
+ throw new Error("Signal Protocol media operation requires remoteObjectStore for download");
13
19
  },
14
20
  async deleteObject() {
15
- throw new Error('Signal Protocol media operation requires remoteObjectStore for remote delete');
21
+ throw new Error("Signal Protocol media operation requires remoteObjectStore for remote delete");
16
22
  },
17
23
  };
18
24
  function priorityRank(priority) {
@@ -35,7 +41,7 @@ function compareMediaAttachmentJobs(left, right) {
35
41
  left.jobId.localeCompare(right.jobId));
36
42
  }
37
43
  function isRecord(value) {
38
- return value !== null && typeof value === 'object' && !Array.isArray(value);
44
+ return value !== null && typeof value === "object" && !Array.isArray(value);
39
45
  }
40
46
  function isInteger(value) {
41
47
  return Number.isSafeInteger(value);
@@ -44,18 +50,18 @@ function isMediaAttachmentJob(value) {
44
50
  if (!isRecord(value)) {
45
51
  return false;
46
52
  }
47
- return (typeof value.jobId === 'string' &&
53
+ return (typeof value.jobId === "string" &&
48
54
  Object.values(MediaAttachmentJobOperation).includes(value.operation) &&
49
55
  Object.values(MediaAttachmentJobSource).includes(value.source) &&
50
56
  Object.values(MediaAttachmentJobPriority).includes(value.priority) &&
51
- typeof value.requiresNetwork === 'boolean' &&
52
- typeof value.attachmentId === 'string' &&
57
+ typeof value.requiresNetwork === "boolean" &&
58
+ typeof value.attachmentId === "string" &&
53
59
  isInteger(value.attempt) &&
54
60
  isInteger(value.createdAt) &&
55
61
  isInteger(value.notBefore) &&
56
- (value.storageId === undefined || typeof value.storageId === 'string') &&
57
- (value.deliveryId === undefined || typeof value.deliveryId === 'string') &&
58
- (value.reason === undefined || typeof value.reason === 'string'));
62
+ (value.storageId === undefined || typeof value.storageId === "string") &&
63
+ (value.deliveryId === undefined || typeof value.deliveryId === "string") &&
64
+ (value.reason === undefined || typeof value.reason === "string"));
59
65
  }
60
66
  function normalizePointer(value) {
61
67
  try {
@@ -67,14 +73,33 @@ function normalizePointer(value) {
67
73
  }
68
74
  function isStoredUpload(value) {
69
75
  return (isRecord(value) &&
70
- typeof value.localMediaId === 'string' &&
76
+ typeof value.localMediaId === "string" &&
71
77
  value.localMediaId.length > 0 &&
72
- typeof value.requestId === 'string' &&
78
+ typeof value.requestId === "string" &&
73
79
  value.requestId.length > 0 &&
74
- typeof value.contentType === 'string' &&
80
+ typeof value.contentType === "string" &&
75
81
  value.contentType.length > 0 &&
76
82
  isInteger(value.size) &&
77
- value.size >= 0);
83
+ value.size >= 0 &&
84
+ (value.preparedFingerprint === undefined ||
85
+ typeof value.preparedFingerprint === "string") &&
86
+ (value.preparationStarted === undefined ||
87
+ value.preparationStarted === true) &&
88
+ (value.preparedAt === undefined ||
89
+ (isInteger(value.preparedAt) && value.preparedAt > 0)) &&
90
+ (value.abandonment === undefined ||
91
+ value.abandonment === "requested" ||
92
+ value.abandonment === "confirmed") &&
93
+ (value.remoteObjectId === undefined ||
94
+ (typeof value.remoteObjectId === "string" &&
95
+ value.remoteObjectId.length > 0)) &&
96
+ (value.transferCompletedAt === undefined ||
97
+ (isInteger(value.transferCompletedAt) &&
98
+ value.transferCompletedAt >= 0)) &&
99
+ (value.callbackDelivered === undefined ||
100
+ typeof value.callbackDelivered === "boolean") &&
101
+ (value.failureCode === undefined ||
102
+ isRemoteObjectUploadFailureCode(value.failureCode)));
78
103
  }
79
104
  function mergeJob(existing, incoming) {
80
105
  if (priorityRank(incoming.priority) <= priorityRank(existing.priority)) {
@@ -98,16 +123,20 @@ function normalizeJobs(jobs, maxJobs) {
98
123
  const deduped = new Map();
99
124
  for (const job of jobs) {
100
125
  if (!isMediaAttachmentJob(job)) {
101
- continue;
126
+ throw new Error("The saved media queue contains an invalid job. Restore the local queue before retrying.");
102
127
  }
103
128
  const existing = deduped.get(job.jobId);
104
129
  deduped.set(job.jobId, existing ? mergeJob(existing, job) : job);
105
130
  }
106
- return [...deduped.values()].sort(compareMediaAttachmentJobs).slice(0, maxJobs);
131
+ if (deduped.size > maxJobs)
132
+ throw new Error("The media queue is full. Complete existing jobs before adding work.");
133
+ return [...deduped.values()].sort(compareMediaAttachmentJobs);
107
134
  }
108
135
  function nextRetryTimestamp(job, now, config) {
109
- const baseDelay = config?.baseRetryDelayMs ?? SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_BASE_RETRY_DELAY_MS_DEFAULT;
110
- const maxDelay = config?.maxRetryDelayMs ?? SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_RETRY_DELAY_MS_DEFAULT;
136
+ const baseDelay = config?.baseRetryDelayMs ??
137
+ SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_BASE_RETRY_DELAY_MS_DEFAULT;
138
+ const maxDelay = config?.maxRetryDelayMs ??
139
+ SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_RETRY_DELAY_MS_DEFAULT;
111
140
  const delay = Math.min(maxDelay, baseDelay * 2 ** Math.max(0, job.attempt));
112
141
  return now + delay;
113
142
  }
@@ -136,30 +165,48 @@ function uploadOptionsFromStoredUpload(upload) {
136
165
  cdnNumber: upload.cdnNumber,
137
166
  };
138
167
  }
168
+ function preparedUploadMatchesQueue(upload, prepared) {
169
+ if (prepared.requestId !== upload.requestId ||
170
+ prepared.pointer.size !== upload.size ||
171
+ prepared.ciphertext.byteLength !==
172
+ preparedUploadCiphertextSize(upload.size) ||
173
+ prepared.pointer.ciphertextSize !== prepared.ciphertext.byteLength)
174
+ return false;
175
+ const pointer = prepared.pointer;
176
+ return Object.entries(uploadOptionsFromStoredUpload(upload)).every(([key, value]) => {
177
+ if (key === "requestId" ||
178
+ key === "policy" ||
179
+ (key === "clientUuid" && value === undefined))
180
+ return true;
181
+ return JSON.stringify(pointer[key]) === JSON.stringify(value);
182
+ });
183
+ }
139
184
  /** @internal */
140
185
  export class StorageBackedSignalProtocolClientMedia {
141
186
  storage;
142
187
  remoteObjectStore;
143
188
  config;
144
189
  storeLock = Promise.resolve();
190
+ queuePersistence;
145
191
  constructor(options) {
146
192
  this.storage = options.storage;
193
+ this.queuePersistence = new MediaQueuePersistence(options.storage, SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_METADATA_KEY);
147
194
  this.remoteObjectStore = options.remoteObjectStore;
148
195
  this.config = options.config;
149
196
  }
150
197
  async upload(input, options = {}) {
151
198
  const job = await this.enqueueUploadJob(input);
152
199
  const result = await this.processJob(job.jobId, options);
153
- if (result.status === 'completed' && result.execution.uploadedAttachment) {
200
+ if (result.status === "completed" && result.execution.uploadedAttachment) {
154
201
  return {
155
- status: 'completed',
202
+ status: "completed",
156
203
  jobId: job.jobId,
157
204
  attachment: result.execution.uploadedAttachment,
158
205
  execution: result.execution,
159
206
  };
160
207
  }
161
- if (result.status === 'completed') {
162
- return { status: 'failed', jobId: job.jobId };
208
+ if (result.status === "completed") {
209
+ return { status: "failed", jobId: job.jobId };
163
210
  }
164
211
  return result;
165
212
  }
@@ -168,26 +215,120 @@ export class StorageBackedSignalProtocolClientMedia {
168
215
  if (!job) {
169
216
  const attachment = createMediaAttachmentPointer(input.attachment);
170
217
  return {
171
- status: 'skipped',
172
- reason: 'not-needed',
218
+ status: "skipped",
219
+ reason: "not-needed",
173
220
  attachmentId: createMediaAttachmentId(attachment),
174
221
  };
175
222
  }
176
223
  const result = await this.processJob(job.jobId, options);
177
- if (result.status === 'completed' && result.execution.downloadedAttachment) {
224
+ if (result.status === "completed" &&
225
+ result.execution.downloadedAttachment) {
178
226
  return {
179
- status: 'completed',
227
+ status: "completed",
180
228
  jobId: job.jobId,
181
229
  attachmentId: job.attachmentId,
182
230
  downloaded: result.execution.downloadedAttachment,
183
231
  execution: result.execution,
184
232
  };
185
233
  }
186
- if (result.status === 'completed') {
187
- return { status: 'failed', jobId: job.jobId };
234
+ if (result.status === "completed") {
235
+ return { status: "failed", jobId: job.jobId };
188
236
  }
189
237
  return result;
190
238
  }
239
+ async abandonUpload(jobId) {
240
+ return this.withStoreLock(() => this.abandonUploadLocked(jobId));
241
+ }
242
+ async abandonUploadLocked(jobId) {
243
+ const artifacts = this.config?.preparedUploads;
244
+ if (!artifacts)
245
+ throw new Error("Configure media.preparedUploads before abandoning a queued upload.");
246
+ const cancellation = await artifacts.withExclusiveAccess(async () => {
247
+ const state = await this.loadState();
248
+ const job = state.jobs.find((item) => item.jobId === jobId);
249
+ if (!job)
250
+ return undefined;
251
+ const upload = state.uploads.get(jobId);
252
+ if (job.operation !== MediaAttachmentJobOperation.Upload || !upload)
253
+ throw new Error("Only a queued upload can be abandoned.");
254
+ const completed = state.pointers.get(jobId);
255
+ if (completed)
256
+ return { completed };
257
+ state.activeJobId = jobId;
258
+ upload.abandonment ??= "requested";
259
+ delete upload.failureCode;
260
+ await this.saveState(state);
261
+ if (upload.preparationStarted && upload.preparedAt === undefined)
262
+ throw new Error("The preparation time is missing. Restore the original queue before abandonment.");
263
+ return {
264
+ requestId: upload.requestId,
265
+ preparedAt: upload.preparedAt,
266
+ confirmed: upload.abandonment === "confirmed",
267
+ };
268
+ });
269
+ if (!cancellation)
270
+ return { status: "not-found", jobId };
271
+ if (cancellation.completed !== undefined)
272
+ return { status: "completed", jobId, attachment: cancellation.completed };
273
+ if (!cancellation.confirmed && cancellation.preparedAt !== undefined) {
274
+ if (!this.remoteObjectStore?.abandonUpload)
275
+ throw new Error("The storage broker must support abandonment by original upload identity. The queue remains retained.");
276
+ try {
277
+ await this.remoteObjectStore.abandonUpload({
278
+ requestId: cancellation.requestId,
279
+ preparedAt: cancellation.preparedAt,
280
+ });
281
+ }
282
+ catch {
283
+ await this.scheduleAbandonmentRetry(jobId);
284
+ return { status: "pending", jobId };
285
+ }
286
+ }
287
+ try {
288
+ await artifacts.withExclusiveAccess(async () => {
289
+ const state = await this.loadState();
290
+ const job = state.jobs.find((item) => item.jobId === jobId);
291
+ if (!job)
292
+ return;
293
+ const upload = state.uploads.get(jobId);
294
+ if (upload?.requestId !== cancellation.requestId ||
295
+ upload.preparedAt !== cancellation.preparedAt ||
296
+ upload.abandonment === undefined)
297
+ throw new MediaQueueConcurrentUpdateError();
298
+ state.activeJobId = jobId;
299
+ upload.abandonment = "confirmed";
300
+ await this.saveState(state);
301
+ await artifacts.delete(upload.requestId);
302
+ state.jobs = state.jobs.filter((item) => item.jobId !== jobId);
303
+ this.deleteJobSidecarState(state, job);
304
+ await this.saveState(state);
305
+ });
306
+ return { status: "abandoned", jobId };
307
+ }
308
+ catch (error) {
309
+ if (error instanceof MediaQueueConcurrentUpdateError)
310
+ throw error;
311
+ await this.scheduleAbandonmentRetry(jobId);
312
+ return { status: "pending", jobId };
313
+ }
314
+ }
315
+ async scheduleAbandonmentRetry(jobId) {
316
+ await this.config.preparedUploads.withExclusiveAccess(async () => {
317
+ const state = await this.loadState();
318
+ const job = state.jobs.find((item) => item.jobId === jobId);
319
+ if (!job || state.uploads.get(jobId)?.abandonment === undefined)
320
+ return;
321
+ state.activeJobId = jobId;
322
+ state.jobs = state.jobs.map((item) => item.jobId === jobId
323
+ ? {
324
+ ...item,
325
+ attempt: item.attempt + 1,
326
+ notBefore: nextRetryTimestamp(item, Date.now(), this.config),
327
+ }
328
+ : item);
329
+ await this.saveState(state);
330
+ });
331
+ }
191
332
  async cleanup(input, options = {}) {
192
333
  const jobs = await this.enqueueCleanupJobs(input);
193
334
  const results = [];
@@ -195,19 +336,46 @@ export class StorageBackedSignalProtocolClientMedia {
195
336
  results.push(await this.processJob(job.jobId, options));
196
337
  }
197
338
  return {
198
- status: results.every((result) => result.status === 'completed') ? 'completed' : 'pending',
339
+ status: results.every((result) => result.status === "completed")
340
+ ? "completed"
341
+ : "pending",
199
342
  jobs: results,
200
343
  };
201
344
  }
202
345
  async enqueueUploadJob(input) {
346
+ assertPreparedUploadByteLimit(this.config?.maxPreparedUploadBytes);
203
347
  const job = planMediaAttachmentUploadJob(input);
204
348
  const requestId = input.requestId ?? (await generateMediaAttachmentUploadRequestId());
205
349
  await this.updateState((state) => {
206
- const existingUpload = state.uploads.get(job.jobId);
350
+ const existingUpload = state.uploads.get(job.jobId) ??
351
+ [...state.uploads.values()].find((upload) => upload.localMediaId === input.localMediaId ||
352
+ upload.requestId === input.requestId);
353
+ if (existingUpload) {
354
+ if (existingUpload.abandonment !== undefined)
355
+ throw new Error("This upload is being abandoned. Complete its cleanup before starting another upload.");
356
+ if (existingUpload.localMediaId !== input.localMediaId)
357
+ throw new Error("The queued upload request ID belongs to another local attachment.");
358
+ const incoming = {
359
+ ...uploadOptionsFromStoredUpload({
360
+ ...input,
361
+ requestId: input.requestId ?? existingUpload.requestId,
362
+ }),
363
+ size: input.size,
364
+ };
365
+ const existing = {
366
+ ...uploadOptionsFromStoredUpload(existingUpload),
367
+ size: existingUpload.size,
368
+ };
369
+ if (JSON.stringify(incoming) !== JSON.stringify(existing)) {
370
+ throw new Error("The queued upload changed. Retry with the original upload input.");
371
+ }
372
+ state.jobs = this.normalizeJobs([...state.jobs, job]);
373
+ return;
374
+ }
207
375
  state.jobs = this.normalizeJobs([...state.jobs, job]);
208
376
  state.uploads.set(job.jobId, {
209
377
  localMediaId: input.localMediaId,
210
- requestId: existingUpload?.requestId ?? requestId,
378
+ requestId,
211
379
  contentType: input.contentType,
212
380
  size: input.size,
213
381
  policy: input.policy,
@@ -255,32 +423,77 @@ export class StorageBackedSignalProtocolClientMedia {
255
423
  async processPendingLocked(options) {
256
424
  const now = options.now ?? Date.now();
257
425
  const limit = options.limit ?? 5;
258
- const maxAttempts = this.config?.maxAttempts ?? SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_ATTEMPTS_DEFAULT;
426
+ const maxAttempts = this.config?.maxAttempts ??
427
+ SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_ATTEMPTS_DEFAULT;
428
+ const initial = await this.loadState();
429
+ const cancellations = initial.jobs
430
+ .filter((job) => job.notBefore <= now &&
431
+ initial.uploads.get(job.jobId)?.abandonment !== undefined)
432
+ .slice(0, limit);
433
+ let abandoned = 0;
434
+ for (const job of cancellations) {
435
+ try {
436
+ const result = await this.abandonUploadLocked(job.jobId);
437
+ if (result.status === "abandoned" || result.status === "not-found")
438
+ abandoned++;
439
+ }
440
+ catch (error) {
441
+ if (error instanceof MediaQueueConcurrentUpdateError)
442
+ throw error;
443
+ await this.scheduleAbandonmentRetry(job.jobId);
444
+ }
445
+ }
259
446
  const state = await this.loadState();
260
- const dueJobs = state.jobs.filter((job) => job.notBefore <= now).slice(0, limit);
261
- return this.processJobsLocked(state, dueJobs, options, now, maxAttempts);
447
+ const dueJobs = state.jobs
448
+ .filter((job) => job.notBefore <= now &&
449
+ job.attempt < maxAttempts &&
450
+ state.uploads.get(job.jobId)?.abandonment === undefined &&
451
+ state.uploads.get(job.jobId)?.failureCode === undefined)
452
+ .slice(0, Math.max(0, limit - cancellations.length));
453
+ const result = await this.processJobsLocked(state, dueJobs, options, now, maxAttempts);
454
+ return {
455
+ ...result,
456
+ attempted: result.attempted + cancellations.length,
457
+ failed: result.failed + cancellations.length - abandoned,
458
+ abandoned,
459
+ };
262
460
  }
263
461
  async processJob(jobId, options) {
264
462
  return this.withStoreLock(async () => {
265
463
  const now = options.now ?? Date.now();
266
- const maxAttempts = this.config?.maxAttempts ?? SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_ATTEMPTS_DEFAULT;
464
+ const maxAttempts = this.config?.maxAttempts ??
465
+ SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_ATTEMPTS_DEFAULT;
267
466
  const state = await this.loadState();
268
467
  const job = state.jobs.find((candidate) => candidate.jobId === jobId);
269
468
  if (!job) {
270
- return { status: 'failed', jobId };
469
+ return { status: "failed", jobId };
271
470
  }
272
471
  if (job.notBefore > now) {
273
- return { status: 'pending', jobId };
472
+ return { status: "pending", jobId };
473
+ }
474
+ // Only an explicit upload call retries a retained broker refusal.
475
+ const savedUpload = state.uploads.get(jobId);
476
+ if (savedUpload?.abandonment !== undefined)
477
+ throw new Error("This upload is being abandoned. Retry cleanup with processPending().");
478
+ state.activeJobId = jobId;
479
+ if (savedUpload?.failureCode !== undefined) {
480
+ delete savedUpload.failureCode;
481
+ await this.saveState(state);
274
482
  }
275
483
  const result = await this.processJobsLocked(state, [job], options, now, maxAttempts);
276
484
  const execution = result.results.find((candidate) => candidate.job.jobId === jobId);
277
485
  if (execution?.status === MediaAttachmentJobExecutionStatus.Completed) {
278
- return { status: 'completed', jobId, execution };
486
+ return { status: "completed", jobId, execution };
279
487
  }
280
488
  if (execution?.status === MediaAttachmentJobExecutionStatus.Skipped) {
281
- return { status: 'skipped', jobId, execution };
489
+ return { status: "skipped", jobId, execution };
282
490
  }
283
- return result.expired > 0 ? { status: 'failed', jobId } : { status: 'pending', jobId };
491
+ const uploadFailure = result.uploadFailures.find((candidate) => candidate.jobId === jobId);
492
+ if (uploadFailure)
493
+ return { status: "failed", jobId, failure: uploadFailure.failure };
494
+ return result.expired > 0
495
+ ? { status: "failed", jobId }
496
+ : { status: "pending", jobId };
284
497
  });
285
498
  }
286
499
  async processJobsLocked(state, jobs, options, now, maxAttempts) {
@@ -290,14 +503,45 @@ export class StorageBackedSignalProtocolClientMedia {
290
503
  let skipped = 0;
291
504
  let failed = 0;
292
505
  let expired = 0;
506
+ const uploadFailures = state.jobs.flatMap((job) => {
507
+ const code = state.uploads.get(job.jobId)?.failureCode;
508
+ return code === undefined
509
+ ? []
510
+ : [{ jobId: job.jobId, failure: remoteObjectUploadFailure(code) }];
511
+ });
293
512
  if (jobs.length === 0) {
294
- return { attempted: 0, completed, skipped, failed, expired, results };
513
+ return {
514
+ attempted: 0,
515
+ abandoned: 0,
516
+ completed,
517
+ skipped,
518
+ failed,
519
+ expired,
520
+ results,
521
+ uploadFailures,
522
+ };
295
523
  }
296
524
  for (const job of jobs) {
525
+ state.activeJobId = job.jobId;
526
+ // Persist progress from each job before external effects for the next job.
527
+ state.jobs = [...retained.values()];
528
+ if (job.operation === MediaAttachmentJobOperation.Upload &&
529
+ !this.config?.preparedUploads) {
530
+ throw new Error("Configure media.preparedUploads with durable local file storage before uploading.");
531
+ }
532
+ if (job.operation === MediaAttachmentJobOperation.Upload)
533
+ assertPreparedUploadByteLimit(this.config?.maxPreparedUploadBytes);
297
534
  try {
298
535
  const execution = await executeMediaAttachmentJob(job, this.createExecutionOptions(job, state, options));
299
- results.push(execution);
300
536
  if (execution.status === MediaAttachmentJobExecutionStatus.Completed) {
537
+ if (job.operation === MediaAttachmentJobOperation.Upload) {
538
+ const upload = state.uploads.get(job.jobId);
539
+ if (upload?.preparedFingerprint)
540
+ await this.config.preparedUploads.withExclusiveAccess(async () => {
541
+ await this.saveState(state);
542
+ await this.config.preparedUploads.delete(upload.requestId);
543
+ });
544
+ }
301
545
  completed += 1;
302
546
  retained.delete(job.jobId);
303
547
  this.deleteJobSidecarState(state, job);
@@ -307,12 +551,35 @@ export class StorageBackedSignalProtocolClientMedia {
307
551
  retained.delete(job.jobId);
308
552
  this.deleteJobSidecarState(state, job);
309
553
  }
554
+ results.push(execution);
310
555
  }
311
- catch {
556
+ catch (error) {
557
+ if (error instanceof MediaQueueConcurrentUpdateError)
558
+ throw error;
312
559
  failed += 1;
560
+ const upload = state.uploads.get(job.jobId);
561
+ if (job.operation === MediaAttachmentJobOperation.Upload &&
562
+ upload &&
563
+ error instanceof RemoteObjectUploadError) {
564
+ upload.failureCode = error.code;
565
+ uploadFailures.push({
566
+ jobId: job.jobId,
567
+ failure: remoteObjectUploadFailure(error.code),
568
+ });
569
+ retained.set(job.jobId, { ...job, attempt: job.attempt + 1 });
570
+ state.jobs = [...retained.values()];
571
+ await this.saveState(state);
572
+ continue;
573
+ }
313
574
  const nextAttempt = job.attempt + 1;
314
575
  if (nextAttempt >= maxAttempts) {
315
576
  expired += 1;
577
+ // The artifact can commit before its reply or queue fingerprint persists.
578
+ if (job.operation === MediaAttachmentJobOperation.Upload &&
579
+ (upload?.preparationStarted || upload?.preparedFingerprint)) {
580
+ retained.set(job.jobId, { ...job, attempt: nextAttempt });
581
+ continue;
582
+ }
316
583
  retained.delete(job.jobId);
317
584
  this.deleteJobSidecarState(state, job);
318
585
  continue;
@@ -323,32 +590,131 @@ export class StorageBackedSignalProtocolClientMedia {
323
590
  notBefore: nextRetryTimestamp(job, now, this.config),
324
591
  });
325
592
  }
593
+ state.jobs = [...retained.values()];
594
+ await this.saveState(state);
326
595
  }
327
- await this.saveState({
328
- jobs: this.normalizeJobs([...retained.values()]),
329
- uploads: state.uploads,
330
- pointers: state.pointers,
331
- });
596
+ state.jobs = this.normalizeJobs([...retained.values()]);
597
+ await this.saveState(state);
332
598
  return {
333
599
  attempted: jobs.length,
600
+ abandoned: 0,
334
601
  completed,
335
602
  skipped,
336
603
  failed,
337
604
  expired,
338
605
  results,
606
+ uploadFailures,
607
+ };
608
+ }
609
+ /** Persist broker identity before the transfer code receives its short-lived URL. */
610
+ uploadBrokerForJob(job, state, broker) {
611
+ return {
612
+ createUpload: async (input) => {
613
+ const upload = state.uploads.get(job.jobId);
614
+ if (!upload?.preparedFingerprint ||
615
+ input.requestId !== upload.requestId) {
616
+ throw new MediaAttachmentError("The upload has no matching durable preparation.", MediaAttachmentErrorCode.UploadIdentityChanged);
617
+ }
618
+ const grant = await broker.createUpload(input);
619
+ if (typeof grant.objectId !== "string" ||
620
+ grant.objectId.length === 0 ||
621
+ (upload.remoteObjectId !== undefined &&
622
+ upload.remoteObjectId !== grant.objectId)) {
623
+ throw new MediaAttachmentError("The broker changed the saved upload identity.", MediaAttachmentErrorCode.UploadIdentityChanged);
624
+ }
625
+ upload.remoteObjectId = grant.objectId;
626
+ // Repeat this write after an uncertain result, including retries within one invocation.
627
+ await this.saveState(state);
628
+ return grant;
629
+ },
630
+ createDownload: (input) => broker.createDownload(input),
631
+ ...(broker.reconcileUpload
632
+ ? {
633
+ reconcileUpload: async (input) => {
634
+ if (state.uploads.get(job.jobId)?.remoteObjectId !== input.objectId) {
635
+ throw new MediaAttachmentError("The reconciliation request differs from the saved upload identity.", MediaAttachmentErrorCode.UploadIdentityChanged);
636
+ }
637
+ return broker.reconcileUpload(input);
638
+ },
639
+ }
640
+ : {}),
641
+ completeUpload: async (input) => {
642
+ const upload = state.uploads.get(job.jobId);
643
+ if (!upload?.remoteObjectId ||
644
+ input.objectId !== upload.remoteObjectId) {
645
+ throw new MediaAttachmentError("The completion request differs from the saved upload identity.", MediaAttachmentErrorCode.UploadIdentityChanged);
646
+ }
647
+ upload.transferCompletedAt ??= Date.now();
648
+ // Persist successful transfer before completion can change the remote state.
649
+ await this.saveState(state);
650
+ await broker.completeUpload?.(input);
651
+ },
652
+ ...(broker.deleteObject
653
+ ? { deleteObject: (input) => broker.deleteObject(input) }
654
+ : {}),
339
655
  };
340
656
  }
657
+ async recoverCompletedUpload(job, state, broker, options) {
658
+ const completed = state.pointers.get(job.jobId);
659
+ if (completed)
660
+ return completed;
661
+ const upload = state.uploads.get(job.jobId);
662
+ if (!upload?.remoteObjectId)
663
+ return null;
664
+ if (upload.transferCompletedAt === undefined && !broker.reconcileUpload)
665
+ return null;
666
+ if (options.signal?.aborted)
667
+ throw new MediaAttachmentError("Media attachment operation cancelled", MediaAttachmentErrorCode.Cancelled);
668
+ const prepared = await this.config.preparedUploads.load(upload.requestId);
669
+ if (!prepared ||
670
+ !preparedUploadMatchesQueue(upload, prepared) ||
671
+ (await preparedUploadFingerprint(prepared)) !==
672
+ upload.preparedFingerprint ||
673
+ prepared.ciphertext.length !== prepared.pointer.ciphertextSize ||
674
+ bytesToBase64(await sha256(prepared.ciphertext)) !==
675
+ prepared.pointer.digest) {
676
+ throw new Error("The saved upload preparation changed. Restore its original local record.");
677
+ }
678
+ const completedAt = upload.transferCompletedAt ?? Date.now();
679
+ const attachment = validateMediaAttachmentPolicy({
680
+ ...prepared.pointer,
681
+ storageId: upload.remoteObjectId,
682
+ uploadTimestamp: completedAt,
683
+ }, upload.policy ?? options.policy);
684
+ if (upload.transferCompletedAt === undefined) {
685
+ const receipt = await broker.reconcileUpload({
686
+ objectId: upload.remoteObjectId,
687
+ });
688
+ if (receipt === null)
689
+ return null;
690
+ if (!matchesUploadReceipt(receipt, {
691
+ objectId: upload.remoteObjectId,
692
+ contentLength: prepared.ciphertext.length,
693
+ digest: await sha256(prepared.ciphertext),
694
+ })) {
695
+ throw new MediaAttachmentError("The stored upload differs from its immutable preparation.", MediaAttachmentErrorCode.UploadIdentityChanged);
696
+ }
697
+ upload.transferCompletedAt = completedAt;
698
+ await this.saveState(state);
699
+ }
700
+ if (options.signal?.aborted)
701
+ throw new MediaAttachmentError("Media attachment operation cancelled", MediaAttachmentErrorCode.Cancelled);
702
+ await broker.completeUpload?.({ objectId: attachment.storageId });
703
+ return attachment;
704
+ }
341
705
  createExecutionOptions(job, state, options) {
342
706
  const remoteObjectStore = this.remoteObjectStore ?? localOnlyObjectStore;
343
707
  if (!this.remoteObjectStore &&
344
708
  (job.operation === MediaAttachmentJobOperation.Upload ||
345
709
  job.operation === MediaAttachmentJobOperation.Download ||
346
710
  job.operation === MediaAttachmentJobOperation.DeleteRemote)) {
347
- throw new Error('Cannot process Signal Protocol media operation: remoteObjectStore is not ' +
348
- 'configured on SignalProtocolClient.');
711
+ throw new Error("Cannot process Signal Protocol media operation: remoteObjectStore is not " +
712
+ "configured on SignalProtocolClient.");
349
713
  }
350
714
  return {
351
- remoteObjectStore,
715
+ remoteObjectStore: job.operation === MediaAttachmentJobOperation.Upload
716
+ ? this.uploadBrokerForJob(job, state, remoteObjectStore)
717
+ : remoteObjectStore,
352
718
  transfer: options.transfer,
353
719
  retry: options.retry,
354
720
  policy: options.policy,
@@ -357,32 +723,93 @@ export class StorageBackedSignalProtocolClientMedia {
357
723
  onCheckpoint: options.onCheckpoint,
358
724
  loadUploadData: async (job) => {
359
725
  const upload = state.uploads.get(job.jobId);
360
- if (!upload || !this.config?.loadLocalAttachment) {
726
+ if (!upload) {
361
727
  return null;
362
728
  }
363
- const loaded = normalizeLoadedLocalAttachment(await this.config.loadLocalAttachment({ ...upload, job }));
729
+ const preparedUploads = this.config?.preparedUploads;
730
+ if (!preparedUploads)
731
+ throw new Error("Configure media.preparedUploads with durable local file storage before uploading.");
732
+ let prepared = await preparedUploads.load(upload.requestId);
733
+ if (prepared) {
734
+ if (!preparedUploadMatchesQueue(upload, prepared) ||
735
+ (upload.preparedFingerprint !== undefined &&
736
+ (await preparedUploadFingerprint(prepared)) !==
737
+ upload.preparedFingerprint)) {
738
+ throw new Error("The saved upload preparation changed. Restore its original local record.");
739
+ }
740
+ if (upload.preparedFingerprint === undefined) {
741
+ upload.preparedFingerprint =
742
+ await preparedUploadFingerprint(prepared);
743
+ await this.saveState(state);
744
+ }
745
+ return { prepared, options: uploadOptionsFromStoredUpload(upload) };
746
+ }
747
+ else if (upload.preparedFingerprint !== undefined) {
748
+ throw new Error("The saved upload preparation is missing. Restore its original local record.");
749
+ }
750
+ if (!this.config?.loadLocalAttachment)
751
+ return null;
752
+ const draft = { ...upload, job };
753
+ delete draft.preparedFingerprint;
754
+ delete draft.preparationStarted;
755
+ delete draft.preparedAt;
756
+ delete draft.abandonment;
757
+ delete draft.remoteObjectId;
758
+ delete draft.transferCompletedAt;
759
+ delete draft.callbackDelivered;
760
+ const loaded = normalizeLoadedLocalAttachment(await this.config.loadLocalAttachment(draft));
364
761
  if (!loaded) {
365
762
  return null;
366
763
  }
367
- return {
368
- data: loaded.data,
369
- options: {
370
- ...uploadOptionsFromStoredUpload(upload),
371
- ...loaded.options,
372
- },
373
- };
764
+ const storedOptions = uploadOptionsFromStoredUpload(upload);
765
+ for (const key of Object.keys(storedOptions)) {
766
+ if (loaded.options?.[key] !== undefined &&
767
+ JSON.stringify(loaded.options[key]) !==
768
+ JSON.stringify(storedOptions[key])) {
769
+ throw new Error("The attachment loader changed the queued upload input.");
770
+ }
771
+ }
772
+ if (loaded.data.length !== upload.size)
773
+ throw new Error("The attachment length differs from the queued upload.");
774
+ await this.saveState(state);
775
+ const candidate = await prepareMediaAttachmentUploadData(loaded.data, {
776
+ ...loaded.options,
777
+ ...storedOptions,
778
+ signal: options.signal,
779
+ onProgress: options.onProgress,
780
+ });
781
+ // Preserve intent if artifact persistence succeeds but its result is lost.
782
+ prepared = await preparedUploads.withExclusiveAccess(async () => {
783
+ upload.preparationStarted = true;
784
+ upload.preparedAt = candidate.preparedAt;
785
+ await this.saveState(state);
786
+ return preparedUploads.createIfAbsent(candidate);
787
+ });
788
+ if (!samePreparedUploadIntent(candidate, prepared, upload.clientUuid !== undefined)) {
789
+ throw new Error("The stored preparation belongs to different upload input.");
790
+ }
791
+ upload.preparedFingerprint = await preparedUploadFingerprint(prepared);
792
+ await this.saveState(state);
793
+ return { prepared, options: { ...loaded.options, ...storedOptions } };
374
794
  },
795
+ loadUploadedAttachment: (job) => this.recoverCompletedUpload(job, state, remoteObjectStore, options),
375
796
  loadAttachmentPointer: async (job) => state.pointers.get(job.jobId) ?? null,
376
797
  saveUploadedAttachment: async (job, attachment) => {
377
798
  const upload = state.uploads.get(job.jobId);
378
799
  if (!upload) {
379
800
  return;
380
801
  }
802
+ if (upload.callbackDelivered)
803
+ return;
804
+ state.pointers.set(job.jobId, createMediaAttachmentPointer(attachment));
805
+ await this.saveState(state);
381
806
  await this.config?.saveUploadedAttachment?.({
382
807
  job,
383
808
  localMediaId: upload.localMediaId,
384
809
  attachment,
385
810
  });
811
+ upload.callbackDelivered = true;
812
+ await this.saveState(state);
386
813
  },
387
814
  saveDownloadedAttachment: async (job, downloaded) => {
388
815
  await this.config?.saveDownloadedAttachment?.({
@@ -408,7 +835,8 @@ export class StorageBackedSignalProtocolClientMedia {
408
835
  state.pointers.delete(job.jobId);
409
836
  }
410
837
  normalizeJobs(jobs) {
411
- return normalizeJobs(jobs, this.config?.maxJobs ?? SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_JOBS_DEFAULT);
838
+ return normalizeJobs(jobs, this.config?.maxJobs ??
839
+ SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_JOBS_DEFAULT);
412
840
  }
413
841
  async withStoreLock(operation) {
414
842
  const previous = this.storeLock;
@@ -426,26 +854,44 @@ export class StorageBackedSignalProtocolClientMedia {
426
854
  }
427
855
  async updateState(mutator) {
428
856
  await this.withStoreLock(async () => {
429
- const state = await this.loadState();
430
- mutator(state);
431
- await this.saveState(state);
857
+ for (let attempt = 0; attempt < 16; attempt++) {
858
+ const state = await this.loadState();
859
+ mutator(state);
860
+ try {
861
+ await this.saveState(state);
862
+ return;
863
+ }
864
+ catch (error) {
865
+ if (!(error instanceof MediaQueueConcurrentUpdateError))
866
+ throw error;
867
+ }
868
+ }
869
+ throw new MediaQueueConcurrentUpdateError();
432
870
  });
433
871
  }
434
872
  async loadState() {
435
873
  const raw = await this.storage.getMetadata(SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_METADATA_KEY);
436
874
  if (!raw) {
437
- return { jobs: [], uploads: new Map(), pointers: new Map() };
875
+ const state = { jobs: [], uploads: new Map(), pointers: new Map() };
876
+ this.queuePersistence.capture(state, raw);
877
+ return state;
438
878
  }
439
879
  try {
440
880
  const parsed = JSON.parse(raw);
441
881
  if (parsed.version !== 1) {
442
- return { jobs: [], uploads: new Map(), pointers: new Map() };
882
+ throw new Error("Invalid media queue version.");
443
883
  }
884
+ if (!Array.isArray(parsed.jobs) ||
885
+ !isRecord(parsed.uploads) ||
886
+ !isRecord(parsed.pointers))
887
+ throw new Error("Invalid media queue structure.");
444
888
  const uploads = new Map();
445
889
  for (const [jobId, upload] of Object.entries(parsed.uploads ?? {})) {
446
890
  if (isStoredUpload(upload)) {
447
891
  uploads.set(jobId, upload);
448
892
  }
893
+ else
894
+ throw new Error("Invalid media upload record.");
449
895
  }
450
896
  const pointers = new Map();
451
897
  for (const [jobId, pointer] of Object.entries(parsed.pointers ?? {})) {
@@ -453,24 +899,46 @@ export class StorageBackedSignalProtocolClientMedia {
453
899
  if (normalized) {
454
900
  pointers.set(jobId, normalized);
455
901
  }
902
+ else
903
+ throw new Error("Invalid media pointer record.");
456
904
  }
457
- return {
458
- jobs: this.normalizeJobs(Array.isArray(parsed.jobs) ? parsed.jobs : []),
905
+ for (const job of parsed.jobs) {
906
+ if (job.operation === MediaAttachmentJobOperation.Upload) {
907
+ const upload = uploads.get(job.jobId);
908
+ if (!upload ||
909
+ (upload.remoteObjectId !== undefined &&
910
+ !upload.preparedFingerprint) ||
911
+ (upload.transferCompletedAt !== undefined &&
912
+ !upload.remoteObjectId) ||
913
+ (pointers.has(job.jobId) &&
914
+ (upload.transferCompletedAt === undefined ||
915
+ pointers.get(job.jobId).storageId !==
916
+ upload.remoteObjectId)) ||
917
+ (upload.callbackDelivered && !pointers.has(job.jobId))) {
918
+ throw new Error("Incomplete media upload record.");
919
+ }
920
+ }
921
+ }
922
+ const state = {
923
+ jobs: this.normalizeJobs(parsed.jobs),
459
924
  uploads,
460
925
  pointers,
461
926
  };
927
+ this.queuePersistence.capture(state, raw);
928
+ return state;
462
929
  }
463
930
  catch {
464
- return { jobs: [], uploads: new Map(), pointers: new Map() };
931
+ throw new Error("The saved media queue is invalid. Restore its original local state before retrying.");
465
932
  }
466
933
  }
467
934
  async saveState(state) {
468
- await this.storage.setMetadata(SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_METADATA_KEY, JSON.stringify({
935
+ await this.queuePersistence.save(state, JSON.stringify({
469
936
  version: 1,
470
937
  jobs: this.normalizeJobs(state.jobs),
471
938
  uploads: Object.fromEntries(state.uploads),
472
939
  pointers: Object.fromEntries(state.pointers),
473
- }));
940
+ }), this.config?.maxJobs ??
941
+ SIGNAL_PROTOCOL_CLIENT_MEDIA_QUEUE_MAX_JOBS_DEFAULT, state.activeJobId, this.config?.maxPreparedUploadBytes);
474
942
  }
475
943
  }
476
944
  //# sourceMappingURL=media.js.map