@adaptabletools/adaptable-cjs 17.0.0-canary.1

package/src/AdaptableOptions/DashboardOptions.d.ts

@@ -0,0 +1,91 @@
+import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
+import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
+import { DashboardState } from '../PredefinedConfig/DashboardState';
+import { BaseContext, CustomRenderContext } from '../types';
+import { AdaptableFrameworkComponent } from './AdaptableFrameworkComponent';
+/**
+ * Options related to the Dashboard in Adaptable.
+ */
+export interface DashboardOptions {
+    /**
+     * Whether the Dashboard can be floated; if true (the default), double-clicking Dashboard puts it in float mode
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    canFloat?: boolean;
+    /**
+     * Shows Quick Search textbox in the Dashboard Header
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    showQuickSearchInHeader?: boolean;
+    /**
+     * Custom Adaptable Buttons to appear in Dashboard (alongside Module Buttons)
+     */
+    customDashboardButtons?: AdaptableButton<DashboardButtonContext>[];
+    /**
+     * Toolbars provided by Users which contain custom content
+     */
+    customToolbars?: CustomToolbar[];
+    /**
+     * Where in Dashboard to display Module and Custom Buttons
+     * @defaultValue 'right'
+     * @noCodeItem
+     */
+    buttonsLocation?: 'left' | 'right';
+}
+/**
+ * Custom Toolbar (which AdapTable will manage) enabling devs to populate Dashboard with bepoke content
+ */
+export interface CustomToolbar extends AdaptableObject {
+    /**
+     * How Toolbar is referenced (e.g. in Dashboard Popup when managing toolbars)
+     */
+    name: string;
+    /**
+     * Title to display in Toolbar; if unset or empty string, nothing will show
+     */
+    title?: string;
+    /**
+     * Shows a Configure (wrench) button which when clicked fires `CustomToolbarConfigured` event
+     */
+    showConfigureButton?: boolean;
+    /**
+     * Shows a Close button at the bottom of Custom Toolbar
+     */
+    showCloseButton?: boolean;
+    /**
+     * Optional set of buttons to show in the Toolbar
+     */
+    toolbarButtons?: AdaptableButton<CustomToolbarButtonContext>[];
+    /**
+     * Function to provide custom content when NOT using a Framework wrapper
+     */
+    render?: (customRenderContext: CustomRenderContext) => string | null;
+    /**
+     * The Framework-specific (Angular or React) component to be rendered
+     */
+    frameworkComponent?: AdaptableFrameworkComponent;
+}
+/**
+ * Context required by functions when using a Dashboard Button
+ */
+export interface DashboardButtonContext extends BaseContext {
+    /**
+     * Current Dashboard State
+     */
+    dashboardState: DashboardState;
+}
+/**
+ * Context required by functions when using a Custom Toolbar Button
+ */
+export interface CustomToolbarButtonContext extends DashboardButtonContext {
+    /**
+     * Custom Toolbar which hosts the Button
+     */
+    customToolbar: CustomToolbar;
+}

package/src/AdaptableOptions/DashboardOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts

@@ -0,0 +1,63 @@
+import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
+import { ActionColumnContext, AdaptableApi, AdaptableButton } from '../types';
+/**
+ * Options to manage the 'Data Change History Module', which provides an overview of all previous changes, giving the possibility to undo specific changes
+ */
+export interface DataChangeHistoryOptions<TData = any> {
+    /**
+     * Whether data change history should be active by default
+     *
+     * @defaultValue false
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    activeByDefault?: boolean;
+    /**
+     * Function specifying which data changes to include in Data Change History
+     *
+     * @defaultValue undefined (all data changes are logged)
+     * @gridInfoItem
+     */
+    showDataChange?: (cellDataChangedInfo: CellDataChangedInfo<TData>) => boolean;
+    /**
+     * Action button definition; can be used to implement undo functionality
+     *
+     * @defaultValue undefined
+     */
+    changeHistoryButton?: DataChangeHistoryButton<TData> | DataChangeHistoryButton<TData>[];
+}
+/**
+ * Built in `undo` or `clear` data change action
+ */
+export type AdaptableDataChangeHistoryAction = 'undo' | 'clear';
+/**
+ * The context for the DataChangeHistoryButton
+ */
+export interface DataChangeHistoryContext<TData = any> extends ActionColumnContext {
+    /**
+     * Helper function to undo the change.
+     */
+    undoDataChange: () => void;
+    /**
+     * Helper function to row from Grid
+     */
+    clearRow: () => void;
+    /**
+     * If the change references a group node.
+     */
+    isGroupNode: boolean;
+    /**
+     * The initial data change
+     */
+    dataChangedInfo: CellDataChangedInfo<TData>;
+    /**
+     * AdapTable API of underlying Grid (not from Data History Monitor)
+     */
+    parentAdapTableApi: AdaptableApi;
+}
+/**
+ * A custom AdaptableButton which provides a build in `undo` action
+ */
+export interface DataChangeHistoryButton<TData = any> extends AdaptableButton<DataChangeHistoryContext<TData>> {
+    action?: AdaptableDataChangeHistoryAction;
+}

package/src/AdaptableOptions/DataChangeHistoryOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/AdaptableOptions/DataImportOptions.d.ts

@@ -0,0 +1,114 @@
+import { BaseContext } from '../types';
+import { IRowNode } from '@ag-grid-community/core';
+/**
+ * Options for managing the Data Import function
+ */
+export interface DataImportOptions<T = Record<string, any>> {
+    /**
+     * File extensions that the Data Import function accepts
+     */
+    fileHandlers?: DataImportFileHandler<T>[];
+    /**
+     * Handles Importing Data using text
+     */
+    textHandler?: (text: string) => T[] | Promise<T[]>;
+    /**
+     * Function to validate the Imported Data
+     */
+    validate?: (context: DataImportValidateContext<T>) => DataImportValidationError[] | undefined;
+    /**
+     * Function to handle the Imported Data and apply it to the Grid. If not provided then the Data will be applied to the Grid automatically.
+     */
+    handleImportedData?: (context: HandleImportedDataContext<T>) => Promise<void | HandleImportedDataResolution>;
+    /**
+     * Function to pre-process the data before it is imported
+     *
+     * @experimental It might change in a future version
+     */
+    _preprocessRowData?: (context: PreprocessRowDataContext<T>) => Record<string, any>;
+    /**
+     * Function to get the Primary Key value for a data row (defaults to value of the primaryKey column)
+     *
+     * @experimental It might change in a future version
+     */
+    _getPrimaryKeyValue?: (context: GetPrimaryKeyValueContext<T>) => string | number;
+}
+/**
+ * Context used when pre-processing Import Data
+ */
+export interface PreprocessRowDataContext<T = Record<string, any>> extends BaseContext {
+    /**
+     * Data which has been imported
+     */
+    rowData: T;
+}
+/**
+ * Context used when importing Data
+ */
+export interface HandleImportedDataContext<T = Record<string, any>> extends BaseContext {
+    /**
+     * Data which has been imported
+     */
+    data: T[];
+}
+/**
+ * Files that can be handled by Data Import
+ */
+export interface DataImportFileHandler<T = Record<string, any>> {
+    /**
+     * Name of File Extension
+     */
+    fileExtension?: string;
+    /**
+     * Function which handles the File
+     */
+    handleFile: (file: File) => Promise<T[]>;
+}
+/**
+ * Defines a Validation Error
+ */
+export interface DataImportValidationError {
+    /**
+     * Column which contains the Error
+     */
+    columnId: string;
+    /**
+     * The validatoin error text
+     */
+    error: string;
+}
+/**
+ * Context passed to the `validate` function
+ */
+export interface DataImportValidateContext<T = Record<string, any>> extends BaseContext {
+    /**
+     * Imported Row Data
+     */
+    rowData: T;
+}
+/**
+ * Context passed to the `getPrimaryKeyValue` function
+ */
+export interface GetPrimaryKeyValueContext<T = Record<string, any>> extends BaseContext {
+    /**
+     * Data being imported
+     */
+    rowData: T;
+}
+/**
+ * Resolution returned by the `handleImportedData` function
+ */
+export interface HandleImportedDataResolution {
+    /**
+     * Whether to emit the `DataImported` event
+     */
+    emitDataImportedEvent: boolean;
+    /**
+     * Rows that were added
+     */
+    addedRows: IRowNode[];
+    /**
+     * Rows that were updated
+     */
+    updatedRows: IRowNode[];
+}

package/src/AdaptableOptions/DataImportOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/AdaptableOptions/DataSetOptions.d.ts

@@ -0,0 +1,41 @@
+import { AdaptableForm, AdaptableObject } from '../../types';
+import { FormContext } from '../PredefinedConfig/Common/FormContext';
+/**
+ * Options to provide Data Sets
+ */
+export interface DataSetOptions<TData = any> {
+    /**
+     * Collection of Data Sets to provide Data to AdapTable
+     */
+    dataSets?: DataSet[];
+}
+/**
+ * Defines a Data Set object that can provide data to AdapTable
+ */
+export interface DataSet extends AdaptableObject {
+    /**
+     * Name of Data Set
+     */
+    name: string;
+    /**
+     * Describes the Data Set
+     */
+    description: string;
+    /**
+     * Params for Data Set popup form
+     */
+    form?: AdaptableForm<DataSetFormContext>;
+    /**
+     * Additional info for Data Set
+     */
+    info?: Record<string, string | number | boolean | Date>;
+}
+/**
+ * Used when a DataSet displays a Form
+ */
+export interface DataSetFormContext extends FormContext {
+    /**
+     * The DataSet which triggered the Form
+     */
+    dataSet: DataSet;
+}

package/src/AdaptableOptions/DataSetOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/AdaptableOptions/DateInputOptions.d.ts

@@ -0,0 +1,82 @@
+/**
+ *  Options for managing and customizing the date inputs.
+ */
+export interface DateInputOptions {
+    /**
+     * Use browser specific date input instead of AdapTable's Date Picker
+     *
+     * @defaultValue false
+     */
+    useNativeInput?: boolean;
+    /**
+     * Format string for formatting date input field
+     *
+     * @defaultValue 'yyyy-MM-dd'
+     */
+    dateFormat?: string;
+    /**
+     * Locale object (to localize Date Picker)
+     *
+     * @defaultValue `en-US`
+     */
+    locale?: any;
+    /**
+     * Display the week numbers column
+     *
+     * @defaultValue false
+     */
+    showWeekNumber?: boolean;
+    /**
+     * Display outside days (i.e. those falling in next or previous month)
+     *
+     * @defaultValue true
+     */
+    showOutsideDays?: boolean;
+    /**
+     * List of buttons which are displayed in the datepicker overlay in the given order (provide empty array to display no buttons); custom button layout and positioning is achievable with the special elements `-` and `|`
+     *
+     * @defaultValue ['close','today']
+     * @see DatepickerButton
+     */
+    datepickerButtons?: DatepickerButton[];
+}
+/**
+ * Datepicker buttons which are displayed in the overlay footer
+ */
+export type DatepickerButton = 
+/**
+ * Clears the datepicker value
+ */
+'clear'
+/**
+ * Closes the datepicker overlay
+ */
+ | 'close'
+/**
+ * Selects the current date
+ */
+ | 'today'
+/**
+ * Selects the tomorrow's date
+ */
+ | 'tomorrow'
+/**
+ * Selects the yesterday's date
+ */
+ | 'yesterday'
+/**
+ * Selects the next working date (monday -> friday)
+ */
+ | 'nextWorkday'
+/**
+ * Selects the previous working date (monday -> friday)
+ */
+ | 'prevWorkday'
+/**
+ * Inserts a line break, 'forcing' the following buttons in the next line
+ */
+ | '|'
+/**
+ * Defines the positioning of the buttons in a line by 'pushing' the left and right hand side buttons to the line extremities
+ */
+ | '-';

package/src/AdaptableOptions/DateInputOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/AdaptableOptions/EditOptions.d.ts

@@ -0,0 +1,100 @@
+import { AdaptableMessageType, BaseContext } from '../../types';
+import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
+import { MathOperation } from '../PredefinedConfig/Common/Enums';
+import { GridCell } from '../PredefinedConfig/Selection/GridCell';
+/**
+ * Options related to Editing in AdapTable - includes Server Validation, Smart Edit Operations and Row Forms
+ */
+export interface EditOptions<TData = any> {
+    /**
+     * Function to validate AdapTable data edits on Server
+     */
+    validateOnServer?: (serverValidationContext: ServerValidationContext<TData>) => Promise<ValidationResult>;
+    /**
+     * Whether to display message after Server Validation runs
+     *
+     * @defaultValue true
+     * @gridInfoItem
+     */
+    displayServerValidationMessages?: boolean;
+    /**
+     * Function which checks if a given Grid Cell is editable
+     */
+    isCellEditable?: (cellEditableContext: CellEditableContext<TData>) => boolean;
+    /**
+     * Custom Operations to use in Smart Edit
+     */
+    smartEditCustomOperations?: SmartEditCustomOperation<TData>[];
+}
+/**
+ * Used for Server Validation ie. after an edit in AG Grid which must be checked on Server
+ */
+export interface ValidationResult {
+    /**
+     * Header to diplay with validation
+     * @defaultValue 'Server Validation Message',
+     */
+    ValidationHeader?: string;
+    /**
+     * Message to diplay with validation
+     */
+    ValidationMessage?: string;
+    /**
+     * Cell Value to use for after Server Validation
+     */
+    NewValue?: any;
+    /**
+     * Type of Message to Display
+     * @defaultValue Info
+     *
+     */
+    MessageType?: AdaptableMessageType;
+}
+/**
+ * Custom Operation used in Smart Edit Module
+ */
+export type SmartEditCustomOperation<TData = any> = {
+    /**
+     * Name of the Custom Operation (as appears in AdapTable UI)
+     */
+    name: string;
+    /**
+     * Custom Operation function - returns a number
+     */
+    operation: (context: SmartEditOperationContext<TData>) => number;
+};
+/**
+ * Operation used by Smart Edit - either System or Custom
+ */
+export type SmartEditOperation = SmartEditCustomOperation | MathOperation;
+/**
+ * Context used in Custom Smart Edit Operations
+ */
+export interface SmartEditOperationContext<TData = any> extends BaseContext {
+    /**
+     * Smart Edit value
+     */
+    smartEditValue: number;
+    /**
+     * Current selected grid cell - contains column, row and cell value information
+     */
+    currentCell: GridCell<TData>;
+}
+/**
+ * Context used when validating data edits on Server
+ */
+export interface ServerValidationContext<TData = any> extends BaseContext {
+    /**
+     * Details of Cell Edit
+     */
+    cellDataChangedInfo: CellDataChangedInfo<TData>;
+}
+/**
+ * Context used when checking Cell editability
+ */
+export interface CellEditableContext<TData = any> extends BaseContext {
+    /**
+     * Cell being edited
+     */
+    gridCell: GridCell<TData>;
+}

package/src/AdaptableOptions/EditOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/AdaptableOptions/EntitlementOptions.d.ts

@@ -0,0 +1,39 @@
+import { AdaptableModule } from '../PredefinedConfig/Common/Types';
+import { AccessLevel, Entitlement } from '../PredefinedConfig/Common/Entitlement';
+import { BaseContext } from '../types';
+/**
+ * Options for managing Entitlements in AdapTable, ie. which Modules are available to the User and whether as *Full*, *ReadOnly* or *Hidden*.
+ */
+export interface EntitlementOptions {
+    /**
+     * Returns either collection of `Entitlements`, or a function to invoke when an Entitlement is required
+     *
+     * @gridInfoItem
+     */
+    moduleEntitlements?: Entitlement[] | ((entitlementContext: EntitlementContext) => AccessLevel | undefined);
+    /**
+     * AccessLevel to use when an Entitlement is not explicitly set; can be hardcoded value or a function to invoke
+     *
+     * @defaultValue 'Full'
+     * @gridInfoItem
+     */
+    defaultAccessLevel?: AccessLevel | ((defaultAccessLevelContext: DefaultAccessLevelContext) => AccessLevel);
+}
+/**
+ * Provided to moduleEntitlements function when setting Entitlements programatically
+ */
+export interface EntitlementContext extends BaseContext {
+    /**
+     * Module being entitled
+     */
+    adaptableModule: AdaptableModule;
+    /**
+     * The default Access Level for the current instance
+     */
+    defaultAccessLevel: AccessLevel;
+}
+/**
+ * Provided to defaultAccessLevel function when setting Default Entitlement value programatically
+ */
+export interface DefaultAccessLevelContext extends BaseContext {
+}

package/src/AdaptableOptions/EntitlementOptions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });