@open-e2ee/signal-protocol-sdk 10.1.0 → 12.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (595) hide show
  1. package/ADAPTERS.md +4 -4
  2. package/ARCHITECTURE.md +6 -8
  3. package/CHANGELOG.md +1413 -0
  4. package/README.md +1 -1
  5. package/SECURITY.md +2 -2
  6. package/TROUBLESHOOTING.md +1 -1
  7. package/client/README.md +84 -37
  8. package/device/README.md +39 -85
  9. package/dist/client/client.d.ts +342 -62
  10. package/dist/client/client.d.ts.map +1 -1
  11. package/dist/client/client.js +1195 -179
  12. package/dist/client/client.js.map +1 -1
  13. package/dist/client/config.d.ts +40 -32
  14. package/dist/client/config.d.ts.map +1 -1
  15. package/dist/client/config.js +1 -1
  16. package/dist/client/config.js.map +1 -1
  17. package/dist/client/constants.d.ts +42 -8
  18. package/dist/client/constants.d.ts.map +1 -1
  19. package/dist/client/constants.js +48 -3
  20. package/dist/client/constants.js.map +1 -1
  21. package/dist/client/content-adapter.d.ts +80 -0
  22. package/dist/client/content-adapter.d.ts.map +1 -1
  23. package/dist/client/content-adapter.js +225 -12
  24. package/dist/client/content-adapter.js.map +1 -1
  25. package/dist/client/delivery-error.d.ts +150 -0
  26. package/dist/client/delivery-error.d.ts.map +1 -0
  27. package/dist/client/delivery-error.js +226 -0
  28. package/dist/client/delivery-error.js.map +1 -0
  29. package/dist/client/delivery-status.d.ts +32 -6
  30. package/dist/client/delivery-status.d.ts.map +1 -1
  31. package/dist/client/delivery-status.js +61 -13
  32. package/dist/client/delivery-status.js.map +1 -1
  33. package/dist/client/device-set-reconciliation.d.ts +196 -0
  34. package/dist/client/device-set-reconciliation.d.ts.map +1 -0
  35. package/dist/client/device-set-reconciliation.js +282 -0
  36. package/dist/client/device-set-reconciliation.js.map +1 -0
  37. package/dist/client/distribution-records.d.ts +29 -0
  38. package/dist/client/distribution-records.d.ts.map +1 -0
  39. package/dist/client/distribution-records.js +33 -0
  40. package/dist/client/distribution-records.js.map +1 -0
  41. package/dist/client/event-hooks.d.ts +308 -6
  42. package/dist/client/event-hooks.d.ts.map +1 -1
  43. package/dist/client/event-hooks.js +9 -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-device-standing.d.ts +52 -0
  82. package/dist/client/hosted-device-standing.d.ts.map +1 -0
  83. package/dist/client/hosted-device-standing.js +74 -0
  84. package/dist/client/hosted-device-standing.js.map +1 -0
  85. package/dist/client/hosted-mailbox-subscription.d.ts +48 -3
  86. package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -1
  87. package/dist/client/hosted-mailbox-subscription.js +288 -74
  88. package/dist/client/hosted-mailbox-subscription.js.map +1 -1
  89. package/dist/client/hosted-push.d.ts +22 -4
  90. package/dist/client/hosted-push.d.ts.map +1 -1
  91. package/dist/client/hosted-push.js +75 -22
  92. package/dist/client/hosted-push.js.map +1 -1
  93. package/dist/client/hosted-transport.d.ts +22 -28
  94. package/dist/client/hosted-transport.d.ts.map +1 -1
  95. package/dist/client/hosted-transport.js +167 -69
  96. package/dist/client/hosted-transport.js.map +1 -1
  97. package/dist/client/hosted.d.ts +22 -5
  98. package/dist/client/hosted.d.ts.map +1 -1
  99. package/dist/client/hosted.js +122 -45
  100. package/dist/client/hosted.js.map +1 -1
  101. package/dist/client/index.d.ts +6 -4
  102. package/dist/client/index.d.ts.map +1 -1
  103. package/dist/client/index.js +3 -1
  104. package/dist/client/index.js.map +1 -1
  105. package/dist/client/messages.d.ts +25 -3
  106. package/dist/client/messages.d.ts.map +1 -1
  107. package/dist/client/messages.js +118 -17
  108. package/dist/client/messages.js.map +1 -1
  109. package/dist/client/one-time-prekey-refill.d.ts +7 -0
  110. package/dist/client/one-time-prekey-refill.d.ts.map +1 -1
  111. package/dist/client/one-time-prekey-refill.js +5 -1
  112. package/dist/client/one-time-prekey-refill.js.map +1 -1
  113. package/dist/client/receive-admission.d.ts +58 -0
  114. package/dist/client/receive-admission.d.ts.map +1 -0
  115. package/dist/client/receive-admission.js +78 -0
  116. package/dist/client/receive-admission.js.map +1 -0
  117. package/dist/client/receive-expiry.d.ts +31 -0
  118. package/dist/client/receive-expiry.d.ts.map +1 -0
  119. package/dist/client/receive-expiry.js +35 -0
  120. package/dist/client/receive-expiry.js.map +1 -0
  121. package/dist/client/receive-hook-bound.d.ts +50 -0
  122. package/dist/client/receive-hook-bound.d.ts.map +1 -0
  123. package/dist/client/receive-hook-bound.js +115 -0
  124. package/dist/client/receive-hook-bound.js.map +1 -0
  125. package/dist/client/receive-queue.d.ts +299 -0
  126. package/dist/client/receive-queue.d.ts.map +1 -0
  127. package/dist/client/receive-queue.js +1420 -0
  128. package/dist/client/receive-queue.js.map +1 -0
  129. package/dist/client/receive-work-seed.d.ts +54 -0
  130. package/dist/client/receive-work-seed.d.ts.map +1 -0
  131. package/dist/client/receive-work-seed.js +116 -0
  132. package/dist/client/receive-work-seed.js.map +1 -0
  133. package/dist/client/recovery-driver.d.ts +25 -0
  134. package/dist/client/recovery-driver.d.ts.map +1 -0
  135. package/dist/client/recovery-driver.js +121 -0
  136. package/dist/client/recovery-driver.js.map +1 -0
  137. package/dist/client/relay-acceptance.d.ts +30 -0
  138. package/dist/client/relay-acceptance.d.ts.map +1 -1
  139. package/dist/client/relay-acceptance.js +55 -0
  140. package/dist/client/relay-acceptance.js.map +1 -1
  141. package/dist/client/relay-device-refusal.d.ts +18 -0
  142. package/dist/client/relay-device-refusal.d.ts.map +1 -1
  143. package/dist/client/relay-device-refusal.js +31 -0
  144. package/dist/client/relay-device-refusal.js.map +1 -1
  145. package/dist/client/relay-sealed-route.d.ts +36 -0
  146. package/dist/client/relay-sealed-route.d.ts.map +1 -0
  147. package/dist/client/relay-sealed-route.js +45 -0
  148. package/dist/client/relay-sealed-route.js.map +1 -0
  149. package/dist/client/relay-subscription.d.ts +56 -13
  150. package/dist/client/relay-subscription.d.ts.map +1 -1
  151. package/dist/client/relay-subscription.js +220 -150
  152. package/dist/client/relay-subscription.js.map +1 -1
  153. package/dist/client/resendable-content.d.ts +98 -0
  154. package/dist/client/resendable-content.d.ts.map +1 -0
  155. package/dist/client/resendable-content.js +136 -0
  156. package/dist/client/resendable-content.js.map +1 -0
  157. package/dist/client/retry-family.d.ts +68 -19
  158. package/dist/client/retry-family.d.ts.map +1 -1
  159. package/dist/client/retry-family.js +59 -17
  160. package/dist/client/retry-family.js.map +1 -1
  161. package/dist/client/retry-request-envelope.d.ts +145 -18
  162. package/dist/client/retry-request-envelope.d.ts.map +1 -1
  163. package/dist/client/retry-request-envelope.js +301 -64
  164. package/dist/client/retry-request-envelope.js.map +1 -1
  165. package/dist/client/retry-request-lifecycle.d.ts +157 -0
  166. package/dist/client/retry-request-lifecycle.d.ts.map +1 -0
  167. package/dist/client/retry-request-lifecycle.js +437 -0
  168. package/dist/client/retry-request-lifecycle.js.map +1 -0
  169. package/dist/client/retry-terminal-recovery.d.ts +100 -0
  170. package/dist/client/retry-terminal-recovery.d.ts.map +1 -0
  171. package/dist/client/retry-terminal-recovery.js +164 -0
  172. package/dist/client/retry-terminal-recovery.js.map +1 -0
  173. package/dist/client/retry-utils.d.ts +27 -0
  174. package/dist/client/retry-utils.d.ts.map +1 -1
  175. package/dist/client/retry-utils.js +46 -0
  176. package/dist/client/retry-utils.js.map +1 -1
  177. package/dist/client/retry.d.ts +106 -18
  178. package/dist/client/retry.d.ts.map +1 -1
  179. package/dist/client/retry.js +687 -139
  180. package/dist/client/retry.js.map +1 -1
  181. package/dist/client/sealed-sender.d.ts +23 -6
  182. package/dist/client/sealed-sender.d.ts.map +1 -1
  183. package/dist/client/sealed-sender.js +30 -6
  184. package/dist/client/sealed-sender.js.map +1 -1
  185. package/dist/client/sessions.d.ts +2 -2
  186. package/dist/client/sessions.js +2 -2
  187. package/dist/client/signal-service-cipher.d.ts +726 -19
  188. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  189. package/dist/client/signal-service-cipher.js +2265 -343
  190. package/dist/client/signal-service-cipher.js.map +1 -1
  191. package/dist/client/state.d.ts +5 -0
  192. package/dist/client/state.d.ts.map +1 -1
  193. package/dist/client/state.js +11 -1
  194. package/dist/client/state.js.map +1 -1
  195. package/dist/client/storage-protection.d.ts +64 -0
  196. package/dist/client/storage-protection.d.ts.map +1 -0
  197. package/dist/client/storage-protection.js +150 -0
  198. package/dist/client/storage-protection.js.map +1 -0
  199. package/dist/client/types.d.ts +149 -15
  200. package/dist/client/types.d.ts.map +1 -1
  201. package/dist/client/types.js +1 -1
  202. package/dist/client/types.js.map +1 -1
  203. package/dist/device/constants.d.ts +0 -5
  204. package/dist/device/constants.d.ts.map +1 -1
  205. package/dist/device/constants.js +0 -5
  206. package/dist/device/constants.js.map +1 -1
  207. package/dist/device/expo/index.d.ts +4 -17
  208. package/dist/device/expo/index.d.ts.map +1 -1
  209. package/dist/device/expo/index.js +4 -23
  210. package/dist/device/expo/index.js.map +1 -1
  211. package/dist/device/index.d.ts +0 -2
  212. package/dist/device/index.d.ts.map +1 -1
  213. package/dist/device/index.js +0 -7
  214. package/dist/device/index.js.map +1 -1
  215. package/dist/device/lifecycle/manager.d.ts +5 -4
  216. package/dist/device/lifecycle/manager.d.ts.map +1 -1
  217. package/dist/device/lifecycle/manager.js +16 -16
  218. package/dist/device/lifecycle/manager.js.map +1 -1
  219. package/dist/device/lifecycle/types.d.ts +2 -2
  220. package/dist/device/lifecycle/types.d.ts.map +1 -1
  221. package/dist/device/react-native/index.d.ts +4 -15
  222. package/dist/device/react-native/index.d.ts.map +1 -1
  223. package/dist/device/react-native/index.js +4 -21
  224. package/dist/device/react-native/index.js.map +1 -1
  225. package/dist/device/types.d.ts +1 -1
  226. package/dist/groups/index.d.ts +1 -1
  227. package/dist/groups/index.d.ts.map +1 -1
  228. package/dist/index.d.ts +8 -6
  229. package/dist/index.d.ts.map +1 -1
  230. package/dist/index.js +2 -1
  231. package/dist/index.js.map +1 -1
  232. package/dist/internal/crypto/ec/x25519-validation.d.ts +0 -1
  233. package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
  234. package/dist/internal/crypto/ec/x25519-validation.js +0 -1
  235. package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
  236. package/dist/internal/crypto/validation.d.ts +2 -2
  237. package/dist/internal/groups/index.d.ts +1 -0
  238. package/dist/internal/groups/index.d.ts.map +1 -1
  239. package/dist/internal/groups/index.js +1 -0
  240. package/dist/internal/groups/index.js.map +1 -1
  241. package/dist/internal/groups/manager.d.ts +37 -16
  242. package/dist/internal/groups/manager.d.ts.map +1 -1
  243. package/dist/internal/groups/manager.js +46 -1
  244. package/dist/internal/groups/manager.js.map +1 -1
  245. package/dist/internal/groups/receive-record.d.ts +78 -0
  246. package/dist/internal/groups/receive-record.d.ts.map +1 -0
  247. package/dist/internal/groups/receive-record.js +43 -0
  248. package/dist/internal/groups/receive-record.js.map +1 -0
  249. package/dist/internal/groups/sdk-store.d.ts +27 -3
  250. package/dist/internal/groups/sdk-store.d.ts.map +1 -1
  251. package/dist/internal/groups/sdk-store.js +151 -19
  252. package/dist/internal/groups/sdk-store.js.map +1 -1
  253. package/dist/internal/groups/wire.d.ts +12 -1
  254. package/dist/internal/groups/wire.d.ts.map +1 -1
  255. package/dist/internal/groups/wire.js +36 -0
  256. package/dist/internal/groups/wire.js.map +1 -1
  257. package/dist/internal/manager/index.d.ts +1 -1
  258. package/dist/internal/manager/manager.d.ts +20 -19
  259. package/dist/internal/manager/manager.d.ts.map +1 -1
  260. package/dist/internal/manager/manager.js +56 -39
  261. package/dist/internal/manager/manager.js.map +1 -1
  262. package/dist/internal/protocol/double-ratchet/chains.d.ts +4 -18
  263. package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
  264. package/dist/internal/protocol/double-ratchet/chains.js +23 -74
  265. package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
  266. package/dist/internal/protocol/double-ratchet/index.d.ts +1 -1
  267. package/dist/internal/protocol/double-ratchet/index.d.ts.map +1 -1
  268. package/dist/internal/protocol/double-ratchet/index.js +1 -1
  269. package/dist/internal/protocol/double-ratchet/index.js.map +1 -1
  270. package/dist/internal/protocol/double-ratchet/ratchet.d.ts +5 -7
  271. package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
  272. package/dist/internal/protocol/double-ratchet/ratchet.js +4 -6
  273. package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
  274. package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
  275. package/dist/internal/protocol/pqxdh/pqxdh.js +2 -1
  276. package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
  277. package/dist/internal/protocol/sealed-sender/types.d.ts +6 -8
  278. package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
  279. package/dist/internal/protocol/sealed-sender/types.js +8 -9
  280. package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
  281. package/dist/internal/protocol/sender-keys/handoff-ledger.d.ts +110 -0
  282. package/dist/internal/protocol/sender-keys/handoff-ledger.d.ts.map +1 -0
  283. package/dist/internal/protocol/sender-keys/handoff-ledger.js +124 -0
  284. package/dist/internal/protocol/sender-keys/handoff-ledger.js.map +1 -0
  285. package/dist/internal/protocol/sender-keys/manager.d.ts +71 -62
  286. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  287. package/dist/internal/protocol/sender-keys/manager.js +228 -175
  288. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  289. package/dist/internal/protocol/spqr/index.d.ts +2 -2
  290. package/dist/internal/protocol/spqr/index.d.ts.map +1 -1
  291. package/dist/internal/protocol/spqr/index.js +2 -2
  292. package/dist/internal/protocol/spqr/index.js.map +1 -1
  293. package/dist/internal/protocol/spqr/serialize.d.ts +9 -1
  294. package/dist/internal/protocol/spqr/serialize.d.ts.map +1 -1
  295. package/dist/internal/protocol/spqr/serialize.js +56 -16
  296. package/dist/internal/protocol/spqr/serialize.js.map +1 -1
  297. package/dist/internal/protocol/spqr/spqr.d.ts +1 -14
  298. package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
  299. package/dist/internal/protocol/spqr/spqr.js +54 -42
  300. package/dist/internal/protocol/spqr/spqr.js.map +1 -1
  301. package/dist/internal/protocol/spqr/validate.d.ts +26 -6
  302. package/dist/internal/protocol/spqr/validate.d.ts.map +1 -1
  303. package/dist/internal/protocol/spqr/validate.js +49 -21
  304. package/dist/internal/protocol/spqr/validate.js.map +1 -1
  305. package/dist/internal/sesame/index.d.ts +1 -1
  306. package/dist/internal/sesame/index.d.ts.map +1 -1
  307. package/dist/internal/sesame/index.js.map +1 -1
  308. package/dist/internal/sesame/manager.d.ts +66 -13
  309. package/dist/internal/sesame/manager.d.ts.map +1 -1
  310. package/dist/internal/sesame/manager.js +221 -87
  311. package/dist/internal/sesame/manager.js.map +1 -1
  312. package/dist/internal/sesame/types.d.ts +95 -17
  313. package/dist/internal/sesame/types.d.ts.map +1 -1
  314. package/dist/internal/sesame/types.js +17 -0
  315. package/dist/internal/sesame/types.js.map +1 -1
  316. package/dist/internal/session/builder.d.ts +5 -5
  317. package/dist/internal/session/builder.d.ts.map +1 -1
  318. package/dist/internal/session/builder.js +12 -17
  319. package/dist/internal/session/builder.js.map +1 -1
  320. package/dist/internal/session/cipher.d.ts +13 -11
  321. package/dist/internal/session/cipher.d.ts.map +1 -1
  322. package/dist/internal/session/cipher.js +40 -22
  323. package/dist/internal/session/cipher.js.map +1 -1
  324. package/dist/internal/session/factory.d.ts +5 -5
  325. package/dist/internal/session/factory.d.ts.map +1 -1
  326. package/dist/internal/session/factory.js +4 -4
  327. package/dist/internal/session/factory.js.map +1 -1
  328. package/dist/internal/session/handshake.d.ts +14 -16
  329. package/dist/internal/session/handshake.d.ts.map +1 -1
  330. package/dist/internal/session/handshake.js +18 -75
  331. package/dist/internal/session/handshake.js.map +1 -1
  332. package/dist/internal/session/index.d.ts +1 -1
  333. package/dist/internal/session/index.js +1 -1
  334. package/dist/internal/session/record-locks.d.ts +17 -6
  335. package/dist/internal/session/record-locks.d.ts.map +1 -1
  336. package/dist/internal/session/record-locks.js +43 -7
  337. package/dist/internal/session/record-locks.js.map +1 -1
  338. package/dist/internal/session/session-resolver.d.ts +1 -1
  339. package/dist/internal/session/session-resolver.js +1 -1
  340. package/dist/internal/session/state.d.ts +2 -2
  341. package/dist/internal/session/state.js +1 -1
  342. package/dist/internal/session/types.d.ts +4 -12
  343. package/dist/internal/session/types.d.ts.map +1 -1
  344. package/dist/internal/session/types.js +1 -1
  345. package/dist/keys/generation.d.ts +2 -2
  346. package/dist/keys/generation.js +2 -2
  347. package/dist/keys/types.d.ts +5 -5
  348. package/dist/keys/types.d.ts.map +1 -1
  349. package/dist/keys/types.js +1 -1
  350. package/dist/layers.d.ts +1 -1
  351. package/dist/layers.js +2 -2
  352. package/dist/layers.js.map +1 -1
  353. package/dist/local/store/expo/adapter.d.ts.map +1 -1
  354. package/dist/local/store/expo/adapter.js +12 -8
  355. package/dist/local/store/expo/adapter.js.map +1 -1
  356. package/dist/local/store/key-value/adapter.d.ts +76 -10
  357. package/dist/local/store/key-value/adapter.d.ts.map +1 -1
  358. package/dist/local/store/key-value/adapter.js +367 -61
  359. package/dist/local/store/key-value/adapter.js.map +1 -1
  360. package/dist/local/store/key-value/backend-conformance.d.ts.map +1 -1
  361. package/dist/local/store/key-value/backend-conformance.js +74 -0
  362. package/dist/local/store/key-value/backend-conformance.js.map +1 -1
  363. package/dist/local/store/key-value/batch.d.ts +2 -0
  364. package/dist/local/store/key-value/batch.d.ts.map +1 -1
  365. package/dist/local/store/key-value/batch.js +26 -0
  366. package/dist/local/store/key-value/batch.js.map +1 -1
  367. package/dist/local/store/key-value/receive-work.d.ts +55 -0
  368. package/dist/local/store/key-value/receive-work.d.ts.map +1 -0
  369. package/dist/local/store/key-value/receive-work.js +162 -0
  370. package/dist/local/store/key-value/receive-work.js.map +1 -0
  371. package/dist/local/store/key-value/send-log.d.ts +61 -0
  372. package/dist/local/store/key-value/send-log.d.ts.map +1 -0
  373. package/dist/local/store/key-value/send-log.js +430 -0
  374. package/dist/local/store/key-value/send-log.js.map +1 -0
  375. package/dist/local/store/key-value/sender-key-handoff.d.ts +68 -0
  376. package/dist/local/store/key-value/sender-key-handoff.d.ts.map +1 -0
  377. package/dist/local/store/key-value/sender-key-handoff.js +189 -0
  378. package/dist/local/store/key-value/sender-key-handoff.js.map +1 -0
  379. package/dist/local/store/key-value/storage.d.ts +15 -0
  380. package/dist/local/store/key-value/storage.d.ts.map +1 -1
  381. package/dist/local/store/keyed-index.d.ts +23 -0
  382. package/dist/local/store/keyed-index.d.ts.map +1 -0
  383. package/dist/local/store/keyed-index.js +41 -0
  384. package/dist/local/store/keyed-index.js.map +1 -0
  385. package/dist/local/store/memory/adapter.d.ts +44 -12
  386. package/dist/local/store/memory/adapter.d.ts.map +1 -1
  387. package/dist/local/store/memory/adapter.js +197 -46
  388. package/dist/local/store/memory/adapter.js.map +1 -1
  389. package/dist/local/store/memory/send-log.d.ts +42 -0
  390. package/dist/local/store/memory/send-log.d.ts.map +1 -0
  391. package/dist/local/store/memory/send-log.js +190 -0
  392. package/dist/local/store/memory/send-log.js.map +1 -0
  393. package/dist/local/store/node/adapter.d.ts.map +1 -1
  394. package/dist/local/store/node/adapter.js +8 -6
  395. package/dist/local/store/node/adapter.js.map +1 -1
  396. package/dist/local/store/react-native/adapter.d.ts.map +1 -1
  397. package/dist/local/store/react-native/adapter.js +12 -8
  398. package/dist/local/store/react-native/adapter.js.map +1 -1
  399. package/dist/local/store/receive-work.d.ts +87 -0
  400. package/dist/local/store/receive-work.d.ts.map +1 -0
  401. package/dist/local/store/receive-work.js +204 -0
  402. package/dist/local/store/receive-work.js.map +1 -0
  403. package/dist/local/store/received-content.d.ts +3 -3
  404. package/dist/local/store/received-content.d.ts.map +1 -1
  405. package/dist/local/store/received-content.js +2 -11
  406. package/dist/local/store/received-content.js.map +1 -1
  407. package/dist/local/store/reliability.d.ts +411 -14
  408. package/dist/local/store/reliability.d.ts.map +1 -1
  409. package/dist/local/store/reliability.js +532 -58
  410. package/dist/local/store/reliability.js.map +1 -1
  411. package/dist/local/store/send-log-order.d.ts +15 -0
  412. package/dist/local/store/send-log-order.d.ts.map +1 -0
  413. package/dist/local/store/send-log-order.js +24 -0
  414. package/dist/local/store/send-log-order.js.map +1 -0
  415. package/dist/local/store/sender-key-handoff-index.d.ts +38 -0
  416. package/dist/local/store/sender-key-handoff-index.d.ts.map +1 -0
  417. package/dist/local/store/sender-key-handoff-index.js +101 -0
  418. package/dist/local/store/sender-key-handoff-index.js.map +1 -0
  419. package/dist/local/store/sender-key-handoff-table.d.ts +29 -0
  420. package/dist/local/store/sender-key-handoff-table.d.ts.map +1 -0
  421. package/dist/local/store/sender-key-handoff-table.js +97 -0
  422. package/dist/local/store/sender-key-handoff-table.js.map +1 -0
  423. package/dist/local/store/sqlite/encryption.d.ts +8 -1
  424. package/dist/local/store/sqlite/encryption.d.ts.map +1 -1
  425. package/dist/local/store/sqlite/encryption.js +9 -0
  426. package/dist/local/store/sqlite/encryption.js.map +1 -1
  427. package/dist/local/store/sqlite/key-storage/index.d.ts +25 -4
  428. package/dist/local/store/sqlite/key-storage/index.d.ts.map +1 -1
  429. package/dist/local/store/sqlite/key-storage/index.js +68 -7
  430. package/dist/local/store/sqlite/key-storage/index.js.map +1 -1
  431. package/dist/local/store/sqlite/key-storage/message-records.d.ts +16 -4
  432. package/dist/local/store/sqlite/key-storage/message-records.d.ts.map +1 -1
  433. package/dist/local/store/sqlite/key-storage/message-records.js +49 -6
  434. package/dist/local/store/sqlite/key-storage/message-records.js.map +1 -1
  435. package/dist/local/store/sqlite/key-storage/metadata.d.ts +8 -7
  436. package/dist/local/store/sqlite/key-storage/metadata.d.ts.map +1 -1
  437. package/dist/local/store/sqlite/key-storage/metadata.js +17 -15
  438. package/dist/local/store/sqlite/key-storage/metadata.js.map +1 -1
  439. package/dist/local/store/sqlite/key-storage/receive-work.d.ts +27 -0
  440. package/dist/local/store/sqlite/key-storage/receive-work.d.ts.map +1 -0
  441. package/dist/local/store/sqlite/key-storage/receive-work.js +98 -0
  442. package/dist/local/store/sqlite/key-storage/receive-work.js.map +1 -0
  443. package/dist/local/store/sqlite/key-storage/send-log.d.ts +27 -0
  444. package/dist/local/store/sqlite/key-storage/send-log.d.ts.map +1 -0
  445. package/dist/local/store/sqlite/key-storage/send-log.js +178 -0
  446. package/dist/local/store/sqlite/key-storage/send-log.js.map +1 -0
  447. package/dist/local/store/sqlite/key-storage/sender-key-handoff.d.ts +27 -0
  448. package/dist/local/store/sqlite/key-storage/sender-key-handoff.d.ts.map +1 -0
  449. package/dist/local/store/sqlite/key-storage/sender-key-handoff.js +75 -0
  450. package/dist/local/store/sqlite/key-storage/sender-key-handoff.js.map +1 -0
  451. package/dist/local/store/sqlite/key-storage/session-trust.d.ts +2 -2
  452. package/dist/local/store/sqlite/key-storage/session-trust.js +5 -5
  453. package/dist/local/store/sqlite/key-storage/session-trust.js.map +1 -1
  454. package/dist/local/store/sqlite/migrations.d.ts.map +1 -1
  455. package/dist/local/store/sqlite/migrations.js +101 -0
  456. package/dist/local/store/sqlite/migrations.js.map +1 -1
  457. package/dist/local/store/sqlite/models/index.d.ts +2 -1
  458. package/dist/local/store/sqlite/models/index.d.ts.map +1 -1
  459. package/dist/local/store/sqlite/models/index.js +5 -1
  460. package/dist/local/store/sqlite/models/index.js.map +1 -1
  461. package/dist/local/store/sqlite/models/message-record.d.ts +15 -0
  462. package/dist/local/store/sqlite/models/message-record.d.ts.map +1 -1
  463. package/dist/local/store/sqlite/models/message-record.js +24 -0
  464. package/dist/local/store/sqlite/models/message-record.js.map +1 -1
  465. package/dist/local/store/sqlite/models/send-log.d.ts +51 -0
  466. package/dist/local/store/sqlite/models/send-log.d.ts.map +1 -0
  467. package/dist/local/store/sqlite/models/send-log.js +206 -0
  468. package/dist/local/store/sqlite/models/send-log.js.map +1 -0
  469. package/dist/local/store/sqlite/open-store.d.ts +9 -1
  470. package/dist/local/store/sqlite/open-store.d.ts.map +1 -1
  471. package/dist/local/store/sqlite/open-store.js +20 -1
  472. package/dist/local/store/sqlite/open-store.js.map +1 -1
  473. package/dist/local/store/sqlite/schema.d.ts +34 -1
  474. package/dist/local/store/sqlite/schema.d.ts.map +1 -1
  475. package/dist/local/store/sqlite/schema.js +14 -0
  476. package/dist/local/store/sqlite/schema.js.map +1 -1
  477. package/dist/local/store/sqlite/store.d.ts +61 -11
  478. package/dist/local/store/sqlite/store.d.ts.map +1 -1
  479. package/dist/local/store/sqlite/store.js +191 -27
  480. package/dist/local/store/sqlite/store.js.map +1 -1
  481. package/dist/local/store/web/adapter.d.ts +76 -8
  482. package/dist/local/store/web/adapter.d.ts.map +1 -1
  483. package/dist/local/store/web/adapter.js +579 -127
  484. package/dist/local/store/web/adapter.js.map +1 -1
  485. package/dist/local/store/web/receive-work.d.ts +57 -0
  486. package/dist/local/store/web/receive-work.d.ts.map +1 -0
  487. package/dist/local/store/web/receive-work.js +99 -0
  488. package/dist/local/store/web/receive-work.js.map +1 -0
  489. package/dist/local/store/web/send-log.d.ts +92 -0
  490. package/dist/local/store/web/send-log.d.ts.map +1 -0
  491. package/dist/local/store/web/send-log.js +267 -0
  492. package/dist/local/store/web/send-log.js.map +1 -0
  493. package/dist/local/store/web/sender-key-handoff.d.ts +81 -0
  494. package/dist/local/store/web/sender-key-handoff.d.ts.map +1 -0
  495. package/dist/local/store/web/sender-key-handoff.js +156 -0
  496. package/dist/local/store/web/sender-key-handoff.js.map +1 -0
  497. package/dist/local/store/web-sqlite/adapter.d.ts +2 -0
  498. package/dist/local/store/web-sqlite/adapter.d.ts.map +1 -1
  499. package/dist/local/store/web-sqlite/adapter.js +12 -6
  500. package/dist/local/store/web-sqlite/adapter.js.map +1 -1
  501. package/dist/local/vault/custody.d.ts +8 -0
  502. package/dist/local/vault/custody.d.ts.map +1 -0
  503. package/dist/local/vault/custody.js +9 -0
  504. package/dist/local/vault/custody.js.map +1 -0
  505. package/dist/local/vault/electron-safe-storage.d.ts +3 -1
  506. package/dist/local/vault/electron-safe-storage.d.ts.map +1 -1
  507. package/dist/local/vault/electron-safe-storage.js +2 -0
  508. package/dist/local/vault/electron-safe-storage.js.map +1 -1
  509. package/dist/local/vault/expo-secure-store.d.ts +3 -1
  510. package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
  511. package/dist/local/vault/expo-secure-store.js +2 -0
  512. package/dist/local/vault/expo-secure-store.js.map +1 -1
  513. package/dist/local/vault/indexed-db.d.ts +3 -1
  514. package/dist/local/vault/indexed-db.d.ts.map +1 -1
  515. package/dist/local/vault/indexed-db.js +2 -0
  516. package/dist/local/vault/indexed-db.js.map +1 -1
  517. package/dist/local/vault/react-native-keychain.d.ts +3 -1
  518. package/dist/local/vault/react-native-keychain.d.ts.map +1 -1
  519. package/dist/local/vault/react-native-keychain.js +2 -0
  520. package/dist/local/vault/react-native-keychain.js.map +1 -1
  521. package/dist/remote/relay/device-set.d.ts +94 -0
  522. package/dist/remote/relay/device-set.d.ts.map +1 -0
  523. package/dist/remote/relay/device-set.js +156 -0
  524. package/dist/remote/relay/device-set.js.map +1 -0
  525. package/dist/remote/relay/types.d.ts +104 -110
  526. package/dist/remote/relay/types.d.ts.map +1 -1
  527. package/dist/safety/core.d.ts +15 -6
  528. package/dist/safety/core.d.ts.map +1 -1
  529. package/dist/safety/core.js +41 -27
  530. package/dist/safety/core.js.map +1 -1
  531. package/dist/safety/index.d.ts +2 -1
  532. package/dist/safety/index.d.ts.map +1 -1
  533. package/dist/safety/index.js +12 -18
  534. package/dist/safety/index.js.map +1 -1
  535. package/dist/types/api.d.ts +707 -62
  536. package/dist/types/api.d.ts.map +1 -1
  537. package/dist/types/errors.d.ts +14 -33
  538. package/dist/types/errors.d.ts.map +1 -1
  539. package/dist/types/errors.js +14 -24
  540. package/dist/types/errors.js.map +1 -1
  541. package/dist/types/messages.d.ts +2 -2
  542. package/dist/types/messages.js +1 -1
  543. package/dist/types/protocol-config.d.ts +175 -42
  544. package/dist/types/protocol-config.d.ts.map +1 -1
  545. package/dist/types/protocol-config.js +19 -38
  546. package/dist/types/protocol-config.js.map +1 -1
  547. package/dist/types/protocol-constants.d.ts +6 -6
  548. package/dist/types/protocol-constants.js +6 -6
  549. package/dist/types/session.d.ts +7 -7
  550. package/dist/types/session.d.ts.map +1 -1
  551. package/dist/types/session.js +39 -21
  552. package/dist/types/session.js.map +1 -1
  553. package/dist/username/link.d.ts +2 -2
  554. package/dist/username/link.js +2 -2
  555. package/dist/utils/origin-lock.d.ts +45 -0
  556. package/dist/utils/origin-lock.d.ts.map +1 -0
  557. package/dist/utils/origin-lock.js +80 -0
  558. package/dist/utils/origin-lock.js.map +1 -0
  559. package/dist/utils/retry.d.ts +2 -0
  560. package/dist/utils/retry.d.ts.map +1 -1
  561. package/dist/utils/retry.js +7 -0
  562. package/dist/utils/retry.js.map +1 -1
  563. package/docs/ASSURANCE.md +6 -6
  564. package/docs/CLIENT_COMPOSITION.md +2 -2
  565. package/docs/DEVIATIONS.md +677 -182
  566. package/docs/E2EE.md +1 -1
  567. package/docs/ERROR_HANDLING.md +235 -2
  568. package/docs/GETTING_STARTED.md +7 -4
  569. package/docs/INTERFACES.md +1 -1
  570. package/docs/PACKAGE_SURFACE.md +6 -5
  571. package/docs/PROTOCOL_POLICY.md +102 -22
  572. package/docs/RECIPES.md +3 -15
  573. package/docs/SECURITY.md +90 -5
  574. package/keys/README.md +3 -3
  575. package/local/store/README.md +78 -14
  576. package/local/store/key-value/README.md +14 -3
  577. package/local/store/node/README.md +8 -3
  578. package/local/store/web/README.md +9 -0
  579. package/local/store/web-sqlite/README.md +14 -2
  580. package/local/vault/README.md +21 -0
  581. package/package.json +1 -6
  582. package/remote/README.md +0 -1
  583. package/remote/relay/README.md +2 -2
  584. package/dist/device/provisioning.d.ts +0 -242
  585. package/dist/device/provisioning.d.ts.map +0 -1
  586. package/dist/device/provisioning.js +0 -421
  587. package/dist/device/provisioning.js.map +0 -1
  588. package/dist/internal/protocol/x3dh/index.d.ts +0 -15
  589. package/dist/internal/protocol/x3dh/index.d.ts.map +0 -1
  590. package/dist/internal/protocol/x3dh/index.js +0 -13
  591. package/dist/internal/protocol/x3dh/index.js.map +0 -1
  592. package/dist/internal/protocol/x3dh/x3dh.d.ts +0 -131
  593. package/dist/internal/protocol/x3dh/x3dh.d.ts.map +0 -1
  594. package/dist/internal/protocol/x3dh/x3dh.js +0 -261
  595. package/dist/internal/protocol/x3dh/x3dh.js.map +0 -1
@@ -1,6 +1,21 @@
1
1
  import { HostedRelayPresenceError, decodePresenceAnswer, decodePresenceUpdate, encodePresenceFrame, isPresenceAnswerType, isPresenceUpdateType, } from "./hosted-presence-frames.js";
2
2
  import { MAXIMUM_RECEIPTS_PER_FRAME, decodeRelayDeliveryReceipts, } from "./relay-receipt-intake.js";
3
3
  import { HostedRelayUpgradeRequiredError, RELAY_AUTH_PROTOCOL_PREFIX, RELAY_PROTOCOL_VERSION, relayProtocolToken, } from "./relay-protocol.js";
4
+ import { HostedRelayDeviceRevokedError, HostedRelayDeviceUnknownError, } from "./hosted-device-standing.js";
5
+ /**
6
+ * The stop reason that a typed Relay refusal names, or undefined for any other
7
+ * error. A conclusive `HostedRelayHttpError` refusal is not typed. The
8
+ * subscription asks `isConclusiveRefusal` for it.
9
+ */
10
+ function relayRefusalReason(error) {
11
+ if (error instanceof HostedRelayUpgradeRequiredError)
12
+ return "upgrade-required";
13
+ if (error instanceof HostedRelayDeviceRevokedError)
14
+ return "device-revoked";
15
+ if (error instanceof HostedRelayDeviceUnknownError)
16
+ return "device-unknown";
17
+ return undefined;
18
+ }
4
19
  /** The subprotocol token that the socket offers and the Relay must echo. */
5
20
  const RELAY_PROTOCOL_TOKEN = relayProtocolToken(RELAY_PROTOCOL_VERSION);
6
21
  /**
@@ -29,16 +44,20 @@ const MAXIMUM_RECOVERY_MILLISECONDS = 64_000;
29
44
  */
30
45
  const FAILED_MESSAGE_GONE_MILLISECONDS = 5_000;
31
46
  /**
32
- * The reconnect ceiling starts at 1 s and doubles to 30 s. Each wait is a
33
- * random time from zero up to the ceiling (full jitter), the first one too, so
34
- * clients that lose their sockets together, for example in a Relay deploy, do
35
- * not reconnect together. The ceiling starts again at 1 s when the Relay
36
- * answers a ping, 30 s after the socket opens. A socket that closes sooner,
47
+ * The retry schedule. Its ceiling starts at 1 s and doubles to 30 s. Each wait
48
+ * is a random time from zero up to the ceiling (full jitter), the first one
49
+ * too, so clients that lose their sockets together, for example in a Relay
50
+ * deploy, do not reconnect together. A failed socket, a failed socket
51
+ * authentication, and a failed pull share this one schedule. While a wait is
52
+ * pending, a further failure draws no new wait, so failures of different
53
+ * kinds do not multiply the requests of an outage. The ceiling starts again at
54
+ * 1 s when the Relay answers a ping, 30 s after the socket opens, and when the
55
+ * socket authentication gets a new device token. A socket that closes sooner,
37
56
  * for example on a frame that the client refuses on each connect, keeps the
38
57
  * ceiling growing, so a loop of short connections backs off to 30 s.
39
58
  */
40
- const FIRST_RECONNECT_MILLISECONDS = 1_000;
41
- const MAXIMUM_RECONNECT_MILLISECONDS = 30_000;
59
+ export const FIRST_RECONNECT_MILLISECONDS = 1_000;
60
+ export const MAXIMUM_RECONNECT_MILLISECONDS = 30_000;
42
61
  /** The Relay answers each `ping` text frame with `pong` without waking the mailbox. */
43
62
  const PING_MILLISECONDS = 30_000;
44
63
  /**
@@ -75,20 +94,71 @@ function notConnected() {
75
94
  * durable queue, so each one is handed off behind the messages that came
76
95
  * before it. HTTP pull recovers retained work only while the socket is down
77
96
  * or after a handler failure.
97
+ *
98
+ * Each page of durable frames ends with one `acknowledge` frame, with no ID
99
+ * when the page acknowledged nothing, so unacknowledged messages do not
100
+ * stall the pages behind them. An HTTP pull sends the Relay cursor of the
101
+ * page before it, so a full page of unacknowledged messages does not stall
102
+ * the pages behind it either. A page past the cursor that is empty clears
103
+ * the cursor, and the next pull starts at the head again. The recovery pull
104
+ * for failed work also starts at the head, so it offers the failed message
105
+ * again.
78
106
  */
79
107
  export function subscribeHostedMailbox(options) {
80
108
  let active = true;
81
- /** True after the Relay refused the protocol version of this SDK. */
82
- let upgradeRequired = false;
109
+ /**
110
+ * True after the Relay refused the protocol version of this SDK, refused
111
+ * this device, or refused the subscription conclusively.
112
+ */
113
+ let refused = false;
83
114
  let socket;
115
+ /** True after the current socket opened with the mailbox subprotocol. */
116
+ let socketOpened = false;
117
+ /** True while a connect waits for its socket authentication. */
118
+ let authenticating = false;
84
119
  let connectionGeneration = 0;
120
+ /** The ceiling of the retry schedule. */
85
121
  let reconnectDelay = FIRST_RECONNECT_MILLISECONDS;
86
- let reconnectTimer;
87
122
  let handshakeTimer;
88
123
  let renewalTimer;
89
- let recoveryTimer;
124
+ /**
125
+ * The one timer of the retries. It fires at the sooner of `retryDue` and
126
+ * `recoveryDue`.
127
+ */
128
+ let retryTimer;
129
+ /**
130
+ * The `Date.now()` time of the next retry of the schedule. The retry
131
+ * reconnects a missing socket, or runs an owed pull while a socket is up or
132
+ * connecting. Undefined while no retry waits.
133
+ */
134
+ let retryDue;
90
135
  /** The `Date.now()` time at which the pending recovery pull starts. */
91
- let recoveryDue = 0;
136
+ let recoveryDue;
137
+ /**
138
+ * True from a failed socket authentication or a failed pull until a pull
139
+ * succeeds, the socket authentication gets a new device token, or the
140
+ * Relay answers a ping. In an outage a failed socket draws no recovery pull
141
+ * of its own. A socket attempt that fails before it opens pulls at once
142
+ * instead, on the retry schedule.
143
+ */
144
+ let outage = false;
145
+ /** True while a failed pull waits for the next retry. */
146
+ let pullOwed = false;
147
+ /**
148
+ * The Relay cursor from the last page that was not empty. A pull failure,
149
+ * an empty page, and a page without a cursor clear it.
150
+ */
151
+ let pullCursor;
152
+ /**
153
+ * True while the pending recovery pull is the one that failed work
154
+ * scheduled. A recovery pull that replaces it sets it to false.
155
+ */
156
+ let recoveryForFailedWork = false;
157
+ /**
158
+ * True from the start of a failed-work recovery pull until a pull starts.
159
+ * That pull ignores the cursor and starts at the head.
160
+ */
161
+ let headPullOwed = false;
92
162
  let failedWorkRecoveryDelay = RECOVERY_MILLISECONDS;
93
163
  /**
94
164
  * The id of each message whose work failed, with the `Date.now()` time of
@@ -115,6 +185,12 @@ export function subscribeHostedMailbox(options) {
115
185
  let relayReceipts = false;
116
186
  /** The messages acknowledged on the live socket that wait for its reply. */
117
187
  const awaitingReply = new Set();
188
+ /**
189
+ * True from a durable message frame of the live socket until the client
190
+ * sends an `acknowledge` frame. The Relay sends the next page of a backlog
191
+ * only on that frame.
192
+ */
193
+ let pageOwed = false;
118
194
  const presenceRequests = new Map();
119
195
  let presenceSequence = 0;
120
196
  const liveSocket = () => active && socket?.readyState === 1 ? socket : undefined;
@@ -150,7 +226,14 @@ export function subscribeHostedMailbox(options) {
150
226
  options.onAcknowledgmentReply(messageId, false);
151
227
  });
152
228
  };
153
- const flushAcknowledgments = () => {
229
+ /**
230
+ * Sends the queued acknowledgments. `endOfPage` is true when a burst of
231
+ * durable frames is done: the socket then sends an `acknowledge` frame for
232
+ * the page, with no id when nothing was acknowledged. Messages that stay
233
+ * unacknowledged, as blocked group content and failed work do, would
234
+ * otherwise stall each page of the backlog behind them.
235
+ */
236
+ const flushAcknowledgments = (endOfPage = false) => {
154
237
  clearTimeout(acknowledgmentTimer);
155
238
  acknowledgmentTimer = undefined;
156
239
  const live = socket?.readyState === 1 ? socket : undefined;
@@ -164,8 +247,14 @@ export function subscribeHostedMailbox(options) {
164
247
  awaitingReply.add(messageId);
165
248
  else
166
249
  options.onAcknowledgmentReply(messageId, false);
250
+ // A page that arrives after this frame owes a frame of its own.
251
+ pageOwed = false;
167
252
  live.send(JSON.stringify({ type: "acknowledge", messageIds }));
168
253
  }
254
+ if (endOfPage && pageOwed) {
255
+ pageOwed = false;
256
+ live.send(JSON.stringify({ type: "acknowledge", messageIds: [] }));
257
+ }
169
258
  // A socket that did not advertise Relay receipts closes on an
170
259
  // `acknowledge-receipts` frame, so the receipts of a pull page go over
171
260
  // HTTP while it is live. A replay acknowledges a lost receipt again.
@@ -197,6 +286,71 @@ export function subscribeHostedMailbox(options) {
197
286
  if (awaitingReply.delete(messageId))
198
287
  options.onAcknowledgmentReply(messageId, receipted.includes(messageId));
199
288
  };
289
+ /** Sets the one retry timer for the sooner of the two pending times. */
290
+ const armRetryTimer = () => {
291
+ clearTimeout(retryTimer);
292
+ retryTimer = undefined;
293
+ if (!active)
294
+ return;
295
+ const due = Math.min(retryDue ?? Infinity, recoveryDue ?? Infinity);
296
+ if (due === Infinity)
297
+ return;
298
+ retryTimer = setTimeout(() => runRetries(due), Math.max(0, due - Date.now()));
299
+ };
300
+ /**
301
+ * Runs each retry that is due at `due`, the time of the timer that fired,
302
+ * then sets the timer for the rest.
303
+ */
304
+ const runRetries = (due) => {
305
+ retryTimer = undefined;
306
+ if (retryDue !== undefined && retryDue <= due) {
307
+ retryDue = undefined;
308
+ // A new socket attempt carries the owed pull, which runs when the
309
+ // attempt fails before it opens.
310
+ if (socket === undefined && !authenticating)
311
+ void connect();
312
+ else if (pullOwed) {
313
+ pullOwed = false;
314
+ requestPull();
315
+ }
316
+ }
317
+ if (recoveryDue !== undefined && recoveryDue <= due) {
318
+ recoveryDue = undefined;
319
+ // The cursor can lie past the failed message, so this pull starts at
320
+ // the head.
321
+ if (recoveryForFailedWork)
322
+ headPullOwed = true;
323
+ requestPull();
324
+ }
325
+ armRetryTimer();
326
+ };
327
+ /**
328
+ * Draws the next retry wait from the schedule and doubles the ceiling,
329
+ * unless a retry already waits. A failure during the wait draws nothing.
330
+ */
331
+ const scheduleRetry = () => {
332
+ if (!active || retryDue !== undefined)
333
+ return;
334
+ retryDue = Date.now() + Math.floor(Math.random() * reconnectDelay);
335
+ reconnectDelay = Math.min(MAXIMUM_RECONNECT_MILLISECONDS, reconnectDelay * 2);
336
+ armRetryTimer();
337
+ };
338
+ /** A request succeeded, so the outage ends and the ceiling starts again. */
339
+ const endOutage = () => {
340
+ outage = false;
341
+ reconnectDelay = FIRST_RECONNECT_MILLISECONDS;
342
+ };
343
+ /**
344
+ * Owes a failed pull to the retry schedule. The pending recovery pull
345
+ * ends, so the failed pull does not run twice.
346
+ */
347
+ const retryPull = () => {
348
+ outage = true;
349
+ pullOwed = true;
350
+ recoveryDue = undefined;
351
+ armRetryTimer();
352
+ scheduleRetry();
353
+ };
200
354
  /**
201
355
  * Schedules one recovery pull. A pending pull that starts sooner stays, and
202
356
  * a pending pull that starts later is replaced, so a longer wait for failed
@@ -208,22 +362,23 @@ export function subscribeHostedMailbox(options) {
208
362
  return false;
209
363
  const wait = delay * (0.5 + Math.random());
210
364
  const due = Date.now() + wait;
211
- if (recoveryTimer !== undefined) {
212
- if (due >= recoveryDue)
213
- return false;
214
- clearTimeout(recoveryTimer);
215
- }
365
+ if (recoveryDue !== undefined && due >= recoveryDue)
366
+ return false;
216
367
  recoveryDue = due;
217
- recoveryTimer = setTimeout(() => {
218
- recoveryTimer = undefined;
219
- requestPull();
220
- }, wait);
368
+ recoveryForFailedWork = false;
369
+ armRetryTimer();
221
370
  return true;
222
371
  };
223
- /** Schedules the recovery pull for failed work, and doubles its next wait. */
372
+ /**
373
+ * Schedules the recovery pull for failed work, and doubles its next wait.
374
+ * That pull starts at the head of the mailbox, so it offers the failed
375
+ * message again.
376
+ */
224
377
  const recoverFailedWork = () => {
225
- if (recoverLater(failedWorkRecoveryDelay))
378
+ if (recoverLater(failedWorkRecoveryDelay)) {
379
+ recoveryForFailedWork = true;
226
380
  failedWorkRecoveryDelay = Math.min(MAXIMUM_RECOVERY_MILLISECONDS, failedWorkRecoveryDelay * 2);
381
+ }
227
382
  };
228
383
  /**
229
384
  * Receives each message and hands off each Relay receipt in mailbox order.
@@ -249,10 +404,10 @@ export function subscribeHostedMailbox(options) {
249
404
  if ("receipt" in work) {
250
405
  try {
251
406
  await options.receiveReceipt(work.receipt);
252
- // A hand-off that settles after the upgrade stop is not
407
+ // A hand-off that settles after a refusal stop is not
253
408
  // acknowledged, because the Relay refuses the acknowledgment. The
254
409
  // Relay keeps the receipt.
255
- if (!upgradeRequired)
410
+ if (!refused)
256
411
  receiptAcknowledgments.push(work.receipt.receiptId);
257
412
  }
258
413
  catch {
@@ -282,9 +437,9 @@ export function subscribeHostedMailbox(options) {
282
437
  };
283
438
  };
284
439
  /**
285
- * Forgets each failed message that a recovery page shows to be gone. A page
286
- * that is not full holds every retained message, except a message in the
287
- * Relay's hot delivery window. Such a page shows a failed message gone when
440
+ * Forgets each failed message that a recovery page shows to be gone. A head
441
+ * page that is not full holds every retained message, except a message in
442
+ * the Relay's hot delivery window. Such a page shows a failed message gone when
288
443
  * the page does not hold it. The message must also have first failed more
289
444
  * than `FAILED_MESSAGE_GONE_MILLISECONDS` before `pulledAt`. `pulledAt` is
290
445
  * the `Date.now()` time at which the pull of the page started. Then the
@@ -304,6 +459,8 @@ export function subscribeHostedMailbox(options) {
304
459
  if (draining || !active)
305
460
  return;
306
461
  draining = true;
462
+ /** True while `options.pull` runs, so the catch knows what failed. */
463
+ let pulling = false;
307
464
  try {
308
465
  while (active &&
309
466
  (pullRequested || ephemeral.length > 0 || durable.length > 0)) {
@@ -323,43 +480,69 @@ export function subscribeHostedMailbox(options) {
323
480
  recoverFailedWork();
324
481
  // One frame acknowledges the whole burst once nothing is queued.
325
482
  if (durable.length === 0)
326
- flushAcknowledgments();
483
+ flushAcknowledgments(true);
327
484
  continue;
328
485
  }
329
486
  pullRequested = false;
330
487
  flushAcknowledgments();
331
488
  const pulledAt = Date.now();
332
- const { messages, receipts } = await options.pull();
489
+ const cursor = headPullOwed ? undefined : pullCursor;
490
+ headPullOwed = false;
491
+ // A failed pull, including a Relay refusal of the cursor, leaves the
492
+ // cursor cleared, so the next pull starts at the head.
493
+ pullCursor = undefined;
494
+ pulling = true;
495
+ const { messages, receipts, nextCursor } = await options.pull(cursor);
496
+ pulling = false;
497
+ // A Relay page without a `nextCursor` makes the next pull start from
498
+ // the head. This branch is removed in the first release after every
499
+ // Relay lane serves the cursor.
500
+ if (messages.length > 0 && nextCursor !== undefined)
501
+ pullCursor = nextCursor;
502
+ // The Relay answered, so the HTTP outage ends. The reconnect ceiling
503
+ // stays, because the socket can still fail.
504
+ outage = false;
505
+ pullOwed = false;
333
506
  const { failed, acknowledged } = await receiveBatch([
334
507
  ...messages.map((message) => ({ message })),
335
508
  ...receipts.map((receipt) => ({ receipt })),
336
509
  ]);
337
510
  flushAcknowledgments();
338
511
  // A failed message can be missing from the page while it waits in the
339
- // Relay's hot delivery window, so a pull follows while one remains.
340
- forgetGoneFailures(messages, pulledAt);
512
+ // Relay's hot delivery window, so a pull follows while one remains. A
513
+ // page past the cursor does not hold the messages before the cursor.
514
+ if (cursor === undefined)
515
+ forgetGoneFailures(messages, pulledAt);
341
516
  if (failed || failedMessages.size > 0)
342
517
  recoverFailedWork();
343
518
  else
344
519
  failedWorkRecoveryDelay = RECOVERY_MILLISECONDS;
345
520
  // A full page can leave more retained work behind it. A full recovery
346
- // page whose batch acknowledged a message pulls the next page after a
347
- // random wait from 1 s to 3 s. A full page that acknowledged nothing
348
- // pulls again only while a failed message remains, after the
349
- // failed-work wait.
350
- if (messages.length >= MAXIMUM_PENDING_FRAMES && acknowledged > 0)
521
+ // page whose batch acknowledged a message, or that issued a cursor,
522
+ // pulls the next page after a random wait from 1 s to 3 s. A full
523
+ // page that did neither pulls again only while a failed message
524
+ // remains, after the failed-work wait.
525
+ if (messages.length >= MAXIMUM_PENDING_FRAMES &&
526
+ (acknowledged > 0 || pullCursor !== undefined))
351
527
  recoverLater();
352
528
  }
353
529
  }
354
530
  catch (error) {
355
531
  // A pull, an ephemeral message, or a batch callback failed. Retained
356
532
  // durable work stays in the mailbox. Ephemeral work can be lost. A pull
357
- // that the Relay refuses with `UPGRADE_REQUIRED` fails the same way
358
- // each time, so it ends the subscription.
359
- if (error instanceof HostedRelayUpgradeRequiredError)
360
- stopForUpgrade();
361
- else
533
+ // that the Relay refuses for this SDK or this device, or refuses
534
+ // conclusively, fails the same way each time, so it ends the
535
+ // subscription. Each other failed pull goes to the retry schedule. A
536
+ // callback error is the application's, so it only schedules a pull.
537
+ const refusal = relayRefusalReason(error);
538
+ if (refusal !== undefined)
539
+ stop(refusal);
540
+ else if (!pulling)
362
541
  recoverLater();
542
+ else if (options.isConclusiveRefusal(error))
543
+ stop("authority-refused");
544
+ else
545
+ retryPull();
363
546
  }
364
547
  finally {
365
548
  draining = false;
@@ -379,9 +562,13 @@ export function subscribeHostedMailbox(options) {
379
562
  const disconnect = () => {
380
563
  const previous = socket;
381
564
  socket = undefined;
565
+ socketOpened = false;
566
+ // A connect that still authenticates is dropped by its generation.
567
+ authenticating = false;
382
568
  connectionGeneration++;
383
569
  ephemeral.length = 0;
384
570
  durable.length = 0;
571
+ pageOwed = false;
385
572
  relayReceipts = false;
386
573
  // A reply can arrive only on the socket that carried the acknowledgment.
387
574
  const unanswered = [...awaitingReply];
@@ -402,47 +589,59 @@ export function subscribeHostedMailbox(options) {
402
589
  }
403
590
  };
404
591
  /**
405
- * Ends the subscription because the Relay no longer serves the protocol
406
- * version of this SDK. Each reconnect and each recovery pull would fail the
407
- * same way, so none follows. Queued acknowledgments are not sent, because
408
- * the Relay refuses them too. A receipt hand-off that settles after the stop
409
- * is not acknowledged either. The Relay keeps their messages and receipts,
410
- * and each queued message gets the reply `receipted` false.
592
+ * Ends the subscription because the Relay refused it in a way that each
593
+ * reconnect and each pull gets again: `upgrade-required` when the Relay no
594
+ * longer serves the protocol version of this SDK, `device-revoked` or
595
+ * `device-unknown` when the Relay refuses this device, and
596
+ * `authority-refused` after a conclusive refusal of a socket authentication
597
+ * or a pull. No retry
598
+ * follows. Queued acknowledgments are not sent, because the Relay refuses
599
+ * them too. A receipt hand-off that settles after the stop is not
600
+ * acknowledged either. The Relay keeps their messages and receipts, and each
601
+ * queued message gets the reply `receipted` false.
411
602
  */
412
- const stopForUpgrade = () => {
603
+ const stop = (reason) => {
413
604
  if (!active)
414
605
  return;
415
606
  active = false;
416
- upgradeRequired = true;
607
+ refused = true;
417
608
  const unsent = acknowledgments.splice(0);
418
609
  receiptAcknowledgments.length = 0;
419
610
  for (const messageId of unsent)
420
611
  options.onAcknowledgmentReply(messageId, false);
421
- clearTimeout(reconnectTimer);
422
- reconnectTimer = undefined;
423
- clearTimeout(recoveryTimer);
424
- recoveryTimer = undefined;
612
+ clearTimeout(retryTimer);
613
+ retryTimer = undefined;
614
+ retryDue = undefined;
615
+ recoveryDue = undefined;
425
616
  clearTimeout(acknowledgmentTimer);
426
617
  acknowledgmentTimer = undefined;
427
618
  disconnect();
428
- options.onConnectionState("stopped", "upgrade-required");
619
+ options.onConnectionState("stopped", reason);
429
620
  };
430
621
  const retryConnection = (reason) => {
431
- if (!active || reconnectTimer !== undefined)
622
+ if (!active)
432
623
  return;
624
+ const replayed = socketOpened;
433
625
  disconnect();
434
626
  options.onConnectionState("reconnecting", reason);
435
- // One recovery pull per reconnect attempt, paced by the reconnect backoff.
436
- recoverLater();
437
- const delay = Math.floor(Math.random() * reconnectDelay);
438
- reconnectDelay = Math.min(MAXIMUM_RECONNECT_MILLISECONDS, reconnectDelay * 2);
439
- reconnectTimer = setTimeout(() => {
440
- reconnectTimer = undefined;
441
- void connect();
442
- }, delay);
627
+ if (!outage) {
628
+ // One recovery pull per reconnect attempt, drawn before the wait.
629
+ recoverLater();
630
+ }
631
+ else if (reason !== "authentication" && !replayed) {
632
+ // In an outage, a socket attempt that fails before it opens pulls at
633
+ // once, on the retry schedule. A socket that opened replayed the
634
+ // retained work. A pull after a failed authentication would fail on
635
+ // the same device token.
636
+ pullOwed = false;
637
+ requestPull();
638
+ }
639
+ scheduleRetry();
443
640
  };
444
641
  const queueDurable = (candidate, message) => {
445
642
  const envelope = options.decodeDurable(message);
643
+ if (socket === candidate)
644
+ pageOwed = true;
446
645
  if (durable.length >= MAXIMUM_PENDING_FRAMES) {
447
646
  // The frame stays retained in the mailbox; the recovery pull collects it.
448
647
  recoverLater();
@@ -469,11 +668,16 @@ export function subscribeHostedMailbox(options) {
469
668
  const connect = async () => {
470
669
  const generation = ++connectionGeneration;
471
670
  let authenticated = false;
671
+ authenticating = true;
472
672
  try {
473
673
  const authority = await options.authenticate();
474
674
  authenticated = true;
475
675
  if (!active || generation !== connectionGeneration)
476
676
  return;
677
+ authenticating = false;
678
+ // A new device token shows that the Relay serves this device again.
679
+ if (authority.refreshed)
680
+ endOutage();
477
681
  const candidate = new WebSocket(authority.url, [
478
682
  RELAY_PROTOCOL_TOKEN,
479
683
  `${RELAY_AUTH_PROTOCOL_PREFIX}${authority.token}`,
@@ -500,8 +704,10 @@ export function subscribeHostedMailbox(options) {
500
704
  // a failed message remains. This pull is scheduled before the replay
501
705
  // arrives, so it can find an empty page when the replay handles the
502
706
  // last failed message.
503
- clearTimeout(recoveryTimer);
504
- recoveryTimer = undefined;
707
+ socketOpened = true;
708
+ recoveryDue = undefined;
709
+ pullOwed = false;
710
+ armRetryTimer();
505
711
  failedWorkRecoveryDelay = RECOVERY_MILLISECONDS;
506
712
  if (failedMessages.size > 0)
507
713
  recoverFailedWork();
@@ -545,7 +751,7 @@ export function subscribeHostedMailbox(options) {
545
751
  if (event.data === "pong") {
546
752
  unansweredPings = 0;
547
753
  // The socket stayed open and the Relay answers it.
548
- reconnectDelay = FIRST_RECONNECT_MILLISECONDS;
754
+ endOutage();
549
755
  return;
550
756
  }
551
757
  const frame = JSON.parse(event.data);
@@ -600,7 +806,7 @@ export function subscribeHostedMailbox(options) {
600
806
  return;
601
807
  if (event.code === UPGRADE_REQUIRED_CLOSE_CODE &&
602
808
  event.reason === UPGRADE_REQUIRED_CLOSE_REASON) {
603
- stopForUpgrade();
809
+ stop("upgrade-required");
604
810
  return;
605
811
  }
606
812
  // A close 4400 with the reason `PROTOCOL_UNSUPPORTED` takes the
@@ -619,10 +825,18 @@ export function subscribeHostedMailbox(options) {
619
825
  catch (error) {
620
826
  if (!active || generation !== connectionGeneration)
621
827
  return;
622
- if (error instanceof HostedRelayUpgradeRequiredError)
623
- stopForUpgrade();
624
- else
828
+ authenticating = false;
829
+ const refusal = relayRefusalReason(error);
830
+ if (refusal !== undefined)
831
+ stop(refusal);
832
+ else if (options.isConclusiveRefusal(error))
833
+ stop("authority-refused");
834
+ else {
835
+ // A failed socket authentication is a failed Relay request.
836
+ if (!authenticated)
837
+ outage = true;
625
838
  retryConnection(authenticated ? "error" : "authentication");
839
+ }
626
840
  }
627
841
  };
628
842
  options.onConnectionState("connecting");
@@ -680,8 +894,8 @@ export function subscribeHostedMailbox(options) {
680
894
  return;
681
895
  flushAcknowledgments();
682
896
  active = false;
683
- clearTimeout(reconnectTimer);
684
- clearTimeout(recoveryTimer);
897
+ clearTimeout(retryTimer);
898
+ retryTimer = undefined;
685
899
  disconnect();
686
900
  options.onConnectionState("stopped");
687
901
  },