@qrvey/filters 0.0.45 → 0.1.0

package/dist/classes/FilterValidation.js

@@ -1,64 +1,7 @@
 import { getFilterType } from "../helpers/getFilterType";
 import { FILTER_GROUPING_COLUMNS, FILTER_GROUPING_VALIDATORS, } from "../resources/filter-grouping.resources";
 import { FILTER_TYPE } from "../resources/filters.resources";
-/**
- *
- */
 export class FilterValidation {
-    //   /**
-    //    *
-    //    * @param filter
-    //    */
-    //   filter(filter: IFilter): IFilterValidationSingleError {
-    //     const errors: IFilterValidationError[] = [];
-    //     if (isEmpty(filter) || !isObject(filter))
-    //       errors.push({ type: FILTER_VALIDATION.EMPTY_FILTER });
-    //     return {
-    //       infoErrors: getInfoErrors(errors),
-    //       errors,
-    //     };
-    //   }
-    //   /**
-    //    *
-    //    * @param filter
-    //    * @param values
-    //    */
-    //   static values(
-    //     filter: IFilter,
-    //     values: IFilterInputValue[],
-    //   ): IFilterValidationSingleError {
-    //     const errors: IFilterValidationError[] = [];
-    //     if (isEmpty(filter)) errors.push({ type: FILTER_VALIDATION.EMPTY_FILTER });
-    //     const { columnType, validator, values: filterValues } = filter;
-    //     const filterType = getFilterType(columnType, validator);
-    //     switch (filterType) {
-    //       case FILTER_TYPE.NULL:
-    //         if (!isEmpty(filterValues) || !isEmpty(values))
-    //           errors.push({ type: FILTER_VALIDATION.EMPTY_FILTER });
-    //         break;
-    //       case FILTER_TYPE.RANGE:
-    //         if (isEmpty(values))
-    //           errors.push({ type: FILTER_VALIDATION.NOT_EMPTY_VALUES });
-    //         else if (values)
-    //           FilterValidation.rangeValues(filter, values)
-    //       default:
-    //         break;
-    //     }
-    //   }
-    //   private static rangeValues(filter: IFilter, values: IFilterInputValueRange[]): IFilterValidationSingleError {
-    //     const errors: IFilterValidationError[] = [];
-    //     filter.validator
-    //     FILTER_VALIDATOR.
-    //     values.forEach(value => {
-    //       if (value.max
-    //     });
-    //   }
-    /**
-     * Validated if the given filter exists into the filter collection
-     * @param filters the collection of filters
-     * @param filter the filter to validate
-     * @returns True when the filter is duplicated in the collection
-     */
     static isDuplicated(filters, filter) {
         if (!Array.isArray(filters))
             return false;
@@ -73,12 +16,6 @@ export class FilterValidation {
             _filter.validator === filter.validator &&
             FilterValidation.isFilterValueDuplicated(_filter, filter));
     }
-    /**
-     * Validates if the given regular value is duplicated with another value collection
-     * @param filter1 the filter info
-     * @param filter2 the filter info to compare
-     * @returns true when the value is duplicated
-     */
     static isFilterValueDuplicated(filter1, filter2) {
         const filterType1 = getFilterType(filter1.columnType, filter1.validator);
         const filterType2 = getFilterType(filter2.columnType, filter2.validator);
@@ -95,52 +32,22 @@ export class FilterValidation {
                 return this.isFilterRegularValueDuplicated(filter1.values, filter2.values);
         }
     }
-    /**
-     * Validates if the given regular value is duplicated with another value collection
-     * @param values1 the filter regular values collection
-     * @param values2 the filter regular values collection
-     * @returns true when the regular value is duplicated
-     */
     static isFilterRegularValueDuplicated(values1, values2) {
         return values1.every((value1) => values2.some((value2) => value1.id === value2.id && value1.value === value2.value));
     }
-    /**
-     * Validates if the given range value is duplicated with another value collection
-     * @param values1 the filter range values collection
-     * @param values2 the filter range values colleciton
-     * @returns true when the range value is duplicated
-     */
     static isFilterRangeValueDuplicated(values1, values2) {
         return values1.every((value1) => values2.some((value2) => value1.id === value2.id &&
             value1.max === value2.max &&
             value1.min === value2.min));
     }
-    /**
-     * Validates if the given relative value is duplicated with another value collection
-     * @param values1 the filter relative values collection
-     * @param values2 the filter relative values collection
-     * @returns true when the relative value is duplicated
-     */
     static isFilterRelativeValueDuplicated(values1, values2) {
         return values1.every((value1) => values2.some((value2) => value1.id === value2.id &&
             value1.cursor === value2.cursor &&
             value1.unit === value2.unit));
     }
-    /**
-     * Validates if the given ranking value is duplicated with another value collection
-     * @param _values1 the filter ranking values collection
-     * @param _values2 the filter ranking values collection
-     * @returns true when the ranking value is duplicated
-     */
     static isFilterRankingValueDuplicated(_values1, _values2) {
         return false;
     }
-    /**
-     * Validates if the grouping is valid to set for the given params
-     * @param columnType the column type
-     * @param validator the filter validator
-     * @returns true when the grouping is valid
-     */
     static isGroupingValid(columnType, validator) {
         return (FILTER_GROUPING_COLUMNS.includes(columnType) &&
             FILTER_GROUPING_VALIDATORS.includes(validator));

package/dist/classes/FilterValues.d.ts

@@ -1,33 +1,8 @@
 import { IFilterInputValue, IFilterInputValueRange, IFilterInputValueRegular, IFilterInputValueRelativeDate, IFilterValueRange, IFilterValueRegular, IFilterValueRelativeDate } from "../resources/filter-values.resources";
 import { IFilterType } from "../resources/filters.resources";
-/**
- * Class to manipulate filter values and input values
- */
 export declare class FilterValues {
-    /**
-     * Gets the Filter Values based on Regular Input values
-     * @param values the regular input values
-     * @returns the Filter Regular Values
-     */
     static getFilterRegularValues(values?: IFilterInputValueRegular[]): IFilterValueRegular[];
-    /**
-     * Gets the Filter Values based on Range Input values
-     * @param values the range input values
-     * @returns the Filter Range Values
-     */
     static getFilterRangeValues(values?: IFilterInputValueRange[]): IFilterValueRange[];
-    /**
-     * Gets the Filter Values based on Relative Input values
-     * @param values the relative range input value
-     * @returns the Filter Relative Value
-     */
     static getFilterRelativeValues(values?: IFilterInputValueRelativeDate[]): IFilterValueRelativeDate[];
-    /**
-     * Gets the Filter Values based on the flter type
-     * @param filterType the filter type
-     * @param values the input values
-     * @returns the Filter Values
-     */
     static getFilterValues(filterType: IFilterType, values?: IFilterInputValue[]): IFilterValueRegular[];
 }
-//# sourceMappingURL=FilterValues.d.ts.map

package/dist/classes/FilterValues.js

@@ -1,13 +1,5 @@
 import { FILTER_TYPE } from "../resources/filters.resources";
-/**
- * Class to manipulate filter values and input values
- */
 export class FilterValues {
-    /**
-     * Gets the Filter Values based on Regular Input values
-     * @param values the regular input values
-     * @returns the Filter Regular Values
-     */
     static getFilterRegularValues(values = []) {
         return values.map((value) => ({
             displayed: true,
@@ -15,11 +7,6 @@ export class FilterValues {
             value: `${value}`,
         }));
     }
-    /**
-     * Gets the Filter Values based on Range Input values
-     * @param values the range input values
-     * @returns the Filter Range Values
-     */
     static getFilterRangeValues(values = []) {
         return values.map((value) => ({
             displayed: true,
@@ -28,11 +15,6 @@ export class FilterValues {
             min: value.min,
         }));
     }
-    /**
-     * Gets the Filter Values based on Relative Input values
-     * @param values the relative range input value
-     * @returns the Filter Relative Value
-     */
     static getFilterRelativeValues(values = []) {
         return values.map((value) => ({
             displayed: true,
@@ -40,12 +22,6 @@ export class FilterValues {
             ...value,
         }));
     }
-    /**
-     * Gets the Filter Values based on the flter type
-     * @param filterType the filter type
-     * @param values the input values
-     * @returns the Filter Values
-     */
     static getFilterValues(filterType, values = []) {
         switch (filterType) {
             case FILTER_TYPE.REGULAR:

package/dist/classes/index.d.ts

@@ -5,4 +5,3 @@ export * from "./FilterResources";
 export * from "./FilterSearcher";
 export * from "./FilterValues";
 export * from "./FilterValidation";
-//# sourceMappingURL=index.d.ts.map

package/dist/helpers/filter-adapt.helpers.d.ts

@@ -2,20 +2,5 @@ import { IDataset } from "@qrvey/utils";
 import { IFilterPanelInteractiveTable } from "../resources/filter-panel.interfaces";
 import { IFilterVisual } from "../resources/filter-visual.resources";
 import { IFilter } from "../resources/filters.resources";
-/**
- * Generates a visual filter structure from the filter collection.
- * @param filters Array of filters
- * @param datasets Array of the dataset info
- * @param interactiveTable table of interaction properties for each section
- * @returns a Filter Data structure
- */
 export declare function filterToVisual(filters: IFilter[], datasets?: IDataset[], interactiveTable?: IFilterPanelInteractiveTable): IFilterVisual | undefined;
-/**
- * Gets the Interactive Table object from the visual filters
- * If an interactive table object is given, it will be merged with the new one
- * @param visual the visual filters
- * @param interactiveTable the interactive table object
- * @returns the interactive table object
- */
 export declare function legacyVisualToInteractiveTable(visual: IFilterVisual, interactiveTable?: IFilterPanelInteractiveTable): IFilterPanelInteractiveTable | undefined;
-//# sourceMappingURL=filter-adapt.helpers.d.ts.map

package/dist/helpers/filter-adapt.helpers.js

@@ -2,13 +2,6 @@ import { isEmpty } from "@qrvey/utils";
 import { getColumnInfo, getDatasetInfo } from "./utils.helpers";
 import { DEFAULT_UI_FILTER, } from "../resources/filter-visual.resources";
 import { DEFAULT_FILTER } from "../resources/filters.resources";
-/**
- * Generates a visual filter structure from the filter collection.
- * @param filters Array of filters
- * @param datasets Array of the dataset info
- * @param interactiveTable table of interaction properties for each section
- * @returns a Filter Data structure
- */
 export function filterToVisual(filters, datasets = [], interactiveTable) {
     if (isEmpty(filters) || !Array.isArray(filters))
         return;
@@ -16,13 +9,6 @@ export function filterToVisual(filters, datasets = [], interactiveTable) {
         scopes: buildScopes(filters, datasets, interactiveTable),
     };
 }
-/**
- * Gets the Interactive Table object from the visual filters
- * If an interactive table object is given, it will be merged with the new one
- * @param visual the visual filters
- * @param interactiveTable the interactive table object
- * @returns the interactive table object
- */
 export function legacyVisualToInteractiveTable(visual, interactiveTable) {
     if (isEmpty(visual) || isEmpty(visual?.scopes))
         return;
@@ -54,16 +40,7 @@ export function legacyVisualToInteractiveTable(visual, interactiveTable) {
         delete newInteractiveTable.interactDatasets;
     return newInteractiveTable;
 }
-/**
- * Gets a collection of scopes for the visual filter data.
- * The scopes are organized by scope types and IDs
- * Also, adds and organizes filters by datasets
- * @param filters Collection of filters
- * @param datasets Array of the dataset info
- * @param interactiveTable table of interaction properties for each section
- * @returns an array of visual scopes.
- */
-function buildScopes(filters = [], datasets = [], interactiveTable) {
+function buildScopes(filters, datasets, interactiveTable) {
     return filters.reduce((scopes, filter) => {
         const datasetInfo = getDatasetInfo({ columnId: filter.columnId, datasetId: filter.datasetId }, datasets);
         const uiFilter = buildFilter(filter, datasetInfo);
@@ -88,12 +65,6 @@ function buildScopes(filters = [], datasets = [], interactiveTable) {
         return scopes;
     }, []);
 }
-/**
- * Gets an scope structure for the filter data
- * @param filter the filter
- * @param interactiveTable table of interaction properties for each section
- * @returns the visual scope structure
- */
 function buildScope(filter, interactiveTable) {
     const { collapsed } = interactiveTable?.interactScopes?.find((interactive) => interactive.scope === filter.scope &&
         interactive.scopeId === filter.scopeId) ?? {};
@@ -104,13 +75,6 @@ function buildScope(filter, interactiveTable) {
         id: filter.scopeId,
     };
 }
-/**
- * Gets an dataset structure for the visual filter
- * @param filter the filter
- * @param dataset the dataset info
- * @param interactiveTable table of interaction properties for each section
- * @returns an dataset structure
- */
 function buildDataset(filter, dataset, interactiveTable) {
     const { collapsed } = interactiveTable?.interactDatasets?.find((interactive) => interactive.datasetId === filter.datasetId) ?? {};
     return {
@@ -120,12 +84,6 @@ function buildDataset(filter, dataset, interactiveTable) {
         filters: [],
     };
 }
-/**
- * Gets an filter structure for the visual filter
- * @param filter a UI structure filter
- * @param dataset the dataset info
- * @returns an filter structure
- */
 function buildFilter(filter, dataset) {
     const columnInfo = dataset == null
         ? undefined

package/dist/helpers/filter-adapt.legacy.helpers.d.ts

@@ -1,26 +1,6 @@
 import { IDataset, IFUData } from "@qrvey/utils";
 import { IFilterPanelInteractiveTable } from "../resources/filter-panel.interfaces";
 import { IFilter } from "../resources/filters.resources";
-/**
- * Generates a legacy visual filter structure from the filter collection.
- * @param filters Array of filters
- * @param datasets Array of the dataset info
- * @param interactiveTable table of interaction properties for each section
- * @returns a Filter Data structure
- */
 export declare function filterToLegacyVisual(filters: IFilter[], datasets?: IDataset[], interactiveTable?: IFilterPanelInteractiveTable): IFUData | undefined;
-/**
- * Generates a legacy visual filter structure from the filter collection.
- * @param filterData the legacy filter
- * @returns a Filter collection
- */
 export declare function legacyVisualToFilter(filterData: IFUData): IFilter[];
-/**
- * Gets the Interactive Table object from the legacy visual filters
- * If an interactive table object is given, it will be merged with the new one
- * @param legacyVisual the legacy visual filters
- * @param interactiveTable the interactive table object
- * @returns the interactive table object
- */
 export declare function legacyVisualToInteractiveTable(legacyVisual: IFUData, interactiveTable?: IFilterPanelInteractiveTable): IFilterPanelInteractiveTable | undefined;
-//# sourceMappingURL=filter-adapt.legacy.helpers.d.ts.map

package/dist/helpers/filter-adapt.legacy.helpers.js

@@ -1,13 +1,6 @@
 import { FILTER_SCOPE, FILTER_SECTION, isEmpty, } from "@qrvey/utils";
 import { getColumnInfo, getDatasetInfo } from "./utils.helpers";
 import { FilterBuilder } from "../classes/FilterBuilder";
-/**
- * Generates a legacy visual filter structure from the filter collection.
- * @param filters Array of filters
- * @param datasets Array of the dataset info
- * @param interactiveTable table of interaction properties for each section
- * @returns a Filter Data structure
- */
 export function filterToLegacyVisual(filters, datasets = [], interactiveTable) {
     if (isEmpty(filters))
         return;
@@ -18,11 +11,6 @@ export function filterToLegacyVisual(filters, datasets = [], interactiveTable) {
         scopes: buildLegacyScopes(filters, datasets, interactiveTable),
     };
 }
-/**
- * Generates a legacy visual filter structure from the filter collection.
- * @param filterData the legacy filter
- * @returns a Filter collection
- */
 export function legacyVisualToFilter(filterData) {
     if (isEmpty(filterData) || isEmpty(filterData?.scopes))
         return [];
@@ -64,13 +52,6 @@ export function legacyVisualToFilter(filterData) {
     });
     return filters;
 }
-/**
- * Gets the Interactive Table object from the legacy visual filters
- * If an interactive table object is given, it will be merged with the new one
- * @param legacyVisual the legacy visual filters
- * @param interactiveTable the interactive table object
- * @returns the interactive table object
- */
 export function legacyVisualToInteractiveTable(legacyVisual, interactiveTable) {
     if (isEmpty(legacyVisual) || isEmpty(legacyVisual?.scopes))
         return;
@@ -102,16 +83,7 @@ export function legacyVisualToInteractiveTable(legacyVisual, interactiveTable) {
         delete newInteractiveTable.interactDatasets;
     return newInteractiveTable;
 }
-/**
- * Gets a collection of legacy scopes for the legacy visual filters.
- * The scopes are organized by scope types and IDs
- * Also, adds and organizes filters by datasets
- * @param filters Collection of filters
- * @param datasets Array of the dataset info
- * @param interactiveTable table of interaction properties for each section
- * @returns an array of visual scopes.
- */
-function buildLegacyScopes(filters = [], datasets = [], interactiveTable) {
+function buildLegacyScopes(filters, datasets, interactiveTable) {
     return filters.reduce((scopes, filter) => {
         const datasetInfo = getDatasetInfo({ columnId: filter.columnId, datasetId: filter.datasetId }, datasets);
         const uiFilter = buildLegacyFilter(filter, datasetInfo);
@@ -136,12 +108,6 @@ function buildLegacyScopes(filters = [], datasets = [], interactiveTable) {
         return scopes;
     }, []);
 }
-/**
- * Gets an legacy scope structure for the legacy filter data
- * @param filter the filter
- * @param interactiveTable table of interaction properties for each section
- * @returns the legacy visual scope structure
- */
 function buildLegacyScope(filter, interactiveTable) {
     const { collapsed } = interactiveTable?.interactScopes?.find((interactive) => interactive.scope === filter.scope &&
         interactive.scopeId === filter.scopeId) ?? {};
@@ -154,13 +120,6 @@ function buildLegacyScope(filter, interactiveTable) {
         scopeid: filter.scopeId,
     };
 }
-/**
- * Gets an legacy dataset structure for the legacy visual filter
- * @param filter the filter
- * @param dataset the dataset info
- * @param interactiveTable table of interaction properties for each section
- * @returns an legacy dataset structure
- */
 function buildLegacyDataset(filter, dataset, interactiveTable) {
     const { collapsed } = interactiveTable?.interactDatasets?.find((interactive) => interactive.datasetId === filter.datasetId &&
         interactive.scope === filter.scope &&
@@ -174,22 +133,17 @@ function buildLegacyDataset(filter, dataset, interactiveTable) {
         filters: [],
     };
 }
-/**
- * Gets an legacy filter structure for the legacy visual filter
- * @param filter a UI structure filter
- * @param dataset the dataset info
- * @returns an legacy filter structure
- */
 function buildLegacyFilter(filter, dataset) {
     const columnInfo = dataset == null
         ? undefined
         : getColumnInfo({ columnId: filter.columnId, datasetId: filter.datasetId }, [dataset]);
+    const columnLabel = columnInfo?.label ?? "";
     return {
         collapsed: filter.collapsed ?? false,
         column: {
             id: filter.columnId,
             formulaType: columnInfo?.formulaType,
-            label: columnInfo?.label || "",
+            label: columnLabel,
             qrveyid: filter.datasetId,
             aggregate: filter.aggregateType,
             type: filter.columnType,

package/dist/helpers/filter-adapt.logic.helpers.d.ts

@@ -1,29 +1,7 @@
 import { IFilterLogic, IFilterLogicExpression, IFilterLogicExpressionValue } from "../resources/filter-logic.resources";
 import { IFilterUI, IFilterVisual } from "../resources/filter-visual.resources";
 import { IFilter } from "../resources/filters.resources";
-/**
- * Generates a Logic structure from the filter collection
- * @param filters the filter collection
- * @returns the logic structure
- */
 export declare function filterToLogic(filters: IFilter[]): IFilterLogic[];
-/**
- * Generates a Logic structure from the visual filter structure
- * @param visual the visual filter structure
- * @returns the logic structure
- */
 export declare function visualToLogic(visual: IFilterVisual): IFilterLogic[];
-/**
- * Builds filter expression by the filter data.
- * - If the resulting value array is empty the enabled property will be false.
- * @param filter The filter to transform
- * @returns a filter expression
- */
 export declare function buildLogicExpression(filter: IFilterUI): IFilterLogicExpression;
-/**
- * Gets the expresion values in the logic format
- * @param filter The filter structure
- * @returns A collection of backend expression value
- */
 export declare function getFilterLogicValues(filter: IFilterUI): IFilterLogicExpressionValue[];
-//# sourceMappingURL=filter-adapt.logic.helpers.d.ts.map