@open-e2ee/signal-protocol-sdk 0.1.0-alpha.6 → 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/ARCHITECTURE.md +1 -1
- package/CHANGELOG.md +876 -3
- 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 +32 -28
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +136 -80
- package/dist/client/client.js.map +1 -1
- package/dist/client/compose.d.ts +6 -1
- package/dist/client/compose.d.ts.map +1 -1
- package/dist/client/compose.js +2 -0
- package/dist/client/compose.js.map +1 -1
- package/dist/client/config.d.ts +53 -19
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/config.js.map +1 -1
- package/dist/client/endorsement-manager.d.ts +23 -2
- package/dist/client/endorsement-manager.d.ts.map +1 -1
- package/dist/client/endorsement-manager.js +35 -10
- package/dist/client/endorsement-manager.js.map +1 -1
- package/dist/client/groups.d.ts +29 -29
- package/dist/client/groups.d.ts.map +1 -1
- package/dist/client/groups.js +54 -37
- package/dist/client/groups.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 +21 -2
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +119 -53
- 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/groups/index.d.ts +4 -4
- package/dist/groups/index.d.ts.map +1 -1
- package/dist/groups/index.js +3 -3
- package/dist/groups/index.js.map +1 -1
- package/dist/index.d.ts +12 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +10 -3
- 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/access-control.d.ts +170 -0
- package/dist/internal/groups/access-control.d.ts.map +1 -0
- package/dist/internal/groups/access-control.js +284 -0
- package/dist/internal/groups/access-control.js.map +1 -0
- package/dist/internal/groups/change-actions.d.ts +57 -0
- package/dist/internal/groups/change-actions.d.ts.map +1 -0
- package/dist/internal/groups/change-actions.js +827 -0
- package/dist/internal/groups/change-actions.js.map +1 -0
- package/dist/internal/groups/change-authorization.d.ts +16 -0
- package/dist/internal/groups/change-authorization.d.ts.map +1 -0
- package/dist/internal/groups/change-authorization.js +120 -0
- package/dist/internal/groups/change-authorization.js.map +1 -0
- package/dist/internal/{groups-v2 → groups}/encrypted-state.d.ts +12 -2
- package/dist/internal/groups/encrypted-state.d.ts.map +1 -0
- package/dist/internal/{groups-v2 → groups}/encrypted-state.js +122 -22
- package/dist/internal/groups/encrypted-state.js.map +1 -0
- package/dist/internal/groups/group-id.d.ts +9 -9
- package/dist/internal/groups/group-id.d.ts.map +1 -1
- package/dist/internal/groups/group-id.js +11 -12
- package/dist/internal/groups/group-id.js.map +1 -1
- package/dist/internal/groups/index.d.ts +16 -6
- package/dist/internal/groups/index.d.ts.map +1 -1
- package/dist/internal/groups/index.js +9 -1
- package/dist/internal/groups/index.js.map +1 -1
- package/dist/internal/groups/invite-link.d.ts.map +1 -0
- package/dist/internal/groups/invite-link.js.map +1 -0
- package/dist/internal/{groups-v2 → groups}/manager.d.ts +188 -40
- package/dist/internal/groups/manager.d.ts.map +1 -0
- package/dist/internal/groups/manager.js +1923 -0
- package/dist/internal/groups/manager.js.map +1 -0
- package/dist/internal/groups/sdk-store.d.ts +32 -0
- package/dist/internal/groups/sdk-store.d.ts.map +1 -0
- package/dist/internal/groups/sdk-store.js +111 -0
- package/dist/internal/groups/sdk-store.js.map +1 -0
- package/dist/internal/groups/server-engine.d.ts +83 -0
- package/dist/internal/groups/server-engine.d.ts.map +1 -0
- package/dist/internal/groups/server-engine.js +1186 -0
- package/dist/internal/groups/server-engine.js.map +1 -0
- package/dist/internal/groups/trust-root.d.ts +32 -0
- package/dist/internal/groups/trust-root.d.ts.map +1 -0
- package/dist/internal/groups/trust-root.js +91 -0
- package/dist/internal/groups/trust-root.js.map +1 -0
- package/dist/internal/{groups-v2 → groups}/types.d.ts +188 -46
- package/dist/internal/groups/types.d.ts.map +1 -0
- package/dist/internal/{groups-v2 → groups}/types.js +3 -2
- package/dist/internal/groups/types.js.map +1 -0
- package/dist/internal/groups/wire.d.ts +68 -0
- package/dist/internal/groups/wire.d.ts.map +1 -0
- package/dist/internal/groups/wire.js +708 -0
- package/dist/internal/groups/wire.js.map +1 -0
- 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/index.d.ts +1 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts +38 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +109 -8
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/zk/groups/auth-credential.d.ts +9 -7
- package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/auth-credential.js +68 -29
- package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
- package/dist/internal/protocol/zk/groups/server-params.d.ts +1 -1
- package/dist/internal/protocol/zk/groups/server-params.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/server-params.js.map +1 -1
- package/dist/internal/protocol/zk/groups/uid-struct.d.ts +2 -0
- package/dist/internal/protocol/zk/groups/uid-struct.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/uid-struct.js +4 -0
- package/dist/internal/protocol/zk/groups/uid-struct.js.map +1 -1
- package/dist/layers.d.ts +1 -1
- package/dist/layers.js +3 -3
- package/dist/layers.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 +25 -21
- package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
- package/dist/remote/relay/convex/group-server.js +51 -21
- 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 +54 -67
- package/dist/remote/relay/convex/relay.d.ts.map +1 -1
- package/dist/remote/relay/convex/relay.js +123 -42
- 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/mock/adapter.d.ts +33 -20
- package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
- package/dist/remote/relay/mock/adapter.js +98 -81
- package/dist/remote/relay/mock/adapter.js.map +1 -1
- package/dist/remote/relay/mock/group-server.d.ts +9 -0
- package/dist/remote/relay/mock/group-server.d.ts.map +1 -0
- package/dist/remote/relay/mock/group-server.js +9 -0
- package/dist/remote/relay/mock/group-server.js.map +1 -0
- package/dist/remote/relay/types.d.ts +73 -79
- 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 +23 -2
- 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 +77 -41
- package/docs/E2EE.md +71 -6
- package/docs/GETTING_STARTED.md +1 -1
- package/docs/PACKAGE_SURFACE.md +6 -0
- package/docs/RECIPES.md +1 -1
- package/docs/SECURITY.md +8 -0
- package/groups/README.md +16 -5
- package/local/store/expo/README.md +10 -1
- package/local/store/node/README.md +10 -1
- package/package.json +20 -4
- package/remote/relay/convex/README.md +6 -0
- package/remote/relay/convex/component/README.md +428 -0
- package/scripts/oe-groups.mjs +162 -0
- package/dist/internal/groups-v2/access-control.d.ts +0 -108
- package/dist/internal/groups-v2/access-control.d.ts.map +0 -1
- package/dist/internal/groups-v2/access-control.js +0 -191
- package/dist/internal/groups-v2/access-control.js.map +0 -1
- package/dist/internal/groups-v2/change-actions.d.ts +0 -40
- package/dist/internal/groups-v2/change-actions.d.ts.map +0 -1
- package/dist/internal/groups-v2/change-actions.js +0 -363
- package/dist/internal/groups-v2/change-actions.js.map +0 -1
- package/dist/internal/groups-v2/encrypted-state.d.ts.map +0 -1
- package/dist/internal/groups-v2/encrypted-state.js.map +0 -1
- package/dist/internal/groups-v2/index.d.ts +0 -19
- package/dist/internal/groups-v2/index.d.ts.map +0 -1
- package/dist/internal/groups-v2/index.js +0 -11
- package/dist/internal/groups-v2/index.js.map +0 -1
- package/dist/internal/groups-v2/invite-link.d.ts.map +0 -1
- package/dist/internal/groups-v2/invite-link.js.map +0 -1
- package/dist/internal/groups-v2/manager.d.ts.map +0 -1
- package/dist/internal/groups-v2/manager.js +0 -1095
- package/dist/internal/groups-v2/manager.js.map +0 -1
- package/dist/internal/groups-v2/types.d.ts.map +0 -1
- package/dist/internal/groups-v2/types.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 -307
- 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/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/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/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 -1329
- 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 -693
- package/docs/api/interfaces/SignalProtocolClientConfig.md +0 -839
- package/docs/api/interfaces/SignalProtocolClientDeleteLocalAttachmentInput.md +0 -25
- package/docs/api/interfaces/SignalProtocolClientHooks.md +0 -506
- package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +0 -35
- 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_V2_PREFIX.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/dist/internal/{groups-v2 → groups}/invite-link.d.ts +0 -0
- /package/dist/internal/{groups-v2 → groups}/invite-link.js +0 -0
|
@@ -1,1033 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / IProtocolStore
|
|
6
|
-
|
|
7
|
-
# Interface: IProtocolStore
|
|
8
|
-
|
|
9
|
-
Aggregate protocol store interface.
|
|
10
|
-
|
|
11
|
-
Combines the five focused local-store responsibilities into one interface.
|
|
12
|
-
|
|
13
|
-
## Extends
|
|
14
|
-
|
|
15
|
-
- [`IIdentityKeyStore`](IIdentityKeyStore.md).[`IEcOneTimePreKeyStore`](IEcOneTimePreKeyStore.md).[`IEcSignedPreKeyStore`](IEcSignedPreKeyStore.md).[`IKyberLastResortPreKeyStore`](IKyberLastResortPreKeyStore.md).[`IKemPreKeyStore`](IKemPreKeyStore.md).[`ISessionStore`](ISessionStore.md)
|
|
16
|
-
|
|
17
|
-
## Extended by
|
|
18
|
-
|
|
19
|
-
- [`ISignalProtocolLocalStore`](ISignalProtocolLocalStore.md)
|
|
20
|
-
|
|
21
|
-
## Methods
|
|
22
|
-
|
|
23
|
-
### acceptContactIdentityRotation()
|
|
24
|
-
|
|
25
|
-
> **acceptContactIdentityRotation**(`address`, `identity`, `identityType?`, `suppliedCommitment?`): `Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md)\>
|
|
26
|
-
|
|
27
|
-
Explicitly accept a changed tuple and atomically delete every session for
|
|
28
|
-
that user; the previous tuple becomes rollback history.
|
|
29
|
-
|
|
30
|
-
#### Parameters
|
|
31
|
-
|
|
32
|
-
##### address
|
|
33
|
-
|
|
34
|
-
[`ProtocolAddress`](ProtocolAddress.md)
|
|
35
|
-
|
|
36
|
-
##### identity
|
|
37
|
-
|
|
38
|
-
[`CompositeIdentityV1`](../namespaces/keys/interfaces/CompositeIdentityV1.md)
|
|
39
|
-
|
|
40
|
-
##### identityType?
|
|
41
|
-
|
|
42
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
43
|
-
|
|
44
|
-
##### suppliedCommitment?
|
|
45
|
-
|
|
46
|
-
`Uint8Array`\<`ArrayBufferLike`\>
|
|
47
|
-
|
|
48
|
-
#### Returns
|
|
49
|
-
|
|
50
|
-
`Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md)\>
|
|
51
|
-
|
|
52
|
-
#### Inherited from
|
|
53
|
-
|
|
54
|
-
[`IIdentityKeyStore`](IIdentityKeyStore.md).[`acceptContactIdentityRotation`](IIdentityKeyStore.md#acceptcontactidentityrotation)
|
|
55
|
-
|
|
56
|
-
***
|
|
57
|
-
|
|
58
|
-
### acceptContactIdentityRotationAndDeleteSessions()
|
|
59
|
-
|
|
60
|
-
> **acceptContactIdentityRotationAndDeleteSessions**(`address`, `identity`, `identityType?`, `suppliedCommitment?`): `Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md)\>
|
|
61
|
-
|
|
62
|
-
Atomically rotate one per-user identity tuple and delete every bound device session.
|
|
63
|
-
|
|
64
|
-
#### Parameters
|
|
65
|
-
|
|
66
|
-
##### address
|
|
67
|
-
|
|
68
|
-
[`ProtocolAddress`](ProtocolAddress.md)
|
|
69
|
-
|
|
70
|
-
##### identity
|
|
71
|
-
|
|
72
|
-
[`CompositeIdentityV1`](../namespaces/keys/interfaces/CompositeIdentityV1.md)
|
|
73
|
-
|
|
74
|
-
##### identityType?
|
|
75
|
-
|
|
76
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
77
|
-
|
|
78
|
-
##### suppliedCommitment?
|
|
79
|
-
|
|
80
|
-
`Uint8Array`\<`ArrayBufferLike`\>
|
|
81
|
-
|
|
82
|
-
#### Returns
|
|
83
|
-
|
|
84
|
-
`Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md)\>
|
|
85
|
-
|
|
86
|
-
***
|
|
87
|
-
|
|
88
|
-
### archiveCurrentSession()
|
|
89
|
-
|
|
90
|
-
> **archiveCurrentSession**(`address`, `newSession?`): `Promise`\<`void`\>
|
|
91
|
-
|
|
92
|
-
Archive the current session and optionally start a new one.
|
|
93
|
-
|
|
94
|
-
Used when:
|
|
95
|
-
- Identity key changes (possible MITM)
|
|
96
|
-
- Registration ID changes (app reinstall detected)
|
|
97
|
-
- Manual session reset
|
|
98
|
-
|
|
99
|
-
#### Parameters
|
|
100
|
-
|
|
101
|
-
##### address
|
|
102
|
-
|
|
103
|
-
[`ProtocolAddress`](ProtocolAddress.md)
|
|
104
|
-
|
|
105
|
-
Protocol address
|
|
106
|
-
|
|
107
|
-
##### newSession?
|
|
108
|
-
|
|
109
|
-
[`SessionState`](SessionState.md) \| `null`
|
|
110
|
-
|
|
111
|
-
Optional new session to set as current
|
|
112
|
-
|
|
113
|
-
#### Returns
|
|
114
|
-
|
|
115
|
-
`Promise`\<`void`\>
|
|
116
|
-
|
|
117
|
-
#### Inherited from
|
|
118
|
-
|
|
119
|
-
[`ISessionStore`](ISessionStore.md).[`archiveCurrentSession`](ISessionStore.md#archivecurrentsession)
|
|
120
|
-
|
|
121
|
-
***
|
|
122
|
-
|
|
123
|
-
### commitSessionTrust()
|
|
124
|
-
|
|
125
|
-
> **commitSessionTrust**(`commit`): `Promise`\<`void`\>
|
|
126
|
-
|
|
127
|
-
Atomically pin/match trust, store the session, and consume referenced one-time prekeys.
|
|
128
|
-
|
|
129
|
-
#### Parameters
|
|
130
|
-
|
|
131
|
-
##### commit
|
|
132
|
-
|
|
133
|
-
[`SessionTrustCommit`](SessionTrustCommit.md)
|
|
134
|
-
|
|
135
|
-
#### Returns
|
|
136
|
-
|
|
137
|
-
`Promise`\<`void`\>
|
|
138
|
-
|
|
139
|
-
***
|
|
140
|
-
|
|
141
|
-
### deleteSessionRecord()
|
|
142
|
-
|
|
143
|
-
> **deleteSessionRecord**(`address`): `Promise`\<`void`\>
|
|
144
|
-
|
|
145
|
-
Delete session record.
|
|
146
|
-
|
|
147
|
-
#### Parameters
|
|
148
|
-
|
|
149
|
-
##### address
|
|
150
|
-
|
|
151
|
-
[`ProtocolAddress`](ProtocolAddress.md)
|
|
152
|
-
|
|
153
|
-
Protocol address
|
|
154
|
-
|
|
155
|
-
#### Returns
|
|
156
|
-
|
|
157
|
-
`Promise`\<`void`\>
|
|
158
|
-
|
|
159
|
-
#### Inherited from
|
|
160
|
-
|
|
161
|
-
[`ISessionStore`](ISessionStore.md).[`deleteSessionRecord`](ISessionStore.md#deletesessionrecord)
|
|
162
|
-
|
|
163
|
-
***
|
|
164
|
-
|
|
165
|
-
### getAllEcSignedPreKeys()?
|
|
166
|
-
|
|
167
|
-
> `optional` **getAllEcSignedPreKeys**(`identityType?`): `Promise`\<[`EcSignedPreKey`](EcSignedPreKey.md)[]\>
|
|
168
|
-
|
|
169
|
-
Get all stored EC signed prekeys (current + archived).
|
|
170
|
-
|
|
171
|
-
Used for cleanup and debugging.
|
|
172
|
-
|
|
173
|
-
#### Parameters
|
|
174
|
-
|
|
175
|
-
##### identityType?
|
|
176
|
-
|
|
177
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
178
|
-
|
|
179
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
180
|
-
|
|
181
|
-
#### Returns
|
|
182
|
-
|
|
183
|
-
`Promise`\<[`EcSignedPreKey`](EcSignedPreKey.md)[]\>
|
|
184
|
-
|
|
185
|
-
#### Inherited from
|
|
186
|
-
|
|
187
|
-
[`IEcSignedPreKeyStore`](IEcSignedPreKeyStore.md).[`getAllEcSignedPreKeys`](IEcSignedPreKeyStore.md#getallecsignedprekeys)
|
|
188
|
-
|
|
189
|
-
***
|
|
190
|
-
|
|
191
|
-
### getContactIdentity()
|
|
192
|
-
|
|
193
|
-
> **getContactIdentity**(`address`, `identityType?`): `Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md) \| `null`\>
|
|
194
|
-
|
|
195
|
-
Get a contact's saved identity key.
|
|
196
|
-
|
|
197
|
-
Returns null if no identity key has been saved for this address.
|
|
198
|
-
|
|
199
|
-
#### Parameters
|
|
200
|
-
|
|
201
|
-
##### address
|
|
202
|
-
|
|
203
|
-
[`ProtocolAddress`](ProtocolAddress.md)
|
|
204
|
-
|
|
205
|
-
Contact's protocol address
|
|
206
|
-
|
|
207
|
-
##### identityType?
|
|
208
|
-
|
|
209
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
210
|
-
|
|
211
|
-
#### Returns
|
|
212
|
-
|
|
213
|
-
`Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md) \| `null`\>
|
|
214
|
-
|
|
215
|
-
Contact's identity key or null
|
|
216
|
-
|
|
217
|
-
#### Inherited from
|
|
218
|
-
|
|
219
|
-
[`IIdentityKeyStore`](IIdentityKeyStore.md).[`getContactIdentity`](IIdentityKeyStore.md#getcontactidentity)
|
|
220
|
-
|
|
221
|
-
***
|
|
222
|
-
|
|
223
|
-
### getEcOneTimePreKeys()
|
|
224
|
-
|
|
225
|
-
> **getEcOneTimePreKeys**(`identityType?`): `Promise`\<[`EcOneTimePreKey`](EcOneTimePreKey.md)[]\>
|
|
226
|
-
|
|
227
|
-
Retrieve all EC one-time prekeys.
|
|
228
|
-
|
|
229
|
-
#### Parameters
|
|
230
|
-
|
|
231
|
-
##### identityType?
|
|
232
|
-
|
|
233
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
234
|
-
|
|
235
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
236
|
-
|
|
237
|
-
#### Returns
|
|
238
|
-
|
|
239
|
-
`Promise`\<[`EcOneTimePreKey`](EcOneTimePreKey.md)[]\>
|
|
240
|
-
|
|
241
|
-
#### Inherited from
|
|
242
|
-
|
|
243
|
-
[`IEcOneTimePreKeyStore`](IEcOneTimePreKeyStore.md).[`getEcOneTimePreKeys`](IEcOneTimePreKeyStore.md#geteconetimeprekeys)
|
|
244
|
-
|
|
245
|
-
***
|
|
246
|
-
|
|
247
|
-
### getEcSignedPreKey()
|
|
248
|
-
|
|
249
|
-
> **getEcSignedPreKey**(`keyId?`, `identityType?`): `Promise`\<[`EcSignedPreKey`](EcSignedPreKey.md) \| `null`\>
|
|
250
|
-
|
|
251
|
-
Retrieve EC signed prekey by ID.
|
|
252
|
-
|
|
253
|
-
#### Parameters
|
|
254
|
-
|
|
255
|
-
##### keyId?
|
|
256
|
-
|
|
257
|
-
`number`
|
|
258
|
-
|
|
259
|
-
Optional key ID to retrieve. If not provided, returns the current (most recent) EC signed prekey.
|
|
260
|
-
|
|
261
|
-
##### identityType?
|
|
262
|
-
|
|
263
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
264
|
-
|
|
265
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
266
|
-
|
|
267
|
-
#### Returns
|
|
268
|
-
|
|
269
|
-
`Promise`\<[`EcSignedPreKey`](EcSignedPreKey.md) \| `null`\>
|
|
270
|
-
|
|
271
|
-
The EC signed prekey, or null if not found
|
|
272
|
-
|
|
273
|
-
#### Inherited from
|
|
274
|
-
|
|
275
|
-
[`IEcSignedPreKeyStore`](IEcSignedPreKeyStore.md).[`getEcSignedPreKey`](IEcSignedPreKeyStore.md#getecsignedprekey)
|
|
276
|
-
|
|
277
|
-
***
|
|
278
|
-
|
|
279
|
-
### getIdentityKey()
|
|
280
|
-
|
|
281
|
-
> **getIdentityKey**(`identityType?`): `Promise`\<[`IdentityKeyPair`](IdentityKeyPair.md) \| `null`\>
|
|
282
|
-
|
|
283
|
-
Retrieve our identity key pair.
|
|
284
|
-
|
|
285
|
-
#### Parameters
|
|
286
|
-
|
|
287
|
-
##### identityType?
|
|
288
|
-
|
|
289
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
290
|
-
|
|
291
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
292
|
-
|
|
293
|
-
#### Returns
|
|
294
|
-
|
|
295
|
-
`Promise`\<[`IdentityKeyPair`](IdentityKeyPair.md) \| `null`\>
|
|
296
|
-
|
|
297
|
-
#### Inherited from
|
|
298
|
-
|
|
299
|
-
[`IIdentityKeyStore`](IIdentityKeyStore.md).[`getIdentityKey`](IIdentityKeyStore.md#getidentitykey)
|
|
300
|
-
|
|
301
|
-
***
|
|
302
|
-
|
|
303
|
-
### getKemOneTimePreKey()
|
|
304
|
-
|
|
305
|
-
> **getKemOneTimePreKey**(`keyId`, `identityType?`): `Promise`\<[`KemOneTimePreKey`](../namespaces/keys/interfaces/KemOneTimePreKey.md) \| `null`\>
|
|
306
|
-
|
|
307
|
-
Retrieve a specific one-time KEM prekey by ID.
|
|
308
|
-
Used during session establishment to find the key for decapsulation.
|
|
309
|
-
|
|
310
|
-
#### Parameters
|
|
311
|
-
|
|
312
|
-
##### keyId
|
|
313
|
-
|
|
314
|
-
`number`
|
|
315
|
-
|
|
316
|
-
##### identityType?
|
|
317
|
-
|
|
318
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
319
|
-
|
|
320
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
321
|
-
|
|
322
|
-
#### Returns
|
|
323
|
-
|
|
324
|
-
`Promise`\<[`KemOneTimePreKey`](../namespaces/keys/interfaces/KemOneTimePreKey.md) \| `null`\>
|
|
325
|
-
|
|
326
|
-
#### Inherited from
|
|
327
|
-
|
|
328
|
-
[`IKemPreKeyStore`](IKemPreKeyStore.md).[`getKemOneTimePreKey`](IKemPreKeyStore.md#getkemonetimeprekey)
|
|
329
|
-
|
|
330
|
-
***
|
|
331
|
-
|
|
332
|
-
### getKemOneTimePreKeyCount()
|
|
333
|
-
|
|
334
|
-
> **getKemOneTimePreKeyCount**(`identityType?`): `Promise`\<`number`\>
|
|
335
|
-
|
|
336
|
-
Get count of available one-time KEM prekeys.
|
|
337
|
-
Used to determine when to replenish the prekey pool.
|
|
338
|
-
|
|
339
|
-
#### Parameters
|
|
340
|
-
|
|
341
|
-
##### identityType?
|
|
342
|
-
|
|
343
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
344
|
-
|
|
345
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
346
|
-
|
|
347
|
-
#### Returns
|
|
348
|
-
|
|
349
|
-
`Promise`\<`number`\>
|
|
350
|
-
|
|
351
|
-
#### Inherited from
|
|
352
|
-
|
|
353
|
-
[`IKemPreKeyStore`](IKemPreKeyStore.md).[`getKemOneTimePreKeyCount`](IKemPreKeyStore.md#getkemonetimeprekeycount)
|
|
354
|
-
|
|
355
|
-
***
|
|
356
|
-
|
|
357
|
-
### getKemOneTimePreKeys()
|
|
358
|
-
|
|
359
|
-
> **getKemOneTimePreKeys**(`identityType?`): `Promise`\<[`KemOneTimePreKey`](../namespaces/keys/interfaces/KemOneTimePreKey.md)[]\>
|
|
360
|
-
|
|
361
|
-
Retrieve all one-time KEM prekeys.
|
|
362
|
-
|
|
363
|
-
#### Parameters
|
|
364
|
-
|
|
365
|
-
##### identityType?
|
|
366
|
-
|
|
367
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
368
|
-
|
|
369
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
370
|
-
|
|
371
|
-
#### Returns
|
|
372
|
-
|
|
373
|
-
`Promise`\<[`KemOneTimePreKey`](../namespaces/keys/interfaces/KemOneTimePreKey.md)[]\>
|
|
374
|
-
|
|
375
|
-
#### Inherited from
|
|
376
|
-
|
|
377
|
-
[`IKemPreKeyStore`](IKemPreKeyStore.md).[`getKemOneTimePreKeys`](IKemPreKeyStore.md#getkemonetimeprekeys)
|
|
378
|
-
|
|
379
|
-
***
|
|
380
|
-
|
|
381
|
-
### getKyberPreKey()
|
|
382
|
-
|
|
383
|
-
> **getKyberPreKey**(`identityType?`): `Promise`\<[`KyberPreKey`](KyberPreKey.md) \| `null`\>
|
|
384
|
-
|
|
385
|
-
Retrieve Kyber prekey.
|
|
386
|
-
|
|
387
|
-
#### Parameters
|
|
388
|
-
|
|
389
|
-
##### identityType?
|
|
390
|
-
|
|
391
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
392
|
-
|
|
393
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
394
|
-
|
|
395
|
-
#### Returns
|
|
396
|
-
|
|
397
|
-
`Promise`\<[`KyberPreKey`](KyberPreKey.md) \| `null`\>
|
|
398
|
-
|
|
399
|
-
#### Inherited from
|
|
400
|
-
|
|
401
|
-
[`IKyberLastResortPreKeyStore`](IKyberLastResortPreKeyStore.md).[`getKyberPreKey`](IKyberLastResortPreKeyStore.md#getkyberprekey)
|
|
402
|
-
|
|
403
|
-
***
|
|
404
|
-
|
|
405
|
-
### getLocalRegistrationId()
|
|
406
|
-
|
|
407
|
-
> **getLocalRegistrationId**(`identityType?`): `Promise`\<`number`\>
|
|
408
|
-
|
|
409
|
-
Get our local registration ID.
|
|
410
|
-
|
|
411
|
-
Registration ID is a random 16-bit integer generated once per install.
|
|
412
|
-
Used to detect session resets when app is reinstalled.
|
|
413
|
-
|
|
414
|
-
#### Parameters
|
|
415
|
-
|
|
416
|
-
##### identityType?
|
|
417
|
-
|
|
418
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
419
|
-
|
|
420
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
421
|
-
|
|
422
|
-
#### Returns
|
|
423
|
-
|
|
424
|
-
`Promise`\<`number`\>
|
|
425
|
-
|
|
426
|
-
#### Inherited from
|
|
427
|
-
|
|
428
|
-
[`IIdentityKeyStore`](IIdentityKeyStore.md).[`getLocalRegistrationId`](IIdentityKeyStore.md#getlocalregistrationid)
|
|
429
|
-
|
|
430
|
-
***
|
|
431
|
-
|
|
432
|
-
### getSessionCount()
|
|
433
|
-
|
|
434
|
-
> **getSessionCount**(): `Promise`\<`number`\>
|
|
435
|
-
|
|
436
|
-
Get the count of active sessions.
|
|
437
|
-
|
|
438
|
-
#### Returns
|
|
439
|
-
|
|
440
|
-
`Promise`\<`number`\>
|
|
441
|
-
|
|
442
|
-
Number of sessions stored
|
|
443
|
-
|
|
444
|
-
#### Inherited from
|
|
445
|
-
|
|
446
|
-
[`ISessionStore`](ISessionStore.md).[`getSessionCount`](ISessionStore.md#getsessioncount)
|
|
447
|
-
|
|
448
|
-
***
|
|
449
|
-
|
|
450
|
-
### getSessionRecord()
|
|
451
|
-
|
|
452
|
-
> **getSessionRecord**(`address`): `Promise`\<[`SessionRecord`](SessionRecord.md) \| `null`\>
|
|
453
|
-
|
|
454
|
-
Retrieve session record.
|
|
455
|
-
|
|
456
|
-
#### Parameters
|
|
457
|
-
|
|
458
|
-
##### address
|
|
459
|
-
|
|
460
|
-
[`ProtocolAddress`](ProtocolAddress.md)
|
|
461
|
-
|
|
462
|
-
Protocol address
|
|
463
|
-
|
|
464
|
-
#### Returns
|
|
465
|
-
|
|
466
|
-
`Promise`\<[`SessionRecord`](SessionRecord.md) \| `null`\>
|
|
467
|
-
|
|
468
|
-
SessionRecord or null if no session exists
|
|
469
|
-
|
|
470
|
-
#### Inherited from
|
|
471
|
-
|
|
472
|
-
[`ISessionStore`](ISessionStore.md).[`getSessionRecord`](ISessionStore.md#getsessionrecord)
|
|
473
|
-
|
|
474
|
-
***
|
|
475
|
-
|
|
476
|
-
### getSessionsForUser()
|
|
477
|
-
|
|
478
|
-
> **getSessionsForUser**(`userId`): `Promise`\<[`SessionRecord`](SessionRecord.md)[]\>
|
|
479
|
-
|
|
480
|
-
Get all sessions for a user (across all their devices).
|
|
481
|
-
|
|
482
|
-
Useful for multi-device scenarios where one user has multiple devices.
|
|
483
|
-
|
|
484
|
-
#### Parameters
|
|
485
|
-
|
|
486
|
-
##### userId
|
|
487
|
-
|
|
488
|
-
`string`
|
|
489
|
-
|
|
490
|
-
User ID (not including device ID)
|
|
491
|
-
|
|
492
|
-
#### Returns
|
|
493
|
-
|
|
494
|
-
`Promise`\<[`SessionRecord`](SessionRecord.md)[]\>
|
|
495
|
-
|
|
496
|
-
Array of session records for all of this user's devices
|
|
497
|
-
|
|
498
|
-
#### Inherited from
|
|
499
|
-
|
|
500
|
-
[`ISessionStore`](ISessionStore.md).[`getSessionsForUser`](ISessionStore.md#getsessionsforuser)
|
|
501
|
-
|
|
502
|
-
***
|
|
503
|
-
|
|
504
|
-
### hasIdentityKey()
|
|
505
|
-
|
|
506
|
-
> **hasIdentityKey**(`identityType?`): `Promise`\<`boolean`\>
|
|
507
|
-
|
|
508
|
-
Check if identity key exists.
|
|
509
|
-
|
|
510
|
-
#### Parameters
|
|
511
|
-
|
|
512
|
-
##### identityType?
|
|
513
|
-
|
|
514
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
515
|
-
|
|
516
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
517
|
-
|
|
518
|
-
#### Returns
|
|
519
|
-
|
|
520
|
-
`Promise`\<`boolean`\>
|
|
521
|
-
|
|
522
|
-
#### Inherited from
|
|
523
|
-
|
|
524
|
-
[`IIdentityKeyStore`](IIdentityKeyStore.md).[`hasIdentityKey`](IIdentityKeyStore.md#hasidentitykey)
|
|
525
|
-
|
|
526
|
-
***
|
|
527
|
-
|
|
528
|
-
### hasSession()
|
|
529
|
-
|
|
530
|
-
> **hasSession**(`address`): `Promise`\<`boolean`\>
|
|
531
|
-
|
|
532
|
-
Check if a session exists for the given address.
|
|
533
|
-
|
|
534
|
-
#### Parameters
|
|
535
|
-
|
|
536
|
-
##### address
|
|
537
|
-
|
|
538
|
-
[`ProtocolAddress`](ProtocolAddress.md)
|
|
539
|
-
|
|
540
|
-
Protocol address
|
|
541
|
-
|
|
542
|
-
#### Returns
|
|
543
|
-
|
|
544
|
-
`Promise`\<`boolean`\>
|
|
545
|
-
|
|
546
|
-
true if session exists
|
|
547
|
-
|
|
548
|
-
#### Inherited from
|
|
549
|
-
|
|
550
|
-
[`ISessionStore`](ISessionStore.md).[`hasSession`](ISessionStore.md#hassession)
|
|
551
|
-
|
|
552
|
-
***
|
|
553
|
-
|
|
554
|
-
### isTrustedIdentity()
|
|
555
|
-
|
|
556
|
-
> **isTrustedIdentity**(`address`, `identity`, `direction`, `identityType?`): `Promise`\<`boolean`\>
|
|
557
|
-
|
|
558
|
-
Check if a contact's identity key is trusted.
|
|
559
|
-
|
|
560
|
-
Trust verification behavior depends on direction:
|
|
561
|
-
- SENDING: Stricter - don't send to untrusted identities
|
|
562
|
-
- RECEIVING: More permissive - allow receiving but warn user
|
|
563
|
-
|
|
564
|
-
From Signal Protocol:
|
|
565
|
-
"It's safer to receive from an unknown identity than to send to one"
|
|
566
|
-
|
|
567
|
-
#### Parameters
|
|
568
|
-
|
|
569
|
-
##### address
|
|
570
|
-
|
|
571
|
-
[`ProtocolAddress`](ProtocolAddress.md)
|
|
572
|
-
|
|
573
|
-
Contact's protocol address
|
|
574
|
-
|
|
575
|
-
##### identity
|
|
576
|
-
|
|
577
|
-
[`CompositeIdentityV1`](../namespaces/keys/interfaces/CompositeIdentityV1.md)
|
|
578
|
-
|
|
579
|
-
Complete composite identity candidate
|
|
580
|
-
|
|
581
|
-
##### direction
|
|
582
|
-
|
|
583
|
-
[`TrustDirection`](../enumerations/TrustDirection.md)
|
|
584
|
-
|
|
585
|
-
Whether we're sending or receiving
|
|
586
|
-
|
|
587
|
-
##### identityType?
|
|
588
|
-
|
|
589
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
590
|
-
|
|
591
|
-
ACI or PNI trust namespace
|
|
592
|
-
|
|
593
|
-
#### Returns
|
|
594
|
-
|
|
595
|
-
`Promise`\<`boolean`\>
|
|
596
|
-
|
|
597
|
-
true if identity is trusted
|
|
598
|
-
|
|
599
|
-
#### Inherited from
|
|
600
|
-
|
|
601
|
-
[`IIdentityKeyStore`](IIdentityKeyStore.md).[`isTrustedIdentity`](IIdentityKeyStore.md#istrustedidentity)
|
|
602
|
-
|
|
603
|
-
***
|
|
604
|
-
|
|
605
|
-
### markKyberPreKeyUsed()
|
|
606
|
-
|
|
607
|
-
> **markKyberPreKeyUsed**(`kyberPreKeyId`, `signedPreKeyId`, `baseKeyBytes`, `identityType?`): `Promise`\<`void`\>
|
|
608
|
-
|
|
609
|
-
Mark a Kyber prekey as used.
|
|
610
|
-
|
|
611
|
-
Kyber prekeys can be reused (unlike one-time prekeys) but should be
|
|
612
|
-
tracked to ensure proper rotation.
|
|
613
|
-
|
|
614
|
-
#### Parameters
|
|
615
|
-
|
|
616
|
-
##### kyberPreKeyId
|
|
617
|
-
|
|
618
|
-
`number`
|
|
619
|
-
|
|
620
|
-
ID of the Kyber prekey that was used
|
|
621
|
-
|
|
622
|
-
##### signedPreKeyId
|
|
623
|
-
|
|
624
|
-
`number`
|
|
625
|
-
|
|
626
|
-
ID of the signed prekey used in combination
|
|
627
|
-
|
|
628
|
-
##### baseKeyBytes
|
|
629
|
-
|
|
630
|
-
`Uint8Array`
|
|
631
|
-
|
|
632
|
-
Base key bytes for the session
|
|
633
|
-
|
|
634
|
-
##### identityType?
|
|
635
|
-
|
|
636
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
637
|
-
|
|
638
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
639
|
-
|
|
640
|
-
#### Returns
|
|
641
|
-
|
|
642
|
-
`Promise`\<`void`\>
|
|
643
|
-
|
|
644
|
-
#### Inherited from
|
|
645
|
-
|
|
646
|
-
[`IKyberLastResortPreKeyStore`](IKyberLastResortPreKeyStore.md).[`markKyberPreKeyUsed`](IKyberLastResortPreKeyStore.md#markkyberprekeyused)
|
|
647
|
-
|
|
648
|
-
***
|
|
649
|
-
|
|
650
|
-
### removeEcOneTimePreKey()
|
|
651
|
-
|
|
652
|
-
> **removeEcOneTimePreKey**(`preKeyId`, `identityType?`): `Promise`\<`void`\>
|
|
653
|
-
|
|
654
|
-
Remove an EC one-time prekey after it has been used.
|
|
655
|
-
|
|
656
|
-
#### Parameters
|
|
657
|
-
|
|
658
|
-
##### preKeyId
|
|
659
|
-
|
|
660
|
-
`number`
|
|
661
|
-
|
|
662
|
-
ID of the prekey to remove
|
|
663
|
-
|
|
664
|
-
##### identityType?
|
|
665
|
-
|
|
666
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
667
|
-
|
|
668
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
669
|
-
|
|
670
|
-
#### Returns
|
|
671
|
-
|
|
672
|
-
`Promise`\<`void`\>
|
|
673
|
-
|
|
674
|
-
#### Inherited from
|
|
675
|
-
|
|
676
|
-
[`IEcOneTimePreKeyStore`](IEcOneTimePreKeyStore.md).[`removeEcOneTimePreKey`](IEcOneTimePreKeyStore.md#removeeconetimeprekey)
|
|
677
|
-
|
|
678
|
-
***
|
|
679
|
-
|
|
680
|
-
### removeEcSignedPreKey()?
|
|
681
|
-
|
|
682
|
-
> `optional` **removeEcSignedPreKey**(`keyId`, `identityType?`): `Promise`\<`void`\>
|
|
683
|
-
|
|
684
|
-
Remove an EC signed prekey by ID.
|
|
685
|
-
|
|
686
|
-
Called during cleanup to remove expired archived prekeys.
|
|
687
|
-
Should NEVER remove the current (most recent) EC signed prekey.
|
|
688
|
-
|
|
689
|
-
#### Parameters
|
|
690
|
-
|
|
691
|
-
##### keyId
|
|
692
|
-
|
|
693
|
-
`number`
|
|
694
|
-
|
|
695
|
-
The key ID to remove
|
|
696
|
-
|
|
697
|
-
##### identityType?
|
|
698
|
-
|
|
699
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
700
|
-
|
|
701
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
702
|
-
|
|
703
|
-
#### Returns
|
|
704
|
-
|
|
705
|
-
`Promise`\<`void`\>
|
|
706
|
-
|
|
707
|
-
#### Inherited from
|
|
708
|
-
|
|
709
|
-
[`IEcSignedPreKeyStore`](IEcSignedPreKeyStore.md).[`removeEcSignedPreKey`](IEcSignedPreKeyStore.md#removeecsignedprekey)
|
|
710
|
-
|
|
711
|
-
***
|
|
712
|
-
|
|
713
|
-
### removeKemOneTimePreKey()
|
|
714
|
-
|
|
715
|
-
> **removeKemOneTimePreKey**(`keyId`, `identityType?`): `Promise`\<`void`\>
|
|
716
|
-
|
|
717
|
-
Remove a one-time KEM prekey after it has been used.
|
|
718
|
-
|
|
719
|
-
CRITICAL: Must be called immediately after successful decapsulation
|
|
720
|
-
to provide per-session post-quantum forward secrecy.
|
|
721
|
-
|
|
722
|
-
#### Parameters
|
|
723
|
-
|
|
724
|
-
##### keyId
|
|
725
|
-
|
|
726
|
-
`number`
|
|
727
|
-
|
|
728
|
-
ID of the prekey to remove
|
|
729
|
-
|
|
730
|
-
##### identityType?
|
|
731
|
-
|
|
732
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
733
|
-
|
|
734
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
735
|
-
|
|
736
|
-
#### Returns
|
|
737
|
-
|
|
738
|
-
`Promise`\<`void`\>
|
|
739
|
-
|
|
740
|
-
#### Inherited from
|
|
741
|
-
|
|
742
|
-
[`IKemPreKeyStore`](IKemPreKeyStore.md).[`removeKemOneTimePreKey`](IKemPreKeyStore.md#removekemonetimeprekey)
|
|
743
|
-
|
|
744
|
-
***
|
|
745
|
-
|
|
746
|
-
### saveContactIdentity()
|
|
747
|
-
|
|
748
|
-
> **saveContactIdentity**(`address`, `identity`, `identityType?`, `suppliedCommitment?`): `Promise`\<[`IdentityKeyChange`](../enumerations/IdentityKeyChange.md)\>
|
|
749
|
-
|
|
750
|
-
Save a contact's identity key and detect changes.
|
|
751
|
-
|
|
752
|
-
This is used for Trust On First Use (TOFU) and post-pinning change
|
|
753
|
-
detection. Returns whether either composite component changed.
|
|
754
|
-
|
|
755
|
-
#### Parameters
|
|
756
|
-
|
|
757
|
-
##### address
|
|
758
|
-
|
|
759
|
-
[`ProtocolAddress`](ProtocolAddress.md)
|
|
760
|
-
|
|
761
|
-
Contact's protocol address
|
|
762
|
-
|
|
763
|
-
##### identity
|
|
764
|
-
|
|
765
|
-
[`CompositeIdentityV1`](../namespaces/keys/interfaces/CompositeIdentityV1.md)
|
|
766
|
-
|
|
767
|
-
Contact's complete canonical composite identity
|
|
768
|
-
|
|
769
|
-
##### identityType?
|
|
770
|
-
|
|
771
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
772
|
-
|
|
773
|
-
ACI or PNI trust namespace
|
|
774
|
-
|
|
775
|
-
##### suppliedCommitment?
|
|
776
|
-
|
|
777
|
-
`Uint8Array`\<`ArrayBufferLike`\>
|
|
778
|
-
|
|
779
|
-
Optional redundant commitment that must match
|
|
780
|
-
|
|
781
|
-
#### Returns
|
|
782
|
-
|
|
783
|
-
`Promise`\<[`IdentityKeyChange`](../enumerations/IdentityKeyChange.md)\>
|
|
784
|
-
|
|
785
|
-
IdentityKeyChange indicating if key is new or changed
|
|
786
|
-
|
|
787
|
-
#### Inherited from
|
|
788
|
-
|
|
789
|
-
[`IIdentityKeyStore`](IIdentityKeyStore.md).[`saveContactIdentity`](IIdentityKeyStore.md#savecontactidentity)
|
|
790
|
-
|
|
791
|
-
***
|
|
792
|
-
|
|
793
|
-
### setLocalRegistrationId()
|
|
794
|
-
|
|
795
|
-
> **setLocalRegistrationId**(`id`, `identityType?`): `Promise`\<`void`\>
|
|
796
|
-
|
|
797
|
-
Set our local registration ID.
|
|
798
|
-
|
|
799
|
-
Should only be called once during initialization.
|
|
800
|
-
|
|
801
|
-
#### Parameters
|
|
802
|
-
|
|
803
|
-
##### id
|
|
804
|
-
|
|
805
|
-
`number`
|
|
806
|
-
|
|
807
|
-
Registration ID
|
|
808
|
-
|
|
809
|
-
##### identityType?
|
|
810
|
-
|
|
811
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
812
|
-
|
|
813
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
814
|
-
|
|
815
|
-
#### Returns
|
|
816
|
-
|
|
817
|
-
`Promise`\<`void`\>
|
|
818
|
-
|
|
819
|
-
#### Inherited from
|
|
820
|
-
|
|
821
|
-
[`IIdentityKeyStore`](IIdentityKeyStore.md).[`setLocalRegistrationId`](IIdentityKeyStore.md#setlocalregistrationid)
|
|
822
|
-
|
|
823
|
-
***
|
|
824
|
-
|
|
825
|
-
### storeEcOneTimePreKeys()
|
|
826
|
-
|
|
827
|
-
> **storeEcOneTimePreKeys**(`prekeys`, `identityType?`): `Promise`\<`void`\>
|
|
828
|
-
|
|
829
|
-
Store EC one-time prekeys.
|
|
830
|
-
|
|
831
|
-
#### Parameters
|
|
832
|
-
|
|
833
|
-
##### prekeys
|
|
834
|
-
|
|
835
|
-
[`EcOneTimePreKey`](EcOneTimePreKey.md)[]
|
|
836
|
-
|
|
837
|
-
##### identityType?
|
|
838
|
-
|
|
839
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
840
|
-
|
|
841
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
842
|
-
|
|
843
|
-
#### Returns
|
|
844
|
-
|
|
845
|
-
`Promise`\<`void`\>
|
|
846
|
-
|
|
847
|
-
#### Inherited from
|
|
848
|
-
|
|
849
|
-
[`IEcOneTimePreKeyStore`](IEcOneTimePreKeyStore.md).[`storeEcOneTimePreKeys`](IEcOneTimePreKeyStore.md#storeeconetimeprekeys)
|
|
850
|
-
|
|
851
|
-
***
|
|
852
|
-
|
|
853
|
-
### storeEcSignedPreKey()
|
|
854
|
-
|
|
855
|
-
> **storeEcSignedPreKey**(`signedPreKey`, `identityType?`): `Promise`\<`void`\>
|
|
856
|
-
|
|
857
|
-
Store EC signed prekey.
|
|
858
|
-
|
|
859
|
-
When storing a new EC signed prekey (rotation), the old one should be
|
|
860
|
-
archived (not deleted) to handle in-flight messages.
|
|
861
|
-
|
|
862
|
-
#### Parameters
|
|
863
|
-
|
|
864
|
-
##### signedPreKey
|
|
865
|
-
|
|
866
|
-
[`EcSignedPreKey`](EcSignedPreKey.md)
|
|
867
|
-
|
|
868
|
-
##### identityType?
|
|
869
|
-
|
|
870
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
871
|
-
|
|
872
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
873
|
-
|
|
874
|
-
#### Returns
|
|
875
|
-
|
|
876
|
-
`Promise`\<`void`\>
|
|
877
|
-
|
|
878
|
-
#### Inherited from
|
|
879
|
-
|
|
880
|
-
[`IEcSignedPreKeyStore`](IEcSignedPreKeyStore.md).[`storeEcSignedPreKey`](IEcSignedPreKeyStore.md#storeecsignedprekey)
|
|
881
|
-
|
|
882
|
-
***
|
|
883
|
-
|
|
884
|
-
### storeIdentityKey()
|
|
885
|
-
|
|
886
|
-
> **storeIdentityKey**(`keyPair`, `identityType?`): `Promise`\<`void`\>
|
|
887
|
-
|
|
888
|
-
Store our identity key pair (only done once per install per identity type).
|
|
889
|
-
|
|
890
|
-
#### Parameters
|
|
891
|
-
|
|
892
|
-
##### keyPair
|
|
893
|
-
|
|
894
|
-
[`IdentityKeyPair`](IdentityKeyPair.md)
|
|
895
|
-
|
|
896
|
-
Identity key pair to store
|
|
897
|
-
|
|
898
|
-
##### identityType?
|
|
899
|
-
|
|
900
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
901
|
-
|
|
902
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
903
|
-
|
|
904
|
-
#### Returns
|
|
905
|
-
|
|
906
|
-
`Promise`\<`void`\>
|
|
907
|
-
|
|
908
|
-
#### Inherited from
|
|
909
|
-
|
|
910
|
-
[`IIdentityKeyStore`](IIdentityKeyStore.md).[`storeIdentityKey`](IIdentityKeyStore.md#storeidentitykey)
|
|
911
|
-
|
|
912
|
-
***
|
|
913
|
-
|
|
914
|
-
### storeKemOneTimePreKeys()
|
|
915
|
-
|
|
916
|
-
> **storeKemOneTimePreKeys**(`prekeys`, `identityType?`): `Promise`\<`void`\>
|
|
917
|
-
|
|
918
|
-
Store one-time KEM prekeys (batch storage).
|
|
919
|
-
|
|
920
|
-
#### Parameters
|
|
921
|
-
|
|
922
|
-
##### prekeys
|
|
923
|
-
|
|
924
|
-
[`KemOneTimePreKey`](../namespaces/keys/interfaces/KemOneTimePreKey.md)[]
|
|
925
|
-
|
|
926
|
-
##### identityType?
|
|
927
|
-
|
|
928
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
929
|
-
|
|
930
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
931
|
-
|
|
932
|
-
#### Returns
|
|
933
|
-
|
|
934
|
-
`Promise`\<`void`\>
|
|
935
|
-
|
|
936
|
-
#### Inherited from
|
|
937
|
-
|
|
938
|
-
[`IKemPreKeyStore`](IKemPreKeyStore.md).[`storeKemOneTimePreKeys`](IKemPreKeyStore.md#storekemonetimeprekeys)
|
|
939
|
-
|
|
940
|
-
***
|
|
941
|
-
|
|
942
|
-
### storeKyberPreKey()
|
|
943
|
-
|
|
944
|
-
> **storeKyberPreKey**(`kyberPreKey`, `identityType?`): `Promise`\<`void`\>
|
|
945
|
-
|
|
946
|
-
Store Kyber prekey (post-quantum security).
|
|
947
|
-
|
|
948
|
-
#### Parameters
|
|
949
|
-
|
|
950
|
-
##### kyberPreKey
|
|
951
|
-
|
|
952
|
-
[`KyberPreKey`](KyberPreKey.md)
|
|
953
|
-
|
|
954
|
-
##### identityType?
|
|
955
|
-
|
|
956
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
957
|
-
|
|
958
|
-
'aci' or 'pni' (defaults to 'aci')
|
|
959
|
-
|
|
960
|
-
#### Returns
|
|
961
|
-
|
|
962
|
-
`Promise`\<`void`\>
|
|
963
|
-
|
|
964
|
-
#### Inherited from
|
|
965
|
-
|
|
966
|
-
[`IKyberLastResortPreKeyStore`](IKyberLastResortPreKeyStore.md).[`storeKyberPreKey`](IKyberLastResortPreKeyStore.md#storekyberprekey)
|
|
967
|
-
|
|
968
|
-
***
|
|
969
|
-
|
|
970
|
-
### storeSessionRecord()
|
|
971
|
-
|
|
972
|
-
> **storeSessionRecord**(`address`, `record`): `Promise`\<`void`\>
|
|
973
|
-
|
|
974
|
-
Store session record with current + archived sessions.
|
|
975
|
-
|
|
976
|
-
This is the preferred API for session storage, supporting session archiving
|
|
977
|
-
and handling race conditions.
|
|
978
|
-
|
|
979
|
-
#### Parameters
|
|
980
|
-
|
|
981
|
-
##### address
|
|
982
|
-
|
|
983
|
-
[`ProtocolAddress`](ProtocolAddress.md)
|
|
984
|
-
|
|
985
|
-
Protocol address for this session
|
|
986
|
-
|
|
987
|
-
##### record
|
|
988
|
-
|
|
989
|
-
[`SessionRecord`](SessionRecord.md)
|
|
990
|
-
|
|
991
|
-
SessionRecord containing current and archived sessions
|
|
992
|
-
|
|
993
|
-
#### Returns
|
|
994
|
-
|
|
995
|
-
`Promise`\<`void`\>
|
|
996
|
-
|
|
997
|
-
#### Inherited from
|
|
998
|
-
|
|
999
|
-
[`ISessionStore`](ISessionStore.md).[`storeSessionRecord`](ISessionStore.md#storesessionrecord)
|
|
1000
|
-
|
|
1001
|
-
***
|
|
1002
|
-
|
|
1003
|
-
### verifyContactIdentity()
|
|
1004
|
-
|
|
1005
|
-
> **verifyContactIdentity**(`address`, `identity`, `identityType?`, `suppliedCommitment?`): `Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md)\>
|
|
1006
|
-
|
|
1007
|
-
Promote the exact current tuple after authenticated comparison.
|
|
1008
|
-
|
|
1009
|
-
#### Parameters
|
|
1010
|
-
|
|
1011
|
-
##### address
|
|
1012
|
-
|
|
1013
|
-
[`ProtocolAddress`](ProtocolAddress.md)
|
|
1014
|
-
|
|
1015
|
-
##### identity
|
|
1016
|
-
|
|
1017
|
-
[`CompositeIdentityV1`](../namespaces/keys/interfaces/CompositeIdentityV1.md)
|
|
1018
|
-
|
|
1019
|
-
##### identityType?
|
|
1020
|
-
|
|
1021
|
-
[`IdentityType`](../namespaces/keys/type-aliases/IdentityType.md)
|
|
1022
|
-
|
|
1023
|
-
##### suppliedCommitment?
|
|
1024
|
-
|
|
1025
|
-
`Uint8Array`\<`ArrayBufferLike`\>
|
|
1026
|
-
|
|
1027
|
-
#### Returns
|
|
1028
|
-
|
|
1029
|
-
`Promise`\<[`ContactIdentityRecord`](../namespaces/keys/interfaces/ContactIdentityRecord.md)\>
|
|
1030
|
-
|
|
1031
|
-
#### Inherited from
|
|
1032
|
-
|
|
1033
|
-
[`IIdentityKeyStore`](IIdentityKeyStore.md).[`verifyContactIdentity`](IIdentityKeyStore.md#verifycontactidentity)
|