@sisense/sdk-pivot-query-client 2.17.0

package/LICENSE.md

@@ -0,0 +1,35 @@
+# SISENSE COMPOSE SDK
+
+# END USER LICENSE AGREEMENT
+
+THIS END USER LICENSE AGREEMENT (“EULA”) FORMS A BINDING AGREEMENT BETWEEN YOU INDIVIDUALLY OR THE ENTITY ON WHOSE BEHALF YOU ARE ACCEPTING THIS AGREEMENT (“YOU”) AND DESCRIBES THE TERMS AND CONDITIONS GOVERNING THE USE OF ANY APPLICATION PROGRAMMING INTERFACE, SOFTWARE DEVELOPMENT KIT, CODE SNIPPET, SAMPLE CODE, USER INTERFACE COMPONENT, VISUALIZATION, CLI TOOLS, OR SAMPLE DATA, AND THE CORRESPONDING DOCUMENTATION FOR EACH, ANY UPDATES AND UPGRADES THERETO, AND ANY MODIFICATIONS, ENHANCEMENTS, OR IMPROVEMENTS, OF ANY OF THE FOREGOING (EACH, A “TOOL” AND COLLECTIVELY, THE “TOOLS”), MADE AVAILABLE BY SISENSE LTD. OR ITS AFFILIATES (“SISENSE”).
+
+1. ACCEPTANCE. By downloading, importing, installing and/or using any Tool (or any portion thereof), You represent and warrant that: (a) You have read, understand and accept all of the provisions of this EULA; and (b) if You are accepting on behalf of an entity, You are an employee, contractor or agent of such entity and have the authority and all legal power to accept on behalf of such entity.
+
+2. LICENSE SCOPE. Subject to the terms and conditions of this EULA, Sisense hereby grants You a royalty-free, non-exclusive, non-transferrable, limited license to access, download and use the Tools (in the manner described in the documentation for such Tool) solely for utilization with Your use of the applicable Sisense subscription product (the “Product”), to which You must have purchased the necessary license and use rights pursuant to a separate written agreement with Sisense (the “Master Subscription Agreement”).
+
+3. RESTRICTIONS. You agree that You will not (and have no license to) and will not permit any third party to: (i) use the Tools except as permitted under this EULA; (ii) sell, resell, license, sublicense, rent, lease, encumber, lend, distribute, transfer, or provide a third party with access to the Tools; (iii) modify or create derivative works of the Tools; (iv) circumvent or remove by any means any copy protection used by Sisense in connection with the Tools; (v) use the Tools to develop a competitive product offering; (vi) use the Tool to access Sisense products in a manner not authorized by the Master Subscription Agreement or this EULA; or (vii) use the Tools in any manner that violates the Master Subscription Agreement or any applicable laws or regulations;
+
+4. SISENSE OWNERSHIP. Except for those portions licensed to Sisense by third parties, Sisense retains all right, title and interest in and to the Tools, including without limitation all copyrights and other intellectual property or other proprietary rights worldwide therein (including but not limited to all patent, trademark, service mark, copyright, trade secret, know-how, moral right, and any other intellectual and intangible property rights, including all continuations, continuations in part, applications, renewals, and extensions of any of the foregoing, whether registered or unregistered). All rights not expressly granted herein are reserved. You may not remove, delete or modify any of the Sisense copyright statements in the Tools.
+
+5. OPEN SOURCE COMPONENTS. To the extent any open source software components are provided with or used by the Tools, such components are licensed to You under the terms of the applicable license agreements included with such open source software components.
+
+6. THIRD-PARTY COMPONENTS. To the extent that any Tool includes one or more components licensed by a third-party (a “Component”), and such third-party’s license requirements apply to such Component in a Tool, such additional license terms will be provided in the open source disclosure file provided with or within a Tool download. Third-party license terms shall take precedence over this EULA to the extent that they impose additional restrictions or limitations on You than the license provided herein for download and use of a Component. You agree that: (a) to the extent that the terms between You and the third party for use of a third-party technology accessed by the Component are more restrictive, such terms shall apply to Your use of the Component; (b) Sisense, and not the third party, is responsible for the Component including, without limitation, for any warranties, maintenance, and support thereof, and the third party does not warrant the Component’s accuracy, reliability, completeness, usefulness, non-infringement, or quality of the Component, and will not be liable for any losses or damages of any kind, including lost profits or other indirect or consequential damages, relating to use of or reliance on the Component; and (c) the third party owns all right, title, and interest in and to the Component, including all intellectual property rights therein.
+
+7. TERM, TERMINATION, AND CHANGES. This EULA shall continue as long as You are in compliance with the terms specified herein or until otherwise terminated. This EULA shall automatically terminate upon the expiration or termination of the Master Subscription Agreement. You agree, upon termination, to destroy all copies of the Tools within Your possession or control. The Disclaimer of Warranties, Limitation of Liability and Indemnification sections set out in this EULA shall survive any termination or expiration of this EULA. Sisense may, in its sole discretion, update this EULA from time to time.
+
+8. NO DUTY TO SUPPORT. You expressly acknowledge that Sisense has no duty or obligation to support the Tools, or to provide updates or bug fixes to the Tools.
+
+9. DISCLAIMER OF WARRANTIES. THE TOOLS ARE PROVIDED “AS IS” WITHOUT ANY WARRANTIES OF ANY KIND. TO THE MAXIMUM EXTENT PERMITTED BY LAW, SISENSE DISCLAIMS RESPONSIBILITY FOR ANY HARM RESULTING FROM YOUR USE OF ANY TOOL. SISENSE DISCLAIMS TO THE FULLEST EXTENT PERMITTED, ALL GUARANTEES AND EXPRESS, IMPLIED AND STATUTORY WARRANTIES, INCLUDING WITHOUT LIMITATION THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT OF PROPRIETARY RIGHTS, AND ANY WARRANTIES REGARDING THE AVAILABILITY, SECURITY, RELIABILITY, TIMELINESS AND PERFORMANCE OF ANY TOOL. YOU ACKNOWLEDGE THAT YOU DOWNLOAD AND USE THE TOOLS AT YOUR OWN DISCRETION AND RISK, AND YOU ARE SOLELY RESPONSIBLE FOR ANY DAMAGES TO HARDWARE DEVICES OR LOSS OF DATA THAT RESULT FROM THE DOWNLOAD OR USE OF ANY TOOL.
+
+10. LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL SISENSE BE LIABLE FOR ANY LOST PROFITS OR BUSINESS OPPORTUNITIES, LOSS OF USE, BUSINESS INTERRUPTION, LOSS OF DATA, OR ANY OTHER INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF OR FROM LIBRARY OR YOUR USE OF THE TOOLS, UNDER ANY THEORY OF LIABILITY, WHETHER BASED IN CONTRACT, TORT, NEGLIGENCE, PRODUCT LIABILITY, OR OTHERWISE. TO THE EXTENT THE PRECEDING LIMITATION DOES NOT APPLY UNDER APPLICABLE LAW, SISENSE’S LIABILITY ARISING OUT OF THE TOOLS PROVIDED HEREUNDER SHALL NOT, IN ANY EVENT, EXCEED USD $100.00.
+
+THE FOREGOING LIMITATIONS SHALL APPLY TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, REGARDLESS OF WHETHER A PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES AND REGARDLESS OF WHETHER ANY REMEDY FAILS OF ITS ESSENTIAL PURPOSE.
+
+11. INDEMNIFICATION. You agree to defend, indemnify and hold harmless Sisense, and any of its directors, officers, employees, affiliates, subsidiaries or agents, from and against any and all claims, losses, damages, liabilities and other expenses (including reasonable attorneys' fees), arising from or related to: (i) Your use of the Tools; (ii) any derivative works You create using the Tools; and (iii) Your breach of this EULA.
+
+12. EXPORT CONTROL. The Tools are provided subject to the U.S. Export Administration Regulations and the regulations of other jurisdictions (e.g., the European Union). Diversion contrary to applicable law is prohibited. Without limiting the foregoing, You agree that (i) You are not acting on behalf of any person who is a citizen, national, or resident of, or who is controlled by the government of any country to which the United States or other applicable government body has prohibited export transactions; (ii) You are not acting on behalf of, any person or entity listed on a relevant list of persons to whom export is prohibited (e.g., the U.S. Treasury Department list of Specially Designated Nationals and Blocked Persons, the U.S. Commerce Department Denied Persons List or Entity List, etc.); and (iii) You will not use the Tools for any purpose prohibited by applicable law.
+
+13. GOVERNMENT USE. If a Tool provided under the Master Subscription Agreement is software, then it is commercial computer software developed exclusively at private expense. Unless otherwise set forth in the Master Subscription Agreement, use, duplication, and disclosure by civilian agencies of the U.S. Government will not exceed those minimum rights set forth in FAR 52.227-19(c) or successor regulations. Use, duplication, and disclosure by U.S. Department of Defense agencies is subject solely to the license terms contained in this EULA, as stated in DFARS 227.7202 or successor regulations. U.S. Government rights will apply only to the specific agency and program for which the Product is obtained.
+
+14. GOVERNING LAW; ENTIRE AGREEMENT. This EULA shall be governed by the laws of the State of New York and the United States of America without regard to conflict of laws principles. You may not assign any part of this EULA without the prior written consent of Sisense. Any attempted assignment without consent shall be void. This EULA represents the entire agreement between You and Sisense with respect to the Tools and supersedes all prior written or oral communications, understandings and agreements containing the subject matter contained herein. Any waiver of these terms must be in writing to be effective. If any provision of these terms is found to be invalid or unenforceable, the remaining terms will continue to be valid and enforceable to the fullest extent permitted by law. In the event of a conflict between this EULA and the Master Subscription Agreement, the terms of this EULA will prevail to the extent applicable to the license and use of the Tools.

package/README.md

@@ -0,0 +1,2 @@
+This library, which is a part of Sisense Compose SDK, provides utilities
+for building pivot table and retrieving pivot data from a Sisense instance (backend).

package/dist/__test-helpers__/testUtils.d.ts

@@ -0,0 +1,30 @@
+import EventEmitter from 'events';
+import { Jaql, JaqlPanel, JaqlRequest } from '../data-load/types.js';
+/**
+ * @param {Function} emitter - instance of EventEmitter (node-events)
+ * @param {string} methodNameCallEvent - name of custom event
+ * @returns {void}
+ */
+export declare const emitterCallHandle: (emitter: EventEmitter, methodNameCallEvent: string) => Promise<string>;
+/**
+ *
+ * @returns {Array} - returns callback listener and dispatcher (node events library)
+ */
+export declare const initEventEmitter: () => {
+    awaitForCall: (methodName: string) => Promise<string>;
+    emitCall: (methodName: string) => void;
+};
+export declare const getNodeProp: (item: any, propName: string, list?: Array<any>) => Array<any>;
+export declare const getNodeNames: (item: any, list?: string[]) => string[];
+export declare const getNodeIndexes: (item: any, list?: string[]) => string[];
+export declare const createTypedPanel: (type: string, jaqlIndex?: number, additionalJaqlProps?: Record<any, any>, additionalPanelProps?: Record<any, any>) => {
+    panel: string;
+    field: {
+        index: number;
+        id: string;
+    };
+    jaql: Jaql;
+};
+export declare const createTypedPanels: (type: string, count: number, startIndex?: number, additionalJaqlProps?: Record<string, any>) => JaqlPanel[];
+export declare const createTestJaql: (rows?: Array<JaqlPanel>, columns?: Array<JaqlPanel>, measures?: Array<JaqlPanel>, scope?: Array<JaqlPanel>, additionalJaqlProps?: Record<string, any>) => JaqlRequest;
+export declare const delay: (time?: number, resolveValue?: any, rejectValue?: any) => Promise<any>;

package/dist/__test-helpers__/testUtils.js

@@ -0,0 +1,89 @@
+import EventEmitter from 'events';
+import { v4 as uuid } from 'uuid';
+import { treeNode } from '../tree-structure/utils/index.js';
+/**
+ * @param {Function} emitter - instance of EventEmitter (node-events)
+ * @param {string} methodNameCallEvent - name of custom event
+ * @returns {void}
+ */
+export const emitterCallHandle = (emitter, methodNameCallEvent) => new Promise((res) => {
+    emitter.once(methodNameCallEvent, () => {
+        res(methodNameCallEvent);
+    });
+});
+/**
+ *
+ * @returns {Array} - returns callback listener and dispatcher (node events library)
+ */
+export const initEventEmitter = () => {
+    const emitter = new EventEmitter();
+    const awaitForCall = (methodName) => emitterCallHandle(emitter, methodName);
+    const emitCall = (methodName) => {
+        emitter.emit(methodName);
+    };
+    return { awaitForCall, emitCall };
+};
+export const getNodeProp = (item, propName, list = []) => {
+    if (!item) {
+        return list;
+    }
+    let children = [];
+    if (Array.isArray(item)) {
+        children = item;
+    }
+    else {
+        children = treeNode.getChildren(item);
+        list.push(item[propName]);
+    }
+    if (children && children.length) {
+        children.forEach((child) => {
+            getNodeProp(child, propName, list);
+        });
+    }
+    return list;
+};
+export const getNodeNames = (item, list = []) => getNodeProp(item, 'value', list);
+export const getNodeIndexes = (item, list = []) => getNodeProp(item, 'index', list);
+export const createTypedPanel = (type, jaqlIndex = 0, additionalJaqlProps = {}, additionalPanelProps = {}) => {
+    const title = `${type}-${jaqlIndex}`;
+    const jaql = Object.assign({ title, datatype: 'numeric', dim: `[${title}]` }, additionalJaqlProps);
+    return Object.assign({ panel: type, field: { index: jaqlIndex, id: title }, jaql }, additionalPanelProps);
+};
+export const createTypedPanels = (type, count, startIndex = 0, additionalJaqlProps = {}) => Array.from(Array(count - startIndex)).map((item, index) => {
+    const jaqlIndex = index + startIndex;
+    const title = `${type}-${jaqlIndex}`;
+    const jaql = Object.assign({ title, datatype: 'numeric', dim: `[${title}]` }, additionalJaqlProps);
+    return {
+        panel: type,
+        field: { index: jaqlIndex, id: title },
+        jaql,
+    };
+});
+export const createTestJaql = (rows, columns, measures, scope, additionalJaqlProps = {}) => {
+    let metadata = [];
+    if (rows) {
+        metadata = metadata.concat(rows);
+    }
+    if (columns) {
+        metadata = metadata.concat(columns);
+    }
+    if (measures) {
+        metadata = metadata.concat(measures);
+    }
+    if (scope) {
+        metadata = metadata.concat(scope);
+    }
+    return Object.assign({ queryGuid: uuid(), metadata, grandTotals: {
+            title: 'Grand total',
+        } }, additionalJaqlProps);
+};
+export const delay = (time = 0, resolveValue, rejectValue) => new Promise((resolve, reject) => {
+    setTimeout(() => {
+        if (typeof rejectValue !== 'undefined') {
+            reject(rejectValue);
+        }
+        else {
+            resolve(resolveValue);
+        }
+    }, time);
+});

package/dist/builders/index.d.ts

@@ -0,0 +1,2 @@
+export { PivotDataBuilder } from './pivot-data-builder.js';
+export { SocketBuilder } from './socket-builder.js';

package/dist/builders/index.js

@@ -0,0 +1,2 @@
+export { PivotDataBuilder } from './pivot-data-builder.js';
+export { SocketBuilder } from './socket-builder.js';

package/dist/builders/pivot-data-builder.d.ts

@@ -0,0 +1,34 @@
+import { PivotQueryResultData } from '@sisense/sdk-data';
+import { InitPageData } from '../data-handling/types.js';
+import { DataLoadServiceI, JaqlRequest, SocketI } from '../data-load/types.js';
+export declare class PivotDataBuilder {
+    /**
+     * DataLoadServiceI instance
+     */
+    private dataLoadService?;
+    /**
+     * SocketI instance
+     */
+    private readonly socket;
+    /**
+     * @param socket - socket instance
+     */
+    constructor(socket: SocketI);
+    destroy(): void;
+    prepareRequest(jaql: JaqlRequest): Promise<JaqlRequest>;
+    prepareLoadService(jaql?: JaqlRequest, useCache?: boolean): DataLoadServiceI;
+    prepareDataService(dataLoadService: DataLoadServiceI): {
+        loadData: (jaql?: JaqlRequest, pageSize?: number, isPaginated?: boolean) => Promise<InitPageData>;
+    };
+    loadInitData(jaql: JaqlRequest, isPaginated?: boolean, elementsPerPage?: number, useCache?: boolean): Promise<PivotQueryResultData>;
+    private buildColumnsHelper;
+    /**
+     * Transforms Pivot Grid to Columns of Table structure
+     *
+     * @param columnType - type of column
+     * @param grid - pivot grid
+     * @returns An array of columns
+     */
+    private transformGridToColumns;
+    private transformTreeStructuresToResultData;
+}

package/dist/builders/pivot-data-builder.js

@@ -0,0 +1,182 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { EMPTY_PIVOT_QUERY_RESULT_DATA, } from '@sisense/sdk-data';
+import { DataService } from '../data-handling/DataService.js';
+import { SisenseDataLoadService } from '../data-load/index.js';
+export class PivotDataBuilder {
+    /**
+     * @param socket - socket instance
+     */
+    constructor(socket) {
+        this.socket = socket;
+    }
+    destroy() { }
+    prepareRequest(jaql) {
+        return Promise.resolve(jaql);
+    }
+    prepareLoadService(jaql, useCache = false) {
+        if (this.dataLoadService && (useCache || this.dataLoadService.isFormattingChanges(jaql))) {
+            return this.dataLoadService;
+        }
+        return new SisenseDataLoadService(this.socket);
+    }
+    prepareDataService(dataLoadService) {
+        const dataService = new DataService(dataLoadService);
+        return {
+            loadData: (jaql, pageSize, isPaginated) => {
+                if (!dataService) {
+                    throw new Error('No DataService defined during "prepareDataService"');
+                }
+                return dataService.loadData(jaql, { pageSize, isPaginated });
+            },
+        };
+    }
+    loadInitData(jaql, isPaginated = true, elementsPerPage = 100, useCache = false) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const pageSize = isPaginated ? elementsPerPage : undefined;
+            try {
+                const jaqlInternal = yield this.prepareRequest(jaql);
+                // Currently, each jaql need a separate dataLoadService instance
+                // In other words, each dataLoadService is associated with a jaql
+                this.dataLoadService = this.prepareLoadService(jaqlInternal, useCache);
+                const { loadData } = this.prepareDataService(this.dataLoadService);
+                const { rowsTreeService, columnsTreeService, cornerTreeService, isLastPage } = yield loadData(useCache ? undefined : jaqlInternal, pageSize, isPaginated);
+                return this.transformTreeStructuresToResultData({
+                    rowsTreeService,
+                    columnsTreeService,
+                    cornerTreeService,
+                    isLastPage,
+                });
+            }
+            catch (err) {
+                console.error('Error during loading initial page"', err);
+            }
+            return EMPTY_PIVOT_QUERY_RESULT_DATA;
+        });
+    }
+    buildColumnsHelper(columnType, columns, prefix, treeNode) {
+        var _a;
+        const columnName = `${prefix}${prefix === '' ? '' : ' | '}${(_a = treeNode.value) === null || _a === void 0 ? void 0 : _a.toString()}`;
+        if (treeNode.children) {
+            treeNode.children.forEach((child) => {
+                this.buildColumnsHelper(columnType, columns, columnName, child);
+            });
+        }
+        else {
+            columns.push({ name: columnName, type: columnType });
+        }
+    }
+    /**
+     * Transforms Pivot Grid to Columns of Table structure
+     *
+     * @param columnType - type of column
+     * @param grid - pivot grid
+     * @returns An array of columns
+     */
+    transformGridToColumns(columnType, grid) {
+        if (!grid || grid.length === 0) {
+            return [];
+        }
+        const columns = [];
+        grid === null || grid === void 0 ? void 0 : grid[0].forEach((cell) => {
+            if (typeof cell === 'string')
+                return;
+            this.buildColumnsHelper(columnType, columns, '', cell);
+        });
+        return columns || [];
+    }
+    // eslint-disable-next-line sonarjs/cognitive-complexity,max-lines-per-function
+    transformTreeStructuresToResultData(pivotTreeData) {
+        const { rowsTreeService, columnsTreeService, cornerTreeService } = pivotTreeData;
+        if (!rowsTreeService && !columnsTreeService && !cornerTreeService) {
+            return EMPTY_PIVOT_QUERY_RESULT_DATA;
+        }
+        const cornerGrid = cornerTreeService ? cornerTreeService.getGrid() : [];
+        const columnsGrid = columnsTreeService ? columnsTreeService.getGrid() : [];
+        const rowsGrid = rowsTreeService ? rowsTreeService.getGrid() : [];
+        const cornerColumns = this.transformGridToColumns('string', cornerGrid);
+        const columnsColumns = this.transformGridToColumns('number', columnsGrid);
+        const columns = [...cornerColumns, ...columnsColumns];
+        const FILL_IN_THE_BLANKS = true;
+        const valuesGrid = rowsTreeService
+            ? rowsTreeService.extractData(columnsTreeService)
+            : [];
+        const rowCount = rowsGrid.length;
+        const columnCount = columns.length;
+        const rows = [];
+        let curRowIndex = 0;
+        let curColIndex = 0;
+        Array.from(Array(rowCount)).map((c, rowIndex) => {
+            const row = [];
+            Array.from(Array(columnCount)).map((c, colIndex) => {
+                var _a, _b;
+                let dataNode;
+                if (colIndex < cornerColumns.length) {
+                    curRowIndex = rowIndex;
+                    curColIndex = colIndex;
+                    try {
+                        dataNode = rowsGrid[curRowIndex][curColIndex];
+                    }
+                    catch (err) {
+                        throw new Error(`Can't find data item for ${curRowIndex}-${curColIndex}`);
+                    }
+                }
+                else {
+                    curRowIndex = rowIndex;
+                    curColIndex = colIndex - cornerColumns.length;
+                    try {
+                        dataNode = valuesGrid[curRowIndex][curColIndex];
+                    }
+                    catch (err) {
+                        throw new Error(`Can't find data item for ${curRowIndex}-${curColIndex}`);
+                    }
+                }
+                let value;
+                if (typeof dataNode === 'string') {
+                    if (FILL_IN_THE_BLANKS) {
+                        const indexes = dataNode.split('-');
+                        // eslint-disable-next-line max-lines
+                        if (indexes.length === 2) {
+                            const parentRowIndex = Number(indexes[0]);
+                            const parentColIndex = Number(indexes[1]);
+                            dataNode = rowsGrid[parentRowIndex][parentColIndex];
+                            value = ((_a = dataNode.value) === null || _a === void 0 ? void 0 : _a.toString()) || '';
+                        }
+                        else {
+                            // eslint-disable-next-line max-lines
+                            value = '';
+                        }
+                    }
+                    else {
+                        value = '';
+                    }
+                    // eslint-disable-next-line max-lines
+                }
+                else {
+                    value = ((_b = dataNode.value) === null || _b === void 0 ? void 0 : _b.toString()) || '';
+                }
+                row.push({ data: value, text: value });
+            });
+            rows.push(row);
+        });
+        return {
+            table: {
+                columns: columns,
+                rows: rows,
+            },
+            grids: {
+                corner: cornerGrid,
+                rows: rowsGrid,
+                columns: columnsGrid,
+                values: valuesGrid,
+            },
+        };
+    }
+}

package/dist/builders/socket-builder.d.ts

@@ -0,0 +1,18 @@
+import { Authenticator } from '@sisense/sdk-rest-client';
+import { SocketI } from '../data-load/types.js';
+export declare class SocketBuilder {
+    private _socket;
+    private readonly _url;
+    private readonly _auth;
+    /**
+     * Boolean flag to indicate if the socket should be mocked or not (for testing).
+     *
+     * @internal
+     */
+    private readonly _mockSocket;
+    constructor(url: string, auth: Authenticator, mockSocket?: boolean);
+    private getQueryOptionsSso;
+    private getQueryOptionsBearer;
+    private getQueryOptionsWat;
+    get socket(): SocketI;
+}

package/dist/builders/socket-builder.js

@@ -0,0 +1,72 @@
+import { isBearerAuthenticator, isSsoAuthenticator, isWatAuthenticator, } from '@sisense/sdk-rest-client';
+import { SisenseSocket } from '../data-load/index.js';
+import TestSocket from '../data-load/sockets/TestSocket.js';
+/**
+ * Builder to create a web socket client on demand to communicate with a Sisense web socket server.
+ *
+ * @internal
+ */
+const PIVOT_NAMESPACE = 'pivot2';
+export class SocketBuilder {
+    constructor(url, auth, mockSocket = false) {
+        this._url = url;
+        this._auth = auth;
+        this._mockSocket = mockSocket;
+    }
+    getQueryOptionsSso(auth) {
+        // No need to add query params as SSO authentication
+        // is using cookies sent automatically by the browser
+        return {};
+    }
+    getQueryOptionsBearer(auth) {
+        const authToken = auth.bearer;
+        if (!authToken) {
+            throw new Error('Missing bearer token');
+        }
+        return {
+            token: authToken,
+        };
+    }
+    getQueryOptionsWat(auth) {
+        const headers = new Headers();
+        auth.applyHeaders(headers);
+        const authorization = headers.get('Authorization');
+        const initialiser = headers.get('Initialiser');
+        if (!authorization || !initialiser) {
+            throw new Error('Missing auth header');
+        }
+        return {
+            authorization,
+            initialiser,
+        };
+    }
+    get socket() {
+        // initialize socket only when needed
+        if (!this._socket) {
+            if (this._mockSocket) {
+                // use a mock socket for testing
+                this._socket = new TestSocket();
+                return this._socket;
+            }
+            const auth = this._auth;
+            const url = this._url;
+            let query = {};
+            // Do not use instanceof because it checks if the constructors are the same.
+            // However, when the class is imported from @sisense/sdk-rest-client,
+            // the code gets its own copy of the constructor from the code in the library,
+            // so they are not the same instance anymore.
+            // Reference: https://stackoverflow.com/a/63937850/2425556
+            if (isBearerAuthenticator(auth)) {
+                query = this.getQueryOptionsBearer(auth);
+            }
+            else if (isWatAuthenticator(auth)) {
+                query = this.getQueryOptionsWat(auth);
+            }
+            else if (isSsoAuthenticator(auth)) {
+                query = this.getQueryOptionsSso(auth);
+            }
+            this._socket = new SisenseSocket(url, query, PIVOT_NAMESPACE);
+        }
+        return this._socket;
+    }
+}

package/dist/cjs/__test-helpers__/testUtils.d.ts

@@ -0,0 +1,30 @@
+import EventEmitter from 'events';
+import { Jaql, JaqlPanel, JaqlRequest } from '../data-load/types.js';
+/**
+ * @param {Function} emitter - instance of EventEmitter (node-events)
+ * @param {string} methodNameCallEvent - name of custom event
+ * @returns {void}
+ */
+export declare const emitterCallHandle: (emitter: EventEmitter, methodNameCallEvent: string) => Promise<string>;
+/**
+ *
+ * @returns {Array} - returns callback listener and dispatcher (node events library)
+ */
+export declare const initEventEmitter: () => {
+    awaitForCall: (methodName: string) => Promise<string>;
+    emitCall: (methodName: string) => void;
+};
+export declare const getNodeProp: (item: any, propName: string, list?: Array<any>) => Array<any>;
+export declare const getNodeNames: (item: any, list?: string[]) => string[];
+export declare const getNodeIndexes: (item: any, list?: string[]) => string[];
+export declare const createTypedPanel: (type: string, jaqlIndex?: number, additionalJaqlProps?: Record<any, any>, additionalPanelProps?: Record<any, any>) => {
+    panel: string;
+    field: {
+        index: number;
+        id: string;
+    };
+    jaql: Jaql;
+};
+export declare const createTypedPanels: (type: string, count: number, startIndex?: number, additionalJaqlProps?: Record<string, any>) => JaqlPanel[];
+export declare const createTestJaql: (rows?: Array<JaqlPanel>, columns?: Array<JaqlPanel>, measures?: Array<JaqlPanel>, scope?: Array<JaqlPanel>, additionalJaqlProps?: Record<string, any>) => JaqlRequest;
+export declare const delay: (time?: number, resolveValue?: any, rejectValue?: any) => Promise<any>;

package/dist/cjs/__test-helpers__/testUtils.js

@@ -0,0 +1,104 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.delay = exports.createTestJaql = exports.createTypedPanels = exports.createTypedPanel = exports.getNodeIndexes = exports.getNodeNames = exports.getNodeProp = exports.initEventEmitter = exports.emitterCallHandle = void 0;
+const events_1 = __importDefault(require("events"));
+const uuid_1 = require("uuid");
+const index_js_1 = require("../tree-structure/utils/index.js");
+/**
+ * @param {Function} emitter - instance of EventEmitter (node-events)
+ * @param {string} methodNameCallEvent - name of custom event
+ * @returns {void}
+ */
+const emitterCallHandle = (emitter, methodNameCallEvent) => new Promise((res) => {
+    emitter.once(methodNameCallEvent, () => {
+        res(methodNameCallEvent);
+    });
+});
+exports.emitterCallHandle = emitterCallHandle;
+/**
+ *
+ * @returns {Array} - returns callback listener and dispatcher (node events library)
+ */
+const initEventEmitter = () => {
+    const emitter = new events_1.default();
+    const awaitForCall = (methodName) => (0, exports.emitterCallHandle)(emitter, methodName);
+    const emitCall = (methodName) => {
+        emitter.emit(methodName);
+    };
+    return { awaitForCall, emitCall };
+};
+exports.initEventEmitter = initEventEmitter;
+const getNodeProp = (item, propName, list = []) => {
+    if (!item) {
+        return list;
+    }
+    let children = [];
+    if (Array.isArray(item)) {
+        children = item;
+    }
+    else {
+        children = index_js_1.treeNode.getChildren(item);
+        list.push(item[propName]);
+    }
+    if (children && children.length) {
+        children.forEach((child) => {
+            (0, exports.getNodeProp)(child, propName, list);
+        });
+    }
+    return list;
+};
+exports.getNodeProp = getNodeProp;
+const getNodeNames = (item, list = []) => (0, exports.getNodeProp)(item, 'value', list);
+exports.getNodeNames = getNodeNames;
+const getNodeIndexes = (item, list = []) => (0, exports.getNodeProp)(item, 'index', list);
+exports.getNodeIndexes = getNodeIndexes;
+const createTypedPanel = (type, jaqlIndex = 0, additionalJaqlProps = {}, additionalPanelProps = {}) => {
+    const title = `${type}-${jaqlIndex}`;
+    const jaql = Object.assign({ title, datatype: 'numeric', dim: `[${title}]` }, additionalJaqlProps);
+    return Object.assign({ panel: type, field: { index: jaqlIndex, id: title }, jaql }, additionalPanelProps);
+};
+exports.createTypedPanel = createTypedPanel;
+const createTypedPanels = (type, count, startIndex = 0, additionalJaqlProps = {}) => Array.from(Array(count - startIndex)).map((item, index) => {
+    const jaqlIndex = index + startIndex;
+    const title = `${type}-${jaqlIndex}`;
+    const jaql = Object.assign({ title, datatype: 'numeric', dim: `[${title}]` }, additionalJaqlProps);
+    return {
+        panel: type,
+        field: { index: jaqlIndex, id: title },
+        jaql,
+    };
+});
+exports.createTypedPanels = createTypedPanels;
+const createTestJaql = (rows, columns, measures, scope, additionalJaqlProps = {}) => {
+    let metadata = [];
+    if (rows) {
+        metadata = metadata.concat(rows);
+    }
+    if (columns) {
+        metadata = metadata.concat(columns);
+    }
+    if (measures) {
+        metadata = metadata.concat(measures);
+    }
+    if (scope) {
+        metadata = metadata.concat(scope);
+    }
+    return Object.assign({ queryGuid: (0, uuid_1.v4)(), metadata, grandTotals: {
+            title: 'Grand total',
+        } }, additionalJaqlProps);
+};
+exports.createTestJaql = createTestJaql;
+const delay = (time = 0, resolveValue, rejectValue) => new Promise((resolve, reject) => {
+    setTimeout(() => {
+        if (typeof rejectValue !== 'undefined') {
+            reject(rejectValue);
+        }
+        else {
+            resolve(resolveValue);
+        }
+    }, time);
+});
+exports.delay = delay;

package/dist/cjs/builders/index.d.ts

@@ -0,0 +1,2 @@
+export { PivotDataBuilder } from './pivot-data-builder.js';
+export { SocketBuilder } from './socket-builder.js';

package/dist/cjs/builders/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SocketBuilder = exports.PivotDataBuilder = void 0;
+var pivot_data_builder_js_1 = require("./pivot-data-builder.js");
+Object.defineProperty(exports, "PivotDataBuilder", { enumerable: true, get: function () { return pivot_data_builder_js_1.PivotDataBuilder; } });
+var socket_builder_js_1 = require("./socket-builder.js");
+Object.defineProperty(exports, "SocketBuilder", { enumerable: true, get: function () { return socket_builder_js_1.SocketBuilder; } });