@adaptabletools/adaptable 13.0.5 → 13.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "13.0.5",
+  "version": "13.0.7",
   "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: 1667157994936;
+declare const _default: 1667316496830;
 export default _default;

package/publishTimestamp.js

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

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -1,7 +1,8 @@
 import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
 import { FilterActionOnDataChange } from '../PredefinedConfig/Common/FilterActionOnDataChange';
-import { SystemFilterPredicateId, SystemFilterPredicateIds } from '../../types';
+import { AdaptablePredicateDef, SystemFilterPredicateId, SystemFilterPredicateIds } from '../../types';
 import { StrictExtract } from '../Utilities/Extensions/TypeExtensions';
+import { BaseContext } from '../types';
 /**
  * Options for managing Filtering in AdapTable
  */
@@ -148,9 +149,9 @@ export interface FilterOptions {
      */
     enableFilterOnSpecialColumns?: boolean;
     /**
-     * Which Adaptable System Filter Predicates are available
+     * Set which System Filter Predicates are available, using list or function
      */
-    systemFilters?: SystemFilterPredicateIds;
+    systemFilters?: SystemFilterPredicateIds | ((context: SystemFiltersPredicateContext) => SystemFilterPredicateIds);
     /**
      * Whether to display Quick Filter Bar between Column Header and the Grid (provided its been setup)
      * @defaultValue  true
@@ -176,3 +177,12 @@ export interface FilterOptions {
      */
     showSuspendFilterButton?: boolean;
 }
+/**
+ * Context used for providing System Filters
+ */
+export interface SystemFiltersPredicateContext extends BaseContext {
+    /**
+     * AdapTable-provided System Filter Predicate Definitions
+     */
+    systemFiltersPredicateDefs: AdaptablePredicateDef[];
+}

package/src/AdaptableOptions/FinancePluginOptions.d.ts

@@ -127,11 +127,11 @@ export interface InstrumentColumn extends FDC3Column {
      */
     permidColumnId?: string;
     /**
-     * Column which holds a FIGI value as instrument data
+     * Column which holds a [FIGI](https://www.openfigi.com/about/figi) value as instrument data
      */
     figiColumnId?: string;
     /**
-     * FDC3 Intents invoked by Column; can be: `ViewChart` `ViewQuote` `ViewNews` `ViewAnalysis` `ViewInstrument`
+     * Instrument-related FDC3 Intents; can be: `ViewChart` `ViewQuote` `ViewNews` `ViewAnalysis` `ViewInstrument`
      */
     intents?: InstrumentIntents;
 }
@@ -152,7 +152,7 @@ export interface PositionColumn extends FDC3Column {
      */
     instrumentColumnId: string;
     /**
-     * FDC3 Intents invoked by Column; can be: `ViewChart` `ViewNews` `ViewAnalysis`
+     * Position-related FDC3 Intents; can be: `ViewChart` `ViewNews` `ViewAnalysis`
      */
     intents?: PositionIntents;
 }
@@ -178,7 +178,7 @@ export interface ContactColumn extends FDC3Column {
      */
     fds_idColumnId?: string;
     /**
-     * FDC3 Intents invoked by Column; can be: `StartCall` `StartChat` `ViewContact`
+     * Contact-related FDC3 Intents; can be: `StartCall` `StartChat` `ViewContact`
      */
     intents?: ContactIntents;
 }
@@ -207,7 +207,7 @@ export interface OrganizationColumn extends FDC3Column {
      */
     fds_idColumnId?: string;
     /**
-     * FDC3 Intents invoked by Column; can be: `ViewNews` `ViewAnalysis`
+     * Organization-related FDC3 Intents; can be: `ViewNews` `ViewAnalysis`
      */
     intents?: OrganizationIntents;
 }
@@ -229,7 +229,7 @@ export interface CountryColumn extends FDC3Column {
      */
     isoalpha3ColumnId?: string;
     /**
-     * FDC3 Intents invoked by Column; can be: `ViewChart`
+     * Country-related FDC3 Intents; can only be: `ViewChart`
      */
     intents?: CountryIntents;
 }

package/src/AdaptableOptions/GeneralOptions.d.ts

@@ -134,7 +134,7 @@ export interface Holidays {
 /**
  * Context used for isHoliday function
  */
-export interface HolidayContext {
+export interface HolidayContext extends BaseContext {
     /**
      * Date being checked
      */

package/src/AdaptableOptions/LayoutOptions.d.ts

@@ -66,6 +66,10 @@ export interface LayoutOptions {
      * Options for leveraging Object Tags to extend Layouts
      */
     layoutTagOptions?: LayoutTagOptions;
+    /**
+     * Columns displayed in Table that opens when viewing contents of Pivot Cells
+     */
+    pivotPreviewColumns?: string[] | ((context: PivotPreviewColumnsContext) => string[]);
 }
 export interface LayoutTagOptions {
     /**
@@ -132,3 +136,16 @@ export interface AutoGenerateTagsForLayoutsContext extends BaseContext {
      */
     objectTags: AdaptableObjectTag[];
 }
+/**
+ * Context uses for pivotPreviewColumns function in Layout Options
+ */
+export interface PivotPreviewColumnsContext extends BaseContext {
+    /**
+     * Current Layout
+     */
+    layout: Layout;
+    /**
+     * Column being opened
+     */
+    columnId: string;
+}

package/src/Api/AlertApi.d.ts

@@ -172,4 +172,24 @@ export interface AlertApi {
      * @param alertDefinition Alert Definition to use
      */
     getAlertRuleDescription(alertDefinition: AlertDefinition): string;
+    /**
+     * Was Adaptable Alert fired due to a Cell Change
+     * @param alert AdaptableAlert to check
+     */
+    isCellChangedAdaptableAlert(alert: AdaptableAlert): boolean;
+    /**
+     * Was Adaptable Alert fired due to a Row Change
+     * @param alert AdaptableAlert to check
+     */
+    isRowChangedAdaptableAlert(alert: AdaptableAlert): boolean;
+    /**
+     * Is Adaptable Alert a Generic one
+     * @param alert AdaptableAlert to check
+     */
+    isGenericAdaptableAlert(alert: AdaptableAlert): boolean;
+    /**
+     * Returns for the Alert Type for an Adaptable Alert
+     * @param alert AdaptableAlert to check
+     */
+    getAlertTypeForAdaptableAlert(alert: AdaptableAlert): 'cellChanged' | 'rowChanged' | 'generic';
 }

package/src/Api/Implementation/AlertApiImpl.d.ts

@@ -44,4 +44,8 @@ export declare class AlertApiImpl extends ApiBase implements AlertApi {
     unSuspendAlertDefinition(alertDefinition: AlertDefinition): AlertDefinition;
     getAlertDescription(alertDefinition: AlertDefinition, cellDataChangedInfo?: CellDataChangedInfo): string;
     getAlertRuleDescription(alert: AlertDefinition): string;
+    isCellChangedAdaptableAlert(alert: AdaptableAlert): boolean;
+    isRowChangedAdaptableAlert(alert: AdaptableAlert): boolean;
+    isGenericAdaptableAlert(alert: AdaptableAlert): boolean;
+    getAlertTypeForAdaptableAlert(alert: AdaptableAlert): 'cellChanged' | 'rowChanged' | 'generic';
 }

package/src/Api/Implementation/AlertApiImpl.js

@@ -323,5 +323,17 @@ class AlertApiImpl extends ApiBase_1.ApiBase {
             : this.adaptable.api.internalApi.getAdaptableQueryExpressionText(alert.Rule);
         return ruleDescription;
     }
+    isCellChangedAdaptableAlert(alert) {
+        return alert.alertType === 'cellChanged';
+    }
+    isRowChangedAdaptableAlert(alert) {
+        return alert.alertType === 'rowChanged';
+    }
+    isGenericAdaptableAlert(alert) {
+        return alert.alertType === 'generic';
+    }
+    getAlertTypeForAdaptableAlert(alert) {
+        return alert.alertType;
+    }
 }
 exports.AlertApiImpl = AlertApiImpl;

package/src/Api/Implementation/CalendarApiImpl.js

@@ -23,11 +23,15 @@ class CalendarApiImpl extends ApiBase_1.ApiBase {
     }
     isWorkingDay(dateToCheck) {
         const holidays = this.getGeneralOptions().holidays;
+        if (!holidays) {
+            return dateToCheck.getDay() != 0 && dateToCheck.getDay() != 6;
+        }
         if (holidays.isHoliday) {
             const context = {
                 dateToCheck: dateToCheck,
                 userName: this.getOptions().userName,
                 adaptableId: this.getOptions().adaptableId,
+                adaptableApi: this.getAdaptableApi(),
             };
             if (holidays.isHoliday(context)) {
                 return false;

package/src/Api/Implementation/ColumnApiImpl.d.ts

@@ -28,7 +28,7 @@ export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     isDateColumn(column: AdaptableColumn): boolean;
     getColumnDataTypeFromColumnId(columnId: string): AdaptableColumnDataType | undefined;
     getFriendlyNameFromColumn(columnId: string, column: AdaptableColumn): string;
-    getFriendlyNameFromColumnId(columnId: string): string;
+    getFriendlyNameFromColumnId(columnId: string): string | undefined;
     getFriendlyNamesFromColumnIds(columnIds: string[]): string[];
     getColumnIdFromFriendlyName(friendlyName: string): string;
     getColumnIdsFromFriendlyNames(friendlyNames: string[]): string[];

package/src/Api/Implementation/ColumnApiImpl.js

@@ -115,6 +115,9 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         return columnId + GeneralConstants.MISSING_COLUMN;
     }
     getFriendlyNameFromColumnId(columnId) {
+        if (this.isAutoPivotColumn(columnId)) {
+            return GeneralConstants.EMPTY_STRING;
+        }
         const foundColumn = this.getColumns().find((c) => c.columnId == columnId);
         if (foundColumn) {
             return this.getFriendlyNameFromColumn(columnId, foundColumn);
@@ -180,6 +183,9 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         if (ArrayExtensions_1.default.IsNullOrEmpty(this.getColumns())) {
             return;
         }
+        if (this.isAutoPivotColumn(columnId)) {
+            return;
+        }
         const foundColumn = this.getColumns().find((c) => c.columnId == columnId);
         if (foundColumn) {
             return foundColumn;

package/src/Api/Implementation/FilterApiImpl.js

@@ -10,7 +10,15 @@ const LoggingHelper_1 = require("../../Utilities/Helpers/LoggingHelper");
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 class FilterApiImpl extends ApiBase_1.ApiBase {
     getAllSystemFilterIds() {
-        return this.getFilterOptions().systemFilters;
+        const systemFilters = this.getFilterOptions().systemFilters;
+        if (typeof systemFilters === 'function') {
+            const systemFiltersPredicateContext = {
+                adaptableApi: this.adaptable.api,
+                systemFiltersPredicateDefs: this.adaptable.api.predicateApi.getSystemPredicateDefs(),
+            };
+            return systemFilters(systemFiltersPredicateContext);
+        }
+        return systemFilters;
     }
     findPredicateDefByShortcut(shortcut, column) {
         return this.getFilterPredicateDefsForColumn(column).find((i) => { var _a; return (_a = i.shortcuts) === null || _a === void 0 ? void 0 : _a.includes(shortcut); });

package/src/Strategy/LayoutModule.js

@@ -236,7 +236,7 @@ class LayoutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         return returnColumnMenuItems;
     }
     createViewPivotItemsMenuItem(menuContext) {
-        var _a, _b;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         // current group => menuContext.rowNode.field;
         if (((_b = (_a = menuContext.selectedCellInfo) === null || _a === void 0 ? void 0 : _a.gridCells) === null || _b === void 0 ? void 0 : _b.length) !== 1) {
             return;
@@ -251,6 +251,19 @@ class LayoutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         if (!isPivotColumn && this.api.columnApi.getColumnDataTypeFromColumnId(columnId) !== 'Number') {
             return;
         }
+        /**
+         * Cannot base the values on the pivot column id, because the value or the field may have underscrores
+         *
+         *
+         * e.g. pivot_license_MIT License_stargazers_count
+         */
+        // pivot_status_Booked_price
+        // price
+        const aggColumn = (_f = (_e = (_d = (_c = agGridColumn === null || agGridColumn === void 0 ? void 0 : agGridColumn.getColDef) === null || _c === void 0 ? void 0 : _c.call(agGridColumn).pivotValueColumn) === null || _d === void 0 ? void 0 : _d.getColDef) === null || _e === void 0 ? void 0 : _e.call(_d)) === null || _f === void 0 ? void 0 : _f.field;
+        // Booked
+        const pivotValue = (_j = (_h = (_g = agGridColumn === null || agGridColumn === void 0 ? void 0 : agGridColumn.getColDef) === null || _g === void 0 ? void 0 : _g.call(agGridColumn)) === null || _h === void 0 ? void 0 : _h.pivotKeys) === null || _j === void 0 ? void 0 : _j[0];
+        // status - the preview works only with one column
+        const pivotColumnId = (_k = currentLayout === null || currentLayout === void 0 ? void 0 : currentLayout.PivotColumns) === null || _k === void 0 ? void 0 : _k[0];
         function getData(rows) {
             return [
                 ...rows.map((row) => {
@@ -271,6 +284,10 @@ class LayoutModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             columnId,
             rowGroups,
             rows: data,
+            layout: currentLayout,
+            aggColumn,
+            pivotValue,
+            pivotColumnId,
         };
         return {
             isVisible: true,

package/src/View/Layout/PivotDetailsPopoup.js

@@ -14,25 +14,47 @@ const tableDOMProps = {
 };
 const PivotDetailsPopoup = (props) => {
     const adaptable = (0, AdaptableContext_1.useAdaptable)();
-    const primaryKey = adaptable.api.internalApi.getAdaptableOptions().primaryKey;
-    const { hasPivotValue, rows, rowGroups, columnId, } = props.popupProps;
+    const adaptableApi = adaptable.api;
+    const primaryKey = adaptableApi.internalApi.getAdaptableOptions().primaryKey;
+    const { hasPivotValue, rows, rowGroups, columnId, layout, aggColumn, pivotValue, pivotColumnId, } = props.popupProps;
     let data = rows;
-    const getFriendlyName = (columnId) => adaptable.api.columnApi.getFriendlyNameFromColumnId(columnId);
-    let columns = {
-        [primaryKey]: { field: primaryKey, header: getFriendlyName(primaryKey) },
-    };
-    if (hasPivotValue) {
-        const [prefix, pivotColumnId, pivotValue, aggColumn] = columnId.split('_');
-        columns = Object.assign(Object.assign({}, columns), { [aggColumn]: { field: aggColumn, header: getFriendlyName(aggColumn) }, [pivotColumnId]: { field: pivotColumnId, header: getFriendlyName(pivotColumnId) } });
-        data = rows.filter((row) => (row === null || row === void 0 ? void 0 : row[pivotColumnId]) === pivotValue);
-    }
-    else {
-        columns = Object.assign(Object.assign({}, columns), { [columnId]: { field: columnId, header: getFriendlyName(columnId) } });
-    }
-    columns = Object.assign(Object.assign({}, columns), rowGroups.reduce((acc, groupColId) => {
-        acc[groupColId] = { field: groupColId, header: getFriendlyName(groupColId) };
-        return acc;
-    }, {}));
+    const columns = React.useMemo(() => {
+        var _a, _b;
+        const getFriendlyName = (columnId) => adaptableApi.columnApi.getFriendlyNameFromColumnId(columnId);
+        const pivotPreviewOptionColumn = (_b = (_a = adaptableApi.internalApi.getAdaptableOptions()) === null || _a === void 0 ? void 0 : _a.layoutOptions) === null || _b === void 0 ? void 0 : _b.pivotPreviewColumns;
+        let pivotPreviewExtraColumns = [];
+        if (typeof pivotPreviewOptionColumn === 'function') {
+            const pivotPreviewColumnsContext = {
+                layout: layout,
+                columnId: columnId,
+                adaptableApi: adaptableApi,
+            };
+            pivotPreviewExtraColumns = pivotPreviewOptionColumn(pivotPreviewColumnsContext);
+        }
+        else if (Array.isArray(pivotPreviewOptionColumn)) {
+            pivotPreviewExtraColumns = pivotPreviewOptionColumn;
+        }
+        let columns = {
+            [primaryKey]: { field: primaryKey, header: getFriendlyName(primaryKey) },
+        };
+        if (hasPivotValue) {
+            // pivot_license_MIT License_stargazers_count
+            // splitting by _ does not work
+            columns = Object.assign(Object.assign({}, columns), { [aggColumn]: { field: aggColumn, header: getFriendlyName(aggColumn) }, [pivotColumnId]: { field: pivotColumnId, header: getFriendlyName(pivotColumnId) } });
+            data = rows.filter((row) => (row === null || row === void 0 ? void 0 : row[pivotColumnId]) === pivotValue);
+        }
+        else {
+            columns = Object.assign(Object.assign({}, columns), { [columnId]: { field: columnId, header: getFriendlyName(columnId) } });
+        }
+        const extraColumns = [];
+        if (Array.isArray(rowGroups) && rowGroups.length > 0) {
+            extraColumns.push(...rowGroups);
+        }
+        if (Array.isArray(pivotPreviewExtraColumns) && pivotPreviewExtraColumns.length > 0) {
+            extraColumns.push(...pivotPreviewExtraColumns);
+        }
+        return Object.assign(Object.assign({}, columns), extraColumns.reduce((acc, colId) => (Object.assign(Object.assign({}, acc), { [colId]: { field: colId, header: getFriendlyName(colId) } })), {}));
+    }, [props.popupProps]);
     return (React.createElement(InfiniteTable_1.DataSource, { data: data, primaryKey: columnId },
         React.createElement(InfiniteTable_1.InfiniteTable, { columnTypes: {
                 default: {

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

@@ -2873,10 +2873,10 @@ export declare const ADAPTABLE_METAMODEL: {
             description: string;
             uiLabel: string;
             isOptional: boolean;
-            reference: string;
             gridInfo?: undefined;
             noCode?: undefined;
             defaultValue?: undefined;
+            reference?: undefined;
         } | {
             name: string;
             kind: string;
@@ -3766,6 +3766,16 @@ export declare const ADAPTABLE_METAMODEL: {
             gridInfo?: undefined;
             noCode?: undefined;
             defaultValue?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            isOptional: boolean;
+            gridInfo?: undefined;
+            noCode?: undefined;
+            defaultValue?: undefined;
+            reference?: undefined;
         })[];
     };
     LayoutState: {
@@ -4123,6 +4133,24 @@ export declare const ADAPTABLE_METAMODEL: {
             reference: string;
         }[];
     };
+    PivotPreviewColumnsContext: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: ({
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference: string;
+        })[];
+    };
     PluginsApi: {
         name: string;
         kind: string;
@@ -4939,6 +4967,17 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         description: string;
     };
+    SystemFiltersPredicateContext: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+        }[];
+    };
     SystemReportName: {
         name: string;
         kind: string;