@adaptabletools/adaptable 13.0.4 → 13.0.5

package/package.json

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

package/publishTimestamp.js

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

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -221,6 +221,7 @@ export interface IAdaptable {
     canHaveSparklines(): boolean;
     showCharts(charts: ChartModel[]): ChartRef[];
     getChartModels(): ChartModel[];
+    getRowModel(): GridOptions['rowModelType'];
     getCurrentIPPStyle(): IPPStyle;
     getDefaultIPPStyle(): IPPStyle;
     getRowCount(): number;

package/src/AdaptableOptions/GeneralOptions.d.ts

@@ -38,12 +38,10 @@ export interface GeneralOptions {
      */
     alternativeModuleNames?: AlternativeModuleName[];
     /**
-     * Calendar to use for calculating Holidays & Working Days
-     *
-     * @defaultValue 'United Kingdom'
-     * @gridInfoItem
+     * Holidays - used to determine Working Days
+     * @defaultValue null
      */
-    currentCalendar?: string;
+    holidays?: Holidays;
     /**
      * English variant to use in UI labels
      *
@@ -120,3 +118,33 @@ export interface UnbalancedGroupsKeyContext extends BaseContext {
      */
     params: KeyCreatorParams;
 }
+/**
+ * Holidays - can be list or function (latter takes preference)
+ */
+export interface Holidays {
+    /**
+     * Holidays provided as valid ISO date strings
+     */
+    list?: string[];
+    /**
+     * Function which returns true if given date is a holiday
+     */
+    isHoliday?: (holidayContext: HolidayContext) => boolean;
+}
+/**
+ * Context used for isHoliday function
+ */
+export interface HolidayContext {
+    /**
+     * Date being checked
+     */
+    dateToCheck: Date;
+    /**
+     * Name of Current User
+     */
+    userName: string;
+    /**
+     * Id of current AdapTable instance
+     */
+    adaptableId: string;
+}

package/src/Api/AdaptableApi.d.ts

@@ -1,6 +1,7 @@
 import { AlertApi } from './AlertApi';
 import { PluginsApi } from './PluginsApi';
 import { BulkUpdateApi } from './BulkUpdateApi';
+import { CalendarApi } from './CalendarApi';
 import { CalculatedColumnApi } from './CalculatedColumnApi';
 import { CellSummaryApi } from './CellSummaryApi';
 import { ConfigApi } from './ConfigApi';
@@ -61,6 +62,10 @@ export interface AdaptableApi {
      * Provides access to the Bulk Update Module
      */
     bulkUpdateApi: BulkUpdateApi;
+    /**
+     * Functions for managing Holidays
+     */
+    calendarApi: CalendarApi;
     /**
      * Provides access to the Calculated Column Module
      */

package/src/Api/CalendarApi.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Calendar, Holiday and Working Day related functions, using supplied Calendars in General Options
+ **/
+export interface CalendarApi {
+    /**
+     * Returns the next Working Day
+     */
+    getNextWorkingDay(): Date;
+    /**
+     * Returns the previous Working Day
+     */
+    getPreviousWorkingDay(): Date;
+    /**
+     * Checks if given date is a Working Day
+     * @param dateToCheck Date To Check
+     */
+    isWorkingDay(dateToCheck: Date): boolean;
+    /**
+     * Checks if given data is a Holiday
+     * @param dateToCheck Date to Check
+     */
+    isHoliday(dateToCheck: Date): boolean;
+    /**
+     * Returns true if both Dates are the same, ignoring the time portions
+     * @param date1 1st Date
+     * @param date2 2nd Date
+     */
+    isSameDay(date1: Date, date2: Date): boolean;
+}

package/src/Api/CalendarApi.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -2,6 +2,7 @@ import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { AdaptableApi, SettingsPanelApi } from '../../types';
 import { AlertApi } from '../AlertApi';
 import { BulkUpdateApi } from '../BulkUpdateApi';
+import { CalendarApi } from '../CalendarApi';
 import { CalculatedColumnApi } from '../CalculatedColumnApi';
 import { CellSummaryApi } from '../CellSummaryApi';
 import { ConfigApi } from '../ConfigApi';
@@ -47,6 +48,7 @@ export declare class AdaptableApiImpl implements AdaptableApi {
     flashingCellApi: FlashingCellApi;
     predicateApi: PredicateApi;
     bulkUpdateApi: BulkUpdateApi;
+    calendarApi: CalendarApi;
     calculatedColumnApi: CalculatedColumnApi;
     cellSummaryApi: CellSummaryApi;
     columnApi: ColumnApi;

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -41,6 +41,7 @@ const ChartingApiImpl_1 = require("./ChartingApiImpl");
 const SettingsPanelApiImpl_1 = require("./SettingsPanelApiImpl");
 const ActionApiImpl_1 = require("./ActionApiImpl");
 const StyledColumnApiImpl_1 = require("./StyledColumnApiImpl");
+const CalendarApiImpl_1 = require("./CalendarApiImpl");
 class AdaptableApiImpl {
     constructor(adaptable) {
         this.adaptable = adaptable;
@@ -53,6 +54,7 @@ class AdaptableApiImpl {
         this.predicateApi = new PredicateApiImpl_1.PredicateApiImpl(adaptable);
         this.pluginsApi = new PluginsApiImpl_1.PluginsApiImpl(adaptable);
         this.bulkUpdateApi = new BulkUpdateApiImpl_1.BulkUpdateApiImpl(adaptable);
+        this.calendarApi = new CalendarApiImpl_1.CalendarApiImpl(adaptable);
         this.calculatedColumnApi = new CalculatedColumnApiImpl_1.CalculatedColumnApiImpl(adaptable);
         this.cellSummaryApi = new CellSummaryApiImpl_1.CellSummaryApiImpl(adaptable);
         this.columnApi = new ColumnApiImpl_1.ColumnApiImpl(adaptable);

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

@@ -0,0 +1,9 @@
+import { ApiBase } from './ApiBase';
+import { CalendarApi } from '../CalendarApi';
+export declare class CalendarApiImpl extends ApiBase implements CalendarApi {
+    getNextWorkingDay(): Date;
+    getPreviousWorkingDay(): Date;
+    isWorkingDay(dateToCheck: Date): boolean;
+    isHoliday(dateToCheck: Date): boolean;
+    isSameDay(firstDateToCheck: Date, secondDateToCheck: Date): boolean;
+}

package/src/Api/Implementation/CalendarApiImpl.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CalendarApiImpl = void 0;
+const ApiBase_1 = require("./ApiBase");
+class CalendarApiImpl extends ApiBase_1.ApiBase {
+    getNextWorkingDay() {
+        let counterDate = new Date();
+        let isWorkingDay = false;
+        while (!isWorkingDay) {
+            counterDate.setDate(counterDate.getDate() + 1);
+            isWorkingDay = this.isWorkingDay(counterDate);
+        }
+        return counterDate;
+    }
+    getPreviousWorkingDay() {
+        let counterDate = new Date();
+        let isWorkingDay = false;
+        while (!isWorkingDay) {
+            counterDate.setDate(counterDate.getDate() - 1);
+            isWorkingDay = this.isWorkingDay(counterDate);
+        }
+        return counterDate;
+    }
+    isWorkingDay(dateToCheck) {
+        const holidays = this.getGeneralOptions().holidays;
+        if (holidays.isHoliday) {
+            const context = {
+                dateToCheck: dateToCheck,
+                userName: this.getOptions().userName,
+                adaptableId: this.getOptions().adaptableId,
+            };
+            if (holidays.isHoliday(context)) {
+                return false;
+            }
+        }
+        if (Array.isArray(holidays.list)) {
+            for (let holiday of holidays.list) {
+                let holidayDate = new Date(holiday);
+                if (holidayDate.setHours(0, 0, 0, 0) == dateToCheck.setHours(0, 0, 0, 0)) {
+                    return false;
+                }
+            }
+        }
+        return dateToCheck.getDay() != 0 && dateToCheck.getDay() != 6;
+    }
+    isHoliday(dateToCheck) {
+        return !this.isWorkingDay(dateToCheck);
+    }
+    isSameDay(firstDateToCheck, secondDateToCheck) {
+        return (firstDateToCheck.getFullYear() === secondDateToCheck.getFullYear() &&
+            firstDateToCheck.getMonth() === secondDateToCheck.getMonth() &&
+            firstDateToCheck.getDate() === secondDateToCheck.getDate());
+    }
+}
+exports.CalendarApiImpl = CalendarApiImpl;

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

@@ -60,6 +60,7 @@ export declare class InternalApiImpl extends ApiBase implements InternalApi {
     showPopupScreen(module: AdaptableModule, componentName: string, popupParams?: ModuleParams, popupProps?: {
         [key: string]: any;
     }): void;
+    showPopupWindow(id: string, title: string, icon: string, popupProps: any): void;
     hidePopupScreen(): void;
     setColumns(columns: AdaptableColumn[]): void;
     setSettingPanelModuleMenuItems(menuItems: AdaptableMenuItem[]): void;

package/src/Api/Implementation/InternalApiImpl.js

@@ -146,6 +146,14 @@ class InternalApiImpl extends ApiBase_1.ApiBase {
     showPopupScreen(module, componentName, popupParams, popupProps) {
         this.dispatchAction(PopupRedux.PopupShowScreen(module, componentName, popupParams, popupProps));
     }
+    showPopupWindow(id, title, icon, popupProps) {
+        this.dispatchAction(PopupRedux.PopupShowWindow({
+            Id: id,
+            Title: title,
+            Icon: icon,
+            PopupProps: popupProps,
+        }));
+    }
     hidePopupScreen() {
         this.dispatchAction(PopupRedux.PopupHideScreen());
     }

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

@@ -45,4 +45,11 @@ export declare class LayoutApiImpl extends ApiBase implements LayoutApi {
     removeColumnFromCurrentLayout(columnId: string): void;
     removeColumnFromAllLayouts(columnId: string): void;
     removeColumnFromLayout(columnId: string, layoutName: string): void;
+    getLayoutSupportedFeatures(): {
+        RowGroupedColumns: boolean;
+        AggregationColumns: boolean;
+        PivotColumns: boolean;
+        ColumnFilters: boolean;
+        ColumnSorts: boolean;
+    };
 }

package/src/Api/Implementation/LayoutApiImpl.js

@@ -334,5 +334,20 @@ class LayoutApiImpl extends ApiBase_1.ApiBase {
             }
         }
     }
+    getLayoutSupportedFeatures() {
+        const layoutSupportedFeatures = {
+            RowGroupedColumns: true,
+            AggregationColumns: true,
+            PivotColumns: true,
+            ColumnFilters: true,
+            ColumnSorts: true,
+        };
+        if (this.adaptable.getRowModel() === 'viewport') {
+            layoutSupportedFeatures.RowGroupedColumns = false;
+            layoutSupportedFeatures.AggregationColumns = false;
+            layoutSupportedFeatures.PivotColumns = false;
+        }
+        return layoutSupportedFeatures;
+    }
 }
 exports.LayoutApiImpl = LayoutApiImpl;

package/src/Api/Implementation/QueryApiImpl.js

@@ -79,14 +79,9 @@ class QueryApiImpl extends ApiBase_1.ApiBase {
     }
     expandCurrentQuery(query) {
         const preparedQuery = query !== null && query !== void 0 ? query : this.getCurrentQuery();
-        this.dispatchAction(PopupRedux.PopupShowWindow({
-            Id: windowFactory_1.WINDOW_QUERY_EDITOR,
-            Title: 'Current Query',
-            Icon: 'query',
-            PopupProps: {
-                value: preparedQuery,
-            },
-        }));
+        this.getAdaptableApi().internalApi.showPopupWindow(windowFactory_1.WINDOW_QUERY_EDITOR, 'Current Query', 'query', {
+            value: preparedQuery,
+        });
     }
     fireQueryRunEvent() {
         if (this.adaptable.isLive) {

package/src/Api/InternalApi.d.ts

@@ -63,6 +63,7 @@ export interface InternalApi {
     showPopupScreen(module: AdaptableModule, componentName: string, popupParams?: ModuleParams, popupProps?: {
         [key: string]: any;
     }): void;
+    showPopupWindow(Id: string, Title: string, Icon: string, PopupProps: any): void;
     isDocumentationLinksDisplayed(): boolean;
     hidePopupScreen(): void;
     setColumns(columns: AdaptableColumn[]): void;

package/src/Api/LayoutApi.d.ts

@@ -203,4 +203,15 @@ export interface LayoutApi {
      * Useful when `autoSaveLayouts=true`
      */
     areDraftAndCurrentLayoutEqual(): boolean;
+    /**
+     * Returns whant the layout supports.
+     * This takes into account the data-source.
+     */
+    getLayoutSupportedFeatures(): {
+        RowGroupedColumns: boolean;
+        AggregationColumns: boolean;
+        PivotColumns: boolean;
+        ColumnFilters: boolean;
+        ColumnSorts: boolean;
+    };
 }

package/src/PredefinedConfig/Common/AdaptablePredicate.d.ts

@@ -103,7 +103,7 @@ export interface PredicateDefHandlerParams {
 export interface PredicateDefToStringParams {
     inputs: any[];
 }
-export declare type ModuleScope = 'filter' | 'alert' | 'conditionalstyle' | 'flashingcell' | 'formatColumn';
+export declare type ModuleScope = 'filter' | 'alert' | 'flashingcell' | 'formatColumn';
 /**
  * Array of Predicate Defs which are shipped by AdapTable
  */