@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
@@ -46,7 +46,7 @@ Delete app-owned local cache state for a cleanup job.
46
46
 
47
47
  Load app-owned local bytes for a queued upload.
48
48
 
49
- The Signal package owns encryption and upload execution. The app owns draft
49
+ The Signal Protocol package owns encryption and upload execution. The app owns draft
50
50
  files, cache paths, and file permissions, so bytes enter the queue through
51
51
  this callback instead of hidden package storage.
52
52
 
@@ -80,7 +80,7 @@ Maximum attempts before a failing job is removed.
80
80
 
81
81
  > `optional` **maxJobs?**: `number`
82
82
 
83
- Bound the queue kept in the Signal local store metadata.
83
+ Bound the queue kept in the Signal Protocol local store metadata.
84
84
 
85
85
  #### Default
86
86
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: SignalProtocolConfig
8
8
 
9
- Public Signal protocol configuration.
9
+ Public Signal Protocol configuration.
10
10
 
11
11
  This keeps application code in product/security terms. Internal protocol
12
12
  strategy details such as X3DH fallback remain below the SignalProtocolClient seam.
@@ -2,9 +2,9 @@
2
2
 
3
3
  ***
4
4
 
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / SignalContentAdapter
5
+ [@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolContentAdapter
6
6
 
7
- # Interface: SignalContentAdapter
7
+ # Interface: SignalProtocolContentAdapter
8
8
 
9
9
  ## Methods
10
10
 
@@ -30,7 +30,7 @@
30
30
 
31
31
  ### inspectContent()
32
32
 
33
- > **inspectContent**(`plaintext`): [`InspectedSignalContent`](InspectedSignalContent.md)
33
+ > **inspectContent**(`plaintext`): [`InspectedSignalProtocolContent`](InspectedSignalProtocolContent.md)
34
34
 
35
35
  #### Parameters
36
36
 
@@ -40,7 +40,7 @@
40
40
 
41
41
  #### Returns
42
42
 
43
- [`InspectedSignalContent`](InspectedSignalContent.md)
43
+ [`InspectedSignalProtocolContent`](InspectedSignalProtocolContent.md)
44
44
 
45
45
  ***
46
46
 
@@ -2,9 +2,9 @@
2
2
 
3
3
  ***
4
4
 
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / SignalRemoteObjectStore
5
+ [@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolRemoteObjectStore
6
6
 
7
- # Interface: SignalRemoteObjectStore
7
+ # Interface: SignalProtocolRemoteObjectStore
8
8
 
9
9
  Brokered remote storage for encrypted byte objects.
10
10
 
@@ -14,30 +14,30 @@ Re-exports [BlockedRecipientEntry](../../interfaces/BlockedRecipientEntry.md)
14
14
 
15
15
  ***
16
16
 
17
- ### SignalBlockingHooks
17
+ ### SignalProtocolBlockingHooks
18
18
 
19
- Re-exports [SignalBlockingHooks](../../interfaces/SignalBlockingHooks.md)
19
+ Re-exports [SignalProtocolBlockingHooks](../../interfaces/SignalProtocolBlockingHooks.md)
20
20
 
21
21
  ***
22
22
 
23
- ### SignalBlockingManager
23
+ ### SignalProtocolBlockingManager
24
24
 
25
- Re-exports [SignalBlockingManager](../../classes/SignalBlockingManager.md)
25
+ Re-exports [SignalProtocolBlockingManager](../../classes/SignalProtocolBlockingManager.md)
26
26
 
27
27
  ***
28
28
 
29
- ### SignalBlockingManagerOptions
29
+ ### SignalProtocolBlockingManagerOptions
30
30
 
31
- Re-exports [SignalBlockingManagerOptions](../../interfaces/SignalBlockingManagerOptions.md)
31
+ Re-exports [SignalProtocolBlockingManagerOptions](../../interfaces/SignalProtocolBlockingManagerOptions.md)
32
32
 
33
33
  ***
34
34
 
35
- ### SignalBlockingMirror
35
+ ### SignalProtocolBlockingMirror
36
36
 
37
- Re-exports [SignalBlockingMirror](../../interfaces/SignalBlockingMirror.md)
37
+ Re-exports [SignalProtocolBlockingMirror](../../interfaces/SignalProtocolBlockingMirror.md)
38
38
 
39
39
  ***
40
40
 
41
- ### SignalBlockingStore
41
+ ### SignalProtocolBlockingStore
42
42
 
43
- Re-exports [SignalBlockingStore](../../interfaces/SignalBlockingStore.md)
43
+ Re-exports [SignalProtocolBlockingStore](../../interfaces/SignalProtocolBlockingStore.md)
@@ -15,8 +15,8 @@ URL-safe Base64 uses:
15
15
  - `_` instead of `/`
16
16
  - No padding (`=`)
17
17
 
18
- Used for R2 storage keys (attachments, profiles) following the Signal
19
- Messenger storage-key pattern.
18
+ Used for R2 storage keys (attachments, profiles), which must survive being
19
+ placed in a URL path without escaping.
20
20
 
21
21
  ## Parameters
22
22
 
@@ -16,7 +16,7 @@ Each key can only be used once for per-session post-quantum forward secrecy.
16
16
  Per PQXDH spec Section 3.2, these are signed one-time pqkem prekeys
17
17
  that the server prefers over the last-resort KEM prekey.
18
18
 
19
- Uses the same batch size as EC one-time prekeys (Signal uses 100 for both).
19
+ Uses the same batch size as EC one-time prekeys (the reference implementation uses 100 for both).
20
20
 
21
21
  ## Parameters
22
22
 
@@ -13,7 +13,7 @@ Encrypt and upload media bytes, returning a SDK attachment pointer.
13
13
  The encrypted object digest and object ID are computed once. Upload
14
14
  retries request fresh presigned URLs for that same key, which handles expired
15
15
  upload URLs without changing the pointer metadata that will be encrypted into
16
- the Signal message.
16
+ the Signal Protocol message.
17
17
 
18
18
  ## Parameters
19
19
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **resolveMediaAttachment**(`attachment`, `options`): `Promise`\<[`ResolvedMediaAttachment`](../interfaces/ResolvedMediaAttachment.md)\>
10
10
 
11
- Download, verify, and decrypt a Signal media attachment pointer.
11
+ Download, verify, and decrypt a Signal Protocol media attachment pointer.
12
12
 
13
13
  This is the safe receive-side counterpart to attachment upload. It validates
14
14
  pointer metadata, downloads opaque ciphertext from the object store, verifies
@@ -16,7 +16,7 @@
16
16
 
17
17
  ### remoteObjectStore
18
18
 
19
- > **remoteObjectStore**: [`SignalRemoteObjectStore`](../../../interfaces/SignalRemoteObjectStore.md)
19
+ > **remoteObjectStore**: [`SignalProtocolRemoteObjectStore`](../../../interfaces/SignalProtocolRemoteObjectStore.md)
20
20
 
21
21
  ***
22
22
 
@@ -76,7 +76,7 @@
76
76
 
77
77
  ### remoteObjectStore
78
78
 
79
- > **remoteObjectStore**: [`SignalRemoteObjectStore`](../../../interfaces/SignalRemoteObjectStore.md)
79
+ > **remoteObjectStore**: [`SignalProtocolRemoteObjectStore`](../../../interfaces/SignalProtocolRemoteObjectStore.md)
80
80
 
81
81
  ***
82
82
 
@@ -88,7 +88,7 @@
88
88
 
89
89
  ### remoteObjectStore
90
90
 
91
- > **remoteObjectStore**: [`SignalRemoteObjectStore`](../../../interfaces/SignalRemoteObjectStore.md)
91
+ > **remoteObjectStore**: [`SignalProtocolRemoteObjectStore`](../../../interfaces/SignalProtocolRemoteObjectStore.md)
92
92
 
93
93
  ***
94
94
 
@@ -28,7 +28,7 @@
28
28
 
29
29
  ### remoteObjectStore
30
30
 
31
- > **remoteObjectStore**: [`SignalRemoteObjectStore`](../../../interfaces/SignalRemoteObjectStore.md)
31
+ > **remoteObjectStore**: [`SignalProtocolRemoteObjectStore`](../../../interfaces/SignalProtocolRemoteObjectStore.md)
32
32
 
33
33
  ***
34
34
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **downloadMediaAttachment**: (`attachment`, `options`) => `Promise`\<[`ResolvedMediaAttachment`](../interfaces/ResolvedMediaAttachment.md)\> = `resolveMediaAttachment`
10
10
 
11
- Download, verify, and decrypt a Signal media attachment pointer.
11
+ Download, verify, and decrypt a Signal Protocol media attachment pointer.
12
12
 
13
13
  This is the safe receive-side counterpart to attachment upload. It validates
14
14
  pointer metadata, downloads opaque ciphertext from the object store, verifies
@@ -11,7 +11,7 @@
11
11
  Branded type for prefixed group IDs
12
12
 
13
13
  Ensures compile-time safety for group ID handling.
14
- A GroupId is always a string with the Signal V2 prefix.
14
+ A GroupId is always a string with the Signal Protocol V2 prefix.
15
15
 
16
16
  ## Type Declaration
17
17
 
@@ -10,5 +10,5 @@
10
10
 
11
11
  Maximum number of receiver chains to store.
12
12
 
13
- Signal maintains up to 5 receiver chains for handling out-of-order
13
+ The reference implementation maintains up to 5 receiver chains for handling out-of-order
14
14
  DH ratchets. When a 6th chain would be added, the oldest is evicted.
@@ -10,7 +10,7 @@
10
10
 
11
11
  Batch size for one-time prekeys (both EC and KEM)
12
12
 
13
- Signal uses 100 for both EC and KEM one-time prekeys to maintain
13
+ The reference implementation uses 100 for both EC and KEM one-time prekeys to maintain
14
14
  protocol symmetry. This balances key availability with storage/upload costs.
15
15
 
16
16
  Per PQXDH specification, KEM one-time prekeys follow the same
@@ -2,16 +2,16 @@
2
2
 
3
3
  ***
4
4
 
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / defaultSignalLogger
5
+ [@open-e2ee/signal-protocol-sdk](../README.md) / defaultSignalProtocolLogger
6
6
 
7
- # Variable: defaultSignalLogger
7
+ # Variable: defaultSignalProtocolLogger
8
8
 
9
- > `const` **defaultSignalLogger**: `Required`\<[`ILogger`](../interfaces/ILogger.md)\>
9
+ > `const` **defaultSignalProtocolLogger**: `Required`\<[`ILogger`](../interfaces/ILogger.md)\>
10
10
 
11
11
  Logging utilities for app composition
12
12
 
13
- Pass a logger into `createSignalProtocolClient()` to route Signal logs through your
14
- app logger or custom diagnostics pipeline.
13
+ Pass a logger into `createSignalProtocolClient()` to route Signal Protocol logs through
14
+ your app logger or custom diagnostics pipeline.
15
15
 
16
16
  ## Example
17
17
 
package/files/README.md CHANGED
@@ -29,7 +29,7 @@ const plaintext = await streamingDecrypt(
29
29
  For a complete attachment workflow with upload brokering, retries, pointer
30
30
  validation, and cleanup, use the
31
31
  [`media`](../media/README.md) module with a
32
- [`SignalRemoteObjectStore`](../remote/object-store/README.md).
32
+ [`SignalProtocolRemoteObjectStore`](../remote/object-store/README.md).
33
33
 
34
34
  Applications remain responsible for file-system permissions, cache lifetime,
35
35
  content rendering, and securely disposing of decrypted temporary files.
@@ -1,6 +1,6 @@
1
1
  # Storage Guide
2
2
 
3
- > Infrastructure | Implements `ISignalLocalStore` | [Architecture](../../ARCHITECTURE.md)
3
+ > Infrastructure | Implements `ISignalProtocolLocalStore` | [Architecture](../../ARCHITECTURE.md)
4
4
 
5
5
  The storage layer owns device-local Signal Protocol state: identity keys,
6
6
  contact trust, prekeys, sessions, and retry/message-record metadata.
@@ -8,26 +8,26 @@ contact trust, prekeys, sessions, and retry/message-record metadata.
8
8
  ## Why it exists
9
9
 
10
10
  Protocol state must survive restarts and several security transitions must
11
- commit atomically. `ISignalLocalStore` makes those requirements explicit
11
+ commit atomically. `ISignalProtocolLocalStore` makes those requirements explicit
12
12
  without coupling the client to a database or platform.
13
13
 
14
14
  ## Current Support
15
15
 
16
16
  ### Primary supported adapter
17
17
 
18
- - `ExpoSignalStore` from `@open-e2ee/signal-protocol-sdk/local/store/expo`
18
+ - `ExpoSignalProtocolStore` from `@open-e2ee/signal-protocol-sdk/local/store/expo`
19
19
  - Expo integration helpers from `@open-e2ee/signal-protocol-sdk/local/store/expo`, including
20
20
  `getKeyStorage`, `getDatabaseKeyManager`, `clearDatabaseKeyCache`, and
21
21
  `createPreKeyMaintenanceStore`
22
22
 
23
23
  ### Local development
24
24
 
25
- - `MockSignalStore` from `@open-e2ee/signal-protocol-sdk/local/store/mock`
25
+ - `MockSignalProtocolStore` from `@open-e2ee/signal-protocol-sdk/local/store/mock`
26
26
 
27
27
  ### Experimental
28
28
 
29
- - `IndexedDbSignalStore` from `@open-e2ee/signal-protocol-sdk/local/store/web`
30
- - `ReactNativeSignalStore` from `@open-e2ee/signal-protocol-sdk/local/store/react-native` (create it with `await ReactNativeSignalStore.create({ storage })` and provide your own key-value backend)
29
+ - `IndexedDbSignalProtocolStore` from `@open-e2ee/signal-protocol-sdk/local/store/web`
30
+ - `ReactNativeSignalProtocolStore` from `@open-e2ee/signal-protocol-sdk/local/store/react-native` (create it with `await ReactNativeSignalProtocolStore.create({ storage })` and provide your own key-value backend)
31
31
 
32
32
  These experimental adapters implement the full core store contract, including
33
33
  SESAME records, sender-key state, retry message records, and recovery helpers.
@@ -36,7 +36,7 @@ operational behavior require further deployment evidence.
36
36
 
37
37
  ### Node
38
38
 
39
- - `NodeSignalStore` from `@open-e2ee/signal-protocol-sdk/local/store/node`
39
+ - `NodeSignalProtocolStore` from `@open-e2ee/signal-protocol-sdk/local/store/node`
40
40
 
41
41
  Use this for non-mobile environments that need a filesystem-backed store.
42
42
 
@@ -44,11 +44,11 @@ Use this for non-mobile environments that need a filesystem-backed store.
44
44
 
45
45
  ```ts
46
46
  import { SignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
47
- import { ExpoSignalStore } from '@open-e2ee/signal-protocol-sdk/local/store/expo';
47
+ import { ExpoSignalProtocolStore } from '@open-e2ee/signal-protocol-sdk/local/store/expo';
48
48
 
49
49
  // Configure the application-owned Expo/SQLCipher database bindings first.
50
50
  const signal = await SignalProtocolClient.create(userId, {
51
- storage: new ExpoSignalStore(),
51
+ storage: new ExpoSignalProtocolStore(),
52
52
  });
53
53
  ```
54
54
 
@@ -56,7 +56,7 @@ The [Expo guide](./expo/README.md) shows the required database bootstrap.
56
56
 
57
57
  ## Storage Responsibilities
58
58
 
59
- An `ISignalLocalStore` implementation must preserve:
59
+ An `ISignalProtocolLocalStore` implementation must preserve:
60
60
 
61
61
  - account identity key storage
62
62
  - contact identity trust / TOFU decisions
@@ -1,6 +1,6 @@
1
1
  # Expo Store
2
2
 
3
- `ExpoSignalStore` implements `ISignalLocalStore` for Expo and React Native with
3
+ `ExpoSignalProtocolStore` implements `ISignalProtocolLocalStore` for Expo and React Native with
4
4
  an application-owned SQLite/Drizzle database and a database key held through
5
5
  the local secret-vault boundary.
6
6
 
@@ -20,7 +20,7 @@ the first query:
20
20
 
21
21
  ```ts
22
22
  import {
23
- configureSignalExpoDbBindings,
23
+ configureSignalProtocolExpoDbBindings,
24
24
  } from "@open-e2ee/signal-protocol-sdk/local/store/expo/db";
25
25
  import {
26
26
  getDatabaseKeyManager,
@@ -32,18 +32,18 @@ await keyManager.initialize();
32
32
  const sqlCipherPassword = await keyManager.getPassword();
33
33
 
34
34
  const { rawDatabase, drizzleDatabase } =
35
- await appDatabase.openEncryptedSignalDatabase({
35
+ await appDatabase.openEncryptedSignalProtocolDatabase({
36
36
  password: sqlCipherPassword,
37
37
  schema: signalSchema,
38
38
  });
39
39
 
40
- configureSignalExpoDbBindings({
40
+ configureSignalProtocolExpoDbBindings({
41
41
  getDrizzle: async () => drizzleDatabase,
42
42
  getRawDatabase: () => rawDatabase,
43
43
  });
44
44
  ```
45
45
 
46
- `appDatabase.openEncryptedSignalDatabase` represents application-owned database
46
+ `appDatabase.openEncryptedSignalProtocolDatabase` represents application-owned database
47
47
  bootstrap. It must enable SQLCipher through the `expo-sqlite` native
48
48
  configuration, apply the supplied key before schema access, create or migrate
49
49
  the exported tables, and return the matching raw and Drizzle handles. SQLCipher
@@ -1,8 +1,10 @@
1
1
  # In-Memory Store
2
2
 
3
- `MockSignalStore` implements `ISignalLocalStore` in memory for examples, local
3
+ `MockSignalProtocolStore` implements `ISignalProtocolLocalStore` in memory for examples, local
4
4
  development, and deterministic application prototypes.
5
5
 
6
+ Real protocol and cryptography; simulated in-memory infrastructure.
7
+
6
8
  ## Why it exists
7
9
 
8
10
  It lets developers exercise client composition without choosing a durable
@@ -12,6 +14,7 @@ security or persistence 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
 
@@ -24,4 +27,32 @@ const client = await createSignalProtocolClient({
24
27
  All keys, sessions, and trust decisions disappear when the process or adapter
25
28
  is discarded. Never use this adapter for production accounts.
26
29
 
30
+ ## Deterministic storage failures
31
+
32
+ Failure mode is opt-in. A seed and cadence replay the same failing writes, or
33
+ you can target the next named store operation:
34
+
35
+ ```ts
36
+ // Real protocol and cryptography; simulated in-memory infrastructure.
37
+ import {
38
+ mockStore,
39
+ MockStorageWriteError,
40
+ } from "@open-e2ee/signal-protocol-sdk/local/store/mock";
41
+
42
+ const storage = mockStore({ failures: { seed: 7 } });
43
+ storage.failures.failNextWrite("setMetadata");
44
+
45
+ try {
46
+ await storage.setMetadata("draft", "encrypted-pointer");
47
+ } catch (error) {
48
+ if (error instanceof MockStorageWriteError) {
49
+ // The explicitly injected failure is consumed, so this retry succeeds.
50
+ await storage.setMetadata("draft", "encrypted-pointer");
51
+ }
52
+ }
53
+ ```
54
+
55
+ Use `writeFailureEvery` for a repeatable cadence. Failure selection uses the
56
+ configured seed and operation count, never `Math.random()` or wall-clock time.
57
+
27
58
  See the parent [storage guide](../README.md).
@@ -1,6 +1,6 @@
1
1
  # Node Store
2
2
 
3
- `NodeSignalStore` implements `ISignalLocalStore` for Node.js using encrypted,
3
+ `NodeSignalProtocolStore` implements `ISignalProtocolLocalStore` for Node.js using encrypted,
4
4
  crash-durable filesystem state.
5
5
 
6
6
  ## Why it exists
@@ -1,6 +1,6 @@
1
1
  # Bare React Native Store
2
2
 
3
- `ReactNativeSignalStore` implements `ISignalLocalStore` for bare React Native
3
+ `ReactNativeSignalProtocolStore` implements `ISignalProtocolLocalStore` for bare React Native
4
4
  through an application-provided persistent key-value backend.
5
5
 
6
6
  ## Why it exists
@@ -1,6 +1,6 @@
1
1
  # IndexedDB Store
2
2
 
3
- `IndexedDbSignalStore` implements the full `ISignalLocalStore` contract for web
3
+ `IndexedDbSignalProtocolStore` implements the full `ISignalProtocolLocalStore` contract for web
4
4
  browsers using IndexedDB and Web Crypto.
5
5
 
6
6
  ## Why it exists
@@ -7,16 +7,16 @@ The local secret vault stores small bootstrap secrets through a minimal
7
7
 
8
8
  Platform secret managers are appropriate for tiny keys and bootstrap values,
9
9
  but not full session databases. Separating the vault from
10
- `ISignalLocalStore` keeps platform limits explicit and lets a local store use a
10
+ `ISignalProtocolLocalStore` keeps platform limits explicit and lets a local store use a
11
11
  vault-held wrapping key without placing every protocol record in the platform
12
12
  keychain.
13
13
 
14
14
  ## Expo usage
15
15
 
16
16
  ```ts
17
- import { ExpoSecureStoreSignalSecretVault } from "@open-e2ee/signal-protocol-sdk/local/vault/expo-secure-store";
17
+ import { ExpoSecureStoreSignalProtocolSecretVault } from "@open-e2ee/signal-protocol-sdk/local/vault/expo-secure-store";
18
18
 
19
- const vault = new ExpoSecureStoreSignalSecretVault();
19
+ const vault = new ExpoSecureStoreSignalProtocolSecretVault();
20
20
 
21
21
  await vault.setSecret("signal-store-wrapping-key", wrappingKey);
22
22
  const restored = await vault.getSecret("signal-store-wrapping-key");
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-e2ee/signal-protocol-sdk",
3
- "version": "0.1.0-alpha.4",
3
+ "version": "0.1.0-alpha.6",
4
4
  "description": "Signal Protocol E2EE SDK for TypeScript — Expo, React Native, browser, and Node. Post-quantum PQXDH and Double Ratchet.",
5
5
  "keywords": [
6
6
  "open-e2ee",
package/remote/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Remote Guide
2
2
 
3
- > Infrastructure | Implements `ISignalRelayServer` and `SignalRemoteObjectStore` | [Architecture](../ARCHITECTURE.md)
3
+ > Infrastructure | Implements `ISignalProtocolRelayServer` and `SignalProtocolRemoteObjectStore` | [Architecture](../ARCHITECTURE.md)
4
4
 
5
5
  The backend layer is responsible for server-owned protocol state: public
6
6
  prekeys, device registration, encrypted-envelope delivery, and provisioning
@@ -17,32 +17,32 @@ replaceable and prevent them from owning private keys or plaintext.
17
17
 
18
18
  ### Relay
19
19
 
20
- - `ConvexSignalRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/convex`
21
- - `MockSignalRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/mock`
22
- - custom implementations via `ISignalRelayServer`
20
+ - `ConvexSignalProtocolRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/convex`
21
+ - `MockSignalProtocolRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/mock`
22
+ - custom implementations via `ISignalProtocolRelayServer`
23
23
 
24
24
  ### Remote object storage
25
25
 
26
26
  - `ConvexR2ObjectStore` from `@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2`
27
27
  - `S3ObjectStore` from `@open-e2ee/signal-protocol-sdk/remote/object-store/s3`
28
- - custom implementations via `SignalRemoteObjectStore`
28
+ - custom implementations via `SignalProtocolRemoteObjectStore`
29
29
 
30
30
  ## Composition
31
31
 
32
32
  ```ts
33
33
  import { SignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
34
34
  import {
35
- ConvexSignalRelayServer,
36
- type ConvexSignalRelayApi,
35
+ ConvexSignalProtocolRelayServer,
36
+ type ConvexSignalProtocolRelayApi,
37
37
  } from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
38
- import { ExpoSignalStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
38
+ import { ExpoSignalProtocolStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
39
39
  import { api } from "../convex/_generated/api";
40
40
 
41
- const signalApi = api.signal satisfies ConvexSignalRelayApi;
41
+ const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
42
42
 
43
43
  const signal = await SignalProtocolClient.create(userId, {
44
- storage: new ExpoSignalStore(),
45
- relay: new ConvexSignalRelayServer(convex, signalApi, {
44
+ storage: new ExpoSignalProtocolStore(),
45
+ relay: new ConvexSignalProtocolRelayServer(convex, signalApi, {
46
46
  currentUserId: userId,
47
47
  }),
48
48
  });
@@ -50,7 +50,7 @@ const signal = await SignalProtocolClient.create(userId, {
50
50
 
51
51
  ## Relay Responsibilities
52
52
 
53
- An `ISignalRelayServer` implementation must preserve the package’s protocol semantics for:
53
+ An `ISignalProtocolRelayServer` implementation must preserve the package’s protocol semantics for:
54
54
 
55
55
  - identity and prekey upload
56
56
  - prekey bundle fetch
@@ -78,7 +78,7 @@ Bundle fetch must preserve one-time-prekey consumption semantics for concurrent
78
78
 
79
79
  ## Remote Object Storage
80
80
 
81
- `SignalRemoteObjectStore` is optional and only needed for encrypted attachment/file flows.
81
+ `SignalProtocolRemoteObjectStore` is optional and only needed for encrypted attachment/file flows.
82
82
 
83
83
  In practice, attachment and encrypted file support is a common consumer path,
84
84
  so object-store adapters should be treated as first-class integrations
@@ -190,22 +190,22 @@ needed to authorize and construct short-lived operations.
190
190
 
191
191
  ## Local development
192
192
 
193
- Use `MockSignalRelayServer` when multiple clients need a shared in-memory relay:
193
+ Use `MockSignalProtocolRelayServer` when multiple clients need a shared in-memory relay:
194
194
 
195
195
  ```ts
196
196
  import { SignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
197
- import { MockSignalRelayServer } from "@open-e2ee/signal-protocol-sdk/remote/relay/mock";
198
- import { MockSignalStore } from "@open-e2ee/signal-protocol-sdk/local/store/mock";
197
+ import { MockSignalProtocolRelayServer } from "@open-e2ee/signal-protocol-sdk/remote/relay/mock";
198
+ import { MockSignalProtocolStore } from "@open-e2ee/signal-protocol-sdk/local/store/mock";
199
199
 
200
- const relay = new MockSignalRelayServer();
200
+ const relay = new MockSignalProtocolRelayServer();
201
201
 
202
202
  const alice = await SignalProtocolClient.create("alice", {
203
- storage: new MockSignalStore(),
203
+ storage: new MockSignalProtocolStore(),
204
204
  relay,
205
205
  });
206
206
 
207
207
  const bob = await SignalProtocolClient.create("bob", {
208
- storage: new MockSignalStore(),
208
+ storage: new MockSignalProtocolStore(),
209
209
  relay,
210
210
  });
211
211
  ```
@@ -1,6 +1,6 @@
1
1
  # Remote Object Store
2
2
 
3
- `SignalRemoteObjectStore` is the provider-neutral client contract for uploading,
3
+ `SignalProtocolRemoteObjectStore` is the provider-neutral client contract for uploading,
4
4
  downloading, completing, and deleting encrypted byte objects through
5
5
  short-lived backend-brokered operations.
6
6
 
@@ -20,10 +20,10 @@ retry-stable requestId -> canonical objectId -> private provider key
20
20
 
21
21
  ```ts
22
22
  import type {
23
- SignalRemoteObjectStore,
23
+ SignalProtocolRemoteObjectStore,
24
24
  } from "@open-e2ee/signal-protocol-sdk/remote/object-store";
25
25
 
26
- const remoteObjectStore: SignalRemoteObjectStore = {
26
+ const remoteObjectStore: SignalProtocolRemoteObjectStore = {
27
27
  createUpload: (request) => appStorageApi.createUpload(request),
28
28
  createDownload: (request) => appStorageApi.createDownload(request),
29
29
  completeUpload: (request) => appStorageApi.completeUpload(request),
@@ -8,7 +8,7 @@ application's bucket, credentials, schema, authorization, or metadata model.
8
8
 
9
9
  The Convex client calls generated function references, while `@convex-dev/r2`
10
10
  operates inside the application backend. This adapter maps that generated API
11
- to `SignalRemoteObjectStore` without moving storage policy, provider keys, or
11
+ to `SignalProtocolRemoteObjectStore` without moving storage policy, provider keys, or
12
12
  component ownership into the SDK.
13
13
 
14
14
  ## Client usage
@@ -1,6 +1,6 @@
1
1
  # S3 Object Store
2
2
 
3
- The S3 adapter connects `SignalRemoteObjectStore` to an application-owned
3
+ The S3 adapter connects `SignalProtocolRemoteObjectStore` to an application-owned
4
4
  broker for Amazon S3 or a compatible object-storage service.
5
5
 
6
6
  ## Why it exists
@@ -1,6 +1,6 @@
1
1
  # Relay
2
2
 
3
- The relay module defines `ISignalRelayServer`, the application-backend contract
3
+ The relay module defines `ISignalProtocolRelayServer`, the application-backend contract
4
4
  for device discovery, public prekeys, encrypted envelopes, key rotation,
5
5
  provisioning, and related synchronization.
6
6
 
@@ -28,7 +28,7 @@ const client = await createSignalProtocolClient({
28
28
  await client.syncToServer();
29
29
  ```
30
30
 
31
- For production, implement `ISignalRelayServer` or use the
31
+ For production, implement `ISignalProtocolRelayServer` or use the
32
32
  [Convex adapter](./convex/README.md). The application backend must authenticate
33
33
  mutations, allocate linked-device IDs, consume one-time prekeys atomically,
34
34
  enforce access policy, and store only encrypted envelopes plus required routing