@adaptabletools/adaptable-plugin-openfin 22.0.0-canary.6 → 22.0.0-canary.8

package/package.json

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

package/src/Module/OpenFinModule.js

@@ -61,21 +61,20 @@ export class OpenFinModule extends AdaptableModuleBase {
                 throw new Error('Invalid report data format');
             })
                 .then(() => {
-                this.adaptable.logger.success('All live report data sent');
+                this.adaptable.logger.success('Live report data sent successfully.');
                 this.isSendingData = false;
                 return this.api.exportApi.internalApi.publishLiveLiveDataChangedEvent('OpenFin', 'LiveDataUpdated', currentLiveOpenFinReport);
             })
                 .catch((reason) => {
                 this.isSendingData = false;
-                this.adaptable.logger.warn('Failed to send data to OpenFin for [' + currentLiveOpenFinReport.ReportName + ']', reason);
+                this.adaptable.logger.warn(`Failed to send data to OpenFin for report "${currentLiveOpenFinReport.ReportName}".`, reason);
                 this.getOpenFinApi().stopLiveData();
-                let errorMessage = 'Export Failed';
+                let errorMessage = 'Export failed';
                 if (reason) {
                     errorMessage += ': ' + reason;
                 }
-                errorMessage += '.  This live export has been cancelled.';
-                this.api.alertApi.showAlertError('OpenFin Export Error', errorMessage);
-                this.adaptable.logger.warn('Failed to send data');
+                errorMessage += '. The live export has been cancelled.';
+                this.api.alertApi.showAlertError('OpenFin Export', errorMessage);
             });
         }
     }
@@ -185,11 +184,11 @@ export class OpenFinModule extends AdaptableModuleBase {
                                     return resolve({ ignore: true });
                                 }
                                 if (columnIsPrimaryKey) {
-                                    return reject(`Cant edit a primary key column`);
+                                    return reject('Cannot edit a primary key column.');
                                     // return resolve({ ignore: true });
                                 }
                                 if (this.api.columnApi.getColumnWithColumnId(columnId).readOnly) {
-                                    const msg = `Can't update column ${columnId} as it is read-only`;
+                                    const msg = `Cannot update column "${columnId}" — it is read-only.`;
                                     this.adaptable.logger.warn(msg);
                                     return reject(msg);
                                     // return resolve({ ignore: true });
@@ -293,7 +292,7 @@ export class OpenFinModule extends AdaptableModuleBase {
                             alertType: 'cellChanged',
                             cellDataChangedInfo: info,
                             alertDefinition: {
-                                Name: 'Excel Validation failed',
+                                Name: 'Excel Validation Failed',
                                 AlertProperties: {
                                     DisplayNotification: true,
                                 },
@@ -306,14 +305,14 @@ export class OpenFinModule extends AdaptableModuleBase {
                                     Buttons: pluginOptions.onValidationFailureInExcel === 'show-undo-notification'
                                         ? [
                                             {
-                                                Label: 'Undo change',
+                                                Label: 'Undo Change',
                                                 Command: 'openfin-plugin:excel-undo',
                                             },
                                         ]
                                         : [],
                                 },
                             },
-                            header: 'Excel Validation failed',
+                            header: 'Excel Validation Failed',
                             message: textPredicate,
                         });
                     }

package/src/Utilities/Services/OpenFinService.js

@@ -23,25 +23,25 @@ export class OpenFinService {
     onWorkbookRemoved = (event) => {
         event.workbook.removeEventListener('workbookActivated', this.onWorkbookActivated);
         const { workbook } = event;
-        this.adaptable.logger.info('Workbook closed:' + workbook.name + ', Stopping Openfin Live Excel');
+        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);
+        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);
+        this.adaptable.logger.info('Workbook activated: ' + event.target.name);
         event.target.getWorksheets((ack) => {
-            this.adaptable.logger.info('getWorksheets:', ack);
+            this.adaptable.logger.info('Retrieved worksheets.', ack);
         });
     };
     onWorkbookAdded = (event) => {
-        this.adaptable.logger.success('Workbook Added: ' + event.workbook.name);
+        this.adaptable.logger.success('Workbook added: ' + event.workbook.name);
         let workbook = event.workbook;
         workbook.addEventListener('workbookActivated', this.onWorkbookActivated);
     };
@@ -52,7 +52,7 @@ export class OpenFinService {
                     // since  getWorkbookByName only works after getWorkbooks was called
                     return fin.desktop.Excel.getWorkbooks().then(() => {
                         this.workbookName = workbook.name;
-                        this.adaptable.logger.info('added workbook', this.workbookName);
+                        this.adaptable.logger.info('Workbook created.', this.workbookName);
                         return workbook;
                     });
                 });
@@ -122,13 +122,13 @@ export class OpenFinService {
                 const workBookName = workbook.name;
                 let workBook = fin.desktop.Excel.getWorkbookByName(workBookName);
                 if (!workBook) {
-                    this.adaptable.logger.error('Cannot find workbook:' + workBookName);
-                    reject('Cannot find workbook:' + workBookName);
+                    this.adaptable.logger.error('Cannot find workbook: ' + workBookName);
+                    reject('Cannot find workbook: ' + workBookName);
                     return;
                 }
                 this.getActiveWorksheet()
                     .then((worksheet) => {
-                    this.adaptable.logger.info('Got active workheet', worksheet);
+                    this.adaptable.logger.info('Active worksheet retrieved.', worksheet);
                     this.onWorksheetSetData(worksheet, result);
                     if (clear) {
                         worksheet.clearAllCells(() => {
@@ -161,13 +161,13 @@ export class OpenFinService {
         this.excelConnected = true;
         this.connectedCallbacks.forEach((fn) => fn());
         this.connectedCallbacks.length = 0;
-        this.adaptable.logger.success('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);
     };
     onExcelDisconnected = () => {
-        this.adaptable.logger.info('Excel Disconnected');
+        this.adaptable.logger.info('Excel disconnected.');
         this.excelConnected = false;
         this.initialisingExcel = null;
         this.workbookName = undefined;
@@ -177,7 +177,7 @@ export class OpenFinService {
         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.adaptable.logger.info('Excel closed. Stopping all Live Excel connections.');
         this.getOpenFinApi().stopLiveData();
     };
     initialisingExcel = null;
@@ -197,13 +197,13 @@ export class OpenFinService {
             return fin.desktop.ExcelService.init();
         })
             .then(() => {
-            this.adaptable.logger.success('Excel initialized, now connecting');
+            this.adaptable.logger.success('Excel initialized. Connecting...');
             fin.desktop.Excel.run();
             return true;
         })
             .then(() => {
             return fin.desktop.Excel.getConnectionStatus().then((connected) => {
-                this.adaptable.logger.success('Excel status', {
+                this.adaptable.logger.success('Excel connection status:', {
                     initialized: fin.desktop.ExcelService.initialized,
                     connected,
                 });
@@ -221,7 +221,7 @@ export class OpenFinService {
         let startTime = Date.now();
         const poolForExcel = (callback) => {
             if (Date.now() - startTime > 20000) {
-                console.error(`Could not find any Excel instance.`);
+                console.error('Could not find any Excel instance within timeout.');
                 return callback();
             }
             if (!fin.desktop.Excel || !fin.desktop.Excel.getWorkbooks) {

package/src/Utilities/Services/setup.js

@@ -9,11 +9,11 @@ export const setup = async () => {
         let serviceIsRunning = await isServiceRunning();
         let assetInfo = await getAppAssetInfo();
         if (serviceIsRunning) {
-            AdaptableLogger.consoleLogBase('Service Already Running: Skipping Deployment and Registration');
+            AdaptableLogger.consoleLogBase('Excel service already running. Skipping deployment and registration.');
             return;
         }
         if (assetInfo.version === localStorage.installedAssetVersion && !assetInfo.forceDownload) {
-            AdaptableLogger.consoleLogBase('Current Add-In version previously installed: Skipping Deployment and Registration');
+            AdaptableLogger.consoleLogBase('Current Add-In version already installed. Skipping deployment and registration.');
         }
         else {
             await deploySharedAssets();
@@ -55,10 +55,10 @@ export const setup = async () => {
                     target: servicePath,
                     arguments: `-d "${installFolder}" -c ${manifest.runtime.version}`,
                     listener: (result) => {
-                        AdaptableLogger.consoleLogBase(`Asset Deployment completed! Exit Code: ${result.exitCode}`);
+                        AdaptableLogger.consoleLogBase(`Asset deployment completed (exit code: ${result.exitCode}).`);
                         resolve();
                     },
-                }, () => console.log('Deploying Shared Assets'), (err) => reject(err));
+                }, () => console.log('Deploying shared assets...'), (err) => reject(err));
             });
         });
     }
@@ -69,14 +69,14 @@ export const setup = async () => {
                 arguments: `-i "${installFolder}"`,
                 listener: (result) => {
                     if (result.exitCode === 0) {
-                        AdaptableLogger.consoleLogBase('Add-In Installed');
+                        AdaptableLogger.consoleLogBase('Add-In installed successfully.');
                     }
                     else {
-                        AdaptableLogger.consoleWarnBase(`Installation failed. Exit code: ${result.exitCode}`);
+                        AdaptableLogger.consoleWarnBase(`Add-In installation failed (exit code: ${result.exitCode}).`);
                     }
                     resolve();
                 },
-            }, () => AdaptableLogger.consoleLogBase('Installing Add-In'), (err) => reject(err));
+            }, () => AdaptableLogger.consoleLogBase('Installing Add-In...'), (err) => reject(err));
         });
     }
     function startExcelService() {
@@ -95,9 +95,9 @@ export const setup = async () => {
                     arguments: '-p ' + details.port,
                     uuid: excelServiceUuid,
                 }, (process) => {
-                    AdaptableLogger.consoleLogBase('Service Launched: ' + process.uuid);
+                    AdaptableLogger.consoleLogBase('Excel service launched: ' + process.uuid);
                 }, (error) => {
-                    reject('Error starting Excel service');
+                    reject('Failed to start Excel service.');
                 });
             });
         });

package/src/excel-service/ExcelApi.js

@@ -156,7 +156,7 @@ class ExcelService extends RpcDispatcher_1.RpcDispatcher {
             }
           }
         }
-        this.logger.info(this.loggerName + ': Initialised called.');
+        this.logger.info(this.loggerName + ': Initialize called.');
         this.logger.debug(this.loggerName + ': Subscribing to Service Messages.');
         yield this.subscribeToServiceMessages();
         this.logger.debug(
@@ -181,7 +181,7 @@ class ExcelService extends RpcDispatcher_1.RpcDispatcher {
           }
           this.logger.warn(
             this.loggerName +
-              ': Error connecting or fetching version to/from provider. The version of the provider is likely older than the script version.',
+              ': Failed to connect to or fetch version from provider. The provider version may be older than the script version.',
             errorMessage
           );
         }

package/src/excel-service/ExcelApplication.js

@@ -237,11 +237,11 @@ class ExcelApplication extends RpcDispatcher_1.RpcDispatcher {
     return __awaiter(this, void 0, void 0, function* () {
       this.logger.info(this.loggerName + ': Init called.');
       if (!this.initialized) {
-        this.logger.info(this.loggerName + ': Not initialised...Initialising.');
+        this.logger.info(this.loggerName + ': Not initialized. Initializing...');
         yield this.subscribeToExcelMessages();
         yield this.monitorDisconnect();
         this.initialized = true;
-        this.logger.info(this.loggerName + ': initialised.');
+        this.logger.info(this.loggerName + ': Initialized.');
       }
       return;
     });
@@ -250,7 +250,7 @@ class ExcelApplication extends RpcDispatcher_1.RpcDispatcher {
     return __awaiter(this, void 0, void 0, function* () {
       this.logger.info(this.loggerName + ': Release called.');
       if (this.initialized) {
-        this.logger.info(this.loggerName + ': Calling unsubscribe as we are currently intialised.');
+        this.logger.info(this.loggerName + ': Unsubscribing from Excel messages.');
         yield this.unsubscribeToExcelMessages();
         //TODO: Provide external means to stop monitoring disconnect
       }

package/src/excel-service/ExcelRtd.js

@@ -72,7 +72,7 @@ class ExcelRtd extends EventEmitter_1.EventEmitter {
       } catch (err) {
         this.logger.warn(
           this.loggerName +
-            `: The excelRtd/${this.providerName} channel already exists. You can only have one instance of a connection for a provider to avoid confusion. It may be you have multiple instances or another window or application has created a provider with the same name.`,
+            `: The excelRtd/${this.providerName} channel already exists. Only one connection instance per provider is allowed. Another window or application may have created a provider with the same name.`,
           err
         );
         return;
@@ -133,7 +133,7 @@ class ExcelRtd extends EventEmitter_1.EventEmitter {
             // without a catch the rest of the initialisation would be broken
             this.logger.warn(
               this.loggerName +
-                `: The excelRtd/${this.providerName} channel could not be destroyed during cleanup.`,
+                `: Failed to destroy excelRtd/${this.providerName} channel during cleanup.`,
               err
             );
           }

package/src/excel-service/RpcDispatcher.js

@@ -77,7 +77,7 @@ class RpcDispatcher extends EventEmitter_1.EventEmitter {
           return result;
         })
         .catch((err) => {
-          this.logger.error('unable to apply callback to promise', err);
+          this.logger.error('Failed to apply callback to promise.', err);
         });
       promise = undefined;
     }

package/src/index.js

@@ -16,11 +16,7 @@ const { version, name } = packageJson;
 const { version: coreVersion } = adaptableCorePackageJson;
 const suffix = name.endsWith('-cjs') ? '-cjs' : '';
 if (version !== coreVersion) {
-    console.warn(`
-!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-!!!!!!! "@adaptabletools/adaptable-plugin-openfin${suffix}" (v @${version}) and "@adaptabletools/adaptable${suffix}" (v @${coreVersion}) have different versions - they should have the exact same version.
-!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-`);
+    console.warn(`Version mismatch: "@adaptabletools/adaptable-plugin-openfin${suffix}" (v${version}) and "@adaptabletools/adaptable${suffix}" (v${coreVersion}) have different versions. They should be the exact same version.`);
 }
 const defaultOptions = {
     throttleTime: 2000,