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

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 (646) hide show
  1. package/ADAPTERS.md +1 -1
  2. package/CHANGELOG.md +680 -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 +13 -0
  43. package/dist/internal/groups/manager.d.ts.map +1 -1
  44. package/dist/internal/groups/manager.js +73 -12
  45. package/dist/internal/groups/manager.js.map +1 -1
  46. package/dist/internal/groups/server-engine.d.ts +31 -0
  47. package/dist/internal/groups/server-engine.d.ts.map +1 -1
  48. package/dist/internal/groups/server-engine.js +67 -7
  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/react-native/adapter.d.ts +39 -0
  108. package/dist/local/store/react-native/adapter.d.ts.map +1 -1
  109. package/dist/local/store/react-native/adapter.js +163 -8
  110. package/dist/local/store/react-native/adapter.js.map +1 -1
  111. package/dist/local/store/web/adapter.d.ts +1 -0
  112. package/dist/local/store/web/adapter.d.ts.map +1 -1
  113. package/dist/local/store/web/adapter.js +33 -1
  114. package/dist/local/store/web/adapter.js.map +1 -1
  115. package/dist/remote/relay/convex/backend.d.ts +402 -0
  116. package/dist/remote/relay/convex/backend.d.ts.map +1 -0
  117. package/dist/remote/relay/convex/backend.js +684 -0
  118. package/dist/remote/relay/convex/backend.js.map +1 -0
  119. package/dist/remote/relay/convex/component/_generated/api.d.ts +58 -0
  120. package/dist/remote/relay/convex/component/_generated/api.d.ts.map +1 -0
  121. package/dist/remote/relay/convex/component/_generated/api.js +31 -0
  122. package/dist/remote/relay/convex/component/_generated/api.js.map +1 -0
  123. package/dist/remote/relay/convex/component/_generated/component.d.ts +480 -0
  124. package/dist/remote/relay/convex/component/_generated/component.d.ts.map +1 -0
  125. package/dist/remote/relay/convex/component/_generated/component.js +11 -0
  126. package/dist/remote/relay/convex/component/_generated/component.js.map +1 -0
  127. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts +46 -0
  128. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts.map +1 -0
  129. package/dist/remote/relay/convex/component/_generated/dataModel.js +11 -0
  130. package/dist/remote/relay/convex/component/_generated/dataModel.js.map +1 -0
  131. package/dist/remote/relay/convex/component/_generated/server.d.ts +129 -0
  132. package/dist/remote/relay/convex/component/_generated/server.d.ts.map +1 -0
  133. package/dist/remote/relay/convex/component/_generated/server.js +79 -0
  134. package/dist/remote/relay/convex/component/_generated/server.js.map +1 -0
  135. package/dist/remote/relay/convex/component/accounts.d.ts +43 -0
  136. package/dist/remote/relay/convex/component/accounts.d.ts.map +1 -0
  137. package/dist/remote/relay/convex/component/accounts.js +181 -0
  138. package/dist/remote/relay/convex/component/accounts.js.map +1 -0
  139. package/dist/remote/relay/convex/component/certificates.d.ts +10 -0
  140. package/dist/remote/relay/convex/component/certificates.d.ts.map +1 -0
  141. package/dist/remote/relay/convex/component/certificates.js +122 -0
  142. package/dist/remote/relay/convex/component/certificates.js.map +1 -0
  143. package/dist/remote/relay/convex/component/cleanup.d.ts +26 -0
  144. package/dist/remote/relay/convex/component/cleanup.d.ts.map +1 -0
  145. package/dist/remote/relay/convex/component/cleanup.js +127 -0
  146. package/dist/remote/relay/convex/component/cleanup.js.map +1 -0
  147. package/dist/remote/relay/convex/component/convex.config.d.ts +5 -0
  148. package/dist/remote/relay/convex/component/convex.config.d.ts.map +1 -0
  149. package/dist/remote/relay/convex/component/convex.config.js +33 -0
  150. package/dist/remote/relay/convex/component/convex.config.js.map +1 -0
  151. package/dist/remote/relay/convex/component/crons.d.ts +3 -0
  152. package/dist/remote/relay/convex/component/crons.d.ts.map +1 -0
  153. package/dist/remote/relay/convex/component/crons.js +9 -0
  154. package/dist/remote/relay/convex/component/crons.js.map +1 -0
  155. package/dist/remote/relay/convex/component/devices.d.ts +101 -0
  156. package/dist/remote/relay/convex/component/devices.d.ts.map +1 -0
  157. package/dist/remote/relay/convex/component/devices.js +299 -0
  158. package/dist/remote/relay/convex/component/devices.js.map +1 -0
  159. package/dist/remote/relay/convex/component/errors.d.ts +22 -0
  160. package/dist/remote/relay/convex/component/errors.d.ts.map +1 -0
  161. package/dist/remote/relay/convex/component/errors.js +17 -0
  162. package/dist/remote/relay/convex/component/errors.js.map +1 -0
  163. package/dist/remote/relay/convex/component/groups.d.ts +60 -0
  164. package/dist/remote/relay/convex/component/groups.d.ts.map +1 -0
  165. package/dist/remote/relay/convex/component/groups.js +331 -0
  166. package/dist/remote/relay/convex/component/groups.js.map +1 -0
  167. package/dist/remote/relay/convex/component/keys.d.ts +130 -0
  168. package/dist/remote/relay/convex/component/keys.d.ts.map +1 -0
  169. package/dist/remote/relay/convex/component/keys.js +578 -0
  170. package/dist/remote/relay/convex/component/keys.js.map +1 -0
  171. package/dist/remote/relay/convex/component/messages.d.ts +119 -0
  172. package/dist/remote/relay/convex/component/messages.d.ts.map +1 -0
  173. package/dist/remote/relay/convex/component/messages.js +649 -0
  174. package/dist/remote/relay/convex/component/messages.js.map +1 -0
  175. package/dist/remote/relay/convex/component/provisioning.d.ts +92 -0
  176. package/dist/remote/relay/convex/component/provisioning.d.ts.map +1 -0
  177. package/dist/remote/relay/convex/component/provisioning.js +359 -0
  178. package/dist/remote/relay/convex/component/provisioning.js.map +1 -0
  179. package/dist/remote/relay/convex/component/runtime.d.ts +18 -0
  180. package/dist/remote/relay/convex/component/runtime.d.ts.map +1 -0
  181. package/dist/remote/relay/convex/component/runtime.js +142 -0
  182. package/dist/remote/relay/convex/component/runtime.js.map +1 -0
  183. package/dist/remote/relay/convex/component/schema.d.ts +344 -0
  184. package/dist/remote/relay/convex/component/schema.d.ts.map +1 -0
  185. package/dist/remote/relay/convex/component/schema.js +266 -0
  186. package/dist/remote/relay/convex/component/schema.js.map +1 -0
  187. package/dist/remote/relay/convex/component/zkAuth.d.ts +12 -0
  188. package/dist/remote/relay/convex/component/zkAuth.d.ts.map +1 -0
  189. package/dist/remote/relay/convex/component/zkAuth.js +71 -0
  190. package/dist/remote/relay/convex/component/zkAuth.js.map +1 -0
  191. package/dist/remote/relay/convex/constants.d.ts +3 -0
  192. package/dist/remote/relay/convex/constants.d.ts.map +1 -0
  193. package/dist/remote/relay/convex/constants.js +3 -0
  194. package/dist/remote/relay/convex/constants.js.map +1 -0
  195. package/dist/remote/relay/convex/group-server.d.ts +4 -2
  196. package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
  197. package/dist/remote/relay/convex/group-server.js +4 -2
  198. package/dist/remote/relay/convex/group-server.js.map +1 -1
  199. package/dist/remote/relay/convex/index.d.ts +4 -1
  200. package/dist/remote/relay/convex/index.d.ts.map +1 -1
  201. package/dist/remote/relay/convex/index.js +3 -1
  202. package/dist/remote/relay/convex/index.js.map +1 -1
  203. package/dist/remote/relay/convex/relay.d.ts +42 -63
  204. package/dist/remote/relay/convex/relay.d.ts.map +1 -1
  205. package/dist/remote/relay/convex/relay.js +51 -29
  206. package/dist/remote/relay/convex/relay.js.map +1 -1
  207. package/dist/remote/relay/convex/types.d.ts +16 -103
  208. package/dist/remote/relay/convex/types.d.ts.map +1 -1
  209. package/dist/remote/relay/convex/types.js +8 -13
  210. package/dist/remote/relay/convex/types.js.map +1 -1
  211. package/dist/remote/relay/index.d.ts +1 -1
  212. package/dist/remote/relay/index.d.ts.map +1 -1
  213. package/dist/remote/relay/index.js.map +1 -1
  214. package/dist/remote/relay/mock/adapter.d.ts +2 -7
  215. package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
  216. package/dist/remote/relay/mock/adapter.js +32 -20
  217. package/dist/remote/relay/mock/adapter.js.map +1 -1
  218. package/dist/remote/relay/types.d.ts +32 -69
  219. package/dist/remote/relay/types.d.ts.map +1 -1
  220. package/dist/remote/relay/types.js +0 -1
  221. package/dist/remote/relay/types.js.map +1 -1
  222. package/dist/types/api.d.ts +21 -0
  223. package/dist/types/api.d.ts.map +1 -1
  224. package/dist/types/protocol-config.d.ts +51 -0
  225. package/dist/types/protocol-config.d.ts.map +1 -1
  226. package/dist/types/protocol-config.js +46 -0
  227. package/dist/types/protocol-config.js.map +1 -1
  228. package/docs/ASSURANCE.md +10 -6
  229. package/docs/CLIENT_COMPOSITION.md +23 -69
  230. package/docs/DEVIATIONS.md +44 -11
  231. package/docs/E2EE.md +71 -6
  232. package/docs/GETTING_STARTED.md +1 -1
  233. package/docs/PACKAGE_SURFACE.md +6 -5
  234. package/docs/RECIPES.md +1 -1
  235. package/docs/SECURITY.md +8 -0
  236. package/local/store/expo/README.md +10 -1
  237. package/local/store/node/README.md +10 -1
  238. package/package.json +12 -7
  239. package/remote/relay/convex/README.md +1 -1
  240. package/remote/relay/convex/component/README.md +428 -0
  241. package/scripts/oe-groups.mjs +21 -1
  242. package/dist/remote/relay/convex/server/index.d.ts +0 -2
  243. package/dist/remote/relay/convex/server/index.d.ts.map +0 -1
  244. package/dist/remote/relay/convex/server/index.js +0 -2
  245. package/dist/remote/relay/convex/server/index.js.map +0 -1
  246. package/dist/remote/relay/convex/server.d.ts +0 -150
  247. package/dist/remote/relay/convex/server.d.ts.map +0 -1
  248. package/dist/remote/relay/convex/server.js +0 -506
  249. package/dist/remote/relay/convex/server.js.map +0 -1
  250. package/docs/api/README.md +0 -471
  251. package/docs/api/classes/EncryptionError.md +0 -112
  252. package/docs/api/classes/EndorsementManager.md +0 -325
  253. package/docs/api/classes/SealedSenderAuthError.md +0 -127
  254. package/docs/api/classes/ServerDerivedKeyPair.md +0 -68
  255. package/docs/api/classes/ServerDerivedPublicKey.md +0 -33
  256. package/docs/api/classes/ServerRootKeyPair.md +0 -94
  257. package/docs/api/classes/ServerRootPublicKey.md +0 -72
  258. package/docs/api/classes/SignalProtocolBlockingManager.md +0 -106
  259. package/docs/api/classes/SignalProtocolClient.md +0 -2654
  260. package/docs/api/classes/VerificationFailure.md +0 -25
  261. package/docs/api/enumerations/ContentHint.md +0 -63
  262. package/docs/api/enumerations/EncryptionErrorCode.md +0 -488
  263. package/docs/api/enumerations/IdentityKeyChange.md +0 -65
  264. package/docs/api/enumerations/MessageType.md +0 -29
  265. package/docs/api/enumerations/TrustDirection.md +0 -33
  266. package/docs/api/enumerations/TypingAction.md +0 -31
  267. package/docs/api/functions/createDefaultSignalProtocolContentAdapter.md +0 -13
  268. package/docs/api/functions/createDefaultSignalProtocolLogger.md +0 -36
  269. package/docs/api/functions/createGroupId.md +0 -32
  270. package/docs/api/functions/createSignalProtocolClient.md +0 -36
  271. package/docs/api/functions/createSignalProtocolClientConfig.md +0 -24
  272. package/docs/api/functions/decodeGroupTrustRoot.md +0 -21
  273. package/docs/api/functions/encodeGroupTrustRoot.md +0 -28
  274. package/docs/api/functions/extractGroupId.md +0 -32
  275. package/docs/api/functions/formatVersion.md +0 -25
  276. package/docs/api/functions/isCompatible.md +0 -31
  277. package/docs/api/functions/isGroupId.md +0 -37
  278. package/docs/api/functions/isSealedSenderAuthError.md +0 -25
  279. package/docs/api/functions/parseVersion.md +0 -29
  280. package/docs/api/functions/resolveSPQRLimits.md +0 -21
  281. package/docs/api/functions/resolveSignalProtocolLogger.md +0 -42
  282. package/docs/api/interfaces/AccountIdentityProvisioning.md +0 -43
  283. package/docs/api/interfaces/AccountIdentityRotation.md +0 -69
  284. package/docs/api/interfaces/AttachmentTransferOptions.md +0 -49
  285. package/docs/api/interfaces/BlockedRecipientEntry.md +0 -25
  286. package/docs/api/interfaces/BlockedRecipientsSyncInput.md +0 -27
  287. package/docs/api/interfaces/ConfigurationSyncInput.md +0 -19
  288. package/docs/api/interfaces/CredentialPublicKey.md +0 -25
  289. package/docs/api/interfaces/DataMessageInput.md +0 -21
  290. package/docs/api/interfaces/DecryptedEnvelope.md +0 -95
  291. package/docs/api/interfaces/DecryptedGroup.md +0 -86
  292. package/docs/api/interfaces/DeviceInfo.md +0 -79
  293. package/docs/api/interfaces/DeviceRecord.md +0 -87
  294. package/docs/api/interfaces/DeviceRegistration.md +0 -27
  295. package/docs/api/interfaces/DoubleRatchetConfig.md +0 -36
  296. package/docs/api/interfaces/EcOneTimePreKey.md +0 -27
  297. package/docs/api/interfaces/EcSignedPreKey.md +0 -39
  298. package/docs/api/interfaces/EcSignedPreKeyUpload.md +0 -50
  299. package/docs/api/interfaces/EncryptionErrorContext.md +0 -51
  300. package/docs/api/interfaces/Envelope.md +0 -154
  301. package/docs/api/interfaces/ForceKeyResetResult.md +0 -37
  302. package/docs/api/interfaces/GroupAuthorization.md +0 -23
  303. package/docs/api/interfaces/GroupChangeEntry.md +0 -42
  304. package/docs/api/interfaces/GroupMemberDevice.md +0 -26
  305. package/docs/api/interfaces/GroupTrustRoot.md +0 -33
  306. package/docs/api/interfaces/IEcOneTimePreKeyStore.md +0 -86
  307. package/docs/api/interfaces/IEcSignedPreKeyStore.md +0 -133
  308. package/docs/api/interfaces/IGroupServer.md +0 -120
  309. package/docs/api/interfaces/IGroupStateStore.md +0 -128
  310. package/docs/api/interfaces/IIdentityKeyStore.md +0 -312
  311. package/docs/api/interfaces/IKemPreKeyStore.md +0 -144
  312. package/docs/api/interfaces/IKyberLastResortPreKeyStore.md +0 -112
  313. package/docs/api/interfaces/ILogger.md +0 -117
  314. package/docs/api/interfaces/IProtocolStore.md +0 -1033
  315. package/docs/api/interfaces/IRelayGroupServer.md +0 -60
  316. package/docs/api/interfaces/ISenderKeyStore.md +0 -417
  317. package/docs/api/interfaces/ISesameStore.md +0 -249
  318. package/docs/api/interfaces/ISessionStore.md +0 -178
  319. package/docs/api/interfaces/ISignalProtocolClient.md +0 -1185
  320. package/docs/api/interfaces/ISignalProtocolLocalSecretVault.md +0 -71
  321. package/docs/api/interfaces/ISignalProtocolLocalStore.md +0 -2053
  322. package/docs/api/interfaces/ISignalProtocolManager.md +0 -272
  323. package/docs/api/interfaces/ISignalProtocolRelayServer.md +0 -1337
  324. package/docs/api/interfaces/IdentityKeyPair.md +0 -49
  325. package/docs/api/interfaces/IncomingEnvelope.md +0 -91
  326. package/docs/api/interfaces/InspectedSignalProtocolContent.md +0 -43
  327. package/docs/api/interfaces/KDFChain.md +0 -31
  328. package/docs/api/interfaces/KemLastResortPreKeyUpload.md +0 -50
  329. package/docs/api/interfaces/KeyPair.md +0 -23
  330. package/docs/api/interfaces/KyberPreKey.md +0 -42
  331. package/docs/api/interfaces/MLKEMBraidAgentState.md +0 -191
  332. package/docs/api/interfaces/MLKEMBraidMessage.md +0 -49
  333. package/docs/api/interfaces/MediaAttachmentDeleteSyncInput.md +0 -31
  334. package/docs/api/interfaces/MessageHeader.md +0 -49
  335. package/docs/api/interfaces/MessageRecord.md +0 -86
  336. package/docs/api/interfaces/ParsedReceiptContent.md +0 -19
  337. package/docs/api/interfaces/ParsedTypingContent.md +0 -19
  338. package/docs/api/interfaces/PreKeyMaintenanceStore.md +0 -88
  339. package/docs/api/interfaces/PreKeyMessage.md +0 -159
  340. package/docs/api/interfaces/PreKeyStatusResult.md +0 -21
  341. package/docs/api/interfaces/PreKeyUpload.md +0 -42
  342. package/docs/api/interfaces/ProcessEnvelopeOptions.md +0 -72
  343. package/docs/api/interfaces/ProtocolAddress.md +0 -38
  344. package/docs/api/interfaces/ProtocolStrategyConfig.md +0 -91
  345. package/docs/api/interfaces/RatchetMessage.md +0 -96
  346. package/docs/api/interfaces/ReadSyncEntryInput.md +0 -19
  347. package/docs/api/interfaces/ReceiverChain.md +0 -43
  348. package/docs/api/interfaces/RecipientUsernameSyncInput.md +0 -31
  349. package/docs/api/interfaces/RelayPreKeyBundle.md +0 -254
  350. package/docs/api/interfaces/RemoteObjectDownload.md +0 -33
  351. package/docs/api/interfaces/RemoteObjectUpload.md +0 -49
  352. package/docs/api/interfaces/ResolvedSPQRInfoStrings.md +0 -27
  353. package/docs/api/interfaces/ResolvedSPQRLimits.md +0 -37
  354. package/docs/api/interfaces/RetryRequest.md +0 -80
  355. package/docs/api/interfaces/SCKAState.md +0 -65
  356. package/docs/api/interfaces/SPQRLimits.md +0 -40
  357. package/docs/api/interfaces/SPQRState.md +0 -191
  358. package/docs/api/interfaces/SafetyNumber.md +0 -60
  359. package/docs/api/interfaces/SafetyNumberConfirmation.md +0 -46
  360. package/docs/api/interfaces/SealedSenderConfig.md +0 -70
  361. package/docs/api/interfaces/SendOptions.md +0 -191
  362. package/docs/api/interfaces/SendResult.md +0 -93
  363. package/docs/api/interfaces/SenderKeyDistributionMessage.md +0 -43
  364. package/docs/api/interfaces/SenderKeyState.md +0 -76
  365. package/docs/api/interfaces/SenderKeysConfig.md +0 -65
  366. package/docs/api/interfaces/SentSyncTranscriptInput.md +0 -31
  367. package/docs/api/interfaces/ServiceId.md +0 -19
  368. package/docs/api/interfaces/SesameMessage.md +0 -84
  369. package/docs/api/interfaces/SesameStats.md +0 -57
  370. package/docs/api/interfaces/SessionHealthResult.md +0 -120
  371. package/docs/api/interfaces/SessionRecord.md +0 -80
  372. package/docs/api/interfaces/SessionRecordMetadata.md +0 -109
  373. package/docs/api/interfaces/SessionState.md +0 -368
  374. package/docs/api/interfaces/SessionTrustCommit.md +0 -58
  375. package/docs/api/interfaces/SignalProtocolBlockingHooks.md +0 -44
  376. package/docs/api/interfaces/SignalProtocolBlockingManagerOptions.md +0 -31
  377. package/docs/api/interfaces/SignalProtocolBlockingMirror.md +0 -30
  378. package/docs/api/interfaces/SignalProtocolBlockingStore.md +0 -83
  379. package/docs/api/interfaces/SignalProtocolClientAdapterConfig.md +0 -44
  380. package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +0 -731
  381. package/docs/api/interfaces/SignalProtocolClientConfig.md +0 -895
  382. package/docs/api/interfaces/SignalProtocolClientDeleteLocalAttachmentInput.md +0 -25
  383. package/docs/api/interfaces/SignalProtocolClientHooks.md +0 -506
  384. package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +0 -51
  385. package/docs/api/interfaces/SignalProtocolClientLoadLocalAttachmentInput.md +0 -187
  386. package/docs/api/interfaces/SignalProtocolClientLoadedLocalAttachment.md +0 -19
  387. package/docs/api/interfaces/SignalProtocolClientMedia.md +0 -83
  388. package/docs/api/interfaces/SignalProtocolClientMediaCompletedResult.md +0 -25
  389. package/docs/api/interfaces/SignalProtocolClientMediaConfig.md +0 -157
  390. package/docs/api/interfaces/SignalProtocolClientMediaDownloadCompletedResult.md +0 -37
  391. package/docs/api/interfaces/SignalProtocolClientMediaDownloadNotNeededResult.md +0 -25
  392. package/docs/api/interfaces/SignalProtocolClientMediaFailedResult.md +0 -19
  393. package/docs/api/interfaces/SignalProtocolClientMediaOperationOptions.md +0 -53
  394. package/docs/api/interfaces/SignalProtocolClientMediaPendingResult.md +0 -19
  395. package/docs/api/interfaces/SignalProtocolClientMediaProcessResult.md +0 -43
  396. package/docs/api/interfaces/SignalProtocolClientMediaSkippedResult.md +0 -25
  397. package/docs/api/interfaces/SignalProtocolClientMediaUploadCompletedResult.md +0 -31
  398. package/docs/api/interfaces/SignalProtocolClientProcessPendingMediaOptions.md +0 -87
  399. package/docs/api/interfaces/SignalProtocolClientSaveDownloadedAttachmentInput.md +0 -25
  400. package/docs/api/interfaces/SignalProtocolClientSaveUploadedAttachmentInput.md +0 -25
  401. package/docs/api/interfaces/SignalProtocolClientSyncDeleteInput.md +0 -19
  402. package/docs/api/interfaces/SignalProtocolConfig.md +0 -50
  403. package/docs/api/interfaces/SignalProtocolContentAdapter.md +0 -325
  404. package/docs/api/interfaces/SignalProtocolRemoteObjectStore.md +0 -88
  405. package/docs/api/interfaces/SkippedSenderMessageKey.md +0 -26
  406. package/docs/api/interfaces/TaskNotificationAckSyncInput.md +0 -31
  407. package/docs/api/interfaces/TripleRatchetState.md +0 -64
  408. package/docs/api/interfaces/UserRecord.md +0 -71
  409. package/docs/api/interfaces/UsernameStateSyncInput.md +0 -19
  410. package/docs/api/interfaces/VerificationStateSyncInput.md +0 -31
  411. package/docs/api/interfaces/VersionNegotiationState.md +0 -84
  412. package/docs/api/interfaces/ViewOnceOpenSyncInput.md +0 -19
  413. package/docs/api/namespaces/ProtocolAddress/README.md +0 -33
  414. package/docs/api/namespaces/ProtocolAddress/functions/create.md +0 -41
  415. package/docs/api/namespaces/ProtocolAddress/functions/equals.md +0 -39
  416. package/docs/api/namespaces/ProtocolAddress/functions/fromStorageKey.md +0 -36
  417. package/docs/api/namespaces/ProtocolAddress/functions/isUser.md +0 -39
  418. package/docs/api/namespaces/ProtocolAddress/functions/isValid.md +0 -34
  419. package/docs/api/namespaces/ProtocolAddress/functions/parse.md +0 -41
  420. package/docs/api/namespaces/ProtocolAddress/functions/toStorageKey.md +0 -38
  421. package/docs/api/namespaces/ProtocolAddress/functions/toString.md +0 -34
  422. package/docs/api/namespaces/SessionRecord/README.md +0 -30
  423. package/docs/api/namespaces/SessionRecord/functions/archiveCurrent.md +0 -40
  424. package/docs/api/namespaces/SessionRecord/functions/archiveCurrentState.md +0 -34
  425. package/docs/api/namespaces/SessionRecord/functions/create.md +0 -25
  426. package/docs/api/namespaces/SessionRecord/functions/deserialize.md +0 -29
  427. package/docs/api/namespaces/SessionRecord/functions/findSession.md +0 -34
  428. package/docs/api/namespaces/SessionRecord/functions/getAllSessions.md +0 -25
  429. package/docs/api/namespaces/SessionRecord/functions/getArchivedCount.md +0 -25
  430. package/docs/api/namespaces/SessionRecord/functions/hasCurrentSession.md +0 -25
  431. package/docs/api/namespaces/SessionRecord/functions/hasUsableSenderChain.md +0 -36
  432. package/docs/api/namespaces/SessionRecord/functions/promoteSession.md +0 -34
  433. package/docs/api/namespaces/SessionRecord/functions/serialize.md +0 -28
  434. package/docs/api/namespaces/SessionRecord/variables/MAX_ARCHIVED_SESSIONS.md +0 -14
  435. package/docs/api/namespaces/SessionState/README.md +0 -15
  436. package/docs/api/namespaces/SessionState/functions/getSessionId.md +0 -32
  437. package/docs/api/namespaces/blocking/README.md +0 -43
  438. package/docs/api/namespaces/encoding/README.md +0 -33
  439. package/docs/api/namespaces/encoding/functions/base64ToUrlSafe.md +0 -28
  440. package/docs/api/namespaces/encoding/functions/bytesToBase64.md +0 -21
  441. package/docs/api/namespaces/encoding/functions/bytesToString.md +0 -21
  442. package/docs/api/namespaces/encoding/functions/bytesToUrlSafeBase64.md +0 -33
  443. package/docs/api/namespaces/encoding/functions/concatBytes.md +0 -21
  444. package/docs/api/namespaces/encoding/functions/stringToBytes.md +0 -21
  445. package/docs/api/namespaces/encoding/functions/urlSafeToBase64.md +0 -27
  446. package/docs/api/namespaces/keys/README.md +0 -130
  447. package/docs/api/namespaces/keys/functions/acceptContactIdentityRotation.md +0 -33
  448. package/docs/api/namespaces/keys/functions/assertIdentityCommitment.md +0 -25
  449. package/docs/api/namespaces/keys/functions/canonicalizeDeviceIdentityKey.md +0 -30
  450. package/docs/api/namespaces/keys/functions/compareDeviceIdentityKeys.md +0 -28
  451. package/docs/api/namespaces/keys/functions/compositeIdentitiesEqual.md +0 -23
  452. package/docs/api/namespaces/keys/functions/createCompositeIdentityV1.md +0 -19
  453. package/docs/api/namespaces/keys/functions/createPreKeySignatureContext.md +0 -31
  454. package/docs/api/namespaces/keys/functions/createUnverifiedContactIdentityRecord.md +0 -23
  455. package/docs/api/namespaces/keys/functions/decodeCompositeIdentityV1.md +0 -19
  456. package/docs/api/namespaces/keys/functions/deriveIdentityCommitment.md +0 -19
  457. package/docs/api/namespaces/keys/functions/encodeCompositeIdentityV1.md +0 -19
  458. package/docs/api/namespaces/keys/functions/evaluateContactIdentityCandidate.md +0 -27
  459. package/docs/api/namespaces/keys/functions/generateEcOneTimePreKeys.md +0 -37
  460. package/docs/api/namespaces/keys/functions/generateEcSignedPreKey.md +0 -39
  461. package/docs/api/namespaces/keys/functions/generateEcSignedPreKeyId.md +0 -21
  462. package/docs/api/namespaces/keys/functions/generateIdentityKeyPair.md +0 -24
  463. package/docs/api/namespaces/keys/functions/generateKemOneTimePreKeys.md +0 -47
  464. package/docs/api/namespaces/keys/functions/generateKyberLastResortPreKey.md +0 -37
  465. package/docs/api/namespaces/keys/functions/generateRegistrationId.md +0 -13
  466. package/docs/api/namespaces/keys/functions/isValidDeviceIdentityKey.md +0 -22
  467. package/docs/api/namespaces/keys/functions/signMlKem1024PreKey.md +0 -29
  468. package/docs/api/namespaces/keys/functions/signPreKey.md +0 -31
  469. package/docs/api/namespaces/keys/functions/validateContactIdentityRecord.md +0 -19
  470. package/docs/api/namespaces/keys/functions/verifyContactIdentityRecord.md +0 -31
  471. package/docs/api/namespaces/keys/functions/verifyMlKem1024PreKey.md +0 -33
  472. package/docs/api/namespaces/keys/functions/verifyPreKeySignature.md +0 -35
  473. package/docs/api/namespaces/keys/interfaces/CompositeIdentityV1.md +0 -33
  474. package/docs/api/namespaces/keys/interfaces/ContactIdentityRecord.md +0 -53
  475. package/docs/api/namespaces/keys/interfaces/KemOneTimePreKey.md +0 -43
  476. package/docs/api/namespaces/keys/type-aliases/IdentityCandidateStatus.md +0 -9
  477. package/docs/api/namespaces/keys/type-aliases/IdentityTrustState.md +0 -9
  478. package/docs/api/namespaces/keys/type-aliases/IdentityType.md +0 -9
  479. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_ED25519_TAG.md +0 -9
  480. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_LENGTH.md +0 -9
  481. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_VERSION.md +0 -9
  482. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_X25519_TAG.md +0 -9
  483. package/docs/api/namespaces/keys/variables/IDENTITY_COMMITMENT_V1_DOMAIN.md +0 -9
  484. package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_ML_KEM_1024.md +0 -9
  485. package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_X25519.md +0 -9
  486. package/docs/api/namespaces/keys/variables/PREKEY_SIGNATURE_V1_DOMAIN.md +0 -9
  487. package/docs/api/namespaces/keys/variables/UNPINNED_DEVICE_IDENTITY_KEY.md +0 -18
  488. package/docs/api/namespaces/media/README.md +0 -105
  489. package/docs/api/namespaces/media/classes/MediaAttachmentError.md +0 -57
  490. package/docs/api/namespaces/media/functions/createByteRangeMediaAttachmentTransfer.md +0 -19
  491. package/docs/api/namespaces/media/functions/createMediaAttachmentDeliveryId.md +0 -29
  492. package/docs/api/namespaces/media/functions/createMediaAttachmentId.md +0 -19
  493. package/docs/api/namespaces/media/functions/createMediaAttachmentMessage.md +0 -25
  494. package/docs/api/namespaces/media/functions/createMediaAttachmentPointer.md +0 -19
  495. package/docs/api/namespaces/media/functions/createTusMediaAttachmentTransfer.md +0 -19
  496. package/docs/api/namespaces/media/functions/deleteMediaAttachment.md +0 -23
  497. package/docs/api/namespaces/media/functions/executeMediaAttachmentJob.md +0 -23
  498. package/docs/api/namespaces/media/functions/isMediaAttachmentFlagSet.md +0 -19
  499. package/docs/api/namespaces/media/functions/parseMediaAttachmentMessage.md +0 -19
  500. package/docs/api/namespaces/media/functions/planMediaAttachmentCleanup.md +0 -23
  501. package/docs/api/namespaces/media/functions/planMediaAttachmentCleanupJobs.md +0 -19
  502. package/docs/api/namespaces/media/functions/planMediaAttachmentDeleteSync.md +0 -19
  503. package/docs/api/namespaces/media/functions/planMediaAttachmentDownloadJob.md +0 -19
  504. package/docs/api/namespaces/media/functions/planMediaAttachmentOpen.md +0 -19
  505. package/docs/api/namespaces/media/functions/planMediaAttachmentProcessing.md +0 -19
  506. package/docs/api/namespaces/media/functions/planMediaAttachmentUploadJob.md +0 -19
  507. package/docs/api/namespaces/media/functions/prepareMediaAttachmentUpload.md +0 -30
  508. package/docs/api/namespaces/media/functions/resolveMediaAttachment.md +0 -30
  509. package/docs/api/namespaces/media/functions/serializeMediaAttachmentMessage.md +0 -25
  510. package/docs/api/namespaces/media/functions/validateMediaAttachmentPolicy.md +0 -23
  511. package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentPartialStore.md +0 -68
  512. package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentTransferOptions.md +0 -91
  513. package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentOptions.md +0 -25
  514. package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentResult.md +0 -19
  515. package/docs/api/namespaces/media/interfaces/ExecuteMediaAttachmentJobOptions.md +0 -157
  516. package/docs/api/namespaces/media/interfaces/MediaAttachmentBackgroundJob.md +0 -85
  517. package/docs/api/namespaces/media/interfaces/MediaAttachmentCleanupPlan.md +0 -37
  518. package/docs/api/namespaces/media/interfaces/MediaAttachmentJobExecutionResult.md +0 -55
  519. package/docs/api/namespaces/media/interfaces/MediaAttachmentMessage.md +0 -31
  520. package/docs/api/namespaces/media/interfaces/MediaAttachmentOpenDecision.md +0 -31
  521. package/docs/api/namespaces/media/interfaces/MediaAttachmentPointer.md +0 -133
  522. package/docs/api/namespaces/media/interfaces/MediaAttachmentPolicy.md +0 -67
  523. package/docs/api/namespaces/media/interfaces/MediaAttachmentProcessingPlan.md +0 -73
  524. package/docs/api/namespaces/media/interfaces/MediaAttachmentProgress.md +0 -69
  525. package/docs/api/namespaces/media/interfaces/MediaAttachmentResumeState.md +0 -37
  526. package/docs/api/namespaces/media/interfaces/MediaAttachmentRetryOptions.md +0 -31
  527. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransfer.md +0 -51
  528. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferCheckpoint.md +0 -69
  529. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferOptions.md +0 -67
  530. package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadJobData.md +0 -19
  531. package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadResponse.md +0 -25
  532. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentCleanupJobsInput.md +0 -61
  533. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDeleteSyncInput.md +0 -25
  534. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDownloadJobInput.md +0 -161
  535. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentOpenInput.md +0 -25
  536. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentProcessingInput.md +0 -83
  537. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentUploadJobInput.md +0 -147
  538. package/docs/api/namespaces/media/interfaces/PrepareMediaAttachmentUploadOptions.md +0 -144
  539. package/docs/api/namespaces/media/interfaces/ResolveMediaAttachmentOptions.md +0 -55
  540. package/docs/api/namespaces/media/interfaces/ResolvedMediaAttachment.md +0 -109
  541. package/docs/api/namespaces/media/interfaces/TusMediaAttachmentTransferOptions.md +0 -85
  542. package/docs/api/namespaces/media/type-aliases/CreateMediaAttachmentPointerInput.md +0 -15
  543. package/docs/api/namespaces/media/type-aliases/MediaAttachmentCheckpointCallback.md +0 -19
  544. package/docs/api/namespaces/media/type-aliases/MediaAttachmentCleanupReason.md +0 -9
  545. package/docs/api/namespaces/media/type-aliases/MediaAttachmentErrorCode.md +0 -9
  546. package/docs/api/namespaces/media/type-aliases/MediaAttachmentFlag.md +0 -9
  547. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobExecutionStatus.md +0 -9
  548. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobOperation.md +0 -9
  549. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobPriority.md +0 -9
  550. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSkipReason.md +0 -9
  551. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSource.md +0 -9
  552. package/docs/api/namespaces/media/type-aliases/MediaAttachmentKnownIds.md +0 -9
  553. package/docs/api/namespaces/media/type-aliases/MediaAttachmentMessageType.md +0 -9
  554. package/docs/api/namespaces/media/type-aliases/MediaAttachmentProgressCallback.md +0 -19
  555. package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_DEFAULTS.md +0 -47
  556. package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_PRESETS.md +0 -95
  557. package/docs/api/namespaces/media/variables/MediaAttachmentCleanupReason.md +0 -27
  558. package/docs/api/namespaces/media/variables/MediaAttachmentErrorCode.md +0 -75
  559. package/docs/api/namespaces/media/variables/MediaAttachmentFlag.md +0 -23
  560. package/docs/api/namespaces/media/variables/MediaAttachmentJobExecutionStatus.md +0 -19
  561. package/docs/api/namespaces/media/variables/MediaAttachmentJobOperation.md +0 -31
  562. package/docs/api/namespaces/media/variables/MediaAttachmentJobPriority.md +0 -23
  563. package/docs/api/namespaces/media/variables/MediaAttachmentJobSource.md +0 -51
  564. package/docs/api/namespaces/media/variables/MediaAttachmentMessageType.md +0 -15
  565. package/docs/api/namespaces/media/variables/downloadMediaAttachment.md +0 -30
  566. package/docs/api/namespaces/safety/README.md +0 -61
  567. package/docs/api/namespaces/safety/classes/DisplayableFingerprint.md +0 -108
  568. package/docs/api/namespaces/safety/classes/Fingerprint.md +0 -104
  569. package/docs/api/namespaces/safety/classes/ScannableFingerprint.md +0 -209
  570. package/docs/api/namespaces/safety/functions/base64ToBytes.md +0 -21
  571. package/docs/api/namespaces/safety/functions/clearFingerprintCache.md +0 -15
  572. package/docs/api/namespaces/safety/functions/compareSafetyNumbers.md +0 -25
  573. package/docs/api/namespaces/safety/functions/createFingerprintData.md +0 -60
  574. package/docs/api/namespaces/safety/functions/extractQrData.md +0 -34
  575. package/docs/api/namespaces/safety/functions/generateCompositeSafetyNumber.md +0 -39
  576. package/docs/api/namespaces/safety/functions/generateEmojiFingerprint.md +0 -24
  577. package/docs/api/namespaces/safety/functions/generateSingleKeyReferenceSafetyNumber.md +0 -51
  578. package/docs/api/namespaces/safety/functions/generateVerifySchemeUrl.md +0 -32
  579. package/docs/api/namespaces/safety/functions/generateVerifyUrl.md +0 -49
  580. package/docs/api/namespaces/safety/functions/isValidSafetyNumber.md +0 -21
  581. package/docs/api/namespaces/safety/functions/isVerifyUrl.md +0 -45
  582. package/docs/api/namespaces/safety/functions/parseVerifyUrl.md +0 -31
  583. package/docs/api/namespaces/safety/interfaces/FingerprintData.md +0 -52
  584. package/docs/api/namespaces/safety/interfaces/SafetyNumber.md +0 -49
  585. package/docs/api/namespaces/safety/interfaces/VerifyLinkConfig.md +0 -28
  586. package/docs/api/namespaces/safety/interfaces/VerifyUrlParams.md +0 -49
  587. package/docs/api/namespaces/safety/type-aliases/CompareResult.md +0 -21
  588. package/docs/api/namespaces/safety/variables/DEFAULT_VERIFY_LINK_CONFIG.md +0 -12
  589. package/docs/api/namespaces/safety/variables/FINGERPRINT_ITERATIONS.md +0 -12
  590. package/docs/api/namespaces/safety/variables/FINGERPRINT_VERSION.md +0 -12
  591. package/docs/api/namespaces/safety/variables/VERIFY_BASE_URL.md +0 -11
  592. package/docs/api/namespaces/safety/variables/VERIFY_SCHEME_URL.md +0 -11
  593. package/docs/api/type-aliases/Base64.md +0 -20
  594. package/docs/api/type-aliases/BraidPolicy.md +0 -11
  595. package/docs/api/type-aliases/Bytes.md +0 -20
  596. package/docs/api/type-aliases/Ciphertext.md +0 -21
  597. package/docs/api/type-aliases/DeviceType.md +0 -11
  598. package/docs/api/type-aliases/DownloadedAttachment.md +0 -11
  599. package/docs/api/type-aliases/GroupId.md +0 -27
  600. package/docs/api/type-aliases/Hex.md +0 -20
  601. package/docs/api/type-aliases/HookName.md +0 -11
  602. package/docs/api/type-aliases/PostQuantumPolicy.md +0 -11
  603. package/docs/api/type-aliases/PreparedAttachmentUpload.md +0 -14
  604. package/docs/api/type-aliases/PrivateKey.md +0 -22
  605. package/docs/api/type-aliases/ProgressCallback.md +0 -45
  606. package/docs/api/type-aliases/PublicKey.md +0 -22
  607. package/docs/api/type-aliases/RemoteObjectCompleteUploadRequest.md +0 -19
  608. package/docs/api/type-aliases/RemoteObjectDeleteRequest.md +0 -19
  609. package/docs/api/type-aliases/RemoteObjectDownloadRequest.md +0 -19
  610. package/docs/api/type-aliases/RemoteObjectUploadRequest.md +0 -42
  611. package/docs/api/type-aliases/SCKAMode.md +0 -11
  612. package/docs/api/type-aliases/SealedSenderAuth.md +0 -15
  613. package/docs/api/type-aliases/SignalProtocolClientMediaCleanupInput.md +0 -9
  614. package/docs/api/type-aliases/SignalProtocolClientMediaCleanupResult.md +0 -9
  615. package/docs/api/type-aliases/SignalProtocolClientMediaDownloadInput.md +0 -9
  616. package/docs/api/type-aliases/SignalProtocolClientMediaDownloadResult.md +0 -9
  617. package/docs/api/type-aliases/SignalProtocolClientMediaOperationResult.md +0 -9
  618. package/docs/api/type-aliases/SignalProtocolClientMediaUploadInput.md +0 -9
  619. package/docs/api/type-aliases/SignalProtocolClientMediaUploadResult.md +0 -9
  620. package/docs/api/type-aliases/Signature.md +0 -21
  621. package/docs/api/type-aliases/Unsubscribe.md +0 -15
  622. package/docs/api/variables/BraidPolicy.md +0 -21
  623. package/docs/api/variables/DEFAULT_DEVICE_ID.md +0 -12
  624. package/docs/api/variables/DOUBLE_RATCHET_SPEC.md +0 -11
  625. package/docs/api/variables/GROUP_ID_PREFIX.md +0 -11
  626. package/docs/api/variables/GROUP_TRUST_ROOT_VERSION.md +0 -11
  627. package/docs/api/variables/KEY_REFRESH_INTERVAL_MS_DEFAULT.md +0 -11
  628. package/docs/api/variables/MAX_MESSAGE_KEYS.md +0 -14
  629. package/docs/api/variables/MAX_PREKEY_AGE_MS_DEFAULT.md +0 -11
  630. package/docs/api/variables/MAX_RECEIVER_CHAINS.md +0 -14
  631. package/docs/api/variables/MAX_REGISTRATION_ID.md +0 -16
  632. package/docs/api/variables/MAX_SKIP.md +0 -11
  633. package/docs/api/variables/MESSAGE_FORMAT.md +0 -11
  634. package/docs/api/variables/MIN_REGISTRATION_ID.md +0 -16
  635. package/docs/api/variables/ML_KEM_BRAID_SPEC.md +0 -11
  636. package/docs/api/variables/ONE_TIME_PREKEY_BATCH_SIZE.md +0 -21
  637. package/docs/api/variables/PQXDH_SPEC.md +0 -11
  638. package/docs/api/variables/PostQuantumPolicy.md +0 -21
  639. package/docs/api/variables/SENDER_KEY_FORMAT.md +0 -11
  640. package/docs/api/variables/SENDER_KEY_SPEC.md +0 -11
  641. package/docs/api/variables/SESAME_SPEC.md +0 -11
  642. package/docs/api/variables/SESSION_FORMAT.md +0 -11
  643. package/docs/api/variables/SPQR_LIMITS_DEFAULTS.md +0 -11
  644. package/docs/api/variables/X3DH_SPEC.md +0 -9
  645. package/docs/api/variables/defaultSignalProtocolLogger.md +0 -32
  646. package/remote/relay/convex/server/README.md +0 -146
@@ -1,1185 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / ISignalProtocolClient
6
-
7
- # Interface: ISignalProtocolClient
8
-
9
- High-level encrypted messaging client interface.
10
-
11
- All methods accept a ProtocolAddress (userId + deviceId) instead of
12
- string sessionId. This provides type safety and prevents format errors.
13
-
14
- ## Example
15
-
16
- ```typescript
17
- import { ProtocolAddress } from '@open-e2ee/signal-protocol-sdk';
18
-
19
- const bob = ProtocolAddress.create('bob', 1);
20
- const encrypted = await signal.encryptMessage(bob, 'Hello!');
21
- ```
22
-
23
- ## Properties
24
-
25
- ### deviceId
26
-
27
- > `readonly` **deviceId**: `number`
28
-
29
- Device ID for this client instance (1 = primary, 2-5 = linked)
30
-
31
- ***
32
-
33
- ### logger
34
-
35
- > `readonly` **logger**: `Required`\<[`ILogger`](ILogger.md)\>
36
-
37
- Resolved logger for this client instance.
38
-
39
- This is the client-scoped logger used throughout the Signal Protocol runtime.
40
-
41
- ***
42
-
43
- ### userId
44
-
45
- > `readonly` **userId**: `string`
46
-
47
- User ID for this client instance
48
-
49
- ## Methods
50
-
51
- ### createGroupSenderKey()
52
-
53
- > **createGroupSenderKey**(`groupId`): `Promise`\<\{ `distributionMessage`: [`SenderKeyDistributionMessage`](SenderKeyDistributionMessage.md); `senderKeyId`: `string`; \}\>
54
-
55
- Create a new sender key for group messaging
56
-
57
- #### Parameters
58
-
59
- ##### groupId
60
-
61
- `string`
62
-
63
- Group identifier
64
-
65
- #### Returns
66
-
67
- `Promise`\<\{ `distributionMessage`: [`SenderKeyDistributionMessage`](SenderKeyDistributionMessage.md); `senderKeyId`: `string`; \}\>
68
-
69
- Sender key ID and distribution message to share with group members
70
-
71
- ***
72
-
73
- ### decryptFile()
74
-
75
- > **decryptFile**(`remoteAddress`, `encryptedBlob`, `encryptedKey`): `Promise`\<`Blob`\>
76
-
77
- Decrypt file blob
78
-
79
- #### Parameters
80
-
81
- ##### remoteAddress
82
-
83
- [`ProtocolAddress`](ProtocolAddress.md)
84
-
85
- Remote party's protocol address (userId:deviceId)
86
-
87
- ##### encryptedBlob
88
-
89
- `Blob`
90
-
91
- Encrypted file data
92
-
93
- ##### encryptedKey
94
-
95
- [`Ciphertext`](../type-aliases/Ciphertext.md)
96
-
97
- Encrypted file key
98
-
99
- #### Returns
100
-
101
- `Promise`\<`Blob`\>
102
-
103
- ***
104
-
105
- ### decryptGroupMessage()
106
-
107
- > **decryptGroupMessage**(`groupId`, `senderId`, `senderDeviceId`, `framedMessage`): `Promise`\<`string`\>
108
-
109
- Decrypt a group message from a sender
110
-
111
- #### Parameters
112
-
113
- ##### groupId
114
-
115
- `string`
116
-
117
- Group identifier
118
-
119
- ##### senderId
120
-
121
- `string`
122
-
123
- Sender's user ID
124
-
125
- ##### senderDeviceId
126
-
127
- `number`
128
-
129
- Sender's device ID
130
-
131
- ##### framedMessage
132
-
133
- `Uint8Array`
134
-
135
- Framed SenderKeyMessage bytes
136
-
137
- #### Returns
138
-
139
- `Promise`\<`string`\>
140
-
141
- Decrypted plaintext
142
-
143
- ***
144
-
145
- ### decryptMessage()
146
-
147
- > **decryptMessage**(`remoteAddress`, `ciphertext`): `Promise`\<`string`\>
148
-
149
- Decrypt a message from a remote address
150
-
151
- #### Parameters
152
-
153
- ##### remoteAddress
154
-
155
- [`ProtocolAddress`](ProtocolAddress.md)
156
-
157
- Remote party's protocol address (userId:deviceId)
158
-
159
- ##### ciphertext
160
-
161
- [`Ciphertext`](../type-aliases/Ciphertext.md)
162
-
163
- Message to decrypt
164
-
165
- #### Returns
166
-
167
- `Promise`\<`string`\>
168
-
169
- ***
170
-
171
- ### deleteGroupSenderKey()
172
-
173
- > **deleteGroupSenderKey**(`groupId`): `Promise`\<`void`\>
174
-
175
- Delete sender key when leaving a group
176
-
177
- #### Parameters
178
-
179
- ##### groupId
180
-
181
- `string`
182
-
183
- Group identifier
184
-
185
- #### Returns
186
-
187
- `Promise`\<`void`\>
188
-
189
- ***
190
-
191
- ### deleteRemoteAttachment()
192
-
193
- > **deleteRemoteAttachment**(`attachment`, `options?`): `Promise`\<`void`\>
194
-
195
- Delete the encrypted remote object referenced by an attachment pointer.
196
-
197
- This only touches remote object storage. App-owned local message rows and
198
- local media caches must be deleted by the application.
199
-
200
- #### Parameters
201
-
202
- ##### attachment
203
-
204
- [`MediaAttachmentPointer`](../namespaces/media/interfaces/MediaAttachmentPointer.md)
205
-
206
- ##### options?
207
-
208
- `Pick`\<[`AttachmentTransferOptions`](AttachmentTransferOptions.md), `"signal"` \| `"onProgress"`\>
209
-
210
- #### Returns
211
-
212
- `Promise`\<`void`\>
213
-
214
- ***
215
-
216
- ### deleteSession()
217
-
218
- > **deleteSession**(`remoteAddress`): `Promise`\<`void`\>
219
-
220
- Delete session (for session reset)
221
-
222
- #### Parameters
223
-
224
- ##### remoteAddress
225
-
226
- [`ProtocolAddress`](ProtocolAddress.md)
227
-
228
- Remote party's protocol address (userId:deviceId)
229
-
230
- #### Returns
231
-
232
- `Promise`\<`void`\>
233
-
234
- ***
235
-
236
- ### distributeGroupSenderKey()
237
-
238
- > **distributeGroupSenderKey**(`groupId`, `memberUserIds`): `Promise`\<`void`\>
239
-
240
- Distribute sender key to all group members
241
-
242
- #### Parameters
243
-
244
- ##### groupId
245
-
246
- `string`
247
-
248
- Group identifier
249
-
250
- ##### memberUserIds
251
-
252
- `string`[]
253
-
254
- Array of all member user IDs
255
-
256
- #### Returns
257
-
258
- `Promise`\<`void`\>
259
-
260
- ***
261
-
262
- ### distributeSenderKeyToUser()
263
-
264
- > **distributeSenderKeyToUser**(`groupId`, `recipientUserId`): `Promise`\<`void`\>
265
-
266
- Distribute sender key to a specific user via pairwise encryption
267
-
268
- #### Parameters
269
-
270
- ##### groupId
271
-
272
- `string`
273
-
274
- Group identifier
275
-
276
- ##### recipientUserId
277
-
278
- `string`
279
-
280
- Recipient user ID to distribute key to
281
-
282
- #### Returns
283
-
284
- `Promise`\<`void`\>
285
-
286
- ***
287
-
288
- ### downloadAttachment()
289
-
290
- > **downloadAttachment**(`attachment`, `options?`): `Promise`\<[`ResolvedMediaAttachment`](../namespaces/media/interfaces/ResolvedMediaAttachment.md)\>
291
-
292
- Download, verify, and decrypt an uploaded attachment pointer.
293
-
294
- The client validates pointer metadata, verifies the encrypted blob digest,
295
- and only returns plaintext after streaming AEAD authentication succeeds.
296
-
297
- #### Parameters
298
-
299
- ##### attachment
300
-
301
- [`MediaAttachmentPointer`](../namespaces/media/interfaces/MediaAttachmentPointer.md)
302
-
303
- ##### options?
304
-
305
- [`AttachmentTransferOptions`](AttachmentTransferOptions.md)
306
-
307
- #### Returns
308
-
309
- `Promise`\<[`ResolvedMediaAttachment`](../namespaces/media/interfaces/ResolvedMediaAttachment.md)\>
310
-
311
- ***
312
-
313
- ### encryptFile()
314
-
315
- > **encryptFile**(`remoteAddress`, `fileBlob`, `mimeType?`): `Promise`\<\{ `encryptedBlob`: `Blob`; `encryptedKey`: [`Ciphertext`](../type-aliases/Ciphertext.md); `keyId`: `string`; \}\>
316
-
317
- Encrypt file blob with two-layer encryption
318
- Returns encrypted blob and encrypted key
319
-
320
- #### Parameters
321
-
322
- ##### remoteAddress
323
-
324
- [`ProtocolAddress`](ProtocolAddress.md)
325
-
326
- Remote party's protocol address (userId:deviceId)
327
-
328
- ##### fileBlob
329
-
330
- `Blob`
331
-
332
- File data to encrypt
333
-
334
- ##### mimeType?
335
-
336
- `string`
337
-
338
- Optional MIME type for the file
339
-
340
- #### Returns
341
-
342
- `Promise`\<\{ `encryptedBlob`: `Blob`; `encryptedKey`: [`Ciphertext`](../type-aliases/Ciphertext.md); `keyId`: `string`; \}\>
343
-
344
- ***
345
-
346
- ### encryptGroupMessage()
347
-
348
- > **encryptGroupMessage**(`groupId`, `plaintext`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
349
-
350
- Encrypt a message for group using sender key (O(1) encryption)
351
-
352
- #### Parameters
353
-
354
- ##### groupId
355
-
356
- `string`
357
-
358
- Group identifier
359
-
360
- ##### plaintext
361
-
362
- `string`
363
-
364
- Message to encrypt
365
-
366
- #### Returns
367
-
368
- `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
369
-
370
- Framed SenderKeyMessage bytes
371
-
372
- ***
373
-
374
- ### encryptMessage()
375
-
376
- > **encryptMessage**(`remoteAddress`, `plaintext`): `Promise`\<[`Ciphertext`](../type-aliases/Ciphertext.md)\>
377
-
378
- Encrypt a message for a remote address
379
-
380
- #### Parameters
381
-
382
- ##### remoteAddress
383
-
384
- [`ProtocolAddress`](ProtocolAddress.md)
385
-
386
- Remote party's protocol address (userId:deviceId)
387
-
388
- ##### plaintext
389
-
390
- `string`
391
-
392
- Message to encrypt
393
-
394
- #### Returns
395
-
396
- `Promise`\<[`Ciphertext`](../type-aliases/Ciphertext.md)\>
397
-
398
- ***
399
-
400
- ### establishSession()
401
-
402
- > **establishSession**(`remoteAddress`, `prekeyBundle`): `Promise`\<`void`\>
403
-
404
- Establish a new session using remote party's prekey bundle
405
-
406
- #### Parameters
407
-
408
- ##### remoteAddress
409
-
410
- [`ProtocolAddress`](ProtocolAddress.md)
411
-
412
- Remote party's protocol address (userId:deviceId)
413
-
414
- ##### prekeyBundle
415
-
416
- [`RelayPreKeyBundle`](RelayPreKeyBundle.md)
417
-
418
- Remote party's prekey bundle from server
419
-
420
- #### Returns
421
-
422
- `Promise`\<`void`\>
423
-
424
- ***
425
-
426
- ### getGroupSenderKeyDistribution()
427
-
428
- > **getGroupSenderKeyDistribution**(`groupId`): `Promise`\<[`SenderKeyDistributionMessage`](SenderKeyDistributionMessage.md) \| `null`\>
429
-
430
- Get the current sender key distribution message for a group
431
-
432
- #### Parameters
433
-
434
- ##### groupId
435
-
436
- `string`
437
-
438
- Group identifier
439
-
440
- #### Returns
441
-
442
- `Promise`\<[`SenderKeyDistributionMessage`](SenderKeyDistributionMessage.md) \| `null`\>
443
-
444
- Distribution message or null if no key exists
445
-
446
- ***
447
-
448
- ### getSessionHealth()
449
-
450
- > **getSessionHealth**(`userId`): `Promise`\<[`SessionHealthResult`](SessionHealthResult.md)\>
451
-
452
- Get health status for encryption sessions with a specific user.
453
-
454
- Checks session existence, key validity, key freshness, and expiration.
455
- This is a client-side check that doesn't require server calls.
456
-
457
- #### Parameters
458
-
459
- ##### userId
460
-
461
- `string`
462
-
463
- The user ID to check session health for
464
-
465
- #### Returns
466
-
467
- `Promise`\<[`SessionHealthResult`](SessionHealthResult.md)\>
468
-
469
- SessionHealthResult with status and detailed diagnostics
470
-
471
- ***
472
-
473
- ### handleGroupMembershipChange()
474
-
475
- > **handleGroupMembershipChange**(`groupId`, `change`): `Promise`\<\{ `distributionMessage?`: [`SenderKeyDistributionMessage`](SenderKeyDistributionMessage.md); `rotated`: `boolean`; \}\>
476
-
477
- Handle group membership change with appropriate sender key actions
478
-
479
- #### Parameters
480
-
481
- ##### groupId
482
-
483
- `string`
484
-
485
- Group identifier
486
-
487
- ##### change
488
-
489
- `"member_added"` \| `"member_removed"` \| `"metadata_changed"`
490
-
491
- Type of membership change
492
-
493
- #### Returns
494
-
495
- `Promise`\<\{ `distributionMessage?`: [`SenderKeyDistributionMessage`](SenderKeyDistributionMessage.md); `rotated`: `boolean`; \}\>
496
-
497
- Distribution message if rotation occurred
498
-
499
- ***
500
-
501
- ### hasGroupSenderKey()
502
-
503
- > **hasGroupSenderKey**(`groupId`): `Promise`\<`boolean`\>
504
-
505
- Check if we have a sender key for a group
506
-
507
- #### Parameters
508
-
509
- ##### groupId
510
-
511
- `string`
512
-
513
- Group identifier
514
-
515
- #### Returns
516
-
517
- `Promise`\<`boolean`\>
518
-
519
- True if sender key exists
520
-
521
- ***
522
-
523
- ### hasSession()
524
-
525
- > **hasSession**(`remoteAddress`): `Promise`\<`boolean`\>
526
-
527
- Check if a session exists for a remote address
528
-
529
- #### Parameters
530
-
531
- ##### remoteAddress
532
-
533
- [`ProtocolAddress`](ProtocolAddress.md)
534
-
535
- Remote party's protocol address (userId:deviceId)
536
-
537
- #### Returns
538
-
539
- `Promise`\<`boolean`\>
540
-
541
- ***
542
-
543
- ### processGroupSenderKeyDistribution()
544
-
545
- > **processGroupSenderKeyDistribution**(`groupId`, `senderId`, `senderDeviceId`, `message`): `Promise`\<`void`\>
546
-
547
- Process a sender key distribution message from another group member
548
-
549
- #### Parameters
550
-
551
- ##### groupId
552
-
553
- `string`
554
-
555
- Group identifier
556
-
557
- ##### senderId
558
-
559
- `string`
560
-
561
- Sender's user ID
562
-
563
- ##### senderDeviceId
564
-
565
- `number`
566
-
567
- Sender's device ID
568
-
569
- ##### message
570
-
571
- [`SenderKeyDistributionMessage`](SenderKeyDistributionMessage.md)
572
-
573
- Distribution message containing the sender key
574
-
575
- #### Returns
576
-
577
- `Promise`\<`void`\>
578
-
579
- ***
580
-
581
- ### processIncomingEnvelope()
582
-
583
- > **processIncomingEnvelope**(`envelope`, `options?`): `Promise`\<`string`\>
584
-
585
- Process an incoming encrypted message envelope.
586
-
587
- Unified entry point for both foreground (relay) and background (HTTP) message processing.
588
- Handles decryption and automatically sends SESAME retry requests on retryable failures.
589
-
590
- This method:
591
- 1. Decodes base64 ciphertext
592
- 2. Decrypts message using Double Ratchet
593
- 3. On retryable error: sends retry request via relay or options callback
594
- 4. Re-throws error for caller to handle
595
-
596
- #### Parameters
597
-
598
- ##### envelope
599
-
600
- [`IncomingEnvelope`](IncomingEnvelope.md)
601
-
602
- The encrypted message envelope
603
-
604
- ##### options?
605
-
606
- [`ProcessEnvelopeOptions`](ProcessEnvelopeOptions.md)
607
-
608
- Transport callbacks for background (no relay) scenarios
609
-
610
- #### Returns
611
-
612
- `Promise`\<`string`\>
613
-
614
- Decrypted plaintext
615
-
616
- #### Throws
617
-
618
- EncryptionError after sending retry request if decryption fails
619
-
620
- #### Example
621
-
622
- ```typescript
623
- // Foreground (relay available)
624
- const plaintext = await signal.processIncomingEnvelope(envelope);
625
-
626
- // Background (no relay)
627
- const plaintext = await signal.processIncomingEnvelope(envelope, {
628
- sendRetryRequest: async (req) => {
629
- await convex.mutation(api.signal.messages.sendRetryRequest, req);
630
- }
631
- });
632
- ```
633
-
634
- ***
635
-
636
- ### registerHook()
637
-
638
- > **registerHook**(`name`, `callback`): `void`
639
-
640
- Register an event hook for Signal Protocol events
641
-
642
- Allows post-construction hook registration for flexibility.
643
- Useful when the app needs to construct storage or content services after the
644
- Signal Protocol client exists.
645
-
646
- #### Parameters
647
-
648
- ##### name
649
-
650
- `string`
651
-
652
- Hook name
653
-
654
- ##### callback
655
-
656
- (...`args`) => `void` \| `Promise`\<`void`\>
657
-
658
- Hook callback function
659
-
660
- #### Returns
661
-
662
- `void`
663
-
664
- #### Example
665
-
666
- ```typescript
667
- signal.registerHook('onMessageDecrypted', async (envelope) => {
668
- await contentManager.storeMessage(envelope);
669
- });
670
- ```
671
-
672
- ***
673
-
674
- ### rotateAccountIdentity()
675
-
676
- > **rotateAccountIdentity**(`expectedCurrentCommitment`, `identityType?`): `Promise`\<`void`\>
677
-
678
- Explicit compare-and-swap rotation of the account-level relay identity.
679
-
680
- #### Parameters
681
-
682
- ##### expectedCurrentCommitment
683
-
684
- `Uint8Array`
685
-
686
- ##### identityType?
687
-
688
- [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
689
-
690
- #### Returns
691
-
692
- `Promise`\<`void`\>
693
-
694
- ***
695
-
696
- ### rotateEcSignedPreKey()
697
-
698
- > **rotateEcSignedPreKey**(): `Promise`\<`boolean`\>
699
-
700
- Rotate EC signed prekey
701
-
702
- Rotates only once the current prekey is older than the configured refresh
703
- interval ([KEY\_REFRESH\_INTERVAL\_MS\_DEFAULT](../variables/KEY_REFRESH_INTERVAL_MS_DEFAULT.md), 2 days by default).
704
- Returns false if rotation is not needed yet.
705
-
706
- #### Returns
707
-
708
- `Promise`\<`boolean`\>
709
-
710
- ***
711
-
712
- ### rotateGroupSenderKey()
713
-
714
- > **rotateGroupSenderKey**(`groupId`): `Promise`\<\{ `distributionMessage`: [`SenderKeyDistributionMessage`](SenderKeyDistributionMessage.md); `senderKeyId`: `string`; \}\>
715
-
716
- Rotate sender key for a group (forward secrecy on membership changes)
717
-
718
- #### Parameters
719
-
720
- ##### groupId
721
-
722
- `string`
723
-
724
- Group identifier
725
-
726
- #### Returns
727
-
728
- `Promise`\<\{ `distributionMessage`: [`SenderKeyDistributionMessage`](SenderKeyDistributionMessage.md); `senderKeyId`: `string`; \}\>
729
-
730
- New sender key ID and distribution message
731
-
732
- ***
733
-
734
- ### rotateKyberPreKey()
735
-
736
- > **rotateKyberPreKey**(): `Promise`\<`boolean`\>
737
-
738
- Rotate Kyber prekey (post-quantum)
739
-
740
- Shares the signed prekey's refresh interval
741
- ([KEY\_REFRESH\_INTERVAL\_MS\_DEFAULT](../variables/KEY_REFRESH_INTERVAL_MS_DEFAULT.md), 2 days by default).
742
- Returns false if rotation is not needed yet.
743
-
744
- #### Returns
745
-
746
- `Promise`\<`boolean`\>
747
-
748
- ***
749
-
750
- ### runPeriodicCleanup()
751
-
752
- > **runPeriodicCleanup**(): `number`
753
-
754
- Run periodic cleanup of internal tracking state.
755
-
756
- Safe to call frequently - internally throttled to avoid overhead.
757
- Recommended call sites:
758
- - App foreground transition
759
- - After successful message batch processing
760
- - Periodically during long sessions
761
-
762
- Cleans up:
763
- - Expired retry dedup entries (recentRetryRequests)
764
-
765
- #### Returns
766
-
767
- `number`
768
-
769
- Number of entries cleaned up
770
-
771
- ***
772
-
773
- ### send()
774
-
775
- > **send**(`recipientId`, `content`, `options?`): `Promise`\<[`SendResult`](SendResult.md)\>
776
-
777
- Send content to a recipient
778
-
779
- This is the primary API for sending encrypted content.
780
- Automatically handles:
781
- - Group vs user detection (Signal Protocol V2 prefix)
782
- - Content type routing (DataMessageInput, string, Uint8Array)
783
- - Multi-device fan-out
784
- - Sender key distribution for groups
785
-
786
- #### Parameters
787
-
788
- ##### recipientId
789
-
790
- `string`
791
-
792
- Prefixed group ID or userId for direct messages
793
-
794
- ##### content
795
-
796
- `string` \| `Uint8Array`\<`ArrayBufferLike`\> \| [`DataMessageInput`](DataMessageInput.md)
797
-
798
- DataMessageInput, string, or raw Uint8Array bytes
799
-
800
- ##### options?
801
-
802
- [`SendOptions`](SendOptions.md)
803
-
804
- Optional send options
805
-
806
- #### Returns
807
-
808
- `Promise`\<[`SendResult`](SendResult.md)\>
809
-
810
- SendResult with messageId, timestamp, recipientDeviceCount
811
-
812
- #### Example
813
-
814
- ```typescript
815
- import { createGroupId } from '@open-e2ee/signal-protocol-sdk';
816
-
817
- // Send to group (use createGroupId helper)
818
- await signal.send(createGroupId(groupId), content);
819
-
820
- // Send to user
821
- await signal.send(userId, content);
822
-
823
- // Send raw bytes
824
- await signal.send(recipient, new Uint8Array([...]));
825
- ```
826
-
827
- ***
828
-
829
- ### sendReadReceipt()
830
-
831
- > **sendReadReceipt**(`recipientUserId`, `timestamps`): `Promise`\<`void`\>
832
-
833
- Send read receipt to original message sender (all devices)
834
-
835
- Called when the user views messages in a conversation.
836
- Similar to delivery receipts but indicates message was actually read.
837
- Multi-device: fans out to all known devices for the sender.
838
-
839
- #### Parameters
840
-
841
- ##### recipientUserId
842
-
843
- `string`
844
-
845
- Original sender's user ID
846
-
847
- ##### timestamps
848
-
849
- `number`[]
850
-
851
- Server timestamps of messages that were read
852
-
853
- #### Returns
854
-
855
- `Promise`\<`void`\>
856
-
857
- ***
858
-
859
- ### sendTypingIndicator()
860
-
861
- > **sendTypingIndicator**(`recipientUserId`, `recipientDeviceId`, `conversationId`, `action`, `groupId?`): `Promise`\<`void`\>
862
-
863
- Send typing indicator to conversation recipient
864
-
865
- Typing indicators are application-layer messages that:
866
- - Use the same encrypted channel as regular messages
867
- - Are NOT stored on the server (transient)
868
- - Respect privacy settings (mutual opt-in required)
869
-
870
- #### Parameters
871
-
872
- ##### recipientUserId
873
-
874
- `string`
875
-
876
- Recipient's user ID
877
-
878
- ##### recipientDeviceId
879
-
880
- `number`
881
-
882
- Recipient's device ID
883
-
884
- ##### conversationId
885
-
886
- `string`
887
-
888
- The conversation ID
889
-
890
- ##### action
891
-
892
- [`TypingAction`](../enumerations/TypingAction.md)
893
-
894
- Whether user STARTED or STOPPED typing
895
-
896
- ##### groupId?
897
-
898
- `string`
899
-
900
- Optional group ID for group conversations
901
-
902
- #### Returns
903
-
904
- `Promise`\<`void`\>
905
-
906
- ***
907
-
908
- ### sendViewedReceipt()
909
-
910
- > **sendViewedReceipt**(`recipientUserId`, `timestamps`): `Promise`\<`void`\>
911
-
912
- Send viewed receipt to original message sender (all devices).
913
-
914
- Used for content where "opened" matters semantically, such as view-once
915
- attachments. This follows the same privacy gate as read receipts.
916
-
917
- #### Parameters
918
-
919
- ##### recipientUserId
920
-
921
- `string`
922
-
923
- ##### timestamps
924
-
925
- `number`[]
926
-
927
- #### Returns
928
-
929
- `Promise`\<`void`\>
930
-
931
- ***
932
-
933
- ### startRelaySubscription()
934
-
935
- > **startRelaySubscription**(): `void`
936
-
937
- Start the relay subscription for receiving encrypted messages.
938
-
939
- Startup is explicit so applications can register hooks before delivery
940
- begins.
941
-
942
- #### Returns
943
-
944
- `void`
945
-
946
- ***
947
-
948
- ### stop()
949
-
950
- > **stop**(): `Promise`\<`void`\>
951
-
952
- Stop the client and cleanup resources
953
-
954
- Should be called on logout or app shutdown.
955
-
956
- #### Returns
957
-
958
- `Promise`\<`void`\>
959
-
960
- ***
961
-
962
- ### stopRelaySubscription()
963
-
964
- > **stopRelaySubscription**(): `void`
965
-
966
- Stop the relay subscription
967
-
968
- Pauses message processing without destroying client state.
969
- Use when app backgrounds to let background task handle messages.
970
- Call startRelaySubscription() to resume when app foregrounds.
971
-
972
- #### Returns
973
-
974
- `void`
975
-
976
- ***
977
-
978
- ### syncBlockedRecipientsToLinkedDevices()
979
-
980
- > **syncBlockedRecipientsToLinkedDevices**(`blocked`): `Promise`\<`void`\>
981
-
982
- Sync the current blocked-recipient snapshot to linked devices.
983
-
984
- The full current snapshot replaces the local linked-device projection
985
- instead of applying deltas.
986
-
987
- #### Parameters
988
-
989
- ##### blocked
990
-
991
- [`BlockedRecipientsSyncInput`](BlockedRecipientsSyncInput.md)
992
-
993
- #### Returns
994
-
995
- `Promise`\<`void`\>
996
-
997
- ***
998
-
999
- ### syncConfigurationToLinkedDevices()
1000
-
1001
- > **syncConfigurationToLinkedDevices**(`configuration`): `Promise`\<`void`\>
1002
-
1003
- Sync account-level communication/privacy configuration to linked devices.
1004
-
1005
- This is linked-device state, not a sender-facing receipt. It should carry
1006
- the current local snapshot for supported fields.
1007
-
1008
- #### Parameters
1009
-
1010
- ##### configuration
1011
-
1012
- [`ConfigurationSyncInput`](ConfigurationSyncInput.md)
1013
-
1014
- #### Returns
1015
-
1016
- `Promise`\<`void`\>
1017
-
1018
- ***
1019
-
1020
- ### syncMediaAttachmentDeleteToLinkedDevices()
1021
-
1022
- > **syncMediaAttachmentDeleteToLinkedDevices**(`entry`): `Promise`\<`void`\>
1023
-
1024
- Sync a local media attachment delete event to the account's other linked devices.
1025
-
1026
- This is account-local device state, not a sender-facing receipt. The app
1027
- remains responsible for applying the delete to its local media cache.
1028
-
1029
- #### Parameters
1030
-
1031
- ##### entry
1032
-
1033
- [`MediaAttachmentDeleteSyncInput`](MediaAttachmentDeleteSyncInput.md)
1034
-
1035
- #### Returns
1036
-
1037
- `Promise`\<`void`\>
1038
-
1039
- ***
1040
-
1041
- ### syncReadToLinkedDevices()
1042
-
1043
- > **syncReadToLinkedDevices**(`entries`): `Promise`\<`void`\>
1044
-
1045
- Sync local read state to the account's other linked devices.
1046
-
1047
- This is separate from read receipts: it updates our own devices so they
1048
- stay in sync even when remote read receipts are disabled.
1049
-
1050
- #### Parameters
1051
-
1052
- ##### entries
1053
-
1054
- [`ReadSyncEntryInput`](ReadSyncEntryInput.md)[]
1055
-
1056
- #### Returns
1057
-
1058
- `Promise`\<`void`\>
1059
-
1060
- ***
1061
-
1062
- ### syncRecipientUsernameToLinkedDevices()
1063
-
1064
- > **syncRecipientUsernameToLinkedDevices**(`recipientUsername`): `Promise`\<`void`\>
1065
-
1066
- Sync learned recipient username metadata to linked devices.
1067
-
1068
- Remote usernames are transient lookup data, but once learned on one device
1069
- they should be available on the account's other linked devices.
1070
-
1071
- #### Parameters
1072
-
1073
- ##### recipientUsername
1074
-
1075
- [`RecipientUsernameSyncInput`](RecipientUsernameSyncInput.md)
1076
-
1077
- #### Returns
1078
-
1079
- `Promise`\<`void`\>
1080
-
1081
- ***
1082
-
1083
- ### syncTaskNotificationAckToLinkedDevices()
1084
-
1085
- > **syncTaskNotificationAckToLinkedDevices**(`input`): `Promise`\<`void`\>
1086
-
1087
- Sync task-notification acknowledgment state to the account's other linked devices.
1088
-
1089
- This is app-level linked-device notification state, not sender-facing content.
1090
-
1091
- #### Parameters
1092
-
1093
- ##### input
1094
-
1095
- `Omit`\<[`TaskNotificationAckSyncInput`](TaskNotificationAckSyncInput.md), `"acknowledgedOnDevice"`\>
1096
-
1097
- #### Returns
1098
-
1099
- `Promise`\<`void`\>
1100
-
1101
- ***
1102
-
1103
- ### syncUsernameStateToLinkedDevices()
1104
-
1105
- > **syncUsernameStateToLinkedDevices**(`usernameState`): `Promise`\<`void`\>
1106
-
1107
- Sync local username and username-link state to linked devices.
1108
-
1109
- This is account-local state, not sender-facing content.
1110
-
1111
- #### Parameters
1112
-
1113
- ##### usernameState
1114
-
1115
- [`UsernameStateSyncInput`](UsernameStateSyncInput.md)
1116
-
1117
- #### Returns
1118
-
1119
- `Promise`\<`void`\>
1120
-
1121
- ***
1122
-
1123
- ### syncVerificationStateToLinkedDevices()
1124
-
1125
- > **syncVerificationStateToLinkedDevices**(`verificationState`): `Promise`\<`void`\>
1126
-
1127
- Sync explicit safety-number verification state to the account's other linked devices.
1128
-
1129
- Only explicit `verified` and cleared-to-`default` states belong here;
1130
- conflict/untrusted state is still derived locally from identity-key changes.
1131
-
1132
- #### Parameters
1133
-
1134
- ##### verificationState
1135
-
1136
- [`VerificationStateSyncInput`](VerificationStateSyncInput.md)
1137
-
1138
- #### Returns
1139
-
1140
- `Promise`\<`void`\>
1141
-
1142
- ***
1143
-
1144
- ### syncViewOnceOpenToLinkedDevices()
1145
-
1146
- > **syncViewOnceOpenToLinkedDevices**(`entry`): `Promise`\<`void`\>
1147
-
1148
- Sync a local view-once open event to the account's other linked devices.
1149
-
1150
- This is account-local device state, not a sender-facing receipt.
1151
-
1152
- #### Parameters
1153
-
1154
- ##### entry
1155
-
1156
- [`ViewOnceOpenSyncInput`](ViewOnceOpenSyncInput.md)
1157
-
1158
- #### Returns
1159
-
1160
- `Promise`\<`void`\>
1161
-
1162
- ***
1163
-
1164
- ### uploadAttachment()
1165
-
1166
- > **uploadAttachment**(`data`, `options`): `Promise`\<[`MediaAttachmentPointer`](../namespaces/media/interfaces/MediaAttachmentPointer.md)\>
1167
-
1168
- Encrypt and upload an attachment without sending a standalone message.
1169
-
1170
- Used by higher-level content types that want to carry attachment metadata
1171
- atomically inside another message payload.
1172
-
1173
- #### Parameters
1174
-
1175
- ##### data
1176
-
1177
- `Uint8Array`
1178
-
1179
- ##### options
1180
-
1181
- [`SendOptions`](SendOptions.md) & `object`
1182
-
1183
- #### Returns
1184
-
1185
- `Promise`\<[`MediaAttachmentPointer`](../namespaces/media/interfaces/MediaAttachmentPointer.md)\>