favalib 0.0.14 → 0.0.15

package/build/platformProviders/browser/index.mjs

@@ -1,6 +1,7 @@
 import BrowserCryptoLib from './cryptoLib.mjs';
 import { BrowserQrCodeLib } from './qrCodeLib.mjs';
 import { BrowserOpenPgpLib } from './openPgpLib.mjs';
+import { v4 as genUuidV4 } from 'uuid';
 /**
  * Browser-specific platform providers
  */
@@ -9,5 +10,6 @@ export const browserProviders = {
     WebSocketLib: () => WebSocket,
     QrCodeLib: BrowserQrCodeLib,
     OpenPgpLib: BrowserOpenPgpLib,
+    genUuidV4: () => genUuidV4(),
 };
 export default browserProviders;

package/build/platformProviders/browser/qrCodeLib.mjs

@@ -1,4 +1,4 @@
-import { TwoFALibError } from '../../TwoFALibError.mjs';
+import { FavaLibError } from '../../FavaLibError.mjs';
 /**
  * Gets the ImageData from an image, for browser environments.
  * This ImageData is then further processed to get QR codes.
@@ -8,7 +8,7 @@ import { TwoFALibError } from '../../TwoFALibError.mjs';
 export const getImageDataFromInput = (input) => {
     return new Promise((resolve, reject) => {
         if (input instanceof Uint8Array) {
-            reject(new TwoFALibError('Uint8Array input not supported in browser environment'));
+            reject(new FavaLibError('Uint8Array input not supported in browser environment'));
             return;
         }
         const img = new Image();
@@ -18,13 +18,13 @@ export const getImageDataFromInput = (input) => {
             canvas.height = img.height;
             const ctx = canvas.getContext('2d');
             if (!ctx) {
-                reject(new TwoFALibError('Could not create canvas context'));
+                reject(new FavaLibError('Could not create canvas context'));
                 return;
             }
             ctx.drawImage(img, 0, 0);
             resolve(ctx.getImageData(0, 0, img.width, img.height));
         };
-        img.onerror = () => reject(new TwoFALibError('Failed to load image'));
+        img.onerror = () => reject(new FavaLibError('Failed to load image'));
         if (typeof input === 'string') {
             // URL or Data URL
             img.src = input;
@@ -35,7 +35,7 @@ export const getImageDataFromInput = (input) => {
             reader.onload = (e) => {
                 img.src = e.target?.result;
             };
-            reader.onerror = () => reject(new TwoFALibError('Failed to read file'));
+            reader.onerror = () => reject(new FavaLibError('Failed to read file'));
             reader.readAsDataURL(input);
         }
     });

package/build/platformProviders/node/cryptoLib.mjs

@@ -3,7 +3,7 @@ import { promisify } from 'node:util';
 import { generateKeyPair as generateKeyPairCb, generateKey as generateKeyCb, publicEncrypt, privateDecrypt, createPrivateKey, createPublicKey, randomBytes, createCipheriv, createDecipheriv, } from 'node:crypto';
 import { argon2id } from 'hash-wasm';
 import { toUint8Array } from 'uint8array-extras';
-import { CryptoError } from '../../TwoFALibError.mjs';
+import { CryptoError } from '../../FavaLibError.mjs';
 import { generatePasswordHash } from '../browser/cryptoLib.mjs';
 const generateKeyPair = promisify(generateKeyPairCb);
 const generateKey = promisify(generateKeyCb);

package/build/platformProviders/node/index.mjs

@@ -1,6 +1,7 @@
 import NodeCryptoLib from './cryptoLib.mjs';
 import { NodeQrCodeLib } from './qrCodeLib.mjs';
 import { NodeOpenPgpLib } from './openPgpLib.mjs';
+import { v4 as genUuidV4 } from 'uuid';
 /**
  * Node.js-specific platform providers
  */
@@ -9,5 +10,6 @@ export const nodeProviders = {
     WebSocketLib: () => WebSocket,
     QrCodeLib: NodeQrCodeLib,
     OpenPgpLib: NodeOpenPgpLib,
+    genUuidV4: () => genUuidV4(),
 };
 export default nodeProviders;

package/build/platformProviders/node/qrCodeLib.mjs

@@ -1,4 +1,4 @@
-import { TwoFALibError } from '../../TwoFALibError.mjs';
+import { FavaLibError } from '../../FavaLibError.mjs';
 import { isUint8Array } from 'uint8array-extras';
 /**
  * Gets the ImageData from an image, for Node.js environments.
@@ -8,7 +8,7 @@ import { isUint8Array } from 'uint8array-extras';
  */
 export const getImageDataFromInput = async (inputImage) => {
     if (inputImage instanceof File) {
-        throw new TwoFALibError('Getting data from QR where image type is "File" is not supported in the node environment');
+        throw new FavaLibError('Getting data from QR where image type is "File" is not supported in the node environment');
     }
     const canvasLib = await import('canvas');
     const { createCanvas, loadImage } = canvasLib;

package/build/subclasses/CommandManager.d.mts

@@ -1,4 +1,4 @@
-import type TwoFaLibMediator from '../TwoFaLibMediator.mjs';
+import type FavaLibMediator from '../FavaLibMediator.mjs';
 import type Command from '../Command/BaseCommand.mjs';
 import { type SyncCommand } from '../interfaces/CommandTypes.mjs';
 /**
@@ -14,7 +14,7 @@ declare class CommandManager {
      * Constructs a new CommandManager instance.
      * @param mediator - The mediator for accessing other components.
      */
-    constructor(mediator: TwoFaLibMediator);
+    constructor(mediator: FavaLibMediator);
     private get syncManager();
     private get log();
     /**

package/build/subclasses/CommandManager.mjs

@@ -1,4 +1,4 @@
-import { InvalidCommandError } from '../TwoFALibError.mjs';
+import { InvalidCommandError } from '../FavaLibError.mjs';
 import commandConstructors from '../Command/commandConstructors.mjs';
 import CommandQueue from '../Command/CommandQueue.mjs';
 /**

package/build/subclasses/ExportImportManager.d.mts

@@ -1,6 +1,6 @@
 import { EntryId } from '../interfaces/Entry.mjs';
 import type { PasswordExtraDict } from '../interfaces/PasswordExtraDict.js';
-import type TwoFaLibMediator from '../TwoFaLibMediator.mjs';
+import type FavaLibMediator from '../FavaLibMediator.mjs';
 /**
  * Manages the export and import of entries in various formats.
  */
@@ -12,7 +12,7 @@ declare class ExportImportManager {
      * @param mediator - The mediator for accessing other components.
      * @param passwordExtraDict - Additional words to be used for password strength evaluation.
      */
-    constructor(mediator: TwoFaLibMediator, passwordExtraDict: PasswordExtraDict);
+    constructor(mediator: FavaLibMediator, passwordExtraDict: PasswordExtraDict);
     private get libraryLoader();
     private get vaultDataManager();
     private get vaultOperationsManager();

package/build/subclasses/ExportImportManager.mjs

@@ -1,6 +1,6 @@
 import { parseOtpUri, generateHtmlExport, generateTextExport, processImportLines, encryptExport, decryptExport, } from '../utils/exportImportUtils.mjs';
 import { getDataFromQRImage } from '../utils/qrUtils.mjs';
-import { ExportImportError } from '../TwoFALibError.mjs';
+import { ExportImportError } from '../FavaLibError.mjs';
 import { validatePasswordStrength } from '../utils/creationUtils.mjs';
 /**
  * Manages the export and import of entries in various formats.

package/build/subclasses/LibraryLoader.mjs

@@ -1,4 +1,4 @@
-import { InitializationError } from '../TwoFALibError.mjs';
+import { InitializationError } from '../FavaLibError.mjs';
 /**
  * Class responsible for loading various external (big) libraries required by the application.
  * All libraries (except CryptoLib) are loaded on demand. This helps to reduce the initial bundle size.

package/build/subclasses/PersistentStorageManager.d.mts

@@ -1,6 +1,6 @@
 import type { EncryptedPrivateKey, EncryptedSymmetricKey, Password, PrivateKey, Salt, SymmetricKey } from '../interfaces/CryptoLib.mjs';
 import { EncryptedVaultStateString, LockedRepresentationString } from '../interfaces/Vault.mjs';
-import type TwoFaLibMediator from '../TwoFaLibMediator.mjs';
+import type FavaLibMediator from '../FavaLibMediator.mjs';
 import type { FavaMeta } from '../interfaces/FavaMeta.mjs';
 import type { PasswordExtraDict } from '../interfaces/PasswordExtraDict.js';
 import type { SaveFunction } from '../interfaces/SaveFunction.mjs';
@@ -32,7 +32,7 @@ declare class PersistentStorageManager {
      * @param salt - The salt used for key derivation.
      * @param saveFunction - The function to save the data.
      */
-    constructor(mediator: TwoFaLibMediator, passwordExtraDict: PasswordExtraDict, favaMeta: FavaMeta, privateKey: PrivateKey, symmetricKey: SymmetricKey, encryptedPrivateKey: EncryptedPrivateKey, encryptedSymmetricKey: EncryptedSymmetricKey, salt: Salt, saveFunction?: SaveFunction | undefined);
+    constructor(mediator: FavaLibMediator, passwordExtraDict: PasswordExtraDict, favaMeta: FavaMeta, privateKey: PrivateKey, symmetricKey: SymmetricKey, encryptedPrivateKey: EncryptedPrivateKey, encryptedSymmetricKey: EncryptedSymmetricKey, salt: Salt, saveFunction?: SaveFunction | undefined);
     private get cryptoLib();
     private get vaultDataManager();
     private get syncManager();

package/build/subclasses/PersistentStorageManager.mjs

@@ -1,5 +1,5 @@
-import { AuthenticationError } from '../TwoFALibError.mjs';
-import TwoFaLib from '../TwoFaLib.mjs';
+import { AuthenticationError } from '../FavaLibError.mjs';
+import FavaLib from '../FavaLib.mjs';
 import { validatePasswordStrength } from '../utils/creationUtils.mjs';
 /**
  * Manages all storage of data that should be persistent.
@@ -75,7 +75,7 @@ class PersistentStorageManager {
     async getLockedRepresentation() {
         const encryptedVaultState = await this.getEncryptedVaultState();
         const lockedRepresentation = {
-            libVersion: TwoFaLib.version,
+            libVersion: FavaLib.version,
             storageVersion: PersistentStorageManager.storageVersion,
             encryptedPrivateKey: this.encryptedPrivateKey,
             encryptedSymmetricKey: this.encryptedSymmetricKey,

package/build/subclasses/StorageOperationsManager.d.mts

@@ -1,4 +1,4 @@
-import type TwoFaLibMediator from '../TwoFaLibMediator.mjs';
+import type FavaLibMediator from '../FavaLibMediator.mjs';
 import type { Password } from '../interfaces/CryptoLib.mjs';
 import type { SaveFunction } from '../interfaces/SaveFunction.mjs';
 /**
@@ -10,7 +10,7 @@ declare class StorageOperationsManager {
      * Constructs a new instance of StorageOperationsManager.
      * @param mediator - The mediator for accessing other components.
      */
-    constructor(mediator: TwoFaLibMediator);
+    constructor(mediator: FavaLibMediator);
     /**
      * @returns The persistent storage manager instance which can be used to store data.
      */

package/build/subclasses/SyncManager.d.mts

@@ -1,7 +1,7 @@
 import { SyncDevice, PublicSyncDevice, 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 type FavaLibMediator from '../FavaLibMediator.mjs';
 import { VaultSyncStateWithServerUrl } from '../interfaces/Vault.mjs';
 import type { FavaMeta } from '../interfaces/FavaMeta.mjs';
 import { SyncCommandFromServer } from 'favaserver/ServerMessage';
@@ -56,7 +56,7 @@ declare class SyncManager {
      * @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, favaMeta: FavaMeta, syncState: VaultSyncStateWithServerUrl, deviceType: DeviceType);
+    constructor(mediator: FavaLibMediator, publicKey: PublicKey, privateKey: PrivateKey, favaMeta: FavaMeta, syncState: VaultSyncStateWithServerUrl, deviceType: DeviceType);
     private get libraryLoader();
     private get cryptoLib();
     private get persistentStorageManager();

package/build/subclasses/SyncManager.mjs

@@ -1,8 +1,8 @@
 import { base64ToUint8Array, hexToUint8Array, stringToBase64, uint8ArrayToBase64, uint8ArrayToHex, } from 'uint8array-extras';
 import { deriveSFromPassword, JPakeThreePass, } from 'jpake-ts';
-import { TwoFaLibEvent } from '../TwoFaLibEvent.mjs';
+import { FavaLibEvent } from '../FavaLibEvent.mjs';
 import { decodeInitiatorData, jsonToUint8Array } from '../utils/syncUtils.mjs';
-import { InitializationError, SyncAddDeviceFlowConflictError, SyncError, SyncInWrongStateError, SyncNoServerConnectionError, TwoFALibError, } from '../TwoFALibError.mjs';
+import { InitializationError, SyncAddDeviceFlowConflictError, SyncError, SyncInWrongStateError, SyncNoServerConnectionError, FavaLibError, } from '../FavaLibError.mjs';
 import AddSyncDeviceCommand from '../Command/commands/AddSyncDeviceCommand.mjs';
 const IN_TESTING = process.env.NODE_ENV === 'test';
 const IN_DEV = process.env.NODE_ENV === 'development';
@@ -91,8 +91,8 @@ class SyncManager {
         this.connectionFailedTimeout = setTimeout(() => {
             if (!this.readyEventEmitted && !this.webSocketConnected) {
                 this.log('warning', 'Failed to connect to sync backend');
-                this.dispatchLibEvent(TwoFaLibEvent.Ready);
-                this.dispatchLibEvent(TwoFaLibEvent.ConnectionToSyncServerStatusChanged, {
+                this.dispatchLibEvent(FavaLibEvent.Ready);
+                this.dispatchLibEvent(FavaLibEvent.ConnectionToSyncServerStatusChanged, {
                     newStatus: ConnectionStatus.FAILED,
                 });
             }
@@ -168,7 +168,7 @@ class SyncManager {
         ws.addEventListener('open', () => {
             this.log('info', 'Connected to server.');
             this.sendToServer('connect', { deviceId: syncManager.deviceId });
-            this.dispatchLibEvent(TwoFaLibEvent.ConnectionToSyncServerStatusChanged, {
+            this.dispatchLibEvent(FavaLibEvent.ConnectionToSyncServerStatusChanged, {
                 newStatus: ConnectionStatus.CONNECTED,
             });
             clearTimeout(this.connectionFailedTimeout);
@@ -181,7 +181,7 @@ class SyncManager {
     }
     handleWebSocketClose(event) {
         if (this.shouldReconnect) {
-            this.dispatchLibEvent(TwoFaLibEvent.ConnectionToSyncServerStatusChanged, {
+            this.dispatchLibEvent(FavaLibEvent.ConnectionToSyncServerStatusChanged, {
                 newStatus: ConnectionStatus.CONNECTING,
             });
             // if we shouldn't reconnect, this closing is expected
@@ -189,7 +189,7 @@ class SyncManager {
             this.attemptReconnect();
         }
         else {
-            this.dispatchLibEvent(TwoFaLibEvent.ConnectionToSyncServerStatusChanged, {
+            this.dispatchLibEvent(FavaLibEvent.ConnectionToSyncServerStatusChanged, {
                 newStatus: ConnectionStatus.NOT_CONNECTED,
             });
             // Connection closed, no need to force terminate
@@ -292,7 +292,7 @@ class SyncManager {
             // Set a timeout for if we get no response from the server
             const timeout = setTimeout(() => {
                 if (this.activeAddDeviceFlow?.state === 'initiator:initiated') {
-                    reject(new TwoFALibError('Timeout of registerAddDeviceFlowRequest, no response'));
+                    reject(new FavaLibError('Timeout of registerAddDeviceFlowRequest, no response'));
                     this.activeAddDeviceFlow = undefined;
                 }
             }, 10000);
@@ -485,7 +485,7 @@ class SyncManager {
         await this.importVaultState(encryptedVaultState, this.activeAddDeviceFlow.syncKey, this.activeAddDeviceFlow.initiatorDeviceId);
         // Reset the active add device flow
         this.activeAddDeviceFlow = undefined;
-        this.dispatchLibEvent(TwoFaLibEvent.ConnectToExistingVaultFinished);
+        this.dispatchLibEvent(FavaLibEvent.ConnectToExistingVaultFinished);
     }
     async importVaultState(encryptedVaultState, symmetricKey, expectedDeviceId) {
         const vaultState = JSON.parse(await this.cryptoLib.decryptSymmetric(symmetricKey, encryptedVaultState));
@@ -521,7 +521,7 @@ class SyncManager {
         });
         // Reset the active add device flow
         this.activeAddDeviceFlow = undefined;
-        this.dispatchLibEvent(TwoFaLibEvent.ConnectToExistingVaultFinished);
+        this.dispatchLibEvent(FavaLibEvent.ConnectToExistingVaultFinished);
     }
     /**
      * Sends a command to the server to synchronize with other devices.
@@ -599,7 +599,7 @@ class SyncManager {
         // we can signal that we're done loading after the commands where processed
         if (!this.readyEventEmitted) {
             this.readyEventEmitted = true;
-            this.dispatchLibEvent(TwoFaLibEvent.Ready);
+            this.dispatchLibEvent(FavaLibEvent.Ready);
         }
         if (commandsExecutedIds.length > 0) {
             this.sendToServer('syncCommandsExecuted', {

package/build/subclasses/VaultDataManager.d.mts

@@ -1,6 +1,6 @@
 import type Entry from '../interfaces/Entry.mjs';
 import type { EntryId, Token } from '../interfaces/Entry.mjs';
-import type TwoFaLibMediator from '../TwoFaLibMediator.mjs';
+import type FavaLibMediator from '../FavaLibMediator.mjs';
 import { Vault } from '../interfaces/Vault.mjs';
 /**
  * Manages the data within the vault. This class should only be used internally
@@ -13,7 +13,7 @@ declare class VaultDataManager {
      * Constructs a new VaultDataManager instance.
      * @param mediator - The mediator for accessing other components.
      */
-    constructor(mediator: TwoFaLibMediator);
+    constructor(mediator: FavaLibMediator);
     private get persistentStorageManager();
     private get dispatchLibEvent();
     /**

package/build/subclasses/VaultDataManager.mjs

@@ -1,6 +1,6 @@
 import { TOTP } from 'totp-generator';
-import { EntryNotFoundError, TokenGenerationError } from '../TwoFALibError.mjs';
-import { TwoFaLibEvent } from '../TwoFaLibEvent.mjs';
+import { EntryNotFoundError, TokenGenerationError } from '../FavaLibError.mjs';
+import { FavaLibEvent } from '../FavaLibEvent.mjs';
 import { SUPPORTED_ALGORITHMS, } from '../utils/constants.mjs';
 /**
  * Manages the data within the vault. This class should only be used internally
@@ -84,7 +84,7 @@ class VaultDataManager {
             return;
         }
         this.vault.push(entry);
-        this.dispatchLibEvent(TwoFaLibEvent.Changed);
+        this.dispatchLibEvent(FavaLibEvent.Changed);
         if (saveAfter) {
             await this.persistentStorageManager.save();
         }
@@ -99,7 +99,7 @@ class VaultDataManager {
         if (index === -1)
             throw new EntryNotFoundError('Entry not found');
         this.vault.splice(index, 1);
-        this.dispatchLibEvent(TwoFaLibEvent.Changed);
+        this.dispatchLibEvent(FavaLibEvent.Changed);
         await this.persistentStorageManager.save();
     }
     /**
@@ -114,7 +114,7 @@ class VaultDataManager {
         if (index === -1)
             throw new EntryNotFoundError('Entry not found');
         this.vault[index] = updatedEntry;
-        this.dispatchLibEvent(TwoFaLibEvent.Changed);
+        this.dispatchLibEvent(FavaLibEvent.Changed);
         await this.persistentStorageManager.save();
     }
     /**
@@ -123,7 +123,7 @@ class VaultDataManager {
      */
     replaceVault(newVault) {
         this.vault = newVault;
-        this.dispatchLibEvent(TwoFaLibEvent.Changed);
+        this.dispatchLibEvent(FavaLibEvent.Changed);
     }
 }
 export default VaultDataManager;

package/build/subclasses/VaultOperationsManager.d.mts

@@ -1,16 +1,17 @@
 import type Entry from '../interfaces/Entry.mjs';
 import type { EntryId, EntryMeta, EntryMetaWithToken, NewEntry, Token } from '../interfaces/Entry.mjs';
-import type TwoFaLibMediator from '../TwoFaLibMediator.mjs';
+import type FavaLibMediator from '../FavaLibMediator.mjs';
 /**
  * Manages the public operations related to the vault, including adding, deleting, and updating entries.
  */
 declare class VaultOperationsManager {
     private readonly mediator;
+    private get platformProviders();
     /**
      * Constructs a new instance of VaultManager.
      * @param mediator - The mediator for accessing other components.
      */
-    constructor(mediator: TwoFaLibMediator);
+    constructor(mediator: FavaLibMediator);
     private get vaultDataManager();
     private get commandManager();
     /**

package/build/subclasses/VaultOperationsManager.mjs

@@ -1,8 +1,7 @@
-import { v4 as genUuidV4 } from 'uuid';
 import AddEntryCommand from '../Command/commands/AddEntryCommand.mjs';
 import DeleteEntryCommand from '../Command/commands/DeleteEntryCommand.mjs';
 import UpdateEntryCommand from '../Command/commands/UpdateEntryCommand.mjs';
-import { EntryNotFoundError } from '../TwoFALibError.mjs';
+import { EntryNotFoundError } from '../FavaLibError.mjs';
 const getMetaForEntry = (entry) => ({
     id: entry.id,
     name: entry.name,
@@ -15,6 +14,9 @@ const getMetaForEntry = (entry) => ({
  * Manages the public operations related to the vault, including adding, deleting, and updating entries.
  */
 class VaultOperationsManager {
+    get platformProviders() {
+        return this.mediator.getComponent('libraryLoader').getPlatformProviders();
+    }
     /**
      * Constructs a new instance of VaultManager.
      * @param mediator - The mediator for accessing other components.
@@ -117,7 +119,7 @@ class VaultOperationsManager {
      * @throws {InvalidCommandError} If the provided entry data is invalid or incomplete.
      */
     async addEntry(entry) {
-        const newId = genUuidV4();
+        const newId = this.platformProviders.genUuidV4();
         const newEntry = {
             ...entry,
             id: newId,

package/build/utils/creationUtils.d.mts

@@ -2,7 +2,7 @@ import type { ZxcvbnResult } from '@zxcvbn-ts/core';
 import type { PlatformProviders } from '../interfaces/PlatformProviders.mjs';
 import type { Password } from '../interfaces/CryptoLib.mjs';
 import type { DeviceType } from '../interfaces/SyncTypes.mjs';
-import TwoFaLib from '../TwoFaLib.mjs';
+import FavaLib from '../FavaLib.mjs';
 import LibraryLoader from '../subclasses/LibraryLoader.mjs';
 import type { LockedRepresentationString } from '../interfaces/Vault.mjs';
 import type { PasswordExtraDict } from '../interfaces/PasswordExtraDict.js';
@@ -24,22 +24,22 @@ export declare const getPasswordStrength: (libraryLoader: LibraryLoader, passwor
  */
 export declare const validatePasswordStrength: (libraryLoader: LibraryLoader, passwordExtraDict: PasswordExtraDict, password: Password) => Promise<void>;
 /**
- * Returns utility functions useful in creating a new twoFaLib vault
+ * Returns utility functions useful in creating a new favaLib vault
  * @param platformProviders - The platform-specific providers containing CryptoLib and other providers.
  * @param deviceType - A unique identifier for this device type (e.g. 2fa-cli).
  * @param passwordExtraDict - Additional words to be used for password strength evaluation.
  * @param saveFunction - The function to save the data.
  * @param serverUrl - The server URL for syncing.
- * @returns An object with methods to evaluate password strength and create a new TwoFaLib vault.
+ * @returns An object with methods to evaluate password strength and create a new FavaLib vault.
  */
-export declare const getTwoFaLibVaultCreationUtils: (platformProviders: PlatformProviders, deviceType: DeviceType, passwordExtraDict: PasswordExtraDict, saveFunction?: SaveFunction, serverUrl?: string) => {
+export declare const getFavaLibVaultCreationUtils: (platformProviders: PlatformProviders, deviceType: DeviceType, passwordExtraDict: PasswordExtraDict, saveFunction?: SaveFunction, serverUrl?: string) => {
     getPasswordStrength: (password: Password) => Promise<ZxcvbnResult>;
-    createNewTwoFaLibVault: (password: Password) => Promise<{
-        twoFaLib: TwoFaLib;
+    createNewFavaLibVault: (password: Password) => Promise<{
+        favaLib: FavaLib;
         publicKey: import("../interfaces/CryptoLib.mjs").PublicKey;
         encryptedPrivateKey: import("../interfaces/CryptoLib.mjs").EncryptedPrivateKey;
         encryptedSymmetricKey: import("../interfaces/CryptoLib.mjs").EncryptedSymmetricKey;
         salt: import("../interfaces/CryptoLib.mjs").Salt;
     }>;
-    loadTwoFaLibFromLockedRepesentation: (lockedRepresentationString: LockedRepresentationString, password: Password) => Promise<TwoFaLib>;
+    loadFavaLibFromLockedRepesentation: (lockedRepresentationString: LockedRepresentationString, password: Password) => Promise<FavaLib>;
 };

package/build/utils/creationUtils.mjs

@@ -1,6 +1,5 @@
-import { v4 as genUuidV4 } from 'uuid';
-import TwoFaLib from '../TwoFaLib.mjs';
-import { InitializationError, TwoFALibError } from '../TwoFALibError.mjs';
+import FavaLib from '../FavaLib.mjs';
+import { InitializationError, FavaLibError } from '../FavaLibError.mjs';
 import LibraryLoader from '../subclasses/LibraryLoader.mjs';
 /**
  * Evaluates the strength of a password.
@@ -47,26 +46,26 @@ export const getPasswordStrength = async (libraryLoader, passwordExtraDict, pass
 export const validatePasswordStrength = async (libraryLoader, passwordExtraDict, password) => {
     const passwordStrength = await getPasswordStrength(libraryLoader, passwordExtraDict, password);
     if (passwordStrength.score < 3) {
-        throw new TwoFALibError('Password is too weak');
+        throw new FavaLibError('Password is too weak');
     }
 };
 /**
- * Creates a new TwoFaLib vault.
+ * Creates a new FavaLib vault.
  * @param libraryLoader - An instance of LibraryLoader.
  * @param deviceType - A unique identifier for the device type e.g. 2fa-cli.
  * @param serverUrl - The server URL for syncing.
  * @param passwordExtraDict - Additional words to be used for password strength evaluation.
  * @param saveFunction - The function to save the data.
  * @param password - The password to be used to encrypt the private key.
- * @returns Promise resolving to an object containing the newly created TwoFaLib instance and related data.
+ * @returns Promise resolving to an object containing the newly created FavaLib instance and related data.
  */
-const createNewTwoFaLibVault = async (libraryLoader, deviceType, serverUrl, passwordExtraDict, saveFunction, password) => {
+const createNewFavaLibVault = async (libraryLoader, deviceType, serverUrl, passwordExtraDict, saveFunction, password) => {
     const cryptoLib = libraryLoader.getCryptoLib();
     const platformProviders = libraryLoader.getPlatformProviders();
     const { publicKey, privateKey, symmetricKey, encryptedPrivateKey, encryptedSymmetricKey, salt, } = await cryptoLib.createKeys(password);
     await validatePasswordStrength(libraryLoader, passwordExtraDict, password);
-    const deviceId = genUuidV4();
-    const twoFaLib = new TwoFaLib(deviceType, platformProviders, passwordExtraDict, privateKey, symmetricKey, encryptedPrivateKey, encryptedSymmetricKey, salt, publicKey, {
+    const deviceId = platformProviders.genUuidV4();
+    const favaLib = new FavaLib(deviceType, platformProviders, passwordExtraDict, privateKey, symmetricKey, encryptedPrivateKey, encryptedSymmetricKey, salt, publicKey, {
         deviceId,
     }, [], saveFunction, {
         serverUrl,
@@ -74,7 +73,7 @@ const createNewTwoFaLibVault = async (libraryLoader, deviceType, serverUrl, pass
         commandSendQueue: [],
     });
     return {
-        twoFaLib,
+        favaLib,
         publicKey,
         encryptedPrivateKey,
         encryptedSymmetricKey,
@@ -92,7 +91,7 @@ const createNewTwoFaLibVault = async (libraryLoader, deviceType, serverUrl, pass
  * @returns A promise that resolves when loading is complete.
  * @throws {InitializationError} If loading fails due to invalid or corrupted data.
  */
-const loadTwoFaLibFromLockedRepesentation = async (libraryLoader, deviceType, passwordExtraDict, saveFunction, lockedRepresentationString, password) => {
+const loadFavaLibFromLockedRepesentation = async (libraryLoader, deviceType, passwordExtraDict, saveFunction, lockedRepresentationString, password) => {
     const cryptoLib = libraryLoader.getCryptoLib();
     const platformProviders = libraryLoader.getPlatformProviders();
     const lockedRepresentation = JSON.parse(lockedRepresentationString);
@@ -111,25 +110,25 @@ const loadTwoFaLibFromLockedRepesentation = async (libraryLoader, deviceType, pa
         !vaultState.sync?.devices) {
         throw new InitializationError('encryptedVaultState is incomplete or corrupted');
     }
-    return new TwoFaLib(deviceType, platformProviders, passwordExtraDict, privateKey, symmetricKey, lockedRepresentation.encryptedPrivateKey, lockedRepresentation.encryptedSymmetricKey, lockedRepresentation.salt, publicKey, {
+    return new FavaLib(deviceType, platformProviders, passwordExtraDict, 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
+ * Returns utility functions useful in creating a new favaLib vault
  * @param platformProviders - The platform-specific providers containing CryptoLib and other providers.
  * @param deviceType - A unique identifier for this device type (e.g. 2fa-cli).
  * @param passwordExtraDict - Additional words to be used for password strength evaluation.
  * @param saveFunction - The function to save the data.
  * @param serverUrl - The server URL for syncing.
- * @returns An object with methods to evaluate password strength and create a new TwoFaLib vault.
+ * @returns An object with methods to evaluate password strength and create a new FavaLib vault.
  */
-export const getTwoFaLibVaultCreationUtils = (platformProviders, deviceType, passwordExtraDict, saveFunction, serverUrl) => {
+export const getFavaLibVaultCreationUtils = (platformProviders, deviceType, passwordExtraDict, saveFunction, serverUrl) => {
     const libraryLoader = new LibraryLoader(platformProviders);
     return {
         getPasswordStrength: getPasswordStrength.bind(null, libraryLoader, passwordExtraDict),
-        createNewTwoFaLibVault: createNewTwoFaLibVault.bind(null, libraryLoader, deviceType, serverUrl, passwordExtraDict, saveFunction),
-        loadTwoFaLibFromLockedRepesentation: loadTwoFaLibFromLockedRepesentation.bind(null, libraryLoader, deviceType, passwordExtraDict, saveFunction),
+        createNewFavaLibVault: createNewFavaLibVault.bind(null, libraryLoader, deviceType, serverUrl, passwordExtraDict, saveFunction),
+        loadFavaLibFromLockedRepesentation: loadFavaLibFromLockedRepesentation.bind(null, libraryLoader, deviceType, passwordExtraDict, saveFunction),
     };
 };

package/build/utils/exportImportUtils.mjs

@@ -1,4 +1,4 @@
-import { ExportImportError } from '../TwoFALibError.mjs';
+import { ExportImportError } from '../FavaLibError.mjs';
 /**
  * Determines the hashing algorithm based on the input string.
  * @param alg - The algorithm string to parse.

package/build/utils/qrUtils.mjs

@@ -1,4 +1,4 @@
-import { TwoFALibError } from '../TwoFALibError.mjs';
+import { FavaLibError } from '../FavaLibError.mjs';
 /**
  * Import an entry from a QR code image.
  * @param libraryLoader - An instance of LibraryLoader.
@@ -12,7 +12,7 @@ export const getDataFromQRImage = async (libraryLoader, imageInput) => {
     const imageData = await qrLib.getImageDataFromInput(imageInput);
     const qrCodeResult = jsQr(imageData.data, imageData.width, imageData.height);
     if (!qrCodeResult) {
-        throw new TwoFALibError("Couldn't read QR code data from image");
+        throw new FavaLibError("Couldn't read QR code data from image");
     }
     return qrCodeResult.data;
 };

package/build/utils/syncUtils.mjs

@@ -1,5 +1,5 @@
 import { base64ToString } from 'uint8array-extras';
-import { SyncError } from '../TwoFALibError.mjs';
+import { SyncError } from '../FavaLibError.mjs';
 /**
  * Decodes the initiator data from a string or QR code.
  * @param initiatorData - The initiator data to decode.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "favalib",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "description": "",
   "type": "module",
   "exports": {
@@ -31,6 +31,7 @@
     "@vitest/coverage-v8": "^3.1.4",
     "eslint": "^9.27.0",
     "type-fest": "^4.41.0",
+    "typedoc": "^0.27.8",
     "vitest": "^3.1.4",
     "vitest-websocket-mock": "^0.5.0"
   },

package/build/TwoFaLibEvent.mjs

@@ -1,9 +0,0 @@
-export var TwoFaLibEvent;
-(function (TwoFaLibEvent) {
-    TwoFaLibEvent["Changed"] = "changed";
-    TwoFaLibEvent["LoadedFromLockedRepresentation"] = "loadedFromLockedRepresentation";
-    TwoFaLibEvent["ConnectToExistingVaultFinished"] = "connectToExistingVaultFinished";
-    TwoFaLibEvent["ConnectionToSyncServerStatusChanged"] = "connectionToSyncServerStatusChanged";
-    TwoFaLibEvent["Log"] = "log";
-    TwoFaLibEvent["Ready"] = "ready";
-})(TwoFaLibEvent || (TwoFaLibEvent = {}));