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

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 (730) hide show
  1. package/ADAPTERS.md +1 -1
  2. package/ARCHITECTURE.md +1 -1
  3. package/CHANGELOG.md +876 -3
  4. package/COMMERCIAL.md +56 -0
  5. package/README.md +13 -8
  6. package/SECURITY.md +15 -1
  7. package/client/README.md +1 -1
  8. package/dist/client/client.d.ts +32 -28
  9. package/dist/client/client.d.ts.map +1 -1
  10. package/dist/client/client.js +136 -80
  11. package/dist/client/client.js.map +1 -1
  12. package/dist/client/compose.d.ts +6 -1
  13. package/dist/client/compose.d.ts.map +1 -1
  14. package/dist/client/compose.js +2 -0
  15. package/dist/client/compose.js.map +1 -1
  16. package/dist/client/config.d.ts +53 -19
  17. package/dist/client/config.d.ts.map +1 -1
  18. package/dist/client/config.js.map +1 -1
  19. package/dist/client/endorsement-manager.d.ts +23 -2
  20. package/dist/client/endorsement-manager.d.ts.map +1 -1
  21. package/dist/client/endorsement-manager.js +35 -10
  22. package/dist/client/endorsement-manager.js.map +1 -1
  23. package/dist/client/groups.d.ts +29 -29
  24. package/dist/client/groups.d.ts.map +1 -1
  25. package/dist/client/groups.js +54 -37
  26. package/dist/client/groups.js.map +1 -1
  27. package/dist/client/headless.d.ts +1 -1
  28. package/dist/client/headless.js +1 -1
  29. package/dist/client/sealed-sender-ops.d.ts +27 -1
  30. package/dist/client/sealed-sender-ops.d.ts.map +1 -1
  31. package/dist/client/sealed-sender-ops.js +36 -6
  32. package/dist/client/sealed-sender-ops.js.map +1 -1
  33. package/dist/client/signal-service-cipher.d.ts +21 -2
  34. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  35. package/dist/client/signal-service-cipher.js +119 -53
  36. package/dist/client/signal-service-cipher.js.map +1 -1
  37. package/dist/client/types.d.ts +20 -7
  38. package/dist/client/types.d.ts.map +1 -1
  39. package/dist/client/types.js.map +1 -1
  40. package/dist/groups/index.d.ts +4 -4
  41. package/dist/groups/index.d.ts.map +1 -1
  42. package/dist/groups/index.js +3 -3
  43. package/dist/groups/index.js.map +1 -1
  44. package/dist/index.d.ts +12 -5
  45. package/dist/index.d.ts.map +1 -1
  46. package/dist/index.js +10 -3
  47. package/dist/index.js.map +1 -1
  48. package/dist/internal/crypto/index.d.ts +1 -1
  49. package/dist/internal/crypto/index.d.ts.map +1 -1
  50. package/dist/internal/crypto/index.js +1 -1
  51. package/dist/internal/crypto/index.js.map +1 -1
  52. package/dist/internal/crypto/random.d.ts +9 -0
  53. package/dist/internal/crypto/random.d.ts.map +1 -1
  54. package/dist/internal/crypto/random.js +16 -0
  55. package/dist/internal/crypto/random.js.map +1 -1
  56. package/dist/internal/groups/access-control.d.ts +170 -0
  57. package/dist/internal/groups/access-control.d.ts.map +1 -0
  58. package/dist/internal/groups/access-control.js +284 -0
  59. package/dist/internal/groups/access-control.js.map +1 -0
  60. package/dist/internal/groups/change-actions.d.ts +57 -0
  61. package/dist/internal/groups/change-actions.d.ts.map +1 -0
  62. package/dist/internal/groups/change-actions.js +827 -0
  63. package/dist/internal/groups/change-actions.js.map +1 -0
  64. package/dist/internal/groups/change-authorization.d.ts +16 -0
  65. package/dist/internal/groups/change-authorization.d.ts.map +1 -0
  66. package/dist/internal/groups/change-authorization.js +120 -0
  67. package/dist/internal/groups/change-authorization.js.map +1 -0
  68. package/dist/internal/{groups-v2 → groups}/encrypted-state.d.ts +12 -2
  69. package/dist/internal/groups/encrypted-state.d.ts.map +1 -0
  70. package/dist/internal/{groups-v2 → groups}/encrypted-state.js +122 -22
  71. package/dist/internal/groups/encrypted-state.js.map +1 -0
  72. package/dist/internal/groups/group-id.d.ts +9 -9
  73. package/dist/internal/groups/group-id.d.ts.map +1 -1
  74. package/dist/internal/groups/group-id.js +11 -12
  75. package/dist/internal/groups/group-id.js.map +1 -1
  76. package/dist/internal/groups/index.d.ts +16 -6
  77. package/dist/internal/groups/index.d.ts.map +1 -1
  78. package/dist/internal/groups/index.js +9 -1
  79. package/dist/internal/groups/index.js.map +1 -1
  80. package/dist/internal/groups/invite-link.d.ts.map +1 -0
  81. package/dist/internal/groups/invite-link.js.map +1 -0
  82. package/dist/internal/{groups-v2 → groups}/manager.d.ts +188 -40
  83. package/dist/internal/groups/manager.d.ts.map +1 -0
  84. package/dist/internal/groups/manager.js +1923 -0
  85. package/dist/internal/groups/manager.js.map +1 -0
  86. package/dist/internal/groups/sdk-store.d.ts +32 -0
  87. package/dist/internal/groups/sdk-store.d.ts.map +1 -0
  88. package/dist/internal/groups/sdk-store.js +111 -0
  89. package/dist/internal/groups/sdk-store.js.map +1 -0
  90. package/dist/internal/groups/server-engine.d.ts +83 -0
  91. package/dist/internal/groups/server-engine.d.ts.map +1 -0
  92. package/dist/internal/groups/server-engine.js +1186 -0
  93. package/dist/internal/groups/server-engine.js.map +1 -0
  94. package/dist/internal/groups/trust-root.d.ts +32 -0
  95. package/dist/internal/groups/trust-root.d.ts.map +1 -0
  96. package/dist/internal/groups/trust-root.js +91 -0
  97. package/dist/internal/groups/trust-root.js.map +1 -0
  98. package/dist/internal/{groups-v2 → groups}/types.d.ts +188 -46
  99. package/dist/internal/groups/types.d.ts.map +1 -0
  100. package/dist/internal/{groups-v2 → groups}/types.js +3 -2
  101. package/dist/internal/groups/types.js.map +1 -0
  102. package/dist/internal/groups/wire.d.ts +68 -0
  103. package/dist/internal/groups/wire.d.ts.map +1 -0
  104. package/dist/internal/groups/wire.js +708 -0
  105. package/dist/internal/groups/wire.js.map +1 -0
  106. package/dist/internal/protocol/sealed-sender/decryption-v2.d.ts.map +1 -1
  107. package/dist/internal/protocol/sealed-sender/decryption-v2.js +32 -18
  108. package/dist/internal/protocol/sealed-sender/decryption-v2.js.map +1 -1
  109. package/dist/internal/protocol/sealed-sender/decryption.d.ts.map +1 -1
  110. package/dist/internal/protocol/sealed-sender/decryption.js +33 -19
  111. package/dist/internal/protocol/sealed-sender/decryption.js.map +1 -1
  112. package/dist/internal/protocol/sealed-sender/encryption-v2.d.ts.map +1 -1
  113. package/dist/internal/protocol/sealed-sender/encryption-v2.js +8 -14
  114. package/dist/internal/protocol/sealed-sender/encryption-v2.js.map +1 -1
  115. package/dist/internal/protocol/sealed-sender/encryption.d.ts +9 -4
  116. package/dist/internal/protocol/sealed-sender/encryption.d.ts.map +1 -1
  117. package/dist/internal/protocol/sealed-sender/encryption.js +7 -15
  118. package/dist/internal/protocol/sealed-sender/encryption.js.map +1 -1
  119. package/dist/internal/protocol/sealed-sender/proto/index.d.ts +6 -7
  120. package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
  121. package/dist/internal/protocol/sealed-sender/proto/index.js +5 -7
  122. package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
  123. package/dist/internal/protocol/sealed-sender/trust-root.d.ts +45 -0
  124. package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +1 -0
  125. package/dist/internal/protocol/sealed-sender/trust-root.js +77 -0
  126. package/dist/internal/protocol/sealed-sender/trust-root.js.map +1 -0
  127. package/dist/internal/protocol/sealed-sender/types.d.ts +64 -9
  128. package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
  129. package/dist/internal/protocol/sealed-sender/types.js +43 -0
  130. package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
  131. package/dist/internal/protocol/sender-keys/index.d.ts +1 -1
  132. package/dist/internal/protocol/sender-keys/manager.d.ts +38 -1
  133. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  134. package/dist/internal/protocol/sender-keys/manager.js +109 -8
  135. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  136. package/dist/internal/protocol/zk/groups/auth-credential.d.ts +9 -7
  137. package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
  138. package/dist/internal/protocol/zk/groups/auth-credential.js +68 -29
  139. package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
  140. package/dist/internal/protocol/zk/groups/server-params.d.ts +1 -1
  141. package/dist/internal/protocol/zk/groups/server-params.d.ts.map +1 -1
  142. package/dist/internal/protocol/zk/groups/server-params.js.map +1 -1
  143. package/dist/internal/protocol/zk/groups/uid-struct.d.ts +2 -0
  144. package/dist/internal/protocol/zk/groups/uid-struct.d.ts.map +1 -1
  145. package/dist/internal/protocol/zk/groups/uid-struct.js +4 -0
  146. package/dist/internal/protocol/zk/groups/uid-struct.js.map +1 -1
  147. package/dist/layers.d.ts +1 -1
  148. package/dist/layers.js +3 -3
  149. package/dist/layers.js.map +1 -1
  150. package/dist/local/store/expo/adapter.d.ts +14 -15
  151. package/dist/local/store/expo/adapter.d.ts.map +1 -1
  152. package/dist/local/store/expo/adapter.js +109 -102
  153. package/dist/local/store/expo/adapter.js.map +1 -1
  154. package/dist/local/store/expo/db.d.ts +4 -1
  155. package/dist/local/store/expo/db.d.ts.map +1 -1
  156. package/dist/local/store/expo/db.js +5 -0
  157. package/dist/local/store/expo/db.js.map +1 -1
  158. package/dist/local/store/expo/index.d.ts +0 -2
  159. package/dist/local/store/expo/index.d.ts.map +1 -1
  160. package/dist/local/store/expo/index.js +1 -1
  161. package/dist/local/store/expo/index.js.map +1 -1
  162. package/dist/local/store/expo/models/index.d.ts +1 -1
  163. package/dist/local/store/expo/models/index.d.ts.map +1 -1
  164. package/dist/local/store/expo/models/index.js +2 -2
  165. package/dist/local/store/expo/models/index.js.map +1 -1
  166. package/dist/local/store/expo/models/sender-key.d.ts +101 -77
  167. package/dist/local/store/expo/models/sender-key.d.ts.map +1 -1
  168. package/dist/local/store/expo/models/sender-key.js +154 -124
  169. package/dist/local/store/expo/models/sender-key.js.map +1 -1
  170. package/dist/local/store/expo/schema.d.ts +134 -32
  171. package/dist/local/store/expo/schema.d.ts.map +1 -1
  172. package/dist/local/store/expo/schema.js +36 -7
  173. package/dist/local/store/expo/schema.js.map +1 -1
  174. package/dist/local/store/mock/adapter.d.ts +1 -0
  175. package/dist/local/store/mock/adapter.d.ts.map +1 -1
  176. package/dist/local/store/mock/adapter.js +18 -0
  177. package/dist/local/store/mock/adapter.js.map +1 -1
  178. package/dist/local/store/react-native/adapter.d.ts +39 -0
  179. package/dist/local/store/react-native/adapter.d.ts.map +1 -1
  180. package/dist/local/store/react-native/adapter.js +163 -8
  181. package/dist/local/store/react-native/adapter.js.map +1 -1
  182. package/dist/local/store/web/adapter.d.ts +1 -0
  183. package/dist/local/store/web/adapter.d.ts.map +1 -1
  184. package/dist/local/store/web/adapter.js +33 -1
  185. package/dist/local/store/web/adapter.js.map +1 -1
  186. package/dist/remote/relay/convex/backend.d.ts +402 -0
  187. package/dist/remote/relay/convex/backend.d.ts.map +1 -0
  188. package/dist/remote/relay/convex/backend.js +684 -0
  189. package/dist/remote/relay/convex/backend.js.map +1 -0
  190. package/dist/remote/relay/convex/component/_generated/api.d.ts +58 -0
  191. package/dist/remote/relay/convex/component/_generated/api.d.ts.map +1 -0
  192. package/dist/remote/relay/convex/component/_generated/api.js +31 -0
  193. package/dist/remote/relay/convex/component/_generated/api.js.map +1 -0
  194. package/dist/remote/relay/convex/component/_generated/component.d.ts +480 -0
  195. package/dist/remote/relay/convex/component/_generated/component.d.ts.map +1 -0
  196. package/dist/remote/relay/convex/component/_generated/component.js +11 -0
  197. package/dist/remote/relay/convex/component/_generated/component.js.map +1 -0
  198. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts +46 -0
  199. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts.map +1 -0
  200. package/dist/remote/relay/convex/component/_generated/dataModel.js +11 -0
  201. package/dist/remote/relay/convex/component/_generated/dataModel.js.map +1 -0
  202. package/dist/remote/relay/convex/component/_generated/server.d.ts +129 -0
  203. package/dist/remote/relay/convex/component/_generated/server.d.ts.map +1 -0
  204. package/dist/remote/relay/convex/component/_generated/server.js +79 -0
  205. package/dist/remote/relay/convex/component/_generated/server.js.map +1 -0
  206. package/dist/remote/relay/convex/component/accounts.d.ts +43 -0
  207. package/dist/remote/relay/convex/component/accounts.d.ts.map +1 -0
  208. package/dist/remote/relay/convex/component/accounts.js +181 -0
  209. package/dist/remote/relay/convex/component/accounts.js.map +1 -0
  210. package/dist/remote/relay/convex/component/certificates.d.ts +10 -0
  211. package/dist/remote/relay/convex/component/certificates.d.ts.map +1 -0
  212. package/dist/remote/relay/convex/component/certificates.js +122 -0
  213. package/dist/remote/relay/convex/component/certificates.js.map +1 -0
  214. package/dist/remote/relay/convex/component/cleanup.d.ts +26 -0
  215. package/dist/remote/relay/convex/component/cleanup.d.ts.map +1 -0
  216. package/dist/remote/relay/convex/component/cleanup.js +127 -0
  217. package/dist/remote/relay/convex/component/cleanup.js.map +1 -0
  218. package/dist/remote/relay/convex/component/convex.config.d.ts +5 -0
  219. package/dist/remote/relay/convex/component/convex.config.d.ts.map +1 -0
  220. package/dist/remote/relay/convex/component/convex.config.js +33 -0
  221. package/dist/remote/relay/convex/component/convex.config.js.map +1 -0
  222. package/dist/remote/relay/convex/component/crons.d.ts +3 -0
  223. package/dist/remote/relay/convex/component/crons.d.ts.map +1 -0
  224. package/dist/remote/relay/convex/component/crons.js +9 -0
  225. package/dist/remote/relay/convex/component/crons.js.map +1 -0
  226. package/dist/remote/relay/convex/component/devices.d.ts +101 -0
  227. package/dist/remote/relay/convex/component/devices.d.ts.map +1 -0
  228. package/dist/remote/relay/convex/component/devices.js +299 -0
  229. package/dist/remote/relay/convex/component/devices.js.map +1 -0
  230. package/dist/remote/relay/convex/component/errors.d.ts +22 -0
  231. package/dist/remote/relay/convex/component/errors.d.ts.map +1 -0
  232. package/dist/remote/relay/convex/component/errors.js +17 -0
  233. package/dist/remote/relay/convex/component/errors.js.map +1 -0
  234. package/dist/remote/relay/convex/component/groups.d.ts +60 -0
  235. package/dist/remote/relay/convex/component/groups.d.ts.map +1 -0
  236. package/dist/remote/relay/convex/component/groups.js +331 -0
  237. package/dist/remote/relay/convex/component/groups.js.map +1 -0
  238. package/dist/remote/relay/convex/component/keys.d.ts +130 -0
  239. package/dist/remote/relay/convex/component/keys.d.ts.map +1 -0
  240. package/dist/remote/relay/convex/component/keys.js +578 -0
  241. package/dist/remote/relay/convex/component/keys.js.map +1 -0
  242. package/dist/remote/relay/convex/component/messages.d.ts +119 -0
  243. package/dist/remote/relay/convex/component/messages.d.ts.map +1 -0
  244. package/dist/remote/relay/convex/component/messages.js +649 -0
  245. package/dist/remote/relay/convex/component/messages.js.map +1 -0
  246. package/dist/remote/relay/convex/component/provisioning.d.ts +92 -0
  247. package/dist/remote/relay/convex/component/provisioning.d.ts.map +1 -0
  248. package/dist/remote/relay/convex/component/provisioning.js +359 -0
  249. package/dist/remote/relay/convex/component/provisioning.js.map +1 -0
  250. package/dist/remote/relay/convex/component/runtime.d.ts +18 -0
  251. package/dist/remote/relay/convex/component/runtime.d.ts.map +1 -0
  252. package/dist/remote/relay/convex/component/runtime.js +142 -0
  253. package/dist/remote/relay/convex/component/runtime.js.map +1 -0
  254. package/dist/remote/relay/convex/component/schema.d.ts +344 -0
  255. package/dist/remote/relay/convex/component/schema.d.ts.map +1 -0
  256. package/dist/remote/relay/convex/component/schema.js +266 -0
  257. package/dist/remote/relay/convex/component/schema.js.map +1 -0
  258. package/dist/remote/relay/convex/component/zkAuth.d.ts +12 -0
  259. package/dist/remote/relay/convex/component/zkAuth.d.ts.map +1 -0
  260. package/dist/remote/relay/convex/component/zkAuth.js +71 -0
  261. package/dist/remote/relay/convex/component/zkAuth.js.map +1 -0
  262. package/dist/remote/relay/convex/constants.d.ts +3 -0
  263. package/dist/remote/relay/convex/constants.d.ts.map +1 -0
  264. package/dist/remote/relay/convex/constants.js +3 -0
  265. package/dist/remote/relay/convex/constants.js.map +1 -0
  266. package/dist/remote/relay/convex/group-server.d.ts +25 -21
  267. package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
  268. package/dist/remote/relay/convex/group-server.js +51 -21
  269. package/dist/remote/relay/convex/group-server.js.map +1 -1
  270. package/dist/remote/relay/convex/index.d.ts +4 -1
  271. package/dist/remote/relay/convex/index.d.ts.map +1 -1
  272. package/dist/remote/relay/convex/index.js +3 -1
  273. package/dist/remote/relay/convex/index.js.map +1 -1
  274. package/dist/remote/relay/convex/relay.d.ts +54 -67
  275. package/dist/remote/relay/convex/relay.d.ts.map +1 -1
  276. package/dist/remote/relay/convex/relay.js +123 -42
  277. package/dist/remote/relay/convex/relay.js.map +1 -1
  278. package/dist/remote/relay/convex/types.d.ts +16 -103
  279. package/dist/remote/relay/convex/types.d.ts.map +1 -1
  280. package/dist/remote/relay/convex/types.js +8 -13
  281. package/dist/remote/relay/convex/types.js.map +1 -1
  282. package/dist/remote/relay/index.d.ts +1 -1
  283. package/dist/remote/relay/index.d.ts.map +1 -1
  284. package/dist/remote/relay/mock/adapter.d.ts +33 -20
  285. package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
  286. package/dist/remote/relay/mock/adapter.js +98 -81
  287. package/dist/remote/relay/mock/adapter.js.map +1 -1
  288. package/dist/remote/relay/mock/group-server.d.ts +9 -0
  289. package/dist/remote/relay/mock/group-server.d.ts.map +1 -0
  290. package/dist/remote/relay/mock/group-server.js +9 -0
  291. package/dist/remote/relay/mock/group-server.js.map +1 -0
  292. package/dist/remote/relay/types.d.ts +73 -79
  293. package/dist/remote/relay/types.d.ts.map +1 -1
  294. package/dist/remote/relay/types.js +0 -1
  295. package/dist/remote/relay/types.js.map +1 -1
  296. package/dist/types/api.d.ts +23 -2
  297. package/dist/types/api.d.ts.map +1 -1
  298. package/dist/types/protocol-config.d.ts +51 -0
  299. package/dist/types/protocol-config.d.ts.map +1 -1
  300. package/dist/types/protocol-config.js +46 -0
  301. package/dist/types/protocol-config.js.map +1 -1
  302. package/docs/ASSURANCE.md +10 -6
  303. package/docs/CLIENT_COMPOSITION.md +23 -69
  304. package/docs/DEVIATIONS.md +77 -41
  305. package/docs/E2EE.md +71 -6
  306. package/docs/GETTING_STARTED.md +1 -1
  307. package/docs/PACKAGE_SURFACE.md +6 -0
  308. package/docs/RECIPES.md +1 -1
  309. package/docs/SECURITY.md +8 -0
  310. package/groups/README.md +16 -5
  311. package/local/store/expo/README.md +10 -1
  312. package/local/store/node/README.md +10 -1
  313. package/package.json +20 -4
  314. package/remote/relay/convex/README.md +6 -0
  315. package/remote/relay/convex/component/README.md +428 -0
  316. package/scripts/oe-groups.mjs +162 -0
  317. package/dist/internal/groups-v2/access-control.d.ts +0 -108
  318. package/dist/internal/groups-v2/access-control.d.ts.map +0 -1
  319. package/dist/internal/groups-v2/access-control.js +0 -191
  320. package/dist/internal/groups-v2/access-control.js.map +0 -1
  321. package/dist/internal/groups-v2/change-actions.d.ts +0 -40
  322. package/dist/internal/groups-v2/change-actions.d.ts.map +0 -1
  323. package/dist/internal/groups-v2/change-actions.js +0 -363
  324. package/dist/internal/groups-v2/change-actions.js.map +0 -1
  325. package/dist/internal/groups-v2/encrypted-state.d.ts.map +0 -1
  326. package/dist/internal/groups-v2/encrypted-state.js.map +0 -1
  327. package/dist/internal/groups-v2/index.d.ts +0 -19
  328. package/dist/internal/groups-v2/index.d.ts.map +0 -1
  329. package/dist/internal/groups-v2/index.js +0 -11
  330. package/dist/internal/groups-v2/index.js.map +0 -1
  331. package/dist/internal/groups-v2/invite-link.d.ts.map +0 -1
  332. package/dist/internal/groups-v2/invite-link.js.map +0 -1
  333. package/dist/internal/groups-v2/manager.d.ts.map +0 -1
  334. package/dist/internal/groups-v2/manager.js +0 -1095
  335. package/dist/internal/groups-v2/manager.js.map +0 -1
  336. package/dist/internal/groups-v2/types.d.ts.map +0 -1
  337. package/dist/internal/groups-v2/types.js.map +0 -1
  338. package/docs/api/README.md +0 -471
  339. package/docs/api/classes/EncryptionError.md +0 -112
  340. package/docs/api/classes/EndorsementManager.md +0 -307
  341. package/docs/api/classes/SealedSenderAuthError.md +0 -127
  342. package/docs/api/classes/ServerDerivedKeyPair.md +0 -68
  343. package/docs/api/classes/ServerDerivedPublicKey.md +0 -33
  344. package/docs/api/classes/ServerRootKeyPair.md +0 -94
  345. package/docs/api/classes/ServerRootPublicKey.md +0 -72
  346. package/docs/api/classes/SignalProtocolBlockingManager.md +0 -106
  347. package/docs/api/classes/SignalProtocolClient.md +0 -2654
  348. package/docs/api/classes/VerificationFailure.md +0 -25
  349. package/docs/api/enumerations/ContentHint.md +0 -63
  350. package/docs/api/enumerations/EncryptionErrorCode.md +0 -488
  351. package/docs/api/enumerations/IdentityKeyChange.md +0 -65
  352. package/docs/api/enumerations/MessageType.md +0 -29
  353. package/docs/api/enumerations/TrustDirection.md +0 -33
  354. package/docs/api/enumerations/TypingAction.md +0 -31
  355. package/docs/api/functions/createDefaultSignalProtocolContentAdapter.md +0 -13
  356. package/docs/api/functions/createDefaultSignalProtocolLogger.md +0 -36
  357. package/docs/api/functions/createGroupId.md +0 -32
  358. package/docs/api/functions/createSignalProtocolClient.md +0 -36
  359. package/docs/api/functions/createSignalProtocolClientConfig.md +0 -24
  360. package/docs/api/functions/extractGroupId.md +0 -32
  361. package/docs/api/functions/formatVersion.md +0 -25
  362. package/docs/api/functions/isCompatible.md +0 -31
  363. package/docs/api/functions/isGroupId.md +0 -37
  364. package/docs/api/functions/isSealedSenderAuthError.md +0 -25
  365. package/docs/api/functions/parseVersion.md +0 -29
  366. package/docs/api/functions/resolveSPQRLimits.md +0 -21
  367. package/docs/api/functions/resolveSignalProtocolLogger.md +0 -42
  368. package/docs/api/interfaces/AccountIdentityProvisioning.md +0 -43
  369. package/docs/api/interfaces/AccountIdentityRotation.md +0 -69
  370. package/docs/api/interfaces/AttachmentTransferOptions.md +0 -49
  371. package/docs/api/interfaces/BlockedRecipientEntry.md +0 -25
  372. package/docs/api/interfaces/BlockedRecipientsSyncInput.md +0 -27
  373. package/docs/api/interfaces/ConfigurationSyncInput.md +0 -19
  374. package/docs/api/interfaces/CredentialPublicKey.md +0 -25
  375. package/docs/api/interfaces/DataMessageInput.md +0 -21
  376. package/docs/api/interfaces/DecryptedEnvelope.md +0 -95
  377. package/docs/api/interfaces/DecryptedGroup.md +0 -86
  378. package/docs/api/interfaces/DeviceInfo.md +0 -79
  379. package/docs/api/interfaces/DeviceRecord.md +0 -87
  380. package/docs/api/interfaces/DeviceRegistration.md +0 -27
  381. package/docs/api/interfaces/DoubleRatchetConfig.md +0 -36
  382. package/docs/api/interfaces/EcOneTimePreKey.md +0 -27
  383. package/docs/api/interfaces/EcSignedPreKey.md +0 -39
  384. package/docs/api/interfaces/EcSignedPreKeyUpload.md +0 -50
  385. package/docs/api/interfaces/EncryptionErrorContext.md +0 -51
  386. package/docs/api/interfaces/Envelope.md +0 -154
  387. package/docs/api/interfaces/ForceKeyResetResult.md +0 -37
  388. package/docs/api/interfaces/GroupAuthorization.md +0 -23
  389. package/docs/api/interfaces/GroupChangeEntry.md +0 -42
  390. package/docs/api/interfaces/GroupMemberDevice.md +0 -26
  391. package/docs/api/interfaces/IEcOneTimePreKeyStore.md +0 -86
  392. package/docs/api/interfaces/IEcSignedPreKeyStore.md +0 -133
  393. package/docs/api/interfaces/IGroupServer.md +0 -120
  394. package/docs/api/interfaces/IGroupStateStore.md +0 -128
  395. package/docs/api/interfaces/IIdentityKeyStore.md +0 -312
  396. package/docs/api/interfaces/IKemPreKeyStore.md +0 -144
  397. package/docs/api/interfaces/IKyberLastResortPreKeyStore.md +0 -112
  398. package/docs/api/interfaces/ILogger.md +0 -117
  399. package/docs/api/interfaces/IProtocolStore.md +0 -1033
  400. package/docs/api/interfaces/ISenderKeyStore.md +0 -417
  401. package/docs/api/interfaces/ISesameStore.md +0 -249
  402. package/docs/api/interfaces/ISessionStore.md +0 -178
  403. package/docs/api/interfaces/ISignalProtocolClient.md +0 -1185
  404. package/docs/api/interfaces/ISignalProtocolLocalSecretVault.md +0 -71
  405. package/docs/api/interfaces/ISignalProtocolLocalStore.md +0 -2053
  406. package/docs/api/interfaces/ISignalProtocolManager.md +0 -272
  407. package/docs/api/interfaces/ISignalProtocolRelayServer.md +0 -1329
  408. package/docs/api/interfaces/IdentityKeyPair.md +0 -49
  409. package/docs/api/interfaces/IncomingEnvelope.md +0 -91
  410. package/docs/api/interfaces/InspectedSignalProtocolContent.md +0 -43
  411. package/docs/api/interfaces/KDFChain.md +0 -31
  412. package/docs/api/interfaces/KemLastResortPreKeyUpload.md +0 -50
  413. package/docs/api/interfaces/KeyPair.md +0 -23
  414. package/docs/api/interfaces/KyberPreKey.md +0 -42
  415. package/docs/api/interfaces/MLKEMBraidAgentState.md +0 -191
  416. package/docs/api/interfaces/MLKEMBraidMessage.md +0 -49
  417. package/docs/api/interfaces/MediaAttachmentDeleteSyncInput.md +0 -31
  418. package/docs/api/interfaces/MessageHeader.md +0 -49
  419. package/docs/api/interfaces/MessageRecord.md +0 -86
  420. package/docs/api/interfaces/ParsedReceiptContent.md +0 -19
  421. package/docs/api/interfaces/ParsedTypingContent.md +0 -19
  422. package/docs/api/interfaces/PreKeyMaintenanceStore.md +0 -88
  423. package/docs/api/interfaces/PreKeyMessage.md +0 -159
  424. package/docs/api/interfaces/PreKeyStatusResult.md +0 -21
  425. package/docs/api/interfaces/PreKeyUpload.md +0 -42
  426. package/docs/api/interfaces/ProcessEnvelopeOptions.md +0 -72
  427. package/docs/api/interfaces/ProtocolAddress.md +0 -38
  428. package/docs/api/interfaces/ProtocolStrategyConfig.md +0 -91
  429. package/docs/api/interfaces/RatchetMessage.md +0 -96
  430. package/docs/api/interfaces/ReadSyncEntryInput.md +0 -19
  431. package/docs/api/interfaces/ReceiverChain.md +0 -43
  432. package/docs/api/interfaces/RecipientUsernameSyncInput.md +0 -31
  433. package/docs/api/interfaces/RelayPreKeyBundle.md +0 -254
  434. package/docs/api/interfaces/RemoteObjectDownload.md +0 -33
  435. package/docs/api/interfaces/RemoteObjectUpload.md +0 -49
  436. package/docs/api/interfaces/ResolvedSPQRInfoStrings.md +0 -27
  437. package/docs/api/interfaces/ResolvedSPQRLimits.md +0 -37
  438. package/docs/api/interfaces/RetryRequest.md +0 -80
  439. package/docs/api/interfaces/SCKAState.md +0 -65
  440. package/docs/api/interfaces/SPQRLimits.md +0 -40
  441. package/docs/api/interfaces/SPQRState.md +0 -191
  442. package/docs/api/interfaces/SafetyNumber.md +0 -60
  443. package/docs/api/interfaces/SafetyNumberConfirmation.md +0 -46
  444. package/docs/api/interfaces/SealedSenderConfig.md +0 -70
  445. package/docs/api/interfaces/SendOptions.md +0 -191
  446. package/docs/api/interfaces/SendResult.md +0 -93
  447. package/docs/api/interfaces/SenderKeyDistributionMessage.md +0 -43
  448. package/docs/api/interfaces/SenderKeyState.md +0 -76
  449. package/docs/api/interfaces/SenderKeysConfig.md +0 -65
  450. package/docs/api/interfaces/SentSyncTranscriptInput.md +0 -31
  451. package/docs/api/interfaces/ServiceId.md +0 -19
  452. package/docs/api/interfaces/SesameMessage.md +0 -84
  453. package/docs/api/interfaces/SesameStats.md +0 -57
  454. package/docs/api/interfaces/SessionHealthResult.md +0 -120
  455. package/docs/api/interfaces/SessionRecord.md +0 -80
  456. package/docs/api/interfaces/SessionRecordMetadata.md +0 -109
  457. package/docs/api/interfaces/SessionState.md +0 -368
  458. package/docs/api/interfaces/SessionTrustCommit.md +0 -58
  459. package/docs/api/interfaces/SignalProtocolBlockingHooks.md +0 -44
  460. package/docs/api/interfaces/SignalProtocolBlockingManagerOptions.md +0 -31
  461. package/docs/api/interfaces/SignalProtocolBlockingMirror.md +0 -30
  462. package/docs/api/interfaces/SignalProtocolBlockingStore.md +0 -83
  463. package/docs/api/interfaces/SignalProtocolClientAdapterConfig.md +0 -44
  464. package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +0 -693
  465. package/docs/api/interfaces/SignalProtocolClientConfig.md +0 -839
  466. package/docs/api/interfaces/SignalProtocolClientDeleteLocalAttachmentInput.md +0 -25
  467. package/docs/api/interfaces/SignalProtocolClientHooks.md +0 -506
  468. package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +0 -35
  469. package/docs/api/interfaces/SignalProtocolClientLoadLocalAttachmentInput.md +0 -187
  470. package/docs/api/interfaces/SignalProtocolClientLoadedLocalAttachment.md +0 -19
  471. package/docs/api/interfaces/SignalProtocolClientMedia.md +0 -83
  472. package/docs/api/interfaces/SignalProtocolClientMediaCompletedResult.md +0 -25
  473. package/docs/api/interfaces/SignalProtocolClientMediaConfig.md +0 -157
  474. package/docs/api/interfaces/SignalProtocolClientMediaDownloadCompletedResult.md +0 -37
  475. package/docs/api/interfaces/SignalProtocolClientMediaDownloadNotNeededResult.md +0 -25
  476. package/docs/api/interfaces/SignalProtocolClientMediaFailedResult.md +0 -19
  477. package/docs/api/interfaces/SignalProtocolClientMediaOperationOptions.md +0 -53
  478. package/docs/api/interfaces/SignalProtocolClientMediaPendingResult.md +0 -19
  479. package/docs/api/interfaces/SignalProtocolClientMediaProcessResult.md +0 -43
  480. package/docs/api/interfaces/SignalProtocolClientMediaSkippedResult.md +0 -25
  481. package/docs/api/interfaces/SignalProtocolClientMediaUploadCompletedResult.md +0 -31
  482. package/docs/api/interfaces/SignalProtocolClientProcessPendingMediaOptions.md +0 -87
  483. package/docs/api/interfaces/SignalProtocolClientSaveDownloadedAttachmentInput.md +0 -25
  484. package/docs/api/interfaces/SignalProtocolClientSaveUploadedAttachmentInput.md +0 -25
  485. package/docs/api/interfaces/SignalProtocolClientSyncDeleteInput.md +0 -19
  486. package/docs/api/interfaces/SignalProtocolConfig.md +0 -50
  487. package/docs/api/interfaces/SignalProtocolContentAdapter.md +0 -325
  488. package/docs/api/interfaces/SignalProtocolRemoteObjectStore.md +0 -88
  489. package/docs/api/interfaces/SkippedSenderMessageKey.md +0 -26
  490. package/docs/api/interfaces/TaskNotificationAckSyncInput.md +0 -31
  491. package/docs/api/interfaces/TripleRatchetState.md +0 -64
  492. package/docs/api/interfaces/UserRecord.md +0 -71
  493. package/docs/api/interfaces/UsernameStateSyncInput.md +0 -19
  494. package/docs/api/interfaces/VerificationStateSyncInput.md +0 -31
  495. package/docs/api/interfaces/VersionNegotiationState.md +0 -84
  496. package/docs/api/interfaces/ViewOnceOpenSyncInput.md +0 -19
  497. package/docs/api/namespaces/ProtocolAddress/README.md +0 -33
  498. package/docs/api/namespaces/ProtocolAddress/functions/create.md +0 -41
  499. package/docs/api/namespaces/ProtocolAddress/functions/equals.md +0 -39
  500. package/docs/api/namespaces/ProtocolAddress/functions/fromStorageKey.md +0 -36
  501. package/docs/api/namespaces/ProtocolAddress/functions/isUser.md +0 -39
  502. package/docs/api/namespaces/ProtocolAddress/functions/isValid.md +0 -34
  503. package/docs/api/namespaces/ProtocolAddress/functions/parse.md +0 -41
  504. package/docs/api/namespaces/ProtocolAddress/functions/toStorageKey.md +0 -38
  505. package/docs/api/namespaces/ProtocolAddress/functions/toString.md +0 -34
  506. package/docs/api/namespaces/SessionRecord/README.md +0 -30
  507. package/docs/api/namespaces/SessionRecord/functions/archiveCurrent.md +0 -40
  508. package/docs/api/namespaces/SessionRecord/functions/archiveCurrentState.md +0 -34
  509. package/docs/api/namespaces/SessionRecord/functions/create.md +0 -25
  510. package/docs/api/namespaces/SessionRecord/functions/deserialize.md +0 -29
  511. package/docs/api/namespaces/SessionRecord/functions/findSession.md +0 -34
  512. package/docs/api/namespaces/SessionRecord/functions/getAllSessions.md +0 -25
  513. package/docs/api/namespaces/SessionRecord/functions/getArchivedCount.md +0 -25
  514. package/docs/api/namespaces/SessionRecord/functions/hasCurrentSession.md +0 -25
  515. package/docs/api/namespaces/SessionRecord/functions/hasUsableSenderChain.md +0 -36
  516. package/docs/api/namespaces/SessionRecord/functions/promoteSession.md +0 -34
  517. package/docs/api/namespaces/SessionRecord/functions/serialize.md +0 -28
  518. package/docs/api/namespaces/SessionRecord/variables/MAX_ARCHIVED_SESSIONS.md +0 -14
  519. package/docs/api/namespaces/SessionState/README.md +0 -15
  520. package/docs/api/namespaces/SessionState/functions/getSessionId.md +0 -32
  521. package/docs/api/namespaces/blocking/README.md +0 -43
  522. package/docs/api/namespaces/encoding/README.md +0 -33
  523. package/docs/api/namespaces/encoding/functions/base64ToUrlSafe.md +0 -28
  524. package/docs/api/namespaces/encoding/functions/bytesToBase64.md +0 -21
  525. package/docs/api/namespaces/encoding/functions/bytesToString.md +0 -21
  526. package/docs/api/namespaces/encoding/functions/bytesToUrlSafeBase64.md +0 -33
  527. package/docs/api/namespaces/encoding/functions/concatBytes.md +0 -21
  528. package/docs/api/namespaces/encoding/functions/stringToBytes.md +0 -21
  529. package/docs/api/namespaces/encoding/functions/urlSafeToBase64.md +0 -27
  530. package/docs/api/namespaces/keys/README.md +0 -130
  531. package/docs/api/namespaces/keys/functions/acceptContactIdentityRotation.md +0 -33
  532. package/docs/api/namespaces/keys/functions/assertIdentityCommitment.md +0 -25
  533. package/docs/api/namespaces/keys/functions/canonicalizeDeviceIdentityKey.md +0 -30
  534. package/docs/api/namespaces/keys/functions/compareDeviceIdentityKeys.md +0 -28
  535. package/docs/api/namespaces/keys/functions/compositeIdentitiesEqual.md +0 -23
  536. package/docs/api/namespaces/keys/functions/createCompositeIdentityV1.md +0 -19
  537. package/docs/api/namespaces/keys/functions/createPreKeySignatureContext.md +0 -31
  538. package/docs/api/namespaces/keys/functions/createUnverifiedContactIdentityRecord.md +0 -23
  539. package/docs/api/namespaces/keys/functions/decodeCompositeIdentityV1.md +0 -19
  540. package/docs/api/namespaces/keys/functions/deriveIdentityCommitment.md +0 -19
  541. package/docs/api/namespaces/keys/functions/encodeCompositeIdentityV1.md +0 -19
  542. package/docs/api/namespaces/keys/functions/evaluateContactIdentityCandidate.md +0 -27
  543. package/docs/api/namespaces/keys/functions/generateEcOneTimePreKeys.md +0 -37
  544. package/docs/api/namespaces/keys/functions/generateEcSignedPreKey.md +0 -39
  545. package/docs/api/namespaces/keys/functions/generateEcSignedPreKeyId.md +0 -21
  546. package/docs/api/namespaces/keys/functions/generateIdentityKeyPair.md +0 -24
  547. package/docs/api/namespaces/keys/functions/generateKemOneTimePreKeys.md +0 -47
  548. package/docs/api/namespaces/keys/functions/generateKyberLastResortPreKey.md +0 -37
  549. package/docs/api/namespaces/keys/functions/generateRegistrationId.md +0 -13
  550. package/docs/api/namespaces/keys/functions/isValidDeviceIdentityKey.md +0 -22
  551. package/docs/api/namespaces/keys/functions/signMlKem1024PreKey.md +0 -29
  552. package/docs/api/namespaces/keys/functions/signPreKey.md +0 -31
  553. package/docs/api/namespaces/keys/functions/validateContactIdentityRecord.md +0 -19
  554. package/docs/api/namespaces/keys/functions/verifyContactIdentityRecord.md +0 -31
  555. package/docs/api/namespaces/keys/functions/verifyMlKem1024PreKey.md +0 -33
  556. package/docs/api/namespaces/keys/functions/verifyPreKeySignature.md +0 -35
  557. package/docs/api/namespaces/keys/interfaces/CompositeIdentityV1.md +0 -33
  558. package/docs/api/namespaces/keys/interfaces/ContactIdentityRecord.md +0 -53
  559. package/docs/api/namespaces/keys/interfaces/KemOneTimePreKey.md +0 -43
  560. package/docs/api/namespaces/keys/type-aliases/IdentityCandidateStatus.md +0 -9
  561. package/docs/api/namespaces/keys/type-aliases/IdentityTrustState.md +0 -9
  562. package/docs/api/namespaces/keys/type-aliases/IdentityType.md +0 -9
  563. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_ED25519_TAG.md +0 -9
  564. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_LENGTH.md +0 -9
  565. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_VERSION.md +0 -9
  566. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_X25519_TAG.md +0 -9
  567. package/docs/api/namespaces/keys/variables/IDENTITY_COMMITMENT_V1_DOMAIN.md +0 -9
  568. package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_ML_KEM_1024.md +0 -9
  569. package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_X25519.md +0 -9
  570. package/docs/api/namespaces/keys/variables/PREKEY_SIGNATURE_V1_DOMAIN.md +0 -9
  571. package/docs/api/namespaces/keys/variables/UNPINNED_DEVICE_IDENTITY_KEY.md +0 -18
  572. package/docs/api/namespaces/media/README.md +0 -105
  573. package/docs/api/namespaces/media/classes/MediaAttachmentError.md +0 -57
  574. package/docs/api/namespaces/media/functions/createByteRangeMediaAttachmentTransfer.md +0 -19
  575. package/docs/api/namespaces/media/functions/createMediaAttachmentDeliveryId.md +0 -29
  576. package/docs/api/namespaces/media/functions/createMediaAttachmentId.md +0 -19
  577. package/docs/api/namespaces/media/functions/createMediaAttachmentMessage.md +0 -25
  578. package/docs/api/namespaces/media/functions/createMediaAttachmentPointer.md +0 -19
  579. package/docs/api/namespaces/media/functions/createTusMediaAttachmentTransfer.md +0 -19
  580. package/docs/api/namespaces/media/functions/deleteMediaAttachment.md +0 -23
  581. package/docs/api/namespaces/media/functions/executeMediaAttachmentJob.md +0 -23
  582. package/docs/api/namespaces/media/functions/isMediaAttachmentFlagSet.md +0 -19
  583. package/docs/api/namespaces/media/functions/parseMediaAttachmentMessage.md +0 -19
  584. package/docs/api/namespaces/media/functions/planMediaAttachmentCleanup.md +0 -23
  585. package/docs/api/namespaces/media/functions/planMediaAttachmentCleanupJobs.md +0 -19
  586. package/docs/api/namespaces/media/functions/planMediaAttachmentDeleteSync.md +0 -19
  587. package/docs/api/namespaces/media/functions/planMediaAttachmentDownloadJob.md +0 -19
  588. package/docs/api/namespaces/media/functions/planMediaAttachmentOpen.md +0 -19
  589. package/docs/api/namespaces/media/functions/planMediaAttachmentProcessing.md +0 -19
  590. package/docs/api/namespaces/media/functions/planMediaAttachmentUploadJob.md +0 -19
  591. package/docs/api/namespaces/media/functions/prepareMediaAttachmentUpload.md +0 -30
  592. package/docs/api/namespaces/media/functions/resolveMediaAttachment.md +0 -30
  593. package/docs/api/namespaces/media/functions/serializeMediaAttachmentMessage.md +0 -25
  594. package/docs/api/namespaces/media/functions/validateMediaAttachmentPolicy.md +0 -23
  595. package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentPartialStore.md +0 -68
  596. package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentTransferOptions.md +0 -91
  597. package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentOptions.md +0 -25
  598. package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentResult.md +0 -19
  599. package/docs/api/namespaces/media/interfaces/ExecuteMediaAttachmentJobOptions.md +0 -157
  600. package/docs/api/namespaces/media/interfaces/MediaAttachmentBackgroundJob.md +0 -85
  601. package/docs/api/namespaces/media/interfaces/MediaAttachmentCleanupPlan.md +0 -37
  602. package/docs/api/namespaces/media/interfaces/MediaAttachmentJobExecutionResult.md +0 -55
  603. package/docs/api/namespaces/media/interfaces/MediaAttachmentMessage.md +0 -31
  604. package/docs/api/namespaces/media/interfaces/MediaAttachmentOpenDecision.md +0 -31
  605. package/docs/api/namespaces/media/interfaces/MediaAttachmentPointer.md +0 -133
  606. package/docs/api/namespaces/media/interfaces/MediaAttachmentPolicy.md +0 -67
  607. package/docs/api/namespaces/media/interfaces/MediaAttachmentProcessingPlan.md +0 -73
  608. package/docs/api/namespaces/media/interfaces/MediaAttachmentProgress.md +0 -69
  609. package/docs/api/namespaces/media/interfaces/MediaAttachmentResumeState.md +0 -37
  610. package/docs/api/namespaces/media/interfaces/MediaAttachmentRetryOptions.md +0 -31
  611. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransfer.md +0 -51
  612. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferCheckpoint.md +0 -69
  613. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferOptions.md +0 -67
  614. package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadJobData.md +0 -19
  615. package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadResponse.md +0 -25
  616. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentCleanupJobsInput.md +0 -61
  617. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDeleteSyncInput.md +0 -25
  618. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDownloadJobInput.md +0 -161
  619. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentOpenInput.md +0 -25
  620. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentProcessingInput.md +0 -83
  621. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentUploadJobInput.md +0 -147
  622. package/docs/api/namespaces/media/interfaces/PrepareMediaAttachmentUploadOptions.md +0 -144
  623. package/docs/api/namespaces/media/interfaces/ResolveMediaAttachmentOptions.md +0 -55
  624. package/docs/api/namespaces/media/interfaces/ResolvedMediaAttachment.md +0 -109
  625. package/docs/api/namespaces/media/interfaces/TusMediaAttachmentTransferOptions.md +0 -85
  626. package/docs/api/namespaces/media/type-aliases/CreateMediaAttachmentPointerInput.md +0 -15
  627. package/docs/api/namespaces/media/type-aliases/MediaAttachmentCheckpointCallback.md +0 -19
  628. package/docs/api/namespaces/media/type-aliases/MediaAttachmentCleanupReason.md +0 -9
  629. package/docs/api/namespaces/media/type-aliases/MediaAttachmentErrorCode.md +0 -9
  630. package/docs/api/namespaces/media/type-aliases/MediaAttachmentFlag.md +0 -9
  631. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobExecutionStatus.md +0 -9
  632. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobOperation.md +0 -9
  633. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobPriority.md +0 -9
  634. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSkipReason.md +0 -9
  635. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSource.md +0 -9
  636. package/docs/api/namespaces/media/type-aliases/MediaAttachmentKnownIds.md +0 -9
  637. package/docs/api/namespaces/media/type-aliases/MediaAttachmentMessageType.md +0 -9
  638. package/docs/api/namespaces/media/type-aliases/MediaAttachmentProgressCallback.md +0 -19
  639. package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_DEFAULTS.md +0 -47
  640. package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_PRESETS.md +0 -95
  641. package/docs/api/namespaces/media/variables/MediaAttachmentCleanupReason.md +0 -27
  642. package/docs/api/namespaces/media/variables/MediaAttachmentErrorCode.md +0 -75
  643. package/docs/api/namespaces/media/variables/MediaAttachmentFlag.md +0 -23
  644. package/docs/api/namespaces/media/variables/MediaAttachmentJobExecutionStatus.md +0 -19
  645. package/docs/api/namespaces/media/variables/MediaAttachmentJobOperation.md +0 -31
  646. package/docs/api/namespaces/media/variables/MediaAttachmentJobPriority.md +0 -23
  647. package/docs/api/namespaces/media/variables/MediaAttachmentJobSource.md +0 -51
  648. package/docs/api/namespaces/media/variables/MediaAttachmentMessageType.md +0 -15
  649. package/docs/api/namespaces/media/variables/downloadMediaAttachment.md +0 -30
  650. package/docs/api/namespaces/safety/README.md +0 -61
  651. package/docs/api/namespaces/safety/classes/DisplayableFingerprint.md +0 -108
  652. package/docs/api/namespaces/safety/classes/Fingerprint.md +0 -104
  653. package/docs/api/namespaces/safety/classes/ScannableFingerprint.md +0 -209
  654. package/docs/api/namespaces/safety/functions/base64ToBytes.md +0 -21
  655. package/docs/api/namespaces/safety/functions/clearFingerprintCache.md +0 -15
  656. package/docs/api/namespaces/safety/functions/compareSafetyNumbers.md +0 -25
  657. package/docs/api/namespaces/safety/functions/createFingerprintData.md +0 -60
  658. package/docs/api/namespaces/safety/functions/extractQrData.md +0 -34
  659. package/docs/api/namespaces/safety/functions/generateCompositeSafetyNumber.md +0 -39
  660. package/docs/api/namespaces/safety/functions/generateEmojiFingerprint.md +0 -24
  661. package/docs/api/namespaces/safety/functions/generateSingleKeyReferenceSafetyNumber.md +0 -51
  662. package/docs/api/namespaces/safety/functions/generateVerifySchemeUrl.md +0 -32
  663. package/docs/api/namespaces/safety/functions/generateVerifyUrl.md +0 -49
  664. package/docs/api/namespaces/safety/functions/isValidSafetyNumber.md +0 -21
  665. package/docs/api/namespaces/safety/functions/isVerifyUrl.md +0 -45
  666. package/docs/api/namespaces/safety/functions/parseVerifyUrl.md +0 -31
  667. package/docs/api/namespaces/safety/interfaces/FingerprintData.md +0 -52
  668. package/docs/api/namespaces/safety/interfaces/SafetyNumber.md +0 -49
  669. package/docs/api/namespaces/safety/interfaces/VerifyLinkConfig.md +0 -28
  670. package/docs/api/namespaces/safety/interfaces/VerifyUrlParams.md +0 -49
  671. package/docs/api/namespaces/safety/type-aliases/CompareResult.md +0 -21
  672. package/docs/api/namespaces/safety/variables/DEFAULT_VERIFY_LINK_CONFIG.md +0 -12
  673. package/docs/api/namespaces/safety/variables/FINGERPRINT_ITERATIONS.md +0 -12
  674. package/docs/api/namespaces/safety/variables/FINGERPRINT_VERSION.md +0 -12
  675. package/docs/api/namespaces/safety/variables/VERIFY_BASE_URL.md +0 -11
  676. package/docs/api/namespaces/safety/variables/VERIFY_SCHEME_URL.md +0 -11
  677. package/docs/api/type-aliases/Base64.md +0 -20
  678. package/docs/api/type-aliases/BraidPolicy.md +0 -11
  679. package/docs/api/type-aliases/Bytes.md +0 -20
  680. package/docs/api/type-aliases/Ciphertext.md +0 -21
  681. package/docs/api/type-aliases/DeviceType.md +0 -11
  682. package/docs/api/type-aliases/DownloadedAttachment.md +0 -11
  683. package/docs/api/type-aliases/GroupId.md +0 -27
  684. package/docs/api/type-aliases/Hex.md +0 -20
  685. package/docs/api/type-aliases/HookName.md +0 -11
  686. package/docs/api/type-aliases/PostQuantumPolicy.md +0 -11
  687. package/docs/api/type-aliases/PreparedAttachmentUpload.md +0 -14
  688. package/docs/api/type-aliases/PrivateKey.md +0 -22
  689. package/docs/api/type-aliases/ProgressCallback.md +0 -45
  690. package/docs/api/type-aliases/PublicKey.md +0 -22
  691. package/docs/api/type-aliases/RemoteObjectCompleteUploadRequest.md +0 -19
  692. package/docs/api/type-aliases/RemoteObjectDeleteRequest.md +0 -19
  693. package/docs/api/type-aliases/RemoteObjectDownloadRequest.md +0 -19
  694. package/docs/api/type-aliases/RemoteObjectUploadRequest.md +0 -42
  695. package/docs/api/type-aliases/SCKAMode.md +0 -11
  696. package/docs/api/type-aliases/SealedSenderAuth.md +0 -15
  697. package/docs/api/type-aliases/SignalProtocolClientMediaCleanupInput.md +0 -9
  698. package/docs/api/type-aliases/SignalProtocolClientMediaCleanupResult.md +0 -9
  699. package/docs/api/type-aliases/SignalProtocolClientMediaDownloadInput.md +0 -9
  700. package/docs/api/type-aliases/SignalProtocolClientMediaDownloadResult.md +0 -9
  701. package/docs/api/type-aliases/SignalProtocolClientMediaOperationResult.md +0 -9
  702. package/docs/api/type-aliases/SignalProtocolClientMediaUploadInput.md +0 -9
  703. package/docs/api/type-aliases/SignalProtocolClientMediaUploadResult.md +0 -9
  704. package/docs/api/type-aliases/Signature.md +0 -21
  705. package/docs/api/type-aliases/Unsubscribe.md +0 -15
  706. package/docs/api/variables/BraidPolicy.md +0 -21
  707. package/docs/api/variables/DEFAULT_DEVICE_ID.md +0 -12
  708. package/docs/api/variables/DOUBLE_RATCHET_SPEC.md +0 -11
  709. package/docs/api/variables/GROUP_V2_PREFIX.md +0 -11
  710. package/docs/api/variables/KEY_REFRESH_INTERVAL_MS_DEFAULT.md +0 -11
  711. package/docs/api/variables/MAX_MESSAGE_KEYS.md +0 -14
  712. package/docs/api/variables/MAX_PREKEY_AGE_MS_DEFAULT.md +0 -11
  713. package/docs/api/variables/MAX_RECEIVER_CHAINS.md +0 -14
  714. package/docs/api/variables/MAX_REGISTRATION_ID.md +0 -16
  715. package/docs/api/variables/MAX_SKIP.md +0 -11
  716. package/docs/api/variables/MESSAGE_FORMAT.md +0 -11
  717. package/docs/api/variables/MIN_REGISTRATION_ID.md +0 -16
  718. package/docs/api/variables/ML_KEM_BRAID_SPEC.md +0 -11
  719. package/docs/api/variables/ONE_TIME_PREKEY_BATCH_SIZE.md +0 -21
  720. package/docs/api/variables/PQXDH_SPEC.md +0 -11
  721. package/docs/api/variables/PostQuantumPolicy.md +0 -21
  722. package/docs/api/variables/SENDER_KEY_FORMAT.md +0 -11
  723. package/docs/api/variables/SENDER_KEY_SPEC.md +0 -11
  724. package/docs/api/variables/SESAME_SPEC.md +0 -11
  725. package/docs/api/variables/SESSION_FORMAT.md +0 -11
  726. package/docs/api/variables/SPQR_LIMITS_DEFAULTS.md +0 -11
  727. package/docs/api/variables/X3DH_SPEC.md +0 -9
  728. package/docs/api/variables/defaultSignalProtocolLogger.md +0 -32
  729. /package/dist/internal/{groups-v2 → groups}/invite-link.d.ts +0 -0
  730. /package/dist/internal/{groups-v2 → groups}/invite-link.js +0 -0
@@ -1,693 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolClientCompositionOptions
6
-
7
- # Interface: SignalProtocolClientCompositionOptions
8
-
9
- App-facing Signal Protocol client composition contract.
10
-
11
- Keep account/device identity in `identity`, platform/backend choices in
12
- `adapters`, and product security policy in `protocol`.
13
-
14
- The secure default protocol policy is strict post-quantum messaging with
15
- the ML-KEM Braid specification. Most apps can omit `protocol`.
16
-
17
- ## Examples
18
-
19
- **Minimal local client**
20
-
21
- ```typescript
22
- import { createSignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
23
- import { mockStore } from '@open-e2ee/signal-protocol-sdk/local/store/mock';
24
-
25
- const signal = await createSignalProtocolClient({
26
- identity: { userId: 'alice' },
27
- adapters: { storage: mockStore() },
28
- });
29
- ```
30
-
31
- **App client with relay**
32
-
33
- ```typescript
34
- const signal = await createSignalProtocolClient({
35
- identity: { userId },
36
- adapters: { storage, relay },
37
- hooks: {
38
- onMessageDecrypted: async (message) => {
39
- await appMessages.insert({
40
- conversationId: message.conversationId,
41
- senderId: message.senderId,
42
- body: message.content,
43
- });
44
- },
45
- },
46
- });
47
-
48
- await signal.syncToServer();
49
- signal.startRelaySubscription();
50
- ```
51
-
52
- ## Extends
53
-
54
- - `Omit`\<[`SignalProtocolClientConfig`](SignalProtocolClientConfig.md), `"remoteObjectStore"` \| `"deviceId"` \| `"enablePniKeys"` \| `"protocol"` \| `"protocolManager"` \| `"protocolStrategy"` \| `"relay"` \| `"storage"`\>
55
-
56
- ## Properties
57
-
58
- ### adapters
59
-
60
- > **adapters**: [`SignalProtocolClientAdapterConfig`](SignalProtocolClientAdapterConfig.md)
61
-
62
- ***
63
-
64
- ### contentAdapter?
65
-
66
- > `optional` **contentAdapter?**: [`SignalProtocolContentAdapter`](SignalProtocolContentAdapter.md)
67
-
68
- Application-provided content adapter.
69
-
70
- This is the boundary between the protocol layer and app-specific content,
71
- notification batching, and privacy preference policy.
72
-
73
- #### Inherited from
74
-
75
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`contentAdapter`](SignalProtocolClientConfig.md#contentadapter)
76
-
77
- ***
78
-
79
- ### enableDebugLogging?
80
-
81
- > `optional` **enableDebugLogging?**: `boolean`
82
-
83
- Enable debug logging
84
- Default: false
85
- Recommended: Enable in development, disable in production
86
-
87
- #### Inherited from
88
-
89
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`enableDebugLogging`](SignalProtocolClientConfig.md#enabledebuglogging)
90
-
91
- ***
92
-
93
- ### groupsV2?
94
-
95
- > `optional` **groupsV2?**: `object`
96
-
97
- GroupsV2 configuration for Signal Private Group System.
98
- Required for group state management (create, sync, membership changes).
99
-
100
- #### aci
101
-
102
- > **aci**: [`ServiceId`](ServiceId.md)
103
-
104
- User's ACI for credential presentation.
105
-
106
- #### credentialPublicKey
107
-
108
- > **credentialPublicKey**: [`CredentialPublicKey`](CredentialPublicKey.md)
109
-
110
- Server's credential public key for verifying issuance proofs.
111
-
112
- #### endorsementManager?
113
-
114
- > `optional` **endorsementManager?**: [`EndorsementManager`](../classes/EndorsementManager.md)
115
-
116
- Pre-constructed EndorsementManager for group send endorsement-based auth.
117
-
118
- #### endorsementRootPublicKey?
119
-
120
- > `optional` **endorsementRootPublicKey?**: [`ServerRootPublicKey`](../classes/ServerRootPublicKey.md)
121
-
122
- Server's endorsement root public key for verifying group send endorsements.
123
-
124
- #### pni?
125
-
126
- > `optional` **pni?**: [`ServiceId`](ServiceId.md)
127
-
128
- User's PNI for credential presentation (optional — nil UUID used for non-phone apps).
129
-
130
- #### resolveAciBytesByUserIds?
131
-
132
- > `optional` **resolveAciBytesByUserIds?**: (`userIds`) => `Promise`\<`Map`\<`string`, `Uint8Array`\<`ArrayBufferLike`\>\>\>
133
-
134
- Resolve member ACIs without importing app content models into the client.
135
-
136
- ##### Parameters
137
-
138
- ###### userIds
139
-
140
- `string`[]
141
-
142
- ##### Returns
143
-
144
- `Promise`\<`Map`\<`string`, `Uint8Array`\<`ArrayBufferLike`\>\>\>
145
-
146
- #### server
147
-
148
- > **server**: [`IGroupServer`](IGroupServer.md)
149
-
150
- Server-side group operations.
151
-
152
- #### store
153
-
154
- > **store**: [`IGroupStateStore`](IGroupStateStore.md)
155
-
156
- Local group state storage (master keys, cached state).
157
-
158
- #### Example
159
-
160
- ```typescript
161
- const signal = await SignalProtocolClient.create(userId, {
162
- storage: customStorage,
163
- groupsV2: {
164
- store: new SQLiteGroupStateStore(db),
165
- server: new ConvexGroupServer(convex),
166
- }
167
- });
168
- ```
169
-
170
- #### Inherited from
171
-
172
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`groupsV2`](SignalProtocolClientConfig.md#groupsv2)
173
-
174
- ***
175
-
176
- ### hooks?
177
-
178
- > `optional` **hooks?**: [`SignalProtocolClientHooks`](SignalProtocolClientHooks.md)
179
-
180
- Event hooks for Signal Protocol lifecycle events
181
-
182
- Provides integration points for applications to react to:
183
- - Session establishment/deletion
184
- - Key rotation
185
- - Message encryption/decryption
186
- - Errors and cleanup operations
187
-
188
- All hooks are optional and support both sync and async implementations.
189
- Hook errors are caught internally and won't affect core functionality.
190
-
191
- Common use cases:
192
- - Cache invalidation (ContentManager, React Query)
193
- - Analytics and monitoring (Sentry, DataDog)
194
- - State management integration (Redux, Zustand)
195
- - User notifications
196
-
197
- #### Examples
198
-
199
- **Basic usage**
200
-
201
- ```typescript
202
- const signal = await SignalProtocolClient.create(userId, {
203
- storage: customStorage,
204
- hooks: {
205
- onSessionEstablished: (sessionId) => {
206
- ContentManager.invalidateSession(sessionId);
207
- },
208
- onKeyRotated: (keyType) => {
209
- analytics.track('Key Rotated', { keyType });
210
- }
211
- }
212
- });
213
- ```
214
-
215
- **Error tracking**
216
-
217
- ```typescript
218
- const signal = await SignalProtocolClient.create(userId, {
219
- storage: customStorage,
220
- hooks: {
221
- onDecryptionError: (sessionId, error) => {
222
- Sentry.captureException(error, {
223
- tags: { sessionId }
224
- });
225
- }
226
- }
227
- });
228
- ```
229
-
230
- #### Inherited from
231
-
232
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`hooks`](SignalProtocolClientConfig.md#hooks)
233
-
234
- ***
235
-
236
- ### identity
237
-
238
- > **identity**: [`SignalProtocolClientIdentityConfig`](SignalProtocolClientIdentityConfig.md)
239
-
240
- ***
241
-
242
- ### keyRefreshIntervalMs?
243
-
244
- > `optional` **keyRefreshIntervalMs?**: `number`
245
-
246
- Key refresh interval in milliseconds.
247
-
248
- Controls how often signed prekeys and Kyber (last-resort) prekeys are rotated.
249
- Per PQXDH specification Section 3.2, both key types use the same rotation
250
- schedule for synchronized post-quantum security.
251
-
252
- #### Default
253
-
254
- ```ts
255
- 172800000 (2 days)
256
- ```
257
-
258
- #### Examples
259
-
260
- **Default rotation interval**
261
-
262
- ```typescript
263
- const signal = await SignalProtocolClient.create(userId, {
264
- storage: customStorage,
265
- keyRefreshIntervalMs: 2 * 24 * 60 * 60 * 1000 // 2 days
266
- });
267
- ```
268
-
269
- **Weekly rotation (lower bandwidth)**
270
-
271
- ```typescript
272
- const signal = await SignalProtocolClient.create(userId, {
273
- storage: customStorage,
274
- keyRefreshIntervalMs: 7 * 24 * 60 * 60 * 1000 // 7 days
275
- });
276
- ```
277
-
278
- #### See
279
-
280
- https://signal.org/docs/specifications/pqxdh/#publishing-keys
281
-
282
- #### Inherited from
283
-
284
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`keyRefreshIntervalMs`](SignalProtocolClientConfig.md#keyrefreshintervalms)
285
-
286
- ***
287
-
288
- ### logger?
289
-
290
- > `optional` **logger?**: [`ILogger`](ILogger.md)
291
-
292
- Custom logger implementation
293
-
294
- Default: Environment-aware console logging
295
- - Development: verbose (debug, info, warn, error, breadcrumb)
296
- - Production: minimal (warn, error only)
297
-
298
- #### Examples
299
-
300
- **Using custom logger**
301
-
302
- ```typescript
303
- const signal = await SignalProtocolClient.create(userId, {
304
- storage: customStorage,
305
- logger: {
306
- info: (msg, data) => myLogger.log('info', msg, data),
307
- error: (msg, err) => myLogger.log('error', msg, err),
308
- warn: (msg, data) => myLogger.log('warn', msg, data)
309
- }
310
- });
311
- ```
312
-
313
- **Using console directly**
314
-
315
- ```typescript
316
- const signal = await SignalProtocolClient.create(userId, {
317
- storage: customStorage,
318
- logger: console // Works directly!
319
- });
320
- ```
321
-
322
- **Using pino**
323
-
324
- ```typescript
325
- import pino from 'pino';
326
- const signal = await SignalProtocolClient.create(userId, {
327
- storage: customStorage,
328
- logger: pino({ level: 'info' })
329
- });
330
- ```
331
-
332
- **Silent mode**
333
-
334
- ```typescript
335
- const signal = await SignalProtocolClient.create(userId, {
336
- storage: customStorage,
337
- logger: {} // All methods optional
338
- });
339
- ```
340
-
341
- #### Inherited from
342
-
343
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`logger`](SignalProtocolClientConfig.md#logger)
344
-
345
- ***
346
-
347
- ### maxPreKeyAgeMs?
348
-
349
- > `optional` **maxPreKeyAgeMs?**: `number`
350
-
351
- Maximum allowed prekey age in milliseconds.
352
-
353
- If prekeys exceed this age, message sending should be blocked to force
354
- key rotation. Provides a safety buffer above keyRefreshIntervalMs.
355
-
356
- With the default two-day refresh interval, the default maximum age leaves
357
- a twelve-day recovery window.
358
-
359
- #### Default
360
-
361
- ```ts
362
- 1209600000 (14 days)
363
- ```
364
-
365
- #### Example
366
-
367
- **Default maximum age**
368
-
369
- ```typescript
370
- const signal = await SignalProtocolClient.create(userId, {
371
- storage: customStorage,
372
- maxPreKeyAgeMs: 14 * 24 * 60 * 60 * 1000 // 14 days
373
- });
374
- ```
375
-
376
- #### See
377
-
378
- https://signal.org/docs/specifications/pqxdh/#publishing-keys
379
-
380
- #### Inherited from
381
-
382
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`maxPreKeyAgeMs`](SignalProtocolClientConfig.md#maxprekeyagems)
383
-
384
- ***
385
-
386
- ### media?
387
-
388
- > `optional` **media?**: [`SignalProtocolClientMediaConfig`](SignalProtocolClientMediaConfig.md)
389
-
390
- App-owned media lifecycle callbacks for the SignalProtocolClient media queue.
391
-
392
- The queue itself is persisted through the existing Signal Protocol local storage
393
- adapter. These callbacks keep local bytes, plaintext caches, and product
394
- state in the app layer where they can share file permissions, UI state, and
395
- app database ownership.
396
-
397
- #### Example
398
-
399
- ```typescript
400
- const signal = await createSignalProtocolClient({
401
- identity: { userId },
402
- adapters: { storage, relay, remoteObjectStore },
403
- media: {
404
- loadLocalAttachment: async ({ localMediaId }) => appDrafts.readBytes(localMediaId),
405
- saveUploadedAttachment: async ({ localMediaId, attachment }) =>
406
- appPointers.save(localMediaId, attachment),
407
- saveDownloadedAttachment: async ({ attachmentId, downloaded }) =>
408
- appMediaCache.save(attachmentId, downloaded.data),
409
- deleteLocalAttachment: async ({ attachmentId }) => appMediaCache.delete(attachmentId),
410
- },
411
- });
412
- ```
413
-
414
- #### Inherited from
415
-
416
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`media`](SignalProtocolClientConfig.md#media)
417
-
418
- ***
419
-
420
- ### onGroupSenderKeyRotated?
421
-
422
- > `optional` **onGroupSenderKeyRotated?**: (`groupId`, `newGeneration`) => `void`
423
-
424
- Called when a group sender key is rotated.
425
-
426
- Useful for logging, analytics, or triggering UI updates when
427
- sender keys are rotated due to membership changes.
428
-
429
- #### Parameters
430
-
431
- ##### groupId
432
-
433
- `string`
434
-
435
- The group whose sender key was rotated
436
-
437
- ##### newGeneration
438
-
439
- `number`
440
-
441
- The new generation number of the sender key
442
-
443
- #### Returns
444
-
445
- `void`
446
-
447
- #### Example
448
-
449
- ```typescript
450
- const signal = await SignalProtocolClient.create(userId, {
451
- storage: customStorage,
452
- onGroupSenderKeyRotated: (groupId, newGeneration) => {
453
- console.log(`Group ${groupId} sender key rotated to gen ${newGeneration}`);
454
- analytics.track('sender_key_rotated', { groupId, newGeneration });
455
- }
456
- });
457
- ```
458
-
459
- #### Inherited from
460
-
461
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`onGroupSenderKeyRotated`](SignalProtocolClientConfig.md#ongroupsenderkeyrotated)
462
-
463
- ***
464
-
465
- ### onPreKeyLow?
466
-
467
- > `optional` **onPreKeyLow?**: (`remaining`) => `void`
468
-
469
- Callback when one-time prekeys are running low
470
-
471
- Called when prekey count drops below the threshold (default: 50).
472
- Use this to trigger prekey replenishment to prevent session
473
- establishment failures.
474
-
475
- #### Parameters
476
-
477
- ##### remaining
478
-
479
- `number`
480
-
481
- #### Returns
482
-
483
- `void`
484
-
485
- #### Example
486
-
487
- ```typescript
488
- const signal = await SignalProtocolClient.create(userId, {
489
- storage: customStorage,
490
- onPreKeyLow: (remaining) => {
491
- console.warn(`Only ${remaining} prekeys remaining, replenishment needed`);
492
- // Trigger server-side prekey generation
493
- backend.replenishPrekeys(userId);
494
- }
495
- });
496
- ```
497
-
498
- #### Inherited from
499
-
500
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`onPreKeyLow`](SignalProtocolClientConfig.md#onprekeylow)
501
-
502
- ***
503
-
504
- ### onProgress?
505
-
506
- > `optional` **onProgress?**: [`ProgressCallback`](../type-aliases/ProgressCallback.md)
507
-
508
- Progress callback for initialization and relay sync operations.
509
-
510
- Receives updates during:
511
- - Key generation
512
- - Prekey bundle generation
513
- - Relay upload
514
-
515
- #### Example
516
-
517
- ```typescript
518
- const signal = await createSignalProtocolClient({
519
- identity: { userId },
520
- adapters: { storage, relay },
521
- onProgress: ({ stage, percent, message }) => {
522
- console.log(`${stage}: ${percent}% - ${message}`);
523
- }
524
- });
525
- ```
526
-
527
- #### Inherited from
528
-
529
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`onProgress`](SignalProtocolClientConfig.md#onprogress)
530
-
531
- ***
532
-
533
- ### preKeyCheckThrottleMs?
534
-
535
- > `optional` **preKeyCheckThrottleMs?**: `number`
536
-
537
- Prekey check throttle interval in milliseconds.
538
-
539
- Controls how often prekey count checks are performed on app activation.
540
- Prevents unnecessary server queries when the app is repeatedly foregrounded.
541
-
542
- #### Default
543
-
544
- ```ts
545
- 43200000 (12 hours)
546
- ```
547
-
548
- #### See
549
-
550
- https://signal.org/docs/specifications/pqxdh/#publishing-keys
551
-
552
- #### Inherited from
553
-
554
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`preKeyCheckThrottleMs`](SignalProtocolClientConfig.md#prekeycheckthrottlems)
555
-
556
- ***
557
-
558
- ### preKeyLowThreshold?
559
-
560
- > `optional` **preKeyLowThreshold?**: `number`
561
-
562
- Threshold for prekey low warning
563
- Default: 50 (warn when fewer than 50 one-time prekeys remain)
564
-
565
- #### Inherited from
566
-
567
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`preKeyLowThreshold`](SignalProtocolClientConfig.md#prekeylowthreshold)
568
-
569
- ***
570
-
571
- ### preKeyMaintenance?
572
-
573
- > `optional` **preKeyMaintenance?**: [`PreKeyMaintenanceStore`](PreKeyMaintenanceStore.md)
574
-
575
- App-provided prekey bookkeeping store.
576
-
577
- Needed for SQLite-backed adapters that track replaced prekeys separately
578
- from the protocol-facing local store interface.
579
-
580
- #### Inherited from
581
-
582
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`preKeyMaintenance`](SignalProtocolClientConfig.md#prekeymaintenance)
583
-
584
- ***
585
-
586
- ### protocol?
587
-
588
- > `optional` **protocol?**: [`SignalProtocolConfig`](SignalProtocolConfig.md)
589
-
590
- ***
591
-
592
- ### ratchetConfig?
593
-
594
- > `optional` **ratchetConfig?**: [`DoubleRatchetConfig`](DoubleRatchetConfig.md)
595
-
596
- Double Ratchet algorithm configuration
597
-
598
- #### Inherited from
599
-
600
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`ratchetConfig`](SignalProtocolClientConfig.md#ratchetconfig)
601
-
602
- ***
603
-
604
- ### sealedSender?
605
-
606
- > `optional` **sealedSender?**: [`SealedSenderConfig`](SealedSenderConfig.md)
607
-
608
- Sealed Sender configuration for anonymous message delivery.
609
-
610
- When configured, messages are wrapped with sealed sender encryption
611
- that hides the sender's identity from the server. The recipient can
612
- still verify the sender via the embedded certificate.
613
-
614
- Requires:
615
- - Server-side SEALED_SENDER_SIGNING_KEY environment variable
616
- - Trust root public key distributed to clients
617
-
618
- #### See
619
-
620
- https://signal.org/blog/sealed-sender/
621
-
622
- #### Example
623
-
624
- ```typescript
625
- const signal = await SignalProtocolClient.create(userId, {
626
- storage: customStorage,
627
- sealedSender: {
628
- trustRoots: [trustRootPublicKeyBytes],
629
- certificateProvider: async () => {
630
- return await convex.mutation(api.signal.certificates.issueSenderCertificate, { deviceId: 1 });
631
- },
632
- accessMode: 'unrestricted',
633
- }
634
- });
635
- ```
636
-
637
- #### Inherited from
638
-
639
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`sealedSender`](SignalProtocolClientConfig.md#sealedsender)
640
-
641
- ***
642
-
643
- ### senderKeys?
644
-
645
- > `optional` **senderKeys?**: [`SenderKeysConfig`](SenderKeysConfig.md)
646
-
647
- Sender Keys (group messaging) configuration.
648
-
649
- Controls HKDF info strings, DoS protection limits, and out-of-order
650
- message handling for group encryption.
651
-
652
- #### Examples
653
-
654
- **Custom protocol branding**
655
-
656
- ```typescript
657
- const signal = await SignalProtocolClient.create(userId, {
658
- storage: customStorage,
659
- senderKeys: {
660
- hkdfInfoString: 'MyApp Group V1'
661
- }
662
- });
663
- ```
664
-
665
- **Production-recommended limits (these are the defaults)**
666
-
667
- ```typescript
668
- const signal = await SignalProtocolClient.create(userId, {
669
- storage: customStorage,
670
- senderKeys: {
671
- maxChainAdvance: 2000, // DoS protection
672
- maxSkippedKeys: 2000 // Memory limit
673
- }
674
- });
675
- ```
676
-
677
- #### Inherited from
678
-
679
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`senderKeys`](SignalProtocolClientConfig.md#senderkeys)
680
-
681
- ***
682
-
683
- ### throwDetailedErrors?
684
-
685
- > `optional` **throwDetailedErrors?**: `boolean`
686
-
687
- Throw detailed errors instead of generic messages
688
- Default: false (generic error messages for security)
689
- Recommended: Enable in development for debugging
690
-
691
- #### Inherited from
692
-
693
- [`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`throwDetailedErrors`](SignalProtocolClientConfig.md#throwdetailederrors)