una-nuxt-module 1.0.2

package/dist/runtime/types/index.d.ts

@@ -0,0 +1,584 @@
+import type { EAuthorization, EFormField, EFormMode, ERequestMethod, EVuetifyDateFormats } from "../enums/index.js";
+import type { FetchOptions } from "ofetch";
+export { FetchClient } from "../classes/FetchClient.js";
+/**
+ * Los tipos definidos en este archivo son exportados globalmente, lo que hace que no sea necesario importarlos para usarlos.
+ */
+/**
+ * Interface to test import from module.
+ *
+ * @interface IInterfaceFromModule
+ *
+ * @property {prop} - *string* - Prop description
+ *
+ */
+export interface IUnaNuxtModuleOptions {
+    sso: {
+        signInRedirectURL: string;
+        signOutRedirectURL: string;
+        clientID: string;
+        clientSecret: string;
+        baseUrl: string;
+        scope: String[];
+        validateIDToken: string;
+    };
+    apis: {
+        authorization: {
+            baseUrl: string;
+            endpoints: {
+                getResources: string;
+            };
+        };
+    };
+    config: {
+        unprotectedPages: String[];
+        navigationMenu: IMenuItem[];
+    };
+}
+/** Tipo de autorización. */
+export type TAuthorization = keyof typeof EAuthorization;
+/** Tipo de campo de formulario. */
+export type TFormField = keyof typeof EFormField;
+/** Tipo de modo de edición de formulario. */
+export type TFormMode = keyof typeof EFormMode;
+/** Tipo de petición */
+export type TRequestMethod = keyof typeof ERequestMethod;
+/** Tipos de formatos de fecha para Vuetify. */
+export type TVuetifyDateFormat = keyof typeof EVuetifyDateFormats;
+/**
+ * Interfaz que define los parámetros necesarios para realizar una petición HTTP.
+ */
+export interface IFetchParams {
+    /**
+     * Método HTTP de la petición (GET, POST, PUT, DELETE, etc.).
+     * Por defecto, se utiliza el método GET.
+     */
+    method?: TRequestMethod;
+    /**
+     * URL o endpoint al cual se realizará la petición.
+     */
+    url: string;
+    /**
+     * Datos que se enviarán en el cuerpo de la petición.
+     * Puede ser un objeto, un valor compatible con BodyInit o null/undefined.
+     */
+    body?: BodyInit | Record<string, any> | null | undefined;
+    /**
+     * Opciones adicionales para configurar la petición, como encabezados y parámetros de configuración.
+     */
+    fetchOptions?: FetchOptions<"json">;
+}
+/**
+ * Interfaz para la información de respuesta de las peticiones.
+ *
+ * @interface IRequestInfo
+ *
+ * @property {string} - *title* - Titulo del mensaje
+ * @property {string} - *description* - Descripción del mensaje
+ */
+export interface IRequestInfo {
+    /** Titulo del mensaje */
+    title: string;
+    /** Descripción del mensaje */
+    description: string;
+}
+/**
+ * Interfaz para mapear la respuesta de las peticiones a APIS
+ *
+ * @interface IRequestResponse
+ *
+ * @property {number} - *statusCode* - Código del resultado de la petición
+ * @property {boolean} - *success* - Indica si la peticion fue exitosa
+ * @property {any} - *message* - Mensaje de la petición
+ * @property {any} - *data* - Datos de la petición
+ * @property {string} - *title* - Titulo del mensaje
+ * @property {string} - *description* - Descripción del mensaje
+ */
+export interface IRequestResponse<T = unknown> extends IRequestInfo {
+    /** Código del resultado de la petición */
+    statusCode: number;
+    /** Indica si la peticion fue exitosa */
+    success: boolean;
+    /** Mensaje de la petición */
+    message?: any;
+    /** Datos de la petición */
+    data: T;
+}
+export interface IPaginatedResponse<T> {
+    content: T[];
+    pageable: IPaginationInfo;
+    totalPages: number;
+    totalElements: number;
+    last: boolean;
+    first: boolean;
+    size: number;
+    number: number;
+    sort: IPaginationSort;
+    numberOfElements: number;
+    empty: boolean;
+}
+export interface IPaginationInfo {
+    pageNumber: number;
+    pageSize: number;
+    sort: IPaginationSort;
+    offset: number;
+    paged: boolean;
+    unpaged: boolean;
+}
+export interface IPaginationSort {
+    sorted: boolean;
+    unsorted: boolean;
+    empty: boolean;
+}
+/**
+ * Interfaz para los parámetros del composable de peticiones a APIS.
+ *
+ * @interface IUseRequestWraperParameters
+ *
+ * @property {string} - *baseURL* - Dirección del servidor
+ * @property {string} - *url* - Endpoint a consumir
+ * @property {TRequestMethod} - *method* - Método de la petición
+ * @property {Object, null} - *body* - Body de la petición
+ * @property {Object} - *query* - Query de la petición
+ * @property {any} - *headers* - Headers de la petición
+ */
+export interface IUseRequestWraperParameters {
+    /** Dirección del servidor */
+    host: string;
+    /** Endpoint a consumir */
+    url?: string;
+    /** Método de la petición */
+    method?: TRequestMethod;
+    /** Body de la petición */
+    body?: Object | null;
+    /** Query de la petición */
+    query?: {
+        [key: string]: any;
+    };
+    /** Headers de la petición */
+    headers?: {
+        [key: string]: any;
+    };
+}
+export interface IIdentifiedEntity {
+    id: number;
+}
+export interface IVersionedEntity {
+    version: number;
+}
+export interface IAuditableEntity {
+    createdBy: ICreatedBy;
+    createdDate: string;
+    lastModifiedBy: ILastModifiedBy;
+    lastModifiedDate: string;
+}
+export interface ICreatedBy {
+    id: number;
+    version: number;
+    createdDate: string;
+    lastModifiedDate: string;
+}
+export interface ILastModifiedBy {
+    id: number;
+    version: number;
+    createdDate: string;
+    lastModifiedDate: string;
+}
+export interface IBaseEntity extends IIdentifiedEntity, IVersionedEntity, IAuditableEntity {
+}
+/**
+ * Interfaz para el estado de la tabla de los módulos.
+ *
+ * @interface ITableState
+ *
+ * @property {number} - *page* - Página actual de la tabla
+ * @property {IItemsPerPage} - *itemsPerPage* - Elementos por página
+ * @property {string, null} - *textToSearch* - Texto a buscar en la tabla
+ * @property {number} - *totalPages* - Total de páginas
+ * @property {number} - *totalElements* - Total de elementos
+ *
+ */
+export interface ITableState {
+    /** Página actual de la tabla */
+    page: number;
+    /** Elementos por página  */
+    itemsPerPage: IItemsPerPage;
+    /** Texto a buscar en la tabla */
+    textToSearch: string | null;
+    /** Total de páginas  */
+    totalPages: number;
+    /** Total de elementos  */
+    totalElements: number;
+}
+/**
+ * Interfaz para el estado del formulario de los módulos.
+ *
+ * @interface IFormState
+ *
+ * @property {TFormMode} - *formMode* - Modo de edición del formulario
+ * @property {boolean} - *openForm* - Almacena si el formulario esta abierto
+ */
+export interface IFormState {
+    /** Modo de edición del formulario */
+    formMode: TFormMode;
+    /** Almacena si el formulario esta abierto */
+    openForm: boolean;
+}
+/**
+ * Interfaz base para el store de los módulos.
+ *
+ * @interface IBaseStore
+ */
+export interface IBaseStore {
+    /** Estado del formulario de los módulos */
+    formState: IFormState;
+    /** Estado de la tabla de los módulos */
+    tableState: ITableState;
+}
+/**
+ * Interfaz para los parámetros del método listar todos.
+ *
+ * @interface IGetAllParams
+ */
+export interface IGetAllParams {
+    makingRequest: boolean;
+}
+/**
+ * Interfaz para el Store de estado de la aplicación.
+ *
+ * @interface IAppStatusState
+ *
+ * @property {boolean} - *makingRequest* - Almacena si la aplicación esta realizando una petición
+ * @property {boolean} - *hasError* - Almacena si la petión respondio con un error
+ * @property {boolean} - *showInfo* - Almacena si la aplicación debe mostrar la respuesta de información de la petición
+ * @property {IRequestInfo, null} - *info* - Almacena la respuesta de información de la petición
+ * @property {boolean} - *openDialogDelete* - Almacena si se debe abrir el diálogo de eliminar
+ * @property {boolean} - *openDialogExport* - Almacena si se debe abrir el diálogo de exportar
+ */
+export interface IAppStatusState {
+    /** Almacena si la aplicación esta realizando una petición */
+    makingRequest: boolean;
+    /** Almacena si la petión respondio con un error */
+    hasError: boolean;
+    /** Almacena si la aplicación debe mostrar la respuesta de información de la petición */
+    showInfo: boolean;
+    /** Almacena la respuesta de información de la petición */
+    info: IRequestInfo | null;
+    /** Almacena si se debe abrir el diálogo de eliminar */
+    openDialogDelete: boolean;
+    /** Almacena si se debe abrir el diálogo de exportar */
+    openDialogExport: boolean;
+}
+/**
+ * Interfaz para el Store de preferencias visuales del usuario.
+ *
+ * @interface IUiCustomizerState
+ *
+ * @property {boolean} - *drawSidebar* - Almacena si se debe renderizar el menú
+ * @property {boolean} - *isSidebarMini* - Almacena si el menú esta minimizado
+ * @property {string} - *currentTheme* - Almacena el tema actual
+ */
+export interface IUiCustomizerState {
+    /** Almacena si se debe renderizar el menú */
+    drawSidebar: boolean;
+    /** Almacena si el menú esta minimizado */
+    isSidebarMini: boolean;
+    /** Almacena el tema actual */
+    currentTheme: string;
+}
+/**
+ * Interfaz para la información del usuario autenticado.
+ *
+ * @interface IAuthenticatedUser
+ *
+ * @property {string} - *email* - Email del usuario
+ * @property {string} - *fullName* - Nombre completo del usuario
+ * @property {string} - *name* - Nombre del usuario
+ * @property {string} - *lastName* - Primer apellido del usuario
+ * @property {string} - *photoUrl* - Url de la foto del usuario
+ * @property {string} - *mainRole* - Rol del usuario
+ */
+export interface IAuthenticatedUser {
+    /** Email del usuario */
+    email: string;
+    /** Nombre completo del usuario */
+    fullName: string;
+    /** Nombre del usuario */
+    name?: string;
+    /** Primer apellido del usuario */
+    lastName?: string;
+    /** Url de la foto del usuario */
+    photoUrl?: string;
+    /** Rol del usuario */
+    mainRole?: string;
+}
+/**
+ * Interfaz para la información de los recursos del usuario autenticado.
+ *
+ * @interface IResource
+ *
+ * @property {number} - *id* - Id del recurso
+ * @property {string} - *nombre* - Nombre del recurso
+ * @property {boolean} - *permisoInsertar* - Especifica si se tiene el permiso de insertar en el recurso
+ * @property {boolean} - *permisoModificar* - Especifica si se tiene el permiso de modificar en el recurso
+ * @property {boolean} - *permisoEliminar* - Especifica si se tiene el permiso de eliminar en el recurso
+ *
+ */
+export interface IResource {
+    /** Id del recurso */
+    id: number;
+    /** Nombre del recurso */
+    nombre: string;
+    /** Especifica si se tiene el permiso de insertar en el recurso */
+    permisoInsertar: boolean;
+    /** Especifica si se tiene el permiso de modificar en el recurso */
+    permisoModificar: boolean;
+    /** Especifica si se tiene el permiso de eliminar en el recurso */
+    permisoEliminar: boolean;
+}
+/**
+ * Interfaz para la información de la sesión del usuario autenticado.
+ *
+ * @interface IAuthData
+ *
+ * @property {boolean} - *isAuthenticated* - Almacena si el usuario esta autenticado
+ * @property {string} - *accessToken* - Access Token del usuario generado al iniciar sesión en WSO2
+ * @property {IResource[]} - *resources* - Recursos del usuario
+ */
+export interface IAuthData {
+    /** Almacena si el usuario esta autenticado */
+    isAuthenticated: boolean;
+    /** Access Token del usuario generado al iniciar sesión en WSO2 */
+    accessToken: string;
+    /** Recursos del usuario */
+    resources: IResource[];
+}
+/**
+ * Interfaz para el Store de autenticación y autorización.
+ *
+ * @interface IAuthState
+ *
+ * @property {IAuthenticatedUser, null} - *user* - Información del usuario
+ * @property {IAuthData, null} - *authData* - Información de la sesión del usuario
+ */
+export interface IAuthState {
+    /** Información del usuario */
+    user: IAuthenticatedUser | null;
+    /** Información de la sesión del usuario */
+    authData: IAuthData | null;
+}
+/**
+ * Interfaz para los parámetros de métodos de validacion de permisos en recursos.
+ *
+ * @interface IHasAuthorizationInResourceParams
+ *
+ * @property {string} - *resource* - Recurso a validar
+ * @property {TAuthorization} - *authorization* - Autorización a validar
+ */
+export interface IHasAuthorizationInResourceParams {
+    /** Recurso a validar */
+    resource: string;
+    /** Autorización a validar */
+    authorization: TAuthorization;
+}
+/**
+ * Interfaz para las opciones del componente ComboBox.
+ *
+ * @interface IComboBoxOption
+ *
+ * @property {number} - *value* - Valor o ID
+ * @property {string} - *title* - Título o texto a mostrar
+ */
+export interface IComboBoxOption {
+    /** Valor o ID */
+    value: number;
+    /** Título o texto a mostrar */
+    title: string;
+}
+/**
+ * Interfaz para las opciones de paginación.
+ *
+ * @interface IItemsPerPage
+ */
+export interface IItemsPerPage extends IComboBoxOption {
+}
+/**
+ * Interfaz para las opciones del menú de navegación.
+ *
+ * @interface IMenuItem
+ *
+ * @property {string} - *header* - Si no es nulo la opción será de tipo header
+ * @property {string} - *title* - Texto de la opción
+ * @property {string} - *icon* - Icono de la opción
+ * @property {string} - *to* - Ruta de la opción
+ * @property {boolean} - *divider* - Si es true la opción será de tipo divider
+ * @property {IMenuItem[]} - *children* -  Opciones del menú, sino es nulo la opción será de tipo ComboBox
+ * @property {boolean} - *disabled* - Indica si la opción esta deshabilitada
+ * @property {string} - *description* - Descripción de la opción
+ */
+export interface IMenuItem {
+    /** Si no es nulo la opción será de tipo header */
+    header?: string;
+    /** Texto de la opción */
+    title?: string;
+    /** Icono de la opción */
+    icon?: string;
+    /** Ruta de la opción */
+    to?: string;
+    /** Si es true la opción será de tipo divider */
+    divider?: boolean;
+    /** Opciones del menú, sino es nulo la opción será de tipo ComboBox */
+    children?: IMenuItem[];
+    /** Indica si la opción esta deshabilitada */
+    disabled?: boolean;
+    /** Descripción de la opción */
+    description?: string;
+}
+/**
+ * Interfaz para los headers de las columnas de la tabla.
+ *
+ * @interface ITableHeader
+ *
+ * @property {string} - *title* - Título del header
+ * @property {string} - *align* - Alinieación del header
+ * @property {boolean} - *sortable* - Indica si la columna es ordenable
+ * @property {string} - *key* - Key o Id del header
+ */
+export interface ITableHeader {
+    /** Título del header */
+    title: string;
+    /** Alinieación del header */
+    align: "start" | "center" | "end";
+    /** Indica si la columna es ordenable */
+    sortable: boolean;
+    /**  Key o Id del header */
+    key: string;
+}
+/**
+ * Tipo para los filtros de ordenamiento de la tabla.
+ *
+ * @type TSortValue
+ */
+export type TSortValue = boolean | "asc" | "desc";
+/**
+ * Interfaz para los filtros de ordenamiento la tabla.
+ *
+ * @interface ISort
+ */
+export interface ISort extends Record<string, TSortValue> {
+}
+/**
+ * Interfaz para los breadcumbs.
+ *
+ * @interface IBreadCumbElement
+ *
+ * @property {string} - *title* - Título del breadcumb
+ * @property {boolean} - *disabled* - Indica si el breadcumb esta deshabilitado
+ * @property {string} - *href* - Ruta del breadcumb
+ */
+export interface IBreadCumbElement {
+    /** Título del breadcumb */
+    title: string;
+    /** Indica si el breadcumb esta deshabilitado */
+    disabled: boolean;
+    /** Ruta del breadcumb */
+    href: string;
+}
+/**
+ * Interfaz para los breadcumbs de los módulos.
+ *
+ * @interface IBreadCumbs
+ *
+ * @property {IBreadCumbElement[]} - *list* - Breadcumbs para listado
+ * @property {IBreadCumbElement[]} - *create* - Breadcumbs para creación
+ * @property {IBreadCumbElement[]} - *edit* - Breadcumbs para edición
+ */
+export interface IBreadCumbs {
+    /** Breadcumbs para listado */
+    LIST: IBreadCumbElement[];
+    /** Breadcumbs para creación */
+    CREATE: IBreadCumbElement[];
+    /** Breadcumbs para edición */
+    EDIT: IBreadCumbElement[];
+}
+export type TFormBuilderField = IFormBuilderFieldText | IFormBuilderFieldTextArea | IFormBuilderFieldNumber | IFormBuilderFieldDate | IFormBuilderFieldSelect | IFormBuilderFieldSlot | IFormBuilderFieldCheckBox | IFormBuilderFieldRadioButton | IFormBuilderFieldSwitch;
+export interface IFormBuilderConfig {
+    rows?: IFormBuilderRow[];
+    tabs?: IFormBuilderTab[];
+    title: string;
+    variant: "SINGLEFORM" | "TABS" | "STEPPERS";
+    stepper?: {
+        LabelLocation?: "LEFT" | "BOTTOM";
+    };
+}
+export interface IFormBuilderTab {
+    rows: IFormBuilderRow[];
+    title: string;
+    value: number;
+}
+export interface IFormBuilderRow {
+    class?: string;
+    fields: TFormBuilderField[];
+    section?: IFormBuilderSection;
+}
+export interface IFormBuilderSection {
+    title: string;
+}
+export interface IFormBuilderFieldBase {
+    disabled?: boolean;
+    key: string;
+    label: string;
+    model: any;
+    placeHolder?: string;
+    readonly?: boolean;
+    required: boolean;
+    rules: any[];
+    size: number;
+    title: string;
+    type: TFormField;
+}
+export interface IFormBuilderFieldSlot extends IFormBuilderFieldBase {
+}
+export interface IFormBuilderFieldText extends IFormBuilderFieldBase {
+    maxlength?: number;
+}
+export interface IFormBuilderFieldTextArea extends IFormBuilderFieldBase {
+    maxlength?: number;
+    resizable?: boolean;
+    rows?: number;
+}
+export interface IFormBuilderFieldNumber extends IFormBuilderFieldBase {
+    max?: number;
+    maxlength?: number;
+    min?: number;
+}
+export interface IFormBuilderFieldDate extends IFormBuilderFieldBase {
+    displayFormat: TVuetifyDateFormat;
+}
+export interface IFormBuilderFieldSelect extends IFormBuilderFieldBase {
+    items: any[];
+    itemTitle: string;
+    itemValue: string;
+    returnObject: boolean;
+}
+export interface IFormBuilderFieldCheckBox extends IFormBuilderFieldBase {
+    falseValue?: any;
+    indeterminate?: boolean;
+    trueValue?: any;
+}
+export interface IFormBuilderFieldRadioButtonItem {
+    label: string;
+    value: any;
+}
+export interface IFormBuilderFieldRadioButton extends IFormBuilderFieldBase {
+    inline: boolean;
+    items: IFormBuilderFieldRadioButtonItem[];
+    labelLocation: "TOP" | "LEFT";
+}
+export interface IFormBuilderFieldSwitch extends IFormBuilderFieldBase {
+    falseValue?: any;
+    indeterminate?: boolean;
+    inset?: boolean;
+    labelPrepend?: string;
+    trueValue?: any;
+}

package/dist/runtime/types/index.js

@@ -0,0 +1 @@
+export { FetchClient } from "../classes/FetchClient.js";

package/dist/runtime/utils/buildSortQueryParams.d.ts

@@ -0,0 +1,10 @@
+import type { ISort } from "#imports";
+/**
+ * Retorna el  listado de los sort
+ *
+ * @param [ISortFilter] sortFilters - Lista de los sorts
+ *
+ * @return *String[]*
+ */
+declare const _default: (sortCriteria: ISort) => string;
+export default _default;

package/dist/runtime/utils/buildSortQueryParams.js

@@ -0,0 +1,3 @@
+export default (sortCriteria) => {
+  return Object.entries(sortCriteria).filter(([, order]) => order).map(([key, order]) => `${key}_${order}`).join();
+};

package/dist/runtime/utils/getCurrentPath.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Retorna la ruta actual en la que se encuentra navegando el usuario.
+ *
+ * @return *string*
+ */
+declare const _default: () => string;
+export default _default;

package/dist/runtime/utils/getCurrentPath.js

@@ -0,0 +1,4 @@
+import { useRoute } from "#app";
+export default () => {
+  return useRoute().matched[0].path;
+};

package/dist/runtime/utils/getDateTimeInISO8601.d.ts

@@ -0,0 +1,11 @@
+/**
+ *  Retorna la fecha en formato ISO-8601.
+ *
+ * @param [Date] date
+ * @param [string] timeStamp
+ * @param [string] timeOffset
+ *
+ * @return *string*
+ */
+declare const _default: (date: Date, timeStamp?: string, timeOffset?: string) => string;
+export default _default;

package/dist/runtime/utils/getDateTimeInISO8601.js

@@ -0,0 +1,3 @@
+export default (date, timeStamp = "06:00:00", timeOffset = "-06:00") => {
+  return date.toJSON().slice(0, 10).concat("T").concat(timeStamp).concat(timeOffset);
+};

package/dist/runtime/utils/getFromLocalStorage.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Retorna el valor almacenado en el local storage.
+ *
+ * @param [string] item - Item del local storage a recuperar
+ *
+ * @return *Object*
+ */
+declare const _default: (item: string) => any;
+export default _default;

package/dist/runtime/utils/getFromLocalStorage.js

@@ -0,0 +1,6 @@
+export default (item) => {
+  if (import.meta.client) {
+    return JSON.parse(localStorage.getItem(item) ?? "null");
+  }
+  return null;
+};

package/dist/runtime/utils/isNumberInRange.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Retorna si un número esta dentro de un rango.
+ *
+ * @param [number] num - Número a validar
+ * @param [number] min - Rango inferior - *null*
+ * @param [number] max - Rango superior - *null*
+ *
+ * @return *boolean*
+ */
+declare const _default: (num: number, min: number | null, max: number | null) => boolean;
+export default _default;

package/dist/runtime/utils/isNumberInRange.js

@@ -0,0 +1,5 @@
+export default (num, min, max) => {
+  if (min && !(num >= min)) return false;
+  if (max && !(num <= max)) return false;
+  return true;
+};

package/dist/runtime/utils/onlyNumbers.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Retorna si un string solo contiene numeros.
+ *
+ * @param [string] expect - Número a validar
+ *
+ * @return *boolean*
+ */
+declare const _default: (expect: string) => boolean;
+export default _default;

package/dist/runtime/utils/onlyNumbers.js

@@ -0,0 +1,3 @@
+export default (expect) => {
+  return /^[0-9]+$/.test(expect);
+};

package/dist/runtime/utils/stringToBoolean.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Convierte un string a boolean. Si es "true" retorna verdadero, cualquier otro valor sera convertido a falso.
+ *
+ * @param [string] value - Texto a convertir
+ *
+ * @return *boolean*
+ */
+declare const _default: (value: string) => boolean;
+export default _default;