@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,839 +0,0 @@
|
|
|
1
|
-
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolClientConfig
|
|
6
|
-
|
|
7
|
-
# Interface: SignalProtocolClientConfig
|
|
8
|
-
|
|
9
|
-
Low-level SignalProtocolClient configuration options.
|
|
10
|
-
|
|
11
|
-
Application code should usually prefer `createSignalProtocolClient()`, which groups
|
|
12
|
-
account identity, adapters, and protocol policy into a friendlier shape. Use
|
|
13
|
-
this config directly when lower-level integration code already has flattened
|
|
14
|
-
client options.
|
|
15
|
-
|
|
16
|
-
## Example
|
|
17
|
-
|
|
18
|
-
```typescript
|
|
19
|
-
import {
|
|
20
|
-
createSignalProtocolClient,
|
|
21
|
-
SignalProtocolClient,
|
|
22
|
-
} from '@open-e2ee/signal-protocol-sdk';
|
|
23
|
-
import {
|
|
24
|
-
convexRelay,
|
|
25
|
-
type ConvexSignalProtocolRelayApi,
|
|
26
|
-
} from '@open-e2ee/signal-protocol-sdk/remote/relay/convex';
|
|
27
|
-
import { api } from '../convex/_generated/api';
|
|
28
|
-
|
|
29
|
-
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
30
|
-
const relay = convexRelay({ convex, api: signalApi, currentUserId: userId });
|
|
31
|
-
|
|
32
|
-
// Preferred app-facing composition.
|
|
33
|
-
const signal = await createSignalProtocolClient({
|
|
34
|
-
identity: { userId },
|
|
35
|
-
adapters: { storage, relay },
|
|
36
|
-
});
|
|
37
|
-
|
|
38
|
-
// Low-level factory with the same underlying options.
|
|
39
|
-
const advancedSignalProtocol = await SignalProtocolClient.create(userId, {
|
|
40
|
-
storage,
|
|
41
|
-
relay,
|
|
42
|
-
onProgress,
|
|
43
|
-
ratchetConfig: {
|
|
44
|
-
maxSkip: 2000,
|
|
45
|
-
keyExpirationMs: 14 * 24 * 60 * 60 * 1000 // 14 days
|
|
46
|
-
},
|
|
47
|
-
enableDebugLogging: true
|
|
48
|
-
});
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
## Properties
|
|
52
|
-
|
|
53
|
-
### contentAdapter?
|
|
54
|
-
|
|
55
|
-
> `optional` **contentAdapter?**: [`SignalProtocolContentAdapter`](SignalProtocolContentAdapter.md)
|
|
56
|
-
|
|
57
|
-
Application-provided content adapter.
|
|
58
|
-
|
|
59
|
-
This is the boundary between the protocol layer and app-specific content,
|
|
60
|
-
notification batching, and privacy preference policy.
|
|
61
|
-
|
|
62
|
-
***
|
|
63
|
-
|
|
64
|
-
### deviceId?
|
|
65
|
-
|
|
66
|
-
> `optional` **deviceId?**: `number`
|
|
67
|
-
|
|
68
|
-
Device identifier for multi-device support
|
|
69
|
-
|
|
70
|
-
- 1 = Primary device (default)
|
|
71
|
-
- 2-5 = Linked devices
|
|
72
|
-
|
|
73
|
-
Device 1 bootstraps identity locally. Devices 2-5 must already have a
|
|
74
|
-
provisioned identity imported into the provided storage before
|
|
75
|
-
`SignalProtocolClient.create()` is called.
|
|
76
|
-
|
|
77
|
-
Prekeys and sessions remain device-specific; account identity is shared.
|
|
78
|
-
Maximum 5 devices per user (1 primary + 4 linked).
|
|
79
|
-
|
|
80
|
-
#### Default
|
|
81
|
-
|
|
82
|
-
```ts
|
|
83
|
-
1 (primary device)
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
#### Example
|
|
87
|
-
|
|
88
|
-
```typescript
|
|
89
|
-
// Primary device
|
|
90
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
91
|
-
storage: customStorage,
|
|
92
|
-
deviceId: 1
|
|
93
|
-
});
|
|
94
|
-
|
|
95
|
-
// Linked device (from QR code provisioning)
|
|
96
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
97
|
-
storage: provisionedLinkedDeviceStorage,
|
|
98
|
-
deviceId: 2
|
|
99
|
-
});
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
***
|
|
103
|
-
|
|
104
|
-
### enableDebugLogging?
|
|
105
|
-
|
|
106
|
-
> `optional` **enableDebugLogging?**: `boolean`
|
|
107
|
-
|
|
108
|
-
Enable debug logging
|
|
109
|
-
Default: false
|
|
110
|
-
Recommended: Enable in development, disable in production
|
|
111
|
-
|
|
112
|
-
***
|
|
113
|
-
|
|
114
|
-
### enablePniKeys?
|
|
115
|
-
|
|
116
|
-
> `optional` **enablePniKeys?**: `boolean`
|
|
117
|
-
|
|
118
|
-
Enable PNI (Phone Number Identity) cryptographic key generation
|
|
119
|
-
|
|
120
|
-
When `true`, generates and syncs both ACI and PNI identity keys, prekeys,
|
|
121
|
-
and Kyber prekeys for applications that maintain both account identifiers.
|
|
122
|
-
|
|
123
|
-
When `false` (default), only ACI keys are generated and synchronized. Use
|
|
124
|
-
this for applications whose account model does not require PNI keys.
|
|
125
|
-
|
|
126
|
-
The PNI UUID on the users table is unaffected — it can still exist for ZK
|
|
127
|
-
group credentials without generating cryptographic keys.
|
|
128
|
-
|
|
129
|
-
#### Default
|
|
130
|
-
|
|
131
|
-
```ts
|
|
132
|
-
false
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
***
|
|
136
|
-
|
|
137
|
-
### groupsV2?
|
|
138
|
-
|
|
139
|
-
> `optional` **groupsV2?**: `object`
|
|
140
|
-
|
|
141
|
-
GroupsV2 configuration for Signal Private Group System.
|
|
142
|
-
Required for group state management (create, sync, membership changes).
|
|
143
|
-
|
|
144
|
-
#### aci
|
|
145
|
-
|
|
146
|
-
> **aci**: [`ServiceId`](ServiceId.md)
|
|
147
|
-
|
|
148
|
-
User's ACI for credential presentation.
|
|
149
|
-
|
|
150
|
-
#### credentialPublicKey
|
|
151
|
-
|
|
152
|
-
> **credentialPublicKey**: [`CredentialPublicKey`](CredentialPublicKey.md)
|
|
153
|
-
|
|
154
|
-
Server's credential public key for verifying issuance proofs.
|
|
155
|
-
|
|
156
|
-
#### endorsementManager?
|
|
157
|
-
|
|
158
|
-
> `optional` **endorsementManager?**: [`EndorsementManager`](../classes/EndorsementManager.md)
|
|
159
|
-
|
|
160
|
-
Pre-constructed EndorsementManager for group send endorsement-based auth.
|
|
161
|
-
|
|
162
|
-
#### endorsementRootPublicKey?
|
|
163
|
-
|
|
164
|
-
> `optional` **endorsementRootPublicKey?**: [`ServerRootPublicKey`](../classes/ServerRootPublicKey.md)
|
|
165
|
-
|
|
166
|
-
Server's endorsement root public key for verifying group send endorsements.
|
|
167
|
-
|
|
168
|
-
#### pni?
|
|
169
|
-
|
|
170
|
-
> `optional` **pni?**: [`ServiceId`](ServiceId.md)
|
|
171
|
-
|
|
172
|
-
User's PNI for credential presentation (optional — nil UUID used for non-phone apps).
|
|
173
|
-
|
|
174
|
-
#### resolveAciBytesByUserIds?
|
|
175
|
-
|
|
176
|
-
> `optional` **resolveAciBytesByUserIds?**: (`userIds`) => `Promise`\<`Map`\<`string`, `Uint8Array`\<`ArrayBufferLike`\>\>\>
|
|
177
|
-
|
|
178
|
-
Resolve member ACIs without importing app content models into the client.
|
|
179
|
-
|
|
180
|
-
##### Parameters
|
|
181
|
-
|
|
182
|
-
###### userIds
|
|
183
|
-
|
|
184
|
-
`string`[]
|
|
185
|
-
|
|
186
|
-
##### Returns
|
|
187
|
-
|
|
188
|
-
`Promise`\<`Map`\<`string`, `Uint8Array`\<`ArrayBufferLike`\>\>\>
|
|
189
|
-
|
|
190
|
-
#### server
|
|
191
|
-
|
|
192
|
-
> **server**: [`IGroupServer`](IGroupServer.md)
|
|
193
|
-
|
|
194
|
-
Server-side group operations.
|
|
195
|
-
|
|
196
|
-
#### store
|
|
197
|
-
|
|
198
|
-
> **store**: [`IGroupStateStore`](IGroupStateStore.md)
|
|
199
|
-
|
|
200
|
-
Local group state storage (master keys, cached state).
|
|
201
|
-
|
|
202
|
-
#### Example
|
|
203
|
-
|
|
204
|
-
```typescript
|
|
205
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
206
|
-
storage: customStorage,
|
|
207
|
-
groupsV2: {
|
|
208
|
-
store: new SQLiteGroupStateStore(db),
|
|
209
|
-
server: new ConvexGroupServer(convex),
|
|
210
|
-
}
|
|
211
|
-
});
|
|
212
|
-
```
|
|
213
|
-
|
|
214
|
-
***
|
|
215
|
-
|
|
216
|
-
### hooks?
|
|
217
|
-
|
|
218
|
-
> `optional` **hooks?**: [`SignalProtocolClientHooks`](SignalProtocolClientHooks.md)
|
|
219
|
-
|
|
220
|
-
Event hooks for Signal Protocol lifecycle events
|
|
221
|
-
|
|
222
|
-
Provides integration points for applications to react to:
|
|
223
|
-
- Session establishment/deletion
|
|
224
|
-
- Key rotation
|
|
225
|
-
- Message encryption/decryption
|
|
226
|
-
- Errors and cleanup operations
|
|
227
|
-
|
|
228
|
-
All hooks are optional and support both sync and async implementations.
|
|
229
|
-
Hook errors are caught internally and won't affect core functionality.
|
|
230
|
-
|
|
231
|
-
Common use cases:
|
|
232
|
-
- Cache invalidation (ContentManager, React Query)
|
|
233
|
-
- Analytics and monitoring (Sentry, DataDog)
|
|
234
|
-
- State management integration (Redux, Zustand)
|
|
235
|
-
- User notifications
|
|
236
|
-
|
|
237
|
-
#### Examples
|
|
238
|
-
|
|
239
|
-
**Basic usage**
|
|
240
|
-
|
|
241
|
-
```typescript
|
|
242
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
243
|
-
storage: customStorage,
|
|
244
|
-
hooks: {
|
|
245
|
-
onSessionEstablished: (sessionId) => {
|
|
246
|
-
ContentManager.invalidateSession(sessionId);
|
|
247
|
-
},
|
|
248
|
-
onKeyRotated: (keyType) => {
|
|
249
|
-
analytics.track('Key Rotated', { keyType });
|
|
250
|
-
}
|
|
251
|
-
}
|
|
252
|
-
});
|
|
253
|
-
```
|
|
254
|
-
|
|
255
|
-
**Error tracking**
|
|
256
|
-
|
|
257
|
-
```typescript
|
|
258
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
259
|
-
storage: customStorage,
|
|
260
|
-
hooks: {
|
|
261
|
-
onDecryptionError: (sessionId, error) => {
|
|
262
|
-
Sentry.captureException(error, {
|
|
263
|
-
tags: { sessionId }
|
|
264
|
-
});
|
|
265
|
-
}
|
|
266
|
-
}
|
|
267
|
-
});
|
|
268
|
-
```
|
|
269
|
-
|
|
270
|
-
***
|
|
271
|
-
|
|
272
|
-
### keyRefreshIntervalMs?
|
|
273
|
-
|
|
274
|
-
> `optional` **keyRefreshIntervalMs?**: `number`
|
|
275
|
-
|
|
276
|
-
Key refresh interval in milliseconds.
|
|
277
|
-
|
|
278
|
-
Controls how often signed prekeys and Kyber (last-resort) prekeys are rotated.
|
|
279
|
-
Per PQXDH specification Section 3.2, both key types use the same rotation
|
|
280
|
-
schedule for synchronized post-quantum security.
|
|
281
|
-
|
|
282
|
-
#### Default
|
|
283
|
-
|
|
284
|
-
```ts
|
|
285
|
-
172800000 (2 days)
|
|
286
|
-
```
|
|
287
|
-
|
|
288
|
-
#### Examples
|
|
289
|
-
|
|
290
|
-
**Default rotation interval**
|
|
291
|
-
|
|
292
|
-
```typescript
|
|
293
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
294
|
-
storage: customStorage,
|
|
295
|
-
keyRefreshIntervalMs: 2 * 24 * 60 * 60 * 1000 // 2 days
|
|
296
|
-
});
|
|
297
|
-
```
|
|
298
|
-
|
|
299
|
-
**Weekly rotation (lower bandwidth)**
|
|
300
|
-
|
|
301
|
-
```typescript
|
|
302
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
303
|
-
storage: customStorage,
|
|
304
|
-
keyRefreshIntervalMs: 7 * 24 * 60 * 60 * 1000 // 7 days
|
|
305
|
-
});
|
|
306
|
-
```
|
|
307
|
-
|
|
308
|
-
#### See
|
|
309
|
-
|
|
310
|
-
https://signal.org/docs/specifications/pqxdh/#publishing-keys
|
|
311
|
-
|
|
312
|
-
***
|
|
313
|
-
|
|
314
|
-
### logger?
|
|
315
|
-
|
|
316
|
-
> `optional` **logger?**: [`ILogger`](ILogger.md)
|
|
317
|
-
|
|
318
|
-
Custom logger implementation
|
|
319
|
-
|
|
320
|
-
Default: Environment-aware console logging
|
|
321
|
-
- Development: verbose (debug, info, warn, error, breadcrumb)
|
|
322
|
-
- Production: minimal (warn, error only)
|
|
323
|
-
|
|
324
|
-
#### Examples
|
|
325
|
-
|
|
326
|
-
**Using custom logger**
|
|
327
|
-
|
|
328
|
-
```typescript
|
|
329
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
330
|
-
storage: customStorage,
|
|
331
|
-
logger: {
|
|
332
|
-
info: (msg, data) => myLogger.log('info', msg, data),
|
|
333
|
-
error: (msg, err) => myLogger.log('error', msg, err),
|
|
334
|
-
warn: (msg, data) => myLogger.log('warn', msg, data)
|
|
335
|
-
}
|
|
336
|
-
});
|
|
337
|
-
```
|
|
338
|
-
|
|
339
|
-
**Using console directly**
|
|
340
|
-
|
|
341
|
-
```typescript
|
|
342
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
343
|
-
storage: customStorage,
|
|
344
|
-
logger: console // Works directly!
|
|
345
|
-
});
|
|
346
|
-
```
|
|
347
|
-
|
|
348
|
-
**Using pino**
|
|
349
|
-
|
|
350
|
-
```typescript
|
|
351
|
-
import pino from 'pino';
|
|
352
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
353
|
-
storage: customStorage,
|
|
354
|
-
logger: pino({ level: 'info' })
|
|
355
|
-
});
|
|
356
|
-
```
|
|
357
|
-
|
|
358
|
-
**Silent mode**
|
|
359
|
-
|
|
360
|
-
```typescript
|
|
361
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
362
|
-
storage: customStorage,
|
|
363
|
-
logger: {} // All methods optional
|
|
364
|
-
});
|
|
365
|
-
```
|
|
366
|
-
|
|
367
|
-
***
|
|
368
|
-
|
|
369
|
-
### maxPreKeyAgeMs?
|
|
370
|
-
|
|
371
|
-
> `optional` **maxPreKeyAgeMs?**: `number`
|
|
372
|
-
|
|
373
|
-
Maximum allowed prekey age in milliseconds.
|
|
374
|
-
|
|
375
|
-
If prekeys exceed this age, message sending should be blocked to force
|
|
376
|
-
key rotation. Provides a safety buffer above keyRefreshIntervalMs.
|
|
377
|
-
|
|
378
|
-
With the default two-day refresh interval, the default maximum age leaves
|
|
379
|
-
a twelve-day recovery window.
|
|
380
|
-
|
|
381
|
-
#### Default
|
|
382
|
-
|
|
383
|
-
```ts
|
|
384
|
-
1209600000 (14 days)
|
|
385
|
-
```
|
|
386
|
-
|
|
387
|
-
#### Example
|
|
388
|
-
|
|
389
|
-
**Default maximum age**
|
|
390
|
-
|
|
391
|
-
```typescript
|
|
392
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
393
|
-
storage: customStorage,
|
|
394
|
-
maxPreKeyAgeMs: 14 * 24 * 60 * 60 * 1000 // 14 days
|
|
395
|
-
});
|
|
396
|
-
```
|
|
397
|
-
|
|
398
|
-
#### See
|
|
399
|
-
|
|
400
|
-
https://signal.org/docs/specifications/pqxdh/#publishing-keys
|
|
401
|
-
|
|
402
|
-
***
|
|
403
|
-
|
|
404
|
-
### media?
|
|
405
|
-
|
|
406
|
-
> `optional` **media?**: [`SignalProtocolClientMediaConfig`](SignalProtocolClientMediaConfig.md)
|
|
407
|
-
|
|
408
|
-
App-owned media lifecycle callbacks for the SignalProtocolClient media queue.
|
|
409
|
-
|
|
410
|
-
The queue itself is persisted through the existing Signal Protocol local storage
|
|
411
|
-
adapter. These callbacks keep local bytes, plaintext caches, and product
|
|
412
|
-
state in the app layer where they can share file permissions, UI state, and
|
|
413
|
-
app database ownership.
|
|
414
|
-
|
|
415
|
-
#### Example
|
|
416
|
-
|
|
417
|
-
```typescript
|
|
418
|
-
const signal = await createSignalProtocolClient({
|
|
419
|
-
identity: { userId },
|
|
420
|
-
adapters: { storage, relay, remoteObjectStore },
|
|
421
|
-
media: {
|
|
422
|
-
loadLocalAttachment: async ({ localMediaId }) => appDrafts.readBytes(localMediaId),
|
|
423
|
-
saveUploadedAttachment: async ({ localMediaId, attachment }) =>
|
|
424
|
-
appPointers.save(localMediaId, attachment),
|
|
425
|
-
saveDownloadedAttachment: async ({ attachmentId, downloaded }) =>
|
|
426
|
-
appMediaCache.save(attachmentId, downloaded.data),
|
|
427
|
-
deleteLocalAttachment: async ({ attachmentId }) => appMediaCache.delete(attachmentId),
|
|
428
|
-
},
|
|
429
|
-
});
|
|
430
|
-
```
|
|
431
|
-
|
|
432
|
-
***
|
|
433
|
-
|
|
434
|
-
### onGroupSenderKeyRotated?
|
|
435
|
-
|
|
436
|
-
> `optional` **onGroupSenderKeyRotated?**: (`groupId`, `newGeneration`) => `void`
|
|
437
|
-
|
|
438
|
-
Called when a group sender key is rotated.
|
|
439
|
-
|
|
440
|
-
Useful for logging, analytics, or triggering UI updates when
|
|
441
|
-
sender keys are rotated due to membership changes.
|
|
442
|
-
|
|
443
|
-
#### Parameters
|
|
444
|
-
|
|
445
|
-
##### groupId
|
|
446
|
-
|
|
447
|
-
`string`
|
|
448
|
-
|
|
449
|
-
The group whose sender key was rotated
|
|
450
|
-
|
|
451
|
-
##### newGeneration
|
|
452
|
-
|
|
453
|
-
`number`
|
|
454
|
-
|
|
455
|
-
The new generation number of the sender key
|
|
456
|
-
|
|
457
|
-
#### Returns
|
|
458
|
-
|
|
459
|
-
`void`
|
|
460
|
-
|
|
461
|
-
#### Example
|
|
462
|
-
|
|
463
|
-
```typescript
|
|
464
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
465
|
-
storage: customStorage,
|
|
466
|
-
onGroupSenderKeyRotated: (groupId, newGeneration) => {
|
|
467
|
-
console.log(`Group ${groupId} sender key rotated to gen ${newGeneration}`);
|
|
468
|
-
analytics.track('sender_key_rotated', { groupId, newGeneration });
|
|
469
|
-
}
|
|
470
|
-
});
|
|
471
|
-
```
|
|
472
|
-
|
|
473
|
-
***
|
|
474
|
-
|
|
475
|
-
### onPreKeyLow?
|
|
476
|
-
|
|
477
|
-
> `optional` **onPreKeyLow?**: (`remaining`) => `void`
|
|
478
|
-
|
|
479
|
-
Callback when one-time prekeys are running low
|
|
480
|
-
|
|
481
|
-
Called when prekey count drops below the threshold (default: 50).
|
|
482
|
-
Use this to trigger prekey replenishment to prevent session
|
|
483
|
-
establishment failures.
|
|
484
|
-
|
|
485
|
-
#### Parameters
|
|
486
|
-
|
|
487
|
-
##### remaining
|
|
488
|
-
|
|
489
|
-
`number`
|
|
490
|
-
|
|
491
|
-
#### Returns
|
|
492
|
-
|
|
493
|
-
`void`
|
|
494
|
-
|
|
495
|
-
#### Example
|
|
496
|
-
|
|
497
|
-
```typescript
|
|
498
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
499
|
-
storage: customStorage,
|
|
500
|
-
onPreKeyLow: (remaining) => {
|
|
501
|
-
console.warn(`Only ${remaining} prekeys remaining, replenishment needed`);
|
|
502
|
-
// Trigger server-side prekey generation
|
|
503
|
-
backend.replenishPrekeys(userId);
|
|
504
|
-
}
|
|
505
|
-
});
|
|
506
|
-
```
|
|
507
|
-
|
|
508
|
-
***
|
|
509
|
-
|
|
510
|
-
### onProgress?
|
|
511
|
-
|
|
512
|
-
> `optional` **onProgress?**: [`ProgressCallback`](../type-aliases/ProgressCallback.md)
|
|
513
|
-
|
|
514
|
-
Progress callback for initialization and relay sync operations.
|
|
515
|
-
|
|
516
|
-
Receives updates during:
|
|
517
|
-
- Key generation
|
|
518
|
-
- Prekey bundle generation
|
|
519
|
-
- Relay upload
|
|
520
|
-
|
|
521
|
-
#### Example
|
|
522
|
-
|
|
523
|
-
```typescript
|
|
524
|
-
const signal = await createSignalProtocolClient({
|
|
525
|
-
identity: { userId },
|
|
526
|
-
adapters: { storage, relay },
|
|
527
|
-
onProgress: ({ stage, percent, message }) => {
|
|
528
|
-
console.log(`${stage}: ${percent}% - ${message}`);
|
|
529
|
-
}
|
|
530
|
-
});
|
|
531
|
-
```
|
|
532
|
-
|
|
533
|
-
***
|
|
534
|
-
|
|
535
|
-
### preKeyCheckThrottleMs?
|
|
536
|
-
|
|
537
|
-
> `optional` **preKeyCheckThrottleMs?**: `number`
|
|
538
|
-
|
|
539
|
-
Prekey check throttle interval in milliseconds.
|
|
540
|
-
|
|
541
|
-
Controls how often prekey count checks are performed on app activation.
|
|
542
|
-
Prevents unnecessary server queries when the app is repeatedly foregrounded.
|
|
543
|
-
|
|
544
|
-
#### Default
|
|
545
|
-
|
|
546
|
-
```ts
|
|
547
|
-
43200000 (12 hours)
|
|
548
|
-
```
|
|
549
|
-
|
|
550
|
-
#### See
|
|
551
|
-
|
|
552
|
-
https://signal.org/docs/specifications/pqxdh/#publishing-keys
|
|
553
|
-
|
|
554
|
-
***
|
|
555
|
-
|
|
556
|
-
### preKeyLowThreshold?
|
|
557
|
-
|
|
558
|
-
> `optional` **preKeyLowThreshold?**: `number`
|
|
559
|
-
|
|
560
|
-
Threshold for prekey low warning
|
|
561
|
-
Default: 50 (warn when fewer than 50 one-time prekeys remain)
|
|
562
|
-
|
|
563
|
-
***
|
|
564
|
-
|
|
565
|
-
### preKeyMaintenance?
|
|
566
|
-
|
|
567
|
-
> `optional` **preKeyMaintenance?**: [`PreKeyMaintenanceStore`](PreKeyMaintenanceStore.md)
|
|
568
|
-
|
|
569
|
-
App-provided prekey bookkeeping store.
|
|
570
|
-
|
|
571
|
-
Needed for SQLite-backed adapters that track replaced prekeys separately
|
|
572
|
-
from the protocol-facing local store interface.
|
|
573
|
-
|
|
574
|
-
***
|
|
575
|
-
|
|
576
|
-
### protocol?
|
|
577
|
-
|
|
578
|
-
> `optional` **protocol?**: [`SignalProtocolConfig`](SignalProtocolConfig.md)
|
|
579
|
-
|
|
580
|
-
Developer-facing protocol policy.
|
|
581
|
-
|
|
582
|
-
The default is strict post-quantum behavior with the specification-defined
|
|
583
|
-
ML-KEM Braid SPQR mode. Use `compatible` only when the product deliberately
|
|
584
|
-
supports genuinely non-PQ peers. Use `braid: 'disabled'` only when a
|
|
585
|
-
product-reviewed constraint requires the local direct SPQR mode.
|
|
586
|
-
|
|
587
|
-
#### Default
|
|
588
|
-
|
|
589
|
-
```ts
|
|
590
|
-
{ postQuantum: 'required', braid: 'required' }
|
|
591
|
-
```
|
|
592
|
-
|
|
593
|
-
#### Examples
|
|
594
|
-
|
|
595
|
-
**Strict post-quantum mode**
|
|
596
|
-
|
|
597
|
-
```typescript
|
|
598
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
599
|
-
storage: customStorage,
|
|
600
|
-
protocol: {
|
|
601
|
-
postQuantum: 'required',
|
|
602
|
-
braid: 'required'
|
|
603
|
-
}
|
|
604
|
-
});
|
|
605
|
-
```
|
|
606
|
-
|
|
607
|
-
**Compatibility with non-PQ peers**
|
|
608
|
-
|
|
609
|
-
```typescript
|
|
610
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
611
|
-
storage: customStorage,
|
|
612
|
-
protocol: {
|
|
613
|
-
postQuantum: 'compatible',
|
|
614
|
-
braid: 'required'
|
|
615
|
-
}
|
|
616
|
-
});
|
|
617
|
-
```
|
|
618
|
-
|
|
619
|
-
**Explicit direct SPQR mode**
|
|
620
|
-
|
|
621
|
-
```typescript
|
|
622
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
623
|
-
storage: customStorage,
|
|
624
|
-
protocol: {
|
|
625
|
-
postQuantum: 'required',
|
|
626
|
-
braid: 'disabled'
|
|
627
|
-
}
|
|
628
|
-
});
|
|
629
|
-
```
|
|
630
|
-
|
|
631
|
-
***
|
|
632
|
-
|
|
633
|
-
### protocolManager?
|
|
634
|
-
|
|
635
|
-
> `optional` **protocolManager?**: [`ISignalProtocolManager`](ISignalProtocolManager.md)
|
|
636
|
-
|
|
637
|
-
Signal Protocol Manager implementation (for advanced use cases)
|
|
638
|
-
Default: Creates new SignalProtocolManager instance
|
|
639
|
-
|
|
640
|
-
***
|
|
641
|
-
|
|
642
|
-
### protocolStrategy?
|
|
643
|
-
|
|
644
|
-
> `optional` **protocolStrategy?**: [`ProtocolStrategyConfig`](ProtocolStrategyConfig.md)
|
|
645
|
-
|
|
646
|
-
Advanced protocol strategy configuration.
|
|
647
|
-
|
|
648
|
-
Most application code should use `protocol.postQuantum` instead. This seam
|
|
649
|
-
exists for diagnostics, telemetry callbacks, and advanced tuning.
|
|
650
|
-
|
|
651
|
-
#### Example
|
|
652
|
-
|
|
653
|
-
**Track protocol usage**
|
|
654
|
-
|
|
655
|
-
```typescript
|
|
656
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
657
|
-
storage: customStorage,
|
|
658
|
-
protocolStrategy: {
|
|
659
|
-
onProtocolSelected: (event) => {
|
|
660
|
-
analytics.track('Protocol Selected', {
|
|
661
|
-
pq: event.usedPQXDH,
|
|
662
|
-
tripleRatchet: event.usedTripleRatchet,
|
|
663
|
-
compatibilityFallback: event.usedClassicalFallback,
|
|
664
|
-
fallbackReason: event.classicalFallbackReason
|
|
665
|
-
});
|
|
666
|
-
}
|
|
667
|
-
}
|
|
668
|
-
});
|
|
669
|
-
```
|
|
670
|
-
|
|
671
|
-
***
|
|
672
|
-
|
|
673
|
-
### ratchetConfig?
|
|
674
|
-
|
|
675
|
-
> `optional` **ratchetConfig?**: [`DoubleRatchetConfig`](DoubleRatchetConfig.md)
|
|
676
|
-
|
|
677
|
-
Double Ratchet algorithm configuration
|
|
678
|
-
|
|
679
|
-
***
|
|
680
|
-
|
|
681
|
-
### relay?
|
|
682
|
-
|
|
683
|
-
> `optional` **relay?**: [`ISignalProtocolRelayServer`](ISignalProtocolRelayServer.md)
|
|
684
|
-
|
|
685
|
-
Relay adapter for server synchronization.
|
|
686
|
-
|
|
687
|
-
If provided, the client will automatically:
|
|
688
|
-
1. Generate prekey bundle
|
|
689
|
-
2. Upload public keys to the relay server
|
|
690
|
-
3. Provide progress updates via onProgress callback
|
|
691
|
-
|
|
692
|
-
If omitted, client operates in local-only mode.
|
|
693
|
-
|
|
694
|
-
#### Example
|
|
695
|
-
|
|
696
|
-
```typescript
|
|
697
|
-
import { createSignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
|
|
698
|
-
import {
|
|
699
|
-
convexRelay,
|
|
700
|
-
type ConvexSignalProtocolRelayApi,
|
|
701
|
-
} from '@open-e2ee/signal-protocol-sdk/remote/relay/convex';
|
|
702
|
-
import { api } from '../convex/_generated/api';
|
|
703
|
-
|
|
704
|
-
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
705
|
-
const relay = convexRelay({ convex, api: signalApi, currentUserId: userId });
|
|
706
|
-
|
|
707
|
-
const signal = await createSignalProtocolClient({
|
|
708
|
-
identity: { userId },
|
|
709
|
-
adapters: { storage, relay },
|
|
710
|
-
});
|
|
711
|
-
```
|
|
712
|
-
|
|
713
|
-
***
|
|
714
|
-
|
|
715
|
-
### remoteObjectStore?
|
|
716
|
-
|
|
717
|
-
> `optional` **remoteObjectStore?**: [`SignalProtocolRemoteObjectStore`](SignalProtocolRemoteObjectStore.md)
|
|
718
|
-
|
|
719
|
-
Remote object storage adapter for encrypted file uploads (two-layer encryption)
|
|
720
|
-
|
|
721
|
-
If provided, enables encrypted file upload (two-layer encryption):
|
|
722
|
-
1. Generate AES-256-GCM key
|
|
723
|
-
2. Encrypt file bytes with AES
|
|
724
|
-
3. Upload encrypted bytes to object storage
|
|
725
|
-
4. Send storage ID + key via Signal Protocol
|
|
726
|
-
|
|
727
|
-
If omitted, file upload operations will throw an error.
|
|
728
|
-
|
|
729
|
-
#### Example
|
|
730
|
-
|
|
731
|
-
```typescript
|
|
732
|
-
import { createSignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
|
|
733
|
-
import { convexR2ObjectStore } from '@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2';
|
|
734
|
-
import { api } from '../convex/_generated/api';
|
|
735
|
-
|
|
736
|
-
const remoteObjectStore = convexR2ObjectStore({
|
|
737
|
-
convex,
|
|
738
|
-
api: api.signalObjectStore,
|
|
739
|
-
});
|
|
740
|
-
|
|
741
|
-
const signal = await createSignalProtocolClient({
|
|
742
|
-
identity: { userId },
|
|
743
|
-
adapters: { storage, relay, remoteObjectStore },
|
|
744
|
-
});
|
|
745
|
-
|
|
746
|
-
// Send file bytes
|
|
747
|
-
const fileBytes = new Uint8Array(await file.arrayBuffer());
|
|
748
|
-
await signal.send('bob', fileBytes, { mimeType: 'image/jpeg' });
|
|
749
|
-
```
|
|
750
|
-
|
|
751
|
-
***
|
|
752
|
-
|
|
753
|
-
### sealedSender?
|
|
754
|
-
|
|
755
|
-
> `optional` **sealedSender?**: [`SealedSenderConfig`](SealedSenderConfig.md)
|
|
756
|
-
|
|
757
|
-
Sealed Sender configuration for anonymous message delivery.
|
|
758
|
-
|
|
759
|
-
When configured, messages are wrapped with sealed sender encryption
|
|
760
|
-
that hides the sender's identity from the server. The recipient can
|
|
761
|
-
still verify the sender via the embedded certificate.
|
|
762
|
-
|
|
763
|
-
Requires:
|
|
764
|
-
- Server-side SEALED_SENDER_SIGNING_KEY environment variable
|
|
765
|
-
- Trust root public key distributed to clients
|
|
766
|
-
|
|
767
|
-
#### See
|
|
768
|
-
|
|
769
|
-
https://signal.org/blog/sealed-sender/
|
|
770
|
-
|
|
771
|
-
#### Example
|
|
772
|
-
|
|
773
|
-
```typescript
|
|
774
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
775
|
-
storage: customStorage,
|
|
776
|
-
sealedSender: {
|
|
777
|
-
trustRoots: [trustRootPublicKeyBytes],
|
|
778
|
-
certificateProvider: async () => {
|
|
779
|
-
return await convex.mutation(api.signal.certificates.issueSenderCertificate, { deviceId: 1 });
|
|
780
|
-
},
|
|
781
|
-
accessMode: 'unrestricted',
|
|
782
|
-
}
|
|
783
|
-
});
|
|
784
|
-
```
|
|
785
|
-
|
|
786
|
-
***
|
|
787
|
-
|
|
788
|
-
### senderKeys?
|
|
789
|
-
|
|
790
|
-
> `optional` **senderKeys?**: [`SenderKeysConfig`](SenderKeysConfig.md)
|
|
791
|
-
|
|
792
|
-
Sender Keys (group messaging) configuration.
|
|
793
|
-
|
|
794
|
-
Controls HKDF info strings, DoS protection limits, and out-of-order
|
|
795
|
-
message handling for group encryption.
|
|
796
|
-
|
|
797
|
-
#### Examples
|
|
798
|
-
|
|
799
|
-
**Custom protocol branding**
|
|
800
|
-
|
|
801
|
-
```typescript
|
|
802
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
803
|
-
storage: customStorage,
|
|
804
|
-
senderKeys: {
|
|
805
|
-
hkdfInfoString: 'MyApp Group V1'
|
|
806
|
-
}
|
|
807
|
-
});
|
|
808
|
-
```
|
|
809
|
-
|
|
810
|
-
**Production-recommended limits (these are the defaults)**
|
|
811
|
-
|
|
812
|
-
```typescript
|
|
813
|
-
const signal = await SignalProtocolClient.create(userId, {
|
|
814
|
-
storage: customStorage,
|
|
815
|
-
senderKeys: {
|
|
816
|
-
maxChainAdvance: 2000, // DoS protection
|
|
817
|
-
maxSkippedKeys: 2000 // Memory limit
|
|
818
|
-
}
|
|
819
|
-
});
|
|
820
|
-
```
|
|
821
|
-
|
|
822
|
-
***
|
|
823
|
-
|
|
824
|
-
### storage
|
|
825
|
-
|
|
826
|
-
> **storage**: [`ISignalProtocolLocalStore`](ISignalProtocolLocalStore.md)
|
|
827
|
-
|
|
828
|
-
Local store implementation for the current runtime.
|
|
829
|
-
Required by SignalProtocolClient.create().
|
|
830
|
-
|
|
831
|
-
***
|
|
832
|
-
|
|
833
|
-
### throwDetailedErrors?
|
|
834
|
-
|
|
835
|
-
> `optional` **throwDetailedErrors?**: `boolean`
|
|
836
|
-
|
|
837
|
-
Throw detailed errors instead of generic messages
|
|
838
|
-
Default: false (generic error messages for security)
|
|
839
|
-
Recommended: Enable in development for debugging
|