@open-e2ee/signal-protocol-sdk 0.1.0-alpha.4 → 0.1.0-alpha.6

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 (497) hide show
  1. package/ADAPTERS.md +15 -15
  2. package/CHANGELOG.md +109 -0
  3. package/README.md +4 -2
  4. package/blocking/README.md +5 -5
  5. package/client/README.md +2 -2
  6. package/dist/blocking/index.d.ts +2 -2
  7. package/dist/blocking/index.d.ts.map +1 -1
  8. package/dist/blocking/index.js +1 -1
  9. package/dist/blocking/index.js.map +1 -1
  10. package/dist/blocking/manager.d.ts +7 -7
  11. package/dist/blocking/manager.d.ts.map +1 -1
  12. package/dist/blocking/manager.js +3 -3
  13. package/dist/blocking/manager.js.map +1 -1
  14. package/dist/blocking/types.d.ts +4 -4
  15. package/dist/blocking/types.d.ts.map +1 -1
  16. package/dist/blocking/types.js +1 -1
  17. package/dist/client/client.d.ts +3 -3
  18. package/dist/client/client.d.ts.map +1 -1
  19. package/dist/client/client.js +11 -11
  20. package/dist/client/client.js.map +1 -1
  21. package/dist/client/compose.d.ts +7 -7
  22. package/dist/client/compose.d.ts.map +1 -1
  23. package/dist/client/config.d.ts +15 -15
  24. package/dist/client/config.d.ts.map +1 -1
  25. package/dist/client/content-adapter.d.ts +4 -4
  26. package/dist/client/content-adapter.d.ts.map +1 -1
  27. package/dist/client/content-adapter.js +1 -1
  28. package/dist/client/content-adapter.js.map +1 -1
  29. package/dist/client/dual-store.d.ts +5 -5
  30. package/dist/client/dual-store.d.ts.map +1 -1
  31. package/dist/client/dual-store.js.map +1 -1
  32. package/dist/client/endorsement-manager.d.ts.map +1 -1
  33. package/dist/client/endorsement-manager.js +2 -2
  34. package/dist/client/endorsement-manager.js.map +1 -1
  35. package/dist/client/event-hooks.d.ts +1 -1
  36. package/dist/client/headless.d.ts +11 -11
  37. package/dist/client/headless.d.ts.map +1 -1
  38. package/dist/client/headless.js +8 -8
  39. package/dist/client/headless.js.map +1 -1
  40. package/dist/client/index.d.ts +2 -2
  41. package/dist/client/index.d.ts.map +1 -1
  42. package/dist/client/index.js +1 -1
  43. package/dist/client/index.js.map +1 -1
  44. package/dist/client/key-rotation-core.d.ts +11 -11
  45. package/dist/client/key-rotation-core.d.ts.map +1 -1
  46. package/dist/client/key-rotation-core.js +22 -22
  47. package/dist/client/key-rotation-core.js.map +1 -1
  48. package/dist/client/media.d.ts +2 -2
  49. package/dist/client/media.js +5 -5
  50. package/dist/client/media.js.map +1 -1
  51. package/dist/client/messages.js +2 -2
  52. package/dist/client/messages.js.map +1 -1
  53. package/dist/client/relay-subscription.d.ts +2 -2
  54. package/dist/client/relay-subscription.d.ts.map +1 -1
  55. package/dist/client/relay-subscription.js +18 -1
  56. package/dist/client/relay-subscription.js.map +1 -1
  57. package/dist/client/retry.js +1 -1
  58. package/dist/client/retry.js.map +1 -1
  59. package/dist/client/sealed-sender-ops.d.ts +1 -1
  60. package/dist/client/sealed-sender-ops.d.ts.map +1 -1
  61. package/dist/client/sealed-sender-ops.js +4 -4
  62. package/dist/client/sealed-sender-ops.js.map +1 -1
  63. package/dist/client/sessions.d.ts.map +1 -1
  64. package/dist/client/sessions.js +3 -0
  65. package/dist/client/sessions.js.map +1 -1
  66. package/dist/client/signal-service-cipher.d.ts +14 -10
  67. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  68. package/dist/client/signal-service-cipher.js +31 -23
  69. package/dist/client/signal-service-cipher.js.map +1 -1
  70. package/dist/client/types.d.ts +8 -8
  71. package/dist/client/types.d.ts.map +1 -1
  72. package/dist/device/connection.js +2 -2
  73. package/dist/device/connection.js.map +1 -1
  74. package/dist/device/device-id.d.ts.map +1 -1
  75. package/dist/device/device-id.js +4 -4
  76. package/dist/device/device-id.js.map +1 -1
  77. package/dist/device/provisioning.d.ts +5 -5
  78. package/dist/device/provisioning.d.ts.map +1 -1
  79. package/dist/device/provisioning.js +9 -9
  80. package/dist/device/provisioning.js.map +1 -1
  81. package/dist/device/transfer.d.ts.map +1 -1
  82. package/dist/device/transfer.js +14 -14
  83. package/dist/device/transfer.js.map +1 -1
  84. package/dist/files/index.d.ts +1 -1
  85. package/dist/files/index.js +1 -1
  86. package/dist/hooks/use-connection-presence.d.ts +5 -5
  87. package/dist/hooks/use-connection-presence.d.ts.map +1 -1
  88. package/dist/hooks/use-connection-presence.js +5 -5
  89. package/dist/hooks/use-connection-presence.js.map +1 -1
  90. package/dist/hooks/use-group-membership.d.ts +2 -2
  91. package/dist/hooks/use-key-rotation.js +2 -2
  92. package/dist/hooks/use-key-rotation.js.map +1 -1
  93. package/dist/index.d.ts +13 -13
  94. package/dist/index.d.ts.map +1 -1
  95. package/dist/index.js +6 -6
  96. package/dist/index.js.map +1 -1
  97. package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
  98. package/dist/internal/crypto/ec/x25519-validation.js +4 -4
  99. package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
  100. package/dist/internal/crypto/index.js +1 -1
  101. package/dist/internal/crypto/index.js.map +1 -1
  102. package/dist/internal/crypto/kdf/hkdf.d.ts +1 -1
  103. package/dist/internal/crypto/kdf/hkdf.d.ts.map +1 -1
  104. package/dist/internal/crypto/kdf/hkdf.js +2 -2
  105. package/dist/internal/crypto/kdf/hkdf.js.map +1 -1
  106. package/dist/internal/crypto/key-prefix.d.ts +1 -1
  107. package/dist/internal/crypto/key-prefix.js +1 -1
  108. package/dist/internal/crypto/pq/kyber.d.ts +1 -1
  109. package/dist/internal/crypto/pq/kyber.js +1 -1
  110. package/dist/internal/crypto/symmetric/aes-gcm-siv.d.ts +1 -1
  111. package/dist/internal/crypto/symmetric/aes-gcm-siv.js +1 -1
  112. package/dist/internal/crypto/symmetric/mac.d.ts +3 -3
  113. package/dist/internal/crypto/symmetric/mac.js +3 -3
  114. package/dist/internal/crypto/utils.d.ts +2 -2
  115. package/dist/internal/crypto/utils.js +2 -2
  116. package/dist/internal/encoding/proto/envelope.d.ts +21 -21
  117. package/dist/internal/encoding/proto/envelope.d.ts.map +1 -1
  118. package/dist/internal/encoding/proto/envelope.js +25 -25
  119. package/dist/internal/encoding/proto/envelope.js.map +1 -1
  120. package/dist/internal/encoding/proto/index.d.ts +2 -2
  121. package/dist/internal/encoding/proto/index.d.ts.map +1 -1
  122. package/dist/internal/encoding/proto/index.js +3 -3
  123. package/dist/internal/encoding/proto/index.js.map +1 -1
  124. package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts +5 -5
  125. package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts.map +1 -1
  126. package/dist/internal/encoding/proto/pq-ratchet-serialize.js +4 -4
  127. package/dist/internal/encoding/proto/pq-ratchet-serialize.js.map +1 -1
  128. package/dist/internal/encoding/proto/signal-message.d.ts +33 -33
  129. package/dist/internal/encoding/proto/signal-message.d.ts.map +1 -1
  130. package/dist/internal/encoding/proto/signal-message.js +58 -58
  131. package/dist/internal/encoding/proto/signal-message.js.map +1 -1
  132. package/dist/internal/groups/group-id.d.ts +1 -1
  133. package/dist/internal/groups/group-id.js +1 -1
  134. package/dist/internal/groups/group-id.js.map +1 -1
  135. package/dist/internal/groups-v2/access-control.d.ts +8 -1
  136. package/dist/internal/groups-v2/access-control.d.ts.map +1 -1
  137. package/dist/internal/groups-v2/access-control.js +8 -1
  138. package/dist/internal/groups-v2/access-control.js.map +1 -1
  139. package/dist/internal/groups-v2/change-actions.d.ts +8 -3
  140. package/dist/internal/groups-v2/change-actions.d.ts.map +1 -1
  141. package/dist/internal/groups-v2/change-actions.js +8 -3
  142. package/dist/internal/groups-v2/change-actions.js.map +1 -1
  143. package/dist/internal/groups-v2/index.d.ts +7 -2
  144. package/dist/internal/groups-v2/index.d.ts.map +1 -1
  145. package/dist/internal/groups-v2/index.js.map +1 -1
  146. package/dist/internal/groups-v2/manager.d.ts +4 -2
  147. package/dist/internal/groups-v2/manager.d.ts.map +1 -1
  148. package/dist/internal/groups-v2/manager.js +5 -3
  149. package/dist/internal/groups-v2/manager.js.map +1 -1
  150. package/dist/internal/groups-v2/types.d.ts +10 -3
  151. package/dist/internal/groups-v2/types.d.ts.map +1 -1
  152. package/dist/internal/groups-v2/types.js.map +1 -1
  153. package/dist/internal/manager/manager.d.ts +3 -3
  154. package/dist/internal/manager/manager.d.ts.map +1 -1
  155. package/dist/internal/manager/manager.js +28 -17
  156. package/dist/internal/manager/manager.js.map +1 -1
  157. package/dist/internal/protocol/double-ratchet/chains.d.ts +1 -1
  158. package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
  159. package/dist/internal/protocol/double-ratchet/chains.js +10 -10
  160. package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
  161. package/dist/internal/protocol/double-ratchet/ratchet.d.ts +3 -3
  162. package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
  163. package/dist/internal/protocol/double-ratchet/ratchet.js +3 -3
  164. package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
  165. package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
  166. package/dist/internal/protocol/pqxdh/pqxdh.js +3 -3
  167. package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
  168. package/dist/internal/protocol/sealed-sender/decryption.js +2 -2
  169. package/dist/internal/protocol/sealed-sender/decryption.js.map +1 -1
  170. package/dist/internal/protocol/sealed-sender/types.d.ts +1 -1
  171. package/dist/internal/protocol/sealed-sender/types.js +1 -1
  172. package/dist/internal/protocol/sender-keys/index.d.ts +1 -1
  173. package/dist/internal/protocol/sender-keys/manager.d.ts +4 -4
  174. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  175. package/dist/internal/protocol/sender-keys/manager.js +5 -5
  176. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  177. package/dist/internal/protocol/spqr/index.d.ts +1 -1
  178. package/dist/internal/protocol/spqr/index.js +1 -1
  179. package/dist/internal/protocol/spqr/message.d.ts +1 -1
  180. package/dist/internal/protocol/spqr/message.js +1 -1
  181. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts +3 -3
  182. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts.map +1 -1
  183. package/dist/internal/protocol/spqr/ml-kem-braid/rs/index.js +2 -2
  184. package/dist/internal/protocol/spqr/ml-kem-braid/rs/index.js.map +1 -1
  185. package/dist/internal/protocol/spqr/ml-kem-braid/rs/lagrange.d.ts +1 -1
  186. package/dist/internal/protocol/spqr/ml-kem-braid/rs/lagrange.js +1 -1
  187. package/dist/internal/protocol/spqr/ml-kem-braid/rs/lagrange.js.map +1 -1
  188. package/dist/internal/protocol/spqr/ml-kem-braid/serialize.d.ts +1 -1
  189. package/dist/internal/protocol/spqr/ml-kem-braid/serialize.js +1 -1
  190. package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js +5 -5
  191. package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js.map +1 -1
  192. package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts +1 -1
  193. package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts.map +1 -1
  194. package/dist/internal/protocol/spqr/spqr.d.ts +10 -10
  195. package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
  196. package/dist/internal/protocol/spqr/spqr.js +14 -14
  197. package/dist/internal/protocol/spqr/spqr.js.map +1 -1
  198. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +3 -3
  199. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +1 -1
  200. package/dist/internal/protocol/triple-ratchet/ratchet.js +5 -5
  201. package/dist/internal/protocol/triple-ratchet/ratchet.js.map +1 -1
  202. package/dist/internal/protocol/username/generate.d.ts +1 -1
  203. package/dist/internal/protocol/username/generate.js +1 -1
  204. package/dist/internal/protocol/username/hash.d.ts +1 -1
  205. package/dist/internal/protocol/username/hash.js +1 -1
  206. package/dist/internal/protocol/username/link.d.ts +1 -1
  207. package/dist/internal/protocol/username/link.js +1 -1
  208. package/dist/internal/protocol/username/proof.d.ts +1 -1
  209. package/dist/internal/protocol/username/proof.js +1 -1
  210. package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
  211. package/dist/internal/protocol/x3dh/x3dh.js +6 -6
  212. package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
  213. package/dist/internal/protocol/zk/groups/client-zk-group-cipher.d.ts +2 -2
  214. package/dist/internal/protocol/zk/groups/client-zk-group-cipher.js +2 -2
  215. package/dist/internal/sesame/device-registry.d.ts +18 -13
  216. package/dist/internal/sesame/device-registry.d.ts.map +1 -1
  217. package/dist/internal/sesame/device-registry.js +13 -9
  218. package/dist/internal/sesame/device-registry.js.map +1 -1
  219. package/dist/internal/sesame/manager.d.ts +1 -1
  220. package/dist/internal/sesame/manager.d.ts.map +1 -1
  221. package/dist/internal/sesame/manager.js +16 -16
  222. package/dist/internal/sesame/manager.js.map +1 -1
  223. package/dist/internal/session/builder.js +3 -3
  224. package/dist/internal/session/builder.js.map +1 -1
  225. package/dist/internal/session/cipher.d.ts +2 -2
  226. package/dist/internal/session/cipher.d.ts.map +1 -1
  227. package/dist/internal/session/cipher.js +30 -30
  228. package/dist/internal/session/cipher.js.map +1 -1
  229. package/dist/internal/session/decryption.d.ts +1 -1
  230. package/dist/internal/session/decryption.js +10 -10
  231. package/dist/internal/session/decryption.js.map +1 -1
  232. package/dist/internal/session/factory.d.ts.map +1 -1
  233. package/dist/internal/session/factory.js +3 -3
  234. package/dist/internal/session/factory.js.map +1 -1
  235. package/dist/internal/session/handshake.d.ts.map +1 -1
  236. package/dist/internal/session/handshake.js +3 -3
  237. package/dist/internal/session/handshake.js.map +1 -1
  238. package/dist/internal/session/keys.d.ts +1 -1
  239. package/dist/internal/session/ratchet.d.ts.map +1 -1
  240. package/dist/internal/session/ratchet.js +4 -4
  241. package/dist/internal/session/ratchet.js.map +1 -1
  242. package/dist/internal/session/types.d.ts +2 -2
  243. package/dist/internal/session/types.d.ts.map +1 -1
  244. package/dist/internal/session/validation.d.ts.map +1 -1
  245. package/dist/internal/session/validation.js +3 -3
  246. package/dist/internal/session/validation.js.map +1 -1
  247. package/dist/keys/generation.d.ts +1 -1
  248. package/dist/keys/generation.js +1 -1
  249. package/dist/keys/types.d.ts +1 -1
  250. package/dist/keys/types.d.ts.map +1 -1
  251. package/dist/layers.d.ts +2 -2
  252. package/dist/layers.d.ts.map +1 -1
  253. package/dist/layers.js +4 -4
  254. package/dist/layers.js.map +1 -1
  255. package/dist/local/store/expo/adapter.d.ts +11 -11
  256. package/dist/local/store/expo/adapter.d.ts.map +1 -1
  257. package/dist/local/store/expo/adapter.js +9 -9
  258. package/dist/local/store/expo/adapter.js.map +1 -1
  259. package/dist/local/store/expo/database-key.d.ts +2 -2
  260. package/dist/local/store/expo/database-key.d.ts.map +1 -1
  261. package/dist/local/store/expo/database-key.js +5 -5
  262. package/dist/local/store/expo/database-key.js.map +1 -1
  263. package/dist/local/store/expo/db.d.ts +9 -9
  264. package/dist/local/store/expo/db.d.ts.map +1 -1
  265. package/dist/local/store/expo/db.js +3 -3
  266. package/dist/local/store/expo/db.js.map +1 -1
  267. package/dist/local/store/expo/index.d.ts +7 -7
  268. package/dist/local/store/expo/index.d.ts.map +1 -1
  269. package/dist/local/store/expo/index.js +3 -3
  270. package/dist/local/store/expo/index.js.map +1 -1
  271. package/dist/local/store/expo/key-storage.d.ts +1 -1
  272. package/dist/local/store/expo/key-storage.d.ts.map +1 -1
  273. package/dist/local/store/expo/key-storage.js +4 -4
  274. package/dist/local/store/expo/key-storage.js.map +1 -1
  275. package/dist/local/store/expo/models/local-identity.d.ts +1 -1
  276. package/dist/local/store/expo/models/local-identity.js +1 -1
  277. package/dist/local/store/expo/models/sender-key.d.ts +3 -3
  278. package/dist/local/store/expo/models/sender-key.d.ts.map +1 -1
  279. package/dist/local/store/expo/models/sender-key.js +3 -3
  280. package/dist/local/store/expo/models/sender-key.js.map +1 -1
  281. package/dist/local/store/expo/schema.d.ts +1 -1
  282. package/dist/local/store/expo/schema.js +1 -1
  283. package/dist/local/store/expo/secure-store-options.d.ts +2 -2
  284. package/dist/local/store/expo/secure-store-options.d.ts.map +1 -1
  285. package/dist/local/store/expo/secure-store-options.js +1 -1
  286. package/dist/local/store/expo/secure-store-options.js.map +1 -1
  287. package/dist/local/store/index.d.ts +9 -9
  288. package/dist/local/store/index.d.ts.map +1 -1
  289. package/dist/local/store/index.js +8 -8
  290. package/dist/local/store/index.js.map +1 -1
  291. package/dist/local/store/mock/adapter.d.ts +10 -4
  292. package/dist/local/store/mock/adapter.d.ts.map +1 -1
  293. package/dist/local/store/mock/adapter.js +119 -49
  294. package/dist/local/store/mock/adapter.js.map +1 -1
  295. package/dist/local/store/mock/failures.d.ts +34 -0
  296. package/dist/local/store/mock/failures.d.ts.map +1 -0
  297. package/dist/local/store/mock/failures.js +75 -0
  298. package/dist/local/store/mock/failures.js.map +1 -0
  299. package/dist/local/store/mock/index.d.ts +4 -3
  300. package/dist/local/store/mock/index.d.ts.map +1 -1
  301. package/dist/local/store/mock/index.js +5 -4
  302. package/dist/local/store/mock/index.js.map +1 -1
  303. package/dist/local/store/node/adapter.d.ts +4 -4
  304. package/dist/local/store/node/adapter.d.ts.map +1 -1
  305. package/dist/local/store/node/adapter.js +2 -2
  306. package/dist/local/store/node/adapter.js.map +1 -1
  307. package/dist/local/store/node/database-key.js +1 -1
  308. package/dist/local/store/node/database.d.ts.map +1 -1
  309. package/dist/local/store/node/database.js +2 -2
  310. package/dist/local/store/node/database.js.map +1 -1
  311. package/dist/local/store/node/index.d.ts +4 -4
  312. package/dist/local/store/node/index.d.ts.map +1 -1
  313. package/dist/local/store/node/index.js +3 -3
  314. package/dist/local/store/node/index.js.map +1 -1
  315. package/dist/local/store/react-native/adapter.d.ts +5 -5
  316. package/dist/local/store/react-native/adapter.d.ts.map +1 -1
  317. package/dist/local/store/react-native/adapter.js +14 -14
  318. package/dist/local/store/react-native/adapter.js.map +1 -1
  319. package/dist/local/store/react-native/index.d.ts +4 -4
  320. package/dist/local/store/react-native/index.d.ts.map +1 -1
  321. package/dist/local/store/react-native/index.js +3 -3
  322. package/dist/local/store/react-native/index.js.map +1 -1
  323. package/dist/local/store/react-native/storage.d.ts +2 -2
  324. package/dist/local/store/web/adapter.d.ts +4 -4
  325. package/dist/local/store/web/adapter.d.ts.map +1 -1
  326. package/dist/local/store/web/adapter.js +21 -9
  327. package/dist/local/store/web/adapter.js.map +1 -1
  328. package/dist/local/store/web/index.d.ts +4 -4
  329. package/dist/local/store/web/index.d.ts.map +1 -1
  330. package/dist/local/store/web/index.js +3 -3
  331. package/dist/local/store/web/index.js.map +1 -1
  332. package/dist/local/vault/expo-secure-store.d.ts +2 -2
  333. package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
  334. package/dist/local/vault/expo-secure-store.js +5 -5
  335. package/dist/local/vault/expo-secure-store.js.map +1 -1
  336. package/dist/local/vault/index.d.ts +3 -3
  337. package/dist/local/vault/index.d.ts.map +1 -1
  338. package/dist/local/vault/index.js +1 -1
  339. package/dist/local/vault/index.js.map +1 -1
  340. package/dist/logger.d.ts +4 -4
  341. package/dist/logger.d.ts.map +1 -1
  342. package/dist/logger.js +5 -5
  343. package/dist/logger.js.map +1 -1
  344. package/dist/media/index.d.ts +7 -7
  345. package/dist/media/index.d.ts.map +1 -1
  346. package/dist/media/index.js +2 -2
  347. package/dist/profile/cipher.d.ts +1 -1
  348. package/dist/profile/cipher.js +1 -1
  349. package/dist/profile/contact-state.d.ts +1 -1
  350. package/dist/profile/contact-state.d.ts.map +1 -1
  351. package/dist/profile/contact-state.js +3 -3
  352. package/dist/profile/contact-state.js.map +1 -1
  353. package/dist/profile/crypto.d.ts +1 -1
  354. package/dist/profile/crypto.js +1 -1
  355. package/dist/profile/profile-key.d.ts.map +1 -1
  356. package/dist/profile/profile-key.js +3 -3
  357. package/dist/profile/profile-key.js.map +1 -1
  358. package/dist/profile/update-service.d.ts +2 -2
  359. package/dist/profile/update-service.d.ts.map +1 -1
  360. package/dist/profile/update-service.js +2 -2
  361. package/dist/profile/update-service.js.map +1 -1
  362. package/dist/remote/object-store/convex-r2/server.d.ts +1 -1
  363. package/dist/remote/object-store/convex-r2/storage.d.ts +2 -2
  364. package/dist/remote/object-store/convex-r2/storage.d.ts.map +1 -1
  365. package/dist/remote/object-store/index.d.ts +1 -1
  366. package/dist/remote/object-store/index.d.ts.map +1 -1
  367. package/dist/remote/object-store/s3/storage.d.ts +3 -3
  368. package/dist/remote/object-store/s3/storage.d.ts.map +1 -1
  369. package/dist/remote/object-store/s3/storage.js +1 -1
  370. package/dist/remote/object-store/types.d.ts +1 -1
  371. package/dist/remote/object-store/types.d.ts.map +1 -1
  372. package/dist/remote/relay/convex/index.d.ts +10 -10
  373. package/dist/remote/relay/convex/index.d.ts.map +1 -1
  374. package/dist/remote/relay/convex/index.js +6 -6
  375. package/dist/remote/relay/convex/index.js.map +1 -1
  376. package/dist/remote/relay/convex/relay.d.ts +13 -13
  377. package/dist/remote/relay/convex/relay.d.ts.map +1 -1
  378. package/dist/remote/relay/convex/relay.js +12 -12
  379. package/dist/remote/relay/convex/relay.js.map +1 -1
  380. package/dist/remote/relay/convex/types.d.ts +7 -7
  381. package/dist/remote/relay/convex/types.js +1 -1
  382. package/dist/remote/relay/index.d.ts +7 -7
  383. package/dist/remote/relay/index.d.ts.map +1 -1
  384. package/dist/remote/relay/index.js +6 -6
  385. package/dist/remote/relay/index.js.map +1 -1
  386. package/dist/remote/relay/mock/adapter.d.ts +17 -6
  387. package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
  388. package/dist/remote/relay/mock/adapter.js +173 -54
  389. package/dist/remote/relay/mock/adapter.js.map +1 -1
  390. package/dist/remote/relay/mock/failures.d.ts +58 -0
  391. package/dist/remote/relay/mock/failures.d.ts.map +1 -0
  392. package/dist/remote/relay/mock/failures.js +123 -0
  393. package/dist/remote/relay/mock/failures.js.map +1 -0
  394. package/dist/remote/relay/mock/index.d.ts +4 -3
  395. package/dist/remote/relay/mock/index.d.ts.map +1 -1
  396. package/dist/remote/relay/mock/index.js +5 -4
  397. package/dist/remote/relay/mock/index.js.map +1 -1
  398. package/dist/remote/relay/types.d.ts +12 -12
  399. package/dist/remote/relay/types.d.ts.map +1 -1
  400. package/dist/remote/relay/types.js +3 -3
  401. package/dist/safety/protobuf.d.ts +1 -1
  402. package/dist/safety/protobuf.d.ts.map +1 -1
  403. package/dist/types/api.d.ts +8 -8
  404. package/dist/types/api.d.ts.map +1 -1
  405. package/dist/types/errors.d.ts +2 -2
  406. package/dist/types/errors.d.ts.map +1 -1
  407. package/dist/types/errors.js +2 -2
  408. package/dist/types/errors.js.map +1 -1
  409. package/dist/types/messages.d.ts +1 -1
  410. package/dist/types/protocol-config.d.ts +20 -4
  411. package/dist/types/protocol-config.d.ts.map +1 -1
  412. package/dist/types/protocol-config.js +17 -2
  413. package/dist/types/protocol-config.js.map +1 -1
  414. package/dist/types/protocol-constants.d.ts +1 -1
  415. package/dist/types/protocol-constants.js +1 -1
  416. package/dist/utils/binary-transfer.d.ts +1 -1
  417. package/dist/utils/errors.d.ts +2 -2
  418. package/dist/utils/errors.js +2 -2
  419. package/dist/utils/retry.d.ts +4 -3
  420. package/dist/utils/retry.d.ts.map +1 -1
  421. package/dist/utils/retry.js +20 -1
  422. package/dist/utils/retry.js.map +1 -1
  423. package/dist/zk/groups.d.ts +1 -1
  424. package/dist/zk/groups.js +1 -1
  425. package/docs/CLIENT_COMPOSITION.md +7 -5
  426. package/docs/DEVIATIONS.md +97 -80
  427. package/docs/GETTING_STARTED.md +12 -8
  428. package/docs/INTERFACES.md +22 -22
  429. package/docs/PACKAGE_SURFACE.md +12 -12
  430. package/docs/PROTOCOL_POLICY.md +2 -2
  431. package/docs/RECIPES.md +6 -2
  432. package/docs/api/classes/EndorsementManager.md +1 -1
  433. package/docs/api/classes/{SignalBlockingManager.md → SignalProtocolBlockingManager.md} +5 -5
  434. package/docs/api/classes/SignalProtocolClient.md +4 -4
  435. package/docs/api/functions/createDefaultSignalProtocolContentAdapter.md +13 -0
  436. package/docs/api/functions/{createDefaultSignalLogger.md → createDefaultSignalProtocolLogger.md} +5 -5
  437. package/docs/api/functions/{resolveSignalLogger.md → resolveSignalProtocolLogger.md} +5 -5
  438. package/docs/api/interfaces/BlockedRecipientEntry.md +1 -1
  439. package/docs/api/interfaces/ILogger.md +1 -1
  440. package/docs/api/interfaces/IProtocolStore.md +1 -1
  441. package/docs/api/interfaces/ISenderKeyStore.md +1 -1
  442. package/docs/api/interfaces/ISesameStore.md +1 -1
  443. package/docs/api/interfaces/ISignalProtocolClient.md +2 -2
  444. package/docs/api/interfaces/{ISignalLocalSecretVault.md → ISignalProtocolLocalSecretVault.md} +4 -4
  445. package/docs/api/interfaces/{ISignalLocalStore.md → ISignalProtocolLocalStore.md} +4 -4
  446. package/docs/api/interfaces/{ISignalRelayServer.md → ISignalProtocolRelayServer.md} +3 -3
  447. package/docs/api/interfaces/{InspectedSignalContent.md → InspectedSignalProtocolContent.md} +2 -2
  448. package/docs/api/interfaces/MLKEMBraidAgentState.md +1 -1
  449. package/docs/api/interfaces/MessageHeader.md +1 -1
  450. package/docs/api/interfaces/PreKeyMaintenanceStore.md +2 -1
  451. package/docs/api/interfaces/SealedSenderConfig.md +1 -1
  452. package/docs/api/interfaces/{SignalBlockingHooks.md → SignalProtocolBlockingHooks.md} +2 -2
  453. package/docs/api/interfaces/SignalProtocolBlockingManagerOptions.md +31 -0
  454. package/docs/api/interfaces/{SignalBlockingMirror.md → SignalProtocolBlockingMirror.md} +2 -2
  455. package/docs/api/interfaces/{SignalBlockingStore.md → SignalProtocolBlockingStore.md} +2 -2
  456. package/docs/api/interfaces/SignalProtocolClientAdapterConfig.md +3 -3
  457. package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +2 -2
  458. package/docs/api/interfaces/SignalProtocolClientConfig.md +10 -10
  459. package/docs/api/interfaces/SignalProtocolClientHooks.md +1 -1
  460. package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +1 -1
  461. package/docs/api/interfaces/SignalProtocolClientMediaConfig.md +2 -2
  462. package/docs/api/interfaces/SignalProtocolConfig.md +1 -1
  463. package/docs/api/interfaces/{SignalContentAdapter.md → SignalProtocolContentAdapter.md} +4 -4
  464. package/docs/api/interfaces/{SignalRemoteObjectStore.md → SignalProtocolRemoteObjectStore.md} +2 -2
  465. package/docs/api/namespaces/blocking/README.md +10 -10
  466. package/docs/api/namespaces/encoding/functions/bytesToUrlSafeBase64.md +2 -2
  467. package/docs/api/namespaces/keys/functions/generateKemOneTimePreKeys.md +1 -1
  468. package/docs/api/namespaces/media/functions/prepareMediaAttachmentUpload.md +1 -1
  469. package/docs/api/namespaces/media/functions/resolveMediaAttachment.md +1 -1
  470. package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentOptions.md +1 -1
  471. package/docs/api/namespaces/media/interfaces/ExecuteMediaAttachmentJobOptions.md +1 -1
  472. package/docs/api/namespaces/media/interfaces/PrepareMediaAttachmentUploadOptions.md +1 -1
  473. package/docs/api/namespaces/media/interfaces/ResolveMediaAttachmentOptions.md +1 -1
  474. package/docs/api/namespaces/media/variables/downloadMediaAttachment.md +1 -1
  475. package/docs/api/type-aliases/GroupId.md +1 -1
  476. package/docs/api/variables/MAX_RECEIVER_CHAINS.md +1 -1
  477. package/docs/api/variables/ONE_TIME_PREKEY_BATCH_SIZE.md +1 -1
  478. package/docs/api/variables/{defaultSignalLogger.md → defaultSignalProtocolLogger.md} +5 -5
  479. package/files/README.md +1 -1
  480. package/local/store/README.md +10 -10
  481. package/local/store/expo/README.md +5 -5
  482. package/local/store/mock/README.md +32 -1
  483. package/local/store/node/README.md +1 -1
  484. package/local/store/react-native/README.md +1 -1
  485. package/local/store/web/README.md +1 -1
  486. package/local/vault/README.md +3 -3
  487. package/package.json +1 -1
  488. package/remote/README.md +19 -19
  489. package/remote/object-store/README.md +3 -3
  490. package/remote/object-store/convex-r2/README.md +1 -1
  491. package/remote/object-store/s3/README.md +1 -1
  492. package/remote/relay/README.md +2 -2
  493. package/remote/relay/convex/README.md +4 -4
  494. package/remote/relay/mock/README.md +38 -1
  495. package/types/README.md +1 -1
  496. package/docs/api/functions/createDefaultSignalContentAdapter.md +0 -13
  497. package/docs/api/interfaces/SignalBlockingManagerOptions.md +0 -31
@@ -1,7 +1,7 @@
1
1
  # Convex Relay Adapter
2
2
 
3
3
  The Convex relay adapter maps an application-owned generated Convex API module
4
- to `ISignalRelayServer`.
4
+ to `ISignalProtocolRelayServer`.
5
5
 
6
6
  ## Why it exists
7
7
 
@@ -24,11 +24,11 @@ pass that namespace directly:
24
24
  import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
25
25
  import {
26
26
  convexRelay,
27
- type ConvexSignalRelayApi,
27
+ type ConvexSignalProtocolRelayApi,
28
28
  } from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
29
29
  import { api } from "../convex/_generated/api";
30
30
 
31
- const signalApi = api.signal satisfies ConvexSignalRelayApi;
31
+ const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
32
32
 
33
33
  const relay = convexRelay({
34
34
  convex,
@@ -43,7 +43,7 @@ const client = await createSignalProtocolClient({
43
43
  ```
44
44
 
45
45
  The generated `api.signal` namespace must expose the nested functions described
46
- by `ConvexSignalRelayApi`. Use `satisfies` to get a compile-time diagnostic
46
+ by `ConvexSignalProtocolRelayApi`. Use `satisfies` to get a compile-time diagnostic
47
47
  without widening the generated references.
48
48
 
49
49
  Public-key reads may be available to authenticated peers, but every write must
@@ -1,8 +1,10 @@
1
1
  # In-Memory Relay
2
2
 
3
- `MockSignalRelayServer` implements `ISignalRelayServer` in memory for examples
3
+ `MockSignalProtocolRelayServer` implements `ISignalProtocolRelayServer` in memory for examples
4
4
  and local application development.
5
5
 
6
+ Real protocol and cryptography; simulated in-memory infrastructure.
7
+
6
8
  ## Why it exists
7
9
 
8
10
  It provides device registration, public-prekey exchange, and encrypted-envelope
@@ -12,6 +14,7 @@ authorization or durability boundary.
12
14
  ## Usage
13
15
 
14
16
  ```ts
17
+ // Real protocol and cryptography; simulated in-memory infrastructure.
15
18
  import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
16
19
  import { mockStore } from "@open-e2ee/signal-protocol-sdk/local/store/mock";
17
20
  import { mockRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/mock";
@@ -29,4 +32,38 @@ All registered devices, public keys, mailboxes, and provisioning state disappear
29
32
  with the adapter. It performs no real account authentication, rate limiting,
30
33
  abuse prevention, or durable delivery and must not be used in production.
31
34
 
35
+ ## Deterministic failure and recovery exercises
36
+
37
+ Failure mode is opt-in and seeded. The default `mockRelay()` remains the
38
+ deterministic happy path:
39
+
40
+ ```ts
41
+ // Real protocol and cryptography; simulated in-memory infrastructure.
42
+ import { mockRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/mock";
43
+
44
+ const relay = mockRelay({
45
+ failures: {
46
+ seed: 7,
47
+ latencyMs: 20,
48
+ duplicateDeliveryEvery: 3,
49
+ reorderDeliveryPairs: true,
50
+ rejectAuthorization: true,
51
+ exhaustOneTimePreKeys: true,
52
+ },
53
+ });
54
+
55
+ relay.failures.disconnect("bob", 1);
56
+ // Sends remain in Bob's encrypted mailbox.
57
+ relay.failures.reconnect("bob", 1);
58
+ ```
59
+
60
+ `flushReordered()` releases an unmatched final envelope. `configure()` changes
61
+ a scenario without rebuilding clients. Authorization rejection raises
62
+ `SealedSenderAuthError`, allowing the client's documented identified-delivery
63
+ fallback. One-time-prekey exhaustion withholds both EC and KEM one-time keys but
64
+ keeps the KEM last-resort key, so strict-PQ examples exercise the intended
65
+ post-quantum recovery path rather than a silent classical downgrade. Failure
66
+ selection uses the configured seed and delivery count, never `Math.random()` or
67
+ wall-clock time.
68
+
32
69
  See the parent [relay guide](../README.md).
package/types/README.md CHANGED
@@ -14,7 +14,7 @@ contracts they validate.
14
14
 
15
15
  ```ts
16
16
  import type {
17
- ISignalLocalStore,
17
+ ISignalProtocolLocalStore,
18
18
  ISignalProtocolClient,
19
19
  SignalProtocolConfig,
20
20
  } from "@open-e2ee/signal-protocol-sdk/types";
@@ -1,13 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / createDefaultSignalContentAdapter
6
-
7
- # Function: createDefaultSignalContentAdapter()
8
-
9
- > **createDefaultSignalContentAdapter**(): [`SignalContentAdapter`](../interfaces/SignalContentAdapter.md)
10
-
11
- ## Returns
12
-
13
- [`SignalContentAdapter`](../interfaces/SignalContentAdapter.md)
@@ -1,31 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / SignalBlockingManagerOptions
6
-
7
- # Interface: SignalBlockingManagerOptions
8
-
9
- ## Properties
10
-
11
- ### hooks?
12
-
13
- > `optional` **hooks?**: [`SignalBlockingHooks`](SignalBlockingHooks.md)
14
-
15
- ***
16
-
17
- ### logger?
18
-
19
- > `optional` **logger?**: [`ILogger`](ILogger.md)
20
-
21
- ***
22
-
23
- ### mirror?
24
-
25
- > `optional` **mirror?**: [`SignalBlockingMirror`](SignalBlockingMirror.md)
26
-
27
- ***
28
-
29
- ### store
30
-
31
- > **store**: [`SignalBlockingStore`](SignalBlockingStore.md)