@arex95/vue-core 1.0.8 → 1.1.0

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

@@ -1,27 +1,24 @@
+import { AuthConfig } from "@/types";
 /**
- * Función para configurar los endpoints y las claves de almacenamiento globalmente.
- * Permite modificar los valores predeterminados de los endpoints y claves de almacenamiento.
+ * Configures authentication settings globally.
+ * Allows modifying default endpoints and storage keys.
  *
- * @param {Object} options - Configuración personalizada.
- * @param {Object} options.endpoints - Endpoints personalizados para login, refresh y logout.
- * @param {Object} options.storageKeys - Claves personalizadas para el almacenamiento de tokens.
+ * @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.
  */
-export declare function configureAuth(options: {
-    endpoints?: {
-        login?: string;
-        refresh?: string;
-        logout?: string;
-    };
-    storageKeys?: {
-        token?: string;
-        refreshToken?: string;
-    };
-}): void;
-export declare function useAuth(secretKey: string): {
+export declare function configureAuth(options: AuthConfig): void;
+/**
+ * Provides authentication utilities.
+ *
+ * @param {string} [secretKey=getSecretKey()] - Encryption key.
+ * @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>;
     tokenExpiry: import("vue").ComputedRef<number | null>;
-    login: (params?: {}) => Promise<import("axios").AxiosResponse<any, any>>;
+    login: (params: {} | undefined, isRememberMe: boolean) => Promise<import("axios").AxiosResponse<any, any>>;
     refresh: () => Promise<import("axios").AxiosResponse<any, any> | undefined>;
     logout: (params?: {}) => Promise<void>;
     cleanStorage: () => Promise<void>;

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

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

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

@@ -0,0 +1,15 @@
+/**
+ * Hook para detectar la inactividad del usuario.
+ * @param timeout - Tiempo en milisegundos antes de considerar al usuario inactivo. Por defecto es 5 minutos.
+ * @param useDefaultEvents - Si se deben usar los eventos por defecto (mousemove, keydown, scroll, touchstart).
+ * @param customEvents - Lista personalizada de eventos para detectar actividad.
+ * @returns Un objeto con el estado de inactividad, funciones para controlar el temporizador y registrar callbacks.
+ */
+export declare function useUserInactivity(timeout?: number, useDefaultEvents?: boolean, customEvents?: Array<keyof WindowEventMap>): {
+    isInactive: import("vue").Ref<boolean, boolean>;
+    startInactivityTimer: () => void;
+    stopInactivityTimer: () => void;
+    resetInactivityTimer: () => void;
+    onTimeout: (callback: () => void) => void;
+    removeTimeoutCallback: (callback: () => void) => void;
+};

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

@@ -3,7 +3,7 @@ import { AxiosInstance } from 'axios';
  * Configures the global Axios instance with a base URL.
  * @param {string} baseURL - The base URL for the Axios instance.
  */
-export declare const configureAxios: (baseURL: string) => void;
+export declare const configAxios: (baseURL: string) => void;
 /**
  * Retrieves the configured Axios instance.
  * @returns {AxiosService} The configured Axios instance.

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

@@ -1,24 +1,21 @@
+import { EndpointsConfig } from "@/types";
 /**
- * Configura las URLs de los endpoints de autenticación globalmente.
- * Esta función congela el objeto para evitar modificaciones posteriores.
+ * Configures authentication endpoint URLs globally.
+ * This function freezes the object to prevent further modifications.
  *
- * @param {string} loginEndpoint - URL del endpoint para el login.
- * @param {string} refreshEndpoint - URL del endpoint para el refresh token.
- * @param {string} logoutEndpoint - URL del endpoint para el logout.
+ * @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.
  *
- * @returns {void} No retorna nada, pero congela el objeto de configuración de endpoints.
+ * @returns {void} Does not return anything but freezes the endpoint configuration object.
  */
-export declare function configureEndpoints(loginEndpoint: string, refreshEndpoint: string, logoutEndpoint: string): void;
+export declare function configEndpoints(loginEndpoint: string, refreshEndpoint: string, logoutEndpoint: string): void;
 /**
- * Obtiene las URLs de los endpoints de autenticación configurados.
+ * Retrieves the configured authentication endpoint URLs.
  *
- * @returns {Object} Objeto con las URLs de los endpoints configurados.
- * @returns {string} returns.LOGIN - URL del endpoint de login.
- * @returns {string} returns.REFRESH - URL del endpoint de refresh token.
- * @returns {string} returns.LOGOUT - URL del endpoint de logout.
+ * @returns {EndpointsConfig} An object containing the configured authentication endpoints.
+ * @property {string} LOGIN - URL of the login endpoint.
+ * @property {string} REFRESH - URL of the refresh token endpoint.
+ * @property {string} LOGOUT - URL of the logout endpoint.
  */
-export declare function getEndpointsConfig(): {
-    LOGIN: string;
-    REFRESH: string;
-    LOGOUT: string;
-};
+export declare function getEndpointsConfig(): EndpointsConfig;

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

@@ -0,0 +1,27 @@
+/**
+ * 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.
+ */
+export declare function configSession(sessionIdParam: string): void;
+/**
+ * Retrieves the current session identifier configuration.
+ *
+ * @returns {string} The unique session identifier.
+ */
+export declare function getSessionConfig(): string;
+/**
+ * Generates a new UUID for the current session.
+ *
+ * @returns {void} Does not return anything, but updates the session identifier.
+ */
+export declare function regenerateSessionId(): void;
+/**
+ * Retrieves the current session identifier.
+ *
+ * @returns {string} The unique session identifier.
+ */
+export declare function getSessionId(): string;

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

@@ -1,15 +1,31 @@
+import { TokenConfig } from "@/types";
 /**
- * Función para configurar las claves globalmente.
- * Esta función congela el objeto para evitar modificaciones posteriores.
- * @param {string} accessTokenKey - Nombre de la clave del token de acceso
- * @param {string} refreshTokenKey - Nombre de la clave del refresh token
+ * 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 configureTokenKeys(accessTokenKey: string, refreshTokenKey: string): void;
+export declare function configTokens(accessTokenKey: string, refreshTokenKey: string): void;
 /**
- * Obtiene las claves configuradas para los tokens.
- * El objeto está congelado, por lo que no se puede modificar directamente.
+ * Retrieves the current token configuration.
+ *
+ * @returns {TokenConfig} The configuration of the access and refresh token keys.
  */
-export declare function getTokenConfig(): {
-    ACCESS_TOKEN: string;
-    REFRESH_TOKEN: string;
-};
+export declare function getTokenConfig(): TokenConfig;
+/**
+ * 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/enums/breakpointsEnums.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Enum defining available screen sizes.
+ */
+export declare enum ScreenSize {
+    XS = "XS",
+    SM = "SM",
+    MD = "MD",
+    LG = "LG",
+    XL = "XL",
+    XXL = "XXL"
+}
+/**
+ * Enum defining breakpoints for design based on screen width.
+ * Values are in pixels.
+ */
+export declare enum ScreenBreakpoint {
+    XS = 480,
+    SM = 576,
+    MD = 768,
+    LG = 992,
+    XL = 1200,
+    XXL = 1600
+}
+/**
+ * Map that associates each screen size defined in `ScreenSize` with its corresponding pixel value from `ScreenBreakpoint`.
+ * @type {Map<ScreenSize, number>}
+ */
+declare const screenMap: Map<ScreenSize, number>;
+export { screenMap };

package/dist/enums/contentTypesEnums.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Enum representing different content types for HTTP headers.
+ * @readonly
+ */
+export declare enum ContentTypeEnum {
+    /**
+     * Content type for JSON.
+     * @constant
+     */
+    JSON = "application/json;charset=UTF-8",
+    /**
+     * Content type for URL-encoded form data.
+     * @constant
+     */
+    FORM_URLENCODED = "application/x-www-form-urlencoded;charset=UTF-8",
+    /**
+     * Content type for multipart form data with file uploads.
+     * @constant
+     */
+    FORM_DATA = "multipart/form-data;charset=UTF-8",
+    /**
+     * Content type for plain text.
+     * @constant
+     */
+    TEXT_PLAIN = "text/plain;charset=UTF-8",
+    /**
+     * Content type for XML data.
+     * @constant
+     */
+    XML = "application/xml;charset=UTF-8",
+    /**
+     * Content type for HTML data.
+     * @constant
+     */
+    HTML = "text/html;charset=UTF-8",
+    /**
+     * Content type for JavaScript files.
+     * @constant
+     */
+    JS = "application/javascript;charset=UTF-8",
+    /**
+     * Content type for CSV files.
+     * @constant
+     */
+    CSV = "text/csv;charset=UTF-8",
+    /**
+     * Content type for PDF files.
+     * @constant
+     */
+    PDF = "application/pdf",
+    /**
+     * Content type for octet-stream (binary data).
+     * @constant
+     */
+    OCTET_STREAM = "application/octet-stream"
+}

package/dist/enums/errorsEnums.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Enum representing different types of errors.
+ * @readonly
+ */
+export declare enum ErrorEnum {
+    WARNING = "warning",
+    ERROR = "error",
+    CRITICAL = "critical",
+    VALIDATION = "validation",
+    COMPONENT = "component",
+    NETWORK = "network",
+    AUTHENTICATION = "authentication",
+    RUNTIME = "runtime",
+    TYPE = "type",
+    REFERENCE = "reference",
+    SYNTAX = "syntax",
+    RANGE = "range",
+    EVAL = "eval",
+    URI = "uri"
+}
+/**
+ * Enum representing different error messages.
+ * @readonly
+ */
+export declare enum ErrorMessages {
+    WARNING = "Algo no est\u00E1 del todo bien. Verifica y vuelve a intentar.",
+    ERROR = "Ocurri\u00F3 un error inesperado.",
+    CRITICAL = "Error cr\u00EDtico. Contacta al soporte t\u00E9cnico.",
+    VALIDATION = "Hay errores en el formulario. Revisa los campos.",
+    COMPONENT = "Error en la carga del componente. Intenta recargar.",
+    NETWORK = "Problema de conexi\u00F3n. Verifica tu internet.",
+    AUTHENTICATION = "No tienes permisos para realizar esta acci\u00F3n.",
+    RUNTIME = "Error de ejecuci\u00F3n. Intenta nuevamente.",
+    TYPE = "Tipo de error no identificado.",
+    REFERENCE = "Referencia no v\u00E1lida.",
+    SYNTAX = "Error de sintaxis en el c\u00F3digo.",
+    RANGE = "Error en el rango de valores.",
+    EVAL = "Error en la evaluaci\u00F3n.",
+    URI = "URI no v\u00E1lida."
+}
+/**
+ * Enum representing different error styles.
+ * @readonly
+ */
+export declare enum ErrorStyles {
+    WARNING = "color: orange; font-weight: bold;",
+    ERROR = "color: red; font-weight: bold;",
+    CRITICAL = "color: white; background-color: red; font-weight: bold; padding: 2px;",
+    VALIDATION = "color: blue; font-weight: bold;",
+    COMPONENT = "color: purple; font-weight: bold;",
+    NETWORK = "color: cyan; font-weight: bold;",
+    AUTHENTICATION = "color: brown; font-weight: bold;",
+    RUNTIME = "color: darkred; font-weight: bold;",
+    TYPE = "color: gray; font-weight: bold;",
+    REFERENCE = "color: darkorange; font-weight: bold;",
+    SYNTAX = "color: darkblue; font-weight: bold;",
+    RANGE = "color: darkgreen; font-weight: bold;",
+    EVAL = "color: darkviolet; font-weight: bold;",
+    URI = "color: darkcyan; font-weight: bold;"
+}
+/**
+ * A record mapping ErrorEnum to their corresponding error messages.
+ */
+export declare const ERROR_MESSAGES: Record<ErrorEnum, string>;
+/**
+ * A record mapping ErrorEnum to their corresponding error styles.
+ */
+export declare const ERROR_STYLES: Record<ErrorEnum, string>;

package/dist/enums/fileTypesEnums.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Enum representing various MIME types for different file categories.
+ * @readonly
+ */
+export declare enum ImageTypes {
+    APNG = "image/apng",
+    BMP = "image/bmp",
+    GIF = "image/gif",
+    JPEG = "image/jpeg",
+    PJPEG = "image/pjpeg",
+    PNG = "image/png",
+    SVG = "image/svg+xml",
+    TIFF = "image/tiff",
+    WEBP = "image/webp",
+    XICON = "image/x-icon"
+}
+export declare enum AudioTypes {
+    Audios = "audio/*"
+}
+export declare enum VideoTypes {
+    Videos = "video/*"
+}
+export declare enum TextTypes {
+    PlainText = "text/plain",
+    HTML = "text/html",
+    CSS = "text/css",
+    JavaScript = "application/javascript",
+    CSV = "text/csv",
+    JSON = "application/json",
+    XML = "application/xml"
+}
+export declare enum DocumentTypes {
+    PDF = "application/pdf",
+    Word = "application/msword",
+    WordOpenXML = "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+    Excel = "application/vnd.ms-excel",
+    ExcelOpenXML = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+    PowerPoint = "application/vnd.ms-powerpoint",
+    PowerPointOpenXML = "application/vnd.openxmlformats-officedocument.presentationml.presentation"
+}
+export declare enum ArchiveTypes {
+    ZIP = "application/zip",
+    GZIP = "application/gzip",
+    TAR = "application/x-tar",
+    RAR = "application/x-rar-compressed"
+}
+export declare enum FontTypes {
+    TrueType = "font/ttf",
+    OpenType = "font/otf",
+    WebOpenFont = "font/woff",
+    WebOpenFont2 = "font/woff2"
+}
+export declare enum AppTypes {
+    Executable = "application/octet-stream",
+    AndroidAPK = "application/vnd.android.package-archive",
+    Java = "application/java-archive"
+}
+export declare enum OtherTypes {
+    JSONLD = "application/ld+json",
+    WASM = "application/wasm"
+}

package/dist/enums/httpExceptionsEnums.d.ts

@@ -0,0 +1,71 @@
+/**
+ * Enum representing all HTTP exception codes.
+ * @readonly
+ */
+export declare enum ExceptionEnum {
+    CONTINUE = 100,
+    SWITCHING_PROTOCOLS = 101,
+    PROCESSING = 102,
+    EARLY_HINTS = 103,
+    OK = 200,
+    CREATED = 201,
+    ACCEPTED = 202,
+    NON_AUTHORITATIVE_INFORMATION = 203,
+    NO_CONTENT = 204,
+    RESET_CONTENT = 205,
+    PARTIAL_CONTENT = 206,
+    MULTI_STATUS = 207,
+    ALREADY_REPORTED = 208,
+    IM_USED = 226,
+    MULTIPLE_CHOICES = 300,
+    MOVED_PERMANENTLY = 301,
+    FOUND = 302,
+    SEE_OTHER = 303,
+    NOT_MODIFIED = 304,
+    USE_PROXY = 305,
+    UNUSED = 306,// Deprecated
+    TEMPORARY_REDIRECT = 307,
+    PERMANENT_REDIRECT = 308,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    PAYMENT_REQUIRED = 402,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    NOT_ACCEPTABLE = 406,
+    PROXY_AUTHENTICATION_REQUIRED = 407,
+    REQUEST_TIMEOUT = 408,
+    CONFLICT = 409,
+    GONE = 410,
+    LENGTH_REQUIRED = 411,
+    PRECONDITION_FAILED = 412,
+    PAYLOAD_TOO_LARGE = 413,
+    URI_TOO_LONG = 414,
+    UNSUPPORTED_MEDIA_TYPE = 415,
+    RANGE_NOT_SATISFIABLE = 416,
+    EXPECTATION_FAILED = 417,
+    IM_A_TEAPOT = 418,// RFC 2324 - Easter egg
+    MISDIRECTED_REQUEST = 421,
+    UNPROCESSABLE_ENTITY = 422,
+    LOCKED = 423,
+    FAILED_DEPENDENCY = 424,
+    TOO_EARLY = 425,
+    UPGRADE_REQUIRED = 426,
+    PRECONDITION_REQUIRED = 428,
+    TOO_MANY_REQUESTS = 429,
+    REQUEST_HEADER_FIELDS_TOO_LARGE = 431,
+    UNAVAILABLE_FOR_LEGAL_REASONS = 451,
+    INTERNAL_SERVER_ERROR = 500,
+    NOT_IMPLEMENTED = 501,
+    BAD_GATEWAY = 502,
+    SERVICE_UNAVAILABLE = 503,
+    GATEWAY_TIMEOUT = 504,
+    HTTP_VERSION_NOT_SUPPORTED = 505,
+    VARIANT_ALSO_NEGOTIATES = 506,
+    INSUFFICIENT_STORAGE = 507,
+    LOOP_DETECTED = 508,
+    NOT_EXTENDED = 510,
+    NETWORK_AUTHENTICATION_REQUIRED = 511,
+    NET_WORK_ERROR = 10000,// Custom network error
+    PAGE_NOT_DATA = 10100
+}

package/dist/enums/index.d.ts

@@ -0,0 +1,7 @@
+export * from './breakpointsEnums';
+export * from './httpExceptionsEnums';
+export * from './fileTypesEnums';
+export * from './contentTypesEnums';
+export * from './keyCodesEnums';
+export * from './storageEnums';
+export * from './errorsEnums';

package/dist/enums/keyCodesEnums.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Enum for key codes used in keyboard events.
+ * This object holds various key codes commonly used for handling keyboard events.
+ * The keys defined here correspond to specific key codes that can be used to detect
+ * user input in web applications.
+ * @readonly
+ * @enum {number}
+ */
+export declare enum KeyCodeEnum {
+    /** Arrow Up key */
+    UP = 38,
+    /** Arrow Down key */
+    DOWN = 40,
+    /** Enter key */
+    ENTER = 13,
+    /** Escape key */
+    ESC = 27,
+    /** Spacebar key */
+    SPACE = 32,
+    /** Tab key */
+    TAB = 9,
+    /** Backspace key */
+    BACKSPACE = 8,
+    /** Delete key */
+    DELETE = 46,
+    /** Arrow Left key */
+    LEFT = 37,
+    /** Arrow Right key */
+    RIGHT = 39,
+    /** Shift key */
+    SHIFT = 16,
+    /** Control key */
+    CONTROL = 17,
+    /** Alt key */
+    ALT = 18,
+    /** Caps Lock key */
+    CAPS_LOCK = 20,
+    /** F1 key */
+    F1 = 112,
+    /** F2 key */
+    F2 = 113,
+    /** F3 key */
+    F3 = 114,
+    /** F4 key */
+    F4 = 115,
+    /** F5 key */
+    F5 = 116,
+    /** F6 key */
+    F6 = 117,
+    /** F7 key */
+    F7 = 118,
+    /** F8 key */
+    F8 = 119,
+    /** F9 key */
+    F9 = 120,
+    /** F10 key */
+    F10 = 121,
+    /** F11 key */
+    F11 = 122,
+    /** F12 key */
+    F12 = 123
+}

package/dist/enums/storageEnums.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Enum for different storage keys used in the application.
+ * This enum contains the keys for storing authentication token, locale information, user info, roles, and more.
+ * @readonly
+ * @enum {string}
+ */
+export declare enum StorageKeyEnum {
+    /**
+     * Key used for storing the authentication token.
+     * @constant {string}
+     */
+    TOKEN_KEY = "TOKEN__",
+    /**
+     * Key used for storing the locale information.
+     * @constant {string}
+     */
+    LOCALE_KEY = "LOCALE__",
+    /**
+     * Key used for storing user information.
+     * @constant {string}
+     */
+    USER_INFO_KEY = "USER__INFO__",
+    /**
+     * Key used for storing role information.
+     * @constant {string}
+     */
+    ROLES_KEY = "ROLES__KEY__",
+    /**
+     * Key used for storing project configuration.
+     * @constant {string}
+     */
+    PROJ_CFG_KEY = "PROJ__CFG__KEY__",
+    /**
+     * Key used for storing lock information.
+     * @constant {string}
+     */
+    LOCK_INFO_KEY = "LOCK__INFO__KEY__",
+    /**
+     * Key used for base global local cache.
+     * @constant {string}
+     */
+    APP_LOCAL_CACHE_KEY = "COMMON__LOCAL__KEY",
+    /**
+     * Key used for base global session cache.
+     * @constant {string}
+     */
+    APP_SESSION_CACHE_KEY = "COMMON__SESSION__KEY"
+}
+/**
+ * Enum defining types of storage.
+ * @readonly
+ * @enum {number}
+ */
+export declare const StorageTypeEnum: {
+    /**
+     * Represents session storage.
+     * @constant {number}
+     */
+    readonly SESSION: 0;
+    /**
+     * Represents local storage.
+     * @constant {number}
+     */
+    readonly LOCAL: 1;
+};
+export type StorageTypeEnum = keyof typeof StorageTypeEnum;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export * from './rest';
 export * from './composables';
 export * from './config';
-export * from './constants';
+export * from './enums';
 export * from './types';
 export * from './utils';