@alert-whatif/ui 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 The Alertcraft Authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OF OR OTHER DEALINGS IN
+THE SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,244 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { Sample, MetricSeries, AlertConfig, GrafanaAlertState, Result, GrafanaRuleObservation, RuleSummary, Threshold, Duration, NoDataState, ExecErrState, ReducerKind, NanMode, Tick, EvalEvent } from '@alert-whatif/core';
+export { GrafanaAlertState, GrafanaRuleObservation, RuleSummary } from '@alert-whatif/core';
+import { ReactNode } from 'react';
+
+type RuleMetadata = {
+    readonly title: string;
+    readonly labels: Readonly<Record<string, string>>;
+    readonly paused: boolean;
+    readonly query: {
+        readonly expr: string;
+        readonly mode: 'range' | 'instant';
+    };
+    readonly updatedMs?: number;
+};
+
+type WhatIfDataSourceCapabilities = {
+    readonly fixtures: boolean;
+    readonly live: boolean;
+    readonly fetchRuleByUid: boolean;
+    readonly fetchRuleList: boolean;
+    readonly grafanaStateOracle: boolean;
+    readonly initialStateOracle: boolean;
+    readonly alertHistoryOracle: boolean;
+    readonly snapshot: boolean;
+};
+type SampleRequest = {
+    readonly datasourceUid: string;
+    readonly expr: string;
+    readonly startSec: number;
+    readonly endSec: number;
+    readonly stepSec: number;
+};
+type Dataset = {
+    readonly id: string;
+    readonly displayName: string;
+    readonly description: string;
+    readonly source: string;
+    readonly samples: ReadonlyArray<Sample>;
+    readonly seriesList?: ReadonlyArray<MetricSeries>;
+    readonly defaultAlertConfig: AlertConfig;
+    readonly rateInnerWindow?: number;
+    readonly evalGridOffsetMs?: number;
+    readonly endTimeMs?: number;
+    readonly startTimeMs?: number;
+    readonly drillFocalMs?: number;
+    readonly drillFocalSide?: 'leading' | 'trailing';
+    readonly grafanaHistory?: ReadonlyArray<{
+        readonly t: number;
+        readonly state: GrafanaAlertState;
+    }>;
+    readonly ruleMetadata?: RuleMetadata;
+};
+interface WhatIfDataSource {
+    readonly capabilities: WhatIfDataSourceCapabilities;
+    fetchSamples(req: SampleRequest): Promise<Result<ReadonlyArray<MetricSeries>, string>>;
+    fetchRuleState?(ruleTitle: string): Promise<GrafanaRuleObservation>;
+    listFixtures?(): ReadonlyArray<Dataset>;
+    fetchRuleByUid?(uid: string): Promise<unknown | null>;
+    listRules?(): Promise<Result<ReadonlyArray<RuleSummary>, string>>;
+    fetchInitialAlertState?(ruleTitle: string, atTimeMs: number): Promise<Result<'Normal' | 'Firing' | 'NoData', string>>;
+    fetchAlertHistory?(ruleTitle: string, fromMs: number, toMs: number): Promise<Result<ReadonlyArray<{
+        readonly t: number;
+        readonly state: GrafanaAlertState;
+    }>, string>>;
+}
+
+type ConfigOverrides = {
+    readonly threshold?: Threshold;
+    readonly forDuration?: Duration;
+    readonly keepFiringFor?: Duration;
+    readonly evaluationInterval?: Duration;
+    readonly intervalMs?: Duration;
+    readonly maxDataPoints?: number;
+    readonly noDataState?: NoDataState;
+    readonly execErrState?: ExecErrState;
+    readonly windowDuration?: Duration;
+    readonly reducer?: ReducerKind;
+    readonly nanMode?: NanMode;
+};
+type WhatIfPreset = {
+    readonly datasetId?: string;
+    readonly overrides?: ConfigOverrides;
+    readonly tick?: number;
+};
+type LiveContext = {
+    readonly datasourceUid: string;
+    readonly query: string;
+    readonly ruleTitle: string;
+    readonly defaultConfig: AlertConfig;
+    readonly ruleMetadata?: RuleMetadata;
+    readonly rateInnerWindow?: number;
+    readonly footerSlot?: ReactNode;
+};
+type Props$5 = {
+    readonly adapter: WhatIfDataSource;
+    readonly themeToggleSlot?: ReactNode;
+    readonly liveContext?: LiveContext;
+    readonly initialRuleUid?: string;
+    readonly initialPreset?: WhatIfPreset;
+    readonly initialLookbackSec?: number;
+    readonly initialDrill?: 'first' | 'last';
+    readonly initialPlay?: boolean;
+    readonly titleLogo?: ReactNode;
+};
+
+declare function WhatIfPage({ adapter, themeToggleSlot, liveContext, initialRuleUid, initialPreset, initialLookbackSec, initialDrill, initialPlay, titleLogo, }: Props$5): react_jsx_runtime.JSX.Element;
+
+type CrossingDirection = 'ignition' | 'resolution';
+type ThresholdCrossing = {
+    readonly t: number;
+    readonly v: number;
+    readonly direction: CrossingDirection;
+};
+
+type Props$4 = {
+    readonly samples: ReadonlyArray<Sample>;
+    readonly visibleSamples?: ReadonlyArray<Sample>;
+    readonly ticks?: ReadonlyArray<Tick>;
+    readonly rightAnchorT?: number | undefined;
+    readonly yMax?: number | undefined;
+    readonly threshold: Threshold;
+    readonly evaluationInterval: number;
+    readonly windowDuration: number;
+    readonly crossings?: ReadonlyArray<ThresholdCrossing>;
+    readonly reducer?: ReducerKind;
+    readonly events?: ReadonlyArray<EvalEvent>;
+    readonly baselineEvents?: ReadonlyArray<EvalEvent>;
+    readonly subtitle?: string;
+    readonly currentState?: EvalEvent['kind'] | 'Normal';
+    readonly initialState?: 'Normal' | 'Firing' | 'NoData';
+    readonly displayEndT?: number;
+    readonly displayStartT?: number;
+    readonly focalMs?: number;
+    readonly pollSignal?: number;
+    readonly grafanaHistory?: ReadonlyArray<{
+        readonly t: number;
+        readonly state: string;
+    }> | undefined;
+    readonly grafanaHistoryEnd?: number | undefined;
+    readonly bottomSlot?: ReactNode;
+};
+declare function MetricChart({ samples, visibleSamples, ticks, threshold, evaluationInterval, windowDuration, crossings: crossingsOverride, reducer, events, subtitle, rightAnchorT, yMax, bottomSlot, currentState, grafanaHistory, grafanaHistoryEnd, baselineEvents, initialState, displayEndT, displayStartT, focalMs, pollSignal, }: Props$4): react_jsx_runtime.JSX.Element;
+
+type Props$3 = {
+    readonly config: AlertConfig;
+    readonly onChange: (next: AlertConfig) => void;
+    readonly onApply: () => void;
+    readonly onReset: () => void;
+    readonly ruleMetadata?: RuleMetadata | undefined;
+    readonly paused?: boolean | undefined;
+    readonly onPausedChange?: ((paused: boolean) => void) | undefined;
+    readonly changedLabels?: ReadonlySet<string> | undefined;
+};
+declare function ParamControls({ config, onChange, onApply, onReset, ruleMetadata, paused, onPausedChange, changedLabels, }: Props$3): react_jsx_runtime.JSX.Element;
+
+type OurState = 'Normal' | 'Pending' | 'Firing' | 'NoData' | 'Recovering';
+
+type CommonProps = {
+    readonly ourState: OurState;
+    readonly query?: string;
+    readonly pillExtra?: ReactNode;
+};
+type LiveProps = CommonProps & {
+    readonly mode: 'live';
+    readonly grafanaState?: GrafanaAlertState;
+    readonly lastPollAt: number | null;
+    readonly intervalSec: number;
+    readonly error: string | null;
+    readonly onSnapshot?: () => void;
+    readonly canSnapshot?: boolean;
+    readonly onExport?: () => void;
+    readonly canExport?: boolean;
+    readonly onImport?: (file: File) => void;
+    readonly exportToast?: string | null;
+    readonly footerSlot?: ReactNode;
+};
+type MockProps = CommonProps & {
+    readonly mode: 'mock';
+    readonly replayButtons: ReactNode;
+    readonly tickIndex: number;
+    readonly tickCount: number;
+    readonly grafanaState?: GrafanaAlertState;
+    readonly onExport?: () => void;
+    readonly onImport?: (file: File) => void;
+};
+type Props$2 = LiveProps | MockProps;
+declare function LiveStatusStrip(props: Props$2): react_jsx_runtime.JSX.Element;
+
+type Props$1 = {
+    readonly rules: ReadonlyArray<RuleSummary>;
+    readonly selectedUid: string | null;
+    readonly onSelect: (uid: string) => void;
+    readonly loading: boolean;
+    readonly error: string | null;
+    readonly onRefresh?: () => void;
+};
+declare function RulePicker({ rules, selectedUid, onSelect, loading, error, onRefresh, }: Props$1): react_jsx_runtime.JSX.Element;
+
+type Theme = 'dark' | 'light';
+declare function useTheme(): readonly [Theme, (next: Theme) => void];
+
+type Props = {
+    readonly theme: Theme;
+    readonly onChange: (next: Theme) => void;
+};
+declare function ThemeToggle({ theme, onChange }: Props): react_jsx_runtime.JSX.Element;
+
+type LiveModeOptions = {
+    readonly active: boolean;
+    readonly datasourceUid: string;
+    readonly query: string;
+    readonly ruleTitle: string;
+    readonly intervalSec: number;
+    readonly lookbackSec: number;
+    readonly stepSec: number;
+    readonly evaluationIntervalMs: number;
+};
+type LiveModeState = {
+    readonly samples: ReadonlyArray<Sample>;
+    readonly grafanaState: GrafanaAlertState;
+    readonly lastPollAt: number | null;
+    readonly grafanaLastEvalMs: number | null;
+    readonly grafanaLatestEvalMs: number | null;
+    readonly error: string | null;
+};
+declare function useLiveMode(opts: LiveModeOptions, adapter: WhatIfDataSource): LiveModeState;
+
+declare function describeFetchError(err: unknown): string;
+
+type PromQueryRangeResponse = {
+    readonly status: 'success' | 'error';
+    readonly error?: string;
+    readonly errorType?: string;
+    readonly data?: {
+        readonly resultType: 'matrix';
+        readonly result: ReadonlyArray<{
+            readonly metric: Readonly<Record<string, string>>;
+            readonly values: ReadonlyArray<readonly [number, string]>;
+        }>;
+    };
+};
+
+export { type ConfigOverrides, type Dataset, LiveStatusStrip, MetricChart, ParamControls, type PromQueryRangeResponse, type RuleMetadata, RulePicker, type Theme, ThemeToggle, type WhatIfDataSource, WhatIfPage, type WhatIfPreset, describeFetchError, useLiveMode, useTheme };