@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.
Files changed (140) hide show
  1. package/ADAPTERS.md +2 -2
  2. package/ARCHITECTURE.md +1 -1
  3. package/CHANGELOG.md +160 -0
  4. package/README.md +9 -9
  5. package/SECURITY.md +2 -2
  6. package/client/README.md +6 -5
  7. package/device/README.md +2 -1
  8. package/dist/client/client.d.ts +43 -42
  9. package/dist/client/client.d.ts.map +1 -1
  10. package/dist/client/client.js +54 -53
  11. package/dist/client/client.js.map +1 -1
  12. package/dist/client/compose.d.ts +5 -5
  13. package/dist/client/compose.d.ts.map +1 -1
  14. package/dist/client/compose.js +1 -1
  15. package/dist/client/config.d.ts +16 -16
  16. package/dist/client/config.d.ts.map +1 -1
  17. package/dist/client/content-adapter.d.ts +5 -5
  18. package/dist/client/content-adapter.d.ts.map +1 -1
  19. package/dist/client/content-adapter.js +6 -6
  20. package/dist/client/content-adapter.js.map +1 -1
  21. package/dist/client/delivery-status.d.ts.map +1 -1
  22. package/dist/client/delivery-status.js +8 -7
  23. package/dist/client/delivery-status.js.map +1 -1
  24. package/dist/client/device-set-reconciliation.d.ts +1 -1
  25. package/dist/client/device-set-reconciliation.js +1 -1
  26. package/dist/client/event-hooks.d.ts +4 -9
  27. package/dist/client/event-hooks.d.ts.map +1 -1
  28. package/dist/client/event-hooks.js +12 -7
  29. package/dist/client/event-hooks.js.map +1 -1
  30. package/dist/client/hosted-anonymous-delivery.d.ts +10 -4
  31. package/dist/client/hosted-anonymous-delivery.d.ts.map +1 -1
  32. package/dist/client/hosted-anonymous-delivery.js +17 -8
  33. package/dist/client/hosted-anonymous-delivery.js.map +1 -1
  34. package/dist/client/hosted-device-link-transport.d.ts +6 -2
  35. package/dist/client/hosted-device-link-transport.d.ts.map +1 -1
  36. package/dist/client/hosted-device-link-transport.js +10 -5
  37. package/dist/client/hosted-device-link-transport.js.map +1 -1
  38. package/dist/client/hosted-group-authority.d.ts +4 -2
  39. package/dist/client/hosted-group-authority.d.ts.map +1 -1
  40. package/dist/client/hosted-group-authority.js +10 -7
  41. package/dist/client/hosted-group-authority.js.map +1 -1
  42. package/dist/client/hosted-groups.d.ts +8 -3
  43. package/dist/client/hosted-groups.d.ts.map +1 -1
  44. package/dist/client/hosted-groups.js +15 -9
  45. package/dist/client/hosted-groups.js.map +1 -1
  46. package/dist/client/hosted-http-error.d.ts +1 -1
  47. package/dist/client/hosted-http-error.js +1 -1
  48. package/dist/client/hosted-mailbox-subscription.d.ts +6 -2
  49. package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -1
  50. package/dist/client/hosted-mailbox-subscription.js +20 -8
  51. package/dist/client/hosted-mailbox-subscription.js.map +1 -1
  52. package/dist/client/hosted-sandbox-identity.d.ts +25 -21
  53. package/dist/client/hosted-sandbox-identity.d.ts.map +1 -1
  54. package/dist/client/hosted-sandbox-identity.js +25 -21
  55. package/dist/client/hosted-sandbox-identity.js.map +1 -1
  56. package/dist/client/hosted-store-records.d.ts +22 -17
  57. package/dist/client/hosted-store-records.d.ts.map +1 -1
  58. package/dist/client/hosted-store-records.js +15 -10
  59. package/dist/client/hosted-store-records.js.map +1 -1
  60. package/dist/client/hosted-transport.d.ts +14 -10
  61. package/dist/client/hosted-transport.d.ts.map +1 -1
  62. package/dist/client/hosted-transport.js +134 -89
  63. package/dist/client/hosted-transport.js.map +1 -1
  64. package/dist/client/hosted.d.ts +32 -21
  65. package/dist/client/hosted.d.ts.map +1 -1
  66. package/dist/client/hosted.js +7 -7
  67. package/dist/client/hosted.js.map +1 -1
  68. package/dist/client/receive-work-seed.d.ts +4 -4
  69. package/dist/client/receive-work-seed.d.ts.map +1 -1
  70. package/dist/client/receive-work-seed.js +1 -1
  71. package/dist/client/receive-work-seed.js.map +1 -1
  72. package/dist/client/send-deadline.d.ts +1 -1
  73. package/dist/client/send-deadline.d.ts.map +1 -1
  74. package/dist/client/send-deadline.js +4 -3
  75. package/dist/client/send-deadline.js.map +1 -1
  76. package/dist/client/signal-relay-lifecycle.d.ts +3 -4
  77. package/dist/client/signal-relay-lifecycle.d.ts.map +1 -1
  78. package/dist/client/signal-relay-lifecycle.js +3 -4
  79. package/dist/client/signal-relay-lifecycle.js.map +1 -1
  80. package/dist/client/signal-relay-protocol.d.ts +83 -18
  81. package/dist/client/signal-relay-protocol.d.ts.map +1 -1
  82. package/dist/client/signal-relay-protocol.js +186 -15
  83. package/dist/client/signal-relay-protocol.js.map +1 -1
  84. package/dist/client/signal-relay-subscription.d.ts +1 -1
  85. package/dist/client/signal-relay-subscription.js +1 -1
  86. package/dist/client/signal-relay-subscription.js.map +1 -1
  87. package/dist/client/signal-service-cipher.d.ts +3 -3
  88. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  89. package/dist/client/signal-service-cipher.js +5 -5
  90. package/dist/client/signal-service-cipher.js.map +1 -1
  91. package/dist/client/types.d.ts +4 -4
  92. package/dist/client/types.d.ts.map +1 -1
  93. package/dist/hooks/use-signal-relay-connection-state.d.ts +2 -3
  94. package/dist/hooks/use-signal-relay-connection-state.d.ts.map +1 -1
  95. package/dist/hooks/use-signal-relay-connection-state.js.map +1 -1
  96. package/dist/index.d.ts +5 -4
  97. package/dist/index.d.ts.map +1 -1
  98. package/dist/index.js +2 -1
  99. package/dist/index.js.map +1 -1
  100. package/dist/internal/groups/authority-certificate.d.ts +4 -3
  101. package/dist/internal/groups/authority-certificate.d.ts.map +1 -1
  102. package/dist/internal/groups/authority-certificate.js.map +1 -1
  103. package/dist/local/store/receive-work.d.ts +5 -5
  104. package/dist/local/store/receive-work.d.ts.map +1 -1
  105. package/dist/local/store/receive-work.js +10 -12
  106. package/dist/local/store/receive-work.js.map +1 -1
  107. package/dist/local/store/reliability.d.ts +7 -4
  108. package/dist/local/store/reliability.d.ts.map +1 -1
  109. package/dist/local/store/reliability.js.map +1 -1
  110. package/dist/remote/signal-relay/types.d.ts +12 -11
  111. package/dist/remote/signal-relay/types.d.ts.map +1 -1
  112. package/dist/types/api.d.ts +27 -24
  113. package/dist/types/api.d.ts.map +1 -1
  114. package/dist/types/errors.d.ts +19 -12
  115. package/dist/types/errors.d.ts.map +1 -1
  116. package/dist/types/errors.js +20 -13
  117. package/dist/types/errors.js.map +1 -1
  118. package/dist/types/renamed-member.d.ts +13 -6
  119. package/dist/types/renamed-member.d.ts.map +1 -1
  120. package/dist/types/renamed-member.js +11 -6
  121. package/dist/types/renamed-member.js.map +1 -1
  122. package/docs/ASSURANCE.md +9 -9
  123. package/docs/CLIENT_COMPOSITION.md +4 -4
  124. package/docs/DEVIATIONS.md +2 -2
  125. package/docs/ERROR_HANDLING.md +3 -3
  126. package/docs/GETTING_STARTED.md +4 -3
  127. package/docs/INTERFACES.md +3 -3
  128. package/docs/PACKAGE_SURFACE.md +1 -1
  129. package/docs/PROTOCOL_POLICY.md +4 -4
  130. package/docs/RECIPES.md +7 -6
  131. package/local/store/expo/README.md +1 -1
  132. package/local/store/key-value/README.md +1 -1
  133. package/local/store/node/README.md +1 -1
  134. package/local/store/react-native/README.md +1 -1
  135. package/local/store/web/README.md +1 -1
  136. package/local/store/web-sqlite/README.md +1 -1
  137. package/package.json +1 -1
  138. package/remote/README.md +2 -2
  139. package/remote/object-store/convex-r2/README.md +1 -1
  140. package/remote/signal-relay/README.md +3 -2
@@ -40,7 +40,7 @@ const storage: SignalProtocolLocalStore = appProtocolStore;
40
40
 
41
41
  const client = await createSignalProtocolClient({
42
42
  identity: { userId },
43
- adapters: { storage, signalProtocolRelay },
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 signalProtocolRelay: SignalProtocolRelayServer = appSignalProtocolRelayTransport;
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, signalProtocolRelay, remoteObjectStore },
178
+ adapters: { storage, relay, remoteObjectStore },
179
179
  media: {
180
180
  preparedUploads: appPreparedUploads,
181
181
  maxPreparedUploadBytes: appUploadBudgetBytes,
@@ -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: { signalProtocolRelayUrl } })`
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
@@ -32,7 +32,7 @@ the current app.
32
32
  ```ts
33
33
  await createSignalProtocolClient({
34
34
  identity: { userId },
35
- adapters: { storage, signalProtocolRelay },
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, signalProtocolRelay },
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, signalProtocolRelay },
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, signalProtocolRelay },
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
- signalProtocolRelayUrl,
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
- signalProtocolRelayUrl: process.env.EXPO_PUBLIC_OPEN_E2EE_SIGNAL_RELAY_URL ?? process.env.EXPO_PUBLIC_OPEN_E2EE_RELAY_URL!,
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, signalProtocolRelay },
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.startSignalProtocolRelaySubscription();
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, signalProtocolRelay },
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, signalProtocolRelay },
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(), signalProtocolRelay },
174
+ adapters: { storage: await expoStore(), relay },
175
175
  });
176
176
  ```
177
177
 
@@ -47,7 +47,7 @@ const storage = await keyValueStore({ storage: keyValueStorage, vault });
47
47
 
48
48
  const client = await createSignalProtocolClient({
49
49
  identity: { userId },
50
- adapters: { storage, signalProtocolRelay },
50
+ adapters: { storage, relay },
51
51
  });
52
52
  ```
53
53
 
@@ -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 }), signalProtocolRelay },
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(), signalProtocolRelay },
192
+ adapters: { storage: await reactNativeStore(), relay },
193
193
  });
194
194
  ```
195
195
 
@@ -29,7 +29,7 @@ const storage = await indexedDbStore();
29
29
 
30
30
  const client = await createSignalProtocolClient({
31
31
  identity: { userId },
32
- adapters: { storage, signalProtocolRelay },
32
+ adapters: { storage, relay },
33
33
  });
34
34
  ```
35
35
 
@@ -28,7 +28,7 @@ const storage = await webSqliteStore();
28
28
 
29
29
  const client = await createSignalProtocolClient({
30
30
  identity: { userId },
31
- adapters: { storage, signalProtocolRelay },
31
+ adapters: { storage, relay },
32
32
  });
33
33
  ```
34
34
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@open-e2ee/signal-protocol-sdk",
3
- "version": "14.2.0",
3
+ "version": "14.4.0",
4
4
  "description": "Pure TypeScript Signal Protocol SDK for encrypted chat in Expo, React Native, browsers, and Node. Post-quantum by default.",
5
5
  "keywords": [
6
6
  "open-e2ee",
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
- signalProtocolRelayUrl: process.env.EXPO_PUBLIC_OPEN_E2EE_SIGNAL_RELAY_URL ?? process.env.EXPO_PUBLIC_OPEN_E2EE_RELAY_URL!,
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
- signalProtocolRelay,
104
+ relay,
105
105
  remoteObjectStore: convexR2ObjectStore({
106
106
  convex,
107
107
  api: api.signalObjectStore,
@@ -29,7 +29,7 @@ const client = await createSignalProtocolClient({
29
29
  identity: { userId },
30
30
  adapters: {
31
31
  storage,
32
- signalProtocolRelay,
32
+ relay,
33
33
  remoteObjectStore: convexR2ObjectStore({
34
34
  convex,
35
35
  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
- signalProtocolRelayUrl,
26
+ relayUrl: signalRelayUrl,
26
27
  getIdentityAssertion,
27
28
  },
28
29
  });
29
30
  ```
30
31
 
31
- `oe new` writes `signalProtocolRelayUrl` to `.env.local` as `OPEN_E2EE_SIGNAL_RELAY_URL`,
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.