@m4l/components 9.1.76 → 9.1.77

package/components/DataGrid/formatters/ColumnUncertaintyFormatter/index.js

@@ -1,5 +1,5 @@
 import { jsx } from "react/jsx-runtime";
-import { U as UncertaintyFormatter } from "../../../formatters/UncertaintyFormatter/index.js";
+import { U as UncertaintyFormatter } from "../../../formatters/UncertaintyFormatter/UncertaintyFormatter.js";
 function ColumnUncertaintyFormatter(props) {
   return (obProps) => {
     return /* @__PURE__ */ jsx(UncertaintyFormatter, { obProps, ...props });

package/components/formatters/UncertaintyFormatter/UncertaintyFormatter.d.ts

@@ -0,0 +1,53 @@
+import { default as React } from 'react';
+import { UncertaintyFormatterProps } from './types';
+import { UncertaintyFormatterRootStyled } from './slots/UncertaintyFormatterSlots';
+/**
+ * Formatea un conjunto de rangos de incertidumbre en una cadena legible.
+ * @param obProps - Objeto que contiene las propiedades de los rangos de incertidumbre.
+ * @param fieldValue - Nombre del campo que contiene los valores de los rangos.
+ * @param fieldSymbol - Nombre del campo que contiene el símbolo a utilizar.
+ * @param fieldUnit - Nombre del campo que contiene la unidad de medida.
+ * @returns Una cadena que representa los rangos de incertidumbre formateados.
+ * @example
+ * const obProps = {
+ *   ranges: [
+ *    { cmc_min: -20, cmc_max: 0.0, cmc_min_closed: true, cmc_max_closed: false, cmc_uncertainty: 0.5 },
+ *   ],
+ *   symbol: 'T',
+ *   unit: '°C'
+ * };
+ * const result = getUncertaintyFormat(obProps, 'ranges', 'symbol', 'unit');
+ * console.log(result); // "[-20°C ≤ T < 0°C ± 0.5]"
+ */
+export declare function getUncertaintyFormat(obProps: any, fieldValue: string, fieldSymbol: string, fieldUnit: string): string;
+/**
+ * Formatea y muestra valores de incertidumbre con estilo opcional.
+ * @param props - Las propiedades para el componente UncertaintyFormatter.
+ * @returns El valor de incertidumbre formateado envuelto en el componente especificado.
+ * @example
+ * ```tsx
+ *
+ * const ObjFormatter = {
+ *  ranges: [
+ *        { cmc_min: -20,
+ *          cmc_max: 0.0,
+ *          cmc_min_closed: true,
+ *          cmc_max_closed: false,
+ *          cmc_uncertainty: 0.5 },
+ *    ],
+ *  symbol: 'T',
+ *  unit: '°C',
+ * },
+ *
+ * <UncertaintyFormatter
+ * obProps = {ObjFormatter}
+ * fieldValue='ranges'
+ * fieldSymbol='symbol'
+ * fieldUnit='unit'
+ * color='text.primary'
+ * size='medium'
+ * variant='body'
+ * />
+ * ```
+ */
+export declare function UncertaintyFormatter<T extends React.ElementType = typeof UncertaintyFormatterRootStyled>(props: UncertaintyFormatterProps): import("react/jsx-runtime").JSX.Element;

package/components/formatters/UncertaintyFormatter/UncertaintyFormatter.js

@@ -0,0 +1,54 @@
+import { jsx, Fragment } from "react/jsx-runtime";
+import React, { useMemo } from "react";
+import { clsx } from "clsx";
+import { getPropertyByString } from "@m4l/core";
+import { U as UncertaintyFormatterRootStyled } from "./slots/UncertaintyFormatterSlots.js";
+import { g as getPropDataTestId } from "../../../test/getNameDataTestId.js";
+import { a as getComponentSlotRoot } from "../../../utils/getComponentSlotRoot.js";
+import { U as UNCERTAINTY_FORMATTER_KEY_COMPONENT } from "./constants.js";
+import { U as UncertaintyFormatterSlots } from "./slots/UncertaintyFormatterEnum.js";
+import { u as useComponentSize } from "../../../hooks/useComponentSize/useComponentSize.js";
+function getUncertaintyFormat(obProps, fieldValue, fieldSymbol, fieldUnit) {
+  let result = "";
+  const ranges = getPropertyByString(obProps, fieldValue);
+  const symbol = getPropertyByString(obProps, fieldSymbol);
+  const unit = getPropertyByString(obProps, fieldUnit);
+  if (ranges === void 0 || ranges === null || !Array.isArray(ranges) || typeof symbol !== "string" || typeof unit !== "string") {
+    return "[]";
+  }
+  ranges.map((obj, idx) => {
+    const cmc_min_closed = obj.cmc_min_closed !== true ? "<" : "≤";
+    const cmc_max_closed = obj.cmc_max_closed !== true ? "<" : "≤";
+    result = result.concat(
+      `${idx > 0 ? " " : ""}`,
+      obj.cmc_min !== obj.cmc_max ? `[${obj.cmc_min}${unit} ${cmc_min_closed} ${symbol} ${cmc_max_closed} ${obj.cmc_max}${unit} ± ${obj.cmc_uncertainty}]` : `[${obj.cmc_min}${unit} ± ${obj.cmc_uncertainty}]`
+    );
+  });
+  return result;
+}
+function UncertaintyFormatter(props) {
+  const { obProps, fieldValue, fieldSymbol, fieldUnit, Component = UncertaintyFormatterRootStyled, size = "medium", color, dataTestid, className } = props;
+  const { currentSize } = useComponentSize(size);
+  const formatterUncertainty = useMemo(
+    () => getUncertaintyFormat(obProps, fieldValue, fieldSymbol, fieldUnit),
+    [obProps, fieldValue, fieldSymbol, fieldUnit]
+  );
+  if (Component === React.Fragment) {
+    return /* @__PURE__ */ jsx(Fragment, { children: formatterUncertainty });
+  }
+  return /* @__PURE__ */ jsx(
+    Component,
+    {
+      size: currentSize,
+      variant: "body",
+      color,
+      className: clsx(getComponentSlotRoot(UNCERTAINTY_FORMATTER_KEY_COMPONENT), className),
+      ...getPropDataTestId(UNCERTAINTY_FORMATTER_KEY_COMPONENT, UncertaintyFormatterSlots.root, dataTestid),
+      children: formatterUncertainty
+    }
+  );
+}
+export {
+  UncertaintyFormatter as U,
+  getUncertaintyFormat as g
+};

package/components/formatters/UncertaintyFormatter/UncertaintyFormatter.styles.d.ts

@@ -0,0 +1,2 @@
+import { UncertaintyFormatterStyles } from './types';
+export declare const uncertaintyFormatterStyles: UncertaintyFormatterStyles;

package/components/formatters/UncertaintyFormatter/UncertaintyFormatter.styles.js

@@ -0,0 +1,11 @@
+const uncertaintyFormatterStyles = {
+  root: {
+    display: "flex",
+    flexDirection: "column",
+    justifyContent: "center",
+    alignItems: "flex-start"
+  }
+};
+export {
+  uncertaintyFormatterStyles as u
+};

package/components/formatters/UncertaintyFormatter/constants.d.ts

@@ -0,0 +1 @@
+export declare const UNCERTAINTY_FORMATTER_KEY_COMPONENT = "M4LUncertaintyFormatter";

package/components/formatters/UncertaintyFormatter/constants.js

@@ -0,0 +1,4 @@
+const UNCERTAINTY_FORMATTER_KEY_COMPONENT = "M4LUncertaintyFormatter";
+export {
+  UNCERTAINTY_FORMATTER_KEY_COMPONENT as U
+};

package/components/formatters/UncertaintyFormatter/slots/UncertaintyFormatterEnum.d.ts

@@ -0,0 +1,3 @@
+export declare enum UncertaintyFormatterSlots {
+    root = "root"
+}

package/components/formatters/UncertaintyFormatter/slots/UncertaintyFormatterEnum.js

@@ -0,0 +1,7 @@
+var UncertaintyFormatterSlots = /* @__PURE__ */ ((UncertaintyFormatterSlots2) => {
+  UncertaintyFormatterSlots2["root"] = "root";
+  return UncertaintyFormatterSlots2;
+})(UncertaintyFormatterSlots || {});
+export {
+  UncertaintyFormatterSlots as U
+};

package/components/formatters/UncertaintyFormatter/slots/UncertaintyFormatterSlots.d.ts

@@ -0,0 +1 @@
+export declare const UncertaintyFormatterRootStyled: import('@emotion/styled').StyledComponent<Pick<import('../../../mui_extended/Typography/types').TypographyProps, keyof import('../../../mui_extended/Typography/types').TypographyProps> & import('@mui/system').MUIStyledCommonProps<import('@mui/material/styles').Theme> & Record<string, unknown>, {}, {}>;

package/components/formatters/UncertaintyFormatter/slots/UncertaintyFormatterSlots.js

@@ -0,0 +1,12 @@
+import { styled } from "@mui/material/styles";
+import { U as UNCERTAINTY_FORMATTER_KEY_COMPONENT } from "../constants.js";
+import { u as uncertaintyFormatterStyles } from "../UncertaintyFormatter.styles.js";
+import { U as UncertaintyFormatterSlots } from "./UncertaintyFormatterEnum.js";
+import { T as Typography } from "../../../mui_extended/Typography/Typography.js";
+const UncertaintyFormatterRootStyled = styled(Typography, {
+  name: UNCERTAINTY_FORMATTER_KEY_COMPONENT,
+  slot: UncertaintyFormatterSlots.root
+})(uncertaintyFormatterStyles.root);
+export {
+  UncertaintyFormatterRootStyled as U
+};

package/components/formatters/UncertaintyFormatter/tests/UncertaintyFormatter.test.d.ts

@@ -0,0 +1 @@
+export {};

package/components/formatters/UncertaintyFormatter/types.d.ts

@@ -1,14 +1,58 @@
+import { Sizes } from '@m4l/styles';
+import { Theme } from '@mui/material';
+import { M4LOverridesStyleRules } from 'src/@types/augmentations';
+import { TypographyProps } from '../../mui_extended/Typography/types';
+import { UncertaintyFormatterSlots as Slots } from './slots/UncertaintyFormatterEnum';
+import { UNCERTAINTY_FORMATTER_KEY_COMPONENT } from './constants';
+/**
+ * Representa un rango de incertidumbre con límites y una incertidumbre asociada.
+ */
 export interface UncertaintyRange {
+    /**
+     * Indica si el límite inferior está cerrado (≤) o abierto (<).
+     */
     cmc_min_closed: boolean;
+    /**
+     * Valor mínimo del rango.
+     */
     cmc_min: number;
+    /**
+     * Indica si el límite superior está cerrado (≤) o abierto (<).
+     */
     cmc_max_closed: boolean;
+    /**
+     * Valor máximo del rango.
+     */
     cmc_max: number;
+    /**
+     * Incertidumbre asociada al rango.
+     */
     cmc_uncertainty: number;
 }
-export interface UncertaintyFormatterProps {
+export interface UncertaintyFormatterProps extends Pick<TypographyProps, 'color' | 'dataTestid' | 'className'> {
+    /**
+     * Componente personalizado que puede dar la presentación del formatter.
+     */
     Component?: React.ElementType;
+    /**
+     * Objeto de información que contine los valores que se van a utilizar en las propiedades fieldUnit y fieldValue.
+     */
     obProps: any;
+    /**
+     * Valor del campo que debe ser expresado en notación de cadena.
+     */
     fieldValue: string;
+    /**
+     * Valor del simbolo que debe ser expresado en notación de cadena.
+     */
     fieldSymbol: string;
+    /**
+     * Valor de la unidad de medida que debe ser expresado en notación de cadena.
+     */
     fieldUnit: string;
+    /**
+     * Tamaño del componente.
+     */
+    size?: Extract<Sizes, 'small' | 'medium'>;
 }
+export type UncertaintyFormatterStyles = M4LOverridesStyleRules<keyof typeof Slots, typeof UNCERTAINTY_FORMATTER_KEY_COMPONENT, Theme>;

package/components/formatters/index.d.ts

@@ -1,6 +1,6 @@
 export { BooleanFormatter } from './BooleanFormatter/BooleanFormatter';
 export { useFormatDate as getFormatDate, DateFormatter } from './DateFormatter/DateFormatter';
-export { UncertaintyFormatter, getUncertaintyFormat } from './UncertaintyFormatter';
+export { UncertaintyFormatter, getUncertaintyFormat } from './UncertaintyFormatter/UncertaintyFormatter';
 export { PointsFormatter, getFormatPoints } from './PointsFormatter/PointsFormatter';
 export { getFormatConcatenated, ConcatenatedFormatter } from './ConcatenatedFormatter/ConcatenatedFormatter';
 export { useFormatPeriod, PeriodFormatter } from './PeriodFormatter/PeriodFormatter';

package/index.js

@@ -43,7 +43,7 @@ import { R as R12 } from "./components/hook-form/RHFTextFieldPassword/RHFTextFie
 import { R as R13 } from "./components/hook-form/RHFUpload/RHFUploadImage/RHFUploadImage.js";
 import { B } from "./components/formatters/BooleanFormatter/BooleanFormatter.js";
 import { D as D2, u as u4 } from "./components/formatters/DateFormatter/DateFormatter.js";
-import { U, g as g7 } from "./components/formatters/UncertaintyFormatter/index.js";
+import { U, g as g7 } from "./components/formatters/UncertaintyFormatter/UncertaintyFormatter.js";
 import { P as P2, g as g8 } from "./components/formatters/PointsFormatter/PointsFormatter.js";
 import { C, g as g9 } from "./components/formatters/ConcatenatedFormatter/ConcatenatedFormatter.js";
 import { P as P3, u as u5 } from "./components/formatters/PeriodFormatter/PeriodFormatter.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@m4l/components",
-  "version": "9.1.76",
+  "version": "9.1.77",
   "license": "UNLICENSED",
   "lint-staged": {
     "*.{js,ts,tsx}": "eslint --fix --max-warnings 0"

package/components/formatters/UncertaintyFormatter/index.d.ts

@@ -1,9 +0,0 @@
-import { UncertaintyFormatterProps } from './types';
-/**
- * TODO: Documentar
- */
-export declare function getUncertaintyFormat(obProps: any, fieldValue: string, fieldSymbol: string, fieldUnit: string): string;
-/**
- * TODO: Documentar
- */
-export declare function UncertaintyFormatter(props: UncertaintyFormatterProps): import("react/jsx-runtime").JSX.Element;

package/components/formatters/UncertaintyFormatter/index.js

@@ -1,29 +0,0 @@
-import { jsx } from "react/jsx-runtime";
-import { getPropertyByString } from "@m4l/core";
-import { W as WrapperComponent } from "../../WrapperComponent/index.js";
-function getUncertaintyFormat(obProps, fieldValue, fieldSymbol, fieldUnit) {
-  let result = "";
-  const ranges = getPropertyByString(obProps, fieldValue);
-  const symbol = getPropertyByString(obProps, fieldSymbol);
-  const unit = getPropertyByString(obProps, fieldUnit);
-  if (ranges === void 0 || ranges === null || !Array.isArray(ranges) || typeof symbol !== "string" || typeof unit !== "string") {
-    return "[]";
-  }
-  ranges.map((obj, idx) => {
-    const cmc_min_closed = obj.cmc_min_closed !== true ? "<" : "≤";
-    const cmc_max_closed = obj.cmc_max_closed !== true ? "<" : "≤";
-    result = result.concat(
-      `${idx > 0 ? " " : ""}`,
-      obj.cmc_min !== obj.cmc_max ? `[${obj.cmc_min}${unit} ${cmc_min_closed} ${symbol} ${cmc_max_closed} ${obj.cmc_max}${unit} ± ${obj.cmc_uncertainty}]` : `[${obj.cmc_min}${unit} ± ${obj.cmc_uncertainty}]`
-    );
-  });
-  return result;
-}
-function UncertaintyFormatter(props) {
-  const { obProps, fieldValue, fieldSymbol, fieldUnit, Component = WrapperComponent } = props;
-  return /* @__PURE__ */ jsx(Component, { children: getUncertaintyFormat(obProps, fieldValue, fieldSymbol, fieldUnit) });
-}
-export {
-  UncertaintyFormatter as U,
-  getUncertaintyFormat as g
-};