@adaptabletools/adaptable 16.0.1-canary.0 → 16.0.1

package/package.json

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

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1691780853920;
+declare const _default: 1692249290030;
 export default _default;

package/publishTimestamp.js

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

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -156,7 +156,8 @@ export interface IAdaptable {
     jumpToColumn(columnId: string): void;
     jumpToCell(columnId: string, rowNode: IRowNode): void;
     getAgGridContainerElement(): HTMLElement | null;
-    setDataSource(dataSource: any): void;
+    setInitialGridData(dataSource: any): void;
+    setGridData(dataSource: any): void;
     getGridData(): any[];
     getFilteredData(): any[];
     updateRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<IRowNode[]>;

package/src/AdaptableOptions/AdaptableOptions.d.ts

@@ -30,6 +30,7 @@ import { CalendarOptions } from './CalendarOptions';
 import { QuickSearchOptions } from './QuickSearchOptions';
 import { FormatColumnOptions } from './FormatColumnOptions';
 import { Fdc3Options } from './Fdc3Options';
+import { CommentOptions } from './CommentsOptions';
 /**
  * Large group of options enabling developers to set up AdapTable at design time to fit precise requirements
  */
@@ -103,7 +104,7 @@ export interface AdaptableOptions<TData = any> {
     /**
      * Options for managing Holidays and Working Days
      */
-    calendarOptions?: CalendarOptions<TData>;
+    calendarOptions?: CalendarOptions;
     /**
      * Options for adding custom Cell Summaries
      */
@@ -122,6 +123,10 @@ export interface AdaptableOptions<TData = any> {
      * Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed
      */
     containerOptions?: ContainerOptions;
+    /**
+     * Options for managing AdapTable Comments
+     */
+    commentOptions?: CommentOptions;
     /**
      * Options for using Custom Sort
      */

package/src/AdaptableOptions/AdaptablePlugin.js

@@ -25,6 +25,8 @@ class AdaptablePlugin {
         return !!this.values[name];
     }
     // plugin lifecycle methods, executed in this exact order
+    // wondering if this is better? 
+    //  beforeInit(adaptableOptions: AdaptableOptions,   gridOptions: GridOptions): void {}
     beforeInit(adaptableOptions) { }
     afterInitOptions(adaptable, adaptableOptions) { }
     afterInitApi(adaptable, api) { }

package/src/AdaptableOptions/CalendarOptions.d.ts

@@ -2,10 +2,10 @@ import { BaseContext } from '../../types';
 /**
  * Options for managing Holidays and Working Days in AdapTable
  */
-export interface CalendarOptions<TData = any> {
+export interface CalendarOptions {
     /**
-     * Holidays - used to determine Working Days
+     * Holidays for current User
      * @defaultValue null
      */
-    holidays?: string[] | ((baseContext: BaseContext) => string[] | undefined);
+    holidays?: Date[] | ((baseContext: BaseContext) => Date[] | undefined);
 }

package/src/AdaptableOptions/CommentsOptions.d.ts

@@ -0,0 +1,23 @@
+import { BaseContext } from '../../types';
+/**
+ * Options for managing AdapTable Comments
+ */
+export interface CommentOptions<TData = any> {
+    /**
+     * Whether a cell can be commented on
+     */
+    isCellCommentable?: (context: CommmentableCellContext) => boolean;
+}
+/**
+ * Context used when determining if a Comment can be added to a Cell
+ */
+export interface CommmentableCellContext extends BaseContext {
+    /**
+     * Value in Primary Key Column
+     */
+    primaryKeyValue: string;
+    /**
+     * Column where Comment will be displayed
+     */
+    columnId: string;
+}

package/src/AdaptableOptions/Fdc3Options.d.ts

@@ -10,80 +10,74 @@ import { ButtonStyle } from '../PredefinedConfig/Common/ButtonStyle';
  */
 export interface Fdc3Options {
     /**
-     * Enable FDC3 in AdapTable
-     *
-     * @defaultValue false
-     */
-    enableFdc3?: boolean;
-    /**
-     * Enable logging of message exchanges in the Console
+     * Enable logging message exchanges to Console
      *
      * @defaultValue false
      */
     enableLogging?: boolean;
     /**
-     * Maps the Context Type to the AdapTable Grid Data
+     * Maps Context Type to AdapTable Grid Data
      */
     gridDataContextMapping?: GridDataContextMapping;
     /**
-     * Builds the Context Data (useful for postprocessing the Context Data mapped from the grid data)
+     * Builds Context Data (useful for postprocessing Context Data mapped from Grid data)
      */
     resolveContextData?: (context: ResolveContextDataContext) => Fdc3Context;
     /**
-     * Configures the FDC3 standard Intents that AdaptTable will listen for and raise
+     * Configures FDC3 standard Intents that AdapTable will listen for and raise
      */
     intents?: {
         /**
-         * Subscribe to the given standard Intent(s)
+         * Subscribe to given standard Intent(s)
          */
         listensFor?: Fdc3IntentType[];
         /**
-         * Raises the given standard Intent(s) on various Grid Actions
+         * Raises given standard Intent(s) on various Grid Actions
          */
         raises?: {
             [K in Fdc3IntentType]?: RaiseIntentConfig<K>[];
         };
     };
     /**
-     * Configures the FDC3 custom Intents that AdaptTable will listen for and raise
+     * Configures FDC3 custom Intents that AdapTable will listen for and raise
      */
     customIntents?: {
         /**
-         * Subscribe to the given custom Intent(s)
+         * Subscribe to given custom Intent(s)
          */
         listensFor?: Fdc3CustomIntentType[];
         /**
-         * Raises the given custom Intent(s) on various Grid Actions
+         * Raises given custom Intent(s) on various Grid Actions
          */
         raises?: {
             [K in Fdc3CustomIntentType]: RaiseIntentConfig[];
         };
     };
     /**
-     * Configures the FDC3 standard Contexts that AdaptTable will listen for and broadcast
+     * Configures FDC3 standard Contexts that AdapTable will listen for and broadcast
      */
     contexts?: {
         /**
-         * Subscribe to the given standard Context(s)
+         * Subscribe to given standard Context(s)
          */
         listensFor?: Fdc3ContextType[];
         /**
-         * Broadcasts the given standard Context(s) on various Grid Actions
+         * Broadcasts given standard Context(s) on various Grid Actions
          */
         broadcasts?: {
             [K in Fdc3ContextType]?: BroadcastConfig;
         };
     };
     /**
-     * Configures the FDC3 custom Contexts that AdaptTable will listen for and broadcast
+     * Configures FDC3 custom Contexts that AdapTable will listen for and broadcast
      */
     customContexts?: {
         /**
-         * Subscribe to the given custom Context(s)
+         * Subscribe to given custom Context(s)
          */
         listensFor?: Fdc3CustomContextType[];
         /**
-         * Broadcasts the given custom Context(s) on various Grid Actions
+         * Broadcasts given custom Context(s) on various Grid Actions
          */
         broadcasts?: {
             [K in Fdc3CustomContextType]?: BroadcastConfig;
@@ -98,49 +92,62 @@ export interface Fdc3Options {
      */
     handleContext?: (context: HandleFdc3Context) => void;
     /**
-     * Customises the FDC3 Actions column
+     * Customises FDC3 Actions column
      */
-    actionColumnDefaultConfiguration?: {
-        /**
-         * @defaultValue 'FDC3 Actions'
-         */
-        headerName?: string;
-        /**
-         * @defaultValue '200' (pixels)
-         */
-        width?: number;
-        /**
-         * @defaultValue true
-         */
-        resizable?: boolean;
-        /**
-         * @defaultValue true
-         */
-        movable?: boolean;
-    };
+    actionColumnDefaultConfiguration?: ActionColumnDefaultConfiguration;
 }
 /**
- * Context used when resolving FDC3 Context Data
+ * Default configuration to use for an FDC3 ACtion Column
+ */
+export interface ActionColumnDefaultConfiguration {
+    /**
+     * Column Id
+     * @defaultValue 'fdc3ActionColumn'
+     */
+    columnId?: string;
+    /**
+     * Column Header
+     * @defaultValue 'FDC3 Actions'
+     */
+    headerName?: string;
+    /**
+     * Column Width in pixels
+     * @defaultValue 200
+     */
+    width?: number;
+    /**
+     * If Column is resizable
+     * @defaultValue true
+     */
+    resizable?: boolean;
+    /**
+     * If Column is moveable
+     * @defaultValue true
+     */
+    movable?: boolean;
+}
+/**
+ * Used to build Context Data
  */
 export interface ResolveContextDataContext extends BaseContext {
     /**
-     * The FDC3 Context Type
+     * FDC3 Context Type
      */
     contextType: Fdc3ContextType | Fdc3CustomContextType;
     /**
-     * The FDC3 Context Data which has been mapped from the grid data based on the given configuration in `gridDataContextMapping`
+     * FDC3 Context Data which has been mapped from the grid data based on the given configuration in `gridDataContextMapping`
      */
     contextMappedFromGridData?: Fdc3Context;
     /**
-     * The row node which is the source of the context data
+     * Row Node which is source of the context data
      */
     rowNode: IRowNode;
     /**
-     * The row data which is the source of the context data
+     * Row data which is the source of the context data
      */
     rowData: any;
     /**
-     * Primary key value of row
+     * Primary Key value of row
      */
     primaryKeyValue: any;
 }
@@ -158,7 +165,7 @@ export interface HandleFdc3Context extends BaseContext {
     metadata?: ContextMetadata;
 }
 /**
- * Context used when handling incoming FDC3 messages
+ * Context used when handling incoming FDC3 Intents
  */
 export interface HandleFdc3IntentContext extends HandleFdc3Context {
     /**
@@ -189,6 +196,9 @@ export declare const ColumnRefTypePrefix = "_colId.";
 export declare const FieldRefTypePrefix = "_field.";
 export declare type GridDataRef = `_colId.${string}` | `_field.${string}`;
 export declare type Fdc3ContentMapping<T> = PropertiesToGridRefs<Omit<T, 'type'>>;
+/**
+ * Config used when raising an FDC3 Intent
+ */
 export interface RaiseIntentConfig<K extends Fdc3IntentType = any> {
     contextType: CompatibleContext<K>;
     contextMenu?: {
@@ -203,6 +213,9 @@ export interface RaiseIntentConfig<K extends Fdc3IntentType = any> {
     };
     handleIntentResolution?: (context: HandleFdc3IntentResolutionContext) => Promise<IntentResult>;
 }
+/**
+ * Config used when broadcasting FDC3 Context
+ */
 export interface BroadcastConfig {
     contextMenu?: {
         columnIds: string[];
@@ -249,33 +262,36 @@ export interface Fdc3ButtonContext extends BaseContext {
      */
     primaryKeyValue: any;
 }
+/**
+ * Button used in FDC3 Action Columns
+ */
 export interface Fdc3AdaptableButton {
     /**
      * Unique id for the button
      */
     id: string;
     /**
-     * Icon for Button - can be object or function that provides a `AdaptableIcon` object
+     * Button's Icon; can be object or function that provides `AdaptableIcon` object
      */
     icon?: '_defaultFdc3' | AdaptableIcon | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => AdaptableIcon);
     /**
-     * Label for Button - can be string or function that provides string
+     * Button' Label; can be string or function that provides string
      */
     label?: '_defaultFdc3' | string | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => string);
     /**
-     * Tooltip for Button - can be string or function that provides string
+     * Button's Tooltip; can be string or function that provides string
      */
     tooltip?: '_defaultFdc3' | string | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => string);
     /**
-     * Style for Button - can be object or function that provides a `ButtonStyle` object
+     * Button's Style; can be object or function that provides `ButtonStyle` object
      */
     buttonStyle?: ButtonStyle | ((button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => ButtonStyle);
     /**
-     * Function that disables / enables the button based on its evaluation result
+     * Function to disable / enable button based on evaluation result
      */
     disabled?: (button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => boolean;
     /**
-     * Function which sets whether Button is hidden
+     * Function to hide the Button
      */
     hidden?: (button: Fdc3AdaptableButton, context: Fdc3ButtonContext) => boolean;
 }

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -7,13 +7,13 @@ import { StrictExtract } from '../Utilities/Extensions/TypeExtensions';
  */
 export interface FilterOptions<TData = any> {
     /**
-     * Hides the Dropdown in Quick Filter Bar for a given Column
+     * Hides Dropdown in Quick Filter Bar for a given Column
      *
      * @defaultValue undefined
      */
     hideQuickFilterDropdown?: (filterContext: FilterContext<TData>) => boolean;
     /**
-     * Hides the Input in Quick Filter Bar for a given Column
+     * Hides Input in Quick Filter Bar for a given Column
      *
      * @defaultValue undefined
      */
@@ -155,6 +155,11 @@ export interface FilterOptions<TData = any> {
      * @noCodeItem
      */
     showQuickFilter?: boolean;
+    /**
+     * If Values filter should filter on datetime rather than date
+     * @defaultValue  true
+     * @noCodeItem
+     */
     filterUsingTime?: boolean;
     /**
      * Display only currently filtered distinct values in Filter controls