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

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 (655) hide show
  1. package/ADAPTERS.md +1 -1
  2. package/CHANGELOG.md +767 -2
  3. package/COMMERCIAL.md +56 -0
  4. package/README.md +13 -8
  5. package/SECURITY.md +15 -1
  6. package/client/README.md +1 -1
  7. package/dist/client/client.d.ts.map +1 -1
  8. package/dist/client/client.js +16 -8
  9. package/dist/client/client.js.map +1 -1
  10. package/dist/client/config.d.ts +12 -2
  11. package/dist/client/config.d.ts.map +1 -1
  12. package/dist/client/config.js.map +1 -1
  13. package/dist/client/endorsement-manager.d.ts +19 -2
  14. package/dist/client/endorsement-manager.d.ts.map +1 -1
  15. package/dist/client/endorsement-manager.js +26 -10
  16. package/dist/client/endorsement-manager.js.map +1 -1
  17. package/dist/client/headless.d.ts +1 -1
  18. package/dist/client/headless.js +1 -1
  19. package/dist/client/sealed-sender-ops.d.ts +27 -1
  20. package/dist/client/sealed-sender-ops.d.ts.map +1 -1
  21. package/dist/client/sealed-sender-ops.js +36 -6
  22. package/dist/client/sealed-sender-ops.js.map +1 -1
  23. package/dist/client/signal-service-cipher.d.ts +16 -1
  24. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  25. package/dist/client/signal-service-cipher.js +112 -52
  26. package/dist/client/signal-service-cipher.js.map +1 -1
  27. package/dist/client/types.d.ts +20 -7
  28. package/dist/client/types.d.ts.map +1 -1
  29. package/dist/client/types.js.map +1 -1
  30. package/dist/index.d.ts +7 -0
  31. package/dist/index.d.ts.map +1 -1
  32. package/dist/index.js +7 -0
  33. package/dist/index.js.map +1 -1
  34. package/dist/internal/crypto/index.d.ts +1 -1
  35. package/dist/internal/crypto/index.d.ts.map +1 -1
  36. package/dist/internal/crypto/index.js +1 -1
  37. package/dist/internal/crypto/index.js.map +1 -1
  38. package/dist/internal/crypto/random.d.ts +9 -0
  39. package/dist/internal/crypto/random.d.ts.map +1 -1
  40. package/dist/internal/crypto/random.js +16 -0
  41. package/dist/internal/crypto/random.js.map +1 -1
  42. package/dist/internal/groups/manager.d.ts +37 -5
  43. package/dist/internal/groups/manager.d.ts.map +1 -1
  44. package/dist/internal/groups/manager.js +98 -15
  45. package/dist/internal/groups/manager.js.map +1 -1
  46. package/dist/internal/groups/server-engine.d.ts +48 -2
  47. package/dist/internal/groups/server-engine.d.ts.map +1 -1
  48. package/dist/internal/groups/server-engine.js +122 -13
  49. package/dist/internal/groups/server-engine.js.map +1 -1
  50. package/dist/internal/protocol/sealed-sender/decryption-v2.d.ts.map +1 -1
  51. package/dist/internal/protocol/sealed-sender/decryption-v2.js +32 -18
  52. package/dist/internal/protocol/sealed-sender/decryption-v2.js.map +1 -1
  53. package/dist/internal/protocol/sealed-sender/decryption.d.ts.map +1 -1
  54. package/dist/internal/protocol/sealed-sender/decryption.js +33 -19
  55. package/dist/internal/protocol/sealed-sender/decryption.js.map +1 -1
  56. package/dist/internal/protocol/sealed-sender/encryption-v2.d.ts.map +1 -1
  57. package/dist/internal/protocol/sealed-sender/encryption-v2.js +8 -14
  58. package/dist/internal/protocol/sealed-sender/encryption-v2.js.map +1 -1
  59. package/dist/internal/protocol/sealed-sender/encryption.d.ts +9 -4
  60. package/dist/internal/protocol/sealed-sender/encryption.d.ts.map +1 -1
  61. package/dist/internal/protocol/sealed-sender/encryption.js +7 -15
  62. package/dist/internal/protocol/sealed-sender/encryption.js.map +1 -1
  63. package/dist/internal/protocol/sealed-sender/proto/index.d.ts +6 -7
  64. package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
  65. package/dist/internal/protocol/sealed-sender/proto/index.js +5 -7
  66. package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
  67. package/dist/internal/protocol/sealed-sender/trust-root.d.ts +45 -0
  68. package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +1 -0
  69. package/dist/internal/protocol/sealed-sender/trust-root.js +77 -0
  70. package/dist/internal/protocol/sealed-sender/trust-root.js.map +1 -0
  71. package/dist/internal/protocol/sealed-sender/types.d.ts +64 -9
  72. package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
  73. package/dist/internal/protocol/sealed-sender/types.js +43 -0
  74. package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
  75. package/dist/internal/protocol/sender-keys/manager.d.ts +37 -0
  76. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  77. package/dist/internal/protocol/sender-keys/manager.js +108 -7
  78. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  79. package/dist/local/store/expo/adapter.d.ts +14 -15
  80. package/dist/local/store/expo/adapter.d.ts.map +1 -1
  81. package/dist/local/store/expo/adapter.js +109 -102
  82. package/dist/local/store/expo/adapter.js.map +1 -1
  83. package/dist/local/store/expo/db.d.ts +4 -1
  84. package/dist/local/store/expo/db.d.ts.map +1 -1
  85. package/dist/local/store/expo/db.js +5 -0
  86. package/dist/local/store/expo/db.js.map +1 -1
  87. package/dist/local/store/expo/index.d.ts +0 -2
  88. package/dist/local/store/expo/index.d.ts.map +1 -1
  89. package/dist/local/store/expo/index.js +1 -1
  90. package/dist/local/store/expo/index.js.map +1 -1
  91. package/dist/local/store/expo/models/index.d.ts +1 -1
  92. package/dist/local/store/expo/models/index.d.ts.map +1 -1
  93. package/dist/local/store/expo/models/index.js +2 -2
  94. package/dist/local/store/expo/models/index.js.map +1 -1
  95. package/dist/local/store/expo/models/sender-key.d.ts +101 -77
  96. package/dist/local/store/expo/models/sender-key.d.ts.map +1 -1
  97. package/dist/local/store/expo/models/sender-key.js +154 -124
  98. package/dist/local/store/expo/models/sender-key.js.map +1 -1
  99. package/dist/local/store/expo/schema.d.ts +134 -32
  100. package/dist/local/store/expo/schema.d.ts.map +1 -1
  101. package/dist/local/store/expo/schema.js +36 -7
  102. package/dist/local/store/expo/schema.js.map +1 -1
  103. package/dist/local/store/mock/adapter.d.ts +1 -0
  104. package/dist/local/store/mock/adapter.d.ts.map +1 -1
  105. package/dist/local/store/mock/adapter.js +18 -0
  106. package/dist/local/store/mock/adapter.js.map +1 -1
  107. package/dist/local/store/node/adapter.d.ts +53 -4
  108. package/dist/local/store/node/adapter.d.ts.map +1 -1
  109. package/dist/local/store/node/adapter.js +456 -9
  110. package/dist/local/store/node/adapter.js.map +1 -1
  111. package/dist/local/store/node/database.d.ts +68 -0
  112. package/dist/local/store/node/database.d.ts.map +1 -1
  113. package/dist/local/store/node/database.js +201 -18
  114. package/dist/local/store/node/database.js.map +1 -1
  115. package/dist/local/store/react-native/adapter.d.ts +39 -0
  116. package/dist/local/store/react-native/adapter.d.ts.map +1 -1
  117. package/dist/local/store/react-native/adapter.js +163 -8
  118. package/dist/local/store/react-native/adapter.js.map +1 -1
  119. package/dist/local/store/web/adapter.d.ts +1 -0
  120. package/dist/local/store/web/adapter.d.ts.map +1 -1
  121. package/dist/local/store/web/adapter.js +33 -1
  122. package/dist/local/store/web/adapter.js.map +1 -1
  123. package/dist/remote/relay/convex/backend.d.ts +405 -0
  124. package/dist/remote/relay/convex/backend.d.ts.map +1 -0
  125. package/dist/remote/relay/convex/backend.js +687 -0
  126. package/dist/remote/relay/convex/backend.js.map +1 -0
  127. package/dist/remote/relay/convex/component/_generated/api.d.ts +58 -0
  128. package/dist/remote/relay/convex/component/_generated/api.d.ts.map +1 -0
  129. package/dist/remote/relay/convex/component/_generated/api.js +31 -0
  130. package/dist/remote/relay/convex/component/_generated/api.js.map +1 -0
  131. package/dist/remote/relay/convex/component/_generated/component.d.ts +483 -0
  132. package/dist/remote/relay/convex/component/_generated/component.d.ts.map +1 -0
  133. package/dist/remote/relay/convex/component/_generated/component.js +11 -0
  134. package/dist/remote/relay/convex/component/_generated/component.js.map +1 -0
  135. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts +46 -0
  136. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts.map +1 -0
  137. package/dist/remote/relay/convex/component/_generated/dataModel.js +11 -0
  138. package/dist/remote/relay/convex/component/_generated/dataModel.js.map +1 -0
  139. package/dist/remote/relay/convex/component/_generated/server.d.ts +129 -0
  140. package/dist/remote/relay/convex/component/_generated/server.d.ts.map +1 -0
  141. package/dist/remote/relay/convex/component/_generated/server.js +79 -0
  142. package/dist/remote/relay/convex/component/_generated/server.js.map +1 -0
  143. package/dist/remote/relay/convex/component/accounts.d.ts +43 -0
  144. package/dist/remote/relay/convex/component/accounts.d.ts.map +1 -0
  145. package/dist/remote/relay/convex/component/accounts.js +181 -0
  146. package/dist/remote/relay/convex/component/accounts.js.map +1 -0
  147. package/dist/remote/relay/convex/component/certificates.d.ts +10 -0
  148. package/dist/remote/relay/convex/component/certificates.d.ts.map +1 -0
  149. package/dist/remote/relay/convex/component/certificates.js +122 -0
  150. package/dist/remote/relay/convex/component/certificates.js.map +1 -0
  151. package/dist/remote/relay/convex/component/cleanup.d.ts +32 -0
  152. package/dist/remote/relay/convex/component/cleanup.d.ts.map +1 -0
  153. package/dist/remote/relay/convex/component/cleanup.js +146 -0
  154. package/dist/remote/relay/convex/component/cleanup.js.map +1 -0
  155. package/dist/remote/relay/convex/component/convex.config.d.ts +5 -0
  156. package/dist/remote/relay/convex/component/convex.config.d.ts.map +1 -0
  157. package/dist/remote/relay/convex/component/convex.config.js +33 -0
  158. package/dist/remote/relay/convex/component/convex.config.js.map +1 -0
  159. package/dist/remote/relay/convex/component/crons.d.ts +3 -0
  160. package/dist/remote/relay/convex/component/crons.d.ts.map +1 -0
  161. package/dist/remote/relay/convex/component/crons.js +10 -0
  162. package/dist/remote/relay/convex/component/crons.js.map +1 -0
  163. package/dist/remote/relay/convex/component/devices.d.ts +101 -0
  164. package/dist/remote/relay/convex/component/devices.d.ts.map +1 -0
  165. package/dist/remote/relay/convex/component/devices.js +299 -0
  166. package/dist/remote/relay/convex/component/devices.js.map +1 -0
  167. package/dist/remote/relay/convex/component/errors.d.ts +22 -0
  168. package/dist/remote/relay/convex/component/errors.d.ts.map +1 -0
  169. package/dist/remote/relay/convex/component/errors.js +17 -0
  170. package/dist/remote/relay/convex/component/errors.js.map +1 -0
  171. package/dist/remote/relay/convex/component/groups.d.ts +63 -0
  172. package/dist/remote/relay/convex/component/groups.d.ts.map +1 -0
  173. package/dist/remote/relay/convex/component/groups.js +341 -0
  174. package/dist/remote/relay/convex/component/groups.js.map +1 -0
  175. package/dist/remote/relay/convex/component/keys.d.ts +130 -0
  176. package/dist/remote/relay/convex/component/keys.d.ts.map +1 -0
  177. package/dist/remote/relay/convex/component/keys.js +578 -0
  178. package/dist/remote/relay/convex/component/keys.js.map +1 -0
  179. package/dist/remote/relay/convex/component/messages.d.ts +119 -0
  180. package/dist/remote/relay/convex/component/messages.d.ts.map +1 -0
  181. package/dist/remote/relay/convex/component/messages.js +723 -0
  182. package/dist/remote/relay/convex/component/messages.js.map +1 -0
  183. package/dist/remote/relay/convex/component/provisioning.d.ts +92 -0
  184. package/dist/remote/relay/convex/component/provisioning.d.ts.map +1 -0
  185. package/dist/remote/relay/convex/component/provisioning.js +359 -0
  186. package/dist/remote/relay/convex/component/provisioning.js.map +1 -0
  187. package/dist/remote/relay/convex/component/runtime.d.ts +18 -0
  188. package/dist/remote/relay/convex/component/runtime.d.ts.map +1 -0
  189. package/dist/remote/relay/convex/component/runtime.js +142 -0
  190. package/dist/remote/relay/convex/component/runtime.js.map +1 -0
  191. package/dist/remote/relay/convex/component/schema.d.ts +358 -0
  192. package/dist/remote/relay/convex/component/schema.d.ts.map +1 -0
  193. package/dist/remote/relay/convex/component/schema.js +287 -0
  194. package/dist/remote/relay/convex/component/schema.js.map +1 -0
  195. package/dist/remote/relay/convex/component/zkAuth.d.ts +12 -0
  196. package/dist/remote/relay/convex/component/zkAuth.d.ts.map +1 -0
  197. package/dist/remote/relay/convex/component/zkAuth.js +71 -0
  198. package/dist/remote/relay/convex/component/zkAuth.js.map +1 -0
  199. package/dist/remote/relay/convex/constants.d.ts +3 -0
  200. package/dist/remote/relay/convex/constants.d.ts.map +1 -0
  201. package/dist/remote/relay/convex/constants.js +3 -0
  202. package/dist/remote/relay/convex/constants.js.map +1 -0
  203. package/dist/remote/relay/convex/group-server.d.ts +9 -6
  204. package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
  205. package/dist/remote/relay/convex/group-server.js +17 -11
  206. package/dist/remote/relay/convex/group-server.js.map +1 -1
  207. package/dist/remote/relay/convex/index.d.ts +4 -1
  208. package/dist/remote/relay/convex/index.d.ts.map +1 -1
  209. package/dist/remote/relay/convex/index.js +3 -1
  210. package/dist/remote/relay/convex/index.js.map +1 -1
  211. package/dist/remote/relay/convex/relay.d.ts +44 -65
  212. package/dist/remote/relay/convex/relay.d.ts.map +1 -1
  213. package/dist/remote/relay/convex/relay.js +61 -36
  214. package/dist/remote/relay/convex/relay.js.map +1 -1
  215. package/dist/remote/relay/convex/types.d.ts +16 -103
  216. package/dist/remote/relay/convex/types.d.ts.map +1 -1
  217. package/dist/remote/relay/convex/types.js +8 -13
  218. package/dist/remote/relay/convex/types.js.map +1 -1
  219. package/dist/remote/relay/index.d.ts +1 -1
  220. package/dist/remote/relay/index.d.ts.map +1 -1
  221. package/dist/remote/relay/index.js.map +1 -1
  222. package/dist/remote/relay/mock/adapter.d.ts +4 -9
  223. package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
  224. package/dist/remote/relay/mock/adapter.js +39 -22
  225. package/dist/remote/relay/mock/adapter.js.map +1 -1
  226. package/dist/remote/relay/types.d.ts +57 -75
  227. package/dist/remote/relay/types.d.ts.map +1 -1
  228. package/dist/remote/relay/types.js +0 -1
  229. package/dist/remote/relay/types.js.map +1 -1
  230. package/dist/types/api.d.ts +21 -0
  231. package/dist/types/api.d.ts.map +1 -1
  232. package/dist/types/protocol-config.d.ts +51 -0
  233. package/dist/types/protocol-config.d.ts.map +1 -1
  234. package/dist/types/protocol-config.js +46 -0
  235. package/dist/types/protocol-config.js.map +1 -1
  236. package/docs/ASSURANCE.md +10 -6
  237. package/docs/CLIENT_COMPOSITION.md +23 -69
  238. package/docs/DEVIATIONS.md +44 -11
  239. package/docs/E2EE.md +71 -6
  240. package/docs/GETTING_STARTED.md +1 -1
  241. package/docs/PACKAGE_SURFACE.md +6 -5
  242. package/docs/RECIPES.md +1 -1
  243. package/docs/SECURITY.md +8 -0
  244. package/local/store/README.md +3 -1
  245. package/local/store/expo/README.md +10 -1
  246. package/local/store/node/README.md +8 -1
  247. package/package.json +12 -7
  248. package/remote/relay/convex/README.md +1 -1
  249. package/remote/relay/convex/component/README.md +428 -0
  250. package/scripts/oe-groups.mjs +21 -1
  251. package/dist/remote/relay/convex/server/index.d.ts +0 -2
  252. package/dist/remote/relay/convex/server/index.d.ts.map +0 -1
  253. package/dist/remote/relay/convex/server/index.js +0 -2
  254. package/dist/remote/relay/convex/server/index.js.map +0 -1
  255. package/dist/remote/relay/convex/server.d.ts +0 -150
  256. package/dist/remote/relay/convex/server.d.ts.map +0 -1
  257. package/dist/remote/relay/convex/server.js +0 -506
  258. package/dist/remote/relay/convex/server.js.map +0 -1
  259. package/docs/api/README.md +0 -471
  260. package/docs/api/classes/EncryptionError.md +0 -112
  261. package/docs/api/classes/EndorsementManager.md +0 -325
  262. package/docs/api/classes/SealedSenderAuthError.md +0 -127
  263. package/docs/api/classes/ServerDerivedKeyPair.md +0 -68
  264. package/docs/api/classes/ServerDerivedPublicKey.md +0 -33
  265. package/docs/api/classes/ServerRootKeyPair.md +0 -94
  266. package/docs/api/classes/ServerRootPublicKey.md +0 -72
  267. package/docs/api/classes/SignalProtocolBlockingManager.md +0 -106
  268. package/docs/api/classes/SignalProtocolClient.md +0 -2654
  269. package/docs/api/classes/VerificationFailure.md +0 -25
  270. package/docs/api/enumerations/ContentHint.md +0 -63
  271. package/docs/api/enumerations/EncryptionErrorCode.md +0 -488
  272. package/docs/api/enumerations/IdentityKeyChange.md +0 -65
  273. package/docs/api/enumerations/MessageType.md +0 -29
  274. package/docs/api/enumerations/TrustDirection.md +0 -33
  275. package/docs/api/enumerations/TypingAction.md +0 -31
  276. package/docs/api/functions/createDefaultSignalProtocolContentAdapter.md +0 -13
  277. package/docs/api/functions/createDefaultSignalProtocolLogger.md +0 -36
  278. package/docs/api/functions/createGroupId.md +0 -32
  279. package/docs/api/functions/createSignalProtocolClient.md +0 -36
  280. package/docs/api/functions/createSignalProtocolClientConfig.md +0 -24
  281. package/docs/api/functions/decodeGroupTrustRoot.md +0 -21
  282. package/docs/api/functions/encodeGroupTrustRoot.md +0 -28
  283. package/docs/api/functions/extractGroupId.md +0 -32
  284. package/docs/api/functions/formatVersion.md +0 -25
  285. package/docs/api/functions/isCompatible.md +0 -31
  286. package/docs/api/functions/isGroupId.md +0 -37
  287. package/docs/api/functions/isSealedSenderAuthError.md +0 -25
  288. package/docs/api/functions/parseVersion.md +0 -29
  289. package/docs/api/functions/resolveSPQRLimits.md +0 -21
  290. package/docs/api/functions/resolveSignalProtocolLogger.md +0 -42
  291. package/docs/api/interfaces/AccountIdentityProvisioning.md +0 -43
  292. package/docs/api/interfaces/AccountIdentityRotation.md +0 -69
  293. package/docs/api/interfaces/AttachmentTransferOptions.md +0 -49
  294. package/docs/api/interfaces/BlockedRecipientEntry.md +0 -25
  295. package/docs/api/interfaces/BlockedRecipientsSyncInput.md +0 -27
  296. package/docs/api/interfaces/ConfigurationSyncInput.md +0 -19
  297. package/docs/api/interfaces/CredentialPublicKey.md +0 -25
  298. package/docs/api/interfaces/DataMessageInput.md +0 -21
  299. package/docs/api/interfaces/DecryptedEnvelope.md +0 -95
  300. package/docs/api/interfaces/DecryptedGroup.md +0 -86
  301. package/docs/api/interfaces/DeviceInfo.md +0 -79
  302. package/docs/api/interfaces/DeviceRecord.md +0 -87
  303. package/docs/api/interfaces/DeviceRegistration.md +0 -27
  304. package/docs/api/interfaces/DoubleRatchetConfig.md +0 -36
  305. package/docs/api/interfaces/EcOneTimePreKey.md +0 -27
  306. package/docs/api/interfaces/EcSignedPreKey.md +0 -39
  307. package/docs/api/interfaces/EcSignedPreKeyUpload.md +0 -50
  308. package/docs/api/interfaces/EncryptionErrorContext.md +0 -51
  309. package/docs/api/interfaces/Envelope.md +0 -154
  310. package/docs/api/interfaces/ForceKeyResetResult.md +0 -37
  311. package/docs/api/interfaces/GroupAuthorization.md +0 -23
  312. package/docs/api/interfaces/GroupChangeEntry.md +0 -42
  313. package/docs/api/interfaces/GroupMemberDevice.md +0 -26
  314. package/docs/api/interfaces/GroupTrustRoot.md +0 -33
  315. package/docs/api/interfaces/IEcOneTimePreKeyStore.md +0 -86
  316. package/docs/api/interfaces/IEcSignedPreKeyStore.md +0 -133
  317. package/docs/api/interfaces/IGroupServer.md +0 -120
  318. package/docs/api/interfaces/IGroupStateStore.md +0 -128
  319. package/docs/api/interfaces/IIdentityKeyStore.md +0 -312
  320. package/docs/api/interfaces/IKemPreKeyStore.md +0 -144
  321. package/docs/api/interfaces/IKyberLastResortPreKeyStore.md +0 -112
  322. package/docs/api/interfaces/ILogger.md +0 -117
  323. package/docs/api/interfaces/IProtocolStore.md +0 -1033
  324. package/docs/api/interfaces/IRelayGroupServer.md +0 -60
  325. package/docs/api/interfaces/ISenderKeyStore.md +0 -417
  326. package/docs/api/interfaces/ISesameStore.md +0 -249
  327. package/docs/api/interfaces/ISessionStore.md +0 -178
  328. package/docs/api/interfaces/ISignalProtocolClient.md +0 -1185
  329. package/docs/api/interfaces/ISignalProtocolLocalSecretVault.md +0 -71
  330. package/docs/api/interfaces/ISignalProtocolLocalStore.md +0 -2053
  331. package/docs/api/interfaces/ISignalProtocolManager.md +0 -272
  332. package/docs/api/interfaces/ISignalProtocolRelayServer.md +0 -1337
  333. package/docs/api/interfaces/IdentityKeyPair.md +0 -49
  334. package/docs/api/interfaces/IncomingEnvelope.md +0 -91
  335. package/docs/api/interfaces/InspectedSignalProtocolContent.md +0 -43
  336. package/docs/api/interfaces/KDFChain.md +0 -31
  337. package/docs/api/interfaces/KemLastResortPreKeyUpload.md +0 -50
  338. package/docs/api/interfaces/KeyPair.md +0 -23
  339. package/docs/api/interfaces/KyberPreKey.md +0 -42
  340. package/docs/api/interfaces/MLKEMBraidAgentState.md +0 -191
  341. package/docs/api/interfaces/MLKEMBraidMessage.md +0 -49
  342. package/docs/api/interfaces/MediaAttachmentDeleteSyncInput.md +0 -31
  343. package/docs/api/interfaces/MessageHeader.md +0 -49
  344. package/docs/api/interfaces/MessageRecord.md +0 -86
  345. package/docs/api/interfaces/ParsedReceiptContent.md +0 -19
  346. package/docs/api/interfaces/ParsedTypingContent.md +0 -19
  347. package/docs/api/interfaces/PreKeyMaintenanceStore.md +0 -88
  348. package/docs/api/interfaces/PreKeyMessage.md +0 -159
  349. package/docs/api/interfaces/PreKeyStatusResult.md +0 -21
  350. package/docs/api/interfaces/PreKeyUpload.md +0 -42
  351. package/docs/api/interfaces/ProcessEnvelopeOptions.md +0 -72
  352. package/docs/api/interfaces/ProtocolAddress.md +0 -38
  353. package/docs/api/interfaces/ProtocolStrategyConfig.md +0 -91
  354. package/docs/api/interfaces/RatchetMessage.md +0 -96
  355. package/docs/api/interfaces/ReadSyncEntryInput.md +0 -19
  356. package/docs/api/interfaces/ReceiverChain.md +0 -43
  357. package/docs/api/interfaces/RecipientUsernameSyncInput.md +0 -31
  358. package/docs/api/interfaces/RelayPreKeyBundle.md +0 -254
  359. package/docs/api/interfaces/RemoteObjectDownload.md +0 -33
  360. package/docs/api/interfaces/RemoteObjectUpload.md +0 -49
  361. package/docs/api/interfaces/ResolvedSPQRInfoStrings.md +0 -27
  362. package/docs/api/interfaces/ResolvedSPQRLimits.md +0 -37
  363. package/docs/api/interfaces/RetryRequest.md +0 -80
  364. package/docs/api/interfaces/SCKAState.md +0 -65
  365. package/docs/api/interfaces/SPQRLimits.md +0 -40
  366. package/docs/api/interfaces/SPQRState.md +0 -191
  367. package/docs/api/interfaces/SafetyNumber.md +0 -60
  368. package/docs/api/interfaces/SafetyNumberConfirmation.md +0 -46
  369. package/docs/api/interfaces/SealedSenderConfig.md +0 -70
  370. package/docs/api/interfaces/SendOptions.md +0 -191
  371. package/docs/api/interfaces/SendResult.md +0 -93
  372. package/docs/api/interfaces/SenderKeyDistributionMessage.md +0 -43
  373. package/docs/api/interfaces/SenderKeyState.md +0 -76
  374. package/docs/api/interfaces/SenderKeysConfig.md +0 -65
  375. package/docs/api/interfaces/SentSyncTranscriptInput.md +0 -31
  376. package/docs/api/interfaces/ServiceId.md +0 -19
  377. package/docs/api/interfaces/SesameMessage.md +0 -84
  378. package/docs/api/interfaces/SesameStats.md +0 -57
  379. package/docs/api/interfaces/SessionHealthResult.md +0 -120
  380. package/docs/api/interfaces/SessionRecord.md +0 -80
  381. package/docs/api/interfaces/SessionRecordMetadata.md +0 -109
  382. package/docs/api/interfaces/SessionState.md +0 -368
  383. package/docs/api/interfaces/SessionTrustCommit.md +0 -58
  384. package/docs/api/interfaces/SignalProtocolBlockingHooks.md +0 -44
  385. package/docs/api/interfaces/SignalProtocolBlockingManagerOptions.md +0 -31
  386. package/docs/api/interfaces/SignalProtocolBlockingMirror.md +0 -30
  387. package/docs/api/interfaces/SignalProtocolBlockingStore.md +0 -83
  388. package/docs/api/interfaces/SignalProtocolClientAdapterConfig.md +0 -44
  389. package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +0 -731
  390. package/docs/api/interfaces/SignalProtocolClientConfig.md +0 -895
  391. package/docs/api/interfaces/SignalProtocolClientDeleteLocalAttachmentInput.md +0 -25
  392. package/docs/api/interfaces/SignalProtocolClientHooks.md +0 -506
  393. package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +0 -51
  394. package/docs/api/interfaces/SignalProtocolClientLoadLocalAttachmentInput.md +0 -187
  395. package/docs/api/interfaces/SignalProtocolClientLoadedLocalAttachment.md +0 -19
  396. package/docs/api/interfaces/SignalProtocolClientMedia.md +0 -83
  397. package/docs/api/interfaces/SignalProtocolClientMediaCompletedResult.md +0 -25
  398. package/docs/api/interfaces/SignalProtocolClientMediaConfig.md +0 -157
  399. package/docs/api/interfaces/SignalProtocolClientMediaDownloadCompletedResult.md +0 -37
  400. package/docs/api/interfaces/SignalProtocolClientMediaDownloadNotNeededResult.md +0 -25
  401. package/docs/api/interfaces/SignalProtocolClientMediaFailedResult.md +0 -19
  402. package/docs/api/interfaces/SignalProtocolClientMediaOperationOptions.md +0 -53
  403. package/docs/api/interfaces/SignalProtocolClientMediaPendingResult.md +0 -19
  404. package/docs/api/interfaces/SignalProtocolClientMediaProcessResult.md +0 -43
  405. package/docs/api/interfaces/SignalProtocolClientMediaSkippedResult.md +0 -25
  406. package/docs/api/interfaces/SignalProtocolClientMediaUploadCompletedResult.md +0 -31
  407. package/docs/api/interfaces/SignalProtocolClientProcessPendingMediaOptions.md +0 -87
  408. package/docs/api/interfaces/SignalProtocolClientSaveDownloadedAttachmentInput.md +0 -25
  409. package/docs/api/interfaces/SignalProtocolClientSaveUploadedAttachmentInput.md +0 -25
  410. package/docs/api/interfaces/SignalProtocolClientSyncDeleteInput.md +0 -19
  411. package/docs/api/interfaces/SignalProtocolConfig.md +0 -50
  412. package/docs/api/interfaces/SignalProtocolContentAdapter.md +0 -325
  413. package/docs/api/interfaces/SignalProtocolRemoteObjectStore.md +0 -88
  414. package/docs/api/interfaces/SkippedSenderMessageKey.md +0 -26
  415. package/docs/api/interfaces/TaskNotificationAckSyncInput.md +0 -31
  416. package/docs/api/interfaces/TripleRatchetState.md +0 -64
  417. package/docs/api/interfaces/UserRecord.md +0 -71
  418. package/docs/api/interfaces/UsernameStateSyncInput.md +0 -19
  419. package/docs/api/interfaces/VerificationStateSyncInput.md +0 -31
  420. package/docs/api/interfaces/VersionNegotiationState.md +0 -84
  421. package/docs/api/interfaces/ViewOnceOpenSyncInput.md +0 -19
  422. package/docs/api/namespaces/ProtocolAddress/README.md +0 -33
  423. package/docs/api/namespaces/ProtocolAddress/functions/create.md +0 -41
  424. package/docs/api/namespaces/ProtocolAddress/functions/equals.md +0 -39
  425. package/docs/api/namespaces/ProtocolAddress/functions/fromStorageKey.md +0 -36
  426. package/docs/api/namespaces/ProtocolAddress/functions/isUser.md +0 -39
  427. package/docs/api/namespaces/ProtocolAddress/functions/isValid.md +0 -34
  428. package/docs/api/namespaces/ProtocolAddress/functions/parse.md +0 -41
  429. package/docs/api/namespaces/ProtocolAddress/functions/toStorageKey.md +0 -38
  430. package/docs/api/namespaces/ProtocolAddress/functions/toString.md +0 -34
  431. package/docs/api/namespaces/SessionRecord/README.md +0 -30
  432. package/docs/api/namespaces/SessionRecord/functions/archiveCurrent.md +0 -40
  433. package/docs/api/namespaces/SessionRecord/functions/archiveCurrentState.md +0 -34
  434. package/docs/api/namespaces/SessionRecord/functions/create.md +0 -25
  435. package/docs/api/namespaces/SessionRecord/functions/deserialize.md +0 -29
  436. package/docs/api/namespaces/SessionRecord/functions/findSession.md +0 -34
  437. package/docs/api/namespaces/SessionRecord/functions/getAllSessions.md +0 -25
  438. package/docs/api/namespaces/SessionRecord/functions/getArchivedCount.md +0 -25
  439. package/docs/api/namespaces/SessionRecord/functions/hasCurrentSession.md +0 -25
  440. package/docs/api/namespaces/SessionRecord/functions/hasUsableSenderChain.md +0 -36
  441. package/docs/api/namespaces/SessionRecord/functions/promoteSession.md +0 -34
  442. package/docs/api/namespaces/SessionRecord/functions/serialize.md +0 -28
  443. package/docs/api/namespaces/SessionRecord/variables/MAX_ARCHIVED_SESSIONS.md +0 -14
  444. package/docs/api/namespaces/SessionState/README.md +0 -15
  445. package/docs/api/namespaces/SessionState/functions/getSessionId.md +0 -32
  446. package/docs/api/namespaces/blocking/README.md +0 -43
  447. package/docs/api/namespaces/encoding/README.md +0 -33
  448. package/docs/api/namespaces/encoding/functions/base64ToUrlSafe.md +0 -28
  449. package/docs/api/namespaces/encoding/functions/bytesToBase64.md +0 -21
  450. package/docs/api/namespaces/encoding/functions/bytesToString.md +0 -21
  451. package/docs/api/namespaces/encoding/functions/bytesToUrlSafeBase64.md +0 -33
  452. package/docs/api/namespaces/encoding/functions/concatBytes.md +0 -21
  453. package/docs/api/namespaces/encoding/functions/stringToBytes.md +0 -21
  454. package/docs/api/namespaces/encoding/functions/urlSafeToBase64.md +0 -27
  455. package/docs/api/namespaces/keys/README.md +0 -130
  456. package/docs/api/namespaces/keys/functions/acceptContactIdentityRotation.md +0 -33
  457. package/docs/api/namespaces/keys/functions/assertIdentityCommitment.md +0 -25
  458. package/docs/api/namespaces/keys/functions/canonicalizeDeviceIdentityKey.md +0 -30
  459. package/docs/api/namespaces/keys/functions/compareDeviceIdentityKeys.md +0 -28
  460. package/docs/api/namespaces/keys/functions/compositeIdentitiesEqual.md +0 -23
  461. package/docs/api/namespaces/keys/functions/createCompositeIdentityV1.md +0 -19
  462. package/docs/api/namespaces/keys/functions/createPreKeySignatureContext.md +0 -31
  463. package/docs/api/namespaces/keys/functions/createUnverifiedContactIdentityRecord.md +0 -23
  464. package/docs/api/namespaces/keys/functions/decodeCompositeIdentityV1.md +0 -19
  465. package/docs/api/namespaces/keys/functions/deriveIdentityCommitment.md +0 -19
  466. package/docs/api/namespaces/keys/functions/encodeCompositeIdentityV1.md +0 -19
  467. package/docs/api/namespaces/keys/functions/evaluateContactIdentityCandidate.md +0 -27
  468. package/docs/api/namespaces/keys/functions/generateEcOneTimePreKeys.md +0 -37
  469. package/docs/api/namespaces/keys/functions/generateEcSignedPreKey.md +0 -39
  470. package/docs/api/namespaces/keys/functions/generateEcSignedPreKeyId.md +0 -21
  471. package/docs/api/namespaces/keys/functions/generateIdentityKeyPair.md +0 -24
  472. package/docs/api/namespaces/keys/functions/generateKemOneTimePreKeys.md +0 -47
  473. package/docs/api/namespaces/keys/functions/generateKyberLastResortPreKey.md +0 -37
  474. package/docs/api/namespaces/keys/functions/generateRegistrationId.md +0 -13
  475. package/docs/api/namespaces/keys/functions/isValidDeviceIdentityKey.md +0 -22
  476. package/docs/api/namespaces/keys/functions/signMlKem1024PreKey.md +0 -29
  477. package/docs/api/namespaces/keys/functions/signPreKey.md +0 -31
  478. package/docs/api/namespaces/keys/functions/validateContactIdentityRecord.md +0 -19
  479. package/docs/api/namespaces/keys/functions/verifyContactIdentityRecord.md +0 -31
  480. package/docs/api/namespaces/keys/functions/verifyMlKem1024PreKey.md +0 -33
  481. package/docs/api/namespaces/keys/functions/verifyPreKeySignature.md +0 -35
  482. package/docs/api/namespaces/keys/interfaces/CompositeIdentityV1.md +0 -33
  483. package/docs/api/namespaces/keys/interfaces/ContactIdentityRecord.md +0 -53
  484. package/docs/api/namespaces/keys/interfaces/KemOneTimePreKey.md +0 -43
  485. package/docs/api/namespaces/keys/type-aliases/IdentityCandidateStatus.md +0 -9
  486. package/docs/api/namespaces/keys/type-aliases/IdentityTrustState.md +0 -9
  487. package/docs/api/namespaces/keys/type-aliases/IdentityType.md +0 -9
  488. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_ED25519_TAG.md +0 -9
  489. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_LENGTH.md +0 -9
  490. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_VERSION.md +0 -9
  491. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_X25519_TAG.md +0 -9
  492. package/docs/api/namespaces/keys/variables/IDENTITY_COMMITMENT_V1_DOMAIN.md +0 -9
  493. package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_ML_KEM_1024.md +0 -9
  494. package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_X25519.md +0 -9
  495. package/docs/api/namespaces/keys/variables/PREKEY_SIGNATURE_V1_DOMAIN.md +0 -9
  496. package/docs/api/namespaces/keys/variables/UNPINNED_DEVICE_IDENTITY_KEY.md +0 -18
  497. package/docs/api/namespaces/media/README.md +0 -105
  498. package/docs/api/namespaces/media/classes/MediaAttachmentError.md +0 -57
  499. package/docs/api/namespaces/media/functions/createByteRangeMediaAttachmentTransfer.md +0 -19
  500. package/docs/api/namespaces/media/functions/createMediaAttachmentDeliveryId.md +0 -29
  501. package/docs/api/namespaces/media/functions/createMediaAttachmentId.md +0 -19
  502. package/docs/api/namespaces/media/functions/createMediaAttachmentMessage.md +0 -25
  503. package/docs/api/namespaces/media/functions/createMediaAttachmentPointer.md +0 -19
  504. package/docs/api/namespaces/media/functions/createTusMediaAttachmentTransfer.md +0 -19
  505. package/docs/api/namespaces/media/functions/deleteMediaAttachment.md +0 -23
  506. package/docs/api/namespaces/media/functions/executeMediaAttachmentJob.md +0 -23
  507. package/docs/api/namespaces/media/functions/isMediaAttachmentFlagSet.md +0 -19
  508. package/docs/api/namespaces/media/functions/parseMediaAttachmentMessage.md +0 -19
  509. package/docs/api/namespaces/media/functions/planMediaAttachmentCleanup.md +0 -23
  510. package/docs/api/namespaces/media/functions/planMediaAttachmentCleanupJobs.md +0 -19
  511. package/docs/api/namespaces/media/functions/planMediaAttachmentDeleteSync.md +0 -19
  512. package/docs/api/namespaces/media/functions/planMediaAttachmentDownloadJob.md +0 -19
  513. package/docs/api/namespaces/media/functions/planMediaAttachmentOpen.md +0 -19
  514. package/docs/api/namespaces/media/functions/planMediaAttachmentProcessing.md +0 -19
  515. package/docs/api/namespaces/media/functions/planMediaAttachmentUploadJob.md +0 -19
  516. package/docs/api/namespaces/media/functions/prepareMediaAttachmentUpload.md +0 -30
  517. package/docs/api/namespaces/media/functions/resolveMediaAttachment.md +0 -30
  518. package/docs/api/namespaces/media/functions/serializeMediaAttachmentMessage.md +0 -25
  519. package/docs/api/namespaces/media/functions/validateMediaAttachmentPolicy.md +0 -23
  520. package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentPartialStore.md +0 -68
  521. package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentTransferOptions.md +0 -91
  522. package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentOptions.md +0 -25
  523. package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentResult.md +0 -19
  524. package/docs/api/namespaces/media/interfaces/ExecuteMediaAttachmentJobOptions.md +0 -157
  525. package/docs/api/namespaces/media/interfaces/MediaAttachmentBackgroundJob.md +0 -85
  526. package/docs/api/namespaces/media/interfaces/MediaAttachmentCleanupPlan.md +0 -37
  527. package/docs/api/namespaces/media/interfaces/MediaAttachmentJobExecutionResult.md +0 -55
  528. package/docs/api/namespaces/media/interfaces/MediaAttachmentMessage.md +0 -31
  529. package/docs/api/namespaces/media/interfaces/MediaAttachmentOpenDecision.md +0 -31
  530. package/docs/api/namespaces/media/interfaces/MediaAttachmentPointer.md +0 -133
  531. package/docs/api/namespaces/media/interfaces/MediaAttachmentPolicy.md +0 -67
  532. package/docs/api/namespaces/media/interfaces/MediaAttachmentProcessingPlan.md +0 -73
  533. package/docs/api/namespaces/media/interfaces/MediaAttachmentProgress.md +0 -69
  534. package/docs/api/namespaces/media/interfaces/MediaAttachmentResumeState.md +0 -37
  535. package/docs/api/namespaces/media/interfaces/MediaAttachmentRetryOptions.md +0 -31
  536. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransfer.md +0 -51
  537. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferCheckpoint.md +0 -69
  538. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferOptions.md +0 -67
  539. package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadJobData.md +0 -19
  540. package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadResponse.md +0 -25
  541. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentCleanupJobsInput.md +0 -61
  542. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDeleteSyncInput.md +0 -25
  543. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDownloadJobInput.md +0 -161
  544. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentOpenInput.md +0 -25
  545. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentProcessingInput.md +0 -83
  546. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentUploadJobInput.md +0 -147
  547. package/docs/api/namespaces/media/interfaces/PrepareMediaAttachmentUploadOptions.md +0 -144
  548. package/docs/api/namespaces/media/interfaces/ResolveMediaAttachmentOptions.md +0 -55
  549. package/docs/api/namespaces/media/interfaces/ResolvedMediaAttachment.md +0 -109
  550. package/docs/api/namespaces/media/interfaces/TusMediaAttachmentTransferOptions.md +0 -85
  551. package/docs/api/namespaces/media/type-aliases/CreateMediaAttachmentPointerInput.md +0 -15
  552. package/docs/api/namespaces/media/type-aliases/MediaAttachmentCheckpointCallback.md +0 -19
  553. package/docs/api/namespaces/media/type-aliases/MediaAttachmentCleanupReason.md +0 -9
  554. package/docs/api/namespaces/media/type-aliases/MediaAttachmentErrorCode.md +0 -9
  555. package/docs/api/namespaces/media/type-aliases/MediaAttachmentFlag.md +0 -9
  556. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobExecutionStatus.md +0 -9
  557. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobOperation.md +0 -9
  558. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobPriority.md +0 -9
  559. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSkipReason.md +0 -9
  560. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSource.md +0 -9
  561. package/docs/api/namespaces/media/type-aliases/MediaAttachmentKnownIds.md +0 -9
  562. package/docs/api/namespaces/media/type-aliases/MediaAttachmentMessageType.md +0 -9
  563. package/docs/api/namespaces/media/type-aliases/MediaAttachmentProgressCallback.md +0 -19
  564. package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_DEFAULTS.md +0 -47
  565. package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_PRESETS.md +0 -95
  566. package/docs/api/namespaces/media/variables/MediaAttachmentCleanupReason.md +0 -27
  567. package/docs/api/namespaces/media/variables/MediaAttachmentErrorCode.md +0 -75
  568. package/docs/api/namespaces/media/variables/MediaAttachmentFlag.md +0 -23
  569. package/docs/api/namespaces/media/variables/MediaAttachmentJobExecutionStatus.md +0 -19
  570. package/docs/api/namespaces/media/variables/MediaAttachmentJobOperation.md +0 -31
  571. package/docs/api/namespaces/media/variables/MediaAttachmentJobPriority.md +0 -23
  572. package/docs/api/namespaces/media/variables/MediaAttachmentJobSource.md +0 -51
  573. package/docs/api/namespaces/media/variables/MediaAttachmentMessageType.md +0 -15
  574. package/docs/api/namespaces/media/variables/downloadMediaAttachment.md +0 -30
  575. package/docs/api/namespaces/safety/README.md +0 -61
  576. package/docs/api/namespaces/safety/classes/DisplayableFingerprint.md +0 -108
  577. package/docs/api/namespaces/safety/classes/Fingerprint.md +0 -104
  578. package/docs/api/namespaces/safety/classes/ScannableFingerprint.md +0 -209
  579. package/docs/api/namespaces/safety/functions/base64ToBytes.md +0 -21
  580. package/docs/api/namespaces/safety/functions/clearFingerprintCache.md +0 -15
  581. package/docs/api/namespaces/safety/functions/compareSafetyNumbers.md +0 -25
  582. package/docs/api/namespaces/safety/functions/createFingerprintData.md +0 -60
  583. package/docs/api/namespaces/safety/functions/extractQrData.md +0 -34
  584. package/docs/api/namespaces/safety/functions/generateCompositeSafetyNumber.md +0 -39
  585. package/docs/api/namespaces/safety/functions/generateEmojiFingerprint.md +0 -24
  586. package/docs/api/namespaces/safety/functions/generateSingleKeyReferenceSafetyNumber.md +0 -51
  587. package/docs/api/namespaces/safety/functions/generateVerifySchemeUrl.md +0 -32
  588. package/docs/api/namespaces/safety/functions/generateVerifyUrl.md +0 -49
  589. package/docs/api/namespaces/safety/functions/isValidSafetyNumber.md +0 -21
  590. package/docs/api/namespaces/safety/functions/isVerifyUrl.md +0 -45
  591. package/docs/api/namespaces/safety/functions/parseVerifyUrl.md +0 -31
  592. package/docs/api/namespaces/safety/interfaces/FingerprintData.md +0 -52
  593. package/docs/api/namespaces/safety/interfaces/SafetyNumber.md +0 -49
  594. package/docs/api/namespaces/safety/interfaces/VerifyLinkConfig.md +0 -28
  595. package/docs/api/namespaces/safety/interfaces/VerifyUrlParams.md +0 -49
  596. package/docs/api/namespaces/safety/type-aliases/CompareResult.md +0 -21
  597. package/docs/api/namespaces/safety/variables/DEFAULT_VERIFY_LINK_CONFIG.md +0 -12
  598. package/docs/api/namespaces/safety/variables/FINGERPRINT_ITERATIONS.md +0 -12
  599. package/docs/api/namespaces/safety/variables/FINGERPRINT_VERSION.md +0 -12
  600. package/docs/api/namespaces/safety/variables/VERIFY_BASE_URL.md +0 -11
  601. package/docs/api/namespaces/safety/variables/VERIFY_SCHEME_URL.md +0 -11
  602. package/docs/api/type-aliases/Base64.md +0 -20
  603. package/docs/api/type-aliases/BraidPolicy.md +0 -11
  604. package/docs/api/type-aliases/Bytes.md +0 -20
  605. package/docs/api/type-aliases/Ciphertext.md +0 -21
  606. package/docs/api/type-aliases/DeviceType.md +0 -11
  607. package/docs/api/type-aliases/DownloadedAttachment.md +0 -11
  608. package/docs/api/type-aliases/GroupId.md +0 -27
  609. package/docs/api/type-aliases/Hex.md +0 -20
  610. package/docs/api/type-aliases/HookName.md +0 -11
  611. package/docs/api/type-aliases/PostQuantumPolicy.md +0 -11
  612. package/docs/api/type-aliases/PreparedAttachmentUpload.md +0 -14
  613. package/docs/api/type-aliases/PrivateKey.md +0 -22
  614. package/docs/api/type-aliases/ProgressCallback.md +0 -45
  615. package/docs/api/type-aliases/PublicKey.md +0 -22
  616. package/docs/api/type-aliases/RemoteObjectCompleteUploadRequest.md +0 -19
  617. package/docs/api/type-aliases/RemoteObjectDeleteRequest.md +0 -19
  618. package/docs/api/type-aliases/RemoteObjectDownloadRequest.md +0 -19
  619. package/docs/api/type-aliases/RemoteObjectUploadRequest.md +0 -42
  620. package/docs/api/type-aliases/SCKAMode.md +0 -11
  621. package/docs/api/type-aliases/SealedSenderAuth.md +0 -15
  622. package/docs/api/type-aliases/SignalProtocolClientMediaCleanupInput.md +0 -9
  623. package/docs/api/type-aliases/SignalProtocolClientMediaCleanupResult.md +0 -9
  624. package/docs/api/type-aliases/SignalProtocolClientMediaDownloadInput.md +0 -9
  625. package/docs/api/type-aliases/SignalProtocolClientMediaDownloadResult.md +0 -9
  626. package/docs/api/type-aliases/SignalProtocolClientMediaOperationResult.md +0 -9
  627. package/docs/api/type-aliases/SignalProtocolClientMediaUploadInput.md +0 -9
  628. package/docs/api/type-aliases/SignalProtocolClientMediaUploadResult.md +0 -9
  629. package/docs/api/type-aliases/Signature.md +0 -21
  630. package/docs/api/type-aliases/Unsubscribe.md +0 -15
  631. package/docs/api/variables/BraidPolicy.md +0 -21
  632. package/docs/api/variables/DEFAULT_DEVICE_ID.md +0 -12
  633. package/docs/api/variables/DOUBLE_RATCHET_SPEC.md +0 -11
  634. package/docs/api/variables/GROUP_ID_PREFIX.md +0 -11
  635. package/docs/api/variables/GROUP_TRUST_ROOT_VERSION.md +0 -11
  636. package/docs/api/variables/KEY_REFRESH_INTERVAL_MS_DEFAULT.md +0 -11
  637. package/docs/api/variables/MAX_MESSAGE_KEYS.md +0 -14
  638. package/docs/api/variables/MAX_PREKEY_AGE_MS_DEFAULT.md +0 -11
  639. package/docs/api/variables/MAX_RECEIVER_CHAINS.md +0 -14
  640. package/docs/api/variables/MAX_REGISTRATION_ID.md +0 -16
  641. package/docs/api/variables/MAX_SKIP.md +0 -11
  642. package/docs/api/variables/MESSAGE_FORMAT.md +0 -11
  643. package/docs/api/variables/MIN_REGISTRATION_ID.md +0 -16
  644. package/docs/api/variables/ML_KEM_BRAID_SPEC.md +0 -11
  645. package/docs/api/variables/ONE_TIME_PREKEY_BATCH_SIZE.md +0 -21
  646. package/docs/api/variables/PQXDH_SPEC.md +0 -11
  647. package/docs/api/variables/PostQuantumPolicy.md +0 -21
  648. package/docs/api/variables/SENDER_KEY_FORMAT.md +0 -11
  649. package/docs/api/variables/SENDER_KEY_SPEC.md +0 -11
  650. package/docs/api/variables/SESAME_SPEC.md +0 -11
  651. package/docs/api/variables/SESSION_FORMAT.md +0 -11
  652. package/docs/api/variables/SPQR_LIMITS_DEFAULTS.md +0 -11
  653. package/docs/api/variables/X3DH_SPEC.md +0 -9
  654. package/docs/api/variables/defaultSignalProtocolLogger.md +0 -32
  655. package/remote/relay/convex/server/README.md +0 -146
@@ -1,895 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolClientConfig
6
-
7
- # Interface: SignalProtocolClientConfig
8
-
9
- Low-level SignalProtocolClient configuration options.
10
-
11
- Application code should usually prefer `createSignalProtocolClient()`, which groups
12
- account identity, adapters, and protocol policy into a friendlier shape. Use
13
- this config directly when lower-level integration code already has flattened
14
- client options.
15
-
16
- ## Example
17
-
18
- ```typescript
19
- import {
20
- createSignalProtocolClient,
21
- SignalProtocolClient,
22
- } from '@open-e2ee/signal-protocol-sdk';
23
- import {
24
- convexRelay,
25
- type ConvexSignalProtocolRelayApi,
26
- } from '@open-e2ee/signal-protocol-sdk/remote/relay/convex';
27
- import { api } from '../convex/_generated/api';
28
-
29
- const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
30
- const relay = convexRelay({ convex, api: signalApi, currentUserId: userId });
31
-
32
- // Preferred app-facing composition.
33
- const signal = await createSignalProtocolClient({
34
- identity: { userId },
35
- adapters: { storage, relay },
36
- });
37
-
38
- // Low-level factory with the same underlying options.
39
- const advancedSignalProtocol = await SignalProtocolClient.create(userId, {
40
- storage,
41
- relay,
42
- onProgress,
43
- ratchetConfig: {
44
- maxSkip: 2000,
45
- keyExpirationMs: 14 * 24 * 60 * 60 * 1000 // 14 days
46
- },
47
- enableDebugLogging: true
48
- });
49
- ```
50
-
51
- ## Properties
52
-
53
- ### aci?
54
-
55
- > `optional` **aci?**: [`ServiceId`](ServiceId.md)
56
-
57
- This account's ACI for Group System credential presentation.
58
-
59
- Required when `groups` is configured.
60
-
61
- ***
62
-
63
- ### contentAdapter?
64
-
65
- > `optional` **contentAdapter?**: [`SignalProtocolContentAdapter`](SignalProtocolContentAdapter.md)
66
-
67
- Application-provided content adapter.
68
-
69
- This is the boundary between the protocol layer and app-specific content,
70
- notification batching, and privacy preference policy.
71
-
72
- ***
73
-
74
- ### deviceId?
75
-
76
- > `optional` **deviceId?**: `number`
77
-
78
- Device identifier for multi-device support
79
-
80
- - 1 = Primary device (default)
81
- - 2-5 = Linked devices
82
-
83
- Device 1 bootstraps identity locally. Devices 2-5 must already have a
84
- provisioned identity imported into the provided storage before
85
- `SignalProtocolClient.create()` is called.
86
-
87
- Prekeys and sessions remain device-specific; account identity is shared.
88
- Maximum 5 devices per user (1 primary + 4 linked).
89
-
90
- #### Default
91
-
92
- ```ts
93
- 1 (primary device)
94
- ```
95
-
96
- #### Example
97
-
98
- ```typescript
99
- // Primary device
100
- const signal = await SignalProtocolClient.create(userId, {
101
- storage: customStorage,
102
- deviceId: 1
103
- });
104
-
105
- // Linked device (from QR code provisioning)
106
- const signal = await SignalProtocolClient.create(userId, {
107
- storage: provisionedLinkedDeviceStorage,
108
- deviceId: 2
109
- });
110
- ```
111
-
112
- ***
113
-
114
- ### enableDebugLogging?
115
-
116
- > `optional` **enableDebugLogging?**: `boolean`
117
-
118
- Enable debug logging
119
- Default: false
120
- Recommended: Enable in development, disable in production
121
-
122
- ***
123
-
124
- ### enablePniKeys?
125
-
126
- > `optional` **enablePniKeys?**: `boolean`
127
-
128
- Enable PNI (Phone Number Identity) cryptographic key generation
129
-
130
- When `true`, generates and syncs both ACI and PNI identity keys, prekeys,
131
- and Kyber prekeys for applications that maintain both account identifiers.
132
-
133
- When `false` (default), only ACI keys are generated and synchronized. Use
134
- this for applications whose account model does not require PNI keys.
135
-
136
- The PNI UUID on the users table is unaffected — it can still exist for ZK
137
- group credentials without generating cryptographic keys.
138
-
139
- #### Default
140
-
141
- ```ts
142
- false
143
- ```
144
-
145
- ***
146
-
147
- ### groups?
148
-
149
- > `optional` **groups?**: `object`
150
-
151
- Group System configuration.
152
- Required for group state management (create, sync, membership changes).
153
-
154
- #### allowUnauthenticatedGroupHistory?
155
-
156
- > `optional` **allowUnauthenticatedGroupHistory?**: `boolean`
157
-
158
- Explicitly accept group history without server signatures.
159
-
160
- This selects the documented non-conforming deployment mode and emits a
161
- visible configuration warning.
162
-
163
- #### endorsementManager?
164
-
165
- > `optional` **endorsementManager?**: [`EndorsementManager`](../classes/EndorsementManager.md)
166
-
167
- Pre-constructed EndorsementManager for group send endorsement-based auth.
168
-
169
- #### issueCredential?
170
-
171
- > `optional` **issueCredential?**: () => `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
172
-
173
- Override the relay's auth-credential issuance transport.
174
-
175
- ##### Returns
176
-
177
- `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
178
-
179
- #### issueProfileKeyCredential?
180
-
181
- > `optional` **issueProfileKeyCredential?**: () => `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
182
-
183
- Override the relay's profile-key credential issuance transport.
184
-
185
- ##### Returns
186
-
187
- `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
188
-
189
- #### onConfigurationWarning?
190
-
191
- > `optional` **onConfigurationWarning?**: (`warning`) => `void`
192
-
193
- Receive the §12.3 non-conforming deployment warning.
194
-
195
- ##### Parameters
196
-
197
- ###### warning
198
-
199
- `GroupConfigurationWarning`
200
-
201
- ##### Returns
202
-
203
- `void`
204
-
205
- #### profileKey
206
-
207
- > **profileKey**: `Uint8Array`
208
-
209
- This account's 32-byte profile key.
210
-
211
- #### resolveAciBytesByUserIds?
212
-
213
- > `optional` **resolveAciBytesByUserIds?**: (`userIds`) => `Promise`\<`Map`\<`string`, `Uint8Array`\<`ArrayBufferLike`\>\>\>
214
-
215
- Resolve member ACIs without importing app content models into the client.
216
-
217
- ##### Parameters
218
-
219
- ###### userIds
220
-
221
- `string`[]
222
-
223
- ##### Returns
224
-
225
- `Promise`\<`Map`\<`string`, `Uint8Array`\<`ArrayBufferLike`\>\>\>
226
-
227
- #### server?
228
-
229
- > `optional` **server?**: [`IGroupServer`](IGroupServer.md)
230
-
231
- Override `relay.groupServer.server` for a custom deployment.
232
-
233
- #### store?
234
-
235
- > `optional` **store?**: [`IGroupStateStore`](IGroupStateStore.md)
236
-
237
- Override the SDK local storage adapter for group state.
238
-
239
- #### trustRoot
240
-
241
- > **trustRoot**: `Uint8Array`
242
-
243
- Versioned serialized trust root pinned by the application at build time.
244
-
245
- This value is never fetched from the relay and trusted at runtime.
246
-
247
- #### Example
248
-
249
- ```typescript
250
- const signal = await SignalProtocolClient.create(userId, {
251
- storage: customStorage,
252
- relay,
253
- aci,
254
- pni,
255
- groups: {
256
- trustRoot: GROUP_TRUST_ROOT,
257
- profileKey,
258
- }
259
- });
260
- ```
261
-
262
- ***
263
-
264
- ### hooks?
265
-
266
- > `optional` **hooks?**: [`SignalProtocolClientHooks`](SignalProtocolClientHooks.md)
267
-
268
- Event hooks for Signal Protocol lifecycle events
269
-
270
- Provides integration points for applications to react to:
271
- - Session establishment/deletion
272
- - Key rotation
273
- - Message encryption/decryption
274
- - Errors and cleanup operations
275
-
276
- All hooks are optional and support both sync and async implementations.
277
- Hook errors are caught internally and won't affect core functionality.
278
-
279
- Common use cases:
280
- - Cache invalidation (ContentManager, React Query)
281
- - Analytics and monitoring (Sentry, DataDog)
282
- - State management integration (Redux, Zustand)
283
- - User notifications
284
-
285
- #### Examples
286
-
287
- **Basic usage**
288
-
289
- ```typescript
290
- const signal = await SignalProtocolClient.create(userId, {
291
- storage: customStorage,
292
- hooks: {
293
- onSessionEstablished: (sessionId) => {
294
- ContentManager.invalidateSession(sessionId);
295
- },
296
- onKeyRotated: (keyType) => {
297
- analytics.track('Key Rotated', { keyType });
298
- }
299
- }
300
- });
301
- ```
302
-
303
- **Error tracking**
304
-
305
- ```typescript
306
- const signal = await SignalProtocolClient.create(userId, {
307
- storage: customStorage,
308
- hooks: {
309
- onDecryptionError: (sessionId, error) => {
310
- Sentry.captureException(error, {
311
- tags: { sessionId }
312
- });
313
- }
314
- }
315
- });
316
- ```
317
-
318
- ***
319
-
320
- ### keyRefreshIntervalMs?
321
-
322
- > `optional` **keyRefreshIntervalMs?**: `number`
323
-
324
- Key refresh interval in milliseconds.
325
-
326
- Controls how often signed prekeys and Kyber (last-resort) prekeys are rotated.
327
- Per PQXDH specification Section 3.2, both key types use the same rotation
328
- schedule for synchronized post-quantum security.
329
-
330
- #### Default
331
-
332
- ```ts
333
- 172800000 (2 days)
334
- ```
335
-
336
- #### Examples
337
-
338
- **Default rotation interval**
339
-
340
- ```typescript
341
- const signal = await SignalProtocolClient.create(userId, {
342
- storage: customStorage,
343
- keyRefreshIntervalMs: 2 * 24 * 60 * 60 * 1000 // 2 days
344
- });
345
- ```
346
-
347
- **Weekly rotation (lower bandwidth)**
348
-
349
- ```typescript
350
- const signal = await SignalProtocolClient.create(userId, {
351
- storage: customStorage,
352
- keyRefreshIntervalMs: 7 * 24 * 60 * 60 * 1000 // 7 days
353
- });
354
- ```
355
-
356
- #### See
357
-
358
- https://signal.org/docs/specifications/pqxdh/#publishing-keys
359
-
360
- ***
361
-
362
- ### logger?
363
-
364
- > `optional` **logger?**: [`ILogger`](ILogger.md)
365
-
366
- Custom logger implementation
367
-
368
- Default: Environment-aware console logging
369
- - Development: verbose (debug, info, warn, error, breadcrumb)
370
- - Production: minimal (warn, error only)
371
-
372
- #### Examples
373
-
374
- **Using custom logger**
375
-
376
- ```typescript
377
- const signal = await SignalProtocolClient.create(userId, {
378
- storage: customStorage,
379
- logger: {
380
- info: (msg, data) => myLogger.log('info', msg, data),
381
- error: (msg, err) => myLogger.log('error', msg, err),
382
- warn: (msg, data) => myLogger.log('warn', msg, data)
383
- }
384
- });
385
- ```
386
-
387
- **Using console directly**
388
-
389
- ```typescript
390
- const signal = await SignalProtocolClient.create(userId, {
391
- storage: customStorage,
392
- logger: console // Works directly!
393
- });
394
- ```
395
-
396
- **Using pino**
397
-
398
- ```typescript
399
- import pino from 'pino';
400
- const signal = await SignalProtocolClient.create(userId, {
401
- storage: customStorage,
402
- logger: pino({ level: 'info' })
403
- });
404
- ```
405
-
406
- **Silent mode**
407
-
408
- ```typescript
409
- const signal = await SignalProtocolClient.create(userId, {
410
- storage: customStorage,
411
- logger: {} // All methods optional
412
- });
413
- ```
414
-
415
- ***
416
-
417
- ### maxPreKeyAgeMs?
418
-
419
- > `optional` **maxPreKeyAgeMs?**: `number`
420
-
421
- Maximum allowed prekey age in milliseconds.
422
-
423
- If prekeys exceed this age, message sending should be blocked to force
424
- key rotation. Provides a safety buffer above keyRefreshIntervalMs.
425
-
426
- With the default two-day refresh interval, the default maximum age leaves
427
- a twelve-day recovery window.
428
-
429
- #### Default
430
-
431
- ```ts
432
- 1209600000 (14 days)
433
- ```
434
-
435
- #### Example
436
-
437
- **Default maximum age**
438
-
439
- ```typescript
440
- const signal = await SignalProtocolClient.create(userId, {
441
- storage: customStorage,
442
- maxPreKeyAgeMs: 14 * 24 * 60 * 60 * 1000 // 14 days
443
- });
444
- ```
445
-
446
- #### See
447
-
448
- https://signal.org/docs/specifications/pqxdh/#publishing-keys
449
-
450
- ***
451
-
452
- ### media?
453
-
454
- > `optional` **media?**: [`SignalProtocolClientMediaConfig`](SignalProtocolClientMediaConfig.md)
455
-
456
- App-owned media lifecycle callbacks for the SignalProtocolClient media queue.
457
-
458
- The queue itself is persisted through the existing Signal Protocol local storage
459
- adapter. These callbacks keep local bytes, plaintext caches, and product
460
- state in the app layer where they can share file permissions, UI state, and
461
- app database ownership.
462
-
463
- #### Example
464
-
465
- ```typescript
466
- const signal = await createSignalProtocolClient({
467
- identity: { userId },
468
- adapters: { storage, relay, remoteObjectStore },
469
- media: {
470
- loadLocalAttachment: async ({ localMediaId }) => appDrafts.readBytes(localMediaId),
471
- saveUploadedAttachment: async ({ localMediaId, attachment }) =>
472
- appPointers.save(localMediaId, attachment),
473
- saveDownloadedAttachment: async ({ attachmentId, downloaded }) =>
474
- appMediaCache.save(attachmentId, downloaded.data),
475
- deleteLocalAttachment: async ({ attachmentId }) => appMediaCache.delete(attachmentId),
476
- },
477
- });
478
- ```
479
-
480
- ***
481
-
482
- ### onGroupSenderKeyRotated?
483
-
484
- > `optional` **onGroupSenderKeyRotated?**: (`groupId`, `newGeneration`) => `void`
485
-
486
- Called when a group sender key is rotated.
487
-
488
- Useful for logging, analytics, or triggering UI updates when
489
- sender keys are rotated due to membership changes.
490
-
491
- #### Parameters
492
-
493
- ##### groupId
494
-
495
- `string`
496
-
497
- The group whose sender key was rotated
498
-
499
- ##### newGeneration
500
-
501
- `number`
502
-
503
- The new generation number of the sender key
504
-
505
- #### Returns
506
-
507
- `void`
508
-
509
- #### Example
510
-
511
- ```typescript
512
- const signal = await SignalProtocolClient.create(userId, {
513
- storage: customStorage,
514
- onGroupSenderKeyRotated: (groupId, newGeneration) => {
515
- console.log(`Group ${groupId} sender key rotated to gen ${newGeneration}`);
516
- analytics.track('sender_key_rotated', { groupId, newGeneration });
517
- }
518
- });
519
- ```
520
-
521
- ***
522
-
523
- ### onPreKeyLow?
524
-
525
- > `optional` **onPreKeyLow?**: (`remaining`) => `void`
526
-
527
- Callback when one-time prekeys are running low
528
-
529
- Called when prekey count drops below the threshold (default: 50).
530
- Use this to trigger prekey replenishment to prevent session
531
- establishment failures.
532
-
533
- #### Parameters
534
-
535
- ##### remaining
536
-
537
- `number`
538
-
539
- #### Returns
540
-
541
- `void`
542
-
543
- #### Example
544
-
545
- ```typescript
546
- const signal = await SignalProtocolClient.create(userId, {
547
- storage: customStorage,
548
- onPreKeyLow: (remaining) => {
549
- console.warn(`Only ${remaining} prekeys remaining, replenishment needed`);
550
- // Trigger server-side prekey generation
551
- backend.replenishPrekeys(userId);
552
- }
553
- });
554
- ```
555
-
556
- ***
557
-
558
- ### onProgress?
559
-
560
- > `optional` **onProgress?**: [`ProgressCallback`](../type-aliases/ProgressCallback.md)
561
-
562
- Progress callback for initialization and relay sync operations.
563
-
564
- Receives updates during:
565
- - Key generation
566
- - Prekey bundle generation
567
- - Relay upload
568
-
569
- #### Example
570
-
571
- ```typescript
572
- const signal = await createSignalProtocolClient({
573
- identity: { userId },
574
- adapters: { storage, relay },
575
- onProgress: ({ stage, percent, message }) => {
576
- console.log(`${stage}: ${percent}% - ${message}`);
577
- }
578
- });
579
- ```
580
-
581
- ***
582
-
583
- ### pni?
584
-
585
- > `optional` **pni?**: [`ServiceId`](ServiceId.md)
586
-
587
- This account's optional PNI for Group System credential presentation.
588
-
589
- ***
590
-
591
- ### preKeyCheckThrottleMs?
592
-
593
- > `optional` **preKeyCheckThrottleMs?**: `number`
594
-
595
- Prekey check throttle interval in milliseconds.
596
-
597
- Controls how often prekey count checks are performed on app activation.
598
- Prevents unnecessary server queries when the app is repeatedly foregrounded.
599
-
600
- #### Default
601
-
602
- ```ts
603
- 43200000 (12 hours)
604
- ```
605
-
606
- #### See
607
-
608
- https://signal.org/docs/specifications/pqxdh/#publishing-keys
609
-
610
- ***
611
-
612
- ### preKeyLowThreshold?
613
-
614
- > `optional` **preKeyLowThreshold?**: `number`
615
-
616
- Threshold for prekey low warning
617
- Default: 50 (warn when fewer than 50 one-time prekeys remain)
618
-
619
- ***
620
-
621
- ### preKeyMaintenance?
622
-
623
- > `optional` **preKeyMaintenance?**: [`PreKeyMaintenanceStore`](PreKeyMaintenanceStore.md)
624
-
625
- App-provided prekey bookkeeping store.
626
-
627
- Needed for SQLite-backed adapters that track replaced prekeys separately
628
- from the protocol-facing local store interface.
629
-
630
- ***
631
-
632
- ### protocol?
633
-
634
- > `optional` **protocol?**: [`SignalProtocolConfig`](SignalProtocolConfig.md)
635
-
636
- Developer-facing protocol policy.
637
-
638
- The default is strict post-quantum behavior with the specification-defined
639
- ML-KEM Braid SPQR mode. Use `compatible` only when the product deliberately
640
- supports genuinely non-PQ peers. Use `braid: 'disabled'` only when a
641
- product-reviewed constraint requires the local direct SPQR mode.
642
-
643
- #### Default
644
-
645
- ```ts
646
- { postQuantum: 'required', braid: 'required' }
647
- ```
648
-
649
- #### Examples
650
-
651
- **Strict post-quantum mode**
652
-
653
- ```typescript
654
- const signal = await SignalProtocolClient.create(userId, {
655
- storage: customStorage,
656
- protocol: {
657
- postQuantum: 'required',
658
- braid: 'required'
659
- }
660
- });
661
- ```
662
-
663
- **Compatibility with non-PQ peers**
664
-
665
- ```typescript
666
- const signal = await SignalProtocolClient.create(userId, {
667
- storage: customStorage,
668
- protocol: {
669
- postQuantum: 'compatible',
670
- braid: 'required'
671
- }
672
- });
673
- ```
674
-
675
- **Explicit direct SPQR mode**
676
-
677
- ```typescript
678
- const signal = await SignalProtocolClient.create(userId, {
679
- storage: customStorage,
680
- protocol: {
681
- postQuantum: 'required',
682
- braid: 'disabled'
683
- }
684
- });
685
- ```
686
-
687
- ***
688
-
689
- ### protocolManager?
690
-
691
- > `optional` **protocolManager?**: [`ISignalProtocolManager`](ISignalProtocolManager.md)
692
-
693
- Signal Protocol Manager implementation (for advanced use cases)
694
- Default: Creates new SignalProtocolManager instance
695
-
696
- ***
697
-
698
- ### protocolStrategy?
699
-
700
- > `optional` **protocolStrategy?**: [`ProtocolStrategyConfig`](ProtocolStrategyConfig.md)
701
-
702
- Advanced protocol strategy configuration.
703
-
704
- Most application code should use `protocol.postQuantum` instead. This seam
705
- exists for diagnostics, telemetry callbacks, and advanced tuning.
706
-
707
- #### Example
708
-
709
- **Track protocol usage**
710
-
711
- ```typescript
712
- const signal = await SignalProtocolClient.create(userId, {
713
- storage: customStorage,
714
- protocolStrategy: {
715
- onProtocolSelected: (event) => {
716
- analytics.track('Protocol Selected', {
717
- pq: event.usedPQXDH,
718
- tripleRatchet: event.usedTripleRatchet,
719
- compatibilityFallback: event.usedClassicalFallback,
720
- fallbackReason: event.classicalFallbackReason
721
- });
722
- }
723
- }
724
- });
725
- ```
726
-
727
- ***
728
-
729
- ### ratchetConfig?
730
-
731
- > `optional` **ratchetConfig?**: [`DoubleRatchetConfig`](DoubleRatchetConfig.md)
732
-
733
- Double Ratchet algorithm configuration
734
-
735
- ***
736
-
737
- ### relay?
738
-
739
- > `optional` **relay?**: [`ISignalProtocolRelayServer`](ISignalProtocolRelayServer.md)
740
-
741
- Relay adapter for server synchronization.
742
-
743
- If provided, the client will automatically:
744
- 1. Generate prekey bundle
745
- 2. Upload public keys to the relay server
746
- 3. Provide progress updates via onProgress callback
747
-
748
- If omitted, client operates in local-only mode.
749
-
750
- #### Example
751
-
752
- ```typescript
753
- import { createSignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
754
- import {
755
- convexRelay,
756
- type ConvexSignalProtocolRelayApi,
757
- } from '@open-e2ee/signal-protocol-sdk/remote/relay/convex';
758
- import { api } from '../convex/_generated/api';
759
-
760
- const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
761
- const relay = convexRelay({ convex, api: signalApi, currentUserId: userId });
762
-
763
- const signal = await createSignalProtocolClient({
764
- identity: { userId },
765
- adapters: { storage, relay },
766
- });
767
- ```
768
-
769
- ***
770
-
771
- ### remoteObjectStore?
772
-
773
- > `optional` **remoteObjectStore?**: [`SignalProtocolRemoteObjectStore`](SignalProtocolRemoteObjectStore.md)
774
-
775
- Remote object storage adapter for encrypted file uploads (two-layer encryption)
776
-
777
- If provided, enables encrypted file upload (two-layer encryption):
778
- 1. Generate AES-256-GCM key
779
- 2. Encrypt file bytes with AES
780
- 3. Upload encrypted bytes to object storage
781
- 4. Send storage ID + key via Signal Protocol
782
-
783
- If omitted, file upload operations will throw an error.
784
-
785
- #### Example
786
-
787
- ```typescript
788
- import { createSignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
789
- import { convexR2ObjectStore } from '@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2';
790
- import { api } from '../convex/_generated/api';
791
-
792
- const remoteObjectStore = convexR2ObjectStore({
793
- convex,
794
- api: api.signalObjectStore,
795
- });
796
-
797
- const signal = await createSignalProtocolClient({
798
- identity: { userId },
799
- adapters: { storage, relay, remoteObjectStore },
800
- });
801
-
802
- // Send file bytes
803
- const fileBytes = new Uint8Array(await file.arrayBuffer());
804
- await signal.send('bob', fileBytes, { mimeType: 'image/jpeg' });
805
- ```
806
-
807
- ***
808
-
809
- ### sealedSender?
810
-
811
- > `optional` **sealedSender?**: [`SealedSenderConfig`](SealedSenderConfig.md)
812
-
813
- Sealed Sender configuration for anonymous message delivery.
814
-
815
- When configured, messages are wrapped with sealed sender encryption
816
- that hides the sender's identity from the server. The recipient can
817
- still verify the sender via the embedded certificate.
818
-
819
- Requires:
820
- - Server-side SEALED_SENDER_SIGNING_KEY environment variable
821
- - Trust root public key distributed to clients
822
-
823
- #### See
824
-
825
- https://signal.org/blog/sealed-sender/
826
-
827
- #### Example
828
-
829
- ```typescript
830
- const signal = await SignalProtocolClient.create(userId, {
831
- storage: customStorage,
832
- sealedSender: {
833
- trustRoots: [trustRootPublicKeyBytes],
834
- certificateProvider: async () => {
835
- return await convex.mutation(api.signal.certificates.issueSenderCertificate, { deviceId: 1 });
836
- },
837
- accessMode: 'unrestricted',
838
- }
839
- });
840
- ```
841
-
842
- ***
843
-
844
- ### senderKeys?
845
-
846
- > `optional` **senderKeys?**: [`SenderKeysConfig`](SenderKeysConfig.md)
847
-
848
- Sender Keys (group messaging) configuration.
849
-
850
- Controls HKDF info strings, DoS protection limits, and out-of-order
851
- message handling for group encryption.
852
-
853
- #### Examples
854
-
855
- **Custom protocol branding**
856
-
857
- ```typescript
858
- const signal = await SignalProtocolClient.create(userId, {
859
- storage: customStorage,
860
- senderKeys: {
861
- hkdfInfoString: 'MyApp Group V1'
862
- }
863
- });
864
- ```
865
-
866
- **Production-recommended limits (these are the defaults)**
867
-
868
- ```typescript
869
- const signal = await SignalProtocolClient.create(userId, {
870
- storage: customStorage,
871
- senderKeys: {
872
- maxChainAdvance: 2000, // DoS protection
873
- maxSkippedKeys: 2000 // Memory limit
874
- }
875
- });
876
- ```
877
-
878
- ***
879
-
880
- ### storage
881
-
882
- > **storage**: [`ISignalProtocolLocalStore`](ISignalProtocolLocalStore.md)
883
-
884
- Local store implementation for the current runtime.
885
- Required by SignalProtocolClient.create().
886
-
887
- ***
888
-
889
- ### throwDetailedErrors?
890
-
891
- > `optional` **throwDetailedErrors?**: `boolean`
892
-
893
- Throw detailed errors instead of generic messages
894
- Default: false (generic error messages for security)
895
- Recommended: Enable in development for debugging