@adaptabletools/adaptable 12.1.0-canary.2 → 12.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "12.1.0-canary.2",
+  "version": "12.1.0",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1658522436956;
+declare const _default: 1658746260266;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1658522436956;
+exports.default = 1658746260266;

package/src/AdaptableOptions/SearchOptions.d.ts

@@ -24,7 +24,7 @@ export interface SearchOptions {
      */
     clearSearchesOnStartUp?: boolean;
     /**
-     * Runs a Query after Quick Search runs, filtering on quick search results
+     * Filters the quick search results so only matching rows are displayed
      *
      * @defaultValue false
      * @gridInfoItem

package/src/Api/ConfigApi.d.ts

@@ -16,8 +16,7 @@ import { AdaptablePersistentState, AdaptableState } from '../PredefinedConfig/Ad
 import { FreeTextColumnState } from '../PredefinedConfig/FreeTextColumnState';
 import { ToolPanelState } from '../PredefinedConfig/ToolPanelState';
 import { AdaptableStateKey, AdaptableModule } from '../PredefinedConfig/Common/Types';
-import { AdaptableSearchState, PredefinedConfig, ScheduleState } from '../types';
-import { AdaptableSortState } from './Events/SearchChanged';
+import { AdaptableSearchState, AdaptableSortState, PredefinedConfig, ScheduleState } from '../types';
 import { QueryState } from '../PredefinedConfig/QueryState';
 /**
  * Range of functions to access Predefined Config and Adaptable State

package/src/Api/EventApi.d.ts

@@ -17,23 +17,60 @@ import { TeamSharingEntityChangedInfo } from './Events/TeamSharingEntityChanged'
 import { ActionRowSubmittedInfo } from './Events/ActionRowSubmitted';
 import { DataSetSelectedInfo } from './Events/DataSetSelected';
 import { AdaptableStateReloadedInfo } from './Events/AdaptableStateReloaded';
+import { GridSortedInfo } from './Events/GridSorted';
+import { QueryRunInfo } from './Events/QueryRun';
+import { FilterAppliedInfo } from './Events/FilterApplied';
 /**
  * Responsible for publishing the many Events that AdapTable fires
  */
 export interface EventApi {
     /**
-     * Event fired whenever search criteria in AdapTable changes
-     * @param eventName SearchChanged
-     * @param callback SearchChangedInfo which includes full details of what triggered the change and the current state of all Search and Filter related functions.
-     * @returns the unsubscribe function
+     * @deprecated - use FilterApplied, QueryRun or GridSorted
      */
     on(eventName: 'SearchChanged', callback: (searchChangedInfo: SearchChangedInfo) => void): VoidFunction;
     /**
-     * Unsubscribe from SearchChanged
-     * @param eventName SearchChanged
-     * @param callback
+     *@deprecated - use FilterApplied, QueryRun or GridSorted
      */
     off(eventName: 'SearchChanged', callback: (searchChangedInfo: SearchChangedInfo) => void): void;
+    /**
+     * Event fired whenever AdapTable is Sorted
+     * @param eventName GridSorted
+     * @param callback GridSortedInfo which contains current Column Sorts
+     * @returns the unsubscribe function
+     */
+    on(eventName: 'GridSorted', callback: (gridSortedInfo: GridSortedInfo) => void): VoidFunction;
+    /**
+     * Unsubscribe from GridSorted
+     * @param eventName GridSorted
+     * @param callback
+     */
+    off(eventName: 'GridSorted', callback: (gridSortedInfo: GridSortedInfo) => void): void;
+    /**
+     * Event fired whenever a Query is run in AdapTable
+     * @param eventName QueryRun
+     * @param callback QueryRun which provides details of the Query and the associated AST
+     * @returns the unsubscribe function
+     */
+    on(eventName: 'QueryRun', callback: (queryRunInfo: QueryRunInfo) => void): VoidFunction;
+    /**
+     * Unsubscribe from QueryRun
+     * @param eventName QueryRun
+     * @param callback
+     */
+    off(eventName: 'QueryRun', callback: (queryRunInfo: QueryRunInfo) => void): void;
+    /**
+     * Event fired whenever a Filter is Applied in AdapTable
+     * @param eventName FilterApplied
+     * @param callback FilterApplied which provides details of the Query and the associated AST
+     * @returns the unsubscribe function
+     */
+    on(eventName: 'FilterApplied', callback: (filterAppliedInfo: FilterAppliedInfo) => void): VoidFunction;
+    /**
+     * Unsubscribe from FilterApplied
+     * @param eventName FilterApplied
+     * @param callback
+     */
+    off(eventName: 'FilterApplied', callback: (filterAppliedInfo: FilterAppliedInfo) => void): void;
     /**
      * Event fired whenever a cell changes in the Grid
      * @param eventName CellChanged
@@ -264,6 +301,6 @@ export interface EventApi {
     emitSync(eventName: 'DashboardChanged', data?: any): any[];
     emitSync(eventName: 'FlashingCellDisplayed', data?: any): any[];
     emitSync(eventName: 'AdaptableDestroy'): any[];
-    emit(eventName: 'AdaptableReady' | 'AlertFired' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'DashboardChanged' | 'CellChanged' | 'GridDataChanged' | 'LayoutChanged' | 'LiveDataChanged' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'FDC3MessageSent' | 'ActionRowSubmitted' | 'DataSetSelected', data?: any): Promise<any>;
+    emit(eventName: 'ActionRowSubmitted' | 'AdaptableReady' | 'AlertFired' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataSetSelected' | 'FDC3MessageSent' | 'FilterApplied' | 'GridDataChanged' | 'GridSorted' | 'LayoutChanged' | 'LiveDataChanged' | 'QueryRun' | 'SearchChanged' | 'SelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged', data?: any): Promise<any>;
     destroy(): void;
 }

package/src/Api/Events/AdaptableSearchState.d.ts

@@ -0,0 +1,22 @@
+import { ColumnFilter, DataSet } from '../../types';
+/**
+ * Current Searches and Filter in AdapTable
+ */
+export interface AdaptableSearchState {
+    /**
+     * Current DataSet (if one selected)
+     */
+    dataSet: DataSet | undefined;
+    /**
+     * Current Query
+     */
+    currentQuery: string | undefined;
+    /**
+     * AST for Current Query
+     */
+    queryAST: any;
+    /**
+     * Currently applied Column Filters
+     */
+    columnFilters: ColumnFilter[] | undefined;
+}

package/src/Api/Events/AdaptableSearchState.js

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

package/src/Api/Events/FilterApplied.d.ts

@@ -0,0 +1,11 @@
+import { BaseEventInfo } from './BaseEventInfo';
+import { ColumnFilter } from '../../types';
+/**
+ * EventInfo returned by the  Filter Applied event
+ */
+export interface FilterAppliedInfo extends BaseEventInfo {
+    /**
+     * Currently applied Column Filters
+     */
+    columnFilters: ColumnFilter[] | undefined;
+}

package/src/Api/Events/FilterApplied.js

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

package/src/Api/Events/GridSorted.d.ts

@@ -0,0 +1,25 @@
+import { CustomSort } from '../../PredefinedConfig/CustomSortState';
+import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
+import { BaseEventInfo } from './BaseEventInfo';
+/**
+ * EventInfo returned by GridSorted event
+ */
+export interface GridSortedInfo extends BaseEventInfo {
+    /**
+     * Current sort state in the Grid
+     */
+    adaptableSortState: AdaptableSortState;
+}
+/**
+ * Overview of current sorting state in the grid
+ */
+export interface AdaptableSortState {
+    /**
+     * Which columns have sorting applied and,if so, which direction
+     */
+    columnSorts: ColumnSort[];
+    /**
+     * All the Custom Sorts in State; this is always sent even if no custom sorts are active
+     */
+    customSorts: CustomSort[];
+}

package/src/Api/Events/GridSorted.js

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

package/src/Api/Events/QueryRun.d.ts

@@ -0,0 +1,14 @@
+import { BaseEventInfo } from './BaseEventInfo';
+/**
+ * EventInfo returned by the QueryRun event
+ */
+export interface QueryRunInfo extends BaseEventInfo {
+    /**
+     * Current Query
+     */
+    currentQuery: string | undefined;
+    /**
+     * AST for Current Query
+     */
+    queryAST: any;
+}

package/src/Api/Events/QueryRun.js

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

package/src/Api/Events/SearchChanged.d.ts

@@ -1,55 +1,11 @@
-import { CustomSort } from '../../PredefinedConfig/CustomSortState';
-import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
 import { BaseEventInfo } from './BaseEventInfo';
-import { ColumnFilter, DataSet } from '../../types';
+import { AdaptableSortState } from '../../types';
+import { AdaptableSearchState } from './AdaptableSearchState';
 /**
- * EventInfo returned by SearchChanged event; includes full AdapTable search and sort info plus the event's trigger
+ * @deprecated Use QueryRun and or FilterApplied
  */
 export interface SearchChangedInfo extends BaseEventInfo {
-    /**
-     * How Search was changed: 'CurrentQuery', 'Filter', 'DataChange' or 'Sort'
-     */
     searchChangedTrigger: 'CurrentQuery' | 'Filter' | 'DataChange' | 'Sort';
-    /**
-     * Current searches and filters in the Grid
-     */
     adaptableSearchState: AdaptableSearchState;
-    /**
-     * Current sort state in the Grid
-     */
     adaptableSortState: AdaptableSortState;
 }
-/**
- * Current Searches and Filter in AdapTable
- */
-export interface AdaptableSearchState {
-    /**
-     * Current DataSet (if one selected)
-     */
-    dataSet: DataSet | undefined;
-    /**
-     * Current Query
-     */
-    currentQuery: string | undefined;
-    /**
-     * AST for Current Query
-     */
-    queryAST: any;
-    /**
-     * Currently applied Column Filters
-     */
-    columnFilters: ColumnFilter[] | undefined;
-}
-/**
- * Overview of current sorting state in the grid
- */
-export interface AdaptableSortState {
-    /**
-     * Which columns have sorting applied and,if so, which direction
-     */
-    columnSorts: ColumnSort[];
-    /**
-     * All the Custom Sorts in State; this is always sent even if no custom sorts are active
-     */
-    customSorts: CustomSort[];
-}

package/src/Api/FilterApi.d.ts

@@ -134,4 +134,8 @@ export interface FilterApi {
      * @param action Filtering Action
      */
     shouldNewColumnFilterTriggerGridFiltering(action: LayoutColumnFilterAction | Redux.Action): boolean;
+    /**
+     * Fires Filter Applied Event - typically used to enable filtering on the server
+     */
+    fireFilterAppliedEvent(): void;
 }

package/src/Api/GridApi.d.ts

@@ -333,8 +333,13 @@ export interface GridApi {
     redrawGrid(): void;
     /**
      * Fires Search Changed Event - typically used to enable server searching and filtering
+     * This is now deprecated and will be removed in AdapTable 13
      */
     fireSearchChangedEvent(searchChangedTrigger: 'CurrentQuery' | 'Filter' | 'DataChange' | 'Sort', searchAtDate?: Date): void;
+    /**
+     * Fires Grid Sorted Event
+     */
+    fireGridSortedEvent(): void;
     /**
      * Fires Cell Changed Changed Event - when any data in AG Grid's dataset has changed
      */

package/src/Api/Implementation/ConfigApiImpl.d.ts

@@ -18,8 +18,7 @@ import { FreeTextColumnState } from '../../PredefinedConfig/FreeTextColumnState'
 import { ToolPanelState } from '../../PredefinedConfig/ToolPanelState';
 import { ConfigApi } from '../ConfigApi';
 import { AdaptableStateKey, AdaptableModule } from '../../PredefinedConfig/Common/Types';
-import { AdaptableSearchState, ScheduleState } from '../../types';
-import { AdaptableSortState } from '../Events/SearchChanged';
+import { AdaptableSearchState, AdaptableSortState, ScheduleState } from '../../types';
 import { QueryState } from '../../PredefinedConfig/QueryState';
 import { PredefinedConfig } from '../../PredefinedConfig/PredefinedConfig';
 import { ChartingState } from '../../PredefinedConfig/ChartingState';

package/src/Api/Implementation/FilterApiImpl.d.ts

@@ -42,4 +42,5 @@ export declare class FilterApiImpl extends ApiBase implements FilterApi {
      */
     isFilterActive(filter: ColumnFilter): boolean;
     shouldNewColumnFilterTriggerGridFiltering(action: LayoutRedux.LayoutColumnFilterAction | Redux.Action): boolean;
+    fireFilterAppliedEvent(): void;
 }

package/src/Api/Implementation/FilterApiImpl.js

@@ -267,5 +267,14 @@ class FilterApiImpl extends ApiBase_1.ApiBase {
             isEditTrigger ||
             isSetAndActive);
     }
+    fireFilterAppliedEvent() {
+        if (this.adaptable.isInitialised) {
+            const filterAppliedInfo = {
+                columnFilters: this.getColumnFilters(),
+                adaptableApi: this.getAdaptableApi(),
+            };
+            this.adaptable.api.eventApi.emit('FilterApplied', filterAppliedInfo);
+        }
+    }
 }
 exports.FilterApiImpl = FilterApiImpl;

package/src/Api/Implementation/GridApiImpl.d.ts

@@ -85,6 +85,7 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     isQuickFilterAvailable(): boolean;
     redrawGrid(): void;
     fireSearchChangedEvent(searchChangedTrigger: 'CurrentQuery' | 'Filter' | 'DataChange' | 'Sort'): void;
+    fireGridSortedEvent(): void;
     fireCellChangedEvent(cellDataChangedInfo: CellDataChangedInfo): void;
     fireGridDataChangedEvent(dataRows: any[], rowNodes: RowNode[], rowTrigger: 'Add' | 'Edit' | 'Delete'): void;
     jumpToRow(primaryKeyValue: any): void;

package/src/Api/Implementation/GridApiImpl.js

@@ -272,6 +272,17 @@ class GridApiImpl extends ApiBase_1.ApiBase {
             this.adaptable.api.eventApi.emit('SearchChanged', searchChangedInfo);
         }
     }
+    fireGridSortedEvent() {
+        if (this.adaptable.isInitialised) {
+            const adaptableSortState = this.adaptable.api.configApi.getAdaptableSortState();
+            const adaptableApi = this.getAdaptableApi();
+            const gridSortedInfo = {
+                adaptableSortState: adaptableSortState,
+                adaptableApi: adaptableApi,
+            };
+            adaptableApi.eventApi.emit('GridSorted', gridSortedInfo);
+        }
+    }
     fireCellChangedEvent(cellDataChangedInfo) {
         if (this.adaptable.isInitialised) {
             const cellChangedInfo = {

package/src/Api/Implementation/QueryApiImpl.d.ts

@@ -17,4 +17,5 @@ export declare class QueryApiImpl extends ApiBase implements QueryApi {
     getReferencedNamedQueryNames(expression?: string): string[];
     getNamedQueryModuleReferences(namedQueryName: string): string[];
     expandCurrentQuery(query?: string): void;
+    fireQueryRunEvent(): void;
 }

package/src/Api/Implementation/QueryApiImpl.js

@@ -88,5 +88,19 @@ class QueryApiImpl extends ApiBase_1.ApiBase {
             },
         }));
     }
+    fireQueryRunEvent() {
+        if (this.adaptable.isInitialised) {
+            const currentQuery = this.adaptable.api.queryApi.getCurrentQuery();
+            const adaptableApi = this.getAdaptableApi();
+            const queryRunInfo = {
+                currentQuery,
+                queryAST: currentQuery
+                    ? adaptableApi.queryLanguageApi.getASTForExpression(currentQuery)
+                    : null,
+                adaptableApi: adaptableApi,
+            };
+            adaptableApi.eventApi.emit('QueryRun', queryRunInfo);
+        }
+    }
 }
 exports.QueryApiImpl = QueryApiImpl;

package/src/Api/QueryApi.d.ts

@@ -62,4 +62,8 @@ export interface QueryApi {
      * @param query - query to edit
      */
     expandCurrentQuery(query?: string): void;
+    /**
+     * Fires Query Run Event - typically used to enable querying on the server
+     */
+    fireQueryRunEvent(): void;
 }

package/src/Redux/Store/AdaptableStore.js

@@ -331,12 +331,14 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                 }
                 /**
                  * Use Case: Query has changed
-                 * Action: Filter the Grid and fire SearchChangedEvent
+                 * Action: Filter the Grid and fire Query Run Event
+                 * Also run SearchChangedEvent (to be removed in AdapTable 13)
                  */
                 case QueryRedux.QUERY_RUN: {
                     let ret = next(action);
                     setTimeout(() => adaptable.applyGridFiltering(), 5);
                     adaptable.api.gridApi.fireSearchChangedEvent('CurrentQuery');
+                    adaptable.api.queryApi.fireQueryRunEvent();
                     return ret;
                 }
                 /*******************
@@ -715,7 +717,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                 }
                 /**
                  * Use Case: Column Filters have changed
-                 * Action: Apply grid filtering and fire search changed event
+                 * Action: Apply grid filtering and fire associated events
                  */
                 case LayoutRedux.LAYOUT_COLUMN_FILTER_ADD:
                 case LayoutRedux.LAYOUT_COLUMN_FILTER_EDIT:
@@ -760,6 +762,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                         }
                     }, 5);
                     adaptable.api.gridApi.fireSearchChangedEvent('Filter');
+                    adaptable.api.filterApi.fireFilterAppliedEvent();
                     return returnAction;
                 }
                 /*******************
@@ -1387,11 +1390,13 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                 case GridRedux.GRID_SET_SORT: {
                     let ret = next(action);
                     adaptable.api.gridApi.fireSearchChangedEvent('Sort');
+                    adaptable.api.gridApi.fireGridSortedEvent();
                     return ret;
                 }
                 case GridRedux.GRID_CLEAR_SORT: {
                     let ret = next(action);
                     adaptable.api.gridApi.fireSearchChangedEvent('Sort');
+                    adaptable.api.gridApi.fireGridSortedEvent();
                     return ret;
                 }
                 /*******************

package/src/View/Query/QueryViewPanel.d.ts

@@ -23,7 +23,7 @@ declare class QueryViewPanelComponent extends React.Component<QueryViewPanelComp
     render(): JSX.Element;
     private clearQuery;
     saveQuery(): void;
-    onSelectedSearchChanged(searchName: string): void;
+    onSelectedQueryChanged(queryName: string): void;
     runQuery(expression?: string): void;
 }
 export declare let QueryViewPanelControl: import("react-redux").ConnectedComponent<typeof QueryViewPanelComponent, import("react-redux").Omit<React.ClassAttributes<QueryViewPanelComponent> & QueryViewPanelComponentProps, "api" | "accessLevel" | "CurrentQuery" | "CachedQueries" | "moduleInfo" | "NamedQueries" | "viewType" | "onAddCachedQuery" | "onRunQuery" | "onShowNamedQueries">>;

package/src/View/Query/QueryViewPanel.js

@@ -122,8 +122,8 @@ class QueryViewPanelComponent extends React.Component {
     saveQuery() {
         this.props.onShowNamedQueries(this.state.expression, this.props.moduleInfo.Popup);
     }
-    onSelectedSearchChanged(searchName) {
-        this.props.onRunQuery(searchName);
+    onSelectedQueryChanged(queryName) {
+        this.props.onRunQuery(queryName);
     }
     runQuery(expression = this.state.expression) {
         if (StringExtensions_1.default.IsNullOrEmpty(expression) &&

package/src/View/QuickSearch/QuickSearchPopup.js

@@ -40,7 +40,7 @@ const QuickSearchPopupComponent = (props) => {
             React.createElement(rebass_1.Flex, { flexDirection: "column" },
                 React.createElement(FormLayout_1.default, { columns: [1, 2] },
                     React.createElement(FormLayout_1.FormRow, null,
-                        React.createElement(CheckBox_1.CheckBox, { value: "existing", marginLeft: 1, marginRight: 3, checked: state.RunQueryAfterQuickSearch, disabled: StringExtensions_1.default.IsNotNullOrEmpty(searchText), onChange: onQuickSearchBehaviourChange }, "Run Simultaneous Query"))))),
+                        React.createElement(CheckBox_1.CheckBox, { value: "existing", marginLeft: 1, marginRight: 3, checked: state.RunQueryAfterQuickSearch, disabled: StringExtensions_1.default.IsNotNullOrEmpty(searchText), onChange: onQuickSearchBehaviourChange }, "Filter Quick Search Results"))))),
         React.createElement(StyleComponent_1.StyleComponent, { style: { height: '100%' }, api: props.api, Style: props.QuickSearchStyle, UpdateStyle: onUpdateStyle })));
 };
 function mapStateToProps(state, ownProps) {

package/src/metamodel/adaptable.metamodel.d.ts

@@ -2700,6 +2700,17 @@ export declare const ADAPTABLE_METAMODEL: {
             uiLabel: string;
         }[];
     };
+    FilterAppliedInfo: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+        }[];
+    };
     FilterOptions: {
         name: string;
         kind: string;
@@ -3239,6 +3250,18 @@ export declare const ADAPTABLE_METAMODEL: {
             reference: string;
         })[];
     };
+    GridSortedInfo: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference: string;
+        }[];
+    };
     IAdaptableNoCodeWizard: {
         name: string;
         kind: string;
@@ -3998,6 +4021,17 @@ export declare const ADAPTABLE_METAMODEL: {
             uiLabel: string;
         }[];
     };
+    QueryRunInfo: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+        }[];
+    };
     QueryState: {
         name: string;
         kind: string;
@@ -4209,19 +4243,6 @@ export declare const ADAPTABLE_METAMODEL: {
         name: string;
         kind: string;
         description: string;
-        properties: ({
-            name: string;
-            kind: string;
-            description: string;
-            uiLabel: string;
-            reference: string;
-        } | {
-            name: string;
-            kind: string;
-            description: string;
-            uiLabel: string;
-            reference?: undefined;
-        })[];
     };
     SearchOptions: {
         name: string;