@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
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / GroupTrustRoot
|
|
6
|
+
|
|
7
|
+
# Interface: GroupTrustRoot
|
|
8
|
+
|
|
9
|
+
The four public keys pinned for one conforming group-server deployment.
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### credentialPublicKey
|
|
14
|
+
|
|
15
|
+
> **credentialPublicKey**: [`CredentialPublicKey`](CredentialPublicKey.md)
|
|
16
|
+
|
|
17
|
+
***
|
|
18
|
+
|
|
19
|
+
### endorsementRootPublicKey
|
|
20
|
+
|
|
21
|
+
> **endorsementRootPublicKey**: [`ServerRootPublicKey`](../classes/ServerRootPublicKey.md)
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### profileKeyCredentialPublicKey
|
|
26
|
+
|
|
27
|
+
> **profileKeyCredentialPublicKey**: [`CredentialPublicKey`](CredentialPublicKey.md)
|
|
28
|
+
|
|
29
|
+
***
|
|
30
|
+
|
|
31
|
+
### serverSigningPublicKey?
|
|
32
|
+
|
|
33
|
+
> `optional` **serverSigningPublicKey?**: `Uint8Array`\<`ArrayBufferLike`\>
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / IRelayGroupServer
|
|
6
|
+
|
|
7
|
+
# Interface: IRelayGroupServer
|
|
8
|
+
|
|
9
|
+
Optional relay capability for the Group System.
|
|
10
|
+
|
|
11
|
+
The trust root is intentionally absent: clients pin it out of band rather
|
|
12
|
+
than discovering and trusting it from this runtime capability.
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
### server
|
|
17
|
+
|
|
18
|
+
> `readonly` **server**: [`IGroupServer`](IGroupServer.md)
|
|
19
|
+
|
|
20
|
+
Encrypted group-state transport.
|
|
21
|
+
|
|
22
|
+
## Methods
|
|
23
|
+
|
|
24
|
+
### issueAuthCredential()
|
|
25
|
+
|
|
26
|
+
> **issueAuthCredential**(`userId`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
|
27
|
+
|
|
28
|
+
Issue an auth credential for the relay's authenticated account.
|
|
29
|
+
|
|
30
|
+
#### Parameters
|
|
31
|
+
|
|
32
|
+
##### userId
|
|
33
|
+
|
|
34
|
+
`string`
|
|
35
|
+
|
|
36
|
+
#### Returns
|
|
37
|
+
|
|
38
|
+
`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
|
39
|
+
|
|
40
|
+
***
|
|
41
|
+
|
|
42
|
+
### issueProfileKeyCredential()
|
|
43
|
+
|
|
44
|
+
> **issueProfileKeyCredential**(`userId`, `profileKey`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
|
45
|
+
|
|
46
|
+
Issue a profile-key credential for the relay's authenticated account.
|
|
47
|
+
|
|
48
|
+
#### Parameters
|
|
49
|
+
|
|
50
|
+
##### userId
|
|
51
|
+
|
|
52
|
+
`string`
|
|
53
|
+
|
|
54
|
+
##### profileKey
|
|
55
|
+
|
|
56
|
+
`Uint8Array`
|
|
57
|
+
|
|
58
|
+
#### Returns
|
|
59
|
+
|
|
60
|
+
`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
package/docs/api/interfaces/{ISignalLocalSecretVault.md → ISignalProtocolLocalSecretVault.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) / ISignalProtocolLocalSecretVault
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: ISignalProtocolLocalSecretVault
|
|
8
8
|
|
|
9
9
|
Small local secret vault used to bootstrap a local Signal Protocol store.
|
|
10
10
|
|
|
@@ -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) / ISignalProtocolLocalStore
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: ISignalProtocolLocalStore
|
|
8
8
|
|
|
9
9
|
Signal Protocol local store interface.
|
|
10
10
|
|
|
@@ -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) / ISignalProtocolRelayServer
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: ISignalProtocolRelayServer
|
|
8
8
|
|
|
9
9
|
Server-side relay for encrypted envelope push delivery.
|
|
10
10
|
|
|
@@ -18,7 +18,7 @@ Maps to 17 Convex tables.
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
const relay:
|
|
21
|
+
const relay: ISignalProtocolRelayServer = new ConvexSignalProtocolRelayServer(convex, signalApi, {
|
|
22
22
|
currentUserId: userId,
|
|
23
23
|
});
|
|
24
24
|
|
|
@@ -42,6 +42,14 @@ await relay.send({
|
|
|
42
42
|
|
|
43
43
|
- `IProvisioningService`.`IKeyRotationService`
|
|
44
44
|
|
|
45
|
+
## Properties
|
|
46
|
+
|
|
47
|
+
### groupServer?
|
|
48
|
+
|
|
49
|
+
> `readonly` `optional` **groupServer?**: [`IRelayGroupServer`](IRelayGroupServer.md)
|
|
50
|
+
|
|
51
|
+
Optional conforming Group System transport and issuance capability.
|
|
52
|
+
|
|
45
53
|
## Methods
|
|
46
54
|
|
|
47
55
|
### acknowledgeProvisioning()
|
|
@@ -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) / InspectedSignalProtocolContent
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: InspectedSignalProtocolContent
|
|
8
8
|
|
|
9
9
|
## Properties
|
|
10
10
|
|
|
@@ -52,7 +52,7 @@ Decoded CT1 stored for combined MAC verification with CT2
|
|
|
52
52
|
|
|
53
53
|
> `optional` **ct1\_for\_mac?**: `Uint8Array`\<`ArrayBufferLike`\>
|
|
54
54
|
|
|
55
|
-
CT1 copy stored for combined MAC computation with CT2 (
|
|
55
|
+
CT1 copy stored for combined MAC computation with CT2 (the reference implementation authenticates ct1||ct2)
|
|
56
56
|
|
|
57
57
|
***
|
|
58
58
|
|
|
@@ -11,7 +11,7 @@ Double Ratchet message header
|
|
|
11
11
|
Contains metadata needed for DH ratcheting and out-of-order message handling.
|
|
12
12
|
This header is sent with every encrypted message.
|
|
13
13
|
|
|
14
|
-
Field names reflect the
|
|
14
|
+
Field names reflect the SignalProtocolMessage wire fields:
|
|
15
15
|
|
|
16
16
|
## Properties
|
|
17
17
|
|
|
@@ -8,8 +8,8 @@
|
|
|
8
8
|
|
|
9
9
|
App-provided persistence helpers for prekey replacement bookkeeping.
|
|
10
10
|
|
|
11
|
-
The Signal Protocol
|
|
12
|
-
|
|
11
|
+
The Signal Protocol SDK owns rotation semantics; concrete storage adapters own
|
|
12
|
+
persistence.
|
|
13
13
|
|
|
14
14
|
## Methods
|
|
15
15
|
|
|
@@ -52,8 +52,8 @@ Base64-encoded serialized SenderCertificate
|
|
|
52
52
|
|
|
53
53
|
Optional host-provided contact profile state store.
|
|
54
54
|
|
|
55
|
-
When present, the Signal Protocol client can use per-contact profile keys
|
|
56
|
-
|
|
55
|
+
When present, the Signal Protocol client can use per-contact profile keys and
|
|
56
|
+
unidentified-access mode for direct-message sealed sender sends
|
|
57
57
|
without importing the host app's persistence layer.
|
|
58
58
|
|
|
59
59
|
***
|
|
@@ -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) / SignalProtocolBlockingHooks
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: SignalProtocolBlockingHooks
|
|
8
8
|
|
|
9
9
|
Optional local side effects that belong to the act of blocking itself.
|
|
10
10
|
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolBlockingManagerOptions
|
|
6
|
+
|
|
7
|
+
# Interface: SignalProtocolBlockingManagerOptions
|
|
8
|
+
|
|
9
|
+
## Properties
|
|
10
|
+
|
|
11
|
+
### hooks?
|
|
12
|
+
|
|
13
|
+
> `optional` **hooks?**: [`SignalProtocolBlockingHooks`](SignalProtocolBlockingHooks.md)
|
|
14
|
+
|
|
15
|
+
***
|
|
16
|
+
|
|
17
|
+
### logger?
|
|
18
|
+
|
|
19
|
+
> `optional` **logger?**: [`ILogger`](ILogger.md)
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### mirror?
|
|
24
|
+
|
|
25
|
+
> `optional` **mirror?**: [`SignalProtocolBlockingMirror`](SignalProtocolBlockingMirror.md)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### store
|
|
30
|
+
|
|
31
|
+
> **store**: [`SignalProtocolBlockingStore`](SignalProtocolBlockingStore.md)
|
|
@@ -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) / SignalProtocolBlockingMirror
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: SignalProtocolBlockingMirror
|
|
8
8
|
|
|
9
9
|
Optional app/backend mirror for local block changes.
|
|
10
10
|
|
|
@@ -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) / SignalProtocolBlockingStore
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: SignalProtocolBlockingStore
|
|
8
8
|
|
|
9
9
|
Durable local store for blocked recipients.
|
|
10
10
|
|
|
@@ -23,7 +23,7 @@ Advanced protocol manager override for tests and specialized integrations.
|
|
|
23
23
|
|
|
24
24
|
### relay?
|
|
25
25
|
|
|
26
|
-
> `optional` **relay?**: [`
|
|
26
|
+
> `optional` **relay?**: [`ISignalProtocolRelayServer`](ISignalProtocolRelayServer.md)
|
|
27
27
|
|
|
28
28
|
Optional relay for server sync, prekeys, fanout, and subscriptions.
|
|
29
29
|
|
|
@@ -31,7 +31,7 @@ Optional relay for server sync, prekeys, fanout, and subscriptions.
|
|
|
31
31
|
|
|
32
32
|
### remoteObjectStore?
|
|
33
33
|
|
|
34
|
-
> `optional` **remoteObjectStore?**: [`
|
|
34
|
+
> `optional` **remoteObjectStore?**: [`SignalProtocolRemoteObjectStore`](SignalProtocolRemoteObjectStore.md)
|
|
35
35
|
|
|
36
36
|
Optional brokered remote object store for encrypted attachments.
|
|
37
37
|
|
|
@@ -39,6 +39,6 @@ Optional brokered remote object store for encrypted attachments.
|
|
|
39
39
|
|
|
40
40
|
### storage
|
|
41
41
|
|
|
42
|
-
> **storage**: [`
|
|
42
|
+
> **storage**: [`ISignalProtocolLocalStore`](ISignalProtocolLocalStore.md)
|
|
43
43
|
|
|
44
44
|
Required local protocol store for the current runtime.
|
|
@@ -51,7 +51,7 @@ signal.startRelaySubscription();
|
|
|
51
51
|
|
|
52
52
|
## Extends
|
|
53
53
|
|
|
54
|
-
- `Omit`\<[`SignalProtocolClientConfig`](SignalProtocolClientConfig.md), `"remoteObjectStore"` \| `"deviceId"` \| `"enablePniKeys"` \| `"protocol"` \| `"protocolManager"` \| `"protocolStrategy"` \| `"relay"` \| `"storage"`\>
|
|
54
|
+
- `Omit`\<[`SignalProtocolClientConfig`](SignalProtocolClientConfig.md), `"remoteObjectStore"` \| `"aci"` \| `"deviceId"` \| `"enablePniKeys"` \| `"protocol"` \| `"protocolManager"` \| `"protocolStrategy"` \| `"relay"` \| `"pni"` \| `"storage"`\>
|
|
55
55
|
|
|
56
56
|
## Properties
|
|
57
57
|
|
|
@@ -63,7 +63,7 @@ signal.startRelaySubscription();
|
|
|
63
63
|
|
|
64
64
|
### contentAdapter?
|
|
65
65
|
|
|
66
|
-
> `optional` **contentAdapter?**: [`
|
|
66
|
+
> `optional` **contentAdapter?**: [`SignalProtocolContentAdapter`](SignalProtocolContentAdapter.md)
|
|
67
67
|
|
|
68
68
|
Application-provided content adapter.
|
|
69
69
|
|
|
@@ -90,24 +90,21 @@ Recommended: Enable in development, disable in production
|
|
|
90
90
|
|
|
91
91
|
***
|
|
92
92
|
|
|
93
|
-
###
|
|
93
|
+
### groups?
|
|
94
94
|
|
|
95
|
-
> `optional` **
|
|
95
|
+
> `optional` **groups?**: `object`
|
|
96
96
|
|
|
97
|
-
|
|
97
|
+
Group System configuration.
|
|
98
98
|
Required for group state management (create, sync, membership changes).
|
|
99
99
|
|
|
100
|
-
####
|
|
100
|
+
#### allowUnauthenticatedGroupHistory?
|
|
101
101
|
|
|
102
|
-
> **
|
|
102
|
+
> `optional` **allowUnauthenticatedGroupHistory?**: `boolean`
|
|
103
103
|
|
|
104
|
-
|
|
104
|
+
Explicitly accept group history without server signatures.
|
|
105
105
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
> **credentialPublicKey**: [`CredentialPublicKey`](CredentialPublicKey.md)
|
|
109
|
-
|
|
110
|
-
Server's credential public key for verifying issuance proofs.
|
|
106
|
+
This selects the documented non-conforming deployment mode and emits a
|
|
107
|
+
visible configuration warning.
|
|
111
108
|
|
|
112
109
|
#### endorsementManager?
|
|
113
110
|
|
|
@@ -115,17 +112,47 @@ Server's credential public key for verifying issuance proofs.
|
|
|
115
112
|
|
|
116
113
|
Pre-constructed EndorsementManager for group send endorsement-based auth.
|
|
117
114
|
|
|
118
|
-
####
|
|
115
|
+
#### issueCredential?
|
|
116
|
+
|
|
117
|
+
> `optional` **issueCredential?**: () => `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
|
118
|
+
|
|
119
|
+
Override the relay's auth-credential issuance transport.
|
|
120
|
+
|
|
121
|
+
##### Returns
|
|
122
|
+
|
|
123
|
+
`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
|
124
|
+
|
|
125
|
+
#### issueProfileKeyCredential?
|
|
126
|
+
|
|
127
|
+
> `optional` **issueProfileKeyCredential?**: () => `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
|
128
|
+
|
|
129
|
+
Override the relay's profile-key credential issuance transport.
|
|
130
|
+
|
|
131
|
+
##### Returns
|
|
132
|
+
|
|
133
|
+
`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
|
|
119
134
|
|
|
120
|
-
|
|
135
|
+
#### onConfigurationWarning?
|
|
121
136
|
|
|
122
|
-
|
|
137
|
+
> `optional` **onConfigurationWarning?**: (`warning`) => `void`
|
|
123
138
|
|
|
124
|
-
|
|
139
|
+
Receive the §12.3 non-conforming deployment warning.
|
|
125
140
|
|
|
126
|
-
|
|
141
|
+
##### Parameters
|
|
142
|
+
|
|
143
|
+
###### warning
|
|
144
|
+
|
|
145
|
+
`GroupConfigurationWarning`
|
|
146
|
+
|
|
147
|
+
##### Returns
|
|
148
|
+
|
|
149
|
+
`void`
|
|
127
150
|
|
|
128
|
-
|
|
151
|
+
#### profileKey
|
|
152
|
+
|
|
153
|
+
> **profileKey**: `Uint8Array`
|
|
154
|
+
|
|
155
|
+
This account's 32-byte profile key.
|
|
129
156
|
|
|
130
157
|
#### resolveAciBytesByUserIds?
|
|
131
158
|
|
|
@@ -143,33 +170,44 @@ Resolve member ACIs without importing app content models into the client.
|
|
|
143
170
|
|
|
144
171
|
`Promise`\<`Map`\<`string`, `Uint8Array`\<`ArrayBufferLike`\>\>\>
|
|
145
172
|
|
|
146
|
-
#### server
|
|
173
|
+
#### server?
|
|
174
|
+
|
|
175
|
+
> `optional` **server?**: [`IGroupServer`](IGroupServer.md)
|
|
176
|
+
|
|
177
|
+
Override `relay.groupServer.server` for a custom deployment.
|
|
178
|
+
|
|
179
|
+
#### store?
|
|
180
|
+
|
|
181
|
+
> `optional` **store?**: [`IGroupStateStore`](IGroupStateStore.md)
|
|
147
182
|
|
|
148
|
-
|
|
183
|
+
Override the SDK local storage adapter for group state.
|
|
149
184
|
|
|
150
|
-
|
|
185
|
+
#### trustRoot
|
|
151
186
|
|
|
152
|
-
|
|
187
|
+
> **trustRoot**: `Uint8Array`
|
|
153
188
|
|
|
154
|
-
|
|
189
|
+
Versioned serialized trust root pinned by the application at build time.
|
|
155
190
|
|
|
156
|
-
|
|
191
|
+
This value is never fetched from the relay and trusted at runtime.
|
|
157
192
|
|
|
158
193
|
#### Example
|
|
159
194
|
|
|
160
195
|
```typescript
|
|
161
196
|
const signal = await SignalProtocolClient.create(userId, {
|
|
162
197
|
storage: customStorage,
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
198
|
+
relay,
|
|
199
|
+
aci,
|
|
200
|
+
pni,
|
|
201
|
+
groups: {
|
|
202
|
+
trustRoot: GROUP_TRUST_ROOT,
|
|
203
|
+
profileKey,
|
|
166
204
|
}
|
|
167
205
|
});
|
|
168
206
|
```
|
|
169
207
|
|
|
170
208
|
#### Inherited from
|
|
171
209
|
|
|
172
|
-
[`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`
|
|
210
|
+
[`SignalProtocolClientConfig`](SignalProtocolClientConfig.md).[`groups`](SignalProtocolClientConfig.md#groups)
|
|
173
211
|
|
|
174
212
|
***
|
|
175
213
|
|
|
@@ -389,8 +427,8 @@ https://signal.org/docs/specifications/pqxdh/#publishing-keys
|
|
|
389
427
|
|
|
390
428
|
App-owned media lifecycle callbacks for the SignalProtocolClient media queue.
|
|
391
429
|
|
|
392
|
-
The queue itself is persisted through the existing Signal Protocol local
|
|
393
|
-
|
|
430
|
+
The queue itself is persisted through the existing Signal Protocol local storage
|
|
431
|
+
adapter. These callbacks keep local bytes, plaintext caches, and product
|
|
394
432
|
state in the app layer where they can share file permissions, UI state, and
|
|
395
433
|
app database ownership.
|
|
396
434
|
|