@qrvey/utils 1.2.9-13 → 1.2.9-17

package/src/globalization/interfaces/style_themes/II18nStyleThemesTooltips.ts

@@ -0,0 +1,3 @@
+export interface II18nStyleThemesTooltips {
+    theme_used_in_all_applications: string;
+}

package/src/globalization/interfaces/style_themes/index.ts

@@ -0,0 +1,6 @@
+export * from './II18nStyleThemes';
+export * from './II18nStyleThemesDeleteDialog';
+export * from './II18nStyleThemesMenu';
+export * from './II18nStyleThemesMessages';
+export * from './II18nStyleThemesTheme';
+export * from './II18nStyleThemesTooltips';

package/src/globalization/labels/I18N_DEFAULT.ts

@@ -11,6 +11,7 @@ import { I18N_FILTER_DISPLAY } from "./filters/I18N_FILTER_DISPLAY";
 import { I18N_BUCKET_BUILDER } from "./bucket_builder/I18N_BUCKET_BUILDER";
 import { I18N_CROSS_TABS } from './cross_tabs';
 import { I18N_CHART_BUILDER } from "./chart_builder";
+import { I18N_STYLE_THEMES } from "./style_themes";
 
 
 export const I18N_DEFAULT: IResourceI18n = {
@@ -25,5 +26,6 @@ export const I18N_DEFAULT: IResourceI18n = {
     filter_panel: I18N_FILTER_PANEL,
     formula_builder: I18N_FORMULA_BUILDER,
     panel: I18N_PANEL,
+    style_themes: I18N_STYLE_THEMES,
     table_charts: I18N_TABLE_CHARTS,
 };

package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_LAYER_OPTIONS.ts

@@ -3,7 +3,7 @@ import { II18nChartBuilder } from "../..";
 type LayerOptions = 'trends_line' | 'references_line';
 export const I18N_CHART_BUILDER_LAYER_OPTIONS: Pick<II18nChartBuilder, LayerOptions> = {
     trends_line: {
-        title: 'Trends line',
+        title: 'Trend Line',
         type: 'Type',
         type_none: 'None',
         type_standard_linear_regression: 'Standard Linear Regression',

package/src/globalization/labels/chart_builder/I18N_CHART_BUILDER_STYLE_OPTIONS.ts

@@ -19,9 +19,9 @@ export const I18N_CHART_BUILDER_STYLE_OPTIONS: Pick<II18nChartBuilder, StyleOpti
         comparision_color: 'Comparision Color',
         data_labels_check: 'Data Labels',
         default_format_title: 'Format',
-        display_outliers_check: 'Display outliers',
+        display_outliers_check: 'Display Outliers',
         line_opacity: 'Line Opacity',
-        map_borders: 'Map borders',
+        map_borders: 'Map Borders',
         needle_color: 'Needle Color',
         opacity: 'Opacity',
         percentage_check: 'Percentage',
@@ -156,13 +156,15 @@ export const I18N_CHART_BUILDER_STYLE_OPTIONS: Pick<II18nChartBuilder, StyleOpti
         names_rotation: 'Names Rotation',
     },
     font_options: {
+        automatic_resize: 'Automatic Resize',
         color: 'Font Color',
+        disabled: '<i>Automatic Resize</i> is active, disable it to set the size manually.',
+        select_option_placeholder: 'Select Option',
+        size: 'Font Size',
         style: 'Font Style',
-        style_regular: 'Regular',
         style_bold: 'Bold',
         style_italic: 'Italic',
-        automatic_resize: 'Automatic Resize',
-        size: 'Font Size',
+        style_regular: 'Regular',
     },
     circle_size: {
         title: 'Circle Size',
@@ -186,7 +188,7 @@ export const I18N_CHART_BUILDER_STYLE_OPTIONS: Pick<II18nChartBuilder, StyleOpti
         target_value: 'Target Value'
     },
     table_style_options: {
-        typeface: 'Typeface', // used
+        typeface: 'Typeface', 
         weight: 'Weight',
         weight_bold: 'Bold',
         weight_normal: 'normal',

package/src/globalization/labels/index.ts

@@ -1,10 +1,12 @@
+export * from './bucket_builder';
+export * from './chart_builder';
 export * from './columns';
 export * from './common';
+export * from './cross_tabs';
 export * from './dashboard';
 export * from './filters';
+export * from './formula_builder';
 export * from './panel';
+export * from './style_themes';
 export * from './table_charts';
 export * from './I18N_DEFAULT';
-export * from './formula_builder';
-export * from './bucket_builder';
-export * from './chart_builder';

package/src/globalization/labels/style_themes/I18N_STYLE_THEMES.ts

@@ -0,0 +1,56 @@
+import { II18nStyleThemes } from "../../interfaces/style_themes/II18nStyleThemes";
+
+export const I18N_STYLE_THEMES: II18nStyleThemes = {
+    delete_dialog: {
+      no: 'No',
+      theme_in_use: 'This theme is in use. If you delete it the visualizations will reset to the default theme.',
+      want_to_continue: 'Are you sure you want to continue?',
+      yes: 'Yes',
+    },
+    menu: {
+      delete: 'Delete',
+      duplicate: 'Duplicate',
+      edit: 'Edit',
+      use_all: 'Use in all applications',
+    },
+    messages: {
+      theme_could_not_be_created: 'Theme could not be created.',
+      theme_could_not_be_deleted: 'Theme could not be deleted.',
+      theme_could_not_be_duplicated: 'Theme could not be duplicated.',
+      theme_could_not_be_saved: 'Theme could not be saved.',
+      theme_could_not_be_selected: 'Theme could not be selected.',
+      theme_could_not_be_used_in_all_applications: 'Theme could not be used in all applications.',
+      themes_could_not_be_loaded: 'Themes could not be loaded.',
+    },
+    theme: {
+      axis_data_labels: 'Axis and Data Labels',
+      cancel_theme: 'Cancel',
+      chart_titles_color: 'Chart Titles Color',
+      copy: 'Copy',
+      create_theme: 'Create New Theme',
+      data_styles: 'Data Styles',
+      data_visualization: 'Data Visualization',
+      edit_theme: 'Edit Theme',
+      generate_new: 'Generate New',
+      header_font_color: 'Header Font Color',
+      id: 'ID',
+      legends: 'Legends',
+      main_color: 'Main Color',
+      name_placeholder: 'Type name',
+      panel_styles: 'Panel Styles',
+      qrvey_theme: 'Qrvey Theme',
+      restore_to_default: 'Restore to Default',
+      save_theme: 'Save Theme',
+      table_header_styles: 'Table Header Styles',
+      text_styles: 'Text Styles',
+      tooltips: 'Tooltips',
+      typeface: 'Typeface',
+      untitled_theme: 'Untitled',
+      use_theme_in_all_apps: 'Use Theme in All Apps',
+      values: 'Values',
+    },
+    title: 'Style Themes',
+    tooltips: {
+      theme_used_in_all_applications: 'This theme is being used in all applications',
+    }
+  };

package/src/globalization/labels/style_themes/index.ts

@@ -0,0 +1 @@
+export * from './I18N_STYLE_THEMES';

package/src/globalization/labels/table_charts/I18N_TABLE_CHARTS.ts

@@ -11,7 +11,7 @@ export const I18N_TABLE_CHARTS: II18nTableCharts = {
         }
     },
     pagination: {
-        page_info: 'Page {0} of {1} ',
+        page_info: 'Page {{currentPage}} of {{pages}}',
         records: 'Records',
         records_per_page: 'Records per page',
         total_records: 'Total records'

package/src/interfaces/format/IFormatConfig.Interface.ts

@@ -0,0 +1,5 @@
+export interface IFormatConfig {
+    lang?: string;
+    options?: object;
+    isMultiplied?: boolean;
+}

package/src/interfaces/format/IFormatCurrency.Interface.ts

@@ -0,0 +1,4 @@
+export interface IFormatCurrency {
+    text: string;
+    label: string;
+}

package/src/interfaces/format/IFormatOutputFormat.Interface.ts

@@ -0,0 +1,9 @@
+import { IFormatCurrency } from "./IFormatCurrency.Interface";
+
+export interface IFormatOutputFormat {
+    format: string;
+    type: string;
+    decimals?: number;
+    currency?: IFormatCurrency;
+    backup_currency?: IFormatCurrency;
+}

package/src/interfaces/format/index.ts

@@ -0,0 +1,3 @@
+export * from './IFormatConfig.Interface';
+export * from './IFormatOutputFormat.Interface';
+export * from './IFormatCurrency.Interface';

package/src/interfaces/general/IGeneralWidgetConfig.ts

@@ -3,8 +3,10 @@ export interface IGeneralWidgetConfig {
     apiKey?: string;
     qrveyid?: string;
     qv_token?: string;
+    locale?: string;
     timezoneControl?: string;
     isFromAN?: boolean;
     appid: string;
     userid: string;
+    lang?: string;
 }

package/src/interfaces/index.ts

@@ -2,3 +2,4 @@ export * from './Chart.Interface';
 export * from './IChartBuilder.Interface';
 export * from './general';
 export * from './Qrvey.Interface';
+export * from './format';

package/src/qrvey/helpers/getValueWithSuffixes.ts

@@ -0,0 +1,19 @@
+import { isEmpty } from "../../general/mix/isEmpty";
+import { isNaNV2 } from "../../general/mix/isNaNV2";
+import { IGetValueWithSuffixesSettings } from "../interfaces/IGetValueWithSuffixesSettings";
+
+/**
+ * Get a string value with suffixes if available.
+ * Add suffix into the value string. Prioritized for numeric values.
+ * @param value a number or string
+ * @param suffixes An object with singular or plural suffix string.
+ * @returns a string value with suffix
+ */
+export function getValueWithSuffixes(value: string | number, settings: IGetValueWithSuffixesSettings): string {
+    let suffix = '';
+    if (!isNaNV2(value)) {
+        if (!isEmpty(settings.suffixTranslateLabel) && !isEmpty(settings.translate)) suffix = settings.translate(settings.suffixTranslateLabel, { count: +value });
+        if (!isEmpty(settings.suffixes)) suffix = (+value > 1 || +value === 0) ? settings.suffixes.plural : settings.suffixes.singular;
+    }
+    return value + (!isEmpty(suffix) ? ' ' + suffix : '');
+}

package/src/qrvey/helpers/index.ts

@@ -1,2 +1,4 @@
 export * from './getColumnsLabel';
 export * from './getPropertyLabel';
+export * from './getValueWithSuffixes';
+export * from './transformValue';

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.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,12 @@
+import { IColumn } from "../../columns/interfaces/IColumn";
+import { IColumnPropertyType } from "../../columns/interfaces/IColumnPropertyType";
+import { II18nServiceTranslate } from "../../globalization/interfaces/II18nServiceTranslate";
+
+export interface ITransformValueSettings {
+    column: IColumn;
+    property: IColumnPropertyType;
+
+    translate: II18nServiceTranslate; // Function for getting translations
+    locale: string; // The locale string
+    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,8 @@ 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 { LANG_DEFAULT } from "../../format/definition";
+import { getLang } from "../..";
 
 /**
    * Get a dataset by Qrvey ID
@@ -11,6 +13,7 @@ import { BDatasetsToUIDatasets } from "../adapters/BDatasetsToUIDatasets.adapter
    */
 export function getDatasetColumns(config: IGeneralWidgetConfig, qrveyid?: string): Promise<IDataset[]> {
     return Request.post({ ...config, qrveyid, endpoint: CHART_ENDPOINT }, '/question/list', {
+      'lang': getLang(config.lang || config.locale || LANG_DEFAULT).lang,
       'optionsAttributes': ['id', 'text', 'type', 'property', 'linked', 'linkid', 'qrveyid', 'bucketId', 'formulaId', 'formulaType', 'geogroup', 'outputFormat'],
       'extend': true
     })

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');
     });