@qrvey/utils 1.2.9-9 → 1.2.10-0

package/src/services/api/Charts.api.ts

@@ -0,0 +1,44 @@
+import Request from "../helpers/Request";
+import { CHART_ENDPOINT } from "../constants/CHART_ENDPOINT";
+import { UCHART_ENDPOINT } from "../constants/UCHART_ENDPOINT";
+import { UCHART_PAGINATION_ENDPOINT } from "../constants/UCHART_PAGINATION_ENDPOINT";
+
+export interface IFieldsConfig {
+  type: string;
+  column?;
+  qrvey_id?: string;
+  showBuckets?: boolean;
+  showLinkedDatasets?: boolean;
+}
+
+export default class ChartsApi {
+  abortCtrl: AbortController;
+
+  constructor(public config) {
+    this.config = { ...config, endpoint: CHART_ENDPOINT };
+  }
+
+  createSignal() {
+    this.abortCtrl && this.abortCtrl.abort();
+    this.abortCtrl = new AbortController();
+    return this.abortCtrl.signal;
+  }
+
+  getResults(data, ignoreSignal = false, newEndpoint = false) {
+    const signal = ignoreSignal ? undefined : this.createSignal();
+    if (data.filters) {
+      data.logic = data.filters;
+      delete data.filters;
+    }
+    return Request.post({ ...this.config, endpoint: newEndpoint ? UCHART_ENDPOINT : CHART_ENDPOINT, signal }, '/results', data);
+  }
+
+  getResultsPagination(data, ignoreSignal = false) {
+    const signal = ignoreSignal ? undefined : this.createSignal();
+    if (data.filters) {
+      data.logic = data.filters;
+      delete data.filters;
+    }
+    return Request.post({ ...this.config, endpoint: UCHART_PAGINATION_ENDPOINT, signal }, '', data);
+  }
+}

package/src/services/api/getAllDatasets.api.ts

@@ -1,23 +1,30 @@
-import { flattenDeep, isEmpty } from "../../general";
+import { getArrayByProperty } from "../../general/array/getArrayByProperty";
+import { isEmpty } from "../../general/mix/isEmpty";
 import { IGeneralWidgetConfig } from "../../interfaces/general/IGeneralWidgetConfig";
 import { IDataset } from "../../qrvey/interfaces/IDataset";
 import { getAllQrveys } from "./getAllQrveys.api";
-import { getDatasetColumns } from "./getDatasetColumns.api";
+import { getDatasetsByIds } from "./getDatasetsByIds.api";
 
 /**
  * Get a dataset list from a collection of Qrvey IDs
- * @param qrveyids Collection of Qrvey IDs
- * @returns a promise
+ * Considerations for qrveyids second argument:
+ * - If it is a undefined argument, the function will return all available datasets of the app
+ * - If it is a empty array argument, the function will return an empty dataset list. (A request will not be executed)
+ * - If it is a non-empty array argument, the function will return a set of available datasets
+ * @param config the widget config. Includes general configuration properties
+ * @param qrveyids Collection of Qrvey IDs for returning a set of available datasets
+ * @returns a promise that if it is resolved displays a collection of dataset info.
  */
-export function getAllDatasets (config: IGeneralWidgetConfig, pickDatasets: string[] = []): Promise<IDataset[]> {
-    return getAllQrveys({ ...config }, { status: ['RUNNING', 'FINISHED', 'PAUSED'], loadAll: true })
-      .then((qrveys) => {
-          let datasets = qrveys.Items.filter(filterSupportedDatasets);
-          if (!isEmpty(pickDatasets)) datasets = datasets.filter(item => pickDatasets.includes(item.qrveyid));
-          return Promise.all(datasets.map(dataset => getDatasetColumns(config, dataset.qrveyid))).then(response => flattenDeep(response));
-      }).catch(_e => Promise.all([]));
-}
-
-function filterSupportedDatasets (dataset) {
-  return !['NPS', 'CHECKLIST'].includes(dataset.appType.toUpperCase());
+export function getAllDatasets(config: IGeneralWidgetConfig, qrveyids?: string[]): Promise<IDataset[]> {
+    if (Array.isArray(qrveyids) && isEmpty(qrveyids)) {
+        return Promise.resolve([] as IDataset[]);
+    } else if (Array.isArray(qrveyids) && !isEmpty(qrveyids)) {
+        return getDatasetsByIds(config, qrveyids);
+    } else {
+        return getAllQrveys({ ...config }, { status: ['RUNNING', 'FINISHED', 'PAUSED'], loadAll: true })
+        .then((qrveys) => {
+            const datasets: any[] = qrveys.Items.filter(item => !['NPS', 'CHECKLIST'].includes(item.appType.toUpperCase()));
+            return getDatasetsByIds(config, getArrayByProperty(datasets, 'qrveyid'));
+        }).catch(_e => [] as IDataset[]);
+    }
 }

package/src/services/api/getAllQrveys.api.ts

@@ -3,7 +3,7 @@ import Request from "../helpers/Request";
 import IPayloadQrveyAll from "../interfaces/IPayloadQrveyAll";
 
  /**
-   * POST Request for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
+   * Request function for getting Qrveys such as Web Forms and Datasets. Use params for getting precise data
    * @param config Configuration
    * @param params  Object for getting precise data
    */

package/src/services/api/getDatasetColumns.api.ts

@@ -1,8 +1,10 @@
-import { IGeneralWidgetConfig } from "../../interfaces/general/IGeneralWidgetConfig";
-import { IDataset } from "../../qrvey/interfaces/IDataset";
-import { CHART_ENDPOINT } from "../constants/CHART_ENDPOINT";
-import Request from "../helpers/Request";
-import { BDatasetsToUIDatasets } from "../adapters/BDatasetsToUIDatasets.adapter";
+import { IGeneralWidgetConfig } from '../../interfaces/general/IGeneralWidgetConfig';
+import { IDataset } from '../../qrvey/interfaces/IDataset';
+import { CHART_ENDPOINT } from '../constants/CHART_ENDPOINT';
+import Request from '../helpers/Request';
+import { BDatasetsToUIDatasets } from '../adapters/BDatasetsToUIDatasets.adapter';
+import { getDefaultQuestionListOptionsAttributes } from '../helpers/getDefaultQuestionListOptionsAttributes';
+import { chooseLang } from '../../format/localization';
 
 /**
    * Get a dataset by Qrvey ID
@@ -10,10 +12,11 @@ import { BDatasetsToUIDatasets } from "../adapters/BDatasetsToUIDatasets.adapter
    * @returns a promise
    */
 export function getDatasetColumns(config: IGeneralWidgetConfig, qrveyid?: string): Promise<IDataset[]> {
+    const lang = chooseLang(config);
     return Request.post({ ...config, qrveyid, endpoint: CHART_ENDPOINT }, '/question/list', {
-      'optionsAttributes': ['id', 'text', 'type', 'property', 'linked', 'linkid', 'qrveyid', 'bucketId', 'formulaId', 'formulaType', 'geogroup', 'outputFormat'],
-      'extend': true
-    })
+      optionsAttributes: getDefaultQuestionListOptionsAttributes(),
+      extend: true,
+    }, { lang })
     .then(BDatasetsToUIDatasets)
     .catch(_e => []);
 }

package/src/services/api/getDatasetsByIds.api.ts

@@ -0,0 +1,26 @@
+import { IGeneralWidgetConfig } from '../../interfaces/general/IGeneralWidgetConfig';
+import { IDataset } from '../../qrvey/interfaces/IDataset';
+import Request from '../helpers/Request';
+import { BDatasetsToUIDatasets } from '../adapters/BDatasetsToUIDatasets.adapter';
+import { isEmpty } from '../../general/mix/isEmpty';
+import { chooseLang } from '../../format/localization';
+import { getDefaultQuestionListOptionsAttributes } from '../helpers/getDefaultQuestionListOptionsAttributes';
+import { QUESTION_LIST_BULK_ENDPOINT } from '../constants/QUESTION_LIST_BULK_ENDPOINT';
+
+/**
+   * Get a dataset by Qrvey ID
+   * @param qrveyid The Qrvey ID
+   * @returns a promise
+   */
+export function getDatasetsByIds(config: IGeneralWidgetConfig, qrveyids: string[] = []): Promise<IDataset[]> {
+    if (Array.isArray(qrveyids) && !isEmpty(qrveyids)) {
+        const lang = chooseLang(config);
+        return Request.post({ ...config, endpoint: QUESTION_LIST_BULK_ENDPOINT }, '', {
+          optionsAttributes: getDefaultQuestionListOptionsAttributes(),
+          qrveyids
+        }, { lang })
+        .then(response => BDatasetsToUIDatasets(response?.data || []))
+        .catch(_e => [] as IDataset[]);
+    }
+    return Promise.resolve([]);
+}

package/src/services/api/getModel.api.ts

@@ -0,0 +1,10 @@
+import Request from "../helpers/Request";
+import { chooseLang } from "../../format/localization";
+import { ANALYTIQ_ENDPOINT } from "../constants/MODEL_ENDPOINT";
+import { BModelToUIModel } from "../adapters/BModelToUIModel.adapter";
+
+export function getModel(config, params?) {
+    const lang = chooseLang(config);
+    const data = { lang, logic: config.logic || [] };
+    return Request.post({ ...config, endpoint: ANALYTIQ_ENDPOINT }, '', data, { ...params, lang }).then(BModelToUIModel);
+}

package/src/services/api/index.ts

@@ -1,3 +1,5 @@
 export * from './getAllDatasets.api';
 export * from './getAllQrveys.api';
 export * from './getDatasetColumns.api';
+export * from './getDatasetsByIds.api';
+export * from './getModel.api';

package/src/services/constants/MODEL_ENDPOINT.ts

@@ -0,0 +1,6 @@
+import { IEndpointConfig } from "../interfaces/IEndpointConfig";
+
+export const ANALYTIQ_ENDPOINT: IEndpointConfig = {
+    uri: '/app/:app_id/qrvey/:qrvey_id/analytiq/model',
+    version: 4
+};

package/src/services/constants/QUESTION_LIST_BULK_ENDPOINT.ts

@@ -0,0 +1,6 @@
+import { IEndpointConfig } from "../interfaces/IEndpointConfig";
+
+export const QUESTION_LIST_BULK_ENDPOINT: IEndpointConfig = {
+  uri: '/app/:app_id/analytiq/chart/question/list/bulk',
+  version: 4
+};

package/src/services/constants/UCHART_ENDPOINT.ts

@@ -0,0 +1,6 @@
+import { IEndpointConfig } from "../interfaces/IEndpointConfig";
+
+export const UCHART_ENDPOINT: IEndpointConfig = {
+    uri: '/app/:app_id/qrvey/:qrvey_id/analytiq/uchart',
+    version: 4
+};

package/src/services/constants/UCHART_PAGINATION_ENDPOINT.ts

@@ -0,0 +1,6 @@
+import { IEndpointConfig } from "../interfaces/IEndpointConfig";
+
+export const UCHART_PAGINATION_ENDPOINT: IEndpointConfig = {
+  uri: '/app/:app_id/qrvey/:qrvey_id/analytiq/uchart/results/pagination',
+  version: 4
+};

package/src/services/constants/index.ts

@@ -1,2 +1,8 @@
 export * from './CHART_ENDPOINT';
+export * from './MODEL_ENDPOINT';
 export * from './QRVEY_ENDPOINT';
+
+export * from './QUESTION_LIST_BULK_ENDPOINT';
+
+export * from './UCHART_ENDPOINT';
+export * from './UCHART_PAGINATION_ENDPOINT';

package/src/services/helpers/getDefaultQuestionListOptionsAttributes.ts

@@ -0,0 +1,24 @@
+export function getDefaultQuestionListOptionsAttributes() {
+    return [
+      'id',
+      'text',
+      'type',
+      'property',
+      'linked',
+      'linkid',
+      'qrveyid',
+      'bucketId',
+      'formulaId',
+      'formulaType',
+      'geogroup',
+      'outputFormat',
+      'answers', // For multiples webform column types
+      'imageUploadOption', // For Image upload
+      'sliderVal', // For slidebar
+      'value', // For lookup
+      'activeCat', // For Expressions
+      'words', // For Expressions with disabled categories
+      'negative', // For Expressions with enabled categories
+      'positive' // For Expressions with enabled categories
+    ];
+}

package/src/services/helpers/index.ts

@@ -1 +1,2 @@
+export * from './getDefaultQuestionListOptionsAttributes';
 export * from './Request';

package/test/columns/isNumericalColumn.test.js

@@ -0,0 +1,154 @@
+const { COLUMN, FORMULA, isNumericalColumn } = require("../../dist/cjs");
+
+const column1 = {
+    id: '123',
+    qrveyid: 'abc',
+    type: COLUMN.NUMERIC
+};
+
+const column2 = {
+    id: '222',
+    qrveyid: 'abc',
+    type: COLUMN.RATING
+};
+
+const column3 = {
+    id: '333',
+    qrveyid: 'abc',
+    type: COLUMN.SLIDEBAR
+};
+
+const column4 = {
+    formulaid: '456',
+    formulaType: FORMULA.NUMBER,
+    id: '456',
+    qrveyid: 'abc',
+    type: COLUMN.FORMULA
+};
+
+const wrongColumn1 = {
+    formulaid: '456',
+    formulaType: FORMULA.DATE,
+    id: '494',
+    qrveyid: 'abc',
+    type: COLUMN.FORMULA
+};
+
+const wrongColumn2 = {
+    id: '789',
+    qrveyid: 'abc',
+    type: COLUMN.TEXTFIELD
+};
+
+describe('Testing undefined/empty arguments', function () {
+    const empty1 = undefined;
+    const empty2 = null;
+    const empty3 = '';
+    const empty4 = [];
+    const empty5 = {};
+
+    test('no argument passed', function () {
+        const validation = isNumericalColumn();
+        expect(validation).toBeFalsy();
+    });
+
+    test('Undefined argument', function () {
+        const validation = isNumericalColumn(empty1);
+        expect(validation).toBeFalsy();
+    });
+
+    test('Null argument', function () {
+        const validation = isNumericalColumn(empty2);
+        expect(validation).toBeFalsy();
+    });
+
+    test('Empty string argument', function () {
+        const validation = isNumericalColumn(empty3);
+        expect(validation).toBeFalsy();
+    });
+
+    test('Empty array argument', function () {
+        const validation = isNumericalColumn(empty4);
+        expect(validation).toBeFalsy();
+    });
+
+    test('Empty object argument', function () {
+        const validation = isNumericalColumn(empty5);
+        expect(validation).toBeFalsy();
+    });
+});
+
+describe('Testing no-object arguments', function () {
+    const variable1 = 1;
+    const variable2 = false;
+    const variable3 = new Date();
+    const variable4 = ['Hello', 'World'];
+    const variable5 = (num1 = 1, num2 = 2) => num1 + num2;
+
+    test('Numeric variable', function () {
+        const validation = isNumericalColumn(variable1);
+        expect(validation).toBeFalsy();
+    });
+
+    test('Boolean variable', function () {
+        const validation = isNumericalColumn(variable2);
+        expect(validation).toBeFalsy();
+    });
+
+    test('Date object variable', function () {
+        const validation = isNumericalColumn(variable3);
+        expect(validation).toBeFalsy();
+    });
+
+    test('Array variable', function () {
+        const validation = isNumericalColumn(variable4);
+        expect(validation).toBeFalsy();
+    });
+
+    test('Function-like variable', function () {
+        const validation = isNumericalColumn(variable5);
+        expect(validation).toBeFalsy();
+    });
+});
+
+describe('Testing invalid expected object', function () {
+    const variable1 = { tag1: 'value1', tag2: 'value2' };
+    
+    test('Different expected object', function () {
+        const validation = isNumericalColumn(variable1);
+        expect(validation).toBeFalsy();
+    });
+
+    test('Different column type 2', function () {
+        const validation = isNumericalColumn(wrongColumn1);
+        expect(validation).toBeFalsy();
+    });
+
+    test('Different column type 1', function () {
+        const validation = isNumericalColumn(wrongColumn2);
+        expect(validation).toBeFalsy();
+    });
+});
+
+describe('Regular scenarios', function () {
+    test('Scenario #1 - Numeric column type', function () {
+        const validation = isNumericalColumn(column1);
+        expect(validation).toBeTruthy();
+    });
+
+    test('Scenario #2 - Rating column type', function () {
+        const validation = isNumericalColumn(column2);
+        expect(validation).toBeTruthy();
+    });
+
+    test('Scenario #4 - Slidebar column type', function () {
+        const validation = isNumericalColumn(column3);
+        expect(validation).toBeTruthy();
+    });
+
+    test('Scenario #4 - Formula column type with a number type', function () {
+        const validation = isNumericalColumn(column4);
+        expect(validation).toBeTruthy();
+    });
+    
+});

package/test/format.test.js

@@ -1,29 +1,29 @@
-const { formatValue, defineFormat, formatAbbreviated } = require('../dist/cjs');
+const { addFormat, defineFormat, formatAbbreviated } = require('../dist/cjs');
 
 describe('Testing format util', function () {
     test('Number formats', function () {
-        const abbreviated = formatValue('1000000', {
+        const abbreviated = addFormat('1000000', {
             "type": "NUMERIC",
             "format": "Abbreviated",
             "decimals": "3"
         });
         expect(abbreviated).toEqual('1.00M');
 
-        const numeric = formatValue('1000000', {
+        const numeric = addFormat('1000000', {
             "type": "NUMERIC",
             "format": "Numeric",
             "decimals": "3"
         });
         expect(numeric).toEqual('1,000,000.000');
 
-        const currency = formatValue('1000000', {
+        const currency = addFormat('1000000', {
             "type": "NUMERIC",
             "format": "Currency",
             "decimals": "3"
         });
         expect(currency).toEqual(' $1,000,000.000');
 
-        const percentage = formatValue('1000000', {
+        const percentage = addFormat('1000000', {
             "type": "NUMERIC",
             "format": "Percentage",
             "decimals": "3"
@@ -32,31 +32,31 @@ describe('Testing format util', function () {
     });
 
     test('Date formats', function () {
-        const yyyyMMdd = formatValue('2021-08-06', {
+        const yyyyMMdd = addFormat('2021-08-06', {
             "type": "DATE",
             "format": "MM/DD/YYYY HH24:MM:SS"
         });
         expect(yyyyMMdd).toEqual('08/06/2021 00:00:00');
 
-        const yyyyMMddHHmmSS = formatValue('2021-08-06 05:30:50', {
+        const yyyyMMddHHmmSS = addFormat('2021-08-06 05:30:50', {
             "type": "DATE",
             "format": "MM/DD/YYYY HH24:MM:SS"
         });
         expect(yyyyMMddHHmmSS).toEqual('08/06/2021 05:30:50');
 
-        const ISOFormat = formatValue('2021-06-09T13:15:46', {
+        const ISOFormat = addFormat('2021-06-09T13:15:46', {
             "type": "DATE",
             "format": "MM/DD/YYYY hh:MM:SS"
         });
         expect(ISOFormat).toEqual('06/09/2021 01:15:46');
 
-        const ISOFormatRandom = formatValue('2021-06-09T13:15:46', {
+        const ISOFormatRandom = addFormat('2021-06-09T13:15:46', {
             "type": "DATE",
             "format": "MM YYYY H M s"
         });
         expect(ISOFormatRandom).toEqual('06 2021 13 6 46');
 
-        const ISOFormatRandom1 = formatValue('2018-01-01T00:00:00', {
+        const ISOFormatRandom1 = addFormat('2018-01-01T00:00:00', {
             "type": "DATE",
             "format": "Q MMMM Do ddd"
         });
@@ -336,7 +336,7 @@ describe('Define format tests', function () {
 
         const format = defineFormat(column, true);
         expect(format).toEqual({ type: 'NUMERIC', format: 'Currency', decimals: '3' });
-        const currency = formatValue('1000000', format);
+        const currency = addFormat('1000000', format);
         expect(currency).toEqual(' $1,000,000.000');
     });
 

package/dist/cjs/filters/interfaces/builder/IFilterBuilderGeneralConfig.d.ts

@@ -1,11 +0,0 @@
-/**
- * Structure for the Fiter Builder General config
- */
-export interface IFilterBuilderGeneralConfig {
-    apiKey?: string;
-    appid: string;
-    domain: string;
-    qv_token?: string;
-    timezoneControl?: string;
-    userid: string;
-}

package/dist/filters/interfaces/builder/IFilterBuilderGeneralConfig.d.ts

@@ -1,11 +0,0 @@
-/**
- * Structure for the Fiter Builder General config
- */
-export interface IFilterBuilderGeneralConfig {
-    apiKey?: string;
-    appid: string;
-    domain: string;
-    qv_token?: string;
-    timezoneControl?: string;
-    userid: string;
-}

package/src/filters/interfaces/builder/IFilterBuilderGeneralConfig.ts

@@ -1,11 +0,0 @@
-/**
- * Structure for the Fiter Builder General config
- */
-export interface IFilterBuilderGeneralConfig {
-    apiKey?: string; // Api Key to get access from servers. Optional if qv_token is set
-    appid: string; // App ID
-    domain: string; // The domain of the environment
-    qv_token?: string; // Qrvey Token for RLS
-    timezoneControl?: string;
-    userid: string; // User ID
-}