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