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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (655) hide show
  1. package/ADAPTERS.md +1 -1
  2. package/CHANGELOG.md +767 -2
  3. package/COMMERCIAL.md +56 -0
  4. package/README.md +13 -8
  5. package/SECURITY.md +15 -1
  6. package/client/README.md +1 -1
  7. package/dist/client/client.d.ts.map +1 -1
  8. package/dist/client/client.js +16 -8
  9. package/dist/client/client.js.map +1 -1
  10. package/dist/client/config.d.ts +12 -2
  11. package/dist/client/config.d.ts.map +1 -1
  12. package/dist/client/config.js.map +1 -1
  13. package/dist/client/endorsement-manager.d.ts +19 -2
  14. package/dist/client/endorsement-manager.d.ts.map +1 -1
  15. package/dist/client/endorsement-manager.js +26 -10
  16. package/dist/client/endorsement-manager.js.map +1 -1
  17. package/dist/client/headless.d.ts +1 -1
  18. package/dist/client/headless.js +1 -1
  19. package/dist/client/sealed-sender-ops.d.ts +27 -1
  20. package/dist/client/sealed-sender-ops.d.ts.map +1 -1
  21. package/dist/client/sealed-sender-ops.js +36 -6
  22. package/dist/client/sealed-sender-ops.js.map +1 -1
  23. package/dist/client/signal-service-cipher.d.ts +16 -1
  24. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  25. package/dist/client/signal-service-cipher.js +112 -52
  26. package/dist/client/signal-service-cipher.js.map +1 -1
  27. package/dist/client/types.d.ts +20 -7
  28. package/dist/client/types.d.ts.map +1 -1
  29. package/dist/client/types.js.map +1 -1
  30. package/dist/index.d.ts +7 -0
  31. package/dist/index.d.ts.map +1 -1
  32. package/dist/index.js +7 -0
  33. package/dist/index.js.map +1 -1
  34. package/dist/internal/crypto/index.d.ts +1 -1
  35. package/dist/internal/crypto/index.d.ts.map +1 -1
  36. package/dist/internal/crypto/index.js +1 -1
  37. package/dist/internal/crypto/index.js.map +1 -1
  38. package/dist/internal/crypto/random.d.ts +9 -0
  39. package/dist/internal/crypto/random.d.ts.map +1 -1
  40. package/dist/internal/crypto/random.js +16 -0
  41. package/dist/internal/crypto/random.js.map +1 -1
  42. package/dist/internal/groups/manager.d.ts +37 -5
  43. package/dist/internal/groups/manager.d.ts.map +1 -1
  44. package/dist/internal/groups/manager.js +98 -15
  45. package/dist/internal/groups/manager.js.map +1 -1
  46. package/dist/internal/groups/server-engine.d.ts +48 -2
  47. package/dist/internal/groups/server-engine.d.ts.map +1 -1
  48. package/dist/internal/groups/server-engine.js +122 -13
  49. package/dist/internal/groups/server-engine.js.map +1 -1
  50. package/dist/internal/protocol/sealed-sender/decryption-v2.d.ts.map +1 -1
  51. package/dist/internal/protocol/sealed-sender/decryption-v2.js +32 -18
  52. package/dist/internal/protocol/sealed-sender/decryption-v2.js.map +1 -1
  53. package/dist/internal/protocol/sealed-sender/decryption.d.ts.map +1 -1
  54. package/dist/internal/protocol/sealed-sender/decryption.js +33 -19
  55. package/dist/internal/protocol/sealed-sender/decryption.js.map +1 -1
  56. package/dist/internal/protocol/sealed-sender/encryption-v2.d.ts.map +1 -1
  57. package/dist/internal/protocol/sealed-sender/encryption-v2.js +8 -14
  58. package/dist/internal/protocol/sealed-sender/encryption-v2.js.map +1 -1
  59. package/dist/internal/protocol/sealed-sender/encryption.d.ts +9 -4
  60. package/dist/internal/protocol/sealed-sender/encryption.d.ts.map +1 -1
  61. package/dist/internal/protocol/sealed-sender/encryption.js +7 -15
  62. package/dist/internal/protocol/sealed-sender/encryption.js.map +1 -1
  63. package/dist/internal/protocol/sealed-sender/proto/index.d.ts +6 -7
  64. package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
  65. package/dist/internal/protocol/sealed-sender/proto/index.js +5 -7
  66. package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
  67. package/dist/internal/protocol/sealed-sender/trust-root.d.ts +45 -0
  68. package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +1 -0
  69. package/dist/internal/protocol/sealed-sender/trust-root.js +77 -0
  70. package/dist/internal/protocol/sealed-sender/trust-root.js.map +1 -0
  71. package/dist/internal/protocol/sealed-sender/types.d.ts +64 -9
  72. package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
  73. package/dist/internal/protocol/sealed-sender/types.js +43 -0
  74. package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
  75. package/dist/internal/protocol/sender-keys/manager.d.ts +37 -0
  76. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  77. package/dist/internal/protocol/sender-keys/manager.js +108 -7
  78. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  79. package/dist/local/store/expo/adapter.d.ts +14 -15
  80. package/dist/local/store/expo/adapter.d.ts.map +1 -1
  81. package/dist/local/store/expo/adapter.js +109 -102
  82. package/dist/local/store/expo/adapter.js.map +1 -1
  83. package/dist/local/store/expo/db.d.ts +4 -1
  84. package/dist/local/store/expo/db.d.ts.map +1 -1
  85. package/dist/local/store/expo/db.js +5 -0
  86. package/dist/local/store/expo/db.js.map +1 -1
  87. package/dist/local/store/expo/index.d.ts +0 -2
  88. package/dist/local/store/expo/index.d.ts.map +1 -1
  89. package/dist/local/store/expo/index.js +1 -1
  90. package/dist/local/store/expo/index.js.map +1 -1
  91. package/dist/local/store/expo/models/index.d.ts +1 -1
  92. package/dist/local/store/expo/models/index.d.ts.map +1 -1
  93. package/dist/local/store/expo/models/index.js +2 -2
  94. package/dist/local/store/expo/models/index.js.map +1 -1
  95. package/dist/local/store/expo/models/sender-key.d.ts +101 -77
  96. package/dist/local/store/expo/models/sender-key.d.ts.map +1 -1
  97. package/dist/local/store/expo/models/sender-key.js +154 -124
  98. package/dist/local/store/expo/models/sender-key.js.map +1 -1
  99. package/dist/local/store/expo/schema.d.ts +134 -32
  100. package/dist/local/store/expo/schema.d.ts.map +1 -1
  101. package/dist/local/store/expo/schema.js +36 -7
  102. package/dist/local/store/expo/schema.js.map +1 -1
  103. package/dist/local/store/mock/adapter.d.ts +1 -0
  104. package/dist/local/store/mock/adapter.d.ts.map +1 -1
  105. package/dist/local/store/mock/adapter.js +18 -0
  106. package/dist/local/store/mock/adapter.js.map +1 -1
  107. package/dist/local/store/node/adapter.d.ts +53 -4
  108. package/dist/local/store/node/adapter.d.ts.map +1 -1
  109. package/dist/local/store/node/adapter.js +456 -9
  110. package/dist/local/store/node/adapter.js.map +1 -1
  111. package/dist/local/store/node/database.d.ts +68 -0
  112. package/dist/local/store/node/database.d.ts.map +1 -1
  113. package/dist/local/store/node/database.js +201 -18
  114. package/dist/local/store/node/database.js.map +1 -1
  115. package/dist/local/store/react-native/adapter.d.ts +39 -0
  116. package/dist/local/store/react-native/adapter.d.ts.map +1 -1
  117. package/dist/local/store/react-native/adapter.js +163 -8
  118. package/dist/local/store/react-native/adapter.js.map +1 -1
  119. package/dist/local/store/web/adapter.d.ts +1 -0
  120. package/dist/local/store/web/adapter.d.ts.map +1 -1
  121. package/dist/local/store/web/adapter.js +33 -1
  122. package/dist/local/store/web/adapter.js.map +1 -1
  123. package/dist/remote/relay/convex/backend.d.ts +405 -0
  124. package/dist/remote/relay/convex/backend.d.ts.map +1 -0
  125. package/dist/remote/relay/convex/backend.js +687 -0
  126. package/dist/remote/relay/convex/backend.js.map +1 -0
  127. package/dist/remote/relay/convex/component/_generated/api.d.ts +58 -0
  128. package/dist/remote/relay/convex/component/_generated/api.d.ts.map +1 -0
  129. package/dist/remote/relay/convex/component/_generated/api.js +31 -0
  130. package/dist/remote/relay/convex/component/_generated/api.js.map +1 -0
  131. package/dist/remote/relay/convex/component/_generated/component.d.ts +483 -0
  132. package/dist/remote/relay/convex/component/_generated/component.d.ts.map +1 -0
  133. package/dist/remote/relay/convex/component/_generated/component.js +11 -0
  134. package/dist/remote/relay/convex/component/_generated/component.js.map +1 -0
  135. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts +46 -0
  136. package/dist/remote/relay/convex/component/_generated/dataModel.d.ts.map +1 -0
  137. package/dist/remote/relay/convex/component/_generated/dataModel.js +11 -0
  138. package/dist/remote/relay/convex/component/_generated/dataModel.js.map +1 -0
  139. package/dist/remote/relay/convex/component/_generated/server.d.ts +129 -0
  140. package/dist/remote/relay/convex/component/_generated/server.d.ts.map +1 -0
  141. package/dist/remote/relay/convex/component/_generated/server.js +79 -0
  142. package/dist/remote/relay/convex/component/_generated/server.js.map +1 -0
  143. package/dist/remote/relay/convex/component/accounts.d.ts +43 -0
  144. package/dist/remote/relay/convex/component/accounts.d.ts.map +1 -0
  145. package/dist/remote/relay/convex/component/accounts.js +181 -0
  146. package/dist/remote/relay/convex/component/accounts.js.map +1 -0
  147. package/dist/remote/relay/convex/component/certificates.d.ts +10 -0
  148. package/dist/remote/relay/convex/component/certificates.d.ts.map +1 -0
  149. package/dist/remote/relay/convex/component/certificates.js +122 -0
  150. package/dist/remote/relay/convex/component/certificates.js.map +1 -0
  151. package/dist/remote/relay/convex/component/cleanup.d.ts +32 -0
  152. package/dist/remote/relay/convex/component/cleanup.d.ts.map +1 -0
  153. package/dist/remote/relay/convex/component/cleanup.js +146 -0
  154. package/dist/remote/relay/convex/component/cleanup.js.map +1 -0
  155. package/dist/remote/relay/convex/component/convex.config.d.ts +5 -0
  156. package/dist/remote/relay/convex/component/convex.config.d.ts.map +1 -0
  157. package/dist/remote/relay/convex/component/convex.config.js +33 -0
  158. package/dist/remote/relay/convex/component/convex.config.js.map +1 -0
  159. package/dist/remote/relay/convex/component/crons.d.ts +3 -0
  160. package/dist/remote/relay/convex/component/crons.d.ts.map +1 -0
  161. package/dist/remote/relay/convex/component/crons.js +10 -0
  162. package/dist/remote/relay/convex/component/crons.js.map +1 -0
  163. package/dist/remote/relay/convex/component/devices.d.ts +101 -0
  164. package/dist/remote/relay/convex/component/devices.d.ts.map +1 -0
  165. package/dist/remote/relay/convex/component/devices.js +299 -0
  166. package/dist/remote/relay/convex/component/devices.js.map +1 -0
  167. package/dist/remote/relay/convex/component/errors.d.ts +22 -0
  168. package/dist/remote/relay/convex/component/errors.d.ts.map +1 -0
  169. package/dist/remote/relay/convex/component/errors.js +17 -0
  170. package/dist/remote/relay/convex/component/errors.js.map +1 -0
  171. package/dist/remote/relay/convex/component/groups.d.ts +63 -0
  172. package/dist/remote/relay/convex/component/groups.d.ts.map +1 -0
  173. package/dist/remote/relay/convex/component/groups.js +341 -0
  174. package/dist/remote/relay/convex/component/groups.js.map +1 -0
  175. package/dist/remote/relay/convex/component/keys.d.ts +130 -0
  176. package/dist/remote/relay/convex/component/keys.d.ts.map +1 -0
  177. package/dist/remote/relay/convex/component/keys.js +578 -0
  178. package/dist/remote/relay/convex/component/keys.js.map +1 -0
  179. package/dist/remote/relay/convex/component/messages.d.ts +119 -0
  180. package/dist/remote/relay/convex/component/messages.d.ts.map +1 -0
  181. package/dist/remote/relay/convex/component/messages.js +723 -0
  182. package/dist/remote/relay/convex/component/messages.js.map +1 -0
  183. package/dist/remote/relay/convex/component/provisioning.d.ts +92 -0
  184. package/dist/remote/relay/convex/component/provisioning.d.ts.map +1 -0
  185. package/dist/remote/relay/convex/component/provisioning.js +359 -0
  186. package/dist/remote/relay/convex/component/provisioning.js.map +1 -0
  187. package/dist/remote/relay/convex/component/runtime.d.ts +18 -0
  188. package/dist/remote/relay/convex/component/runtime.d.ts.map +1 -0
  189. package/dist/remote/relay/convex/component/runtime.js +142 -0
  190. package/dist/remote/relay/convex/component/runtime.js.map +1 -0
  191. package/dist/remote/relay/convex/component/schema.d.ts +358 -0
  192. package/dist/remote/relay/convex/component/schema.d.ts.map +1 -0
  193. package/dist/remote/relay/convex/component/schema.js +287 -0
  194. package/dist/remote/relay/convex/component/schema.js.map +1 -0
  195. package/dist/remote/relay/convex/component/zkAuth.d.ts +12 -0
  196. package/dist/remote/relay/convex/component/zkAuth.d.ts.map +1 -0
  197. package/dist/remote/relay/convex/component/zkAuth.js +71 -0
  198. package/dist/remote/relay/convex/component/zkAuth.js.map +1 -0
  199. package/dist/remote/relay/convex/constants.d.ts +3 -0
  200. package/dist/remote/relay/convex/constants.d.ts.map +1 -0
  201. package/dist/remote/relay/convex/constants.js +3 -0
  202. package/dist/remote/relay/convex/constants.js.map +1 -0
  203. package/dist/remote/relay/convex/group-server.d.ts +9 -6
  204. package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
  205. package/dist/remote/relay/convex/group-server.js +17 -11
  206. package/dist/remote/relay/convex/group-server.js.map +1 -1
  207. package/dist/remote/relay/convex/index.d.ts +4 -1
  208. package/dist/remote/relay/convex/index.d.ts.map +1 -1
  209. package/dist/remote/relay/convex/index.js +3 -1
  210. package/dist/remote/relay/convex/index.js.map +1 -1
  211. package/dist/remote/relay/convex/relay.d.ts +44 -65
  212. package/dist/remote/relay/convex/relay.d.ts.map +1 -1
  213. package/dist/remote/relay/convex/relay.js +61 -36
  214. package/dist/remote/relay/convex/relay.js.map +1 -1
  215. package/dist/remote/relay/convex/types.d.ts +16 -103
  216. package/dist/remote/relay/convex/types.d.ts.map +1 -1
  217. package/dist/remote/relay/convex/types.js +8 -13
  218. package/dist/remote/relay/convex/types.js.map +1 -1
  219. package/dist/remote/relay/index.d.ts +1 -1
  220. package/dist/remote/relay/index.d.ts.map +1 -1
  221. package/dist/remote/relay/index.js.map +1 -1
  222. package/dist/remote/relay/mock/adapter.d.ts +4 -9
  223. package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
  224. package/dist/remote/relay/mock/adapter.js +39 -22
  225. package/dist/remote/relay/mock/adapter.js.map +1 -1
  226. package/dist/remote/relay/types.d.ts +57 -75
  227. package/dist/remote/relay/types.d.ts.map +1 -1
  228. package/dist/remote/relay/types.js +0 -1
  229. package/dist/remote/relay/types.js.map +1 -1
  230. package/dist/types/api.d.ts +21 -0
  231. package/dist/types/api.d.ts.map +1 -1
  232. package/dist/types/protocol-config.d.ts +51 -0
  233. package/dist/types/protocol-config.d.ts.map +1 -1
  234. package/dist/types/protocol-config.js +46 -0
  235. package/dist/types/protocol-config.js.map +1 -1
  236. package/docs/ASSURANCE.md +10 -6
  237. package/docs/CLIENT_COMPOSITION.md +23 -69
  238. package/docs/DEVIATIONS.md +44 -11
  239. package/docs/E2EE.md +71 -6
  240. package/docs/GETTING_STARTED.md +1 -1
  241. package/docs/PACKAGE_SURFACE.md +6 -5
  242. package/docs/RECIPES.md +1 -1
  243. package/docs/SECURITY.md +8 -0
  244. package/local/store/README.md +3 -1
  245. package/local/store/expo/README.md +10 -1
  246. package/local/store/node/README.md +8 -1
  247. package/package.json +12 -7
  248. package/remote/relay/convex/README.md +1 -1
  249. package/remote/relay/convex/component/README.md +428 -0
  250. package/scripts/oe-groups.mjs +21 -1
  251. package/dist/remote/relay/convex/server/index.d.ts +0 -2
  252. package/dist/remote/relay/convex/server/index.d.ts.map +0 -1
  253. package/dist/remote/relay/convex/server/index.js +0 -2
  254. package/dist/remote/relay/convex/server/index.js.map +0 -1
  255. package/dist/remote/relay/convex/server.d.ts +0 -150
  256. package/dist/remote/relay/convex/server.d.ts.map +0 -1
  257. package/dist/remote/relay/convex/server.js +0 -506
  258. package/dist/remote/relay/convex/server.js.map +0 -1
  259. package/docs/api/README.md +0 -471
  260. package/docs/api/classes/EncryptionError.md +0 -112
  261. package/docs/api/classes/EndorsementManager.md +0 -325
  262. package/docs/api/classes/SealedSenderAuthError.md +0 -127
  263. package/docs/api/classes/ServerDerivedKeyPair.md +0 -68
  264. package/docs/api/classes/ServerDerivedPublicKey.md +0 -33
  265. package/docs/api/classes/ServerRootKeyPair.md +0 -94
  266. package/docs/api/classes/ServerRootPublicKey.md +0 -72
  267. package/docs/api/classes/SignalProtocolBlockingManager.md +0 -106
  268. package/docs/api/classes/SignalProtocolClient.md +0 -2654
  269. package/docs/api/classes/VerificationFailure.md +0 -25
  270. package/docs/api/enumerations/ContentHint.md +0 -63
  271. package/docs/api/enumerations/EncryptionErrorCode.md +0 -488
  272. package/docs/api/enumerations/IdentityKeyChange.md +0 -65
  273. package/docs/api/enumerations/MessageType.md +0 -29
  274. package/docs/api/enumerations/TrustDirection.md +0 -33
  275. package/docs/api/enumerations/TypingAction.md +0 -31
  276. package/docs/api/functions/createDefaultSignalProtocolContentAdapter.md +0 -13
  277. package/docs/api/functions/createDefaultSignalProtocolLogger.md +0 -36
  278. package/docs/api/functions/createGroupId.md +0 -32
  279. package/docs/api/functions/createSignalProtocolClient.md +0 -36
  280. package/docs/api/functions/createSignalProtocolClientConfig.md +0 -24
  281. package/docs/api/functions/decodeGroupTrustRoot.md +0 -21
  282. package/docs/api/functions/encodeGroupTrustRoot.md +0 -28
  283. package/docs/api/functions/extractGroupId.md +0 -32
  284. package/docs/api/functions/formatVersion.md +0 -25
  285. package/docs/api/functions/isCompatible.md +0 -31
  286. package/docs/api/functions/isGroupId.md +0 -37
  287. package/docs/api/functions/isSealedSenderAuthError.md +0 -25
  288. package/docs/api/functions/parseVersion.md +0 -29
  289. package/docs/api/functions/resolveSPQRLimits.md +0 -21
  290. package/docs/api/functions/resolveSignalProtocolLogger.md +0 -42
  291. package/docs/api/interfaces/AccountIdentityProvisioning.md +0 -43
  292. package/docs/api/interfaces/AccountIdentityRotation.md +0 -69
  293. package/docs/api/interfaces/AttachmentTransferOptions.md +0 -49
  294. package/docs/api/interfaces/BlockedRecipientEntry.md +0 -25
  295. package/docs/api/interfaces/BlockedRecipientsSyncInput.md +0 -27
  296. package/docs/api/interfaces/ConfigurationSyncInput.md +0 -19
  297. package/docs/api/interfaces/CredentialPublicKey.md +0 -25
  298. package/docs/api/interfaces/DataMessageInput.md +0 -21
  299. package/docs/api/interfaces/DecryptedEnvelope.md +0 -95
  300. package/docs/api/interfaces/DecryptedGroup.md +0 -86
  301. package/docs/api/interfaces/DeviceInfo.md +0 -79
  302. package/docs/api/interfaces/DeviceRecord.md +0 -87
  303. package/docs/api/interfaces/DeviceRegistration.md +0 -27
  304. package/docs/api/interfaces/DoubleRatchetConfig.md +0 -36
  305. package/docs/api/interfaces/EcOneTimePreKey.md +0 -27
  306. package/docs/api/interfaces/EcSignedPreKey.md +0 -39
  307. package/docs/api/interfaces/EcSignedPreKeyUpload.md +0 -50
  308. package/docs/api/interfaces/EncryptionErrorContext.md +0 -51
  309. package/docs/api/interfaces/Envelope.md +0 -154
  310. package/docs/api/interfaces/ForceKeyResetResult.md +0 -37
  311. package/docs/api/interfaces/GroupAuthorization.md +0 -23
  312. package/docs/api/interfaces/GroupChangeEntry.md +0 -42
  313. package/docs/api/interfaces/GroupMemberDevice.md +0 -26
  314. package/docs/api/interfaces/GroupTrustRoot.md +0 -33
  315. package/docs/api/interfaces/IEcOneTimePreKeyStore.md +0 -86
  316. package/docs/api/interfaces/IEcSignedPreKeyStore.md +0 -133
  317. package/docs/api/interfaces/IGroupServer.md +0 -120
  318. package/docs/api/interfaces/IGroupStateStore.md +0 -128
  319. package/docs/api/interfaces/IIdentityKeyStore.md +0 -312
  320. package/docs/api/interfaces/IKemPreKeyStore.md +0 -144
  321. package/docs/api/interfaces/IKyberLastResortPreKeyStore.md +0 -112
  322. package/docs/api/interfaces/ILogger.md +0 -117
  323. package/docs/api/interfaces/IProtocolStore.md +0 -1033
  324. package/docs/api/interfaces/IRelayGroupServer.md +0 -60
  325. package/docs/api/interfaces/ISenderKeyStore.md +0 -417
  326. package/docs/api/interfaces/ISesameStore.md +0 -249
  327. package/docs/api/interfaces/ISessionStore.md +0 -178
  328. package/docs/api/interfaces/ISignalProtocolClient.md +0 -1185
  329. package/docs/api/interfaces/ISignalProtocolLocalSecretVault.md +0 -71
  330. package/docs/api/interfaces/ISignalProtocolLocalStore.md +0 -2053
  331. package/docs/api/interfaces/ISignalProtocolManager.md +0 -272
  332. package/docs/api/interfaces/ISignalProtocolRelayServer.md +0 -1337
  333. package/docs/api/interfaces/IdentityKeyPair.md +0 -49
  334. package/docs/api/interfaces/IncomingEnvelope.md +0 -91
  335. package/docs/api/interfaces/InspectedSignalProtocolContent.md +0 -43
  336. package/docs/api/interfaces/KDFChain.md +0 -31
  337. package/docs/api/interfaces/KemLastResortPreKeyUpload.md +0 -50
  338. package/docs/api/interfaces/KeyPair.md +0 -23
  339. package/docs/api/interfaces/KyberPreKey.md +0 -42
  340. package/docs/api/interfaces/MLKEMBraidAgentState.md +0 -191
  341. package/docs/api/interfaces/MLKEMBraidMessage.md +0 -49
  342. package/docs/api/interfaces/MediaAttachmentDeleteSyncInput.md +0 -31
  343. package/docs/api/interfaces/MessageHeader.md +0 -49
  344. package/docs/api/interfaces/MessageRecord.md +0 -86
  345. package/docs/api/interfaces/ParsedReceiptContent.md +0 -19
  346. package/docs/api/interfaces/ParsedTypingContent.md +0 -19
  347. package/docs/api/interfaces/PreKeyMaintenanceStore.md +0 -88
  348. package/docs/api/interfaces/PreKeyMessage.md +0 -159
  349. package/docs/api/interfaces/PreKeyStatusResult.md +0 -21
  350. package/docs/api/interfaces/PreKeyUpload.md +0 -42
  351. package/docs/api/interfaces/ProcessEnvelopeOptions.md +0 -72
  352. package/docs/api/interfaces/ProtocolAddress.md +0 -38
  353. package/docs/api/interfaces/ProtocolStrategyConfig.md +0 -91
  354. package/docs/api/interfaces/RatchetMessage.md +0 -96
  355. package/docs/api/interfaces/ReadSyncEntryInput.md +0 -19
  356. package/docs/api/interfaces/ReceiverChain.md +0 -43
  357. package/docs/api/interfaces/RecipientUsernameSyncInput.md +0 -31
  358. package/docs/api/interfaces/RelayPreKeyBundle.md +0 -254
  359. package/docs/api/interfaces/RemoteObjectDownload.md +0 -33
  360. package/docs/api/interfaces/RemoteObjectUpload.md +0 -49
  361. package/docs/api/interfaces/ResolvedSPQRInfoStrings.md +0 -27
  362. package/docs/api/interfaces/ResolvedSPQRLimits.md +0 -37
  363. package/docs/api/interfaces/RetryRequest.md +0 -80
  364. package/docs/api/interfaces/SCKAState.md +0 -65
  365. package/docs/api/interfaces/SPQRLimits.md +0 -40
  366. package/docs/api/interfaces/SPQRState.md +0 -191
  367. package/docs/api/interfaces/SafetyNumber.md +0 -60
  368. package/docs/api/interfaces/SafetyNumberConfirmation.md +0 -46
  369. package/docs/api/interfaces/SealedSenderConfig.md +0 -70
  370. package/docs/api/interfaces/SendOptions.md +0 -191
  371. package/docs/api/interfaces/SendResult.md +0 -93
  372. package/docs/api/interfaces/SenderKeyDistributionMessage.md +0 -43
  373. package/docs/api/interfaces/SenderKeyState.md +0 -76
  374. package/docs/api/interfaces/SenderKeysConfig.md +0 -65
  375. package/docs/api/interfaces/SentSyncTranscriptInput.md +0 -31
  376. package/docs/api/interfaces/ServiceId.md +0 -19
  377. package/docs/api/interfaces/SesameMessage.md +0 -84
  378. package/docs/api/interfaces/SesameStats.md +0 -57
  379. package/docs/api/interfaces/SessionHealthResult.md +0 -120
  380. package/docs/api/interfaces/SessionRecord.md +0 -80
  381. package/docs/api/interfaces/SessionRecordMetadata.md +0 -109
  382. package/docs/api/interfaces/SessionState.md +0 -368
  383. package/docs/api/interfaces/SessionTrustCommit.md +0 -58
  384. package/docs/api/interfaces/SignalProtocolBlockingHooks.md +0 -44
  385. package/docs/api/interfaces/SignalProtocolBlockingManagerOptions.md +0 -31
  386. package/docs/api/interfaces/SignalProtocolBlockingMirror.md +0 -30
  387. package/docs/api/interfaces/SignalProtocolBlockingStore.md +0 -83
  388. package/docs/api/interfaces/SignalProtocolClientAdapterConfig.md +0 -44
  389. package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +0 -731
  390. package/docs/api/interfaces/SignalProtocolClientConfig.md +0 -895
  391. package/docs/api/interfaces/SignalProtocolClientDeleteLocalAttachmentInput.md +0 -25
  392. package/docs/api/interfaces/SignalProtocolClientHooks.md +0 -506
  393. package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +0 -51
  394. package/docs/api/interfaces/SignalProtocolClientLoadLocalAttachmentInput.md +0 -187
  395. package/docs/api/interfaces/SignalProtocolClientLoadedLocalAttachment.md +0 -19
  396. package/docs/api/interfaces/SignalProtocolClientMedia.md +0 -83
  397. package/docs/api/interfaces/SignalProtocolClientMediaCompletedResult.md +0 -25
  398. package/docs/api/interfaces/SignalProtocolClientMediaConfig.md +0 -157
  399. package/docs/api/interfaces/SignalProtocolClientMediaDownloadCompletedResult.md +0 -37
  400. package/docs/api/interfaces/SignalProtocolClientMediaDownloadNotNeededResult.md +0 -25
  401. package/docs/api/interfaces/SignalProtocolClientMediaFailedResult.md +0 -19
  402. package/docs/api/interfaces/SignalProtocolClientMediaOperationOptions.md +0 -53
  403. package/docs/api/interfaces/SignalProtocolClientMediaPendingResult.md +0 -19
  404. package/docs/api/interfaces/SignalProtocolClientMediaProcessResult.md +0 -43
  405. package/docs/api/interfaces/SignalProtocolClientMediaSkippedResult.md +0 -25
  406. package/docs/api/interfaces/SignalProtocolClientMediaUploadCompletedResult.md +0 -31
  407. package/docs/api/interfaces/SignalProtocolClientProcessPendingMediaOptions.md +0 -87
  408. package/docs/api/interfaces/SignalProtocolClientSaveDownloadedAttachmentInput.md +0 -25
  409. package/docs/api/interfaces/SignalProtocolClientSaveUploadedAttachmentInput.md +0 -25
  410. package/docs/api/interfaces/SignalProtocolClientSyncDeleteInput.md +0 -19
  411. package/docs/api/interfaces/SignalProtocolConfig.md +0 -50
  412. package/docs/api/interfaces/SignalProtocolContentAdapter.md +0 -325
  413. package/docs/api/interfaces/SignalProtocolRemoteObjectStore.md +0 -88
  414. package/docs/api/interfaces/SkippedSenderMessageKey.md +0 -26
  415. package/docs/api/interfaces/TaskNotificationAckSyncInput.md +0 -31
  416. package/docs/api/interfaces/TripleRatchetState.md +0 -64
  417. package/docs/api/interfaces/UserRecord.md +0 -71
  418. package/docs/api/interfaces/UsernameStateSyncInput.md +0 -19
  419. package/docs/api/interfaces/VerificationStateSyncInput.md +0 -31
  420. package/docs/api/interfaces/VersionNegotiationState.md +0 -84
  421. package/docs/api/interfaces/ViewOnceOpenSyncInput.md +0 -19
  422. package/docs/api/namespaces/ProtocolAddress/README.md +0 -33
  423. package/docs/api/namespaces/ProtocolAddress/functions/create.md +0 -41
  424. package/docs/api/namespaces/ProtocolAddress/functions/equals.md +0 -39
  425. package/docs/api/namespaces/ProtocolAddress/functions/fromStorageKey.md +0 -36
  426. package/docs/api/namespaces/ProtocolAddress/functions/isUser.md +0 -39
  427. package/docs/api/namespaces/ProtocolAddress/functions/isValid.md +0 -34
  428. package/docs/api/namespaces/ProtocolAddress/functions/parse.md +0 -41
  429. package/docs/api/namespaces/ProtocolAddress/functions/toStorageKey.md +0 -38
  430. package/docs/api/namespaces/ProtocolAddress/functions/toString.md +0 -34
  431. package/docs/api/namespaces/SessionRecord/README.md +0 -30
  432. package/docs/api/namespaces/SessionRecord/functions/archiveCurrent.md +0 -40
  433. package/docs/api/namespaces/SessionRecord/functions/archiveCurrentState.md +0 -34
  434. package/docs/api/namespaces/SessionRecord/functions/create.md +0 -25
  435. package/docs/api/namespaces/SessionRecord/functions/deserialize.md +0 -29
  436. package/docs/api/namespaces/SessionRecord/functions/findSession.md +0 -34
  437. package/docs/api/namespaces/SessionRecord/functions/getAllSessions.md +0 -25
  438. package/docs/api/namespaces/SessionRecord/functions/getArchivedCount.md +0 -25
  439. package/docs/api/namespaces/SessionRecord/functions/hasCurrentSession.md +0 -25
  440. package/docs/api/namespaces/SessionRecord/functions/hasUsableSenderChain.md +0 -36
  441. package/docs/api/namespaces/SessionRecord/functions/promoteSession.md +0 -34
  442. package/docs/api/namespaces/SessionRecord/functions/serialize.md +0 -28
  443. package/docs/api/namespaces/SessionRecord/variables/MAX_ARCHIVED_SESSIONS.md +0 -14
  444. package/docs/api/namespaces/SessionState/README.md +0 -15
  445. package/docs/api/namespaces/SessionState/functions/getSessionId.md +0 -32
  446. package/docs/api/namespaces/blocking/README.md +0 -43
  447. package/docs/api/namespaces/encoding/README.md +0 -33
  448. package/docs/api/namespaces/encoding/functions/base64ToUrlSafe.md +0 -28
  449. package/docs/api/namespaces/encoding/functions/bytesToBase64.md +0 -21
  450. package/docs/api/namespaces/encoding/functions/bytesToString.md +0 -21
  451. package/docs/api/namespaces/encoding/functions/bytesToUrlSafeBase64.md +0 -33
  452. package/docs/api/namespaces/encoding/functions/concatBytes.md +0 -21
  453. package/docs/api/namespaces/encoding/functions/stringToBytes.md +0 -21
  454. package/docs/api/namespaces/encoding/functions/urlSafeToBase64.md +0 -27
  455. package/docs/api/namespaces/keys/README.md +0 -130
  456. package/docs/api/namespaces/keys/functions/acceptContactIdentityRotation.md +0 -33
  457. package/docs/api/namespaces/keys/functions/assertIdentityCommitment.md +0 -25
  458. package/docs/api/namespaces/keys/functions/canonicalizeDeviceIdentityKey.md +0 -30
  459. package/docs/api/namespaces/keys/functions/compareDeviceIdentityKeys.md +0 -28
  460. package/docs/api/namespaces/keys/functions/compositeIdentitiesEqual.md +0 -23
  461. package/docs/api/namespaces/keys/functions/createCompositeIdentityV1.md +0 -19
  462. package/docs/api/namespaces/keys/functions/createPreKeySignatureContext.md +0 -31
  463. package/docs/api/namespaces/keys/functions/createUnverifiedContactIdentityRecord.md +0 -23
  464. package/docs/api/namespaces/keys/functions/decodeCompositeIdentityV1.md +0 -19
  465. package/docs/api/namespaces/keys/functions/deriveIdentityCommitment.md +0 -19
  466. package/docs/api/namespaces/keys/functions/encodeCompositeIdentityV1.md +0 -19
  467. package/docs/api/namespaces/keys/functions/evaluateContactIdentityCandidate.md +0 -27
  468. package/docs/api/namespaces/keys/functions/generateEcOneTimePreKeys.md +0 -37
  469. package/docs/api/namespaces/keys/functions/generateEcSignedPreKey.md +0 -39
  470. package/docs/api/namespaces/keys/functions/generateEcSignedPreKeyId.md +0 -21
  471. package/docs/api/namespaces/keys/functions/generateIdentityKeyPair.md +0 -24
  472. package/docs/api/namespaces/keys/functions/generateKemOneTimePreKeys.md +0 -47
  473. package/docs/api/namespaces/keys/functions/generateKyberLastResortPreKey.md +0 -37
  474. package/docs/api/namespaces/keys/functions/generateRegistrationId.md +0 -13
  475. package/docs/api/namespaces/keys/functions/isValidDeviceIdentityKey.md +0 -22
  476. package/docs/api/namespaces/keys/functions/signMlKem1024PreKey.md +0 -29
  477. package/docs/api/namespaces/keys/functions/signPreKey.md +0 -31
  478. package/docs/api/namespaces/keys/functions/validateContactIdentityRecord.md +0 -19
  479. package/docs/api/namespaces/keys/functions/verifyContactIdentityRecord.md +0 -31
  480. package/docs/api/namespaces/keys/functions/verifyMlKem1024PreKey.md +0 -33
  481. package/docs/api/namespaces/keys/functions/verifyPreKeySignature.md +0 -35
  482. package/docs/api/namespaces/keys/interfaces/CompositeIdentityV1.md +0 -33
  483. package/docs/api/namespaces/keys/interfaces/ContactIdentityRecord.md +0 -53
  484. package/docs/api/namespaces/keys/interfaces/KemOneTimePreKey.md +0 -43
  485. package/docs/api/namespaces/keys/type-aliases/IdentityCandidateStatus.md +0 -9
  486. package/docs/api/namespaces/keys/type-aliases/IdentityTrustState.md +0 -9
  487. package/docs/api/namespaces/keys/type-aliases/IdentityType.md +0 -9
  488. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_ED25519_TAG.md +0 -9
  489. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_LENGTH.md +0 -9
  490. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_VERSION.md +0 -9
  491. package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_X25519_TAG.md +0 -9
  492. package/docs/api/namespaces/keys/variables/IDENTITY_COMMITMENT_V1_DOMAIN.md +0 -9
  493. package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_ML_KEM_1024.md +0 -9
  494. package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_X25519.md +0 -9
  495. package/docs/api/namespaces/keys/variables/PREKEY_SIGNATURE_V1_DOMAIN.md +0 -9
  496. package/docs/api/namespaces/keys/variables/UNPINNED_DEVICE_IDENTITY_KEY.md +0 -18
  497. package/docs/api/namespaces/media/README.md +0 -105
  498. package/docs/api/namespaces/media/classes/MediaAttachmentError.md +0 -57
  499. package/docs/api/namespaces/media/functions/createByteRangeMediaAttachmentTransfer.md +0 -19
  500. package/docs/api/namespaces/media/functions/createMediaAttachmentDeliveryId.md +0 -29
  501. package/docs/api/namespaces/media/functions/createMediaAttachmentId.md +0 -19
  502. package/docs/api/namespaces/media/functions/createMediaAttachmentMessage.md +0 -25
  503. package/docs/api/namespaces/media/functions/createMediaAttachmentPointer.md +0 -19
  504. package/docs/api/namespaces/media/functions/createTusMediaAttachmentTransfer.md +0 -19
  505. package/docs/api/namespaces/media/functions/deleteMediaAttachment.md +0 -23
  506. package/docs/api/namespaces/media/functions/executeMediaAttachmentJob.md +0 -23
  507. package/docs/api/namespaces/media/functions/isMediaAttachmentFlagSet.md +0 -19
  508. package/docs/api/namespaces/media/functions/parseMediaAttachmentMessage.md +0 -19
  509. package/docs/api/namespaces/media/functions/planMediaAttachmentCleanup.md +0 -23
  510. package/docs/api/namespaces/media/functions/planMediaAttachmentCleanupJobs.md +0 -19
  511. package/docs/api/namespaces/media/functions/planMediaAttachmentDeleteSync.md +0 -19
  512. package/docs/api/namespaces/media/functions/planMediaAttachmentDownloadJob.md +0 -19
  513. package/docs/api/namespaces/media/functions/planMediaAttachmentOpen.md +0 -19
  514. package/docs/api/namespaces/media/functions/planMediaAttachmentProcessing.md +0 -19
  515. package/docs/api/namespaces/media/functions/planMediaAttachmentUploadJob.md +0 -19
  516. package/docs/api/namespaces/media/functions/prepareMediaAttachmentUpload.md +0 -30
  517. package/docs/api/namespaces/media/functions/resolveMediaAttachment.md +0 -30
  518. package/docs/api/namespaces/media/functions/serializeMediaAttachmentMessage.md +0 -25
  519. package/docs/api/namespaces/media/functions/validateMediaAttachmentPolicy.md +0 -23
  520. package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentPartialStore.md +0 -68
  521. package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentTransferOptions.md +0 -91
  522. package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentOptions.md +0 -25
  523. package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentResult.md +0 -19
  524. package/docs/api/namespaces/media/interfaces/ExecuteMediaAttachmentJobOptions.md +0 -157
  525. package/docs/api/namespaces/media/interfaces/MediaAttachmentBackgroundJob.md +0 -85
  526. package/docs/api/namespaces/media/interfaces/MediaAttachmentCleanupPlan.md +0 -37
  527. package/docs/api/namespaces/media/interfaces/MediaAttachmentJobExecutionResult.md +0 -55
  528. package/docs/api/namespaces/media/interfaces/MediaAttachmentMessage.md +0 -31
  529. package/docs/api/namespaces/media/interfaces/MediaAttachmentOpenDecision.md +0 -31
  530. package/docs/api/namespaces/media/interfaces/MediaAttachmentPointer.md +0 -133
  531. package/docs/api/namespaces/media/interfaces/MediaAttachmentPolicy.md +0 -67
  532. package/docs/api/namespaces/media/interfaces/MediaAttachmentProcessingPlan.md +0 -73
  533. package/docs/api/namespaces/media/interfaces/MediaAttachmentProgress.md +0 -69
  534. package/docs/api/namespaces/media/interfaces/MediaAttachmentResumeState.md +0 -37
  535. package/docs/api/namespaces/media/interfaces/MediaAttachmentRetryOptions.md +0 -31
  536. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransfer.md +0 -51
  537. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferCheckpoint.md +0 -69
  538. package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferOptions.md +0 -67
  539. package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadJobData.md +0 -19
  540. package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadResponse.md +0 -25
  541. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentCleanupJobsInput.md +0 -61
  542. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDeleteSyncInput.md +0 -25
  543. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDownloadJobInput.md +0 -161
  544. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentOpenInput.md +0 -25
  545. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentProcessingInput.md +0 -83
  546. package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentUploadJobInput.md +0 -147
  547. package/docs/api/namespaces/media/interfaces/PrepareMediaAttachmentUploadOptions.md +0 -144
  548. package/docs/api/namespaces/media/interfaces/ResolveMediaAttachmentOptions.md +0 -55
  549. package/docs/api/namespaces/media/interfaces/ResolvedMediaAttachment.md +0 -109
  550. package/docs/api/namespaces/media/interfaces/TusMediaAttachmentTransferOptions.md +0 -85
  551. package/docs/api/namespaces/media/type-aliases/CreateMediaAttachmentPointerInput.md +0 -15
  552. package/docs/api/namespaces/media/type-aliases/MediaAttachmentCheckpointCallback.md +0 -19
  553. package/docs/api/namespaces/media/type-aliases/MediaAttachmentCleanupReason.md +0 -9
  554. package/docs/api/namespaces/media/type-aliases/MediaAttachmentErrorCode.md +0 -9
  555. package/docs/api/namespaces/media/type-aliases/MediaAttachmentFlag.md +0 -9
  556. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobExecutionStatus.md +0 -9
  557. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobOperation.md +0 -9
  558. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobPriority.md +0 -9
  559. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSkipReason.md +0 -9
  560. package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSource.md +0 -9
  561. package/docs/api/namespaces/media/type-aliases/MediaAttachmentKnownIds.md +0 -9
  562. package/docs/api/namespaces/media/type-aliases/MediaAttachmentMessageType.md +0 -9
  563. package/docs/api/namespaces/media/type-aliases/MediaAttachmentProgressCallback.md +0 -19
  564. package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_DEFAULTS.md +0 -47
  565. package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_PRESETS.md +0 -95
  566. package/docs/api/namespaces/media/variables/MediaAttachmentCleanupReason.md +0 -27
  567. package/docs/api/namespaces/media/variables/MediaAttachmentErrorCode.md +0 -75
  568. package/docs/api/namespaces/media/variables/MediaAttachmentFlag.md +0 -23
  569. package/docs/api/namespaces/media/variables/MediaAttachmentJobExecutionStatus.md +0 -19
  570. package/docs/api/namespaces/media/variables/MediaAttachmentJobOperation.md +0 -31
  571. package/docs/api/namespaces/media/variables/MediaAttachmentJobPriority.md +0 -23
  572. package/docs/api/namespaces/media/variables/MediaAttachmentJobSource.md +0 -51
  573. package/docs/api/namespaces/media/variables/MediaAttachmentMessageType.md +0 -15
  574. package/docs/api/namespaces/media/variables/downloadMediaAttachment.md +0 -30
  575. package/docs/api/namespaces/safety/README.md +0 -61
  576. package/docs/api/namespaces/safety/classes/DisplayableFingerprint.md +0 -108
  577. package/docs/api/namespaces/safety/classes/Fingerprint.md +0 -104
  578. package/docs/api/namespaces/safety/classes/ScannableFingerprint.md +0 -209
  579. package/docs/api/namespaces/safety/functions/base64ToBytes.md +0 -21
  580. package/docs/api/namespaces/safety/functions/clearFingerprintCache.md +0 -15
  581. package/docs/api/namespaces/safety/functions/compareSafetyNumbers.md +0 -25
  582. package/docs/api/namespaces/safety/functions/createFingerprintData.md +0 -60
  583. package/docs/api/namespaces/safety/functions/extractQrData.md +0 -34
  584. package/docs/api/namespaces/safety/functions/generateCompositeSafetyNumber.md +0 -39
  585. package/docs/api/namespaces/safety/functions/generateEmojiFingerprint.md +0 -24
  586. package/docs/api/namespaces/safety/functions/generateSingleKeyReferenceSafetyNumber.md +0 -51
  587. package/docs/api/namespaces/safety/functions/generateVerifySchemeUrl.md +0 -32
  588. package/docs/api/namespaces/safety/functions/generateVerifyUrl.md +0 -49
  589. package/docs/api/namespaces/safety/functions/isValidSafetyNumber.md +0 -21
  590. package/docs/api/namespaces/safety/functions/isVerifyUrl.md +0 -45
  591. package/docs/api/namespaces/safety/functions/parseVerifyUrl.md +0 -31
  592. package/docs/api/namespaces/safety/interfaces/FingerprintData.md +0 -52
  593. package/docs/api/namespaces/safety/interfaces/SafetyNumber.md +0 -49
  594. package/docs/api/namespaces/safety/interfaces/VerifyLinkConfig.md +0 -28
  595. package/docs/api/namespaces/safety/interfaces/VerifyUrlParams.md +0 -49
  596. package/docs/api/namespaces/safety/type-aliases/CompareResult.md +0 -21
  597. package/docs/api/namespaces/safety/variables/DEFAULT_VERIFY_LINK_CONFIG.md +0 -12
  598. package/docs/api/namespaces/safety/variables/FINGERPRINT_ITERATIONS.md +0 -12
  599. package/docs/api/namespaces/safety/variables/FINGERPRINT_VERSION.md +0 -12
  600. package/docs/api/namespaces/safety/variables/VERIFY_BASE_URL.md +0 -11
  601. package/docs/api/namespaces/safety/variables/VERIFY_SCHEME_URL.md +0 -11
  602. package/docs/api/type-aliases/Base64.md +0 -20
  603. package/docs/api/type-aliases/BraidPolicy.md +0 -11
  604. package/docs/api/type-aliases/Bytes.md +0 -20
  605. package/docs/api/type-aliases/Ciphertext.md +0 -21
  606. package/docs/api/type-aliases/DeviceType.md +0 -11
  607. package/docs/api/type-aliases/DownloadedAttachment.md +0 -11
  608. package/docs/api/type-aliases/GroupId.md +0 -27
  609. package/docs/api/type-aliases/Hex.md +0 -20
  610. package/docs/api/type-aliases/HookName.md +0 -11
  611. package/docs/api/type-aliases/PostQuantumPolicy.md +0 -11
  612. package/docs/api/type-aliases/PreparedAttachmentUpload.md +0 -14
  613. package/docs/api/type-aliases/PrivateKey.md +0 -22
  614. package/docs/api/type-aliases/ProgressCallback.md +0 -45
  615. package/docs/api/type-aliases/PublicKey.md +0 -22
  616. package/docs/api/type-aliases/RemoteObjectCompleteUploadRequest.md +0 -19
  617. package/docs/api/type-aliases/RemoteObjectDeleteRequest.md +0 -19
  618. package/docs/api/type-aliases/RemoteObjectDownloadRequest.md +0 -19
  619. package/docs/api/type-aliases/RemoteObjectUploadRequest.md +0 -42
  620. package/docs/api/type-aliases/SCKAMode.md +0 -11
  621. package/docs/api/type-aliases/SealedSenderAuth.md +0 -15
  622. package/docs/api/type-aliases/SignalProtocolClientMediaCleanupInput.md +0 -9
  623. package/docs/api/type-aliases/SignalProtocolClientMediaCleanupResult.md +0 -9
  624. package/docs/api/type-aliases/SignalProtocolClientMediaDownloadInput.md +0 -9
  625. package/docs/api/type-aliases/SignalProtocolClientMediaDownloadResult.md +0 -9
  626. package/docs/api/type-aliases/SignalProtocolClientMediaOperationResult.md +0 -9
  627. package/docs/api/type-aliases/SignalProtocolClientMediaUploadInput.md +0 -9
  628. package/docs/api/type-aliases/SignalProtocolClientMediaUploadResult.md +0 -9
  629. package/docs/api/type-aliases/Signature.md +0 -21
  630. package/docs/api/type-aliases/Unsubscribe.md +0 -15
  631. package/docs/api/variables/BraidPolicy.md +0 -21
  632. package/docs/api/variables/DEFAULT_DEVICE_ID.md +0 -12
  633. package/docs/api/variables/DOUBLE_RATCHET_SPEC.md +0 -11
  634. package/docs/api/variables/GROUP_ID_PREFIX.md +0 -11
  635. package/docs/api/variables/GROUP_TRUST_ROOT_VERSION.md +0 -11
  636. package/docs/api/variables/KEY_REFRESH_INTERVAL_MS_DEFAULT.md +0 -11
  637. package/docs/api/variables/MAX_MESSAGE_KEYS.md +0 -14
  638. package/docs/api/variables/MAX_PREKEY_AGE_MS_DEFAULT.md +0 -11
  639. package/docs/api/variables/MAX_RECEIVER_CHAINS.md +0 -14
  640. package/docs/api/variables/MAX_REGISTRATION_ID.md +0 -16
  641. package/docs/api/variables/MAX_SKIP.md +0 -11
  642. package/docs/api/variables/MESSAGE_FORMAT.md +0 -11
  643. package/docs/api/variables/MIN_REGISTRATION_ID.md +0 -16
  644. package/docs/api/variables/ML_KEM_BRAID_SPEC.md +0 -11
  645. package/docs/api/variables/ONE_TIME_PREKEY_BATCH_SIZE.md +0 -21
  646. package/docs/api/variables/PQXDH_SPEC.md +0 -11
  647. package/docs/api/variables/PostQuantumPolicy.md +0 -21
  648. package/docs/api/variables/SENDER_KEY_FORMAT.md +0 -11
  649. package/docs/api/variables/SENDER_KEY_SPEC.md +0 -11
  650. package/docs/api/variables/SESAME_SPEC.md +0 -11
  651. package/docs/api/variables/SESSION_FORMAT.md +0 -11
  652. package/docs/api/variables/SPQR_LIMITS_DEFAULTS.md +0 -11
  653. package/docs/api/variables/X3DH_SPEC.md +0 -9
  654. package/docs/api/variables/defaultSignalProtocolLogger.md +0 -32
  655. package/remote/relay/convex/server/README.md +0 -146
@@ -1,65 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / SCKAState
6
-
7
- # Interface: SCKAState
8
-
9
- ML-KEM Braid state for continuous key agreement.
10
-
11
- Signal Protocol Section 5 (ML-KEM Braid):
12
- The ML-KEM Braid provides continuous post-quantum key agreement by
13
- maintaining alternating send/receive Kyber key pairs across epochs.
14
-
15
- Intended properties are conditional on authenticated establishment, correct
16
- state handling, uncompromised refresh entropy, and the underlying primitive
17
- assumptions. See docs/SECURITY.md.
18
-
19
- ## Properties
20
-
21
- ### direction
22
-
23
- > **direction**: `"A2B"` \| `"B2A"`
24
-
25
- Direction of communication ('A2B' = Alice to Bob, 'B2A' = Bob to Alice)
26
-
27
- ***
28
-
29
- ### epoch
30
-
31
- > **epoch**: `number`
32
-
33
- Current epoch number (increments with each DH ratchet)
34
-
35
- ***
36
-
37
- ### lastRefreshMessageCount
38
-
39
- > **lastRefreshMessageCount**: `number`
40
-
41
- Message counter at last Kyber refresh (for message-count-based rotation)
42
-
43
- ***
44
-
45
- ### lastRefreshTimestamp
46
-
47
- > **lastRefreshTimestamp**: `number`
48
-
49
- Timestamp of last Kyber key refresh (for time-based rotation)
50
-
51
- ***
52
-
53
- ### ourKyberPrivateKey
54
-
55
- > **ourKyberPrivateKey**: [`Base64`](../type-aliases/Base64.md) \| `null`
56
-
57
- Our current Kyber private key (for receiving)
58
-
59
- ***
60
-
61
- ### theirKyberPublicKey
62
-
63
- > **theirKyberPublicKey**: [`Base64`](../type-aliases/Base64.md) \| `null`
64
-
65
- Remote party's current Kyber public key (for sending)
@@ -1,40 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / SPQRLimits
6
-
7
- # Interface: SPQRLimits
8
-
9
- SPQR security and performance limits.
10
-
11
- Defaults bound a forward jump to 25,000 and retained out-of-order keys to
12
- 2,000.
13
-
14
- ## Properties
15
-
16
- ### maxMessageJump?
17
-
18
- > `optional` **maxMessageJump?**: `number`
19
-
20
- Maximum forward jump in message numbers.
21
-
22
- #### Default
23
-
24
- ```ts
25
- 25000
26
- ```
27
-
28
- ***
29
-
30
- ### maxOutOfOrderKeys?
31
-
32
- > `optional` **maxOutOfOrderKeys?**: `number`
33
-
34
- Maximum out-of-order keys to store.
35
-
36
- #### Default
37
-
38
- ```ts
39
- 2000
40
- ```
@@ -1,191 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / SPQRState
6
-
7
- # Interface: SPQRState
8
-
9
- Sparse Post-Quantum Ratchet state (Section 5).
10
-
11
- Signal Protocol Section 5:
12
- "The sparse post-quantum ratchet provides ~90% post-quantum protection
13
- by periodically refreshing Kyber keys (not every message)."
14
-
15
- When combined with the EC Double Ratchet, this state supplies the profile's
16
- post-quantum contribution to hybrid message-key derivation.
17
-
18
- State Structure:
19
- - Root Key (RK): Derives new KDF chain keys when epoch changes
20
- - Epoch: Current epoch number (increments with DH ratchet)
21
- - KDF Chains: Per-epoch chains for deriving message keys
22
- - MKSKIPPED: Skipped message keys for out-of-order delivery
23
- - Direction: Communication direction (A2B or B2A)
24
- - SCKA State: ML-KEM Braid state for continuous key agreement
25
-
26
- ## Properties
27
-
28
- ### braidState?
29
-
30
- > `optional` **braidState?**: [`MLKEMBraidAgentState`](MLKEMBraidAgentState.md)
31
-
32
- ML-KEM Braid agent state.
33
-
34
- Only present when mode is `braid`.
35
-
36
- ***
37
-
38
- ### direction
39
-
40
- > **direction**: `"A2B"` \| `"B2A"`
41
-
42
- Communication direction
43
-
44
- ***
45
-
46
- ### epoch
47
-
48
- > **epoch**: `number`
49
-
50
- Current epoch number (synchronized with DH ratchet)
51
-
52
- ***
53
-
54
- ### infoStrings?
55
-
56
- > `optional` **infoStrings?**: [`ResolvedSPQRInfoStrings`](ResolvedSPQRInfoStrings.md)
57
-
58
- Resolved HKDF info strings for SPQR key derivation.
59
-
60
- ***
61
-
62
- ### kdfChains
63
-
64
- > **kdfChains**: `Record`\<`number`, \{ `receive`: [`KDFChain`](KDFChain.md); `send`: [`KDFChain`](KDFChain.md); \}\>
65
-
66
- KDF chains per epoch.
67
-
68
- Map structure: epoch -> { send: KDFChain, receive: KDFChain }
69
-
70
- Each epoch has two chains:
71
- - send: For encrypting outgoing messages
72
- - receive: For decrypting incoming messages
73
-
74
- Note: Using Record instead of Map for JSON serialization compatibility.
75
- Convert to/from Map in memory for better performance if needed.
76
-
77
- ***
78
-
79
- ### limits?
80
-
81
- > `optional` **limits?**: [`ResolvedSPQRLimits`](ResolvedSPQRLimits.md)
82
-
83
- Resolved security limits for SPQR DoS and skipped-key handling.
84
-
85
- ***
86
-
87
- ### MKSKIPPED
88
-
89
- > **MKSKIPPED**: `Record`\<`string`, \{ `key`: [`Base64`](../type-aliases/Base64.md); `timestamp`: `number`; \}\>
90
-
91
- Skipped message keys for out-of-order delivery.
92
-
93
- Map structure: epoch -> (index -> messageKey)
94
-
95
- Signal Protocol Section 4.6:
96
- "Messages may arrive out of order. Store skipped message keys
97
- to decrypt them later."
98
-
99
- Signal Protocol Section 8.4:
100
- "A recommended policy is to delete message keys more than one week old"
101
-
102
- Note: Using Record for JSON serialization. Keys are stored as strings
103
- in format "epoch:index" -> { key: Base64, timestamp: number }
104
-
105
- ***
106
-
107
- ### mode
108
-
109
- > **mode**: [`SCKAMode`](../type-aliases/SCKAMode.md)
110
-
111
- SCKA mode used for this session.
112
-
113
- - `'braid'` (default): specification-defined ML-KEM Braid profile
114
- - `'direct'`: Explicit direct ML-KEM-768 encapsulation mode
115
-
116
- Once set during session establishment, the mode is fixed for the
117
- lifetime of the session to ensure protocol consistency.
118
-
119
- #### Default
120
-
121
- ```ts
122
- 'braid'
123
- ```
124
-
125
- ***
126
-
127
- ### needsSendRatchet?
128
-
129
- > `optional` **needsSendRatchet?**: `boolean`
130
-
131
- Flag: next spqrSend() should do full KEM ratchet.
132
-
133
- Set to true by spqrRecv() after decapsulating kyber ciphertext,
134
- and during bootstrap. Cleared by spqrSend() after performing the
135
- encapsulation/keypair generation.
136
-
137
- `send()` decides whether to perform a KEM exchange from this state; callers
138
- do not trigger the exchange separately.
139
-
140
- ***
141
-
142
- ### pendingOutgoingChunks?
143
-
144
- > `optional` **pendingOutgoingChunks?**: [`MLKEMBraidMessage`](MLKEMBraidMessage.md)[]
145
-
146
- Pending outgoing Braid chunks.
147
-
148
- Only present when mode is `braid` and the state machine has queued chunks
149
- for future message headers.
150
-
151
- ***
152
-
153
- ### RK
154
-
155
- > **RK**: [`Base64`](../type-aliases/Base64.md)
156
-
157
- Root Key for deriving new KDF chain keys
158
-
159
- ***
160
-
161
- ### sckaState
162
-
163
- > **sckaState**: [`SCKAState`](SCKAState.md)
164
-
165
- ML-KEM Braid state for continuous key agreement
166
-
167
- ***
168
-
169
- ### sendEpoch?
170
-
171
- > `optional` **sendEpoch?**: `number`
172
-
173
- Latest epoch used for sending.
174
-
175
- Tracks send-epoch cleanup for SPQR forward secrecy while retaining receive
176
- chains needed for in-flight messages.
177
-
178
- ***
179
-
180
- ### versionNegotiation?
181
-
182
- > `optional` **versionNegotiation?**: [`VersionNegotiationState`](VersionNegotiationState.md)
183
-
184
- Version negotiation state for this session.
185
-
186
- Tracks the negotiation process with the peer to agree on a protocol version.
187
- Once negotiation completes, the version is locked for the session lifetime.
188
-
189
- #### See
190
-
191
- VersionNegotiationState
@@ -1,60 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / SafetyNumber
6
-
7
- # Interface: SafetyNumber
8
-
9
- Safety number for verifying identity with another user
10
-
11
- Generated by SignalProtocolClient.verify() for out-of-band verification.
12
-
13
- ## Properties
14
-
15
- ### confirmation
16
-
17
- > **confirmation**: [`SafetyNumberConfirmation`](SafetyNumberConfirmation.md)
18
-
19
- Immutable evidence for the exact value displayed to the user.
20
- Pass this object to confirmSafetyNumber() after authenticated comparison.
21
-
22
- ***
23
-
24
- ### fingerprint
25
-
26
- > **fingerprint**: `Uint8Array`
27
-
28
- Raw fingerprint bytes for QR code generation
29
-
30
- ***
31
-
32
- ### identityType
33
-
34
- > **identityType**: [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
35
-
36
- Per-user identity namespace used for this comparison.
37
-
38
- ***
39
-
40
- ### numeric
41
-
42
- > **numeric**: `string`
43
-
44
- 60-digit numeric code for voice/phone verification
45
-
46
- ***
47
-
48
- ### trustState
49
-
50
- > **trustState**: [`IdentityTrustState`](../namespaces/keys/type-aliases/IdentityTrustState.md) \| `null`
51
-
52
- Generating a safety number never promotes this state.
53
-
54
- ***
55
-
56
- ### userId
57
-
58
- > **userId**: `string`
59
-
60
- User ID this safety number is for
@@ -1,46 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / SafetyNumberConfirmation
6
-
7
- # Interface: SafetyNumberConfirmation
8
-
9
- Exact safety-number comparison evidence.
10
-
11
- Strings are used instead of mutable Uint8Array instances so application code
12
- cannot accidentally change the value between display and confirmation.
13
-
14
- ## Properties
15
-
16
- ### fingerprint
17
-
18
- > `readonly` **fingerprint**: [`Base64`](../type-aliases/Base64.md)
19
-
20
- Canonical Base64 of the complete displayed composite fingerprint.
21
-
22
- ***
23
-
24
- ### identityType
25
-
26
- > `readonly` **identityType**: [`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
27
-
28
- ***
29
-
30
- ### remoteIdentityCommitment
31
-
32
- > `readonly` **remoteIdentityCommitment**: [`Base64`](../type-aliases/Base64.md)
33
-
34
- Canonical Base64 of the locally derived remote composite commitment.
35
-
36
- ***
37
-
38
- ### userId
39
-
40
- > `readonly` **userId**: `string`
41
-
42
- ***
43
-
44
- ### version
45
-
46
- > `readonly` **version**: `1`
@@ -1,70 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / SealedSenderConfig
6
-
7
- # Interface: SealedSenderConfig
8
-
9
- Sealed Sender configuration.
10
-
11
- ## See
12
-
13
- https://signal.org/blog/sealed-sender/
14
-
15
- ## Properties
16
-
17
- ### accessMode?
18
-
19
- > `optional` **accessMode?**: `SealedSenderAccessMode`
20
-
21
- Who is allowed to send sealed sender messages to this user.
22
-
23
- #### Default
24
-
25
- ```ts
26
- 'unrestricted'
27
- ```
28
-
29
- ***
30
-
31
- ### certificateProvider?
32
-
33
- > `optional` **certificateProvider?**: () => `Promise`\<`string`\>
34
-
35
- Provider function that returns a serialized SenderCertificate (base64).
36
-
37
- Called lazily when a sealed sender message is sent and the cached
38
- certificate has expired. The returned certificate is cached for its
39
- validity period (typically 24 hours).
40
-
41
- #### Returns
42
-
43
- `Promise`\<`string`\>
44
-
45
- Base64-encoded serialized SenderCertificate
46
-
47
- ***
48
-
49
- ### contactStateStore?
50
-
51
- > `optional` **contactStateStore?**: `ContactProfileStateStore`
52
-
53
- Optional host-provided contact profile state store.
54
-
55
- When present, the Signal Protocol client can use per-contact profile keys and
56
- unidentified-access mode for direct-message sealed sender sends
57
- without importing the host app's persistence layer.
58
-
59
- ***
60
-
61
- ### trustRoots
62
-
63
- > **trustRoots**: `Uint8Array`\<`ArrayBufferLike`\>[]
64
-
65
- Ed25519 trust root public keys for certificate validation.
66
-
67
- Clients use these to validate the certificate chain:
68
- trust_root signs ServerCertificate -> ServerCertificate signs SenderCertificate
69
-
70
- Multiple roots are supported for key rotation scenarios.
@@ -1,191 +0,0 @@
1
- [**@open-e2ee/signal-protocol-sdk**](../README.md)
2
-
3
- ***
4
-
5
- [@open-e2ee/signal-protocol-sdk](../README.md) / SendOptions
6
-
7
- # Interface: SendOptions
8
-
9
- Options for SignalProtocolClient.send()
10
-
11
- Extensible for future features like disappearing messages and threads.
12
-
13
- ## Properties
14
-
15
- ### attachment?
16
-
17
- > `optional` **attachment?**: [`AttachmentTransferOptions`](AttachmentTransferOptions.md)
18
-
19
- Upload/download lifecycle controls for attachment operations.
20
-
21
- ***
22
-
23
- ### blurHash?
24
-
25
- > `optional` **blurHash?**: `string`
26
-
27
- BlurHash for instant placeholder (~25 chars, base-83 encoded)
28
-
29
- ***
30
-
31
- ### caption?
32
-
33
- > `optional` **caption?**: `string`
34
-
35
- Caption text for attachment
36
-
37
- ***
38
-
39
- ### cdnNumber?
40
-
41
- > `optional` **cdnNumber?**: `number`
42
-
43
- Optional CDN number when the remote object backend distinguishes CDN tiers
44
-
45
- ***
46
-
47
- ### clientMessageId?
48
-
49
- > `optional` **clientMessageId?**: `string`
50
-
51
- Stable client-generated send identifier for retry idempotency.
52
-
53
- Retries of the same logical send should reuse this value with the same
54
- timestamp. Relay adapters that support it can return the original accept
55
- result instead of inserting a duplicate envelope after an unknown result.
56
-
57
- ***
58
-
59
- ### clientUuid?
60
-
61
- > `optional` **clientUuid?**: `string`
62
-
63
- Optional client-generated media identifier for cross-device reconciliation
64
-
65
- ***
66
-
67
- ### contentHint?
68
-
69
- > `optional` **contentHint?**: [`ContentHint`](../enumerations/ContentHint.md)
70
-
71
- Content hint for recipient retry behavior.
72
-
73
- Used for protocol/no-op payloads (for example NullMessage resend responses)
74
- that should be treated as IMPLICIT and silently discarded on failure.
75
-
76
- ***
77
-
78
- ### durationMs?
79
-
80
- > `optional` **durationMs?**: `number`
81
-
82
- Media duration in milliseconds for video/audio attachments
83
-
84
- ***
85
-
86
- ### expiresIn?
87
-
88
- > `optional` **expiresIn?**: `number`
89
-
90
- Disappearing message duration in milliseconds (future feature)
91
-
92
- ***
93
-
94
- ### fileName?
95
-
96
- > `optional` **fileName?**: `string`
97
-
98
- Original file name
99
-
100
- ***
101
-
102
- ### flags?
103
-
104
- > `optional` **flags?**: `number`
105
-
106
- Media attachment flags bitmap, for example MediaAttachmentFlag.VoiceMessage
107
-
108
- ***
109
-
110
- ### groupMemberUserIds?
111
-
112
- > `optional` **groupMemberUserIds?**: `string`[]
113
-
114
- Pre-resolved group member user IDs (local-first member resolution).
115
- The caller provides the member list from local SQLite since group membership
116
- is not stored on the server. The cipher resolves these to device IDs via
117
- relay.getActiveDevices().
118
-
119
- ***
120
-
121
- ### height?
122
-
123
- > `optional` **height?**: `number`
124
-
125
- Media height in pixels (for layout before download)
126
-
127
- ***
128
-
129
- ### isBinary?
130
-
131
- > `optional` **isBinary?**: `boolean`
132
-
133
- Marks Uint8Array content as binary file data (vs protobuf/text bytes).
134
- When true with Uint8Array content, routes to blob encryption flow.
135
-
136
- ***
137
-
138
- ### isViewOnce?
139
-
140
- > `optional` **isViewOnce?**: `boolean`
141
-
142
- Whether this is a view-once attachment
143
-
144
- ***
145
-
146
- ### mimeType?
147
-
148
- > `optional` **mimeType?**: `string`
149
-
150
- MIME type for binary content (e.g., 'image/jpeg', 'application/pdf')
151
-
152
- ***
153
-
154
- ### replyTo?
155
-
156
- > `optional` **replyTo?**: `string`
157
-
158
- Message ID to reply to for thread support (future feature)
159
-
160
- ***
161
-
162
- ### thumbnail?
163
-
164
- > `optional` **thumbnail?**: `string`
165
-
166
- Base64-encoded preview thumbnail stored inside encrypted attachment metadata
167
-
168
- ***
169
-
170
- ### timestamp?
171
-
172
- > `optional` **timestamp?**: `number`
173
-
174
- Client timestamp for receipt matching.
175
- Same timestamp should be stored locally for delivery receipt lookup.
176
-
177
- ***
178
-
179
- ### waveform?
180
-
181
- > `optional` **waveform?**: `number`[]
182
-
183
- Voice-message waveform samples, each represented as an integer from 0 to 255
184
-
185
- ***
186
-
187
- ### width?
188
-
189
- > `optional` **width?**: `number`
190
-
191
- Media width in pixels (for layout before download)