@sentio/ui-dashboard 0.2.9 → 0.3.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { DurationLike, ButtonProps } from '@sentio/ui-core';
+import { DurationLike, ButtonProps, DateTimeValue } from '@sentio/ui-core';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import react__default, { ReactNode, CSSProperties } from 'react';
@@ -383,6 +383,28 @@ interface MetricInfoLike {
     };
 }
 
+/** A single data point: [timestamp, value, ...extra values]. */
+type SeriesDataLike<T = Date> = [T, number | null, ...number[]];
+/** One rendered series (echarts-ready). */
+interface SeriesLike<T = Date> {
+    name: string;
+    data: SeriesDataLike<T>[];
+    showSymbol: boolean;
+    type: 'line' | 'bar';
+    areaStyle?: any;
+    lineStyle?: any;
+    stack?: string;
+    stackStrategy?: string;
+    emphasis?: any;
+    id: string;
+    xAxisIndex?: number;
+    symbolSize?: number | ((v: SeriesDataLike<T>) => number);
+    itemStyle?: {
+        color?: string;
+    };
+    smooth?: boolean;
+}
+
 interface Props$s {
     metric?: MetricInfoLike;
     value: QueryLike;
@@ -617,6 +639,110 @@ interface QueryValueChartProps {
 }
 declare const QueryValueChart: react.ForwardRefExoticComponent<QueryValueChartProps & react.RefAttributes<EChartsHandle>>;
 
+interface Mark {
+    value?: number;
+    label?: string;
+    above?: boolean;
+    below?: boolean;
+    color?: string;
+    from?: Date;
+    to?: Date;
+}
+type MarkLine = Mark;
+type MarkArea = Omit<Mark, 'above' | 'below' | 'value'>;
+/** Overlay outputs injected by the app (computed by its overlay-series hook). */
+interface TimeSeriesOverlay {
+    seriesIdToYAxisName: Map<string, string>;
+    overlaySeriesIdToFormatter: Map<string, (v: number) => string>;
+    applyOverlaySeries: (option: EChartsOption) => EChartsOption;
+}
+/**
+ * Context built by the presentational chart for a hovered/clicked series, handed
+ * out to the app so it can build the log/cohort URL + navigation. The app combines
+ * `value` (the data point, holding the timestamp) with its own time range.
+ */
+interface ViewActionContext {
+    value: any;
+    labels: Record<string, string>;
+    name: string;
+    id?: string;
+    isEventSeries: boolean;
+    eventName?: string;
+    query?: {
+        selectorExpr?: unknown;
+    };
+}
+interface TimeSeriesChartProps {
+    group?: string;
+    title?: string;
+    startTime?: DateTimeValue;
+    endTime?: DateTimeValue;
+    tz?: string;
+    minHeight?: number;
+    onSelectTimeRange?: (start: DateTimeValue, end: DateTimeValue) => void;
+    loading?: boolean;
+    controls?: boolean;
+    config?: ChartConfigLike;
+    onChangeConfig?: (config: ChartConfigLike) => void;
+    style?: CSSProperties;
+    chartType?: ChartTypeLike;
+    allowClick?: boolean;
+    showSymbol?: boolean;
+    sourceType?: string;
+    getEventNameById?: (id?: string) => string;
+    noLegend?: boolean;
+    onInitChart?: (chart: ECharts) => void;
+    markAreas?: MarkArea[];
+    markLines?: MarkLine[];
+    nonXAxis?: boolean;
+    /** Already-computed primary series (app runs the worker compute). */
+    series: SeriesLike<Date>[];
+    /** Already-computed compare-period series (already styled by the app, or styled here). */
+    compareSeries?: SeriesLike<Date>[];
+    /** Legend entries for the primary series. */
+    legend?: string[];
+    /** Formats a value for axis/tooltip display (replaces lib/metrics/formatter). */
+    numberFormatter: (value: number, seriesId?: string) => string;
+    /** Overlay outputs computed by the app (replaces the overlay-series hook). */
+    overlay?: TimeSeriesOverlay;
+    /** Template-variable keys (replaces the app's template-variables atom). */
+    templateVariableKeys?: string[];
+    /**
+     * Per-series metric labels, indexed by series index (the worker compute's
+     * `seriesToMetricLabels`; the original read `labelsRef.current[idx]`).
+     */
+    seriesToMetricLabels?: {
+        name: string;
+        labels: Record<string, string>;
+        id?: string;
+    }[];
+    /** Map of series id → event name (the original `eventNameMapRef.current`). */
+    eventNameMap?: Map<string, string>;
+    /** Map of series id → events query (the original `eventsQueryMapRef.current`). */
+    eventsQueryMap?: Map<string, {
+        selectorExpr?: unknown;
+    }>;
+    /**
+     * Navigate to logs for a clicked series. The presentational builds the context
+     * (from the hovered tooltip value + injected labels/event maps) and hands it out;
+     * the app maps it to a URL + navigation using its own time range.
+     */
+    onViewLogs?: (ctx: ViewActionContext) => void;
+    /** Navigate to users/accounts for a clicked series (the app builds the cohort query). */
+    onViewUsers?: (ctx: ViewActionContext) => void;
+    /**
+     * Whether the "View Logs" action should be disabled. The component computes the
+     * context (may be null) and passes it; the app decides disabled.
+     */
+    viewLogDisabled?: (ctx: ViewActionContext | null) => boolean;
+    /** Whether the "View Users" action should be disabled. */
+    viewUsersDisabled?: (ctx: ViewActionContext | null) => boolean;
+    /** Counts of returned/total samples for the data-truncation banner. */
+    returnedSeries?: number;
+    totalSeries?: number;
+}
+declare const TimeSeriesChart: react.ForwardRefExoticComponent<TimeSeriesChartProps & react.RefAttributes<EChartsHandle>>;
+
 interface Props$j {
     config?: LineConfigLike;
     defaultOpen?: boolean;
@@ -1534,4 +1660,4 @@ interface Props {
 }
 declare const SvgIcon: ({ className }: Props) => react_jsx_runtime.JSX.Element;
 
-export { AggregateInput, SvgIcon$6 as AreaIcon, type ArgumentDef, ArgumentInput, ArgumentType, BarGaugeChart, type BarGaugeChartProps, BarGaugeControls, SvgIcon$4 as BarGuageIcon, SvgIcon$5 as BarIcon, type ChartConfigLike, ChartLegend, type ChartLike, ChartTooltip, ChartTypeButtonGroup, type ChartTypeLike, type DashboardExtraLike, type DashboardLike, type DashboardVisibilityLike, DataControls, type DataSourceTypeLike, type EChartsHandle, type EChartsOption, EventsFunctionCategories, EventsFunctionMap, type FunctionDef, FunctionInput, FunctionMap, FunctionsCategories, FunctionsPanel, type GroupLike, type GroupStyleLike, LabelControls, LabelSearchProvider, LabelsInput, type LayoutItemLike, type LayoutsLike, LineControls, SvgIcon$7 as LineIcon, MarkerControls, type NoteAlignmentLike, type NoteFontSizeLike, type NoteLike, type NoteVerticalAlignmentLike, type OverlayGraphLike, type PanelLike, PieChart, PieChartControls, type PieChartProps, SvgIcon$3 as PieIcon, type PieSeriesInput, QueryValueChart, type QueryValueChartProps, SvgIcon$2 as QueryValueIcon, ReactEChartsBase, type ReactEChartsProps, RefreshButton, RefreshContext, type ResponsiveLayoutsLike, ScatterChartTooltip, ScatterControls, SvgIcon$1 as ScatterIcon, SystemLabels, SvgIcon as TableIcon, type TemplateVariableLike, type TemplateViewLike, ValueControls, type ValueFormatter, ValueFormatters, ValueOptions, ValueStringMapping, XAxisControls, type YAxisConfigLike, YaxisControls, defaultConfig$4 as defaultBarGaugeConfig, defaultConfig$1 as defaultDataConfig, defaultConfig$5 as defaultPieConfig, defaultConfig as defaultScatterConfig, defaultConfig$3 as defaultValueConfig, defaultConfig$2 as defaultValueControlsConfig, isAggrOrRollupFunction, sentioColors, sentioTheme, sentioThemeDark, sortMetricByName, useLabelSearch, useLabelSearchContext };
+export { AggregateInput, SvgIcon$6 as AreaIcon, type ArgumentDef, ArgumentInput, ArgumentType, BarGaugeChart, type BarGaugeChartProps, BarGaugeControls, SvgIcon$4 as BarGuageIcon, SvgIcon$5 as BarIcon, type ChartConfigLike, ChartLegend, type ChartLike, ChartTooltip, ChartTypeButtonGroup, type ChartTypeLike, type DashboardExtraLike, type DashboardLike, type DashboardVisibilityLike, DataControls, type DataSourceTypeLike, type EChartsHandle, type EChartsOption, EventsFunctionCategories, EventsFunctionMap, type FunctionDef, FunctionInput, FunctionMap, FunctionsCategories, FunctionsPanel, type GroupLike, type GroupStyleLike, LabelControls, LabelSearchProvider, LabelsInput, type LayoutItemLike, type LayoutsLike, LineControls, SvgIcon$7 as LineIcon, type MarkArea, type MarkLine, MarkerControls, type NoteAlignmentLike, type NoteFontSizeLike, type NoteLike, type NoteVerticalAlignmentLike, type OverlayGraphLike, type PanelLike, PieChart, PieChartControls, type PieChartProps, SvgIcon$3 as PieIcon, type PieSeriesInput, QueryValueChart, type QueryValueChartProps, SvgIcon$2 as QueryValueIcon, ReactEChartsBase, type ReactEChartsProps, RefreshButton, RefreshContext, type ResponsiveLayoutsLike, ScatterChartTooltip, ScatterControls, SvgIcon$1 as ScatterIcon, SystemLabels, SvgIcon as TableIcon, type TemplateVariableLike, type TemplateViewLike, TimeSeriesChart, type TimeSeriesChartProps, ValueControls, type ValueFormatter, ValueFormatters, ValueOptions, ValueStringMapping, type ViewActionContext, XAxisControls, type YAxisConfigLike, YaxisControls, defaultConfig$4 as defaultBarGaugeConfig, defaultConfig$1 as defaultDataConfig, defaultConfig$5 as defaultPieConfig, defaultConfig as defaultScatterConfig, defaultConfig$3 as defaultValueConfig, defaultConfig$2 as defaultValueControlsConfig, isAggrOrRollupFunction, sentioColors, sentioTheme, sentioThemeDark, sortMetricByName, useLabelSearch, useLabelSearchContext };