@signalapp/libsignal-client 0.83.0 → 0.84.0

package/Native.d.ts

@@ -229,6 +229,10 @@ export function BackupAuthCredential_GetBackupId(credentialBytes: Uint8Array): U
 export function BackupAuthCredential_GetBackupLevel(credentialBytes: Uint8Array): number;
 export function BackupAuthCredential_GetType(credentialBytes: Uint8Array): number;
 export function BackupAuthCredential_PresentDeterministic(credentialBytes: Uint8Array, serverParamsBytes: Uint8Array, randomness: Uint8Array): Uint8Array;
+export function BackupJsonExporter_ExportFrames(exporter: Wrapper<BackupJsonExporter>, frames: Uint8Array): string;
+export function BackupJsonExporter_Finish(exporter: Wrapper<BackupJsonExporter>): string;
+export function BackupJsonExporter_GetInitialChunk(exporter: Wrapper<BackupJsonExporter>): string;
+export function BackupJsonExporter_New(backupInfo: Uint8Array, shouldValidate: boolean): BackupJsonExporter;
 export function BackupKey_DeriveBackupId(backupKey: Uint8Array, aci: Uint8Array): Uint8Array;
 export function BackupKey_DeriveEcKey(backupKey: Uint8Array, aci: Uint8Array): PrivateKey;
 export function BackupKey_DeriveLocalBackupMetadataKey(backupKey: Uint8Array): Uint8Array;
@@ -347,7 +351,7 @@ export function HsmEnclaveClient_InitialRequest(obj: Wrapper<HsmEnclaveClient>):
 export function HsmEnclaveClient_New(trustedPublicKey: Uint8Array, trustedCodeHashes: Uint8Array): HsmEnclaveClient;
 export function HttpRequest_add_header(request: Wrapper<HttpRequest>, name: string, value: string): void;
 export function HttpRequest_new(method: string, path: string, bodyAsSlice: Uint8Array | null): HttpRequest;
-export function IdentityKeyPair_Deserialize(buffer: Uint8Array): {publicKey:PublicKey,privateKey:PrivateKey};
+export function IdentityKeyPair_Deserialize(input: Uint8Array): [PublicKey, PrivateKey];
 export function IdentityKeyPair_Serialize(publicKey: Wrapper<PublicKey>, privateKey: Wrapper<PrivateKey>): Uint8Array;
 export function IdentityKeyPair_SignAlternateIdentity(publicKey: Wrapper<PublicKey>, privateKey: Wrapper<PrivateKey>, otherIdentity: Wrapper<PublicKey>): Uint8Array;
 export function IdentityKey_VerifyAlternateIdentity(publicKey: Wrapper<PublicKey>, otherIdentity: Wrapper<PublicKey>, signature: Uint8Array): boolean;
@@ -685,6 +689,7 @@ export function TESTING_RegistrationService_ResumeSessionErrorConvert(errorDescr
 export function TESTING_RegistrationService_SubmitVerificationErrorConvert(errorDescription: string): void;
 export function TESTING_RegistrationService_UpdateSessionErrorConvert(errorDescription: string): void;
 export function TESTING_RegistrationSessionInfoConvert(): RegistrationSession;
+export function TESTING_ReturnPair(): [number, string];
 export function TESTING_ReturnStringArray(): string[];
 export function TESTING_RoundTripI32(input: number): number;
 export function TESTING_RoundTripU16(input: number): number;
@@ -733,6 +738,7 @@ export function initLogger(maxLevel: LogLevel, callback: (level: LogLevel, targe
 export function test_only_fn_returns_123(): number;
 interface Aes256GcmSiv { readonly __type: unique symbol; }
 interface AuthenticatedChatConnection { readonly __type: unique symbol; }
+interface BackupJsonExporter { readonly __type: unique symbol; }
 interface BackupRestoreResponse { readonly __type: unique symbol; }
 interface BackupStoreResponse { readonly __type: unique symbol; }
 interface BridgedStringMap { readonly __type: unique symbol; }
@@ -740,7 +746,6 @@ interface CdsiLookup { readonly __type: unique symbol; }
 interface ChatConnectionInfo { readonly __type: unique symbol; }
 interface CiphertextMessage { readonly __type: unique symbol; }
 interface ComparableBackup { readonly __type: unique symbol; }
-interface ComparableBackup { readonly __type: unique symbol; }
 interface ConnectionManager { readonly __type: unique symbol; }
 interface ConnectionProxyConfig { readonly __type: unique symbol; }
 interface DecryptionErrorMessage { readonly __type: unique symbol; }

package/dist/EcKeys.js

@@ -93,7 +93,7 @@ export class IdentityKeyPair {
         return new IdentityKeyPair(privateKey.getPublicKey(), privateKey);
     }
     static deserialize(buffer) {
-        const { privateKey, publicKey } = Native.IdentityKeyPair_Deserialize(buffer);
+        const [publicKey, privateKey] = Native.IdentityKeyPair_Deserialize(buffer);
         return new IdentityKeyPair(PublicKey._fromNativeHandle(publicKey), PrivateKey._fromNativeHandle(privateKey));
     }
     serialize() {

package/dist/MessageBackup.d.ts

@@ -62,7 +62,8 @@ export declare class MessageBackupKey {
 }
 export declare enum Purpose {
     DeviceTransfer = 0,
-    RemoteBackup = 1
+    RemoteBackup = 1,
+    TakeoutExport = 2
 }
 /**
  * Validate a backup file
@@ -170,3 +171,37 @@ export declare class ComparableBackup {
      */
     get unknownFields(): Array<string>;
 }
+/**
+ * Streaming exporter that produces a human-readable JSON representation of a backup.
+ */
+export declare class BackupJsonExporter {
+    readonly _nativeHandle: Native.BackupJsonExporter;
+    private constructor();
+    /**
+     * Initializes the streaming exporter and returns the first chunk of output.
+     * @param backupInfo The serialized BackupInfo protobuf without a varint header.
+     * @param [options] Additional configuration for the exporter.
+     * @param [options.validate=true] Whether to run semantic validation on the backup.
+     * @returns An object containing the exporter and the first chunk of output, containing the backup info.
+     * @throws Error if the input is invalid.
+     */
+    static start(backupInfo: Uint8Array, options?: {
+        validate?: boolean;
+    }): {
+        exporter: BackupJsonExporter;
+        chunk: string;
+    };
+    /**
+     * Validates and exports a human-readable JSON representation of backup frames.
+     * @param frames One or more varint delimited Frame serialized protobuf messages.
+     * @returns A string containing the exported frames.
+     * @throws Error if the input is invalid.
+     */
+    exportFrames(frames: Uint8Array): string;
+    /**
+     * Completes the validation and export of the previously exported frames.
+     * @returns A string containing the final chunk of the output.
+     * @throws Error if some previous input fails validation at the final stage.
+     */
+    finish(): string;
+}

package/dist/MessageBackup.js

@@ -70,6 +70,7 @@ export var Purpose;
 (function (Purpose) {
     Purpose[Purpose["DeviceTransfer"] = 0] = "DeviceTransfer";
     Purpose[Purpose["RemoteBackup"] = 1] = "RemoteBackup";
+    Purpose[Purpose["TakeoutExport"] = 2] = "TakeoutExport";
 })(Purpose || (Purpose = {}));
 /**
  * Validate a backup file
@@ -202,4 +203,44 @@ export class ComparableBackup {
         return Native.ComparableBackup_GetUnknownFields(this);
     }
 }
+/**
+ * Streaming exporter that produces a human-readable JSON representation of a backup.
+ */
+export class BackupJsonExporter {
+    constructor(handle) {
+        this._nativeHandle = handle;
+    }
+    /**
+     * Initializes the streaming exporter and returns the first chunk of output.
+     * @param backupInfo The serialized BackupInfo protobuf without a varint header.
+     * @param [options] Additional configuration for the exporter.
+     * @param [options.validate=true] Whether to run semantic validation on the backup.
+     * @returns An object containing the exporter and the first chunk of output, containing the backup info.
+     * @throws Error if the input is invalid.
+     */
+    static start(backupInfo, options) {
+        const shouldValidate = options?.validate ?? true;
+        const handle = Native.BackupJsonExporter_New(backupInfo, shouldValidate);
+        const exporter = new BackupJsonExporter(handle);
+        const chunk = Native.BackupJsonExporter_GetInitialChunk(exporter);
+        return { exporter, chunk };
+    }
+    /**
+     * Validates and exports a human-readable JSON representation of backup frames.
+     * @param frames One or more varint delimited Frame serialized protobuf messages.
+     * @returns A string containing the exported frames.
+     * @throws Error if the input is invalid.
+     */
+    exportFrames(frames) {
+        return Native.BackupJsonExporter_ExportFrames(this, frames);
+    }
+    /**
+     * Completes the validation and export of the previously exported frames.
+     * @returns A string containing the final chunk of the output.
+     * @throws Error if some previous input fails validation at the final stage.
+     */
+    finish() {
+        return Native.BackupJsonExporter_Finish(this);
+    }
+}
 //# sourceMappingURL=MessageBackup.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalapp/libsignal-client",
-  "version": "0.83.0",
+  "version": "0.84.0",
   "license": "AGPL-3.0-only",
   "type": "module",
   "main": "dist/index.js",
@@ -64,6 +64,7 @@
     "mocha": "^11",
     "prettier": "^2.7.1",
     "prettier-plugin-packagejson": "^2.5.19",
+    "protobufjs": "^7.5.3",
     "rimraf": "^6.0.1",
     "sinon": "^21.0.0",
     "sinon-chai": "^4.0.1",