@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
@@ -0,0 +1,428 @@
1
+ # Convex Signal Protocol component
2
+
3
+ This installable Convex component owns the complete relay backend: account and
4
+ device registration, identity and prekey storage, message queues, sealed-sender
5
+ delivery, retry requests, provisioning, sender certificates, canonical
6
+ encrypted group state, anonymous group authorization, credential issuance, and
7
+ group-send endorsements. The app owns only its
8
+ authentication-to-protocol-identity mapping and thin public wrappers.
9
+
10
+ ## Install the component
11
+
12
+ Mount the component in the app's Convex configuration:
13
+
14
+ ```ts
15
+ // convex/convex.config.ts
16
+ import { defineApp } from 'convex/server';
17
+ import { v } from 'convex/values';
18
+ import signalProtocol from '@open-e2ee/signal-protocol-sdk/convex.config';
19
+
20
+ const app = defineApp({
21
+ env: { OE_GROUPS_SERVER_SECRET: v.optional(v.string()) },
22
+ });
23
+ app.use(signalProtocol, {
24
+ env: { OE_GROUPS_SERVER_SECRET: app.env.OE_GROUPS_SERVER_SECRET },
25
+ });
26
+ export default app;
27
+ ```
28
+
29
+ The `env` forwarding is load-bearing: Convex components are isolated from the
30
+ app's environment variables, so without it the component cannot see the
31
+ deployment's `OE_GROUPS_SERVER_SECRET` and every group, credential-issuance,
32
+ and sender-certificate call fails at runtime. The messaging, device, key, and
33
+ provisioning namespaces work without the secret.
34
+
35
+ The component owns these isolated tables. They do not appear in the app schema
36
+ and need no package-specific prefixes:
37
+
38
+ - `accounts`: reverse lookup from application account IDs to protocol service
39
+ identifiers and sealed-sender access keys.
40
+ - `devices` and `deviceHeartbeats`: device lifecycle and presence state.
41
+ - `identityKeys` and `identityRegistrations`: account-scoped composite
42
+ identities and device-scoped registration IDs.
43
+ - `ecPreKeys`, `ecSignedPreKeys`, `kemOneTimePreKeys`, and
44
+ `kemLastResortPreKeys`: the four prekey kinds, including durable one-time-key
45
+ consumption tombstones.
46
+ - `messages` and `retryRequests`: device delivery and retry queues.
47
+ - `provisioningSessions`: the linked-device provisioning state machine.
48
+ - `senderCertificates`: cached account/device certificate material.
49
+ - `groups`, `groupChanges`, and `groupSnapshots`: canonical encrypted group
50
+ state, immutable signed changes, and per-version signed snapshots.
51
+
52
+ The component derives **no** membership map from group state. Group reads and
53
+ writes are authorized entirely by zero-knowledge presentations, so `groups`,
54
+ `groupChanges`, and `groupSnapshots` never name an account, and there is no
55
+ `getGroupMembers` endpoint anywhere in the relay surface. Membership is
56
+ local-first: each client resolves fan-out recipients from its own decrypted
57
+ group state and passes their user IDs with the send
58
+ (`SendOptions.groupMemberUserIds`); the relay expands users to devices via
59
+ `getActiveDevices`.
60
+
61
+ See [Group metadata privacy](#group-metadata-privacy) for what the relay can
62
+ still infer from delivery traffic. The absence of a membership endpoint is not
63
+ by itself a metadata-privacy guarantee.
64
+
65
+ The mounted `@convex-dev/rate-limiter` child component separately owns its
66
+ isolated `rateLimits` table.
67
+
68
+ The tables store the latest canonical encrypted state, the exact accepted and
69
+ signed action bytes, and every historical encrypted snapshot with its cached
70
+ S14 baseline signature. They never store the group master key, group secret
71
+ parameters, plaintext group attributes, or the server secret.
72
+
73
+ Storage grows with one full encrypted snapshot per accepted version and is
74
+ never pruned. Old snapshots are load-bearing: `getGroupChanges` serves signed
75
+ history from them, so deleting rows breaks catch-up for clients behind that
76
+ version. A snapshot-compaction protocol is future work; budget storage as
77
+ O(versions × state size) per group.
78
+
79
+ ## Mount the public wrappers
80
+
81
+ Create the wrapper once with the mounted component reference and the app's
82
+ authentication hook:
83
+
84
+ ```ts
85
+ // convex/relayBackend.ts
86
+ import { components } from './_generated/api';
87
+ import { defineConvexSignalProtocolBackend } from '@open-e2ee/signal-protocol-sdk/remote/relay/convex';
88
+ import { resolveProtocolIdentity } from './auth';
89
+
90
+ export const signalRelay = defineConvexSignalProtocolBackend(
91
+ components.signalProtocol,
92
+ {
93
+ identify: async (ctx) => {
94
+ const identity = await resolveProtocolIdentity(ctx);
95
+ return {
96
+ userId: identity.userId,
97
+ aciBytes: identity.aciBytes,
98
+ pniBytes: identity.pniBytes,
99
+ };
100
+ },
101
+ }
102
+ );
103
+ ```
104
+
105
+ The relay reads these functions through `api.signal`, so the modules must live
106
+ inside that namespace rather than at the top of `convex/`:
107
+
108
+ ```ts
109
+ // convex/signal/groups.ts
110
+ import { signalRelay } from '../relayBackend';
111
+
112
+ export const {
113
+ createGroup,
114
+ getGroup,
115
+ getGroupJoinInfo,
116
+ getGroupChanges,
117
+ submitGroupChange,
118
+ refreshGroupSendEndorsements,
119
+ } = signalRelay.groups;
120
+ ```
121
+
122
+ ```ts
123
+ // convex/signal/zkAuth.ts
124
+ import { signalRelay } from '../relayBackend';
125
+
126
+ export const {
127
+ issueAuthCredentialMutation,
128
+ issueProfileKeyCredentialMutation,
129
+ } = signalRelay.zkAuth;
130
+ ```
131
+
132
+ Mount the remaining relay namespaces alongside those group modules:
133
+
134
+ ```ts
135
+ // convex/signal/messages.ts
136
+ import { signalRelay } from '../relayBackend';
137
+ export const {
138
+ send,
139
+ getPendingMessages,
140
+ markDelivered,
141
+ getActiveDevices,
142
+ sendUnidentified,
143
+ sendMultiRecipientUnidentified,
144
+ sendRetryRequest,
145
+ getPendingRetryRequests,
146
+ markRetryRequestHandled,
147
+ } = signalRelay.messages;
148
+ ```
149
+
150
+ ```ts
151
+ // convex/signal/devices.ts
152
+ import { signalRelay } from '../relayBackend';
153
+ export const {
154
+ getDevices,
155
+ registerDevice,
156
+ removeDevice,
157
+ markDeviceConnected,
158
+ markDeviceDisconnected,
159
+ presenceHeartbeat,
160
+ } = signalRelay.devices;
161
+ ```
162
+
163
+ ```ts
164
+ // convex/signal/keys.ts
165
+ import { signalRelay } from '../relayBackend';
166
+ export const {
167
+ uploadIdentityKey,
168
+ getIdentityKey,
169
+ uploadPreKeys,
170
+ fetchPreKeyBundle,
171
+ getPreKeyCount,
172
+ clearStaleKemPreKeys,
173
+ uploadEcSignedPreKey,
174
+ uploadKemLastResortPreKey,
175
+ getEcSignedPreKeyMetadata,
176
+ getKemLastResortPreKeyMetadata,
177
+ } = signalRelay.keys;
178
+ ```
179
+
180
+ ```ts
181
+ // convex/signal/certificates.ts
182
+ import { signalRelay } from '../relayBackend';
183
+ export const { issueSenderCertificate } = signalRelay.certificates;
184
+ ```
185
+
186
+ ```ts
187
+ // convex/signal/provisioning.ts
188
+ import { signalRelay } from '../relayBackend';
189
+ export const {
190
+ createProvisioningSession,
191
+ connectNewDevice,
192
+ sendProvisioningMessage,
193
+ getProvisioningMessage,
194
+ completeProvisioning,
195
+ acknowledgeProvisioning,
196
+ rollbackProvisioning,
197
+ deleteProvisioningSession,
198
+ } = signalRelay.provisioning;
199
+ ```
200
+
201
+ `messages` owns identified and sealed delivery, multi-recipient fan-out, retry
202
+ queues, and message/device lookup reads. `devices` owns registration, removal,
203
+ connection state, and presence. `keys` owns identity provisioning and
204
+ compare-and-swap rotation, prekey upload, atomic one-time-key consumption, and
205
+ key metadata. `certificates` issues sender certificates for registered
206
+ account/device identities. `provisioning` owns the linked-device session state
207
+ machine through acknowledgment or rollback.
208
+
209
+ The account-scoped wrappers resolve the caller identity on the server and
210
+ inject the application `userId`, raw ACI, and optional PNI bytes into the
211
+ isolated component. Client-supplied owner IDs are never trusted. Credential
212
+ issuance also resolves identity. Group wrappers pass client arguments through
213
+ untouched because group reads and writes authenticate membership solely through
214
+ the supplied zero-knowledge presentation.
215
+
216
+ `sendUnidentified` and `sendMultiRecipientUnidentified` are the deliberate
217
+ exception: those sealed-sender paths do **not** call `identify`. They authorize
218
+ the bearer request with the target's unidentified-access key or verified group
219
+ send material, preserving delivery without an authenticated application
220
+ session. Rejections are structured `ConvexError` data, and the relay adapter
221
+ decides whether to fall back to identified delivery by reading
222
+ `data.code === 'UNAUTHORIZED'` — not by matching on the message text. A
223
+ deployment that wraps or re-throws component rejections must preserve `code`,
224
+ or a sealed send that should have retried on the identified path will surface
225
+ as a hard failure instead.
226
+
227
+ A recipient's unidentified-access key is registered as a side effect of the
228
+ zero-knowledge profile-key credential flow
229
+ (`issueProfileKeyCredentialMutation`). Until a recipient has completed that
230
+ flow, access-key-authorized sealed sends to them are rejected and the client
231
+ falls back to identified delivery — messages still arrive, but without sender
232
+ anonymity. Deployments that want sealed sender for 1:1 messaging must drive
233
+ the profile-key credential flow during account setup, not lazily.
234
+
235
+ `identify` must return the authenticated account's real ACI, and its real PNI
236
+ or **no PNI at all**, plus the application-owned `userId` used for relay
237
+ routing. Never substitute a shared placeholder value for accounts without a
238
+ PNI: credentials are matched by ACI-or-PNI alias, so a constant PNI issued to
239
+ every account would let any authenticated user act on any PNI-addressed pending
240
+ membership. An absent PNI must be absent.
241
+
242
+ ## Retention and rate limiting
243
+
244
+ Component-owned interval jobs delete expired seven-day messages hourly,
245
+ expired seven-day retry requests hourly, expired provisioning sessions every
246
+ minute, and stale KEM prekeys daily. Cleanup mutations delete bounded batches
247
+ and schedule immediate continuations until the indexed range is empty.
248
+
249
+ Completing a provisioning session grants the acknowledgment its own full
250
+ session TTL. A link that is never acknowledged within that window is rolled
251
+ back by the cron: the device it created is deleted together with all of its
252
+ key material, queued messages, and heartbeats. Teardown matches the device's
253
+ `linkedAt` stamp recorded at completion, so a device legitimately
254
+ re-registered into a freed slot is never reaped by a stale session.
255
+
256
+ Prekey-bundle fetches use the mounted `@convex-dev/rate-limiter` child
257
+ component. Each authenticated fetcher/target-account pair receives ten fetches
258
+ per fixed one-minute window. The eleventh request fails with structured
259
+ `RATE_LIMITED` data and HTTP-equivalent status 429.
260
+
261
+ ## Upgrading: clear `messages` before deploying this version
262
+
263
+ This version drops two shapes from the `messages` table: the optional
264
+ `groupId` field, and `plaintext_content` from the `messageType` union.
265
+
266
+ Convex validates every existing document against the new schema **during the
267
+ push**, before any of your code runs. A stored row carrying a `groupId`, or
268
+ one whose `messageType` is `plaintext_content`, therefore fails the deploy —
269
+ and no migration mutation can fix it, because the deploy that would ship the
270
+ mutation is the deploy that fails. The order has to be: clear first, deploy
271
+ second.
272
+
273
+ Messages are transient by design. The table has a seven-day TTL and an hourly
274
+ cleanup cron, and undelivered messages are re-requested by clients through the
275
+ retry path, so clearing it is a normal operation rather than data loss.
276
+
277
+ Check whether the deployment has anything to clear — still on the previous
278
+ version, since the table lives inside the component rather than the app:
279
+
280
+ ```sh
281
+ npx convex data messages --component signalProtocol
282
+ ```
283
+
284
+ Add `--prod` or `--deployment <name-or-reference>` to target a deployment other
285
+ than your dev one. A deployment that has never relayed a group message and
286
+ never had a caller pass `plaintext_content` has no affected rows and needs no
287
+ action — no send path in this SDK ever produced the latter.
288
+
289
+ If there are rows, either wait or clear:
290
+
291
+ - **Wait.** Stop sending, and the hourly cleanup cron drains the table as the
292
+ seven-day retention window expires. No manual step, but it takes a week.
293
+ - **Clear.** In the Convex dashboard, select the `signalProtocol` component,
294
+ open the `messages` table, and clear it. Undelivered messages are lost;
295
+ clients re-request them over the retry path.
296
+
297
+ Deploy once the table is empty.
298
+
299
+ ## Secret initialization and pinned trust root
300
+
301
+ From the Convex app directory, run:
302
+
303
+ ```sh
304
+ npx oe-groups trust-root
305
+ ```
306
+
307
+ Add `--prod` for the default production deployment or
308
+ `--deployment <name-or-reference>` for another deployment. The command checks
309
+ `OE_GROUPS_SERVER_SECRET`, generates a cryptographically random 32-byte seed
310
+ only when it is absent, writes it to the selected Convex deployment through
311
+ stdin, and prints two labelled base64 roots — the serialized group trust root
312
+ and the Ed25519 sender-certificate root. Pin both in the client build; see
313
+ [Sender certificate trust root](#sender-certificate-trust-root) for where each
314
+ one goes. Never fetch and trust either at runtime.
315
+
316
+ The seed remains in the Convex environment and deterministically derives all
317
+ four server keypairs. It is never written to a Convex table or log. Back up the
318
+ deployment secret: deleting or replacing it rotates the trust root and strands
319
+ clients pinned to the previous deployment.
320
+
321
+ ## Sender certificate trust root
322
+
323
+ `certificates.issueSenderCertificate` signs sender certificates with an Ed25519
324
+ key pair deterministically derived from the deployment secret, domain-separated
325
+ from the group signing key by distinct KDF labels
326
+ (`open-e2ee:sealed-sender:root:v1` / `:server:v1`). Clients verify inbound
327
+ sealed-sender certificates against the matching Ed25519 **root** public key.
328
+
329
+ `oe-groups trust-root` prints both roots, labelled:
330
+
331
+ ```
332
+ group trust root: <base64>
333
+ sealed sender trust root: <base64>
334
+ ```
335
+
336
+ They are pinned in different places and are not interchangeable — the group
337
+ trust root goes into the group configuration, and the sealed-sender root into
338
+ `sealedSender.trustRoots` in the client build. Pin both at build time; never
339
+ fetch either from a relay at runtime, since a relay that chooses the root it is
340
+ validated against can mint certificates for any sender.
341
+
342
+ Both are derived from the same deployment secret, so rotating
343
+ `OE_GROUPS_SERVER_SECRET` rotates both and strands clients pinned to either
344
+ previous value.
345
+
346
+ With `trustRoots` left empty, inbound sealed-sender validation stays disabled
347
+ and sends fall back to identified delivery — messages still arrive, but the
348
+ sender is disclosed to the relay.
349
+
350
+ ## Group metadata privacy
351
+
352
+ The relay cannot read message contents, cannot derive membership from group
353
+ state, and no longer sees a group identifier on the two channels that used to
354
+ carry one.
355
+
356
+ **Closed: the distribution identifier in the frame.** The identified send path
357
+ stores the framed `SenderKeyMessage` as its `ciphertext`, and that frame's
358
+ `distributionUuid` is **not** encrypted. It used to embed
359
+ `groupId:senderUserId:senderDeviceId:timestamp`, so the group and the sender's
360
+ device were readable straight out of the ciphertext column — and, worse than a
361
+ column, off every message in flight to any relay on the path. Sealed sender did
362
+ not help: it hides the frame from the relay but not from the rest of the path,
363
+ and it is disabled until the trust root is exported (see above), so group
364
+ traffic takes the identified path anyway. Distribution identifiers are now
365
+ opaque random UUIDs carrying no group, sender, device, or clock, as the
366
+ reference implementation uses, as the sender-keys specification now requires.
367
+
368
+ **Closed: the `groupId` column.** Every `messages` row used to store a plaintext
369
+ `groupId` next to `targetUserId` for the seven-day retention window. The column
370
+ is gone. What replaces it is a `sender_key` message type, which tells the
371
+ receiver to decrypt the payload as a framed `SenderKeyMessage` and nothing more:
372
+ the receiver reads the opaque distribution identifier out of the frame and
373
+ resolves the group against its own sender key store. No group identifier
374
+ travels on an envelope, sealed or not.
375
+
376
+ **Open: the group partition itself.** Removing the identifier removed the
377
+ group's *name*, not the ability to group rows. Be precise about what is left,
378
+ because the difference matters and it is easy to overstate:
379
+
380
+ - The frame's `distributionUuid` is unencrypted and is stored verbatim inside
381
+ `messages.ciphertext` — the paragraph above says as much. It is opaque, but
382
+ it is stable for the life of a sender key, and nothing rotates keys on a
383
+ timer. Grouping rows by it recovers the recipient set for a sender's group
384
+ traffic.
385
+ - Sender keys encrypt once and fan out, so every recipient row of one send
386
+ carries a byte-identical `ciphertext`. Grouping by that recovers the
387
+ recipient set of a single send, which is sharper than the old column.
388
+ - The fan-out stamps one `timestamp` across every recipient row, and passes
389
+ through one `clientMessageId` when the application supplies one.
390
+ - `sendMultiRecipientUnidentified` hands the relay the roster explicitly, in
391
+ one call — the sealed-sender path names the recipient set outright.
392
+
393
+ So the relay cannot learn *which* group, or its name, membership list, or
394
+ attributes — but it can still partition delivery pairs into unlabeled groups,
395
+ and any one of those channels suffices. That is a real improvement on a
396
+ plaintext `groupId`, which handed over a stable, meaningful, cross-send label;
397
+ it is not anonymity of the partition. The `sender_key` type is also a
398
+ single-column filter isolating group traffic from pairwise traffic, which the
399
+ old design did not offer — group messages used to hide among `ciphertext` rows.
400
+
401
+ **Still visible.** Delivery metadata itself: who sent to whom, when, and how
402
+ much. Every relay sees this. Sealed sender removes the sender from the
403
+ identified half of it.
404
+
405
+ ## Authorization is account-scoped, not device-scoped
406
+
407
+ `identify` maps an authenticated session to an account (`userId`), with no
408
+ device. Every account-scoped endpoint therefore authorizes at account
409
+ granularity, and the `deviceId` arguments are routing selectors chosen by the
410
+ caller rather than authenticated claims. Concretely, any session for an account
411
+ can read and delete **any** of that account's device queues
412
+ (`getPendingMessages`, `markDelivered`), send as any of its device IDs
413
+ (`send.senderDeviceId`), and upload or rotate key material for any of its
414
+ devices (`keys`).
415
+
416
+ This is the intended model — a compromised session already holds the account —
417
+ but it means the component provides no isolation *between* an account's own
418
+ devices. Deployments that need device isolation must issue device-scoped
419
+ sessions and enforce the binding in their own `identify` wrapper; the component
420
+ cannot do it while its identity has no device field.
421
+
422
+ ## Profile-key issuance threat model
423
+
424
+ `issueProfileKeyCredentialMutation` receives the raw 32-byte profile key. The
425
+ group server therefore sees the plaintext profile key at issuance time. The
426
+ credential proof hides it in later group presentations, but issuance in this
427
+ credential layer is not blinded. Blinded issuance is a future credential-layer
428
+ candidate and is explicitly outside this component's scope.
@@ -0,0 +1,162 @@
1
+ #!/usr/bin/env node
2
+
3
+ import { randomBytes } from 'node:crypto';
4
+ import { spawnSync } from 'node:child_process';
5
+ import { fileURLToPath, pathToFileURL } from 'node:url';
6
+ import path from 'node:path';
7
+
8
+ const SECRET_ENV_VAR = 'OE_GROUPS_SERVER_SECRET';
9
+
10
+ function usage(message) {
11
+ if (message) process.stderr.write(`${message}\n\n`);
12
+ process.stderr.write(
13
+ 'Usage: oe-groups trust-root [--prod | --deployment <deployment>]\n'
14
+ );
15
+ process.exitCode = 2;
16
+ }
17
+
18
+ function deploymentArgs(args) {
19
+ if (args.length === 0) return [];
20
+ if (args.length === 1 && args[0] === '--prod') return ['--prod'];
21
+ if (
22
+ args.length === 2 &&
23
+ args[0] === '--deployment' &&
24
+ args[1].trim().length > 0
25
+ ) {
26
+ return args;
27
+ }
28
+ usage('Invalid deployment arguments');
29
+ return null;
30
+ }
31
+
32
+ function runConvex(args, options = {}) {
33
+ const command = process.platform === 'win32' ? 'npx.cmd' : 'npx';
34
+ const result = spawnSync(command, ['convex', 'env', ...args], {
35
+ cwd: process.cwd(),
36
+ encoding: 'utf8',
37
+ input: options.input,
38
+ stdio: ['pipe', 'pipe', 'pipe'],
39
+ });
40
+ if (result.error) throw result.error;
41
+ if (result.status !== 0) {
42
+ const detail = result.stderr?.trim();
43
+ throw new Error(
44
+ detail
45
+ ? `Convex environment command failed: ${detail}`
46
+ : `Convex environment command exited with status ${result.status}`
47
+ );
48
+ }
49
+ return result.stdout ?? '';
50
+ }
51
+
52
+ function requireSeed(encoded) {
53
+ const normalized = encoded.trim();
54
+ const seed = Buffer.from(normalized, 'base64');
55
+ if (
56
+ seed.length !== 32 ||
57
+ seed.toString('base64') !== normalized
58
+ ) {
59
+ throw new Error(
60
+ `${SECRET_ENV_VAR} must be canonical base64 encoding exactly 32 bytes`
61
+ );
62
+ }
63
+ return new Uint8Array(seed);
64
+ }
65
+
66
+ async function printTrustRoot(args) {
67
+ const selectedDeployment = deploymentArgs(args);
68
+ if (!selectedDeployment) return;
69
+
70
+ const names = runConvex([
71
+ 'list',
72
+ '--names-only',
73
+ ...selectedDeployment,
74
+ ])
75
+ .split(/\r?\n/)
76
+ .map((name) => name.trim())
77
+ .filter(Boolean);
78
+
79
+ let seed;
80
+ if (names.includes(SECRET_ENV_VAR)) {
81
+ seed = requireSeed(
82
+ runConvex(['get', SECRET_ENV_VAR, ...selectedDeployment])
83
+ );
84
+ } else {
85
+ seed = new Uint8Array(randomBytes(32));
86
+ const encoded = Buffer.from(seed).toString('base64');
87
+ runConvex(
88
+ ['set', SECRET_ENV_VAR, ...selectedDeployment],
89
+ { input: `${encoded}\n` }
90
+ );
91
+ }
92
+
93
+ const scriptDirectory = path.dirname(fileURLToPath(import.meta.url));
94
+ const [
95
+ { generateServerSecretParams, getServerPublicParams },
96
+ { encodeGroupTrustRoot },
97
+ { deriveSealedSenderRootPublicKey },
98
+ ] = await Promise.all([
99
+ // pathToFileURL: dynamic import of a bare absolute path fails on
100
+ // Windows, where the ESM loader requires a file:// URL.
101
+ import(
102
+ pathToFileURL(
103
+ path.join(
104
+ scriptDirectory,
105
+ '../dist/internal/protocol/zk/groups/server-params.js'
106
+ )
107
+ ).href
108
+ ),
109
+ import(
110
+ pathToFileURL(
111
+ path.join(
112
+ scriptDirectory,
113
+ '../dist/internal/groups/trust-root.js'
114
+ )
115
+ ).href
116
+ ),
117
+ import(
118
+ pathToFileURL(
119
+ path.join(
120
+ scriptDirectory,
121
+ '../dist/internal/protocol/sealed-sender/trust-root.js'
122
+ )
123
+ ).href
124
+ ),
125
+ ]);
126
+ const secretParams = generateServerSecretParams(seed);
127
+ seed.fill(0);
128
+ const publicParams = getServerPublicParams(secretParams);
129
+ const trustRoot = encodeGroupTrustRoot({
130
+ credentialPublicKey: publicParams.credentialPublicKey,
131
+ serverSigningPublicKey: publicParams.signingPublicKey,
132
+ profileKeyCredentialPublicKey:
133
+ publicParams.profileKeyCredentialPublicKey,
134
+ endorsementRootPublicKey: publicParams.endorsementPublicKey,
135
+ });
136
+ const sealedSenderRoot = await deriveSealedSenderRootPublicKey(
137
+ secretParams.signingKeyPair.signingKey
138
+ );
139
+
140
+ // Two independently pinned roots, printed with labels because they go to
141
+ // different places in the client build and are not interchangeable.
142
+ process.stdout.write(
143
+ `group trust root: ${Buffer.from(trustRoot).toString('base64')}\n`
144
+ );
145
+ process.stdout.write(
146
+ `sealed sender trust root: ${Buffer.from(sealedSenderRoot).toString('base64')}\n`
147
+ );
148
+ }
149
+
150
+ const [command, ...args] = process.argv.slice(2);
151
+ if (command !== 'trust-root') {
152
+ usage(command ? `Unknown command: ${command}` : undefined);
153
+ } else {
154
+ try {
155
+ await printTrustRoot(args);
156
+ } catch (error) {
157
+ process.stderr.write(
158
+ `${error instanceof Error ? error.message : String(error)}\n`
159
+ );
160
+ process.exitCode = 1;
161
+ }
162
+ }
@@ -1,108 +0,0 @@
1
- /**
2
- * GroupsV2 Access Control
3
- *
4
- * Authorization checks for group operations based on member roles and
5
- * access control settings.
6
- *
7
- * These are client-local checks over already-decrypted group state. They use
8
- * the role and access-required vocabulary of the Signal Protocol group system,
9
- * but they are not that system's enforcement model: there, the server
10
- * validates each change against embedded zero-knowledge presentations. Here
11
- * the server sees only opaque state and a version number, so these checks
12
- * bind an honest client, not a hostile one.
13
- *
14
- * @module groups-v2/access-control
15
- */
16
- import { type DecryptedGroup, type DecryptedMember, MemberRole, AccessRequired } from './types.js';
17
- /**
18
- * Actions that can be performed on a group.
19
- * Each action has specific authorization requirements.
20
- */
21
- export {};
22
- export declare enum GroupAction {
23
- MODIFY_TITLE = "MODIFY_TITLE",
24
- MODIFY_AVATAR = "MODIFY_AVATAR",
25
- MODIFY_DESCRIPTION = "MODIFY_DESCRIPTION",
26
- MODIFY_DISAPPEARING_MESSAGES = "MODIFY_DISAPPEARING_MESSAGES",
27
- ADD_MEMBER = "ADD_MEMBER",
28
- REMOVE_MEMBER = "REMOVE_MEMBER",
29
- MODIFY_MEMBER_ROLE = "MODIFY_MEMBER_ROLE",
30
- MODIFY_MEMBER_LABEL = "MODIFY_MEMBER_LABEL",
31
- MODIFY_ATTRIBUTES_ACCESS = "MODIFY_ATTRIBUTES_ACCESS",
32
- MODIFY_MEMBERS_ACCESS = "MODIFY_MEMBERS_ACCESS",
33
- MODIFY_INVITE_LINK_ACCESS = "MODIFY_INVITE_LINK_ACCESS",
34
- MODIFY_INVITE_LINK_PASSWORD = "MODIFY_INVITE_LINK_PASSWORD",
35
- MODIFY_ANNOUNCEMENTS = "MODIFY_ANNOUNCEMENTS",
36
- BAN_MEMBER = "BAN_MEMBER",
37
- UNBAN_MEMBER = "UNBAN_MEMBER",
38
- SEND_MESSAGE = "SEND_MESSAGE"
39
- }
40
- /**
41
- * Find a member in the group by their ACI (Account Identity).
42
- *
43
- * @param group - Decrypted group state
44
- * @param aciBytes - Member's ACI as bytes (32 bytes UUID)
45
- * @returns Member object if found, undefined otherwise
46
- */
47
- export declare function findMember(group: DecryptedGroup, aciBytes: Uint8Array): DecryptedMember | undefined;
48
- /**
49
- * Get a member's role in the group.
50
- *
51
- * @param group - Decrypted group state
52
- * @param aciBytes - Member's ACI as bytes
53
- * @returns Member's role, or UNKNOWN if not a member
54
- */
55
- export declare function getMemberRole(group: DecryptedGroup, aciBytes: Uint8Array): MemberRole;
56
- /**
57
- * Check if a member role satisfies an access requirement.
58
- *
59
- * @param memberRole - The member's current role
60
- * @param requirement - The required access level
61
- * @returns True if the member role meets the requirement
62
- */
63
- export declare function meetsAccessRequirement(memberRole: MemberRole, requirement: AccessRequired): boolean;
64
- /**
65
- * Check if a member can perform a specific action on the group.
66
- * Core authorization function for all group operations.
67
- *
68
- * @param group - Decrypted group state
69
- * @param aciBytes - Member's ACI as bytes
70
- * @param action - The action to check
71
- * @returns True if the member is authorized to perform the action
72
- */
73
- export declare function canPerformAction(group: DecryptedGroup, aciBytes: Uint8Array, action: GroupAction): boolean;
74
- /**
75
- * Check if a member is an administrator of the group.
76
- * Convenience function for common authorization check.
77
- *
78
- * @param group - Decrypted group state
79
- * @param aciBytes - Member's ACI as bytes
80
- * @returns True if the member is an administrator
81
- */
82
- export declare function isAdmin(group: DecryptedGroup, aciBytes: Uint8Array): boolean;
83
- /**
84
- * Check if a user is a member of the group.
85
- * Convenience function to check membership status.
86
- *
87
- * @param group - Decrypted group state
88
- * @param aciBytes - User's ACI as bytes
89
- * @returns True if the user is a member
90
- */
91
- export declare function isMember(group: DecryptedGroup, aciBytes: Uint8Array): boolean;
92
- /**
93
- * Check if a user has a pending membership invitation.
94
- *
95
- * @param group - Decrypted group state
96
- * @param serviceIdBytes - User's service ID (ACI or PNI) as bytes
97
- * @returns True if the user has a pending invitation
98
- */
99
- export declare function isPending(group: DecryptedGroup, serviceIdBytes: Uint8Array): boolean;
100
- /**
101
- * Check if a user is banned from the group.
102
- *
103
- * @param group - Decrypted group state
104
- * @param serviceIdBytes - User's service ID (ACI or PNI) as bytes
105
- * @returns True if the user is banned
106
- */
107
- export declare function isBanned(group: DecryptedGroup, serviceIdBytes: Uint8Array): boolean;
108
- //# sourceMappingURL=access-control.d.ts.map