@qrvey/utils 1.2.9-2 → 1.2.9-23

package/src/qrvey/helpers/transformValue.ts

@@ -0,0 +1,47 @@
+import { isDateColumn } from "../../columns/helpers/isDateColumn";
+import { isNumericalColumn } from "../../columns/helpers/isNumericalColumn";
+import { IDateColumnPropertyType } from "../../columns/interfaces/IDateColumnPropertyType";
+import { DATE_GROUPING_PROPERTY } from "../../dates/constants/DATE_GROUPING_PROPERTY";
+import { DATE_GROUPING_TIME_PROPERTY } from "../../dates/constants/DATE_GROUPING_TIME_PROPERTY";
+import { addFormat } from "../../format/format";
+import { getI18nDateGroupLabel } from "../../globalization/helpers/getI18nDateGroupLabel";
+import { ITransformValueSettings } from "../interfaces/ITransformValueSettings";
+import { getValueWithSuffixes } from "./getValueWithSuffixes";
+
+/**
+ * Transforms a value depending of localization/globalization and extras settings.
+ * @param value A value to transform
+ * @param settings The settings of the transformValue function
+ * @returns A transformed value
+ */
+export function transformValue(value: string, settings: ITransformValueSettings): string {
+    const valueWithI18n = getI18nDateGroupLabel(value, settings.property as IDateColumnPropertyType, settings.translate);
+    
+    const valueWithLocalization = addFormat(valueWithI18n, getOutputFormat(settings), getFormatConfig(settings));
+    return getValueWithSuffixes(valueWithLocalization, { suffixTranslateLabel: settings.suffixTranslateLabel, translate: settings.translate });
+}
+
+/**
+ * Gets the outputformat settings
+ * @param settings The settings of the transformValue function
+ * @returns the outputformat settings
+ */
+function getOutputFormat(settings: ITransformValueSettings) {
+    let type, format;
+    if (isDateColumn(settings.column) && [DATE_GROUPING_PROPERTY.DAY, DATE_GROUPING_TIME_PROPERTY.HOUR, DATE_GROUPING_TIME_PROPERTY.MINUTE, DATE_GROUPING_TIME_PROPERTY.SECOND].includes(settings.property as any)) {
+        type = 'DATE';
+        format = 'Default';
+    } else if (isNumericalColumn(settings.column)) {
+        type = 'NUMERIC';
+    }
+    return { type, format };
+}
+
+/**
+ * Gets the format config
+ * @param settings The settings of the transformValue function
+ * @returns the format config
+ */
+function getFormatConfig(settings: ITransformValueSettings) {
+    return { lang: settings.i18n?.locale };
+}

package/src/qrvey/interfaces/IGetValueWithSuffixesSettings.ts

@@ -0,0 +1,12 @@
+import { II18nServiceTranslate } from "../../globalization/interfaces/II18nServiceTranslate";
+
+export interface IGetValueWithSuffixesSettings {
+    translate?: II18nServiceTranslate; // Function for getting translations
+    suffixTranslateLabel?: string; // Label of the i18n path for translations
+    suffixes?: IGetValueWithSuffixesSettingsSuffixes; // Manual suffixes to add if the translate and the suffixes translate label is not present
+}
+
+interface IGetValueWithSuffixesSettingsSuffixes {
+    singular: string;
+    plural: string;
+}

package/src/qrvey/interfaces/ITransformValueSettings.ts

@@ -0,0 +1,13 @@
+import { IColumn } from "../../columns/interfaces/IColumn";
+import { IColumnPropertyType } from "../../columns/interfaces/IColumnPropertyType";
+import { II18nConfig } from "../../globalization/interfaces/II18nConfig";
+import { II18nServiceTranslate } from "../../globalization/interfaces/II18nServiceTranslate";
+
+export interface ITransformValueSettings {
+    column: IColumn;
+    property: IColumnPropertyType;
+
+    translate: II18nServiceTranslate; // Function for getting translations
+    i18n: II18nConfig; // The i18n configuration;
+    suffixTranslateLabel?: string // The i18n label for the suffix values.
+}

package/src/qrvey/interfaces/index.ts

@@ -3,3 +3,5 @@ export * from './ICalculation';
 export * from './ICalculationInfo';
 export * from './ICalculationType';
 export * from './IDataset';
+export * from './IGetValueWithSuffixesSettings';
+export * from './ITransformValueSettings';

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

@@ -6,10 +6,11 @@ import { getDatasetColumns } from "./getDatasetColumns.api";
 
 /**
  * Get a dataset list from a collection of Qrvey IDs
- * @param qrveyids Collection of Qrvey IDs
+ * @param config the widget config. Includes the appid and others configuration properties
+ * @param pickDatasets Collection of Qrvey IDs for filtering the request
  * @returns a promise
  */
-export function getAllDatasets (config: IGeneralWidgetConfig, pickDatasets: string[] = []): Promise<IDataset[]> {
+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);

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

@@ -3,6 +3,7 @@ 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 { chooseLang } from "../..";
 
 /**
    * Get a dataset by Qrvey ID
@@ -10,10 +11,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
-    })
+    }, { lang })
     .then(BDatasetsToUIDatasets)
     .catch(_e => []);
 }

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/globalization/interfaces/chart_builder/II18nChartBuilderComplexAddress.d.ts

@@ -1,5 +0,0 @@
-import { II18nChartBuilderAddress } from "./II18nChartBuilderAddress";
-export interface II18nChartBuilderComplexAddress extends II18nChartBuilderAddress {
-    street: string;
-    country: string;
-}

package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexFile.d.ts

@@ -1,4 +0,0 @@
-export interface II18nChartBuilderComplexFile {
-    file_size: string;
-    file_type: string;
-}

package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexImage.d.ts

@@ -1,4 +0,0 @@
-export interface II18nChartBuilderComplexImage {
-    image_size: string;
-    image_type: string;
-}

package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexImageAnalysis.d.ts

@@ -1,4 +0,0 @@
-export interface II18nChartBuilderComplexImageAnalysis {
-    word: string;
-    categories: string;
-}

package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexName.d.ts

@@ -1,4 +0,0 @@
-export interface II18nChartBuilderComplexName {
-    first_name: string;
-    last_name: string;
-}

package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexText.d.ts

@@ -1,6 +0,0 @@
-export interface II18nChartBuilderComplexText {
-    words: string;
-    keyphrases: string;
-    sentiment: string;
-    entities: string;
-}

package/dist/cjs/globalization/interfaces/chart_builder/II18nChartBuilderComplexUsaAddress.d.ts

@@ -1,5 +0,0 @@
-import { II18nChartBuilderAddress } from "./II18nChartBuilderAddress";
-export interface II18nChartBuilderComplexUsaAddress extends II18nChartBuilderAddress {
-    address_1: string;
-    address_2: string;
-}

package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexAddress.d.ts

@@ -1,5 +0,0 @@
-import { II18nChartBuilderAddress } from "./II18nChartBuilderAddress";
-export interface II18nChartBuilderComplexAddress extends II18nChartBuilderAddress {
-    street: string;
-    country: string;
-}

package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexFile.d.ts

@@ -1,4 +0,0 @@
-export interface II18nChartBuilderComplexFile {
-    file_size: string;
-    file_type: string;
-}

package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexImage.d.ts

@@ -1,4 +0,0 @@
-export interface II18nChartBuilderComplexImage {
-    image_size: string;
-    image_type: string;
-}

package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexImageAnalysis.d.ts

@@ -1,4 +0,0 @@
-export interface II18nChartBuilderComplexImageAnalysis {
-    word: string;
-    categories: string;
-}

package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexName.d.ts

@@ -1,4 +0,0 @@
-export interface II18nChartBuilderComplexName {
-    first_name: string;
-    last_name: string;
-}

package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexText.d.ts

@@ -1,6 +0,0 @@
-export interface II18nChartBuilderComplexText {
-    words: string;
-    keyphrases: string;
-    sentiment: string;
-    entities: string;
-}

package/dist/globalization/interfaces/chart_builder/II18nChartBuilderComplexUsaAddress.d.ts

@@ -1,5 +0,0 @@
-import { II18nChartBuilderAddress } from "./II18nChartBuilderAddress";
-export interface II18nChartBuilderComplexUsaAddress extends II18nChartBuilderAddress {
-    address_1: string;
-    address_2: string;
-}

package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexAddress.ts

@@ -1,6 +0,0 @@
-import { II18nChartBuilderAddress } from "./II18nChartBuilderAddress";
-
-export interface II18nChartBuilderComplexAddress extends II18nChartBuilderAddress {
-    street: string;
-    country: string;
-}

package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexFile.ts

@@ -1,4 +0,0 @@
-export interface II18nChartBuilderComplexFile {
-    file_size: string;
-    file_type: string;
-}

package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexImage.ts

@@ -1,4 +0,0 @@
-export interface II18nChartBuilderComplexImage {
-    image_size: string;
-    image_type: string;
-}

package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexImageAnalysis.ts

@@ -1,4 +0,0 @@
-export interface II18nChartBuilderComplexImageAnalysis {
-    word: string;
-    categories: string;
-}

package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexName.ts

@@ -1,4 +0,0 @@
-export interface II18nChartBuilderComplexName {
-    first_name: string;
-    last_name: string;
-}

package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexText.ts

@@ -1,6 +0,0 @@
-export interface II18nChartBuilderComplexText {
-    words: string;
-    keyphrases: string;
-    sentiment: string;
-    entities: string;
-}

package/src/globalization/interfaces/chart_builder/II18nChartBuilderComplexUsaAddress.ts

@@ -1,6 +0,0 @@
-import { II18nChartBuilderAddress } from "./II18nChartBuilderAddress";
-
-export interface II18nChartBuilderComplexUsaAddress extends II18nChartBuilderAddress {
-    address_1: string;
-    address_2: string;
-}