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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "21.0.0-canary.0",
+  "version": "21.0.0-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/src/AdaptableOptions/LayoutOptions.d.ts

@@ -1,4 +1,4 @@
-import { Layout } from '../AdaptableState/LayoutState';
+import { Layout, PivotLayout, TableLayout } from '../AdaptableState/LayoutState';
 import { AdaptableObjectTag } from '../AdaptableState/Common/AdaptableObject';
 import { BaseContext, LayoutExtensionModule, LayoutExtensionObject } from '../../types';
 /**
@@ -17,6 +17,10 @@ export interface LayoutOptions {
      * Columns to display in Table that opens when viewing Pivot Cell contents
      */
     pivotPreviewColumns?: string[] | ((context: PivotPreviewColumnsContext) => string[]);
+    /**
+     * Default properties to apply when creating a new Layout (Table or Pivot)
+     */
+    defaultLayoutProperties?: DefaultLayoutProperties | ((context: DefaultLayoutPropertiesContext) => DefaultTableLayoutProperties | DefaultPivotLayoutProperties);
 }
 /**
  * Options for managing Tags in Layouts (used to enhance Layouts)
@@ -93,3 +97,30 @@ export interface PivotPreviewColumnsContext extends BaseContext {
      */
     columnId: string;
 }
+/**
+ * Default properties to apply when creating a new Table Layout
+ */
+export type DefaultTableLayoutProperties = Partial<Omit<TableLayout, 'Name'>>;
+/**
+ * Default properties to apply when creating a new Pivot Layout
+ */
+export type DefaultPivotLayoutProperties = Partial<Omit<PivotLayout, 'Name'>>;
+/**
+ * Default properties to apply when creating a new Layout (Table or Pivot)
+ */
+export interface DefaultLayoutProperties {
+    /**
+     * Default properties to apply when creating a new Table Layout
+     */
+    tableLayout?: DefaultTableLayoutProperties;
+    /**
+     * Default properties to apply when creating a new Pivot Layout
+     */
+    pivotLayout?: DefaultPivotLayoutProperties;
+}
+/**
+ * Context for `LayoutOptions.defaultLayoutProperties` function
+ */
+export interface DefaultLayoutPropertiesContext extends BaseContext {
+    layoutType: 'table' | 'pivot';
+}

package/src/Api/Implementation/LayoutApiImpl.js

@@ -2,8 +2,6 @@ import * as LayoutRedux from '../../Redux/ActionsReducers/LayoutRedux';
 import * as ModuleConstants from '../../Utilities/Constants/ModuleConstants';
 import { ApiBase } from './ApiBase';
 import StringExtensions from '../../Utilities/Extensions/StringExtensions';
-import ObjectFactory from '../../Utilities/ObjectFactory';
-import Helper from '../../Utilities/Helpers/Helper';
 import { createUuid } from '../../AdaptableState/Uuid';
 import { PopupShowPrompt } from '../../Redux/ActionsReducers/PopupRedux';
 import { LayoutInternalApi } from '../Internal/LayoutInternalApi';
@@ -275,7 +273,7 @@ export class LayoutApiImpl extends ApiBase {
             this.logError("Cannot create layout with the Name: '" + layoutToCreate.Name + "' as it already exists");
             return false;
         }
-        const newLayout = ObjectFactory.CreateEmptyLayout({ ...layoutToCreate });
+        const newLayout = this.internalApi.buildInitialLayout(layoutToCreate);
         this.addUidToAdaptableObject(newLayout);
         this.dispatchAction(LayoutRedux.LayoutAdd(newLayout));
         return newLayout;
@@ -292,9 +290,11 @@ export class LayoutApiImpl extends ApiBase {
             this.logError("Cannot clone layout with Name: '" + layoutName + "' as other Layout does not exist");
             return false;
         }
-        const newLayout = Helper.cloneObject(layoutToClone);
-        newLayout.Uuid = createUuid();
-        newLayout.Name = layoutName;
+        const newLayout = {
+            ...this.internalApi.cloneLayout(layoutToClone),
+            Name: layoutName,
+            Uuid: createUuid(),
+        };
         this.dispatchAction(LayoutRedux.LayoutAdd(newLayout));
         return this.getLayoutById(newLayout.Uuid);
     }

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

@@ -32,4 +32,9 @@ export declare class LayoutInternalApi extends ApiBase {
     setupRowSummaries(): void;
     refreshLayout(): void;
     getChangedColumnSorts(oldSorts: LayoutBase['ColumnSorts'], newSorts: LayoutBase['ColumnSorts']): string[];
+    buildInitialLayout(providedLayout: Partial<Layout> & {
+        Name: string;
+    }, type?: 'table' | 'pivot'): Layout;
+    private getDefaultLayoutProperties;
+    cloneLayout(layoutToClone: Layout): Omit<Layout, 'Name'>;
 }

package/src/Api/Internal/LayoutInternalApi.js

@@ -1,7 +1,10 @@
 import { ColumnFilterModuleId, GridFilterModuleId, } from '../../Utilities/Constants/ModuleConstants';
 import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
 import { ApiBase } from '../Implementation/ApiBase';
-import { areLayoutsEqual, normalizeLayout } from '../Implementation/LayoutHelpers';
+import { areLayoutsEqual, isPivotLayout, normalizeLayout } from '../Implementation/LayoutHelpers';
+import ObjectFactory from '../../Utilities/ObjectFactory';
+import Helper from '../../Utilities/Helpers/Helper';
+import AdaptableHelper from '../../Utilities/Helpers/AdaptableHelper';
 export class LayoutInternalApi extends ApiBase {
     getNormalizedLayout(layout) {
         return normalizeLayout(layout);
@@ -206,4 +209,44 @@ export class LayoutInternalApi extends ApiBase {
         });
         return changedColumnIds;
     }
+    buildInitialLayout(providedLayout, type) {
+        const layoutType = type || (isPivotLayout(providedLayout) ? 'pivot' : 'table');
+        const providedTableLayout = providedLayout;
+        const providedPivotLayout = providedLayout;
+        const initialEmptyLayout = layoutType === 'pivot'
+            ? ObjectFactory.CreateEmptyPivotLayout({ ...providedPivotLayout })
+            : ObjectFactory.CreateEmptyTableLayout({ ...providedTableLayout });
+        const defaultLayoutProperties = this.getDefaultLayoutProperties(layoutType);
+        const initialLayout = {
+            ...initialEmptyLayout,
+            ...defaultLayoutProperties,
+        };
+        return initialLayout;
+    }
+    getDefaultLayoutProperties(layoutType) {
+        const defaultLayoutPropertiesOption = this.getLayoutOptions().defaultLayoutProperties;
+        if (typeof defaultLayoutPropertiesOption === 'object') {
+            const initialProps = layoutType === 'table'
+                ? defaultLayoutPropertiesOption.tableLayout
+                : defaultLayoutPropertiesOption.pivotLayout;
+            return initialProps;
+        }
+        if (typeof defaultLayoutPropertiesOption === 'function') {
+            const context = {
+                layoutType,
+                ...this.getAdaptableInternalApi().buildBaseContext(),
+            };
+            return defaultLayoutPropertiesOption(context);
+        }
+        return {};
+    }
+    cloneLayout(layoutToClone) {
+        let clonedLayout = Helper.cloneObject(layoutToClone);
+        let result = {
+            ...this.buildInitialLayout(clonedLayout),
+        };
+        result = AdaptableHelper.removeAdaptableObjectPrimitivesInlineDeep(result);
+        delete result.Name;
+        return result;
+    }
 }

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

@@ -14,6 +14,7 @@ export declare const AdaptableHelper: {
     addAdaptableObjectPrimitives: typeof addAdaptableObjectPrimitives;
     removeAdaptableObjectPrimitives: typeof removeAdaptableObjectPrimitives;
     removeAdaptableObjectPrimitivesInline: typeof removeAdaptableObjectPrimitivesInline;
+    removeAdaptableObjectPrimitivesInlineDeep: typeof removeAdaptableObjectPrimitivesInlineDeep;
     isAdaptableObject: typeof isAdaptableObject;
 };
 export default AdaptableHelper;

package/src/Utilities/Helpers/AdaptableHelper.js

@@ -106,6 +106,7 @@ export const AdaptableHelper = {
     addAdaptableObjectPrimitives,
     removeAdaptableObjectPrimitives,
     removeAdaptableObjectPrimitivesInline,
+    removeAdaptableObjectPrimitivesInlineDeep,
     isAdaptableObject,
 };
 export default AdaptableHelper;

package/src/Utilities/ObjectFactory.d.ts

@@ -23,7 +23,7 @@ import { NotificationsOptions } from '../AdaptableOptions/NotificationsOptions';
 import { CellSummmaryInfo } from '../AdaptableState/Common/CellSummary';
 import { AdaptableTheme, ChartDefinition, ColumnFilter, CommentThread, CustomDisplayFormatterContext, FlashingCellDefinition, RowDataChangedInfo, SpecialColumnSettings, SystemFilterPredicateId } from '../types';
 import { IRowNode } from 'ag-grid-enterprise';
-import { AdaptableApi, AdaptableComment, BadgeStyleDefinition, CellAddress, NamedQuery, PivotLayout } from '../../types';
+import { AdaptableApi, AdaptableComment, BadgeStyleDefinition, CellAddress, NamedQuery, PivotLayout, TableLayout } from '../../types';
 import { ToastOptions } from '../components/Toastify';
 import { StyledColumn } from '../AdaptableState/StyledColumnState';
 export declare function CreateEmptyCustomSort(): CustomSort;
@@ -51,12 +51,15 @@ export declare function CreateEmptySchedule(): Schedule;
 export declare function CreateEmptyShortcut(): Shortcut;
 export declare function CreateEmptyFormatColumn(): FormatColumn;
 export declare function CreateEmptyFreeTextColumn(defaultSpecialColumnSettings: Partial<SpecialColumnSettings>): FreeTextColumn;
-export declare function CreateEmptyPivotLayout(layout?: Partial<PivotLayout> & {
+export declare function CreateEmptyPivotLayout(pivotLayout?: Partial<PivotLayout> & {
     Name: string;
 }): PivotLayout;
+export declare function CreateEmptyTableLayout(tableLayout?: Partial<TableLayout> & {
+    Name: string;
+}): TableLayout;
 export declare function CreateEmptyLayout(layout?: Partial<Layout> & {
     Name: string;
-}, adaptableColumns?: AdaptableColumn[]): Layout;
+}): Layout;
 export declare function CreateEmptyStyle(): AdaptableStyle;
 export declare function CreateSystemStatusMessageInfo(message: string, type: AdaptableMessageType, furtherInfo?: string): SystemStatusMessageInfo;
 export declare function CreateEmptyCellSummmary(): CellSummmaryInfo;
@@ -100,6 +103,7 @@ export declare const ObjectFactory: {
     CreateEmptyFreeTextColumn: typeof CreateEmptyFreeTextColumn;
     CreateEmptyLayout: typeof CreateEmptyLayout;
     CreateEmptyPivotLayout: typeof CreateEmptyPivotLayout;
+    CreateEmptyTableLayout: typeof CreateEmptyTableLayout;
     CreateColumnFilter: typeof CreateColumnFilter;
     CreateEmptyStyle: typeof CreateEmptyStyle;
     CreateEmptyCellSummmary: typeof CreateEmptyCellSummmary;

package/src/Utilities/ObjectFactory.js

@@ -246,36 +246,43 @@ export function CreateEmptyFreeTextColumn(defaultSpecialColumnSettings) {
         },
     };
 }
-export function CreateEmptyPivotLayout(layout) {
+export function CreateEmptyPivotLayout(pivotLayout) {
     const result = {
-        Name: layout.Name,
-        ColumnSorts: layout.ColumnSorts || [],
-        ColumnFilters: layout.ColumnFilters || [],
+        ...pivotLayout,
         Uuid: createUuid(),
-        PivotColumns: layout.PivotColumns || [],
-        PivotAggregationColumns: layout.PivotAggregationColumns || [],
-        PivotGroupedColumns: layout.PivotGroupedColumns || [],
-        ColumnSizing: layout.ColumnSizing || {},
+        ColumnSizing: pivotLayout.ColumnSizing || {},
+        ColumnHeaders: pivotLayout.ColumnHeaders || {},
+        ColumnPinning: pivotLayout.ColumnPinning || {},
+        ColumnSorts: pivotLayout.ColumnSorts || [],
+        ColumnFilters: pivotLayout.ColumnFilters || [],
+        PivotColumns: pivotLayout.PivotColumns || [],
+        PivotAggregationColumns: pivotLayout.PivotAggregationColumns || [],
+        PivotGroupedColumns: pivotLayout.PivotGroupedColumns || [],
     };
     return result;
 }
-export function CreateEmptyLayout(layout, adaptableColumns) {
-    if (isPivotLayout(layout)) {
-        return CreateEmptyPivotLayout(layout);
-    }
-    const tableLayout = layout;
+export function CreateEmptyTableLayout(tableLayout) {
     const result = {
         ...tableLayout,
         Uuid: createUuid(),
-        TableColumns: tableLayout.TableColumns || [],
+        ColumnSizing: tableLayout.ColumnSizing || {},
+        ColumnHeaders: tableLayout.ColumnHeaders || {},
+        ColumnPinning: tableLayout.ColumnPinning || {},
         ColumnSorts: tableLayout.ColumnSorts || [],
         ColumnFilters: tableLayout.ColumnFilters || [],
-        ColumnSizing: tableLayout.ColumnSizing || {},
-        RowGroupedColumns: tableLayout.RowGroupedColumns ||
-            (adaptableColumns ? adaptableColumns.filter((c) => c.isGrouped).map((c) => c.columnId) : []),
+        TableColumns: tableLayout.TableColumns || [],
+        RowGroupedColumns: tableLayout.RowGroupedColumns || [],
     };
     return result;
 }
+export function CreateEmptyLayout(layout) {
+    if (isPivotLayout(layout)) {
+        return CreateEmptyPivotLayout(layout);
+    }
+    else {
+        return CreateEmptyTableLayout(layout);
+    }
+}
 export function CreateEmptyStyle() {
     return {
         BackColor: undefined,
@@ -444,6 +451,7 @@ export const ObjectFactory = {
     CreateEmptyFreeTextColumn,
     CreateEmptyLayout,
     CreateEmptyPivotLayout,
+    CreateEmptyTableLayout,
     CreateColumnFilter,
     CreateEmptyStyle,
     CreateEmptyCellSummmary,

package/src/View/Layout/Wizard/LayoutWizard.js

@@ -1,7 +1,6 @@
 import * as React from 'react';
 import * as LayoutRedux from '../../../Redux/ActionsReducers/LayoutRedux';
 import { OnePageAdaptableWizard, OnePageWizardSummary } from '../../Wizard/OnePageAdaptableWizard';
-import ObjectFactory from '../../../Utilities/ObjectFactory';
 import { cloneObject } from '../../../Utilities/Helpers/Helper';
 import { SettingsSection, SettingsSectionSummary } from './sections/SettingsSection';
 import { Box } from 'rebass';
@@ -29,17 +28,17 @@ export const LayoutWizard = (props) => {
         if (initialLayout) {
             preparedLayout = cloneObject(initialLayout);
             if (props?.popupParams?.action === 'Clone') {
-                preparedLayout.Name = '';
-                delete preparedLayout.Uuid;
+                preparedLayout = {
+                    ...adaptable.api.layoutApi.internalApi.cloneLayout(preparedLayout),
+                    Name: '',
+                };
             }
         }
         else {
             const shouldCreatePivot = props.popupParams?.config?.layoutType === 'pivot' ||
                 props.abObjectType?.name?.toLowerCase().includes('pivot') ||
                 false;
-            preparedLayout = shouldCreatePivot
-                ? ObjectFactory.CreateEmptyPivotLayout({ Name: '' })
-                : ObjectFactory.CreateEmptyLayout({ Name: '' });
+            preparedLayout = adaptable.api.layoutApi.internalApi.buildInitialLayout({ Name: '' }, shouldCreatePivot ? 'pivot' : 'table');
         }
         if (preparedLayout.SuppressAggFuncInHeader === undefined) {
             preparedLayout.SuppressAggFuncInHeader =
@@ -62,7 +61,6 @@ export const LayoutWizard = (props) => {
                 break;
             case 'Clone':
                 const clonedLayout = { ...layout };
-                delete clonedLayout.Uuid;
                 dispatch(LayoutRedux.LayoutAdd(clonedLayout));
                 dispatch(LayoutRedux.LayoutSelect(clonedLayout.Name));
                 break;

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: 1756391396935 || Date.now(),
-    VERSION: "21.0.0-canary.0" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1756456060910 || Date.now(),
+    VERSION: "21.0.0-canary.1" || '--current-version--',
 };

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

@@ -2408,22 +2408,6 @@ export declare const ADAPTABLE_METAMODEL: {
             ref?: undefined;
         })[];
     };
-    CustomEditColumnValueInfo: {
-        name: string;
-        kind: string;
-        desc: string;
-        props: ({
-            name: string;
-            kind: string;
-            desc: string;
-            isOpt: boolean;
-        } | {
-            name: string;
-            kind: string;
-            desc: string;
-            isOpt?: undefined;
-        })[];
-    };
     CustomEditColumnValuesContext: {
         name: string;
         kind: string;
@@ -3024,6 +3008,28 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    DefaultLayoutProperties: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            ref: string;
+        }[];
+    };
+    DefaultLayoutPropertiesContext: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
+    DefaultPivotLayoutProperties: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     DefaultPredicateFilterContext: {
         name: string;
         kind: string;
@@ -3040,6 +3046,11 @@ export declare const ADAPTABLE_METAMODEL: {
             ref: string;
         })[];
     };
+    DefaultTableLayoutProperties: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     DetailInitContext: {
         name: string;
         kind: string;
@@ -4037,27 +4048,28 @@ export declare const ADAPTABLE_METAMODEL: {
         name: string;
         kind: string;
         desc: string;
-        props: {
+        props: ({
             name: string;
             kind: string;
             desc: string;
-        }[];
+            isOpt?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+        })[];
     };
     InFilterValueInfo: {
         name: string;
         kind: string;
         desc: string;
-        props: ({
+        props: {
             name: string;
             kind: string;
             desc: string;
             isOpt: boolean;
-        } | {
-            name: string;
-            kind: string;
-            desc: string;
-            isOpt?: undefined;
-        })[];
+        }[];
     };
     InitialState: {
         name: string;
@@ -4244,13 +4256,13 @@ export declare const ADAPTABLE_METAMODEL: {
             kind: string;
             desc: string;
             isOpt: boolean;
-            ref: string;
+            ref?: undefined;
         } | {
             name: string;
             kind: string;
             desc: string;
             isOpt: boolean;
-            ref?: undefined;
+            ref: string;
         })[];
     };
     LayoutState: {