@arex95/vue-core 1.1.29 → 1.1.30

package/dist/composables/auth/useAuth.d.ts

@@ -1,5 +1,4 @@
-import { AuthParams, AuthResponse, AuthTokenPaths } from "@/types";
-import { SessionPreference } from "@config/global/sessionConfig";
+import { AuthParams, AuthResponse, AuthTokenPaths, SessionPreference } from "@/types";
 /**
  * @typedef {object} AuthHook
  * @property {function(): Promise<number | null>} getTokenExpiry - Retrieves the expiration time of the current token in milliseconds.
@@ -9,7 +8,7 @@ import { SessionPreference } from "@config/global/sessionConfig";
  * @property {(tokenPaths?: AuthTokenPaths) => Promise<AuthResponse>} refresh - Refreshes authentication tokens.
  * @property {function(): Promise<boolean>} verifyAuth - Verifies the validity and expiration of the current authentication token.
  * @property {(preference: SessionPreference) => void} setSessionPersistencePreference - Sets the user's preferred storage for authentication data.
- * @property {function(): SessionPreference} getSessionPersistencePreference - Retrieves the user's current preferred storage for authentication data.
+ * @property {function(): SessionPreference} getSessionPersistence - Retrieves the user's current preferred storage for authentication data.
  */
 /**
  * Custom hook for authentication logic, including login, logout, token management, and session preference.

package/dist/config/global/sessionConfig.d.ts

@@ -1,49 +1,34 @@
-export type SessionPreference = "local" | "session";
+import { SessionPreference, SessionConfigObject, SessionConfig } from "@/types/SessionConfig";
 /**
- * Configuration object for the session.
- */
-interface SessionConfigObject {
-    /** The unique session identifier. */
-    sessionId?: string;
-    /** The storage preference: 'local' for localStorage, 'session' for sessionStorage. */
-    persistencePreference?: SessionPreference;
-}
-/**
- * Loads the session configuration from storage (local or session).
- * This should be called once when the application initializes.
- */
-export declare function loadSessionConfigFromStorage(): Promise<void>;
-/**
- * Configures the session identifier and/or the data persistence preference for the active browser session.
- * Once configured, the session ID cannot be modified. The persistence preference can be updated.
+ * Configures the session identifier and/or data persistence preference
+ * for the active browser session.
  *
- * @param {SessionConfigObject} config - An object containing the unique session identifier and/or persistence preference.
+ * This function is asynchronous because it will always attempt to load the current configuration
+ * before applying changes and then saving them.
  *
- * @returns {void} Does not return anything, but freezes the session configuration (for ID) and updates preference.
+ * @param {SessionConfigObject} config - An object containing the unique session identifier and/or
+ * the persistence preference.
+ * @returns {Promise<void>} A promise that resolves when the session has been configured and saved.
  */
-export declare function configSession(config: SessionConfigObject): void;
+export declare function configSession(config: SessionConfigObject): Promise<void>;
 /**
- * Retrieves the current session identifier configuration.
+ * Retrieves the current session identifier.
+ * Always attempts to load the configuration from storage. If it fails, it uses the internal state.
  *
- * @returns {string} The unique session identifier.
+ * @returns {Promise<string>} A promise that resolves with the unique session identifier.
  */
-export declare function getSessionConfig(): string;
+export declare function getSessionId(): Promise<string>;
 /**
  * Retrieves the current data persistence preference.
+ * Always attempts to load the configuration from storage. If it fails, it uses the internal state.
  *
- * @returns {SessionPreference} The configured persistence preference ('local' or 'session').
+ * @returns {Promise<SessionPreference>} A promise that resolves with the configured persistence preference ('local' or 'session').
  */
-export declare function getSessionPersistencePreference(): SessionPreference;
+export declare function getSessionPersistence(): Promise<SessionPreference>;
 /**
- * Generates a new UUID for the current session.
- *
- * @returns {void} Does not return anything, but updates the session identifier.
- */
-export declare function regenerateSessionId(): void;
-/**
- * Retrieves the current session identifier.
+ * Retrieves the complete session configuration.
+ * Always attempts to load the configuration from storage. If it fails, it uses the internal state.
  *
- * @returns {string} The unique session identifier.
+ * @returns {Promise<SessionConfig>} A promise that resolves with the session configuration object.
  */
-export declare function getSessionId(): string;
-export {};
+export declare function getSessionConfig(): Promise<SessionConfig>;

package/dist/index.mjs

@@ -933,106 +933,109 @@ function getAppKey() {
     return appKey;
 }
 
-let sessionId = v4();
-let sessionConfig = Object.freeze({
-    SESSION_ID: sessionId,
+const SESSION_KEY = "session_config_";
+const internalSessionState = {
+    sessionId: v4(),
+    persistencePreference: "session",
+};
+let _sessionConfig = Object.freeze({
+    SESSION_ID: internalSessionState.sessionId,
+    PERSISTENCE: internalSessionState.persistencePreference,
 });
-let persistencePreference = "session";
 /**
- * Loads the session configuration from storage (local or session).
- * This should be called once when the application initializes.
+ * Updates the immutable `_sessionConfig` object with the current state of `internalSessionState`
+ * and freezes it.
  */
-async function loadSessionConfigFromStorage() {
-    const isPersistent = persistencePreference === "local";
-    const storedConfig = await getDecryptedItem("sessionConfig", getAppKey(), isPersistent);
-    if (storedConfig) {
-        try {
-            const parsedConfig = JSON.parse(storedConfig);
-            sessionConfig = Object.freeze({
-                ...sessionConfig,
-                ...parsedConfig,
-            });
-            if (parsedConfig.SESSION_ID) {
-                sessionId = parsedConfig.SESSION_ID;
-            }
-        }
-        catch (error) {
-            console.error("Error parsing stored session config:", error);
-            regenerateSessionId();
-        }
-    }
-    else {
-        regenerateSessionId();
-    }
-    await saveSessionConfigToStorage();
+function updateSessionConfig() {
+    _sessionConfig = Object.freeze({
+        SESSION_ID: internalSessionState.sessionId,
+        PERSISTENCE: internalSessionState.persistencePreference,
+    });
 }
 /**
  * Saves the current session configuration to local or session storage.
+ * @returns {Promise<void>} A promise that resolves when the session configuration has been saved.
  */
-async function saveSessionConfigToStorage() {
-    const isPersistent = persistencePreference === "local";
+async function saveSessionConfig() {
+    const isPersistent = internalSessionState.persistencePreference === "local";
     try {
-        await storeEncryptedItem("sessionConfig", JSON.stringify(sessionConfig), getAppKey(), isPersistent);
+        await storeEncryptedItem(SESSION_KEY, JSON.stringify(_sessionConfig), getAppKey(), isPersistent);
     }
     catch (error) {
-        console.error("Error saving session config to storage:", error);
+        console.error("Error saving session configuration to storage:", error);
     }
 }
 /**
- * Configures the session identifier and/or the data persistence preference for the active browser session.
- * Once configured, the session ID cannot be modified. The persistence preference can be updated.
- *
- * @param {SessionConfigObject} config - An object containing the unique session identifier and/or persistence preference.
+ * Attempts to load the configuration from storage.
+ * If it fails or is not found, `internalSessionState` will retain its current values (initial or last configured).
+ * Then, it updates `_sessionConfig`.
  *
- * @returns {void} Does not return anything, but freezes the session configuration (for ID) and updates preference.
- */
-function configSession(config) {
-    let updatedConfig = { ...sessionConfig };
-    if (config.sessionId && sessionConfig.SESSION_ID === sessionId) {
-        updatedConfig = {
-            ...updatedConfig,
-            SESSION_ID: config.sessionId,
-        };
-        sessionId = config.sessionId;
+ * @returns {Promise<void>} A promise that resolves when the state has been loaded and updated.
+ */
+async function loadSessionConfig() {
+    try {
+        const storedConfig = await getDecryptedItem(SESSION_KEY, getAppKey(), true);
+        if (storedConfig) {
+            const parsedConfig = JSON.parse(storedConfig);
+            internalSessionState.sessionId = parsedConfig.SESSION_ID;
+            internalSessionState.persistencePreference = parsedConfig.PERSISTENCE;
+            updateSessionConfig();
+        }
     }
-    if (config.persistencePreference) {
-        persistencePreference = config.persistencePreference;
+    catch (error) {
+        console.warn(`Error loading or parsing from storage`, error);
     }
-    sessionConfig = Object.freeze(updatedConfig);
-    saveSessionConfigToStorage();
 }
 /**
- * Retrieves the current session identifier configuration.
+ * Configures the session identifier and/or data persistence preference
+ * for the active browser session.
  *
- * @returns {string} The unique session identifier.
+ * This function is asynchronous because it will always attempt to load the current configuration
+ * before applying changes and then saving them.
+ *
+ * @param {SessionConfigObject} config - An object containing the unique session identifier and/or
+ * the persistence preference.
+ * @returns {Promise<void>} A promise that resolves when the session has been configured and saved.
  */
-function getSessionConfig() {
-    return sessionConfig.SESSION_ID;
+async function configSession(config) {
+    if (config.sessionId) {
+        internalSessionState.sessionId = config.sessionId;
+    }
+    if (config.persistencePreference) {
+        internalSessionState.persistencePreference = config.persistencePreference;
+    }
+    updateSessionConfig();
+    await saveSessionConfig();
 }
 /**
- * Retrieves the current data persistence preference.
+ * Retrieves the current session identifier.
+ * Always attempts to load the configuration from storage. If it fails, it uses the internal state.
  *
- * @returns {SessionPreference} The configured persistence preference ('local' or 'session').
+ * @returns {Promise<string>} A promise that resolves with the unique session identifier.
  */
-function getSessionPersistencePreference() {
-    return persistencePreference;
+async function getSessionId() {
+    await loadSessionConfig();
+    return _sessionConfig.SESSION_ID;
 }
 /**
- * Generates a new UUID for the current session.
+ * Retrieves the current data persistence preference.
+ * Always attempts to load the configuration from storage. If it fails, it uses the internal state.
  *
- * @returns {void} Does not return anything, but updates the session identifier.
+ * @returns {Promise<SessionPreference>} A promise that resolves with the configured persistence preference ('local' or 'session').
  */
-function regenerateSessionId() {
-    sessionId = v4();
-    configSession({ sessionId: sessionId });
+async function getSessionPersistence() {
+    await loadSessionConfig();
+    return _sessionConfig.PERSISTENCE;
 }
 /**
- * Retrieves the current session identifier.
+ * Retrieves the complete session configuration.
+ * Always attempts to load the configuration from storage. If it fails, it uses the internal state.
  *
- * @returns {string} The unique session identifier.
+ * @returns {Promise<SessionConfig>} A promise that resolves with the session configuration object.
  */
-function getSessionId() {
-    return sessionId;
+async function getSessionConfig() {
+    await loadSessionConfig();
+    return _sessionConfig;
 }
 
 /**
@@ -2765,44 +2768,42 @@ const storeAuthRefreshToken = async (token, secretKey, preference) => {
  * Verifies the validity and expiration of the current authentication token.
  * If the token is missing, invalid, or expired, appropriate errors are thrown and credentials are cleaned.
  *
- * @param {string} secretKey - The secret key used for token decryption.
- * @param {SessionPreference} preference - The current session persistence preference.
  * @returns {Promise<boolean>} True if the token is valid and unexpired.
  * @throws {Error} "TOKEN_MISSING" if no token is found, "TOKEN_EXPIRED" if the token has expired,
  * "TOKEN_INVALID" if the token format is invalid.
  */
 const verifyAuth = async () => {
-    const preference = getSessionPersistencePreference();
+    const sessionPersistence = await getSessionPersistence();
+    const handleAuthError = async (message, shouldClean = true) => {
+        handleError(message, false);
+        if (shouldClean) {
+            await cleanCredentials(sessionPersistence);
+        }
+        return false;
+    };
     try {
-        const token = await getAuthToken(getAppKey(), preference);
+        const token = await getAuthToken(getAppKey(), sessionPersistence);
         if (!token) {
-            handleError("TOKEN_MISSING: No valid token found", false);
-            await cleanCredentials(preference);
-            return false;
+            return await handleAuthError("TOKEN_MISSING: No valid token found");
+        }
+        let decoded;
+        try {
+            decoded = jwtDecode(token);
+        }
+        catch (decodeError) {
+            return await handleAuthError("TOKEN_INVALID: Invalid token format");
         }
-        const decoded = jwtDecode(token);
         const currentTime = Date.now() / 1000;
         if (typeof decoded.exp !== "number") {
-            handleError("TOKEN_INVALID: Invalid expiration format", false);
-            await cleanCredentials(preference);
-            return false;
+            return await handleAuthError("TOKEN_INVALID: Invalid expiration format");
         }
         if (decoded.exp <= currentTime) {
-            handleError("TOKEN_EXPIRED: Token is expired", false);
-            await cleanCredentials(preference);
-            return false;
+            return await handleAuthError("TOKEN_EXPIRED: Token is expired");
         }
         return true;
     }
     catch (error) {
-        if (error instanceof Error && error.message.includes("Invalid")) {
-            handleError("TOKEN_INVALID: Invalid token format", false);
-            await cleanCredentials(preference);
-            return false;
-        }
-        handleError("AUTH_ERROR: An unexpected error occurred", false);
-        await cleanCredentials(preference);
-        return false;
+        return await handleAuthError("AUTH_ERROR: An unexpected error occurred", true);
     }
 };
 
@@ -3366,7 +3367,7 @@ function useSorter(items, criteriaList, selectedCriteria) {
  * @property {(tokenPaths?: AuthTokenPaths) => Promise<AuthResponse>} refresh - Refreshes authentication tokens.
  * @property {function(): Promise<boolean>} verifyAuth - Verifies the validity and expiration of the current authentication token.
  * @property {(preference: SessionPreference) => void} setSessionPersistencePreference - Sets the user's preferred storage for authentication data.
- * @property {function(): SessionPreference} getSessionPersistencePreference - Retrieves the user's current preferred storage for authentication data.
+ * @property {function(): SessionPreference} getSessionPersistence - Retrieves the user's current preferred storage for authentication data.
  */
 /**
  * Custom hook for authentication logic, including login, logout, token management, and session preference.
@@ -3377,7 +3378,6 @@ function useSorter(items, criteriaList, selectedCriteria) {
 function useAuth(secretKey = getAppKey()) {
     const axiosInstance = getAxiosInstance();
     const endpoints = getEndpointsConfig();
-    const currentPersistencePreference = getSessionPersistencePreference();
     /**
      * Logs out the user by making a POST request to the logout endpoint,
      * cleaning all stored credentials, and reloading the page.
@@ -3394,7 +3394,7 @@ function useAuth(secretKey = getAppKey()) {
             handleError(error, false);
         }
         finally {
-            await cleanCredentials(currentPersistencePreference);
+            await cleanCredentials(await getSessionPersistence());
             window.location.reload();
         }
     };
@@ -3450,7 +3450,7 @@ function useAuth(secretKey = getAppKey()) {
      */
     const refresh = async (tokenPaths) => {
         try {
-            const refreshTokenFromStorage = await getAuthRefreshToken(secretKey, currentPersistencePreference);
+            const refreshTokenFromStorage = await getAuthRefreshToken(secretKey, await getSessionPersistence());
             if (!refreshTokenFromStorage) {
                 throw new Error("TOKEN_MISSING: No refresh token found in storage.");
             }
@@ -3472,8 +3472,8 @@ function useAuth(secretKey = getAppKey()) {
                 typeof refreshTokenAfterRefresh !== "string") {
                 throw new Error(`REFRESH_ERROR: Refresh token not found or invalid at path '${refreshTokenPath}' in refresh response.`);
             }
-            await storeAuthToken(accessTokenAfterRefresh, secretKey, currentPersistencePreference);
-            await storeAuthRefreshToken(refreshTokenAfterRefresh, secretKey, currentPersistencePreference);
+            await storeAuthToken(accessTokenAfterRefresh, secretKey, await getSessionPersistence());
+            await storeAuthRefreshToken(refreshTokenAfterRefresh, secretKey, await getSessionPersistence());
             return data;
         }
         catch (error) {
@@ -3524,4 +3524,4 @@ const ArexVueCore = {
     },
 };
 
-export { AppTypes, ArchiveTypes, ArexVueCore, AudioTypes, AxiosService, ContentTypeEnum, DocumentTypes, ERROR_MESSAGES, ERROR_STYLES, ErrorEnum, ErrorMessages, ErrorStyles, ExceptionEnum, FontTypes, ImageTypes, KeyCodeEnum, OtherTypes, RestStd, ScreenBreakpoint, ScreenSize, StorageKeyEnum, StorageTypeEnum, TextTypes, VideoTypes, ab2hex, addCustomKeyboardShortcut, addDays, addDoubleClickListener, addKeyListener, ageAtDate, axiosFetch, blobToFormData, bufferToBlob, calculateAge, cleanCredentials, clickOutside, compareObject, configAppKey, configAxios, configEndpoints, configSession, configTokenKeys, copyToClipboard, countWords, createCustomAxiosInstance, createFetch, createKeyMap, customShortcut, daysBetween, daysToNextBirthday, debounce, debounceAsync, debounceAsyncValidator, debounceAsyncWithImmediate, debounceLeading, debounceLeadingTrailing, debounceTrailing, decrypt, deepClone, deepEqual, deepMerge, detectKeyHold, disableCopy, disableF12Key, disableMouseButtons, disableRightClick, disableSpecificKeys, downloadBlob, enableMouseButtons, enableRightClick, enableSpecificKeys, encrypt, exportToCSV, exportToExcel, exportToJSON, exportToText, exportToXML, filterObjectByKeys, flattenObject, formDataToObject, formatDate, generateRandomString, getAppKey, getAuthRefreshToken, getAuthToken, getAxiosInstance, getDecryptedItem, getEndOfMonth, getEndpointsConfig, getObjectDifferences, getObjectKeys, getQueryParam, getSessionConfig, getSessionId, getSessionPersistencePreference, getStartOfMonth, getTokenConfig, handleError, hasNestedProperties, hex2ab, importKey, isEmptyObject, isLeapYear, isStrongPassword, isValidAge, isValidCreditCard, isValidDate, isValidEmail, isValidExpiryDate, isValidHexColor, isValidHexColorAlpha, isValidHexNumber, isValidIP, isValidPhoneNumber, isValidSSN, isValidTime, isValidURL, isValidUsername, isValidZIP, loadSessionConfigFromStorage, lowerFirst, objectToFormData, objectToFormDataEnhanced, objectToQueryString, openWindow, parseDate, proxyToPlainObject, readFileAsDataURL, readFileAsText, regenerateSessionId, registerKeyboardShortcuts, removeAccent, removeClickOutside, removeCustomKeyboardShortcut, removeCustomShortcuts, removeDoubleClickListener, removeEmptyProperties, removeKeyListeners, replaceAll, reverseString, safeGet, screenMap, scrollToTop, simulateKeyPress, stopDetectingKeyHold, storeAuthRefreshToken, storeAuthToken, storeEncryptedItem, stringToBlob, subtractDays, throttle, toCamelCase, toKebabCase, toggleTabNavigation, truncateString, unregisterKeyboardShortcuts, upperFirst, useAuth, useBreakpoint, useFilter, usePagination, useSorter, useVueQuery, validateAlphanumeric, validateLetters, validateNumbers, verifyAuth };
+export { AppTypes, ArchiveTypes, ArexVueCore, AudioTypes, AxiosService, ContentTypeEnum, DocumentTypes, ERROR_MESSAGES, ERROR_STYLES, ErrorEnum, ErrorMessages, ErrorStyles, ExceptionEnum, FontTypes, ImageTypes, KeyCodeEnum, OtherTypes, RestStd, ScreenBreakpoint, ScreenSize, StorageKeyEnum, StorageTypeEnum, TextTypes, VideoTypes, ab2hex, addCustomKeyboardShortcut, addDays, addDoubleClickListener, addKeyListener, ageAtDate, axiosFetch, blobToFormData, bufferToBlob, calculateAge, cleanCredentials, clickOutside, compareObject, configAppKey, configAxios, configEndpoints, configSession, configTokenKeys, copyToClipboard, countWords, createCustomAxiosInstance, createFetch, createKeyMap, customShortcut, daysBetween, daysToNextBirthday, debounce, debounceAsync, debounceAsyncValidator, debounceAsyncWithImmediate, debounceLeading, debounceLeadingTrailing, debounceTrailing, decrypt, deepClone, deepEqual, deepMerge, detectKeyHold, disableCopy, disableF12Key, disableMouseButtons, disableRightClick, disableSpecificKeys, downloadBlob, enableMouseButtons, enableRightClick, enableSpecificKeys, encrypt, exportToCSV, exportToExcel, exportToJSON, exportToText, exportToXML, filterObjectByKeys, flattenObject, formDataToObject, formatDate, generateRandomString, getAppKey, getAuthRefreshToken, getAuthToken, getAxiosInstance, getDecryptedItem, getEndOfMonth, getEndpointsConfig, getObjectDifferences, getObjectKeys, getQueryParam, getSessionConfig, getSessionId, getSessionPersistence, getStartOfMonth, getTokenConfig, handleError, hasNestedProperties, hex2ab, importKey, isEmptyObject, isLeapYear, isStrongPassword, isValidAge, isValidCreditCard, isValidDate, isValidEmail, isValidExpiryDate, isValidHexColor, isValidHexColorAlpha, isValidHexNumber, isValidIP, isValidPhoneNumber, isValidSSN, isValidTime, isValidURL, isValidUsername, isValidZIP, lowerFirst, objectToFormData, objectToFormDataEnhanced, objectToQueryString, openWindow, parseDate, proxyToPlainObject, readFileAsDataURL, readFileAsText, registerKeyboardShortcuts, removeAccent, removeClickOutside, removeCustomKeyboardShortcut, removeCustomShortcuts, removeDoubleClickListener, removeEmptyProperties, removeKeyListeners, replaceAll, reverseString, safeGet, screenMap, scrollToTop, simulateKeyPress, stopDetectingKeyHold, storeAuthRefreshToken, storeAuthToken, storeEncryptedItem, stringToBlob, subtractDays, throttle, toCamelCase, toKebabCase, toggleTabNavigation, truncateString, unregisterKeyboardShortcuts, upperFirst, useAuth, useBreakpoint, useFilter, usePagination, useSorter, useVueQuery, validateAlphanumeric, validateLetters, validateNumbers, verifyAuth };

package/dist/types/SessionConfig.d.ts

@@ -1,3 +1,13 @@
+export type SessionPreference = "local" | "session";
 export type SessionConfig = {
     SESSION_ID: string;
+    PERSISTENCE: SessionPreference;
 };
+export interface InternalSessionState {
+    sessionId: string;
+    persistencePreference: SessionPreference;
+}
+export interface SessionConfigObject {
+    sessionId?: string;
+    persistencePreference?: SessionPreference;
+}

package/dist/utils/credentials.d.ts

@@ -1,4 +1,4 @@
-import { SessionPreference } from "@config/global/sessionConfig";
+import { SessionPreference } from "@/types/SessionConfig";
 /**
  * Clears all stored authentication data (access and refresh tokens)
  * from either sessionStorage or localStorage based on the provided preference.
@@ -49,8 +49,6 @@ export declare const storeAuthRefreshToken: (token: string, secretKey: string, p
  * Verifies the validity and expiration of the current authentication token.
  * If the token is missing, invalid, or expired, appropriate errors are thrown and credentials are cleaned.
  *
- * @param {string} secretKey - The secret key used for token decryption.
- * @param {SessionPreference} preference - The current session persistence preference.
  * @returns {Promise<boolean>} True if the token is valid and unexpired.
  * @throws {Error} "TOKEN_MISSING" if no token is found, "TOKEN_EXPIRED" if the token has expired,
  * "TOKEN_INVALID" if the token format is invalid.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arex95/vue-core",
-  "version": "1.1.29",
+  "version": "1.1.30",
   "description": "Opinionated Vue Core",
   "main": "dist/index.js",
   "module": "dist/index.mjs",