@open-e2ee/signal-protocol-sdk 2.0.2 → 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 +74 -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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-e2ee/signal-protocol-sdk",
3
- "version": "2.0.2",
3
+ "version": "3.0.0",
4
4
  "description": "Pure TypeScript Signal Protocol SDK for encrypted chat in Expo, React Native, browsers, and Node. Post-quantum by default.",
5
5
  "keywords": [
6
6
  "open-e2ee",
@@ -26,7 +26,7 @@
26
26
  "sdk",
27
27
  "forward-secrecy"
28
28
  ],
29
- "license": "AGPL-3.0-or-later",
29
+ "license": "(MIT OR Apache-2.0)",
30
30
  "author": {
31
31
  "name": "OpenE2EE",
32
32
  "url": "https://github.com/open-e2ee"
@@ -63,18 +63,6 @@
63
63
  "types": "./dist/remote/relay/index.d.ts",
64
64
  "default": "./dist/remote/relay/index.js"
65
65
  },
66
- "./remote/relay/convex": {
67
- "types": "./dist/remote/relay/convex/index.d.ts",
68
- "default": "./dist/remote/relay/convex/index.js"
69
- },
70
- "./remote/relay/convex/relay": {
71
- "types": "./dist/remote/relay/convex/relay.d.ts",
72
- "default": "./dist/remote/relay/convex/relay.js"
73
- },
74
- "./convex.config": {
75
- "types": "./dist/remote/relay/convex/component/convex.config.d.ts",
76
- "default": "./dist/remote/relay/convex/component/convex.config.js"
77
- },
78
66
  "./remote/relay/memory": {
79
67
  "types": "./dist/remote/relay/memory/index.d.ts",
80
68
  "default": "./dist/remote/relay/memory/index.js"
@@ -123,9 +111,9 @@
123
111
  "types": "./dist/device/device-id.d.ts",
124
112
  "default": "./dist/device/device-id.js"
125
113
  },
126
- "./device/expo-metadata": {
127
- "types": "./dist/device/expo-metadata.d.ts",
128
- "default": "./dist/device/expo-metadata.js"
114
+ "./device/expo": {
115
+ "types": "./dist/device/expo/index.d.ts",
116
+ "default": "./dist/device/expo/index.js"
129
117
  },
130
118
  "./device/lifecycle": {
131
119
  "types": "./dist/device/lifecycle/index.d.ts",
@@ -151,6 +139,10 @@
151
139
  "types": "./dist/groups/index.d.ts",
152
140
  "default": "./dist/groups/index.js"
153
141
  },
142
+ "./groups/server": {
143
+ "types": "./dist/groups/server.d.ts",
144
+ "default": "./dist/groups/server.js"
145
+ },
154
146
  "./hooks": {
155
147
  "types": "./dist/hooks/index.d.ts",
156
148
  "default": "./dist/hooks/index.js"
@@ -297,8 +289,9 @@
297
289
  "ADAPTERS.md",
298
290
  "ARCHITECTURE.md",
299
291
  "CHANGELOG.md",
300
- "COMMERCIAL.md",
301
292
  "LICENSE",
293
+ "LICENSE-APACHE",
294
+ "LICENSE-MIT",
302
295
  "NOTICE",
303
296
  "README.md",
304
297
  "SECURITY.md",
@@ -346,8 +339,6 @@
346
339
  "remote/object-store/convex-r2/README.md",
347
340
  "remote/object-store/s3/README.md",
348
341
  "remote/relay/README.md",
349
- "remote/relay/convex/README.md",
350
- "remote/relay/convex/component/README.md",
351
342
  "remote/relay/memory/README.md",
352
343
  "safety/README.md",
353
344
  "scripts/oe-groups.mjs",
@@ -359,7 +350,7 @@
359
350
  ],
360
351
  "sideEffects": false,
361
352
  "engines": {
362
- "node": ">=18.0.0"
353
+ "node": ">=22.12.0"
363
354
  },
364
355
  "scripts": {
365
356
  "audit:dependencies": "npm audit --omit=dev --audit-level=moderate && npm audit --audit-level=moderate",
@@ -375,7 +366,6 @@
375
366
  },
376
367
  "peerDependencies": {
377
368
  "@convex-dev/r2": "^0.10.2",
378
- "@convex-dev/rate-limiter": "^0.3.2",
379
369
  "convex": "^1.42.1",
380
370
  "drizzle-orm": "^0.45.1",
381
371
  "expo": "~55.0.27",
@@ -384,6 +374,7 @@
384
374
  "expo-device": "~55.0.15",
385
375
  "expo-secure-store": "~55.0.15",
386
376
  "expo-sqlite": "~55.0.17",
377
+ "fs-native-extensions": "1.2.7",
387
378
  "idb": "^8.0.3",
388
379
  "react": "^19.0.0",
389
380
  "react-native": "^0.83.6",
@@ -393,9 +384,6 @@
393
384
  "@convex-dev/r2": {
394
385
  "optional": true
395
386
  },
396
- "@convex-dev/rate-limiter": {
397
- "optional": true
398
- },
399
387
  "convex": {
400
388
  "optional": true
401
389
  },
@@ -420,6 +408,9 @@
420
408
  "expo-sqlite": {
421
409
  "optional": true
422
410
  },
411
+ "fs-native-extensions": {
412
+ "optional": true
413
+ },
423
414
  "idb": {
424
415
  "optional": true
425
416
  },
@@ -450,13 +441,11 @@
450
441
  },
451
442
  "devDependencies": {
452
443
  "@convex-dev/r2": "^0.10.2",
453
- "@convex-dev/rate-limiter": "^0.3.2",
454
444
  "@swc/core": "^1.15.43",
455
445
  "@types/async-lock": "^1.4.0",
456
446
  "@types/node": "^22.0.0",
457
447
  "@types/react": "^19.0.0",
458
448
  "convex": "^1.42.3",
459
- "convex-test": "^0.0.54",
460
449
  "drizzle-orm": "^0.45.1",
461
450
  "esbuild": "^0.27.0",
462
451
  "expo": "~55.0.27",
@@ -465,6 +454,7 @@
465
454
  "expo-device": "~55.0.19",
466
455
  "expo-secure-store": "~55.0.16",
467
456
  "expo-sqlite": "~55.0.18",
457
+ "fs-native-extensions": "1.2.7",
468
458
  "idb": "^8.0.3",
469
459
  "react": "19.2.0",
470
460
  "react-native": "0.83.10",
package/remote/README.md CHANGED
@@ -17,7 +17,7 @@ replaceable and prevent them from owning private keys or plaintext.
17
17
 
18
18
  ### Relay
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
  - custom implementations via `ISignalProtocolRelayServer`
23
23
 
@@ -31,21 +31,21 @@ replaceable and prevent them from owning private keys or plaintext.
31
31
 
32
32
  <!-- doc-snippet:skip requires-production-adapters -->
33
33
  ```ts
34
- import { SignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
35
- import {
36
- ConvexSignalProtocolRelayServer,
37
- type ConvexSignalProtocolRelayApi,
38
- } from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
39
- import { ExpoSignalProtocolStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
40
- import { api } from "../convex/_generated/api";
41
-
42
- const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
43
-
44
- const signal = await SignalProtocolClient.create(userId, {
45
- storage: new ExpoSignalProtocolStore(),
46
- relay: new ConvexSignalProtocolRelayServer(convex, signalApi, {
47
- currentUserId: userId,
48
- }),
34
+ import { createHostedSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
35
+ import { expoStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
36
+
37
+ // Initialize the application-owned Expo/SQLCipher database bindings first.
38
+ const signal = await createHostedSignalProtocolClient({
39
+ adapters: {
40
+ // Expo storage owns this device's private keys and session state.
41
+ storage: expoStore(),
42
+ },
43
+ hosted: {
44
+ // The environment-scoped connection URL from the OpenE2EE console.
45
+ relayUrl: process.env.EXPO_PUBLIC_OPEN_E2EE_RELAY_URL!,
46
+ // Returns a short-lived signed assertion for the signed-in user.
47
+ getIdentityAssertion,
48
+ },
49
49
  });
50
50
  ```
51
51
 
@@ -46,5 +46,13 @@ Provider adapters:
46
46
  - [Convex R2](./convex-r2/README.md)
47
47
  - [Amazon S3 and compatible brokers](./s3/README.md)
48
48
 
49
+ ## Upload refusals
50
+
51
+ A broker can throw `RemoteObjectUploadError` for a specific upload refusal.
52
+ Use the exact `RemoteObjectUploadFailureCode` for expiry, clock skew, closed admission, unavailable objects, identity conflicts, or rejected authority.
53
+ These errors stop automatic retries and preserve the original preparation for explicit recovery.
54
+ Do not classify a storage URL expiry, network failure, or pending accepted settlement as a terminal upload refusal.
55
+ The [media guide](../../media/README.md#durable-upload-preparation) defines the recovery actions.
56
+
49
57
  See the [media guide](../../media/README.md) and
50
58
  [API reference](../../docs/api/README.md).
@@ -20,6 +20,7 @@ const remoteObjectStore = s3ObjectStore({
20
20
  createUpload: (input) => appStorageApi.createS3Upload(input),
21
21
  createDownload: (input) => appStorageApi.createS3Download(input),
22
22
  completeUpload: (input) => appStorageApi.completeS3Upload(input),
23
+ reconcileUpload: (input) => appStorageApi.reconcileS3Upload(input),
23
24
  deleteObject: (input) => appStorageApi.deleteS3Object(input),
24
25
  },
25
26
  });
@@ -32,10 +33,18 @@ The broker must:
32
33
  - generate opaque object identifiers and private provider keys
33
34
  - restrict signed operations to the reserved key and expected method
34
35
  - enforce content length and content type
36
+ - bind the exact ciphertext digest to each reservation
37
+
38
+ `reconcileUpload` is an optional backend capability for uncertain transfers.
39
+ It must authenticate the caller and verify stored bytes against the original reservation.
40
+ Return the object ID, exact length, and verified SHA-256 only after backend acceptance completes.
41
+ Return `null` only when bytes are absent and the original authorization remains valid.
42
+
43
+ Throw on unknown outcomes, mismatch, deletion, or expiry. Never create another reservation during reconciliation.
44
+ Omit this method when the backend checks only metadata or cannot verify stored bytes.
35
45
 
36
46
  Bucket names, credentials, and unrestricted SDK clients must not cross into the
37
47
  application client.
38
48
 
39
49
  See the [object-store guide](../README.md) and
40
50
  [media guide](../../../media/README.md).
41
-
@@ -30,8 +30,9 @@ const client = await createSignalProtocolClient({
30
30
  await client.syncToServer();
31
31
  ```
32
32
 
33
- For production, implement `ISignalProtocolRelayServer` or use the
34
- [Convex adapter](./convex/README.md). The application backend must authenticate
33
+ For production, connect to the OpenE2EE Signal Protocol Relay through
34
+ `createHostedSignalProtocolClient()` from the package root, or implement
35
+ `ISignalProtocolRelayServer` against your own backend. That backend must authenticate
35
36
  mutations, allocate linked-device IDs, consume one-time prekeys atomically,
36
37
  enforce access policy, and store only encrypted envelopes plus required routing
37
38
  metadata.
package/COMMERCIAL.md DELETED
@@ -1,56 +0,0 @@
1
- # Commercial licensing
2
-
3
- `@open-e2ee/signal-protocol-sdk` is dual-licensed. This file explains the
4
- commercial path; the open-source path is the
5
- [GNU AGPL-3.0-or-later](https://github.com/open-e2ee/signal-protocol-js/blob/main/LICENSE).
6
-
7
- ## Do you need a commercial license?
8
-
9
- You do **not** need one if your application complies with AGPLv3 — including
10
- its network-use provision (section 13): users who interact with your service
11
- over a network must be able to obtain the complete corresponding source of your
12
- application under AGPLv3.
13
-
14
- You likely **do** need one if any of these describe your product:
15
-
16
- - Closed-source or proprietary application, mobile or web, that ships or serves
17
- this SDK.
18
- - You cannot offer your application's source under AGPLv3 terms — for
19
- contractual, competitive, or policy reasons.
20
- - You are embedding the SDK in a product you redistribute to customers who
21
- will not receive AGPLv3 source (OEM).
22
-
23
- ## What the commercial license changes
24
-
25
- - **Grant.** The right to use, modify, and distribute the SDK in a proprietary
26
- product, without the AGPLv3 source-provision obligations.
27
- - **Scope.** Licensed per product, covering `@open-e2ee/signal-protocol-sdk`
28
- and its subpath adapters as named in your license record.
29
- - **Support.** Any support terms are those stated in your order form; nothing
30
- is implied here.
31
-
32
- It does **not** change the software: same package, same code, same versions,
33
- same [security policy](https://github.com/open-e2ee/signal-protocol-js/blob/main/SECURITY.md).
34
- There is no "commercial edition."
35
-
36
- ## Tiers and pricing
37
-
38
- Current tiers — Startup ($5,000/yr), Growth ($20,000/yr), and Enterprise/OEM
39
- (from $50,000/yr) — are described with their qualification criteria at
40
- [open-e2ee.dev/pricing](https://open-e2ee.dev/pricing). Startup licenses can be
41
- purchased self-serve through the [console](https://console.open-e2ee.dev);
42
- Growth and Enterprise start with an email.
43
-
44
- ## How buying works
45
-
46
- 1. Read the [Commercial Terms](https://open-e2ee.dev/legal/terms).
47
- 2. Startup tier: purchase directly in the [console](https://console.open-e2ee.dev)
48
- and download your signed license record immediately.
49
- 3. Growth, Enterprise, or anything unusual (OEM, source escrow, security
50
- review): email [licensing@open-e2ee.dev](mailto:licensing@open-e2ee.dev).
51
-
52
- ## Evaluation
53
-
54
- Evaluate under AGPLv3 first — the full SDK, not a trial build. Nothing about
55
- evaluation, prototyping, or internal proof-of-concept work requires a
56
- commercial license before you ship to users.
@@ -1 +0,0 @@
1
- {"version":3,"file":"expo-metadata.d.ts","sourceRoot":"","sources":["../../device/expo-metadata.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAIH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAE1D,OAAO,EAAE,CAAC;AAEV;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,mBAAmB,CAOzE"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"expo-metadata.js","sourceRoot":"","sources":["../../device/expo-metadata.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAKvC;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAAkB;IAClD,OAAO;QACL,UAAU;QACV,QAAQ,EAAE,QAAQ,CAAC,EAAE;QACrB,UAAU,EAAE,SAAS,CAAC,UAAU,EAAE,OAAO,IAAI,SAAS;QACtD,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE;KACvC,CAAC;AACJ,CAAC"}