@qrvey/utils 1.2.9-9 → 1.2.10-2

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

@@ -12,7 +12,8 @@ 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";
 
 /**
  * 
@@ -24,12 +25,13 @@ import { getI18nDateGroupLabel, IDateColumnPropertyType } from "../../..";
 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),
                 enabled: settings.addEnableds ? value.enabled != null ? value.enabled : true : undefined,
             }));
@@ -37,33 +39,38 @@ export function getUIValues(filter: IFSFilter, settings?: IFUUIValueSettings): I
         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),
                 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)} - ${getValueLabel(value.max, filter, settings)}`,
                 enabled: settings.addEnableds ? value.enabled != null ? value.enabled : true : undefined,
             }));
         case FILTER_VALIDATOR.IS_NULL:
         case FILTER_VALIDATOR.IS_NOT_NULL:
             return [{
-                value: FILTER_VALIDATOR_INFO[filter.validator].label,
-                enabled: settings.addEnableds ? (filter.values as IFSValue[])[0]?.enabled : undefined,
+                value: settings?.translate ? settings.translate('filter.validators.' + filter.validator.toLowerCase() + '_label') : FILTER_VALIDATOR_INFO[filter.validator].label,
+                enabled: settings.addEnableds ? (values as IFSValue[])[0]?.enabled : undefined,
             }];
         case FILTER_VALIDATOR.IN:
-            return (filter.values as IFSValueRelativeDate[]).map(value => ({
-                value: 
-                `${RELATIVE_CURSOR_INFO[value.cursor].label} ${value.cursor !== RELATIVE_CURSOR.THIS && value.number > 1 ? value.number : ''} ${getValueUiUnitRelativeDate(value)} ${value.cursor !== RELATIVE_CURSOR.THIS ? `from ${value.anchor || 'current date'}`: ''}`,
-                enabled: settings.addEnableds ? filter.enabled : undefined,
-            }));
+            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,
+                };
+            });
         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 => ({
+            return (values as IFSValue[]).map(val => ({
                 imageUrl: val.imageUrl,
                 value: getValueLabel(val.value, filter, settings),
                 enabled: settings.addEnableds ? val.enabled != null ? val.enabled : true : undefined,
@@ -84,8 +91,9 @@ function getUiValuesSettings(settings: IFUUIValueSettings): IFUUIValueSettings {
     };
 }
 
-function getValueUiUnitRelativeDate(relative: IFSValueRelativeDate) {
-    return relative.cursor !== RELATIVE_CURSOR.THIS && relative.number > 1 ? `${relative.unit}s`: relative.unit;
+function getValueUiUnitRelativeDate(relative: IFSValueRelativeDate, settings: IFUUIValueSettings) {
+    const unit = settings.translate ? `${settings.translate(`common.units.${relative.unit}`)}` : relative.unit;
+    return relative.cursor !== RELATIVE_CURSOR.THIS && relative.number > 1 ? `${unit}s`: unit;
 }
 
 function getRankingUIValues(values: IFSValueRanking[][], addEnableds = false, rankingGroupIndex?: number) {

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

@@ -0,0 +1,36 @@
+import { IColumn } from "../../../columns/interfaces/IColumn";
+import { isEmpty } from "../../../general/mix/isEmpty";
+import { IDataset } from "../../../qrvey/interfaces/IDataset";
+import { IFUData } from "../../interfaces/ui/IFUData";
+
+/**
+ * Gets a new UI Filter structure with a datasets/columns info updates
+ * @param data The UI Filter structure
+ * @param datasets An array of datasets/column info used for updating the data
+ * @returns A new UI FIlter structure
+ */
+export function getUpdatedUIFilters(data: IFUData, datasets: IDataset[] = []): IFUData {
+    if (isEmpty(data) || isEmpty(datasets)) return data;
+
+    const updatedScopes = data.scopes.map(scopes => {
+        scopes.datasets = scopes.datasets.map(dataset => {
+            const datasetInfo: IDataset = datasets.find(dInfo => dInfo.qrveyid === dataset.qrveyid && dInfo.linkid === dataset.linkid);
+            if (!isEmpty(datasetInfo)) dataset.label = datasetInfo.label;
+            dataset.filters = dataset.filters.map(filter => {
+                let columnInfo: IColumn;
+                if (!isEmpty(datasetInfo)) columnInfo = datasetInfo.options.find(cInfo => cInfo.id === filter.column.id && cInfo.qrveyid === filter.column.qrveyid && cInfo.linkid === filter.column.linkid);
+                if (!isEmpty(columnInfo)) {
+                    filter.column.formulaType = columnInfo.formulaType;
+                    filter.column.geogroup = columnInfo.geogroup;
+                    filter.column.label = columnInfo.label;
+                    filter.column.outputFormat = columnInfo.outputFormat;
+                    filter.column.type = columnInfo.type;
+                }
+                return filter;
+            });
+            return dataset;
+        });
+        return scopes;
+    });
+    return { ...data, scopes: updatedScopes };
+}

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

@@ -2,7 +2,11 @@ export * from './excludeUIFiltersByAggregate';
 export * from './excludeUIFlatFiltersByScopes';
 export * from './getFilterPropertyLabel';
 export * from './getOutputFormatByColumn';
+export * from './getQrveyIdsByUIFilters';
 export * from './getUIFlatFilterByParams';
 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

@@ -0,0 +1,30 @@
+import { isEmpty } from "../../../general/mix/isEmpty";
+import { transformValue } from "../../../qrvey/helpers/transformValue";
+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: 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 (values as IFSValue[]).map((value: IFSValue) => ({
+            ...value,
+            value: transformValue(value.value, transformValueSettings),
+         }));
+    } else if (isRangeValidator(filter.validator)) {
+        return (values as IFSValueRange[]).map((value: IFSValueRange) => ({
+            ...value,
+            min: transformValue(value.min, transformValueSettings),
+            max: transformValue(value.max, transformValueSettings)
+         }));
+    } else {
+        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

@@ -1,4 +1,5 @@
 import { IColumn } from "../../columns/interfaces/IColumn";
+import { IDataset } from "../../qrvey/interfaces/IDataset";
 import { IFSFilterExtrasInfo } from "./common/IFSFilterExtrasInfo";
 import { IFDateSection } from "./IFDateSection";
 import { IFOperator } from "./IFOperator";
@@ -11,13 +12,14 @@ import { IFUChartSettings } from "./ui/IFUChartSettings";
 import { IFUValue } from "./ui/IFUValue";
 
 export interface OLD_IFilterDetail {
-    column?: IColumn;
+    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/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,6 +1,6 @@
-import { IResourceI18n } from "../../../globalization/interfaces/IResourceI18n";
 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";
@@ -9,15 +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 {
-    i18n?: IResourceI18n; // Globalization object
-    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;
@@ -33,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/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?: IFSColumn;
     dateSection?: IFDateSection;
     enableds?: IFSParamsToGetFilterEnableds;
+    chart?: IFUChartSettings;
     linkid?: string;
     panelid?: string;
     property?: IFProperty;

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/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;
+    dataset: 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/{common/IFSMergeFiltersSettings.ts → functions/IFFiltersMergeFilters.ts}

@@ -2,7 +2,8 @@
 /**
  * Structure for MergeFilters property settings
  */
-export interface IFSMergeFiltersSettings {
+export interface IFFiltersMergeFilters {
+    overwriteFilterProps?: boolean;
     overwriteValues?: boolean;
     setGroupedColumnOperator?: 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,5 @@
+export * from './IFFiltersGetData';
+export * from './IFFiltersGetValuesFromDataset';
+export * from './IFFiltersGetValuesFromModel';
+export * from './IFFiltersMergeFilters';
+export * from './IFFiltersParamsToGetFilter';

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

@@ -5,8 +5,9 @@
     canCollapse?: boolean; // Validates if the component can be collapsed. True: It can collapse; False: It cannot collapse
     collapsed?: boolean; // True: The component is collapsed; False: The component is not collapsed.
     colorModeDisplayed?: boolean; // True: Display the color of each filter scopes; False: Hide the color.
+    dynamicFilters?: boolean; // True: The filters should be filtered by given params from config or listener.
     enabled?: boolean; // True: The scope filters are applied. False: The scope filters are not applied.
     iconDisplayed?: boolean; // True: Display the icons linked with each scope; false: Do not display the icons.
     readonly?: boolean; // True: validates read only, any event could be executed.
-    dynamicFilters?: boolean; // True: The filters should be filtered by given params from config or listener.
+    updateFilterInfo?: boolean; // True: Update info of the datasets and columns stored in the filter structure
 }

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

@@ -1,4 +1,4 @@
-import { IResourceI18n } from "../../../globalization";
+import { II18nConfig } from "../../../globalization/interfaces/II18nConfig";
 import { IFilterBuilderConfig } from "../builder/IFilterBuilderConfig";
 import { IFUDataStore } from "../ui/IFUDataStore";
 
@@ -7,5 +7,5 @@ import { IFUDataStore } from "../ui/IFUDataStore";
  */
 export interface IFilterPanelConfig extends IFUDataStore {
     filterBuilderConfig?: IFilterBuilderConfig; // Filter Builder config object
-    i18n?: IResourceI18n;
+    i18n?: II18nConfig; // The i18n configuration;
 }

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/IFUTransformFilterValuesSettings.ts

@@ -0,0 +1,8 @@
+import { II18nConfig } from "../../../globalization/interfaces/II18nConfig";
+import { II18nServiceTranslate } from "../../../globalization/interfaces/II18nServiceTranslate";
+
+export interface IFUTransformFilterValuesSettings {
+    translate: II18nServiceTranslate; // Function for getting translations
+    i18n: II18nConfig; // I18n configuration
+    suffixTranslateLabel?: string // The i18n label for the suffix values.
+}

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

@@ -14,12 +14,13 @@
 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';
-export * from './IFUScope';
 export * from './IFUParamsToGetFilter';
-export * from './IFUValue';
+export * from './IFUScope';
+export * from './IFUTransformFilterValuesSettings';
 export * from './IFUUIValueSettings';
+export * from './IFUValue';

package/src/filters/services/Filters.api.ts

@@ -0,0 +1,151 @@
+import UChartPaginationApi from './UChartPaginationApi';
+import UChartApi from './UChartApi';
+import { IFBData } from '../interfaces/backend/IFBData';
+import { isRangeValidator } from '../helpers/common/isRangeValidator';
+import { getFiltersByVisibility } from '../helpers/common/getFiltersByVisibility';
+import { excludeFiltersByAggregateColumn } from '../helpers/common/excludeFiltersByAggregateColumn';
+import { FDToLogic } from '../adapters/FDToLogic';
+import { getLogicByScopesHierarchy } from '../helpers/backend/getLogicByScopesHierarchy';
+import { buildUserFilters } from '../helpers/backend/buildUserFilters';
+import { applyHierarchyForAggFilters } from '../helpers/applyHierarchyForAggFilters';
+import { getAvailableScopes } from '../helpers/getAvailableScopes';
+import { getAvailableScopesIDsByConfig } from '../helpers/getAvailableScopesIDsByConfig';
+import { FILTER_SCOPE } from '../constants/common/FILTER_SCOPE';
+import { IFSScopeID } from '../interfaces/common/IFSScopeID';
+import { IEndpointConfig } from '../../services/interfaces/IEndpointConfig';
+import { IDataset } from '../../qrvey/interfaces/IDataset';
+import { getAllDatasets } from '../../services/api/getAllDatasets.api';
+import { isEmpty } from '../../general/mix/isEmpty';
+import { IFUChartSettings } from '../interfaces/ui/IFUChartSettings';
+import { IFilterConfig } from '../interfaces/common/IFilterConfig';
+import { IFSGetDataValues } from '../interfaces/common/IFSGetDataValues';
+import { getModel } from '../../services/api/getModel.api';
+import { IModel } from '../../qrvey/interfaces/IModel';
+import { IFUFlattenedFilter } from '../interfaces/ui/IFUFlattenedFilter';
+import { areStaticColumnValues } from '../../qrvey/helpers/areStaticColumnValues';
+import { getValuesFromDataset } from '../helpers/common/getValuesFromDataset';
+import { IFFiltersGetData } from '../interfaces/functions/IFFiltersGetData';
+
+
+interface IFilterApiConfig extends IFilterConfig {
+  endpoint?: IEndpointConfig;
+  qrveyid: string
+}
+
+export class FiltersApi {
+  // abortCtrl: AbortController;
+  private config: IFilterApiConfig;
+  private chartApi: UChartApi | UChartPaginationApi;
+  private chartPaginationApi;
+
+  constructor(cfg: IFilterApiConfig) {
+    this.setConfig(cfg);
+    this.chartPaginationApi = new UChartPaginationApi();
+    this.chartApi = new UChartApi();
+  }
+
+  /**
+   * Get the model by Qrvey ID
+   * @param qrveyid The Qrvey ID
+   * @returns a promise with the resulting model
+   */
+   getModel(qrveyid?: string): Promise<IModel> {
+    const config = isEmpty(qrveyid) ? { ...this.config } : { ...this.config, qrveyid };
+    return getModel(config, { includeInfo: ['datalinkInfo', 'bucketsInfo', 'formulaInfo', 'componentPreferences'] });
+  }
+
+  /**
+   * Get a dataset list from a collection of Qrvey IDs
+   * @param qrveyids Collection of Qrvey IDs
+   * @returns a promise
+   */
+  public getDatasets(qrveyids: string[]): Promise<IDataset[]> {
+    return getAllDatasets(this.config, qrveyids);
+  }
+
+  // public getAllDataTokens(config): Promise<any> {
+  //   return DataTokensApi.getAll(config);
+  // }
+
+  public getData(config: IFFiltersGetData, resetApi = false): Promise<IFBData> {
+    let promise;
+    if (areStaticColumnValues(config.filter?.column) && isEmpty(config.filter?.column.aggregate)) {
+      promise = getValuesFromDataset({
+        column: config.filter?.column,
+        property: config.filter?.property,
+        lookupDisplay: config.filter?.lookupDisplayIndex,
+        dataset: config.dataset,
+        value: config.valueText,
+      });
+    } else {
+      promise = this.getDataValues(config, resetApi);
+    }
+
+    return promise;
+  }
+
+  /**
+   * Get a promise with a preview of resulting data. Depending on the validator, the endpoint will change.
+   * @param uFilter The Filter Builder Filter
+   * @param filterLogic Additional filter logic to apply in the preview
+   * @param chartSettings
+   * @param resetApi flag to determine when the api should be reseted.
+   * @returns a promise with a preview of resulting data.
+   */
+  private async getDataValues(config: IFSGetDataValues, resetApi = false): Promise<IFBData> {
+    let api: UChartApi | UChartPaginationApi;
+    if (isRangeValidator(config.filter.validator)) {
+      this.chartPaginationApi.afterKey = undefined;
+      api = this.chartApi as UChartApi;
+    } else {
+      api = this.chartPaginationApi as UChartPaginationApi;
+    }
+    return api.getChartResult(this.config, this.getFilter(config), this.getLogic(config), this.getChartRequest(config), resetApi);
+  }
+
+  private getLogic(config: IFSGetDataValues) {
+    const scopes = this.getAvailableScopeIds(config);
+    let filterData = getFiltersByVisibility(config.filterData, scopes);
+    filterData = excludeFiltersByAggregateColumn(filterData);
+    const logics = FDToLogic(filterData);
+    const hierarchyLogic = getLogicByScopesHierarchy(logics, scopes, config.filter?.extras.scope);
+  
+    return [
+      ...hierarchyLogic,
+      ...buildUserFilters(config.userFilters) || [],
+    ];
+  }
+  
+  private getFilter(config: IFSGetDataValues): IFUFlattenedFilter {
+    return { ... config.filter, values: !isEmpty(config.valueText) ? [{ value: config.valueText, enabled: true }] : undefined };
+  }
+  
+  private getChartRequest(config: IFSGetDataValues): IFUChartSettings {
+    const scopes = this.getAvailableScopeIds(config);
+    return applyHierarchyForAggFilters(config.chartRequest, scopes, config.filter?.extras.scope);
+  }
+
+  /**
+  * Gets the available scopes and scope IDs
+  * @returns a collection of the pair Scopes and Scope IDs
+  */
+  private getAvailableScopeIds(config: IFFiltersGetData): IFSScopeID[] {
+    return getAvailableScopes({
+        ...getAvailableScopesIDsByConfig(config),
+        qrveyid: config.filter?.column?.qrveyid,
+        defaultid: [FILTER_SCOPE.DEFAULT, FILTER_SCOPE.CHART].includes(config.filter?.extras.scope) && config.filter?.column?.qrveyid,
+        scope: undefined,
+        predefinedScopes: [
+          { label: FILTER_SCOPE.DATA, id: config.filter?.column?.qrveyid }
+        ]
+      });
+    }
+
+  /**
+   * Set the config into the Filter Builder Api class
+   * @param config the config.
+   */
+  public setConfig(config: IFilterApiConfig): void {
+    this.config = { ...config };
+  }
+}