@adaptabletools/adaptable-cjs 20.0.0-canary.0 → 20.0.0-canary.10

package/src/Api/Fdc3Api.d.ts

@@ -1,5 +1,5 @@
 import { IRowNode } from 'ag-grid-enterprise';
-import { AppIdentifier, Context, ContextType, DesktopAgent, Intent, IntentResolution } from '@finos/fdc3';
+import { AppIdentifier, Channel, Context, ContextType, DesktopAgent, Intent, IntentResolution } from '@finos/fdc3';
 /**
  * Provides run-time access to AdapTable's FDC3 functionality
  */
@@ -59,14 +59,16 @@ export interface Fdc3Api {
      * Broadcasts the given Context from the given Row Node
      * @param rowNode - The Row Node
      * @param contextType - The FDC3 Context Type
+     * @param channel - (optional) Channel to broadcast to; if not provided, the Context will be broadcast to whatever User Channel the app is joined to
      */
-    broadcastFromRow(rowNode: IRowNode, contextType: ContextType): Promise<void>;
+    broadcastFromRow(rowNode: IRowNode, contextType: ContextType, channel?: Channel): Promise<void>;
     /**
      * Broadcasts the given Context from the given Row Node with the given Primary Key Value
      * @param primaryKeyValue - The Primary Key Value
      * @param contextType - The FDC3 Context Type
+     * @param channel - (optional) Channel to broadcast to; if not provided, the Context will be broadcast to whatever User Channel the app is joined to
      */
-    broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType): Promise<void> | undefined;
+    broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType, channel?: Channel): Promise<void> | undefined;
     /**
      * Checks if the given Context Type is a FDC3 standard Context Type
      */

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -144,6 +144,7 @@ class AdaptableApiImpl {
         this.formatColumnApi = null;
         this.freeTextColumnApi = null;
         this.gridApi = null;
+        this.rowFormApi = null;
         this.internalApi = null;
         this.layoutApi = null;
         this.pluginsApi = null;

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

@@ -25,7 +25,7 @@ export declare class ColumnScopeApiImpl extends ApiBase implements ColumnScopeAp
     getColumnTypesInScope(scope: ColumnScope): string[] | undefined;
     getDataTypesInScope(scope: ColumnScope): ScopeDataType[] | undefined;
     isColumnInNumericScope(column: AdaptableColumn, scope: ColumnScope): boolean;
-    isColumnInStringsScope(column: AdaptableColumn, scope: ColumnScope): boolean;
+    isColumnInTextScope(column: AdaptableColumn, scope: ColumnScope): boolean;
     isColumnInDateScope(column: AdaptableColumn, scope: ColumnScope): boolean;
     isScopeInScope(a: ColumnScope, b: ColumnScope): boolean;
     createCellColorRangesForScope(scope: ColumnScope): CellColorRange[];

package/src/Api/Implementation/ColumnScopeApiImpl.js

@@ -187,7 +187,7 @@ class ColumnScopeApiImpl extends ApiBase_1.ApiBase {
         }
         return false;
     }
-    isColumnInStringsScope(column, scope) {
+    isColumnInTextScope(column, scope) {
         // if column is not even string then return false
         if (column == null || column == undefined || column.dataType !== 'text') {
             return false;

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

@@ -1,5 +1,5 @@
 import { ExportApi } from '../ExportApi';
-import { ExportState, Report, ReportData, ReportFormatType, ReportNameType, SystemReportFormat, SystemReportName } from '../../PredefinedConfig/ExportState';
+import { ExportState, Report, ReportFormatType, ReportNameType, SystemReportFormat, SystemReportName } from '../../PredefinedConfig/ExportState';
 import { ApiBase } from './ApiBase';
 import { AdaptableForm } from '../../PredefinedConfig/Common/AdaptableForm';
 import { CustomDestination, ExportDestinationType, ExportFormContext, ExportResultData, ExternalReport, SystemExportDestination } from '../../AdaptableOptions/ExportOptions';
@@ -36,7 +36,6 @@ export declare class ExportApiImpl extends ApiBase implements ExportApi {
     getCustomReports(): Report[];
     getExternalReports(): ExternalReport[];
     isExternalReport(report: Report): boolean;
-    runExternalReport(externalReportName: string): ReportData | undefined;
     isColumnExportable(adaptableColumn: AdaptableColumn): boolean;
     getSupportedExportDestinations(reportFormat: ReportFormatType): ExportDestinationType[];
     exportReport(reportName: ReportNameType, format: ReportFormatType, destination?: ExportDestinationType): void;

package/src/Api/Implementation/ExportApiImpl.js

@@ -136,21 +136,14 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
     isExternalReport(report) {
         return this.getExternalReports()?.find((cr) => cr.name == report.Name) != null;
     }
-    runExternalReport(externalReportName) {
-        const externalReport = this.getExternalReports()?.find((cr) => cr.name == externalReportName);
-        if (!externalReport) {
-            this.logWarn(`External Report '${externalReportName}' not found!`);
-            return undefined;
-        }
-        return externalReport.onRunReport();
-    }
     isColumnExportable(adaptableColumn) {
         const isExportableFn = this.getExportOptions().isColumnExportable;
         if (typeof isExportableFn === 'function') {
-            return isExportableFn({
+            const adaptableColumnContext = {
                 ...this.getAdaptableInternalApi().buildBaseContext(),
                 column: adaptableColumn,
-            });
+            };
+            return isExportableFn(adaptableColumnContext);
         }
         return true;
     }
@@ -171,6 +164,20 @@ class ExportApiImpl extends ApiBase_1.ApiBase {
     exportReport(reportName, format, destination = 'Download') {
         let report = this.getReportByName(reportName);
         if (this.checkItemExists(report, reportName, 'Report')) {
+            if (this.isExternalReport(report)) {
+                // Handle external report
+                this.internalApi
+                    .getExternalReportData(reportName, format, destination)
+                    .then((reportData) => {
+                    if (reportData) {
+                        this.internalApi.sendReportToDestination(reportData, report, format, destination);
+                    }
+                })
+                    .catch((error) => {
+                    this.logWarn(`Failed to get external report data for '${reportName}': ${error}`);
+                });
+                return;
+            }
             this._adaptable.agGridExportAdapter
                 .exportData({
                 report,

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

@@ -1,5 +1,5 @@
 import { IRowNode } from 'ag-grid-enterprise';
-import { Context, ContextType, DesktopAgent, Intent, IntentResolution, StandardContextType, StandardIntent } from '@finos/fdc3';
+import { Channel, Context, ContextType, DesktopAgent, Intent, IntentResolution, StandardContextType, StandardIntent } from '@finos/fdc3';
 import { ApiBase } from './ApiBase';
 import { Fdc3Api } from '../Fdc3Api';
 import { Fdc3InternalApi } from '../Internal/Fdc3InternalApi';
@@ -15,8 +15,8 @@ export declare class Fdc3ApiImpl extends ApiBase implements Fdc3Api {
     raiseIntentFromRow(rowNode: IRowNode, intent: Intent, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
     raiseIntentForContextFromRow(rowNode: IRowNode, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
     raiseIntentForContextFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
-    broadcastFromRow(rowNode: IRowNode, contextType: ContextType): Promise<void>;
-    broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType): Promise<void> | undefined;
+    broadcastFromRow(rowNode: IRowNode, contextType: ContextType, channel?: Channel): Promise<void>;
+    broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType, channel?: Channel): Promise<void> | undefined;
     getContextLabel(contextType: ContextType): string;
     isStandardContextType(contextType: string): contextType is StandardContextType;
     isStandardIntentType(intentType: string): intentType is StandardIntent;

package/src/Api/Implementation/Fdc3ApiImpl.js

@@ -47,17 +47,17 @@ class Fdc3ApiImpl extends ApiBase_1.ApiBase {
         }
         return this.raiseIntentForContextFromRow(rowNode, contextType, appIdentifier);
     }
-    broadcastFromRow(rowNode, contextType) {
+    broadcastFromRow(rowNode, contextType, channel) {
         const contextData = this.buildContextDataFromRow(contextType, rowNode);
-        return this.getFdc3Service().broadcast(contextData);
+        return this.getFdc3Service().broadcast(contextData, channel);
     }
-    broadcastFromPrimaryKey(primaryKeyValue, contextType) {
+    broadcastFromPrimaryKey(primaryKeyValue, contextType, channel) {
         const rowNode = this.getGridApi().getRowNodeForPrimaryKey(primaryKeyValue);
         if (!rowNode) {
             this.logWarn(`No row found for primary key value '${primaryKeyValue}'`);
             return undefined;
         }
-        return this.broadcastFromRow(rowNode, contextType);
+        return this.broadcastFromRow(rowNode, contextType, channel);
     }
     getContextLabel(contextType) {
         return this.isStandardContextType(contextType)

package/src/Api/Implementation/LayoutHelpers.js

@@ -7,6 +7,7 @@ const isPivotLayoutModel_1 = require("../../layout-manager/src/isPivotLayoutMode
 const normalizeLayoutModel_1 = require("../../layout-manager/src/normalizeLayoutModel");
 const simplifyLayoutModel_1 = require("../../layout-manager/src/simplifyLayoutModel");
 const AggregationColumns_1 = require("../../PredefinedConfig/Common/AggregationColumns");
+const AdaptableHelper_1 = require("../../Utilities/Helpers/AdaptableHelper");
 const layoutStateToLayoutModel = (layout) => {
     if ((0, exports.isPivotLayout)(layout)) {
         return (0, exports.pivotLayoutToPivotLayoutModel)(layout);
@@ -24,44 +25,23 @@ exports.layoutModelToLayoutState = layoutModelToLayoutState;
 function cleanupAdaptableObjectPrimitives(layout) {
     if (layout.TableAggregationColumns) {
         layout.TableAggregationColumns.forEach((AggValue) => {
-            // @ts-ignore
-            delete AggValue.Source;
-            // @ts-ignore
-            delete AggValue.Uuid;
-            // @ts-ignore
-            delete AggValue.AdaptableVersion;
+            (0, AdaptableHelper_1.removeAdaptableObjectPrimitivesInline)(AggValue);
             if (typeof AggValue.AggFunc === 'object' && AggValue.AggFunc) {
-                // @ts-ignore
-                delete AggValue.AggFunc.Source;
-                // @ts-ignore
-                delete AggValue.AggFunc.Uuid;
-                // @ts-ignore
-                delete AggValue.AggFunc.AdaptableVersion;
+                (0, AdaptableHelper_1.removeAdaptableObjectPrimitivesInline)(AggValue.AggFunc);
             }
         });
     }
     if (layout.ColumnHeaders) {
-        delete layout.ColumnHeaders.Source;
-        delete layout.ColumnHeaders.Uuid;
-        delete layout.ColumnHeaders.AdaptableVersion;
+        (0, AdaptableHelper_1.removeAdaptableObjectPrimitivesInline)(layout.ColumnHeaders);
     }
     if (layout.ColumnVisibility) {
-        delete layout.ColumnVisibility.Source;
-        delete layout.ColumnVisibility.Uuid;
-        delete layout.ColumnVisibility.AdaptableVersion;
+        (0, AdaptableHelper_1.removeAdaptableObjectPrimitivesInline)(layout.ColumnVisibility);
     }
     if (layout.ColumnWidths) {
-        delete layout.ColumnWidths.Source;
-        delete layout.ColumnWidths.Uuid;
-        delete layout.ColumnWidths.AdaptableVersion;
+        (0, AdaptableHelper_1.removeAdaptableObjectPrimitivesInline)(layout.ColumnWidths);
     }
     if (layout.RowGroupValues) {
-        // @ts-ignore
-        delete layout.RowGroupValues.Source;
-        // @ts-ignore
-        delete layout.RowGroupValues.Uuid;
-        // @ts-ignore
-        delete layout.RowGroupValues.AdaptableVersion;
+        (0, AdaptableHelper_1.removeAdaptableObjectPrimitivesInline)(layout.RowGroupValues);
     }
 }
 /**
@@ -271,6 +251,7 @@ const tableLayoutModelToTableLayout = (layoutModel, defaults) => {
     else {
         delete tableLayout.TableAggregationColumns;
     }
+    cleanupAdaptableObjectPrimitives(tableLayout);
     return tableLayout;
 };
 exports.tableLayoutModelToTableLayout = tableLayoutModelToTableLayout;

package/src/Api/Implementation/ScheduleApiImpl.js

@@ -163,7 +163,7 @@ class ScheduleApiImpl extends ApiBase_1.ApiBase {
         }
         else if (scheduleType == 'Report') {
             const reportSchedule = schedule;
-            this.getExportApi().exportReport(reportSchedule.ReportName, reportSchedule.ReportFormat, 'Download');
+            this.getExportApi().exportReport(reportSchedule.ReportName, reportSchedule.ReportFormat, reportSchedule.ExportDestination ?? 'Download');
         }
         else if (scheduleType == 'ipushpull') {
             const ippApi = this.getAdaptableApi().pluginsApi.getipushpullPluginApi();

package/src/Api/Implementation/StyledColumnApiImpl.js

@@ -39,7 +39,7 @@ class StyledColumnApiImpl extends ApiBase_1.ApiBase {
         if (!column) {
             return false;
         }
-        return !!this.getStyledColumns().find((styledColumn) => !!styledColumn.SparkLineStyle && styledColumn.ColumnId === column.columnId);
+        return !!this.getStyledColumns().find((styledColumn) => !!styledColumn.SparklineStyle && styledColumn.ColumnId === column.columnId);
     }
     getActiveStyledColumnForColumn(column) {
         const styledColumns = this.getActiveStyledColumns();

package/src/Api/Implementation/ThemeApiImpl.js

@@ -8,6 +8,7 @@ const ApiBase_1 = require("./ApiBase");
 const themes_1 = require("../../themes");
 const ThemeInternalApi_1 = require("../Internal/ThemeInternalApi");
 const AdaptableHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/AdaptableHelper"));
+const logDeprecation_1 = require("../../Utilities/logDeprecation");
 class ThemeApiImpl extends ApiBase_1.ApiBase {
     constructor(_adaptable) {
         super(_adaptable);
@@ -74,7 +75,8 @@ class ThemeApiImpl extends ApiBase_1.ApiBase {
         this.showModulePopup(ModuleConstants.ThemeModuleId);
     }
     getAgGridCurrentThemeName() {
-        return this._adaptable.getAgGridCurrentThemeName();
+        (0, logDeprecation_1.logDeprecation)(this._adaptable.logger, 'ThemeApi', 'getAgGridCurrentThemeName', null, `This is required only for AG Grid's legacy themes. See https://www.ag-grid.com/javascript-data-grid/theming-v32/`);
+        return this._adaptable.agGridThemeAdapter.getAgGridCurrentThemeClassNames();
     }
     editTheme(theme) {
         this.dispatchAction(ThemeRedux.ThemeEdit(theme));

package/src/Api/Internal/ActionColumnInternalApi.js

@@ -81,13 +81,14 @@ class ActionColumnInternalApi extends ApiBase_1.ApiBase {
         return { actionButtons, actionColumn };
     }
     updateAllActionColumnButtons(actionButtons) {
-        return actionButtons.map((actionButton) => ({
-            ...actionButton,
-            Uuid: (0, Uuid_1.createUuid)(),
-            command: actionButton.command == undefined
-                ? undefined
-                : this.updateActionButtonCommand(actionButton),
-        }));
+        return actionButtons.map((actionButton) => {
+            actionButton = { ...actionButton };
+            actionButton.Uuid = (0, Uuid_1.createUuid)();
+            if (actionButton.command) {
+                this.updateActionButtonCommand(actionButton);
+            }
+            return actionButton;
+        });
     }
     updateActionButtonCommand(button) {
         switch (button.command) {
@@ -96,7 +97,7 @@ class ActionColumnInternalApi extends ApiBase_1.ApiBase {
                     this.getRowFormApi().displayCreateRowForm();
                 };
                 button.tooltip = button.tooltip ? button.tooltip : 'Create Row';
-                button.icon = {
+                button.icon = button.icon ?? {
                     name: 'add',
                 };
                 break;
@@ -105,7 +106,7 @@ class ActionColumnInternalApi extends ApiBase_1.ApiBase {
                     this.getRowFormApi().displayCloneRowForm(context.primaryKeyValue);
                 };
                 button.tooltip = button.tooltip ? button.tooltip : 'Clone Row';
-                button.icon = {
+                button.icon = button.icon ?? {
                     name: 'clone',
                 };
                 break;
@@ -120,22 +121,18 @@ class ActionColumnInternalApi extends ApiBase_1.ApiBase {
                     this.getRowFormOptions().onRowFormSubmit?.(eventInfo);
                 };
                 button.tooltip = button.tooltip ? button.tooltip : 'Delete Row';
-                button.icon = button.icon
-                    ? button.icon
-                    : {
-                        name: 'delete',
-                    };
+                button.icon = button.icon ?? {
+                    name: 'delete',
+                };
                 break;
             case 'edit':
                 button.onClick = (button, context) => {
                     this.getRowFormApi().displayEditRowForm(context.primaryKeyValue);
                 };
                 button.tooltip = button.tooltip ? button.tooltip : 'Edit Row';
-                button.icon = button.icon
-                    ? button.icon
-                    : {
-                        name: 'edit',
-                    };
+                button.icon = button.icon ?? {
+                    name: 'edit',
+                };
                 break;
         }
     }

package/src/Api/Internal/AdaptableInternalApi.js

@@ -191,7 +191,7 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
         if (firstRowNode == undefined) {
             return {};
         }
-        const firstRowData = { ...firstRowNode?.data } ?? {};
+        const firstRowData = firstRowNode?.data ? { ...firstRowNode?.data } : {};
         // handle CalcCols which are not persisted in the rowModel
         this.getCalculatedColumnApi()
             .getCalculatedColumns()

package/src/Api/Internal/EventInternalApi.js

@@ -63,7 +63,12 @@ class EventInternalApi extends ApiBase_1.ApiBase {
             isToolbarStateChangedToHidden,
         };
         if (!(0, isEqual_1.default)(oldDashboardState, newDashboardState)) {
-            setTimeout(() => this.getEventApi().emit('DashboardChanged', dashboardChangedInfo));
+            setTimeout(() => {
+                const eventApi = this.getEventApi();
+                if (eventApi) {
+                    eventApi.emit('DashboardChanged', dashboardChangedInfo);
+                }
+            });
         }
     }
     fireAlertFiredEvent(alertToFire) {

package/src/Api/Internal/ExportInternalApi.d.ts

@@ -1,7 +1,7 @@
 import { ApiBase } from '../Implementation/ApiBase';
 import { CellDataChangedInfo } from '../../PredefinedConfig/Common/CellDataChangedInfo';
 import { Report, ReportData, ReportFormatType, ReportNameType, SystemReportName } from '../../PredefinedConfig/ExportState';
-import { IRowNode } from 'ag-grid-enterprise';
+import { CsvCell, ExcelCell, ExcelDataType, IRowNode } from 'ag-grid-enterprise';
 import { AdaptableColumn, AdaptableColumnDataType } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { BaseExportContext, DataFormatType, ExportDestinationType, ExportResultData } from '../../AdaptableOptions/ExportOptions';
 export declare class ExportInternalApi extends ApiBase {
@@ -21,12 +21,7 @@ export declare class ExportInternalApi extends ApiBase {
     getReportColumnScopeShortDescription(report: Report): string[];
     getReportColumnScopeLongDescription(report: Report): string;
     getReportExpressionDescription(report: Report, cols: AdaptableColumn[]): string;
-    getReportDataColumns(report: Report, includePrimaryKey?: boolean): AdaptableColumn[];
-    getReportDataRows(report: Report, columns: AdaptableColumn[], includePrimaryKey?: boolean): Record<string, any>[];
-    getReportData(report: Report, includePrimaryKey?: boolean): ReportData;
-    getReportDataAsArray(report: Report, includePrimaryKey?: boolean): any[][];
     convertReportDataToArray(reportData: ReportData): any[][];
-    getRowObjectForColumnIds(rowNode: IRowNode, columnIds: string[], reportName: string): Record<string, any>;
     publishLiveLiveDataChangedEvent(reportDestination: 'ipushpull' | 'OpenFin', liveDataTrigger: 'Connected' | 'Disconnected' | 'SnapshotSent' | 'LiveDataStarted' | 'LiveDataStopped' | 'LiveDataUpdated', liveReport?: any): void;
     getCellExportValueFromRowNode(rowNode: IRowNode, columnId: string, isVisualReport?: boolean): any;
     getCellExportValueFromRawValue(rowNode: IRowNode, cellRawValue: any, columnId: string, isVisualReport?: boolean): any;
@@ -36,4 +31,13 @@ export declare class ExportInternalApi extends ApiBase {
     sendReportToDestination(reportResult: ExportResultData, report: Report, format: ReportFormatType, destination: ExportDestinationType): void;
     private sendReportToCustomDestination;
     buildBaseExportContext(reportName: ReportNameType, reportFormat: ReportFormatType, exportDestination?: ExportDestinationType): BaseExportContext;
+    createCellCsv(cellContent: any): CsvCell;
+    createCellExcel(cellContent: any, cellType: ExcelDataType): ExcelCell;
+    createCellHeader(cellContent: any): ExcelCell;
+    getExternalReportData(externalReportName: ReportNameType, reportFormat: ReportFormatType, exportDestination: ExportDestinationType): Promise<ExportResultData | undefined>;
+    private buildGridReportColumns;
+    private buildExcelConverter;
+    private buildCsvConverter;
+    private executeGridExport;
+    private buildCsvExportParams;
 }