@adaptabletools/adaptable 12.0.4 → 12.0.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "12.0.4",
+  "version": "12.0.5",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1657113089379;
+declare const _default: 1657198207277;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1657113089379;
+exports.default = 1657198207277;

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -72,15 +72,15 @@ export interface CustomReport {
  */
 export interface CustomDestination {
     /**
-     * Name of Custom Destination
+     * Name of Custom Destination (mandatory)
      */
     name: string;
     /**
-     * Optional Adaptable Form - if provided, it must include Buttons that will execute the export
+     * Optional Adaptable Form; if provided, it must include Buttons that will execute the Export
      */
     form?: AdaptableForm<ExportFormContext>;
     /**
-     * Function invoked when export is applied (used if no form is supplied)
+     * Optional Function invoked when Export is applied (used if no form is supplied)
      */
     onExport?: (reportContext: ReportContext) => void;
 }

package/src/Utilities/ExpressionFunctions/aggregatedBooleanExpressionFunctions.js

@@ -28,7 +28,7 @@ exports.aggregatedBooleanExpressionFunctions = {
     SUM: {
         handler(args, context) {
             const columnParameter = expressionFunctionUtils_1.extractColumnParameter('SUM', args);
-            expressionFunctionUtils_1.validateColumnType(columnParameter.value, ['Number'], 'SUM', context.api);
+            expressionFunctionUtils_1.validateColumnType(columnParameter.value, ['Number'], 'SUM', context.adaptableApi);
             const sumAggregationFn = (dataSource$) => getSumAggregation$(dataSource$, getColumnValueSum(columnParameter.value, context));
             const result = {
                 type: 'aggregation',
@@ -195,15 +195,15 @@ const getSumAggregation$ = (source$, initialSum) => {
 };
 const getColumnValueSum = (column, context) => {
     let sum = 0;
-    context.api.internalApi.forAllRowNodesDo((rowNode) => {
+    context.adaptableApi.internalApi.forAllRowNodesDo((rowNode) => {
         // if there is a WHERE clause defined, check if the current rowNode satisfies the condition
         if (context.filterFn && !context.filterFn(rowNode)) {
             return;
         }
-        if (context.api.gridApi.isGroupRowNode(rowNode)) {
+        if (context.adaptableApi.gridApi.isGroupRowNode(rowNode)) {
             return;
         }
-        const cellValue = context.api.gridApi.getRawValueFromRowNode(rowNode, column);
+        const cellValue = context.adaptableApi.gridApi.getRawValueFromRowNode(rowNode, column);
         if (cellValue != undefined) {
             sum = sum + expressionFunctionUtils_1.getNumericValue(rowNode.data[column]);
         }

package/src/Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions.js

@@ -8,7 +8,7 @@ exports.aggregatedScalarExpressionFunctions = {
         handler(args, context) {
             const sumColumnParameter = expressionFunctionUtils_1.extractColumnParameter('SUM', args);
             const sumColumnName = sumColumnParameter.value;
-            expressionFunctionUtils_1.validateColumnType(sumColumnName, ['Number'], 'SUM', context.api);
+            expressionFunctionUtils_1.validateColumnType(sumColumnName, ['Number'], 'SUM', context.adaptableApi);
             const groupByParameter = expressionFunctionUtils_1.extractParameter('SUM', 'operand', ['GROUP_BY'], args, true);
             const aggregationExpressionEvaluation = {
                 aggregationParams: {
@@ -50,7 +50,7 @@ exports.aggregatedScalarExpressionFunctions = {
             var _a;
             const percentageColumnParameter = expressionFunctionUtils_1.extractColumnParameter('PERCENTAGE', args);
             const percentageColumnName = percentageColumnParameter.value;
-            expressionFunctionUtils_1.validateColumnType(percentageColumnName, ['Number'], 'PERCENTAGE', context.api);
+            expressionFunctionUtils_1.validateColumnType(percentageColumnName, ['Number'], 'PERCENTAGE', context.adaptableApi);
             const sumOperand = expressionFunctionUtils_1.extractParameter('PERCENTAGE', 'aggregation', ['SUM'], args, true);
             const groupByOperand = expressionFunctionUtils_1.extractParameter('PERCENTAGE', 'operand', ['GROUP_BY'], args, true);
             if (sumOperand && groupByOperand) {
@@ -79,7 +79,7 @@ exports.aggregatedScalarExpressionFunctions = {
                     },
                 },
                 rowValueGetter: (rowNode, aggregationValue) => {
-                    return ((context.api.gridApi.getRawValueFromRowNode(rowNode, percentageColumnName) /
+                    return ((context.adaptableApi.gridApi.getRawValueFromRowNode(rowNode, percentageColumnName) /
                         aggregationValue) *
                         100);
                 },
@@ -118,7 +118,7 @@ exports.aggregatedScalarExpressionFunctions = {
         handler(args, context) {
             const avgColumnParameter = expressionFunctionUtils_1.extractColumnParameter('AVG', args);
             const avgColumnName = avgColumnParameter.value;
-            expressionFunctionUtils_1.validateColumnType(avgColumnName, ['Number'], 'AVG', context.api);
+            expressionFunctionUtils_1.validateColumnType(avgColumnName, ['Number'], 'AVG', context.adaptableApi);
             const groupByParameter = expressionFunctionUtils_1.extractParameter('AVG', 'operand', ['GROUP_BY'], args, true);
             const aggregationExpressionEvaluation = {
                 aggregationParams: {
@@ -162,7 +162,7 @@ exports.aggregatedScalarExpressionFunctions = {
         handler(args, context) {
             const minColumnParameter = expressionFunctionUtils_1.extractColumnParameter('MIN', args);
             const minColumnName = minColumnParameter.value;
-            expressionFunctionUtils_1.validateColumnType(minColumnName, ['Number'], 'MIN', context.api);
+            expressionFunctionUtils_1.validateColumnType(minColumnName, ['Number'], 'MIN', context.adaptableApi);
             const groupByParameter = expressionFunctionUtils_1.extractParameter('MIN', 'operand', ['GROUP_BY'], args, true);
             const aggregationExpressionEvaluation = {
                 aggregationParams: {
@@ -203,7 +203,7 @@ exports.aggregatedScalarExpressionFunctions = {
         handler(args, context) {
             const maxColumnParameter = expressionFunctionUtils_1.extractColumnParameter('MAX', args);
             const maxColumnName = maxColumnParameter.value;
-            expressionFunctionUtils_1.validateColumnType(maxColumnName, ['Number'], 'MAX', context.api);
+            expressionFunctionUtils_1.validateColumnType(maxColumnName, ['Number'], 'MAX', context.adaptableApi);
             const groupByParameter = expressionFunctionUtils_1.extractParameter('MAX', 'operand', ['GROUP_BY'], args, true);
             const aggregationExpressionEvaluation = {
                 aggregationParams: {
@@ -284,7 +284,7 @@ exports.aggregatedScalarExpressionFunctions = {
     OVER: {
         handler(args, context) {
             const columnParameter = expressionFunctionUtils_1.extractColumnParameter('OVER', args);
-            expressionFunctionUtils_1.validateColumnType(columnParameter.value, ['Number', 'Date'], 'OVER', context.api);
+            expressionFunctionUtils_1.validateColumnType(columnParameter.value, ['Number', 'Date'], 'OVER', context.adaptableApi);
             const result = {
                 type: 'operand',
                 name: 'OVER',

package/src/Utilities/ExpressionFunctions/booleanExpressionFunctions.js

@@ -225,9 +225,9 @@ exports.booleanExpressionFunctions = {
         handler(args, context) {
             var _a;
             const searchTerm = expressionFunctionUtils_1.getStringValue(context, String(args[0]));
-            return (_a = context.api) === null || _a === void 0 ? void 0 : _a.columnApi.getColumns().some((column) => {
+            return (_a = context.adaptableApi) === null || _a === void 0 ? void 0 : _a.columnApi.getColumns().some((column) => {
                 var _a;
-                const value = (_a = context.api) === null || _a === void 0 ? void 0 : _a.gridApi.getDisplayValueFromRowNode(context.node, column.columnId);
+                const value = (_a = context.adaptableApi) === null || _a === void 0 ? void 0 : _a.gridApi.getDisplayValueFromRowNode(context.node, column.columnId);
                 const columnValue = expressionFunctionUtils_1.getStringValue(context, String(value));
                 return columnValue.indexOf(searchTerm) !== -1;
             });
@@ -266,7 +266,7 @@ exports.booleanExpressionFunctions = {
             if (StringExtensions_1.default.IsNullOrEmpty(namedQueryName)) {
                 return false;
             }
-            const namedQuery = (_a = context.api) === null || _a === void 0 ? void 0 : _a.queryApi.getNamedQueryByName(namedQueryName);
+            const namedQuery = (_a = context.adaptableApi) === null || _a === void 0 ? void 0 : _a.queryApi.getNamedQueryByName(namedQueryName);
             if (!namedQuery) {
                 throw new ExpressionEvaluationError_1.ExpressionEvaluationError('QUERY', `Named Query with name ${namedQueryName} not found!`);
             }

package/src/Utilities/ExpressionFunctions/expressionFunctionUtils.js

@@ -19,12 +19,12 @@ const getStringValue = (context, stringArgument) => {
     return exports.isTextSearchCaseInsensitive(context) ? stringArgument.toLowerCase() : stringArgument;
 };
 exports.getStringValue = getStringValue;
-const isTextSearchCaseInsensitive = (context) => !context.api.internalApi.isTextComparisonCaseSensitive();
+const isTextSearchCaseInsensitive = (context) => !context.adaptableApi.internalApi.isTextComparisonCaseSensitive();
 exports.isTextSearchCaseInsensitive = isTextSearchCaseInsensitive;
 // returns an observable which filters the source$ emissions and emits only if the CellDataChangedInfo relates to the given column
 // optionally, if a filter function (where clause) is provided, it is also evaluated
 const getDataChangeLog$ = (context, columnNameFilter) => {
-    let dataChangeLog$ = context.api.internalApi.getDataService().dataChangeLog$;
+    let dataChangeLog$ = context.adaptableApi.internalApi.getDataService().dataChangeLog$;
     // filter only the given column changes
     dataChangeLog$ = dataChangeLog$.pipe(operators_1.filter((dataChangeLog) => dataChangeLog.column.columnId === columnNameFilter));
     // filter based on the WHERE clause
@@ -41,14 +41,14 @@ const handleWhereFunction = (args, context) => {
         // whereClauseResult
         return evaluator_1.evaluateNode(whereClauseExpressionNode, {
             node: rowNode,
-            api: context.api,
+            adaptableApi: context.adaptableApi,
             functions: context.whereClauseFunctions,
         });
     };
     // observableExpressionResult
     return evaluator_1.evaluateNode(reactiveExpressionNode, {
         node: context.node,
-        api: context.api,
+        adaptableApi: context.adaptableApi,
         functions: context.functions,
         filterFn,
     });
@@ -76,7 +76,7 @@ const handleColumnFunction = (args, context) => {
     if (StringExtensions_1.default.IsNullOrEmpty(args[0])) {
         throw new ExpressionEvaluationError_1.ExpressionEvaluationError('COL', `no column name is provided`);
     }
-    validateColumnId(args[0], context.api);
+    validateColumnId(args[0], context.adaptableApi);
     const result = {
         type: 'config',
         name: 'COL',

package/src/Utilities/ExpressionFunctions/observableExpressionFunctions.js

@@ -32,12 +32,12 @@ exports.observableExpressionFunctions = {
                     return getDataChangeCount$(dataChangeLog$, timeframeChange$, operandParameter.value);
                 }
                 case 'MIN': {
-                    expressionFunctionUtils_1.validateColumnType(operandParameter.column, ['Number'], 'MIN', context.api);
+                    expressionFunctionUtils_1.validateColumnType(operandParameter.column, ['Number'], 'MIN', context.adaptableApi);
                     const timeframeChange$ = getTrailingRowValueChange$(dataChangeLog$, timeframeParameter.value);
                     return getDataChangeMin$(dataChangeLog$, timeframeChange$);
                 }
                 case 'MAX': {
-                    expressionFunctionUtils_1.validateColumnType(operandParameter.column, ['Number'], 'MAX', context.api);
+                    expressionFunctionUtils_1.validateColumnType(operandParameter.column, ['Number'], 'MAX', context.adaptableApi);
                     const timeframeChange$ = getTrailingRowValueChange$(dataChangeLog$, timeframeParameter.value);
                     return getDataChangeMax$(dataChangeLog$, timeframeChange$);
                 }
@@ -71,12 +71,12 @@ exports.observableExpressionFunctions = {
                     return getDataChangeCount$(dataChangeLog$, timeframeChange$, operandParameter.value);
                 }
                 case 'MIN': {
-                    expressionFunctionUtils_1.validateColumnType(operandParameter.column, ['Number'], 'MIN', context.api);
+                    expressionFunctionUtils_1.validateColumnType(operandParameter.column, ['Number'], 'MIN', context.adaptableApi);
                     const timeframeChange$ = getTrailingGridValueChange$(dataChangeLog$, timeframeParameter.value);
                     return getDataChangeMin$(dataChangeLog$, timeframeChange$);
                 }
                 case 'MAX': {
-                    expressionFunctionUtils_1.validateColumnType(operandParameter.column, ['Number'], 'MAX', context.api);
+                    expressionFunctionUtils_1.validateColumnType(operandParameter.column, ['Number'], 'MAX', context.adaptableApi);
                     const timeframeChange$ = getTrailingGridValueChange$(dataChangeLog$, timeframeParameter.value);
                     return getDataChangeMax$(dataChangeLog$, timeframeChange$);
                 }
@@ -229,11 +229,11 @@ const getDataChangedInfoStub = (context) => {
     var _a;
     let rowNodeStub;
     if (!context.filterFn) {
-        rowNodeStub = context.api.gridApi.getFirstRowNode();
+        rowNodeStub = context.adaptableApi.gridApi.getFirstRowNode();
     }
     else {
         // if there is a WHERE clause defined, find the first rowNode which satisfies the condition
-        context.api.internalApi.forAllRowNodesDo((rowNode) => {
+        context.adaptableApi.internalApi.forAllRowNodesDo((rowNode) => {
             if (!rowNodeStub) {
                 if (context.filterFn(rowNode)) {
                     rowNodeStub = rowNode;
@@ -243,10 +243,10 @@ const getDataChangedInfoStub = (context) => {
     }
     const rowNode = rowNodeStub;
     if (rowNode) {
-        const primaryKeyValue = context.api.gridApi.getPrimaryKeyValueForRowNode(rowNode);
-        const columnId = (_a = context.api.columnApi.getQueryableColumns()[0]) === null || _a === void 0 ? void 0 : _a.columnId;
-        const oldValue = context.api.gridApi.getCellRawValue(primaryKeyValue, columnId);
-        const column = context.api.columnApi.getColumnFromId(columnId);
+        const primaryKeyValue = context.adaptableApi.gridApi.getPrimaryKeyValueForRowNode(rowNode);
+        const columnId = (_a = context.adaptableApi.columnApi.getQueryableColumns()[0]) === null || _a === void 0 ? void 0 : _a.columnId;
+        const oldValue = context.adaptableApi.gridApi.getCellRawValue(primaryKeyValue, columnId);
+        const column = context.adaptableApi.columnApi.getColumnFromId(columnId);
         const newValue = oldValue;
         return {
             changedAt: Date.now(),
@@ -417,7 +417,7 @@ const getSlidingTimeframe$ = (source$, timeframeDuration, onTimeframeEnter, onTi
     }));
 };
 const getMaxTimeframeSize = (expressionValue, context) => {
-    let maxTimeframeSize = context.api.internalApi.getAdaptableOptions().adaptableQLOptions.expressionOptions
+    let maxTimeframeSize = context.adaptableApi.internalApi.getAdaptableOptions().adaptableQLOptions.expressionOptions
         .maxTimeframeSize;
     if (maxTimeframeSize > SYSTEM_MAX_TIMEFRAME_SIZE) {
         maxTimeframeSize = SYSTEM_MAX_TIMEFRAME_SIZE;

package/src/Utilities/ExpressionFunctions/scalarExpressionFunctions.js

@@ -95,14 +95,14 @@ exports.scalarExpressionFunctions = {
         handler(args, context) {
             var _a, _b;
             const columnId = args[0];
-            const column = (_a = context.api) === null || _a === void 0 ? void 0 : _a.columnApi.getColumnFromId(columnId);
+            const column = (_a = context.adaptableApi) === null || _a === void 0 ? void 0 : _a.columnApi.getColumnFromId(columnId);
             if (!column) {
                 throw new ExpressionEvaluationError_1.ExpressionEvaluationError('COL', `Column name "${columnId}" is not found`);
             }
             if (!column.queryable) {
                 throw new ExpressionEvaluationError_1.ExpressionEvaluationError('COL', `Column name "${columnId}" is not queryable`);
             }
-            return (_b = context.api) === null || _b === void 0 ? void 0 : _b.gridApi.getRawValueFromRowNode(context.node, columnId);
+            return (_b = context.adaptableApi) === null || _b === void 0 ? void 0 : _b.gridApi.getRawValueFromRowNode(context.node, columnId);
         },
         description: 'Returns the value of a column',
         signatures: ['[colName]', 'COL(name: string)'],

package/src/Utilities/Services/QueryLanguageService.js

@@ -19,7 +19,7 @@ class QueryLanguageService {
         const booleanAndScalarFunctions = this.getBooleanAndScalarFunctions(moduleExpressionFunctions);
         return parser.evaluate(expression, {
             node: rowNode,
-            api: this.adaptableApi,
+            adaptableApi: this.adaptableApi,
             functions: booleanAndScalarFunctions,
         });
     }
@@ -31,7 +31,7 @@ class QueryLanguageService {
         const aggregatedScalarFunctions = this.getModuleExpressionFunctions(module).aggregatedScalarFunctions;
         return parser.evaluate(expression, {
             node: null,
-            api: this.adaptableApi,
+            adaptableApi: this.adaptableApi,
             functions: aggregatedScalarFunctions,
         });
     }
@@ -40,7 +40,7 @@ class QueryLanguageService {
         const booleanAndScalarFunctions = this.getBooleanAndScalarFunctions(moduleExpressionFunctions);
         const reactiveExpression$ = parser.evaluate(reactiveExpression, {
             node: reactiveExpression,
-            api: this.adaptableApi,
+            adaptableApi: this.adaptableApi,
             functions: moduleExpressionFunctions.observableFunctions,
             whereClauseFunctions: booleanAndScalarFunctions,
         });
@@ -51,7 +51,7 @@ class QueryLanguageService {
         const booleanAndScalarFunctions = this.getBooleanAndScalarFunctions(moduleExpressionFunctions);
         const aggregationExpression$ = parser.evaluate(aggregationExpression, {
             node: aggregationExpression,
-            api: this.adaptableApi,
+            adaptableApi: this.adaptableApi,
             functions: moduleExpressionFunctions.aggregatedBooleanFunctions,
             whereClauseFunctions: booleanAndScalarFunctions,
         });

package/src/components/ExpressionEditor/BaseEditorInput.js

@@ -51,7 +51,7 @@ function BaseEditorInput(props) {
             result = expr.evaluate({
                 // we need a fully-fledged rowNode as Adaptable accesses internal methods of it
                 node: testRowNode,
-                api: props.api,
+                adaptableApi: props.api,
                 functions: expressionFunctions,
             });
         }

package/src/metamodel/adaptable.metamodel.d.ts

@@ -2544,22 +2544,22 @@ export declare const ADAPTABLE_METAMODEL: {
             kind: string;
             description: string;
             uiLabel: string;
-            reference: string;
-            isOptional?: undefined;
+            isOptional: boolean;
+            reference?: undefined;
         } | {
             name: string;
             kind: string;
             description: string;
             uiLabel: string;
-            isOptional: boolean;
-            reference?: undefined;
+            reference: string;
+            isOptional?: undefined;
         } | {
             name: string;
             kind: string;
             description: string;
             uiLabel: string;
-            reference?: undefined;
             isOptional?: undefined;
+            reference?: undefined;
         } | {
             name: string;
             kind: string;