@open-e2ee/signal-protocol-sdk 10.1.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 +1413 -0
- package/README.md +1 -1
- package/SECURITY.md +2 -2
- package/TROUBLESHOOTING.md +1 -1
- package/client/README.md +84 -37
- package/device/README.md +39 -85
- package/dist/client/client.d.ts +342 -62
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +1195 -179
- 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 +308 -6
- package/dist/client/event-hooks.d.ts.map +1 -1
- package/dist/client/event-hooks.js +9 -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-device-standing.d.ts +52 -0
- package/dist/client/hosted-device-standing.d.ts.map +1 -0
- package/dist/client/hosted-device-standing.js +74 -0
- package/dist/client/hosted-device-standing.js.map +1 -0
- package/dist/client/hosted-mailbox-subscription.d.ts +48 -3
- package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -1
- package/dist/client/hosted-mailbox-subscription.js +288 -74
- 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 +167 -69
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/hosted.d.ts +22 -5
- package/dist/client/hosted.d.ts.map +1 -1
- package/dist/client/hosted.js +122 -45
- package/dist/client/hosted.js.map +1 -1
- package/dist/client/index.d.ts +6 -4
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +3 -1
- 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 +118 -17
- package/dist/client/messages.js.map +1 -1
- package/dist/client/one-time-prekey-refill.d.ts +7 -0
- package/dist/client/one-time-prekey-refill.d.ts.map +1 -1
- package/dist/client/one-time-prekey-refill.js +5 -1
- package/dist/client/one-time-prekey-refill.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 +30 -0
- package/dist/client/relay-acceptance.d.ts.map +1 -1
- package/dist/client/relay-acceptance.js +55 -0
- 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 +220 -150
- 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 +68 -19
- package/dist/client/retry-family.d.ts.map +1 -1
- package/dist/client/retry-family.js +59 -17
- package/dist/client/retry-family.js.map +1 -1
- package/dist/client/retry-request-envelope.d.ts +145 -18
- package/dist/client/retry-request-envelope.d.ts.map +1 -1
- package/dist/client/retry-request-envelope.js +301 -64
- package/dist/client/retry-request-envelope.js.map +1 -1
- package/dist/client/retry-request-lifecycle.d.ts +157 -0
- package/dist/client/retry-request-lifecycle.d.ts.map +1 -0
- package/dist/client/retry-request-lifecycle.js +437 -0
- package/dist/client/retry-request-lifecycle.js.map +1 -0
- 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 +106 -18
- package/dist/client/retry.d.ts.map +1 -1
- package/dist/client/retry.js +687 -139
- 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 +2265 -343
- 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 +411 -14
- package/dist/local/store/reliability.d.ts.map +1 -1
- package/dist/local/store/reliability.js +532 -58
- 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 +104 -110
- 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/dist/utils/retry.d.ts +2 -0
- package/dist/utils/retry.d.ts.map +1 -1
- package/dist/utils/retry.js +7 -0
- package/dist/utils/retry.js.map +1 -1
- 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 +235 -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
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"one-time-prekey-refill.js","sourceRoot":"","sources":["../../client/one-time-prekey-refill.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,2BAA2B,EAAe,MAAM,WAAW,CAAC;AAErE,OAAO,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAC;AAGtD,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAC;AAG9E;;;;GAIG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAqBrD,
|
|
1
|
+
{"version":3,"file":"one-time-prekey-refill.js","sourceRoot":"","sources":["../../client/one-time-prekey-refill.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,2BAA2B,EAAe,MAAM,WAAW,CAAC;AAErE,OAAO,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAC;AAGtD,OAAO,EAAE,wBAAwB,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAC;AAG9E;;;;GAIG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAG,EAAE,CAAC;AAqBrD;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,QAAsC;IACxE,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AACzE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,KAA+B;IAE/B,MAAM,EACJ,OAAO,EACP,YAAY,EACZ,aAAa,EACb,cAAc,EACd,SAAS,GAAG,kCAAkC,EAC9C,iBAAiB,EACjB,MAAM,GAAG,2BAA2B,GACrC,GAAG,KAAK,CAAC;IACV,MAAM,OAAO,GAAmB,EAAE,CAAC;IACnC,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,IAAI,aAAa,GAAG,SAAS,EAAE,CAAC;QAC9B,MAAM,iBAAiB,EAAE,4BAA4B,CAAC,YAAY,CAAC,CAAC;QACpE,MAAM,OAAO,GAAG,mBAAmB,CAAC,MAAM,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC,CAAC;QACrF,MAAM,KAAK,GAAG,MAAM,wBAAwB,CAAC,0BAA0B,EAAE,OAAO,CAAC,CAAC;QAClF,MAAM,OAAO,CAAC,qBAAqB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QACzD,OAAO,CAAC,IAAI,CACV,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACrB,IAAI,EAAE,UAAmB;YACzB,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,SAAS,EAAE,GAAG,CAAC,SAAmB;SACnC,CAAC,CAAC,CACJ,CAAC;QACF,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC;QAC3B,MAAM,CAAC,KAAK,CAAC,qCAAqC,EAAE;YAClD,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE;SAC/E,CAAC,CAAC;IACL,CAAC;IAED,IAAI,cAAc,GAAG,SAAS,EAAE,CAAC;QAC/B,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;QAC/D,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,2DAA2D,YAAY,GAAG,CAAC,CAAC;QAC9F,CAAC;QACD,MAAM,iBAAiB,EAAE,+BAA+B,CAAC,YAAY,CAAC,CAAC;QACvE,MAAM,OAAO,GAAG,mBAAmB,CAAC,MAAM,OAAO,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC,CAAC;QACtF,MAAM,KAAK,GAAG,MAAM,yBAAyB,CAAC,WAAW,EAAE,0BAA0B,EAAE,OAAO,CAAC,CAAC;QAChG,MAAM,OAAO,CAAC,sBAAsB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;QAC1D,OAAO,CAAC,IAAI,CACV,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;YACrB,IAAI,EAAE,kBAA2B;YACjC,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,SAAS,EAAE,GAAG,CAAC,SAAmB;YAClC,SAAS,EAAE,GAAG,CAAC,SAAmB;SACnC,CAAC,CAAC,CACJ,CAAC;QACF,YAAY,GAAG,KAAK,CAAC,MAAM,CAAC;QAC5B,MAAM,CAAC,KAAK,CAAC,sCAAsC,EAAE;YACnD,QAAQ,EAAE,MAAM;YAChB,IAAI,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE;SAChF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,CAAC;AAChD,CAAC"}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The admission of the receive queue: the bounds check that runs before a
|
|
3
|
+
* decrypt.
|
|
4
|
+
*
|
|
5
|
+
* Only records that wait accumulate, so the bounds count every stored
|
|
6
|
+
* receive record. A decrypt runs only when the queue has room:
|
|
7
|
+
*
|
|
8
|
+
* - The global bound: fewer than `maxItems` records and fewer than
|
|
9
|
+
* `maxBytes` bytes.
|
|
10
|
+
* - The group bound, for a sender-key message: the records of its group
|
|
11
|
+
* that wait for a group update hold fewer than `blockedGroupShare` of
|
|
12
|
+
* each global bound. The group resolves from the distribution identifier
|
|
13
|
+
* in the frame before the decrypt.
|
|
14
|
+
*
|
|
15
|
+
* A pairwise message decrypts whenever the global bound has room. After its
|
|
16
|
+
* decrypt, a pairwise record that waits for its group counts toward that
|
|
17
|
+
* group, so pairwise content can fill a group past its share up to the
|
|
18
|
+
* global bound.
|
|
19
|
+
*
|
|
20
|
+
* One in-process lock per store covers the check, the decrypt, and the
|
|
21
|
+
* commit of the record, so two receives in one process never pass the
|
|
22
|
+
* check for the same last slot. Two processes that share one store, such
|
|
23
|
+
* as two browser tabs, can each pass the check and overshoot a bound by
|
|
24
|
+
* their own receives in flight. Each process also keeps its own arrival
|
|
25
|
+
* counter, so a record of one process can sort before a record that another
|
|
26
|
+
* process admitted earlier (see `receive-work-seed.ts`).
|
|
27
|
+
*/
|
|
28
|
+
import type { Logger } from '../logger.js';
|
|
29
|
+
import type { SignalProtocolLocalStore } from '../types/api.js';
|
|
30
|
+
import type { ResolvedReceiveQueuePolicy } from './storage-protection.js';
|
|
31
|
+
/** The store reads of the admission. */
|
|
32
|
+
export type ReceiveAdmissionStore = Pick<SignalProtocolLocalStore, 'receiveWorkUsage'>;
|
|
33
|
+
/**
|
|
34
|
+
* The bounds of the waiting records of one group.
|
|
35
|
+
*
|
|
36
|
+
* @returns At least one item, so a small `maxItems` still lets one record
|
|
37
|
+
* of each group wait.
|
|
38
|
+
*/
|
|
39
|
+
export declare function blockedGroupBounds(policy: ResolvedReceiveQueuePolicy): {
|
|
40
|
+
readonly items: number;
|
|
41
|
+
readonly bytes: number;
|
|
42
|
+
};
|
|
43
|
+
/**
|
|
44
|
+
* Run one decrypt under the receive admission.
|
|
45
|
+
*
|
|
46
|
+
* @param store - The local store that keeps the receive records.
|
|
47
|
+
* @param policy - The resolved receive queue policy.
|
|
48
|
+
* @param logger - The client logger.
|
|
49
|
+
* @param groupId - The raw group of a sender-key message, or null for a
|
|
50
|
+
* pairwise message.
|
|
51
|
+
* @param decrypt - The decrypt and the commit of its record.
|
|
52
|
+
* @returns The decrypt result, or null when the queue has no room. Then
|
|
53
|
+
* nothing is decrypted.
|
|
54
|
+
*/
|
|
55
|
+
export declare function admitReceive<T>(store: ReceiveAdmissionStore, policy: ResolvedReceiveQueuePolicy, logger: Required<Logger>, groupId: string | null, decrypt: () => Promise<T>): Promise<{
|
|
56
|
+
value: T;
|
|
57
|
+
} | null>;
|
|
58
|
+
//# sourceMappingURL=receive-admission.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"receive-admission.d.ts","sourceRoot":"","sources":["../../client/receive-admission.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAE7D,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,sBAAsB,CAAC;AAIvE,wCAAwC;AACxC,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,wBAAwB,EAAE,kBAAkB,CAAC,CAAC;AAEvF;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,0BAA0B,GAAG;IACtE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB,CAKA;AAED;;;;;;;;;;;GAWG;AACH,wBAAsB,YAAY,CAAC,CAAC,EAClC,KAAK,EAAE,qBAAqB,EAC5B,MAAM,EAAE,0BAA0B,EAClC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,EACxB,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GACxB,OAAO,CAAC;IAAE,KAAK,EAAE,CAAC,CAAA;CAAE,GAAG,IAAI,CAAC,CAuB9B"}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The admission of the receive queue: the bounds check that runs before a
|
|
3
|
+
* decrypt.
|
|
4
|
+
*
|
|
5
|
+
* Only records that wait accumulate, so the bounds count every stored
|
|
6
|
+
* receive record. A decrypt runs only when the queue has room:
|
|
7
|
+
*
|
|
8
|
+
* - The global bound: fewer than `maxItems` records and fewer than
|
|
9
|
+
* `maxBytes` bytes.
|
|
10
|
+
* - The group bound, for a sender-key message: the records of its group
|
|
11
|
+
* that wait for a group update hold fewer than `blockedGroupShare` of
|
|
12
|
+
* each global bound. The group resolves from the distribution identifier
|
|
13
|
+
* in the frame before the decrypt.
|
|
14
|
+
*
|
|
15
|
+
* A pairwise message decrypts whenever the global bound has room. After its
|
|
16
|
+
* decrypt, a pairwise record that waits for its group counts toward that
|
|
17
|
+
* group, so pairwise content can fill a group past its share up to the
|
|
18
|
+
* global bound.
|
|
19
|
+
*
|
|
20
|
+
* One in-process lock per store covers the check, the decrypt, and the
|
|
21
|
+
* commit of the record, so two receives in one process never pass the
|
|
22
|
+
* check for the same last slot. Two processes that share one store, such
|
|
23
|
+
* as two browser tabs, can each pass the check and overshoot a bound by
|
|
24
|
+
* their own receives in flight. Each process also keeps its own arrival
|
|
25
|
+
* counter, so a record of one process can sort before a record that another
|
|
26
|
+
* process admitted earlier (see `receive-work-seed.ts`).
|
|
27
|
+
*/
|
|
28
|
+
import { createKeyedLocks, withKeyedLock } from '../utils/keyed-lock.js';
|
|
29
|
+
const admissionLocks = createKeyedLocks();
|
|
30
|
+
/**
|
|
31
|
+
* The bounds of the waiting records of one group.
|
|
32
|
+
*
|
|
33
|
+
* @returns At least one item, so a small `maxItems` still lets one record
|
|
34
|
+
* of each group wait.
|
|
35
|
+
*/
|
|
36
|
+
export function blockedGroupBounds(policy) {
|
|
37
|
+
return {
|
|
38
|
+
items: Math.max(1, Math.floor(policy.maxItems * policy.blockedGroupShare)),
|
|
39
|
+
bytes: Math.max(1, Math.floor(policy.maxBytes * policy.blockedGroupShare)),
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Run one decrypt under the receive admission.
|
|
44
|
+
*
|
|
45
|
+
* @param store - The local store that keeps the receive records.
|
|
46
|
+
* @param policy - The resolved receive queue policy.
|
|
47
|
+
* @param logger - The client logger.
|
|
48
|
+
* @param groupId - The raw group of a sender-key message, or null for a
|
|
49
|
+
* pairwise message.
|
|
50
|
+
* @param decrypt - The decrypt and the commit of its record.
|
|
51
|
+
* @returns The decrypt result, or null when the queue has no room. Then
|
|
52
|
+
* nothing is decrypted.
|
|
53
|
+
*/
|
|
54
|
+
export async function admitReceive(store, policy, logger, groupId, decrypt) {
|
|
55
|
+
return withKeyedLock(admissionLocks, store, 'admission', async () => {
|
|
56
|
+
const usage = await store.receiveWorkUsage();
|
|
57
|
+
if (usage.items >= policy.maxItems || usage.bytes >= policy.maxBytes) {
|
|
58
|
+
logger.warn('The receive queue is full. The message waits at the Relay', {
|
|
59
|
+
category: 'E2EE',
|
|
60
|
+
data: { behavior: 'RECEIVE_QUEUE_FULL', items: usage.items, bytes: usage.bytes },
|
|
61
|
+
});
|
|
62
|
+
return null;
|
|
63
|
+
}
|
|
64
|
+
if (groupId !== null) {
|
|
65
|
+
const group = await store.receiveWorkUsage({ groupId });
|
|
66
|
+
const bounds = blockedGroupBounds(policy);
|
|
67
|
+
if (group.items >= bounds.items || group.bytes >= bounds.bytes) {
|
|
68
|
+
logger.warn('The waiting content of one group fills its share of the receive queue', {
|
|
69
|
+
category: 'E2EE',
|
|
70
|
+
data: { behavior: 'RECEIVE_QUEUE_GROUP_FULL', items: group.items, bytes: group.bytes },
|
|
71
|
+
});
|
|
72
|
+
return null;
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
return { value: await decrypt() };
|
|
76
|
+
});
|
|
77
|
+
}
|
|
78
|
+
//# sourceMappingURL=receive-admission.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"receive-admission.js","sourceRoot":"","sources":["../../client/receive-admission.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAIH,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGtE,MAAM,cAAc,GAAG,gBAAgB,EAAE,CAAC;AAK1C;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAkC;IAInE,OAAO;QACL,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC;QAC1E,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAC;KAC3E,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,KAA4B,EAC5B,MAAkC,EAClC,MAAwB,EACxB,OAAsB,EACtB,OAAyB;IAEzB,OAAO,aAAa,CAAC,cAAc,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,gBAAgB,EAAE,CAAC;QAC7C,IAAI,KAAK,CAAC,KAAK,IAAI,MAAM,CAAC,QAAQ,IAAI,KAAK,CAAC,KAAK,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACrE,MAAM,CAAC,IAAI,CAAC,2DAA2D,EAAE;gBACvE,QAAQ,EAAE,MAAM;gBAChB,IAAI,EAAE,EAAE,QAAQ,EAAE,oBAAoB,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE;aACjF,CAAC,CAAC;YACH,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrB,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC,gBAAgB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;YACxD,MAAM,MAAM,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAC1C,IAAI,KAAK,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAC/D,MAAM,CAAC,IAAI,CAAC,uEAAuE,EAAE;oBACnF,QAAQ,EAAE,MAAM;oBAChB,IAAI,EAAE,EAAE,QAAQ,EAAE,0BAA0B,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE;iBACvF,CAAC,CAAC;gBACH,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,MAAM,OAAO,EAAE,EAAE,CAAC;IACpC,CAAC,CAAC,CAAC;AACL,CAAC"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The age rule of the receive queue (outcome 3).
|
|
3
|
+
*
|
|
4
|
+
* A receive record expires when it waited `MAX_RECEIVE_WORK_AGE_MS`, 30
|
|
5
|
+
* days, since its first durable admission on this device. The age uses wall
|
|
6
|
+
* time. A negative age, after the clock moved back, counts as 0. A clock
|
|
7
|
+
* that moves forward can expire a record early.
|
|
8
|
+
*
|
|
9
|
+
* The rule reads only the age. It never reads the retry deadline of the
|
|
10
|
+
* retry request lifecycle, the content recovery retention, or the sender
|
|
11
|
+
* key rotation.
|
|
12
|
+
*/
|
|
13
|
+
import type { ReceiveWorkRecord } from '../types/api.js';
|
|
14
|
+
/**
|
|
15
|
+
* Tell whether a receive record has expired.
|
|
16
|
+
*
|
|
17
|
+
* @param record - The record. Its `receivedAt` is the time of the first
|
|
18
|
+
* durable admission, and no later write changes it.
|
|
19
|
+
* @param now - The current wall time.
|
|
20
|
+
* @param maxAgeMs - The age. Only a test passes a value other than
|
|
21
|
+
* `MAX_RECEIVE_WORK_AGE_MS`.
|
|
22
|
+
*/
|
|
23
|
+
export declare function isReceiveExpired(record: Pick<ReceiveWorkRecord, 'receivedAt'>, now: number, maxAgeMs?: number): boolean;
|
|
24
|
+
/**
|
|
25
|
+
* The time at which a receive record expires.
|
|
26
|
+
*
|
|
27
|
+
* @param maxAgeMs - The age. Only a test passes a value other than
|
|
28
|
+
* `MAX_RECEIVE_WORK_AGE_MS`.
|
|
29
|
+
*/
|
|
30
|
+
export declare function receiveExpiresAt(record: Pick<ReceiveWorkRecord, 'receivedAt'>, maxAgeMs?: number): number;
|
|
31
|
+
//# sourceMappingURL=receive-expiry.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"receive-expiry.d.ts","sourceRoot":"","sources":["../../client/receive-expiry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAGtD;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,IAAI,CAAC,iBAAiB,EAAE,YAAY,CAAC,EAC7C,GAAG,EAAE,MAAM,EACX,QAAQ,GAAE,MAAgC,GACzC,OAAO,CAET;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,IAAI,CAAC,iBAAiB,EAAE,YAAY,CAAC,EAC7C,QAAQ,GAAE,MAAgC,GACzC,MAAM,CAER"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The age rule of the receive queue (outcome 3).
|
|
3
|
+
*
|
|
4
|
+
* A receive record expires when it waited `MAX_RECEIVE_WORK_AGE_MS`, 30
|
|
5
|
+
* days, since its first durable admission on this device. The age uses wall
|
|
6
|
+
* time. A negative age, after the clock moved back, counts as 0. A clock
|
|
7
|
+
* that moves forward can expire a record early.
|
|
8
|
+
*
|
|
9
|
+
* The rule reads only the age. It never reads the retry deadline of the
|
|
10
|
+
* retry request lifecycle, the content recovery retention, or the sender
|
|
11
|
+
* key rotation.
|
|
12
|
+
*/
|
|
13
|
+
import { MAX_RECEIVE_WORK_AGE_MS } from './constants.js';
|
|
14
|
+
/**
|
|
15
|
+
* Tell whether a receive record has expired.
|
|
16
|
+
*
|
|
17
|
+
* @param record - The record. Its `receivedAt` is the time of the first
|
|
18
|
+
* durable admission, and no later write changes it.
|
|
19
|
+
* @param now - The current wall time.
|
|
20
|
+
* @param maxAgeMs - The age. Only a test passes a value other than
|
|
21
|
+
* `MAX_RECEIVE_WORK_AGE_MS`.
|
|
22
|
+
*/
|
|
23
|
+
export function isReceiveExpired(record, now, maxAgeMs = MAX_RECEIVE_WORK_AGE_MS) {
|
|
24
|
+
return Math.max(0, now - record.receivedAt) >= maxAgeMs;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* The time at which a receive record expires.
|
|
28
|
+
*
|
|
29
|
+
* @param maxAgeMs - The age. Only a test passes a value other than
|
|
30
|
+
* `MAX_RECEIVE_WORK_AGE_MS`.
|
|
31
|
+
*/
|
|
32
|
+
export function receiveExpiresAt(record, maxAgeMs = MAX_RECEIVE_WORK_AGE_MS) {
|
|
33
|
+
return record.receivedAt + maxAgeMs;
|
|
34
|
+
}
|
|
35
|
+
//# sourceMappingURL=receive-expiry.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"receive-expiry.js","sourceRoot":"","sources":["../../client/receive-expiry.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAGH,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAEtD;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAC9B,MAA6C,EAC7C,GAAW,EACX,QAAQ,GAAW,uBAAuB;IAE1C,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,QAAQ,CAAC;AAC1D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC9B,MAA6C,EAC7C,QAAQ,GAAW,uBAAuB;IAE1C,OAAO,MAAM,CAAC,UAAU,GAAG,QAAQ,CAAC;AACtC,CAAC"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The receive hook bound: the longest time that a receive pass waits for
|
|
3
|
+
* one application hook.
|
|
4
|
+
*
|
|
5
|
+
* A pass awaits each hook that it calls, so a hook that never settles would
|
|
6
|
+
* stop the queue. Each call therefore races a timer of
|
|
7
|
+
* `protocol.receiveQueue.receiveHookTimeoutMs`. At the bound, the call logs
|
|
8
|
+
* `RECEIVE_HOOK_TIMEOUT` once and rejects with ReceiveHookTimeout. The pass
|
|
9
|
+
* then handles the timeout as it handles a thrown error of that call:
|
|
10
|
+
*
|
|
11
|
+
* - A timeout of `onMessageDecrypted`, or of a hook whose error the pass
|
|
12
|
+
* gives back to it such as `onDelivered`, counts as one hook attempt,
|
|
13
|
+
* with the normal backoff and the attempt cap.
|
|
14
|
+
* - A timeout of a hook that `callHook` calls, or of `onDeliveryRecovered`,
|
|
15
|
+
* ends that call, and the pass continues.
|
|
16
|
+
*
|
|
17
|
+
* The internal profile key exchange is not an application hook, and the
|
|
18
|
+
* bound does not apply to it.
|
|
19
|
+
*
|
|
20
|
+
* The bounded call keeps running, but no SDK step waits for it. So its late
|
|
21
|
+
* result or error reaches no SDK step, and the pass writes nothing for it.
|
|
22
|
+
* A relay work item wraps each bounded hook, so the item stops counting as
|
|
23
|
+
* waiting in the app at the timeout.
|
|
24
|
+
*
|
|
25
|
+
* Signal equivalence. One Signal client runs each receive task and each
|
|
26
|
+
* event dispatch under its 2-minute short-lived bound, and its application
|
|
27
|
+
* handlers under its 30-minute long-running bound. The SDK
|
|
28
|
+
* bounds each hook at the 2-minute receive bound by default, and the
|
|
29
|
+
* application can change it. docs/DEVIATIONS.md records the deviation.
|
|
30
|
+
*/
|
|
31
|
+
import type { Logger } from '../logger.js';
|
|
32
|
+
import type { SignalProtocolClientHooks } from './event-hooks.js';
|
|
33
|
+
/** The default of `protocol.receiveQueue.receiveHookTimeoutMs`: 2 minutes. */
|
|
34
|
+
export declare const RECEIVE_HOOK_TIMEOUT_MS = 120000;
|
|
35
|
+
/** The log behavior of a call that did not settle within the bound. */
|
|
36
|
+
export declare const RECEIVE_HOOK_TIMEOUT = "RECEIVE_HOOK_TIMEOUT";
|
|
37
|
+
/**
|
|
38
|
+
* Run one call under the receive hook bound.
|
|
39
|
+
*
|
|
40
|
+
* @returns The result of the call, when it settles within the bound
|
|
41
|
+
* @throws The error of the call, when it rejects within the bound
|
|
42
|
+
* @throws ReceiveHookTimeout at the bound, after one log
|
|
43
|
+
*/
|
|
44
|
+
export declare function boundReceiveCall<T>(hook: string, timeoutMs: number, logger: Pick<Required<Logger>, 'warn'>, call: () => T | Promise<T>): Promise<T>;
|
|
45
|
+
/**
|
|
46
|
+
* Hooks that run each call under the receive hook bound. A receive pass
|
|
47
|
+
* wraps these hooks in its relay work.
|
|
48
|
+
*/
|
|
49
|
+
export declare function boundReceiveHooks(hooks: SignalProtocolClientHooks, timeoutMs: number, logger: Pick<Required<Logger>, 'warn'>): SignalProtocolClientHooks;
|
|
50
|
+
//# sourceMappingURL=receive-hook-bound.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"receive-hook-bound.d.ts","sourceRoot":"","sources":["../../client/receive-hook-bound.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,eAAe,CAAC;AAE/D,8EAA8E;AAC9E,eAAO,MAAM,uBAAuB,SAAU,CAAC;AAE/C,uEAAuE;AACvE,eAAO,MAAM,oBAAoB,yBAAyB,CAAC;AAoB3D;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAChC,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EACtC,IAAI,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,GACzB,OAAO,CAAC,CAAC,CAAC,CAqCZ;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,yBAAyB,EAChC,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,GACrC,yBAAyB,CAS3B"}
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The receive hook bound: the longest time that a receive pass waits for
|
|
3
|
+
* one application hook.
|
|
4
|
+
*
|
|
5
|
+
* A pass awaits each hook that it calls, so a hook that never settles would
|
|
6
|
+
* stop the queue. Each call therefore races a timer of
|
|
7
|
+
* `protocol.receiveQueue.receiveHookTimeoutMs`. At the bound, the call logs
|
|
8
|
+
* `RECEIVE_HOOK_TIMEOUT` once and rejects with ReceiveHookTimeout. The pass
|
|
9
|
+
* then handles the timeout as it handles a thrown error of that call:
|
|
10
|
+
*
|
|
11
|
+
* - A timeout of `onMessageDecrypted`, or of a hook whose error the pass
|
|
12
|
+
* gives back to it such as `onDelivered`, counts as one hook attempt,
|
|
13
|
+
* with the normal backoff and the attempt cap.
|
|
14
|
+
* - A timeout of a hook that `callHook` calls, or of `onDeliveryRecovered`,
|
|
15
|
+
* ends that call, and the pass continues.
|
|
16
|
+
*
|
|
17
|
+
* The internal profile key exchange is not an application hook, and the
|
|
18
|
+
* bound does not apply to it.
|
|
19
|
+
*
|
|
20
|
+
* The bounded call keeps running, but no SDK step waits for it. So its late
|
|
21
|
+
* result or error reaches no SDK step, and the pass writes nothing for it.
|
|
22
|
+
* A relay work item wraps each bounded hook, so the item stops counting as
|
|
23
|
+
* waiting in the app at the timeout.
|
|
24
|
+
*
|
|
25
|
+
* Signal equivalence. One Signal client runs each receive task and each
|
|
26
|
+
* event dispatch under its 2-minute short-lived bound, and its application
|
|
27
|
+
* handlers under its 30-minute long-running bound. The SDK
|
|
28
|
+
* bounds each hook at the 2-minute receive bound by default, and the
|
|
29
|
+
* application can change it. docs/DEVIATIONS.md records the deviation.
|
|
30
|
+
*/
|
|
31
|
+
/** The default of `protocol.receiveQueue.receiveHookTimeoutMs`: 2 minutes. */
|
|
32
|
+
export const RECEIVE_HOOK_TIMEOUT_MS = 120_000;
|
|
33
|
+
/** The log behavior of a call that did not settle within the bound. */
|
|
34
|
+
export const RECEIVE_HOOK_TIMEOUT = 'RECEIVE_HOOK_TIMEOUT';
|
|
35
|
+
/**
|
|
36
|
+
* Thrown in a receive pass when a hook did not settle within the receive
|
|
37
|
+
* hook bound. The bound logged it.
|
|
38
|
+
*
|
|
39
|
+
* @internal
|
|
40
|
+
*/
|
|
41
|
+
export class ReceiveHookTimeout extends Error {
|
|
42
|
+
hook;
|
|
43
|
+
timeoutMs;
|
|
44
|
+
constructor(
|
|
45
|
+
/** The name of the hook. */
|
|
46
|
+
hook,
|
|
47
|
+
/** The bound that the call passed. */
|
|
48
|
+
timeoutMs) {
|
|
49
|
+
super(`The ${hook} call did not settle within ${timeoutMs} ms`);
|
|
50
|
+
this.hook = hook;
|
|
51
|
+
this.timeoutMs = timeoutMs;
|
|
52
|
+
this.name = 'ReceiveHookTimeout';
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Run one call under the receive hook bound.
|
|
57
|
+
*
|
|
58
|
+
* @returns The result of the call, when it settles within the bound
|
|
59
|
+
* @throws The error of the call, when it rejects within the bound
|
|
60
|
+
* @throws ReceiveHookTimeout at the bound, after one log
|
|
61
|
+
*/
|
|
62
|
+
export function boundReceiveCall(hook, timeoutMs, logger, call) {
|
|
63
|
+
let settled;
|
|
64
|
+
try {
|
|
65
|
+
settled = Promise.resolve(call());
|
|
66
|
+
}
|
|
67
|
+
catch (error) {
|
|
68
|
+
return Promise.reject(error);
|
|
69
|
+
}
|
|
70
|
+
return new Promise((resolve, reject) => {
|
|
71
|
+
let open = true;
|
|
72
|
+
const timer = setTimeout(() => {
|
|
73
|
+
if (!open)
|
|
74
|
+
return;
|
|
75
|
+
open = false;
|
|
76
|
+
logger.warn('A receive hook did not settle within its bound', {
|
|
77
|
+
category: 'E2EE',
|
|
78
|
+
data: { hook, timeoutMs, behavior: RECEIVE_HOOK_TIMEOUT },
|
|
79
|
+
});
|
|
80
|
+
reject(new ReceiveHookTimeout(hook, timeoutMs));
|
|
81
|
+
}, timeoutMs);
|
|
82
|
+
// The bound alone does not keep a Node process alive.
|
|
83
|
+
timer.unref?.();
|
|
84
|
+
// A settle after the timeout reaches no SDK step. Its rejection is
|
|
85
|
+
// handled here, so it is not an unhandled rejection.
|
|
86
|
+
settled.then((value) => {
|
|
87
|
+
if (!open)
|
|
88
|
+
return;
|
|
89
|
+
open = false;
|
|
90
|
+
clearTimeout(timer);
|
|
91
|
+
resolve(value);
|
|
92
|
+
}, (error) => {
|
|
93
|
+
if (!open)
|
|
94
|
+
return;
|
|
95
|
+
open = false;
|
|
96
|
+
clearTimeout(timer);
|
|
97
|
+
reject(error);
|
|
98
|
+
});
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Hooks that run each call under the receive hook bound. A receive pass
|
|
103
|
+
* wraps these hooks in its relay work.
|
|
104
|
+
*/
|
|
105
|
+
export function boundReceiveHooks(hooks, timeoutMs, logger) {
|
|
106
|
+
const bound = {};
|
|
107
|
+
for (const [name, hook] of Object.entries(hooks)) {
|
|
108
|
+
if (typeof hook !== 'function')
|
|
109
|
+
continue;
|
|
110
|
+
const call = hook;
|
|
111
|
+
bound[name] = (...args) => boundReceiveCall(name, timeoutMs, logger, () => Reflect.apply(call, undefined, args));
|
|
112
|
+
}
|
|
113
|
+
return bound;
|
|
114
|
+
}
|
|
115
|
+
//# sourceMappingURL=receive-hook-bound.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"receive-hook-bound.js","sourceRoot":"","sources":["../../client/receive-hook-bound.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAKH,8EAA8E;AAC9E,MAAM,CAAC,MAAM,uBAAuB,GAAG,OAAO,CAAC;AAE/C,uEAAuE;AACvE,MAAM,CAAC,MAAM,oBAAoB,GAAG,sBAAsB,CAAC;AAE3D;;;;;GAKG;AACH,MAAM,OAAO,kBAAmB,SAAQ,KAAK;IAGhC,IAAI;IAEJ,SAAS;IAJpB;IACE,4BAA4B;IACnB,IAAY;IACrB,sCAAsC;IAC7B,SAAiB;QAE1B,KAAK,CAAC,OAAO,IAAI,+BAA+B,SAAS,KAAK,CAAC,CAAC;oBAJvD,IAAI;yBAEJ,SAAS;QAGlB,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;IACnC,CAAC;CACF;AAED;;;;;;GAMG;AACH,MAAM,UAAU,gBAAgB,CAC9B,IAAY,EACZ,SAAiB,EACjB,MAAsC,EACtC,IAA0B;IAE1B,IAAI,OAAmB,CAAC;IACxB,IAAI,CAAC;QACH,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACpC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IACD,OAAO,IAAI,OAAO,CAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACxC,IAAI,IAAI,GAAG,IAAI,CAAC;QAChB,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YAC5B,IAAI,CAAC,IAAI;gBAAE,OAAO;YAClB,IAAI,GAAG,KAAK,CAAC;YACb,MAAM,CAAC,IAAI,CAAC,gDAAgD,EAAE;gBAC5D,QAAQ,EAAE,MAAM;gBAChB,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,oBAAoB,EAAE;aAC1D,CAAC,CAAC;YACH,MAAM,CAAC,IAAI,kBAAkB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QAClD,CAAC,EAAE,SAAS,CAAC,CAAC;QACd,sDAAsD;QACrD,KAAgC,CAAC,KAAK,EAAE,EAAE,CAAC;QAC5C,mEAAmE;QACnE,qDAAqD;QACrD,OAAO,CAAC,IAAI,CACV,CAAC,KAAK,EAAE,EAAE;YACR,IAAI,CAAC,IAAI;gBAAE,OAAO;YAClB,IAAI,GAAG,KAAK,CAAC;YACb,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC,EACD,CAAC,KAAc,EAAE,EAAE;YACjB,IAAI,CAAC,IAAI;gBAAE,OAAO;YAClB,IAAI,GAAG,KAAK,CAAC;YACb,YAAY,CAAC,KAAK,CAAC,CAAC;YACpB,MAAM,CAAC,KAAK,CAAC,CAAC;QAChB,CAAC,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAgC,EAChC,SAAiB,EACjB,MAAsC;IAEtC,MAAM,KAAK,GAA6D,EAAE,CAAC;IAC3E,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACjD,IAAI,OAAO,IAAI,KAAK,UAAU;YAAE,SAAS;QACzC,MAAM,IAAI,GAAG,IAAuC,CAAC;QACrD,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,EAAE,CACxB,gBAAgB,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;IAC1F,CAAC;IACD,OAAO,KAAkC,CAAC;AAC5C,CAAC"}
|