@open-e2ee/signal-protocol-sdk 0.1.0-alpha.1 → 0.1.0-alpha.11
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 +24 -24
- package/ARCHITECTURE.md +4 -4
- package/CHANGELOG.md +1370 -0
- package/COMMERCIAL.md +56 -0
- package/NOTICE +3 -1
- package/README.md +40 -35
- package/SECURITY.md +15 -1
- package/blocking/README.md +5 -5
- package/client/README.md +5 -5
- package/device/README.md +3 -1
- package/dist/blocking/index.d.ts +2 -2
- package/dist/blocking/index.d.ts.map +1 -1
- package/dist/blocking/index.js +1 -1
- package/dist/blocking/index.js.map +1 -1
- package/dist/blocking/manager.d.ts +7 -7
- package/dist/blocking/manager.d.ts.map +1 -1
- package/dist/blocking/manager.js +3 -3
- package/dist/blocking/manager.js.map +1 -1
- package/dist/blocking/types.d.ts +4 -4
- package/dist/blocking/types.d.ts.map +1 -1
- package/dist/blocking/types.js +1 -1
- package/dist/client/client.d.ts +48 -41
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +160 -101
- package/dist/client/client.js.map +1 -1
- package/dist/client/compose.d.ts +15 -10
- 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 +68 -34
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/config.js.map +1 -1
- package/dist/client/content-adapter.d.ts +4 -4
- package/dist/client/content-adapter.d.ts.map +1 -1
- package/dist/client/content-adapter.js +1 -1
- package/dist/client/content-adapter.js.map +1 -1
- package/dist/client/dual-store.d.ts +5 -5
- package/dist/client/dual-store.d.ts.map +1 -1
- package/dist/client/dual-store.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 +37 -12
- package/dist/client/endorsement-manager.js.map +1 -1
- package/dist/client/event-hooks.d.ts +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 +12 -12
- package/dist/client/headless.d.ts.map +1 -1
- package/dist/client/headless.js +9 -9
- package/dist/client/headless.js.map +1 -1
- package/dist/client/index.d.ts +4 -4
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/key-rotation-core.d.ts +11 -11
- package/dist/client/key-rotation-core.d.ts.map +1 -1
- package/dist/client/key-rotation-core.js +22 -22
- package/dist/client/key-rotation-core.js.map +1 -1
- package/dist/client/media.d.ts +2 -2
- package/dist/client/media.js +5 -5
- package/dist/client/media.js.map +1 -1
- package/dist/client/messages.js +2 -2
- package/dist/client/messages.js.map +1 -1
- package/dist/client/prekeys.js +1 -1
- package/dist/client/prekeys.js.map +1 -1
- package/dist/client/relay-subscription.d.ts +2 -2
- package/dist/client/relay-subscription.d.ts.map +1 -1
- package/dist/client/relay-subscription.js +18 -1
- package/dist/client/relay-subscription.js.map +1 -1
- package/dist/client/retry.js +1 -1
- package/dist/client/retry.js.map +1 -1
- package/dist/client/sealed-sender-ops.d.ts +28 -2
- package/dist/client/sealed-sender-ops.d.ts.map +1 -1
- package/dist/client/sealed-sender-ops.js +40 -10
- package/dist/client/sealed-sender-ops.js.map +1 -1
- package/dist/client/sessions.d.ts.map +1 -1
- package/dist/client/sessions.js +3 -0
- package/dist/client/sessions.js.map +1 -1
- package/dist/client/signal-service-cipher.d.ts +34 -11
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +149 -75
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/types.d.ts +28 -15
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js.map +1 -1
- package/dist/device/connection.js +2 -2
- package/dist/device/connection.js.map +1 -1
- package/dist/device/device-id.d.ts.map +1 -1
- package/dist/device/device-id.js +4 -4
- package/dist/device/device-id.js.map +1 -1
- package/dist/device/expo-metadata.d.ts +26 -0
- package/dist/device/expo-metadata.d.ts.map +1 -0
- package/dist/device/expo-metadata.js +33 -0
- package/dist/device/expo-metadata.js.map +1 -0
- package/dist/device/index.d.ts +1 -1
- package/dist/device/index.d.ts.map +1 -1
- package/dist/device/index.js +5 -1
- package/dist/device/index.js.map +1 -1
- package/dist/device/provisioning.d.ts +9 -17
- package/dist/device/provisioning.d.ts.map +1 -1
- package/dist/device/provisioning.js +13 -30
- package/dist/device/provisioning.js.map +1 -1
- package/dist/device/transfer.d.ts.map +1 -1
- package/dist/device/transfer.js +14 -14
- package/dist/device/transfer.js.map +1 -1
- package/dist/files/index.d.ts +1 -1
- package/dist/files/index.js +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/hooks/use-connection-presence.d.ts +5 -5
- package/dist/hooks/use-connection-presence.d.ts.map +1 -1
- package/dist/hooks/use-connection-presence.js +5 -5
- package/dist/hooks/use-connection-presence.js.map +1 -1
- package/dist/hooks/use-group-membership.d.ts +2 -2
- package/dist/hooks/use-key-rotation.js +2 -2
- package/dist/hooks/use-key-rotation.js.map +1 -1
- package/dist/index.d.ts +29 -22
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +20 -13
- package/dist/index.js.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.js +4 -4
- package/dist/internal/crypto/ec/x25519-validation.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 +2 -2
- package/dist/internal/crypto/index.js.map +1 -1
- package/dist/internal/crypto/kdf/hkdf.d.ts +1 -1
- package/dist/internal/crypto/kdf/hkdf.d.ts.map +1 -1
- package/dist/internal/crypto/kdf/hkdf.js +2 -2
- package/dist/internal/crypto/kdf/hkdf.js.map +1 -1
- package/dist/internal/crypto/key-prefix.d.ts +1 -1
- package/dist/internal/crypto/key-prefix.js +1 -1
- package/dist/internal/crypto/pq/kyber.d.ts +1 -1
- package/dist/internal/crypto/pq/kyber.js +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/crypto/symmetric/aes-gcm-siv.d.ts +1 -1
- package/dist/internal/crypto/symmetric/aes-gcm-siv.js +1 -1
- package/dist/internal/crypto/symmetric/mac.d.ts +3 -3
- package/dist/internal/crypto/symmetric/mac.js +3 -3
- package/dist/internal/crypto/utils.d.ts +2 -2
- package/dist/internal/crypto/utils.js +2 -2
- package/dist/internal/encoding/proto/envelope.d.ts +21 -21
- package/dist/internal/encoding/proto/envelope.d.ts.map +1 -1
- package/dist/internal/encoding/proto/envelope.js +25 -25
- package/dist/internal/encoding/proto/envelope.js.map +1 -1
- package/dist/internal/encoding/proto/index.d.ts +2 -2
- package/dist/internal/encoding/proto/index.d.ts.map +1 -1
- package/dist/internal/encoding/proto/index.js +3 -3
- package/dist/internal/encoding/proto/index.js.map +1 -1
- package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts +5 -5
- package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts.map +1 -1
- package/dist/internal/encoding/proto/pq-ratchet-serialize.js +4 -4
- package/dist/internal/encoding/proto/pq-ratchet-serialize.js.map +1 -1
- package/dist/internal/encoding/proto/primitives.d.ts +261 -6
- package/dist/internal/encoding/proto/primitives.d.ts.map +1 -1
- package/dist/internal/encoding/proto/primitives.js +468 -6
- package/dist/internal/encoding/proto/primitives.js.map +1 -1
- package/dist/internal/encoding/proto/sender-key-message.d.ts +4 -3
- package/dist/internal/encoding/proto/sender-key-message.d.ts.map +1 -1
- package/dist/internal/encoding/proto/sender-key-message.js +97 -76
- package/dist/internal/encoding/proto/sender-key-message.js.map +1 -1
- package/dist/internal/encoding/proto/signal-message.d.ts +39 -34
- package/dist/internal/encoding/proto/signal-message.d.ts.map +1 -1
- package/dist/internal/encoding/proto/signal-message.js +236 -152
- package/dist/internal/encoding/proto/signal-message.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 +212 -43
- package/dist/internal/groups/manager.d.ts.map +1 -0
- package/dist/internal/groups/manager.js +1945 -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 +98 -0
- package/dist/internal/groups/server-engine.d.ts.map +1 -0
- package/dist/internal/groups/server-engine.js +1235 -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 +190 -41
- 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/manager/manager.d.ts +4 -4
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +28 -17
- package/dist/internal/manager/manager.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.d.ts +1 -1
- package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.js +10 -10
- package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts +3 -3
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.js +3 -3
- package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.js +3 -3
- package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption-v2.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption-v2.js +32 -18
- package/dist/internal/protocol/sealed-sender/decryption-v2.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/decryption.js +35 -21
- 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 +56 -11
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.js +278 -158
- 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 +65 -10
- package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/types.js +44 -1
- 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 +41 -4
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +113 -12
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/index.d.ts +1 -1
- package/dist/internal/protocol/spqr/index.js +1 -1
- package/dist/internal/protocol/spqr/message.d.ts +1 -1
- package/dist/internal/protocol/spqr/message.js +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts +3 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/index.js +2 -2
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/index.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/lagrange.d.ts +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/lagrange.js +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/rs/lagrange.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/serialize.d.ts +8 -2
- package/dist/internal/protocol/spqr/ml-kem-braid/serialize.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/serialize.js +335 -152
- package/dist/internal/protocol/spqr/ml-kem-braid/serialize.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js +5 -5
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts +10 -10
- package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.js +14 -14
- package/dist/internal/protocol/spqr/spqr.js.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +3 -3
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.js +5 -5
- package/dist/internal/protocol/triple-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/username/generate.d.ts +1 -1
- package/dist/internal/protocol/username/generate.js +1 -1
- package/dist/internal/protocol/username/hash.d.ts +1 -1
- package/dist/internal/protocol/username/hash.js +1 -1
- package/dist/internal/protocol/username/link.d.ts +1 -1
- package/dist/internal/protocol/username/link.js +1 -1
- package/dist/internal/protocol/username/proof.d.ts +1 -1
- package/dist/internal/protocol/username/proof.js +1 -1
- package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
- package/dist/internal/protocol/x3dh/x3dh.js +6 -6
- package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
- package/dist/internal/protocol/zk/groups/auth-credential.d.ts +14 -11
- 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/client-zk-group-cipher.d.ts +2 -2
- package/dist/internal/protocol/zk/groups/client-zk-group-cipher.js +2 -2
- 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/internal/sesame/device-registry.d.ts +18 -13
- package/dist/internal/sesame/device-registry.d.ts.map +1 -1
- package/dist/internal/sesame/device-registry.js +13 -9
- package/dist/internal/sesame/device-registry.js.map +1 -1
- package/dist/internal/sesame/manager.d.ts +1 -1
- package/dist/internal/sesame/manager.d.ts.map +1 -1
- package/dist/internal/sesame/manager.js +66 -34
- package/dist/internal/sesame/manager.js.map +1 -1
- package/dist/internal/sesame/types.d.ts.map +1 -1
- package/dist/internal/sesame/types.js +7 -2
- package/dist/internal/sesame/types.js.map +1 -1
- package/dist/internal/session/builder.js +3 -3
- package/dist/internal/session/builder.js.map +1 -1
- package/dist/internal/session/cipher.d.ts +2 -2
- package/dist/internal/session/cipher.d.ts.map +1 -1
- package/dist/internal/session/cipher.js +38 -30
- package/dist/internal/session/cipher.js.map +1 -1
- package/dist/internal/session/decryption.d.ts +1 -1
- package/dist/internal/session/decryption.js +10 -10
- package/dist/internal/session/decryption.js.map +1 -1
- package/dist/internal/session/factory.d.ts.map +1 -1
- package/dist/internal/session/factory.js +3 -3
- package/dist/internal/session/factory.js.map +1 -1
- package/dist/internal/session/handshake.d.ts.map +1 -1
- package/dist/internal/session/handshake.js +3 -3
- package/dist/internal/session/handshake.js.map +1 -1
- package/dist/internal/session/keys.d.ts +1 -1
- package/dist/internal/session/ratchet.d.ts.map +1 -1
- package/dist/internal/session/ratchet.js +4 -4
- package/dist/internal/session/ratchet.js.map +1 -1
- package/dist/internal/session/types.d.ts +2 -2
- package/dist/internal/session/types.d.ts.map +1 -1
- package/dist/internal/session/validation.d.ts.map +1 -1
- package/dist/internal/session/validation.js +3 -3
- package/dist/internal/session/validation.js.map +1 -1
- package/dist/keys/generation.d.ts +4 -3
- package/dist/keys/generation.d.ts.map +1 -1
- package/dist/keys/generation.js +2 -2
- package/dist/keys/generation.js.map +1 -1
- package/dist/keys/identity.d.ts +32 -0
- package/dist/keys/identity.d.ts.map +1 -1
- package/dist/keys/identity.js +55 -0
- package/dist/keys/identity.js.map +1 -1
- package/dist/keys/index.d.ts +1 -1
- package/dist/keys/index.d.ts.map +1 -1
- package/dist/keys/index.js +1 -1
- package/dist/keys/index.js.map +1 -1
- package/dist/keys/types.d.ts +1 -1
- package/dist/keys/types.d.ts.map +1 -1
- package/dist/layers.d.ts +5 -5
- package/dist/layers.d.ts.map +1 -1
- package/dist/layers.js +9 -9
- package/dist/layers.js.map +1 -1
- package/dist/local/store/expo/adapter.d.ts +28 -25
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +125 -113
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/expo/database-key.d.ts +2 -2
- package/dist/local/store/expo/database-key.d.ts.map +1 -1
- package/dist/local/store/expo/database-key.js +5 -5
- package/dist/local/store/expo/database-key.js.map +1 -1
- package/dist/local/store/expo/db.d.ts +13 -10
- package/dist/local/store/expo/db.d.ts.map +1 -1
- package/dist/local/store/expo/db.js +8 -3
- package/dist/local/store/expo/db.js.map +1 -1
- package/dist/local/store/expo/index.d.ts +5 -7
- package/dist/local/store/expo/index.d.ts.map +1 -1
- package/dist/local/store/expo/index.js +3 -3
- package/dist/local/store/expo/index.js.map +1 -1
- package/dist/local/store/expo/key-storage.d.ts +1 -1
- package/dist/local/store/expo/key-storage.d.ts.map +1 -1
- package/dist/local/store/expo/key-storage.js +4 -4
- package/dist/local/store/expo/key-storage.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/local-identity.d.ts +1 -1
- package/dist/local/store/expo/models/local-identity.js +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 +135 -33
- package/dist/local/store/expo/schema.d.ts.map +1 -1
- package/dist/local/store/expo/schema.js +37 -8
- package/dist/local/store/expo/schema.js.map +1 -1
- package/dist/local/store/expo/secure-store-options.d.ts +2 -2
- package/dist/local/store/expo/secure-store-options.d.ts.map +1 -1
- package/dist/local/store/expo/secure-store-options.js +1 -1
- package/dist/local/store/expo/secure-store-options.js.map +1 -1
- package/dist/local/store/index.d.ts +9 -9
- package/dist/local/store/index.d.ts.map +1 -1
- package/dist/local/store/index.js +9 -9
- package/dist/local/store/index.js.map +1 -1
- package/dist/local/store/{mock → memory}/adapter.d.ts +14 -7
- package/dist/local/store/memory/adapter.d.ts.map +1 -0
- package/dist/local/store/{mock → memory}/adapter.js +156 -58
- package/dist/local/store/memory/adapter.js.map +1 -0
- package/dist/local/store/memory/failures.d.ts +34 -0
- package/dist/local/store/memory/failures.d.ts.map +1 -0
- package/dist/local/store/memory/failures.js +75 -0
- package/dist/local/store/memory/failures.js.map +1 -0
- package/dist/local/store/memory/index.d.ts +11 -0
- package/dist/local/store/memory/index.d.ts.map +1 -0
- package/dist/local/store/memory/index.js +7 -0
- package/dist/local/store/memory/index.js.map +1 -0
- package/dist/local/store/node/adapter.d.ts +56 -7
- package/dist/local/store/node/adapter.d.ts.map +1 -1
- package/dist/local/store/node/adapter.js +458 -11
- package/dist/local/store/node/adapter.js.map +1 -1
- package/dist/local/store/node/database-key.js +1 -1
- package/dist/local/store/node/database.d.ts +68 -0
- package/dist/local/store/node/database.d.ts.map +1 -1
- package/dist/local/store/node/database.js +203 -20
- package/dist/local/store/node/database.js.map +1 -1
- package/dist/local/store/node/index.d.ts +4 -4
- package/dist/local/store/node/index.d.ts.map +1 -1
- package/dist/local/store/node/index.js +3 -3
- package/dist/local/store/node/index.js.map +1 -1
- package/dist/local/store/react-native/adapter.d.ts +44 -5
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +177 -22
- package/dist/local/store/react-native/adapter.js.map +1 -1
- package/dist/local/store/react-native/index.d.ts +4 -4
- package/dist/local/store/react-native/index.d.ts.map +1 -1
- package/dist/local/store/react-native/index.js +3 -3
- package/dist/local/store/react-native/index.js.map +1 -1
- package/dist/local/store/react-native/storage.d.ts +2 -2
- package/dist/local/store/web/adapter.d.ts +5 -4
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +54 -10
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/local/store/web/index.d.ts +4 -4
- package/dist/local/store/web/index.d.ts.map +1 -1
- package/dist/local/store/web/index.js +3 -3
- package/dist/local/store/web/index.js.map +1 -1
- package/dist/local/vault/expo-secure-store.d.ts +2 -2
- package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
- package/dist/local/vault/expo-secure-store.js +5 -5
- package/dist/local/vault/expo-secure-store.js.map +1 -1
- package/dist/local/vault/index.d.ts +7 -3
- package/dist/local/vault/index.d.ts.map +1 -1
- package/dist/local/vault/index.js +1 -1
- package/dist/local/vault/index.js.map +1 -1
- package/dist/logger.d.ts +4 -4
- package/dist/logger.d.ts.map +1 -1
- package/dist/logger.js +5 -5
- package/dist/logger.js.map +1 -1
- package/dist/media/index.d.ts +7 -7
- package/dist/media/index.d.ts.map +1 -1
- package/dist/media/index.js +2 -2
- package/dist/profile/cipher.d.ts +1 -1
- package/dist/profile/cipher.js +1 -1
- package/dist/profile/contact-state.d.ts +1 -1
- package/dist/profile/contact-state.d.ts.map +1 -1
- package/dist/profile/contact-state.js +3 -3
- package/dist/profile/contact-state.js.map +1 -1
- package/dist/profile/crypto.d.ts +1 -1
- package/dist/profile/crypto.js +1 -1
- package/dist/profile/profile-key.d.ts.map +1 -1
- package/dist/profile/profile-key.js +3 -3
- package/dist/profile/profile-key.js.map +1 -1
- package/dist/profile/update-service.d.ts +2 -2
- package/dist/profile/update-service.d.ts.map +1 -1
- package/dist/profile/update-service.js +2 -2
- package/dist/profile/update-service.js.map +1 -1
- package/dist/remote/object-store/convex-r2/server.d.ts +1 -1
- package/dist/remote/object-store/convex-r2/storage.d.ts +2 -2
- package/dist/remote/object-store/convex-r2/storage.d.ts.map +1 -1
- package/dist/remote/object-store/index.d.ts +1 -1
- package/dist/remote/object-store/index.d.ts.map +1 -1
- package/dist/remote/object-store/s3/storage.d.ts +3 -3
- package/dist/remote/object-store/s3/storage.d.ts.map +1 -1
- package/dist/remote/object-store/s3/storage.js +1 -1
- package/dist/remote/object-store/types.d.ts +1 -1
- package/dist/remote/object-store/types.d.ts.map +1 -1
- package/dist/remote/relay/convex/backend.d.ts +405 -0
- package/dist/remote/relay/convex/backend.d.ts.map +1 -0
- package/dist/remote/relay/convex/backend.js +687 -0
- package/dist/remote/relay/convex/backend.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/api.d.ts +58 -0
- package/dist/remote/relay/convex/component/_generated/api.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/api.js +31 -0
- package/dist/remote/relay/convex/component/_generated/api.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/component.d.ts +483 -0
- package/dist/remote/relay/convex/component/_generated/component.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/component.js +11 -0
- package/dist/remote/relay/convex/component/_generated/component.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.d.ts +46 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.js +11 -0
- package/dist/remote/relay/convex/component/_generated/dataModel.js.map +1 -0
- package/dist/remote/relay/convex/component/_generated/server.d.ts +129 -0
- package/dist/remote/relay/convex/component/_generated/server.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/_generated/server.js +79 -0
- package/dist/remote/relay/convex/component/_generated/server.js.map +1 -0
- package/dist/remote/relay/convex/component/accounts.d.ts +43 -0
- package/dist/remote/relay/convex/component/accounts.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/accounts.js +181 -0
- package/dist/remote/relay/convex/component/accounts.js.map +1 -0
- package/dist/remote/relay/convex/component/certificates.d.ts +10 -0
- package/dist/remote/relay/convex/component/certificates.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/certificates.js +117 -0
- package/dist/remote/relay/convex/component/certificates.js.map +1 -0
- package/dist/remote/relay/convex/component/cleanup.d.ts +32 -0
- package/dist/remote/relay/convex/component/cleanup.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/cleanup.js +146 -0
- package/dist/remote/relay/convex/component/cleanup.js.map +1 -0
- package/dist/remote/relay/convex/component/convex.config.d.ts +5 -0
- package/dist/remote/relay/convex/component/convex.config.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/convex.config.js +33 -0
- package/dist/remote/relay/convex/component/convex.config.js.map +1 -0
- package/dist/remote/relay/convex/component/crons.d.ts +3 -0
- package/dist/remote/relay/convex/component/crons.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/crons.js +10 -0
- package/dist/remote/relay/convex/component/crons.js.map +1 -0
- package/dist/remote/relay/convex/component/devices.d.ts +101 -0
- package/dist/remote/relay/convex/component/devices.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/devices.js +299 -0
- package/dist/remote/relay/convex/component/devices.js.map +1 -0
- package/dist/remote/relay/convex/component/errors.d.ts +22 -0
- package/dist/remote/relay/convex/component/errors.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/errors.js +17 -0
- package/dist/remote/relay/convex/component/errors.js.map +1 -0
- package/dist/remote/relay/convex/component/groups.d.ts +63 -0
- package/dist/remote/relay/convex/component/groups.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/groups.js +341 -0
- package/dist/remote/relay/convex/component/groups.js.map +1 -0
- package/dist/remote/relay/convex/component/keys.d.ts +130 -0
- package/dist/remote/relay/convex/component/keys.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/keys.js +578 -0
- package/dist/remote/relay/convex/component/keys.js.map +1 -0
- package/dist/remote/relay/convex/component/messages.d.ts +119 -0
- package/dist/remote/relay/convex/component/messages.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/messages.js +723 -0
- package/dist/remote/relay/convex/component/messages.js.map +1 -0
- package/dist/remote/relay/convex/component/provisioning.d.ts +92 -0
- package/dist/remote/relay/convex/component/provisioning.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/provisioning.js +359 -0
- package/dist/remote/relay/convex/component/provisioning.js.map +1 -0
- package/dist/remote/relay/convex/component/runtime.d.ts +18 -0
- package/dist/remote/relay/convex/component/runtime.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/runtime.js +142 -0
- package/dist/remote/relay/convex/component/runtime.js.map +1 -0
- package/dist/remote/relay/convex/component/schema.d.ts +358 -0
- package/dist/remote/relay/convex/component/schema.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/schema.js +287 -0
- package/dist/remote/relay/convex/component/schema.js.map +1 -0
- package/dist/remote/relay/convex/component/zkAuth.d.ts +12 -0
- package/dist/remote/relay/convex/component/zkAuth.d.ts.map +1 -0
- package/dist/remote/relay/convex/component/zkAuth.js +71 -0
- package/dist/remote/relay/convex/component/zkAuth.js.map +1 -0
- package/dist/remote/relay/convex/constants.d.ts +3 -0
- package/dist/remote/relay/convex/constants.d.ts.map +1 -0
- package/dist/remote/relay/convex/constants.js +3 -0
- package/dist/remote/relay/convex/constants.js.map +1 -0
- package/dist/remote/relay/convex/group-server.d.ts +29 -24
- package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
- package/dist/remote/relay/convex/group-server.js +62 -28
- package/dist/remote/relay/convex/group-server.js.map +1 -1
- package/dist/remote/relay/convex/index.d.ts +14 -11
- package/dist/remote/relay/convex/index.d.ts.map +1 -1
- package/dist/remote/relay/convex/index.js +9 -7
- package/dist/remote/relay/convex/index.js.map +1 -1
- package/dist/remote/relay/convex/relay.d.ts +67 -80
- package/dist/remote/relay/convex/relay.d.ts.map +1 -1
- package/dist/remote/relay/convex/relay.js +143 -59
- 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 +7 -7
- package/dist/remote/relay/index.d.ts.map +1 -1
- package/dist/remote/relay/index.js +7 -7
- package/dist/remote/relay/index.js.map +1 -1
- package/dist/remote/relay/{mock → memory}/adapter.d.ts +55 -31
- package/dist/remote/relay/memory/adapter.d.ts.map +1 -0
- package/dist/remote/relay/{mock → memory}/adapter.js +276 -135
- package/dist/remote/relay/memory/adapter.js.map +1 -0
- package/dist/remote/relay/memory/failures.d.ts +58 -0
- package/dist/remote/relay/memory/failures.d.ts.map +1 -0
- package/dist/remote/relay/memory/failures.js +123 -0
- package/dist/remote/relay/memory/failures.js.map +1 -0
- package/dist/remote/relay/memory/group-server.d.ts +9 -0
- package/dist/remote/relay/memory/group-server.d.ts.map +1 -0
- package/dist/remote/relay/memory/group-server.js +9 -0
- package/dist/remote/relay/memory/group-server.js.map +1 -0
- package/dist/remote/relay/memory/index.d.ts +11 -0
- package/dist/remote/relay/memory/index.d.ts.map +1 -0
- package/dist/remote/relay/memory/index.js +7 -0
- package/dist/remote/relay/memory/index.js.map +1 -0
- package/dist/remote/relay/types.d.ts +99 -86
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/remote/relay/types.js +2 -3
- package/dist/remote/relay/types.js.map +1 -1
- package/dist/safety/protobuf.d.ts +1 -1
- package/dist/safety/protobuf.d.ts.map +1 -1
- package/dist/types/api.d.ts +42 -17
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/errors.d.ts +2 -2
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/errors.js +2 -2
- package/dist/types/errors.js.map +1 -1
- package/dist/types/messages.d.ts +1 -1
- package/dist/types/protocol-config.d.ts +71 -4
- package/dist/types/protocol-config.d.ts.map +1 -1
- package/dist/types/protocol-config.js +63 -2
- package/dist/types/protocol-config.js.map +1 -1
- package/dist/types/protocol-constants.d.ts +1 -1
- package/dist/types/protocol-constants.js +1 -1
- package/dist/utils/binary-transfer.d.ts +1 -1
- package/dist/utils/errors.d.ts +2 -2
- package/dist/utils/errors.js +2 -2
- package/dist/utils/retry.d.ts +4 -3
- package/dist/utils/retry.d.ts.map +1 -1
- package/dist/utils/retry.js +20 -1
- package/dist/utils/retry.js.map +1 -1
- package/dist/zk/groups.d.ts +1 -1
- package/dist/zk/groups.js +1 -1
- package/docs/ASSURANCE.md +28 -11
- package/docs/CLIENT_COMPOSITION.md +32 -76
- package/docs/DEVIATIONS.md +944 -0
- package/docs/E2EE.md +71 -6
- package/docs/ERROR_HANDLING.md +8 -1
- package/docs/GETTING_STARTED.md +22 -18
- package/docs/INTERFACES.md +22 -22
- package/docs/PACKAGE_SURFACE.md +23 -16
- package/docs/PROTOCOL_POLICY.md +11 -2
- package/docs/RECIPES.md +17 -13
- package/docs/SECURITY.md +8 -0
- package/files/README.md +1 -1
- package/groups/README.md +16 -5
- package/local/store/README.md +14 -12
- package/local/store/expo/README.md +15 -6
- package/local/store/memory/README.md +58 -0
- package/local/store/node/README.md +8 -1
- package/local/store/react-native/README.md +1 -1
- package/local/store/web/README.md +1 -1
- package/local/vault/README.md +3 -3
- package/package.json +33 -13
- package/remote/README.md +19 -19
- package/remote/object-store/README.md +3 -3
- package/remote/object-store/convex-r2/README.md +1 -1
- package/remote/object-store/s3/README.md +1 -1
- package/remote/relay/README.md +7 -7
- package/remote/relay/convex/README.md +10 -4
- package/remote/relay/convex/component/README.md +428 -0
- package/remote/relay/memory/README.md +69 -0
- package/scripts/oe-groups.mjs +162 -0
- package/types/README.md +1 -1
- package/dist/internal/groups-v2/access-control.d.ts +0 -101
- package/dist/internal/groups-v2/access-control.d.ts.map +0 -1
- package/dist/internal/groups-v2/access-control.js +0 -184
- package/dist/internal/groups-v2/access-control.js.map +0 -1
- package/dist/internal/groups-v2/change-actions.d.ts +0 -35
- package/dist/internal/groups-v2/change-actions.d.ts.map +0 -1
- package/dist/internal/groups-v2/change-actions.js +0 -358
- 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 -14
- 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 -1093
- 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/dist/local/store/mock/adapter.d.ts.map +0 -1
- package/dist/local/store/mock/adapter.js.map +0 -1
- package/dist/local/store/mock/index.d.ts +0 -10
- package/dist/local/store/mock/index.d.ts.map +0 -1
- package/dist/local/store/mock/index.js +0 -6
- package/dist/local/store/mock/index.js.map +0 -1
- package/dist/remote/relay/mock/adapter.d.ts.map +0 -1
- package/dist/remote/relay/mock/adapter.js.map +0 -1
- package/dist/remote/relay/mock/index.d.ts +0 -10
- package/dist/remote/relay/mock/index.d.ts.map +0 -1
- package/dist/remote/relay/mock/index.js +0 -6
- package/dist/remote/relay/mock/index.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/SignalBlockingManager.md +0 -106
- package/docs/api/classes/SignalProtocolClient.md +0 -2651
- 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/createDefaultSignalContentAdapter.md +0 -13
- package/docs/api/functions/createDefaultSignalLogger.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/resolveSignalLogger.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 -132
- 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 -111
- 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/ISignalLocalSecretVault.md +0 -71
- package/docs/api/interfaces/ISignalLocalStore.md +0 -2053
- package/docs/api/interfaces/ISignalProtocolClient.md +0 -1183
- package/docs/api/interfaces/ISignalProtocolManager.md +0 -272
- package/docs/api/interfaces/ISignalRelayServer.md +0 -1329
- package/docs/api/interfaces/IdentityKeyPair.md +0 -49
- package/docs/api/interfaces/IncomingEnvelope.md +0 -91
- package/docs/api/interfaces/InspectedSignalContent.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 -87
- 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/SignalBlockingHooks.md +0 -44
- package/docs/api/interfaces/SignalBlockingManagerOptions.md +0 -31
- package/docs/api/interfaces/SignalBlockingMirror.md +0 -30
- package/docs/api/interfaces/SignalBlockingStore.md +0 -83
- package/docs/api/interfaces/SignalContentAdapter.md +0 -325
- 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/SignalRemoteObjectStore.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 -126
- 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/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/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/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/defaultSignalLogger.md +0 -32
- package/local/store/mock/README.md +0 -27
- package/remote/relay/mock/README.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
package/local/store/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Storage Guide
|
|
2
2
|
|
|
3
|
-
> Infrastructure | Implements `
|
|
3
|
+
> Infrastructure | Implements `ISignalProtocolLocalStore` | [Architecture](../../ARCHITECTURE.md)
|
|
4
4
|
|
|
5
5
|
The storage layer owns device-local Signal Protocol state: identity keys,
|
|
6
6
|
contact trust, prekeys, sessions, and retry/message-record metadata.
|
|
@@ -8,26 +8,26 @@ contact trust, prekeys, sessions, and retry/message-record metadata.
|
|
|
8
8
|
## Why it exists
|
|
9
9
|
|
|
10
10
|
Protocol state must survive restarts and several security transitions must
|
|
11
|
-
commit atomically. `
|
|
11
|
+
commit atomically. `ISignalProtocolLocalStore` makes those requirements explicit
|
|
12
12
|
without coupling the client to a database or platform.
|
|
13
13
|
|
|
14
14
|
## Current Support
|
|
15
15
|
|
|
16
16
|
### Primary supported adapter
|
|
17
17
|
|
|
18
|
-
- `
|
|
18
|
+
- `ExpoSignalProtocolStore` from `@open-e2ee/signal-protocol-sdk/local/store/expo`
|
|
19
19
|
- Expo integration helpers from `@open-e2ee/signal-protocol-sdk/local/store/expo`, including
|
|
20
20
|
`getKeyStorage`, `getDatabaseKeyManager`, `clearDatabaseKeyCache`, and
|
|
21
21
|
`createPreKeyMaintenanceStore`
|
|
22
22
|
|
|
23
23
|
### Local development
|
|
24
24
|
|
|
25
|
-
- `
|
|
25
|
+
- `InMemorySignalProtocolStore` from `@open-e2ee/signal-protocol-sdk/local/store/memory`
|
|
26
26
|
|
|
27
27
|
### Experimental
|
|
28
28
|
|
|
29
|
-
- `
|
|
30
|
-
- `
|
|
29
|
+
- `IndexedDbSignalProtocolStore` from `@open-e2ee/signal-protocol-sdk/local/store/web`
|
|
30
|
+
- `ReactNativeSignalProtocolStore` from `@open-e2ee/signal-protocol-sdk/local/store/react-native` (create it with `await ReactNativeSignalProtocolStore.create({ storage })` and provide your own key-value backend)
|
|
31
31
|
|
|
32
32
|
These experimental adapters implement the full core store contract, including
|
|
33
33
|
SESAME records, sender-key state, retry message records, and recovery helpers.
|
|
@@ -36,19 +36,21 @@ operational behavior require further deployment evidence.
|
|
|
36
36
|
|
|
37
37
|
### Node
|
|
38
38
|
|
|
39
|
-
- `
|
|
39
|
+
- `NodeSignalProtocolStore` from `@open-e2ee/signal-protocol-sdk/local/store/node`
|
|
40
40
|
|
|
41
|
-
Use this for non-mobile environments that need a filesystem-backed store.
|
|
41
|
+
Use this for non-mobile environments that need a filesystem-backed store. It
|
|
42
|
+
implements the full core store contract, including SESAME records, sender-key
|
|
43
|
+
state, retry message records, and recovery helpers.
|
|
42
44
|
|
|
43
45
|
## Composition
|
|
44
46
|
|
|
45
47
|
```ts
|
|
46
48
|
import { SignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
|
|
47
|
-
import {
|
|
49
|
+
import { ExpoSignalProtocolStore } from '@open-e2ee/signal-protocol-sdk/local/store/expo';
|
|
48
50
|
|
|
49
51
|
// Configure the application-owned Expo/SQLCipher database bindings first.
|
|
50
52
|
const signal = await SignalProtocolClient.create(userId, {
|
|
51
|
-
storage: new
|
|
53
|
+
storage: new ExpoSignalProtocolStore(),
|
|
52
54
|
});
|
|
53
55
|
```
|
|
54
56
|
|
|
@@ -56,7 +58,7 @@ The [Expo guide](./expo/README.md) shows the required database bootstrap.
|
|
|
56
58
|
|
|
57
59
|
## Storage Responsibilities
|
|
58
60
|
|
|
59
|
-
An `
|
|
61
|
+
An `ISignalProtocolLocalStore` implementation must preserve:
|
|
60
62
|
|
|
61
63
|
- account identity key storage
|
|
62
64
|
- contact identity trust / TOFU decisions
|
|
@@ -117,4 +119,4 @@ can leave a concurrently-created session trusted under a rotated identity.
|
|
|
117
119
|
- [Node adapter](./node/README.md)
|
|
118
120
|
- [Bare React Native adapter](./react-native/README.md)
|
|
119
121
|
- [Web adapter](./web/README.md)
|
|
120
|
-
- [
|
|
122
|
+
- [In-memory adapter](./memory/README.md)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Expo Store
|
|
2
2
|
|
|
3
|
-
`
|
|
3
|
+
`ExpoSignalProtocolStore` implements `ISignalProtocolLocalStore` for Expo and React Native with
|
|
4
4
|
an application-owned SQLite/Drizzle database and a database key held through
|
|
5
5
|
the local secret-vault boundary.
|
|
6
6
|
|
|
@@ -20,7 +20,7 @@ the first query:
|
|
|
20
20
|
|
|
21
21
|
```ts
|
|
22
22
|
import {
|
|
23
|
-
|
|
23
|
+
configureSignalProtocolExpoDbBindings,
|
|
24
24
|
} from "@open-e2ee/signal-protocol-sdk/local/store/expo/db";
|
|
25
25
|
import {
|
|
26
26
|
getDatabaseKeyManager,
|
|
@@ -32,23 +32,32 @@ await keyManager.initialize();
|
|
|
32
32
|
const sqlCipherPassword = await keyManager.getPassword();
|
|
33
33
|
|
|
34
34
|
const { rawDatabase, drizzleDatabase } =
|
|
35
|
-
await appDatabase.
|
|
35
|
+
await appDatabase.openEncryptedSignalProtocolDatabase({
|
|
36
36
|
password: sqlCipherPassword,
|
|
37
37
|
schema: signalSchema,
|
|
38
38
|
});
|
|
39
39
|
|
|
40
|
-
|
|
40
|
+
configureSignalProtocolExpoDbBindings({
|
|
41
41
|
getDrizzle: async () => drizzleDatabase,
|
|
42
42
|
getRawDatabase: () => rawDatabase,
|
|
43
43
|
});
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
`appDatabase.
|
|
46
|
+
`appDatabase.openEncryptedSignalProtocolDatabase` represents application-owned database
|
|
47
47
|
bootstrap. It must enable SQLCipher through the `expo-sqlite` native
|
|
48
48
|
configuration, apply the supplied key before schema access, create or migrate
|
|
49
49
|
the exported tables, and return the matching raw and Drizzle handles. SQLCipher
|
|
50
50
|
requires a development build and is not available in Expo Go.
|
|
51
51
|
|
|
52
|
+
Every table this store exports holds material that must not leave the device.
|
|
53
|
+
That includes the group `sender_keys` and `skipped_sender_keys` tables, whose
|
|
54
|
+
rows contain the sender chain key, the sender's private signature key, and
|
|
55
|
+
individual message keys — enough to read and to forge a sender's group
|
|
56
|
+
messages. They are stored unencrypted at the row level because SQLCipher
|
|
57
|
+
encrypts the database file itself, so the database key is the only thing that
|
|
58
|
+
protects them. Do not back these tables up to a server or sync them between
|
|
59
|
+
devices.
|
|
60
|
+
|
|
52
61
|
## Client usage
|
|
53
62
|
|
|
54
63
|
```ts
|
|
@@ -58,7 +67,7 @@ import { expoStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
|
|
|
58
67
|
const client = await createSignalProtocolClient({
|
|
59
68
|
identity: { userId },
|
|
60
69
|
adapters: {
|
|
61
|
-
storage: expoStore(
|
|
70
|
+
storage: expoStore(),
|
|
62
71
|
relay,
|
|
63
72
|
},
|
|
64
73
|
});
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# In-Memory Store
|
|
2
|
+
|
|
3
|
+
`InMemorySignalProtocolStore` implements `ISignalProtocolLocalStore` in memory for examples, local
|
|
4
|
+
development, and deterministic application prototypes.
|
|
5
|
+
|
|
6
|
+
Real protocol and cryptography; simulated in-memory infrastructure.
|
|
7
|
+
|
|
8
|
+
## Why it exists
|
|
9
|
+
|
|
10
|
+
It lets developers exercise client composition without choosing a durable
|
|
11
|
+
platform database first. It is intentionally a development adapter, not a
|
|
12
|
+
security or persistence boundary.
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
```ts
|
|
17
|
+
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
18
|
+
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
19
|
+
import { inMemoryStore } from "@open-e2ee/signal-protocol-sdk/local/store/memory";
|
|
20
|
+
|
|
21
|
+
const client = await createSignalProtocolClient({
|
|
22
|
+
identity: { userId: "alice" },
|
|
23
|
+
adapters: { storage: inMemoryStore() },
|
|
24
|
+
});
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
All keys, sessions, and trust decisions disappear when the process or adapter
|
|
28
|
+
is discarded. Never use this adapter for production accounts.
|
|
29
|
+
|
|
30
|
+
## Deterministic storage failures
|
|
31
|
+
|
|
32
|
+
Failure mode is opt-in. A seed and cadence replay the same failing writes, or
|
|
33
|
+
you can target the next named store operation:
|
|
34
|
+
|
|
35
|
+
```ts
|
|
36
|
+
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
37
|
+
import {
|
|
38
|
+
inMemoryStore,
|
|
39
|
+
InjectedStorageWriteError,
|
|
40
|
+
} from "@open-e2ee/signal-protocol-sdk/local/store/memory";
|
|
41
|
+
|
|
42
|
+
const storage = inMemoryStore({ failures: { seed: 7 } });
|
|
43
|
+
storage.failures.failNextWrite("setMetadata");
|
|
44
|
+
|
|
45
|
+
try {
|
|
46
|
+
await storage.setMetadata("draft", "encrypted-pointer");
|
|
47
|
+
} catch (error) {
|
|
48
|
+
if (error instanceof InjectedStorageWriteError) {
|
|
49
|
+
// The explicitly injected failure is consumed, so this retry succeeds.
|
|
50
|
+
await storage.setMetadata("draft", "encrypted-pointer");
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Use `writeFailureEvery` for a repeatable cadence. Failure selection uses the
|
|
56
|
+
configured seed and operation count, never `Math.random()` or wall-clock time.
|
|
57
|
+
|
|
58
|
+
See the parent [storage guide](../README.md).
|
|
@@ -1,8 +1,15 @@
|
|
|
1
1
|
# Node Store
|
|
2
2
|
|
|
3
|
-
`
|
|
3
|
+
`NodeSignalProtocolStore` provides Node.js protocol storage using encrypted,
|
|
4
4
|
crash-durable filesystem state.
|
|
5
5
|
|
|
6
|
+
It implements all of `ISignalProtocolLocalStore` — identity, prekeys, sessions,
|
|
7
|
+
Kyber prekeys, Sesame device records, sender keys, and message records — so
|
|
8
|
+
multi-device and group flows work in Node without a custom adapter. The class
|
|
9
|
+
declares `implements ISignalProtocolLocalStore`, so the compiler rejects any
|
|
10
|
+
build in which a member is missing or its signature drifts; that check is the
|
|
11
|
+
guarantee behind this paragraph, not a manual audit.
|
|
12
|
+
|
|
6
13
|
## Why it exists
|
|
7
14
|
|
|
8
15
|
Servers, command-line tools, and desktop processes may need persistent protocol
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Bare React Native Store
|
|
2
2
|
|
|
3
|
-
`
|
|
3
|
+
`ReactNativeSignalProtocolStore` implements `ISignalProtocolLocalStore` for bare React Native
|
|
4
4
|
through an application-provided persistent key-value backend.
|
|
5
5
|
|
|
6
6
|
## Why it exists
|
package/local/vault/README.md
CHANGED
|
@@ -7,16 +7,16 @@ The local secret vault stores small bootstrap secrets through a minimal
|
|
|
7
7
|
|
|
8
8
|
Platform secret managers are appropriate for tiny keys and bootstrap values,
|
|
9
9
|
but not full session databases. Separating the vault from
|
|
10
|
-
`
|
|
10
|
+
`ISignalProtocolLocalStore` keeps platform limits explicit and lets a local store use a
|
|
11
11
|
vault-held wrapping key without placing every protocol record in the platform
|
|
12
12
|
keychain.
|
|
13
13
|
|
|
14
14
|
## Expo usage
|
|
15
15
|
|
|
16
16
|
```ts
|
|
17
|
-
import {
|
|
17
|
+
import { ExpoSecureStoreSignalProtocolSecretVault } from "@open-e2ee/signal-protocol-sdk/local/vault/expo-secure-store";
|
|
18
18
|
|
|
19
|
-
const vault = new
|
|
19
|
+
const vault = new ExpoSecureStoreSignalProtocolSecretVault();
|
|
20
20
|
|
|
21
21
|
await vault.setSecret("signal-store-wrapping-key", wrappingKey);
|
|
22
22
|
const restored = await vault.getSecret("signal-store-wrapping-key");
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@open-e2ee/signal-protocol-sdk",
|
|
3
|
-
"version": "0.1.0-alpha.
|
|
3
|
+
"version": "0.1.0-alpha.11",
|
|
4
4
|
"description": "Signal Protocol E2EE SDK for TypeScript — Expo, React Native, browser, and Node. Post-quantum PQXDH and Double Ratchet.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"open-e2ee",
|
|
@@ -43,6 +43,9 @@
|
|
|
43
43
|
"main": "./dist/index.js",
|
|
44
44
|
"module": "./dist/index.js",
|
|
45
45
|
"types": "./dist/index.d.ts",
|
|
46
|
+
"bin": {
|
|
47
|
+
"oe-groups": "./scripts/oe-groups.mjs"
|
|
48
|
+
},
|
|
46
49
|
"exports": {
|
|
47
50
|
".": {
|
|
48
51
|
"types": "./dist/index.d.ts",
|
|
@@ -60,9 +63,13 @@
|
|
|
60
63
|
"types": "./dist/remote/relay/convex/relay.d.ts",
|
|
61
64
|
"default": "./dist/remote/relay/convex/relay.js"
|
|
62
65
|
},
|
|
63
|
-
"./
|
|
64
|
-
"types": "./dist/remote/relay/
|
|
65
|
-
"default": "./dist/remote/relay/
|
|
66
|
+
"./convex.config": {
|
|
67
|
+
"types": "./dist/remote/relay/convex/component/convex.config.d.ts",
|
|
68
|
+
"default": "./dist/remote/relay/convex/component/convex.config.js"
|
|
69
|
+
},
|
|
70
|
+
"./remote/relay/memory": {
|
|
71
|
+
"types": "./dist/remote/relay/memory/index.d.ts",
|
|
72
|
+
"default": "./dist/remote/relay/memory/index.js"
|
|
66
73
|
},
|
|
67
74
|
"./remote/relay/types": {
|
|
68
75
|
"types": "./dist/remote/relay/types.d.ts",
|
|
@@ -108,6 +115,10 @@
|
|
|
108
115
|
"types": "./dist/device/device-id.d.ts",
|
|
109
116
|
"default": "./dist/device/device-id.js"
|
|
110
117
|
},
|
|
118
|
+
"./device/expo-metadata": {
|
|
119
|
+
"types": "./dist/device/expo-metadata.d.ts",
|
|
120
|
+
"default": "./dist/device/expo-metadata.js"
|
|
121
|
+
},
|
|
111
122
|
"./device/lifecycle": {
|
|
112
123
|
"types": "./dist/device/lifecycle/index.d.ts",
|
|
113
124
|
"default": "./dist/device/lifecycle/index.js"
|
|
@@ -196,9 +207,9 @@
|
|
|
196
207
|
"types": "./dist/local/store/expo/schema.d.ts",
|
|
197
208
|
"default": "./dist/local/store/expo/schema.js"
|
|
198
209
|
},
|
|
199
|
-
"./local/store/
|
|
200
|
-
"types": "./dist/local/store/
|
|
201
|
-
"default": "./dist/local/store/
|
|
210
|
+
"./local/store/memory": {
|
|
211
|
+
"types": "./dist/local/store/memory/index.d.ts",
|
|
212
|
+
"default": "./dist/local/store/memory/index.js"
|
|
202
213
|
},
|
|
203
214
|
"./local/store/node": {
|
|
204
215
|
"types": "./dist/local/store/node/index.d.ts",
|
|
@@ -278,11 +289,12 @@
|
|
|
278
289
|
"ADAPTERS.md",
|
|
279
290
|
"ARCHITECTURE.md",
|
|
280
291
|
"CHANGELOG.md",
|
|
292
|
+
"COMMERCIAL.md",
|
|
281
293
|
"LICENSE",
|
|
282
294
|
"NOTICE",
|
|
283
|
-
"THIRD_PARTY_NOTICES.md",
|
|
284
295
|
"README.md",
|
|
285
296
|
"SECURITY.md",
|
|
297
|
+
"THIRD_PARTY_NOTICES.md",
|
|
286
298
|
"TROUBLESHOOTING.md",
|
|
287
299
|
"blocking/README.md",
|
|
288
300
|
"client/README.md",
|
|
@@ -290,6 +302,7 @@
|
|
|
290
302
|
"dist",
|
|
291
303
|
"docs/ASSURANCE.md",
|
|
292
304
|
"docs/CLIENT_COMPOSITION.md",
|
|
305
|
+
"docs/DEVIATIONS.md",
|
|
293
306
|
"docs/DOCUMENTATION_STANDARDS.md",
|
|
294
307
|
"docs/E2EE.md",
|
|
295
308
|
"docs/ERROR_HANDLING.md",
|
|
@@ -299,7 +312,6 @@
|
|
|
299
312
|
"docs/PROTOCOL_POLICY.md",
|
|
300
313
|
"docs/RECIPES.md",
|
|
301
314
|
"docs/SECURITY.md",
|
|
302
|
-
"docs/api",
|
|
303
315
|
"encoding/README.md",
|
|
304
316
|
"files/README.md",
|
|
305
317
|
"groups/README.md",
|
|
@@ -307,7 +319,7 @@
|
|
|
307
319
|
"keys/README.md",
|
|
308
320
|
"local/store/README.md",
|
|
309
321
|
"local/store/expo/README.md",
|
|
310
|
-
"local/store/
|
|
322
|
+
"local/store/memory/README.md",
|
|
311
323
|
"local/store/node/README.md",
|
|
312
324
|
"local/store/react-native/README.md",
|
|
313
325
|
"local/store/web/README.md",
|
|
@@ -320,8 +332,10 @@
|
|
|
320
332
|
"remote/object-store/s3/README.md",
|
|
321
333
|
"remote/relay/README.md",
|
|
322
334
|
"remote/relay/convex/README.md",
|
|
323
|
-
"remote/relay/
|
|
335
|
+
"remote/relay/convex/component/README.md",
|
|
336
|
+
"remote/relay/memory/README.md",
|
|
324
337
|
"safety/README.md",
|
|
338
|
+
"scripts/oe-groups.mjs",
|
|
325
339
|
"sealed-sender/README.md",
|
|
326
340
|
"types/README.md",
|
|
327
341
|
"username/README.md",
|
|
@@ -345,6 +359,7 @@
|
|
|
345
359
|
},
|
|
346
360
|
"peerDependencies": {
|
|
347
361
|
"@convex-dev/r2": "^0.10.2",
|
|
362
|
+
"@convex-dev/rate-limiter": "^0.3.2",
|
|
348
363
|
"convex": "^1.42.1",
|
|
349
364
|
"drizzle-orm": "^0.45.1",
|
|
350
365
|
"expo": "~55.0.27",
|
|
@@ -362,6 +377,9 @@
|
|
|
362
377
|
"@convex-dev/r2": {
|
|
363
378
|
"optional": true
|
|
364
379
|
},
|
|
380
|
+
"@convex-dev/rate-limiter": {
|
|
381
|
+
"optional": true
|
|
382
|
+
},
|
|
365
383
|
"convex": {
|
|
366
384
|
"optional": true
|
|
367
385
|
},
|
|
@@ -405,20 +423,22 @@
|
|
|
405
423
|
"@noble/hashes": "2.2.0",
|
|
406
424
|
"@noble/post-quantum": "^0.6.1",
|
|
407
425
|
"async-lock": "^1.4.0",
|
|
408
|
-
"protobufjs": "^8.6.5",
|
|
409
426
|
"unique-names-generator": "^4.7.1"
|
|
410
427
|
},
|
|
411
428
|
"overrides": {
|
|
412
429
|
"xcode": {
|
|
413
430
|
"uuid": "11.1.1"
|
|
414
|
-
}
|
|
431
|
+
},
|
|
432
|
+
"brace-expansion": "^5.0.8"
|
|
415
433
|
},
|
|
416
434
|
"devDependencies": {
|
|
417
435
|
"@convex-dev/r2": "^0.10.2",
|
|
436
|
+
"@convex-dev/rate-limiter": "^0.3.2",
|
|
418
437
|
"@types/async-lock": "^1.4.0",
|
|
419
438
|
"@types/node": "^22.0.0",
|
|
420
439
|
"@types/react": "^19.0.0",
|
|
421
440
|
"convex": "^1.42.3",
|
|
441
|
+
"convex-test": "^0.0.54",
|
|
422
442
|
"drizzle-orm": "^0.45.1",
|
|
423
443
|
"esbuild": "^0.27.0",
|
|
424
444
|
"expo": "~55.0.27",
|
package/remote/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Remote Guide
|
|
2
2
|
|
|
3
|
-
> Infrastructure | Implements `
|
|
3
|
+
> Infrastructure | Implements `ISignalProtocolRelayServer` and `SignalProtocolRemoteObjectStore` | [Architecture](../ARCHITECTURE.md)
|
|
4
4
|
|
|
5
5
|
The backend layer is responsible for server-owned protocol state: public
|
|
6
6
|
prekeys, device registration, encrypted-envelope delivery, and provisioning
|
|
@@ -17,32 +17,32 @@ replaceable and prevent them from owning private keys or plaintext.
|
|
|
17
17
|
|
|
18
18
|
### Relay
|
|
19
19
|
|
|
20
|
-
- `
|
|
21
|
-
- `
|
|
22
|
-
- custom implementations via `
|
|
20
|
+
- `ConvexSignalProtocolRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/convex`
|
|
21
|
+
- `InMemorySignalProtocolRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/memory`
|
|
22
|
+
- custom implementations via `ISignalProtocolRelayServer`
|
|
23
23
|
|
|
24
24
|
### Remote object storage
|
|
25
25
|
|
|
26
26
|
- `ConvexR2ObjectStore` from `@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2`
|
|
27
27
|
- `S3ObjectStore` from `@open-e2ee/signal-protocol-sdk/remote/object-store/s3`
|
|
28
|
-
- custom implementations via `
|
|
28
|
+
- custom implementations via `SignalProtocolRemoteObjectStore`
|
|
29
29
|
|
|
30
30
|
## Composition
|
|
31
31
|
|
|
32
32
|
```ts
|
|
33
33
|
import { SignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
34
34
|
import {
|
|
35
|
-
|
|
36
|
-
type
|
|
35
|
+
ConvexSignalProtocolRelayServer,
|
|
36
|
+
type ConvexSignalProtocolRelayApi,
|
|
37
37
|
} from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
|
|
38
|
-
import {
|
|
38
|
+
import { ExpoSignalProtocolStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
|
|
39
39
|
import { api } from "../convex/_generated/api";
|
|
40
40
|
|
|
41
|
-
const signalApi = api.signal satisfies
|
|
41
|
+
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
42
42
|
|
|
43
43
|
const signal = await SignalProtocolClient.create(userId, {
|
|
44
|
-
storage: new
|
|
45
|
-
relay: new
|
|
44
|
+
storage: new ExpoSignalProtocolStore(),
|
|
45
|
+
relay: new ConvexSignalProtocolRelayServer(convex, signalApi, {
|
|
46
46
|
currentUserId: userId,
|
|
47
47
|
}),
|
|
48
48
|
});
|
|
@@ -50,7 +50,7 @@ const signal = await SignalProtocolClient.create(userId, {
|
|
|
50
50
|
|
|
51
51
|
## Relay Responsibilities
|
|
52
52
|
|
|
53
|
-
An `
|
|
53
|
+
An `ISignalProtocolRelayServer` implementation must preserve the package’s protocol semantics for:
|
|
54
54
|
|
|
55
55
|
- identity and prekey upload
|
|
56
56
|
- prekey bundle fetch
|
|
@@ -78,7 +78,7 @@ Bundle fetch must preserve one-time-prekey consumption semantics for concurrent
|
|
|
78
78
|
|
|
79
79
|
## Remote Object Storage
|
|
80
80
|
|
|
81
|
-
`
|
|
81
|
+
`SignalProtocolRemoteObjectStore` is optional and only needed for encrypted attachment/file flows.
|
|
82
82
|
|
|
83
83
|
In practice, attachment and encrypted file support is a common consumer path,
|
|
84
84
|
so object-store adapters should be treated as first-class integrations
|
|
@@ -190,22 +190,22 @@ needed to authorize and construct short-lived operations.
|
|
|
190
190
|
|
|
191
191
|
## Local development
|
|
192
192
|
|
|
193
|
-
Use `
|
|
193
|
+
Use `InMemorySignalProtocolRelayServer` when multiple clients need a shared in-memory relay:
|
|
194
194
|
|
|
195
195
|
```ts
|
|
196
196
|
import { SignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
197
|
-
import {
|
|
198
|
-
import {
|
|
197
|
+
import { InMemorySignalProtocolRelayServer } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
|
|
198
|
+
import { InMemorySignalProtocolStore } from "@open-e2ee/signal-protocol-sdk/local/store/memory";
|
|
199
199
|
|
|
200
|
-
const relay = new
|
|
200
|
+
const relay = new InMemorySignalProtocolRelayServer();
|
|
201
201
|
|
|
202
202
|
const alice = await SignalProtocolClient.create("alice", {
|
|
203
|
-
storage: new
|
|
203
|
+
storage: new InMemorySignalProtocolStore(),
|
|
204
204
|
relay,
|
|
205
205
|
});
|
|
206
206
|
|
|
207
207
|
const bob = await SignalProtocolClient.create("bob", {
|
|
208
|
-
storage: new
|
|
208
|
+
storage: new InMemorySignalProtocolStore(),
|
|
209
209
|
relay,
|
|
210
210
|
});
|
|
211
211
|
```
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Remote Object Store
|
|
2
2
|
|
|
3
|
-
`
|
|
3
|
+
`SignalProtocolRemoteObjectStore` is the provider-neutral client contract for uploading,
|
|
4
4
|
downloading, completing, and deleting encrypted byte objects through
|
|
5
5
|
short-lived backend-brokered operations.
|
|
6
6
|
|
|
@@ -20,10 +20,10 @@ retry-stable requestId -> canonical objectId -> private provider key
|
|
|
20
20
|
|
|
21
21
|
```ts
|
|
22
22
|
import type {
|
|
23
|
-
|
|
23
|
+
SignalProtocolRemoteObjectStore,
|
|
24
24
|
} from "@open-e2ee/signal-protocol-sdk/remote/object-store";
|
|
25
25
|
|
|
26
|
-
const remoteObjectStore:
|
|
26
|
+
const remoteObjectStore: SignalProtocolRemoteObjectStore = {
|
|
27
27
|
createUpload: (request) => appStorageApi.createUpload(request),
|
|
28
28
|
createDownload: (request) => appStorageApi.createDownload(request),
|
|
29
29
|
completeUpload: (request) => appStorageApi.completeUpload(request),
|
|
@@ -8,7 +8,7 @@ application's bucket, credentials, schema, authorization, or metadata model.
|
|
|
8
8
|
|
|
9
9
|
The Convex client calls generated function references, while `@convex-dev/r2`
|
|
10
10
|
operates inside the application backend. This adapter maps that generated API
|
|
11
|
-
to `
|
|
11
|
+
to `SignalProtocolRemoteObjectStore` without moving storage policy, provider keys, or
|
|
12
12
|
component ownership into the SDK.
|
|
13
13
|
|
|
14
14
|
## Client usage
|
package/remote/relay/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Relay
|
|
2
2
|
|
|
3
|
-
The relay module defines `
|
|
3
|
+
The relay module defines `ISignalProtocolRelayServer`, the application-backend contract
|
|
4
4
|
for device discovery, public prekeys, encrypted envelopes, key rotation,
|
|
5
5
|
provisioning, and related synchronization.
|
|
6
6
|
|
|
@@ -15,24 +15,24 @@ plaintext ownership to the backend.
|
|
|
15
15
|
|
|
16
16
|
```ts
|
|
17
17
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
18
|
-
import {
|
|
19
|
-
import {
|
|
18
|
+
import { inMemoryStore } from "@open-e2ee/signal-protocol-sdk/local/store/memory";
|
|
19
|
+
import { inMemoryRelay } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
|
|
20
20
|
|
|
21
|
-
const relay =
|
|
21
|
+
const relay = inMemoryRelay();
|
|
22
22
|
|
|
23
23
|
const client = await createSignalProtocolClient({
|
|
24
24
|
identity: { userId: "alice" },
|
|
25
|
-
adapters: { storage:
|
|
25
|
+
adapters: { storage: inMemoryStore(), relay },
|
|
26
26
|
});
|
|
27
27
|
|
|
28
28
|
await client.syncToServer();
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
For production, implement `
|
|
31
|
+
For production, implement `ISignalProtocolRelayServer` or use the
|
|
32
32
|
[Convex adapter](./convex/README.md). The application backend must authenticate
|
|
33
33
|
mutations, allocate linked-device IDs, consume one-time prekeys atomically,
|
|
34
34
|
enforce access policy, and store only encrypted envelopes plus required routing
|
|
35
35
|
metadata.
|
|
36
36
|
|
|
37
37
|
See the [remote guide](../README.md), [interface guide](../../docs/INTERFACES.md),
|
|
38
|
-
[
|
|
38
|
+
[in-memory relay guide](./memory/README.md), and [API reference](../../docs/api/README.md).
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Convex Relay Adapter
|
|
2
2
|
|
|
3
3
|
The Convex relay adapter maps an application-owned generated Convex API module
|
|
4
|
-
to `
|
|
4
|
+
to `ISignalProtocolRelayServer`.
|
|
5
5
|
|
|
6
6
|
## Why it exists
|
|
7
7
|
|
|
@@ -24,11 +24,11 @@ pass that namespace directly:
|
|
|
24
24
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
25
25
|
import {
|
|
26
26
|
convexRelay,
|
|
27
|
-
type
|
|
27
|
+
type ConvexSignalProtocolRelayApi,
|
|
28
28
|
} from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
|
|
29
29
|
import { api } from "../convex/_generated/api";
|
|
30
30
|
|
|
31
|
-
const signalApi = api.signal satisfies
|
|
31
|
+
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
32
32
|
|
|
33
33
|
const relay = convexRelay({
|
|
34
34
|
convex,
|
|
@@ -43,9 +43,15 @@ const client = await createSignalProtocolClient({
|
|
|
43
43
|
```
|
|
44
44
|
|
|
45
45
|
The generated `api.signal` namespace must expose the nested functions described
|
|
46
|
-
by `
|
|
46
|
+
by `ConvexSignalProtocolRelayApi`. Use `satisfies` to get a compile-time diagnostic
|
|
47
47
|
without widening the generated references.
|
|
48
48
|
|
|
49
|
+
To serve groups from this deployment, also mount the
|
|
50
|
+
[Convex Signal Protocol component](./component/README.md) inside the same namespace
|
|
51
|
+
(`convex/signal/groups.ts` and `convex/signal/zkAuth.ts`); the relay
|
|
52
|
+
advertises its `groupServer` capability only when both modules are
|
|
53
|
+
configured.
|
|
54
|
+
|
|
49
55
|
Public-key reads may be available to authenticated peers, but every write must
|
|
50
56
|
derive ownership from server-side authentication rather than trusting a
|
|
51
57
|
client-supplied user ID.
|