@sisense/sdk-data 1.18.0 → 1.19.0

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

@@ -562,7 +562,7 @@ export declare function measureBase(attribute: Attribute, measure: Measure, oper
  * Filter for categories that have an average revenue equal 50 in the Sample ECommerce data model.
  * ```ts
  * filterFactory.measureEquals(
- *   measures.average(DM.Commerce.Revenue),
+ *   measureFactory.average(DM.Commerce.Revenue),
  *   50
  * )
  * ```
@@ -580,7 +580,7 @@ export declare function measureEquals(measure: BaseMeasure, value: number, guid?
  * to 50 in the Sample ECommerce data model.
  * ```ts
  * filterFactory.measureGreaterThan(
- *   measures.average(DM.Commerce.Revenue),
+ *   measureFactory.average(DM.Commerce.Revenue),
  *   50
  * )
  * ```
@@ -598,7 +598,7 @@ export declare function measureGreaterThan(measure: BaseMeasure, value: number,
  * or equal to 50 in the Sample ECommerce data model.
  * ```ts
  * filterFactory.measureGreaterThanOrEqual(
- *   measures.average(DM.Commerce.Revenue),
+ *   measureFactory.average(DM.Commerce.Revenue),
  *   50
  * )
  * ```
@@ -616,7 +616,7 @@ export declare function measureGreaterThanOrEqual(measure: BaseMeasure, value: n
  * or equal to 100 in the Sample ECommerce data model.
  * ```ts
  * filterFactory.measureLessThanOrEqual(
- *   measures.average(DM.Commerce.Revenue),
+ *   measureFactory.average(DM.Commerce.Revenue),
  *   100
  * )
  * ```
@@ -633,7 +633,7 @@ export declare function measureLessThanOrEqual(measure: BaseMeasure, value: numb
  * Filter for categories that have an average revenue less than 100 in the Sample ECommerce data model.
  * ```ts
  * filterFactory.measureLessThan(
- *   measures.average(DM.Commerce.Revenue),
+ *   measureFactory.average(DM.Commerce.Revenue),
  *   100
  * )
  * ```
@@ -651,7 +651,7 @@ export declare function measureLessThan(measure: BaseMeasure, value: number, gui
  * or equal to 100 in the Sample ECommerce data model.
  * ```ts
  * filterFactory.measureBetween(
- *   measures.average(DM.Commerce.Revenue),
+ *   measureFactory.average(DM.Commerce.Revenue),
  *   50,
  *   100
  * )
@@ -671,7 +671,7 @@ export declare function measureBetween(measure: BaseMeasure, valueA: number, val
  * 100 in the Sample ECommerce data model.
  * ```ts
  * filterFactory.measureBetweenNotEqual(
- *   measures.average(DM.Commerce.Revenue),
+ *   measureFactory.average(DM.Commerce.Revenue),
  *   50,
  *   100
  * )
@@ -691,7 +691,7 @@ export declare function measureBetweenNotEqual(measure: BaseMeasure, valueA: num
  * ```ts
  * filterFactory.topRanking(
  *   DM.Commerce.AgeRange,
- *   measures.sum(DM.Commerce.Revenue),
+ *   measureFactory.sum(DM.Commerce.Revenue),
  *   3
  * )
  * ```
@@ -710,7 +710,7 @@ export declare function topRanking(attribute: Attribute, measure: Measure, count
  * ```ts
  * filterFactory.bottomRanking(
  *   DM.Commerce.AgeRange,
- *   measures.sum(DM.Commerce.Revenue),
+ *   measureFactory.sum(DM.Commerce.Revenue),
  *   3
  * )
  * ```

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

@@ -638,7 +638,7 @@ export function measureBase(attribute, measure, operatorA, valueA, operatorB, va
  * Filter for categories that have an average revenue equal 50 in the Sample ECommerce data model.
  * ```ts
  * filterFactory.measureEquals(
- *   measures.average(DM.Commerce.Revenue),
+ *   measureFactory.average(DM.Commerce.Revenue),
  *   50
  * )
  * ```
@@ -658,7 +658,7 @@ export function measureEquals(measure, value, guid) {
  * to 50 in the Sample ECommerce data model.
  * ```ts
  * filterFactory.measureGreaterThan(
- *   measures.average(DM.Commerce.Revenue),
+ *   measureFactory.average(DM.Commerce.Revenue),
  *   50
  * )
  * ```
@@ -678,7 +678,7 @@ export function measureGreaterThan(measure, value, guid) {
  * or equal to 50 in the Sample ECommerce data model.
  * ```ts
  * filterFactory.measureGreaterThanOrEqual(
- *   measures.average(DM.Commerce.Revenue),
+ *   measureFactory.average(DM.Commerce.Revenue),
  *   50
  * )
  * ```
@@ -698,7 +698,7 @@ export function measureGreaterThanOrEqual(measure, value, guid) {
  * or equal to 100 in the Sample ECommerce data model.
  * ```ts
  * filterFactory.measureLessThanOrEqual(
- *   measures.average(DM.Commerce.Revenue),
+ *   measureFactory.average(DM.Commerce.Revenue),
  *   100
  * )
  * ```
@@ -717,7 +717,7 @@ export function measureLessThanOrEqual(measure, value, guid) {
  * Filter for categories that have an average revenue less than 100 in the Sample ECommerce data model.
  * ```ts
  * filterFactory.measureLessThan(
- *   measures.average(DM.Commerce.Revenue),
+ *   measureFactory.average(DM.Commerce.Revenue),
  *   100
  * )
  * ```
@@ -737,7 +737,7 @@ export function measureLessThan(measure, value, guid) {
  * or equal to 100 in the Sample ECommerce data model.
  * ```ts
  * filterFactory.measureBetween(
- *   measures.average(DM.Commerce.Revenue),
+ *   measureFactory.average(DM.Commerce.Revenue),
  *   50,
  *   100
  * )
@@ -759,7 +759,7 @@ export function measureBetween(measure, valueA, valueB, guid) {
  * 100 in the Sample ECommerce data model.
  * ```ts
  * filterFactory.measureBetweenNotEqual(
- *   measures.average(DM.Commerce.Revenue),
+ *   measureFactory.average(DM.Commerce.Revenue),
  *   50,
  *   100
  * )
@@ -782,7 +782,7 @@ export function measureBetweenNotEqual(measure, valueA, valueB, guid) {
  * ```ts
  * filterFactory.topRanking(
  *   DM.Commerce.AgeRange,
- *   measures.sum(DM.Commerce.Revenue),
+ *   measureFactory.sum(DM.Commerce.Revenue),
  *   3
  * )
  * ```
@@ -803,7 +803,7 @@ export function topRanking(attribute, measure, count, guid) {
  * ```ts
  * filterFactory.bottomRanking(
  *   DM.Commerce.AgeRange,
- *   measures.sum(DM.Commerce.Revenue),
+ *   measureFactory.sum(DM.Commerce.Revenue),
  *   3
  * )
  * ```

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

@@ -1,5 +1,6 @@
 import { LevelAttribute, Attribute, Measure, Filter } from '../interfaces.js';
 import { DimensionalElement } from '../base.js';
+import { AnyObject } from '../types.js';
 /**
  * Different text operators that can be used with text filters
  *
@@ -71,7 +72,7 @@ export declare const FilterTypes: {
     ranking: string;
     text: string;
     numeric: string;
-    date: string;
+    dateRange: string;
     relativeDate: string;
     cascading: string;
     advanced: string;
@@ -350,6 +351,83 @@ export declare class CustomFilter extends AbstractFilter {
      */
     filterJaql(): any;
 }
+/**
+ * Checks if a filter is a CustomFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export declare function isCustomFilter(filter: Filter & AnyObject): filter is CustomFilter;
+/**
+ * Checks if a filter is a MembersFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export declare function isMembersFilter(filter: Filter & AnyObject): filter is MembersFilter;
+/**
+ * Checks if a filter is a NumericFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export declare function isNumericFilter(filter: Filter & AnyObject): filter is NumericFilter;
+/**
+ * Checks if a filter is a TextFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export declare function isRankingFilter(filter: Filter & AnyObject): filter is RankingFilter;
+/**
+ * Checks if a filter is a MeasureFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export declare function isMeasureFilter(filter: Filter & AnyObject): filter is MeasureFilter;
+/**
+ * Checks if a filter is a ExcludeFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export declare function isExcludeFilter(filter: Filter & AnyObject): filter is ExcludeFilter;
+/**
+ * Checks if a filter is a LogicalAttributeFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export declare function isLogicalAttributeFilter(filter: Filter & AnyObject): filter is LogicalAttributeFilter;
+/**
+ * Checks if a filter is a CascadingFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export declare function isCascadingFilter(filter: Filter & AnyObject): filter is CascadingFilter;
+/**
+ * Checks if a filter is a RelativeDateFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export declare function isRelativeDateFilter(filter: Filter & AnyObject): filter is RelativeDateFilter;
+/**
+ * Checks if a filter is a TextFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export declare function isTextFilter(filter: Filter & AnyObject): filter is TextFilter;
+/**
+ * Checks if a filter is a DateRangeFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export declare function isDateRangeFilter(filter: Filter & AnyObject): filter is DateRangeFilter;
 /**
  * @param json - Filter JSON representation
  * @internal

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

@@ -1,3 +1,4 @@
+/* eslint-disable max-lines */
 /* eslint-disable @typescript-eslint/no-unsafe-assignment */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 /* eslint-disable @typescript-eslint/no-unsafe-return */
@@ -83,7 +84,7 @@ export const FilterTypes = {
     ranking: 'ranking',
     text: 'text',
     numeric: 'numeric',
-    date: 'date',
+    dateRange: 'dateRange',
     relativeDate: 'relativeDate',
     cascading: 'cascading',
     advanced: 'advanced',
@@ -531,7 +532,7 @@ export class TextFilter extends DoubleOperatorFilter {
  */
 export class DateRangeFilter extends DoubleOperatorFilter {
     constructor(l, valueFrom, valueTo, guid) {
-        super(l, FilterTypes.date, DateOperators.From, valueFrom, DateOperators.To, valueTo, guid);
+        super(l, FilterTypes.dateRange, DateOperators.From, valueFrom, DateOperators.To, valueTo, guid);
         if (typeof valueFrom === 'object') {
             this.valueA = valueFrom.toISOString();
         }
@@ -645,6 +646,105 @@ export class CustomFilter extends AbstractFilter {
         return this.jaqlExpression;
     }
 }
+/**
+ * Checks if a filter is a CustomFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export function isCustomFilter(filter) {
+    return 'filterType' in filter && filter.filterType === FilterTypes.advanced;
+}
+/**
+ * Checks if a filter is a MembersFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export function isMembersFilter(filter) {
+    return 'filterType' in filter && filter.filterType === FilterTypes.members;
+}
+/**
+ * Checks if a filter is a NumericFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export function isNumericFilter(filter) {
+    return 'filterType' in filter && filter.filterType === FilterTypes.numeric;
+}
+/**
+ * Checks if a filter is a TextFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export function isRankingFilter(filter) {
+    return 'filterType' in filter && filter.filterType === FilterTypes.ranking;
+}
+/**
+ * Checks if a filter is a MeasureFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export function isMeasureFilter(filter) {
+    return 'filterType' in filter && filter.filterType === FilterTypes.measure;
+}
+/**
+ * Checks if a filter is a ExcludeFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export function isExcludeFilter(filter) {
+    return 'filterType' in filter && filter.filterType === FilterTypes.exclude;
+}
+/**
+ * Checks if a filter is a LogicalAttributeFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export function isLogicalAttributeFilter(filter) {
+    return 'filterType' in filter && filter.filterType === FilterTypes.logicalAttribute;
+}
+/**
+ * Checks if a filter is a CascadingFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export function isCascadingFilter(filter) {
+    return 'filterType' in filter && filter.filterType === FilterTypes.cascading;
+}
+/**
+ * Checks if a filter is a RelativeDateFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export function isRelativeDateFilter(filter) {
+    return 'filterType' in filter && filter.filterType === FilterTypes.relativeDate;
+}
+/**
+ * Checks if a filter is a TextFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export function isTextFilter(filter) {
+    return 'filterType' in filter && filter.filterType === FilterTypes.text;
+}
+/**
+ * Checks if a filter is a DateRangeFilter.
+ *
+ * @param filter - The filter to check.
+ * @internal
+ */
+export function isDateRangeFilter(filter) {
+    return 'filterType' in filter && filter.filterType === FilterTypes.dateRange;
+}
 /**
  * @param json - Filter JSON representation
  * @internal
@@ -675,7 +775,7 @@ export function createFilter(json) {
         case FilterTypes.relativeDate:
             return new RelativeDateFilter(create(json.attribute), json.offset, json.count, json.operator, json.anchor);
             break;
-        case FilterTypes.date:
+        case FilterTypes.dateRange:
             return new DateRangeFilter(create(json.attribute), json.valueA, json.valueB);
             break;
     }

package/dist/dimensional-model/filters/utils/attribute-measure-util.d.ts

@@ -9,9 +9,10 @@ import { FilterJaqlInternal, RankingFilterJaql } from './types.js';
  * @param column - Column name
  * @param level - Date level
  * @param dataType - Data type
+ * @param title - Attribute title
  * @returns attribute or level attribute
  */
-export declare const createAttributeHelper: (dim: string, table: string | undefined, column: string, level: string | undefined, dataType: string) => Attribute | LevelAttribute;
+export declare const createAttributeHelper: (dim: string, table: string | undefined, column: string, level: string | undefined, dataType: string, title?: string) => Attribute | LevelAttribute;
 /**
  * Creates an attribute or level attribute from the provided filter JAQL object
  *
@@ -30,7 +31,7 @@ export declare const createAttributeFromFilterJaql: (jaql: FilterJaql | FilterJa
  * @param agg - Aggregation function
  * @returns measure
  */
-export declare const createMeasureHelper: (dim: string, table: string | undefined, column: string, level: string | undefined, dataType: string, agg: string) => BaseMeasure;
+export declare const createMeasureHelper: (dim: string, table: string | undefined, column: string, level: string | undefined, dataType: string, agg: string, title?: string) => BaseMeasure;
 /**
  * Creates a measure from the provided filter JAQL object
  *

package/dist/dimensional-model/filters/utils/attribute-measure-util.js

@@ -11,22 +11,23 @@ const DATA_MODEL_MODULE_NAME = 'DM';
  * @param column - Column name
  * @param level - Date level
  * @param dataType - Data type
+ * @param title - Attribute title
  * @returns attribute or level attribute
  */
-export const createAttributeHelper = (dim, table, column, level, dataType) => {
+export const createAttributeHelper = (dim, table, column, level, dataType, title) => {
     // if table is undefined, extract it from dim
     const dimTable = table !== null && table !== void 0 ? table : dim.slice(1, -1).split('.')[0];
     if (level) {
         const dateLevel = DimensionalLevelAttribute.translateJaqlToGranularity({ level });
         const format = DimensionalLevelAttribute.getDefaultFormatForGranularity(dateLevel);
-        const levelAttribute = new DimensionalLevelAttribute(column, dim, dateLevel, format);
+        const levelAttribute = new DimensionalLevelAttribute(title !== null && title !== void 0 ? title : column, dim, dateLevel, format);
         levelAttribute.composeCode = normalizeAttributeName(dimTable, column, level, DATA_MODEL_MODULE_NAME);
         return levelAttribute;
     }
     const attributeType = isNumber(dataType)
         ? MetadataTypes.NumericAttribute
         : MetadataTypes.TextAttribute;
-    const attribute = new DimensionalAttribute(column, dim, attributeType);
+    const attribute = new DimensionalAttribute(title !== null && title !== void 0 ? title : column, dim, attributeType);
     attribute.composeCode = normalizeAttributeName(dimTable, column, undefined, DATA_MODEL_MODULE_NAME);
     return attribute;
 };
@@ -37,7 +38,7 @@ export const createAttributeHelper = (dim, table, column, level, dataType) => {
  * @returns attribute or level attribute
  */
 export const createAttributeFromFilterJaql = (jaql) => {
-    return createAttributeHelper(jaql.dim, jaql.table, jaql.column, jaql.level, jaql.datatype);
+    return createAttributeHelper(jaql.dim, jaql.table, jaql.column, jaql.level, jaql.datatype, jaql.title);
 };
 /**
  * Creates a measure from the provided parameters
@@ -50,8 +51,8 @@ export const createAttributeFromFilterJaql = (jaql) => {
  * @param agg - Aggregation function
  * @returns measure
  */
-export const createMeasureHelper = (dim, table, column, level, dataType, agg) => {
-    const attribute = createAttributeHelper(dim, table, column, level, dataType);
+export const createMeasureHelper = (dim, table, column, level, dataType, agg, title) => {
+    const attribute = createAttributeHelper(dim, table, column, level, dataType, title);
     const measure = measureFactory.aggregate(attribute, agg);
     measure.composeCode = `measureFactory.${agg}(${attribute.composeCode})`;
     return measure;
@@ -63,10 +64,10 @@ export const createMeasureHelper = (dim, table, column, level, dataType, agg) =>
  * @returns Measure
  */
 export const createMeasureFromFilterJaql = (jaql) => {
-    const { dim, table, column, level, datatype: dataType, agg } = jaql;
+    const { dim, table, column, title, level, datatype: dataType, agg } = jaql;
     if (!agg)
         return undefined;
-    return createMeasureHelper(dim, table, column, level, dataType, agg);
+    return createMeasureHelper(dim, table, column, level, dataType, agg, title);
 };
 /**
  * Creates a measure from the provided ranking filter JAQL object

package/dist/dimensional-model/interfaces.d.ts

@@ -344,6 +344,10 @@ export interface Filter extends Element {
      * Attribute this filter instance is filtering
      */
     readonly attribute: Attribute;
+    /**
+     * Filter type
+     */
+    readonly filterType: string;
     /**
      * Boolean flag whether the filter is a scope filter
      */

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

@@ -258,7 +258,7 @@ export declare function countDistinct(attribute: Attribute, name?: string, forma
  * ```ts
  * measureFactory.measuredValue(
  *   measureFactory.sum(DM.Commerce.Cost),
- *   [filters.greaterThan(DM.Commerce.Cost, 100)],
+ *   [filterFactory.greaterThan(DM.Commerce.Cost, 100)],
  *   'Cost Greater Than 100'
  * ),
  * ```

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

@@ -381,7 +381,7 @@ export function countDistinct(attribute, name, format) {
  * ```ts
  * measureFactory.measuredValue(
  *   measureFactory.sum(DM.Commerce.Cost),
- *   [filters.greaterThan(DM.Commerce.Cost, 100)],
+ *   [filterFactory.greaterThan(DM.Commerce.Cost, 100)],
  *   'Cost Greater Than 100'
  * ),
  * ```

package/dist/dimensional-model/types.d.ts

@@ -190,6 +190,7 @@ export declare type BaseJaql = {
             jaql: FilterJaql;
         };
     };
+    merged?: boolean;
 };
 /** @internal */
 export declare type FormulaID = string;
@@ -255,4 +256,8 @@ declare type AndFilter<FilterItem> = {
 export declare type OrFilter<FilterItem> = {
     or: FilterItem[];
 };
+/**
+ * Abstract object with any unknown values
+ */
+export declare type AnyObject = Record<string, any>;
 export {};