@svar-ui/gantt-store 2.2.1 → 2.4.0

package/dist/types/types.d.ts

@@ -1,6 +1,9 @@
 import type { IDataMethodsConfig } from "./DataStore";
-import type { DataArray, TID } from "@wx/lib-state";
+import type { DataArray, TID, IEventBus, IPublicWritable, IEventConfig } from "@wx/lib-state";
 import type GanttDataTree from "./GanttDataTree";
+import { Day } from "date-fns";
+import type DataStore from "./DataStore";
+import type { IApi as ITableApi, IColumn } from "@wx/grid-store";
 export type TMethodsConfig = IDataMethodsConfig;
 export type { GanttDataTree, TID };
 export interface IActionConfig<T = any> {
@@ -8,27 +11,25 @@ export interface IActionConfig<T = any> {
     noSave?: boolean;
 }
 export type TLinkType = "s2s" | "s2e" | "e2s" | "e2e";
-export type TTaskType = "task" | "summary" | "milestone";
-export type TEditorType = "text" | "combo" | "datepicker" | "richselect";
-export interface IColumnEditor {
-    type: TEditorType;
-    config?: {
-        template?: (v: any) => string;
-        cell?: any;
-        options?: any[];
-        buttons?: boolean | string[];
-    };
-}
-export type TEditorHandler = (row?: ITask, column?: any) => TEditorType | IColumnEditor | null;
+export type TTaskType = "task" | "summary" | "milestone" | string;
+export type TLengthUnit = "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year" | string;
+export type TDurationUnit = "day" | "hour";
 export interface ILink {
-    id: TID;
+    id?: TID;
     type: TLinkType;
     source: TID;
     target: TID;
+    lag?: number;
+}
+export interface IGanttLink extends ILink {
+    id: TID;
+    $p: string;
+    $pl: number;
+    $critical?: boolean;
 }
 export interface ITask {
     start?: Date;
-    id: TID;
+    id?: TID;
     end?: Date;
     duration?: number;
     data?: ITask[];
@@ -42,13 +43,25 @@ export interface ITask {
     type?: TTaskType;
     parent?: TID;
     unscheduled?: boolean;
+    segments?: Partial<ITask>[];
     [key: string]: any;
 }
 export interface IParsedTask extends ITask {
-    parent: TID;
-    data: IParsedTask[];
+    id: TID;
+    parent?: TID;
+    data?: IParsedTask[];
     $level: number;
 }
+export interface IGanttTask extends IParsedTask {
+    $x: number;
+    $y: number;
+    $h: number;
+    $w: number;
+    $x_base?: number;
+    $w_base?: number;
+    $reorder?: boolean;
+    $critical?: boolean;
+}
 export type TDispatch = <A extends keyof TMethodsConfig>(action: A, data: TMethodsConfig[A]) => void;
 export interface IMethodsHash {
     [key: string]: any;
@@ -64,7 +77,7 @@ export interface IVisibleArea {
     end: number;
 }
 export interface IZoomConfig {
-    level: number;
+    level?: number;
     minCellWidth?: number;
     maxCellWidth?: number;
     levels?: Array<IScaleLevel>;
@@ -72,7 +85,7 @@ export interface IZoomConfig {
 export interface IScaleLevel {
     minCellWidth: number;
     maxCellWidth: number;
-    scales: GanttScale[];
+    scales: IScaleConfig[];
 }
 export interface IMarker {
     start: Date;
@@ -80,77 +93,112 @@ export interface IMarker {
     css?: string;
     left?: number;
 }
-export interface IDataConfig {
+export interface IHistory {
+    undo: number;
+    redo: number;
+}
+export interface ICriticalPathConfig {
+    type: "strict" | "flexible";
+}
+export interface ICriticalTasks {
+    [key: TID]: boolean;
+}
+type UnitFormatter = (date: Date) => string;
+export interface IUnitFormats {
+    [unit: string]: UnitFormatter | string;
+}
+export interface IScheduleConfig {
+    type?: "forward";
+    auto?: boolean;
+}
+export interface ICalendarConfig {
+    name?: string;
+    weekHours?: {
+        sunday?: number;
+        monday?: number;
+        tuesday?: number;
+        wednesday?: number;
+        thursday?: number;
+        friday?: number;
+        saturday?: number;
+    };
+}
+export interface Calendar {
+    isWorkingDay(date: Date): boolean;
+    addRule(rule: (date: Date) => number): void;
+    clone(config?: ICalendarConfig): Calendar;
+    addWorkingDays(start: Date, days: number, excludeEndDate?: boolean): Date | null;
+    addWorkingHours(start: Date, hours: number): Date | null;
+    getNextWorkingDay(date: Date): Date | null;
+    getPreviousWorkingDay(date: Date): Date | null;
+    getWorkingDays(start: Date, end: Date, excludeEndDate?: boolean): number;
+    getWorkingHours(start: Date, end?: Date, excludeEndDate?: boolean): number;
+    setDayHours(date: Date, hours: number): void;
+    setRangeHours(start: Date, end: Date, hours: number): void;
+}
+export interface IConfig {
+    tasks?: ITask[];
+    links?: any[];
+    taskTypes?: ITaskType[];
     selected?: TID[];
-    activeTask?: TID;
-    tasks: ITask[];
-    links: ILink[];
-    start: Date;
-    end: Date;
-    lengthUnit: string;
-    cellWidth: number;
-    cellHeight: number;
-    scaleHeight: number;
-    scales: any[];
-    columns: GanttColumn[];
+    activeTask?: TID | {
+        id: TID;
+        segmentIndex: number;
+    };
+    scales?: IScaleConfig[];
+    columns?: IGanttColumn[];
+    start?: Date;
+    end?: Date;
+    lengthUnit?: TLengthUnit;
+    durationUnit?: TDurationUnit;
+    cellWidth?: number;
+    cellHeight?: number;
+    scaleHeight?: number;
+    zoom?: boolean | IZoomConfig;
+    autoScale?: boolean;
+    schedule?: IScheduleConfig;
+    undo?: boolean;
+    unscheduledTasks?: boolean;
+    baselines?: boolean;
+    markers?: IMarker[];
+    criticalPath?: ICriticalPathConfig;
+    projectStart?: Date;
+    projectEnd?: Date;
+    calendar?: Calendar;
+    splitTasks?: boolean;
+}
+export interface IDataConfig extends IConfig {
     scrollLeft: number;
     scrollTop: number;
     area: IVisibleArea;
-    taskTypes?: ITaskType[];
-    baselines?: boolean;
-    zoom: boolean | IZoomConfig;
-    highlightTime?: (date: Date, unit: "day" | "hour") => string;
+    history?: IHistory;
     _cellWidth?: number;
     _sort?: TSort[];
-    autoScale?: boolean;
-    unscheduledTasks?: boolean;
-    markers?: IMarker[];
-    durationUnit: "day" | "hour";
     _scrollTask?: TScrollTask;
+    _weekStart?: Day;
 }
-export interface IData {
-    selected: TID[];
-    _selected: ITask[];
-    activeTask: TID;
-    _activeTask: ITask;
+export interface IData extends Omit<IDataConfig, "tasks" | "links"> {
+    zoom?: IZoomConfig;
     tasks: GanttDataTree;
-    _tasks: IParsedTask[];
     links: DataArray<ILink>;
+    _tasks: IParsedTask[];
     _links: IGanttLink[];
-    start: Date;
-    _start: Date;
-    end: Date;
-    _end: Date;
-    lengthUnit: string;
-    cellWidth: number;
-    cellHeight: number;
-    scaleHeight: number;
-    scales: GanttScale[];
-    _scales: GanttScaleData;
-    columns: GanttColumn[];
-    scrollTop: number;
-    scrollLeft: number;
-    area: IVisibleArea;
-    taskTypes?: ITaskType[];
-    baselines?: boolean;
-    zoom: IZoomConfig;
-    highlightTime?: (date: Date, unit: "day" | "hour") => string;
-    _cellWidth?: number;
-    _sort?: TSort[];
+    _selected?: ITask[];
+    _activeTask?: ITask;
+    _start?: Date;
+    _end?: Date;
+    _scales?: GanttScaleData;
     _scaleDate?: Date;
     _zoomOffset?: number;
-    autoScale?: boolean;
-    markers?: IMarker[];
-    _markers?: IMarker[];
-    unscheduledTasks?: boolean;
-    durationUnit: "day" | "hour";
+    _weekStart?: Day;
     _scrollTask?: TScrollTask;
+    _markers?: IMarker[];
 }
-export interface DataHash {
-    [key: string]: any;
+export interface IDataHash<T = any> {
+    [key: string]: T;
 }
-export type GanttScale = {
-    unit: string;
+export type IScaleConfig = {
+    unit: TLengthUnit;
     step: number;
     format?: {
         (date: Date, next?: Date): string;
@@ -175,49 +223,40 @@ export type GanttScaleData = {
     height: number;
     start: Date;
     end: Date;
-    lengthUnit: string;
+    lengthUnit: TLengthUnit;
     minUnit: string;
     lengthUnitWidth: number;
     diff: {
-        (a: Date, b: Date, lengthUnit?: string, unitSize?: boolean): number;
+        (a: Date, b: Date, lengthUnit?: TLengthUnit, unitSize?: boolean): number;
     };
 };
-export type GanttColumn = {
+export type GanttScaleUnit = {
+    start: (date: Date) => Date;
+    end: (date: Date) => Date;
+    isSame: (date1: Date, date2: Date) => boolean;
+    add: (date: Date, num: number) => Date;
+    diff?: (date1: Date, date2: Date) => number;
+    smallerCount?: {
+        [key: TLengthUnit]: number | ((date: Date) => number);
+    };
+    biggerCount?: {
+        [key: TLengthUnit]: number | ((date: Date) => number);
+    };
+};
+export type IGanttColumn = {
     width?: number;
     align?: "left" | "right" | "center";
     flexgrow?: number;
     resize?: boolean;
-    header: string | {
-        cell?: string;
-        css?: string;
-        text: string;
-    };
-    id: string;
-    action?: string;
-    template?: {
-        (b: any, row: any): string;
-    };
+    header?: IColumn["header"];
+    id?: string;
+    template?: IColumn["template"];
+    _template?: IColumn["template"];
     sort?: boolean;
     cell?: any;
-    editor?: TEditorType | IColumnEditor | TEditorHandler;
-    options?: DataHash[];
+    editor?: IColumn["editor"];
+    options?: IColumn["options"];
 };
-export interface IGanttTask extends IParsedTask {
-    end: Date;
-    duration: number;
-    unscheduled?: boolean;
-    $x: number;
-    $y: number;
-    $h: number;
-    $w: number;
-    $x_base?: number;
-    $w_base?: number;
-    $reorder?: boolean;
-}
-export interface IGanttLink extends ILink {
-    id: TID;
-    $p: string;
-}
 export type TCommonShape = {
     id?: TID;
     key: string;
@@ -225,6 +264,8 @@ export type TCommonShape = {
     labelTemplate?: (value: any) => string;
     config?: Record<string, any>;
     [key: string]: any;
+    isHidden?: (task: Partial<ITask>) => boolean;
+    isDisabled?: (task: Partial<ITask>, state: IData) => boolean;
 };
 export type TTextFieldShape = TCommonShape & {
     comp: "text" | "textarea";
@@ -259,7 +300,7 @@ export type ILinksShape = TCommonShape & {
 export type ITwoStateShape = TCommonShape & {
     comp: "twostate";
 };
-export type TEditorShape = TTextFieldShape | TCounterShape | TComboFieldShape | TSliderShape | TDateFieldShape | TRadioShape | ILinksShape | ITwoStateShape;
+export type TEditorItem = TTextFieldShape | TCounterShape | TComboFieldShape | TSliderShape | TDateFieldShape | TRadioShape | ILinksShape | ITwoStateShape;
 export type ITaskType = {
     id: TID;
     label: string;
@@ -273,3 +314,20 @@ export type TScrollTask = {
     id: TID;
     mode?: "x" | "y" | "xy" | boolean;
 };
+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;
+    intercept: <A extends keyof TMethodsConfig | (string & {})>(action: A, callback: (config: A extends keyof TMethodsConfig ? TMethodsConfig[A] : any) => any, config?: IEventConfig) => void;
+    detach: (tag: IEventConfig["tag"]) => void;
+    getState: () => IData;
+    getReactiveState: () => {
+        [Key in keyof IData]: IPublicWritable<IData[Key]>;
+    };
+    setNext: (ev: IEventBus<TMethodsConfig>) => void;
+    getStores: () => {
+        data: DataStore;
+    };
+    getTable: (waitRender?: boolean) => Promise<ITableApi> | ITableApi;
+    getTask: (id: TID) => ITask;
+    serialize: () => ITask[];
+}

package/license.txt

@@ -1,21 +1,9 @@
 MIT License
 
-Copyright (c) 2025 XB Software Sp. z o.o.
+Copyright (c) 2025 XB Software Sp. z o.o
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -1,24 +1,26 @@
 {
-	"name": "@svar-ui/gantt-store",
-	"version": "2.2.1",
-	"type": "module",
-	"main": "dist/index.js",
-	"module": "dist/index.js",
-	"types": "dist/types/index.d.ts",
-	"license": "MIT",
-	"scripts": {
-		"build": "vite build",
-		"watch": "vite build --mode development -w",
-		"lint": "yarn eslint ./src",
-		"test": "vitest --run",
-		"coverage": "vitest --run --coverage"
-	},
-	"files": [
-		"dist",
-		"license.txt"
-	],
-	"dependencies": {
-		"@svar-ui/lib-state": "1.9.6",
-		"date-fns": "3.6.0"
-	}
+  "name": "@svar-ui/gantt-store",
+  "version": "2.4.0",
+  "description": "Internal state management used by SVAR Gantt component",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/types/index.d.ts",
+  "license": "MIT",
+  "scripts": {
+    "build": "vite build",
+    "watch": "vite build --mode development -w",
+    "lint": "yarn eslint ./src",
+    "test": "vitest --run",
+    "coverage": "vitest --run --coverage"
+  },
+  "files": [
+    "dist",
+    "licenses",
+    "license.txt"
+  ],
+  "dependencies": {
+    "date-fns": "3.6.0",
+    "@svar-ui/lib-state": "1.9.6"
+  }
 }

package/readme.md

@@ -0,0 +1,5 @@
+# SVAR Gantt Store
+
+This package is part of the **SVAR Gantt (Open-Source Edition)** functionality and is distributed under the MIT license.
+
+The **gantt-store** package handles the internal state management used by the Gantt component.

package/dist/types/editorItems.d.ts

@@ -1,2 +0,0 @@
-import type { TEditorShape } from "./types";
-export declare const defaultEditorItems: TEditorShape[];