favalib 0.0.7 → 0.0.9

package/build/CryptoProviders/browser/index.d.mts

@@ -14,7 +14,7 @@ declare class BrowserCryptoLib implements CryptoLib {
     /**
      * @inheritdoc
      */
-    getRandomBytes(count: number): Promise<Uint8Array>;
+    getRandomBytes(count: number): Promise<Uint8Array<ArrayBuffer>>;
     /**
      * @inheritdoc
      */

package/build/CryptoProviders/node/index.d.mts

@@ -7,7 +7,7 @@ declare class NodeCryptoLib implements CryptoLib {
     /**
      * @inheritdoc
      */
-    getRandomBytes(count: number): Promise<Uint8Array>;
+    getRandomBytes(count: number): Promise<Uint8Array<ArrayBufferLike>>;
     /**
      * @inheritdoc
      */

package/build/TwoFaLib.d.mts

@@ -1,27 +1,36 @@
 import { TypedEventTarget } from 'typescript-event-target';
 import type CryptoLib from './interfaces/CryptoLib.mjs';
 import type { EncryptedPrivateKey, EncryptedSymmetricKey, PrivateKey, PublicKey, Salt, SymmetricKey } from './interfaces/CryptoLib.mjs';
-import type { DeviceFriendlyName, DeviceId, DeviceType } from './interfaces/SyncTypes.mjs';
+import type { DeviceFriendlyName, DeviceType } from './interfaces/SyncTypes.mjs';
 import type { TwoFaLibEventMapEvents } from './interfaces/Events.mjs';
 import type { PassphraseExtraDict } from './interfaces/PassphraseExtraDict.js';
 import type { Vault, VaultSyncState } from './interfaces/Vault.mjs';
+import type { SaveFunction } from './interfaces/SaveFunction.mjs';
+import type { FavaMeta } from './interfaces/FavaMeta.mjs';
 import SyncManager from './subclasses/SyncManager.mjs';
 import ExportImportManager from './subclasses/ExportImportManager.mjs';
 import VaultOperationsManager from './subclasses/VaultOperationsManager.mjs';
-import SaveFunction from './interfaces/SaveFunction.mjs';
 import StorageOperationsManager from './subclasses/StorageOperationsManager.mjs';
 /**
  * The Two-Factor Library, this is the main entry point.
  */
 declare class TwoFaLib extends TypedEventTarget<TwoFaLibEventMapEvents> {
     static readonly version = "0.0.1";
-    readonly deviceId: DeviceId;
+    private readonly favaMeta;
     readonly deviceType: DeviceType;
     deviceFriendlyName: DeviceFriendlyName;
     private mediator;
     private readonly publicKey;
     private readonly privateKey;
     readonly ready: Promise<unknown>;
+    /**
+     * @returns The meta info for this device.
+     */
+    get meta(): {
+        deviceId: import("./interfaces/SyncTypes.mjs").DeviceId;
+        deviceFriendlyName: DeviceFriendlyName;
+        deviceType: DeviceType;
+    };
     /**
      * Constructs a new instance of TwoFaLib. If a serverUrl is provided, the library will use it for its sync operations.
      * @param deviceType - The identifier for this device type (e.g. 2fa-cli).
@@ -33,7 +42,7 @@ declare class TwoFaLib extends TypedEventTarget<TwoFaLibEventMapEvents> {
      * @param encryptedSymmetricKey - The encrypted symmetric key
      * @param salt - The salt used for key derivation.
      * @param publicKey - The public key of the device.
-     * @param deviceId - A unique identifier for this device.
+     * @param favaMeta - Meta info containing at least a unique identifier for this device.
      * @param vault - The vault data (entries)
      * @param saveFunction - The function to save the data.
      * @param syncState - The state of the sync, includes the serverUrl
@@ -41,7 +50,7 @@ declare class TwoFaLib extends TypedEventTarget<TwoFaLibEventMapEvents> {
      * @throws {InitializationError} If some parameter has an invalid value
      * @throws {AuthenticationError} If the provided passphrase is incorrect.
      */
-    constructor(deviceType: DeviceType, cryptoLib: CryptoLib, passphraseExtraDict: PassphraseExtraDict, privateKey: PrivateKey, symmetricKey: SymmetricKey, encryptedPrivateKey: EncryptedPrivateKey, encryptedSymmetricKey: EncryptedSymmetricKey, salt: Salt, publicKey: PublicKey, deviceId: DeviceId, vault?: Vault, saveFunction?: SaveFunction, syncState?: VaultSyncState);
+    constructor(deviceType: DeviceType, cryptoLib: CryptoLib, passphraseExtraDict: PassphraseExtraDict, privateKey: PrivateKey, symmetricKey: SymmetricKey, encryptedPrivateKey: EncryptedPrivateKey, encryptedSymmetricKey: EncryptedSymmetricKey, salt: Salt, publicKey: PublicKey, favaMeta: FavaMeta, vault?: Vault, saveFunction?: SaveFunction, syncState?: VaultSyncState);
     /**
      * @returns The persistent storage manager instance which can be used to store data.
      */

package/build/TwoFaLib.mjs

@@ -16,6 +16,16 @@ import StorageOperationsManager from './subclasses/StorageOperationsManager.mjs'
 class TwoFaLib extends TypedEventTarget {
     // TOOD: load this from package.json
     static { this.version = '0.0.1'; }
+    /**
+     * @returns The meta info for this device.
+     */
+    get meta() {
+        return {
+            deviceId: this.favaMeta.deviceId,
+            deviceFriendlyName: this.deviceFriendlyName ?? '',
+            deviceType: this.deviceType,
+        };
+    }
     /**
      * Constructs a new instance of TwoFaLib. If a serverUrl is provided, the library will use it for its sync operations.
      * @param deviceType - The identifier for this device type (e.g. 2fa-cli).
@@ -27,7 +37,7 @@ class TwoFaLib extends TypedEventTarget {
      * @param encryptedSymmetricKey - The encrypted symmetric key
      * @param salt - The salt used for key derivation.
      * @param publicKey - The public key of the device.
-     * @param deviceId - A unique identifier for this device.
+     * @param favaMeta - Meta info containing at least a unique identifier for this device.
      * @param vault - The vault data (entries)
      * @param saveFunction - The function to save the data.
      * @param syncState - The state of the sync, includes the serverUrl
@@ -35,23 +45,27 @@ class TwoFaLib extends TypedEventTarget {
      * @throws {InitializationError} If some parameter has an invalid value
      * @throws {AuthenticationError} If the provided passphrase is incorrect.
      */
-    constructor(deviceType, cryptoLib, passphraseExtraDict, privateKey, symmetricKey, encryptedPrivateKey, encryptedSymmetricKey, salt, publicKey, deviceId, vault, saveFunction, syncState) {
+    constructor(deviceType, cryptoLib, passphraseExtraDict, privateKey, symmetricKey, encryptedPrivateKey, encryptedSymmetricKey, salt, publicKey, favaMeta, vault, saveFunction, syncState) {
         super();
         this.deviceFriendlyName = '';
         if (!deviceType) {
             throw new InitializationError('Device type is required');
         }
-        if (!deviceId) {
+        if (!favaMeta.deviceId) {
             throw new InitializationError('Device id is required');
         }
         if (deviceType.length > 256) {
             throw new InitializationError('Device type is too long, max 256 characters');
         }
+        if (favaMeta.deviceFriendlyName &&
+            favaMeta.deviceFriendlyName.length > 256) {
+            throw new InitializationError('Device friendly name is too long, max 256 characters');
+        }
         if (passphraseExtraDict?.length === 0) {
             throw new InitializationError('Passphrase extra dictionary is required and must contain at least one element (eg phone)');
         }
+        this.favaMeta = favaMeta;
         this.deviceType = deviceType;
-        this.deviceId = deviceId;
         this.publicKey = publicKey;
         this.privateKey = privateKey;
         this.mediator = new TwoFaLibMediator();
@@ -59,7 +73,7 @@ class TwoFaLib extends TypedEventTarget {
             ['libraryLoader', new LibraryLoader(cryptoLib)],
             [
                 'persistentStorageManager',
-                new PersistentStorageManager(this.mediator, passphraseExtraDict, deviceId, privateKey, symmetricKey, encryptedPrivateKey, encryptedSymmetricKey, salt, saveFunction),
+                new PersistentStorageManager(this.mediator, passphraseExtraDict, favaMeta, privateKey, symmetricKey, encryptedPrivateKey, encryptedSymmetricKey, salt, saveFunction),
             ],
             ['vaultDataManager', new VaultDataManager(this.mediator)],
             ['commandManager', new CommandManager(this.mediator)],
@@ -77,7 +91,7 @@ class TwoFaLib extends TypedEventTarget {
         }
         if (syncState?.serverUrl) {
             // Initiate the syncManager
-            this.mediator.registerComponent('syncManager', new SyncManager(this.mediator, this.publicKey, this.privateKey, syncState, this.deviceId));
+            this.mediator.registerComponent('syncManager', new SyncManager(this.mediator, this.publicKey, this.privateKey, this.meta, syncState, this.deviceType));
         }
         else {
             // If no syncmanager we're ready now, otherwise the syncmanager is responsible for emitting the ready event
@@ -147,7 +161,7 @@ class TwoFaLib extends TypedEventTarget {
             devices: [],
             commandSendQueue: [],
         };
-        const newSyncManager = new SyncManager(this.mediator, this.publicKey, this.privateKey, newSyncState, this.deviceId);
+        const newSyncManager = new SyncManager(this.mediator, this.publicKey, this.privateKey, this.meta, newSyncState, this.deviceType);
         const success = await new Promise((resolve) => {
             this.addEventListener(TwoFaLibEvent.ConnectionToSyncServerStatusChanged, (event) => {
                 if (event.detail.newStatus === ConnectionStatus.CONNECTED) {

package/build/interfaces/FavaMeta.d.mts

@@ -0,0 +1,5 @@
+import type { DeviceFriendlyName, DeviceId } from './SyncTypes.mjs';
+export interface FavaMeta {
+    deviceId: DeviceId;
+    deviceFriendlyName?: DeviceFriendlyName;
+}

package/build/interfaces/FavaMeta.mjs

@@ -0,0 +1 @@
+export {};

package/build/interfaces/SaveFunction.d.mts

@@ -1,3 +1,2 @@
 import type { LockedRepresentationString } from './Vault.mjs';
-type SaveFunction = (newLockedRepresentationString: LockedRepresentationString) => Promise<void> | void;
-export default SaveFunction;
+export type SaveFunction = (newLockedRepresentationString: LockedRepresentationString) => Promise<void> | void;

package/build/interfaces/Vault.d.mts

@@ -1,7 +1,7 @@
 import type { Tagged } from 'type-fest';
 import type { Encrypted, EncryptedPrivateKey, EncryptedSymmetricKey, Salt } from './CryptoLib.mjs';
 import type Entry from './Entry.mjs';
-import { DeviceId, SyncDevice } from './SyncTypes.mjs';
+import { DeviceFriendlyName, DeviceId, SyncDevice } from './SyncTypes.mjs';
 import { SyncCommandFromClient } from 'favaserver/ClientMessage';
 export type Vault = Entry[];
 export type EncryptedVaultStateString = Encrypted<VaultStateString>;
@@ -24,6 +24,7 @@ export type VaultSyncStateWithServerUrl = Omit<VaultSyncState, 'serverUrl'> & {
 };
 export interface VaultState {
     deviceId: DeviceId;
+    deviceFriendlyName?: DeviceFriendlyName;
     vault: Vault;
     sync: VaultSyncState;
 }

package/build/main.d.mts

@@ -5,7 +5,7 @@ import type CryptoLib from './interfaces/CryptoLib.mjs';
 import type { Encrypted, EncryptedPrivateKey, EncryptedSymmetricKey, EncryptedPublicKey, PrivateKey, SymmetricKey, PublicKey, Passphrase, Salt } from './interfaces/CryptoLib.mjs';
 import type { PublicSyncDevice, DeviceId, DeviceType, DeviceFriendlyName } from './interfaces/SyncTypes.mjs';
 import type { EncryptedVaultStateString, LockedRepresentationString } from './interfaces/Vault.mjs';
-import type SaveFunction from './interfaces/SaveFunction.mjs';
+import type { SaveFunction } from './interfaces/SaveFunction.mjs';
 import { TwoFALibError, InitializationError, AuthenticationError, EntryNotFoundError, TokenGenerationError } from './TwoFALibError.mjs';
 import { TwoFaLibEvent } from './TwoFaLibEvent.mjs';
 import { getTwoFaLibVaultCreationUtils } from './utils/creationUtils.mjs';

package/build/subclasses/PersistentStorageManager.d.mts

@@ -1,16 +1,16 @@
 import type { EncryptedPrivateKey, EncryptedSymmetricKey, Passphrase, PrivateKey, Salt, SymmetricKey } from '../interfaces/CryptoLib.mjs';
-import { EncryptedVaultStateString } from '../interfaces/Vault.mjs';
+import { EncryptedVaultStateString, LockedRepresentationString } from '../interfaces/Vault.mjs';
 import type TwoFaLibMediator from '../TwoFaLibMediator.mjs';
-import type { DeviceId } from '../interfaces/SyncTypes.mjs';
+import type { FavaMeta } from '../interfaces/FavaMeta.mjs';
 import type { PassphraseExtraDict } from '../interfaces/PassphraseExtraDict.js';
-import SaveFunction from '../interfaces/SaveFunction.mjs';
+import { SaveFunction } from '../interfaces/SaveFunction.mjs';
 /**
  * Manages all storage of data that should be persistent.
  */
 declare class PersistentStorageManager {
     private mediator;
     private readonly passphraseExtraDict;
-    private readonly deviceId;
+    private readonly favaMeta;
     private readonly privateKey;
     private readonly symmetricKey;
     private encryptedPrivateKey;
@@ -23,7 +23,7 @@ declare class PersistentStorageManager {
      * Constructs a new instance of PersistentStorageManager.
      * @param mediator - The mediator for accessing other components.
      * @param passphraseExtraDict - Additional words to be used for passphrase strength evaluation.
-     * @param deviceId - The unique identifier of the device.
+     * @param favaMeta - Meta info containing at least a unique identifier for this device.
      * @param privateKey - The private key used for cryptographic operations.
      * @param symmetricKey - The symmetric key used for cryptographic operations.
      * @param encryptedPrivateKey - The encrypted private key
@@ -31,7 +31,7 @@ declare class PersistentStorageManager {
      * @param salt - The salt used for key derivation.
      * @param saveFunction - The function to save the data.
      */
-    constructor(mediator: TwoFaLibMediator, passphraseExtraDict: PassphraseExtraDict, deviceId: DeviceId, privateKey: PrivateKey, symmetricKey: SymmetricKey, encryptedPrivateKey: EncryptedPrivateKey, encryptedSymmetricKey: EncryptedSymmetricKey, salt: Salt, saveFunction?: SaveFunction | undefined);
+    constructor(mediator: TwoFaLibMediator, passphraseExtraDict: PassphraseExtraDict, favaMeta: FavaMeta, privateKey: PrivateKey, symmetricKey: SymmetricKey, encryptedPrivateKey: EncryptedPrivateKey, encryptedSymmetricKey: EncryptedSymmetricKey, salt: Salt, saveFunction?: SaveFunction | undefined);
     private get cryptoLib();
     private get vaultDataManager();
     private get syncManager();
@@ -49,9 +49,9 @@ declare class PersistentStorageManager {
      * @returns A promise that resolves with a json encoded string of
      * the partially encrypted library's data.
      */
-    private getLockedRepresentation;
+    getLockedRepresentation(): Promise<LockedRepresentationString>;
     /**
-     * Sets the save function for the library. Used for testing.
+     * Sets the save function for the library.
      * @param saveFunction - The save function to set.
      */
     setSaveFunction(saveFunction: SaveFunction): void;

package/build/subclasses/PersistentStorageManager.mjs

@@ -10,7 +10,7 @@ class PersistentStorageManager {
      * Constructs a new instance of PersistentStorageManager.
      * @param mediator - The mediator for accessing other components.
      * @param passphraseExtraDict - Additional words to be used for passphrase strength evaluation.
-     * @param deviceId - The unique identifier of the device.
+     * @param favaMeta - Meta info containing at least a unique identifier for this device.
      * @param privateKey - The private key used for cryptographic operations.
      * @param symmetricKey - The symmetric key used for cryptographic operations.
      * @param encryptedPrivateKey - The encrypted private key
@@ -18,10 +18,10 @@ class PersistentStorageManager {
      * @param salt - The salt used for key derivation.
      * @param saveFunction - The function to save the data.
      */
-    constructor(mediator, passphraseExtraDict, deviceId, privateKey, symmetricKey, encryptedPrivateKey, encryptedSymmetricKey, salt, saveFunction) {
+    constructor(mediator, passphraseExtraDict, favaMeta, privateKey, symmetricKey, encryptedPrivateKey, encryptedSymmetricKey, salt, saveFunction) {
         this.mediator = mediator;
         this.passphraseExtraDict = passphraseExtraDict;
-        this.deviceId = deviceId;
+        this.favaMeta = favaMeta;
         this.privateKey = privateKey;
         this.symmetricKey = symmetricKey;
         this.encryptedPrivateKey = encryptedPrivateKey;
@@ -52,7 +52,8 @@ class PersistentStorageManager {
         const vault = this.vaultDataManager.getAllEntries();
         const vaultState = {
             vault,
-            deviceId: this.deviceId,
+            deviceId: this.favaMeta.deviceId,
+            deviceFriendlyName: this.favaMeta.deviceFriendlyName,
             sync: {
                 // eslint-disable-next-line @typescript-eslint/dot-notation
                 devices: this.syncManager ? this.syncManager['syncDevices'] : [],
@@ -82,7 +83,7 @@ class PersistentStorageManager {
         return JSON.stringify(lockedRepresentation);
     }
     /**
-     * Sets the save function for the library. Used for testing.
+     * Sets the save function for the library.
      * @param saveFunction - The save function to set.
      */
     setSaveFunction(saveFunction) {

package/build/subclasses/StorageOperationsManager.d.mts

@@ -1,5 +1,6 @@
 import type TwoFaLibMediator from '../TwoFaLibMediator.mjs';
 import type { Passphrase } from '../interfaces/CryptoLib.mjs';
+import type { SaveFunction } from '../interfaces/SaveFunction.mjs';
 /**
  * Manages the public operations related to the vault storage
  */
@@ -16,6 +17,7 @@ declare class StorageOperationsManager {
     get persistentStorage(): import("./PersistentStorageManager.mjs").default;
     /**
      * Forces a save.
+     * @returns void
      */
     forceSave(): Promise<void>;
     /**
@@ -26,5 +28,10 @@ declare class StorageOperationsManager {
      * @throws {AuthenticationError} If the provided old passphrase is incorrect.
      */
     changePassphrase(oldPassphrase: Passphrase, newPassphrase: Passphrase): Promise<void>;
+    /**
+     * Sets the save function for the library.
+     * @param saveFunction - The save function to set.
+     */
+    setSaveFunction(saveFunction: SaveFunction): void;
 }
 export default StorageOperationsManager;

package/build/subclasses/StorageOperationsManager.mjs

@@ -17,6 +17,7 @@ class StorageOperationsManager {
     }
     /**
      * Forces a save.
+     * @returns void
      */
     async forceSave() {
         return this.persistentStorage.save();
@@ -31,5 +32,12 @@ class StorageOperationsManager {
     async changePassphrase(oldPassphrase, newPassphrase) {
         return this.persistentStorage.changePassphrase(oldPassphrase, newPassphrase);
     }
+    /**
+     * Sets the save function for the library.
+     * @param saveFunction - The save function to set.
+     */
+    setSaveFunction(saveFunction) {
+        this.persistentStorage.setSaveFunction(saveFunction);
+    }
 }
 export default StorageOperationsManager;

package/build/subclasses/SyncManager.d.mts

@@ -1,8 +1,9 @@
-import { SyncDevice, DeviceId, PublicSyncDevice } from '../interfaces/SyncTypes.mjs';
+import { SyncDevice, PublicSyncDevice, DeviceFriendlyName, DeviceType } from '../interfaces/SyncTypes.mjs';
 import type { PrivateKey, PublicKey } from '../interfaces/CryptoLib.mjs';
 import type Command from '../Command/BaseCommand.mjs';
 import type TwoFaLibMediator from '../TwoFaLibMediator.mjs';
 import { VaultSyncStateWithServerUrl } from '../interfaces/Vault.mjs';
+import type { FavaMeta } from '../interfaces/FavaMeta.mjs';
 import { SyncCommandFromServer } from 'favaserver/ServerMessage';
 import { SyncCommandFromClient } from 'favaserver/ClientMessage';
 export declare enum ConnectionStatus {
@@ -18,18 +19,20 @@ declare class SyncManager {
     private readonly mediator;
     private readonly publicKey;
     private readonly privateKey;
+    private readonly favaMeta;
+    private readonly deviceType;
     private ws?;
     private activeAddDeviceFlow?;
     private readonly reconnectInterval;
     readonly serverUrl: string;
     private syncDevices;
-    deviceId: DeviceId;
     private readyEventEmitted;
     private commandSendQueue;
     private reconnectTimeout?;
     private terminateTimeout?;
     private connectionFailedTimeout?;
     private shouldReconnect;
+    private get deviceId();
     /**
      * Public getter for the command send queue.
      * @returns The command send queue.
@@ -45,11 +48,12 @@ declare class SyncManager {
      * @param mediator - The mediator for accessing other components.
      * @param publicKey - The public key of the device.
      * @param privateKey - The private key of the device.
+     * @param favaMeta - Meta info containing at least a unique identifier for this device.
      * @param syncState - The state of the sync.
-     * @param deviceId - The unique identifier of the device.
+     * @param deviceType - The identifier for this device type (e.g. 2fa-cli).
      * @throws {InitializationError} If initialization fails (e.g., if the server URL is invalid).
      */
-    constructor(mediator: TwoFaLibMediator, publicKey: PublicKey, privateKey: PrivateKey, syncState: VaultSyncStateWithServerUrl, deviceId: DeviceId);
+    constructor(mediator: TwoFaLibMediator, publicKey: PublicKey, privateKey: PrivateKey, favaMeta: FavaMeta, syncState: VaultSyncStateWithServerUrl, deviceType: DeviceType);
     private get libraryLoader();
     private get cryptoLib();
     private get persistentStorageManager();
@@ -173,6 +177,11 @@ declare class SyncManager {
      * Requests a resilver of the vault
      */
     requestResilver(): void;
+    /**
+     * Change the meta of the current device, allows setting a friendly name
+     * @param deviceFriendlyName Human readable name for the device
+     */
+    setDeviceFriendlyName(deviceFriendlyName: DeviceFriendlyName): Promise<void>;
     /**
      * Function to call when the server connection should be closed
      */

package/build/subclasses/SyncManager.mjs

@@ -4,6 +4,7 @@ import { TwoFaLibEvent } from '../TwoFaLibEvent.mjs';
 import { decodeInitiatorData, jsonToUint8Array } from '../utils/syncUtils.mjs';
 import { InitializationError, SyncAddDeviceFlowConflictError, SyncError, SyncInWrongStateError, SyncNoServerConnectionError, TwoFALibError, } from '../TwoFALibError.mjs';
 import AddSyncDeviceCommand from '../Command/commands/AddSyncDeviceCommand.mjs';
+import ChangeSyncDeviceMetaCommand from '../Command/commands/ChangeSyncDeviceMetaCommand.mjs';
 const IN_TESTING = process.env.NODE_ENV === 'test';
 const IN_DEV = process.env.NODE_ENV === 'development';
 export var ConnectionStatus;
@@ -22,6 +23,9 @@ const generateNonCryptographicRandomString = () => {
  * Manages synchronization of 2FA devices and communication with the server.
  */
 class SyncManager {
+    get deviceId() {
+        return this.favaMeta.deviceId;
+    }
     /**
      * Public getter for the command send queue.
      * @returns The command send queue.
@@ -46,14 +50,17 @@ class SyncManager {
      * @param mediator - The mediator for accessing other components.
      * @param publicKey - The public key of the device.
      * @param privateKey - The private key of the device.
+     * @param favaMeta - Meta info containing at least a unique identifier for this device.
      * @param syncState - The state of the sync.
-     * @param deviceId - The unique identifier of the device.
+     * @param deviceType - The identifier for this device type (e.g. 2fa-cli).
      * @throws {InitializationError} If initialization fails (e.g., if the server URL is invalid).
      */
-    constructor(mediator, publicKey, privateKey, syncState, deviceId) {
+    constructor(mediator, publicKey, privateKey, favaMeta, syncState, deviceType) {
         this.mediator = mediator;
         this.publicKey = publicKey;
         this.privateKey = privateKey;
+        this.favaMeta = favaMeta;
+        this.deviceType = deviceType;
         this.reconnectInterval = IN_TESTING ? 100 : 5000; // 5 seconds
         this.readyEventEmitted = false;
         this.commandSendQueue = [];
@@ -64,14 +71,13 @@ class SyncManager {
                 throw new InitializationError('Invalid server URL, protocol must be wss');
             }
         }
-        this.deviceId = deviceId;
         this.syncDevices = devices;
         this.commandSendQueue = commandSendQueue;
         this.serverUrl = serverUrl;
         this.initServerConnection();
         // add ourselves to the list of syncdevices if we're missing
         void this.addSyncDevice({
-            deviceId: deviceId,
+            deviceId: this.favaMeta.deviceId,
             publicKey: this.publicKey,
         }, false);
         // if not yet connected after 2 tries, emit ready event so we can continue
@@ -132,7 +138,8 @@ class SyncManager {
         // eslint-disable-next-line @typescript-eslint/no-this-alias
         const syncManager = this;
         ws.addEventListener('error', (event) => {
-            syncManager.log('warning', `Error in websocket: ${event}`);
+            // eslint-disable-next-line @typescript-eslint/no-base-to-string
+            syncManager.log('warning', `Error in websocket: ${event.toString()}`);
         });
         ws.addEventListener('message', function message(message) {
             try {
@@ -622,6 +629,25 @@ class SyncManager {
             deviceIds: this.syncDevices.map((d) => d.deviceId),
         });
     }
+    /**
+     * Change the meta of the current device, allows setting a friendly name
+     * @param deviceFriendlyName Human readable name for the device
+     */
+    async setDeviceFriendlyName(deviceFriendlyName) {
+        if (deviceFriendlyName.length > 256) {
+            throw new TwoFALibError('Device friendly name is too long, max 256 characters');
+        }
+        if (deviceFriendlyName.length < 1) {
+            throw new TwoFALibError('Device friendly name is too short, min 1 character');
+        }
+        this.favaMeta.deviceFriendlyName = deviceFriendlyName;
+        const newMeta = {
+            deviceId: this.deviceId,
+            newMeta: { deviceType: this.deviceType, deviceFriendlyName },
+        };
+        const command = ChangeSyncDeviceMetaCommand.create(newMeta);
+        await this.commandManager.execute(command);
+    }
     /**
      * Function to call when the server connection should be closed
      */

package/build/utils/creationUtils.d.mts

@@ -6,7 +6,7 @@ import TwoFaLib from '../TwoFaLib.mjs';
 import LibraryLoader from '../subclasses/LibraryLoader.mjs';
 import type { LockedRepresentationString } from '../interfaces/Vault.mjs';
 import type { PassphraseExtraDict } from '../interfaces/PassphraseExtraDict.js';
-import SaveFunction from '../interfaces/SaveFunction.mjs';
+import { SaveFunction } from '../interfaces/SaveFunction.mjs';
 /**
  * Evaluates the strength of a passphrase.
  * @param libraryLoader - An instance of LibraryLoader.

package/build/utils/creationUtils.mjs

@@ -65,7 +65,9 @@ const createNewTwoFaLibVault = async (libraryLoader, deviceType, serverUrl, pass
     const { publicKey, privateKey, symmetricKey, encryptedPrivateKey, encryptedSymmetricKey, salt, } = await cryptoLib.createKeys(passphrase);
     await validatePassphraseStrength(libraryLoader, passphrase, passphraseExtraDict);
     const deviceId = genUuidV4();
-    const twoFaLib = new TwoFaLib(deviceType, cryptoLib, passphraseExtraDict, privateKey, symmetricKey, encryptedPrivateKey, encryptedSymmetricKey, salt, publicKey, deviceId, [], saveFunction, {
+    const twoFaLib = new TwoFaLib(deviceType, cryptoLib, passphraseExtraDict, privateKey, symmetricKey, encryptedPrivateKey, encryptedSymmetricKey, salt, publicKey, {
+        deviceId,
+    }, [], saveFunction, {
         serverUrl,
         devices: [],
         commandSendQueue: [],
@@ -107,7 +109,10 @@ const loadTwoFaLibFromLockedRepesentation = async (libraryLoader, deviceType, pa
         !vaultState.sync?.devices) {
         throw new InitializationError('encryptedVaultState is incomplete or corrupted');
     }
-    return new TwoFaLib(deviceType, cryptoLib, passphraseExtraDict, privateKey, symmetricKey, lockedRepresentation.encryptedPrivateKey, lockedRepresentation.encryptedSymmetricKey, lockedRepresentation.salt, publicKey, vaultState.deviceId, vaultState.vault, saveFunction, vaultState.sync);
+    return new TwoFaLib(deviceType, cryptoLib, passphraseExtraDict, privateKey, symmetricKey, lockedRepresentation.encryptedPrivateKey, lockedRepresentation.encryptedSymmetricKey, lockedRepresentation.salt, publicKey, {
+        deviceId: vaultState.deviceId,
+        deviceFriendlyName: vaultState.deviceFriendlyName,
+    }, vaultState.vault, saveFunction, vaultState.sync);
 };
 /**
  * Returns utility functions useful in creating a new twoFaLib vault

package/build/utils/exportImportUtils.mjs

@@ -162,6 +162,7 @@ export const processImportLines = async (lines, importFromUri) => {
  * @returns A promise that resolves to the encrypted data.
  */
 export const encryptExport = async (openPgpLib, data, password) => {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     const encrypted = await openPgpLib.encrypt({
         message: await openPgpLib.createMessage({ text: data }),
         passwords: [password],

package/build/utils/syncUtils.d.mts

@@ -17,7 +17,7 @@ export declare const decodeInitiatorData: (initiatorData: string | Uint8Array |
  * @param jsonObj - The JSONified Uint8Array to convert.
  * @returns A Uint8Array containing the values of the JSONified Uint8Array.
  */
-export declare const jsonifiedUint8ArraytoUint8Array: (jsonObj: Record<string, number>) => Uint8Array;
+export declare const jsonifiedUint8ArraytoUint8Array: (jsonObj: Record<string, number>) => Uint8Array<ArrayBuffer>;
 /**
  * Converts a JSON object to a record of Uint8Arrays.
  * @param jsonObj - The JSON object to convert.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "favalib",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "",
   "type": "module",
   "exports": {
@@ -28,10 +28,10 @@
     "@types/qrcode": "^1.5.5",
     "@types/uuid": "^10.0.0",
     "@types/whatwg-url": "^13.0.0",
-    "@vitest/coverage-v8": "^3.1.1",
-    "eslint": "^9.24.0",
-    "type-fest": "^4.39.1",
-    "vitest": "^3.1.1",
+    "@vitest/coverage-v8": "^3.1.4",
+    "eslint": "^9.27.0",
+    "type-fest": "^4.41.0",
+    "vitest": "^3.1.4",
     "vitest-websocket-mock": "^0.5.0"
   },
   "dependencies": {
@@ -43,15 +43,15 @@
     "jpake-ts": "^1.0.1",
     "jsqr": "^1.4.0",
     "node-forge": "^1.3.1",
-    "openpgp": "^6.1.0",
+    "openpgp": "^6.1.1",
     "qrcode": "^1.5.4",
     "totp-generator": "^1.0.0",
     "typescript-event-target": "^1.1.1",
     "uint8array-extras": "^1.4.0",
-    "unws": "^0.3.1",
+    "unws": "^0.3.2",
     "uuid": "^11.1.0",
     "whatwg-url": "^14.2.0",
-    "ws": "^8.18.1"
+    "ws": "^8.18.2"
   },
   "engines": {
     "node": ">=20"