@multiplatform.one/backoffice 7.28.0 → 7.29.0

package/src/report/reportViewModel.ts

@@ -1,606 +1,33 @@
-// Pure model for the doctype REPORT view (desk report-builder parity).
-// UI-free on purpose: default-column derivation (desk set_default_fields),
-// the per-column filter-row → frappe-tuple mapping (list filter-fields
-// vocabulary), desk `report_settings` JSON round-trip (saved Report docs
-// desk can open and vice versa), deterministic sort/group/totals over the
-// live collection rows, and CSV assembly for export.
-import {
-  fieldKind,
-  selectOptionsFromField,
-  type FilterFieldKind,
+// The doctype report-view model lives in @multiplatform.one/frappe-ui
+// (MPO-15, GL-28), where FrappeReportBuilder renders it; this path keeps
+// handing out the same names.
+export {
+  buildReportGridRows as buildGridRows,
+  buildReportCsv,
+  reportColumnAlign as columnAlign,
+  reportColumnFilterTuple as columnFilterTuple,
+  reportColumnFilterTuples as columnFilterTuples,
+  compareReportCellValues as compareCellValues,
+  computeReportTotals as computeTotals,
+  DEFAULT_REPORT_PAGE_SIZE,
+  defaultReportColumnWidth as defaultColumnWidth,
+  defaultReportFieldnames,
+  fromDeskReportSettings,
+  orderReportRows,
+  parseDeskOrderBy,
+  parseReportFiltersParam,
+  REPORT_NUMERIC_FIELDTYPES,
+  REPORT_PAGE_SIZES,
+  reportColumnsFromMeta,
+  resolveReportColumns as resolveSelectedColumns,
+  toDeskReportSettings,
+} from "@multiplatform.one/frappe-ui";
+export type {
+  DeskReportSettings,
+  ReportColumnDef,
+  ReportGridRow,
+  ReportRow,
+  ReportSortState,
+  ReportTotalsCell,
+  ReportViewConfig,
 } from "@multiplatform.one/frappe-ui";
-import type { FrappeFilter, FrappeFilters } from "../shared/types";
-import type { DocFieldMeta, DoctypeMeta } from "../shared/useDoctypeMeta";
-
-// ── Column model ──────────────────────────────────────────────
-
-export interface ReportColumnDef {
-  fieldname: string;
-  label: string;
-  fieldtype: string;
-  kind: FilterFieldKind;
-  /** Link target doctype or raw Select options string. */
-  options?: string;
-  /** Fixed column width (px) — one scrollport, so widths align all rows. */
-  width: number;
-  align: "left" | "right" | "center";
-}
-
-export type ReportRow = { name: string } & Record<string, unknown>;
-
-export interface ReportSortState {
-  field: string;
-  order: "asc" | "desc";
-}
-
-/** Field types that can render/sort as report cells (desk is_value_type). */
-const VALUELESS_FIELDTYPES = new Set([
-  "Section Break",
-  "Column Break",
-  "Tab Break",
-  "HTML",
-  "Table",
-  "Table MultiSelect",
-  "Button",
-  "Image",
-  "Fold",
-  "Heading",
-]);
-
-export const REPORT_NUMERIC_FIELDTYPES = new Set([
-  "Int",
-  "Float",
-  "Currency",
-  "Percent",
-  "Rating",
-  "Duration",
-]);
-
-const WIDE_FIELDTYPES = new Set([
-  "Small Text",
-  "Text",
-  "Long Text",
-  "Text Editor",
-  "Markdown Editor",
-  "Code",
-  "JSON",
-]);
-
-/** Desk report page lengths. */
-export const REPORT_PAGE_SIZES = [20, 100, 500] as const;
-export const DEFAULT_REPORT_PAGE_SIZE: number = REPORT_PAGE_SIZES[0];
-
-export function defaultColumnWidth(fieldtype: string): number {
-  if (fieldtype === "Check") return 90;
-  if (REPORT_NUMERIC_FIELDTYPES.has(fieldtype)) return 110;
-  if (fieldtype === "Date") return 120;
-  if (fieldtype === "Datetime") return 165;
-  if (WIDE_FIELDTYPES.has(fieldtype)) return 240;
-  return 160;
-}
-
-export function columnAlign(fieldtype: string): ReportColumnDef["align"] {
-  if (fieldtype === "Check") return "center";
-  return REPORT_NUMERIC_FIELDTYPES.has(fieldtype) ? "right" : "left";
-}
-
-function toColumnDef(field: DocFieldMeta): ReportColumnDef {
-  const fieldtype = String(field.fieldtype);
-  return {
-    fieldname: field.fieldname,
-    label: field.label || field.fieldname,
-    fieldtype,
-    kind: fieldKind(fieldtype),
-    options: field.options,
-    width: defaultColumnWidth(fieldtype),
-    align: columnAlign(fieldtype),
-  };
-}
-
-/** Standard doc fields every doctype carries (absent from meta.fields). */
-function standardReportColumns(): ReportColumnDef[] {
-  return [
-    {
-      fieldname: "name",
-      label: "ID",
-      fieldtype: "Data",
-      kind: "text",
-      width: 160,
-      align: "left",
-    },
-    {
-      fieldname: "owner",
-      label: "Created By",
-      fieldtype: "Link",
-      kind: "link",
-      options: "User",
-      width: 160,
-      align: "left",
-    },
-    {
-      fieldname: "creation",
-      label: "Created On",
-      fieldtype: "Datetime",
-      kind: "date",
-      width: 165,
-      align: "left",
-    },
-    {
-      fieldname: "modified",
-      label: "Last Updated On",
-      fieldtype: "Datetime",
-      kind: "date",
-      width: 165,
-      align: "left",
-    },
-    {
-      fieldname: "modified_by",
-      label: "Last Updated By",
-      fieldtype: "Link",
-      kind: "link",
-      options: "User",
-      width: 160,
-      align: "left",
-    },
-  ];
-}
-
-/**
- * Every column the picker can offer: ID + meta value-type data fields (in
- * meta order, hidden included — desk's picker offers them too) + the
- * remaining standard doc fields.
- */
-export function reportColumnsFromMeta(meta?: DoctypeMeta): ReportColumnDef[] {
-  const out: ReportColumnDef[] = [];
-  const seen = new Set<string>();
-  const push = (column: ReportColumnDef) => {
-    if (!column.fieldname || seen.has(column.fieldname)) return;
-    seen.add(column.fieldname);
-    out.push(column);
-  };
-  push(standardReportColumns()[0]); // ID first, desk parity
-  for (const field of meta?.fields ?? []) {
-    const fieldtype = String(field.fieldtype);
-    if (VALUELESS_FIELDTYPES.has(fieldtype) || fieldtype.startsWith("Table")) continue;
-    push(toColumnDef(field));
-  }
-  for (const standard of standardReportColumns()) push(standard);
-  return out;
-}
-
-/**
- * Desk default report columns (report_view.js set_default_fields):
- * name, a `status` docfield when the doctype has one (nearest meta-derivable
- * stand-in for desk's computed Status indicator), title_field + image_field,
- * fields flagged in_list_view OR in_standard_filter (value-type, not
- * report_hide), currency-source fields referenced by flagged Currency
- * columns, then modified (a fresh report should carry recency). Desk's
- * listview_settings.add_fields (e.g. User's "enabled") live in desk-side JS
- * bundles and cannot be derived from the meta channel — honest subset.
- */
-export function defaultReportFieldnames(meta?: DoctypeMeta): string[] {
-  const out: string[] = [];
-  const seen = new Set<string>();
-  const push = (fieldname?: string) => {
-    if (!fieldname || seen.has(fieldname)) return;
-    seen.add(fieldname);
-    out.push(fieldname);
-  };
-  const pickable = (field: DocFieldMeta): boolean => {
-    const fieldtype = String(field.fieldtype);
-    return (
-      !VALUELESS_FIELDTYPES.has(fieldtype) &&
-      !fieldtype.startsWith("Table") &&
-      field.report_hide !== 1
-    );
-  };
-  const fields = meta?.fields ?? [];
-  push("name");
-  const status = fields.find((field) => field.fieldname === "status");
-  if (status && pickable(status)) push("status");
-  push(meta?.title_field);
-  push(meta?.image_field);
-  const flagged = fields.filter(
-    (field) => pickable(field) && (field.in_list_view === 1 || field.in_standard_filter === 1),
-  );
-  for (const field of flagged) push(field.fieldname);
-  // Desk: a flagged Currency column pulls in the field naming its currency.
-  for (const field of flagged) {
-    if (String(field.fieldtype) !== "Currency" || !field.options) continue;
-    push(field.options.includes(":") ? field.options.split(":")[1] : field.options);
-  }
-  push("modified");
-  return out;
-}
-
-/** Resolve selected fieldnames against the pickable set (drops unknowns). */
-export function resolveSelectedColumns(
-  all: ReportColumnDef[],
-  fieldnames: readonly string[],
-): ReportColumnDef[] {
-  const byName = new Map(all.map((column) => [column.fieldname, column]));
-  const out: ReportColumnDef[] = [];
-  for (const fieldname of fieldnames) {
-    const column = byName.get(fieldname);
-    if (column) out.push(column);
-  }
-  return out;
-}
-
-// ── Per-column filter row → frappe tuples ─────────────────────
-
-const COMPARISON_PREFIXES = [">=", "<=", "!=", ">", "<", "="] as const;
-
-const CHECK_TRUE = new Set(["1", "true", "yes", "y", "✓"]);
-const CHECK_FALSE = new Set(["0", "false", "no", "n"]);
-
-/**
- * One filter-row input → one frappe tuple (null = no filter yet).
- * Mapping mirrors the list filter vocabulary (filter-fields):
- *   text / link → `like %value%` (contains; user-typed % wins)
- *   select      → `=` on an exact option match (case-insensitive),
- *                 else `like %value%` so partial typing still narrows
- *   check       → yes/no/1/0/true/false → `= 1|0`
- *   number/date → optional comparison prefix (`>`, `<`, `>=`, `<=`, `!=`,
- *                 `=`), bare values equal-match (desk operator-hint parity)
- */
-export function columnFilterTuple(column: ReportColumnDef, raw: string): FrappeFilter | null {
-  const text = raw.trim();
-  if (!text) return null;
-  switch (column.kind) {
-    case "check": {
-      const lowered = text.toLowerCase();
-      if (CHECK_TRUE.has(lowered)) return [column.fieldname, "=", 1];
-      if (CHECK_FALSE.has(lowered)) return [column.fieldname, "=", 0];
-      return null;
-    }
-    case "select": {
-      const match = selectOptionsFromField(column.options).find(
-        (option) => option.value.toLowerCase() === text.toLowerCase(),
-      );
-      if (match) return [column.fieldname, "=", match.value];
-      return [column.fieldname, "like", text.includes("%") ? text : `%${text}%`];
-    }
-    case "number":
-    case "date": {
-      for (const prefix of COMPARISON_PREFIXES) {
-        if (text.startsWith(prefix)) {
-          const value = text.slice(prefix.length).trim();
-          return value ? [column.fieldname, prefix, value] : null;
-        }
-      }
-      return [column.fieldname, "=", text];
-    }
-    default:
-      return [column.fieldname, "like", text.includes("%") ? text : `%${text}%`];
-  }
-}
-
-/** All committed filter-row inputs → tuples (unparseable inputs skipped). */
-export function columnFilterTuples(
-  columns: readonly ReportColumnDef[],
-  filters: Readonly<Record<string, string>>,
-): FrappeFilters {
-  const out: FrappeFilters = [];
-  for (const column of columns) {
-    const raw = filters[column.fieldname];
-    if (raw === undefined) continue;
-    const tuple = columnFilterTuple(column, raw);
-    if (tuple) out.push(tuple);
-  }
-  return out;
-}
-
-// ── `?f=` deep-link param ─────────────────────────────────────
-
-/**
- * Parse the `?f=` search param: urlencoded JSON FrappeFilters. The router
- * usually decodes the param already, so the raw value is tried first
- * (same contract as the list screen's parser). Malformed input degrades to
- * "no filters".
- */
-export function parseReportFiltersParam(raw: unknown): FrappeFilters | undefined {
-  if (typeof raw !== "string" || !raw) return undefined;
-  const candidates = [raw];
-  try {
-    const decoded = decodeURIComponent(raw);
-    if (decoded !== raw) candidates.push(decoded);
-  } catch {
-    // raw is not percent-encoded — the direct candidate covers it
-  }
-  for (const candidate of candidates) {
-    try {
-      const parsed: unknown = JSON.parse(candidate);
-      if (!Array.isArray(parsed)) continue;
-      const filters: FrappeFilters = [];
-      for (const tuple of parsed) {
-        if (
-          Array.isArray(tuple) &&
-          tuple.length === 3 &&
-          typeof tuple[0] === "string" &&
-          typeof tuple[1] === "string"
-        ) {
-          filters.push([tuple[0], tuple[1], tuple[2]]);
-        }
-      }
-      if (filters.length > 0) return filters;
-    } catch {
-      // not JSON — try the next candidate
-    }
-  }
-  return undefined;
-}
-
-// ── Desk saved-report round trip ──────────────────────────────
-// Report docs store json = { fields: [fieldname, doctype][], filters:
-// [doctype, fieldname, operator, value][], order_by: "`tabX`.`field` desc",
-// add_totals_row, page_length, group_by, column_widths, ... }. Serialize
-// the same shape so desk opens our reports and we open desk's.
-
-export interface ReportViewConfig {
-  fieldnames: string[];
-  filters: FrappeFilters;
-  sort?: ReportSortState;
-  pageSize?: number;
-  groupBy?: string | null;
-  addTotals?: boolean;
-}
-
-interface DeskGroupBySettings {
-  group_by?: string | null;
-  aggregate_function?: string;
-  aggregate_on?: string | null;
-}
-
-export interface DeskReportSettings {
-  fields: Array<[string, string]>;
-  filters: Array<[string, string, string, unknown]>;
-  order_by: string;
-  add_totals_row: 0 | 1;
-  page_length: number;
-  column_widths: Record<string, number>;
-  group_by?: DeskGroupBySettings | null;
-}
-
-const BACKTICK_FIELD_RE = /`tab([^`]+)`\.`([^`]+)`/;
-
-function toDeskFieldExpr(doctype: string, fieldname: string): string {
-  return `\`tab${doctype}\`.\`${fieldname}\``;
-}
-
-/** Parse "`tabUser`.`modified` desc" (or bare "modified desc"). */
-export function parseDeskOrderBy(orderBy: unknown): ReportSortState | undefined {
-  if (typeof orderBy !== "string" || !orderBy.trim()) return undefined;
-  const [expr, direction] = orderBy.trim().split(/\s+/);
-  const backticked = expr.match(BACKTICK_FIELD_RE);
-  const field = backticked ? backticked[2] : expr.replace(/`/g, "");
-  if (!field) return undefined;
-  return { field, order: direction?.toLowerCase() === "asc" ? "asc" : "desc" };
-}
-
-export function toDeskReportSettings(
-  doctype: string,
-  config: ReportViewConfig,
-): DeskReportSettings {
-  const sort = config.sort ?? { field: "modified", order: "desc" };
-  return {
-    fields: config.fieldnames.map((fieldname) => [fieldname, doctype]),
-    filters: config.filters.map(([fieldname, operator, value]) => [
-      doctype,
-      fieldname,
-      operator,
-      value,
-    ]),
-    order_by: `${toDeskFieldExpr(doctype, sort.field)} ${sort.order}`,
-    add_totals_row: config.addTotals ? 1 : 0,
-    page_length: config.pageSize ?? DEFAULT_REPORT_PAGE_SIZE,
-    column_widths: {},
-    group_by: config.groupBy
-      ? {
-          group_by: toDeskFieldExpr(doctype, config.groupBy),
-          aggregate_function: "count",
-          aggregate_on: null,
-        }
-      : null,
-  };
-}
-
-/**
- * Desk Report json → view config. Child-doctype fields/filters are dropped
- * (this view renders parent fields only — honest subset), legacy plain
- * string field entries are honored.
- */
-export function fromDeskReportSettings(
-  doctype: string,
-  json: unknown,
-): ReportViewConfig | undefined {
-  if (!json || typeof json !== "object") return undefined;
-  const raw = json as Record<string, unknown>;
-  const fieldnames: string[] = [];
-  if (Array.isArray(raw.fields)) {
-    for (const entry of raw.fields) {
-      if (typeof entry === "string") {
-        fieldnames.push(entry);
-      } else if (Array.isArray(entry) && typeof entry[0] === "string") {
-        const fieldDoctype = typeof entry[1] === "string" ? entry[1] : doctype;
-        if (fieldDoctype === doctype) fieldnames.push(entry[0]);
-      }
-    }
-  }
-  const filters: FrappeFilters = [];
-  if (Array.isArray(raw.filters)) {
-    for (const entry of raw.filters) {
-      if (!Array.isArray(entry)) continue;
-      if (entry.length === 4) {
-        const [filterDoctype, fieldname, operator, value] = entry;
-        if (
-          filterDoctype === doctype &&
-          typeof fieldname === "string" &&
-          typeof operator === "string"
-        ) {
-          filters.push([fieldname, operator, value]);
-        }
-      } else if (
-        entry.length === 3 &&
-        typeof entry[0] === "string" &&
-        typeof entry[1] === "string"
-      ) {
-        filters.push([entry[0], entry[1], entry[2]]);
-      }
-    }
-  }
-  const groupByRaw = raw.group_by as DeskGroupBySettings | null | undefined;
-  const groupByExpr = typeof groupByRaw?.group_by === "string" ? groupByRaw.group_by : undefined;
-  const groupByMatch = groupByExpr?.match(BACKTICK_FIELD_RE);
-  return {
-    fieldnames,
-    filters,
-    sort: parseDeskOrderBy(raw.order_by),
-    pageSize:
-      typeof raw.page_length === "number" && raw.page_length > 0 ? raw.page_length : undefined,
-    groupBy: groupByMatch ? groupByMatch[2] : null,
-    addTotals: raw.add_totals_row === 1,
-  };
-}
-
-// ── Sorting, grouping, totals ─────────────────────────────────
-
-function isNullish(value: unknown): value is null | undefined {
-  return value === null || value === undefined;
-}
-
-export function compareCellValues(a: unknown, b: unknown): number {
-  if (isNullish(a) && isNullish(b)) return 0;
-  if (isNullish(a)) return 1;
-  if (isNullish(b)) return -1;
-  if (typeof a === "number" && typeof b === "number") return a - b;
-  const left = String(a);
-  const right = String(b);
-  return left < right ? -1 : left > right ? 1 : 0;
-}
-
-/**
- * Deterministic client ordering of the live collection rows (live-query row
- * order is not guaranteed): group field first (when grouping), then the
- * sort field in its direction, name as the final tiebreak.
- */
-export function orderReportRows(
-  rows: readonly ReportRow[],
-  sort: ReportSortState,
-  groupBy?: string | null,
-): ReportRow[] {
-  const direction = sort.order === "asc" ? 1 : -1;
-  const sorted = [...rows];
-  sorted.sort((a, b) => {
-    if (groupBy) {
-      const grouped = compareCellValues(a[groupBy], b[groupBy]);
-      if (grouped !== 0) return grouped;
-    }
-    const left = a[sort.field];
-    const right = b[sort.field];
-    const ordered =
-      isNullish(left) || isNullish(right)
-        ? compareCellValues(left, right)
-        : direction * compareCellValues(left, right);
-    return ordered || compareCellValues(a.name, b.name);
-  });
-  return sorted;
-}
-
-export interface ReportGroupHeader {
-  kind: "group";
-  key: string;
-  value: unknown;
-  /** Rows carrying this value across the FULL filtered result. */
-  count: number;
-}
-
-export interface ReportDataRow {
-  kind: "row";
-  key: string;
-  row: ReportRow;
-  /** 1-based position in the full ordered result (row-number column). */
-  index: number;
-}
-
-export type ReportGridRow = ReportGroupHeader | ReportDataRow;
-
-/**
- * Page slice → grid rows. With grouping active, group headers are injected
- * at value boundaries inside the page; counts cover the full ordered result
- * so a group spanning pages reads honestly.
- */
-export function buildGridRows(
-  orderedRows: readonly ReportRow[],
-  pageStart: number,
-  pageSize: number,
-  groupBy?: string | null,
-): ReportGridRow[] {
-  const page = orderedRows.slice(pageStart, pageStart + pageSize);
-  const out: ReportGridRow[] = [];
-  let previousGroup: string | undefined;
-  const counts = new Map<string, number>();
-  if (groupBy) {
-    for (const row of orderedRows) {
-      const groupKey = String(row[groupBy] ?? "");
-      counts.set(groupKey, (counts.get(groupKey) ?? 0) + 1);
-    }
-  }
-  page.forEach((row, index) => {
-    if (groupBy) {
-      const groupKey = String(row[groupBy] ?? "");
-      if (previousGroup === undefined || groupKey !== previousGroup) {
-        previousGroup = groupKey;
-        out.push({
-          kind: "group",
-          key: `group:${groupKey}:${pageStart + index}`,
-          value: row[groupBy],
-          count: counts.get(groupKey) ?? 0,
-        });
-      }
-    }
-    out.push({ kind: "row", key: row.name, row, index: pageStart + index + 1 });
-  });
-  return out;
-}
-
-export interface ReportTotalsCell {
-  fieldname: string;
-  fieldtype: string;
-  value: number;
-}
-
-/** Sums per visible numeric column over the FULL filtered result. */
-export function computeTotals(
-  columns: readonly ReportColumnDef[],
-  rows: readonly ReportRow[],
-): ReportTotalsCell[] {
-  if (rows.length === 0) return [];
-  return columns
-    .filter((column) => REPORT_NUMERIC_FIELDTYPES.has(column.fieldtype))
-    .map((column) => ({
-      fieldname: column.fieldname,
-      fieldtype: column.fieldtype,
-      value: rows.reduce((sum, row) => sum + (Number(row[column.fieldname]) || 0), 0),
-    }));
-}
-
-// ── CSV export ────────────────────────────────────────────────
-
-function escapeCsvCell(value: unknown): string {
-  if (value === null || value === undefined) return "";
-  const text = String(value);
-  return /[",\n]/.test(text) ? `"${text.replace(/"/g, '""')}"` : text;
-}
-
-/** CSV over the FULL filtered + ordered result (not just the page). */
-export function buildReportCsv(
-  columns: readonly ReportColumnDef[],
-  rows: readonly ReportRow[],
-): string {
-  const lines = [
-    columns.map((column) => escapeCsvCell(column.label)).join(","),
-    ...rows.map((row) => columns.map((column) => escapeCsvCell(row[column.fieldname])).join(",")),
-  ];
-  return lines.join("\n");
-}