@arex95/vue-core 1.1.10 → 1.1.12

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

@@ -0,0 +1 @@
+export * from "./useAuth";

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

@@ -15,8 +15,9 @@ export declare function configureAuth(options: AuthConfig): void;
  * @returns {Object} Auth composable methods and properties.
  */
 export declare function useAuth(secretKey?: string): {
-    jwt: import("vue").ComputedRef<string | null>;
-    refresh_token: import("vue").ComputedRef<string | null>;
+    isAuthenticated: import("vue").ComputedRef<boolean>;
+    jwt: import("vue").Ref<string | null, string | null>;
+    refresh_token: import("vue").Ref<string | null, string | null>;
     tokenExpiry: import("vue").ComputedRef<number | null>;
     login: (params: {} | undefined, isRememberMe: boolean) => Promise<import("axios").AxiosResponse<any, any>>;
     refresh: () => Promise<import("axios").AxiosResponse<any, any> | undefined>;

package/dist/composables/index.d.ts

@@ -3,3 +3,4 @@ export * from './breakpoints';
 export * from './filters';
 export * from './paginators';
 export * from './sorters';
+export * from './auth';

package/dist/composables/monitoring/useApiActivity.d.ts

@@ -1,5 +1,5 @@
 export declare function useApiActivity(sessionTimeoutMin: number, checkIntervalSec: number): {
-    pause: import("@vueuse/shared").Fn;
-    resume: import("@vueuse/shared").Fn;
+    pause: import("@vueuse/core").Fn;
+    resume: import("@vueuse/core").Fn;
     updateTimestamp: () => void;
 };

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

@@ -1,2 +1,3 @@
-export * from './tokenConfig';
+export * from './tokensConfig';
 export * from './endpointsConfig';
+export * from './sessionConfig';

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

@@ -0,0 +1,31 @@
+import { TokensConfig } from "@/types";
+/**
+ * Configures the global keys for access and refresh tokens.
+ * Once set, they cannot be modified.
+ *
+ * @param {string} accessTokenKey - The name of the access token key.
+ * @param {string} refreshTokenKey - The name of the refresh token key.
+ *
+ * @returns {void} Does not return anything but freezes the token configuration object.
+ */
+export declare function configTokenKeys(accessTokenKey: string, refreshTokenKey: string): void;
+/**
+ * Retrieves the current token configuration.
+ *
+ * @returns {TokensConfig} The configuration of the access and refresh token keys.
+ */
+export declare function getTokenConfig(): TokensConfig;
+/**
+ * Sets the secret key for use in authentication.
+ *
+ * @param {string} key - The new secret key.
+ *
+ * @returns {void} Does not return anything, but updates the secret key.
+ */
+export declare function setSecretKey(key: string): void;
+/**
+ * Retrieves the current secret key.
+ *
+ * @returns {string} The configured secret key.
+ */
+export declare function getSecretKey(): string;

package/dist/index.mjs

@@ -1,8 +1,10 @@
-import { useTimeoutFn, useBreakpoints, breakpointsTailwind, useWindowSize } from '@vueuse/core';
+import { useTimeoutFn, useBreakpoints, breakpointsTailwind, useWindowSize, computedAsync } from '@vueuse/core';
 import axios from 'axios';
 import { useRouter } from 'vue-router';
 import { useQuery } from '@tanstack/vue-query';
 import { ref, watch, onServerPrefetch, onMounted, computed } from 'vue';
+import { jwtDecode } from 'jwt-decode';
+import { v4 } from 'uuid';
 
 /**
  * Creates and downloads a file from Blob data.
@@ -2385,7 +2387,7 @@ function inferErrorType(error) {
 }
 
 let secretKey = "12345678901234567890123456789012";
-let tokenConfig = Object.freeze({
+let tokensConfig$1 = Object.freeze({
     ACCESS_TOKEN: "authToken",
     REFRESH_TOKEN: "refreshToken",
 });
@@ -2398,8 +2400,8 @@ let tokenConfig = Object.freeze({
  *
  * @returns {void} Does not return anything but freezes the token configuration object.
  */
-function configTokens(accessTokenKey, refreshTokenKey) {
-    tokenConfig = Object.freeze({
+function configTokenKeys(accessTokenKey, refreshTokenKey) {
+    tokensConfig$1 = Object.freeze({
         ACCESS_TOKEN: accessTokenKey,
         REFRESH_TOKEN: refreshTokenKey,
     });
@@ -2407,10 +2409,10 @@ function configTokens(accessTokenKey, refreshTokenKey) {
 /**
  * Retrieves the current token configuration.
  *
- * @returns {TokenConfig} The configuration of the access and refresh token keys.
+ * @returns {TokensConfig} The configuration of the access and refresh token keys.
  */
 function getTokenConfig() {
-    return tokenConfig;
+    return tokensConfig$1;
 }
 /**
  * Sets the secret key for use in authentication.
@@ -2431,7 +2433,7 @@ function getSecretKey() {
     return secretKey;
 }
 
-let endpointsConfig = {
+let endpointsConfig$1 = {
     LOGIN: "/login",
     REFRESH: "/refresh",
     LOGOUT: "/logout",
@@ -2447,7 +2449,7 @@ let endpointsConfig = {
  * @returns {void} Does not return anything but freezes the endpoint configuration object.
  */
 function configEndpoints(loginEndpoint, refreshEndpoint, logoutEndpoint) {
-    endpointsConfig = Object.freeze({
+    endpointsConfig$1 = Object.freeze({
         LOGIN: loginEndpoint,
         REFRESH: refreshEndpoint,
         LOGOUT: logoutEndpoint,
@@ -2462,7 +2464,7 @@ function configEndpoints(loginEndpoint, refreshEndpoint, logoutEndpoint) {
  * @property {string} LOGOUT - URL of the logout endpoint.
  */
 function getEndpointsConfig() {
-    return endpointsConfig;
+    return endpointsConfig$1;
 }
 
 /**
@@ -2591,13 +2593,13 @@ class AxiosService {
     }
 }
 
-let axiosInstance;
+let axiosInstance$1;
 /**
  * Configures the global Axios instance with a base URL.
  * @param {string} baseURL - The base URL for the Axios instance.
  */
 const configAxios = (baseURL) => {
-    axiosInstance = new AxiosService(baseURL);
+    axiosInstance$1 = new AxiosService(baseURL);
 };
 /**
  * Retrieves the configured Axios instance.
@@ -2605,10 +2607,10 @@ const configAxios = (baseURL) => {
  * @throws Will throw an error if the Axios instance is not configured.
  */
 const getAxiosInstance = () => {
-    if (!axiosInstance) {
+    if (!axiosInstance$1) {
         throw new Error('Axios instance not configured. Call configureAxios first.');
     }
-    return axiosInstance.getAxiosInstance();
+    return axiosInstance$1.getAxiosInstance();
 };
 /**
  * Creates a new AxiosService instance with custom headers.
@@ -2987,4 +2989,300 @@ function useSorter(items, criteriaList, selectedCriteria) {
     }).value;
 }
 
-export { AppTypes, ArchiveTypes, AudioTypes, AxiosService, ContentTypeEnum, DocumentTypes, ERROR_MESSAGES, ERROR_STYLES, ErrorEnum, ErrorMessages, ErrorStyles, ExceptionEnum, FontTypes, ImageTypes, KeyCodeEnum, OtherTypes, RestStd, ScreenBreakpoint, ScreenSize, StorageKeyEnum, StorageTypeEnum, TextTypes, VideoTypes, addCustomKeyboardShortcut, addDays, addDoubleClickListener, addKeyListener, ageAtDate, axiosFetch, blobToFormData, bufferToBlob, calculateAge, clickOutside, compareObject, configAxios, configEndpoints, configTokens, copyToClipboard, countWords, createCustomAxiosInstance, createFetch, createKeyMap, customShortcut, daysBetween, daysToNextBirthday, debounce, debounceAsync, debounceAsyncValidator, debounceAsyncWithImmediate, debounceLeading, debounceLeadingTrailing, debounceTrailing, deepClone, deepEqual, deepMerge, detectKeyHold, disableCopy, disableF12Key, disableMouseButtons, disableRightClick, disableSpecificKeys, downloadBlob, enableMouseButtons, enableRightClick, enableSpecificKeys, exportToCSV, exportToExcel, exportToJSON, exportToText, exportToXML, filterObjectByKeys, flattenObject, formDataToObject, formatDate, generateRandomString, getAxiosInstance, getEndOfMonth, getEndpointsConfig, getObjectDifferences, getObjectKeys, getQueryParam, getSecretKey, getStartOfMonth, getTokenConfig, hasNestedProperties, 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, setSecretKey, simulateKeyPress, stopDetectingKeyHold, stringToBlob, subtractDays, throttle, toCamelCase, toKebabCase, toggleTabNavigation, truncateString, unregisterKeyboardShortcuts, upperFirst, useBreakpoint, useFilter, usePagination, useSorter, useVueQuery, validateAlphanumeric, validateLetters, validateNumbers };
+const axiosInstance = getAxiosInstance();
+const tokensConfig = getTokenConfig();
+const endpointsConfig = getEndpointsConfig();
+const config = {
+    endpoints: endpointsConfig,
+    storageKeys: tokensConfig,
+};
+/**
+ * Configures authentication settings globally.
+ * Allows modifying default endpoints and storage keys.
+ *
+ * @param {Object} options - Custom configuration options.
+ * @param {Object} [options.endpoints] - Custom endpoints for login, refresh, and logout.
+ * @param {Object} [options.storageKeys] - Custom storage keys for tokens.
+ */
+function configureAuth(options) {
+    if (options.endpoints) {
+        config.endpoints = { ...config.endpoints, ...options.endpoints };
+    }
+    if (options.storageKeys) {
+        config.storageKeys = { ...config.storageKeys, ...options.storageKeys };
+    }
+}
+function ab2hex(buffer) {
+    return Array.from(buffer)
+        .map((b) => b.toString(16).padStart(2, "0"))
+        .join("");
+}
+function hex2ab(hex) {
+    return new Uint8Array(hex.match(/.{1,2}/g).map((byte) => parseInt(byte, 16)));
+}
+async function importKey(secretKey) {
+    const encoder = new TextEncoder();
+    const keyMaterial = await crypto.subtle.digest("SHA-256", encoder.encode(secretKey));
+    return await crypto.subtle.importKey("raw", keyMaterial, { name: "AES-CBC", length: 256 }, false, ["encrypt", "decrypt"]);
+}
+/**
+ * Encrypts a value using AES-256 CBC encryption with Web Cryptography API.
+ * The IV is generated randomly for each encryption and prepended to the ciphertext.
+ *
+ * @param {string} value - The value to encrypt.
+ * @param {string} secretKey - The encryption key string.
+ * @returns {Promise<string>} A promise that resolves to the encrypted string (hex IV + hex ciphertext).
+ */
+const encrypt = async (value, secretKey) => {
+    const key = await importKey(secretKey);
+    const textEncoder = new TextEncoder();
+    const data = textEncoder.encode(value);
+    const iv = crypto.getRandomValues(new Uint8Array(16));
+    const encryptedContentBuffer = await crypto.subtle.encrypt({ name: "AES-CBC", iv: iv }, key, data);
+    const encryptedContentUint8 = new Uint8Array(encryptedContentBuffer);
+    return ab2hex(iv) + ab2hex(encryptedContentUint8);
+};
+/**
+ * Decrypts an AES-256 CBC encrypted value using Web Cryptography API.
+ * The IV is extracted from the beginning of the encrypted string.
+ *
+ * @param {string} value - The encrypted string (hex IV + hex ciphertext).
+ * @param {string} secretKey - The decryption key string.
+ * @returns {Promise<string>} A promise that resolves to the decrypted string.
+ */
+const decrypt = async (value, secretKey) => {
+    const key = await importKey(secretKey);
+    const iv = hex2ab(value.substring(0, 32));
+    const encryptedData = hex2ab(value.substring(32));
+    const decryptedContent = await crypto.subtle.decrypt({ name: "AES-CBC", iv: iv }, key, encryptedData);
+    return new TextDecoder().decode(decryptedContent);
+};
+/**
+ * Stores an encrypted value in sessionStorage or localStorage.
+ *
+ * @param {string} key - Storage key.
+ * @param {string} value - Value to store.
+ * @param {string} secretKey - Encryption key.
+ * @param {boolean} isRememberMe - Whether to store in localStorage.
+ * @param {number} [attempt=0] - Retry attempt count.
+ * @returns {Promise<void>}
+ */
+const storeEncryptedItem = async (key, value, secretKey, isRememberMe, attempt = 0) => {
+    const storage = isRememberMe ? localStorage : sessionStorage;
+    if (typeof window !== "undefined" && storage) {
+        try {
+            const encryptedValue = await encrypt(value, secretKey);
+            storage.setItem(key, encryptedValue);
+            return;
+        }
+        catch (error) {
+            handleError(error, false);
+            if (attempt < 5) {
+                await new Promise((resolve) => setTimeout(resolve, 100));
+                return await storeEncryptedItem(key, value, secretKey, isRememberMe, attempt + 1);
+            }
+            throw new Error(`Storage not available for key ${key} after multiple attempts`);
+        }
+    }
+    else {
+        if (attempt < 5) {
+            await new Promise((resolve) => setTimeout(resolve, 100));
+            return await storeEncryptedItem(key, value, secretKey, isRememberMe, attempt + 1);
+        }
+        throw new Error(`Storage not available for key ${key} after multiple attempts`);
+    }
+};
+/**
+ * Retrieves and decrypts a stored value.
+ *
+ * @param {string} key - Storage key.
+ * @param {string} secretKey - Decryption key.
+ * @param {boolean} isRememberMe - Whether to retrieve from localStorage.
+ * @returns {Promise<string|null>} The decrypted value or null.
+ */
+async function getDecryptedValue(key, secretKey, isRememberMe) {
+    const storage = sessionStorage;
+    try {
+        const value = storage.getItem(key);
+        if (!value)
+            return null;
+        return await decrypt(value, secretKey);
+    }
+    catch (error) {
+        handleError(error, false);
+        return null;
+    }
+}
+/**
+ * Provides authentication utilities.
+ *
+ * @param {string} [secretKey=getSecretKey()] - Encryption key.
+ * @returns {Object} Auth composable methods and properties.
+ */
+function useAuth(secretKey = getSecretKey()) {
+    const jwt = computedAsync(async () => await getDecryptedValue(config.storageKeys.ACCESS_TOKEN, secretKey), null);
+    const refresh_token = computedAsync(async () => await getDecryptedValue(config.storageKeys.REFRESH_TOKEN, secretKey), null);
+    /**
+     * Computes token expiration timestamp.
+     */
+    const tokenExpiry = computed(() => {
+        if (!jwt.value)
+            return null;
+        try {
+            const decoded = jwtDecode(jwt.value);
+            return decoded.exp ? decoded.exp * 1000 : null;
+        }
+        catch (error) {
+            handleError(error, false);
+            return null;
+        }
+    });
+    /**
+     * Checks if the user is authenticated.
+     */
+    const isAuthenticated = computed(() => {
+        if (!jwt.value || jwt.value.length === 0) {
+            return false;
+        }
+        if (tokenExpiry.value === null) {
+            return false;
+        }
+        return tokenExpiry.value > Date.now();
+    });
+    /**
+     * Handles user login.
+     */
+    const login = async (params = {}, isRememberMe) => {
+        try {
+            const response = await axiosInstance.post(config.endpoints.LOGIN, params);
+            await storeEncryptedItem(config.storageKeys.ACCESS_TOKEN, response.data.token, secretKey, isRememberMe);
+            await storeEncryptedItem(config.storageKeys.REFRESH_TOKEN, response.data.refresh_token, secretKey, isRememberMe);
+            return response;
+        }
+        catch (error) {
+            handleError(error, false);
+            throw error;
+        }
+    };
+    /**
+     * Refreshes authentication token.
+     */
+    const refresh = async () => {
+        try {
+            const response = await axiosInstance.post(config.endpoints.REFRESH, {});
+            await storeEncryptedItem(config.storageKeys.ACCESS_TOKEN, response.data.token, secretKey, false);
+            await storeEncryptedItem(config.storageKeys.REFRESH_TOKEN, response.data.refresh_token, secretKey, false);
+            return response;
+        }
+        catch (error) {
+            handleError(error, false);
+            await logout();
+        }
+    };
+    /**
+     * Logs out the user.
+     */
+    const logout = async (params = {}) => {
+        try {
+            await axiosInstance.post(config.endpoints.LOGOUT, params);
+        }
+        catch (error) {
+            handleError(error, false);
+        }
+        finally {
+            await cleanStorage();
+            location.reload();
+        }
+    };
+    /**
+     * Clears stored authentication data.
+     */
+    const cleanStorage = async () => {
+        Object.keys(config.storageKeys).forEach((key) => {
+            sessionStorage.removeItem(config.storageKeys[key]);
+            localStorage.removeItem(config.storageKeys[key]);
+        });
+    };
+    /**
+     * Verifies token validity.
+     */
+    const verifyToken = async () => {
+        if (!jwt.value) {
+            handleError("TOKEN_MISSING: No valid token found", true, "/auth-error", "query");
+            await cleanStorage();
+            throw new Error("TOKEN_MISSING: No valid token found");
+        }
+        try {
+            const decoded = jwtDecode(jwt.value);
+            if (decoded.exp ? decoded.exp * 1000 < Date.now() : false) {
+                handleError("TOKEN_EXPIRED", false);
+                await refresh();
+            }
+        }
+        catch (error) {
+            let errorMessage = "TOKEN_INVALID: Token verification failed";
+            if (error instanceof Error) {
+                errorMessage = `${errorMessage} - ${error.message}`;
+            }
+            handleError(errorMessage, true, "/auth-error", "query");
+            await cleanStorage();
+            throw new Error(errorMessage);
+        }
+    };
+    return {
+        isAuthenticated,
+        jwt,
+        refresh_token,
+        tokenExpiry,
+        login,
+        refresh,
+        logout,
+        cleanStorage,
+        verifyToken,
+    };
+}
+
+let sessionId = v4();
+let sessionConfig = Object.freeze({
+    SESSION_ID: sessionId,
+});
+/**
+ * Configures the session identifier for the active browser session.
+ * Once configured, it cannot be modified.
+ *
+ * @param {string} sessionIdParam - The unique session identifier.
+ *
+ * @returns {void} Does not return anything, but freezes the session configuration.
+ */
+function configSession(sessionIdParam) {
+    sessionConfig = Object.freeze({
+        SESSION_ID: sessionIdParam,
+    });
+}
+/**
+ * Retrieves the current session identifier configuration.
+ *
+ * @returns {string} The unique session identifier.
+ */
+function getSessionConfig() {
+    return sessionConfig.SESSION_ID;
+}
+/**
+ * Generates a new UUID for the current session.
+ *
+ * @returns {void} Does not return anything, but updates the session identifier.
+ */
+function regenerateSessionId() {
+    sessionId = v4();
+    configSession(sessionId);
+}
+/**
+ * Retrieves the current session identifier.
+ *
+ * @returns {string} The unique session identifier.
+ */
+function getSessionId() {
+    return sessionId;
+}
+
+export { AppTypes, ArchiveTypes, AudioTypes, AxiosService, ContentTypeEnum, DocumentTypes, ERROR_MESSAGES, ERROR_STYLES, ErrorEnum, ErrorMessages, ErrorStyles, ExceptionEnum, FontTypes, ImageTypes, KeyCodeEnum, OtherTypes, RestStd, ScreenBreakpoint, ScreenSize, StorageKeyEnum, StorageTypeEnum, TextTypes, VideoTypes, addCustomKeyboardShortcut, addDays, addDoubleClickListener, addKeyListener, ageAtDate, axiosFetch, blobToFormData, bufferToBlob, calculateAge, clickOutside, compareObject, configAxios, configEndpoints, configSession, configTokenKeys, configureAuth, copyToClipboard, countWords, createCustomAxiosInstance, createFetch, createKeyMap, customShortcut, daysBetween, daysToNextBirthday, debounce, debounceAsync, debounceAsyncValidator, debounceAsyncWithImmediate, debounceLeading, debounceLeadingTrailing, debounceTrailing, deepClone, deepEqual, deepMerge, detectKeyHold, disableCopy, disableF12Key, disableMouseButtons, disableRightClick, disableSpecificKeys, downloadBlob, enableMouseButtons, enableRightClick, enableSpecificKeys, exportToCSV, exportToExcel, exportToJSON, exportToText, exportToXML, filterObjectByKeys, flattenObject, formDataToObject, formatDate, generateRandomString, getAxiosInstance, getEndOfMonth, getEndpointsConfig, getObjectDifferences, getObjectKeys, getQueryParam, getSecretKey, getSessionConfig, getSessionId, getStartOfMonth, getTokenConfig, hasNestedProperties, 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, regenerateSessionId, registerKeyboardShortcuts, removeAccent, removeClickOutside, removeCustomKeyboardShortcut, removeCustomShortcuts, removeDoubleClickListener, removeEmptyProperties, removeKeyListeners, replaceAll, reverseString, safeGet, screenMap, scrollToTop, setSecretKey, simulateKeyPress, stopDetectingKeyHold, stringToBlob, subtractDays, throttle, toCamelCase, toKebabCase, toggleTabNavigation, truncateString, unregisterKeyboardShortcuts, upperFirst, useAuth, useBreakpoint, useFilter, usePagination, useSorter, useVueQuery, validateAlphanumeric, validateLetters, validateNumbers };

package/dist/types/AuthConfig.d.ts

@@ -1,5 +1,5 @@
-import { TokenConfig, EndpointsConfig } from "@/types";
+import { TokensConfig, EndpointsConfig } from "@/types";
 export type AuthConfig = {
     endpoints: EndpointsConfig;
-    storageKeys: TokenConfig;
+    storageKeys: TokensConfig;
 };

package/dist/types/TokenConfig.d.ts

@@ -1,4 +1,4 @@
-export type TokenConfig = {
+export type TokensConfig = {
     readonly ACCESS_TOKEN: string;
     readonly REFRESH_TOKEN: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arex95/vue-core",
-  "version": "1.1.10",
+  "version": "1.1.12",
   "description": "Opinionated Vue Core",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -35,7 +35,9 @@
     "axios": ">=1.6.0",
     "uuid": ">=11.1.0",
     "vue": ">=3.0.0",
-    "vue-router": ">=4.5.0"
+    "vue-router": ">=4.5.0",
+    "crypto-js": "^4.2.0",
+    "jwt-decode": "^4.0.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.23.0",