@highcharts/grid-pro 2.0.0

package/es-modules/Grid/Pro/ColumnTypes/Validator.js

@@ -0,0 +1,270 @@
+/* *
+ *
+ *  Grid cell content validator
+ *
+ *  (c) 2009-2024 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Dawid Dragula
+ *
+ * */
+'use strict';
+import AST from '../../../Core/Renderer/HTML/AST.js';
+import Globals from '../../Core/Globals.js';
+import GridUtils from '../../Core/GridUtils.js';
+import U from '../../../Core/Utilities.js';
+const { makeDiv, setHTMLContent } = GridUtils;
+const { defined } = U;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Class for validating cell content.
+ */
+class Validator {
+    /* *
+     *
+     *  Constructor
+     *
+     * */
+    constructor(viewport) {
+        this.viewport = viewport;
+        this.notifContainer = makeDiv(Validator.classNames.notifContainer);
+        this.viewport.grid.contentWrapper?.appendChild(this.notifContainer);
+    }
+    /* *
+     *
+     *  Methods
+     *
+     * */
+    /**
+     * Validates the cell content.
+     *
+     * @param cell
+     * Edited cell.
+     *
+     * @param errors
+     * An output array for error messages.
+     *
+     * @returns
+     * Returns true if the value is valid, false otherwise.
+     */
+    validate(cell, errors = []) {
+        const { options, dataType } = cell.column;
+        const validationErrors = cell.row.viewport.grid.options?.lang?.validationErrors;
+        let rules = Array.from(options?.cells?.editMode?.validationRules || []);
+        // Remove duplicates in validationRules
+        const isArrayString = rules.every((rule) => typeof rule === 'string');
+        if (rules.length > 0 && isArrayString) {
+            rules = [...new Set(rules)];
+        }
+        else {
+            const predefined = Validator.predefinedRules[dataType] || [];
+            const hasPredefined = rules.some((rule) => typeof rule !== 'string' &&
+                typeof rule.validate === 'string' &&
+                predefined.includes(rule.validate));
+            if (!hasPredefined) {
+                rules.push(...predefined);
+            }
+        }
+        for (const rule of rules) {
+            let ruleDef;
+            let err;
+            if (typeof rule === 'string') {
+                ruleDef = Validator.rulesRegistry[rule];
+                err = validationErrors?.[rule]?.notification;
+            }
+            else {
+                ruleDef = rule;
+            }
+            let validateFn;
+            if (typeof ruleDef.validate === 'string') {
+                const predefinedRules = (Validator.rulesRegistry[ruleDef.validate]);
+                validateFn =
+                    predefinedRules?.validate;
+            }
+            else {
+                validateFn = ruleDef.validate;
+            }
+            const { editModeContent } = cell.column.viewport.cellEditing || {};
+            if (typeof validateFn === 'function' &&
+                editModeContent &&
+                !validateFn.call(cell, editModeContent)) {
+                if (typeof ruleDef.notification === 'function') {
+                    err = ruleDef.notification.call(cell, editModeContent);
+                }
+                errors.push((err || ruleDef.notification));
+            }
+        }
+        return !errors.length;
+    }
+    /**
+     * Set content of notification and adjust the position.
+     *
+     * @param cell
+     * Cell that is currently edited and is not valid.
+     *
+     * @param errors
+     * An array of error messages.
+     *
+     */
+    initErrorBox(cell, errors) {
+        const { grid } = this.viewport;
+        this.errorCell = cell;
+        // Set error container position
+        this.reflow();
+        // Set width and content
+        setHTMLContent(this.notifContainer, errors.join('<br />'));
+        // A11y announcement
+        if (grid.options?.accessibility?.announcements?.cellEditing) {
+            this.viewport.grid.accessibility?.announce((grid.options?.lang?.accessibility?.cellEditing
+                ?.announcements?.notValid || '') + ' ' + errors.join('. '), true);
+        }
+        this.show();
+    }
+    /**
+     * Highlight the non-valid cell and display error in the notification box.
+     */
+    show() {
+        this.errorCell?.htmlElement.classList.add(Validator.classNames.editedCellError);
+        this.notifContainer.classList.add(Validator.classNames.notifError, Validator.classNames.notifAnimation);
+        // Set for the aria-errormessage attribute.
+        this.notifContainer.setAttribute('id', 'notification-error');
+    }
+    /**
+     * Hide the notification, error and unset highlight on cell.
+     *
+     * @param hideErrorBox
+     * The flag that hides the error on edited cell.
+     *
+     */
+    hide(hideErrorBox = true) {
+        this.errorCell?.htmlElement.classList.remove(Validator.classNames.editedCellError);
+        this.notifContainer.classList.remove(Validator.classNames.notifError, Validator.classNames.notifAnimation);
+        this.notifContainer.removeAttribute('id');
+        if (hideErrorBox) {
+            this.errorCell = void 0;
+        }
+        this.notifContainer.innerHTML = AST.emptyHTML;
+    }
+    /**
+     * Set the position of the error box.
+     */
+    reflow() {
+        const vp = this.viewport, errorCell = this.errorCell?.htmlElement, tableElement = vp.grid.tableElement, contentWrapper = vp.grid.contentWrapper;
+        if (!errorCell || !tableElement || !contentWrapper) {
+            return;
+        }
+        const tableTop = tableElement.offsetTop, tableHeight = tableElement.offsetHeight, middlePoint = tableTop + (tableHeight / 2), errorCellTop = errorCell.offsetTop - tableTop;
+        if (errorCellTop > middlePoint) {
+            this.notifContainer.style.top = // Avoid header overlap
+                tableTop + (vp.theadElement?.offsetHeight || 0) + 'px';
+            this.notifContainer.style.bottom = 'auto';
+        }
+        else {
+            this.notifContainer.style.top = 'auto';
+            this.notifContainer.style.bottom =
+                contentWrapper.offsetHeight - tableTop - tableHeight + 'px';
+        }
+    }
+    /**
+     * Destroy validator.
+     */
+    destroy() {
+        this.errorCell = void 0;
+        this.notifContainer.remove();
+    }
+}
+/* *
+ *
+ *  Namespace
+ *
+ * */
+/**
+ * Namespace for Validation functionality.
+ */
+(function (Validator) {
+    /**
+     * The class names used by the validator functionality.
+     */
+    Validator.classNames = {
+        notifContainer: Globals.classNamePrefix + 'notification',
+        notifError: Globals.classNamePrefix + 'notification-error',
+        notifAnimation: Globals.classNamePrefix + 'notification-animation',
+        editedCellError: Globals.classNamePrefix + 'edited-cell-error'
+    };
+    /* *
+     *
+     *  Variables
+     *
+     * */
+    /**
+     * Definition of default validation rules.
+     */
+    Validator.rulesRegistry = {
+        notEmpty: {
+            validate: ({ value, rawValue }) => (defined(value) && rawValue.length > 0),
+            notification: 'Value cannot be empty.'
+        },
+        number: {
+            validate: ({ rawValue }) => !isNaN(+rawValue),
+            notification: 'Value has to be a number.'
+        },
+        datetime: {
+            validate: ({ value }) => !defined(value) || !isNaN(+value),
+            notification: 'Value has to be parsed to a valid timestamp.'
+        },
+        'boolean': {
+            validate: ({ rawValue }) => (rawValue === 'true' || rawValue === 'false' ||
+                Number(rawValue) === 1 || Number(rawValue) === 0),
+            notification: 'Value has to be a boolean.'
+        },
+        ignoreCaseUnique: {
+            validate: function ({ rawValue }) {
+                const oldValue = String(this.value).toLowerCase();
+                const rowValueString = rawValue.toLowerCase();
+                if (oldValue === rowValueString) {
+                    return true;
+                }
+                const columnData = this.column.data;
+                const isDuplicate = columnData?.some((value) => String(value).toLowerCase() ===
+                    rowValueString);
+                return !isDuplicate;
+            },
+            notification: 'Value must be unique within this column (case-insensitive).'
+        },
+        unique: {
+            validate: function ({ rawValue }) {
+                const oldValue = this.value;
+                if (oldValue === rawValue) {
+                    return true;
+                }
+                const columnData = this.column.data;
+                const isDuplicate = columnData?.some((value) => value === rawValue);
+                return !isDuplicate;
+            },
+            notification: 'Value must be unique within this column (case-sensitive).'
+        }
+    };
+    /**
+     * Default validation rules for each dataType.
+     */
+    Validator.predefinedRules = {
+        'boolean': ['boolean'],
+        datetime: ['datetime'],
+        number: ['number'],
+        string: []
+    };
+})(Validator || (Validator = {}));
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default Validator;

package/es-modules/Grid/Pro/ColumnTypes/ValidatorComposition.d.ts

@@ -0,0 +1,32 @@
+import Validator from './Validator.js';
+declare module '../../Core/Table/Table' {
+    export default interface Table {
+        /**
+         * The validator object.
+         */
+        validator: Validator;
+    }
+}
+declare module '../../Pro/CellEditing/CellEditingComposition' {
+    interface ColumnEditModeOptions {
+        /**
+         * Validation options for the column.
+         *
+         * If not set, the validation rules are applied according to the data
+         * type.
+         */
+        validationRules?: (Validator.RuleKey | Validator.RuleDefinition)[];
+    }
+}
+declare module '../../Core/Options' {
+    interface LangOptions {
+        /**
+         * Validation options for the column.
+         *
+         * If not set, the validation rules are applied according to the data
+         * type.
+         */
+        validationErrors?: Validator.RulesRegistryType;
+    }
+}
+export default ValidatorComposition;

package/es-modules/Grid/Pro/ColumnTypes/ValidatorComposition.js

@@ -0,0 +1,63 @@
+/* *
+ *
+ *  Validator Composition.
+ *
+ *  (c) 2020-2024 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Sebastian Bochan
+ *
+ * */
+'use strict';
+import Validator from './Validator.js';
+import Globals from '../../Core/Globals.js';
+import U from '../../../Core/Utilities.js';
+const { addEvent, pushUnique } = U;
+/* *
+ *
+ *  Composition
+ *
+ * */
+/**
+ * @internal
+ */
+var ValidatorComposition;
+(function (ValidatorComposition) {
+    /**
+     * Extends the grid classes with cell editing functionality.
+     *
+     * @param TableClass
+     * The class to extend.
+     *
+     */
+    function compose(TableClass) {
+        if (!pushUnique(Globals.composed, 'Validator')) {
+            return;
+        }
+        addEvent(TableClass, 'afterInit', initValidatorComposition);
+        addEvent(TableClass, 'afterDestroy', destroy);
+    }
+    ValidatorComposition.compose = compose;
+    /**
+     * Callback function called after table initialization.
+     */
+    function initValidatorComposition() {
+        this.validator = new Validator(this);
+    }
+    /**
+     * Callback function called after table destroy.
+     */
+    function destroy() {
+        this.validator.destroy();
+    }
+})(ValidatorComposition || (ValidatorComposition = {}));
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default ValidatorComposition;

package/es-modules/Grid/Pro/Credits/CreditsPro.d.ts

@@ -0,0 +1,35 @@
+import type { CreditsOptions } from '../../Core/Options';
+import Credits from '../../Core/Credits.js';
+/**
+ * Represents a credits in the data grid.
+ */
+declare class CreditsPro extends Credits {
+    /**
+     * Set the content of the credits.
+     */
+    private setContent;
+    /**
+     * Append the credits to the container. The position of the credits is
+     * determined by the `position` option.
+     */
+    private appendToContainer;
+    /**
+     * Update the credits with new options.
+     *
+     * @param options
+     * The new options for the credits.
+     *
+     * @param render
+     * Whether to render the credits after the update.
+     */
+    update(options: Partial<CreditsOptions> | undefined, render?: boolean): void;
+    /**
+     * Render the credits. If the credits are disabled, they will be removed
+     * from the container. If also reflows the viewport dimensions.
+     */
+    render(): void;
+    destroy(): void;
+}
+declare namespace CreditsPro {
+}
+export default CreditsPro;

package/es-modules/Grid/Pro/Credits/CreditsPro.js

@@ -0,0 +1,112 @@
+/* *
+ *
+ *  Grid Credits class
+ *
+ *  (c) 2020-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Dawid Dragula
+ *  - Sebastian Bochan
+ *
+ * */
+'use strict';
+import Globals from '../../Core/Globals.js';
+import Credits from '../../Core/Credits.js';
+import GridUtils from '../../Core/GridUtils.js';
+const { setHTMLContent } = GridUtils;
+/* *
+ *
+ *  Class
+ *
+ * */
+/**
+ * Represents a credits in the data grid.
+ */
+class CreditsPro extends Credits {
+    /* *
+    *
+    *  Methods
+    *
+    * */
+    /**
+     * Set the content of the credits.
+     */
+    setContent() {
+        const { text, href } = this.options;
+        setHTMLContent(this.textElement, text || '');
+        this.textElement.setAttribute('href', href || '');
+    }
+    /**
+     * Append the credits to the container. The position of the credits is
+     * determined by the `position` option.
+     */
+    appendToContainer() {
+        const grid = this.grid;
+        const contentWrapper = grid.contentWrapper;
+        const { position } = this.options;
+        // Apply grid-pro class
+        this.containerElement.classList.add(Globals.getClassName('creditsPro'));
+        if (position === 'top') {
+            // Append the credits to the top of the table.
+            contentWrapper?.prepend(this.containerElement);
+            return;
+        }
+        // Append the credits to the bottom of the table.
+        if (grid.descriptionElement) {
+            contentWrapper?.insertBefore(this.containerElement, grid.descriptionElement);
+        }
+        else {
+            contentWrapper?.appendChild(this.containerElement);
+        }
+    }
+    /**
+     * Update the credits with new options.
+     *
+     * @param options
+     * The new options for the credits.
+     *
+     * @param render
+     * Whether to render the credits after the update.
+     */
+    update(options, render = true) {
+        if (options) {
+            this.grid.update({
+                credits: options
+            }, false);
+            this.options = this.grid.options?.credits ?? {};
+        }
+        if (render) {
+            this.render();
+        }
+    }
+    /**
+     * Render the credits. If the credits are disabled, they will be removed
+     * from the container. If also reflows the viewport dimensions.
+     */
+    render() {
+        const enabled = this.options.enabled ?? false;
+        this.containerElement.remove();
+        if (enabled) {
+            this.setContent();
+            this.appendToContainer();
+        }
+        else {
+            this.destroy();
+        }
+        this.grid.viewport?.reflow();
+    }
+    destroy() {
+        super.destroy();
+        delete this.grid.credits;
+    }
+}
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default CreditsPro;

package/es-modules/Grid/Pro/Credits/CreditsProComposition.d.ts

@@ -0,0 +1,28 @@
+import type Grid from '../../Core/Grid';
+import CreditsPro from './CreditsPro.js';
+declare namespace CreditsProComposition {
+    /**
+     * Extends the grid classes with customizable credits.
+     *
+     * @param GridClass
+     * The class to extend.
+     *
+     */
+    function compose(GridClass: typeof Grid): void;
+}
+declare module '../../Core/Options' {
+    interface Options {
+        /**
+         * Options for the credits label.
+         *
+         * Try it: {@link https://jsfiddle.net/gh/get/library/pure/highcharts/highcharts/tree/master/samples/grid-pro/credits | Credits options}
+         */
+        credits?: CreditsOptions;
+    }
+}
+declare module '../../Core/Grid' {
+    export default interface Grid {
+        credits?: CreditsPro;
+    }
+}
+export default CreditsProComposition;

package/es-modules/Grid/Pro/Credits/CreditsProComposition.js

@@ -0,0 +1,61 @@
+/* *
+ *
+ *  Grid Credits class
+ *
+ *  (c) 2020-2025 Highsoft AS
+ *
+ *  License: www.highcharts.com/license
+ *
+ *  !!!!!!! SOURCE GETS TRANSPILED BY TYPESCRIPT. EDIT TS FILE ONLY. !!!!!!!
+ *
+ *  Authors:
+ *  - Dawid Dragula
+ *  - Sebastian Bochan
+ *
+ * */
+'use strict';
+import CreditsPro from './CreditsPro.js';
+import Globals from '../../Core/Globals.js';
+import U from '../../../Core/Utilities.js';
+import Defaults from '../../Core/Defaults.js';
+const { addEvent, merge, pushUnique } = U;
+/* *
+ *
+ *  Class Namespace
+ *
+ * */
+var CreditsProComposition;
+(function (CreditsProComposition) {
+    /**
+     * Extends the grid classes with customizable credits.
+     *
+     * @param GridClass
+     * The class to extend.
+     *
+     */
+    function compose(GridClass) {
+        if (!pushUnique(Globals.composed, 'CreditsPro')) {
+            return;
+        }
+        merge(true, Defaults.defaultOptions, {
+            credits: CreditsPro.defaultOptions
+        });
+        // TODO: Change to `beforeLoad` after upgrading grid update.
+        addEvent(GridClass, 'afterRenderViewport', initCredits);
+    }
+    CreditsProComposition.compose = compose;
+    /**
+     * Init configurable credits.
+     * @param this
+     * Reference to Grid.
+     */
+    function initCredits() {
+        this.credits = new CreditsPro(this, this.options?.credits);
+    }
+})(CreditsProComposition || (CreditsProComposition = {}));
+/* *
+ *
+ *  Default Export
+ *
+ * */
+export default CreditsProComposition;

package/es-modules/Grid/Pro/Export/Exporting.d.ts

@@ -0,0 +1,68 @@
+import type Grid from '../../Core/Grid';
+import type { ExportingOptions } from '../../Core/Options';
+/**
+ * Export the given table to CSV format.
+ */
+declare class Exporting {
+    /**
+     * The Grid instance.
+     */
+    readonly grid: Grid;
+    /**
+     * Default options of the credits.
+     */
+    static defaultOptions: ExportingOptions;
+    /**
+     * Construct the exporting.
+     *
+     * @param grid
+     * The Grid instance.
+     */
+    constructor(grid: Grid);
+    /**
+     * Downloads the CSV string as a file.
+     *
+     * @param modified
+     * Whether to return the modified data table (after filtering/sorting/etc.)
+     * or the unmodified, original one. Default value is set to `true`.
+     */
+    downloadCSV(modified?: boolean): void;
+    /**
+     * Downloads the JSON string as a file.
+     *
+     * @param modified
+     * Whether to return the modified data table (after filtering/sorting/etc.)
+     * or the unmodified, original one. Default value is set to `true`.
+     */
+    downloadJSON(modified?: boolean): void;
+    /**
+     * Creates a CSV string from the data table.
+     *
+     * @param modified
+     * Whether to return the modified data table (after filtering/sorting/etc.)
+     * or the unmodified, original one. Default value is set to `true`.
+     *
+     * @return
+     * CSV string representing the data table.
+     */
+    getCSV(modified?: boolean): string;
+    /**
+     * Returns the current grid data as a JSON string.
+     *
+     * @param modified
+     * Whether to return the modified data table (after filtering/sorting/etc.)
+     * or the unmodified, original one. Default value is set to `true`.
+     *
+     * @return
+     * JSON representation of the data
+     */
+    getJSON(modified?: boolean): string;
+    /**
+     * Get the default file name used for exported the grid.
+     *
+     * @returns
+     * A file name without extension.
+     */
+    private getFilename;
+}
+export default Exporting;