@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,130 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../README.md) / keys
6
-
7
- # keys
8
-
9
- Key generation utilities namespace
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import { keys } from '@open-e2ee/signal-protocol-sdk';
15
- const identityKey = await keys.generateIdentityKeyPair();
16
- const signedPreKey = await keys.generateEcSignedPreKey(signingKey);
17
- ```
18
-
19
- ## Interfaces
20
-
21
- - [CompositeIdentityV1](interfaces/CompositeIdentityV1.md)
22
- - [ContactIdentityRecord](interfaces/ContactIdentityRecord.md)
23
- - [KemOneTimePreKey](interfaces/KemOneTimePreKey.md)
24
-
25
- ## Type Aliases
26
-
27
- - [IdentityCandidateStatus](type-aliases/IdentityCandidateStatus.md)
28
- - [IdentityTrustState](type-aliases/IdentityTrustState.md)
29
- - [IdentityType](type-aliases/IdentityType.md)
30
-
31
- ## Variables
32
-
33
- - [COMPOSITE\_IDENTITY\_V1\_ED25519\_TAG](variables/COMPOSITE_IDENTITY_V1_ED25519_TAG.md)
34
- - [COMPOSITE\_IDENTITY\_V1\_LENGTH](variables/COMPOSITE_IDENTITY_V1_LENGTH.md)
35
- - [COMPOSITE\_IDENTITY\_V1\_VERSION](variables/COMPOSITE_IDENTITY_V1_VERSION.md)
36
- - [COMPOSITE\_IDENTITY\_V1\_X25519\_TAG](variables/COMPOSITE_IDENTITY_V1_X25519_TAG.md)
37
- - [IDENTITY\_COMMITMENT\_V1\_DOMAIN](variables/IDENTITY_COMMITMENT_V1_DOMAIN.md)
38
- - [PREKEY\_ALGORITHM\_ML\_KEM\_1024](variables/PREKEY_ALGORITHM_ML_KEM_1024.md)
39
- - [PREKEY\_ALGORITHM\_X25519](variables/PREKEY_ALGORITHM_X25519.md)
40
- - [PREKEY\_SIGNATURE\_V1\_DOMAIN](variables/PREKEY_SIGNATURE_V1_DOMAIN.md)
41
- - [UNPINNED\_DEVICE\_IDENTITY\_KEY](variables/UNPINNED_DEVICE_IDENTITY_KEY.md)
42
-
43
- ## Functions
44
-
45
- - [acceptContactIdentityRotation](functions/acceptContactIdentityRotation.md)
46
- - [assertIdentityCommitment](functions/assertIdentityCommitment.md)
47
- - [canonicalizeDeviceIdentityKey](functions/canonicalizeDeviceIdentityKey.md)
48
- - [compareDeviceIdentityKeys](functions/compareDeviceIdentityKeys.md)
49
- - [compositeIdentitiesEqual](functions/compositeIdentitiesEqual.md)
50
- - [createCompositeIdentityV1](functions/createCompositeIdentityV1.md)
51
- - [createPreKeySignatureContext](functions/createPreKeySignatureContext.md)
52
- - [createUnverifiedContactIdentityRecord](functions/createUnverifiedContactIdentityRecord.md)
53
- - [decodeCompositeIdentityV1](functions/decodeCompositeIdentityV1.md)
54
- - [deriveIdentityCommitment](functions/deriveIdentityCommitment.md)
55
- - [encodeCompositeIdentityV1](functions/encodeCompositeIdentityV1.md)
56
- - [evaluateContactIdentityCandidate](functions/evaluateContactIdentityCandidate.md)
57
- - [generateEcOneTimePreKeys](functions/generateEcOneTimePreKeys.md)
58
- - [generateEcSignedPreKey](functions/generateEcSignedPreKey.md)
59
- - [generateEcSignedPreKeyId](functions/generateEcSignedPreKeyId.md)
60
- - [generateIdentityKeyPair](functions/generateIdentityKeyPair.md)
61
- - [generateKemOneTimePreKeys](functions/generateKemOneTimePreKeys.md)
62
- - [generateKyberLastResortPreKey](functions/generateKyberLastResortPreKey.md)
63
- - [generateRegistrationId](functions/generateRegistrationId.md)
64
- - [isValidDeviceIdentityKey](functions/isValidDeviceIdentityKey.md)
65
- - [signMlKem1024PreKey](functions/signMlKem1024PreKey.md)
66
- - [signPreKey](functions/signPreKey.md)
67
- - [validateContactIdentityRecord](functions/validateContactIdentityRecord.md)
68
- - [verifyContactIdentityRecord](functions/verifyContactIdentityRecord.md)
69
- - [verifyMlKem1024PreKey](functions/verifyMlKem1024PreKey.md)
70
- - [verifyPreKeySignature](functions/verifyPreKeySignature.md)
71
-
72
- ## References
73
-
74
- ### Ciphertext
75
-
76
- Re-exports [Ciphertext](../../type-aliases/Ciphertext.md)
77
-
78
- ***
79
-
80
- ### EcOneTimePreKey
81
-
82
- Re-exports [EcOneTimePreKey](../../interfaces/EcOneTimePreKey.md)
83
-
84
- ***
85
-
86
- ### EcSignedPreKey
87
-
88
- Re-exports [EcSignedPreKey](../../interfaces/EcSignedPreKey.md)
89
-
90
- ***
91
-
92
- ### IdentityKeyPair
93
-
94
- Re-exports [IdentityKeyPair](../../interfaces/IdentityKeyPair.md)
95
-
96
- ***
97
-
98
- ### KeyPair
99
-
100
- Re-exports [KeyPair](../../interfaces/KeyPair.md)
101
-
102
- ***
103
-
104
- ### KyberPreKey
105
-
106
- Re-exports [KyberPreKey](../../interfaces/KyberPreKey.md)
107
-
108
- ***
109
-
110
- ### PreKeyBundle
111
-
112
- Renames and re-exports [RelayPreKeyBundle](../../interfaces/RelayPreKeyBundle.md)
113
-
114
- ***
115
-
116
- ### PrivateKey
117
-
118
- Re-exports [PrivateKey](../../type-aliases/PrivateKey.md)
119
-
120
- ***
121
-
122
- ### PublicKey
123
-
124
- Re-exports [PublicKey](../../type-aliases/PublicKey.md)
125
-
126
- ***
127
-
128
- ### Signature
129
-
130
- Re-exports [Signature](../../type-aliases/Signature.md)
@@ -1,33 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / acceptContactIdentityRotation
6
-
7
- # Function: acceptContactIdentityRotation()
8
-
9
- > **acceptContactIdentityRotation**(`record`, `candidate`, `now`, `suppliedCommitment?`): [`ContactIdentityRecord`](../interfaces/ContactIdentityRecord.md)
10
-
11
- Explicit user/application acceptance path; automatic save must not call this.
12
-
13
- ## Parameters
14
-
15
- ### record
16
-
17
- [`ContactIdentityRecord`](../interfaces/ContactIdentityRecord.md)
18
-
19
- ### candidate
20
-
21
- [`CompositeIdentityV1`](../interfaces/CompositeIdentityV1.md)
22
-
23
- ### now
24
-
25
- `number`
26
-
27
- ### suppliedCommitment?
28
-
29
- `Uint8Array`\<`ArrayBufferLike`\>
30
-
31
- ## Returns
32
-
33
- [`ContactIdentityRecord`](../interfaces/ContactIdentityRecord.md)
@@ -1,25 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / assertIdentityCommitment
6
-
7
- # Function: assertIdentityCommitment()
8
-
9
- > **assertIdentityCommitment**(`identity`, `suppliedCommitment`): `void`
10
-
11
- Reject a redundant relay/cache assertion that disagrees with the tuple.
12
-
13
- ## Parameters
14
-
15
- ### identity
16
-
17
- [`CompositeIdentityV1`](../interfaces/CompositeIdentityV1.md)
18
-
19
- ### suppliedCommitment
20
-
21
- `Uint8Array`
22
-
23
- ## Returns
24
-
25
- `void`
@@ -1,30 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / canonicalizeDeviceIdentityKey
6
-
7
- # Function: canonicalizeDeviceIdentityKey()
8
-
9
- > **canonicalizeDeviceIdentityKey**(`bytes`, `label`): `Uint8Array`
10
-
11
- Reduce `DeviceRecord.identityKey` bytes to their canonical form, rejecting
12
- any other encoding at the storage boundary.
13
-
14
- Every producer of device identity bytes goes through here so that a single
15
- encoding reaches storage and comparison. Without it, two producers using two
16
- encodings of the same key compare unequal and forge an identity-change event.
17
-
18
- ## Parameters
19
-
20
- ### bytes
21
-
22
- `Uint8Array`
23
-
24
- ### label
25
-
26
- `string`
27
-
28
- ## Returns
29
-
30
- `Uint8Array`
@@ -1,28 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / compareDeviceIdentityKeys
6
-
7
- # Function: compareDeviceIdentityKeys()
8
-
9
- > **compareDeviceIdentityKeys**(`pinned`, `incoming`): `"unpinned"` \| `"same"` \| `"changed"`
10
-
11
- Compare two `DeviceRecord.identityKey` values.
12
-
13
- Returns `'unpinned'` when no identity has been observed for the device yet,
14
- which is first contact (a TOFU pin) and not a change.
15
-
16
- ## Parameters
17
-
18
- ### pinned
19
-
20
- `Uint8Array`
21
-
22
- ### incoming
23
-
24
- `Uint8Array`
25
-
26
- ## Returns
27
-
28
- `"unpinned"` \| `"same"` \| `"changed"`
@@ -1,23 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / compositeIdentitiesEqual
6
-
7
- # Function: compositeIdentitiesEqual()
8
-
9
- > **compositeIdentitiesEqual**(`left`, `right`): `boolean`
10
-
11
- ## Parameters
12
-
13
- ### left
14
-
15
- [`CompositeIdentityV1`](../interfaces/CompositeIdentityV1.md)
16
-
17
- ### right
18
-
19
- [`CompositeIdentityV1`](../interfaces/CompositeIdentityV1.md)
20
-
21
- ## Returns
22
-
23
- `boolean`
@@ -1,19 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / createCompositeIdentityV1
6
-
7
- # Function: createCompositeIdentityV1()
8
-
9
- > **createCompositeIdentityV1**(`identity`): [`CompositeIdentityV1`](../interfaces/CompositeIdentityV1.md)
10
-
11
- ## Parameters
12
-
13
- ### identity
14
-
15
- `Pick`\<[`IdentityKeyPair`](../../../interfaces/IdentityKeyPair.md), `"dhKey"` \| `"signingKey"`\>
16
-
17
- ## Returns
18
-
19
- [`CompositeIdentityV1`](../interfaces/CompositeIdentityV1.md)
@@ -1,31 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / createPreKeySignatureContext
6
-
7
- # Function: createPreKeySignatureContext()
8
-
9
- > **createPreKeySignatureContext**(`identity`, `algorithmTag`, `keyId`, `serializedPublicKey`): `Uint8Array`
10
-
11
- ## Parameters
12
-
13
- ### identity
14
-
15
- [`CompositeIdentityV1`](../interfaces/CompositeIdentityV1.md)
16
-
17
- ### algorithmTag
18
-
19
- `number`
20
-
21
- ### keyId
22
-
23
- `number`
24
-
25
- ### serializedPublicKey
26
-
27
- `Uint8Array`
28
-
29
- ## Returns
30
-
31
- `Uint8Array`
@@ -1,23 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / createUnverifiedContactIdentityRecord
6
-
7
- # Function: createUnverifiedContactIdentityRecord()
8
-
9
- > **createUnverifiedContactIdentityRecord**(`identity`, `now`): [`ContactIdentityRecord`](../interfaces/ContactIdentityRecord.md)
10
-
11
- ## Parameters
12
-
13
- ### identity
14
-
15
- [`CompositeIdentityV1`](../interfaces/CompositeIdentityV1.md)
16
-
17
- ### now
18
-
19
- `number`
20
-
21
- ## Returns
22
-
23
- [`ContactIdentityRecord`](../interfaces/ContactIdentityRecord.md)
@@ -1,19 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / decodeCompositeIdentityV1
6
-
7
- # Function: decodeCompositeIdentityV1()
8
-
9
- > **decodeCompositeIdentityV1**(`encoded`): [`CompositeIdentityV1`](../interfaces/CompositeIdentityV1.md)
10
-
11
- ## Parameters
12
-
13
- ### encoded
14
-
15
- `Uint8Array`
16
-
17
- ## Returns
18
-
19
- [`CompositeIdentityV1`](../interfaces/CompositeIdentityV1.md)
@@ -1,19 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / deriveIdentityCommitment
6
-
7
- # Function: deriveIdentityCommitment()
8
-
9
- > **deriveIdentityCommitment**(`identity`): `Uint8Array`
10
-
11
- ## Parameters
12
-
13
- ### identity
14
-
15
- [`CompositeIdentityV1`](../interfaces/CompositeIdentityV1.md)
16
-
17
- ## Returns
18
-
19
- `Uint8Array`
@@ -1,19 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / encodeCompositeIdentityV1
6
-
7
- # Function: encodeCompositeIdentityV1()
8
-
9
- > **encodeCompositeIdentityV1**(`identity`): `Uint8Array`
10
-
11
- ## Parameters
12
-
13
- ### identity
14
-
15
- [`CompositeIdentityV1`](../interfaces/CompositeIdentityV1.md)
16
-
17
- ## Returns
18
-
19
- `Uint8Array`
@@ -1,27 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / evaluateContactIdentityCandidate
6
-
7
- # Function: evaluateContactIdentityCandidate()
8
-
9
- > **evaluateContactIdentityCandidate**(`record`, `candidate`, `suppliedCommitment?`): [`IdentityCandidateStatus`](../type-aliases/IdentityCandidateStatus.md)
10
-
11
- ## Parameters
12
-
13
- ### record
14
-
15
- [`ContactIdentityRecord`](../interfaces/ContactIdentityRecord.md) \| `null`
16
-
17
- ### candidate
18
-
19
- [`CompositeIdentityV1`](../interfaces/CompositeIdentityV1.md)
20
-
21
- ### suppliedCommitment?
22
-
23
- `Uint8Array`\<`ArrayBufferLike`\>
24
-
25
- ## Returns
26
-
27
- [`IdentityCandidateStatus`](../type-aliases/IdentityCandidateStatus.md)
@@ -1,37 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / generateEcOneTimePreKeys
6
-
7
- # Function: generateEcOneTimePreKeys()
8
-
9
- > **generateEcOneTimePreKeys**(`count`, `startId?`): `Promise`\<[`EcOneTimePreKey`](../../../interfaces/EcOneTimePreKey.md)[]\>
10
-
11
- Generate batch of EC one-time prekeys
12
-
13
- Creates multiple EC one-time prekeys for X3DH.
14
- Each key can only be used once for forward secrecy.
15
-
16
- ## Parameters
17
-
18
- ### count
19
-
20
- `number`
21
-
22
- Number of prekeys to generate
23
-
24
- ### startId?
25
-
26
- `number` = `0`
27
-
28
- Starting ID for sequential assignment
29
-
30
- ## Returns
31
-
32
- `Promise`\<[`EcOneTimePreKey`](../../../interfaces/EcOneTimePreKey.md)[]\>
33
-
34
- ## See
35
-
36
- - https://signal.org/docs/specifications/x3dh/#keys
37
- - https://signal.org/docs/specifications/x3dh/#publishing-keys
@@ -1,39 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / generateEcSignedPreKey
6
-
7
- # Function: generateEcSignedPreKey()
8
-
9
- > **generateEcSignedPreKey**(`identityKeyPair`, `id?`): `Promise`\<[`EcSignedPreKey`](../../../interfaces/EcSignedPreKey.md)\>
10
-
11
- Generate EC signed prekey
12
-
13
- Creates an EC signed prekey that includes:
14
- - ECDH key pair for key agreement
15
- - Signature over public key using identity signing key
16
- - Timestamp for rotation tracking
17
-
18
- ## Parameters
19
-
20
- ### identityKeyPair
21
-
22
- [`IdentityKeyPair`](../../../interfaces/IdentityKeyPair.md)
23
-
24
- Complete composite identity key pair for contextual signing
25
-
26
- ### id?
27
-
28
- `number`
29
-
30
- Optional prekey ID (random if not provided)
31
-
32
- ## Returns
33
-
34
- `Promise`\<[`EcSignedPreKey`](../../../interfaces/EcSignedPreKey.md)\>
35
-
36
- ## See
37
-
38
- - https://signal.org/docs/specifications/x3dh/#keys
39
- - https://signal.org/docs/specifications/x3dh/#publishing-keys
@@ -1,21 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / generateEcSignedPreKeyId
6
-
7
- # Function: generateEcSignedPreKeyId()
8
-
9
- > **generateEcSignedPreKeyId**(): `Promise`\<`number`\>
10
-
11
- Generate EC signed prekey ID
12
-
13
- Returns a random ID for EC signed prekeys.
14
- Range: 0 to 999,999
15
-
16
- Uses CSPRNG (generateRandomBytes) instead of Math.random() for
17
- cryptographic security.
18
-
19
- ## Returns
20
-
21
- `Promise`\<`number`\>
@@ -1,24 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / generateIdentityKeyPair
6
-
7
- # Function: generateIdentityKeyPair()
8
-
9
- > **generateIdentityKeyPair**(): `Promise`\<[`IdentityKeyPair`](../../../interfaces/IdentityKeyPair.md)\>
10
-
11
- Generate identity key pair
12
-
13
- Creates the long-lived identity key pair consisting of:
14
- - DH key pair for X3DH/PQXDH key agreement
15
- - Signing key pair for prekey signatures
16
- - Registration ID for session reset detection
17
-
18
- ## Returns
19
-
20
- `Promise`\<[`IdentityKeyPair`](../../../interfaces/IdentityKeyPair.md)\>
21
-
22
- ## See
23
-
24
- https://signal.org/docs/specifications/x3dh/#keys
@@ -1,47 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / generateKemOneTimePreKeys
6
-
7
- # Function: generateKemOneTimePreKeys()
8
-
9
- > **generateKemOneTimePreKeys**(`identityKeyPair`, `count`, `startId?`): `Promise`\<[`KemOneTimePreKey`](../interfaces/KemOneTimePreKey.md)[]\>
10
-
11
- Generate batch of KEM one-time prekeys (post-quantum)
12
-
13
- Creates multiple one-time Kyber prekeys for PQXDH.
14
- Each key can only be used once for per-session post-quantum forward secrecy.
15
-
16
- Per PQXDH spec Section 3.2, these are signed one-time pqkem prekeys
17
- that the server prefers over the last-resort KEM prekey.
18
-
19
- Uses the same batch size as EC one-time prekeys (the reference implementation uses 100 for both).
20
-
21
- ## Parameters
22
-
23
- ### identityKeyPair
24
-
25
- [`IdentityKeyPair`](../../../interfaces/IdentityKeyPair.md)
26
-
27
- Complete composite identity key pair for contextual signing
28
-
29
- ### count
30
-
31
- `number`
32
-
33
- Number of prekeys to generate
34
-
35
- ### startId?
36
-
37
- `number` = `0`
38
-
39
- Starting ID for sequential assignment
40
-
41
- ## Returns
42
-
43
- `Promise`\<[`KemOneTimePreKey`](../interfaces/KemOneTimePreKey.md)[]\>
44
-
45
- ## See
46
-
47
- https://signal.org/docs/specifications/pqxdh/#sending-the-initial-message
@@ -1,37 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / generateKyberLastResortPreKey
6
-
7
- # Function: generateKyberLastResortPreKey()
8
-
9
- > **generateKyberLastResortPreKey**(`identityKeyPair`, `id?`): `Promise`\<[`KyberPreKey`](../../../interfaces/KyberPreKey.md)\>
10
-
11
- Generate Kyber prekey for PQXDH
12
-
13
- Creates a post-quantum prekey using ML-KEM-1024 (Kyber).
14
- Per PQXDH spec Section 3.2, this is a "signed last-resort" prekey
15
- that rotates periodically, always using ID 1.
16
-
17
- ## Parameters
18
-
19
- ### identityKeyPair
20
-
21
- [`IdentityKeyPair`](../../../interfaces/IdentityKeyPair.md)
22
-
23
- Complete composite identity key pair for contextual signing
24
-
25
- ### id?
26
-
27
- `number` = `1`
28
-
29
- Optional prekey ID (default: 1 per PQXDH spec)
30
-
31
- ## Returns
32
-
33
- `Promise`\<[`KyberPreKey`](../../../interfaces/KyberPreKey.md)\>
34
-
35
- ## See
36
-
37
- https://signal.org/docs/specifications/pqxdh/
@@ -1,13 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../../../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../../../README.md) / [keys](../README.md) / generateRegistrationId
6
-
7
- # Function: generateRegistrationId()
8
-
9
- > **generateRegistrationId**(): `Promise`\<`number`\>
10
-
11
- ## Returns
12
-
13
- `Promise`\<`number`\>