@arex95/vue-core 1.1.43 → 3.0.0

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

@@ -3,34 +3,33 @@ interface TokenPathsConfig {
     refreshTokenPath?: string;
 }
 /**
- * Configures the paths for access and refresh tokens in the authentication response.
- * This function freezes the object to prevent further modifications.
+ * Configures the dot-notation paths for extracting access and refresh tokens from the initial login response.
+ * The configuration is frozen to prevent runtime changes.
  *
- * @param {TokenPathsConfig} config - An object containing the paths for access and refresh tokens.
- * @param {string} [config.accessTokenPath="data.access_token"] - Path to the access token in the response.
- * @param {string} [config.refreshTokenPath="data.refresh_token"] - Path to the refresh token in the response.
- *
- * @returns {void} Does not return anything but freezes the token paths configuration object.
+ * @param {TokenPathsConfig} config - An object containing the token paths.
+ * @param {string} [config.accessTokenPath="data.access_token"] - The path to the access token.
+ * @param {string} [config.refreshTokenPath="data.refresh_token"] - The path to the refresh token.
  */
 export declare function configTokenPaths(config: TokenPathsConfig): void;
 /**
- * Configures the paths for access and refresh tokens in the refresh response.
- * This function freezes the object to prevent further modifications.
- *
- * @param {TokenPathsConfig} config - An object containing the paths for access and refresh tokens.
- * @param {string} [config.accessTokenPath="data.access_token"] - Path to the access token in the response.
- * @param {string} [config.refreshTokenPath="data.refresh_token"] - Path to the refresh token in the response.
+ * Configures the dot-notation paths for extracting access and refresh tokens from the token refresh response.
+ * The configuration is frozen to prevent runtime changes.
  *
- * @returns {void} Does not return anything but freezes the refresh token paths configuration object.
+ * @param {TokenPathsConfig} config - An object containing the token paths for the refresh response.
+ * @param {string} [config.accessTokenPath="data.access_token"] - The path to the new access token.
+ * @param {string} [config.refreshTokenPath="data.refresh_token"] - The path to the new refresh token.
  */
 export declare function configRefreshTokenPaths(config: TokenPathsConfig): void;
 /**
- * Retrieves the configured authentication token paths.
+ * Retrieves the configured token paths for the initial login response.
  *
- * @returns {AuthTokenPaths} An object containing the configured authentication token paths.
- * @property {string} accessTokenPath - Path to the access token in the response.
- * @property {string} refreshTokenPath - Path to the refresh token in the response.
+ * @returns {AuthTokenPaths} A frozen object containing the `accessTokenPath` and `refreshTokenPath`.
  */
 export declare function getTokenPathsConfig(): TokenPathsConfig;
+/**
+ * Retrieves the configured token paths for the token refresh response.
+ *
+ * @returns {AuthTokenPaths} A frozen object containing the `accessTokenPath` and `refreshTokenPath` for the refresh response.
+ */
 export declare function getRefreshTokenPathsConfig(): TokenPathsConfig;
 export {};

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

@@ -7,20 +7,20 @@ interface TokenKeyConfig {
     refreshTokenKey: string;
 }
 /**
- * Configures the global keys for access and refresh tokens.
- * Once set, they cannot be modified.
+ * Configures the global storage keys for the access and refresh tokens.
+ * This function should be called once at application startup to define the keys
+ * used for storing tokens in `localStorage` or `sessionStorage`. The configuration
+ * is frozen to prevent runtime changes.
  *
- * @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.
+ * @param {TokenKeyConfig} config - An object containing the token storage keys.
+ * @param {string} config.accessTokenKey - The key for the access token.
+ * @param {string} config.refreshTokenKey - The key for the refresh token.
  */
 export declare function configTokenKeys(config: TokenKeyConfig): void;
 /**
- * Retrieves the current token configuration.
+ * Retrieves the configured storage keys for the access and refresh tokens.
  *
- * @returns {TokensConfig} The configuration of the access and refresh token keys.
+ * @returns {TokensConfig} A frozen object containing the `ACCESS_TOKEN` and `REFRESH_TOKEN` keys.
  */
 export declare function getTokenConfig(): TokensConfig;
 export {};

package/dist/config/index.d.ts

@@ -1,2 +1,3 @@
 export * from './axios';
 export * from './global';
+export * from './auth';

package/dist/enums/breakpointsEnums.d.ts

@@ -1,5 +1,6 @@
 /**
- * Enum defining available screen sizes.
+ * An enum that defines a set of standardized screen size labels, ranging from extra-small (XS) to extra-extra-large (XXL).
+ * These labels are used to create a consistent vocabulary for responsive design across the application.
  */
 export declare enum ScreenSize {
     XS = "XS",
@@ -10,8 +11,8 @@ export declare enum ScreenSize {
     XXL = "XXL"
 }
 /**
- * Enum defining breakpoints for design based on screen width.
- * Values are in pixels.
+ * An enum that establishes specific pixel values for screen width breakpoints, corresponding to the labels in `ScreenSize`.
+ * These values are used to implement responsive design changes at standard device widths.
  */
 export declare enum ScreenBreakpoint {
     XS = 480,
@@ -22,7 +23,9 @@ export declare enum ScreenBreakpoint {
     XXL = 1600
 }
 /**
- * Map that associates each screen size defined in `ScreenSize` with its corresponding pixel value from `ScreenBreakpoint`.
+ * A map that associates the symbolic screen size names from the `ScreenSize` enum with their
+ * corresponding pixel values from the `ScreenBreakpoint` enum. This provides an easy way to
+ * look up the pixel width for a given screen size label.
  * @type {Map<ScreenSize, number>}
  */
 declare const screenMap: Map<ScreenSize, number>;

package/dist/enums/errorsEnums.d.ts

@@ -1,5 +1,7 @@
 /**
- * Enum representing different types of errors.
+ * An enum that defines a vocabulary of error types, covering a wide range of potential issues
+ * from validation and network problems to runtime and syntax errors. This provides a standardized
+ * way to classify errors throughout the application.
  * @readonly
  */
 export declare enum ErrorEnum {
@@ -19,27 +21,30 @@ export declare enum ErrorEnum {
     URI = "uri"
 }
 /**
- * Enum representing different error messages.
+ * An enum that provides standardized, user-friendly messages for different error types.
+ * These messages are intended to be displayed to the user or used in logs.
  * @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."
+    WARNING = "Something is not quite right. Please check and try again.",
+    ERROR = "An unexpected error occurred.",
+    CRITICAL = "Critical error. Please contact technical support.",
+    VALIDATION = "There are errors in the form. Please review the fields.",
+    COMPONENT = "Error loading the component. Try reloading.",
+    NETWORK = "Connection problem. Please check your internet.",
+    AUTHENTICATION = "You do not have permission to perform this action.",
+    RUNTIME = "Execution error. Please try again.",
+    TYPE = "Unidentified error type.",
+    REFERENCE = "Invalid reference.",
+    SYNTAX = "Syntax error in the code.",
+    RANGE = "Error in the range of values.",
+    EVAL = "Error in evaluation.",
+    URI = "Invalid URI."
 }
 /**
- * Enum representing different error styles.
+ * An enum that defines CSS styles for console log messages, corresponding to each error type in `ErrorEnum`.
+ * This allows for visually distinct, styled logging in the browser's console, making it easier to
+ * identify the severity and type of logged errors during development.
  * @readonly
  */
 export declare enum ErrorStyles {
@@ -59,10 +64,12 @@ export declare enum ErrorStyles {
     URI = "color: darkcyan; font-weight: bold;"
 }
 /**
- * A record mapping ErrorEnum to their corresponding error messages.
+ * A frozen record that maps each `ErrorEnum` member to its corresponding user-friendly message from `ErrorMessages`.
+ * This provides a convenient, type-safe way to look up error messages.
  */
 export declare const ERROR_MESSAGES: Record<ErrorEnum, string>;
 /**
- * A record mapping ErrorEnum to their corresponding error styles.
+ * A frozen record that maps each `ErrorEnum` member to its corresponding CSS style string from `ErrorStyles`.
+ * This enables easy retrieval of the correct style for console logging based on the error type.
  */
 export declare const ERROR_STYLES: Record<ErrorEnum, string>;

package/dist/enums/fileTypesEnums.d.ts

@@ -1,5 +1,5 @@
 /**
- * Enum representing various MIME types for different file categories.
+ * An enum that defines MIME types for common image formats.
  * @readonly
  */
 export declare enum ImageTypes {
@@ -14,12 +14,24 @@ export declare enum ImageTypes {
     WEBP = "image/webp",
     XICON = "image/x-icon"
 }
+/**
+ * An enum for generic audio MIME types.
+ * @readonly
+ */
 export declare enum AudioTypes {
     Audios = "audio/*"
 }
+/**
+ * An enum for generic video MIME types.
+ * @readonly
+ */
 export declare enum VideoTypes {
     Videos = "video/*"
 }
+/**
+ * An enum that defines MIME types for various text-based formats, including plain text, markup, and data serialization formats.
+ * @readonly
+ */
 export declare enum TextTypes {
     PlainText = "text/plain",
     HTML = "text/html",
@@ -29,6 +41,10 @@ export declare enum TextTypes {
     JSON = "application/json",
     XML = "application/xml"
 }
+/**
+ * An enum that defines MIME types for common document formats, such as PDFs and Microsoft Office files.
+ * @readonly
+ */
 export declare enum DocumentTypes {
     PDF = "application/pdf",
     Word = "application/msword",
@@ -38,23 +54,39 @@ export declare enum DocumentTypes {
     PowerPoint = "application/vnd.ms-powerpoint",
     PowerPointOpenXML = "application/vnd.openxmlformats-officedocument.presentationml.presentation"
 }
+/**
+ * An enum that defines MIME types for popular archive and compression formats.
+ * @readonly
+ */
 export declare enum ArchiveTypes {
     ZIP = "application/zip",
     GZIP = "application/gzip",
     TAR = "application/x-tar",
     RAR = "application/x-rar-compressed"
 }
+/**
+ * An enum that defines MIME types for different font file formats.
+ * @readonly
+ */
 export declare enum FontTypes {
     TrueType = "font/ttf",
     OpenType = "font/otf",
     WebOpenFont = "font/woff",
     WebOpenFont2 = "font/woff2"
 }
+/**
+ * An enum that defines MIME types for application-specific formats, including executables and packages.
+ * @readonly
+ */
 export declare enum AppTypes {
     Executable = "application/octet-stream",
     AndroidAPK = "application/vnd.android.package-archive",
     Java = "application/java-archive"
 }
+/**
+ * An enum for miscellaneous MIME types that do not fit into the other categories.
+ * @readonly
+ */
 export declare enum OtherTypes {
     JSONLD = "application/ld+json",
     WASM = "application/wasm"

package/dist/enums/httpExceptionsEnums.d.ts

@@ -1,5 +1,7 @@
 /**
- * Enum representing all HTTP exception codes.
+ * An enum that defines a comprehensive set of HTTP status codes, organized by category
+ * (Informational, Success, Redirection, Client Errors, Server Errors). It also includes
+ * custom error codes for application-specific scenarios like network errors.
  * @readonly
  */
 export declare enum ExceptionEnum {

package/dist/enums/keyCodesEnums.d.ts

@@ -1,8 +1,6 @@
 /**
- * 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.
+ * An enum that provides a comprehensive mapping of common keyboard keys to their corresponding key codes.
+ * This is useful for handling keyboard events in a readable and standardized way, avoiding the use of magic numbers.
  * @readonly
  * @enum {number}
  */

package/dist/enums/storageEnums.d.ts

@@ -1,6 +1,6 @@
 /**
- * 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.
+ * An enum that defines a standardized set of keys for accessing `localStorage` and `sessionStorage`.
+ * This helps to avoid magic strings and ensures consistency when managing data persistence in the browser.
  * @readonly
  * @enum {string}
  */
@@ -47,9 +47,9 @@ export declare enum StorageKeyEnum {
     APP_SESSION_CACHE_KEY = "COMMON__SESSION__KEY"
 }
 /**
- * Enum defining types of storage.
+ * A frozen object that serves as an enum for storage types, distinguishing between `sessionStorage` and `localStorage`.
+ * Using this object provides a type-safe way to specify the desired storage mechanism.
  * @readonly
- * @enum {number}
  */
 export declare const StorageTypeEnum: {
     /**

package/dist/errors/AuthError.d.ts

@@ -0,0 +1,10 @@
+import { BaseError } from './BaseError';
+export declare class AuthError extends BaseError {
+    readonly code = "AUTH_ERROR";
+    readonly statusCode = 401;
+    constructor(message?: string, context?: Record<string, any>);
+    static unauthorized(message?: string): AuthError;
+    static tokenExpired(): AuthError;
+    static tokenInvalid(): AuthError;
+    static tokenMissing(): AuthError;
+}

package/dist/errors/BaseError.d.ts

@@ -0,0 +1,16 @@
+export declare abstract class BaseError extends Error {
+    abstract readonly code: string;
+    abstract readonly statusCode?: number;
+    readonly timestamp: Date;
+    readonly context?: Record<string, any>;
+    constructor(message: string, context?: Record<string, any>);
+    toJSON(): {
+        name: string;
+        message: string;
+        code: string;
+        statusCode: number | undefined;
+        timestamp: string;
+        context: Record<string, any> | undefined;
+        stack: string | undefined;
+    };
+}

package/dist/errors/NetworkError.d.ts

@@ -0,0 +1,9 @@
+import { BaseError } from './BaseError';
+export declare class NetworkError extends BaseError {
+    readonly code = "NETWORK_ERROR";
+    readonly statusCode?: number;
+    readonly originalError?: unknown;
+    constructor(message?: string, statusCode?: number, originalError?: unknown, context?: Record<string, any>);
+    static fromAxiosError(error: any): NetworkError;
+    static fromFetchError(error: any): NetworkError;
+}

package/dist/errors/ServerError.d.ts

@@ -0,0 +1,10 @@
+import { BaseError } from './BaseError';
+export declare class ServerError extends BaseError {
+    readonly code = "SERVER_ERROR";
+    readonly statusCode: number;
+    constructor(message?: string, statusCode?: number, context?: Record<string, any>);
+    static internal(message?: string): ServerError;
+    static badGateway(message?: string): ServerError;
+    static serviceUnavailable(message?: string): ServerError;
+    static gatewayTimeout(message?: string): ServerError;
+}

package/dist/errors/ValidationError.d.ts

@@ -0,0 +1,14 @@
+import { BaseError } from './BaseError';
+export interface ValidationIssue {
+    field: string;
+    message: string;
+    value?: any;
+}
+export declare class ValidationError extends BaseError {
+    readonly code = "VALIDATION_ERROR";
+    readonly statusCode = 422;
+    readonly issues: ValidationIssue[];
+    constructor(message?: string, issues?: ValidationIssue[], context?: Record<string, any>);
+    static fromIssues(issues: ValidationIssue[]): ValidationError;
+    static fromField(field: string, message: string, value?: any): ValidationError;
+}

package/dist/errors/index.d.ts

@@ -0,0 +1,5 @@
+export * from './BaseError';
+export * from './NetworkError';
+export * from './AuthError';
+export * from './ValidationError';
+export * from './ServerError';

package/dist/fetchers/axios.d.ts

@@ -0,0 +1,22 @@
+import { AxiosInstance } from 'axios';
+import { Fetcher } from '../types/Fetcher';
+/**
+ * Creates a fetcher function using Axios.
+ *
+ * @param axiosInstance - The Axios instance to use
+ * @returns A fetcher function compatible with RestStd
+ *
+ * @example
+ * ```typescript
+ * import axios from 'axios';
+ * import { createAxiosFetcher, RestStd } from '@arex95/vue-core';
+ *
+ * const axiosInstance = axios.create({ baseURL: 'https://api.example.com' });
+ *
+ * export class Role extends RestStd {
+ *     static override resource = 'roles';
+ *     static fetchFn = createAxiosFetcher(axiosInstance);
+ * }
+ * ```
+ */
+export declare function createAxiosFetcher(axiosInstance: AxiosInstance): Fetcher;

package/dist/fetchers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './axios';
+export * from './ofetch';

package/dist/fetchers/ofetch.d.ts

@@ -0,0 +1,33 @@
+import { FetchOptions } from 'ofetch';
+import { Fetcher } from '../types/Fetcher';
+/**
+ * Creates a fetcher function using ofetch.
+ *
+ * @param baseURL - Optional base URL for requests
+ * @param defaultOptions - Optional default options for ofetch
+ * @returns A fetcher function compatible with RestStd
+ *
+ * @example
+ * ```typescript
+ * import { createOfetchFetcher, RestStd } from '@arex95/vue-core';
+ *
+ * export class Role extends RestStd {
+ *     static override resource = 'roles';
+ *     static fetchFn = createOfetchFetcher('https://api.example.com');
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * import { createFetch } from 'ofetch';
+ * import { createOfetchFetcher, RestStd } from '@arex95/vue-core';
+ *
+ * const ofetchInstance = createFetch({ baseURL: 'https://api.example.com' });
+ *
+ * export class Role extends RestStd {
+ *     static override resource = 'roles';
+ *     static fetchFn = createOfetchFetcher(undefined, { fetch: ofetchInstance });
+ * }
+ * ```
+ */
+export declare function createOfetchFetcher(baseURL?: string, defaultOptions?: FetchOptions): Fetcher;

package/dist/index.d.ts

@@ -1,16 +1,16 @@
 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.
+ * A Vue plugin that serves as the entry point for the `@arex95/vue-core` library.
+ * It initializes and configures all the core modules, such as authentication, API communication,
+ * and token management, based on the provided options.
  */
 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.
+     * The `install` method required by Vue's plugin system. It is called when `app.use()` is invoked.
      *
-     * @param app The Vue application instance.
-     * @param options The configuration options provided by the user.
+     * @param {App} app - The Vue application instance.
+     * @param {ArexVueCoreOptions} options - The configuration object for the library.
      */
     install: (app: App, options: ArexVueCoreOptions) => void;
 };
@@ -21,3 +21,5 @@ export * from "./enums";
 export * from "./types";
 export * from "./utils";
 export * from "./services";
+export * from "./fetchers";
+export * from "./errors";