@firestitch/report 18.7.0 → 18.8.1

package/app/reports/components/component-kpi/component-kpi.component.d.ts

@@ -1,11 +1,20 @@
+import { ReportKpiTrend } from '../../enums/report-kpi-trend.enum';
 import { ComponentData, ReportComponent } from '../../interfaces/report.interface';
 import * as i0 from "@angular/core";
 export declare class ComponentKpiComponent {
     readonly component: import("@angular/core").InputSignal<ReportComponent>;
     readonly data: import("@angular/core").InputSignal<ComponentData>;
-    readonly label: import("@angular/core").Signal<string>;
-    readonly value: import("@angular/core").Signal<string>;
-    private readonly _config;
+    readonly ReportKpiTrend: typeof ReportKpiTrend;
+    readonly tokens: {
+        valueSize: string;
+        text: string;
+        good: string;
+        bad: string;
+        neutral: string;
+        sparkline: string;
+    };
+    readonly view: import("@angular/core").Signal<import("../../kpi-card").KpiCardView>;
+    readonly hasNote: import("@angular/core").Signal<boolean>;
     private readonly _filterState;
     static ɵfac: i0.ɵɵFactoryDeclaration<ComponentKpiComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ComponentKpiComponent, "app-report-component-kpi", never, { "component": { "alias": "component"; "required": true; "isSignal": true; }; "data": { "alias": "data"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;

package/app/reports/components/component-kpi/components/sparkline/sparkline.component.d.ts

@@ -0,0 +1,8 @@
+import * as i0 from "@angular/core";
+export declare class SparklineComponent {
+    readonly values: import("@angular/core").InputSignal<number[]>;
+    readonly partial: import("@angular/core").InputSignal<boolean>;
+    readonly geometry: import("@angular/core").Signal<import("../../../../kpi-card").KpiSparklineGeometry>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SparklineComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SparklineComponent, "app-component-kpi-sparkline", never, { "values": { "alias": "values"; "required": false; "isSignal": true; }; "partial": { "alias": "partial"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}

package/app/reports/components/component-list/component-list.component.d.ts

@@ -2,7 +2,8 @@ import { OnInit } from '@angular/core';
 import { FsListComponent, FsListConfig } from '@firestitch/list';
 import { ReportListColumnFormat } from '../../enums/report-list-column-format.enum';
 import { ListColumn, ReportComponent } from '../../interfaces/report.interface';
-import { columnClasses } from '../../list-config';
+import { ListOutputColumn, columnClasses } from '../../list-config';
+import { ComponentNoteData } from '../../output-notes';
 import * as i0 from "@angular/core";
 export declare class ComponentListComponent implements OnInit {
     readonly reportId: import("@angular/core").InputSignal<number>;
@@ -18,6 +19,7 @@ export declare class ComponentListComponent implements OnInit {
     readonly showTotals: import("@angular/core").WritableSignal<boolean>;
     readonly totals: import("@angular/core").WritableSignal<Record<string, unknown>>;
     readonly totalsNote: import("@angular/core").WritableSignal<string>;
+    readonly noteData: import("@angular/core").WritableSignal<ComponentNoteData>;
     readonly rowCount: import("@angular/core").WritableSignal<{
         shown: number;
         total: number;
@@ -29,6 +31,8 @@ export declare class ComponentListComponent implements OnInit {
     readonly columnClasses: typeof columnClasses;
     readonly hidden: import("@angular/core").Signal<Set<string>>;
     readonly totalLabel = "Total";
+    readonly outputColumns: import("@angular/core").Signal<Record<string, ListOutputColumn>>;
+    readonly columnNotes: import("@angular/core").Signal<Record<string, string>>;
     readonly totalsLabelColumn: import("@angular/core").Signal<string>;
     readonly caption: import("@angular/core").Signal<string>;
     private _reportData;
@@ -42,6 +46,8 @@ export declare class ComponentListComponent implements OnInit {
     private _initListConfig;
     private _fetch;
     private _pivotColumns;
+    private _noteData;
+    private _alignOutputColumns;
     private _observePinOffsets;
     private _schedulePinOffsets;
     private _updatePinOffsets;

package/app/reports/components/component-note/component-note.component.d.ts

@@ -0,0 +1,12 @@
+import { ComponentNoteData } from '../../output-notes';
+import * as i0 from "@angular/core";
+export declare class ComponentNoteComponent {
+    readonly data: import("@angular/core").InputSignal<ComponentNoteData>;
+    readonly windows: import("@angular/core").InputSignal<boolean>;
+    readonly windowDescriptions: import("@angular/core").InputSignal<boolean>;
+    readonly windowNotes: import("@angular/core").InputSignal<boolean>;
+    readonly lines: import("@angular/core").Signal<string[]>;
+    private readonly _filterState;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ComponentNoteComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ComponentNoteComponent, "app-report-component-note", never, { "data": { "alias": "data"; "required": false; "isSignal": true; }; "windows": { "alias": "windows"; "required": false; "isSignal": true; }; "windowDescriptions": { "alias": "windowDescriptions"; "required": false; "isSignal": true; }; "windowNotes": { "alias": "windowNotes"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
+}

package/app/reports/components/report-canvas/report-canvas.component.d.ts

@@ -39,7 +39,6 @@ export declare class ReportCanvasComponent implements OnChanges, AfterViewInit {
     private _viewport;
     private _guides;
     readonly PX = 96;
-    readonly flowPadding = 0.25;
     readonly pages: import("@angular/core").WritableSignal<ReportPage[]>;
     readonly activePageIndex: import("@angular/core").WritableSignal<number>;
     readonly zoom: import("@angular/core").WritableSignal<number>;
@@ -58,7 +57,6 @@ export declare class ReportCanvasComponent implements OnChanges, AfterViewInit {
     ngOnChanges(changes: SimpleChanges): void;
     get headingSizePx(): number;
     ngAfterViewInit(): void;
-    get isFlow(): boolean;
     get activePage(): ReportPage | null;
     get bands(): ReportHeaderFooter;
     get masterComponents(): ReportComponent[];
@@ -70,7 +68,6 @@ export declare class ReportCanvasComponent implements OnChanges, AfterViewInit {
     addText(): void;
     onComponentRemoved(componentId: number): void;
     toggleMasterHidden(page: ReportPage): void;
-    get flowComponents(): ReportComponent[];
     selectPage(index: number): void;
     addPage(): void;
     pageLabel(page: ReportPage, index: number): string;
@@ -88,12 +85,6 @@ export declare class ReportCanvasComponent implements OnChanges, AfterViewInit {
     onPositionChanged(position: {
         componentId: number;
     } & Record<string, number>): void;
-    onFlowReorder(event: {
-        componentId: number;
-        clientX: number;
-        clientY: number;
-    }): void;
-    private _flowDropIndex;
     private get _snapThreshold();
     private _snapMove;
     private _snapResize;

package/app/reports/components/report-component/report-component.component.d.ts

@@ -1,6 +1,6 @@
 import { EventEmitter, OnChanges, OnInit, SimpleChanges } from '@angular/core';
 import { FilterConfig } from '@firestitch/filter';
-import { ComponentData, ComponentSettings, ReportComponent as ReportComponentModel, ReportFilterGroup, ReportLayout } from '../../interfaces/report.interface';
+import { ComponentData, ComponentSettings, ReportComponent as ReportComponentModel, ReportFilterGroup } from '../../interfaces/report.interface';
 import { ComponentChartComponent } from '../component-chart/component-chart.component';
 import { TextTokenContext } from '../../text';
 import { CanvasSnapper } from '../report-canvas/report-canvas.component';
@@ -12,7 +12,6 @@ export declare class ReportComponentComponent implements OnInit, OnChanges {
     component: ReportComponentModel;
     groups: Map<number, ReportFilterGroup>;
     editMode: boolean;
-    layout: ReportLayout;
     zoom: number;
     snapper: CanvasSnapper | null;
     selected: boolean;
@@ -20,11 +19,6 @@ export declare class ReportComponentComponent implements OnInit, OnChanges {
     positionChanged: EventEmitter<{
         componentId: number;
     } & Record<string, number>>;
-    flowReorder: EventEmitter<{
-        componentId: number;
-        clientX: number;
-        clientY: number;
-    }>;
     openSettings: EventEmitter<ReportComponentModel>;
     readonly tokens: import("@angular/core").InputSignal<TextTokenContext>;
     readonly removed: import("@angular/core").OutputEmitterRef<number>;
@@ -66,8 +60,6 @@ export declare class ReportComponentComponent implements OnInit, OnChanges {
     onDragStart(event: PointerEvent): void;
     onResizeStart(event: PointerEvent, handle: Handle): void;
     private _buildFilterConfig;
-    private _flowResize;
-    private _flowDrag;
     private _origin;
     private _track;
     private _emitGeometry;
@@ -76,10 +68,9 @@ export declare class ReportComponentComponent implements OnInit, OnChanges {
     get heightAuto(): boolean;
     private _inches;
     private _round;
-    private _snapFlowWidth;
     private _applyGeometry;
     private _load;
     static ɵfac: i0.ɵɵFactoryDeclaration<ReportComponentComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ReportComponentComponent, "app-report-component", never, { "reportId": { "alias": "reportId"; "required": false; }; "component": { "alias": "component"; "required": false; }; "groups": { "alias": "groups"; "required": false; }; "editMode": { "alias": "editMode"; "required": false; }; "layout": { "alias": "layout"; "required": false; }; "zoom": { "alias": "zoom"; "required": false; }; "snapper": { "alias": "snapper"; "required": false; }; "selected": { "alias": "selected"; "required": false; }; "tokens": { "alias": "tokens"; "required": false; "isSignal": true; }; }, { "selectComponent": "selectComponent"; "positionChanged": "positionChanged"; "flowReorder": "flowReorder"; "openSettings": "openSettings"; "removed": "removed"; }, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ReportComponentComponent, "app-report-component", never, { "reportId": { "alias": "reportId"; "required": false; }; "component": { "alias": "component"; "required": false; }; "groups": { "alias": "groups"; "required": false; }; "editMode": { "alias": "editMode"; "required": false; }; "zoom": { "alias": "zoom"; "required": false; }; "snapper": { "alias": "snapper"; "required": false; }; "selected": { "alias": "selected"; "required": false; }; "tokens": { "alias": "tokens"; "required": false; "isSignal": true; }; }, { "selectComponent": "selectComponent"; "positionChanged": "positionChanged"; "openSettings": "openSettings"; "removed": "removed"; }, never, never, true, never>;
 }
 export {};

package/app/reports/data/report.data.d.ts

@@ -46,8 +46,6 @@ export declare class ReportData<T = any> {
         y: number;
         w: number;
         h: number;
-        flowWidth: number;
-        order: number;
     }>)[], config?: RequestConfig): Observable<T>;
     componentData(reportId: number, componentId: number, filters?: ResolvedFilterValue[], state?: ComponentDataState, isExport?: boolean, config?: RequestConfig): Observable<T>;
     exportComponent(reportId: number, componentId: number, filters?: ResolvedFilterValue[], state?: ComponentDataState, config?: RequestConfig): Observable<ComponentExportResponse>;

package/app/reports/dialogs/component-settings/component-settings.component.d.ts

@@ -1,11 +1,17 @@
 import { EventEmitter, OnInit } from '@angular/core';
+import { AbstractControl } from '@angular/forms';
 import { Observable } from 'rxjs';
-import { ComponentSettings, Report, ReportComponent, ReportFilterType } from '../../interfaces/report.interface';
+import { ReportChangePolarity } from '../../enums/report-change-polarity.enum';
+import { ChartGranularity, ComponentSettings, Report, ReportComponent, ReportFilterType } from '../../interfaces/report.interface';
 import * as i0 from "@angular/core";
 export interface ComponentSettingsResult {
     settings?: ComponentSettings;
     deleted?: boolean;
 }
+interface ComponentSettingsResponse {
+    id: number;
+    config?: Record<string, unknown> | null;
+}
 interface FilterRow {
     column: string;
     type: ReportFilterType;
@@ -24,6 +30,25 @@ export declare class ComponentSettingsComponent implements OnInit {
     paddingBottom: number | string;
     paddingLeft: number | string;
     configJson: string;
+    readonly kpiPolarityOptions: {
+        value: ReportChangePolarity;
+        name: string;
+    }[];
+    readonly granularityOptions: {
+        value: ChartGranularity;
+        name: string;
+    }[];
+    readonly sparklineMinPeriods = 2;
+    readonly sparklineMaxPeriods = 60;
+    readonly kpiCard: import("@angular/core").WritableSignal<boolean>;
+    readonly increaseIs: import("@angular/core").WritableSignal<ReportChangePolarity>;
+    readonly targetValue: import("@angular/core").WritableSignal<string | number>;
+    readonly targetLabel: import("@angular/core").WritableSignal<string>;
+    readonly targetPercent: import("@angular/core").WritableSignal<boolean>;
+    readonly hasTarget: import("@angular/core").Signal<boolean>;
+    readonly sparkline: import("@angular/core").WritableSignal<boolean>;
+    readonly sparklineGranularity: import("@angular/core").WritableSignal<ChartGranularity>;
+    readonly sparklinePeriods: import("@angular/core").WritableSignal<string | number>;
     readonly sql: import("@angular/core").WritableSignal<string>;
     readonly sqlBaseline: import("@angular/core").WritableSignal<boolean>;
     readonly sqlTimezone: import("@angular/core").WritableSignal<string>;
@@ -43,8 +68,15 @@ export declare class ComponentSettingsComponent implements OnInit {
     ngOnInit(): void;
     typeLabel(type: ReportFilterType): string;
     delete(): void;
-    save: () => Observable<any>;
+    validateTarget: (control: AbstractControl) => void;
+    save: () => Observable<ComponentSettingsResponse>;
     setExposure(row: FilterRow, target: 'report' | 'component', on: boolean): void;
+    private _seedKpiCard;
+    private _savedKpiCard;
+    private _kpiCardSettings;
+    private _targetShown;
+    private _targetStored;
+    private _number;
     private _padding;
     private _run;
     private _rebuildRows;

package/app/reports/dialogs/report-settings/report-settings.component.d.ts

@@ -36,7 +36,6 @@ export declare class ReportSettingsComponent implements OnInit {
     headerHeight: number | string;
     footerHeight: number | string;
     readonly headerFooterMax = 3;
-    layout: 'freeform' | 'flow';
     timezone: string;
     headingSize: number;
     readonly locales: import("@angular/core").WritableSignal<ReportLocales>;

package/app/reports/enums/report-change-polarity.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum ReportChangePolarity {
+    Good = "good",
+    Bad = "bad",
+    Neutral = "neutral"
+}

package/app/reports/enums/report-kpi-trend.enum.d.ts

@@ -0,0 +1,5 @@
+export declare enum ReportKpiTrend {
+    Up = "up",
+    Down = "down",
+    Flat = "flat"
+}

package/app/reports/export/report-export-collector.service.d.ts

@@ -1,5 +1,7 @@
 import { Observable } from 'rxjs';
 import { ComponentData, ListColumn, Report, ReportComponent, ReportFormatContext, ReportLocaleTag, ReportPage } from '../interfaces/report.interface';
+import { KpiCardView } from '../kpi-card';
+import { ListOutputColumn } from '../list-config';
 import * as i0 from "@angular/core";
 export interface CollectedComponent {
     component: ReportComponent;
@@ -20,15 +22,41 @@ export interface CollectedReport {
 }
 export type ExportListColumn = ListColumn & {
     numeric: boolean;
+    output?: ListOutputColumn;
 };
+export interface KpiExportHeights {
+    value: number;
+    label: number;
+    delta: number;
+    window: number;
+    target: number;
+    sparkline: number;
+    note: number;
+}
+export interface KpiExportParts {
+    delta: boolean;
+    window: boolean;
+    target: boolean;
+    sparkline: boolean;
+    notes: string[];
+    scale: number;
+}
 export declare function emptyLabel(item: CollectedComponent): string;
 export declare function exportTitle(component: ReportComponent, search?: string | null): string;
 export declare function isFailed(item: CollectedComponent): boolean;
 export declare function coverLines(collected: CollectedReport): string[];
-export declare function exportCell(value: unknown, column: ListColumn, timezone: string, context: ReportFormatContext): string;
+export declare function exportCell(value: unknown, column: ListColumn & {
+    output?: ListOutputColumn;
+}, timezone: string, context: ReportFormatContext, row?: Record<string, unknown> | null): string;
 export declare function listColumns(component: ReportComponent, data: ComponentData, locale: ReportLocaleTag, hidden?: readonly string[]): ExportListColumn[];
 export declare function listHeadings(component: ReportComponent, data: ComponentData, locale: ReportLocaleTag, hidden?: readonly string[]): string[];
 export declare function listTotalsRow(data: ComponentData, columns: readonly ExportListColumn[], timezone: string, context: ReportFormatContext): string[] | null;
+export declare function exportWindowsLine(item: CollectedComponent, timezone: string, locale: ReportLocaleTag): string;
+export declare function exportNoteLines(item: CollectedComponent, timezone: string, locale: ReportLocaleTag): string[];
+export declare function kpiCardHasExtras(view: KpiCardView, notes: readonly string[]): boolean;
+export declare function kpiExportParts(view: KpiCardView, notes: readonly string[], available: number, heights: KpiExportHeights): KpiExportParts;
+export declare function scaledKpiHeights(heights: KpiExportHeights, scale: number): KpiExportHeights;
+export declare function kpiExportHeight(view: KpiCardView, parts: KpiExportParts, heights: KpiExportHeights): number;
 export declare function moreRowsNotice(remaining: number): string;
 export declare function failedPageNames(collected: CollectedReport): string[];
 export declare class ReportExportCollectorService {

package/app/reports/export/report-pdf.service.d.ts

@@ -15,6 +15,8 @@ export declare class ReportPdfService {
     private _alignOffset;
     private _tokens;
     private _renderComponent;
+    private _smallLine;
+    private _fit;
     private _componentTitle;
     private _boxNote;
     private _renderTable;
@@ -27,6 +29,9 @@ export declare class ReportPdfService {
     private _continuationMargin;
     private _continuedTitle;
     private _renderKpi;
+    private _kpiDelta;
+    private _kpiTarget;
+    private _kpiSparkline;
     private _pdfText;
     private _slug;
     static ɵfac: i0.ɵɵFactoryDeclaration<ReportPdfService, never>;

package/app/reports/export/report-pptx.service.d.ts

@@ -10,6 +10,7 @@ export declare class ReportPptxService {
     private _renderText;
     private _tokens;
     private _renderComponent;
+    private _lineRuns;
     private _renderChart;
     private _legendPosition;
     private _referenceLines;
@@ -19,6 +20,7 @@ export declare class ReportPptxService {
     private _withDataLabels;
     private _percentAxisOptions;
     private _twoAxesOptions;
+    private _rankAxisOptions;
     private _categoryOrderOptions;
     private _valueAxisCode;
     private _addChart;
@@ -33,6 +35,11 @@ export declare class ReportPptxService {
     private _valueAxisRangeOptions;
     private _renderTable;
     private _renderKpi;
+    private _kpiDelta;
+    private _estimatedWidth;
+    private _fitEstimate;
+    private _kpiTarget;
+    private _kpiSparkline;
     private _slug;
     static ɵfac: i0.ɵɵFactoryDeclaration<ReportPptxService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ReportPptxService>;

package/app/reports/format.d.ts

@@ -1,5 +1,5 @@
 import { ReportNumberUnits } from './enums/report-number-units.enum';
-import { ChartMeasure, NumberFormatSpec, Report, ReportCurrencyCode, ReportFormatContext, ReportLocaleTag } from './interfaces/report.interface';
+import { ChartGranularity, ChartMeasure, ComparisonAgainst, ComparisonNoteCode, ComparisonOffset, ComparisonWindow, ComponentComparison, KpiNoteCode, NumberFormatSpec, OutputMeta, OutputRole, Report, ReportCurrencyCode, ReportFormatContext, ReportLocaleTag, WindowMeta, WindowNoteCode } from './interfaces/report.interface';
 export declare const REPORT_FALLBACK_LOCALE: ReportLocaleTag;
 export declare const REPORT_FALLBACK_CURRENCY: ReportCurrencyCode;
 export declare const DEFAULT_FORMAT_CONTEXT: Readonly<ReportFormatContext>;
@@ -13,6 +13,7 @@ export interface FormatNumberOptions {
     empty?: string;
     units?: ResolvedUnits;
     decimals?: number | null;
+    signed?: boolean;
 }
 export interface ChartNumberFormat {
     units: ResolvedUnits;
@@ -22,6 +23,18 @@ export declare function toFiniteNumber(value: unknown): number | null;
 export declare function hasNumberFormat(spec?: NumberFormatSpec | null): boolean;
 export declare function resolveUnits(units: ReportNumberUnits | null | undefined, magnitude: number, decimals: number): ResolvedUnits;
 export declare function formatNumber(value: unknown, spec: NumberFormatSpec | null | undefined, context: ReportFormatContext, options?: FormatNumberOptions): string;
+export interface OutputValueOptions {
+    measureSpec?: NumberFormatSpec | null;
+    prior?: unknown;
+    floor?: string | null;
+    empty?: string;
+}
+export interface FormattedOutputValue {
+    text: string;
+    title: string | null;
+}
+export declare function formatOutputValue(value: unknown, output: OutputMeta | null | undefined, spec: NumberFormatSpec | null | undefined, context: ReportFormatContext, options?: OutputValueOptions): FormattedOutputValue;
+export declare function laneOutputAlias(outputs: Record<string, OutputMeta> | null | undefined, alias: string, role: OutputRole): string | null;
 export declare function axisNumberFormat(measures: ChartMeasure[]): NumberFormatSpec | null;
 export declare function resolveChartNumberFormat(spec: NumberFormatSpec, peak: number, context: ReportFormatContext): ChartNumberFormat;
 export declare function numberFormatCode(spec: NumberFormatSpec, context: ReportFormatContext, chart: ChartNumberFormat, series: (number | null)[][], stacked: boolean): string;
@@ -37,7 +50,22 @@ export declare const MONTH_YEAR: Intl.DateTimeFormatOptions;
 export declare const MONTH_DAY: Intl.DateTimeFormatOptions;
 export declare function formatLocalDate(date: Date, locale: ReportLocaleTag, options: Intl.DateTimeFormatOptions, timeZone?: string): string;
 export declare function formatReportDate(value: unknown, timezone: string, locale: ReportLocaleTag): string;
+export declare const TIME_SHORT: Intl.DateTimeFormatOptions;
+export declare function formatDayRange(start: string | null | undefined, end: string | null | undefined, locale: ReportLocaleTag, options?: Intl.DateTimeFormatOptions): string;
+export declare function formatThroughTime(through: string | null | undefined, timezone: string, locale: ReportLocaleTag): string;
+export declare function formatDayWindow(meta: {
+    start: string | null;
+    end: string | null;
+    through?: string | null;
+}, timezone: string, locale: ReportLocaleTag): string;
+export declare function isReadOnOneDay(comparison: ComponentComparison | null | undefined): boolean;
+export declare function formatReadingDay(window: Pick<ComparisonWindow, 'end'>, locale: ReportLocaleTag, lead?: boolean): string;
 export declare function localeName(tag: ReportLocaleTag): string;
 export declare function currencyName(code: ReportCurrencyCode): string;
+export declare function comparisonOffsetLabel(offset: ComparisonOffset): string;
+export declare function comparisonNoteText(code: ComparisonNoteCode, comparison?: ComponentComparison | null): string;
+export declare function windowText(meta: WindowMeta, locale: ReportLocaleTag, granularity?: ChartGranularity | null): string;
+export declare function windowNoteText(code: WindowNoteCode, meta: WindowMeta, locale: ReportLocaleTag, granularity?: ChartGranularity | null): string;
+export declare function kpiNoteText(code: KpiNoteCode, against?: ComparisonAgainst | null): string;
 export declare function getTimezoneLabel(timezone: string): string;
 export declare function getZonedNow(timezone: string): Date;

package/app/reports/interfaces/report-chat-viewer-filter.interface.d.ts

@@ -1,7 +1,9 @@
+import { ReportRelativeRange } from './report.interface';
 export interface ReportChatViewerFilter {
     groupId: number;
     start?: string;
     end?: string;
     values?: unknown[];
     value?: string;
+    preset?: ReportRelativeRange;
 }

package/app/reports/interfaces/report.interface.d.ts

@@ -1,3 +1,4 @@
+import { ReportChangePolarity } from '../enums/report-change-polarity.enum';
 import { ReportChartColor } from '../enums/report-chart-color.enum';
 import { ReportChartDataLabels } from '../enums/report-chart-data-labels.enum';
 import { ReportChartDateLabel } from '../enums/report-chart-date-label.enum';
@@ -6,13 +7,11 @@ import { ReportChartMarkStat } from '../enums/report-chart-mark-stat.enum';
 import { ReportListColumnFormat } from '../enums/report-list-column-format.enum';
 import { ReportNumberUnits } from '../enums/report-number-units.enum';
 import { ReportValueFormat } from '../enums/report-value-format.enum';
-export type ReportLayout = 'freeform' | 'flow';
 export type ReportLocaleTag = string;
 export type ReportCurrencyCode = string;
 export interface Report {
     id: number;
     name: string;
-    layout: ReportLayout;
     timezone: string | null;
     effectiveTimezone?: string;
     locale?: ReportLocaleTag | null;
@@ -87,8 +86,6 @@ export interface ReportComponent {
     w: number;
     h: number;
     autoHeight: boolean;
-    flowWidth: number;
-    order: number;
     sql: string | null;
     config: ChartConfig & ListConfig & KpiConfig & TextConfig & ComponentLayoutConfig & Record<string, unknown>;
     filters: ReportFilter[];
@@ -110,6 +107,12 @@ export interface ComponentLayoutConfig {
 export interface ComponentSettings {
     title: string;
     padding: ComponentPadding;
+    kpi?: KpiCardSettings;
+}
+export interface KpiCardSettings {
+    increaseIs: ReportChangePolarity | null;
+    target: KpiTargetConfig | null;
+    sparkline: KpiSparklineConfig | null;
 }
 export type LegendPosition = 'top' | 'bottom' | 'left' | 'right' | 'hidden';
 export type ChartGranularity = 'day' | 'week' | 'month' | 'quarter' | 'year';
@@ -202,6 +205,17 @@ export interface ListConfig {
 }
 export interface KpiConfig {
     measure?: ChartMeasure;
+    increaseIs?: ReportChangePolarity | null;
+    target?: KpiTargetConfig | null;
+    sparkline?: KpiSparklineConfig | null;
+}
+export interface KpiTargetConfig {
+    value: number;
+    label?: string | null;
+}
+export interface KpiSparklineConfig {
+    granularity?: ChartGranularity | null;
+    periods?: number | null;
 }
 export interface ReportSort {
     column: string;
@@ -252,6 +266,7 @@ export interface FilterGroupValue {
     value?: string;
     preset?: string;
 }
+export type ReportRelativeRange = 'thisWeek' | 'lastWeek' | 'last7Days' | 'last30Days' | 'last3Months' | 'last6Months' | 'last12Months' | 'thisMonth' | 'thisQuarter' | 'thisYear' | 'yearToDate';
 export interface ReportUrlParams {
     groups: Map<number, string>;
     listSorts: Map<number, string>;
@@ -272,6 +287,7 @@ export interface ResolvedFilterValue {
     end?: string;
     values?: unknown[];
     value?: string;
+    preset?: ReportRelativeRange;
 }
 export interface ComponentDataState {
     sort?: ReportSort;
@@ -294,6 +310,110 @@ export interface ComponentData {
     searchNote?: string | null;
     totals?: Record<string, unknown> | null;
     totalsNote?: string | null;
+    timeframe?: ComponentTimeframe | null;
+    comparison?: ComponentComparison | null;
+    outputs?: Record<string, OutputMeta>;
+    cellMeasures?: Record<string, string>;
+    windows?: Record<string, WindowMeta>;
+    kpi?: ComponentKpi | null;
+    partialPeriod?: string | null;
+}
+export type TimeframeSource = 'filter' | 'range' | 'fixed' | 'none';
+export interface ComponentTimeframe {
+    column: string;
+    start: string | null;
+    end: string | null;
+    through: string | null;
+    range: ReportRelativeRange | null;
+    source: TimeframeSource;
+}
+export type ComparisonMode = 'range' | 'series' | 'period_end';
+export type ComparisonAlign = 'to_date' | 'full';
+export type ComparisonAgainst = 'previous_period' | 'previous_week' | 'previous_month' | 'previous_quarter' | 'previous_year' | 'range';
+export type ComparisonNoteCode = 'no_window' | 'unit_inferred' | 'window_in_future' | 'other_date_filter' | 'grain_followed';
+export interface ComparisonWindow {
+    start: string;
+    end: string;
+    through: string | null;
+}
+export interface ComparisonOffset {
+    against: ComparisonAgainst;
+    unit: ChartGranularity | null;
+    count: number | null;
+}
+export interface ComponentComparison {
+    mode: ComparisonMode;
+    timezone: string;
+    align: ComparisonAlign;
+    current: ComparisonWindow | null;
+    priors: ComparisonWindow[];
+    offsets: ComparisonOffset[];
+    floor: string | null;
+    notes: ComparisonNoteCode[];
+}
+export type OutputKind = 'value' | 'rank' | 'share';
+export type OutputRole = 'current' | 'prior' | 'change' | 'percent_change';
+export type OutputRankMethod = 'competition' | 'dense';
+export interface OutputRank {
+    method: OutputRankMethod;
+    direction: 'asc' | 'desc';
+    within: string[];
+}
+export interface OutputShare {
+    within: string[];
+}
+export interface OutputMeta {
+    measure: string;
+    kind: OutputKind;
+    role: OutputRole | null;
+    offset: number | null;
+    window: boolean;
+    rank: OutputRank | null;
+    share: OutputShare | null;
+}
+export type WindowKind = 'running' | 'to_date' | 'rolling';
+export type WindowNoteCode = 'snapped_start' | 'span_converted' | 'grain_too_coarse' | 'equal_grain_plain' | 'own_filter_caps_lead_in' | 'week_by_monday' | 'incomplete_head';
+export interface WindowMeta {
+    kind: WindowKind;
+    periods: number | null;
+    unit: ChartGranularity | null;
+    drawnPeriods: number | null;
+    resetEvery: ChartGranularity | null;
+    average: boolean;
+    fromBeginning: boolean;
+    dateColumn: string | null;
+    start: string | null;
+    end: string | null;
+    leadIn: string | null;
+    notes: WindowNoteCode[];
+    description: string;
+}
+export type KpiDeltaShow = 'change' | 'percent_change';
+export type KpiNoteCode = 'no_prior_data' | 'up_from_zero' | 'no_change' | 'no_data_either' | 'sign_change';
+export interface ComponentKpiTarget {
+    value: number;
+    label: string | null;
+    progress: number | null;
+    met: boolean | null;
+}
+export interface ComponentKpiSparklinePoint {
+    period: string;
+    value: number | null;
+}
+export interface ComponentKpiSparkline {
+    granularity: ChartGranularity;
+    partial: boolean;
+    points: ComponentKpiSparklinePoint[];
+}
+export interface ComponentKpi {
+    value: number | null;
+    prior: number | null;
+    change: number | null;
+    percentChange: number | null;
+    show: KpiDeltaShow;
+    note: KpiNoteCode | null;
+    target: ComponentKpiTarget | null;
+    sparkline: ComponentKpiSparkline | null;
 }
 export interface ComponentExportResponse {
     url: string;