@open-e2ee/signal-protocol-sdk 0.1.0-alpha.5 → 0.1.0-alpha.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ADAPTERS.md +15 -15
- package/CHANGELOG.md +56 -1
- package/README.md +1 -1
- package/blocking/README.md +5 -5
- package/client/README.md +2 -2
- package/dist/blocking/index.d.ts +2 -2
- package/dist/blocking/index.d.ts.map +1 -1
- package/dist/blocking/index.js +1 -1
- package/dist/blocking/index.js.map +1 -1
- package/dist/blocking/manager.d.ts +7 -7
- package/dist/blocking/manager.d.ts.map +1 -1
- package/dist/blocking/manager.js +3 -3
- package/dist/blocking/manager.js.map +1 -1
- package/dist/blocking/types.d.ts +3 -3
- package/dist/blocking/types.d.ts.map +1 -1
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +7 -7
- package/dist/client/client.js.map +1 -1
- package/dist/client/compose.d.ts +6 -6
- package/dist/client/compose.d.ts.map +1 -1
- package/dist/client/config.d.ts +13 -13
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/content-adapter.d.ts +4 -4
- package/dist/client/content-adapter.d.ts.map +1 -1
- package/dist/client/content-adapter.js +1 -1
- package/dist/client/content-adapter.js.map +1 -1
- package/dist/client/dual-store.d.ts +5 -5
- package/dist/client/dual-store.d.ts.map +1 -1
- package/dist/client/dual-store.js.map +1 -1
- package/dist/client/endorsement-manager.d.ts.map +1 -1
- package/dist/client/endorsement-manager.js +2 -2
- package/dist/client/endorsement-manager.js.map +1 -1
- package/dist/client/headless.d.ts +9 -9
- package/dist/client/headless.d.ts.map +1 -1
- package/dist/client/headless.js +6 -6
- package/dist/client/headless.js.map +1 -1
- package/dist/client/index.d.ts +2 -2
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/key-rotation-core.d.ts +7 -7
- package/dist/client/key-rotation-core.d.ts.map +1 -1
- package/dist/client/key-rotation-core.js +11 -11
- package/dist/client/key-rotation-core.js.map +1 -1
- package/dist/client/media.js.map +1 -1
- package/dist/client/relay-subscription.d.ts +2 -2
- package/dist/client/relay-subscription.d.ts.map +1 -1
- package/dist/client/relay-subscription.js +1 -1
- package/dist/client/relay-subscription.js.map +1 -1
- package/dist/client/retry.js.map +1 -1
- package/dist/client/sealed-sender-ops.d.ts +1 -1
- package/dist/client/sealed-sender-ops.d.ts.map +1 -1
- package/dist/client/sealed-sender-ops.js +3 -3
- package/dist/client/sealed-sender-ops.js.map +1 -1
- package/dist/client/signal-service-cipher.d.ts +10 -10
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +17 -14
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/types.d.ts +8 -8
- package/dist/client/types.d.ts.map +1 -1
- package/dist/device/connection.js +2 -2
- package/dist/device/connection.js.map +1 -1
- package/dist/device/device-id.d.ts.map +1 -1
- package/dist/device/device-id.js +4 -4
- package/dist/device/device-id.js.map +1 -1
- package/dist/device/provisioning.d.ts +2 -2
- package/dist/device/provisioning.d.ts.map +1 -1
- package/dist/device/provisioning.js +7 -7
- package/dist/device/provisioning.js.map +1 -1
- package/dist/device/transfer.d.ts.map +1 -1
- package/dist/device/transfer.js +14 -14
- package/dist/device/transfer.js.map +1 -1
- package/dist/files/index.d.ts +1 -1
- package/dist/files/index.js +1 -1
- package/dist/hooks/use-connection-presence.d.ts +3 -3
- package/dist/hooks/use-connection-presence.d.ts.map +1 -1
- package/dist/hooks/use-connection-presence.js +4 -4
- package/dist/hooks/use-connection-presence.js.map +1 -1
- package/dist/hooks/use-key-rotation.js +2 -2
- package/dist/hooks/use-key-rotation.js.map +1 -1
- package/dist/index.d.ts +11 -11
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -3
- package/dist/index.js.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
- package/dist/internal/crypto/ec/x25519-validation.js +4 -4
- package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
- package/dist/internal/crypto/symmetric/mac.d.ts +3 -3
- package/dist/internal/crypto/symmetric/mac.js +3 -3
- package/dist/internal/encoding/proto/envelope.d.ts +21 -21
- package/dist/internal/encoding/proto/envelope.d.ts.map +1 -1
- package/dist/internal/encoding/proto/envelope.js +25 -25
- package/dist/internal/encoding/proto/envelope.js.map +1 -1
- package/dist/internal/encoding/proto/index.d.ts +2 -2
- package/dist/internal/encoding/proto/index.d.ts.map +1 -1
- package/dist/internal/encoding/proto/index.js +2 -2
- package/dist/internal/encoding/proto/index.js.map +1 -1
- package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts +3 -3
- package/dist/internal/encoding/proto/pq-ratchet-serialize.js +2 -2
- package/dist/internal/encoding/proto/signal-message.d.ts +33 -33
- package/dist/internal/encoding/proto/signal-message.d.ts.map +1 -1
- package/dist/internal/encoding/proto/signal-message.js +58 -58
- package/dist/internal/encoding/proto/signal-message.js.map +1 -1
- package/dist/internal/manager/manager.d.ts +3 -3
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +3 -3
- package/dist/internal/manager/manager.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/chains.js +9 -9
- package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts +2 -2
- package/dist/internal/protocol/double-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/double-ratchet/ratchet.js +2 -2
- package/dist/internal/protocol/double-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
- package/dist/internal/protocol/pqxdh/pqxdh.js +3 -3
- package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.d.ts +2 -2
- package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
- package/dist/internal/protocol/sender-keys/manager.js +2 -2
- package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts +1 -1
- package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
- package/dist/internal/protocol/spqr/spqr.js +5 -5
- package/dist/internal/protocol/spqr/spqr.js.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +2 -2
- package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +1 -1
- package/dist/internal/protocol/triple-ratchet/ratchet.js +4 -4
- package/dist/internal/protocol/triple-ratchet/ratchet.js.map +1 -1
- package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
- package/dist/internal/protocol/x3dh/x3dh.js +3 -3
- package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
- package/dist/internal/sesame/device-registry.d.ts +7 -7
- package/dist/internal/sesame/device-registry.d.ts.map +1 -1
- package/dist/internal/sesame/device-registry.js +2 -2
- package/dist/internal/sesame/device-registry.js.map +1 -1
- package/dist/internal/sesame/manager.d.ts +1 -1
- package/dist/internal/sesame/manager.d.ts.map +1 -1
- package/dist/internal/sesame/manager.js +15 -15
- package/dist/internal/sesame/manager.js.map +1 -1
- package/dist/internal/session/builder.js +3 -3
- package/dist/internal/session/builder.js.map +1 -1
- package/dist/internal/session/cipher.d.ts +2 -2
- package/dist/internal/session/cipher.d.ts.map +1 -1
- package/dist/internal/session/cipher.js +30 -30
- package/dist/internal/session/cipher.js.map +1 -1
- package/dist/internal/session/decryption.d.ts +1 -1
- package/dist/internal/session/decryption.js +10 -10
- package/dist/internal/session/decryption.js.map +1 -1
- package/dist/internal/session/factory.d.ts.map +1 -1
- package/dist/internal/session/factory.js +3 -3
- package/dist/internal/session/factory.js.map +1 -1
- package/dist/internal/session/handshake.d.ts.map +1 -1
- package/dist/internal/session/handshake.js +3 -3
- package/dist/internal/session/handshake.js.map +1 -1
- package/dist/internal/session/ratchet.d.ts.map +1 -1
- package/dist/internal/session/ratchet.js +4 -4
- package/dist/internal/session/ratchet.js.map +1 -1
- package/dist/internal/session/types.d.ts +2 -2
- package/dist/internal/session/types.d.ts.map +1 -1
- package/dist/internal/session/validation.d.ts.map +1 -1
- package/dist/internal/session/validation.js +3 -3
- package/dist/internal/session/validation.js.map +1 -1
- package/dist/layers.d.ts +2 -2
- package/dist/layers.d.ts.map +1 -1
- package/dist/layers.js +4 -4
- package/dist/layers.js.map +1 -1
- package/dist/local/store/expo/adapter.d.ts +8 -8
- package/dist/local/store/expo/adapter.d.ts.map +1 -1
- package/dist/local/store/expo/adapter.js +7 -7
- package/dist/local/store/expo/adapter.js.map +1 -1
- package/dist/local/store/expo/database-key.d.ts +2 -2
- package/dist/local/store/expo/database-key.d.ts.map +1 -1
- package/dist/local/store/expo/database-key.js +5 -5
- package/dist/local/store/expo/database-key.js.map +1 -1
- package/dist/local/store/expo/db.d.ts +9 -9
- package/dist/local/store/expo/db.d.ts.map +1 -1
- package/dist/local/store/expo/db.js +2 -2
- package/dist/local/store/expo/db.js.map +1 -1
- package/dist/local/store/expo/index.d.ts +6 -6
- package/dist/local/store/expo/index.d.ts.map +1 -1
- package/dist/local/store/expo/index.js +3 -3
- package/dist/local/store/expo/index.js.map +1 -1
- package/dist/local/store/expo/key-storage.d.ts +1 -1
- package/dist/local/store/expo/key-storage.d.ts.map +1 -1
- package/dist/local/store/expo/key-storage.js +4 -4
- package/dist/local/store/expo/key-storage.js.map +1 -1
- package/dist/local/store/expo/secure-store-options.d.ts +1 -1
- package/dist/local/store/expo/secure-store-options.d.ts.map +1 -1
- package/dist/local/store/expo/secure-store-options.js +1 -1
- package/dist/local/store/expo/secure-store-options.js.map +1 -1
- package/dist/local/store/index.d.ts +9 -9
- package/dist/local/store/index.d.ts.map +1 -1
- package/dist/local/store/index.js +8 -8
- package/dist/local/store/index.js.map +1 -1
- package/dist/local/store/mock/adapter.d.ts +6 -6
- package/dist/local/store/mock/adapter.d.ts.map +1 -1
- package/dist/local/store/mock/adapter.js +2 -2
- package/dist/local/store/mock/adapter.js.map +1 -1
- package/dist/local/store/mock/index.d.ts +3 -3
- package/dist/local/store/mock/index.d.ts.map +1 -1
- package/dist/local/store/mock/index.js +3 -3
- package/dist/local/store/mock/index.js.map +1 -1
- package/dist/local/store/node/adapter.d.ts +4 -4
- package/dist/local/store/node/adapter.d.ts.map +1 -1
- package/dist/local/store/node/adapter.js +2 -2
- package/dist/local/store/node/adapter.js.map +1 -1
- package/dist/local/store/node/database.d.ts.map +1 -1
- package/dist/local/store/node/database.js +2 -2
- package/dist/local/store/node/database.js.map +1 -1
- package/dist/local/store/node/index.d.ts +4 -4
- package/dist/local/store/node/index.d.ts.map +1 -1
- package/dist/local/store/node/index.js +3 -3
- package/dist/local/store/node/index.js.map +1 -1
- package/dist/local/store/react-native/adapter.d.ts +5 -5
- package/dist/local/store/react-native/adapter.d.ts.map +1 -1
- package/dist/local/store/react-native/adapter.js +12 -12
- package/dist/local/store/react-native/adapter.js.map +1 -1
- package/dist/local/store/react-native/index.d.ts +4 -4
- package/dist/local/store/react-native/index.d.ts.map +1 -1
- package/dist/local/store/react-native/index.js +3 -3
- package/dist/local/store/react-native/index.js.map +1 -1
- package/dist/local/store/react-native/storage.d.ts +1 -1
- package/dist/local/store/web/adapter.d.ts +4 -4
- package/dist/local/store/web/adapter.d.ts.map +1 -1
- package/dist/local/store/web/adapter.js +7 -7
- package/dist/local/store/web/adapter.js.map +1 -1
- package/dist/local/store/web/index.d.ts +4 -4
- package/dist/local/store/web/index.d.ts.map +1 -1
- package/dist/local/store/web/index.js +3 -3
- package/dist/local/store/web/index.js.map +1 -1
- package/dist/local/vault/expo-secure-store.d.ts +2 -2
- package/dist/local/vault/expo-secure-store.d.ts.map +1 -1
- package/dist/local/vault/expo-secure-store.js +5 -5
- package/dist/local/vault/expo-secure-store.js.map +1 -1
- package/dist/local/vault/index.d.ts +2 -2
- package/dist/local/vault/index.d.ts.map +1 -1
- package/dist/local/vault/index.js +1 -1
- package/dist/local/vault/index.js.map +1 -1
- package/dist/logger.d.ts +3 -3
- package/dist/logger.d.ts.map +1 -1
- package/dist/logger.js +4 -4
- package/dist/logger.js.map +1 -1
- package/dist/media/index.d.ts +5 -5
- package/dist/media/index.d.ts.map +1 -1
- package/dist/profile/contact-state.d.ts.map +1 -1
- package/dist/profile/contact-state.js +2 -2
- package/dist/profile/contact-state.js.map +1 -1
- package/dist/profile/profile-key.d.ts.map +1 -1
- package/dist/profile/profile-key.js +2 -2
- package/dist/profile/profile-key.js.map +1 -1
- package/dist/profile/update-service.d.ts.map +1 -1
- package/dist/profile/update-service.js +2 -2
- package/dist/profile/update-service.js.map +1 -1
- package/dist/remote/object-store/convex-r2/storage.d.ts +2 -2
- package/dist/remote/object-store/convex-r2/storage.d.ts.map +1 -1
- package/dist/remote/object-store/index.d.ts +1 -1
- package/dist/remote/object-store/index.d.ts.map +1 -1
- package/dist/remote/object-store/s3/storage.d.ts +3 -3
- package/dist/remote/object-store/s3/storage.d.ts.map +1 -1
- package/dist/remote/object-store/s3/storage.js +1 -1
- package/dist/remote/object-store/types.d.ts +1 -1
- package/dist/remote/object-store/types.d.ts.map +1 -1
- package/dist/remote/relay/convex/index.d.ts +9 -9
- package/dist/remote/relay/convex/index.d.ts.map +1 -1
- package/dist/remote/relay/convex/index.js +5 -5
- package/dist/remote/relay/convex/index.js.map +1 -1
- package/dist/remote/relay/convex/relay.d.ts +11 -11
- package/dist/remote/relay/convex/relay.d.ts.map +1 -1
- package/dist/remote/relay/convex/relay.js +10 -10
- package/dist/remote/relay/convex/relay.js.map +1 -1
- package/dist/remote/relay/index.d.ts +7 -7
- package/dist/remote/relay/index.d.ts.map +1 -1
- package/dist/remote/relay/index.js +6 -6
- package/dist/remote/relay/index.js.map +1 -1
- package/dist/remote/relay/mock/adapter.d.ts +6 -6
- package/dist/remote/relay/mock/adapter.d.ts.map +1 -1
- package/dist/remote/relay/mock/adapter.js +9 -4
- package/dist/remote/relay/mock/adapter.js.map +1 -1
- package/dist/remote/relay/mock/failures.d.ts +1 -0
- package/dist/remote/relay/mock/failures.d.ts.map +1 -1
- package/dist/remote/relay/mock/failures.js +5 -0
- package/dist/remote/relay/mock/failures.js.map +1 -1
- package/dist/remote/relay/mock/index.d.ts +3 -3
- package/dist/remote/relay/mock/index.d.ts.map +1 -1
- package/dist/remote/relay/mock/index.js +3 -3
- package/dist/remote/relay/mock/index.js.map +1 -1
- package/dist/remote/relay/types.d.ts +11 -11
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/remote/relay/types.js +2 -2
- package/dist/types/api.d.ts +2 -2
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/messages.d.ts +1 -1
- package/dist/types/protocol-config.d.ts +17 -2
- package/dist/types/protocol-config.d.ts.map +1 -1
- package/dist/types/protocol-config.js +17 -2
- package/dist/types/protocol-config.js.map +1 -1
- package/dist/utils/retry.d.ts +2 -2
- package/dist/utils/retry.d.ts.map +1 -1
- package/dist/utils/retry.js +17 -0
- package/dist/utils/retry.js.map +1 -1
- package/docs/CLIENT_COMPOSITION.md +3 -3
- package/docs/DEVIATIONS.md +34 -18
- package/docs/GETTING_STARTED.md +3 -3
- package/docs/INTERFACES.md +22 -22
- package/docs/PACKAGE_SURFACE.md +10 -10
- package/docs/RECIPES.md +4 -4
- package/docs/api/classes/EndorsementManager.md +1 -1
- package/docs/api/classes/{SignalBlockingManager.md → SignalProtocolBlockingManager.md} +5 -5
- package/docs/api/classes/SignalProtocolClient.md +2 -2
- package/docs/api/functions/createDefaultSignalProtocolContentAdapter.md +13 -0
- package/docs/api/functions/{createDefaultSignalLogger.md → createDefaultSignalProtocolLogger.md} +5 -5
- package/docs/api/functions/{resolveSignalLogger.md → resolveSignalProtocolLogger.md} +5 -5
- package/docs/api/interfaces/IProtocolStore.md +1 -1
- package/docs/api/interfaces/ISenderKeyStore.md +1 -1
- package/docs/api/interfaces/ISesameStore.md +1 -1
- package/docs/api/interfaces/{ISignalLocalSecretVault.md → ISignalProtocolLocalSecretVault.md} +2 -2
- package/docs/api/interfaces/{ISignalLocalStore.md → ISignalProtocolLocalStore.md} +2 -2
- package/docs/api/interfaces/{ISignalRelayServer.md → ISignalProtocolRelayServer.md} +3 -3
- package/docs/api/interfaces/{InspectedSignalContent.md → InspectedSignalProtocolContent.md} +2 -2
- package/docs/api/interfaces/MLKEMBraidAgentState.md +1 -1
- package/docs/api/interfaces/MessageHeader.md +1 -1
- package/docs/api/interfaces/PreKeyMaintenanceStore.md +2 -2
- package/docs/api/interfaces/SealedSenderConfig.md +2 -2
- package/docs/api/interfaces/{SignalBlockingHooks.md → SignalProtocolBlockingHooks.md} +2 -2
- package/docs/api/interfaces/SignalProtocolBlockingManagerOptions.md +31 -0
- package/docs/api/interfaces/{SignalBlockingMirror.md → SignalProtocolBlockingMirror.md} +2 -2
- package/docs/api/interfaces/{SignalBlockingStore.md → SignalProtocolBlockingStore.md} +2 -2
- package/docs/api/interfaces/SignalProtocolClientAdapterConfig.md +3 -3
- package/docs/api/interfaces/SignalProtocolClientCompositionOptions.md +3 -3
- package/docs/api/interfaces/SignalProtocolClientConfig.md +11 -11
- package/docs/api/interfaces/SignalProtocolClientHooks.md +1 -1
- package/docs/api/interfaces/SignalProtocolClientMediaConfig.md +2 -2
- package/docs/api/interfaces/{SignalContentAdapter.md → SignalProtocolContentAdapter.md} +4 -4
- package/docs/api/interfaces/{SignalRemoteObjectStore.md → SignalProtocolRemoteObjectStore.md} +2 -2
- package/docs/api/namespaces/blocking/README.md +10 -10
- package/docs/api/namespaces/keys/functions/generateKemOneTimePreKeys.md +1 -1
- package/docs/api/namespaces/media/interfaces/DeleteMediaAttachmentOptions.md +1 -1
- package/docs/api/namespaces/media/interfaces/ExecuteMediaAttachmentJobOptions.md +1 -1
- package/docs/api/namespaces/media/interfaces/PrepareMediaAttachmentUploadOptions.md +1 -1
- package/docs/api/namespaces/media/interfaces/ResolveMediaAttachmentOptions.md +1 -1
- package/docs/api/variables/MAX_RECEIVER_CHAINS.md +1 -1
- package/docs/api/variables/ONE_TIME_PREKEY_BATCH_SIZE.md +1 -1
- package/docs/api/variables/{defaultSignalLogger.md → defaultSignalProtocolLogger.md} +5 -5
- package/files/README.md +1 -1
- package/local/store/README.md +10 -10
- package/local/store/expo/README.md +5 -5
- package/local/store/mock/README.md +1 -1
- package/local/store/node/README.md +1 -1
- package/local/store/react-native/README.md +1 -1
- package/local/store/web/README.md +1 -1
- package/local/vault/README.md +3 -3
- package/package.json +1 -1
- package/remote/README.md +19 -19
- package/remote/object-store/README.md +3 -3
- package/remote/object-store/convex-r2/README.md +1 -1
- package/remote/object-store/s3/README.md +1 -1
- package/remote/relay/README.md +2 -2
- package/remote/relay/convex/README.md +4 -4
- package/remote/relay/mock/README.md +1 -1
- package/types/README.md +1 -1
- package/docs/api/functions/createDefaultSignalContentAdapter.md +0 -13
- package/docs/api/interfaces/SignalBlockingManagerOptions.md +0 -31
package/docs/PACKAGE_SURFACE.md
CHANGED
|
@@ -142,24 +142,24 @@ Expo storage or Convex helpers.
|
|
|
142
142
|
|
|
143
143
|
### Relay implementations
|
|
144
144
|
|
|
145
|
-
- `
|
|
145
|
+
- `ConvexSignalProtocolRelayServer` for Convex-backed apps
|
|
146
146
|
- `convexRelay()` for Convex-backed composition
|
|
147
|
-
- `
|
|
148
|
-
- custom implementations via `
|
|
147
|
+
- `MockSignalProtocolRelayServer` / `mockRelay()` for local development
|
|
148
|
+
- custom implementations via `ISignalProtocolRelayServer`
|
|
149
149
|
|
|
150
150
|
### Storage implementations
|
|
151
151
|
|
|
152
|
-
- `
|
|
152
|
+
- `ExpoSignalProtocolStore` for Expo / React Native
|
|
153
153
|
- `expoStore()` for Expo / React Native composition
|
|
154
154
|
- `@open-e2ee/signal-protocol-sdk/local/store/expo` also exports the Expo helpers
|
|
155
155
|
Signal Protocol composes directly: `getKeyStorage`, `getDatabaseKeyManager`,
|
|
156
156
|
`clearDatabaseKeyCache`, and `createPreKeyMaintenanceStore`
|
|
157
|
-
- `
|
|
158
|
-
- `
|
|
157
|
+
- `IndexedDbSignalProtocolStore` / `indexedDbStore()` for browsers (experimental)
|
|
158
|
+
- `ReactNativeSignalProtocolStore` / `reactNativeStore()` for bare React Native
|
|
159
159
|
(experimental; provide your own key-value backend)
|
|
160
|
-
- `
|
|
161
|
-
- `
|
|
162
|
-
- custom implementations via `
|
|
160
|
+
- `NodeSignalProtocolStore` / `nodeStore()` for Node environments
|
|
161
|
+
- `MockSignalProtocolStore` / `mockStore()` for local development
|
|
162
|
+
- custom implementations via `ISignalProtocolLocalStore`
|
|
163
163
|
|
|
164
164
|
### Remote object storage
|
|
165
165
|
|
|
@@ -171,7 +171,7 @@ Expo storage or Convex helpers.
|
|
|
171
171
|
point
|
|
172
172
|
- `S3ObjectStore` via `@open-e2ee/signal-protocol-sdk/remote/object-store/s3`
|
|
173
173
|
- `s3ObjectStore()` for brokered Amazon S3 or S3-compatible storage
|
|
174
|
-
- custom implementations via `
|
|
174
|
+
- custom implementations via `SignalProtocolRemoteObjectStore`
|
|
175
175
|
|
|
176
176
|
`ConvexR2ObjectStore` is a client adapter for authenticated app-owned Convex
|
|
177
177
|
functions that wrap `@convex-dev/r2`; it is not the Convex component itself.
|
package/docs/RECIPES.md
CHANGED
|
@@ -13,7 +13,7 @@ uses public exports only.
|
|
|
13
13
|
This local demo sends while Bob is offline so you can see the relay's encrypted
|
|
14
14
|
envelope and Bob's decrypted plaintext in the same workflow.
|
|
15
15
|
|
|
16
|
-
<!-- mock-snippet:run recipes-two-local-clients -->
|
|
16
|
+
<!-- mock-snippet:run recipes-two-local-clients expect="bob decrypted: alice: hello" -->
|
|
17
17
|
```ts
|
|
18
18
|
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
19
19
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
@@ -99,12 +99,12 @@ Bob through the `onMessageDecrypted` hook.
|
|
|
99
99
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
100
100
|
import {
|
|
101
101
|
convexRelay,
|
|
102
|
-
type
|
|
102
|
+
type ConvexSignalProtocolRelayApi,
|
|
103
103
|
} from "@open-e2ee/signal-protocol-sdk/remote/relay/convex";
|
|
104
104
|
import { expoStore } from "@open-e2ee/signal-protocol-sdk/local/store/expo";
|
|
105
105
|
import { api } from "../convex/_generated/api";
|
|
106
106
|
|
|
107
|
-
const signalApi = api.signal satisfies
|
|
107
|
+
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
108
108
|
|
|
109
109
|
// The relay handles server-side public keys, devices, and encrypted envelopes.
|
|
110
110
|
const relay = convexRelay({
|
|
@@ -135,7 +135,7 @@ before creating the client.
|
|
|
135
135
|
|
|
136
136
|
## Local development
|
|
137
137
|
|
|
138
|
-
<!-- mock-snippet:run recipes-local-development -->
|
|
138
|
+
<!-- mock-snippet:run recipes-local-development expect="" -->
|
|
139
139
|
```ts
|
|
140
140
|
// Real protocol and cryptography; simulated in-memory infrastructure.
|
|
141
141
|
import { createSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolBlockingManager
|
|
6
6
|
|
|
7
|
-
# Class:
|
|
7
|
+
# Class: SignalProtocolBlockingManager
|
|
8
8
|
|
|
9
9
|
SDK blocking orchestration.
|
|
10
10
|
|
|
@@ -15,17 +15,17 @@ project that state elsewhere without becoming a second mutation path.
|
|
|
15
15
|
|
|
16
16
|
### Constructor
|
|
17
17
|
|
|
18
|
-
> **new
|
|
18
|
+
> **new SignalProtocolBlockingManager**(`options`): `SignalProtocolBlockingManager`
|
|
19
19
|
|
|
20
20
|
#### Parameters
|
|
21
21
|
|
|
22
22
|
##### options
|
|
23
23
|
|
|
24
|
-
[`
|
|
24
|
+
[`SignalProtocolBlockingManagerOptions`](../interfaces/SignalProtocolBlockingManagerOptions.md)
|
|
25
25
|
|
|
26
26
|
#### Returns
|
|
27
27
|
|
|
28
|
-
`
|
|
28
|
+
`SignalProtocolBlockingManager`
|
|
29
29
|
|
|
30
30
|
## Methods
|
|
31
31
|
|
|
@@ -1785,7 +1785,7 @@ Per Signal Protocol specification, rotate sender keys on **membership changes**:
|
|
|
1785
1785
|
| Member ADDED | Distribute current key to new member (no rotation needed) |
|
|
1786
1786
|
| Group metadata changed | Rotate recommended |
|
|
1787
1787
|
|
|
1788
|
-
**Important**: The
|
|
1788
|
+
**Important**: The reference implementation does NOT use periodic or message-count-based rotation.
|
|
1789
1789
|
Only rotate when membership changes to maintain forward secrecy.
|
|
1790
1790
|
|
|
1791
1791
|
## Why Rotate on Member Removal?
|
|
@@ -1919,7 +1919,7 @@ All inputs are normalized to Uint8Array before reaching the cipher layer.
|
|
|
1919
1919
|
|
|
1920
1920
|
`string`
|
|
1921
1921
|
|
|
1922
|
-
User ID or group ID (groups use the
|
|
1922
|
+
User ID or group ID (groups use the V2 group ID prefix)
|
|
1923
1923
|
|
|
1924
1924
|
##### content
|
|
1925
1925
|
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / createDefaultSignalProtocolContentAdapter
|
|
6
|
+
|
|
7
|
+
# Function: createDefaultSignalProtocolContentAdapter()
|
|
8
|
+
|
|
9
|
+
> **createDefaultSignalProtocolContentAdapter**(): [`SignalProtocolContentAdapter`](../interfaces/SignalProtocolContentAdapter.md)
|
|
10
|
+
|
|
11
|
+
## Returns
|
|
12
|
+
|
|
13
|
+
[`SignalProtocolContentAdapter`](../interfaces/SignalProtocolContentAdapter.md)
|
package/docs/api/functions/{createDefaultSignalLogger.md → createDefaultSignalProtocolLogger.md}
RENAMED
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / createDefaultSignalProtocolLogger
|
|
6
6
|
|
|
7
|
-
# Function:
|
|
7
|
+
# Function: createDefaultSignalProtocolLogger()
|
|
8
8
|
|
|
9
|
-
> **
|
|
9
|
+
> **createDefaultSignalProtocolLogger**(): [`ILogger`](../interfaces/ILogger.md)
|
|
10
10
|
|
|
11
11
|
Logging utilities for app composition
|
|
12
12
|
|
|
13
|
-
Pass a logger into `createSignalProtocolClient()` to route Signal Protocol logs
|
|
14
|
-
|
|
13
|
+
Pass a logger into `createSignalProtocolClient()` to route Signal Protocol logs through
|
|
14
|
+
your app logger or custom diagnostics pipeline.
|
|
15
15
|
|
|
16
16
|
## Returns
|
|
17
17
|
|
|
@@ -2,16 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / resolveSignalProtocolLogger
|
|
6
6
|
|
|
7
|
-
# Function:
|
|
7
|
+
# Function: resolveSignalProtocolLogger()
|
|
8
8
|
|
|
9
|
-
> **
|
|
9
|
+
> **resolveSignalProtocolLogger**(`logger?`): `Required`\<[`ILogger`](../interfaces/ILogger.md)\>
|
|
10
10
|
|
|
11
11
|
Logging utilities for app composition
|
|
12
12
|
|
|
13
|
-
Pass a logger into `createSignalProtocolClient()` to route Signal Protocol logs
|
|
14
|
-
|
|
13
|
+
Pass a logger into `createSignalProtocolClient()` to route Signal Protocol logs through
|
|
14
|
+
your app logger or custom diagnostics pipeline.
|
|
15
15
|
|
|
16
16
|
## Parameters
|
|
17
17
|
|
package/docs/api/interfaces/{ISignalLocalSecretVault.md → ISignalProtocolLocalSecretVault.md}
RENAMED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / ISignalProtocolLocalSecretVault
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: ISignalProtocolLocalSecretVault
|
|
8
8
|
|
|
9
9
|
Small local secret vault used to bootstrap a local Signal Protocol store.
|
|
10
10
|
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / ISignalProtocolLocalStore
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: ISignalProtocolLocalStore
|
|
8
8
|
|
|
9
9
|
Signal Protocol local store interface.
|
|
10
10
|
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / ISignalProtocolRelayServer
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: ISignalProtocolRelayServer
|
|
8
8
|
|
|
9
9
|
Server-side relay for encrypted envelope push delivery.
|
|
10
10
|
|
|
@@ -18,7 +18,7 @@ Maps to 17 Convex tables.
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
const relay:
|
|
21
|
+
const relay: ISignalProtocolRelayServer = new ConvexSignalProtocolRelayServer(convex, signalApi, {
|
|
22
22
|
currentUserId: userId,
|
|
23
23
|
});
|
|
24
24
|
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / InspectedSignalProtocolContent
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: InspectedSignalProtocolContent
|
|
8
8
|
|
|
9
9
|
## Properties
|
|
10
10
|
|
|
@@ -52,7 +52,7 @@ Decoded CT1 stored for combined MAC verification with CT2
|
|
|
52
52
|
|
|
53
53
|
> `optional` **ct1\_for\_mac?**: `Uint8Array`\<`ArrayBufferLike`\>
|
|
54
54
|
|
|
55
|
-
CT1 copy stored for combined MAC computation with CT2 (
|
|
55
|
+
CT1 copy stored for combined MAC computation with CT2 (the reference implementation authenticates ct1||ct2)
|
|
56
56
|
|
|
57
57
|
***
|
|
58
58
|
|
|
@@ -11,7 +11,7 @@ Double Ratchet message header
|
|
|
11
11
|
Contains metadata needed for DH ratcheting and out-of-order message handling.
|
|
12
12
|
This header is sent with every encrypted message.
|
|
13
13
|
|
|
14
|
-
Field names reflect the
|
|
14
|
+
Field names reflect the SignalProtocolMessage wire fields:
|
|
15
15
|
|
|
16
16
|
## Properties
|
|
17
17
|
|
|
@@ -8,8 +8,8 @@
|
|
|
8
8
|
|
|
9
9
|
App-provided persistence helpers for prekey replacement bookkeeping.
|
|
10
10
|
|
|
11
|
-
The Signal Protocol
|
|
12
|
-
|
|
11
|
+
The Signal Protocol SDK owns rotation semantics; concrete storage adapters own
|
|
12
|
+
persistence.
|
|
13
13
|
|
|
14
14
|
## Methods
|
|
15
15
|
|
|
@@ -52,8 +52,8 @@ Base64-encoded serialized SenderCertificate
|
|
|
52
52
|
|
|
53
53
|
Optional host-provided contact profile state store.
|
|
54
54
|
|
|
55
|
-
When present, the Signal Protocol client can use per-contact profile keys
|
|
56
|
-
|
|
55
|
+
When present, the Signal Protocol client can use per-contact profile keys and
|
|
56
|
+
unidentified-access mode for direct-message sealed sender sends
|
|
57
57
|
without importing the host app's persistence layer.
|
|
58
58
|
|
|
59
59
|
***
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolBlockingHooks
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: SignalProtocolBlockingHooks
|
|
8
8
|
|
|
9
9
|
Optional local side effects that belong to the act of blocking itself.
|
|
10
10
|
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
[**@open-e2ee/signal-protocol-sdk**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolBlockingManagerOptions
|
|
6
|
+
|
|
7
|
+
# Interface: SignalProtocolBlockingManagerOptions
|
|
8
|
+
|
|
9
|
+
## Properties
|
|
10
|
+
|
|
11
|
+
### hooks?
|
|
12
|
+
|
|
13
|
+
> `optional` **hooks?**: [`SignalProtocolBlockingHooks`](SignalProtocolBlockingHooks.md)
|
|
14
|
+
|
|
15
|
+
***
|
|
16
|
+
|
|
17
|
+
### logger?
|
|
18
|
+
|
|
19
|
+
> `optional` **logger?**: [`ILogger`](ILogger.md)
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### mirror?
|
|
24
|
+
|
|
25
|
+
> `optional` **mirror?**: [`SignalProtocolBlockingMirror`](SignalProtocolBlockingMirror.md)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### store
|
|
30
|
+
|
|
31
|
+
> **store**: [`SignalProtocolBlockingStore`](SignalProtocolBlockingStore.md)
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolBlockingMirror
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: SignalProtocolBlockingMirror
|
|
8
8
|
|
|
9
9
|
Optional app/backend mirror for local block changes.
|
|
10
10
|
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolBlockingStore
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: SignalProtocolBlockingStore
|
|
8
8
|
|
|
9
9
|
Durable local store for blocked recipients.
|
|
10
10
|
|
|
@@ -23,7 +23,7 @@ Advanced protocol manager override for tests and specialized integrations.
|
|
|
23
23
|
|
|
24
24
|
### relay?
|
|
25
25
|
|
|
26
|
-
> `optional` **relay?**: [`
|
|
26
|
+
> `optional` **relay?**: [`ISignalProtocolRelayServer`](ISignalProtocolRelayServer.md)
|
|
27
27
|
|
|
28
28
|
Optional relay for server sync, prekeys, fanout, and subscriptions.
|
|
29
29
|
|
|
@@ -31,7 +31,7 @@ Optional relay for server sync, prekeys, fanout, and subscriptions.
|
|
|
31
31
|
|
|
32
32
|
### remoteObjectStore?
|
|
33
33
|
|
|
34
|
-
> `optional` **remoteObjectStore?**: [`
|
|
34
|
+
> `optional` **remoteObjectStore?**: [`SignalProtocolRemoteObjectStore`](SignalProtocolRemoteObjectStore.md)
|
|
35
35
|
|
|
36
36
|
Optional brokered remote object store for encrypted attachments.
|
|
37
37
|
|
|
@@ -39,6 +39,6 @@ Optional brokered remote object store for encrypted attachments.
|
|
|
39
39
|
|
|
40
40
|
### storage
|
|
41
41
|
|
|
42
|
-
> **storage**: [`
|
|
42
|
+
> **storage**: [`ISignalProtocolLocalStore`](ISignalProtocolLocalStore.md)
|
|
43
43
|
|
|
44
44
|
Required local protocol store for the current runtime.
|
|
@@ -63,7 +63,7 @@ signal.startRelaySubscription();
|
|
|
63
63
|
|
|
64
64
|
### contentAdapter?
|
|
65
65
|
|
|
66
|
-
> `optional` **contentAdapter?**: [`
|
|
66
|
+
> `optional` **contentAdapter?**: [`SignalProtocolContentAdapter`](SignalProtocolContentAdapter.md)
|
|
67
67
|
|
|
68
68
|
Application-provided content adapter.
|
|
69
69
|
|
|
@@ -389,8 +389,8 @@ https://signal.org/docs/specifications/pqxdh/#publishing-keys
|
|
|
389
389
|
|
|
390
390
|
App-owned media lifecycle callbacks for the SignalProtocolClient media queue.
|
|
391
391
|
|
|
392
|
-
The queue itself is persisted through the existing Signal Protocol local
|
|
393
|
-
|
|
392
|
+
The queue itself is persisted through the existing Signal Protocol local storage
|
|
393
|
+
adapter. These callbacks keep local bytes, plaintext caches, and product
|
|
394
394
|
state in the app layer where they can share file permissions, UI state, and
|
|
395
395
|
app database ownership.
|
|
396
396
|
|
|
@@ -22,11 +22,11 @@ import {
|
|
|
22
22
|
} from '@open-e2ee/signal-protocol-sdk';
|
|
23
23
|
import {
|
|
24
24
|
convexRelay,
|
|
25
|
-
type
|
|
25
|
+
type ConvexSignalProtocolRelayApi,
|
|
26
26
|
} from '@open-e2ee/signal-protocol-sdk/remote/relay/convex';
|
|
27
27
|
import { api } from '../convex/_generated/api';
|
|
28
28
|
|
|
29
|
-
const signalApi = api.signal satisfies
|
|
29
|
+
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
30
30
|
const relay = convexRelay({ convex, api: signalApi, currentUserId: userId });
|
|
31
31
|
|
|
32
32
|
// Preferred app-facing composition.
|
|
@@ -36,7 +36,7 @@ const signal = await createSignalProtocolClient({
|
|
|
36
36
|
});
|
|
37
37
|
|
|
38
38
|
// Low-level factory with the same underlying options.
|
|
39
|
-
const
|
|
39
|
+
const advancedSignalProtocol = await SignalProtocolClient.create(userId, {
|
|
40
40
|
storage,
|
|
41
41
|
relay,
|
|
42
42
|
onProgress,
|
|
@@ -52,7 +52,7 @@ const advancedSignal = await SignalProtocolClient.create(userId, {
|
|
|
52
52
|
|
|
53
53
|
### contentAdapter?
|
|
54
54
|
|
|
55
|
-
> `optional` **contentAdapter?**: [`
|
|
55
|
+
> `optional` **contentAdapter?**: [`SignalProtocolContentAdapter`](SignalProtocolContentAdapter.md)
|
|
56
56
|
|
|
57
57
|
Application-provided content adapter.
|
|
58
58
|
|
|
@@ -407,8 +407,8 @@ https://signal.org/docs/specifications/pqxdh/#publishing-keys
|
|
|
407
407
|
|
|
408
408
|
App-owned media lifecycle callbacks for the SignalProtocolClient media queue.
|
|
409
409
|
|
|
410
|
-
The queue itself is persisted through the existing Signal Protocol local
|
|
411
|
-
|
|
410
|
+
The queue itself is persisted through the existing Signal Protocol local storage
|
|
411
|
+
adapter. These callbacks keep local bytes, plaintext caches, and product
|
|
412
412
|
state in the app layer where they can share file permissions, UI state, and
|
|
413
413
|
app database ownership.
|
|
414
414
|
|
|
@@ -680,7 +680,7 @@ Double Ratchet algorithm configuration
|
|
|
680
680
|
|
|
681
681
|
### relay?
|
|
682
682
|
|
|
683
|
-
> `optional` **relay?**: [`
|
|
683
|
+
> `optional` **relay?**: [`ISignalProtocolRelayServer`](ISignalProtocolRelayServer.md)
|
|
684
684
|
|
|
685
685
|
Relay adapter for server synchronization.
|
|
686
686
|
|
|
@@ -697,11 +697,11 @@ If omitted, client operates in local-only mode.
|
|
|
697
697
|
import { createSignalProtocolClient } from '@open-e2ee/signal-protocol-sdk';
|
|
698
698
|
import {
|
|
699
699
|
convexRelay,
|
|
700
|
-
type
|
|
700
|
+
type ConvexSignalProtocolRelayApi,
|
|
701
701
|
} from '@open-e2ee/signal-protocol-sdk/remote/relay/convex';
|
|
702
702
|
import { api } from '../convex/_generated/api';
|
|
703
703
|
|
|
704
|
-
const signalApi = api.signal satisfies
|
|
704
|
+
const signalApi = api.signal satisfies ConvexSignalProtocolRelayApi;
|
|
705
705
|
const relay = convexRelay({ convex, api: signalApi, currentUserId: userId });
|
|
706
706
|
|
|
707
707
|
const signal = await createSignalProtocolClient({
|
|
@@ -714,7 +714,7 @@ const signal = await createSignalProtocolClient({
|
|
|
714
714
|
|
|
715
715
|
### remoteObjectStore?
|
|
716
716
|
|
|
717
|
-
> `optional` **remoteObjectStore?**: [`
|
|
717
|
+
> `optional` **remoteObjectStore?**: [`SignalProtocolRemoteObjectStore`](SignalProtocolRemoteObjectStore.md)
|
|
718
718
|
|
|
719
719
|
Remote object storage adapter for encrypted file uploads (two-layer encryption)
|
|
720
720
|
|
|
@@ -823,7 +823,7 @@ const signal = await SignalProtocolClient.create(userId, {
|
|
|
823
823
|
|
|
824
824
|
### storage
|
|
825
825
|
|
|
826
|
-
> **storage**: [`
|
|
826
|
+
> **storage**: [`ISignalProtocolLocalStore`](ISignalProtocolLocalStore.md)
|
|
827
827
|
|
|
828
828
|
Local store implementation for the current runtime.
|
|
829
829
|
Required by SignalProtocolClient.create().
|
|
@@ -46,8 +46,8 @@ Delete app-owned local cache state for a cleanup job.
|
|
|
46
46
|
|
|
47
47
|
Load app-owned local bytes for a queued upload.
|
|
48
48
|
|
|
49
|
-
The Signal Protocol package owns encryption and upload execution. The app owns
|
|
50
|
-
|
|
49
|
+
The Signal Protocol package owns encryption and upload execution. The app owns draft
|
|
50
|
+
files, cache paths, and file permissions, so bytes enter the queue through
|
|
51
51
|
this callback instead of hidden package storage.
|
|
52
52
|
|
|
53
53
|
#### Parameters
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolContentAdapter
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: SignalProtocolContentAdapter
|
|
8
8
|
|
|
9
9
|
## Methods
|
|
10
10
|
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
|
|
31
31
|
### inspectContent()
|
|
32
32
|
|
|
33
|
-
> **inspectContent**(`plaintext`): [`
|
|
33
|
+
> **inspectContent**(`plaintext`): [`InspectedSignalProtocolContent`](InspectedSignalProtocolContent.md)
|
|
34
34
|
|
|
35
35
|
#### Parameters
|
|
36
36
|
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
|
|
41
41
|
#### Returns
|
|
42
42
|
|
|
43
|
-
[`
|
|
43
|
+
[`InspectedSignalProtocolContent`](InspectedSignalProtocolContent.md)
|
|
44
44
|
|
|
45
45
|
***
|
|
46
46
|
|
package/docs/api/interfaces/{SignalRemoteObjectStore.md → SignalProtocolRemoteObjectStore.md}
RENAMED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
***
|
|
4
4
|
|
|
5
|
-
[@open-e2ee/signal-protocol-sdk](../README.md) /
|
|
5
|
+
[@open-e2ee/signal-protocol-sdk](../README.md) / SignalProtocolRemoteObjectStore
|
|
6
6
|
|
|
7
|
-
# Interface:
|
|
7
|
+
# Interface: SignalProtocolRemoteObjectStore
|
|
8
8
|
|
|
9
9
|
Brokered remote storage for encrypted byte objects.
|
|
10
10
|
|
|
@@ -14,30 +14,30 @@ Re-exports [BlockedRecipientEntry](../../interfaces/BlockedRecipientEntry.md)
|
|
|
14
14
|
|
|
15
15
|
***
|
|
16
16
|
|
|
17
|
-
###
|
|
17
|
+
### SignalProtocolBlockingHooks
|
|
18
18
|
|
|
19
|
-
Re-exports [
|
|
19
|
+
Re-exports [SignalProtocolBlockingHooks](../../interfaces/SignalProtocolBlockingHooks.md)
|
|
20
20
|
|
|
21
21
|
***
|
|
22
22
|
|
|
23
|
-
###
|
|
23
|
+
### SignalProtocolBlockingManager
|
|
24
24
|
|
|
25
|
-
Re-exports [
|
|
25
|
+
Re-exports [SignalProtocolBlockingManager](../../classes/SignalProtocolBlockingManager.md)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
29
|
-
###
|
|
29
|
+
### SignalProtocolBlockingManagerOptions
|
|
30
30
|
|
|
31
|
-
Re-exports [
|
|
31
|
+
Re-exports [SignalProtocolBlockingManagerOptions](../../interfaces/SignalProtocolBlockingManagerOptions.md)
|
|
32
32
|
|
|
33
33
|
***
|
|
34
34
|
|
|
35
|
-
###
|
|
35
|
+
### SignalProtocolBlockingMirror
|
|
36
36
|
|
|
37
|
-
Re-exports [
|
|
37
|
+
Re-exports [SignalProtocolBlockingMirror](../../interfaces/SignalProtocolBlockingMirror.md)
|
|
38
38
|
|
|
39
39
|
***
|
|
40
40
|
|
|
41
|
-
###
|
|
41
|
+
### SignalProtocolBlockingStore
|
|
42
42
|
|
|
43
|
-
Re-exports [
|
|
43
|
+
Re-exports [SignalProtocolBlockingStore](../../interfaces/SignalProtocolBlockingStore.md)
|
|
@@ -16,7 +16,7 @@ Each key can only be used once for per-session post-quantum forward secrecy.
|
|
|
16
16
|
Per PQXDH spec Section 3.2, these are signed one-time pqkem prekeys
|
|
17
17
|
that the server prefers over the last-resort KEM prekey.
|
|
18
18
|
|
|
19
|
-
Uses the same batch size as EC one-time prekeys (
|
|
19
|
+
Uses the same batch size as EC one-time prekeys (the reference implementation uses 100 for both).
|
|
20
20
|
|
|
21
21
|
## Parameters
|
|
22
22
|
|