@arex95/vue-core 1.1.19 → 1.1.21

package/dist/types/ArexVueCoreOptions.d.ts

@@ -0,0 +1,26 @@
+export interface ArexVueCoreOptions {
+    /**
+     * The authentication endpoints.
+     */
+    endpoints: {
+        /** The login endpoint. */
+        login: string;
+        /** The token refresh endpoint. */
+        refresh: string;
+        /** The logout endpoint. */
+        logout: string;
+    };
+    /**
+     * The key prefixes for storing tokens.
+     */
+    tokenKeys: {
+        /** The access token key prefix. */
+        accessToken: string;
+        /** The refresh token key prefix. */
+        refreshToken: string;
+    };
+    /**
+     * The base URL for the API.
+     */
+    apiUrl: string;
+}

package/dist/types/AuthParams.d.ts

@@ -0,0 +1,4 @@
+export interface AuthParams {
+    username?: string;
+    password?: string;
+}

package/dist/types/AuthResponse.d.ts

@@ -0,0 +1,5 @@
+export interface AuthResponse {
+    access_token: string;
+    refresh_token: string;
+    [key: string]: unknown;
+}

package/dist/types/DecodedJwtPayload.d.ts

@@ -0,0 +1,9 @@
+export interface DecodedJwtPayload {
+    exp?: number;
+    iat?: number;
+    nbf?: number;
+    iss?: string;
+    sub?: string;
+    aud?: string | string[];
+    [key: string]: unknown;
+}

package/dist/types/index.d.ts

@@ -5,3 +5,7 @@ export * from './EndpointsConfig';
 export * from './TokenConfig';
 export * from './AuthConfig';
 export * from './SessionConfig';
+export * from './DecodedJwtPayload';
+export * from './AuthResponse';
+export * from './AuthParams';
+export * from './ArexVueCoreOptions';

package/dist/utils/credentials.d.ts

@@ -0,0 +1,47 @@
+import { SessionPreference } from "@config/global/sessionConfig";
+/**
+ * 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.
+ */
+export declare const cleanCredentials: (preference: SessionPreference) => Promise<void>;
+/**
+ * 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.
+ */
+export declare const getAuthToken: (secretKey: string, preference: SessionPreference) => Promise<string | null>;
+/**
+ * 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.
+ */
+export declare const getAuthRefreshToken: (secretKey: string, preference: SessionPreference) => Promise<string | null>;
+/**
+ * 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.
+ */
+export declare const storeAuthToken: (token: string, secretKey: string, preference: SessionPreference) => Promise<void>;
+/**
+ * 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.
+ */
+export declare const storeAuthRefreshToken: (token: string, secretKey: string, preference: SessionPreference) => Promise<void>;

package/dist/utils/encryption.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Converts an ArrayBuffer or Uint8Array to a hexadecimal string.
+ * @param buffer The ArrayBuffer or Uint8Array to convert.
+ * @returns The hexadecimal string.
+ */
+export declare function ab2hex(buffer: ArrayBuffer | Uint8Array): string;
+/**
+ * Converts a hexadecimal string to a Uint8Array.
+ * @param hex The hexadecimal string to convert.
+ * @returns The Uint8Array.
+ */
+export declare function hex2ab(hex: string): Uint8Array;
+/**
+ * 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.
+ */
+export declare function importKey(secretKey: string): Promise<CryptoKey>;
+/**
+ * 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.
+ */
+export declare function encrypt(value: string, secretKey: string): Promise<string>;
+/**
+ * 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.
+ */
+export declare function decrypt(encryptedValue: string, secretKey: string): Promise<string>;

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/dist/utils/storage.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+export declare function storeEncryptedItem(key: string, value: string, secretKey: string, isRememberMe: boolean): Promise<void>;
+/**
+ * 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.
+ */
+export declare function getDecryptedItem(key: string, secretKey: string, isRememberMe: boolean): Promise<string | null>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arex95/vue-core",
-  "version": "1.1.19",
+  "version": "1.1.21",
   "description": "Opinionated Vue Core",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -49,6 +49,7 @@
     "@rollup/plugin-typescript": "^12.1.2",
     "@types/crypto-js": "^4.2.2",
     "@types/node": "^22.13.10",
+    "@vitest/spy": "^3.2.3",
     "@vitest/ui": "^3.2.3",
     "@vue/test-utils": "^2.4.6",
     "conventional-changelog-cli": "^5.0.0",