@adaptabletools/adaptable-plugin-ipushpull 22.0.1-canary.3 → 22.0.2

package/src/index.js

@@ -1,4 +1,4 @@
-import { AdaptablePlugin } from '@adaptabletools/adaptable';
+import { AdaptablePlugin } from '@adaptabletools/adaptable/types';
 import env from './env';
 import packageJson from '../package.json';
 import adaptableCorePackageJson from '@adaptabletools/adaptable/package.json';
@@ -8,8 +8,8 @@ import * as PopupRedux from '@adaptabletools/adaptable/src/Redux/ActionsReducers
 import { AdaptableViewFactory, AdaptableViewPanelFactory, } from '@adaptabletools/adaptable/src/View/AdaptableViewFactory';
 import { PushPullModule } from './Module/PushPullModule';
 import { IPushPullApiImpl } from './IPushPullApiImpl';
-import { PushPullService } from './Utilities/Services/PushPullService';
-import ipushpull from 'ipushpull-js';
+import { IPushPullService } from './Utilities/Services/IPushPullService';
+import { IPushPullClient } from './ipushpull-client';
 import { iPushPullInitialState, IPushPullReducer, IPushPullSetCurrentAvailablePages, IPushPullSetCurrentPage, } from './Redux/ActionReducers/IPushPullRedux';
 import { IPushPullLoginPopup } from './View/IPushPullLoginPopup';
 import { IPushPullAddPagePopup } from './View/IPushPullAddPagePopup';
@@ -22,25 +22,18 @@ const suffix = name.endsWith('-cjs') ? '-cjs' : '';
 if (version !== coreVersion) {
     console.warn(`Version mismatch: "@adaptabletools/adaptable-plugin-ipushpull${suffix}" (v${version}) and "@adaptabletools/adaptable${suffix}" (v${coreVersion}) have different versions. They should be the exact same version.`);
 }
+const DEFAULT_API_URL = 'https://test.ipushpull.com/api/1.0';
 const getApiKey = () => {
-    let key = env.IPUSHPULL_API_KEY; // need to make sure that is always there
-    return key;
+    return env.IPUSHPULL_API_KEY || '';
 };
 const getApiSecret = () => {
-    let secret = env.IPUSHPULL_API_SECRET; // need to make sure that is always there
-    return secret;
+    return env.IPUSHPULL_API_SECRET || '';
 };
 const defaultOptions = {
     ippConfig: {
-        api_secret: getApiSecret() || '',
-        api_key: getApiKey() || '',
-        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
+        api_key: getApiKey(),
+        api_secret: getApiSecret(),
+        api_url: DEFAULT_API_URL,
     },
     autoLogin: false,
     throttleTime: 2000,
@@ -52,40 +45,37 @@ class IPushPullPlugin extends AdaptablePlugin {
     PushPullService;
     constructor(options) {
         super(options);
+        const defaults = defaultOptions.ippConfig;
+        const userConfig = options?.ippConfig;
         const ippConfig = {
-            ...defaultOptions.ippConfig,
-            ...(options || {}).ippConfig,
+            api_url: userConfig?.api_url ?? defaults.api_url ?? DEFAULT_API_URL,
+            api_key: userConfig?.api_key || defaults.api_key,
+            api_secret: userConfig?.api_secret || defaults.api_secret,
         };
-        if (!ippConfig.api_key) {
-            ippConfig.api_key = defaultOptions.ippConfig.api_key;
-        }
-        if (!ippConfig.api_secret) {
-            ippConfig.api_secret = defaultOptions.ippConfig.api_secret;
-        }
         this.options = {
             ...defaultOptions,
             ...options,
             ippConfig,
         };
-        /**
-         * Contains the objects required to export (snapshot or live) data to ipushpull from AdapTable.
-         *
-         * Includes ipushpull config and objects and, optionally, any ipushpull Reports (including schedules).
-         */
-        // IPushPull?: IPushPullState;
-        ipushpull.config.set(this.options.ippConfig);
     }
     afterInitApi(adaptable) {
+        const config = this.options.ippConfig;
+        const client = new IPushPullClient({
+            api_url: config.api_url ?? DEFAULT_API_URL,
+            api_key: config.api_key,
+            api_secret: config.api_secret,
+        });
         this.iPushPullApi = new IPushPullApiImpl(adaptable, this.options);
-        this.PushPullService = new PushPullService(adaptable);
-        this.iPushPullApi.setIPushPullInstance(ipushpull);
+        this.PushPullService = new IPushPullService(adaptable, this.options.cellStyles);
+        this.iPushPullApi.setIPushPullInstance(client);
         this.registerProperty('api', () => this.iPushPullApi);
         this.registerProperty('service', () => this.PushPullService);
     }
+    // FIXME AFL improve typing
     rootReducer = (rootReducer) => {
         return {
-            System: (state, action) => {
-                let augmentedState = rootReducer.System(state, action);
+            Internal: (state, action) => {
+                let augmentedState = rootReducer.Internal(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)

package/src/ipushpull-client/IPushPullClient.d.ts

@@ -0,0 +1,27 @@
+import { IPushPullClientConfig, IPushPullTokens, IPushPullDomainAccessInfo, IPushPullPageContentPayload, IPushPullPageContentResponse, IPushPullCellStyle } from './types';
+export declare class IPushPullClient {
+    private config;
+    private tokens;
+    private refreshPromise;
+    constructor(config: IPushPullClientConfig);
+    private buildOAuthBody;
+    login(username: string, password: string): Promise<IPushPullTokens>;
+    refreshToken(): Promise<IPushPullTokens>;
+    private doRefreshToken;
+    logout(): Promise<void>;
+    getDomainsAndPages(): Promise<IPushPullDomainAccessInfo[]>;
+    getPageContent(folderId: number, pageId: number): Promise<any>;
+    updatePageContent(folderId: number, pageId: number, payload: IPushPullPageContentPayload): Promise<IPushPullPageContentResponse>;
+    createPage(folderId: number, pageName: string, description?: string): Promise<any>;
+    isAuthenticated(): boolean;
+    private fetchWithAuth;
+}
+/**
+ * Converts per-cell data (array of rows, each cell being { value, formatted_value, style })
+ * into the official ipushpull page content format with deduplicated styles.
+ */
+export declare function buildPageContentPayload(cellData: Array<Array<{
+    value: any;
+    formatted_value: any;
+    style: IPushPullCellStyle;
+}>>): IPushPullPageContentPayload;

package/src/ipushpull-client/IPushPullClient.js

@@ -0,0 +1,197 @@
+export class IPushPullClient {
+    config;
+    tokens = null;
+    refreshPromise = null;
+    constructor(config) {
+        this.config = config;
+    }
+    buildOAuthBody(params) {
+        const allParams = {
+            ...params,
+            client_id: this.config.api_key,
+            client_secret: this.config.api_secret,
+        };
+        return Object.entries(allParams)
+            .map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`)
+            .join('&');
+    }
+    async login(username, password) {
+        const url = `${this.config.api_url}/oauth/token/`;
+        const body = this.buildOAuthBody({
+            grant_type: 'password',
+            username,
+            password,
+        });
+        const response = await fetch(url, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/x-www-form-urlencoded',
+            },
+            body,
+        });
+        if (!response.ok) {
+            const errorData = await response.json().catch(() => ({}));
+            const message = errorData.error_description || errorData.error || response.statusText;
+            const err = new Error(message);
+            err.data = errorData;
+            throw err;
+        }
+        this.tokens = await response.json();
+        return this.tokens;
+    }
+    async refreshToken() {
+        if (!this.tokens?.refresh_token) {
+            throw new Error('No refresh token available. Please login first.');
+        }
+        // Deduplicate concurrent refresh attempts
+        if (this.refreshPromise) {
+            return this.refreshPromise;
+        }
+        this.refreshPromise = this.doRefreshToken();
+        try {
+            const result = await this.refreshPromise;
+            return result;
+        }
+        finally {
+            this.refreshPromise = null;
+        }
+    }
+    async doRefreshToken() {
+        const url = `${this.config.api_url}/oauth/token/`;
+        const body = this.buildOAuthBody({
+            grant_type: 'refresh_token',
+            refresh_token: this.tokens.refresh_token,
+        });
+        const response = await fetch(url, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/x-www-form-urlencoded',
+            },
+            body,
+        });
+        if (!response.ok) {
+            this.tokens = null;
+            const errorData = await response.json().catch(() => ({}));
+            throw new Error(errorData.error_description || errorData.error || 'Token refresh failed');
+        }
+        this.tokens = await response.json();
+        return this.tokens;
+    }
+    async logout() {
+        if (!this.tokens?.access_token) {
+            return;
+        }
+        const url = `${this.config.api_url}/oauth/logout/`;
+        await fetch(url, {
+            method: 'POST',
+            headers: {
+                Authorization: `Bearer ${this.tokens.access_token}`,
+            },
+        });
+        this.tokens = null;
+    }
+    async getDomainsAndPages() {
+        const url = `${this.config.api_url}/domain_page_access`;
+        const response = await this.fetchWithAuth(url);
+        const data = await response.json();
+        return (data.domains ?? data).map((domain) => ({
+            id: domain.id,
+            name: domain.name,
+            pages: (domain.current_user_domain_page_access?.pages ?? domain.pages ?? []).map((page) => ({
+                id: page.id,
+                name: page.name,
+                special_page_type: page.special_page_type ?? 0,
+                write_access: page.write_access ?? false,
+            })),
+        }));
+    }
+    async getPageContent(folderId, pageId) {
+        const baseUrl = this.config.api_url.replace(/\/api\/1\.0\/?$/, '');
+        const url = `${baseUrl}/api/2.0/domains/id/${folderId}/page_content/id/${pageId}/`;
+        const response = await this.fetchWithAuth(url);
+        return response.json();
+    }
+    async updatePageContent(folderId, pageId, payload) {
+        const baseUrl = this.config.api_url.replace(/\/api\/1\.0\/?$/, '');
+        const url = `${baseUrl}/api/2.0/domains/id/${folderId}/page_content/id/${pageId}/`;
+        const response = await this.fetchWithAuth(url, {
+            method: 'PUT',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify(payload),
+        });
+        return response.json();
+    }
+    async createPage(folderId, pageName, description) {
+        const url = `${this.config.api_url}/domains/${folderId}/pages/`;
+        const response = await this.fetchWithAuth(url, {
+            method: 'POST',
+            headers: { 'Content-Type': 'application/json' },
+            body: JSON.stringify({
+                name: pageName,
+                description: description ?? '',
+            }),
+        });
+        return response.json();
+    }
+    isAuthenticated() {
+        return this.tokens != null;
+    }
+    async fetchWithAuth(url, options = {}) {
+        if (!this.tokens?.access_token) {
+            throw new Error('Not authenticated. Please login first.');
+        }
+        const headers = new Headers(options.headers);
+        headers.set('Authorization', `Bearer ${this.tokens.access_token}`);
+        let response = await fetch(url, { ...options, headers });
+        if (response.status === 401) {
+            await this.refreshToken();
+            headers.set('Authorization', `Bearer ${this.tokens.access_token}`);
+            response = await fetch(url, { ...options, headers });
+        }
+        if (!response.ok) {
+            const errorData = await response.json().catch(() => ({}));
+            const message = errorData.detail || errorData.error || response.statusText;
+            throw new Error(message);
+        }
+        return response;
+    }
+}
+/**
+ * Converts per-cell data (array of rows, each cell being { value, formatted_value, style })
+ * into the official ipushpull page content format with deduplicated styles.
+ */
+export function buildPageContentPayload(cellData) {
+    const values = [];
+    const formattedValues = [];
+    const uniqueStyles = [];
+    const cellStyles = [];
+    const styleIndex = new Map();
+    for (const row of cellData) {
+        const rowValues = [];
+        const rowFormattedValues = [];
+        const rowStyleIndices = [];
+        for (const cell of row) {
+            rowValues.push(cell.value);
+            rowFormattedValues.push(cell.formatted_value);
+            const styleKey = JSON.stringify(cell.style);
+            let idx = styleIndex.get(styleKey);
+            if (idx === undefined) {
+                idx = uniqueStyles.length;
+                uniqueStyles.push(cell.style);
+                styleIndex.set(styleKey, idx);
+            }
+            rowStyleIndices.push(idx);
+        }
+        values.push(rowValues);
+        formattedValues.push(rowFormattedValues);
+        cellStyles.push(rowStyleIndices);
+    }
+    return {
+        content: {
+            values,
+            formatted_values: formattedValues,
+            unique_styles: uniqueStyles,
+            cell_styles: cellStyles,
+        },
+    };
+}

package/src/ipushpull-client/index.d.ts

@@ -0,0 +1,4 @@
+export { IPushPullClient, buildPageContentPayload } from './IPushPullClient';
+export { getThemeStyles } from './themes';
+export type { IPushPullTheme, IPushPullThemeStyles } from './themes';
+export type { IPushPullClientConfig, IPushPullTokens, IPushPullPageAccessInfo, IPushPullDomainAccessInfo, IPushPullCellStyle, IPushPullPageContentPayload, IPushPullPageContentResponse, } from './types';

package/src/ipushpull-client/index.js

@@ -0,0 +1,2 @@
+export { IPushPullClient, buildPageContentPayload } from './IPushPullClient';
+export { getThemeStyles } from './themes';

package/src/ipushpull-client/themes.d.ts

@@ -0,0 +1,8 @@
+import { IPushPullCellStyle } from './types';
+export type IPushPullTheme = 'lightTheme' | 'darkTheme';
+export interface IPushPullThemeStyles {
+    headerStyle: IPushPullCellStyle;
+    rowStyle: IPushPullCellStyle;
+    altRowStyle: IPushPullCellStyle;
+}
+export declare function getThemeStyles(theme: IPushPullTheme): IPushPullThemeStyles;

package/src/ipushpull-client/themes.js

@@ -0,0 +1,159 @@
+const lightTheme = {
+    headerStyle: {
+        'background-color': '4a86c8',
+        color: 'FFFFFF',
+        'font-family': 'Calibri',
+        'font-size': '12pt',
+        'font-style': 'normal',
+        'font-weight': 'bold',
+        'text-align': 'center',
+        'vertical-align': 'middle',
+        'text-wrap': 'normal',
+        'white-space': 'nowrap',
+        'word-wrap': 'normal',
+        height: '24px',
+        bbc: 'dae1e7',
+        bbs: 'solid',
+        bbw: 'thin',
+        lbc: 'dae1e7',
+        lbs: 'solid',
+        lbw: 'thin',
+        rbc: 'dae1e7',
+        rbs: 'solid',
+        rbw: 'thin',
+        tbc: 'dae1e7',
+        tbs: 'solid',
+        tbw: 'thin',
+    },
+    rowStyle: {
+        'background-color': 'FFFFFF',
+        color: '000000',
+        'font-family': 'Calibri',
+        'font-size': '11pt',
+        'font-style': 'normal',
+        'font-weight': 'normal',
+        'text-align': 'left',
+        'vertical-align': 'middle',
+        'text-wrap': 'normal',
+        height: '20px',
+        bbc: 'dae1e7',
+        bbs: 'solid',
+        bbw: 'thin',
+        lbc: 'dae1e7',
+        lbs: 'solid',
+        lbw: 'thin',
+        rbc: 'dae1e7',
+        rbs: 'solid',
+        rbw: 'thin',
+        tbc: 'dae1e7',
+        tbs: 'solid',
+        tbw: 'thin',
+    },
+    altRowStyle: {
+        'background-color': 'f5f7f7',
+        color: '000000',
+        'font-family': 'Calibri',
+        'font-size': '11pt',
+        'font-style': 'normal',
+        'font-weight': 'normal',
+        'text-align': 'left',
+        'vertical-align': 'middle',
+        'text-wrap': 'normal',
+        height: '20px',
+        bbc: 'dae1e7',
+        bbs: 'solid',
+        bbw: 'thin',
+        lbc: 'dae1e7',
+        lbs: 'solid',
+        lbw: 'thin',
+        rbc: 'dae1e7',
+        rbs: 'solid',
+        rbw: 'thin',
+        tbc: 'dae1e7',
+        tbs: 'solid',
+        tbw: 'thin',
+    },
+};
+const darkTheme = {
+    headerStyle: {
+        'background-color': '2d3748',
+        color: 'FFFFFF',
+        'font-family': 'Calibri',
+        'font-size': '12pt',
+        'font-style': 'normal',
+        'font-weight': 'bold',
+        'text-align': 'center',
+        'vertical-align': 'middle',
+        'text-wrap': 'normal',
+        'white-space': 'nowrap',
+        'word-wrap': 'normal',
+        height: '24px',
+        bbc: '4a5568',
+        bbs: 'solid',
+        bbw: 'thin',
+        lbc: '4a5568',
+        lbs: 'solid',
+        lbw: 'thin',
+        rbc: '4a5568',
+        rbs: 'solid',
+        rbw: 'thin',
+        tbc: '4a5568',
+        tbs: 'solid',
+        tbw: 'thin',
+    },
+    rowStyle: {
+        'background-color': '1a202c',
+        color: 'e2e8f0',
+        'font-family': 'Calibri',
+        'font-size': '11pt',
+        'font-style': 'normal',
+        'font-weight': 'normal',
+        'text-align': 'left',
+        'vertical-align': 'middle',
+        'text-wrap': 'normal',
+        height: '20px',
+        bbc: '4a5568',
+        bbs: 'solid',
+        bbw: 'thin',
+        lbc: '4a5568',
+        lbs: 'solid',
+        lbw: 'thin',
+        rbc: '4a5568',
+        rbs: 'solid',
+        rbw: 'thin',
+        tbc: '4a5568',
+        tbs: 'solid',
+        tbw: 'thin',
+    },
+    altRowStyle: {
+        'background-color': '2d3748',
+        color: 'e2e8f0',
+        'font-family': 'Calibri',
+        'font-size': '11pt',
+        'font-style': 'normal',
+        'font-weight': 'normal',
+        'text-align': 'left',
+        'vertical-align': 'middle',
+        'text-wrap': 'normal',
+        height: '20px',
+        bbc: '4a5568',
+        bbs: 'solid',
+        bbw: 'thin',
+        lbc: '4a5568',
+        lbs: 'solid',
+        lbw: 'thin',
+        rbc: '4a5568',
+        rbs: 'solid',
+        rbw: 'thin',
+        tbc: '4a5568',
+        tbs: 'solid',
+        tbw: 'thin',
+    },
+};
+const themes = {
+    lightTheme,
+    darkTheme,
+};
+export function getThemeStyles(theme) {
+    return themes[theme];
+}

package/src/ipushpull-client/types.d.ts

@@ -0,0 +1,67 @@
+export interface IPushPullClientConfig {
+    api_url: string;
+    api_key: string;
+    api_secret: string;
+}
+export interface IPushPullTokens {
+    access_token: string;
+    refresh_token: string;
+    expires_in: number;
+    token_type: string;
+    scope: string;
+}
+export interface IPushPullPageAccessInfo {
+    id: number;
+    name: string;
+    special_page_type: number;
+    write_access: boolean;
+}
+export interface IPushPullDomainAccessInfo {
+    id: number;
+    name: string;
+    pages: IPushPullPageAccessInfo[];
+}
+export interface IPushPullCellStyle {
+    'background-color'?: string;
+    color?: string;
+    'font-family'?: string;
+    'font-size'?: string;
+    'font-style'?: string;
+    'font-weight'?: string;
+    'text-align'?: string;
+    'vertical-align'?: string;
+    'white-space'?: string;
+    'text-wrap'?: string;
+    'word-wrap'?: string;
+    'number-format'?: string;
+    height?: string;
+    width?: string;
+    bbc?: string;
+    bbs?: string;
+    bbw?: string;
+    lbc?: string;
+    lbs?: string;
+    lbw?: string;
+    rbc?: string;
+    rbs?: string;
+    rbw?: string;
+    tbc?: string;
+    tbs?: string;
+    tbw?: string;
+    [key: string]: string | undefined;
+}
+export interface IPushPullPageContentPayload {
+    content: {
+        values: any[][];
+        formatted_values: any[][];
+        unique_styles: IPushPullCellStyle[];
+        cell_styles: number[][];
+    };
+}
+export interface IPushPullPageContentResponse {
+    push_interval?: number;
+    pull_interval?: number;
+    encryption_type_to_use?: number;
+    encryption_key_to_use?: string;
+    seq_no?: number;
+}

package/src/ipushpull-client/types.js

@@ -0,0 +1 @@
+export {};

package/src/Utilities/Services/PushPullService.d.ts

@@ -1,26 +0,0 @@
-import { IAdaptable } from '@adaptabletools/adaptable/src/AdaptableInterfaces/IAdaptable';
-import { IPPStyle } from '@adaptabletools/adaptable/src/Utilities/Interface/IPPStyle';
-import { IPushPullService } from './Interface/IPushPullService';
-import { IPushPullDomain } from '@adaptabletools/adaptable/src/AdaptableState/InternalState';
-export declare enum ServiceStatus {
-    Unknown = "Unknown",
-    Disconnected = "Disconnected",
-    Connected = "Connected",
-    Error = "Error"
-}
-export declare class PushPullService implements IPushPullService {
-    adaptable: IAdaptable;
-    private ppInstance;
-    private pages;
-    constructor(adaptable: IAdaptable);
-    getIPushPullStatus(): ServiceStatus;
-    private getIPPApi;
-    login(login: string, password: string): Promise<any>;
-    getDomainPages(): Promise<IPushPullDomain[]>;
-    loadPage(folderIPP: string, pageIPP: string): Promise<void>;
-    unloadPage(page: string): void;
-    addNewPage(folderId: number, page: string): Promise<any>;
-    pushData(page: string, data: any[]): Promise<void>;
-    getCurrentIPPStyle(): IPPStyle;
-    getDefaultIPPStyle(): IPPStyle;
-}