@qrvey/filters 0.0.13 → 0.0.14

package/src/resources/filter-panel.interfaces.ts

@@ -2,8 +2,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;
 }
 
 /**
@@ -15,18 +45,42 @@ export interface IFilterUIToFilter {
 }
 
 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;
+}

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

@@ -17,14 +17,6 @@ interface IFilterVisualGeneral {
    * Flag to collapse
    */
   collapsed: boolean;
-  /**
-   * Flag to apply
-   */
-  enabled: boolean;
-  /**
-   * Flag to display
-   */
-  displayed: boolean;
 }
 
 /**

package/src/resources/filters.resources.ts

@@ -3,6 +3,7 @@ import { COLUMN, IAggregateType, IColumnType, IFUData } from "@qrvey/utils";
 import { IFilterGrouping } from "./filter-grouping.resources";
 import { IFilterLogic } from "./filter-logic.resources";
 import { FILTER_OPERATOR, IFilterOperator } from "./filter-operators.resources";
+import { IFilterPanelInteractiveTable } from "./filter-panel.interfaces";
 import { FILTER_SCOPE, IFilterScope } from "./filter-scopes.resources";
 import { FILTER_SECTION, IFilterSection } from "./filter-sections.resources";
 import {
@@ -130,6 +131,7 @@ export interface IFilterVersion<
 > {
   version: TVersionNumber;
   filters?: IFilterVersionMap[TVersionNumber];
+  settings?: IFilterPanelInteractiveTable;
 }
 
 /**

package/tests/mock/filters-adapter.mock.ts

@@ -277,7 +277,6 @@ export const __v3Filters1: IFilterVersion<FILTER_VERSION_TYPE.V3> = {
 export const __logicFilters1: IFilterVersion<FILTER_VERSION_TYPE.LOGIC> = {
   filters: [
     {
-      enabled: true,
       filters: [
         {
           expressions: [
@@ -340,8 +339,6 @@ export const __visualFilters1: IFilterVersion<FILTER_VERSION_TYPE.UI_3> = {
             collapsed: false,
             id: "D123",
             label: "Dataset 123",
-            displayed: true,
-            enabled: true,
             filters: [
               {
                 aggregateType: undefined,
@@ -411,8 +408,6 @@ export const __visualFilters1: IFilterVersion<FILTER_VERSION_TYPE.UI_3> = {
             collapsed: false,
             id: "D456",
             label: "Dataset 456",
-            displayed: true,
-            enabled: true,
             filters: [
               {
                 aggregateType: undefined,
@@ -458,8 +453,6 @@ export const __visualFilters1: IFilterVersion<FILTER_VERSION_TYPE.UI_3> = {
             ],
           },
         ],
-        displayed: true,
-        enabled: true,
         scope: FILTER_SCOPE.GLOBAL,
         id: undefined,
         section: FILTER_SECTION.ANYWHERE,

package/tests/mock/filters-interactive-table.mock.ts

@@ -2,62 +2,58 @@ import { IFilterPanelInteractiveTable } from "../../src/resources/filter-panel.i
 import { FILTER_SCOPE } from "../../src/resources/filter-scopes.resources";
 
 export const __interactiveTable1: IFilterPanelInteractiveTable = {
-  datasets: [
+  interactDatasets: [
     {
       datasetId: "D123",
       collapsed: false,
-      displayed: true,
-      enabled: true,
       scope: FILTER_SCOPE.GLOBAL,
     },
     {
       datasetId: "D456",
       collapsed: false,
-      displayed: true,
-      enabled: true,
       scope: FILTER_SCOPE.GLOBAL,
     },
   ],
-  scopes: [
+  interactScopes: [
     {
       collapsed: false,
-      displayed: true,
-      enabled: true,
       scope: FILTER_SCOPE.GLOBAL,
     },
   ],
+  collapsed: false,
+  colorized: true,
+  defaultCollapsed: false,
+  displayed: true,
+  iconsDisplayed: true,
 };
 
 export const __interactiveTable2: IFilterPanelInteractiveTable = {
-  datasets: [
+  interactDatasets: [
     {
       datasetId: "D123",
       collapsed: false,
-      displayed: true,
-      enabled: true,
       scope: FILTER_SCOPE.GLOBAL,
     },
     {
       datasetId: "D456",
       collapsed: false,
-      displayed: true,
-      enabled: true,
       scope: FILTER_SCOPE.PAGE,
     },
     {
       datasetId: "D789",
       collapsed: false,
-      displayed: true,
-      enabled: true,
       scope: FILTER_SCOPE.PAGE,
     },
   ],
-  scopes: [
+  interactScopes: [
     {
       collapsed: false,
-      displayed: true,
-      enabled: true,
       scope: FILTER_SCOPE.GLOBAL,
     },
   ],
+  collapsed: false,
+  colorized: true,
+  defaultCollapsed: false,
+  displayed: true,
+  iconsDisplayed: true,
 };