@sisense/sdk-data 1.33.0 → 2.0.0

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

@@ -1,4 +1,4 @@
-import { DateDimension, LevelAttribute, Attribute, Measure, Filter, BaseMeasure, FilterRelationsNode, FilterRelations, MembersFilterConfig, BaseFilterConfig } from '../interfaces.js';
+import { Attribute, BaseFilterConfig, BaseMeasure, DateDimension, Filter, FilterRelations, FilterRelationsNode, LevelAttribute, Measure, MembersFilterConfig } from '../interfaces.js';
 /**
  * Creates a filter representing the union of multiple filters on the same attribute. The resulting
  * union filter filters on items that match any of the given filters.
@@ -18,7 +18,7 @@ import { DateDimension, LevelAttribute, Attribute, Measure, Filter, BaseMeasure,
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function union(filters: Filter[], config?: BaseFilterConfig): Filter;
+export declare const union: (filters: Filter[], config?: BaseFilterConfig) => 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.
@@ -38,7 +38,7 @@ export declare function union(filters: Filter[], config?: BaseFilterConfig): Fil
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function intersection(filters: Filter[], config?: BaseFilterConfig): Filter;
+export declare const intersection: (filters: Filter[], config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter that excludes items matching the given filter
  * from all items or from items matching the optional input filter.
@@ -65,7 +65,7 @@ export declare function intersection(filters: Filter[], config?: BaseFilterConfi
  * @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, config?: BaseFilterConfig): Filter;
+export declare const exclude: (filter: Filter, input?: Filter, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values that do not contain a specified string.
  *
@@ -85,7 +85,7 @@ export declare function exclude(filter: Filter, input?: Filter, config?: BaseFil
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function doesntContain(attribute: Attribute, value: string, config?: BaseFilterConfig): Filter;
+export declare const doesntContain: (attribute: Attribute, value: string, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values that do not end with a specified string.
  *
@@ -105,7 +105,7 @@ export declare function doesntContain(attribute: Attribute, value: string, confi
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function doesntEndWith(attribute: Attribute, value: string, config?: BaseFilterConfig): Filter;
+export declare const doesntEndWith: (attribute: Attribute, value: string, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values that do not start with a specified string.
  *
@@ -125,7 +125,7 @@ export declare function doesntEndWith(attribute: Attribute, value: string, confi
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function doesntStartWith(attribute: Attribute, value: string, config?: BaseFilterConfig): Filter;
+export declare const doesntStartWith: (attribute: Attribute, value: string, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values that contain a specified string.
  *
@@ -145,7 +145,7 @@ export declare function doesntStartWith(attribute: Attribute, value: string, con
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function contains(attribute: Attribute, value: string, config?: BaseFilterConfig): Filter;
+export declare const contains: (attribute: Attribute, value: string, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values that end with a specified string.
  *
@@ -165,7 +165,7 @@ export declare function contains(attribute: Attribute, value: string, config?: B
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function endsWith(attribute: Attribute, value: string, config?: BaseFilterConfig): Filter;
+export declare const endsWith: (attribute: Attribute, value: string, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values that start with a specified string.
  *
@@ -185,7 +185,7 @@ export declare function endsWith(attribute: Attribute, value: string, config?: B
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function startsWith(attribute: Attribute, value: string, config?: BaseFilterConfig): Filter;
+export declare const startsWith: (attribute: Attribute, value: string, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values that match a specified string pattern.
  *
@@ -210,7 +210,7 @@ export declare function startsWith(attribute: Attribute, value: string, config?:
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function like(attribute: Attribute, value: string, config?: BaseFilterConfig): Filter;
+export declare const like: (attribute: Attribute, value: string, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values that do not equal a specified string or number.
  *
@@ -230,7 +230,7 @@ export declare function like(attribute: Attribute, value: string, config?: BaseF
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function doesntEqual(attribute: Attribute, value: string | number, config?: BaseFilterConfig): Filter;
+export declare const doesntEqual: (attribute: Attribute, value: string | number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values that equal a specified string or number.
  *
@@ -250,7 +250,7 @@ export declare function doesntEqual(attribute: Attribute, value: string | number
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function equals(attribute: Attribute, value: string | number, config?: BaseFilterConfig): Filter;
+export declare const equals: (attribute: Attribute, value: string | number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values strictly greater than a specified number.
  *
@@ -264,7 +264,7 @@ export declare function equals(attribute: Attribute, value: string | number, con
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function greaterThan(attribute: Attribute, value: number, config?: BaseFilterConfig): Filter;
+export declare const greaterThan: (attribute: Attribute, value: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values greater than or equal to a specified number.
  *
@@ -278,7 +278,7 @@ export declare function greaterThan(attribute: Attribute, value: number, config?
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function greaterThanOrEqual(attribute: Attribute, value: number, config?: BaseFilterConfig): Filter;
+export declare const greaterThanOrEqual: (attribute: Attribute, value: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values strictly less than a specified number.
  *
@@ -292,7 +292,7 @@ export declare function greaterThanOrEqual(attribute: Attribute, value: number,
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function lessThan(attribute: Attribute, value: number, config?: BaseFilterConfig): Filter;
+export declare const lessThan: (attribute: Attribute, value: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values less than or equal to a specified number.
  *
@@ -306,7 +306,7 @@ export declare function lessThan(attribute: Attribute, value: number, config?: B
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function lessThanOrEqual(attribute: Attribute, value: number, config?: BaseFilterConfig): Filter;
+export declare const lessThanOrEqual: (attribute: Attribute, value: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values within or exactly matching two specified numerical boundaries.
  *
@@ -321,7 +321,7 @@ export declare function lessThanOrEqual(attribute: Attribute, value: number, con
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function between(attribute: Attribute, valueA: number, valueB: number, config?: BaseFilterConfig): Filter;
+export declare const between: (attribute: Attribute, valueA: number, valueB: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter that isolates attribute values strictly within two specified numerical boundaries.
  *
@@ -336,7 +336,7 @@ export declare function between(attribute: Attribute, valueA: number, valueB: nu
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function betweenNotEqual(attribute: Attribute, valueA: number, valueB: number, config?: BaseFilterConfig): Filter;
+export declare const betweenNotEqual: (attribute: Attribute, valueA: number, valueB: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a custom numeric filter that filters for given attribute values.
  *
@@ -360,7 +360,7 @@ export declare function betweenNotEqual(attribute: Attribute, valueA: number, va
  * @param config - Optional configuration 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, config?: BaseFilterConfig): Filter;
+export declare const numeric: (attribute: Attribute, operatorA?: string, valueA?: number, operatorB?: string, valueB?: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate attribute values that match any of the specified strings.
  *
@@ -378,7 +378,7 @@ export declare function numeric(attribute: Attribute, operatorA?: string, valueA
  * @returns A filter instance
  * @shortDescription Creates filter on attribute to match certain string values
  */
-export declare function members(attribute: Attribute, members: string[], config?: MembersFilterConfig): Filter;
+export declare const members: (attribute: Attribute, members: string[], config?: MembersFilterConfig) => Filter;
 /**
  * Creates a filter to isolate date values starting from and including the given date and level.
  *
@@ -392,7 +392,7 @@ export declare function members(attribute: Attribute, members: string[], config?
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function dateFrom(level: LevelAttribute, from: Date | string, config?: BaseFilterConfig): Filter;
+export declare const dateFrom: (level: LevelAttribute, from: Date | string, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate items up until and including the given date and level.
  *
@@ -406,7 +406,7 @@ export declare function dateFrom(level: LevelAttribute, from: Date | string, con
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function dateTo(level: LevelAttribute, to: Date | string, config?: BaseFilterConfig): Filter;
+export declare const dateTo: (level: LevelAttribute, to: Date | string, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate items between and including the given dates and level.
  *
@@ -421,7 +421,7 @@ export declare function dateTo(level: LevelAttribute, to: Date | string, config?
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function dateRange(level: LevelAttribute, from?: Date | string, to?: Date | string, config?: BaseFilterConfig): Filter;
+export declare const dateRange: (level: LevelAttribute, from?: Date | string, to?: Date | string, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate items with a date dimension value within a specified range after a
  * given date and level.
@@ -454,7 +454,7 @@ export declare function dateRange(level: LevelAttribute, from?: Date | string, t
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function dateRelative(level: LevelAttribute, offset: number, count: number, anchor?: Date | string, config?: BaseFilterConfig): Filter;
+export declare const dateRelative: (level: LevelAttribute, offset: number, count: number, anchor?: Date | string, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate items with a date dimension value within a specified range after a
  * given date and level.
@@ -471,7 +471,7 @@ export declare function dateRelative(level: LevelAttribute, offset: number, coun
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function dateRelativeFrom(level: LevelAttribute, offset: number, count: number, anchor?: Date | string, config?: BaseFilterConfig): Filter;
+export declare const dateRelativeFrom: (level: LevelAttribute, offset: number, count: number, anchor?: Date | string, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate items with a date dimension value within a specified range before a
  * given date and level.
@@ -488,7 +488,7 @@ export declare function dateRelativeFrom(level: LevelAttribute, offset: number,
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function dateRelativeTo(level: LevelAttribute, offset: number, count: number, anchor?: Date | string, config?: BaseFilterConfig): Filter;
+export declare const dateRelativeTo: (level: LevelAttribute, offset: number, count: number, anchor?: Date | string, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate items with a date dimension value in the current calendar year.
  *
@@ -501,7 +501,7 @@ export declare function dateRelativeTo(level: LevelAttribute, offset: number, co
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function thisYear(dimension: DateDimension, config?: BaseFilterConfig): Filter;
+export declare const thisYear: (dimension: DateDimension, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate items with a date dimension value in the current calendar month.
  *
@@ -514,7 +514,7 @@ export declare function thisYear(dimension: DateDimension, config?: BaseFilterCo
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function thisMonth(dimension: DateDimension, config?: BaseFilterConfig): Filter;
+export declare const thisMonth: (dimension: DateDimension, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate items with a date dimension value in the current quarter.
  *
@@ -527,7 +527,7 @@ export declare function thisMonth(dimension: DateDimension, config?: BaseFilterC
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function thisQuarter(dimension: DateDimension, config?: BaseFilterConfig): Filter;
+export declare const thisQuarter: (dimension: DateDimension, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate items with a date dimension value of the current date.
  *
@@ -540,7 +540,7 @@ export declare function thisQuarter(dimension: DateDimension, config?: BaseFilte
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function today(dimension: DateDimension, config?: BaseFilterConfig): Filter;
+export declare const today: (dimension: DateDimension, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter on all measure values matching the provided criteria.
  *
@@ -571,7 +571,7 @@ export declare function measureBase(attribute: Attribute, measure: Measure, oper
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function measureEquals(measure: BaseMeasure, value: number, config?: BaseFilterConfig): Filter;
+export declare const measureEquals: (measure: BaseMeasure, value: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate a measure value greater than to a given number.
  *
@@ -589,7 +589,7 @@ export declare function measureEquals(measure: BaseMeasure, value: number, confi
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function measureGreaterThan(measure: BaseMeasure, value: number, config?: BaseFilterConfig): Filter;
+export declare const measureGreaterThan: (measure: BaseMeasure, value: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate a measure value greater than or equal to a given number.
  *
@@ -607,7 +607,7 @@ export declare function measureGreaterThan(measure: BaseMeasure, value: number,
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function measureGreaterThanOrEqual(measure: BaseMeasure, value: number, config?: BaseFilterConfig): Filter;
+export declare const measureGreaterThanOrEqual: (measure: BaseMeasure, value: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate a measure value less than or equal to a given number.
  *
@@ -625,7 +625,7 @@ export declare function measureGreaterThanOrEqual(measure: BaseMeasure, value: n
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function measureLessThanOrEqual(measure: BaseMeasure, value: number, config?: BaseFilterConfig): Filter;
+export declare const measureLessThanOrEqual: (measure: BaseMeasure, value: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate a measure value less than a given number.
  *
@@ -642,7 +642,7 @@ export declare function measureLessThanOrEqual(measure: BaseMeasure, value: numb
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function measureLessThan(measure: BaseMeasure, value: number, config?: BaseFilterConfig): Filter;
+export declare const measureLessThan: (measure: BaseMeasure, value: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate a measure value between or equal to two given numbers.
  *
@@ -662,7 +662,7 @@ export declare function measureLessThan(measure: BaseMeasure, value: number, con
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function measureBetween(measure: BaseMeasure, valueA: number, valueB: number, config?: BaseFilterConfig): Filter;
+export declare const measureBetween: (measure: BaseMeasure, valueA: number, valueB: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate a measure value between but not equal to two given numbers.
  *
@@ -682,7 +682,7 @@ export declare function measureBetween(measure: BaseMeasure, valueA: number, val
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function measureBetweenNotEqual(measure: BaseMeasure, valueA: number, valueB: number, config?: BaseFilterConfig): Filter;
+export declare const measureBetweenNotEqual: (measure: BaseMeasure, valueA: number, valueB: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate items that rank towards the top for a given measure.
  *
@@ -701,7 +701,7 @@ export declare function measureBetweenNotEqual(measure: BaseMeasure, valueA: num
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function topRanking(attribute: Attribute, measure: Measure, count: number, config?: BaseFilterConfig): Filter;
+export declare const topRanking: (attribute: Attribute, measure: Measure, count: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter to isolate items that rank towards the bottom for a given measure.
  *
@@ -720,7 +720,7 @@ export declare function topRanking(attribute: Attribute, measure: Measure, count
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function bottomRanking(attribute: Attribute, measure: Measure, count: number, config?: BaseFilterConfig): Filter;
+export declare const bottomRanking: (attribute: Attribute, measure: Measure, count: number, config?: BaseFilterConfig) => Filter;
 /**
  * Creates a filter that contains a list of dependent/cascading filters,
  * where each filter depends on the results or state of the previous ones in the array.
@@ -743,7 +743,7 @@ export declare function bottomRanking(attribute: Attribute, measure: Measure, co
  * @param config - Optional configuration for the filter
  * @returns A filter instance
  */
-export declare function cascading(filters: Filter[], config?: BaseFilterConfig): Filter;
+export declare const cascading: (filters: Filter[], config?: BaseFilterConfig) => Filter;
 /**
  * Set of logic operators for filter relations construction
  *
@@ -820,4 +820,4 @@ export declare namespace logic {
  * @returns A filter instance
  * @internal
  */
-export declare function customFilter(attribute: Attribute, jaql: any, config?: BaseFilterConfig): Filter;
+export declare const customFilter: (attribute: Attribute, jaql: any, config?: BaseFilterConfig) => Filter;