@sisense/sdk-data 1.11.0 → 1.12.0

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

@@ -17,10 +17,11 @@ import { createGenericFilter } from './utils/filter-from-jaql-util.js';
  * ])
  * ```
  * @param filters - Filters to union. The filters must all be on the same attribute.
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function union(filters) {
-    return new LogicalAttributeFilter(filters, LogicalOperators.Union);
+export function union(filters, guid) {
+    return new LogicalAttributeFilter(filters, LogicalOperators.Union, guid);
 }
 /**
  * Creates a filter representing the intersection of multiple filters on the same attribute. The resulting
@@ -38,10 +39,11 @@ export function union(filters) {
  * ])
  * ```
  * @param filters - Filters to intersect. The filters must all be on the same attribute.
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function intersection(filters) {
-    return new LogicalAttributeFilter(filters, LogicalOperators.Intersection);
+export function intersection(filters, guid) {
+    return new LogicalAttributeFilter(filters, LogicalOperators.Intersection, guid);
 }
 /**
  * Creates a filter that excludes items matching the given filter
@@ -65,11 +67,12 @@ export function intersection(filters) {
  * ```
  * @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
  * @returns A filter representing an exclusion of the given filter
  * from all attribute members or from the optional input filter
  */
-export function exclude(filter, input) {
-    return new ExcludeFilter(filter, input);
+export function exclude(filter, input, guid) {
+    return new ExcludeFilter(filter, input, guid);
 }
 // TEXT / NUMERIC FILTERS
 /**
@@ -88,10 +91,11 @@ export function exclude(filter, input) {
  * ```
  * @param attribute - Text attribute to filter on
  * @param value - Value to filter by
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function doesntContain(attribute, value) {
-    return new TextFilter(attribute, TextOperators.DoesntContain, value);
+export function doesntContain(attribute, value, guid) {
+    return new TextFilter(attribute, TextOperators.DoesntContain, value, guid);
 }
 /**
  * Creates a filter to isolate attribute values that do not end with a specified string.
@@ -109,10 +113,11 @@ export function doesntContain(attribute, value) {
  * ```
  * @param attribute - Text attribute to filter on
  * @param value - Value to filter by
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function doesntEndWith(attribute, value) {
-    return new TextFilter(attribute, TextOperators.DoesntEndWith, value);
+export function doesntEndWith(attribute, value, guid) {
+    return new TextFilter(attribute, TextOperators.DoesntEndWith, value, guid);
 }
 /**
  * Creates a filter to isolate attribute values that do not start with a specified string.
@@ -130,10 +135,11 @@ export function doesntEndWith(attribute, value) {
  * ```
  * @param attribute - Text attribute to filter on
  * @param value - Value to filter by
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function doesntStartWith(attribute, value) {
-    return new TextFilter(attribute, TextOperators.DoesntStartWith, value);
+export function doesntStartWith(attribute, value, guid) {
+    return new TextFilter(attribute, TextOperators.DoesntStartWith, value, guid);
 }
 /**
  * Creates a filter to isolate attribute values that contain a specified string.
@@ -151,10 +157,11 @@ export function doesntStartWith(attribute, value) {
  * ```
  * @param attribute - Text attribute to filter on
  * @param value - Value to filter by
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function contains(attribute, value) {
-    return new TextFilter(attribute, TextOperators.Contains, value);
+export function contains(attribute, value, guid) {
+    return new TextFilter(attribute, TextOperators.Contains, value, guid);
 }
 /**
  * Creates a filter to isolate attribute values that end with a specified string.
@@ -172,10 +179,11 @@ export function contains(attribute, value) {
  * ```
  * @param attribute - Text attribute to filter on
  * @param value - Value to filter by
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function endsWith(attribute, value) {
-    return new TextFilter(attribute, TextOperators.EndsWith, value);
+export function endsWith(attribute, value, guid) {
+    return new TextFilter(attribute, TextOperators.EndsWith, value, guid);
 }
 /**
  * Creates a filter to isolate attribute values that start with a specified string.
@@ -193,10 +201,11 @@ export function endsWith(attribute, value) {
  * ```
  * @param attribute - Text attribute to filter on
  * @param value - Value to filter by
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function startsWith(attribute, value) {
-    return new TextFilter(attribute, TextOperators.StartsWith, value);
+export function startsWith(attribute, value, guid) {
+    return new TextFilter(attribute, TextOperators.StartsWith, value, guid);
 }
 /**
  * Creates a filter to isolate attribute values that match a specified string pattern.
@@ -219,10 +228,11 @@ export function startsWith(attribute, value) {
  * ```
  * @param attribute - Text attribute to filter on
  * @param value - Value to filter by
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function like(attribute, value) {
-    return new TextFilter(attribute, TextOperators.Like, value);
+export function like(attribute, value, guid) {
+    return new TextFilter(attribute, TextOperators.Like, value, guid);
 }
 /**
  * Creates a filter to isolate attribute values that do not equal a specified string or number.
@@ -242,12 +252,12 @@ export function like(attribute, value) {
  * @param value - Value to filter by
  * @returns A filter instance
  */
-export function doesntEqual(attribute, value) {
+export function doesntEqual(attribute, value, guid) {
     if (typeof value === 'string') {
-        return new TextFilter(attribute, TextOperators.DoesntEqual, value);
+        return new TextFilter(attribute, TextOperators.DoesntEqual, value, guid);
     }
     else {
-        return numeric(attribute, NumericOperators.DoesntEqual, value);
+        return numeric(attribute, NumericOperators.DoesntEqual, value, undefined, undefined, guid);
     }
 }
 /**
@@ -266,14 +276,15 @@ export function doesntEqual(attribute, value) {
  * ```
  * @param attribute - Text or numeric attribute to filter on
  * @param value - Value to filter by
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function equals(attribute, value) {
+export function equals(attribute, value, guid) {
     if (typeof value === 'string') {
-        return new TextFilter(attribute, TextOperators.Equals, value);
+        return new TextFilter(attribute, TextOperators.Equals, value, guid);
     }
     else {
-        return numeric(attribute, NumericOperators.Equals, value);
+        return numeric(attribute, NumericOperators.Equals, value, undefined, undefined, guid);
     }
 }
 /**
@@ -286,10 +297,11 @@ export function equals(attribute, value) {
  * ```
  * @param attribute - Numeric attribute to filter on
  * @param value - Value to filter by
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function greaterThan(attribute, value) {
-    return numeric(attribute, NumericOperators.FromNotEqual, value);
+export function greaterThan(attribute, value, guid) {
+    return numeric(attribute, NumericOperators.FromNotEqual, value, undefined, undefined, guid);
 }
 /**
  * Creates a filter to isolate attribute values greater than or equal to a specified number.
@@ -301,10 +313,11 @@ export function greaterThan(attribute, value) {
  * ```
  * @param attribute - Numeric attribute to filter on
  * @param value - Value to filter by
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function greaterThanOrEqual(attribute, value) {
-    return numeric(attribute, NumericOperators.From, value);
+export function greaterThanOrEqual(attribute, value, guid) {
+    return numeric(attribute, NumericOperators.From, value, undefined, undefined, guid);
 }
 /**
  * Creates a filter to isolate attribute values strictly less than a specified number.
@@ -316,10 +329,11 @@ export function greaterThanOrEqual(attribute, value) {
  * ```
  * @param attribute - Numeric attribute to filter on
  * @param value - Value to filter by
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function lessThan(attribute, value) {
-    return numeric(attribute, NumericOperators.ToNotEqual, value);
+export function lessThan(attribute, value, guid) {
+    return numeric(attribute, NumericOperators.ToNotEqual, value, undefined, undefined, guid);
 }
 /**
  * Creates a filter to isolate attribute values less than or equal to a specified number.
@@ -331,10 +345,11 @@ export function lessThan(attribute, value) {
  * ```
  * @param attribute - Numeric attribute to filter on
  * @param value - Value to filter by
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function lessThanOrEqual(attribute, value) {
-    return numeric(attribute, NumericOperators.To, value);
+export function lessThanOrEqual(attribute, value, guid) {
+    return numeric(attribute, NumericOperators.To, value, undefined, undefined, guid);
 }
 /**
  * Creates a filter to isolate attribute values within or exactly matching two specified numerical boundaries.
@@ -347,10 +362,11 @@ export function lessThanOrEqual(attribute, value) {
  * @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
  * @returns A filter instance
  */
-export function between(attribute, valueA, valueB) {
-    return numeric(attribute, NumericOperators.From, valueA, NumericOperators.To, valueB);
+export function between(attribute, valueA, valueB, guid) {
+    return numeric(attribute, NumericOperators.From, valueA, NumericOperators.To, valueB, guid);
 }
 /**
  * Creates a filter that isolates attribute values strictly within two specified numerical boundaries.
@@ -363,10 +379,11 @@ export function between(attribute, valueA, valueB) {
  * @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
  * @returns A filter instance
  */
-export function betweenNotEqual(attribute, valueA, valueB) {
-    return numeric(attribute, NumericOperators.FromNotEqual, valueA, NumericOperators.ToNotEqual, valueB);
+export function betweenNotEqual(attribute, valueA, valueB, guid) {
+    return numeric(attribute, NumericOperators.FromNotEqual, valueA, NumericOperators.ToNotEqual, valueB, guid);
 }
 /**
  * Creates a custom numeric filter that filters for given attribute values.
@@ -388,10 +405,11 @@ export function betweenNotEqual(attribute, valueA, valueB) {
  * @param valueA - First value
  * @param operatorB - Second operator
  * @param valueB - Second value
+ * @param guid - Optional GUID for the filter
  * @returns A custom numeric filter of the given attribute
  */
-export function numeric(attribute, operatorA, valueA, operatorB, valueB) {
-    return new NumericFilter(attribute, operatorA, valueA, operatorB, valueB);
+export function numeric(attribute, operatorA, valueA, operatorB, valueB, guid) {
+    return new NumericFilter(attribute, operatorA, valueA, operatorB, valueB, guid);
 }
 /**
  * Creates a filter to isolate attribute values that match any of the specified strings.
@@ -406,10 +424,11 @@ export function numeric(attribute, operatorA, valueA, operatorB, valueB) {
  * ```
  * @param attribute - Attribute to filter on
  * @param members - Array of member values to filter by
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function members(attribute, members) {
-    return new MembersFilter(attribute, members);
+export function members(attribute, members, guid) {
+    return new MembersFilter(attribute, members, guid);
 }
 // DATE FILTERS
 /**
@@ -424,8 +443,8 @@ export function members(attribute, members) {
  * @param from - Date or string representing the value to filter from
  * @returns A filter instance
  */
-export function dateFrom(level, from) {
-    return dateRange(level, from, undefined);
+export function dateFrom(level, from, guid) {
+    return dateRange(level, from, undefined, guid);
 }
 /**
  * Creates a filter to isolate items up until and including the given date and level.
@@ -437,10 +456,11 @@ export function dateFrom(level, from) {
  * ```
  * @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
  * @returns A filter instance
  */
-export function dateTo(level, to) {
-    return dateRange(level, undefined, to);
+export function dateTo(level, to, guid) {
+    return dateRange(level, undefined, to, guid);
 }
 /**
  * Creates a filter to isolate items between and including the given dates and level.
@@ -453,10 +473,11 @@ export function dateTo(level, to) {
  * @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
  * @returns A filter instance
  */
-export function dateRange(level, from, to) {
-    return new DateRangeFilter(level, from, to);
+export function dateRange(level, from, to, guid) {
+    return new DateRangeFilter(level, from, to, guid);
 }
 /**
  * Creates a filter to isolate items with a date dimension value within a specified range after a
@@ -487,10 +508,11 @@ export function dateRange(level, from, to) {
  * 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
  * @returns A filter instance
  */
-export function dateRelative(level, offset, count, anchor) {
-    return new RelativeDateFilter(level, offset, count, undefined, anchor);
+export function dateRelative(level, offset, count, anchor, guid) {
+    return new RelativeDateFilter(level, offset, count, undefined, anchor, guid);
 }
 /**
  * Creates a filter to isolate items with a date dimension value within a specified range after a
@@ -505,10 +527,11 @@ export function dateRelative(level, offset, count, anchor) {
  * @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
  * @returns A filter instance
  */
-export function dateRelativeFrom(level, offset, count, anchor) {
-    return new RelativeDateFilter(level, offset, count, DateOperators.Next, anchor);
+export function dateRelativeFrom(level, offset, count, anchor, guid) {
+    return new RelativeDateFilter(level, offset, count, DateOperators.Next, anchor, guid);
 }
 /**
  * Creates a filter to isolate items with a date dimension value within a specified range before a
@@ -523,10 +546,11 @@ export function dateRelativeFrom(level, offset, count, anchor) {
  * @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
  * @returns A filter instance
  */
-export function dateRelativeTo(level, offset, count, anchor) {
-    return new RelativeDateFilter(level, offset, count, DateOperators.Last, anchor);
+export function dateRelativeTo(level, offset, count, anchor, guid) {
+    return new RelativeDateFilter(level, offset, count, DateOperators.Last, anchor, guid);
 }
 /**
  * Creates a filter to isolate items with a date dimension value in the current calendar year.
@@ -537,10 +561,11 @@ export function dateRelativeTo(level, offset, count, anchor) {
  * filterFactory.thisYear(DM.Commerce.Date)
  * ```
  * @param dimension - Date dimension to filter
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function thisYear(dimension) {
-    return dateRelativeTo(dimension.Years, 0, 1);
+export function thisYear(dimension, guid) {
+    return dateRelativeTo(dimension.Years, 0, 1, undefined, guid);
 }
 /**
  * Creates a filter to isolate items with a date dimension value in the current calendar month.
@@ -551,10 +576,11 @@ export function thisYear(dimension) {
  * filterFactory.thisMonth(DM.Commerce.Date)
  * ```
  * @param dimension - Date dimension to filter
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function thisMonth(dimension) {
-    return dateRelativeTo(dimension.Months, 0, 1);
+export function thisMonth(dimension, guid) {
+    return dateRelativeTo(dimension.Months, 0, 1, undefined, guid);
 }
 /**
  * Creates a filter to isolate items with a date dimension value in the current quarter.
@@ -565,10 +591,11 @@ export function thisMonth(dimension) {
  * filterFactory.thisQuarter(DM.Commerce.Date)
  * ```
  * @param dimension - Date dimension to filter
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function thisQuarter(dimension) {
-    return dateRelativeTo(dimension.Quarters, 0, 1);
+export function thisQuarter(dimension, guid) {
+    return dateRelativeTo(dimension.Quarters, 0, 1, undefined, guid);
 }
 /**
  * Creates a filter to isolate items with a date dimension value of the current date.
@@ -579,10 +606,11 @@ export function thisQuarter(dimension) {
  * filterFactory.today(DM.Commerce.Date)
  * ```
  * @param dimension - date dimension to filter
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function today(dimension) {
-    return dateRelativeTo(dimension.Days, 0, 1);
+export function today(dimension, guid) {
+    return dateRelativeTo(dimension.Days, 0, 1, undefined, guid);
 }
 // MEASURE-RELATED FILTERS
 /**
@@ -594,11 +622,12 @@ export function today(dimension) {
  * @param valueA - First value
  * @param operatorB - Operator to apply on `valueB` ({@link NumericOperators})
  * @param valueB - Second value
+ * @param guid - Optional GUID for the filter
  * @returns A filter representing the provided logic
  * @internal
  */
-export function measureBase(attribute, measure, operatorA, valueA, operatorB, valueB) {
-    return new MeasureFilter(attribute, measure, operatorA, valueA, operatorB, valueB);
+export function measureBase(attribute, measure, operatorA, valueA, operatorB, valueB, guid) {
+    return new MeasureFilter(attribute, measure, operatorA, valueA, operatorB, valueB, guid);
 }
 /**
  * Creates a filter to isolate a measure value equal to a given number.
@@ -613,10 +642,11 @@ export function measureBase(attribute, measure, operatorA, valueA, operatorB, va
  * ```
  * @param measure - Measure to filter by
  * @param value - Value
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function measureEquals(measure, value) {
-    return measureBase(measure.attribute, measure, NumericOperators.Equals, value);
+export function measureEquals(measure, value, guid) {
+    return measureBase(measure.attribute, measure, NumericOperators.Equals, value, undefined, undefined, guid);
 }
 /**
  * Creates a filter to isolate a measure value greater than to a given number.
@@ -632,10 +662,11 @@ export function measureEquals(measure, value) {
  * ```
  * @param measure - Measure to filter by
  * @param value - Min value
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function measureGreaterThan(measure, value) {
-    return measureBase(measure.attribute, measure, NumericOperators.FromNotEqual, value);
+export function measureGreaterThan(measure, value, guid) {
+    return measureBase(measure.attribute, measure, NumericOperators.FromNotEqual, value, undefined, undefined, guid);
 }
 /**
  * Creates a filter to isolate a measure value greater than or equal to a given number.
@@ -651,10 +682,11 @@ export function measureGreaterThan(measure, value) {
  * ```
  * @param measure - Measure to filter by
  * @param value - Min value
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function measureGreaterThanOrEqual(measure, value) {
-    return measureBase(measure.attribute, measure, NumericOperators.From, value);
+export function measureGreaterThanOrEqual(measure, value, guid) {
+    return measureBase(measure.attribute, measure, NumericOperators.From, value, undefined, undefined, guid);
 }
 /**
  * Creates a filter to isolate a measure value less than or equal to a given number.
@@ -670,10 +702,11 @@ export function measureGreaterThanOrEqual(measure, value) {
  * ```
  * @param measure - Measure to filter by
  * @param value - Max value
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function measureLessThanOrEqual(measure, value) {
-    return measureBase(measure.attribute, measure, NumericOperators.To, value);
+export function measureLessThanOrEqual(measure, value, guid) {
+    return measureBase(measure.attribute, measure, NumericOperators.To, value, undefined, undefined, guid);
 }
 /**
  * Creates a filter to isolate a measure value less than a given number.
@@ -688,10 +721,11 @@ export function measureLessThanOrEqual(measure, value) {
  * ```
  * @param measure - Measure to filter by
  * @param value - Value
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function measureLessThan(measure, value) {
-    return measureBase(measure.attribute, measure, NumericOperators.ToNotEqual, value);
+export function measureLessThan(measure, value, guid) {
+    return measureBase(measure.attribute, measure, NumericOperators.ToNotEqual, value, undefined, undefined, guid);
 }
 /**
  * Creates a filter to isolate a measure value between or equal to two given numbers.
@@ -709,10 +743,11 @@ export function measureLessThan(measure, value) {
  * @param measure - Measure to filter by
  * @param valueA - Min value
  * @param valueB - Max value
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function measureBetween(measure, valueA, valueB) {
-    return measureBase(measure.attribute, measure, NumericOperators.From, valueA, NumericOperators.To, valueB);
+export function measureBetween(measure, valueA, valueB, guid) {
+    return measureBase(measure.attribute, measure, NumericOperators.From, valueA, NumericOperators.To, valueB, guid);
 }
 /**
  * Creates a filter to isolate a measure value between but not equal to two given numbers.
@@ -730,10 +765,11 @@ export function measureBetween(measure, valueA, valueB) {
  * @param measure - Measure to filter by
  * @param valueA - Min value
  * @param valueB - Max value
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export function measureBetweenNotEqual(measure, valueA, valueB) {
-    return measureBase(measure.attribute, measure, NumericOperators.FromNotEqual, valueA, NumericOperators.ToNotEqual, valueB);
+export function measureBetweenNotEqual(measure, valueA, valueB, guid) {
+    return measureBase(measure.attribute, measure, NumericOperators.FromNotEqual, valueA, NumericOperators.ToNotEqual, valueB, guid);
 }
 // RANKING FILTERS
 /**
@@ -751,10 +787,11 @@ export function measureBetweenNotEqual(measure, valueA, valueB) {
  * @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
  * @returns A filter instance
  */
-export function topRanking(attribute, measure, count) {
-    return new RankingFilter(attribute, measure, RankingOperators.Top, count);
+export function topRanking(attribute, measure, count, guid) {
+    return new RankingFilter(attribute, measure, RankingOperators.Top, count, guid);
 }
 /**
  * Creates a filter to isolate items that rank towards the bottom for a given measure.
@@ -771,10 +808,11 @@ export function topRanking(attribute, measure, count) {
  * @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
  * @returns A filter instance
  */
-export function bottomRanking(attribute, measure, count) {
-    return new RankingFilter(attribute, measure, RankingOperators.Bottom, count);
+export function bottomRanking(attribute, measure, count, guid) {
+    return new RankingFilter(attribute, measure, RankingOperators.Bottom, count, guid);
 }
 const relate = (node) => {
     if (Array.isArray(node)) {
@@ -871,10 +909,10 @@ export var logic;
  * Creates a filter from JAQL
  *
  * @param jaql - Filter Jaql
- * @param instanceid - Filter instance id
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  * @internal
  */
-export function customFilter(jaql, instanceid) {
-    return createGenericFilter(jaql, instanceid);
+export function customFilter(jaql, guid) {
+    return createGenericFilter(jaql, guid);
 }