@customafk/lunas-ui 0.2.65 → 0.2.67

package/dist/index-CBntsHIg.d.cts

@@ -0,0 +1,520 @@
+import { ComponentType } from "react";
+
+//#region packages/components/features/charts/types.d.ts
+/** Trend direction shared with the `Statistic` display component. */
+type ChartTrend = 'up' | 'down' | 'neutral';
+type TimeSeriesPoint = {
+  date: string | Date;
+  value: number; /** Same-bucket value from the comparison period (enables the comparison series). */
+  previousValue?: number;
+};
+type ChartSeries = {
+  key: string;
+  label: string;
+  color?: string;
+};
+type NamedValue = {
+  name: string;
+  value: number;
+};
+/** A single OHLC(V) period — one candle, one trading day, etc. */
+type OHLCPoint = {
+  date: string | Date;
+  open: number;
+  high: number;
+  low: number;
+  close: number;
+  volume?: number;
+};
+/** A single portfolio holding or asset allocation segment. */
+type PortfolioHolding = NamedValue & {
+  /** Config key; derived from `name` when omitted. */key?: string;
+  color?: string;
+};
+/** A single step in a waterfall/bridge chart. */
+type WaterfallPoint = {
+  label: string; /** Signed delta for a step; the running/starting/ending amount when `isTotal` is set. */
+  value: number; /** Renders as a full-height bar from zero instead of a floating delta. Defaults to `false`. */
+  isTotal?: boolean;
+};
+/** A single point in an x/y correlation chart; `z` optionally sizes the bubble. */
+type ScatterPoint = {
+  x: number;
+  y: number;
+  z?: number;
+  name?: string;
+};
+/** A single day's intensity value in an activity/usage calendar heatmap. */
+type ActivityPoint = {
+  date: string | Date;
+  value: number;
+};
+/** Props shared by every prebuilt chart. */
+type BaseChartProps = {
+  className?: string; /** Enable the recharts enter animation. Disable for deterministic tests. Defaults to `true`. */
+  animate?: boolean; /** Fixed height in px; otherwise the container's aspect-video ratio applies. */
+  height?: number;
+};
+//#endregion
+//#region packages/components/features/charts/utils.d.ts
+/** Cycles through the eight `--chart-N` theme palette variables. */
+declare const getChartColor: (index: number) => string;
+declare const formatCompactNumber: (value: number, locale?: string) => string;
+declare const formatCurrency: (value: number, currency?: string, locale?: string) => string;
+declare const formatPercent: (value: number, locale?: string) => string;
+declare const toDateLabel: (date: string | Date, locale?: string) => string;
+/** Picks an up/down color by comparing `current` against `reference` (e.g. close vs. open, or vs. zero). */
+declare const getDirectionColor: (current: number, reference: number, colors?: {
+  up?: string;
+  down?: string;
+}) => string;
+declare const formatSignedPercent: (value: number, locale?: string) => string;
+/**
+ * Normalizes each of `seriesKeys` in `data` to a common `base` value at its first defined point,
+ * so relative performance across series with different price scales becomes directly comparable.
+ */
+declare const computeIndexedSeries: <T extends {
+  date: string | Date;
+} & Record<string, unknown>>(data: readonly T[], seriesKeys: readonly string[], base?: number) => Array<Record<string, string | Date | number>>;
+//#endregion
+//#region packages/components/features/charts/components/activity-heatmap-chart.d.ts
+type ActivityHeatmapChartProps = BaseChartProps & {
+  data: ActivityPoint[]; /** Series label used in the theme config. Defaults to `'Activity'`. */
+  label?: string;
+  color?: string;
+  valueFormatter?: (value: number) => string;
+};
+//#endregion
+//#region packages/components/features/charts/components/candlestick-chart.d.ts
+type CandlestickChartProps = BaseChartProps & {
+  data: OHLCPoint[]; /** Series label used in the theme config. Defaults to `'Price'`. */
+  label?: string;
+  upColor?: string;
+  downColor?: string;
+  valueFormatter?: (value: number) => string;
+  dateFormatter?: (date: string | Date) => string;
+  showGrid?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/conversion-funnel-chart.d.ts
+type FunnelStage = NamedValue & {
+  /** Config key; derived from `name` when omitted. */key?: string;
+  color?: string;
+};
+type ConversionFunnelChartProps = BaseChartProps & {
+  /** Funnel stages ordered top (widest) to bottom. */data: FunnelStage[]; /** Appends each stage's percentage of the first stage. Defaults to `true`. */
+  showConversionRates?: boolean;
+  valueFormatter?: (value: number) => string;
+};
+//#endregion
+//#region packages/components/features/charts/components/correlation-scatter-chart.d.ts
+type CorrelationScatterChartProps = BaseChartProps & {
+  data: ScatterPoint[]; /** Series label used in the theme config. Defaults to `'Points'`. */
+  label?: string;
+  color?: string;
+  xLabel?: string;
+  yLabel?: string;
+  xFormatter?: (value: number) => string;
+  yFormatter?: (value: number) => string; /** Sizes each point from its `z` value. Defaults to `false`. */
+  showBubbleSize?: boolean;
+  showGrid?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/donut-chart.d.ts
+type DonutChartSegment = NamedValue & {
+  /** Config key; derived from `name` when omitted. */key?: string;
+  color?: string;
+};
+type DonutChartProps = BaseChartProps & {
+  data: DonutChartSegment[]; /** Text under the center total, e.g. `'Total sales'`. */
+  centerLabel?: string; /** Formats the center total. Defaults to compact notation. */
+  centerValueFormatter?: (total: number) => string; /** Overrides the computed segment sum shown in the center. */
+  totalValue?: number;
+  showLegend?: boolean;
+  showCenterTotal?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/gain-loss-bar-chart.d.ts
+type GainLossBarChartProps = BaseChartProps & {
+  /** `name` is the period label (e.g. a month or quarter); `value` is the signed return. */data: NamedValue[]; /** Series label. Defaults to `'Return'`. */
+  label?: string;
+  upColor?: string;
+  downColor?: string; /** Formats tooltip and Y-axis values. Defaults to a signed percentage. */
+  valueFormatter?: (value: number) => string;
+  showGrid?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/indexed-performance-line-chart.d.ts
+type IndexedPerformanceLineChartProps = BaseChartProps & {
+  data: Array<{
+    date: string | Date;
+  } & Record<string, unknown>>; /** One entry per instrument/fund to compare. */
+  series: ChartSeries[]; /** The value every series is normalized to at its first data point. Defaults to `100`. */
+  base?: number; /** Formats tooltip and Y-axis values. Defaults to signed % change from `base`. */
+  valueFormatter?: (indexedValue: number, base: number) => string;
+  dateFormatter?: (date: string | Date) => string;
+  showLegend?: boolean;
+  showGrid?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/metric-radar-chart.d.ts
+type MetricRadarChartProps = BaseChartProps & {
+  data: Array<{
+    metric: string;
+  } & Record<string, unknown>>; /** One entry per entity being compared (e.g. a candidate, a product, a team). */
+  series: ChartSeries[];
+  valueFormatter?: (value: number) => string; /** Radius-axis domain. Defaults to `['auto', 'auto']`. */
+  domain?: [number | 'auto', number | 'auto'];
+  showLegend?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/mirrored-bar-chart.d.ts
+type MirroredBarRow = {
+  category: string;
+  left: number;
+  right: number;
+};
+type MirroredBarChartProps = BaseChartProps & {
+  data: MirroredBarRow[];
+  leftLabel?: string;
+  rightLabel?: string;
+  leftColor?: string;
+  rightColor?: string;
+  valueFormatter?: (value: number) => string;
+  showLegend?: boolean;
+  showGrid?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/orders-bar-chart.d.ts
+type OrdersBarChartProps = BaseChartProps & {
+  data: Array<{
+    date: string | Date;
+  } & Record<string, unknown>>; /** Simple mode: the key holding each period's count. Defaults to `'orders'`. */
+  dataKey?: string; /** Series label in simple mode. Defaults to `'Orders'`. */
+  label?: string; /** Stacked mode: one series per order status; each `key` indexes into the data rows. */
+  statuses?: ChartSeries[];
+  color?: string;
+  valueFormatter?: (value: number) => string;
+  dateFormatter?: (date: string | Date) => string; /** Defaults to `true` when `statuses` is provided. */
+  showLegend?: boolean;
+  showGrid?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/portfolio-allocation-treemap.d.ts
+type PortfolioAllocationTreemapProps = BaseChartProps & {
+  data: PortfolioHolding[];
+  valueFormatter?: (value: number) => string; /** Shows the holding name and formatted value inside each rect when it fits. Defaults to `true`. */
+  showLabels?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/price-range-area-chart.d.ts
+type PriceRangeAreaChartProps = BaseChartProps & {
+  /** Only `date`, `high`, `low`, and `close` are used; pass the same rows given to `CandlestickChart`. */data: Array<Pick<OHLCPoint, 'date' | 'high' | 'low' | 'close'>>; /** Close-price series label. Defaults to `'Close'`. */
+  label?: string; /** High-low band label. Defaults to `'Range'`. */
+  rangeLabel?: string;
+  color?: string;
+  valueFormatter?: (value: number) => string;
+  dateFormatter?: (date: string | Date) => string;
+  showGrid?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/revenue-area-chart.d.ts
+type RevenueAreaChartProps = BaseChartProps & {
+  data: TimeSeriesPoint[]; /** Series label. Defaults to `'Revenue'`. */
+  label?: string; /** Comparison series label. Defaults to `'Previous period'`. */
+  comparisonLabel?: string; /** Renders `previousValue` as a second, muted area series. */
+  showComparison?: boolean;
+  color?: string;
+  comparisonColor?: string; /** Formats tooltip and Y-axis values. Defaults to compact currency. */
+  valueFormatter?: (value: number) => string;
+  dateFormatter?: (date: string | Date) => string; /** Defaults to `showComparison`. */
+  showLegend?: boolean;
+  showGrid?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/revenue-orders-composed-chart.d.ts
+type RevenueOrdersPoint = {
+  date: string | Date;
+  revenue: number;
+  orders: number;
+};
+type RevenueOrdersComposedChartProps = BaseChartProps & {
+  data: RevenueOrdersPoint[];
+  revenueLabel?: string;
+  ordersLabel?: string;
+  revenueColor?: string;
+  ordersColor?: string; /** Formats the left (revenue) axis and tooltip values. Defaults to compact currency. */
+  revenueFormatter?: (value: number) => string; /** Formats the right (orders) axis and tooltip values. */
+  ordersFormatter?: (value: number) => string;
+  dateFormatter?: (date: string | Date) => string;
+  showLegend?: boolean;
+  showGrid?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/sales-target-radial-chart.d.ts
+type SalesTargetRadialChartProps = BaseChartProps & {
+  /** Current progress value, e.g. revenue to date. */value: number; /** The goal the value is measured against. */
+  target: number; /** Text under the center figure. Defaults to `'Target'`. */
+  label?: string; /** Formats the center figure. Defaults to percent-of-target. */
+  valueFormatter?: (value: number, target: number) => string;
+  color?: string;
+};
+//#endregion
+//#region packages/components/features/charts/components/sankey-flow-chart.d.ts
+type SankeyFlowNode = {
+  name: string;
+  color?: string;
+};
+type SankeyFlowLink = {
+  /** Node name, matching an entry in `nodes`. */source: string; /** Node name, matching an entry in `nodes`. */
+  target: string;
+  value: number;
+};
+type SankeyFlowChartProps = BaseChartProps & {
+  nodes: Array<SankeyFlowNode | string>;
+  links: SankeyFlowLink[];
+  valueFormatter?: (value: number) => string;
+  nodeWidth?: number;
+  nodePadding?: number; /** Minimum horizontal space reserved for node labels outside the plot area; grows to fit the longest root/leaf label. Defaults to `170`. */
+  labelWidth?: number;
+};
+//#endregion
+//#region packages/components/features/charts/components/sparkline-chart.d.ts
+type SparklineChartProps = {
+  data: number[] | Array<{
+    value: number;
+  }>; /** Render style. Defaults to `'area'`. */
+  type?: 'line' | 'area'; /** Colors the series like the `Statistic` trend prop. Defaults to `'neutral'`. */
+  trend?: ChartTrend; /** Explicit series color; overrides `trend`. */
+  color?: string; /** Fixed height in px. Defaults to `40`. */
+  height?: number;
+  animate?: boolean;
+  className?: string;
+};
+//#endregion
+//#region packages/components/features/charts/components/stacked-area-chart.d.ts
+type StackedAreaChartProps = BaseChartProps & {
+  data: Array<{
+    date: string | Date;
+  } & Record<string, unknown>>; /** One entry per stacked category. */
+  series: ChartSeries[];
+  valueFormatter?: (value: number) => string;
+  dateFormatter?: (date: string | Date) => string;
+  showLegend?: boolean;
+  showGrid?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/top-products-bar-chart.d.ts
+type TopProductsBarChartProps = BaseChartProps & {
+  data: NamedValue[]; /** Series label. Defaults to `'Sales'`. */
+  label?: string; /** Number of items shown after sorting descending. Defaults to `8`. */
+  maxItems?: number;
+  color?: string;
+  valueFormatter?: (value: number) => string; /** Value labels at the end of each bar. Defaults to `true`. */
+  showValueLabels?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/volume-bar-chart.d.ts
+type VolumeBarChartProps = BaseChartProps & {
+  /** Only `date`, `close`, and `volume` are used; pass the same rows given to `CandlestickChart`. */data: Array<Pick<OHLCPoint, 'date' | 'close' | 'volume'>>; /** Series label. Defaults to `'Volume'`. */
+  label?: string;
+  upColor?: string;
+  downColor?: string;
+  valueFormatter?: (value: number) => string;
+  dateFormatter?: (date: string | Date) => string;
+  showGrid?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/components/waterfall-chart.d.ts
+type WaterfallChartProps = BaseChartProps & {
+  data: WaterfallPoint[]; /** Color for `isTotal` bars. Defaults to `'var(--chart-1)'`. */
+  totalColor?: string;
+  upColor?: string;
+  downColor?: string;
+  valueFormatter?: (value: number) => string;
+  showGrid?: boolean;
+};
+//#endregion
+//#region packages/components/features/charts/index.d.ts
+declare const ActivityHeatmapChart: ComponentType<BaseChartProps & {
+  data: ActivityPoint[];
+  label?: string;
+  color?: string;
+  valueFormatter?: (value: number) => string;
+}>;
+declare const CandlestickChart: ComponentType<BaseChartProps & {
+  data: OHLCPoint[];
+  label?: string;
+  upColor?: string;
+  downColor?: string;
+  valueFormatter?: (value: number) => string;
+  dateFormatter?: (date: string | Date) => string;
+  showGrid?: boolean;
+}>;
+declare const ConversionFunnelChart: ComponentType<BaseChartProps & {
+  data: FunnelStage[];
+  showConversionRates?: boolean;
+  valueFormatter?: (value: number) => string;
+}>;
+declare const CorrelationScatterChart: ComponentType<BaseChartProps & {
+  data: ScatterPoint[];
+  label?: string;
+  color?: string;
+  xLabel?: string;
+  yLabel?: string;
+  xFormatter?: (value: number) => string;
+  yFormatter?: (value: number) => string;
+  showBubbleSize?: boolean;
+  showGrid?: boolean;
+}>;
+declare const DonutChart: ComponentType<BaseChartProps & {
+  data: DonutChartSegment[];
+  centerLabel?: string;
+  centerValueFormatter?: (total: number) => string;
+  totalValue?: number;
+  showLegend?: boolean;
+  showCenterTotal?: boolean;
+}>;
+declare const GainLossBarChart: ComponentType<BaseChartProps & {
+  data: NamedValue[];
+  label?: string;
+  upColor?: string;
+  downColor?: string;
+  valueFormatter?: (value: number) => string;
+  showGrid?: boolean;
+}>;
+declare const IndexedPerformanceLineChart: ComponentType<BaseChartProps & {
+  data: Array<{
+    date: string | Date;
+  } & Record<string, unknown>>;
+  series: ChartSeries[];
+  base?: number;
+  valueFormatter?: (indexedValue: number, base: number) => string;
+  dateFormatter?: (date: string | Date) => string;
+  showLegend?: boolean;
+  showGrid?: boolean;
+}>;
+declare const MetricRadarChart: ComponentType<BaseChartProps & {
+  data: Array<{
+    metric: string;
+  } & Record<string, unknown>>;
+  series: ChartSeries[];
+  valueFormatter?: (value: number) => string;
+  domain?: [number | "auto", number | "auto"];
+  showLegend?: boolean;
+}>;
+declare const MirroredBarChart: ComponentType<BaseChartProps & {
+  data: MirroredBarRow[];
+  leftLabel?: string;
+  rightLabel?: string;
+  leftColor?: string;
+  rightColor?: string;
+  valueFormatter?: (value: number) => string;
+  showLegend?: boolean;
+  showGrid?: boolean;
+}>;
+declare const OrdersBarChart: ComponentType<BaseChartProps & {
+  data: Array<{
+    date: string | Date;
+  } & Record<string, unknown>>;
+  dataKey?: string;
+  label?: string;
+  statuses?: ChartSeries[];
+  color?: string;
+  valueFormatter?: (value: number) => string;
+  dateFormatter?: (date: string | Date) => string;
+  showLegend?: boolean;
+  showGrid?: boolean;
+}>;
+declare const PortfolioAllocationTreemap: ComponentType<BaseChartProps & {
+  data: PortfolioHolding[];
+  valueFormatter?: (value: number) => string;
+  showLabels?: boolean;
+}>;
+declare const PriceRangeAreaChart: ComponentType<BaseChartProps & {
+  data: Array<Pick<OHLCPoint, "date" | "high" | "low" | "close">>;
+  label?: string;
+  rangeLabel?: string;
+  color?: string;
+  valueFormatter?: (value: number) => string;
+  dateFormatter?: (date: string | Date) => string;
+  showGrid?: boolean;
+}>;
+declare const RevenueAreaChart: ComponentType<BaseChartProps & {
+  data: TimeSeriesPoint[];
+  label?: string;
+  comparisonLabel?: string;
+  showComparison?: boolean;
+  color?: string;
+  comparisonColor?: string;
+  valueFormatter?: (value: number) => string;
+  dateFormatter?: (date: string | Date) => string;
+  showLegend?: boolean;
+  showGrid?: boolean;
+}>;
+declare const RevenueOrdersComposedChart: ComponentType<BaseChartProps & {
+  data: RevenueOrdersPoint[];
+  revenueLabel?: string;
+  ordersLabel?: string;
+  revenueColor?: string;
+  ordersColor?: string;
+  revenueFormatter?: (value: number) => string;
+  ordersFormatter?: (value: number) => string;
+  dateFormatter?: (date: string | Date) => string;
+  showLegend?: boolean;
+  showGrid?: boolean;
+}>;
+declare const SalesTargetRadialChart: ComponentType<BaseChartProps & {
+  value: number;
+  target: number;
+  label?: string;
+  valueFormatter?: (value: number, target: number) => string;
+  color?: string;
+}>;
+declare const SankeyFlowChart: ComponentType<BaseChartProps & {
+  nodes: Array<SankeyFlowNode | string>;
+  links: SankeyFlowLink[];
+  valueFormatter?: (value: number) => string;
+  nodeWidth?: number;
+  nodePadding?: number;
+  labelWidth?: number;
+}>;
+declare const SparklineChart: ComponentType<SparklineChartProps>;
+declare const StackedAreaChart: ComponentType<BaseChartProps & {
+  data: Array<{
+    date: string | Date;
+  } & Record<string, unknown>>;
+  series: ChartSeries[];
+  valueFormatter?: (value: number) => string;
+  dateFormatter?: (date: string | Date) => string;
+  showLegend?: boolean;
+  showGrid?: boolean;
+}>;
+declare const TopProductsBarChart: ComponentType<BaseChartProps & {
+  data: NamedValue[];
+  label?: string;
+  maxItems?: number;
+  color?: string;
+  valueFormatter?: (value: number) => string;
+  showValueLabels?: boolean;
+}>;
+declare const VolumeBarChart: ComponentType<BaseChartProps & {
+  data: Array<Pick<OHLCPoint, "date" | "close" | "volume">>;
+  label?: string;
+  upColor?: string;
+  downColor?: string;
+  valueFormatter?: (value: number) => string;
+  dateFormatter?: (date: string | Date) => string;
+  showGrid?: boolean;
+}>;
+declare const WaterfallChart: ComponentType<BaseChartProps & {
+  data: WaterfallPoint[];
+  totalColor?: string;
+  upColor?: string;
+  downColor?: string;
+  valueFormatter?: (value: number) => string;
+  showGrid?: boolean;
+}>;
+//#endregion
+export { formatSignedPercent as $, SalesTargetRadialChartProps as A, IndexedPerformanceLineChartProps as B, VolumeBarChartProps as C, SankeyFlowChartProps as D, SparklineChartProps as E, PortfolioAllocationTreemapProps as F, ConversionFunnelChartProps as G, DonutChartProps as H, OrdersBarChartProps as I, ActivityHeatmapChartProps as J, FunnelStage as K, MirroredBarChartProps as L, RevenueOrdersPoint as M, RevenueAreaChartProps as N, SankeyFlowLink as O, PriceRangeAreaChartProps as P, formatPercent as Q, MirroredBarRow as R, WaterfallChartProps as S, StackedAreaChartProps as T, DonutChartSegment as U, GainLossBarChartProps as V, CorrelationScatterChartProps as W, formatCompactNumber as X, computeIndexedSeries as Y, formatCurrency as Z, SparklineChart as _, DonutChart as a, ChartSeries as at, VolumeBarChart as b, MetricRadarChart as c, OHLCPoint as ct, PortfolioAllocationTreemap as d, TimeSeriesPoint as dt, getChartColor as et, PriceRangeAreaChart as f, WaterfallPoint as ft, SankeyFlowChart as g, SalesTargetRadialChart as h, CorrelationScatterChart as i, BaseChartProps as it, RevenueOrdersComposedChartProps as j, SankeyFlowNode as k, MirroredBarChart as l, PortfolioHolding as lt, RevenueOrdersComposedChart as m, CandlestickChart as n, toDateLabel as nt, GainLossBarChart as o, ChartTrend as ot, RevenueAreaChart as p, CandlestickChartProps as q, ConversionFunnelChart as r, ActivityPoint as rt, IndexedPerformanceLineChart as s, NamedValue as st, ActivityHeatmapChart as t, getDirectionColor as tt, OrdersBarChart as u, ScatterPoint as ut, StackedAreaChart as v, TopProductsBarChartProps as w, WaterfallChart as x, TopProductsBarChart as y, MetricRadarChartProps as z };
+//# sourceMappingURL=index-CBntsHIg.d.cts.map