@arex95/vue-core 1.0.4 → 1.0.6

package/README.md

@@ -1,2 +1,21 @@
-# npm-arex-core
-arex core npm distribution
+# @arex95/vue-core
+
+Opinionated Vue Core
+
+## Descripción
+
+Este proyecto es un conjunto de composables y utilidades para Vue.js, diseñado para facilitar el desarrollo de aplicaciones Vue. Proporciona herramientas para manejar peticiones HTTP con Axios, aplicar filtros personalizados, y crear paginadores flexibles. Además, incluye wrappers para TanStack Vue Query, que simplifican la gestión de estados de datos asíncronos, y una implementación estándar para interactuar con APIs RESTful, facilitando la creación, lectura, actualización y eliminación de recursos.
+
+## Estructura del Proyecto
+
+- **src/composables**: Contiene composables reutilizables para Axios, filtros, paginadores y ordenadores.
+- **src/config**: Configuraciones para Axios.
+- **src/constants**: Constantes utilizadas en el proyecto, como enumeraciones de breakpoints, excepciones, tipos de archivos, etc.
+- **src/rest**: Implementación estándar de una interfaz REST para operaciones CRUD. Proporciona una forma sencilla y estandarizada de interactuar con APIs RESTful, facilitando la creación de servicios que pueden realizar operaciones como crear, leer, actualizar y eliminar recursos.
+- **src/types**: Tipos TypeScript utilizados en el proyecto.
+- **src/utils**: Utilidades varias, como funciones para manejar fechas, validaciones, manipulación de strings, etc.
+
+## Instalación
+
+```sh
+npm install @arex95/vue-core

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

@@ -3,8 +3,7 @@ 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 apiUrl - The base URL for the Axios instance.
- * @param axiosInstance - An optional custom Axios instance to use for the request.
+ * @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, apiUrl: string, axiosInstance?: AxiosInstance): (axiosRequestConfig: AxiosRequestConfig, options?: UseQueryOptions) => any;
+export declare function createFetch(fetchComposable: Function, axiosCustomInstance?: AxiosInstance): (axiosRequestConfig: AxiosRequestConfig, options?: UseQueryOptions) => any;

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

@@ -0,0 +1,2 @@
+export declare const configureAxios: (baseURL: string) => void;
+export declare const getAxiosInstance: () => import("axios").AxiosInstance;

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

@@ -1 +1,2 @@
 export * from './axiosConfig';
+export * from './axiosInstance';

package/dist/index.mjs

@@ -239,15 +239,25 @@ class AxiosService {
     }
 }
 
+let axiosInstance;
+const configureAxios = (baseURL) => {
+    axiosInstance = new AxiosService(baseURL);
+};
+const getAxiosInstance = () => {
+    if (!axiosInstance) {
+        throw new Error('Axios instance not configured. Call configureAxios first.');
+    }
+    return axiosInstance.getAxiosInstance();
+};
+
 /**
  * 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 apiUrl - The base URL for the Axios instance.
- * @param axiosInstance - An optional custom Axios instance to use for the request.
+ * @param axiosCustomInstance - An optional custom Axios instance to use for the request.
  * @returns A function that handles the request using the provided composable.
  */
-function createFetch(fetchComposable, apiUrl, axiosInstance) {
-    const instance = axiosInstance || new AxiosService(apiUrl).getAxiosInstance();
+function createFetch(fetchComposable, axiosCustomInstance) {
+    const instance = axiosCustomInstance || getAxiosInstance();
     return (axiosRequestConfig, options) => {
         return fetchComposable(instance, axiosRequestConfig, options);
     };
@@ -2447,4 +2457,4 @@ function isValidHexNumber(hex) {
 // console.log(isValidHexNumber('1A3F')); // true
 // console.log(isValidHexNumber('GHIJ')); // false
 
-export { APP_LOCAL_CACHE_KEY, APP_SESSION_CACHE_KEY, AxiosService, CacheTypeEnum, ContentTypeEnum, ExceptionEnum, FileMetaTypes, ImageTypes, KeyCodeEnum, LOCALE_KEY, LOCK_INFO_KEY, PROJ_CFG_KEY, ROLES_KEY, RestStd, TOKEN_KEY, USER_INFO_KEY, addCustomKeyboardShortcut, addDays, addDoubleClickListener, addKeyListener, ageAtDate, axiosFetch, blobToFormData, bufferToBlob, calculateAge, clickOutside, compareObject, copyToClipboard, countWords, createFetch, createKeyMap, customShortcut, daysBetween, daysToNextBirthday, debounce, debounceAsync, debounceAsyncValidator, debounceAsyncWithImmediate, debounceLeading, debounceLeadingTrailing, debounceTrailing, deepClone, deepEqual, deepMerge, detectKeyHold, disableCopy, disableF12Key, disableMouseButtons, disableRightClick, disableSpecificKeys, downloadBlob, enableMouseButtons, enableRightClick, enableSpecificKeys, exportToCSV, exportToExcel, exportToJSON, exportToText, exportToXML, filterObjectByKeys, flattenObject, formDataToObject, formatDate, generateRandomString, getEndOfMonth, getObjectDifferences, getObjectKeys, getQueryParam, getStartOfMonth, hasNestedProperties, isEmptyObject, isLeapYear, isStrongPassword, isValidAge, isValidCreditCard, isValidDate, isValidEmail, isValidExpiryDate, isValidHexColor, isValidHexColorAlpha, isValidHexNumber, isValidIP, isValidPhoneNumber, isValidSSN, isValidTime, isValidURL, isValidUsername, isValidZIP, lowerFirst, objectToFormData, objectToFormDataEnhanced, objectToQueryString, openWindow, parseDate, proxyToPlainObject, readFileAsDataURL, readFileAsText, registerKeyboardShortcuts, removeAccent, removeClickOutside, removeCustomKeyboardShortcut, removeCustomShortcuts, removeDoubleClickListener, removeEmptyProperties, removeKeyListeners, replaceAll, reverseString, safeGet, screenEnum, screenMap, scrollToTop, simulateKeyPress, sizeEnum, stopDetectingKeyHold, stringToBlob, subtractDays, throttle, toCamelCase, toKebabCase, toggleTabNavigation, truncateString, unregisterKeyboardShortcuts, upperFirst, useBreakpoint, useFilter, usePagination, useSorter, useVueQuery, validateAlphanumeric, validateLetters, validateNumbers };
+export { APP_LOCAL_CACHE_KEY, APP_SESSION_CACHE_KEY, AxiosService, CacheTypeEnum, ContentTypeEnum, ExceptionEnum, FileMetaTypes, ImageTypes, KeyCodeEnum, LOCALE_KEY, LOCK_INFO_KEY, PROJ_CFG_KEY, ROLES_KEY, RestStd, TOKEN_KEY, USER_INFO_KEY, addCustomKeyboardShortcut, addDays, addDoubleClickListener, addKeyListener, ageAtDate, axiosFetch, blobToFormData, bufferToBlob, calculateAge, clickOutside, compareObject, configureAxios, copyToClipboard, countWords, createFetch, createKeyMap, customShortcut, daysBetween, daysToNextBirthday, debounce, debounceAsync, debounceAsyncValidator, debounceAsyncWithImmediate, debounceLeading, debounceLeadingTrailing, debounceTrailing, deepClone, deepEqual, deepMerge, detectKeyHold, disableCopy, disableF12Key, disableMouseButtons, disableRightClick, disableSpecificKeys, downloadBlob, enableMouseButtons, enableRightClick, enableSpecificKeys, exportToCSV, exportToExcel, exportToJSON, exportToText, exportToXML, filterObjectByKeys, flattenObject, formDataToObject, formatDate, generateRandomString, getAxiosInstance, getEndOfMonth, getObjectDifferences, getObjectKeys, getQueryParam, getStartOfMonth, hasNestedProperties, isEmptyObject, isLeapYear, isStrongPassword, isValidAge, isValidCreditCard, isValidDate, isValidEmail, isValidExpiryDate, isValidHexColor, isValidHexColorAlpha, isValidHexNumber, isValidIP, isValidPhoneNumber, isValidSSN, isValidTime, isValidURL, isValidUsername, isValidZIP, lowerFirst, objectToFormData, objectToFormDataEnhanced, objectToQueryString, openWindow, parseDate, proxyToPlainObject, readFileAsDataURL, readFileAsText, registerKeyboardShortcuts, removeAccent, removeClickOutside, removeCustomKeyboardShortcut, removeCustomShortcuts, removeDoubleClickListener, removeEmptyProperties, removeKeyListeners, replaceAll, reverseString, safeGet, screenEnum, screenMap, scrollToTop, simulateKeyPress, sizeEnum, stopDetectingKeyHold, stringToBlob, subtractDays, throttle, toCamelCase, toKebabCase, toggleTabNavigation, truncateString, unregisterKeyboardShortcuts, upperFirst, useBreakpoint, useFilter, usePagination, useSorter, useVueQuery, validateAlphanumeric, validateLetters, validateNumbers };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arex95/vue-core",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Opinionated Vue Core",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -28,24 +28,26 @@
   "author": "Arturo Rafael Serrano Girón",
   "license": "MIT",
   "peerDependencies": {
-    "@tanstack/vue-query": "^5.0.0",
-    "@vueuse/core": "^12.8.2",
-    "axios": "^1.6.0",
-    "vue": "^3.0.0"
+    "@tanstack/vue-query": ">=5.0.0",
+    "@vueuse/core": ">=12.8.2",
+    "axios": ">=1.6.0",
+    "vue": ">=3.0.0"
+  },
+  "optionalDependencies": {
+    "@tanstack/vue-query": ">=5.0.0",
+    "@vueuse/core": ">=12.8.2",
+    "axios": ">=1.6.0",
+    "vue": ">=3.0.0"
   },
   "devDependencies": {
     "@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",
-    "@tanstack/vue-query": "^5.0.0",
     "@types/node": "^22.13.9",
-    "@vueuse/core": "^12.8.2",
-    "axios": "^1.6.0",
     "rollup": "^4.34.9",
     "ts-node": "^10.9.2",
     "tslib": "^2.8.1",
-    "typescript": "^5.0.0",
-    "vue": "^3.0.0"
+    "typescript": "^5.0.0"
   }
-}
+}