@open-e2ee/signal-protocol-sdk 11.0.0 → 12.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 +4 -4
- package/ARCHITECTURE.md +6 -8
- package/CHANGELOG.md +1315 -0
- package/README.md +1 -1
- package/SECURITY.md +2 -2
- package/TROUBLESHOOTING.md +1 -1
- package/client/README.md +70 -37
- package/device/README.md +39 -85
- package/dist/client/client.d.ts +334 -63
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +1168 -184
- package/dist/client/client.js.map +1 -1
- package/dist/client/config.d.ts +40 -32
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/config.js +1 -1
- package/dist/client/config.js.map +1 -1
- package/dist/client/constants.d.ts +42 -8
- package/dist/client/constants.d.ts.map +1 -1
- package/dist/client/constants.js +48 -3
- package/dist/client/constants.js.map +1 -1
- package/dist/client/content-adapter.d.ts +80 -0
- package/dist/client/content-adapter.d.ts.map +1 -1
- package/dist/client/content-adapter.js +225 -12
- package/dist/client/content-adapter.js.map +1 -1
- package/dist/client/delivery-error.d.ts +150 -0
- package/dist/client/delivery-error.d.ts.map +1 -0
- package/dist/client/delivery-error.js +226 -0
- package/dist/client/delivery-error.js.map +1 -0
- package/dist/client/delivery-status.d.ts +32 -6
- package/dist/client/delivery-status.d.ts.map +1 -1
- package/dist/client/delivery-status.js +61 -13
- package/dist/client/delivery-status.js.map +1 -1
- package/dist/client/device-set-reconciliation.d.ts +196 -0
- package/dist/client/device-set-reconciliation.d.ts.map +1 -0
- package/dist/client/device-set-reconciliation.js +282 -0
- package/dist/client/device-set-reconciliation.js.map +1 -0
- package/dist/client/distribution-records.d.ts +29 -0
- package/dist/client/distribution-records.d.ts.map +1 -0
- package/dist/client/distribution-records.js +33 -0
- package/dist/client/distribution-records.js.map +1 -0
- package/dist/client/event-hooks.d.ts +280 -14
- package/dist/client/event-hooks.d.ts.map +1 -1
- package/dist/client/event-hooks.js +8 -0
- package/dist/client/event-hooks.js.map +1 -1
- package/dist/client/group-device-set.d.ts +47 -0
- package/dist/client/group-device-set.d.ts.map +1 -0
- package/dist/client/group-device-set.js +65 -0
- package/dist/client/group-device-set.js.map +1 -0
- package/dist/client/group-fetcher.d.ts +116 -0
- package/dist/client/group-fetcher.d.ts.map +1 -0
- package/dist/client/group-fetcher.js +598 -0
- package/dist/client/group-fetcher.js.map +1 -0
- package/dist/client/group-outbox.d.ts +172 -10
- package/dist/client/group-outbox.d.ts.map +1 -1
- package/dist/client/group-outbox.js +915 -74
- package/dist/client/group-outbox.js.map +1 -1
- package/dist/client/group-receive-authorization.d.ts +127 -4
- package/dist/client/group-receive-authorization.d.ts.map +1 -1
- package/dist/client/group-receive-authorization.js +270 -20
- package/dist/client/group-receive-authorization.js.map +1 -1
- package/dist/client/group-sealed-sender.d.ts +3 -0
- package/dist/client/group-sealed-sender.d.ts.map +1 -1
- package/dist/client/group-sealed-sender.js +1 -0
- package/dist/client/group-sealed-sender.js.map +1 -1
- package/dist/client/group-sender-key-operations.d.ts +14 -3
- package/dist/client/group-sender-key-operations.d.ts.map +1 -1
- package/dist/client/group-sender-key-operations.js +26 -5
- package/dist/client/group-sender-key-operations.js.map +1 -1
- package/dist/client/groups.d.ts +5 -5
- package/dist/client/groups.d.ts.map +1 -1
- package/dist/client/groups.js +5 -4
- package/dist/client/groups.js.map +1 -1
- package/dist/client/hosted-anonymous-delivery.d.ts +61 -9
- package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -1
- package/dist/client/hosted-anonymous-delivery.js +242 -48
- package/dist/client/hosted-anonymous-delivery.js.map +1 -1
- package/dist/client/hosted-assertion-id.d.ts +7 -0
- package/dist/client/hosted-assertion-id.d.ts.map +1 -0
- package/dist/client/hosted-assertion-id.js +51 -0
- package/dist/client/hosted-assertion-id.js.map +1 -0
- package/dist/client/hosted-mailbox-subscription.d.ts +34 -2
- package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -1
- package/dist/client/hosted-mailbox-subscription.js +87 -17
- package/dist/client/hosted-mailbox-subscription.js.map +1 -1
- package/dist/client/hosted-push.d.ts +22 -4
- package/dist/client/hosted-push.d.ts.map +1 -1
- package/dist/client/hosted-push.js +75 -22
- package/dist/client/hosted-push.js.map +1 -1
- package/dist/client/hosted-transport.d.ts +22 -28
- package/dist/client/hosted-transport.d.ts.map +1 -1
- package/dist/client/hosted-transport.js +115 -55
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/hosted.d.ts +10 -4
- package/dist/client/hosted.d.ts.map +1 -1
- package/dist/client/hosted.js +10 -4
- package/dist/client/hosted.js.map +1 -1
- package/dist/client/index.d.ts +5 -3
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +2 -0
- package/dist/client/index.js.map +1 -1
- package/dist/client/messages.d.ts +25 -3
- package/dist/client/messages.d.ts.map +1 -1
- package/dist/client/messages.js +111 -20
- package/dist/client/messages.js.map +1 -1
- package/dist/client/receive-admission.d.ts +58 -0
- package/dist/client/receive-admission.d.ts.map +1 -0
- package/dist/client/receive-admission.js +78 -0
- package/dist/client/receive-admission.js.map +1 -0
- package/dist/client/receive-expiry.d.ts +31 -0
- package/dist/client/receive-expiry.d.ts.map +1 -0
- package/dist/client/receive-expiry.js +35 -0
- package/dist/client/receive-expiry.js.map +1 -0
- package/dist/client/receive-hook-bound.d.ts +50 -0
- package/dist/client/receive-hook-bound.d.ts.map +1 -0
- package/dist/client/receive-hook-bound.js +115 -0
- package/dist/client/receive-hook-bound.js.map +1 -0
- package/dist/client/receive-queue.d.ts +299 -0
- package/dist/client/receive-queue.d.ts.map +1 -0
- package/dist/client/receive-queue.js +1420 -0
- package/dist/client/receive-queue.js.map +1 -0
- package/dist/client/receive-work-seed.d.ts +54 -0
- package/dist/client/receive-work-seed.d.ts.map +1 -0
- package/dist/client/receive-work-seed.js +116 -0
- package/dist/client/receive-work-seed.js.map +1 -0
- package/dist/client/recovery-driver.d.ts +25 -0
- package/dist/client/recovery-driver.d.ts.map +1 -0
- package/dist/client/recovery-driver.js +121 -0
- package/dist/client/recovery-driver.js.map +1 -0
- package/dist/client/relay-acceptance.d.ts +20 -7
- package/dist/client/relay-acceptance.d.ts.map +1 -1
- package/dist/client/relay-acceptance.js +30 -12
- package/dist/client/relay-acceptance.js.map +1 -1
- package/dist/client/relay-device-refusal.d.ts +18 -0
- package/dist/client/relay-device-refusal.d.ts.map +1 -1
- package/dist/client/relay-device-refusal.js +31 -0
- package/dist/client/relay-device-refusal.js.map +1 -1
- package/dist/client/relay-sealed-route.d.ts +36 -0
- package/dist/client/relay-sealed-route.d.ts.map +1 -0
- package/dist/client/relay-sealed-route.js +45 -0
- package/dist/client/relay-sealed-route.js.map +1 -0
- package/dist/client/relay-subscription.d.ts +56 -13
- package/dist/client/relay-subscription.d.ts.map +1 -1
- package/dist/client/relay-subscription.js +193 -123
- package/dist/client/relay-subscription.js.map +1 -1
- package/dist/client/resendable-content.d.ts +98 -0
- package/dist/client/resendable-content.d.ts.map +1 -0
- package/dist/client/resendable-content.js +136 -0
- package/dist/client/resendable-content.js.map +1 -0
- package/dist/client/retry-family.d.ts +57 -10
- package/dist/client/retry-family.d.ts.map +1 -1
- package/dist/client/retry-family.js +54 -12
- package/dist/client/retry-family.js.map +1 -1
- package/dist/client/retry-request-envelope.d.ts +107 -8
- package/dist/client/retry-request-envelope.d.ts.map +1 -1
- package/dist/client/retry-request-envelope.js +172 -23
- package/dist/client/retry-request-envelope.js.map +1 -1
- package/dist/client/retry-request-lifecycle.d.ts +70 -14
- package/dist/client/retry-request-lifecycle.d.ts.map +1 -1
- package/dist/client/retry-request-lifecycle.js +162 -32
- package/dist/client/retry-request-lifecycle.js.map +1 -1
- package/dist/client/retry-terminal-recovery.d.ts +100 -0
- package/dist/client/retry-terminal-recovery.d.ts.map +1 -0
- package/dist/client/retry-terminal-recovery.js +164 -0
- package/dist/client/retry-terminal-recovery.js.map +1 -0
- package/dist/client/retry-utils.d.ts +27 -0
- package/dist/client/retry-utils.d.ts.map +1 -1
- package/dist/client/retry-utils.js +46 -0
- package/dist/client/retry-utils.js.map +1 -1
- package/dist/client/retry.d.ts +100 -12
- package/dist/client/retry.d.ts.map +1 -1
- package/dist/client/retry.js +619 -116
- package/dist/client/retry.js.map +1 -1
- package/dist/client/sealed-sender.d.ts +23 -6
- package/dist/client/sealed-sender.d.ts.map +1 -1
- package/dist/client/sealed-sender.js +30 -6
- package/dist/client/sealed-sender.js.map +1 -1
- package/dist/client/sessions.d.ts +2 -2
- package/dist/client/sessions.js +2 -2
- package/dist/client/signal-service-cipher.d.ts +726 -19
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +2260 -342
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/state.d.ts +5 -0
- package/dist/client/state.d.ts.map +1 -1
- package/dist/client/state.js +11 -1
- package/dist/client/state.js.map +1 -1
- package/dist/client/storage-protection.d.ts +64 -0
- package/dist/client/storage-protection.d.ts.map +1 -0
- package/dist/client/storage-protection.js +150 -0
- package/dist/client/storage-protection.js.map +1 -0
- package/dist/client/types.d.ts +149 -15
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js +1 -1
- package/dist/client/types.js.map +1 -1
- package/dist/device/constants.d.ts +0 -5
- package/dist/device/constants.d.ts.map +1 -1
- package/dist/device/constants.js +0 -5
- package/dist/device/constants.js.map +1 -1
- package/dist/device/expo/index.d.ts +4 -17
- package/dist/device/expo/index.d.ts.map +1 -1
- package/dist/device/expo/index.js +4 -23
- package/dist/device/expo/index.js.map +1 -1
- package/dist/device/index.d.ts +0 -2
- package/dist/device/index.d.ts.map +1 -1
- package/dist/device/index.js +0 -7
- package/dist/device/index.js.map +1 -1
- package/dist/device/lifecycle/manager.d.ts +5 -4
- package/dist/device/lifecycle/manager.d.ts.map +1 -1
- package/dist/device/lifecycle/manager.js +16 -16
- package/dist/device/lifecycle/manager.js.map +1 -1
- package/dist/device/lifecycle/types.d.ts +2 -2
- package/dist/device/lifecycle/types.d.ts.map +1 -1
- package/dist/device/react-native/index.d.ts +4 -15
- package/dist/device/react-native/index.d.ts.map +1 -1
- package/dist/device/react-native/index.js +4 -21
- package/dist/device/react-native/index.js.map +1 -1
- package/dist/device/types.d.ts +1 -1
- package/dist/groups/index.d.ts +1 -1
- package/dist/groups/index.d.ts.map +1 -1
- package/dist/index.d.ts +8 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.d.ts +0 -1
- package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.js +0 -1
- package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
- package/dist/internal/crypto/validation.d.ts +2 -2
- package/dist/internal/groups/index.d.ts +1 -0
- package/dist/internal/groups/index.d.ts.map +1 -1
- package/dist/internal/groups/index.js +1 -0
- package/dist/internal/groups/index.js.map +1 -1
- package/dist/internal/groups/manager.d.ts +37 -16
- package/dist/internal/groups/manager.d.ts.map +1 -1
- package/dist/internal/groups/manager.js +46 -1
- package/dist/internal/groups/manager.js.map +1 -1
- package/dist/internal/groups/receive-record.d.ts +78 -0
- package/dist/internal/groups/receive-record.d.ts.map +1 -0
- package/dist/internal/groups/receive-record.js +43 -0
- package/dist/internal/groups/receive-record.js.map +1 -0
- package/dist/internal/groups/sdk-store.d.ts +27 -3
- package/dist/internal/groups/sdk-store.d.ts.map +1 -1
- package/dist/internal/groups/sdk-store.js +151 -19
- package/dist/internal/groups/sdk-store.js.map +1 -1
- package/dist/internal/groups/wire.d.ts +12 -1
- package/dist/internal/groups/wire.d.ts.map +1 -1
- package/dist/internal/groups/wire.js +36 -0
- package/dist/internal/groups/wire.js.map +1 -1
- package/dist/internal/manager/index.d.ts +1 -1
- package/dist/internal/manager/manager.d.ts +20 -19
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +56 -39
- package/dist/internal/manager/manager.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.d.ts +4 -18
- package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.js +23 -74
- package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/index.d.ts +1 -1
- package/dist/internal/protocol/double-ratchet/index.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/index.js +1 -1
- package/dist/internal/protocol/double-ratchet/index.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts +5 -7
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.js +4 -6
- package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.js +2 -1
- package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
- package/dist/internal/protocol/sealed-sender/types.d.ts +6 -8
- package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
- package/dist/internal/protocol/sealed-sender/types.js +8 -9
- package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
- package/dist/internal/protocol/sender-keys/handoff-ledger.d.ts +110 -0
- package/dist/internal/protocol/sender-keys/handoff-ledger.d.ts.map +1 -0
- package/dist/internal/protocol/sender-keys/handoff-ledger.js +124 -0
- package/dist/internal/protocol/sender-keys/handoff-ledger.js.map +1 -0
- package/dist/internal/protocol/sender-keys/manager.d.ts +71 -62
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +228 -175
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/index.d.ts +2 -2
- package/dist/internal/protocol/spqr/index.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/index.js +2 -2
- package/dist/internal/protocol/spqr/index.js.map +1 -1
- package/dist/internal/protocol/spqr/serialize.d.ts +9 -1
- package/dist/internal/protocol/spqr/serialize.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/serialize.js +56 -16
- package/dist/internal/protocol/spqr/serialize.js.map +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts +1 -14
- package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.js +54 -42
- package/dist/internal/protocol/spqr/spqr.js.map +1 -1
- package/dist/internal/protocol/spqr/validate.d.ts +26 -6
- package/dist/internal/protocol/spqr/validate.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/validate.js +49 -21
- package/dist/internal/protocol/spqr/validate.js.map +1 -1
- package/dist/internal/sesame/index.d.ts +1 -1
- package/dist/internal/sesame/index.d.ts.map +1 -1
- package/dist/internal/sesame/index.js.map +1 -1
- package/dist/internal/sesame/manager.d.ts +66 -13
- package/dist/internal/sesame/manager.d.ts.map +1 -1
- package/dist/internal/sesame/manager.js +221 -87
- package/dist/internal/sesame/manager.js.map +1 -1
- package/dist/internal/sesame/types.d.ts +95 -17
- package/dist/internal/sesame/types.d.ts.map +1 -1
- package/dist/internal/sesame/types.js +17 -0
- package/dist/internal/sesame/types.js.map +1 -1
- package/dist/internal/session/builder.d.ts +5 -5
- package/dist/internal/session/builder.d.ts.map +1 -1
- package/dist/internal/session/builder.js +12 -17
- package/dist/internal/session/builder.js.map +1 -1
- package/dist/internal/session/cipher.d.ts +13 -11
- package/dist/internal/session/cipher.d.ts.map +1 -1
- package/dist/internal/session/cipher.js +40 -22
- package/dist/internal/session/cipher.js.map +1 -1
- package/dist/internal/session/factory.d.ts +5 -5
- package/dist/internal/session/factory.d.ts.map +1 -1
- package/dist/internal/session/factory.js +4 -4
- package/dist/internal/session/factory.js.map +1 -1
- package/dist/internal/session/handshake.d.ts +14 -16
- package/dist/internal/session/handshake.d.ts.map +1 -1
- package/dist/internal/session/handshake.js +18 -75
- package/dist/internal/session/handshake.js.map +1 -1
- package/dist/internal/session/index.d.ts +1 -1
- package/dist/internal/session/index.js +1 -1
- package/dist/internal/session/record-locks.d.ts +17 -6
- package/dist/internal/session/record-locks.d.ts.map +1 -1
- package/dist/internal/session/record-locks.js +43 -7
- package/dist/internal/session/record-locks.js.map +1 -1
- package/dist/internal/session/session-resolver.d.ts +1 -1
- package/dist/internal/session/session-resolver.js +1 -1
- package/dist/internal/session/state.d.ts +2 -2
- package/dist/internal/session/state.js +1 -1
- package/dist/internal/session/types.d.ts +4 -12
- package/dist/internal/session/types.d.ts.map +1 -1
- package/dist/internal/session/types.js +1 -1
- package/dist/keys/generation.d.ts +2 -2
- package/dist/keys/generation.js +2 -2
- package/dist/keys/types.d.ts +5 -5
- package/dist/keys/types.d.ts.map +1 -1
- package/dist/keys/types.js +1 -1
- package/dist/layers.d.ts +1 -1
- package/dist/layers.js +2 -2
- package/dist/layers.js.map +1 -1
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +12 -8
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/key-value/adapter.d.ts +76 -10
- package/dist/local/store/key-value/adapter.d.ts.map +1 -1
- package/dist/local/store/key-value/adapter.js +367 -61
- package/dist/local/store/key-value/adapter.js.map +1 -1
- package/dist/local/store/key-value/backend-conformance.d.ts.map +1 -1
- package/dist/local/store/key-value/backend-conformance.js +74 -0
- package/dist/local/store/key-value/backend-conformance.js.map +1 -1
- package/dist/local/store/key-value/batch.d.ts +2 -0
- package/dist/local/store/key-value/batch.d.ts.map +1 -1
- package/dist/local/store/key-value/batch.js +26 -0
- package/dist/local/store/key-value/batch.js.map +1 -1
- package/dist/local/store/key-value/receive-work.d.ts +55 -0
- package/dist/local/store/key-value/receive-work.d.ts.map +1 -0
- package/dist/local/store/key-value/receive-work.js +162 -0
- package/dist/local/store/key-value/receive-work.js.map +1 -0
- package/dist/local/store/key-value/send-log.d.ts +61 -0
- package/dist/local/store/key-value/send-log.d.ts.map +1 -0
- package/dist/local/store/key-value/send-log.js +430 -0
- package/dist/local/store/key-value/send-log.js.map +1 -0
- package/dist/local/store/key-value/sender-key-handoff.d.ts +68 -0
- package/dist/local/store/key-value/sender-key-handoff.d.ts.map +1 -0
- package/dist/local/store/key-value/sender-key-handoff.js +189 -0
- package/dist/local/store/key-value/sender-key-handoff.js.map +1 -0
- package/dist/local/store/key-value/storage.d.ts +15 -0
- package/dist/local/store/key-value/storage.d.ts.map +1 -1
- package/dist/local/store/keyed-index.d.ts +23 -0
- package/dist/local/store/keyed-index.d.ts.map +1 -0
- package/dist/local/store/keyed-index.js +41 -0
- package/dist/local/store/keyed-index.js.map +1 -0
- package/dist/local/store/memory/adapter.d.ts +44 -12
- package/dist/local/store/memory/adapter.d.ts.map +1 -1
- package/dist/local/store/memory/adapter.js +197 -46
- package/dist/local/store/memory/adapter.js.map +1 -1
- package/dist/local/store/memory/send-log.d.ts +42 -0
- package/dist/local/store/memory/send-log.d.ts.map +1 -0
- package/dist/local/store/memory/send-log.js +190 -0
- package/dist/local/store/memory/send-log.js.map +1 -0
- package/dist/local/store/node/adapter.d.ts.map +1 -1
- package/dist/local/store/node/adapter.js +8 -6
- package/dist/local/store/node/adapter.js.map +1 -1
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +12 -8
- package/dist/local/store/react-native/adapter.js.map +1 -1
- package/dist/local/store/receive-work.d.ts +87 -0
- package/dist/local/store/receive-work.d.ts.map +1 -0
- package/dist/local/store/receive-work.js +204 -0
- package/dist/local/store/receive-work.js.map +1 -0
- package/dist/local/store/received-content.d.ts +3 -3
- package/dist/local/store/received-content.d.ts.map +1 -1
- package/dist/local/store/received-content.js +2 -11
- package/dist/local/store/received-content.js.map +1 -1
- package/dist/local/store/reliability.d.ts +317 -18
- package/dist/local/store/reliability.d.ts.map +1 -1
- package/dist/local/store/reliability.js +371 -46
- package/dist/local/store/reliability.js.map +1 -1
- package/dist/local/store/send-log-order.d.ts +15 -0
- package/dist/local/store/send-log-order.d.ts.map +1 -0
- package/dist/local/store/send-log-order.js +24 -0
- package/dist/local/store/send-log-order.js.map +1 -0
- package/dist/local/store/sender-key-handoff-index.d.ts +38 -0
- package/dist/local/store/sender-key-handoff-index.d.ts.map +1 -0
- package/dist/local/store/sender-key-handoff-index.js +101 -0
- package/dist/local/store/sender-key-handoff-index.js.map +1 -0
- package/dist/local/store/sender-key-handoff-table.d.ts +29 -0
- package/dist/local/store/sender-key-handoff-table.d.ts.map +1 -0
- package/dist/local/store/sender-key-handoff-table.js +97 -0
- package/dist/local/store/sender-key-handoff-table.js.map +1 -0
- package/dist/local/store/sqlite/encryption.d.ts +8 -1
- package/dist/local/store/sqlite/encryption.d.ts.map +1 -1
- package/dist/local/store/sqlite/encryption.js +9 -0
- package/dist/local/store/sqlite/encryption.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/index.d.ts +25 -4
- package/dist/local/store/sqlite/key-storage/index.d.ts.map +1 -1
- package/dist/local/store/sqlite/key-storage/index.js +68 -7
- package/dist/local/store/sqlite/key-storage/index.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/message-records.d.ts +16 -4
- package/dist/local/store/sqlite/key-storage/message-records.d.ts.map +1 -1
- package/dist/local/store/sqlite/key-storage/message-records.js +49 -6
- package/dist/local/store/sqlite/key-storage/message-records.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/metadata.d.ts +8 -7
- package/dist/local/store/sqlite/key-storage/metadata.d.ts.map +1 -1
- package/dist/local/store/sqlite/key-storage/metadata.js +17 -15
- package/dist/local/store/sqlite/key-storage/metadata.js.map +1 -1
- package/dist/local/store/sqlite/key-storage/receive-work.d.ts +27 -0
- package/dist/local/store/sqlite/key-storage/receive-work.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/receive-work.js +98 -0
- package/dist/local/store/sqlite/key-storage/receive-work.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/send-log.d.ts +27 -0
- package/dist/local/store/sqlite/key-storage/send-log.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/send-log.js +178 -0
- package/dist/local/store/sqlite/key-storage/send-log.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/sender-key-handoff.d.ts +27 -0
- package/dist/local/store/sqlite/key-storage/sender-key-handoff.d.ts.map +1 -0
- package/dist/local/store/sqlite/key-storage/sender-key-handoff.js +75 -0
- package/dist/local/store/sqlite/key-storage/sender-key-handoff.js.map +1 -0
- package/dist/local/store/sqlite/key-storage/session-trust.d.ts +2 -2
- package/dist/local/store/sqlite/key-storage/session-trust.js +5 -5
- package/dist/local/store/sqlite/key-storage/session-trust.js.map +1 -1
- package/dist/local/store/sqlite/migrations.d.ts.map +1 -1
- package/dist/local/store/sqlite/migrations.js +101 -0
- package/dist/local/store/sqlite/migrations.js.map +1 -1
- package/dist/local/store/sqlite/models/index.d.ts +2 -1
- package/dist/local/store/sqlite/models/index.d.ts.map +1 -1
- package/dist/local/store/sqlite/models/index.js +5 -1
- package/dist/local/store/sqlite/models/index.js.map +1 -1
- package/dist/local/store/sqlite/models/message-record.d.ts +15 -0
- package/dist/local/store/sqlite/models/message-record.d.ts.map +1 -1
- package/dist/local/store/sqlite/models/message-record.js +24 -0
- package/dist/local/store/sqlite/models/message-record.js.map +1 -1
- package/dist/local/store/sqlite/models/send-log.d.ts +51 -0
- package/dist/local/store/sqlite/models/send-log.d.ts.map +1 -0
- package/dist/local/store/sqlite/models/send-log.js +206 -0
- package/dist/local/store/sqlite/models/send-log.js.map +1 -0
- package/dist/local/store/sqlite/open-store.d.ts +9 -1
- package/dist/local/store/sqlite/open-store.d.ts.map +1 -1
- package/dist/local/store/sqlite/open-store.js +20 -1
- package/dist/local/store/sqlite/open-store.js.map +1 -1
- package/dist/local/store/sqlite/schema.d.ts +34 -1
- package/dist/local/store/sqlite/schema.d.ts.map +1 -1
- package/dist/local/store/sqlite/schema.js +14 -0
- package/dist/local/store/sqlite/schema.js.map +1 -1
- package/dist/local/store/sqlite/store.d.ts +61 -11
- package/dist/local/store/sqlite/store.d.ts.map +1 -1
- package/dist/local/store/sqlite/store.js +191 -27
- package/dist/local/store/sqlite/store.js.map +1 -1
- package/dist/local/store/web/adapter.d.ts +76 -8
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +579 -127
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/local/store/web/receive-work.d.ts +57 -0
- package/dist/local/store/web/receive-work.d.ts.map +1 -0
- package/dist/local/store/web/receive-work.js +99 -0
- package/dist/local/store/web/receive-work.js.map +1 -0
- package/dist/local/store/web/send-log.d.ts +92 -0
- package/dist/local/store/web/send-log.d.ts.map +1 -0
- package/dist/local/store/web/send-log.js +267 -0
- package/dist/local/store/web/send-log.js.map +1 -0
- package/dist/local/store/web/sender-key-handoff.d.ts +81 -0
- package/dist/local/store/web/sender-key-handoff.d.ts.map +1 -0
- package/dist/local/store/web/sender-key-handoff.js +156 -0
- package/dist/local/store/web/sender-key-handoff.js.map +1 -0
- package/dist/local/store/web-sqlite/adapter.d.ts +2 -0
- package/dist/local/store/web-sqlite/adapter.d.ts.map +1 -1
- package/dist/local/store/web-sqlite/adapter.js +12 -6
- package/dist/local/store/web-sqlite/adapter.js.map +1 -1
- package/dist/local/vault/custody.d.ts +8 -0
- package/dist/local/vault/custody.d.ts.map +1 -0
- package/dist/local/vault/custody.js +9 -0
- package/dist/local/vault/custody.js.map +1 -0
- package/dist/local/vault/electron-safe-storage.d.ts +3 -1
- package/dist/local/vault/electron-safe-storage.d.ts.map +1 -1
- package/dist/local/vault/electron-safe-storage.js +2 -0
- package/dist/local/vault/electron-safe-storage.js.map +1 -1
- package/dist/local/vault/expo-secure-store.d.ts +3 -1
- package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
- package/dist/local/vault/expo-secure-store.js +2 -0
- package/dist/local/vault/expo-secure-store.js.map +1 -1
- package/dist/local/vault/indexed-db.d.ts +3 -1
- package/dist/local/vault/indexed-db.d.ts.map +1 -1
- package/dist/local/vault/indexed-db.js +2 -0
- package/dist/local/vault/indexed-db.js.map +1 -1
- package/dist/local/vault/react-native-keychain.d.ts +3 -1
- package/dist/local/vault/react-native-keychain.d.ts.map +1 -1
- package/dist/local/vault/react-native-keychain.js +2 -0
- package/dist/local/vault/react-native-keychain.js.map +1 -1
- package/dist/remote/relay/device-set.d.ts +94 -0
- package/dist/remote/relay/device-set.d.ts.map +1 -0
- package/dist/remote/relay/device-set.js +156 -0
- package/dist/remote/relay/device-set.js.map +1 -0
- package/dist/remote/relay/types.d.ts +92 -107
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/safety/core.d.ts +15 -6
- package/dist/safety/core.d.ts.map +1 -1
- package/dist/safety/core.js +41 -27
- package/dist/safety/core.js.map +1 -1
- package/dist/safety/index.d.ts +2 -1
- package/dist/safety/index.d.ts.map +1 -1
- package/dist/safety/index.js +12 -18
- package/dist/safety/index.js.map +1 -1
- package/dist/types/api.d.ts +707 -62
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/errors.d.ts +14 -33
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/errors.js +14 -24
- package/dist/types/errors.js.map +1 -1
- package/dist/types/messages.d.ts +2 -2
- package/dist/types/messages.js +1 -1
- package/dist/types/protocol-config.d.ts +175 -42
- package/dist/types/protocol-config.d.ts.map +1 -1
- package/dist/types/protocol-config.js +19 -38
- package/dist/types/protocol-config.js.map +1 -1
- package/dist/types/protocol-constants.d.ts +6 -6
- package/dist/types/protocol-constants.js +6 -6
- package/dist/types/session.d.ts +7 -7
- package/dist/types/session.d.ts.map +1 -1
- package/dist/types/session.js +39 -21
- package/dist/types/session.js.map +1 -1
- package/dist/username/link.d.ts +2 -2
- package/dist/username/link.js +2 -2
- package/dist/utils/origin-lock.d.ts +45 -0
- package/dist/utils/origin-lock.d.ts.map +1 -0
- package/dist/utils/origin-lock.js +80 -0
- package/dist/utils/origin-lock.js.map +1 -0
- package/docs/ASSURANCE.md +6 -6
- package/docs/CLIENT_COMPOSITION.md +2 -2
- package/docs/DEVIATIONS.md +677 -182
- package/docs/E2EE.md +1 -1
- package/docs/ERROR_HANDLING.md +165 -2
- package/docs/GETTING_STARTED.md +7 -4
- package/docs/INTERFACES.md +1 -1
- package/docs/PACKAGE_SURFACE.md +6 -5
- package/docs/PROTOCOL_POLICY.md +102 -22
- package/docs/RECIPES.md +3 -15
- package/docs/SECURITY.md +90 -5
- package/keys/README.md +3 -3
- package/local/store/README.md +78 -14
- package/local/store/key-value/README.md +14 -3
- package/local/store/node/README.md +8 -3
- package/local/store/web/README.md +9 -0
- package/local/store/web-sqlite/README.md +14 -2
- package/local/vault/README.md +21 -0
- package/package.json +1 -6
- package/remote/README.md +0 -1
- package/remote/relay/README.md +2 -2
- package/dist/device/provisioning.d.ts +0 -242
- package/dist/device/provisioning.d.ts.map +0 -1
- package/dist/device/provisioning.js +0 -421
- package/dist/device/provisioning.js.map +0 -1
- package/dist/internal/protocol/x3dh/index.d.ts +0 -15
- package/dist/internal/protocol/x3dh/index.d.ts.map +0 -1
- package/dist/internal/protocol/x3dh/index.js +0 -13
- package/dist/internal/protocol/x3dh/index.js.map +0 -1
- package/dist/internal/protocol/x3dh/x3dh.d.ts +0 -131
- package/dist/internal/protocol/x3dh/x3dh.d.ts.map +0 -1
- package/dist/internal/protocol/x3dh/x3dh.js +0 -261
- package/dist/internal/protocol/x3dh/x3dh.js.map +0 -1
|
@@ -6,6 +6,9 @@
|
|
|
6
6
|
*
|
|
7
7
|
*/
|
|
8
8
|
import { RetryReason } from '../internal/sesame/types.js';
|
|
9
|
+
import type { ContentHint } from '../types/messages.js';
|
|
10
|
+
import type { SenderKeyStore } from '../types/api.js';
|
|
11
|
+
import type { RetryRequestSource } from './retry-request-lifecycle.js';
|
|
9
12
|
/**
|
|
10
13
|
* Determine the appropriate retry reason based on error type
|
|
11
14
|
*
|
|
@@ -38,4 +41,28 @@ export declare function determineRetryReason(error: Error): RetryReason;
|
|
|
38
41
|
* @returns true if this is an expected retry case, false if unexpected failure
|
|
39
42
|
*/
|
|
40
43
|
export declare function isRetryableDecryptionError(error: Error): boolean;
|
|
44
|
+
/**
|
|
45
|
+
* Describe a failed envelope for its retry request, the same on every
|
|
46
|
+
* receive path. A `sender_key` envelope is a group message: its request
|
|
47
|
+
* carries no ratchet key, and its request record stores it as a group
|
|
48
|
+
* message, so a resend that brings only the sender key does not fulfill it.
|
|
49
|
+
* The envelope names no group. Its group is known only when the local
|
|
50
|
+
* sender key store holds the distribution that the frame names, as
|
|
51
|
+
* `resolveGroupForFramedMessage` tells, and the record then stores it in
|
|
52
|
+
* the form that `DecryptedEnvelope.conversationId` uses. A missing sender
|
|
53
|
+
* key gives no group. The content hint, which travels inside a seal, sets
|
|
54
|
+
* when the client reports the delivery error of the envelope.
|
|
55
|
+
*
|
|
56
|
+
* @param store - The sender key store of the local device
|
|
57
|
+
* @param envelope - The failed envelope, after any unseal
|
|
58
|
+
* @returns What the failed envelope names for `requestRetryInFamily`
|
|
59
|
+
*/
|
|
60
|
+
export declare function retryFailedEnvelope(store: Pick<SenderKeyStore, 'resolveGroupForSenderKeyId'>, envelope: {
|
|
61
|
+
readonly messageType?: string;
|
|
62
|
+
readonly clientMessageId?: string;
|
|
63
|
+
readonly contentHint?: ContentHint;
|
|
64
|
+
readonly senderUserId: string;
|
|
65
|
+
readonly senderDeviceId: number;
|
|
66
|
+
readonly ciphertext: string | Uint8Array;
|
|
67
|
+
}): Promise<NonNullable<RetryRequestSource['failedEnvelope']>>;
|
|
41
68
|
//# sourceMappingURL=retry-utils.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"retry-utils.d.ts","sourceRoot":"","sources":["../../client/retry-utils.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;
|
|
1
|
+
{"version":3,"file":"retry-utils.d.ts","sourceRoot":"","sources":["../../client/retry-utils.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAKnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;;;;;;;GAQG;AACH,OAAO,EAAE,CAAC;AACV,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,KAAK,GAAG,WAAW,CAuB9D;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,KAAK,GAAG,OAAO,CAsDhE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,mBAAmB,CACvC,KAAK,EAAE,IAAI,CAAC,cAAc,EAAE,4BAA4B,CAAC,EACzD,QAAQ,EAAE;IACR,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC;IACnC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,CAAC;CAC1C,GACA,OAAO,CAAC,WAAW,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAU5D"}
|
|
@@ -7,6 +7,9 @@
|
|
|
7
7
|
*/
|
|
8
8
|
import { EncryptionError, EncryptionErrorCode } from '../types/errors.js';
|
|
9
9
|
import { RetryReason } from '../internal/sesame/types.js';
|
|
10
|
+
import { base64ToBytes } from '../internal/crypto/utils.js';
|
|
11
|
+
import { extractGroupId } from '../internal/groups/group-id.js';
|
|
12
|
+
import { resolveGroupForFramedMessage } from '../internal/protocol/sender-keys/manager.js';
|
|
10
13
|
export function determineRetryReason(error) {
|
|
11
14
|
if (error instanceof EncryptionError) {
|
|
12
15
|
switch (error.code) {
|
|
@@ -97,4 +100,47 @@ export function isRetryableDecryptionError(error) {
|
|
|
97
100
|
}
|
|
98
101
|
return false;
|
|
99
102
|
}
|
|
103
|
+
/**
|
|
104
|
+
* Describe a failed envelope for its retry request, the same on every
|
|
105
|
+
* receive path. A `sender_key` envelope is a group message: its request
|
|
106
|
+
* carries no ratchet key, and its request record stores it as a group
|
|
107
|
+
* message, so a resend that brings only the sender key does not fulfill it.
|
|
108
|
+
* The envelope names no group. Its group is known only when the local
|
|
109
|
+
* sender key store holds the distribution that the frame names, as
|
|
110
|
+
* `resolveGroupForFramedMessage` tells, and the record then stores it in
|
|
111
|
+
* the form that `DecryptedEnvelope.conversationId` uses. A missing sender
|
|
112
|
+
* key gives no group. The content hint, which travels inside a seal, sets
|
|
113
|
+
* when the client reports the delivery error of the envelope.
|
|
114
|
+
*
|
|
115
|
+
* @param store - The sender key store of the local device
|
|
116
|
+
* @param envelope - The failed envelope, after any unseal
|
|
117
|
+
* @returns What the failed envelope names for `requestRetryInFamily`
|
|
118
|
+
*/
|
|
119
|
+
export async function retryFailedEnvelope(store, envelope) {
|
|
120
|
+
const groupMessage = envelope.messageType === 'sender_key';
|
|
121
|
+
const groupId = groupMessage ? await failedEnvelopeGroup(store, envelope) : null;
|
|
122
|
+
return {
|
|
123
|
+
...(envelope.clientMessageId !== undefined && { clientMessageId: envelope.clientMessageId }),
|
|
124
|
+
...(envelope.contentHint !== undefined && { contentHint: envelope.contentHint }),
|
|
125
|
+
senderKey: groupMessage,
|
|
126
|
+
groupMessage,
|
|
127
|
+
...(groupId !== null && { groupId }),
|
|
128
|
+
};
|
|
129
|
+
}
|
|
130
|
+
/** The group of a failed sender-key envelope, or null when the store does not know it. */
|
|
131
|
+
async function failedEnvelopeGroup(store, envelope) {
|
|
132
|
+
let framed;
|
|
133
|
+
try {
|
|
134
|
+
framed =
|
|
135
|
+
typeof envelope.ciphertext === 'string'
|
|
136
|
+
? base64ToBytes(envelope.ciphertext)
|
|
137
|
+
: envelope.ciphertext;
|
|
138
|
+
}
|
|
139
|
+
catch {
|
|
140
|
+
// A malformed envelope names no group.
|
|
141
|
+
return null;
|
|
142
|
+
}
|
|
143
|
+
const groupId = await resolveGroupForFramedMessage(store, framed, envelope.senderUserId, envelope.senderDeviceId);
|
|
144
|
+
return groupId === null ? null : extractGroupId(groupId);
|
|
145
|
+
}
|
|
100
146
|
//# sourceMappingURL=retry-utils.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"retry-utils.js","sourceRoot":"","sources":["../../client/retry-utils.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;
|
|
1
|
+
{"version":3,"file":"retry-utils.js","sourceRoot":"","sources":["../../client/retry-utils.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACvE,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAIvD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,4BAA4B,EAAE,MAAM,0CAA0C,CAAC;AAaxF,MAAM,UAAU,oBAAoB,CAAC,KAAY;IAC/C,IAAI,KAAK,YAAY,eAAe,EAAE,CAAC;QACrC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,mBAAmB,CAAC,iBAAiB;gBACxC,OAAO,WAAW,CAAC,UAAU,CAAC;YAChC,KAAK,mBAAmB,CAAC,iBAAiB,CAAC;YAC3C,KAAK,mBAAmB,CAAC,iBAAiB,CAAC;YAC3C,KAAK,mBAAmB,CAAC,kBAAkB,CAAC;YAC5C,KAAK,mBAAmB,CAAC,gBAAgB;gBACvC,gEAAgE;gBAChE,iEAAiE;gBACjE,qEAAqE;gBACrE,OAAO,WAAW,CAAC,iBAAiB,CAAC;YACvC,KAAK,mBAAmB,CAAC,kBAAkB;gBACzC,OAAO,WAAW,CAAC,qBAAqB,CAAC;YAC3C,KAAK,mBAAmB,CAAC,yBAAyB;gBAChD,OAAO,WAAW,CAAC,eAAe,CAAC;YACrC;gBACE,OAAO,WAAW,CAAC,iBAAiB,CAAC;QACzC,CAAC;IACH,CAAC;IACD,kEAAkE;IAClE,OAAO,WAAW,CAAC,iBAAiB,CAAC;AACvC,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,0BAA0B,CAAC,KAAY;IACrD,2EAA2E;IAC3E,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;IACjD,MAAM,mBAAmB,GAAG;QAC1B,4BAA4B;QAC5B,oBAAoB;QACpB,SAAS;QACT,YAAY;QACZ,mBAAmB;QACnB,iBAAiB;KAClB,CAAC;IAEF,IAAI,mBAAmB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;QAC1E,OAAO,IAAI,CAAC;IACd,CAAC;IAED,4DAA4D;IAC5D,IAAI,KAAK,YAAY,eAAe,EAAE,CAAC;QACrC,MAAM,cAAc,GAAG;YACrB,mBAAmB,CAAC,iBAAiB;YACrC,mBAAmB,CAAC,iBAAiB;YACrC,mBAAmB,CAAC,iBAAiB;YACrC,mBAAmB,CAAC,yBAAyB;YAC7C,kEAAkE;YAClE,qEAAqE;YACrE,4DAA4D;YAC5D,mBAAmB,CAAC,gBAAgB;SACrC,CAAC;QACF,OAAO,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,6CAA6C;IAC7C,MAAM,YAAY,GAChB,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,SAAS,IAAI,KAAK;QAClB,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ;QACjC,KAAK,CAAC,OAAO,KAAK,IAAI;QACtB,eAAe,IAAI,KAAK,CAAC,OAAO;QAC9B,CAAC,CAAE,KAAK,CAAC,OAAO,CAAC,aAAiE;QAClF,CAAC,CAAC,SAAS,CAAC;IAChB,IAAI,YAAY,EAAE,CAAC;QACjB,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;QAChE,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;QAC1D,IACE,mBAAmB,CAAC,IAAI,CACtB,CAAC,OAAO,EAAE,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAC7E,EACD,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,KAAyD,EACzD,QAOC;IAED,MAAM,YAAY,GAAG,QAAQ,CAAC,WAAW,KAAK,YAAY,CAAC;IAC3D,MAAM,OAAO,GAAG,YAAY,CAAC,CAAC,CAAC,MAAM,mBAAmB,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACjF,OAAO;QACL,GAAG,CAAC,QAAQ,CAAC,eAAe,KAAK,SAAS,IAAI,EAAE,eAAe,EAAE,QAAQ,CAAC,eAAe,EAAE,CAAC;QAC5F,GAAG,CAAC,QAAQ,CAAC,WAAW,KAAK,SAAS,IAAI,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC;QAChF,SAAS,EAAE,YAAY;QACvB,YAAY;QACZ,GAAG,CAAC,OAAO,KAAK,IAAI,IAAI,EAAE,OAAO,EAAE,CAAC;KACrC,CAAC;AACJ,CAAC;AAED,0FAA0F;AAC1F,KAAK,UAAU,mBAAmB,CAChC,KAAyD,EACzD,QAIC;IAED,IAAI,MAAkB,CAAC;IACvB,IAAI,CAAC;QACH,MAAM;YACJ,OAAO,QAAQ,CAAC,UAAU,KAAK,QAAQ;gBACrC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,UAAoB,CAAC;gBAC9C,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC;IAC5B,CAAC;IAAC,MAAM,CAAC;QACP,uCAAuC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,4BAA4B,CAChD,KAAK,EACL,MAAM,EACN,QAAQ,CAAC,YAAY,EACrB,QAAQ,CAAC,cAAc,CACxB,CAAC;IACF,OAAO,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;AAC3D,CAAC"}
|
package/dist/client/retry.d.ts
CHANGED
|
@@ -10,14 +10,25 @@ import { ProtocolAddress } from '../types/address.js';
|
|
|
10
10
|
import type { RetryFamilyReceive } from './retry-family.js';
|
|
11
11
|
import type { SignalProtocolClientContext, IncomingEnvelope, ProcessEnvelopeOptions } from './types.js';
|
|
12
12
|
import { type SesameManager, type RetryRequest } from '../internal/sesame/types.js';
|
|
13
|
+
import type { SenderKeyDistributionMessage } from '../internal/protocol/sender-keys/index.js';
|
|
14
|
+
import { type GroupMembershipChecker } from './group-receive-authorization.js';
|
|
13
15
|
import { type RetryResendTarget } from '../local/store/reliability.js';
|
|
14
16
|
/**
|
|
15
17
|
* Retry response state (passed by client, mutated in place)
|
|
16
18
|
*/
|
|
17
19
|
export {};
|
|
18
20
|
export interface RetryResponseState {
|
|
19
|
-
/**
|
|
21
|
+
/**
|
|
22
|
+
* Retry responses per message: key = `${sessionId}:${failedTimestamp}`,
|
|
23
|
+
* value = response count. The row of a logged group send counts its
|
|
24
|
+
* resends instead, and that count survives a restart.
|
|
25
|
+
*/
|
|
20
26
|
retryResponseCounts: Map<string, number>;
|
|
27
|
+
/**
|
|
28
|
+
* The groups with no source of current membership whose refused resend
|
|
29
|
+
* the client logged, by raw group ID. Each is logged once.
|
|
30
|
+
*/
|
|
31
|
+
refusedGroupResends: Set<string>;
|
|
21
32
|
}
|
|
22
33
|
/**
|
|
23
34
|
* Extended context for retry operations (adds sesame and relay)
|
|
@@ -30,6 +41,11 @@ export interface RetryContext extends SignalProtocolClientContext {
|
|
|
30
41
|
* the retry ID of its request record and the ID of the request envelope.
|
|
31
42
|
*/
|
|
32
43
|
export type RetryRequestAttempt = Omit<RetryResendTarget, 'kind'>;
|
|
44
|
+
/**
|
|
45
|
+
* The ID of the resend job of one logged send for one request envelope. A
|
|
46
|
+
* redelivery of the request envelope names the same job.
|
|
47
|
+
*/
|
|
48
|
+
export declare function resendJobId(requestEnvelopeId: string, clientMessageId: string): string;
|
|
33
49
|
/**
|
|
34
50
|
* Callbacks for operations that need to delegate back to SignalProtocolClient
|
|
35
51
|
*/
|
|
@@ -56,9 +72,43 @@ export interface RetryCallbacks {
|
|
|
56
72
|
timestamp: number;
|
|
57
73
|
contentHint?: ContentHint;
|
|
58
74
|
retry?: RetryResendTarget;
|
|
75
|
+
/**
|
|
76
|
+
* The own sender key of the raw group that the content carries. When
|
|
77
|
+
* the Relay accepts the encryption that carries it, the sender records
|
|
78
|
+
* a handoff row of that key for the device.
|
|
79
|
+
*/
|
|
80
|
+
senderKeyHandoff?: {
|
|
81
|
+
groupId: string;
|
|
82
|
+
senderKeyId: string;
|
|
83
|
+
generation: number;
|
|
84
|
+
};
|
|
59
85
|
}) => Promise<boolean>;
|
|
60
86
|
/** Generate replacement prekeys and upload their public material. */
|
|
61
87
|
forcePreKeyRotation: () => Promise<void>;
|
|
88
|
+
/** The current membership of a user in a group, before group content goes to it again. */
|
|
89
|
+
groupMembership: GroupMembershipChecker;
|
|
90
|
+
/**
|
|
91
|
+
* The group of the group send that this client sent to the user at this
|
|
92
|
+
* client timestamp, if any.
|
|
93
|
+
*/
|
|
94
|
+
findSentGroupId: (userId: string, clientTimestamp: number) => Promise<string | undefined>;
|
|
95
|
+
/**
|
|
96
|
+
* The current sender-key distribution of this device for a group, with
|
|
97
|
+
* the raw group ID, or null when the device has no sender key for it.
|
|
98
|
+
*/
|
|
99
|
+
currentGroupDistribution: (groupId: string) => Promise<{
|
|
100
|
+
groupId: string;
|
|
101
|
+
distribution: SenderKeyDistributionMessage;
|
|
102
|
+
} | null>;
|
|
103
|
+
/**
|
|
104
|
+
* Delete the sender-key handoff rows of one device in one group, so the
|
|
105
|
+
* next group send gives the current key to that device. It returns true
|
|
106
|
+
* when a row was deleted.
|
|
107
|
+
*/
|
|
108
|
+
invalidateSenderKeyHandoff: (groupId: string, device: {
|
|
109
|
+
userId: string;
|
|
110
|
+
deviceId: number;
|
|
111
|
+
}) => Promise<boolean>;
|
|
62
112
|
}
|
|
63
113
|
/**
|
|
64
114
|
* Configuration constants for retry operations
|
|
@@ -128,20 +178,43 @@ export declare function sendRetryRequestInternal(ctx: RetryContext, envelope: In
|
|
|
128
178
|
* Handle incoming retry request and resend the original message
|
|
129
179
|
*
|
|
130
180
|
* Per SESAME spec §4.1, this method:
|
|
131
|
-
* 1.
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
181
|
+
* 1. Drops a request for another device of this user. Then it looks up the
|
|
182
|
+
* content that the requesting device can get again: the rows of that
|
|
183
|
+
* exact device in the send log, by the failed client message ID, then by
|
|
184
|
+
* the failed envelope ID, then by the failed timestamp, and else the
|
|
185
|
+
* MessageRecord of the device at the failed timestamp. When the sender
|
|
186
|
+
* already stored a resend or a null message for this request envelope,
|
|
187
|
+
* it posts the stored bytes again and does no session work
|
|
188
|
+
* 2. Sends logged group content only to a current member of its group.
|
|
189
|
+
* A requester that is not a current member, or a group with no source
|
|
190
|
+
* of current membership, gets no content, and the answer to the failed
|
|
191
|
+
* envelope ends with `membership-refused`. Each row counts its resends,
|
|
192
|
+
* and the count survives a restart. A row with
|
|
193
|
+
* `MAX_RETRY_RESPONSES_PER_MESSAGE` resends gets no more
|
|
194
|
+
* 3. For a request without a ratchet key, a sender-key failure, with no
|
|
195
|
+
* row: when this client sent a group to the requester at the failed
|
|
196
|
+
* timestamp, only a current member of that group gets an answer. With no
|
|
197
|
+
* record of the device at that timestamp, the answer is the current
|
|
198
|
+
* sender-key distribution alone. A sender-key failure never resets the
|
|
199
|
+
* pairwise session
|
|
200
|
+
* 4. For a pairwise MessageRecord: verifies that the requester is its
|
|
201
|
+
* recipient and checks the content retention. With the ratchet key of
|
|
202
|
+
* the failed message, it creates a new session if the session is
|
|
203
|
+
* orphaned, or uses the existing different session
|
|
204
|
+
* 5. Re-encrypts and sends the content, which replaces the old
|
|
138
205
|
* MessageRecord with the record of the new encryption. Only a delivery
|
|
139
|
-
* receipt from the device or the
|
|
206
|
+
* receipt from the device or the content retention deletes that record
|
|
207
|
+
* or the row.
|
|
140
208
|
*
|
|
141
|
-
* It refuses a request for a message
|
|
209
|
+
* It refuses a request for a message stored more than
|
|
142
210
|
* `RELIABILITY_RECORD_TTL_MS` ago, before it reads a stored resend. The
|
|
143
|
-
*
|
|
144
|
-
*
|
|
211
|
+
* store clock at local persistence (`createdAt` of the MessageRecord or of
|
|
212
|
+
* the send log entry) sets that age, so the message timestamp never moves
|
|
213
|
+
* it. With no stored content, the failed timestamp sets it. The Relay can
|
|
214
|
+
* keep the last resend post for that time again, and the requester keeps
|
|
215
|
+
* its retry records for both periods. The content
|
|
216
|
+
* retention (`protocol.contentRecovery.retentionMs`, 14 days by default) is
|
|
217
|
+
* shorter. A request after it gets no content.
|
|
145
218
|
*
|
|
146
219
|
* It returns normally when it resends the message or refuses the request.
|
|
147
220
|
* It throws every other error, so the caller keeps the request envelope and
|
|
@@ -160,4 +233,19 @@ export declare function sendRetryRequestInternal(ctx: RetryContext, envelope: In
|
|
|
160
233
|
* `:<n>` from attempt 2.
|
|
161
234
|
*/
|
|
162
235
|
export declare function handleRetryRequestAndResend(ctx: RetryContext, retryRequest: RetryRequest, responseState: RetryResponseState, callbacks: RetryCallbacks, config: RetryConfig, retry?: RetryRequestAttempt): Promise<void>;
|
|
236
|
+
/**
|
|
237
|
+
* Run one pending resend job, as the resend job driver does after a restart,
|
|
238
|
+
* a reconnect or a failed post. The job ends as abandoned when it is older
|
|
239
|
+
* than `SEND_LOG_RESEND_JOB_TTL_MS`, when its logged entry or the row of
|
|
240
|
+
* the device is gone or expired, when the answer to its failed envelope
|
|
241
|
+
* ended, when the row has its maximum count of resends, when the requester
|
|
242
|
+
* is not a current member of the group, or when no session to the device
|
|
243
|
+
* can be made. A membership refusal of the job that holds the failed
|
|
244
|
+
* envelope also ends the answer with `membership-refused`. The membership
|
|
245
|
+
* is checked again here. A group state that waits for an update defers the
|
|
246
|
+
* job with `GroupResendDeferredError`. The job never resets a session: a
|
|
247
|
+
* session is made only when there is none. A deferral and any other error
|
|
248
|
+
* leave the job pending and propagate, so the driver runs it again later.
|
|
249
|
+
*/
|
|
250
|
+
export declare function runResendJob(ctx: RetryContext, jobId: string, responseState: RetryResponseState, callbacks: RetryCallbacks): Promise<void>;
|
|
163
251
|
//# sourceMappingURL=retry.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"retry.d.ts","sourceRoot":"","sources":["../../client/retry.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"retry.d.ts","sourceRoot":"","sources":["../../client/retry.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAE5C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAInD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,KAAK,EACV,2BAA2B,EAC3B,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,SAAS,CAAC;AACjB,OAAO,EAGL,KAAK,aAAa,EAElB,KAAK,YAAY,EAClB,MAAM,0BAA0B,CAAC;AAgBlC,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,kCAAkC,CAAC;AAErF,OAAO,EAA4B,KAAK,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACtG,OAAO,EAKL,KAAK,iBAAiB,EAGvB,MAAM,4BAA4B,CAAC;AAGpC;;GAEG;AACH,OAAO,EAAE,CAAC;AACV,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,mBAAmB,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC;;;OAGG;IACH,mBAAmB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,2BAA2B;IAC/D,aAAa,EAAE,aAAa,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;AAgBlE;;;GAGG;AACH,wBAAgB,WAAW,CAAC,iBAAiB,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,MAAM,CAEtF;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,wDAAwD;IACxD,cAAc,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5D,iDAAiD;IACjD,gBAAgB,EAAE,CAAC,OAAO,EAAE,eAAe,EAAE,MAAM,EAAE,YAAY,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACpF;;;;;;;;;;;;;OAaG;IACH,MAAM,EAAE,CACN,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,OAAO,EAAE;QACP,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,WAAW,CAAC;QAC1B,KAAK,CAAC,EAAE,iBAAiB,CAAC;QAC1B;;;;WAIG;QACH,gBAAgB,CAAC,EAAE;YAAE,OAAO,EAAE,MAAM,CAAC;YAAC,WAAW,EAAE,MAAM,CAAC;YAAC,UAAU,EAAE,MAAM,CAAA;SAAE,CAAC;KACjF,KACE,OAAO,CAAC,OAAO,CAAC,CAAC;IACtB,qEAAqE;IACrE,mBAAmB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,0FAA0F;IAC1F,eAAe,EAAE,sBAAsB,CAAC;IACxC;;;OAGG;IACH,eAAe,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;IAC1F;;;OAGG;IACH,wBAAwB,EAAE,CACxB,OAAO,EAAE,MAAM,KACZ,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,4BAA4B,CAAA;KAAE,GAAG,IAAI,CAAC,CAAC;IACrF;;;;OAIG;IACH,0BAA0B,EAAE,CAC1B,OAAO,EAAE,MAAM,EACf,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,KACzC,OAAO,CAAC,OAAO,CAAC,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,0DAA0D;IAC1D,qBAAqB,EAAE,MAAM,CAAC;CAC/B;AAGD,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAChD,eAAO,MAAM,uBAAuB,QAAqB,CAAC;AAE1D;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,6DAA6D;IAC7D,oBAAoB,EAAE,GAAG,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC/E,8DAA8D;IAC9D,sBAAsB,EAAE,MAAM,CAAC;CAChC;AAID;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,cAAc,EAAE,mBAAmB,EACnC,QAAQ,EAAE,MAAM,EAChB,GAAG,GAAE,MAAmB,GACvB,OAAO,CAgCT;AAED;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,WAElC,CAAC;AA0KF;;GAEG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAEtE;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,wBAAwB,CAC5C,GAAG,EAAE,YAAY,EACjB,QAAQ,EAAE,gBAAgB,EAC1B,KAAK,EAAE,KAAK,EACZ,cAAc,EAAE,mBAAmB,EACnC,SAAS,EAAE,IAAI,CAAC,cAAc,EAAE,qBAAqB,CAAC,EACtD,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,kBAAkB,EAC1B,WAAW,EAAE,MAAM,GAAG,SAAS,EAC/B,OAAO,CAAC,EAAE,sBAAsB,GAC/B,OAAO,CAAC,IAAI,CAAC,CAsMf;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,wBAAsB,2BAA2B,CAC/C,GAAG,EAAE,YAAY,EACjB,YAAY,EAAE,YAAY,EAC1B,aAAa,EAAE,kBAAkB,EACjC,SAAS,EAAE,cAAc,EACzB,MAAM,EAAE,WAAW,EACnB,KAAK,CAAC,EAAE,mBAAmB,GAC1B,OAAO,CAAC,IAAI,CAAC,CAoUf;AA0ND;;;;;;;;;;;;;GAaG;AACH,wBAAsB,YAAY,CAChC,GAAG,EAAE,YAAY,EACjB,KAAK,EAAE,MAAM,EACb,aAAa,EAAE,kBAAkB,EACjC,SAAS,EAAE,cAAc,GACxB,OAAO,CAAC,IAAI,CAAC,CAyDf"}
|