@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,839 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolClientConfig
6
-
7
- # Interface: SignalProtocolClientConfig
8
-
9
- Low-level SignalProtocolClient configuration options.
10
-
11
- Application code should usually prefer `createSignalProtocolClient()`, which groups
12
- account identity, adapters, and protocol policy into a friendlier shape. Use
13
- this config directly when lower-level integration code already has flattened
14
- client options.
15
-
16
- ## Example
17
-
18
- ```typescript
19
- import {
20
- createSignalProtocolClient,
21
- SignalProtocolClient,
22
- } from '@open-e2ee/signal-protocol-sdk';
23
- import {
24
- convexRelay,
25
- type ConvexSignalRelayApi,
26
- } from '@open-e2ee/signal-protocol-sdk/remote/relay/convex';
27
- import { api } from '../convex/_generated/api';
28
-
29
- const signalApi = api.signal satisfies ConvexSignalRelayApi;
30
- const relay = convexRelay({ convex, api: signalApi, currentUserId: userId });
31
-
32
- // Preferred app-facing composition.
33
- const signal = await createSignalProtocolClient({
34
- identity: { userId },
35
- adapters: { storage, relay },
36
- });
37
-
38
- // Low-level factory with the same underlying options.
39
- const advancedSignal = await SignalProtocolClient.create(userId, {
40
- storage,
41
- relay,
42
- onProgress,
43
- ratchetConfig: {
44
- maxSkip: 2000,
45
- keyExpirationMs: 14 * 24 * 60 * 60 * 1000 // 14 days
46
- },
47
- enableDebugLogging: true
48
- });
49
- ```
50
-
51
- ## Properties
52
-
53
- ### contentAdapter?
54
-
55
- > `optional` **contentAdapter?**: [`SignalContentAdapter`](SignalContentAdapter.md)
56
-
57
- Application-provided content adapter.
58
-
59
- This is the boundary between the protocol layer and app-specific content,
60
- notification batching, and privacy preference policy.
61
-
62
- ***
63
-
64
- ### deviceId?
65
-
66
- > `optional` **deviceId?**: `number`
67
-
68
- Device identifier for multi-device support
69
-
70
- - 1 = Primary device (default)
71
- - 2-5 = Linked devices
72
-
73
- Device 1 bootstraps identity locally. Devices 2-5 must already have a
74
- provisioned identity imported into the provided storage before
75
- `SignalProtocolClient.create()` is called.
76
-
77
- Prekeys and sessions remain device-specific; account identity is shared.
78
- Maximum 5 devices per user (1 primary + 4 linked).
79
-
80
- #### Default
81
-
82
- ```ts
83
- 1 (primary device)
84
- ```
85
-
86
- #### Example
87
-
88
- ```typescript
89
- // Primary device
90
- const signal = await SignalProtocolClient.create(userId, {
91
- storage: customStorage,
92
- deviceId: 1
93
- });
94
-
95
- // Linked device (from QR code provisioning)
96
- const signal = await SignalProtocolClient.create(userId, {
97
- storage: provisionedLinkedDeviceStorage,
98
- deviceId: 2
99
- });
100
- ```
101
-
102
- ***
103
-
104
- ### enableDebugLogging?
105
-
106
- > `optional` **enableDebugLogging?**: `boolean`
107
-
108
- Enable debug logging
109
- Default: false
110
- Recommended: Enable in development, disable in production
111
-
112
- ***
113
-
114
- ### enablePniKeys?
115
-
116
- > `optional` **enablePniKeys?**: `boolean`
117
-
118
- Enable PNI (Phone Number Identity) cryptographic key generation
119
-
120
- When `true`, generates and syncs both ACI and PNI identity keys, prekeys,
121
- and Kyber prekeys for applications that maintain both account identifiers.
122
-
123
- When `false` (default), only ACI keys are generated and synchronized. Use
124
- this for applications whose account model does not require PNI keys.
125
-
126
- The PNI UUID on the users table is unaffected — it can still exist for ZK
127
- group credentials without generating cryptographic keys.
128
-
129
- #### Default
130
-
131
- ```ts
132
- false
133
- ```
134
-
135
- ***
136
-
137
- ### groupsV2?
138
-
139
- > `optional` **groupsV2?**: `object`
140
-
141
- GroupsV2 configuration for Signal Private Group System.
142
- Required for group state management (create, sync, membership changes).
143
-
144
- #### aci
145
-
146
- > **aci**: [`ServiceId`](ServiceId.md)
147
-
148
- User's ACI for credential presentation.
149
-
150
- #### credentialPublicKey
151
-
152
- > **credentialPublicKey**: [`CredentialPublicKey`](CredentialPublicKey.md)
153
-
154
- Server's credential public key for verifying issuance proofs.
155
-
156
- #### endorsementManager?
157
-
158
- > `optional` **endorsementManager?**: [`EndorsementManager`](../classes/EndorsementManager.md)
159
-
160
- Pre-constructed EndorsementManager for group send endorsement-based auth.
161
-
162
- #### endorsementRootPublicKey?
163
-
164
- > `optional` **endorsementRootPublicKey?**: [`ServerRootPublicKey`](../classes/ServerRootPublicKey.md)
165
-
166
- Server's endorsement root public key for verifying group send endorsements.
167
-
168
- #### pni?
169
-
170
- > `optional` **pni?**: [`ServiceId`](ServiceId.md)
171
-
172
- User's PNI for credential presentation (optional — nil UUID used for non-phone apps).
173
-
174
- #### resolveAciBytesByUserIds?
175
-
176
- > `optional` **resolveAciBytesByUserIds?**: (`userIds`) => `Promise`\<`Map`\<`string`, `Uint8Array`\<`ArrayBufferLike`\>\>\>
177
-
178
- Resolve member ACIs without importing app content models into the client.
179
-
180
- ##### Parameters
181
-
182
- ###### userIds
183
-
184
- `string`[]
185
-
186
- ##### Returns
187
-
188
- `Promise`\<`Map`\<`string`, `Uint8Array`\<`ArrayBufferLike`\>\>\>
189
-
190
- #### server
191
-
192
- > **server**: [`IGroupServer`](IGroupServer.md)
193
-
194
- Server-side group operations.
195
-
196
- #### store
197
-
198
- > **store**: [`IGroupStateStore`](IGroupStateStore.md)
199
-
200
- Local group state storage (master keys, cached state).
201
-
202
- #### Example
203
-
204
- ```typescript
205
- const signal = await SignalProtocolClient.create(userId, {
206
- storage: customStorage,
207
- groupsV2: {
208
- store: new SQLiteGroupStateStore(db),
209
- server: new ConvexGroupServer(convex),
210
- }
211
- });
212
- ```
213
-
214
- ***
215
-
216
- ### hooks?
217
-
218
- > `optional` **hooks?**: [`SignalProtocolClientHooks`](SignalProtocolClientHooks.md)
219
-
220
- Event hooks for Signal Protocol lifecycle events
221
-
222
- Provides integration points for applications to react to:
223
- - Session establishment/deletion
224
- - Key rotation
225
- - Message encryption/decryption
226
- - Errors and cleanup operations
227
-
228
- All hooks are optional and support both sync and async implementations.
229
- Hook errors are caught internally and won't affect core functionality.
230
-
231
- Common use cases:
232
- - Cache invalidation (ContentManager, React Query)
233
- - Analytics and monitoring (Sentry, DataDog)
234
- - State management integration (Redux, Zustand)
235
- - User notifications
236
-
237
- #### Examples
238
-
239
- **Basic usage**
240
-
241
- ```typescript
242
- const signal = await SignalProtocolClient.create(userId, {
243
- storage: customStorage,
244
- hooks: {
245
- onSessionEstablished: (sessionId) => {
246
- ContentManager.invalidateSession(sessionId);
247
- },
248
- onKeyRotated: (keyType) => {
249
- analytics.track('Key Rotated', { keyType });
250
- }
251
- }
252
- });
253
- ```
254
-
255
- **Error tracking**
256
-
257
- ```typescript
258
- const signal = await SignalProtocolClient.create(userId, {
259
- storage: customStorage,
260
- hooks: {
261
- onDecryptionError: (sessionId, error) => {
262
- Sentry.captureException(error, {
263
- tags: { sessionId }
264
- });
265
- }
266
- }
267
- });
268
- ```
269
-
270
- ***
271
-
272
- ### keyRefreshIntervalMs?
273
-
274
- > `optional` **keyRefreshIntervalMs?**: `number`
275
-
276
- Key refresh interval in milliseconds.
277
-
278
- Controls how often signed prekeys and Kyber (last-resort) prekeys are rotated.
279
- Per PQXDH specification Section 3.2, both key types use the same rotation
280
- schedule for synchronized post-quantum security.
281
-
282
- #### Default
283
-
284
- ```ts
285
- 172800000 (2 days)
286
- ```
287
-
288
- #### Examples
289
-
290
- **Default rotation interval**
291
-
292
- ```typescript
293
- const signal = await SignalProtocolClient.create(userId, {
294
- storage: customStorage,
295
- keyRefreshIntervalMs: 2 * 24 * 60 * 60 * 1000 // 2 days
296
- });
297
- ```
298
-
299
- **Weekly rotation (lower bandwidth)**
300
-
301
- ```typescript
302
- const signal = await SignalProtocolClient.create(userId, {
303
- storage: customStorage,
304
- keyRefreshIntervalMs: 7 * 24 * 60 * 60 * 1000 // 7 days
305
- });
306
- ```
307
-
308
- #### See
309
-
310
- https://signal.org/docs/specifications/pqxdh/#publishing-keys
311
-
312
- ***
313
-
314
- ### logger?
315
-
316
- > `optional` **logger?**: [`ILogger`](ILogger.md)
317
-
318
- Custom logger implementation
319
-
320
- Default: Environment-aware console logging
321
- - Development: verbose (debug, info, warn, error, breadcrumb)
322
- - Production: minimal (warn, error only)
323
-
324
- #### Examples
325
-
326
- **Using custom logger**
327
-
328
- ```typescript
329
- const signal = await SignalProtocolClient.create(userId, {
330
- storage: customStorage,
331
- logger: {
332
- info: (msg, data) => myLogger.log('info', msg, data),
333
- error: (msg, err) => myLogger.log('error', msg, err),
334
- warn: (msg, data) => myLogger.log('warn', msg, data)
335
- }
336
- });
337
- ```
338
-
339
- **Using console directly**
340
-
341
- ```typescript
342
- const signal = await SignalProtocolClient.create(userId, {
343
- storage: customStorage,
344
- logger: console // Works directly!
345
- });
346
- ```
347
-
348
- **Using pino**
349
-
350
- ```typescript
351
- import pino from 'pino';
352
- const signal = await SignalProtocolClient.create(userId, {
353
- storage: customStorage,
354
- logger: pino({ level: 'info' })
355
- });
356
- ```
357
-
358
- **Silent mode**
359
-
360
- ```typescript
361
- const signal = await SignalProtocolClient.create(userId, {
362
- storage: customStorage,
363
- logger: {} // All methods optional
364
- });
365
- ```
366
-
367
- ***
368
-
369
- ### maxPreKeyAgeMs?
370
-
371
- > `optional` **maxPreKeyAgeMs?**: `number`
372
-
373
- Maximum allowed prekey age in milliseconds.
374
-
375
- If prekeys exceed this age, message sending should be blocked to force
376
- key rotation. Provides a safety buffer above keyRefreshIntervalMs.
377
-
378
- With the default two-day refresh interval, the default maximum age leaves
379
- a twelve-day recovery window.
380
-
381
- #### Default
382
-
383
- ```ts
384
- 1209600000 (14 days)
385
- ```
386
-
387
- #### Example
388
-
389
- **Default maximum age**
390
-
391
- ```typescript
392
- const signal = await SignalProtocolClient.create(userId, {
393
- storage: customStorage,
394
- maxPreKeyAgeMs: 14 * 24 * 60 * 60 * 1000 // 14 days
395
- });
396
- ```
397
-
398
- #### See
399
-
400
- https://signal.org/docs/specifications/pqxdh/#publishing-keys
401
-
402
- ***
403
-
404
- ### media?
405
-
406
- > `optional` **media?**: [`SignalProtocolClientMediaConfig`](SignalProtocolClientMediaConfig.md)
407
-
408
- App-owned media lifecycle callbacks for the SignalProtocolClient media queue.
409
-
410
- The queue itself is persisted through the existing Signal local storage
411
- adapter. These callbacks keep local bytes, plaintext caches, and product
412
- state in the app layer where they can share file permissions, UI state, and
413
- app database ownership.
414
-
415
- #### Example
416
-
417
- ```typescript
418
- const signal = await createSignalProtocolClient({
419
- identity: { userId },
420
- adapters: { storage, relay, remoteObjectStore },
421
- media: {
422
- loadLocalAttachment: async ({ localMediaId }) => appDrafts.readBytes(localMediaId),
423
- saveUploadedAttachment: async ({ localMediaId, attachment }) =>
424
- appPointers.save(localMediaId, attachment),
425
- saveDownloadedAttachment: async ({ attachmentId, downloaded }) =>
426
- appMediaCache.save(attachmentId, downloaded.data),
427
- deleteLocalAttachment: async ({ attachmentId }) => appMediaCache.delete(attachmentId),
428
- },
429
- });
430
- ```
431
-
432
- ***
433
-
434
- ### onGroupSenderKeyRotated?
435
-
436
- > `optional` **onGroupSenderKeyRotated?**: (`groupId`, `newGeneration`) => `void`
437
-
438
- Called when a group sender key is rotated.
439
-
440
- Useful for logging, analytics, or triggering UI updates when
441
- sender keys are rotated due to membership changes.
442
-
443
- #### Parameters
444
-
445
- ##### groupId
446
-
447
- `string`
448
-
449
- The group whose sender key was rotated
450
-
451
- ##### newGeneration
452
-
453
- `number`
454
-
455
- The new generation number of the sender key
456
-
457
- #### Returns
458
-
459
- `void`
460
-
461
- #### Example
462
-
463
- ```typescript
464
- const signal = await SignalProtocolClient.create(userId, {
465
- storage: customStorage,
466
- onGroupSenderKeyRotated: (groupId, newGeneration) => {
467
- console.log(`Group ${groupId} sender key rotated to gen ${newGeneration}`);
468
- analytics.track('sender_key_rotated', { groupId, newGeneration });
469
- }
470
- });
471
- ```
472
-
473
- ***
474
-
475
- ### onPreKeyLow?
476
-
477
- > `optional` **onPreKeyLow?**: (`remaining`) => `void`
478
-
479
- Callback when one-time prekeys are running low
480
-
481
- Called when prekey count drops below the threshold (default: 50).
482
- Use this to trigger prekey replenishment to prevent session
483
- establishment failures.
484
-
485
- #### Parameters
486
-
487
- ##### remaining
488
-
489
- `number`
490
-
491
- #### Returns
492
-
493
- `void`
494
-
495
- #### Example
496
-
497
- ```typescript
498
- const signal = await SignalProtocolClient.create(userId, {
499
- storage: customStorage,
500
- onPreKeyLow: (remaining) => {
501
- console.warn(`Only ${remaining} prekeys remaining, replenishment needed`);
502
- // Trigger server-side prekey generation
503
- backend.replenishPrekeys(userId);
504
- }
505
- });
506
- ```
507
-
508
- ***
509
-
510
- ### onProgress?
511
-
512
- > `optional` **onProgress?**: [`ProgressCallback`](../type-aliases/ProgressCallback.md)
513
-
514
- Progress callback for initialization and relay sync operations.
515
-
516
- Receives updates during:
517
- - Key generation
518
- - Prekey bundle generation
519
- - Relay upload
520
-
521
- #### Example
522
-
523
- ```typescript
524
- const signal = await createSignalProtocolClient({
525
- identity: { userId },
526
- adapters: { storage, relay },
527
- onProgress: ({ stage, percent, message }) => {
528
- console.log(`${stage}: ${percent}% - ${message}`);
529
- }
530
- });
531
- ```
532
-
533
- ***
534
-
535
- ### preKeyCheckThrottleMs?
536
-
537
- > `optional` **preKeyCheckThrottleMs?**: `number`
538
-
539
- Prekey check throttle interval in milliseconds.
540
-
541
- Controls how often prekey count checks are performed on app activation.
542
- Prevents unnecessary server queries when the app is repeatedly foregrounded.
543
-
544
- #### Default
545
-
546
- ```ts
547
- 43200000 (12 hours)
548
- ```
549
-
550
- #### See
551
-
552
- https://signal.org/docs/specifications/pqxdh/#publishing-keys
553
-
554
- ***
555
-
556
- ### preKeyLowThreshold?
557
-
558
- > `optional` **preKeyLowThreshold?**: `number`
559
-
560
- Threshold for prekey low warning
561
- Default: 50 (warn when fewer than 50 one-time prekeys remain)
562
-
563
- ***
564
-
565
- ### preKeyMaintenance?
566
-
567
- > `optional` **preKeyMaintenance?**: [`PreKeyMaintenanceStore`](PreKeyMaintenanceStore.md)
568
-
569
- App-provided prekey bookkeeping store.
570
-
571
- Needed for SQLite-backed adapters that track replaced prekeys separately
572
- from the protocol-facing local store interface.
573
-
574
- ***
575
-
576
- ### protocol?
577
-
578
- > `optional` **protocol?**: [`SignalProtocolConfig`](SignalProtocolConfig.md)
579
-
580
- Developer-facing protocol policy.
581
-
582
- The default is strict post-quantum behavior with the specification-defined
583
- ML-KEM Braid SPQR mode. Use `compatible` only when the product deliberately
584
- supports genuinely non-PQ peers. Use `braid: 'disabled'` only when a
585
- product-reviewed constraint requires the local direct SPQR mode.
586
-
587
- #### Default
588
-
589
- ```ts
590
- { postQuantum: 'required', braid: 'required' }
591
- ```
592
-
593
- #### Examples
594
-
595
- **Strict post-quantum mode**
596
-
597
- ```typescript
598
- const signal = await SignalProtocolClient.create(userId, {
599
- storage: customStorage,
600
- protocol: {
601
- postQuantum: 'required',
602
- braid: 'required'
603
- }
604
- });
605
- ```
606
-
607
- **Compatibility with non-PQ peers**
608
-
609
- ```typescript
610
- const signal = await SignalProtocolClient.create(userId, {
611
- storage: customStorage,
612
- protocol: {
613
- postQuantum: 'compatible',
614
- braid: 'required'
615
- }
616
- });
617
- ```
618
-
619
- **Explicit direct SPQR mode**
620
-
621
- ```typescript
622
- const signal = await SignalProtocolClient.create(userId, {
623
- storage: customStorage,
624
- protocol: {
625
- postQuantum: 'required',
626
- braid: 'disabled'
627
- }
628
- });
629
- ```
630
-
631
- ***
632
-
633
- ### protocolManager?
634
-
635
- > `optional` **protocolManager?**: [`ISignalProtocolManager`](ISignalProtocolManager.md)
636
-
637
- Signal Protocol Manager implementation (for advanced use cases)
638
- Default: Creates new SignalProtocolManager instance
639
-
640
- ***
641
-
642
- ### protocolStrategy?
643
-
644
- > `optional` **protocolStrategy?**: [`ProtocolStrategyConfig`](ProtocolStrategyConfig.md)
645
-
646
- Advanced protocol strategy configuration.
647
-
648
- Most application code should use `protocol.postQuantum` instead. This seam
649
- exists for diagnostics, telemetry callbacks, and advanced tuning.
650
-
651
- #### Example
652
-
653
- **Track protocol usage**
654
-
655
- ```typescript
656
- const signal = await SignalProtocolClient.create(userId, {
657
- storage: customStorage,
658
- protocolStrategy: {
659
- onProtocolSelected: (event) => {
660
- analytics.track('Protocol Selected', {
661
- pq: event.usedPQXDH,
662
- tripleRatchet: event.usedTripleRatchet,
663
- compatibilityFallback: event.usedClassicalFallback,
664
- fallbackReason: event.classicalFallbackReason
665
- });
666
- }
667
- }
668
- });
669
- ```
670
-
671
- ***
672
-
673
- ### ratchetConfig?
674
-
675
- > `optional` **ratchetConfig?**: [`DoubleRatchetConfig`](DoubleRatchetConfig.md)
676
-
677
- Double Ratchet algorithm configuration
678
-
679
- ***
680
-
681
- ### relay?
682
-
683
- > `optional` **relay?**: [`ISignalRelayServer`](ISignalRelayServer.md)
684
-
685
- Relay adapter for server synchronization.
686
-
687
- If provided, the client will automatically:
688
- 1. Generate prekey bundle
689
- 2. Upload public keys to the relay server
690
- 3. Provide progress updates via onProgress callback
691
-
692
- If omitted, client operates in local-only mode.
693
-
694
- #### Example
695
-
696
- ```typescript
697
- import { createSignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
698
- import {
699
- convexRelay,
700
- type ConvexSignalRelayApi,
701
- } from '@open-e2ee/signal-protocol-sdk/remote/relay/convex';
702
- import { api } from '../convex/_generated/api';
703
-
704
- const signalApi = api.signal satisfies ConvexSignalRelayApi;
705
- const relay = convexRelay({ convex, api: signalApi, currentUserId: userId });
706
-
707
- const signal = await createSignalProtocolClient({
708
- identity: { userId },
709
- adapters: { storage, relay },
710
- });
711
- ```
712
-
713
- ***
714
-
715
- ### remoteObjectStore?
716
-
717
- > `optional` **remoteObjectStore?**: [`SignalRemoteObjectStore`](SignalRemoteObjectStore.md)
718
-
719
- Remote object storage adapter for encrypted file uploads (two-layer encryption)
720
-
721
- If provided, enables encrypted file upload (two-layer encryption):
722
- 1. Generate AES-256-GCM key
723
- 2. Encrypt file bytes with AES
724
- 3. Upload encrypted bytes to object storage
725
- 4. Send storage ID + key via Signal Protocol
726
-
727
- If omitted, file upload operations will throw an error.
728
-
729
- #### Example
730
-
731
- ```typescript
732
- import { createSignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
733
- import { convexR2ObjectStore } from '@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2';
734
- import { api } from '../convex/_generated/api';
735
-
736
- const remoteObjectStore = convexR2ObjectStore({
737
- convex,
738
- api: api.signalObjectStore,
739
- });
740
-
741
- const signal = await createSignalProtocolClient({
742
- identity: { userId },
743
- adapters: { storage, relay, remoteObjectStore },
744
- });
745
-
746
- // Send file bytes
747
- const fileBytes = new Uint8Array(await file.arrayBuffer());
748
- await signal.send('bob', fileBytes, { mimeType: 'image/jpeg' });
749
- ```
750
-
751
- ***
752
-
753
- ### sealedSender?
754
-
755
- > `optional` **sealedSender?**: [`SealedSenderConfig`](SealedSenderConfig.md)
756
-
757
- Sealed Sender configuration for anonymous message delivery.
758
-
759
- When configured, messages are wrapped with sealed sender encryption
760
- that hides the sender's identity from the server. The recipient can
761
- still verify the sender via the embedded certificate.
762
-
763
- Requires:
764
- - Server-side SEALED_SENDER_SIGNING_KEY environment variable
765
- - Trust root public key distributed to clients
766
-
767
- #### See
768
-
769
- https://signal.org/blog/sealed-sender/
770
-
771
- #### Example
772
-
773
- ```typescript
774
- const signal = await SignalProtocolClient.create(userId, {
775
- storage: customStorage,
776
- sealedSender: {
777
- trustRoots: [trustRootPublicKeyBytes],
778
- certificateProvider: async () => {
779
- return await convex.mutation(api.signal.certificates.issueSenderCertificate, { deviceId: 1 });
780
- },
781
- accessMode: 'unrestricted',
782
- }
783
- });
784
- ```
785
-
786
- ***
787
-
788
- ### senderKeys?
789
-
790
- > `optional` **senderKeys?**: [`SenderKeysConfig`](SenderKeysConfig.md)
791
-
792
- Sender Keys (group messaging) configuration.
793
-
794
- Controls HKDF info strings, DoS protection limits, and out-of-order
795
- message handling for group encryption.
796
-
797
- #### Examples
798
-
799
- **Custom protocol branding**
800
-
801
- ```typescript
802
- const signal = await SignalProtocolClient.create(userId, {
803
- storage: customStorage,
804
- senderKeys: {
805
- hkdfInfoString: 'MyApp Group V1'
806
- }
807
- });
808
- ```
809
-
810
- **Production-recommended limits (these are the defaults)**
811
-
812
- ```typescript
813
- const signal = await SignalProtocolClient.create(userId, {
814
- storage: customStorage,
815
- senderKeys: {
816
- maxChainAdvance: 2000, // DoS protection
817
- maxSkippedKeys: 2000 // Memory limit
818
- }
819
- });
820
- ```
821
-
822
- ***
823
-
824
- ### storage
825
-
826
- > **storage**: [`ISignalLocalStore`](ISignalLocalStore.md)
827
-
828
- Local store implementation for the current runtime.
829
- Required by SignalProtocolClient.create().
830
-
831
- ***
832
-
833
- ### throwDetailedErrors?
834
-
835
- > `optional` **throwDetailedErrors?**: `boolean`
836
-
837
- Throw detailed errors instead of generic messages
838
- Default: false (generic error messages for security)
839
- Recommended: Enable in development for debugging