gantt-renderer 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,364 @@
+import { z } from "zod";
+
+//#region src/gantt-chart/validation/schemas.d.ts
+declare const LinkTypeSchema: z.ZodEnum<{
+  FS: "FS";
+  SS: "SS";
+  FF: "FF";
+  SF: "SF";
+}>;
+declare const TaskTypeSchema: z.ZodEnum<{
+  task: "task";
+  project: "project";
+  milestone: "milestone";
+}>;
+declare const SpecialDayKindSchema: z.ZodEnum<{
+  holiday: "holiday";
+  custom: "custom";
+}>;
+declare const SpecialDaySchema: z.ZodObject<{
+  date: z.ZodString;
+  kind: z.ZodEnum<{
+    holiday: "holiday";
+    custom: "custom";
+  }>;
+  label: z.ZodOptional<z.ZodString>;
+  className: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const TaskSchema: z.ZodObject<{
+  id: z.ZodNumber;
+  text: z.ZodString;
+  start_date: z.ZodString;
+  duration: z.ZodNumber;
+  parent: z.ZodOptional<z.ZodNumber>;
+  progress: z.ZodDefault<z.ZodNumber>;
+  type: z.ZodDefault<z.ZodEnum<{
+    task: "task";
+    project: "project";
+    milestone: "milestone";
+  }>>;
+  open: z.ZodDefault<z.ZodBoolean>;
+  color: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+declare const LinkSchema: z.ZodObject<{
+  id: z.ZodNumber;
+  source: z.ZodNumber;
+  target: z.ZodNumber;
+  type: z.ZodDefault<z.ZodEnum<{
+    FS: "FS";
+    SS: "SS";
+    FF: "FF";
+    SF: "SF";
+  }>>;
+}, z.core.$strip>;
+declare const GanttInputSchema: z.ZodObject<{
+  tasks: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    text: z.ZodString;
+    start_date: z.ZodString;
+    duration: z.ZodNumber;
+    parent: z.ZodOptional<z.ZodNumber>;
+    progress: z.ZodDefault<z.ZodNumber>;
+    type: z.ZodDefault<z.ZodEnum<{
+      task: "task";
+      project: "project";
+      milestone: "milestone";
+    }>>;
+    open: z.ZodDefault<z.ZodBoolean>;
+    color: z.ZodOptional<z.ZodString>;
+  }, z.core.$strip>>;
+  links: z.ZodDefault<z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    source: z.ZodNumber;
+    target: z.ZodNumber;
+    type: z.ZodDefault<z.ZodEnum<{
+      FS: "FS";
+      SS: "SS";
+      FF: "FF";
+      SF: "SF";
+    }>>;
+  }, z.core.$strip>>>;
+}, z.core.$strip>;
+type LinkType = z.infer<typeof LinkTypeSchema>;
+type TaskType = z.infer<typeof TaskTypeSchema>;
+type SpecialDayKind = z.infer<typeof SpecialDayKindSchema>;
+type SpecialDay = z.infer<typeof SpecialDaySchema>;
+type Task = z.infer<typeof TaskSchema>;
+type Link = z.infer<typeof LinkSchema>;
+type GanttInput = z.infer<typeof GanttInputSchema>;
+/** Parses raw external data. Throws ZodError on failure. */
+declare function parseGanttInput(raw: unknown): GanttInput;
+/** Returns null instead of throwing. */
+declare function safeParseGanttInput(raw: unknown): GanttInput | null;
+//#endregion
+//#region src/gantt-chart/timeline/scale.d.ts
+type TimeScale = 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
+type ScaleConfig = {
+  /** Pixel width of one column unit */columnWidth: number; /** Milliseconds per column unit */
+  msPerColumn: number;
+  headerFormat: TimeScale;
+};
+declare const SCALE_CONFIGS: Record<TimeScale, ScaleConfig>;
+//#endregion
+//#region src/gantt-chart/domain/tree.d.ts
+type TaskNode = Task & {
+  children: TaskNode[]; /** 0 = root */
+  depth: number;
+};
+/**
+ * Builds a typed tree from a flat task array.
+ * Order of tasks[] is irrelevant — parents need not precede children.
+ * Throws if any parent reference is unresolvable.
+ */
+declare function buildTaskTree(tasks: Task[]): TaskNode[];
+/**
+ * Flattens a tree into a visible row list.
+ * A node's children are included only when its id is in expandedIds.
+ */
+declare function flattenTree(roots: TaskNode[], expandedIds: ReadonlySet<number>): TaskNode[];
+/** Returns true when a node has children in the tree. */
+declare function isParent(node: TaskNode): boolean;
+//#endregion
+//#region src/gantt-chart/timeline/pixelMapper.d.ts
+type PixelMapper = {
+  /** Date → x pixel offset from viewport start */toX: (date: Date) => number; /** x pixel offset → Date */
+  toDate: (x: number) => Date; /** Days → pixel width */
+  durationToWidth: (days: number) => number; /** Pixel width → days (float) */
+  widthToDuration: (px: number) => number; /** The origin timestamp used for this mapper */
+  originMs: number; /** Pixel width of one column unit */
+  columnWidth: number;
+};
+/**
+ * Creates a stateless pixel mapper for the given scale and viewport start.
+ * All conversions are O(1) arithmetic — safe to call in tight loops.
+ */
+declare function createPixelMapper(scale: TimeScale, viewportStart: Date): PixelMapper;
+//#endregion
+//#region src/gantt-chart/timeline/layoutEngine.d.ts
+declare const DENSITY: {
+  readonly rowHeight: 44;
+  readonly barHeight: 28;
+  readonly milestoneSize: 20;
+};
+declare const ROW_HEIGHT: 44;
+declare const BAR_HEIGHT: 28;
+declare const BAR_Y_OFFSET: number;
+declare const MILESTONE_SIZE: 20;
+/** Half-width of a milestone diamond */
+declare const MILESTONE_HALF: number;
+type BarLayout = {
+  taskId: number; /** Left edge x in timeline coordinates */
+  x: number; /** Top edge y in content coordinates */
+  y: number;
+  width: number;
+  height: number;
+  progressWidth: number;
+  type: 'task' | 'project' | 'milestone';
+  rowIndex: number; /** Center x; identical to x + width/2 or x for milestones */
+  centerX: number;
+  centerY: number;
+};
+/**
+ * Computes pixel-space layout for all visible task rows.
+ * Returns a map keyed by task id for O(1) lookup during link routing.
+ */
+declare function computeLayout(rows: TaskNode[], mapper: PixelMapper): Map<number, BarLayout>;
+/**
+ * Derives viewport bounds from task data with padding.
+ * Returns [start, end] as UTC midnight dates.
+ */
+declare function deriveViewport(tasks: TaskNode[], paddingDays?: number): [Date, Date];
+//#endregion
+//#region src/gantt-chart/locale.d.ts
+type LocaleLabelKey = 'aria_task' | 'aria_milestone' | 'add_subtask_title' | 'column_task_name' | 'column_start_time' | 'column_duration' | 'column_quarter';
+type ChartLocale = {
+  code: string;
+  labels?: Partial<Record<LocaleLabelKey, string>>;
+  weekStartsOn?: 0 | 1 | 6;
+  weekNumbering?: 'iso' | 'us' | 'simple';
+  weekendDays?: number[];
+};
+declare const EN_US_LABELS: Record<LocaleLabelKey, string>;
+declare const CHART_LOCALE_EN_US: ChartLocale;
+/**
+ * Resolves a ChartLocale from either a full ChartLocale object or a BCP 47 string.
+ * When given a string, derives weekStartsOn, weekNumbering, and weekendDays from CLDR conventions.
+ */
+declare function resolveChartLocale(raw: ChartLocale | string | undefined): ChartLocale;
+/**
+ * Derives the first day of week (0=Sun, 1=Mon, 6=Sat) from a BCP 47 code.
+ * Uses Intl.Locale.getWeekInfo() where available (Chromium, Safari 15.4+),
+ * with a CLDR-based fallback table for Firefox and older runtimes.
+ */
+declare function deriveWeekStartsOn(code: string): 0 | 1 | 6;
+/**
+ * Derives the week numbering scheme from a BCP 47 code.
+ * Europe and ISO-aligned regions default to 'iso'; Americas and others to 'us'.
+ */
+declare function deriveWeekNumbering(code: string): 'iso' | 'us' | 'simple';
+/**
+ * Derives weekend days (0=Sun … 6=Sat) from a BCP 47 code.
+ * Uses Intl.Locale.getWeekInfo() where available, with a CLDR-based fallback table.
+ */
+declare function deriveWeekendDays(code: string): number[];
+/**
+ * Formats a week number according to the specified scheme.
+ *
+ * - `'iso'`: ISO 8601 (week 1 contains the first Thursday; Monday start).
+ * - `'us'`: Week 1 contains January 1; Sunday start.
+ * - `'simple'`: `Math.ceil(dayOfYear / 7)`.
+ */
+declare function formatWeekNumber(date: Date, scheme: 'iso' | 'us' | 'simple'): number;
+/**
+ * Formats a label template by replacing `{0}` with the given argument.
+ */
+declare function formatLabel(template: string, arg: string): string;
+//#endregion
+//#region src/gantt-chart/domain/dependencies.d.ts
+/**
+ * Detects circular dependencies in the link graph using DFS tri-colour marking.
+ * Throws with a human-readable cycle path on detection.
+ * Silent return = no cycles.
+ */
+declare function detectCycles(tasks: Task[], links: Link[]): void;
+/**
+ * Returns true when all link source/target ids reference existing tasks.
+ * Throws with details on failure.
+ */
+declare function validateLinkRefs(tasks: Task[], links: Link[]): void;
+//#endregion
+//#region src/gantt-chart/domain/dateMath.d.ts
+/** Parses YYYY-MM-DD → UTC midnight Date. Throws on invalid input. */
+declare function parseDate(dateStr: string): Date;
+/** Returns date + n days (exact ms arithmetic). */
+declare function addDays(date: Date, days: number): Date;
+/** Difference in days (float). Positive when b > a. */
+declare function diffDays(a: Date, b: Date): number;
+//#endregion
+//#region src/gantt-chart/rendering/linkRouter.d.ts
+type Point = {
+  x: number;
+  y: number;
+};
+type RoutedLink = {
+  linkId: number;
+  sourceTaskId: number;
+  targetTaskId: number; /** Ordered vertices of the orthogonal polyline (source → target). */
+  points: Point[];
+};
+/**
+ * Computes orthogonal routing for all dependency links.
+ * Links whose source or target is not in the layout map are skipped silently
+ * (e.g. when the row is collapsed).
+ */
+declare function routeLinks(links: Link[], layouts: Map<number, BarLayout>): RoutedLink[];
+//#endregion
+//#region src/gantt-chart/vanilla/dom/gridColumns.d.ts
+type GridColumn = {
+  id: string;
+  header: string;
+  width: string;
+  align?: 'left' | 'center' | 'right';
+  visible?: boolean;
+  field?: keyof Task;
+  format?: (value: unknown, task: Task, row: TaskNode, locale: ChartLocale) => string;
+};
+declare const DEFAULT_GRID_COLUMNS: GridColumn[];
+/**
+ * Returns a localized default grid column schema.
+ * Column headers use locale label overrides with EN_US_LABELS fallback.
+ */
+declare function gridColumnDefaults(locale: ChartLocale): GridColumn[];
+declare function gridTemplateColumns(columns: GridColumn[]): string;
+declare function visibleColumns(columns: GridColumn[]): GridColumn[];
+declare const GRID_COLUMN_FR_MIN_WIDTH = 120;
+declare function gridNaturalWidth(columns: GridColumn[]): number;
+//#endregion
+//#region src/gantt-chart/vanilla/gantt-chart.d.ts
+type OnTaskSelect = (taskId: number | null) => void;
+type OnTaskMove = (payload: {
+  id: number;
+  startDate: Date;
+}) => void;
+type OnTaskResize = (payload: {
+  id: number;
+  duration: number;
+}) => void;
+type OnTaskAdd = (payload: {
+  parentId: number;
+}) => void;
+type OnTaskDoubleClick = (payload: {
+  id: number;
+  source: 'grid' | 'bar' | 'milestone';
+}) => void;
+type OnTaskEditIntent = (payload: {
+  id: number;
+  source: 'grid' | 'bar' | 'milestone';
+  trigger: 'double_click';
+  task: Task;
+}) => void;
+type OnLinkCreate = (payload: {
+  sourceTaskId: number;
+  targetTaskId: number;
+  type: 'FS';
+}) => void;
+type GanttCallbacks = {
+  onSelect?: OnTaskSelect;
+  onMove?: OnTaskMove;
+  onResize?: OnTaskResize;
+  onAdd?: OnTaskAdd;
+  onTaskDoubleClick?: OnTaskDoubleClick;
+  onTaskEditIntent?: OnTaskEditIntent;
+  onLinkCreate?: OnLinkCreate;
+  onLeftPaneWidthChange?: (width: number) => void;
+  onGridColumnsChange?: (columns: GridColumn[]) => void;
+};
+type ThemeMode = 'light' | 'dark' | 'system';
+type GanttOptions = {
+  scale?: TimeScale;
+  highlightLinkedDependenciesOnSelect?: boolean;
+  linkCreationEnabled?: boolean;
+  leftPaneWidth?: number;
+  responsiveSplitPane?: boolean;
+  mobileBreakpoint?: number;
+  mobileLeftPaneMinWidth?: number;
+  mobileLeftPaneMaxRatio?: number;
+  timelineMinWidth?: number;
+  height?: number;
+  viewportStart?: Date;
+  viewportEnd?: Date;
+  locale?: ChartLocale | string;
+  showWeekends?: boolean;
+  weekendDays?: number[];
+  specialDays?: SpecialDay[];
+  gridColumns?: GridColumn[];
+  theme?: ThemeMode;
+} & GanttCallbacks;
+type GanttInstance = {
+  update: (input: GanttInput) => void;
+  setScale: (scale: TimeScale) => void;
+  select: (id: number | null) => void;
+  collapseAll: () => void;
+  expandAll: () => void;
+  destroy: () => void;
+};
+declare class GanttChart implements GanttInstance {
+  #private;
+  constructor(container: HTMLElement, input: GanttInput, opts?: GanttOptions);
+  update(newInput: GanttInput): void;
+  setScale(scale: TimeScale): void;
+  select(id: number | null): void;
+  collapseAll(): void;
+  expandAll(): void;
+  destroy(): void;
+}
+//#endregion
+//#region src/gantt-chart/errors.d.ts
+type GanttErrorCode = 'PARENT_REFERENCE' | 'LINK_REFERENCE' | 'DEPENDENCY_CYCLE' | 'INSTANCE_DESTROYED';
+declare class GanttError extends Error {
+  readonly code: GanttErrorCode;
+  constructor(code: GanttErrorCode, message: string);
+}
+//#endregion
+export { BAR_HEIGHT, BAR_Y_OFFSET, type BarLayout, CHART_LOCALE_EN_US, type ChartLocale, DEFAULT_GRID_COLUMNS, DENSITY, EN_US_LABELS, GRID_COLUMN_FR_MIN_WIDTH, type GanttCallbacks, GanttChart, GanttError, type GanttErrorCode, type GanttInput, GanttInputSchema, type GanttInstance, type GanttOptions, type GridColumn, type Link, LinkSchema, type LinkType, LinkTypeSchema, type LocaleLabelKey, MILESTONE_HALF, MILESTONE_SIZE, type OnLinkCreate, type OnTaskAdd, type OnTaskDoubleClick, type OnTaskEditIntent, type OnTaskMove, type OnTaskResize, type OnTaskSelect, type PixelMapper, type Point, ROW_HEIGHT, type RoutedLink, SCALE_CONFIGS, type ScaleConfig, type SpecialDay, type SpecialDayKind, SpecialDayKindSchema, SpecialDaySchema, type Task, type TaskNode, TaskSchema, type TaskType, TaskTypeSchema, type ThemeMode, type TimeScale, addDays, buildTaskTree, computeLayout, createPixelMapper, deriveViewport, deriveWeekNumbering, deriveWeekStartsOn, deriveWeekendDays, detectCycles, diffDays, flattenTree, formatLabel, formatWeekNumber, gridColumnDefaults, gridNaturalWidth, gridTemplateColumns, isParent, parseDate, parseGanttInput, resolveChartLocale, routeLinks, safeParseGanttInput, validateLinkRefs, visibleColumns };
+//# sourceMappingURL=index.d.mts.map