@m4l/components 0.2.13 → 0.2.15

package/components/maps/components/GpsTools/contexts/GpsToolsContext/types.d.ts

@@ -0,0 +1,173 @@
+import { GetLabelType } from '@m4l/core';
+import { ReactNode } from 'react';
+import { FeatureId } from '../../../Map';
+import { CrossingFeature, GeofenceListModel, InternalFeature } from '../../subcomponents/TabTools/subcomponents/GeofencesTool/model';
+export declare type GpsToolsStatus = 'init' | 'ready';
+export declare type CurrentTabTool = 'geofences' | 'measure';
+export interface GeofenceFeature extends Pick<GeofenceListModel, 'id' | 'name' | 'type' | 'geometry' | 'properties' | 'createdAt' | 'updatedAt' | 'countCrossingFeatures' | 'countInternalFeatures' | 'timeMinInSeconds' | 'timeMinOutSeconds' | 'alias' | 'customerId'> {
+    hasRenderizedGeofence: boolean;
+    /**
+     * "renderizedCrossingFeatures" indica si está renderizado los features de cruce
+     */
+    hasRenderizedCrossingFeatures: boolean;
+    /**
+     * "loadedCrossingFeatures" features cargados, mas no necesariamente visibles (incremental)
+     */
+    loadedCrossingFeatures: CrossingFeature[] | null;
+    /**
+     * "loadedInternalFeatures" features internos cargados, mas no necesariamente visibles (incremental)
+     */
+    loadedInternalFeatures: InternalFeature[] | null;
+    /**
+     * "renderizedInternalFeatures" indica si está renderizado los features internos
+     */
+    hasRenderizedInternalFeatures: boolean;
+}
+export declare type OwnerState = {
+    status: GpsToolsStatus;
+    /**
+     *  "isMobile" cuando el navegador está en modo celular
+     */
+    isMobile: boolean;
+    /**
+     *  "isSkeleton" indica si el componente está en skeleton.
+     */
+    isSkeleton: boolean;
+    /**
+     * focus: Estado de selección asignado por el usuario.
+     *
+     */
+    focus: 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'>;
+export declare type CurrentGeofenceTool = 'list' | 'add_edit';
+/**
+ * @description Tipo de dato del Id de la geocerca
+ * @interface GeofenceId
+ */
+export interface GeofenceState {
+    /**
+     * "geofenceId" indica el id de la geocerca en edición
+     */
+    geofenceId?: GeofenceId;
+    rows: GeofenceListModel[];
+    /**
+     * "currentGeofenceTool" indica la herramienta de geocercas en uso
+     */
+    currentGeofenceTool: CurrentGeofenceTool;
+    /**
+     * "checkedGeofences" indica las geocercas visibles en el mapa
+     */
+    checkedGeofences: ReadonlySet<GeofenceId>;
+    /**
+     * "hashGeofences" Almacena las geocercas que se han cargado alguna vez, no necesariamente visibles
+     */
+    hashGeofences: Record<FeatureId, GeofenceFeature>;
+    /**
+     * "checkedCrossingFeatures" indica los crossing features visibles en el mapa
+     */
+    checkedCrossingFeatures: ReadonlySet<GeofenceId>;
+    /**
+     * "checkedInternalFeatures" indica los features internos visibles en el mapa
+     */
+    checkedInternalFeatures: ReadonlySet<GeofenceId>;
+}
+/**
+ * @description Tipo de dato del Id de la geocerca
+ * @interface GeofenceId
+ */
+export declare type GeofenceId = number;
+/**
+ * @interface
+ * @description Interface que define el estado del componente (variables y funciones )
+ */
+export interface GpsToolsState {
+    ownerState: OwnerState;
+    /**
+     * "currentTabTool" indica la pestaña actual en uso
+     */
+    currentTabTool: CurrentTabTool;
+    /**
+     * "geofenceState" manejo del estado lo relacionado con geocercas
+     */
+    geofenceState: GeofenceState;
+    /**
+     *  "getLabel" funcion que usará para traducir las etiquetas de diccionario
+     */
+    getLabel: GetLabelType;
+}
+export interface GpsToolsStateWithActions extends GpsToolsState {
+    gpsToolsActions: {
+        /**
+         * @description
+         */
+        init(): void;
+        /**
+         * @description Cambia el estado del las herramientas de gps
+         */
+        setGpsToolsState: (state: GpsToolsStatus) => void;
+        /**
+         * @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 Modifica los estados que se actualizan externamente al Store
+         * @param newIsMobile
+         * @returns
+         */
+        setExternalState: (newExternalState: ExternalOwnerState) => void;
+        /**
+         * @description Modifica los estados que se actualizan externamente al Store
+         * @param newIsMobile
+         * @returns
+         */
+        setCurrentTabTool: (newTabTool: CurrentTabTool) => void;
+    };
+    geofenceActions: {
+        /**
+         * @description Cambia la vista de la del modulo add/edit geocercas
+        */
+        goToAddEdit: (geofenceId?: GeofenceId) => void;
+        /**
+         * @description Cambia la vista de la del modulo add/edit geocercas
+        */
+        goToList: (geofenceId?: GeofenceId) => void;
+        /**
+         * @description Agrega una geocerca al store
+        */
+        addGeofence: (geofenceId: GeofenceId, geofence: GeofenceFeature) => void;
+        /**
+         * @description Actualizar parcialmente una geocerca
+        */
+        updatePartialGeofence: (geofenceId: GeofenceId, geofence: Partial<GeofenceFeature>) => void;
+        /**
+         * @description Actualizar la filas que son mostradas en el grid de geocercas
+        */
+        updateRows: (newRows: GeofenceListModel[]) => void;
+        /**
+         * @description Cambia el set de chequeo de las geocercas
+         */
+        setCheckedGeofences: (newGeofences: ReadonlySet<GeofenceId>) => void;
+        /**
+         * @description Cambia el set de chequeo de los crossing features
+         */
+        setCheckedCrossingFeatures: (newFeatures: ReadonlySet<GeofenceId>) => void;
+        /**
+         * @description Cambia el set de chequeo de los internal features
+         */
+        setCheckedInternalFeatures: (newFeatures: ReadonlySet<GeofenceId>) => void;
+    };
+}
+export declare type DefaultMapGpsToolsStoreProps = Omit<GpsToolsState, 'currentLayer'>;
+export declare type InitialMapGpsToolsStoreProps = Pick<GpsToolsState, 'getLabel' | 'ownerState'> & Partial<DefaultMapGpsToolsStoreProps>;
+export interface MapGpsToolsProviderProps {
+    children: ReactNode;
+}

package/components/maps/components/GpsTools/hooks/useGpsToolsStore/index.d.ts

@@ -0,0 +1,2 @@
+import { GpsToolsStateWithActions } from '../../contexts/GpsToolsContext/types';
+export declare function useGpsToolsStore<T>(selector: (state: GpsToolsStateWithActions) => T, equalityFn?: (left: T, right: T) => boolean): T;

package/components/maps/components/GpsTools/hooks/useLayers/index.d.ts

@@ -0,0 +1 @@
+export declare function useLayers(): void;

package/components/maps/components/GpsTools/icons.d.ts

@@ -0,0 +1,15 @@
+export declare const icons: {
+    GEOMETRY_CIRCLE: string;
+    GEOMETRY_RECTANGLE: string;
+    GEOMETRY_POLYGON: string;
+    ADD: string;
+    MEASURE: string;
+    GENERAL: string;
+    CONFIG: string;
+    STROKE: string;
+    FILL: string;
+    EDIT: string;
+    DELETE: string;
+    ACTIVE: string;
+    NAME: string;
+};