@spider-analyzer/timeline 4.0.2 → 5.0.0

package/dist/index.d.mts

@@ -0,0 +1,132 @@
+import { ComponentType, ReactNode, Ref } from 'react';
+
+interface Domain {
+    min: Date;
+    max: Date;
+}
+interface TimeSpan {
+    start: Date;
+    stop: Date;
+}
+interface HistoItem {
+    time: Date;
+    metrics: number[];
+    total: number;
+}
+interface Histo {
+    items: HistoItem[];
+    intervalMs: number | null;
+}
+interface QualityItem {
+    time: Date;
+    quality: number;
+    tip?: ReactNode;
+}
+interface Quality {
+    items: QualityItem[];
+    intervalMin?: number;
+}
+interface MetricsDefinition {
+    count: number;
+    legends: string[];
+    colors: Array<{
+        fill: string;
+        stroke: string;
+        text: string;
+    }>;
+}
+interface TimeLineTools {
+    slideForward?: boolean;
+    slideBackward?: boolean;
+    resetTimeline?: boolean;
+    gotoNow?: boolean;
+    cursor?: boolean;
+    zoomIn?: boolean;
+    zoomOut?: boolean;
+}
+interface AxisConfig {
+    spaceBetweenTicks?: number;
+    barsBetweenTicks?: number;
+    height?: number;
+    showGrid?: boolean;
+}
+interface MarginConfig {
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+}
+interface TimeLineHandle {
+    zoomIn(): void;
+    zoomOut(): void;
+    shiftTimeLine(delta: number): void;
+}
+interface TimeLineProps {
+    className?: string;
+    classes?: Record<string, string>;
+    rcToolTipPrefixCls?: string;
+    timeSpan: TimeSpan;
+    histo: Histo;
+    quality?: Quality;
+    /**
+     * The currently-visible window, controlled by the host.
+     * Pass `null` on first render if you don't have a default yet — the
+     * component will call `onLoadDefaultDomain()` and wait for its result.
+     *
+     * Zoom-out undo is handled internally; the host only needs to observe
+     * `onDomainChange` and re-render with whatever domain it wants.
+     */
+    domain: Domain | null;
+    maxDomain?: Domain;
+    metricsDefinition: MetricsDefinition;
+    /** IANA time-zone name (e.g. "UTC", "Europe/Paris"). Required. */
+    timeZone?: string;
+    zoomOutFactor?: number;
+    /** Maximum visible duration, in milliseconds. */
+    biggestVisibleDomain?: number;
+    /** Maximum selectable duration, in milliseconds. */
+    biggestTimeSpan?: number;
+    /** Smallest zoom step (15 px == this value), in milliseconds. */
+    smallestResolution?: number;
+    tools?: TimeLineTools;
+    fetchWhileSliding?: boolean;
+    selectBarOnClick?: boolean;
+    showHistoToolTip?: boolean;
+    xAxis?: AxisConfig;
+    yAxis?: AxisConfig;
+    margin?: MarginConfig;
+    labels?: Record<string, unknown>;
+    /** Called on mount when `domain` is null. Return (sync or Promise) the
+     *  default domain; the component seeds its internal stack from it and
+     *  fires `onDomainChange` once resolved.
+     */
+    onLoadDefaultDomain(): Domain | Promise<Domain> | void;
+    /** Called whenever the component needs histogram data for a window. */
+    onLoadHisto(args: {
+        intervalMs: number;
+        start: Date;
+        end: Date;
+    }): void;
+    /** Called when the cursor selection changes (resize, drag, draw, goto). */
+    onTimeSpanChange(span: TimeSpan): void;
+    onShowMessage(message: ReactNode): void;
+    /** Called when the visible domain changes — zoom in/out, pan, or edge shift. */
+    onDomainChange(domain: Domain): void;
+    onResetTime(): void;
+    onFormatTimeToolTips(time: Date): ReactNode;
+    onFormatTimeLegend(time: Date): string;
+    onFormatMetricLegend(value: number): string;
+}
+interface TimeLineResizerProps extends TimeLineProps {
+}
+type TimeLineComponent = ComponentType<TimeLineProps & {
+    ref?: Ref<TimeLineHandle>;
+}>;
+type TimeLineResizerComponent = ComponentType<TimeLineResizerProps & {
+    ref?: Ref<TimeLineHandle>;
+}>;
+declare const _TimeLine: TimeLineComponent;
+declare const _TimeLineResizer: TimeLineResizerComponent;
+declare const _Cursor: ComponentType<Record<string, unknown>>;
+
+export { type AxisConfig, _Cursor as Cursor, type Domain, type Histo, type HistoItem, type MarginConfig, type MetricsDefinition, type Quality, type QualityItem, _TimeLine as TimeLine, type TimeLineHandle, type TimeLineProps, type TimeLineResizerProps, type TimeLineTools, type TimeSpan, _TimeLineResizer as default };

package/dist/index.d.ts

@@ -0,0 +1,132 @@
+import { ComponentType, ReactNode, Ref } from 'react';
+
+interface Domain {
+    min: Date;
+    max: Date;
+}
+interface TimeSpan {
+    start: Date;
+    stop: Date;
+}
+interface HistoItem {
+    time: Date;
+    metrics: number[];
+    total: number;
+}
+interface Histo {
+    items: HistoItem[];
+    intervalMs: number | null;
+}
+interface QualityItem {
+    time: Date;
+    quality: number;
+    tip?: ReactNode;
+}
+interface Quality {
+    items: QualityItem[];
+    intervalMin?: number;
+}
+interface MetricsDefinition {
+    count: number;
+    legends: string[];
+    colors: Array<{
+        fill: string;
+        stroke: string;
+        text: string;
+    }>;
+}
+interface TimeLineTools {
+    slideForward?: boolean;
+    slideBackward?: boolean;
+    resetTimeline?: boolean;
+    gotoNow?: boolean;
+    cursor?: boolean;
+    zoomIn?: boolean;
+    zoomOut?: boolean;
+}
+interface AxisConfig {
+    spaceBetweenTicks?: number;
+    barsBetweenTicks?: number;
+    height?: number;
+    showGrid?: boolean;
+}
+interface MarginConfig {
+    top?: number;
+    bottom?: number;
+    left?: number;
+    right?: number;
+}
+interface TimeLineHandle {
+    zoomIn(): void;
+    zoomOut(): void;
+    shiftTimeLine(delta: number): void;
+}
+interface TimeLineProps {
+    className?: string;
+    classes?: Record<string, string>;
+    rcToolTipPrefixCls?: string;
+    timeSpan: TimeSpan;
+    histo: Histo;
+    quality?: Quality;
+    /**
+     * The currently-visible window, controlled by the host.
+     * Pass `null` on first render if you don't have a default yet — the
+     * component will call `onLoadDefaultDomain()` and wait for its result.
+     *
+     * Zoom-out undo is handled internally; the host only needs to observe
+     * `onDomainChange` and re-render with whatever domain it wants.
+     */
+    domain: Domain | null;
+    maxDomain?: Domain;
+    metricsDefinition: MetricsDefinition;
+    /** IANA time-zone name (e.g. "UTC", "Europe/Paris"). Required. */
+    timeZone?: string;
+    zoomOutFactor?: number;
+    /** Maximum visible duration, in milliseconds. */
+    biggestVisibleDomain?: number;
+    /** Maximum selectable duration, in milliseconds. */
+    biggestTimeSpan?: number;
+    /** Smallest zoom step (15 px == this value), in milliseconds. */
+    smallestResolution?: number;
+    tools?: TimeLineTools;
+    fetchWhileSliding?: boolean;
+    selectBarOnClick?: boolean;
+    showHistoToolTip?: boolean;
+    xAxis?: AxisConfig;
+    yAxis?: AxisConfig;
+    margin?: MarginConfig;
+    labels?: Record<string, unknown>;
+    /** Called on mount when `domain` is null. Return (sync or Promise) the
+     *  default domain; the component seeds its internal stack from it and
+     *  fires `onDomainChange` once resolved.
+     */
+    onLoadDefaultDomain(): Domain | Promise<Domain> | void;
+    /** Called whenever the component needs histogram data for a window. */
+    onLoadHisto(args: {
+        intervalMs: number;
+        start: Date;
+        end: Date;
+    }): void;
+    /** Called when the cursor selection changes (resize, drag, draw, goto). */
+    onTimeSpanChange(span: TimeSpan): void;
+    onShowMessage(message: ReactNode): void;
+    /** Called when the visible domain changes — zoom in/out, pan, or edge shift. */
+    onDomainChange(domain: Domain): void;
+    onResetTime(): void;
+    onFormatTimeToolTips(time: Date): ReactNode;
+    onFormatTimeLegend(time: Date): string;
+    onFormatMetricLegend(value: number): string;
+}
+interface TimeLineResizerProps extends TimeLineProps {
+}
+type TimeLineComponent = ComponentType<TimeLineProps & {
+    ref?: Ref<TimeLineHandle>;
+}>;
+type TimeLineResizerComponent = ComponentType<TimeLineResizerProps & {
+    ref?: Ref<TimeLineHandle>;
+}>;
+declare const _TimeLine: TimeLineComponent;
+declare const _TimeLineResizer: TimeLineResizerComponent;
+declare const _Cursor: ComponentType<Record<string, unknown>>;
+
+export { type AxisConfig, _Cursor as Cursor, type Domain, type Histo, type HistoItem, type MarginConfig, type MetricsDefinition, type Quality, type QualityItem, _TimeLine as TimeLine, type TimeLineHandle, type TimeLineProps, type TimeLineResizerProps, type TimeLineTools, type TimeSpan, _TimeLineResizer as default };