@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.
Files changed (93) hide show
  1. package/ADAPTERS.md +2 -2
  2. package/ARCHITECTURE.md +1 -1
  3. package/CHANGELOG.md +90 -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/device-set-reconciliation.d.ts +1 -1
  22. package/dist/client/device-set-reconciliation.js +1 -1
  23. package/dist/client/event-hooks.d.ts +4 -9
  24. package/dist/client/event-hooks.d.ts.map +1 -1
  25. package/dist/client/event-hooks.js +12 -7
  26. package/dist/client/event-hooks.js.map +1 -1
  27. package/dist/client/hosted-http-error.d.ts +1 -1
  28. package/dist/client/hosted-http-error.js +1 -1
  29. package/dist/client/hosted-sandbox-identity.d.ts +2 -2
  30. package/dist/client/hosted-sandbox-identity.js +2 -2
  31. package/dist/client/hosted-transport.d.ts +4 -4
  32. package/dist/client/hosted-transport.d.ts.map +1 -1
  33. package/dist/client/hosted-transport.js +2 -2
  34. package/dist/client/hosted-transport.js.map +1 -1
  35. package/dist/client/hosted.d.ts +17 -17
  36. package/dist/client/hosted.d.ts.map +1 -1
  37. package/dist/client/hosted.js +1 -1
  38. package/dist/client/send-deadline.d.ts +1 -1
  39. package/dist/client/send-deadline.d.ts.map +1 -1
  40. package/dist/client/send-deadline.js +4 -3
  41. package/dist/client/send-deadline.js.map +1 -1
  42. package/dist/client/signal-relay-lifecycle.d.ts +3 -4
  43. package/dist/client/signal-relay-lifecycle.d.ts.map +1 -1
  44. package/dist/client/signal-relay-lifecycle.js +3 -4
  45. package/dist/client/signal-relay-lifecycle.js.map +1 -1
  46. package/dist/client/signal-relay-subscription.d.ts +1 -1
  47. package/dist/client/signal-service-cipher.d.ts +3 -3
  48. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  49. package/dist/client/signal-service-cipher.js +5 -5
  50. package/dist/client/signal-service-cipher.js.map +1 -1
  51. package/dist/client/types.d.ts +4 -4
  52. package/dist/client/types.d.ts.map +1 -1
  53. package/dist/hooks/use-signal-relay-connection-state.d.ts +2 -3
  54. package/dist/hooks/use-signal-relay-connection-state.d.ts.map +1 -1
  55. package/dist/hooks/use-signal-relay-connection-state.js.map +1 -1
  56. package/dist/index.d.ts +5 -4
  57. package/dist/index.d.ts.map +1 -1
  58. package/dist/index.js +2 -1
  59. package/dist/index.js.map +1 -1
  60. package/dist/internal/groups/authority-certificate.d.ts +4 -3
  61. package/dist/internal/groups/authority-certificate.d.ts.map +1 -1
  62. package/dist/internal/groups/authority-certificate.js.map +1 -1
  63. package/dist/remote/signal-relay/types.d.ts +12 -11
  64. package/dist/remote/signal-relay/types.d.ts.map +1 -1
  65. package/dist/types/api.d.ts +15 -15
  66. package/dist/types/api.d.ts.map +1 -1
  67. package/dist/types/errors.d.ts +19 -12
  68. package/dist/types/errors.d.ts.map +1 -1
  69. package/dist/types/errors.js +20 -13
  70. package/dist/types/errors.js.map +1 -1
  71. package/dist/types/renamed-member.d.ts +13 -6
  72. package/dist/types/renamed-member.d.ts.map +1 -1
  73. package/dist/types/renamed-member.js +11 -6
  74. package/dist/types/renamed-member.js.map +1 -1
  75. package/docs/ASSURANCE.md +9 -9
  76. package/docs/CLIENT_COMPOSITION.md +4 -4
  77. package/docs/DEVIATIONS.md +2 -2
  78. package/docs/ERROR_HANDLING.md +3 -3
  79. package/docs/GETTING_STARTED.md +4 -3
  80. package/docs/INTERFACES.md +3 -3
  81. package/docs/PACKAGE_SURFACE.md +1 -1
  82. package/docs/PROTOCOL_POLICY.md +4 -4
  83. package/docs/RECIPES.md +7 -6
  84. package/local/store/expo/README.md +1 -1
  85. package/local/store/key-value/README.md +1 -1
  86. package/local/store/node/README.md +1 -1
  87. package/local/store/react-native/README.md +1 -1
  88. package/local/store/web/README.md +1 -1
  89. package/local/store/web-sqlite/README.md +1 -1
  90. package/package.json +1 -1
  91. package/remote/README.md +2 -2
  92. package/remote/object-store/convex-r2/README.md +1 -1
  93. 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(), 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.3.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.