@object-ui/plugin-report 6.2.3 → 7.1.0

package/CHANGELOG.md

@@ -1,5 +1,119 @@
 # @object-ui/plugin-report
 
+## 7.1.0
+
+### Patch Changes
+
+- b419a7c: fix(studio): enable report authoring (create flow, chart render, dataset-aware inspector)
+
+  Found dogfooding report design in Studio as a business user — you could not create a report at all, plus several follow-on gaps.
+
+  - **Report create now uses the canvas + `ReportDefaultInspector`.** Only `object` was in `CREATE_MODE_CANVAS_TYPES`, so report-create fell back to a stale name-first form whose create-config (`objectName`, `columns: []`) predates the ADR-0021 dataset-bound model — saving failed server validation (_"a report needs `dataset` + `values`"_) with no field to fix it. Add `'report'` to the canvas set; the inspector exposes an auto-derived snake_case Name in create mode; fix the create-config (drop `objectName`/`columns`, seed `type: 'summary'` + `drilldown: true`).
+  - **Preserve `?package=` on post-create navigation** — it was dropped, so the editor reloaded a blank draft in the user's default package.
+  - **Render a report's embedded `chart`** in `DatasetReportRenderer` (authorable in Studio but never rendered) via the lazily-registered generic chart component; requests a non-animated render for export/background-tab safety.
+  - **Dedicated Chart panel in the inspector** — chart type + dataset-aware X-Axis (dimension) / Y-Axis (measure) dropdowns + title, replacing free-text axis fields and the vague "Chart: Required text value" validation.
+
+- Updated dependencies [677f7ed]
+- Updated dependencies [08c47da]
+- Updated dependencies [a71be60]
+- Updated dependencies [cb03bc3]
+  - @object-ui/types@7.1.0
+  - @object-ui/core@7.1.0
+  - @object-ui/react@7.1.0
+  - @object-ui/components@7.1.0
+  - @object-ui/fields@7.1.0
+  - @object-ui/plugin-grid@7.1.0
+  - @object-ui/i18n@7.1.0
+
+## 7.0.0
+
+### Major Changes
+
+- 0c95963: ADR-0021 single-form: dataset-native report editing + legacy report surface retired.
+
+  - The Studio/runtime report inspector now edits the 9.0 dataset binding (dataset picker + values/rows selectors sourced from the dataset's semantic layer) instead of the removed objectName/columns query form.
+  - plugin-report: the pre-9.0 query-form renderers (SpecReportGrid, MatrixRenderer, JoinedReportRenderer), the drill helpers, and the legacy authoring components (ReportBuilder, ReportConfigPanel, ColumnsEditor, GroupingsBuilder, JoinedBlocksEditor, FieldPickerDialog, ChartConfig, ScheduleConfig) are removed. ReportRenderer dispatches dataset-bound reports to DatasetReportRenderer; stored pre-9.0 spec JSON renders through the lossy specReportToPresentation → ReportViewer bridge until migrated.
+
+### Minor Changes
+
+- 39c89e7: ADR-0021 D2: true matrix cross-tab + dataset-path drill-down.
+
+  - DatasetReportRenderer pivots `type: 'matrix'` reports into a real rows × columns cross-tab (one dataset query over all dimensions, pivoted client-side; matrix without `columns` degrades to the flat grouped table). Joined blocks pivot too.
+  - Drill-down: aggregated rows / matrix cells are clickable when the host passes `onDrill` (and the report doesn't set `drilldown: false`), emitting `{dataset, groupKey, runtimeFilter}`. ReportView resolves the dataset's object + dimension→field mapping (reverse-mapping select option labels back to stored values) and navigates to the object list scoped by `?filter[field]=value`.
+  - Studio: the report inspector gains a Columns (across dimensions) list for matrix reports; ReportPreview renders through the same DatasetReportRenderer as the runtime, so the matrix preview is WYSIWYG.
+
+- 053c948: feat(plugin-report): server-supplied totals in dataset matrix reports
+
+  Pairs with the framework's server-side `queryDataset` totals. The matrix renderer
+  now requests `totals: { groupings: [rows, columns, []] }` and renders the
+  returned pre-aggregated rows — a trailing Total column per measure (row
+  subtotals), a trailing Total row (column subtotals), and the grand total at their
+  intersection — matched to pivot headers via the same `bucketId` logic. A response
+  without totals (older server) renders exactly as before; the client never
+  re-aggregates (ADR-0021).
+
+### Patch Changes
+
+- c849d3b: Remove the dead pre-9.0 client-side report-aggregation pipeline. ADR-0021 moved aggregation into the semantic layer (`queryDataset`), leaving the `useReportData` hook and its helpers (`buildAggregateQuery`, `groupAndAggregate`, `pivotRows`, `aggregateRows`, `collectFields`, `columnKey`, `bucketDate`, `groupingValue`) and the `ReportRow` / `PivotMatrix` / `PivotHeader` / `UseReportDataResult` / `UseReportDataOptions` types with zero consumers across the monorepo and all product repos. The still-used `mergeFilters` combinator moves to its own module and remains exported from the package root.
+- Updated dependencies [5976ba3]
+- Updated dependencies [a00e16d]
+- Updated dependencies [eaccefd]
+- Updated dependencies [f7f325d]
+- Updated dependencies [c12986e]
+- Updated dependencies [71d7ce0]
+- Updated dependencies [053c948]
+- Updated dependencies [053c948]
+- Updated dependencies [89e113c]
+- Updated dependencies [ddbe4a2]
+- Updated dependencies [2d47e94]
+- Updated dependencies [9049bbe]
+- Updated dependencies [77cc6bb]
+- Updated dependencies [6c0c92c]
+- Updated dependencies [97c6831]
+- Updated dependencies [cb2fdb1]
+- Updated dependencies [c3749eb]
+- Updated dependencies [c09f44e]
+- Updated dependencies [6cfa330]
+- Updated dependencies [ad8ade6]
+- Updated dependencies [d54346c]
+- Updated dependencies [5332639]
+- Updated dependencies [3870c20]
+- Updated dependencies [2eb3096]
+- Updated dependencies [b88c560]
+- Updated dependencies [0ad72a6]
+- Updated dependencies [bd398df]
+- Updated dependencies [3fa23a7]
+- Updated dependencies [18d0339]
+- Updated dependencies [66ed3ad]
+- Updated dependencies [c6445b6]
+- Updated dependencies [80c133c]
+- Updated dependencies [5e1b838]
+- Updated dependencies [59b6bbb]
+- Updated dependencies [d16566f]
+- Updated dependencies [90acb7f]
+- Updated dependencies [7913390]
+- Updated dependencies [514f426]
+- Updated dependencies [1394e34]
+- Updated dependencies [e95cc25]
+- Updated dependencies [abe8ebc]
+- Updated dependencies [300d755]
+- Updated dependencies [bd8b054]
+- Updated dependencies [4eb9cb6]
+- Updated dependencies [7c239fd]
+- Updated dependencies [858ad94]
+- Updated dependencies [2270239]
+- Updated dependencies [db8cd00]
+- Updated dependencies [2f31406]
+- Updated dependencies [18728c1]
+- Updated dependencies [8d1195d]
+  - @object-ui/core@7.0.0
+  - @object-ui/components@7.0.0
+  - @object-ui/plugin-grid@7.0.0
+  - @object-ui/react@7.0.0
+  - @object-ui/i18n@7.0.0
+  - @object-ui/types@7.0.0
+  - @object-ui/fields@7.0.0
+
 ## 6.2.3
 
 ### Patch Changes

package/dist/DatasetReportRenderer.d.ts

@@ -0,0 +1,95 @@
+/**
+ * DatasetReportRenderer
+ *
+ * Renders a spec `Report` that binds to a semantic-layer `dataset` (ADR-0021
+ * single-form) instead of an inline `objectName` + `columns` query. The report
+ * selects dimensions (`rows`, and for matrix also `columns`) and measures
+ * (`values`) BY NAME and runs them through `dataSource.queryDataset` — the
+ * same governed path dataset-bound dashboard widgets and the dataset preview
+ * use, so the numbers (and the server-resolved dimension display labels)
+ * match everywhere.
+ *
+ * - `summary` / `tabular` → one grouped table (`rows` + `values`).
+ * - `matrix` → a true cross-tab (ADR-0021 D2): `rows` down × `columns`
+ *   across, measures in the cells. One dataset query over all dimensions,
+ *   pivoted client-side. Totals (per-row subtotals, per-column subtotals,
+ *   grand total) are SERVER-supplied: the selection asks for
+ *   `totals: { groupings: [rows, columns, []] }` and the renderer only
+ *   places the returned pre-aggregated rows. It never re-aggregates bucketed
+ *   values client-side — measures like `avg` cannot be recombined without
+ *   drifting from the semantic layer (the ADR-0021 governance red line) —
+ *   so an older server that returns no `totals` renders the plain cross-tab
+ *   with no totals row/column. A matrix without `columns` degrades to the
+ *   flat grouped table.
+ * - `joined` → a vertical stack of blocks, each its own dataset-bound table,
+ *   with the report-level `runtimeFilter` merged into every block.
+ *
+ * Headers and measure cells mirror the dashboard `DatasetWidget` (PR #1825):
+ * column headers use the dataset's server-supplied display `label` (run
+ * through the i18n field-label convention), and measure values format with
+ * the field's declared `currency` (`Intl` symbol) + numeral `format`, never
+ * the raw field name or a misleading "$".
+ *
+ * Drill-down (ADR-0021 D2): when the report's `drilldown` flag is not `false`
+ * and the host supplies `onDrill`, every aggregated row / matrix cell is
+ * clickable and emits `{ dataset, groupKey, runtimeFilter }`. The HOST owns
+ * navigation — it resolves the dataset's `object` and dimension→field mapping
+ * (this renderer only knows dimension NAMES) and routes to the underlying
+ * records.
+ */
+import * as React from 'react';
+/** What a drill click means — the host resolves names to a navigation target. */
+export interface DatasetDrillArgs {
+    /** Dataset the clicked aggregate was computed over. */
+    dataset: string;
+    /** Dimension NAME → clicked bucket value (row dims, plus across dims for a matrix cell). */
+    groupKey: Record<string, unknown>;
+    /** The effective render-time scope filter, if any. */
+    runtimeFilter?: Record<string, unknown>;
+    /** The dataset's base object (records to drill into), when the server supplied it. */
+    object?: string;
+    /**
+     * Exact record-list filter (object FIELD name → RAW stored value) for the
+     * clicked bucket, ANDed with `runtimeFilter`. Present only when the server
+     * returned the dimension→field mapping + raw grouped values, so the host can
+     * filter precisely — including select/lookup dims a display-label `groupKey`
+     * would mis-filter — without re-fetching the dataset definition.
+     */
+    objectFilter?: Record<string, unknown>;
+}
+/** A report (or joined block) bound to a dataset. Field access is permissive — */
+/** the bundled spec types lag the runtime schema across the repo boundary.     */
+interface DatasetReportLike {
+    name?: string;
+    type?: string;
+    dataset?: string;
+    rows?: string[];
+    /** Dimension names across — matrix pivots `rows` × `columns` (ADR-0021 D2). */
+    columns?: string[];
+    values?: string[];
+    runtimeFilter?: Record<string, unknown>;
+    filter?: Record<string, unknown>;
+    /** Click-through to underlying records (default true). */
+    drilldown?: boolean;
+    /** Embedded chart visualization (ADR-0021): type + xAxis/yAxis over the dataset. */
+    chart?: Record<string, unknown>;
+    label?: unknown;
+    description?: unknown;
+    blocks?: DatasetReportLike[];
+}
+export interface DatasetReportRendererProps {
+    report: DatasetReportLike;
+    dataSource?: unknown;
+    /** Filter merged into the report (and every joined block) as `runtimeFilter`. */
+    runtimeFilter?: Record<string, unknown>;
+    /**
+     * Drill-down sink. Rows/cells become clickable when provided (and the
+     * report doesn't set `drilldown: false`).
+     */
+    onDrill?: (args: DatasetDrillArgs) => void;
+    className?: string;
+}
+/** `true` when this report should render through the dataset path. */
+export declare function isDatasetReport(value: unknown): value is DatasetReportLike;
+export declare const DatasetReportRenderer: React.FC<DatasetReportRendererProps>;
+export {};

package/dist/{packages/plugin-report/src/LiveReportExporter.d.ts → LiveReportExporter.d.ts}

@@ -1,4 +1,4 @@
-import { DataSource, QueryParams, ReportSchema, ReportExportFormat, ReportExportConfig, ReportSchedule } from '../../types/src';
+import { DataSource, QueryParams, ReportSchema, ReportExportFormat, ReportExportConfig, ReportSchedule } from '@object-ui/types';
 /**
  * Options for live report export
  */

package/dist/{packages/plugin-report/src/ReportExportEngine.d.ts → ReportExportEngine.d.ts}

@@ -1,4 +1,4 @@
-import { ReportSchema, ReportExportConfig, ReportExportFormat } from '../../types/src';
+import { ReportSchema, ReportExportConfig, ReportExportFormat } from '@object-ui/types';
 /**
  * Report Export Engine
  * Handles exporting report data to various formats using browser-native APIs.

package/dist/ReportRenderer.d.ts

@@ -0,0 +1,45 @@
+import { SpecReport, DataSource } from '@object-ui/types';
+import { LegacyReportRendererProps } from './LegacyReportRenderer';
+import { DatasetDrillArgs } from './DatasetReportRenderer';
+/**
+ * ReportRenderer
+ *
+ * Thin dispatcher that routes a report schema to the correct renderer.
+ *
+ * ADR-0021 single-form: a 9.0 report is **dataset-bound** — it binds a
+ * semantic-layer `dataset` and selects its `values` (measure names) grouped
+ * by `rows` (dimension names). That is the live rendering path.
+ *
+ * Dispatch table:
+ * | schema shape                          | Renderer                                  |
+ * |---------------------------------------|-------------------------------------------|
+ * | dataset-bound (dataset / blocks)      | <DatasetReportRenderer>                   |
+ * | pre-9.0 spec report (stored JSON)     | specReportToPresentation → <ReportViewer> |
+ * | legacy presentation ({data, columns}) | <LegacyReportRenderer>                    |
+ *
+ * The pre-9.0 query-form renderers (SpecReportGrid / MatrixRenderer /
+ * JoinedReportRenderer) were retired with the cutover — stored old-shape JSON
+ * renders through the lossy {@link specReportToPresentation} bridge until it
+ * is migrated to a dataset binding.
+ */
+import * as React from 'react';
+export type ReportRendererSchema = SpecReport | LegacyReportRendererProps['schema'];
+export interface ReportRendererProps {
+    /** Either a spec `Report` (dataset-bound) or a legacy presentation schema. */
+    schema: ReportRendererSchema;
+    /** Required for dataset-bound reports unless the host pre-fetched rows. */
+    dataSource?: DataSource | Record<string, unknown>;
+    /** Pre-fetched rows — feeds the pre-9.0 / legacy presentation paths. */
+    rows?: Array<Record<string, unknown>>;
+    /** Runtime filter merged on top of the report's own scope filter. */
+    runtimeFilter?: Record<string, unknown>;
+    /**
+     * Drill-down sink for dataset-bound reports (ADR-0021 D2) — rows/cells
+     * become clickable when provided. The host resolves the dataset's object
+     * and dimension→field mapping and navigates to the underlying records.
+     */
+    onDrill?: (args: DatasetDrillArgs) => void;
+    /** Optional class for the outer container. */
+    className?: string;
+}
+export declare const ReportRenderer: React.FC<ReportRendererProps>;

package/dist/{packages/plugin-report/src/ReportViewer.d.ts → ReportViewer.d.ts}

@@ -1,5 +1,5 @@
 import { default as React } from 'react';
-import { ReportViewerSchema } from '../../types/src';
+import { ReportViewerSchema } from '@object-ui/types';
 export interface ReportViewerProps {
     schema: ReportViewerSchema;
     /** Callback to refresh data */

package/dist/{packages/plugin-report/src/formatValue.d.ts → formatValue.d.ts}

@@ -1,4 +1,4 @@
-import { ReportField } from '../../types/src';
+import { ReportField } from '@object-ui/types';
 /**
  * Format a cell value based on the field definition.
  * Handles number (with thousand separators), currency, percent, and date formatting.

package/dist/index.d.ts

@@ -1,2 +1,13 @@
-export * from './packages/plugin-report/src/index'
-export {}
+import { ReportRenderer } from './ReportRenderer';
+import { LegacyReportRenderer } from './LegacyReportRenderer';
+import { ReportViewer } from './ReportViewer';
+import { DatasetReportRenderer, isDatasetReport } from './DatasetReportRenderer';
+export { ReportRenderer, LegacyReportRenderer, ReportViewer, DatasetReportRenderer, isDatasetReport };
+export type { ReportRendererProps, ReportRendererSchema } from './ReportRenderer';
+export type { LegacyReportRendererProps } from './LegacyReportRenderer';
+export type { DatasetReportRendererProps, DatasetDrillArgs } from './DatasetReportRenderer';
+export { formatValue } from './formatValue';
+export { exportReport, exportAsCSV, exportAsJSON, exportAsHTML, exportAsPDF, exportAsExcel } from './ReportExportEngine';
+export { exportWithLiveData, exportExcelWithFormulas, createScheduleTrigger, } from './LiveReportExporter';
+export type { LiveExportOptions, LiveExportResult, ExcelColumnConfig, ScheduleTriggerCallback, } from './LiveReportExporter';
+export { mergeFilters } from './mergeFilters';