@qrvey/utils 1.3.0-9 → 1.3.2

package/src/filters/helpers/ui/getUIValues.ts

@@ -12,65 +12,74 @@ import { IFSValueRanking } from "../../interfaces/common/IFSValueRanking";
 import { flattenDeep } from "../../../general/array/flattenDeep";
 import { RELATIVE_CURSOR_INFO } from "../../../dates/relative/constants/RELATIVE_CURSOR_INFO";
 import { IFUUIValueSettings } from "../../interfaces/ui/IFUUIValueSettings";
-import { getI18nDateGroupLabel, IDateColumnPropertyType } from "../../..";
+import { getI18nDateGroupLabel } from "../../../globalization/helpers/getI18nDateGroupLabel";
+import { IDateColumnPropertyType } from "../../../columns/interfaces/IDateColumnPropertyType";
 
 /**
- * Gets the UI Values from the filter object
- * @param filter The filter object
- * @param settings configuration for this function
+ * Gets the UI Values generated depending on the validator
+ * @param filter the filter structure
+ * @param settings a settings for this function
  * @returns an array of values
  */
 export function getUIValues(filter: IFSFilter, settings?: IFUUIValueSettings): IFUValue[] {
     settings = getUiValuesSettings(settings);
+
+    const values = filter.values || [];
     switch (filter.validator) {
         case FILTER_VALIDATOR.AFTER:
         case FILTER_VALIDATOR.GREATER_THAN:
         case FILTER_VALIDATOR.AFTER_ON:
         case FILTER_VALIDATOR.GREATER_THAN_EQUAL:
-            return (filter.values as IFSValueRange[]).map(value => ({
+            return (values as IFSValueRange[]).map(value => ({
                 value: getValueLabel(value.min, filter, settings),
+                displayed: value.displayed != null ? value.displayed : true,
                 enabled: settings.addEnableds ? value.enabled != null ? value.enabled : true : undefined,
             }));
         case FILTER_VALIDATOR.BEFORE_ON:
         case FILTER_VALIDATOR.LESS_THAN_EQUAL:
         case FILTER_VALIDATOR.BEFORE:
         case FILTER_VALIDATOR.LESS_THAN:
-            return (filter.values as IFSValueRange[]).map(value => ({
+            return (values as IFSValueRange[]).map(value => ({
                 value: getValueLabel(value.max, filter, settings),
+                displayed: value.displayed != null ? value.displayed : true,
                 enabled: settings.addEnableds ? value.enabled != null ? value.enabled : true : undefined,
             }));
         case FILTER_VALIDATOR.BETWEEN_INCLUSIVE:
         case FILTER_VALIDATOR.BETWEEN_EXCLUSIVE:
-            return (filter.values as IFSValueRange[]).map(value => ({
+            return (values as IFSValueRange[]).map(value => ({
                 value: `${getValueLabel(value.min, filter, settings)} ${getRangeSeparator(settings)} ${getValueLabel(value.max, filter, settings)}`,
+                displayed: value.displayed != null ? value.displayed : true,
                 enabled: settings.addEnableds ? value.enabled != null ? value.enabled : true : undefined,
             }));
         case FILTER_VALIDATOR.IS_NULL:
         case FILTER_VALIDATOR.IS_NOT_NULL:
             return [{
                 value: settings?.translate ? settings.translate('filter.validators.' + filter.validator.toLowerCase() + '_label') : FILTER_VALIDATOR_INFO[filter.validator].label,
-                enabled: settings.addEnableds ? (filter.values as IFSValue[])[0]?.enabled : undefined,
+                displayed: (values as IFSValue[])[0]?.displayed,
+                enabled: settings.addEnableds ? (values as IFSValue[])[0]?.enabled : undefined,
             }];
         case FILTER_VALIDATOR.IN:
-            return (filter.values as IFSValueRelativeDate[]).map(value => {
+            return (values as IFSValueRelativeDate[]).map(value => {
                 const cursor = settings?.translate ? settings.translate(RELATIVE_CURSOR_INFO[value.cursor].i18nLabelPath) : RELATIVE_CURSOR_INFO[value.cursor].i18nLabelPath;
                 const from = settings?.translate ? settings.translate('filter.relative_container.from_label') : 'from';
                 const anchor = settings?.translate ?  settings?.translate('filter.relative_container.current_date') : 'current date';
                 return {
                     value: 
                     `${cursor} ${value.cursor !== RELATIVE_CURSOR.THIS && value.number > 1 ? value.number : ''} ${getValueUiUnitRelativeDate(value, settings)} ${value.cursor !== RELATIVE_CURSOR.THIS ? `${from} ${value.anchor || anchor}`: ''}`,
-                    enabled: settings.addEnableds ? filter.enabled : undefined,
+                    displayed: value.displayed != null ? value.displayed : true,
+                    enabled: settings.addEnableds ? value.enabled : undefined,
                 };
             });
         default:
             if (filter.column.type === COLUMN.RANKING && isEmpty(filter.column.aggregate)) {
-                return getRankingUIValues(filter.values as IFSValueRanking[][], settings.addEnableds, settings.rankingGroupIndex);
+                return getRankingUIValues(values as IFSValueRanking[][], settings.addEnableds, settings.rankingGroupIndex);
             }
-            return ((filter.values || []) as IFSValue[]).map(val => ({
-                imageUrl: val.imageUrl,
-                value: getValueLabel(val.value, filter, settings),
-                enabled: settings.addEnableds ? val.enabled != null ? val.enabled : true : undefined,
-                valueid: val.valueid,
+            return (values as IFSValue[]).map(value => ({
+                imageUrl: value.imageUrl,
+                value: getValueLabel(value.value, filter, settings),
+                displayed: value.displayed != null ? value.displayed : true,
+                enabled: settings.addEnableds ? value.enabled != null ? value.enabled : true : undefined,
+                valueid: value.valueid,
             }));
     }
 }
@@ -100,6 +109,7 @@ function getRankingUIValues(values: IFSValueRanking[][], addEnableds = false, ra
         rankingIndex: rankingGroupIndex,
         value: `${rankingValue.value.value} - ${rankingValue.position}`,
         valueid: rankingValue.value.valueid,
+        displayed: rankingValue.displayed != null ? rankingValue.displayed : true,
         enabled: addEnableds ? rankingValue.enabled : undefined
     }));
 }

package/src/filters/helpers/ui/index.ts

@@ -8,4 +8,5 @@ export * from './getUIFlatFiltersByParams';
 export * from './getUIFlatFiltersByScopes';
 export * from './getUIValues';
 export * from './getUpdatedUIFilters';
+export * from './resolveUIFlatFilterByParams';
 export * from './transformFilterValues';

package/src/filters/helpers/ui/{resolveUIFlatFiltersByParams.ts → resolveUIFlatFilterByParams.ts}

@@ -1,5 +1,6 @@
-import { isEmpty } from "../../../general";
-import { IFUFlattenedFilter, IFUParamsToGetFilter } from "../../interfaces";
+import { isEmpty } from "../../../general/mix/isEmpty";
+import { IFUFlattenedFilter } from "../../interfaces/ui/IFUFlattenedFilter";
+import { IFUParamsToGetFilter } from "../../interfaces/ui/IFUParamsToGetFilter";
 
 /**
  * Resolves conditions between UI flattened filter and given parameters

package/src/filters/helpers/ui/transformFilterValues.ts

@@ -1,29 +1,30 @@
 import { isEmpty } from "../../../general/mix/isEmpty";
 import { transformValue } from "../../../qrvey/helpers/transformValue";
-import { IFSFilter } from "../../interfaces/common/IFSFilter";
 import { IFSValue } from "../../interfaces/common/IFSValue";
 import { IFSValueRange } from "../../interfaces/common/IFSValueRange";
 import { IFValue } from "../../interfaces/IFValue";
+import { IFUFilter } from "../../interfaces/ui/IFUFilter";
 import { IFUTransformFilterValuesSettings } from "../../interfaces/ui/IFUTransformFilterValuesSettings";
 import { isRangeValidator } from "../common/isRangeValidator";
 import { isRegularValidator } from "../common/isRegularValidator";
 
-export function transformFilterValues(filter: IFSFilter, settings: IFUTransformFilterValuesSettings): IFValue[] {
+export function transformFilterValues(filter: IFUFilter, settings: IFUTransformFilterValuesSettings): IFValue[] {
     const transformValueSettings = { ...settings, column: filter.column, property: filter.property };
     if (isEmpty(filter)) return [];
 
+    const values = filter.values || [];
     if (isRegularValidator(filter.validator)) {
-        return (filter.values as IFSValue[]).map((value: IFSValue) => ({
+        return (values as IFSValue[]).map((value: IFSValue) => ({
             ...value,
             value: transformValue(value.value, transformValueSettings),
          }));
     } else if (isRangeValidator(filter.validator)) {
-        return (filter.values as IFSValueRange[]).map((value: IFSValueRange) => ({
+        return (values as IFSValueRange[]).map((value: IFSValueRange) => ({
             ...value,
             min: transformValue(value.min, transformValueSettings),
             max: transformValue(value.max, transformValueSettings)
          }));
     } else {
-        return filter.values;
+        return values;
     }
 }

package/src/filters/index.ts

@@ -3,3 +3,4 @@ export * from './classes/index';
 export * from './constants/index';
 export * from './helpers/index';
 export * from './interfaces/index';
+export * from './services/index';

package/src/filters/interfaces/OLD_IFilterDetail.ts

@@ -12,13 +12,14 @@ import { IFUChartSettings } from "./ui/IFUChartSettings";
 import { IFUValue } from "./ui/IFUValue";
 
 export interface OLD_IFilterDetail {
-    column?: IColumn & { dataset: IDataset };
+    column?: Omit<IColumn, 'label'> & { dataset: IDataset } & { text: string };
     dateSection?: IFDateSection;
     enabled?: boolean;
     lookupDisplayIndex?: number;
     nullValues?: boolean;
     operator?: IFOperator;
     property?: IFProperty;
+    selectAll?: boolean;
     validator?: IFValidator;
     values?: IFValue[];
   

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

@@ -0,0 +1,6 @@
+import { IFSValue } from "../common/IFSValue";
+
+export interface IFBData {
+    data: IFSValue[];
+    total?: number;
+}

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

@@ -8,6 +8,7 @@ import { IFProperty } from "../IFProperty";
 export interface IFBExpression {
     enabled?: boolean; // True: The filter expression is applied; False: The filter expression is not applied.
     groupValue?: IFProperty; // Date grouping for Date column filters
+    qrveyid?: string; // The Qrvey ID used in the expression
     questionid?: string; // The Question/Column ID
     questionType?: string; // The type of the Question/Column. Require if it is FORMULA OR BUCKET, otherwise is optional.
     property?: IFProperty; // Properties for Complex Data types

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

@@ -16,6 +16,8 @@
 export * from './IFBackendExpressionValue';
 export * from './IFBackendValidator';
 
+export * from './IFBData';
+
 export * from './IFBExpression';
 export * from './IFBExpressionAggregate';
 export * from './IFBExpressionRelativeDate';

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

@@ -1,5 +1,6 @@
 import { IFBLogic } from "../backend/IFBLogic";
 import { IFBUserFilters } from "../backend/IFBUserFilters";
+import { IFilterConfig } from "../common/IFilterConfig";
 import { IFSColumn } from "../common/IFSColumn";
 import { IFSData } from "../common/IFSData";
 import { IFProperty } from "../IFProperty";
@@ -8,14 +9,13 @@ import { IFSection } from "../IFSection";
 import { IFValidator } from "../IFValidator";
 import { OLD_IFilterData } from "../OLD_IFilterData";
 import { IFUData } from "../ui/IFUData";
-import { IFilterBuilderGeneralConfig } from "./IFilterBuilderGeneralConfig";
 import { IFilterBuilderSettings } from "./IFilterBuilderSettings";
 
 /**
  * Structure for the configuration of the Filter Builder
  */
 export interface IFilterBuilderConfig {
-    datasets?: string[]; // Qrvey IDs for displaying their columns in the colum selector. No qrveyids, the column list is not render
+    datasets?: string[]; // Qrvey IDs for displaying their columns in the colum selector. If there is not qrveyids, the column list will not render
     filterData?: IFSData; // The Filter Data structure
     filterLabel?: string; // A label for the filter. If filterLabel is provided the old filterLabel is replaced by the new one
     onApplied?: (filter: IFSData | IFUData | OLD_IFilterData | IFBLogic[]) => void;
@@ -31,5 +31,5 @@ export interface IFilterBuilderConfig {
     tokenBoxConfig?: any; // Configuration for the TokenBox.
     userFilters?: IFBUserFilters; // Backend Filter structure assinged by users
     validator?: IFValidator; // Filter Validator type
-    widgetConfig: IFilterBuilderGeneralConfig; // General config for the Filter Builder Widget
+    widgetConfig: IFilterConfig; // General config for the Filter Builder Widget
 }

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

@@ -14,6 +14,5 @@
  */
 
 export * from './IFilterBuilderConfig';
-export * from './IFilterBuilderGeneralConfig';
 export * from './IFilterBuilderSettings';
 export * from './IFilterBuilderSettingsScopes';

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

@@ -10,6 +10,7 @@ export interface IFSAvailableScope {
     qrveyid?: string; // Qrvey ID
     tabid?: string; // Tab ID
     pageid?: string; // Page ID
+    panelid?: string; // The ID for Panel Filters
     defaultid?: string; // Default ID
     predefinedScopes?: IFSScopeID[]; // Predefined Scopes 
 }

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

@@ -1,3 +1,3 @@
 import { IColumn } from "../../../columns/interfaces/IColumn";
 
-export type IFSColumn = IColumn;
+export type IFSColumn = Omit<IColumn, 'expressionCategory' | 'expressionNegative' | 'expressionPositive' | 'expressionWords' | 'label' | 'lookupValue' | 'slidebarValue'>;

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

@@ -21,6 +21,7 @@ export interface IFSFilter {
   nullValues: boolean; // True: Add values including Null Values; False: Not including Null values.
   operator: IFOperator; // Related operator for this filter. i.e: F1 AND...
   property?: IFProperty; // Related property for some columns (Date group|Complex Data types).
+  selectAll?: boolean; // Flag to determine the complete selection of the data
   validator: IFValidator; // Related Validator for this filter.
-  values: IFValue[]; // Values structure. Depending on the selected validator it changes.
+  values?: IFValue[]; // Values structure. Depending on the selected validator it changes. Activated Select All could recieve an empty or undefined values
 }

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

@@ -1,5 +1,6 @@
 import { IFScope } from "../IFScope";
 import { IFSection } from "../IFSection";
+import { IFUChartSettings } from "../ui/IFUChartSettings";
 import { IFSFilterExtrasInfo } from "./IFSFilterExtrasInfo";
 
 /**
@@ -12,6 +13,7 @@ export interface IFSFilterExtras {
     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
+    chart?: IFUChartSettings; // Chart Settings
 
     [x: string]: any; // Specific case for those filters that need to store something else
 }

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

@@ -0,0 +1,3 @@
+import { IFFiltersGetData } from "../functions/IFFiltersGetData";
+
+export type IFSGetDataValues = IFFiltersGetData;

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

@@ -2,6 +2,7 @@ import { IFDateSection } from "../IFDateSection";
 import { IFProperty } from "../IFProperty";
 import { IFScope } from "../IFScope";
 import { IFValidator } from "../IFValidator";
+import { IFUChartSettings } from "../ui/IFUChartSettings";
 import { IFSColumn } from "./IFSColumn";
 import { IFSParamsToGetFilterEnableds } from "./IFSParamsToGetFilterEnableds";
 
@@ -12,6 +13,7 @@ export interface IFSParamsToGetFilter {
     column?: Partial<IFSColumn>;
     dateSection?: IFDateSection;
     enableds?: IFSParamsToGetFilterEnableds;
+    chart?: IFUChartSettings;
     linkid?: string;
     panelid?: string;
     property?: IFProperty;

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

@@ -2,6 +2,7 @@
  * Structure for the value of the filter. Common structure.
  */
 export interface IFSValue {
+    displayed?: boolean; // True: The value is display; False: the value is hidden
     enabled?: boolean; // True: the value is enabled; False: the value is disabled
     imageUrl?: string; // URL for a image. This is common for images column type.
     value?: string; // The value to filter

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

@@ -2,6 +2,7 @@
  * Structure for filters values with ranges.
  */
 export interface IFSValueRange {
+    displayed?: boolean; // True: The value is display; False: the value is hidden
     enabled?: boolean; // True: the value is enabled; False: the value is disabled
     min?: string; // The min value of the range
     max?: string; // The max value of the range

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

@@ -4,6 +4,7 @@ import { IFSValue } from "./IFSValue";
  * Structure for filters values with ranks. For Ranking column type.
  */
 export interface IFSValueRanking {
+    displayed?: boolean; // True: The value is display; False: the value is hidden
     enabled?: boolean; // True: the value is enabled; False: the value is disabled
     position: number; // The position in the rank
     value: IFSValue; // The value to filter

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

@@ -1,3 +1,3 @@
 import { RelativeStatement } from "../../../dates/relative/interfaces/RelativeStatement";
 
-export type IFSValueRelativeDate = { enabled?: boolean; } & RelativeStatement;
+export type IFSValueRelativeDate = { displayed?: boolean; enabled?: boolean; } & RelativeStatement;

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

@@ -0,0 +1,3 @@
+import { IWidgetConfig } from "../../../interfaces/general/IWidgetConfig";
+
+export type IFilterConfig = IWidgetConfig;

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

@@ -13,6 +13,7 @@
  * IFP-: Structures to Filter Panel
  */
  
+export * from './IFilterConfig';
 export * from './IFSAvailableScope';
 export * from './IFSColumn';
 export * from './IFSData';
@@ -21,10 +22,9 @@ export * from './IFSDataStore';
 export * from './IFSFilter';
 export * from './IFSFilterExtras';
 export * from './IFSFilterExtrasInfo';
-export * from './IFSMergeFiltersSettings';
+export * from './IFSGetDataValues';
 export * from './IFSParamsToGetFilter';
 export * from './IFSParamsToGetFilterEnableds';
-export * from './IFSParamsToGetFilterSettings';
 export * from './IFSScope';
 export * from './IFSScopeID';
 export * from './IFSValue';

package/src/filters/interfaces/functions/IFFGetLogicByDatasets.ts

@@ -0,0 +1,6 @@
+export interface IFFGetLogicByDatasets {
+    letPassUndefinedProperties?: {
+        qrveyid?: boolean;
+    }
+    filterEmptyArrays?: boolean;
+}

package/src/filters/interfaces/functions/IFFGetLogicByDatasetsColumns.ts

@@ -0,0 +1,7 @@
+export interface IFFGetLogicByDatasetsColumns {
+    letPassUndefinedProperties?: {
+        qrveyid?: boolean;
+        questionid?: boolean;
+    }
+    filterEmptyArrays?: boolean;
+}

package/src/filters/interfaces/functions/IFFiltersGetData.ts

@@ -0,0 +1,18 @@
+import { IDataset } from "../../../qrvey/interfaces/IDataset";
+import { IFBUserFilters } from "../backend/IFBUserFilters";
+import { IFilterConfig } from "../common/IFilterConfig";
+import { IFSData } from "../common/IFSData";
+import { IFUChartSettings } from "../ui/IFUChartSettings";
+import { IFUFlattenedFilter } from "../ui/IFUFlattenedFilter";
+
+export interface IFFiltersGetData {
+    chartRequest?: IFUChartSettings;
+    datasets: IDataset[];
+    filterData?: IFSData;
+    filter: IFUFlattenedFilter;
+    pageid?: string;
+    userFilters?: IFBUserFilters;
+    tabid?: string;
+    valueText?: string;
+    widgetConfig: IFilterConfig;
+}

package/src/filters/interfaces/functions/IFFiltersGetValuesFromDataset.ts

@@ -0,0 +1,11 @@
+import { IColumn } from "../../../columns/interfaces/IColumn";
+import { IDataset } from "../../../qrvey/interfaces/IDataset";
+import { IFProperty } from "../IFProperty";
+
+export interface IFFiltersGetValuesFromDataset {
+    column: IColumn;
+    property?: IFProperty;
+    lookupDisplay?: number;
+    dataset: IDataset;
+    value?: string;
+}

package/src/filters/interfaces/functions/IFFiltersGetValuesFromModel.ts

@@ -0,0 +1,11 @@
+import { IColumn } from "../../../columns/interfaces/IColumn";
+import { IModel } from "../../../qrvey/interfaces/IModel";
+import { IFProperty } from "../IFProperty";
+
+export interface IFFiltersGetValuesFromModel {
+    column: IColumn;
+    property?: IFProperty;
+    lookupDisplay?: number;
+    model: IModel;
+    value?: string;
+}

package/src/filters/interfaces/functions/IFFiltersMergeFilters.ts

@@ -0,0 +1,9 @@
+import { IFFiltersMergeValues } from "./IFFiltersMergeValues";
+
+/**
+ * Structure for MergeFilters property settings
+ */
+export interface IFFiltersMergeFilters extends IFFiltersMergeValues{
+    overwriteFilterProps?: boolean;
+    setGroupedColumnOperator?: boolean;
+}

package/src/filters/interfaces/functions/IFFiltersMergeValues.ts

@@ -0,0 +1,3 @@
+export interface IFFiltersMergeValues {
+    overwriteValues?: boolean;
+}

package/src/filters/interfaces/{common/IFSParamsToGetFilterSettings.ts → functions/IFFiltersParamsToGetFilter.ts}

@@ -1,7 +1,7 @@
 /**
  * Structure for filter properties
  */
- export interface IFSParamsToGetFilterSettings {
+ export interface IFFiltersParamsToGetFilter {
     letPassUndefinedProperties?: {
         scope?: boolean;
         dataset?: boolean;

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

@@ -0,0 +1,8 @@
+export * from './IFFGetLogicByDatasets';
+export * from './IFFGetLogicByDatasetsColumns';
+export * from './IFFiltersGetData';
+export * from './IFFiltersGetValuesFromDataset';
+export * from './IFFiltersGetValuesFromModel';
+export * from './IFFiltersMergeFilters';
+export * from './IFFiltersMergeValues';
+export * from './IFFiltersParamsToGetFilter';

package/src/filters/interfaces/index.ts

@@ -16,6 +16,7 @@
 export * from './backend/index';
 export * from './builder/index';
 export * from './common/index';
+export * from './functions/index';
 export * from './panel/index';
 export * from './ui/index';
 

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

@@ -1,9 +1,9 @@
-import { IFSColumn } from "../common/IFSColumn";
+import { IColumn } from "../../../columns/interfaces/IColumn";
 
 /**
  * Structure for visualizing a column.
  */
-export interface IFUColumn extends IFSColumn {
+export interface IFUColumn extends IColumn {
     label: string; // The label/name of the column
     uniqueid?: string; // The unique ID for this column.
 }

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

@@ -2,6 +2,7 @@
  * Structure for Displaying Value
  */
 export interface IFUValue {
+    displayed?: boolean; // True: The value is display; False: the value is hidden
     enabled?: boolean; // Optional flag to enabled the value
     imageUrl?: string; // URL from Image type
     value?: string; // A string value

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

@@ -14,8 +14,8 @@
 export * from './IFUChartSettings';
 export * from './IFUColumn';
 export * from './IFUData';
-export * from './IFUDataStore';
 export * from './IFUDataset';
+export * from './IFUDataStore';
 export * from './IFUFilter';
 export * from './IFUFilterExtras';
 export * from './IFUFlattenedFilter';