@sisense/sdk-data 1.24.0 → 1.26.0

package/dist/cjs/dimensional-model/filters/factory.js

@@ -19,11 +19,11 @@ const filters_js_1 = require("./filters.js");
  * ])
  * ```
  * @param filters - Filters to union. The filters must all be on the same attribute.
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function union(filters, guid) {
-    return new filters_js_1.LogicalAttributeFilter(filters, filters_js_1.LogicalOperators.Union, guid);
+function union(filters, config) {
+    return new filters_js_1.LogicalAttributeFilter(filters, filters_js_1.LogicalOperators.Union, config);
 }
 exports.union = union;
 /**
@@ -42,11 +42,11 @@ exports.union = union;
  * ])
  * ```
  * @param filters - Filters to intersect. The filters must all be on the same attribute.
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function intersection(filters, guid) {
-    return new filters_js_1.LogicalAttributeFilter(filters, filters_js_1.LogicalOperators.Intersection, guid);
+function intersection(filters, config) {
+    return new filters_js_1.LogicalAttributeFilter(filters, filters_js_1.LogicalOperators.Intersection, config);
 }
 exports.intersection = intersection;
 /**
@@ -71,12 +71,12 @@ exports.intersection = intersection;
  * ```
  * @param filter - Filter to exclude
  * @param input - Input filter to exclude from, on the same attribute. If not provided, the filter excludes from all items.
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter representing an exclusion of the given filter
  * from all attribute members or from the optional input filter
  */
-function exclude(filter, input, guid) {
-    return new filters_js_1.ExcludeFilter(filter, input, guid);
+function exclude(filter, input, config) {
+    return new filters_js_1.ExcludeFilter(filter, input, config);
 }
 exports.exclude = exclude;
 // TEXT / NUMERIC FILTERS
@@ -96,11 +96,11 @@ exports.exclude = exclude;
  * ```
  * @param attribute - Text attribute to filter on
  * @param value - Value to filter by
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function doesntContain(attribute, value, guid) {
-    return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.DoesntContain, value, guid);
+function doesntContain(attribute, value, config) {
+    return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.DoesntContain, value, config);
 }
 exports.doesntContain = doesntContain;
 /**
@@ -119,11 +119,11 @@ exports.doesntContain = doesntContain;
  * ```
  * @param attribute - Text attribute to filter on
  * @param value - Value to filter by
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function doesntEndWith(attribute, value, guid) {
-    return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.DoesntEndWith, value, guid);
+function doesntEndWith(attribute, value, config) {
+    return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.DoesntEndWith, value, config);
 }
 exports.doesntEndWith = doesntEndWith;
 /**
@@ -142,11 +142,11 @@ exports.doesntEndWith = doesntEndWith;
  * ```
  * @param attribute - Text attribute to filter on
  * @param value - Value to filter by
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function doesntStartWith(attribute, value, guid) {
-    return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.DoesntStartWith, value, guid);
+function doesntStartWith(attribute, value, config) {
+    return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.DoesntStartWith, value, config);
 }
 exports.doesntStartWith = doesntStartWith;
 /**
@@ -165,11 +165,11 @@ exports.doesntStartWith = doesntStartWith;
  * ```
  * @param attribute - Text attribute to filter on
  * @param value - Value to filter by
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function contains(attribute, value, guid) {
-    return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.Contains, value, guid);
+function contains(attribute, value, config) {
+    return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.Contains, value, config);
 }
 exports.contains = contains;
 /**
@@ -188,11 +188,11 @@ exports.contains = contains;
  * ```
  * @param attribute - Text attribute to filter on
  * @param value - Value to filter by
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function endsWith(attribute, value, guid) {
-    return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.EndsWith, value, guid);
+function endsWith(attribute, value, config) {
+    return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.EndsWith, value, config);
 }
 exports.endsWith = endsWith;
 /**
@@ -211,11 +211,11 @@ exports.endsWith = endsWith;
  * ```
  * @param attribute - Text attribute to filter on
  * @param value - Value to filter by
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function startsWith(attribute, value, guid) {
-    return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.StartsWith, value, guid);
+function startsWith(attribute, value, config) {
+    return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.StartsWith, value, config);
 }
 exports.startsWith = startsWith;
 /**
@@ -239,11 +239,11 @@ exports.startsWith = startsWith;
  * ```
  * @param attribute - Text attribute to filter on
  * @param value - Value to filter by
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function like(attribute, value, guid) {
-    return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.Like, value, guid);
+function like(attribute, value, config) {
+    return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.Like, value, config);
 }
 exports.like = like;
 /**
@@ -262,14 +262,15 @@ exports.like = like;
  * ```
  * @param attribute - Text or numeric attribute to filter on
  * @param value - Value to filter by
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function doesntEqual(attribute, value, guid) {
+function doesntEqual(attribute, value, config) {
     if (typeof value === 'string') {
-        return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.DoesntEqual, value, guid);
+        return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.DoesntEqual, value, config);
     }
     else {
-        return numeric(attribute, filters_js_1.NumericOperators.DoesntEqual, value, undefined, undefined, guid);
+        return numeric(attribute, filters_js_1.NumericOperators.DoesntEqual, value, undefined, undefined, config);
     }
 }
 exports.doesntEqual = doesntEqual;
@@ -289,15 +290,15 @@ exports.doesntEqual = doesntEqual;
  * ```
  * @param attribute - Text or numeric attribute to filter on
  * @param value - Value to filter by
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function equals(attribute, value, guid) {
+function equals(attribute, value, config) {
     if (typeof value === 'string') {
-        return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.Equals, value, guid);
+        return new filters_js_1.TextFilter(attribute, filters_js_1.TextOperators.Equals, value, config);
     }
     else {
-        return numeric(attribute, filters_js_1.NumericOperators.Equals, value, undefined, undefined, guid);
+        return numeric(attribute, filters_js_1.NumericOperators.Equals, value, undefined, undefined, config);
     }
 }
 exports.equals = equals;
@@ -311,11 +312,11 @@ exports.equals = equals;
  * ```
  * @param attribute - Numeric attribute to filter on
  * @param value - Value to filter by
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function greaterThan(attribute, value, guid) {
-    return numeric(attribute, filters_js_1.NumericOperators.FromNotEqual, value, undefined, undefined, guid);
+function greaterThan(attribute, value, config) {
+    return numeric(attribute, filters_js_1.NumericOperators.FromNotEqual, value, undefined, undefined, config);
 }
 exports.greaterThan = greaterThan;
 /**
@@ -328,11 +329,11 @@ exports.greaterThan = greaterThan;
  * ```
  * @param attribute - Numeric attribute to filter on
  * @param value - Value to filter by
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function greaterThanOrEqual(attribute, value, guid) {
-    return numeric(attribute, filters_js_1.NumericOperators.From, value, undefined, undefined, guid);
+function greaterThanOrEqual(attribute, value, config) {
+    return numeric(attribute, filters_js_1.NumericOperators.From, value, undefined, undefined, config);
 }
 exports.greaterThanOrEqual = greaterThanOrEqual;
 /**
@@ -345,11 +346,11 @@ exports.greaterThanOrEqual = greaterThanOrEqual;
  * ```
  * @param attribute - Numeric attribute to filter on
  * @param value - Value to filter by
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function lessThan(attribute, value, guid) {
-    return numeric(attribute, filters_js_1.NumericOperators.ToNotEqual, value, undefined, undefined, guid);
+function lessThan(attribute, value, config) {
+    return numeric(attribute, filters_js_1.NumericOperators.ToNotEqual, value, undefined, undefined, config);
 }
 exports.lessThan = lessThan;
 /**
@@ -362,11 +363,11 @@ exports.lessThan = lessThan;
  * ```
  * @param attribute - Numeric attribute to filter on
  * @param value - Value to filter by
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function lessThanOrEqual(attribute, value, guid) {
-    return numeric(attribute, filters_js_1.NumericOperators.To, value, undefined, undefined, guid);
+function lessThanOrEqual(attribute, value, config) {
+    return numeric(attribute, filters_js_1.NumericOperators.To, value, undefined, undefined, config);
 }
 exports.lessThanOrEqual = lessThanOrEqual;
 /**
@@ -380,11 +381,11 @@ exports.lessThanOrEqual = lessThanOrEqual;
  * @param attribute - Numeric attribute to filter on
  * @param valueA - Value to filter from
  * @param valueB - Value to filter to
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function between(attribute, valueA, valueB, guid) {
-    return numeric(attribute, filters_js_1.NumericOperators.From, valueA, filters_js_1.NumericOperators.To, valueB, guid);
+function between(attribute, valueA, valueB, config) {
+    return numeric(attribute, filters_js_1.NumericOperators.From, valueA, filters_js_1.NumericOperators.To, valueB, config);
 }
 exports.between = between;
 /**
@@ -398,11 +399,11 @@ exports.between = between;
  * @param attribute - Numeric attribute to filter on
  * @param valueA - Value to filter from
  * @param valueB - Value to filter to
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function betweenNotEqual(attribute, valueA, valueB, guid) {
-    return numeric(attribute, filters_js_1.NumericOperators.FromNotEqual, valueA, filters_js_1.NumericOperators.ToNotEqual, valueB, guid);
+function betweenNotEqual(attribute, valueA, valueB, config) {
+    return numeric(attribute, filters_js_1.NumericOperators.FromNotEqual, valueA, filters_js_1.NumericOperators.ToNotEqual, valueB, config);
 }
 exports.betweenNotEqual = betweenNotEqual;
 /**
@@ -425,11 +426,11 @@ exports.betweenNotEqual = betweenNotEqual;
  * @param valueA - First value
  * @param operatorB - Second operator
  * @param valueB - Second value
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A custom numeric filter of the given attribute
  */
-function numeric(attribute, operatorA, valueA, operatorB, valueB, guid) {
-    return new filters_js_1.NumericFilter(attribute, operatorA, valueA, operatorB, valueB, guid);
+function numeric(attribute, operatorA, valueA, operatorB, valueB, config) {
+    return new filters_js_1.NumericFilter(attribute, operatorA, valueA, operatorB, valueB, config);
 }
 exports.numeric = numeric;
 /**
@@ -445,16 +446,12 @@ exports.numeric = numeric;
  * ```
  * @param attribute - Attribute to filter on
  * @param members - Array of member values to filter by
- * @param excludeMembers - Whether selected members are for exclusion
- * @param guid - Optional GUID for the filter
- * @param deactivatedMembers - Array of deactivated member values
- * @param backgroundFilter - Optional background filter
- * @param multiSelection - Optional flag to disable multi-selection
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  * @shortDescription Creates filter on attribute to match certain string values
  */
-function members(attribute, members, excludeMembers, guid, deactivatedMembers, backgroundFilter, multiSelection) {
-    return new filters_js_1.MembersFilter(attribute, members, excludeMembers, guid, deactivatedMembers, backgroundFilter, multiSelection);
+function members(attribute, members, config) {
+    return new filters_js_1.MembersFilter(attribute, members, config);
 }
 exports.members = members;
 // DATE FILTERS
@@ -468,10 +465,11 @@ exports.members = members;
  * ```
  * @param level - Date {@link LevelAttribute} to filter on
  * @param from - Date or string representing the value to filter from
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function dateFrom(level, from, guid) {
-    return dateRange(level, from, undefined, guid);
+function dateFrom(level, from, config) {
+    return dateRange(level, from, undefined, config);
 }
 exports.dateFrom = dateFrom;
 /**
@@ -484,11 +482,11 @@ exports.dateFrom = dateFrom;
  * ```
  * @param level - Date {@link LevelAttribute} to filter on
  * @param to - Date or string representing the last member to filter to
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function dateTo(level, to, guid) {
-    return dateRange(level, undefined, to, guid);
+function dateTo(level, to, config) {
+    return dateRange(level, undefined, to, config);
 }
 exports.dateTo = dateTo;
 /**
@@ -502,11 +500,11 @@ exports.dateTo = dateTo;
  * @param level - Date {@link LevelAttribute} to filter on
  * @param from - Date or string representing the start member to filter from
  * @param to - Date or string representing the end member to filter to
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function dateRange(level, from, to, guid) {
-    return new filters_js_1.DateRangeFilter(level, from, to, guid);
+function dateRange(level, from, to, config) {
+    return new filters_js_1.DateRangeFilter(level, from, to, config);
 }
 exports.dateRange = dateRange;
 /**
@@ -538,11 +536,11 @@ exports.dateRange = dateRange;
  * Positive numbers skip forwards and negative numbers skip backwards (e.g. `-6` is 6 months backwards when `level` is a months level attribute)
  * @param count - Number of levels to include in the filter (e.g. `6` is 6 months when `level` is a months level attribute)
  * @param anchor - Date to filter from, defaults to the current day
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function dateRelative(level, offset, count, anchor, guid) {
-    return new filters_js_1.RelativeDateFilter(level, offset, count, undefined, anchor, guid);
+function dateRelative(level, offset, count, anchor, config) {
+    return new filters_js_1.RelativeDateFilter(level, offset, count, undefined, anchor, config);
 }
 exports.dateRelative = dateRelative;
 /**
@@ -558,11 +556,11 @@ exports.dateRelative = dateRelative;
  * @param offset - Number of levels to skip from the given `anchor` or the default of the current day (e.g. `6` is 6 months when `level` is a months level attribute)
  * @param count - Number of levels to include in the filter (e.g. `6` is 6 months when `level` is a months level attribute)
  * @param anchor - Date to filter from, defaults to the current day
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function dateRelativeFrom(level, offset, count, anchor, guid) {
-    return new filters_js_1.RelativeDateFilter(level, offset, count, filters_js_1.DateOperators.Next, anchor, guid);
+function dateRelativeFrom(level, offset, count, anchor, config) {
+    return new filters_js_1.RelativeDateFilter(level, offset, count, filters_js_1.DateOperators.Next, anchor, config);
 }
 exports.dateRelativeFrom = dateRelativeFrom;
 /**
@@ -578,11 +576,11 @@ exports.dateRelativeFrom = dateRelativeFrom;
  * @param offset - Number of levels to skip from the given `anchor` or the default of the current day (e.g. `6` is 6 months when `level` is a months level attribute)
  * @param count - Number of levels to include in the filter (e.g. `6` is 6 months when `level` is a months level attribute)
  * @param anchor - Date to filter to, defaults to the current day
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function dateRelativeTo(level, offset, count, anchor, guid) {
-    return new filters_js_1.RelativeDateFilter(level, offset, count, filters_js_1.DateOperators.Last, anchor, guid);
+function dateRelativeTo(level, offset, count, anchor, config) {
+    return new filters_js_1.RelativeDateFilter(level, offset, count, filters_js_1.DateOperators.Last, anchor, config);
 }
 exports.dateRelativeTo = dateRelativeTo;
 /**
@@ -594,11 +592,11 @@ exports.dateRelativeTo = dateRelativeTo;
  * filterFactory.thisYear(DM.Commerce.Date)
  * ```
  * @param dimension - Date dimension to filter
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function thisYear(dimension, guid) {
-    return dateRelativeTo(dimension.Years, 0, 1, undefined, guid);
+function thisYear(dimension, config) {
+    return dateRelativeTo(dimension.Years, 0, 1, undefined, config);
 }
 exports.thisYear = thisYear;
 /**
@@ -610,11 +608,11 @@ exports.thisYear = thisYear;
  * filterFactory.thisMonth(DM.Commerce.Date)
  * ```
  * @param dimension - Date dimension to filter
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function thisMonth(dimension, guid) {
-    return dateRelativeTo(dimension.Months, 0, 1, undefined, guid);
+function thisMonth(dimension, config) {
+    return dateRelativeTo(dimension.Months, 0, 1, undefined, config);
 }
 exports.thisMonth = thisMonth;
 /**
@@ -626,11 +624,11 @@ exports.thisMonth = thisMonth;
  * filterFactory.thisQuarter(DM.Commerce.Date)
  * ```
  * @param dimension - Date dimension to filter
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function thisQuarter(dimension, guid) {
-    return dateRelativeTo(dimension.Quarters, 0, 1, undefined, guid);
+function thisQuarter(dimension, config) {
+    return dateRelativeTo(dimension.Quarters, 0, 1, undefined, config);
 }
 exports.thisQuarter = thisQuarter;
 /**
@@ -642,11 +640,11 @@ exports.thisQuarter = thisQuarter;
  * filterFactory.today(DM.Commerce.Date)
  * ```
  * @param dimension - date dimension to filter
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function today(dimension, guid) {
-    return dateRelativeTo(dimension.Days, 0, 1, undefined, guid);
+function today(dimension, config) {
+    return dateRelativeTo(dimension.Days, 0, 1, undefined, config);
 }
 exports.today = today;
 // MEASURE-RELATED FILTERS
@@ -659,12 +657,12 @@ exports.today = today;
  * @param valueA - First value
  * @param operatorB - Operator to apply on `valueB` ({@link NumericOperators})
  * @param valueB - Second value
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter representing the provided logic
  * @internal
  */
-function measureBase(attribute, measure, operatorA, valueA, operatorB, valueB, guid) {
-    return new filters_js_1.MeasureFilter(attribute, measure, operatorA, valueA, operatorB, valueB, guid);
+function measureBase(attribute, measure, operatorA, valueA, operatorB, valueB, config) {
+    return new filters_js_1.MeasureFilter(attribute, measure, operatorA, valueA, operatorB, valueB, config);
 }
 exports.measureBase = measureBase;
 /**
@@ -680,11 +678,11 @@ exports.measureBase = measureBase;
  * ```
  * @param measure - Measure to filter by
  * @param value - Value
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function measureEquals(measure, value, guid) {
-    return measureBase(measure.attribute, measure, filters_js_1.NumericOperators.Equals, value, undefined, undefined, guid);
+function measureEquals(measure, value, config) {
+    return measureBase(measure.attribute, measure, filters_js_1.NumericOperators.Equals, value, undefined, undefined, config);
 }
 exports.measureEquals = measureEquals;
 /**
@@ -701,11 +699,11 @@ exports.measureEquals = measureEquals;
  * ```
  * @param measure - Measure to filter by
  * @param value - Min value
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function measureGreaterThan(measure, value, guid) {
-    return measureBase(measure.attribute, measure, filters_js_1.NumericOperators.FromNotEqual, value, undefined, undefined, guid);
+function measureGreaterThan(measure, value, config) {
+    return measureBase(measure.attribute, measure, filters_js_1.NumericOperators.FromNotEqual, value, undefined, undefined, config);
 }
 exports.measureGreaterThan = measureGreaterThan;
 /**
@@ -722,11 +720,11 @@ exports.measureGreaterThan = measureGreaterThan;
  * ```
  * @param measure - Measure to filter by
  * @param value - Min value
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function measureGreaterThanOrEqual(measure, value, guid) {
-    return measureBase(measure.attribute, measure, filters_js_1.NumericOperators.From, value, undefined, undefined, guid);
+function measureGreaterThanOrEqual(measure, value, config) {
+    return measureBase(measure.attribute, measure, filters_js_1.NumericOperators.From, value, undefined, undefined, config);
 }
 exports.measureGreaterThanOrEqual = measureGreaterThanOrEqual;
 /**
@@ -743,11 +741,11 @@ exports.measureGreaterThanOrEqual = measureGreaterThanOrEqual;
  * ```
  * @param measure - Measure to filter by
  * @param value - Max value
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function measureLessThanOrEqual(measure, value, guid) {
-    return measureBase(measure.attribute, measure, filters_js_1.NumericOperators.To, value, undefined, undefined, guid);
+function measureLessThanOrEqual(measure, value, config) {
+    return measureBase(measure.attribute, measure, filters_js_1.NumericOperators.To, value, undefined, undefined, config);
 }
 exports.measureLessThanOrEqual = measureLessThanOrEqual;
 /**
@@ -763,11 +761,11 @@ exports.measureLessThanOrEqual = measureLessThanOrEqual;
  * ```
  * @param measure - Measure to filter by
  * @param value - Value
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function measureLessThan(measure, value, guid) {
-    return measureBase(measure.attribute, measure, filters_js_1.NumericOperators.ToNotEqual, value, undefined, undefined, guid);
+function measureLessThan(measure, value, config) {
+    return measureBase(measure.attribute, measure, filters_js_1.NumericOperators.ToNotEqual, value, undefined, undefined, config);
 }
 exports.measureLessThan = measureLessThan;
 /**
@@ -786,11 +784,11 @@ exports.measureLessThan = measureLessThan;
  * @param measure - Measure to filter by
  * @param valueA - Min value
  * @param valueB - Max value
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function measureBetween(measure, valueA, valueB, guid) {
-    return measureBase(measure.attribute, measure, filters_js_1.NumericOperators.From, valueA, filters_js_1.NumericOperators.To, valueB, guid);
+function measureBetween(measure, valueA, valueB, config) {
+    return measureBase(measure.attribute, measure, filters_js_1.NumericOperators.From, valueA, filters_js_1.NumericOperators.To, valueB, config);
 }
 exports.measureBetween = measureBetween;
 /**
@@ -809,11 +807,11 @@ exports.measureBetween = measureBetween;
  * @param measure - Measure to filter by
  * @param valueA - Min value
  * @param valueB - Max value
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function measureBetweenNotEqual(measure, valueA, valueB, guid) {
-    return measureBase(measure.attribute, measure, filters_js_1.NumericOperators.FromNotEqual, valueA, filters_js_1.NumericOperators.ToNotEqual, valueB, guid);
+function measureBetweenNotEqual(measure, valueA, valueB, config) {
+    return measureBase(measure.attribute, measure, filters_js_1.NumericOperators.FromNotEqual, valueA, filters_js_1.NumericOperators.ToNotEqual, valueB, config);
 }
 exports.measureBetweenNotEqual = measureBetweenNotEqual;
 // RANKING FILTERS
@@ -832,11 +830,11 @@ exports.measureBetweenNotEqual = measureBetweenNotEqual;
  * @param attribute - Attribute to filter
  * @param measure - Measure to filter by
  * @param count - Number of members to return
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function topRanking(attribute, measure, count, guid) {
-    return new filters_js_1.RankingFilter(attribute, measure, filters_js_1.RankingOperators.Top, count, guid);
+function topRanking(attribute, measure, count, config) {
+    return new filters_js_1.RankingFilter(attribute, measure, filters_js_1.RankingOperators.Top, count, config);
 }
 exports.topRanking = topRanking;
 /**
@@ -854,11 +852,11 @@ exports.topRanking = topRanking;
  * @param attribute - Attribute to filter
  * @param measure - Measure to filter by
  * @param count - Number of members to return
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-function bottomRanking(attribute, measure, count, guid) {
-    return new filters_js_1.RankingFilter(attribute, measure, filters_js_1.RankingOperators.Bottom, count, guid);
+function bottomRanking(attribute, measure, count, config) {
+    return new filters_js_1.RankingFilter(attribute, measure, filters_js_1.RankingOperators.Bottom, count, config);
 }
 exports.bottomRanking = bottomRanking;
 const relate = (node) => {
@@ -955,12 +953,13 @@ var logic;
 /**
  * Creates a filter from JAQL
  *
+ * @param attribute - Attribute to filter
  * @param jaql - Filter Jaql
- * @param guid - Optional GUID for the filter
+ * @param config - Optional configuration for the filter
  * @returns A filter instance
  * @internal
  */
-function customFilter(attribute, jaql, guid) {
-    return new filters_js_1.CustomFilter(attribute, jaql, guid);
+function customFilter(attribute, jaql, config) {
+    return new filters_js_1.CustomFilter(attribute, jaql, config);
 }
 exports.customFilter = customFilter;

package/dist/cjs/dimensional-model/filters/filter-config-utils.d.ts

@@ -0,0 +1,25 @@
+import { BaseFilterConfig, CompleteBaseFilterConfig, CompleteMembersFilterConfig, MembersFilterConfig } from '../interfaces.js';
+/**
+ * Returns a default configuration for a base filter.
+ * @internal
+ */
+export declare const getDefaultBaseFilterConfig: () => CompleteBaseFilterConfig;
+/**
+ * Returns a default configuration for a members filter.
+ * @internal
+ */
+export declare const getDefaultMembersFilterConfig: () => CompleteMembersFilterConfig;
+/**
+ * Checks whether the given configuration is a members filter configuration.
+ * @param config - The filter configuration.
+ * @returns Whether the configuration is a members filter configuration.
+ * @internal
+ */
+export declare function isMembersFilterConfig(config: BaseFilterConfig | MembersFilterConfig): config is MembersFilterConfig;
+/**
+ * Simplifies the filter configuration by removing default values.
+ * @param config - The filter configuration.
+ * @returns The simplified filter configuration.
+ * @internal
+ */
+export declare const simplifyFilterConfig: (config: BaseFilterConfig | MembersFilterConfig) => BaseFilterConfig | MembersFilterConfig;