@open-e2ee/signal-protocol-sdk 14.2.0 → 14.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ADAPTERS.md +2 -2
- package/ARCHITECTURE.md +1 -1
- package/CHANGELOG.md +90 -0
- package/README.md +9 -9
- package/SECURITY.md +2 -2
- package/client/README.md +6 -5
- package/device/README.md +2 -1
- package/dist/client/client.d.ts +43 -42
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +54 -53
- package/dist/client/client.js.map +1 -1
- package/dist/client/compose.d.ts +5 -5
- package/dist/client/compose.d.ts.map +1 -1
- package/dist/client/compose.js +1 -1
- package/dist/client/config.d.ts +16 -16
- package/dist/client/config.d.ts.map +1 -1
- package/dist/client/content-adapter.d.ts +5 -5
- package/dist/client/content-adapter.d.ts.map +1 -1
- package/dist/client/content-adapter.js +6 -6
- package/dist/client/content-adapter.js.map +1 -1
- package/dist/client/device-set-reconciliation.d.ts +1 -1
- package/dist/client/device-set-reconciliation.js +1 -1
- package/dist/client/event-hooks.d.ts +4 -9
- package/dist/client/event-hooks.d.ts.map +1 -1
- package/dist/client/event-hooks.js +12 -7
- package/dist/client/event-hooks.js.map +1 -1
- package/dist/client/hosted-http-error.d.ts +1 -1
- package/dist/client/hosted-http-error.js +1 -1
- package/dist/client/hosted-sandbox-identity.d.ts +2 -2
- package/dist/client/hosted-sandbox-identity.js +2 -2
- package/dist/client/hosted-transport.d.ts +4 -4
- package/dist/client/hosted-transport.d.ts.map +1 -1
- package/dist/client/hosted-transport.js +2 -2
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/hosted.d.ts +17 -17
- package/dist/client/hosted.d.ts.map +1 -1
- package/dist/client/hosted.js +1 -1
- package/dist/client/send-deadline.d.ts +1 -1
- package/dist/client/send-deadline.d.ts.map +1 -1
- package/dist/client/send-deadline.js +4 -3
- package/dist/client/send-deadline.js.map +1 -1
- package/dist/client/signal-relay-lifecycle.d.ts +3 -4
- package/dist/client/signal-relay-lifecycle.d.ts.map +1 -1
- package/dist/client/signal-relay-lifecycle.js +3 -4
- package/dist/client/signal-relay-lifecycle.js.map +1 -1
- package/dist/client/signal-relay-subscription.d.ts +1 -1
- package/dist/client/signal-service-cipher.d.ts +3 -3
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +5 -5
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/types.d.ts +4 -4
- package/dist/client/types.d.ts.map +1 -1
- package/dist/hooks/use-signal-relay-connection-state.d.ts +2 -3
- package/dist/hooks/use-signal-relay-connection-state.d.ts.map +1 -1
- package/dist/hooks/use-signal-relay-connection-state.js.map +1 -1
- package/dist/index.d.ts +5 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/internal/groups/authority-certificate.d.ts +4 -3
- package/dist/internal/groups/authority-certificate.d.ts.map +1 -1
- package/dist/internal/groups/authority-certificate.js.map +1 -1
- package/dist/remote/signal-relay/types.d.ts +12 -11
- package/dist/remote/signal-relay/types.d.ts.map +1 -1
- package/dist/types/api.d.ts +15 -15
- package/dist/types/api.d.ts.map +1 -1
- package/dist/types/errors.d.ts +19 -12
- package/dist/types/errors.d.ts.map +1 -1
- package/dist/types/errors.js +20 -13
- package/dist/types/errors.js.map +1 -1
- package/dist/types/renamed-member.d.ts +13 -6
- package/dist/types/renamed-member.d.ts.map +1 -1
- package/dist/types/renamed-member.js +11 -6
- package/dist/types/renamed-member.js.map +1 -1
- package/docs/ASSURANCE.md +9 -9
- package/docs/CLIENT_COMPOSITION.md +4 -4
- package/docs/DEVIATIONS.md +2 -2
- package/docs/ERROR_HANDLING.md +3 -3
- package/docs/GETTING_STARTED.md +4 -3
- package/docs/INTERFACES.md +3 -3
- package/docs/PACKAGE_SURFACE.md +1 -1
- package/docs/PROTOCOL_POLICY.md +4 -4
- package/docs/RECIPES.md +7 -6
- package/local/store/expo/README.md +1 -1
- package/local/store/key-value/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/store/web-sqlite/README.md +1 -1
- package/package.json +1 -1
- package/remote/README.md +2 -2
- package/remote/object-store/convex-r2/README.md +1 -1
- package/remote/signal-relay/README.md +3 -2
|
@@ -189,7 +189,7 @@ import { reactNativeStore } from '@open-e2ee/signal-protocol-sdk/local/store/rea
|
|
|
189
189
|
|
|
190
190
|
const client = await createSignalProtocolClient({
|
|
191
191
|
identity: { userId },
|
|
192
|
-
adapters: { storage: await reactNativeStore(),
|
|
192
|
+
adapters: { storage: await reactNativeStore(), relay },
|
|
193
193
|
});
|
|
194
194
|
```
|
|
195
195
|
|
package/package.json
CHANGED
package/remote/README.md
CHANGED
|
@@ -40,7 +40,7 @@ const signal = await createHostedSignalProtocolClient({
|
|
|
40
40
|
},
|
|
41
41
|
hosted: {
|
|
42
42
|
// The environment-scoped connection URL from the OpenE2EE console.
|
|
43
|
-
|
|
43
|
+
relayUrl: process.env.EXPO_PUBLIC_OPEN_E2EE_SIGNAL_RELAY_URL ?? process.env.EXPO_PUBLIC_OPEN_E2EE_RELAY_URL!,
|
|
44
44
|
// Returns a short-lived signed assertion for the signed-in user.
|
|
45
45
|
getIdentityAssertion,
|
|
46
46
|
},
|
|
@@ -101,7 +101,7 @@ import { api } from "../convex/_generated/api";
|
|
|
101
101
|
|
|
102
102
|
const signal = await DefaultSignalProtocolClient.create(userId, {
|
|
103
103
|
storage,
|
|
104
|
-
|
|
104
|
+
relay,
|
|
105
105
|
remoteObjectStore: convexR2ObjectStore({
|
|
106
106
|
convex,
|
|
107
107
|
api: api.signalObjectStore,
|
|
@@ -19,16 +19,17 @@ Use the OpenE2EE Signal Protocol Relay through the hosted client factory:
|
|
|
19
19
|
```ts
|
|
20
20
|
import { createHostedSignalProtocolClient } from "@open-e2ee/signal-protocol-sdk";
|
|
21
21
|
|
|
22
|
+
const signalRelayUrl = process.env.OPEN_E2EE_SIGNAL_RELAY_URL ?? process.env.OPEN_E2EE_RELAY_URL!;
|
|
22
23
|
const signal = await createHostedSignalProtocolClient({
|
|
23
24
|
adapters: { storage },
|
|
24
25
|
hosted: {
|
|
25
|
-
|
|
26
|
+
relayUrl: signalRelayUrl,
|
|
26
27
|
getIdentityAssertion,
|
|
27
28
|
},
|
|
28
29
|
});
|
|
29
30
|
```
|
|
30
31
|
|
|
31
|
-
`oe new` writes
|
|
32
|
+
`oe new` writes the connection URL to `.env.local` as `OPEN_E2EE_SIGNAL_RELAY_URL`,
|
|
32
33
|
with the public prefix of the framework in a Next.js, Expo, or Vite
|
|
33
34
|
application. An `oe` release before 5.0.0 wrote the earlier name,
|
|
34
35
|
`OPEN_E2EE_RELAY_URL`. Read the new name first and the earlier name second.
|