@sisense/sdk-ui 2.31.1 → 2.32.0

package/dist/packages/sdk-ui/src/domains/dashboarding/common-filters/utils.d.ts

@@ -22,5 +22,5 @@ type GetWidgetDataOptionsWithDrilldownParams = {
  * @param params.drilldownOptions - The drilldown options of the widget.
  * @returns The widget data options with drilldown applied.
  */
-export declare function getWidgetDataOptionsWithDrilldown({ widgetType, chartType, dataOptions, drilldownOptions, }: GetWidgetDataOptionsWithDrilldownParams): import('../../../index.js').CategoricalChartDataOptions | import('../../../index.js').ScatterChartDataOptions | import('../../../index.js').IndicatorChartDataOptions | import('../../../index.js').BoxplotChartDataOptions | import('../../../index.js').BoxplotChartCustomDataOptions | import('../../../index.js').AreamapChartDataOptions | import('../../../index.js').ScattermapChartDataOptions | import('../../../index.js').RangeChartDataOptions | import('../../../index.js').CalendarHeatmapChartDataOptions | import('../../../index.js').SankeyChartDataOptions | import('../../../index.js').TableDataOptions | PivotTableDataOptions | GenericDataOptions;
+export declare function getWidgetDataOptionsWithDrilldown({ widgetType, chartType, dataOptions, drilldownOptions, }: GetWidgetDataOptionsWithDrilldownParams): import('../../../index.js').CategoricalChartDataOptions | import('../../../index.js').ScatterChartDataOptions | import('../../../index.js').IndicatorChartDataOptions | import('../../../index.js').BoxplotChartDataOptions | import('../../../index.js').BoxplotChartCustomDataOptions | import('../../../index.js').AreamapChartDataOptions | import('../../../index.js').ScattermapChartDataOptions | import('../../../index.js').RangeChartDataOptions | import('../../../index.js').CalendarHeatmapChartDataOptions | import('../../../index.js').SankeyChartDataOptions | import('../../../index.js').KpiChartDataOptions | import('../../../index.js').TableDataOptions | PivotTableDataOptions | GenericDataOptions;
 export {};

package/dist/packages/sdk-ui/src/domains/dashboarding/types.d.ts

@@ -67,8 +67,10 @@ export interface DashboardWidgetsDeletedEvent {
     payload: string[];
 }
 /**
- * Event triggered when a FilterWidget's date granularity is changed on the dashboard.
- * Lets an embedding host sync the widget's stored dimension metadata to the new level.
+ * `DashboardWidgetDateLevelChangedEvent` is emitted when a filter widget's date
+ * granularity is changed on the dashboard, letting an embedding host sync the widget's
+ * stored dimension metadata to the new level. The payload carries the affected widget's
+ * `oid` plus a JAQL-level descriptor of the new date granularity.
  *
  * @beta
  */
@@ -239,15 +241,29 @@ export interface WidgetsPanelConfig {
             enabled?: boolean;
         };
         /**
-         * Configuration for downloading widget data as Excel.
+         * Configuration for the "Download as Excel" action on all widgets in the panel,
+         * which adds an item to each widget's header menu that exports the widget's
+         * underlying data as an Excel (XLSX) file.
          *
-         * @sisenseInternal
+         * @example
+         * Enable Excel download for every widget in a dashboard:
+         * ```ts
+         * const dashboardConfig: DashboardConfig = {
+         *   widgetsPanel: {
+         *     actions: {
+         *       downloadExcel: {
+         *         enabled: true,
+         *       },
+         *     },
+         *   },
+         * };
+         * ```
          */
         downloadExcel?: {
             /**
-             * Determines whether the widgets possibility to download Excel is enabled.
+             * Whether the "Download as Excel" action is enabled for all widgets in the panel.
              *
-             * If not specified, the default value is `false`.
+             * @default false
              */
             enabled?: boolean;
         };

package/dist/packages/sdk-ui/src/domains/query-execution/types.d.ts

@@ -386,6 +386,8 @@ export interface ExecuteCsvQueryParams extends Omit<ExecuteQueryParams, 'include
 }
 /**
  * Parameters for {@link useExecuteExcelQueryInternal} (JAQL XLSX export).
+ *
+ * @internal
  */
 export interface ExecuteExcelQueryParams extends Omit<ExecuteQueryParams, 'includeRowCount'> {
     /** `false` = repeat rows (Angular default); `true` = merge rows. */

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/components/regular-chart/has-no-results.d.ts

@@ -0,0 +1,12 @@
+import { ChartData } from '../../../../../../domains/visualizations/core/chart-data/types';
+import { ChartType } from '../../../../../../types';
+/**
+ * Returns whether prepared chart data has nothing to visualize
+ * (triggers the no-results overlay).
+ *
+ * @param chartType - Chart type used to interpret `chartData`.
+ * @param chartData - Prepared chart data for that type.
+ * @returns `true` when the chart should show an empty / no-results state.
+ * @internal
+ */
+export declare function hasNoResults(chartType: ChartType, chartData: ChartData): boolean;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/components/sisense-chart/sisense-chart.d.ts

@@ -4,6 +4,6 @@ import { SisenseChartProps, SisenseChartType } from './types.js';
 /**
  * @internal
  */
-export declare const SisenseChart: ({ chartType, chartData, dataOptions, designOptions, onDataPointClick, onDataPointContextMenu, onDataPointsSelected, onBeforeRender, size, }: SisenseChartProps) => import("react/jsx-runtime").JSX.Element | null;
+export declare const SisenseChart: ({ chartType, chartData, dataOptions, designOptions, onDataPointClick, onDataPointContextMenu, onDataPointsSelected, onBeforeRender, onReady, size, }: SisenseChartProps) => import("react/jsx-runtime").JSX.Element | null;
 export declare const isSisenseChartType: (chartType: ChartType) => chartType is SisenseChartType;
 export declare const isSisenseChartProps: (props: ChartRendererProps) => props is SisenseChartProps;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/components/sisense-chart/types.d.ts

@@ -15,6 +15,14 @@ export interface SisenseChartProps {
     onDataPointContextMenu?: SisenseChartDataPointEventHandler;
     onDataPointsSelected?: SisenseChartDataPointsEventHandler;
     onBeforeRender?: BeforeRenderHandler;
+    /**
+     * Called when Highcharts finishes painting the chart (`chart.events.load` /
+     * `render`). Used by RegularChart as the paint signal for the shared chart
+     * `onReady` readiness contract (see `BaseChartEventProps.onReady` in props).
+     *
+     * @internal
+     */
+    onReady?: () => void;
     size?: {
         width?: number;
         height?: number;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/helpers/use-chart-on-ready.d.ts

@@ -0,0 +1,38 @@
+import { ChartData } from '../../../../../domains/visualizations/core/chart-data/types';
+import { ChartType } from '../../../../../types';
+type UseChartOnReadyInput = {
+    chartType: ChartType;
+    /** Whether a query / data sync is in progress. */
+    isLoading: boolean;
+    /** Whether data options have no attributes or measures. */
+    hasNoDimensions: boolean;
+    /** Prepared chart data, or `null` while unavailable. */
+    chartData: ChartData | null;
+    /** Consumer `onReady` callback to fire on each rising edge of readiness. */
+    onReady?: () => void;
+};
+type UseChartOnReadyResult = {
+    /**
+     * Paint signal handler to forward to the renderer via
+     * `ChartRendererProps.onReady`, or `undefined` when the chart type does not
+     * participate in the `onReady` contract.
+     */
+    onRendererReady: (() => void) | undefined;
+};
+/**
+ * Wires the shared chart `onReady` (Fusion `domready` / PDF) readiness contract.
+ *
+ * Chart types opt in by declaring `onReady` on their `ChartBuilder`; this
+ * hook tracks the renderer paint flag, feeds it into the builder's readiness
+ * predicate together with the loading / data signals, and fires the consumer
+ * `onReady` callback via {@link useFireOnReady} on each rising edge. Chart types
+ * without the contract get a no-op (`onRendererReady` is `undefined`).
+ *
+ * Readiness lives here rather than inside the renderer because `onReady` must
+ * still fire in the empty / no-results case, where RegularChart shows a terminal
+ * overlay and the renderer never mounts.
+ *
+ * @internal
+ */
+export declare function useChartOnReady({ chartType, isLoading, hasNoDimensions, chartData, onReady, }: UseChartOnReadyInput): UseChartOnReadyResult;
+export {};

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/helpers/use-chart-renderer-props.d.ts

@@ -15,6 +15,7 @@ type UnpreparedInternalChartProps = {
     onDataPointContextMenu?: ChartProps['onDataPointContextMenu'];
     onDataPointsSelected?: ChartProps['onDataPointsSelected'];
     onBeforeRender?: ChartProps['onBeforeRender'];
+    onReady?: ChartProps['onReady'];
     filters?: ChartProps['filters'];
 };
 /**

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/highcharts-based-chart-renderer/highcharts-based-chart-renderer.d.ts

@@ -14,6 +14,14 @@ export type HighchartsBasedChartRendererProps<CT extends HighchartBasedChartType
     onDataPointContextMenu?: SisenseChartDataPointEventHandler;
     onDataPointsSelected?: SisenseChartDataPointsEventHandler;
     onBeforeRender?: BeforeRenderHandler;
+    /**
+     * Called when Highcharts finishes painting the chart (`chart.events.load` /
+     * `render`). Used by RegularChart as the paint signal for the shared chart
+     * `onReady` readiness contract (see `BaseChartEventProps.onReady` in props).
+     *
+     * @internal
+     */
+    onReady?: () => void;
 };
 /**
  * Creates a specific highcharts based chart renderer component

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/sankey-chart/helpers/on-ready-state.d.ts

@@ -0,0 +1,17 @@
+import { ChartOnReadyStateInput } from '../../../types.js';
+/**
+ * Rising-edge readiness for Sankey `onReady` (Fusion `domready` / PDF).
+ *
+ * Implements the `ChartBuilder.onReady` contract for Sankey — other
+ * Fusion widgets fire `domready` from their native Prism renderers, not via
+ * Compose SDK `Chart`, so they omit the contract.
+ *
+ * - Ready after Highcharts paint when not loading
+ * - Empty / no-dimensions: ready when the terminal overlay is shown **and**
+ *   loading has finished (so empty→empty refetch still gets a false→true edge)
+ *
+ * @param state - Current loading, paint, and data signals.
+ * @returns `true` when the consumer `onReady` callback should fire for this cycle.
+ * @internal
+ */
+export declare function isSankeyReadyForOnReady({ isLoading, rendererPainted, hasNoDimensions, chartData, }: ChartOnReadyStateInput): boolean;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/highchart-based-charts/sankey-chart/sankey-chart-builder.d.ts

@@ -1,3 +1,10 @@
 import { ChartBuilder } from '../../types.js';
-/** Wires together data options, data, design options, and Highcharts renderer for the Sankey chart. */
+/**
+ * Wires together data options, data, design options, and Highcharts renderer
+ * for the Sankey chart.
+ *
+ * `onReady` (Fusion `domready`): Highcharts paint is forwarded via
+ * `ChartRendererProps.onReady`; the `onReady` contract below tells RegularChart
+ * when to fire the consumer callback (see `helpers/on-ready-state.ts`).
+ */
 export declare const sankeyChartBuilder: ChartBuilder<'sankey'>;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/data/comparison.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Computes a delta comparison (absolute and percent change) between `value` and `baseline`.
+ * @internal
+ */
+export declare function calcDeltaComparison(value: number, baseline: number): {
+    deltaValue: number;
+    deltaPercent: number | undefined;
+};
+/**
+ * Computes a target comparison (percent of goal and remaining amount) between `value` and `target`.
+ * @internal
+ */
+export declare function calcTargetComparison(value: number, target: number): {
+    percentOfTarget: number | undefined;
+    toGo: number;
+};
+/**
+ * Resolves the `'previous-period'` comparison's translation key for the given `trend` granularity,
+ * falling back to a granularity-agnostic key when `granularity` is missing or unrecognized.
+ * @internal
+ */
+export declare function inferPeriodLabelKey(granularity: string | undefined): string;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/data/data.d.ts

@@ -0,0 +1,17 @@
+import { KpiChartDataOptionsInternal } from '../../../../../../../domains/visualizations/core/chart-data-options/types.js';
+import { DataTable } from '../../../../../../../domains/visualizations/core/chart-data-processor/table-processor.js';
+import { KpiChartData } from '../types.js';
+/**
+ * Converts a data table to KPI chart data.
+ *
+ * Without `trend`: a single-row query -- the headline is read straight from the first row.
+ *
+ * With `trend`: one row per time bucket. When the result was produced by the dual-query
+ * merge in `load-data.ts` (`valueMode: 'total'` with a `trend`), rows carry a
+ * {@link KPI_ROW_TYPE_COLUMN} marker; rows are split into per-bucket rows and the single
+ * ungrouped total row by that marker **before** any date-based processing runs, because the
+ * merged total row's date cell is a blank placeholder that parses to `NaN` -- letting it
+ * anywhere near bucket iteration, sparkline building, or prior-bucket lookups would corrupt
+ * them. When the marker column is absent (the single-query path), every row is a bucket.
+ */
+export declare function getKpiChartData(dataOptions: KpiChartDataOptionsInternal, dataTable: DataTable): KpiChartData;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/data/index.d.ts

@@ -0,0 +1,4 @@
+export * from './data.js';
+export * from './comparison.js';
+export * from './value-colors.js';
+export * from './load-data.js';

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/data/load-data.d.ts

@@ -0,0 +1,64 @@
+import { QueryResultData } from '@sisense/sdk-data';
+import type { TypedLoadDataFunction } from '../../types.js';
+/**
+ * Name of the marker column appended to a KPI query result merged by
+ * {@link mergeTotalIntoResult}. Its presence in `columns` is how a consumer
+ * distinguishes a dual-query merged result from a plain single-query one --
+ * when the column is absent, every row is implicitly a `'bucket'` row.
+ *
+ * Reserved: this assumes no real dimension/measure is ever named `$kpiRowType`. A collision
+ * would misclassify a bucket row as the total row (or vice versa); not hardened against here
+ * (tracked separately as a follow-up).
+ * @internal
+ */
+export declare const KPI_ROW_TYPE_COLUMN = "$kpiRowType";
+/**
+ * Marks a row of a KPI dual-query merged result as either a per-bucket data point
+ * (`'bucket'`, one per grouped date value) or the single ungrouped total row
+ * (`'total'`), appended under the {@link KPI_ROW_TYPE_COLUMN} column.
+ * @internal
+ */
+export type KpiRowType = 'bucket' | 'total';
+/**
+ * Options accepted by {@link loadKpiData}, matching `TypedLoadDataFunction<'kpi'>`'s shape
+ * (`restructured-charts/types.ts`) -- kept as its own named alias since this module and its
+ * tests reference it directly.
+ * @internal
+ */
+export type LoadKpiDataOptions = Parameters<TypedLoadDataFunction<'kpi'>>[0];
+/**
+ * Loads the data for a KPI chart.
+ *
+ * When `valueMode` is `'total'` and a `trend` dimension is configured, the headline
+ * value must be the aggregate over the *entire* period, not a combination of the
+ * per-bucket (e.g. per-month) values -- summing per-bucket averages, for instance,
+ * would be mathematically wrong. Correct SQL semantics require a second, ungrouped
+ * query (same measures, no dimensions) run alongside the regular grouped one; the
+ * two results are then merged (see {@link mergeTotalIntoResult}).
+ *
+ * In every other case (`valueMode: 'last'`, or `'total'` without a `trend`), a single
+ * regular query is sufficient and its result is returned untouched.
+ * @internal
+ */
+export declare const loadKpiData: (options: LoadKpiDataOptions) => Promise<QueryResultData>;
+/**
+ * Merges a bucketed (grouped-by-date) KPI query result with an ungrouped total
+ * query result into a single {@link QueryResultData}.
+ *
+ * The merge appends a `{@link KPI_ROW_TYPE_COLUMN}` column (type `'string'`) to the
+ * bucketed columns. Every bucketed row is carried over unchanged with a `'bucket'`
+ * marker cell appended; one extra row is appended holding the total query's measure
+ * values -- prefixed with an empty cell in place of the (dropped) date bucket -- with
+ * a `'total'` marker cell.
+ *
+ * The total query is expected to carry exactly the bucketed result's measure
+ * columns (same measures, no dimensions), so its column count is used to work out
+ * how many leading (dimension) columns the bucketed result has and need an empty
+ * placeholder cell in the appended total row.
+ *
+ * An empty `total.rows` (the ungrouped query legitimately returning no row at all) has no
+ * measure cells to append -- rather than emit a total row holding only the marker cell (missing
+ * every measure value), the total row is omitted entirely and only the bucket rows are returned.
+ * @internal
+ */
+export declare function mergeTotalIntoResult(bucketed: QueryResultData, total: QueryResultData): QueryResultData;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/data/value-colors.d.ts

@@ -0,0 +1,27 @@
+import { DataColorOptions, StyledMeasureColumn } from '../../../../../../../types';
+/**
+ * Resolves the display color of a KPI value from the measure's color options
+ * (`StyledMeasureColumn.color`) — the same mechanism the indicator chart uses.
+ * Static (string/uniform) and conditional options are supported; range coloring
+ * needs a comparison population and is not applicable to a single KPI value.
+ */
+export declare function resolveValueColor(styledMeasureColumn: StyledMeasureColumn, value: number | undefined): string | undefined;
+/**
+ * Resolves the display color of a KPI comparison metric (`deltaPercent`/`percentOfTarget`)
+ * against the given color options, reusing the shared data-coloring evaluator
+ * (`getColoringServiceByColorOptions`) so conditional/uniform/range options behave
+ * identically to how they're evaluated elsewhere (indicator values, pivot table cells).
+ *
+ * - `metric === undefined` → `undefined` (renderer falls back to the default text color).
+ * - `colorOptions` provided → evaluated against `metric` via the shared evaluator.
+ * - No `colorOptions` → sign-based default: positive → green, negative → red, zero → undefined.
+ * - `'Relative'` (range) options → `undefined`, same as {@link resolveValueColor}: range coloring
+ *   is meant to place a value within a population of other values, and a single comparison
+ *   metric has no such population to place itself within -- even with an explicit
+ *   `minValue`/`maxValue`, there's no other data point for "relative" to mean anything against.
+ *   Left unrejected, the previous approach of feeding the interpolator a one-item population
+ *   compounds this: with the (common) population-derived min/max, the metric always equals both
+ *   bounds, so the interpolator collapses to its fixed midpoint color regardless of the metric's
+ *   actual sign or magnitude -- a range-colored comparison that can never visibly vary.
+ */
+export declare function resolveComparisonColor(colorOptions: DataColorOptions | undefined, metric: number | undefined): string | undefined;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/data-options/data-options.d.ts

@@ -0,0 +1,30 @@
+import { Attribute, Measure } from '@sisense/sdk-data';
+import { ChartDataOptionsInternal, KpiChartDataOptions, KpiChartDataOptionsInternal } from '../../../../../../../domains/visualizations/core/chart-data-options/types.js';
+import { ChartDataOptions } from '../../../../../../../types';
+/**
+ * Translates the public KPI data options into their internal, normalized shape.
+ * @internal
+ */
+export declare function translateKpiChartDataOptions(dataOptions: KpiChartDataOptions): KpiChartDataOptionsInternal;
+/**
+ * Extracts the attribute(s) a KPI chart's query needs, from its `trend` column when present.
+ * @internal
+ */
+export declare function getKpiAttributes(dataOptions: KpiChartDataOptionsInternal): Attribute[];
+/**
+ * Extracts every measure a KPI chart's query needs: the headline `value`, plus whichever
+ * comparison measure (`delta`/`target`/`value`) is configured.
+ * @internal
+ */
+export declare function getKpiMeasures(dataOptions: KpiChartDataOptionsInternal): Measure[];
+/**
+ * Checks whether the given chart data options are shaped as {@link KpiChartDataOptions}.
+ * @internal
+ */
+export declare function isKpiChartDataOptions(dataOptions: ChartDataOptions): dataOptions is KpiChartDataOptions;
+/**
+ * Checks whether the given internal chart data options are shaped as
+ * {@link KpiChartDataOptionsInternal}.
+ * @internal
+ */
+export declare function isKpiChartDataOptionsInternal(dataOptions: ChartDataOptionsInternal): dataOptions is KpiChartDataOptionsInternal;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/data-options/index.d.ts

@@ -0,0 +1 @@
+export * from './data-options.js';

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/design-options/design-options.d.ts

@@ -0,0 +1,31 @@
+import { KpiChartDataOptionsInternal } from '../../../../../../../domains/visualizations/core/chart-data-options/types.js';
+import { KpiChartDesignOptions } from '../../../../../../../domains/visualizations/core/chart-options-processor/translations/design-options.js';
+import { ChartStyleOptions, KpiStyleOptions } from '../../../../../../../types';
+/**
+ * Translates KPI style options to design options.
+ *
+ * @param styleOptions - User-provided KPI style options
+ * @param dataOptionsInternal - Translated data options, used to resolve data-dependent defaults
+ * @returns Translated design options for internal use
+ * @internal
+ */
+export declare function translateKpiStyleOptionsToDesignOptions(styleOptions: KpiStyleOptions, dataOptionsInternal: KpiChartDataOptionsInternal): KpiChartDesignOptions;
+/**
+ * Checks whether the given style options are valid for KPI charts.
+ *
+ * @param styleOptions - Style options to validate
+ * @returns True if the style options are valid for KPI charts
+ * @internal
+ */
+export declare function isKpiStyleOptions(styleOptions: ChartStyleOptions): styleOptions is KpiStyleOptions;
+/**
+ * Gets the default style options for KPI charts.
+ *
+ * Data-dependent defaults (like sparkline visibility) are intentionally left unset here so that
+ * feeding this result back into {@link translateKpiStyleOptionsToDesignOptions} alongside the
+ * actual {@link KpiChartDataOptionsInternal} resolves them the same way as an empty object would.
+ *
+ * @returns Default KPI style options
+ * @internal
+ */
+export declare function getDefaultKpiStyleOptions(): KpiStyleOptions;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/design-options/index.d.ts

@@ -0,0 +1 @@
+export * from './design-options.js';

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/kpi-chart-builder.d.ts

@@ -0,0 +1,9 @@
+import { ChartBuilder } from '../types.js';
+/**
+ * KPI chart builder configuration.
+ *
+ * Provides a complete configuration for building KPI charts,
+ * including data processing, styling, and rendering capabilities.
+ * @internal
+ */
+export declare const kpiChartBuilder: ChartBuilder<'kpi'>;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/helpers.d.ts

@@ -0,0 +1,139 @@
+import type { KpiComparisonInfo, KpiDataPoint, KpiIconCondition, KpiRenderOptions, NumberFormatConfig } from '../../../../../../../types.js';
+import { KpiChartData, KpiComparisonData } from '../types.js';
+/**
+ * Caps the displayed percent difference so a near-zero baseline doesn't blow up the readout.
+ * @internal
+ */
+export declare const MAX_DISPLAY_PERCENT_DIFF = 999.99;
+/**
+ * Formats a KPI number through the shared number-format pipeline (plain text, no markup).
+ * @internal
+ */
+export declare function formatKpiValue(value: number, config?: NumberFormatConfig): string;
+/**
+ * Computes the non-circular height budget for whichever of value/comparison plays the
+ * "headline" (auto-fit) role in `BodyArea`: its `flex: 0 0 auto` sibling's own box is
+ * content-sized, so subtracting the *sibling's* measured height (plus the gap between them) from
+ * `BodyArea`'s own (grid-derived, safe-to-self-measure) height gives the headline element's real
+ * available height -- see `use-auto-fit-font-size.ts`'s `maxHeightPxOverride` TSDoc for why this
+ * indirection is needed at all. Clamped to 0 so a not-yet-measured (0-height) `BodyArea` -- or a
+ * compact sibling briefly taller than `BodyArea` mid-resize -- never yields a negative budget.
+ * @internal
+ */
+export declare function computeHeadlineMaxHeightPx(bodyHeightPx: number, compactSiblingHeightPx: number, gapPx: number): number;
+/**
+ * Formats a percent difference with an explicit sign, capped at {@link MAX_DISPLAY_PERCENT_DIFF}.
+ * @internal
+ */
+export declare function formatPercentDiff(percentDiff: number): string;
+/**
+ * A percent diff is only worth displaying when it's a finite, non-extreme number.
+ * @internal
+ */
+export declare function isMeaningfulPercentDiff(percentDiff: number | undefined): percentDiff is number;
+/**
+ * Formats a delta value with an explicit sign, e.g. `+$1.2K` / `-$3.4K`.
+ * @internal
+ */
+export declare function formatDeltaValue(deltaValue: number, config?: NumberFormatConfig): string;
+/**
+ * Resolves the first icon condition matching `value` (first-match-wins), or `undefined` when
+ * nothing matches or an input is missing.
+ * @internal
+ */
+export declare function resolveConditionalIcon(conditions: KpiIconCondition[] | undefined, value: number | undefined): KpiIconCondition | undefined;
+/**
+ * Builds the readout text for a delta-shaped comparison (`'previous-period'`/`'delta'`),
+ * honoring `display`. `deltaValue` is guaranteed on this shape, so every branch always resolves
+ * to a string (falling back to the formatted absolute delta when the percent isn't meaningful).
+ * @internal
+ */
+export declare function formatDelta(comparison: {
+    deltaValue: number;
+    deltaPercent?: number;
+}, display: 'percent' | 'value' | 'both', numberFormatConfig?: NumberFormatConfig): string | null;
+/**
+ * Picks the metric a comparison's color (and conditional icon) should be evaluated against, per
+ * the contract documented on {@link KpiComparisonInfo} / `KpiComparisonStyleOptions.color`:
+ * delta-shaped comparisons compare on `deltaPercent`, `'target'` compares on `percentOfTarget`,
+ * and `'value'` has no applicable metric here -- it's colored by its own measure instead.
+ *
+ * A zero baseline leaves `deltaPercent` undefined (division by zero); this deliberately does
+ * NOT fall back to `deltaValue` -- an absolute delta isn't the same unit as a user's percent
+ * condition (e.g. `> 5` meaning 5%), and sign-based default coloring would misapply too.
+ * `undefined` means "no metric to evaluate against", which `resolveComparisonColor` /
+ * `resolveConditionalIcon` both already treat as no color / no icon.
+ * @internal
+ */
+export declare function metricFor(comparison: {
+    type: string;
+    deltaValue?: number;
+    deltaPercent?: number;
+    percentOfTarget?: number;
+}): number | undefined;
+/**
+ * Translates the internal {@link KpiComparisonData} into the public {@link KpiComparisonInfo}
+ * shape exposed to `onBeforeRender`/`onDataPointClick` consumers, resolving `'previous-period'`'s
+ * `labelKey` to display text via `t()`. Internal-only rendering metadata (`color`,
+ * `numberFormatConfig`) is intentionally dropped -- it's not part of the public contract.
+ * @internal
+ */
+export declare function toKpiComparisonInfo(comparison: KpiComparisonData, t: (key: string) => string): KpiComparisonInfo;
+/**
+ * Builds the public {@link KpiRenderOptions} passed to `onBeforeRender`, translating the
+ * comparison's `labelKey` (when present) to display text up front -- this always runs, whether
+ * or not a consumer supplied `onBeforeRender`, so the label is resolved exactly once per render.
+ * @internal
+ */
+export declare function toKpiRenderOptions(chartData: KpiChartData, t: (key: string) => string): KpiRenderOptions;
+/**
+ * Builds the click/context-menu payload from the (possibly `onBeforeRender`-adjusted) render options.
+ * @internal
+ */
+export declare function toKpiDataPoint(renderOptions: KpiRenderOptions): KpiDataPoint;
+/**
+ * Comparison data shaped for display: same as {@link KpiComparisonData}, but with
+ * `'previous-period'`'s `labelKey` already resolved to `label` (matching `'delta'`'s shape), so
+ * `kpi-comparison.tsx` only ever needs to read `label`.
+ * @internal
+ */
+export type KpiComparisonDisplay = {
+    type: 'previous-period' | 'delta';
+    baseline: number;
+    deltaValue: number;
+    deltaPercent?: number;
+    label: string;
+    color?: string;
+} | {
+    type: 'target';
+    target: number;
+    percentOfTarget?: number;
+    toGo: number;
+    label: string;
+    color?: string;
+} | {
+    type: 'value';
+    value: number;
+    label: string;
+    color?: string;
+    numberFormatConfig?: NumberFormatConfig;
+};
+/**
+ * Combines the (possibly `onBeforeRender`-modified) public comparison info with the internal-only
+ * metadata (`color`, `numberFormatConfig`) that never left `original` in the first place, so the
+ * card can display a consumer's numeric/label override without losing its coloring/formatting.
+ * The metadata is only carried over when the type is unchanged -- if a consumer's callback swaps
+ * the comparison type entirely, there's no matching original metadata to reuse.
+ * @internal
+ */
+export declare function toComparisonDisplay(original: KpiComparisonData | undefined, publicInfo: KpiComparisonInfo): KpiComparisonDisplay;
+/**
+ * Builds the comparison segment of the card's `aria-label`, e.g. `'+20.00% vs prior month'`.
+ *
+ * For `'target'` comparisons the summary follows the same `display` semantics as the visible
+ * readout (see `kpi-comparison.tsx`), so assistive tech never hears content that isn't shown:
+ * `'percent'` reads the percent-of-goal line, `'value'` the amount-to-go line, `'both'` reads
+ * both; an unavailable percent falls back to the amount-to-go line.
+ * @internal
+ */
+export declare function summarizeComparisonForAria(comparison: KpiComparisonDisplay, numberFormatConfig: NumberFormatConfig | undefined, display?: 'percent' | 'value' | 'both'): string;

package/dist/packages/sdk-ui/src/domains/visualizations/components/chart/restructured-charts/kpi-chart/renderer/index.d.ts

@@ -0,0 +1 @@
+export * from './kpi-chart-renderer.js';