@open-e2ee/signal-protocol-sdk 8.1.0 → 9.0.0

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 (387) hide show
  1. package/ADAPTERS.md +13 -31
  2. package/ARCHITECTURE.md +5 -7
  3. package/CHANGELOG.md +258 -0
  4. package/README.md +36 -48
  5. package/SECURITY.md +2 -2
  6. package/client/README.md +9 -0
  7. package/device/README.md +16 -7
  8. package/dist/client/client.d.ts +25 -16
  9. package/dist/client/client.d.ts.map +1 -1
  10. package/dist/client/client.js +115 -95
  11. package/dist/client/client.js.map +1 -1
  12. package/dist/client/config.d.ts +10 -17
  13. package/dist/client/config.d.ts.map +1 -1
  14. package/dist/client/config.js.map +1 -1
  15. package/dist/client/event-hooks.js +27 -0
  16. package/dist/client/event-hooks.js.map +1 -1
  17. package/dist/client/group-outbox.d.ts +31 -1
  18. package/dist/client/group-outbox.d.ts.map +1 -1
  19. package/dist/client/group-outbox.js +67 -58
  20. package/dist/client/group-outbox.js.map +1 -1
  21. package/dist/client/group-receive-authorization.d.ts +5 -0
  22. package/dist/client/group-receive-authorization.d.ts.map +1 -0
  23. package/dist/client/group-receive-authorization.js +32 -0
  24. package/dist/client/group-receive-authorization.js.map +1 -0
  25. package/dist/client/group-sender-key-operations.d.ts +15 -0
  26. package/dist/client/group-sender-key-operations.d.ts.map +1 -0
  27. package/dist/client/group-sender-key-operations.js +31 -0
  28. package/dist/client/group-sender-key-operations.js.map +1 -0
  29. package/dist/client/groups.d.ts +3 -1
  30. package/dist/client/groups.d.ts.map +1 -1
  31. package/dist/client/groups.js +5 -2
  32. package/dist/client/groups.js.map +1 -1
  33. package/dist/client/hosted-anonymous-delivery.d.ts +9 -1
  34. package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -1
  35. package/dist/client/hosted-anonymous-delivery.js +61 -22
  36. package/dist/client/hosted-anonymous-delivery.js.map +1 -1
  37. package/dist/client/hosted-transport.d.ts +7 -0
  38. package/dist/client/hosted-transport.d.ts.map +1 -1
  39. package/dist/client/hosted-transport.js +44 -6
  40. package/dist/client/hosted-transport.js.map +1 -1
  41. package/dist/client/key-rotation.d.ts.map +1 -1
  42. package/dist/client/key-rotation.js +2 -4
  43. package/dist/client/key-rotation.js.map +1 -1
  44. package/dist/client/prekeys.d.ts.map +1 -1
  45. package/dist/client/prekeys.js +1 -1
  46. package/dist/client/prekeys.js.map +1 -1
  47. package/dist/client/relay-device-refusal.d.ts +32 -0
  48. package/dist/client/relay-device-refusal.d.ts.map +1 -0
  49. package/dist/client/relay-device-refusal.js +36 -0
  50. package/dist/client/relay-device-refusal.js.map +1 -0
  51. package/dist/client/relay-subscription.d.ts +2 -0
  52. package/dist/client/relay-subscription.d.ts.map +1 -1
  53. package/dist/client/relay-subscription.js +3 -1
  54. package/dist/client/relay-subscription.js.map +1 -1
  55. package/dist/client/relay-work.d.ts +26 -0
  56. package/dist/client/relay-work.d.ts.map +1 -1
  57. package/dist/client/relay-work.js +37 -0
  58. package/dist/client/relay-work.js.map +1 -1
  59. package/dist/client/sealed-sender.d.ts.map +1 -1
  60. package/dist/client/sealed-sender.js +12 -17
  61. package/dist/client/sealed-sender.js.map +1 -1
  62. package/dist/client/sender-key-distribution.d.ts.map +1 -1
  63. package/dist/client/sender-key-distribution.js +4 -1
  64. package/dist/client/sender-key-distribution.js.map +1 -1
  65. package/dist/client/sessions.d.ts.map +1 -1
  66. package/dist/client/sessions.js +2 -4
  67. package/dist/client/sessions.js.map +1 -1
  68. package/dist/client/signal-service-cipher.d.ts +94 -6
  69. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  70. package/dist/client/signal-service-cipher.js +483 -184
  71. package/dist/client/signal-service-cipher.js.map +1 -1
  72. package/dist/client/types.d.ts +7 -0
  73. package/dist/client/types.d.ts.map +1 -1
  74. package/dist/client/types.js.map +1 -1
  75. package/dist/index.d.ts +27 -21
  76. package/dist/index.d.ts.map +1 -1
  77. package/dist/index.js +8 -17
  78. package/dist/index.js.map +1 -1
  79. package/dist/internal/crypto/pq/kyber.d.ts +1 -1
  80. package/dist/internal/crypto/pq/kyber.js +1 -1
  81. package/dist/internal/encoding/proto/sender-key-message.d.ts +2 -2
  82. package/dist/internal/encoding/proto/sender-key-message.d.ts.map +1 -1
  83. package/dist/internal/encoding/proto/sender-key-message.js +5 -2
  84. package/dist/internal/encoding/proto/sender-key-message.js.map +1 -1
  85. package/dist/internal/groups/manager.d.ts.map +1 -1
  86. package/dist/internal/groups/manager.js +5 -2
  87. package/dist/internal/groups/manager.js.map +1 -1
  88. package/dist/internal/groups/wire.d.ts +0 -2
  89. package/dist/internal/groups/wire.d.ts.map +1 -1
  90. package/dist/internal/groups/wire.js +0 -6
  91. package/dist/internal/groups/wire.js.map +1 -1
  92. package/dist/internal/manager/manager.d.ts +8 -7
  93. package/dist/internal/manager/manager.d.ts.map +1 -1
  94. package/dist/internal/manager/manager.js +34 -37
  95. package/dist/internal/manager/manager.js.map +1 -1
  96. package/dist/internal/protocol/double-ratchet/ratchet.d.ts +0 -17
  97. package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
  98. package/dist/internal/protocol/double-ratchet/ratchet.js +0 -4
  99. package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
  100. package/dist/internal/protocol/sealed-sender/certificate.d.ts +2 -32
  101. package/dist/internal/protocol/sealed-sender/certificate.d.ts.map +1 -1
  102. package/dist/internal/protocol/sealed-sender/certificate.js +4 -85
  103. package/dist/internal/protocol/sealed-sender/certificate.js.map +1 -1
  104. package/dist/internal/protocol/sealed-sender/index.d.ts +2 -2
  105. package/dist/internal/protocol/sealed-sender/index.d.ts.map +1 -1
  106. package/dist/internal/protocol/sealed-sender/index.js +2 -6
  107. package/dist/internal/protocol/sealed-sender/index.js.map +1 -1
  108. package/dist/internal/protocol/sealed-sender/proto/index.d.ts +0 -19
  109. package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
  110. package/dist/internal/protocol/sealed-sender/proto/index.js +1 -48
  111. package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
  112. package/dist/internal/protocol/sender-keys/manager.d.ts +9 -13
  113. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  114. package/dist/internal/protocol/sender-keys/manager.js +90 -95
  115. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  116. package/dist/internal/protocol/spqr/index.d.ts +1 -1
  117. package/dist/internal/protocol/spqr/index.d.ts.map +1 -1
  118. package/dist/internal/protocol/spqr/index.js +2 -2
  119. package/dist/internal/protocol/spqr/index.js.map +1 -1
  120. package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.d.ts +0 -2
  121. package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.d.ts.map +1 -1
  122. package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.js +4 -12
  123. package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.js.map +1 -1
  124. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts.map +1 -1
  125. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.js +1 -3
  126. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.js.map +1 -1
  127. package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts +1 -0
  128. package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts.map +1 -1
  129. package/dist/internal/protocol/spqr/serialize.d.ts.map +1 -1
  130. package/dist/internal/protocol/spqr/serialize.js +1 -4
  131. package/dist/internal/protocol/spqr/serialize.js.map +1 -1
  132. package/dist/internal/protocol/spqr/spqr.d.ts +1 -1
  133. package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
  134. package/dist/internal/protocol/spqr/spqr.js +2 -3
  135. package/dist/internal/protocol/spqr/spqr.js.map +1 -1
  136. package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
  137. package/dist/internal/protocol/x3dh/x3dh.js +1 -1
  138. package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
  139. package/dist/internal/protocol/zk/credentials/credentials.d.ts +3 -54
  140. package/dist/internal/protocol/zk/credentials/credentials.d.ts.map +1 -1
  141. package/dist/internal/protocol/zk/credentials/credentials.js +4 -91
  142. package/dist/internal/protocol/zk/credentials/credentials.js.map +1 -1
  143. package/dist/internal/protocol/zk/credentials/endorsements.d.ts +3 -64
  144. package/dist/internal/protocol/zk/credentials/endorsements.d.ts.map +1 -1
  145. package/dist/internal/protocol/zk/credentials/endorsements.js +4 -134
  146. package/dist/internal/protocol/zk/credentials/endorsements.js.map +1 -1
  147. package/dist/internal/protocol/zk/credentials/index.d.ts +3 -3
  148. package/dist/internal/protocol/zk/credentials/index.d.ts.map +1 -1
  149. package/dist/internal/protocol/zk/credentials/index.js +3 -3
  150. package/dist/internal/protocol/zk/credentials/index.js.map +1 -1
  151. package/dist/internal/protocol/zk/credentials/issuance.d.ts +3 -26
  152. package/dist/internal/protocol/zk/credentials/issuance.d.ts.map +1 -1
  153. package/dist/internal/protocol/zk/credentials/issuance.js +3 -80
  154. package/dist/internal/protocol/zk/credentials/issuance.js.map +1 -1
  155. package/dist/internal/protocol/zk/credentials/presentation.d.ts +4 -73
  156. package/dist/internal/protocol/zk/credentials/presentation.d.ts.map +1 -1
  157. package/dist/internal/protocol/zk/credentials/presentation.js +4 -152
  158. package/dist/internal/protocol/zk/credentials/presentation.js.map +1 -1
  159. package/dist/internal/protocol/zk/groups/auth-credential.d.ts +1 -61
  160. package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
  161. package/dist/internal/protocol/zk/groups/auth-credential.js +2 -196
  162. package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
  163. package/dist/internal/protocol/zk/groups/group-send-endorsement.d.ts +1 -86
  164. package/dist/internal/protocol/zk/groups/group-send-endorsement.d.ts.map +1 -1
  165. package/dist/internal/protocol/zk/groups/group-send-endorsement.js +1 -152
  166. package/dist/internal/protocol/zk/groups/group-send-endorsement.js.map +1 -1
  167. package/dist/internal/protocol/zk/groups/index.d.ts +4 -4
  168. package/dist/internal/protocol/zk/groups/index.d.ts.map +1 -1
  169. package/dist/internal/protocol/zk/groups/index.js +4 -4
  170. package/dist/internal/protocol/zk/groups/index.js.map +1 -1
  171. package/dist/internal/protocol/zk/groups/profile-key-credential.d.ts +2 -57
  172. package/dist/internal/protocol/zk/groups/profile-key-credential.d.ts.map +1 -1
  173. package/dist/internal/protocol/zk/groups/profile-key-credential.js +2 -174
  174. package/dist/internal/protocol/zk/groups/profile-key-credential.js.map +1 -1
  175. package/dist/internal/protocol/zk/groups/server-params.d.ts +8 -72
  176. package/dist/internal/protocol/zk/groups/server-params.d.ts.map +1 -1
  177. package/dist/internal/protocol/zk/groups/server-params.js +8 -108
  178. package/dist/internal/protocol/zk/groups/server-params.js.map +1 -1
  179. package/dist/internal/protocol/zk/proofs/sign.d.ts +1 -2
  180. package/dist/internal/protocol/zk/proofs/sign.d.ts.map +1 -1
  181. package/dist/internal/protocol/zk/proofs/sign.js +2 -11
  182. package/dist/internal/protocol/zk/proofs/sign.js.map +1 -1
  183. package/dist/internal/sesame/device-registry.d.ts +24 -4
  184. package/dist/internal/sesame/device-registry.d.ts.map +1 -1
  185. package/dist/internal/sesame/device-registry.js +55 -28
  186. package/dist/internal/sesame/device-registry.js.map +1 -1
  187. package/dist/internal/sesame/manager.d.ts +79 -11
  188. package/dist/internal/sesame/manager.d.ts.map +1 -1
  189. package/dist/internal/sesame/manager.js +381 -280
  190. package/dist/internal/sesame/manager.js.map +1 -1
  191. package/dist/internal/session/cipher.d.ts +0 -5
  192. package/dist/internal/session/cipher.d.ts.map +1 -1
  193. package/dist/internal/session/cipher.js +3 -9
  194. package/dist/internal/session/cipher.js.map +1 -1
  195. package/dist/internal/session/ratchet.d.ts.map +1 -1
  196. package/dist/internal/session/ratchet.js +0 -2
  197. package/dist/internal/session/ratchet.js.map +1 -1
  198. package/dist/internal/session/record-locks.d.ts +46 -0
  199. package/dist/internal/session/record-locks.d.ts.map +1 -0
  200. package/dist/internal/session/record-locks.js +72 -0
  201. package/dist/internal/session/record-locks.js.map +1 -0
  202. package/dist/local/store/expo/adapter.d.ts +8 -2
  203. package/dist/local/store/expo/adapter.d.ts.map +1 -1
  204. package/dist/local/store/expo/adapter.js +24 -3
  205. package/dist/local/store/expo/adapter.js.map +1 -1
  206. package/dist/local/store/expo/driver.d.ts +7 -0
  207. package/dist/local/store/expo/driver.d.ts.map +1 -1
  208. package/dist/local/store/expo/driver.js +16 -0
  209. package/dist/local/store/expo/driver.js.map +1 -1
  210. package/dist/local/store/key-value/adapter.d.ts +3 -3
  211. package/dist/local/store/key-value/adapter.d.ts.map +1 -1
  212. package/dist/local/store/key-value/adapter.js +91 -53
  213. package/dist/local/store/key-value/adapter.js.map +1 -1
  214. package/dist/local/store/key-value/backend-conformance.d.ts.map +1 -1
  215. package/dist/local/store/key-value/backend-conformance.js +25 -0
  216. package/dist/local/store/key-value/backend-conformance.js.map +1 -1
  217. package/dist/local/store/key-value/batch.d.ts +3 -1
  218. package/dist/local/store/key-value/batch.d.ts.map +1 -1
  219. package/dist/local/store/key-value/batch.js +9 -1
  220. package/dist/local/store/key-value/batch.js.map +1 -1
  221. package/dist/local/store/key-value/storage.d.ts +6 -0
  222. package/dist/local/store/key-value/storage.d.ts.map +1 -1
  223. package/dist/local/store/key-value/transactional-backend.d.ts +1 -1
  224. package/dist/local/store/key-value/transactional-backend.js +1 -1
  225. package/dist/local/store/memory/adapter.d.ts +13 -3
  226. package/dist/local/store/memory/adapter.d.ts.map +1 -1
  227. package/dist/local/store/memory/adapter.js +122 -73
  228. package/dist/local/store/memory/adapter.js.map +1 -1
  229. package/dist/local/store/reliability.d.ts +16 -0
  230. package/dist/local/store/reliability.d.ts.map +1 -1
  231. package/dist/local/store/reliability.js +58 -28
  232. package/dist/local/store/reliability.js.map +1 -1
  233. package/dist/local/store/sqlite/migrations.d.ts.map +1 -1
  234. package/dist/local/store/sqlite/migrations.js +18 -0
  235. package/dist/local/store/sqlite/migrations.js.map +1 -1
  236. package/dist/local/store/sqlite/models/skipped-sender-key.d.ts +3 -3
  237. package/dist/local/store/sqlite/models/skipped-sender-key.d.ts.map +1 -1
  238. package/dist/local/store/sqlite/models/skipped-sender-key.js +13 -17
  239. package/dist/local/store/sqlite/models/skipped-sender-key.js.map +1 -1
  240. package/dist/local/store/sqlite/store.d.ts +3 -3
  241. package/dist/local/store/sqlite/store.d.ts.map +1 -1
  242. package/dist/local/store/sqlite/store.js +53 -23
  243. package/dist/local/store/sqlite/store.js.map +1 -1
  244. package/dist/local/store/web/adapter.d.ts +3 -3
  245. package/dist/local/store/web/adapter.d.ts.map +1 -1
  246. package/dist/local/store/web/adapter.js +122 -73
  247. package/dist/local/store/web/adapter.js.map +1 -1
  248. package/dist/local/vault/electron-safe-storage.d.ts.map +1 -1
  249. package/dist/local/vault/electron-safe-storage.js +15 -2
  250. package/dist/local/vault/electron-safe-storage.js.map +1 -1
  251. package/dist/profile/index.d.ts +2 -1
  252. package/dist/profile/index.d.ts.map +1 -1
  253. package/dist/profile/index.js +2 -1
  254. package/dist/profile/index.js.map +1 -1
  255. package/dist/profile/own-profile-key.d.ts +42 -0
  256. package/dist/profile/own-profile-key.d.ts.map +1 -0
  257. package/dist/profile/own-profile-key.js +64 -0
  258. package/dist/profile/own-profile-key.js.map +1 -0
  259. package/dist/profile/profile-key.d.ts +1 -34
  260. package/dist/profile/profile-key.d.ts.map +1 -1
  261. package/dist/profile/profile-key.js +3 -63
  262. package/dist/profile/profile-key.js.map +1 -1
  263. package/dist/profile/update-service.js +1 -1
  264. package/dist/profile/update-service.js.map +1 -1
  265. package/dist/remote/relay/index.d.ts +4 -7
  266. package/dist/remote/relay/index.d.ts.map +1 -1
  267. package/dist/remote/relay/index.js +5 -7
  268. package/dist/remote/relay/index.js.map +1 -1
  269. package/dist/remote/relay/types.d.ts +3 -3
  270. package/dist/types/api.d.ts +29 -8
  271. package/dist/types/api.d.ts.map +1 -1
  272. package/dist/username/link.d.ts.map +1 -1
  273. package/dist/username/link.js +1 -5
  274. package/dist/username/link.js.map +1 -1
  275. package/dist/utils/bounded-fan-out.d.ts +99 -0
  276. package/dist/utils/bounded-fan-out.d.ts.map +1 -0
  277. package/dist/utils/bounded-fan-out.js +180 -0
  278. package/dist/utils/bounded-fan-out.js.map +1 -0
  279. package/dist/utils/keyed-lock.d.ts +16 -0
  280. package/dist/utils/keyed-lock.d.ts.map +1 -0
  281. package/dist/utils/keyed-lock.js +39 -0
  282. package/dist/utils/keyed-lock.js.map +1 -0
  283. package/dist/versions.d.ts +3 -3
  284. package/dist/versions.js +3 -3
  285. package/dist/zk/credentials.d.ts +2 -2
  286. package/dist/zk/credentials.js +2 -2
  287. package/dist/zk/groups.d.ts +3 -3
  288. package/dist/zk/groups.d.ts.map +1 -1
  289. package/dist/zk/groups.js +3 -3
  290. package/dist/zk/groups.js.map +1 -1
  291. package/docs/ASSURANCE.md +69 -28
  292. package/docs/CLIENT_COMPOSITION.md +9 -3
  293. package/docs/DEVIATIONS.md +45 -27
  294. package/docs/GETTING_STARTED.md +42 -320
  295. package/docs/INTERFACES.md +7 -7
  296. package/docs/PACKAGE_SURFACE.md +14 -16
  297. package/docs/RECIPES.md +6 -112
  298. package/groups/README.md +9 -1
  299. package/hooks/README.md +11 -2
  300. package/local/store/README.md +26 -6
  301. package/local/store/expo/README.md +18 -5
  302. package/local/store/key-value/README.md +5 -3
  303. package/local/store/node/README.md +2 -1
  304. package/local/store/web-sqlite/README.md +28 -8
  305. package/local/vault/README.md +21 -2
  306. package/package.json +1 -30
  307. package/remote/README.md +12 -78
  308. package/remote/object-store/convex-r2/README.md +20 -42
  309. package/remote/relay/README.md +21 -18
  310. package/zk/README.md +6 -7
  311. package/dist/client/dual-store.d.ts +0 -70
  312. package/dist/client/dual-store.d.ts.map +0 -1
  313. package/dist/client/dual-store.js +0 -123
  314. package/dist/client/dual-store.js.map +0 -1
  315. package/dist/client/multi-device.d.ts +0 -74
  316. package/dist/client/multi-device.d.ts.map +0 -1
  317. package/dist/client/multi-device.js +0 -105
  318. package/dist/client/multi-device.js.map +0 -1
  319. package/dist/groups/server.d.ts +0 -10
  320. package/dist/groups/server.d.ts.map +0 -1
  321. package/dist/groups/server.js +0 -6
  322. package/dist/groups/server.js.map +0 -1
  323. package/dist/internal/encoding/index.d.ts +0 -2
  324. package/dist/internal/encoding/index.d.ts.map +0 -1
  325. package/dist/internal/encoding/index.js +0 -2
  326. package/dist/internal/encoding/index.js.map +0 -1
  327. package/dist/internal/groups/server-engine.d.ts +0 -118
  328. package/dist/internal/groups/server-engine.d.ts.map +0 -1
  329. package/dist/internal/groups/server-engine.js +0 -1268
  330. package/dist/internal/groups/server-engine.js.map +0 -1
  331. package/dist/internal/protocol/index.d.ts +0 -24
  332. package/dist/internal/protocol/index.d.ts.map +0 -1
  333. package/dist/internal/protocol/index.js +0 -9
  334. package/dist/internal/protocol/index.js.map +0 -1
  335. package/dist/internal/protocol/sealed-sender/trust-root.d.ts +0 -56
  336. package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +0 -1
  337. package/dist/internal/protocol/sealed-sender/trust-root.js +0 -90
  338. package/dist/internal/protocol/sealed-sender/trust-root.js.map +0 -1
  339. package/dist/internal/protocol/triple-ratchet/index.d.ts +0 -21
  340. package/dist/internal/protocol/triple-ratchet/index.d.ts.map +0 -1
  341. package/dist/internal/protocol/triple-ratchet/index.js +0 -19
  342. package/dist/internal/protocol/triple-ratchet/index.js.map +0 -1
  343. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +0 -233
  344. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +0 -1
  345. package/dist/internal/protocol/triple-ratchet/ratchet.js +0 -254
  346. package/dist/internal/protocol/triple-ratchet/ratchet.js.map +0 -1
  347. package/dist/internal/protocol/zk/proofs/index.d.ts +0 -13
  348. package/dist/internal/protocol/zk/proofs/index.d.ts.map +0 -1
  349. package/dist/internal/protocol/zk/proofs/index.js +0 -7
  350. package/dist/internal/protocol/zk/proofs/index.js.map +0 -1
  351. package/dist/local/store/sqlite/index.d.ts +0 -20
  352. package/dist/local/store/sqlite/index.d.ts.map +0 -1
  353. package/dist/local/store/sqlite/index.js +0 -18
  354. package/dist/local/store/sqlite/index.js.map +0 -1
  355. package/dist/remote/object-store/convex-r2/server/index.d.ts +0 -2
  356. package/dist/remote/object-store/convex-r2/server/index.d.ts.map +0 -1
  357. package/dist/remote/object-store/convex-r2/server/index.js +0 -2
  358. package/dist/remote/object-store/convex-r2/server/index.js.map +0 -1
  359. package/dist/remote/object-store/convex-r2/server.d.ts +0 -129
  360. package/dist/remote/object-store/convex-r2/server.d.ts.map +0 -1
  361. package/dist/remote/object-store/convex-r2/server.js +0 -244
  362. package/dist/remote/object-store/convex-r2/server.js.map +0 -1
  363. package/dist/remote/relay/memory/adapter.d.ts +0 -252
  364. package/dist/remote/relay/memory/adapter.d.ts.map +0 -1
  365. package/dist/remote/relay/memory/adapter.js +0 -1058
  366. package/dist/remote/relay/memory/adapter.js.map +0 -1
  367. package/dist/remote/relay/memory/failures.d.ts +0 -58
  368. package/dist/remote/relay/memory/failures.d.ts.map +0 -1
  369. package/dist/remote/relay/memory/failures.js +0 -124
  370. package/dist/remote/relay/memory/failures.js.map +0 -1
  371. package/dist/remote/relay/memory/group-server.d.ts +0 -13
  372. package/dist/remote/relay/memory/group-server.d.ts.map +0 -1
  373. package/dist/remote/relay/memory/group-server.js +0 -19
  374. package/dist/remote/relay/memory/group-server.js.map +0 -1
  375. package/dist/remote/relay/memory/index.d.ts +0 -11
  376. package/dist/remote/relay/memory/index.d.ts.map +0 -1
  377. package/dist/remote/relay/memory/index.js +0 -7
  378. package/dist/remote/relay/memory/index.js.map +0 -1
  379. package/examples/browser/README.md +0 -35
  380. package/examples/browser/index.html +0 -27
  381. package/examples/browser/src/exchange.ts +0 -69
  382. package/examples/browser/src/main.ts +0 -63
  383. package/examples/browser/src/style.css +0 -9
  384. package/examples/browser/src/worker.ts +0 -10
  385. package/examples/browser/vite.config.ts +0 -9
  386. package/remote/relay/memory/README.md +0 -72
  387. package/scripts/oe-groups.mjs +0 -166
@@ -2,8 +2,10 @@
2
2
 
3
3
  > Navigation: [README](../README.md) | [ARCHITECTURE](../ARCHITECTURE.md) | **Getting Started**
4
4
 
5
- This guide is for app developers who understand end-to-end encryption but do
6
- not want to learn protocol internals before sending a message.
5
+ Use the OpenE2EE Signal Protocol SDK with the OpenE2EE Signal Protocol Relay
6
+ for authenticated delivery. The SDK owns device-local encryption and protocol
7
+ state. The Relay holds public key material, encrypted envelopes, and routing
8
+ metadata. The relay never needs message plaintext or device private keys.
7
9
 
8
10
  ## Install
9
11
 
@@ -11,313 +13,36 @@ not want to learn protocol internals before sending a message.
11
13
  npm install @open-e2ee/signal-protocol-sdk
12
14
  ```
13
15
 
14
- In this monorepo, consumers use the package as a workspace package. App consumers
15
- should also install any runtime dependencies their chosen adapters need, such as
16
- Expo packages.
16
+ Install the runtime dependencies that your device-local store requires.
17
+ The [adapter guide](../ADAPTERS.md) lists the supported stores.
17
18
 
18
19
  ## What You Need
19
20
 
20
- Every client needs:
21
+ - A Relay project and environment connection URL from the OpenE2EE console.
22
+ - An identity provider configured for that environment.
23
+ - A `getIdentityAssertion` callback that returns a short-lived signed assertion
24
+ for the signed-in user.
25
+ - Device-local storage for private keys, sessions, and delivery state.
26
+ - Application storage for decrypted messages and attachment bytes.
21
27
 
22
- - a stable `userId` from your app,
23
- - local `storage` for that user's encrypted protocol state,
24
- - usually a `relay` for server sync and encrypted message delivery,
25
- - an encrypted remote object store when sending attachments,
26
- - device registration or provisioning with that relay for each active device.
27
-
28
- The default security policy requires the package's post-quantum Signal Protocol
29
- configuration. You do not need to configure protocol options for the normal
30
- path.
31
-
32
- This guide uses the current stable API names. The target message-first DX groups
33
- local persistence under `deviceStorage.{protocol,messages,files}` and calls the
34
- remote encrypted byte adapter `remoteObjectStore`. Current `signal.media.*`
35
- examples are transition-only lower-level APIs. The target public API sends
36
- message attachments through `signal.messages.send({ attachments })` and advanced
37
- helpers, if needed, under a message-scoped API.
28
+ The callback belongs to your authentication integration. The examples below
29
+ require that setup. The SDK does not supply an identity provider or a relay
30
+ server implementation.
38
31
 
39
32
  ## Setup Sequence
40
33
 
41
- For a production app, wire startup in this order:
42
-
43
- 1. Choose protocol storage for this device.
44
- 2. Create or configure the relay adapter.
45
- 3. Register or provision this device with the relay during app bootstrap.
46
- 4. Create the client with `createSignalProtocolClient()`.
47
- 5. Call `syncToServer()` so peers can discover this device's public prekeys.
48
- 6. Register receive hooks and start relay subscription delivery.
49
-
50
- ## Mental Model
51
-
52
- ```mermaid
53
- flowchart LR
54
- subgraph ThisDevice["This device"]
55
- App["Your app"]
56
- Client["Signal Protocol client"]
57
- ProtocolStorage["Protocol storage"]
58
- MessageState["App message state"]
59
- LocalFiles["Local files/cache"]
60
- App --> Client
61
- Client <--> ProtocolStorage
62
- App <--> MessageState
63
- App <--> LocalFiles
64
- end
65
-
66
- Relay["Relay server"]
67
- ObjectStorage["Remote object storage"]
68
-
69
- subgraph RecipientPhone["Recipient phone"]
70
- PhoneClient["Signal Protocol client"]
71
- PhoneStorage["Device storage"]
72
- PhoneClient <--> PhoneStorage
73
- end
74
-
75
- subgraph RecipientLaptop["Recipient laptop"]
76
- LaptopClient["Signal Protocol client"]
77
- LaptopStorage["Device storage"]
78
- LaptopClient <--> LaptopStorage
79
- end
80
-
81
- subgraph LinkedDevice["Your linked device"]
82
- LinkedClient["Signal Protocol client"]
83
- LinkedStorage["Device storage"]
84
- LinkedClient <--> LinkedStorage
85
- end
86
-
87
- Client <--> Relay
88
- Client --> ObjectStorage
89
- Relay <--> PhoneClient
90
- Relay <--> LaptopClient
91
- Relay <--> LinkedClient
92
- ```
93
-
94
- - Each device owns its own app runtime, Signal Protocol client, protocol storage, message
95
- state, and local file/cache storage.
96
- - The current `adapters.storage` API maps to the protocol facet of the target
97
- `deviceStorage` model.
98
- - Your app owns decrypted message rows and local files after the Signal Protocol client
99
- decrypts or stages them.
100
- - The relay connects devices, stores public keys, and carries encrypted
101
- envelopes.
102
- - The remote object store carries encrypted attachment/media bytes only.
103
-
104
- You can operate these server-side interfaces through a shipped or custom
105
- adapter. You can instead use [OpenE2EE Signal Protocol Relay](https://open-e2ee.dev/relay) for
106
- managed encrypted delivery, private encrypted attachment storage, push wakes,
107
- and lifecycle controls. The SDK does not require the managed service. The
108
- [Relay pricing page](https://open-e2ee.dev/relay/pricing) defines its exact
109
- meters and limits.
110
-
111
- ## Target Message-First API Preview
112
-
113
- This is the target DX the package moves toward. It appears here so app
114
- developers can understand the intended mental model. The current stable API
115
- still uses `storage`, `remoteObjectStore`, hooks, and transition-only media helpers.
116
-
117
- <!-- doc-snippet:planned target-message-api unshipped="@open-e2ee/signal-protocol-sdk/device/storage/memory" -->
118
- ```ts
119
- // Real protocol and cryptography; simulated in-memory infrastructure.
120
- import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
121
- import { createInMemoryDeviceStorage } from "@open-e2ee/signal-protocol-sdk/device/storage/memory";
122
- import { inMemoryRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
123
-
124
- const relay = inMemoryRelay();
125
-
126
- const alice = await createSignalProtocolClient({
127
- identity: { userId: "alice", deviceId: 1 },
128
- adapters: {
129
- deviceStorage: createInMemoryDeviceStorage(),
130
- relay,
131
- },
132
- });
133
-
134
- const bob = await createSignalProtocolClient({
135
- identity: { userId: "bob", deviceId: 1 },
136
- adapters: {
137
- deviceStorage: createInMemoryDeviceStorage(),
138
- relay,
139
- },
140
- });
141
-
142
- const delivered = new Promise<void>((resolve) => {
143
- bob.messages.subscribe(
144
- { conversationId: "dm:alice_bob" },
145
- async (message) => {
146
- console.log("bob decrypted:", message.text);
147
- resolve();
148
- },
149
- );
150
- });
151
-
152
- const plaintext = "hello from Alice";
153
- console.log("alice plaintext input:", plaintext);
154
-
155
- const sent = await alice.messages.send({
156
- conversationId: "dm:alice_bob",
157
- to: "bob",
158
- text: plaintext,
159
- });
160
-
161
- console.log("relay-visible encrypted envelope:", {
162
- envelopeId: sent.envelopeId,
163
- ciphertextLength: sent.ciphertextLength,
164
- });
165
-
166
- await delivered;
167
- ```
168
-
169
- The production shape uses the same message API with platform adapters:
170
-
171
- <!-- doc-snippet:planned target-message-api-platform-adapters unshipped="@open-e2ee/signal-protocol-sdk/device/storage/expo" -->
172
- ```ts
173
- import { createHostedSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
174
- import { createExpoDeviceStorage } from "@open-e2ee/signal-protocol-sdk/device/storage/expo";
175
-
176
- const signal = await createHostedSignalProtocolClient({
177
- adapters: {
178
- deviceStorage: createExpoDeviceStorage({ database, files }),
179
- },
180
- hosted: {
181
- relayUrl: process.env.EXPO_PUBLIC_OPEN_E2EE_RELAY_URL!,
182
- getIdentityAssertion,
183
- },
184
- });
185
- ```
186
-
187
- Attachments use the same message API. On Expo, pass the picker URI. The Signal
188
- Protocol client copies or persists the bytes through `deviceStorage.files`
189
- before upload, so retry can continue after restart:
190
-
191
- <!-- doc-snippet:skip requires-external-context -->
192
- ```ts
193
- await signal.messages.send({
194
- conversationId: "dm:alice_bob",
195
- to: "bob",
196
- text: "photo from Expo",
197
- attachments: [
198
- {
199
- source: pickedPhoto.uri,
200
- contentType: pickedPhoto.contentType,
201
- fileName: pickedPhoto.fileName,
202
- size: pickedPhoto.fileSize,
203
- },
204
- ],
205
- });
206
- ```
207
-
208
- On the web, pass the browser file object:
209
-
210
- <!-- doc-snippet:skip requires-external-context -->
211
- ```ts
212
- await signal.messages.send({
213
- conversationId,
214
- to: "bob",
215
- text: "photo from the browser",
216
- attachments: [
217
- {
218
- source: file,
219
- contentType: file.type,
220
- fileName: file.name,
221
- size: file.size,
222
- },
223
- ],
224
- });
225
- ```
226
-
227
- Once this API lands, this guide should teach the target path first and move the
228
- current `signal.media.*` examples into lower-level transition or migration docs.
229
-
230
- ## Current Stable Local Clients
34
+ 1. Configure a Relay project and identity provider in the OpenE2EE console.
35
+ 2. Open the device-local store for the signed-in user.
36
+ 3. Create the client with `createHostedSignalProtocolClient()`.
37
+ 4. Register a receive handler that persists decrypted messages.
38
+ 5. Start the relay subscription.
231
39
 
232
- Use the in-memory adapters for local examples and development. The demo sends
233
- while Bob is offline, inspects the relay-visible ciphertext, and then starts
234
- Bob's subscription to show the decrypted plaintext entering the app.
40
+ The hosted factory authenticates and registers the current device, then publishes
41
+ its public prekeys. Linked devices use the provisioning flow in the
42
+ [device guide](../device/README.md). The default policy requires post-quantum
43
+ session establishment and Braid ratcheting.
235
44
 
236
- <!-- doc-snippet:run getting-started-stable-local-clients expect="bob decrypted: alice: hello" -->
237
- ```ts
238
- // Real protocol and cryptography; simulated in-memory infrastructure.
239
- import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
240
- import { inMemoryStore } from "@open-e2ee/signal-protocol-sdk/local/store/memory";
241
- import { inMemoryRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
242
-
243
- const relay = inMemoryRelay();
244
-
245
- // The relay knows which devices exist, but it does not get plaintext.
246
- await relay.registerDevice("alice", {
247
- encryptedDeviceName: new ArrayBuffer(0),
248
- });
249
- await relay.registerDevice("bob", { encryptedDeviceName: new ArrayBuffer(0) });
250
-
251
- // Each client represents one device. Its protocol storage is local to that device.
252
- const alice = await createSignalProtocolClient({
253
- identity: { userId: "alice" },
254
- adapters: { storage: inMemoryStore(), relay },
255
- });
256
-
257
- const bob = await createSignalProtocolClient({
258
- identity: { userId: "bob" },
259
- adapters: { storage: inMemoryStore(), relay },
260
- });
261
-
262
- await alice.syncToServer();
263
- await bob.syncToServer();
264
-
265
- // Send while Bob is offline so we can inspect what the relay stores.
266
- const sent = await alice.send("bob", "hello");
267
- console.log("alice sent:", sent.messageId);
268
-
269
- // The relay-visible envelope contains metadata plus ciphertext, not plaintext.
270
- const [queuedEnvelope] = relay.getPendingMessages("bob", 1);
271
- const ciphertextLength =
272
- typeof queuedEnvelope.ciphertext === "string"
273
- ? queuedEnvelope.ciphertext.length
274
- : queuedEnvelope.ciphertext.byteLength;
275
- const ciphertextPreview =
276
- typeof queuedEnvelope.ciphertext === "string"
277
- ? `${queuedEnvelope.ciphertext.slice(0, 32)}...`
278
- : `${queuedEnvelope.ciphertext.byteLength} encrypted bytes`;
279
-
280
- console.log("relay sees encrypted envelope:", {
281
- messageType: queuedEnvelope.messageType,
282
- ciphertextLength,
283
- ciphertextPreview,
284
- });
285
-
286
- const decrypted = new Promise<void>((resolve) => {
287
- // Plaintext enters your app only after Bob's Signal Protocol client decrypts it.
288
- bob.registerHook("onMessageDecrypted", async (message) => {
289
- console.log("bob decrypted:", `${message.senderId}: ${message.content}`);
290
- resolve();
291
- });
292
- });
293
-
294
- // Starting the subscription delivers Bob's queued encrypted envelope.
295
- bob.startRelaySubscription();
296
- await decrypted;
297
- ```
298
-
299
- Example output:
300
-
301
- ```text
302
- alice sent: msg-1
303
- relay sees encrypted envelope: {
304
- messageType: 'prekey_bundle',
305
- ciphertextLength: 3464,
306
- ciphertextPreview: '<base64 ciphertext preview>...'
307
- }
308
- bob decrypted: alice: hello
309
- ```
310
-
311
- The in-memory relay lets the example inspect what a server can see. The relay sees
312
- metadata plus encrypted envelope bytes. It does not receive Bob's decrypted
313
- message content. The first message often uses `prekey_bundle` to establish a
314
- session, and later messages use `ciphertext`.
315
-
316
- ## Production Client
317
-
318
- Use the protocol storage adapter for your runtime and connect to the OpenE2EE
319
- Signal Protocol Relay. For an Expo app, that is Expo local storage and the
320
- hosted client:
45
+ ## Expo Client
321
46
 
322
47
  <!-- doc-snippet:skip requires-external-context -->
323
48
  ```ts
@@ -325,22 +50,24 @@ import { createHostedSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk
325
50
  import { expoStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
326
51
 
327
52
  const signal = await createHostedSignalProtocolClient({
328
- adapters: {
329
- // Expo storage owns this device's private keys and session state.
330
- storage: await expoStore(),
331
- },
53
+ adapters: { storage: await expoStore() },
332
54
  hosted: {
333
- // The environment-scoped connection URL from the OpenE2EE console.
334
55
  relayUrl: process.env.EXPO_PUBLIC_OPEN_E2EE_RELAY_URL!,
335
- // Returns a short-lived signed assertion for the signed-in user.
336
56
  getIdentityAssertion,
337
57
  },
338
58
  });
339
59
  ```
340
60
 
341
- Production bootstrapping must register or provision the current device with the
342
- relay before user-level sends can discover it. Device registration and
343
- provisioning belong to the application bootstrap.
61
+ Complete the [Expo database setup](../local/store/expo/README.md) before creating
62
+ the client. Use a Sandbox connection URL during development. Keep each
63
+ account's device-local state separate.
64
+
65
+ ## Custom Transport
66
+
67
+ Advanced integrations can use `createSignalProtocolClient()` with an
68
+ application-owned `SignalProtocolRelayServer` client transport. That transport
69
+ connects to an authenticated backend. The [interface guide](./INTERFACES.md)
70
+ defines the contract. The published SDK contains no relay server implementation.
344
71
 
345
72
  ## Receive Messages
346
73
 
@@ -392,21 +119,17 @@ await signal.send("bob", {
392
119
  Add a remote object store when your app sends encrypted attachments. The
393
120
  `remoteObjectStore` adapter brokers encrypted byte objects rather than
394
121
  plaintext files.
395
- The final public DX should not expose both `signal.media.*` and message
396
- attachment helpers. The planned replacement is message-scoped attachment
397
- handling.
398
122
 
399
123
  <!-- doc-snippet:skip requires-external-context -->
400
124
  ```ts
401
- import { media } from "@open-e2ee/signal-protocol-sdk";
125
+ import { createHostedSignalProtocolClient, media } from "@open-e2ee/signal-protocol-sdk";
402
126
  import { convexR2ObjectStore } from "@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2";
403
127
  import { api } from "../convex/_generated/api";
404
128
 
405
- const signal = await createSignalProtocolClient({
406
- identity: { userId },
129
+ const signal = await createHostedSignalProtocolClient({
130
+ hosted: { relayUrl, getIdentityAssertion },
407
131
  adapters: {
408
132
  storage,
409
- relay,
410
133
  remoteObjectStore: convexR2ObjectStore({
411
134
  convex,
412
135
  api: api.signalObjectStore,
@@ -528,8 +251,7 @@ through a partial-byte store. Native background download code should implement t
528
251
 
529
252
  For background-safe uploads, use the durable client operation. The current API
530
253
  persists bounded recovery metadata through the existing Signal Protocol storage
531
- adapter. The target message-first API moves that responsibility behind
532
- `deviceStorage.messages`. The operation tries the upload when it is due and
254
+ adapter. The operation tries the upload when it is due and
533
255
  returns either a completed pointer or a pending job id for later recovery:
534
256
 
535
257
  <!-- doc-snippet:skip requires-external-context -->
@@ -722,6 +444,6 @@ Leave it unset unless your product has a specific compatibility decision. See
722
444
 
723
445
  - [Client Composition](./CLIENT_COMPOSITION.md): app setup and adapter shape.
724
446
  - [Protocol Policy](./PROTOCOL_POLICY.md): security policy choices.
725
- - [Adapters](../ADAPTERS.md): implementing current custom storage, relay, or blob
726
- stores before the target `deviceStorage` and `remoteObjectStore` API lands.
447
+ - [Adapters](../ADAPTERS.md): device-local storage, client transports, and remote
448
+ object stores.
727
449
  - [API Reference](./api/README.md): generated TypeScript API docs.
@@ -88,14 +88,15 @@ delivery, provisioning, key rotation, and encrypted group coordination.
88
88
  <!-- doc-snippet:skip requires-external-context -->
89
89
  ```ts
90
90
  import type { SignalProtocolRelayServer } from "@open-e2ee/signal-protocol-sdk/remote/relay";
91
- import { inMemoryRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
92
91
 
93
- // Development uses the in-memory relay. Production connects to the OpenE2EE
94
- // Signal Protocol Relay through `createHostedSignalProtocolClient()`, or to an
95
- // application backend that implements this interface.
96
- const relay: SignalProtocolRelayServer = inMemoryRelay();
92
+ // An application-owned client transport to an authenticated backend.
93
+ const relay: SignalProtocolRelayServer = appRelayTransport;
97
94
  ```
98
95
 
96
+ The hosted factory configures the OpenE2EE Signal Protocol Relay transport.
97
+ Custom transports remain an advanced integration point. The published package
98
+ contains the client contract, without a relay server implementation.
99
+
99
100
  The application backend must:
100
101
 
101
102
  - authenticate every caller
@@ -202,8 +203,7 @@ update, unless the specific API says so.
202
203
  - Implement the public interface when infrastructure requirements differ.
203
204
  - Import provider and platform adapters from explicit package subpaths so
204
205
  unrelated dependencies stay out of client bundles.
205
- - Keep authentication and product authorization in the application backend,
206
- even when an SDK helper supplies generic broker mechanics.
206
+ - Keep authentication and product authorization in the application backend.
207
207
 
208
208
  See [client composition](./CLIENT_COMPOSITION.md) for the complete client
209
209
  configuration shape and [documentation standards](./DOCUMENTATION_STANDARDS.md)
@@ -11,7 +11,8 @@ It also defines the vocabulary the rest of the documentation assumes.
11
11
 
12
12
  ## Core model
13
13
 
14
- - `createSignalProtocolClient()` is the recommended app-facing entry point.
14
+ - `createHostedSignalProtocolClient()` connects to the OpenE2EE Signal Protocol Relay.
15
+ - `createSignalProtocolClient()` composes an application-owned client transport.
15
16
  - `DefaultSignalProtocolClient` is the class the factory returns. `SignalProtocolClient` is its interface.
16
17
  - Every client requires `storage`, which owns local encryption state for one
17
18
  user/device.
@@ -33,12 +34,12 @@ package. They do not imply that one client spans multiple protocols.
33
34
 
34
35
  For a production app, the normal startup shape is:
35
36
 
36
- 1. Choose device-local storage for the current user/device.
37
- 2. Choose a relay for device discovery, public prekeys, and encrypted delivery.
38
- 3. Register or provision the current device with the relay during app bootstrap.
39
- 4. Create the Signal Protocol client with `createSignalProtocolClient()`.
40
- 5. Call `syncToServer()` so other devices can start encrypted sessions.
41
- 6. Register receive hooks and start relay subscription delivery.
37
+ 1. Configure a Relay project and identity provider in the OpenE2EE console.
38
+ 2. Open device-local storage for the signed-in user.
39
+ 3. Create the client with `createHostedSignalProtocolClient()`.
40
+ 4. Register receive hooks and start relay subscription delivery.
41
+
42
+ The hosted factory registers the device and publishes its public prekeys.
42
43
 
43
44
  ## Root package
44
45
 
@@ -48,6 +49,7 @@ Use the root package for core portable APIs:
48
49
  ```ts
49
50
  import {
50
51
  SignalProtocolClient,
52
+ createHostedSignalProtocolClient,
51
53
  createSignalProtocolClient,
52
54
  ProtocolAddress,
53
55
  BraidPolicy,
@@ -61,14 +63,16 @@ import {
61
63
  The root package intentionally does not re-export platform-bound adapters like
62
64
  Expo storage or the Convex R2 object store.
63
65
 
66
+ The published package contains client APIs and transport contracts. Relay
67
+ servers, group authorization engines, credential issuers, and server signing
68
+ implementations are outside the published SDK.
69
+
64
70
  ## Integration subpaths
65
71
 
66
72
  - `@open-e2ee/signal-protocol-sdk/remote/relay`
67
- - `@open-e2ee/signal-protocol-sdk/remote/relay/memory`
68
73
  - `@open-e2ee/signal-protocol-sdk/remote/relay/types`
69
74
  - `@open-e2ee/signal-protocol-sdk/remote/object-store`
70
75
  - `@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2`
71
- - `@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2/server`
72
76
  - `@open-e2ee/signal-protocol-sdk/remote/object-store/s3`
73
77
  - `@open-e2ee/signal-protocol-sdk/client`
74
78
  - `@open-e2ee/signal-protocol-sdk/client/config`
@@ -88,7 +92,6 @@ Expo storage or the Convex R2 object store.
88
92
  - `@open-e2ee/signal-protocol-sdk/encoding/hex`
89
93
  - `@open-e2ee/signal-protocol-sdk/files`
90
94
  - `@open-e2ee/signal-protocol-sdk/groups`
91
- - `@open-e2ee/signal-protocol-sdk/groups/server`
92
95
  - `@open-e2ee/signal-protocol-sdk/hooks`
93
96
  - `@open-e2ee/signal-protocol-sdk/keys`
94
97
  - `@open-e2ee/signal-protocol-sdk/keys/generation`
@@ -125,7 +128,6 @@ Expo storage or the Convex R2 object store.
125
128
 
126
129
  ### Development adapters
127
130
 
128
- - `@open-e2ee/signal-protocol-sdk/remote/relay/memory`
129
131
  - `@open-e2ee/signal-protocol-sdk/local/store/memory`
130
132
 
131
133
  `internal/**` is implementation-only and not part of the supported external API.
@@ -149,7 +151,6 @@ Expo storage or the Convex R2 object store.
149
151
 
150
152
  - `createHostedSignalProtocolClient()` from the package root for the OpenE2EE
151
153
  Signal Protocol Relay
152
- - `InMemorySignalProtocolRelayServer` / `inMemoryRelay()` for local development
153
154
  - custom implementations via `SignalProtocolRelayServer`
154
155
 
155
156
  ### Storage implementations
@@ -188,9 +189,6 @@ Expo storage or the Convex R2 object store.
188
189
  - `ConvexR2ObjectStore` via
189
190
  `@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2`
190
191
  - `convexR2ObjectStore()` for Cloudflare R2 composition
191
- - `defineConvexR2ObjectStore()` via the server-only
192
- `@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2/server` entry
193
- point
194
192
  - `S3ObjectStore` via `@open-e2ee/signal-protocol-sdk/remote/object-store/s3`
195
193
  - `s3ObjectStore()` for brokered Amazon S3 or S3-compatible storage
196
194
  - custom implementations via `SignalProtocolRemoteObjectStore`
@@ -199,7 +197,7 @@ Expo storage or the Convex R2 object store.
199
197
  functions that wrap `@convex-dev/r2`. It is not the Convex component itself.
200
198
  The application continues to own component installation, mounting,
201
199
  configuration, authentication, authorization, persistence, credentials, and
202
- the R2 bucket. The optional server helper owns only generic broker mechanics.
200
+ the R2 bucket and broker implementation.
203
201
  Both concrete adapters keep provider credentials in the application backend.
204
202
 
205
203
  The remote object store is a normal integration point for encrypted