@adaptabletools/adaptable-plugin-openfin 22.1.1 → 23.0.0-canary.1

package/package.json

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

package/src/Module/OpenFinModule.js

@@ -266,9 +266,15 @@ export class OpenFinModule extends AdaptableModuleBase {
                     }
                     if (pluginOptions.onValidationFailureInExcel === 'show-notification' ||
                         pluginOptions.onValidationFailureInExcel === 'show-undo-notification') {
-                        const textPredicate = this.adaptable.api.columnScopeApi.getScopeDescription(failedValidationRules[0].Scope) +
+                        const failedRule = failedValidationRules[0];
+                        const predicateText = 'Rule' in failedRule && failedRule.Rule.Predicates
+                            ? failedRule.Rule.Predicates.map((predicate) => this.adaptable.api.predicateApi.predicateToString(predicate)).join(' AND ')
+                            : '';
+                        const textPredicate = ('Scope' in failedRule
+                            ? this.adaptable.api.columnScopeApi.getScopeDescription(failedRule.Scope)
+                            : '') +
                             ' ' +
-                            failedValidationRules[0].Rule?.Predicates.map((predicate) => this.adaptable.api.predicateApi.predicateToString(predicate)).join(' AND ');
+                            predicateText;
                         const info = { ...dataChangedInfos[0] };
                         delete info.rowNode;
                         const alertOptions = this.api.optionsApi.getAlertOptions();
@@ -300,7 +306,9 @@ export class OpenFinModule extends AdaptableModuleBase {
                                 Scope: {
                                     All: true,
                                 },
-                                Rule: { Predicates: failedValidationRules[0].Rule?.Predicates },
+                                Rule: {
+                                    Predicates: 'Rule' in failedRule ? failedRule.Rule.Predicates : [],
+                                },
                                 AlertForm: {
                                     Buttons: pluginOptions.onValidationFailureInExcel === 'show-undo-notification'
                                         ? [

package/src/OpenFinApiImpl.d.ts

@@ -2,7 +2,7 @@ import { ApiBase } from '@adaptabletools/adaptable/src/Api/Implementation/ApiBas
 import { OpenFinApi } from '@adaptabletools/adaptable/src/Api/OpenFinApi';
 import { OpenFinPluginOptions } from '@adaptabletools/adaptable/src/AdaptableOptions/OpenFinPluginOptions';
 import { AdaptableAlert } from '@adaptabletools/adaptable';
-import { OpenFinReport, OpenFinSchedule, OpenFinState } from '@adaptabletools/adaptable/src/AdaptableState/OpenFinState';
+import { OpenFinReport, OpenFinState } from '@adaptabletools/adaptable/src/AdaptableState/OpenFinState';
 import { IAdaptable } from '@adaptabletools/adaptable/src/AdaptableInterfaces/IAdaptable';
 export declare class OpenFinApiImpl extends ApiBase implements OpenFinApi {
     private options;
@@ -17,7 +17,6 @@ export declare class OpenFinApiImpl extends ApiBase implements OpenFinApi {
     clearOpenFinInternalState(): void;
     getOpenFinThrottleTime(): number | undefined;
     getCurrentLiveOpenFinReport(): OpenFinReport | undefined;
-    getOpenFinSchedules(): OpenFinSchedule[];
     startLiveData(OpenFinReport: OpenFinReport): void;
     stopLiveData(): void;
 }

package/src/OpenFinApiImpl.js

@@ -4,6 +4,7 @@ import * as OpenFinRedux from './Redux/ActionReducers/OpenFinRedux';
 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/alertFormHelper';
 // 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
@@ -77,10 +78,8 @@ export class OpenFinApiImpl extends ApiBase {
                 AlertId: alert.Uuid,
             },
         };
-        const alertForm = typeof alert.alertDefinition.AlertForm === 'string'
-            ? null
-            : alert.alertDefinition.AlertForm ||
-                this.getAlertApi().internalApi.getDefaultAlertNotificationForm();
+        const resolvedForm = resolveAlertFormForDefinition(alert.alertDefinition, this.getAlertApi().internalApi.getDefaultAlertNotificationForm());
+        const alertForm = typeof resolvedForm === 'string' ? null : resolvedForm;
         if (alertForm && alertForm?.Buttons) {
             notification.buttons = alertForm.Buttons.map((button) => {
                 const { ButtonStyle: buttonStyle } = button;
@@ -136,9 +135,6 @@ export class OpenFinApiImpl extends ApiBase {
     getCurrentLiveOpenFinReport() {
         return this.getAdaptableState().Internal.CurrentLiveOpenFinReport;
     }
-    getOpenFinSchedules() {
-        return this.getAdaptableState().Schedule.OpenFinSchedules || [];
-    }
     startLiveData(OpenFinReport) {
         if (this.checkItemExists(OpenFinReport, OpenFinReport.ReportName, 'OpenFin Report')) {
             this.dispatchAction(OpenFinRedux.OpenFinStartLiveData(OpenFinReport));

package/src/View/OpenFinPopup.js

@@ -1,3 +1,4 @@
+import { jsx as _jsx } from "react/jsx-runtime";
 import * as React from 'react';
 import { connect } from 'react-redux';
 import { PanelWithButton } from '@adaptabletools/adaptable/src/View/Components/Panels/PanelWithButton';
@@ -14,7 +15,7 @@ const OpenFinPopupComponent = (props) => {
     // const onApplyExport = (OpenFinReport: OpenFinReport) => {
     //   props.onOpenFinSendSnapshot(OpenFinReport);
     // };
-    return (React.createElement(PanelWithButton, { headerText: props.moduleInfo.FriendlyName, bodyProps: { className: 'twa:p-0' }, glyphicon: props.moduleInfo.Glyph, infoLink: props.moduleInfo.HelpPage, infoLinkDisabled: !props.api.internalApi.isDocumentationLinksDisplayed() }));
+    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) {
     return {};

package/src/View/OpenFinViewPanel.d.ts

@@ -1,7 +1,6 @@
 import { ViewPanelProps } from '@adaptabletools/adaptable/src/View/Components/SharedProps/ViewPanelProps';
 import { OpenFinReport } from '@adaptabletools/adaptable/src/AdaptableState/OpenFinState';
 import * as OpenFinRedux from '../Redux/ActionReducers/OpenFinRedux';
-import * as PopupRedux from '@adaptabletools/adaptable/src/Redux/ActionsReducers/PopupRedux';
 import { AdaptableColumn } from '@adaptabletools/adaptable/src/AdaptableState/Common/AdaptableColumn';
 import { Report } from '@adaptabletools/adaptable/src/AdaptableState/ExportState';
 import * as React from 'react';
@@ -11,7 +10,6 @@ import { ConnectedComponent } from 'react-redux';
 export interface OpenFinViewPanelComponentProps extends ViewPanelProps {
     onOpenFinStartLiveData: (OpenFinreport: OpenFinReport) => OpenFinRedux.OpenFinStartLiveDataAction;
     onOpenFinStopLiveData: (OpenFinreport: OpenFinReport) => OpenFinRedux.OpenFinStopLiveDataAction;
-    onNewOpenFinSchedule: () => PopupRedux.PopupShowScreenAction;
     Columns: AdaptableColumn[];
     Reports: Report[] | undefined;
     CurrentLiveOpenFinReport: OpenFinReport | undefined;
@@ -28,7 +26,6 @@ declare class OpenFinViewPanelComponent extends React.Component<OpenFinViewPanel
     render(): any;
     onSelectedReportChanged(reportName: string): void;
     private onOpenFinStartLiveData;
-    private onNewOpenFinSchedule;
     private createOpenFinReportFromState;
 }
 export declare const OpenFinViewPanelControl: ConnectedComponent<typeof OpenFinViewPanelComponent, Pick<React.ClassAttributes<OpenFinViewPanelComponent> & OpenFinViewPanelComponentProps, never>>;

package/src/View/OpenFinViewPanel.js

@@ -1,17 +1,12 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import * as OpenFinRedux from '../Redux/ActionReducers/OpenFinRedux';
-import * as PopupRedux from '@adaptabletools/adaptable/src/Redux/ActionsReducers/PopupRedux';
 import { isRunningInOpenfin } from '../Utilities/isRunningInOpenfin';
 import * as React from 'react';
-import * as GeneralConstants from '@adaptabletools/adaptable/src/Utilities/Constants/GeneralConstants';
 import { StringExtensions } from '@adaptabletools/adaptable/src/Utilities/Extensions/StringExtensions';
 import { Flex } from '@adaptabletools/adaptable/src/components/Flex';
 import Dropdown from '@adaptabletools/adaptable/src/components/Dropdown';
 import { ButtonPause } from '@adaptabletools/adaptable/src/View/Components/Buttons/ButtonPause';
 import { ButtonPlay } from '@adaptabletools/adaptable/src/View/Components/Buttons/ButtonPlay';
-import join from '@adaptabletools/adaptable/src/components/utils/join';
-import { ButtonSchedule } from '@adaptabletools/adaptable/src/View/Components/Buttons/ButtonSchedule';
-import * as ModuleConstants from '@adaptabletools/adaptable/src/Utilities/Constants/ModuleConstants';
-import { CreateEmptyOpenFinSchedule } from '@adaptabletools/adaptable/src/Utilities/ObjectFactory';
 import { connect } from 'react-redux';
 const IS_OPENFIN = isRunningInOpenfin();
 class OpenFinViewPanelComponent extends React.Component {
@@ -55,13 +50,7 @@ class OpenFinViewPanelComponent extends React.Component {
             this.props.CurrentLiveOpenFinReport &&
             this.props.currentReportName == this.props.CurrentLiveOpenFinReport.ReportName;
         const elementType = this.props.viewType === 'Toolbar' ? 'DashboardToolbar' : 'ToolPanel';
-        return (React.createElement(Flex, { flexDirection: "row", className: `ab-${elementType}__OpenFin__wrap`, flexWrap: this.props.viewType === 'ToolPanel' ? 'wrap' : 'nowrap' },
-            React.createElement(Flex, null,
-                React.createElement(Dropdown, { disabled: !IS_OPENFIN || allReports.length == 0 || isLiveOpenFinReport, options: availableReports, className: `ab-${elementType}__OpenFin__select twa:mr-2 twa:min-w-[160px]`, placeholder: !IS_OPENFIN ? 'Not available' : 'Select Report', onChange: (reportName) => this.onSelectedReportChanged(reportName), value: this.props.currentReportName, showClearButton: true })),
-            React.createElement(Flex, null,
-                isLiveOpenFinReport ? (React.createElement(ButtonPause, { fillColor: 'red', className: `ab-${elementType}__OpenFin__pause twa:ml-1`, onClick: () => this.getOpenFinApi().stopLiveData(), tooltip: "Stop sync with OpenFin", disabled: !isLiveOpenFinReport, accessLevel: this.props.accessLevel })) : (React.createElement(ButtonPlay, { className: `ab-${elementType}__OpenFin__play twa:ml-1`, onClick: () => this.onOpenFinStartLiveData(), tooltip: "Start sync with OpenFin", disabled: isLiveOpenFinReport || !isCompletedReport, accessLevel: this.props.accessLevel })),
-                React.createElement(Flex, { className: join(this.props.accessLevel == 'ReadOnly' ? GeneralConstants.READ_ONLY_STYLE : '', `ab-${elementType}__OpenFin__controls`), alignItems: "stretch" },
-                    React.createElement(ButtonSchedule, { className: `ab-${elementType}__OpenFin__schedule twa:ml-1`, onClick: () => this.onNewOpenFinSchedule(), tooltip: "Schedule", disabled: !IS_OPENFIN, accessLevel: this.props.accessLevel })))));
+        return (_jsxs(Flex, { flexDirection: "row", className: `ab-${elementType}__OpenFin__wrap`, flexWrap: this.props.viewType === 'ToolPanel' ? 'wrap' : 'nowrap', children: [_jsx(Flex, { children: _jsx(Dropdown, { disabled: !IS_OPENFIN || allReports.length == 0 || isLiveOpenFinReport, options: availableReports, className: `ab-${elementType}__OpenFin__select twa:mr-2 twa:min-w-[160px]`, placeholder: !IS_OPENFIN ? 'Not available' : 'Select Report', onChange: (reportName) => this.onSelectedReportChanged(reportName), value: this.props.currentReportName, showClearButton: true }) }), _jsx(Flex, { children: isLiveOpenFinReport ? (_jsx(ButtonPause, { fillColor: 'red', className: `ab-${elementType}__OpenFin__pause twa:ml-1`, onClick: () => this.getOpenFinApi().stopLiveData(), tooltip: "Stop sync with OpenFin", disabled: !isLiveOpenFinReport, accessLevel: this.props.accessLevel })) : (_jsx(ButtonPlay, { className: `ab-${elementType}__OpenFin__play twa:ml-1`, onClick: () => this.onOpenFinStartLiveData(), tooltip: "Start sync with OpenFin", disabled: isLiveOpenFinReport || !isCompletedReport, accessLevel: this.props.accessLevel })) })] }));
     }
     onSelectedReportChanged(reportName) {
         if (reportName == undefined) {
@@ -72,14 +61,6 @@ class OpenFinViewPanelComponent extends React.Component {
     onOpenFinStartLiveData() {
         this.getOpenFinApi().startLiveData(this.createOpenFinReportFromState());
     }
-    onNewOpenFinSchedule() {
-        // let OpenFinSchedule: OpenFinSchedule = {
-        //   ...ObjectFactory.CreateEmptyBaseSchedule(ScheduleType.OpenFin),
-        //   OpenFinReport: this.createOpenFinReportFromState(),
-        //   Transmission: 'Live Data',
-        // };
-        this.props.onNewOpenFinSchedule();
-    }
     // perhaps this should be props and in real state?
     createOpenFinReportFromState() {
         return {
@@ -97,11 +78,6 @@ function mapStateToProps(state) {
 }
 function mapDispatchToProps(dispatch) {
     return {
-        onNewOpenFinSchedule: () => dispatch(PopupRedux.PopupShowScreen(ModuleConstants.ScheduleModuleId, 'SchedulePopup', {
-            action: 'New',
-            source: 'Other',
-            value: CreateEmptyOpenFinSchedule(),
-        })),
         onCurrentReportNameChange: (reportName) => dispatch(OpenFinRedux.OpenFinSetCurrentReportName(reportName)),
     };
 }

package/src/index.js

@@ -46,6 +46,7 @@ class OpenFinPlugin extends AdaptablePlugin {
         adaptable.api.eventApi.on('AlertFired', (alertFiredInfo) => {
             if (this.options.showAdaptableAlertsAsNotifications) {
                 if (!alertFiredInfo.alert.alertDefinition.AlertProperties.DisplayNotification &&
+                    'AlertForm' in alertFiredInfo.alert.alertDefinition &&
                     typeof alertFiredInfo.alert.alertDefinition.AlertForm === 'string') {
                     // bail out early for dynamic forms
                     return;