@adaptabletools/adaptable 15.4.2 → 16.0.0-canary.0

package/src/AdaptableOptions/AdaptableQLOptions.d.ts

@@ -1,4 +1,4 @@
-import { AdaptablePredicate, AdaptablePredicateDef } from '../PredefinedConfig/Common/AdaptablePredicate';
+import { AdaptablePredicate } from '../PredefinedConfig/Common/AdaptablePredicate';
 import { AdaptableQLModule } from '../PredefinedConfig/Common/Types';
 import { BaseContext } from '../PredefinedConfig/Common/BaseContext';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
@@ -30,17 +30,6 @@ export interface AdaptableQLOptions<TData = any> {
      * Options for managing Predicates in AdapTableQL
      */
     predicateOptions?: PredicateOptions;
-    /**
-     * Definitions for Custom provided Predicates
-     */
-    customPredicateDefs?: AdaptablePredicateDef[];
-    /**
-     * Reference a Column's Header (i.e. FriendlyName) in all Expression overviews (instead of ColumnId)
-     *
-     * @defaultValue true
-     * @noCodeItem
-     */
-    displayColumnFriendlyNamesForExpressions?: boolean;
 }
 /**
  * Context passed when evaluating `AdaptableQLOptions.evaluateExpressionExternally()`

package/src/AdaptableOptions/AlertOptions.d.ts

@@ -58,6 +58,15 @@ export interface AlertOptions<TData = any> {
      * Function providing Message to display in Alert; if empty, AdapTable provides dynamically
      */
     alertMessageText?: (alertMessageContext: AlertMessageContext<TData>) => string | undefined;
+    /**
+   * Shows Alert if Primary Key column in Adaptable Options is not present or incorrect
+   *
+   * @defaultValue false
+   * @gridInfoItem
+   * @noCodeItem
+   * @uiLabel Show Missing Primary Key Warning
+   */
+    showMissingPrimaryKeyAlert?: boolean;
 }
 /**
  * Handles a Form Button Action

package/src/AdaptableOptions/CalendarOptions.d.ts

@@ -0,0 +1,11 @@
+import { BaseContext } from '../../types';
+/**
+ * Options for managing Holidays and Working Days in AdapTable
+ */
+export interface CalendarOptions<TData = any> {
+    /**
+     * Holidays - used to determine Working Days
+     * @defaultValue null
+     */
+    holidays?: string[] | ((baseContext: BaseContext) => string[] | undefined);
+}

package/src/AdaptableOptions/CellSummaryOptions.d.ts

@@ -0,0 +1,10 @@
+import { CellSummaryOperation } from '../PredefinedConfig/Common/CellSummary';
+/**
+ * Options to provide custom Cell Summaries
+ */
+export interface CellSummaryOptions<TData = any> {
+    /**
+     * Custom Cell Summary Operations to add to shipped set
+     */
+    cellSummaryOperations?: CellSummaryOperation<TData>[];
+}

package/src/AdaptableOptions/ColumnOptions.d.ts

@@ -30,10 +30,6 @@ export interface ColumnOptions {
      * @noCodeItem
      */
     autoOrderGroupedColumns?: boolean;
-    /**
-     * @deprecated - this is now AG Grid behaviour
-     */
-    hideColumnWhenGrouped?: boolean;
 }
 /**
  * Context used when setting a Column Friendly Name

package/src/AdaptableOptions/CustomSortOptions.d.ts

@@ -0,0 +1,24 @@
+import { AdaptableScope } from '../../types';
+import { AdaptableComparerFunction } from '../PredefinedConfig/Common/AdaptableComparerFunction';
+/**
+ * Options for providing Custom Sorts comparers
+ */
+export interface CustomSortOptions<TData = any> {
+    /**
+     * CustomSort column comparer functions
+     */
+    customSortComparers?: ColumnValuesComparer<TData>[];
+}
+/**
+ * Comparer object for Column Values - used for custom sorting
+ */
+export interface ColumnValuesComparer<TData = any> {
+    /**
+     * Column for which to compare values
+     */
+    scope: AdaptableScope;
+    /**
+     * Comparer function to use
+     */
+    comparer: AdaptableComparerFunction<TData>;
+}

package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts

@@ -1,5 +1,5 @@
 import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
-import { ActionColumnContext, AdaptableButton } from '../types';
+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
  */
@@ -46,6 +46,10 @@ export interface DataChangeHistoryContext<TData = any> extends ActionColumnConte
      * 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

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/EditOptions.d.ts

@@ -81,8 +81,8 @@ export interface SmartEditOperationContext<TData = any> extends BaseContext {
     currentCell: GridCell<TData>;
 }
 /**
-* Context used when validating data edits on Server
-*/
+ * Context used when validating data edits on Server
+ */
 export interface ServerValidationContext<TData = any> extends BaseContext {
     /**
      * Details of Cell Edit
@@ -90,8 +90,8 @@ export interface ServerValidationContext<TData = any> extends BaseContext {
     cellDataChangedInfo: CellDataChangedInfo<TData>;
 }
 /**
-* Context used when checking Cell editability
-*/
+ * Context used when checking Cell editability
+ */
 export interface CellEditableContext<TData = any> extends BaseContext {
     /**
      * Cell being edited

package/src/AdaptableOptions/EntitlementOptions.d.ts

@@ -27,14 +27,6 @@ export interface EntitlementContext extends BaseContext {
      * Module being entitled
      */
     adaptableModule: AdaptableModule;
-    /**
-     * Name of Current User
-     */
-    userName: string;
-    /**
-     * Id of current AdapTable instance
-     */
-    adaptableId: string;
     /**
      * The default Access Level for the current instance
      */
@@ -44,12 +36,4 @@ export interface EntitlementContext extends BaseContext {
  * Provided to defaultAccessLevel function when setting Default Entitlement value programatically
  */
 export interface DefaultAccessLevelContext extends BaseContext {
-    /**
-     * Name of Current User
-     */
-    userName: string;
-    /**
-     * Id of current AdapTable instance
-     */
-    adaptableId: string;
 }

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -29,10 +29,8 @@ export interface ExportOptions {
     customDestinations?: CustomDestination[];
     /**
      * Reports generated entirely by users (and not AdapTable)
-     *
-     * @deprecated It will be renamed to `externalReports` in version 16
      */
-    serverReports?: ServerReport[];
+    externalReports?: ExternalReport[];
     /**
      * System Reports to use; leave blank for all, empty array for none
      *
@@ -112,7 +110,7 @@ export declare type DataFormatType = 'rawValue' | 'formattedValue';
 /**
  * Defines a Report where all the data is provided entirely by the user
  */
-export interface ServerReport {
+export interface ExternalReport {
     /**
      * Name of the Report
      */

package/src/AdaptableOptions/ExpressionOptions.d.ts

@@ -87,6 +87,13 @@ export interface ExpressionOptions {
      * Custom query variables allow values to be attached to variables so that a single value can easily be expressed multiple times within a query, or quickly changed to affect the results of a query. Variables are evaluated synchronously with each expression evaluation.
      */
     customQueryVariables?: Record<string, string | number | boolean | Date | ((context: CustomQueryVariableContext) => string | number | boolean | Date)>;
+    /**
+   * Reference a Column's Header (i.e. FriendlyName) in all Expression overviews (instead of ColumnId)
+   *
+   * @defaultValue true
+   * @noCodeItem
+   */
+    displayColumnFriendlyNamesForExpressions?: boolean;
 }
 /**
  * Module specific Expression Functions

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -200,6 +200,9 @@ export interface FilterOptions<TData = any> {
      */
     quickFilterValuesWidth?: 'auto' | number;
 }
+/**
+ * Context provided when Filtering
+ */
 export interface FilterContext<TData = any> extends BaseContext {
     /**
      * Column being filtered

package/src/AdaptableOptions/FinancePluginOptions.d.ts

@@ -214,6 +214,9 @@ export interface OrganizationColumn extends FDC3Column {
      */
     intents?: OrganizationIntents;
 }
+/**
+ * All available Organization Intents
+ */
 export declare type OrganizationIntents = OrganizationIntent[];
 /**
  * FDC3 Intents available to an Organization Column
@@ -274,12 +277,33 @@ export interface RaiseFDC3IntentContext extends ContextMenuContext {
      */
     intent: FDC3Intent | CustomFDC3Intent;
 }
+/**
+ * Function that handles FDC3 Context
+ */
 export declare type FDC3ContextHandler = (context: FDC3Context) => void;
+/**
+ * Defines a Desktop Agent which supports FDC3
+ */
 export interface FDC3DesktopAgent {
+    /**
+     * Raises an Intent
+     */
     raiseIntent: (intent: FDC3Intent, context: FDC3Context) => void;
+    /**
+     * Broadcasts an FDC3 Message
+     */
     broadcast: (context: FDC3Context) => void;
+    /**
+     * Raises an FDC3 Intent for a given Context
+     */
     raiseIntentForContext: (context: FDC3Context) => void;
+    /**
+     * Adds an FDC3 Intent Listener
+     */
     addIntentListener: (intent: FDC3Intent | CustomFDC3Intent, listener: (context: FDC3Context) => void) => void;
+    /**
+    * Adds an FDC3 Context Listener
+    */
     addContextListener: (contextType: string | null, handler: FDC3ContextHandler) => {
         unsubscribe: () => void;
     };

package/src/AdaptableOptions/GroupingOptions.d.ts

@@ -0,0 +1,50 @@
+import { AdaptableColumn, BaseContext } from '../../types';
+import { KeyCreatorParams } from '@ag-grid-community/core';
+/**
+ * Options for managing Row and Column Groups in AdapTable
+ */
+export interface GroupingOptions<TData = any> {
+    /**
+    * Show aggregated totals row at top of Grid when row grouping
+    *
+    * @defaultValue false
+    * @gridInfoItem
+    */
+    showGroupingTotalsAsHeader?: boolean;
+    /**
+    * Value to use for 'Unbalanced Groups' (string columns)
+    */
+    unbalancedGroupsKey?: string | ((context: UnbalancedGroupsKeyContext<TData>) => string);
+    /**
+     * Places ungrouped columns at pre-grouping indexed position
+     * @defaultValue false
+     * @noCodeItem
+     */
+    restoreUngroupedColumns?: boolean;
+}
+/**
+ * Context used when setting a value for Unbalanced Row Groups
+ */
+export interface UnbalancedGroupsKeyContext<TData = any> extends BaseContext {
+    /**
+     * Adaptable Column being grouped
+     */
+    adaptableColumn: AdaptableColumn<TData>;
+    /**
+     * AG Grid's Key Creator Params
+     */
+    params: KeyCreatorParams<TData>;
+}
+/**
+ * Context used when setting a value for Unbalanced Row Groups
+ */
+export interface UnbalancedGroupsKeyContext<TData = any> extends BaseContext {
+    /**
+     * Adaptable Column being grouped
+     */
+    adaptableColumn: AdaptableColumn<TData>;
+    /**
+     * AG Grid's Key Creator Params
+     */
+    params: KeyCreatorParams<TData>;
+}

package/src/AdaptableOptions/GroupingOptions.js

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

package/src/AdaptableOptions/LayoutOptions.d.ts

@@ -65,6 +65,9 @@ export interface LayoutOptions {
      */
     pivotPreviewColumns?: string[] | ((context: PivotPreviewColumnsContext) => string[]);
 }
+/**
+ * Options for managing Tags in Layouts (used to enhance Layouts)
+ */
 export interface LayoutTagOptions {
     /**
      * Automatically generate an AdaptableObjectTag for each Layout

package/src/AdaptableOptions/MasterDetailPluginOptions.d.ts

@@ -17,7 +17,16 @@ export interface MasterDetailPluginOptions {
  * Context passed to Detail Grids when using Master Detail Plugin
  */
 export interface DetailInitContext extends BaseContext {
+    /**
+     * Row Node in the Master Grid that was opened
+     */
     rowNode: IRowNode;
+    /**
+     * The data in the Master Grid Row that was opened
+     */
     data: IRowNode['data'];
+    /**
+     * Primary Key Value of Master Grid Row that was opened
+     */
     primaryKeyValue: unknown;
 }

package/src/AdaptableOptions/PredicateOptions.d.ts

@@ -3,6 +3,10 @@ import { AdaptablePredicateDef, AdaptableScope, BaseContext, PredicateModuleScop
  * Options for managing Adaptable Predicates using AdaptableQL
  */
 export interface PredicateOptions {
+    /**
+     * Definitions for Custom provided Predicates
+     */
+    customPredicateDefs?: AdaptablePredicateDef[];
     /**
      * Which System Filter Predicates are available
      */

package/src/AdaptableOptions/TeamSharingOptions.d.ts

@@ -61,12 +61,4 @@ export interface TeamSharingOptions {
  * Context provided to `TeamSharingOptions.loadSharedEntities()` callback
  */
 export interface SharedEntitiesContext extends BaseContext {
-    /**
-     * `AdaptableOptions.adaptableId`
-     */
-    adaptableId: string;
-    /**
-     * `AdaptableOptions.userName`
-     */
-    userName: string;
 }

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -58,6 +58,9 @@ export interface ToolPanelButtonContext extends BaseContext {
      */
     toolPanelState: ToolPanelState;
 }
+/**
+ * Context used for Custom Tool Panels containing Buttons
+ */
 export interface CustomToolPanelButtonContext extends ToolPanelButtonContext {
     /**
      *The Custom ToolPanel which contains the button

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -4,7 +4,7 @@ import { AdaptableScope } from '../PredefinedConfig/Common/AdaptableScope';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
 import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
-import { BaseContext, GridCell } from '../../types';
+import { AlternativeModuleName, BaseContext, GridCell } from '../../types';
 import { IRowNode } from '@ag-grid-community/core';
 /**
  * Options for managing the User Interface of AdapTable
@@ -23,6 +23,13 @@ export interface UserInterfaceOptions<TData = any> {
      * @defaultValue null
      */
     applicationIcon?: AdaptableIcon;
+    /**
+     * A map of custom icons that can be used in Adaptable objects (e.g. Badges).
+     */
+    customIcons?: {
+        name: string;
+        icon: AdaptableIcon;
+    }[];
     /**
      * Options for managing and customizing date inputs in AdapTable
      */
@@ -92,7 +99,29 @@ export interface UserInterfaceOptions<TData = any> {
      * Custom Formatters to use in the Format Column Module
      */
     customDisplayFormatters?: CustomDisplayFormatter[];
+    /**
+     * English variant to use in UI labels
+     *
+     * @defaultValue 'GB'
+     * @gridInfoItem
+     */
+    englishVariant?: 'GB' | 'US';
+    /**
+     * Hides confirmation dialog which displays whenever an AdaptableObject is deleted
+     * @defaultValue false
+     * @noCodeItem
+     */
+    disableDeleteConfirmation?: boolean;
+    /**
+     * Alternative names to use for Adaptable Modules in toolbars and menus
+     *
+     * @defaultValue null
+     */
+    alternativeModuleNames?: AlternativeModuleName[];
 }
+/**
+ * Base class for all Permitted Values related objects
+ */
 export interface BasePermittedValues {
     /**
      * Scope where Values will appear (Mandatory property)
@@ -185,11 +214,17 @@ export interface BulkUpdatePermittedValuesContext<TData = any> extends Permitted
      */
     gridCells: GridCell<TData>[];
 }
+/**
+ * Sets of Tabs avilable in Grid Info Settings Panel
+ */
 export declare type GridInfoSections = GridInfoSection[];
 /**
  * Tabs available in the Grid Info Settings Panel
  */
 export declare type GridInfoSection = 'GridSummary' | 'AdaptableOptions' | 'ColumnInfo' | 'AdaptableObjects';
+/**
+ * Context used when evaluating Object Tags
+ */
 export interface ObjectTagsContext extends BaseContext {
 }
 /**

package/src/Api/ActionColumnApi.d.ts

@@ -0,0 +1,10 @@
+import { ActionColumn } from '../../types';
+/**
+ * Functions for accessing Action Columns
+ */
+export interface ActionColumnApi {
+    /**
+     * Retrieves the Action Columns provided in Action Column Options
+     */
+    getActionColumns(): ActionColumn[];
+}

package/src/Api/ActionColumnApi.js

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

package/src/Api/{ActionApi.d.ts → ActionRowApi.d.ts}

@@ -1,14 +1,10 @@
-import { ActionColumn, ActionRowButtonType } from '../../types';
+import { ActionRowButtonType } from '../../types';
 /**
- * A large range of column-related functions in AdapTable
+ * Functions for accessing Action Rows
  */
-export interface ActionApi {
+export interface ActionRowApi {
     /**
-     * Retrieves the Action Columns provided in Action Options
-     */
-    getActionColumns(): ActionColumn[];
-    /**
-     * Retrieves the Action Row Buttons provided in Action Options
+     * Retrieves the Action Row Buttons provided in Action Row Options
      */
     getActionRowButtons(): ActionRowButtonType[];
     /**
@@ -25,11 +21,4 @@ export interface ActionApi {
      * @param primaryKey - Primary Key of the duplicated row
      */
     displayCloneActionRow(primaryKey?: any): void;
-    /**
-     * TO BE REMOVED
-     */
-    /**
-     * @deprecated use `getActionColumns()` instead
-     */
-    getAllActionColumn(): ActionColumn[];
 }

package/src/Api/ActionRowApi.js

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

package/src/Api/AdaptableApi.d.ts

@@ -26,10 +26,9 @@ import { UserInterfaceApi } from './UserInterfaceApi';
 import { GridApi } from './GridApi';
 import { ScheduleApi } from './ScheduleApi';
 import { QueryApi } from './QueryApi';
-import { QueryLanguageApi } from './QueryLanguageApi';
+import { ExpressionApi } from './ExpressionApi';
 import { TeamSharingApi } from './TeamSharingApi';
 import { ColumnApi } from './ColumnApi';
-import { ActionApi } from './ActionApi';
 import { ApplicationApi } from './ApplicationApi';
 import { ScopeApi } from './ScopeApi';
 import { PredicateApi } from './PredicateApi';
@@ -40,6 +39,8 @@ import { SettingsPanelApi } from './SettingsPanelApi';
 import { StatusBarApi } from './StatusBarApi';
 import { StyledColumnApi } from './StyledColumnApi';
 import { OptionsApi } from './OptionsApi';
+import { ActionColumnApi } from './ActionColumnApi';
+import { ActionRowApi } from './ActionRowApi';
 /**
  *
  * The `AdaptableApi` provides developers with run-time access to AdapTable.
@@ -48,9 +49,13 @@ import { OptionsApi } from './OptionsApi';
  */
 export interface AdaptableApi {
     /**
-     * Provides access to Action Rows and Columns
+     * Provides access to Action Columns
      */
-    actionApi: ActionApi;
+    actionColumnApi: ActionColumnApi;
+    /**
+   * Provides access to Action Rows
+   */
+    actionRowApi: ActionRowApi;
     /**
      * Provides access to the Alert Module
      */
@@ -160,9 +165,9 @@ export interface AdaptableApi {
      */
     queryApi: QueryApi;
     /**
-     * Manages AdapTableQL (Query Language)
+     * Manages AdapTableQL Expressions
      */
-    queryLanguageApi: QueryLanguageApi;
+    expressionApi: ExpressionApi;
     /**
      * Provides access to the Quick Search Module
      */