@qrvey/utils 1.3.0-1 → 1.3.0-12

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/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/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";
 
@@ -9,9 +10,10 @@ import { IFSParamsToGetFilterEnableds } from "./IFSParamsToGetFilterEnableds";
  * Structure for filter properties
  */
 export interface IFSParamsToGetFilter {
-    column?: IFSColumn;
+    column?: Partial<IFSColumn>;
     dateSection?: IFDateSection;
     enableds?: IFSParamsToGetFilterEnableds;
+    chart?: IFUChartSettings;
     linkid?: string;
     panelid?: string;
     property?: IFProperty;
@@ -19,4 +21,4 @@ export interface IFSParamsToGetFilter {
     scope?: IFScope;
     scopeid?: string;
     validator?: IFValidator;
-}
+}

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/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/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,6 @@
+export * from './IFFiltersGetData';
+export * from './IFFiltersGetValuesFromDataset';
+export * from './IFFiltersGetValuesFromModel';
+export * from './IFFiltersMergeFilters';
+export * from './IFFiltersMergeValues';
+export * from './IFFiltersParamsToGetFilter';

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

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

@@ -0,0 +1,154 @@
+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';
+import { getFiltersByDatasetsColumns } from '../helpers/common/getFiltersByDatasetsColumns';
+import { IFUData } from '../interfaces/ui/IFUData';
+
+
+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 = getFiltersByDatasetsColumns(filterData as IFUData, [config.dataset]);
+    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 };
+  }
+}