@open-e2ee/signal-protocol-sdk 14.2.0 → 14.4.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 +160 -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/delivery-status.d.ts.map +1 -1
- package/dist/client/delivery-status.js +8 -7
- package/dist/client/delivery-status.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-anonymous-delivery.d.ts +10 -4
- package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -1
- package/dist/client/hosted-anonymous-delivery.js +17 -8
- package/dist/client/hosted-anonymous-delivery.js.map +1 -1
- package/dist/client/hosted-device-link-transport.d.ts +6 -2
- package/dist/client/hosted-device-link-transport.d.ts.map +1 -1
- package/dist/client/hosted-device-link-transport.js +10 -5
- package/dist/client/hosted-device-link-transport.js.map +1 -1
- package/dist/client/hosted-group-authority.d.ts +4 -2
- package/dist/client/hosted-group-authority.d.ts.map +1 -1
- package/dist/client/hosted-group-authority.js +10 -7
- package/dist/client/hosted-group-authority.js.map +1 -1
- package/dist/client/hosted-groups.d.ts +8 -3
- package/dist/client/hosted-groups.d.ts.map +1 -1
- package/dist/client/hosted-groups.js +15 -9
- package/dist/client/hosted-groups.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-mailbox-subscription.d.ts +6 -2
- package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -1
- package/dist/client/hosted-mailbox-subscription.js +20 -8
- package/dist/client/hosted-mailbox-subscription.js.map +1 -1
- package/dist/client/hosted-sandbox-identity.d.ts +25 -21
- package/dist/client/hosted-sandbox-identity.d.ts.map +1 -1
- package/dist/client/hosted-sandbox-identity.js +25 -21
- package/dist/client/hosted-sandbox-identity.js.map +1 -1
- package/dist/client/hosted-store-records.d.ts +22 -17
- package/dist/client/hosted-store-records.d.ts.map +1 -1
- package/dist/client/hosted-store-records.js +15 -10
- package/dist/client/hosted-store-records.js.map +1 -1
- package/dist/client/hosted-transport.d.ts +14 -10
- package/dist/client/hosted-transport.d.ts.map +1 -1
- package/dist/client/hosted-transport.js +134 -89
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/hosted.d.ts +32 -21
- package/dist/client/hosted.d.ts.map +1 -1
- package/dist/client/hosted.js +7 -7
- package/dist/client/hosted.js.map +1 -1
- package/dist/client/receive-work-seed.d.ts +4 -4
- package/dist/client/receive-work-seed.d.ts.map +1 -1
- package/dist/client/receive-work-seed.js +1 -1
- package/dist/client/receive-work-seed.js.map +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-protocol.d.ts +83 -18
- package/dist/client/signal-relay-protocol.d.ts.map +1 -1
- package/dist/client/signal-relay-protocol.js +186 -15
- package/dist/client/signal-relay-protocol.js.map +1 -1
- package/dist/client/signal-relay-subscription.d.ts +1 -1
- package/dist/client/signal-relay-subscription.js +1 -1
- package/dist/client/signal-relay-subscription.js.map +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/local/store/receive-work.d.ts +5 -5
- package/dist/local/store/receive-work.d.ts.map +1 -1
- package/dist/local/store/receive-work.js +10 -12
- package/dist/local/store/receive-work.js.map +1 -1
- package/dist/local/store/reliability.d.ts +7 -4
- package/dist/local/store/reliability.d.ts.map +1 -1
- package/dist/local/store/reliability.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 +27 -24
- 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
package/docs/INTERFACES.md
CHANGED
|
@@ -40,7 +40,7 @@ const storage: SignalProtocolLocalStore = appProtocolStore;
|
|
|
40
40
|
|
|
41
41
|
const client = await createSignalProtocolClient({
|
|
42
42
|
identity: { userId },
|
|
43
|
-
adapters: { storage,
|
|
43
|
+
adapters: { storage, relay },
|
|
44
44
|
});
|
|
45
45
|
```
|
|
46
46
|
|
|
@@ -90,7 +90,7 @@ delivery, key rotation, and encrypted group coordination.
|
|
|
90
90
|
import type { SignalProtocolRelayServer } from "@open-e2ee/signal-protocol-sdk/remote/signal-relay";
|
|
91
91
|
|
|
92
92
|
// An application-owned client transport to an authenticated backend.
|
|
93
|
-
const
|
|
93
|
+
const relay: SignalProtocolRelayServer = appSignalProtocolRelayTransport;
|
|
94
94
|
```
|
|
95
95
|
|
|
96
96
|
The hosted factory configures the OpenE2EE Signal Protocol Relay transport.
|
|
@@ -175,7 +175,7 @@ media lifecycle callbacks and client hooks at the client boundary:
|
|
|
175
175
|
```ts
|
|
176
176
|
const client = await createSignalProtocolClient({
|
|
177
177
|
identity: { userId },
|
|
178
|
-
adapters: { storage,
|
|
178
|
+
adapters: { storage, relay, remoteObjectStore },
|
|
179
179
|
media: {
|
|
180
180
|
preparedUploads: appPreparedUploads,
|
|
181
181
|
maxPreparedUploadBytes: appUploadBudgetBytes,
|
package/docs/PACKAGE_SURFACE.md
CHANGED
|
@@ -270,7 +270,7 @@ implement the same `MediaAttachmentTransfer` seam.
|
|
|
270
270
|
|
|
271
271
|
## Resume an existing hosted device
|
|
272
272
|
|
|
273
|
-
Use `resumeHostedSignalProtocolClient({ adapters: { storage }, hosted: {
|
|
273
|
+
Use `resumeHostedSignalProtocolClient({ adapters: { storage }, hosted: { relayUrl: signalRelayUrl } })`
|
|
274
274
|
when the application must preserve the device already held by its open store.
|
|
275
275
|
The SDK refuses missing, unreadable or changed required identity state. It never
|
|
276
276
|
falls back to registration, recovery or device linking. The default
|
package/docs/PROTOCOL_POLICY.md
CHANGED
|
@@ -32,7 +32,7 @@ the current app.
|
|
|
32
32
|
```ts
|
|
33
33
|
await createSignalProtocolClient({
|
|
34
34
|
identity: { userId },
|
|
35
|
-
adapters: { storage,
|
|
35
|
+
adapters: { storage, relay },
|
|
36
36
|
protocol: { postQuantum: 'required', braid: 'required' },
|
|
37
37
|
});
|
|
38
38
|
```
|
|
@@ -60,7 +60,7 @@ No setting allows downgrade recovery:
|
|
|
60
60
|
```ts
|
|
61
61
|
await createSignalProtocolClient({
|
|
62
62
|
identity: { userId },
|
|
63
|
-
adapters: { storage,
|
|
63
|
+
adapters: { storage, relay },
|
|
64
64
|
protocol: { postQuantum: 'required', braid: 'required' },
|
|
65
65
|
});
|
|
66
66
|
```
|
|
@@ -78,7 +78,7 @@ See [Deviations §4.1](./DEVIATIONS.md#41-the-hek-operand-order-diverges).
|
|
|
78
78
|
```ts
|
|
79
79
|
await createSignalProtocolClient({
|
|
80
80
|
identity: { userId },
|
|
81
|
-
adapters: { storage,
|
|
81
|
+
adapters: { storage, relay },
|
|
82
82
|
protocol: { postQuantum: 'required', braid: 'disabled' },
|
|
83
83
|
});
|
|
84
84
|
```
|
|
@@ -97,7 +97,7 @@ import { BraidPolicy, PostQuantumPolicy, createSignalProtocolClient } from '@ope
|
|
|
97
97
|
|
|
98
98
|
await createSignalProtocolClient({
|
|
99
99
|
identity: { userId },
|
|
100
|
-
adapters: { storage,
|
|
100
|
+
adapters: { storage, relay },
|
|
101
101
|
protocol: {
|
|
102
102
|
postQuantum: PostQuantumPolicy.Required,
|
|
103
103
|
braid: BraidPolicy.Required,
|
package/docs/RECIPES.md
CHANGED
|
@@ -269,10 +269,11 @@ import { webSqliteStore } from "@open-e2ee/signal-protocol-sdk/local/store/web-s
|
|
|
269
269
|
|
|
270
270
|
// An application-chosen name for this provider user, within the store name rules.
|
|
271
271
|
const storage = await webSqliteStore({ name: storeName });
|
|
272
|
+
const signalRelayUrl = process.env.OPEN_E2EE_SIGNAL_RELAY_URL!;
|
|
272
273
|
const signal = await createHostedSignalProtocolClient({
|
|
273
274
|
adapters: { storage },
|
|
274
275
|
hosted: {
|
|
275
|
-
|
|
276
|
+
relayUrl: signalRelayUrl,
|
|
276
277
|
getIdentityAssertion: firebaseIdentityAssertion(auth, uid),
|
|
277
278
|
},
|
|
278
279
|
});
|
|
@@ -333,7 +334,7 @@ const signal = await createHostedSignalProtocolClient({
|
|
|
333
334
|
},
|
|
334
335
|
hosted: {
|
|
335
336
|
// The environment-scoped connection URL from the OpenE2EE console.
|
|
336
|
-
|
|
337
|
+
relayUrl: process.env.EXPO_PUBLIC_OPEN_E2EE_SIGNAL_RELAY_URL ?? process.env.EXPO_PUBLIC_OPEN_E2EE_RELAY_URL!,
|
|
337
338
|
// The native app callback: https://docs.open-e2ee.dev/signal-relay/custom-token#native-apps-react-native-and-expo
|
|
338
339
|
getIdentityAssertion,
|
|
339
340
|
},
|
|
@@ -349,7 +350,7 @@ must complete the [database setup](../local/store/expo/README.md) first.
|
|
|
349
350
|
```ts
|
|
350
351
|
const signal = await createSignalProtocolClient({
|
|
351
352
|
identity: { userId },
|
|
352
|
-
adapters: { storage,
|
|
353
|
+
adapters: { storage, relay },
|
|
353
354
|
});
|
|
354
355
|
|
|
355
356
|
// Upload public prekeys before other devices need to message this device.
|
|
@@ -366,7 +367,7 @@ signal.registerHook("onMessageDecrypted", async (message) => {
|
|
|
366
367
|
});
|
|
367
368
|
|
|
368
369
|
// Subscribing starts encrypted envelope delivery and local decryption.
|
|
369
|
-
signal.
|
|
370
|
+
signal.startRelaySubscription();
|
|
370
371
|
|
|
371
372
|
await signal.send(recipientUserId, "hello");
|
|
372
373
|
```
|
|
@@ -380,7 +381,7 @@ message storage through hooks.
|
|
|
380
381
|
```ts
|
|
381
382
|
await createSignalProtocolClient({
|
|
382
383
|
identity: { userId },
|
|
383
|
-
adapters: { storage,
|
|
384
|
+
adapters: { storage, relay },
|
|
384
385
|
protocol: {
|
|
385
386
|
postQuantum: "required",
|
|
386
387
|
braid: "required",
|
|
@@ -401,7 +402,7 @@ agreement, so a peer that advertises no post-quantum material fails with
|
|
|
401
402
|
```ts
|
|
402
403
|
await createSignalProtocolClient({
|
|
403
404
|
identity: { userId },
|
|
404
|
-
adapters: { storage,
|
|
405
|
+
adapters: { storage, relay },
|
|
405
406
|
protocol: {
|
|
406
407
|
postQuantum: "required",
|
|
407
408
|
braid: "disabled",
|
|
@@ -171,7 +171,7 @@ import { expoStore } from '@open-e2ee/signal-protocol-sdk/local/store/expo';
|
|
|
171
171
|
|
|
172
172
|
const client = await createSignalProtocolClient({
|
|
173
173
|
identity: { userId },
|
|
174
|
-
adapters: { storage: await expoStore(),
|
|
174
|
+
adapters: { storage: await expoStore(), relay },
|
|
175
175
|
});
|
|
176
176
|
```
|
|
177
177
|
|
|
@@ -292,7 +292,7 @@ import { nodeStore } from '@open-e2ee/signal-protocol-sdk/local/store/node';
|
|
|
292
292
|
|
|
293
293
|
const client = await createSignalProtocolClient({
|
|
294
294
|
identity: { userId },
|
|
295
|
-
adapters: { storage: await nodeStore({ directory, vault }),
|
|
295
|
+
adapters: { storage: await nodeStore({ directory, vault }), relay },
|
|
296
296
|
});
|
|
297
297
|
```
|
|
298
298
|
|
|
@@ -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.
|