@adaptabletools/adaptable-plugin-openfin 23.0.4 → 23.0.5-canary.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable-plugin-openfin",
-  "version": "23.0.4",
+  "version": "23.0.5-canary.1",
   "description": "",
   "homepage": "http://www.adaptabletools.com/",
   "author": {

package/src/Module/OpenFinModule.js

@@ -42,7 +42,6 @@ export class OpenFinModule extends AdaptableModuleBase {
         return this.openFinService;
     }
     sendInitialLiveData(force = true) {
-        // We wait for the last setInitialLiveData to finish
         if (this.isSendingData === true && !force) {
             this.throttledRecomputeAndSendLiveDataEvent();
             return;
@@ -82,15 +81,14 @@ export class OpenFinModule extends AdaptableModuleBase {
         return this.currentReportData ? this.currentReportData.columns : [];
     };
     startLiveData(iOpenFinReport) {
-        this.cleanup(); // just in case the previous report has not been stopped
+        this.cleanup();
         this.liveTimeoutId = setTimeout(() => {
             this.sendInitialLiveData();
-        }, 500); // for whatever strange excel reason, the timeout is needed
+        }, 500);
         const isSelectionReport = (report) => {
             return report && report.ReportName === SELECTED_DATA_REPORT;
         };
         const resendLiveDataNoSelectionReport = () => {
-            // Rerun all reports except selected cells / rows
             const currentLiveIOpenFinReport = this.getOpenFinApi().getCurrentLiveOpenFinReport();
             if (currentLiveIOpenFinReport && !isSelectionReport(currentLiveIOpenFinReport)) {
                 this.throttledRecomputeAndSendLiveDataEvent();
@@ -102,9 +100,6 @@ export class OpenFinModule extends AdaptableModuleBase {
                 this.throttledRecomputeAndSendLiveDataEvent();
             }
         };
-        // if a piece of data has updated then update any live reports except cell or row selected
-        // currently we DONT send deltas or even check if the updated cell is in the current report  - we should
-        // we simply send everything to iOpenFin every time any cell ticks....
         this.removeDataChangedListener = this.adaptable.DataService.on('CellDataChanged', (cellDataChangedInfo) => {
             const currentLiveIOpenFinReport = this.getOpenFinApi().getCurrentLiveOpenFinReport();
             const report = currentLiveIOpenFinReport
@@ -116,14 +111,10 @@ export class OpenFinModule extends AdaptableModuleBase {
                 this.throttledRecomputeAndSendLiveDataEvent();
             }
         });
-        // if the grid has refreshed then update all live reports
         this.removeGridRefreshedListener = this.adaptable._on('GridRefreshed', resendLiveDataNoSelectionReport);
         if (iOpenFinReport.ReportName !== ALL_DATA_REPORT) {
-            //  this.removeGridSortChangedListener = this.adaptable._on('SortChanged', resendLiveData);
-            // if the grid filters have changed then update any live reports except cell or row selected
             this.removeGridFilteredListener = this.adaptable._on('AdapTableFiltersApplied', resendLiveDataNoSelectionReport);
         }
-        // if grid selection has changed and the iOpenFin Live report is 'Selected Cells' or 'Selected Rows' then send updated data
         this.removeCellSelectionChangedListener = this.api.eventApi.on('CellSelectionChanged', () => {
             const currentLiveIOpenFinReport = this.getOpenFinApi().getCurrentLiveOpenFinReport();
             if (currentLiveIOpenFinReport &&
@@ -143,11 +134,8 @@ export class OpenFinModule extends AdaptableModuleBase {
             const { data } = event;
             const { row, column, width = 1, height = 1 } = data;
             if (row === 1) {
-                //its an event coming from adaptable, so no need to do extra processing
                 return;
             }
-            // if (address.split(':').length === 1) {
-            //  update on only 1 cell
             const columns = this.getCurrentReportColumns();
             const primaryKeyColumnId = this.adaptable.adaptableOptions.primaryKey;
             const primaryKeyColumnIndex = columns.findIndex((c) => c.columnId === primaryKeyColumnId);
@@ -165,7 +153,6 @@ export class OpenFinModule extends AdaptableModuleBase {
                         const primaryKey = primaryKeyColumnIndex != -1 ? rowValues[primaryKeyColumnIndex] : null;
                         const rowNode = this.api.gridApi.getRowNodeForPrimaryKey(primaryKey);
                         if (!rowNode || cols.includes(primaryKeyColumnIndex + 1)) {
-                            // rejectTop(false);
                             resolveTop({
                                 success: false,
                                 failedValidationRules: [],
@@ -185,13 +172,11 @@ export class OpenFinModule extends AdaptableModuleBase {
                                 }
                                 if (columnIsPrimaryKey) {
                                     return reject('Cannot edit a primary key column.');
-                                    // return resolve({ ignore: true });
                                 }
                                 if (this.api.columnApi.getColumnWithColumnId(columnId).readOnly) {
                                     const msg = `Cannot update column "${columnId}" — it is read-only.`;
                                     this.adaptable.logger.warn(msg);
                                     return reject(msg);
-                                    // return resolve({ ignore: true });
                                 }
                                 const cellDataChangedInfo = this.api.internalApi.buildCellDataChangedInfo({
                                     oldValue,
@@ -251,7 +236,6 @@ export class OpenFinModule extends AdaptableModuleBase {
                 const api = this.getOpenFinApi();
                 const pluginOptions = api.getPluginOptions();
                 if (!success) {
-                    //push data back to excel as hard error occured
                     if (this.getOpenFinApi().getCurrentLiveOpenFinReport()) {
                         this.sendInitialLiveData();
                     }
@@ -259,7 +243,6 @@ export class OpenFinModule extends AdaptableModuleBase {
                 }
                 if (failedValidationRules.length) {
                     if (pluginOptions.onValidationFailureInExcel === 'override') {
-                        // push data back to excel
                         if (this.getOpenFinApi().getCurrentLiveOpenFinReport()) {
                             this.sendInitialLiveData();
                         }

package/src/OpenFinApiImpl.js

@@ -5,10 +5,6 @@ import { addEventListener, create } from 'openfin-notifications';
 import { isRunningInOpenfin } from './Utilities/isRunningInOpenfin';
 import { isAdaptableCustomIcon } from '@adaptabletools/adaptable/src/components/Icon';
 import { resolveAlertFormForDefinition } from '@adaptabletools/adaptable/src/Utilities/Helpers/AlertHelper';
-// needed because otherwise openfin-notifications is not initialized properly
-// as it assumes it's running before DOMContentLoaded, but nextjs and other bundlers
-// might inject it after DOMContentLoaded is fired - so we fire it programatically
-// to trick openfin-notifications to work properly
 if (typeof window !== 'undefined' && window.document) {
     window.document.dispatchEvent(new Event('DOMContentLoaded', {
         bubbles: true,
@@ -66,14 +62,10 @@ export class OpenFinApiImpl extends ApiBase {
         const notification = {
             title: alert.header || messageType.toUpperCase(),
             category: messageType,
-            // possible values for indicator type: 'failure', 'warning','success'
-            // see https://cdn.openfin.co/docs/services/notifications/stable/api/interfaces/notifications.notificationindicator.html#type
             indicator: messageType === 'Info'
                 ? undefined
                 : { type: messageType === 'Error' ? 'failure' : messageType.toLowerCase() },
             body: alert.message,
-            // not sure if this is right but seems a nice way to tie in the Alert to the Notification - useful in the action clicked...
-            // see: https://cdn.openfin.co/docs/services/notifications/stable/api/interfaces/notifications.customdata.html
             customData: {
                 AlertId: alert.Uuid,
             },
@@ -110,7 +102,6 @@ export class OpenFinApiImpl extends ApiBase {
         if (fn && fn(notification, alert) === false) {
             return;
         }
-        // see https://developers.openfin.co/of-docs/docs/customize-notifications
         create(notification);
     }
     getOpenFinState() {
@@ -144,7 +135,6 @@ export class OpenFinApiImpl extends ApiBase {
     stopLiveData() {
         let currentLiveReport = this.getCurrentLiveOpenFinReport();
         this.dispatchAction(OpenFinRedux.OpenFinStopLiveData(currentLiveReport));
-        // fire the Live Report event for Export Stopped
         this.getExportApi().internalApi.publishLiveLiveDataChangedEvent('OpenFin', 'LiveDataStopped', currentLiveReport);
     }
 }

package/src/OpenFinHelper.js

@@ -1,5 +1,3 @@
-/*import { ExcelWorkbook } from '../Services/OpenfinLiveExcel/ExcelWorkbook';*/
-// putting this here as we dont use it elswhere - so keeping it here until we redo the OpenFin one day...
 import { AdaptableLogger } from '@adaptabletools/adaptable/src/agGrid/AdaptableLogger';
 export class EventDispatcher {
     _subscriptions = new Array();
@@ -50,36 +48,12 @@ export function isExcelOpenfinLoaded() {
 function addWorkbook() {
     return new Promise((resolve, reject) => {
         AdaptableLogger.consoleLogBase('Creating new workbook');
-        fin.desktop.Excel.addWorkbook(function (workbook /*ExcelWorkbook*/) {
+        fin.desktop.Excel.addWorkbook(function (workbook) {
             AdaptableLogger.consoleLogBase('workbook created:' + workbook.name);
             resolve(workbook.name);
-            // workbook.addEventListener("workbookActivated", (event) => onWorkbookActivated(event, resolve));
-            // workbook.activate();
-            // setTimeout(() => {
-            //     workbook.getWorksheets((ack: any) => {
-            //        LogMessage('getWorksheets:', ack);
-            //         resolve(workbook.name)
-            //     })
-            // }, 500);
         });
     });
 }
-// function onWorkbookActivated(event: any, resolve: any) {
-//    LogMessage('workbookActivated:', event);
-//     event.target.getWorksheets((ack: any) => {
-//        LogMessage('getWorksheets:', ack);
-//         resolve();
-//     });
-// }
-// export function addRangeWorkSheet(workBook: ExcelWorkbook, range: string): Promise<ExcelWorksheet> {
-//     return new Promise<ExcelWorksheet>((resolve: any, reject: any) => {
-//         resolve(workBook.getWorksheetByName("Sheet1"))
-//         // workBook.addWorksheet(function (worksheet: ExcelWorksheet) {
-//         //     //worksheet.worksheetName = range
-//         //     resolve(worksheet);
-//         // });
-//     });
-// }
 export function pushData(workBookName, data) {
     return new Promise((resolve, reject) => {
         let workBook = fin.desktop.Excel.getWorkbookByName(workBookName);
@@ -92,11 +66,7 @@ export function pushData(workBookName, data) {
         resolve();
     });
 }
-/**
- * @deprecated not used anymore
- */
 export function initOpenFinExcel() {
-    // fin.desktop.main(function () {
     fin.desktop.Excel.init();
     if (excelStatus == ExcelServiceStatus.Unknown) {
         return Promise.resolve()
@@ -119,7 +89,6 @@ export function initOpenFinExcel() {
             return '';
         });
     }
-    // });
 }
 function initExcelPluginService() {
     var installFolder = '%localappdata%\\OpenFin\\shared\\assets\\excel-api-addin';
@@ -184,9 +153,7 @@ function registerAddIn(servicePath, installFolder) {
         AdaptableLogger.consoleLogBase('Registering Add-In');
         fin.desktop.Excel.install((ack) => {
             AdaptableLogger.consoleLogBase('Add-In Registration callback', ack);
-            //if (ack.success) {
             resolve();
-            //}
         });
     });
 }
@@ -226,11 +193,9 @@ function onExcelConnected() {
     if (excelStatus != ExcelServiceStatus.Connected) {
         AdaptableLogger.consoleLogBase('Excel Connected: ' + fin.desktop.Excel.legacyApi.connectionUuid);
         excelStatus = ExcelServiceStatus.Connected;
-        // fin.desktop.Excel.instance.removeEventListener("excelConnected", onExcelConnected);
         fin.desktop.Excel.addEventListener('workbookClosed', onWorkbookRemoved);
         fin.desktop.Excel.addEventListener('workbookSaved', onWorkbookSaved);
         fin.desktop.Excel.addEventListener('workbookAdded', onWorkbookAdded);
-        // Grab a snapshot of the current instance, it can change!
         var legacyApi = fin.desktop.Excel.legacyApi;
         var onExcelDisconnected = function () {
             AdaptableLogger.consoleLogBase('Excel Disconnected: ' + legacyApi.connectionUuid);
@@ -245,7 +210,6 @@ function onExcelConnected() {
             else {
                 excelStatus = ExcelServiceStatus.Disconnected;
                 _onExcelDisconnected.Dispatch(this, null);
-                // fin.desktop.Excel.instance.addEventListener("excelConnected", onExcelConnected);
             }
         };
         fin.desktop.Excel.instance.addEventListener('excelDisconnected', onExcelDisconnected);

package/src/Redux/ActionReducers/OpenFinRedux.js

@@ -23,9 +23,7 @@ export const initialOpenFinState = {
     CurrentLiveOpenFinReport: undefined,
     OpenFinCurrentReportName: EMPTY_STRING,
 };
-export const OpenFinReducer = (
-// initial state is handled in the plugin rootReducer
-state, action) => {
+export const OpenFinReducer = (state, action) => {
     switch (action.type) {
         case OPENFIN_START_LIVE_DATA: {
             const actionType = action;

package/src/Utilities/Services/OpenFinService.js

@@ -2,9 +2,6 @@ import Emitter from '@adaptabletools/adaptable/src/Utilities/Emitter';
 import { setup } from './setup';
 import { isRunningInOpenfin } from '../isRunningInOpenfin';
 if (isRunningInOpenfin()) {
-    // Commenting this out as its causing build issues
-    // Need to decide what to do about Excel - old implementation is deprecated and replaced with this:  https://developers.openfin.co/of-docs/docs/excel-integration
-    //  require('../../excel-service/index.js');
 }
 export function isExcelOpenfinLoaded() {
     return isRunningInOpenfin() && 'Excel' in fin.desktop;
@@ -29,9 +26,6 @@ export class OpenFinService {
     onWorkbookSaved = (event) => {
         const NewName = event.workbook.name;
         this.adaptable.logger.info('Workbook saved.', NewName);
-        //saving adds an extension, but the name does not have that
-        // however, not adding the extension will not find the workbook when we do getWorkBookByName
-        // and will crash the app
         this.workbookName = NewName;
     };
     onWorkbookActivated = (event) => {
@@ -49,7 +43,6 @@ export class OpenFinService {
         if (!this.workbookName) {
             return this.waitForExcel().then(() => {
                 return fin.desktop.Excel.addWorkbook().then((workbook) => {
-                    // since  getWorkbookByName only works after getWorkbooks was called
                     return fin.desktop.Excel.getWorkbooks().then(() => {
                         this.workbookName = workbook.name;
                         this.adaptable.logger.info('Workbook created.', this.workbookName);
@@ -212,7 +205,6 @@ export class OpenFinService {
         })
             .then(() => this.waitForExcel())
             .then(() => {
-            //this.initialisingExcel = null
             return Promise.resolve('');
         });
         return this.initialisingExcel;

package/src/Utilities/Services/setup.js

@@ -25,10 +25,6 @@ export const setup = async () => {
     catch (err) {
         console.error(err);
     }
-    // Technically there is a small window of time between when the UUID is
-    // registered as an external application and when the service is ready to
-    // receive commands. This edge-case will be best handled in the future
-    // with the availability of plugins and services from the fin API
     function isServiceRunning() {
         return new Promise((resolve, reject) => {
             fin.desktop.System.getAllExternalApplications((extApps) => {
@@ -84,8 +80,6 @@ export const setup = async () => {
             var onExcelServiceEvent;
             fin.desktop.InterApplicationBus.subscribe('*', excelServiceEventTopic, (onExcelServiceEvent = () => {
                 fin.desktop.InterApplicationBus.unsubscribe('*', excelServiceEventTopic, onExcelServiceEvent);
-                // The channel provider should eventually move into the .NET app
-                // but for now it only being used for signalling
                 fin.desktop.InterApplicationBus.Channel.create(excelServiceUuid);
                 resolve();
             }));

package/src/View/OpenFinPopup.js

@@ -12,9 +12,6 @@ const OpenFinPopupComponent = (props) => {
                 props.popupParams.source && props.popupParams.source == 'Toolbar';
         }
     }, [props.popupParams]);
-    // const onApplyExport = (OpenFinReport: OpenFinReport) => {
-    //   props.onOpenFinSendSnapshot(OpenFinReport);
-    // };
     return (_jsx(PanelWithButton, { headerText: props.moduleInfo.FriendlyName, bodyProps: { className: 'twa:p-0' }, glyphicon: props.moduleInfo.Glyph, infoLink: props.moduleInfo.HelpPage, infoLinkDisabled: !props.api.internalApi.isDocumentationLinksDisplayed() }));
 };
 function mapStateToProps(state) {

package/src/View/OpenFinViewPanel.js

@@ -43,8 +43,6 @@ class OpenFinViewPanelComponent extends React.Component {
                 value: report,
             };
         });
-        // this is clearly ridiculous!
-        // im getting tired...
         let isCompletedReport = StringExtensions.IsNotNullOrEmpty(this.props.currentReportName);
         let isLiveOpenFinReport = isCompletedReport &&
             this.props.CurrentLiveOpenFinReport &&
@@ -61,7 +59,6 @@ class OpenFinViewPanelComponent extends React.Component {
     onOpenFinStartLiveData() {
         this.getOpenFinApi().startLiveData(this.createOpenFinReportFromState());
     }
-    // perhaps this should be props and in real state?
     createOpenFinReportFromState() {
         return {
             ReportName: this.props.currentReportName,

package/src/index.js

@@ -48,7 +48,6 @@ class OpenFinPlugin extends AdaptablePlugin {
                 if (!alertFiredInfo.alert.alertDefinition.AlertProperties.DisplayNotification &&
                     'AlertForm' in alertFiredInfo.alert.alertDefinition &&
                     typeof alertFiredInfo.alert.alertDefinition.AlertForm === 'string') {
-                    // bail out early for dynamic forms
                     return;
                 }
                 this.openFinApi.showNotificationForAlert(alertFiredInfo.alert);
@@ -63,8 +62,6 @@ class OpenFinPlugin extends AdaptablePlugin {
             Internal: (state, action) => {
                 let augmentedState = rootReducer.Internal(state, action);
                 if (!state) {
-                    // required for store initialization
-                    // (idiomatic way of default parameter value in reducer is not feasible because the passed argument is already initialized by the Internal reducer)
                     augmentedState = Object.assign({}, augmentedState, initialOpenFinState);
                 }
                 return OpenFinReducer(augmentedState, action);