@arex95/vue-core 1.1.19 → 1.1.21

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

@@ -1,57 +1,29 @@
+import { AuthParams, AuthResponse } from "@/types";
+import { SessionPreference } from "@config/global/sessionConfig";
 /**
- * Converts an ArrayBuffer to a hexadecimal string.
- * @param {Uint8Array} buffer - The Uint8Array to convert.
- * @returns {string} The hexadecimal string representation.
+ * @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.
+ * @property {(params: AuthParams, persistence: SessionPreference) => Promise<AuthResponse>} login - Logs in the user and stores tokens.
+ * @property {function(): 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.
  */
-declare function ab2hex(buffer: Uint8Array): string;
 /**
- * Converts a hexadecimal string to a Uint8Array.
- * @param {string} hex - The hexadecimal string to convert.
- * @returns {Uint8Array} The Uint8Array representation.
- */
-declare function hex2ab(hex: string): Uint8Array;
-/**
- * Imports a secret key for cryptographic operations.
- * @param {string} secretKey - The string secret key.
- * @returns {Promise<CryptoKey>} A Promise that resolves to the CryptoKey.
- */
-declare function importKey(secretKey: string): Promise<CryptoKey>;
-/**
- * Interface for the expected structure of a successful login response from the API.
- */
-interface LoginResponse {
-    access_token: string;
-    refresh_token: string;
-    [key: string]: unknown;
-}
-/**
- * Interface for the expected structure of a successful token refresh response from the API.
- */
-interface RefreshResponse {
-    access_token: string;
-    refresh_token: string;
-    [key: string]: unknown;
-}
-/**
- * A Vue composable that provides authentication utilities, enforcing asynchronous access to tokens.
- * All token-related properties and status checks are awaitable functions.
- * @param {string} [secretKey=getSecretKey()] - The encryption/decryption key. Defaults to a globally configured key.
- * @returns {object} An object containing asynchronous authentication methods and properties.
+ * Custom hook for authentication logic, including login, logout, token management, and session preference.
+ *
+ * @param {string} secretKey - The secret key used for token encryption/decryption.
+ * @returns {AuthHook} An object containing authentication functions.
  */
 export declare function useAuth(secretKey?: string): {
     getJwt: () => Promise<string | null>;
-    getRefreshToken: () => Promise<string | null>;
-    isAuthenticated: () => Promise<boolean>;
     getTokenExpiry: () => Promise<number | null>;
-    login: (params: object | undefined, isRememberMe: boolean) => Promise<LoginResponse>;
-    refresh: () => Promise<RefreshResponse>;
-    logout: (params?: object) => Promise<void>;
-    cleanStorage: () => Promise<void>;
-    verifyToken: () => Promise<void>;
-    ab2hex: typeof ab2hex;
-    hex2ab: typeof hex2ab;
-    importKey: typeof importKey;
-    encrypt: (value: string, secretKey: string) => Promise<string>;
-    decrypt: (value: string, secretKey: string) => Promise<string>;
+    cleanCredentials: (preference: SessionPreference) => Promise<void>;
+    logout: (params?: AuthParams) => Promise<void>;
+    login: (params: AuthParams, persistence: SessionPreference) => Promise<AuthResponse>;
+    refresh: () => Promise<AuthResponse>;
+    verifyAuth: () => Promise<boolean>;
 };
-export {};

package/dist/config/axios/axiosInstance.d.ts

@@ -1,19 +1,41 @@
-import { AxiosInstance } from 'axios';
+import { AxiosInstance } from "axios";
+/**
+ * Configuration object for the Axios instance.
+ */
+interface AxiosConfig {
+    baseURL: string;
+}
+/**
+ * Configuration object for a custom Axios instance.
+ */
+interface CustomAxiosConfig {
+    baseURL: string;
+    headers?: Record<string, string>;
+}
 /**
  * Configures the global Axios instance with a base URL.
- * @param {string} baseURL - The base URL for the Axios instance.
+ *
+ * @param {AxiosConfig} config - An object containing the base URL for the Axios instance.
+ * @param {string} config.baseURL - The base URL for the Axios instance.
+ *
+ * @returns {void}
  */
-export declare const configAxios: (baseURL: string) => void;
+export declare const configAxios: (config: AxiosConfig) => void;
 /**
  * Retrieves the configured Axios instance.
+ *
  * @returns {AxiosService} The configured Axios instance.
  * @throws Will throw an error if the Axios instance is not configured.
  */
 export declare const getAxiosInstance: () => AxiosInstance;
 /**
  * Creates a new AxiosService instance with custom headers.
- * @param {string} baseURL - The base URL for the Axios instance.
- * @param {Record<string, string>} headers - Custom headers to set.
+ *
+ * @param {CustomAxiosConfig} config - An object containing the base URL and optional custom headers.
+ * @param {string} config.baseURL - The base URL for the Axios instance.
+ * @param {Record<string, string>} [config.headers] - Custom headers to set (optional).
+ *
  * @returns {AxiosService} The new AxiosService instance.
  */
-export declare const createCustomAxiosInstance: (baseURL: string, headers: Record<string, string>) => AxiosInstance;
+export declare const createCustomAxiosInstance: (config: CustomAxiosConfig) => AxiosInstance;
+export {};

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

@@ -1,15 +1,24 @@
 import { EndpointsConfig } from "@/types";
+/**
+ * Configuration object for authentication endpoints.
+ */
+interface EndpointConfig {
+    loginEndpoint: string;
+    refreshEndpoint: string;
+    logoutEndpoint: string;
+}
 /**
  * Configures authentication endpoint URLs globally.
  * This function freezes the object to prevent further modifications.
  *
- * @param {string} loginEndpoint - URL of the login endpoint.
- * @param {string} refreshEndpoint - URL of the refresh token endpoint.
- * @param {string} logoutEndpoint - URL of the logout endpoint.
+ * @param {EndpointConfig} config - An object containing the authentication endpoint URLs.
+ * @param {string} config.loginEndpoint - URL of the login endpoint.
+ * @param {string} config.refreshEndpoint - URL of the refresh token endpoint.
+ * @param {string} config.logoutEndpoint - URL of the logout endpoint.
  *
  * @returns {void} Does not return anything but freezes the endpoint configuration object.
  */
-export declare function configEndpoints(loginEndpoint: string, refreshEndpoint: string, logoutEndpoint: string): void;
+export declare function configEndpoints(config: EndpointConfig): void;
 /**
  * Retrieves the configured authentication endpoint URLs.
  *
@@ -19,3 +28,4 @@ export declare function configEndpoints(loginEndpoint: string, refreshEndpoint:
  * @property {string} LOGOUT - URL of the logout endpoint.
  */
 export declare function getEndpointsConfig(): EndpointsConfig;
+export {};

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

@@ -1,18 +1,34 @@
+export type SessionPreference = "local" | "session";
 /**
- * Configures the session identifier for the active browser session.
- * Once configured, it cannot be modified.
+ * Configuration object for the session.
+ */
+interface SessionConfigObject {
+    /** The unique session identifier. */
+    sessionId?: string;
+    /** The storage preference: 'local' for localStorage, 'session' for sessionStorage. */
+    persistencePreference?: SessionPreference;
+}
+/**
+ * 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 {string} sessionIdParam - The unique session identifier.
+ * @param {SessionConfigObject} config - An object containing the unique session identifier and/or persistence preference.
  *
- * @returns {void} Does not return anything, but freezes the session configuration.
+ * @returns {void} Does not return anything, but freezes the session configuration (for ID) and updates preference.
  */
-export declare function configSession(sessionIdParam: string): void;
+export declare function configSession(config: SessionConfigObject): void;
 /**
  * Retrieves the current session identifier configuration.
  *
  * @returns {string} The unique session identifier.
  */
 export declare function getSessionConfig(): string;
+/**
+ * Retrieves the current data persistence preference.
+ *
+ * @returns {SessionPreference} The configured persistence preference ('local' or 'session').
+ */
+export declare function getSessionPersistencePreference(): SessionPreference;
 /**
  * Generates a new UUID for the current session.
  *
@@ -25,3 +41,4 @@ export declare function regenerateSessionId(): void;
  * @returns {string} The unique session identifier.
  */
 export declare function getSessionId(): string;
+export {};

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

@@ -1,14 +1,22 @@
 import { TokensConfig } from "@/types";
+/**
+ * Configuration object for token keys.
+ */
+interface TokenKeyConfig {
+    accessTokenKey: string;
+    refreshTokenKey: string;
+}
 /**
  * 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.
+ * @param {TokenKeyConfig} config - An object containing the token keys.
+ * @param {string} config.accessTokenKey - The name of the key for the access token.
+ * @param {string} config.refreshTokenKey - The name of the key for the refresh token.
  *
- * @returns {void} Does not return anything but freezes the token configuration object.
+ * @returns {void} Does not return anything, but freezes the token configuration object.
  */
-export declare function configTokenKeys(accessTokenKey: string, refreshTokenKey: string): void;
+export declare function configTokenKeys(config: TokenKeyConfig): void;
 /**
  * Retrieves the current token configuration.
  *
@@ -29,3 +37,4 @@ export declare function setSecretKey(key: string): void;
  * @returns {string} The configured secret key.
  */
 export declare function getSecretKey(): string;
+export {};

package/dist/index.d.ts

@@ -1,6 +1,22 @@
-export * from './rest';
-export * from './composables';
-export * from './config';
-export * from './enums';
-export * from './types';
-export * from './utils';
+import { App } from "vue";
+import { ArexVueCoreOptions } from "./types/ArexVueCoreOptions";
+/**
+ * The Vue plugin for @arex95/vue-core.
+ * Configures the core functionalities for authentication and API communication.
+ */
+export declare const ArexVueCore: {
+    /**
+     * The `install` method is the entry point for the Vue plugin.
+     * It is automatically called when `app.use(ArexVueCore, options)` is executed.
+     *
+     * @param app The Vue application instance.
+     * @param options The configuration options provided by the user.
+     */
+    install: (app: App, options: ArexVueCoreOptions) => void;
+};
+export * from "./rest";
+export * from "./composables";
+export * from "./config";
+export * from "./enums";
+export * from "./types";
+export * from "./utils";