refactor: add new select actions provider

Author: iobuhov

packages/shared/widget-plugin-grid/src/interfaces/SelectActionsService.ts

@@ -0,0 +1,11 @@
+import { ObjectItem } from "mendix";
+import { SelectAdjacentFx, SelectAllFx, SelectFx, SelectionType } from "../selection";
+
+export interface SelectActionsService {
+    selectionType: SelectionType;
+    select: SelectFx;
+    selectPage: SelectAllFx;
+    selectAdjacent: SelectAdjacentFx;
+    isSelected(item: ObjectItem): boolean;
+    clearSelection(): void;
+}

packages/shared/widget-plugin-grid/src/main.ts

@@ -1,10 +1,12 @@
 export { DatasourceService } from "./core/Datasource.service";
 export { ProgressService } from "./core/Progress.service";
 export type { QueryService } from "./interfaces/QueryService";
+export type { SelectActionsService } from "./interfaces/SelectActionsService";
 export type { SelectionDynamicProps } from "./interfaces/SelectionDynamicProps";
 export { type SelectionHelperService } from "./interfaces/SelectionHelperService";
 export type { TaskProgressService } from "./interfaces/TaskProgressService";
 export { SelectAllService } from "./select-all/SelectAll.service";
 export { SelectionCounterViewModel } from "./selection-counter/SelectionCounter.viewModel";
 export * from "./selection/context";
 export { createSelectionHelper } from "./selection/createSelectionHelper";
+export { SelectActionsProvider } from "./selection/SelectActionsProvider.service";

packages/shared/widget-plugin-grid/src/selection/SelectActionsProvider.service.ts

@@ -0,0 +1,116 @@
+import { ObjectItem } from "mendix";
+import { SelectActionsService } from "../interfaces/SelectActionsService";
+import { SelectionHelperService } from "../interfaces/SelectionHelperService";
+import { SelectAdjacentFx, SelectAllFx, SelectFx, SelectionType } from "./types";
+
+export class SelectActionsProvider implements SelectActionsService {
+    constructor(
+        private type: SelectionType,
+        private selectionHelper?: SelectionHelperService
+    ) {
+        if (type === "Multi") {
+            if (!selectionHelper || selectionHelper.type !== "Multi") {
+                throw new Error("SelectionHelperService of type Multi is required for Multi selection type");
+            }
+        }
+        if (type === "Single") {
+            if (!selectionHelper || selectionHelper.type !== "Single") {
+                throw new Error("SelectionHelperService of type Single is required for Single selection type");
+            }
+        }
+    }
+
+    get selectionType(): SelectionType {
+        return this.type;
+    }
+
+    select: SelectFx = (...params) => {
+        if (!this.selectionHelper) {
+            return;
+        }
+
+        if (this.selectionHelper.type === "Multi") {
+            this.selectItemMulti(...params);
+        } else {
+            this.selectItemSingle(...params);
+        }
+    };
+
+    selectPage: SelectAllFx = (requestedAction?: "selectAll") => {
+        if (!this.selectionHelper) {
+            return;
+        }
+
+        if (this.selectionHelper.type === "Single") {
+            console.warn("Calling selectPage in single selection mode have no effect");
+            return;
+        }
+
+        if (requestedAction === "selectAll") {
+            this.selectionHelper.selectAll();
+            return;
+        }
+
+        if (this.selectionHelper.selectionStatus === "all") {
+            this.selectionHelper.selectNone();
+        } else {
+            this.selectionHelper.selectAll();
+        }
+    };
+
+    selectAdjacent: SelectAdjacentFx = (...params) => {
+        if (this.selectionHelper?.type === "Multi") {
+            this.selectionHelper.selectUpToAdjacent(...params);
+        }
+    };
+
+    isSelected = (item: ObjectItem): boolean => {
+        return this.selectionHelper ? this.selectionHelper.isSelected(item) : false;
+    };
+
+    clearSelection = (): void => {
+        if (this.selectionHelper?.type === "Multi") {
+            this.selectionHelper.clearSelection();
+        } else if (this.selectionHelper?.type === "Single") {
+            this.selectionHelper.remove();
+        }
+    };
+
+    private selectItemMulti: SelectFx = (item, shiftKey, toggleMode = false) => {
+        if (this.selectionHelper?.type !== "Multi") {
+            return;
+        }
+
+        if (shiftKey) {
+            this.selectionHelper.selectUpTo(item, toggleMode ? "toggle" : "clear");
+            return;
+        }
+
+        this.selectItem(item, toggleMode);
+    };
+
+    private selectItemSingle: SelectFx = (item, _, toggleMode = false) => {
+        this.selectItem(item, toggleMode);
+    };
+
+    private selectItem = (item: ObjectItem, toggleMode: boolean): void => {
+        if (this.selectionHelper === undefined) {
+            return;
+        }
+
+        // clear mode
+        if (toggleMode === false) {
+            this.selectionHelper.reduceTo(item);
+            return;
+        }
+
+        // toggle mode
+        if (this.selectionHelper.isSelected(item)) {
+            this.selectionHelper.remove(item);
+        } else if (this.selectionHelper.type === "Multi") {
+            this.selectionHelper.add(item);
+        } else {
+            this.selectionHelper.reduceTo(item);
+        }
+    };
+}

packages/shared/widget-plugin-grid/src/selection/select-action-handler.ts

@@ -2,6 +2,7 @@ import { ObjectItem } from "mendix";
 import { SelectionHelperService } from "../interfaces/SelectionHelperService";
 import { SelectAdjacentFx, SelectAllFx, SelectFx, SelectionType, WidgetSelectionProperty } from "./types";
 
+/** @deprecated use `SelectActionsProvider` instead */
 export class SelectActionHandler {
     constructor(
         private selection: WidgetSelectionProperty,