@m4l/components 0.1.64 → 0.1.66

package/components/areas/contexts/AreasContext/types.d.ts

@@ -1,6 +1,125 @@
+import { GetLabelType, NetworkProps } from '@m4l/core';
 import { ReactNode } from 'react';
+import { AreaStore } from '../../components/AreasViewer/subcomponents/Area/contexts/AreaContext/store';
+import { AreaType } from '../../components/AreasViewer/subcomponents/Area/types';
+import { ViwerClasses } from '../../components/AreasViewer/classes';
+import { AdminClasses } from '../../components/AreasAdmin/classes';
+/**
+ * @description estado de carga de las areaS de trabajo.
+ */
+export declare type AreasStatus = 'init' | 'loading' | 'loaded' | 'error';
+export declare type OwnerState = {
+    /**
+     *  "isSkeleton" indica si el componente está en skeleton.
+     */
+    status: AreasStatus;
+    /**
+     *  "isMobile" cuando el navegador está en modo celular
+     */
+    isMobile: boolean;
+    /**
+     *  "isSkeleton" indica si el componente está en skeleton.
+     */
+    isSkeleton: boolean;
+};
+/**
+ * @type
+ * @name ExternalOwnerState
+ * @description Estados que se actulizan por fuera del store, a través de hooks
+ */
+export declare type ExternalOwnerState = Pick<OwnerState, 'isMobile' | 'isSkeleton'>;
+/**
+ * @interface
+ * @description Interface que define el estado del componente (variables y funciones )
+ */
+export interface AreasState {
+    /**
+     *  "loadAreasFromNetwork" Indica si se deben cargar/grabar las áreas de trabajo en la API
+     */
+    loadAreasFromNetwork: boolean;
+    /**
+     *  "loadCookiesFromNetwork" Indica si se deben cargar/grabar las cookies en la API
+     */
+    loadCookiesFromNetwork: boolean;
+    /**
+     *  "currentArea" Area de trabajo seleccionada
+     */
+    currentArea: string;
+    /**
+     *  "ownerState" enfocado al funcionamiento de las clases
+     */
+    ownerState: OwnerState;
+    /**
+     *  "viwerClasses" enfocado al funcionamiento de las clases a nivel de viewer
+     */
+    viwerClasses: ViwerClasses;
+    /**
+     *  "adminClasses" enfocado al funcionamiento de las clases a nivel de Admin
+     */
+    adminClasses: AdminClasses;
+    /**
+     *  "areas" Areas de trabajo
+     */
+    areas: AreaType[];
+    /**
+     *  "networkOperation" funcion que usará el Store para enviar las peticiones de red
+     */
+    networkOperation: (props: NetworkProps) => Promise<any>;
+    /**
+     *  "getLabel" funcion que usará para traducir las etiquetas de diccionario
+     */
+    getLabel: GetLabelType;
+}
+export interface AreasStateWithActions extends AreasState {
+    actions: {
+        /**
+         * @description inicializa el componente, si la función onLoad está seteada, se invoca
+         */
+        init: () => void;
+        /**
+         * @description Agrega un area de trabajo, si esta activa "loadAreasFromNetwork" llama al API de agregado
+         * @returns id del ara de trabajo
+         */
+        addArea: () => string;
+        /**
+         *
+         * @param newAreaId Id de area a seleccionar
+         * @returns
+         */
+        selectArea: (newAreaId: string) => void;
+        /**
+         * @description Borra un area de trabajo, si esta activa "loadAreasFromNetwork" llama al API
+         * @param areaId Id de area a borrar
+         * @returns void
+         */
+        deleteArea: (areaId: string) => void;
+    };
+    internalActions: {
+        /**
+         * @description Actualiza la variable de estado "getLabel"
+         * @param newHandler handle o función que va a traducir las etiquetas, esto es necesario debido que getLabel de useModuleDictionary
+         * cambia por el useCallback, cuando el diccionario se carga.
+         * @returns void
+         */
+        setHandlerGetLabel: (newHandler: GetLabelType) => void;
+        /**
+         * @description conecta el store de una Area con el Store de AreaS, para poder lanzar ventanas.
+         * @returns void
+         */
+        setAreaLink: (areaId: string, store: AreaStore) => void;
+        /**
+         * @description Modifica los estados que se actualizan externamente al Store
+         * @param newIsMobile
+         * @returns
+         */
+        setExternalState: (newExternalState: ExternalOwnerState) => void;
+    };
+}
+export declare type DefaultAreasStoreProps = Omit<AreasState, 'currentArea'>;
+export declare type InitialAreasStoreProps = Pick<AreasState, 'networkOperation' | 'loadAreasFromNetwork' | 'loadCookiesFromNetwork' | 'getLabel' | 'ownerState'> & Partial<DefaultAreasStoreProps>;
 export interface AreasProviderProps {
     children: ReactNode;
     loadAreasFromNetwork: boolean;
+    loadCookiesFromNetwork: boolean;
     onLoad?: () => void;
 }

package/components/areas/contexts/WindowToolsMFContext/types.d.ts

@@ -1,9 +1,10 @@
 import { ReactNode } from 'react';
 import { MenuAction } from '../../../mui_extended';
-import { CookieType } from '../../components/Area/types';
+import { CookieType } from '../../components/AreasViewer/subcomponents/Area/types';
 export declare type WindowActionType = 'main' | 'allways' | 'normal';
 export interface ModuleAction extends MenuAction {
     visibility: WindowActionType;
+    key: string;
     tag?: any;
     className?: string;
 }
@@ -11,7 +12,7 @@ export interface WindowToolsMF {
     getCookie: (id: string) => Record<string, any> | undefined;
     getWindowId: () => string;
     getCookies: (type: CookieType) => Record<string, any>;
-    setActions: (newActions: ModuleAction[]) => void;
+    setActions: (newActions: ModuleAction[], version?: string) => void;
     setCookie: (id: string, type: CookieType, cookie: Record<string, any>) => void;
     close: () => void;
 }

package/components/areas/dictionary.d.ts

@@ -1,14 +1,9 @@
-export declare const MODULE_NAME_ADD = "module_name_add";
-export declare const MODULE_NAME_EDIT = "module_name_edit";
-export declare const LABEL_NEW_AREA = "label_new_area";
-export declare const LABEL_DELETE_AREA = "label_delete_area";
-export declare const MODAL_DELETE_MESSAGE = "modal_delete_message";
-export declare const MODAL_DELETE_TITLE = "modal_delete_title";
-export declare const ROW_ACTION_EDIT = "row_action_edit";
-export declare const ROW_ACTION_DELETE = "row_action_delete";
-export declare const LABEL_ID = "label_id";
-export declare const ACCORDION_BASIC_INFORMATION = "accordion_basic_information";
-export declare const ACCORDION_CONTACT_DATA = "accordion_contact_data";
-export declare const LABEL_ROLE_NAME = "label_role_name";
-export declare const LABEL_PRIVILEGE_NAME = "label_privilege_name";
-export declare const LABEL_PRIVILEGE_ACTIVE = "label_privilege_active";
+export declare const AREAS_DICTIONARY_ID = "areas";
+export declare function getAreasComponentsDictionary(): string[];
+export declare const LABEL_FILTER_BUTTON = "filter_tooltip";
+export declare const DICCTIONARY: {
+    readonly label_new_area: "label_new_area";
+    readonly label_persist_module_cookies: "label_persist_module_cookies";
+};
+export declare type TypeDictionary = typeof DICCTIONARY;
+export declare const getAreasDictionary: (key: keyof TypeDictionary) => string;

package/components/areas/hooks/useArea/index.d.ts

@@ -1,4 +1,4 @@
-import { AreaStateWithActions } from '../../contexts/AreaContext/store';
+import { AreaStateWithActions } from '../../components/AreasViewer/subcomponents/Area/contexts/AreaContext/types';
 export declare const useArea: () => Omit<Omit<import("zustand").StoreApi<AreaStateWithActions>, "setState"> & {
     setState<A extends string | {
         type: unknown;

package/components/areas/hooks/useAreas/index.d.ts

@@ -1,4 +1,4 @@
-import { AreasStateWithActions } from '../../contexts/AreasContext/store';
+import { AreasStateWithActions } from '../../contexts/AreasContext/types';
 export declare function useAreas(): Omit<Omit<import("zustand").StoreApi<AreasStateWithActions>, "setState"> & {
     setState<A extends string | {
         type: unknown;

package/components/areas/hooks/useWindow/index.d.ts

@@ -1,4 +1,4 @@
-import { WindowStateWithActions } from '../../contexts/WindowContext/store';
+import { WindowStateWithActions } from '../../components/AreasViewer/subcomponents/Area/subcomponents/Window/contexts/WindowContext/store';
 export declare const useWindow: () => Omit<Omit<import("zustand").StoreApi<WindowStateWithActions>, "setState"> & {
     setState<A extends string | {
         type: unknown;

package/components/areas/icons.d.ts

@@ -0,0 +1,8 @@
+export declare const ICONS: {
+    CLOSE: string;
+    MAXIMIZE: string;
+    NORMALIZE: string;
+    DELETE_AREA: string;
+    ADD_AREA: string;
+    EDIT_AREA: string;
+};

package/components/areas/index.d.ts

@@ -1,3 +1,4 @@
 export * from './components';
 export * from './contexts';
 export * from './hooks';
+export * from './dictionary';