@open-e2ee/signal-protocol-sdk 0.1.0-alpha.1 → 0.1.0-alpha.10

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 (1086) hide show
  1. package/ADAPTERS.md +24 -24
  2. package/ARCHITECTURE.md +4 -4
  3. package/CHANGELOG.md +1319 -0
  4. package/COMMERCIAL.md +56 -0
  5. package/NOTICE +3 -1
  6. package/README.md +40 -35
  7. package/SECURITY.md +15 -1
  8. package/blocking/README.md +5 -5
  9. package/client/README.md +5 -5
  10. package/dist/blocking/index.d.ts +2 -2
  11. package/dist/blocking/index.d.ts.map +1 -1
  12. package/dist/blocking/index.js +1 -1
  13. package/dist/blocking/index.js.map +1 -1
  14. package/dist/blocking/manager.d.ts +7 -7
  15. package/dist/blocking/manager.d.ts.map +1 -1
  16. package/dist/blocking/manager.js +3 -3
  17. package/dist/blocking/manager.js.map +1 -1
  18. package/dist/blocking/types.d.ts +4 -4
  19. package/dist/blocking/types.d.ts.map +1 -1
  20. package/dist/blocking/types.js +1 -1
  21. package/dist/client/client.d.ts +48 -41
  22. package/dist/client/client.d.ts.map +1 -1
  23. package/dist/client/client.js +160 -101
  24. package/dist/client/client.js.map +1 -1
  25. package/dist/client/compose.d.ts +15 -10
  26. package/dist/client/compose.d.ts.map +1 -1
  27. package/dist/client/compose.js +2 -0
  28. package/dist/client/compose.js.map +1 -1
  29. package/dist/client/config.d.ts +68 -34
  30. package/dist/client/config.d.ts.map +1 -1
  31. package/dist/client/config.js.map +1 -1
  32. package/dist/client/content-adapter.d.ts +4 -4
  33. package/dist/client/content-adapter.d.ts.map +1 -1
  34. package/dist/client/content-adapter.js +1 -1
  35. package/dist/client/content-adapter.js.map +1 -1
  36. package/dist/client/dual-store.d.ts +5 -5
  37. package/dist/client/dual-store.d.ts.map +1 -1
  38. package/dist/client/dual-store.js.map +1 -1
  39. package/dist/client/endorsement-manager.d.ts +23 -2
  40. package/dist/client/endorsement-manager.d.ts.map +1 -1
  41. package/dist/client/endorsement-manager.js +37 -12
  42. package/dist/client/endorsement-manager.js.map +1 -1
  43. package/dist/client/event-hooks.d.ts +1 -1
  44. package/dist/client/groups.d.ts +29 -29
  45. package/dist/client/groups.d.ts.map +1 -1
  46. package/dist/client/groups.js +54 -37
  47. package/dist/client/groups.js.map +1 -1
  48. package/dist/client/headless.d.ts +12 -12
  49. package/dist/client/headless.d.ts.map +1 -1
  50. package/dist/client/headless.js +9 -9
  51. package/dist/client/headless.js.map +1 -1
  52. package/dist/client/index.d.ts +4 -4
  53. package/dist/client/index.d.ts.map +1 -1
  54. package/dist/client/index.js +1 -1
  55. package/dist/client/index.js.map +1 -1
  56. package/dist/client/key-rotation-core.d.ts +11 -11
  57. package/dist/client/key-rotation-core.d.ts.map +1 -1
  58. package/dist/client/key-rotation-core.js +22 -22
  59. package/dist/client/key-rotation-core.js.map +1 -1
  60. package/dist/client/media.d.ts +2 -2
  61. package/dist/client/media.js +5 -5
  62. package/dist/client/media.js.map +1 -1
  63. package/dist/client/messages.js +2 -2
  64. package/dist/client/messages.js.map +1 -1
  65. package/dist/client/prekeys.js +1 -1
  66. package/dist/client/prekeys.js.map +1 -1
  67. package/dist/client/relay-subscription.d.ts +2 -2
  68. package/dist/client/relay-subscription.d.ts.map +1 -1
  69. package/dist/client/relay-subscription.js +18 -1
  70. package/dist/client/relay-subscription.js.map +1 -1
  71. package/dist/client/retry.js +1 -1
  72. package/dist/client/retry.js.map +1 -1
  73. package/dist/client/sealed-sender-ops.d.ts +28 -2
  74. package/dist/client/sealed-sender-ops.d.ts.map +1 -1
  75. package/dist/client/sealed-sender-ops.js +40 -10
  76. package/dist/client/sealed-sender-ops.js.map +1 -1
  77. package/dist/client/sessions.d.ts.map +1 -1
  78. package/dist/client/sessions.js +3 -0
  79. package/dist/client/sessions.js.map +1 -1
  80. package/dist/client/signal-service-cipher.d.ts +34 -11
  81. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  82. package/dist/client/signal-service-cipher.js +149 -75
  83. package/dist/client/signal-service-cipher.js.map +1 -1
  84. package/dist/client/types.d.ts +28 -15
  85. package/dist/client/types.d.ts.map +1 -1
  86. package/dist/client/types.js.map +1 -1
  87. package/dist/device/connection.js +2 -2
  88. package/dist/device/connection.js.map +1 -1
  89. package/dist/device/device-id.d.ts.map +1 -1
  90. package/dist/device/device-id.js +4 -4
  91. package/dist/device/device-id.js.map +1 -1
  92. package/dist/device/provisioning.d.ts +5 -5
  93. package/dist/device/provisioning.d.ts.map +1 -1
  94. package/dist/device/provisioning.js +9 -9
  95. package/dist/device/provisioning.js.map +1 -1
  96. package/dist/device/transfer.d.ts.map +1 -1
  97. package/dist/device/transfer.js +14 -14
  98. package/dist/device/transfer.js.map +1 -1
  99. package/dist/files/index.d.ts +1 -1
  100. package/dist/files/index.js +1 -1
  101. package/dist/groups/index.d.ts +4 -4
  102. package/dist/groups/index.d.ts.map +1 -1
  103. package/dist/groups/index.js +3 -3
  104. package/dist/groups/index.js.map +1 -1
  105. package/dist/hooks/use-connection-presence.d.ts +5 -5
  106. package/dist/hooks/use-connection-presence.d.ts.map +1 -1
  107. package/dist/hooks/use-connection-presence.js +5 -5
  108. package/dist/hooks/use-connection-presence.js.map +1 -1
  109. package/dist/hooks/use-group-membership.d.ts +2 -2
  110. package/dist/hooks/use-key-rotation.js +2 -2
  111. package/dist/hooks/use-key-rotation.js.map +1 -1
  112. package/dist/index.d.ts +29 -22
  113. package/dist/index.d.ts.map +1 -1
  114. package/dist/index.js +20 -13
  115. package/dist/index.js.map +1 -1
  116. package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
  117. package/dist/internal/crypto/ec/x25519-validation.js +4 -4
  118. package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
  119. package/dist/internal/crypto/index.d.ts +1 -1
  120. package/dist/internal/crypto/index.d.ts.map +1 -1
  121. package/dist/internal/crypto/index.js +2 -2
  122. package/dist/internal/crypto/index.js.map +1 -1
  123. package/dist/internal/crypto/kdf/hkdf.d.ts +1 -1
  124. package/dist/internal/crypto/kdf/hkdf.d.ts.map +1 -1
  125. package/dist/internal/crypto/kdf/hkdf.js +2 -2
  126. package/dist/internal/crypto/kdf/hkdf.js.map +1 -1
  127. package/dist/internal/crypto/key-prefix.d.ts +1 -1
  128. package/dist/internal/crypto/key-prefix.js +1 -1
  129. package/dist/internal/crypto/pq/kyber.d.ts +1 -1
  130. package/dist/internal/crypto/pq/kyber.js +1 -1
  131. package/dist/internal/crypto/random.d.ts +9 -0
  132. package/dist/internal/crypto/random.d.ts.map +1 -1
  133. package/dist/internal/crypto/random.js +16 -0
  134. package/dist/internal/crypto/random.js.map +1 -1
  135. package/dist/internal/crypto/symmetric/aes-gcm-siv.d.ts +1 -1
  136. package/dist/internal/crypto/symmetric/aes-gcm-siv.js +1 -1
  137. package/dist/internal/crypto/symmetric/mac.d.ts +3 -3
  138. package/dist/internal/crypto/symmetric/mac.js +3 -3
  139. package/dist/internal/crypto/utils.d.ts +2 -2
  140. package/dist/internal/crypto/utils.js +2 -2
  141. package/dist/internal/encoding/proto/envelope.d.ts +21 -21
  142. package/dist/internal/encoding/proto/envelope.d.ts.map +1 -1
  143. package/dist/internal/encoding/proto/envelope.js +25 -25
  144. package/dist/internal/encoding/proto/envelope.js.map +1 -1
  145. package/dist/internal/encoding/proto/index.d.ts +2 -2
  146. package/dist/internal/encoding/proto/index.d.ts.map +1 -1
  147. package/dist/internal/encoding/proto/index.js +3 -3
  148. package/dist/internal/encoding/proto/index.js.map +1 -1
  149. package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts +5 -5
  150. package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts.map +1 -1
  151. package/dist/internal/encoding/proto/pq-ratchet-serialize.js +4 -4
  152. package/dist/internal/encoding/proto/pq-ratchet-serialize.js.map +1 -1
  153. package/dist/internal/encoding/proto/primitives.d.ts +261 -6
  154. package/dist/internal/encoding/proto/primitives.d.ts.map +1 -1
  155. package/dist/internal/encoding/proto/primitives.js +468 -6
  156. package/dist/internal/encoding/proto/primitives.js.map +1 -1
  157. package/dist/internal/encoding/proto/sender-key-message.d.ts +4 -3
  158. package/dist/internal/encoding/proto/sender-key-message.d.ts.map +1 -1
  159. package/dist/internal/encoding/proto/sender-key-message.js +97 -76
  160. package/dist/internal/encoding/proto/sender-key-message.js.map +1 -1
  161. package/dist/internal/encoding/proto/signal-message.d.ts +39 -34
  162. package/dist/internal/encoding/proto/signal-message.d.ts.map +1 -1
  163. package/dist/internal/encoding/proto/signal-message.js +236 -152
  164. package/dist/internal/encoding/proto/signal-message.js.map +1 -1
  165. package/dist/internal/groups/access-control.d.ts +170 -0
  166. package/dist/internal/groups/access-control.d.ts.map +1 -0
  167. package/dist/internal/groups/access-control.js +284 -0
  168. package/dist/internal/groups/access-control.js.map +1 -0
  169. package/dist/internal/groups/change-actions.d.ts +57 -0
  170. package/dist/internal/groups/change-actions.d.ts.map +1 -0
  171. package/dist/internal/groups/change-actions.js +827 -0
  172. package/dist/internal/groups/change-actions.js.map +1 -0
  173. package/dist/internal/groups/change-authorization.d.ts +16 -0
  174. package/dist/internal/groups/change-authorization.d.ts.map +1 -0
  175. package/dist/internal/groups/change-authorization.js +120 -0
  176. package/dist/internal/groups/change-authorization.js.map +1 -0
  177. package/dist/internal/{groups-v2 → groups}/encrypted-state.d.ts +12 -2
  178. package/dist/internal/groups/encrypted-state.d.ts.map +1 -0
  179. package/dist/internal/{groups-v2 → groups}/encrypted-state.js +122 -22
  180. package/dist/internal/groups/encrypted-state.js.map +1 -0
  181. package/dist/internal/groups/group-id.d.ts +9 -9
  182. package/dist/internal/groups/group-id.d.ts.map +1 -1
  183. package/dist/internal/groups/group-id.js +11 -12
  184. package/dist/internal/groups/group-id.js.map +1 -1
  185. package/dist/internal/groups/index.d.ts +16 -6
  186. package/dist/internal/groups/index.d.ts.map +1 -1
  187. package/dist/internal/groups/index.js +9 -1
  188. package/dist/internal/groups/index.js.map +1 -1
  189. package/dist/internal/groups/invite-link.d.ts.map +1 -0
  190. package/dist/internal/groups/invite-link.js.map +1 -0
  191. package/dist/internal/{groups-v2 → groups}/manager.d.ts +212 -43
  192. package/dist/internal/groups/manager.d.ts.map +1 -0
  193. package/dist/internal/groups/manager.js +1945 -0
  194. package/dist/internal/groups/manager.js.map +1 -0
  195. package/dist/internal/groups/sdk-store.d.ts +32 -0
  196. package/dist/internal/groups/sdk-store.d.ts.map +1 -0
  197. package/dist/internal/groups/sdk-store.js +111 -0
  198. package/dist/internal/groups/sdk-store.js.map +1 -0
  199. package/dist/internal/groups/server-engine.d.ts +98 -0
  200. package/dist/internal/groups/server-engine.d.ts.map +1 -0
  201. package/dist/internal/groups/server-engine.js +1235 -0
  202. package/dist/internal/groups/server-engine.js.map +1 -0
  203. package/dist/internal/groups/trust-root.d.ts +32 -0
  204. package/dist/internal/groups/trust-root.d.ts.map +1 -0
  205. package/dist/internal/groups/trust-root.js +91 -0
  206. package/dist/internal/groups/trust-root.js.map +1 -0
  207. package/dist/internal/{groups-v2 → groups}/types.d.ts +190 -41
  208. package/dist/internal/groups/types.d.ts.map +1 -0
  209. package/dist/internal/{groups-v2 → groups}/types.js +3 -2
  210. package/dist/internal/groups/types.js.map +1 -0
  211. package/dist/internal/groups/wire.d.ts +68 -0
  212. package/dist/internal/groups/wire.d.ts.map +1 -0
  213. package/dist/internal/groups/wire.js +708 -0
  214. package/dist/internal/groups/wire.js.map +1 -0
  215. package/dist/internal/manager/manager.d.ts +4 -4
  216. package/dist/internal/manager/manager.d.ts.map +1 -1
  217. package/dist/internal/manager/manager.js +28 -17
  218. package/dist/internal/manager/manager.js.map +1 -1
  219. package/dist/internal/protocol/double-ratchet/chains.d.ts +1 -1
  220. package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
  221. package/dist/internal/protocol/double-ratchet/chains.js +10 -10
  222. package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
  223. package/dist/internal/protocol/double-ratchet/ratchet.d.ts +3 -3
  224. package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
  225. package/dist/internal/protocol/double-ratchet/ratchet.js +3 -3
  226. package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
  227. package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
  228. package/dist/internal/protocol/pqxdh/pqxdh.js +3 -3
  229. package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
  230. package/dist/internal/protocol/sealed-sender/decryption-v2.d.ts.map +1 -1
  231. package/dist/internal/protocol/sealed-sender/decryption-v2.js +32 -18
  232. package/dist/internal/protocol/sealed-sender/decryption-v2.js.map +1 -1
  233. package/dist/internal/protocol/sealed-sender/decryption.d.ts.map +1 -1
  234. package/dist/internal/protocol/sealed-sender/decryption.js +35 -21
  235. package/dist/internal/protocol/sealed-sender/decryption.js.map +1 -1
  236. package/dist/internal/protocol/sealed-sender/encryption-v2.d.ts.map +1 -1
  237. package/dist/internal/protocol/sealed-sender/encryption-v2.js +8 -14
  238. package/dist/internal/protocol/sealed-sender/encryption-v2.js.map +1 -1
  239. package/dist/internal/protocol/sealed-sender/encryption.d.ts +9 -4
  240. package/dist/internal/protocol/sealed-sender/encryption.d.ts.map +1 -1
  241. package/dist/internal/protocol/sealed-sender/encryption.js +7 -15
  242. package/dist/internal/protocol/sealed-sender/encryption.js.map +1 -1
  243. package/dist/internal/protocol/sealed-sender/proto/index.d.ts +56 -11
  244. package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
  245. package/dist/internal/protocol/sealed-sender/proto/index.js +272 -157
  246. package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
  247. package/dist/internal/protocol/sealed-sender/trust-root.d.ts +45 -0
  248. package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +1 -0
  249. package/dist/internal/protocol/sealed-sender/trust-root.js +77 -0
  250. package/dist/internal/protocol/sealed-sender/trust-root.js.map +1 -0
  251. package/dist/internal/protocol/sealed-sender/types.d.ts +65 -10
  252. package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
  253. package/dist/internal/protocol/sealed-sender/types.js +44 -1
  254. package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
  255. package/dist/internal/protocol/sender-keys/index.d.ts +1 -1
  256. package/dist/internal/protocol/sender-keys/manager.d.ts +41 -4
  257. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  258. package/dist/internal/protocol/sender-keys/manager.js +113 -12
  259. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  260. package/dist/internal/protocol/spqr/index.d.ts +1 -1
  261. package/dist/internal/protocol/spqr/index.js +1 -1
  262. package/dist/internal/protocol/spqr/message.d.ts +1 -1
  263. package/dist/internal/protocol/spqr/message.js +1 -1
  264. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts +3 -3
  265. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts.map +1 -1
  266. package/dist/internal/protocol/spqr/ml-kem-braid/rs/index.js +2 -2
  267. package/dist/internal/protocol/spqr/ml-kem-braid/rs/index.js.map +1 -1
  268. package/dist/internal/protocol/spqr/ml-kem-braid/rs/lagrange.d.ts +1 -1
  269. package/dist/internal/protocol/spqr/ml-kem-braid/rs/lagrange.js +1 -1
  270. package/dist/internal/protocol/spqr/ml-kem-braid/rs/lagrange.js.map +1 -1
  271. package/dist/internal/protocol/spqr/ml-kem-braid/serialize.d.ts +8 -2
  272. package/dist/internal/protocol/spqr/ml-kem-braid/serialize.d.ts.map +1 -1
  273. package/dist/internal/protocol/spqr/ml-kem-braid/serialize.js +335 -152
  274. package/dist/internal/protocol/spqr/ml-kem-braid/serialize.js.map +1 -1
  275. package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js +5 -5
  276. package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js.map +1 -1
  277. package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts +1 -1
  278. package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts.map +1 -1
  279. package/dist/internal/protocol/spqr/spqr.d.ts +10 -10
  280. package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
  281. package/dist/internal/protocol/spqr/spqr.js +14 -14
  282. package/dist/internal/protocol/spqr/spqr.js.map +1 -1
  283. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +3 -3
  284. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +1 -1
  285. package/dist/internal/protocol/triple-ratchet/ratchet.js +5 -5
  286. package/dist/internal/protocol/triple-ratchet/ratchet.js.map +1 -1
  287. package/dist/internal/protocol/username/generate.d.ts +1 -1
  288. package/dist/internal/protocol/username/generate.js +1 -1
  289. package/dist/internal/protocol/username/hash.d.ts +1 -1
  290. package/dist/internal/protocol/username/hash.js +1 -1
  291. package/dist/internal/protocol/username/link.d.ts +1 -1
  292. package/dist/internal/protocol/username/link.js +1 -1
  293. package/dist/internal/protocol/username/proof.d.ts +1 -1
  294. package/dist/internal/protocol/username/proof.js +1 -1
  295. package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
  296. package/dist/internal/protocol/x3dh/x3dh.js +6 -6
  297. package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
  298. package/dist/internal/protocol/zk/groups/auth-credential.d.ts +14 -11
  299. package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
  300. package/dist/internal/protocol/zk/groups/auth-credential.js +68 -29
  301. package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
  302. package/dist/internal/protocol/zk/groups/client-zk-group-cipher.d.ts +2 -2
  303. package/dist/internal/protocol/zk/groups/client-zk-group-cipher.js +2 -2
  304. package/dist/internal/protocol/zk/groups/server-params.d.ts +1 -1
  305. package/dist/internal/protocol/zk/groups/server-params.d.ts.map +1 -1
  306. package/dist/internal/protocol/zk/groups/server-params.js.map +1 -1
  307. package/dist/internal/protocol/zk/groups/uid-struct.d.ts +2 -0
  308. package/dist/internal/protocol/zk/groups/uid-struct.d.ts.map +1 -1
  309. package/dist/internal/protocol/zk/groups/uid-struct.js +4 -0
  310. package/dist/internal/protocol/zk/groups/uid-struct.js.map +1 -1
  311. package/dist/internal/sesame/device-registry.d.ts +18 -13
  312. package/dist/internal/sesame/device-registry.d.ts.map +1 -1
  313. package/dist/internal/sesame/device-registry.js +13 -9
  314. package/dist/internal/sesame/device-registry.js.map +1 -1
  315. package/dist/internal/sesame/manager.d.ts +1 -1
  316. package/dist/internal/sesame/manager.d.ts.map +1 -1
  317. package/dist/internal/sesame/manager.js +66 -34
  318. package/dist/internal/sesame/manager.js.map +1 -1
  319. package/dist/internal/sesame/types.d.ts.map +1 -1
  320. package/dist/internal/sesame/types.js +7 -2
  321. package/dist/internal/sesame/types.js.map +1 -1
  322. package/dist/internal/session/builder.js +3 -3
  323. package/dist/internal/session/builder.js.map +1 -1
  324. package/dist/internal/session/cipher.d.ts +2 -2
  325. package/dist/internal/session/cipher.d.ts.map +1 -1
  326. package/dist/internal/session/cipher.js +38 -30
  327. package/dist/internal/session/cipher.js.map +1 -1
  328. package/dist/internal/session/decryption.d.ts +1 -1
  329. package/dist/internal/session/decryption.js +10 -10
  330. package/dist/internal/session/decryption.js.map +1 -1
  331. package/dist/internal/session/factory.d.ts.map +1 -1
  332. package/dist/internal/session/factory.js +3 -3
  333. package/dist/internal/session/factory.js.map +1 -1
  334. package/dist/internal/session/handshake.d.ts.map +1 -1
  335. package/dist/internal/session/handshake.js +3 -3
  336. package/dist/internal/session/handshake.js.map +1 -1
  337. package/dist/internal/session/keys.d.ts +1 -1
  338. package/dist/internal/session/ratchet.d.ts.map +1 -1
  339. package/dist/internal/session/ratchet.js +4 -4
  340. package/dist/internal/session/ratchet.js.map +1 -1
  341. package/dist/internal/session/types.d.ts +2 -2
  342. package/dist/internal/session/types.d.ts.map +1 -1
  343. package/dist/internal/session/validation.d.ts.map +1 -1
  344. package/dist/internal/session/validation.js +3 -3
  345. package/dist/internal/session/validation.js.map +1 -1
  346. package/dist/keys/generation.d.ts +4 -3
  347. package/dist/keys/generation.d.ts.map +1 -1
  348. package/dist/keys/generation.js +2 -2
  349. package/dist/keys/generation.js.map +1 -1
  350. package/dist/keys/identity.d.ts +32 -0
  351. package/dist/keys/identity.d.ts.map +1 -1
  352. package/dist/keys/identity.js +55 -0
  353. package/dist/keys/identity.js.map +1 -1
  354. package/dist/keys/index.d.ts +1 -1
  355. package/dist/keys/index.d.ts.map +1 -1
  356. package/dist/keys/index.js +1 -1
  357. package/dist/keys/index.js.map +1 -1
  358. package/dist/keys/types.d.ts +1 -1
  359. package/dist/keys/types.d.ts.map +1 -1
  360. package/dist/layers.d.ts +5 -5
  361. package/dist/layers.d.ts.map +1 -1
  362. package/dist/layers.js +9 -9
  363. package/dist/layers.js.map +1 -1
  364. package/dist/local/store/expo/adapter.d.ts +28 -25
  365. package/dist/local/store/expo/adapter.d.ts.map +1 -1
  366. package/dist/local/store/expo/adapter.js +125 -113
  367. package/dist/local/store/expo/adapter.js.map +1 -1
  368. package/dist/local/store/expo/database-key.d.ts +2 -2
  369. package/dist/local/store/expo/database-key.d.ts.map +1 -1
  370. package/dist/local/store/expo/database-key.js +5 -5
  371. package/dist/local/store/expo/database-key.js.map +1 -1
  372. package/dist/local/store/expo/db.d.ts +13 -10
  373. package/dist/local/store/expo/db.d.ts.map +1 -1
  374. package/dist/local/store/expo/db.js +8 -3
  375. package/dist/local/store/expo/db.js.map +1 -1
  376. package/dist/local/store/expo/index.d.ts +5 -7
  377. package/dist/local/store/expo/index.d.ts.map +1 -1
  378. package/dist/local/store/expo/index.js +3 -3
  379. package/dist/local/store/expo/index.js.map +1 -1
  380. package/dist/local/store/expo/key-storage.d.ts +1 -1
  381. package/dist/local/store/expo/key-storage.d.ts.map +1 -1
  382. package/dist/local/store/expo/key-storage.js +4 -4
  383. package/dist/local/store/expo/key-storage.js.map +1 -1
  384. package/dist/local/store/expo/models/index.d.ts +1 -1
  385. package/dist/local/store/expo/models/index.d.ts.map +1 -1
  386. package/dist/local/store/expo/models/index.js +2 -2
  387. package/dist/local/store/expo/models/index.js.map +1 -1
  388. package/dist/local/store/expo/models/local-identity.d.ts +1 -1
  389. package/dist/local/store/expo/models/local-identity.js +1 -1
  390. package/dist/local/store/expo/models/sender-key.d.ts +101 -77
  391. package/dist/local/store/expo/models/sender-key.d.ts.map +1 -1
  392. package/dist/local/store/expo/models/sender-key.js +154 -124
  393. package/dist/local/store/expo/models/sender-key.js.map +1 -1
  394. package/dist/local/store/expo/schema.d.ts +135 -33
  395. package/dist/local/store/expo/schema.d.ts.map +1 -1
  396. package/dist/local/store/expo/schema.js +37 -8
  397. package/dist/local/store/expo/schema.js.map +1 -1
  398. package/dist/local/store/expo/secure-store-options.d.ts +2 -2
  399. package/dist/local/store/expo/secure-store-options.d.ts.map +1 -1
  400. package/dist/local/store/expo/secure-store-options.js +1 -1
  401. package/dist/local/store/expo/secure-store-options.js.map +1 -1
  402. package/dist/local/store/index.d.ts +9 -9
  403. package/dist/local/store/index.d.ts.map +1 -1
  404. package/dist/local/store/index.js +9 -9
  405. package/dist/local/store/index.js.map +1 -1
  406. package/dist/local/store/{mock → memory}/adapter.d.ts +14 -7
  407. package/dist/local/store/memory/adapter.d.ts.map +1 -0
  408. package/dist/local/store/{mock → memory}/adapter.js +156 -58
  409. package/dist/local/store/memory/adapter.js.map +1 -0
  410. package/dist/local/store/memory/failures.d.ts +34 -0
  411. package/dist/local/store/memory/failures.d.ts.map +1 -0
  412. package/dist/local/store/memory/failures.js +75 -0
  413. package/dist/local/store/memory/failures.js.map +1 -0
  414. package/dist/local/store/memory/index.d.ts +11 -0
  415. package/dist/local/store/memory/index.d.ts.map +1 -0
  416. package/dist/local/store/memory/index.js +7 -0
  417. package/dist/local/store/memory/index.js.map +1 -0
  418. package/dist/local/store/node/adapter.d.ts +56 -7
  419. package/dist/local/store/node/adapter.d.ts.map +1 -1
  420. package/dist/local/store/node/adapter.js +458 -11
  421. package/dist/local/store/node/adapter.js.map +1 -1
  422. package/dist/local/store/node/database-key.js +1 -1
  423. package/dist/local/store/node/database.d.ts +68 -0
  424. package/dist/local/store/node/database.d.ts.map +1 -1
  425. package/dist/local/store/node/database.js +203 -20
  426. package/dist/local/store/node/database.js.map +1 -1
  427. package/dist/local/store/node/index.d.ts +4 -4
  428. package/dist/local/store/node/index.d.ts.map +1 -1
  429. package/dist/local/store/node/index.js +3 -3
  430. package/dist/local/store/node/index.js.map +1 -1
  431. package/dist/local/store/react-native/adapter.d.ts +44 -5
  432. package/dist/local/store/react-native/adapter.d.ts.map +1 -1
  433. package/dist/local/store/react-native/adapter.js +177 -22
  434. package/dist/local/store/react-native/adapter.js.map +1 -1
  435. package/dist/local/store/react-native/index.d.ts +4 -4
  436. package/dist/local/store/react-native/index.d.ts.map +1 -1
  437. package/dist/local/store/react-native/index.js +3 -3
  438. package/dist/local/store/react-native/index.js.map +1 -1
  439. package/dist/local/store/react-native/storage.d.ts +2 -2
  440. package/dist/local/store/web/adapter.d.ts +5 -4
  441. package/dist/local/store/web/adapter.d.ts.map +1 -1
  442. package/dist/local/store/web/adapter.js +54 -10
  443. package/dist/local/store/web/adapter.js.map +1 -1
  444. package/dist/local/store/web/index.d.ts +4 -4
  445. package/dist/local/store/web/index.d.ts.map +1 -1
  446. package/dist/local/store/web/index.js +3 -3
  447. package/dist/local/store/web/index.js.map +1 -1
  448. package/dist/local/vault/expo-secure-store.d.ts +2 -2
  449. package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
  450. package/dist/local/vault/expo-secure-store.js +5 -5
  451. package/dist/local/vault/expo-secure-store.js.map +1 -1
  452. package/dist/local/vault/index.d.ts +3 -3
  453. package/dist/local/vault/index.d.ts.map +1 -1
  454. package/dist/local/vault/index.js +1 -1
  455. package/dist/local/vault/index.js.map +1 -1
  456. package/dist/logger.d.ts +4 -4
  457. package/dist/logger.d.ts.map +1 -1
  458. package/dist/logger.js +5 -5
  459. package/dist/logger.js.map +1 -1
  460. package/dist/media/index.d.ts +7 -7
  461. package/dist/media/index.d.ts.map +1 -1
  462. package/dist/media/index.js +2 -2
  463. package/dist/profile/cipher.d.ts +1 -1
  464. package/dist/profile/cipher.js +1 -1
  465. package/dist/profile/contact-state.d.ts +1 -1
  466. package/dist/profile/contact-state.d.ts.map +1 -1
  467. package/dist/profile/contact-state.js +3 -3
  468. package/dist/profile/contact-state.js.map +1 -1
  469. package/dist/profile/crypto.d.ts +1 -1
  470. package/dist/profile/crypto.js +1 -1
  471. package/dist/profile/profile-key.d.ts.map +1 -1
  472. package/dist/profile/profile-key.js +3 -3
  473. package/dist/profile/profile-key.js.map +1 -1
  474. package/dist/profile/update-service.d.ts +2 -2
  475. package/dist/profile/update-service.d.ts.map +1 -1
  476. package/dist/profile/update-service.js +2 -2
  477. package/dist/profile/update-service.js.map +1 -1
  478. package/dist/remote/object-store/convex-r2/server.d.ts +1 -1
  479. package/dist/remote/object-store/convex-r2/storage.d.ts +2 -2
  480. package/dist/remote/object-store/convex-r2/storage.d.ts.map +1 -1
  481. package/dist/remote/object-store/index.d.ts +1 -1
  482. package/dist/remote/object-store/index.d.ts.map +1 -1
  483. package/dist/remote/object-store/s3/storage.d.ts +3 -3
  484. package/dist/remote/object-store/s3/storage.d.ts.map +1 -1
  485. package/dist/remote/object-store/s3/storage.js +1 -1
  486. package/dist/remote/object-store/types.d.ts +1 -1
  487. package/dist/remote/object-store/types.d.ts.map +1 -1
  488. package/dist/remote/relay/convex/backend.d.ts +405 -0
  489. package/dist/remote/relay/convex/backend.d.ts.map +1 -0
  490. package/dist/remote/relay/convex/backend.js +687 -0
  491. package/dist/remote/relay/convex/backend.js.map +1 -0
  492. package/dist/remote/relay/convex/component/_generated/api.d.ts +58 -0
  493. package/dist/remote/relay/convex/component/_generated/api.d.ts.map +1 -0
  494. package/dist/remote/relay/convex/component/_generated/api.js +31 -0
  495. package/dist/remote/relay/convex/component/_generated/api.js.map +1 -0
  496. package/dist/remote/relay/convex/component/_generated/component.d.ts +483 -0
  497. package/dist/remote/relay/convex/component/_generated/component.d.ts.map +1 -0
  498. package/dist/remote/relay/convex/component/_generated/component.js +11 -0
  499. package/dist/remote/relay/convex/component/_generated/component.js.map +1 -0
  500. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts +46 -0
  501. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts.map +1 -0
  502. package/dist/remote/relay/convex/component/_generated/dataModel.js +11 -0
  503. package/dist/remote/relay/convex/component/_generated/dataModel.js.map +1 -0
  504. package/dist/remote/relay/convex/component/_generated/server.d.ts +129 -0
  505. package/dist/remote/relay/convex/component/_generated/server.d.ts.map +1 -0
  506. package/dist/remote/relay/convex/component/_generated/server.js +79 -0
  507. package/dist/remote/relay/convex/component/_generated/server.js.map +1 -0
  508. package/dist/remote/relay/convex/component/accounts.d.ts +43 -0
  509. package/dist/remote/relay/convex/component/accounts.d.ts.map +1 -0
  510. package/dist/remote/relay/convex/component/accounts.js +181 -0
  511. package/dist/remote/relay/convex/component/accounts.js.map +1 -0
  512. package/dist/remote/relay/convex/component/certificates.d.ts +10 -0
  513. package/dist/remote/relay/convex/component/certificates.d.ts.map +1 -0
  514. package/dist/remote/relay/convex/component/certificates.js +117 -0
  515. package/dist/remote/relay/convex/component/certificates.js.map +1 -0
  516. package/dist/remote/relay/convex/component/cleanup.d.ts +32 -0
  517. package/dist/remote/relay/convex/component/cleanup.d.ts.map +1 -0
  518. package/dist/remote/relay/convex/component/cleanup.js +146 -0
  519. package/dist/remote/relay/convex/component/cleanup.js.map +1 -0
  520. package/dist/remote/relay/convex/component/convex.config.d.ts +5 -0
  521. package/dist/remote/relay/convex/component/convex.config.d.ts.map +1 -0
  522. package/dist/remote/relay/convex/component/convex.config.js +33 -0
  523. package/dist/remote/relay/convex/component/convex.config.js.map +1 -0
  524. package/dist/remote/relay/convex/component/crons.d.ts +3 -0
  525. package/dist/remote/relay/convex/component/crons.d.ts.map +1 -0
  526. package/dist/remote/relay/convex/component/crons.js +10 -0
  527. package/dist/remote/relay/convex/component/crons.js.map +1 -0
  528. package/dist/remote/relay/convex/component/devices.d.ts +101 -0
  529. package/dist/remote/relay/convex/component/devices.d.ts.map +1 -0
  530. package/dist/remote/relay/convex/component/devices.js +299 -0
  531. package/dist/remote/relay/convex/component/devices.js.map +1 -0
  532. package/dist/remote/relay/convex/component/errors.d.ts +22 -0
  533. package/dist/remote/relay/convex/component/errors.d.ts.map +1 -0
  534. package/dist/remote/relay/convex/component/errors.js +17 -0
  535. package/dist/remote/relay/convex/component/errors.js.map +1 -0
  536. package/dist/remote/relay/convex/component/groups.d.ts +63 -0
  537. package/dist/remote/relay/convex/component/groups.d.ts.map +1 -0
  538. package/dist/remote/relay/convex/component/groups.js +341 -0
  539. package/dist/remote/relay/convex/component/groups.js.map +1 -0
  540. package/dist/remote/relay/convex/component/keys.d.ts +130 -0
  541. package/dist/remote/relay/convex/component/keys.d.ts.map +1 -0
  542. package/dist/remote/relay/convex/component/keys.js +578 -0
  543. package/dist/remote/relay/convex/component/keys.js.map +1 -0
  544. package/dist/remote/relay/convex/component/messages.d.ts +119 -0
  545. package/dist/remote/relay/convex/component/messages.d.ts.map +1 -0
  546. package/dist/remote/relay/convex/component/messages.js +723 -0
  547. package/dist/remote/relay/convex/component/messages.js.map +1 -0
  548. package/dist/remote/relay/convex/component/provisioning.d.ts +92 -0
  549. package/dist/remote/relay/convex/component/provisioning.d.ts.map +1 -0
  550. package/dist/remote/relay/convex/component/provisioning.js +359 -0
  551. package/dist/remote/relay/convex/component/provisioning.js.map +1 -0
  552. package/dist/remote/relay/convex/component/runtime.d.ts +18 -0
  553. package/dist/remote/relay/convex/component/runtime.d.ts.map +1 -0
  554. package/dist/remote/relay/convex/component/runtime.js +142 -0
  555. package/dist/remote/relay/convex/component/runtime.js.map +1 -0
  556. package/dist/remote/relay/convex/component/schema.d.ts +358 -0
  557. package/dist/remote/relay/convex/component/schema.d.ts.map +1 -0
  558. package/dist/remote/relay/convex/component/schema.js +287 -0
  559. package/dist/remote/relay/convex/component/schema.js.map +1 -0
  560. package/dist/remote/relay/convex/component/zkAuth.d.ts +12 -0
  561. package/dist/remote/relay/convex/component/zkAuth.d.ts.map +1 -0
  562. package/dist/remote/relay/convex/component/zkAuth.js +71 -0
  563. package/dist/remote/relay/convex/component/zkAuth.js.map +1 -0
  564. package/dist/remote/relay/convex/constants.d.ts +3 -0
  565. package/dist/remote/relay/convex/constants.d.ts.map +1 -0
  566. package/dist/remote/relay/convex/constants.js +3 -0
  567. package/dist/remote/relay/convex/constants.js.map +1 -0
  568. package/dist/remote/relay/convex/group-server.d.ts +29 -24
  569. package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
  570. package/dist/remote/relay/convex/group-server.js +62 -28
  571. package/dist/remote/relay/convex/group-server.js.map +1 -1
  572. package/dist/remote/relay/convex/index.d.ts +14 -11
  573. package/dist/remote/relay/convex/index.d.ts.map +1 -1
  574. package/dist/remote/relay/convex/index.js +9 -7
  575. package/dist/remote/relay/convex/index.js.map +1 -1
  576. package/dist/remote/relay/convex/relay.d.ts +67 -80
  577. package/dist/remote/relay/convex/relay.d.ts.map +1 -1
  578. package/dist/remote/relay/convex/relay.js +143 -59
  579. package/dist/remote/relay/convex/relay.js.map +1 -1
  580. package/dist/remote/relay/convex/types.d.ts +16 -103
  581. package/dist/remote/relay/convex/types.d.ts.map +1 -1
  582. package/dist/remote/relay/convex/types.js +8 -13
  583. package/dist/remote/relay/convex/types.js.map +1 -1
  584. package/dist/remote/relay/index.d.ts +7 -7
  585. package/dist/remote/relay/index.d.ts.map +1 -1
  586. package/dist/remote/relay/index.js +7 -7
  587. package/dist/remote/relay/index.js.map +1 -1
  588. package/dist/remote/relay/{mock → memory}/adapter.d.ts +55 -31
  589. package/dist/remote/relay/memory/adapter.d.ts.map +1 -0
  590. package/dist/remote/relay/{mock → memory}/adapter.js +276 -135
  591. package/dist/remote/relay/memory/adapter.js.map +1 -0
  592. package/dist/remote/relay/memory/failures.d.ts +58 -0
  593. package/dist/remote/relay/memory/failures.d.ts.map +1 -0
  594. package/dist/remote/relay/memory/failures.js +123 -0
  595. package/dist/remote/relay/memory/failures.js.map +1 -0
  596. package/dist/remote/relay/memory/group-server.d.ts +9 -0
  597. package/dist/remote/relay/memory/group-server.d.ts.map +1 -0
  598. package/dist/remote/relay/memory/group-server.js +9 -0
  599. package/dist/remote/relay/memory/group-server.js.map +1 -0
  600. package/dist/remote/relay/memory/index.d.ts +11 -0
  601. package/dist/remote/relay/memory/index.d.ts.map +1 -0
  602. package/dist/remote/relay/memory/index.js +7 -0
  603. package/dist/remote/relay/memory/index.js.map +1 -0
  604. package/dist/remote/relay/types.d.ts +99 -86
  605. package/dist/remote/relay/types.d.ts.map +1 -1
  606. package/dist/remote/relay/types.js +2 -3
  607. package/dist/remote/relay/types.js.map +1 -1
  608. package/dist/safety/protobuf.d.ts +1 -1
  609. package/dist/safety/protobuf.d.ts.map +1 -1
  610. package/dist/types/api.d.ts +42 -17
  611. package/dist/types/api.d.ts.map +1 -1
  612. package/dist/types/errors.d.ts +2 -2
  613. package/dist/types/errors.d.ts.map +1 -1
  614. package/dist/types/errors.js +2 -2
  615. package/dist/types/errors.js.map +1 -1
  616. package/dist/types/messages.d.ts +1 -1
  617. package/dist/types/protocol-config.d.ts +71 -4
  618. package/dist/types/protocol-config.d.ts.map +1 -1
  619. package/dist/types/protocol-config.js +63 -2
  620. package/dist/types/protocol-config.js.map +1 -1
  621. package/dist/types/protocol-constants.d.ts +1 -1
  622. package/dist/types/protocol-constants.js +1 -1
  623. package/dist/utils/binary-transfer.d.ts +1 -1
  624. package/dist/utils/errors.d.ts +2 -2
  625. package/dist/utils/errors.js +2 -2
  626. package/dist/utils/retry.d.ts +4 -3
  627. package/dist/utils/retry.d.ts.map +1 -1
  628. package/dist/utils/retry.js +20 -1
  629. package/dist/utils/retry.js.map +1 -1
  630. package/dist/zk/groups.d.ts +1 -1
  631. package/dist/zk/groups.js +1 -1
  632. package/docs/ASSURANCE.md +12 -8
  633. package/docs/CLIENT_COMPOSITION.md +32 -76
  634. package/docs/DEVIATIONS.md +944 -0
  635. package/docs/E2EE.md +71 -6
  636. package/docs/ERROR_HANDLING.md +8 -1
  637. package/docs/GETTING_STARTED.md +22 -18
  638. package/docs/INTERFACES.md +22 -22
  639. package/docs/PACKAGE_SURFACE.md +22 -16
  640. package/docs/PROTOCOL_POLICY.md +11 -2
  641. package/docs/RECIPES.md +17 -13
  642. package/docs/SECURITY.md +8 -0
  643. package/files/README.md +1 -1
  644. package/groups/README.md +16 -5
  645. package/local/store/README.md +14 -12
  646. package/local/store/expo/README.md +15 -6
  647. package/local/store/memory/README.md +58 -0
  648. package/local/store/node/README.md +8 -1
  649. package/local/store/react-native/README.md +1 -1
  650. package/local/store/web/README.md +1 -1
  651. package/local/vault/README.md +3 -3
  652. package/package.json +29 -13
  653. package/remote/README.md +19 -19
  654. package/remote/object-store/README.md +3 -3
  655. package/remote/object-store/convex-r2/README.md +1 -1
  656. package/remote/object-store/s3/README.md +1 -1
  657. package/remote/relay/README.md +7 -7
  658. package/remote/relay/convex/README.md +10 -4
  659. package/remote/relay/convex/component/README.md +428 -0
  660. package/remote/relay/memory/README.md +69 -0
  661. package/scripts/oe-groups.mjs +162 -0
  662. package/types/README.md +1 -1
  663. package/dist/internal/groups-v2/access-control.d.ts +0 -101
  664. package/dist/internal/groups-v2/access-control.d.ts.map +0 -1
  665. package/dist/internal/groups-v2/access-control.js +0 -184
  666. package/dist/internal/groups-v2/access-control.js.map +0 -1
  667. package/dist/internal/groups-v2/change-actions.d.ts +0 -35
  668. package/dist/internal/groups-v2/change-actions.d.ts.map +0 -1
  669. package/dist/internal/groups-v2/change-actions.js +0 -358
  670. package/dist/internal/groups-v2/change-actions.js.map +0 -1
  671. package/dist/internal/groups-v2/encrypted-state.d.ts.map +0 -1
  672. package/dist/internal/groups-v2/encrypted-state.js.map +0 -1
  673. package/dist/internal/groups-v2/index.d.ts +0 -14
  674. package/dist/internal/groups-v2/index.d.ts.map +0 -1
  675. package/dist/internal/groups-v2/index.js +0 -11
  676. package/dist/internal/groups-v2/index.js.map +0 -1
  677. package/dist/internal/groups-v2/invite-link.d.ts.map +0 -1
  678. package/dist/internal/groups-v2/invite-link.js.map +0 -1
  679. package/dist/internal/groups-v2/manager.d.ts.map +0 -1
  680. package/dist/internal/groups-v2/manager.js +0 -1093
  681. package/dist/internal/groups-v2/manager.js.map +0 -1
  682. package/dist/internal/groups-v2/types.d.ts.map +0 -1
  683. package/dist/internal/groups-v2/types.js.map +0 -1
  684. package/dist/local/store/mock/adapter.d.ts.map +0 -1
  685. package/dist/local/store/mock/adapter.js.map +0 -1
  686. package/dist/local/store/mock/index.d.ts +0 -10
  687. package/dist/local/store/mock/index.d.ts.map +0 -1
  688. package/dist/local/store/mock/index.js +0 -6
  689. package/dist/local/store/mock/index.js.map +0 -1
  690. package/dist/remote/relay/mock/adapter.d.ts.map +0 -1
  691. package/dist/remote/relay/mock/adapter.js.map +0 -1
  692. package/dist/remote/relay/mock/index.d.ts +0 -10
  693. package/dist/remote/relay/mock/index.d.ts.map +0 -1
  694. package/dist/remote/relay/mock/index.js +0 -6
  695. package/dist/remote/relay/mock/index.js.map +0 -1
  696. package/docs/api/README.md +0 -471
  697. package/docs/api/classes/EncryptionError.md +0 -112
  698. package/docs/api/classes/EndorsementManager.md +0 -307
  699. package/docs/api/classes/SealedSenderAuthError.md +0 -127
  700. package/docs/api/classes/ServerDerivedKeyPair.md +0 -68
  701. package/docs/api/classes/ServerDerivedPublicKey.md +0 -33
  702. package/docs/api/classes/ServerRootKeyPair.md +0 -94
  703. package/docs/api/classes/ServerRootPublicKey.md +0 -72
  704. package/docs/api/classes/SignalBlockingManager.md +0 -106
  705. package/docs/api/classes/SignalProtocolClient.md +0 -2651
  706. package/docs/api/classes/VerificationFailure.md +0 -25
  707. package/docs/api/enumerations/ContentHint.md +0 -63
  708. package/docs/api/enumerations/EncryptionErrorCode.md +0 -488
  709. package/docs/api/enumerations/IdentityKeyChange.md +0 -65
  710. package/docs/api/enumerations/MessageType.md +0 -29
  711. package/docs/api/enumerations/TrustDirection.md +0 -33
  712. package/docs/api/enumerations/TypingAction.md +0 -31
  713. package/docs/api/functions/createDefaultSignalContentAdapter.md +0 -13
  714. package/docs/api/functions/createDefaultSignalLogger.md +0 -36
  715. package/docs/api/functions/createGroupId.md +0 -32
  716. package/docs/api/functions/createSignalProtocolClient.md +0 -36
  717. package/docs/api/functions/createSignalProtocolClientConfig.md +0 -24
  718. package/docs/api/functions/extractGroupId.md +0 -32
  719. package/docs/api/functions/formatVersion.md +0 -25
  720. package/docs/api/functions/isCompatible.md +0 -31
  721. package/docs/api/functions/isGroupId.md +0 -37
  722. package/docs/api/functions/isSealedSenderAuthError.md +0 -25
  723. package/docs/api/functions/parseVersion.md +0 -29
  724. package/docs/api/functions/resolveSPQRLimits.md +0 -21
  725. package/docs/api/functions/resolveSignalLogger.md +0 -42
  726. package/docs/api/interfaces/AccountIdentityProvisioning.md +0 -43
  727. package/docs/api/interfaces/AccountIdentityRotation.md +0 -69
  728. package/docs/api/interfaces/AttachmentTransferOptions.md +0 -49
  729. package/docs/api/interfaces/BlockedRecipientEntry.md +0 -25
  730. package/docs/api/interfaces/BlockedRecipientsSyncInput.md +0 -27
  731. package/docs/api/interfaces/ConfigurationSyncInput.md +0 -19
  732. package/docs/api/interfaces/CredentialPublicKey.md +0 -25
  733. package/docs/api/interfaces/DataMessageInput.md +0 -21
  734. package/docs/api/interfaces/DecryptedEnvelope.md +0 -95
  735. package/docs/api/interfaces/DecryptedGroup.md +0 -86
  736. package/docs/api/interfaces/DeviceInfo.md +0 -79
  737. package/docs/api/interfaces/DeviceRecord.md +0 -87
  738. package/docs/api/interfaces/DeviceRegistration.md +0 -27
  739. package/docs/api/interfaces/DoubleRatchetConfig.md +0 -36
  740. package/docs/api/interfaces/EcOneTimePreKey.md +0 -27
  741. package/docs/api/interfaces/EcSignedPreKey.md +0 -39
  742. package/docs/api/interfaces/EcSignedPreKeyUpload.md +0 -50
  743. package/docs/api/interfaces/EncryptionErrorContext.md +0 -51
  744. package/docs/api/interfaces/Envelope.md +0 -154
  745. package/docs/api/interfaces/ForceKeyResetResult.md +0 -37
  746. package/docs/api/interfaces/GroupAuthorization.md +0 -23
  747. package/docs/api/interfaces/GroupChangeEntry.md +0 -42
  748. package/docs/api/interfaces/GroupMemberDevice.md +0 -26
  749. package/docs/api/interfaces/IEcOneTimePreKeyStore.md +0 -86
  750. package/docs/api/interfaces/IEcSignedPreKeyStore.md +0 -132
  751. package/docs/api/interfaces/IGroupServer.md +0 -120
  752. package/docs/api/interfaces/IGroupStateStore.md +0 -128
  753. package/docs/api/interfaces/IIdentityKeyStore.md +0 -312
  754. package/docs/api/interfaces/IKemPreKeyStore.md +0 -144
  755. package/docs/api/interfaces/IKyberLastResortPreKeyStore.md +0 -111
  756. package/docs/api/interfaces/ILogger.md +0 -117
  757. package/docs/api/interfaces/IProtocolStore.md +0 -1033
  758. package/docs/api/interfaces/ISenderKeyStore.md +0 -417
  759. package/docs/api/interfaces/ISesameStore.md +0 -249
  760. package/docs/api/interfaces/ISessionStore.md +0 -178
  761. package/docs/api/interfaces/ISignalLocalSecretVault.md +0 -71
  762. package/docs/api/interfaces/ISignalLocalStore.md +0 -2053
  763. package/docs/api/interfaces/ISignalProtocolClient.md +0 -1183
  764. package/docs/api/interfaces/ISignalProtocolManager.md +0 -272
  765. package/docs/api/interfaces/ISignalRelayServer.md +0 -1329
  766. package/docs/api/interfaces/IdentityKeyPair.md +0 -49
  767. package/docs/api/interfaces/IncomingEnvelope.md +0 -91
  768. package/docs/api/interfaces/InspectedSignalContent.md +0 -43
  769. package/docs/api/interfaces/KDFChain.md +0 -31
  770. package/docs/api/interfaces/KemLastResortPreKeyUpload.md +0 -50
  771. package/docs/api/interfaces/KeyPair.md +0 -23
  772. package/docs/api/interfaces/KyberPreKey.md +0 -42
  773. package/docs/api/interfaces/MLKEMBraidAgentState.md +0 -191
  774. package/docs/api/interfaces/MLKEMBraidMessage.md +0 -49
  775. package/docs/api/interfaces/MediaAttachmentDeleteSyncInput.md +0 -31
  776. package/docs/api/interfaces/MessageHeader.md +0 -49
  777. package/docs/api/interfaces/MessageRecord.md +0 -86
  778. package/docs/api/interfaces/ParsedReceiptContent.md +0 -19
  779. package/docs/api/interfaces/ParsedTypingContent.md +0 -19
  780. package/docs/api/interfaces/PreKeyMaintenanceStore.md +0 -87
  781. package/docs/api/interfaces/PreKeyMessage.md +0 -159
  782. package/docs/api/interfaces/PreKeyStatusResult.md +0 -21
  783. package/docs/api/interfaces/PreKeyUpload.md +0 -42
  784. package/docs/api/interfaces/ProcessEnvelopeOptions.md +0 -72
  785. package/docs/api/interfaces/ProtocolAddress.md +0 -38
  786. package/docs/api/interfaces/ProtocolStrategyConfig.md +0 -91
  787. package/docs/api/interfaces/RatchetMessage.md +0 -96
  788. package/docs/api/interfaces/ReadSyncEntryInput.md +0 -19
  789. package/docs/api/interfaces/ReceiverChain.md +0 -43
  790. package/docs/api/interfaces/RecipientUsernameSyncInput.md +0 -31
  791. package/docs/api/interfaces/RelayPreKeyBundle.md +0 -254
  792. package/docs/api/interfaces/RemoteObjectDownload.md +0 -33
  793. package/docs/api/interfaces/RemoteObjectUpload.md +0 -49
  794. package/docs/api/interfaces/ResolvedSPQRInfoStrings.md +0 -27
  795. package/docs/api/interfaces/ResolvedSPQRLimits.md +0 -37
  796. package/docs/api/interfaces/RetryRequest.md +0 -80
  797. package/docs/api/interfaces/SCKAState.md +0 -65
  798. package/docs/api/interfaces/SPQRLimits.md +0 -40
  799. package/docs/api/interfaces/SPQRState.md +0 -191
  800. package/docs/api/interfaces/SafetyNumber.md +0 -60
  801. package/docs/api/interfaces/SafetyNumberConfirmation.md +0 -46
  802. package/docs/api/interfaces/SealedSenderConfig.md +0 -70
  803. package/docs/api/interfaces/SendOptions.md +0 -191
  804. package/docs/api/interfaces/SendResult.md +0 -93
  805. package/docs/api/interfaces/SenderKeyDistributionMessage.md +0 -43
  806. package/docs/api/interfaces/SenderKeyState.md +0 -76
  807. package/docs/api/interfaces/SenderKeysConfig.md +0 -65
  808. package/docs/api/interfaces/SentSyncTranscriptInput.md +0 -31
  809. package/docs/api/interfaces/ServiceId.md +0 -19
  810. package/docs/api/interfaces/SesameMessage.md +0 -84
  811. package/docs/api/interfaces/SesameStats.md +0 -57
  812. package/docs/api/interfaces/SessionHealthResult.md +0 -120
  813. package/docs/api/interfaces/SessionRecord.md +0 -80
  814. package/docs/api/interfaces/SessionRecordMetadata.md +0 -109
  815. package/docs/api/interfaces/SessionState.md +0 -368
  816. package/docs/api/interfaces/SessionTrustCommit.md +0 -58
  817. package/docs/api/interfaces/SignalBlockingHooks.md +0 -44
  818. package/docs/api/interfaces/SignalBlockingManagerOptions.md +0 -31
  819. package/docs/api/interfaces/SignalBlockingMirror.md +0 -30
  820. package/docs/api/interfaces/SignalBlockingStore.md +0 -83
  821. package/docs/api/interfaces/SignalContentAdapter.md +0 -325
  822. package/docs/api/interfaces/SignalProtocolClientAdapterConfig.md +0 -44
  823. package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +0 -693
  824. package/docs/api/interfaces/SignalProtocolClientConfig.md +0 -839
  825. package/docs/api/interfaces/SignalProtocolClientDeleteLocalAttachmentInput.md +0 -25
  826. package/docs/api/interfaces/SignalProtocolClientHooks.md +0 -506
  827. package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +0 -35
  828. package/docs/api/interfaces/SignalProtocolClientLoadLocalAttachmentInput.md +0 -187
  829. package/docs/api/interfaces/SignalProtocolClientLoadedLocalAttachment.md +0 -19
  830. package/docs/api/interfaces/SignalProtocolClientMedia.md +0 -83
  831. package/docs/api/interfaces/SignalProtocolClientMediaCompletedResult.md +0 -25
  832. package/docs/api/interfaces/SignalProtocolClientMediaConfig.md +0 -157
  833. package/docs/api/interfaces/SignalProtocolClientMediaDownloadCompletedResult.md +0 -37
  834. package/docs/api/interfaces/SignalProtocolClientMediaDownloadNotNeededResult.md +0 -25
  835. package/docs/api/interfaces/SignalProtocolClientMediaFailedResult.md +0 -19
  836. package/docs/api/interfaces/SignalProtocolClientMediaOperationOptions.md +0 -53
  837. package/docs/api/interfaces/SignalProtocolClientMediaPendingResult.md +0 -19
  838. package/docs/api/interfaces/SignalProtocolClientMediaProcessResult.md +0 -43
  839. package/docs/api/interfaces/SignalProtocolClientMediaSkippedResult.md +0 -25
  840. package/docs/api/interfaces/SignalProtocolClientMediaUploadCompletedResult.md +0 -31
  841. package/docs/api/interfaces/SignalProtocolClientProcessPendingMediaOptions.md +0 -87
  842. package/docs/api/interfaces/SignalProtocolClientSaveDownloadedAttachmentInput.md +0 -25
  843. package/docs/api/interfaces/SignalProtocolClientSaveUploadedAttachmentInput.md +0 -25
  844. package/docs/api/interfaces/SignalProtocolClientSyncDeleteInput.md +0 -19
  845. package/docs/api/interfaces/SignalProtocolConfig.md +0 -50
  846. package/docs/api/interfaces/SignalRemoteObjectStore.md +0 -88
  847. package/docs/api/interfaces/SkippedSenderMessageKey.md +0 -26
  848. package/docs/api/interfaces/TaskNotificationAckSyncInput.md +0 -31
  849. package/docs/api/interfaces/TripleRatchetState.md +0 -64
  850. package/docs/api/interfaces/UserRecord.md +0 -71
  851. package/docs/api/interfaces/UsernameStateSyncInput.md +0 -19
  852. package/docs/api/interfaces/VerificationStateSyncInput.md +0 -31
  853. package/docs/api/interfaces/VersionNegotiationState.md +0 -84
  854. package/docs/api/interfaces/ViewOnceOpenSyncInput.md +0 -19
  855. package/docs/api/namespaces/ProtocolAddress/README.md +0 -33
  856. package/docs/api/namespaces/ProtocolAddress/functions/create.md +0 -41
  857. package/docs/api/namespaces/ProtocolAddress/functions/equals.md +0 -39
  858. package/docs/api/namespaces/ProtocolAddress/functions/fromStorageKey.md +0 -36
  859. package/docs/api/namespaces/ProtocolAddress/functions/isUser.md +0 -39
  860. package/docs/api/namespaces/ProtocolAddress/functions/isValid.md +0 -34
  861. package/docs/api/namespaces/ProtocolAddress/functions/parse.md +0 -41
  862. package/docs/api/namespaces/ProtocolAddress/functions/toStorageKey.md +0 -38
  863. package/docs/api/namespaces/ProtocolAddress/functions/toString.md +0 -34
  864. package/docs/api/namespaces/SessionRecord/README.md +0 -30
  865. package/docs/api/namespaces/SessionRecord/functions/archiveCurrent.md +0 -40
  866. package/docs/api/namespaces/SessionRecord/functions/archiveCurrentState.md +0 -34
  867. package/docs/api/namespaces/SessionRecord/functions/create.md +0 -25
  868. package/docs/api/namespaces/SessionRecord/functions/deserialize.md +0 -29
  869. package/docs/api/namespaces/SessionRecord/functions/findSession.md +0 -34
  870. package/docs/api/namespaces/SessionRecord/functions/getAllSessions.md +0 -25
  871. package/docs/api/namespaces/SessionRecord/functions/getArchivedCount.md +0 -25
  872. package/docs/api/namespaces/SessionRecord/functions/hasCurrentSession.md +0 -25
  873. package/docs/api/namespaces/SessionRecord/functions/hasUsableSenderChain.md +0 -36
  874. package/docs/api/namespaces/SessionRecord/functions/promoteSession.md +0 -34
  875. package/docs/api/namespaces/SessionRecord/functions/serialize.md +0 -28
  876. package/docs/api/namespaces/SessionRecord/variables/MAX_ARCHIVED_SESSIONS.md +0 -14
  877. package/docs/api/namespaces/SessionState/README.md +0 -15
  878. package/docs/api/namespaces/SessionState/functions/getSessionId.md +0 -32
  879. package/docs/api/namespaces/blocking/README.md +0 -43
  880. package/docs/api/namespaces/encoding/README.md +0 -33
  881. package/docs/api/namespaces/encoding/functions/base64ToUrlSafe.md +0 -28
  882. package/docs/api/namespaces/encoding/functions/bytesToBase64.md +0 -21
  883. package/docs/api/namespaces/encoding/functions/bytesToString.md +0 -21
  884. package/docs/api/namespaces/encoding/functions/bytesToUrlSafeBase64.md +0 -33
  885. package/docs/api/namespaces/encoding/functions/concatBytes.md +0 -21
  886. package/docs/api/namespaces/encoding/functions/stringToBytes.md +0 -21
  887. package/docs/api/namespaces/encoding/functions/urlSafeToBase64.md +0 -27
  888. package/docs/api/namespaces/keys/README.md +0 -126
  889. package/docs/api/namespaces/keys/functions/acceptContactIdentityRotation.md +0 -33
  890. package/docs/api/namespaces/keys/functions/assertIdentityCommitment.md +0 -25
  891. package/docs/api/namespaces/keys/functions/compositeIdentitiesEqual.md +0 -23
  892. package/docs/api/namespaces/keys/functions/createCompositeIdentityV1.md +0 -19
  893. package/docs/api/namespaces/keys/functions/createPreKeySignatureContext.md +0 -31
  894. package/docs/api/namespaces/keys/functions/createUnverifiedContactIdentityRecord.md +0 -23
  895. package/docs/api/namespaces/keys/functions/decodeCompositeIdentityV1.md +0 -19
  896. package/docs/api/namespaces/keys/functions/deriveIdentityCommitment.md +0 -19
  897. package/docs/api/namespaces/keys/functions/encodeCompositeIdentityV1.md +0 -19
  898. package/docs/api/namespaces/keys/functions/evaluateContactIdentityCandidate.md +0 -27
  899. package/docs/api/namespaces/keys/functions/generateEcOneTimePreKeys.md +0 -37
  900. package/docs/api/namespaces/keys/functions/generateEcSignedPreKey.md +0 -39
  901. package/docs/api/namespaces/keys/functions/generateEcSignedPreKeyId.md +0 -21
  902. package/docs/api/namespaces/keys/functions/generateIdentityKeyPair.md +0 -24
  903. package/docs/api/namespaces/keys/functions/generateKemOneTimePreKeys.md +0 -47
  904. package/docs/api/namespaces/keys/functions/generateKyberLastResortPreKey.md +0 -37
  905. package/docs/api/namespaces/keys/functions/generateRegistrationId.md +0 -13
  906. package/docs/api/namespaces/keys/functions/signMlKem1024PreKey.md +0 -29
  907. package/docs/api/namespaces/keys/functions/signPreKey.md +0 -31
  908. package/docs/api/namespaces/keys/functions/validateContactIdentityRecord.md +0 -19
  909. package/docs/api/namespaces/keys/functions/verifyContactIdentityRecord.md +0 -31
  910. package/docs/api/namespaces/keys/functions/verifyMlKem1024PreKey.md +0 -33
  911. package/docs/api/namespaces/keys/functions/verifyPreKeySignature.md +0 -35
  912. package/docs/api/namespaces/keys/interfaces/CompositeIdentityV1.md +0 -33
  913. package/docs/api/namespaces/keys/interfaces/ContactIdentityRecord.md +0 -53
  914. package/docs/api/namespaces/keys/interfaces/KemOneTimePreKey.md +0 -43
  915. package/docs/api/namespaces/keys/type-aliases/IdentityCandidateStatus.md +0 -9
  916. package/docs/api/namespaces/keys/type-aliases/IdentityTrustState.md +0 -9
  917. package/docs/api/namespaces/keys/type-aliases/IdentityType.md +0 -9
  918. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_ED25519_TAG.md +0 -9
  919. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_LENGTH.md +0 -9
  920. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_VERSION.md +0 -9
  921. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_X25519_TAG.md +0 -9
  922. package/docs/api/namespaces/keys/variables/IDENTITY_COMMITMENT_V1_DOMAIN.md +0 -9
  923. package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_ML_KEM_1024.md +0 -9
  924. package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_X25519.md +0 -9
  925. package/docs/api/namespaces/keys/variables/PREKEY_SIGNATURE_V1_DOMAIN.md +0 -9
  926. package/docs/api/namespaces/media/README.md +0 -105
  927. package/docs/api/namespaces/media/classes/MediaAttachmentError.md +0 -57
  928. package/docs/api/namespaces/media/functions/createByteRangeMediaAttachmentTransfer.md +0 -19
  929. package/docs/api/namespaces/media/functions/createMediaAttachmentDeliveryId.md +0 -29
  930. package/docs/api/namespaces/media/functions/createMediaAttachmentId.md +0 -19
  931. package/docs/api/namespaces/media/functions/createMediaAttachmentMessage.md +0 -25
  932. package/docs/api/namespaces/media/functions/createMediaAttachmentPointer.md +0 -19
  933. package/docs/api/namespaces/media/functions/createTusMediaAttachmentTransfer.md +0 -19
  934. package/docs/api/namespaces/media/functions/deleteMediaAttachment.md +0 -23
  935. package/docs/api/namespaces/media/functions/executeMediaAttachmentJob.md +0 -23
  936. package/docs/api/namespaces/media/functions/isMediaAttachmentFlagSet.md +0 -19
  937. package/docs/api/namespaces/media/functions/parseMediaAttachmentMessage.md +0 -19
  938. package/docs/api/namespaces/media/functions/planMediaAttachmentCleanup.md +0 -23
  939. package/docs/api/namespaces/media/functions/planMediaAttachmentCleanupJobs.md +0 -19
  940. package/docs/api/namespaces/media/functions/planMediaAttachmentDeleteSync.md +0 -19
  941. package/docs/api/namespaces/media/functions/planMediaAttachmentDownloadJob.md +0 -19
  942. package/docs/api/namespaces/media/functions/planMediaAttachmentOpen.md +0 -19
  943. package/docs/api/namespaces/media/functions/planMediaAttachmentProcessing.md +0 -19
  944. package/docs/api/namespaces/media/functions/planMediaAttachmentUploadJob.md +0 -19
  945. package/docs/api/namespaces/media/functions/prepareMediaAttachmentUpload.md +0 -30
  946. package/docs/api/namespaces/media/functions/resolveMediaAttachment.md +0 -30
  947. package/docs/api/namespaces/media/functions/serializeMediaAttachmentMessage.md +0 -25
  948. package/docs/api/namespaces/media/functions/validateMediaAttachmentPolicy.md +0 -23
  949. package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentPartialStore.md +0 -68
  950. package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentTransferOptions.md +0 -91
  951. package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentOptions.md +0 -25
  952. package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentResult.md +0 -19
  953. package/docs/api/namespaces/media/interfaces/ExecuteMediaAttachmentJobOptions.md +0 -157
  954. package/docs/api/namespaces/media/interfaces/MediaAttachmentBackgroundJob.md +0 -85
  955. package/docs/api/namespaces/media/interfaces/MediaAttachmentCleanupPlan.md +0 -37
  956. package/docs/api/namespaces/media/interfaces/MediaAttachmentJobExecutionResult.md +0 -55
  957. package/docs/api/namespaces/media/interfaces/MediaAttachmentMessage.md +0 -31
  958. package/docs/api/namespaces/media/interfaces/MediaAttachmentOpenDecision.md +0 -31
  959. package/docs/api/namespaces/media/interfaces/MediaAttachmentPointer.md +0 -133
  960. package/docs/api/namespaces/media/interfaces/MediaAttachmentPolicy.md +0 -67
  961. package/docs/api/namespaces/media/interfaces/MediaAttachmentProcessingPlan.md +0 -73
  962. package/docs/api/namespaces/media/interfaces/MediaAttachmentProgress.md +0 -69
  963. package/docs/api/namespaces/media/interfaces/MediaAttachmentResumeState.md +0 -37
  964. package/docs/api/namespaces/media/interfaces/MediaAttachmentRetryOptions.md +0 -31
  965. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransfer.md +0 -51
  966. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferCheckpoint.md +0 -69
  967. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferOptions.md +0 -67
  968. package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadJobData.md +0 -19
  969. package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadResponse.md +0 -25
  970. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentCleanupJobsInput.md +0 -61
  971. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDeleteSyncInput.md +0 -25
  972. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDownloadJobInput.md +0 -161
  973. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentOpenInput.md +0 -25
  974. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentProcessingInput.md +0 -83
  975. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentUploadJobInput.md +0 -147
  976. package/docs/api/namespaces/media/interfaces/PrepareMediaAttachmentUploadOptions.md +0 -144
  977. package/docs/api/namespaces/media/interfaces/ResolveMediaAttachmentOptions.md +0 -55
  978. package/docs/api/namespaces/media/interfaces/ResolvedMediaAttachment.md +0 -109
  979. package/docs/api/namespaces/media/interfaces/TusMediaAttachmentTransferOptions.md +0 -85
  980. package/docs/api/namespaces/media/type-aliases/CreateMediaAttachmentPointerInput.md +0 -15
  981. package/docs/api/namespaces/media/type-aliases/MediaAttachmentCheckpointCallback.md +0 -19
  982. package/docs/api/namespaces/media/type-aliases/MediaAttachmentCleanupReason.md +0 -9
  983. package/docs/api/namespaces/media/type-aliases/MediaAttachmentErrorCode.md +0 -9
  984. package/docs/api/namespaces/media/type-aliases/MediaAttachmentFlag.md +0 -9
  985. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobExecutionStatus.md +0 -9
  986. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobOperation.md +0 -9
  987. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobPriority.md +0 -9
  988. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSkipReason.md +0 -9
  989. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSource.md +0 -9
  990. package/docs/api/namespaces/media/type-aliases/MediaAttachmentKnownIds.md +0 -9
  991. package/docs/api/namespaces/media/type-aliases/MediaAttachmentMessageType.md +0 -9
  992. package/docs/api/namespaces/media/type-aliases/MediaAttachmentProgressCallback.md +0 -19
  993. package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_DEFAULTS.md +0 -47
  994. package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_PRESETS.md +0 -95
  995. package/docs/api/namespaces/media/variables/MediaAttachmentCleanupReason.md +0 -27
  996. package/docs/api/namespaces/media/variables/MediaAttachmentErrorCode.md +0 -75
  997. package/docs/api/namespaces/media/variables/MediaAttachmentFlag.md +0 -23
  998. package/docs/api/namespaces/media/variables/MediaAttachmentJobExecutionStatus.md +0 -19
  999. package/docs/api/namespaces/media/variables/MediaAttachmentJobOperation.md +0 -31
  1000. package/docs/api/namespaces/media/variables/MediaAttachmentJobPriority.md +0 -23
  1001. package/docs/api/namespaces/media/variables/MediaAttachmentJobSource.md +0 -51
  1002. package/docs/api/namespaces/media/variables/MediaAttachmentMessageType.md +0 -15
  1003. package/docs/api/namespaces/media/variables/downloadMediaAttachment.md +0 -30
  1004. package/docs/api/namespaces/safety/README.md +0 -61
  1005. package/docs/api/namespaces/safety/classes/DisplayableFingerprint.md +0 -108
  1006. package/docs/api/namespaces/safety/classes/Fingerprint.md +0 -104
  1007. package/docs/api/namespaces/safety/classes/ScannableFingerprint.md +0 -209
  1008. package/docs/api/namespaces/safety/functions/base64ToBytes.md +0 -21
  1009. package/docs/api/namespaces/safety/functions/clearFingerprintCache.md +0 -15
  1010. package/docs/api/namespaces/safety/functions/compareSafetyNumbers.md +0 -25
  1011. package/docs/api/namespaces/safety/functions/createFingerprintData.md +0 -60
  1012. package/docs/api/namespaces/safety/functions/extractQrData.md +0 -34
  1013. package/docs/api/namespaces/safety/functions/generateCompositeSafetyNumber.md +0 -39
  1014. package/docs/api/namespaces/safety/functions/generateEmojiFingerprint.md +0 -24
  1015. package/docs/api/namespaces/safety/functions/generateSingleKeyReferenceSafetyNumber.md +0 -51
  1016. package/docs/api/namespaces/safety/functions/generateVerifySchemeUrl.md +0 -32
  1017. package/docs/api/namespaces/safety/functions/generateVerifyUrl.md +0 -49
  1018. package/docs/api/namespaces/safety/functions/isValidSafetyNumber.md +0 -21
  1019. package/docs/api/namespaces/safety/functions/isVerifyUrl.md +0 -45
  1020. package/docs/api/namespaces/safety/functions/parseVerifyUrl.md +0 -31
  1021. package/docs/api/namespaces/safety/interfaces/FingerprintData.md +0 -52
  1022. package/docs/api/namespaces/safety/interfaces/SafetyNumber.md +0 -49
  1023. package/docs/api/namespaces/safety/interfaces/VerifyLinkConfig.md +0 -28
  1024. package/docs/api/namespaces/safety/interfaces/VerifyUrlParams.md +0 -49
  1025. package/docs/api/namespaces/safety/type-aliases/CompareResult.md +0 -21
  1026. package/docs/api/namespaces/safety/variables/DEFAULT_VERIFY_LINK_CONFIG.md +0 -12
  1027. package/docs/api/namespaces/safety/variables/FINGERPRINT_ITERATIONS.md +0 -12
  1028. package/docs/api/namespaces/safety/variables/FINGERPRINT_VERSION.md +0 -12
  1029. package/docs/api/namespaces/safety/variables/VERIFY_BASE_URL.md +0 -11
  1030. package/docs/api/namespaces/safety/variables/VERIFY_SCHEME_URL.md +0 -11
  1031. package/docs/api/type-aliases/Base64.md +0 -20
  1032. package/docs/api/type-aliases/BraidPolicy.md +0 -11
  1033. package/docs/api/type-aliases/Bytes.md +0 -20
  1034. package/docs/api/type-aliases/Ciphertext.md +0 -21
  1035. package/docs/api/type-aliases/DeviceType.md +0 -11
  1036. package/docs/api/type-aliases/DownloadedAttachment.md +0 -11
  1037. package/docs/api/type-aliases/GroupId.md +0 -27
  1038. package/docs/api/type-aliases/Hex.md +0 -20
  1039. package/docs/api/type-aliases/HookName.md +0 -11
  1040. package/docs/api/type-aliases/PostQuantumPolicy.md +0 -11
  1041. package/docs/api/type-aliases/PreparedAttachmentUpload.md +0 -14
  1042. package/docs/api/type-aliases/PrivateKey.md +0 -22
  1043. package/docs/api/type-aliases/ProgressCallback.md +0 -45
  1044. package/docs/api/type-aliases/PublicKey.md +0 -22
  1045. package/docs/api/type-aliases/RemoteObjectCompleteUploadRequest.md +0 -19
  1046. package/docs/api/type-aliases/RemoteObjectDeleteRequest.md +0 -19
  1047. package/docs/api/type-aliases/RemoteObjectDownloadRequest.md +0 -19
  1048. package/docs/api/type-aliases/RemoteObjectUploadRequest.md +0 -42
  1049. package/docs/api/type-aliases/SCKAMode.md +0 -11
  1050. package/docs/api/type-aliases/SealedSenderAuth.md +0 -15
  1051. package/docs/api/type-aliases/SignalProtocolClientMediaCleanupInput.md +0 -9
  1052. package/docs/api/type-aliases/SignalProtocolClientMediaCleanupResult.md +0 -9
  1053. package/docs/api/type-aliases/SignalProtocolClientMediaDownloadInput.md +0 -9
  1054. package/docs/api/type-aliases/SignalProtocolClientMediaDownloadResult.md +0 -9
  1055. package/docs/api/type-aliases/SignalProtocolClientMediaOperationResult.md +0 -9
  1056. package/docs/api/type-aliases/SignalProtocolClientMediaUploadInput.md +0 -9
  1057. package/docs/api/type-aliases/SignalProtocolClientMediaUploadResult.md +0 -9
  1058. package/docs/api/type-aliases/Signature.md +0 -21
  1059. package/docs/api/type-aliases/Unsubscribe.md +0 -15
  1060. package/docs/api/variables/BraidPolicy.md +0 -21
  1061. package/docs/api/variables/DEFAULT_DEVICE_ID.md +0 -12
  1062. package/docs/api/variables/DOUBLE_RATCHET_SPEC.md +0 -11
  1063. package/docs/api/variables/GROUP_V2_PREFIX.md +0 -11
  1064. package/docs/api/variables/KEY_REFRESH_INTERVAL_MS_DEFAULT.md +0 -11
  1065. package/docs/api/variables/MAX_MESSAGE_KEYS.md +0 -14
  1066. package/docs/api/variables/MAX_PREKEY_AGE_MS_DEFAULT.md +0 -11
  1067. package/docs/api/variables/MAX_RECEIVER_CHAINS.md +0 -14
  1068. package/docs/api/variables/MAX_REGISTRATION_ID.md +0 -16
  1069. package/docs/api/variables/MAX_SKIP.md +0 -11
  1070. package/docs/api/variables/MESSAGE_FORMAT.md +0 -11
  1071. package/docs/api/variables/MIN_REGISTRATION_ID.md +0 -16
  1072. package/docs/api/variables/ML_KEM_BRAID_SPEC.md +0 -11
  1073. package/docs/api/variables/ONE_TIME_PREKEY_BATCH_SIZE.md +0 -21
  1074. package/docs/api/variables/PQXDH_SPEC.md +0 -11
  1075. package/docs/api/variables/PostQuantumPolicy.md +0 -21
  1076. package/docs/api/variables/SENDER_KEY_FORMAT.md +0 -11
  1077. package/docs/api/variables/SENDER_KEY_SPEC.md +0 -11
  1078. package/docs/api/variables/SESAME_SPEC.md +0 -11
  1079. package/docs/api/variables/SESSION_FORMAT.md +0 -11
  1080. package/docs/api/variables/SPQR_LIMITS_DEFAULTS.md +0 -11
  1081. package/docs/api/variables/X3DH_SPEC.md +0 -9
  1082. package/docs/api/variables/defaultSignalLogger.md +0 -32
  1083. package/local/store/mock/README.md +0 -27
  1084. package/remote/relay/mock/README.md +0 -32
  1085. /package/dist/internal/{groups-v2 → groups}/invite-link.d.ts +0 -0
  1086. /package/dist/internal/{groups-v2 → groups}/invite-link.js +0 -0
@@ -1,2053 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / ISignalLocalStore
6
-
7
- # Interface: ISignalLocalStore
8
-
9
- Signal local store interface.
10
-
11
- Canonical device/browser-local persistence for Signal protocol state:
12
- - identity keys and registrations
13
- - sessions and sender keys
14
- - SESAME multi-device state
15
- - message records and local metadata
16
-
17
- This is the interface that local store adapters should implement.
18
-
19
- ## Extends
20
-
21
- - [`IProtocolStore`](IProtocolStore.md).[`ISesameStore`](ISesameStore.md).[`ISenderKeyStore`](ISenderKeyStore.md).`IMessageRecordStore`
22
-
23
- ## Methods
24
-
25
- ### acceptContactIdentityRotation()
26
-
27
- > **acceptContactIdentityRotation**(`address`, `identity`, `identityType?`, `suppliedCommitment?`): `Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md)\>
28
-
29
- Explicitly accept a changed tuple and atomically delete every session for
30
- that user; the previous tuple becomes rollback history.
31
-
32
- #### Parameters
33
-
34
- ##### address
35
-
36
- [`ProtocolAddress`](ProtocolAddress.md)
37
-
38
- ##### identity
39
-
40
- [`CompositeIdentityV1`](../namespaces/keys/interfaces/CompositeIdentityV1.md)
41
-
42
- ##### identityType?
43
-
44
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
45
-
46
- ##### suppliedCommitment?
47
-
48
- `Uint8Array`\<`ArrayBufferLike`\>
49
-
50
- #### Returns
51
-
52
- `Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md)\>
53
-
54
- #### Inherited from
55
-
56
- [`IProtocolStore`](IProtocolStore.md).[`acceptContactIdentityRotation`](IProtocolStore.md#acceptcontactidentityrotation)
57
-
58
- ***
59
-
60
- ### acceptContactIdentityRotationAndDeleteSessions()
61
-
62
- > **acceptContactIdentityRotationAndDeleteSessions**(`address`, `identity`, `identityType?`, `suppliedCommitment?`): `Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md)\>
63
-
64
- Atomically rotate one per-user identity tuple and delete every bound device session.
65
-
66
- #### Parameters
67
-
68
- ##### address
69
-
70
- [`ProtocolAddress`](ProtocolAddress.md)
71
-
72
- ##### identity
73
-
74
- [`CompositeIdentityV1`](../namespaces/keys/interfaces/CompositeIdentityV1.md)
75
-
76
- ##### identityType?
77
-
78
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
79
-
80
- ##### suppliedCommitment?
81
-
82
- `Uint8Array`\<`ArrayBufferLike`\>
83
-
84
- #### Returns
85
-
86
- `Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md)\>
87
-
88
- #### Inherited from
89
-
90
- [`IProtocolStore`](IProtocolStore.md).[`acceptContactIdentityRotationAndDeleteSessions`](IProtocolStore.md#acceptcontactidentityrotationanddeletesessions)
91
-
92
- ***
93
-
94
- ### archiveCurrentSession()
95
-
96
- > **archiveCurrentSession**(`address`, `newSession?`): `Promise`\<`void`\>
97
-
98
- Archive the current session and optionally start a new one.
99
-
100
- Used when:
101
- - Identity key changes (possible MITM)
102
- - Registration ID changes (app reinstall detected)
103
- - Manual session reset
104
-
105
- #### Parameters
106
-
107
- ##### address
108
-
109
- [`ProtocolAddress`](ProtocolAddress.md)
110
-
111
- Protocol address
112
-
113
- ##### newSession?
114
-
115
- [`SessionState`](SessionState.md) \| `null`
116
-
117
- Optional new session to set as current
118
-
119
- #### Returns
120
-
121
- `Promise`\<`void`\>
122
-
123
- #### Inherited from
124
-
125
- [`IProtocolStore`](IProtocolStore.md).[`archiveCurrentSession`](IProtocolStore.md#archivecurrentsession)
126
-
127
- ***
128
-
129
- ### cleanupExpiredSessions()
130
-
131
- > **cleanupExpiredSessions**(`maxRecv`): `Promise`\<`number`\>
132
-
133
- Delete expired sessions (sessions older than MAXRECV threshold).
134
-
135
- #### Parameters
136
-
137
- ##### maxRecv
138
-
139
- `number`
140
-
141
- #### Returns
142
-
143
- `Promise`\<`number`\>
144
-
145
- #### Inherited from
146
-
147
- [`ISesameStore`](ISesameStore.md).[`cleanupExpiredSessions`](ISesameStore.md#cleanupexpiredsessions)
148
-
149
- ***
150
-
151
- ### clearAllKeys()
152
-
153
- > **clearAllKeys**(): `Promise`\<`void`\>
154
-
155
- Clear all encryption keys (use with caution!).
156
-
157
- This should only be used for:
158
- - Account deletion
159
- - Reset after security incident
160
- - Local development
161
-
162
- #### Returns
163
-
164
- `Promise`\<`void`\>
165
-
166
- ***
167
-
168
- ### clearAllMessageRecords()
169
-
170
- > **clearAllMessageRecords**(): `Promise`\<`number`\>
171
-
172
- Clear all message records (for device re-registration)
173
-
174
- #### Returns
175
-
176
- `Promise`\<`number`\>
177
-
178
- #### Inherited from
179
-
180
- `IMessageRecordStore.clearAllMessageRecords`
181
-
182
- ***
183
-
184
- ### clearAllSessions()
185
-
186
- > **clearAllSessions**(): `Promise`\<`void`\>
187
-
188
- Clear all sessions from storage.
189
- Used during force key reset.
190
-
191
- #### Returns
192
-
193
- `Promise`\<`void`\>
194
-
195
- ***
196
-
197
- ### commitSessionTrust()
198
-
199
- > **commitSessionTrust**(`commit`): `Promise`\<`void`\>
200
-
201
- Atomically pin/match trust, store the session, and consume referenced one-time prekeys.
202
-
203
- #### Parameters
204
-
205
- ##### commit
206
-
207
- [`SessionTrustCommit`](SessionTrustCommit.md)
208
-
209
- #### Returns
210
-
211
- `Promise`\<`void`\>
212
-
213
- #### Inherited from
214
-
215
- [`IProtocolStore`](IProtocolStore.md).[`commitSessionTrust`](IProtocolStore.md#commitsessiontrust)
216
-
217
- ***
218
-
219
- ### countSkippedSenderKeys()
220
-
221
- > **countSkippedSenderKeys**(`groupId`, `senderId`, `senderDeviceId`): `Promise`\<`number`\>
222
-
223
- Count skipped keys for a sender (for enforcing maxSkippedKeys limit).
224
-
225
- #### Parameters
226
-
227
- ##### groupId
228
-
229
- `string`
230
-
231
- Group identifier
232
-
233
- ##### senderId
234
-
235
- `string`
236
-
237
- Sender user identifier
238
-
239
- ##### senderDeviceId
240
-
241
- `number`
242
-
243
- Sender device identifier
244
-
245
- #### Returns
246
-
247
- `Promise`\<`number`\>
248
-
249
- Number of stored skipped keys for this sender
250
-
251
- #### Inherited from
252
-
253
- [`ISenderKeyStore`](ISenderKeyStore.md).[`countSkippedSenderKeys`](ISenderKeyStore.md#countskippedsenderkeys)
254
-
255
- ***
256
-
257
- ### deleteAllPreKeys()
258
-
259
- > **deleteAllPreKeys**(`identityType?`): `Promise`\<\{ `ecOneTimePreKeys`: `number`; `ecSignedPreKeys`: `number`; `kemOneTimePreKeys`: `number`; `kyberPreKeys`: `number`; \}\>
260
-
261
- Delete all prekeys from storage (preserves identity keys and sessions).
262
- Used for recovery from identifier collision per PQXDH §4.13.
263
-
264
- #### Parameters
265
-
266
- ##### identityType?
267
-
268
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
269
-
270
- 'aci' or 'pni' (defaults to 'aci')
271
-
272
- #### Returns
273
-
274
- `Promise`\<\{ `ecOneTimePreKeys`: `number`; `ecSignedPreKeys`: `number`; `kemOneTimePreKeys`: `number`; `kyberPreKeys`: `number`; \}\>
275
-
276
- Counts of deleted prekeys by type
277
-
278
- ***
279
-
280
- ### deleteAllSenderKeysForGroup()
281
-
282
- > **deleteAllSenderKeysForGroup**(`groupId`): `Promise`\<`number`\>
283
-
284
- Delete all sender keys for a group (when group is deleted).
285
-
286
- #### Parameters
287
-
288
- ##### groupId
289
-
290
- `string`
291
-
292
- #### Returns
293
-
294
- `Promise`\<`number`\>
295
-
296
- #### Inherited from
297
-
298
- [`ISenderKeyStore`](ISenderKeyStore.md).[`deleteAllSenderKeysForGroup`](ISenderKeyStore.md#deleteallsenderkeysforgroup)
299
-
300
- ***
301
-
302
- ### deleteDeviceRecord()
303
-
304
- > **deleteDeviceRecord**(`userId`, `deviceId`): `Promise`\<`void`\>
305
-
306
- Delete device record.
307
-
308
- #### Parameters
309
-
310
- ##### userId
311
-
312
- `string`
313
-
314
- ##### deviceId
315
-
316
- `number`
317
-
318
- #### Returns
319
-
320
- `Promise`\<`void`\>
321
-
322
- #### Inherited from
323
-
324
- [`ISesameStore`](ISesameStore.md).[`deleteDeviceRecord`](ISesameStore.md#deletedevicerecord)
325
-
326
- ***
327
-
328
- ### deleteExpiredMessageRecords()
329
-
330
- > **deleteExpiredMessageRecords**(`maxAgeMs`): `Promise`\<`number`\>
331
-
332
- Delete all expired message records older than maxAgeMs
333
-
334
- #### Parameters
335
-
336
- ##### maxAgeMs
337
-
338
- `number`
339
-
340
- #### Returns
341
-
342
- `Promise`\<`number`\>
343
-
344
- #### Inherited from
345
-
346
- `IMessageRecordStore.deleteExpiredMessageRecords`
347
-
348
- ***
349
-
350
- ### deleteMessageRecord()
351
-
352
- > **deleteMessageRecord**(`sessionId`, `timestamp`): `Promise`\<`void`\>
353
-
354
- Delete a message record by session and timestamp.
355
-
356
- Called when processing delivery receipts to clean up confirmed messages.
357
-
358
- #### Parameters
359
-
360
- ##### sessionId
361
-
362
- `string`
363
-
364
- ##### timestamp
365
-
366
- `number`
367
-
368
- #### Returns
369
-
370
- `Promise`\<`void`\>
371
-
372
- #### Inherited from
373
-
374
- `IMessageRecordStore.deleteMessageRecord`
375
-
376
- ***
377
-
378
- ### deleteMessageRecordsForSession()
379
-
380
- > **deleteMessageRecordsForSession**(`sessionId`): `Promise`\<`number`\>
381
-
382
- Delete all message records for a session
383
-
384
- #### Parameters
385
-
386
- ##### sessionId
387
-
388
- `string`
389
-
390
- #### Returns
391
-
392
- `Promise`\<`number`\>
393
-
394
- #### Inherited from
395
-
396
- `IMessageRecordStore.deleteMessageRecordsForSession`
397
-
398
- ***
399
-
400
- ### deleteOldestSkippedSenderKeys()
401
-
402
- > **deleteOldestSkippedSenderKeys**(`groupId`, `senderId`, `senderDeviceId`, `count`): `Promise`\<`number`\>
403
-
404
- Delete oldest skipped keys to make room for new ones.
405
-
406
- Called when maxSkippedKeys limit is reached.
407
-
408
- #### Parameters
409
-
410
- ##### groupId
411
-
412
- `string`
413
-
414
- Group identifier
415
-
416
- ##### senderId
417
-
418
- `string`
419
-
420
- Sender user identifier
421
-
422
- ##### senderDeviceId
423
-
424
- `number`
425
-
426
- Sender device identifier
427
-
428
- ##### count
429
-
430
- `number`
431
-
432
- Number of oldest keys to delete
433
-
434
- #### Returns
435
-
436
- `Promise`\<`number`\>
437
-
438
- Number of deleted keys
439
-
440
- #### Inherited from
441
-
442
- [`ISenderKeyStore`](ISenderKeyStore.md).[`deleteOldestSkippedSenderKeys`](ISenderKeyStore.md#deleteoldestskippedsenderkeys)
443
-
444
- ***
445
-
446
- ### deleteSenderKey()
447
-
448
- > **deleteSenderKey**(`groupId`, `userId`, `deviceId`): `Promise`\<`void`\>
449
-
450
- Delete sender key for a group member device.
451
-
452
- #### Parameters
453
-
454
- ##### groupId
455
-
456
- `string`
457
-
458
- ##### userId
459
-
460
- `string`
461
-
462
- ##### deviceId
463
-
464
- `number`
465
-
466
- #### Returns
467
-
468
- `Promise`\<`void`\>
469
-
470
- #### Inherited from
471
-
472
- [`ISenderKeyStore`](ISenderKeyStore.md).[`deleteSenderKey`](ISenderKeyStore.md#deletesenderkey)
473
-
474
- ***
475
-
476
- ### deleteSessionRecord()
477
-
478
- > **deleteSessionRecord**(`address`): `Promise`\<`void`\>
479
-
480
- Delete session record.
481
-
482
- #### Parameters
483
-
484
- ##### address
485
-
486
- [`ProtocolAddress`](ProtocolAddress.md)
487
-
488
- Protocol address
489
-
490
- #### Returns
491
-
492
- `Promise`\<`void`\>
493
-
494
- #### Inherited from
495
-
496
- [`IProtocolStore`](IProtocolStore.md).[`deleteSessionRecord`](IProtocolStore.md#deletesessionrecord)
497
-
498
- ***
499
-
500
- ### deleteSkippedSenderKey()
501
-
502
- > **deleteSkippedSenderKey**(`groupId`, `senderId`, `senderDeviceId`, `chainIndex`): `Promise`\<`void`\>
503
-
504
- Delete skipped message key after use.
505
-
506
- Called after successfully decrypting an out-of-order message.
507
-
508
- #### Parameters
509
-
510
- ##### groupId
511
-
512
- `string`
513
-
514
- Group identifier
515
-
516
- ##### senderId
517
-
518
- `string`
519
-
520
- Sender user identifier
521
-
522
- ##### senderDeviceId
523
-
524
- `number`
525
-
526
- Sender device identifier
527
-
528
- ##### chainIndex
529
-
530
- `number`
531
-
532
- The message index to delete
533
-
534
- #### Returns
535
-
536
- `Promise`\<`void`\>
537
-
538
- #### Inherited from
539
-
540
- [`ISenderKeyStore`](ISenderKeyStore.md).[`deleteSkippedSenderKey`](ISenderKeyStore.md#deleteskippedsenderkey)
541
-
542
- ***
543
-
544
- ### deleteStaleRecords()
545
-
546
- > **deleteStaleRecords**(`maxLatency`): `Promise`\<`number`\>
547
-
548
- Delete stale device records (orphaned sessions older than MAXLATENCY).
549
-
550
- #### Parameters
551
-
552
- ##### maxLatency
553
-
554
- `number`
555
-
556
- #### Returns
557
-
558
- `Promise`\<`number`\>
559
-
560
- #### Inherited from
561
-
562
- [`ISesameStore`](ISesameStore.md).[`deleteStaleRecords`](ISesameStore.md#deletestalerecords)
563
-
564
- ***
565
-
566
- ### getAllEcSignedPreKeys()?
567
-
568
- > `optional` **getAllEcSignedPreKeys**(`identityType?`): `Promise`\<[`EcSignedPreKey`](EcSignedPreKey.md)[]\>
569
-
570
- Get all stored EC signed prekeys (current + archived).
571
-
572
- Used for cleanup and debugging.
573
-
574
- #### Parameters
575
-
576
- ##### identityType?
577
-
578
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
579
-
580
- 'aci' or 'pni' (defaults to 'aci')
581
-
582
- #### Returns
583
-
584
- `Promise`\<[`EcSignedPreKey`](EcSignedPreKey.md)[]\>
585
-
586
- #### Inherited from
587
-
588
- [`IProtocolStore`](IProtocolStore.md).[`getAllEcSignedPreKeys`](IProtocolStore.md#getallecsignedprekeys)
589
-
590
- ***
591
-
592
- ### getAllSenderKeysForGroup()
593
-
594
- > **getAllSenderKeysForGroup**(`groupId`): `Promise`\<[`SenderKeyState`](SenderKeyState.md)[]\>
595
-
596
- Get all sender keys for a group (for admin operations).
597
-
598
- #### Parameters
599
-
600
- ##### groupId
601
-
602
- `string`
603
-
604
- #### Returns
605
-
606
- `Promise`\<[`SenderKeyState`](SenderKeyState.md)[]\>
607
-
608
- #### Inherited from
609
-
610
- [`ISenderKeyStore`](ISenderKeyStore.md).[`getAllSenderKeysForGroup`](ISenderKeyStore.md#getallsenderkeysforgroup)
611
-
612
- ***
613
-
614
- ### getAllUserIds()
615
-
616
- > **getAllUserIds**(): `Promise`\<`string`[]\>
617
-
618
- Get all user IDs with SESAME records.
619
-
620
- #### Returns
621
-
622
- `Promise`\<`string`[]\>
623
-
624
- #### Inherited from
625
-
626
- [`ISesameStore`](ISesameStore.md).[`getAllUserIds`](ISesameStore.md#getalluserids)
627
-
628
- ***
629
-
630
- ### getContactIdentity()
631
-
632
- > **getContactIdentity**(`address`, `identityType?`): `Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md) \| `null`\>
633
-
634
- Get a contact's saved identity key.
635
-
636
- Returns null if no identity key has been saved for this address.
637
-
638
- #### Parameters
639
-
640
- ##### address
641
-
642
- [`ProtocolAddress`](ProtocolAddress.md)
643
-
644
- Contact's protocol address
645
-
646
- ##### identityType?
647
-
648
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
649
-
650
- #### Returns
651
-
652
- `Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md) \| `null`\>
653
-
654
- Contact's identity key or null
655
-
656
- #### Inherited from
657
-
658
- [`IProtocolStore`](IProtocolStore.md).[`getContactIdentity`](IProtocolStore.md#getcontactidentity)
659
-
660
- ***
661
-
662
- ### getDetailedStats()
663
-
664
- > **getDetailedStats**(): `Promise`\<\{ `ecOneTimePreKeys`: `number`; `ecSignedPreKeys`: `number`; `kemOneTimePreKeys`: `number`; `kyberPreKeys`: `number`; `sessions`: `number`; `users`: `number`; \}\>
665
-
666
- Get detailed statistics about stored data.
667
-
668
- #### Returns
669
-
670
- `Promise`\<\{ `ecOneTimePreKeys`: `number`; `ecSignedPreKeys`: `number`; `kemOneTimePreKeys`: `number`; `kyberPreKeys`: `number`; `sessions`: `number`; `users`: `number`; \}\>
671
-
672
- ***
673
-
674
- ### getDeviceRecord()
675
-
676
- > **getDeviceRecord**(`userId`, `deviceId`): `Promise`\<[`DeviceRecord`](DeviceRecord.md) \| `null`\>
677
-
678
- Get device record for a specific user's device.
679
-
680
- #### Parameters
681
-
682
- ##### userId
683
-
684
- `string`
685
-
686
- ##### deviceId
687
-
688
- `number`
689
-
690
- #### Returns
691
-
692
- `Promise`\<[`DeviceRecord`](DeviceRecord.md) \| `null`\>
693
-
694
- #### Inherited from
695
-
696
- [`ISesameStore`](ISesameStore.md).[`getDeviceRecord`](ISesameStore.md#getdevicerecord)
697
-
698
- ***
699
-
700
- ### getDeviceSession()
701
-
702
- > **getDeviceSession**(`userId`, `deviceId`): `Promise`\<[`SessionRecord`](SessionRecord.md) \| `null`\>
703
-
704
- Get the session for a device.
705
-
706
- #### Parameters
707
-
708
- ##### userId
709
-
710
- `string`
711
-
712
- ##### deviceId
713
-
714
- `number`
715
-
716
- #### Returns
717
-
718
- `Promise`\<[`SessionRecord`](SessionRecord.md) \| `null`\>
719
-
720
- The SessionRecord, or null if no session exists.
721
-
722
- #### Inherited from
723
-
724
- [`ISesameStore`](ISesameStore.md).[`getDeviceSession`](ISesameStore.md#getdevicesession)
725
-
726
- ***
727
-
728
- ### getEcOneTimePreKeys()
729
-
730
- > **getEcOneTimePreKeys**(`identityType?`): `Promise`\<[`EcOneTimePreKey`](EcOneTimePreKey.md)[]\>
731
-
732
- Retrieve all EC one-time prekeys.
733
-
734
- #### Parameters
735
-
736
- ##### identityType?
737
-
738
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
739
-
740
- 'aci' or 'pni' (defaults to 'aci')
741
-
742
- #### Returns
743
-
744
- `Promise`\<[`EcOneTimePreKey`](EcOneTimePreKey.md)[]\>
745
-
746
- #### Inherited from
747
-
748
- [`IProtocolStore`](IProtocolStore.md).[`getEcOneTimePreKeys`](IProtocolStore.md#geteconetimeprekeys)
749
-
750
- ***
751
-
752
- ### getEcSignedPreKey()
753
-
754
- > **getEcSignedPreKey**(`keyId?`, `identityType?`): `Promise`\<[`EcSignedPreKey`](EcSignedPreKey.md) \| `null`\>
755
-
756
- Retrieve EC signed prekey by ID.
757
-
758
- #### Parameters
759
-
760
- ##### keyId?
761
-
762
- `number`
763
-
764
- Optional key ID to retrieve. If not provided, returns the current (most recent) EC signed prekey.
765
-
766
- ##### identityType?
767
-
768
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
769
-
770
- 'aci' or 'pni' (defaults to 'aci')
771
-
772
- #### Returns
773
-
774
- `Promise`\<[`EcSignedPreKey`](EcSignedPreKey.md) \| `null`\>
775
-
776
- The EC signed prekey, or null if not found
777
-
778
- #### Inherited from
779
-
780
- [`IProtocolStore`](IProtocolStore.md).[`getEcSignedPreKey`](IProtocolStore.md#getecsignedprekey)
781
-
782
- ***
783
-
784
- ### getEcSignedPreKeyMaxId()
785
-
786
- > **getEcSignedPreKeyMaxId**(`identityType?`): `Promise`\<`number`\>
787
-
788
- Get the maximum EC signed prekey ID in storage.
789
- Used to generate new keyIds that won't collide with existing ones.
790
-
791
- #### Parameters
792
-
793
- ##### identityType?
794
-
795
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
796
-
797
- 'aci' or 'pni' (defaults to 'aci')
798
-
799
- #### Returns
800
-
801
- `Promise`\<`number`\>
802
-
803
- The highest EC signed prekey ID, or 0 if none exist
804
-
805
- ***
806
-
807
- ### getIdentityKey()
808
-
809
- > **getIdentityKey**(`identityType?`): `Promise`\<[`IdentityKeyPair`](IdentityKeyPair.md) \| `null`\>
810
-
811
- Retrieve our identity key pair.
812
-
813
- #### Parameters
814
-
815
- ##### identityType?
816
-
817
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
818
-
819
- 'aci' or 'pni' (defaults to 'aci')
820
-
821
- #### Returns
822
-
823
- `Promise`\<[`IdentityKeyPair`](IdentityKeyPair.md) \| `null`\>
824
-
825
- #### Inherited from
826
-
827
- [`IProtocolStore`](IProtocolStore.md).[`getIdentityKey`](IProtocolStore.md#getidentitykey)
828
-
829
- ***
830
-
831
- ### getKemOneTimePreKey()
832
-
833
- > **getKemOneTimePreKey**(`keyId`, `identityType?`): `Promise`\<[`KemOneTimePreKey`](../namespaces/keys/interfaces/KemOneTimePreKey.md) \| `null`\>
834
-
835
- Retrieve a specific one-time KEM prekey by ID.
836
- Used during session establishment to find the key for decapsulation.
837
-
838
- #### Parameters
839
-
840
- ##### keyId
841
-
842
- `number`
843
-
844
- ##### identityType?
845
-
846
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
847
-
848
- 'aci' or 'pni' (defaults to 'aci')
849
-
850
- #### Returns
851
-
852
- `Promise`\<[`KemOneTimePreKey`](../namespaces/keys/interfaces/KemOneTimePreKey.md) \| `null`\>
853
-
854
- #### Inherited from
855
-
856
- [`IProtocolStore`](IProtocolStore.md).[`getKemOneTimePreKey`](IProtocolStore.md#getkemonetimeprekey)
857
-
858
- ***
859
-
860
- ### getKemOneTimePreKeyCount()
861
-
862
- > **getKemOneTimePreKeyCount**(`identityType?`): `Promise`\<`number`\>
863
-
864
- Get count of available one-time KEM prekeys.
865
- Used to determine when to replenish the prekey pool.
866
-
867
- #### Parameters
868
-
869
- ##### identityType?
870
-
871
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
872
-
873
- 'aci' or 'pni' (defaults to 'aci')
874
-
875
- #### Returns
876
-
877
- `Promise`\<`number`\>
878
-
879
- #### Inherited from
880
-
881
- [`IProtocolStore`](IProtocolStore.md).[`getKemOneTimePreKeyCount`](IProtocolStore.md#getkemonetimeprekeycount)
882
-
883
- ***
884
-
885
- ### getKemOneTimePreKeys()
886
-
887
- > **getKemOneTimePreKeys**(`identityType?`): `Promise`\<[`KemOneTimePreKey`](../namespaces/keys/interfaces/KemOneTimePreKey.md)[]\>
888
-
889
- Retrieve all one-time KEM prekeys.
890
-
891
- #### Parameters
892
-
893
- ##### identityType?
894
-
895
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
896
-
897
- 'aci' or 'pni' (defaults to 'aci')
898
-
899
- #### Returns
900
-
901
- `Promise`\<[`KemOneTimePreKey`](../namespaces/keys/interfaces/KemOneTimePreKey.md)[]\>
902
-
903
- #### Inherited from
904
-
905
- [`IProtocolStore`](IProtocolStore.md).[`getKemOneTimePreKeys`](IProtocolStore.md#getkemonetimeprekeys)
906
-
907
- ***
908
-
909
- ### getKyberPreKey()
910
-
911
- > **getKyberPreKey**(`identityType?`): `Promise`\<[`KyberPreKey`](KyberPreKey.md) \| `null`\>
912
-
913
- Retrieve Kyber prekey.
914
-
915
- #### Parameters
916
-
917
- ##### identityType?
918
-
919
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
920
-
921
- 'aci' or 'pni' (defaults to 'aci')
922
-
923
- #### Returns
924
-
925
- `Promise`\<[`KyberPreKey`](KyberPreKey.md) \| `null`\>
926
-
927
- #### Inherited from
928
-
929
- [`IProtocolStore`](IProtocolStore.md).[`getKyberPreKey`](IProtocolStore.md#getkyberprekey)
930
-
931
- ***
932
-
933
- ### getKyberPreKeyMaxId()
934
-
935
- > **getKyberPreKeyMaxId**(`identityType?`): `Promise`\<`number`\>
936
-
937
- Get the maximum Kyber prekey ID in storage.
938
- Used to generate new keyIds that won't collide with existing ones.
939
-
940
- #### Parameters
941
-
942
- ##### identityType?
943
-
944
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
945
-
946
- 'aci' or 'pni' (defaults to 'aci')
947
-
948
- #### Returns
949
-
950
- `Promise`\<`number`\>
951
-
952
- The highest Kyber prekey ID, or 0 if none exist
953
-
954
- ***
955
-
956
- ### getLocalRegistrationId()
957
-
958
- > **getLocalRegistrationId**(`identityType?`): `Promise`\<`number`\>
959
-
960
- Get our local registration ID.
961
-
962
- Registration ID is a random 16-bit integer generated once per install.
963
- Used to detect session resets when app is reinstalled.
964
-
965
- #### Parameters
966
-
967
- ##### identityType?
968
-
969
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
970
-
971
- 'aci' or 'pni' (defaults to 'aci')
972
-
973
- #### Returns
974
-
975
- `Promise`\<`number`\>
976
-
977
- #### Inherited from
978
-
979
- [`IProtocolStore`](IProtocolStore.md).[`getLocalRegistrationId`](IProtocolStore.md#getlocalregistrationid)
980
-
981
- ***
982
-
983
- ### getMessageRecord()
984
-
985
- > **getMessageRecord**(`sessionId`, `timestamp`): `Promise`\<[`MessageRecord`](MessageRecord.md) \| `null`\>
986
-
987
- Get a message record by session and timestamp (PRIMARY lookup method).
988
-
989
- Per Signal Protocol, messages are identified by client timestamp.
990
-
991
- #### Parameters
992
-
993
- ##### sessionId
994
-
995
- `string`
996
-
997
- ##### timestamp
998
-
999
- `number`
1000
-
1001
- #### Returns
1002
-
1003
- `Promise`\<[`MessageRecord`](MessageRecord.md) \| `null`\>
1004
-
1005
- #### Inherited from
1006
-
1007
- `IMessageRecordStore.getMessageRecord`
1008
-
1009
- ***
1010
-
1011
- ### getMetadata()
1012
-
1013
- > **getMetadata**(`key`): `Promise`\<`string` \| `null`\>
1014
-
1015
- Get a metadata value by key.
1016
- Used for persisting operational timestamps (e.g., lastForcedPreKeyRotation).
1017
-
1018
- #### Parameters
1019
-
1020
- ##### key
1021
-
1022
- `string`
1023
-
1024
- #### Returns
1025
-
1026
- `Promise`\<`string` \| `null`\>
1027
-
1028
- ***
1029
-
1030
- ### getSenderKey()
1031
-
1032
- > **getSenderKey**(`groupId`, `userId`, `deviceId`): `Promise`\<[`SenderKeyState`](SenderKeyState.md) \| `null`\>
1033
-
1034
- Retrieve sender key state for a group member device.
1035
-
1036
- #### Parameters
1037
-
1038
- ##### groupId
1039
-
1040
- `string`
1041
-
1042
- ##### userId
1043
-
1044
- `string`
1045
-
1046
- ##### deviceId
1047
-
1048
- `number`
1049
-
1050
- #### Returns
1051
-
1052
- `Promise`\<[`SenderKeyState`](SenderKeyState.md) \| `null`\>
1053
-
1054
- #### Inherited from
1055
-
1056
- [`ISenderKeyStore`](ISenderKeyStore.md).[`getSenderKey`](ISenderKeyStore.md#getsenderkey)
1057
-
1058
- ***
1059
-
1060
- ### getSenderKeyRecord()
1061
-
1062
- > **getSenderKeyRecord**(`groupId`, `userId`, `deviceId`): `Promise`\<[`SenderKeyState`](SenderKeyState.md)[] \| `null`\>
1063
-
1064
- Retrieve all sender key states (current + previous) for a group member device.
1065
-
1066
- First element is the current state; remaining are previous states.
1067
-
1068
- #### Parameters
1069
-
1070
- ##### groupId
1071
-
1072
- `string`
1073
-
1074
- Group identifier
1075
-
1076
- ##### userId
1077
-
1078
- `string`
1079
-
1080
- User identifier
1081
-
1082
- ##### deviceId
1083
-
1084
- `number`
1085
-
1086
- Device identifier
1087
-
1088
- #### Returns
1089
-
1090
- `Promise`\<[`SenderKeyState`](SenderKeyState.md)[] \| `null`\>
1091
-
1092
- Array of states, or null if none exist
1093
-
1094
- #### Inherited from
1095
-
1096
- [`ISenderKeyStore`](ISenderKeyStore.md).[`getSenderKeyRecord`](ISenderKeyStore.md#getsenderkeyrecord)
1097
-
1098
- ***
1099
-
1100
- ### getSesameDeviceIds()
1101
-
1102
- > **getSesameDeviceIds**(`userId`): `Promise`\<`number`[]\>
1103
-
1104
- Get all device IDs for a specific user.
1105
-
1106
- #### Parameters
1107
-
1108
- ##### userId
1109
-
1110
- `string`
1111
-
1112
- #### Returns
1113
-
1114
- `Promise`\<`number`[]\>
1115
-
1116
- #### Inherited from
1117
-
1118
- [`ISesameStore`](ISesameStore.md).[`getSesameDeviceIds`](ISesameStore.md#getsesamedeviceids)
1119
-
1120
- ***
1121
-
1122
- ### getSessionCount()
1123
-
1124
- > **getSessionCount**(): `Promise`\<`number`\>
1125
-
1126
- Get the count of active sessions.
1127
-
1128
- #### Returns
1129
-
1130
- `Promise`\<`number`\>
1131
-
1132
- Number of sessions stored
1133
-
1134
- #### Inherited from
1135
-
1136
- [`IProtocolStore`](IProtocolStore.md).[`getSessionCount`](IProtocolStore.md#getsessioncount)
1137
-
1138
- ***
1139
-
1140
- ### getSessionRecord()
1141
-
1142
- > **getSessionRecord**(`address`): `Promise`\<[`SessionRecord`](SessionRecord.md) \| `null`\>
1143
-
1144
- Retrieve session record.
1145
-
1146
- #### Parameters
1147
-
1148
- ##### address
1149
-
1150
- [`ProtocolAddress`](ProtocolAddress.md)
1151
-
1152
- Protocol address
1153
-
1154
- #### Returns
1155
-
1156
- `Promise`\<[`SessionRecord`](SessionRecord.md) \| `null`\>
1157
-
1158
- SessionRecord or null if no session exists
1159
-
1160
- #### Inherited from
1161
-
1162
- [`IProtocolStore`](IProtocolStore.md).[`getSessionRecord`](IProtocolStore.md#getsessionrecord)
1163
-
1164
- ***
1165
-
1166
- ### getSessionsForUser()
1167
-
1168
- > **getSessionsForUser**(`userId`): `Promise`\<[`SessionRecord`](SessionRecord.md)[]\>
1169
-
1170
- Get all sessions for a user (across all their devices).
1171
-
1172
- Useful for multi-device scenarios where one user has multiple devices.
1173
-
1174
- #### Parameters
1175
-
1176
- ##### userId
1177
-
1178
- `string`
1179
-
1180
- User ID (not including device ID)
1181
-
1182
- #### Returns
1183
-
1184
- `Promise`\<[`SessionRecord`](SessionRecord.md)[]\>
1185
-
1186
- Array of session records for all of this user's devices
1187
-
1188
- #### Inherited from
1189
-
1190
- [`IProtocolStore`](IProtocolStore.md).[`getSessionsForUser`](IProtocolStore.md#getsessionsforuser)
1191
-
1192
- ***
1193
-
1194
- ### getSkippedSenderKey()
1195
-
1196
- > **getSkippedSenderKey**(`groupId`, `senderId`, `senderDeviceId`, `chainIndex`): `Promise`\<[`SkippedSenderMessageKey`](SkippedSenderMessageKey.md) \| `null`\>
1197
-
1198
- Retrieve skipped message key for out-of-order decryption.
1199
-
1200
- #### Parameters
1201
-
1202
- ##### groupId
1203
-
1204
- `string`
1205
-
1206
- Group identifier
1207
-
1208
- ##### senderId
1209
-
1210
- `string`
1211
-
1212
- Sender user identifier
1213
-
1214
- ##### senderDeviceId
1215
-
1216
- `number`
1217
-
1218
- Sender device identifier
1219
-
1220
- ##### chainIndex
1221
-
1222
- `number`
1223
-
1224
- The message index to look up
1225
-
1226
- #### Returns
1227
-
1228
- `Promise`\<[`SkippedSenderMessageKey`](SkippedSenderMessageKey.md) \| `null`\>
1229
-
1230
- Message key or null if not found/expired
1231
-
1232
- #### Inherited from
1233
-
1234
- [`ISenderKeyStore`](ISenderKeyStore.md).[`getSkippedSenderKey`](ISenderKeyStore.md#getskippedsenderkey)
1235
-
1236
- ***
1237
-
1238
- ### getUserRecord()
1239
-
1240
- > **getUserRecord**(`userId`): `Promise`\<[`UserRecord`](UserRecord.md) \| `null`\>
1241
-
1242
- Get user record containing all devices for a user.
1243
-
1244
- #### Parameters
1245
-
1246
- ##### userId
1247
-
1248
- `string`
1249
-
1250
- #### Returns
1251
-
1252
- `Promise`\<[`UserRecord`](UserRecord.md) \| `null`\>
1253
-
1254
- #### Inherited from
1255
-
1256
- [`ISesameStore`](ISesameStore.md).[`getUserRecord`](ISesameStore.md#getuserrecord)
1257
-
1258
- ***
1259
-
1260
- ### hasIdentityKey()
1261
-
1262
- > **hasIdentityKey**(`identityType?`): `Promise`\<`boolean`\>
1263
-
1264
- Check if identity key exists.
1265
-
1266
- #### Parameters
1267
-
1268
- ##### identityType?
1269
-
1270
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
1271
-
1272
- 'aci' or 'pni' (defaults to 'aci')
1273
-
1274
- #### Returns
1275
-
1276
- `Promise`\<`boolean`\>
1277
-
1278
- #### Inherited from
1279
-
1280
- [`IProtocolStore`](IProtocolStore.md).[`hasIdentityKey`](IProtocolStore.md#hasidentitykey)
1281
-
1282
- ***
1283
-
1284
- ### hasSession()
1285
-
1286
- > **hasSession**(`address`): `Promise`\<`boolean`\>
1287
-
1288
- Check if a session exists for the given address.
1289
-
1290
- #### Parameters
1291
-
1292
- ##### address
1293
-
1294
- [`ProtocolAddress`](ProtocolAddress.md)
1295
-
1296
- Protocol address
1297
-
1298
- #### Returns
1299
-
1300
- `Promise`\<`boolean`\>
1301
-
1302
- true if session exists
1303
-
1304
- #### Inherited from
1305
-
1306
- [`IProtocolStore`](IProtocolStore.md).[`hasSession`](IProtocolStore.md#hassession)
1307
-
1308
- ***
1309
-
1310
- ### isTrustedIdentity()
1311
-
1312
- > **isTrustedIdentity**(`address`, `identity`, `direction`, `identityType?`): `Promise`\<`boolean`\>
1313
-
1314
- Check if a contact's identity key is trusted.
1315
-
1316
- Trust verification behavior depends on direction:
1317
- - SENDING: Stricter - don't send to untrusted identities
1318
- - RECEIVING: More permissive - allow receiving but warn user
1319
-
1320
- From Signal Protocol:
1321
- "It's safer to receive from an unknown identity than to send to one"
1322
-
1323
- #### Parameters
1324
-
1325
- ##### address
1326
-
1327
- [`ProtocolAddress`](ProtocolAddress.md)
1328
-
1329
- Contact's protocol address
1330
-
1331
- ##### identity
1332
-
1333
- [`CompositeIdentityV1`](../namespaces/keys/interfaces/CompositeIdentityV1.md)
1334
-
1335
- Complete composite identity candidate
1336
-
1337
- ##### direction
1338
-
1339
- [`TrustDirection`](../enumerations/TrustDirection.md)
1340
-
1341
- Whether we're sending or receiving
1342
-
1343
- ##### identityType?
1344
-
1345
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
1346
-
1347
- ACI or PNI trust namespace
1348
-
1349
- #### Returns
1350
-
1351
- `Promise`\<`boolean`\>
1352
-
1353
- true if identity is trusted
1354
-
1355
- #### Inherited from
1356
-
1357
- [`IProtocolStore`](IProtocolStore.md).[`isTrustedIdentity`](IProtocolStore.md#istrustedidentity)
1358
-
1359
- ***
1360
-
1361
- ### markKyberPreKeyUsed()
1362
-
1363
- > **markKyberPreKeyUsed**(`kyberPreKeyId`, `signedPreKeyId`, `baseKeyBytes`, `identityType?`): `Promise`\<`void`\>
1364
-
1365
- Mark a Kyber prekey as used.
1366
-
1367
- Kyber prekeys can be reused (unlike one-time prekeys) but should be
1368
- tracked to ensure proper rotation.
1369
-
1370
- #### Parameters
1371
-
1372
- ##### kyberPreKeyId
1373
-
1374
- `number`
1375
-
1376
- ID of the Kyber prekey that was used
1377
-
1378
- ##### signedPreKeyId
1379
-
1380
- `number`
1381
-
1382
- ID of the signed prekey used in combination
1383
-
1384
- ##### baseKeyBytes
1385
-
1386
- `Uint8Array`
1387
-
1388
- Base key bytes for the session
1389
-
1390
- ##### identityType?
1391
-
1392
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
1393
-
1394
- 'aci' or 'pni' (defaults to 'aci')
1395
-
1396
- #### Returns
1397
-
1398
- `Promise`\<`void`\>
1399
-
1400
- #### Inherited from
1401
-
1402
- [`IProtocolStore`](IProtocolStore.md).[`markKyberPreKeyUsed`](IProtocolStore.md#markkyberprekeyused)
1403
-
1404
- ***
1405
-
1406
- ### removeEcOneTimePreKey()
1407
-
1408
- > **removeEcOneTimePreKey**(`preKeyId`, `identityType?`): `Promise`\<`void`\>
1409
-
1410
- Remove an EC one-time prekey after it has been used.
1411
-
1412
- #### Parameters
1413
-
1414
- ##### preKeyId
1415
-
1416
- `number`
1417
-
1418
- ID of the prekey to remove
1419
-
1420
- ##### identityType?
1421
-
1422
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
1423
-
1424
- 'aci' or 'pni' (defaults to 'aci')
1425
-
1426
- #### Returns
1427
-
1428
- `Promise`\<`void`\>
1429
-
1430
- #### Inherited from
1431
-
1432
- [`IProtocolStore`](IProtocolStore.md).[`removeEcOneTimePreKey`](IProtocolStore.md#removeeconetimeprekey)
1433
-
1434
- ***
1435
-
1436
- ### removeEcSignedPreKey()?
1437
-
1438
- > `optional` **removeEcSignedPreKey**(`keyId`, `identityType?`): `Promise`\<`void`\>
1439
-
1440
- Remove an EC signed prekey by ID.
1441
-
1442
- Called during cleanup to remove expired archived prekeys.
1443
- Should NEVER remove the current (most recent) EC signed prekey.
1444
-
1445
- #### Parameters
1446
-
1447
- ##### keyId
1448
-
1449
- `number`
1450
-
1451
- The key ID to remove
1452
-
1453
- ##### identityType?
1454
-
1455
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
1456
-
1457
- 'aci' or 'pni' (defaults to 'aci')
1458
-
1459
- #### Returns
1460
-
1461
- `Promise`\<`void`\>
1462
-
1463
- #### Inherited from
1464
-
1465
- [`IProtocolStore`](IProtocolStore.md).[`removeEcSignedPreKey`](IProtocolStore.md#removeecsignedprekey)
1466
-
1467
- ***
1468
-
1469
- ### removeKemOneTimePreKey()
1470
-
1471
- > **removeKemOneTimePreKey**(`keyId`, `identityType?`): `Promise`\<`void`\>
1472
-
1473
- Remove a one-time KEM prekey after it has been used.
1474
-
1475
- CRITICAL: Must be called immediately after successful decapsulation
1476
- to provide per-session post-quantum forward secrecy.
1477
-
1478
- #### Parameters
1479
-
1480
- ##### keyId
1481
-
1482
- `number`
1483
-
1484
- ID of the prekey to remove
1485
-
1486
- ##### identityType?
1487
-
1488
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
1489
-
1490
- 'aci' or 'pni' (defaults to 'aci')
1491
-
1492
- #### Returns
1493
-
1494
- `Promise`\<`void`\>
1495
-
1496
- #### Inherited from
1497
-
1498
- [`IProtocolStore`](IProtocolStore.md).[`removeKemOneTimePreKey`](IProtocolStore.md#removekemonetimeprekey)
1499
-
1500
- ***
1501
-
1502
- ### saveContactIdentity()
1503
-
1504
- > **saveContactIdentity**(`address`, `identity`, `identityType?`, `suppliedCommitment?`): `Promise`\<[`IdentityKeyChange`](../enumerations/IdentityKeyChange.md)\>
1505
-
1506
- Save a contact's identity key and detect changes.
1507
-
1508
- This is used for Trust On First Use (TOFU) and post-pinning change
1509
- detection. Returns whether either composite component changed.
1510
-
1511
- #### Parameters
1512
-
1513
- ##### address
1514
-
1515
- [`ProtocolAddress`](ProtocolAddress.md)
1516
-
1517
- Contact's protocol address
1518
-
1519
- ##### identity
1520
-
1521
- [`CompositeIdentityV1`](../namespaces/keys/interfaces/CompositeIdentityV1.md)
1522
-
1523
- Contact's complete canonical composite identity
1524
-
1525
- ##### identityType?
1526
-
1527
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
1528
-
1529
- ACI or PNI trust namespace
1530
-
1531
- ##### suppliedCommitment?
1532
-
1533
- `Uint8Array`\<`ArrayBufferLike`\>
1534
-
1535
- Optional redundant commitment that must match
1536
-
1537
- #### Returns
1538
-
1539
- `Promise`\<[`IdentityKeyChange`](../enumerations/IdentityKeyChange.md)\>
1540
-
1541
- IdentityKeyChange indicating if key is new or changed
1542
-
1543
- #### Inherited from
1544
-
1545
- [`IProtocolStore`](IProtocolStore.md).[`saveContactIdentity`](IProtocolStore.md#savecontactidentity)
1546
-
1547
- ***
1548
-
1549
- ### setDeviceRecord()
1550
-
1551
- > **setDeviceRecord**(`userId`, `deviceId`, `record`): `Promise`\<`void`\>
1552
-
1553
- Store device record.
1554
-
1555
- #### Parameters
1556
-
1557
- ##### userId
1558
-
1559
- `string`
1560
-
1561
- ##### deviceId
1562
-
1563
- `number`
1564
-
1565
- ##### record
1566
-
1567
- [`DeviceRecord`](DeviceRecord.md)
1568
-
1569
- #### Returns
1570
-
1571
- `Promise`\<`void`\>
1572
-
1573
- #### Inherited from
1574
-
1575
- [`ISesameStore`](ISesameStore.md).[`setDeviceRecord`](ISesameStore.md#setdevicerecord)
1576
-
1577
- ***
1578
-
1579
- ### setDeviceSession()
1580
-
1581
- > **setDeviceSession**(`userId`, `deviceId`, `session`): `Promise`\<`void`\>
1582
-
1583
- Set the session for a device.
1584
- This updates DeviceRecord.session.
1585
-
1586
- #### Parameters
1587
-
1588
- ##### userId
1589
-
1590
- `string`
1591
-
1592
- ##### deviceId
1593
-
1594
- `number`
1595
-
1596
- ##### session
1597
-
1598
- [`SessionRecord`](SessionRecord.md)
1599
-
1600
- #### Returns
1601
-
1602
- `Promise`\<`void`\>
1603
-
1604
- #### Inherited from
1605
-
1606
- [`ISesameStore`](ISesameStore.md).[`setDeviceSession`](ISesameStore.md#setdevicesession)
1607
-
1608
- ***
1609
-
1610
- ### setLocalRegistrationId()
1611
-
1612
- > **setLocalRegistrationId**(`id`, `identityType?`): `Promise`\<`void`\>
1613
-
1614
- Set our local registration ID.
1615
-
1616
- Should only be called once during initialization.
1617
-
1618
- #### Parameters
1619
-
1620
- ##### id
1621
-
1622
- `number`
1623
-
1624
- Registration ID
1625
-
1626
- ##### identityType?
1627
-
1628
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
1629
-
1630
- 'aci' or 'pni' (defaults to 'aci')
1631
-
1632
- #### Returns
1633
-
1634
- `Promise`\<`void`\>
1635
-
1636
- #### Inherited from
1637
-
1638
- [`IProtocolStore`](IProtocolStore.md).[`setLocalRegistrationId`](IProtocolStore.md#setlocalregistrationid)
1639
-
1640
- ***
1641
-
1642
- ### setMetadata()
1643
-
1644
- > **setMetadata**(`key`, `value`): `Promise`\<`void`\>
1645
-
1646
- Set a metadata value by key.
1647
-
1648
- #### Parameters
1649
-
1650
- ##### key
1651
-
1652
- `string`
1653
-
1654
- ##### value
1655
-
1656
- `string`
1657
-
1658
- #### Returns
1659
-
1660
- `Promise`\<`void`\>
1661
-
1662
- ***
1663
-
1664
- ### setUserRecord()
1665
-
1666
- > **setUserRecord**(`userId`, `record`): `Promise`\<`void`\>
1667
-
1668
- Store user record.
1669
-
1670
- #### Parameters
1671
-
1672
- ##### userId
1673
-
1674
- `string`
1675
-
1676
- ##### record
1677
-
1678
- [`UserRecord`](UserRecord.md)
1679
-
1680
- #### Returns
1681
-
1682
- `Promise`\<`void`\>
1683
-
1684
- #### Inherited from
1685
-
1686
- [`ISesameStore`](ISesameStore.md).[`setUserRecord`](ISesameStore.md#setuserrecord)
1687
-
1688
- ***
1689
-
1690
- ### storeEcOneTimePreKeys()
1691
-
1692
- > **storeEcOneTimePreKeys**(`prekeys`, `identityType?`): `Promise`\<`void`\>
1693
-
1694
- Store EC one-time prekeys.
1695
-
1696
- #### Parameters
1697
-
1698
- ##### prekeys
1699
-
1700
- [`EcOneTimePreKey`](EcOneTimePreKey.md)[]
1701
-
1702
- ##### identityType?
1703
-
1704
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
1705
-
1706
- 'aci' or 'pni' (defaults to 'aci')
1707
-
1708
- #### Returns
1709
-
1710
- `Promise`\<`void`\>
1711
-
1712
- #### Inherited from
1713
-
1714
- [`IProtocolStore`](IProtocolStore.md).[`storeEcOneTimePreKeys`](IProtocolStore.md#storeeconetimeprekeys)
1715
-
1716
- ***
1717
-
1718
- ### storeEcSignedPreKey()
1719
-
1720
- > **storeEcSignedPreKey**(`signedPreKey`, `identityType?`): `Promise`\<`void`\>
1721
-
1722
- Store EC signed prekey.
1723
-
1724
- When storing a new EC signed prekey (rotation), the old one should be
1725
- archived (not deleted) to handle in-flight messages.
1726
-
1727
- #### Parameters
1728
-
1729
- ##### signedPreKey
1730
-
1731
- [`EcSignedPreKey`](EcSignedPreKey.md)
1732
-
1733
- ##### identityType?
1734
-
1735
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
1736
-
1737
- 'aci' or 'pni' (defaults to 'aci')
1738
-
1739
- #### Returns
1740
-
1741
- `Promise`\<`void`\>
1742
-
1743
- #### Inherited from
1744
-
1745
- [`IProtocolStore`](IProtocolStore.md).[`storeEcSignedPreKey`](IProtocolStore.md#storeecsignedprekey)
1746
-
1747
- ***
1748
-
1749
- ### storeIdentityKey()
1750
-
1751
- > **storeIdentityKey**(`keyPair`, `identityType?`): `Promise`\<`void`\>
1752
-
1753
- Store our identity key pair (only done once per install per identity type).
1754
-
1755
- #### Parameters
1756
-
1757
- ##### keyPair
1758
-
1759
- [`IdentityKeyPair`](IdentityKeyPair.md)
1760
-
1761
- Identity key pair to store
1762
-
1763
- ##### identityType?
1764
-
1765
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
1766
-
1767
- 'aci' or 'pni' (defaults to 'aci')
1768
-
1769
- #### Returns
1770
-
1771
- `Promise`\<`void`\>
1772
-
1773
- #### Inherited from
1774
-
1775
- [`IProtocolStore`](IProtocolStore.md).[`storeIdentityKey`](IProtocolStore.md#storeidentitykey)
1776
-
1777
- ***
1778
-
1779
- ### storeKemOneTimePreKeys()
1780
-
1781
- > **storeKemOneTimePreKeys**(`prekeys`, `identityType?`): `Promise`\<`void`\>
1782
-
1783
- Store one-time KEM prekeys (batch storage).
1784
-
1785
- #### Parameters
1786
-
1787
- ##### prekeys
1788
-
1789
- [`KemOneTimePreKey`](../namespaces/keys/interfaces/KemOneTimePreKey.md)[]
1790
-
1791
- ##### identityType?
1792
-
1793
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
1794
-
1795
- 'aci' or 'pni' (defaults to 'aci')
1796
-
1797
- #### Returns
1798
-
1799
- `Promise`\<`void`\>
1800
-
1801
- #### Inherited from
1802
-
1803
- [`IProtocolStore`](IProtocolStore.md).[`storeKemOneTimePreKeys`](IProtocolStore.md#storekemonetimeprekeys)
1804
-
1805
- ***
1806
-
1807
- ### storeKyberPreKey()
1808
-
1809
- > **storeKyberPreKey**(`kyberPreKey`, `identityType?`): `Promise`\<`void`\>
1810
-
1811
- Store Kyber prekey (post-quantum security).
1812
-
1813
- #### Parameters
1814
-
1815
- ##### kyberPreKey
1816
-
1817
- [`KyberPreKey`](KyberPreKey.md)
1818
-
1819
- ##### identityType?
1820
-
1821
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
1822
-
1823
- 'aci' or 'pni' (defaults to 'aci')
1824
-
1825
- #### Returns
1826
-
1827
- `Promise`\<`void`\>
1828
-
1829
- #### Inherited from
1830
-
1831
- [`IProtocolStore`](IProtocolStore.md).[`storeKyberPreKey`](IProtocolStore.md#storekyberprekey)
1832
-
1833
- ***
1834
-
1835
- ### storeMessageRecord()
1836
-
1837
- > **storeMessageRecord**(`record`): `Promise`\<`void`\>
1838
-
1839
- Store a message record after encryption
1840
-
1841
- #### Parameters
1842
-
1843
- ##### record
1844
-
1845
- [`MessageRecord`](MessageRecord.md)
1846
-
1847
- #### Returns
1848
-
1849
- `Promise`\<`void`\>
1850
-
1851
- #### Inherited from
1852
-
1853
- `IMessageRecordStore.storeMessageRecord`
1854
-
1855
- ***
1856
-
1857
- ### storeSenderKey()
1858
-
1859
- > **storeSenderKey**(`groupId`, `userId`, `deviceId`, `state`): `Promise`\<`void`\>
1860
-
1861
- Store sender key state for a group member device.
1862
-
1863
- #### Parameters
1864
-
1865
- ##### groupId
1866
-
1867
- `string`
1868
-
1869
- ##### userId
1870
-
1871
- `string`
1872
-
1873
- ##### deviceId
1874
-
1875
- `number`
1876
-
1877
- ##### state
1878
-
1879
- [`SenderKeyState`](SenderKeyState.md)
1880
-
1881
- #### Returns
1882
-
1883
- `Promise`\<`void`\>
1884
-
1885
- #### Inherited from
1886
-
1887
- [`ISenderKeyStore`](ISenderKeyStore.md).[`storeSenderKey`](ISenderKeyStore.md#storesenderkey)
1888
-
1889
- ***
1890
-
1891
- ### storeSenderKeyRecord()
1892
-
1893
- > **storeSenderKeyRecord**(`groupId`, `userId`, `deviceId`, `states`): `Promise`\<`void`\>
1894
-
1895
- Store all sender key states (current + previous) for a group member device.
1896
-
1897
- The first element is the current state; remaining are previous states
1898
- retained during the rotation window for decrypting in-flight messages.
1899
-
1900
- Per Sender Keys spec Section 5.1: "Implementations MUST store sender key
1901
- state persistently." This method persists the full record atomically.
1902
-
1903
- #### Parameters
1904
-
1905
- ##### groupId
1906
-
1907
- `string`
1908
-
1909
- Group identifier
1910
-
1911
- ##### userId
1912
-
1913
- `string`
1914
-
1915
- User identifier
1916
-
1917
- ##### deviceId
1918
-
1919
- `number`
1920
-
1921
- Device identifier
1922
-
1923
- ##### states
1924
-
1925
- [`SenderKeyState`](SenderKeyState.md)[]
1926
-
1927
- Array of states (current first, then previous, capped at MAX_SENDER_KEY_STATES)
1928
-
1929
- #### Returns
1930
-
1931
- `Promise`\<`void`\>
1932
-
1933
- #### Inherited from
1934
-
1935
- [`ISenderKeyStore`](ISenderKeyStore.md).[`storeSenderKeyRecord`](ISenderKeyStore.md#storesenderkeyrecord)
1936
-
1937
- ***
1938
-
1939
- ### storeSessionRecord()
1940
-
1941
- > **storeSessionRecord**(`address`, `record`): `Promise`\<`void`\>
1942
-
1943
- Store session record with current + archived sessions.
1944
-
1945
- This is the preferred API for session storage, supporting session archiving
1946
- and handling race conditions.
1947
-
1948
- #### Parameters
1949
-
1950
- ##### address
1951
-
1952
- [`ProtocolAddress`](ProtocolAddress.md)
1953
-
1954
- Protocol address for this session
1955
-
1956
- ##### record
1957
-
1958
- [`SessionRecord`](SessionRecord.md)
1959
-
1960
- SessionRecord containing current and archived sessions
1961
-
1962
- #### Returns
1963
-
1964
- `Promise`\<`void`\>
1965
-
1966
- #### Inherited from
1967
-
1968
- [`IProtocolStore`](IProtocolStore.md).[`storeSessionRecord`](IProtocolStore.md#storesessionrecord)
1969
-
1970
- ***
1971
-
1972
- ### storeSkippedSenderKey()
1973
-
1974
- > **storeSkippedSenderKey**(`groupId`, `senderId`, `senderDeviceId`, `chainIndex`, `messageKey`): `Promise`\<`void`\>
1975
-
1976
- Store skipped message key for out-of-order decryption.
1977
-
1978
- When chain is advanced past a message (gap in chainIndex),
1979
- store the derived key so the skipped message can be decrypted later.
1980
-
1981
- #### Parameters
1982
-
1983
- ##### groupId
1984
-
1985
- `string`
1986
-
1987
- Group identifier
1988
-
1989
- ##### senderId
1990
-
1991
- `string`
1992
-
1993
- Sender user identifier
1994
-
1995
- ##### senderDeviceId
1996
-
1997
- `number`
1998
-
1999
- Sender device identifier
2000
-
2001
- ##### chainIndex
2002
-
2003
- `number`
2004
-
2005
- The message index this key is for
2006
-
2007
- ##### messageKey
2008
-
2009
- [`SkippedSenderMessageKey`](SkippedSenderMessageKey.md)
2010
-
2011
- Derived IV and cipher key (base64 encoded)
2012
-
2013
- #### Returns
2014
-
2015
- `Promise`\<`void`\>
2016
-
2017
- #### Inherited from
2018
-
2019
- [`ISenderKeyStore`](ISenderKeyStore.md).[`storeSkippedSenderKey`](ISenderKeyStore.md#storeskippedsenderkey)
2020
-
2021
- ***
2022
-
2023
- ### verifyContactIdentity()
2024
-
2025
- > **verifyContactIdentity**(`address`, `identity`, `identityType?`, `suppliedCommitment?`): `Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md)\>
2026
-
2027
- Promote the exact current tuple after authenticated comparison.
2028
-
2029
- #### Parameters
2030
-
2031
- ##### address
2032
-
2033
- [`ProtocolAddress`](ProtocolAddress.md)
2034
-
2035
- ##### identity
2036
-
2037
- [`CompositeIdentityV1`](../namespaces/keys/interfaces/CompositeIdentityV1.md)
2038
-
2039
- ##### identityType?
2040
-
2041
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
2042
-
2043
- ##### suppliedCommitment?
2044
-
2045
- `Uint8Array`\<`ArrayBufferLike`\>
2046
-
2047
- #### Returns
2048
-
2049
- `Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md)\>
2050
-
2051
- #### Inherited from
2052
-
2053
- [`IProtocolStore`](IProtocolStore.md).[`verifyContactIdentity`](IProtocolStore.md#verifycontactidentity)