@open-e2ee/signal-protocol-sdk 14.1.0 → 14.3.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 +5 -5
- package/CHANGELOG.md +505 -0
- package/README.md +24 -19
- package/SECURITY.md +2 -2
- package/TROUBLESHOOTING.md +1 -1
- package/client/README.md +30 -18
- package/device/README.md +6 -5
- package/dist/client/client.d.ts +49 -38
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +231 -155
- package/dist/client/client.js.map +1 -1
- package/dist/client/compose.d.ts +4 -2
- package/dist/client/compose.d.ts.map +1 -1
- package/dist/client/compose.js +6 -1
- package/dist/client/compose.js.map +1 -1
- package/dist/client/config.d.ts +15 -6
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/config.js.map +1 -1
- package/dist/client/content-adapter.d.ts +9 -0
- package/dist/client/content-adapter.d.ts.map +1 -1
- package/dist/client/content-adapter.js +6 -0
- package/dist/client/content-adapter.js.map +1 -1
- package/dist/client/delivery-status.d.ts +2 -2
- package/dist/client/delivery-status.d.ts.map +1 -1
- package/dist/client/delivery-status.js +10 -4
- package/dist/client/delivery-status.js.map +1 -1
- package/dist/client/device-set-reconciliation.d.ts +23 -15
- package/dist/client/device-set-reconciliation.d.ts.map +1 -1
- package/dist/client/device-set-reconciliation.js +16 -13
- package/dist/client/device-set-reconciliation.js.map +1 -1
- package/dist/client/event-hooks.d.ts +15 -5
- package/dist/client/event-hooks.d.ts.map +1 -1
- package/dist/client/event-hooks.js +39 -4
- package/dist/client/event-hooks.js.map +1 -1
- package/dist/client/group-device-set.d.ts +1 -1
- package/dist/client/group-device-set.d.ts.map +1 -1
- package/dist/client/group-key-sync.js +1 -1
- package/dist/client/group-key-sync.js.map +1 -1
- package/dist/client/group-outbox.d.ts +7 -7
- package/dist/client/group-outbox.d.ts.map +1 -1
- package/dist/client/group-outbox.js +24 -24
- package/dist/client/group-outbox.js.map +1 -1
- package/dist/client/group-sealed-sender.d.ts +1 -1
- package/dist/client/group-sealed-sender.d.ts.map +1 -1
- package/dist/client/group-sender-key-operations.js +1 -1
- package/dist/client/group-sender-key-operations.js.map +1 -1
- package/dist/client/headless.d.ts +6 -6
- package/dist/client/headless.d.ts.map +1 -1
- package/dist/client/headless.js +7 -7
- package/dist/client/headless.js.map +1 -1
- package/dist/client/hosted-anonymous-delivery.d.ts +6 -6
- package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -1
- package/dist/client/hosted-anonymous-delivery.js +17 -17
- package/dist/client/hosted-anonymous-delivery.js.map +1 -1
- package/dist/client/hosted-assertion-id.d.ts +1 -1
- package/dist/client/hosted-assertion-id.d.ts.map +1 -1
- package/dist/client/hosted-assertion-id.js +1 -1
- package/dist/client/hosted-assertion-id.js.map +1 -1
- package/dist/client/hosted-connection.d.ts +5 -5
- package/dist/client/hosted-connection.d.ts.map +1 -1
- package/dist/client/hosted-connection.js +32 -32
- package/dist/client/hosted-connection.js.map +1 -1
- package/dist/client/hosted-device-link-transport.d.ts +2 -2
- package/dist/client/hosted-device-link-transport.d.ts.map +1 -1
- package/dist/client/hosted-device-link-transport.js +1 -1
- package/dist/client/hosted-device-link-transport.js.map +1 -1
- package/dist/client/hosted-device-link.d.ts +5 -1
- package/dist/client/hosted-device-link.d.ts.map +1 -1
- package/dist/client/hosted-device-link.js +7 -4
- package/dist/client/hosted-device-link.js.map +1 -1
- package/dist/client/hosted-device-standing.d.ts +13 -5
- package/dist/client/hosted-device-standing.d.ts.map +1 -1
- package/dist/client/hosted-device-standing.js +11 -6
- package/dist/client/hosted-device-standing.js.map +1 -1
- package/dist/client/hosted-group-authority.d.ts +2 -2
- package/dist/client/hosted-group-authority.d.ts.map +1 -1
- package/dist/client/hosted-group-authority.js +8 -8
- package/dist/client/hosted-group-authority.js.map +1 -1
- package/dist/client/hosted-groups.d.ts +4 -4
- package/dist/client/hosted-groups.d.ts.map +1 -1
- package/dist/client/hosted-groups.js +8 -8
- package/dist/client/hosted-groups.js.map +1 -1
- package/dist/client/hosted-http-error.d.ts +7 -3
- package/dist/client/hosted-http-error.d.ts.map +1 -1
- package/dist/client/hosted-http-error.js +6 -3
- package/dist/client/hosted-http-error.js.map +1 -1
- package/dist/client/hosted-mailbox-subscription.d.ts +10 -10
- package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -1
- package/dist/client/hosted-mailbox-subscription.js +17 -17
- package/dist/client/hosted-mailbox-subscription.js.map +1 -1
- package/dist/client/hosted-prekey-publication.d.ts +9 -9
- package/dist/client/hosted-prekey-publication.d.ts.map +1 -1
- package/dist/client/hosted-prekey-publication.js.map +1 -1
- package/dist/client/hosted-presence-frames.d.ts +62 -38
- package/dist/client/hosted-presence-frames.d.ts.map +1 -1
- package/dist/client/hosted-presence-frames.js +4 -2
- package/dist/client/hosted-presence-frames.js.map +1 -1
- package/dist/client/hosted-presence.d.ts +22 -14
- package/dist/client/hosted-presence.d.ts.map +1 -1
- package/dist/client/hosted-presence.js +26 -17
- package/dist/client/hosted-presence.js.map +1 -1
- package/dist/client/hosted-profile-keys.d.ts +3 -1
- package/dist/client/hosted-profile-keys.d.ts.map +1 -1
- package/dist/client/hosted-profile-keys.js +19 -15
- package/dist/client/hosted-profile-keys.js.map +1 -1
- package/dist/client/hosted-push.d.ts +38 -16
- package/dist/client/hosted-push.d.ts.map +1 -1
- package/dist/client/hosted-push.js +11 -5
- package/dist/client/hosted-push.js.map +1 -1
- package/dist/client/hosted-resume-error.d.ts +21 -9
- package/dist/client/hosted-resume-error.d.ts.map +1 -1
- package/dist/client/hosted-resume-error.js +4 -1
- package/dist/client/hosted-resume-error.js.map +1 -1
- package/dist/client/hosted-resume.d.ts +3 -3
- package/dist/client/hosted-resume.d.ts.map +1 -1
- package/dist/client/hosted-resume.js +12 -12
- package/dist/client/hosted-resume.js.map +1 -1
- package/dist/client/hosted-sandbox-identity.d.ts +32 -18
- package/dist/client/hosted-sandbox-identity.d.ts.map +1 -1
- package/dist/client/hosted-sandbox-identity.js +46 -27
- package/dist/client/hosted-sandbox-identity.js.map +1 -1
- package/dist/client/hosted-store-records.d.ts +46 -0
- package/dist/client/hosted-store-records.d.ts.map +1 -0
- package/dist/client/hosted-store-records.js +32 -0
- package/dist/client/hosted-store-records.js.map +1 -0
- package/dist/client/hosted-transport.d.ts +41 -33
- package/dist/client/hosted-transport.d.ts.map +1 -1
- package/dist/client/hosted-transport.js +146 -101
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/hosted-trust.d.ts +1 -1
- package/dist/client/hosted-trust.d.ts.map +1 -1
- package/dist/client/hosted-trust.js +1 -1
- package/dist/client/hosted-trust.js.map +1 -1
- package/dist/client/hosted.d.ts +138 -72
- package/dist/client/hosted.d.ts.map +1 -1
- package/dist/client/hosted.js +102 -60
- package/dist/client/hosted.js.map +1 -1
- package/dist/client/index.d.ts +4 -4
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +4 -4
- package/dist/client/index.js.map +1 -1
- package/dist/client/key-rotation-core.d.ts +4 -4
- package/dist/client/key-rotation-core.d.ts.map +1 -1
- package/dist/client/key-rotation-core.js +8 -8
- package/dist/client/key-rotation-core.js.map +1 -1
- package/dist/client/key-rotation.js +2 -2
- package/dist/client/key-rotation.js.map +1 -1
- package/dist/client/messages.d.ts +3 -3
- package/dist/client/messages.d.ts.map +1 -1
- package/dist/client/messages.js +18 -18
- package/dist/client/messages.js.map +1 -1
- package/dist/client/one-time-prekey-refill.d.ts +1 -1
- package/dist/client/one-time-prekey-refill.d.ts.map +1 -1
- package/dist/client/prekeys.js +17 -17
- package/dist/client/prekeys.js.map +1 -1
- package/dist/client/receive-queue.d.ts +4 -4
- package/dist/client/receive-queue.d.ts.map +1 -1
- package/dist/client/receive-queue.js +29 -29
- package/dist/client/receive-queue.js.map +1 -1
- package/dist/client/receive-work-seed.d.ts +6 -2
- package/dist/client/receive-work-seed.d.ts.map +1 -1
- package/dist/client/receive-work-seed.js.map +1 -1
- package/dist/client/recovery-driver.js +7 -7
- package/dist/client/recovery-driver.js.map +1 -1
- package/dist/client/retry-request-envelope.d.ts +3 -3
- package/dist/client/retry-request-envelope.d.ts.map +1 -1
- package/dist/client/retry-request-envelope.js +10 -10
- package/dist/client/retry-request-envelope.js.map +1 -1
- package/dist/client/retry-request-lifecycle.d.ts +1 -1
- package/dist/client/retry-request-lifecycle.d.ts.map +1 -1
- package/dist/client/retry-request-lifecycle.js +8 -8
- package/dist/client/retry-request-lifecycle.js.map +1 -1
- package/dist/client/retry-terminal-recovery.js +2 -2
- package/dist/client/retry-terminal-recovery.js.map +1 -1
- package/dist/client/retry.js +13 -13
- package/dist/client/retry.js.map +1 -1
- package/dist/client/sealed-sender.d.ts +13 -4
- package/dist/client/sealed-sender.d.ts.map +1 -1
- package/dist/client/sealed-sender.js +27 -15
- package/dist/client/sealed-sender.js.map +1 -1
- package/dist/client/send-deadline.d.ts +6 -6
- package/dist/client/send-deadline.d.ts.map +1 -1
- package/dist/client/send-deadline.js +37 -23
- package/dist/client/send-deadline.js.map +1 -1
- package/dist/client/send-intent-driver.js +9 -9
- package/dist/client/send-intent-driver.js.map +1 -1
- package/dist/client/sessions.js +11 -11
- package/dist/client/sessions.js.map +1 -1
- package/dist/client/{relay-acceptance.d.ts → signal-relay-acceptance.d.ts} +9 -9
- package/dist/client/signal-relay-acceptance.d.ts.map +1 -0
- package/dist/client/{relay-acceptance.js → signal-relay-acceptance.js} +7 -7
- package/dist/client/signal-relay-acceptance.js.map +1 -0
- package/dist/client/{relay-device-refusal.d.ts → signal-relay-device-refusal.d.ts} +7 -7
- package/dist/client/signal-relay-device-refusal.d.ts.map +1 -0
- package/dist/client/{relay-device-refusal.js → signal-relay-device-refusal.js} +9 -9
- package/dist/client/signal-relay-device-refusal.js.map +1 -0
- package/dist/client/{relay-lifecycle.d.ts → signal-relay-lifecycle.d.ts} +18 -9
- package/dist/client/signal-relay-lifecycle.d.ts.map +1 -0
- package/dist/client/{relay-lifecycle.js → signal-relay-lifecycle.js} +16 -7
- package/dist/client/signal-relay-lifecycle.js.map +1 -0
- package/dist/client/{relay-period-close.d.ts → signal-relay-period-close.d.ts} +1 -1
- package/dist/client/signal-relay-period-close.d.ts.map +1 -0
- package/dist/client/{relay-period-close.js → signal-relay-period-close.js} +1 -1
- package/dist/client/signal-relay-period-close.js.map +1 -0
- package/dist/client/{relay-protocol.d.ts → signal-relay-protocol.d.ts} +12 -8
- package/dist/client/signal-relay-protocol.d.ts.map +1 -0
- package/dist/client/{relay-protocol.js → signal-relay-protocol.js} +13 -10
- package/dist/client/signal-relay-protocol.js.map +1 -0
- package/dist/client/{relay-receipt-intake.d.ts → signal-relay-receipt-intake.d.ts} +12 -12
- package/dist/client/signal-relay-receipt-intake.d.ts.map +1 -0
- package/dist/client/{relay-receipt-intake.js → signal-relay-receipt-intake.js} +9 -9
- package/dist/client/signal-relay-receipt-intake.js.map +1 -0
- package/dist/client/{relay-receipt-join.d.ts → signal-relay-receipt-join.d.ts} +8 -8
- package/dist/client/signal-relay-receipt-join.d.ts.map +1 -0
- package/dist/client/{relay-receipt-join.js → signal-relay-receipt-join.js} +11 -11
- package/dist/client/signal-relay-receipt-join.js.map +1 -0
- package/dist/client/{relay-request-deadline.d.ts → signal-relay-request-deadline.d.ts} +3 -3
- package/dist/client/signal-relay-request-deadline.d.ts.map +1 -0
- package/dist/client/{relay-request-deadline.js → signal-relay-request-deadline.js} +4 -4
- package/dist/client/signal-relay-request-deadline.js.map +1 -0
- package/dist/client/{relay-sealed-route.d.ts → signal-relay-sealed-route.d.ts} +1 -1
- package/dist/client/signal-relay-sealed-route.d.ts.map +1 -0
- package/dist/client/{relay-sealed-route.js → signal-relay-sealed-route.js} +1 -1
- package/dist/client/signal-relay-sealed-route.js.map +1 -0
- package/dist/client/{relay-subscription.d.ts → signal-relay-subscription.d.ts} +12 -12
- package/dist/client/signal-relay-subscription.d.ts.map +1 -0
- package/dist/client/{relay-subscription.js → signal-relay-subscription.js} +23 -23
- package/dist/client/signal-relay-subscription.js.map +1 -0
- package/dist/client/{relay-work.d.ts → signal-relay-work.d.ts} +7 -7
- package/dist/client/signal-relay-work.d.ts.map +1 -0
- package/dist/client/{relay-work.js → signal-relay-work.js} +13 -13
- package/dist/client/signal-relay-work.js.map +1 -0
- package/dist/client/signal-service-cipher.d.ts +10 -8
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +102 -97
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/state.d.ts +4 -4
- package/dist/client/state.d.ts.map +1 -1
- package/dist/client/state.js +3 -3
- package/dist/client/state.js.map +1 -1
- package/dist/client/types.d.ts +13 -4
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js.map +1 -1
- package/dist/device/connection.d.ts +10 -4
- package/dist/device/connection.d.ts.map +1 -1
- package/dist/device/connection.js +8 -3
- package/dist/device/connection.js.map +1 -1
- package/dist/device/index.d.ts +2 -2
- 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/types.d.ts +3 -1
- package/dist/device/types.d.ts.map +1 -1
- package/dist/hooks/index.d.ts +2 -2
- package/dist/hooks/index.d.ts.map +1 -1
- package/dist/hooks/index.js +2 -2
- package/dist/hooks/index.js.map +1 -1
- package/dist/hooks/use-signal-relay-connection-state.d.ts +39 -0
- package/dist/hooks/use-signal-relay-connection-state.d.ts.map +1 -0
- package/dist/hooks/use-signal-relay-connection-state.js +45 -0
- package/dist/hooks/use-signal-relay-connection-state.js.map +1 -0
- package/dist/hooks/use-signal-relay-lifecycle.d.ts +43 -0
- package/dist/hooks/use-signal-relay-lifecycle.d.ts.map +1 -0
- package/dist/hooks/use-signal-relay-lifecycle.js +38 -0
- package/dist/hooks/use-signal-relay-lifecycle.js.map +1 -0
- package/dist/index.d.ts +16 -9
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +6 -5
- package/dist/index.js.map +1 -1
- package/dist/internal/groups/authority-certificate.d.ts +8 -1
- package/dist/internal/groups/authority-certificate.d.ts.map +1 -1
- package/dist/internal/groups/authority-certificate.js +29 -6
- package/dist/internal/groups/authority-certificate.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/certificate.js +2 -2
- package/dist/internal/protocol/sealed-sender/certificate.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/proto/index.js +5 -5
- package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
- package/dist/internal/sesame/device-registry.d.ts +13 -13
- package/dist/internal/sesame/device-registry.d.ts.map +1 -1
- package/dist/internal/sesame/device-registry.js +20 -20
- package/dist/internal/sesame/device-registry.js.map +1 -1
- package/dist/local/store/receive-work.d.ts +29 -0
- package/dist/local/store/receive-work.d.ts.map +1 -1
- package/dist/local/store/receive-work.js +58 -1
- package/dist/local/store/receive-work.js.map +1 -1
- package/dist/local/store/received-content.d.ts +1 -1
- package/dist/local/store/received-content.d.ts.map +1 -1
- package/dist/local/store/reliability.d.ts +11 -3
- package/dist/local/store/reliability.d.ts.map +1 -1
- package/dist/local/store/reliability.js +4 -0
- package/dist/local/store/reliability.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/index.d.ts +3 -9
- package/dist/local/store/sqlite/key-storage/index.d.ts.map +1 -1
- package/dist/local/store/sqlite/key-storage/index.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/signed-prekeys.d.ts +1 -7
- package/dist/local/store/sqlite/key-storage/signed-prekeys.d.ts.map +1 -1
- package/dist/local/store/sqlite/key-storage/signed-prekeys.js.map +1 -1
- package/dist/local/store/sqlite/models/kyber-prekey.d.ts +4 -9
- package/dist/local/store/sqlite/models/kyber-prekey.d.ts.map +1 -1
- package/dist/local/store/sqlite/models/kyber-prekey.js +4 -1
- package/dist/local/store/sqlite/models/kyber-prekey.js.map +1 -1
- package/dist/local/store/sqlite/store.d.ts.map +1 -1
- package/dist/local/store/sqlite/store.js +1 -2
- package/dist/local/store/sqlite/store.js.map +1 -1
- package/dist/remote/signal-relay/connection-state.d.ts +16 -0
- package/dist/remote/signal-relay/connection-state.d.ts.map +1 -0
- package/dist/remote/{relay → signal-relay}/connection-state.js +1 -1
- package/dist/remote/signal-relay/connection-state.js.map +1 -0
- package/dist/remote/{relay → signal-relay}/device-set.d.ts +3 -3
- package/dist/remote/signal-relay/device-set.d.ts.map +1 -0
- package/dist/remote/{relay → signal-relay}/device-set.js +7 -7
- package/dist/remote/signal-relay/device-set.js.map +1 -0
- package/dist/remote/{relay → signal-relay}/index.d.ts +3 -3
- package/dist/remote/signal-relay/index.d.ts.map +1 -0
- package/dist/remote/{relay → signal-relay}/index.js +2 -2
- package/dist/remote/signal-relay/index.js.map +1 -0
- package/dist/remote/{relay → signal-relay}/request-admission.d.ts +2 -2
- package/dist/remote/signal-relay/request-admission.d.ts.map +1 -0
- package/dist/remote/{relay → signal-relay}/request-admission.js +5 -5
- package/dist/remote/signal-relay/request-admission.js.map +1 -0
- package/dist/remote/{relay → signal-relay}/types.d.ts +29 -10
- package/dist/remote/signal-relay/types.d.ts.map +1 -0
- package/dist/remote/{relay → signal-relay}/types.js +1 -1
- package/dist/remote/signal-relay/types.js.map +1 -0
- package/dist/safety/core.d.ts +1 -1
- package/dist/safety/core.js +1 -1
- package/dist/types/api.d.ts +38 -15
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/errors.d.ts +62 -7
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/errors.js +68 -8
- package/dist/types/errors.js.map +1 -1
- package/dist/types/renamed-member.d.ts +48 -0
- package/dist/types/renamed-member.d.ts.map +1 -0
- package/dist/types/renamed-member.js +78 -0
- package/dist/types/renamed-member.js.map +1 -0
- package/dist/utils/bounded-fan-out.d.ts +2 -2
- package/dist/utils/bounded-fan-out.d.ts.map +1 -1
- package/dist/utils/bounded-fan-out.js +2 -2
- package/dist/utils/bounded-fan-out.js.map +1 -1
- package/dist/utils/retry.d.ts +3 -3
- package/dist/utils/retry.d.ts.map +1 -1
- package/dist/utils/retry.js +4 -3
- package/dist/utils/retry.js.map +1 -1
- package/docs/ASSURANCE.md +9 -9
- package/docs/CLIENT_COMPOSITION.md +7 -5
- package/docs/DEVIATIONS.md +8 -5
- package/docs/ERROR_HANDLING.md +21 -21
- package/docs/GETTING_STARTED.md +22 -15
- package/docs/INTERFACES.md +3 -3
- package/docs/PACKAGE_SURFACE.md +14 -4
- package/docs/RECIPES.md +271 -11
- package/hooks/README.md +11 -11
- package/local/store/key-value/README.md +1 -1
- package/local/store/web-sqlite/README.md +1 -1
- package/package.json +16 -6
- package/remote/README.md +3 -3
- package/remote/{relay → signal-relay}/README.md +15 -6
- package/dist/client/relay-acceptance.d.ts.map +0 -1
- package/dist/client/relay-acceptance.js.map +0 -1
- package/dist/client/relay-device-refusal.d.ts.map +0 -1
- package/dist/client/relay-device-refusal.js.map +0 -1
- package/dist/client/relay-lifecycle.d.ts.map +0 -1
- package/dist/client/relay-lifecycle.js.map +0 -1
- package/dist/client/relay-period-close.d.ts.map +0 -1
- package/dist/client/relay-period-close.js.map +0 -1
- package/dist/client/relay-protocol.d.ts.map +0 -1
- package/dist/client/relay-protocol.js.map +0 -1
- package/dist/client/relay-receipt-intake.d.ts.map +0 -1
- package/dist/client/relay-receipt-intake.js.map +0 -1
- package/dist/client/relay-receipt-join.d.ts.map +0 -1
- package/dist/client/relay-receipt-join.js.map +0 -1
- package/dist/client/relay-request-deadline.d.ts.map +0 -1
- package/dist/client/relay-request-deadline.js.map +0 -1
- package/dist/client/relay-sealed-route.d.ts.map +0 -1
- package/dist/client/relay-sealed-route.js.map +0 -1
- package/dist/client/relay-subscription.d.ts.map +0 -1
- package/dist/client/relay-subscription.js.map +0 -1
- package/dist/client/relay-work.d.ts.map +0 -1
- package/dist/client/relay-work.js.map +0 -1
- package/dist/hooks/use-relay-connection-state.d.ts +0 -32
- package/dist/hooks/use-relay-connection-state.d.ts.map +0 -1
- package/dist/hooks/use-relay-connection-state.js +0 -31
- package/dist/hooks/use-relay-connection-state.js.map +0 -1
- package/dist/hooks/use-relay-lifecycle.d.ts +0 -36
- package/dist/hooks/use-relay-lifecycle.d.ts.map +0 -1
- package/dist/hooks/use-relay-lifecycle.js +0 -35
- package/dist/hooks/use-relay-lifecycle.js.map +0 -1
- package/dist/remote/relay/connection-state.d.ts +0 -16
- package/dist/remote/relay/connection-state.d.ts.map +0 -1
- package/dist/remote/relay/connection-state.js.map +0 -1
- package/dist/remote/relay/device-set.d.ts.map +0 -1
- package/dist/remote/relay/device-set.js.map +0 -1
- package/dist/remote/relay/index.d.ts.map +0 -1
- package/dist/remote/relay/index.js.map +0 -1
- package/dist/remote/relay/request-admission.d.ts.map +0 -1
- package/dist/remote/relay/request-admission.js.map +0 -1
- package/dist/remote/relay/types.d.ts.map +0 -1
- package/dist/remote/relay/types.js.map +0 -1
package/ADAPTERS.md
CHANGED
|
@@ -143,7 +143,7 @@ const signal = await createHostedSignalProtocolClient({
|
|
|
143
143
|
},
|
|
144
144
|
hosted: {
|
|
145
145
|
// The environment-scoped connection URL from the OpenE2EE console.
|
|
146
|
-
relayUrl: process.env.EXPO_PUBLIC_OPEN_E2EE_RELAY_URL!,
|
|
146
|
+
relayUrl: process.env.EXPO_PUBLIC_OPEN_E2EE_SIGNAL_RELAY_URL ?? process.env.EXPO_PUBLIC_OPEN_E2EE_RELAY_URL!,
|
|
147
147
|
// Returns a short-lived signed assertion for the signed-in user.
|
|
148
148
|
getIdentityAssertion,
|
|
149
149
|
},
|
|
@@ -158,8 +158,8 @@ database and SQLCipher bootstrap.
|
|
|
158
158
|
`oe new` writes a Sandbox connection URL to `.env.local`. Use it with the
|
|
159
159
|
hosted client. The device-local storage contracts are the same in Sandbox. A
|
|
160
160
|
Sandbox environment uses device-owned identity:
|
|
161
|
-
`
|
|
162
|
-
See the [client guide](./client/README.md#with-relay).
|
|
161
|
+
`hostedSignalProtocolRelaySandboxIdentity(storage)` supplies `hosted.getIdentityAssertion`.
|
|
162
|
+
See the [client guide](./client/README.md#with-the-signal-protocol-relay).
|
|
163
163
|
|
|
164
164
|
## Security Expectations
|
|
165
165
|
|
|
@@ -199,7 +199,7 @@ Use the public interfaces:
|
|
|
199
199
|
<!-- doc-snippet:skip requires-external-context -->
|
|
200
200
|
```ts
|
|
201
201
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
202
|
-
import type { SignalProtocolRelayServer } from "@open-e2ee/signal-protocol-sdk/remote/relay";
|
|
202
|
+
import type { SignalProtocolRelayServer } from "@open-e2ee/signal-protocol-sdk/remote/signal-relay";
|
|
203
203
|
import type { SignalProtocolRemoteObjectStore } from "@open-e2ee/signal-protocol-sdk/remote/object-store";
|
|
204
204
|
import type { SignalProtocolLocalStore } from "@open-e2ee/signal-protocol-sdk/local/store";
|
|
205
205
|
```
|
|
@@ -212,7 +212,7 @@ const signal = await createSignalProtocolClient({
|
|
|
212
212
|
identity: { userId },
|
|
213
213
|
adapters: {
|
|
214
214
|
storage: customStorage,
|
|
215
|
-
relay:
|
|
215
|
+
relay: customSignalRelay,
|
|
216
216
|
remoteObjectStore: customObjectStorage,
|
|
217
217
|
},
|
|
218
218
|
});
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,510 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 14.3.0
|
|
4
|
+
|
|
5
|
+
### Changed
|
|
6
|
+
|
|
7
|
+
- The Expo example moves to the Expo SDK 58 line. It uses React Native
|
|
8
|
+
0.88.1, React 19.3.0, and TypeScript 6.0 as Expo recommends. Its dependency
|
|
9
|
+
tree no longer contains `deepmerge`. Its `app.json` no longer sets
|
|
10
|
+
`jsEngine`, because Hermes is the default.
|
|
11
|
+
- Internal CI also adds the packed package to an Expo SDK 58 project. It
|
|
12
|
+
builds the Expo example's Hermes bundle on Expo SDK 55 and 58.
|
|
13
|
+
|
|
14
|
+
### Changed: role names are the member and option names to use
|
|
15
|
+
|
|
16
|
+
- **The role names are not deprecated.** Each of the 24 members and options
|
|
17
|
+
in the 14.2.0 table "Deprecated: members and options without the Signal
|
|
18
|
+
Protocol prefix" keeps its role name, such as `relay`, `relayUrl`, and
|
|
19
|
+
`startRelaySubscription`. SDK 15.0.0 keeps these names.
|
|
20
|
+
- **The `signalProtocolRelay*` names are deprecated.** SDK 14.2.0 added these
|
|
21
|
+
names, such as `signalProtocolRelay` and
|
|
22
|
+
`startSignalProtocolRelaySubscription`. SDK 15.0.0 removes them. See step 1.
|
|
23
|
+
|
|
24
|
+
This change applies only to the names of members, methods, and option keys of
|
|
25
|
+
objects that the SDK owns. It does not change export names, type names, file
|
|
26
|
+
names, subpaths, URLs, wire values, or stored keys. Those names keep the
|
|
27
|
+
`SignalProtocolRelay` form, for example `SignalProtocolRelayServer` and
|
|
28
|
+
`createHostedSignalProtocolClient`.
|
|
29
|
+
|
|
30
|
+
Both names of each member and option work in this release, as in SDK 14.2.0.
|
|
31
|
+
An option accepts either name. When a call sets both names to different
|
|
32
|
+
values, it fails with `SignalProtocolRelayNameConflictError`. This release
|
|
33
|
+
does not change the behavior of the SDK, the wire, signed bytes, or stored
|
|
34
|
+
bytes.
|
|
35
|
+
|
|
36
|
+
`SignalProtocolRelayNameConflictError` keeps its public shape. `newName` holds
|
|
37
|
+
the deprecated `signalProtocolRelay*` name, because SDK 14.2.0 added it after
|
|
38
|
+
the role name. `earlierName` holds the role name. The error message now tells
|
|
39
|
+
you to set only the role name, for example `relay and signalProtocolRelay name
|
|
40
|
+
the same option and hold different values. Set only relay.` Code that reads
|
|
41
|
+
`newName` to find the name to keep must read `earlierName`. See step 3.
|
|
42
|
+
|
|
43
|
+
Each interface that your code implements keeps the role-name member required
|
|
44
|
+
and the `signalProtocolRelay*` member optional. This applies to
|
|
45
|
+
`SignalProtocolRelayServer`, `SignalProtocolContentAdapter`, and
|
|
46
|
+
`HostedSignalProtocolRelayBootstrapResult`. An implementation with only the
|
|
47
|
+
role-name members compiles and works in SDK 14 and in SDK 15.0.0. See step 2.
|
|
48
|
+
|
|
49
|
+
| Type | Name to use | Deprecated name |
|
|
50
|
+
| --- | --- | --- |
|
|
51
|
+
| `SignalProtocolClient`, `DefaultSignalProtocolClient` | `relayConnectionState` | `signalProtocolRelayConnectionState` |
|
|
52
|
+
| `SignalProtocolClient`, `DefaultSignalProtocolClient` | `subscribeRelayConnectionState` | `subscribeSignalProtocolRelayConnectionState` |
|
|
53
|
+
| `SignalProtocolClient`, `DefaultSignalProtocolClient` | `startRelaySubscription` | `startSignalProtocolRelaySubscription` |
|
|
54
|
+
| `SignalProtocolClient`, `DefaultSignalProtocolClient` | `stopRelaySubscription` | `stopSignalProtocolRelaySubscription` |
|
|
55
|
+
| `SignalProtocolRelayServer`, `InMemorySignalProtocolRelayServer`, `ConvexSignalProtocolRelayServer` | `relayConnectionState` | `signalProtocolRelayConnectionState` |
|
|
56
|
+
| `SignalProtocolRelayServer`, `InMemorySignalProtocolRelayServer`, `ConvexSignalProtocolRelayServer` | `subscribeRelayConnectionState` | `subscribeSignalProtocolRelayConnectionState` |
|
|
57
|
+
| `SignalProtocolClientConfig` | `relay` | `signalProtocolRelay` |
|
|
58
|
+
| `SignalProtocolClientAdapterConfig` | `relay` | `signalProtocolRelay` |
|
|
59
|
+
| `SignalProtocolClientContext` | `relay` | `signalProtocolRelay` |
|
|
60
|
+
| `SealedSenderConfig` | `relayScopeId` | `signalProtocolRelayScopeId` |
|
|
61
|
+
| `GroupAuthorityFields` | `relayScopeId` | `signalProtocolRelayScopeId` |
|
|
62
|
+
| `SignalProtocolClientHooks` | `onRelayProtocolError` | `onSignalProtocolRelayProtocolError` |
|
|
63
|
+
| `SignalProtocolContentAdapter` | `setRelayBatching` | `setSignalProtocolRelayBatching` |
|
|
64
|
+
| `OutgoingMessageError` | `relayRetryable` | `signalProtocolRelayRetryable` |
|
|
65
|
+
| `HostedSignalProtocolRelayBootstrapResult` | `relay` | `signalProtocolRelay` |
|
|
66
|
+
| `HostedSignalProtocolRelayBootstrapResult` | `relayScopeId` | `signalProtocolRelayScopeId` |
|
|
67
|
+
| `HostedSignalProtocolClientOptions` | `hosted.relayUrl` | `hosted.signalProtocolRelayUrl` |
|
|
68
|
+
| `HostedSignalProtocolResumeOptions` | `hosted.relayUrl` | `hosted.signalProtocolRelayUrl` |
|
|
69
|
+
| `HostedSignalProtocolRelayManagedDeviceLinkOptions` | `hosted.relayUrl` | `hosted.signalProtocolRelayUrl` |
|
|
70
|
+
| `HostedSignalProtocolRelayIdentityMigrationOptions` | `relayUrl` | `signalProtocolRelayUrl` |
|
|
71
|
+
| `CreateTestClientOptions` | `sharedRelay` | `sharedSignalProtocolRelay` |
|
|
72
|
+
| `TestClientResult` | `relay` | `signalProtocolRelay` |
|
|
73
|
+
| `SignalProtocolClientInternals` | `relay` | `signalProtocolRelay` |
|
|
74
|
+
| `SignalProtocolServiceCipher` | `setRelayProtocolErrorReporter` | `setSignalProtocolRelayProtocolErrorReporter` |
|
|
75
|
+
|
|
76
|
+
#### Upgrade steps
|
|
77
|
+
|
|
78
|
+
Code that did not change for SDK 14.2.0 needs no change. Code that keeps the
|
|
79
|
+
role names compiles and runs in this release and in SDK 15.0.0.
|
|
80
|
+
|
|
81
|
+
1. If you changed your code to a `signalProtocolRelay*` name in the table for
|
|
82
|
+
SDK 14.2.0, change it back to the role name. Code that keeps a
|
|
83
|
+
`signalProtocolRelay*` name compiles and runs unchanged in this release.
|
|
84
|
+
The TypeScript tools mark it as deprecated. Complete this step before
|
|
85
|
+
SDK 15.0.0, which removes these names.
|
|
86
|
+
2. If you added a `signalProtocolRelay*` member to a class or object that
|
|
87
|
+
implements `SignalProtocolRelayServer`, `SignalProtocolContentAdapter`, or
|
|
88
|
+
`HostedSignalProtocolRelayBootstrapResult`, remove it. Keep the role-name
|
|
89
|
+
member, which this release requires.
|
|
90
|
+
3. If your code reads `newName` from a `SignalProtocolRelayNameConflictError`
|
|
91
|
+
to tell the user which name to keep, read `earlierName`.
|
|
92
|
+
|
|
93
|
+
## 14.2.0
|
|
94
|
+
|
|
95
|
+
### Deprecated
|
|
96
|
+
|
|
97
|
+
- **Names without the Signal Protocol prefix.** Each of the 81 names in the
|
|
98
|
+
table has a new name. A new name has the form `SignalProtocolRelay`, or
|
|
99
|
+
`HostedSignalProtocolRelay` for a name that starts with `Hosted`. SDK 15.0.0
|
|
100
|
+
removes the earlier names. See step 1.
|
|
101
|
+
- **`RelayPreKeyBundle`, from the package root.** Use `PreKeyBundle`. The two
|
|
102
|
+
names identify the same type. SDK 15.0.0 removes `RelayPreKeyBundle`. See
|
|
103
|
+
step 2.
|
|
104
|
+
|
|
105
|
+
Each earlier name is a deprecated alias of the same class, function, or type,
|
|
106
|
+
from the same entry points. A class alias is the same value. Thus `instanceof`
|
|
107
|
+
with the earlier class name is true for an error that the SDK throws.
|
|
108
|
+
|
|
109
|
+
The new names do not change the `name` property of an error or a property
|
|
110
|
+
of an object. The package subpaths are in
|
|
111
|
+
[Deprecated package subpaths](#deprecated-package-subpaths).
|
|
112
|
+
|
|
113
|
+
| Earlier name | New name |
|
|
114
|
+
| --- | --- |
|
|
115
|
+
| `advanceHostedRelayIdentityMigration` | `advanceHostedSignalProtocolRelayIdentityMigration` |
|
|
116
|
+
| `bindRelayLifecycle` | `bindSignalProtocolRelayLifecycle` |
|
|
117
|
+
| `convexRelay` | `convexSignalProtocolRelay` |
|
|
118
|
+
| `createRelayConnection` | `createSignalProtocolRelayConnection` |
|
|
119
|
+
| `HostedRelayBootstrapAdapter` | `HostedSignalProtocolRelayBootstrapAdapter` |
|
|
120
|
+
| `HostedRelayBootstrapRequest` | `HostedSignalProtocolRelayBootstrapRequest` |
|
|
121
|
+
| `HostedRelayBootstrapResult` | `HostedSignalProtocolRelayBootstrapResult` |
|
|
122
|
+
| `HostedRelayDeviceAuthentication` | `HostedSignalProtocolRelayDeviceAuthentication` |
|
|
123
|
+
| `HostedRelayDeviceLinkError` | `HostedSignalProtocolRelayDeviceLinkError` |
|
|
124
|
+
| `hostedRelayDeviceOwnedIdentity` | `hostedSignalProtocolRelayDeviceOwnedIdentity` |
|
|
125
|
+
| `HostedRelayDeviceRevokedError` | `HostedSignalProtocolRelayDeviceRevokedError` |
|
|
126
|
+
| `HostedRelayDeviceUnknownError` | `HostedSignalProtocolRelayDeviceUnknownError` |
|
|
127
|
+
| `HostedRelayHttpError` | `HostedSignalProtocolRelayHttpError` |
|
|
128
|
+
| `HostedRelayIdentityMigrationAction` | `HostedSignalProtocolRelayIdentityMigrationAction` |
|
|
129
|
+
| `HostedRelayIdentityMigrationAdapter` | `HostedSignalProtocolRelayIdentityMigrationAdapter` |
|
|
130
|
+
| `HostedRelayIdentityMigrationOptions` | `HostedSignalProtocolRelayIdentityMigrationOptions` |
|
|
131
|
+
| `HostedRelayIdentityMigrationRequest` | `HostedSignalProtocolRelayIdentityMigrationRequest` |
|
|
132
|
+
| `HostedRelayIdentityMigrationSnapshot` | `HostedSignalProtocolRelayIdentityMigrationSnapshot` |
|
|
133
|
+
| `HostedRelayIdentityMigrationState` | `HostedSignalProtocolRelayIdentityMigrationState` |
|
|
134
|
+
| `HostedRelayIdentityProgress` | `HostedSignalProtocolRelayIdentityProgress` |
|
|
135
|
+
| `HostedRelayIdentityProgressCallback` | `HostedSignalProtocolRelayIdentityProgressCallback` |
|
|
136
|
+
| `HostedRelayManagedDeviceLinkAdapter` | `HostedSignalProtocolRelayManagedDeviceLinkAdapter` |
|
|
137
|
+
| `HostedRelayManagedDeviceLinkOptions` | `HostedSignalProtocolRelayManagedDeviceLinkOptions` |
|
|
138
|
+
| `HostedRelayManagedDeviceLinkRequest` | `HostedSignalProtocolRelayManagedDeviceLinkRequest` |
|
|
139
|
+
| `HostedRelayManagedDeviceLinkResult` | `HostedSignalProtocolRelayManagedDeviceLinkResult` |
|
|
140
|
+
| `hostedRelayPresence` | `hostedSignalProtocolRelayPresence` |
|
|
141
|
+
| `HostedRelayPresence` | `HostedSignalProtocolRelayPresence` |
|
|
142
|
+
| `HostedRelayPresenceAccount` | `HostedSignalProtocolRelayPresenceAccount` |
|
|
143
|
+
| `HostedRelayPresenceApproximateLastSeen` | `HostedSignalProtocolRelayPresenceApproximateLastSeen` |
|
|
144
|
+
| `HostedRelayPresenceAudience` | `HostedSignalProtocolRelayPresenceAudience` |
|
|
145
|
+
| `HostedRelayPresenceError` | `HostedSignalProtocolRelayPresenceError` |
|
|
146
|
+
| `HostedRelayPresenceErrorCode` | `HostedSignalProtocolRelayPresenceErrorCode` |
|
|
147
|
+
| `HostedRelayPresenceLastSeenPolicy` | `HostedSignalProtocolRelayPresenceLastSeenPolicy` |
|
|
148
|
+
| `HostedRelayPresenceMode` | `HostedSignalProtocolRelayPresenceMode` |
|
|
149
|
+
| `HostedRelayPresencePolicy` | `HostedSignalProtocolRelayPresencePolicy` |
|
|
150
|
+
| `HostedRelayPresenceSetting` | `HostedSignalProtocolRelayPresenceSetting` |
|
|
151
|
+
| `HostedRelayPresenceStatus` | `HostedSignalProtocolRelayPresenceStatus` |
|
|
152
|
+
| `HostedRelayPresenceVisibility` | `HostedSignalProtocolRelayPresenceVisibility` |
|
|
153
|
+
| `HostedRelayProfileKeys` | `HostedSignalProtocolRelayProfileKeys` |
|
|
154
|
+
| `HostedRelayPushPlatform` | `HostedSignalProtocolRelayPushPlatform` |
|
|
155
|
+
| `HostedRelayPushProfile` | `HostedSignalProtocolRelayPushProfile` |
|
|
156
|
+
| `HostedRelayPushRegistration` | `HostedSignalProtocolRelayPushRegistration` |
|
|
157
|
+
| `HostedRelayRegistrationPreKey` | `HostedSignalProtocolRelayRegistrationPreKey` |
|
|
158
|
+
| `HostedRelayRegistrationPreKeys` | `HostedSignalProtocolRelayRegistrationPreKeys` |
|
|
159
|
+
| `HostedRelayResumeError` | `HostedSignalProtocolRelayResumeError` |
|
|
160
|
+
| `HostedRelayResumeErrorCode` | `HostedSignalProtocolRelayResumeErrorCode` |
|
|
161
|
+
| `HostedRelayResumePhase` | `HostedSignalProtocolRelayResumePhase` |
|
|
162
|
+
| `HostedRelayResumeProgress` | `HostedSignalProtocolRelayResumeProgress` |
|
|
163
|
+
| `HostedRelayResumeProgressCallback` | `HostedSignalProtocolRelayResumeProgressCallback` |
|
|
164
|
+
| `hostedRelaySandboxIdentity` | `hostedSignalProtocolRelaySandboxIdentity` |
|
|
165
|
+
| `HostedRelayTokenPushRegistration` | `HostedSignalProtocolRelayTokenPushRegistration` |
|
|
166
|
+
| `HostedRelayUpgradeRequiredError` | `HostedSignalProtocolRelayUpgradeRequiredError` |
|
|
167
|
+
| `HostedRelayWakeClient` | `HostedSignalProtocolRelayWakeClient` |
|
|
168
|
+
| `HostedRelayWakeOptions` | `HostedSignalProtocolRelayWakeOptions` |
|
|
169
|
+
| `hostedRelayWakePresence` | `hostedSignalProtocolRelayWakePresence` |
|
|
170
|
+
| `HostedRelayWakePresence` | `HostedSignalProtocolRelayWakePresence` |
|
|
171
|
+
| `HostedRelayWakeResult` | `HostedSignalProtocolRelayWakeResult` |
|
|
172
|
+
| `HostedRelayWebPushRegistration` | `HostedSignalProtocolRelayWebPushRegistration` |
|
|
173
|
+
| `inMemoryRelay` | `inMemorySignalProtocolRelay` |
|
|
174
|
+
| `isSendNeverAcceptedByRelayError` | `isSendNeverAcceptedBySignalProtocolRelayError` |
|
|
175
|
+
| `linkHostedRelayDevice` | `linkHostedSignalProtocolRelayDevice` |
|
|
176
|
+
| `pullHostedRelayAfterWake` | `pullHostedSignalProtocolRelayAfterWake` |
|
|
177
|
+
| `registerHostedRelayPush` | `registerHostedSignalProtocolRelayPush` |
|
|
178
|
+
| `RelayConfig` | `SignalProtocolRelayConfig` |
|
|
179
|
+
| `RelayConnection` | `SignalProtocolRelayConnection` |
|
|
180
|
+
| `RelayConnectionReason` | `SignalProtocolRelayConnectionReason` |
|
|
181
|
+
| `RelayConnectionState` | `SignalProtocolRelayConnectionState` |
|
|
182
|
+
| `RelayFailureController` | `SignalProtocolRelayFailureController` |
|
|
183
|
+
| `RelayFailureOptions` | `SignalProtocolRelayFailureOptions` |
|
|
184
|
+
| `RelayGroupServer` | `SignalProtocolRelayGroupServer` |
|
|
185
|
+
| `RelayLifecycleAppState` | `SignalProtocolRelayLifecycleAppState` |
|
|
186
|
+
| `RelayLifecycleOptions` | `SignalProtocolRelayLifecycleOptions` |
|
|
187
|
+
| `RelayProtocolError` | `SignalProtocolRelayProtocolError` |
|
|
188
|
+
| `RelayProtocolErrorCode` | `SignalProtocolRelayProtocolErrorCode` |
|
|
189
|
+
| `RelayProtocolRoute` | `SignalProtocolRelayProtocolRoute` |
|
|
190
|
+
| `removeHostedRelayPush` | `removeHostedSignalProtocolRelayPush` |
|
|
191
|
+
| `SendNeverAcceptedByRelayError` | `SendNeverAcceptedBySignalProtocolRelayError` |
|
|
192
|
+
| `useRelayConnectionState` | `useSignalProtocolRelayConnectionState` |
|
|
193
|
+
| `UseRelayConnectionStateOptions` | `UseSignalProtocolRelayConnectionStateOptions` |
|
|
194
|
+
| `useRelayLifecycle` | `useSignalProtocolRelayLifecycle` |
|
|
195
|
+
| `UseRelayLifecycleOptions` | `UseSignalProtocolRelayLifecycleOptions` |
|
|
196
|
+
|
|
197
|
+
### Changed
|
|
198
|
+
|
|
199
|
+
- **The docs read the new URL variable first.** The examples read
|
|
200
|
+
`OPEN_E2EE_SIGNAL_RELAY_URL` or `EXPO_PUBLIC_OPEN_E2EE_SIGNAL_RELAY_URL`
|
|
201
|
+
first. They read the earlier name without `SIGNAL_` second. `oe` 5.0.0 added
|
|
202
|
+
`SIGNAL_` to these names. The SDK reads no environment variable. See step 3.
|
|
203
|
+
- **The SDK verifies the protocol version 3 names of the OpenE2EE Signal
|
|
204
|
+
Protocol Relay.** A device link accepts a device token with the issuer
|
|
205
|
+
`signal-relay` and the audience `signal-relay-device`. A group authority
|
|
206
|
+
certificate with the domain `signal-relay-group-authority-v2` verifies. The
|
|
207
|
+
earlier issuer, audience, and domain still verify. A token that mixes an
|
|
208
|
+
earlier name with a new name fails. A device token can carry the scope claim
|
|
209
|
+
`signal_relay_scope_id`, the earlier claim `relay_scope_id`, or both. A token
|
|
210
|
+
with two different scope values fails. The SDK still sends protocol version 2.
|
|
211
|
+
The sender certificate schema names field 7 `signalRelayScopeId`. The field
|
|
212
|
+
number and the bytes on the wire do not change. No step is necessary.
|
|
213
|
+
|
|
214
|
+
#### Upgrade steps
|
|
215
|
+
|
|
216
|
+
1. Replace each earlier name in the table with its new name. Code that keeps
|
|
217
|
+
an earlier name compiles and runs unchanged in this release. The
|
|
218
|
+
TypeScript tools mark the earlier name as deprecated. Complete this step before
|
|
219
|
+
SDK 15.0.0, which removes the earlier names.
|
|
220
|
+
2. Replace `RelayPreKeyBundle` with `PreKeyBundle`.
|
|
221
|
+
3. Set the Relay URL in `OPEN_E2EE_SIGNAL_RELAY_URL`. In a Next.js, Vite, or
|
|
222
|
+
Expo application, use the public prefix of the framework:
|
|
223
|
+
`NEXT_PUBLIC_OPEN_E2EE_SIGNAL_RELAY_URL`, `VITE_OPEN_E2EE_SIGNAL_RELAY_URL`,
|
|
224
|
+
or `EXPO_PUBLIC_OPEN_E2EE_SIGNAL_RELAY_URL`. An `oe` release before 5.0.0
|
|
225
|
+
wrote the earlier name. Until each environment has the new name, read the
|
|
226
|
+
new name first and the earlier name second.
|
|
227
|
+
|
|
228
|
+
### Relay values that SDK 15.0.0 changes
|
|
229
|
+
|
|
230
|
+
- **The Relay union values accept `'signal-relay'`.** `DeliverySource`, the
|
|
231
|
+
`origin` of `ReceiveExpiredEvent`, and the `origin` of `PendingReceive`
|
|
232
|
+
accept `'signal-relay'` and `'relay'`. This release reports `'relay'`. SDK
|
|
233
|
+
15.0.0 reports `'signal-relay'`.
|
|
234
|
+
- **SDK 15.0.0 changes two error names.** This release does not change the
|
|
235
|
+
`name` property of an error.
|
|
236
|
+
- **SDK 15.0.0 changes four log operations.** A device transfer log entry
|
|
237
|
+
holds its operation in the `data.operation` field. This release does not
|
|
238
|
+
change the operations.
|
|
239
|
+
|
|
240
|
+
| Kind | Value in this release | Value in SDK 15.0.0 |
|
|
241
|
+
| --- | --- | --- |
|
|
242
|
+
| `DeliverySource` value | `'relay'` | `'signal-relay'` |
|
|
243
|
+
| `ReceiveExpiredEvent.origin` value | `'relay'` | `'signal-relay'` |
|
|
244
|
+
| `PendingReceive.origin` value | `'relay'` | `'signal-relay'` |
|
|
245
|
+
| Error `name` | `RelayWorkStopped` | `SignalProtocolRelayWorkStopped` |
|
|
246
|
+
| Error `name` | `InMemoryRelayRefusal` | `InMemorySignalProtocolRelayRefusal` |
|
|
247
|
+
| Log operation | `relay-connect` | `signal-relay-connect` |
|
|
248
|
+
| Log operation | `relay-disconnect` | `signal-relay-disconnect` |
|
|
249
|
+
| Log operation | `relay-upload` | `signal-relay-upload` |
|
|
250
|
+
| Log operation | `relay-download` | `signal-relay-download` |
|
|
251
|
+
|
|
252
|
+
#### Upgrade steps for the Relay values
|
|
253
|
+
|
|
254
|
+
1. Find each comparison with `'relay'` of a value in the first three rows of
|
|
255
|
+
the table. Make it also accept `'signal-relay'`. Before you upgrade to SDK
|
|
256
|
+
15.0.0, complete this step. In that release, code that accepts only
|
|
257
|
+
`'relay'` does not match a Relay delivery or a Relay message. A `switch`
|
|
258
|
+
that ends with an exhaustive check needs a `case` for each value now,
|
|
259
|
+
because it does not compile with this release. For example, this `switch`
|
|
260
|
+
compiles with SDK 14.1.0 only:
|
|
261
|
+
|
|
262
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
263
|
+
```ts
|
|
264
|
+
import type { DeliverySource } from '@open-e2ee/signal-protocol-sdk';
|
|
265
|
+
|
|
266
|
+
function deliveryLabel(source: DeliverySource): string {
|
|
267
|
+
switch (source) {
|
|
268
|
+
case 'relay':
|
|
269
|
+
return 'Delivered to the device';
|
|
270
|
+
case 'e2ee':
|
|
271
|
+
return 'Decrypted on the device';
|
|
272
|
+
default: {
|
|
273
|
+
const unhandled: never = source;
|
|
274
|
+
return unhandled;
|
|
275
|
+
}
|
|
276
|
+
}
|
|
277
|
+
}
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
Add a `case` for `'signal-relay'` next to the `case` for `'relay'`. This
|
|
281
|
+
`switch` compiles with this release and with SDK 15.0.0:
|
|
282
|
+
|
|
283
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
284
|
+
```ts
|
|
285
|
+
import type { DeliverySource } from '@open-e2ee/signal-protocol-sdk';
|
|
286
|
+
|
|
287
|
+
function deliveryLabel(source: DeliverySource): string {
|
|
288
|
+
switch (source) {
|
|
289
|
+
case 'relay':
|
|
290
|
+
case 'signal-relay':
|
|
291
|
+
return 'Delivered to the device';
|
|
292
|
+
case 'e2ee':
|
|
293
|
+
return 'Decrypted on the device';
|
|
294
|
+
default: {
|
|
295
|
+
const unhandled: never = source;
|
|
296
|
+
return unhandled;
|
|
297
|
+
}
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
2. Find each match of an error `name` in the table, in code or in a log
|
|
303
|
+
query. Make it also match the SDK 15.0.0 name.
|
|
304
|
+
3. Find each log query that matches a log operation in the table. Make it
|
|
305
|
+
also match the SDK 15.0.0 value.
|
|
306
|
+
|
|
307
|
+
### Store keys
|
|
308
|
+
|
|
309
|
+
- **The SDK reads a hosted record under a new key prefix first.** Seven
|
|
310
|
+
records in the application store have a new metadata key prefix,
|
|
311
|
+
`signalRelay.<record>.v2:`. The records are `session`,
|
|
312
|
+
`deviceAuthentication`, `registrationSnapshot`, `reregistrationSnapshot`,
|
|
313
|
+
`sandboxIdentity`, `presenceGrant`, and `profileKeyDelivered`. The SDK reads
|
|
314
|
+
the new key first and the earlier `hostedRelay.<record>.v1:` key second.
|
|
315
|
+
- **The SDK writes the earlier key.** This release writes each record under
|
|
316
|
+
the earlier key, so SDK 14.1.0 still finds every record. When the store
|
|
317
|
+
already holds the new key, a write also replaces it. A later release writes
|
|
318
|
+
the new key. SDK 15 still reads the earlier key.
|
|
319
|
+
- **A store that SDK 14.1.0 wrote opens with its sessions and device
|
|
320
|
+
authentication.** You do not need to change the store. The documentation of
|
|
321
|
+
`hostedSignalProtocolRelaySandboxIdentity` and
|
|
322
|
+
`hostedSignalProtocolRelayDeviceOwnedIdentity` names the two key prefixes of
|
|
323
|
+
the sandbox identity key.
|
|
324
|
+
|
|
325
|
+
### Stored Relay values
|
|
326
|
+
|
|
327
|
+
- **A receive record accepts the Relay values of a later release.** The
|
|
328
|
+
`origin` of `ReceiveWorkRecord` accepts `'signal-relay'`, the same origin as
|
|
329
|
+
`'relay'`. The new optional field `signalProtocolRelayOwnsReceipt` holds the
|
|
330
|
+
Relay receipt decision, the same decision as `relayOwnsReceipt`. A stored
|
|
331
|
+
delivery status accepts the source `'signal-relay'`, the same source as
|
|
332
|
+
`'relay'`. The SDK reads both values and both field names. When a record
|
|
333
|
+
holds both field names, the new name wins.
|
|
334
|
+
- **The SDK writes the values of SDK 14.1.0.** This release writes the origin
|
|
335
|
+
`'relay'`, the field `relayOwnsReceipt`, and the source `'relay'`, so SDK
|
|
336
|
+
14.1.0 reads each record that it writes. The SDK does not rewrite or delete
|
|
337
|
+
a stored record to change a value. It reports `'relay'` for a stored
|
|
338
|
+
`'signal-relay'`.
|
|
339
|
+
- **A store refuses a record whose two field names hold different values.**
|
|
340
|
+
`putReceiveWork` and a read of the record throw
|
|
341
|
+
`SignalProtocolRelayNameConflictError`. A store that SDK 14.1.0 wrote opens
|
|
342
|
+
with each record intact. You do not need to change the store.
|
|
343
|
+
- **A custom store keeps each value that it gets.** A
|
|
344
|
+
`SignalProtocolLocalStore` that you write must store and return
|
|
345
|
+
`'signal-relay'` and `signalProtocolRelayOwnsReceipt` without a change, as
|
|
346
|
+
it does each other field.
|
|
347
|
+
|
|
348
|
+
### Deprecated package subpaths
|
|
349
|
+
|
|
350
|
+
- **Package subpaths without `signal-`.** Each subpath in the table has a new
|
|
351
|
+
subpath. SDK 15.0.0 removes the earlier subpaths.
|
|
352
|
+
|
|
353
|
+
Each earlier subpath is a deprecated entry to the same files as its new
|
|
354
|
+
subpath. Thus the two subpaths load one module, and `instanceof` with a class
|
|
355
|
+
from either subpath is true for an object from the other. An exports map cannot
|
|
356
|
+
mark a subpath as deprecated, so the TypeScript tools do not mark an import of
|
|
357
|
+
an earlier subpath.
|
|
358
|
+
|
|
359
|
+
| Earlier subpath | New subpath |
|
|
360
|
+
| --- | --- |
|
|
361
|
+
| `@open-e2ee/signal-protocol-sdk/remote/relay` | `@open-e2ee/signal-protocol-sdk/remote/signal-relay` |
|
|
362
|
+
| `@open-e2ee/signal-protocol-sdk/remote/relay/types` | `@open-e2ee/signal-protocol-sdk/remote/signal-relay/types` |
|
|
363
|
+
|
|
364
|
+
The package files move to the same names. The directory `remote/relay/` is
|
|
365
|
+
now `remote/signal-relay/`. Each `client/relay-<name>.ts` file is now
|
|
366
|
+
`client/signal-relay-<name>.ts`. The hook files `use-relay-connection-state`
|
|
367
|
+
and `use-relay-lifecycle` are now `use-signal-relay-connection-state` and
|
|
368
|
+
`use-signal-relay-lifecycle`. The page `docs/RELAY_CONNECTION.md` is now
|
|
369
|
+
`docs/SIGNAL_RELAY_CONNECTION.md`. Import only the subpaths in the exports
|
|
370
|
+
map.
|
|
371
|
+
|
|
372
|
+
The Convex component, which the public package does not include, also changes.
|
|
373
|
+
Its `./convex.config` entry points to `remote/signal-relay/convex/component`,
|
|
374
|
+
and its cron `delete expired relay messages` is now
|
|
375
|
+
`delete expired signal-relay messages`. The component name stays
|
|
376
|
+
`signalProtocol`. On a local Convex backend, a deploy of this release kept the
|
|
377
|
+
component and its tables, deleted the earlier cron and its run history, and
|
|
378
|
+
added the new cron. The new cron ran once at the deploy, and its next run was
|
|
379
|
+
one hour later.
|
|
380
|
+
|
|
381
|
+
#### Upgrade steps
|
|
382
|
+
|
|
383
|
+
1. Replace each earlier subpath in the table with its new subpath. Code that
|
|
384
|
+
keeps an earlier subpath runs unchanged in this release. Complete this step
|
|
385
|
+
before SDK 15.0.0, which removes the earlier subpaths.
|
|
386
|
+
2. For a Convex deployment that mounts the component, keep the mount name
|
|
387
|
+
`signalProtocol` and deploy. Before the deploy, copy the run history of
|
|
388
|
+
`delete expired relay messages` if you need it, because the deploy deletes
|
|
389
|
+
it. Change each monitor or alert that names the earlier cron to the new name.
|
|
390
|
+
|
|
391
|
+
### Deprecated: members and options without the Signal Protocol prefix
|
|
392
|
+
|
|
393
|
+
- **Members and options named `relay`.** Each member and option in the table
|
|
394
|
+
has a new name in the `signalProtocolRelay` form. SDK 15.0.0 removes the
|
|
395
|
+
earlier names. See steps 1 and 3.
|
|
396
|
+
|
|
397
|
+
An option accepts the new name or the earlier name. When a call sets both
|
|
398
|
+
names to different values, it fails with `SignalProtocolRelayNameConflictError`,
|
|
399
|
+
from `@open-e2ee/signal-protocol-sdk/types`. The error holds `newName` and
|
|
400
|
+
`earlierName`, and its code is `SIGNAL_PROTOCOL_RELAY_NAME_CONFLICT`. Two equal
|
|
401
|
+
values, or two byte arrays with the same bytes, do not fail. See step 2.
|
|
402
|
+
|
|
403
|
+
In this release, each interface that your code implements keeps the earlier
|
|
404
|
+
member required, with its earlier type, and adds the new member as optional.
|
|
405
|
+
This applies to `SignalProtocolRelayServer`, `SignalProtocolContentAdapter`, and
|
|
406
|
+
`HostedSignalProtocolRelayBootstrapResult`. An implementation with only the
|
|
407
|
+
earlier members compiles and works unchanged, and code that reads an earlier
|
|
408
|
+
member needs no change. When an implementation has both members, the SDK uses
|
|
409
|
+
the new member. SDK 15.0.0 requires the new members.
|
|
410
|
+
|
|
411
|
+
The SDK uses the name that the nearest level of an object defines, so a
|
|
412
|
+
subclass or a spread object that overrides only one name keeps its override.
|
|
413
|
+
For example, a subclass of `InMemorySignalProtocolRelayServer` that overrides
|
|
414
|
+
only `subscribeRelayConnectionState` gets the client subscriptions. Each SDK
|
|
415
|
+
class and each object that the SDK returns has both members, and one member
|
|
416
|
+
forwards to the other. `registerHook('onRelayProtocolError', hook)` registers
|
|
417
|
+
the hook under `onSignalProtocolRelayProtocolError`.
|
|
418
|
+
`bindSignalProtocolRelayLifecycle` and `useSignalProtocolRelayLifecycle` accept
|
|
419
|
+
an object with only the earlier members.
|
|
420
|
+
|
|
421
|
+
This release does not change bytes on the wire, signed bytes, or stored bytes.
|
|
422
|
+
The sealed sender field `relayScopeId` keeps protobuf field 7, and the group
|
|
423
|
+
authority certificate encodes the same bytes for both names.
|
|
424
|
+
|
|
425
|
+
Three options had a required earlier name: `SealedSenderConfig.relayScopeId`,
|
|
426
|
+
`HostedSignalProtocolRelayIdentityMigrationOptions.relayUrl`, and the
|
|
427
|
+
`relayScopeId` field of `encodeGroupAuthority`. Each now accepts either name,
|
|
428
|
+
so both names are optional, and the SDK requires one of the two. A call that
|
|
429
|
+
sets the earlier name compiles unchanged. Code that reads one of these fields
|
|
430
|
+
back from its own options object must handle `undefined`. See step 4.
|
|
431
|
+
|
|
432
|
+
| Type | Earlier name | New name |
|
|
433
|
+
| --- | --- | --- |
|
|
434
|
+
| `SignalProtocolClient`, `DefaultSignalProtocolClient` | `relayConnectionState` | `signalProtocolRelayConnectionState` |
|
|
435
|
+
| `SignalProtocolClient`, `DefaultSignalProtocolClient` | `subscribeRelayConnectionState` | `subscribeSignalProtocolRelayConnectionState` |
|
|
436
|
+
| `SignalProtocolClient`, `DefaultSignalProtocolClient` | `startRelaySubscription` | `startSignalProtocolRelaySubscription` |
|
|
437
|
+
| `SignalProtocolClient`, `DefaultSignalProtocolClient` | `stopRelaySubscription` | `stopSignalProtocolRelaySubscription` |
|
|
438
|
+
| `SignalProtocolRelayServer`, `InMemorySignalProtocolRelayServer`, `ConvexSignalProtocolRelayServer` | `relayConnectionState` | `signalProtocolRelayConnectionState` |
|
|
439
|
+
| `SignalProtocolRelayServer`, `InMemorySignalProtocolRelayServer`, `ConvexSignalProtocolRelayServer` | `subscribeRelayConnectionState` | `subscribeSignalProtocolRelayConnectionState` |
|
|
440
|
+
| `SignalProtocolClientConfig` | `relay` | `signalProtocolRelay` |
|
|
441
|
+
| `SignalProtocolClientAdapterConfig` | `relay` | `signalProtocolRelay` |
|
|
442
|
+
| `SignalProtocolClientContext` | `relay` | `signalProtocolRelay` |
|
|
443
|
+
| `SealedSenderConfig` | `relayScopeId` | `signalProtocolRelayScopeId` |
|
|
444
|
+
| `GroupAuthorityFields` | `relayScopeId` | `signalProtocolRelayScopeId` |
|
|
445
|
+
| `SignalProtocolClientHooks` | `onRelayProtocolError` | `onSignalProtocolRelayProtocolError` |
|
|
446
|
+
| `SignalProtocolContentAdapter` | `setRelayBatching` | `setSignalProtocolRelayBatching` |
|
|
447
|
+
| `OutgoingMessageError` | `relayRetryable` | `signalProtocolRelayRetryable` |
|
|
448
|
+
| `HostedSignalProtocolRelayBootstrapResult` | `relay` | `signalProtocolRelay` |
|
|
449
|
+
| `HostedSignalProtocolRelayBootstrapResult` | `relayScopeId` | `signalProtocolRelayScopeId` |
|
|
450
|
+
| `HostedSignalProtocolClientOptions` | `hosted.relayUrl` | `hosted.signalProtocolRelayUrl` |
|
|
451
|
+
| `HostedSignalProtocolResumeOptions` | `hosted.relayUrl` | `hosted.signalProtocolRelayUrl` |
|
|
452
|
+
| `HostedSignalProtocolRelayManagedDeviceLinkOptions` | `hosted.relayUrl` | `hosted.signalProtocolRelayUrl` |
|
|
453
|
+
| `HostedSignalProtocolRelayIdentityMigrationOptions` | `relayUrl` | `signalProtocolRelayUrl` |
|
|
454
|
+
| `CreateTestClientOptions` | `sharedRelay` | `sharedSignalProtocolRelay` |
|
|
455
|
+
| `TestClientResult` | `relay` | `signalProtocolRelay` |
|
|
456
|
+
| `SignalProtocolClientInternals` | `relay` | `signalProtocolRelay` |
|
|
457
|
+
| `SignalProtocolServiceCipher` | `setRelayProtocolErrorReporter` | `setSignalProtocolRelayProtocolErrorReporter` |
|
|
458
|
+
|
|
459
|
+
#### Upgrade steps
|
|
460
|
+
|
|
461
|
+
1. Replace each earlier name in the table with its new name where your code
|
|
462
|
+
reads a member or sets an option. Code that keeps an earlier name compiles
|
|
463
|
+
and runs unchanged in this release. The TypeScript tools mark the earlier
|
|
464
|
+
name as deprecated.
|
|
465
|
+
2. Set each option by one name only. If your code sets both names, for example
|
|
466
|
+
during a migration, give them the same value or remove the earlier name.
|
|
467
|
+
3. In a class or object that implements `SignalProtocolRelayServer`,
|
|
468
|
+
`SignalProtocolContentAdapter`, or `HostedSignalProtocolRelayBootstrapResult`,
|
|
469
|
+
add the new member and keep the earlier member. This release requires the
|
|
470
|
+
earlier member. Let one member forward to the other, or give both the same
|
|
471
|
+
value. SDK 15.0.0 requires the new member and removes the earlier member.
|
|
472
|
+
4. Find each read of `relayScopeId` or `relayUrl` from your own
|
|
473
|
+
`SealedSenderConfig`, `GroupAuthorityFields`, or
|
|
474
|
+
`HostedSignalProtocolRelayIdentityMigrationOptions` object. This release
|
|
475
|
+
makes the field optional, so the type of the read includes `undefined`.
|
|
476
|
+
With the TypeScript `strict` option, this function compiles with SDK 14.1.0
|
|
477
|
+
only:
|
|
478
|
+
|
|
479
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
480
|
+
```ts
|
|
481
|
+
import type { SealedSenderConfig } from '@open-e2ee/signal-protocol-sdk';
|
|
482
|
+
|
|
483
|
+
function scopeOf(config: SealedSenderConfig): Uint8Array {
|
|
484
|
+
return config.relayScopeId;
|
|
485
|
+
}
|
|
486
|
+
```
|
|
487
|
+
|
|
488
|
+
Read the new name first and the earlier name second, and handle
|
|
489
|
+
`undefined`. This function compiles with this release:
|
|
490
|
+
|
|
491
|
+
<!-- doc-snippet:skip requires-external-context -->
|
|
492
|
+
```ts
|
|
493
|
+
import type { SealedSenderConfig } from '@open-e2ee/signal-protocol-sdk';
|
|
494
|
+
|
|
495
|
+
function scopeOf(config: SealedSenderConfig): Uint8Array {
|
|
496
|
+
const scope = config.signalProtocolRelayScopeId ?? config.relayScopeId;
|
|
497
|
+
if (scope === undefined) {
|
|
498
|
+
throw new Error('The sealed sender configuration has no Relay scope.');
|
|
499
|
+
}
|
|
500
|
+
return scope;
|
|
501
|
+
}
|
|
502
|
+
```
|
|
503
|
+
|
|
504
|
+
When your code sets only `signalProtocolRelayScopeId`, remove
|
|
505
|
+
`?? config.relayScopeId`. SDK 15.0.0 removes the earlier name. Do the same
|
|
506
|
+
for `relayUrl` with `signalProtocolRelayUrl`.
|
|
507
|
+
|
|
3
508
|
## 14.1.0
|
|
4
509
|
|
|
5
510
|
### Added
|
package/README.md
CHANGED
|
@@ -16,7 +16,7 @@ The default policy requires post-quantum session establishment and ratcheting. T
|
|
|
16
16
|
[](https://www.npmjs.com/package/@open-e2ee/signal-protocol-sdk#user-content-provenance)
|
|
17
17
|
[](https://github.com/open-e2ee/signal-protocol-js/actions/workflows/ci.yml)
|
|
18
18
|
|
|
19
|
-
[Documentation](https://docs.open-e2ee.dev) · [API reference](https://docs.open-e2ee.dev/reference/api) · [OpenE2EE Signal Protocol Relay](https://open-e2ee.dev/relay/) · [Security](./SECURITY.md)
|
|
19
|
+
[Documentation](https://docs.open-e2ee.dev) · [API reference](https://docs.open-e2ee.dev/reference/api) · [OpenE2EE Signal Protocol Relay](https://open-e2ee.dev/signal-relay/) · [Security](./SECURITY.md)
|
|
20
20
|
|
|
21
21
|
## See an encrypted round trip
|
|
22
22
|
|
|
@@ -29,13 +29,13 @@ The demonstrations use real protocol code and cryptography. Application integrat
|
|
|
29
29
|
- **Session establishment and ratcheting.** PQXDH establishes sessions. The ML-KEM Braid ratchet adds post-quantum key updates. Required post-quantum operations fail closed.
|
|
30
30
|
- **Chat features.** Multi-device messaging, groups, sealed sender, encrypted attachments, and safety-number verification use the same package.
|
|
31
31
|
- **Device-local state.** Storage adapters keep identities, sessions, and message state on the device.
|
|
32
|
-
- **Hosted delivery.** Connect to [OpenE2EE Signal Protocol Relay](https://open-e2ee.dev/relay/) with the hosted client factory. Advanced integrations can supply a custom transport. A hosted client sends a sealed 1:1 message only with `hosted.profileKeys`. It must also hold the contact's profile key.
|
|
32
|
+
- **Hosted delivery.** Connect to [OpenE2EE Signal Protocol Relay](https://open-e2ee.dev/signal-relay/) with the hosted client factory. Advanced integrations can supply a custom transport. A hosted client sends a sealed 1:1 message only with `hosted.profileKeys`. It must also hold the contact's profile key.
|
|
33
33
|
|
|
34
34
|
The relay never needs message plaintext or device private keys.
|
|
35
35
|
|
|
36
36
|
The OpenE2EE Signal Protocol SDK implements a versioned profile of the published Signal Protocol specifications. It is not affiliated with Signal Messenger and is **not wire-compatible with Signal Messenger or libsignal**. Messages, identities, and safety numbers do not interoperate. See the [notice](./NOTICE) and [documented deviations](./docs/DEVIATIONS.md).
|
|
37
37
|
|
|
38
|
-
Version `14.
|
|
38
|
+
Version `14.3.x`. Public APIs and persisted formats follow semantic versioning.
|
|
39
39
|
|
|
40
40
|
## Install
|
|
41
41
|
|
|
@@ -47,15 +47,18 @@ Local development needs Node 22.12 or later. The storage guides list platform re
|
|
|
47
47
|
|
|
48
48
|
## Connect to the Signal Protocol Relay
|
|
49
49
|
|
|
50
|
-
Follow the [Sandbox quickstart](https://docs.open-e2ee.dev/relay#sandbox-quickstart).
|
|
50
|
+
Follow the [Sandbox quickstart](https://docs.open-e2ee.dev/signal-relay#sandbox-quickstart).
|
|
51
51
|
In the application directory, `oe new` creates the Relay project and its Sandbox
|
|
52
52
|
environment. It writes the connection URL to `.env.local` as
|
|
53
|
-
`
|
|
54
|
-
the public prefix of the framework, for example
|
|
53
|
+
`OPEN_E2EE_SIGNAL_RELAY_URL`. In a Next.js, Expo, or Vite application, the name
|
|
54
|
+
has the public prefix of the framework, for example
|
|
55
|
+
`EXPO_PUBLIC_OPEN_E2EE_SIGNAL_RELAY_URL`. An `oe` release before 5.0.0 wrote the
|
|
56
|
+
earlier name, such as `OPEN_E2EE_RELAY_URL`. The examples read the new name
|
|
57
|
+
first and the earlier name second.
|
|
55
58
|
The URL is public configuration. It is not a credential.
|
|
56
59
|
|
|
57
60
|
A new Sandbox environment defaults to device-owned identity.
|
|
58
|
-
`
|
|
61
|
+
`hostedSignalProtocolRelaySandboxIdentity` signs the identity assertion with a key that it keeps in the device-local store.
|
|
59
62
|
Use the same store for the client.
|
|
60
63
|
|
|
61
64
|
This example needs that Sandbox environment. It is not an offline script.
|
|
@@ -64,24 +67,26 @@ This example needs that Sandbox environment. It is not an offline script.
|
|
|
64
67
|
```ts
|
|
65
68
|
import {
|
|
66
69
|
createHostedSignalProtocolClient,
|
|
67
|
-
|
|
70
|
+
hostedSignalProtocolRelaySandboxIdentity,
|
|
68
71
|
} from "@open-e2ee/signal-protocol-sdk";
|
|
69
72
|
|
|
70
73
|
const signal = await createHostedSignalProtocolClient({
|
|
71
74
|
adapters: { storage },
|
|
72
75
|
hosted: {
|
|
73
|
-
relayUrl: process.env.OPEN_E2EE_RELAY_URL!,
|
|
74
|
-
getIdentityAssertion:
|
|
76
|
+
relayUrl: process.env.OPEN_E2EE_SIGNAL_RELAY_URL ?? process.env.OPEN_E2EE_RELAY_URL!,
|
|
77
|
+
getIdentityAssertion: hostedSignalProtocolRelaySandboxIdentity(storage),
|
|
75
78
|
},
|
|
76
79
|
});
|
|
77
80
|
```
|
|
78
81
|
|
|
79
|
-
`
|
|
80
|
-
project in device-owned mode uses `
|
|
82
|
+
`hostedSignalProtocolRelaySandboxIdentity` works only in a Sandbox environment. A production
|
|
83
|
+
project in device-owned mode uses `hostedSignalProtocolRelayDeviceOwnedIdentity(storage)`. A
|
|
81
84
|
production project in application-bound mode needs a `getIdentityAssertion`
|
|
82
85
|
callback that returns a short-lived assertion for the signed-in user from your
|
|
83
|
-
backend.
|
|
84
|
-
|
|
86
|
+
backend. With a [native Clerk or Firebase profile](./docs/RECIPES.md#native-provider-profiles),
|
|
87
|
+
the callback returns the provider token instead. The
|
|
88
|
+
[identity guide](https://docs.open-e2ee.dev/signal-relay/identity) describes the
|
|
89
|
+
production setup.
|
|
85
90
|
|
|
86
91
|
Register a handler before you start incoming delivery. Persist each message
|
|
87
92
|
before the handler resolves, and use its ID to make repeated writes idempotent.
|
|
@@ -100,9 +105,9 @@ public prekeys. `send()` establishes the recipient sessions and sends encrypted
|
|
|
100
105
|
envelopes. The receive handler gets plaintext after device-local decryption.
|
|
101
106
|
See [client composition](./docs/CLIENT_COMPOSITION.md) for platform setup.
|
|
102
107
|
|
|
103
|
-
## Use your app’s storage and
|
|
108
|
+
## Use your app’s storage and message delivery
|
|
104
109
|
|
|
105
|
-
Choose the device-local store for your runtime. Then supply a relay that authenticates each device and implements your product's access policy, or use [OpenE2EE Signal Protocol Relay](https://open-e2ee.dev/relay/) as the managed delivery path. The SDK does not require the managed service. [Review Relay plans and exact meter definitions.](https://open-e2ee.dev/pricing/#relay-plans)
|
|
110
|
+
Choose the device-local store for your runtime. Then supply a relay that authenticates each device and implements your product's access policy, or use [OpenE2EE Signal Protocol Relay](https://open-e2ee.dev/signal-relay/) as the managed delivery path. The SDK does not require the managed service. [Review Relay plans and exact meter definitions.](https://open-e2ee.dev/pricing/#signal-relay-plans)
|
|
106
111
|
|
|
107
112
|
| Runtime | Storage path | Deployment boundary |
|
|
108
113
|
|---|---|---|
|
|
@@ -117,9 +122,9 @@ React Native support starts at React Native 0.83.6 and Expo SDK 55. The peer ran
|
|
|
117
122
|
|
|
118
123
|
| CI check | Versions |
|
|
119
124
|
|---|---|
|
|
120
|
-
| Add the packed package to a project | React Native 0.83, 0.85, 0.86, and 0.87; Expo SDK 55, 56, and
|
|
121
|
-
| Build the Expo example's Hermes bundle | Expo SDK 55 and
|
|
122
|
-
| Run the Expo example's release build on an Android emulator | Expo SDK
|
|
125
|
+
| Add the packed package to a project | React Native 0.83, 0.85, 0.86, and 0.87; Expo SDK 55, 56, 57, and 58 |
|
|
126
|
+
| Build the Expo example's Hermes bundle | Expo SDK 55 and 58 |
|
|
127
|
+
| Run the Expo example's release build on an Android emulator | Expo SDK 58 with React Native 0.88 |
|
|
123
128
|
|
|
124
129
|
React Native 0.84 and later use Hermes V1 by default. React Native 0.82 and later run only on the New Architecture.
|
|
125
130
|
|