@highcharts/grid-pro 2.2.0 → 2.3.0

package/es-modules/Data/Converters/CSVConverter.d.ts

@@ -1,7 +1,7 @@
-import type DataEvent from '../DataEvent';
+import type { DataEventDetail } from '../DataEvent';
 import type CSVConverterOptions from './CSVConverterOptions';
 import DataConverter from './DataConverter.js';
-import DataTable from '../DataTable.js';
+import type { ColumnCollection as DataTableColumnCollection } from '../DataTable.js';
 /**
  * Handles parsing and transforming CSV to a table.
  *
@@ -34,15 +34,15 @@ declare class CSVConverter extends DataConverter {
      *
      * @param {Partial<CSVConverterOptions>} [options]
      * Options for the parser.
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
-     * @return {DataTable.ColumnCollection}
+     * @return {DataTableColumnCollection}
      * The parsed column collection.
      *
      * @emits CSVDataParser#parse
      * @emits CSVDataParser#afterParse
      */
-    parse(options: Partial<CSVConverterOptions>, eventDetail?: DataEvent.Detail): DataTable.ColumnCollection;
+    parse(options: Partial<CSVConverterOptions>, eventDetail?: DataEventDetail): DataTableColumnCollection;
     /**
      * Parses a single CSV row string into columns, handling delimiters,
      * quoted values, data type inference, and column range selection.

package/es-modules/Data/Converters/CSVConverter.js

@@ -17,8 +17,7 @@
 'use strict';
 import DataConverter from './DataConverter.js';
 import DataConverterUtils from './DataConverterUtils.js';
-import U from '../../Core/Utilities.js';
-const { merge } = U;
+import { merge } from '../../Shared/Utilities.js';
 /* *
  *
  *  Class
@@ -65,9 +64,9 @@ class CSVConverter extends DataConverter {
      *
      * @param {Partial<CSVConverterOptions>} [options]
      * Options for the parser.
-     * @param {DataEvent.Detail} [eventDetail]
+     * @param {DataEventDetail} [eventDetail]
      * Custom information for pending events.
-     * @return {DataTable.ColumnCollection}
+     * @return {DataTableColumnCollection}
      * The parsed column collection.
      *
      * @emits CSVDataParser#parse

package/es-modules/Data/Converters/CSVConverterOptions.d.ts

@@ -19,7 +19,7 @@
 
 import type { CSVBeforeParseCallbackFunction } from '../Connectors/CSVConnectorOptions';
 
-import DataConverter from './DataConverter';
+import type { Options as DataConverterOptions } from './DataConverter';
 
 /* *
  *
@@ -30,7 +30,7 @@ import DataConverter from './DataConverter';
 /**
  * Options of the CSVConverter.
  */
-export interface CSVConverterOptions extends DataConverter.Options {
+export interface CSVConverterOptions extends DataConverterOptions {
     startRow: number;
     endRow: number;
     startColumn: number;

package/es-modules/Data/Converters/DataConverter.d.ts

@@ -1,28 +1,48 @@
 import type { DataConverterTypes } from './DataConverterType';
-import type DataEvent from '../DataEvent';
+import type { DataEvent, DataEventCallback, DataEventEmitter } from '../DataEvent';
 import type { ColumnIdsOptions } from '../Connectors/JSONConnectorOptions';
-import DataTable from '../DataTable.js';
+import DataTable, { type Column as DataTableColumn } from '../DataTable.js';
 /**
  * Base class providing an interface and basic methods for a DataConverter
  *
  * @private
  */
-declare class DataConverter implements DataEvent.Emitter<DataConverter.Event> {
+declare class DataConverter implements DataEventEmitter<Event> {
     /**
      * Default options
      */
-    protected static readonly defaultOptions: DataConverter.Options;
+    protected static readonly defaultOptions: Options;
+    /**
+     * Registry as a record object with converter names and their class.
+     */
+    static types: DataConverterTypes;
+    /**
+     * Adds a converter class to the registry.
+     *
+     * @private
+     *
+     * @param {string} key
+     * Registry key of the converter class.
+     *
+     * @param {DataConverterTypes} DataConverterClass
+     * Connector class (aka class constructor) to register.
+     *
+     * @return {boolean}
+     * Returns true, if the registration was successful. False is returned, if
+     * their is already a converter registered with this key.
+     */
+    static registerType<T extends keyof DataConverterTypes>(key: T, DataConverterClass: DataConverterTypes[T]): boolean;
     /**
      * Constructs an instance of the DataConverter.
      *
-     * @param {DataConverter.UserOptions} [options]
+     * @param {UserOptions} [options]
      * Options for the DataConverter.
      */
-    constructor(options?: DataConverter.UserOptions);
+    constructor(options?: UserOptions);
     /**
      * A collection of available date formats.
      */
-    dateFormats: Record<string, DataConverter.DateFormatObject>;
+    dateFormats: Record<string, DateFormatObject>;
     /**
      * Regular expression used in the trim method to change a decimal point.
      */
@@ -30,7 +50,7 @@ declare class DataConverter implements DataEvent.Emitter<DataConverter.Event> {
     /**
      * Options for the DataConverter.
      */
-    readonly options: DataConverter.Options;
+    readonly options: Options;
     /**
      * Converts a string value based on its guessed type.
      *
@@ -40,7 +60,7 @@ declare class DataConverter implements DataEvent.Emitter<DataConverter.Event> {
      * @return {number | string | Date}
      * The converted value.
      */
-    convertByType(value: DataConverter.Type): number | string | Date;
+    convertByType(value: Type): number | string | Date;
     /**
      * Tries to guess the date format
      *  - Check if either month candidate exceeds 12
@@ -63,23 +83,23 @@ declare class DataConverter implements DataEvent.Emitter<DataConverter.Event> {
     /**
      * Emits an event on the DataConverter instance.
      *
-     * @param {DataConverter.Event} [e]
+     * @param {Event} [e]
      * Event object containing additional event data
      */
-    emit(e: DataConverter.Event): void;
+    emit(e: Event): void;
     /**
      * Registers a callback for a specific event.
      *
      * @param {string} type
      * Event type as a string.
      *
-     * @param {DataEventEmitter.Callback} callback
+     * @param {DataEventCallback} callback
      * Function to register for an modifier callback.
      *
      * @return {Function}
      * Function to unregister callback from the modifier event.
      */
-    on<T extends DataConverter.Event['type']>(type: T, callback: DataEvent.Callback<this, Extract<DataConverter.Event, {
+    on<T extends Event['type']>(type: T, callback: DataEventCallback<this, Extract<Event, {
         type: T;
     }>>): Function;
     /**
@@ -97,72 +117,50 @@ declare class DataConverter implements DataEvent.Emitter<DataConverter.Event> {
 /**
  * Additionally provided types for events and conversion.
  */
-declare namespace DataConverter {
-    /**
-     * The basic event object for a DataConverter instance.
-     * Valid types are `parse`, `afterParse`, and `parseError`
-     */
-    interface Event extends DataEvent {
-        readonly type: ('export' | 'afterExport' | 'exportError' | 'parse' | 'afterParse' | 'parseError');
-        readonly columns: DataTable.Column[];
-        readonly error?: string | Error;
-        readonly headers: string[] | ColumnIdsOptions;
-    }
-    interface DateFormatCallbackFunction {
-        (match: ReturnType<string['match']>): number;
-    }
-    interface DateFormatObject {
-        alternative?: string;
-        parser: DateFormatCallbackFunction;
-        regex: RegExp;
-    }
-    /**
-     * The shared options for all DataConverter instances
-     */
-    interface Options {
-        dateFormat?: string;
-        decimalPoint?: string;
-        firstRowAsNames: boolean;
-        /**
-         * A function to parse string representations of dates into JavaScript
-         * timestamps. If not set, the default implementation will be used.
-         */
-        parseDate?: DataConverter.ParseDateFunction;
-    }
-    /**
-     * A function to parse string representations of dates
-     * into JavaScript timestamps.
-     */
-    interface ParseDateFunction {
-        (dateValue: string): number;
-    }
-    /**
-     * Contains supported types to convert values from and to.
-     */
-    type Type = (boolean | null | number | string | DataTable | Date | undefined);
-    /**
-     * Options of the DataConverter.
-     */
-    type UserOptions = Partial<Options>;
-    /**
-     * Registry as a record object with connector names and their class.
-     */
-    const types: DataConverterTypes;
+/**
+ * The basic event object for a DataConverter instance.
+ * Valid types are `parse`, `afterParse`, and `parseError`
+ */
+export interface Event extends DataEvent {
+    readonly type: ('export' | 'afterExport' | 'exportError' | 'parse' | 'afterParse' | 'parseError');
+    readonly columns: DataTableColumn[];
+    readonly error?: string | Error;
+    readonly headers: string[] | ColumnIdsOptions;
+}
+export interface DateFormatCallbackFunction {
+    (match: ReturnType<string['match']>): number;
+}
+export interface DateFormatObject {
+    alternative?: string;
+    parser: DateFormatCallbackFunction;
+    regex: RegExp;
+}
+/**
+ * The shared options for all DataConverter instances
+ */
+export interface Options {
+    dateFormat?: string;
+    decimalPoint?: string;
+    firstRowAsNames: boolean;
     /**
-     * Adds a converter class to the registry.
-     *
-     * @private
-     *
-     * @param {string} key
-     * Registry key of the converter class.
-     *
-     * @param {DataConverterTypes} DataConverterClass
-     * Connector class (aka class constructor) to register.
-     *
-     * @return {boolean}
-     * Returns true, if the registration was successful. False is returned, if
-     * their is already a converter registered with this key.
+     * A function to parse string representations of dates into JavaScript
+     * timestamps. If not set, the default implementation will be used.
      */
-    function registerType<T extends keyof DataConverterTypes>(key: T, DataConverterClass: DataConverterTypes[T]): boolean;
+    parseDate?: ParseDateFunction;
 }
+/**
+ * A function to parse string representations of dates
+ * into JavaScript timestamps.
+ */
+export interface ParseDateFunction {
+    (dateValue: string): number;
+}
+/**
+ * Contains supported types to convert values from and to.
+ */
+export type Type = (boolean | null | number | string | DataTable | Date | undefined);
+/**
+ * Options of the DataConverter.
+ */
+export type UserOptions = Partial<Options>;
 export default DataConverter;

package/es-modules/Data/Converters/DataConverter.js

@@ -18,8 +18,7 @@
  * */
 'use strict';
 import DataConverterUtils from './DataConverterUtils.js';
-import U from '../../Core/Utilities.js';
-const { addEvent, fireEvent, merge } = U;
+import { addEvent, fireEvent, merge } from '../../Shared/Utilities.js';
 /* *
  *
  *  Class
@@ -31,6 +30,26 @@ const { addEvent, fireEvent, merge } = U;
  * @private
  */
 class DataConverter {
+    /**
+     * Adds a converter class to the registry.
+     *
+     * @private
+     *
+     * @param {string} key
+     * Registry key of the converter class.
+     *
+     * @param {DataConverterTypes} DataConverterClass
+     * Connector class (aka class constructor) to register.
+     *
+     * @return {boolean}
+     * Returns true, if the registration was successful. False is returned, if
+     * their is already a converter registered with this key.
+     */
+    static registerType(key, DataConverterClass) {
+        return (!!key &&
+            !DataConverter.types[key] &&
+            !!(DataConverter.types[key] = DataConverterClass));
+    }
     /* *
      *
      *  Constructor
@@ -39,7 +58,7 @@ class DataConverter {
     /**
      * Constructs an instance of the DataConverter.
      *
-     * @param {DataConverter.UserOptions} [options]
+     * @param {UserOptions} [options]
      * Options for the DataConverter.
      */
     constructor(options) {
@@ -237,7 +256,7 @@ class DataConverter {
     /**
      * Emits an event on the DataConverter instance.
      *
-     * @param {DataConverter.Event} [e]
+     * @param {Event} [e]
      * Event object containing additional event data
      */
     emit(e) {
@@ -249,7 +268,7 @@ class DataConverter {
      * @param {string} type
      * Event type as a string.
      *
-     * @param {DataEventEmitter.Callback} callback
+     * @param {DataEventCallback} callback
      * Function to register for an modifier callback.
      *
      * @return {Function}
@@ -329,56 +348,10 @@ DataConverter.defaultOptions = {
     dateFormat: '',
     firstRowAsNames: true
 };
-/* *
- *
- *  Class Namespace
- *
- * */
 /**
- * Additionally provided types for events and conversion.
+ * Registry as a record object with converter names and their class.
  */
-(function (DataConverter) {
-    /* *
-     *
-     *  Declarations
-     *
-     * */
-    /* *
-     *
-     *  Constants
-     *
-     * */
-    /**
-     * Registry as a record object with connector names and their class.
-     */
-    DataConverter.types = {};
-    /* *
-     *
-     *  Functions
-     *
-     * */
-    /**
-     * Adds a converter class to the registry.
-     *
-     * @private
-     *
-     * @param {string} key
-     * Registry key of the converter class.
-     *
-     * @param {DataConverterTypes} DataConverterClass
-     * Connector class (aka class constructor) to register.
-     *
-     * @return {boolean}
-     * Returns true, if the registration was successful. False is returned, if
-     * their is already a converter registered with this key.
-     */
-    function registerType(key, DataConverterClass) {
-        return (!!key &&
-            !DataConverter.types[key] &&
-            !!(DataConverter.types[key] = DataConverterClass));
-    }
-    DataConverter.registerType = registerType;
-})(DataConverter || (DataConverter = {}));
+DataConverter.types = {};
 /* *
  *
  *  Default Export

package/es-modules/Data/Converters/DataConverterUtils.d.ts

@@ -1,82 +1,89 @@
-import DataConverter from './DataConverter';
-import DataTable from '../DataTable.js';
-declare namespace DataConverterUtils {
-    /**
-     * Converts a value to a Date.
-     *
-     * @param {DataConverter.Type} value
-     * Value to convert.
-     *
-     * @return {globalThis.Date}
-     * Converted value as a Date.
-     */
-    function asDate(value: DataConverter.Type, converter: DataConverter): Date;
-    /**
-     * Converts a value to a number.
-     *
-     * @param {DataConverter.Type} value
-     * Value to convert.
-     *
-     * @return {number}
-     * Converted value as a number.
-     */
-    function asNumber(value: DataConverter.Type, decimalRegExp?: RegExp): number;
-    /**
-     * Converts a value to a string.
-     *
-     * @param {DataConverter.Type} value
-     * Value to convert.
-     *
-     * @return {string}
-     * Converted value as a string.
-     */
-    function asString(value: DataConverter.Type): string;
-    /**
-     * Converts a value to a boolean.
-     *
-     * @param {DataConverter.Type} value
-     * Value to convert.
-     *
-     * @return {boolean}
-     * Converted value as a boolean.
-     */
-    function asBoolean(value: DataConverter.Type): boolean;
-    /**
-     * Guesses the potential type of a string value for parsing CSV etc.
-     *
-     * @param {*} value
-     * The value to examine.
-     *
-     * @return {'number' | 'string' | 'Date'}
-     * Type string, either `string`, `Date`, or `number`.
-     */
-    function guessType(value: unknown, converter: DataConverter): 'number' | 'string' | 'Date';
-    /**
-     * Trim a string from whitespaces.
-     *
-     * @param {string} str
-     * String to trim.
-     *
-     * @param {boolean} [inside=false]
-     * Remove all spaces between numbers.
-     *
-     * @return {string}
-     * Trimed string
-     */
-    function trim(str: string, inside?: boolean): string;
-    /**
-     * Parses an array of columns to a column collection. If more headers are
-     * provided, the corresponding, empty columns are added.
-     *
-     * @param {DataTable.Column[]} [columnsArray]
-     * Array of columns.
-     *
-     * @param {string[]} [headers]
-     * Column ids to use.
-     *
-     * @return {DataTable.ColumnCollection}
-     * Parsed columns.
-     */
-    function getColumnsCollection(columnsArray: DataTable.Column[] | undefined, headers: string[]): DataTable.ColumnCollection;
-}
+import DataConverter, { type Type as DataConverterType } from './DataConverter';
+import type { Column as DataTableColumn, ColumnCollection as DataTableColumnCollection } from '../DataTable';
+/**
+ * Converts a value to a Date.
+ *
+ * @param {DataConverterType} value
+ * Value to convert.
+ *
+ * @return {globalThis.Date}
+ * Converted value as a Date.
+ */
+export declare function asDate(value: DataConverterType, converter: DataConverter): Date;
+/**
+ * Converts a value to a number.
+ *
+ * @param {DataConverterType} value
+ * Value to convert.
+ *
+ * @return {number}
+ * Converted value as a number.
+ */
+export declare function asNumber(value: DataConverterType, decimalRegExp?: RegExp): number;
+/**
+ * Converts a value to a string.
+ *
+ * @param {DataConverterType} value
+ * Value to convert.
+ *
+ * @return {string}
+ * Converted value as a string.
+ */
+export declare function asString(value: DataConverterType): string;
+/**
+ * Converts a value to a boolean.
+ *
+ * @param {DataConverterType} value
+ * Value to convert.
+ *
+ * @return {boolean}
+ * Converted value as a boolean.
+ */
+export declare function asBoolean(value: DataConverterType): boolean;
+/**
+ * Guesses the potential type of a string value for parsing CSV etc.
+ *
+ * @param {*} value
+ * The value to examine.
+ *
+ * @return {'number' | 'string' | 'Date'}
+ * Type string, either `string`, `Date`, or `number`.
+ */
+export declare function guessType(value: unknown, converter: DataConverter): 'number' | 'string' | 'Date';
+/**
+ * Trim a string from whitespaces.
+ *
+ * @param {string} str
+ * String to trim.
+ *
+ * @param {boolean} [inside=false]
+ * Remove all spaces between numbers.
+ *
+ * @return {string}
+ * Trimed string
+ */
+export declare function trim(str: string, inside?: boolean): string;
+/**
+ * Parses an array of columns to a column collection. If more headers are
+ * provided, the corresponding, empty columns are added.
+ *
+ * @param {DataTableColumn[]} [columnsArray]
+ * Array of columns.
+ *
+ * @param {string[]} [headers]
+ * Column ids to use.
+ *
+ * @return {DataTableColumnCollection}
+ * Parsed columns.
+ */
+export declare function getColumnsCollection(columnsArray: DataTableColumn[] | undefined, headers: string[]): DataTableColumnCollection;
+declare const DataConverterUtils: {
+    asBoolean: typeof asBoolean;
+    asDate: typeof asDate;
+    asNumber: typeof asNumber;
+    asString: typeof asString;
+    getColumnsCollection: typeof getColumnsCollection;
+    guessType: typeof guessType;
+    trim: typeof trim;
+};
 export default DataConverterUtils;