@m4l/components 9.1.75 → 9.1.76

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

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

package/components/formatters/PriceFormatter/PriceFormatter.d.ts

@@ -0,0 +1,43 @@
+import { default as React } from 'react';
+import { PriceFormatterProps } from './types';
+import { PriceFormatterRootStyled } from './slots/PriceFormatterSlots';
+/**
+ * Formatea un valor numérico como un precio en una moneda específica.
+ * @param {any} obProps - El objeto que contiene las propiedades.
+ * @param {string} fieldValue - El nombre de la propiedad dentro de obProps que contiene el valor a formatear.
+ * @param {string} currency - El código de la moneda (por ejemplo, 'USD' para dólares estadounidenses).
+ * @param {number} decimalDigits - La cantidad de dígitos decimales a mostrar.
+ * @returns {string} - El valor formateado como un precio en la moneda especificada.
+ *  @example
+ * ```
+ * const obProps = { price: '1234.56' };
+ * const formattedPrice = getFormatPrice(obProps, 'price', 'USD', 2);
+ * console.log(formattedPrice); // "$1,234.56" (suponiendo que el idioma del navegador es 'en-US')
+ *
+ * const formattedPriceEUR = getFormatPrice(obProps, 'price', 'EUR', 2);
+ * console.log(formattedPriceEUR); // "1.234,56 €" (suponiendo que el idioma del navegador es 'es-ES')
+ * ```
+ */
+export declare function getFormatPrice(obProps: any, fieldValue: string, currency: string, decimalDigits: number): string;
+/**
+ * El `PriceFormatter` es un componente de presentación diseñado para mostrar valores monetarios en el formato correcto según la configuración del sistema.
+ * Este componente asegura que los valores se representen en la divisa esperada, respetando las configuraciones de idioma, número de decimales y estilo visual definidos.
+ * @param {PriceFormatterProps} props - Las propiedades del componente.
+ * @returns {JSX.Element} - El componente `PriceFormatter` renderizado.
+ * @example
+ * ```
+ * import React from 'react';
+ * import { PriceFormatter } from './PriceFormatter';
+ *
+ * const obProps = { price: '1234.56' };
+ *
+ * function App() {
+ *   return (
+ *     <PriceFormatter obProps={obProps} fieldValue="price" size="medium" variant="body" />
+ *   );
+ * }
+ *
+ * export default App;
+ * ```
+ */
+export declare function PriceFormatter<T extends React.ElementType = typeof PriceFormatterRootStyled>(props: PriceFormatterProps): JSX.Element;

package/components/formatters/PriceFormatter/PriceFormatter.js

@@ -0,0 +1,69 @@
+import { jsx, Fragment } from "react/jsx-runtime";
+import React, { useMemo } from "react";
+import { clsx } from "clsx";
+import { getPropertyByString } from "@m4l/core";
+import { useFormatter } from "@m4l/graphics";
+import { a as getComponentSlotRoot } from "../../../utils/getComponentSlotRoot.js";
+import { g as getPropDataTestId } from "../../../test/getNameDataTestId.js";
+import { P as PriceFormatterRootStyled } from "./slots/PriceFormatterSlots.js";
+import { P as PRICE_FORMATTER_KEY_COMPONENT } from "./constants.js";
+import { P as PriceFormatterSlots } from "./slots/PriceFormatterEnum.js";
+import { u as useComponentSize } from "../../../hooks/useComponentSize/useComponentSize.js";
+function getFormatPrice(obProps, fieldValue, currency, decimalDigits) {
+  let result = "";
+  const value = getPropertyByString(obProps, fieldValue);
+  if (isNaN(Number(value))) {
+    return Number("").toLocaleString(navigator.language, {
+      currency,
+      style: "currency",
+      currencyDisplay: "symbol",
+      useGrouping: true,
+      maximumFractionDigits: decimalDigits
+    });
+  }
+  try {
+    result = Number(value).toLocaleString(navigator.language, {
+      currency,
+      style: "currency",
+      currencyDisplay: "symbol",
+      useGrouping: true,
+      maximumFractionDigits: decimalDigits
+    }) || "";
+  } catch (_e) {
+    result = Number(value).toLocaleString("en-US", {
+      style: "currency",
+      currency: "USD",
+      currencyDisplay: "symbol",
+      useGrouping: true,
+      maximumFractionDigits: decimalDigits
+    }) || "";
+  }
+  return result;
+}
+function PriceFormatter(props) {
+  const { obProps, fieldValue, Component = PriceFormatterRootStyled, size = "medium", color, dataTestid, className } = props;
+  const { currentSize } = useComponentSize(size);
+  const { currencyFormatter } = useFormatter();
+  const formatterPrice = useMemo(
+    () => getFormatPrice(obProps, fieldValue, currencyFormatter.code, currencyFormatter.decimalDigits),
+    [obProps, fieldValue, currencyFormatter.code, currencyFormatter.decimalDigits]
+  );
+  if (Component === React.Fragment) {
+    return /* @__PURE__ */ jsx(Fragment, { children: formatterPrice });
+  }
+  return /* @__PURE__ */ jsx(
+    Component,
+    {
+      variant: "body",
+      size: currentSize,
+      color,
+      className: clsx(getComponentSlotRoot(PRICE_FORMATTER_KEY_COMPONENT), className),
+      ...getPropDataTestId(PRICE_FORMATTER_KEY_COMPONENT, PriceFormatterSlots.root, dataTestid),
+      children: formatterPrice
+    }
+  );
+}
+export {
+  PriceFormatter as P,
+  getFormatPrice as g
+};

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

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

package/components/formatters/PriceFormatter/PriceFormatter.styles.js

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

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

@@ -0,0 +1 @@
+export declare const PRICE_FORMATTER_KEY_COMPONENT = "M4LPriceFormatter";

package/components/formatters/PriceFormatter/constants.js

@@ -0,0 +1,4 @@
+const PRICE_FORMATTER_KEY_COMPONENT = "M4LPriceFormatter";
+export {
+  PRICE_FORMATTER_KEY_COMPONENT as P
+};

package/components/formatters/PriceFormatter/slots/PriceFormatterEnum.d.ts

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

package/components/formatters/PriceFormatter/slots/PriceFormatterEnum.js

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

package/components/formatters/PriceFormatter/slots/PriceFormatterSlots.d.ts

@@ -0,0 +1 @@
+export declare const PriceFormatterRootStyled: 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').Theme> & Record<string, unknown>, {}, {}>;

package/components/formatters/PriceFormatter/slots/PriceFormatterSlots.js

@@ -0,0 +1,12 @@
+import { styled } from "@mui/material";
+import { P as PRICE_FORMATTER_KEY_COMPONENT } from "../constants.js";
+import { p as priceFormatterStyles } from "../PriceFormatter.styles.js";
+import { P as PriceFormatterSlots } from "./PriceFormatterEnum.js";
+import { T as Typography } from "../../../mui_extended/Typography/Typography.js";
+const PriceFormatterRootStyled = styled(Typography, {
+  name: PRICE_FORMATTER_KEY_COMPONENT,
+  slot: PriceFormatterSlots.root
+})(priceFormatterStyles?.root);
+export {
+  PriceFormatterRootStyled as P
+};

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

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

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

@@ -1,5 +1,25 @@
-export interface PriceFormatterProps {
+import { Theme } from '@mui/material';
+import { Sizes } from '@m4l/styles';
+import { M4LOverridesStyleRules } from 'src/@types/augmentations';
+import { TypographyProps } from '../../mui_extended/Typography/types';
+import { PriceFormatterSlots } from './slots/PriceFormatterEnum';
+import { PRICE_FORMATTER_KEY_COMPONENT } from './constants';
+export interface PriceFormatterProps 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 la propiedad price.
+     */
     obProps: any;
+    /**
+     * Valor del campo que debe ser expresado en notación de cadena.
+     */
     fieldValue: string;
+    /**
+     * Tamaño del componente.
+     */
+    size?: Extract<Sizes, 'small' | 'medium'>;
 }
+export type PriceFormatterStyles = M4LOverridesStyleRules<keyof typeof PriceFormatterSlots, typeof PRICE_FORMATTER_KEY_COMPONENT, Theme>;

package/components/formatters/index.d.ts

@@ -4,6 +4,6 @@ export { UncertaintyFormatter, getUncertaintyFormat } from './UncertaintyFormatt
 export { PointsFormatter, getFormatPoints } from './PointsFormatter/PointsFormatter';
 export { getFormatConcatenated, ConcatenatedFormatter } from './ConcatenatedFormatter/ConcatenatedFormatter';
 export { useFormatPeriod, PeriodFormatter } from './PeriodFormatter/PeriodFormatter';
-export { PriceFormatter, getFormatPrice } from './PriceFormatter';
+export { PriceFormatter, getFormatPrice } from './PriceFormatter/PriceFormatter';
 export * from './DistanceToNowFormatter';
 export type { UncertaintyRange } from './UncertaintyFormatter/types';

package/index.js

@@ -47,7 +47,7 @@ import { U, g as g7 } from "./components/formatters/UncertaintyFormatter/index.j
 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";
-import { P as P4, g as g10 } from "./components/formatters/PriceFormatter/index.js";
+import { P as P4, g as g10 } from "./components/formatters/PriceFormatter/PriceFormatter.js";
 import { g as g11 } from "./components/formatters/DistanceToNowFormatter/dictionary.js";
 import { D as D3 } from "./components/formatters/DistanceToNowFormatter/DistanceToNowFormatter.js";
 import { g as g12 } from "./components/formatters/dictionary.js";

package/package.json

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

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

@@ -1,9 +0,0 @@
-import { PriceFormatterProps } from './types';
-/**
- * TODO: Documentar
- */
-export declare function getFormatPrice(obProps: any, fieldValue: string, currency: string, decimalDigits: number): string;
-/**
- * TODO: Documentar
- */
-export declare function PriceFormatter(props: PriceFormatterProps): import("react/jsx-runtime").JSX.Element;

package/components/formatters/PriceFormatter/index.js

@@ -1,35 +0,0 @@
-import { jsx } from "react/jsx-runtime";
-import { getPropertyByString } from "@m4l/core";
-import { useFormatter } from "@m4l/graphics";
-import { W as WrapperComponent } from "../../WrapperComponent/index.js";
-function getFormatPrice(obProps, fieldValue, currency, decimalDigits) {
-  let result = "";
-  const value = getPropertyByString(obProps, fieldValue);
-  try {
-    result = Number(value).toLocaleString(navigator.language, {
-      currency,
-      style: "currency",
-      currencyDisplay: "symbol",
-      useGrouping: true,
-      maximumFractionDigits: decimalDigits
-    }) || "";
-  } catch (_e) {
-    result = Number(value).toLocaleString("en-US", {
-      style: "currency",
-      currency: "USD",
-      currencyDisplay: "symbol",
-      useGrouping: true,
-      maximumFractionDigits: decimalDigits
-    }) || "";
-  }
-  return result;
-}
-function PriceFormatter(props) {
-  const { obProps, fieldValue, Component = WrapperComponent } = props;
-  const { currencyFormatter } = useFormatter();
-  return /* @__PURE__ */ jsx(Component, { children: getFormatPrice(obProps, fieldValue, currencyFormatter.code, currencyFormatter.decimalDigits) });
-}
-export {
-  PriceFormatter as P,
-  getFormatPrice as g
-};