@open-e2ee/signal-protocol-sdk 2.0.1 → 3.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 (410) hide show
  1. package/ADAPTERS.md +10 -17
  2. package/ARCHITECTURE.md +1 -2
  3. package/CHANGELOG.md +80 -0
  4. package/LICENSE +11 -655
  5. package/LICENSE-APACHE +201 -0
  6. package/LICENSE-MIT +21 -0
  7. package/NOTICE +5 -7
  8. package/README.md +11 -11
  9. package/SECURITY.md +2 -2
  10. package/TROUBLESHOOTING.md +2 -6
  11. package/client/README.md +34 -16
  12. package/device/README.md +1 -1
  13. package/dist/client/client.d.ts +13 -2
  14. package/dist/client/client.d.ts.map +1 -1
  15. package/dist/client/client.js +136 -73
  16. package/dist/client/client.js.map +1 -1
  17. package/dist/client/config.d.ts +14 -18
  18. package/dist/client/config.d.ts.map +1 -1
  19. package/dist/client/config.js.map +1 -1
  20. package/dist/client/content-adapter.d.ts +2 -0
  21. package/dist/client/content-adapter.d.ts.map +1 -1
  22. package/dist/client/content-adapter.js +4 -0
  23. package/dist/client/content-adapter.js.map +1 -1
  24. package/dist/client/endorsement-manager.d.ts +4 -1
  25. package/dist/client/endorsement-manager.d.ts.map +1 -1
  26. package/dist/client/endorsement-manager.js +14 -6
  27. package/dist/client/endorsement-manager.js.map +1 -1
  28. package/dist/client/group-authority.d.ts +8 -0
  29. package/dist/client/group-authority.d.ts.map +1 -0
  30. package/dist/client/group-authority.js +2 -0
  31. package/dist/client/group-authority.js.map +1 -0
  32. package/dist/client/headless.d.ts +3 -8
  33. package/dist/client/headless.d.ts.map +1 -1
  34. package/dist/client/headless.js +3 -8
  35. package/dist/client/headless.js.map +1 -1
  36. package/dist/client/hosted-anonymous-delivery.d.ts +32 -0
  37. package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -0
  38. package/dist/client/hosted-anonymous-delivery.js +239 -0
  39. package/dist/client/hosted-anonymous-delivery.js.map +1 -0
  40. package/dist/client/hosted-connection.d.ts +1 -1
  41. package/dist/client/hosted-connection.d.ts.map +1 -1
  42. package/dist/client/hosted-connection.js +18 -51
  43. package/dist/client/hosted-connection.js.map +1 -1
  44. package/dist/client/hosted-group-authority.d.ts +11 -0
  45. package/dist/client/hosted-group-authority.d.ts.map +1 -0
  46. package/dist/client/hosted-group-authority.js +96 -0
  47. package/dist/client/hosted-group-authority.js.map +1 -0
  48. package/dist/client/hosted-groups.d.ts +31 -0
  49. package/dist/client/hosted-groups.d.ts.map +1 -0
  50. package/dist/client/hosted-groups.js +217 -0
  51. package/dist/client/hosted-groups.js.map +1 -0
  52. package/dist/client/hosted-mailbox-subscription.d.ts +34 -0
  53. package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -0
  54. package/dist/client/hosted-mailbox-subscription.js +257 -0
  55. package/dist/client/hosted-mailbox-subscription.js.map +1 -0
  56. package/dist/client/hosted-prekey-publication.d.ts +51 -0
  57. package/dist/client/hosted-prekey-publication.d.ts.map +1 -0
  58. package/dist/client/hosted-prekey-publication.js +249 -0
  59. package/dist/client/hosted-prekey-publication.js.map +1 -0
  60. package/dist/client/hosted-push.d.ts +4 -5
  61. package/dist/client/hosted-push.d.ts.map +1 -1
  62. package/dist/client/hosted-push.js +22 -22
  63. package/dist/client/hosted-push.js.map +1 -1
  64. package/dist/client/hosted-transport.d.ts +57 -35
  65. package/dist/client/hosted-transport.d.ts.map +1 -1
  66. package/dist/client/hosted-transport.js +666 -341
  67. package/dist/client/hosted-transport.js.map +1 -1
  68. package/dist/client/hosted-trust.d.ts +29 -0
  69. package/dist/client/hosted-trust.d.ts.map +1 -0
  70. package/dist/client/hosted-trust.js +28 -0
  71. package/dist/client/hosted-trust.js.map +1 -0
  72. package/dist/client/hosted.d.ts +18 -13
  73. package/dist/client/hosted.d.ts.map +1 -1
  74. package/dist/client/hosted.js +78 -34
  75. package/dist/client/hosted.js.map +1 -1
  76. package/dist/client/index.d.ts +14 -14
  77. package/dist/client/index.d.ts.map +1 -1
  78. package/dist/client/index.js +7 -7
  79. package/dist/client/index.js.map +1 -1
  80. package/dist/client/key-rotation-core.d.ts +8 -0
  81. package/dist/client/key-rotation-core.d.ts.map +1 -1
  82. package/dist/client/key-rotation-core.js +12 -1
  83. package/dist/client/key-rotation-core.js.map +1 -1
  84. package/dist/client/key-rotation.d.ts +2 -1
  85. package/dist/client/key-rotation.d.ts.map +1 -1
  86. package/dist/client/key-rotation.js +4 -4
  87. package/dist/client/key-rotation.js.map +1 -1
  88. package/dist/client/media-queue-persistence.d.ts +14 -0
  89. package/dist/client/media-queue-persistence.d.ts.map +1 -0
  90. package/dist/client/media-queue-persistence.js +123 -0
  91. package/dist/client/media-queue-persistence.js.map +1 -0
  92. package/dist/client/media-upload-budget.d.ts +3 -0
  93. package/dist/client/media-upload-budget.d.ts.map +1 -0
  94. package/dist/client/media-upload-budget.js +27 -0
  95. package/dist/client/media-upload-budget.js.map +1 -0
  96. package/dist/client/media.d.ts +51 -15
  97. package/dist/client/media.d.ts.map +1 -1
  98. package/dist/client/media.js +541 -73
  99. package/dist/client/media.js.map +1 -1
  100. package/dist/client/messages.d.ts.map +1 -1
  101. package/dist/client/messages.js +13 -14
  102. package/dist/client/messages.js.map +1 -1
  103. package/dist/client/prekeys.d.ts.map +1 -1
  104. package/dist/client/prekeys.js +131 -43
  105. package/dist/client/prekeys.js.map +1 -1
  106. package/dist/client/relay-subscription.d.ts +4 -0
  107. package/dist/client/relay-subscription.d.ts.map +1 -1
  108. package/dist/client/relay-subscription.js +58 -25
  109. package/dist/client/relay-subscription.js.map +1 -1
  110. package/dist/client/sender-key-distribution.d.ts +8 -0
  111. package/dist/client/sender-key-distribution.d.ts.map +1 -0
  112. package/dist/client/sender-key-distribution.js +59 -0
  113. package/dist/client/sender-key-distribution.js.map +1 -0
  114. package/dist/client/signal-service-cipher.d.ts +7 -3
  115. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  116. package/dist/client/signal-service-cipher.js +41 -16
  117. package/dist/client/signal-service-cipher.js.map +1 -1
  118. package/dist/device/{expo-metadata.d.ts → expo/index.d.ts} +3 -3
  119. package/dist/device/expo/index.d.ts.map +1 -0
  120. package/dist/device/{expo-metadata.js → expo/index.js} +2 -2
  121. package/dist/device/expo/index.js.map +1 -0
  122. package/dist/device/index.js +1 -1
  123. package/dist/device/index.js.map +1 -1
  124. package/dist/device/provisioning.d.ts +1 -1
  125. package/dist/device/provisioning.js +1 -1
  126. package/dist/device/types.d.ts +1 -1
  127. package/dist/groups/server.d.ts +10 -0
  128. package/dist/groups/server.d.ts.map +1 -0
  129. package/dist/groups/server.js +6 -0
  130. package/dist/groups/server.js.map +1 -0
  131. package/dist/hooks/use-connection-presence.d.ts +2 -4
  132. package/dist/hooks/use-connection-presence.d.ts.map +1 -1
  133. package/dist/hooks/use-connection-presence.js +2 -4
  134. package/dist/hooks/use-connection-presence.js.map +1 -1
  135. package/dist/index.d.ts +51 -49
  136. package/dist/index.d.ts.map +1 -1
  137. package/dist/index.js +25 -24
  138. package/dist/index.js.map +1 -1
  139. package/dist/internal/groups/authority-certificate.d.ts +22 -0
  140. package/dist/internal/groups/authority-certificate.d.ts.map +1 -0
  141. package/dist/internal/groups/authority-certificate.js +99 -0
  142. package/dist/internal/groups/authority-certificate.js.map +1 -0
  143. package/dist/internal/groups/error-details.d.ts +9 -0
  144. package/dist/internal/groups/error-details.d.ts.map +1 -0
  145. package/dist/internal/groups/error-details.js +30 -0
  146. package/dist/internal/groups/error-details.js.map +1 -0
  147. package/dist/internal/groups/manager.d.ts +5 -0
  148. package/dist/internal/groups/manager.d.ts.map +1 -1
  149. package/dist/internal/groups/manager.js +3 -0
  150. package/dist/internal/groups/manager.js.map +1 -1
  151. package/dist/internal/groups/server-engine.d.ts +7 -0
  152. package/dist/internal/groups/server-engine.d.ts.map +1 -1
  153. package/dist/internal/groups/server-engine.js +51 -19
  154. package/dist/internal/groups/server-engine.js.map +1 -1
  155. package/dist/internal/groups/wire.d.ts.map +1 -1
  156. package/dist/internal/groups/wire.js +10 -9
  157. package/dist/internal/groups/wire.js.map +1 -1
  158. package/dist/internal/manager/manager.d.ts +1 -1
  159. package/dist/internal/manager/manager.d.ts.map +1 -1
  160. package/dist/internal/manager/manager.js +22 -25
  161. package/dist/internal/manager/manager.js.map +1 -1
  162. package/dist/internal/protocol/sender-keys/manager.d.ts +1 -1
  163. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  164. package/dist/internal/protocol/sender-keys/manager.js +27 -14
  165. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  166. package/dist/internal/sesame/manager.d.ts +2 -2
  167. package/dist/internal/sesame/manager.d.ts.map +1 -1
  168. package/dist/internal/sesame/manager.js +6 -6
  169. package/dist/internal/sesame/manager.js.map +1 -1
  170. package/dist/internal/sesame/types.d.ts +1 -1
  171. package/dist/internal/sesame/types.d.ts.map +1 -1
  172. package/dist/internal/session/cipher.d.ts +1 -1
  173. package/dist/internal/session/cipher.d.ts.map +1 -1
  174. package/dist/internal/session/cipher.js +31 -28
  175. package/dist/internal/session/cipher.js.map +1 -1
  176. package/dist/layers.d.ts +1 -1
  177. package/dist/layers.d.ts.map +1 -1
  178. package/dist/layers.js +1 -1
  179. package/dist/layers.js.map +1 -1
  180. package/dist/local/store/expo/adapter.d.ts +8 -2
  181. package/dist/local/store/expo/adapter.d.ts.map +1 -1
  182. package/dist/local/store/expo/adapter.js +28 -9
  183. package/dist/local/store/expo/adapter.js.map +1 -1
  184. package/dist/local/store/expo/key-storage.d.ts +7 -1
  185. package/dist/local/store/expo/key-storage.d.ts.map +1 -1
  186. package/dist/local/store/expo/key-storage.js +82 -17
  187. package/dist/local/store/expo/key-storage.js.map +1 -1
  188. package/dist/local/store/expo/models/kyber-prekey-used.d.ts +1 -4
  189. package/dist/local/store/expo/models/kyber-prekey-used.d.ts.map +1 -1
  190. package/dist/local/store/expo/models/kyber-prekey-used.js +23 -9
  191. package/dist/local/store/expo/models/kyber-prekey-used.js.map +1 -1
  192. package/dist/local/store/expo/models/kyber-prekey.d.ts +4 -4
  193. package/dist/local/store/expo/models/kyber-prekey.d.ts.map +1 -1
  194. package/dist/local/store/expo/models/kyber-prekey.js +67 -26
  195. package/dist/local/store/expo/models/kyber-prekey.js.map +1 -1
  196. package/dist/local/store/expo/schema.d.ts +21 -2
  197. package/dist/local/store/expo/schema.d.ts.map +1 -1
  198. package/dist/local/store/expo/schema.js +10 -2
  199. package/dist/local/store/expo/schema.js.map +1 -1
  200. package/dist/local/store/kyber-prekey-lifecycle.d.ts +46 -0
  201. package/dist/local/store/kyber-prekey-lifecycle.d.ts.map +1 -0
  202. package/dist/local/store/kyber-prekey-lifecycle.js +88 -0
  203. package/dist/local/store/kyber-prekey-lifecycle.js.map +1 -0
  204. package/dist/local/store/memory/adapter.d.ts +11 -3
  205. package/dist/local/store/memory/adapter.d.ts.map +1 -1
  206. package/dist/local/store/memory/adapter.js +113 -28
  207. package/dist/local/store/memory/adapter.js.map +1 -1
  208. package/dist/local/store/node/adapter.d.ts +8 -2
  209. package/dist/local/store/node/adapter.d.ts.map +1 -1
  210. package/dist/local/store/node/adapter.js +31 -13
  211. package/dist/local/store/node/adapter.js.map +1 -1
  212. package/dist/local/store/node/database-file-commit.d.ts +8 -0
  213. package/dist/local/store/node/database-file-commit.d.ts.map +1 -0
  214. package/dist/local/store/node/database-file-commit.js +62 -0
  215. package/dist/local/store/node/database-file-commit.js.map +1 -0
  216. package/dist/local/store/node/database-key.d.ts +6 -1
  217. package/dist/local/store/node/database-key.d.ts.map +1 -1
  218. package/dist/local/store/node/database-key.js +79 -44
  219. package/dist/local/store/node/database-key.js.map +1 -1
  220. package/dist/local/store/node/database-lock.d.ts +8 -0
  221. package/dist/local/store/node/database-lock.d.ts.map +1 -0
  222. package/dist/local/store/node/database-lock.js +44 -0
  223. package/dist/local/store/node/database-lock.js.map +1 -0
  224. package/dist/local/store/node/database.d.ts +15 -14
  225. package/dist/local/store/node/database.d.ts.map +1 -1
  226. package/dist/local/store/node/database.js +197 -202
  227. package/dist/local/store/node/database.js.map +1 -1
  228. package/dist/local/store/react-native/adapter.d.ts +8 -2
  229. package/dist/local/store/react-native/adapter.d.ts.map +1 -1
  230. package/dist/local/store/react-native/adapter.js +151 -66
  231. package/dist/local/store/react-native/adapter.js.map +1 -1
  232. package/dist/local/store/received-content.d.ts +9 -0
  233. package/dist/local/store/received-content.d.ts.map +1 -0
  234. package/dist/local/store/received-content.js +46 -0
  235. package/dist/local/store/received-content.js.map +1 -0
  236. package/dist/local/store/reliability.d.ts +2 -2
  237. package/dist/local/store/reliability.d.ts.map +1 -1
  238. package/dist/local/store/reliability.js +7 -4
  239. package/dist/local/store/reliability.js.map +1 -1
  240. package/dist/local/store/web/adapter.d.ts +8 -2
  241. package/dist/local/store/web/adapter.d.ts.map +1 -1
  242. package/dist/local/store/web/adapter.js +206 -73
  243. package/dist/local/store/web/adapter.js.map +1 -1
  244. package/dist/media/index.d.ts +71 -61
  245. package/dist/media/index.d.ts.map +1 -1
  246. package/dist/media/index.js +550 -386
  247. package/dist/media/index.js.map +1 -1
  248. package/dist/media/prepared-upload.d.ts +37 -0
  249. package/dist/media/prepared-upload.d.ts.map +1 -0
  250. package/dist/media/prepared-upload.js +46 -0
  251. package/dist/media/prepared-upload.js.map +1 -0
  252. package/dist/remote/object-store/convex-r2/server.d.ts +2 -1
  253. package/dist/remote/object-store/convex-r2/server.d.ts.map +1 -1
  254. package/dist/remote/object-store/convex-r2/server.js +4 -0
  255. package/dist/remote/object-store/convex-r2/server.js.map +1 -1
  256. package/dist/remote/object-store/convex-r2/storage.d.ts.map +1 -1
  257. package/dist/remote/object-store/convex-r2/storage.js +1 -0
  258. package/dist/remote/object-store/convex-r2/storage.js.map +1 -1
  259. package/dist/remote/object-store/index.d.ts +3 -1
  260. package/dist/remote/object-store/index.d.ts.map +1 -1
  261. package/dist/remote/object-store/index.js +1 -1
  262. package/dist/remote/object-store/index.js.map +1 -1
  263. package/dist/remote/object-store/s3/storage.d.ts +3 -1
  264. package/dist/remote/object-store/s3/storage.d.ts.map +1 -1
  265. package/dist/remote/object-store/s3/storage.js +9 -2
  266. package/dist/remote/object-store/s3/storage.js.map +1 -1
  267. package/dist/remote/object-store/types.d.ts +33 -4
  268. package/dist/remote/object-store/types.d.ts.map +1 -1
  269. package/dist/remote/object-store/upload-error.d.ts +23 -0
  270. package/dist/remote/object-store/upload-error.d.ts.map +1 -0
  271. package/dist/remote/object-store/upload-error.js +33 -0
  272. package/dist/remote/object-store/upload-error.js.map +1 -0
  273. package/dist/remote/object-store/validation.d.ts +7 -1
  274. package/dist/remote/object-store/validation.d.ts.map +1 -1
  275. package/dist/remote/object-store/validation.js +39 -25
  276. package/dist/remote/object-store/validation.js.map +1 -1
  277. package/dist/remote/relay/index.d.ts +5 -12
  278. package/dist/remote/relay/index.d.ts.map +1 -1
  279. package/dist/remote/relay/index.js +4 -11
  280. package/dist/remote/relay/index.js.map +1 -1
  281. package/dist/remote/relay/memory/adapter.d.ts +2 -1
  282. package/dist/remote/relay/memory/adapter.d.ts.map +1 -1
  283. package/dist/remote/relay/memory/adapter.js +10 -0
  284. package/dist/remote/relay/memory/adapter.js.map +1 -1
  285. package/dist/remote/relay/types.d.ts +28 -17
  286. package/dist/remote/relay/types.d.ts.map +1 -1
  287. package/dist/types/api.d.ts +36 -1
  288. package/dist/types/api.d.ts.map +1 -1
  289. package/dist/types/session.d.ts +6 -0
  290. package/dist/types/session.d.ts.map +1 -1
  291. package/dist/types/session.js.map +1 -1
  292. package/docs/ASSURANCE.md +7 -7
  293. package/docs/CLIENT_COMPOSITION.md +12 -19
  294. package/docs/DEVIATIONS.md +1 -1
  295. package/docs/DOCUMENTATION_STANDARDS.md +4 -0
  296. package/docs/GETTING_STARTED.md +23 -38
  297. package/docs/INTERFACES.md +22 -13
  298. package/docs/PACKAGE_SURFACE.md +5 -12
  299. package/docs/RECIPES.md +10 -23
  300. package/examples/browser/index.html +2 -2
  301. package/local/store/README.md +16 -1
  302. package/local/store/expo/README.md +23 -19
  303. package/local/store/node/README.md +29 -0
  304. package/media/README.md +94 -0
  305. package/package.json +17 -27
  306. package/remote/README.md +16 -16
  307. package/remote/object-store/README.md +8 -0
  308. package/remote/object-store/s3/README.md +10 -1
  309. package/remote/relay/README.md +3 -2
  310. package/COMMERCIAL.md +0 -56
  311. package/dist/device/expo-metadata.d.ts.map +0 -1
  312. package/dist/device/expo-metadata.js.map +0 -1
  313. package/dist/remote/relay/convex/backend.d.ts +0 -394
  314. package/dist/remote/relay/convex/backend.d.ts.map +0 -1
  315. package/dist/remote/relay/convex/backend.js +0 -678
  316. package/dist/remote/relay/convex/backend.js.map +0 -1
  317. package/dist/remote/relay/convex/component/_generated/api.d.ts +0 -58
  318. package/dist/remote/relay/convex/component/_generated/api.d.ts.map +0 -1
  319. package/dist/remote/relay/convex/component/_generated/api.js +0 -31
  320. package/dist/remote/relay/convex/component/_generated/api.js.map +0 -1
  321. package/dist/remote/relay/convex/component/_generated/component.d.ts +0 -475
  322. package/dist/remote/relay/convex/component/_generated/component.d.ts.map +0 -1
  323. package/dist/remote/relay/convex/component/_generated/component.js +0 -11
  324. package/dist/remote/relay/convex/component/_generated/component.js.map +0 -1
  325. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts +0 -46
  326. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts.map +0 -1
  327. package/dist/remote/relay/convex/component/_generated/dataModel.js +0 -11
  328. package/dist/remote/relay/convex/component/_generated/dataModel.js.map +0 -1
  329. package/dist/remote/relay/convex/component/_generated/server.d.ts +0 -129
  330. package/dist/remote/relay/convex/component/_generated/server.d.ts.map +0 -1
  331. package/dist/remote/relay/convex/component/_generated/server.js +0 -79
  332. package/dist/remote/relay/convex/component/_generated/server.js.map +0 -1
  333. package/dist/remote/relay/convex/component/accounts.d.ts +0 -45
  334. package/dist/remote/relay/convex/component/accounts.d.ts.map +0 -1
  335. package/dist/remote/relay/convex/component/accounts.js +0 -184
  336. package/dist/remote/relay/convex/component/accounts.js.map +0 -1
  337. package/dist/remote/relay/convex/component/certificates.d.ts +0 -10
  338. package/dist/remote/relay/convex/component/certificates.d.ts.map +0 -1
  339. package/dist/remote/relay/convex/component/certificates.js +0 -126
  340. package/dist/remote/relay/convex/component/certificates.js.map +0 -1
  341. package/dist/remote/relay/convex/component/cleanup.d.ts +0 -32
  342. package/dist/remote/relay/convex/component/cleanup.d.ts.map +0 -1
  343. package/dist/remote/relay/convex/component/cleanup.js +0 -146
  344. package/dist/remote/relay/convex/component/cleanup.js.map +0 -1
  345. package/dist/remote/relay/convex/component/convex.config.d.ts +0 -5
  346. package/dist/remote/relay/convex/component/convex.config.d.ts.map +0 -1
  347. package/dist/remote/relay/convex/component/convex.config.js +0 -35
  348. package/dist/remote/relay/convex/component/convex.config.js.map +0 -1
  349. package/dist/remote/relay/convex/component/crons.d.ts +0 -3
  350. package/dist/remote/relay/convex/component/crons.d.ts.map +0 -1
  351. package/dist/remote/relay/convex/component/crons.js +0 -10
  352. package/dist/remote/relay/convex/component/crons.js.map +0 -1
  353. package/dist/remote/relay/convex/component/devices.d.ts +0 -102
  354. package/dist/remote/relay/convex/component/devices.d.ts.map +0 -1
  355. package/dist/remote/relay/convex/component/devices.js +0 -300
  356. package/dist/remote/relay/convex/component/devices.js.map +0 -1
  357. package/dist/remote/relay/convex/component/errors.d.ts +0 -22
  358. package/dist/remote/relay/convex/component/errors.d.ts.map +0 -1
  359. package/dist/remote/relay/convex/component/errors.js +0 -17
  360. package/dist/remote/relay/convex/component/errors.js.map +0 -1
  361. package/dist/remote/relay/convex/component/groups.d.ts +0 -63
  362. package/dist/remote/relay/convex/component/groups.d.ts.map +0 -1
  363. package/dist/remote/relay/convex/component/groups.js +0 -341
  364. package/dist/remote/relay/convex/component/groups.js.map +0 -1
  365. package/dist/remote/relay/convex/component/keys.d.ts +0 -130
  366. package/dist/remote/relay/convex/component/keys.d.ts.map +0 -1
  367. package/dist/remote/relay/convex/component/keys.js +0 -578
  368. package/dist/remote/relay/convex/component/keys.js.map +0 -1
  369. package/dist/remote/relay/convex/component/messages.d.ts +0 -105
  370. package/dist/remote/relay/convex/component/messages.d.ts.map +0 -1
  371. package/dist/remote/relay/convex/component/messages.js +0 -702
  372. package/dist/remote/relay/convex/component/messages.js.map +0 -1
  373. package/dist/remote/relay/convex/component/provisioning.d.ts +0 -92
  374. package/dist/remote/relay/convex/component/provisioning.d.ts.map +0 -1
  375. package/dist/remote/relay/convex/component/provisioning.js +0 -360
  376. package/dist/remote/relay/convex/component/provisioning.js.map +0 -1
  377. package/dist/remote/relay/convex/component/runtime.d.ts +0 -18
  378. package/dist/remote/relay/convex/component/runtime.d.ts.map +0 -1
  379. package/dist/remote/relay/convex/component/runtime.js +0 -144
  380. package/dist/remote/relay/convex/component/runtime.js.map +0 -1
  381. package/dist/remote/relay/convex/component/schema.d.ts +0 -358
  382. package/dist/remote/relay/convex/component/schema.d.ts.map +0 -1
  383. package/dist/remote/relay/convex/component/schema.js +0 -288
  384. package/dist/remote/relay/convex/component/schema.js.map +0 -1
  385. package/dist/remote/relay/convex/component/zkAuth.d.ts +0 -18
  386. package/dist/remote/relay/convex/component/zkAuth.d.ts.map +0 -1
  387. package/dist/remote/relay/convex/component/zkAuth.js +0 -86
  388. package/dist/remote/relay/convex/component/zkAuth.js.map +0 -1
  389. package/dist/remote/relay/convex/constants.d.ts +0 -3
  390. package/dist/remote/relay/convex/constants.d.ts.map +0 -1
  391. package/dist/remote/relay/convex/constants.js +0 -3
  392. package/dist/remote/relay/convex/constants.js.map +0 -1
  393. package/dist/remote/relay/convex/group-server.d.ts +0 -123
  394. package/dist/remote/relay/convex/group-server.d.ts.map +0 -1
  395. package/dist/remote/relay/convex/group-server.js +0 -184
  396. package/dist/remote/relay/convex/group-server.js.map +0 -1
  397. package/dist/remote/relay/convex/index.d.ts +0 -42
  398. package/dist/remote/relay/convex/index.d.ts.map +0 -1
  399. package/dist/remote/relay/convex/index.js +0 -38
  400. package/dist/remote/relay/convex/index.js.map +0 -1
  401. package/dist/remote/relay/convex/relay.d.ts +0 -323
  402. package/dist/remote/relay/convex/relay.d.ts.map +0 -1
  403. package/dist/remote/relay/convex/relay.js +0 -1144
  404. package/dist/remote/relay/convex/relay.js.map +0 -1
  405. package/dist/remote/relay/convex/types.d.ts +0 -24
  406. package/dist/remote/relay/convex/types.d.ts.map +0 -1
  407. package/dist/remote/relay/convex/types.js +0 -14
  408. package/dist/remote/relay/convex/types.js.map +0 -1
  409. package/remote/relay/convex/README.md +0 -61
  410. package/remote/relay/convex/component/README.md +0 -462
package/ADAPTERS.md CHANGED
@@ -17,7 +17,7 @@ The relay interface handles server-owned Signal Protocol state:
17
17
 
18
18
  Use:
19
19
 
20
- - `ConvexSignalProtocolRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/convex`
20
+ - the OpenE2EE Signal Protocol Relay through `createHostedSignalProtocolClient()` from the package root
21
21
  - `InMemorySignalProtocolRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/memory`
22
22
  - or a custom implementation
23
23
 
@@ -83,27 +83,20 @@ const signal = await createSignalProtocolClient({
83
83
 
84
84
  <!-- doc-snippet:skip requires-production-adapters -->
85
85
  ```ts
86
- import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
87
- import {
88
- convexRelay,
89
- type ConvexSignalProtocolRelayApi,
90
- } from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
86
+ import { createHostedSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
91
87
  import { expoStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
92
- import { api } from "../convex/_generated/api";
93
-
94
- const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
95
- const relay = convexRelay({
96
- convex,
97
- api: signalApi,
98
- currentUserId: userId,
99
- });
100
88
 
101
89
  // Initialize the application-owned Expo/SQLCipher database bindings first.
102
- const signal = await createSignalProtocolClient({
103
- identity: { userId },
90
+ const signal = await createHostedSignalProtocolClient({
104
91
  adapters: {
92
+ // Expo storage owns this device's private keys and session state.
105
93
  storage: expoStore(),
106
- relay,
94
+ },
95
+ hosted: {
96
+ // The environment-scoped connection URL from the OpenE2EE console.
97
+ relayUrl: process.env.EXPO_PUBLIC_OPEN_E2EE_RELAY_URL!,
98
+ // Returns a short-lived signed assertion for the signed-in user.
99
+ getIdentityAssertion,
107
100
  },
108
101
  });
109
102
  ```
package/ARCHITECTURE.md CHANGED
@@ -41,7 +41,7 @@ compatibility shim when a boundary is wrong.
41
41
  | Public feature surfaces | [blocking/](./blocking/), [groups/](./groups/), [media/](./media/), [profile/](./profile/), [sealed-sender/](./sealed-sender/), [username/](./username/), [zk/](./zk/) | App-facing helpers that compose protocol, media, or account-state behavior without joining the inward dependency hierarchy |
42
42
  | Public utility surfaces | [encoding/](./encoding/), [files/](./files/), [hooks/](./hooks/), [utils/](./utils/), `logger.ts`, `server-clock.ts`, `versions.ts` | Stable helpers, React hooks, logging, clock estimation, version metadata, and file/encoding utilities |
43
43
  | Local adapters | [local/](./local/) | Local protocol stores and secret vault integrations |
44
- | Remote adapters | [remote/](./remote/) | Relay and object-store ports plus Convex, in-memory, R2, and S3 adapters |
44
+ | Remote adapters | [remote/](./remote/) | Relay and object-store ports plus in-memory, R2, and S3 adapters |
45
45
  | Device features | [device/](./device/) | Device IDs, provisioning, linked-device lifecycle and transfer |
46
46
 
47
47
  ## Documentation Ownership
@@ -74,7 +74,6 @@ Platform and backend integrations are explicit subpaths such as:
74
74
 
75
75
  - `@open-e2ee/signal-protocol-sdk/local/store/expo`
76
76
  - `@open-e2ee/signal-protocol-sdk/local/store/memory`
77
- - `@open-e2ee/signal-protocol-sdk/remote/relay/convex`
78
77
  - `@open-e2ee/signal-protocol-sdk/remote/relay/memory`
79
78
  - `@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2`
80
79
  - `@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2/server`
package/CHANGELOG.md CHANGED
@@ -1,5 +1,85 @@
1
1
  # Changelog
2
2
 
3
+ ## 3.0.0
4
+
5
+ - **Breaking: the SDK is dual-licensed under MIT or Apache-2.0.** The package
6
+ `license` is `(MIT OR Apache-2.0)`. `LICENSE` states the grant, and
7
+ `LICENSE-MIT` and `LICENSE-APACHE` carry the full texts. The
8
+ AGPL-3.0-or-later terms and the commercial license (`COMMERCIAL.md`) are
9
+ withdrawn.
10
+ - **Breaking: the Convex relay server is no longer published.** The
11
+ `./remote/relay/convex` and `./convex.config` entry points, the
12
+ `remote/relay/convex/**` sources, and the `@convex-dev/rate-limiter` peer
13
+ dependency leave the public package. Production clients connect to the
14
+ OpenE2EE Signal Protocol Relay through `createHostedSignalProtocolClient()`,
15
+ development uses `inMemoryRelay()`, and any backend can implement
16
+ `ISignalProtocolRelayServer`. The Convex R2 object store
17
+ (`./remote/object-store/convex-r2`) stays.
18
+ - **Breaking: `./device/expo-metadata` is now `./device/expo`.** The Expo
19
+ device metadata module moved to `device/expo/index.ts`. The duplicate
20
+ `./remote/relay/convex/relay` entry point is removed with the Convex relay.
21
+ - **The hosted relay is the OpenE2EE Signal Protocol Relay.** Documentation,
22
+ doc comments, and user-visible error messages say `OpenE2EE Signal Protocol
23
+ Relay`, or `Signal Protocol Relay` as the short form, instead of
24
+ `OpenE2EE Relay`, `Managed Relay`, or `hosted Relay`. Code that matched
25
+ the old error message text must match the new text. Domain-separation labels
26
+ are unchanged.
27
+ - Correct the browser and Expo example package integrity. Both lockfiles pin
28
+ the public tarball, and release verification packs the public candidate
29
+ under the publication runtime and checks both pins before an export.
30
+ - **Breaking: the Kyber last-resort prekey takes the next key id on every
31
+ rotation.** Rotation, prekey regeneration, and the local-only rotation path
32
+ previously regenerated the key under id 1, which the local store now refuses
33
+ because it retains replaced keys under their ids for in-flight PQXDH
34
+ messages. Only a complete key reset starts at id 1 again. The
35
+ `KemLastResortPreKeyUpload` key id is no longer fixed at 1.
36
+ - **Breaking: Node.js 22.12 is the minimum supported runtime.** Node.js 18 and
37
+ 20 have reached end of life, the S3 object store dependencies require Node.js
38
+ 20 or later, and the committed lockfile installs with npm 11. The Node store
39
+ authority checks run on Node.js 22 and 26.
40
+
41
+ - **Breaking: hosted mailbox subscriptions deliver from the socket.** A
42
+ `durable-message` frame carries the envelope, and the subscription hands it
43
+ to the receive handler without a pull. Acknowledgments travel over the same
44
+ socket as one `acknowledge` frame per delivered batch, bounded at one hundred
45
+ message ids. The HTTP pull remains for recovery: once per reconnect attempt,
46
+ after a handler failure, and after a full recovery page. The HTTP
47
+ acknowledgment remains for the push-wake path and for a batch whose socket
48
+ closed before its acknowledgment left. Relay must reply `acknowledged`
49
+ without re-sending pending messages.
50
+
51
+ - **Hosted group transport and issuer authority.**
52
+ Clients create encrypted groups, invite members, synchronize revisions, and
53
+ distribute sender keys through Relay. Long-lived clients refresh signed
54
+ authority. Cached endorsements bind to their issuer, and issuance cannot
55
+ exceed the issuer's expiry. Self-hosted trust remains explicit.
56
+
57
+ - **Interrupted receives preserve an encrypted device-local receipt.** Receipt
58
+ persistence shares the transaction that advances cryptographic state.
59
+ Retries recover application handling after a restart without decrypting the
60
+ same envelope twice. Acknowledgment follows successful application handling.
61
+
62
+ - **Breaking: endorsement cache entries include their public issuer key.**
63
+ Custom stores must preserve that key with each entry. The `groups/server`
64
+ entry point exposes the existing group authorization engine for Relay hosts.
65
+
66
+ - **Hosted mailbox subscriptions stop dispatch after unsubscribe.** Polling
67
+ waits for each asynchronous message handler before the next envelope, batch
68
+ completion, and next poll. A handler failure closes the batch and leaves
69
+ unacknowledged envelopes available for retry.
70
+
71
+ - **Breaking: Relay adapters implement `getPreKeyInventory`.** Prekey
72
+ synchronization reads both signed-key records and both one-time-key counts
73
+ through one operation. The Signal Protocol Relay uses one status request per
74
+ decision. Inventory is not a reservation or cache. Canonical identity checks and fresh replenishment
75
+ checks remain separate.
76
+
77
+ ## 2.0.2
78
+
79
+ - Correct the browser and Expo example package integrity for the release environment.
80
+ - Check example pins before publication and publish the checked tarball.
81
+ This release changes package metadata and publication checks.
82
+
3
83
  ## 2.0.1
4
84
 
5
85
  - Select secure randomness for browsers, Node, and Expo through package imports.