@adaptabletools/adaptable 20.0.0-canary.5 → 20.0.0-canary.6

package/package.json

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

package/src/Api/Fdc3Api.d.ts

@@ -1,5 +1,5 @@
 import { IRowNode } from 'ag-grid-enterprise';
-import { AppIdentifier, Context, ContextType, DesktopAgent, Intent, IntentResolution } from '@finos/fdc3';
+import { AppIdentifier, Channel, Context, ContextType, DesktopAgent, Intent, IntentResolution } from '@finos/fdc3';
 /**
  * Provides run-time access to AdapTable's FDC3 functionality
  */
@@ -59,14 +59,16 @@ export interface Fdc3Api {
      * Broadcasts the given Context from the given Row Node
      * @param rowNode - The Row Node
      * @param contextType - The FDC3 Context Type
+     * @param channel - (optional) Channel to broadcast to; if not provided, the Context will be broadcast to whatever User Channel the app is joined to
      */
-    broadcastFromRow(rowNode: IRowNode, contextType: ContextType): Promise<void>;
+    broadcastFromRow(rowNode: IRowNode, contextType: ContextType, channel?: Channel): Promise<void>;
     /**
      * Broadcasts the given Context from the given Row Node with the given Primary Key Value
      * @param primaryKeyValue - The Primary Key Value
      * @param contextType - The FDC3 Context Type
+     * @param channel - (optional) Channel to broadcast to; if not provided, the Context will be broadcast to whatever User Channel the app is joined to
      */
-    broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType): Promise<void> | undefined;
+    broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType, channel?: Channel): Promise<void> | undefined;
     /**
      * Checks if the given Context Type is a FDC3 standard Context Type
      */

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

@@ -1,5 +1,5 @@
 import { IRowNode } from 'ag-grid-enterprise';
-import { Context, ContextType, DesktopAgent, Intent, IntentResolution, StandardContextType, StandardIntent } from '@finos/fdc3';
+import { Channel, Context, ContextType, DesktopAgent, Intent, IntentResolution, StandardContextType, StandardIntent } from '@finos/fdc3';
 import { ApiBase } from './ApiBase';
 import { Fdc3Api } from '../Fdc3Api';
 import { Fdc3InternalApi } from '../Internal/Fdc3InternalApi';
@@ -15,8 +15,8 @@ export declare class Fdc3ApiImpl extends ApiBase implements Fdc3Api {
     raiseIntentFromRow(rowNode: IRowNode, intent: Intent, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
     raiseIntentForContextFromRow(rowNode: IRowNode, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution>;
     raiseIntentForContextFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType, appIdentifier?: AppIdentifier): Promise<IntentResolution> | undefined;
-    broadcastFromRow(rowNode: IRowNode, contextType: ContextType): Promise<void>;
-    broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType): Promise<void> | undefined;
+    broadcastFromRow(rowNode: IRowNode, contextType: ContextType, channel?: Channel): Promise<void>;
+    broadcastFromPrimaryKey(primaryKeyValue: string | number, contextType: ContextType, channel?: Channel): Promise<void> | undefined;
     getContextLabel(contextType: ContextType): string;
     isStandardContextType(contextType: string): contextType is StandardContextType;
     isStandardIntentType(intentType: string): intentType is StandardIntent;

package/src/Api/Implementation/Fdc3ApiImpl.js

@@ -44,17 +44,17 @@ export class Fdc3ApiImpl extends ApiBase {
         }
         return this.raiseIntentForContextFromRow(rowNode, contextType, appIdentifier);
     }
-    broadcastFromRow(rowNode, contextType) {
+    broadcastFromRow(rowNode, contextType, channel) {
         const contextData = this.buildContextDataFromRow(contextType, rowNode);
-        return this.getFdc3Service().broadcast(contextData);
+        return this.getFdc3Service().broadcast(contextData, channel);
     }
-    broadcastFromPrimaryKey(primaryKeyValue, contextType) {
+    broadcastFromPrimaryKey(primaryKeyValue, contextType, channel) {
         const rowNode = this.getGridApi().getRowNodeForPrimaryKey(primaryKeyValue);
         if (!rowNode) {
             this.logWarn(`No row found for primary key value '${primaryKeyValue}'`);
             return undefined;
         }
-        return this.broadcastFromRow(rowNode, contextType);
+        return this.broadcastFromRow(rowNode, contextType, channel);
     }
     getContextLabel(contextType) {
         return this.isStandardContextType(contextType)

package/src/Api/Implementation/LayoutHelpers.js

@@ -3,6 +3,7 @@ import { isPivotLayoutModel } from '../../layout-manager/src/isPivotLayoutModel'
 import { normalizeTableLayoutModel, normalizePivotLayoutModel, } from '../../layout-manager/src/normalizeLayoutModel';
 import { simplifyTableLayoutModel, simplifyPivotLayoutModel, } from '../../layout-manager/src/simplifyLayoutModel';
 import { isWeightedAverageAggregation, WEIGHTED_AVERAGE_AGG_FN_NAME, isWeightedAverageAggFuncName, } from '../../PredefinedConfig/Common/AggregationColumns';
+import { removeAdaptableObjectPrimitivesInline } from '../../Utilities/Helpers/AdaptableHelper';
 export const layoutStateToLayoutModel = (layout) => {
     if (isPivotLayout(layout)) {
         return pivotLayoutToPivotLayoutModel(layout);
@@ -18,44 +19,23 @@ export const layoutModelToLayoutState = (layoutModel, defaults) => {
 function cleanupAdaptableObjectPrimitives(layout) {
     if (layout.TableAggregationColumns) {
         layout.TableAggregationColumns.forEach((AggValue) => {
-            // @ts-ignore
-            delete AggValue.Source;
-            // @ts-ignore
-            delete AggValue.Uuid;
-            // @ts-ignore
-            delete AggValue.AdaptableVersion;
+            removeAdaptableObjectPrimitivesInline(AggValue);
             if (typeof AggValue.AggFunc === 'object' && AggValue.AggFunc) {
-                // @ts-ignore
-                delete AggValue.AggFunc.Source;
-                // @ts-ignore
-                delete AggValue.AggFunc.Uuid;
-                // @ts-ignore
-                delete AggValue.AggFunc.AdaptableVersion;
+                removeAdaptableObjectPrimitivesInline(AggValue.AggFunc);
             }
         });
     }
     if (layout.ColumnHeaders) {
-        delete layout.ColumnHeaders.Source;
-        delete layout.ColumnHeaders.Uuid;
-        delete layout.ColumnHeaders.AdaptableVersion;
+        removeAdaptableObjectPrimitivesInline(layout.ColumnHeaders);
     }
     if (layout.ColumnVisibility) {
-        delete layout.ColumnVisibility.Source;
-        delete layout.ColumnVisibility.Uuid;
-        delete layout.ColumnVisibility.AdaptableVersion;
+        removeAdaptableObjectPrimitivesInline(layout.ColumnVisibility);
     }
     if (layout.ColumnWidths) {
-        delete layout.ColumnWidths.Source;
-        delete layout.ColumnWidths.Uuid;
-        delete layout.ColumnWidths.AdaptableVersion;
+        removeAdaptableObjectPrimitivesInline(layout.ColumnWidths);
     }
     if (layout.RowGroupValues) {
-        // @ts-ignore
-        delete layout.RowGroupValues.Source;
-        // @ts-ignore
-        delete layout.RowGroupValues.Uuid;
-        // @ts-ignore
-        delete layout.RowGroupValues.AdaptableVersion;
+        removeAdaptableObjectPrimitivesInline(layout.RowGroupValues);
     }
 }
 /**
@@ -258,6 +238,7 @@ export const tableLayoutModelToTableLayout = (layoutModel, defaults) => {
     else {
         delete tableLayout.TableAggregationColumns;
     }
+    cleanupAdaptableObjectPrimitives(tableLayout);
     return tableLayout;
 };
 function toAggregationColumnValue(columnAggregationModel) {

package/src/Utilities/Helpers/AdaptableHelper.d.ts

@@ -4,6 +4,7 @@ import { AccessLevel } from '../../PredefinedConfig/Common/Entitlement';
 export declare function initPredefinedConfigWithUuids(predefinedConfig: PredefinedConfig): PredefinedConfig;
 export declare function getAccessLevelForObject(adaptableObject: AdaptableObject, moduleAccessLevel: AccessLevel): AccessLevel;
 export declare function addAdaptableObjectPrimitives<T extends AdaptableObject>(adaptableObject: T): T;
+export declare function removeAdaptableObjectPrimitivesInline(target: any): any;
 export declare function removeAdaptableObjectPrimitives<T extends AdaptableObject>(adaptableObject: T): T;
 export declare function isAdaptableObject(object: unknown): object is AdaptableObject;
 export declare const AdaptableHelper: {
@@ -11,6 +12,7 @@ export declare const AdaptableHelper: {
     getAccessLevelForObject: typeof getAccessLevelForObject;
     addAdaptableObjectPrimitives: typeof addAdaptableObjectPrimitives;
     removeAdaptableObjectPrimitives: typeof removeAdaptableObjectPrimitives;
+    removeAdaptableObjectPrimitivesInline: typeof removeAdaptableObjectPrimitivesInline;
     isAdaptableObject: typeof isAdaptableObject;
 };
 export default AdaptableHelper;

package/src/Utilities/Helpers/AdaptableHelper.js

@@ -43,6 +43,15 @@ export function addAdaptableObjectPrimitives(adaptableObject) {
     adaptableObject.AdaptableVersion = GET_CURRENT_VERSION();
     return adaptableObject;
 }
+export function removeAdaptableObjectPrimitivesInline(target) {
+    if (!target || typeof target !== 'object') {
+        return target;
+    }
+    delete target.Source;
+    delete target.Uuid;
+    delete target.AdaptableVersion;
+    return target;
+}
 export function removeAdaptableObjectPrimitives(adaptableObject) {
     const clonedObject = structuredClone(adaptableObject);
     const sanitiseObject = (object) => {
@@ -70,6 +79,7 @@ export const AdaptableHelper = {
     getAccessLevelForObject,
     addAdaptableObjectPrimitives,
     removeAdaptableObjectPrimitives,
+    removeAdaptableObjectPrimitivesInline,
     isAdaptableObject,
 };
 export default AdaptableHelper;

package/src/Utilities/Services/Fdc3Service.d.ts

@@ -1,7 +1,7 @@
 import { IAdaptableService } from './Interface/IAdaptableService';
 import { AdaptableApi } from '../../Api/AdaptableApi';
 import { Fdc3Options } from '../../AdaptableOptions/Fdc3Options';
-import { AppIdentifier, DesktopAgent, IntentResolution } from '@finos/fdc3';
+import { AppIdentifier, Channel, DesktopAgent, IntentResolution } from '@finos/fdc3';
 import { Context } from '@finos/fdc3/dist/context/ContextTypes';
 export declare class Fdc3Service implements IAdaptableService {
     private adaptableApi;
@@ -15,7 +15,7 @@ export declare class Fdc3Service implements IAdaptableService {
     destroy(): void;
     raiseIntent(intent: string, context: Context, app?: AppIdentifier): Promise<IntentResolution>;
     raiseIntentForContext(context: Context, app?: AppIdentifier): Promise<IntentResolution>;
-    broadcast(context: Context): Promise<void>;
+    broadcast(context: Context, channel?: Channel): Promise<void>;
     private logFdc3Event;
     private logFdc3Error;
     private getFdc3Api;

package/src/Utilities/Services/Fdc3Service.js

@@ -131,7 +131,7 @@ export class Fdc3Service {
             this.logFdc3Error(error);
         }
     }
-    broadcast(context) {
+    broadcast(context, channel) {
         if (!this.getDesktopAgent()) {
             return;
         }
@@ -144,7 +144,12 @@ export class Fdc3Service {
                 context,
             };
             this.adaptableApi.eventApi.emit('Fdc3Message', payload);
-            return this.getDesktopAgent().broadcast(context);
+            if (channel) {
+                return channel.broadcast(context);
+            }
+            else {
+                return this.getDesktopAgent().broadcast(context);
+            }
         }
         catch (error) {
             this.logFdc3Error(error);

package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/ConfigurationWizard.js

@@ -42,6 +42,47 @@ export const ConfigurationWizard = (props) => {
                 delete newColumn.caption;
                 return newColumn;
             });
+            const columnDefs = adaptableConfig.gridOptions.columnDefs;
+            // handle the layout creation
+            let Layouts = newAdaptableOptions.predefinedConfig?.Layout?.Layouts || [];
+            const NewLayout = {
+                TableColumns: columnDefs.map((col) => col.colId ?? col.field),
+                Name: 'Default Layout',
+            };
+            let currentLayoutName = NewLayout.Name;
+            let found = false;
+            if (!Layouts.length) {
+                // no layouts, make this the only one
+                Layouts = [NewLayout];
+            }
+            else {
+                Layouts = Layouts.map((layout) => {
+                    if (found) {
+                        return layout;
+                    }
+                    if (layout.TableColumns?.length === 0) {
+                        // when finding the first empty layout
+                        // set its column to be those of the new layout
+                        found = true;
+                        // and grab the name so we can put it in the Layout.CurrentLayout state
+                        currentLayoutName = layout.Name;
+                        layout = { ...layout };
+                        layout.TableColumns = NewLayout.TableColumns;
+                    }
+                    return layout;
+                });
+                if (!found) {
+                    Layouts.push(NewLayout);
+                }
+            }
+            newAdaptableOptions.predefinedConfig = {
+                ...newAdaptableOptions.predefinedConfig,
+                Layout: {
+                    ...newAdaptableOptions.predefinedConfig.Layout,
+                    Layouts: Layouts,
+                    CurrentLayout: currentLayoutName,
+                },
+            };
             newAdaptableOptions.primaryKey = columnsHandle.current.getPrimaryKey();
         }
         const newAdaptableConfig = {

package/src/agGrid/AdaptableAgGrid.js

@@ -2961,6 +2961,10 @@ You need to define at least one Layout!`);
             };
             this.agGridColumnAdapter.setupColumnHeader(colSetupInfo);
         });
+        // need to refresh the header,
+        // as the Layout.ColumnHeaders state property is not implemented in the LayoutManager
+        // and is specific to Adaptable, therefore we need to refresh it manually
+        this.refreshHeader();
         const layoutModel = layoutStateToLayoutModel(layout);
         this.layoutManager?.setLayout(layoutModel, {
             skipApplyRowGroupsExpandedState: !shouldUpdateExpandState,

package/src/agGrid/AgGridAdapter.js

@@ -96,7 +96,7 @@ export class AgGridAdapter {
             // `context`
             const passedContext = options.context;
             if (passedContext) {
-                passedContext['__adaptable'] = self;
+                passedContext['__adaptable'] = self._adaptableInstance;
                 passedContext['adaptableApi'] = self.adaptableApi;
             }
             // we mutated the options array, so it's OK to use the 'arguments' object

package/src/agGrid/AgGridColumnAdapter.js

@@ -387,9 +387,6 @@ export class AgGridColumnAdapter {
             if (layoutCustomHeader) {
                 resultHeaderName = layoutCustomHeader;
             }
-            // required here for the initial layout rendering
-            // Removed by JW, 3 october 2023; i don't think we need it and it overrides stuff unnecessarily
-            abColumn.friendlyName = resultHeaderName;
             return resultHeaderName;
         });
         const newColumnHeader = col?.getColDef()?.headerName;

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     NEXT_PUBLIC_INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862" || '',
-    PUBLISH_TIMESTAMP: 1741156623359 || Date.now(),
-    VERSION: "20.0.0-canary.5" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1741253338614 || Date.now(),
+    VERSION: "20.0.0-canary.6" || '--current-version--',
 };