@sisense/sdk-data 2.19.0 → 2.21.0

package/dist/dimensional-model/filters/utils/condition-filter-util.js

@@ -153,6 +153,7 @@ export const createAttributeFilterFromConditionFilterJaql = (attribute, conditio
     }
     throw new TranslatableError('errors.filter.unsupportedConditionFilter', {
         filter: JSON.stringify(conditionFilterJaql),
+        attributeName: attribute.name,
     });
 };
 /**
@@ -188,5 +189,6 @@ export const createMeasureFilterFromConditionFilterJaql = (measure, conditionFil
     }
     throw new TranslatableError('errors.filter.unsupportedConditionFilter', {
         filter: JSON.stringify(conditionFilterJaql),
+        attributeName: measure.name,
     });
 };

package/dist/dimensional-model/filters/utils/filter-from-jaql-util.js

@@ -130,11 +130,13 @@ export const createFilterFromCustomFilterJaql = (attribute, customFilterJaql, gu
  * @returns Filter object.
  */
 export const createFilterFromJaqlInternal = (jaql, guid) => {
+    var _a, _b;
     try {
         if ('formula' in jaql) {
             // generic pass-through JAQL filter will be used instead
             throw new TranslatableError('errors.filter.formulaFiltersNotSupported', {
                 filter: JSON.stringify(jaql),
+                attributeName: (_b = (_a = jaql.title) !== null && _a !== void 0 ? _a : jaql.column) !== null && _b !== void 0 ? _b : jaql.dim,
             });
         }
         const filterJaqlWrapperWithType = extractFilterTypeFromFilterJaql(jaql, jaql.datatype);

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

@@ -639,8 +639,14 @@ export declare type FilterRelationsModelCascadeNode = {
     type: 'CascadingIdentifier';
     levels: FilterRelationsModelIdNode[];
 };
-/** Sorting direction, either in Ascending order, Descending order, or None */
+/**
+ * Sorting direction, either in Ascending order, Descending order, or None
+ */
 export declare type SortDirection = 'sortAsc' | 'sortDesc' | 'sortNone';
+/**
+ * @internal
+ */
+export declare function isSortDirection(sortDirection: unknown): sortDirection is SortDirection;
 /**
  * Sorting configuration for pivot "rows".
  *

package/dist/dimensional-model/interfaces.js

@@ -32,3 +32,10 @@ export const DEFAULT_PIVOT_GRAND_TOTALS = {
     rows: false,
     columns: false,
 };
+/**
+ * @internal
+ */
+export function isSortDirection(sortDirection) {
+    const SORT_DIRECTIONS = ['sortAsc', 'sortDesc', 'sortNone'];
+    return (typeof sortDirection === 'string' && SORT_DIRECTIONS.includes(sortDirection));
+}

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

@@ -81,10 +81,12 @@ export declare const RankingSortTypes: {
  * @param title - Title of the measure to be displayed in legend
  * @param formula - Formula to be used for the measure
  * @param context - Formula context as a map of strings to attributes, measures, or filters
+ * @param format - Optional format string for the measure
+ * @param description - Optional description of the measure
  * @returns A calculated measure instance
  * @group Advanced Analytics
  */
-export declare const customFormula: (title: string, formula: string, context: CustomFormulaContext) => CalculatedMeasure;
+export declare const customFormula: (title: string, formula: string, context: CustomFormulaContext, format?: string, description?: string) => CalculatedMeasure;
 /**
  * Creates an aggregated measure.
  *

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

@@ -121,13 +121,15 @@ function measureFunction(measure, name, func, options) {
  * @param title - Title of the measure to be displayed in legend
  * @param formula - Formula to be used for the measure
  * @param context - Formula context as a map of strings to attributes, measures, or filters
+ * @param format - Optional format string for the measure
+ * @param description - Optional description of the measure
  * @returns A calculated measure instance
  * @group Advanced Analytics
  */
-export const customFormula = withComposeCodeForMeasure((title, formula, context) => {
+export const customFormula = withComposeCodeForMeasure((title, formula, context, format, description) => {
     // context keys must be in brackets
     const newContext = Object.fromEntries(Object.entries(context).map(([key, val]) => [key.startsWith('[') ? key : `[${key}]`, val]));
-    return new DimensionalCalculatedMeasure(title, formula, newContext);
+    return new DimensionalCalculatedMeasure(title, formula, newContext, format, description);
 }, 'customFormula');
 function arithmetic(operand1, operator, operand2, name, withParentheses) {
     const builder = [];

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

@@ -391,7 +391,9 @@ export function createMeasure(json) {
     }
     if (MetadataTypes.isCalculatedMeasure(json)) {
         if (json.context === undefined) {
-            throw new TranslatableError('errors.measure.dimensionalCalculatedMeasure.noContext');
+            throw new TranslatableError('errors.measure.dimensionalCalculatedMeasure.noContext', {
+                measureName: name,
+            });
         }
         const context = {};
         Object.getOwnPropertyNames(json.context).forEach((pname) => {
@@ -401,19 +403,21 @@ export function createMeasure(json) {
     }
     else if (MetadataTypes.isMeasureTemplate(json)) {
         if (att === undefined) {
-            throw new TranslatableError('errors.measure.dimensionalBaseMeasure.noAttributeDimExpression');
+            throw new TranslatableError('errors.measure.dimensionalBaseMeasure.noAttributeDimExpression', { measureName: name });
         }
         return new DimensionalMeasureTemplate(name, att, format, desc, sort);
     }
     else if (MetadataTypes.isBaseMeasure(json)) {
         if (att === undefined) {
-            throw new TranslatableError('errors.measure.dimensionalBaseMeasure.noAttributeDimExpression');
+            throw new TranslatableError('errors.measure.dimensionalBaseMeasure.noAttributeDimExpression', { measureName: name });
         }
         const agg = json.agg || json.aggregation;
         if (!agg) {
-            throw new TranslatableError('errors.measure.dimensionalBaseMeasure.noAggAggregation');
+            throw new TranslatableError('errors.measure.dimensionalBaseMeasure.noAggAggregation', {
+                measureName: name,
+            });
         }
         return new DimensionalBaseMeasure(name, att, agg, format, desc, sort);
     }
-    throw new TranslatableError('errors.measure.unsupportedType');
+    throw new TranslatableError('errors.measure.unsupportedType', { measureName: name });
 }

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

@@ -217,6 +217,7 @@ export declare type FormulaJaql = {
     formula: string;
     context?: Record<FormulaID, FormulaContext>;
     datasource?: JaqlDataSource;
+    description?: string;
 };
 /** @internal */
 export declare type BaseFilterJaql = IncludeAllFilterJaql | IncludeMembersFilterJaql | ExcludeMembersFilterJaql | NumericFilterJaql | ConditionFilterJaql | AndFilterJaql<NumericFilterJaql | ConditionFilterJaql> | OrFilterJaql<NumericFilterJaql | ConditionFilterJaql>;

package/dist/translation/resources/en.d.ts

@@ -12,9 +12,8 @@ export declare const translation: {
                 noAttributeDimExpression: string;
                 noAggAggregation: string;
             };
-            notAFormula: string;
         };
-        dataModelConfig: {
+        dataModel: {
             noName: string;
             noMetadata: string;
         };

package/dist/translation/resources/en.js

@@ -4,26 +4,25 @@
 export const translation = {
     errors: {
         measure: {
-            unsupportedType: 'Unsupported measure type',
+            unsupportedType: 'Unsupported measure type for measure: {{measureName}}',
             dimensionalCalculatedMeasure: {
-                noContext: "DimensionalCalculatedMeasure must have 'context' property",
+                noContext: "DimensionalCalculatedMeasure {{measureName}} must have 'context' property",
             },
             dimensionalBaseMeasure: {
-                noAttributeDimExpression: "DimensionalBaseMeasure must have 'attribute'/'dim'/'expression' property",
-                noAggAggregation: "DimensionalBaseMeasure must have 'agg' or 'aggregation' property",
+                noAttributeDimExpression: "DimensionalBaseMeasure {{measureName}} must have 'attribute'/'dim'/'expression' property",
+                noAggAggregation: "DimensionalBaseMeasure {{measureName}} must have 'agg' or 'aggregation' property",
             },
-            notAFormula: 'Jaql is not a formula',
         },
-        dataModelConfig: {
+        dataModel: {
             noName: "'name' must be specified in config for DataModel",
             noMetadata: "'metadata' must be specified in config for DataModel",
         },
         filter: {
             unsupportedType: 'Unsupported filter type: {{filterType}}',
-            unsupportedDatetimeLevel: 'Filters do not support the next "datetime" levels: Hours, MinutesRoundTo30, MinutesRoundTo15, Minutes, Seconds',
+            unsupportedDatetimeLevel: 'Filters do not support the following "datetime" levels: Hours, MinutesRoundTo30, MinutesRoundTo15, Minutes, Seconds',
             membersFilterNullMember: 'MembersFilter of {{attributeId}} - member cannot be null',
-            unsupportedConditionFilter: 'Jaql contains unsupported condition filter: {{filter}}',
-            formulaFiltersNotSupported: 'Formula-based filter not supported yet: {{filter}}',
+            unsupportedConditionFilter: 'Jaql for {{attributeName}} contains unsupported condition filter: {{filter}}',
+            formulaFiltersNotSupported: 'Formula-based filter for {{attributeName}} not supported yet: {{filter}}',
         },
         unsupportedDimensionalElement: 'Unsupported dimensional element type',
     },

package/dist/translation/resources/index.d.ts

@@ -19,9 +19,8 @@ export declare const resources: {
                     noAttributeDimExpression: string;
                     noAggAggregation: string;
                 };
-                notAFormula: string;
             };
-            dataModelConfig: {
+            dataModel: {
                 noName: string;
                 noMetadata: string;
             };
@@ -46,9 +45,8 @@ export declare const resources: {
                     noAttributeDimExpression: string;
                     noAggAggregation: string;
                 };
-                notAFormula: string;
             };
-            dataModelConfig: {
+            dataModel: {
                 noName: string;
                 noMetadata: string;
             };

package/dist/translation/resources/uk.js

@@ -4,17 +4,16 @@
 export const translation = {
     errors: {
         measure: {
-            unsupportedType: 'Непідтримуваний тип measure',
+            unsupportedType: 'Непідтримуваний тип measure: {{measureName}}',
             dimensionalCalculatedMeasure: {
-                noContext: "DimensionalCalculatedMeasure має мати властивість 'context'",
+                noContext: "DimensionalCalculatedMeasure {{measureName}} має мати властивість 'context'",
             },
             dimensionalBaseMeasure: {
-                noAttributeDimExpression: "DimensionalBaseMeasure має мати властивість 'attribute'/'dim'/'expression'",
-                noAggAggregation: "DimensionalBaseMeasure має мати властивість 'agg' або 'aggregation'",
+                noAttributeDimExpression: "DimensionalBaseMeasure {{measureName}} має мати властивість 'attribute'/'dim'/'expression'",
+                noAggAggregation: "DimensionalBaseMeasure {{measureName}} має мати властивість 'agg' або 'aggregation'",
             },
-            notAFormula: 'Jaql не формула',
         },
-        dataModelConfig: {
+        dataModel: {
             noName: "'name' має бути вказано в конфігурації для DataModel",
             noMetadata: "'metadata' має бути вказано в конфігурації для DataModel",
         },
@@ -22,8 +21,8 @@ export const translation = {
             unsupportedType: 'Непідтримуваний тип фільтра: {{filterType}}',
             unsupportedDatetimeLevel: 'Фільтри не підтримують наступні рівні "datetime": Hours, MinutesRoundTo30, MinutesRoundTo15, Minutes, Seconds',
             membersFilterNullMember: 'MembersFilter у {{attributeId}} - member не може бути нульовим',
-            unsupportedConditionFilter: 'Jaql містить непідтримуваний condition фільтр: {{filter}}',
-            formulaFiltersNotSupported: 'Фільтри, що містять формули наразі не підтримуються: {{filter}}',
+            unsupportedConditionFilter: 'Jaql для {{attributeName}} містить непідтримуваний condition фільтр: {{filter}}',
+            formulaFiltersNotSupported: 'Фільтри, що містять формули для {{attributeName}} наразі не підтримуються: {{filter}}',
         },
         unsupportedDimensionalElement: 'Непідтримуваний тип елемента',
     },