@open-e2ee/signal-protocol-sdk 10.1.0 → 11.0.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 +98 -0
- package/README.md +1 -1
- package/SECURITY.md +2 -2
- package/client/README.md +14 -0
- package/dist/client/client.d.ts +9 -0
- package/dist/client/client.d.ts.map +1 -1
- package/dist/client/client.js +32 -0
- package/dist/client/client.js.map +1 -1
- package/dist/client/event-hooks.d.ts +36 -0
- package/dist/client/event-hooks.d.ts.map +1 -1
- package/dist/client/event-hooks.js +1 -0
- package/dist/client/event-hooks.js.map +1 -1
- package/dist/client/hosted-device-standing.d.ts +52 -0
- package/dist/client/hosted-device-standing.d.ts.map +1 -0
- package/dist/client/hosted-device-standing.js +74 -0
- package/dist/client/hosted-device-standing.js.map +1 -0
- package/dist/client/hosted-mailbox-subscription.d.ts +14 -1
- package/dist/client/hosted-mailbox-subscription.d.ts.map +1 -1
- package/dist/client/hosted-mailbox-subscription.js +201 -57
- package/dist/client/hosted-mailbox-subscription.js.map +1 -1
- package/dist/client/hosted-transport.d.ts.map +1 -1
- package/dist/client/hosted-transport.js +52 -14
- package/dist/client/hosted-transport.js.map +1 -1
- package/dist/client/hosted.d.ts +12 -1
- package/dist/client/hosted.d.ts.map +1 -1
- package/dist/client/hosted.js +112 -41
- package/dist/client/hosted.js.map +1 -1
- package/dist/client/index.d.ts +2 -2
- package/dist/client/index.d.ts.map +1 -1
- package/dist/client/index.js +1 -1
- package/dist/client/index.js.map +1 -1
- package/dist/client/messages.d.ts.map +1 -1
- package/dist/client/messages.js +10 -0
- package/dist/client/messages.js.map +1 -1
- package/dist/client/one-time-prekey-refill.d.ts +7 -0
- package/dist/client/one-time-prekey-refill.d.ts.map +1 -1
- package/dist/client/one-time-prekey-refill.js +5 -1
- package/dist/client/one-time-prekey-refill.js.map +1 -1
- package/dist/client/relay-acceptance.d.ts +17 -0
- package/dist/client/relay-acceptance.d.ts.map +1 -1
- package/dist/client/relay-acceptance.js +37 -0
- package/dist/client/relay-acceptance.js.map +1 -1
- package/dist/client/relay-subscription.d.ts.map +1 -1
- package/dist/client/relay-subscription.js +30 -30
- package/dist/client/relay-subscription.js.map +1 -1
- package/dist/client/retry-family.d.ts +11 -9
- package/dist/client/retry-family.d.ts.map +1 -1
- package/dist/client/retry-family.js +5 -5
- package/dist/client/retry-family.js.map +1 -1
- package/dist/client/retry-request-envelope.d.ts +40 -12
- package/dist/client/retry-request-envelope.d.ts.map +1 -1
- package/dist/client/retry-request-envelope.js +142 -54
- package/dist/client/retry-request-envelope.js.map +1 -1
- package/dist/client/retry-request-lifecycle.d.ts +101 -0
- package/dist/client/retry-request-lifecycle.d.ts.map +1 -0
- package/dist/client/retry-request-lifecycle.js +307 -0
- package/dist/client/retry-request-lifecycle.js.map +1 -0
- package/dist/client/retry.d.ts +6 -6
- package/dist/client/retry.d.ts.map +1 -1
- package/dist/client/retry.js +83 -38
- package/dist/client/retry.js.map +1 -1
- package/dist/client/signal-service-cipher.d.ts.map +1 -1
- package/dist/client/signal-service-cipher.js +5 -1
- package/dist/client/signal-service-cipher.js.map +1 -1
- package/dist/client/types.d.ts.map +1 -1
- package/dist/client/types.js.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/local/store/reliability.d.ts +106 -8
- package/dist/local/store/reliability.d.ts.map +1 -1
- package/dist/local/store/reliability.js +165 -16
- package/dist/local/store/reliability.js.map +1 -1
- package/dist/remote/relay/types.d.ts +12 -3
- package/dist/remote/relay/types.d.ts.map +1 -1
- package/dist/utils/retry.d.ts +2 -0
- package/dist/utils/retry.d.ts.map +1 -1
- package/dist/utils/retry.js +7 -0
- package/dist/utils/retry.js.map +1 -1
- package/docs/ASSURANCE.md +5 -5
- package/docs/ERROR_HANDLING.md +70 -0
- package/package.json +1 -1
|
@@ -35,6 +35,8 @@
|
|
|
35
35
|
* });
|
|
36
36
|
* ```
|
|
37
37
|
*/
|
|
38
|
+
import type { RetryTerminalClass } from '../local/store/reliability.js';
|
|
39
|
+
export type { RetryTerminalClass };
|
|
38
40
|
/**
|
|
39
41
|
* Decrypted envelope passed to onMessageDecrypted hook
|
|
40
42
|
*
|
|
@@ -72,6 +74,19 @@ export interface DeliveredEvent {
|
|
|
72
74
|
/** The group ID, for a group message. */
|
|
73
75
|
groupId?: string;
|
|
74
76
|
}
|
|
77
|
+
/**
|
|
78
|
+
* The end of a retry request with no resend. The device that asked for the
|
|
79
|
+
* resend gets it for each class except `missing-prekey`. The device that
|
|
80
|
+
* sent the failed message gets `missing-prekey`, when it cannot start a new
|
|
81
|
+
* session with the requester. Each request ends once, and the hook runs once
|
|
82
|
+
* for it.
|
|
83
|
+
*/
|
|
84
|
+
export interface RetryTerminalEvent {
|
|
85
|
+
/** Why the request ended. */
|
|
86
|
+
class: RetryTerminalClass;
|
|
87
|
+
/** The Relay message ID of the envelope that the requester failed to decrypt. */
|
|
88
|
+
failedEnvelopeId: string;
|
|
89
|
+
}
|
|
75
90
|
export interface DecryptedEnvelope {
|
|
76
91
|
/** Unique message ID (from server or generated) */
|
|
77
92
|
messageId: string;
|
|
@@ -301,6 +316,27 @@ export interface SignalProtocolClientHooks {
|
|
|
301
316
|
* ```
|
|
302
317
|
*/
|
|
303
318
|
onDelivered?: (event: DeliveredEvent) => void | Promise<void>;
|
|
319
|
+
/**
|
|
320
|
+
* Runs when a retry request ends with no resend
|
|
321
|
+
*
|
|
322
|
+
* A failed decrypt asks the sender device for a resend. The request ends
|
|
323
|
+
* when the Relay gives a conclusive answer to its post, when it gets no
|
|
324
|
+
* answer within 24 hours, when the sender used up its retry allowance, or
|
|
325
|
+
* when the sender device has no prekey bundle of the requester. The
|
|
326
|
+
* content of the failed envelope is then lost. The hook runs once for
|
|
327
|
+
* each request. A client stop during the hook can make it run again after
|
|
328
|
+
* the next start.
|
|
329
|
+
*
|
|
330
|
+
* @param event - The class of the end and the failed envelope
|
|
331
|
+
*
|
|
332
|
+
* @example
|
|
333
|
+
* ```typescript
|
|
334
|
+
* onRetryTerminal: async (event) => {
|
|
335
|
+
* await messageStore.markUndecryptable(event.failedEnvelopeId, event.class);
|
|
336
|
+
* }
|
|
337
|
+
* ```
|
|
338
|
+
*/
|
|
339
|
+
onRetryTerminal?: (event: RetryTerminalEvent) => void | Promise<void>;
|
|
304
340
|
/**
|
|
305
341
|
* Runs when the client receives a read receipt
|
|
306
342
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"event-hooks.d.ts","sourceRoot":"","sources":["../../client/event-hooks.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;
|
|
1
|
+
{"version":3,"file":"event-hooks.d.ts","sourceRoot":"","sources":["../../client/event-hooks.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AACrE,YAAY,EAAE,kBAAkB,EAAE,CAAC;AAGnC;;;;;GAKG;AACH,OAAO,EAAE,CAAC;AAEV;;;;;;;GAOG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,MAAM,CAAC;AAE9C,oEAAoE;AACpE,MAAM,WAAW,cAAc;IAC7B,yCAAyC;IACzC,eAAe,EAAE,MAAM,CAAC;IACxB,iEAAiE;IACjE,WAAW,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,0CAA0C;IAC1C,MAAM,EAAE,cAAc,CAAC;IACvB,mEAAmE;IACnE,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,+EAA+E;IAC/E,mBAAmB,EAAE,OAAO,CAAC;IAC7B,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACxC,eAAe,EAAE,MAAM,CAAC;IACxB,yCAAyC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC,6BAA6B;IAC7B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,iFAAiF;IACjF,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,iBAAiB;IAChC,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,SAAS,EAAE,MAAM,CAAC;IAClB,uBAAuB;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,yBAAyB;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,gEAAgE;IAChE,cAAc,EAAE,MAAM,CAAC;IACvB,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB,yFAAyF;IACzF,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;;;;;;;;;;;;OAeG;IACH,oBAAoB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1F;;;;;;;;;;;;;;OAcG;IACH,gBAAgB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D;;;;;;;;;;;;;;;OAeG;IACH,iBAAiB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhE;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,EAAE,CAAC,OAAO,EAAE,gBAAgB,GAAG,qBAAqB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3F;;;;;;;;;;;;;;;;;OAiBG;IACH,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElF;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAAE,iBAAiB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3E;;;;;;;;;;;;;;;;;;;OAmBG;IACH,iBAAiB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9E;;;;;;;;;;;;;;;;;;;OAmBG;IACH,iBAAiB,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9E;;;;;;;;;;;;;;;OAeG;IACH,eAAe,CAAC,EAAE,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,WAAW,CAAC,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9D;;;;;;;;;;;;;;;;;;;OAmBG;IACH,eAAe,CAAC,EAAE,CAAC,KAAK,EAAE,kBAAkB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtE;;;;;;;;;;;;;;;;;OAiBG;IACH,qBAAqB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzF;;;;;;;;;;;;;;;;;OAiBG;IACH,uBAAuB,CAAC,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3F;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,yBAAyB,CAAC,EAAE,CAC1B,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,OAAO,SAAS,EAAE,YAAY,KACnC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,yBAAyB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"event-hooks.js","sourceRoot":"","sources":["../../client/event-hooks.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;
|
|
1
|
+
{"version":3,"file":"event-hooks.js","sourceRoot":"","sources":["../../client/event-hooks.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAIH,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAuYvD,MAAM,UAAU,GAAG;IACjB,oBAAoB,EAAE,IAAI;IAC1B,gBAAgB,EAAE,IAAI;IACtB,iBAAiB,EAAE,IAAI;IACvB,YAAY,EAAE,IAAI;IAClB,kBAAkB,EAAE,IAAI;IACxB,kBAAkB,EAAE,IAAI;IACxB,iBAAiB,EAAE,IAAI;IACvB,iBAAiB,EAAE,IAAI;IACvB,eAAe,EAAE,IAAI;IACrB,WAAW,EAAE,IAAI;IACjB,eAAe,EAAE,IAAI;IACrB,qBAAqB,EAAE,IAAI;IAC3B,uBAAuB,EAAE,IAAI;IAC7B,yBAAyB,EAAE,IAAI;CACU,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,IAAY;IACzC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CAAC;QAC5D,MAAM,IAAI,KAAK,CAAC,wCAAwC,IAAI,EAAE,CAAC,CAAC;IAClE,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,KAA4C,EAC5C,QAAW,EACX,GAAG,IAA2D;IAE9D,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC/B,OAAO;IACT,CAAC;IAED,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAA8C,CAAC;QAC1E,MAAM,OAAO,CAAC,OAAO,CACnB,OAAO,CAAC,KAAK,CAAC,IAA2C,EAAE,SAAS,EAAE,IAAiB,CAAC,CACzF,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,uBAAuB,CAAC,KAAK,CAAC,CAAC;QAC/B,4DAA4D;QAC5D,OAAO,CAAC,KAAK,CAAC,QAAQ,QAAQ,UAAU,EAAE,KAAK,CAAC,CAAC;IACnD,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,KAA4C;IAIrE,MAAM,MAAM,GAAiC,EAAE,CAAC;IAChD,MAAM,QAAQ,GAAiD,EAAE,CAAC;IAClE,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;QACvD,IAAI,OAAO,IAAI,KAAK,UAAU;YAAE,SAAS;QACzC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,EAAE;YAC3B,MAAM,CAAC,IAAI,CAAC,CAAC,IAAgB,EAAE,IAAI,CAAC,CAAC,CAAC;QACxC,CAAC,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,QAIK,CAAC;IACnB,OAAO;QACL,KAAK,EAAE,QAAqC;QAC5C,KAAK,CAAC,KAAK;YACT,KAAK,IAAI,IAAI,GAAG,MAAM,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,GAAG,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;gBAC5D,MAAM,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACzC,CAAC;QACH,CAAC;KACF,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The standing of this device at the Relay.
|
|
3
|
+
*
|
|
4
|
+
* A device that the Relay no longer lists cannot get a device token. Two
|
|
5
|
+
* refusals name that state, and both are terminal for the stored session:
|
|
6
|
+
*
|
|
7
|
+
* - `HostedRelayDeviceUnknownError`: the Relay has no device for the stored
|
|
8
|
+
* session. The device token request answered `NOT_FOUND`.
|
|
9
|
+
* - `HostedRelayDeviceRevokedError`: an account recovery revoked this device.
|
|
10
|
+
* Any identity route can answer `DEVICE_REVOKED`.
|
|
11
|
+
*
|
|
12
|
+
* The SDK never retries either request and never registers again on its own.
|
|
13
|
+
* Only the application can decide to register the device again, with the
|
|
14
|
+
* `reregister` assertion purpose.
|
|
15
|
+
*/
|
|
16
|
+
/**
|
|
17
|
+
* The Relay has no device for the stored session, so the session cannot get
|
|
18
|
+
* a device token. The message is the Relay's own message. It also names the
|
|
19
|
+
* case where the account itself does not exist.
|
|
20
|
+
*
|
|
21
|
+
* The SDK does not retry the request and does not register again. To keep
|
|
22
|
+
* this device, call `createHostedSignalProtocolClient` with the
|
|
23
|
+
* `assertionPurpose` `reregister` after the user confirms it.
|
|
24
|
+
*/
|
|
25
|
+
export declare class HostedRelayDeviceUnknownError extends Error {
|
|
26
|
+
readonly code = "NOT_FOUND";
|
|
27
|
+
/** The HTTP status of the refusal, 404 from a current Relay. */
|
|
28
|
+
readonly status: number;
|
|
29
|
+
/** Always false: the same request fails again. */
|
|
30
|
+
readonly retryable = false;
|
|
31
|
+
constructor(status: number, message: string);
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* An account recovery revoked this device. The Relay refuses its key on the
|
|
35
|
+
* device token request and on a registration, so both fail the same way. The
|
|
36
|
+
* SDK does not retry the request.
|
|
37
|
+
*/
|
|
38
|
+
export declare class HostedRelayDeviceRevokedError extends Error {
|
|
39
|
+
readonly code = "DEVICE_REVOKED";
|
|
40
|
+
/** The HTTP status of the refusal, 403 from a current Relay. */
|
|
41
|
+
readonly status: number;
|
|
42
|
+
/** Always false: the Relay refuses these keys for good. */
|
|
43
|
+
readonly retryable = false;
|
|
44
|
+
constructor(status: number, message?: string);
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Throws `HostedRelayDeviceRevokedError` when a Relay error body has the code
|
|
48
|
+
* `DEVICE_REVOKED`, at any error status. The body code is the contract, not
|
|
49
|
+
* the status.
|
|
50
|
+
*/
|
|
51
|
+
export declare function throwIfDeviceRevoked(status: number, body: unknown): void;
|
|
52
|
+
//# sourceMappingURL=hosted-device-standing.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"hosted-device-standing.d.ts","sourceRoot":"","sources":["../../client/hosted-device-standing.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAIH;;;;;;;;GAQG;AACH,qBAAa,6BAA8B,SAAQ,KAAK;IACtD,SAAgB,IAAI,eAAe;IACnC,gEAAgE;IAChE,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,kDAAkD;IAClD,SAAgB,SAAS,SAAS;IAElC,YAAmB,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAIjD;CACF;AAED;;;;GAIG;AACH,qBAAa,6BAA8B,SAAQ,KAAK;IACtD,SAAgB,IAAI,oBAAoB;IACxC,gEAAgE;IAChE,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,2DAA2D;IAC3D,SAAgB,SAAS,SAAS;IAElC,YAAmB,MAAM,EAAE,MAAM,EAAE,OAAO,SAAyB,EAIlE;CACF;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,IAAI,CAgBxE"}
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The standing of this device at the Relay.
|
|
3
|
+
*
|
|
4
|
+
* A device that the Relay no longer lists cannot get a device token. Two
|
|
5
|
+
* refusals name that state, and both are terminal for the stored session:
|
|
6
|
+
*
|
|
7
|
+
* - `HostedRelayDeviceUnknownError`: the Relay has no device for the stored
|
|
8
|
+
* session. The device token request answered `NOT_FOUND`.
|
|
9
|
+
* - `HostedRelayDeviceRevokedError`: an account recovery revoked this device.
|
|
10
|
+
* Any identity route can answer `DEVICE_REVOKED`.
|
|
11
|
+
*
|
|
12
|
+
* The SDK never retries either request and never registers again on its own.
|
|
13
|
+
* Only the application can decide to register the device again, with the
|
|
14
|
+
* `reregister` assertion purpose.
|
|
15
|
+
*/
|
|
16
|
+
const DEVICE_REVOKED_MESSAGE = "The device was revoked by an account recovery.";
|
|
17
|
+
/**
|
|
18
|
+
* The Relay has no device for the stored session, so the session cannot get
|
|
19
|
+
* a device token. The message is the Relay's own message. It also names the
|
|
20
|
+
* case where the account itself does not exist.
|
|
21
|
+
*
|
|
22
|
+
* The SDK does not retry the request and does not register again. To keep
|
|
23
|
+
* this device, call `createHostedSignalProtocolClient` with the
|
|
24
|
+
* `assertionPurpose` `reregister` after the user confirms it.
|
|
25
|
+
*/
|
|
26
|
+
export class HostedRelayDeviceUnknownError extends Error {
|
|
27
|
+
code = "NOT_FOUND";
|
|
28
|
+
/** The HTTP status of the refusal, 404 from a current Relay. */
|
|
29
|
+
status;
|
|
30
|
+
/** Always false: the same request fails again. */
|
|
31
|
+
retryable = false;
|
|
32
|
+
constructor(status, message) {
|
|
33
|
+
super(message);
|
|
34
|
+
this.name = "HostedRelayDeviceUnknownError";
|
|
35
|
+
this.status = status;
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* An account recovery revoked this device. The Relay refuses its key on the
|
|
40
|
+
* device token request and on a registration, so both fail the same way. The
|
|
41
|
+
* SDK does not retry the request.
|
|
42
|
+
*/
|
|
43
|
+
export class HostedRelayDeviceRevokedError extends Error {
|
|
44
|
+
code = "DEVICE_REVOKED";
|
|
45
|
+
/** The HTTP status of the refusal, 403 from a current Relay. */
|
|
46
|
+
status;
|
|
47
|
+
/** Always false: the Relay refuses these keys for good. */
|
|
48
|
+
retryable = false;
|
|
49
|
+
constructor(status, message = DEVICE_REVOKED_MESSAGE) {
|
|
50
|
+
super(message);
|
|
51
|
+
this.name = "HostedRelayDeviceRevokedError";
|
|
52
|
+
this.status = status;
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
/**
|
|
56
|
+
* Throws `HostedRelayDeviceRevokedError` when a Relay error body has the code
|
|
57
|
+
* `DEVICE_REVOKED`, at any error status. The body code is the contract, not
|
|
58
|
+
* the status.
|
|
59
|
+
*/
|
|
60
|
+
export function throwIfDeviceRevoked(status, body) {
|
|
61
|
+
if (typeof body !== "object" ||
|
|
62
|
+
body === null ||
|
|
63
|
+
!("error" in body) ||
|
|
64
|
+
typeof body.error !== "object" ||
|
|
65
|
+
body.error === null ||
|
|
66
|
+
!("code" in body.error) ||
|
|
67
|
+
body.error.code !== "DEVICE_REVOKED")
|
|
68
|
+
return;
|
|
69
|
+
const message = "message" in body.error && typeof body.error.message === "string"
|
|
70
|
+
? body.error.message
|
|
71
|
+
: undefined;
|
|
72
|
+
throw new HostedRelayDeviceRevokedError(status, message);
|
|
73
|
+
}
|
|
74
|
+
//# sourceMappingURL=hosted-device-standing.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"hosted-device-standing.js","sourceRoot":"","sources":["../../client/hosted-device-standing.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,MAAM,sBAAsB,GAAG,gDAAgD,CAAC;AAEhF;;;;;;;;GAQG;AACH,MAAM,OAAO,6BAA8B,SAAQ,KAAK;IACtC,IAAI,GAAG,WAAW,CAAC;IACnC,gEAAgE;IAChD,MAAM,CAAS;IAC/B,kDAAkD;IAClC,SAAS,GAAG,KAAK,CAAC;IAElC,YAAmB,MAAc,EAAE,OAAe;QAChD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,+BAA+B,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,OAAO,6BAA8B,SAAQ,KAAK;IACtC,IAAI,GAAG,gBAAgB,CAAC;IACxC,gEAAgE;IAChD,MAAM,CAAS;IAC/B,2DAA2D;IAC3C,SAAS,GAAG,KAAK,CAAC;IAElC,YAAmB,MAAc,EAAE,OAAO,GAAG,sBAAsB;QACjE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,+BAA+B,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAc,EAAE,IAAa;IAChE,IACE,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,CAAC,CAAC,OAAO,IAAI,IAAI,CAAC;QAClB,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ;QAC9B,IAAI,CAAC,KAAK,KAAK,IAAI;QACnB,CAAC,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,CAAC;QACvB,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,gBAAgB;QAEpC,OAAO;IACT,MAAM,OAAO,GACX,SAAS,IAAI,IAAI,CAAC,KAAK,IAAI,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,KAAK,QAAQ;QAC/D,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO;QACpB,CAAC,CAAC,SAAS,CAAC;IAChB,MAAM,IAAI,6BAA6B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC3D,CAAC"}
|
|
@@ -26,11 +26,22 @@ export interface MailboxAcknowledgment {
|
|
|
26
26
|
readonly receipted: readonly string[];
|
|
27
27
|
}
|
|
28
28
|
interface MailboxSubscription {
|
|
29
|
+
/**
|
|
30
|
+
* Gets the socket address and a device token. `refreshed` is true when the
|
|
31
|
+
* call got a new device token from the Relay.
|
|
32
|
+
*/
|
|
29
33
|
authenticate(): Promise<{
|
|
30
34
|
url: string;
|
|
31
35
|
token: string;
|
|
32
36
|
renewAt: number;
|
|
37
|
+
refreshed: boolean;
|
|
33
38
|
}>;
|
|
39
|
+
/**
|
|
40
|
+
* Returns true for a Relay refusal of a socket authentication or a pull
|
|
41
|
+
* that the same request gets again. The subscription then stops with the
|
|
42
|
+
* reason `authority-refused`. Each other failure goes to the retry schedule.
|
|
43
|
+
*/
|
|
44
|
+
isConclusiveRefusal(error: unknown): boolean;
|
|
34
45
|
/** Decodes the `message` of a `durable-message` frame. */
|
|
35
46
|
decodeDurable(message: unknown): Envelope;
|
|
36
47
|
/** Recovers retained work over HTTP while no socket delivers it. */
|
|
@@ -61,7 +72,9 @@ interface MailboxSubscription {
|
|
|
61
72
|
* Receives each connection transition. The subscription starts at
|
|
62
73
|
* `connecting` and ends at `stopped`. It ends at `stopped` with the reason
|
|
63
74
|
* `upgrade-required` when the Relay no longer serves the protocol version of
|
|
64
|
-
* this SDK
|
|
75
|
+
* this SDK, with `device-revoked` or `device-unknown` when the Relay refuses
|
|
76
|
+
* this device, and with `authority-refused` after a conclusive refusal. A
|
|
77
|
+
* token renewal on a live socket is not a transition.
|
|
65
78
|
*/
|
|
66
79
|
onConnectionState(state: RelayConnectionState["state"], reason?: RelayConnectionReason): void;
|
|
67
80
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"hosted-mailbox-subscription.d.ts","sourceRoot":"","sources":["../../client/hosted-mailbox-subscription.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,qBAAqB,EACrB,oBAAoB,EACpB,WAAW,EACZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAOL,KAAK,0BAA0B,EAC/B,KAAK,yBAAyB,EAC/B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAGL,KAAK,oBAAoB,EAC1B,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"hosted-mailbox-subscription.d.ts","sourceRoot":"","sources":["../../client/hosted-mailbox-subscription.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,qBAAqB,EACrB,oBAAoB,EACpB,WAAW,EACZ,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAOL,KAAK,0BAA0B,EAC/B,KAAK,yBAAyB,EAC/B,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAGL,KAAK,oBAAoB,EAC1B,MAAM,wBAAwB,CAAC;AAyGhC;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GACzB;IAAE,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAA;CAAE,CAAC;AAE5E;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,SAAS,QAAQ,EAAE,CAAC;IACvC,QAAQ,CAAC,QAAQ,EAAE,SAAS,oBAAoB,EAAE,CAAC;CACpD;AAED,qDAAqD;AACrD,MAAM,WAAW,qBAAqB;IACpC,0EAA0E;IAC1E,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;CACvC;AAED,UAAU,mBAAmB;IAC3B;;;OAGG;IACH,YAAY,IAAI,OAAO,CAAC;QACtB,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,OAAO,CAAC;KACpB,CAAC,CAAC;IACH;;;;OAIG;IACH,mBAAmB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7C,0DAA0D;IAC1D,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,QAAQ,CAAC;IAC1C,oEAAoE;IACpE,IAAI,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7B;;;OAGG;IACH,WAAW,CACT,UAAU,EAAE,SAAS,MAAM,EAAE,EAC7B,UAAU,EAAE,SAAS,MAAM,EAAE,GAC5B,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAClC,OAAO,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClD;;;OAGG;IACH,cAAc,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7D;;;;;;OAMG;IACH,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,IAAI,CAAC;IACnE,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5E,YAAY,CAAC,IAAI,IAAI,CAAC;IACtB,UAAU,CAAC,IAAI,IAAI,CAAC;IACpB;;;;;;;OAOG;IACH,iBAAiB,CACf,KAAK,EAAE,oBAAoB,CAAC,OAAO,CAAC,EACpC,MAAM,CAAC,EAAE,qBAAqB,GAC7B,IAAI,CAAC;IACR;;;OAGG;IACH,UAAU,CAAC,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI,CAAC;CAC/C;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC;;;OAGG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC;IACxC;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACjE;AAqBD;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,mBAAmB,GAC3B,yBAAyB,CAowB3B"}
|