@adaptabletools/adaptable-plugin-openfin 15.0.2 → 15.1.0-canary.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable-plugin-openfin",
-  "version": "15.0.2",
+  "version": "15.1.0-canary.0",
   "description": "",
   "homepage": "http://www.adaptabletools.com/",
   "author": {
@@ -20,6 +20,6 @@
     "redux": "4.0.5",
     "styled-components": "^4.4.1",
     "tslib": "^2.3.0",
-    "@adaptabletools/adaptable": "15.0.2"
+    "@adaptabletools/adaptable": "15.1.0-canary.0"
   }
 }

package/src/Module/OpenFinModule.js

@@ -5,7 +5,6 @@ const tslib_1 = require("tslib");
 const AdaptableModuleBase_1 = require("@adaptabletools/adaptable/src/Strategy/AdaptableModuleBase");
 const ModuleConstants = tslib_1.__importStar(require("@adaptabletools/adaptable/src/Utilities/Constants/ModuleConstants"));
 const throttle_1 = tslib_1.__importDefault(require("lodash/throttle"));
-const logger_1 = require("../logger");
 const GeneralConstants_1 = require("@adaptabletools/adaptable/src/Utilities/Constants/GeneralConstants");
 exports.EXCEL_VALIDATION_FAILED = 'excelValidationFailed';
 class OpenFinModule extends AdaptableModuleBase_1.AdaptableModuleBase {
@@ -57,13 +56,13 @@ class OpenFinModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             return this.getOpenFinService()
                 .clearAndPushData(ReportAsArray)
                 .then(() => {
-                (0, logger_1.LogAdaptableSuccess)('All live report data sent');
+                this.adaptable.logger.success('All live report data sent');
                 this.isSendingData = false;
                 return this.adaptable.ReportService.PublishLiveLiveDataChangedEvent('OpenFin', 'LiveDataUpdated', currentLiveIOpenFinReport);
             })
                 .catch((reason) => {
                 this.isSendingData = false;
-                (0, logger_1.LogAdaptableWarning)('Failed to send data to OpenFin for [' + currentLiveIOpenFinReport.ReportName + ']', reason);
+                this.adaptable.logger.warn('Failed to send data to OpenFin for [' + currentLiveIOpenFinReport.ReportName + ']', reason);
                 this.getOpenFinApi().stopLiveData();
                 let errorMessage = 'Export Failed';
                 if (reason) {
@@ -71,7 +70,7 @@ class OpenFinModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                 }
                 errorMessage += '.  This live export has been cancelled.';
                 this.api.alertApi.showAlertError('iOpenFin Export Error', errorMessage);
-                (0, logger_1.LogAdaptableWarning)('Failed to send data');
+                this.adaptable.logger.warn('Failed to send data');
             });
         }
     }
@@ -208,13 +207,13 @@ class OpenFinModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                                 }
                                 if (this.api.columnApi.getColumnWithColumnId(columnId).readOnly) {
                                     const msg = `Can't update column ${columnId} as it is read-only`;
-                                    (0, logger_1.LogAdaptableWarning)(msg);
+                                    this.adaptable.logger.warn(msg);
                                     return reject(msg);
                                     // return resolve({ ignore: true });
                                 }
                                 else if (!this.adaptable.isCellEditable(rowNode, this.adaptable.api.columnApi.internalApi.getAgGridColumnForAdaptableColumn(columnId))) {
                                     const msg = `Can't update column cell in ${columnId} as it is read-only`;
-                                    (0, logger_1.LogAdaptableWarning)(msg);
+                                    this.adaptable.logger.warn(msg);
                                     return reject(msg);
                                     // return resolve({ ignore: true });
                                 }

package/src/OpenFinHelper.js

@@ -1,7 +1,9 @@
 "use strict";
+/*import { ExcelWorkbook } from '../Services/OpenfinLiveExcel/ExcelWorkbook';*/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenfinHelper = exports.initOpenFinExcel = exports.pushData = exports.isExcelOpenfinLoaded = exports.isRunningInOpenfin = exports.OnWorkbookSaved = exports.OnWorkbookDisconnected = exports.OnExcelDisconnected = exports.EventDispatcher = void 0;
-const logger_1 = require("./logger");
+// putting this here as we dont use it elswhere - so keeping it here until we redo the OpenFin one day...
+const AdaptableLogger_1 = require("@adaptabletools/adaptable/src/agGrid/AdaptableLogger");
 class EventDispatcher {
     constructor() {
         this._subscriptions = new Array();
@@ -58,9 +60,9 @@ function isExcelOpenfinLoaded() {
 exports.isExcelOpenfinLoaded = isExcelOpenfinLoaded;
 function addWorkbook() {
     return new Promise((resolve, reject) => {
-        (0, logger_1.LogAdaptableInfo)('Creating new workbook');
+        AdaptableLogger_1.AdaptableLogger.consoleLogBase('Creating new workbook');
         fin.desktop.Excel.addWorkbook(function (workbook /*ExcelWorkbook*/) {
-            (0, logger_1.LogAdaptableSuccess)('workbook created:' + workbook.name);
+            AdaptableLogger_1.AdaptableLogger.consoleLogBase('workbook created:' + workbook.name);
             resolve(workbook.name);
             // workbook.addEventListener("workbookActivated", (event) => onWorkbookActivated(event, resolve));
             // workbook.activate();
@@ -93,7 +95,7 @@ function pushData(workBookName, data) {
     return new Promise((resolve, reject) => {
         let workBook = fin.desktop.Excel.getWorkbookByName(workBookName);
         if (!workBook) {
-            (0, logger_1.LogAdaptableError)('Cannot find workbook:' + workBookName);
+            AdaptableLogger_1.AdaptableLogger.consoleErrorBase('Cannot find workbook:' + workBookName);
             reject('Cannot find workbook:' + workBookName);
         }
         let worksheet = workBook.getWorksheetByName('Sheet1');
@@ -115,7 +117,7 @@ function initOpenFinExcel() {
             .then(onExcelConnected)
             .then(addWorkbook)
             .catch((err) => {
-            (0, logger_1.LogAdaptableError)(err);
+            AdaptableLogger_1.AdaptableLogger.consoleErrorBase(err);
             return '';
         });
     }
@@ -125,7 +127,7 @@ function initOpenFinExcel() {
             .then(onExcelConnected)
             .then(addWorkbook)
             .catch((err) => {
-            (0, logger_1.LogAdaptableError)(err);
+            AdaptableLogger_1.AdaptableLogger.consoleErrorBase(err);
             return '';
         });
     }
@@ -137,7 +139,7 @@ function initExcelPluginService() {
     var servicePath = 'OpenFin.ExcelService.exe';
     var addInPath = 'OpenFin.ExcelApi-AddIn.xll';
     if (excelStatus != ExcelServiceStatus.Unknown) {
-        (0, logger_1.LogAdaptableInfo)('Skipping Add-in deployment as already deployed');
+        AdaptableLogger_1.AdaptableLogger.consoleLogBase('Skipping Add-in deployment as already deployed');
         return Promise.resolve();
     }
     excelStatus = ExcelServiceStatus.Connecting;
@@ -148,13 +150,13 @@ function initExcelPluginService() {
 }
 function deployAddIn(servicePath, installFolder) {
     return new Promise((resolve, reject) => {
-        (0, logger_1.LogAdaptableInfo)('Deploying Add-In');
+        AdaptableLogger_1.AdaptableLogger.consoleLogBase('Deploying Add-In');
         fin.desktop.System.launchExternalProcess({
             alias: 'excel-api-addin',
             target: servicePath,
             arguments: '-d "' + installFolder + '"',
             listener: function (args) {
-                (0, logger_1.LogAdaptableSuccess)('Installer script completed! ' + args.exitCode);
+                AdaptableLogger_1.AdaptableLogger.consoleLogBase('Installer script completed! ' + args.exitCode);
                 resolve();
             },
         });
@@ -166,12 +168,12 @@ function startExcelService(servicePath, installFolder) {
         fin.desktop.System.getAllExternalApplications((extApps) => {
             var excelServiceIndex = extApps.findIndex((extApp) => extApp.uuid === serviceUuid);
             if (excelServiceIndex >= 0) {
-                (0, logger_1.LogAdaptableInfo)('Service Already Running');
+                AdaptableLogger_1.AdaptableLogger.consoleLogBase('Service Already Running');
                 resolve();
                 return;
             }
             var onServiceStarted = () => {
-                (0, logger_1.LogAdaptableSuccess)('Service Started');
+                AdaptableLogger_1.AdaptableLogger.consoleLogBase('Service Started');
                 fin.desktop.Excel.instance.removeEventListener('started', onServiceStarted);
                 resolve();
             };
@@ -182,7 +184,7 @@ function startExcelService(servicePath, installFolder) {
                     arguments: '-p ' + details.port,
                     uuid: serviceUuid,
                 }, (process) => {
-                    (0, logger_1.LogAdaptableSuccess)('Service Launched: ' + process.uuid);
+                    AdaptableLogger_1.AdaptableLogger.consoleLogBase('Service Launched: ' + process.uuid);
                 }, (error) => {
                     reject('Error starting Excel service');
                 });
@@ -192,9 +194,9 @@ function startExcelService(servicePath, installFolder) {
 }
 function registerAddIn(servicePath, installFolder) {
     return new Promise((resolve, reject) => {
-        (0, logger_1.LogAdaptableInfo)('Registering Add-In');
+        AdaptableLogger_1.AdaptableLogger.consoleLogBase('Registering Add-In');
         fin.desktop.Excel.install((ack) => {
-            (0, logger_1.LogAdaptableInfo)('Add-In Registration callback', ack);
+            AdaptableLogger_1.AdaptableLogger.consoleLogBase('Add-In Registration callback', ack);
             //if (ack.success) {
             resolve();
             //}
@@ -205,11 +207,11 @@ function connectToExcel() {
     return new Promise((resolve, reject) => {
         fin.desktop.Excel.instance.getExcelInstances((instances) => {
             if (instances.length > 0) {
-                (0, logger_1.LogAdaptableInfo)('Excel Already Running');
+                AdaptableLogger_1.AdaptableLogger.consoleLogBase('Excel Already Running');
                 resolve();
             }
             else {
-                (0, logger_1.LogAdaptableInfo)('Launching Excel');
+                AdaptableLogger_1.AdaptableLogger.consoleLogBase('Launching Excel');
                 fin.desktop.Excel.run(resolve);
             }
         });
@@ -223,19 +225,19 @@ function onWorkbookSaved(event) {
     _onWorkbookSaved.Dispatch(this, { OldName: event.oldWorkbookName, NewName: event.workbook.name });
 }
 function onWorkbookActivated(event) {
-    (0, logger_1.LogAdaptableInfo)('Workbook Activated: ' + event.target.name);
+    AdaptableLogger_1.AdaptableLogger.consoleLogBase('Workbook Activated: ' + event.target.name);
     event.target.getWorksheets((ack) => {
-        (0, logger_1.LogAdaptableInfo)('getWorksheets:', ack);
+        AdaptableLogger_1.AdaptableLogger.consoleLogBase('getWorksheets:', ack);
     });
 }
 function onWorkbookAdded(event) {
-    (0, logger_1.LogAdaptableSuccess)('Workbook Added: ' + event.workbook.name);
+    AdaptableLogger_1.AdaptableLogger.consoleLogBase('Workbook Added: ' + event.workbook.name);
     let workbook = event.workbook;
     workbook.addEventListener('workbookActivated', onWorkbookActivated);
 }
 function onExcelConnected() {
     if (excelStatus != ExcelServiceStatus.Connected) {
-        (0, logger_1.LogAdaptableSuccess)('Excel Connected: ' + fin.desktop.Excel.legacyApi.connectionUuid);
+        AdaptableLogger_1.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);
@@ -244,7 +246,7 @@ function onExcelConnected() {
         // Grab a snapshot of the current instance, it can change!
         var legacyApi = fin.desktop.Excel.legacyApi;
         var onExcelDisconnected = function () {
-            (0, logger_1.LogAdaptableInfo)('Excel Disconnected: ' + legacyApi.connectionUuid);
+            AdaptableLogger_1.AdaptableLogger.consoleLogBase('Excel Disconnected: ' + legacyApi.connectionUuid);
             fin.desktop.Excel.instance.removeEventListener('excelDisconnected', onExcelDisconnected);
             legacyApi.removeEventListener('workbookClosed', onWorkbookRemoved);
             legacyApi.removeEventListener('workbookSaved', onWorkbookSaved);

package/src/Utilities/Services/OpenFinService.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenFinService = exports.isExcelOpenfinLoaded = void 0;
 const tslib_1 = require("tslib");
-const logger_1 = require("../../logger");
 const Emitter_1 = tslib_1.__importDefault(require("@adaptabletools/adaptable/src/Utilities/Emitter"));
 const setup_1 = require("./setup");
 const isRunningInOpenfin_1 = require("../isRunningInOpenfin");
@@ -21,25 +20,25 @@ class OpenFinService {
         this.onWorkbookRemoved = (event) => {
             event.workbook.removeEventListener('workbookActivated', this.onWorkbookActivated);
             const { workbook } = event;
-            (0, logger_1.LogAdaptableInfo)('Workbook closed:' + workbook.name + ', Stopping Openfin Live Excel');
+            this.adaptable.logger.info('Workbook closed:' + workbook.name + ', Stopping Openfin Live Excel');
             this.getOpenFinApi().stopLiveData();
         };
         this.onWorkbookSaved = (event) => {
             const NewName = event.workbook.name;
-            (0, logger_1.LogAdaptableInfo)('workbook saved', NewName);
+            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) => {
-            (0, logger_1.LogAdaptableInfo)('Workbook Activated: ' + event.target.name);
+            this.adaptable.logger.info('Workbook Activated: ' + event.target.name);
             event.target.getWorksheets((ack) => {
-                (0, logger_1.LogAdaptableInfo)('getWorksheets:', ack);
+                this.adaptable.logger.info('getWorksheets:', ack);
             });
         };
         this.onWorkbookAdded = (event) => {
-            (0, logger_1.LogAdaptableSuccess)('Workbook Added: ' + event.workbook.name);
+            this.adaptable.logger.success('Workbook Added: ' + event.workbook.name);
             let workbook = event.workbook;
             workbook.addEventListener('workbookActivated', this.onWorkbookActivated);
         };
@@ -62,13 +61,13 @@ class OpenFinService {
             this.excelConnected = true;
             this.connectedCallbacks.forEach((fn) => fn());
             this.connectedCallbacks.length = 0;
-            (0, logger_1.LogAdaptableSuccess)('Excel Connected');
+            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 = () => {
-            (0, logger_1.LogAdaptableInfo)('Excel Disconnected');
+            this.adaptable.logger.info('Excel Disconnected');
             this.excelConnected = false;
             this.initialisingExcel = null;
             this.workbookName = undefined;
@@ -78,7 +77,7 @@ class OpenFinService {
             fin.desktop.Excel.removeEventListener('workbookAdded', this.onWorkbookAdded);
             fin.desktop.ExcelService.removeEventListener('excelConnected', this.onExcelConnected);
             fin.desktop.ExcelService.removeEventListener('excelDisconnected', this.onExcelDisconnected);
-            (0, logger_1.LogAdaptableInfo)('Excel closed stopping all Live Excel');
+            this.adaptable.logger.info('Excel closed stopping all Live Excel');
             this.getOpenFinApi().stopLiveData();
         };
         this.initialisingExcel = null;
@@ -122,7 +121,7 @@ class OpenFinService {
                     // since  getWorkbookByName only works after getWorkbooks was called
                     return fin.desktop.Excel.getWorkbooks().then(() => {
                         this.workbookName = workbook.name;
-                        (0, logger_1.LogAdaptableInfo)('added workbook', this.workbookName);
+                        this.adaptable.logger.info('added workbook', this.workbookName);
                         return workbook;
                     });
                 });
@@ -177,13 +176,13 @@ class OpenFinService {
                 const workBookName = workbook.name;
                 let workBook = fin.desktop.Excel.getWorkbookByName(workBookName);
                 if (!workBook) {
-                    (0, logger_1.LogAdaptableError)('Cannot find workbook:' + workBookName);
+                    this.adaptable.logger.error('Cannot find workbook:' + workBookName);
                     reject('Cannot find workbook:' + workBookName);
                     return;
                 }
                 this.getActiveWorksheet()
                     .then((worksheet) => {
-                    (0, logger_1.LogAdaptableInfo)('Got active workheet', worksheet);
+                    this.adaptable.logger.info('Got active workheet', worksheet);
                     this.onWorksheetSetData(worksheet, result);
                     if (clear) {
                         worksheet.clearAllCells(() => {
@@ -228,13 +227,13 @@ class OpenFinService {
             return fin.desktop.ExcelService.init();
         })
             .then(() => {
-            (0, logger_1.LogAdaptableSuccess)('Excel initialized, now connecting');
+            this.adaptable.logger.success('Excel initialized, now connecting');
             fin.desktop.Excel.run();
             return true;
         })
             .then(() => {
             return fin.desktop.Excel.getConnectionStatus().then((connected) => {
-                (0, logger_1.LogAdaptableSuccess)('Excel status', {
+                this.adaptable.logger.success('Excel status', {
                     initialized: fin.desktop.ExcelService.initialized,
                     connected,
                 });

package/src/Utilities/Services/setup.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setup = void 0;
-const logger_1 = require("../../logger");
+const AdaptableLogger_1 = require("@adaptabletools/adaptable/src/agGrid/AdaptableLogger");
 const setup = async () => {
     const excelAssetAlias = 'excel-api-addin';
     const excelServiceUuid = '886834D1-4651-4872-996C-7B2578E953B9';
@@ -12,11 +12,11 @@ const setup = async () => {
         let serviceIsRunning = await isServiceRunning();
         let assetInfo = await getAppAssetInfo();
         if (serviceIsRunning) {
-            (0, logger_1.LogAdaptableInfo)('Service Already Running: Skipping Deployment and Registration');
+            AdaptableLogger_1.AdaptableLogger.consoleLogBase('Service Already Running: Skipping Deployment and Registration');
             return;
         }
         if (assetInfo.version === localStorage.installedAssetVersion && !assetInfo.forceDownload) {
-            (0, logger_1.LogAdaptableInfo)('Current Add-In version previously installed: Skipping Deployment and Registration');
+            AdaptableLogger_1.AdaptableLogger.consoleLogBase('Current Add-In version previously installed: Skipping Deployment and Registration');
         }
         else {
             await deploySharedAssets();
@@ -58,7 +58,7 @@ const setup = async () => {
                     target: servicePath,
                     arguments: `-d "${installFolder}" -c ${manifest.runtime.version}`,
                     listener: (result) => {
-                        (0, logger_1.LogAdaptableInfo)(`Asset Deployment completed! Exit Code: ${result.exitCode}`);
+                        AdaptableLogger_1.AdaptableLogger.consoleLogBase(`Asset Deployment completed! Exit Code: ${result.exitCode}`);
                         resolve();
                     },
                 }, () => console.log('Deploying Shared Assets'), (err) => reject(err));
@@ -72,14 +72,14 @@ const setup = async () => {
                 arguments: `-i "${installFolder}"`,
                 listener: (result) => {
                     if (result.exitCode === 0) {
-                        (0, logger_1.LogAdaptableInfo)('Add-In Installed');
+                        AdaptableLogger_1.AdaptableLogger.consoleLogBase('Add-In Installed');
                     }
                     else {
-                        (0, logger_1.LogAdaptableWarning)(`Installation failed. Exit code: ${result.exitCode}`);
+                        AdaptableLogger_1.AdaptableLogger.consoleWarnBase(`Installation failed. Exit code: ${result.exitCode}`);
                     }
                     resolve();
                 },
-            }, () => (0, logger_1.LogAdaptableInfo)('Installing Add-In'), (err) => reject(err));
+            }, () => AdaptableLogger_1.AdaptableLogger.consoleLogBase('Installing Add-In'), (err) => reject(err));
         });
     }
     function startExcelService() {
@@ -98,7 +98,7 @@ const setup = async () => {
                     arguments: '-p ' + details.port,
                     uuid: excelServiceUuid,
                 }, (process) => {
-                    (0, logger_1.LogAdaptableInfo)('Service Launched: ' + process.uuid);
+                    AdaptableLogger_1.AdaptableLogger.consoleLogBase('Service Launched: ' + process.uuid);
                 }, (error) => {
                     reject('Error starting Excel service');
                 });

package/src/logger.d.ts

@@ -1 +0,0 @@
-export declare const LogAdaptableError: (message: string, ...optionalParams: any[]) => void, LogAdaptableInfo: (message: string, ...optionalParams: any[]) => void, LogAdaptableSuccess: (message: string, ...optionalParams: any[]) => void, LogAdaptableWarning: (message: string, ...optionalParams: any[]) => void;

package/src/logger.js

@@ -1,6 +0,0 @@
-"use strict";
-var _a;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogAdaptableWarning = exports.LogAdaptableSuccess = exports.LogAdaptableInfo = exports.LogAdaptableError = void 0;
-const LoggingHelper_1 = require("@adaptabletools/adaptable/src/Utilities/Helpers/LoggingHelper");
-_a = (0, LoggingHelper_1.getLoggingFunctions)('openfin'), exports.LogAdaptableError = _a.LogAdaptableError, exports.LogAdaptableInfo = _a.LogAdaptableInfo, exports.LogAdaptableSuccess = _a.LogAdaptableSuccess, exports.LogAdaptableWarning = _a.LogAdaptableWarning;