@adaptabletools/adaptable 15.2.0-canary.2 → 15.2.0-canary.4

package/package.json

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

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1680846291184;
+declare const _default: 1680875814346;
 export default _default;

package/publishTimestamp.js

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

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -1,4 +1,4 @@
-import { ChartModel, ChartRef, Column, GridOptions, ModuleNames, IRowNode, StatusPanelDef } from '@ag-grid-community/core';
+import { ChartModel, ChartRef, Column, IRowNode, ModuleNames, RowModelType, StatusPanelDef } from '@ag-grid-community/core';
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { ColumnSort } from '../PredefinedConfig/Common/ColumnSort';
@@ -235,7 +235,7 @@ export interface IAdaptable {
     showChart(chart: ChartDefinition, container?: HTMLElement): ChartRef;
     getChartRef(chardId: string): ChartRef;
     getChartModels(): ChartModel[];
-    getRowModel(): GridOptions['rowModelType'];
+    getRowModelType(): RowModelType;
     getCurrentIPPStyle(): IPPStyle;
     getDefaultIPPStyle(): IPPStyle;
     getRowCount(): number;

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -1,7 +1,7 @@
 import { AdaptableForm } from '../PredefinedConfig/Common/AdaptableForm';
 import { FormContext } from '../PredefinedConfig/Common/FormContext';
 import { Report, ReportData, SystemReportNames } from '../PredefinedConfig/ExportState';
-import { AdaptableColumnBase, BaseContext } from '../types';
+import { AdaptableColumnDataType, BaseContext } from '../types';
 /**
  * Options regarding Exporting data from AdapTable
  */
@@ -29,6 +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[];
     /**
@@ -77,13 +79,34 @@ export interface PreProcessExportContext extends BaseContext {
      * Returns the columns which would be included in the report based on the `Report.ReportColumnScope`
      * @param includePrimaryKey - whether to include the primary key column (defaults to `false`)
      */
-    getReportColumns: (includePrimaryKey?: boolean) => AdaptableColumnBase[];
+    getReportColumns: (includePrimaryKey?: boolean) => AdaptableReportColumn[];
     /**
      * Returns the row data which would be included in the report based on the `Report.ReportRowScope`
      * @param reportColumns - the columns to include in the report
      * @param includePrimaryKey - whether to include the primary key column (defaults to `false`)
      */
-    getReportRowData: (reportColumns: AdaptableColumnBase[], includePrimaryKey?: boolean) => Record<string, any>[];
+    getReportRowData: (reportColumns: AdaptableReportColumn[], includePrimaryKey?: boolean) => Record<string, any>[];
+}
+/**
+ * Column which is included in a Report
+ */
+export interface AdaptableReportColumn {
+    /**
+     * ColumnID
+     */
+    columnId: string;
+    /**
+     * Column Header
+     */
+    friendlyName: string;
+    /**
+     * Field name to get the value from the row data (defaults to `columnId`)
+     */
+    field?: string;
+    /**
+     * DataType of the Column
+     */
+    dataType: AdaptableColumnDataType;
 }
 /**
  * Format of exported Data - 'rawValue' or 'formattedValue'
@@ -164,5 +187,5 @@ export interface ExportableColumnContext extends BaseContext {
     /**
      * Column to be exported
      */
-    adaptableColumn: AdaptableColumnBase;
+    adaptableColumn: AdaptableReportColumn;
 }

package/src/Api/ColumnApi.d.ts

@@ -137,6 +137,11 @@ export interface ColumnApi {
      * @param columnId ColumnId to check
      */
     isAutoPivotColumn(columnId: string): boolean;
+    /**
+     * Checks if Column with given ColumnId is a Calculated Column or a Free Text Column or an Action Column
+     * @param columnId ColumnId to check
+     */
+    isSpecialColumn(columnId: string): boolean;
     /**
      * Checks if Column with given ColumnId is a Calculated Column
      * @param columnId ColumnId to check

package/src/Api/GridApi.d.ts

@@ -9,7 +9,7 @@ import { CellHighlightInfo } from '../PredefinedConfig/Common/CellHighlightInfo'
 import { RowHighlightInfo } from '../PredefinedConfig/Common/RowHighlightInfo';
 import { AdaptableModule } from '../PredefinedConfig/Common/Types';
 import { AccessLevel } from '../PredefinedConfig/Common/Entitlement';
-import { GridOptions, IRowNode } from '@ag-grid-community/core';
+import { GridOptions, IRowNode, RowModelType } from '@ag-grid-community/core';
 import { GridCellRange } from '../PredefinedConfig/Selection/GridCellRange';
 import { RowsHighlightInfo } from '../PredefinedConfig/Common/RowsHighlightInfo';
 /**
@@ -485,6 +485,10 @@ export interface GridApi {
      * Opens Settings Panel with Grid Info section selected and visible
      */
     openGridInfoSettingsPanel(): void;
+    /**
+     * Returns the current AG Grid Row Model Type
+     */
+    getRowModelType(): RowModelType;
     /**
      * TO BE REMOVED
      */

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

@@ -92,4 +92,5 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     isActionRowButtonColumn(columnId: string): boolean;
     getDefaultAggFunc(columnId: string): string;
     getTypesForColumn(columnId: string): string | string[] | undefined;
+    isSpecialColumn(columnId: string): boolean;
 }

package/src/Api/Implementation/ColumnApiImpl.js

@@ -443,5 +443,10 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         const agGridColumn = this.getAgGridColumnForAdaptableColumn(columnId);
         return (_a = agGridColumn === null || agGridColumn === void 0 ? void 0 : agGridColumn.getColDef()) === null || _a === void 0 ? void 0 : _a.type;
     }
+    isSpecialColumn(columnId) {
+        return (this.isCalculatedColumn(columnId) ||
+            this.isFreeTextColumn(columnId) ||
+            this.isActionColumn(columnId));
+    }
 }
 exports.ColumnApiImpl = ColumnApiImpl;

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

@@ -3,11 +3,10 @@ import { ExportState, Report, ReportData, ReportSchedule, SystemReportNames } fr
 import { ApiBase } from './ApiBase';
 import { AdaptableForm } from '../../PredefinedConfig/Common/AdaptableForm';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
-import { CustomDestination, ExportFormContext, ServerReport } from '../../AdaptableOptions/ExportOptions';
+import { AdaptableReportColumn, CustomDestination, ExportFormContext, ServerReport } from '../../AdaptableOptions/ExportOptions';
 import { ExportDestination } from '../../PredefinedConfig/Common/Enums';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { ExportInternalApi } from '../Internal/ExportInternalApi';
-import { AdaptableColumnBase } from '../../types';
 export declare class ExportApiImpl extends ApiBase implements ExportApi {
     internalApi: ExportInternalApi;
     constructor(adaptable: IAdaptable);
@@ -43,5 +42,5 @@ export declare class ExportApiImpl extends ApiBase implements ExportApi {
     isServerReport(report: Report): boolean;
     runServerReport(serverReportName: string): ReportData | undefined;
     getReportDataForReport(reportName: string): ReportData | undefined;
-    isColumnExportable(adaptableColumn: AdaptableColumnBase): boolean;
+    isColumnExportable(adaptableColumn: AdaptableReportColumn): boolean;
 }

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

@@ -8,7 +8,7 @@ import { ColumnSort } from '../../PredefinedConfig/Common/ColumnSort';
 import { DataUpdateConfig } from '../../PredefinedConfig/Common/DataUpdateConfig';
 import { CellHighlightInfo } from '../../PredefinedConfig/Common/CellHighlightInfo';
 import { RowHighlightInfo } from '../../PredefinedConfig/Common/RowHighlightInfo';
-import { GridOptions, IRowNode } from '@ag-grid-community/core';
+import { GridOptions, IRowNode, RowModelType } from '@ag-grid-community/core';
 import { GridCellRange } from '../../PredefinedConfig/Selection/GridCellRange';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
 import { AdaptableModule } from '../../PredefinedConfig/Common/Types';
@@ -139,4 +139,5 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     getGridContainerElement(): HTMLElement | null;
     showGridInfoPopup(): void;
     openGridInfoSettingsPanel(): void;
+    getRowModelType(): RowModelType;
 }

package/src/Api/Implementation/GridApiImpl.js

@@ -515,5 +515,8 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     openGridInfoSettingsPanel() {
         this.showModulePopup(ModuleConstants.GridInfoModuleId);
     }
+    getRowModelType() {
+        return this.adaptable.getRowModelType();
+    }
 }
 exports.GridApiImpl = GridApiImpl;

package/src/Api/Implementation/LayoutApiImpl.js

@@ -258,7 +258,7 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             ColumnFilters: true,
             ColumnSorts: true,
         };
-        if (this.adaptable.getRowModel() === 'viewport') {
+        if (this.getGridApi().getRowModelType() === 'viewport') {
             layoutSupportedFeatures.RowGroupedColumns = false;
             layoutSupportedFeatures.AggregationColumns = false;
             layoutSupportedFeatures.PivotColumns = false;

package/src/Api/Internal/LayoutInternalApi.js

@@ -117,7 +117,7 @@ class LayoutInternalApi extends ApiBase_1.ApiBase {
             ColumnFilters: true,
             ColumnSorts: true,
         };
-        if (this.adaptable.getRowModel() === 'viewport') {
+        if (this.getGridApi().getRowModelType() === 'viewport') {
             layoutSupportedFeatures.RowGroupedColumns = false;
             layoutSupportedFeatures.AggregationColumns = false;
             layoutSupportedFeatures.PivotColumns = false;

package/src/Strategy/LayoutModule.js

@@ -65,7 +65,7 @@ class LayoutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
          * logic where layout is applied, it is easier and
          * less error prone to just remove it.
          */
-        if (this.api.internalApi.getAdaptableInstance().getRowModel() === 'viewport') {
+        if (this.api.gridApi.getRowModelType() === 'viewport') {
             this.api.layoutApi.getLayouts().forEach(this.clearUnsuportedFeaturesFromLayout);
         }
     }

package/src/Utilities/Services/ReportService.d.ts

@@ -1,8 +1,8 @@
-import { AdaptableColumn, AdaptableColumnBase } from '../../PredefinedConfig/Common/AdaptableColumn';
+import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { Report, ReportData, SystemReportName } from '../../PredefinedConfig/ExportState';
 import { IReportService } from './Interface/IReportService';
 import { ExcelStyle, IRowNode } from '@ag-grid-community/core';
-import { SystemExportDestination } from '../../AdaptableOptions/ExportOptions';
+import { AdaptableReportColumn, SystemExportDestination } from '../../AdaptableOptions/ExportOptions';
 import { AdaptableApi } from '../../../types';
 export declare class ReportService implements IReportService {
     private adaptableApi;
@@ -23,8 +23,8 @@ export declare class ReportService implements IReportService {
     GetReportColumnScopeShortDescription(report: Report): string[];
     GetReportColumnScopeLongDescription(report: Report): string;
     GetReportExpressionDescription(report: Report, cols: AdaptableColumn[]): string;
-    getReportDataColumns(report: Report, includePrimaryKey?: boolean): AdaptableColumnBase[];
-    getReportDataRows(report: Report, columns: AdaptableColumnBase[], includePrimaryKey?: boolean): Record<string, any>[];
+    getReportDataColumns(report: Report, includePrimaryKey?: boolean): AdaptableReportColumn[];
+    getReportDataRows(report: Report, columns: AdaptableReportColumn[], includePrimaryKey?: boolean): Record<string, any>[];
     getReportData(report: Report, includePrimaryKey?: boolean): ReportData;
     getReportDataAsArray(report: Report, includePrimaryKey?: boolean): any[][];
     convertReportDataToArray(reportData: ReportData): any[][];

package/src/Utilities/Services/ReportService.js

@@ -224,11 +224,15 @@ class ReportService {
                 reportColumns.push(this.adaptableApi.columnApi.getPrimaryKeyColumn());
             }
         }
-        return reportColumns.map((column) => ({
-            columnId: column.columnId,
-            friendlyName: column.friendlyName,
-            dataType: column.dataType,
-        }));
+        return reportColumns.map((column) => {
+            var _a;
+            return ({
+                columnId: column.columnId,
+                friendlyName: column.friendlyName,
+                dataType: column.dataType,
+                field: (_a = column.field) !== null && _a !== void 0 ? _a : column.columnId,
+            });
+        });
     }
     getReportDataRows(report, columns, includePrimaryKey) {
         var _a, _b;

package/src/agGrid/Adaptable.d.ts

@@ -219,7 +219,7 @@ export declare class Adaptable implements IAdaptable {
     getRowNodeForPrimaryKey(primaryKeyValue: any): any;
     getRowNodeByIndex(index: number): IRowNode;
     getRowNodesForPrimaryKeys(primaryKeyValues: any[]): any[];
-    forAllRowNodesDo(func: (rowNode: IRowNode) => void, config?: {
+    forAllRowNodesDo(func: (rowNode: IRowNode, rowIndex: number) => void, config?: {
         includeGroupRows?: boolean;
         filterFn?: (rowNode: IRowNode) => boolean;
     }): void;
@@ -398,7 +398,7 @@ export declare class Adaptable implements IAdaptable {
     showChart(chartDefinition: ChartDefinition, container?: HTMLElement): ChartRef;
     getChartRef(chartId: string): ChartRef;
     getChartModels(): import("@ag-grid-community/core").ChartModel[];
-    getRowModel(): import("@ag-grid-community/core").RowModelType;
+    getRowModelType(): import("@ag-grid-community/core").RowModelType;
     private getActiveAdaptableAggFuncForCol;
     private registerAdaptableAggFuncs;
     /**

package/src/agGrid/Adaptable.js

@@ -2104,15 +2104,21 @@ class Adaptable {
         return rowNodes;
     }
     forAllRowNodesDo(func, config) {
-        this.gridOptions.api.forEachNode((rowNode) => {
+        this.gridOptions.api.forEachNode((rowNode, rowIndex) => {
             const includeGroupRows = (config === null || config === void 0 ? void 0 : config.includeGroupRows) || !this.isGroupRowNode(rowNode);
             const filterFnFulfilled = !(config === null || config === void 0 ? void 0 : config.filterFn) || (config === null || config === void 0 ? void 0 : config.filterFn(rowNode));
             if (includeGroupRows && filterFnFulfilled) {
-                func(rowNode);
+                func(rowNode, rowIndex);
             }
         });
     }
     forAllVisibleRowNodesDo(func, config) {
+        if (this.getRowModelType() !== 'clientSide') {
+            // only in client-side row model can we loop through filtered&sorted rows
+            // see https://www.ag-grid.com/javascript-data-grid/accessing-data/#iterating-rows
+            this.logger.warn('`forAllVisibleRowNodesDo()` is only supported in client-side row model. `forAllRowNodesDo` will be used instead.');
+            return this.forAllRowNodesDo(func, config);
+        }
         this.gridOptions.api.forEachNodeAfterFilterAndSort((rowNode, rowIndex) => {
             const includeGroupRows = (config === null || config === void 0 ? void 0 : config.includeGroupRows) || !this.isGroupRowNode(rowNode);
             const filterFnFulfilled = !(config === null || config === void 0 ? void 0 : config.filterFn) || (config === null || config === void 0 ? void 0 : config.filterFn(rowNode));
@@ -4884,7 +4890,7 @@ import "@adaptabletools/adaptable/themes/${themeName}.css"`);
         }
         return this.gridOptions.api.getChartModels();
     }
-    getRowModel() {
+    getRowModelType() {
         return this.gridOptions.rowModelType;
     }
     getActiveAdaptableAggFuncForCol(columnId) {

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

@@ -790,6 +790,30 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    AdaptableReportColumn: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            ref?: undefined;
+            isOpt?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            ref: string;
+            isOpt?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            ref?: undefined;
+        })[];
+    };
     AdaptableRowChangedAlert: {
         name: string;
         kind: string;