@adaptabletools/adaptable 16.0.1-canary.0 → 16.0.1-canary.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "16.0.1-canary.0",
+  "version": "16.0.1-canary.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: 1692167076689;
 export default _default;

package/publishTimestamp.js

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

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/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 of 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 {
     /**

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

package/src/AdaptableOptions/FinancePluginOptions.d.ts

@@ -1,310 +1,6 @@
-import { AdaptableApi, AdaptableIcon, ContextMenuContext, FDC3Context_DEPR, GridCell } from '../../types';
-import { CustomFDC3Context } from '../PredefinedConfig/Common/FDC3Context_DEPR';
 /**
- * Options required for when using the Finance plugin
+ * Removed in Version 16
+ * @deprecated - now provided in FDC3 Options
  */
 export interface FinancePluginOptions {
-    /**
-     * Columns to be defined as FDC3-related
-     */
-    fdc3Columns?: {
-        /**
-         * FDC3 Instruments
-         */
-        instrumentColumns?: InstrumentColumn[];
-        /**
-         * FDC3 Positions
-         */
-        positionColumns?: PositionColumn[];
-        /**
-         * FDC3 Contacts
-         */
-        contactColumns?: ContactColumn[];
-        /**
-         * FDC3 Countries
-         */
-        countryColumns?: CountryColumn[];
-        /**
-         * FDC3 Organizations
-         */
-        organizationColumns?: OrganizationColumn[];
-        /**
-         * Custom FDC3 Columns
-         */
-        customFDC3Columns?: CustomFDC3Column[];
-        /**
-         * Custom FDC3 Intents
-         */
-        customFDC3Intents?: CustomFDC3Intent_Depr[];
-    };
-    /**
-     * Intents to which to subscribe.
-     */
-    availableFDC3Intents?: (FDC3Intent_Depr | CustomFDC3Intent_Depr)[];
-    /**
-     * Whether `FDC3MessageSent` Adaptable events should be automatically delegated to the FDC3 API (either via `fdc3.raiseIntent(...)` or `fdc3.broadcast(...)` )
-     *
-     * @defaultValue TRUE
-     */
-    autoHandleFDC3AdaptableMessages?: boolean;
-    /**
-     * Called when an intent from `availableIntents` is raised.
-     */
-    onFDC3Intent?: (intent: FDC3Intent_Depr | CustomFDC3Intent_Depr, context: FDC3Context_DEPR, adaptableApi: AdaptableApi) => void;
-    /**
-     * Called when a context changes.
-     */
-    onFDC3Context?: (context: FDC3Context_DEPR, adaptableApi: AdaptableApi) => void;
-}
-/**
- * An FDC3 Column - will raise FDC3 intents and broadcast FDC3 messages
- */
-export interface FDC3Column_Depr {
-    /**
-     * Id of Column defined as FDC3
-     */
-    columnId: string;
-    /**
-     * If provided, will supply `name` property in FDC3 message
-     */
-    nameColumnId?: string;
-    /**
-     * Should Column display a 'Broadcast' context menu item
-     */
-    showBroadcastContextMenu?: boolean;
-    /**
-     * Should Column display a 'Raise Intent for Context' context menu item
-     */
-    showRaiseIntentForContextMenu?: boolean;
-    /**
-     * Label to display in Broadcast Context Menu Item
-     */
-    broadcastContextMenuLabel?: string | ((broadcastFDC3MessageContext: ContextMenuContext) => string);
-    /**
-     * Label to display in RaiseIntentForContext Context Menu Item
-     */
-    raiseIntentForContextMenuLabel?: string | ((raiseFDC3IntentForContext: ContextMenuContext) => string);
-    /**
-     * FDC3 intents which the Column can raise
-     */
-    intents?: any[];
-    /**
-     * Label to display in Intent Context Menu Item
-     */
-    intentContextMenuLabel?: string | ((raiseFDC3IntentContext: RaiseFDC3IntentContext) => string);
-    /**
-     * Returns a custom icon to display in the Raise Intent Context Menu Item;
-     */
-    intentIcon?: (intent: FDC3Intent_Depr | CustomFDC3Intent_Depr) => AdaptableIcon;
-}
-/**
- * A Column which will be defined as an FDC3 Instrument
- */
-export interface InstrumentColumn extends FDC3Column_Depr {
-    /**
-     * Column which holds a ticker value as instrument data
-     */
-    tickerColumnId?: string;
-    /**
-     * Column which holds an ISIN value as instrument data
-     */
-    isinColumnId?: string;
-    /**
-     * Column which holds a CUSIP value as instrument data
-     */
-    cusipColumnId?: string;
-    /**
-     * Column which holds a SEDOL value as instrument data
-     */
-    sedolColumnId?: string;
-    /**
-     * Column which holds a Reuters Instrument Code value as instrument data
-     */
-    ricColumnId?: string;
-    /**
-     * Column which holds a Bloomberg Ticker value as instrument data
-     */
-    bbgColumnId?: string;
-    /**
-     * Column which holds a PERMID value as instrument data
-     */
-    permidColumnId?: string;
-    /**
-     * Column which holds a [FIGI](https://www.openfigi.com/about/figi) value as instrument data
-     */
-    figiColumnId?: string;
-    /**
-     * Instrument-related FDC3 Intents; can be: `ViewChart` `ViewQuote` `ViewNews` `ViewAnalysis` `ViewInstrument`
-     */
-    intents?: InstrumentIntents;
-}
-/**
- * All available Instrument Intents
- */
-export declare type InstrumentIntents = InstrumentIntent[];
-/**
- * FDC3 Intents available to an Instrument Column
- */
-export declare type InstrumentIntent = 'ViewChart' | 'ViewQuote' | 'ViewNews' | 'ViewAnalysis' | 'ViewInstrument';
-/**
- *  A (Numeric) Column which will be defined as an FDC3 Position
- */
-export interface PositionColumn extends FDC3Column_Depr {
-    /**
-     * Column which contains the Instrument information of the FDC3 Message
-     */
-    instrumentColumnId: string;
-    /**
-     * Position-related FDC3 Intents; can be: `ViewChart` `ViewNews` `ViewAnalysis`
-     */
-    intents?: PositionIntents;
-}
-/**
- * All available Position Intents
- */
-export declare type PositionIntents = PositionIntent[];
-/**
- * FDC3 Intents available to a Position Column
- */
-export declare type PositionIntent = 'ViewChart' | 'ViewNews' | 'ViewAnalysis';
-/**
- *  A (String) Column which will be defined as an FDC3 Contact
- *  columnId and at least one other property is required
- */
-export interface ContactColumn extends FDC3Column_Depr {
-    /**
-     * Column which holds the email address of a Contact
-     */
-    emailColumnId?: string;
-    /**
-     * Column which holds an FDS_ID value a Contact
-     */
-    fds_idColumnId?: string;
-    /**
-     * Contact-related FDC3 Intents; can be: `StartCall` `StartChat` `ViewContact`
-     */
-    intents?: ContactIntents;
-}
-/**
- * All available Contact Intents
- */
-export declare type ContactIntents = ContactIntent[];
-/**
- * FDC3 Intents available to a Contact Column
- */
-export declare type ContactIntent = 'StartCall' | 'StartChat' | 'ViewContact';
-/**
- *  A (String) Column which will be defined as an FDC3 Organization
- */
-export interface OrganizationColumn extends FDC3Column_Depr {
-    /**
-     * Column which contains the LEI
-     */
-    leiColumnId?: string;
-    /**
-     * Column which contains a PermId
-     */
-    permidColumnId?: string;
-    /**
-     * Column which contains an FDS_ID
-     */
-    fds_idColumnId?: string;
-    /**
-     * Organization-related FDC3 Intents; can be: `ViewNews` `ViewAnalysis`
-     */
-    intents?: OrganizationIntents;
-}
-/**
- * All available Organization Intents
- */
-export declare type OrganizationIntents = OrganizationIntent[];
-/**
- * FDC3 Intents available to an Organization Column
- */
-export declare type OrganizationIntent = 'ViewNews' | 'ViewAnalysis';
-/**
- *  A (String) Column which will be defined as an FDC3 Country
- */
-export interface CountryColumn extends FDC3Column_Depr {
-    /**
-     * Column which contains the ISOALPHA2 Standard
-     */
-    isoalpha2ColumnId?: string;
-    /**
-     * Column which contains the ISOALPHA3 Standard
-     */
-    isoalpha3ColumnId?: string;
-    /**
-     * Country-related FDC3 Intents; can only be: `ViewChart`
-     */
-    intents?: CountryIntents;
-}
-/**
- * All available Country Intents
- */
-export declare type CountryIntents = CountryIntent[];
-/**
- * FDC3 Intents available to a Country Column
- */
-export declare type CountryIntent = 'ViewChart';
-/**
- *  A Column which will be defined as Custom FDC3 (can be any datatype)
- */
-export interface CustomFDC3Column extends FDC3Column_Depr {
-    /**
-     * Custom FDC3 Intents available to the column
-     */
-    intents: CustomFDC3Intent_Depr[];
-    /**
-     * Function which creates FDC3 context for the current column and row
-     */
-    createContext: (gridCell: GridCell) => CustomFDC3Context;
-}
-/**
- * Full list of FDC3 Intents available - each FDC3 Column can use a subset
- */
-export declare type FDC3Intent_Depr = 'StartCall' | 'StartChat' | 'ViewAnalysis' | 'ViewChart' | 'ViewContact' | 'ViewInstrument' | 'ViewNews' | 'ViewQuote';
-/**
- * Custom FDC3 Intent - just a string value
- */
-export declare type CustomFDC3Intent_Depr = string;
-/**
- * Context passed into Raise FDC3 Intent functions (e.g. get label)
- */
-export interface RaiseFDC3IntentContext extends ContextMenuContext {
-    /**
-     * FDC3 Intent that was raised
-     */
-    intent: FDC3Intent_Depr | CustomFDC3Intent_Depr;
-}
-/**
- * Function that handles FDC3 Context
- */
-export declare type FDC3ContextHandler = (context: FDC3Context_DEPR) => void;
-/**
- * Defines a Desktop Agent which supports FDC3
- */
-export interface FDC3DesktopAgent {
-    /**
-     * Raises an Intent
-     */
-    raiseIntent: (intent: FDC3Intent_Depr, context: FDC3Context_DEPR) => void;
-    /**
-     * Broadcasts an FDC3 Message
-     */
-    broadcast: (context: FDC3Context_DEPR) => void;
-    /**
-     * Raises an FDC3 Intent for a given Context
-     */
-    raiseIntentForContext: (context: FDC3Context_DEPR) => void;
-    /**
-     * Adds an FDC3 Intent Listener
-     */
-    addIntentListener: (intent: FDC3Intent_Depr | CustomFDC3Intent_Depr, listener: (context: FDC3Context_DEPR) => void) => void;
-    /**
-     * Adds an FDC3 Context Listener
-     */
-    addContextListener: (contextType: string | null, handler: FDC3ContextHandler) => {
-        unsubscribe: () => void;
-    };
 }

package/src/AdaptableOptions/OpenFinPluginOptions.d.ts

@@ -1,5 +1,4 @@
 import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
-import { AdaptableFDC3EventInfo } from '../PredefinedConfig/Common/FDC3Context_DEPR';
 /**
  * Options required for when using the OpenFin plugin
  */
@@ -44,9 +43,4 @@ export interface OpenFinPluginOptions {
      * Action to perform when a data change in Live Excel report triggers Prevent Edit Alert failure
      */
     onValidationFailureInExcel?: 'override' | 'show-notification' | 'show-undo-notification';
-    /**
-     * Useful when you also use the finance plugin configured with fdc3 related columns - values in cells such columns can be broadcasted to fdc3, and this function
-     * will be called for broadcasting. It's your job to broadcast to the desired fdc3 channel
-     */
-    onFDC3MessageSent?: (eventInfo: AdaptableFDC3EventInfo) => void;
 }

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -110,10 +110,6 @@ export interface UserInterfaceOptions<TData = any> {
      * @defaultValue null
      */
     alternativeModuleNames?: AlternativeModuleName[];
-    /**
-     * Whether a cell can be commented on
-     */
-    isCellCommentable?: (context: CommmentableCellContext) => boolean;
 }
 /**
  * Base class for all Permitted Values related objects
@@ -210,19 +206,6 @@ export interface BulkUpdatePermittedValuesContext<TData = any> extends Permitted
      */
     gridCells: GridCell<TData>[];
 }
-/**
- * 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;
-}
 /**
  * Sets of Tabs avilable in Grid Info Settings Panel
  */