@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.
- package/ADAPTERS.md +1 -1
- package/CHANGELOG.md +767 -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 +37 -5
- package/dist/internal/groups/manager.d.ts.map +1 -1
- package/dist/internal/groups/manager.js +98 -15
- package/dist/internal/groups/manager.js.map +1 -1
- package/dist/internal/groups/server-engine.d.ts +48 -2
- package/dist/internal/groups/server-engine.d.ts.map +1 -1
- package/dist/internal/groups/server-engine.js +122 -13
- 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/node/adapter.d.ts +53 -4
- package/dist/local/store/node/adapter.d.ts.map +1 -1
- package/dist/local/store/node/adapter.js +456 -9
- package/dist/local/store/node/adapter.js.map +1 -1
- package/dist/local/store/node/database.d.ts +68 -0
- package/dist/local/store/node/database.d.ts.map +1 -1
- package/dist/local/store/node/database.js +201 -18
- package/dist/local/store/node/database.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 +405 -0
- package/dist/remote/relay/convex/backend.d.ts.map +1 -0
- package/dist/remote/relay/convex/backend.js +687 -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 +483 -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 +32 -0
- package/dist/remote/relay/convex/component/cleanup.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/cleanup.js +146 -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 +10 -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 +63 -0
- package/dist/remote/relay/convex/component/groups.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/groups.js +341 -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 +723 -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 +358 -0
- package/dist/remote/relay/convex/component/schema.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/schema.js +287 -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 +9 -6
- package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
- package/dist/remote/relay/convex/group-server.js +17 -11
- 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 +44 -65
- package/dist/remote/relay/convex/relay.d.ts.map +1 -1
- package/dist/remote/relay/convex/relay.js +61 -36
- 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 +4 -9
- package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
- package/dist/remote/relay/mock/adapter.js +39 -22
- package/dist/remote/relay/mock/adapter.js.map +1 -1
- package/dist/remote/relay/types.d.ts +57 -75
- 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/README.md +3 -1
- package/local/store/expo/README.md +10 -1
- package/local/store/node/README.md +8 -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,93 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / SendResult
|
|
6
|
-
|
|
7
|
-
# Interface: SendResult
|
|
8
|
-
|
|
9
|
-
Result from SignalProtocolClient.send()
|
|
10
|
-
|
|
11
|
-
Provides uniform response regardless of content type (string/Blob) or
|
|
12
|
-
recipient type (user/group).
|
|
13
|
-
|
|
14
|
-
## Properties
|
|
15
|
-
|
|
16
|
-
### aesKey?
|
|
17
|
-
|
|
18
|
-
> `optional` **aesKey?**: `string`
|
|
19
|
-
|
|
20
|
-
Base64-encoded AES-256 master key
|
|
21
|
-
|
|
22
|
-
***
|
|
23
|
-
|
|
24
|
-
### clientTimestamp?
|
|
25
|
-
|
|
26
|
-
> `optional` **clientTimestamp?**: `number`
|
|
27
|
-
|
|
28
|
-
Client timestamp from the proto.
|
|
29
|
-
Use this for storing outgoing messages to enable receipt matching.
|
|
30
|
-
|
|
31
|
-
***
|
|
32
|
-
|
|
33
|
-
### contentType?
|
|
34
|
-
|
|
35
|
-
> `optional` **contentType?**: `string`
|
|
36
|
-
|
|
37
|
-
MIME content type for the encrypted media
|
|
38
|
-
|
|
39
|
-
***
|
|
40
|
-
|
|
41
|
-
### digest?
|
|
42
|
-
|
|
43
|
-
> `optional` **digest?**: `string`
|
|
44
|
-
|
|
45
|
-
Base64-encoded SHA-256 digest for the encrypted blob
|
|
46
|
-
|
|
47
|
-
***
|
|
48
|
-
|
|
49
|
-
### groupId?
|
|
50
|
-
|
|
51
|
-
> `optional` **groupId?**: `string`
|
|
52
|
-
|
|
53
|
-
Group ID if sent to a group
|
|
54
|
-
|
|
55
|
-
***
|
|
56
|
-
|
|
57
|
-
### messageId
|
|
58
|
-
|
|
59
|
-
> **messageId**: `string`
|
|
60
|
-
|
|
61
|
-
Server-assigned message ID for tracking and markAsRead()
|
|
62
|
-
|
|
63
|
-
***
|
|
64
|
-
|
|
65
|
-
### recipientDeviceCount
|
|
66
|
-
|
|
67
|
-
> **recipientDeviceCount**: `number`
|
|
68
|
-
|
|
69
|
-
Number of recipient devices that received the message
|
|
70
|
-
|
|
71
|
-
***
|
|
72
|
-
|
|
73
|
-
### segmentSize?
|
|
74
|
-
|
|
75
|
-
> `optional` **segmentSize?**: `number`
|
|
76
|
-
|
|
77
|
-
Segment size for streaming AEAD format
|
|
78
|
-
|
|
79
|
-
***
|
|
80
|
-
|
|
81
|
-
### storageId?
|
|
82
|
-
|
|
83
|
-
> `optional` **storageId?**: `string`
|
|
84
|
-
|
|
85
|
-
Opaque remote object identifier for the encrypted attachment
|
|
86
|
-
|
|
87
|
-
***
|
|
88
|
-
|
|
89
|
-
### timestamp
|
|
90
|
-
|
|
91
|
-
> **timestamp**: `number`
|
|
92
|
-
|
|
93
|
-
Server timestamp when message was accepted
|
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / SenderKeyDistributionMessage
|
|
6
|
-
|
|
7
|
-
# Interface: SenderKeyDistributionMessage
|
|
8
|
-
|
|
9
|
-
## Properties
|
|
10
|
-
|
|
11
|
-
### chainId
|
|
12
|
-
|
|
13
|
-
> **chainId**: `number`
|
|
14
|
-
|
|
15
|
-
***
|
|
16
|
-
|
|
17
|
-
### chainIndex
|
|
18
|
-
|
|
19
|
-
> **chainIndex**: `number`
|
|
20
|
-
|
|
21
|
-
***
|
|
22
|
-
|
|
23
|
-
### chainKey
|
|
24
|
-
|
|
25
|
-
> **chainKey**: `string`
|
|
26
|
-
|
|
27
|
-
***
|
|
28
|
-
|
|
29
|
-
### generation
|
|
30
|
-
|
|
31
|
-
> **generation**: `number`
|
|
32
|
-
|
|
33
|
-
***
|
|
34
|
-
|
|
35
|
-
### publicSignatureKey
|
|
36
|
-
|
|
37
|
-
> **publicSignatureKey**: `string`
|
|
38
|
-
|
|
39
|
-
***
|
|
40
|
-
|
|
41
|
-
### senderKeyId
|
|
42
|
-
|
|
43
|
-
> **senderKeyId**: `string`
|
|
@@ -1,76 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / SenderKeyState
|
|
6
|
-
|
|
7
|
-
# Interface: SenderKeyState
|
|
8
|
-
|
|
9
|
-
## Properties
|
|
10
|
-
|
|
11
|
-
### chainId
|
|
12
|
-
|
|
13
|
-
> **chainId**: `number`
|
|
14
|
-
|
|
15
|
-
Chain identifier serialized as uint32 field 2.
|
|
16
|
-
|
|
17
|
-
Derived deterministically from senderKeyId via FNV-1a hash.
|
|
18
|
-
Included in protobuf-encoded messages for wire compatibility.
|
|
19
|
-
|
|
20
|
-
***
|
|
21
|
-
|
|
22
|
-
### chainIndex
|
|
23
|
-
|
|
24
|
-
> **chainIndex**: `number`
|
|
25
|
-
|
|
26
|
-
***
|
|
27
|
-
|
|
28
|
-
### chainKey
|
|
29
|
-
|
|
30
|
-
> **chainKey**: `string`
|
|
31
|
-
|
|
32
|
-
***
|
|
33
|
-
|
|
34
|
-
### createdAt
|
|
35
|
-
|
|
36
|
-
> **createdAt**: `number`
|
|
37
|
-
|
|
38
|
-
Creation timestamp (ms since epoch) for time-based rotation.
|
|
39
|
-
|
|
40
|
-
Only locally created encryption keys are checked for expiration. Received
|
|
41
|
-
decryption keys remain usable for delayed messages.
|
|
42
|
-
|
|
43
|
-
***
|
|
44
|
-
|
|
45
|
-
### generation
|
|
46
|
-
|
|
47
|
-
> **generation**: `number`
|
|
48
|
-
|
|
49
|
-
***
|
|
50
|
-
|
|
51
|
-
### publicSignatureKey
|
|
52
|
-
|
|
53
|
-
> **publicSignatureKey**: `string`
|
|
54
|
-
|
|
55
|
-
***
|
|
56
|
-
|
|
57
|
-
### senderKeyId
|
|
58
|
-
|
|
59
|
-
> **senderKeyId**: `string`
|
|
60
|
-
|
|
61
|
-
***
|
|
62
|
-
|
|
63
|
-
### senderKeyVersion
|
|
64
|
-
|
|
65
|
-
> **senderKeyVersion**: `string`
|
|
66
|
-
|
|
67
|
-
Sender key wire format version for protocol evolution.
|
|
68
|
-
|
|
69
|
-
Format 'v1' (current): Ed25519 signatures, AES-256-CBC encryption
|
|
70
|
-
Future versions may support format changes or algorithm upgrades.
|
|
71
|
-
|
|
72
|
-
***
|
|
73
|
-
|
|
74
|
-
### signatureKey
|
|
75
|
-
|
|
76
|
-
> **signatureKey**: `string`
|
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / SenderKeysConfig
|
|
6
|
-
|
|
7
|
-
# Interface: SenderKeysConfig
|
|
8
|
-
|
|
9
|
-
Sender Keys (group messaging) configuration options.
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### hkdfInfoString?
|
|
14
|
-
|
|
15
|
-
> `optional` **hkdfInfoString?**: `string`
|
|
16
|
-
|
|
17
|
-
HKDF info string for message key derivation.
|
|
18
|
-
|
|
19
|
-
#### Default
|
|
20
|
-
|
|
21
|
-
```ts
|
|
22
|
-
"WhisperGroup"
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
***
|
|
26
|
-
|
|
27
|
-
### maxChainAdvance?
|
|
28
|
-
|
|
29
|
-
> `optional` **maxChainAdvance?**: `number`
|
|
30
|
-
|
|
31
|
-
Maximum chain advancement per message.
|
|
32
|
-
|
|
33
|
-
#### Default
|
|
34
|
-
|
|
35
|
-
```ts
|
|
36
|
-
25000
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
***
|
|
40
|
-
|
|
41
|
-
### maxSenderKeyAge?
|
|
42
|
-
|
|
43
|
-
> `optional` **maxSenderKeyAge?**: `number`
|
|
44
|
-
|
|
45
|
-
Maximum age for locally generated sender keys before rotation.
|
|
46
|
-
|
|
47
|
-
#### Default
|
|
48
|
-
|
|
49
|
-
```ts
|
|
50
|
-
1209600000
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
***
|
|
54
|
-
|
|
55
|
-
### maxSkippedKeys?
|
|
56
|
-
|
|
57
|
-
> `optional` **maxSkippedKeys?**: `number`
|
|
58
|
-
|
|
59
|
-
Maximum skipped message keys to store per sender.
|
|
60
|
-
|
|
61
|
-
#### Default
|
|
62
|
-
|
|
63
|
-
```ts
|
|
64
|
-
2000
|
|
65
|
-
```
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / SentSyncTranscriptInput
|
|
6
|
-
|
|
7
|
-
# Interface: SentSyncTranscriptInput
|
|
8
|
-
|
|
9
|
-
## Properties
|
|
10
|
-
|
|
11
|
-
### conversationId
|
|
12
|
-
|
|
13
|
-
> **conversationId**: `string`
|
|
14
|
-
|
|
15
|
-
***
|
|
16
|
-
|
|
17
|
-
### recipientUserId?
|
|
18
|
-
|
|
19
|
-
> `optional` **recipientUserId?**: `string`
|
|
20
|
-
|
|
21
|
-
***
|
|
22
|
-
|
|
23
|
-
### serializedContent
|
|
24
|
-
|
|
25
|
-
> **serializedContent**: `Uint8Array`
|
|
26
|
-
|
|
27
|
-
***
|
|
28
|
-
|
|
29
|
-
### timestamp
|
|
30
|
-
|
|
31
|
-
> **timestamp**: `number`
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / ServiceId
|
|
6
|
-
|
|
7
|
-
# Interface: ServiceId
|
|
8
|
-
|
|
9
|
-
## Properties
|
|
10
|
-
|
|
11
|
-
### kind
|
|
12
|
-
|
|
13
|
-
> **kind**: `ServiceIdKind`
|
|
14
|
-
|
|
15
|
-
***
|
|
16
|
-
|
|
17
|
-
### uuid
|
|
18
|
-
|
|
19
|
-
> **uuid**: `Uint8Array`
|
|
@@ -1,84 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / SesameMessage
|
|
6
|
-
|
|
7
|
-
# Interface: SesameMessage
|
|
8
|
-
|
|
9
|
-
SESAME message structure for encrypted communication
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### ciphertext
|
|
14
|
-
|
|
15
|
-
> **ciphertext**: `Uint8Array`
|
|
16
|
-
|
|
17
|
-
Encrypted message ciphertext (from Double Ratchet)
|
|
18
|
-
|
|
19
|
-
***
|
|
20
|
-
|
|
21
|
-
### initHeader
|
|
22
|
-
|
|
23
|
-
> **initHeader**: `Uint8Array`\<`ArrayBufferLike`\> \| `null`
|
|
24
|
-
|
|
25
|
-
X3DH/PQXDH header data for initiating messages
|
|
26
|
-
Null for non-initiating messages
|
|
27
|
-
|
|
28
|
-
***
|
|
29
|
-
|
|
30
|
-
### isInitiating
|
|
31
|
-
|
|
32
|
-
> **isInitiating**: `boolean`
|
|
33
|
-
|
|
34
|
-
Whether this is an initiating message (contains X3DH/PQXDH header)
|
|
35
|
-
|
|
36
|
-
***
|
|
37
|
-
|
|
38
|
-
### recipientDeviceId
|
|
39
|
-
|
|
40
|
-
> **recipientDeviceId**: `number`
|
|
41
|
-
|
|
42
|
-
Recipient's device ID
|
|
43
|
-
|
|
44
|
-
***
|
|
45
|
-
|
|
46
|
-
### recipientUserId
|
|
47
|
-
|
|
48
|
-
> **recipientUserId**: `string`
|
|
49
|
-
|
|
50
|
-
Recipient's user ID
|
|
51
|
-
|
|
52
|
-
***
|
|
53
|
-
|
|
54
|
-
### senderDeviceId
|
|
55
|
-
|
|
56
|
-
> **senderDeviceId**: `number`
|
|
57
|
-
|
|
58
|
-
Sender's device ID
|
|
59
|
-
|
|
60
|
-
***
|
|
61
|
-
|
|
62
|
-
### senderUserId
|
|
63
|
-
|
|
64
|
-
> **senderUserId**: `string`
|
|
65
|
-
|
|
66
|
-
Sender's user ID
|
|
67
|
-
|
|
68
|
-
***
|
|
69
|
-
|
|
70
|
-
### sessionId
|
|
71
|
-
|
|
72
|
-
> **sessionId**: `string`
|
|
73
|
-
|
|
74
|
-
Session ID used for this message
|
|
75
|
-
|
|
76
|
-
***
|
|
77
|
-
|
|
78
|
-
### timestamp
|
|
79
|
-
|
|
80
|
-
> **timestamp**: `number`
|
|
81
|
-
|
|
82
|
-
Client timestamp for message identification.
|
|
83
|
-
Set by sender BEFORE encryption. Same value stored in MessageRecord.
|
|
84
|
-
Used for: retry request matching, delivery receipt correlation.
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / SesameStats
|
|
6
|
-
|
|
7
|
-
# Interface: SesameStats
|
|
8
|
-
|
|
9
|
-
Statistics about SESAME state for debugging/monitoring
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### expiredSessions
|
|
14
|
-
|
|
15
|
-
> **expiredSessions**: `number`
|
|
16
|
-
|
|
17
|
-
Number of sessions eligible for cleanup (age > MAXRECV)
|
|
18
|
-
|
|
19
|
-
***
|
|
20
|
-
|
|
21
|
-
### staleRecords
|
|
22
|
-
|
|
23
|
-
> **staleRecords**: `number`
|
|
24
|
-
|
|
25
|
-
Number of stale device records eligible for cleanup
|
|
26
|
-
|
|
27
|
-
***
|
|
28
|
-
|
|
29
|
-
### totalActiveSessions
|
|
30
|
-
|
|
31
|
-
> **totalActiveSessions**: `number`
|
|
32
|
-
|
|
33
|
-
Total number of active sessions
|
|
34
|
-
|
|
35
|
-
***
|
|
36
|
-
|
|
37
|
-
### totalDevices
|
|
38
|
-
|
|
39
|
-
> **totalDevices**: `number`
|
|
40
|
-
|
|
41
|
-
Total number of device records across all users
|
|
42
|
-
|
|
43
|
-
***
|
|
44
|
-
|
|
45
|
-
### totalInactiveSessions
|
|
46
|
-
|
|
47
|
-
> **totalInactiveSessions**: `number`
|
|
48
|
-
|
|
49
|
-
Total number of inactive sessions
|
|
50
|
-
|
|
51
|
-
***
|
|
52
|
-
|
|
53
|
-
### totalUsers
|
|
54
|
-
|
|
55
|
-
> **totalUsers**: `number`
|
|
56
|
-
|
|
57
|
-
Total number of user records
|
|
@@ -1,120 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / SessionHealthResult
|
|
6
|
-
|
|
7
|
-
# Interface: SessionHealthResult
|
|
8
|
-
|
|
9
|
-
Result from session health check
|
|
10
|
-
|
|
11
|
-
Provides detailed diagnostics about session state, key validity,
|
|
12
|
-
and any issues that may affect encryption.
|
|
13
|
-
|
|
14
|
-
## Properties
|
|
15
|
-
|
|
16
|
-
### checkedAt
|
|
17
|
-
|
|
18
|
-
> **checkedAt**: `number`
|
|
19
|
-
|
|
20
|
-
When this check was performed
|
|
21
|
-
|
|
22
|
-
***
|
|
23
|
-
|
|
24
|
-
### issues
|
|
25
|
-
|
|
26
|
-
> **issues**: `SessionHealthIssue`[]
|
|
27
|
-
|
|
28
|
-
List of issues found
|
|
29
|
-
|
|
30
|
-
***
|
|
31
|
-
|
|
32
|
-
### keyStatus
|
|
33
|
-
|
|
34
|
-
> **keyStatus**: `object`
|
|
35
|
-
|
|
36
|
-
Key status information
|
|
37
|
-
|
|
38
|
-
#### hasIdentityKey
|
|
39
|
-
|
|
40
|
-
> **hasIdentityKey**: `boolean`
|
|
41
|
-
|
|
42
|
-
#### hasKyberPreKey
|
|
43
|
-
|
|
44
|
-
> **hasKyberPreKey**: `boolean`
|
|
45
|
-
|
|
46
|
-
#### hasSignedPreKey
|
|
47
|
-
|
|
48
|
-
> **hasSignedPreKey**: `boolean`
|
|
49
|
-
|
|
50
|
-
#### kyberPreKeyAgeDays
|
|
51
|
-
|
|
52
|
-
> **kyberPreKeyAgeDays**: `number`
|
|
53
|
-
|
|
54
|
-
#### needsRotation
|
|
55
|
-
|
|
56
|
-
> **needsRotation**: `boolean`
|
|
57
|
-
|
|
58
|
-
#### signedPreKeyAgeDays
|
|
59
|
-
|
|
60
|
-
> **signedPreKeyAgeDays**: `number`
|
|
61
|
-
|
|
62
|
-
***
|
|
63
|
-
|
|
64
|
-
### message
|
|
65
|
-
|
|
66
|
-
> **message**: `string`
|
|
67
|
-
|
|
68
|
-
Summary message for UI display
|
|
69
|
-
|
|
70
|
-
***
|
|
71
|
-
|
|
72
|
-
### sessionExists
|
|
73
|
-
|
|
74
|
-
> **sessionExists**: `boolean`
|
|
75
|
-
|
|
76
|
-
Whether a session exists with this user
|
|
77
|
-
|
|
78
|
-
***
|
|
79
|
-
|
|
80
|
-
### sessionStatus?
|
|
81
|
-
|
|
82
|
-
> `optional` **sessionStatus?**: `object`
|
|
83
|
-
|
|
84
|
-
Session-specific status (only if session exists)
|
|
85
|
-
|
|
86
|
-
#### ageDays
|
|
87
|
-
|
|
88
|
-
> **ageDays**: `number`
|
|
89
|
-
|
|
90
|
-
#### createdAt
|
|
91
|
-
|
|
92
|
-
> **createdAt**: `number`
|
|
93
|
-
|
|
94
|
-
#### isExpiredForReceiving
|
|
95
|
-
|
|
96
|
-
> **isExpiredForReceiving**: `boolean`
|
|
97
|
-
|
|
98
|
-
#### isExpiredForSending
|
|
99
|
-
|
|
100
|
-
> **isExpiredForSending**: `boolean`
|
|
101
|
-
|
|
102
|
-
#### lastUsedAt
|
|
103
|
-
|
|
104
|
-
> **lastUsedAt**: `number`
|
|
105
|
-
|
|
106
|
-
#### messagesReceived
|
|
107
|
-
|
|
108
|
-
> **messagesReceived**: `number`
|
|
109
|
-
|
|
110
|
-
#### messagesSent
|
|
111
|
-
|
|
112
|
-
> **messagesSent**: `number`
|
|
113
|
-
|
|
114
|
-
***
|
|
115
|
-
|
|
116
|
-
### status
|
|
117
|
-
|
|
118
|
-
> **status**: `SessionHealthStatus`
|
|
119
|
-
|
|
120
|
-
Overall health status
|
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / SessionRecord
|
|
6
|
-
|
|
7
|
-
# Interface: SessionRecord
|
|
8
|
-
|
|
9
|
-
Session record wrapper for session archiving and versioning.
|
|
10
|
-
|
|
11
|
-
Provides SessionRecord which supports the Sesame algorithm
|
|
12
|
-
for automatic session convergence. Maintains current session plus archived
|
|
13
|
-
sessions for handling race conditions and out-of-order establishment.
|
|
14
|
-
|
|
15
|
-
From Signal Protocol:
|
|
16
|
-
"A device might have multiple sessions for the same remote device.
|
|
17
|
-
The Sesame algorithm ensures convergence to a single active session."
|
|
18
|
-
|
|
19
|
-
Session Lookup Architecture:
|
|
20
|
-
1. Sessions are LOOKED UP by ProtocolAddress (userId:deviceId)
|
|
21
|
-
2. Within a SessionRecord, session states are IDENTIFIED by baseKey
|
|
22
|
-
3. The baseKey is the initiator's ephemeral public key from X3DH/PQXDH
|
|
23
|
-
|
|
24
|
-
## See
|
|
25
|
-
|
|
26
|
-
https://signal.org/docs/specifications/sesame/
|
|
27
|
-
|
|
28
|
-
## Properties
|
|
29
|
-
|
|
30
|
-
### archivedSessions
|
|
31
|
-
|
|
32
|
-
> **archivedSessions**: `Record`\<[`Base64`](../type-aliases/Base64.md), [`SessionState`](SessionState.md)\>
|
|
33
|
-
|
|
34
|
-
Archived sessions indexed by baseKey for O(1) lookup.
|
|
35
|
-
|
|
36
|
-
Session states are identified by the initiator's ephemeral public key
|
|
37
|
-
(`baseKey`).
|
|
38
|
-
|
|
39
|
-
Used for:
|
|
40
|
-
- Handling race conditions during session establishment
|
|
41
|
-
- Decrypting messages from old sessions
|
|
42
|
-
- Implementing Sesame algorithm for session convergence
|
|
43
|
-
|
|
44
|
-
Key: Base64-encoded baseKey (initiator's ephemeral public key)
|
|
45
|
-
Value: SessionState
|
|
46
|
-
|
|
47
|
-
Session records are keyed by baseKey for fast lookup and spec-aligned
|
|
48
|
-
session recovery behavior.
|
|
49
|
-
|
|
50
|
-
***
|
|
51
|
-
|
|
52
|
-
### currentSession
|
|
53
|
-
|
|
54
|
-
> **currentSession**: [`SessionState`](SessionState.md) \| `null`
|
|
55
|
-
|
|
56
|
-
Current active session state.
|
|
57
|
-
|
|
58
|
-
This is the session used for encrypting new messages.
|
|
59
|
-
May be null if all sessions have been archived (rare edge case).
|
|
60
|
-
|
|
61
|
-
***
|
|
62
|
-
|
|
63
|
-
### metadata?
|
|
64
|
-
|
|
65
|
-
> `optional` **metadata?**: [`SessionRecordMetadata`](SessionRecordMetadata.md)
|
|
66
|
-
|
|
67
|
-
Metadata about the session record.
|
|
68
|
-
|
|
69
|
-
Useful for UI, logging, and session management.
|
|
70
|
-
|
|
71
|
-
***
|
|
72
|
-
|
|
73
|
-
### version
|
|
74
|
-
|
|
75
|
-
> **version**: `4`
|
|
76
|
-
|
|
77
|
-
Protocol version for this persisted session record shape.
|
|
78
|
-
|
|
79
|
-
The current format is version 4. Older versions are rejected and force
|
|
80
|
-
session re-establishment instead of compatibility migration.
|