Data model

// AC = actual · PY = previous year · PL = plan/budget · FC = forecast
type ScenarioKey = "AC" | "PY" | "PL" | "FC";

// The standard category row: one label plus one optional value per scenario.
// Trend periods, line points, combo columns and variance columns are all this
// shape (or a narrow extension of it).
interface ScenarioDatum {
  category: string; // "EMEA", "Jan", "Q1", "2024"
  AC?: number;
  PY?: number;
  PL?: number;
  FC?: number;
}

interface StatementLine {
  id: string;
  label: string;
  // How the line moves the actual waterfall. Default "add".
  //  "add"      → moves the running total up   (revenue, other income)
  //  "subtract" → moves the running total down (cost, expense, tax)
  //  "result"   → a subtotal drawn to the running total; it does not move it
  flow?: "add" | "subtract" | "result";
  values: Partial<Record<ScenarioKey, number>>; // real currency units
  higherIsBetter?: boolean; // default true; set false on cost/expense/tax
  children?: StatementLine[]; // breakdown; collapsible. Must sum to the parent.
  defaultCollapsed?: boolean;
  emphasis?: boolean; // bold; auto-true for flow "result"
}

// VarianceColumnChart rows: a ScenarioDatum where AC is required.
type ColumnDatum = ScenarioDatum & { AC: number };

const quarterly: ColumnDatum[] = [
  { category: "Q1", AC: 6.8e6, PY: 6.1e6, PL: 6.5e6 },
  { category: "Q2", AC: 7.3e6, PY: 6.4e6, PL: 7.0e6 },
];

// TrendChart periods. Actual periods carry AC; the forecast tail carries FC
// (drawn hatched). PY / PL ride along as reference lines.
interface TrendDatum extends ScenarioDatum {
  // Set off as a total (e.g. a full-year column): divider, emphasis colour,
  // and its OWN scale treatment - a total that dwarfs the periods is drawn
  // capped with a marked scale break instead of crushing the months.
  summary?: boolean;
}

// StructureChart components - same `category` key as every other datum
// (`label` is accepted as a legacy alias from v1.0).
interface StructureDatum {
  category: string; // "North America", "Europe", …
  AC?: number;
  PY?: number;
  PL?: number;
  FC?: number;
  higherIsBetter?: boolean; // per-component override (e.g. a cost part)
}

// WaterfallChart contributions, in order.
interface WaterfallDatum {
  category: string;
  value: number;
  flow?: "add" | "subtract" | "result";
  higherIsBetter?: boolean;
}

import { statementToWaterfall, statementToStructure, statementToDataTableRows } from "ibcs-react";

// statementToWaterfall(lines, scenario = "AC", { expandGroups = false })
const acBridge = statementToWaterfall(lines); // top-level lines, AC
const pyBridge = statementToWaterfall(lines, "PY"); // the same bridge, PY
const detailed = statementToWaterfall(lines, "AC", { expandGroups: true });

// statementToStructure(lines, { skipResults = true })
const parts = statementToStructure(costLines); // subtotals dropped

// statementToDataTableRows(lines, { measure = "value" })
const rows = statementToDataTableRows(lines); // hierarchy preserved

import { DataTable, statementToDataTableRows } from "ibcs-react";

const columns = [
  { key: "value", label: "AC" }, // measure defaults to the key
  { key: "value_py", label: "PY", measure: "value", scenario: "PY" },
  { key: "d_py", label: "ΔPY", kind: "variance", measure: "value", base: "PY" },
];

<DataTable columns={columns} rows={statementToDataTableRows(lines)} />;

import { StatementTable, WaterfallChart, statementToWaterfall } from "ibcs-react";

const lines = fetchPnl(); // the ONE model

<StatementTable lines={lines} />
<WaterfallChart
  data={statementToWaterfall(lines)}
  comparisonData={statementToWaterfall(lines, "PY")}
/>