@open-e2ee/signal-protocol-sdk 2.0.2 → 4.0.0
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 +14 -21
- package/ARCHITECTURE.md +1 -2
- package/CHANGELOG.md +90 -0
- package/LICENSE +11 -655
- package/LICENSE-APACHE +201 -0
- package/LICENSE-MIT +21 -0
- package/NOTICE +5 -7
- package/README.md +11 -11
- package/SECURITY.md +2 -2
- package/TROUBLESHOOTING.md +6 -10
- package/client/README.md +36 -18
- package/device/README.md +1 -1
- package/dist/blocking/manager.d.ts +2 -2
- package/dist/blocking/manager.d.ts.map +1 -1
- package/dist/blocking/manager.js.map +1 -1
- package/dist/client/client.d.ts +45 -34
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +178 -115
- package/dist/client/client.js.map +1 -1
- package/dist/client/compose.d.ts +7 -7
- package/dist/client/compose.d.ts.map +1 -1
- package/dist/client/compose.js +2 -2
- package/dist/client/compose.js.map +1 -1
- package/dist/client/config.d.ts +24 -28
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/config.js.map +1 -1
- package/dist/client/content-adapter.d.ts +2 -0
- package/dist/client/content-adapter.d.ts.map +1 -1
- package/dist/client/content-adapter.js +4 -0
- 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 +6 -3
- package/dist/client/endorsement-manager.d.ts.map +1 -1
- package/dist/client/endorsement-manager.js +14 -6
- package/dist/client/endorsement-manager.js.map +1 -1
- package/dist/client/files.d.ts +1 -1
- package/dist/client/files.js +1 -1
- package/dist/client/group-authority.d.ts +8 -0
- package/dist/client/group-authority.d.ts.map +1 -0
- package/dist/client/group-authority.js +2 -0
- package/dist/client/group-authority.js.map +1 -0
- package/dist/client/group-outbox.d.ts +4 -4
- package/dist/client/group-outbox.d.ts.map +1 -1
- package/dist/client/group-sealed-sender.d.ts +2 -2
- package/dist/client/group-sealed-sender.d.ts.map +1 -1
- package/dist/client/groups.d.ts +1 -1
- package/dist/client/groups.js +1 -1
- package/dist/client/headless.d.ts +11 -16
- package/dist/client/headless.d.ts.map +1 -1
- package/dist/client/headless.js +4 -9
- package/dist/client/headless.js.map +1 -1
- package/dist/client/hosted-anonymous-delivery.d.ts +32 -0
- package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -0
- package/dist/client/hosted-anonymous-delivery.js +239 -0
- package/dist/client/hosted-anonymous-delivery.js.map +1 -0
- package/dist/client/hosted-connection.d.ts +1 -1
- package/dist/client/hosted-connection.d.ts.map +1 -1
- package/dist/client/hosted-connection.js +18 -51
- package/dist/client/hosted-connection.js.map +1 -1
- package/dist/client/hosted-group-authority.d.ts +11 -0
- package/dist/client/hosted-group-authority.d.ts.map +1 -0
- package/dist/client/hosted-group-authority.js +96 -0
- package/dist/client/hosted-group-authority.js.map +1 -0
- package/dist/client/hosted-groups.d.ts +31 -0
- package/dist/client/hosted-groups.d.ts.map +1 -0
- package/dist/client/hosted-groups.js +217 -0
- package/dist/client/hosted-groups.js.map +1 -0
- package/dist/client/hosted-mailbox-subscription.d.ts +34 -0
- package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -0
- package/dist/client/hosted-mailbox-subscription.js +257 -0
- package/dist/client/hosted-mailbox-subscription.js.map +1 -0
- package/dist/client/hosted-prekey-publication.d.ts +51 -0
- package/dist/client/hosted-prekey-publication.d.ts.map +1 -0
- package/dist/client/hosted-prekey-publication.js +249 -0
- package/dist/client/hosted-prekey-publication.js.map +1 -0
- package/dist/client/hosted-push.d.ts +5 -6
- package/dist/client/hosted-push.d.ts.map +1 -1
- package/dist/client/hosted-push.js +22 -22
- package/dist/client/hosted-push.js.map +1 -1
- package/dist/client/hosted-transport.d.ts +62 -40
- package/dist/client/hosted-transport.d.ts.map +1 -1
- package/dist/client/hosted-transport.js +666 -341
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/hosted-trust.d.ts +29 -0
- package/dist/client/hosted-trust.d.ts.map +1 -0
- package/dist/client/hosted-trust.js +28 -0
- package/dist/client/hosted-trust.js.map +1 -0
- package/dist/client/hosted.d.ts +26 -21
- package/dist/client/hosted.d.ts.map +1 -1
- package/dist/client/hosted.js +80 -36
- package/dist/client/hosted.js.map +1 -1
- package/dist/client/index.d.ts +15 -15
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +7 -7
- package/dist/client/index.js.map +1 -1
- package/dist/client/key-rotation-core.d.ts +16 -8
- package/dist/client/key-rotation-core.d.ts.map +1 -1
- package/dist/client/key-rotation-core.js +14 -3
- package/dist/client/key-rotation-core.js.map +1 -1
- package/dist/client/key-rotation.d.ts +3 -2
- package/dist/client/key-rotation.d.ts.map +1 -1
- package/dist/client/key-rotation.js +5 -5
- package/dist/client/key-rotation.js.map +1 -1
- package/dist/client/media-queue-persistence.d.ts +14 -0
- package/dist/client/media-queue-persistence.d.ts.map +1 -0
- package/dist/client/media-queue-persistence.js +123 -0
- package/dist/client/media-queue-persistence.js.map +1 -0
- package/dist/client/media-upload-budget.d.ts +3 -0
- package/dist/client/media-upload-budget.d.ts.map +1 -0
- package/dist/client/media-upload-budget.js +27 -0
- package/dist/client/media-upload-budget.js.map +1 -0
- package/dist/client/media.d.ts +51 -15
- package/dist/client/media.d.ts.map +1 -1
- package/dist/client/media.js +541 -73
- package/dist/client/media.js.map +1 -1
- package/dist/client/messages.d.ts +1 -1
- package/dist/client/messages.d.ts.map +1 -1
- package/dist/client/messages.js +14 -15
- package/dist/client/messages.js.map +1 -1
- package/dist/client/multi-device.d.ts +1 -1
- package/dist/client/multi-device.js +1 -1
- package/dist/client/prekeys.d.ts +1 -1
- package/dist/client/prekeys.d.ts.map +1 -1
- package/dist/client/prekeys.js +132 -44
- package/dist/client/prekeys.js.map +1 -1
- package/dist/client/relay-subscription.d.ts +5 -1
- package/dist/client/relay-subscription.d.ts.map +1 -1
- package/dist/client/relay-subscription.js +59 -26
- package/dist/client/relay-subscription.js.map +1 -1
- package/dist/client/retry.d.ts +3 -3
- package/dist/client/retry.d.ts.map +1 -1
- package/dist/client/retry.js +1 -1
- package/dist/client/retry.js.map +1 -1
- package/dist/client/sealed-sender.d.ts +5 -5
- package/dist/client/sealed-sender.d.ts.map +1 -1
- package/dist/client/sealed-sender.js.map +1 -1
- package/dist/client/sender-key-distribution.d.ts +8 -0
- package/dist/client/sender-key-distribution.d.ts.map +1 -0
- package/dist/client/sender-key-distribution.js +59 -0
- package/dist/client/sender-key-distribution.js.map +1 -0
- package/dist/client/sessions.d.ts +3 -3
- package/dist/client/sessions.d.ts.map +1 -1
- package/dist/client/sessions.js +1 -1
- package/dist/client/sessions.js.map +1 -1
- package/dist/client/signal-service-cipher.d.ts +12 -8
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +41 -16
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/state.d.ts +1 -1
- package/dist/client/state.js +1 -1
- package/dist/client/types.d.ts +10 -10
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js +1 -1
- package/dist/device/connection.d.ts.map +1 -1
- package/dist/device/connection.js.map +1 -1
- package/dist/device/device-id.d.ts +2 -2
- package/dist/device/device-id.d.ts.map +1 -1
- package/dist/device/device-id.js.map +1 -1
- package/dist/device/{expo-metadata.d.ts → expo/index.d.ts} +3 -3
- package/dist/device/expo/index.d.ts.map +1 -0
- package/dist/device/{expo-metadata.js → expo/index.js} +2 -2
- package/dist/device/expo/index.js.map +1 -0
- package/dist/device/index.d.ts +1 -1
- package/dist/device/index.d.ts.map +1 -1
- package/dist/device/index.js +1 -1
- package/dist/device/index.js.map +1 -1
- package/dist/device/lifecycle/index.d.ts +1 -1
- package/dist/device/lifecycle/index.d.ts.map +1 -1
- package/dist/device/lifecycle/types.d.ts +8 -8
- package/dist/device/lifecycle/types.d.ts.map +1 -1
- package/dist/device/provisioning.d.ts +13 -13
- package/dist/device/provisioning.d.ts.map +1 -1
- package/dist/device/provisioning.js +1 -1
- package/dist/device/provisioning.js.map +1 -1
- package/dist/device/transfer.d.ts +13 -13
- package/dist/device/transfer.d.ts.map +1 -1
- package/dist/device/transfer.js.map +1 -1
- package/dist/device/types.d.ts +3 -3
- package/dist/device/types.d.ts.map +1 -1
- package/dist/groups/index.d.ts +1 -1
- package/dist/groups/index.d.ts.map +1 -1
- package/dist/groups/server.d.ts +10 -0
- package/dist/groups/server.d.ts.map +1 -0
- package/dist/groups/server.js +6 -0
- package/dist/groups/server.js.map +1 -0
- package/dist/hooks/use-connection-presence.d.ts +6 -8
- package/dist/hooks/use-connection-presence.d.ts.map +1 -1
- package/dist/hooks/use-connection-presence.js +2 -4
- package/dist/hooks/use-connection-presence.js.map +1 -1
- package/dist/hooks/use-group-membership.d.ts +2 -2
- package/dist/hooks/use-group-membership.d.ts.map +1 -1
- package/dist/hooks/use-group-membership.js.map +1 -1
- package/dist/hooks/use-key-rotation.d.ts +2 -2
- package/dist/hooks/use-key-rotation.d.ts.map +1 -1
- package/dist/hooks/use-session-health.d.ts +2 -2
- package/dist/hooks/use-session-health.d.ts.map +1 -1
- package/dist/index.d.ts +57 -55
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +27 -26
- package/dist/index.js.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.d.ts +4 -4
- package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
- package/dist/internal/groups/authority-certificate.d.ts +22 -0
- package/dist/internal/groups/authority-certificate.d.ts.map +1 -0
- package/dist/internal/groups/authority-certificate.js +99 -0
- package/dist/internal/groups/authority-certificate.js.map +1 -0
- package/dist/internal/groups/error-details.d.ts +9 -0
- package/dist/internal/groups/error-details.d.ts.map +1 -0
- package/dist/internal/groups/error-details.js +30 -0
- package/dist/internal/groups/error-details.js.map +1 -0
- package/dist/internal/groups/index.d.ts +1 -1
- package/dist/internal/groups/index.d.ts.map +1 -1
- package/dist/internal/groups/manager.d.ts +9 -4
- package/dist/internal/groups/manager.d.ts.map +1 -1
- package/dist/internal/groups/manager.js +3 -0
- package/dist/internal/groups/manager.js.map +1 -1
- package/dist/internal/groups/sdk-store.d.ts +4 -4
- package/dist/internal/groups/sdk-store.d.ts.map +1 -1
- package/dist/internal/groups/sdk-store.js.map +1 -1
- package/dist/internal/groups/server-engine.d.ts +9 -2
- package/dist/internal/groups/server-engine.d.ts.map +1 -1
- package/dist/internal/groups/server-engine.js +51 -19
- package/dist/internal/groups/server-engine.js.map +1 -1
- package/dist/internal/groups/wire.d.ts.map +1 -1
- package/dist/internal/groups/wire.js +10 -9
- package/dist/internal/groups/wire.js.map +1 -1
- package/dist/internal/manager/index.d.ts +2 -2
- package/dist/internal/manager/index.d.ts.map +1 -1
- package/dist/internal/manager/index.js +1 -1
- package/dist/internal/manager/index.js.map +1 -1
- package/dist/internal/manager/manager.d.ts +23 -23
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +40 -43
- package/dist/internal/manager/manager.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.d.ts +9 -9
- package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
- 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.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.d.ts +3 -3
- package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts +4 -4
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +27 -14
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/authenticator.d.ts +3 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/authenticator.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.d.ts +3 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/index.d.ts +2 -2
- package/dist/internal/protocol/spqr/ml-kem-braid/index.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/index.js +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/index.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.d.ts +3 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js +2 -2
- package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js.map +1 -1
- package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts +3 -3
- package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts +5 -5
- package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.js.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +4 -4
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/x3dh/x3dh.d.ts +3 -3
- package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
- package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
- package/dist/internal/sesame/device-registry.d.ts +16 -16
- package/dist/internal/sesame/device-registry.d.ts.map +1 -1
- package/dist/internal/sesame/device-registry.js +6 -6
- package/dist/internal/sesame/device-registry.js.map +1 -1
- package/dist/internal/sesame/index.d.ts +4 -4
- package/dist/internal/sesame/index.d.ts.map +1 -1
- package/dist/internal/sesame/index.js +2 -2
- package/dist/internal/sesame/index.js.map +1 -1
- package/dist/internal/sesame/manager.d.ts +10 -10
- package/dist/internal/sesame/manager.d.ts.map +1 -1
- package/dist/internal/sesame/manager.js +13 -13
- package/dist/internal/sesame/manager.js.map +1 -1
- package/dist/internal/sesame/types.d.ts +5 -5
- package/dist/internal/sesame/types.d.ts.map +1 -1
- package/dist/internal/session/cipher.d.ts +4 -4
- package/dist/internal/session/cipher.d.ts.map +1 -1
- package/dist/internal/session/cipher.js +31 -28
- package/dist/internal/session/cipher.js.map +1 -1
- package/dist/internal/session/decryption.js.map +1 -1
- package/dist/internal/session/factory.d.ts +3 -3
- package/dist/internal/session/factory.d.ts.map +1 -1
- package/dist/internal/session/factory.js.map +1 -1
- package/dist/internal/session/handshake.d.ts +2 -2
- package/dist/internal/session/handshake.d.ts.map +1 -1
- package/dist/internal/session/handshake.js.map +1 -1
- package/dist/internal/session/ratchet.d.ts +4 -4
- package/dist/internal/session/ratchet.d.ts.map +1 -1
- package/dist/internal/session/ratchet.js.map +1 -1
- package/dist/internal/session/types.d.ts +5 -5
- package/dist/internal/session/types.d.ts.map +1 -1
- package/dist/internal/session/validation.d.ts +3 -3
- package/dist/internal/session/validation.d.ts.map +1 -1
- package/dist/internal/session/validation.js.map +1 -1
- package/dist/layers.d.ts +4 -4
- package/dist/layers.d.ts.map +1 -1
- package/dist/layers.js +12 -12
- package/dist/layers.js.map +1 -1
- package/dist/local/store/expo/adapter.d.ts +15 -9
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +29 -10
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/expo/database-key.d.ts +5 -5
- package/dist/local/store/expo/database-key.d.ts.map +1 -1
- package/dist/local/store/expo/database-key.js.map +1 -1
- package/dist/local/store/expo/index.d.ts +3 -3
- package/dist/local/store/expo/index.d.ts.map +1 -1
- package/dist/local/store/expo/key-storage.d.ts +11 -5
- package/dist/local/store/expo/key-storage.d.ts.map +1 -1
- package/dist/local/store/expo/key-storage.js +82 -17
- package/dist/local/store/expo/key-storage.js.map +1 -1
- package/dist/local/store/expo/models/kyber-prekey-used.d.ts +1 -4
- package/dist/local/store/expo/models/kyber-prekey-used.d.ts.map +1 -1
- package/dist/local/store/expo/models/kyber-prekey-used.js +23 -9
- package/dist/local/store/expo/models/kyber-prekey-used.js.map +1 -1
- package/dist/local/store/expo/models/kyber-prekey.d.ts +4 -4
- package/dist/local/store/expo/models/kyber-prekey.d.ts.map +1 -1
- package/dist/local/store/expo/models/kyber-prekey.js +67 -26
- package/dist/local/store/expo/models/kyber-prekey.js.map +1 -1
- package/dist/local/store/expo/schema.d.ts +21 -2
- package/dist/local/store/expo/schema.d.ts.map +1 -1
- package/dist/local/store/expo/schema.js +10 -2
- package/dist/local/store/expo/schema.js.map +1 -1
- package/dist/local/store/index.d.ts +3 -3
- package/dist/local/store/index.d.ts.map +1 -1
- package/dist/local/store/index.js +1 -1
- package/dist/local/store/kyber-prekey-lifecycle.d.ts +46 -0
- package/dist/local/store/kyber-prekey-lifecycle.d.ts.map +1 -0
- package/dist/local/store/kyber-prekey-lifecycle.js +88 -0
- package/dist/local/store/kyber-prekey-lifecycle.js.map +1 -0
- package/dist/local/store/memory/adapter.d.ts +14 -6
- package/dist/local/store/memory/adapter.d.ts.map +1 -1
- package/dist/local/store/memory/adapter.js +114 -29
- package/dist/local/store/memory/adapter.js.map +1 -1
- package/dist/local/store/node/adapter.d.ts +9 -3
- package/dist/local/store/node/adapter.d.ts.map +1 -1
- package/dist/local/store/node/adapter.js +31 -13
- package/dist/local/store/node/adapter.js.map +1 -1
- package/dist/local/store/node/database-file-commit.d.ts +8 -0
- package/dist/local/store/node/database-file-commit.d.ts.map +1 -0
- package/dist/local/store/node/database-file-commit.js +62 -0
- package/dist/local/store/node/database-file-commit.js.map +1 -0
- package/dist/local/store/node/database-key.d.ts +6 -1
- package/dist/local/store/node/database-key.d.ts.map +1 -1
- package/dist/local/store/node/database-key.js +79 -44
- package/dist/local/store/node/database-key.js.map +1 -1
- package/dist/local/store/node/database-lock.d.ts +8 -0
- package/dist/local/store/node/database-lock.d.ts.map +1 -0
- package/dist/local/store/node/database-lock.js +44 -0
- package/dist/local/store/node/database-lock.js.map +1 -0
- package/dist/local/store/node/database.d.ts +17 -16
- package/dist/local/store/node/database.d.ts.map +1 -1
- package/dist/local/store/node/database.js +197 -202
- package/dist/local/store/node/database.js.map +1 -1
- package/dist/local/store/react-native/adapter.d.ts +10 -4
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +151 -66
- package/dist/local/store/react-native/adapter.js.map +1 -1
- package/dist/local/store/received-content.d.ts +9 -0
- package/dist/local/store/received-content.d.ts.map +1 -0
- package/dist/local/store/received-content.js +46 -0
- package/dist/local/store/received-content.js.map +1 -0
- package/dist/local/store/reliability.d.ts +4 -4
- package/dist/local/store/reliability.d.ts.map +1 -1
- package/dist/local/store/reliability.js +7 -4
- package/dist/local/store/reliability.js.map +1 -1
- package/dist/local/store/web/adapter.d.ts +11 -5
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +207 -74
- package/dist/local/store/web/adapter.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/index.d.ts +1 -1
- package/dist/local/vault/index.d.ts.map +1 -1
- package/dist/logger.d.ts +4 -4
- package/dist/logger.d.ts.map +1 -1
- package/dist/logger.js.map +1 -1
- package/dist/media/index.d.ts +71 -61
- package/dist/media/index.d.ts.map +1 -1
- package/dist/media/index.js +550 -386
- package/dist/media/index.js.map +1 -1
- package/dist/media/prepared-upload.d.ts +37 -0
- package/dist/media/prepared-upload.d.ts.map +1 -0
- package/dist/media/prepared-upload.js +46 -0
- package/dist/media/prepared-upload.js.map +1 -0
- package/dist/profile/contact-state.d.ts +2 -2
- package/dist/profile/contact-state.d.ts.map +1 -1
- package/dist/profile/contact-state.js.map +1 -1
- package/dist/profile/profile-key.d.ts +2 -2
- package/dist/profile/profile-key.d.ts.map +1 -1
- package/dist/profile/profile-key.js.map +1 -1
- package/dist/profile/update-service.d.ts +2 -2
- package/dist/profile/update-service.d.ts.map +1 -1
- package/dist/profile/update-service.js.map +1 -1
- package/dist/remote/object-store/convex-r2/server.d.ts +2 -1
- package/dist/remote/object-store/convex-r2/server.d.ts.map +1 -1
- package/dist/remote/object-store/convex-r2/server.js +4 -0
- package/dist/remote/object-store/convex-r2/server.js.map +1 -1
- package/dist/remote/object-store/convex-r2/storage.d.ts.map +1 -1
- package/dist/remote/object-store/convex-r2/storage.js +1 -0
- package/dist/remote/object-store/convex-r2/storage.js.map +1 -1
- package/dist/remote/object-store/index.d.ts +3 -1
- package/dist/remote/object-store/index.d.ts.map +1 -1
- package/dist/remote/object-store/index.js +1 -1
- package/dist/remote/object-store/index.js.map +1 -1
- package/dist/remote/object-store/s3/storage.d.ts +3 -1
- package/dist/remote/object-store/s3/storage.d.ts.map +1 -1
- package/dist/remote/object-store/s3/storage.js +9 -2
- package/dist/remote/object-store/s3/storage.js.map +1 -1
- package/dist/remote/object-store/types.d.ts +33 -4
- package/dist/remote/object-store/types.d.ts.map +1 -1
- package/dist/remote/object-store/upload-error.d.ts +23 -0
- package/dist/remote/object-store/upload-error.d.ts.map +1 -0
- package/dist/remote/object-store/upload-error.js +33 -0
- package/dist/remote/object-store/upload-error.js.map +1 -0
- package/dist/remote/object-store/validation.d.ts +7 -1
- package/dist/remote/object-store/validation.d.ts.map +1 -1
- package/dist/remote/object-store/validation.js +39 -25
- package/dist/remote/object-store/validation.js.map +1 -1
- package/dist/remote/relay/index.d.ts +7 -14
- package/dist/remote/relay/index.d.ts.map +1 -1
- package/dist/remote/relay/index.js +6 -13
- package/dist/remote/relay/index.js.map +1 -1
- package/dist/remote/relay/memory/adapter.d.ts +5 -4
- package/dist/remote/relay/memory/adapter.d.ts.map +1 -1
- package/dist/remote/relay/memory/adapter.js +14 -4
- package/dist/remote/relay/memory/adapter.js.map +1 -1
- package/dist/remote/relay/types.d.ts +36 -25
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/remote/relay/types.js +1 -1
- package/dist/types/api.d.ts +59 -24
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/index.js +1 -1
- package/dist/types/index.js.map +1 -1
- package/dist/types/session.d.ts +6 -0
- package/dist/types/session.d.ts.map +1 -1
- package/dist/types/session.js.map +1 -1
- package/docs/ASSURANCE.md +7 -7
- package/docs/CLIENT_COMPOSITION.md +16 -23
- package/docs/DEVIATIONS.md +1 -1
- package/docs/DOCUMENTATION_STANDARDS.md +4 -0
- package/docs/ERROR_HANDLING.md +2 -2
- package/docs/GETTING_STARTED.md +23 -38
- package/docs/INTERFACES.md +36 -27
- package/docs/PACKAGE_SURFACE.md +9 -16
- package/docs/RECIPES.md +10 -23
- package/examples/browser/index.html +2 -2
- package/groups/README.md +4 -4
- package/local/store/README.md +22 -7
- package/local/store/expo/README.md +24 -20
- package/local/store/memory/README.md +1 -1
- package/local/store/node/README.md +31 -2
- package/local/store/react-native/README.md +1 -1
- package/local/store/web/README.md +1 -1
- package/local/vault/README.md +1 -1
- package/media/README.md +94 -0
- package/package.json +17 -27
- package/remote/README.md +24 -24
- package/remote/object-store/README.md +8 -0
- package/remote/object-store/s3/README.md +10 -1
- package/remote/relay/README.md +4 -3
- package/remote/relay/memory/README.md +1 -1
- package/types/README.md +2 -2
- package/COMMERCIAL.md +0 -56
- package/dist/device/expo-metadata.d.ts.map +0 -1
- package/dist/device/expo-metadata.js.map +0 -1
- package/dist/remote/relay/convex/backend.d.ts +0 -394
- package/dist/remote/relay/convex/backend.d.ts.map +0 -1
- package/dist/remote/relay/convex/backend.js +0 -678
- package/dist/remote/relay/convex/backend.js.map +0 -1
- package/dist/remote/relay/convex/component/_generated/api.d.ts +0 -58
- package/dist/remote/relay/convex/component/_generated/api.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/_generated/api.js +0 -31
- package/dist/remote/relay/convex/component/_generated/api.js.map +0 -1
- package/dist/remote/relay/convex/component/_generated/component.d.ts +0 -475
- package/dist/remote/relay/convex/component/_generated/component.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/_generated/component.js +0 -11
- package/dist/remote/relay/convex/component/_generated/component.js.map +0 -1
- package/dist/remote/relay/convex/component/_generated/dataModel.d.ts +0 -46
- package/dist/remote/relay/convex/component/_generated/dataModel.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/_generated/dataModel.js +0 -11
- package/dist/remote/relay/convex/component/_generated/dataModel.js.map +0 -1
- package/dist/remote/relay/convex/component/_generated/server.d.ts +0 -129
- package/dist/remote/relay/convex/component/_generated/server.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/_generated/server.js +0 -79
- package/dist/remote/relay/convex/component/_generated/server.js.map +0 -1
- package/dist/remote/relay/convex/component/accounts.d.ts +0 -45
- package/dist/remote/relay/convex/component/accounts.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/accounts.js +0 -184
- package/dist/remote/relay/convex/component/accounts.js.map +0 -1
- package/dist/remote/relay/convex/component/certificates.d.ts +0 -10
- package/dist/remote/relay/convex/component/certificates.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/certificates.js +0 -126
- package/dist/remote/relay/convex/component/certificates.js.map +0 -1
- package/dist/remote/relay/convex/component/cleanup.d.ts +0 -32
- package/dist/remote/relay/convex/component/cleanup.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/cleanup.js +0 -146
- package/dist/remote/relay/convex/component/cleanup.js.map +0 -1
- package/dist/remote/relay/convex/component/convex.config.d.ts +0 -5
- package/dist/remote/relay/convex/component/convex.config.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/convex.config.js +0 -35
- package/dist/remote/relay/convex/component/convex.config.js.map +0 -1
- package/dist/remote/relay/convex/component/crons.d.ts +0 -3
- package/dist/remote/relay/convex/component/crons.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/crons.js +0 -10
- package/dist/remote/relay/convex/component/crons.js.map +0 -1
- package/dist/remote/relay/convex/component/devices.d.ts +0 -102
- package/dist/remote/relay/convex/component/devices.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/devices.js +0 -300
- package/dist/remote/relay/convex/component/devices.js.map +0 -1
- package/dist/remote/relay/convex/component/errors.d.ts +0 -22
- package/dist/remote/relay/convex/component/errors.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/errors.js +0 -17
- package/dist/remote/relay/convex/component/errors.js.map +0 -1
- package/dist/remote/relay/convex/component/groups.d.ts +0 -63
- package/dist/remote/relay/convex/component/groups.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/groups.js +0 -341
- package/dist/remote/relay/convex/component/groups.js.map +0 -1
- package/dist/remote/relay/convex/component/keys.d.ts +0 -130
- package/dist/remote/relay/convex/component/keys.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/keys.js +0 -578
- package/dist/remote/relay/convex/component/keys.js.map +0 -1
- package/dist/remote/relay/convex/component/messages.d.ts +0 -105
- package/dist/remote/relay/convex/component/messages.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/messages.js +0 -702
- package/dist/remote/relay/convex/component/messages.js.map +0 -1
- package/dist/remote/relay/convex/component/provisioning.d.ts +0 -92
- package/dist/remote/relay/convex/component/provisioning.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/provisioning.js +0 -360
- package/dist/remote/relay/convex/component/provisioning.js.map +0 -1
- package/dist/remote/relay/convex/component/runtime.d.ts +0 -18
- package/dist/remote/relay/convex/component/runtime.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/runtime.js +0 -144
- package/dist/remote/relay/convex/component/runtime.js.map +0 -1
- package/dist/remote/relay/convex/component/schema.d.ts +0 -358
- package/dist/remote/relay/convex/component/schema.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/schema.js +0 -288
- package/dist/remote/relay/convex/component/schema.js.map +0 -1
- package/dist/remote/relay/convex/component/zkAuth.d.ts +0 -18
- package/dist/remote/relay/convex/component/zkAuth.d.ts.map +0 -1
- package/dist/remote/relay/convex/component/zkAuth.js +0 -86
- package/dist/remote/relay/convex/component/zkAuth.js.map +0 -1
- package/dist/remote/relay/convex/constants.d.ts +0 -3
- package/dist/remote/relay/convex/constants.d.ts.map +0 -1
- package/dist/remote/relay/convex/constants.js +0 -3
- package/dist/remote/relay/convex/constants.js.map +0 -1
- package/dist/remote/relay/convex/group-server.d.ts +0 -123
- package/dist/remote/relay/convex/group-server.d.ts.map +0 -1
- package/dist/remote/relay/convex/group-server.js +0 -184
- package/dist/remote/relay/convex/group-server.js.map +0 -1
- package/dist/remote/relay/convex/index.d.ts +0 -42
- package/dist/remote/relay/convex/index.d.ts.map +0 -1
- package/dist/remote/relay/convex/index.js +0 -38
- package/dist/remote/relay/convex/index.js.map +0 -1
- package/dist/remote/relay/convex/relay.d.ts +0 -323
- package/dist/remote/relay/convex/relay.d.ts.map +0 -1
- package/dist/remote/relay/convex/relay.js +0 -1144
- package/dist/remote/relay/convex/relay.js.map +0 -1
- package/dist/remote/relay/convex/types.d.ts +0 -24
- package/dist/remote/relay/convex/types.d.ts.map +0 -1
- package/dist/remote/relay/convex/types.js +0 -14
- package/dist/remote/relay/convex/types.js.map +0 -1
- package/remote/relay/convex/README.md +0 -61
- package/remote/relay/convex/component/README.md +0 -462
package/media/README.md
CHANGED
|
@@ -16,6 +16,100 @@ objects. Media therefore uses two encryption layers:
|
|
|
16
16
|
|
|
17
17
|
The remote object store never receives the media key or plaintext.
|
|
18
18
|
|
|
19
|
+
## Durable upload preparation
|
|
20
|
+
|
|
21
|
+
`prepareMediaAttachmentUpload()` covers retries within one invocation.
|
|
22
|
+
A later invocation must not encrypt different bytes under the same `requestId`.
|
|
23
|
+
For restart recovery, use `signal.media.upload()` with `media.preparedUploads` configured.
|
|
24
|
+
|
|
25
|
+
The application implements `MediaAttachmentPreparedUploadStore` beside its local file storage.
|
|
26
|
+
Its atomic `createIfAbsent` operation persists ciphertext and private pointer material together.
|
|
27
|
+
Concurrent callers receive the same durable record.
|
|
28
|
+
The store returns independent copies and retains records until the queue requests deletion.
|
|
29
|
+
It must not evict preparations as disposable cache entries.
|
|
30
|
+
|
|
31
|
+
`withExclusiveAccess` coordinates queue checks and artifact mutations across clients, tabs, and processes that share the store.
|
|
32
|
+
Its callback can use the same store's methods. Process exit must release ownership without a timed lock takeover.
|
|
33
|
+
The SDK holds this access only for local queue and artifact work, not provider calls or application callbacks.
|
|
34
|
+
The application must not mutate queue-owned artifacts outside this coordination boundary.
|
|
35
|
+
|
|
36
|
+
Set `media.maxPreparedUploadBytes` from the application's device-local storage budget. The value must be a positive safe integer.
|
|
37
|
+
There is no SDK default. The queue reserves each upload's exact ciphertext size before loading or encrypting its draft.
|
|
38
|
+
This reservation includes the encoder's header and authentication tags. Pending drafts also hold reservations.
|
|
39
|
+
|
|
40
|
+
Conditional queue writes enforce the total against shared backing state across clients, tabs, and processes.
|
|
41
|
+
|
|
42
|
+
The reservation remains until successful cleanup removes the queued upload.
|
|
43
|
+
Uncertain authorization, pointer callbacks, or artifact deletion do not release capacity.
|
|
44
|
+
If the application lowers its limit, existing uploads can still retry or finish cleanup.
|
|
45
|
+
The queue refuses new work that increases an excessive total. It never evicts an upload to make space.
|
|
46
|
+
|
|
47
|
+
This limit covers ciphertext bytes, not physical disk capacity or encryption memory.
|
|
48
|
+
The application must reserve additional space for private metadata, atomic file commits, and its storage adapter.
|
|
49
|
+
The existing `maxJobs` setting bounds queue entries separately.
|
|
50
|
+
Use one artifact namespace per device-local queue. Independent queues require separate budgets or an application-owned shared storage limit.
|
|
51
|
+
|
|
52
|
+
The queue persists a small preparation fingerprint before remote authorization.
|
|
53
|
+
It saves the canonical object identifier before transfer.
|
|
54
|
+
After a successful transfer response, it persists that progress before broker completion.
|
|
55
|
+
A lost completion response then retries only completion for the same object.
|
|
56
|
+
|
|
57
|
+
After a lost transfer response, `reconcileUpload` can verify the original stored object.
|
|
58
|
+
The SDK checks its object ID, exact length, and SHA-256 against the saved preparation.
|
|
59
|
+
The queue can repeat this check after a client restart without another authorization or transfer.
|
|
60
|
+
|
|
61
|
+
Unknown outcomes and mismatches remain failures. A conditional refusal alone never proves success.
|
|
62
|
+
Metadata-only brokers must omit this capability. The ordinary completion hook does not supply this proof.
|
|
63
|
+
|
|
64
|
+
It persists the completed pointer before the application's `saveUploadedAttachment` callback.
|
|
65
|
+
That callback must be idempotent for the job ID because its result can be lost.
|
|
66
|
+
Local cleanup runs only after the queue records callback completion.
|
|
67
|
+
|
|
68
|
+
After automatic retries stop, a prepared upload keeps its original identity.
|
|
69
|
+
The queue also retains intent after a lost preparation-store reply, before its fingerprint exists.
|
|
70
|
+
Call `signal.media.upload()` with the same input to retry that job explicitly.
|
|
71
|
+
Missing or changed preparation fails without another authorization or new encryption.
|
|
72
|
+
Do not reset the queue to recover uncertain remote work.
|
|
73
|
+
|
|
74
|
+
Broker refusals stop automatic retries without deleting the prepared upload.
|
|
75
|
+
The upload result exposes safe guidance in `failure`.
|
|
76
|
+
`processPending()` reports retained refusals in `uploadFailures`, including after a restart.
|
|
77
|
+
Only an explicit upload call retries a refused preparation.
|
|
78
|
+
|
|
79
|
+
| Failure code | Required action |
|
|
80
|
+
| --- | --- |
|
|
81
|
+
| `upload-expired` | Reconcile the existing upload before explicitly starting another upload. |
|
|
82
|
+
| `upload-clock-skew` | Correct the device clock. Retry when the saved preparation time is valid, without changing its time or identity. |
|
|
83
|
+
| `upload-admission-closed` | Reconcile existing work without moving its admission to another accounting period. |
|
|
84
|
+
| `upload-unavailable` | Check deletion or expiry before explicitly starting another upload. |
|
|
85
|
+
| `upload-identity-conflict` | Restore the original preparation before retrying. |
|
|
86
|
+
| `upload-rejected` | Check connection and permissions without replacing the preparation. |
|
|
87
|
+
|
|
88
|
+
An expired transfer URL remains retryable with the same prepared bytes.
|
|
89
|
+
An uncertain settlement remains retryable even when period-close repair delays it.
|
|
90
|
+
A stale connection does not prove that the prepared upload expired.
|
|
91
|
+
The queue stores only the refusal code, not provider error text.
|
|
92
|
+
|
|
93
|
+
Call `signal.media.abandonUpload(jobId)` to abandon a retained upload explicitly.
|
|
94
|
+
The broker's `abandonUpload` operation uses the original request ID and preparation time without creating another upload.
|
|
95
|
+
Accepted upload usage remains charged. The server retains its refusal and cleanup obligations.
|
|
96
|
+
The SDK records abandonment before the call and removes local artifacts only after confirmation.
|
|
97
|
+
`processPending()` retries uncertain cancellation and local cleanup with the configured delay. Its `abandoned` count reports completed cleanup.
|
|
98
|
+
|
|
99
|
+
A `completed` result returns an existing pointer instead of deleting it.
|
|
100
|
+
The application's pointer callback can save the pointer before its reply is lost.
|
|
101
|
+
Use the existing attachment cleanup operation when the application wants to delete that completed object.
|
|
102
|
+
An unsupported broker leaves the queue retained with actionable guidance.
|
|
103
|
+
|
|
104
|
+
Keep prepared records private on the device, outside queue JSON, logs, and provider payloads.
|
|
105
|
+
The supplied store must survive the failures that the application's recovery contract covers.
|
|
106
|
+
An in-memory test store does not prove disk or device durability.
|
|
107
|
+
|
|
108
|
+
Applications with their own scheduler can persist the result of `prepareMediaAttachmentUploadData()`.
|
|
109
|
+
They then pass that exact preparation to `uploadPreparedMediaAttachment()`.
|
|
110
|
+
The scheduler owns equivalent persistence, callback, and cleanup ordering.
|
|
111
|
+
Broker completion recovery and logical upload expiry remain separate server contracts.
|
|
112
|
+
|
|
19
113
|
## Upload and send
|
|
20
114
|
|
|
21
115
|
<!-- doc-snippet:skip requires-external-context -->
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@open-e2ee/signal-protocol-sdk",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "4.0.0",
|
|
4
4
|
"description": "Pure TypeScript Signal Protocol SDK for encrypted chat in Expo, React Native, browsers, and Node. Post-quantum by default.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"open-e2ee",
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"sdk",
|
|
27
27
|
"forward-secrecy"
|
|
28
28
|
],
|
|
29
|
-
"license": "
|
|
29
|
+
"license": "(MIT OR Apache-2.0)",
|
|
30
30
|
"author": {
|
|
31
31
|
"name": "OpenE2EE",
|
|
32
32
|
"url": "https://github.com/open-e2ee"
|
|
@@ -63,18 +63,6 @@
|
|
|
63
63
|
"types": "./dist/remote/relay/index.d.ts",
|
|
64
64
|
"default": "./dist/remote/relay/index.js"
|
|
65
65
|
},
|
|
66
|
-
"./remote/relay/convex": {
|
|
67
|
-
"types": "./dist/remote/relay/convex/index.d.ts",
|
|
68
|
-
"default": "./dist/remote/relay/convex/index.js"
|
|
69
|
-
},
|
|
70
|
-
"./remote/relay/convex/relay": {
|
|
71
|
-
"types": "./dist/remote/relay/convex/relay.d.ts",
|
|
72
|
-
"default": "./dist/remote/relay/convex/relay.js"
|
|
73
|
-
},
|
|
74
|
-
"./convex.config": {
|
|
75
|
-
"types": "./dist/remote/relay/convex/component/convex.config.d.ts",
|
|
76
|
-
"default": "./dist/remote/relay/convex/component/convex.config.js"
|
|
77
|
-
},
|
|
78
66
|
"./remote/relay/memory": {
|
|
79
67
|
"types": "./dist/remote/relay/memory/index.d.ts",
|
|
80
68
|
"default": "./dist/remote/relay/memory/index.js"
|
|
@@ -123,9 +111,9 @@
|
|
|
123
111
|
"types": "./dist/device/device-id.d.ts",
|
|
124
112
|
"default": "./dist/device/device-id.js"
|
|
125
113
|
},
|
|
126
|
-
"./device/expo
|
|
127
|
-
"types": "./dist/device/expo
|
|
128
|
-
"default": "./dist/device/expo
|
|
114
|
+
"./device/expo": {
|
|
115
|
+
"types": "./dist/device/expo/index.d.ts",
|
|
116
|
+
"default": "./dist/device/expo/index.js"
|
|
129
117
|
},
|
|
130
118
|
"./device/lifecycle": {
|
|
131
119
|
"types": "./dist/device/lifecycle/index.d.ts",
|
|
@@ -151,6 +139,10 @@
|
|
|
151
139
|
"types": "./dist/groups/index.d.ts",
|
|
152
140
|
"default": "./dist/groups/index.js"
|
|
153
141
|
},
|
|
142
|
+
"./groups/server": {
|
|
143
|
+
"types": "./dist/groups/server.d.ts",
|
|
144
|
+
"default": "./dist/groups/server.js"
|
|
145
|
+
},
|
|
154
146
|
"./hooks": {
|
|
155
147
|
"types": "./dist/hooks/index.d.ts",
|
|
156
148
|
"default": "./dist/hooks/index.js"
|
|
@@ -297,8 +289,9 @@
|
|
|
297
289
|
"ADAPTERS.md",
|
|
298
290
|
"ARCHITECTURE.md",
|
|
299
291
|
"CHANGELOG.md",
|
|
300
|
-
"COMMERCIAL.md",
|
|
301
292
|
"LICENSE",
|
|
293
|
+
"LICENSE-APACHE",
|
|
294
|
+
"LICENSE-MIT",
|
|
302
295
|
"NOTICE",
|
|
303
296
|
"README.md",
|
|
304
297
|
"SECURITY.md",
|
|
@@ -346,8 +339,6 @@
|
|
|
346
339
|
"remote/object-store/convex-r2/README.md",
|
|
347
340
|
"remote/object-store/s3/README.md",
|
|
348
341
|
"remote/relay/README.md",
|
|
349
|
-
"remote/relay/convex/README.md",
|
|
350
|
-
"remote/relay/convex/component/README.md",
|
|
351
342
|
"remote/relay/memory/README.md",
|
|
352
343
|
"safety/README.md",
|
|
353
344
|
"scripts/oe-groups.mjs",
|
|
@@ -359,7 +350,7 @@
|
|
|
359
350
|
],
|
|
360
351
|
"sideEffects": false,
|
|
361
352
|
"engines": {
|
|
362
|
-
"node": ">=
|
|
353
|
+
"node": ">=22.12.0"
|
|
363
354
|
},
|
|
364
355
|
"scripts": {
|
|
365
356
|
"audit:dependencies": "npm audit --omit=dev --audit-level=moderate && npm audit --audit-level=moderate",
|
|
@@ -375,7 +366,6 @@
|
|
|
375
366
|
},
|
|
376
367
|
"peerDependencies": {
|
|
377
368
|
"@convex-dev/r2": "^0.10.2",
|
|
378
|
-
"@convex-dev/rate-limiter": "^0.3.2",
|
|
379
369
|
"convex": "^1.42.1",
|
|
380
370
|
"drizzle-orm": "^0.45.1",
|
|
381
371
|
"expo": "~55.0.27",
|
|
@@ -384,6 +374,7 @@
|
|
|
384
374
|
"expo-device": "~55.0.15",
|
|
385
375
|
"expo-secure-store": "~55.0.15",
|
|
386
376
|
"expo-sqlite": "~55.0.17",
|
|
377
|
+
"fs-native-extensions": "1.2.7",
|
|
387
378
|
"idb": "^8.0.3",
|
|
388
379
|
"react": "^19.0.0",
|
|
389
380
|
"react-native": "^0.83.6",
|
|
@@ -393,9 +384,6 @@
|
|
|
393
384
|
"@convex-dev/r2": {
|
|
394
385
|
"optional": true
|
|
395
386
|
},
|
|
396
|
-
"@convex-dev/rate-limiter": {
|
|
397
|
-
"optional": true
|
|
398
|
-
},
|
|
399
387
|
"convex": {
|
|
400
388
|
"optional": true
|
|
401
389
|
},
|
|
@@ -420,6 +408,9 @@
|
|
|
420
408
|
"expo-sqlite": {
|
|
421
409
|
"optional": true
|
|
422
410
|
},
|
|
411
|
+
"fs-native-extensions": {
|
|
412
|
+
"optional": true
|
|
413
|
+
},
|
|
423
414
|
"idb": {
|
|
424
415
|
"optional": true
|
|
425
416
|
},
|
|
@@ -450,13 +441,11 @@
|
|
|
450
441
|
},
|
|
451
442
|
"devDependencies": {
|
|
452
443
|
"@convex-dev/r2": "^0.10.2",
|
|
453
|
-
"@convex-dev/rate-limiter": "^0.3.2",
|
|
454
444
|
"@swc/core": "^1.15.43",
|
|
455
445
|
"@types/async-lock": "^1.4.0",
|
|
456
446
|
"@types/node": "^22.0.0",
|
|
457
447
|
"@types/react": "^19.0.0",
|
|
458
448
|
"convex": "^1.42.3",
|
|
459
|
-
"convex-test": "^0.0.54",
|
|
460
449
|
"drizzle-orm": "^0.45.1",
|
|
461
450
|
"esbuild": "^0.27.0",
|
|
462
451
|
"expo": "~55.0.27",
|
|
@@ -465,6 +454,7 @@
|
|
|
465
454
|
"expo-device": "~55.0.19",
|
|
466
455
|
"expo-secure-store": "~55.0.16",
|
|
467
456
|
"expo-sqlite": "~55.0.18",
|
|
457
|
+
"fs-native-extensions": "1.2.7",
|
|
468
458
|
"idb": "^8.0.3",
|
|
469
459
|
"react": "19.2.0",
|
|
470
460
|
"react-native": "0.83.10",
|
package/remote/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Remote Guide
|
|
2
2
|
|
|
3
|
-
> Infrastructure | Implements `
|
|
3
|
+
> Infrastructure | Implements `SignalProtocolRelayServer` and `SignalProtocolRemoteObjectStore` | [Architecture](../ARCHITECTURE.md)
|
|
4
4
|
|
|
5
5
|
The backend layer is responsible for server-owned protocol state: public
|
|
6
6
|
prekeys, device registration, encrypted-envelope delivery, and provisioning
|
|
@@ -17,9 +17,9 @@ replaceable and prevent them from owning private keys or plaintext.
|
|
|
17
17
|
|
|
18
18
|
### Relay
|
|
19
19
|
|
|
20
|
-
- `
|
|
20
|
+
- the OpenE2EE Signal Protocol Relay through `createHostedSignalProtocolClient()` from the package root
|
|
21
21
|
- `InMemorySignalProtocolRelayServer` from `@open-e2ee/signal-protocol-sdk/remote/relay/memory`
|
|
22
|
-
- custom implementations via `
|
|
22
|
+
- custom implementations via `SignalProtocolRelayServer`
|
|
23
23
|
|
|
24
24
|
### Remote object store
|
|
25
25
|
|
|
@@ -31,27 +31,27 @@ replaceable and prevent them from owning private keys or plaintext.
|
|
|
31
31
|
|
|
32
32
|
<!-- doc-snippet:skip requires-production-adapters -->
|
|
33
33
|
```ts
|
|
34
|
-
import {
|
|
35
|
-
import {
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
}
|
|
34
|
+
import { createHostedSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
35
|
+
import { expoStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
|
|
36
|
+
|
|
37
|
+
// Initialize the application-owned Expo/SQLCipher database bindings first.
|
|
38
|
+
const signal = await createHostedSignalProtocolClient({
|
|
39
|
+
adapters: {
|
|
40
|
+
// Expo storage owns this device's private keys and session state.
|
|
41
|
+
storage: expoStore(),
|
|
42
|
+
},
|
|
43
|
+
hosted: {
|
|
44
|
+
// The environment-scoped connection URL from the OpenE2EE console.
|
|
45
|
+
relayUrl: process.env.EXPO_PUBLIC_OPEN_E2EE_RELAY_URL!,
|
|
46
|
+
// Returns a short-lived signed assertion for the signed-in user.
|
|
47
|
+
getIdentityAssertion,
|
|
48
|
+
},
|
|
49
49
|
});
|
|
50
50
|
```
|
|
51
51
|
|
|
52
52
|
## Relay Responsibilities
|
|
53
53
|
|
|
54
|
-
An `
|
|
54
|
+
An `SignalProtocolRelayServer` implementation must preserve the package’s protocol semantics for:
|
|
55
55
|
|
|
56
56
|
- identity and prekey upload
|
|
57
57
|
- prekey bundle fetch
|
|
@@ -98,11 +98,11 @@ create, download, completion, and deletion.
|
|
|
98
98
|
|
|
99
99
|
<!-- doc-snippet:skip requires-external-context -->
|
|
100
100
|
```ts
|
|
101
|
-
import {
|
|
101
|
+
import { DefaultSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
102
102
|
import { convexR2ObjectStore } from "@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2";
|
|
103
103
|
import { api } from "../convex/_generated/api";
|
|
104
104
|
|
|
105
|
-
const signal = await
|
|
105
|
+
const signal = await DefaultSignalProtocolClient.create(userId, {
|
|
106
106
|
storage,
|
|
107
107
|
relay,
|
|
108
108
|
remoteObjectStore: convexR2ObjectStore({
|
|
@@ -201,18 +201,18 @@ Use `InMemorySignalProtocolRelayServer` when multiple clients need a shared in-m
|
|
|
201
201
|
<!-- doc-snippet:run remote-shared-memory-relay expect="" -->
|
|
202
202
|
```ts
|
|
203
203
|
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
204
|
-
import {
|
|
204
|
+
import { DefaultSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
205
205
|
import { InMemorySignalProtocolRelayServer } from "@open-e2ee/signal-protocol-sdk/remote/relay/memory";
|
|
206
206
|
import { InMemorySignalProtocolStore } from "@open-e2ee/signal-protocol-sdk/local/store/memory";
|
|
207
207
|
|
|
208
208
|
const relay = new InMemorySignalProtocolRelayServer();
|
|
209
209
|
|
|
210
|
-
const alice = await
|
|
210
|
+
const alice = await DefaultSignalProtocolClient.create("alice", {
|
|
211
211
|
storage: new InMemorySignalProtocolStore(),
|
|
212
212
|
relay,
|
|
213
213
|
});
|
|
214
214
|
|
|
215
|
-
const bob = await
|
|
215
|
+
const bob = await DefaultSignalProtocolClient.create("bob", {
|
|
216
216
|
storage: new InMemorySignalProtocolStore(),
|
|
217
217
|
relay,
|
|
218
218
|
});
|
|
@@ -46,5 +46,13 @@ Provider adapters:
|
|
|
46
46
|
- [Convex R2](./convex-r2/README.md)
|
|
47
47
|
- [Amazon S3 and compatible brokers](./s3/README.md)
|
|
48
48
|
|
|
49
|
+
## Upload refusals
|
|
50
|
+
|
|
51
|
+
A broker can throw `RemoteObjectUploadError` for a specific upload refusal.
|
|
52
|
+
Use the exact `RemoteObjectUploadFailureCode` for expiry, clock skew, closed admission, unavailable objects, identity conflicts, or rejected authority.
|
|
53
|
+
These errors stop automatic retries and preserve the original preparation for explicit recovery.
|
|
54
|
+
Do not classify a storage URL expiry, network failure, or pending accepted settlement as a terminal upload refusal.
|
|
55
|
+
The [media guide](../../media/README.md#durable-upload-preparation) defines the recovery actions.
|
|
56
|
+
|
|
49
57
|
See the [media guide](../../media/README.md) and
|
|
50
58
|
[API reference](../../docs/api/README.md).
|
|
@@ -20,6 +20,7 @@ const remoteObjectStore = s3ObjectStore({
|
|
|
20
20
|
createUpload: (input) => appStorageApi.createS3Upload(input),
|
|
21
21
|
createDownload: (input) => appStorageApi.createS3Download(input),
|
|
22
22
|
completeUpload: (input) => appStorageApi.completeS3Upload(input),
|
|
23
|
+
reconcileUpload: (input) => appStorageApi.reconcileS3Upload(input),
|
|
23
24
|
deleteObject: (input) => appStorageApi.deleteS3Object(input),
|
|
24
25
|
},
|
|
25
26
|
});
|
|
@@ -32,10 +33,18 @@ The broker must:
|
|
|
32
33
|
- generate opaque object identifiers and private provider keys
|
|
33
34
|
- restrict signed operations to the reserved key and expected method
|
|
34
35
|
- enforce content length and content type
|
|
36
|
+
- bind the exact ciphertext digest to each reservation
|
|
37
|
+
|
|
38
|
+
`reconcileUpload` is an optional backend capability for uncertain transfers.
|
|
39
|
+
It must authenticate the caller and verify stored bytes against the original reservation.
|
|
40
|
+
Return the object ID, exact length, and verified SHA-256 only after backend acceptance completes.
|
|
41
|
+
Return `null` only when bytes are absent and the original authorization remains valid.
|
|
42
|
+
|
|
43
|
+
Throw on unknown outcomes, mismatch, deletion, or expiry. Never create another reservation during reconciliation.
|
|
44
|
+
Omit this method when the backend checks only metadata or cannot verify stored bytes.
|
|
35
45
|
|
|
36
46
|
Bucket names, credentials, and unrestricted SDK clients must not cross into the
|
|
37
47
|
application client.
|
|
38
48
|
|
|
39
49
|
See the [object-store guide](../README.md) and
|
|
40
50
|
[media guide](../../../media/README.md).
|
|
41
|
-
|
package/remote/relay/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Relay
|
|
2
2
|
|
|
3
|
-
The relay module defines `
|
|
3
|
+
The relay module defines `SignalProtocolRelayServer`, the application-backend contract
|
|
4
4
|
for device discovery, public prekeys, encrypted envelopes, key rotation,
|
|
5
5
|
provisioning, and related synchronization.
|
|
6
6
|
|
|
@@ -30,8 +30,9 @@ const client = await createSignalProtocolClient({
|
|
|
30
30
|
await client.syncToServer();
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
For production,
|
|
34
|
-
|
|
33
|
+
For production, connect to the OpenE2EE Signal Protocol Relay through
|
|
34
|
+
`createHostedSignalProtocolClient()` from the package root, or implement
|
|
35
|
+
`SignalProtocolRelayServer` against your own backend. That backend must authenticate
|
|
35
36
|
mutations, allocate linked-device IDs, consume one-time prekeys atomically,
|
|
36
37
|
enforce access policy, and store only encrypted envelopes plus required routing
|
|
37
38
|
metadata.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# In-Memory Relay
|
|
2
2
|
|
|
3
|
-
`InMemorySignalProtocolRelayServer` implements `
|
|
3
|
+
`InMemorySignalProtocolRelayServer` implements `SignalProtocolRelayServer` in memory for examples
|
|
4
4
|
and local application development.
|
|
5
5
|
|
|
6
6
|
The protocol and cryptography are real. The adapter simulates the
|
package/types/README.md
CHANGED
|
@@ -15,8 +15,8 @@ contracts they validate.
|
|
|
15
15
|
<!-- doc-snippet:skip requires-external-context -->
|
|
16
16
|
```ts
|
|
17
17
|
import type {
|
|
18
|
-
|
|
19
|
-
|
|
18
|
+
SignalProtocolLocalStore,
|
|
19
|
+
SignalProtocolClient,
|
|
20
20
|
SignalProtocolConfig,
|
|
21
21
|
} from "@open-e2ee/signal-protocol-sdk/types";
|
|
22
22
|
import { ProtocolAddress } from "@open-e2ee/signal-protocol-sdk/types/address";
|
package/COMMERCIAL.md
DELETED
|
@@ -1,56 +0,0 @@
|
|
|
1
|
-
# Commercial licensing
|
|
2
|
-
|
|
3
|
-
`@open-e2ee/signal-protocol-sdk` is dual-licensed. This file explains the
|
|
4
|
-
commercial path; the open-source path is the
|
|
5
|
-
[GNU AGPL-3.0-or-later](https://github.com/open-e2ee/signal-protocol-js/blob/main/LICENSE).
|
|
6
|
-
|
|
7
|
-
## Do you need a commercial license?
|
|
8
|
-
|
|
9
|
-
You do **not** need one if your application complies with AGPLv3 — including
|
|
10
|
-
its network-use provision (section 13): users who interact with your service
|
|
11
|
-
over a network must be able to obtain the complete corresponding source of your
|
|
12
|
-
application under AGPLv3.
|
|
13
|
-
|
|
14
|
-
You likely **do** need one if any of these describe your product:
|
|
15
|
-
|
|
16
|
-
- Closed-source or proprietary application, mobile or web, that ships or serves
|
|
17
|
-
this SDK.
|
|
18
|
-
- You cannot offer your application's source under AGPLv3 terms — for
|
|
19
|
-
contractual, competitive, or policy reasons.
|
|
20
|
-
- You are embedding the SDK in a product you redistribute to customers who
|
|
21
|
-
will not receive AGPLv3 source (OEM).
|
|
22
|
-
|
|
23
|
-
## What the commercial license changes
|
|
24
|
-
|
|
25
|
-
- **Grant.** The right to use, modify, and distribute the SDK in a proprietary
|
|
26
|
-
product, without the AGPLv3 source-provision obligations.
|
|
27
|
-
- **Scope.** Licensed per product, covering `@open-e2ee/signal-protocol-sdk`
|
|
28
|
-
and its subpath adapters as named in your license record.
|
|
29
|
-
- **Support.** Any support terms are those stated in your order form; nothing
|
|
30
|
-
is implied here.
|
|
31
|
-
|
|
32
|
-
It does **not** change the software: same package, same code, same versions,
|
|
33
|
-
same [security policy](https://github.com/open-e2ee/signal-protocol-js/blob/main/SECURITY.md).
|
|
34
|
-
There is no "commercial edition."
|
|
35
|
-
|
|
36
|
-
## Tiers and pricing
|
|
37
|
-
|
|
38
|
-
Current tiers — Startup ($5,000/yr), Growth ($20,000/yr), and Enterprise/OEM
|
|
39
|
-
(from $50,000/yr) — are described with their qualification criteria at
|
|
40
|
-
[open-e2ee.dev/pricing](https://open-e2ee.dev/pricing). Startup licenses can be
|
|
41
|
-
purchased self-serve through the [console](https://console.open-e2ee.dev);
|
|
42
|
-
Growth and Enterprise start with an email.
|
|
43
|
-
|
|
44
|
-
## How buying works
|
|
45
|
-
|
|
46
|
-
1. Read the [Commercial Terms](https://open-e2ee.dev/legal/terms).
|
|
47
|
-
2. Startup tier: purchase directly in the [console](https://console.open-e2ee.dev)
|
|
48
|
-
and download your signed license record immediately.
|
|
49
|
-
3. Growth, Enterprise, or anything unusual (OEM, source escrow, security
|
|
50
|
-
review): email [licensing@open-e2ee.dev](mailto:licensing@open-e2ee.dev).
|
|
51
|
-
|
|
52
|
-
## Evaluation
|
|
53
|
-
|
|
54
|
-
Evaluate under AGPLv3 first — the full SDK, not a trial build. Nothing about
|
|
55
|
-
evaluation, prototyping, or internal proof-of-concept work requires a
|
|
56
|
-
commercial license before you ship to users.
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"expo-metadata.d.ts","sourceRoot":"","sources":["../../device/expo-metadata.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAIH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAE1D,OAAO,EAAE,CAAC;AAEV;;;;;;;;;;GAUG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,mBAAmB,CAOzE"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"expo-metadata.js","sourceRoot":"","sources":["../../device/expo-metadata.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAKvC;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAAkB;IAClD,OAAO;QACL,UAAU;QACV,QAAQ,EAAE,QAAQ,CAAC,EAAE;QACrB,UAAU,EAAE,SAAS,CAAC,UAAU,EAAE,OAAO,IAAI,SAAS;QACtD,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE;KACvC,CAAC;AACJ,CAAC"}
|