@adaptabletools/adaptable 16.0.2 → 16.0.3-canary.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "16.0.2",
+  "version": "16.0.3-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: 1692354453311;
+declare const _default: 1692792415311;
 export default _default;

package/publishTimestamp.js

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

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -156,7 +156,6 @@ export interface IAdaptable {
     jumpToColumn(columnId: string): void;
     jumpToCell(columnId: string, rowNode: IRowNode): void;
     getAgGridContainerElement(): HTMLElement | null;
-    setInitialGridData(dataSource: any): void;
     setGridData(dataSource: any): void;
     getGridData(): any[];
     getFilteredData(): any[];

package/src/AdaptableOptions/Fdc3Options.d.ts

@@ -1,7 +1,7 @@
 import { ChartContext, ChatInitSettingsContext, ContactContext, ContactListContext, CountryContext, CurrencyContext, EmailContext, Fdc3Context, Fdc3ContextType, Fdc3CustomContext, Fdc3CustomContextType, InstrumentContext, InstrumentListContext, OrganizationContext, PortfolioContext, PositionContext, TimeRangeContext, ValuationContext } from '../PredefinedConfig/Common/Fdc3Context';
 import { BaseContext } from '../PredefinedConfig/Common/BaseContext';
 import { IRowNode } from '@ag-grid-community/core';
-import { Context, ContextMetadata, IntentResolution, IntentResult } from '@finos/fdc3';
+import { Context, ContextMetadata, DesktopAgent, IntentResolution, IntentResult } from '@finos/fdc3';
 import { CompatibleContext, Fdc3CustomIntentType, Fdc3IntentType } from '../PredefinedConfig/Common/Fdc3Intent';
 import { AdaptableIcon } from '../PredefinedConfig/Common/AdaptableIcon';
 import { ButtonStyle } from '../PredefinedConfig/Common/ButtonStyle';
@@ -15,6 +15,10 @@ export interface Fdc3Options {
      * @defaultValue false
      */
     enableLogging?: boolean;
+    /**
+     * TODO AFL
+     */
+    desktopAgentProvider?: Promise<DesktopAgent>;
     /**
      * Maps Context Type to AdapTable Grid Data
      */
@@ -28,69 +32,39 @@ export interface Fdc3Options {
      */
     intents?: {
         /**
-         * Subscribe to given standard Intent(s)
+         * Raises given standard Intent(s) on various Grid Actions
          */
-        listensFor?: Fdc3IntentType[];
+        raises?: RaiseIntentConfiguration;
         /**
-         * Raises given standard Intent(s) on various Grid Actions
+         * Subscribe to given standard Intent(s)
          */
-        raises?: {
-            [K in Fdc3IntentType]?: RaiseIntentConfig<K>[];
-        };
-    };
-    /**
-     * Configures FDC3 custom Intents that AdapTable will listen for and raise
-     */
-    customIntents?: {
+        listensFor?: (Fdc3IntentType | Fdc3CustomIntentType)[];
         /**
-         * Subscribe to given custom Intent(s)
+         * Handles incoming Intents (standard and custom)
          */
-        listensFor?: Fdc3CustomIntentType[];
+        handleIntent?: (context: HandleFdc3IntentContext) => Promise<IntentResult> | void;
         /**
-         * Raises given custom Intent(s) on various Grid Actions
+         * Handles the IntentResolution that a raised Intent might return
          */
-        raises?: {
-            [K in Fdc3CustomIntentType]: RaiseIntentConfig[];
-        };
+        handleIntentResolution?: (context: HandleFdc3IntentResolutionContext) => Promise<void>;
     };
     /**
      * Configures FDC3 standard Contexts that AdapTable will listen for and broadcast
      */
     contexts?: {
-        /**
-         * Subscribe to given standard Context(s)
-         */
-        listensFor?: Fdc3ContextType[];
         /**
          * Broadcasts given standard Context(s) on various Grid Actions
          */
-        broadcasts?: {
-            [K in Fdc3ContextType]?: BroadcastConfig;
-        };
-    };
-    /**
-     * Configures FDC3 custom Contexts that AdapTable will listen for and broadcast
-     */
-    customContexts?: {
+        broadcasts?: BroadcastConfiguration;
         /**
-         * Subscribe to given custom Context(s)
+         * Subscribe to given standard Context(s)
          */
-        listensFor?: Fdc3CustomContextType[];
+        listensFor?: (Fdc3ContextType | Fdc3CustomContextType)[];
         /**
-         * Broadcasts given custom Context(s) on various Grid Actions
+         * Handles incoming Contexts (standard and custom)
          */
-        broadcasts?: {
-            [K in Fdc3CustomContextType]?: BroadcastConfig;
-        };
+        handleContext?: (context: HandleFdc3Context) => void;
     };
-    /**
-     * Handles incoming Intents (both standard and custom)
-     */
-    handleIntent?: (context: HandleFdc3IntentContext) => Promise<IntentResult> | void;
-    /**
-     * Handles incoming Contexts (both standard and custom)
-     */
-    handleContext?: (context: HandleFdc3Context) => void;
     /**
      * Customises FDC3 Actions column
      */
@@ -121,7 +95,7 @@ export interface ActionColumnDefaultConfiguration {
      */
     resizable?: boolean;
     /**
-     * If Column is moveable
+     * If Column is movable
      * @defaultValue true
      */
     movable?: boolean;
@@ -173,6 +147,10 @@ export interface HandleFdc3IntentContext extends HandleFdc3Context {
      */
     intent: Fdc3IntentType | Fdc3CustomIntentType;
 }
+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'>>;
 /**
  * Mapping of FDC3 Context Types to Grid Data/Columns
  */
@@ -191,36 +169,97 @@ export interface GridDataContextMapping {
     'fdc3.position'?: Fdc3ContentMapping<PositionContext>;
     'fdc3.timerange'?: Fdc3ContentMapping<TimeRangeContext>;
     'fdc3.valuation'?: Fdc3ContentMapping<ValuationContext>;
+    custom?: {
+        [key: string]: Fdc3ContentMapping<Context>;
+    };
+}
+export interface RaiseIntentConfiguration {
+    StartCall?: RaiseIntentConfig<'StartCall'>[];
+    StartChat?: RaiseIntentConfig<'StartChat'>[];
+    StartEmail?: RaiseIntentConfig<'StartEmail'>[];
+    ViewAnalysis?: RaiseIntentConfig<'ViewAnalysis'>[];
+    ViewChart?: RaiseIntentConfig<'ViewChart'>[];
+    ViewContact?: RaiseIntentConfig<'ViewContact'>[];
+    ViewHoldings?: RaiseIntentConfig<'ViewHoldings'>[];
+    ViewInstrument?: RaiseIntentConfig<'ViewInstrument'>[];
+    ViewInteractions?: RaiseIntentConfig<'ViewInteractions'>[];
+    ViewNews?: RaiseIntentConfig<'ViewNews'>[];
+    ViewOrders?: RaiseIntentConfig<'ViewOrders'>[];
+    ViewProfile?: RaiseIntentConfig<'ViewProfile'>[];
+    ViewQuote?: RaiseIntentConfig<'ViewQuote'>[];
+    ViewResearch?: RaiseIntentConfig<'ViewResearch'>[];
+    custom?: {
+        [customIntent: string]: RaiseIntentConfig[];
+    };
+}
+export interface BroadcastConfiguration {
+    'fdc3.chart'?: BroadcastConfig;
+    'fdc3.chat.initSettings'?: BroadcastConfig;
+    'fdc3.contact'?: BroadcastConfig;
+    'fdc3.contactList'?: BroadcastConfig;
+    'fdc3.country'?: BroadcastConfig;
+    'fdc3.currency'?: BroadcastConfig;
+    'fdc3.email'?: BroadcastConfig;
+    'fdc3.instrument'?: BroadcastConfig;
+    'fdc3.instrumentList'?: BroadcastConfig;
+    'fdc3.organization'?: BroadcastConfig;
+    'fdc3.portfolio'?: BroadcastConfig;
+    'fdc3.position'?: BroadcastConfig;
+    'fdc3.timerange'?: BroadcastConfig;
+    'fdc3.valuation'?: BroadcastConfig;
+    custom?: {
+        [customContext: string]: BroadcastConfig;
+    };
 }
-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> {
+    /**
+     * Key of Context being Raised
+     */
     contextType: CompatibleContext<K>;
+    /**
+     * Columns to display a 'Raise Intent' Context Menu item
+     */
     contextMenu?: {
         columnIds: string[];
     };
+    /**
+     * Definition of Action Button (to be put in default FDC3 Action Column)
+     */
     actionButton?: Fdc3AdaptableButton;
+    /**
+     * Custom FDC3 Action Column definition for the Intent
+     */
     actionColumn?: {
         columnId: string;
         friendlyName?: string;
         button: Fdc3AdaptableButton;
         width?: number;
     };
-    handleIntentResolution?: (context: HandleFdc3IntentResolutionContext) => Promise<IntentResult>;
+    /**
+     * Handles the IntentResolution for this specific raise intent configuration
+     */
+    handleIntentResolution?: (context: HandleFdc3IntentResolutionContext) => Promise<void>;
 }
 /**
  * Config used when broadcasting FDC3 Context
  */
 export interface BroadcastConfig {
+    /**
+     * Columns to display a 'Broadcast' Context Menu item
+     */
     contextMenu?: {
         columnIds: string[];
     };
+    /**
+     * Definition of Action Button (to be put in default FDC3 Action Column)
+     */
     actionButton?: Fdc3AdaptableButton;
+    /**
+     * Custom FDC3 Action Column definition to broadcast the Context
+     */
     actionColumn?: {
         columnId: string;
         friendlyName?: string;

package/src/Api/GridApi.d.ts

@@ -27,10 +27,10 @@ export interface GridApi {
      */
     getFilteredData(): any[];
     /**
-     * Repopulates EXISTING grid with given data; fires GridDataChanged' Event
+     * Repopulates Grid with given data; fires `GridDataChanged` Event
      * @param data any data suitable as AG Grid data source
      */
-    setGridData(data: any[]): void;
+    resetGridData(data: any[]): void;
     /**
      * Sets grid with given data for FIRST use; doesn't fire 'GridDataChanged' Event
      * @param dataany data suitable as AG Grid data source
@@ -43,10 +43,10 @@ export interface GridApi {
      */
     updateGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;
     /**
-   * Adds or Updates AdapTable (and AG Grid) with new and changed rows
-   * @param dataRows rows to add or update
-   * @param config batch option and callback function to run post change
-   */
+     * Adds or Updates AdapTable (and AG Grid) with new and changed rows
+     * @param dataRows rows to add or update
+     * @param config batch option and callback function to run post change
+     */
     addOrUpdateGridData(dataRows: any[], config?: DataUpdateConfig): Promise<IRowNode[]>;
     /**
      * Adds rows to AdapTable (and AG Grid)
@@ -293,16 +293,16 @@ export interface GridApi {
      */
     getCellRawValueCount(columnId: string, rawValue: any): number;
     /**
-   * Returns all the Grid Cells in a Column that have the given Display Value
-   * @param columnId ColumnId to lookup
-   * @param displayValue Display Value to use
-   */
+     * Returns all the Grid Cells in a Column that have the given Display Value
+     * @param columnId ColumnId to lookup
+     * @param displayValue Display Value to use
+     */
     getGridCellsForDisplayValue(columnId: string, displayValue: any): GridCell[] | undefined;
     /**
-   * Gets the count of the cells in a Column that have the given Display Value
-   * @param columnId ColumnId to lookup
-   * @param displayValue Display Value to use
-   */
+     * Gets the count of the cells in a Column that have the given Display Value
+     * @param columnId ColumnId to lookup
+     * @param displayValue Display Value to use
+     */
     getCellDisplayValueCount(columnId: string, displayValue: any): number;
     /**
      * Retrieves Formatted Value for a given Raw Value in given Column
@@ -434,7 +434,17 @@ export interface GridApi {
      */
     unHighlightAllRows(): void;
     /**
-     * Refresh Cells in AdapTable
+     * Refresh Column Values in AdapTable
+     * @param columnId - the ID of the Column to refresh
+     */
+    refreshColumn(columnId: string): void;
+    /**
+     * Refresh Columns Values in AdapTable
+     * @param columnIds - the IDs of the Columns to refresh
+     */
+    refreshColumns(columnIds: string[]): void;
+    /**
+     * Refresh Cell Values in AdapTable
      * @param rowNodes agGrid RowNodes which contain cells to refresh
      * @param columnIds ColumnIds which contain cells to refresh
      */

package/src/Api/Implementation/Fdc3ApiImpl.js

@@ -73,12 +73,10 @@ class Fdc3ApiImpl extends ApiBase_1.ApiBase {
         return (_a = Fdc3Context_1.ContextLabels[contextType]) !== null && _a !== void 0 ? _a : contextType;
     }
     isStandardContextType(contextType) {
-        // @ts-ignore
-        return Fdc3Context_1.StandardContextTypes.includes(contextType);
+        return this.internalApi.isStandardContextType(contextType);
     }
     isStandardIntentType(intentType) {
-        // @ts-ignore
-        return Fdc3Intent_1.Fdc3StandardIntents.includes(intentType);
+        return this.internalApi.isStandardIntentType(intentType);
     }
     getFdc3Service() {
         return this.adaptable.api.internalApi.getFdc3Service();

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

@@ -18,7 +18,7 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     internalApi: GridInternalApi;
     constructor(adaptable: IAdaptable);
     getGridState(): GridState;
-    setGridData(dataSource: any[]): void;
+    resetGridData(dataSource: any[]): void;
     setInitialGridData(data: any): void;
     getGridData(): any[];
     getFilteredData(): any[];
@@ -109,6 +109,8 @@ export declare class GridApiImpl extends ApiBase implements GridApi {
     unHighlightRows(primaryKeyValues: RowsHighlightInfo['primaryKeyValues']): void;
     unHighlightAllRows(): void;
     refreshCells(rowNodes: IRowNode[], columnIds: string[]): void;
+    refreshColumn(columnId: string): void;
+    refreshColumns(columnIds: string[]): void;
     refreshRowByPrimaryKey(primaryKey: any): void;
     refreshRowNode(rowNode: IRowNode): void;
     refreshRowNodes(rowNodes: IRowNode[]): void;

package/src/Api/Implementation/GridApiImpl.js

@@ -16,13 +16,13 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     getGridState() {
         return this.getAdaptableState().Grid;
     }
-    setGridData(dataSource) {
+    resetGridData(dataSource) {
         this.adaptable.setGridData(dataSource);
         const allRowNodes = this.getAllRowNodes();
         this.internalApi.fireGridDataChangedEvent(dataSource, allRowNodes, 'Add');
     }
     setInitialGridData(data) {
-        this.adaptable.setInitialGridData(data);
+        this.adaptable.setGridData(data);
     }
     getGridData() {
         return this.adaptable.getGridData();
@@ -455,6 +455,12 @@ class GridApiImpl extends ApiBase_1.ApiBase {
     refreshCells(rowNodes, columnIds) {
         this.adaptable.refreshCells(rowNodes, columnIds, true);
     }
+    refreshColumn(columnId) {
+        this.adaptable.refreshCells(null, [columnId], true);
+    }
+    refreshColumns(columnIds) {
+        this.adaptable.refreshCells(null, columnIds, true);
+    }
     refreshRowByPrimaryKey(primaryKey) {
         const rowNode = this.getRowNodeForPrimaryKey(primaryKey);
         this.refreshRowNode(rowNode);

package/src/Api/Internal/Fdc3InternalApi.d.ts

@@ -2,28 +2,35 @@ import { ApiBase } from '../Implementation/ApiBase';
 import { Fdc3Context, Fdc3ContextType, Fdc3CustomContextType } from '../../PredefinedConfig/Common/Fdc3Context';
 import { ColDef, IRowNode } from '@ag-grid-community/core';
 import { AppIdentifier, Context, IntentResolution } from '@finos/fdc3';
+import { BroadcastConfig, RaiseIntentConfig } from '../../AdaptableOptions/Fdc3Options';
+import { Fdc3CustomIntentType, Fdc3IntentType } from '../../PredefinedConfig/Common/Fdc3Intent';
 import { AdaptableButton } from '../../PredefinedConfig/Common/AdaptableButton';
 import { ActionColumnContext } from '../../AdaptableOptions/ActionColumnOptions';
+declare type WithContext<K> = K & {
+    contextType: Fdc3ContextType | Fdc3CustomContextType;
+};
+declare type WithIntent<K> = K & {
+    intentType: Fdc3IntentType | Fdc3CustomIntentType;
+};
 export declare class Fdc3InternalApi extends ApiBase {
     mapRowToContextData(contextType: Fdc3ContextType | Fdc3CustomContextType, rowNode: IRowNode): Fdc3Context;
-    /**
-     * Computes the context based on the given `Fdc3Options.gridDataContextMapping` and the given `IRowNode`.
-     */
-    getMappedContextData(contextType: Fdc3ContextType, rowNode: IRowNode): Fdc3Context;
     getFdc3ActionColDefs(): ColDef[];
     getButtonsForFdc3MainActionColumn(): AdaptableButton<ActionColumnContext<any>>[];
     getButtonsForFdc3StandaloneActionColumn(columnId: string): AdaptableButton<ActionColumnContext<any>>[];
     isFdc3MainActionColumn(columnId: string): boolean;
     isFdc3StandaloneActionColumn(columnId: string, columnType: string | string[]): boolean;
     handleIntentResolution(intentResolution: IntentResolution, context: Context, raisedIntent: string, app?: AppIdentifier): void;
+    isStandardContextType(contextType: string): contextType is Fdc3ContextType;
+    isStandardIntentType(intentType: string): intentType is Fdc3IntentType;
+    getAllRaiseIntentConfigs(): WithIntent<RaiseIntentConfig>[];
+    getAllBroadcastContextConfigs(): WithContext<BroadcastConfig>[];
+    private mapRowValueToContextData;
     private isAtLeastOneActionButtonConfigured;
     private getIntentConfigsWithActionButtons;
-    private getCustomIntentConfigsWithActionButtons;
     private getContextConfigsWithActionButtons;
-    private getCustomContextConfigsWithActionButtons;
-    private mapRowValueToContextData;
     private mapFdc3ButtonConfigToAdaptableButton;
     private getDefaultFdc3ButtonLabel;
     private getDefaultFdc3ButtonIcon;
     private getDefaultFdc3ButtonStyle;
 }
+export {};