gantt-lib 0.18.0 → 0.20.0

package/dist/index.d.ts

@@ -1,6 +1,205 @@
 import React$1 from 'react';
 import * as RadixPopover from '@radix-ui/react-popover';
 
+/**
+ * Parse date string as UTC to prevent DST issues
+ * @param date - Date string or Date object
+ * @returns Date object representing UTC midnight
+ * @throws Error if date string is invalid
+ */
+declare const parseUTCDate: (date: string | Date) => Date;
+/**
+ * Get all days in the month of given date (UTC)
+ * @param date - Reference date (any day in the target month)
+ * @returns Array of Date objects for each day in the month
+ */
+declare const getMonthDays: (date: Date | string) => Date[];
+/**
+ * Calculate day offset from month start (0-based)
+ * @param date - The date to calculate offset for
+ * @param monthStart - The start of the month as reference
+ * @returns Number of days from month start (negative if date is before month start)
+ */
+declare const getDayOffset: (date: Date, monthStart: Date) => number;
+/**
+ * Check if date is today (local timezone comparison)
+ * Uses local time to determine today's date boundary so the result matches
+ * the user's timezone rather than UTC (prevents off-by-one errors at midnight).
+ * @param date - Date to check
+ * @returns True if date is today, false otherwise
+ */
+declare const isToday: (date: Date) => boolean;
+/**
+ * Check if date is a weekend day (Saturday or Sunday)
+ * @param date - Date to check
+ * @returns True if date is Saturday (6) or Sunday (0), false otherwise
+ */
+declare const isWeekend: (date: Date) => boolean;
+/**
+ * Create a UTC-safe key for Set-based date lookup
+ * @param date - Date object to create key from
+ * @returns String key in "YYYY-M-D" format using UTC date components
+ *
+ * Example:
+ * createDateKey(new Date(Date.UTC(2026, 2, 15))) // "2026-2-15"
+ *
+ * Note: Uses UTC methods to prevent DST and timezone issues.
+ * Month is 0-indexed (0=January, 11=December) per JavaScript Date convention.
+ */
+declare const createDateKey: (date: Date) => string;
+/**
+ * Configuration for a single custom day
+ */
+interface CustomDayConfig {
+    /** The date to customize */
+    date: Date;
+    /** Type of day: 'weekend' marks as weekend, 'workday' marks as workday */
+    type: 'weekend' | 'workday';
+}
+/**
+ * Configuration for custom day predicate
+ */
+interface CustomDayPredicateConfig {
+    /** Array of custom day configurations with explicit types */
+    customDays?: CustomDayConfig[];
+    /** Optional base weekend predicate (checked before customDays overrides) */
+    isWeekend?: (date: Date) => boolean;
+}
+/**
+ * Create a weekend predicate with unified custom day support
+ *
+ * Precedence order (highest to lowest):
+ * 1. customDays.type='workday' - explicit workday (highest override)
+ * 2. customDays.type='weekend' - explicit weekend (override)
+ * 3. isWeekend (base predicate) - custom base logic
+ * 4. default - Saturday (6) and Sunday (0)
+ *
+ * @param config - Custom day configuration with array and optional predicate
+ * @returns Predicate function (date: Date) => boolean
+ *
+ * Example:
+ * // Simple holidays + working Saturdays
+ * const predicate = createCustomDayPredicate({
+ *   customDays: [
+ *     { date: new Date(Date.UTC(2026, 2, 15)), type: 'workday' }, // working Saturday
+ *     { date: new Date(Date.UTC(2026, 0, 1)), type: 'weekend' }  // holiday Tuesday
+ *   ]
+ * });
+ *
+ * // 4-day work week + occasional overrides
+ * const predicate2 = createCustomDayPredicate({
+ *   isWeekend: (date) => {
+ *     const day = date.getUTCDay();
+ *     return day === 0 || day === 6 || day === 5; // Sun+Sat+Fri
+ *   },
+ *   customDays: [
+ *     { date: new Date(Date.UTC(2026, 2, 10)), type: 'workday' } // working Friday
+ *   ]
+ * });
+ */
+declare const createCustomDayPredicate: (config: CustomDayPredicateConfig) => ((date: Date) => boolean);
+/**
+ * Calculate multi-month date range from task dates
+ * Expands range to include full months with padding on both ends for drag flexibility
+ * Adds 1 month before and 2 months after the task range
+ * @param tasks - Array of tasks with startDate and endDate
+ * @returns Array of Date objects for all days in the expanded range
+ */
+declare const getMultiMonthDays: (tasks: Array<{
+    startDate: string | Date;
+    endDate: string | Date;
+}>) => Date[];
+/**
+ * Calculate month spans within a date range
+ * @param dateRange - Array of Date objects representing the full range
+ * @returns Array of month span objects with month, days count, and start index
+ */
+declare const getMonthSpans: (dateRange: Date[]) => Array<{
+    month: Date;
+    days: number;
+    startIndex: number;
+}>;
+/**
+ * Format date as DD.MM (e.g., 25.03 for March 25th)
+ * @param date - Date to format
+ * @returns Formatted date string in DD.MM format
+ */
+declare const formatDateLabel: (date: Date | string) => string;
+/**
+ * Return block boundaries for week-view, splitting on month boundaries.
+ * Each block represents a column in the week-view header.
+ * Blocks are typically 7 days, but split on month boundaries so
+ * the first/last block of a month may be smaller.
+ *
+ * @param days - Array of dates from getMultiMonthDays
+ * @returns Array of start dates for each block, with actual block sizes
+ */
+interface WeekBlock {
+    /** Start date of this block */
+    startDate: Date;
+    /** Number of days in this block (≤7, splits on month boundaries) */
+    days: number;
+}
+/**
+ * Split the date range into blocks, primarily 7-day weeks,
+ * but splitting blocks on month boundaries for accurate month spans.
+ */
+declare const getWeekBlocks: (days: Date[]) => WeekBlock[];
+/**
+ * Represents a month span in week-view header row 1.
+ * In week-view, the width is calculated from actual day counts,
+ * not from a fixed column count.
+ */
+interface WeekSpan {
+    /** First day of the calendar month (UTC) */
+    month: Date;
+    /** Total number of days this month occupies across all blocks */
+    days: number;
+    /** Start index in the blocks array */
+    startIndex: number;
+}
+/**
+ * Calculate month spans based on week-block boundaries.
+ * Groups consecutive blocks that belong to the same month.
+ */
+declare const getWeekSpans: (days: Date[]) => WeekSpan[];
+interface MonthBlock {
+    /** Первый день месяца (UTC) */
+    startDate: Date;
+    /** Количество дней в этом месяце внутри dateRange (может быть меньше при обрезке) */
+    days: number;
+}
+/**
+ * Разбивает dateRange на блоки по месяцам.
+ * Каждый блок = один месяц (колонка в строке 2 month-view шапки).
+ * Блок на краях может быть неполным если dateRange начинается/заканчивается не с 1-го числа.
+ */
+declare const getMonthBlocks: (days: Date[]) => MonthBlock[];
+interface YearSpan {
+    /** 1 января года (UTC) */
+    year: Date;
+    /** Суммарное кол-во дней этого года внутри dateRange */
+    days: number;
+    /** Начальный индекс в массиве monthBlocks */
+    startIndex: number;
+}
+/**
+ * Группирует month-блоки по годам.
+ * Используется в строке 1 month-view шапки (year label).
+ */
+declare const getYearSpans: (days: Date[]) => YearSpan[];
+/**
+ * Normalize task dates to ensure startDate is always before or equal to endDate.
+ * If dates are swapped (endDate < startDate), they are automatically swapped.
+ * @param startDate - Task start date (string or Date)
+ * @param endDate - Task end date (string or Date)
+ * @returns Object with normalized startDate and endDate as ISO date strings (YYYY-MM-DD)
+ */
+declare const normalizeTaskDates: (startDate: string | Date, endDate: string | Date) => {
+    startDate: string;
+    endDate: string;
+};
+
 /**
  * Dependency link types following PM standard
  * - FS (Finish-to-Start): Predecessor must finish before successor starts
@@ -252,6 +451,10 @@ interface GanttChartProps {
     enableAddTask?: boolean;
     /** View mode: 'day' renders one column per day, 'week' renders one column per 7 days, 'month' renders one column per month (default: 'day') */
     viewMode?: 'day' | 'week' | 'month';
+    /** Custom day configurations with explicit type (weekend or workday) */
+    customDays?: CustomDayConfig[];
+    /** Optional base weekend predicate (checked before customDays overrides) */
+    isWeekend?: (date: Date) => boolean;
 }
 /**
  * Ref handle type for GanttChart — exposes imperative scroll methods.
@@ -348,6 +551,8 @@ interface TimeScaleHeaderProps {
     headerHeight: number;
     /** View mode: 'day' renders individual day columns, 'week' renders 7-day week columns, 'month' renders one column per month */
     viewMode?: 'day' | 'week' | 'month';
+    /** Optional predicate for custom weekend logic (e.g., holidays, shift patterns) */
+    isCustomWeekend?: (date: Date) => boolean;
 }
 /**
  * TimeScaleHeader component - displays two-row date headers for the Gantt chart
@@ -370,6 +575,8 @@ interface GridBackgroundProps {
     totalHeight: number;
     /** View mode: 'day' renders per-day lines with weekend blocks, 'week' renders per-week lines only, 'month' renders per-month lines only */
     viewMode?: 'day' | 'week' | 'month';
+    /** Optional predicate for custom weekend logic (e.g., holidays, shift patterns) */
+    isCustomWeekend?: (date: Date) => boolean;
 }
 /**
  * GridBackground component - renders vertical grid lines and weekend background highlighting
@@ -463,6 +670,10 @@ interface TaskListProps {
     onPromoteTask?: (taskId: string) => void;
     /** Callback when task is demoted (parentId set to previous task) */
     onDemoteTask?: (taskId: string, newParentId: string) => void;
+    /** Custom day configurations for date picker */
+    customDays?: CustomDayConfig[];
+    /** Optional base weekend predicate for date picker */
+    isWeekend?: (date: Date) => boolean;
 }
 /**
  * TaskList component - displays tasks in a table format as an overlay
@@ -537,6 +748,8 @@ interface CalendarProps {
     initialDate?: Date;
     mode?: 'single' | 'range';
     disabled?: boolean;
+    /** Optional predicate for custom weekend logic (e.g., holidays, shift patterns) */
+    isWeekend?: (date: Date) => boolean;
 }
 declare const Calendar: React$1.FC<CalendarProps>;
 
@@ -555,6 +768,8 @@ interface DatePickerProps {
     className?: string;
     /** Whether the picker is disabled */
     disabled?: boolean;
+    /** Optional predicate for custom weekend logic */
+    isWeekend?: (date: Date) => boolean;
 }
 /**
  * DatePicker component — shows formatted date as a button, opens calendar popup on click.
@@ -638,142 +853,6 @@ interface UseTaskDragReturn {
  */
 declare const useTaskDrag: (options: UseTaskDragOptions) => UseTaskDragReturn;
 
-/**
- * Parse date string as UTC to prevent DST issues
- * @param date - Date string or Date object
- * @returns Date object representing UTC midnight
- * @throws Error if date string is invalid
- */
-declare const parseUTCDate: (date: string | Date) => Date;
-/**
- * Get all days in the month of given date (UTC)
- * @param date - Reference date (any day in the target month)
- * @returns Array of Date objects for each day in the month
- */
-declare const getMonthDays: (date: Date | string) => Date[];
-/**
- * Calculate day offset from month start (0-based)
- * @param date - The date to calculate offset for
- * @param monthStart - The start of the month as reference
- * @returns Number of days from month start (negative if date is before month start)
- */
-declare const getDayOffset: (date: Date, monthStart: Date) => number;
-/**
- * Check if date is today (local timezone comparison)
- * Uses local time to determine today's date boundary so the result matches
- * the user's timezone rather than UTC (prevents off-by-one errors at midnight).
- * @param date - Date to check
- * @returns True if date is today, false otherwise
- */
-declare const isToday: (date: Date) => boolean;
-/**
- * Check if date is a weekend day (Saturday or Sunday)
- * @param date - Date to check
- * @returns True if date is Saturday (6) or Sunday (0), false otherwise
- */
-declare const isWeekend: (date: Date) => boolean;
-/**
- * Calculate multi-month date range from task dates
- * Expands range to include full months with padding on both ends for drag flexibility
- * Adds 1 month before and 2 months after the task range
- * @param tasks - Array of tasks with startDate and endDate
- * @returns Array of Date objects for all days in the expanded range
- */
-declare const getMultiMonthDays: (tasks: Array<{
-    startDate: string | Date;
-    endDate: string | Date;
-}>) => Date[];
-/**
- * Calculate month spans within a date range
- * @param dateRange - Array of Date objects representing the full range
- * @returns Array of month span objects with month, days count, and start index
- */
-declare const getMonthSpans: (dateRange: Date[]) => Array<{
-    month: Date;
-    days: number;
-    startIndex: number;
-}>;
-/**
- * Format date as DD.MM (e.g., 25.03 for March 25th)
- * @param date - Date to format
- * @returns Formatted date string in DD.MM format
- */
-declare const formatDateLabel: (date: Date | string) => string;
-/**
- * Return block boundaries for week-view, splitting on month boundaries.
- * Each block represents a column in the week-view header.
- * Blocks are typically 7 days, but split on month boundaries so
- * the first/last block of a month may be smaller.
- *
- * @param days - Array of dates from getMultiMonthDays
- * @returns Array of start dates for each block, with actual block sizes
- */
-interface WeekBlock {
-    /** Start date of this block */
-    startDate: Date;
-    /** Number of days in this block (≤7, splits on month boundaries) */
-    days: number;
-}
-/**
- * Split the date range into blocks, primarily 7-day weeks,
- * but splitting blocks on month boundaries for accurate month spans.
- */
-declare const getWeekBlocks: (days: Date[]) => WeekBlock[];
-/**
- * Represents a month span in week-view header row 1.
- * In week-view, the width is calculated from actual day counts,
- * not from a fixed column count.
- */
-interface WeekSpan {
-    /** First day of the calendar month (UTC) */
-    month: Date;
-    /** Total number of days this month occupies across all blocks */
-    days: number;
-    /** Start index in the blocks array */
-    startIndex: number;
-}
-/**
- * Calculate month spans based on week-block boundaries.
- * Groups consecutive blocks that belong to the same month.
- */
-declare const getWeekSpans: (days: Date[]) => WeekSpan[];
-interface MonthBlock {
-    /** Первый день месяца (UTC) */
-    startDate: Date;
-    /** Количество дней в этом месяце внутри dateRange (может быть меньше при обрезке) */
-    days: number;
-}
-/**
- * Разбивает dateRange на блоки по месяцам.
- * Каждый блок = один месяц (колонка в строке 2 month-view шапки).
- * Блок на краях может быть неполным если dateRange начинается/заканчивается не с 1-го числа.
- */
-declare const getMonthBlocks: (days: Date[]) => MonthBlock[];
-interface YearSpan {
-    /** 1 января года (UTC) */
-    year: Date;
-    /** Суммарное кол-во дней этого года внутри dateRange */
-    days: number;
-    /** Начальный индекс в массиве monthBlocks */
-    startIndex: number;
-}
-/**
- * Группирует month-блоки по годам.
- * Используется в строке 1 month-view шапки (year label).
- */
-declare const getYearSpans: (days: Date[]) => YearSpan[];
-/**
- * Normalize task dates to ensure startDate is always before or equal to endDate.
- * If dates are swapped (endDate < startDate), they are automatically swapped.
- * @param startDate - Task start date (string or Date)
- * @param endDate - Task end date (string or Date)
- * @returns Object with normalized startDate and endDate as ISO date strings (YYYY-MM-DD)
- */
-declare const normalizeTaskDates: (startDate: string | Date, endDate: string | Date) => {
-    startDate: string;
-    endDate: string;
-};
-
 /**
  * Build adjacency list for dependency graph (task -> successors)
  */
@@ -993,9 +1072,21 @@ declare const calculateGridLines: (dateRange: Date[], dayWidth: number) => Array
  * Calculate weekend background blocks for a date range
  * @param dateRange - Array of Date objects representing the visible range
  * @param dayWidth - Width of each day column in pixels
+ * @param isCustomWeekend - Optional predicate for custom weekend logic (e.g., holidays, shift patterns)
  * @returns Array of weekend block objects with left position and width
- */
-declare const calculateWeekendBlocks: (dateRange: Date[], dayWidth: number) => Array<{
+ *
+ * Example:
+ * // Default behavior (Saturday/Sunday)
+ * calculateWeekendBlocks(dateRange, dayWidth)
+ *
+ * // Custom weekends (holidays, shifted workdays)
+ * const isCustomWeekend = createIsWeekendPredicate({
+ *   weekends: [new Date(Date.UTC(2026, 2, 8))], // March 8 holiday
+ *   workdays: [new Date(Date.UTC(2026, 2, 15))] // March 15 workday
+ * });
+ * calculateWeekendBlocks(dateRange, dayWidth, isCustomWeekend)
+ */
+declare const calculateWeekendBlocks: (dateRange: Date[], dayWidth: number, isCustomWeekend?: (date: Date) => boolean) => Array<{
     left: number;
     width: number;
 }>;
@@ -1107,4 +1198,4 @@ interface VisibleReorderPosition {
  */
 declare function getVisibleReorderPosition(orderedTasks: TaskLike[], visibleTasks: TaskLike[], movedTaskId: string, originVisibleIndex: number, dropVisibleIndex: number): VisibleReorderPosition | null;
 
-export { Button, type ButtonProps, Calendar, type CalendarProps, DatePicker, type DatePickerProps, DragGuideLines, GanttChart, type GanttChartHandle, type GanttChartProps, type GanttDateRange, GridBackground, type GridConfig, type GridLine, Input, type InputProps, type MonthBlock, type MonthSpan, Popover, PopoverContent, type PopoverContentProps, type PopoverProps, PopoverTrigger, type Task, type TaskBarGeometry, type TaskDependency, TaskList, type TaskListProps, TaskRow, TimeScaleHeader, TodayIndicator, type VisibleReorderPosition, type WeekBlock, type WeekSpan, type WeekendBlock, type YearSpan, buildAdjacencyList, calculateBezierPath, calculateDependencyPath, calculateGridLines, calculateGridWidth, calculateMonthGridLines, calculateOrthogonalPath, calculateSuccessorDate, calculateTaskBar, calculateWeekGridLines, calculateWeekendBlocks, cascadeByLinks, computeLagFromDates, computeParentDates, computeParentProgress, detectCycles, detectEdgeZone, findParentId, flattenHierarchy, formatDateLabel, getAllDependencyEdges, getChildren, getCursorForPosition, getDayOffset, getMonthBlocks, getMonthDays, getMonthSpans, getMultiMonthDays, getSuccessorChain, getTransitiveCascadeChain, getVisibleReorderPosition, getWeekBlocks, getWeekSpans, getYearSpans, isTaskParent, isToday, isWeekend, normalizeHierarchyTasks, normalizeTaskDates, parseUTCDate, pixelsToDate, recalculateIncomingLags, removeDependenciesBetweenTasks, universalCascade, useTaskDrag, validateDependencies };
+export { Button, type ButtonProps, Calendar, type CalendarProps, type CustomDayConfig, type CustomDayPredicateConfig, DatePicker, type DatePickerProps, DragGuideLines, GanttChart, type GanttChartHandle, type GanttChartProps, type GanttDateRange, GridBackground, type GridConfig, type GridLine, Input, type InputProps, type MonthBlock, type MonthSpan, Popover, PopoverContent, type PopoverContentProps, type PopoverProps, PopoverTrigger, type Task, type TaskBarGeometry, type TaskDependency, TaskList, type TaskListProps, TaskRow, TimeScaleHeader, TodayIndicator, type VisibleReorderPosition, type WeekBlock, type WeekSpan, type WeekendBlock, type YearSpan, buildAdjacencyList, calculateBezierPath, calculateDependencyPath, calculateGridLines, calculateGridWidth, calculateMonthGridLines, calculateOrthogonalPath, calculateSuccessorDate, calculateTaskBar, calculateWeekGridLines, calculateWeekendBlocks, cascadeByLinks, computeLagFromDates, computeParentDates, computeParentProgress, createCustomDayPredicate, createDateKey, detectCycles, detectEdgeZone, findParentId, flattenHierarchy, formatDateLabel, getAllDependencyEdges, getChildren, getCursorForPosition, getDayOffset, getMonthBlocks, getMonthDays, getMonthSpans, getMultiMonthDays, getSuccessorChain, getTransitiveCascadeChain, getVisibleReorderPosition, getWeekBlocks, getWeekSpans, getYearSpans, isTaskParent, isToday, isWeekend, normalizeHierarchyTasks, normalizeTaskDates, parseUTCDate, pixelsToDate, recalculateIncomingLags, removeDependenciesBetweenTasks, universalCascade, useTaskDrag, validateDependencies };