@qrvey/utils 1.1.0-9 → 1.1.2-1

package/src/filters/interfaces/backend/IFBExpression.ts

@@ -1,4 +1,4 @@
-import { IFBackendValidator } from "./IFBackendValidator"
+import { IFBackendValidator } from "./IFBackendValidator";
 import { IFBackendExpressionValue } from "./IFBackendExpressionValue";
 import { IFProperty } from "../IFProperty";
 

package/src/filters/interfaces/common/IFSFilterExtras.ts

@@ -1,5 +1,6 @@
 import { IFScope } from "../IFScope";
 import { IFSection } from "../IFSection";
+import { IFSFilterExtrasInfo } from "./IFSFilterExtrasInfo";
 
 /**
  * Structure for extra properties of the Filter.
@@ -10,4 +11,7 @@ export interface IFSFilterExtras {
     scope: IFScope; // Scope of the filter.
     scopeid?: string; // The scope ID. This is set depending on the scope type. Global: undefined; Tab: tabid; Page: pageid; DATA: qrveyid
     section?: IFSection; // The section when the filter is applied.
+    info?: IFSFilterExtrasInfo; // Extra filter info
+
+    [x: string]: any; // Specific case for those filters that need to store something else
 }

package/src/filters/interfaces/common/IFSFilterExtrasInfo.ts

@@ -0,0 +1,5 @@
+// Structure of extra info
+export interface IFSFilterExtrasInfo { 
+    icon: string; // An icon string related to the filter
+    label: string; // Info related to the filter
+}

package/src/filters/interfaces/common/IFSMergeFiltersSettings.ts

@@ -0,0 +1,8 @@
+
+/**
+ * Structure for MergeFilters property settings
+ */
+export interface IFSMergeFiltersSettings {
+    overwriteValues?: boolean;
+    setGroupedColumnOperator?: boolean;
+}

package/src/filters/interfaces/common/IFSParamsToGetFilter.ts

@@ -3,6 +3,7 @@ import { IFProperty } from "../IFProperty";
 import { IFScope } from "../IFScope";
 import { IFValidator } from "../IFValidator";
 import { IFSColumn } from "./IFSColumn";
+import { IFSParamsToGetFilterEnableds } from "./IFSParamsToGetFilterEnableds";
 
 /**
  * Structure for filter properties
@@ -10,7 +11,7 @@ import { IFSColumn } from "./IFSColumn";
 export interface IFSParamsToGetFilter {
     column?: IFSColumn;
     dateSection?: IFDateSection;
-    enableds?: boolean;
+    enableds?: IFSParamsToGetFilterEnableds;
     linkid?: string;
     panelid?: string;
     property?: IFProperty;

package/src/filters/interfaces/common/IFSParamsToGetFilterEnableds.ts

@@ -0,0 +1,9 @@
+/**
+ * Structure for filter structure enabled flags
+ */
+ export interface IFSParamsToGetFilterEnableds {
+    scopes?: boolean; // Flag to filter the scope enabled properties
+    datasets?: boolean; // Flag to filter the dataset enabled properties
+    filters?: boolean; // Flag to filter the filter enabled properties
+    values?: boolean; // Flag to filter the value enabled properties
+}

package/src/filters/interfaces/common/IFSParamsToGetFilterSettings.ts

@@ -12,4 +12,9 @@
         dataset?: boolean;
         filter?: boolean;
     };
+    filterEmptyArrays?: {
+        scope?: boolean;
+        dataset?: boolean;
+        filter?: boolean;
+    }
 }

package/src/filters/interfaces/common/index.ts

@@ -20,7 +20,10 @@ export * from './IFSDataset';
 export * from './IFSDataStore';
 export * from './IFSFilter';
 export * from './IFSFilterExtras';
+export * from './IFSFilterExtrasInfo';
+export * from './IFSMergeFiltersSettings';
 export * from './IFSParamsToGetFilter';
+export * from './IFSParamsToGetFilterEnableds';
 export * from './IFSParamsToGetFilterSettings';
 export * from './IFSScope';
 export * from './IFSScopeID';

package/src/filters/interfaces/panel/IFPSettingsFilterPanelBodyScopeScope.ts

@@ -14,4 +14,5 @@ import { IFPSettingsFilterPanelBodyScopeScopeHeader } from "./IFPSettingsFilterP
     readonly?: boolean; // True: validates read only, any event could not be executed in the scope.
     header?: IFPSettingsFilterPanelBodyScopeScopeHeader; // Scope header options. If this object does not provide, the options of settings.filterPanel.body.scope.header would be taken
     body?: IFPSettingsFilterPanelBodyScopeScopeBody; // Opciones para el body del scope.
+    settingDisplayed?: boolean; // True: Display the color settings
 }

package/src/filters/interfaces/panel/IFPSettingsFilterPanelHeader.ts

@@ -8,5 +8,6 @@ import { IFPSettingsFilterPanelHeaderMenu } from "./IFPSettingsFilterPanelHeader
     readonly?: boolean; // True: validates read only, any event could not be executed in the Filter Panel header.
     filterButtonDisplayed?: boolean; // True: Display Add Filter button.
     settingsButtonDisplayed?: boolean; // True: Display Setting button.
+    settingsReadonly?: boolean; // True: disable Settings section
     menu?: IFPSettingsFilterPanelHeaderMenu; // Option Menu Settings
 }

package/src/filters/interfaces/panel/IFPSettingsFilterPanelSettings.ts

@@ -1,9 +1,13 @@
+import { IFPSettingsFilterPanelSettingsScope } from "./IFPSettingsFilterPanelSettingsScope";
 import { IFPSettingsPanelView } from "./IFPSettingsPanelView";
 
 /**
  * Structure for the additional Filter Panel settings
  */
  export interface IFPSettingsFilterPanelSettings {
+    panelInPageViewShow?: boolean; // True: Display the option in the Filter Panel Settings section
     panelInPageViewDisplayed?: boolean; // True: Display the Filter Panel component in the Page View (End user)
     panelDefaultView?: IFPSettingsPanelView;
+    panelDefaultViewShow?: boolean;
+    scopeSettings?: IFPSettingsFilterPanelSettingsScope;
 }

package/src/filters/interfaces/panel/IFPSettingsFilterPanelSettingsScope.ts

@@ -0,0 +1,7 @@
+/**
+ * Scope Settings Structure
+ */
+export interface IFPSettingsFilterPanelSettingsScope {
+    displayIconDisplayed: boolean;
+    displayColorModeDisplayed: boolean;
+}

package/src/filters/interfaces/panel/IFilterPanelConfig.ts

@@ -1,7 +1,5 @@
 import { IFilterBuilderConfig } from "../builder";
-import { IFUData } from "../ui";
 import { IFUDataStore } from "../ui/IFUDataStore";
-import { IFPSettings } from "./IFPSettings";
 
 /**
  * Structure for the Filter Panel Config

package/src/filters/interfaces/panel/index.ts

@@ -36,5 +36,6 @@ export * from './IFPSettingsFilterPanelBodyDatasetHeader';
 export * from './IFPSettingsFilterPanelBodyFilter';
 export * from './IFPSettingsFilterPanelBodyFilterMenu';
 export * from './IFPSettingsFilterPanelBodyOperator';
+export * from './IFPSettingsFilterPanelSettingsScope';
 
 export * from './IFPSettingsPanelView';

package/src/filters/interfaces/ui/IFUFilterExtras.ts

@@ -1,5 +1,5 @@
 import { IQrveyDataset } from "../../../interfaces/Qrvey.Interface";
-import { IFSDataset, IFSFilterExtras, IFSScope } from "../common";
+import { IFSFilterExtras } from "../common";
 import { IFUDataset } from "./IFUDataset";
 import { IFUScope } from "./IFUScope";
 

package/src/format/definition.ts

@@ -1,5 +1,6 @@
 
 import { COLUMN, CHART_TYPE } from '../constants';
+import { ChartType } from '../interfaces';
 
 export const textFields: string[] = [COLUMN.TEXTFIELD, COLUMN.TEXT_CATEGORY, COLUMN.TEXT_LABEL, COLUMN.TEXT_CATEGORY];
 
@@ -28,15 +29,15 @@ export const QUESTION_FORMAT_SUPPORT = [
   ];
 export const DATEGROUP_FORMATTING_UNSUPPORT = ['YEAR', 'QUARTER', 'MONTH', 'WEEK'];
 
-export const appliesFormatting = (columnType) => QUESTION_FORMAT_SUPPORT.includes(columnType);
+export const appliesFormatting = (columnType): boolean => QUESTION_FORMAT_SUPPORT.includes(columnType);
 
-export const hasfileSizeProperty = (column: any = {}) => isComplexColumn(column) && column.property && (column.property.value || column.property).includes('fileSize');
+export const hasfileSizeProperty = (column: any = {}): boolean => isComplexColumn(column) && column.property && (column.property.value || column.property).includes('fileSize');
 
-export const isComplexColumn = (column: any = {}) => complexFields.includes(column.type);
+export const isComplexColumn = (column: any = {}): boolean => complexFields.includes(column.type);
 
-export const isNumericalColumn = (column: any = {}) => numericalFields.includes(column.type) || column.formulaType === 'number';
+export const isNumericalColumn = (column: any = {}): boolean => numericalFields.includes(column.type) || column.formulaType === 'number';
 
-export function supportNumericFormatting(chartType): boolean {
+export function supportNumericFormatting(chartType: ChartType): boolean {
     const supportedCharts = [
       CHART_TYPE.TABLE_CHART,
       CHART_TYPE.CROSSTAB_CHART,
@@ -52,6 +53,4 @@ export function supportNumericFormatting(chartType): boolean {
     return supportedCharts.includes(chartType);
   }
 
-export const isTextColumn = (column: any) => textFields.includes(column.type) || column.formulaType === 'string' || column.formulaType === 'boolean';
-
-
+export const isTextColumn = (column: any): boolean => textFields.includes(column.type) || column.formulaType === 'string' || column.formulaType === 'boolean';

package/src/format/format.ts

@@ -1,32 +1,28 @@
 import { format as d3Format } from 'd3';
 import dayjs from 'dayjs';
 import { COLUMN, FORMULA_TYPES } from '../constants';
-import { _get } from '../general/object/get';
 import { DATEGROUP_FORMATTING_UNSUPPORT, appliesFormatting, hasfileSizeProperty, isTextColumn } from './definition';
 import advancedFormat from 'dayjs/plugin/advancedFormat';
+import { isEmpty, _get } from '../general';
 
 dayjs.extend(advancedFormat); // Add support to advanced formats https://day.js.org/docs/en/plugin/advanced-format
 
-export const isEmptyValue = (variable: any): boolean => {
-    return variable === undefined || variable === null || variable === '';
-}
-
 /**
  * Apply to the given date format to a date value
  * @param bytes type number
  */
 function isValidDateString(dateString = '') {
     return /^\d{2}\/\d{2}\/\d{4}/.test(dateString) // MM/DD/YYY OR DD/MM/YYYY
-        || /^\d{4}\-\d{2}\-\d{2}/.test(dateString);  // YYYY-MM-DD
+        || /^\d{4}-\d{2}-\d{2}/.test(dateString);  // YYYY-MM-DD
 }
 
 export function formatDate(dateString, format) {
-    if (isEmptyValue(dateString) || !isNaN(dateString) || format === 'Default') return dateString;
+    if (isEmpty(dateString) || !isNaN(dateString) || format === 'Default') return dateString;
     if (!isValidDateString(dateString)) return dateString;
     return dayjs(dateString.split('.')[0]).format(format.replace('HH24:', 'HH:').replace('MI:SS', 'mm:ss').replace('MM:SS', 'mm:ss'));
 }
 
-function formatAbbreviated(num, decimals) {
+export function formatAbbreviated(num, decimals) {
     if (num == 0) return 0;
 
     const absValue = Math.abs(num);
@@ -35,17 +31,17 @@ function formatAbbreviated(num, decimals) {
     if (exp < 0 && exp >= -3)
         return decimals ? num.toFixed(decimals) : num;
 
-    return d3Format((num > -100 && num < 100) ? '.s' : '.3s')(num);
+    return d3Format(num > -100 && num < 100 ? '' : '.3s')(num);
 }
 
-function formatNumber(num, outputFormat, config?) {
+function formatNumber(num, outputFormat, _config?) {
     try {
         num = +(num || 0);
     } catch (e) {
         num = 0;
     }
     if (isNaN(num)) num = 0;
-    const num_decimals = !isEmptyValue(outputFormat.decimals) && outputFormat.format !== 'Abbreviated' ? outputFormat.decimals : 0;
+    const num_decimals = !isEmpty(outputFormat.decimals) && outputFormat.format !== 'Abbreviated' ? outputFormat.decimals : 0;
 
     switch (outputFormat.format) {
         case 'Abbreviated':
@@ -57,12 +53,12 @@ function formatNumber(num, outputFormat, config?) {
 
             const currency = `${num < 0 ? '-' : ''} ${_get(outputFormat, 'currency.label', '$')}`;
             const absNum = Math.abs(num);
-            return currency + d3Format(`,.${num_decimals}f`)(absNum).replace(/\.(%*)$/, '$1')
+            return currency + d3Format(`,.${num_decimals}f`)(absNum).replace(/\.(%*)$/, '$1');
         }
         case 'Percentage':
-            return `${d3Format(`,.${num_decimals}f`)(num).replace(/\.(%*)$/, '$1')}%`
+            return `${d3Format(`,.${num_decimals}f`)(num).replace(/\.(%*)$/, '$1')}%`;
         case 'Scientific':
-            return Number(num).toExponential(num_decimals).replace('.00', '').replace('e+0', '')
+            return Number(num).toExponential(num_decimals).replace('.00', '').replace('e+0', '');
         default:
             return `${num}`;
     }
@@ -72,7 +68,7 @@ function formatNumber(num, outputFormat, config?) {
  * Set convert Bytes into MB
  * @param bytes type number
  */
-export function formatFileSize(bytes: number) {
+export function formatFileSize(bytes: number): string {
     const fixDecimals = (num) => {
         return parseFloat(`${(num * 100) / 100}`).toFixed(2);
     };
@@ -85,14 +81,15 @@ export function formatFileSize(bytes: number) {
 }
 
 export const formatValue = (value: any, outputFormat: any = 'None', config?): any => {
-    if (isEmptyValue(value) || typeof value === 'object' && isEmptyValue(value[0])) return value;
+    if (isEmpty(value) || typeof value === 'object' && isEmpty(value[0])) return value;
     switch (outputFormat.type) {
         case 'DATE':
         case 'DATETIME':
             return formatDate(value, outputFormat.format);
-        case 'NUMERIC':
+        case 'NUMERIC': {
             const parse = parseFloat(value);
             return isNaN(parse) ? value : formatNumber(parse, outputFormat, config);
+        }
         case 'IMAGEUPLOAD':
         case 'FILEUPLOAD':
             return formatFileSize(parseFloat(value));
@@ -135,7 +132,7 @@ export const defineFormat = (column: any = {}, isSimpleTable = false, isCategory
         format: 'Abbreviated'
     };
     
-    const dateGroupLabel = _get(column, 'dateGroup.label') || column.dateGroup
+    const dateGroupLabel = _get(column, 'dateGroup.label') || column.dateGroup;
     switch (columnType) {
         case COLUMN.YES_NO:
         case COLUMN.PHONE:
@@ -147,7 +144,7 @@ export const defineFormat = (column: any = {}, isSimpleTable = false, isCategory
         case COLUMN.EMAIL_FORM:
         case COLUMN.IMAGE:
         case COLUMN.TEXT_LABEL:
-            if (isTable) return 'None'
+            if (isTable) return 'None';
             if (outputFormat) {
                 if (isNumericDefaultOutput) return defaultAbbreviated;
                 return column.outputFormat;
@@ -156,6 +153,7 @@ export const defineFormat = (column: any = {}, isSimpleTable = false, isCategory
                 if (isNumericDefaultSelected) return defaultAbbreviated;
                 return column.selectedFormat;
             }
+        break;
         case COLUMN.DATE:
             if ((!isTable && column.isSummary) || column.isXY) {
                 if (isCategoryDimension && outputFormat !== 'Default') return column.outputFormat;
@@ -165,7 +163,7 @@ export const defineFormat = (column: any = {}, isSimpleTable = false, isCategory
             if ((isCategoryDimension || isTable) && DATEGROUP_FORMATTING_UNSUPPORT.includes(dateGroupLabel)) return 'None';
             if ((isCategoryDimension || isTable) && selectType == 'NUMERIC' && dateGroupLabel && outputType === 'DATE') return column.outputFormat;
             if ((isCategoryDimension || isTable) && selectType == 'NUMERIC' && dateGroupLabel && outputType === 'NUMERIC') return _get(column, 'defaultFormat');
-            if (selectedFormat) {
+            if (selectedFormat && selectedFormat != 'Default') {
                 if (isNumericDefaultSelected) return defaultAbbreviated;
                 return column.selectedFormat;
             }
@@ -182,7 +180,6 @@ export const defineFormat = (column: any = {}, isSimpleTable = false, isCategory
                 type: columnType,
                 format: 'MM/DD/YYYY'
             };
-
         case COLUMN.NUMERIC:
         case COLUMN.RATING:
         case COLUMN.SLIDEBAR: {
@@ -272,7 +269,7 @@ export const defineFormat = (column: any = {}, isSimpleTable = false, isCategory
                 ((column.selectedFormat &&
                     column.selectedFormat.format !== "Default") ||
                     (!isSimpleTable && column.isSummary)) &&
-                _get(column, "outputFormat.format")
+                    _get(column, "outputFormat.format")
             )
                 return column.outputFormat;
             break;

package/src/general/array/delete.ts

@@ -1,9 +1,13 @@
+import { isEmpty } from "../mix";
+
 /**
  * Inmutable Array Item deletion
- * @param {Array} array List to loo for item to delte
- * @param {Number} index position of item to delete
- * @return new Array
+ * @param {Array} array a collection of items to delete
+ * @param {Number} index the position of the item to delete
+ * @returns a new Array or the given parameter when is empty or not an array
  */
-export function ArrayDelete (array: Array<any>, index: number) {
-    return array.slice(0, index).concat(array.slice(index + 1));
-};
+export function ArrayDelete<T = Array<any>> (arr: T[], index: number): T[] {
+    if (isEmpty(index) || isEmpty(arr) || !Array.isArray(arr)) return arr;
+
+    return arr.slice(0, index).concat(arr.slice(index + 1));
+}

package/src/general/array/filterNestedTree.ts

@@ -8,7 +8,7 @@ import { cloneDeep } from "../object/cloneDeep";
  * @param condition function callback that determines if the filter is applied on the last child node of the nested tree
  * @returns array filtered
  */
- export function filterNestedTree(arr: any[] = [], childArrKey: string, condition: any) {
+ export function filterNestedTree(arr: any[], childArrKey: string, condition: any): any[] {
    if (isEmpty(arr)) return [];
   
     return cloneDeep(arr).filter(obj => {

package/src/general/array/flattenDeep.ts

@@ -3,6 +3,7 @@
  * @param arr Array to flat deeply
  * @returns flatten array
  */
- export function flattenDeep(arr) {
-    return arr.reduce((acc, val) => Array.isArray(val) ? acc.concat(flattenDeep(val)) : acc.concat(val), []);
+ export function flattenDeep(arr = []): any[] {
+    if (Array.isArray(arr)) return arr.reduce((acc, val) => Array.isArray(val) ? acc.concat(flattenDeep(val)) : acc.concat(val), []);
+    return undefined;
 }

package/src/general/array/getFirstIndexFromArray.ts

@@ -4,13 +4,15 @@
  * @param callback function callback
  * @returns the first index of the array. -1 when the condition is not satisfied
  */
- export function getFirstIndexFromArray(array = [], callback): number {
+ export function getFirstIndexFromArray(array: any[] = [], callback?: (item: any) => boolean): number {
     let firstArrayIndex = -1;
-    for(let i = 0; i < array.length; i++) {
-        const condition = callback(array[i]);
-        if (condition) {
-            firstArrayIndex = i;
-            break;
+    if (Array.isArray(array) && callback instanceof Function) {
+        for(let i = 0; i < array.length; i++) {
+            const condition = callback(array[i]);
+            if (condition) {
+                firstArrayIndex = i;
+                break;
+            }
         }
     }
     return firstArrayIndex;

package/src/general/array/getLastIndexFromArray.ts

@@ -4,12 +4,14 @@
  * @param callback function callback
  * @returns the last index of the array. -1 when the condition is not satisfied
  */
-export function getLastIndexFromArray(array = [], callback): number {
+export function getLastIndexFromArray(array: any[] = [], callback?: (item: any) => boolean): number {
     let lastArrayIndex = -1;
-    for(let i = 0; i < array.length; i++) {
-        const condition = callback(array[i]);
-        if (condition) {
-            lastArrayIndex = i;
+    if (Array.isArray(array) && callback instanceof Function) {
+        for(let i = 0; i < array.length; i++) {
+            const condition = callback(array[i]);
+            if (condition) {
+                lastArrayIndex = i;
+            }
         }
     }
     return lastArrayIndex;

package/src/general/function/debounce.ts

@@ -4,7 +4,7 @@
  * @param {Number} time default 500ms
  * @returns {Function} debounced functions 
  */
-export function debounce(fn: Function, time = 500) {
+export function debounce(fn, time = 500) {
     let timeout;
 
     return function (...args: any) {
@@ -12,5 +12,5 @@ export function debounce(fn: Function, time = 500) {
 
         clearTimeout(timeout);
         timeout = setTimeout(functionCall, time);
-    }
+    };
 }

package/src/general/function/throttled.ts

@@ -4,14 +4,14 @@
  * @param {Number} time default 500ms
  * @returns {Function} throttled function
  */
-export function throttled(fn: Function, delay = 500) {
+export function throttled(fn, delay = 500) {
     let lastCall = 0;
     return (...args: any) => {
-        const now = (new Date()).getTime();
+        const now = new Date().getTime();
         if (now - lastCall < delay) {
             return;
         }
         lastCall = now;
         return fn(...args);
-    }
+    };
 }