@m4l/graphics 6.0.2-alpha.2 → 6.0.2

package/components/GlobalStyles/index.d.ts

@@ -1 +1,8 @@
+/**
+ * Estilos globales
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:17 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare function GlobalStyles(): import("react").JSX.Element;

package/contexts/FormatterContext/index.d.ts

@@ -1,15 +1,12 @@
 import { FormatterProviderProps, Formatters } from './types';
 declare const FormatterContext: import('react').Context<Formatters | null>;
 /**
- * @function
  * Componente encargado de proveer un contexto que permita saber los diferentes forrmatos,
  * Segunda linea
- * @param props Objeto de propiedades
- * @version 1.0.0
- * @author Juan Andrés Escobar
- * @date 2023-02-11
- * @beta
- * @link
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
  */
 declare function FormatterProvider(props: FormatterProviderProps): import("react").JSX.Element;
 export { FormatterProvider, FormatterContext };

package/contexts/FormatterContext/types.d.ts

@@ -9,7 +9,11 @@ export interface NumberFormatter {
     thousandsSymbol: string;
 }
 /**
- * @author
+ * Formateador de fechas
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
  */
 export interface DateFormatter {
     dateFormat: string;
@@ -46,7 +50,6 @@ export interface OptionalFormatters {
     numberFormatter?: NumberFormatter;
 }
 /**
- * @interface
  */
 export interface FormatterProviderProps extends OptionalFormatters {
     isMicroFrontEnd: boolean;

package/contexts/HostThemeContext/index.d.ts

@@ -1,4 +1,11 @@
 import { HostThemeProviderProps } from './types';
 declare const HostThemeContext: import('react').Context<import('./types').HostThemeType | null>;
+/**
+ * Host theme provider
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 declare function HostThemeProvider(props: HostThemeProviderProps): import("react").JSX.Element;
 export { HostThemeProvider, HostThemeContext };

package/contexts/LocalesContext/helper.d.ts

@@ -1,4 +1,25 @@
 import { BaseLocale, LocaleType, NetworkLocaleType } from './types';
+/**
+ * Obtiene el locale de la red
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare function getLocaleFromNetwork(locale: NetworkLocaleType, host_static_assets: string, environment_assets: string): Promise<LocaleType>;
+/**
+ * Une los elementos de un locale
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare function joinLocale(baseLocale: BaseLocale): string;
+/**
+ * Divide un locale en sus partes
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare function splitLocale(locale: string): BaseLocale;

package/contexts/LocalesContext/index.d.ts

@@ -1,4 +1,11 @@
 import { LocalesProviderProps, LocalesContextProps } from './types';
 declare const LocalesContext: import('react').Context<LocalesContextProps | null>;
+/**
+ * Proveedor de locales
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 declare function LocalesProvider(props: LocalesProviderProps): import("react").JSX.Element | null;
 export { LocalesProvider, LocalesContext };

package/contexts/ResponsiveContainerContext/index.d.ts

@@ -8,5 +8,12 @@ declare const ResponsiveContainerContext: import('react').Context<(Omit<Omit<imp
         type: unknown;
     } | undefined): void;
 }) | null>;
+/**
+ * Proveedor de contenedor responsivo
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 declare const ResponsiveContainerProvider: (props: ResponsiveContainerProviderProps) => import("react").JSX.Element;
 export { ResponsiveContainerProvider, ResponsiveContainerContext };

package/contexts/ResponsiveContainerContext/store.d.ts

@@ -1,4 +1,11 @@
 import { InitialResponsiveContainerProps, ResponsiveContainerStateWithActions } from './types';
+/**
+ * Crea la tienda de contenedor responsivo
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare const createResponsiveContainerStore: (initProps: InitialResponsiveContainerProps) => Omit<Omit<import('zustand').StoreApi<ResponsiveContainerStateWithActions>, "setState"> & {
     setState<A extends string | {
         type: unknown;

package/contexts/ResponsiveContainerContext/store.js

@@ -10,6 +10,13 @@ const S = (r) => {
       n((t, p) => ({
         ...s,
         responsiveContainerActions: {
+          /**
+           * Establece el punto de interrupción
+           * @author Juan Escobar - automatic
+           * @createdAt 2024-10-06 20:07:18 - automatic
+           * @updatedAt 2024-10-06 20:07:18 - automatic
+           * @updatedUser Juan Escobar - automatic
+           */
           setBreakpoint: (e) => {
             t((o) => {
               o.breakPoint = e, o.isUpSm = e !== "xs" && e !== "sm", o.isXs = e === "xs";

package/contexts/ThemeSettingsContext/ThemeSettingsContext.d.ts

@@ -8,5 +8,12 @@ declare const ThemeSettingsContext: import('react').Context<(Omit<Omit<import('z
         type: unknown;
     } | undefined): void;
 }) | null>;
+/**
+ * Theme settings provider
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 declare function ThemeSettingsProvider({ children, themeSettings }: ThemeSettingsProviderProps): import("react").JSX.Element;
 export { ThemeSettingsProvider, ThemeSettingsContext };

package/contexts/ThemeSettingsContext/store.d.ts

@@ -1,5 +1,12 @@
 import { InitialThemeSettingsStoreProps, ThemeSettingsStateWithActions } from './types';
 import { WritableDraft } from 'immer/dist/internal';
+/**
+ * Crea la tienda de configuración del tema
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare const createThemeSettingsStore: (initialState: InitialThemeSettingsStoreProps) => Omit<Omit<import('zustand').StoreApi<ThemeSettingsStateWithActions>, "setState"> & {
     setState<A extends string | {
         type: unknown;

package/contexts/ThemeSettingsContext/store.js

@@ -46,16 +46,37 @@ const o = (n) => {
     S((r, m) => ({
       ...n,
       settingsActions: {
+        /**
+         * Inicializa la tienda de configuración del tema
+         * @author Juan Escobar - automatic
+         * @createdAt 2024-10-06 20:07:18 - automatic
+         * @updatedAt 2024-10-06 20:07:18 - automatic
+         * @updatedUser Juan Escobar - automatic
+         */
         init: () => {
           r((t) => {
             o(t);
           });
         },
+        /**
+         * Establece la configuración del tema
+         * @author Juan Escobar - automatic
+         * @createdAt 2024-10-06 20:07:18 - automatic
+         * @updatedAt 2024-10-06 20:07:18 - automatic
+         * @updatedUser Juan Escobar - automatic
+         */
         setThemeSettings: (t) => {
           r((e) => {
             e.currentThemeSettings = { ...e.currentThemeSettings, ...t }, i(e), o(e);
           });
         },
+        /**
+         * Cambia el modo del tema
+         * @author Juan Escobar - automatic
+         * @createdAt 2024-10-06 20:07:18 - automatic
+         * @updatedAt 2024-10-06 20:07:18 - automatic
+         * @updatedUser Juan Escobar - automatic
+         */
         onChangeMode: (t) => {
           r((e) => {
             e.currentThemeSettings = {
@@ -64,11 +85,25 @@ const o = (n) => {
             }, i(e), o(e);
           });
         },
+        /**
+         * Abre o cierra el panel de configuración del tema
+         * @author Juan Escobar - automatic
+         * @createdAt 2024-10-06 20:07:18 - automatic
+         * @updatedAt 2024-10-06 20:07:18 - automatic
+         * @updatedUser Juan Escobar - automatic
+         */
         handleOpen: () => {
           r((t) => {
             t.open = !t.open;
           });
         },
+        /**
+         * Cambia la dirección del tema
+         * @author Juan Escobar - automatic
+         * @createdAt 2024-10-06 20:07:18 - automatic
+         * @updatedAt 2024-10-06 20:07:18 - automatic
+         * @updatedUser Juan Escobar - automatic
+         */
         onChangeDirection: (t) => {
           r((e) => {
             e.currentThemeSettings = {
@@ -77,6 +112,13 @@ const o = (n) => {
             }, i(e), o(e);
           });
         },
+        /**
+         * Cambia el color del tema
+         * @author Juan Escobar - automatic
+         * @createdAt 2024-10-06 20:07:18 - automatic
+         * @updatedAt 2024-10-06 20:07:18 - automatic
+         * @updatedUser Juan Escobar - automatic
+         */
         onChangeColor: (t) => {
           r((e) => {
             e.currentThemeSettings = {
@@ -85,6 +127,13 @@ const o = (n) => {
             }, i(e), o(e);
           });
         },
+        /**
+         * Cambia el diseño del tema
+         * @author Juan Escobar - automatic
+         * @createdAt 2024-10-06 20:07:18 - automatic
+         * @updatedAt 2024-10-06 20:07:18 - automatic
+         * @updatedUser Juan Escobar - automatic
+         */
         onChangeLayout: (t) => {
           r((e) => {
             e.currentThemeSettings = {
@@ -93,6 +142,13 @@ const o = (n) => {
             }, i(e), o(e);
           });
         },
+        /**
+         * Cambia el estiramiento del tema
+         * @author Juan Escobar - automatic
+         * @createdAt 2024-10-06 20:07:18 - automatic
+         * @updatedAt 2024-10-06 20:07:18 - automatic
+         * @updatedUser Juan Escobar - automatic
+         */
         onToggleStretch: () => {
           r((t) => {
             t.currentThemeSettings = {
@@ -101,6 +157,13 @@ const o = (n) => {
             }, i(t), o(t);
           });
         },
+        /**
+         * Resetea la configuración del tema
+         * @author Juan Escobar - automatic
+         * @createdAt 2024-10-06 20:07:18 - automatic
+         * @updatedAt 2024-10-06 20:07:18 - automatic
+         * @updatedUser Juan Escobar - automatic
+         */
         onResetSetting: () => {
           r((t) => {
             t.currentThemeSettings = {

package/contexts/ThemeSettingsContext/types.d.ts

@@ -19,12 +19,17 @@ export interface ThemeSettingsStore {
     currentThemeSettings: ThemeSettingsType;
     /**
      * Contiene la configuración incial del tema como la paleta, tipografía, sombras, etc. También puede contener el tema convertido a css vars.
+     * @createdAt 2024-10-06 20:07:18 - automatic
      */
     themeOptions: (Omit<Theme, 'palette' | 'applyStyles'> & CssVarsTheme) | OurTheme;
     colorOption: PresetsOptions;
     /**
      * "setterThemeSettings" es una función que se encarga de persistir en local storage los cambios de los settings
      * Solo se instancia cuando esta en host, cuando esta storybook no se instancia
+     * @author Juan Escobar - automatic
+     * @createdAt 2024-10-06 20:07:18 - automatic
+     * @updatedAt 2024-10-06 20:07:18 - automatic
+     * @updatedUser Juan Escobar - automatic
      */
     setterThemeSettings?: (newValue: ThemeSettingsType) => void;
     open: boolean;
@@ -33,6 +38,13 @@ export type DefaultThemeSettingsStoreProps = ThemeSettingsStore;
 export type InitialThemeSettingsStoreProps = DefaultThemeSettingsStoreProps;
 export interface ThemeSettingsStateWithActions extends ThemeSettingsStore {
     settingsActions: {
+        /**
+         * Inicializa la tienda de configuración del tema
+         * @author Juan Escobar - automatic
+         * @createdAt 2024-10-06 20:07:18 - automatic
+         * @updatedAt 2024-10-06 20:07:18 - automatic
+         * @updatedUser Juan Escobar - automatic
+         */
         init: () => void;
         onToggleStretch: VoidFunction;
         onResetSetting: VoidFunction;

package/hooks/useFirstRender/index.d.ts

@@ -1,2 +1,9 @@
 import { DependencyList } from 'react';
+/**
+ * Hook to use the first render
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare function useFirstRender(dependencies?: DependencyList): boolean;

package/hooks/useFormatter/index.d.ts

@@ -1 +1,8 @@
+/**
+ * Hook to use the formatter context
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare const useFormatter: () => import('../..').Formatters;

package/hooks/useHostTheme/index.d.ts

@@ -1 +1,8 @@
+/**
+ * Hook to use the host theme context
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare const useHostTheme: () => import('../..').HostThemeType;

package/hooks/useIsMobile/index.d.ts

@@ -1 +1,8 @@
+/**
+ * Hook to check if the device is a mobile device
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare const useIsMobile: () => boolean;

package/hooks/useIsMountedRef/index.d.ts

@@ -1 +1,8 @@
+/**
+ * Hook to use the is mounted ref
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare function useIsMountedRef(): import('react').MutableRefObject<boolean>;

package/hooks/useLocales/index.d.ts

@@ -1 +1,8 @@
+/**
+ * Hook to use the locales context
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare const useLocales: () => import('../../contexts/LocalesContext/types').LocalesContextProps;

package/hooks/useOffSetTop.d.ts

@@ -1 +1,8 @@
+/**
+ * Hook to use the offset top
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare function useOffSetTop(top: number): boolean;

package/hooks/useResizeObserver/index.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Hook to use the resize observer
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare function useResizeObserver<T extends HTMLElement>(callback: (target: T, entry: ResizeObserverEntry) => void): import('react').RefObject<T>;
 export default useResizeObserver;

package/hooks/useResponsive/index.d.ts

@@ -1 +1,8 @@
+/**
+ * Returns true if the screen size is desktop.
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare function useResponsiveDesktop(): boolean | undefined;

package/hooks/useResponsiveContainer/index.d.ts

@@ -1,2 +1,9 @@
 import { ResponsiveContainerStateWithActions } from '../../contexts/ResponsiveContainerContext/types';
+/**
+ * Hook to use the responsive container store
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare function useResponsiveContainerStore<T>(selector: (state: ResponsiveContainerStateWithActions) => T, equalityFn?: (left: T, right: T) => boolean): T;

package/hooks/useThemSettingsStore/index.d.ts

@@ -1,2 +1,9 @@
 import { ThemeSettingsStateWithActions } from '../../contexts/ThemeSettingsContext/types';
+/**
+ * Hook to use the settings store
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:07:18 - automatic
+ * @updatedAt 2024-10-06 20:07:18 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare function useThemeSettingsStore<T>(selector: (state: ThemeSettingsStateWithActions) => T, equalityFn?: (left: T, right: T) => boolean): T;

package/package.json

@@ -1,16 +1,24 @@
 {
   "name": "@m4l/graphics",
-  "version": "6.0.2-alpha.2",
+  "version": "6.0.2",
   "license": "UNLICENSED",
   "author": "M4L Team*",
+  "publishConfig": {
+    "access": "public"
+  },
+  "lint-staged": {
+    "**/*.{js,jsx,ts,tsx,json}": [
+      "eslint . --fix"
+    ]
+  },
   "dependencies": {
     "date-fns": "^2.30.0",
     "immer": "^9.0.21",
     "zustand": "4.3.6"
   },
   "peerDependencies": {
-    "@m4l/core": "^2.0.9-alpha.0",
-    "@m4l/styles": "^6.4.1",
+    "@m4l/core": "^2.0.9",
+    "@m4l/styles": "^6.5.1",
     "@mui/material": "^5.15.19",
     "@mui/x-date-pickers": "^6.11.1",
     "@types/react": "^18.0.0",
@@ -70,9 +78,6 @@
   "type": "module",
   "types": "./index.d.ts",
   "sideEffects": false,
-  "publishConfig": {
-    "access": "public"
-  },
   "engines": {
     "node": ">=12.0.0"
   },

package/utils/anchorEl.d.ts

@@ -7,6 +7,13 @@ export interface AnchorPosition {
     top: number;
     left: number;
 }
+/**
+ * Get the position of the element based on the anchor element
+ * @author Juan Escobar - automatic
+ * @createdAt 2024-10-06 20:06:37 - automatic
+ * @updatedAt 2024-10-06 20:06:38 - automatic
+ * @updatedUser Juan Escobar - automatic
+ */
 export declare const getAnchorElPositionWindow: (anchorElement: HTMLElement, newWindowRect: Pick<DOMRect, "width" | "height">, anchorOrigin: AnchorOrigin, transformOrigin: AnchorOrigin, marginThreshold?: number) => {
     top: number;
     left: number;