@open-e2ee/signal-protocol-sdk 0.1.0-alpha.5 → 0.1.0-alpha.7

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 (494) hide show
  1. package/ADAPTERS.md +15 -15
  2. package/ARCHITECTURE.md +1 -1
  3. package/CHANGELOG.md +252 -2
  4. package/README.md +1 -1
  5. package/blocking/README.md +5 -5
  6. package/client/README.md +2 -2
  7. package/dist/blocking/index.d.ts +2 -2
  8. package/dist/blocking/index.d.ts.map +1 -1
  9. package/dist/blocking/index.js +1 -1
  10. package/dist/blocking/index.js.map +1 -1
  11. package/dist/blocking/manager.d.ts +7 -7
  12. package/dist/blocking/manager.d.ts.map +1 -1
  13. package/dist/blocking/manager.js +3 -3
  14. package/dist/blocking/manager.js.map +1 -1
  15. package/dist/blocking/types.d.ts +3 -3
  16. package/dist/blocking/types.d.ts.map +1 -1
  17. package/dist/client/client.d.ts +32 -28
  18. package/dist/client/client.d.ts.map +1 -1
  19. package/dist/client/client.js +127 -79
  20. package/dist/client/client.js.map +1 -1
  21. package/dist/client/compose.d.ts +12 -7
  22. package/dist/client/compose.d.ts.map +1 -1
  23. package/dist/client/compose.js +2 -0
  24. package/dist/client/compose.js.map +1 -1
  25. package/dist/client/config.d.ts +54 -30
  26. package/dist/client/config.d.ts.map +1 -1
  27. package/dist/client/config.js.map +1 -1
  28. package/dist/client/content-adapter.d.ts +4 -4
  29. package/dist/client/content-adapter.d.ts.map +1 -1
  30. package/dist/client/content-adapter.js +1 -1
  31. package/dist/client/content-adapter.js.map +1 -1
  32. package/dist/client/dual-store.d.ts +5 -5
  33. package/dist/client/dual-store.d.ts.map +1 -1
  34. package/dist/client/dual-store.js.map +1 -1
  35. package/dist/client/endorsement-manager.d.ts +4 -0
  36. package/dist/client/endorsement-manager.d.ts.map +1 -1
  37. package/dist/client/endorsement-manager.js +11 -2
  38. package/dist/client/endorsement-manager.js.map +1 -1
  39. package/dist/client/groups.d.ts +29 -29
  40. package/dist/client/groups.d.ts.map +1 -1
  41. package/dist/client/groups.js +54 -37
  42. package/dist/client/groups.js.map +1 -1
  43. package/dist/client/headless.d.ts +9 -9
  44. package/dist/client/headless.d.ts.map +1 -1
  45. package/dist/client/headless.js +6 -6
  46. package/dist/client/headless.js.map +1 -1
  47. package/dist/client/index.d.ts +2 -2
  48. package/dist/client/index.d.ts.map +1 -1
  49. package/dist/client/index.js +1 -1
  50. package/dist/client/index.js.map +1 -1
  51. package/dist/client/key-rotation-core.d.ts +7 -7
  52. package/dist/client/key-rotation-core.d.ts.map +1 -1
  53. package/dist/client/key-rotation-core.js +11 -11
  54. package/dist/client/key-rotation-core.js.map +1 -1
  55. package/dist/client/media.js.map +1 -1
  56. package/dist/client/relay-subscription.d.ts +2 -2
  57. package/dist/client/relay-subscription.d.ts.map +1 -1
  58. package/dist/client/relay-subscription.js +1 -1
  59. package/dist/client/relay-subscription.js.map +1 -1
  60. package/dist/client/retry.js.map +1 -1
  61. package/dist/client/sealed-sender-ops.d.ts +1 -1
  62. package/dist/client/sealed-sender-ops.d.ts.map +1 -1
  63. package/dist/client/sealed-sender-ops.js +3 -3
  64. package/dist/client/sealed-sender-ops.js.map +1 -1
  65. package/dist/client/signal-service-cipher.d.ts +15 -11
  66. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  67. package/dist/client/signal-service-cipher.js +24 -15
  68. package/dist/client/signal-service-cipher.js.map +1 -1
  69. package/dist/client/types.d.ts +8 -8
  70. package/dist/client/types.d.ts.map +1 -1
  71. package/dist/device/connection.js +2 -2
  72. package/dist/device/connection.js.map +1 -1
  73. package/dist/device/device-id.d.ts.map +1 -1
  74. package/dist/device/device-id.js +4 -4
  75. package/dist/device/device-id.js.map +1 -1
  76. package/dist/device/provisioning.d.ts +2 -2
  77. package/dist/device/provisioning.d.ts.map +1 -1
  78. package/dist/device/provisioning.js +7 -7
  79. package/dist/device/provisioning.js.map +1 -1
  80. package/dist/device/transfer.d.ts.map +1 -1
  81. package/dist/device/transfer.js +14 -14
  82. package/dist/device/transfer.js.map +1 -1
  83. package/dist/files/index.d.ts +1 -1
  84. package/dist/files/index.js +1 -1
  85. package/dist/groups/index.d.ts +4 -4
  86. package/dist/groups/index.d.ts.map +1 -1
  87. package/dist/groups/index.js +3 -3
  88. package/dist/groups/index.js.map +1 -1
  89. package/dist/hooks/use-connection-presence.d.ts +3 -3
  90. package/dist/hooks/use-connection-presence.d.ts.map +1 -1
  91. package/dist/hooks/use-connection-presence.js +4 -4
  92. package/dist/hooks/use-connection-presence.js.map +1 -1
  93. package/dist/hooks/use-key-rotation.js +2 -2
  94. package/dist/hooks/use-key-rotation.js.map +1 -1
  95. package/dist/index.d.ts +15 -15
  96. package/dist/index.d.ts.map +1 -1
  97. package/dist/index.js +6 -6
  98. package/dist/index.js.map +1 -1
  99. package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
  100. package/dist/internal/crypto/ec/x25519-validation.js +4 -4
  101. package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
  102. package/dist/internal/crypto/symmetric/mac.d.ts +3 -3
  103. package/dist/internal/crypto/symmetric/mac.js +3 -3
  104. package/dist/internal/encoding/proto/envelope.d.ts +21 -21
  105. package/dist/internal/encoding/proto/envelope.d.ts.map +1 -1
  106. package/dist/internal/encoding/proto/envelope.js +25 -25
  107. package/dist/internal/encoding/proto/envelope.js.map +1 -1
  108. package/dist/internal/encoding/proto/index.d.ts +2 -2
  109. package/dist/internal/encoding/proto/index.d.ts.map +1 -1
  110. package/dist/internal/encoding/proto/index.js +2 -2
  111. package/dist/internal/encoding/proto/index.js.map +1 -1
  112. package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts +3 -3
  113. package/dist/internal/encoding/proto/pq-ratchet-serialize.js +2 -2
  114. package/dist/internal/encoding/proto/signal-message.d.ts +33 -33
  115. package/dist/internal/encoding/proto/signal-message.d.ts.map +1 -1
  116. package/dist/internal/encoding/proto/signal-message.js +58 -58
  117. package/dist/internal/encoding/proto/signal-message.js.map +1 -1
  118. package/dist/internal/groups/access-control.d.ts +170 -0
  119. package/dist/internal/groups/access-control.d.ts.map +1 -0
  120. package/dist/internal/groups/access-control.js +284 -0
  121. package/dist/internal/groups/access-control.js.map +1 -0
  122. package/dist/internal/groups/change-actions.d.ts +57 -0
  123. package/dist/internal/groups/change-actions.d.ts.map +1 -0
  124. package/dist/internal/groups/change-actions.js +827 -0
  125. package/dist/internal/groups/change-actions.js.map +1 -0
  126. package/dist/internal/groups/change-authorization.d.ts +16 -0
  127. package/dist/internal/groups/change-authorization.d.ts.map +1 -0
  128. package/dist/internal/groups/change-authorization.js +120 -0
  129. package/dist/internal/groups/change-authorization.js.map +1 -0
  130. package/dist/internal/{groups-v2 → groups}/encrypted-state.d.ts +12 -2
  131. package/dist/internal/groups/encrypted-state.d.ts.map +1 -0
  132. package/dist/internal/{groups-v2 → groups}/encrypted-state.js +122 -22
  133. package/dist/internal/groups/encrypted-state.js.map +1 -0
  134. package/dist/internal/groups/group-id.d.ts +9 -9
  135. package/dist/internal/groups/group-id.d.ts.map +1 -1
  136. package/dist/internal/groups/group-id.js +11 -12
  137. package/dist/internal/groups/group-id.js.map +1 -1
  138. package/dist/internal/groups/index.d.ts +16 -6
  139. package/dist/internal/groups/index.d.ts.map +1 -1
  140. package/dist/internal/groups/index.js +9 -1
  141. package/dist/internal/groups/index.js.map +1 -1
  142. package/dist/internal/groups/invite-link.d.ts.map +1 -0
  143. package/dist/internal/groups/invite-link.js.map +1 -0
  144. package/dist/internal/{groups-v2 → groups}/manager.d.ts +175 -40
  145. package/dist/internal/groups/manager.d.ts.map +1 -0
  146. package/dist/internal/groups/manager.js +1862 -0
  147. package/dist/internal/groups/manager.js.map +1 -0
  148. package/dist/internal/groups/sdk-store.d.ts +32 -0
  149. package/dist/internal/groups/sdk-store.d.ts.map +1 -0
  150. package/dist/internal/groups/sdk-store.js +111 -0
  151. package/dist/internal/groups/sdk-store.js.map +1 -0
  152. package/dist/internal/groups/server-engine.d.ts +52 -0
  153. package/dist/internal/groups/server-engine.d.ts.map +1 -0
  154. package/dist/internal/groups/server-engine.js +1126 -0
  155. package/dist/internal/groups/server-engine.js.map +1 -0
  156. package/dist/internal/groups/trust-root.d.ts +32 -0
  157. package/dist/internal/groups/trust-root.d.ts.map +1 -0
  158. package/dist/internal/groups/trust-root.js +91 -0
  159. package/dist/internal/groups/trust-root.js.map +1 -0
  160. package/dist/internal/{groups-v2 → groups}/types.d.ts +188 -46
  161. package/dist/internal/groups/types.d.ts.map +1 -0
  162. package/dist/internal/{groups-v2 → groups}/types.js +3 -2
  163. package/dist/internal/groups/types.js.map +1 -0
  164. package/dist/internal/groups/wire.d.ts +68 -0
  165. package/dist/internal/groups/wire.d.ts.map +1 -0
  166. package/dist/internal/groups/wire.js +708 -0
  167. package/dist/internal/groups/wire.js.map +1 -0
  168. package/dist/internal/manager/manager.d.ts +3 -3
  169. package/dist/internal/manager/manager.d.ts.map +1 -1
  170. package/dist/internal/manager/manager.js +3 -3
  171. package/dist/internal/manager/manager.js.map +1 -1
  172. package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
  173. package/dist/internal/protocol/double-ratchet/chains.js +9 -9
  174. package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
  175. package/dist/internal/protocol/double-ratchet/ratchet.d.ts +2 -2
  176. package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
  177. package/dist/internal/protocol/double-ratchet/ratchet.js +2 -2
  178. package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
  179. package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
  180. package/dist/internal/protocol/pqxdh/pqxdh.js +3 -3
  181. package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
  182. package/dist/internal/protocol/sender-keys/index.d.ts +1 -1
  183. package/dist/internal/protocol/sender-keys/manager.d.ts +3 -3
  184. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  185. package/dist/internal/protocol/sender-keys/manager.js +3 -3
  186. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  187. package/dist/internal/protocol/spqr/spqr.d.ts +1 -1
  188. package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
  189. package/dist/internal/protocol/spqr/spqr.js +5 -5
  190. package/dist/internal/protocol/spqr/spqr.js.map +1 -1
  191. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +2 -2
  192. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +1 -1
  193. package/dist/internal/protocol/triple-ratchet/ratchet.js +4 -4
  194. package/dist/internal/protocol/triple-ratchet/ratchet.js.map +1 -1
  195. package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
  196. package/dist/internal/protocol/x3dh/x3dh.js +3 -3
  197. package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
  198. package/dist/internal/protocol/zk/groups/auth-credential.d.ts +9 -7
  199. package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
  200. package/dist/internal/protocol/zk/groups/auth-credential.js +68 -29
  201. package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
  202. package/dist/internal/protocol/zk/groups/server-params.d.ts +1 -1
  203. package/dist/internal/protocol/zk/groups/server-params.d.ts.map +1 -1
  204. package/dist/internal/protocol/zk/groups/server-params.js.map +1 -1
  205. package/dist/internal/protocol/zk/groups/uid-struct.d.ts +2 -0
  206. package/dist/internal/protocol/zk/groups/uid-struct.d.ts.map +1 -1
  207. package/dist/internal/protocol/zk/groups/uid-struct.js +4 -0
  208. package/dist/internal/protocol/zk/groups/uid-struct.js.map +1 -1
  209. package/dist/internal/sesame/device-registry.d.ts +7 -7
  210. package/dist/internal/sesame/device-registry.d.ts.map +1 -1
  211. package/dist/internal/sesame/device-registry.js +2 -2
  212. package/dist/internal/sesame/device-registry.js.map +1 -1
  213. package/dist/internal/sesame/manager.d.ts +1 -1
  214. package/dist/internal/sesame/manager.d.ts.map +1 -1
  215. package/dist/internal/sesame/manager.js +15 -15
  216. package/dist/internal/sesame/manager.js.map +1 -1
  217. package/dist/internal/session/builder.js +3 -3
  218. package/dist/internal/session/builder.js.map +1 -1
  219. package/dist/internal/session/cipher.d.ts +2 -2
  220. package/dist/internal/session/cipher.d.ts.map +1 -1
  221. package/dist/internal/session/cipher.js +30 -30
  222. package/dist/internal/session/cipher.js.map +1 -1
  223. package/dist/internal/session/decryption.d.ts +1 -1
  224. package/dist/internal/session/decryption.js +10 -10
  225. package/dist/internal/session/decryption.js.map +1 -1
  226. package/dist/internal/session/factory.d.ts.map +1 -1
  227. package/dist/internal/session/factory.js +3 -3
  228. package/dist/internal/session/factory.js.map +1 -1
  229. package/dist/internal/session/handshake.d.ts.map +1 -1
  230. package/dist/internal/session/handshake.js +3 -3
  231. package/dist/internal/session/handshake.js.map +1 -1
  232. package/dist/internal/session/ratchet.d.ts.map +1 -1
  233. package/dist/internal/session/ratchet.js +4 -4
  234. package/dist/internal/session/ratchet.js.map +1 -1
  235. package/dist/internal/session/types.d.ts +2 -2
  236. package/dist/internal/session/types.d.ts.map +1 -1
  237. package/dist/internal/session/validation.d.ts.map +1 -1
  238. package/dist/internal/session/validation.js +3 -3
  239. package/dist/internal/session/validation.js.map +1 -1
  240. package/dist/layers.d.ts +3 -3
  241. package/dist/layers.d.ts.map +1 -1
  242. package/dist/layers.js +7 -7
  243. package/dist/layers.js.map +1 -1
  244. package/dist/local/store/expo/adapter.d.ts +8 -8
  245. package/dist/local/store/expo/adapter.d.ts.map +1 -1
  246. package/dist/local/store/expo/adapter.js +7 -7
  247. package/dist/local/store/expo/adapter.js.map +1 -1
  248. package/dist/local/store/expo/database-key.d.ts +2 -2
  249. package/dist/local/store/expo/database-key.d.ts.map +1 -1
  250. package/dist/local/store/expo/database-key.js +5 -5
  251. package/dist/local/store/expo/database-key.js.map +1 -1
  252. package/dist/local/store/expo/db.d.ts +9 -9
  253. package/dist/local/store/expo/db.d.ts.map +1 -1
  254. package/dist/local/store/expo/db.js +2 -2
  255. package/dist/local/store/expo/db.js.map +1 -1
  256. package/dist/local/store/expo/index.d.ts +6 -6
  257. package/dist/local/store/expo/index.d.ts.map +1 -1
  258. package/dist/local/store/expo/index.js +3 -3
  259. package/dist/local/store/expo/index.js.map +1 -1
  260. package/dist/local/store/expo/key-storage.d.ts +1 -1
  261. package/dist/local/store/expo/key-storage.d.ts.map +1 -1
  262. package/dist/local/store/expo/key-storage.js +4 -4
  263. package/dist/local/store/expo/key-storage.js.map +1 -1
  264. package/dist/local/store/expo/secure-store-options.d.ts +1 -1
  265. package/dist/local/store/expo/secure-store-options.d.ts.map +1 -1
  266. package/dist/local/store/expo/secure-store-options.js +1 -1
  267. package/dist/local/store/expo/secure-store-options.js.map +1 -1
  268. package/dist/local/store/index.d.ts +9 -9
  269. package/dist/local/store/index.d.ts.map +1 -1
  270. package/dist/local/store/index.js +8 -8
  271. package/dist/local/store/index.js.map +1 -1
  272. package/dist/local/store/mock/adapter.d.ts +6 -6
  273. package/dist/local/store/mock/adapter.d.ts.map +1 -1
  274. package/dist/local/store/mock/adapter.js +2 -2
  275. package/dist/local/store/mock/adapter.js.map +1 -1
  276. package/dist/local/store/mock/index.d.ts +3 -3
  277. package/dist/local/store/mock/index.d.ts.map +1 -1
  278. package/dist/local/store/mock/index.js +3 -3
  279. package/dist/local/store/mock/index.js.map +1 -1
  280. package/dist/local/store/node/adapter.d.ts +4 -4
  281. package/dist/local/store/node/adapter.d.ts.map +1 -1
  282. package/dist/local/store/node/adapter.js +2 -2
  283. package/dist/local/store/node/adapter.js.map +1 -1
  284. package/dist/local/store/node/database.d.ts.map +1 -1
  285. package/dist/local/store/node/database.js +2 -2
  286. package/dist/local/store/node/database.js.map +1 -1
  287. package/dist/local/store/node/index.d.ts +4 -4
  288. package/dist/local/store/node/index.d.ts.map +1 -1
  289. package/dist/local/store/node/index.js +3 -3
  290. package/dist/local/store/node/index.js.map +1 -1
  291. package/dist/local/store/react-native/adapter.d.ts +5 -5
  292. package/dist/local/store/react-native/adapter.d.ts.map +1 -1
  293. package/dist/local/store/react-native/adapter.js +12 -12
  294. package/dist/local/store/react-native/adapter.js.map +1 -1
  295. package/dist/local/store/react-native/index.d.ts +4 -4
  296. package/dist/local/store/react-native/index.d.ts.map +1 -1
  297. package/dist/local/store/react-native/index.js +3 -3
  298. package/dist/local/store/react-native/index.js.map +1 -1
  299. package/dist/local/store/react-native/storage.d.ts +1 -1
  300. package/dist/local/store/web/adapter.d.ts +4 -4
  301. package/dist/local/store/web/adapter.d.ts.map +1 -1
  302. package/dist/local/store/web/adapter.js +7 -7
  303. package/dist/local/store/web/adapter.js.map +1 -1
  304. package/dist/local/store/web/index.d.ts +4 -4
  305. package/dist/local/store/web/index.d.ts.map +1 -1
  306. package/dist/local/store/web/index.js +3 -3
  307. package/dist/local/store/web/index.js.map +1 -1
  308. package/dist/local/vault/expo-secure-store.d.ts +2 -2
  309. package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
  310. package/dist/local/vault/expo-secure-store.js +5 -5
  311. package/dist/local/vault/expo-secure-store.js.map +1 -1
  312. package/dist/local/vault/index.d.ts +2 -2
  313. package/dist/local/vault/index.d.ts.map +1 -1
  314. package/dist/local/vault/index.js +1 -1
  315. package/dist/local/vault/index.js.map +1 -1
  316. package/dist/logger.d.ts +3 -3
  317. package/dist/logger.d.ts.map +1 -1
  318. package/dist/logger.js +4 -4
  319. package/dist/logger.js.map +1 -1
  320. package/dist/media/index.d.ts +5 -5
  321. package/dist/media/index.d.ts.map +1 -1
  322. package/dist/profile/contact-state.d.ts.map +1 -1
  323. package/dist/profile/contact-state.js +2 -2
  324. package/dist/profile/contact-state.js.map +1 -1
  325. package/dist/profile/profile-key.d.ts.map +1 -1
  326. package/dist/profile/profile-key.js +2 -2
  327. package/dist/profile/profile-key.js.map +1 -1
  328. package/dist/profile/update-service.d.ts.map +1 -1
  329. package/dist/profile/update-service.js +2 -2
  330. package/dist/profile/update-service.js.map +1 -1
  331. package/dist/remote/object-store/convex-r2/storage.d.ts +2 -2
  332. package/dist/remote/object-store/convex-r2/storage.d.ts.map +1 -1
  333. package/dist/remote/object-store/index.d.ts +1 -1
  334. package/dist/remote/object-store/index.d.ts.map +1 -1
  335. package/dist/remote/object-store/s3/storage.d.ts +3 -3
  336. package/dist/remote/object-store/s3/storage.d.ts.map +1 -1
  337. package/dist/remote/object-store/s3/storage.js +1 -1
  338. package/dist/remote/object-store/types.d.ts +1 -1
  339. package/dist/remote/object-store/types.d.ts.map +1 -1
  340. package/dist/remote/relay/convex/group-server.d.ts +23 -21
  341. package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
  342. package/dist/remote/relay/convex/group-server.js +49 -21
  343. package/dist/remote/relay/convex/group-server.js.map +1 -1
  344. package/dist/remote/relay/convex/index.d.ts +9 -9
  345. package/dist/remote/relay/convex/index.d.ts.map +1 -1
  346. package/dist/remote/relay/convex/index.js +5 -5
  347. package/dist/remote/relay/convex/index.js.map +1 -1
  348. package/dist/remote/relay/convex/relay.d.ts +26 -18
  349. package/dist/remote/relay/convex/relay.d.ts.map +1 -1
  350. package/dist/remote/relay/convex/relay.js +82 -23
  351. package/dist/remote/relay/convex/relay.js.map +1 -1
  352. package/dist/remote/relay/convex/server/index.d.ts +2 -0
  353. package/dist/remote/relay/convex/server/index.d.ts.map +1 -0
  354. package/dist/remote/relay/convex/server/index.js +2 -0
  355. package/dist/remote/relay/convex/server/index.js.map +1 -0
  356. package/dist/remote/relay/convex/server.d.ts +150 -0
  357. package/dist/remote/relay/convex/server.d.ts.map +1 -0
  358. package/dist/remote/relay/convex/server.js +506 -0
  359. package/dist/remote/relay/convex/server.js.map +1 -0
  360. package/dist/remote/relay/index.d.ts +7 -7
  361. package/dist/remote/relay/index.d.ts.map +1 -1
  362. package/dist/remote/relay/index.js +6 -6
  363. package/dist/remote/relay/index.js.map +1 -1
  364. package/dist/remote/relay/mock/adapter.d.ts +36 -18
  365. package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
  366. package/dist/remote/relay/mock/adapter.js +75 -65
  367. package/dist/remote/relay/mock/adapter.js.map +1 -1
  368. package/dist/remote/relay/mock/failures.d.ts +1 -0
  369. package/dist/remote/relay/mock/failures.d.ts.map +1 -1
  370. package/dist/remote/relay/mock/failures.js +5 -0
  371. package/dist/remote/relay/mock/failures.js.map +1 -1
  372. package/dist/remote/relay/mock/group-server.d.ts +9 -0
  373. package/dist/remote/relay/mock/group-server.d.ts.map +1 -0
  374. package/dist/remote/relay/mock/group-server.js +9 -0
  375. package/dist/remote/relay/mock/group-server.js.map +1 -0
  376. package/dist/remote/relay/mock/index.d.ts +3 -3
  377. package/dist/remote/relay/mock/index.d.ts.map +1 -1
  378. package/dist/remote/relay/mock/index.js +3 -3
  379. package/dist/remote/relay/mock/index.js.map +1 -1
  380. package/dist/remote/relay/types.d.ts +56 -25
  381. package/dist/remote/relay/types.d.ts.map +1 -1
  382. package/dist/remote/relay/types.js +2 -2
  383. package/dist/types/api.d.ts +4 -4
  384. package/dist/types/api.d.ts.map +1 -1
  385. package/dist/types/messages.d.ts +1 -1
  386. package/dist/types/protocol-config.d.ts +17 -2
  387. package/dist/types/protocol-config.d.ts.map +1 -1
  388. package/dist/types/protocol-config.js +17 -2
  389. package/dist/types/protocol-config.js.map +1 -1
  390. package/dist/utils/retry.d.ts +2 -2
  391. package/dist/utils/retry.d.ts.map +1 -1
  392. package/dist/utils/retry.js +17 -0
  393. package/dist/utils/retry.js.map +1 -1
  394. package/docs/CLIENT_COMPOSITION.md +3 -3
  395. package/docs/DEVIATIONS.md +69 -50
  396. package/docs/GETTING_STARTED.md +3 -3
  397. package/docs/INTERFACES.md +22 -22
  398. package/docs/PACKAGE_SURFACE.md +15 -10
  399. package/docs/RECIPES.md +4 -4
  400. package/docs/api/classes/EndorsementManager.md +19 -1
  401. package/docs/api/classes/{SignalBlockingManager.md → SignalProtocolBlockingManager.md} +5 -5
  402. package/docs/api/classes/SignalProtocolClient.md +78 -78
  403. package/docs/api/functions/createDefaultSignalProtocolContentAdapter.md +13 -0
  404. package/docs/api/functions/{createDefaultSignalLogger.md → createDefaultSignalProtocolLogger.md} +5 -5
  405. package/docs/api/functions/createGroupId.md +1 -1
  406. package/docs/api/functions/decodeGroupTrustRoot.md +21 -0
  407. package/docs/api/functions/encodeGroupTrustRoot.md +28 -0
  408. package/docs/api/functions/extractGroupId.md +2 -2
  409. package/docs/api/functions/isGroupId.md +1 -1
  410. package/docs/api/functions/{resolveSignalLogger.md → resolveSignalProtocolLogger.md} +5 -5
  411. package/docs/api/interfaces/GroupTrustRoot.md +33 -0
  412. package/docs/api/interfaces/IProtocolStore.md +1 -1
  413. package/docs/api/interfaces/IRelayGroupServer.md +60 -0
  414. package/docs/api/interfaces/ISenderKeyStore.md +1 -1
  415. package/docs/api/interfaces/ISesameStore.md +1 -1
  416. package/docs/api/interfaces/ISignalProtocolClient.md +1 -1
  417. package/docs/api/interfaces/{ISignalLocalSecretVault.md → ISignalProtocolLocalSecretVault.md} +2 -2
  418. package/docs/api/interfaces/{ISignalLocalStore.md → ISignalProtocolLocalStore.md} +2 -2
  419. package/docs/api/interfaces/{ISignalRelayServer.md → ISignalProtocolRelayServer.md} +11 -3
  420. package/docs/api/interfaces/{InspectedSignalContent.md → InspectedSignalProtocolContent.md} +2 -2
  421. package/docs/api/interfaces/MLKEMBraidAgentState.md +1 -1
  422. package/docs/api/interfaces/MessageHeader.md +1 -1
  423. package/docs/api/interfaces/PreKeyMaintenanceStore.md +2 -2
  424. package/docs/api/interfaces/SealedSenderConfig.md +2 -2
  425. package/docs/api/interfaces/{SignalBlockingHooks.md → SignalProtocolBlockingHooks.md} +2 -2
  426. package/docs/api/interfaces/SignalProtocolBlockingManagerOptions.md +31 -0
  427. package/docs/api/interfaces/{SignalBlockingMirror.md → SignalProtocolBlockingMirror.md} +2 -2
  428. package/docs/api/interfaces/{SignalBlockingStore.md → SignalProtocolBlockingStore.md} +2 -2
  429. package/docs/api/interfaces/SignalProtocolClientAdapterConfig.md +3 -3
  430. package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +69 -31
  431. package/docs/api/interfaces/SignalProtocolClientConfig.md +93 -37
  432. package/docs/api/interfaces/SignalProtocolClientHooks.md +1 -1
  433. package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +16 -0
  434. package/docs/api/interfaces/SignalProtocolClientMediaConfig.md +2 -2
  435. package/docs/api/interfaces/{SignalContentAdapter.md → SignalProtocolContentAdapter.md} +4 -4
  436. package/docs/api/interfaces/{SignalRemoteObjectStore.md → SignalProtocolRemoteObjectStore.md} +2 -2
  437. package/docs/api/namespaces/blocking/README.md +10 -10
  438. package/docs/api/namespaces/keys/functions/generateKemOneTimePreKeys.md +1 -1
  439. package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentOptions.md +1 -1
  440. package/docs/api/namespaces/media/interfaces/ExecuteMediaAttachmentJobOptions.md +1 -1
  441. package/docs/api/namespaces/media/interfaces/PrepareMediaAttachmentUploadOptions.md +1 -1
  442. package/docs/api/namespaces/media/interfaces/ResolveMediaAttachmentOptions.md +1 -1
  443. package/docs/api/type-aliases/GroupId.md +2 -2
  444. package/docs/api/variables/GROUP_ID_PREFIX.md +11 -0
  445. package/docs/api/variables/GROUP_TRUST_ROOT_VERSION.md +11 -0
  446. package/docs/api/variables/MAX_RECEIVER_CHAINS.md +1 -1
  447. package/docs/api/variables/ONE_TIME_PREKEY_BATCH_SIZE.md +1 -1
  448. package/docs/api/variables/{defaultSignalLogger.md → defaultSignalProtocolLogger.md} +5 -5
  449. package/files/README.md +1 -1
  450. package/groups/README.md +16 -5
  451. package/local/store/README.md +10 -10
  452. package/local/store/expo/README.md +5 -5
  453. package/local/store/mock/README.md +1 -1
  454. package/local/store/node/README.md +1 -1
  455. package/local/store/react-native/README.md +1 -1
  456. package/local/store/web/README.md +1 -1
  457. package/local/vault/README.md +3 -3
  458. package/package.json +13 -2
  459. package/remote/README.md +19 -19
  460. package/remote/object-store/README.md +3 -3
  461. package/remote/object-store/convex-r2/README.md +1 -1
  462. package/remote/object-store/s3/README.md +1 -1
  463. package/remote/relay/README.md +2 -2
  464. package/remote/relay/convex/README.md +10 -4
  465. package/remote/relay/convex/server/README.md +146 -0
  466. package/remote/relay/mock/README.md +1 -1
  467. package/scripts/oe-groups.mjs +142 -0
  468. package/types/README.md +1 -1
  469. package/dist/internal/groups-v2/access-control.d.ts +0 -108
  470. package/dist/internal/groups-v2/access-control.d.ts.map +0 -1
  471. package/dist/internal/groups-v2/access-control.js +0 -191
  472. package/dist/internal/groups-v2/access-control.js.map +0 -1
  473. package/dist/internal/groups-v2/change-actions.d.ts +0 -40
  474. package/dist/internal/groups-v2/change-actions.d.ts.map +0 -1
  475. package/dist/internal/groups-v2/change-actions.js +0 -363
  476. package/dist/internal/groups-v2/change-actions.js.map +0 -1
  477. package/dist/internal/groups-v2/encrypted-state.d.ts.map +0 -1
  478. package/dist/internal/groups-v2/encrypted-state.js.map +0 -1
  479. package/dist/internal/groups-v2/index.d.ts +0 -19
  480. package/dist/internal/groups-v2/index.d.ts.map +0 -1
  481. package/dist/internal/groups-v2/index.js +0 -11
  482. package/dist/internal/groups-v2/index.js.map +0 -1
  483. package/dist/internal/groups-v2/invite-link.d.ts.map +0 -1
  484. package/dist/internal/groups-v2/invite-link.js.map +0 -1
  485. package/dist/internal/groups-v2/manager.d.ts.map +0 -1
  486. package/dist/internal/groups-v2/manager.js +0 -1095
  487. package/dist/internal/groups-v2/manager.js.map +0 -1
  488. package/dist/internal/groups-v2/types.d.ts.map +0 -1
  489. package/dist/internal/groups-v2/types.js.map +0 -1
  490. package/docs/api/functions/createDefaultSignalContentAdapter.md +0 -13
  491. package/docs/api/interfaces/SignalBlockingManagerOptions.md +0 -31
  492. package/docs/api/variables/GROUP_V2_PREFIX.md +0 -11
  493. /package/dist/internal/{groups-v2 → groups}/invite-link.d.ts +0 -0
  494. /package/dist/internal/{groups-v2 → groups}/invite-link.js +0 -0
@@ -1,6 +1,6 @@
1
1
  # Expo Store
2
2
 
3
- `ExpoSignalStore` implements `ISignalLocalStore` for Expo and React Native with
3
+ `ExpoSignalProtocolStore` implements `ISignalProtocolLocalStore` for Expo and React Native with
4
4
  an application-owned SQLite/Drizzle database and a database key held through
5
5
  the local secret-vault boundary.
6
6
 
@@ -20,7 +20,7 @@ the first query:
20
20
 
21
21
  ```ts
22
22
  import {
23
- configureSignalExpoDbBindings,
23
+ configureSignalProtocolExpoDbBindings,
24
24
  } from "@open-e2ee/signal-protocol-sdk/local/store/expo/db";
25
25
  import {
26
26
  getDatabaseKeyManager,
@@ -32,18 +32,18 @@ await keyManager.initialize();
32
32
  const sqlCipherPassword = await keyManager.getPassword();
33
33
 
34
34
  const { rawDatabase, drizzleDatabase } =
35
- await appDatabase.openEncryptedSignalDatabase({
35
+ await appDatabase.openEncryptedSignalProtocolDatabase({
36
36
  password: sqlCipherPassword,
37
37
  schema: signalSchema,
38
38
  });
39
39
 
40
- configureSignalExpoDbBindings({
40
+ configureSignalProtocolExpoDbBindings({
41
41
  getDrizzle: async () => drizzleDatabase,
42
42
  getRawDatabase: () => rawDatabase,
43
43
  });
44
44
  ```
45
45
 
46
- `appDatabase.openEncryptedSignalDatabase` represents application-owned database
46
+ `appDatabase.openEncryptedSignalProtocolDatabase` represents application-owned database
47
47
  bootstrap. It must enable SQLCipher through the `expo-sqlite` native
48
48
  configuration, apply the supplied key before schema access, create or migrate
49
49
  the exported tables, and return the matching raw and Drizzle handles. SQLCipher
@@ -1,6 +1,6 @@
1
1
  # In-Memory Store
2
2
 
3
- `MockSignalStore` implements `ISignalLocalStore` in memory for examples, local
3
+ `MockSignalProtocolStore` implements `ISignalProtocolLocalStore` in memory for examples, local
4
4
  development, and deterministic application prototypes.
5
5
 
6
6
  Real protocol and cryptography; simulated in-memory infrastructure.
@@ -1,6 +1,6 @@
1
1
  # Node Store
2
2
 
3
- `NodeSignalStore` implements `ISignalLocalStore` for Node.js using encrypted,
3
+ `NodeSignalProtocolStore` implements `ISignalProtocolLocalStore` for Node.js using encrypted,
4
4
  crash-durable filesystem state.
5
5
 
6
6
  ## Why it exists
@@ -1,6 +1,6 @@
1
1
  # Bare React Native Store
2
2
 
3
- `ReactNativeSignalStore` implements `ISignalLocalStore` for bare React Native
3
+ `ReactNativeSignalProtocolStore` implements `ISignalProtocolLocalStore` for bare React Native
4
4
  through an application-provided persistent key-value backend.
5
5
 
6
6
  ## Why it exists
@@ -1,6 +1,6 @@
1
1
  # IndexedDB Store
2
2
 
3
- `IndexedDbSignalStore` implements the full `ISignalLocalStore` contract for web
3
+ `IndexedDbSignalProtocolStore` implements the full `ISignalProtocolLocalStore` contract for web
4
4
  browsers using IndexedDB and Web Crypto.
5
5
 
6
6
  ## Why it exists
@@ -7,16 +7,16 @@ The local secret vault stores small bootstrap secrets through a minimal
7
7
 
8
8
  Platform secret managers are appropriate for tiny keys and bootstrap values,
9
9
  but not full session databases. Separating the vault from
10
- `ISignalLocalStore` keeps platform limits explicit and lets a local store use a
10
+ `ISignalProtocolLocalStore` keeps platform limits explicit and lets a local store use a
11
11
  vault-held wrapping key without placing every protocol record in the platform
12
12
  keychain.
13
13
 
14
14
  ## Expo usage
15
15
 
16
16
  ```ts
17
- import { ExpoSecureStoreSignalSecretVault } from "@open-e2ee/signal-protocol-sdk/local/vault/expo-secure-store";
17
+ import { ExpoSecureStoreSignalProtocolSecretVault } from "@open-e2ee/signal-protocol-sdk/local/vault/expo-secure-store";
18
18
 
19
- const vault = new ExpoSecureStoreSignalSecretVault();
19
+ const vault = new ExpoSecureStoreSignalProtocolSecretVault();
20
20
 
21
21
  await vault.setSecret("signal-store-wrapping-key", wrappingKey);
22
22
  const restored = await vault.getSecret("signal-store-wrapping-key");
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-e2ee/signal-protocol-sdk",
3
- "version": "0.1.0-alpha.5",
3
+ "version": "0.1.0-alpha.7",
4
4
  "description": "Signal Protocol E2EE SDK for TypeScript — Expo, React Native, browser, and Node. Post-quantum PQXDH and Double Ratchet.",
5
5
  "keywords": [
6
6
  "open-e2ee",
@@ -43,6 +43,9 @@
43
43
  "main": "./dist/index.js",
44
44
  "module": "./dist/index.js",
45
45
  "types": "./dist/index.d.ts",
46
+ "bin": {
47
+ "oe-groups": "./scripts/oe-groups.mjs"
48
+ },
46
49
  "exports": {
47
50
  ".": {
48
51
  "types": "./dist/index.d.ts",
@@ -60,6 +63,10 @@
60
63
  "types": "./dist/remote/relay/convex/relay.d.ts",
61
64
  "default": "./dist/remote/relay/convex/relay.js"
62
65
  },
66
+ "./remote/relay/convex/server": {
67
+ "types": "./dist/remote/relay/convex/server/index.d.ts",
68
+ "default": "./dist/remote/relay/convex/server/index.js"
69
+ },
63
70
  "./remote/relay/mock": {
64
71
  "types": "./dist/remote/relay/mock/index.d.ts",
65
72
  "default": "./dist/remote/relay/mock/index.js"
@@ -321,8 +328,10 @@
321
328
  "remote/object-store/s3/README.md",
322
329
  "remote/relay/README.md",
323
330
  "remote/relay/convex/README.md",
331
+ "remote/relay/convex/server/README.md",
324
332
  "remote/relay/mock/README.md",
325
333
  "safety/README.md",
334
+ "scripts/oe-groups.mjs",
326
335
  "sealed-sender/README.md",
327
336
  "types/README.md",
328
337
  "username/README.md",
@@ -412,7 +421,8 @@
412
421
  "overrides": {
413
422
  "xcode": {
414
423
  "uuid": "11.1.1"
415
- }
424
+ },
425
+ "brace-expansion": "^5.0.8"
416
426
  },
417
427
  "devDependencies": {
418
428
  "@convex-dev/r2": "^0.10.2",
@@ -420,6 +430,7 @@
420
430
  "@types/node": "^22.0.0",
421
431
  "@types/react": "^19.0.0",
422
432
  "convex": "^1.42.3",
433
+ "convex-test": "^0.0.54",
423
434
  "drizzle-orm": "^0.45.1",
424
435
  "esbuild": "^0.27.0",
425
436
  "expo": "~55.0.27",
package/remote/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Remote Guide
2
2
 
3
- > Infrastructure | Implements `ISignalRelayServer` and `SignalRemoteObjectStore` | [Architecture](../ARCHITECTURE.md)
3
+ > Infrastructure | Implements `ISignalProtocolRelayServer` and `SignalProtocolRemoteObjectStore` | [Architecture](../ARCHITECTURE.md)
4
4
 
5
5
  The backend layer is responsible for server-owned protocol state: public
6
6
  prekeys, device registration, encrypted-envelope delivery, and provisioning
@@ -17,32 +17,32 @@ replaceable and prevent them from owning private keys or plaintext.
17
17
 
18
18
  ### Relay
19
19
 
20
- - `ConvexSignalRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/convex`
21
- - `MockSignalRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/mock`
22
- - custom implementations via `ISignalRelayServer`
20
+ - `ConvexSignalProtocolRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/convex`
21
+ - `MockSignalProtocolRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/mock`
22
+ - custom implementations via `ISignalProtocolRelayServer`
23
23
 
24
24
  ### Remote object storage
25
25
 
26
26
  - `ConvexR2ObjectStore` from `@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2`
27
27
  - `S3ObjectStore` from `@open-e2ee/signal-protocol-sdk/remote/object-store/s3`
28
- - custom implementations via `SignalRemoteObjectStore`
28
+ - custom implementations via `SignalProtocolRemoteObjectStore`
29
29
 
30
30
  ## Composition
31
31
 
32
32
  ```ts
33
33
  import { SignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
34
34
  import {
35
- ConvexSignalRelayServer,
36
- type ConvexSignalRelayApi,
35
+ ConvexSignalProtocolRelayServer,
36
+ type ConvexSignalProtocolRelayApi,
37
37
  } from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
38
- import { ExpoSignalStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
38
+ import { ExpoSignalProtocolStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
39
39
  import { api } from "../convex/_generated/api";
40
40
 
41
- const signalApi = api.signal satisfies ConvexSignalRelayApi;
41
+ const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
42
42
 
43
43
  const signal = await SignalProtocolClient.create(userId, {
44
- storage: new ExpoSignalStore(),
45
- relay: new ConvexSignalRelayServer(convex, signalApi, {
44
+ storage: new ExpoSignalProtocolStore(),
45
+ relay: new ConvexSignalProtocolRelayServer(convex, signalApi, {
46
46
  currentUserId: userId,
47
47
  }),
48
48
  });
@@ -50,7 +50,7 @@ const signal = await SignalProtocolClient.create(userId, {
50
50
 
51
51
  ## Relay Responsibilities
52
52
 
53
- An `ISignalRelayServer` implementation must preserve the package’s protocol semantics for:
53
+ An `ISignalProtocolRelayServer` implementation must preserve the package’s protocol semantics for:
54
54
 
55
55
  - identity and prekey upload
56
56
  - prekey bundle fetch
@@ -78,7 +78,7 @@ Bundle fetch must preserve one-time-prekey consumption semantics for concurrent
78
78
 
79
79
  ## Remote Object Storage
80
80
 
81
- `SignalRemoteObjectStore` is optional and only needed for encrypted attachment/file flows.
81
+ `SignalProtocolRemoteObjectStore` is optional and only needed for encrypted attachment/file flows.
82
82
 
83
83
  In practice, attachment and encrypted file support is a common consumer path,
84
84
  so object-store adapters should be treated as first-class integrations
@@ -190,22 +190,22 @@ needed to authorize and construct short-lived operations.
190
190
 
191
191
  ## Local development
192
192
 
193
- Use `MockSignalRelayServer` when multiple clients need a shared in-memory relay:
193
+ Use `MockSignalProtocolRelayServer` when multiple clients need a shared in-memory relay:
194
194
 
195
195
  ```ts
196
196
  import { SignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
197
- import { MockSignalRelayServer } from "@open-e2ee/signal-protocol-sdk/remote/relay/mock";
198
- import { MockSignalStore } from "@open-e2ee/signal-protocol-sdk/local/store/mock";
197
+ import { MockSignalProtocolRelayServer } from "@open-e2ee/signal-protocol-sdk/remote/relay/mock";
198
+ import { MockSignalProtocolStore } from "@open-e2ee/signal-protocol-sdk/local/store/mock";
199
199
 
200
- const relay = new MockSignalRelayServer();
200
+ const relay = new MockSignalProtocolRelayServer();
201
201
 
202
202
  const alice = await SignalProtocolClient.create("alice", {
203
- storage: new MockSignalStore(),
203
+ storage: new MockSignalProtocolStore(),
204
204
  relay,
205
205
  });
206
206
 
207
207
  const bob = await SignalProtocolClient.create("bob", {
208
- storage: new MockSignalStore(),
208
+ storage: new MockSignalProtocolStore(),
209
209
  relay,
210
210
  });
211
211
  ```
@@ -1,6 +1,6 @@
1
1
  # Remote Object Store
2
2
 
3
- `SignalRemoteObjectStore` is the provider-neutral client contract for uploading,
3
+ `SignalProtocolRemoteObjectStore` is the provider-neutral client contract for uploading,
4
4
  downloading, completing, and deleting encrypted byte objects through
5
5
  short-lived backend-brokered operations.
6
6
 
@@ -20,10 +20,10 @@ retry-stable requestId -> canonical objectId -> private provider key
20
20
 
21
21
  ```ts
22
22
  import type {
23
- SignalRemoteObjectStore,
23
+ SignalProtocolRemoteObjectStore,
24
24
  } from "@open-e2ee/signal-protocol-sdk/remote/object-store";
25
25
 
26
- const remoteObjectStore: SignalRemoteObjectStore = {
26
+ const remoteObjectStore: SignalProtocolRemoteObjectStore = {
27
27
  createUpload: (request) => appStorageApi.createUpload(request),
28
28
  createDownload: (request) => appStorageApi.createDownload(request),
29
29
  completeUpload: (request) => appStorageApi.completeUpload(request),
@@ -8,7 +8,7 @@ application's bucket, credentials, schema, authorization, or metadata model.
8
8
 
9
9
  The Convex client calls generated function references, while `@convex-dev/r2`
10
10
  operates inside the application backend. This adapter maps that generated API
11
- to `SignalRemoteObjectStore` without moving storage policy, provider keys, or
11
+ to `SignalProtocolRemoteObjectStore` without moving storage policy, provider keys, or
12
12
  component ownership into the SDK.
13
13
 
14
14
  ## Client usage
@@ -1,6 +1,6 @@
1
1
  # S3 Object Store
2
2
 
3
- The S3 adapter connects `SignalRemoteObjectStore` to an application-owned
3
+ The S3 adapter connects `SignalProtocolRemoteObjectStore` to an application-owned
4
4
  broker for Amazon S3 or a compatible object-storage service.
5
5
 
6
6
  ## Why it exists
@@ -1,6 +1,6 @@
1
1
  # Relay
2
2
 
3
- The relay module defines `ISignalRelayServer`, the application-backend contract
3
+ The relay module defines `ISignalProtocolRelayServer`, the application-backend contract
4
4
  for device discovery, public prekeys, encrypted envelopes, key rotation,
5
5
  provisioning, and related synchronization.
6
6
 
@@ -28,7 +28,7 @@ const client = await createSignalProtocolClient({
28
28
  await client.syncToServer();
29
29
  ```
30
30
 
31
- For production, implement `ISignalRelayServer` or use the
31
+ For production, implement `ISignalProtocolRelayServer` or use the
32
32
  [Convex adapter](./convex/README.md). The application backend must authenticate
33
33
  mutations, allocate linked-device IDs, consume one-time prekeys atomically,
34
34
  enforce access policy, and store only encrypted envelopes plus required routing
@@ -1,7 +1,7 @@
1
1
  # Convex Relay Adapter
2
2
 
3
3
  The Convex relay adapter maps an application-owned generated Convex API module
4
- to `ISignalRelayServer`.
4
+ to `ISignalProtocolRelayServer`.
5
5
 
6
6
  ## Why it exists
7
7
 
@@ -24,11 +24,11 @@ pass that namespace directly:
24
24
  import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
25
25
  import {
26
26
  convexRelay,
27
- type ConvexSignalRelayApi,
27
+ type ConvexSignalProtocolRelayApi,
28
28
  } from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
29
29
  import { api } from "../convex/_generated/api";
30
30
 
31
- const signalApi = api.signal satisfies ConvexSignalRelayApi;
31
+ const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
32
32
 
33
33
  const relay = convexRelay({
34
34
  convex,
@@ -43,9 +43,15 @@ const client = await createSignalProtocolClient({
43
43
  ```
44
44
 
45
45
  The generated `api.signal` namespace must expose the nested functions described
46
- by `ConvexSignalRelayApi`. Use `satisfies` to get a compile-time diagnostic
46
+ by `ConvexSignalProtocolRelayApi`. Use `satisfies` to get a compile-time diagnostic
47
47
  without widening the generated references.
48
48
 
49
+ To serve groups from this deployment, also mount the
50
+ [Convex group server](./server/README.md) inside the same namespace
51
+ (`convex/signal/groups.ts` and `convex/signal/zkAuth.ts`); the relay
52
+ advertises its `groupServer` capability only when both modules are
53
+ configured.
54
+
49
55
  Public-key reads may be available to authenticated peers, but every write must
50
56
  derive ownership from server-side authentication rather than trusting a
51
57
  client-supplied user ID.
@@ -0,0 +1,146 @@
1
+ # Convex group server
2
+
3
+ This server-only subpath provides the production group-server implementation
4
+ for Convex. It owns canonical encrypted group state, immutable signed changes,
5
+ per-version signed snapshots, anonymous group authorization, credential
6
+ issuance, and group-send endorsements.
7
+
8
+ Import it from:
9
+
10
+ ```ts
11
+ import {
12
+ convexGroupServerTables,
13
+ defineConvexGroupServer,
14
+ } from "@open-e2ee/signal-protocol-sdk/remote/relay/convex/server";
15
+ ```
16
+
17
+ ## Schema
18
+
19
+ The component owns three package-scoped tables. Add them to the app schema:
20
+
21
+ ```ts
22
+ // convex/schema.ts
23
+ import { defineSchema } from "convex/server";
24
+ import {
25
+ convexGroupServerTables,
26
+ } from "@open-e2ee/signal-protocol-sdk/remote/relay/convex/server";
27
+
28
+ export default defineSchema({
29
+ ...convexGroupServerTables,
30
+ // App-owned tables...
31
+ });
32
+ ```
33
+
34
+ The tables store the latest canonical encrypted state, the exact accepted and
35
+ signed action bytes, and every historical encrypted snapshot with its cached
36
+ S14 baseline signature. They never store the group master key, group secret
37
+ parameters, plaintext group attributes, or the server secret.
38
+
39
+ Storage grows with one full encrypted snapshot per accepted version and is
40
+ never pruned. Old snapshots are load-bearing: `getGroupChanges` serves signed
41
+ history from them, so deleting rows breaks catch-up for clients behind that
42
+ version. A snapshot-compaction protocol is future work; budget storage as
43
+ O(versions × state size) per group.
44
+
45
+ ## Functions
46
+
47
+ The relay reads these functions through the same generated namespace as the
48
+ rest of the protocol API — `api.signal` in the
49
+ [Convex relay adapter](../README.md). The modules therefore must live inside
50
+ that namespace: `convex/signal/groups.ts` and `convex/signal/zkAuth.ts`, not
51
+ at the top of `convex/`. Both `groups` and `zkAuth` are optional on
52
+ `ConvexSignalProtocolRelayApi`, so a wrong location still compiles; the relay
53
+ then reports the missing `groupServer` capability on the first group call.
54
+
55
+ Create the handlers with the application's one authentication hook:
56
+
57
+ ```ts
58
+ // convex/signal/groups.ts
59
+ import {
60
+ defineConvexGroupServer,
61
+ } from "@open-e2ee/signal-protocol-sdk/remote/relay/convex/server";
62
+ import { resolveProtocolIdentity } from "../auth";
63
+
64
+ const server = defineConvexGroupServer({
65
+ identify: async (ctx) => {
66
+ const identity = await resolveProtocolIdentity(ctx);
67
+ return {
68
+ aciBytes: identity.aciBytes,
69
+ pniBytes: identity.pniBytes,
70
+ };
71
+ },
72
+ });
73
+
74
+ export const {
75
+ createGroup,
76
+ getGroup,
77
+ getGroupJoinInfo,
78
+ getGroupChanges,
79
+ submitGroupChange,
80
+ refreshGroupSendEndorsements,
81
+ } = server;
82
+ ```
83
+
84
+ Credential functions can be mounted from a second module so the generated API
85
+ matches `ConvexSignalProtocolRelayApi`:
86
+
87
+ ```ts
88
+ // convex/signal/zkAuth.ts
89
+ import {
90
+ defineConvexGroupServer,
91
+ } from "@open-e2ee/signal-protocol-sdk/remote/relay/convex/server";
92
+ import { resolveProtocolIdentity } from "../auth";
93
+
94
+ const server = defineConvexGroupServer({
95
+ identify: async (ctx) => {
96
+ const identity = await resolveProtocolIdentity(ctx);
97
+ return {
98
+ aciBytes: identity.aciBytes,
99
+ pniBytes: identity.pniBytes,
100
+ };
101
+ },
102
+ });
103
+
104
+ export const {
105
+ issueAuthCredentialMutation,
106
+ issueProfileKeyCredentialMutation,
107
+ } = server;
108
+ ```
109
+
110
+ The `identify` hook drives issuance only. Group reads and writes never trust the
111
+ app session for membership; they verify the supplied zero-knowledge
112
+ presentation and enforce S1–S14 over ciphertext.
113
+
114
+ `identify` must return the authenticated account's real ACI, and its real PNI
115
+ or **no PNI at all**. Never substitute a shared placeholder value for accounts
116
+ without a PNI: credentials are matched by ACI-or-PNI alias, so a constant PNI
117
+ issued to every account would let any authenticated user act on any
118
+ PNI-addressed pending membership. An absent PNI must be absent.
119
+
120
+ ## Secret initialization and pinned trust root
121
+
122
+ From the Convex app directory, run:
123
+
124
+ ```sh
125
+ npx oe-groups trust-root
126
+ ```
127
+
128
+ Add `--prod` for the default production deployment or
129
+ `--deployment <name-or-reference>` for another deployment. The command checks
130
+ `OE_GROUPS_SERVER_SECRET`, generates a cryptographically random 32-byte seed
131
+ only when it is absent, writes it to the selected Convex deployment through
132
+ stdin, and prints the base64 serialized trust root. Pin that printed value in
133
+ the client build. Never fetch and trust it at runtime.
134
+
135
+ The seed remains in the Convex environment and deterministically derives all
136
+ four server keypairs. It is never written to a Convex table or log. Back up the
137
+ deployment secret: deleting or replacing it rotates the trust root and strands
138
+ clients pinned to the previous deployment.
139
+
140
+ ## Profile-key issuance threat model
141
+
142
+ `issueProfileKeyCredentialMutation` receives the raw 32-byte profile key. The
143
+ group server therefore sees the plaintext profile key at issuance time. The
144
+ credential proof hides it in later group presentations, but issuance in this
145
+ credential layer is not blinded. Blinded issuance is a future credential-layer
146
+ candidate and is explicitly outside this component's scope.
@@ -1,6 +1,6 @@
1
1
  # In-Memory Relay
2
2
 
3
- `MockSignalRelayServer` implements `ISignalRelayServer` in memory for examples
3
+ `MockSignalProtocolRelayServer` implements `ISignalProtocolRelayServer` in memory for examples
4
4
  and local application development.
5
5
 
6
6
  Real protocol and cryptography; simulated in-memory infrastructure.
@@ -0,0 +1,142 @@
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
+ ] = await Promise.all([
98
+ // pathToFileURL: dynamic import of a bare absolute path fails on
99
+ // Windows, where the ESM loader requires a file:// URL.
100
+ import(
101
+ pathToFileURL(
102
+ path.join(
103
+ scriptDirectory,
104
+ '../dist/internal/protocol/zk/groups/server-params.js'
105
+ )
106
+ ).href
107
+ ),
108
+ import(
109
+ pathToFileURL(
110
+ path.join(
111
+ scriptDirectory,
112
+ '../dist/internal/groups/trust-root.js'
113
+ )
114
+ ).href
115
+ ),
116
+ ]);
117
+ const secretParams = generateServerSecretParams(seed);
118
+ seed.fill(0);
119
+ const publicParams = getServerPublicParams(secretParams);
120
+ const trustRoot = encodeGroupTrustRoot({
121
+ credentialPublicKey: publicParams.credentialPublicKey,
122
+ serverSigningPublicKey: publicParams.signingPublicKey,
123
+ profileKeyCredentialPublicKey:
124
+ publicParams.profileKeyCredentialPublicKey,
125
+ endorsementRootPublicKey: publicParams.endorsementPublicKey,
126
+ });
127
+ process.stdout.write(`${Buffer.from(trustRoot).toString('base64')}\n`);
128
+ }
129
+
130
+ const [command, ...args] = process.argv.slice(2);
131
+ if (command !== 'trust-root') {
132
+ usage(command ? `Unknown command: ${command}` : undefined);
133
+ } else {
134
+ try {
135
+ await printTrustRoot(args);
136
+ } catch (error) {
137
+ process.stderr.write(
138
+ `${error instanceof Error ? error.message : String(error)}\n`
139
+ );
140
+ process.exitCode = 1;
141
+ }
142
+ }
package/types/README.md CHANGED
@@ -14,7 +14,7 @@ contracts they validate.
14
14
 
15
15
  ```ts
16
16
  import type {
17
- ISignalLocalStore,
17
+ ISignalProtocolLocalStore,
18
18
  ISignalProtocolClient,
19
19
  SignalProtocolConfig,
20
20
  } from "@open-e2ee/signal-protocol-sdk/types";