@adaptabletools/adaptable 20.2.2 → 20.2.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "20.2.2",
+  "version": "20.2.3",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -346,10 +346,21 @@ export interface DataFormatDataType {
     date?: DataFormatType;
 }
 /**
- * Custom Export Parameters which extend AG Grid's base export parameters.
- * Use:
- * - `ExcelExportParams` for Excel format exports
- * - `CsvExportParams` for CSV, JSON and any custom format exports
- * These parameters allow overriding AdapTable's default export behavior.
+ * Custom Export Parameters which extend AG Grid's base export parameters, allowing overriding of AdapTable's default export behaviour.
+ * Use `ExcelExportParams` for Excel format exports and `CsvExportParams` for CSV, JSON and any custom format exports
  */
 export type CustomExportParams = ExcelExportParams | CsvExportParams;
+/**
+ * Config used when Exporting via API, allows fine grained exporting
+ */
+export interface ExportConfig {
+    /**
+     *
+     * Function to modify export params; receives default params & returns modified params
+     */
+    exportParams?: (defaultExportParams: CustomExportParams) => CustomExportParams;
+    /**
+     * Whether to show progress indicator
+     */
+    showProgressIndicator?: boolean;
+}

package/src/Api/ExportApi.d.ts

@@ -1,6 +1,6 @@
 import { AdaptableForm } from '../AdaptableState/Common/AdaptableForm';
 import { ExportState, Report, ReportFormatType, ReportNameType, SystemReportFormat, SystemReportName } from '../AdaptableState/ExportState';
-import { CustomDestination, CustomExportParams, ExportDestinationType, ExportFormContext, ExportResultData, SystemExportDestination } from '../AdaptableOptions/ExportOptions';
+import { CustomDestination, CustomExportParams, ExportConfig, ExportDestinationType, ExportFormContext, ExportResultData, SystemExportDestination } from '../AdaptableOptions/ExportOptions';
 import { AdaptableColumn } from '../types';
 /**
  * Provides run-time access to the Export Module and Report state
@@ -143,14 +143,9 @@ export interface ExportApi {
      * @param reportName - name of the report
      * @param format - format of the report
      * @param destination - destination to export to
-     * @param config - optional configuration
-     * @param config.exportParams - function to modify the default export parameters; it will be called with the default export parameters and should return the modified export parameters
-     * @param config.showProgressIndicator - whether to show progress indicator
-     */
-    exportReport(reportName: ReportNameType, format: ReportFormatType, destination?: ExportDestinationType, config?: {
-        exportParams?: (defaultExportParams: CustomExportParams) => CustomExportParams;
-        showProgressIndicator?: boolean;
-    }): Promise<void>;
+     * @param exportConfig - optional export configuration
+      */
+    exportReport(reportName: ReportNameType, format: ReportFormatType, destination?: ExportDestinationType, exportConfig?: ExportConfig): Promise<void>;
     /**
      * Gets the data for the Report with the given Name in the given Format
      * @param reportName - name of the report

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

@@ -2,7 +2,7 @@ import { ExportApi } from '../ExportApi';
 import { ExportState, Report, ReportFormatType, ReportNameType, SystemReportFormat, SystemReportName } from '../../AdaptableState/ExportState';
 import { ApiBase } from './ApiBase';
 import { AdaptableForm } from '../../AdaptableState/Common/AdaptableForm';
-import { CustomDestination, CustomExportParams, ExportDestinationType, ExportFormContext, ExportResultData, SystemExportDestination } from '../../AdaptableOptions/ExportOptions';
+import { CustomDestination, CustomExportParams, ExportConfig, ExportDestinationType, ExportFormContext, ExportResultData, SystemExportDestination } from '../../AdaptableOptions/ExportOptions';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { ExportInternalApi } from '../Internal/ExportInternalApi';
 import { AdaptableColumn } from '../../types';
@@ -37,10 +37,7 @@ export declare class ExportApiImpl extends ApiBase implements ExportApi {
     getCustomReports(): Report[];
     isColumnExportable(adaptableColumn: AdaptableColumn): boolean;
     getSupportedExportDestinations(reportFormat: ReportFormatType): ExportDestinationType[];
-    exportReport(reportName: ReportNameType, format: ReportFormatType, destination?: ExportDestinationType, config?: {
-        exportParams?: (defaultExportParams: CustomExportParams) => CustomExportParams;
-        showProgressIndicator?: boolean;
-    }): Promise<void>;
+    exportReport(reportName: ReportNameType, format: ReportFormatType, destination?: ExportDestinationType, exportConfig?: ExportConfig): Promise<void>;
     getReportData(reportName: ReportNameType, format: ReportFormatType, config?: {
         exportParams?: (defaultExportParams: CustomExportParams) => CustomExportParams;
         showProgressIndicator?: boolean;

package/src/Api/Implementation/ExportApiImpl.js

@@ -179,7 +179,7 @@ export class ExportApiImpl extends ApiBase {
             return true;
         });
     }
-    async exportReport(reportName, format, destination = 'Download', config) {
+    async exportReport(reportName, format, destination = 'Download', exportConfig) {
         let report = this.getReportByName(reportName);
         if (!this.checkItemExists(report, reportName, 'Report')) {
             return;
@@ -197,8 +197,8 @@ export class ExportApiImpl extends ApiBase {
                 report,
                 format,
                 destination,
-                showProgressIndicator: config?.showProgressIndicator === false ? false : true,
-                customExportParams: config?.exportParams,
+                showProgressIndicator: exportConfig?.showProgressIndicator === false ? false : true,
+                customExportParams: exportConfig?.exportParams,
             });
             if (!exportedReport) {
                 // for destination 'Download' and format 'Excel', 'VisualExcel' or 'Csv', AG Grid handles the download as well

package/src/Redux/ActionsReducers/QuickSearchRedux.d.ts

@@ -1,6 +1,10 @@
 import * as Redux from 'redux';
 import { QuickSearchState } from '../../AdaptableState/QuickSearchState';
 import { AdaptableStyle } from '../../AdaptableState/Common/AdaptableStyle';
+export declare const QUICK_SEARCH_SET_CELL_MATCHING_STYLE_DEFAULT: {
+    BackColor: string;
+    ForeColor: string;
+};
 /**
  * @ReduxAction Runs Quick Search
  */

package/src/Redux/ActionsReducers/QuickSearchRedux.js

@@ -1,5 +1,9 @@
 import { QUICK_SEARCH_DEFAULT_BACK_COLOR, QUICK_SEARCH_DEFAULT_FORE_COLOR, } from '../../Utilities/Constants/ReduxConstants';
 import { EMPTY_STRING } from '../../Utilities/Constants/GeneralConstants';
+export const QUICK_SEARCH_SET_CELL_MATCHING_STYLE_DEFAULT = {
+    BackColor: QUICK_SEARCH_DEFAULT_BACK_COLOR,
+    ForeColor: QUICK_SEARCH_DEFAULT_FORE_COLOR,
+};
 /**
  * @ReduxAction Runs Quick Search
  */
@@ -26,10 +30,6 @@ export const QuickSearchReady = (quickSearchState) => ({
 });
 const initialState = {
     QuickSearchText: EMPTY_STRING,
-    CellMatchStyle: {
-        BackColor: QUICK_SEARCH_DEFAULT_BACK_COLOR,
-        ForeColor: QUICK_SEARCH_DEFAULT_FORE_COLOR,
-    },
 };
 export const QuickSearchReducer = (state = initialState, action) => {
     switch (action.type) {

package/src/Strategy/QuickSearchModule.d.ts

@@ -4,4 +4,5 @@ import { AdaptableApi } from '../Api/AdaptableApi';
 export declare class QuickSearchModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
     getViewProperties(): AdaptableModuleView;
+    onAdaptableReady(): void;
 }

package/src/Strategy/QuickSearchModule.js

@@ -1,6 +1,7 @@
 import { AdaptableModuleBase } from './AdaptableModuleBase';
 import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
 import { QuickSearchStatusBarContent } from '../View/QuickSearch/QuickSearchStatusBarContent';
+import { QUICK_SEARCH_SET_CELL_MATCHING_STYLE_DEFAULT, QuickSearchSetCellMatchingStyle, } from '../Redux/ActionsReducers/QuickSearchRedux';
 export class QuickSearchModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.QuickSearchModuleId, ModuleConstants.QuickSearchFriendlyName, 'search-table', 'QuickSearchPopup', 'Quickly highlight all cells in the grid that contain matching query text', api);
@@ -14,4 +15,17 @@ export class QuickSearchModule extends AdaptableModuleBase {
             },
         };
     }
+    onAdaptableReady() {
+        const { api } = this;
+        const { internalApi, agGridApi } = api;
+        const isServerSideRowModel = agGridApi.getGridOption('rowModelType') === 'serverSide';
+        if (isServerSideRowModel &&
+            internalApi.getAdaptableState().QuickSearch.CellMatchStyle === undefined) {
+            // for server side row model,
+            // let's setup some defaults if there are no styles set
+            // as there are no defaults in the AG Grid find functionality (as it only works for non ssrm)
+            // so we need to set the defaults here
+            this.api.internalApi.dispatchReduxAction(QuickSearchSetCellMatchingStyle(QUICK_SEARCH_SET_CELL_MATCHING_STYLE_DEFAULT));
+        }
+    }
 }

package/src/View/QuickSearch/QuickSearchPopup.js

@@ -44,7 +44,7 @@ const QuickSearchPopupComponent = (props) => {
 function mapStateToProps(state, ownProps) {
     return {
         QuickSearchText: state.QuickSearch.QuickSearchText,
-        QuickSearchStyle: state.QuickSearch.CellMatchStyle,
+        QuickSearchStyle: state.QuickSearch.CellMatchStyle ?? {},
     };
 }
 function mapDispatchToProps(dispatch) {

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     NEXT_PUBLIC_INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862" || '',
-    PUBLISH_TIMESTAMP: 1750862989331 || Date.now(),
-    VERSION: "20.2.2" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1750939303696 || Date.now(),
+    VERSION: "20.2.3" || '--current-version--',
 };

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

@@ -3074,6 +3074,17 @@ export declare const ADAPTABLE_METAMODEL: {
             ref: string;
         })[];
     };
+    ExportConfig: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+        }[];
+    };
     ExportDataFormatContext: {
         name: string;
         kind: string;
@@ -4718,19 +4729,12 @@ export declare const ADAPTABLE_METAMODEL: {
         name: string;
         kind: string;
         desc: string;
-        props: ({
-            name: string;
-            kind: string;
-            desc: string;
-            isOpt: boolean;
-            ref?: undefined;
-        } | {
+        props: {
             name: string;
             kind: string;
             desc: string;
             isOpt: boolean;
-            ref: string;
-        })[];
+        }[];
     };
     RaiseIntentConfig: {
         name: string;