@svar-ui/gantt-store 2.7.2 → 2.8.0

package/dist/types/types.d.ts

@@ -1,14 +1,31 @@
 import type { IDataMethodsConfig } from "./DataStore";
-import type { DataArray, TID, IEventBus, IPublicWritable, IEventConfig } from "@svar-ui/lib-state";
+import type { DataArray, TID, IEventBus, IPublicWritable, IEventConfig, DataTree } from "@svar-ui/lib-state";
 import type GanttDataTree from "./GanttDataTree";
 import { Day } from "date-fns";
 import type DataStore from "./DataStore";
 import type { IApi as ITableApi, IColumn, IFilterValues } from "@svar-ui/grid-store";
-import type { TaskSlackInfo, ICalendarRule, CalendarConfig, ICalendar } from "./schedule-types";
-export type { TaskSlackInfo, ICalendarRule, CalendarConfig, ICalendar };
-import ResourceDataTree from "./pro/ResourceDataTree";
+import type { TaskSlackInfo, ICalendarRule, CalendarConfig, ICalendar, Constraint, Conflict, InvalidLinkReason } from "./schedule-types";
+export type { TaskSlackInfo, ICalendarRule, CalendarConfig, ICalendar, Constraint, Conflict, InvalidLinkReason, };
+export type ITaskCalendar = ICalendar & {
+    noWorkingTime?: boolean;
+};
 export type TMethodsConfig = IDataMethodsConfig;
 export type { GanttDataTree, TID };
+export interface IConflict {
+    type: "link" | "constraint";
+    task: TID;
+    link?: TID;
+    required: Date;
+}
+export interface IConflictReportRow extends IConflict {
+    id: string;
+    typeKey: string | null;
+}
+export interface IConflictsIndex {
+    rows: IConflictReportRow[];
+    constraints: Set<TID>;
+    links: Set<TID>;
+}
 export interface IExportConfig {
     url?: string;
     format?: "pdf" | "png" | "xlsx" | "mspx";
@@ -68,7 +85,9 @@ export type TSerializeData = {
 };
 export type TDataName = keyof TSerializeData;
 export type TSortFunction = (a: IDataHash, b: IDataHash) => 1 | -1 | 0;
+export type TDisplayPanel = "grid" | "chart" | "subGrid";
 export type TDisplayMode = "all" | "grid" | "chart";
+export type TDisplayModeConfig = TDisplayMode | TDisplayPanel[];
 export type TCellBorders = "column" | "full";
 export type TCalendarGetter = (task: Partial<ITask>) => ICalendar | undefined;
 export interface ILink {
@@ -114,12 +133,54 @@ export interface IParsedResource extends IResource {
     $level: number;
     data?: IParsedResource[];
 }
+export interface IResourceDataTree extends DataTree<IParsedResource> {
+    sort(conf: TSort[], columns?: IResourceColumn[]): void;
+}
 export interface IComputedResource extends IParsedResource {
     data?: IComputedResource[];
     $load: Record<string, IResourceLoad>;
+    $capacity: Record<string, number>;
+    $capacityTotal: number;
+    $fullDay: number;
     $total: number;
     $overloaded: boolean;
     $unitLoad?: Record<string, IResourceLoad>;
+    $unitCapacity?: Record<string, number>;
+}
+export interface IHistogramColumn {
+    id: string;
+    width: number;
+    date: Date;
+    end?: Date;
+    pxPerDayThreshold: number;
+    overloadHeadroom?: number;
+}
+export interface IResourceHistogramConfig {
+    overloadHeadroom?: number;
+    capacityLine?: boolean;
+}
+export interface IResourceHistogramTooltip {
+    resource: IComputedResource;
+    start: Date;
+    end: Date;
+    hours: number;
+    capacity: number;
+    days: number;
+}
+export interface IHistogramColumnPosition {
+    column: IHistogramColumn;
+    left: number;
+}
+export interface IHistogramBar {
+    key: string;
+    start: Date;
+    end?: Date;
+    hours: number;
+    capacity: number;
+    ceiling: number;
+    width: number;
+    days: number;
+    overloaded: boolean;
 }
 export interface IResourceColumn {
     id: string;
@@ -153,6 +214,7 @@ export interface ITask {
     base_start?: Date;
     base_end?: Date;
     base_duration?: number;
+    deadline?: Date;
     rollup?: boolean;
     open?: boolean;
     text?: string;
@@ -161,8 +223,12 @@ export interface ITask {
     type?: TTaskType;
     parent?: TID;
     calendar?: TID;
+    skipResourceCalendars?: boolean;
     unscheduled?: boolean;
+    manual?: boolean;
+    inactive?: boolean;
     segments?: Partial<ITask>[];
+    constraint?: Constraint | null;
     [key: string]: any;
 }
 export interface IParsedTask extends ITask {
@@ -171,6 +237,8 @@ export interface IParsedTask extends ITask {
     data?: IParsedTask[];
     $level: number;
     $wbs?: string;
+    $noWorkingTime?: boolean;
+    $placeholder?: boolean;
 }
 export interface IGanttTask extends IParsedTask {
     $x: number;
@@ -183,12 +251,15 @@ export interface IGanttTask extends IParsedTask {
     $h_rollup?: number;
     $y_rollup_relative?: number;
     $w_rollup?: number;
+    $x_deadline?: number;
+    $overdue?: boolean;
     $reorder?: boolean;
     critical?: boolean;
     slack?: TaskSlackInfo;
     $visibleSlack?: number;
     $x_slack?: number;
     $w_slack?: number;
+    $x_constraint?: number;
 }
 export type TDispatch = <A extends keyof TMethodsConfig>(action: A, data: TMethodsConfig[A]) => void;
 export interface IMethodsHash {
@@ -222,10 +293,69 @@ export interface IMarker {
     css?: string;
     left?: number;
 }
+export interface IProgressLineData {
+    statusX: number;
+    statusDate: Date;
+}
+export type TSCurveType = "scheduled" | "earned" | "baseline";
+export type TSCurveMetric = "duration" | "progress";
+export type TSCurveLine = {
+    type: TSCurveType;
+    metric?: TSCurveMetric;
+    css?: string;
+};
+export type TSCurveConfig = boolean | TSCurveLine[];
+export interface ISCurveLineInfo {
+    type: TSCurveType;
+    metric: TSCurveMetric;
+}
+export interface ISCurveLineConfig extends ISCurveLineInfo {
+    css?: string;
+}
+export type TSCurvePlan = "scheduled" | "baseline";
+export interface ISCurveLine extends ISCurveLineInfo {
+    series: Float64Array;
+}
+export interface ISCurveData {
+    lines: ISCurveLine[];
+    start: number;
+    end: number;
+}
+export interface ISCurveViewPoint {
+    index: number;
+    x: number;
+    y: number;
+}
+export interface ISCurveLineView extends ISCurveLineConfig {
+    line: number;
+    path: string;
+    points: ISCurveViewPoint[];
+}
+export interface ISCurveTooltipLine extends ISCurveLineInfo {
+    line: number;
+    value: number;
+}
+export interface ISCurveTooltip {
+    date: Date;
+    hovered: ISCurveTooltipLine;
+    lines: ISCurveTooltipLine[];
+}
 export interface IHistory {
     undo: number;
     redo: number;
 }
+export interface IHistoryManager {
+    startBatch: () => void;
+    endBatch: (discard?: boolean) => void;
+    isBatching: () => boolean;
+    handleUndo: () => void;
+    handleRedo: () => void;
+    resetHistory: () => void;
+}
+export interface IGroupManager {
+    buildTree: () => GanttDataTree;
+    updateTaskGroup: (id: TID) => void;
+}
 export interface ICriticalPathConfig {
     type: "strict" | "flexible";
 }
@@ -237,6 +367,7 @@ export interface IUnitFormats {
 export interface IScheduleConfig {
     type?: "forward";
     auto?: boolean;
+    resourceCalendars?: boolean;
 }
 export interface ISummaryConfig {
     autoProgress?: boolean;
@@ -266,11 +397,12 @@ export interface IConfig {
         segmentIndex: number;
     };
     scales?: IScaleConfig[];
-    columns?: IGanttColumn[];
+    columns?: false | IGanttColumn[];
     start?: Date;
     end?: Date;
     lengthUnit?: TLengthUnit;
     durationUnit?: TDurationUnit;
+    inclusiveEnd?: boolean;
     cellWidth?: number;
     cellHeight?: number;
     scaleHeight?: number;
@@ -279,6 +411,8 @@ export interface IConfig {
     schedule?: IScheduleConfig;
     undo?: boolean;
     unscheduledTasks?: boolean;
+    inactiveTasks?: boolean;
+    placeholderRow?: boolean;
     baselines?: boolean;
     rollups?: boolean | {
         type: "all" | "closest";
@@ -295,11 +429,18 @@ export interface IConfig {
     groupBy?: string | IGroupByConfig | null;
     wbs?: boolean;
     highlightTime?: (date: Date, unit: TDurationUnit) => string;
-    displayMode?: TDisplayMode;
+    displayMode?: TDisplayModeConfig;
     gridWidth?: number;
+    subGridWidth?: number;
     cellBorders?: TCellBorders;
+    deadlines?: boolean;
+    progressLine?: boolean | Date | null;
+    sCurve?: TSCurveConfig | null;
 }
 export interface IDataConfig extends IConfig {
+    displayMode: TDisplayPanel[];
+    gridWidth: number;
+    _displayPanels: TDisplayPanel[];
     scrollLeft: number;
     scrollTop: number;
     area: IVisibleArea;
@@ -322,24 +463,34 @@ export interface IDataConfig extends IConfig {
     _chartHeight?: number;
     _scrollSize?: number;
     _calendar?: ICalendar;
-    _calendars?: Record<TID, ICalendar>;
+    _calendars?: Map<TID, ICalendar>;
+    _composites?: Map<string, ICalendar>;
     _compactMode: boolean;
+    _containerWidth: number | null;
     _columnsWidth?: number;
     _gridCollapseThreshold?: number;
+    _progressLine?: IProgressLineData | null;
+    _progressLinePoints?: string | null;
+    _sCurve?: ISCurveData | null;
+    _sCurvePoints?: ISCurveLineView[] | null;
+    conflicts?: IConflict[];
+    _conflicts?: IConflictsIndex | null;
+    showConflicts?: boolean;
 }
-export interface IData extends Omit<IDataConfig, TDataName | "rollups" | "groupBy"> {
+export interface IData extends Omit<IDataConfig, TDataName> {
+    columns?: IGanttColumn[];
+    _columns?: IGanttColumn[];
     rollups?: false | {
         type: "all" | "closest";
     };
     zoom?: IZoomConfig;
     tasks: GanttDataTree;
     links: DataArray<ILink>;
-    resources?: ResourceDataTree;
+    resources?: IResourceDataTree;
     assignments?: DataArray<IAssignment>;
     calendars?: GanttCalendarConfig[];
     tree: GanttDataTree;
     _tasks: IParsedTask[];
-    _tasksPatch?: boolean | null;
     _rollups: {
         [key: TID]: Array<ITask>;
     };
@@ -352,7 +503,6 @@ export interface IData extends Omit<IDataConfig, TDataName | "rollups" | "groupB
     _start?: Date;
     _end?: Date;
     _scales?: GanttScaleData;
-    _scaleMinUnit?: TLengthUnit;
     _scaleDate?: Date;
     _zoomOffset?: number;
     _weekStart?: Day;
@@ -364,6 +514,9 @@ export interface IData extends Omit<IDataConfig, TDataName | "rollups" | "groupB
     _columnsWidth?: number;
     groupBy?: IGroupByConfig;
     _gridCollapseThreshold?: number;
+    _progressLine?: IProgressLineData | null;
+    _progressLinePoints?: string | null;
+    conflicts: IConflict[];
 }
 export interface IDataHash<T = any> {
     [key: string]: T;
@@ -381,7 +534,10 @@ export type IScaleConfig = {
 export type GanttScaleCell = {
     width: number;
     value: string;
+    date: Date;
+    key: string;
     css: string;
+    unit: TLengthUnit;
 };
 export type GanttScaleRow = {
     cells: GanttScaleCell[];
@@ -414,11 +570,13 @@ export type GanttScaleUnit = {
         [key: TLengthUnit]: number | ((date: Date) => number);
     };
 };
+export type TColumnSection = "grid" | "subGrid";
 export type IGanttColumn = {
     width?: number;
     align?: "left" | "right" | "center";
     flexgrow?: number;
     hidden?: boolean;
+    section?: TColumnSection;
     resize?: boolean;
     header?: IColumn["header"];
     id?: string;
@@ -429,6 +587,7 @@ export type IGanttColumn = {
     editor?: IColumn["editor"];
     options?: IColumn["options"];
     getter?: (obj: IDataHash) => any;
+    setter?: (obj: IDataHash, value: any) => void;
 };
 export type TCommonShape = {
     id?: TID;
@@ -448,17 +607,11 @@ export type TCounterShape = TCommonShape & {
 };
 export type TRadioShape = TCommonShape & {
     comp: "radio";
-    options: {
-        id: TID;
-        label: string;
-    }[];
+    options: IOption[];
 };
 export type TComboFieldShape = TCommonShape & {
     comp: "combo" | "select" | "multiselect";
-    options?: {
-        id: any;
-        label: string;
-    }[];
+    options?: IOption<any>[];
 };
 export type TCheckboxShape = TCommonShape & {
     comp: "checkbox";
@@ -485,11 +638,16 @@ export type ITabs = TCommonShape & {
 export type ISegments = TCommonShape & {
     comp: "segments";
 };
-export type TEditorItem = TTextFieldShape | TCounterShape | TComboFieldShape | TSliderShape | TDateFieldShape | TRadioShape | ILinksShape | ITwoStateShape | TCheckboxShape | IResources | ISegments | ITabs;
-export type ITaskType = {
-    id: TID;
+export type IConstraintShape = TCommonShape & {
+    comp: "constraint";
+};
+export type TEditorItem = TTextFieldShape | TCounterShape | TComboFieldShape | TSliderShape | TDateFieldShape | TRadioShape | ILinksShape | ITwoStateShape | TCheckboxShape | IResources | ISegments | IConstraintShape | ITabs;
+export type IOption<T = TID> = {
+    id: T;
     label: string;
 };
+export type ITaskType = IOption;
+export type IConstraintType = IOption;
 export type TSort = {
     key: string;
     order?: "asc" | "desc";
@@ -499,8 +657,13 @@ export type TFilterHandler = (task: any) => boolean;
 export type TScrollMode = "x" | "y" | "xy" | boolean;
 export type TFocusTask = {
     id: TID;
-    column?: boolean;
+    /** Where to move focus; omitted or "chart" focuses the chart bar. */
+    section?: TDisplayPanel;
+};
+export type TLinkDraft = Pick<ILink, "source" | "target" | "type"> & {
+    id?: TID;
 };
+export type TLinkValidator = (link: TLinkDraft) => InvalidLinkReason | null;
 export interface IApi {
     exec: <A extends keyof TMethodsConfig | (string & {})>(action: A, params?: A extends keyof TMethodsConfig ? TMethodsConfig[A] : any) => Promise<any>;
     on: <A extends keyof TMethodsConfig | (string & {})>(action: A, callback: (config: A extends keyof TMethodsConfig ? TMethodsConfig[A] : any) => any, config?: IEventConfig) => void;
@@ -514,13 +677,17 @@ export interface IApi {
     getStores: () => {
         data: DataStore;
     };
-    getTable: (waitRender?: boolean) => Promise<ITableApi> | ITableApi;
+    getTable: (waitRender?: boolean, section?: TColumnSection) => Promise<ITableApi> | ITableApi;
     getTask: (id: TID) => ITask;
     getResource: (id: TID) => IResource;
     serialize: (config?: {
         data?: keyof TSerializeData;
     }) => TSerializeData[keyof TSerializeData] | null;
     getCalendar: (id?: TID) => ICalendar | undefined;
+    getTaskCalendar: (task: Partial<ITask>) => ITaskCalendar | undefined;
+    getResourceCalendar: (resource: Partial<IResource>) => ICalendar | undefined;
+    getHistory: () => IHistoryManager | null | undefined;
     getTaskResources: (id: TID) => TResourceAssignment[];
     getResourceTasks: (id: TID) => ITask[];
+    getLinkValidator: () => TLinkValidator;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@svar-ui/gantt-store",
-	"version": "2.7.2",
+	"version": "2.8.0",
 	"description": "Internal state management used by SVAR Gantt component",
 	"type": "module",
 	"main": "dist/index.js",
@@ -21,6 +21,7 @@
 	],
 	"dependencies": {
 		"date-fns": "3.6.0",
-		"@svar-ui/lib-state": "1.9.7"
+		"@svar-ui/lib-dom": "0.14.0",
+		"@svar-ui/lib-state": "1.10.1"
 	}
 }