@open-e2ee/signal-protocol-sdk 0.1.0-alpha.5 → 0.1.0-alpha.7
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 +15 -15
- package/ARCHITECTURE.md +1 -1
- package/CHANGELOG.md +252 -2
- package/README.md +1 -1
- package/blocking/README.md +5 -5
- package/client/README.md +2 -2
- 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 +3 -3
- package/dist/blocking/types.d.ts.map +1 -1
- package/dist/client/client.d.ts +32 -28
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +127 -79
- package/dist/client/client.js.map +1 -1
- package/dist/client/compose.d.ts +12 -7
- 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 +54 -30
- 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 +4 -0
- package/dist/client/endorsement-manager.d.ts.map +1 -1
- package/dist/client/endorsement-manager.js +11 -2
- package/dist/client/endorsement-manager.js.map +1 -1
- package/dist/client/groups.d.ts +29 -29
- package/dist/client/groups.d.ts.map +1 -1
- package/dist/client/groups.js +54 -37
- package/dist/client/groups.js.map +1 -1
- package/dist/client/headless.d.ts +9 -9
- package/dist/client/headless.d.ts.map +1 -1
- package/dist/client/headless.js +6 -6
- package/dist/client/headless.js.map +1 -1
- package/dist/client/index.d.ts +2 -2
- 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 +7 -7
- package/dist/client/key-rotation-core.d.ts.map +1 -1
- package/dist/client/key-rotation-core.js +11 -11
- package/dist/client/key-rotation-core.js.map +1 -1
- package/dist/client/media.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 +1 -1
- package/dist/client/relay-subscription.js.map +1 -1
- package/dist/client/retry.js.map +1 -1
- package/dist/client/sealed-sender-ops.d.ts +1 -1
- package/dist/client/sealed-sender-ops.d.ts.map +1 -1
- package/dist/client/sealed-sender-ops.js +3 -3
- package/dist/client/sealed-sender-ops.js.map +1 -1
- package/dist/client/signal-service-cipher.d.ts +15 -11
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +24 -15
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/types.d.ts +8 -8
- package/dist/client/types.d.ts.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/provisioning.d.ts +2 -2
- package/dist/device/provisioning.d.ts.map +1 -1
- package/dist/device/provisioning.js +7 -7
- 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 +3 -3
- package/dist/hooks/use-connection-presence.d.ts.map +1 -1
- package/dist/hooks/use-connection-presence.js +4 -4
- package/dist/hooks/use-connection-presence.js.map +1 -1
- package/dist/hooks/use-key-rotation.js +2 -2
- package/dist/hooks/use-key-rotation.js.map +1 -1
- package/dist/index.d.ts +15 -15
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +6 -6
- 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/symmetric/mac.d.ts +3 -3
- package/dist/internal/crypto/symmetric/mac.js +3 -3
- 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 +2 -2
- package/dist/internal/encoding/proto/index.js.map +1 -1
- package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts +3 -3
- package/dist/internal/encoding/proto/pq-ratchet-serialize.js +2 -2
- package/dist/internal/encoding/proto/signal-message.d.ts +33 -33
- package/dist/internal/encoding/proto/signal-message.d.ts.map +1 -1
- package/dist/internal/encoding/proto/signal-message.js +58 -58
- 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 +175 -40
- package/dist/internal/groups/manager.d.ts.map +1 -0
- package/dist/internal/groups/manager.js +1862 -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 +52 -0
- package/dist/internal/groups/server-engine.d.ts.map +1 -0
- package/dist/internal/groups/server-engine.js +1126 -0
- package/dist/internal/groups/server-engine.js.map +1 -0
- package/dist/internal/groups/trust-root.d.ts +32 -0
- package/dist/internal/groups/trust-root.d.ts.map +1 -0
- package/dist/internal/groups/trust-root.js +91 -0
- package/dist/internal/groups/trust-root.js.map +1 -0
- package/dist/internal/{groups-v2 → groups}/types.d.ts +188 -46
- package/dist/internal/groups/types.d.ts.map +1 -0
- package/dist/internal/{groups-v2 → groups}/types.js +3 -2
- package/dist/internal/groups/types.js.map +1 -0
- package/dist/internal/groups/wire.d.ts +68 -0
- package/dist/internal/groups/wire.d.ts.map +1 -0
- package/dist/internal/groups/wire.js +708 -0
- package/dist/internal/groups/wire.js.map +1 -0
- package/dist/internal/manager/manager.d.ts +3 -3
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +3 -3
- package/dist/internal/manager/manager.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.js +9 -9
- package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts +2 -2
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.js +2 -2
- 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/sender-keys/index.d.ts +1 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts +3 -3
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +3 -3
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.js +5 -5
- package/dist/internal/protocol/spqr/spqr.js.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +2 -2
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.js +4 -4
- package/dist/internal/protocol/triple-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
- package/dist/internal/protocol/x3dh/x3dh.js +3 -3
- package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
- package/dist/internal/protocol/zk/groups/auth-credential.d.ts +9 -7
- package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/auth-credential.js +68 -29
- package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
- package/dist/internal/protocol/zk/groups/server-params.d.ts +1 -1
- package/dist/internal/protocol/zk/groups/server-params.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/server-params.js.map +1 -1
- package/dist/internal/protocol/zk/groups/uid-struct.d.ts +2 -0
- package/dist/internal/protocol/zk/groups/uid-struct.d.ts.map +1 -1
- package/dist/internal/protocol/zk/groups/uid-struct.js +4 -0
- package/dist/internal/protocol/zk/groups/uid-struct.js.map +1 -1
- package/dist/internal/sesame/device-registry.d.ts +7 -7
- package/dist/internal/sesame/device-registry.d.ts.map +1 -1
- package/dist/internal/sesame/device-registry.js +2 -2
- 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 +15 -15
- package/dist/internal/sesame/manager.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 +30 -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/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/layers.d.ts +3 -3
- package/dist/layers.d.ts.map +1 -1
- package/dist/layers.js +7 -7
- package/dist/layers.js.map +1 -1
- package/dist/local/store/expo/adapter.d.ts +8 -8
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +7 -7
- 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 +9 -9
- package/dist/local/store/expo/db.d.ts.map +1 -1
- package/dist/local/store/expo/db.js +2 -2
- package/dist/local/store/expo/db.js.map +1 -1
- package/dist/local/store/expo/index.d.ts +6 -6
- 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/secure-store-options.d.ts +1 -1
- 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 +8 -8
- package/dist/local/store/index.js.map +1 -1
- package/dist/local/store/mock/adapter.d.ts +6 -6
- package/dist/local/store/mock/adapter.d.ts.map +1 -1
- package/dist/local/store/mock/adapter.js +2 -2
- package/dist/local/store/mock/adapter.js.map +1 -1
- package/dist/local/store/mock/index.d.ts +3 -3
- package/dist/local/store/mock/index.d.ts.map +1 -1
- package/dist/local/store/mock/index.js +3 -3
- package/dist/local/store/mock/index.js.map +1 -1
- package/dist/local/store/node/adapter.d.ts +4 -4
- package/dist/local/store/node/adapter.d.ts.map +1 -1
- package/dist/local/store/node/adapter.js +2 -2
- package/dist/local/store/node/adapter.js.map +1 -1
- package/dist/local/store/node/database.d.ts.map +1 -1
- package/dist/local/store/node/database.js +2 -2
- 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 +5 -5
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +12 -12
- 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 +1 -1
- package/dist/local/store/web/adapter.d.ts +4 -4
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +7 -7
- 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 +2 -2
- 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 +3 -3
- package/dist/logger.d.ts.map +1 -1
- package/dist/logger.js +4 -4
- package/dist/logger.js.map +1 -1
- package/dist/media/index.d.ts +5 -5
- package/dist/media/index.d.ts.map +1 -1
- package/dist/profile/contact-state.d.ts.map +1 -1
- package/dist/profile/contact-state.js +2 -2
- package/dist/profile/contact-state.js.map +1 -1
- package/dist/profile/profile-key.d.ts.map +1 -1
- package/dist/profile/profile-key.js +2 -2
- package/dist/profile/profile-key.js.map +1 -1
- 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/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/group-server.d.ts +23 -21
- package/dist/remote/relay/convex/group-server.d.ts.map +1 -1
- package/dist/remote/relay/convex/group-server.js +49 -21
- package/dist/remote/relay/convex/group-server.js.map +1 -1
- package/dist/remote/relay/convex/index.d.ts +9 -9
- package/dist/remote/relay/convex/index.d.ts.map +1 -1
- package/dist/remote/relay/convex/index.js +5 -5
- package/dist/remote/relay/convex/index.js.map +1 -1
- package/dist/remote/relay/convex/relay.d.ts +26 -18
- package/dist/remote/relay/convex/relay.d.ts.map +1 -1
- package/dist/remote/relay/convex/relay.js +82 -23
- package/dist/remote/relay/convex/relay.js.map +1 -1
- package/dist/remote/relay/convex/server/index.d.ts +2 -0
- package/dist/remote/relay/convex/server/index.d.ts.map +1 -0
- package/dist/remote/relay/convex/server/index.js +2 -0
- package/dist/remote/relay/convex/server/index.js.map +1 -0
- package/dist/remote/relay/convex/server.d.ts +150 -0
- package/dist/remote/relay/convex/server.d.ts.map +1 -0
- package/dist/remote/relay/convex/server.js +506 -0
- package/dist/remote/relay/convex/server.js.map +1 -0
- 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 +6 -6
- package/dist/remote/relay/index.js.map +1 -1
- package/dist/remote/relay/mock/adapter.d.ts +36 -18
- package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
- package/dist/remote/relay/mock/adapter.js +75 -65
- package/dist/remote/relay/mock/adapter.js.map +1 -1
- package/dist/remote/relay/mock/failures.d.ts +1 -0
- package/dist/remote/relay/mock/failures.d.ts.map +1 -1
- package/dist/remote/relay/mock/failures.js +5 -0
- package/dist/remote/relay/mock/failures.js.map +1 -1
- package/dist/remote/relay/mock/group-server.d.ts +9 -0
- package/dist/remote/relay/mock/group-server.d.ts.map +1 -0
- package/dist/remote/relay/mock/group-server.js +9 -0
- package/dist/remote/relay/mock/group-server.js.map +1 -0
- package/dist/remote/relay/mock/index.d.ts +3 -3
- package/dist/remote/relay/mock/index.d.ts.map +1 -1
- package/dist/remote/relay/mock/index.js +3 -3
- package/dist/remote/relay/mock/index.js.map +1 -1
- package/dist/remote/relay/types.d.ts +56 -25
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/remote/relay/types.js +2 -2
- package/dist/types/api.d.ts +4 -4
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/messages.d.ts +1 -1
- package/dist/types/protocol-config.d.ts +17 -2
- package/dist/types/protocol-config.d.ts.map +1 -1
- package/dist/types/protocol-config.js +17 -2
- package/dist/types/protocol-config.js.map +1 -1
- package/dist/utils/retry.d.ts +2 -2
- package/dist/utils/retry.d.ts.map +1 -1
- package/dist/utils/retry.js +17 -0
- package/dist/utils/retry.js.map +1 -1
- package/docs/CLIENT_COMPOSITION.md +3 -3
- package/docs/DEVIATIONS.md +69 -50
- package/docs/GETTING_STARTED.md +3 -3
- package/docs/INTERFACES.md +22 -22
- package/docs/PACKAGE_SURFACE.md +15 -10
- package/docs/RECIPES.md +4 -4
- package/docs/api/classes/EndorsementManager.md +19 -1
- package/docs/api/classes/{SignalBlockingManager.md → SignalProtocolBlockingManager.md} +5 -5
- package/docs/api/classes/SignalProtocolClient.md +78 -78
- package/docs/api/functions/createDefaultSignalProtocolContentAdapter.md +13 -0
- package/docs/api/functions/{createDefaultSignalLogger.md → createDefaultSignalProtocolLogger.md} +5 -5
- package/docs/api/functions/createGroupId.md +1 -1
- package/docs/api/functions/decodeGroupTrustRoot.md +21 -0
- package/docs/api/functions/encodeGroupTrustRoot.md +28 -0
- package/docs/api/functions/extractGroupId.md +2 -2
- package/docs/api/functions/isGroupId.md +1 -1
- package/docs/api/functions/{resolveSignalLogger.md → resolveSignalProtocolLogger.md} +5 -5
- package/docs/api/interfaces/GroupTrustRoot.md +33 -0
- package/docs/api/interfaces/IProtocolStore.md +1 -1
- package/docs/api/interfaces/IRelayGroupServer.md +60 -0
- package/docs/api/interfaces/ISenderKeyStore.md +1 -1
- package/docs/api/interfaces/ISesameStore.md +1 -1
- package/docs/api/interfaces/ISignalProtocolClient.md +1 -1
- package/docs/api/interfaces/{ISignalLocalSecretVault.md → ISignalProtocolLocalSecretVault.md} +2 -2
- package/docs/api/interfaces/{ISignalLocalStore.md → ISignalProtocolLocalStore.md} +2 -2
- package/docs/api/interfaces/{ISignalRelayServer.md → ISignalProtocolRelayServer.md} +11 -3
- package/docs/api/interfaces/{InspectedSignalContent.md → InspectedSignalProtocolContent.md} +2 -2
- package/docs/api/interfaces/MLKEMBraidAgentState.md +1 -1
- package/docs/api/interfaces/MessageHeader.md +1 -1
- package/docs/api/interfaces/PreKeyMaintenanceStore.md +2 -2
- package/docs/api/interfaces/SealedSenderConfig.md +2 -2
- package/docs/api/interfaces/{SignalBlockingHooks.md → SignalProtocolBlockingHooks.md} +2 -2
- package/docs/api/interfaces/SignalProtocolBlockingManagerOptions.md +31 -0
- package/docs/api/interfaces/{SignalBlockingMirror.md → SignalProtocolBlockingMirror.md} +2 -2
- package/docs/api/interfaces/{SignalBlockingStore.md → SignalProtocolBlockingStore.md} +2 -2
- package/docs/api/interfaces/SignalProtocolClientAdapterConfig.md +3 -3
- package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +69 -31
- package/docs/api/interfaces/SignalProtocolClientConfig.md +93 -37
- package/docs/api/interfaces/SignalProtocolClientHooks.md +1 -1
- package/docs/api/interfaces/SignalProtocolClientIdentityConfig.md +16 -0
- package/docs/api/interfaces/SignalProtocolClientMediaConfig.md +2 -2
- package/docs/api/interfaces/{SignalContentAdapter.md → SignalProtocolContentAdapter.md} +4 -4
- package/docs/api/interfaces/{SignalRemoteObjectStore.md → SignalProtocolRemoteObjectStore.md} +2 -2
- package/docs/api/namespaces/blocking/README.md +10 -10
- package/docs/api/namespaces/keys/functions/generateKemOneTimePreKeys.md +1 -1
- package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentOptions.md +1 -1
- package/docs/api/namespaces/media/interfaces/ExecuteMediaAttachmentJobOptions.md +1 -1
- package/docs/api/namespaces/media/interfaces/PrepareMediaAttachmentUploadOptions.md +1 -1
- package/docs/api/namespaces/media/interfaces/ResolveMediaAttachmentOptions.md +1 -1
- package/docs/api/type-aliases/GroupId.md +2 -2
- package/docs/api/variables/GROUP_ID_PREFIX.md +11 -0
- package/docs/api/variables/GROUP_TRUST_ROOT_VERSION.md +11 -0
- package/docs/api/variables/MAX_RECEIVER_CHAINS.md +1 -1
- package/docs/api/variables/ONE_TIME_PREKEY_BATCH_SIZE.md +1 -1
- package/docs/api/variables/{defaultSignalLogger.md → defaultSignalProtocolLogger.md} +5 -5
- package/files/README.md +1 -1
- package/groups/README.md +16 -5
- package/local/store/README.md +10 -10
- package/local/store/expo/README.md +5 -5
- package/local/store/mock/README.md +1 -1
- package/local/store/node/README.md +1 -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 +13 -2
- 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 +2 -2
- package/remote/relay/convex/README.md +10 -4
- package/remote/relay/convex/server/README.md +146 -0
- package/remote/relay/mock/README.md +1 -1
- package/scripts/oe-groups.mjs +142 -0
- package/types/README.md +1 -1
- package/dist/internal/groups-v2/access-control.d.ts +0 -108
- package/dist/internal/groups-v2/access-control.d.ts.map +0 -1
- package/dist/internal/groups-v2/access-control.js +0 -191
- package/dist/internal/groups-v2/access-control.js.map +0 -1
- package/dist/internal/groups-v2/change-actions.d.ts +0 -40
- package/dist/internal/groups-v2/change-actions.d.ts.map +0 -1
- package/dist/internal/groups-v2/change-actions.js +0 -363
- package/dist/internal/groups-v2/change-actions.js.map +0 -1
- package/dist/internal/groups-v2/encrypted-state.d.ts.map +0 -1
- package/dist/internal/groups-v2/encrypted-state.js.map +0 -1
- package/dist/internal/groups-v2/index.d.ts +0 -19
- package/dist/internal/groups-v2/index.d.ts.map +0 -1
- package/dist/internal/groups-v2/index.js +0 -11
- package/dist/internal/groups-v2/index.js.map +0 -1
- package/dist/internal/groups-v2/invite-link.d.ts.map +0 -1
- package/dist/internal/groups-v2/invite-link.js.map +0 -1
- package/dist/internal/groups-v2/manager.d.ts.map +0 -1
- package/dist/internal/groups-v2/manager.js +0 -1095
- package/dist/internal/groups-v2/manager.js.map +0 -1
- package/dist/internal/groups-v2/types.d.ts.map +0 -1
- package/dist/internal/groups-v2/types.js.map +0 -1
- package/docs/api/functions/createDefaultSignalContentAdapter.md +0 -13
- package/docs/api/interfaces/SignalBlockingManagerOptions.md +0 -31
- package/docs/api/variables/GROUP_V2_PREFIX.md +0 -11
- /package/dist/internal/{groups-v2 → groups}/invite-link.d.ts +0 -0
- /package/dist/internal/{groups-v2 → groups}/invite-link.js +0 -0
|
@@ -22,11 +22,11 @@ import {
|
|
|
22
22
|
} from '@open-e2ee/signal-protocol-sdk';
|
|
23
23
|
import {
|
|
24
24
|
convexRelay,
|
|
25
|
-
type
|
|
25
|
+
type ConvexSignalProtocolRelayApi,
|
|
26
26
|
} from '@open-e2ee/signal-protocol-sdk/remote/relay/convex';
|
|
27
27
|
import { api } from '../convex/_generated/api';
|
|
28
28
|
|
|
29
|
-
const signalApi = api.signal satisfies
|
|
29
|
+
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
30
30
|
const relay = convexRelay({ convex, api: signalApi, currentUserId: userId });
|
|
31
31
|
|
|
32
32
|
// Preferred app-facing composition.
|
|
@@ -36,7 +36,7 @@ const signal = await createSignalProtocolClient({
|
|
|
36
36
|
});
|
|
37
37
|
|
|
38
38
|
// Low-level factory with the same underlying options.
|
|
39
|
-
const
|
|
39
|
+
const advancedSignalProtocol = await SignalProtocolClient.create(userId, {
|
|
40
40
|
storage,
|
|
41
41
|
relay,
|
|
42
42
|
onProgress,
|
|
@@ -50,9 +50,19 @@ const advancedSignal = await SignalProtocolClient.create(userId, {
|
|
|
50
50
|
|
|
51
51
|
## Properties
|
|
52
52
|
|
|
53
|
+
### aci?
|
|
54
|
+
|
|
55
|
+
> `optional` **aci?**: [`ServiceId`](ServiceId.md)
|
|
56
|
+
|
|
57
|
+
This account's ACI for Group System credential presentation.
|
|
58
|
+
|
|
59
|
+
Required when `groups` is configured.
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
53
63
|
### contentAdapter?
|
|
54
64
|
|
|
55
|
-
> `optional` **contentAdapter?**: [`
|
|
65
|
+
> `optional` **contentAdapter?**: [`SignalProtocolContentAdapter`](SignalProtocolContentAdapter.md)
|
|
56
66
|
|
|
57
67
|
Application-provided content adapter.
|
|
58
68
|
|
|
@@ -134,24 +144,21 @@ false
|
|
|
134
144
|
|
|
135
145
|
***
|
|
136
146
|
|
|
137
|
-
###
|
|
147
|
+
### groups?
|
|
138
148
|
|
|
139
|
-
> `optional` **
|
|
149
|
+
> `optional` **groups?**: `object`
|
|
140
150
|
|
|
141
|
-
|
|
151
|
+
Group System configuration.
|
|
142
152
|
Required for group state management (create, sync, membership changes).
|
|
143
153
|
|
|
144
|
-
####
|
|
145
|
-
|
|
146
|
-
> **aci**: [`ServiceId`](ServiceId.md)
|
|
147
|
-
|
|
148
|
-
User's ACI for credential presentation.
|
|
154
|
+
#### allowUnauthenticatedGroupHistory?
|
|
149
155
|
|
|
150
|
-
|
|
156
|
+
> `optional` **allowUnauthenticatedGroupHistory?**: `boolean`
|
|
151
157
|
|
|
152
|
-
|
|
158
|
+
Explicitly accept group history without server signatures.
|
|
153
159
|
|
|
154
|
-
|
|
160
|
+
This selects the documented non-conforming deployment mode and emits a
|
|
161
|
+
visible configuration warning.
|
|
155
162
|
|
|
156
163
|
#### endorsementManager?
|
|
157
164
|
|
|
@@ -159,17 +166,47 @@ Server's credential public key for verifying issuance proofs.
|
|
|
159
166
|
|
|
160
167
|
Pre-constructed EndorsementManager for group send endorsement-based auth.
|
|
161
168
|
|
|
162
|
-
####
|
|
169
|
+
#### issueCredential?
|
|
163
170
|
|
|
164
|
-
> `optional` **
|
|
171
|
+
> `optional` **issueCredential?**: () => `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
|
165
172
|
|
|
166
|
-
|
|
173
|
+
Override the relay's auth-credential issuance transport.
|
|
167
174
|
|
|
168
|
-
|
|
175
|
+
##### Returns
|
|
169
176
|
|
|
170
|
-
|
|
177
|
+
`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
|
178
|
+
|
|
179
|
+
#### issueProfileKeyCredential?
|
|
180
|
+
|
|
181
|
+
> `optional` **issueProfileKeyCredential?**: () => `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
|
182
|
+
|
|
183
|
+
Override the relay's profile-key credential issuance transport.
|
|
184
|
+
|
|
185
|
+
##### Returns
|
|
186
|
+
|
|
187
|
+
`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
|
188
|
+
|
|
189
|
+
#### onConfigurationWarning?
|
|
190
|
+
|
|
191
|
+
> `optional` **onConfigurationWarning?**: (`warning`) => `void`
|
|
192
|
+
|
|
193
|
+
Receive the §12.3 non-conforming deployment warning.
|
|
194
|
+
|
|
195
|
+
##### Parameters
|
|
196
|
+
|
|
197
|
+
###### warning
|
|
198
|
+
|
|
199
|
+
`GroupConfigurationWarning`
|
|
200
|
+
|
|
201
|
+
##### Returns
|
|
171
202
|
|
|
172
|
-
|
|
203
|
+
`void`
|
|
204
|
+
|
|
205
|
+
#### profileKey
|
|
206
|
+
|
|
207
|
+
> **profileKey**: `Uint8Array`
|
|
208
|
+
|
|
209
|
+
This account's 32-byte profile key.
|
|
173
210
|
|
|
174
211
|
#### resolveAciBytesByUserIds?
|
|
175
212
|
|
|
@@ -187,26 +224,37 @@ Resolve member ACIs without importing app content models into the client.
|
|
|
187
224
|
|
|
188
225
|
`Promise`\<`Map`\<`string`, `Uint8Array`\<`ArrayBufferLike`\>\>\>
|
|
189
226
|
|
|
190
|
-
#### server
|
|
227
|
+
#### server?
|
|
228
|
+
|
|
229
|
+
> `optional` **server?**: [`IGroupServer`](IGroupServer.md)
|
|
191
230
|
|
|
192
|
-
|
|
231
|
+
Override `relay.groupServer.server` for a custom deployment.
|
|
193
232
|
|
|
194
|
-
|
|
233
|
+
#### store?
|
|
195
234
|
|
|
196
|
-
|
|
235
|
+
> `optional` **store?**: [`IGroupStateStore`](IGroupStateStore.md)
|
|
197
236
|
|
|
198
|
-
|
|
237
|
+
Override the SDK local storage adapter for group state.
|
|
199
238
|
|
|
200
|
-
|
|
239
|
+
#### trustRoot
|
|
240
|
+
|
|
241
|
+
> **trustRoot**: `Uint8Array`
|
|
242
|
+
|
|
243
|
+
Versioned serialized trust root pinned by the application at build time.
|
|
244
|
+
|
|
245
|
+
This value is never fetched from the relay and trusted at runtime.
|
|
201
246
|
|
|
202
247
|
#### Example
|
|
203
248
|
|
|
204
249
|
```typescript
|
|
205
250
|
const signal = await SignalProtocolClient.create(userId, {
|
|
206
251
|
storage: customStorage,
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
252
|
+
relay,
|
|
253
|
+
aci,
|
|
254
|
+
pni,
|
|
255
|
+
groups: {
|
|
256
|
+
trustRoot: GROUP_TRUST_ROOT,
|
|
257
|
+
profileKey,
|
|
210
258
|
}
|
|
211
259
|
});
|
|
212
260
|
```
|
|
@@ -407,8 +455,8 @@ https://signal.org/docs/specifications/pqxdh/#publishing-keys
|
|
|
407
455
|
|
|
408
456
|
App-owned media lifecycle callbacks for the SignalProtocolClient media queue.
|
|
409
457
|
|
|
410
|
-
The queue itself is persisted through the existing Signal Protocol local
|
|
411
|
-
|
|
458
|
+
The queue itself is persisted through the existing Signal Protocol local storage
|
|
459
|
+
adapter. These callbacks keep local bytes, plaintext caches, and product
|
|
412
460
|
state in the app layer where they can share file permissions, UI state, and
|
|
413
461
|
app database ownership.
|
|
414
462
|
|
|
@@ -532,6 +580,14 @@ const signal = await createSignalProtocolClient({
|
|
|
532
580
|
|
|
533
581
|
***
|
|
534
582
|
|
|
583
|
+
### pni?
|
|
584
|
+
|
|
585
|
+
> `optional` **pni?**: [`ServiceId`](ServiceId.md)
|
|
586
|
+
|
|
587
|
+
This account's optional PNI for Group System credential presentation.
|
|
588
|
+
|
|
589
|
+
***
|
|
590
|
+
|
|
535
591
|
### preKeyCheckThrottleMs?
|
|
536
592
|
|
|
537
593
|
> `optional` **preKeyCheckThrottleMs?**: `number`
|
|
@@ -680,7 +736,7 @@ Double Ratchet algorithm configuration
|
|
|
680
736
|
|
|
681
737
|
### relay?
|
|
682
738
|
|
|
683
|
-
> `optional` **relay?**: [`
|
|
739
|
+
> `optional` **relay?**: [`ISignalProtocolRelayServer`](ISignalProtocolRelayServer.md)
|
|
684
740
|
|
|
685
741
|
Relay adapter for server synchronization.
|
|
686
742
|
|
|
@@ -697,11 +753,11 @@ If omitted, client operates in local-only mode.
|
|
|
697
753
|
import { createSignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
|
|
698
754
|
import {
|
|
699
755
|
convexRelay,
|
|
700
|
-
type
|
|
756
|
+
type ConvexSignalProtocolRelayApi,
|
|
701
757
|
} from '@open-e2ee/signal-protocol-sdk/remote/relay/convex';
|
|
702
758
|
import { api } from '../convex/_generated/api';
|
|
703
759
|
|
|
704
|
-
const signalApi = api.signal satisfies
|
|
760
|
+
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
705
761
|
const relay = convexRelay({ convex, api: signalApi, currentUserId: userId });
|
|
706
762
|
|
|
707
763
|
const signal = await createSignalProtocolClient({
|
|
@@ -714,7 +770,7 @@ const signal = await createSignalProtocolClient({
|
|
|
714
770
|
|
|
715
771
|
### remoteObjectStore?
|
|
716
772
|
|
|
717
|
-
> `optional` **remoteObjectStore?**: [`
|
|
773
|
+
> `optional` **remoteObjectStore?**: [`SignalProtocolRemoteObjectStore`](SignalProtocolRemoteObjectStore.md)
|
|
718
774
|
|
|
719
775
|
Remote object storage adapter for encrypted file uploads (two-layer encryption)
|
|
720
776
|
|
|
@@ -823,7 +879,7 @@ const signal = await SignalProtocolClient.create(userId, {
|
|
|
823
879
|
|
|
824
880
|
### storage
|
|
825
881
|
|
|
826
|
-
> **storage**: [`
|
|
882
|
+
> **storage**: [`ISignalProtocolLocalStore`](ISignalProtocolLocalStore.md)
|
|
827
883
|
|
|
828
884
|
Local store implementation for the current runtime.
|
|
829
885
|
Required by SignalProtocolClient.create().
|
|
@@ -12,6 +12,14 @@ A client represents one app install for one account and one device.
|
|
|
12
12
|
|
|
13
13
|
## Properties
|
|
14
14
|
|
|
15
|
+
### aci?
|
|
16
|
+
|
|
17
|
+
> `optional` **aci?**: [`ServiceId`](ServiceId.md)
|
|
18
|
+
|
|
19
|
+
Account ACI used by the Group System.
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
15
23
|
### deviceId?
|
|
16
24
|
|
|
17
25
|
> `optional` **deviceId?**: `number`
|
|
@@ -28,6 +36,14 @@ Generate and sync both ACI and PNI key material when true.
|
|
|
28
36
|
|
|
29
37
|
***
|
|
30
38
|
|
|
39
|
+
### pni?
|
|
40
|
+
|
|
41
|
+
> `optional` **pni?**: [`ServiceId`](ServiceId.md)
|
|
42
|
+
|
|
43
|
+
Optional account PNI used by the Group System.
|
|
44
|
+
|
|
45
|
+
***
|
|
46
|
+
|
|
31
47
|
### userId
|
|
32
48
|
|
|
33
49
|
> **userId**: `string`
|
|
@@ -46,8 +46,8 @@ Delete app-owned local cache state for a cleanup job.
|
|
|
46
46
|
|
|
47
47
|
Load app-owned local bytes for a queued upload.
|
|
48
48
|
|
|
49
|
-
The Signal Protocol package owns encryption and upload execution. The app owns
|
|
50
|
-
|
|
49
|
+
The Signal Protocol package owns encryption and upload execution. The app owns draft
|
|
50
|
+
files, cache paths, and file permissions, so bytes enter the queue through
|
|
51
51
|
this callback instead of hidden package storage.
|
|
52
52
|
|
|
53
53
|
#### Parameters
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolContentAdapter
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: SignalProtocolContentAdapter
|
|
8
8
|
|
|
9
9
|
## Methods
|
|
10
10
|
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
|
|
31
31
|
### inspectContent()
|
|
32
32
|
|
|
33
|
-
> **inspectContent**(`plaintext`): [`
|
|
33
|
+
> **inspectContent**(`plaintext`): [`InspectedSignalProtocolContent`](InspectedSignalProtocolContent.md)
|
|
34
34
|
|
|
35
35
|
#### Parameters
|
|
36
36
|
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
|
|
41
41
|
#### Returns
|
|
42
42
|
|
|
43
|
-
[`
|
|
43
|
+
[`InspectedSignalProtocolContent`](InspectedSignalProtocolContent.md)
|
|
44
44
|
|
|
45
45
|
***
|
|
46
46
|
|
package/docs/api/interfaces/{SignalRemoteObjectStore.md → SignalProtocolRemoteObjectStore.md}
RENAMED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolRemoteObjectStore
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: SignalProtocolRemoteObjectStore
|
|
8
8
|
|
|
9
9
|
Brokered remote storage for encrypted byte objects.
|
|
10
10
|
|
|
@@ -14,30 +14,30 @@ Re-exports [BlockedRecipientEntry](../../interfaces/BlockedRecipientEntry.md)
|
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
17
|
-
###
|
|
17
|
+
### SignalProtocolBlockingHooks
|
|
18
18
|
|
|
19
|
-
Re-exports [
|
|
19
|
+
Re-exports [SignalProtocolBlockingHooks](../../interfaces/SignalProtocolBlockingHooks.md)
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
23
|
-
###
|
|
23
|
+
### SignalProtocolBlockingManager
|
|
24
24
|
|
|
25
|
-
Re-exports [
|
|
25
|
+
Re-exports [SignalProtocolBlockingManager](../../classes/SignalProtocolBlockingManager.md)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
29
|
-
###
|
|
29
|
+
### SignalProtocolBlockingManagerOptions
|
|
30
30
|
|
|
31
|
-
Re-exports [
|
|
31
|
+
Re-exports [SignalProtocolBlockingManagerOptions](../../interfaces/SignalProtocolBlockingManagerOptions.md)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
35
|
-
###
|
|
35
|
+
### SignalProtocolBlockingMirror
|
|
36
36
|
|
|
37
|
-
Re-exports [
|
|
37
|
+
Re-exports [SignalProtocolBlockingMirror](../../interfaces/SignalProtocolBlockingMirror.md)
|
|
38
38
|
|
|
39
39
|
***
|
|
40
40
|
|
|
41
|
-
###
|
|
41
|
+
### SignalProtocolBlockingStore
|
|
42
42
|
|
|
43
|
-
Re-exports [
|
|
43
|
+
Re-exports [SignalProtocolBlockingStore](../../interfaces/SignalProtocolBlockingStore.md)
|
|
@@ -16,7 +16,7 @@ Each key can only be used once for per-session post-quantum forward secrecy.
|
|
|
16
16
|
Per PQXDH spec Section 3.2, these are signed one-time pqkem prekeys
|
|
17
17
|
that the server prefers over the last-resort KEM prekey.
|
|
18
18
|
|
|
19
|
-
Uses the same batch size as EC one-time prekeys (
|
|
19
|
+
Uses the same batch size as EC one-time prekeys (the reference implementation uses 100 for both).
|
|
20
20
|
|
|
21
21
|
## Parameters
|
|
22
22
|
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
|
|
17
17
|
### remoteObjectStore
|
|
18
18
|
|
|
19
|
-
> **remoteObjectStore**: [`
|
|
19
|
+
> **remoteObjectStore**: [`SignalProtocolRemoteObjectStore`](../../../interfaces/SignalProtocolRemoteObjectStore.md)
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
@@ -76,7 +76,7 @@
|
|
|
76
76
|
|
|
77
77
|
### remoteObjectStore
|
|
78
78
|
|
|
79
|
-
> **remoteObjectStore**: [`
|
|
79
|
+
> **remoteObjectStore**: [`SignalProtocolRemoteObjectStore`](../../../interfaces/SignalProtocolRemoteObjectStore.md)
|
|
80
80
|
|
|
81
81
|
***
|
|
82
82
|
|
|
@@ -88,7 +88,7 @@
|
|
|
88
88
|
|
|
89
89
|
### remoteObjectStore
|
|
90
90
|
|
|
91
|
-
> **remoteObjectStore**: [`
|
|
91
|
+
> **remoteObjectStore**: [`SignalProtocolRemoteObjectStore`](../../../interfaces/SignalProtocolRemoteObjectStore.md)
|
|
92
92
|
|
|
93
93
|
***
|
|
94
94
|
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
|
|
29
29
|
### remoteObjectStore
|
|
30
30
|
|
|
31
|
-
> **remoteObjectStore**: [`
|
|
31
|
+
> **remoteObjectStore**: [`SignalProtocolRemoteObjectStore`](../../../interfaces/SignalProtocolRemoteObjectStore.md)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
Branded type for prefixed group IDs
|
|
12
12
|
|
|
13
13
|
Ensures compile-time safety for group ID handling.
|
|
14
|
-
A GroupId is always a string with the
|
|
14
|
+
A GroupId is always a string with the OpenE2EE group prefix.
|
|
15
15
|
|
|
16
16
|
## Type Declaration
|
|
17
17
|
|
|
@@ -23,5 +23,5 @@ A GroupId is always a string with the Signal Protocol V2 prefix.
|
|
|
23
23
|
|
|
24
24
|
```typescript
|
|
25
25
|
const groupId: GroupId = createGroupId('abc123');
|
|
26
|
-
// groupId is '
|
|
26
|
+
// groupId is 'open-e2ee:group:abc123' with GroupId type
|
|
27
27
|
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / GROUP\_ID\_PREFIX
|
|
6
|
+
|
|
7
|
+
# Variable: GROUP\_ID\_PREFIX
|
|
8
|
+
|
|
9
|
+
> `const` **GROUP\_ID\_PREFIX**: `"open-e2ee:group:"` = `'open-e2ee:group:'`
|
|
10
|
+
|
|
11
|
+
Canonical prefix for group identifiers.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / GROUP\_TRUST\_ROOT\_VERSION
|
|
6
|
+
|
|
7
|
+
# Variable: GROUP\_TRUST\_ROOT\_VERSION
|
|
8
|
+
|
|
9
|
+
> `const` **GROUP\_TRUST\_ROOT\_VERSION**: `1` = `1`
|
|
10
|
+
|
|
11
|
+
Current serialized group trust-root format.
|
|
@@ -10,5 +10,5 @@
|
|
|
10
10
|
|
|
11
11
|
Maximum number of receiver chains to store.
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
The reference implementation maintains up to 5 receiver chains for handling out-of-order
|
|
14
14
|
DH ratchets. When a 6th chain would be added, the oldest is evicted.
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
|
|
11
11
|
Batch size for one-time prekeys (both EC and KEM)
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
The reference implementation uses 100 for both EC and KEM one-time prekeys to maintain
|
|
14
14
|
protocol symmetry. This balances key availability with storage/upload costs.
|
|
15
15
|
|
|
16
16
|
Per PQXDH specification, KEM one-time prekeys follow the same
|
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / defaultSignalProtocolLogger
|
|
6
6
|
|
|
7
|
-
# Variable:
|
|
7
|
+
# Variable: defaultSignalProtocolLogger
|
|
8
8
|
|
|
9
|
-
> `const` **
|
|
9
|
+
> `const` **defaultSignalProtocolLogger**: `Required`\<[`ILogger`](../interfaces/ILogger.md)\>
|
|
10
10
|
|
|
11
11
|
Logging utilities for app composition
|
|
12
12
|
|
|
13
|
-
Pass a logger into `createSignalProtocolClient()` to route Signal Protocol logs
|
|
14
|
-
|
|
13
|
+
Pass a logger into `createSignalProtocolClient()` to route Signal Protocol logs through
|
|
14
|
+
your app logger or custom diagnostics pipeline.
|
|
15
15
|
|
|
16
16
|
## Example
|
|
17
17
|
|
package/files/README.md
CHANGED
|
@@ -29,7 +29,7 @@ const plaintext = await streamingDecrypt(
|
|
|
29
29
|
For a complete attachment workflow with upload brokering, retries, pointer
|
|
30
30
|
validation, and cleanup, use the
|
|
31
31
|
[`media`](../media/README.md) module with a
|
|
32
|
-
[`
|
|
32
|
+
[`SignalProtocolRemoteObjectStore`](../remote/object-store/README.md).
|
|
33
33
|
|
|
34
34
|
Applications remain responsible for file-system permissions, cache lifetime,
|
|
35
35
|
content rendering, and securely disposing of decrypted temporary files.
|
package/groups/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Groups
|
|
2
2
|
|
|
3
|
-
The groups module provides group identifiers, encrypted
|
|
3
|
+
The groups module provides group identifiers, encrypted group state,
|
|
4
4
|
membership transitions, access-control checks, invite links, and the
|
|
5
|
-
`
|
|
5
|
+
`GroupManager` orchestration API.
|
|
6
6
|
|
|
7
7
|
## Why it exists
|
|
8
8
|
|
|
@@ -15,18 +15,23 @@ and sender-key rotation.
|
|
|
15
15
|
|
|
16
16
|
```ts
|
|
17
17
|
import {
|
|
18
|
-
|
|
18
|
+
GroupManager,
|
|
19
19
|
createGroupId,
|
|
20
20
|
type IGroupServer,
|
|
21
21
|
type IGroupStateStore,
|
|
22
22
|
} from "@open-e2ee/signal-protocol-sdk/groups";
|
|
23
23
|
|
|
24
|
-
const groups = new
|
|
24
|
+
const groups = new GroupManager({
|
|
25
25
|
store: appGroupStore as IGroupStateStore,
|
|
26
26
|
server: appGroupServer as IGroupServer,
|
|
27
27
|
issueCredential: () => appGroupCredentials.issue(),
|
|
28
28
|
credentialPublicKey,
|
|
29
|
+
serverSigningPublicKey,
|
|
29
30
|
aci: localAccountServiceId,
|
|
31
|
+
pni: localPhoneNumberServiceId,
|
|
32
|
+
issueProfileKeyCredential: () => appGroupCredentials.issueProfileKey(),
|
|
33
|
+
profileKeyCredentialPublicKey,
|
|
34
|
+
profileKey: localProfileKey,
|
|
30
35
|
});
|
|
31
36
|
|
|
32
37
|
const groupId = createGroupId(rawGroupId);
|
|
@@ -36,7 +41,13 @@ const state = await groups.syncGroup(groupId);
|
|
|
36
41
|
The server must enforce authenticated access and version sequencing without
|
|
37
42
|
receiving plaintext group attributes or group master keys. Membership removal
|
|
38
43
|
must also invalidate or rotate group messaging state through the callbacks
|
|
39
|
-
required by `
|
|
44
|
+
required by `GroupManagerOptions`. Every `getGroup()` response must include a
|
|
45
|
+
baseline signature over the group ID, version, and exact encrypted-state bytes;
|
|
46
|
+
the client verifies it before installing a first or post-revocation baseline.
|
|
47
|
+
|
|
48
|
+
Deployments whose server does not yet sign group changes must opt in explicitly
|
|
49
|
+
with `allowUnauthenticatedGroupHistory: true`; the SDK emits a security warning
|
|
50
|
+
because that mode has no authenticated group history.
|
|
40
51
|
|
|
41
52
|
See the [API reference](../docs/api/README.md) and
|
|
42
53
|
[security model](../docs/SECURITY.md).
|
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
|
+
- `MockSignalProtocolStore` from `@open-e2ee/signal-protocol-sdk/local/store/mock`
|
|
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,7 +36,7 @@ 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
41
|
Use this for non-mobile environments that need a filesystem-backed store.
|
|
42
42
|
|
|
@@ -44,11 +44,11 @@ Use this for non-mobile environments that need a filesystem-backed store.
|
|
|
44
44
|
|
|
45
45
|
```ts
|
|
46
46
|
import { SignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
|
|
47
|
-
import {
|
|
47
|
+
import { ExpoSignalProtocolStore } from '@open-e2ee/signal-protocol-sdk/local/store/expo';
|
|
48
48
|
|
|
49
49
|
// Configure the application-owned Expo/SQLCipher database bindings first.
|
|
50
50
|
const signal = await SignalProtocolClient.create(userId, {
|
|
51
|
-
storage: new
|
|
51
|
+
storage: new ExpoSignalProtocolStore(),
|
|
52
52
|
});
|
|
53
53
|
```
|
|
54
54
|
|
|
@@ -56,7 +56,7 @@ The [Expo guide](./expo/README.md) shows the required database bootstrap.
|
|
|
56
56
|
|
|
57
57
|
## Storage Responsibilities
|
|
58
58
|
|
|
59
|
-
An `
|
|
59
|
+
An `ISignalProtocolLocalStore` implementation must preserve:
|
|
60
60
|
|
|
61
61
|
- account identity key storage
|
|
62
62
|
- contact identity trust / TOFU decisions
|