@adaptabletools/adaptable-plugin-openfin 22.0.0-canary.0 → 22.0.0-canary.2

package/README.md

@@ -10,12 +10,12 @@ This plugin allows users to take advantage of some additional functionality cour
  
 ## Documentation & Demos
 
-Full details of how to install, configure and use the OpenFin plugin can be found at [AdapTable OpenFin Documentation](https://docs.adaptabletools.com/guide/integrations-openfin)
+Full details of how to install, configure and use the OpenFin plugin can be found at [AdapTable OpenFin Documentation](https://www.adaptabletools.com/docs/integrations-openfin)
 
 
 ## Help
 
-Developers can learn how to access AdapTable programmatically at [AdapTable Documentation](https://docs.adaptabletools.com).
+Developers can learn how to access AdapTable programmatically at [AdapTable Documentation](https://www.adaptabletools.com/docs).
 
 ## Other AdapTable Resources
 
@@ -27,4 +27,4 @@ For all support enquiries please email [`support@adaptabletools.com`](mailto:sup
 
 ## Licences
 
-Information on AdapTable Licences can be found at [Licensing AdapTable for AG Grid](https://docs.adaptabletools.com/guide/buying-adaptable-licensing).
+Information on AdapTable Licences can be found at [Licensing AdapTable for AG Grid](https://www.adaptabletools.com/buy/buying-adaptable-licensing).

package/package.json

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

package/src/Module/OpenFinModule.js

@@ -4,13 +4,20 @@ import throttle from 'lodash/throttle';
 import { DEFAULT_LIVE_REPORT_THROTTLE_TIME, ALL_DATA_REPORT, SELECTED_DATA_REPORT, } from '@adaptabletools/adaptable/src/Utilities/Constants/GeneralConstants';
 export const EXCEL_VALIDATION_FAILED = 'excelValidationFailed';
 export class OpenFinModule extends AdaptableModuleBase {
+    isSendingData = false;
+    openFinService = null;
+    adaptable;
+    throttledRecomputeAndSendLiveDataEvent;
+    liveTimeoutId;
+    removeDataChangedListener;
+    removeGridRefreshedListener;
+    removeGridFilteredListener;
+    removeCellSelectionChangedListener;
+    removeRowSelectionChangedListener;
+    removeSheetChangedListener;
+    currentReportData;
     constructor(api) {
         super(ModuleConstants.OpenFinModuleId, ModuleConstants.OpenFinFriendlyName, 'download', null, 'Integrate AdapTable with the OpenFin container', api);
-        this.isSendingData = false;
-        this.openFinService = null;
-        this.getCurrentReportColumns = () => {
-            return this.currentReportData ? this.currentReportData.columns : [];
-        };
         this.adaptable = api.internalApi.getAdaptableInstance();
         this.throttledRecomputeAndSendLiveDataEvent = throttle(() => this.sendInitialLiveData(), this.getThrottleTimeFromState());
     }
@@ -72,6 +79,9 @@ export class OpenFinModule extends AdaptableModuleBase {
             });
         }
     }
+    getCurrentReportColumns = () => {
+        return this.currentReportData ? this.currentReportData.columns : [];
+    };
     startLiveData(iOpenFinReport) {
         this.cleanup(); // just in case the previous report has not been stopped
         this.liveTimeoutId = setTimeout(() => {

package/src/OpenFinApiImpl.js

@@ -16,9 +16,10 @@ if (typeof window !== 'undefined' && window.document) {
 }
 const CLICK_ALERT_BUTTON = 'adaptable-click-alert-button';
 export class OpenFinApiImpl extends ApiBase {
+    options;
+    OpenFinService = null;
     constructor(_adaptable, options) {
         super(_adaptable);
-        this.OpenFinService = null;
         this.options = options;
         if (isRunningInOpenfin()) {
             addEventListener('notification-action', (event) => {

package/src/OpenFinHelper.js

@@ -2,9 +2,7 @@
 // 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 {
-    constructor() {
-        this._subscriptions = new Array();
-    }
+    _subscriptions = new Array();
     Subscribe(fn) {
         if (fn) {
             this._subscriptions.push(fn);

package/src/Utilities/Services/OpenFinService.js

@@ -10,9 +10,41 @@ export function isExcelOpenfinLoaded() {
     return isRunningInOpenfin() && 'Excel' in fin.desktop;
 }
 export class OpenFinService {
+    adaptable;
+    options;
+    workbookName;
+    excelConnected = false;
+    connectedCallbacks = [];
+    activeWorksheet;
+    emitter;
     getOpenFinApi() {
         return this.adaptable.api.pluginsApi.getOpenFinPluginApi();
     }
+    onWorkbookRemoved = (event) => {
+        event.workbook.removeEventListener('workbookActivated', this.onWorkbookActivated);
+        const { workbook } = event;
+        this.adaptable.logger.info('Workbook closed:' + workbook.name + ', Stopping Openfin Live Excel');
+        this.getOpenFinApi().stopLiveData();
+    };
+    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) => {
+        this.adaptable.logger.info('Workbook Activated: ' + event.target.name);
+        event.target.getWorksheets((ack) => {
+            this.adaptable.logger.info('getWorksheets:', ack);
+        });
+    };
+    onWorkbookAdded = (event) => {
+        this.adaptable.logger.success('Workbook Added: ' + event.workbook.name);
+        let workbook = event.workbook;
+        workbook.addEventListener('workbookActivated', this.onWorkbookActivated);
+    };
     getCurrentWorkbook(skipRetry) {
         if (!this.workbookName) {
             return this.waitForExcel().then(() => {
@@ -59,6 +91,21 @@ export class OpenFinService {
             });
         });
     }
+    onSheetChanged = (event) => {
+        this.emit('sheetchanged', event);
+    };
+    getRowContents = (rowIndex, columnCount) => {
+        return new Promise((resolve, reject) => {
+            try {
+                this.activeWorksheet.getRow('A' + rowIndex, columnCount, (row) => {
+                    return resolve(row.map((x) => x.value));
+                });
+            }
+            catch (err) {
+                reject(err);
+            }
+        });
+    };
     doPushData(data, { address, clear }) {
         const OpenFinApi = this.getOpenFinApi();
         if (!OpenFinApi || !this.options || !isRunningInOpenfin()) {
@@ -110,6 +157,30 @@ export class OpenFinService {
             }));
         });
     }
+    onExcelConnected = () => {
+        this.excelConnected = true;
+        this.connectedCallbacks.forEach((fn) => fn());
+        this.connectedCallbacks.length = 0;
+        this.adaptable.logger.success('Excel Connected');
+        fin.desktop.Excel.addEventListener('workbookClosed', this.onWorkbookRemoved);
+        fin.desktop.Excel.addEventListener('workbookSaved', this.onWorkbookSaved);
+        fin.desktop.Excel.addEventListener('workbookAdded', this.onWorkbookAdded);
+    };
+    onExcelDisconnected = () => {
+        this.adaptable.logger.info('Excel Disconnected');
+        this.excelConnected = false;
+        this.initialisingExcel = null;
+        this.workbookName = undefined;
+        this.activeWorksheet = null;
+        fin.desktop.Excel.removeEventListener('workbookClosed', this.onWorkbookRemoved);
+        fin.desktop.Excel.removeEventListener('workbookSaved', this.onWorkbookSaved);
+        fin.desktop.Excel.removeEventListener('workbookAdded', this.onWorkbookAdded);
+        fin.desktop.ExcelService.removeEventListener('excelConnected', this.onExcelConnected);
+        fin.desktop.ExcelService.removeEventListener('excelDisconnected', this.onExcelDisconnected);
+        this.adaptable.logger.info('Excel closed stopping all Live Excel');
+        this.getOpenFinApi().stopLiveData();
+    };
+    initialisingExcel = null;
     initOpenFinExcel(callback) {
         if (this.excelConnected) {
             callback();
@@ -146,102 +217,36 @@ export class OpenFinService {
         });
         return this.initialisingExcel;
     }
+    waitForExcel = () => {
+        let startTime = Date.now();
+        const poolForExcel = (callback) => {
+            if (Date.now() - startTime > 20000) {
+                console.error(`Could not find any Excel instance.`);
+                return callback();
+            }
+            if (!fin.desktop.Excel || !fin.desktop.Excel.getWorkbooks) {
+                requestAnimationFrame(() => {
+                    poolForExcel(callback);
+                });
+            }
+            else {
+                callback();
+            }
+        };
+        return new Promise((resolve) => {
+            poolForExcel(() => resolve(''));
+        });
+    };
     constructor(adaptable, options) {
         this.adaptable = adaptable;
-        this.excelConnected = false;
-        this.connectedCallbacks = [];
-        this.onWorkbookRemoved = (event) => {
-            event.workbook.removeEventListener('workbookActivated', this.onWorkbookActivated);
-            const { workbook } = event;
-            this.adaptable.logger.info('Workbook closed:' + workbook.name + ', Stopping Openfin Live Excel');
-            this.getOpenFinApi().stopLiveData();
-        };
-        this.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;
-        };
-        this.onWorkbookActivated = (event) => {
-            this.adaptable.logger.info('Workbook Activated: ' + event.target.name);
-            event.target.getWorksheets((ack) => {
-                this.adaptable.logger.info('getWorksheets:', ack);
-            });
-        };
-        this.onWorkbookAdded = (event) => {
-            this.adaptable.logger.success('Workbook Added: ' + event.workbook.name);
-            let workbook = event.workbook;
-            workbook.addEventListener('workbookActivated', this.onWorkbookActivated);
-        };
-        this.onSheetChanged = (event) => {
-            this.emit('sheetchanged', event);
-        };
-        this.getRowContents = (rowIndex, columnCount) => {
-            return new Promise((resolve, reject) => {
-                try {
-                    this.activeWorksheet.getRow('A' + rowIndex, columnCount, (row) => {
-                        return resolve(row.map((x) => x.value));
-                    });
-                }
-                catch (err) {
-                    reject(err);
-                }
-            });
-        };
-        this.onExcelConnected = () => {
-            this.excelConnected = true;
-            this.connectedCallbacks.forEach((fn) => fn());
-            this.connectedCallbacks.length = 0;
-            this.adaptable.logger.success('Excel Connected');
-            fin.desktop.Excel.addEventListener('workbookClosed', this.onWorkbookRemoved);
-            fin.desktop.Excel.addEventListener('workbookSaved', this.onWorkbookSaved);
-            fin.desktop.Excel.addEventListener('workbookAdded', this.onWorkbookAdded);
-        };
-        this.onExcelDisconnected = () => {
-            this.adaptable.logger.info('Excel Disconnected');
-            this.excelConnected = false;
-            this.initialisingExcel = null;
-            this.workbookName = undefined;
-            this.activeWorksheet = null;
-            fin.desktop.Excel.removeEventListener('workbookClosed', this.onWorkbookRemoved);
-            fin.desktop.Excel.removeEventListener('workbookSaved', this.onWorkbookSaved);
-            fin.desktop.Excel.removeEventListener('workbookAdded', this.onWorkbookAdded);
-            fin.desktop.ExcelService.removeEventListener('excelConnected', this.onExcelConnected);
-            fin.desktop.ExcelService.removeEventListener('excelDisconnected', this.onExcelDisconnected);
-            this.adaptable.logger.info('Excel closed stopping all Live Excel');
-            this.getOpenFinApi().stopLiveData();
-        };
-        this.initialisingExcel = null;
-        this.waitForExcel = () => {
-            let startTime = Date.now();
-            const poolForExcel = (callback) => {
-                if (Date.now() - startTime > 20000) {
-                    console.error(`Could not find any Excel instance.`);
-                    return callback();
-                }
-                if (!fin.desktop.Excel || !fin.desktop.Excel.getWorkbooks) {
-                    requestAnimationFrame(() => {
-                        poolForExcel(callback);
-                    });
-                }
-                else {
-                    callback();
-                }
-            };
-            return new Promise((resolve) => {
-                poolForExcel(() => resolve(''));
-            });
-        };
-        this.on = (eventName, callback) => {
-            return this.emitter.on(eventName, callback);
-        };
-        this.emit = (eventName, data) => {
-            return this.emitter.emit(eventName, data);
-        };
         this.adaptable = adaptable;
         this.options = options;
         this.emitter = new Emitter();
     }
+    on = (eventName, callback) => {
+        return this.emitter.on(eventName, callback);
+    };
+    emit = (eventName, data) => {
+        return this.emitter.emit(eventName, data);
+    };
 }

package/src/View/OpenFinViewPanel.js

@@ -17,13 +17,6 @@ const IS_OPENFIN = isRunningInOpenfin();
 class OpenFinViewPanelComponent extends React.Component {
     constructor(props) {
         super(props);
-        this.onLiveDataChanged = (liveDataChangedInfo) => {
-            if (liveDataChangedInfo.reportDestination == 'OpenFin' &&
-                (liveDataChangedInfo.liveDataTrigger == 'Connected' ||
-                    liveDataChangedInfo.liveDataTrigger == 'Disconnected')) {
-                this.forceUpdate();
-            }
-        };
     }
     componentDidMount() {
         this.props.api.eventApi.on('LiveDataChanged', this.onLiveDataChanged);
@@ -31,6 +24,13 @@ class OpenFinViewPanelComponent extends React.Component {
     componentWillUnmount() {
         this.props.api.eventApi.off('LiveDataChanged', this.onLiveDataChanged);
     }
+    onLiveDataChanged = (liveDataChangedInfo) => {
+        if (liveDataChangedInfo.reportDestination == 'OpenFin' &&
+            (liveDataChangedInfo.liveDataTrigger == 'Connected' ||
+                liveDataChangedInfo.liveDataTrigger == 'Disconnected')) {
+            this.forceUpdate();
+        }
+    };
     getOpenFinApi() {
         return this.props.api.pluginsApi.getOpenFinPluginApi();
     }

package/src/index.js

@@ -30,44 +30,12 @@ const defaultOptions = {
     onValidationFailureInExcel: 'show-undo-notification',
 };
 class OpenFinPlugin extends AdaptablePlugin {
+    pluginId = 'openfin';
+    openFinApi;
+    OpenFinService;
+    openFinModule;
     constructor(options) {
         super(options);
-        this.pluginId = 'openfin';
-        this.rootReducer = (rootReducer) => {
-            return {
-                System: (state, action) => {
-                    let augmentedState = rootReducer.System(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 System reducer)
-                        augmentedState = Object.assign({}, augmentedState, initialOpenFinState);
-                    }
-                    return OpenFinReducer(augmentedState, action);
-                },
-            };
-        };
-        this.reduxMiddleware = (adaptable) => (middlewareAPI) => {
-            return (next) => {
-                return (action) => {
-                    switch (action.type) {
-                        case OPENFIN_START_LIVE_DATA: {
-                            const actionTyped = action;
-                            this.openFinModule.startLiveData(actionTyped.openFinReport);
-                            middlewareAPI.dispatch(PopupRedux.PopupHideScreen());
-                            return next(action);
-                        }
-                        case OPENFIN_STOP_LIVE_DATA: {
-                            const actionTyped = action;
-                            this.openFinModule.stopLiveData(actionTyped.openFinReport);
-                            return next(action);
-                        }
-                        default: {
-                            return next(action);
-                        }
-                    }
-                };
-            };
-        };
         this.options = {
             ...defaultOptions,
             ...options,
@@ -93,6 +61,41 @@ class OpenFinPlugin extends AdaptablePlugin {
         this.registerProperty('api', () => this.openFinApi);
         this.registerProperty('service', () => this.OpenFinService);
     }
+    rootReducer = (rootReducer) => {
+        return {
+            System: (state, action) => {
+                let augmentedState = rootReducer.System(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 System reducer)
+                    augmentedState = Object.assign({}, augmentedState, initialOpenFinState);
+                }
+                return OpenFinReducer(augmentedState, action);
+            },
+        };
+    };
+    reduxMiddleware = (adaptable) => (middlewareAPI) => {
+        return (next) => {
+            return (action) => {
+                switch (action.type) {
+                    case OPENFIN_START_LIVE_DATA: {
+                        const actionTyped = action;
+                        this.openFinModule.startLiveData(actionTyped.openFinReport);
+                        middlewareAPI.dispatch(PopupRedux.PopupHideScreen());
+                        return next(action);
+                    }
+                    case OPENFIN_STOP_LIVE_DATA: {
+                        const actionTyped = action;
+                        this.openFinModule.stopLiveData(actionTyped.openFinReport);
+                        return next(action);
+                    }
+                    default: {
+                        return next(action);
+                    }
+                }
+            };
+        };
+    };
     afterInitStore(adaptable) {
         adaptable.adaptableModules.set(OpenFinModuleId, new OpenFinModule(adaptable.api));
         AdaptableViewPanelFactory.set(OpenFinModuleId, OpenFinViewPanelControl);