@signalapp/libsignal-client 0.42.0 → 0.44.0

package/Native.d.ts

@@ -21,22 +21,24 @@ interface LookupResponseEntry {
   readonly pni: string | undefined;
 }
 
-interface Response {
+interface ChatResponse {
   status: number;
   message: string | undefined;
   headers: ReadonlyArray<[string, string]>;
   body: Buffer | undefined;
 }
 
-interface DebugInfo {
+interface ChatServiceDebugInfo {
   connectionReused: boolean;
   reconnectCount: number;
   ipType: number;
+  durationMillis: number;
+  connectionInfo: string;
 }
 
 interface ResponseAndDebugInfo {
-  response: Response;
-  debugInfo: DebugInfo;
+  response: ChatResponse;
+  debugInfo: ChatServiceDebugInfo;
 }
 
 interface SealedSenderMultiRecipientMessageRecipient {
@@ -113,9 +115,9 @@ export abstract class InputStream {
 
 export abstract class SyncInputStream extends Buffer {}
 
-interface Wrapper<T> {
-  readonly _nativeHandle: T;
-}
+type Wrapper<T> = Readonly<{
+  _nativeHandle: T;
+}>;
 
 interface MessageBackupValidationOutcome {
   errorMessage: string | null;
@@ -164,16 +166,20 @@ export function CallLinkSecretParams_DeriveFromRootKey(rootKey: Buffer): Buffer;
 export function CallLinkSecretParams_GetPublicParams(paramsBytes: Buffer): Buffer;
 export function Cds2ClientState_New(mrenclave: Buffer, attestationMsg: Buffer, currentTimestamp: Timestamp): SgxClientState;
 export function CdsiLookup_complete(asyncRuntime: Wrapper<TokioAsyncContext>, lookup: Wrapper<CdsiLookup>): Promise<LookupResponse>;
-export function CdsiLookup_new(asyncRuntime: Wrapper<TokioAsyncContext>, connectionManager: Wrapper<ConnectionManager>, username: string, password: string, request: Wrapper<LookupRequest>, timeoutMillis: number): Promise<CdsiLookup>;
+export function CdsiLookup_new(asyncRuntime: Wrapper<TokioAsyncContext>, connectionManager: Wrapper<ConnectionManager>, username: string, password: string, request: Wrapper<LookupRequest>): Promise<CdsiLookup>;
 export function CdsiLookup_token(lookup: Wrapper<CdsiLookup>): Buffer;
+export function ChatService_connect_auth(asyncRuntime: Wrapper<TokioAsyncContext>, chat: Wrapper<Chat>): Promise<ChatServiceDebugInfo>;
+export function ChatService_connect_unauth(asyncRuntime: Wrapper<TokioAsyncContext>, chat: Wrapper<Chat>): Promise<ChatServiceDebugInfo>;
 export function ChatService_disconnect(asyncRuntime: Wrapper<TokioAsyncContext>, chat: Wrapper<Chat>): Promise<void>;
 export function ChatService_new(connectionManager: Wrapper<ConnectionManager>, username: string, password: string): Chat;
-export function ChatService_unauth_send(asyncRuntime: Wrapper<TokioAsyncContext>, chat: Wrapper<Chat>, httpRequest: Wrapper<HttpRequest>, timeoutMillis: number): Promise<Response>;
+export function ChatService_unauth_send(asyncRuntime: Wrapper<TokioAsyncContext>, chat: Wrapper<Chat>, httpRequest: Wrapper<HttpRequest>, timeoutMillis: number): Promise<ChatResponse>;
 export function ChatService_unauth_send_and_debug(asyncRuntime: Wrapper<TokioAsyncContext>, chat: Wrapper<Chat>, httpRequest: Wrapper<HttpRequest>, timeoutMillis: number): Promise<ResponseAndDebugInfo>;
 export function CiphertextMessage_FromPlaintextContent(m: Wrapper<PlaintextContent>): CiphertextMessage;
 export function CiphertextMessage_Serialize(obj: Wrapper<CiphertextMessage>): Buffer;
 export function CiphertextMessage_Type(msg: Wrapper<CiphertextMessage>): number;
+export function ConnectionManager_clear_proxy(connectionManager: Wrapper<ConnectionManager>): void;
 export function ConnectionManager_new(environment: number): ConnectionManager;
+export function ConnectionManager_set_proxy(connectionManager: Wrapper<ConnectionManager>, host: string, port: number): void;
 export function CreateCallLinkCredentialPresentation_CheckValidContents(presentationBytes: Buffer): void;
 export function CreateCallLinkCredentialPresentation_Verify(presentationBytes: Buffer, roomId: Buffer, now: Timestamp, serverParamsBytes: Buffer, callLinkParamsBytes: Buffer): void;
 export function CreateCallLinkCredentialRequestContext_CheckValidContents(contextBytes: Buffer): void;
@@ -457,17 +463,19 @@ export function SignedPreKeyRecord_GetSignature(obj: Wrapper<SignedPreKeyRecord>
 export function SignedPreKeyRecord_GetTimestamp(obj: Wrapper<SignedPreKeyRecord>): Timestamp;
 export function SignedPreKeyRecord_New(id: number, timestamp: Timestamp, pubKey: Wrapper<PublicKey>, privKey: Wrapper<PrivateKey>, signature: Buffer): SignedPreKeyRecord;
 export function SignedPreKeyRecord_Serialize(obj: Wrapper<SignedPreKeyRecord>): Buffer;
-export function Svr3Backup(asyncRuntime: Wrapper<TokioAsyncContext>, connectionManager: Wrapper<ConnectionManager>, secret: Buffer, password: string, maxTries: number, username: string, enclavePassword: string, opTimeoutMs: number): Promise<Buffer>;
-export function Svr3Restore(asyncRuntime: Wrapper<TokioAsyncContext>, connectionManager: Wrapper<ConnectionManager>, password: string, shareSet: Buffer, username: string, enclavePassword: string, opTimeoutMs: number): Promise<Buffer>;
-export function TESTING_CdsiLookupErrorConvert(): void;
+export function Svr3Backup(asyncRuntime: Wrapper<TokioAsyncContext>, connectionManager: Wrapper<ConnectionManager>, secret: Buffer, password: string, maxTries: number, username: string, enclavePassword: string): Promise<Buffer>;
+export function Svr3Restore(asyncRuntime: Wrapper<TokioAsyncContext>, connectionManager: Wrapper<ConnectionManager>, password: string, shareSet: Buffer, username: string, enclavePassword: string): Promise<Buffer>;
+export function TESTING_CdsiLookupErrorConvert(errorDescription: string): void;
 export function TESTING_CdsiLookupResponseConvert(asyncRuntime: Wrapper<TokioAsyncContext>): Promise<LookupResponse>;
-export function TESTING_ChatRequestGetBody(request: Wrapper<HttpRequest>): Buffer | null;
+export function TESTING_ChatRequestGetBody(request: Wrapper<HttpRequest>): Buffer;
 export function TESTING_ChatRequestGetHeaderValue(request: Wrapper<HttpRequest>, headerName: string): string;
 export function TESTING_ChatRequestGetMethod(request: Wrapper<HttpRequest>): string;
 export function TESTING_ChatRequestGetPath(request: Wrapper<HttpRequest>): string;
-export function TESTING_ChatServiceDebugInfoConvert(): DebugInfo;
+export function TESTING_ChatServiceDebugInfoConvert(): ChatServiceDebugInfo;
 export function TESTING_ChatServiceErrorConvert(): void;
-export function TESTING_ChatServiceResponseConvert(bodyPresent: boolean): Response;
+export function TESTING_ChatServiceInactiveErrorConvert(): void;
+export function TESTING_ChatServiceResponseAndDebugInfoConvert(): ResponseAndDebugInfo;
+export function TESTING_ChatServiceResponseConvert(bodyPresent: boolean): ChatResponse;
 export function TESTING_ErrorOnBorrowAsync(_input: null): Promise<void>;
 export function TESTING_ErrorOnBorrowIo(asyncRuntime: Wrapper<NonSuspendingBackgroundThreadRuntime>, _input: null): Promise<void>;
 export function TESTING_ErrorOnBorrowSync(_input: null): void;

package/dist/Errors.d.ts

@@ -22,15 +22,18 @@ export declare enum ErrorCode {
     BadDiscriminatorCharacter = 18,
     DiscriminatorTooLarge = 19,
     IoError = 20,
-    InvalidMediaInput = 21,
-    UnsupportedMediaInput = 22,
-    InputDataTooLong = 23,
-    InvalidEntropyDataLength = 24,
-    InvalidUsernameLinkEncryptedData = 25,
-    RateLimitedError = 26,
-    SvrDataMissing = 27,
-    SvrRequestFailed = 28,
-    SvrRestoreFailed = 29
+    CdsiInvalidToken = 21,
+    InvalidUri = 22,
+    InvalidMediaInput = 23,
+    UnsupportedMediaInput = 24,
+    InputDataTooLong = 25,
+    InvalidEntropyDataLength = 26,
+    InvalidUsernameLinkEncryptedData = 27,
+    RateLimitedError = 28,
+    SvrDataMissing = 29,
+    SvrRequestFailed = 30,
+    SvrRestoreFailed = 31,
+    ChatServiceInactive = 32
 }
 export declare class LibSignalErrorBase extends Error {
     readonly code: ErrorCode;
@@ -115,6 +118,12 @@ export type InvalidUsernameLinkEncryptedData = LibSignalErrorCommon & {
 export type IoError = LibSignalErrorCommon & {
     code: ErrorCode.IoError;
 };
+export type CdsiInvalidTokenError = LibSignalErrorCommon & {
+    code: ErrorCode.CdsiInvalidToken;
+};
+export type InvalidUriError = LibSignalErrorCommon & {
+    code: ErrorCode.InvalidUri;
+};
 export type InvalidMediaInputError = LibSignalErrorCommon & {
     code: ErrorCode.InvalidMediaInput;
 };
@@ -125,6 +134,9 @@ export type RateLimitedError = LibSignalErrorBase & {
     code: ErrorCode.RateLimitedError;
     readonly retryAfterSecs: number;
 };
+export type ChatServiceInactive = LibSignalErrorBase & {
+    code: ErrorCode.ChatServiceInactive;
+};
 export type SvrDataMissingError = LibSignalErrorBase & {
     code: ErrorCode.SvrDataMissing;
 };
@@ -134,4 +146,4 @@ export type SvrRequestFailedError = LibSignalErrorCommon & {
 export type SvrRestoreFailedError = LibSignalErrorCommon & {
     code: ErrorCode.SvrRestoreFailed;
 };
-export type LibSignalError = GenericError | DuplicatedMessageError | SealedSenderSelfSendError | UntrustedIdentityError | InvalidRegistrationIdError | VerificationFailedError | InvalidSessionError | InvalidSenderKeySessionError | NicknameCannotBeEmptyError | CannotStartWithDigitError | MissingSeparatorError | BadNicknameCharacterError | NicknameTooShortError | NicknameTooLongError | DiscriminatorCannotBeEmptyError | DiscriminatorCannotBeZeroError | DiscriminatorCannotBeSingleDigitError | DiscriminatorCannotHaveLeadingZerosError | BadDiscriminatorCharacterError | DiscriminatorTooLargeError | InputDataTooLong | InvalidEntropyDataLength | InvalidUsernameLinkEncryptedData | IoError | InvalidMediaInputError | SvrDataMissingError | SvrRestoreFailedError | SvrRequestFailedError | UnsupportedMediaInputError;
+export type LibSignalError = GenericError | DuplicatedMessageError | SealedSenderSelfSendError | UntrustedIdentityError | InvalidRegistrationIdError | VerificationFailedError | InvalidSessionError | InvalidSenderKeySessionError | NicknameCannotBeEmptyError | CannotStartWithDigitError | MissingSeparatorError | BadNicknameCharacterError | NicknameTooShortError | NicknameTooLongError | DiscriminatorCannotBeEmptyError | DiscriminatorCannotBeZeroError | DiscriminatorCannotBeSingleDigitError | DiscriminatorCannotHaveLeadingZerosError | BadDiscriminatorCharacterError | DiscriminatorTooLargeError | InputDataTooLong | InvalidEntropyDataLength | InvalidUsernameLinkEncryptedData | IoError | CdsiInvalidTokenError | InvalidUriError | InvalidMediaInputError | SvrDataMissingError | SvrRestoreFailedError | SvrRequestFailedError | UnsupportedMediaInputError | ChatServiceInactive;

package/dist/Errors.js

@@ -29,15 +29,18 @@ var ErrorCode;
     ErrorCode[ErrorCode["BadDiscriminatorCharacter"] = 18] = "BadDiscriminatorCharacter";
     ErrorCode[ErrorCode["DiscriminatorTooLarge"] = 19] = "DiscriminatorTooLarge";
     ErrorCode[ErrorCode["IoError"] = 20] = "IoError";
-    ErrorCode[ErrorCode["InvalidMediaInput"] = 21] = "InvalidMediaInput";
-    ErrorCode[ErrorCode["UnsupportedMediaInput"] = 22] = "UnsupportedMediaInput";
-    ErrorCode[ErrorCode["InputDataTooLong"] = 23] = "InputDataTooLong";
-    ErrorCode[ErrorCode["InvalidEntropyDataLength"] = 24] = "InvalidEntropyDataLength";
-    ErrorCode[ErrorCode["InvalidUsernameLinkEncryptedData"] = 25] = "InvalidUsernameLinkEncryptedData";
-    ErrorCode[ErrorCode["RateLimitedError"] = 26] = "RateLimitedError";
-    ErrorCode[ErrorCode["SvrDataMissing"] = 27] = "SvrDataMissing";
-    ErrorCode[ErrorCode["SvrRequestFailed"] = 28] = "SvrRequestFailed";
-    ErrorCode[ErrorCode["SvrRestoreFailed"] = 29] = "SvrRestoreFailed";
+    ErrorCode[ErrorCode["CdsiInvalidToken"] = 21] = "CdsiInvalidToken";
+    ErrorCode[ErrorCode["InvalidUri"] = 22] = "InvalidUri";
+    ErrorCode[ErrorCode["InvalidMediaInput"] = 23] = "InvalidMediaInput";
+    ErrorCode[ErrorCode["UnsupportedMediaInput"] = 24] = "UnsupportedMediaInput";
+    ErrorCode[ErrorCode["InputDataTooLong"] = 25] = "InputDataTooLong";
+    ErrorCode[ErrorCode["InvalidEntropyDataLength"] = 26] = "InvalidEntropyDataLength";
+    ErrorCode[ErrorCode["InvalidUsernameLinkEncryptedData"] = 27] = "InvalidUsernameLinkEncryptedData";
+    ErrorCode[ErrorCode["RateLimitedError"] = 28] = "RateLimitedError";
+    ErrorCode[ErrorCode["SvrDataMissing"] = 29] = "SvrDataMissing";
+    ErrorCode[ErrorCode["SvrRequestFailed"] = 30] = "SvrRequestFailed";
+    ErrorCode[ErrorCode["SvrRestoreFailed"] = 31] = "SvrRestoreFailed";
+    ErrorCode[ErrorCode["ChatServiceInactive"] = 32] = "ChatServiceInactive";
 })(ErrorCode = exports.ErrorCode || (exports.ErrorCode = {}));
 class LibSignalErrorBase extends Error {
     constructor(message, name, operation, extraProps) {

package/dist/acknowledgments.md

@@ -669,7 +669,7 @@ For more information on this, and how to apply and follow the GNU AGPL, see
 
 ```
 
-## attest 0.1.0, device-transfer 0.1.0, libsignal-bridge 0.1.0, libsignal-bridge-macros 0.1.0, libsignal-core 0.1.0, libsignal-ffi 0.42.0, libsignal-jni 0.42.0, libsignal-message-backup 0.1.0, libsignal-message-backup-macros 0.1.0, libsignal-net 0.1.0, libsignal-node 0.42.0, libsignal-protocol 0.1.0, libsignal-svr3 0.1.0, poksho 0.7.0, signal-crypto 0.1.0, signal-media 0.1.0, signal-neon-futures 0.1.0, signal-neon-futures-tests 0.1.0, signal-pin 0.1.0, usernames 0.1.0, zkcredential 0.1.0, zkgroup 0.9.0
+## attest 0.1.0, device-transfer 0.1.0, libsignal-bridge 0.1.0, libsignal-bridge-macros 0.1.0, libsignal-core 0.1.0, libsignal-ffi 0.44.0, libsignal-jni 0.44.0, libsignal-message-backup 0.1.0, libsignal-message-backup-macros 0.1.0, libsignal-net 0.1.0, libsignal-node 0.44.0, libsignal-protocol 0.1.0, libsignal-svr3 0.1.0, poksho 0.7.0, signal-crypto 0.1.0, signal-media 0.1.0, signal-neon-futures 0.1.0, signal-neon-futures-tests 0.1.0, signal-pin 0.1.0, usernames 0.1.0, zkcredential 0.1.0, zkgroup 0.9.0
 
 ```
 GNU AFFERO GENERAL PUBLIC LICENSE

package/dist/net.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import type { ReadonlyDeep } from 'type-fest';
 import * as Native from '../Native';
+import { Wrapper } from '../Native';
 export declare enum Environment {
     Staging = 0,
     Production = 1
@@ -15,7 +16,6 @@ export type CDSRequestOptionsType = {
         aci: string;
         accessKey: string;
     }>;
-    timeout: number;
     returnAcisWithoutUaks: boolean;
 };
 export type CDSResponseEntryType<Aci, Pni> = {
@@ -34,22 +34,90 @@ export type ChatRequest = Readonly<{
     body?: Uint8Array;
     timeoutMillis?: number;
 }>;
-export declare class Net {
-    private readonly _asyncContext;
-    private readonly _chatService;
-    private readonly _connectionManager;
+type TokioAsyncContext = Wrapper<Native.TokioAsyncContext>;
+type ConnectionManager = Wrapper<Native.ConnectionManager>;
+/**
+ * Provides API methods to connect and communicate with the Chat Service.
+ * Before using either authenticated or unauthenticated channels,
+ * a corresponding `connect*` method must be called.
+ * It's also important to call {@link #disconnect()} method when the instance is no longer needed.
+ */
+export declare class ChatService {
+    private readonly asyncContext;
+    private readonly chatService;
+    constructor(asyncContext: TokioAsyncContext, connectionManager: ConnectionManager);
     /**
-     * Instance of the {@link Svr3Client} to access SVR3.
+     * Initiates termination of the underlying connection to the Chat Service. After the service is
+     * disconnected, it will not attempt to automatically reconnect until you call
+     * {@link #connectAuthenticated()} and/or {@link #connectUnauthenticated()}.
+     *
+     * Note: the same instance of `ChatService` can be reused after `disconnect()` was
+     * called.
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Initiates establishing of the underlying unauthenticated connection to the Chat Service. Once
+     * the service is connected, all the requests will be using the established connection. Also, if
+     * the connection is lost for any reason other than the call to {@link #disconnect()}, an
+     * automatic reconnect attempt will be made.
+     */
+    connectUnauthenticated(): Promise<Native.ChatServiceDebugInfo>;
+    /**
+     * Initiates establishing of the underlying authenticated connection to the Chat Service. Once the
+     * service is connected, all the requests will be using the established connection. Also, if the
+     * connection is lost for any reason other than the call to {@link #disconnect()}, an automatic
+     * reconnect attempt will be made.
+     *
+     * Calling this method will result in starting to accept incoming requests from the Chat Service.
+     */
+    connectAuthenticated(): Promise<Native.ChatServiceDebugInfo>;
+    /**
+     * Sends request to the Chat Service over an unauthenticated channel.
+     *
+     * In addition to the response, an object containing debug information about the request flow is
+     * returned.
+     *
+     * @throws {ChatServiceInactive} if you haven't called {@link #connectUnauthenticated()}.
      */
-    svr3: Svr3Client;
-    constructor(env: Environment);
-    disconnectChatService(): Promise<void>;
     unauthenticatedFetchAndDebug(chatRequest: ChatRequest): Promise<Native.ResponseAndDebugInfo>;
-    unauthenticatedFetch(chatRequest: ChatRequest): Promise<Native.Response>;
+    /**
+     * Sends request to the Chat Service over an unauthenticated channel.
+     *
+     * @throws {ChatServiceInactive} if you haven't called {@link #connectUnauthenticated()}.
+     */
+    unauthenticatedFetch(chatRequest: ChatRequest): Promise<Native.ChatResponse>;
     static buildHttpRequest(chatRequest: ChatRequest): {
         _nativeHandle: Native.HttpRequest;
     };
-    cdsiLookup({ username, password }: Readonly<ServiceAuth>, { e164s, acisAndAccessKeys, timeout, returnAcisWithoutUaks, }: ReadonlyDeep<CDSRequestOptionsType>): Promise<CDSResponseType<string, string>>;
+}
+export declare class Net {
+    private readonly asyncContext;
+    private readonly connectionManager;
+    /**
+     * Instance of the {@link Svr3Client} to access SVR3.
+     */
+    svr3: Svr3Client;
+    constructor(env: Environment);
+    /**
+     * Creates a new instance of {@link ChatService}.
+     */
+    newChatService(): ChatService;
+    /**
+     * Sets the proxy host to be used for all new connections (until overridden).
+     *
+     * Sets a domain name and port to be used to proxy all new outgoing
+     * connections. The proxy can be overridden by calling this method again or
+     * unset by calling {@link #clearProxy}.
+     */
+    setProxy(host: string, port: number): void;
+    /**
+     * Ensures that future connections will be made directly, not through a proxy.
+     *
+     * Clears any proxy configuration set via {@link #setProxy}. If none was set, calling this
+     * method is a no-op.
+     */
+    clearProxy(): void;
+    cdsiLookup({ username, password }: Readonly<ServiceAuth>, { e164s, acisAndAccessKeys, returnAcisWithoutUaks, }: ReadonlyDeep<CDSRequestOptionsType>): Promise<CDSResponseType<string, string>>;
 }
 /**
  * This interface provides functionality for communicating with SVR3
@@ -67,8 +135,8 @@ export declare class Net {
  * // Instantiate ServiceAuth with the username and password obtained from the Chat Server.
  * const auth = { username: USERNAME, password: ENCLAVE_PASSWORD };
  * // Store a value in SVR3. Here 10 is the number of permitted restore attempts.
- * const shareSet = await SVR3.backup(SECRET_TO_BE_STORED, PASSWORD, 10, auth, TIMEOUT);
- * const restoredSecret = await SVR3.restore( PASSWORD, shareSet, auth, TIMEOUT);
+ * const shareSet = await SVR3.backup(SECRET_TO_BE_STORED, PASSWORD, 10, auth);
+ * const restoredSecret = await SVR3.restore( PASSWORD, shareSet, auth);
  * ```
  */
 export interface Svr3Client {
@@ -89,8 +157,6 @@ export interface Svr3Client {
      * generally good for about 15 minutes, therefore it can be reused for the
      * subsequent calls to either backup or restore that are not too far apart in
      * time.
-     * @param opTimeoutMs - The maximum wall time libsignal is allowed to spend
-     * communicating with SVR3 service.
      * @returns A `Promise` which--when awaited--will return a byte array with a
      * serialized masked share set. It is supposed to be an opaque blob for the
      * clients and therefore no assumptions should be made about its contents.
@@ -98,15 +164,16 @@ export interface Svr3Client {
      * secret along with the password. Please note that masked share set does not
      * have to be treated as secret.
      *
-     * The returned `Promise` can also fail due to the network issues (including the
-     * timeout), problems establishing the Noise connection to the enclaves, or
-     * invalid arguments' values. {@link IoError} errors can, in general, be
-     * retried, although there is already a retry-with-backoff mechanism inside
-     * libsignal used to connect to the SVR3 servers. Other exceptions are caused
-     * by the bad input or data missing on the server. They are therefore
-     * non-actionable and are guaranteed to be thrown again when retried.
+     * The returned `Promise` can also fail due to the network issues (including a
+     * connection timeout), problems establishing the Noise connection to the
+     * enclaves, or invalid arguments' values. {@link IoError} errors can, in
+     * general, be retried, although there is already a retry-with-backoff
+     * mechanism inside libsignal used to connect to the SVR3 servers. Other
+     * exceptions are caused by the bad input or data missing on the server. They
+     * are therefore non-actionable and are guaranteed to be thrown again when
+     * retried.
      */
-    backup(what: Buffer, password: string, maxTries: number, auth: Readonly<ServiceAuth>, opTimeoutMs: number): Promise<Buffer>;
+    backup(what: Buffer, password: string, maxTries: number, auth: Readonly<ServiceAuth>): Promise<Buffer>;
     /**
      * Restore a secret from SVR3.
      *
@@ -122,18 +189,17 @@ export interface Svr3Client {
      * generally good for about 15 minutes, therefore it can be reused for the
      * subsequent calls to either backup or restore that are not too far apart in
      * time.
-     * @param opTimeoutMs - The maximum wall time libsignal is allowed to spend
-     * communicating with SVR3 service.
      * @returns A `Promise` which--when awaited--will return a byte array with the
      * restored secret.
      *
-     * The returned `Promise` can also fail due to the network issues (including the
-     * timeout), problems establishing the Noise connection to the enclaves, or
-     * invalid arguments' values. {@link IoError} errors can, in general, be
-     * retried, although there is already a retry-with-backoff mechanism inside
-     * libsignal used to connect to the SVR3 servers. Other exceptions are caused
-     * by the bad input or data missing on the server. They are therefore
-     * non-actionable and are guaranteed to be thrown again when retried.
+     * The returned `Promise` can also fail due to the network issues (including
+     * the connection timeout), problems establishing the Noise connection to the
+     * enclaves, or invalid arguments' values. {@link IoError} errors can, in
+     * general, be retried, although there is already a retry-with-backoff
+     * mechanism inside libsignal used to connect to the SVR3 servers. Other
+     * exceptions are caused by the bad input or data missing on the server. They
+     * are therefore non-actionable and are guaranteed to be thrown again when
+     * retried.
      *
      * - {@link SvrDataMissingError} is returned when the maximum restore attempts
      * number has been exceeded or if the value has never been backed up.
@@ -144,5 +210,6 @@ export interface Svr3Client {
      * masked share set fails, or when the server requests fail for reasons
      * other than "maximum attempts exceeded".
      */
-    restore(password: string, shareSet: Buffer, auth: Readonly<ServiceAuth>, opTimeoutMs: number): Promise<Buffer>;
+    restore(password: string, shareSet: Buffer, auth: Readonly<ServiceAuth>): Promise<Buffer>;
 }
+export {};

package/dist/net.js

@@ -4,7 +4,7 @@
 // SPDX-License-Identifier: AGPL-3.0-only
 //
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Net = exports.Environment = void 0;
+exports.Net = exports.ChatService = exports.Environment = void 0;
 const Native = require("../Native");
 const Address_1 = require("./Address");
 const DEFAULT_CHAT_REQUEST_TIMEOUT_MILLIS = 5000;
@@ -14,25 +14,71 @@ var Environment;
     Environment[Environment["Staging"] = 0] = "Staging";
     Environment[Environment["Production"] = 1] = "Production";
 })(Environment = exports.Environment || (exports.Environment = {}));
-class Net {
-    constructor(env) {
-        this._asyncContext = { _nativeHandle: Native.TokioAsyncContext_new() };
-        this._connectionManager = {
-            _nativeHandle: Native.ConnectionManager_new(env),
-        };
-        this._chatService = {
-            _nativeHandle: Native.ChatService_new(this._connectionManager, '', ''),
-        };
-        this.svr3 = new Svr3ClientImpl(this._asyncContext, this._connectionManager);
+function newNativeHandle(handle) {
+    return {
+        _nativeHandle: handle,
+    };
+}
+/**
+ * Provides API methods to connect and communicate with the Chat Service.
+ * Before using either authenticated or unauthenticated channels,
+ * a corresponding `connect*` method must be called.
+ * It's also important to call {@link #disconnect()} method when the instance is no longer needed.
+ */
+class ChatService {
+    constructor(asyncContext, connectionManager) {
+        this.asyncContext = asyncContext;
+        this.chatService = newNativeHandle(Native.ChatService_new(connectionManager, '', ''));
+    }
+    /**
+     * Initiates termination of the underlying connection to the Chat Service. After the service is
+     * disconnected, it will not attempt to automatically reconnect until you call
+     * {@link #connectAuthenticated()} and/or {@link #connectUnauthenticated()}.
+     *
+     * Note: the same instance of `ChatService` can be reused after `disconnect()` was
+     * called.
+     */
+    async disconnect() {
+        await Native.ChatService_disconnect(this.asyncContext, this.chatService);
     }
-    async disconnectChatService() {
-        await Native.ChatService_disconnect(this._asyncContext, this._chatService);
+    /**
+     * Initiates establishing of the underlying unauthenticated connection to the Chat Service. Once
+     * the service is connected, all the requests will be using the established connection. Also, if
+     * the connection is lost for any reason other than the call to {@link #disconnect()}, an
+     * automatic reconnect attempt will be made.
+     */
+    async connectUnauthenticated() {
+        return await Native.ChatService_connect_unauth(this.asyncContext, this.chatService);
     }
+    /**
+     * Initiates establishing of the underlying authenticated connection to the Chat Service. Once the
+     * service is connected, all the requests will be using the established connection. Also, if the
+     * connection is lost for any reason other than the call to {@link #disconnect()}, an automatic
+     * reconnect attempt will be made.
+     *
+     * Calling this method will result in starting to accept incoming requests from the Chat Service.
+     */
+    async connectAuthenticated() {
+        return await Native.ChatService_connect_auth(this.asyncContext, this.chatService);
+    }
+    /**
+     * Sends request to the Chat Service over an unauthenticated channel.
+     *
+     * In addition to the response, an object containing debug information about the request flow is
+     * returned.
+     *
+     * @throws {ChatServiceInactive} if you haven't called {@link #connectUnauthenticated()}.
+     */
     async unauthenticatedFetchAndDebug(chatRequest) {
-        return await Native.ChatService_unauth_send_and_debug(this._asyncContext, this._chatService, Net.buildHttpRequest(chatRequest), chatRequest.timeoutMillis ?? DEFAULT_CHAT_REQUEST_TIMEOUT_MILLIS);
+        return await Native.ChatService_unauth_send_and_debug(this.asyncContext, this.chatService, ChatService.buildHttpRequest(chatRequest), chatRequest.timeoutMillis ?? DEFAULT_CHAT_REQUEST_TIMEOUT_MILLIS);
     }
+    /**
+     * Sends request to the Chat Service over an unauthenticated channel.
+     *
+     * @throws {ChatServiceInactive} if you haven't called {@link #connectUnauthenticated()}.
+     */
     async unauthenticatedFetch(chatRequest) {
-        return await Native.ChatService_unauth_send(this._asyncContext, this._chatService, Net.buildHttpRequest(chatRequest), chatRequest.timeoutMillis ?? DEFAULT_CHAT_REQUEST_TIMEOUT_MILLIS);
+        return await Native.ChatService_unauth_send(this.asyncContext, this.chatService, ChatService.buildHttpRequest(chatRequest), chatRequest.timeoutMillis ?? DEFAULT_CHAT_REQUEST_TIMEOUT_MILLIS);
     }
     static buildHttpRequest(chatRequest) {
         const { verb, path, body, headers } = chatRequest;
@@ -46,8 +92,41 @@ class Net {
         });
         return httpRequest;
     }
-    async cdsiLookup({ username, password }, { e164s, acisAndAccessKeys, timeout, returnAcisWithoutUaks, }) {
-        const request = { _nativeHandle: Native.LookupRequest_new() };
+}
+exports.ChatService = ChatService;
+class Net {
+    constructor(env) {
+        this.asyncContext = newNativeHandle(Native.TokioAsyncContext_new());
+        this.connectionManager = newNativeHandle(Native.ConnectionManager_new(env));
+        this.svr3 = new Svr3ClientImpl(this.asyncContext, this.connectionManager);
+    }
+    /**
+     * Creates a new instance of {@link ChatService}.
+     */
+    newChatService() {
+        return new ChatService(this.asyncContext, this.connectionManager);
+    }
+    /**
+     * Sets the proxy host to be used for all new connections (until overridden).
+     *
+     * Sets a domain name and port to be used to proxy all new outgoing
+     * connections. The proxy can be overridden by calling this method again or
+     * unset by calling {@link #clearProxy}.
+     */
+    setProxy(host, port) {
+        Native.ConnectionManager_set_proxy(this.connectionManager, host, port);
+    }
+    /**
+     * Ensures that future connections will be made directly, not through a proxy.
+     *
+     * Clears any proxy configuration set via {@link #setProxy}. If none was set, calling this
+     * method is a no-op.
+     */
+    clearProxy() {
+        Native.ConnectionManager_clear_proxy(this.connectionManager);
+    }
+    async cdsiLookup({ username, password }, { e164s, acisAndAccessKeys, returnAcisWithoutUaks, }) {
+        const request = newNativeHandle(Native.LookupRequest_new());
         e164s.forEach((e164) => {
             Native.LookupRequest_addE164(request, e164);
         });
@@ -55,23 +134,21 @@ class Net {
             Native.LookupRequest_addAciAndAccessKey(request, Address_1.Aci.parseFromServiceIdString(aciStr).getServiceIdFixedWidthBinary(), Buffer.from(accessKeyStr, 'base64'));
         });
         Native.LookupRequest_setReturnAcisWithoutUaks(request, returnAcisWithoutUaks);
-        const lookup = await Native.CdsiLookup_new(this._asyncContext, this._connectionManager, username, password, request, timeout);
-        return await Native.CdsiLookup_complete(this._asyncContext, {
-            _nativeHandle: lookup,
-        });
+        const lookup = await Native.CdsiLookup_new(this.asyncContext, this.connectionManager, username, password, request);
+        return await Native.CdsiLookup_complete(this.asyncContext, newNativeHandle(lookup));
     }
 }
 exports.Net = Net;
 class Svr3ClientImpl {
-    constructor(_asyncContext, _connectionManager) {
-        this._asyncContext = _asyncContext;
-        this._connectionManager = _connectionManager;
+    constructor(asyncContext, connectionManager) {
+        this.asyncContext = asyncContext;
+        this.connectionManager = connectionManager;
     }
-    async backup(what, password, maxTries, auth, opTimeoutMs) {
-        return Native.Svr3Backup(this._asyncContext, this._connectionManager, what, password, maxTries, auth.username, auth.password, opTimeoutMs);
+    async backup(what, password, maxTries, auth) {
+        return Native.Svr3Backup(this.asyncContext, this.connectionManager, what, password, maxTries, auth.username, auth.password);
     }
-    async restore(password, shareSet, auth, opTimeoutMs) {
-        return Native.Svr3Restore(this._asyncContext, this._connectionManager, password, shareSet, auth.username, auth.password, opTimeoutMs);
+    async restore(password, shareSet, auth) {
+        return Native.Svr3Restore(this.asyncContext, this.connectionManager, password, shareSet, auth.username, auth.password);
     }
 }
 //# sourceMappingURL=net.js.map

package/dist/zkgroup/internal/ByteArray.d.ts

@@ -2,7 +2,7 @@
 export declare const UNCHECKED_AND_UNCLONED: unique symbol;
 export default class ByteArray {
     contents: Buffer;
-    constructor(contents: Buffer, checkValid: ((contents: Buffer) => void) | typeof UNCHECKED_AND_UNCLONED);
+    protected constructor(contents: Buffer, checkValid: ((contents: Buffer) => void) | typeof UNCHECKED_AND_UNCLONED);
     protected static checkLength(expectedLength: number): (contents: Buffer) => void;
     getContents(): Buffer;
     serialize(): Buffer;

package/dist/zkgroup/internal/ByteArray.js

@@ -6,6 +6,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UNCHECKED_AND_UNCLONED = void 0;
 const Errors_1 = require("../../Errors");
+const Native = require("../../../Native");
 exports.UNCHECKED_AND_UNCLONED = Symbol();
 class ByteArray {
     constructor(contents, checkValid) {
@@ -13,7 +14,7 @@ class ByteArray {
             this.contents = contents;
         }
         else {
-            checkValid(contents);
+            checkValid.call(Native, contents);
             this.contents = Buffer.from(contents);
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalapp/libsignal-client",
-  "version": "0.42.0",
+  "version": "0.44.0",
   "license": "AGPL-3.0-only",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",