@multiplatform.one/backoffice 6.4.3 → 6.7.0

package/dist/cjs/report/DoctypeReportView.cjs

@@ -0,0 +1,430 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all) __defProp(target, name, {
+    get: all[name],
+    enumerable: true
+  });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from)) if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+      get: () => from[key],
+      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+    });
+  }
+  return to;
+};
+var __toCommonJS = mod => __copyProps(__defProp({}, "__esModule", {
+  value: true
+}), mod);
+var DoctypeReportView_exports = {};
+__export(DoctypeReportView_exports, {
+  DoctypeReportView: () => DoctypeReportView
+});
+module.exports = __toCommonJS(DoctypeReportView_exports);
+var import_components = require("@multiplatform.one/components");
+var import_forms = require("@multiplatform.one/forms");
+var import_frappe = require("@multiplatform.one/frappe");
+var import_platform = require("@multiplatform.one/platform");
+var import_store = require("@multiplatform.one/store");
+var import_table = require("@multiplatform.one/table");
+var import_react = require("react");
+var import_react_i18next = require("react-i18next");
+var import_BackofficeProvider = require("../config/BackofficeProvider.cjs");
+var import_i18n = require("../i18n/index.cjs");
+var import_useDoctypeMeta = require("../shared/useDoctypeMeta.cjs");
+var import_connection = require("../views/connection.cjs");
+var import_ViewStates = require("../views/ViewStates.cjs");
+var import_report_grid = require("./report-grid.cjs");
+var import_report_toolbar = require("./report-toolbar.cjs");
+var import_savedReports = require("./savedReports.cjs");
+var import_reportViewModel = require("./reportViewModel.cjs");
+var import_jsx_runtime = require("react/jsx-runtime");
+const EMPTY_FILTERS = [];
+const COLUMN_FILTER_DEBOUNCE_MS = 350;
+function columnsStorageKey(doctype) {
+  return `backoffice.report.columns.${doctype}`;
+}
+async function readStoredColumns(doctype) {
+  try {
+    const raw = await Promise.resolve(import_store.storage.getItem(columnsStorageKey(doctype)));
+    if (!raw) return void 0;
+    const parsed = JSON.parse(raw);
+    if (Array.isArray(parsed) && parsed.every(entry => typeof entry === "string")) {
+      return parsed;
+    }
+  } catch {}
+  return void 0;
+}
+function persistStoredColumns(doctype, fieldnames) {
+  try {
+    void Promise.resolve(import_store.storage.setItem(columnsStorageKey(doctype), JSON.stringify(fieldnames)));
+  } catch {}
+}
+function DoctypeReportView({
+  doctype,
+  filtersParam,
+  initialFilters
+}) {
+  const {
+    t
+  } = (0, import_react_i18next.useTranslation)(import_i18n.BACKOFFICE_I18N_NAMESPACE);
+  const navigator = (0, import_BackofficeProvider.useBackofficeNavigator)();
+  const paths = (0, import_BackofficeProvider.useBackofficePaths)();
+  const {
+    params
+  } = (0, import_BackofficeProvider.useBackofficeLocation)();
+  const connection = (0, import_connection.useViewConnection)();
+  const fixtureMode = Boolean(connection?.fixtures);
+  const {
+    meta,
+    loading: metaLoading,
+    error: metaError
+  } = (0, import_useDoctypeMeta.useDoctypeMeta)(doctype);
+  const savedReports = (0, import_savedReports.useSavedReports)(doctype);
+  const rawReportParam = typeof params.report === "string" ? params.report : params.report?.[0];
+  const currentReport = (0, import_react.useMemo)(() => {
+    if (!rawReportParam) return null;
+    try {
+      return decodeURIComponent(rawReportParam);
+    } catch {
+      return rawReportParam;
+    }
+  }, [rawReportParam]);
+  const allColumns = (0, import_react.useMemo)(() => (0, import_reportViewModel.reportColumnsFromMeta)(meta), [meta]);
+  const defaultFieldnames = (0, import_react.useMemo)(() => (0, import_reportViewModel.defaultReportFieldnames)(meta), [meta]);
+  const [storedColumns, setStoredColumns] = (0, import_react.useState)(void 0);
+  const [selectedOverride, setSelectedOverride] = (0, import_react.useState)(null);
+  (0, import_react.useEffect)(() => {
+    if (fixtureMode) return;
+    let cancelled = false;
+    void readStoredColumns(doctype).then(stored => {
+      if (!cancelled) setStoredColumns(stored);
+    });
+    return () => {
+      cancelled = true;
+    };
+  }, [doctype, fixtureMode]);
+  const selectedFieldnames = selectedOverride ?? storedColumns ?? defaultFieldnames;
+  const selectedColumns = (0, import_react.useMemo)(() => (0, import_reportViewModel.resolveSelectedColumns)(allColumns, selectedFieldnames), [allColumns, selectedFieldnames]);
+  const urlFilters = (0, import_react.useMemo)(() => (0, import_reportViewModel.parseReportFiltersParam)(filtersParam), [filtersParam]);
+  const [filtersCleared, setFiltersCleared] = (0, import_react.useState)(false);
+  const [reportFilters, setReportFilters] = (0, import_react.useState)(null);
+  const baseFilters = filtersCleared ? EMPTY_FILTERS : reportFilters ?? urlFilters ?? initialFilters ?? EMPTY_FILTERS;
+  const [filterDrafts, setFilterDrafts] = (0, import_react.useState)({});
+  const [committedFilters, setCommittedFilters] = (0, import_react.useState)({});
+  (0, import_react.useEffect)(() => {
+    const handle = setTimeout(() => {
+      setCommittedFilters(previous => JSON.stringify(previous) === JSON.stringify(filterDrafts) ? previous : filterDrafts);
+    }, COLUMN_FILTER_DEBOUNCE_MS);
+    return () => clearTimeout(handle);
+  }, [filterDrafts]);
+  const columnTuples = (0, import_react.useMemo)(() => (0, import_reportViewModel.columnFilterTuples)(selectedColumns, committedFilters), [selectedColumns, committedFilters]);
+  const effectiveFilters = (0, import_react.useMemo)(() => [...baseFilters, ...columnTuples], [baseFilters, columnTuples]);
+  const metaSort = (0, import_react.useMemo)(() => ({
+    field: (meta?.sort_field || "modified").split(" ")[0],
+    order: (meta?.sort_order || "DESC").toLowerCase() === "asc" ? "asc" : "desc"
+  }), [meta?.sort_field, meta?.sort_order]);
+  const [sortOverride, setSortOverride] = (0, import_react.useState)(null);
+  const sort = sortOverride ?? metaSort;
+  const [groupBy, setGroupBy] = (0, import_react.useState)(null);
+  const [pageSize, setPageSize] = (0, import_react.useState)(import_reportViewModel.DEFAULT_REPORT_PAGE_SIZE);
+  const [page, setPage] = (0, import_react.useState)(0);
+  (0, import_react.useEffect)(() => {
+    setSelectedOverride(null);
+    setStoredColumns(void 0);
+    setSortOverride(null);
+    setGroupBy(null);
+    setPage(0);
+    setPageSize(import_reportViewModel.DEFAULT_REPORT_PAGE_SIZE);
+    setFilterDrafts({});
+    setCommittedFilters({});
+    setFiltersCleared(false);
+    setReportFilters(null);
+  }, [doctype]);
+  (0, import_react.useEffect)(() => setFiltersCleared(false), [filtersParam]);
+  const filtersKey = (0, import_react.useMemo)(() => JSON.stringify(effectiveFilters), [effectiveFilters]);
+  (0, import_react.useEffect)(() => {
+    setPage(0);
+  }, [filtersKey, pageSize, groupBy]);
+  (0, import_react.useEffect)(() => {
+    if (!currentReport) {
+      setReportFilters(null);
+      return;
+    }
+    let cancelled = false;
+    void savedReports.load(currentReport).then(config => {
+      if (cancelled || !config) return;
+      setSelectedOverride(config.fieldnames.length > 0 ? config.fieldnames : null);
+      setReportFilters(config.filters);
+      setFilterDrafts({});
+      setCommittedFilters({});
+      setFiltersCleared(false);
+      if (config.sort) setSortOverride(config.sort);
+      if (config.pageSize && import_reportViewModel.REPORT_PAGE_SIZES.some(size => size === config.pageSize)) {
+        setPageSize(config.pageSize);
+      }
+      setGroupBy(config.groupBy ?? null);
+    });
+    return () => {
+      cancelled = true;
+    };
+  }, [currentReport, doctype]);
+  const handleToggleColumn = (0, import_react.useCallback)(fieldname => {
+    setSelectedOverride(previous => {
+      const current = previous ?? storedColumns ?? defaultFieldnames;
+      const next = current.includes(fieldname) ? current.length === 1 ? current : current.filter(entry => entry !== fieldname) : [...current, fieldname];
+      if (!fixtureMode && !currentReport) persistStoredColumns(doctype, next);
+      return next;
+    });
+  }, [storedColumns, defaultFieldnames, fixtureMode, currentReport, doctype]);
+  const handleResetColumns = (0, import_react.useCallback)(() => {
+    setSelectedOverride(defaultFieldnames);
+    setStoredColumns(void 0);
+    if (!fixtureMode) persistStoredColumns(doctype, defaultFieldnames);
+  }, [defaultFieldnames, fixtureMode, doctype]);
+  const fetchFields = (0, import_react.useMemo)(() => {
+    const fields = /* @__PURE__ */new Set(["name", sort.field]);
+    for (const column of selectedColumns) fields.add(column.fieldname);
+    if (groupBy) fields.add(groupBy);
+    return [...fields];
+  }, [selectedColumns, sort.field, groupBy]);
+  const [syncError, setSyncError] = (0, import_react.useState)(null);
+  const handleSyncError = (0, import_react.useCallback)(error => {
+    setSyncError(error instanceof Error ? error : new Error(String(error)));
+  }, []);
+  const [retryGen, setRetryGen] = (0, import_react.useState)(0);
+  const collectionConfig = (0, import_react.useMemo)(() => connection && meta && retryGen >= 0 ? connection : void 0, [connection, meta, retryGen]);
+  const collection = (0, import_frappe.useFrappeCollection)(collectionConfig, doctype, {
+    fields: fetchFields,
+    filters: effectiveFilters,
+    orderBy: {
+      field: sort.field,
+      order: sort.order === "asc" ? import_frappe.Order.Asc : import_frappe.Order.Desc
+    },
+    onSyncError: handleSyncError
+  });
+  (0, import_react.useEffect)(() => setSyncError(null), [collection]);
+  const {
+    data: rowsData,
+    isLoading: rowsLoading
+  } = (0, import_frappe.useLiveQuery)(q => collection ? q.from({
+    _report: collection
+  }) : null, [collection]);
+  const orderedRows = (0, import_react.useMemo)(() => (0, import_reportViewModel.orderReportRows)(rowsData ?? [], sort, groupBy), [rowsData, sort, groupBy]);
+  const total = orderedRows.length;
+  const pageCount = Math.max(1, Math.ceil(total / pageSize));
+  const effectivePage = Math.min(page, pageCount - 1);
+  const gridRows = (0, import_react.useMemo)(() => (0, import_reportViewModel.buildGridRows)(orderedRows, effectivePage * pageSize, pageSize, groupBy), [orderedRows, effectivePage, pageSize, groupBy]);
+  const totals = (0, import_react.useMemo)(() => (0, import_reportViewModel.computeTotals)(selectedColumns, orderedRows), [selectedColumns, orderedRows]);
+  const groupByColumn = groupBy ? allColumns.find(column => column.fieldname === groupBy) : void 0;
+  const handleOpenRow = (0, import_react.useCallback)(name => navigator.navigate(paths.form(doctype, name)), [navigator, paths, doctype]);
+  const handleOpenLink = (0, import_react.useCallback)((targetDoctype, name) => navigator.navigate(paths.form(targetDoctype, name)), [navigator, paths]);
+  const handleSelectReport = (0, import_react.useCallback)(name => {
+    const base = paths.view(doctype, "report");
+    navigator.replace(name ? `${base}?report=${encodeURIComponent(name)}` : base);
+    if (!name) {
+      setReportFilters(null);
+      setSelectedOverride(null);
+      setSortOverride(null);
+      setGroupBy(null);
+    }
+  }, [navigator, paths, doctype]);
+  const handleClearBaseFilters = (0, import_react.useCallback)(() => {
+    setFiltersCleared(true);
+    if (urlFilters && !reportFilters) navigator.replace(paths.view(doctype, "report"));
+  }, [urlFilters, reportFilters, navigator, paths, doctype]);
+  const handleSaveReport = (0, import_react.useCallback)(name => {
+    void savedReports.save(name, {
+      fieldnames: [...selectedFieldnames],
+      filters: effectiveFilters,
+      sort,
+      pageSize,
+      groupBy,
+      addTotals: totals.length > 0
+    }).then(savedName => {
+      (0, import_components.notify)({
+        severity: "success",
+        scope: "page",
+        body: t("report.saveDone", {
+          defaultValue: "Saved report \u201C{{name}}\u201D",
+          name: savedName
+        })
+      });
+      if (savedName !== currentReport) handleSelectReport(savedName);
+    }).catch(error => {
+      (0, import_components.notify)({
+        severity: "error",
+        scope: "page",
+        body: error instanceof Error ? error.message : t("report.saveFailed", "Could not save the report")
+      });
+    });
+  }, [savedReports, selectedFieldnames, effectiveFilters, sort, pageSize, groupBy, totals.length, currentReport, handleSelectReport, t]);
+  const handleDeleteReport = (0, import_react.useCallback)(name => {
+    void savedReports.remove(name).then(() => {
+      (0, import_components.notify)({
+        severity: "success",
+        scope: "page",
+        body: t("report.deleteDone", {
+          defaultValue: "Deleted report \u201C{{name}}\u201D",
+          name
+        })
+      });
+      if (name === currentReport) handleSelectReport(null);
+    }).catch(error => {
+      (0, import_components.notify)({
+        severity: "error",
+        scope: "page",
+        body: error instanceof Error ? error.message : t("report.deleteFailed", "Could not delete the report")
+      });
+    });
+  }, [savedReports, currentReport, handleSelectReport, t]);
+  const handleExport = (0, import_react.useCallback)(() => {
+    if (!import_components.isWeb) {
+      (0, import_components.notify)({
+        severity: "warning",
+        scope: "page",
+        body: t("report.exportUnsupported", "CSV export needs a browser download \u2014 not available on this platform yet")
+      });
+      return;
+    }
+    (0, import_platform.downloadBlob)(new Blob([(0, import_reportViewModel.buildReportCsv)(selectedColumns, orderedRows)], {
+      type: "text/csv;charset=utf-8;"
+    }), `${doctype}_report.csv`);
+    (0, import_components.notify)({
+      severity: "success",
+      scope: "page",
+      body: t("report.exportDone", {
+        count: orderedRows.length,
+        defaultValue_one: "Exported {{count}} row to CSV",
+        defaultValue_other: "Exported {{count}} rows to CSV"
+      })
+    });
+  }, [selectedColumns, orderedRows, doctype, t]);
+  const handleColumnFilterChange = (0, import_react.useCallback)((fieldname, value) => {
+    setFilterDrafts(previous => {
+      if (value === "") {
+        if (!(fieldname in previous)) return previous;
+        const {
+          [fieldname]: _dropped,
+          ...rest
+        } = previous;
+        return rest;
+      }
+      return {
+        ...previous,
+        [fieldname]: value
+      };
+    });
+  }, []);
+  const handleClearColumnFilters = (0, import_react.useCallback)(() => {
+    setFilterDrafts({});
+    setCommittedFilters({});
+  }, []);
+  const activeColumnFilterCount = columnTuples.length;
+  if (metaLoading && !meta) return /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_ViewStates.ViewLoading, {});
+  if (metaError && !meta) return /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_ViewStates.ViewError, {
+    doctype,
+    error: metaError
+  });
+  let body;
+  if (syncError) {
+    body = /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_components.EmptyState, {
+      intent: "error",
+      title: t("report.loadFailed", "Couldn't load report rows"),
+      description: syncError.message,
+      action: /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_forms.Button, {
+        size: "$3",
+        onPress: () => {
+          setSyncError(null);
+          setRetryGen(generation => generation + 1);
+        },
+        children: t("report.retry", "Retry")
+      })
+    });
+  } else if (rowsLoading && total === 0) {
+    body = /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_ViewStates.ViewLoading, {});
+  } else if (total === 0) {
+    const hasFilters = effectiveFilters.length > 0;
+    body = /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_components.EmptyState, {
+      title: t("report.emptyTitle", "No results"),
+      description: hasFilters ? t("report.emptyFiltered", "No rows match the current filters") : t("report.emptyDescription", {
+        defaultValue: "There are no {{doctype}} records yet",
+        doctype
+      }),
+      action: hasFilters ? /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_forms.Button, {
+        size: "$3",
+        onPress: () => {
+          handleClearColumnFilters();
+          handleClearBaseFilters();
+        },
+        children: t("report.clearAllFilters", "Clear all filters")
+      }) : void 0
+    });
+  } else {
+    body = /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_report_grid.ReportGrid, {
+      columns: selectedColumns,
+      rows: gridRows,
+      sort,
+      onSortChange: setSortOverride,
+      columnFilters: filterDrafts,
+      onColumnFilterChange: handleColumnFilterChange,
+      onOpenRow: handleOpenRow,
+      onOpenLink: handleOpenLink,
+      totals,
+      groupByColumn
+    });
+  }
+  const content = /* @__PURE__ */(0, import_jsx_runtime.jsxs)(import_components.YStack, {
+    flex: 1,
+    minWidth: 0,
+    children: [/* @__PURE__ */(0, import_jsx_runtime.jsx)(import_report_toolbar.ReportToolbar, {
+      columns: allColumns,
+      selected: selectedFieldnames,
+      onToggleColumn: handleToggleColumn,
+      onResetColumns: handleResetColumns,
+      groupBy,
+      onGroupByChange: setGroupBy,
+      baseFilters,
+      onClearBaseFilters: baseFilters.length > 0 ? handleClearBaseFilters : void 0,
+      columnFilterCount: activeColumnFilterCount,
+      onClearColumnFilters: handleClearColumnFilters,
+      savedReports: savedReports.reports,
+      currentReport,
+      onSelectReport: handleSelectReport,
+      onSaveReport: handleSaveReport,
+      onDeleteReport: handleDeleteReport,
+      onExport: handleExport,
+      exportDisabled: total === 0
+    }), /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_components.YStack, {
+      flex: 1,
+      minWidth: 0,
+      paddingHorizontal: "$3",
+      children: body
+    }), total > 0 && !syncError && /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_components.YStack, {
+      paddingHorizontal: "$3",
+      paddingVertical: "$2",
+      children: /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_table.DataTablePagination, {
+        pagination: {
+          pageIndex: effectivePage,
+          pageSize,
+          totalCount: total,
+          totalPages: pageCount
+        },
+        onPaginationChange: next => {
+          setPage(next.pageIndex);
+          setPageSize(next.pageSize);
+        },
+        pageSizeOptions: [...import_reportViewModel.REPORT_PAGE_SIZES],
+        compact: true
+      })
+    })]
+  });
+  return import_components.isWeb ? content : /* @__PURE__ */(0, import_jsx_runtime.jsx)(import_components.ScrollView, {
+    flex: 1,
+    children: content
+  });
+}