@moderneinc/react-charts 1.1.0 → 1.2.0-next.2d0a72

package/dist/components/stacked-area-chart/stacked-area-chart.constants.d.ts

@@ -0,0 +1,115 @@
+/**
+ * Default colors for stacked area chart categories
+ * These colors are designed to work well together and provide good contrast
+ * Migration colors match the exact gradient used in ParliamentChart for visual consistency
+ */
+export declare const DEFAULT_STACKED_AREA_COLORS: {
+    readonly critical: "#dc3545";
+    readonly high: "#fd7e14";
+    readonly medium: "#ffc107";
+    readonly low: "#17a2b8";
+    readonly complete: "#40c048";
+    readonly inProgress: "#007bff";
+    readonly farthest: string | undefined;
+    readonly far: string | undefined;
+    readonly close: string | undefined;
+    readonly closest: string | undefined;
+    readonly completed: string | undefined;
+    readonly primary: "#007bff";
+    readonly secondary: "#6c757d";
+    readonly success: "#40c048";
+    readonly danger: "#dc3545";
+    readonly warning: "#ffc107";
+    readonly info: "#17a2b8";
+    readonly light: "#EDEFEF";
+    readonly dark: "#343a40";
+};
+/**
+ * Default configuration for stacked area chart
+ */
+export declare const DEFAULT_STACKED_AREA_CONFIG: {
+    readonly dimensions: {
+        readonly height: 400;
+        readonly width: "100%";
+        readonly minHeight: 200;
+    };
+    readonly margin: {
+        readonly top: 10;
+        readonly right: 30;
+        readonly left: 0;
+        readonly bottom: 0;
+    };
+    readonly animation: {
+        readonly enabled: true;
+        readonly duration: 1500;
+        readonly easing: "ease";
+    };
+    readonly display: {
+        readonly showHeader: true;
+        readonly showLegend: true;
+        readonly showTooltip: true;
+        readonly showXAxis: true;
+        readonly showYAxis: true;
+        readonly showGrid: true;
+    };
+    readonly curve: {
+        readonly type: "monotone";
+    };
+    readonly stack: {
+        readonly offset: "none";
+    };
+    readonly axis: {
+        readonly strokeColor: "#ADB5BD";
+        readonly tickColor: "#666";
+        readonly labelColor: "#666";
+    };
+    readonly tooltip: {
+        readonly backgroundColor: "rgba(255, 255, 255, 0.95)";
+        readonly borderColor: "#ADB5BD";
+        readonly borderWidth: 1;
+        readonly borderRadius: 4;
+        readonly padding: 10;
+    };
+    readonly legend: {
+        readonly iconSize: 14;
+        readonly iconType: "square";
+        readonly layout: "horizontal";
+        readonly align: "center";
+        readonly verticalAlign: "bottom";
+    };
+    readonly marker: {
+        readonly strokeColor: "#666";
+        readonly strokeWidth: 2;
+        readonly strokeDasharray: "5 5";
+        readonly labelColor: "#666";
+    };
+};
+/**
+ * Predefined color palettes for common use cases
+ */
+export declare const STACKED_AREA_PALETTES: {
+    readonly migration: string[];
+    readonly severity: readonly ["#dc3545", "#fd7e14", "#ffc107", "#17a2b8", "#17a2b8"];
+    readonly status: readonly ["#dc3545", "#ffc107", "#40c048"];
+    readonly extended: readonly ["#e74c3c", "#e67e22", "#f39c12", "#2ecc71", "#3498db", "#9b59b6", "#1abc9c", "#95a5a6"];
+    readonly colorblindSafe: readonly ["#0173B2", "#DE8F05", "#029E73", "#CC78BC", "#CA9161", "#FBAFE4", "#949494", "#ECE133"];
+};
+/**
+ * Category label constants for common use cases
+ * These match the categories used in ParliamentChart for transition compatibility
+ */
+export declare const CATEGORY_LABELS: {
+    readonly FARTHEST: "Farthest";
+    readonly FAR: "Far";
+    readonly CLOSE: "Close";
+    readonly CLOSEST: "Closest";
+    readonly COMPLETE: "Complete";
+    readonly CRITICAL: "Critical";
+    readonly HIGH: "High";
+    readonly MEDIUM: "Medium";
+    readonly LOW: "Low";
+    readonly INFO: "Info";
+    readonly NOT_APPLICABLE: "N/A";
+    readonly NO_LST: "No LST";
+    readonly DATA_MISSING: "Data Missing";
+};

package/dist/components/stacked-area-chart/stacked-area-chart.types.d.ts

@@ -0,0 +1,186 @@
+import { BoxProps, StackProps, TypographyProps } from '@mui/material';
+/**
+ * Represents a single data point in the stacked area chart.
+ * Each property beyond timestamp represents a category value at that point in time.
+ *
+ * Example:
+ * {
+ *   timestamp: 1704067200000,
+ *   Complete: 120,
+ *   Close: 45,
+ *   Far: 30
+ * }
+ */
+export type StackedAreaDataPoint = {
+    timestamp: number;
+    [category: string]: number;
+};
+/**
+ * Defines a category (area) in the stacked area chart.
+ * The dataKey must match a property in StackedAreaDataPoint.
+ */
+export type StackedAreaCategory = {
+    /** Key matching the property name in data points */
+    dataKey: string;
+    /** Display label for the category */
+    label: string;
+    /** Color for this area (hex color or CSS color string) */
+    color: string;
+    /** Optional stroke width in pixels (default: 2) */
+    strokeWidth?: number;
+    /** Optional dash pattern for the stroke (e.g., '5 5' for dashed) */
+    strokeDasharray?: string;
+    /** Optional fill opacity (0-1, default: 0.7) */
+    fillOpacity?: number;
+};
+/**
+ * Defines a marker (vertical line) at a specific timestamp.
+ * Markers are useful for highlighting significant events like releases, deployments, or milestones.
+ */
+export type StackedAreaMarker = {
+    /** Timestamp where the marker should be placed on the X-axis */
+    timestamp: number;
+    /** Optional label to display on the marker */
+    label?: string;
+    /** Optional color for the marker line (default: from config) */
+    color?: string;
+    /** Optional stroke width in pixels (default: from config) */
+    strokeWidth?: number;
+    /** Optional dash pattern for the stroke (e.g., '5 5' for dashed) */
+    strokeDasharray?: string;
+};
+/**
+ * Slot props for customizing stacked area chart component styles
+ */
+export type StackedAreaChartSlotProps = {
+    /** Props for the outer container (Stack) */
+    container?: StackProps;
+    /** Props for the header container (Stack) */
+    header?: StackProps;
+    /** Props for the title Typography component */
+    title?: TypographyProps;
+    /** Props for the subtitle/description Typography component */
+    subtitle?: TypographyProps;
+    /** Props for the chart container (Box) */
+    chartContainer?: BoxProps;
+};
+/**
+ * Props for the StackedAreaChart component
+ */
+export type StackedAreaChartProps = {
+    /** Array of data points sorted by timestamp (ascending) */
+    data: StackedAreaDataPoint[];
+    /** Array of category definitions for the areas to display */
+    categories: StackedAreaCategory[];
+    /** Optional array of markers (vertical lines) to display at specific timestamps */
+    markers?: StackedAreaMarker[];
+    /** Optional title displayed above the chart */
+    title?: string;
+    /** Optional subtitle/description displayed below the title */
+    subtitle?: string;
+    /** Show the chart header (title and subtitle) */
+    showHeader?: boolean;
+    /** Height of the chart in pixels (default: 400) */
+    height?: number;
+    /** Width of the chart (default: '100%') */
+    width?: string | number;
+    /** Show the legend */
+    showLegend?: boolean;
+    /** Show the tooltip on hover */
+    showTooltip?: boolean;
+    /** Show X-axis labels */
+    showXAxis?: boolean;
+    /** Show Y-axis labels */
+    showYAxis?: boolean;
+    /** Show grid lines */
+    showGrid?: boolean;
+    /** Enable animations */
+    enableAnimation?: boolean;
+    /** Animation duration in milliseconds (default: 1500) */
+    animationDuration?: number;
+    /** Animation easing function (default: 'ease') */
+    animationEasing?: 'ease' | 'ease-in' | 'ease-out' | 'ease-in-out' | 'linear';
+    /** Custom date formatter for X-axis and tooltip */
+    formatDate?: (timestamp: number) => string;
+    /** Custom value formatter for Y-axis and tooltip */
+    formatValue?: (value: number) => string;
+    /** Custom tooltip formatter */
+    tooltipFormatter?: (value: number, name: string, props: unknown) => [string, string];
+    /** Props for customizing individual component slots */
+    slotProps?: StackedAreaChartSlotProps;
+    /** Margin around the chart (for axis labels) */
+    margin?: {
+        top?: number;
+        right?: number;
+        bottom?: number;
+        left?: number;
+    };
+    /**
+     * Curve type for the area paths
+     * - 'monotone': Smooth curves that preserve monotonicity
+     * - 'linear': Straight lines between points
+     * - 'step': Step function
+     * - 'stepBefore': Step function with vertical at start
+     * - 'stepAfter': Step function with vertical at end
+     */
+    curveType?: 'monotone' | 'linear' | 'step' | 'stepBefore' | 'stepAfter';
+    /**
+     * Stack offset type
+     * - 'none': Stack normally
+     * - 'expand': Normalize to 0-100%
+     * - 'wiggle': Streamgraph layout
+     * - 'silhouette': Centered streamgraph
+     */
+    stackOffset?: 'none' | 'expand' | 'wiggle' | 'silhouette';
+    /**
+     * External time domain control [minTimestamp, maxTimestamp]
+     * When provided, overrides automatic domain calculation and controls the X-axis range.
+     * Useful for synchronizing multiple charts to show the same time range.
+     */
+    timeRange?: [number, number] | null;
+    /**
+     * Callback when user selects a time range via brush or other interaction
+     * Returns [startTimestamp, endTimestamp]
+     */
+    onTimeRangeChange?: (range: [number, number]) => void;
+    /**
+     * Enable brush component for time range selection
+     * When enabled, displays a brush control below the chart that users can drag to select a time range.
+     * Triggers onTimeRangeChange callback when the brush is moved.
+     */
+    enableBrush?: boolean;
+    /**
+     * Zoom to selection mode - When enabled, dragging to select a range
+     * will automatically rescale the chart to show only that range via the timeRange prop.
+     * Selection highlight only shows during drag.
+     */
+    zoomToSelection?: boolean;
+};
+/**
+ * Props for the custom hook
+ */
+export type UseStackedAreaChartProps = {
+    data: StackedAreaDataPoint[];
+    categories: StackedAreaCategory[];
+    formatDate?: (timestamp: number) => string;
+    formatValue?: (value: number) => string;
+};
+/**
+ * Return type for the custom hook
+ */
+export type UseStackedAreaChartReturn = {
+    /** Validated and processed data */
+    processedData: StackedAreaDataPoint[];
+    /** Validated categories */
+    processedCategories: StackedAreaCategory[];
+    /** Minimum timestamp in data */
+    minTimestamp: number;
+    /** Maximum timestamp in data */
+    maxTimestamp: number;
+    /** Total value at each timestamp (sum of all categories) */
+    maxTotalValue: number;
+    /** Default date formatter */
+    dateFormatter: (timestamp: number) => string;
+    /** Default value formatter */
+    valueFormatter: (value: number) => string;
+};

package/dist/components/stacked-area-chart/utils/color.utils.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Generates gradient colors for categories, ordered from worst (red) to best (green).
+ */
+export declare function generateMeasureGradient(count: number): string[];

package/dist/components/timeline-chart/hooks/use-timeline-chart.hook.d.ts

@@ -0,0 +1,2 @@
+import { UseTimelineChartProps, UseTimelineChartReturn } from '../timeline-chart.types';
+export declare const useTimelineChart: ({ events, selectedRange, onSelectionChange, enableZoom, zoomToSelection, visibleRange, onVisibleRangeChange }: UseTimelineChartProps) => UseTimelineChartReturn;

package/dist/components/timeline-chart/timeline-chart.component.d.ts

@@ -0,0 +1,9 @@
+import { FunctionComponent } from 'react';
+import { TimelineChartProps } from './timeline-chart.types';
+/**
+ * TimelineChart component - Interactive timeline with drag selection and zoom
+ *
+ * Displays events on a timeline with interactive selection capabilities.
+ * Users can click and drag to select date ranges, and use mouse wheel to zoom.
+ */
+export declare const TimelineChart: FunctionComponent<TimelineChartProps>;

package/dist/components/timeline-chart/timeline-chart.types.d.ts

@@ -0,0 +1,126 @@
+import { BoxProps, StackProps, TypographyProps } from '@mui/material';
+export type TimelineEvent = {
+    date: Date;
+    timestamp: number;
+    eventName: string;
+    [key: string]: unknown;
+};
+export type TimelineSelection = {
+    start: number | null;
+    end: number | null;
+};
+export type TimelineChartSlotProps = {
+    /** Props for the header container (Stack) */
+    header?: StackProps;
+    /** Props for the title Typography component */
+    title?: TypographyProps;
+    /** Props for the instructions Typography component */
+    instructions?: TypographyProps;
+    /** Props for the month labels container (Stack) */
+    monthLabelsContainer?: StackProps;
+    /** Props for individual month label Typography components */
+    monthLabel?: TypographyProps;
+    /** Props for the timeline container (Box) */
+    timeline?: BoxProps;
+    /** Props for individual event markers (Box) */
+    event?: BoxProps;
+    /** Props for the selection highlight overlay (Box) */
+    selection?: BoxProps;
+    /** Props for the hover tooltip container (Box) */
+    tooltip?: BoxProps;
+    /** Props for the tooltip event name Typography component */
+    tooltipEventName?: TypographyProps;
+    /** Props for the tooltip date Typography component */
+    tooltipDate?: TypographyProps;
+};
+export type TimelineChartProps = {
+    /** Array of events to display on the timeline (must be sorted by timestamp) */
+    events: TimelineEvent[];
+    /** Callback when selection changes */
+    onSelectionChange?: (selection: TimelineSelection) => void;
+    /** Controlled selection state (optional) */
+    selectedRange?: TimelineSelection;
+    /** Height of the timeline container in pixels (default: 32) */
+    height?: number;
+    /** Custom date formatter */
+    formatDate?: (timestamp: number) => string;
+    /** Custom month/year formatter */
+    formatMonthYear?: (timestamp: number) => string;
+    /** Show month labels at top */
+    showMonthLabels?: boolean;
+    /** Number of month labels to display (default: 6) */
+    monthLabelCount?: number;
+    /** Enable zoom with mouse wheel */
+    enableZoom?: boolean;
+    /** Show header title and instructions (default: true) */
+    showHeader?: boolean;
+    /** Custom title for the header */
+    title?: string;
+    /**
+     * Zoom to selection mode - When enabled, dragging to select a range
+     * will automatically rescale the timeline to show only that range.
+     * Selection highlight only shows during drag.
+     */
+    zoomToSelection?: boolean;
+    /** Callback when the visible range changes (for zoom to selection mode) */
+    onVisibleRangeChange?: (range: TimelineSelection) => void;
+    /** Controlled visible range (for zoom to selection mode) */
+    visibleRange?: TimelineSelection;
+    /**
+     * External time domain control [minTimestamp, maxTimestamp]
+     * Simplified alias for visibleRange that uses tuple format instead of object format.
+     * When provided, overrides automatic domain calculation and controls the visible time range.
+     * Useful for synchronizing multiple charts to show the same time range.
+     * Note: This is converted internally to visibleRange format { start, end }
+     */
+    timeRange?: [number, number] | null;
+    /**
+     * Callback when the visible time range changes
+     * Simplified alias for onVisibleRangeChange that uses tuple format [start, end].
+     * Note: This is converted internally to/from TimelineSelection format { start, end }
+     */
+    onTimeRangeChange?: (range: [number, number]) => void;
+    /** Props for individual component slots */
+    slotProps?: TimelineChartSlotProps;
+};
+export type UseTimelineChartProps = {
+    events: TimelineEvent[];
+    selectedRange?: TimelineSelection;
+    onSelectionChange?: (selection: TimelineSelection) => void;
+    enableZoom: boolean;
+    zoomToSelection: boolean;
+    visibleRange?: TimelineSelection;
+    onVisibleRangeChange?: (range: TimelineSelection) => void;
+};
+export type UseTimelineChartReturn = {
+    isDragging: boolean;
+    dragStart: number | null;
+    internalSelectedRange: TimelineSelection;
+    internalVisibleRange: TimelineSelection;
+    hoveredEvent: TimelineEvent | null;
+    minDate: number;
+    maxDate: number;
+    timeSpan: number;
+    getPositionFromTimestamp: (timestamp: number) => number;
+    getTimestampFromPosition: (x: number, containerWidth: number) => number;
+    handleMouseDown: (e: React.MouseEvent<HTMLDivElement>) => void;
+    handleMouseMove: (e: React.MouseEvent<HTMLDivElement>) => void;
+    handleMouseUp: () => void;
+    handleWheel: (e: React.WheelEvent<HTMLDivElement>) => void;
+    handleDoubleClick: () => void;
+    setHoveredEvent: (event: TimelineEvent | null) => void;
+    getEventsInRange: () => TimelineEvent[];
+    resetZoom: () => void;
+};
+export type TimelineSelectedEventsProps = {
+    /** Array of selected events to display */
+    events: TimelineEvent[];
+    /** Title for the selected events section */
+    title?: string;
+    /** Maximum height before scrolling */
+    maxHeight?: string;
+    /** Custom date formatter */
+    formatDate?: (timestamp: number) => string;
+    /** Primary color for event items */
+    primaryColor?: string;
+};

package/dist/components/timeline-chart/timeline-selected-events.component.d.ts

@@ -0,0 +1,9 @@
+import { FunctionComponent } from 'react';
+import { TimelineSelectedEventsProps } from './timeline-chart.types';
+/**
+ * TimelineSelectedEvents component - Displays selected events from timeline
+ *
+ * This component observes and displays events that have been selected in a timeline.
+ * It can be used independently alongside the TimelineChart component.
+ */
+export declare const TimelineSelectedEvents: FunctionComponent<TimelineSelectedEventsProps>;