@adaptabletools/adaptable-plugin-ipushpull-cjs 17.0.0-canary.1

package/README.md

@@ -0,0 +1,113 @@
+# AdapTable ipushpull Plugin Read Me
+
+The ipushpull plugin connects AdapTable with [ipushpull](https://www.ipushpull.com) the market-leading collaborative software.
+
+It allows user to send Reports - either System Reports shipped by AdapTable or those created via the AdapTable Export function - to ipushpull and from their to Symphony and other destinations.
+
+## Version 7 
+Version 7 of AdapTable made significant changes to how ipushpull is set up, primarily by using this dedicated plugin.
+
+As a consequence, the ipushpull section from Predefined Config was removed and no ipushpull information is provided by users that way.
+
+Similarly all ipushpull state is now transient and **not persisted** when the application ends.
+
+Instead we now use the `ipushpullPluginOptions` object in a similar way to other plugins. 
+
+The actual ipushpull functionality is unchanged, and the information required to be supplied by the user is identical but it now done through Options and not Predefined Config - isolating it in this way enables us to add more ipushpull-related functionality in a much quicker and safer way, isolated from the rest of the application.
+
+## ipushpull Options
+
+The ipushpull plugin contains an `ipushpullPluginOptions` object which allows users to set up their instance.
+
+It contains credential details, useful properties (e.g. `throttleTime`, `autoLogin` etc.) and the ipupshpull config object.
+
+## ipushpull Api
+
+The `ipushpullApi` is available for full runtime programmatic access to ipushpull objects and methods.
+
+> Note: because ipushpull is a plugin, you can get hold of this object through the `getPluginApi` method of pluginsApi.
+
+## ipushpull Setup Example
+ 
+  ```ts
+  
+  // set up AdaptableOptions
+  const adaptableOptions: AdaptableOptions = {
+     ******
+      plugins: [
+      ipp({
+          username: process.env.IPUSHPULL_USERNAME,
+          password: process.env.IPUSHPULL_PASSWORD,
+          throttleTime: 5000,
+          includeSystemReports: true,
+          ippConfig: {
+             api_secret: process.env.IPUSHPULL_API_KEY,
+             api_key: process.env.IPUSHPULL_API_KEY,
+             api_url: 'https://www.ipushpull.com/api/1.0',
+             ws_url: 'https://www.ipushpull.com',
+             web_url: 'https://www.ipushpull.com',
+             docs_url: 'https://docs.ipushpull.com',
+             storage_prefix: 'ipp_local',
+             transport: 'polling',
+             hsts: false, // strict cors policy
+         },
+       }),
+     ],
+    ******
+   };
+   
+  // Instantitate AdapTable and get the main Api object 
+  adaptableApi = await Adaptable.init(adaptableOptions);
+  
+  // use the plugins api to get the IPushPullApi object
+  const ipushpullApi: IPushPullApi = adaptableApi.pluginsApi.getPluginApi(
+    'ipushpull'
+  );
+  
+ ```
+
+## ipushpull Toolbar
+
+The ipushpull plugin includes a dedicated ipushpull Toolbar - the main way to interact with ipushpull inside AdapTable.
+
+At start-up this simply displays a login button that, when clicked, opens a login screen asking for username and password.
+
+> There is a `AutoLogin` property option which will automatically log the user in to ipushpull (if the correct credentials have been provided in ipushpull Plugin Options).
+
+Once the user is successfully logged in, the Toolbar will contain a number of elements (primarily dropdowns and buttons). These include:
+
+### Dropdowns
+
+1. **Reports Dropdown** - this shows all the Reports that have been created via the Export function.
+    > This dropdown will also include any System Reports that AdapTable ships by default (e.g. Selected Cells); however these can be removed by setting `IncludeSystemReports` to false
+
+2. **Folders Dropdown** - lists all the folders (aka 'Domains') to which the user has access in ipushpull
+
+3. **Pages Dropdown** - lists all the ipushpull pages in the currently selected Folder (in the Folders Dropdown).
+
+### Buttons
+
+1. **Send Snapshot** - this will run the current report and send the data to the currently selected ipushpull page.  This is a **one-off** action.
+
+2. **Run Live Report** - this will run the current report and send the data to the currently selected ipushpull page.  It will also send live updates so as the data in the grid ticks and the report updaes, ipushpull will be updated in real time.
+   > The button displays a 'Play' icon; however, when a Live Report is running this changes to a 'Pause' icon.
+
+3. **New ipushpull Page** - alllows the user to create a new ipushpull page in the folder of his choice.
+
+4. **Create Schedule** - enables an ipushpull report to be sent at a schedule of the user's choice
+   >This leverages AdapTable Scheduling which enables actions to be performed either at a one off date and time or to be repeated daily at a scheduled time.  
+
+5. **Logout Button** - logs the User out of ipushpull (and displays the login button).
+
+
+## Help
+
+Developers can learn how to access AdapTable programmatically at [AdapTable Documentation](https://docs.adaptabletools.com).
+
+## More Information
+
+General information about Adaptable Tools is available at our [Website](http://www.adaptabletools.com) 
+
+## Support
+
+For all support enquiries please email [`support@adaptabletools.com`](mailto:support@adaptabletools.com) or [raise a Support Ticket](https://adaptabletools.zendesk.com/hc/en-us/requests/new).

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@adaptabletools/adaptable-plugin-ipushpull-cjs",
+  "version": "17.0.0-canary.1",
+  "description": "",
+  "homepage": "http://www.adaptabletools.com/",
+  "author": {
+    "name": "Jonny Wolfson",
+    "email": "jonny.wolfson@adaptabletools.com"
+  },
+  "main": "src/index.js",
+  "typings": "src/index.d.ts",
+  "dependencies": {
+    "ipushpull-js": "^2.25.0",
+    "lodash": "^4.17.15",
+    "prop-types": "^15.6.2",
+    "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
+    "react-redux": "7.2.8",
+    "rebass": "^3.2.2",
+    "redux": "4.0.5",
+    "styled-components": "^4.4.1",
+    "tslib": "^2.3.0",
+    "@adaptabletools/adaptable-cjs": "17.0.0-canary.1"
+  },
+  "peerDependencies": {}
+}

package/src/IPushPullApiImpl.d.ts

@@ -0,0 +1,47 @@
+import { ApiBase } from '@adaptabletools/adaptable/src/Api/Implementation/ApiBase';
+import { IPushPullDomain, IPushPullReport, IPushPullSchedule } from '@adaptabletools/adaptable/src/PredefinedConfig/IPushPullState';
+import { IPushPullApi } from '@adaptabletools/adaptable/src/Api/IPushPullApi';
+import { IPushPullPluginOptions } from '@adaptabletools/adaptable/src/AdaptableOptions/IPushPullPluginOptions';
+import { IAdaptable } from '@adaptabletools/adaptable/src/AdaptableInterfaces/IAdaptable';
+export declare class IPushPullApiImpl extends ApiBase implements IPushPullApi {
+    private ippInstance;
+    private ippService;
+    private options;
+    constructor(adaptable: IAdaptable, options: IPushPullPluginOptions);
+    getCurrentIPushPullUsername(): string | undefined;
+    getCurrentIPushPullPassword(): string | undefined;
+    getIPushPullUsername(): string | undefined;
+    getIPushPullPassword(): string | undefined;
+    getAutoLogin(): boolean;
+    getCurrentLiveIPushPullReport(): IPushPullReport | undefined;
+    setIPushPullInstance(ippInstance: any): void;
+    getIPushPullInstance(): any;
+    sendSnapshot(iPushPullReport: IPushPullReport): void;
+    startLiveData(iPushPullReport: IPushPullReport): void;
+    stopLiveData(): void;
+    isIPushPullReportLive(iPushPullReport: IPushPullReport): boolean;
+    isIPushPullAvailable(): boolean;
+    isIPushPullRunning(): boolean | undefined;
+    getIPushPullDomains(): IPushPullDomain[];
+    getPagesForIPushPullDomain(folderName: string): string[];
+    setIPushPullLoginErrorMessage(loginErrorMessage: string): void;
+    getFolderIdForName(folderName: string): number;
+    addNewIPushPullPage(folderName: string, pageName: string): void;
+    getIPushPullThrottleTime(): number | undefined;
+    setIPushPullThrottleTime(throttleTime: number): void;
+    setIPushPullDomains(iPushPullDomains: IPushPullDomain[]): void;
+    clearIPushPullDomains(): void;
+    getIPushPullSchedules(): IPushPullSchedule[];
+    showIPushPullPopup(): void;
+    setIPushPullAvailableOn(): void;
+    setIPushPullAvailableOff(): void;
+    setIPushPullRunningOn(): void;
+    setIPushPullRunningOff(): void;
+    isIPushPullLiveDataRunning(): boolean;
+    private getIPPService;
+    loginToIPushPull(userName: string, password: string): Promise<void>;
+    retrieveIPushPullDomainsFromIPushPull(): Promise<void>;
+    logoutFromIPushPull(): void;
+    includeSystemReports(): boolean;
+    clearIPushPullInternalState(): void;
+}

package/src/IPushPullApiImpl.js

@@ -0,0 +1,172 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IPushPullApiImpl = void 0;
+const tslib_1 = require("tslib");
+const ApiBase_1 = require("@adaptabletools/adaptable-cjs/src/Api/Implementation/ApiBase");
+const ModuleConstants = tslib_1.__importStar(require("@adaptabletools/adaptable-cjs/src/Utilities/Constants/ModuleConstants"));
+const IPushPullRedux = tslib_1.__importStar(require("./Redux/ActionReducers/IPushPullRedux"));
+const ArrayExtensions_1 = tslib_1.__importDefault(require("@adaptabletools/adaptable-cjs/src/Utilities/Extensions/ArrayExtensions"));
+const Helper_1 = tslib_1.__importDefault(require("@adaptabletools/adaptable-cjs/src/Utilities/Helpers/Helper"));
+class IPushPullApiImpl extends ApiBase_1.ApiBase {
+    constructor(adaptable, options) {
+        super(adaptable);
+        this.ippService = null;
+        this.options = options;
+    }
+    getCurrentIPushPullUsername() {
+        return this.getAdaptableState().System.CurrentIPushpullUsername;
+    }
+    getCurrentIPushPullPassword() {
+        return this.getAdaptableState().System.CurrentIPushpullPassword;
+    }
+    getIPushPullUsername() {
+        return this.options.username;
+    }
+    getIPushPullPassword() {
+        return this.options.password;
+    }
+    getAutoLogin() {
+        var _a;
+        return (_a = this.options.autoLogin) !== null && _a !== void 0 ? _a : false;
+    }
+    getCurrentLiveIPushPullReport() {
+        return this.getAdaptableState().System.CurrentLiveIPushPullReport;
+    }
+    setIPushPullInstance(ippInstance) {
+        this.ippInstance = ippInstance;
+    }
+    getIPushPullInstance() {
+        return this.ippInstance;
+    }
+    sendSnapshot(iPushPullReport) {
+        if (this.checkItemExists(iPushPullReport, iPushPullReport.ReportName, 'IPushPull Report')) {
+            this.dispatchAction(IPushPullRedux.IPushPullSendSnapshot(iPushPullReport));
+            this.adaptable.ReportService.PublishLiveLiveDataChangedEvent('ipushpull', 'SnapshotSent');
+        }
+    }
+    startLiveData(iPushPullReport) {
+        if (this.checkItemExists(iPushPullReport, iPushPullReport.ReportName, 'IPushPull Report')) {
+            this.dispatchAction(IPushPullRedux.IPushPullLiveReportSet(iPushPullReport));
+            this.adaptable.ReportService.PublishLiveLiveDataChangedEvent('ipushpull', 'LiveDataStarted', iPushPullReport);
+        }
+    }
+    stopLiveData() {
+        let currentLiveReport = this.getCurrentLiveIPushPullReport();
+        if (!currentLiveReport) {
+            return;
+        }
+        this.getIPPService().unloadPage(currentLiveReport.Page);
+        // clear the live report
+        this.dispatchAction(IPushPullRedux.IPushPullLiveReportClear());
+        // fire the Live Report event for Export Stopped
+        this.adaptable.ReportService.PublishLiveLiveDataChangedEvent('ipushpull', 'LiveDataStopped', currentLiveReport);
+    }
+    isIPushPullReportLive(iPushPullReport) {
+        if (!iPushPullReport) {
+            return false;
+        }
+        const CurrentLiveIPushPullReport = this.getCurrentLiveIPushPullReport();
+        return CurrentLiveIPushPullReport != null && CurrentLiveIPushPullReport == iPushPullReport;
+    }
+    isIPushPullAvailable() {
+        return true;
+    }
+    isIPushPullRunning() {
+        return this.getAdaptableState().System.IsIPushPullRunning;
+    }
+    getIPushPullDomains() {
+        return this.getAdaptableState().System.IPushPullDomainsPages || [];
+    }
+    getPagesForIPushPullDomain(folderName) {
+        let returnArray = [];
+        let iPushPullDomains = this.getIPushPullDomains();
+        if (ArrayExtensions_1.default.IsNotNullOrEmpty(iPushPullDomains)) {
+            let iPushPullDomain = iPushPullDomains.find((f) => f.Name == folderName);
+            if (iPushPullDomain) {
+                returnArray = iPushPullDomain.Pages;
+            }
+        }
+        return returnArray;
+    }
+    setIPushPullLoginErrorMessage(loginErrorMessage) {
+        this.dispatchAction(IPushPullRedux.IPushPullSetLoginErrorMessage(loginErrorMessage));
+    }
+    getFolderIdForName(folderName) {
+        let iPushPullDomains = this.getIPushPullDomains();
+        return iPushPullDomains.find((i) => i.Name == folderName).FolderId;
+    }
+    addNewIPushPullPage(folderName, pageName) {
+        let folderId = this.getFolderIdForName(folderName);
+        this.getIPPService().addNewPage(folderId, pageName);
+    }
+    getIPushPullThrottleTime() {
+        return this.options.throttleTime;
+    }
+    setIPushPullThrottleTime(throttleTime) {
+        this.dispatchAction(IPushPullRedux.IPushPullSetThrottleTime(throttleTime));
+    }
+    setIPushPullDomains(iPushPullDomains) {
+        this.dispatchAction(IPushPullRedux.IPushPullSetDomainsPages(iPushPullDomains));
+    }
+    clearIPushPullDomains() {
+        this.dispatchAction(IPushPullRedux.IPushPullClearDomainsPages());
+    }
+    getIPushPullSchedules() {
+        return this.getAdaptableState().Schedule.IPushPullSchedules || [];
+    }
+    showIPushPullPopup() {
+        this.showModulePopup(ModuleConstants.IPushPullModuleId);
+    }
+    setIPushPullAvailableOn() {
+        this.dispatchAction(IPushPullRedux.SetIPushPullAvailableOn());
+    }
+    setIPushPullAvailableOff() {
+        this.dispatchAction(IPushPullRedux.SetIPushPullAvailableOff());
+    }
+    setIPushPullRunningOn() {
+        this.dispatchAction(IPushPullRedux.SetIPushPullRunningOn());
+        this.adaptable.ReportService.PublishLiveLiveDataChangedEvent('ipushpull', 'Connected');
+    }
+    setIPushPullRunningOff() {
+        this.dispatchAction(IPushPullRedux.SetIPushPullRunningOff());
+        this.adaptable.ReportService.PublishLiveLiveDataChangedEvent('ipushpull', 'Disconnected');
+    }
+    isIPushPullLiveDataRunning() {
+        return Helper_1.default.objectExists(this.getCurrentLiveIPushPullReport());
+    }
+    getIPPService() {
+        if (!this.ippService) {
+            this.ippService = this.adaptable.getPluginProperty('ipushpull', 'service') || null;
+        }
+        return this.ippService;
+    }
+    async loginToIPushPull(userName, password) {
+        await this.getIPPService().login(userName, password);
+        const domainpages = await this.getIPPService().getDomainPages();
+        this.setIPushPullDomains(domainpages);
+        this.setIPushPullRunningOn();
+        this.getAdaptableApi().internalApi.hidePopupScreen();
+        this.setIPushPullLoginErrorMessage('');
+        this.dispatchAction(IPushPullRedux.IPushPullSetLoginDetails(userName, password));
+    }
+    async retrieveIPushPullDomainsFromIPushPull() {
+        this.clearIPushPullDomains();
+        const domainpages = await this.getIPPService().getDomainPages();
+        this.setIPushPullDomains(domainpages);
+    }
+    logoutFromIPushPull() {
+        this.clearIPushPullInternalState();
+        this.dispatchAction(IPushPullRedux.IPushPullLogout());
+        this.getAdaptableApi().internalApi.hidePopupScreen();
+    }
+    includeSystemReports() {
+        return this.options.includeSystemReports || false;
+    }
+    clearIPushPullInternalState() {
+        this.setIPushPullDomains([]);
+        this.setIPushPullRunningOff();
+        this.setIPushPullLoginErrorMessage('');
+        this.dispatchAction(IPushPullRedux.IPushPullLiveReportClear());
+    }
+}
+exports.IPushPullApiImpl = IPushPullApiImpl;

package/src/Module/Interface/IPushPullModule.d.ts

@@ -0,0 +1,7 @@
+import { IPushPullReport } from '@adaptabletools/adaptable/src/PredefinedConfig/IPushPullState';
+import { IModule } from '@adaptabletools/adaptable/src/Strategy/Interface/IModule';
+export interface IPushPullModule extends IModule {
+    sendSnapshot(report: IPushPullReport): void;
+    startLiveData(report: IPushPullReport): void;
+    stopLiveData(): void;
+}

package/src/Module/Interface/IPushPullModule.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Module/PushPullModule.d.ts

@@ -0,0 +1,23 @@
+import { AdaptableModuleBase } from '@adaptabletools/adaptable/src/Strategy/AdaptableModuleBase';
+import { IPushPullModule } from './Interface/IPushPullModule';
+import { IPushPullReport } from '@adaptabletools/adaptable/src/PredefinedConfig/IPushPullState';
+import { IPushPullApi } from '@adaptabletools/adaptable/src/Api/IPushPullApi';
+import { AccessLevel, AdaptableApi } from '@adaptabletools/adaptable/types';
+export declare class PushPullModule extends AdaptableModuleBase implements IPushPullModule {
+    private isSendingData;
+    private ippService;
+    private adaptable;
+    private throttledRecomputeAndSendLiveDataEvent;
+    private lastData;
+    constructor(api: AdaptableApi);
+    protected getViewAccessLevel(): AccessLevel;
+    setModuleEntitlement(): void;
+    getIPPApi(): IPushPullApi;
+    private getCurrentReport;
+    private getIPPService;
+    private sendNewLiveData;
+    sendSnapshot(iPushPullReport: IPushPullReport): void;
+    startLiveData(iPushPullReport: IPushPullReport): void;
+    stopLiveData(): void;
+    private getThrottleTimeFromState;
+}

package/src/Module/PushPullModule.js

@@ -0,0 +1,190 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PushPullModule = void 0;
+const tslib_1 = require("tslib");
+const AdaptableModuleBase_1 = require("@adaptabletools/adaptable-cjs/src/Strategy/AdaptableModuleBase");
+const ModuleConstants = tslib_1.__importStar(require("@adaptabletools/adaptable-cjs/src/Utilities/Constants/ModuleConstants"));
+const throttle_1 = tslib_1.__importDefault(require("lodash/throttle"));
+const GeneralConstants_1 = require("@adaptabletools/adaptable-cjs/src/Utilities/Constants/GeneralConstants");
+const EQUAL_DATA_ERR = 'equal data, so not sending';
+class PushPullModule extends AdaptableModuleBase_1.AdaptableModuleBase {
+    constructor(api) {
+        super(ModuleConstants.IPushPullModuleId, 'ipushpull', 'download', null, 'Send data from AdapTable to ipushpull', api);
+        this.isSendingData = false;
+        this.ippService = null;
+        this.adaptable = api.internalApi.getAdaptableInstance();
+        this.api.eventApi.on('AdaptableReady', () => {
+            setTimeout(() => {
+                this.throttledRecomputeAndSendLiveDataEvent = (0, throttle_1.default)(() => this.sendNewLiveData(), this.getThrottleTimeFromState());
+            }, 1000);
+        });
+        // if a piece of data has updated then update any live reports except cell or row selected where the data change is relevant
+        // currently we DONT send deltas - we simply send everything to ipushpull every time a relevant change happens
+        this.api.internalApi
+            .getDataService()
+            .on('CellDataChanged', (cellDataChangedInfo) => {
+            const api = this.getIPPApi();
+            const exportApi = this.api.exportApi;
+            if (api.isIPushPullLiveDataRunning()) {
+                let currentLiveIPushPullReport = api.getCurrentLiveIPushPullReport();
+                if (currentLiveIPushPullReport &&
+                    currentLiveIPushPullReport.ReportName !== GeneralConstants_1.SELECTED_CELLS_REPORT &&
+                    currentLiveIPushPullReport.ReportName !== GeneralConstants_1.SELECTED_ROWS_REPORT &&
+                    exportApi.internalApi.isDataChangeInReport(cellDataChangedInfo, this.getCurrentReport())) {
+                    this.throttledRecomputeAndSendLiveDataEvent();
+                }
+            }
+        });
+        // if the grid has refreshed then update all live reports
+        this.adaptable._on('GridRefreshed', () => {
+            if (this.getIPPApi().isIPushPullLiveDataRunning()) {
+                this.throttledRecomputeAndSendLiveDataEvent();
+            }
+        });
+        // if the grid filters have changed then update any live reports except cell or row selected
+        this.adaptable._on('AdapTableFiltersApplied', () => {
+            // Rerun all reports except selected cells / rows when filter changes
+            if (this.getIPPApi().isIPushPullLiveDataRunning()) {
+                let currentLiveIPushPullReport = this.getIPPApi().getCurrentLiveIPushPullReport();
+                if (currentLiveIPushPullReport &&
+                    currentLiveIPushPullReport.ReportName !== GeneralConstants_1.SELECTED_CELLS_REPORT &&
+                    currentLiveIPushPullReport.ReportName !== GeneralConstants_1.SELECTED_ROWS_REPORT) {
+                    this.throttledRecomputeAndSendLiveDataEvent();
+                }
+            }
+        });
+        // if grid selection has changed and the ipushpull Live report is 'Selected Cells' or 'Selected Rows' then send updated data
+        this.api.eventApi.on('SelectionChanged', () => {
+            if (this.getIPPApi().isIPushPullLiveDataRunning()) {
+                let currentLiveIPushPullReport = this.getIPPApi().getCurrentLiveIPushPullReport();
+                if (currentLiveIPushPullReport &&
+                    (currentLiveIPushPullReport.ReportName === GeneralConstants_1.SELECTED_CELLS_REPORT ||
+                        currentLiveIPushPullReport.ReportName === GeneralConstants_1.SELECTED_ROWS_REPORT)) {
+                    this.throttledRecomputeAndSendLiveDataEvent();
+                }
+            }
+        });
+    }
+    getViewAccessLevel() {
+        return 'Full';
+    }
+    setModuleEntitlement() {
+        // TODO
+        if (!this.api.pluginsApi.getipushpullPluginApi().isIPushPullAvailable()) {
+            this.AccessLevel = 'Hidden';
+        }
+        else {
+            this.AccessLevel = this.api.internalApi
+                .getEntitlementService()
+                .getEntitlementAccessLevelForModule(this.moduleInfo.ModuleName);
+        }
+    }
+    getIPPApi() {
+        return this.api.pluginsApi.getipushpullPluginApi();
+    }
+    getCurrentReport() {
+        const api = this.getIPPApi();
+        const exportApi = this.api.exportApi;
+        if (api.isIPushPullLiveDataRunning()) {
+            let currentLiveIPushPullReport = api.getCurrentLiveIPushPullReport();
+            return currentLiveIPushPullReport
+                ? exportApi.getReportByName(currentLiveIPushPullReport.ReportName)
+                : null;
+        }
+        return null;
+    }
+    getIPPService() {
+        if (!this.ippService) {
+            this.ippService = this.adaptable.getPluginProperty('ipushpull', 'service') || null;
+        }
+        return this.ippService;
+    }
+    sendNewLiveData() {
+        //we wait for the last sendNewLiveData to finish
+        if (this.isSendingData == true) {
+            this.throttledRecomputeAndSendLiveDataEvent();
+            return;
+        }
+        let currentLiveIPushPullReport = this.getIPPApi().getCurrentLiveIPushPullReport();
+        if (currentLiveIPushPullReport) {
+            this.isSendingData = true;
+            let report = this.api.exportApi.getReportByName(currentLiveIPushPullReport.ReportName);
+            let reportAsArray = this.adaptable.ReportService.getReportDataAsArray(report);
+            const currentData = JSON.stringify(reportAsArray);
+            if (currentData === this.lastData) {
+                this.adaptable.logger.warn(EQUAL_DATA_ERR);
+                this.isSendingData = false;
+                return;
+            }
+            Promise.resolve()
+                .then(() => {
+                return new Promise((resolve, reject) => {
+                    if (reportAsArray) {
+                        resolve(reportAsArray);
+                    }
+                    else {
+                        reject('no data in the report');
+                    }
+                });
+            })
+                .then((reportAsArray) => {
+                return this.getIPPService().pushData(currentLiveIPushPullReport.Page, reportAsArray);
+            })
+                .then(() => {
+                this.lastData = currentData;
+                return this.adaptable.ReportService.PublishLiveLiveDataChangedEvent('ipushpull', 'LiveDataUpdated', currentLiveIPushPullReport);
+            })
+                .catch((reason) => {
+                this.adaptable.logger.warn('Failed to send data to ipushpull for [' + currentLiveIPushPullReport.ReportName + ']', reason);
+                this.stopLiveData();
+                let errorMessage = 'Export Failed';
+                if (reason) {
+                    errorMessage += ': ' + reason;
+                }
+                errorMessage += '.  This live export has been cancelled.';
+                this.api.alertApi.showAlertError('ipushpull Export Error', errorMessage);
+            });
+            Promise.resolve()
+                .then(() => {
+                this.adaptable.logger.success('All live report data sent');
+                this.isSendingData = false;
+            })
+                .catch(() => {
+                this.adaptable.logger.warn('Failed to send data');
+                this.isSendingData = false;
+            });
+        }
+    }
+    sendSnapshot(iPushPullReport) {
+        this.getIPPService()
+            .loadPage(iPushPullReport.Folder, iPushPullReport.Page)
+            .then(() => {
+            let report = this.api.exportApi.getReportByName(iPushPullReport.ReportName);
+            if (report) {
+                let reportAsArray = this.adaptable.ReportService.getReportDataAsArray(report);
+                if (reportAsArray) {
+                    this.getIPPService().pushData(iPushPullReport.Page, reportAsArray);
+                }
+            }
+        });
+    }
+    startLiveData(iPushPullReport) {
+        this.getIPPService()
+            .loadPage(iPushPullReport.Folder, iPushPullReport.Page)
+            .then(() => {
+            this.getIPPApi().startLiveData(iPushPullReport);
+        });
+    }
+    stopLiveData() {
+        this.lastData = '';
+        this.getIPPApi().stopLiveData();
+    }
+    getThrottleTimeFromState() {
+        let iPushPullThrottleTime;
+        if (this.getIPPApi().isIPushPullRunning()) {
+            iPushPullThrottleTime = this.getIPPApi().getIPushPullThrottleTime();
+        }
+        return iPushPullThrottleTime ? iPushPullThrottleTime : GeneralConstants_1.DEFAULT_LIVE_REPORT_THROTTLE_TIME;
+    }
+}
+exports.PushPullModule = PushPullModule;

package/src/Redux/ActionReducers/IPushPullRedux.d.ts

@@ -0,0 +1,85 @@
+import * as Redux from 'redux';
+import { IPushPullReport } from '@adaptabletools/adaptable/src/PredefinedConfig/IPushPullState';
+import { IPushPullDomain } from '@adaptabletools/adaptable/src/PredefinedConfig/IPushPullState';
+import { IPushPullState } from '@adaptabletools/adaptable/src/PredefinedConfig/IPushPullState';
+export interface IPushPullSetThrottleTimeAction extends Redux.Action {
+    throttleTime: number;
+}
+export interface IPushPullSendSnapshotAction extends Redux.Action {
+    iPushPullReport: IPushPullReport;
+}
+export interface IPushPullStartLiveDataAction extends Redux.Action {
+    iPushPullReport: IPushPullReport;
+}
+export interface IPushPullStopLiveDataAction extends Redux.Action {
+}
+export interface IPushPullLoginAction extends Redux.Action {
+    username: string;
+    password: string;
+}
+export interface IPushPullLogoutAction extends Redux.Action {
+}
+export interface IPushPullSetLoginDetailsAction extends Redux.Action {
+    username: string;
+    password: string;
+}
+export interface IPushPullSetLoginErrorMessageAction extends Redux.Action {
+    errorMessage: string;
+}
+export interface IPushPullAddPageAction extends Redux.Action {
+    folder: string;
+    page: string;
+}
+export interface SetIPushPullAvailableOnAction extends Redux.Action {
+}
+export interface SetIPushPullAvailableOffAction extends Redux.Action {
+}
+export interface SetIPushPullRunningOnAction extends Redux.Action {
+}
+export interface SetIPushPullRunningOffAction extends Redux.Action {
+}
+export interface IPushPullDomainsPagesSetAction extends Redux.Action {
+    IPushPullDomainsPages: IPushPullDomain[];
+}
+export interface IPushPullDomainsPagesClearAction extends Redux.Action {
+}
+export interface IPushPullLiveReportSetAction extends Redux.Action {
+    iPushPullReport: IPushPullReport;
+}
+export interface IPushPullLiveReportClearAction extends Redux.Action {
+}
+export interface IPushPullSetCurrentReportNameAction extends Redux.Action {
+    reportName: string;
+}
+export interface IPushPullSetCurrentFolderAction extends Redux.Action {
+    folder: string;
+}
+export interface IPushPullSetCurrentPageAction extends Redux.Action {
+    page: string;
+}
+export interface IPushPullSetCurrentAvailablePagesAction extends Redux.Action {
+    availablePages: string[];
+}
+export declare const IPushPullSetThrottleTime: (throttleTime: number) => IPushPullSetThrottleTimeAction;
+export declare const IPushPullSendSnapshot: (iPushPullReport: IPushPullReport) => IPushPullSendSnapshotAction;
+export declare const IPushPullStartLiveData: (iPushPullReport: IPushPullReport) => IPushPullStartLiveDataAction;
+export declare const IPushPullStopLiveData: () => IPushPullStopLiveDataAction;
+export declare const IPushPullLogin: (username: string, password: string) => IPushPullLoginAction;
+export declare const IPushPullLogout: () => IPushPullLogoutAction;
+export declare const IPushPullSetLoginDetails: (username: string, password: string) => IPushPullSetLoginDetailsAction;
+export declare const IPushPullSetLoginErrorMessage: (errorMessage: string) => IPushPullSetLoginErrorMessageAction;
+export declare const IPushPullAddPage: (folder: string, page: string) => IPushPullAddPageAction;
+export declare const SetIPushPullAvailableOn: () => SetIPushPullAvailableOnAction;
+export declare const SetIPushPullAvailableOff: () => SetIPushPullAvailableOffAction;
+export declare const SetIPushPullRunningOn: () => SetIPushPullRunningOnAction;
+export declare const SetIPushPullRunningOff: () => SetIPushPullRunningOffAction;
+export declare const IPushPullSetDomainsPages: (IPushPullDomainsPages: IPushPullDomain[]) => IPushPullDomainsPagesSetAction;
+export declare const IPushPullClearDomainsPages: () => IPushPullDomainsPagesClearAction;
+export declare const IPushPullLiveReportSet: (iPushPullReport: IPushPullReport) => IPushPullLiveReportSetAction;
+export declare const IPushPullLiveReportClear: () => IPushPullLiveReportClearAction;
+export declare const IPushPullSetCurrentReportName: (reportName: string) => IPushPullSetCurrentReportNameAction;
+export declare const IPushPullSetCurrentFolder: (folder: string) => IPushPullSetCurrentFolderAction;
+export declare const IPushPullSetCurrentPage: (page: string) => IPushPullSetCurrentPageAction;
+export declare const IPushPullSetCurrentAvailablePages: (availablePages: string[]) => IPushPullSetCurrentAvailablePagesAction;
+export declare const iPushPullInitialState: IPushPullState;
+export declare const IPushPullReducer: Redux.Reducer<IPushPullState>;