@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.
- package/ADAPTERS.md +1 -1
- package/CHANGELOG.md +680 -2
- package/COMMERCIAL.md +56 -0
- package/README.md +13 -8
- package/SECURITY.md +15 -1
- package/client/README.md +1 -1
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +16 -8
- package/dist/client/client.js.map +1 -1
- package/dist/client/config.d.ts +12 -2
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/config.js.map +1 -1
- package/dist/client/endorsement-manager.d.ts +19 -2
- package/dist/client/endorsement-manager.d.ts.map +1 -1
- package/dist/client/endorsement-manager.js +26 -10
- package/dist/client/endorsement-manager.js.map +1 -1
- package/dist/client/headless.d.ts +1 -1
- package/dist/client/headless.js +1 -1
- package/dist/client/sealed-sender-ops.d.ts +27 -1
- package/dist/client/sealed-sender-ops.d.ts.map +1 -1
- package/dist/client/sealed-sender-ops.js +36 -6
- package/dist/client/sealed-sender-ops.js.map +1 -1
- package/dist/client/signal-service-cipher.d.ts +16 -1
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +112 -52
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/types.d.ts +20 -7
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js.map +1 -1
- package/dist/index.d.ts +7 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7 -0
- package/dist/index.js.map +1 -1
- package/dist/internal/crypto/index.d.ts +1 -1
- package/dist/internal/crypto/index.d.ts.map +1 -1
- package/dist/internal/crypto/index.js +1 -1
- package/dist/internal/crypto/index.js.map +1 -1
- package/dist/internal/crypto/random.d.ts +9 -0
- package/dist/internal/crypto/random.d.ts.map +1 -1
- package/dist/internal/crypto/random.js +16 -0
- package/dist/internal/crypto/random.js.map +1 -1
- package/dist/internal/groups/manager.d.ts +13 -0
- package/dist/internal/groups/manager.d.ts.map +1 -1
- package/dist/internal/groups/manager.js +73 -12
- package/dist/internal/groups/manager.js.map +1 -1
- package/dist/internal/groups/server-engine.d.ts +31 -0
- package/dist/internal/groups/server-engine.d.ts.map +1 -1
- package/dist/internal/groups/server-engine.js +67 -7
- package/dist/internal/groups/server-engine.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption-v2.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption-v2.js +32 -18
- package/dist/internal/protocol/sealed-sender/decryption-v2.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption.js +33 -19
- package/dist/internal/protocol/sealed-sender/decryption.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption-v2.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption-v2.js +8 -14
- package/dist/internal/protocol/sealed-sender/encryption-v2.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption.d.ts +9 -4
- package/dist/internal/protocol/sealed-sender/encryption.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption.js +7 -15
- package/dist/internal/protocol/sealed-sender/encryption.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts +6 -7
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.js +5 -7
- package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/trust-root.d.ts +45 -0
- package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +1 -0
- package/dist/internal/protocol/sealed-sender/trust-root.js +77 -0
- package/dist/internal/protocol/sealed-sender/trust-root.js.map +1 -0
- package/dist/internal/protocol/sealed-sender/types.d.ts +64 -9
- package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/types.js +43 -0
- package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts +37 -0
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +108 -7
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/local/store/expo/adapter.d.ts +14 -15
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +109 -102
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/expo/db.d.ts +4 -1
- package/dist/local/store/expo/db.d.ts.map +1 -1
- package/dist/local/store/expo/db.js +5 -0
- package/dist/local/store/expo/db.js.map +1 -1
- package/dist/local/store/expo/index.d.ts +0 -2
- package/dist/local/store/expo/index.d.ts.map +1 -1
- package/dist/local/store/expo/index.js +1 -1
- package/dist/local/store/expo/index.js.map +1 -1
- package/dist/local/store/expo/models/index.d.ts +1 -1
- package/dist/local/store/expo/models/index.d.ts.map +1 -1
- package/dist/local/store/expo/models/index.js +2 -2
- package/dist/local/store/expo/models/index.js.map +1 -1
- package/dist/local/store/expo/models/sender-key.d.ts +101 -77
- package/dist/local/store/expo/models/sender-key.d.ts.map +1 -1
- package/dist/local/store/expo/models/sender-key.js +154 -124
- package/dist/local/store/expo/models/sender-key.js.map +1 -1
- package/dist/local/store/expo/schema.d.ts +134 -32
- package/dist/local/store/expo/schema.d.ts.map +1 -1
- package/dist/local/store/expo/schema.js +36 -7
- package/dist/local/store/expo/schema.js.map +1 -1
- package/dist/local/store/mock/adapter.d.ts +1 -0
- package/dist/local/store/mock/adapter.d.ts.map +1 -1
- package/dist/local/store/mock/adapter.js +18 -0
- package/dist/local/store/mock/adapter.js.map +1 -1
- package/dist/local/store/react-native/adapter.d.ts +39 -0
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +163 -8
- package/dist/local/store/react-native/adapter.js.map +1 -1
- package/dist/local/store/web/adapter.d.ts +1 -0
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +33 -1
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/remote/relay/convex/backend.d.ts +402 -0
- package/dist/remote/relay/convex/backend.d.ts.map +1 -0
- package/dist/remote/relay/convex/backend.js +684 -0
- package/dist/remote/relay/convex/backend.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/api.d.ts +58 -0
- package/dist/remote/relay/convex/component/_generated/api.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/api.js +31 -0
- package/dist/remote/relay/convex/component/_generated/api.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/component.d.ts +480 -0
- package/dist/remote/relay/convex/component/_generated/component.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/component.js +11 -0
- package/dist/remote/relay/convex/component/_generated/component.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.d.ts +46 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.js +11 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/server.d.ts +129 -0
- package/dist/remote/relay/convex/component/_generated/server.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/server.js +79 -0
- package/dist/remote/relay/convex/component/_generated/server.js.map +1 -0
- package/dist/remote/relay/convex/component/accounts.d.ts +43 -0
- package/dist/remote/relay/convex/component/accounts.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/accounts.js +181 -0
- package/dist/remote/relay/convex/component/accounts.js.map +1 -0
- package/dist/remote/relay/convex/component/certificates.d.ts +10 -0
- package/dist/remote/relay/convex/component/certificates.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/certificates.js +122 -0
- package/dist/remote/relay/convex/component/certificates.js.map +1 -0
- package/dist/remote/relay/convex/component/cleanup.d.ts +26 -0
- package/dist/remote/relay/convex/component/cleanup.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/cleanup.js +127 -0
- package/dist/remote/relay/convex/component/cleanup.js.map +1 -0
- package/dist/remote/relay/convex/component/convex.config.d.ts +5 -0
- package/dist/remote/relay/convex/component/convex.config.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/convex.config.js +33 -0
- package/dist/remote/relay/convex/component/convex.config.js.map +1 -0
- package/dist/remote/relay/convex/component/crons.d.ts +3 -0
- package/dist/remote/relay/convex/component/crons.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/crons.js +9 -0
- package/dist/remote/relay/convex/component/crons.js.map +1 -0
- package/dist/remote/relay/convex/component/devices.d.ts +101 -0
- package/dist/remote/relay/convex/component/devices.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/devices.js +299 -0
- package/dist/remote/relay/convex/component/devices.js.map +1 -0
- package/dist/remote/relay/convex/component/errors.d.ts +22 -0
- package/dist/remote/relay/convex/component/errors.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/errors.js +17 -0
- package/dist/remote/relay/convex/component/errors.js.map +1 -0
- package/dist/remote/relay/convex/component/groups.d.ts +60 -0
- package/dist/remote/relay/convex/component/groups.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/groups.js +331 -0
- package/dist/remote/relay/convex/component/groups.js.map +1 -0
- package/dist/remote/relay/convex/component/keys.d.ts +130 -0
- package/dist/remote/relay/convex/component/keys.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/keys.js +578 -0
- package/dist/remote/relay/convex/component/keys.js.map +1 -0
- package/dist/remote/relay/convex/component/messages.d.ts +119 -0
- package/dist/remote/relay/convex/component/messages.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/messages.js +649 -0
- package/dist/remote/relay/convex/component/messages.js.map +1 -0
- package/dist/remote/relay/convex/component/provisioning.d.ts +92 -0
- package/dist/remote/relay/convex/component/provisioning.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/provisioning.js +359 -0
- package/dist/remote/relay/convex/component/provisioning.js.map +1 -0
- package/dist/remote/relay/convex/component/runtime.d.ts +18 -0
- package/dist/remote/relay/convex/component/runtime.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/runtime.js +142 -0
- package/dist/remote/relay/convex/component/runtime.js.map +1 -0
- package/dist/remote/relay/convex/component/schema.d.ts +344 -0
- package/dist/remote/relay/convex/component/schema.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/schema.js +266 -0
- package/dist/remote/relay/convex/component/schema.js.map +1 -0
- package/dist/remote/relay/convex/component/zkAuth.d.ts +12 -0
- package/dist/remote/relay/convex/component/zkAuth.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/zkAuth.js +71 -0
- package/dist/remote/relay/convex/component/zkAuth.js.map +1 -0
- package/dist/remote/relay/convex/constants.d.ts +3 -0
- package/dist/remote/relay/convex/constants.d.ts.map +1 -0
- package/dist/remote/relay/convex/constants.js +3 -0
- package/dist/remote/relay/convex/constants.js.map +1 -0
- package/dist/remote/relay/convex/group-server.d.ts +4 -2
- package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
- package/dist/remote/relay/convex/group-server.js +4 -2
- package/dist/remote/relay/convex/group-server.js.map +1 -1
- package/dist/remote/relay/convex/index.d.ts +4 -1
- package/dist/remote/relay/convex/index.d.ts.map +1 -1
- package/dist/remote/relay/convex/index.js +3 -1
- package/dist/remote/relay/convex/index.js.map +1 -1
- package/dist/remote/relay/convex/relay.d.ts +42 -63
- package/dist/remote/relay/convex/relay.d.ts.map +1 -1
- package/dist/remote/relay/convex/relay.js +51 -29
- package/dist/remote/relay/convex/relay.js.map +1 -1
- package/dist/remote/relay/convex/types.d.ts +16 -103
- package/dist/remote/relay/convex/types.d.ts.map +1 -1
- package/dist/remote/relay/convex/types.js +8 -13
- package/dist/remote/relay/convex/types.js.map +1 -1
- package/dist/remote/relay/index.d.ts +1 -1
- package/dist/remote/relay/index.d.ts.map +1 -1
- package/dist/remote/relay/index.js.map +1 -1
- package/dist/remote/relay/mock/adapter.d.ts +2 -7
- package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
- package/dist/remote/relay/mock/adapter.js +32 -20
- package/dist/remote/relay/mock/adapter.js.map +1 -1
- package/dist/remote/relay/types.d.ts +32 -69
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/remote/relay/types.js +0 -1
- package/dist/remote/relay/types.js.map +1 -1
- package/dist/types/api.d.ts +21 -0
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/protocol-config.d.ts +51 -0
- package/dist/types/protocol-config.d.ts.map +1 -1
- package/dist/types/protocol-config.js +46 -0
- package/dist/types/protocol-config.js.map +1 -1
- package/docs/ASSURANCE.md +10 -6
- package/docs/CLIENT_COMPOSITION.md +23 -69
- package/docs/DEVIATIONS.md +44 -11
- package/docs/E2EE.md +71 -6
- package/docs/GETTING_STARTED.md +1 -1
- package/docs/PACKAGE_SURFACE.md +6 -5
- package/docs/RECIPES.md +1 -1
- package/docs/SECURITY.md +8 -0
- package/local/store/expo/README.md +10 -1
- package/local/store/node/README.md +10 -1
- package/package.json +12 -7
- package/remote/relay/convex/README.md +1 -1
- package/remote/relay/convex/component/README.md +428 -0
- package/scripts/oe-groups.mjs +21 -1
- package/dist/remote/relay/convex/server/index.d.ts +0 -2
- package/dist/remote/relay/convex/server/index.d.ts.map +0 -1
- package/dist/remote/relay/convex/server/index.js +0 -2
- package/dist/remote/relay/convex/server/index.js.map +0 -1
- package/dist/remote/relay/convex/server.d.ts +0 -150
- package/dist/remote/relay/convex/server.d.ts.map +0 -1
- package/dist/remote/relay/convex/server.js +0 -506
- package/dist/remote/relay/convex/server.js.map +0 -1
- package/docs/api/README.md +0 -471
- package/docs/api/classes/EncryptionError.md +0 -112
- package/docs/api/classes/EndorsementManager.md +0 -325
- package/docs/api/classes/SealedSenderAuthError.md +0 -127
- package/docs/api/classes/ServerDerivedKeyPair.md +0 -68
- package/docs/api/classes/ServerDerivedPublicKey.md +0 -33
- package/docs/api/classes/ServerRootKeyPair.md +0 -94
- package/docs/api/classes/ServerRootPublicKey.md +0 -72
- package/docs/api/classes/SignalProtocolBlockingManager.md +0 -106
- package/docs/api/classes/SignalProtocolClient.md +0 -2654
- package/docs/api/classes/VerificationFailure.md +0 -25
- package/docs/api/enumerations/ContentHint.md +0 -63
- package/docs/api/enumerations/EncryptionErrorCode.md +0 -488
- package/docs/api/enumerations/IdentityKeyChange.md +0 -65
- package/docs/api/enumerations/MessageType.md +0 -29
- package/docs/api/enumerations/TrustDirection.md +0 -33
- package/docs/api/enumerations/TypingAction.md +0 -31
- package/docs/api/functions/createDefaultSignalProtocolContentAdapter.md +0 -13
- package/docs/api/functions/createDefaultSignalProtocolLogger.md +0 -36
- package/docs/api/functions/createGroupId.md +0 -32
- package/docs/api/functions/createSignalProtocolClient.md +0 -36
- package/docs/api/functions/createSignalProtocolClientConfig.md +0 -24
- package/docs/api/functions/decodeGroupTrustRoot.md +0 -21
- package/docs/api/functions/encodeGroupTrustRoot.md +0 -28
- package/docs/api/functions/extractGroupId.md +0 -32
- package/docs/api/functions/formatVersion.md +0 -25
- package/docs/api/functions/isCompatible.md +0 -31
- package/docs/api/functions/isGroupId.md +0 -37
- package/docs/api/functions/isSealedSenderAuthError.md +0 -25
- package/docs/api/functions/parseVersion.md +0 -29
- package/docs/api/functions/resolveSPQRLimits.md +0 -21
- package/docs/api/functions/resolveSignalProtocolLogger.md +0 -42
- package/docs/api/interfaces/AccountIdentityProvisioning.md +0 -43
- package/docs/api/interfaces/AccountIdentityRotation.md +0 -69
- package/docs/api/interfaces/AttachmentTransferOptions.md +0 -49
- package/docs/api/interfaces/BlockedRecipientEntry.md +0 -25
- package/docs/api/interfaces/BlockedRecipientsSyncInput.md +0 -27
- package/docs/api/interfaces/ConfigurationSyncInput.md +0 -19
- package/docs/api/interfaces/CredentialPublicKey.md +0 -25
- package/docs/api/interfaces/DataMessageInput.md +0 -21
- package/docs/api/interfaces/DecryptedEnvelope.md +0 -95
- package/docs/api/interfaces/DecryptedGroup.md +0 -86
- package/docs/api/interfaces/DeviceInfo.md +0 -79
- package/docs/api/interfaces/DeviceRecord.md +0 -87
- package/docs/api/interfaces/DeviceRegistration.md +0 -27
- package/docs/api/interfaces/DoubleRatchetConfig.md +0 -36
- package/docs/api/interfaces/EcOneTimePreKey.md +0 -27
- package/docs/api/interfaces/EcSignedPreKey.md +0 -39
- package/docs/api/interfaces/EcSignedPreKeyUpload.md +0 -50
- package/docs/api/interfaces/EncryptionErrorContext.md +0 -51
- package/docs/api/interfaces/Envelope.md +0 -154
- package/docs/api/interfaces/ForceKeyResetResult.md +0 -37
- package/docs/api/interfaces/GroupAuthorization.md +0 -23
- package/docs/api/interfaces/GroupChangeEntry.md +0 -42
- package/docs/api/interfaces/GroupMemberDevice.md +0 -26
- package/docs/api/interfaces/GroupTrustRoot.md +0 -33
- package/docs/api/interfaces/IEcOneTimePreKeyStore.md +0 -86
- package/docs/api/interfaces/IEcSignedPreKeyStore.md +0 -133
- package/docs/api/interfaces/IGroupServer.md +0 -120
- package/docs/api/interfaces/IGroupStateStore.md +0 -128
- package/docs/api/interfaces/IIdentityKeyStore.md +0 -312
- package/docs/api/interfaces/IKemPreKeyStore.md +0 -144
- package/docs/api/interfaces/IKyberLastResortPreKeyStore.md +0 -112
- package/docs/api/interfaces/ILogger.md +0 -117
- package/docs/api/interfaces/IProtocolStore.md +0 -1033
- package/docs/api/interfaces/IRelayGroupServer.md +0 -60
- package/docs/api/interfaces/ISenderKeyStore.md +0 -417
- package/docs/api/interfaces/ISesameStore.md +0 -249
- package/docs/api/interfaces/ISessionStore.md +0 -178
- package/docs/api/interfaces/ISignalProtocolClient.md +0 -1185
- package/docs/api/interfaces/ISignalProtocolLocalSecretVault.md +0 -71
- package/docs/api/interfaces/ISignalProtocolLocalStore.md +0 -2053
- package/docs/api/interfaces/ISignalProtocolManager.md +0 -272
- package/docs/api/interfaces/ISignalProtocolRelayServer.md +0 -1337
- package/docs/api/interfaces/IdentityKeyPair.md +0 -49
- package/docs/api/interfaces/IncomingEnvelope.md +0 -91
- package/docs/api/interfaces/InspectedSignalProtocolContent.md +0 -43
- package/docs/api/interfaces/KDFChain.md +0 -31
- package/docs/api/interfaces/KemLastResortPreKeyUpload.md +0 -50
- package/docs/api/interfaces/KeyPair.md +0 -23
- package/docs/api/interfaces/KyberPreKey.md +0 -42
- package/docs/api/interfaces/MLKEMBraidAgentState.md +0 -191
- package/docs/api/interfaces/MLKEMBraidMessage.md +0 -49
- package/docs/api/interfaces/MediaAttachmentDeleteSyncInput.md +0 -31
- package/docs/api/interfaces/MessageHeader.md +0 -49
- package/docs/api/interfaces/MessageRecord.md +0 -86
- package/docs/api/interfaces/ParsedReceiptContent.md +0 -19
- package/docs/api/interfaces/ParsedTypingContent.md +0 -19
- package/docs/api/interfaces/PreKeyMaintenanceStore.md +0 -88
- package/docs/api/interfaces/PreKeyMessage.md +0 -159
- package/docs/api/interfaces/PreKeyStatusResult.md +0 -21
- package/docs/api/interfaces/PreKeyUpload.md +0 -42
- package/docs/api/interfaces/ProcessEnvelopeOptions.md +0 -72
- package/docs/api/interfaces/ProtocolAddress.md +0 -38
- package/docs/api/interfaces/ProtocolStrategyConfig.md +0 -91
- package/docs/api/interfaces/RatchetMessage.md +0 -96
- package/docs/api/interfaces/ReadSyncEntryInput.md +0 -19
- package/docs/api/interfaces/ReceiverChain.md +0 -43
- package/docs/api/interfaces/RecipientUsernameSyncInput.md +0 -31
- package/docs/api/interfaces/RelayPreKeyBundle.md +0 -254
- package/docs/api/interfaces/RemoteObjectDownload.md +0 -33
- package/docs/api/interfaces/RemoteObjectUpload.md +0 -49
- package/docs/api/interfaces/ResolvedSPQRInfoStrings.md +0 -27
- package/docs/api/interfaces/ResolvedSPQRLimits.md +0 -37
- package/docs/api/interfaces/RetryRequest.md +0 -80
- package/docs/api/interfaces/SCKAState.md +0 -65
- package/docs/api/interfaces/SPQRLimits.md +0 -40
- package/docs/api/interfaces/SPQRState.md +0 -191
- package/docs/api/interfaces/SafetyNumber.md +0 -60
- package/docs/api/interfaces/SafetyNumberConfirmation.md +0 -46
- package/docs/api/interfaces/SealedSenderConfig.md +0 -70
- package/docs/api/interfaces/SendOptions.md +0 -191
- package/docs/api/interfaces/SendResult.md +0 -93
- package/docs/api/interfaces/SenderKeyDistributionMessage.md +0 -43
- package/docs/api/interfaces/SenderKeyState.md +0 -76
- package/docs/api/interfaces/SenderKeysConfig.md +0 -65
- package/docs/api/interfaces/SentSyncTranscriptInput.md +0 -31
- package/docs/api/interfaces/ServiceId.md +0 -19
- package/docs/api/interfaces/SesameMessage.md +0 -84
- package/docs/api/interfaces/SesameStats.md +0 -57
- package/docs/api/interfaces/SessionHealthResult.md +0 -120
- package/docs/api/interfaces/SessionRecord.md +0 -80
- package/docs/api/interfaces/SessionRecordMetadata.md +0 -109
- package/docs/api/interfaces/SessionState.md +0 -368
- package/docs/api/interfaces/SessionTrustCommit.md +0 -58
- package/docs/api/interfaces/SignalProtocolBlockingHooks.md +0 -44
- package/docs/api/interfaces/SignalProtocolBlockingManagerOptions.md +0 -31
- package/docs/api/interfaces/SignalProtocolBlockingMirror.md +0 -30
- package/docs/api/interfaces/SignalProtocolBlockingStore.md +0 -83
- package/docs/api/interfaces/SignalProtocolClientAdapterConfig.md +0 -44
- package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +0 -731
- package/docs/api/interfaces/SignalProtocolClientConfig.md +0 -895
- package/docs/api/interfaces/SignalProtocolClientDeleteLocalAttachmentInput.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientHooks.md +0 -506
- package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +0 -51
- package/docs/api/interfaces/SignalProtocolClientLoadLocalAttachmentInput.md +0 -187
- package/docs/api/interfaces/SignalProtocolClientLoadedLocalAttachment.md +0 -19
- package/docs/api/interfaces/SignalProtocolClientMedia.md +0 -83
- package/docs/api/interfaces/SignalProtocolClientMediaCompletedResult.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientMediaConfig.md +0 -157
- package/docs/api/interfaces/SignalProtocolClientMediaDownloadCompletedResult.md +0 -37
- package/docs/api/interfaces/SignalProtocolClientMediaDownloadNotNeededResult.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientMediaFailedResult.md +0 -19
- package/docs/api/interfaces/SignalProtocolClientMediaOperationOptions.md +0 -53
- package/docs/api/interfaces/SignalProtocolClientMediaPendingResult.md +0 -19
- package/docs/api/interfaces/SignalProtocolClientMediaProcessResult.md +0 -43
- package/docs/api/interfaces/SignalProtocolClientMediaSkippedResult.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientMediaUploadCompletedResult.md +0 -31
- package/docs/api/interfaces/SignalProtocolClientProcessPendingMediaOptions.md +0 -87
- package/docs/api/interfaces/SignalProtocolClientSaveDownloadedAttachmentInput.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientSaveUploadedAttachmentInput.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientSyncDeleteInput.md +0 -19
- package/docs/api/interfaces/SignalProtocolConfig.md +0 -50
- package/docs/api/interfaces/SignalProtocolContentAdapter.md +0 -325
- package/docs/api/interfaces/SignalProtocolRemoteObjectStore.md +0 -88
- package/docs/api/interfaces/SkippedSenderMessageKey.md +0 -26
- package/docs/api/interfaces/TaskNotificationAckSyncInput.md +0 -31
- package/docs/api/interfaces/TripleRatchetState.md +0 -64
- package/docs/api/interfaces/UserRecord.md +0 -71
- package/docs/api/interfaces/UsernameStateSyncInput.md +0 -19
- package/docs/api/interfaces/VerificationStateSyncInput.md +0 -31
- package/docs/api/interfaces/VersionNegotiationState.md +0 -84
- package/docs/api/interfaces/ViewOnceOpenSyncInput.md +0 -19
- package/docs/api/namespaces/ProtocolAddress/README.md +0 -33
- package/docs/api/namespaces/ProtocolAddress/functions/create.md +0 -41
- package/docs/api/namespaces/ProtocolAddress/functions/equals.md +0 -39
- package/docs/api/namespaces/ProtocolAddress/functions/fromStorageKey.md +0 -36
- package/docs/api/namespaces/ProtocolAddress/functions/isUser.md +0 -39
- package/docs/api/namespaces/ProtocolAddress/functions/isValid.md +0 -34
- package/docs/api/namespaces/ProtocolAddress/functions/parse.md +0 -41
- package/docs/api/namespaces/ProtocolAddress/functions/toStorageKey.md +0 -38
- package/docs/api/namespaces/ProtocolAddress/functions/toString.md +0 -34
- package/docs/api/namespaces/SessionRecord/README.md +0 -30
- package/docs/api/namespaces/SessionRecord/functions/archiveCurrent.md +0 -40
- package/docs/api/namespaces/SessionRecord/functions/archiveCurrentState.md +0 -34
- package/docs/api/namespaces/SessionRecord/functions/create.md +0 -25
- package/docs/api/namespaces/SessionRecord/functions/deserialize.md +0 -29
- package/docs/api/namespaces/SessionRecord/functions/findSession.md +0 -34
- package/docs/api/namespaces/SessionRecord/functions/getAllSessions.md +0 -25
- package/docs/api/namespaces/SessionRecord/functions/getArchivedCount.md +0 -25
- package/docs/api/namespaces/SessionRecord/functions/hasCurrentSession.md +0 -25
- package/docs/api/namespaces/SessionRecord/functions/hasUsableSenderChain.md +0 -36
- package/docs/api/namespaces/SessionRecord/functions/promoteSession.md +0 -34
- package/docs/api/namespaces/SessionRecord/functions/serialize.md +0 -28
- package/docs/api/namespaces/SessionRecord/variables/MAX_ARCHIVED_SESSIONS.md +0 -14
- package/docs/api/namespaces/SessionState/README.md +0 -15
- package/docs/api/namespaces/SessionState/functions/getSessionId.md +0 -32
- package/docs/api/namespaces/blocking/README.md +0 -43
- package/docs/api/namespaces/encoding/README.md +0 -33
- package/docs/api/namespaces/encoding/functions/base64ToUrlSafe.md +0 -28
- package/docs/api/namespaces/encoding/functions/bytesToBase64.md +0 -21
- package/docs/api/namespaces/encoding/functions/bytesToString.md +0 -21
- package/docs/api/namespaces/encoding/functions/bytesToUrlSafeBase64.md +0 -33
- package/docs/api/namespaces/encoding/functions/concatBytes.md +0 -21
- package/docs/api/namespaces/encoding/functions/stringToBytes.md +0 -21
- package/docs/api/namespaces/encoding/functions/urlSafeToBase64.md +0 -27
- package/docs/api/namespaces/keys/README.md +0 -130
- package/docs/api/namespaces/keys/functions/acceptContactIdentityRotation.md +0 -33
- package/docs/api/namespaces/keys/functions/assertIdentityCommitment.md +0 -25
- package/docs/api/namespaces/keys/functions/canonicalizeDeviceIdentityKey.md +0 -30
- package/docs/api/namespaces/keys/functions/compareDeviceIdentityKeys.md +0 -28
- package/docs/api/namespaces/keys/functions/compositeIdentitiesEqual.md +0 -23
- package/docs/api/namespaces/keys/functions/createCompositeIdentityV1.md +0 -19
- package/docs/api/namespaces/keys/functions/createPreKeySignatureContext.md +0 -31
- package/docs/api/namespaces/keys/functions/createUnverifiedContactIdentityRecord.md +0 -23
- package/docs/api/namespaces/keys/functions/decodeCompositeIdentityV1.md +0 -19
- package/docs/api/namespaces/keys/functions/deriveIdentityCommitment.md +0 -19
- package/docs/api/namespaces/keys/functions/encodeCompositeIdentityV1.md +0 -19
- package/docs/api/namespaces/keys/functions/evaluateContactIdentityCandidate.md +0 -27
- package/docs/api/namespaces/keys/functions/generateEcOneTimePreKeys.md +0 -37
- package/docs/api/namespaces/keys/functions/generateEcSignedPreKey.md +0 -39
- package/docs/api/namespaces/keys/functions/generateEcSignedPreKeyId.md +0 -21
- package/docs/api/namespaces/keys/functions/generateIdentityKeyPair.md +0 -24
- package/docs/api/namespaces/keys/functions/generateKemOneTimePreKeys.md +0 -47
- package/docs/api/namespaces/keys/functions/generateKyberLastResortPreKey.md +0 -37
- package/docs/api/namespaces/keys/functions/generateRegistrationId.md +0 -13
- package/docs/api/namespaces/keys/functions/isValidDeviceIdentityKey.md +0 -22
- package/docs/api/namespaces/keys/functions/signMlKem1024PreKey.md +0 -29
- package/docs/api/namespaces/keys/functions/signPreKey.md +0 -31
- package/docs/api/namespaces/keys/functions/validateContactIdentityRecord.md +0 -19
- package/docs/api/namespaces/keys/functions/verifyContactIdentityRecord.md +0 -31
- package/docs/api/namespaces/keys/functions/verifyMlKem1024PreKey.md +0 -33
- package/docs/api/namespaces/keys/functions/verifyPreKeySignature.md +0 -35
- package/docs/api/namespaces/keys/interfaces/CompositeIdentityV1.md +0 -33
- package/docs/api/namespaces/keys/interfaces/ContactIdentityRecord.md +0 -53
- package/docs/api/namespaces/keys/interfaces/KemOneTimePreKey.md +0 -43
- package/docs/api/namespaces/keys/type-aliases/IdentityCandidateStatus.md +0 -9
- package/docs/api/namespaces/keys/type-aliases/IdentityTrustState.md +0 -9
- package/docs/api/namespaces/keys/type-aliases/IdentityType.md +0 -9
- package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_ED25519_TAG.md +0 -9
- package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_LENGTH.md +0 -9
- package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_VERSION.md +0 -9
- package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_X25519_TAG.md +0 -9
- package/docs/api/namespaces/keys/variables/IDENTITY_COMMITMENT_V1_DOMAIN.md +0 -9
- package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_ML_KEM_1024.md +0 -9
- package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_X25519.md +0 -9
- package/docs/api/namespaces/keys/variables/PREKEY_SIGNATURE_V1_DOMAIN.md +0 -9
- package/docs/api/namespaces/keys/variables/UNPINNED_DEVICE_IDENTITY_KEY.md +0 -18
- package/docs/api/namespaces/media/README.md +0 -105
- package/docs/api/namespaces/media/classes/MediaAttachmentError.md +0 -57
- package/docs/api/namespaces/media/functions/createByteRangeMediaAttachmentTransfer.md +0 -19
- package/docs/api/namespaces/media/functions/createMediaAttachmentDeliveryId.md +0 -29
- package/docs/api/namespaces/media/functions/createMediaAttachmentId.md +0 -19
- package/docs/api/namespaces/media/functions/createMediaAttachmentMessage.md +0 -25
- package/docs/api/namespaces/media/functions/createMediaAttachmentPointer.md +0 -19
- package/docs/api/namespaces/media/functions/createTusMediaAttachmentTransfer.md +0 -19
- package/docs/api/namespaces/media/functions/deleteMediaAttachment.md +0 -23
- package/docs/api/namespaces/media/functions/executeMediaAttachmentJob.md +0 -23
- package/docs/api/namespaces/media/functions/isMediaAttachmentFlagSet.md +0 -19
- package/docs/api/namespaces/media/functions/parseMediaAttachmentMessage.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentCleanup.md +0 -23
- package/docs/api/namespaces/media/functions/planMediaAttachmentCleanupJobs.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentDeleteSync.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentDownloadJob.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentOpen.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentProcessing.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentUploadJob.md +0 -19
- package/docs/api/namespaces/media/functions/prepareMediaAttachmentUpload.md +0 -30
- package/docs/api/namespaces/media/functions/resolveMediaAttachment.md +0 -30
- package/docs/api/namespaces/media/functions/serializeMediaAttachmentMessage.md +0 -25
- package/docs/api/namespaces/media/functions/validateMediaAttachmentPolicy.md +0 -23
- package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentPartialStore.md +0 -68
- package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentTransferOptions.md +0 -91
- package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentOptions.md +0 -25
- package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentResult.md +0 -19
- package/docs/api/namespaces/media/interfaces/ExecuteMediaAttachmentJobOptions.md +0 -157
- package/docs/api/namespaces/media/interfaces/MediaAttachmentBackgroundJob.md +0 -85
- package/docs/api/namespaces/media/interfaces/MediaAttachmentCleanupPlan.md +0 -37
- package/docs/api/namespaces/media/interfaces/MediaAttachmentJobExecutionResult.md +0 -55
- package/docs/api/namespaces/media/interfaces/MediaAttachmentMessage.md +0 -31
- package/docs/api/namespaces/media/interfaces/MediaAttachmentOpenDecision.md +0 -31
- package/docs/api/namespaces/media/interfaces/MediaAttachmentPointer.md +0 -133
- package/docs/api/namespaces/media/interfaces/MediaAttachmentPolicy.md +0 -67
- package/docs/api/namespaces/media/interfaces/MediaAttachmentProcessingPlan.md +0 -73
- package/docs/api/namespaces/media/interfaces/MediaAttachmentProgress.md +0 -69
- package/docs/api/namespaces/media/interfaces/MediaAttachmentResumeState.md +0 -37
- package/docs/api/namespaces/media/interfaces/MediaAttachmentRetryOptions.md +0 -31
- package/docs/api/namespaces/media/interfaces/MediaAttachmentTransfer.md +0 -51
- package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferCheckpoint.md +0 -69
- package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferOptions.md +0 -67
- package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadJobData.md +0 -19
- package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadResponse.md +0 -25
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentCleanupJobsInput.md +0 -61
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDeleteSyncInput.md +0 -25
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDownloadJobInput.md +0 -161
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentOpenInput.md +0 -25
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentProcessingInput.md +0 -83
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentUploadJobInput.md +0 -147
- package/docs/api/namespaces/media/interfaces/PrepareMediaAttachmentUploadOptions.md +0 -144
- package/docs/api/namespaces/media/interfaces/ResolveMediaAttachmentOptions.md +0 -55
- package/docs/api/namespaces/media/interfaces/ResolvedMediaAttachment.md +0 -109
- package/docs/api/namespaces/media/interfaces/TusMediaAttachmentTransferOptions.md +0 -85
- package/docs/api/namespaces/media/type-aliases/CreateMediaAttachmentPointerInput.md +0 -15
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentCheckpointCallback.md +0 -19
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentCleanupReason.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentErrorCode.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentFlag.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobExecutionStatus.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobOperation.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobPriority.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSkipReason.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSource.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentKnownIds.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentMessageType.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentProgressCallback.md +0 -19
- package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_DEFAULTS.md +0 -47
- package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_PRESETS.md +0 -95
- package/docs/api/namespaces/media/variables/MediaAttachmentCleanupReason.md +0 -27
- package/docs/api/namespaces/media/variables/MediaAttachmentErrorCode.md +0 -75
- package/docs/api/namespaces/media/variables/MediaAttachmentFlag.md +0 -23
- package/docs/api/namespaces/media/variables/MediaAttachmentJobExecutionStatus.md +0 -19
- package/docs/api/namespaces/media/variables/MediaAttachmentJobOperation.md +0 -31
- package/docs/api/namespaces/media/variables/MediaAttachmentJobPriority.md +0 -23
- package/docs/api/namespaces/media/variables/MediaAttachmentJobSource.md +0 -51
- package/docs/api/namespaces/media/variables/MediaAttachmentMessageType.md +0 -15
- package/docs/api/namespaces/media/variables/downloadMediaAttachment.md +0 -30
- package/docs/api/namespaces/safety/README.md +0 -61
- package/docs/api/namespaces/safety/classes/DisplayableFingerprint.md +0 -108
- package/docs/api/namespaces/safety/classes/Fingerprint.md +0 -104
- package/docs/api/namespaces/safety/classes/ScannableFingerprint.md +0 -209
- package/docs/api/namespaces/safety/functions/base64ToBytes.md +0 -21
- package/docs/api/namespaces/safety/functions/clearFingerprintCache.md +0 -15
- package/docs/api/namespaces/safety/functions/compareSafetyNumbers.md +0 -25
- package/docs/api/namespaces/safety/functions/createFingerprintData.md +0 -60
- package/docs/api/namespaces/safety/functions/extractQrData.md +0 -34
- package/docs/api/namespaces/safety/functions/generateCompositeSafetyNumber.md +0 -39
- package/docs/api/namespaces/safety/functions/generateEmojiFingerprint.md +0 -24
- package/docs/api/namespaces/safety/functions/generateSingleKeyReferenceSafetyNumber.md +0 -51
- package/docs/api/namespaces/safety/functions/generateVerifySchemeUrl.md +0 -32
- package/docs/api/namespaces/safety/functions/generateVerifyUrl.md +0 -49
- package/docs/api/namespaces/safety/functions/isValidSafetyNumber.md +0 -21
- package/docs/api/namespaces/safety/functions/isVerifyUrl.md +0 -45
- package/docs/api/namespaces/safety/functions/parseVerifyUrl.md +0 -31
- package/docs/api/namespaces/safety/interfaces/FingerprintData.md +0 -52
- package/docs/api/namespaces/safety/interfaces/SafetyNumber.md +0 -49
- package/docs/api/namespaces/safety/interfaces/VerifyLinkConfig.md +0 -28
- package/docs/api/namespaces/safety/interfaces/VerifyUrlParams.md +0 -49
- package/docs/api/namespaces/safety/type-aliases/CompareResult.md +0 -21
- package/docs/api/namespaces/safety/variables/DEFAULT_VERIFY_LINK_CONFIG.md +0 -12
- package/docs/api/namespaces/safety/variables/FINGERPRINT_ITERATIONS.md +0 -12
- package/docs/api/namespaces/safety/variables/FINGERPRINT_VERSION.md +0 -12
- package/docs/api/namespaces/safety/variables/VERIFY_BASE_URL.md +0 -11
- package/docs/api/namespaces/safety/variables/VERIFY_SCHEME_URL.md +0 -11
- package/docs/api/type-aliases/Base64.md +0 -20
- package/docs/api/type-aliases/BraidPolicy.md +0 -11
- package/docs/api/type-aliases/Bytes.md +0 -20
- package/docs/api/type-aliases/Ciphertext.md +0 -21
- package/docs/api/type-aliases/DeviceType.md +0 -11
- package/docs/api/type-aliases/DownloadedAttachment.md +0 -11
- package/docs/api/type-aliases/GroupId.md +0 -27
- package/docs/api/type-aliases/Hex.md +0 -20
- package/docs/api/type-aliases/HookName.md +0 -11
- package/docs/api/type-aliases/PostQuantumPolicy.md +0 -11
- package/docs/api/type-aliases/PreparedAttachmentUpload.md +0 -14
- package/docs/api/type-aliases/PrivateKey.md +0 -22
- package/docs/api/type-aliases/ProgressCallback.md +0 -45
- package/docs/api/type-aliases/PublicKey.md +0 -22
- package/docs/api/type-aliases/RemoteObjectCompleteUploadRequest.md +0 -19
- package/docs/api/type-aliases/RemoteObjectDeleteRequest.md +0 -19
- package/docs/api/type-aliases/RemoteObjectDownloadRequest.md +0 -19
- package/docs/api/type-aliases/RemoteObjectUploadRequest.md +0 -42
- package/docs/api/type-aliases/SCKAMode.md +0 -11
- package/docs/api/type-aliases/SealedSenderAuth.md +0 -15
- package/docs/api/type-aliases/SignalProtocolClientMediaCleanupInput.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaCleanupResult.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaDownloadInput.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaDownloadResult.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaOperationResult.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaUploadInput.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaUploadResult.md +0 -9
- package/docs/api/type-aliases/Signature.md +0 -21
- package/docs/api/type-aliases/Unsubscribe.md +0 -15
- package/docs/api/variables/BraidPolicy.md +0 -21
- package/docs/api/variables/DEFAULT_DEVICE_ID.md +0 -12
- package/docs/api/variables/DOUBLE_RATCHET_SPEC.md +0 -11
- package/docs/api/variables/GROUP_ID_PREFIX.md +0 -11
- package/docs/api/variables/GROUP_TRUST_ROOT_VERSION.md +0 -11
- package/docs/api/variables/KEY_REFRESH_INTERVAL_MS_DEFAULT.md +0 -11
- package/docs/api/variables/MAX_MESSAGE_KEYS.md +0 -14
- package/docs/api/variables/MAX_PREKEY_AGE_MS_DEFAULT.md +0 -11
- package/docs/api/variables/MAX_RECEIVER_CHAINS.md +0 -14
- package/docs/api/variables/MAX_REGISTRATION_ID.md +0 -16
- package/docs/api/variables/MAX_SKIP.md +0 -11
- package/docs/api/variables/MESSAGE_FORMAT.md +0 -11
- package/docs/api/variables/MIN_REGISTRATION_ID.md +0 -16
- package/docs/api/variables/ML_KEM_BRAID_SPEC.md +0 -11
- package/docs/api/variables/ONE_TIME_PREKEY_BATCH_SIZE.md +0 -21
- package/docs/api/variables/PQXDH_SPEC.md +0 -11
- package/docs/api/variables/PostQuantumPolicy.md +0 -21
- package/docs/api/variables/SENDER_KEY_FORMAT.md +0 -11
- package/docs/api/variables/SENDER_KEY_SPEC.md +0 -11
- package/docs/api/variables/SESAME_SPEC.md +0 -11
- package/docs/api/variables/SESSION_FORMAT.md +0 -11
- package/docs/api/variables/SPQR_LIMITS_DEFAULTS.md +0 -11
- package/docs/api/variables/X3DH_SPEC.md +0 -9
- package/docs/api/variables/defaultSignalProtocolLogger.md +0 -32
- package/remote/relay/convex/server/README.md +0 -146
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / IdentityKeyPair
|
|
6
|
-
|
|
7
|
-
# Interface: IdentityKeyPair
|
|
8
|
-
|
|
9
|
-
Identity key pair (long-lived, per-user)
|
|
10
|
-
|
|
11
|
-
The SDK's independent composite profile deliberately uses separate standard
|
|
12
|
-
keys for DH and signatures:
|
|
13
|
-
- dhKey: Used for X3DH key exchange (DH1 operation)
|
|
14
|
-
- signingKey: Used for signing prekeys
|
|
15
|
-
- registrationId: Random ID generated once per app install
|
|
16
|
-
|
|
17
|
-
## Properties
|
|
18
|
-
|
|
19
|
-
### dhKey
|
|
20
|
-
|
|
21
|
-
> **dhKey**: [`KeyPair`](KeyPair.md)
|
|
22
|
-
|
|
23
|
-
X25519 key pair for Diffie-Hellman
|
|
24
|
-
|
|
25
|
-
***
|
|
26
|
-
|
|
27
|
-
### registrationId
|
|
28
|
-
|
|
29
|
-
> **registrationId**: `number`
|
|
30
|
-
|
|
31
|
-
Registration ID - Random 16-bit integer generated once per app install.
|
|
32
|
-
|
|
33
|
-
Used to detect session resets when a device reinstalls the app.
|
|
34
|
-
Changes on reinstall to invalidate old sessions and prevent replay attacks.
|
|
35
|
-
|
|
36
|
-
From Signal Protocol:
|
|
37
|
-
"Registration IDs help detect stale sessions from previous installations"
|
|
38
|
-
|
|
39
|
-
#### See
|
|
40
|
-
|
|
41
|
-
https://signal.org/docs/specifications/x3dh/#registration-id
|
|
42
|
-
|
|
43
|
-
***
|
|
44
|
-
|
|
45
|
-
### signingKey
|
|
46
|
-
|
|
47
|
-
> **signingKey**: [`KeyPair`](KeyPair.md)
|
|
48
|
-
|
|
49
|
-
Ed25519 signing key pair for signatures
|
|
@@ -1,91 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / IncomingEnvelope
|
|
6
|
-
|
|
7
|
-
# Interface: IncomingEnvelope
|
|
8
|
-
|
|
9
|
-
Incoming message envelope structure.
|
|
10
|
-
|
|
11
|
-
Matches both relay subscription envelopes and background pending messages.
|
|
12
|
-
Used by processIncomingEnvelope() for unified message handling.
|
|
13
|
-
|
|
14
|
-
## Properties
|
|
15
|
-
|
|
16
|
-
### ciphertext
|
|
17
|
-
|
|
18
|
-
> **ciphertext**: `string`
|
|
19
|
-
|
|
20
|
-
Base64-encoded ciphertext
|
|
21
|
-
|
|
22
|
-
***
|
|
23
|
-
|
|
24
|
-
### contentHint?
|
|
25
|
-
|
|
26
|
-
> `optional` **contentHint?**: [`ContentHint`](../enumerations/ContentHint.md)
|
|
27
|
-
|
|
28
|
-
Content hint for retry behavior per Signal Protocol.
|
|
29
|
-
|
|
30
|
-
- IMPLICIT: Ephemeral messages (typing indicators, receipts) - silently discard on failure
|
|
31
|
-
- RESENDABLE: Content messages - can trigger retry requests
|
|
32
|
-
- DEFAULT: Standard handling
|
|
33
|
-
|
|
34
|
-
If not set, behavior is inferred from messageType via IMPLICIT_ENVELOPE_TYPES.
|
|
35
|
-
|
|
36
|
-
***
|
|
37
|
-
|
|
38
|
-
### groupId?
|
|
39
|
-
|
|
40
|
-
> `optional` **groupId?**: `string`
|
|
41
|
-
|
|
42
|
-
Group ID for group messages
|
|
43
|
-
|
|
44
|
-
***
|
|
45
|
-
|
|
46
|
-
### id
|
|
47
|
-
|
|
48
|
-
> **id**: `string`
|
|
49
|
-
|
|
50
|
-
Server-assigned message ID
|
|
51
|
-
|
|
52
|
-
***
|
|
53
|
-
|
|
54
|
-
### messageType?
|
|
55
|
-
|
|
56
|
-
> `optional` **messageType?**: `string`
|
|
57
|
-
|
|
58
|
-
Message type for filtering (ciphertext, prekey_bundle, etc.)
|
|
59
|
-
|
|
60
|
-
***
|
|
61
|
-
|
|
62
|
-
### senderDeviceId
|
|
63
|
-
|
|
64
|
-
> **senderDeviceId**: `number`
|
|
65
|
-
|
|
66
|
-
Sender's device ID
|
|
67
|
-
|
|
68
|
-
***
|
|
69
|
-
|
|
70
|
-
### senderUserId
|
|
71
|
-
|
|
72
|
-
> **senderUserId**: `string`
|
|
73
|
-
|
|
74
|
-
Sender's user ID (Convex _id)
|
|
75
|
-
|
|
76
|
-
***
|
|
77
|
-
|
|
78
|
-
### serverTimestamp?
|
|
79
|
-
|
|
80
|
-
> `optional` **serverTimestamp?**: `number`
|
|
81
|
-
|
|
82
|
-
Server timestamp when message was received
|
|
83
|
-
|
|
84
|
-
***
|
|
85
|
-
|
|
86
|
-
### timestamp
|
|
87
|
-
|
|
88
|
-
> **timestamp**: `number`
|
|
89
|
-
|
|
90
|
-
Client timestamp for message identification.
|
|
91
|
-
Set by sender BEFORE encryption. Used for retry requests and replay prevention.
|
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / InspectedSignalProtocolContent
|
|
6
|
-
|
|
7
|
-
# Interface: InspectedSignalProtocolContent
|
|
8
|
-
|
|
9
|
-
## Properties
|
|
10
|
-
|
|
11
|
-
### conversationId?
|
|
12
|
-
|
|
13
|
-
> `optional` **conversationId?**: `string`
|
|
14
|
-
|
|
15
|
-
***
|
|
16
|
-
|
|
17
|
-
### receipt
|
|
18
|
-
|
|
19
|
-
> **receipt**: [`ParsedReceiptContent`](ParsedReceiptContent.md) \| `null`
|
|
20
|
-
|
|
21
|
-
***
|
|
22
|
-
|
|
23
|
-
### shouldSendDeliveryReceipt
|
|
24
|
-
|
|
25
|
-
> **shouldSendDeliveryReceipt**: `boolean`
|
|
26
|
-
|
|
27
|
-
***
|
|
28
|
-
|
|
29
|
-
### sync
|
|
30
|
-
|
|
31
|
-
> **sync**: `ParsedSyncContent` \| `null`
|
|
32
|
-
|
|
33
|
-
***
|
|
34
|
-
|
|
35
|
-
### timestamp?
|
|
36
|
-
|
|
37
|
-
> `optional` **timestamp?**: `number`
|
|
38
|
-
|
|
39
|
-
***
|
|
40
|
-
|
|
41
|
-
### typing
|
|
42
|
-
|
|
43
|
-
> **typing**: [`ParsedTypingContent`](ParsedTypingContent.md) \| `null`
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / KDFChain
|
|
6
|
-
|
|
7
|
-
# Interface: KDFChain
|
|
8
|
-
|
|
9
|
-
KDF Chain state for SPQR.
|
|
10
|
-
|
|
11
|
-
Each epoch maintains separate KDF chains for sending and receiving.
|
|
12
|
-
KDF chains derive message keys from a chain key using KDF_CK().
|
|
13
|
-
|
|
14
|
-
Signal Protocol Section 5.3:
|
|
15
|
-
"Each epoch e has two KDF chains: one for sending and one for receiving"
|
|
16
|
-
|
|
17
|
-
## Properties
|
|
18
|
-
|
|
19
|
-
### CK
|
|
20
|
-
|
|
21
|
-
> **CK**: [`Base64`](../type-aliases/Base64.md)
|
|
22
|
-
|
|
23
|
-
Chain key (derives message keys)
|
|
24
|
-
|
|
25
|
-
***
|
|
26
|
-
|
|
27
|
-
### N
|
|
28
|
-
|
|
29
|
-
> **N**: `number`
|
|
30
|
-
|
|
31
|
-
Message counter (number of keys derived from this chain)
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / KemLastResortPreKeyUpload
|
|
6
|
-
|
|
7
|
-
# Interface: KemLastResortPreKeyUpload
|
|
8
|
-
|
|
9
|
-
KEM last-resort prekey upload for key rotation.
|
|
10
|
-
Contains the full key including private key for local storage.
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### deviceId
|
|
15
|
-
|
|
16
|
-
> **deviceId**: `number`
|
|
17
|
-
|
|
18
|
-
Device ID (1=primary, 2-5=linked)
|
|
19
|
-
|
|
20
|
-
***
|
|
21
|
-
|
|
22
|
-
### keyId
|
|
23
|
-
|
|
24
|
-
> **keyId**: `number`
|
|
25
|
-
|
|
26
|
-
Key ID (always 1 per PQXDH spec Section 3.2)
|
|
27
|
-
|
|
28
|
-
***
|
|
29
|
-
|
|
30
|
-
### publicKey
|
|
31
|
-
|
|
32
|
-
> **publicKey**: `string`
|
|
33
|
-
|
|
34
|
-
Public key (base64 encoded, ~1.5KB for ML-KEM-1024)
|
|
35
|
-
|
|
36
|
-
***
|
|
37
|
-
|
|
38
|
-
### signature
|
|
39
|
-
|
|
40
|
-
> **signature**: `string`
|
|
41
|
-
|
|
42
|
-
Signature from identity key (base64 encoded)
|
|
43
|
-
|
|
44
|
-
***
|
|
45
|
-
|
|
46
|
-
### timestamp
|
|
47
|
-
|
|
48
|
-
> **timestamp**: `number`
|
|
49
|
-
|
|
50
|
-
Timestamp when generated
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / KeyPair
|
|
6
|
-
|
|
7
|
-
# Interface: KeyPair
|
|
8
|
-
|
|
9
|
-
Generic key pair (public + private).
|
|
10
|
-
|
|
11
|
-
Used for X25519 (ECDH) and Ed25519 (signing) key pairs.
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
### privateKey
|
|
16
|
-
|
|
17
|
-
> **privateKey**: [`PrivateKey`](../type-aliases/PrivateKey.md)
|
|
18
|
-
|
|
19
|
-
***
|
|
20
|
-
|
|
21
|
-
### publicKey
|
|
22
|
-
|
|
23
|
-
> **publicKey**: [`PublicKey`](../type-aliases/PublicKey.md)
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / KyberPreKey
|
|
6
|
-
|
|
7
|
-
# Interface: KyberPreKey
|
|
8
|
-
|
|
9
|
-
ML-KEM-1024 prekey (historical public name, rotates weekly)
|
|
10
|
-
|
|
11
|
-
`KyberPreKey` is retained as an API identifier, but the bytes are standardized
|
|
12
|
-
ML-KEM-1024 with the profile's mandatory `0x0A` serialization.
|
|
13
|
-
|
|
14
|
-
## Properties
|
|
15
|
-
|
|
16
|
-
### keyId
|
|
17
|
-
|
|
18
|
-
> **keyId**: `number`
|
|
19
|
-
|
|
20
|
-
***
|
|
21
|
-
|
|
22
|
-
### privateKey
|
|
23
|
-
|
|
24
|
-
> **privateKey**: [`PrivateKey`](../type-aliases/PrivateKey.md)
|
|
25
|
-
|
|
26
|
-
***
|
|
27
|
-
|
|
28
|
-
### publicKey
|
|
29
|
-
|
|
30
|
-
> **publicKey**: [`PublicKey`](../type-aliases/PublicKey.md)
|
|
31
|
-
|
|
32
|
-
***
|
|
33
|
-
|
|
34
|
-
### signature
|
|
35
|
-
|
|
36
|
-
> **signature**: [`Signature`](../type-aliases/Signature.md)
|
|
37
|
-
|
|
38
|
-
***
|
|
39
|
-
|
|
40
|
-
### timestamp
|
|
41
|
-
|
|
42
|
-
> **timestamp**: `number`
|
|
@@ -1,191 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / MLKEMBraidAgentState
|
|
6
|
-
|
|
7
|
-
# Interface: MLKEMBraidAgentState
|
|
8
|
-
|
|
9
|
-
Unified ML-KEM Braid agent state
|
|
10
|
-
|
|
11
|
-
The state name determines the current role — no `role` field needed.
|
|
12
|
-
This matches the `SPQR` pattern where the state variant
|
|
13
|
-
is the role.
|
|
14
|
-
|
|
15
|
-
Use isInAliceRole(state) / isInBobRole(state) to check current role.
|
|
16
|
-
|
|
17
|
-
## Extends
|
|
18
|
-
|
|
19
|
-
- `MLKEMBraidBaseState`
|
|
20
|
-
|
|
21
|
-
## Properties
|
|
22
|
-
|
|
23
|
-
### auth
|
|
24
|
-
|
|
25
|
-
> **auth**: `AuthenticatorState`
|
|
26
|
-
|
|
27
|
-
Authenticator state
|
|
28
|
-
|
|
29
|
-
#### Inherited from
|
|
30
|
-
|
|
31
|
-
`MLKEMBraidBaseState.auth`
|
|
32
|
-
|
|
33
|
-
***
|
|
34
|
-
|
|
35
|
-
### ct1?
|
|
36
|
-
|
|
37
|
-
> `optional` **ct1?**: `Uint8Array`\<`ArrayBufferLike`\>
|
|
38
|
-
|
|
39
|
-
First ciphertext component (960 bytes)
|
|
40
|
-
|
|
41
|
-
***
|
|
42
|
-
|
|
43
|
-
### ct1\_decoded?
|
|
44
|
-
|
|
45
|
-
> `optional` **ct1\_decoded?**: `Uint8Array`\<`ArrayBufferLike`\>
|
|
46
|
-
|
|
47
|
-
Decoded CT1 stored for combined MAC verification with CT2
|
|
48
|
-
|
|
49
|
-
***
|
|
50
|
-
|
|
51
|
-
### ct1\_for\_mac?
|
|
52
|
-
|
|
53
|
-
> `optional` **ct1\_for\_mac?**: `Uint8Array`\<`ArrayBufferLike`\>
|
|
54
|
-
|
|
55
|
-
CT1 copy stored for combined MAC computation with CT2 (the reference implementation authenticates ct1||ct2)
|
|
56
|
-
|
|
57
|
-
***
|
|
58
|
-
|
|
59
|
-
### ct1Decoder?
|
|
60
|
-
|
|
61
|
-
> `optional` **ct1Decoder?**: `DecoderState`
|
|
62
|
-
|
|
63
|
-
CT1 decoder state
|
|
64
|
-
|
|
65
|
-
***
|
|
66
|
-
|
|
67
|
-
### ct1Encoder?
|
|
68
|
-
|
|
69
|
-
> `optional` **ct1Encoder?**: `EncoderState`
|
|
70
|
-
|
|
71
|
-
CT1 encoder state
|
|
72
|
-
|
|
73
|
-
***
|
|
74
|
-
|
|
75
|
-
### ct2?
|
|
76
|
-
|
|
77
|
-
> `optional` **ct2?**: `Uint8Array`\<`ArrayBufferLike`\>
|
|
78
|
-
|
|
79
|
-
Second ciphertext component (128 bytes)
|
|
80
|
-
|
|
81
|
-
***
|
|
82
|
-
|
|
83
|
-
### ct2Decoder?
|
|
84
|
-
|
|
85
|
-
> `optional` **ct2Decoder?**: `DecoderState`
|
|
86
|
-
|
|
87
|
-
CT2 decoder state
|
|
88
|
-
|
|
89
|
-
***
|
|
90
|
-
|
|
91
|
-
### ct2Encoder?
|
|
92
|
-
|
|
93
|
-
> `optional` **ct2Encoder?**: `EncoderState`
|
|
94
|
-
|
|
95
|
-
CT2 encoder state
|
|
96
|
-
|
|
97
|
-
***
|
|
98
|
-
|
|
99
|
-
### dk?
|
|
100
|
-
|
|
101
|
-
> `optional` **dk?**: `Uint8Array`\<`ArrayBufferLike`\>
|
|
102
|
-
|
|
103
|
-
Decapsulation key (private, 2400 bytes)
|
|
104
|
-
|
|
105
|
-
***
|
|
106
|
-
|
|
107
|
-
### ek\_seed?
|
|
108
|
-
|
|
109
|
-
> `optional` **ek\_seed?**: `Uint8Array`\<`ArrayBufferLike`\>
|
|
110
|
-
|
|
111
|
-
Encapsulation key seed (32 bytes)
|
|
112
|
-
|
|
113
|
-
***
|
|
114
|
-
|
|
115
|
-
### ek\_vector?
|
|
116
|
-
|
|
117
|
-
> `optional` **ek\_vector?**: `Uint8Array`\<`ArrayBufferLike`\>
|
|
118
|
-
|
|
119
|
-
Encapsulation key vector (1152 bytes)
|
|
120
|
-
|
|
121
|
-
***
|
|
122
|
-
|
|
123
|
-
### ekDecoder?
|
|
124
|
-
|
|
125
|
-
> `optional` **ekDecoder?**: `DecoderState`
|
|
126
|
-
|
|
127
|
-
EK vector decoder state
|
|
128
|
-
|
|
129
|
-
***
|
|
130
|
-
|
|
131
|
-
### ekEncoder?
|
|
132
|
-
|
|
133
|
-
> `optional` **ekEncoder?**: `EncoderState`
|
|
134
|
-
|
|
135
|
-
EK vector encoder state
|
|
136
|
-
|
|
137
|
-
***
|
|
138
|
-
|
|
139
|
-
### encaps\_secret?
|
|
140
|
-
|
|
141
|
-
> `optional` **encaps\_secret?**: `Uint8Array`\<`ArrayBufferLike`\>
|
|
142
|
-
|
|
143
|
-
One-shot Encaps1 state; owned bytes are consumed and best-effort overwritten by Encaps2.
|
|
144
|
-
|
|
145
|
-
***
|
|
146
|
-
|
|
147
|
-
### epoch
|
|
148
|
-
|
|
149
|
-
> **epoch**: `bigint`
|
|
150
|
-
|
|
151
|
-
Current epoch number
|
|
152
|
-
|
|
153
|
-
#### Inherited from
|
|
154
|
-
|
|
155
|
-
`MLKEMBraidBaseState.epoch`
|
|
156
|
-
|
|
157
|
-
***
|
|
158
|
-
|
|
159
|
-
### headerDecoder?
|
|
160
|
-
|
|
161
|
-
> `optional` **headerDecoder?**: `DecoderState`
|
|
162
|
-
|
|
163
|
-
Header decoder state
|
|
164
|
-
|
|
165
|
-
***
|
|
166
|
-
|
|
167
|
-
### headerEncoder?
|
|
168
|
-
|
|
169
|
-
> `optional` **headerEncoder?**: `EncoderState`
|
|
170
|
-
|
|
171
|
-
Header encoder state
|
|
172
|
-
|
|
173
|
-
***
|
|
174
|
-
|
|
175
|
-
### hek?
|
|
176
|
-
|
|
177
|
-
> `optional` **hek?**: `Uint8Array`\<`ArrayBufferLike`\>
|
|
178
|
-
|
|
179
|
-
Specification HEK: SHA3-256(ek_seed || ek_vector)
|
|
180
|
-
|
|
181
|
-
***
|
|
182
|
-
|
|
183
|
-
### state
|
|
184
|
-
|
|
185
|
-
> **state**: `MLKEMBraidState`
|
|
186
|
-
|
|
187
|
-
Current state machine state
|
|
188
|
-
|
|
189
|
-
#### Inherited from
|
|
190
|
-
|
|
191
|
-
`MLKEMBraidBaseState.state`
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / MLKEMBraidMessage
|
|
6
|
-
|
|
7
|
-
# Interface: MLKEMBraidMessage
|
|
8
|
-
|
|
9
|
-
ML-KEM Braid protocol message
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### chunkIndex?
|
|
14
|
-
|
|
15
|
-
> `optional` **chunkIndex?**: `number`
|
|
16
|
-
|
|
17
|
-
Chunk index for out-of-order delivery support (0-based)
|
|
18
|
-
|
|
19
|
-
***
|
|
20
|
-
|
|
21
|
-
### data?
|
|
22
|
-
|
|
23
|
-
> `optional` **data?**: `Uint8Array`\<`ArrayBufferLike`\>
|
|
24
|
-
|
|
25
|
-
Erasure code chunk (when applicable)
|
|
26
|
-
|
|
27
|
-
***
|
|
28
|
-
|
|
29
|
-
### epoch
|
|
30
|
-
|
|
31
|
-
> **epoch**: `bigint`
|
|
32
|
-
|
|
33
|
-
Current negotiation epoch (uint64)
|
|
34
|
-
|
|
35
|
-
***
|
|
36
|
-
|
|
37
|
-
### type
|
|
38
|
-
|
|
39
|
-
> **type**: `MessageType`
|
|
40
|
-
|
|
41
|
-
Message type
|
|
42
|
-
|
|
43
|
-
***
|
|
44
|
-
|
|
45
|
-
### versionCapability?
|
|
46
|
-
|
|
47
|
-
> `optional` **versionCapability?**: `VersionCapability`
|
|
48
|
-
|
|
49
|
-
Version capability (only during negotiation)
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / MediaAttachmentDeleteSyncInput
|
|
6
|
-
|
|
7
|
-
# Interface: MediaAttachmentDeleteSyncInput
|
|
8
|
-
|
|
9
|
-
## Properties
|
|
10
|
-
|
|
11
|
-
### attachmentId
|
|
12
|
-
|
|
13
|
-
> **attachmentId**: `string`
|
|
14
|
-
|
|
15
|
-
***
|
|
16
|
-
|
|
17
|
-
### deletedAt
|
|
18
|
-
|
|
19
|
-
> **deletedAt**: `number`
|
|
20
|
-
|
|
21
|
-
***
|
|
22
|
-
|
|
23
|
-
### reason
|
|
24
|
-
|
|
25
|
-
> **reason**: [`MediaAttachmentCleanupReason`](../namespaces/media/type-aliases/MediaAttachmentCleanupReason.md)
|
|
26
|
-
|
|
27
|
-
***
|
|
28
|
-
|
|
29
|
-
### storageId
|
|
30
|
-
|
|
31
|
-
> **storageId**: `string`
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / MessageHeader
|
|
6
|
-
|
|
7
|
-
# Interface: MessageHeader
|
|
8
|
-
|
|
9
|
-
Double Ratchet message header
|
|
10
|
-
|
|
11
|
-
Contains metadata needed for DH ratcheting and out-of-order message handling.
|
|
12
|
-
This header is sent with every encrypted message.
|
|
13
|
-
|
|
14
|
-
Field names reflect the SignalProtocolMessage wire fields:
|
|
15
|
-
|
|
16
|
-
## Properties
|
|
17
|
-
|
|
18
|
-
### counter
|
|
19
|
-
|
|
20
|
-
> **counter**: `number`
|
|
21
|
-
|
|
22
|
-
Message counter within the current sending chain (proto: counter, field 2).
|
|
23
|
-
|
|
24
|
-
Increments with each message sent. Used for:
|
|
25
|
-
- Deriving message keys from the chain key
|
|
26
|
-
- Detecting out-of-order and missing messages
|
|
27
|
-
- Indexing skipped message keys in MKSKIPPED
|
|
28
|
-
|
|
29
|
-
***
|
|
30
|
-
|
|
31
|
-
### previousCounter
|
|
32
|
-
|
|
33
|
-
> **previousCounter**: `number`
|
|
34
|
-
|
|
35
|
-
Number of messages in the previous sending chain (proto: previous_counter, field 3).
|
|
36
|
-
|
|
37
|
-
When a DH ratchet occurs, this tells the recipient how many messages
|
|
38
|
-
were sent in the previous chain, allowing them to store skipped keys.
|
|
39
|
-
|
|
40
|
-
***
|
|
41
|
-
|
|
42
|
-
### ratchetKey
|
|
43
|
-
|
|
44
|
-
> **ratchetKey**: [`PublicKey`](../type-aliases/PublicKey.md)
|
|
45
|
-
|
|
46
|
-
Sender's current ratchet public key (proto: ratchet_key, field 1).
|
|
47
|
-
|
|
48
|
-
This is the ephemeral DH public key used in the Double Ratchet algorithm.
|
|
49
|
-
When this changes, the recipient performs a DH ratchet step.
|