@multiplatform.one/backoffice 7.28.0 → 7.29.0

package/src/report/savedReports.ts

@@ -1,161 +1,4 @@
-// Saved reports — desk parity via the `Report` doctype (report_type
-// "Report Builder"): the same records desk's "Select Report" dropdown
-// lists. Save/Save As ride the whitelisted frappe.desk.reportview
-// save_report / delete_report methods (identical payload shape, so desk
-// opens reports saved here and vice versa). Fixture mode (stories / no
-// bench) keeps an in-memory list so the control stays demonstrable.
-import { useFrappeConfig } from "@multiplatform.one/frappe-ui";
-import { useCallback, useEffect, useMemo, useRef, useState } from "react";
-import { useFrappeApp } from "../shared/useFrappeApp";
-import {
-  toDeskReportSettings,
-  fromDeskReportSettings,
-  type ReportViewConfig,
-} from "./reportViewModel";
-
-export interface SavedReportSummary {
-  /** Report document name (usually equals the report title). */
-  name: string;
-  reportName: string;
-  json?: string;
-}
-
-export interface UseSavedReportsResult {
-  reports: SavedReportSummary[];
-  loading: boolean;
-  /** Load a saved report's view config (fields/filters/sort/…). */
-  load: (name: string) => Promise<ReportViewConfig | undefined>;
-  /** Create or update a Report doc; returns the server-side name. */
-  save: (name: string, config: ReportViewConfig) => Promise<string>;
-  remove: (name: string) => Promise<void>;
-  refresh: () => void;
-}
-
-type ReportListRow = { name: string; report_name?: string; json?: string };
-
-export function useSavedReports(doctype: string): UseSavedReportsResult {
-  const app = useFrappeApp();
-  const config = useFrappeConfig();
-  const fixtureMode = Boolean(config?.fixtures);
-  const [reports, setReports] = useState<SavedReportSummary[]>([]);
-  const [loading, setLoading] = useState(false);
-  const [generation, setGeneration] = useState(0);
-  // Fixture-mode saves live here (stories/tests) — never reaches a bench.
-  const memoryConfigs = useRef(new Map<string, ReportViewConfig>());
-
-  useEffect(() => {
-    memoryConfigs.current = new Map();
-    setReports([]);
-  }, [doctype]);
-
-  useEffect(() => {
-    if (!app || fixtureMode) return;
-    let cancelled = false;
-    setLoading(true);
-    app
-      .call()
-      .get<{ message?: ReportListRow[] }>("frappe.client.get_list", {
-        doctype: "Report",
-        filters: JSON.stringify([
-          ["ref_doctype", "=", doctype],
-          ["report_type", "=", "Report Builder"],
-          ["disabled", "=", 0],
-        ]),
-        fields: JSON.stringify(["name", "report_name", "json"]),
-        limit_page_length: 0,
-        order_by: "report_name asc",
-      })
-      .then((res) => {
-        if (cancelled) return;
-        const rows = res.payload?.message ?? [];
-        setReports(
-          rows.map((row) => ({
-            name: row.name,
-            reportName: row.report_name || row.name,
-            json: row.json,
-          })),
-        );
-        setLoading(false);
-      })
-      .catch(() => {
-        // Report doctype may be unreadable for restricted roles — the
-        // selector then simply offers no saved reports.
-        if (cancelled) return;
-        setReports([]);
-        setLoading(false);
-      });
-    return () => {
-      cancelled = true;
-    };
-  }, [app, fixtureMode, doctype, generation]);
-
-  const load = useCallback(
-    async (name: string): Promise<ReportViewConfig | undefined> => {
-      if (fixtureMode) return memoryConfigs.current.get(name);
-      const summary = reports.find((report) => report.name === name);
-      let json = summary?.json;
-      if (json === undefined && app) {
-        const res = await app
-          .call()
-          .get<{ message?: { json?: string } }>("frappe.client.get_value", {
-            doctype: "Report",
-            filters: JSON.stringify({ name }),
-            fieldname: JSON.stringify(["json"]),
-          });
-        json = res.payload?.message?.json;
-      }
-      if (!json) return undefined;
-      try {
-        return fromDeskReportSettings(doctype, JSON.parse(json));
-      } catch {
-        return undefined;
-      }
-    },
-    [app, fixtureMode, reports, doctype],
-  );
-
-  const save = useCallback(
-    async (name: string, viewConfig: ReportViewConfig): Promise<string> => {
-      const trimmed = name.trim();
-      if (!trimmed) throw new Error("Report name is required");
-      if (fixtureMode || !app) {
-        memoryConfigs.current.set(trimmed, viewConfig);
-        setReports((previous) => [
-          ...previous.filter((report) => report.name !== trimmed),
-          { name: trimmed, reportName: trimmed },
-        ]);
-        return trimmed;
-      }
-      const res = await app
-        .call()
-        .post<{ message?: string }>("frappe.desk.reportview.save_report", {
-          name: trimmed,
-          doctype,
-          report_settings: JSON.stringify(toDeskReportSettings(doctype, viewConfig)),
-        });
-      setGeneration((value) => value + 1);
-      return res.payload?.message ?? trimmed;
-    },
-    [app, fixtureMode, doctype],
-  );
-
-  const remove = useCallback(
-    async (name: string): Promise<void> => {
-      if (fixtureMode || !app) {
-        memoryConfigs.current.delete(name);
-        setReports((previous) => previous.filter((report) => report.name !== name));
-        return;
-      }
-      await app.call().post("frappe.desk.reportview.delete_report", { name });
-      setGeneration((value) => value + 1);
-    },
-    [app, fixtureMode, doctype],
-  );
-
-  const refresh = useCallback(() => setGeneration((value) => value + 1), []);
-
-  return useMemo(
-    () => ({ reports, loading, load, save, remove, refresh }),
-    [reports, loading, load, save, remove, refresh],
-  );
-}
+// Saved reports live in @multiplatform.one/frappe-ui (MPO-15, GL-28); this
+// path keeps handing out the same names.
+export { useSavedReports } from "@multiplatform.one/frappe-ui";
+export type { SavedReportSummary, UseSavedReportsResult } from "@multiplatform.one/frappe-ui";

package/src/report/useQueryReport.ts

@@ -1,47 +1,6 @@
-// Data hook for frappe Query / Script Reports (the desk
-// /app/query-report/<name> surface): loads the Report doc (title,
-// ref_doctype, doc-level filters) plus the desk-side script module
-// (frappe.desk.query_report.get_script) and runs
-// frappe.desk.query_report.run. Wire-shape normalization (and the probed
-// response documentation) lives in reportShapes.ts; this file owns
-// fetch/state.
-//
-//   GET /api/method/frappe.client.get {doctype:"Report", name}
-//   → {message: {report_name, ref_doctype, report_type, disabled,
-//      prepared_report, add_total_row, filters: [...], ...}}
-//   GET /api/method/frappe.desk.query_report.get_script {report_name}
-//   → {message: {script, html_format, execution_time, filters}}
-//
-// Filter meta sources (desk precedence, query_report.js setup): the script
-// module's declarative `filters` win when the script declares any; the
-// Report doc `filters` child table applies only when it doesn't. Script
-// filters are extracted from the raw JS text without eval
-// (reportShapes.extractScriptFilters) — entries beyond the declarative
-// subset (get_query functions, dynamic defaults, desk-only fieldtypes)
-// surface as `scriptFilterGap` so the screen can render an honest note.
-// `ignore_prepared_report` forces a synchronous run for prepared reports
-// (desk's background Prepared Report queue is out of scope here).
-import type { FrappeApp } from "@multiplatform.one/frappe";
-import { useCallback, useEffect, useMemo, useRef, useState } from "react";
-import { useFrappeApp } from "../shared/useFrappeApp";
-import {
-  type QueryReportColumn,
-  type QueryReportFilterMeta,
-  type QueryReportFilters,
-  type QueryReportFixture,
-  type QueryReportMeta,
-  type QueryReportRow,
-  type QueryReportRunMessage,
-  buildRunFilters,
-  defaultFilterValues,
-  extractScriptFilters,
-  humanizeFrappeError,
-  isEmptyFilterValue,
-  normalizeFilterMeta,
-  normalizeQueryReportColumns,
-  normalizeQueryReportRows,
-} from "./reportShapes";
-
+// The query-report hook lives in @multiplatform.one/frappe-ui (MPO-15,
+// GL-28), on the same transport as FrappeReportView; this path keeps
+// handing out the same names, the model's included.
 export {
   buildRunFilters,
   compactQueryReportFilters,
@@ -51,8 +10,9 @@ export {
   normalizeQueryReportColumns,
   normalizeQueryReportRows,
   scrubFieldname,
-  stripHtml,
-} from "./reportShapes";
+  stripReportHtml as stripHtml,
+  useQueryReport,
+} from "@multiplatform.one/frappe-ui";
 export type {
   QueryReportColumn,
   QueryReportFilterMeta,
@@ -61,304 +21,6 @@ export type {
   QueryReportMeta,
   QueryReportRow,
   ScriptFilterExtraction,
-} from "./reportShapes";
-
-const RUN_METHOD = "frappe.desk.query_report.run";
-const SCRIPT_METHOD = "frappe.desk.query_report.get_script";
-
-export interface UseQueryReportOptions {
-  fixture?: QueryReportFixture;
-  /** Filter values applied before the first run (report swaps re-apply them). */
-  initialFilters?: QueryReportFilters;
-}
-
-export interface UseQueryReportResult {
-  meta?: QueryReportMeta;
-  columns: QueryReportColumn[];
-  rows: QueryReportRow[];
-  /** True until the first meta+script+run cycle settles. */
-  loading: boolean;
-  /** True while a (re)run is in flight. */
-  running: boolean;
-  error?: Error;
-  /** The report's informational `message` payload (may embed HTML). */
-  serverMessage?: string;
-  /** Server-reported run time in seconds. */
-  executionTime?: number;
-  /** Merged filter meta: script-declared filters, else doc-level rows. */
-  filterMeta: QueryReportFilterMeta[];
-  /**
-   * True when the desk script declares filters this surface could not
-   * derive (non-declarative entries) — the honest "defined in code" note.
-   */
-  scriptFilterGap: boolean;
-  /** Mandatory filters currently unfilled — the run is skipped while non-empty. */
-  missingRequired: QueryReportFilterMeta[];
-  filters: QueryReportFilters;
-  setFilters: (next: QueryReportFilters) => void;
-  reload: () => void;
-}
-
-async function fetchReportMeta(app: FrappeApp, reportName: string): Promise<QueryReportMeta> {
-  const res = await app.call().get<{ message?: QueryReportMeta }>("frappe.client.get", {
-    doctype: "Report",
-    name: reportName,
-  });
-  const doc = res.payload?.message;
-  if (!doc) throw new Error(`Report "${reportName}" not found`);
-  return doc;
-}
-
-async function fetchReportScript(app: FrappeApp, reportName: string): Promise<string | undefined> {
-  const res = await app.call().get<{ message?: { script?: string | null } }>(SCRIPT_METHOD, {
-    report_name: reportName,
-  });
-  const script = res.payload?.message?.script;
-  return typeof script === "string" ? script : undefined;
-}
-
-export function useQueryReport(
-  reportName: string,
-  options: UseQueryReportOptions = {},
-): UseQueryReportResult {
-  const { fixture } = options;
-  const app = useFrappeApp();
-
-  // Latest initialFilters without re-running effects on identity churn.
-  const initialFiltersRef = useRef(options.initialFilters);
-  initialFiltersRef.current = options.initialFilters;
-
-  const [meta, setMeta] = useState<QueryReportMeta | undefined>(undefined);
-  const [script, setScript] = useState<string | undefined>(undefined);
-  const [sourcesSettled, setSourcesSettled] = useState(false);
-  const [filters, setFiltersState] = useState<QueryReportFilters>(() => ({
-    ...initialFiltersRef.current,
-  }));
-  const [columns, setColumns] = useState<QueryReportColumn[]>([]);
-  const [rows, setRows] = useState<QueryReportRow[]>([]);
-  const [loading, setLoading] = useState(true);
-  const [running, setRunning] = useState(false);
-  const [error, setError] = useState<Error | undefined>(undefined);
-  const [serverMessage, setServerMessage] = useState<string | undefined>(undefined);
-  const [executionTime, setExecutionTime] = useState<number | undefined>(undefined);
-  const [generation, setGeneration] = useState(0);
-  const seededFor = useRef<string | undefined>(undefined);
-
-  // The route component is reused across query-report navigations — a
-  // report swap resets filters and shows the loading state again.
-  const lastReport = useRef(reportName);
-  useEffect(() => {
-    if (lastReport.current === reportName) return;
-    lastReport.current = reportName;
-    setFiltersState({ ...initialFiltersRef.current });
-    setMeta(undefined);
-    setScript(undefined);
-    setSourcesSettled(false);
-    setColumns([]);
-    setRows([]);
-    setError(undefined);
-    setServerMessage(undefined);
-    setExecutionTime(undefined);
-    setLoading(true);
-  }, [reportName]);
-
-  // Report doc meta (title, ref_doctype, doc filters) + the desk script
-  // module, fetched together. Both are non-fatal niceties — the run below
-  // reports the real errors — but the run waits for them so declared
-  // defaults are seeded into the FIRST run (desk parity).
-  useEffect(() => {
-    if (fixture) return;
-    if (!app) {
-      setSourcesSettled(true);
-      return;
-    }
-    let cancelled = false;
-    setSourcesSettled(false);
-    Promise.allSettled([fetchReportMeta(app, reportName), fetchReportScript(app, reportName)]).then(
-      ([metaResult, scriptResult]) => {
-        if (cancelled) return;
-        const doc = metaResult.status === "fulfilled" ? metaResult.value : undefined;
-        const scriptText = scriptResult.status === "fulfilled" ? scriptResult.value : undefined;
-        if (doc) setMeta(doc);
-        if (scriptText) setScript(scriptText);
-        // Seed filter defaults once per report; user edits (and deep-link
-        // initialFilters, already in state) win over defaults.
-        if (seededFor.current !== reportName) {
-          seededFor.current = reportName;
-          const extraction = extractScriptFilters(scriptText);
-          const merged = extraction.declared
-            ? extraction.filters
-            : normalizeFilterMeta(doc?.filters);
-          const defaults = defaultFilterValues(merged);
-          if (Object.keys(defaults).length > 0)
-            setFiltersState((previous) => ({ ...defaults, ...previous }));
-        }
-        setSourcesSettled(true);
-      },
-    );
-    return () => {
-      cancelled = true;
-    };
-  }, [app, fixture, reportName]);
-
-  const scriptExtraction = useMemo(
-    () => extractScriptFilters(fixture ? fixture.script : script),
-    [fixture, script],
-  );
-  const docFilterMeta = useMemo(
-    () => normalizeFilterMeta(fixture ? fixture.meta?.filters : meta?.filters),
-    [fixture, meta],
-  );
-  // Desk precedence (query_report.js): the script module's filters apply
-  // when the script declares the key at all; doc rows only otherwise.
-  const filterMeta = useMemo(
-    () => (scriptExtraction.declared ? scriptExtraction.filters : docFilterMeta),
-    [scriptExtraction, docFilterMeta],
-  );
-  const scriptFilterGap = scriptExtraction.declaredCount > scriptExtraction.filters.length;
-
-  // Fixture branch seeds defaults too (no fetch effect runs for fixtures).
-  useEffect(() => {
-    if (!fixture) return;
-    if (seededFor.current === reportName) return;
-    seededFor.current = reportName;
-    const defaults = defaultFilterValues(filterMeta);
-    if (Object.keys(defaults).length > 0)
-      setFiltersState((previous) => ({ ...defaults, ...previous }));
-  }, [fixture, reportName, filterMeta]);
-
-  // Desk parity: defaults SEED the controls (state) once; after that the
-  // gate reads the live values only — clearing a defaulted mandatory filter
-  // re-gates instead of firing a doomed run (desk's get_filter_values reads
-  // control values, not declarations).
-  const missingRequired = useMemo(
-    () =>
-      filterMeta.filter(
-        (filter) => filter.mandatory === 1 && isEmptyFilterValue(filters[filter.fieldname]),
-      ),
-    [filterMeta, filters],
-  );
-  const hasMissingRequired = missingRequired.length > 0;
-  const metaDisabled = (fixture ? fixture.meta?.disabled : meta?.disabled) === 1;
-
-  useEffect(() => {
-    if (fixture) return;
-    if (!sourcesSettled) return;
-    if (metaDisabled) {
-      setLoading(false);
-      return;
-    }
-    if (hasMissingRequired) {
-      setColumns([]);
-      setRows([]);
-      setError(undefined);
-      setLoading(false);
-      return;
-    }
-    if (!app) {
-      setError(new Error("No Frappe connection configured"));
-      setLoading(false);
-      return;
-    }
-    let cancelled = false;
-    setRunning(true);
-    app
-      .call()
-      .post<{ message?: QueryReportRunMessage }>(RUN_METHOD, {
-        report_name: reportName,
-        filters: buildRunFilters(filterMeta, filters),
-        ignore_prepared_report: 1,
-      })
-      .then((res) => {
-        if (cancelled) return;
-        const message = res.payload?.message;
-        const nextColumns = normalizeQueryReportColumns(message?.columns);
-        setColumns(nextColumns);
-        setRows(normalizeQueryReportRows(message?.result, nextColumns));
-        setServerMessage(typeof message?.message === "string" ? message.message : undefined);
-        setExecutionTime(
-          typeof message?.execution_time === "number" ? message.execution_time : undefined,
-        );
-        setError(undefined);
-      })
-      .catch((err) => {
-        if (cancelled) return;
-        setColumns([]);
-        setRows([]);
-        setError(humanizeFrappeError(err));
-      })
-      .finally(() => {
-        if (cancelled) return;
-        setRunning(false);
-        setLoading(false);
-      });
-    return () => {
-      cancelled = true;
-    };
-  }, [
-    app,
-    fixture,
-    reportName,
-    filters,
-    filterMeta,
-    generation,
-    sourcesSettled,
-    metaDisabled,
-    hasMissingRequired,
-  ]);
-
-  const setFilters = useCallback((next: QueryReportFilters) => {
-    setFiltersState(next);
-  }, []);
-
-  const reload = useCallback(() => {
-    setGeneration((previous) => previous + 1);
-  }, []);
-
-  // Fixture branch: static data, no RPCs (stories/tests).
-  const fixtureResult = useMemo(() => {
-    if (!fixture) return undefined;
-    const fixtureColumns = normalizeQueryReportColumns(fixture.columns);
-    return {
-      columns: fixtureColumns,
-      rows: normalizeQueryReportRows(fixture.rows, fixtureColumns),
-      meta: fixture.meta ? ({ name: reportName, ...fixture.meta } as QueryReportMeta) : undefined,
-    };
-  }, [fixture, reportName]);
-
-  if (fixtureResult) {
-    return {
-      meta: fixtureResult.meta,
-      columns: fixtureResult.columns,
-      rows: hasMissingRequired ? [] : fixtureResult.rows,
-      loading: false,
-      running: false,
-      error: undefined,
-      serverMessage: fixture?.message,
-      executionTime: undefined,
-      filterMeta,
-      scriptFilterGap,
-      missingRequired,
-      filters,
-      setFilters,
-      reload,
-    };
-  }
-
-  return {
-    meta,
-    columns,
-    rows,
-    loading,
-    running,
-    error,
-    serverMessage,
-    executionTime,
-    filterMeta,
-    scriptFilterGap,
-    missingRequired,
-    filters,
-    setFilters,
-    reload,
-  };
-}
+  UseQueryReportOptions,
+  UseQueryReportResult,
+} from "@multiplatform.one/frappe-ui";

package/src/shared/measures.ts

@@ -1,11 +1,3 @@
-import { sizeRecipeEscape } from "@multiplatform.one/theme";
-
-export const dialogBodyMinWidth = sizeRecipeEscape(
-  280,
-  "dialog body floor: a reading width for the form inside a dialog or popover",
-);
-
-export const overlayListMaxHeight = sizeRecipeEscape(
-  360,
-  "overlay list cap: a menu or popover list scrolls past this height instead of growing",
-);
+// The overlay measures live in @multiplatform.one/frappe-ui beside the report
+// toolbar that moved there (MPO-15, GL-28); this path keeps handing them out.
+export { dialogBodyMinWidth, overlayListMaxHeight } from "@multiplatform.one/frappe-ui";

package/src/views/ReportView.screen.spec.tsx

@@ -1,7 +1,8 @@
 // The compatibility report view (MPO-414), still exported beside
-// DoctypeReportView: it counts and totals the filtered result, opens a record
-// from the footer or the grid, applies and clears the ?f= base filters, and
-// ANDs the desk scope into its queries (GL-5).
+// DoctypeReportView. Since MPO-15 (GL-28) it is that view under its old name,
+// FrappeReportBuilder under the desk's navigation: it totals the filtered
+// result, opens a record from the grid, applies and clears the ?f= base
+// filters, and ANDs the desk scope into its queries (GL-5).
 import React from "react";
 import { InMemoryFixtureProvider } from "@multiplatform.one/frappe";
 import { renderWithProviders } from "@multiplatform.one/test-utils";
@@ -66,25 +67,29 @@ function renderReport(filtersParam?: string, scope?: FrappeFilters): MemoryNavig
   return navigation;
 }
 
-async function counted(count: number) {
-  expect(await screen.findByText(`${count} record(s)`, {}, { timeout: 5000 })).toBeTruthy();
+function rowNames(): string[] {
+  return Array.from(
+    document.querySelectorAll('[data-report-row="true"]'),
+    (row) => row.getAttribute("aria-label") ?? "",
+  );
+}
+
+async function rowsAre(names: string[]) {
+  await waitFor(() => expect(rowNames().sort()).toEqual([...names].sort()), { timeout: 5000 });
 }
 
 describe("<ReportView />", () => {
-  it("counts and totals the result", async () => {
+  it("is the desk report view, totals row included", async () => {
     renderReport();
-    await counted(3);
-    const strips = screen
-      .getAllByText("Totals")
-      .map((label) => label.parentElement?.textContent ?? "");
-    expect(strips.some((text) => text.includes("Amount: 123"))).toBe(true);
+    await rowsAre(["QLO-0001", "QLO-0002", "QLO-0003"]);
+    const totals = screen.getByText("Totals").closest("[role=row]") ?? screen.getByText("Totals");
+    expect(totals.parentElement?.textContent ?? totals.textContent).toContain("123");
   });
 
-  it("opens a record from the footer's Open menu", async () => {
+  it("opens a record from the grid", async () => {
     const navigation = renderReport();
-    await counted(3);
-    fireEvent.click(screen.getByRole("button", { name: "Open" }));
-    fireEvent.click(await screen.findByText("Globex", { selector: "[role=menuitem] *" }));
+    await rowsAre(["QLO-0001", "QLO-0002", "QLO-0003"]);
+    fireEvent.click(screen.getByText("Globex"));
     await waitFor(() =>
       expect(navigation.getLocation().path).toBe("/backoffice/qalegacyorder/QLO-0002"),
     );
@@ -92,17 +97,17 @@ describe("<ReportView />", () => {
 
   it("applies the ?f= base filters and drops them from the address on clear", async () => {
     const navigation = renderReport(encodeURIComponent(JSON.stringify([["status", "=", "Draft"]])));
-    await counted(2);
+    await rowsAre(["QLO-0002", "QLO-0003"]);
     fireEvent.click(screen.getByRole("button", { name: "Clear filters" }));
-    await counted(3);
+    await rowsAre(["QLO-0001", "QLO-0002", "QLO-0003"]);
     expect(navigation.getLocation().path).toBe("/backoffice/qalegacyorder/view/report");
   });
 
-  it("ANDs the desk scope into the count and the grid", async () => {
+  it("ANDs the desk scope into the grid, with nothing to clear", async () => {
     renderReport(undefined, [["status", "=", "Paid"]]);
-    await counted(1);
+    await rowsAre(["QLO-0001"]);
     expect(screen.queryByRole("button", { name: "Clear filters" })).toBeNull();
-    await waitFor(() => expect(screen.queryByText("Globex")).toBeNull());
+    expect(screen.queryByText("Globex")).toBeNull();
     expect(screen.getAllByText("ACME Corp").length).toBeGreaterThan(0);
   });
 });