@arex95/vue-core 1.1.21 → 1.1.22

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

@@ -2,7 +2,6 @@ import { AuthParams, AuthResponse } from "@/types";
 import { SessionPreference } from "@config/global/sessionConfig";
 /**
  * @typedef {object} AuthHook
- * @property {function(): Promise<string | null>} getJwt - Retrieves the current JWT.
  * @property {function(): Promise<number | null>} getTokenExpiry - Retrieves the expiration time of the current token in milliseconds.
  * @property {function(): Promise<void>} cleanCredentials - Clears authentication credentials from storage.
  * @property {(params?: AuthParams) => Promise<void>} logout - Logs out the user, clears credentials, and reloads the page.
@@ -19,11 +18,7 @@ import { SessionPreference } from "@config/global/sessionConfig";
  * @returns {AuthHook} An object containing authentication functions.
  */
 export declare function useAuth(secretKey?: string): {
-    getJwt: () => Promise<string | null>;
-    getTokenExpiry: () => Promise<number | null>;
-    cleanCredentials: (preference: SessionPreference) => Promise<void>;
     logout: (params?: AuthParams) => Promise<void>;
     login: (params: AuthParams, persistence: SessionPreference) => Promise<AuthResponse>;
     refresh: () => Promise<AuthResponse>;
-    verifyAuth: () => Promise<boolean>;
 };

package/dist/index.mjs

@@ -2,9 +2,9 @@ import axios from 'axios';
 import { useRouter } from 'vue-router';
 import { v4 } from 'uuid';
 import { useTimeoutFn, useBreakpoints, breakpointsTailwind, useWindowSize } from '@vueuse/core';
+import { jwtDecode } from 'jwt-decode';
 import { useQuery } from '@tanstack/vue-query';
 import { ref, watch, onServerPrefetch, onMounted, computed } from 'vue';
-import { jwtDecode } from 'jwt-decode';
 
 /**
  * Enum defining available screen sizes.
@@ -2667,6 +2667,49 @@ const storeAuthToken = async (token, secretKey, preference) => {
 const storeAuthRefreshToken = async (token, secretKey, preference) => {
     await storeEncryptedItem(tokensConfig.REFRESH_TOKEN, token, secretKey, preference === "session");
 };
+/**
+ * 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 (secretKey = getSecretKey(), preference = getSessionPersistencePreference()) => {
+    try {
+        const token = await getAuthToken(secretKey, preference);
+        if (!token) {
+            handleError("TOKEN_MISSING: No valid token found", false);
+            await cleanCredentials(preference);
+            return false;
+        }
+        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;
+        }
+        if (decoded.exp <= currentTime) {
+            handleError("TOKEN_EXPIRED: Token is expired", false);
+            await cleanCredentials(preference);
+            return false;
+        }
+        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;
+    }
+};
 
 class RestStd {
     static resource;
@@ -3221,7 +3264,6 @@ function useSorter(items, criteriaList, selectedCriteria) {
 
 /**
  * @typedef {object} AuthHook
- * @property {function(): Promise<string | null>} getJwt - Retrieves the current JWT.
  * @property {function(): Promise<number | null>} getTokenExpiry - Retrieves the expiration time of the current token in milliseconds.
  * @property {function(): Promise<void>} cleanCredentials - Clears authentication credentials from storage.
  * @property {(params?: AuthParams) => Promise<void>} logout - Logs out the user, clears credentials, and reloads the page.
@@ -3241,38 +3283,6 @@ function useAuth(secretKey = getSecretKey()) {
     const axiosInstance = getAxiosInstance();
     const endpoints = getEndpointsConfig();
     const currentPersistencePreference = getSessionPersistencePreference();
-    /**
-     * Retrieves the current JSON Web Token (JWT) from storage based on the active session preference.
-     *
-     * @returns {Promise<string | null>} The JWT string if found, otherwise null.
-     */
-    const getJwt = async () => {
-        try {
-            return await getAuthToken(secretKey, currentPersistencePreference);
-        }
-        catch (error) {
-            handleError("Error getting JWT: " + error, false);
-            return null;
-        }
-    };
-    /**
-     * Retrieves the expiration timestamp of the current authentication token in milliseconds.
-     *
-     * @returns {Promise<number | null>} The expiration timestamp in milliseconds if the token is valid, otherwise null.
-     */
-    const getTokenExpiry = async () => {
-        const token = await getJwt();
-        if (!token)
-            return null;
-        try {
-            const decoded = jwtDecode(token);
-            return decoded.exp ? decoded.exp * 1000 : null;
-        }
-        catch (error) {
-            handleError(`TOKEN_INVALID: Token verification failed (malformed or unreadable): ${error.message}`, false);
-            return null;
-        }
-    };
     /**
      * Logs out the user by making a POST request to the logout endpoint,
      * cleaning all stored credentials, and reloading the page.
@@ -3341,51 +3351,10 @@ function useAuth(secretKey = getSecretKey()) {
             throw error;
         }
     };
-    /**
-     * 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.
-     *
-     * @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 token = await getJwt();
-        if (!token) {
-            handleError("TOKEN_MISSING: No valid token found", false);
-            await cleanCredentials(currentPersistencePreference);
-            throw new Error("TOKEN_MISSING: No valid token found");
-        }
-        try {
-            const decoded = jwtDecode(token);
-            const currentTime = Date.now() / 1000;
-            if (typeof decoded.exp !== "number") {
-                throw new Error("Invalid expiration format");
-            }
-            if (decoded.exp <= currentTime) {
-                handleError("TOKEN_EXPIRED: Token is expired", false);
-                await cleanCredentials(currentPersistencePreference);
-                throw new Error("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(currentPersistencePreference);
-                throw new Error("TOKEN_INVALID: Invalid token format");
-            }
-            throw error;
-        }
-    };
     return {
-        getJwt,
-        getTokenExpiry,
-        cleanCredentials,
         logout,
         login,
-        refresh,
-        verifyAuth
+        refresh
     };
 }
 
@@ -3421,4 +3390,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, 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, getAuthRefreshToken, getAuthToken, getAxiosInstance, getDecryptedItem, getEndOfMonth, getEndpointsConfig, getObjectDifferences, getObjectKeys, getQueryParam, getSecretKey, 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, 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, storeAuthRefreshToken, storeAuthToken, storeEncryptedItem, stringToBlob, subtractDays, throttle, toCamelCase, toKebabCase, toggleTabNavigation, truncateString, unregisterKeyboardShortcuts, upperFirst, useAuth, useBreakpoint, useFilter, usePagination, useSorter, useVueQuery, validateAlphanumeric, validateLetters, validateNumbers };
+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, 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, getAuthRefreshToken, getAuthToken, getAxiosInstance, getDecryptedItem, getEndOfMonth, getEndpointsConfig, getObjectDifferences, getObjectKeys, getQueryParam, getSecretKey, 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, 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, storeAuthRefreshToken, storeAuthToken, storeEncryptedItem, stringToBlob, subtractDays, throttle, toCamelCase, toKebabCase, toggleTabNavigation, truncateString, unregisterKeyboardShortcuts, upperFirst, useAuth, useBreakpoint, useFilter, usePagination, useSorter, useVueQuery, validateAlphanumeric, validateLetters, validateNumbers, verifyAuth };

package/dist/utils/credentials.d.ts

@@ -45,3 +45,14 @@ export declare const storeAuthToken: (token: string, secretKey: string, preferen
  * @returns {Promise<void>} A promise that resolves when the token is successfully stored.
  */
 export declare const storeAuthRefreshToken: (token: string, secretKey: string, preference: SessionPreference) => Promise<void>;
+/**
+ * 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.
+ */
+export declare const verifyAuth: (secretKey?: string, preference?: SessionPreference) => Promise<boolean>;

package/package.json

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