@qrvey/filters 0.0.13 → 0.0.15

package/src/helpers/filter-adapt.helpers.ts

@@ -1,23 +1,8 @@
-import {
-  IColumn,
-  IColumnPropertyType,
-  IDataset,
-  IFUData,
-  IFUDataset,
-  IFUFilter,
-  IFUScope,
-  IFValue,
-  isEmpty,
-} from "@qrvey/utils";
+import { IColumn, IDataset, isEmpty } from "@qrvey/utils";
 
 import { getColumnInfo, getDatasetInfo } from "./utils.helpers";
 
-import { FilterBuilder } from "../classes/FilterBuilder";
-import { IFilterGrouping } from "../resources/filter-grouping.resources";
 import { IFilterPanelInteractiveTable } from "../resources/filter-panel.interfaces";
-import { FILTER_SCOPE } from "../resources/filter-scopes.resources";
-import { FILTER_SECTION } from "../resources/filter-sections.resources";
-import { IFilterValue } from "../resources/filter-values.resources";
 import {
   DEFAULT_UI_FILTER,
   IFilterUI,
@@ -47,73 +32,47 @@ export function filterToVisual(
 }
 
 /**
- * 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
+ * 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 filterToLegacyVisual(
-  filters: IFilter[],
-  datasets: IDataset[] = [],
+export function legacyVisualToInteractiveTable(
+  visual: IFilterVisual,
   interactiveTable?: IFilterPanelInteractiveTable,
-): IFUData | undefined {
-  if (isEmpty(filters)) return;
+): IFilterPanelInteractiveTable | undefined {
+  if (isEmpty(visual) || isEmpty(visual?.scopes)) return;
 
-  return {
-    enabled: true,
-    section: FILTER_SECTION.DX,
-    version: "2.1",
-    scopes: buildLegacyScopes(filters, datasets, interactiveTable),
+  const newInteractiveTable: IFilterPanelInteractiveTable = {
+    interactScopes: [],
+    interactDatasets: [],
+    ...interactiveTable,
   };
-}
 
-/**
- * Generates a legacy visual filter structure from the filter collection.
- * @param filterData the legacy filter
- * @returns a Filter collection
- */
-export function legacyVisualToFilter(filterData: IFUData): IFilter[] {
-  if (isEmpty(filterData) || isEmpty(filterData?.scopes)) return [];
-
-  const filters: IFilter[] = [];
-
-  filterData.scopes.forEach((scope: IFUScope) => {
+  visual.scopes.forEach((scope: IFilterVisualScope) => {
+    newInteractiveTable.interactScopes!.push({
+      collapsed: scope.collapsed,
+      scope: scope.scope,
+      scopeId: scope.id,
+    });
     if (scope.datasets.length === 0) return;
-    scope.datasets.forEach((dataset: IFUDataset) => {
-      if (dataset.filters.length === 0) return;
-      dataset.filters.forEach((filter) => {
-        const fFilter = 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 as unknown as IFilterGrouping,
-          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 as unknown as IFilterValue[],
-        });
-
-        filters.push(fFilter);
+    scope.datasets.forEach((dataset: IFilterVisualDataset) => {
+      newInteractiveTable.interactDatasets!.push({
+        collapsed: scope.collapsed,
+        scope: scope.scope,
+        scopeId: scope.id,
+        datasetId: dataset.id,
       });
     });
   });
 
-  return filters;
+  if (isEmpty(newInteractiveTable.interactScopes))
+    delete newInteractiveTable.interactScopes;
+  if (isEmpty(newInteractiveTable.interactDatasets))
+    delete newInteractiveTable.interactDatasets;
+
+  return newInteractiveTable;
 }
 
 /**
@@ -179,8 +138,8 @@ function buildScope(
   filter: IFilter,
   interactiveTable?: IFilterPanelInteractiveTable,
 ): IFilterVisualScope {
-  const { collapsed, displayed, enabled } =
-    interactiveTable?.scopes.find(
+  const { collapsed } =
+    interactiveTable?.interactScopes?.find(
       (interactive) =>
         interactive.scope === filter.scope &&
         interactive.scopeId === filter.scopeId,
@@ -189,8 +148,6 @@ function buildScope(
   return {
     collapsed: collapsed ?? false,
     datasets: [],
-    displayed: displayed ?? true,
-    enabled: enabled ?? true,
     scope: filter.scope,
     id: filter.scopeId,
     section: filter.section,
@@ -209,16 +166,14 @@ function buildDataset(
   dataset?: IDataset,
   interactiveTable?: IFilterPanelInteractiveTable,
 ): IFilterVisualDataset {
-  const { collapsed, displayed, enabled } =
-    interactiveTable?.datasets.find(
+  const { collapsed } =
+    interactiveTable?.interactDatasets?.find(
       (interactive) => interactive.datasetId === filter.datasetId,
     ) ?? {};
   return {
     collapsed: collapsed ?? false,
     id: filter.datasetId,
     label: dataset?.label || "",
-    displayed: displayed ?? true,
-    enabled: enabled ?? true,
     filters: [],
   };
 }
@@ -247,164 +202,3 @@ function buildFilter(filter: IFilter, dataset?: IDataset): IFilterUI {
     iconTooltip: filter.iconTooltip ?? DEFAULT_UI_FILTER.iconTooltip,
   };
 }
-
-/**
- * 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: IFilter[] = [],
-  datasets: IDataset[] = [],
-  interactiveTable?: IFilterPanelInteractiveTable,
-): IFUScope[] {
-  return filters.reduce((scopes: IFUScope[], filter: IFilter) => {
-    const datasetInfo = getDatasetInfo(
-      { columnId: filter.columnId, datasetId: filter.datasetId },
-      datasets,
-    );
-
-    const uiFilter: IFUFilter = buildLegacyFilter(filter, datasetInfo);
-    const uiDataset: IFUDataset = buildLegacyDataset(
-      filter,
-      datasetInfo,
-      interactiveTable,
-    );
-    const uiScope: IFUScope = 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: IFilter,
-  interactiveTable?: IFilterPanelInteractiveTable,
-): IFUScope {
-  const { collapsed, displayed, enabled } =
-    interactiveTable?.scopes.find(
-      (interactive) =>
-        interactive.scope === filter.scope &&
-        interactive.scopeId === filter.scopeId,
-    ) ?? {};
-
-  return {
-    collapsed: collapsed ?? false,
-    datasets: [],
-    displayed: displayed ?? true,
-    enabled: 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: IFilter,
-  dataset?: IDataset,
-  interactiveTable?: IFilterPanelInteractiveTable,
-): IFUDataset {
-  const { collapsed, displayed, enabled } =
-    interactiveTable?.datasets.find(
-      (interactive) => interactive.datasetId === filter.datasetId,
-    ) ?? {};
-  return {
-    collapsed: collapsed ?? false,
-    qrveyid: filter.datasetId,
-    label: dataset?.label || "",
-    displayed: displayed ?? true,
-    enabled: 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: IFilter, dataset?: IDataset): IFUFilter {
-  const columnInfo: IColumn | undefined =
-    dataset == null
-      ? undefined
-      : 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: FILTER_SCOPE.CHART === filter.scope ? filter.scopeId : undefined,
-      info: !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 as unknown as IColumnPropertyType,
-    selectAll: filter.selectAll,
-    validator: filter.validator,
-    values: filter.values as unknown as IFValue[],
-  };
-}

package/src/helpers/filter-adapt.legacy.helpers.ts

@@ -0,0 +1,296 @@
+import {
+  FILTER_SCOPE,
+  FILTER_SECTION,
+  IColumn,
+  IColumnPropertyType,
+  IDataset,
+  IFUData,
+  IFUDataset,
+  IFUFilter,
+  IFUScope,
+  IFValue,
+  isEmpty,
+} from "@qrvey/utils";
+
+import { getColumnInfo, getDatasetInfo } from "./utils.helpers";
+
+import { FilterBuilder } from "../classes/FilterBuilder";
+import { IFilterGrouping } from "../resources/filter-grouping.resources";
+import { IFilterPanelInteractiveTable } from "../resources/filter-panel.interfaces";
+import { IFilterValue } from "../resources/filter-values.resources";
+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 function filterToLegacyVisual(
+  filters: IFilter[],
+  datasets: IDataset[] = [],
+  interactiveTable?: IFilterPanelInteractiveTable,
+): IFUData | undefined {
+  if (isEmpty(filters)) return;
+
+  return {
+    enabled: true,
+    section: FILTER_SECTION.DX,
+    version: "2.1",
+    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: IFUData): IFilter[] {
+  if (isEmpty(filterData) || isEmpty(filterData?.scopes)) return [];
+
+  const filters: IFilter[] = [];
+
+  filterData.scopes.forEach((scope: IFUScope) => {
+    if (scope.datasets.length === 0) return;
+    scope.datasets.forEach((dataset: IFUDataset) => {
+      if (dataset.filters.length === 0) return;
+      dataset.filters.forEach((filter) => {
+        const fFilter = 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 as unknown as IFilterGrouping,
+          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 as unknown as IFilterValue[],
+        });
+
+        filters.push(fFilter);
+      });
+    });
+  });
+
+  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: IFUData,
+  interactiveTable?: IFilterPanelInteractiveTable,
+): IFilterPanelInteractiveTable | undefined {
+  if (isEmpty(legacyVisual) || isEmpty(legacyVisual?.scopes)) return;
+
+  const newInteractiveTable: IFilterPanelInteractiveTable = {
+    ...interactiveTable,
+    interactScopes: [],
+    interactDatasets: [],
+  };
+
+  legacyVisual.scopes.forEach((scope: IFUScope) => {
+    newInteractiveTable.interactScopes!.push({
+      collapsed: scope.collapsed,
+      scope: scope.scope,
+      scopeId: scope.scopeid,
+    });
+    if (scope.datasets.length === 0) return;
+    scope.datasets.forEach((dataset: IFUDataset) => {
+      newInteractiveTable.interactDatasets!.push({
+        collapsed: dataset.collapsed,
+        scope: scope.scope,
+        scopeId: scope.scopeid,
+        datasetId: dataset.qrveyid,
+      });
+    });
+  });
+
+  if (isEmpty(newInteractiveTable.interactScopes))
+    delete newInteractiveTable.interactScopes;
+  if (isEmpty(newInteractiveTable.interactDatasets))
+    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: IFilter[] = [],
+  datasets: IDataset[] = [],
+  interactiveTable?: IFilterPanelInteractiveTable,
+): IFUScope[] {
+  return filters.reduce((scopes: IFUScope[], filter: IFilter) => {
+    const datasetInfo = getDatasetInfo(
+      { columnId: filter.columnId, datasetId: filter.datasetId },
+      datasets,
+    );
+
+    const uiFilter: IFUFilter = buildLegacyFilter(filter, datasetInfo);
+    const uiDataset: IFUDataset = buildLegacyDataset(
+      filter,
+      datasetInfo,
+      interactiveTable,
+    );
+    const uiScope: IFUScope = 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: IFilter,
+  interactiveTable?: IFilterPanelInteractiveTable,
+): IFUScope {
+  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: IFilter,
+  dataset?: IDataset,
+  interactiveTable?: IFilterPanelInteractiveTable,
+): IFUDataset {
+  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: IFilter, dataset?: IDataset): IFUFilter {
+  const columnInfo: IColumn | undefined =
+    dataset == null
+      ? undefined
+      : 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: FILTER_SCOPE.CHART === filter.scope ? filter.scopeId : undefined,
+      info: !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 as unknown as IColumnPropertyType,
+    selectAll: filter.selectAll,
+    validator: filter.validator,
+    values: filter.values as unknown as IFValue[],
+  };
+}

package/src/helpers/filter-adapt.logic.helpers.ts

@@ -91,7 +91,6 @@ export function visualToLogic(visual: IFilterVisual): IFilterLogic[] {
  */
 function buildLogic(scope: IFilterVisualScope): IFilterLogic {
   return {
-    enabled: scope.enabled,
     filters: [],
     scope: scope.scope,
     scopeid: scope.id,
@@ -102,6 +101,7 @@ function buildLogic(scope: IFilterVisualScope): IFilterLogic {
  * 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: IFilterUI[],

package/src/resources/filter-logic.resources.ts

@@ -9,10 +9,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
    */