@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
package/docs/INTERFACES.md
CHANGED
|
@@ -12,30 +12,30 @@ policy.
|
|
|
12
12
|
|
|
13
13
|
```text
|
|
14
14
|
SignalProtocolClient
|
|
15
|
-
├──
|
|
16
|
-
├──
|
|
17
|
-
├──
|
|
15
|
+
├── ISignalProtocolLocalStore device-local protocol state
|
|
16
|
+
├── ISignalProtocolRelayServer authenticated device, prekey, and envelope service
|
|
17
|
+
├── SignalProtocolRemoteObjectStore brokered encrypted-object operations (optional)
|
|
18
18
|
├── media callbacks application-owned attachment bytes and caches
|
|
19
19
|
└── lifecycle hooks application reactions and observability
|
|
20
20
|
|
|
21
21
|
Local-store bootstrap
|
|
22
|
-
└──
|
|
22
|
+
└── ISignalProtocolLocalSecretVault small platform-managed bootstrap secrets
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
The interfaces are public contracts, but they do not make an implementation
|
|
26
26
|
secure by themselves. Each adapter must preserve the ownership and atomicity
|
|
27
27
|
requirements described below.
|
|
28
28
|
|
|
29
|
-
## `
|
|
29
|
+
## `ISignalProtocolLocalStore`
|
|
30
30
|
|
|
31
|
-
`
|
|
31
|
+
`ISignalProtocolLocalStore` persists the current device's identities, prekeys, sessions,
|
|
32
32
|
sender keys, contact trust, retry records, and operational metadata.
|
|
33
33
|
|
|
34
34
|
```ts
|
|
35
|
-
import type {
|
|
35
|
+
import type { ISignalProtocolLocalStore } from "@open-e2ee/signal-protocol-sdk/local/store";
|
|
36
36
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
37
37
|
|
|
38
|
-
const storage:
|
|
38
|
+
const storage: ISignalProtocolLocalStore = appProtocolStore;
|
|
39
39
|
|
|
40
40
|
const client = await createSignalProtocolClient({
|
|
41
41
|
identity: { userId },
|
|
@@ -56,16 +56,16 @@ A production implementation must:
|
|
|
56
56
|
Available adapters and their status are documented in the
|
|
57
57
|
[local-store guide](../local/store/README.md).
|
|
58
58
|
|
|
59
|
-
## `
|
|
59
|
+
## `ISignalProtocolLocalSecretVault`
|
|
60
60
|
|
|
61
|
-
`
|
|
61
|
+
`ISignalProtocolLocalSecretVault` is a deliberately small interface for bootstrap
|
|
62
62
|
secrets that must live outside the main local store, such as a database
|
|
63
63
|
encryption key.
|
|
64
64
|
|
|
65
65
|
```ts
|
|
66
|
-
import type {
|
|
66
|
+
import type { ISignalProtocolLocalSecretVault } from "@open-e2ee/signal-protocol-sdk";
|
|
67
67
|
|
|
68
|
-
const vault:
|
|
68
|
+
const vault: ISignalProtocolLocalSecretVault = {
|
|
69
69
|
getSecret: (name) => platformSecrets.getBytes(name),
|
|
70
70
|
setSecret: (name, value) => platformSecrets.setBytes(name, value),
|
|
71
71
|
deleteSecret: (name) => platformSecrets.delete(name),
|
|
@@ -77,23 +77,23 @@ device migration, uninstall persistence, and deletion behavior depend on the
|
|
|
77
77
|
selected platform service and host configuration. See the
|
|
78
78
|
[secret-vault guide](../local/vault/README.md).
|
|
79
79
|
|
|
80
|
-
## `
|
|
80
|
+
## `ISignalProtocolRelayServer`
|
|
81
81
|
|
|
82
|
-
`
|
|
82
|
+
`ISignalProtocolRelayServer` represents the authenticated application backend used for
|
|
83
83
|
device registration, account identity state, public prekeys, encrypted-envelope
|
|
84
84
|
delivery, provisioning, key rotation, and encrypted group coordination.
|
|
85
85
|
|
|
86
86
|
```ts
|
|
87
|
-
import type {
|
|
87
|
+
import type { ISignalProtocolRelayServer } from "@open-e2ee/signal-protocol-sdk/remote/relay";
|
|
88
88
|
import {
|
|
89
89
|
convexRelay,
|
|
90
|
-
type
|
|
90
|
+
type ConvexSignalProtocolRelayApi,
|
|
91
91
|
} from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
|
|
92
92
|
import { api } from "../convex/_generated/api";
|
|
93
93
|
|
|
94
|
-
const signalApi = api.signal satisfies
|
|
94
|
+
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
95
95
|
|
|
96
|
-
const relay:
|
|
96
|
+
const relay: ISignalProtocolRelayServer = convexRelay({
|
|
97
97
|
convex,
|
|
98
98
|
api: signalApi,
|
|
99
99
|
currentUserId: userId,
|
|
@@ -110,17 +110,17 @@ The relay stores public protocol material, ciphertext, and required routing
|
|
|
110
110
|
metadata. It must not require device private keys or decrypted message content.
|
|
111
111
|
See the [relay guide](../remote/relay/README.md).
|
|
112
112
|
|
|
113
|
-
## `
|
|
113
|
+
## `SignalProtocolRemoteObjectStore`
|
|
114
114
|
|
|
115
|
-
`
|
|
115
|
+
`SignalProtocolRemoteObjectStore` supplies short-lived upload and download operations
|
|
116
116
|
for already encrypted objects. It is provider-neutral and optional.
|
|
117
117
|
|
|
118
118
|
```ts
|
|
119
119
|
import type {
|
|
120
|
-
|
|
120
|
+
SignalProtocolRemoteObjectStore,
|
|
121
121
|
} from "@open-e2ee/signal-protocol-sdk/remote/object-store";
|
|
122
122
|
|
|
123
|
-
const remoteObjectStore:
|
|
123
|
+
const remoteObjectStore: SignalProtocolRemoteObjectStore = {
|
|
124
124
|
createUpload: (request) => appObjectBroker.createUpload(request),
|
|
125
125
|
createDownload: (request) => appObjectBroker.createDownload(request),
|
|
126
126
|
completeUpload: (request) => appObjectBroker.completeUpload(request),
|
package/docs/PACKAGE_SURFACE.md
CHANGED
|
@@ -64,6 +64,7 @@ Expo storage or Convex helpers.
|
|
|
64
64
|
- `@open-e2ee/signal-protocol-sdk/remote/relay`
|
|
65
65
|
- `@open-e2ee/signal-protocol-sdk/remote/relay/convex`
|
|
66
66
|
- `@open-e2ee/signal-protocol-sdk/remote/relay/convex/relay`
|
|
67
|
+
- `@open-e2ee/signal-protocol-sdk/remote/relay/convex/server`
|
|
67
68
|
- `@open-e2ee/signal-protocol-sdk/remote/relay/mock`
|
|
68
69
|
- `@open-e2ee/signal-protocol-sdk/remote/relay/types`
|
|
69
70
|
- `@open-e2ee/signal-protocol-sdk/remote/object-store`
|
|
@@ -142,24 +143,28 @@ Expo storage or Convex helpers.
|
|
|
142
143
|
|
|
143
144
|
### Relay implementations
|
|
144
145
|
|
|
145
|
-
- `
|
|
146
|
+
- `ConvexSignalProtocolRelayServer` for Convex-backed apps
|
|
146
147
|
- `convexRelay()` for Convex-backed composition
|
|
147
|
-
- `
|
|
148
|
-
-
|
|
148
|
+
- `defineConvexGroupServer()` via the server-only
|
|
149
|
+
`@open-e2ee/signal-protocol-sdk/remote/relay/convex/server` entry point,
|
|
150
|
+
with the `oe-groups` CLI (`npx oe-groups trust-root`) for secret
|
|
151
|
+
initialization and trust-root export
|
|
152
|
+
- `MockSignalProtocolRelayServer` / `mockRelay()` for local development
|
|
153
|
+
- custom implementations via `ISignalProtocolRelayServer`
|
|
149
154
|
|
|
150
155
|
### Storage implementations
|
|
151
156
|
|
|
152
|
-
- `
|
|
157
|
+
- `ExpoSignalProtocolStore` for Expo / React Native
|
|
153
158
|
- `expoStore()` for Expo / React Native composition
|
|
154
159
|
- `@open-e2ee/signal-protocol-sdk/local/store/expo` also exports the Expo helpers
|
|
155
160
|
Signal Protocol composes directly: `getKeyStorage`, `getDatabaseKeyManager`,
|
|
156
161
|
`clearDatabaseKeyCache`, and `createPreKeyMaintenanceStore`
|
|
157
|
-
- `
|
|
158
|
-
- `
|
|
162
|
+
- `IndexedDbSignalProtocolStore` / `indexedDbStore()` for browsers (experimental)
|
|
163
|
+
- `ReactNativeSignalProtocolStore` / `reactNativeStore()` for bare React Native
|
|
159
164
|
(experimental; provide your own key-value backend)
|
|
160
|
-
- `
|
|
161
|
-
- `
|
|
162
|
-
- custom implementations via `
|
|
165
|
+
- `NodeSignalProtocolStore` / `nodeStore()` for Node environments
|
|
166
|
+
- `MockSignalProtocolStore` / `mockStore()` for local development
|
|
167
|
+
- custom implementations via `ISignalProtocolLocalStore`
|
|
163
168
|
|
|
164
169
|
### Remote object storage
|
|
165
170
|
|
|
@@ -171,7 +176,7 @@ Expo storage or Convex helpers.
|
|
|
171
176
|
point
|
|
172
177
|
- `S3ObjectStore` via `@open-e2ee/signal-protocol-sdk/remote/object-store/s3`
|
|
173
178
|
- `s3ObjectStore()` for brokered Amazon S3 or S3-compatible storage
|
|
174
|
-
- custom implementations via `
|
|
179
|
+
- custom implementations via `SignalProtocolRemoteObjectStore`
|
|
175
180
|
|
|
176
181
|
`ConvexR2ObjectStore` is a client adapter for authenticated app-owned Convex
|
|
177
182
|
functions that wrap `@convex-dev/r2`; it is not the Convex component itself.
|
package/docs/RECIPES.md
CHANGED
|
@@ -13,7 +13,7 @@ uses public exports only.
|
|
|
13
13
|
This local demo sends while Bob is offline so you can see the relay's encrypted
|
|
14
14
|
envelope and Bob's decrypted plaintext in the same workflow.
|
|
15
15
|
|
|
16
|
-
<!-- mock-snippet:run recipes-two-local-clients -->
|
|
16
|
+
<!-- mock-snippet:run recipes-two-local-clients expect="bob decrypted: alice: hello" -->
|
|
17
17
|
```ts
|
|
18
18
|
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
19
19
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
@@ -99,12 +99,12 @@ Bob through the `onMessageDecrypted` hook.
|
|
|
99
99
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
100
100
|
import {
|
|
101
101
|
convexRelay,
|
|
102
|
-
type
|
|
102
|
+
type ConvexSignalProtocolRelayApi,
|
|
103
103
|
} from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
|
|
104
104
|
import { expoStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
|
|
105
105
|
import { api } from "../convex/_generated/api";
|
|
106
106
|
|
|
107
|
-
const signalApi = api.signal satisfies
|
|
107
|
+
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
108
108
|
|
|
109
109
|
// The relay handles server-side public keys, devices, and encrypted envelopes.
|
|
110
110
|
const relay = convexRelay({
|
|
@@ -135,7 +135,7 @@ before creating the client.
|
|
|
135
135
|
|
|
136
136
|
## Local development
|
|
137
137
|
|
|
138
|
-
<!-- mock-snippet:run recipes-local-development -->
|
|
138
|
+
<!-- mock-snippet:run recipes-local-development expect="" -->
|
|
139
139
|
```ts
|
|
140
140
|
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
141
141
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
|
|
25
25
|
##### logger?
|
|
26
26
|
|
|
27
|
-
`Required`\<[`ILogger`](../interfaces/ILogger.md)\> = `
|
|
27
|
+
`Required`\<[`ILogger`](../interfaces/ILogger.md)\> = `defaultSignalProtocolLogger`
|
|
28
28
|
|
|
29
29
|
#### Returns
|
|
30
30
|
|
|
@@ -32,6 +32,24 @@
|
|
|
32
32
|
|
|
33
33
|
## Methods
|
|
34
34
|
|
|
35
|
+
### assertEndorsementRootPublicKey()
|
|
36
|
+
|
|
37
|
+
> **assertEndorsementRootPublicKey**(`expected`): `void`
|
|
38
|
+
|
|
39
|
+
Require this verifier to use the endorsement root pinned by group config.
|
|
40
|
+
|
|
41
|
+
#### Parameters
|
|
42
|
+
|
|
43
|
+
##### expected
|
|
44
|
+
|
|
45
|
+
[`ServerRootPublicKey`](ServerRootPublicKey.md)
|
|
46
|
+
|
|
47
|
+
#### Returns
|
|
48
|
+
|
|
49
|
+
`void`
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
35
53
|
### clearGroupEndorsements()
|
|
36
54
|
|
|
37
55
|
> **clearGroupEndorsements**(`groupId`): `Promise`\<`void`\>
|
|
@@ -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) / SignalProtocolBlockingManager
|
|
6
6
|
|
|
7
|
-
# Class:
|
|
7
|
+
# Class: SignalProtocolBlockingManager
|
|
8
8
|
|
|
9
9
|
SDK blocking orchestration.
|
|
10
10
|
|
|
@@ -15,17 +15,17 @@ project that state elsewhere without becoming a second mutation path.
|
|
|
15
15
|
|
|
16
16
|
### Constructor
|
|
17
17
|
|
|
18
|
-
> **new
|
|
18
|
+
> **new SignalProtocolBlockingManager**(`options`): `SignalProtocolBlockingManager`
|
|
19
19
|
|
|
20
20
|
#### Parameters
|
|
21
21
|
|
|
22
22
|
##### options
|
|
23
23
|
|
|
24
|
-
[`
|
|
24
|
+
[`SignalProtocolBlockingManagerOptions`](../interfaces/SignalProtocolBlockingManagerOptions.md)
|
|
25
25
|
|
|
26
26
|
#### Returns
|
|
27
27
|
|
|
28
|
-
`
|
|
28
|
+
`SignalProtocolBlockingManager`
|
|
29
29
|
|
|
30
30
|
## Methods
|
|
31
31
|
|
|
@@ -138,11 +138,11 @@ Accept an authenticated composite-identity rotation and reset bound sessions.
|
|
|
138
138
|
|
|
139
139
|
***
|
|
140
140
|
|
|
141
|
-
###
|
|
141
|
+
### addGroupMember()
|
|
142
142
|
|
|
143
|
-
> **
|
|
143
|
+
> **addGroupMember**(`groupId`, `editorAci`, `newMemberAci`, `newMemberProfileKey`): `Promise`\<`void`\>
|
|
144
144
|
|
|
145
|
-
Add a member to a
|
|
145
|
+
Add a member to a group.
|
|
146
146
|
|
|
147
147
|
#### Parameters
|
|
148
148
|
|
|
@@ -329,11 +329,59 @@ Confirm an authenticated comparison of the currently displayed tuple.
|
|
|
329
329
|
|
|
330
330
|
***
|
|
331
331
|
|
|
332
|
-
###
|
|
332
|
+
### createGroup()
|
|
333
333
|
|
|
334
|
-
> **
|
|
334
|
+
> **createGroup**(`creatorAci`, `creatorProfileKey`, `members`, `title`, `options?`): `Promise`\<\{ `groupId`: [`GroupId`](../type-aliases/GroupId.md); `masterKey`: `Uint8Array`; \}\>
|
|
335
335
|
|
|
336
|
-
Create
|
|
336
|
+
Create a new group.
|
|
337
|
+
|
|
338
|
+
#### Parameters
|
|
339
|
+
|
|
340
|
+
##### creatorAci
|
|
341
|
+
|
|
342
|
+
`Uint8Array`
|
|
343
|
+
|
|
344
|
+
##### creatorProfileKey
|
|
345
|
+
|
|
346
|
+
`Uint8Array`
|
|
347
|
+
|
|
348
|
+
##### members
|
|
349
|
+
|
|
350
|
+
`object`[]
|
|
351
|
+
|
|
352
|
+
##### title
|
|
353
|
+
|
|
354
|
+
`string`
|
|
355
|
+
|
|
356
|
+
##### options?
|
|
357
|
+
|
|
358
|
+
###### accessControl?
|
|
359
|
+
|
|
360
|
+
`Partial`\<`AccessControl`\>
|
|
361
|
+
|
|
362
|
+
###### avatarUrl?
|
|
363
|
+
|
|
364
|
+
`string`
|
|
365
|
+
|
|
366
|
+
###### description?
|
|
367
|
+
|
|
368
|
+
`string`
|
|
369
|
+
|
|
370
|
+
###### disappearingMessagesDuration?
|
|
371
|
+
|
|
372
|
+
`number`
|
|
373
|
+
|
|
374
|
+
#### Returns
|
|
375
|
+
|
|
376
|
+
`Promise`\<\{ `groupId`: [`GroupId`](../type-aliases/GroupId.md); `masterKey`: `Uint8Array`; \}\>
|
|
377
|
+
|
|
378
|
+
***
|
|
379
|
+
|
|
380
|
+
### createGroupInviteLink()
|
|
381
|
+
|
|
382
|
+
> **createGroupInviteLink**(`groupId`, `editorAci`): `Promise`\<`string`\>
|
|
383
|
+
|
|
384
|
+
Create an invite link for a group.
|
|
337
385
|
|
|
338
386
|
#### Parameters
|
|
339
387
|
|
|
@@ -393,54 +441,6 @@ for (const member of groupMembers) {
|
|
|
393
441
|
|
|
394
442
|
***
|
|
395
443
|
|
|
396
|
-
### createGroupV2()
|
|
397
|
-
|
|
398
|
-
> **createGroupV2**(`creatorAci`, `creatorProfileKey`, `members`, `title`, `options?`): `Promise`\<\{ `groupId`: [`GroupId`](../type-aliases/GroupId.md); `masterKey`: `Uint8Array`; \}\>
|
|
399
|
-
|
|
400
|
-
Create a new GroupsV2 group.
|
|
401
|
-
|
|
402
|
-
#### Parameters
|
|
403
|
-
|
|
404
|
-
##### creatorAci
|
|
405
|
-
|
|
406
|
-
`Uint8Array`
|
|
407
|
-
|
|
408
|
-
##### creatorProfileKey
|
|
409
|
-
|
|
410
|
-
`Uint8Array`
|
|
411
|
-
|
|
412
|
-
##### members
|
|
413
|
-
|
|
414
|
-
`object`[]
|
|
415
|
-
|
|
416
|
-
##### title
|
|
417
|
-
|
|
418
|
-
`string`
|
|
419
|
-
|
|
420
|
-
##### options?
|
|
421
|
-
|
|
422
|
-
###### accessControl?
|
|
423
|
-
|
|
424
|
-
`Partial`\<`AccessControl`\>
|
|
425
|
-
|
|
426
|
-
###### avatarUrl?
|
|
427
|
-
|
|
428
|
-
`string`
|
|
429
|
-
|
|
430
|
-
###### description?
|
|
431
|
-
|
|
432
|
-
`string`
|
|
433
|
-
|
|
434
|
-
###### disappearingMessagesDuration?
|
|
435
|
-
|
|
436
|
-
`number`
|
|
437
|
-
|
|
438
|
-
#### Returns
|
|
439
|
-
|
|
440
|
-
`Promise`\<\{ `groupId`: [`GroupId`](../type-aliases/GroupId.md); `masterKey`: `Uint8Array`; \}\>
|
|
441
|
-
|
|
442
|
-
***
|
|
443
|
-
|
|
444
444
|
### decryptFile()
|
|
445
445
|
|
|
446
446
|
> **decryptFile**(`remoteAddress`, `encryptedBlob`, `encryptedKey`): `Promise`\<`Blob`\>
|
|
@@ -1167,9 +1167,9 @@ console.log(`${stats.skippedKeysCount} skipped keys stored`);
|
|
|
1167
1167
|
|
|
1168
1168
|
***
|
|
1169
1169
|
|
|
1170
|
-
###
|
|
1170
|
+
### getGroupState()
|
|
1171
1171
|
|
|
1172
|
-
> **
|
|
1172
|
+
> **getGroupState**(`groupId`): `Promise`\<[`DecryptedGroup`](../interfaces/DecryptedGroup.md)\>
|
|
1173
1173
|
|
|
1174
1174
|
Get decrypted group state (from cache or server).
|
|
1175
1175
|
|
|
@@ -1378,11 +1378,11 @@ True if identity keys exist and client is ready to use
|
|
|
1378
1378
|
|
|
1379
1379
|
***
|
|
1380
1380
|
|
|
1381
|
-
###
|
|
1381
|
+
### joinGroupViaInviteLink()
|
|
1382
1382
|
|
|
1383
|
-
> **
|
|
1383
|
+
> **joinGroupViaInviteLink**(`url`, `userAci`, `userProfileKey`): `Promise`\<\{ `groupId`: [`GroupId`](../type-aliases/GroupId.md); `status`: `"joined"` \| `"pending_approval"`; \}\>
|
|
1384
1384
|
|
|
1385
|
-
Join a
|
|
1385
|
+
Join a group via invite link.
|
|
1386
1386
|
|
|
1387
1387
|
#### Parameters
|
|
1388
1388
|
|
|
@@ -1404,11 +1404,11 @@ Join a GroupsV2 group via invite link.
|
|
|
1404
1404
|
|
|
1405
1405
|
***
|
|
1406
1406
|
|
|
1407
|
-
###
|
|
1407
|
+
### leaveGroup()
|
|
1408
1408
|
|
|
1409
|
-
> **
|
|
1409
|
+
> **leaveGroup**(`groupId`, `userAci`): `Promise`\<`void`\>
|
|
1410
1410
|
|
|
1411
|
-
Leave a
|
|
1411
|
+
Leave a group.
|
|
1412
1412
|
|
|
1413
1413
|
#### Parameters
|
|
1414
1414
|
|
|
@@ -1692,11 +1692,11 @@ ISignalProtocolClient.registerHook
|
|
|
1692
1692
|
|
|
1693
1693
|
***
|
|
1694
1694
|
|
|
1695
|
-
###
|
|
1695
|
+
### removeGroupMember()
|
|
1696
1696
|
|
|
1697
|
-
> **
|
|
1697
|
+
> **removeGroupMember**(`groupId`, `editorAci`, `targetAci`): `Promise`\<`void`\>
|
|
1698
1698
|
|
|
1699
|
-
Remove a member from a
|
|
1699
|
+
Remove a member from a group. Triggers sender key rotation.
|
|
1700
1700
|
|
|
1701
1701
|
#### Parameters
|
|
1702
1702
|
|
|
@@ -1785,7 +1785,7 @@ Per Signal Protocol specification, rotate sender keys on **membership changes**:
|
|
|
1785
1785
|
| Member ADDED | Distribute current key to new member (no rotation needed) |
|
|
1786
1786
|
| Group metadata changed | Rotate recommended |
|
|
1787
1787
|
|
|
1788
|
-
**Important**: The
|
|
1788
|
+
**Important**: The reference implementation does NOT use periodic or message-count-based rotation.
|
|
1789
1789
|
Only rotate when membership changes to maintain forward secrecy.
|
|
1790
1790
|
|
|
1791
1791
|
## Why Rotate on Member Removal?
|
|
@@ -1919,7 +1919,7 @@ All inputs are normalized to Uint8Array before reaching the cipher layer.
|
|
|
1919
1919
|
|
|
1920
1920
|
`string`
|
|
1921
1921
|
|
|
1922
|
-
User ID or group ID (groups use the
|
|
1922
|
+
User ID or group ID (groups use the package group ID prefix)
|
|
1923
1923
|
|
|
1924
1924
|
##### content
|
|
1925
1925
|
|
|
@@ -2216,9 +2216,9 @@ Sync local account-level communication/privacy configuration to our other linked
|
|
|
2216
2216
|
|
|
2217
2217
|
***
|
|
2218
2218
|
|
|
2219
|
-
###
|
|
2219
|
+
### syncGroup()
|
|
2220
2220
|
|
|
2221
|
-
> **
|
|
2221
|
+
> **syncGroup**(`groupId`): `Promise`\<[`DecryptedGroup`](../interfaces/DecryptedGroup.md)\>
|
|
2222
2222
|
|
|
2223
2223
|
Sync group state from server.
|
|
2224
2224
|
|
|
@@ -2427,11 +2427,11 @@ Sync a local view-once open event to our other linked devices.
|
|
|
2427
2427
|
|
|
2428
2428
|
***
|
|
2429
2429
|
|
|
2430
|
-
###
|
|
2430
|
+
### updateGroupAccessControl()
|
|
2431
2431
|
|
|
2432
|
-
> **
|
|
2432
|
+
> **updateGroupAccessControl**(`groupId`, `editorAci`, `updates`): `Promise`\<`void`\>
|
|
2433
2433
|
|
|
2434
|
-
Update
|
|
2434
|
+
Update a group's access control.
|
|
2435
2435
|
|
|
2436
2436
|
#### Parameters
|
|
2437
2437
|
|
|
@@ -2453,11 +2453,11 @@ Update GroupsV2 group access control.
|
|
|
2453
2453
|
|
|
2454
2454
|
***
|
|
2455
2455
|
|
|
2456
|
-
###
|
|
2456
|
+
### updateGroupDescription()
|
|
2457
2457
|
|
|
2458
|
-
> **
|
|
2458
|
+
> **updateGroupDescription**(`groupId`, `editorAci`, `description`): `Promise`\<`void`\>
|
|
2459
2459
|
|
|
2460
|
-
Update
|
|
2460
|
+
Update a group's description.
|
|
2461
2461
|
|
|
2462
2462
|
#### Parameters
|
|
2463
2463
|
|
|
@@ -2479,11 +2479,11 @@ Update GroupsV2 group description.
|
|
|
2479
2479
|
|
|
2480
2480
|
***
|
|
2481
2481
|
|
|
2482
|
-
###
|
|
2482
|
+
### updateGroupTitle()
|
|
2483
2483
|
|
|
2484
|
-
> **
|
|
2484
|
+
> **updateGroupTitle**(`groupId`, `editorAci`, `title`): `Promise`\<`void`\>
|
|
2485
2485
|
|
|
2486
|
-
Update
|
|
2486
|
+
Update a group's title.
|
|
2487
2487
|
|
|
2488
2488
|
#### Parameters
|
|
2489
2489
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / createDefaultSignalProtocolContentAdapter
|
|
6
|
+
|
|
7
|
+
# Function: createDefaultSignalProtocolContentAdapter()
|
|
8
|
+
|
|
9
|
+
> **createDefaultSignalProtocolContentAdapter**(): [`SignalProtocolContentAdapter`](../interfaces/SignalProtocolContentAdapter.md)
|
|
10
|
+
|
|
11
|
+
## Returns
|
|
12
|
+
|
|
13
|
+
[`SignalProtocolContentAdapter`](../interfaces/SignalProtocolContentAdapter.md)
|
package/docs/api/functions/{createDefaultSignalLogger.md → createDefaultSignalProtocolLogger.md}
RENAMED
|
@@ -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) / createDefaultSignalProtocolLogger
|
|
6
6
|
|
|
7
|
-
# Function:
|
|
7
|
+
# Function: createDefaultSignalProtocolLogger()
|
|
8
8
|
|
|
9
|
-
> **
|
|
9
|
+
> **createDefaultSignalProtocolLogger**(): [`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
|
## Returns
|
|
17
17
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / decodeGroupTrustRoot
|
|
6
|
+
|
|
7
|
+
# Function: decodeGroupTrustRoot()
|
|
8
|
+
|
|
9
|
+
> **decodeGroupTrustRoot**(`encoded`): [`GroupTrustRoot`](../interfaces/GroupTrustRoot.md)
|
|
10
|
+
|
|
11
|
+
Decode and validate a versioned group trust-root blob.
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
### encoded
|
|
16
|
+
|
|
17
|
+
`Uint8Array`
|
|
18
|
+
|
|
19
|
+
## Returns
|
|
20
|
+
|
|
21
|
+
[`GroupTrustRoot`](../interfaces/GroupTrustRoot.md)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / encodeGroupTrustRoot
|
|
6
|
+
|
|
7
|
+
# Function: encodeGroupTrustRoot()
|
|
8
|
+
|
|
9
|
+
> **encodeGroupTrustRoot**(`trustRoot`): `Uint8Array`
|
|
10
|
+
|
|
11
|
+
Encode a group trust root into its versioned binary representation.
|
|
12
|
+
|
|
13
|
+
Version 1 is fixed-width:
|
|
14
|
+
`version || signing-key length || credential key || signing key ||
|
|
15
|
+
profile-key credential key || endorsement root`.
|
|
16
|
+
|
|
17
|
+
The signing-key length is either 32 for a conforming S9/S14 deployment or
|
|
18
|
+
zero for §12.3's explicitly selected non-conforming mode.
|
|
19
|
+
|
|
20
|
+
## Parameters
|
|
21
|
+
|
|
22
|
+
### trustRoot
|
|
23
|
+
|
|
24
|
+
[`GroupTrustRoot`](../interfaces/GroupTrustRoot.md)
|
|
25
|
+
|
|
26
|
+
## Returns
|
|
27
|
+
|
|
28
|
+
`Uint8Array`
|
|
@@ -27,6 +27,6 @@ Raw group ID without prefix
|
|
|
27
27
|
## Example
|
|
28
28
|
|
|
29
29
|
```typescript
|
|
30
|
-
extractGroupId('
|
|
31
|
-
extractGroupId('abc123');
|
|
30
|
+
extractGroupId('open-e2ee:group:abc123'); // 'abc123'
|
|
31
|
+
extractGroupId('abc123'); // 'abc123' (no prefix)
|
|
32
32
|
```
|
|
@@ -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) / resolveSignalProtocolLogger
|
|
6
6
|
|
|
7
|
-
# Function:
|
|
7
|
+
# Function: resolveSignalProtocolLogger()
|
|
8
8
|
|
|
9
|
-
> **
|
|
9
|
+
> **resolveSignalProtocolLogger**(`logger?`): `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
|
## Parameters
|
|
17
17
|
|