@arex95/vue-core 1.1.20 → 1.1.21

package/dist/index.mjs

@@ -2504,6 +2504,170 @@ function isValidHexNumber(hex) {
 // console.log(isValidHexNumber('1A3F')); // true
 // console.log(isValidHexNumber('GHIJ')); // false
 
+/**
+ * Converts an ArrayBuffer or Uint8Array to a hexadecimal string.
+ * @param buffer The ArrayBuffer or Uint8Array to convert.
+ * @returns The hexadecimal string.
+ */
+function ab2hex(buffer) {
+    return Array.from(new Uint8Array(buffer))
+        .map((byte) => byte.toString(16).padStart(2, "0"))
+        .join("");
+}
+/**
+ * Converts a hexadecimal string to a Uint8Array.
+ * @param hex The hexadecimal string to convert.
+ * @returns The Uint8Array.
+ */
+function hex2ab(hex) {
+    if (!hex || !/^[0-9a-fA-F]*$/.test(hex)) {
+        return new Uint8Array();
+    }
+    const matches = hex.match(/[0-9a-fA-F]{1,2}/g);
+    return new Uint8Array(matches ? matches.map((byte) => parseInt(byte, 16)) : []);
+}
+/**
+ * Derives an encryption key from a secret key.
+ * @param secretKey The secret key in plain text.
+ * @returns A promise that resolves with the derived CryptoKey.
+ */
+async function importKey(secretKey) {
+    const keyMaterial = new TextEncoder().encode(secretKey);
+    const digest = await crypto.subtle.digest("SHA-256", keyMaterial);
+    return crypto.subtle.importKey("raw", digest, { name: "AES-CBC", length: 256 }, false, ["encrypt", "decrypt"]);
+}
+/**
+ * Encrypts a value with the provided secret key.
+ * @param value The value to encrypt.
+ * @param secretKey The secret key for encryption.
+ * @returns A promise that resolves with the IV (hex) + ciphertext (hex) string.
+ */
+async function encrypt(value, secretKey) {
+    const key = await importKey(secretKey);
+    const iv = crypto.getRandomValues(new Uint8Array(16));
+    const encodedValue = new TextEncoder().encode(value);
+    const ciphertext = await crypto.subtle.encrypt({ name: "AES-CBC", iv: iv }, key, encodedValue);
+    return ab2hex(iv) + ab2hex(new Uint8Array(ciphertext));
+}
+/**
+ * Decrypts an encrypted value.
+ * @param encryptedValue The encrypted string (IV_hex + ciphertext_hex).
+ * @param secretKey The secret key for decryption.
+ * @returns A promise that resolves with the decrypted value.
+ */
+async function decrypt(encryptedValue, secretKey) {
+    const key = await importKey(secretKey);
+    const ivHex = encryptedValue.substring(0, 32);
+    const ciphertextHex = encryptedValue.substring(32);
+    const iv = hex2ab(ivHex);
+    const ciphertext = hex2ab(ciphertextHex);
+    const decryptedBuffer = await crypto.subtle.decrypt({ name: "AES-CBC", iv: iv }, key, ciphertext);
+    return new TextDecoder().decode(decryptedBuffer);
+}
+
+/**
+ * Encrypts and stores an item in local or session storage.
+ * Assumes the `window` environment is available.
+ * @param key The key under which to store the value.
+ * @param value The value to encrypt and store.
+ * @param secretKey The secret key for encryption.
+ * @param isRememberMe If true, uses localStorage; otherwise, uses sessionStorage.
+ * @returns A promise that resolves when the item is stored. Throws an error if it fails.
+ */
+async function storeEncryptedItem(key, value, secretKey, isRememberMe) {
+    if (typeof window === "undefined") {
+        throw new Error("Cannot access storage: window is not defined.");
+    }
+    const storage = isRememberMe ? window.localStorage : window.sessionStorage;
+    const encryptedValue = await encrypt(value, secretKey);
+    storage.setItem(key, encryptedValue);
+}
+/**
+ * Retrieves and decrypts a value from local or session storage.
+ * Assumes the `window` environment is available.
+ * @param key The key of the item to retrieve.
+ * @param secretKey The secret key for decryption.
+ * @param isRememberMe If true, searches localStorage; otherwise, sessionStorage.
+ * @returns A promise that resolves with the decrypted value or null if not found or decryption fails.
+ */
+async function getDecryptedItem(key, secretKey, isRememberMe) {
+    if (typeof window === "undefined") {
+        return null;
+    }
+    const storage = isRememberMe ? window.localStorage : window.sessionStorage;
+    const encryptedData = storage.getItem(key);
+    if (!encryptedData) {
+        return null;
+    }
+    try {
+        return await decrypt(encryptedData, secretKey);
+    }
+    catch (error) {
+        return null;
+    }
+}
+
+const tokensConfig = getTokenConfig();
+/**
+ * Clears all stored authentication data (access and refresh tokens)
+ * from either sessionStorage or localStorage based on the provided preference.
+ *
+ * @param {SessionPreference} preference - The storage preference ('local' for localStorage, 'session' for sessionStorage).
+ * @returns {Promise<void>} A promise that resolves when all relevant storage items are removed.
+ */
+const cleanCredentials = async (preference) => {
+    Object.keys(tokensConfig).forEach((key) => {
+        const storage = preference === "session" ? sessionStorage : localStorage;
+        storage.removeItem(tokensConfig[key]);
+    });
+};
+/**
+ * Retrieves the authentication token (access token) from storage, decrypting it
+ * using the provided secret key and based on the specified session preference.
+ *
+ * @param {string} secretKey - The secret key used for decryption.
+ * @param {SessionPreference} preference - The storage preference ('local' for localStorage, 'session' for sessionStorage).
+ * @returns {Promise<string | null>} A promise that resolves with the decrypted access token, or null if not found.
+ */
+const getAuthToken = async (secretKey, preference) => {
+    return await getDecryptedItem(tokensConfig.ACCESS_TOKEN, secretKey, preference === "session");
+};
+/**
+ * Retrieves the authentication refresh token from storage, decrypting it
+ * using the provided secret key and based on the specified session preference.
+ *
+ * @param {string} secretKey - The secret key used for decryption.
+ * @param {SessionPreference} preference - The storage preference ('local' for localStorage, 'session' for sessionStorage).
+ * @returns {Promise<string | null>} A promise that resolves with the decrypted refresh token, or null if not found.
+ */
+const getAuthRefreshToken = async (secretKey, preference) => {
+    return await getDecryptedItem(tokensConfig.REFRESH_TOKEN, secretKey, preference === "session");
+};
+/**
+ * Stores the authentication token (access token) in storage after encrypting it,
+ * based on the specified session preference.
+ *
+ * @param {string} token - The access token to store.
+ * @param {string} secretKey - The secret key used for encryption.
+ * @param {SessionPreference} preference - The storage preference ('local' for localStorage, 'session' for sessionStorage).
+ * @returns {Promise<void>} A promise that resolves when the token is successfully stored.
+ */
+const storeAuthToken = async (token, secretKey, preference) => {
+    await storeEncryptedItem(tokensConfig.ACCESS_TOKEN, token, secretKey, preference === "session");
+};
+/**
+ * Stores the authentication refresh token in storage after encrypting it,
+ * based on the specified session preference.
+ *
+ * @param {string} token - The refresh token to store.
+ * @param {string} secretKey - The secret key used for encryption.
+ * @param {SessionPreference} preference - The storage preference ('local' for localStorage, 'session' for sessionStorage).
+ * @returns {Promise<void>} A promise that resolves when the token is successfully stored.
+ */
+const storeAuthRefreshToken = async (token, secretKey, preference) => {
+    await storeEncryptedItem(tokensConfig.REFRESH_TOKEN, token, secretKey, preference === "session");
+};
+
 class RestStd {
     static resource;
     static isFormData = false;
@@ -3055,170 +3219,6 @@ function useSorter(items, criteriaList, selectedCriteria) {
     }).value;
 }
 
-/**
- * Converts an ArrayBuffer or Uint8Array to a hexadecimal string.
- * @param buffer The ArrayBuffer or Uint8Array to convert.
- * @returns The hexadecimal string.
- */
-function ab2hex(buffer) {
-    return Array.from(new Uint8Array(buffer))
-        .map((byte) => byte.toString(16).padStart(2, "0"))
-        .join("");
-}
-/**
- * Converts a hexadecimal string to a Uint8Array.
- * @param hex The hexadecimal string to convert.
- * @returns The Uint8Array.
- */
-function hex2ab(hex) {
-    if (!hex || !/^[0-9a-fA-F]*$/.test(hex)) {
-        return new Uint8Array();
-    }
-    const matches = hex.match(/[0-9a-fA-F]{1,2}/g);
-    return new Uint8Array(matches ? matches.map((byte) => parseInt(byte, 16)) : []);
-}
-/**
- * Derives an encryption key from a secret key.
- * @param secretKey The secret key in plain text.
- * @returns A promise that resolves with the derived CryptoKey.
- */
-async function importKey(secretKey) {
-    const keyMaterial = new TextEncoder().encode(secretKey);
-    const digest = await crypto.subtle.digest("SHA-256", keyMaterial);
-    return crypto.subtle.importKey("raw", digest, { name: "AES-CBC", length: 256 }, false, ["encrypt", "decrypt"]);
-}
-/**
- * Encrypts a value with the provided secret key.
- * @param value The value to encrypt.
- * @param secretKey The secret key for encryption.
- * @returns A promise that resolves with the IV (hex) + ciphertext (hex) string.
- */
-async function encrypt(value, secretKey) {
-    const key = await importKey(secretKey);
-    const iv = crypto.getRandomValues(new Uint8Array(16));
-    const encodedValue = new TextEncoder().encode(value);
-    const ciphertext = await crypto.subtle.encrypt({ name: "AES-CBC", iv: iv }, key, encodedValue);
-    return ab2hex(iv) + ab2hex(new Uint8Array(ciphertext));
-}
-/**
- * Decrypts an encrypted value.
- * @param encryptedValue The encrypted string (IV_hex + ciphertext_hex).
- * @param secretKey The secret key for decryption.
- * @returns A promise that resolves with the decrypted value.
- */
-async function decrypt(encryptedValue, secretKey) {
-    const key = await importKey(secretKey);
-    const ivHex = encryptedValue.substring(0, 32);
-    const ciphertextHex = encryptedValue.substring(32);
-    const iv = hex2ab(ivHex);
-    const ciphertext = hex2ab(ciphertextHex);
-    const decryptedBuffer = await crypto.subtle.decrypt({ name: "AES-CBC", iv: iv }, key, ciphertext);
-    return new TextDecoder().decode(decryptedBuffer);
-}
-
-/**
- * Encrypts and stores an item in local or session storage.
- * Assumes the `window` environment is available.
- * @param key The key under which to store the value.
- * @param value The value to encrypt and store.
- * @param secretKey The secret key for encryption.
- * @param isRememberMe If true, uses localStorage; otherwise, uses sessionStorage.
- * @returns A promise that resolves when the item is stored. Throws an error if it fails.
- */
-async function storeEncryptedItem(key, value, secretKey, isRememberMe) {
-    if (typeof window === "undefined") {
-        throw new Error("Cannot access storage: window is not defined.");
-    }
-    const storage = isRememberMe ? window.localStorage : window.sessionStorage;
-    const encryptedValue = await encrypt(value, secretKey);
-    storage.setItem(key, encryptedValue);
-}
-/**
- * Retrieves and decrypts a value from local or session storage.
- * Assumes the `window` environment is available.
- * @param key The key of the item to retrieve.
- * @param secretKey The secret key for decryption.
- * @param isRememberMe If true, searches localStorage; otherwise, sessionStorage.
- * @returns A promise that resolves with the decrypted value or null if not found or decryption fails.
- */
-async function getDecryptedItem(key, secretKey, isRememberMe) {
-    if (typeof window === "undefined") {
-        return null;
-    }
-    const storage = isRememberMe ? window.localStorage : window.sessionStorage;
-    const encryptedData = storage.getItem(key);
-    if (!encryptedData) {
-        return null;
-    }
-    try {
-        return await decrypt(encryptedData, secretKey);
-    }
-    catch (error) {
-        return null;
-    }
-}
-
-const tokensConfig = getTokenConfig();
-/**
- * Clears all stored authentication data (access and refresh tokens)
- * from either sessionStorage or localStorage based on the provided preference.
- *
- * @param {SessionPreference} preference - The storage preference ('local' for localStorage, 'session' for sessionStorage).
- * @returns {Promise<void>} A promise that resolves when all relevant storage items are removed.
- */
-const cleanCredentials = async (preference) => {
-    Object.keys(tokensConfig).forEach((key) => {
-        const storage = preference === "session" ? sessionStorage : localStorage;
-        storage.removeItem(tokensConfig[key]);
-    });
-};
-/**
- * Retrieves the authentication token (access token) from storage, decrypting it
- * using the provided secret key and based on the specified session preference.
- *
- * @param {string} secretKey - The secret key used for decryption.
- * @param {SessionPreference} preference - The storage preference ('local' for localStorage, 'session' for sessionStorage).
- * @returns {Promise<string | null>} A promise that resolves with the decrypted access token, or null if not found.
- */
-const getAuthToken = async (secretKey, preference) => {
-    return await getDecryptedItem(tokensConfig.ACCESS_TOKEN, secretKey, preference === "session");
-};
-/**
- * Retrieves the authentication refresh token from storage, decrypting it
- * using the provided secret key and based on the specified session preference.
- *
- * @param {string} secretKey - The secret key used for decryption.
- * @param {SessionPreference} preference - The storage preference ('local' for localStorage, 'session' for sessionStorage).
- * @returns {Promise<string | null>} A promise that resolves with the decrypted refresh token, or null if not found.
- */
-const getAuthRefreshToken = async (secretKey, preference) => {
-    return await getDecryptedItem(tokensConfig.REFRESH_TOKEN, secretKey, preference === "session");
-};
-/**
- * Stores the authentication token (access token) in storage after encrypting it,
- * based on the specified session preference.
- *
- * @param {string} token - The access token to store.
- * @param {string} secretKey - The secret key used for encryption.
- * @param {SessionPreference} preference - The storage preference ('local' for localStorage, 'session' for sessionStorage).
- * @returns {Promise<void>} A promise that resolves when the token is successfully stored.
- */
-const storeAuthToken = async (token, secretKey, preference) => {
-    await storeEncryptedItem(tokensConfig.ACCESS_TOKEN, token, secretKey, preference === "session");
-};
-/**
- * Stores the authentication refresh token in storage after encrypting it,
- * based on the specified session preference.
- *
- * @param {string} token - The refresh token to store.
- * @param {string} secretKey - The secret key used for encryption.
- * @param {SessionPreference} preference - The storage preference ('local' for localStorage, 'session' for sessionStorage).
- * @returns {Promise<void>} A promise that resolves when the token is successfully stored.
- */
-const storeAuthRefreshToken = async (token, secretKey, preference) => {
-    await storeEncryptedItem(tokensConfig.REFRESH_TOKEN, token, secretKey, preference === "session");
-};
-
 /**
  * @typedef {object} AuthHook
  * @property {function(): Promise<string | null>} getJwt - Retrieves the current JWT.
@@ -3421,4 +3421,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, addCustomKeyboardShortcut, addDays, addDoubleClickListener, addKeyListener, ageAtDate, axiosFetch, blobToFormData, bufferToBlob, calculateAge, clickOutside, compareObject, configAxios, configEndpoints, configSession, configTokenKeys, 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, getSessionPersistencePreference, 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 };
+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 };

package/dist/types/index.d.ts

@@ -8,3 +8,4 @@ export * from './SessionConfig';
 export * from './DecodedJwtPayload';
 export * from './AuthResponse';
 export * from './AuthParams';
+export * from './ArexVueCoreOptions';

package/dist/utils/index.d.ts

@@ -7,3 +7,7 @@ export * from './files';
 export * from './objects';
 export * from './strings';
 export * from './validations';
+export * from './credentials';
+export * from './storage';
+export * from './encryption';
+export * from './errors';

package/package.json

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