@open-e2ee/signal-protocol-sdk 0.1.0-alpha.7 → 0.1.0-alpha.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ADAPTERS.md +1 -1
- package/CHANGELOG.md +680 -2
- package/COMMERCIAL.md +56 -0
- package/README.md +13 -8
- package/SECURITY.md +15 -1
- package/client/README.md +1 -1
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +16 -8
- package/dist/client/client.js.map +1 -1
- package/dist/client/config.d.ts +12 -2
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/config.js.map +1 -1
- package/dist/client/endorsement-manager.d.ts +19 -2
- package/dist/client/endorsement-manager.d.ts.map +1 -1
- package/dist/client/endorsement-manager.js +26 -10
- package/dist/client/endorsement-manager.js.map +1 -1
- package/dist/client/headless.d.ts +1 -1
- package/dist/client/headless.js +1 -1
- package/dist/client/sealed-sender-ops.d.ts +27 -1
- package/dist/client/sealed-sender-ops.d.ts.map +1 -1
- package/dist/client/sealed-sender-ops.js +36 -6
- package/dist/client/sealed-sender-ops.js.map +1 -1
- package/dist/client/signal-service-cipher.d.ts +16 -1
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +112 -52
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/types.d.ts +20 -7
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js.map +1 -1
- package/dist/index.d.ts +7 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7 -0
- package/dist/index.js.map +1 -1
- package/dist/internal/crypto/index.d.ts +1 -1
- package/dist/internal/crypto/index.d.ts.map +1 -1
- package/dist/internal/crypto/index.js +1 -1
- package/dist/internal/crypto/index.js.map +1 -1
- package/dist/internal/crypto/random.d.ts +9 -0
- package/dist/internal/crypto/random.d.ts.map +1 -1
- package/dist/internal/crypto/random.js +16 -0
- package/dist/internal/crypto/random.js.map +1 -1
- package/dist/internal/groups/manager.d.ts +13 -0
- package/dist/internal/groups/manager.d.ts.map +1 -1
- package/dist/internal/groups/manager.js +73 -12
- package/dist/internal/groups/manager.js.map +1 -1
- package/dist/internal/groups/server-engine.d.ts +31 -0
- package/dist/internal/groups/server-engine.d.ts.map +1 -1
- package/dist/internal/groups/server-engine.js +67 -7
- package/dist/internal/groups/server-engine.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption-v2.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption-v2.js +32 -18
- package/dist/internal/protocol/sealed-sender/decryption-v2.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption.js +33 -19
- package/dist/internal/protocol/sealed-sender/decryption.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption-v2.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption-v2.js +8 -14
- package/dist/internal/protocol/sealed-sender/encryption-v2.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption.d.ts +9 -4
- package/dist/internal/protocol/sealed-sender/encryption.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/encryption.js +7 -15
- package/dist/internal/protocol/sealed-sender/encryption.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts +6 -7
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.js +5 -7
- package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/trust-root.d.ts +45 -0
- package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +1 -0
- package/dist/internal/protocol/sealed-sender/trust-root.js +77 -0
- package/dist/internal/protocol/sealed-sender/trust-root.js.map +1 -0
- package/dist/internal/protocol/sealed-sender/types.d.ts +64 -9
- package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/types.js +43 -0
- package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts +37 -0
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +108 -7
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/local/store/expo/adapter.d.ts +14 -15
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +109 -102
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/expo/db.d.ts +4 -1
- package/dist/local/store/expo/db.d.ts.map +1 -1
- package/dist/local/store/expo/db.js +5 -0
- package/dist/local/store/expo/db.js.map +1 -1
- package/dist/local/store/expo/index.d.ts +0 -2
- package/dist/local/store/expo/index.d.ts.map +1 -1
- package/dist/local/store/expo/index.js +1 -1
- package/dist/local/store/expo/index.js.map +1 -1
- package/dist/local/store/expo/models/index.d.ts +1 -1
- package/dist/local/store/expo/models/index.d.ts.map +1 -1
- package/dist/local/store/expo/models/index.js +2 -2
- package/dist/local/store/expo/models/index.js.map +1 -1
- package/dist/local/store/expo/models/sender-key.d.ts +101 -77
- package/dist/local/store/expo/models/sender-key.d.ts.map +1 -1
- package/dist/local/store/expo/models/sender-key.js +154 -124
- package/dist/local/store/expo/models/sender-key.js.map +1 -1
- package/dist/local/store/expo/schema.d.ts +134 -32
- package/dist/local/store/expo/schema.d.ts.map +1 -1
- package/dist/local/store/expo/schema.js +36 -7
- package/dist/local/store/expo/schema.js.map +1 -1
- package/dist/local/store/mock/adapter.d.ts +1 -0
- package/dist/local/store/mock/adapter.d.ts.map +1 -1
- package/dist/local/store/mock/adapter.js +18 -0
- package/dist/local/store/mock/adapter.js.map +1 -1
- package/dist/local/store/react-native/adapter.d.ts +39 -0
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +163 -8
- package/dist/local/store/react-native/adapter.js.map +1 -1
- package/dist/local/store/web/adapter.d.ts +1 -0
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +33 -1
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/remote/relay/convex/backend.d.ts +402 -0
- package/dist/remote/relay/convex/backend.d.ts.map +1 -0
- package/dist/remote/relay/convex/backend.js +684 -0
- package/dist/remote/relay/convex/backend.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/api.d.ts +58 -0
- package/dist/remote/relay/convex/component/_generated/api.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/api.js +31 -0
- package/dist/remote/relay/convex/component/_generated/api.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/component.d.ts +480 -0
- package/dist/remote/relay/convex/component/_generated/component.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/component.js +11 -0
- package/dist/remote/relay/convex/component/_generated/component.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.d.ts +46 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.js +11 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/server.d.ts +129 -0
- package/dist/remote/relay/convex/component/_generated/server.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/server.js +79 -0
- package/dist/remote/relay/convex/component/_generated/server.js.map +1 -0
- package/dist/remote/relay/convex/component/accounts.d.ts +43 -0
- package/dist/remote/relay/convex/component/accounts.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/accounts.js +181 -0
- package/dist/remote/relay/convex/component/accounts.js.map +1 -0
- package/dist/remote/relay/convex/component/certificates.d.ts +10 -0
- package/dist/remote/relay/convex/component/certificates.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/certificates.js +122 -0
- package/dist/remote/relay/convex/component/certificates.js.map +1 -0
- package/dist/remote/relay/convex/component/cleanup.d.ts +26 -0
- package/dist/remote/relay/convex/component/cleanup.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/cleanup.js +127 -0
- package/dist/remote/relay/convex/component/cleanup.js.map +1 -0
- package/dist/remote/relay/convex/component/convex.config.d.ts +5 -0
- package/dist/remote/relay/convex/component/convex.config.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/convex.config.js +33 -0
- package/dist/remote/relay/convex/component/convex.config.js.map +1 -0
- package/dist/remote/relay/convex/component/crons.d.ts +3 -0
- package/dist/remote/relay/convex/component/crons.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/crons.js +9 -0
- package/dist/remote/relay/convex/component/crons.js.map +1 -0
- package/dist/remote/relay/convex/component/devices.d.ts +101 -0
- package/dist/remote/relay/convex/component/devices.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/devices.js +299 -0
- package/dist/remote/relay/convex/component/devices.js.map +1 -0
- package/dist/remote/relay/convex/component/errors.d.ts +22 -0
- package/dist/remote/relay/convex/component/errors.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/errors.js +17 -0
- package/dist/remote/relay/convex/component/errors.js.map +1 -0
- package/dist/remote/relay/convex/component/groups.d.ts +60 -0
- package/dist/remote/relay/convex/component/groups.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/groups.js +331 -0
- package/dist/remote/relay/convex/component/groups.js.map +1 -0
- package/dist/remote/relay/convex/component/keys.d.ts +130 -0
- package/dist/remote/relay/convex/component/keys.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/keys.js +578 -0
- package/dist/remote/relay/convex/component/keys.js.map +1 -0
- package/dist/remote/relay/convex/component/messages.d.ts +119 -0
- package/dist/remote/relay/convex/component/messages.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/messages.js +649 -0
- package/dist/remote/relay/convex/component/messages.js.map +1 -0
- package/dist/remote/relay/convex/component/provisioning.d.ts +92 -0
- package/dist/remote/relay/convex/component/provisioning.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/provisioning.js +359 -0
- package/dist/remote/relay/convex/component/provisioning.js.map +1 -0
- package/dist/remote/relay/convex/component/runtime.d.ts +18 -0
- package/dist/remote/relay/convex/component/runtime.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/runtime.js +142 -0
- package/dist/remote/relay/convex/component/runtime.js.map +1 -0
- package/dist/remote/relay/convex/component/schema.d.ts +344 -0
- package/dist/remote/relay/convex/component/schema.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/schema.js +266 -0
- package/dist/remote/relay/convex/component/schema.js.map +1 -0
- package/dist/remote/relay/convex/component/zkAuth.d.ts +12 -0
- package/dist/remote/relay/convex/component/zkAuth.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/zkAuth.js +71 -0
- package/dist/remote/relay/convex/component/zkAuth.js.map +1 -0
- package/dist/remote/relay/convex/constants.d.ts +3 -0
- package/dist/remote/relay/convex/constants.d.ts.map +1 -0
- package/dist/remote/relay/convex/constants.js +3 -0
- package/dist/remote/relay/convex/constants.js.map +1 -0
- package/dist/remote/relay/convex/group-server.d.ts +4 -2
- package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
- package/dist/remote/relay/convex/group-server.js +4 -2
- package/dist/remote/relay/convex/group-server.js.map +1 -1
- package/dist/remote/relay/convex/index.d.ts +4 -1
- package/dist/remote/relay/convex/index.d.ts.map +1 -1
- package/dist/remote/relay/convex/index.js +3 -1
- package/dist/remote/relay/convex/index.js.map +1 -1
- package/dist/remote/relay/convex/relay.d.ts +42 -63
- package/dist/remote/relay/convex/relay.d.ts.map +1 -1
- package/dist/remote/relay/convex/relay.js +51 -29
- package/dist/remote/relay/convex/relay.js.map +1 -1
- package/dist/remote/relay/convex/types.d.ts +16 -103
- package/dist/remote/relay/convex/types.d.ts.map +1 -1
- package/dist/remote/relay/convex/types.js +8 -13
- package/dist/remote/relay/convex/types.js.map +1 -1
- package/dist/remote/relay/index.d.ts +1 -1
- package/dist/remote/relay/index.d.ts.map +1 -1
- package/dist/remote/relay/index.js.map +1 -1
- package/dist/remote/relay/mock/adapter.d.ts +2 -7
- package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
- package/dist/remote/relay/mock/adapter.js +32 -20
- package/dist/remote/relay/mock/adapter.js.map +1 -1
- package/dist/remote/relay/types.d.ts +32 -69
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/remote/relay/types.js +0 -1
- package/dist/remote/relay/types.js.map +1 -1
- package/dist/types/api.d.ts +21 -0
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/protocol-config.d.ts +51 -0
- package/dist/types/protocol-config.d.ts.map +1 -1
- package/dist/types/protocol-config.js +46 -0
- package/dist/types/protocol-config.js.map +1 -1
- package/docs/ASSURANCE.md +10 -6
- package/docs/CLIENT_COMPOSITION.md +23 -69
- package/docs/DEVIATIONS.md +44 -11
- package/docs/E2EE.md +71 -6
- package/docs/GETTING_STARTED.md +1 -1
- package/docs/PACKAGE_SURFACE.md +6 -5
- package/docs/RECIPES.md +1 -1
- package/docs/SECURITY.md +8 -0
- package/local/store/expo/README.md +10 -1
- package/local/store/node/README.md +10 -1
- package/package.json +12 -7
- package/remote/relay/convex/README.md +1 -1
- package/remote/relay/convex/component/README.md +428 -0
- package/scripts/oe-groups.mjs +21 -1
- package/dist/remote/relay/convex/server/index.d.ts +0 -2
- package/dist/remote/relay/convex/server/index.d.ts.map +0 -1
- package/dist/remote/relay/convex/server/index.js +0 -2
- package/dist/remote/relay/convex/server/index.js.map +0 -1
- package/dist/remote/relay/convex/server.d.ts +0 -150
- package/dist/remote/relay/convex/server.d.ts.map +0 -1
- package/dist/remote/relay/convex/server.js +0 -506
- package/dist/remote/relay/convex/server.js.map +0 -1
- package/docs/api/README.md +0 -471
- package/docs/api/classes/EncryptionError.md +0 -112
- package/docs/api/classes/EndorsementManager.md +0 -325
- package/docs/api/classes/SealedSenderAuthError.md +0 -127
- package/docs/api/classes/ServerDerivedKeyPair.md +0 -68
- package/docs/api/classes/ServerDerivedPublicKey.md +0 -33
- package/docs/api/classes/ServerRootKeyPair.md +0 -94
- package/docs/api/classes/ServerRootPublicKey.md +0 -72
- package/docs/api/classes/SignalProtocolBlockingManager.md +0 -106
- package/docs/api/classes/SignalProtocolClient.md +0 -2654
- package/docs/api/classes/VerificationFailure.md +0 -25
- package/docs/api/enumerations/ContentHint.md +0 -63
- package/docs/api/enumerations/EncryptionErrorCode.md +0 -488
- package/docs/api/enumerations/IdentityKeyChange.md +0 -65
- package/docs/api/enumerations/MessageType.md +0 -29
- package/docs/api/enumerations/TrustDirection.md +0 -33
- package/docs/api/enumerations/TypingAction.md +0 -31
- package/docs/api/functions/createDefaultSignalProtocolContentAdapter.md +0 -13
- package/docs/api/functions/createDefaultSignalProtocolLogger.md +0 -36
- package/docs/api/functions/createGroupId.md +0 -32
- package/docs/api/functions/createSignalProtocolClient.md +0 -36
- package/docs/api/functions/createSignalProtocolClientConfig.md +0 -24
- package/docs/api/functions/decodeGroupTrustRoot.md +0 -21
- package/docs/api/functions/encodeGroupTrustRoot.md +0 -28
- package/docs/api/functions/extractGroupId.md +0 -32
- package/docs/api/functions/formatVersion.md +0 -25
- package/docs/api/functions/isCompatible.md +0 -31
- package/docs/api/functions/isGroupId.md +0 -37
- package/docs/api/functions/isSealedSenderAuthError.md +0 -25
- package/docs/api/functions/parseVersion.md +0 -29
- package/docs/api/functions/resolveSPQRLimits.md +0 -21
- package/docs/api/functions/resolveSignalProtocolLogger.md +0 -42
- package/docs/api/interfaces/AccountIdentityProvisioning.md +0 -43
- package/docs/api/interfaces/AccountIdentityRotation.md +0 -69
- package/docs/api/interfaces/AttachmentTransferOptions.md +0 -49
- package/docs/api/interfaces/BlockedRecipientEntry.md +0 -25
- package/docs/api/interfaces/BlockedRecipientsSyncInput.md +0 -27
- package/docs/api/interfaces/ConfigurationSyncInput.md +0 -19
- package/docs/api/interfaces/CredentialPublicKey.md +0 -25
- package/docs/api/interfaces/DataMessageInput.md +0 -21
- package/docs/api/interfaces/DecryptedEnvelope.md +0 -95
- package/docs/api/interfaces/DecryptedGroup.md +0 -86
- package/docs/api/interfaces/DeviceInfo.md +0 -79
- package/docs/api/interfaces/DeviceRecord.md +0 -87
- package/docs/api/interfaces/DeviceRegistration.md +0 -27
- package/docs/api/interfaces/DoubleRatchetConfig.md +0 -36
- package/docs/api/interfaces/EcOneTimePreKey.md +0 -27
- package/docs/api/interfaces/EcSignedPreKey.md +0 -39
- package/docs/api/interfaces/EcSignedPreKeyUpload.md +0 -50
- package/docs/api/interfaces/EncryptionErrorContext.md +0 -51
- package/docs/api/interfaces/Envelope.md +0 -154
- package/docs/api/interfaces/ForceKeyResetResult.md +0 -37
- package/docs/api/interfaces/GroupAuthorization.md +0 -23
- package/docs/api/interfaces/GroupChangeEntry.md +0 -42
- package/docs/api/interfaces/GroupMemberDevice.md +0 -26
- package/docs/api/interfaces/GroupTrustRoot.md +0 -33
- package/docs/api/interfaces/IEcOneTimePreKeyStore.md +0 -86
- package/docs/api/interfaces/IEcSignedPreKeyStore.md +0 -133
- package/docs/api/interfaces/IGroupServer.md +0 -120
- package/docs/api/interfaces/IGroupStateStore.md +0 -128
- package/docs/api/interfaces/IIdentityKeyStore.md +0 -312
- package/docs/api/interfaces/IKemPreKeyStore.md +0 -144
- package/docs/api/interfaces/IKyberLastResortPreKeyStore.md +0 -112
- package/docs/api/interfaces/ILogger.md +0 -117
- package/docs/api/interfaces/IProtocolStore.md +0 -1033
- package/docs/api/interfaces/IRelayGroupServer.md +0 -60
- package/docs/api/interfaces/ISenderKeyStore.md +0 -417
- package/docs/api/interfaces/ISesameStore.md +0 -249
- package/docs/api/interfaces/ISessionStore.md +0 -178
- package/docs/api/interfaces/ISignalProtocolClient.md +0 -1185
- package/docs/api/interfaces/ISignalProtocolLocalSecretVault.md +0 -71
- package/docs/api/interfaces/ISignalProtocolLocalStore.md +0 -2053
- package/docs/api/interfaces/ISignalProtocolManager.md +0 -272
- package/docs/api/interfaces/ISignalProtocolRelayServer.md +0 -1337
- package/docs/api/interfaces/IdentityKeyPair.md +0 -49
- package/docs/api/interfaces/IncomingEnvelope.md +0 -91
- package/docs/api/interfaces/InspectedSignalProtocolContent.md +0 -43
- package/docs/api/interfaces/KDFChain.md +0 -31
- package/docs/api/interfaces/KemLastResortPreKeyUpload.md +0 -50
- package/docs/api/interfaces/KeyPair.md +0 -23
- package/docs/api/interfaces/KyberPreKey.md +0 -42
- package/docs/api/interfaces/MLKEMBraidAgentState.md +0 -191
- package/docs/api/interfaces/MLKEMBraidMessage.md +0 -49
- package/docs/api/interfaces/MediaAttachmentDeleteSyncInput.md +0 -31
- package/docs/api/interfaces/MessageHeader.md +0 -49
- package/docs/api/interfaces/MessageRecord.md +0 -86
- package/docs/api/interfaces/ParsedReceiptContent.md +0 -19
- package/docs/api/interfaces/ParsedTypingContent.md +0 -19
- package/docs/api/interfaces/PreKeyMaintenanceStore.md +0 -88
- package/docs/api/interfaces/PreKeyMessage.md +0 -159
- package/docs/api/interfaces/PreKeyStatusResult.md +0 -21
- package/docs/api/interfaces/PreKeyUpload.md +0 -42
- package/docs/api/interfaces/ProcessEnvelopeOptions.md +0 -72
- package/docs/api/interfaces/ProtocolAddress.md +0 -38
- package/docs/api/interfaces/ProtocolStrategyConfig.md +0 -91
- package/docs/api/interfaces/RatchetMessage.md +0 -96
- package/docs/api/interfaces/ReadSyncEntryInput.md +0 -19
- package/docs/api/interfaces/ReceiverChain.md +0 -43
- package/docs/api/interfaces/RecipientUsernameSyncInput.md +0 -31
- package/docs/api/interfaces/RelayPreKeyBundle.md +0 -254
- package/docs/api/interfaces/RemoteObjectDownload.md +0 -33
- package/docs/api/interfaces/RemoteObjectUpload.md +0 -49
- package/docs/api/interfaces/ResolvedSPQRInfoStrings.md +0 -27
- package/docs/api/interfaces/ResolvedSPQRLimits.md +0 -37
- package/docs/api/interfaces/RetryRequest.md +0 -80
- package/docs/api/interfaces/SCKAState.md +0 -65
- package/docs/api/interfaces/SPQRLimits.md +0 -40
- package/docs/api/interfaces/SPQRState.md +0 -191
- package/docs/api/interfaces/SafetyNumber.md +0 -60
- package/docs/api/interfaces/SafetyNumberConfirmation.md +0 -46
- package/docs/api/interfaces/SealedSenderConfig.md +0 -70
- package/docs/api/interfaces/SendOptions.md +0 -191
- package/docs/api/interfaces/SendResult.md +0 -93
- package/docs/api/interfaces/SenderKeyDistributionMessage.md +0 -43
- package/docs/api/interfaces/SenderKeyState.md +0 -76
- package/docs/api/interfaces/SenderKeysConfig.md +0 -65
- package/docs/api/interfaces/SentSyncTranscriptInput.md +0 -31
- package/docs/api/interfaces/ServiceId.md +0 -19
- package/docs/api/interfaces/SesameMessage.md +0 -84
- package/docs/api/interfaces/SesameStats.md +0 -57
- package/docs/api/interfaces/SessionHealthResult.md +0 -120
- package/docs/api/interfaces/SessionRecord.md +0 -80
- package/docs/api/interfaces/SessionRecordMetadata.md +0 -109
- package/docs/api/interfaces/SessionState.md +0 -368
- package/docs/api/interfaces/SessionTrustCommit.md +0 -58
- package/docs/api/interfaces/SignalProtocolBlockingHooks.md +0 -44
- package/docs/api/interfaces/SignalProtocolBlockingManagerOptions.md +0 -31
- package/docs/api/interfaces/SignalProtocolBlockingMirror.md +0 -30
- package/docs/api/interfaces/SignalProtocolBlockingStore.md +0 -83
- package/docs/api/interfaces/SignalProtocolClientAdapterConfig.md +0 -44
- package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +0 -731
- package/docs/api/interfaces/SignalProtocolClientConfig.md +0 -895
- package/docs/api/interfaces/SignalProtocolClientDeleteLocalAttachmentInput.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientHooks.md +0 -506
- package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +0 -51
- package/docs/api/interfaces/SignalProtocolClientLoadLocalAttachmentInput.md +0 -187
- package/docs/api/interfaces/SignalProtocolClientLoadedLocalAttachment.md +0 -19
- package/docs/api/interfaces/SignalProtocolClientMedia.md +0 -83
- package/docs/api/interfaces/SignalProtocolClientMediaCompletedResult.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientMediaConfig.md +0 -157
- package/docs/api/interfaces/SignalProtocolClientMediaDownloadCompletedResult.md +0 -37
- package/docs/api/interfaces/SignalProtocolClientMediaDownloadNotNeededResult.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientMediaFailedResult.md +0 -19
- package/docs/api/interfaces/SignalProtocolClientMediaOperationOptions.md +0 -53
- package/docs/api/interfaces/SignalProtocolClientMediaPendingResult.md +0 -19
- package/docs/api/interfaces/SignalProtocolClientMediaProcessResult.md +0 -43
- package/docs/api/interfaces/SignalProtocolClientMediaSkippedResult.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientMediaUploadCompletedResult.md +0 -31
- package/docs/api/interfaces/SignalProtocolClientProcessPendingMediaOptions.md +0 -87
- package/docs/api/interfaces/SignalProtocolClientSaveDownloadedAttachmentInput.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientSaveUploadedAttachmentInput.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientSyncDeleteInput.md +0 -19
- package/docs/api/interfaces/SignalProtocolConfig.md +0 -50
- package/docs/api/interfaces/SignalProtocolContentAdapter.md +0 -325
- package/docs/api/interfaces/SignalProtocolRemoteObjectStore.md +0 -88
- package/docs/api/interfaces/SkippedSenderMessageKey.md +0 -26
- package/docs/api/interfaces/TaskNotificationAckSyncInput.md +0 -31
- package/docs/api/interfaces/TripleRatchetState.md +0 -64
- package/docs/api/interfaces/UserRecord.md +0 -71
- package/docs/api/interfaces/UsernameStateSyncInput.md +0 -19
- package/docs/api/interfaces/VerificationStateSyncInput.md +0 -31
- package/docs/api/interfaces/VersionNegotiationState.md +0 -84
- package/docs/api/interfaces/ViewOnceOpenSyncInput.md +0 -19
- package/docs/api/namespaces/ProtocolAddress/README.md +0 -33
- package/docs/api/namespaces/ProtocolAddress/functions/create.md +0 -41
- package/docs/api/namespaces/ProtocolAddress/functions/equals.md +0 -39
- package/docs/api/namespaces/ProtocolAddress/functions/fromStorageKey.md +0 -36
- package/docs/api/namespaces/ProtocolAddress/functions/isUser.md +0 -39
- package/docs/api/namespaces/ProtocolAddress/functions/isValid.md +0 -34
- package/docs/api/namespaces/ProtocolAddress/functions/parse.md +0 -41
- package/docs/api/namespaces/ProtocolAddress/functions/toStorageKey.md +0 -38
- package/docs/api/namespaces/ProtocolAddress/functions/toString.md +0 -34
- package/docs/api/namespaces/SessionRecord/README.md +0 -30
- package/docs/api/namespaces/SessionRecord/functions/archiveCurrent.md +0 -40
- package/docs/api/namespaces/SessionRecord/functions/archiveCurrentState.md +0 -34
- package/docs/api/namespaces/SessionRecord/functions/create.md +0 -25
- package/docs/api/namespaces/SessionRecord/functions/deserialize.md +0 -29
- package/docs/api/namespaces/SessionRecord/functions/findSession.md +0 -34
- package/docs/api/namespaces/SessionRecord/functions/getAllSessions.md +0 -25
- package/docs/api/namespaces/SessionRecord/functions/getArchivedCount.md +0 -25
- package/docs/api/namespaces/SessionRecord/functions/hasCurrentSession.md +0 -25
- package/docs/api/namespaces/SessionRecord/functions/hasUsableSenderChain.md +0 -36
- package/docs/api/namespaces/SessionRecord/functions/promoteSession.md +0 -34
- package/docs/api/namespaces/SessionRecord/functions/serialize.md +0 -28
- package/docs/api/namespaces/SessionRecord/variables/MAX_ARCHIVED_SESSIONS.md +0 -14
- package/docs/api/namespaces/SessionState/README.md +0 -15
- package/docs/api/namespaces/SessionState/functions/getSessionId.md +0 -32
- package/docs/api/namespaces/blocking/README.md +0 -43
- package/docs/api/namespaces/encoding/README.md +0 -33
- package/docs/api/namespaces/encoding/functions/base64ToUrlSafe.md +0 -28
- package/docs/api/namespaces/encoding/functions/bytesToBase64.md +0 -21
- package/docs/api/namespaces/encoding/functions/bytesToString.md +0 -21
- package/docs/api/namespaces/encoding/functions/bytesToUrlSafeBase64.md +0 -33
- package/docs/api/namespaces/encoding/functions/concatBytes.md +0 -21
- package/docs/api/namespaces/encoding/functions/stringToBytes.md +0 -21
- package/docs/api/namespaces/encoding/functions/urlSafeToBase64.md +0 -27
- package/docs/api/namespaces/keys/README.md +0 -130
- package/docs/api/namespaces/keys/functions/acceptContactIdentityRotation.md +0 -33
- package/docs/api/namespaces/keys/functions/assertIdentityCommitment.md +0 -25
- package/docs/api/namespaces/keys/functions/canonicalizeDeviceIdentityKey.md +0 -30
- package/docs/api/namespaces/keys/functions/compareDeviceIdentityKeys.md +0 -28
- package/docs/api/namespaces/keys/functions/compositeIdentitiesEqual.md +0 -23
- package/docs/api/namespaces/keys/functions/createCompositeIdentityV1.md +0 -19
- package/docs/api/namespaces/keys/functions/createPreKeySignatureContext.md +0 -31
- package/docs/api/namespaces/keys/functions/createUnverifiedContactIdentityRecord.md +0 -23
- package/docs/api/namespaces/keys/functions/decodeCompositeIdentityV1.md +0 -19
- package/docs/api/namespaces/keys/functions/deriveIdentityCommitment.md +0 -19
- package/docs/api/namespaces/keys/functions/encodeCompositeIdentityV1.md +0 -19
- package/docs/api/namespaces/keys/functions/evaluateContactIdentityCandidate.md +0 -27
- package/docs/api/namespaces/keys/functions/generateEcOneTimePreKeys.md +0 -37
- package/docs/api/namespaces/keys/functions/generateEcSignedPreKey.md +0 -39
- package/docs/api/namespaces/keys/functions/generateEcSignedPreKeyId.md +0 -21
- package/docs/api/namespaces/keys/functions/generateIdentityKeyPair.md +0 -24
- package/docs/api/namespaces/keys/functions/generateKemOneTimePreKeys.md +0 -47
- package/docs/api/namespaces/keys/functions/generateKyberLastResortPreKey.md +0 -37
- package/docs/api/namespaces/keys/functions/generateRegistrationId.md +0 -13
- package/docs/api/namespaces/keys/functions/isValidDeviceIdentityKey.md +0 -22
- package/docs/api/namespaces/keys/functions/signMlKem1024PreKey.md +0 -29
- package/docs/api/namespaces/keys/functions/signPreKey.md +0 -31
- package/docs/api/namespaces/keys/functions/validateContactIdentityRecord.md +0 -19
- package/docs/api/namespaces/keys/functions/verifyContactIdentityRecord.md +0 -31
- package/docs/api/namespaces/keys/functions/verifyMlKem1024PreKey.md +0 -33
- package/docs/api/namespaces/keys/functions/verifyPreKeySignature.md +0 -35
- package/docs/api/namespaces/keys/interfaces/CompositeIdentityV1.md +0 -33
- package/docs/api/namespaces/keys/interfaces/ContactIdentityRecord.md +0 -53
- package/docs/api/namespaces/keys/interfaces/KemOneTimePreKey.md +0 -43
- package/docs/api/namespaces/keys/type-aliases/IdentityCandidateStatus.md +0 -9
- package/docs/api/namespaces/keys/type-aliases/IdentityTrustState.md +0 -9
- package/docs/api/namespaces/keys/type-aliases/IdentityType.md +0 -9
- package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_ED25519_TAG.md +0 -9
- package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_LENGTH.md +0 -9
- package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_VERSION.md +0 -9
- package/docs/api/namespaces/keys/variables/COMPOSITE_IDENTITY_V1_X25519_TAG.md +0 -9
- package/docs/api/namespaces/keys/variables/IDENTITY_COMMITMENT_V1_DOMAIN.md +0 -9
- package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_ML_KEM_1024.md +0 -9
- package/docs/api/namespaces/keys/variables/PREKEY_ALGORITHM_X25519.md +0 -9
- package/docs/api/namespaces/keys/variables/PREKEY_SIGNATURE_V1_DOMAIN.md +0 -9
- package/docs/api/namespaces/keys/variables/UNPINNED_DEVICE_IDENTITY_KEY.md +0 -18
- package/docs/api/namespaces/media/README.md +0 -105
- package/docs/api/namespaces/media/classes/MediaAttachmentError.md +0 -57
- package/docs/api/namespaces/media/functions/createByteRangeMediaAttachmentTransfer.md +0 -19
- package/docs/api/namespaces/media/functions/createMediaAttachmentDeliveryId.md +0 -29
- package/docs/api/namespaces/media/functions/createMediaAttachmentId.md +0 -19
- package/docs/api/namespaces/media/functions/createMediaAttachmentMessage.md +0 -25
- package/docs/api/namespaces/media/functions/createMediaAttachmentPointer.md +0 -19
- package/docs/api/namespaces/media/functions/createTusMediaAttachmentTransfer.md +0 -19
- package/docs/api/namespaces/media/functions/deleteMediaAttachment.md +0 -23
- package/docs/api/namespaces/media/functions/executeMediaAttachmentJob.md +0 -23
- package/docs/api/namespaces/media/functions/isMediaAttachmentFlagSet.md +0 -19
- package/docs/api/namespaces/media/functions/parseMediaAttachmentMessage.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentCleanup.md +0 -23
- package/docs/api/namespaces/media/functions/planMediaAttachmentCleanupJobs.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentDeleteSync.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentDownloadJob.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentOpen.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentProcessing.md +0 -19
- package/docs/api/namespaces/media/functions/planMediaAttachmentUploadJob.md +0 -19
- package/docs/api/namespaces/media/functions/prepareMediaAttachmentUpload.md +0 -30
- package/docs/api/namespaces/media/functions/resolveMediaAttachment.md +0 -30
- package/docs/api/namespaces/media/functions/serializeMediaAttachmentMessage.md +0 -25
- package/docs/api/namespaces/media/functions/validateMediaAttachmentPolicy.md +0 -23
- package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentPartialStore.md +0 -68
- package/docs/api/namespaces/media/interfaces/ByteRangeMediaAttachmentTransferOptions.md +0 -91
- package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentOptions.md +0 -25
- package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentResult.md +0 -19
- package/docs/api/namespaces/media/interfaces/ExecuteMediaAttachmentJobOptions.md +0 -157
- package/docs/api/namespaces/media/interfaces/MediaAttachmentBackgroundJob.md +0 -85
- package/docs/api/namespaces/media/interfaces/MediaAttachmentCleanupPlan.md +0 -37
- package/docs/api/namespaces/media/interfaces/MediaAttachmentJobExecutionResult.md +0 -55
- package/docs/api/namespaces/media/interfaces/MediaAttachmentMessage.md +0 -31
- package/docs/api/namespaces/media/interfaces/MediaAttachmentOpenDecision.md +0 -31
- package/docs/api/namespaces/media/interfaces/MediaAttachmentPointer.md +0 -133
- package/docs/api/namespaces/media/interfaces/MediaAttachmentPolicy.md +0 -67
- package/docs/api/namespaces/media/interfaces/MediaAttachmentProcessingPlan.md +0 -73
- package/docs/api/namespaces/media/interfaces/MediaAttachmentProgress.md +0 -69
- package/docs/api/namespaces/media/interfaces/MediaAttachmentResumeState.md +0 -37
- package/docs/api/namespaces/media/interfaces/MediaAttachmentRetryOptions.md +0 -31
- package/docs/api/namespaces/media/interfaces/MediaAttachmentTransfer.md +0 -51
- package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferCheckpoint.md +0 -69
- package/docs/api/namespaces/media/interfaces/MediaAttachmentTransferOptions.md +0 -67
- package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadJobData.md +0 -19
- package/docs/api/namespaces/media/interfaces/MediaAttachmentUploadResponse.md +0 -25
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentCleanupJobsInput.md +0 -61
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDeleteSyncInput.md +0 -25
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentDownloadJobInput.md +0 -161
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentOpenInput.md +0 -25
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentProcessingInput.md +0 -83
- package/docs/api/namespaces/media/interfaces/PlanMediaAttachmentUploadJobInput.md +0 -147
- package/docs/api/namespaces/media/interfaces/PrepareMediaAttachmentUploadOptions.md +0 -144
- package/docs/api/namespaces/media/interfaces/ResolveMediaAttachmentOptions.md +0 -55
- package/docs/api/namespaces/media/interfaces/ResolvedMediaAttachment.md +0 -109
- package/docs/api/namespaces/media/interfaces/TusMediaAttachmentTransferOptions.md +0 -85
- package/docs/api/namespaces/media/type-aliases/CreateMediaAttachmentPointerInput.md +0 -15
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentCheckpointCallback.md +0 -19
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentCleanupReason.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentErrorCode.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentFlag.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobExecutionStatus.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobOperation.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobPriority.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSkipReason.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentJobSource.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentKnownIds.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentMessageType.md +0 -9
- package/docs/api/namespaces/media/type-aliases/MediaAttachmentProgressCallback.md +0 -19
- package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_DEFAULTS.md +0 -47
- package/docs/api/namespaces/media/variables/MEDIA_ATTACHMENT_POLICY_PRESETS.md +0 -95
- package/docs/api/namespaces/media/variables/MediaAttachmentCleanupReason.md +0 -27
- package/docs/api/namespaces/media/variables/MediaAttachmentErrorCode.md +0 -75
- package/docs/api/namespaces/media/variables/MediaAttachmentFlag.md +0 -23
- package/docs/api/namespaces/media/variables/MediaAttachmentJobExecutionStatus.md +0 -19
- package/docs/api/namespaces/media/variables/MediaAttachmentJobOperation.md +0 -31
- package/docs/api/namespaces/media/variables/MediaAttachmentJobPriority.md +0 -23
- package/docs/api/namespaces/media/variables/MediaAttachmentJobSource.md +0 -51
- package/docs/api/namespaces/media/variables/MediaAttachmentMessageType.md +0 -15
- package/docs/api/namespaces/media/variables/downloadMediaAttachment.md +0 -30
- package/docs/api/namespaces/safety/README.md +0 -61
- package/docs/api/namespaces/safety/classes/DisplayableFingerprint.md +0 -108
- package/docs/api/namespaces/safety/classes/Fingerprint.md +0 -104
- package/docs/api/namespaces/safety/classes/ScannableFingerprint.md +0 -209
- package/docs/api/namespaces/safety/functions/base64ToBytes.md +0 -21
- package/docs/api/namespaces/safety/functions/clearFingerprintCache.md +0 -15
- package/docs/api/namespaces/safety/functions/compareSafetyNumbers.md +0 -25
- package/docs/api/namespaces/safety/functions/createFingerprintData.md +0 -60
- package/docs/api/namespaces/safety/functions/extractQrData.md +0 -34
- package/docs/api/namespaces/safety/functions/generateCompositeSafetyNumber.md +0 -39
- package/docs/api/namespaces/safety/functions/generateEmojiFingerprint.md +0 -24
- package/docs/api/namespaces/safety/functions/generateSingleKeyReferenceSafetyNumber.md +0 -51
- package/docs/api/namespaces/safety/functions/generateVerifySchemeUrl.md +0 -32
- package/docs/api/namespaces/safety/functions/generateVerifyUrl.md +0 -49
- package/docs/api/namespaces/safety/functions/isValidSafetyNumber.md +0 -21
- package/docs/api/namespaces/safety/functions/isVerifyUrl.md +0 -45
- package/docs/api/namespaces/safety/functions/parseVerifyUrl.md +0 -31
- package/docs/api/namespaces/safety/interfaces/FingerprintData.md +0 -52
- package/docs/api/namespaces/safety/interfaces/SafetyNumber.md +0 -49
- package/docs/api/namespaces/safety/interfaces/VerifyLinkConfig.md +0 -28
- package/docs/api/namespaces/safety/interfaces/VerifyUrlParams.md +0 -49
- package/docs/api/namespaces/safety/type-aliases/CompareResult.md +0 -21
- package/docs/api/namespaces/safety/variables/DEFAULT_VERIFY_LINK_CONFIG.md +0 -12
- package/docs/api/namespaces/safety/variables/FINGERPRINT_ITERATIONS.md +0 -12
- package/docs/api/namespaces/safety/variables/FINGERPRINT_VERSION.md +0 -12
- package/docs/api/namespaces/safety/variables/VERIFY_BASE_URL.md +0 -11
- package/docs/api/namespaces/safety/variables/VERIFY_SCHEME_URL.md +0 -11
- package/docs/api/type-aliases/Base64.md +0 -20
- package/docs/api/type-aliases/BraidPolicy.md +0 -11
- package/docs/api/type-aliases/Bytes.md +0 -20
- package/docs/api/type-aliases/Ciphertext.md +0 -21
- package/docs/api/type-aliases/DeviceType.md +0 -11
- package/docs/api/type-aliases/DownloadedAttachment.md +0 -11
- package/docs/api/type-aliases/GroupId.md +0 -27
- package/docs/api/type-aliases/Hex.md +0 -20
- package/docs/api/type-aliases/HookName.md +0 -11
- package/docs/api/type-aliases/PostQuantumPolicy.md +0 -11
- package/docs/api/type-aliases/PreparedAttachmentUpload.md +0 -14
- package/docs/api/type-aliases/PrivateKey.md +0 -22
- package/docs/api/type-aliases/ProgressCallback.md +0 -45
- package/docs/api/type-aliases/PublicKey.md +0 -22
- package/docs/api/type-aliases/RemoteObjectCompleteUploadRequest.md +0 -19
- package/docs/api/type-aliases/RemoteObjectDeleteRequest.md +0 -19
- package/docs/api/type-aliases/RemoteObjectDownloadRequest.md +0 -19
- package/docs/api/type-aliases/RemoteObjectUploadRequest.md +0 -42
- package/docs/api/type-aliases/SCKAMode.md +0 -11
- package/docs/api/type-aliases/SealedSenderAuth.md +0 -15
- package/docs/api/type-aliases/SignalProtocolClientMediaCleanupInput.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaCleanupResult.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaDownloadInput.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaDownloadResult.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaOperationResult.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaUploadInput.md +0 -9
- package/docs/api/type-aliases/SignalProtocolClientMediaUploadResult.md +0 -9
- package/docs/api/type-aliases/Signature.md +0 -21
- package/docs/api/type-aliases/Unsubscribe.md +0 -15
- package/docs/api/variables/BraidPolicy.md +0 -21
- package/docs/api/variables/DEFAULT_DEVICE_ID.md +0 -12
- package/docs/api/variables/DOUBLE_RATCHET_SPEC.md +0 -11
- package/docs/api/variables/GROUP_ID_PREFIX.md +0 -11
- package/docs/api/variables/GROUP_TRUST_ROOT_VERSION.md +0 -11
- package/docs/api/variables/KEY_REFRESH_INTERVAL_MS_DEFAULT.md +0 -11
- package/docs/api/variables/MAX_MESSAGE_KEYS.md +0 -14
- package/docs/api/variables/MAX_PREKEY_AGE_MS_DEFAULT.md +0 -11
- package/docs/api/variables/MAX_RECEIVER_CHAINS.md +0 -14
- package/docs/api/variables/MAX_REGISTRATION_ID.md +0 -16
- package/docs/api/variables/MAX_SKIP.md +0 -11
- package/docs/api/variables/MESSAGE_FORMAT.md +0 -11
- package/docs/api/variables/MIN_REGISTRATION_ID.md +0 -16
- package/docs/api/variables/ML_KEM_BRAID_SPEC.md +0 -11
- package/docs/api/variables/ONE_TIME_PREKEY_BATCH_SIZE.md +0 -21
- package/docs/api/variables/PQXDH_SPEC.md +0 -11
- package/docs/api/variables/PostQuantumPolicy.md +0 -21
- package/docs/api/variables/SENDER_KEY_FORMAT.md +0 -11
- package/docs/api/variables/SENDER_KEY_SPEC.md +0 -11
- package/docs/api/variables/SESAME_SPEC.md +0 -11
- package/docs/api/variables/SESSION_FORMAT.md +0 -11
- package/docs/api/variables/SPQR_LIMITS_DEFAULTS.md +0 -11
- package/docs/api/variables/X3DH_SPEC.md +0 -9
- package/docs/api/variables/defaultSignalProtocolLogger.md +0 -32
- package/remote/relay/convex/server/README.md +0 -146
|
@@ -1,96 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / RatchetMessage
|
|
6
|
-
|
|
7
|
-
# Interface: RatchetMessage
|
|
8
|
-
|
|
9
|
-
Complete encrypted message with Double Ratchet header
|
|
10
|
-
|
|
11
|
-
This is the wire format for messages using the full Double Ratchet.
|
|
12
|
-
Uses AES-256-CBC + HMAC-SHA256 per Signal Protocol specification.
|
|
13
|
-
|
|
14
|
-
Section 3 Variant (Plaintext Headers + MAC):
|
|
15
|
-
- DH public key is sent in plaintext (needed to determine key chain)
|
|
16
|
-
- Message counters are sent in plaintext (PN and N)
|
|
17
|
-
- HMAC-SHA256 (truncated to 8 bytes) authenticates header + ciphertext
|
|
18
|
-
- Identity keys are included in MAC computation for session binding
|
|
19
|
-
|
|
20
|
-
## See
|
|
21
|
-
|
|
22
|
-
https://signal.org/docs/specifications/doubleratchet/ (Section 3)
|
|
23
|
-
|
|
24
|
-
## Properties
|
|
25
|
-
|
|
26
|
-
### ciphertext
|
|
27
|
-
|
|
28
|
-
> **ciphertext**: [`Base64`](../type-aliases/Base64.md)
|
|
29
|
-
|
|
30
|
-
AES-CBC encrypted message body
|
|
31
|
-
|
|
32
|
-
***
|
|
33
|
-
|
|
34
|
-
### contentHint?
|
|
35
|
-
|
|
36
|
-
> `optional` **contentHint?**: [`ContentHint`](../enumerations/ContentHint.md)
|
|
37
|
-
|
|
38
|
-
Content hint for delivery and retry behavior (optional).
|
|
39
|
-
|
|
40
|
-
Helps optimize message handling without decrypting:
|
|
41
|
-
- DEFAULT: Normal message with standard policies
|
|
42
|
-
- RESENDABLE: Can be retried if delivery fails
|
|
43
|
-
- IMPLICIT: Ephemeral (typing, receipts) - don't store long-term
|
|
44
|
-
|
|
45
|
-
***
|
|
46
|
-
|
|
47
|
-
### counter
|
|
48
|
-
|
|
49
|
-
> **counter**: `number`
|
|
50
|
-
|
|
51
|
-
Message counter in current sending chain (proto: counter, field 2)
|
|
52
|
-
|
|
53
|
-
***
|
|
54
|
-
|
|
55
|
-
### mac
|
|
56
|
-
|
|
57
|
-
> **mac**: [`Base64`](../type-aliases/Base64.md)
|
|
58
|
-
|
|
59
|
-
HMAC-SHA256 truncated to 8 bytes (identity-bound: includes sender/receiver identity keys)
|
|
60
|
-
|
|
61
|
-
***
|
|
62
|
-
|
|
63
|
-
### messageVersion
|
|
64
|
-
|
|
65
|
-
> **messageVersion**: `string`
|
|
66
|
-
|
|
67
|
-
Wire format version for protocol evolution.
|
|
68
|
-
|
|
69
|
-
Format 'v1' (current): JSON serialization, plaintext headers + identity-bound MAC
|
|
70
|
-
|
|
71
|
-
Allows backward/forward compatibility - recipients can gracefully handle
|
|
72
|
-
different versions or reject unsupported versions during decryption.
|
|
73
|
-
|
|
74
|
-
***
|
|
75
|
-
|
|
76
|
-
### previousCounter
|
|
77
|
-
|
|
78
|
-
> **previousCounter**: `number`
|
|
79
|
-
|
|
80
|
-
Number of messages in previous sending chain (proto: previous_counter, field 3)
|
|
81
|
-
|
|
82
|
-
***
|
|
83
|
-
|
|
84
|
-
### ratchetKey
|
|
85
|
-
|
|
86
|
-
> **ratchetKey**: [`PublicKey`](../type-aliases/PublicKey.md)
|
|
87
|
-
|
|
88
|
-
Sender's current ratchet public key (proto: ratchet_key, field 1)
|
|
89
|
-
|
|
90
|
-
***
|
|
91
|
-
|
|
92
|
-
### type
|
|
93
|
-
|
|
94
|
-
> **type**: [`RATCHET`](../enumerations/MessageType.md#ratchet)
|
|
95
|
-
|
|
96
|
-
Message type discriminator - enables exhaustive type checking
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / ReadSyncEntryInput
|
|
6
|
-
|
|
7
|
-
# Interface: ReadSyncEntryInput
|
|
8
|
-
|
|
9
|
-
## Properties
|
|
10
|
-
|
|
11
|
-
### senderUserId
|
|
12
|
-
|
|
13
|
-
> **senderUserId**: `string`
|
|
14
|
-
|
|
15
|
-
***
|
|
16
|
-
|
|
17
|
-
### timestamp
|
|
18
|
-
|
|
19
|
-
> **timestamp**: `number`
|
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / ReceiverChain
|
|
6
|
-
|
|
7
|
-
# Interface: ReceiverChain
|
|
8
|
-
|
|
9
|
-
Receiver chain with skipped message keys.
|
|
10
|
-
|
|
11
|
-
The SDK maintains up to MAX_RECEIVER_CHAINS (5) receiver chains
|
|
12
|
-
to handle out-of-order DH ratchets.
|
|
13
|
-
|
|
14
|
-
## Properties
|
|
15
|
-
|
|
16
|
-
### chainKey
|
|
17
|
-
|
|
18
|
-
> **chainKey**: [`Base64`](../type-aliases/Base64.md) \| `null`
|
|
19
|
-
|
|
20
|
-
Chain key for deriving more message keys (proto: chain_key, field 2).
|
|
21
|
-
|
|
22
|
-
May be null if chain key is no longer needed (all expected messages received).
|
|
23
|
-
|
|
24
|
-
***
|
|
25
|
-
|
|
26
|
-
### messageKeys
|
|
27
|
-
|
|
28
|
-
> **messageKeys**: `StoredMessageKey`[]
|
|
29
|
-
|
|
30
|
-
Skipped message keys (proto: message_keys, field 3).
|
|
31
|
-
|
|
32
|
-
Keys are stored when messages arrive out of order. When the skipped
|
|
33
|
-
message arrives, its key is consumed (removed) from this array.
|
|
34
|
-
|
|
35
|
-
***
|
|
36
|
-
|
|
37
|
-
### senderRatchetKey
|
|
38
|
-
|
|
39
|
-
> **senderRatchetKey**: [`Base64`](../type-aliases/Base64.md)
|
|
40
|
-
|
|
41
|
-
Sender's ratchet public key (proto: sender_ratchet_key, field 1).
|
|
42
|
-
|
|
43
|
-
Identifies which DH ratchet epoch this chain belongs to.
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / RecipientUsernameSyncInput
|
|
6
|
-
|
|
7
|
-
# Interface: RecipientUsernameSyncInput
|
|
8
|
-
|
|
9
|
-
## Properties
|
|
10
|
-
|
|
11
|
-
### learnedAt
|
|
12
|
-
|
|
13
|
-
> **learnedAt**: `number`
|
|
14
|
-
|
|
15
|
-
***
|
|
16
|
-
|
|
17
|
-
### userId
|
|
18
|
-
|
|
19
|
-
> **userId**: `string`
|
|
20
|
-
|
|
21
|
-
***
|
|
22
|
-
|
|
23
|
-
### username
|
|
24
|
-
|
|
25
|
-
> **username**: `string` \| `null`
|
|
26
|
-
|
|
27
|
-
***
|
|
28
|
-
|
|
29
|
-
### uuid?
|
|
30
|
-
|
|
31
|
-
> `optional` **uuid?**: `string` \| `null`
|
|
@@ -1,254 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / RelayPreKeyBundle
|
|
6
|
-
|
|
7
|
-
# Interface: RelayPreKeyBundle
|
|
8
|
-
|
|
9
|
-
PreKey Bundle - Public keys for establishing an encrypted session
|
|
10
|
-
|
|
11
|
-
Contains all public information needed for X3DH/PQXDH key exchange.
|
|
12
|
-
Fetched from the server when initiating a session with a new device.
|
|
13
|
-
|
|
14
|
-
## Key Exchange Flow (PQXDH)
|
|
15
|
-
|
|
16
|
-
Alice fetches Bob's PreKeyBundle and computes:
|
|
17
|
-
```
|
|
18
|
-
DH1 = DH(Alice_IK, Bob_SPK) // Identity to Signed PreKey
|
|
19
|
-
DH2 = DH(Alice_EK, Bob_IK) // Ephemeral to Identity
|
|
20
|
-
DH3 = DH(Alice_EK, Bob_SPK) // Ephemeral to Signed PreKey
|
|
21
|
-
DH4 = DH(Alice_EK, Bob_OPK) // Ephemeral to One-Time PreKey (if available)
|
|
22
|
-
KEM = Encaps(Bob_MLKEM1024_PK) // Standardized ML-KEM-1024
|
|
23
|
-
|
|
24
|
-
SK = KDF(DH1 || DH2 || DH3 || DH4 || KEM_SS)
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## Bundle Contents
|
|
28
|
-
|
|
29
|
-
| Field | Type | Purpose | Lifetime |
|
|
30
|
-
|--------------------|-------------|--------------------------------------|----------------|
|
|
31
|
-
| registrationId | number | Detect app reinstalls | Per install |
|
|
32
|
-
| deviceId | number | Identify device (1=primary, 2-5) | Per device |
|
|
33
|
-
| identity | CompositeV1 | Per-user DH + signing trust object | Permanent |
|
|
34
|
-
| ecSignedPreKey | X25519+sig | Medium-term DH key (SPK) | Rotates weekly |
|
|
35
|
-
| ecOneTimePreKey | X25519 | Single-use forward secrecy (OPK) | Consumed once |
|
|
36
|
-
| kemLastResortPreKey| ML-KEM-1024 | Post-quantum protection (PQSPK) | Rotates weekly |
|
|
37
|
-
|
|
38
|
-
## Security Properties
|
|
39
|
-
|
|
40
|
-
These inputs support the profile's conditional hybrid-security and
|
|
41
|
-
one-time-prekey properties. See `docs/SECURITY.md` for their assumptions and
|
|
42
|
-
limits; this data shape alone is not a security proof.
|
|
43
|
-
|
|
44
|
-
## See
|
|
45
|
-
|
|
46
|
-
- https://signal.org/docs/specifications/pqxdh/
|
|
47
|
-
- https://signal.org/docs/specifications/x3dh/
|
|
48
|
-
|
|
49
|
-
## Properties
|
|
50
|
-
|
|
51
|
-
### deviceId
|
|
52
|
-
|
|
53
|
-
> **deviceId**: `number`
|
|
54
|
-
|
|
55
|
-
Device ID within this user's device set.
|
|
56
|
-
|
|
57
|
-
- Primary device: 1
|
|
58
|
-
- Linked devices: 2-5 (max 5 devices per user)
|
|
59
|
-
|
|
60
|
-
Used for multi-device fanout - messages are encrypted separately
|
|
61
|
-
for each of the recipient's devices.
|
|
62
|
-
|
|
63
|
-
***
|
|
64
|
-
|
|
65
|
-
### ecOneTimePreKey?
|
|
66
|
-
|
|
67
|
-
> `optional` **ecOneTimePreKey?**: \{ `keyId`: `number`; `publicKey`: [`PublicKey`](../type-aliases/PublicKey.md); \} \| `null`
|
|
68
|
-
|
|
69
|
-
EC One-Time PreKey (X25519, optional).
|
|
70
|
-
|
|
71
|
-
Single-use key consumed atomically on fetch. Provides additional
|
|
72
|
-
forward secrecy - if compromised, only affects one session.
|
|
73
|
-
|
|
74
|
-
May be null/undefined if the server has exhausted the prekey pool.
|
|
75
|
-
Session establishment still works without it (degraded to 3-DH).
|
|
76
|
-
|
|
77
|
-
#### Union Members
|
|
78
|
-
|
|
79
|
-
##### Type Literal
|
|
80
|
-
|
|
81
|
-
\{ `keyId`: `number`; `publicKey`: [`PublicKey`](../type-aliases/PublicKey.md); \}
|
|
82
|
-
|
|
83
|
-
##### keyId
|
|
84
|
-
|
|
85
|
-
> **keyId**: `number`
|
|
86
|
-
|
|
87
|
-
Key ID for tracking which key was consumed
|
|
88
|
-
|
|
89
|
-
##### publicKey
|
|
90
|
-
|
|
91
|
-
> **publicKey**: [`PublicKey`](../type-aliases/PublicKey.md)
|
|
92
|
-
|
|
93
|
-
X25519 public key (32 bytes, base64)
|
|
94
|
-
|
|
95
|
-
***
|
|
96
|
-
|
|
97
|
-
`null`
|
|
98
|
-
|
|
99
|
-
***
|
|
100
|
-
|
|
101
|
-
### ecSignedPreKey
|
|
102
|
-
|
|
103
|
-
> **ecSignedPreKey**: `object`
|
|
104
|
-
|
|
105
|
-
EC Signed PreKey (X25519 + Ed25519 signature).
|
|
106
|
-
|
|
107
|
-
Medium-term key that rotates weekly. Signed by identitySigningKey
|
|
108
|
-
to prove authenticity. Used for DH1 and DH3 in X3DH.
|
|
109
|
-
|
|
110
|
-
The signature covers the composite identity commitment, algorithm tag, key
|
|
111
|
-
ID, and public key in the profile's domain-separated context.
|
|
112
|
-
|
|
113
|
-
#### keyId
|
|
114
|
-
|
|
115
|
-
> **keyId**: `number`
|
|
116
|
-
|
|
117
|
-
Key ID for tracking which key was used
|
|
118
|
-
|
|
119
|
-
#### publicKey
|
|
120
|
-
|
|
121
|
-
> **publicKey**: [`PublicKey`](../type-aliases/PublicKey.md)
|
|
122
|
-
|
|
123
|
-
X25519 public key (32 bytes, base64)
|
|
124
|
-
|
|
125
|
-
#### signature
|
|
126
|
-
|
|
127
|
-
> **signature**: [`Signature`](../type-aliases/Signature.md)
|
|
128
|
-
|
|
129
|
-
Ed25519 signature over publicKey bytes (64 bytes, base64)
|
|
130
|
-
|
|
131
|
-
***
|
|
132
|
-
|
|
133
|
-
### identity
|
|
134
|
-
|
|
135
|
-
> **identity**: [`CompositeIdentityV1`](../namespaces/keys/interfaces/CompositeIdentityV1.md)
|
|
136
|
-
|
|
137
|
-
Versioned per-user identity trust object. ACI and PNI are independent.
|
|
138
|
-
Linked devices expose the same tuple; registration IDs and prekeys remain
|
|
139
|
-
device-specific. Consumers derive commitments locally.
|
|
140
|
-
|
|
141
|
-
***
|
|
142
|
-
|
|
143
|
-
### kemLastResortPreKey?
|
|
144
|
-
|
|
145
|
-
> `optional` **kemLastResortPreKey?**: \{ `keyId`: `number`; `publicKey`: [`PublicKey`](../type-aliases/PublicKey.md); `signature`: [`Signature`](../type-aliases/Signature.md); \} \| `null`
|
|
146
|
-
|
|
147
|
-
Last-resort KEM PreKey for PQXDH (ML-KEM-1024 + Ed25519 signature, optional).
|
|
148
|
-
|
|
149
|
-
Post-quantum key encapsulation mechanism. Provides protection against
|
|
150
|
-
"harvest now, decrypt later" attacks from quantum computers.
|
|
151
|
-
|
|
152
|
-
Reusable KEM prekey used when the server has exhausted the one-time KEM pool.
|
|
153
|
-
Server and relay adapters must not place one-time KEM material in this field;
|
|
154
|
-
use `kemOneTimePreKey` for consumed one-time KEM material.
|
|
155
|
-
|
|
156
|
-
- Public key: 1569 bytes (`0x0A` plus 1568 raw bytes; base64 encoded)
|
|
157
|
-
- Ciphertext: 1569 bytes (`0x0A` plus 1568 raw bytes)
|
|
158
|
-
- Shared secret: 32 bytes
|
|
159
|
-
|
|
160
|
-
The signature covers the complete tagged public key plus identity
|
|
161
|
-
commitment, algorithm tag, and key ID in a domain-separated context.
|
|
162
|
-
|
|
163
|
-
#### Union Members
|
|
164
|
-
|
|
165
|
-
##### Type Literal
|
|
166
|
-
|
|
167
|
-
\{ `keyId`: `number`; `publicKey`: [`PublicKey`](../type-aliases/PublicKey.md); `signature`: [`Signature`](../type-aliases/Signature.md); \}
|
|
168
|
-
|
|
169
|
-
##### keyId
|
|
170
|
-
|
|
171
|
-
> **keyId**: `number`
|
|
172
|
-
|
|
173
|
-
Key ID
|
|
174
|
-
|
|
175
|
-
##### publicKey
|
|
176
|
-
|
|
177
|
-
> **publicKey**: [`PublicKey`](../type-aliases/PublicKey.md)
|
|
178
|
-
|
|
179
|
-
Tagged ML-KEM-1024 public key (1569 bytes, base64)
|
|
180
|
-
|
|
181
|
-
##### signature
|
|
182
|
-
|
|
183
|
-
> **signature**: [`Signature`](../type-aliases/Signature.md)
|
|
184
|
-
|
|
185
|
-
Ed25519 signature over the profile's complete prekey context
|
|
186
|
-
|
|
187
|
-
***
|
|
188
|
-
|
|
189
|
-
`null`
|
|
190
|
-
|
|
191
|
-
#### See
|
|
192
|
-
|
|
193
|
-
https://signal.org/docs/specifications/pqxdh/
|
|
194
|
-
|
|
195
|
-
***
|
|
196
|
-
|
|
197
|
-
### kemOneTimePreKey?
|
|
198
|
-
|
|
199
|
-
> `optional` **kemOneTimePreKey?**: \{ `keyId`: `number`; `publicKey`: [`PublicKey`](../type-aliases/PublicKey.md); `signature`: [`Signature`](../type-aliases/Signature.md); \} \| `null`
|
|
200
|
-
|
|
201
|
-
KEM One-Time PreKey (ML-KEM-1024 + Ed25519 signature, optional).
|
|
202
|
-
|
|
203
|
-
Per PQXDH spec Section 3.2, these are signed one-time pqkem prekeys
|
|
204
|
-
that provide per-session post-quantum forward secrecy.
|
|
205
|
-
|
|
206
|
-
Server prefers these over the last-resort KEM prekey. Consumed atomically on
|
|
207
|
-
fetch (like EC one-time prekeys). A bundle should contain either this field
|
|
208
|
-
or `kemLastResortPreKey` as the selected KEM material for PQXDH.
|
|
209
|
-
|
|
210
|
-
May be null/undefined if the server has exhausted the prekey pool.
|
|
211
|
-
Session establishment still works without it (falls back to last-resort).
|
|
212
|
-
|
|
213
|
-
#### Union Members
|
|
214
|
-
|
|
215
|
-
##### Type Literal
|
|
216
|
-
|
|
217
|
-
\{ `keyId`: `number`; `publicKey`: [`PublicKey`](../type-aliases/PublicKey.md); `signature`: [`Signature`](../type-aliases/Signature.md); \}
|
|
218
|
-
|
|
219
|
-
##### keyId
|
|
220
|
-
|
|
221
|
-
> **keyId**: `number`
|
|
222
|
-
|
|
223
|
-
Key ID for tracking which key was consumed
|
|
224
|
-
|
|
225
|
-
##### publicKey
|
|
226
|
-
|
|
227
|
-
> **publicKey**: [`PublicKey`](../type-aliases/PublicKey.md)
|
|
228
|
-
|
|
229
|
-
Tagged ML-KEM-1024 public key (1569 bytes, base64)
|
|
230
|
-
|
|
231
|
-
##### signature
|
|
232
|
-
|
|
233
|
-
> **signature**: [`Signature`](../type-aliases/Signature.md)
|
|
234
|
-
|
|
235
|
-
Ed25519 signature over the profile's complete prekey context
|
|
236
|
-
|
|
237
|
-
***
|
|
238
|
-
|
|
239
|
-
`null`
|
|
240
|
-
|
|
241
|
-
#### See
|
|
242
|
-
|
|
243
|
-
https://signal.org/docs/specifications/pqxdh/#sending-the-initial-message
|
|
244
|
-
|
|
245
|
-
***
|
|
246
|
-
|
|
247
|
-
### registrationId
|
|
248
|
-
|
|
249
|
-
> **registrationId**: `number`
|
|
250
|
-
|
|
251
|
-
Registration ID - Random 16-bit integer generated on app install.
|
|
252
|
-
|
|
253
|
-
Changes when user reinstalls app, allowing peers to detect stale sessions
|
|
254
|
-
and re-establish encryption. Prevents replay of messages from old installs.
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / RemoteObjectDownload
|
|
6
|
-
|
|
7
|
-
# Interface: RemoteObjectDownload
|
|
8
|
-
|
|
9
|
-
Short-lived credentials for a direct object download.
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### downloadUrl
|
|
14
|
-
|
|
15
|
-
> **downloadUrl**: `string`
|
|
16
|
-
|
|
17
|
-
Short-lived download URL issued by the application's storage broker.
|
|
18
|
-
|
|
19
|
-
***
|
|
20
|
-
|
|
21
|
-
### expiresAt
|
|
22
|
-
|
|
23
|
-
> **expiresAt**: `number`
|
|
24
|
-
|
|
25
|
-
Unix timestamp in milliseconds when the download operation expires.
|
|
26
|
-
|
|
27
|
-
***
|
|
28
|
-
|
|
29
|
-
### headers?
|
|
30
|
-
|
|
31
|
-
> `optional` **headers?**: `Record`\<`string`, `string`\>
|
|
32
|
-
|
|
33
|
-
Request headers that must accompany the download.
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / RemoteObjectUpload
|
|
6
|
-
|
|
7
|
-
# Interface: RemoteObjectUpload
|
|
8
|
-
|
|
9
|
-
Short-lived credentials for a direct object upload.
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### expiresAt
|
|
14
|
-
|
|
15
|
-
> **expiresAt**: `number`
|
|
16
|
-
|
|
17
|
-
Unix timestamp in milliseconds when the upload operation expires.
|
|
18
|
-
|
|
19
|
-
***
|
|
20
|
-
|
|
21
|
-
### headers?
|
|
22
|
-
|
|
23
|
-
> `optional` **headers?**: `Record`\<`string`, `string`\>
|
|
24
|
-
|
|
25
|
-
Request headers that must accompany the upload.
|
|
26
|
-
|
|
27
|
-
***
|
|
28
|
-
|
|
29
|
-
### objectId
|
|
30
|
-
|
|
31
|
-
> **objectId**: `string`
|
|
32
|
-
|
|
33
|
-
Canonical opaque identifier assigned to the uploaded object.
|
|
34
|
-
|
|
35
|
-
***
|
|
36
|
-
|
|
37
|
-
### protocol?
|
|
38
|
-
|
|
39
|
-
> `optional` **protocol?**: `"put"` \| `"tus"`
|
|
40
|
-
|
|
41
|
-
Upload protocol. Direct PUT is used when omitted.
|
|
42
|
-
|
|
43
|
-
***
|
|
44
|
-
|
|
45
|
-
### uploadUrl
|
|
46
|
-
|
|
47
|
-
> **uploadUrl**: `string`
|
|
48
|
-
|
|
49
|
-
Short-lived upload URL issued by the application's storage broker.
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / ResolvedSPQRInfoStrings
|
|
6
|
-
|
|
7
|
-
# Interface: ResolvedSPQRInfoStrings
|
|
8
|
-
|
|
9
|
-
Resolved SPQR info strings for KDF operations.
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### chainAddEpoch
|
|
14
|
-
|
|
15
|
-
> **chainAddEpoch**: `string`
|
|
16
|
-
|
|
17
|
-
***
|
|
18
|
-
|
|
19
|
-
### chainNext
|
|
20
|
-
|
|
21
|
-
> **chainNext**: `string`
|
|
22
|
-
|
|
23
|
-
***
|
|
24
|
-
|
|
25
|
-
### chainStart
|
|
26
|
-
|
|
27
|
-
> **chainStart**: `string`
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / ResolvedSPQRLimits
|
|
6
|
-
|
|
7
|
-
# Interface: ResolvedSPQRLimits
|
|
8
|
-
|
|
9
|
-
Resolved SPQR limits with profile defaults applied.
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### maxMessageJump
|
|
14
|
-
|
|
15
|
-
> **maxMessageJump**: `number`
|
|
16
|
-
|
|
17
|
-
Max forward jump in message numbers.
|
|
18
|
-
|
|
19
|
-
#### Default
|
|
20
|
-
|
|
21
|
-
```ts
|
|
22
|
-
25000
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
***
|
|
26
|
-
|
|
27
|
-
### maxOutOfOrderKeys
|
|
28
|
-
|
|
29
|
-
> **maxOutOfOrderKeys**: `number`
|
|
30
|
-
|
|
31
|
-
Max out-of-order keys to store.
|
|
32
|
-
|
|
33
|
-
#### Default
|
|
34
|
-
|
|
35
|
-
```ts
|
|
36
|
-
2000
|
|
37
|
-
```
|
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / RetryRequest
|
|
6
|
-
|
|
7
|
-
# Interface: RetryRequest
|
|
8
|
-
|
|
9
|
-
Retry request message sent when decryption fails
|
|
10
|
-
Unencrypted message requesting sender to resend with updated session state
|
|
11
|
-
|
|
12
|
-
## Properties
|
|
13
|
-
|
|
14
|
-
### failedTimestamp
|
|
15
|
-
|
|
16
|
-
> **failedTimestamp**: `number`
|
|
17
|
-
|
|
18
|
-
Timestamp of the message that failed to decrypt.
|
|
19
|
-
Used to look up original message in MessageSendLog for resend.
|
|
20
|
-
|
|
21
|
-
***
|
|
22
|
-
|
|
23
|
-
### originalSenderDeviceId
|
|
24
|
-
|
|
25
|
-
> **originalSenderDeviceId**: `number`
|
|
26
|
-
|
|
27
|
-
Original sender's device ID
|
|
28
|
-
|
|
29
|
-
***
|
|
30
|
-
|
|
31
|
-
### originalSenderUserId
|
|
32
|
-
|
|
33
|
-
> **originalSenderUserId**: `string`
|
|
34
|
-
|
|
35
|
-
Original sender's user ID
|
|
36
|
-
|
|
37
|
-
***
|
|
38
|
-
|
|
39
|
-
### ratchetKey?
|
|
40
|
-
|
|
41
|
-
> `optional` **ratchetKey?**: `string`
|
|
42
|
-
|
|
43
|
-
Sender ratchet key from the failed message (1:1 messages only).
|
|
44
|
-
|
|
45
|
-
Allows the sender to verify that a session-reset request targets the active
|
|
46
|
-
ratchet.
|
|
47
|
-
|
|
48
|
-
Undefined for sender-key/group failures.
|
|
49
|
-
|
|
50
|
-
***
|
|
51
|
-
|
|
52
|
-
### reason
|
|
53
|
-
|
|
54
|
-
> **reason**: `RetryReason`
|
|
55
|
-
|
|
56
|
-
Reason for retry (for debugging/logging)
|
|
57
|
-
|
|
58
|
-
***
|
|
59
|
-
|
|
60
|
-
### requesterDeviceId
|
|
61
|
-
|
|
62
|
-
> **requesterDeviceId**: `number`
|
|
63
|
-
|
|
64
|
-
Requester's device ID
|
|
65
|
-
|
|
66
|
-
***
|
|
67
|
-
|
|
68
|
-
### requesterUserId
|
|
69
|
-
|
|
70
|
-
> **requesterUserId**: `string`
|
|
71
|
-
|
|
72
|
-
Requester's user ID
|
|
73
|
-
|
|
74
|
-
***
|
|
75
|
-
|
|
76
|
-
### timestamp
|
|
77
|
-
|
|
78
|
-
> **timestamp**: `number`
|
|
79
|
-
|
|
80
|
-
Timestamp of this retry request
|