@qrvey/filters 0.0.13 → 0.0.15

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

@@ -0,0 +1,229 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.legacyVisualToInteractiveTable = exports.legacyVisualToFilter = exports.filterToLegacyVisual = void 0;
+const utils_1 = require("@qrvey/utils");
+const utils_helpers_1 = require("./utils.helpers");
+const FilterBuilder_1 = require("../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
+ */
+function filterToLegacyVisual(filters, datasets = [], interactiveTable) {
+    if ((0, utils_1.isEmpty)(filters))
+        return;
+    return {
+        enabled: true,
+        section: utils_1.FILTER_SECTION.DX,
+        version: "2.1",
+        scopes: buildLegacyScopes(filters, datasets, interactiveTable),
+    };
+}
+exports.filterToLegacyVisual = filterToLegacyVisual;
+/**
+ * Generates a legacy visual filter structure from the filter collection.
+ * @param filterData the legacy filter
+ * @returns a Filter collection
+ */
+function legacyVisualToFilter(filterData) {
+    if ((0, utils_1.isEmpty)(filterData) || (0, utils_1.isEmpty)(filterData?.scopes))
+        return [];
+    const filters = [];
+    filterData.scopes.forEach((scope) => {
+        if (scope.datasets.length === 0)
+            return;
+        scope.datasets.forEach((dataset) => {
+            if (dataset.filters.length === 0)
+                return;
+            dataset.filters.forEach((filter) => {
+                const fFilter = FilterBuilder_1.FilterBuilder.createFilter({
+                    aggregateType: filter.column.aggregate,
+                    collapsed: filter.collapsed,
+                    columnId: filter.column.id,
+                    columnType: filter.column.type,
+                    customLabel: filter.extras.filterLabel,
+                    datasetId: dataset.qrveyid,
+                    deletable: filter.deletable,
+                    displayed: filter.displayed,
+                    editable: filter.editable,
+                    enableable: filter.enableable,
+                    enabled: filter.enabled,
+                    extras: filter.extras,
+                    grouping: filter.property,
+                    id: "",
+                    lookupDisplayIndex: filter.lookupDisplayIndex,
+                    operator: filter.operator,
+                    scope: scope.scope,
+                    scopeId: scope.scopeid,
+                    section: filterData.section,
+                    selectAll: filter.selectAll,
+                    validator: filter.validator,
+                    values: filter.values,
+                });
+                filters.push(fFilter);
+            });
+        });
+    });
+    return filters;
+}
+exports.legacyVisualToFilter = legacyVisualToFilter;
+/**
+ * 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
+ */
+function legacyVisualToInteractiveTable(legacyVisual, interactiveTable) {
+    if ((0, utils_1.isEmpty)(legacyVisual) || (0, utils_1.isEmpty)(legacyVisual?.scopes))
+        return;
+    const newInteractiveTable = {
+        ...interactiveTable,
+        interactScopes: [],
+        interactDatasets: [],
+    };
+    legacyVisual.scopes.forEach((scope) => {
+        newInteractiveTable.interactScopes.push({
+            collapsed: scope.collapsed,
+            scope: scope.scope,
+            scopeId: scope.scopeid,
+        });
+        if (scope.datasets.length === 0)
+            return;
+        scope.datasets.forEach((dataset) => {
+            newInteractiveTable.interactDatasets.push({
+                collapsed: dataset.collapsed,
+                scope: scope.scope,
+                scopeId: scope.scopeid,
+                datasetId: dataset.qrveyid,
+            });
+        });
+    });
+    if ((0, utils_1.isEmpty)(newInteractiveTable.interactScopes))
+        delete newInteractiveTable.interactScopes;
+    if ((0, utils_1.isEmpty)(newInteractiveTable.interactDatasets))
+        delete newInteractiveTable.interactDatasets;
+    return newInteractiveTable;
+}
+exports.legacyVisualToInteractiveTable = legacyVisualToInteractiveTable;
+/**
+ * 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) {
+    return filters.reduce((scopes, filter) => {
+        const datasetInfo = (0, utils_helpers_1.getDatasetInfo)({ columnId: filter.columnId, datasetId: filter.datasetId }, datasets);
+        const uiFilter = buildLegacyFilter(filter, datasetInfo);
+        const uiDataset = buildLegacyDataset(filter, datasetInfo, interactiveTable);
+        const uiScope = buildLegacyScope(filter, interactiveTable);
+        const scopeIndex = scopes.findIndex((sc) => sc.scope === filter.scope && sc.scopeid === filter.scopeId);
+        const datasetIndex = scopeIndex > -1
+            ? scopes[scopeIndex].datasets.findIndex((dt) => dt.qrveyid === filter.datasetId)
+            : -1;
+        if (scopeIndex === -1) {
+            scopes.push({
+                ...uiScope,
+                datasets: [{ ...uiDataset, filters: [uiFilter] }],
+            });
+        }
+        else if (datasetIndex === -1) {
+            scopes[scopeIndex].datasets.push({ ...uiDataset, filters: [uiFilter] });
+        }
+        else {
+            scopes[scopeIndex].datasets[datasetIndex].filters.push(uiFilter);
+        }
+        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) ?? {};
+    return {
+        collapsed: collapsed ?? false,
+        datasets: [],
+        displayed: true,
+        enabled: true,
+        scope: filter.scope,
+        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) ?? {};
+    return {
+        collapsed: collapsed ?? false,
+        qrveyid: filter.datasetId,
+        label: dataset?.label || "",
+        displayed: true,
+        enabled: true,
+        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
+        : (0, utils_helpers_1.getColumnInfo)({ columnId: filter.columnId, datasetId: filter.datasetId }, [dataset]);
+    return {
+        collapsed: filter.collapsed ?? false,
+        column: {
+            id: filter.columnId,
+            formulaType: columnInfo?.formulaType,
+            label: columnInfo?.label || "",
+            qrveyid: filter.datasetId,
+            aggregate: filter.aggregateType,
+            type: filter.columnType,
+        },
+        deletable: filter.deletable,
+        displayed: filter.displayed,
+        editable: filter.editable,
+        enableable: filter.enableable,
+        enabled: filter.enabled,
+        filterid: filter.id,
+        extras: {
+            ...filter.extras,
+            filterLabel: filter.customLabel,
+            panelid: utils_1.FILTER_SCOPE.CHART === filter.scope ? filter.scopeId : undefined,
+            info: !(0, utils_1.isEmpty)(filter.extras?.info)
+                ? {
+                    icon: filter.icon || "",
+                    label: filter.iconTooltip || "",
+                }
+                : undefined,
+            scope: filter.scope,
+            scopeid: filter.scopeId,
+            section: filter.section,
+        },
+        lookupDisplayIndex: filter.lookupDisplayIndex,
+        nullValues: false,
+        operator: filter.operator,
+        property: filter.grouping,
+        selectAll: filter.selectAll,
+        validator: filter.validator,
+        values: filter.values,
+    };
+}

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

@@ -49,7 +49,6 @@ exports.visualToLogic = visualToLogic;
  */
 function buildLogic(scope) {
     return {
-        enabled: scope.enabled,
         filters: [],
         scope: scope.scope,
         scopeid: scope.id,
@@ -59,6 +58,7 @@ function buildLogic(scope) {
  * Gets the Logic Filters collection based on filters
  * @param filters the filter collection
  * @param groupColumns a flag to know if the
+ * @returns the logic filter collection
  */
 function buildLogicFilters(filters, groupColumns = false) {
     const expression = numericExpression(filters, groupColumns);

package/dist/cjs/resources/filter-logic.resources.d.ts

@@ -7,10 +7,6 @@ export type IFilterLogicValidator = FILTER_LOGIC_VALIDATOR;
  * The structure of the logic
  */
 export interface IFilterLogic {
-    /**
-     * Flag to apply the logic.
-     */
-    enabled: boolean;
     /**
      * The filter structure
      */

package/dist/cjs/resources/filter-logic.resources.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"filter-logic.resources.d.ts","sourceRoot":"","sources":["../../../src/resources/filter-logic.resources.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAErE,MAAM,MAAM,qBAAqB,GAAG,sBAAsB,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC9B;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAC;IAC1B;;OAEG;IACH,WAAW,EAAE,kBAAkB,EAAE,GAAG,sBAAsB,EAAE,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,GAAG,MAAM,CAAC;IACpC;;OAEG;IACH,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,2BAA2B,EAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GACnC,kCAAkC,GAClC,gCAAgC,GAChC,mCAAmC,GACnC,kCAAkC,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG,MAAM,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,oBAAY,sBAAsB;IAChC,MAAM,UAAU;IAChB,SAAS,cAAc;IACvB,QAAQ,YAAY;IACpB,WAAW,gBAAgB;IAC3B,SAAS,aAAa;IACtB,YAAY,iBAAiB;IAC7B,WAAW,eAAe;IAC1B,cAAc,mBAAmB;IACjC,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,eAAe,uBAAuB;IACtC,YAAY,iBAAiB;IAC7B,kBAAkB,0BAA0B;IAC5C,OAAO,aAAa;IACpB,WAAW,iBAAiB;IAC5B,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,EAAE,OAAO;IACT,QAAQ,aAAa;CACtB"}
+{"version":3,"file":"filter-logic.resources.d.ts","sourceRoot":"","sources":["../../../src/resources/filter-logic.resources.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAErE,MAAM,MAAM,qBAAqB,GAAG,sBAAsB,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC9B;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,eAAe,CAAC;IAC1B;;OAEG;IACH,WAAW,EAAE,kBAAkB,EAAE,GAAG,sBAAsB,EAAE,CAAC;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,eAAe,GAAG,MAAM,CAAC;IACpC;;OAEG;IACH,cAAc,CAAC,EAAE,qBAAqB,CAAC;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,2BAA2B,EAAE,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,MAAM,2BAA2B,GACnC,kCAAkC,GAClC,gCAAgC,GAChC,mCAAmC,GACnC,kCAAkC,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG,MAAM,CAAC;AAExD;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,oBAAY,sBAAsB;IAChC,MAAM,UAAU;IAChB,SAAS,cAAc;IACvB,QAAQ,YAAY;IACpB,WAAW,gBAAgB;IAC3B,SAAS,aAAa;IACtB,YAAY,iBAAiB;IAC7B,WAAW,eAAe;IAC1B,cAAc,mBAAmB;IACjC,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,eAAe,uBAAuB;IACtC,YAAY,iBAAiB;IAC7B,kBAAkB,0BAA0B;IAC5C,OAAO,aAAa;IACpB,WAAW,iBAAiB;IAC5B,KAAK,UAAU;IACf,SAAS,cAAc;IACvB,EAAE,OAAO;IACT,QAAQ,aAAa;CACtB"}

package/dist/cjs/resources/filter-panel.interfaces.d.ts

@@ -1,8 +1,38 @@
 import { IFilterScope } from "./filter-scopes.resources";
 import { IFilter } from "./filters.resources";
 export interface IFilterPanelInteractiveTable {
-    datasets: IFilterPanelInteractiveDatasetTable[];
-    scopes: IFilterPanelInteractiveScopeTable[];
+    /**
+     * Collection of the interactivity Datasets settings
+     */
+    interactDatasets?: IFilterPanelInteractiveDatasetTable[];
+    /**
+     * Collection of the interactivity Scope settings
+     */
+    interactScopes?: IFilterPanelInteractiveScopeTable[];
+    /**
+     * Scopes Settings
+     */
+    scopesSettings?: IFilterPanelInteractiveScopeSetting[];
+    /**
+     * Displays/Hides the panel (Interact)
+     */
+    displayed?: boolean;
+    /**
+     * Collapses/Expands the Panel
+     */
+    collapsed?: boolean;
+    /**
+     * Allows to display the related color for each scope
+     */
+    colorized?: boolean;
+    /**
+     * The Panel Default View (Interact)
+     */
+    defaultCollapsed?: boolean;
+    /**
+     * Displays/Hides the icons linked with each scope
+     */
+    iconsDisplayed?: boolean;
 }
 /**
  * Structure for the resulting conversion of the UI filter
@@ -12,16 +42,39 @@ export interface IFilterUIToFilter {
     interactiveTable?: IFilterPanelInteractiveTable;
 }
 interface IFilterPanelInteractiveGeneral {
+    /**
+     * Flag to collapse or expand the related section
+     */
     collapsed: boolean;
-    enabled: boolean;
-    displayed: boolean;
 }
 interface IFilterPanelInteractiveScopeTable extends IFilterPanelInteractiveGeneral {
+    /**
+     * The Scope ID
+     */
     scopeId?: string;
+    /**
+     * The Scope Type
+     */
     scope: IFilterScope;
 }
 interface IFilterPanelInteractiveDatasetTable extends IFilterPanelInteractiveScopeTable {
+    /**
+     * The Dataset ID
+     */
     datasetId: string;
 }
+/**
+ * Structure for a single scope settings
+ */
+interface IFilterPanelInteractiveScopeSetting {
+    /**
+     * Hexadecimal/Rgba/Name color to be applied in the scope
+     */
+    color?: string;
+    /**
+     * The Scope Type
+     */
+    scope: IFilterScope;
+}
 export {};
 //# sourceMappingURL=filter-panel.interfaces.d.ts.map

package/dist/cjs/resources/filter-panel.interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"filter-panel.interfaces.d.ts","sourceRoot":"","sources":["../../../src/resources/filter-panel.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,EAAE,mCAAmC,EAAE,CAAC;IAChD,MAAM,EAAE,iCAAiC,EAAE,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,gBAAgB,CAAC,EAAE,4BAA4B,CAAC;CACjD;AAED,UAAU,8BAA8B;IACtC,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,UAAU,iCACR,SAAQ,8BAA8B;IACtC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,YAAY,CAAC;CACrB;AAED,UAAU,mCACR,SAAQ,iCAAiC;IACzC,SAAS,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"filter-panel.interfaces.d.ts","sourceRoot":"","sources":["../../../src/resources/filter-panel.interfaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAE9C,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,gBAAgB,CAAC,EAAE,mCAAmC,EAAE,CAAC;IACzD;;OAEG;IACH,cAAc,CAAC,EAAE,iCAAiC,EAAE,CAAC;IACrD;;OAEG;IACH,cAAc,CAAC,EAAE,mCAAmC,EAAE,CAAC;IACvD;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,OAAO,EAAE,CAAC;IACnB,gBAAgB,CAAC,EAAE,4BAA4B,CAAC;CACjD;AAED,UAAU,8BAA8B;IACtC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,UAAU,iCACR,SAAQ,8BAA8B;IACtC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC;CACrB;AAED,UAAU,mCACR,SAAQ,iCAAiC;IACzC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,UAAU,mCAAmC;IAC3C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC;CACrB"}