@open-e2ee/signal-protocol-sdk 13.3.0 → 13.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/CHANGELOG.md +19 -0
- package/README.md +1 -1
- package/SECURITY.md +2 -2
- package/dist/client/client.d.ts +1 -0
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +107 -70
- package/dist/client/client.js.map +1 -1
- package/dist/client/hosted-resume-error.d.ts +19 -0
- package/dist/client/hosted-resume-error.d.ts.map +1 -0
- package/dist/client/hosted-resume-error.js +44 -0
- package/dist/client/hosted-resume-error.js.map +1 -0
- package/dist/client/hosted-resume.d.ts +24 -0
- package/dist/client/hosted-resume.d.ts.map +1 -0
- package/dist/client/hosted-resume.js +82 -0
- package/dist/client/hosted-resume.js.map +1 -0
- package/dist/client/hosted-transport.d.ts.map +1 -1
- package/dist/client/hosted-transport.js +27 -3
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/hosted.d.ts.map +1 -1
- package/dist/client/hosted.js +28 -5
- package/dist/client/hosted.js.map +1 -1
- package/dist/client/index.d.ts +2 -0
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +2 -0
- package/dist/client/index.js.map +1 -1
- package/dist/client/startup-cleanup.d.ts +2 -0
- package/dist/client/startup-cleanup.d.ts.map +1 -0
- package/dist/client/startup-cleanup.js +14 -0
- package/dist/client/startup-cleanup.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/internal/manager/manager.d.ts +1 -0
- package/dist/internal/manager/manager.d.ts.map +1 -1
- package/dist/internal/manager/manager.js +17 -2
- package/dist/internal/manager/manager.js.map +1 -1
- package/dist/internal/manager/retained-identity.d.ts +2 -0
- package/dist/internal/manager/retained-identity.d.ts.map +1 -0
- package/dist/internal/manager/retained-identity.js +57 -0
- package/dist/internal/manager/retained-identity.js.map +1 -0
- package/docs/ASSURANCE.md +5 -5
- package/docs/PACKAGE_SURFACE.md +21 -0
- package/docs/RECIPES.md +3 -2
- package/package.json +1 -1
package/docs/PACKAGE_SURFACE.md
CHANGED
|
@@ -12,6 +12,7 @@ It also defines the vocabulary the rest of the documentation assumes.
|
|
|
12
12
|
## Core model
|
|
13
13
|
|
|
14
14
|
- `createHostedSignalProtocolClient()` connects to the OpenE2EE Signal Protocol Relay.
|
|
15
|
+
- `resumeHostedSignalProtocolClient()` requires existing permanent Signal identity keys, device-authentication authority and a hosted session. It never requests a provider assertion or registers a replacement.
|
|
15
16
|
- `createSignalProtocolClient()` composes an application-owned client transport.
|
|
16
17
|
- `DefaultSignalProtocolClient` is the class the factory returns. `SignalProtocolClient` is its interface.
|
|
17
18
|
- Every client requires `storage`, which owns local encryption state for one
|
|
@@ -256,3 +257,23 @@ implement the same `MediaAttachmentTransfer` seam.
|
|
|
256
257
|
- [Public types](../types/README.md)
|
|
257
258
|
- [Zero-knowledge credentials and groups](../zk/README.md)
|
|
258
259
|
- [Documentation and comment standards](./DOCUMENTATION_STANDARDS.md)
|
|
260
|
+
|
|
261
|
+
## Resume an existing hosted device
|
|
262
|
+
|
|
263
|
+
Use `resumeHostedSignalProtocolClient({ adapters: { storage }, hosted: { relayUrl } })`
|
|
264
|
+
when the application must preserve the device already held by its open store.
|
|
265
|
+
The SDK refuses missing, unreadable or changed required identity state. It never
|
|
266
|
+
falls back to registration, recovery or device linking. The default
|
|
267
|
+
`createHostedSignalProtocolClient()` behavior stays the same.
|
|
268
|
+
|
|
269
|
+
A successful resume renews and persists the authenticated device token. Normal
|
|
270
|
+
prekey maintenance and client startup, including automatic subscription when
|
|
271
|
+
the application configures receive hooks, still run. This API does not promise an unchanged
|
|
272
|
+
store or prove that the store contains every historical message/key.
|
|
273
|
+
|
|
274
|
+
The application owns the store and must not use it concurrently. A
|
|
275
|
+
`HostedRelayResumeError` with `cleanupPending` retains a client that has not
|
|
276
|
+
completed `stop()`. Keep that error and call `retryCleanup()` only when cleanup is
|
|
277
|
+
selected. This retries the held stop, never resume or registration, and never
|
|
278
|
+
closes the application store. Preserve unresolved application operation state.
|
|
279
|
+
Do not display raw error causes or key material in a public error report.
|
package/docs/RECIPES.md
CHANGED
|
@@ -56,8 +56,9 @@ other provider paths and their evidence levels. Those paths issue custom-token
|
|
|
56
56
|
assertions. They are not native provider adapters in this package.
|
|
57
57
|
|
|
58
58
|
Application logout and assertion refusal do not revoke existing device proofs.
|
|
59
|
-
|
|
60
|
-
|
|
59
|
+
To stop identified access on existing devices, follow the
|
|
60
|
+
[suspension procedure](https://docs.open-e2ee.dev/relay/backend-identity#suspend-an-identified-account).
|
|
61
|
+
Anonymous capabilities retain their separate limits.
|
|
61
62
|
|
|
62
63
|
## Production composition with Expo on the Signal Protocol Relay
|
|
63
64
|
|
package/package.json
CHANGED