@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,1337 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / ISignalProtocolRelayServer
|
|
6
|
-
|
|
7
|
-
# Interface: ISignalProtocolRelayServer
|
|
8
|
-
|
|
9
|
-
Server-side relay for encrypted envelope push delivery.
|
|
10
|
-
|
|
11
|
-
Responsibilities:
|
|
12
|
-
- Envelope delivery (push to devices via real-time subscription)
|
|
13
|
-
- Device registry (multi-device support, max 5 devices per user)
|
|
14
|
-
- Prekey management (X3DH/PQXDH key exchange)
|
|
15
|
-
|
|
16
|
-
Maps to 17 Convex tables.
|
|
17
|
-
|
|
18
|
-
## Example
|
|
19
|
-
|
|
20
|
-
```typescript
|
|
21
|
-
const relay: ISignalProtocolRelayServer = new ConvexSignalProtocolRelayServer(convex, signalApi, {
|
|
22
|
-
currentUserId: userId,
|
|
23
|
-
});
|
|
24
|
-
|
|
25
|
-
// Subscribe to incoming envelopes
|
|
26
|
-
const unsubscribe = relay.subscribe(userId, deviceId, (envelope) => {
|
|
27
|
-
// Decrypt and process
|
|
28
|
-
});
|
|
29
|
-
|
|
30
|
-
// Send encrypted envelope
|
|
31
|
-
await relay.send({
|
|
32
|
-
targetUserId: 'bob',
|
|
33
|
-
targetDeviceId: 1,
|
|
34
|
-
senderUserId: 'alice',
|
|
35
|
-
senderDeviceId: 1,
|
|
36
|
-
ciphertext: encryptedBytes,
|
|
37
|
-
messageType: 'ciphertext',
|
|
38
|
-
});
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
## Extends
|
|
42
|
-
|
|
43
|
-
- `IProvisioningService`.`IKeyRotationService`
|
|
44
|
-
|
|
45
|
-
## Properties
|
|
46
|
-
|
|
47
|
-
### groupServer?
|
|
48
|
-
|
|
49
|
-
> `readonly` `optional` **groupServer?**: [`IRelayGroupServer`](IRelayGroupServer.md)
|
|
50
|
-
|
|
51
|
-
Optional conforming Group System transport and issuance capability.
|
|
52
|
-
|
|
53
|
-
## Methods
|
|
54
|
-
|
|
55
|
-
### acknowledgeProvisioning()
|
|
56
|
-
|
|
57
|
-
> **acknowledgeProvisioning**(`sessionId`): `Promise`\<`void`\>
|
|
58
|
-
|
|
59
|
-
Acknowledge that the linked device finished persisting its local
|
|
60
|
-
bootstrap state, allowing the backend to clear the reversible
|
|
61
|
-
provisioning session state.
|
|
62
|
-
|
|
63
|
-
#### Parameters
|
|
64
|
-
|
|
65
|
-
##### sessionId
|
|
66
|
-
|
|
67
|
-
`string`
|
|
68
|
-
|
|
69
|
-
Session ID to finalize
|
|
70
|
-
|
|
71
|
-
#### Returns
|
|
72
|
-
|
|
73
|
-
`Promise`\<`void`\>
|
|
74
|
-
|
|
75
|
-
#### Inherited from
|
|
76
|
-
|
|
77
|
-
`IProvisioningService.acknowledgeProvisioning`
|
|
78
|
-
|
|
79
|
-
***
|
|
80
|
-
|
|
81
|
-
### clearStaleKemPreKeys()
|
|
82
|
-
|
|
83
|
-
> **clearStaleKemPreKeys**(`userId`, `deviceId`, `identityType?`): `Promise`\<\{ `cleared`: `number`; \}\>
|
|
84
|
-
|
|
85
|
-
Clear stale KEM one-time prekeys during recovery.
|
|
86
|
-
|
|
87
|
-
Called when PREKEY_NOT_FOUND indicates Bob has stale one-time KEM keys
|
|
88
|
-
on the server that he no longer has private keys for. Clearing them lets
|
|
89
|
-
subsequent bundle fetches select a current one-time or last-resort key.
|
|
90
|
-
|
|
91
|
-
#### Parameters
|
|
92
|
-
|
|
93
|
-
##### userId
|
|
94
|
-
|
|
95
|
-
`string`
|
|
96
|
-
|
|
97
|
-
User ID
|
|
98
|
-
|
|
99
|
-
##### deviceId
|
|
100
|
-
|
|
101
|
-
`number`
|
|
102
|
-
|
|
103
|
-
Device ID
|
|
104
|
-
|
|
105
|
-
##### identityType?
|
|
106
|
-
|
|
107
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
108
|
-
|
|
109
|
-
#### Returns
|
|
110
|
-
|
|
111
|
-
`Promise`\<\{ `cleared`: `number`; \}\>
|
|
112
|
-
|
|
113
|
-
Number of keys cleared
|
|
114
|
-
|
|
115
|
-
***
|
|
116
|
-
|
|
117
|
-
### completeProvisioning()
|
|
118
|
-
|
|
119
|
-
> **completeProvisioning**(`sessionId`, `deviceMetadata`): `Promise`\<\{ `deviceId`: `number`; \}\>
|
|
120
|
-
|
|
121
|
-
Mark provisioning as complete and finalize linked-device registration.
|
|
122
|
-
|
|
123
|
-
#### Parameters
|
|
124
|
-
|
|
125
|
-
##### sessionId
|
|
126
|
-
|
|
127
|
-
`string`
|
|
128
|
-
|
|
129
|
-
Session ID to complete
|
|
130
|
-
|
|
131
|
-
##### deviceMetadata
|
|
132
|
-
|
|
133
|
-
Final device metadata, including the encrypted device name
|
|
134
|
-
|
|
135
|
-
###### appVersion?
|
|
136
|
-
|
|
137
|
-
`string`
|
|
138
|
-
|
|
139
|
-
###### encryptedDeviceName
|
|
140
|
-
|
|
141
|
-
`ArrayBuffer`
|
|
142
|
-
|
|
143
|
-
###### osVersion?
|
|
144
|
-
|
|
145
|
-
`string`
|
|
146
|
-
|
|
147
|
-
###### platform?
|
|
148
|
-
|
|
149
|
-
`string`
|
|
150
|
-
|
|
151
|
-
#### Returns
|
|
152
|
-
|
|
153
|
-
`Promise`\<\{ `deviceId`: `number`; \}\>
|
|
154
|
-
|
|
155
|
-
#### Inherited from
|
|
156
|
-
|
|
157
|
-
`IProvisioningService.completeProvisioning`
|
|
158
|
-
|
|
159
|
-
***
|
|
160
|
-
|
|
161
|
-
### connectNewDevice()
|
|
162
|
-
|
|
163
|
-
> **connectNewDevice**(`sessionId`, `ephemeralPublicKey`, `deviceMetadata`): `Promise`\<`void`\>
|
|
164
|
-
|
|
165
|
-
Connect a new device to an existing provisioning session.
|
|
166
|
-
|
|
167
|
-
#### Parameters
|
|
168
|
-
|
|
169
|
-
##### sessionId
|
|
170
|
-
|
|
171
|
-
`string`
|
|
172
|
-
|
|
173
|
-
Provisioning session ID from QR code
|
|
174
|
-
|
|
175
|
-
##### ephemeralPublicKey
|
|
176
|
-
|
|
177
|
-
`string`
|
|
178
|
-
|
|
179
|
-
New device's ECDH public key (Base64)
|
|
180
|
-
|
|
181
|
-
##### deviceMetadata
|
|
182
|
-
|
|
183
|
-
Non-sensitive device information available before provisioning completes
|
|
184
|
-
|
|
185
|
-
###### appVersion?
|
|
186
|
-
|
|
187
|
-
`string`
|
|
188
|
-
|
|
189
|
-
###### osVersion?
|
|
190
|
-
|
|
191
|
-
`string`
|
|
192
|
-
|
|
193
|
-
###### platform?
|
|
194
|
-
|
|
195
|
-
`string`
|
|
196
|
-
|
|
197
|
-
#### Returns
|
|
198
|
-
|
|
199
|
-
`Promise`\<`void`\>
|
|
200
|
-
|
|
201
|
-
#### Inherited from
|
|
202
|
-
|
|
203
|
-
`IProvisioningService.connectNewDevice`
|
|
204
|
-
|
|
205
|
-
***
|
|
206
|
-
|
|
207
|
-
### createGroupState()
|
|
208
|
-
|
|
209
|
-
> **createGroupState**(`groupId`, `encryptedState`, `authorization`): `Promise`\<`void`\>
|
|
210
|
-
|
|
211
|
-
Create a new encrypted group on the server.
|
|
212
|
-
Server stores opaque ciphertext and never decrypts.
|
|
213
|
-
|
|
214
|
-
#### Parameters
|
|
215
|
-
|
|
216
|
-
##### groupId
|
|
217
|
-
|
|
218
|
-
`Uint8Array`
|
|
219
|
-
|
|
220
|
-
32-byte group identifier
|
|
221
|
-
|
|
222
|
-
##### encryptedState
|
|
223
|
-
|
|
224
|
-
`Uint8Array`
|
|
225
|
-
|
|
226
|
-
Serialized EncryptedGroup (opaque to server)
|
|
227
|
-
|
|
228
|
-
##### authorization
|
|
229
|
-
|
|
230
|
-
[`GroupAuthorization`](GroupAuthorization.md)
|
|
231
|
-
|
|
232
|
-
ZK auth credential for anonymous group access
|
|
233
|
-
|
|
234
|
-
#### Returns
|
|
235
|
-
|
|
236
|
-
`Promise`\<`void`\>
|
|
237
|
-
|
|
238
|
-
***
|
|
239
|
-
|
|
240
|
-
### createProvisioningSession()
|
|
241
|
-
|
|
242
|
-
> **createProvisioningSession**(`userId`, `ephemeralPublicKey`): `Promise`\<\{ `sessionId`: `string`; \}\>
|
|
243
|
-
|
|
244
|
-
Create a new provisioning session.
|
|
245
|
-
|
|
246
|
-
#### Parameters
|
|
247
|
-
|
|
248
|
-
##### userId
|
|
249
|
-
|
|
250
|
-
`string`
|
|
251
|
-
|
|
252
|
-
User ID creating the session
|
|
253
|
-
|
|
254
|
-
##### ephemeralPublicKey
|
|
255
|
-
|
|
256
|
-
`string`
|
|
257
|
-
|
|
258
|
-
Base64-encoded ECDH public key for key agreement
|
|
259
|
-
|
|
260
|
-
#### Returns
|
|
261
|
-
|
|
262
|
-
`Promise`\<\{ `sessionId`: `string`; \}\>
|
|
263
|
-
|
|
264
|
-
Session ID for the provisioning flow
|
|
265
|
-
|
|
266
|
-
#### Inherited from
|
|
267
|
-
|
|
268
|
-
`IProvisioningService.createProvisioningSession`
|
|
269
|
-
|
|
270
|
-
***
|
|
271
|
-
|
|
272
|
-
### deleteProvisioningSession()
|
|
273
|
-
|
|
274
|
-
> **deleteProvisioningSession**(`sessionId`, `userId?`): `Promise`\<`void`\>
|
|
275
|
-
|
|
276
|
-
Delete/cancel a provisioning session.
|
|
277
|
-
|
|
278
|
-
#### Parameters
|
|
279
|
-
|
|
280
|
-
##### sessionId
|
|
281
|
-
|
|
282
|
-
`string`
|
|
283
|
-
|
|
284
|
-
Session ID to delete
|
|
285
|
-
|
|
286
|
-
##### userId?
|
|
287
|
-
|
|
288
|
-
`string`
|
|
289
|
-
|
|
290
|
-
#### Returns
|
|
291
|
-
|
|
292
|
-
`Promise`\<`void`\>
|
|
293
|
-
|
|
294
|
-
#### Inherited from
|
|
295
|
-
|
|
296
|
-
`IProvisioningService.deleteProvisioningSession`
|
|
297
|
-
|
|
298
|
-
***
|
|
299
|
-
|
|
300
|
-
### fetchPreKeyBundle()
|
|
301
|
-
|
|
302
|
-
> **fetchPreKeyBundle**(`userId`, `deviceId`, `fetcherUserId?`, `identityType?`): `Promise`\<[`RelayPreKeyBundle`](RelayPreKeyBundle.md) \| `null`\>
|
|
303
|
-
|
|
304
|
-
Fetch prekey bundle for session establishment.
|
|
305
|
-
|
|
306
|
-
Atomically consumes one EC and one KEM one-time prekey.
|
|
307
|
-
Returns bundle with identity key, signed prekey, and optional one-time keys.
|
|
308
|
-
|
|
309
|
-
#### Parameters
|
|
310
|
-
|
|
311
|
-
##### userId
|
|
312
|
-
|
|
313
|
-
`string`
|
|
314
|
-
|
|
315
|
-
Target user ID
|
|
316
|
-
|
|
317
|
-
##### deviceId
|
|
318
|
-
|
|
319
|
-
`number`
|
|
320
|
-
|
|
321
|
-
Target device ID
|
|
322
|
-
|
|
323
|
-
##### fetcherUserId?
|
|
324
|
-
|
|
325
|
-
`string`
|
|
326
|
-
|
|
327
|
-
Deprecated, ignored. Fetcher identity is derived from auth server-side.
|
|
328
|
-
|
|
329
|
-
##### identityType?
|
|
330
|
-
|
|
331
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
332
|
-
|
|
333
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
334
|
-
|
|
335
|
-
#### Returns
|
|
336
|
-
|
|
337
|
-
`Promise`\<[`RelayPreKeyBundle`](RelayPreKeyBundle.md) \| `null`\>
|
|
338
|
-
|
|
339
|
-
Prekey bundle or null if device not found
|
|
340
|
-
|
|
341
|
-
***
|
|
342
|
-
|
|
343
|
-
### fetchSenderCertificate()?
|
|
344
|
-
|
|
345
|
-
> `optional` **fetchSenderCertificate**(`deviceId`): `Promise`\<`string`\>
|
|
346
|
-
|
|
347
|
-
Fetch a sender certificate for sealed sender messaging.
|
|
348
|
-
|
|
349
|
-
The certificate binds the user's uuid, deviceId, and identity key,
|
|
350
|
-
signed by the server's trust root key. Expires after 24 hours.
|
|
351
|
-
|
|
352
|
-
#### Parameters
|
|
353
|
-
|
|
354
|
-
##### deviceId
|
|
355
|
-
|
|
356
|
-
`number`
|
|
357
|
-
|
|
358
|
-
Device ID (1-5) to bind the certificate to
|
|
359
|
-
|
|
360
|
-
#### Returns
|
|
361
|
-
|
|
362
|
-
`Promise`\<`string`\>
|
|
363
|
-
|
|
364
|
-
Base64-encoded serialized SenderCertificate
|
|
365
|
-
|
|
366
|
-
***
|
|
367
|
-
|
|
368
|
-
### getActiveDevices()
|
|
369
|
-
|
|
370
|
-
> **getActiveDevices**(`userId`): `Promise`\<[`GroupMemberDevice`](GroupMemberDevice.md)[]\>
|
|
371
|
-
|
|
372
|
-
Get all active devices for a user.
|
|
373
|
-
Used for local-first member resolution (caller provides user IDs,
|
|
374
|
-
relay resolves to device IDs).
|
|
375
|
-
|
|
376
|
-
#### Parameters
|
|
377
|
-
|
|
378
|
-
##### userId
|
|
379
|
-
|
|
380
|
-
`string`
|
|
381
|
-
|
|
382
|
-
#### Returns
|
|
383
|
-
|
|
384
|
-
`Promise`\<[`GroupMemberDevice`](GroupMemberDevice.md)[]\>
|
|
385
|
-
|
|
386
|
-
***
|
|
387
|
-
|
|
388
|
-
### getDevices()
|
|
389
|
-
|
|
390
|
-
> **getDevices**(`userId`): `Promise`\<[`DeviceInfo`](DeviceInfo.md)[]\>
|
|
391
|
-
|
|
392
|
-
Get all active devices for a user.
|
|
393
|
-
Used for multi-device fanout during encryption.
|
|
394
|
-
|
|
395
|
-
#### Parameters
|
|
396
|
-
|
|
397
|
-
##### userId
|
|
398
|
-
|
|
399
|
-
`string`
|
|
400
|
-
|
|
401
|
-
Target user ID
|
|
402
|
-
|
|
403
|
-
#### Returns
|
|
404
|
-
|
|
405
|
-
`Promise`\<[`DeviceInfo`](DeviceInfo.md)[]\>
|
|
406
|
-
|
|
407
|
-
Array of device info (max 5 devices)
|
|
408
|
-
|
|
409
|
-
***
|
|
410
|
-
|
|
411
|
-
### getEcSignedPreKeyMetadata()
|
|
412
|
-
|
|
413
|
-
> **getEcSignedPreKeyMetadata**(`userId`, `deviceId`, `identityType?`): `Promise`\<\{ `createdAt`: `number`; `expiresAt`: `number`; `keyId`: `number`; `publicKey`: `string`; \} \| `null`\>
|
|
414
|
-
|
|
415
|
-
Get EC signed prekey metadata for rotation checks and server key verification.
|
|
416
|
-
|
|
417
|
-
#### Parameters
|
|
418
|
-
|
|
419
|
-
##### userId
|
|
420
|
-
|
|
421
|
-
`string`
|
|
422
|
-
|
|
423
|
-
User ID
|
|
424
|
-
|
|
425
|
-
##### deviceId
|
|
426
|
-
|
|
427
|
-
`number`
|
|
428
|
-
|
|
429
|
-
Device ID
|
|
430
|
-
|
|
431
|
-
##### identityType?
|
|
432
|
-
|
|
433
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
434
|
-
|
|
435
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
436
|
-
|
|
437
|
-
#### Returns
|
|
438
|
-
|
|
439
|
-
`Promise`\<\{ `createdAt`: `number`; `expiresAt`: `number`; `keyId`: `number`; `publicKey`: `string`; \} \| `null`\>
|
|
440
|
-
|
|
441
|
-
Metadata with timestamps and publicKey, or null if no key exists
|
|
442
|
-
|
|
443
|
-
#### Inherited from
|
|
444
|
-
|
|
445
|
-
`IKeyRotationService.getEcSignedPreKeyMetadata`
|
|
446
|
-
|
|
447
|
-
***
|
|
448
|
-
|
|
449
|
-
### getGroupChanges()
|
|
450
|
-
|
|
451
|
-
> **getGroupChanges**(`groupId`, `fromVersion`, `authorization`): `Promise`\<[`GroupChangeEntry`](GroupChangeEntry.md)[]\>
|
|
452
|
-
|
|
453
|
-
Get group change log entries after a given version.
|
|
454
|
-
Used for incremental state synchronization.
|
|
455
|
-
|
|
456
|
-
#### Parameters
|
|
457
|
-
|
|
458
|
-
##### groupId
|
|
459
|
-
|
|
460
|
-
`Uint8Array`
|
|
461
|
-
|
|
462
|
-
32-byte group identifier
|
|
463
|
-
|
|
464
|
-
##### fromVersion
|
|
465
|
-
|
|
466
|
-
`number`
|
|
467
|
-
|
|
468
|
-
Fetch changes with version > fromVersion
|
|
469
|
-
|
|
470
|
-
##### authorization
|
|
471
|
-
|
|
472
|
-
[`GroupAuthorization`](GroupAuthorization.md)
|
|
473
|
-
|
|
474
|
-
ZK auth credential for anonymous group access
|
|
475
|
-
|
|
476
|
-
#### Returns
|
|
477
|
-
|
|
478
|
-
`Promise`\<[`GroupChangeEntry`](GroupChangeEntry.md)[]\>
|
|
479
|
-
|
|
480
|
-
Array of change log entries in version order
|
|
481
|
-
|
|
482
|
-
***
|
|
483
|
-
|
|
484
|
-
### getGroupMembers()
|
|
485
|
-
|
|
486
|
-
> **getGroupMembers**(`groupId`): `Promise`\<[`GroupMemberDevice`](GroupMemberDevice.md)[]\>
|
|
487
|
-
|
|
488
|
-
Get all devices in a group for message fanout.
|
|
489
|
-
Used for Sender Key group message delivery.
|
|
490
|
-
|
|
491
|
-
#### Parameters
|
|
492
|
-
|
|
493
|
-
##### groupId
|
|
494
|
-
|
|
495
|
-
`string`
|
|
496
|
-
|
|
497
|
-
Group identifier
|
|
498
|
-
|
|
499
|
-
#### Returns
|
|
500
|
-
|
|
501
|
-
`Promise`\<[`GroupMemberDevice`](GroupMemberDevice.md)[]\>
|
|
502
|
-
|
|
503
|
-
Array of member devices
|
|
504
|
-
|
|
505
|
-
***
|
|
506
|
-
|
|
507
|
-
### getGroupState()
|
|
508
|
-
|
|
509
|
-
> **getGroupState**(`groupId`, `authorization`): `Promise`\<\{ `encryptedState`: `Uint8Array`; `version`: `number`; \} \| `null`\>
|
|
510
|
-
|
|
511
|
-
Get the latest encrypted group state.
|
|
512
|
-
|
|
513
|
-
#### Parameters
|
|
514
|
-
|
|
515
|
-
##### groupId
|
|
516
|
-
|
|
517
|
-
`Uint8Array`
|
|
518
|
-
|
|
519
|
-
32-byte group identifier
|
|
520
|
-
|
|
521
|
-
##### authorization
|
|
522
|
-
|
|
523
|
-
[`GroupAuthorization`](GroupAuthorization.md)
|
|
524
|
-
|
|
525
|
-
ZK auth credential for anonymous group access
|
|
526
|
-
|
|
527
|
-
#### Returns
|
|
528
|
-
|
|
529
|
-
`Promise`\<\{ `encryptedState`: `Uint8Array`; `version`: `number`; \} \| `null`\>
|
|
530
|
-
|
|
531
|
-
Encrypted state + current version, or null if not found
|
|
532
|
-
|
|
533
|
-
***
|
|
534
|
-
|
|
535
|
-
### getIdentityKey()
|
|
536
|
-
|
|
537
|
-
> **getIdentityKey**(`userId`, `identityType?`): `Promise`\<[`CompositeIdentityV1`](../namespaces/keys/interfaces/CompositeIdentityV1.md) \| `null`\>
|
|
538
|
-
|
|
539
|
-
Get the account-level canonical composite identity.
|
|
540
|
-
|
|
541
|
-
#### Parameters
|
|
542
|
-
|
|
543
|
-
##### userId
|
|
544
|
-
|
|
545
|
-
`string`
|
|
546
|
-
|
|
547
|
-
Target user ID
|
|
548
|
-
|
|
549
|
-
##### identityType?
|
|
550
|
-
|
|
551
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
552
|
-
|
|
553
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
554
|
-
|
|
555
|
-
#### Returns
|
|
556
|
-
|
|
557
|
-
`Promise`\<[`CompositeIdentityV1`](../namespaces/keys/interfaces/CompositeIdentityV1.md) \| `null`\>
|
|
558
|
-
|
|
559
|
-
Composite identity or null if not found
|
|
560
|
-
|
|
561
|
-
***
|
|
562
|
-
|
|
563
|
-
### getKemLastResortPreKeyMetadata()
|
|
564
|
-
|
|
565
|
-
> **getKemLastResortPreKeyMetadata**(`userId`, `deviceId`, `identityType?`): `Promise`\<\{ `createdAt`: `number`; `expiresAt`: `number`; `keyId`: `number`; `publicKey`: `string`; \} \| `null`\>
|
|
566
|
-
|
|
567
|
-
Get KEM last-resort prekey metadata for rotation checks and server key verification.
|
|
568
|
-
|
|
569
|
-
#### Parameters
|
|
570
|
-
|
|
571
|
-
##### userId
|
|
572
|
-
|
|
573
|
-
`string`
|
|
574
|
-
|
|
575
|
-
User ID
|
|
576
|
-
|
|
577
|
-
##### deviceId
|
|
578
|
-
|
|
579
|
-
`number`
|
|
580
|
-
|
|
581
|
-
Device ID
|
|
582
|
-
|
|
583
|
-
##### identityType?
|
|
584
|
-
|
|
585
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
586
|
-
|
|
587
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
588
|
-
|
|
589
|
-
#### Returns
|
|
590
|
-
|
|
591
|
-
`Promise`\<\{ `createdAt`: `number`; `expiresAt`: `number`; `keyId`: `number`; `publicKey`: `string`; \} \| `null`\>
|
|
592
|
-
|
|
593
|
-
Metadata with timestamps, publicKey, and keyId, or null if no key exists
|
|
594
|
-
|
|
595
|
-
#### Inherited from
|
|
596
|
-
|
|
597
|
-
`IKeyRotationService.getKemLastResortPreKeyMetadata`
|
|
598
|
-
|
|
599
|
-
***
|
|
600
|
-
|
|
601
|
-
### getPreKeyCount()
|
|
602
|
-
|
|
603
|
-
> **getPreKeyCount**(`userId`, `deviceId`, `type`, `identityType?`): `Promise`\<`number`\>
|
|
604
|
-
|
|
605
|
-
Get count of remaining one-time prekeys.
|
|
606
|
-
Client should upload more when count < 10.
|
|
607
|
-
|
|
608
|
-
#### Parameters
|
|
609
|
-
|
|
610
|
-
##### userId
|
|
611
|
-
|
|
612
|
-
`string`
|
|
613
|
-
|
|
614
|
-
User ID
|
|
615
|
-
|
|
616
|
-
##### deviceId
|
|
617
|
-
|
|
618
|
-
`number`
|
|
619
|
-
|
|
620
|
-
Device ID
|
|
621
|
-
|
|
622
|
-
##### type
|
|
623
|
-
|
|
624
|
-
`"ec"` \| `"kem"`
|
|
625
|
-
|
|
626
|
-
'ec' for X25519, 'kem' for ML-KEM-1024
|
|
627
|
-
|
|
628
|
-
##### identityType?
|
|
629
|
-
|
|
630
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
631
|
-
|
|
632
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
633
|
-
|
|
634
|
-
#### Returns
|
|
635
|
-
|
|
636
|
-
`Promise`\<`number`\>
|
|
637
|
-
|
|
638
|
-
***
|
|
639
|
-
|
|
640
|
-
### getProvisioningMessage()
|
|
641
|
-
|
|
642
|
-
> **getProvisioningMessage**(`sessionId`): `Promise`\<\{ `message`: `string` \| `null`; `status`: `"completed"` \| `"waiting"` \| `"connected"` \| `"ready"` \| `"linked_pending_ack"` \| `"rolled_back"` \| `"expired"`; \}\>
|
|
643
|
-
|
|
644
|
-
Get provisioning message for new device.
|
|
645
|
-
|
|
646
|
-
#### Parameters
|
|
647
|
-
|
|
648
|
-
##### sessionId
|
|
649
|
-
|
|
650
|
-
`string`
|
|
651
|
-
|
|
652
|
-
Provisioning session ID
|
|
653
|
-
|
|
654
|
-
#### Returns
|
|
655
|
-
|
|
656
|
-
`Promise`\<\{ `message`: `string` \| `null`; `status`: `"completed"` \| `"waiting"` \| `"connected"` \| `"ready"` \| `"linked_pending_ack"` \| `"rolled_back"` \| `"expired"`; \}\>
|
|
657
|
-
|
|
658
|
-
Status and encrypted message (if ready)
|
|
659
|
-
|
|
660
|
-
#### Inherited from
|
|
661
|
-
|
|
662
|
-
`IProvisioningService.getProvisioningMessage`
|
|
663
|
-
|
|
664
|
-
***
|
|
665
|
-
|
|
666
|
-
### heartbeat()
|
|
667
|
-
|
|
668
|
-
> **heartbeat**(`deviceId`): `Promise`\<`void`\>
|
|
669
|
-
|
|
670
|
-
Lightweight heartbeat — writes only to heartbeat table, triggers 0 query reruns
|
|
671
|
-
|
|
672
|
-
#### Parameters
|
|
673
|
-
|
|
674
|
-
##### deviceId
|
|
675
|
-
|
|
676
|
-
`number`
|
|
677
|
-
|
|
678
|
-
#### Returns
|
|
679
|
-
|
|
680
|
-
`Promise`\<`void`\>
|
|
681
|
-
|
|
682
|
-
***
|
|
683
|
-
|
|
684
|
-
### issueAuthCredential()
|
|
685
|
-
|
|
686
|
-
> **issueAuthCredential**(`userId`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
|
687
|
-
|
|
688
|
-
Issue a blinded auth credential for anonymous group access.
|
|
689
|
-
|
|
690
|
-
#### Parameters
|
|
691
|
-
|
|
692
|
-
##### userId
|
|
693
|
-
|
|
694
|
-
`string`
|
|
695
|
-
|
|
696
|
-
User requesting the credential
|
|
697
|
-
|
|
698
|
-
#### Returns
|
|
699
|
-
|
|
700
|
-
`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
|
701
|
-
|
|
702
|
-
Blinded auth credential bytes
|
|
703
|
-
|
|
704
|
-
***
|
|
705
|
-
|
|
706
|
-
### markDelivered()
|
|
707
|
-
|
|
708
|
-
> **markDelivered**(`envelopeId`): `Promise`\<`void`\>
|
|
709
|
-
|
|
710
|
-
Mark envelope as delivered.
|
|
711
|
-
Depending on privacy settings, may delete immediately or mark for cleanup.
|
|
712
|
-
|
|
713
|
-
#### Parameters
|
|
714
|
-
|
|
715
|
-
##### envelopeId
|
|
716
|
-
|
|
717
|
-
`string`
|
|
718
|
-
|
|
719
|
-
ID from send() or subscription
|
|
720
|
-
|
|
721
|
-
#### Returns
|
|
722
|
-
|
|
723
|
-
`Promise`\<`void`\>
|
|
724
|
-
|
|
725
|
-
***
|
|
726
|
-
|
|
727
|
-
### markDeviceConnected()
|
|
728
|
-
|
|
729
|
-
> **markDeviceConnected**(`deviceId`): `Promise`\<`void`\>
|
|
730
|
-
|
|
731
|
-
Mark device as connected (online).
|
|
732
|
-
Called when WebSocket connects.
|
|
733
|
-
userId is derived from JWT server-side.
|
|
734
|
-
|
|
735
|
-
#### Parameters
|
|
736
|
-
|
|
737
|
-
##### deviceId
|
|
738
|
-
|
|
739
|
-
`number`
|
|
740
|
-
|
|
741
|
-
Device ID (1-5)
|
|
742
|
-
|
|
743
|
-
#### Returns
|
|
744
|
-
|
|
745
|
-
`Promise`\<`void`\>
|
|
746
|
-
|
|
747
|
-
***
|
|
748
|
-
|
|
749
|
-
### markDeviceDisconnected()
|
|
750
|
-
|
|
751
|
-
> **markDeviceDisconnected**(`deviceId`): `Promise`\<`void`\>
|
|
752
|
-
|
|
753
|
-
Mark device as disconnected (offline).
|
|
754
|
-
Called when WebSocket disconnects gracefully.
|
|
755
|
-
userId is derived from JWT server-side.
|
|
756
|
-
|
|
757
|
-
#### Parameters
|
|
758
|
-
|
|
759
|
-
##### deviceId
|
|
760
|
-
|
|
761
|
-
`number`
|
|
762
|
-
|
|
763
|
-
Device ID (1-5)
|
|
764
|
-
|
|
765
|
-
#### Returns
|
|
766
|
-
|
|
767
|
-
`Promise`\<`void`\>
|
|
768
|
-
|
|
769
|
-
***
|
|
770
|
-
|
|
771
|
-
### provisionIdentityKey()
|
|
772
|
-
|
|
773
|
-
> **provisionIdentityKey**(`request`): `Promise`\<`void`\>
|
|
774
|
-
|
|
775
|
-
Provision a device against the account-level canonical composite identity.
|
|
776
|
-
Creates an absent identity, accepts an exact tuple match for linked
|
|
777
|
-
devices, and rejects a different tuple without mutating device metadata.
|
|
778
|
-
|
|
779
|
-
#### Parameters
|
|
780
|
-
|
|
781
|
-
##### request
|
|
782
|
-
|
|
783
|
-
[`AccountIdentityProvisioning`](AccountIdentityProvisioning.md)
|
|
784
|
-
|
|
785
|
-
#### Returns
|
|
786
|
-
|
|
787
|
-
`Promise`\<`void`\>
|
|
788
|
-
|
|
789
|
-
***
|
|
790
|
-
|
|
791
|
-
### refreshGroupSendEndorsements()?
|
|
792
|
-
|
|
793
|
-
> `optional` **refreshGroupSendEndorsements**(`groupId`, `authorization`): `Promise`\<\{ `endorsements`: `Uint8Array`; `expiration`: `number`; \}\>
|
|
794
|
-
|
|
795
|
-
Refresh group send endorsements from the server.
|
|
796
|
-
Returns serialized endorsement response and expiration.
|
|
797
|
-
|
|
798
|
-
#### Parameters
|
|
799
|
-
|
|
800
|
-
##### groupId
|
|
801
|
-
|
|
802
|
-
`Uint8Array`
|
|
803
|
-
|
|
804
|
-
32-byte group identifier
|
|
805
|
-
|
|
806
|
-
##### authorization
|
|
807
|
-
|
|
808
|
-
[`GroupAuthorization`](GroupAuthorization.md)
|
|
809
|
-
|
|
810
|
-
ZK auth presentation + group public params
|
|
811
|
-
|
|
812
|
-
#### Returns
|
|
813
|
-
|
|
814
|
-
`Promise`\<\{ `endorsements`: `Uint8Array`; `expiration`: `number`; \}\>
|
|
815
|
-
|
|
816
|
-
Endorsement response bytes and expiration epoch seconds
|
|
817
|
-
|
|
818
|
-
***
|
|
819
|
-
|
|
820
|
-
### registerDevice()
|
|
821
|
-
|
|
822
|
-
> **registerDevice**(`userId`, `device`): `Promise`\<`number`\>
|
|
823
|
-
|
|
824
|
-
Register this device with the server.
|
|
825
|
-
|
|
826
|
-
For first device: deviceId = 1 (PRIMARY_ID)
|
|
827
|
-
For linked devices: server assigns 2-5
|
|
828
|
-
|
|
829
|
-
#### Parameters
|
|
830
|
-
|
|
831
|
-
##### userId
|
|
832
|
-
|
|
833
|
-
`string`
|
|
834
|
-
|
|
835
|
-
Current user ID
|
|
836
|
-
|
|
837
|
-
##### device
|
|
838
|
-
|
|
839
|
-
[`DeviceRegistration`](DeviceRegistration.md)
|
|
840
|
-
|
|
841
|
-
Device registration info
|
|
842
|
-
|
|
843
|
-
#### Returns
|
|
844
|
-
|
|
845
|
-
`Promise`\<`number`\>
|
|
846
|
-
|
|
847
|
-
Assigned device ID
|
|
848
|
-
|
|
849
|
-
***
|
|
850
|
-
|
|
851
|
-
### removeDevice()
|
|
852
|
-
|
|
853
|
-
> **removeDevice**(`userId`, `deviceId`): `Promise`\<`void`\>
|
|
854
|
-
|
|
855
|
-
Remove a device from the registry.
|
|
856
|
-
Also deletes all prekeys and pending envelopes for that device.
|
|
857
|
-
|
|
858
|
-
#### Parameters
|
|
859
|
-
|
|
860
|
-
##### userId
|
|
861
|
-
|
|
862
|
-
`string`
|
|
863
|
-
|
|
864
|
-
User ID
|
|
865
|
-
|
|
866
|
-
##### deviceId
|
|
867
|
-
|
|
868
|
-
`number`
|
|
869
|
-
|
|
870
|
-
Device to remove
|
|
871
|
-
|
|
872
|
-
#### Returns
|
|
873
|
-
|
|
874
|
-
`Promise`\<`void`\>
|
|
875
|
-
|
|
876
|
-
***
|
|
877
|
-
|
|
878
|
-
### rollbackProvisioning()
|
|
879
|
-
|
|
880
|
-
> **rollbackProvisioning**(`sessionId`): `Promise`\<`void`\>
|
|
881
|
-
|
|
882
|
-
Undo a completed provisioning link if the new device fails to persist its
|
|
883
|
-
local bootstrap state after the server-side link succeeded.
|
|
884
|
-
|
|
885
|
-
#### Parameters
|
|
886
|
-
|
|
887
|
-
##### sessionId
|
|
888
|
-
|
|
889
|
-
`string`
|
|
890
|
-
|
|
891
|
-
Session ID to roll back
|
|
892
|
-
|
|
893
|
-
#### Returns
|
|
894
|
-
|
|
895
|
-
`Promise`\<`void`\>
|
|
896
|
-
|
|
897
|
-
#### Inherited from
|
|
898
|
-
|
|
899
|
-
`IProvisioningService.rollbackProvisioning`
|
|
900
|
-
|
|
901
|
-
***
|
|
902
|
-
|
|
903
|
-
### rotateIdentityKey()
|
|
904
|
-
|
|
905
|
-
> **rotateIdentityKey**(`request`): `Promise`\<`void`\>
|
|
906
|
-
|
|
907
|
-
Rotate an existing account-level composite identity using compare-and-swap.
|
|
908
|
-
A successful rotation invalidates prekeys for every linked device in the
|
|
909
|
-
selected identity namespace.
|
|
910
|
-
|
|
911
|
-
#### Parameters
|
|
912
|
-
|
|
913
|
-
##### request
|
|
914
|
-
|
|
915
|
-
[`AccountIdentityRotation`](AccountIdentityRotation.md)
|
|
916
|
-
|
|
917
|
-
#### Returns
|
|
918
|
-
|
|
919
|
-
`Promise`\<`void`\>
|
|
920
|
-
|
|
921
|
-
***
|
|
922
|
-
|
|
923
|
-
### send()
|
|
924
|
-
|
|
925
|
-
> **send**(`envelope`): `Promise`\<\{ `messageId`: `string`; `serverTimestamp`: `number`; \}\>
|
|
926
|
-
|
|
927
|
-
Send encrypted envelope to a device.
|
|
928
|
-
Server pushes to recipient via their subscription.
|
|
929
|
-
|
|
930
|
-
#### Parameters
|
|
931
|
-
|
|
932
|
-
##### envelope
|
|
933
|
-
|
|
934
|
-
[`Envelope`](Envelope.md)
|
|
935
|
-
|
|
936
|
-
Encrypted envelope with targeting info
|
|
937
|
-
|
|
938
|
-
#### Returns
|
|
939
|
-
|
|
940
|
-
`Promise`\<\{ `messageId`: `string`; `serverTimestamp`: `number`; \}\>
|
|
941
|
-
|
|
942
|
-
Message ID and server timestamp (for delivery receipt matching)
|
|
943
|
-
|
|
944
|
-
***
|
|
945
|
-
|
|
946
|
-
### sendMultiRecipientUnidentified()?
|
|
947
|
-
|
|
948
|
-
> `optional` **sendMultiRecipientUnidentified**(`sentMessageBase64`, `auth`, `timestamp`, `groupId?`, `recipientUserIds?`, `clientMessageId?`): `Promise`\<\{ `messageId`: `string`; `serverTimestamp`: `number`; `uuids404`: `string`[]; \}\>
|
|
949
|
-
|
|
950
|
-
Send a V2 multi-recipient sealed sender message.
|
|
951
|
-
|
|
952
|
-
Client sends the full V2 binary blob (base64-encoded).
|
|
953
|
-
Relay parses client-side, sends structured JSON to mutation.
|
|
954
|
-
Server constructs per-device ReceivedMessage blobs and fans out.
|
|
955
|
-
|
|
956
|
-
#### Parameters
|
|
957
|
-
|
|
958
|
-
##### sentMessageBase64
|
|
959
|
-
|
|
960
|
-
`string`
|
|
961
|
-
|
|
962
|
-
Base64-encoded V2 multi-recipient binary blob
|
|
963
|
-
|
|
964
|
-
##### auth
|
|
965
|
-
|
|
966
|
-
[`SealedSenderAuth`](../type-aliases/SealedSenderAuth.md)
|
|
967
|
-
|
|
968
|
-
Sealed sender authentication (access key or group send token)
|
|
969
|
-
|
|
970
|
-
##### timestamp
|
|
971
|
-
|
|
972
|
-
`number`
|
|
973
|
-
|
|
974
|
-
Client timestamp for message identification
|
|
975
|
-
|
|
976
|
-
##### groupId?
|
|
977
|
-
|
|
978
|
-
`string`
|
|
979
|
-
|
|
980
|
-
Optional group ID for group messages
|
|
981
|
-
|
|
982
|
-
##### recipientUserIds?
|
|
983
|
-
|
|
984
|
-
`string`[]
|
|
985
|
-
|
|
986
|
-
Original user IDs in same order as binary recipients
|
|
987
|
-
|
|
988
|
-
##### clientMessageId?
|
|
989
|
-
|
|
990
|
-
`string`
|
|
991
|
-
|
|
992
|
-
#### Returns
|
|
993
|
-
|
|
994
|
-
`Promise`\<\{ `messageId`: `string`; `serverTimestamp`: `number`; `uuids404`: `string`[]; \}\>
|
|
995
|
-
|
|
996
|
-
Message ID, server timestamp, and list of unknown recipient UUIDs
|
|
997
|
-
|
|
998
|
-
***
|
|
999
|
-
|
|
1000
|
-
### sendProvisioningMessage()
|
|
1001
|
-
|
|
1002
|
-
> **sendProvisioningMessage**(`sessionId`, `encryptedMessage`, `userId?`): `Promise`\<`void`\>
|
|
1003
|
-
|
|
1004
|
-
Send encrypted provisioning message from primary to new device.
|
|
1005
|
-
|
|
1006
|
-
#### Parameters
|
|
1007
|
-
|
|
1008
|
-
##### sessionId
|
|
1009
|
-
|
|
1010
|
-
`string`
|
|
1011
|
-
|
|
1012
|
-
Provisioning session ID
|
|
1013
|
-
|
|
1014
|
-
##### encryptedMessage
|
|
1015
|
-
|
|
1016
|
-
`string`
|
|
1017
|
-
|
|
1018
|
-
AES-GCM encrypted payload (JSON string with ciphertext, iv, authTag)
|
|
1019
|
-
|
|
1020
|
-
##### userId?
|
|
1021
|
-
|
|
1022
|
-
`string`
|
|
1023
|
-
|
|
1024
|
-
#### Returns
|
|
1025
|
-
|
|
1026
|
-
`Promise`\<`void`\>
|
|
1027
|
-
|
|
1028
|
-
#### Inherited from
|
|
1029
|
-
|
|
1030
|
-
`IProvisioningService.sendProvisioningMessage`
|
|
1031
|
-
|
|
1032
|
-
***
|
|
1033
|
-
|
|
1034
|
-
### sendRetryRequest()?
|
|
1035
|
-
|
|
1036
|
-
> `optional` **sendRetryRequest**(`request`): `Promise`\<`void`\>
|
|
1037
|
-
|
|
1038
|
-
Send retry request to the original sender.
|
|
1039
|
-
|
|
1040
|
-
Called by recipient when decryption fails. The retry request is
|
|
1041
|
-
unencrypted (per SESAME spec) and contains only the message ID
|
|
1042
|
-
and reason. Transport is TLS-secured.
|
|
1043
|
-
|
|
1044
|
-
#### Parameters
|
|
1045
|
-
|
|
1046
|
-
##### request
|
|
1047
|
-
|
|
1048
|
-
[`RetryRequest`](RetryRequest.md)
|
|
1049
|
-
|
|
1050
|
-
Retry request with sender/requester info and failed sequence number
|
|
1051
|
-
|
|
1052
|
-
#### Returns
|
|
1053
|
-
|
|
1054
|
-
`Promise`\<`void`\>
|
|
1055
|
-
|
|
1056
|
-
***
|
|
1057
|
-
|
|
1058
|
-
### sendUnidentified()?
|
|
1059
|
-
|
|
1060
|
-
> `optional` **sendUnidentified**(`envelope`, `auth`): `Promise`\<\{ `messageId`: `string`; `serverTimestamp`: `number`; \}\>
|
|
1061
|
-
|
|
1062
|
-
Send a sealed sender message (anonymous delivery).
|
|
1063
|
-
|
|
1064
|
-
The server does NOT know the sender. The ciphertext is an
|
|
1065
|
-
UnidentifiedSenderMessage that the recipient unseals to discover
|
|
1066
|
-
the sender's identity via the embedded certificate.
|
|
1067
|
-
|
|
1068
|
-
#### Parameters
|
|
1069
|
-
|
|
1070
|
-
##### envelope
|
|
1071
|
-
|
|
1072
|
-
[`Envelope`](Envelope.md)
|
|
1073
|
-
|
|
1074
|
-
Sealed sender envelope (senderUserId/senderDeviceId are empty strings/0)
|
|
1075
|
-
|
|
1076
|
-
##### auth
|
|
1077
|
-
|
|
1078
|
-
[`SealedSenderAuth`](../type-aliases/SealedSenderAuth.md)
|
|
1079
|
-
|
|
1080
|
-
Authentication for anonymous delivery (access key or group send token)
|
|
1081
|
-
|
|
1082
|
-
#### Returns
|
|
1083
|
-
|
|
1084
|
-
`Promise`\<\{ `messageId`: `string`; `serverTimestamp`: `number`; \}\>
|
|
1085
|
-
|
|
1086
|
-
Message ID and server timestamp
|
|
1087
|
-
|
|
1088
|
-
***
|
|
1089
|
-
|
|
1090
|
-
### submitGroupChange()
|
|
1091
|
-
|
|
1092
|
-
> **submitGroupChange**(`groupId`, `expectedVersion`, `encryptedChange`, `updatedEncryptedState`, `authorization`): `Promise`\<\{ `serverSignature`: `Uint8Array`; \}\>
|
|
1093
|
-
|
|
1094
|
-
Submit a group change with optimistic concurrency control.
|
|
1095
|
-
Server validates expectedVersion === currentVersion before accepting.
|
|
1096
|
-
|
|
1097
|
-
#### Parameters
|
|
1098
|
-
|
|
1099
|
-
##### groupId
|
|
1100
|
-
|
|
1101
|
-
`Uint8Array`
|
|
1102
|
-
|
|
1103
|
-
32-byte group identifier
|
|
1104
|
-
|
|
1105
|
-
##### expectedVersion
|
|
1106
|
-
|
|
1107
|
-
`number`
|
|
1108
|
-
|
|
1109
|
-
Expected current version (for optimistic concurrency)
|
|
1110
|
-
|
|
1111
|
-
##### encryptedChange
|
|
1112
|
-
|
|
1113
|
-
`Uint8Array`
|
|
1114
|
-
|
|
1115
|
-
Serialized GroupChange (opaque)
|
|
1116
|
-
|
|
1117
|
-
##### updatedEncryptedState
|
|
1118
|
-
|
|
1119
|
-
`Uint8Array`
|
|
1120
|
-
|
|
1121
|
-
New full encrypted state after this change
|
|
1122
|
-
|
|
1123
|
-
##### authorization
|
|
1124
|
-
|
|
1125
|
-
[`GroupAuthorization`](GroupAuthorization.md)
|
|
1126
|
-
|
|
1127
|
-
ZK auth credential for anonymous group access
|
|
1128
|
-
|
|
1129
|
-
#### Returns
|
|
1130
|
-
|
|
1131
|
-
`Promise`\<\{ `serverSignature`: `Uint8Array`; \}\>
|
|
1132
|
-
|
|
1133
|
-
Server signature binding this change
|
|
1134
|
-
|
|
1135
|
-
#### Throws
|
|
1136
|
-
|
|
1137
|
-
ConflictError if expectedVersion !== currentVersion
|
|
1138
|
-
|
|
1139
|
-
***
|
|
1140
|
-
|
|
1141
|
-
### subscribe()
|
|
1142
|
-
|
|
1143
|
-
> **subscribe**(`userId`, `deviceId`, `onEnvelope`, `options?`): [`Unsubscribe`](../type-aliases/Unsubscribe.md)
|
|
1144
|
-
|
|
1145
|
-
Subscribe to incoming envelopes for this device.
|
|
1146
|
-
Real-time push via Convex subscription / WebSocket.
|
|
1147
|
-
|
|
1148
|
-
#### Parameters
|
|
1149
|
-
|
|
1150
|
-
##### userId
|
|
1151
|
-
|
|
1152
|
-
`string`
|
|
1153
|
-
|
|
1154
|
-
Current user ID
|
|
1155
|
-
|
|
1156
|
-
##### deviceId
|
|
1157
|
-
|
|
1158
|
-
`number`
|
|
1159
|
-
|
|
1160
|
-
This device's ID (1-5)
|
|
1161
|
-
|
|
1162
|
-
##### onEnvelope
|
|
1163
|
-
|
|
1164
|
-
(`envelope`) => `void`
|
|
1165
|
-
|
|
1166
|
-
Callback for each incoming envelope
|
|
1167
|
-
|
|
1168
|
-
##### options?
|
|
1169
|
-
|
|
1170
|
-
Optional batching callbacks for notification coalescing
|
|
1171
|
-
|
|
1172
|
-
###### onBatchEnd?
|
|
1173
|
-
|
|
1174
|
-
() => `void`
|
|
1175
|
-
|
|
1176
|
-
Called when batch is complete (idle detected)
|
|
1177
|
-
|
|
1178
|
-
###### onBatchStart?
|
|
1179
|
-
|
|
1180
|
-
() => `void`
|
|
1181
|
-
|
|
1182
|
-
Called when first message in a batch arrives
|
|
1183
|
-
|
|
1184
|
-
#### Returns
|
|
1185
|
-
|
|
1186
|
-
[`Unsubscribe`](../type-aliases/Unsubscribe.md)
|
|
1187
|
-
|
|
1188
|
-
Unsubscribe function
|
|
1189
|
-
|
|
1190
|
-
***
|
|
1191
|
-
|
|
1192
|
-
### subscribeRetryRequests()?
|
|
1193
|
-
|
|
1194
|
-
> `optional` **subscribeRetryRequests**(`userId`, `deviceId`, `handler`): [`Unsubscribe`](../type-aliases/Unsubscribe.md)
|
|
1195
|
-
|
|
1196
|
-
Subscribe to incoming retry requests for this device.
|
|
1197
|
-
|
|
1198
|
-
Called by sender to listen for retry requests from recipients.
|
|
1199
|
-
When a retry request arrives, the sender should:
|
|
1200
|
-
1. Look up the MessageRecord by sequence number
|
|
1201
|
-
2. Fetch the requester's current prekey bundle
|
|
1202
|
-
3. Establish a new session (X3DH/PQXDH)
|
|
1203
|
-
4. Re-encrypt and send the original message
|
|
1204
|
-
|
|
1205
|
-
#### Parameters
|
|
1206
|
-
|
|
1207
|
-
##### userId
|
|
1208
|
-
|
|
1209
|
-
`string`
|
|
1210
|
-
|
|
1211
|
-
Current user ID (the original sender)
|
|
1212
|
-
|
|
1213
|
-
##### deviceId
|
|
1214
|
-
|
|
1215
|
-
`number`
|
|
1216
|
-
|
|
1217
|
-
This device's ID
|
|
1218
|
-
|
|
1219
|
-
##### handler
|
|
1220
|
-
|
|
1221
|
-
(`request`) => `Promise`\<`void`\>
|
|
1222
|
-
|
|
1223
|
-
Callback for each incoming retry request
|
|
1224
|
-
|
|
1225
|
-
#### Returns
|
|
1226
|
-
|
|
1227
|
-
[`Unsubscribe`](../type-aliases/Unsubscribe.md)
|
|
1228
|
-
|
|
1229
|
-
Unsubscribe function
|
|
1230
|
-
|
|
1231
|
-
***
|
|
1232
|
-
|
|
1233
|
-
### uploadEcSignedPreKey()
|
|
1234
|
-
|
|
1235
|
-
> **uploadEcSignedPreKey**(`userId`, `ecSignedPreKey`, `identityType?`): `Promise`\<`void`\>
|
|
1236
|
-
|
|
1237
|
-
Upload an EC signed prekey.
|
|
1238
|
-
Convenience wrapper around uploadPreKeys for key rotation.
|
|
1239
|
-
|
|
1240
|
-
#### Parameters
|
|
1241
|
-
|
|
1242
|
-
##### userId
|
|
1243
|
-
|
|
1244
|
-
`string`
|
|
1245
|
-
|
|
1246
|
-
User ID
|
|
1247
|
-
|
|
1248
|
-
##### ecSignedPreKey
|
|
1249
|
-
|
|
1250
|
-
[`EcSignedPreKeyUpload`](EcSignedPreKeyUpload.md)
|
|
1251
|
-
|
|
1252
|
-
EC signed prekey to upload
|
|
1253
|
-
|
|
1254
|
-
##### identityType?
|
|
1255
|
-
|
|
1256
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
1257
|
-
|
|
1258
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
1259
|
-
|
|
1260
|
-
#### Returns
|
|
1261
|
-
|
|
1262
|
-
`Promise`\<`void`\>
|
|
1263
|
-
|
|
1264
|
-
***
|
|
1265
|
-
|
|
1266
|
-
### uploadKemLastResortPreKey()
|
|
1267
|
-
|
|
1268
|
-
> **uploadKemLastResortPreKey**(`userId`, `kemLastResortPreKey`, `identityType?`): `Promise`\<`void`\>
|
|
1269
|
-
|
|
1270
|
-
Upload a KEM last-resort (post-quantum) prekey.
|
|
1271
|
-
Convenience wrapper around uploadPreKeys for key rotation.
|
|
1272
|
-
|
|
1273
|
-
#### Parameters
|
|
1274
|
-
|
|
1275
|
-
##### userId
|
|
1276
|
-
|
|
1277
|
-
`string`
|
|
1278
|
-
|
|
1279
|
-
User ID
|
|
1280
|
-
|
|
1281
|
-
##### kemLastResortPreKey
|
|
1282
|
-
|
|
1283
|
-
[`KemLastResortPreKeyUpload`](KemLastResortPreKeyUpload.md)
|
|
1284
|
-
|
|
1285
|
-
KEM last-resort prekey to upload
|
|
1286
|
-
|
|
1287
|
-
##### identityType?
|
|
1288
|
-
|
|
1289
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
1290
|
-
|
|
1291
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
1292
|
-
|
|
1293
|
-
#### Returns
|
|
1294
|
-
|
|
1295
|
-
`Promise`\<`void`\>
|
|
1296
|
-
|
|
1297
|
-
***
|
|
1298
|
-
|
|
1299
|
-
### uploadPreKeys()
|
|
1300
|
-
|
|
1301
|
-
> **uploadPreKeys**(`userId`, `deviceId`, `keys`, `identityType?`): `Promise`\<`void`\>
|
|
1302
|
-
|
|
1303
|
-
Upload prekeys for this device (batch upload).
|
|
1304
|
-
|
|
1305
|
-
Typically called:
|
|
1306
|
-
- On registration: 100 EC + 1 signed + 100 KEM + 1 last-resort
|
|
1307
|
-
- When count < 10: replenish one-time keys
|
|
1308
|
-
|
|
1309
|
-
#### Parameters
|
|
1310
|
-
|
|
1311
|
-
##### userId
|
|
1312
|
-
|
|
1313
|
-
`string`
|
|
1314
|
-
|
|
1315
|
-
User ID
|
|
1316
|
-
|
|
1317
|
-
##### deviceId
|
|
1318
|
-
|
|
1319
|
-
`number`
|
|
1320
|
-
|
|
1321
|
-
Device ID
|
|
1322
|
-
|
|
1323
|
-
##### keys
|
|
1324
|
-
|
|
1325
|
-
[`PreKeyUpload`](PreKeyUpload.md)[]
|
|
1326
|
-
|
|
1327
|
-
Array of prekeys to upload
|
|
1328
|
-
|
|
1329
|
-
##### identityType?
|
|
1330
|
-
|
|
1331
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
1332
|
-
|
|
1333
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
1334
|
-
|
|
1335
|
-
#### Returns
|
|
1336
|
-
|
|
1337
|
-
`Promise`\<`void`\>
|