@adaptabletools/adaptable 16.0.2-canary.0 → 16.0.3-canary.0

package/package.json

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

package/publishTimestamp.js

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

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

@@ -84,11 +84,11 @@ export interface Fdc3Options {
         };
     };
     /**
-     * Handles incoming Intents (both standard and custom)
+     * Handles incoming Intents (standard and custom)
      */
     handleIntent?: (context: HandleFdc3IntentContext) => Promise<IntentResult> | void;
     /**
-     * Handles incoming Contexts (both standard and custom)
+     * Handles incoming Contexts (standard and custom)
      */
     handleContext?: (context: HandleFdc3Context) => void;
     /**
@@ -121,7 +121,7 @@ export interface ActionColumnDefaultConfiguration {
      */
     resizable?: boolean;
     /**
-     * If Column is moveable
+     * If Column is movable
      * @defaultValue true
      */
     movable?: boolean;
@@ -191,6 +191,9 @@ export interface GridDataContextMapping {
     'fdc3.position'?: Fdc3ContentMapping<PositionContext>;
     'fdc3.timerange'?: Fdc3ContentMapping<TimeRangeContext>;
     'fdc3.valuation'?: Fdc3ContentMapping<ValuationContext>;
+    custom?: {
+        [key: string]: Fdc3ContentMapping<Context>;
+    };
 }
 export declare const ColumnRefTypePrefix = "_colId.";
 export declare const FieldRefTypePrefix = "_field.";
@@ -200,27 +203,51 @@ 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;
     };
+    /**
+     * Handles Intent Resolution returning an ayschronous Intent Result
+     */
     handleIntentResolution?: (context: HandleFdc3IntentResolutionContext) => Promise<IntentResult>;
 }
 /**
  * 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

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[];

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();

package/src/Api/Internal/Fdc3InternalApi.js

@@ -26,11 +26,15 @@ class Fdc3InternalApi extends ApiBase_1.ApiBase {
      * Computes the context based on the given `Fdc3Options.gridDataContextMapping` and the given `IRowNode`.
      */
     getMappedContextData(contextType, rowNode) {
-        var _a;
+        var _a, _b, _c;
         if (contextType === fdc3_1.ContextTypes.Nothing) {
             return { type: fdc3_1.ContextTypes.Nothing };
         }
-        const contextMapping = (_a = this.getFdc3Options().gridDataContextMapping) === null || _a === void 0 ? void 0 : _a[contextType];
+        let contextMapping = (_a = this.getFdc3Options().gridDataContextMapping) === null || _a === void 0 ? void 0 : _a[contextType];
+        if (!contextMapping) {
+            // check if it's a custom context type
+            contextMapping = (_c = (_b = this.getFdc3Options().gridDataContextMapping) === null || _b === void 0 ? void 0 : _b.custom) === null || _c === void 0 ? void 0 : _c[contextType];
+        }
         if (!contextMapping) {
             return { type: contextType };
         }

package/src/Utilities/Constants/DocumentationLinkConstants.js

@@ -9,7 +9,7 @@ exports.ScalarQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expre
 exports.ObservableQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expression-observable`;
 exports.AggregatedBooleanQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expression-aggregation-boolean`;
 exports.AggregatedScalarQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expression-aggregation-scalar`;
-exports.CumulativeAggregatedScalarQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expression-aggregation-scalar#cumulative-aggregation`;
+exports.CumulativeAggregatedScalarQueryDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-expression-cumulative`;
 exports.PredicateDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-ql-predicate`;
 exports.PrimaryKeyDocsLink = `${exports.HOST_URL_DOCS}/guide/getting-started-primary-key`;
 exports.LicenseDocsLink = `${exports.HOST_URL_DOCS}/guide/licensing`;

package/src/Utilities/Services/Fdc3Service.js

@@ -63,6 +63,7 @@ class Fdc3Service {
         var _a;
         this.logFdc3Event('OUT', `raise ${intent}`, JSON.stringify(context));
         const intentResolution = await ((_a = this.getDesktopAgent()) === null || _a === void 0 ? void 0 : _a.raiseIntent(intent, context, app));
+        this.logFdc3Event('IN', `IntentResolution`, intentResolution.intent);
         this.getFdc3Api().internalApi.handleIntentResolution(intentResolution, context, intent, app);
         return intentResolution;
     }
@@ -70,8 +71,8 @@ class Fdc3Service {
         var _a;
         this.logFdc3Event('OUT', `raise for context`, JSON.stringify(context));
         const intentResolution = await ((_a = this.getDesktopAgent()) === null || _a === void 0 ? void 0 : _a.raiseIntentForContext(context, app));
-        // TODO AFL
-        // this.getFdc3Api().internalApi.handleIntentResolution(intentResolution, context, null, app);
+        this.logFdc3Event('IN', `IntentResolution`, intentResolution.intent);
+        this.getFdc3Api().internalApi.handleIntentResolution(intentResolution, context, null, app);
         return intentResolution;
     }
     broadcast(context) {

package/src/View/QuickSearch/QuickSearchInput.js

@@ -12,7 +12,7 @@ const QuickSearchInput = (props) => {
     const adaptable = (0, AdaptableContext_1.useAdaptable)();
     const QuickSearchText = (0, react_redux_1.useSelector)((state) => state.QuickSearch.QuickSearchText);
     const dispatch = (0, react_redux_1.useDispatch)();
-    const onRunQuickSearch = (newQuickSearchText) => dispatch(QuickSearchRedux.QuickSearchRun(newQuickSearchText));
+    const onRunQuickSearch = react_1.default.useCallback((newQuickSearchText) => dispatch(QuickSearchRedux.QuickSearchRun(newQuickSearchText)), []);
     const [searchText, search] = (0, useQuickSearchDebounced_1.useQuickSearchDebounced)({
         QuickSearchText,
         onRunQuickSearch,

package/src/agGrid/Adaptable.d.ts

@@ -378,7 +378,6 @@ export declare class Adaptable implements IAdaptable {
     setColumnSort(columnSorts: ColumnSort[]): void;
     clearColumnSort(): void;
     setGridData(dataSource: any[]): void;
-    setInitialGridData(dataSource: any[]): void;
     getGridData(): any[];
     getFilteredData(): any[];
     updateRows(dataRows: any[], dataUpdateConfig?: DataUpdateConfig): Promise<IRowNode[]>;

package/src/agGrid/Adaptable.js

@@ -4277,9 +4277,6 @@ class Adaptable {
         this.gridOptions.api.setRowData(dataSource);
         this.updateColumnDataTypeIfRowDataIsEmpty();
         this.updateRowGroupsExpandedState();
-    }
-    setInitialGridData(dataSource) {
-        this.setGridData(dataSource);
         this.setupColumns();
     }
     getGridData() {

package/src/metamodel/adaptable.metamodel.d.ts

@@ -1287,6 +1287,19 @@ export declare const ADAPTABLE_METAMODEL: {
         name: string;
         kind: string;
         desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            ref: string;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            ref?: undefined;
+        })[];
     };
     BulkUpdatePermittedValues: {
         name: string;
@@ -3911,6 +3924,25 @@ export declare const ADAPTABLE_METAMODEL: {
         name: string;
         kind: string;
         desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            ref: string;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            ref?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt?: undefined;
+            ref?: undefined;
+        })[];
     };
     RangeValueType: {
         name: string;