@m4l/layouts 9.3.18 → 9.4.0-AQ20260114.beta.1

package/hooks/index.d.ts

@@ -4,3 +4,4 @@ export * from './useDynamicAccordions';
 export * from './useDynamicPaperForm';
 export * from './useNetworkActionConfirm';
 export * from './useFormAddEdit';
+export * from './useRefreshData';

package/hooks/useRefreshData/dictionary.d.ts

@@ -0,0 +1,4 @@
+export declare const USE_REFRESH_DATA_DICTIONARY: {
+    readonly TOAST_NEW_ROW_BUT_NOT_VISIBLE_TITLE: "refresh.toast_new_row_but_not_visible_title";
+    readonly TOAST_NEW_ROW_BUT_NOT_VISIBLE_DESCRIPTION: "refresh.toast_new_row_but_not_visible_description";
+};

package/hooks/useRefreshData/dictionary.js

@@ -0,0 +1,7 @@
+const USE_REFRESH_DATA_DICTIONARY = {
+  TOAST_NEW_ROW_BUT_NOT_VISIBLE_TITLE: "refresh.toast_new_row_but_not_visible_title",
+  TOAST_NEW_ROW_BUT_NOT_VISIBLE_DESCRIPTION: "refresh.toast_new_row_but_not_visible_description"
+};
+export {
+  USE_REFRESH_DATA_DICTIONARY as U
+};

package/hooks/useRefreshData/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useRefreshData';
+export type { UseRefreshData } from './types';

package/hooks/useRefreshData/index.js

@@ -0,0 +1 @@
+

package/hooks/useRefreshData/types.d.ts

@@ -0,0 +1,35 @@
+import { GetLabelType } from '@m4l/core';
+export interface UseRefreshData<TRow> {
+    /**
+     * Function to refresh the data
+     */
+    refreshPaginate: () => void;
+    /**
+     * Rows to refresh
+     */
+    rows: TRow[];
+    /**
+     * Function to get the label
+     */
+    getLabel: GetLabelType;
+}
+/**
+ * fieldValue with generic that allow to use nested attributes from a interface or object
+ * example: 'fieldValue' = 'object.field1.field2'
+ */
+export type DeepKeyOf<TRow> = TRow extends object ? {
+    [Key in keyof TRow & string]: NonNullable<TRow[Key]> extends object ? Key | `${Key}.${DeepKeyOf<NonNullable<TRow[Key]>>}` : Key;
+}[keyof TRow & string] : never;
+/**
+ * Interface to trigger the refresh when a specific attribute is equal to a specific value
+ */
+export interface TriggerRefreshWhen<TRow> {
+    /**
+     * Attribute to check if it is equal to the value
+     */
+    attribute: DeepKeyOf<TRow>;
+    /**
+     * Value to compare with the attribute
+     */
+    equals: string | number | boolean;
+}

package/hooks/useRefreshData/useRefreshData.d.ts

@@ -0,0 +1,12 @@
+import { RowKey } from '@m4l/components';
+import { TriggerRefreshWhen, UseRefreshData } from './types';
+/**
+ * Hook that manages the refresh of the data and the selected rows.
+ * Note: This hook could be use in every module that needs to refresh the data and the selected rows.
+ */
+export declare const useRefreshData: <TRow>(useRefreshDataProps: UseRefreshData<TRow>) => {
+    refresh: (rowParam?: TRow | RowKey, triggerSelectedRowWhen?: TriggerRefreshWhen<TRow>) => void;
+    onSelectedRowsChange: (newRowsSelectSet: ReadonlySet<RowKey>) => void;
+    selectedRows: ReadonlySet<RowKey>;
+    focusOnRowKey: RowKey | undefined;
+};

package/hooks/useRefreshData/useRefreshData.js

@@ -0,0 +1,56 @@
+import { useState, useEffect, useCallback } from "react";
+import { getDataGridRowsFromSet } from "@m4l/components";
+import { useHostTools } from "@m4l/core";
+import { u as useMasterDetail } from "../useMasterDetail/index.js";
+import { U as USE_REFRESH_DATA_DICTIONARY } from "./dictionary.js";
+const useRefreshData = (useRefreshDataProps) => {
+  const { rows, refreshPaginate, getLabel } = useRefreshDataProps;
+  const { toast } = useHostTools();
+  const { onChangeMasterSelection } = useMasterDetail();
+  const [validateShowRowCreate, setValidateShowRowCreate] = useState({ show: false, idRow: void 0 });
+  const [selectedRows, setSelectedRows] = useState(/* @__PURE__ */ new Set());
+  const [focusOnRowKey, setFocusOnRowKey] = useState(void 0);
+  const onSelectedRowsChange = (newRowsSelectSet) => {
+    setSelectedRows(newRowsSelectSet);
+    onChangeMasterSelection(getDataGridRowsFromSet(newRowsSelectSet, rows, (row) => row?.id));
+  };
+  useEffect(() => {
+    if (selectedRows.size > 0) {
+      onChangeMasterSelection(getDataGridRowsFromSet(selectedRows, rows, (row) => row?.id));
+    }
+  }, [rows]);
+  useEffect(() => {
+    if (validateShowRowCreate.show) {
+      const existRowSelected = rows.some((row) => selectedRows.has(row?.id));
+      if (!existRowSelected && validateShowRowCreate.idRow) {
+        setSelectedRows?.(/* @__PURE__ */ new Set());
+        toast({
+          title: getLabel(USE_REFRESH_DATA_DICTIONARY.TOAST_NEW_ROW_BUT_NOT_VISIBLE_TITLE),
+          description: getLabel(USE_REFRESH_DATA_DICTIONARY.TOAST_NEW_ROW_BUT_NOT_VISIBLE_DESCRIPTION, validateShowRowCreate.idRow)
+        }, { type: "info" });
+      }
+    }
+  }, [rows]);
+  const getRowKey = useCallback((rowParam) => {
+    if (typeof rowParam === "string" || typeof rowParam === "number") {
+      return rowParam;
+    }
+    if (typeof rowParam === "object" && rowParam !== null && "id" in rowParam && (typeof rowParam?.id === "string" || typeof rowParam?.id === "number")) {
+      return rowParam?.id;
+    }
+    return void 0;
+  }, []);
+  const refresh = useCallback((rowParam, triggerSelectedRowWhen) => {
+    const idRow = getRowKey(rowParam);
+    setFocusOnRowKey(idRow);
+    setValidateShowRowCreate({ show: idRow !== void 0, idRow });
+    if (idRow !== void 0 && triggerSelectedRowWhen && typeof rowParam === "object" && Object.prototype.hasOwnProperty.call(rowParam, triggerSelectedRowWhen.attribute) && rowParam[triggerSelectedRowWhen.attribute] === triggerSelectedRowWhen.equals) {
+      setSelectedRows(/* @__PURE__ */ new Set([idRow]));
+    }
+    refreshPaginate();
+  }, [refreshPaginate, setSelectedRows, getRowKey]);
+  return { refresh, onSelectedRowsChange, selectedRows, focusOnRowKey };
+};
+export {
+  useRefreshData as u
+};

package/hooks/useRefreshData/useRefreshData.test.d.ts

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

package/index.js

@@ -15,6 +15,7 @@ import { u as u3 } from "./hooks/useDynamicAccordions/useDynamicAccordions.js";
 import { c, u as u4 } from "./hooks/useDynamicPaperForm/useDynamicPaperForm.js";
 import { u as u5 } from "./hooks/useNetworkActionConfirm/useNetworkActionConfirm.js";
 import { u as u6 } from "./hooks/useFormAddEdit/useFormAddEdit.js";
+import { u as u7 } from "./hooks/useRefreshData/useRefreshData.js";
 import { c as c2 } from "./utils/createAppMF.js";
 export {
   D as DynamicTabs,
@@ -36,5 +37,6 @@ export {
   u6 as useFormAddEdit,
   u as useMasterDetail,
   u2 as useModule,
-  u5 as useNetworkActionConfirm
+  u5 as useNetworkActionConfirm,
+  u7 as useRefreshData
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@m4l/layouts",
-  "version": "9.3.18",
+  "version": "9.4.0-AQ20260114.beta.1",
   "license": "UNLICENSED",
   "author": "M4L Team",
   "lint-staged": {