@adaptabletools/adaptable 20.0.0-canary.3 → 20.0.0-canary.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "20.0.0-canary.3",
+  "version": "20.0.0-canary.4",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/src/AdaptableOptions/CellSummaryOptions.d.ts

@@ -9,7 +9,7 @@ export interface CellSummaryOptions<TData = any> {
      */
     customCellSummaryOperations?: CustomCellSummaryOperation<TData>[];
     /**
-     * Numeric format to use for summary value; note relevant Format Columns with a DisplayFormat take precedence over this
+     * Numeric format to use for summary value; a Format Column DisplayFormat will take precedence
      */
     numericDisplayFormat?: NumberFormatterOptions | ((columnContext: AdaptableColumnContext) => NumberFormatterOptions);
 }

package/src/AdaptableOptions/ContainerOptions.d.ts

@@ -16,13 +16,6 @@ export interface ContainerOptions {
      * @gridInfoItem
      */
     agGridContainer?: string | HTMLElement;
-    /**
-     *  How long to wait for AG Grid before giving up trying to connect
-     *
-     * @defaultValue 60s
-     * @gridInfoItem
-     */
-    agGridContainerWaitTimeout?: number;
     /**
      * Name of div where popups appear
      *

package/src/AdaptableOptions/DefaultAdaptableOptions.js

@@ -54,7 +54,6 @@ const DefaultAdaptableOptions = {
     containerOptions: {
         adaptableContainer: 'adaptable',
         agGridContainer: 'grid',
-        agGridContainerWaitTimeout: 60000,
         modalContainer: undefined,
         systemStatusContainer: undefined,
         alertContainer: undefined,

package/src/AdaptableOptions/EditOptions.d.ts

@@ -26,7 +26,7 @@ export interface EditOptions<TData = any> {
      */
     smartEditCustomOperations?: SmartEditCustomOperation<TData>[];
     /**
-     * Dropdown values displayed when column is being edited
+     * Columns that will display a Select dropdown when editing
      */
     showSelectCellEditor?: (currentColumContext: AdaptableColumnContext<TData>) => boolean;
     /**

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -13,7 +13,7 @@ export interface ExportOptions<TData = any> {
      *
      * @defaultValue rawValue
      */
-    exportDataFormat?: DataFormatType | DataFormatDataType | ((dataFormatTypeContext: DataFormatTypeContext<TData>) => DataFormatType);
+    exportDataFormat?: DataFormatType | DataFormatDataType | ((context: AdaptableColumnContext<TData>) => DataFormatType);
     /**
      * Optional custom format for Date columns when exporting
      *
@@ -66,7 +66,7 @@ export interface ExportOptions<TData = any> {
      * Whether a Column is included in System Reports and available in UI for selection
      * @defaultValue true
      */
-    isColumnExportable?: (exportableColumnContext: ExportableColumnContext) => boolean;
+    isColumnExportable?: (context: AdaptableColumnContext) => boolean;
     /**
      * Function invoked before a Report is run, enabling users to preload the data before it is exported
      */
@@ -257,11 +257,6 @@ export interface ReportContext extends BaseExportContext {
      */
     reportData: ExportResultData;
 }
-/**
- * Context used for setting whether a Column is exportable
- */
-export interface ExportableColumnContext extends AdaptableColumnContext {
-}
 /**
  * Context used for providing a custom filename for a Report
  */
@@ -271,23 +266,14 @@ export interface ReportFileNameContext extends BaseExportContext {
      */
     fileName: string;
 }
-/**
- * Context provided when setting a Data Format Type for Export
- */
-export interface DataFormatTypeContext<TData = any> extends BaseContext {
-    /**
-     * Column being exported
-     */
-    column: AdaptableColumn<TData>;
-}
 /**
  * Defines the Format Data Types for all Data Types
  */
 export interface DataFormatDataType {
     /**
-     * Data Format type for String columns
+     * Data Format type for String / Text columns
      */
-    string?: DataFormatType;
+    text?: DataFormatType;
     /**
      * Data Format type for Number columns
      */

package/src/AdaptableOptions/PredicateOptions.d.ts

@@ -36,10 +36,10 @@ export interface PredicateOptions {
      */
     caseSensitivePredicates?: boolean;
     /**
-   * Should Values (IN) Predicate evaluate using datetime (rather than date)
-   * @defaultValue  true
-   * @noCodeItem
-   */
+     * Should Values (IN) Predicate evaluate using datetime (rather than date)
+     * @defaultValue  true
+     * @noCodeItem
+     */
     evaluateValuesPredicateUsingTime?: boolean;
 }
 /**

package/src/Api/Implementation/AdaptableApiImpl.js

@@ -141,6 +141,7 @@ export class AdaptableApiImpl {
         this.formatColumnApi = null;
         this.freeTextColumnApi = null;
         this.gridApi = null;
+        this.rowFormApi = null;
         this.internalApi = null;
         this.layoutApi = null;
         this.pluginsApi = null;

package/src/Api/Implementation/ExportApiImpl.js

@@ -143,10 +143,11 @@ export class ExportApiImpl extends ApiBase {
     isColumnExportable(adaptableColumn) {
         const isExportableFn = this.getExportOptions().isColumnExportable;
         if (typeof isExportableFn === 'function') {
-            return isExportableFn({
+            const adaptableColumnContext = {
                 ...this.getAdaptableInternalApi().buildBaseContext(),
                 column: adaptableColumn,
-            });
+            };
+            return isExportableFn(adaptableColumnContext);
         }
         return true;
     }

package/src/Api/Implementation/ScheduleApiImpl.js

@@ -159,7 +159,7 @@ export class ScheduleApiImpl extends ApiBase {
         }
         else if (scheduleType == 'Report') {
             const reportSchedule = schedule;
-            this.getExportApi().exportReport(reportSchedule.ReportName, reportSchedule.ReportFormat, 'Download');
+            this.getExportApi().exportReport(reportSchedule.ReportName, reportSchedule.ReportFormat, reportSchedule.ExportDestination ?? 'Download');
         }
         else if (scheduleType == 'ipushpull') {
             const ippApi = this.getAdaptableApi().pluginsApi.getipushpullPluginApi();

package/src/Api/Implementation/StyledColumnApiImpl.js

@@ -35,7 +35,7 @@ export class StyledColumnApiImpl extends ApiBase {
         if (!column) {
             return false;
         }
-        return !!this.getStyledColumns().find((styledColumn) => !!styledColumn.SparkLineStyle && styledColumn.ColumnId === column.columnId);
+        return !!this.getStyledColumns().find((styledColumn) => !!styledColumn.SparklineStyle && styledColumn.ColumnId === column.columnId);
     }
     getActiveStyledColumnForColumn(column) {
         const styledColumns = this.getActiveStyledColumns();

package/src/Api/Internal/EventInternalApi.js

@@ -59,7 +59,12 @@ export class EventInternalApi extends ApiBase {
             isToolbarStateChangedToHidden,
         };
         if (!isEqual(oldDashboardState, newDashboardState)) {
-            setTimeout(() => this.getEventApi().emit('DashboardChanged', dashboardChangedInfo));
+            setTimeout(() => {
+                const eventApi = this.getEventApi();
+                if (eventApi) {
+                    eventApi.emit('DashboardChanged', dashboardChangedInfo);
+                }
+            });
         }
     }
     fireAlertFiredEvent(alertToFire) {

package/src/Api/Internal/ExportInternalApi.js

@@ -113,7 +113,7 @@ export class ExportInternalApi extends ApiBase {
             // format is customized based on column data type
             switch (columnDataType) {
                 case 'text':
-                    return dataFormatDataType.string;
+                    return dataFormatDataType.text;
                 case 'number':
                     return dataFormatDataType.number;
                 case 'date':

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

@@ -5,7 +5,7 @@ import { BaseContext } from './BaseContext';
  */
 export interface AdaptableColumnContext<TData = any> extends BaseContext {
     /**
-     * Column being filtered
+     * The current Column
      */
     column: AdaptableColumn<TData>;
 }

package/src/PredefinedConfig/ExportState.d.ts

@@ -3,9 +3,9 @@ import { BaseSchedule } from './Common/Schedule';
 import { ColumnScope } from './Common/ColumnScope';
 import { AdaptableColumnBase } from './Common/AdaptableColumn';
 import { AdaptableObject } from './Common/AdaptableObject';
-import { AdaptableFormData } from './Common/AdaptableForm';
 import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
 import { TypeHint } from './Common/Types';
+import { ExportDestinationType } from '../AdaptableOptions/ExportOptions';
 /**
  * Predefined Configuration for Export Module
  */
@@ -61,9 +61,9 @@ export interface ReportSchedule extends BaseSchedule {
      */
     ReportFormat: ReportFormatType;
     /**
-     * Additional data for a Custom Destination produced by a Dynamic Form
+     * Destination of Report to run on Schedule
      */
-    ExportDestinationData?: AdaptableFormData;
+    ExportDestination?: ExportDestinationType;
 }
 /**
  * Defines the data in a Report run by AdapTable

package/src/PredefinedConfig/LayoutState.d.ts

@@ -100,19 +100,19 @@ export interface TableLayout extends LayoutBase {
      */
     RowGroupDisplayType?: 'single' | 'multi';
     /**
-     * Pivot Columns - can NOT be provided
+     * Pivot Columns - must NOT be provided
      */
     PivotColumns?: never;
     /**
-     * Pivot Group Columns - can NOT be provided
+     * Pivot Group Columns - must NOT be provided
      */
     PivotGroupedColumns?: never;
     /**
-     * Pivot Expansions - can NOT be provided
+     * Pivot Expansions - must NOT be provided
      */
     PivotExpandLevel?: never;
     /**
-     * Pivot Aggregation Columns - can NOT be provided
+     * Pivot Aggregation Columns - must NOT be provided
      */
     PivotAggregationColumns?: never;
 }
@@ -137,31 +137,31 @@ export interface PivotLayout extends LayoutBase {
      */
     PivotGroupedColumns?: string[];
     /**
-     * Table Columns - can NOT be provided
+     * Table Columns - must NOT be provided
      */
     TableColumns?: never;
     /**
-     * Table Aggregation Columns - can NOT be provided
+     * Table Aggregation Columns - must NOT be provided
      */
     TableAggregationColumns?: never;
     /**
-     * Row Grouped Columns Columns - can NOT be provided
+     * Row Grouped Columns Columns - must NOT be provided
      */
     RowGroupedColumns?: never;
 }
-/**
- * Object used for defining which Row Group Values are Expanded or Collapsed
- */
-export type RowGroupValuesWithExceptionKeys = {
-    RowGroupDefaultBehavior: 'expanded' | 'collapsed';
-    ExceptionGroupKeys?: any[][];
-};
 /**
  * Manages how (and which) Row Group values are stored
  */
 export type RowGroupValues = {
     RowGroupDefaultBehavior: 'always-expanded' | 'always-collapsed';
 } | RowGroupValuesWithExceptionKeys;
+/**
+ * Defines which Row Group Values are expanded or collapsed
+ */
+export type RowGroupValuesWithExceptionKeys = {
+    RowGroupDefaultBehavior: 'expanded' | 'collapsed';
+    ExceptionGroupKeys?: any[][];
+};
 /**
  * Defines a map of Columns with a String value
  */

package/src/PredefinedConfig/StyledColumnState.d.ts

@@ -32,7 +32,7 @@ export interface StyledColumn extends SuspendableObject {
     /**
      * Displays a Sparkline Chart in an array column
      */
-    SparkLineStyle?: SparklineStyle;
+    SparklineStyle?: SparklineStyle;
     /**
      * Displays cell values in Column as a Badge
      */

package/src/Strategy/StyledColumnModule.js

@@ -35,12 +35,12 @@ export class StyledColumnModule extends AdaptableModuleBase {
                     // because if just one then it was created in AG Grid and we dont want to edit it
                 }
                 else {
-                    const hasSparklineStyle = styledColumn != null && styledColumn.SparkLineStyle != null;
+                    const hasSparklineStyle = styledColumn != null && styledColumn.SparklineStyle != null;
                     if (!hasSparklineStyle) {
                         styledColumn = {
                             ...ObjectFactory.CreateEmptyStyledColumn(),
                             ColumnId: column.columnId,
-                            SparkLineStyle: {},
+                            SparklineStyle: {},
                         };
                     }
                     let label = hasSparklineStyle ? 'Edit ' : 'Create ';
@@ -48,7 +48,7 @@ export class StyledColumnModule extends AdaptableModuleBase {
                         ? 'styled-column-sparkline-edit'
                         : 'styled-column-sparkline-add';
                     let popupParam = {
-                        action: sparklineColumnExists ? 'Edit' : 'New',
+                        action: hasSparklineStyle ? 'Edit' : 'New',
                         source: 'ColumnMenu',
                         value: styledColumn,
                         config: {
@@ -161,7 +161,7 @@ export class StyledColumnModule extends AdaptableModuleBase {
         else if (styledColumn.PercentBarStyle) {
             return 'percent';
         }
-        else if (styledColumn.SparkLineStyle) {
+        else if (styledColumn.SparklineStyle) {
             return 'spark-line';
         }
         else if (styledColumn.BadgeStyle) {
@@ -248,7 +248,7 @@ export class StyledColumnModule extends AdaptableModuleBase {
         else if (styledColumn.PercentBarStyle) {
             type = 'Percent Bar';
         }
-        else if (styledColumn.SparkLineStyle) {
+        else if (styledColumn.SparklineStyle) {
             type = 'Spark Line';
         }
         else if (styledColumn.BadgeStyle) {
@@ -264,7 +264,7 @@ export class StyledColumnModule extends AdaptableModuleBase {
         else if (styledColumn.PercentBarStyle) {
             type = 'styled-column-percent-bar-edit';
         }
-        else if (styledColumn.SparkLineStyle) {
+        else if (styledColumn.SparklineStyle) {
             type = 'styled-column-sparkline-edit';
         }
         else if (styledColumn.BadgeStyle) {

package/src/Utilities/ObjectFactory.js

@@ -162,6 +162,7 @@ export function CreateEmptyReportSchedule() {
         Schedule: CreateEmptySchedule(),
         ReportName: EMPTY_STRING,
         ReportFormat: EMPTY_STRING,
+        ExportDestination: 'Download',
     };
 }
 export function CreateEmptyIPushPullReport() {

package/src/View/Schedule/Wizard/ScheduleSettingsWizard/ScheduleSettingsReport.d.ts

@@ -1,10 +1,12 @@
 import * as React from 'react';
+import { ExportDestinationType } from '../../../../AdaptableOptions/ExportOptions';
 import { Report, ReportFormatType, ReportSchedule } from '../../../../PredefinedConfig/ExportState';
 interface ReportScheduleProps {
     report: ReportSchedule;
     onChange: (reminder: ReportSchedule) => void;
     allReports: Report[];
     allFormats: ReportFormatType[];
+    allDestinations: ExportDestinationType[];
 }
 export declare const ScheduleSettingsReport: React.FunctionComponent<ReportScheduleProps>;
 export {};

package/src/View/Schedule/Wizard/ScheduleSettingsWizard/ScheduleSettingsReport.js

@@ -18,14 +18,24 @@ export const ScheduleSettingsReport = (props) => {
             });
         },
     }));
+    const destinationOptions = props.allDestinations.map((destination) => ({
+        label: destination,
+        value: destination,
+        onClick: () => {
+            props.onChange({
+                ...props.report,
+                ExportDestination: destination,
+            });
+        },
+    }));
     return (React.createElement(Box, { "data-name": "schedule-settings-report" },
         React.createElement(Tabs, { autoFocus: false, mb: 3 },
-            React.createElement(Tabs.Tab, null, "Report Schedule Settings"),
+            React.createElement(Tabs.Tab, null, "Report Settings"),
             React.createElement(Tabs.Content, null,
                 React.createElement(FormLayout, null,
                     React.createElement(FormRow, { label: "Export" },
                         React.createElement(Box, { maxWidth: 300 },
-                            React.createElement(Select, { "data-name": "select-export", options: reportOptions, value: props?.report?.ReportName, placeholder: "Select Export", onChange: (value) => props.onChange({
+                            React.createElement(Select, { "data-name": "select-report", options: reportOptions, value: props?.report?.ReportName, placeholder: "Select Export", onChange: (value) => props.onChange({
                                     ...props.report,
                                     ReportName: value,
                                 }) }))),
@@ -34,5 +44,11 @@ export const ScheduleSettingsReport = (props) => {
                             React.createElement(Select, { "data-name": "select-format", options: formatOptions, value: props?.report?.ReportFormat, placeholder: "Select Format", onChange: (value) => props.onChange({
                                     ...props.report,
                                     ReportFormat: value,
+                                }) }))),
+                    React.createElement(FormRow, { label: "Destination" },
+                        React.createElement(Box, { maxWidth: 300 },
+                            React.createElement(Select, { "data-name": "select-destination", options: destinationOptions, value: props?.report?.ExportDestination, placeholder: "Select Format", onChange: (value) => props.onChange({
+                                    ...props.report,
+                                    ExportDestination: value,
                                 }) }))))))));
 };

package/src/View/Schedule/Wizard/ScheduleSettingsWizard/ScheduleSettingsSummary.js

@@ -39,6 +39,10 @@ export const getScheduleSettingsValues = (data) => {
                 label: 'Report Format',
                 value: report?.ReportFormat || 'Not Specified',
             },
+            {
+                label: 'Export Destination',
+                value: report?.ExportDestination || 'Download',
+            },
         ];
     }
     if (data.ScheduleType === ScheduleType.ipushpull) {

package/src/View/Schedule/Wizard/ScheduleSettingsWizard/ScheduleSettingsWizard.js

@@ -13,7 +13,8 @@ export const ScheduleSettingsWizard = (props) => {
     }
     if (data?.ScheduleType === ScheduleType.Report) {
         const allFormats = api.exportApi.getAvailableSystemFormats();
-        return (React.createElement(ScheduleSettingsReport, { allReports: allReports ?? [], allFormats: allFormats ?? [], report: data, onChange: props.onChange }));
+        const allDestinations = api.exportApi.getAllExportDestinations();
+        return (React.createElement(ScheduleSettingsReport, { allReports: allReports ?? [], allFormats: allFormats ?? [], allDestinations: allDestinations ?? [], report: data, onChange: props.onChange }));
     }
     if (data?.ScheduleType === ScheduleType.ipushpull) {
         const ippApi = api.pluginsApi.getipushpullPluginApi();

package/src/View/StyledColumn/Wizard/StyledColumnSparklineSettingsSection.d.ts

@@ -1,6 +1,5 @@
 import * as React from 'react';
-import { StyledColumn } from '../../../types';
-export interface StyledColumnSparklineSettingsSectionProps {
+import type { StyledColumn } from '../../../types';
+export declare const StyledColumnSparklineSettingsSection: React.FC<{
     onChange: (data: StyledColumn) => void;
-}
-export declare const StyledColumnSparklineSettingsSection: React.FunctionComponent<StyledColumnSparklineSettingsSectionProps>;
+}>;