@guiexpert/table 1.1.18 → 1.1.20

package/package.json

@@ -1,9 +1,7 @@
 {
   "name": "@guiexpert/table",
-  "version": "1.1.18",
-  "dependencies": {
-    "tslib": "^2.3.0"
-  },
+  "version": "1.1.20",
+  "private": false,
   "type": "module",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -11,18 +9,39 @@
     "entryFile": "src/index.ts"
   },
   "scripts": {
+    "i": "pnpm i",
+    "patch-version": "node patch.js",
+    "build": "vite build && npm run concat-css:main && npm run concat-css:dist",
+    "concat-css:main": "cat css/table*.css > css/main.css",
+    "concat-css:dist": "cat css/table*.css > dist/css/main.css",
     "typedoc:json": "npx typedoc --json ../../apps/table-website/src/assets/json/doctype.json src/index.ts",
     "typedoc:docs-html": "npx typedoc --out ../../apps/table-website/src/assets/docs src/index.ts",
     "typedoc:docs-html-custom-css": "npx typedoc --customCss ./doc.css --out ../../apps/table-website/src/assets/docs src/index.ts",
     "typedoc:docs-md": "npx typedoc --plugin typedoc-plugin-markdown --out ../../apps/table-website/src/assets/docsmd src/index.ts",
-    "npm-pub:table": "npm publish --access public"
+    "npm-pub": "npm publish --access public"
   },
   "exports": {
     ".": {
       "import": "./index.js",
       "require": "./index.cjs"
     }
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.17",
+    "vite": "^5.1.1",
+    "vite-plugin-dts": "^3.7.2",
+    "vite-plugin-eslint": "^1.8.1",
+    "vite-plugin-static-copy": "^0.17.0",
+    "vite-tsconfig-paths": "^4.2.1",
+    "vite-plugin-babel": "^1.2.0",
+    "ts-node": "10.9.1",
+    "tsconfig": "^7.0.0",
+    "typedoc": "0.25.3",
+    "typedoc-plugin-rename-defaults": "^0.7.0",
+    "typedoc-plugin-markdown": "3.17.1",
+    "typescript": "5.2.2"
   }
-}
-
-
+}

package/patch.js

@@ -0,0 +1,16 @@
+import fs from 'fs';
+
+const packageJsonPath = 'package.json';
+
+try {
+  const pack = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+  const currentVersion = pack.version;
+  const [major, minor, patch] = currentVersion.split('.').map(Number);
+  const newPatchVersion = `${major}.${minor}.${patch + 1}`;
+  pack.version = newPatchVersion;
+  fs.writeFileSync(packageJsonPath, JSON.stringify(pack, null, 2));
+  console.log(`${pack.name} -> version patched to ${newPatchVersion}.`);
+
+} catch (error) {
+  console.error('Error:', error);
+}

package/src/index.ts

@@ -0,0 +1,176 @@
+
+export * from './lib/common/decorator/avoid-double-execution.decorator';
+
+export * from './lib/table/license-manager';
+export * from './lib/table/instanceof-workaround';
+export * from './lib/table/table-scope';
+export * from './lib/table/table-api';
+export * from './lib/table/ele-scope';
+export * from './lib/table/render-scope';
+export * from './lib/table/mouse-handler';
+export * from './lib/table/input-handler';
+export * from './lib/table/event-listener.if';
+export * from './lib/table/event-adapter';
+export * from './lib/table/css-vars';
+export * from './lib/table/selection/event-selection-changed-listener.if';
+export * from './lib/table/focus/event-focus-changed-listener.if';
+
+export * from './lib/table/factory/tree-factory';
+export * from './lib/table/factory/table-factory';
+
+
+export * from './lib/table/action/action-id.type';
+export * from './lib/table/action/shortcut.service';
+export * from './lib/table/action/shortcut-actionid-mapping.type';
+export * from './lib/table/action/windows-shortcut-actionId-mapping';
+export * from './lib/table/action/osx-shortcut-actionId-mapping';
+export * from './lib/table/action/on-action-triggered.if';
+
+export * from './lib/table/data/side-ident.type';
+export * from './lib/table/data/div-scope.type';
+export * from './lib/table/data/geo-data';
+export * from './lib/table/data/table-model-and-options.if';
+export * from './lib/table/data/table-model-and-options';
+export * from './lib/table/data/chunk/chunk.data-event';
+export * from './lib/table/data/chunk/chunk.data-event.if';
+export * from './lib/table/data/chunk/request-chunk';
+export * from './lib/table/data/chunk/request-chunk.if';
+
+export * from './lib/table/data/common/get-t';
+export * from './lib/table/data/common/value-label.if';
+export * from './lib/table/data/common/value-label';
+export * from './lib/table/data/common/sort-item';
+export * from './lib/table/data/common/sort-state.type';
+export * from './lib/table/data/common/index-and-px';
+export * from './lib/table/data/common/cell-range';
+export * from './lib/table/data/common/checked-type';
+export * from './lib/table/data/common/sizes';
+export * from './lib/table/data/common/aligns';
+export * from './lib/table/data/common/boolean-function';
+export * from './lib/table/data/common/checkbox-column-def';
+export * from './lib/table/data/common/size';
+export * from './lib/table/data/common/size.if';
+export * from './lib/table/data/common/sort-item';
+export * from './lib/table/data/common/sort-state.type';
+export * from './lib/table/data/common/area-map';
+export * from './lib/table/data/common/area-map.type';
+export * from "./lib/table/data/common/area-map-factory";
+export * from "./lib/table/data/common/filter-function";
+export * from "./lib/table/data/common/args-render-cell-div";
+export * from "./lib/table/data/common/args-adjust-columns-to-row-parent-params";
+
+export * from "./lib/table/data/common/event/ge-mouse-event";
+export * from "./lib/table/data/common/event/ge-model-change-event";
+export * from "./lib/table/data/common/event/ge-cell-indices";
+export * from "./lib/table/data/common/event/ge-key-event";
+
+export * from "./lib/table/data/common/event/input/table-cell-update-event";
+export * from "./lib/table/data/common/event/input/table-cell-update-event.if";
+
+export * from "./lib/table/data/event/mouse-target-data";
+
+export * from "./lib/table/focus/focus-model";
+export * from "./lib/table/focus/focus-model.if";
+export * from "./lib/table/focus/focus.type";
+
+export * from "./lib/table/checkbox/checkbox-model";
+export * from "./lib/table/checkbox/tree-checkbox-model";
+export * from "./lib/table/checkbox/checkbox-model.if";
+
+export * from "./lib/table/data/options/auto-restore-options.if";
+export * from './lib/table/data/options/auto-restore-options';
+export * from './lib/table/data/options/table-options';
+export * from './lib/table/data/options/table-options.if';
+export * from './lib/table/data/options/default-row-heights.if';
+export * from './lib/table/data/options/default-row-heights';
+export * from './lib/table/data/options/tree-options';
+export * from './lib/table/data/options/tree-options.if';
+export * from './lib/table/data/options/icon';
+export * from './lib/table/data/options/icon.if';
+export * from './lib/table/data/options/sorted-options.if';
+export * from './lib/table/data/options/sorted-options';
+
+export * from './lib/table/data/tablemodel/padding';
+export * from './lib/table/data/tablemodel/table-model.if';
+export * from './lib/table/data/tablemodel/table-model';
+export * from './lib/table/data/tablemodel/area-ident.type';
+
+export * from './lib/table/data/tablemodel/column/column-def';
+export * from './lib/table/data/tablemodel/column/column-def.if';
+
+export * from './lib/table/data/tablemodel/cellgroup/cell-group';
+export * from './lib/table/data/tablemodel/cellgroup/cell-group.if';
+export * from './lib/table/data/tablemodel/cellgroup/cellgroup-factory';
+export * from './lib/table/data/tablemodel/cellgroup/cell-group-ext';
+
+export * from './lib/table/data/tablemodel/areamodel/area-model.if';
+export * from './lib/table/data/tablemodel/areamodel/area-model';
+export * from './lib/table/data/tablemodel/areamodel/area-model-cell-groups';
+export * from "./lib/table/data/tablemodel/areamodel/abstract-area-model";
+export * from "./lib/table/data/tablemodel/areamodel/area-model-array-of-arrays";
+export * from "./lib/table/data/tablemodel/areamodel/area-model-hidden";
+export * from './lib/table/data/tablemodel/areamodel/area-model-object-array';
+export * from './lib/table/data/tablemodel/areamodel/area-model-tree';
+export * from './lib/table/data/tablemodel/areamodel/col-and-rowspan-model';
+export * from './lib/table/data/tablemodel/areamodel/has-default-row-height-if';
+export * from './lib/table/data/tablemodel/areamodel/object-array-holder.if';
+
+export * from './lib/table/data/common/tree-row';
+export * from './lib/table/data/common/tree-row-if';
+export * from './lib/table/data/common/tree-arrow.type';
+export * from './lib/table/data/tablemodel/areamodel/area-model-object-array-with-columndefs';
+
+export * from './lib/table/service/convenience-dom.service';
+export * from "./lib/table/service/dom-service.if";
+export * from "./lib/table/service/simple-dom-service";
+export * from "./lib/table/service/tree-row.service";
+export * from "./lib/table/service/store-state-scroll-pos.service";
+export * from "./lib/table/service/store-state-collapsed-expand.service";
+export * from "./lib/table/service/store-state-sorting.service";
+export * from "./lib/table/service/data/collapsed-expanded.data";
+export * from "./lib/table/service/data/html-style.type";
+export * from "./lib/table/service/ge-filter.service";
+export * from "./lib/table/service/copy-service";
+export * from "./lib/table/service/copy-service.if";
+
+
+export * from "./lib/table/renderer/renderer";
+export * from "./lib/table/renderer/cell-render.if";
+export * from "./lib/table/renderer/cell-group-ext-cell-renderer";
+export * from "./lib/table/renderer/checkbox-cell-renderer";
+export * from "./lib/table/renderer/checkbox-boolean-property-cell-renderer";
+export * from "./lib/table/renderer/date-to-iso-cell-renderer";
+export * from "./lib/table/renderer/date-to-int-date-cell-renderer";
+export * from "./lib/table/renderer/date-to-locale-date-cell-renderer";
+export * from "./lib/table/renderer/male-female-to-icon-cell-renderer";
+export * from "./lib/table/renderer/number-cell-progress-bar-cell-renderer";
+export * from "./lib/table/renderer/true-false-cell-renderer";
+export * from "./lib/table/renderer/date-to-tec-cell-renderer";
+export * from "./lib/table/renderer/renderer-cleanup-fn.type";
+export * from "./lib/table/renderer/number-cell-renderer";
+export * from "./lib/table/renderer/star-rating-cell-renderer";
+export * from "./lib/table/renderer/progress-bar-cell-renderer";
+export * from "./lib/table/renderer/positive-and-negative-number-renderer";
+
+export * from "./lib/table/renderer/edit/edit-cell-renderer.type";
+export * from "./lib/table/renderer/edit/edit-input-pipe.if";
+export * from "./lib/table/renderer/edit/edit-input-pipe-for-number";
+export * from "./lib/table/renderer/edit/input-cell-renderer";
+export * from './lib/table/renderer/edit/select-cell-renderer';
+
+export * from './lib/table/selection/selection-model';
+export * from './lib/table/selection/selection-model.if';
+export * from './lib/table/selection/selection.type';
+export * from './lib/table/selection/selection-service';
+export * from './lib/table/selection/multi-rows-selection-model';
+
+
+export * from './lib/table/color/color-rgb';
+export * from './lib/table/color/color-rgb.if';
+export * from './lib/table/color/ge-css-color-util';
+export * from './lib/table/color/three-color-gradient-arg.if';
+export * from './lib/table/color/three-color-gradient-arg';
+export * from './lib/table/color/two-color-gradient-arg.if';
+export * from './lib/table/color/two-color-gradient-arg';
+export * from "./lib/table/data/tablemodel/areamodel/has-default-row-height-if";
+

package/src/lib/common/decorator/avoid-double-execution.decorator.ts

@@ -0,0 +1,21 @@
+/**
+ * A decorator that prevents a method from being executed multiple times within a specified delay.
+ *
+ * @param {number} [delay=500] - The delay threshold in milliseconds.
+ * @returns {Function} - The decorated method descriptor.
+ */
+export function AvoidDoubleExecution(delay:number = 500) {
+  return function (_target: any, _key: string, descriptor: PropertyDescriptor) {
+    let lastClick = 0;
+    const originalMethod = descriptor.value;
+    descriptor.value = function (...args: any[]) {
+      if (Date.now() - lastClick < delay) {
+        // skipped
+        return;
+      }
+      lastClick = Date.now();
+      return originalMethod.apply(this, args);
+    };
+    return descriptor;
+  };
+}

package/src/lib/table/action/action-id.type.ts

@@ -0,0 +1,36 @@
+/**
+ * An array of action identifiers.
+ *
+ * @type {ReadonlyArray<string>}
+ */
+export const actionIds = [
+  "COPY_2_CLIPBOARD",
+
+  "START_EDITING",
+
+  "TOGGLE_SELECTION",
+  "SELECT_ALL",
+  "DESELECT_ALL",
+
+  "NAVIGATE_LEFT",
+  "NAVIGATE_RIGHT",
+  "NAVIGATE_UP",
+  "NAVIGATE_DOWN",
+  //
+  // "ENTER_PRESSED",
+  // "HOME_PRESSED",
+  // "SPACE_PRESSED",
+  // "END_PRESSED",
+  // "PAGEUP_PRESSED",
+  // "PAGEDOWN_PRESSED"
+] as const;
+
+/**
+ * Represents an action ID.
+ *
+ * @typedef {string} ActionId
+ * @memberof module:myModule
+ * @see module:myModule.actionIds
+ */
+export type ActionId = typeof actionIds[number];
+

package/src/lib/table/action/on-action-triggered.if.ts

@@ -0,0 +1,14 @@
+import { ActionId } from "./action-id.type";
+
+export interface OnActionTriggeredIf {
+
+  /**
+   * Triggers an action based on the provided action ID.
+   *
+   * @param {ActionId} actionId - The ID of the action to be triggered.
+   *
+   * @return {boolean} - Returns true if the action was successfully triggered; otherwise, false.
+   */
+  onActionTriggered(actionId: ActionId): boolean;
+
+}

package/src/lib/table/action/osx-shortcut-actionId-mapping.ts

@@ -0,0 +1,39 @@
+import { ActionId } from "./action-id.type";
+
+/**
+ * Class representing the mapping of OS X shortcut actions to action IDs.
+ *
+ * Use 'meta' for the MacOS 'cmd' key.
+ *
+ * @class OsxShortcutActionIdMapping
+ */
+export class OsxShortcutActionIdMapping {
+
+  get(): { [key: string]: ActionId } {
+    return {
+      "f2": "START_EDITING",
+
+      "space": "TOGGLE_SELECTION",
+
+      "ctrl+num_add": "SELECT_ALL",
+      "meta+a": "SELECT_ALL",
+      "ctrl+a": "SELECT_ALL",
+
+      "meta+x": "DESELECT_ALL",
+      "meta+shift+a": "DESELECT_ALL",
+      "ctrl+shift+a": "DESELECT_ALL",
+      "ctrl+num_subtract": "DESELECT_ALL",
+      "ctrl -": "DESELECT_ALL",
+
+      "arrowup": "NAVIGATE_UP",
+      "arrowdown": "NAVIGATE_DOWN",
+      "arrowleft": "NAVIGATE_LEFT",
+      "arrowright": "NAVIGATE_RIGHT",
+
+      "meta+c": "COPY_2_CLIPBOARD",
+      "ctrl+c": "COPY_2_CLIPBOARD",
+    };
+  }
+
+
+}

package/src/lib/table/action/shortcut-actionid-mapping.type.ts

@@ -0,0 +1,7 @@
+import { ActionId } from "./action-id.type";
+
+/**
+ * Represents a mapping of shortcut action IDs.
+ * @typedef {Object.<string, ActionId>} ShortcutActionIdMapping
+ */
+export type ShortcutActionIdMapping = { [key: string]: ActionId };

package/src/lib/table/action/shortcut.service.ts

@@ -0,0 +1,162 @@
+import { ActionId } from "./action-id.type";
+import { TableScope } from "../table-scope";
+import { ShortcutActionIdMapping } from "./shortcut-actionid-mapping.type";
+import { WindowsShortcutActionIdMapping } from "./windows-shortcut-actionId-mapping";
+import { OsxShortcutActionIdMapping } from "./osx-shortcut-actionId-mapping";
+import { OnActionTriggeredIf } from "./on-action-triggered.if";
+
+
+/**
+ * Represents a service for managing shortcuts and triggering actions based on keyboard events.
+ */
+export class ShortcutService {
+
+  private shortcutActionIdMapping: ShortcutActionIdMapping = {};
+  private listener: OnActionTriggeredIf[] = [];
+
+  constructor(
+    protected tableScope: TableScope
+  ) {
+    this.listener.push(tableScope);
+    this.init();
+  }
+
+
+  /**
+   * Adds a listener to the list of listeners.
+   *
+   * @param {OnActionTriggeredIf} listener - The listener to be added.
+   * @returns {void}
+   */
+  addListener(listener: OnActionTriggeredIf) {
+    if (!this.listener.includes(listener)) {
+      this.listener.push(listener);
+    }
+  }
+
+  /**
+   * Initializes the ShortcutService by assigning shortcut action id mappings based on the current operating system.
+   * Also adds key down event listener to the table host element.
+   */
+  init() {
+    this.assignPredefinedSystemShortcutMappings();
+
+    // Overwrite predefined mapping with mapping from the table options:
+    Object.assign(this.shortcutActionIdMapping, this.tableScope.tableOptions.shortcutActionIdMapping);
+
+    if (this.isDebug()) {
+      console.debug("ShortcutService", this.shortcutActionIdMapping);
+    }
+    // add key down listener:
+    this.tableScope.hostElement.addEventListener("keydown", this.onKeyDown.bind(this));
+  }
+
+  private assignPredefinedSystemShortcutMappings(){
+    if (this.isMacintosh()) {
+      Object.assign(this.shortcutActionIdMapping, new OsxShortcutActionIdMapping().get());
+    } else {
+      Object.assign(this.shortcutActionIdMapping, new WindowsShortcutActionIdMapping().get());
+    }
+  }
+
+  private isMacintosh() {
+    return navigator.platform.indexOf("Mac") > -1;
+  }
+
+  private isDebug() {
+    return this.isLocalhost();
+  }
+
+  private isLocalhost() {
+    return (location.hostname === "localhost" || location.hostname === "127.0.0.1");
+  }
+
+
+  private onKeyDown(evt: KeyboardEvent) {
+    const actionId = this.findEntity(evt);
+    if (actionId) {
+      const consumed = this.emit(actionId);
+      if (consumed) {
+        evt.preventDefault();
+        evt.stopPropagation();
+      }
+    }
+  }
+
+  private emit(actionId: ActionId): boolean {
+    if (this.isDebug()) {
+      console.debug("ShortcutService emit      :", actionId);
+    }
+    let ret = false;
+    for (const l of this.listener) {
+      const consumed = l.onActionTriggered(actionId);
+      if (consumed) {
+        ret = true;
+      }
+    }
+    return ret;
+  }
+
+  private findEntity(evt: KeyboardEvent): ActionId | undefined {
+    const tokens = this.getTokenByEvent(evt);
+    if (this.isDebug()) {
+      console.debug("ShortcutService tokens    :", tokens);
+    }
+    for (const key in this.shortcutActionIdMapping) {
+      const shortcutTokens = key
+        .replace(/opt/g, "alt")
+        .replace(/cmd/g, "meta")
+        .split(/[+ ]/g).sort();
+
+      if (this.areTokensEquals(tokens, shortcutTokens)) {
+        return this.shortcutActionIdMapping[key] as ActionId;
+      }
+    }
+    return undefined;
+  }
+
+  private areTokensEquals(tokens1: string[], tokens2: string[]): boolean {
+    if (tokens1.length !== tokens2.length) {
+      return false;
+    }
+    if (tokens1.length === 0) {
+      return false;
+    }
+    for (let i = 0; i < tokens1.length; i++) {
+      if (tokens1[i] !== tokens2[i]) {
+        return false;
+      }
+    }
+
+    return true;
+  }
+
+  private getTokenByEvent(evt: KeyboardEvent): string[] {
+    const tokens: string[] = [];
+    if (evt.altKey) {
+      tokens.push("alt");
+    }
+    if (evt.shiftKey) {
+      tokens.push("shift");
+    }
+    if (evt.ctrlKey) {
+      tokens.push("ctrl");
+    }
+    if (evt.metaKey) {
+      tokens.push("meta");
+    }
+    if (evt.code) {
+      tokens.push(evt.code.toLowerCase().replace(/key/g, ""));
+    }
+    return tokens.sort();
+  }
+
+  /**
+   * Retrieves the shortcut action mapping object.
+   *
+   * @returns {ShortcutActionIdMapping} - The shortcut action mapping object.
+   */
+  getShortcutActionMapping(): ShortcutActionIdMapping {
+    return this.shortcutActionIdMapping;
+  }
+}

package/src/lib/table/action/windows-shortcut-actionId-mapping.ts

@@ -0,0 +1,35 @@
+import { ActionId } from "./action-id.type";
+
+/**
+ * Class representing a mapping of Windows shortcut keys to action IDs.
+ *
+ * Use 'meta' for the MacOS 'cmd' key.
+ */
+export class WindowsShortcutActionIdMapping {
+
+  get(): { [key: string]: ActionId } {
+    return {
+      "f2": "START_EDITING",
+
+      "space": "TOGGLE_SELECTION",
+
+      "ctrl+num_add": "SELECT_ALL",
+      "ctrl+a": "SELECT_ALL",
+
+      "ctrl+shift+a": "DESELECT_ALL",
+      "ctrl+x": "DESELECT_ALL",
+      "ctrl+num_subtract": "DESELECT_ALL",
+
+      "meta -": "DESELECT_ALL",
+
+      "arrowup": "NAVIGATE_UP",
+      "arrowdown": "NAVIGATE_DOWN",
+      "arrowleft": "NAVIGATE_LEFT",
+      "arrowright": "NAVIGATE_RIGHT",
+
+      "meta+c": "COPY_2_CLIPBOARD",
+      "ctrl+c": "COPY_2_CLIPBOARD",
+    };
+  }
+
+}

package/src/lib/table/checkbox/checkbox-model.if.ts

@@ -0,0 +1,16 @@
+import { CheckedType } from "../data/common/checked-type";
+
+export interface CheckboxModelIf<T> {
+
+  getCheckedRows(): T[];
+
+  setCheckedRows(value: T[]): void;
+
+  addCheckedRows(value: T[]): void;
+
+  checkRow(row: T, check: boolean): void;
+
+  isRowChecked(row: T): CheckedType;
+
+  checkAll(value: T[]): void;
+}

package/src/lib/table/checkbox/checkbox-model.ts

@@ -0,0 +1,62 @@
+import { CheckedType } from "../data/common/checked-type";
+import { CheckboxModelIf } from "./checkbox-model.if";
+
+export class CheckboxModel<T> implements CheckboxModelIf<T> {
+
+  protected checkedRows: Array<T> = [];
+
+  getCheckedRows(): T[] {
+    return this.checkedRows;
+  }
+
+  setCheckedRows(rows: T[]) {
+    this.checkedRows = rows;
+  }
+
+
+  addCheckedRows(rows: T[]) {
+    if (!this.checkedRows) {
+      this.checkedRows = [];
+    }
+    for (const row of rows) {
+      if (!this.checkedRows.includes(row)) {
+        this.checkedRows.push(row);
+      }
+    }
+  }
+
+  checkRow(row: T, sel: boolean) {
+    if (!this.checkedRows) {
+      this.checkedRows = [];
+    }
+    if (sel) {
+      if (!this.checkedRows.includes(row)) {
+        this.checkedRows.push(row);
+      }
+    } else {
+      this.removeSelectedRow(row);
+    }
+  }
+
+
+  isRowChecked(row: T): CheckedType {
+    if (this.checkedRows) {
+      return this.checkedRows.includes(row) ? "full" : "none";
+    }
+    return "none";
+  }
+
+  checkAll(_rows: T[]) {
+    this.checkedRows = [];
+  }
+
+  private removeSelectedRow(row: T) {
+    if (this.checkedRows) {
+      const idx = this.checkedRows.indexOf(row);
+      if (idx > -1) {
+        this.checkedRows.splice(idx, 1);
+      }
+    }
+  }
+
+}