@sisense/sdk-data 1.11.0 → 1.12.0

package/dist/dimensional-model/filters/factory.d.ts

@@ -15,9 +15,10 @@ import { DateDimension, LevelAttribute, Attribute, Measure, Filter, BaseMeasure,
  * ])
  * ```
  * @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 declare function union(filters: Filter[]): Filter;
+export declare function union(filters: Filter[], guid?: string): Filter;
 /**
  * Creates a filter representing the intersection of multiple filters on the same attribute. The resulting
  * intersection filter filters on items that match all of the given filters.
@@ -34,9 +35,10 @@ export declare function union(filters: Filter[]): Filter;
  * ])
  * ```
  * @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 declare function intersection(filters: Filter[]): Filter;
+export declare function intersection(filters: Filter[], guid?: string): Filter;
 /**
  * Creates a filter that excludes items matching the given filter
  * from all items or from items matching the optional input filter.
@@ -59,10 +61,11 @@ export declare function intersection(filters: Filter[]): Filter;
  * ```
  * @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 declare function exclude(filter: Filter, input?: Filter): Filter;
+export declare function exclude(filter: Filter, input?: Filter, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values that do not contain a specified string.
  *
@@ -79,9 +82,10 @@ export declare function exclude(filter: Filter, input?: Filter): Filter;
  * ```
  * @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 declare function doesntContain(attribute: Attribute, value: string): Filter;
+export declare function doesntContain(attribute: Attribute, value: string, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values that do not end with a specified string.
  *
@@ -98,9 +102,10 @@ export declare function doesntContain(attribute: Attribute, value: string): Filt
  * ```
  * @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 declare function doesntEndWith(attribute: Attribute, value: string): Filter;
+export declare function doesntEndWith(attribute: Attribute, value: string, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values that do not start with a specified string.
  *
@@ -117,9 +122,10 @@ export declare function doesntEndWith(attribute: Attribute, value: string): Filt
  * ```
  * @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 declare function doesntStartWith(attribute: Attribute, value: string): Filter;
+export declare function doesntStartWith(attribute: Attribute, value: string, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values that contain a specified string.
  *
@@ -136,9 +142,10 @@ export declare function doesntStartWith(attribute: Attribute, value: string): Fi
  * ```
  * @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 declare function contains(attribute: Attribute, value: string): Filter;
+export declare function contains(attribute: Attribute, value: string, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values that end with a specified string.
  *
@@ -155,9 +162,10 @@ export declare function contains(attribute: Attribute, value: string): Filter;
  * ```
  * @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 declare function endsWith(attribute: Attribute, value: string): Filter;
+export declare function endsWith(attribute: Attribute, value: string, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values that start with a specified string.
  *
@@ -174,9 +182,10 @@ export declare function endsWith(attribute: Attribute, value: string): Filter;
  * ```
  * @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 declare function startsWith(attribute: Attribute, value: string): Filter;
+export declare function startsWith(attribute: Attribute, value: string, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values that match a specified string pattern.
  *
@@ -198,9 +207,10 @@ export declare function startsWith(attribute: Attribute, value: string): Filter;
  * ```
  * @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 declare function like(attribute: Attribute, value: string): Filter;
+export declare function like(attribute: Attribute, value: string, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values that do not equal a specified string or number.
  *
@@ -219,7 +229,7 @@ export declare function like(attribute: Attribute, value: string): Filter;
  * @param value - Value to filter by
  * @returns A filter instance
  */
-export declare function doesntEqual(attribute: Attribute, value: string | number): Filter;
+export declare function doesntEqual(attribute: Attribute, value: string | number, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values that equal a specified string or number.
  *
@@ -236,9 +246,10 @@ export declare function doesntEqual(attribute: Attribute, value: string | number
  * ```
  * @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 declare function equals(attribute: Attribute, value: string | number): Filter;
+export declare function equals(attribute: Attribute, value: string | number, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values strictly greater than a specified number.
  *
@@ -249,9 +260,10 @@ export declare function equals(attribute: Attribute, value: string | number): Fi
  * ```
  * @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 declare function greaterThan(attribute: Attribute, value: number): Filter;
+export declare function greaterThan(attribute: Attribute, value: number, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values greater than or equal to a specified number.
  *
@@ -262,9 +274,10 @@ export declare function greaterThan(attribute: Attribute, value: number): Filter
  * ```
  * @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 declare function greaterThanOrEqual(attribute: Attribute, value: number): Filter;
+export declare function greaterThanOrEqual(attribute: Attribute, value: number, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values strictly less than a specified number.
  *
@@ -275,9 +288,10 @@ export declare function greaterThanOrEqual(attribute: Attribute, value: number):
  * ```
  * @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 declare function lessThan(attribute: Attribute, value: number): Filter;
+export declare function lessThan(attribute: Attribute, value: number, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values less than or equal to a specified number.
  *
@@ -288,9 +302,10 @@ export declare function lessThan(attribute: Attribute, value: number): Filter;
  * ```
  * @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 declare function lessThanOrEqual(attribute: Attribute, value: number): Filter;
+export declare function lessThanOrEqual(attribute: Attribute, value: number, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values within or exactly matching two specified numerical boundaries.
  *
@@ -302,9 +317,10 @@ export declare function lessThanOrEqual(attribute: Attribute, value: number): Fi
  * @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 declare function between(attribute: Attribute, valueA: number, valueB: number): Filter;
+export declare function between(attribute: Attribute, valueA: number, valueB: number, guid?: string): Filter;
 /**
  * Creates a filter that isolates attribute values strictly within two specified numerical boundaries.
  *
@@ -316,9 +332,10 @@ export declare function between(attribute: Attribute, valueA: number, valueB: nu
  * @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 declare function betweenNotEqual(attribute: Attribute, valueA: number, valueB: number): Filter;
+export declare function betweenNotEqual(attribute: Attribute, valueA: number, valueB: number, guid?: string): Filter;
 /**
  * Creates a custom numeric filter that filters for given attribute values.
  *
@@ -339,9 +356,10 @@ export declare function betweenNotEqual(attribute: Attribute, valueA: number, va
  * @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 declare function numeric(attribute: Attribute, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number): Filter;
+export declare function numeric(attribute: Attribute, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number, guid?: string): Filter;
 /**
  * Creates a filter to isolate attribute values that match any of the specified strings.
  *
@@ -355,9 +373,10 @@ export declare function numeric(attribute: Attribute, operatorA?: string, valueA
  * ```
  * @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 declare function members(attribute: Attribute, members: string[]): Filter;
+export declare function members(attribute: Attribute, members: string[], guid?: string): Filter;
 /**
  * Creates a filter to isolate date values starting from and including the given date and level.
  *
@@ -370,7 +389,7 @@ export declare function members(attribute: Attribute, members: string[]): Filter
  * @param from - Date or string representing the value to filter from
  * @returns A filter instance
  */
-export declare function dateFrom(level: LevelAttribute, from: Date | string): Filter;
+export declare function dateFrom(level: LevelAttribute, from: Date | string, guid?: string): Filter;
 /**
  * Creates a filter to isolate items up until and including the given date and level.
  *
@@ -381,9 +400,10 @@ export declare function dateFrom(level: LevelAttribute, from: Date | string): Fi
  * ```
  * @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 declare function dateTo(level: LevelAttribute, to: Date | string): Filter;
+export declare function dateTo(level: LevelAttribute, to: Date | string, guid?: string): Filter;
 /**
  * Creates a filter to isolate items between and including the given dates and level.
  *
@@ -395,9 +415,10 @@ export declare function dateTo(level: LevelAttribute, to: Date | string): Filter
  * @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 declare function dateRange(level: LevelAttribute, from?: Date | string, to?: Date | string): Filter;
+export declare function dateRange(level: LevelAttribute, from?: Date | string, to?: Date | string, guid?: string): Filter;
 /**
  * Creates a filter to isolate items with a date dimension value within a specified range after a
  * given date and level.
@@ -427,9 +448,10 @@ export declare function dateRange(level: LevelAttribute, from?: Date | string, t
  * 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 declare function dateRelative(level: LevelAttribute, offset: number, count: number, anchor?: Date | string): Filter;
+export declare function dateRelative(level: LevelAttribute, offset: number, count: number, anchor?: Date | string, guid?: string): Filter;
 /**
  * Creates a filter to isolate items with a date dimension value within a specified range after a
  * given date and level.
@@ -443,9 +465,10 @@ export declare function dateRelative(level: LevelAttribute, offset: number, coun
  * @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 declare function dateRelativeFrom(level: LevelAttribute, offset: number, count: number, anchor?: Date | string): Filter;
+export declare function dateRelativeFrom(level: LevelAttribute, offset: number, count: number, anchor?: Date | string, guid?: string): Filter;
 /**
  * Creates a filter to isolate items with a date dimension value within a specified range before a
  * given date and level.
@@ -459,9 +482,10 @@ export declare function dateRelativeFrom(level: LevelAttribute, offset: number,
  * @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 declare function dateRelativeTo(level: LevelAttribute, offset: number, count: number, anchor?: Date | string): Filter;
+export declare function dateRelativeTo(level: LevelAttribute, offset: number, count: number, anchor?: Date | string, guid?: string): Filter;
 /**
  * Creates a filter to isolate items with a date dimension value in the current calendar year.
  *
@@ -471,9 +495,10 @@ export declare function dateRelativeTo(level: LevelAttribute, offset: number, co
  * filterFactory.thisYear(DM.Commerce.Date)
  * ```
  * @param dimension - Date dimension to filter
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export declare function thisYear(dimension: DateDimension): Filter;
+export declare function thisYear(dimension: DateDimension, guid?: string): Filter;
 /**
  * Creates a filter to isolate items with a date dimension value in the current calendar month.
  *
@@ -483,9 +508,10 @@ export declare function thisYear(dimension: DateDimension): Filter;
  * filterFactory.thisMonth(DM.Commerce.Date)
  * ```
  * @param dimension - Date dimension to filter
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export declare function thisMonth(dimension: DateDimension): Filter;
+export declare function thisMonth(dimension: DateDimension, guid?: string): Filter;
 /**
  * Creates a filter to isolate items with a date dimension value in the current quarter.
  *
@@ -495,9 +521,10 @@ export declare function thisMonth(dimension: DateDimension): Filter;
  * filterFactory.thisQuarter(DM.Commerce.Date)
  * ```
  * @param dimension - Date dimension to filter
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export declare function thisQuarter(dimension: DateDimension): Filter;
+export declare function thisQuarter(dimension: DateDimension, guid?: string): Filter;
 /**
  * Creates a filter to isolate items with a date dimension value of the current date.
  *
@@ -507,9 +534,10 @@ export declare function thisQuarter(dimension: DateDimension): Filter;
  * filterFactory.today(DM.Commerce.Date)
  * ```
  * @param dimension - date dimension to filter
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export declare function today(dimension: DateDimension): Filter;
+export declare function today(dimension: DateDimension, guid?: string): Filter;
 /**
  * Creates a filter on all measure values matching the provided criteria.
  *
@@ -519,10 +547,11 @@ export declare function today(dimension: DateDimension): Filter;
  * @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 declare function measureBase(attribute: Attribute, measure: Measure, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number): Filter;
+export declare function measureBase(attribute: Attribute, measure: Measure, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number, guid?: string): Filter;
 /**
  * Creates a filter to isolate a measure value equal to a given number.
  *
@@ -536,9 +565,10 @@ export declare function measureBase(attribute: Attribute, measure: Measure, oper
  * ```
  * @param measure - Measure to filter by
  * @param value - Value
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export declare function measureEquals(measure: BaseMeasure, value: number): Filter;
+export declare function measureEquals(measure: BaseMeasure, value: number, guid?: string): Filter;
 /**
  * Creates a filter to isolate a measure value greater than to a given number.
  *
@@ -553,9 +583,10 @@ export declare function measureEquals(measure: BaseMeasure, value: number): Filt
  * ```
  * @param measure - Measure to filter by
  * @param value - Min value
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export declare function measureGreaterThan(measure: BaseMeasure, value: number): Filter;
+export declare function measureGreaterThan(measure: BaseMeasure, value: number, guid?: string): Filter;
 /**
  * Creates a filter to isolate a measure value greater than or equal to a given number.
  *
@@ -570,9 +601,10 @@ export declare function measureGreaterThan(measure: BaseMeasure, value: number):
  * ```
  * @param measure - Measure to filter by
  * @param value - Min value
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export declare function measureGreaterThanOrEqual(measure: BaseMeasure, value: number): Filter;
+export declare function measureGreaterThanOrEqual(measure: BaseMeasure, value: number, guid?: string): Filter;
 /**
  * Creates a filter to isolate a measure value less than or equal to a given number.
  *
@@ -587,9 +619,10 @@ export declare function measureGreaterThanOrEqual(measure: BaseMeasure, value: n
  * ```
  * @param measure - Measure to filter by
  * @param value - Max value
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export declare function measureLessThanOrEqual(measure: BaseMeasure, value: number): Filter;
+export declare function measureLessThanOrEqual(measure: BaseMeasure, value: number, guid?: string): Filter;
 /**
  * Creates a filter to isolate a measure value less than a given number.
  *
@@ -603,9 +636,10 @@ export declare function measureLessThanOrEqual(measure: BaseMeasure, value: numb
  * ```
  * @param measure - Measure to filter by
  * @param value - Value
+ * @param guid - Optional GUID for the filter
  * @returns A filter instance
  */
-export declare function measureLessThan(measure: BaseMeasure, value: number): Filter;
+export declare function measureLessThan(measure: BaseMeasure, value: number, guid?: string): Filter;
 /**
  * Creates a filter to isolate a measure value between or equal to two given numbers.
  *
@@ -622,9 +656,10 @@ export declare function measureLessThan(measure: BaseMeasure, value: number): Fi
  * @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 declare function measureBetween(measure: BaseMeasure, valueA: number, valueB: number): Filter;
+export declare function measureBetween(measure: BaseMeasure, valueA: number, valueB: number, guid?: string): Filter;
 /**
  * Creates a filter to isolate a measure value between but not equal to two given numbers.
  *
@@ -641,9 +676,10 @@ export declare function measureBetween(measure: BaseMeasure, valueA: number, val
  * @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 declare function measureBetweenNotEqual(measure: BaseMeasure, valueA: number, valueB: number): Filter;
+export declare function measureBetweenNotEqual(measure: BaseMeasure, valueA: number, valueB: number, guid?: string): Filter;
 /**
  * Creates a filter to isolate items that rank towards the top for a given measure.
  *
@@ -659,9 +695,10 @@ export declare function measureBetweenNotEqual(measure: BaseMeasure, valueA: num
  * @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 declare function topRanking(attribute: Attribute, measure: Measure, count: number): Filter;
+export declare function topRanking(attribute: Attribute, measure: Measure, count: number, guid?: string): Filter;
 /**
  * Creates a filter to isolate items that rank towards the bottom for a given measure.
  *
@@ -677,9 +714,10 @@ export declare function topRanking(attribute: Attribute, measure: 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 declare function bottomRanking(attribute: Attribute, measure: Measure, count: number): Filter;
+export declare function bottomRanking(attribute: Attribute, measure: Measure, count: number, guid?: string): Filter;
 /**
  * Set of logic operators for filter relations construction
  *
@@ -751,8 +789,8 @@ export declare namespace 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 declare function customFilter(jaql: any, instanceid?: string): Filter;
+export declare function customFilter(jaql: any, guid?: string): Filter;