@arex95/vue-core 1.1.41 → 3.0.0

package/dist/utils/strings.d.ts

@@ -1,63 +1,74 @@
 /**
- * Capitalizes the first character of a string.
- * @param {string} s The string to capitalize.
- * @returns {string} The capitalized string.
+ * Capitalizes the first letter of a string.
+ *
+ * @param {string} s - The input string.
+ * @returns {string} The string with the first letter capitalized.
  */
 export declare function upperFirst(s: string): string;
 /**
- * Lowercases the first character of a string.
- * @param {string} s The string to lowercase.
- * @returns {string} The lowercased string.
+ * Converts the first letter of a string to lowercase.
+ *
+ * @param {string} s - The input string.
+ * @returns {string} The string with the first letter in lowercase.
  */
 export declare function lowerFirst(s: string): string;
 /**
- * Removes accents and special characters from a string and converts it to a URL-friendly format.
- * @param {string} input The string to process.
- * @returns {string} The processed string.
+ * Normalizes a string by converting it to lowercase, trimming whitespace, replacing spaces with hyphens,
+ * and removing diacritical marks (accents).
+ *
+ * @param {string} input - The string to normalize.
+ * @returns {string} The URL-friendly, normalized string.
  */
 export declare function removeAccent(input: string): string;
 /**
- * Reverses a string.
- * @param {string} str The string to reverse.
+ * Reverses the characters of a string.
+ *
+ * @param {string} str - The input string.
  * @returns {string} The reversed string.
  */
 export declare function reverseString(str: string): string;
 /**
- * Counts the number of words in a string.
- * @param {string} str The string to analyze.
- * @returns {number} The word count.
+ * Counts the number of words in a string, based on whitespace separation.
+ *
+ * @param {string} str - The input string.
+ * @returns {number} The number of words in the string.
  */
 export declare function countWords(str: string): number;
 /**
- * Truncates a string to the specified length and adds ellipsis if necessary.
- * @param {string} str The string to truncate.
- * @param {number} maxLength The maximum length of the string.
+ * Truncates a string to a specified maximum length, appending '...' if the string is cut.
+ *
+ * @param {string} str - The input string.
+ * @param {number} maxLength - The maximum desired length of the string.
  * @returns {string} The truncated string.
  */
 export declare function truncateString(str: string, maxLength: number): string;
 /**
- * Converts a string to camel case.
- * @param {string} str The string to convert.
- * @returns {string} The camel cased string.
+ * Converts a string from various cases (e.g., snake_case, kebab-case, space separated) into camelCase.
+ *
+ * @param {string} str - The input string.
+ * @returns {string} The camelCase version of the string.
  */
 export declare function toCamelCase(str: string): string;
 /**
- * Converts a string to kebab case.
- * @param {string} str The string to convert.
- * @returns {string} The kebab cased string.
+ * Converts a string from various cases (e.g., camelCase, PascalCase, space separated) into kebab-case.
+ *
+ * @param {string} str - The input string.
+ * @returns {string} The kebab-case version of the string.
  */
 export declare function toKebabCase(str: string): string;
 /**
- * Replaces all instances of a substring within a string.
- * @param {string} str The original string.
- * @param {string} find The substring to find.
- * @param {string} replace The substring to replace with.
- * @returns {string} The modified string.
+ * Replaces all occurrences of a substring with a new substring.
+ *
+ * @param {string} str - The original string.
+ * @param {string} find - The substring to find and replace.
+ * @param {string} replace - The substring to replace with.
+ * @returns {string} A new string with all replacements made.
  */
 export declare function replaceAll(str: string, find: string, replace: string): string;
 /**
- * Generates a random string of a specific length.
- * @param {number} length The length of the string to generate.
- * @returns {string} The random string.
+ * Generates a random alphanumeric string of a specified length.
+ *
+ * @param {number} length - The desired length of the random string.
+ * @returns {string} The generated random string.
  */
 export declare function generateRandomString(length: number): string;

package/dist/utils/validations.d.ts

@@ -1,114 +1,133 @@
 /**
- * Validates if the key pressed is a valid letter or special character.
- * @param {KeyboardEvent} e The keyboard event.
- * @returns {boolean} True if the key is valid, otherwise false.
+ * An event handler that prevents a `KeyboardEvent`'s default action if the key pressed is not a letter or a specific special character.
+ *
+ * @param {KeyboardEvent} e - The `KeyboardEvent` object.
+ * @returns {boolean} `true` if the key is valid, `false` otherwise.
  */
 export declare function validateLetters(e: KeyboardEvent): boolean;
 /**
- * Validates if the key pressed is a valid alphanumeric character.
- * @param {KeyboardEvent} e The keyboard event.
- * @returns {boolean} True if the key is valid, otherwise false.
+ * An event handler that prevents a `KeyboardEvent`'s default action if the key pressed is not an alphanumeric character.
+ *
+ * @param {KeyboardEvent} e - The `KeyboardEvent` object.
+ * @returns {boolean} `true` if the key is valid, `false` otherwise.
  */
 export declare function validateAlphanumeric(e: KeyboardEvent): boolean;
 /**
- * Validates if the key pressed is a number.
- * @param {KeyboardEvent} e The keyboard event.
- * @returns {boolean} True if the key is a number, otherwise false.
+ * An event handler that prevents a `KeyboardEvent`'s default action if the key pressed is not a number.
+ *
+ * @param {KeyboardEvent} e - The `KeyboardEvent` object.
+ * @returns {boolean} `true` if the key is a number, otherwise `false`.
  */
 export declare function validateNumbers(e: KeyboardEvent): boolean;
 /**
- * Validates if a phone number is valid.
- * @param {string} phoneNumber The phone number to validate.
- * @returns {boolean} True if the phone number is valid, otherwise false.
+ * Validates a phone number against a regex for 10-digit numbers.
+ *
+ * @param {string} phoneNumber - The phone number to validate.
+ * @returns {boolean} `true` if the phone number is valid, otherwise `false`.
  */
 export declare function isValidPhoneNumber(phoneNumber: string): boolean;
 /**
- * Validates if a string is a valid email address.
- * @param {string} email The email address to validate.
- * @returns {boolean} True if the email address is valid, otherwise false.
+ * Validates an email address against a standard regex pattern.
+ *
+ * @param {string} email - The email address to validate.
+ * @returns {boolean} `true` if the email is valid, otherwise `false`.
  */
 export declare function isValidEmail(email: string): boolean;
 /**
- * Validates if a string is a valid URL.
- * @param {string} url The URL to validate.
- * @returns {boolean} True if the URL is valid, otherwise false.
+ * Validates a string to see if it is a well-formed URL.
+ *
+ * @param {string} url - The URL string to validate.
+ * @returns {boolean} `true` if the URL is valid, otherwise `false`.
  */
 export declare function isValidURL(url: string): boolean;
 /**
- * Validates if a string is a valid date in YYYY-MM-DD format.
- * @param {string} date The date string to validate.
- * @returns {boolean} True if the date is valid, otherwise false.
+ * Validates a string to ensure it is a valid date in 'YYYY-MM-DD' format.
+ *
+ * @param {string} date - The date string to validate.
+ * @returns {boolean} `true` if the date is valid, otherwise `false`.
  */
 export declare function isValidDate(date: string): boolean;
 /**
- * Validates if a password meets certain strength criteria.
- * @param {string} password The password to validate.
- * @returns {boolean} True if the password is strong, otherwise false.
+ * Checks if a password meets a set of strength requirements (minimum length, uppercase, lowercase, numbers, special characters).
+ *
+ * @param {string} password - The password to validate.
+ * @returns {boolean} `true` if the password is strong, otherwise `false`.
  */
 export declare function isStrongPassword(password: string): boolean;
 /**
- * Validates a credit card number using the Luhn algorithm.
- * @param {string} cardNumber The credit card number to validate.
- * @returns {boolean} True if the credit card number is valid, otherwise false.
+ * Validates a credit card number using the Luhn algorithm (mod-10 check).
+ *
+ * @param {string} cardNumber - The credit card number to validate.
+ * @returns {boolean} `true` if the credit card number is valid, otherwise `false`.
  */
 export declare function isValidCreditCard(cardNumber: string): boolean;
 /**
- * Validates if a string is a valid hex color code.
- * @param {string} color The color code to validate.
- * @returns {boolean} True if the color code is valid, otherwise false.
+ * Validates a string to check if it's a valid 3- or 6-digit hexadecimal color code.
+ *
+ * @param {string} color - The hex color string to validate.
+ * @returns {boolean} `true` if the color code is valid, otherwise `false`.
  */
 export declare function isValidHexColor(color: string): boolean;
 /**
- * Validates if a string is a valid time in HH:MM format.
- * @param {string} time The time string to validate.
- * @returns {boolean} True if the time is valid, otherwise false.
+ * Validates a string to ensure it represents a valid time in 24-hour HH:MM format.
+ *
+ * @param {string} time - The time string to validate.
+ * @returns {boolean} `true` if the time is valid, otherwise `false`.
  */
 export declare function isValidTime(time: string): boolean;
 /**
- * Validates if a string is a valid IPv4 address.
- * @param {string} ip The IP address to validate.
- * @returns {boolean} True if the IP address is valid, otherwise false.
+ * Validates a string to check if it is a valid IPv4 address.
+ *
+ * @param {string} ip - The IP address string to validate.
+ * @returns {boolean} `true` if the IP address is valid, otherwise `false`.
  */
 export declare function isValidIP(ip: string): boolean;
 /**
- * Validates if a string is a valid U.S. Social Security Number (SSN).
- * @param {string} ssn The SSN to validate.
- * @returns {boolean} True if the SSN is valid, otherwise false.
+ * Validates a string to check if it matches the format of a U.S. Social Security Number (SSN).
+ *
+ * @param {string} ssn - The SSN string to validate.
+ * @returns {boolean} `true` if the SSN format is valid, otherwise `false`.
  */
 export declare function isValidSSN(ssn: string): boolean;
 /**
- * Validates if a string is a valid U.S. ZIP code.
- * @param {string} zip The ZIP code to validate.
- * @returns {boolean} True if the ZIP code is valid, otherwise false.
+ * Validates a string to check if it is a valid 5-digit or 9-digit (ZIP+4) U.S. ZIP code.
+ *
+ * @param {string} zip - The ZIP code string to validate.
+ * @returns {boolean} `true` if the ZIP code is valid, otherwise `false`.
  */
 export declare function isValidZIP(zip: string): boolean;
 /**
- * Validates if a string is a valid credit card expiry date in MM/YY format.
- * @param {string} expiryDate The expiry date to validate.
- * @returns {boolean} True if the expiry date is valid, otherwise false.
+ * Validates a credit card expiry date string (MM/YY format) to ensure it is a valid, non-expired date.
+ *
+ * @param {string} expiryDate - The expiry date to validate.
+ * @returns {boolean} `true` if the expiry date is valid and not in the past, otherwise `false`.
  */
 export declare function isValidExpiryDate(expiryDate: string): boolean;
 /**
- * Validates if a string is a valid 8-character hexadecimal color code (including alpha).
- * @param {string} color The color code to validate.
- * @returns {boolean} True if the color code is valid, otherwise false.
+ * Validates a string to check if it's a valid 8-digit hexadecimal color code (with alpha channel).
+ *
+ * @param {string} color - The hex color string to validate.
+ * @returns {boolean} `true` if the color code is valid, otherwise `false`.
  */
 export declare function isValidHexColorAlpha(color: string): boolean;
 /**
- * Validates if a username meets specific criteria.
- * @param {string} username The username to validate.
- * @returns {boolean} True if the username is valid, otherwise false.
+ * Validates a username to ensure it contains only alphanumeric characters and underscores, with a length between 3 and 16 characters.
+ *
+ * @param {string} username - The username to validate.
+ * @returns {boolean} `true` if the username is valid, otherwise `false`.
  */
 export declare function isValidUsername(username: string): boolean;
 /**
- * Validates if a string represents a valid age between 0 and 120.
- * @param {string} age The age to validate.
- * @returns {boolean} True if the age is valid, otherwise false.
+ * Validates a string to ensure it represents a plausible human age (0-120).
+ *
+ * @param {string} age - The age string to validate.
+ * @returns {boolean} `true` if the age is valid, otherwise `false`.
  */
 export declare function isValidAge(age: string): boolean;
 /**
- * Validates if a string is a valid hexadecimal number.
- * @param {string} hex The hexadecimal number to validate.
- * @returns {boolean} True if the number is valid, otherwise false.
+ * Validates a string to check if it contains only valid hexadecimal characters.
+ *
+ * @param {string} hex - The string to validate.
+ * @returns {boolean} `true` if the string is a valid hexadecimal number, otherwise `false`.
  */
 export declare function isValidHexNumber(hex: string): boolean;

package/package.json

@@ -1,76 +1,71 @@
-{
-  "name": "@arex95/vue-core",
-  "version": "1.1.41",
-  "description": "Opinionated Vue Core",
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "exports": {
-    "import": "./dist/index.mjs"
-  },
-  "types": "dist/index.d.ts",
-  "type": "module",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "rollup -c",
-    "changelog": "conventional-changelog -p angular -o CHANGELOG.md -r 0",
-    "release": "npm version patch && npm run changelog && git add CHANGELOG.md package.json pnpm-lock.yaml && git commit -m \"chore(release): update changelog\" && git push && npm publish --access public",
-    "test": "vitest",
-    "test:watch": "vitest --watch",
-    "test:ui": "vitest --ui"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Arex95/npm-arex-core.git"
-  },
-  "keywords": [
-    "vue",
-    "composables",
-    "core",
-    "npm"
-  ],
-  "author": "Arturo Rafael Serrano Girón",
-  "license": "MIT",
-  "peerDependencies": {
-    "@tanstack/vue-query": ">=5.0.0",
-    "@vueuse/core": ">=12.8.2",
-    "axios": ">=1.6.0",
-    "jwt-decode": "^4.0.0",
-    "uuid": ">=11.1.0",
-    "vue": ">=3.0.0",
-    "vue-router": ">=4.5.0"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.23.0",
-    "@rollup/plugin-commonjs": "^28.0.3",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^16.0.0",
-    "@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",
-    "eslint": "^9.23.0",
-    "eslint-plugin-vue": "^10.0.0",
-    "globals": "^16.0.0",
-    "jsdom": "^26.1.0",
-    "rollup": "^4.35.0",
-    "ts-node": "^10.9.2",
-    "tslib": "^2.8.1",
-    "typescript": "^5.8.2",
-    "typescript-eslint": "^8.28.0",
-    "vitest": "^3.2.3"
-  },
-  "dependencies": {
-    "@tanstack/vue-query": ">=5.0.0",
-    "@vueuse/core": ">=12.8.2",
-    "axios": ">=1.6.0",
-    "jwt-decode": "^4.0.0",
-    "uuid": ">=11.1.0",
-    "vue": ">=3.0.0",
-    "vue-router": ">=4.5.0"
-  }
-}
+{
+  "name": "@arex95/vue-core",
+  "version": "3.0.0",
+  "description": "Opinionated Vue Core",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "changelog": "conventional-changelog -p angular -o CHANGELOG.md -r 0",
+    "release": "npm version patch && npm run changelog && git add CHANGELOG.md package.json pnpm-lock.yaml && git commit -m \"chore(release): update changelog\" && git push && npm publish --access public",
+    "release:major": "npm version major && npm run changelog && git add CHANGELOG.md package.json pnpm-lock.yaml && git commit -m \"chore(release): update changelog\" && git push && npm publish --access public",
+    "release:minor": "npm version minor && npm run changelog && git add CHANGELOG.md package.json pnpm-lock.yaml && git commit -m \"chore(release): update changelog\" && git push && npm publish --access public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Arex95/npm-arex-core.git"
+  },
+  "keywords": [
+    "vue",
+    "composables",
+    "core",
+    "npm"
+  ],
+  "author": "Arturo Rafael Serrano Girón",
+  "license": "MIT",
+  "peerDependencies": {
+    "@vueuse/core": ">=12.8.2",
+    "axios": ">=1.6.0",
+    "jwt-decode": "^4.0.0",
+    "ofetch": ">=1.0.0",
+    "uuid": ">=11.1.0",
+    "vue": ">=3.0.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.23.0",
+    "@rollup/plugin-commonjs": "^28.0.3",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.0",
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@types/crypto-js": "^4.2.2",
+    "@types/node": "^22.13.10",
+    "conventional-changelog-cli": "^5.0.0",
+    "eslint": "^9.23.0",
+    "eslint-plugin-vue": "^10.0.0",
+    "globals": "^16.0.0",
+    "rollup": "^4.35.0",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.28.0"
+  },
+  "dependencies": {
+    "@vueuse/core": ">=12.8.2",
+    "axios": ">=1.6.0",
+    "jwt-decode": "^4.0.0",
+    "uuid": ">=11.1.0",
+    "vue": ">=3.0.0"
+  }
+}

package/dist/composables/axios/createFetch.d.ts

@@ -1,9 +0,0 @@
-import { AxiosInstance, AxiosRequestConfig } from 'axios';
-import { UseQueryOptions } from '@tanstack/vue-query';
-/**
- * Creates a fetchComposable for Axios requests with an optional custom instance.
- * @param fetchComposable - The composable to use for the request (can be any fetch function).
- * @param axiosCustomInstance - An optional custom Axios instance to use for the request.
- * @returns A function that handles the request using the provided composable.
- */
-export declare function createFetch(fetchComposable: Function, axiosCustomInstance?: AxiosInstance): (axiosRequestConfig: AxiosRequestConfig, options?: UseQueryOptions) => any;

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

@@ -1,31 +0,0 @@
-import { TokenConfig } from "@/types";
-/**
- * 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 configTokens(accessTokenKey: string, refreshTokenKey: string): void;
-/**
- * Retrieves the current token configuration.
- *
- * @returns {TokenConfig} The configuration of the access and refresh token keys.
- */
-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/constants/breakpointEnum.d.ts

@@ -1,31 +0,0 @@
-/**
- * Object defining available screen sizes as constants.
- * @readonly
- */
-export declare const sizeEnum: {
-    readonly XS: "XS";
-    readonly SM: "SM";
-    readonly MD: "MD";
-    readonly LG: "LG";
-    readonly XL: "XL";
-    readonly XXL: "XXL";
-};
-/**
- * Object defining breakpoints for design based on screen width.
- * Values are in pixels.
- * @readonly
- */
-export declare const screenEnum: {
-    readonly XS: 480;
-    readonly SM: 576;
-    readonly MD: 768;
-    readonly LG: 992;
-    readonly XL: 1200;
-    readonly XXL: 1600;
-};
-/**
- * Map that associates each screen size defined in `sizeEnum` with its corresponding pixel value from `screenEnum`.
- * @type {Map<typeof sizeEnum[keyof typeof sizeEnum], number>}
- */
-declare const screenMap: Map<"XS" | "SM" | "MD" | "LG" | "XL" | "XXL", number>;
-export { screenMap };

package/dist/constants/errorsEnum.d.ts

@@ -1,3 +0,0 @@
-import { ErrorType } from '@/types';
-export declare const ERROR_MESSAGES: Record<ErrorType, string>;
-export declare const ERROR_STYLES: Record<ErrorType, string>;

package/dist/constants/exceptionEnum.d.ts

@@ -1,30 +0,0 @@
-/**
- * Object defining various exception codes.
- * @readonly
- */
-export declare const ExceptionEnum: {
-    /**
-     * HTTP status code for page access forbidden.
-     */
-    readonly PAGE_NOT_ACCESS: 403;
-    /**
-     * HTTP status code for page not found.
-     */
-    readonly PAGE_NOT_FOUND: 404;
-    /**
-     * HTTP status code for general server error.
-     */
-    readonly ERROR: 500;
-    /**
-     * HTTP status code for bad request.
-     */
-    readonly BAD_REQUEST: 406;
-    /**
-     * Custom error code for network errors.
-     */
-    readonly NET_WORK_ERROR: 10000;
-    /**
-     * Custom code indicating no data on the page, not actually an exception page.
-     */
-    readonly PAGE_NOT_DATA: 10100;
-};

package/dist/constants/fileTypesEnum.d.ts

@@ -1,25 +0,0 @@
-/**
- * Object defining various image MIME types.
- * @readonly
- */
-export declare const ImageTypes: {
-    readonly apng: "image/apng";
-    readonly bmp: "image/bmp";
-    readonly gif: "image/gif";
-    readonly jpeg: "image/jpeg";
-    readonly pjpeg: "image/pjpeg";
-    readonly png: "image/png";
-    readonly svg: "image/svg+xml";
-    readonly tiff: "image/tiff";
-    readonly webp: "image/webp";
-    readonly xicon: "image/x-icon";
-};
-/**
- * Object defining various file meta types.
- * @readonly
- */
-export declare const FileMetaTypes: {
-    readonly images: "image/*";
-    readonly audios: "audio/*";
-    readonly videos: "video/*";
-};

package/dist/constants/httpEnum.d.ts

@@ -1,21 +0,0 @@
-/**
- * Object representing different content types for HTTP headers.
- * @readonly
- */
-export declare const ContentTypeEnum: {
-    /**
-     * Content type for JSON.
-     * @constant
-     */
-    readonly JSON: "application/json;charset=UTF-8";
-    /**
-     * Content type for URL-encoded form data.
-     * @constant
-     */
-    readonly FORM_URLENCODED: "application/x-www-form-urlencoded;charset=UTF-8";
-    /**
-     * Content type for multipart form data with file uploads.
-     * @constant
-     */
-    readonly FORM_DATA: "multipart/form-data;charset=UTF-8";
-};

package/dist/constants/index.d.ts

@@ -1,7 +0,0 @@
-export * from './breakpointEnum';
-export * from './exceptionEnum';
-export * from './fileTypesEnum';
-export * from './httpEnum';
-export * from './keyCodeEnum';
-export * from './storageEnum';
-export * from './errorsEnum';

package/dist/constants/keyCodeEnum.d.ts

@@ -1,10 +0,0 @@
-/**
- * Object defining various key codes for keyboard events.
- * @readonly
- */
-export declare const KeyCodeEnum: {
-    readonly UP: 38;
-    readonly DOWN: 40;
-    readonly ENTER: 13;
-    readonly ESC: 27;
-};