una-nuxt-module 1.0.2

package/dist/runtime/stores/UiCustomizer.d.ts

@@ -0,0 +1,22 @@
+import type { IUiCustomizerState } from "../types/index.js";
+/**
+ * Store encargado de almacenar y gestionar las preferencias visuales del usuario.
+ */
+export declare const useUiCustomizerStore: import("pinia").StoreDefinition<"UiCustomizerStore", IUiCustomizerState, {}, {
+    /**
+     * Alterna el estado de renderizar el menú.
+     */
+    SET_DRAW_SIDEBAR(): void;
+    /**
+     * Cambia el estado de minimización del menú.
+     *
+     * @param [boolean] newValue - Nuevo valor
+     */
+    SET_IS_SIDEBAR_MINI(newValue: boolean): void;
+    /**
+     * Cambia el tema de la aplicación.
+     *
+     * @param [string] newValue - Nuevo tema
+     */
+    SET_THEME(newValue: string): void;
+}>;

package/dist/runtime/stores/UiCustomizer.js

@@ -0,0 +1,34 @@
+import { defineStore } from "pinia";
+import { ETheme } from "../enums/index.js";
+export const useUiCustomizerStore = defineStore({
+  id: "UiCustomizerStore",
+  state: () => ({
+    drawSidebar: true,
+    isSidebarMini: false,
+    currentTheme: ETheme.LIGHT
+  }),
+  actions: {
+    /**
+     * Alterna el estado de renderizar el menú.
+     */
+    SET_DRAW_SIDEBAR() {
+      this.drawSidebar = !this.drawSidebar;
+    },
+    /**
+     * Cambia el estado de minimización del menú.
+     *
+     * @param [boolean] newValue - Nuevo valor
+     */
+    SET_IS_SIDEBAR_MINI(newValue) {
+      this.isSidebarMini = newValue;
+    },
+    /**
+     * Cambia el tema de la aplicación.
+     *
+     * @param [string] newValue - Nuevo tema
+     */
+    SET_THEME(newValue) {
+      this.currentTheme = newValue;
+    }
+  }
+});

package/dist/runtime/stores/appStatus.d.ts

@@ -0,0 +1,63 @@
+import type { IAppStatusState, IRequestInfo, IRequestResponse } from "../types/index.js";
+/**
+ * Store encargado de almacenar y gestionar la lógica de la aplicación.
+ */
+export declare const useAppStatusStore: import("pinia").StoreDefinition<"appStatusStore", IAppStatusState, {}, {
+    /**
+     * Cambia si la aplicación esta haciendo una petición.
+     *
+     * @param [boolean] newValue - Nuevo valor
+     */
+    SET_MAKING_REQUEST(newState: boolean): void;
+    /**
+     * Cambia si la aplicación contiene un error.
+     *
+     * @param [boolean] newValue - Nuevo valor
+     */
+    SET_HAS_ERROR(newState: boolean): void;
+    /**
+     * Cambia si la aplicación debe mostrar el snack bar.
+     *
+     * @param [boolean] newValue - Nuevo valor
+     */
+    SET_SHOW_INFO(newState: boolean): void;
+    /**
+     * Cambia la información a mostrar en el snack bar.
+     *
+     * @param [boolean] newValue - Nuevo valor
+     */
+    SET_INFO(newState: IRequestInfo): void;
+    /**
+     * Cambia si la aplicación debe abrir la pantalla de confirmar eliminar.
+     *
+     * @param [boolean] newValue - Nuevo valor
+     */
+    SET_OPEN_DIALOG_DELETE(newState: boolean): void;
+    /**
+     * Cambia si la aplicación debe abrir la pantalla de exportar tabla.
+     *
+     * @param [boolean] newValue - Nuevo valor
+     */
+    SET_OPEN_DIALOG_EXPORT(newState: boolean): void;
+    /**
+     * Método que prepara la aplicación previo a realizar una petición.
+     *
+     * @param  [boolean] makingRequest - *true*
+     * @param  [boolean] hasError - *false*
+     * @param  [boolean] showInfo - *false*
+     * @param  [boolean] info - *null*
+     */
+    SET_STATE_BEFORE_REQUEST(makingRequest?: boolean, hasError?: boolean, showInfo?: boolean, info?: null): void;
+    /**
+     * Método que prepara la aplicación previo a realizar una petición pero mantiene la información de la petición previa.
+     */
+    SET_STATE_BEFORE_REQUEST_AND_KEEP_SHOWINFO(): void;
+    /**
+     * Método que actualiza la aplicación posterior a realizar una petición.
+     *
+     * @param  [IRequestResponse] response - Respuesta de la petición
+     * @param  [boolean] showInfo - *true*
+     * @param  [boolean] makingRequest - *false*
+     */
+    SET_STATE_AFTER_REQUEST(response: IRequestResponse, showInfo?: boolean, makingRequest?: boolean): void;
+}>;

package/dist/runtime/stores/appStatus.js

@@ -0,0 +1,101 @@
+import { defineStore } from "pinia";
+export const useAppStatusStore = defineStore({
+  id: "appStatusStore",
+  state: () => {
+    return {
+      makingRequest: false,
+      hasError: false,
+      showInfo: false,
+      info: null,
+      openDialogDelete: false,
+      openDialogExport: false
+    };
+  },
+  actions: {
+    /**
+     * Cambia si la aplicación esta haciendo una petición.
+     *
+     * @param [boolean] newValue - Nuevo valor
+     */
+    SET_MAKING_REQUEST(newState) {
+      this.makingRequest = newState;
+    },
+    /**
+     * Cambia si la aplicación contiene un error.
+     *
+     * @param [boolean] newValue - Nuevo valor
+     */
+    SET_HAS_ERROR(newState) {
+      this.hasError = newState;
+    },
+    /**
+     * Cambia si la aplicación debe mostrar el snack bar.
+     *
+     * @param [boolean] newValue - Nuevo valor
+     */
+    SET_SHOW_INFO(newState) {
+      this.showInfo = newState;
+    },
+    /**
+     * Cambia la información a mostrar en el snack bar.
+     *
+     * @param [boolean] newValue - Nuevo valor
+     */
+    SET_INFO(newState) {
+      this.info = newState;
+    },
+    /**
+     * Cambia si la aplicación debe abrir la pantalla de confirmar eliminar.
+     *
+     * @param [boolean] newValue - Nuevo valor
+     */
+    SET_OPEN_DIALOG_DELETE(newState) {
+      this.openDialogDelete = newState;
+    },
+    /**
+     * Cambia si la aplicación debe abrir la pantalla de exportar tabla.
+     *
+     * @param [boolean] newValue - Nuevo valor
+     */
+    SET_OPEN_DIALOG_EXPORT(newState) {
+      this.openDialogExport = newState;
+    },
+    /**
+     * Método que prepara la aplicación previo a realizar una petición.
+     *
+     * @param  [boolean] makingRequest - *true*
+     * @param  [boolean] hasError - *false*
+     * @param  [boolean] showInfo - *false*
+     * @param  [boolean] info - *null*
+     */
+    SET_STATE_BEFORE_REQUEST(makingRequest = true, hasError = false, showInfo = false, info = null) {
+      this.makingRequest = makingRequest;
+      this.hasError = hasError;
+      this.showInfo = showInfo;
+      this.info = info;
+    },
+    /**
+     * Método que prepara la aplicación previo a realizar una petición pero mantiene la información de la petición previa.
+     */
+    SET_STATE_BEFORE_REQUEST_AND_KEEP_SHOWINFO() {
+      if (this.showInfo) {
+        this.SET_MAKING_REQUEST(true);
+      } else {
+        this.SET_STATE_BEFORE_REQUEST();
+      }
+    },
+    /**
+     * Método que actualiza la aplicación posterior a realizar una petición.
+     *
+     * @param  [IRequestResponse] response - Respuesta de la petición
+     * @param  [boolean] showInfo - *true*
+     * @param  [boolean] makingRequest - *false*
+     */
+    SET_STATE_AFTER_REQUEST(response, showInfo = true, makingRequest = false) {
+      this.hasError = !response.success;
+      this.info = { title: response.title, description: response.description };
+      this.showInfo = showInfo;
+      this.makingRequest = makingRequest;
+    }
+  }
+});

package/dist/runtime/stores/auth.d.ts

@@ -0,0 +1,76 @@
+import type { IAuthData, IAuthenticatedUser, IAuthState, IHasAuthorizationInResourceParams } from "../types/index.js";
+/**
+ * Store encargado de almacenar y gestionar la autenticación y autorización del usuario.
+ */
+export declare const useAuthStore: import("pinia").StoreDefinition<"AuthStore", IAuthState, {
+    isAuthenticated: (state: {
+        user: {
+            email: string;
+            fullName: string;
+            name?: string | undefined;
+            lastName?: string | undefined;
+            photoUrl?: string | undefined;
+            mainRole?: string | undefined;
+        } | null;
+        authData: {
+            isAuthenticated: boolean;
+            accessToken: string;
+            resources: {
+                id: number;
+                nombre: string;
+                permisoInsertar: boolean;
+                permisoModificar: boolean;
+                permisoEliminar: boolean;
+            }[];
+        } | null;
+    } & import("pinia").PiniaCustomStateProperties<IAuthState>) => boolean | undefined;
+    token: (state: {
+        user: {
+            email: string;
+            fullName: string;
+            name?: string | undefined;
+            lastName?: string | undefined;
+            photoUrl?: string | undefined;
+            mainRole?: string | undefined;
+        } | null;
+        authData: {
+            isAuthenticated: boolean;
+            accessToken: string;
+            resources: {
+                id: number;
+                nombre: string;
+                permisoInsertar: boolean;
+                permisoModificar: boolean;
+                permisoEliminar: boolean;
+            }[];
+        } | null;
+    } & import("pinia").PiniaCustomStateProperties<IAuthState>) => string | undefined;
+}, {
+    /**
+     * Cierra la sesión del usuario
+     */
+    logout(): Promise<void>;
+    /**
+     * Actualiza la información del usuario autenticado y la información de la sesión.
+     *
+     * @param [IAuthenticatedUser] userInfo - Datos del usuario autenticado
+     * @param [IAuthData] authData - Datos de la sesión del usuario autenticado
+     */
+    update(userInfo: IAuthenticatedUser, authData: IAuthData): void;
+    /**
+     * Retorna si el usuario tiene acceso a un recurso.
+     *
+     * @param [string] resource - Recurso a validar
+     *
+     * @return *boolean*
+     */
+    hasResource(resource: string): boolean;
+    /**
+     * Retorna si el usuario tiene la autorización en el recurso.
+     *
+     * @param [Object] params - Objeto con los parámetros *resource* y *authorization*
+     *
+     * @return *boolean*
+     */
+    hasAuthorizationInResource(params: IHasAuthorizationInResourceParams): boolean;
+}>;

package/dist/runtime/stores/auth.js

@@ -0,0 +1,66 @@
+import { defineStore } from "pinia";
+import { EAuthorization } from "../enums/EAuthorization.js";
+import { useNuxtApp } from "#app";
+export const useAuthStore = defineStore({
+  id: "AuthStore",
+  state: () => ({
+    user: null,
+    authData: null
+  }),
+  getters: {
+    isAuthenticated: (state) => state.authData?.isAuthenticated,
+    token: (state) => state.authData?.accessToken
+  },
+  actions: {
+    /**
+     * Cierra la sesión del usuario
+     */
+    async logout() {
+      const { $signOut } = useNuxtApp();
+      await $signOut();
+    },
+    /**
+     * Actualiza la información del usuario autenticado y la información de la sesión.
+     *
+     * @param [IAuthenticatedUser] userInfo - Datos del usuario autenticado
+     * @param [IAuthData] authData - Datos de la sesión del usuario autenticado
+     */
+    update(userInfo, authData) {
+      this.user = userInfo;
+      this.authData = authData;
+    },
+    /**
+     * Retorna si el usuario tiene acceso a un recurso.
+     *
+     * @param [string] resource - Recurso a validar
+     *
+     * @return *boolean*
+     */
+    hasResource(resource) {
+      return this.authData?.resources?.find((r) => r.nombre === resource) !== void 0;
+    },
+    /**
+     * Retorna si el usuario tiene la autorización en el recurso.
+     *
+     * @param [Object] params - Objeto con los parámetros *resource* y *authorization*
+     *
+     * @return *boolean*
+     */
+    hasAuthorizationInResource(params) {
+      const resource = this.authData?.resources.find(
+        (r) => r.nombre === params.resource
+      );
+      if (resource === void 0) return false;
+      switch (params.authorization) {
+        case EAuthorization.CREATE:
+          return resource.permisoInsertar;
+        case EAuthorization.EDIT:
+          return resource.permisoModificar;
+        case EAuthorization.DELETE:
+          return resource.permisoEliminar;
+        default:
+          return false;
+      }
+    }
+  }
+});

package/dist/runtime/stores/formModeTracker.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Store encargado de almacenar y gestionar el modo de edición de formulario del módulo actual.
+ *
+ * Usado por el middlware de autorización para validar si el usuario tiene el acceso de crear o editar del módulo actual.
+ * Al ir al formulario de un modulo el formato de la ruta es: "/modules/{NombreModulo}/form".
+ * Este Store es necesario para identificar si el formulario esta en modo crear o modo editar.
+ */
+export declare const useFormModeTrackerStore: import("pinia").StoreDefinition<"formModeTrackerStore", import("pinia")._UnwrapAll<Pick<{
+    formMode: import("vue").Ref<"CREATE" | "EDIT", "CREATE" | "EDIT">;
+}, "formMode">>, Pick<{
+    formMode: import("vue").Ref<"CREATE" | "EDIT", "CREATE" | "EDIT">;
+}, never>, Pick<{
+    formMode: import("vue").Ref<"CREATE" | "EDIT", "CREATE" | "EDIT">;
+}, never>>;

package/dist/runtime/stores/formModeTracker.js

@@ -0,0 +1,10 @@
+import { defineStore } from "pinia";
+import { EFormMode } from "../enums/index.js";
+import { ref } from "vue";
+export const useFormModeTrackerStore = defineStore(
+  "formModeTrackerStore",
+  () => {
+    const formMode = ref(EFormMode.CREATE);
+    return { formMode };
+  }
+);