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