@adaptabletools/adaptable 18.0.0-canary.1 → 18.0.0-canary.10

package/src/metamodel/adaptable.metamodel.js

@@ -661,6 +661,12 @@ export const ADAPTABLE_METAMODEL = {
                 "kind": "s",
                 "desc": "Name of Column in AG Grid (e.g. field or colId)"
             },
+            {
+                "name": "columnTypes",
+                "kind": "a",
+                "desc": "Column Types of the Column",
+                "isOpt": true
+            },
             {
                 "name": "dataType",
                 "kind": "R",
@@ -1035,16 +1041,6 @@ export const ADAPTABLE_METAMODEL = {
         "kind": "I",
         "desc": "Note that can be applied to a Cell in AdapTable",
         "props": [
-            {
-                "name": "AdaptableId",
-                "kind": "s",
-                "desc": "Id of this AdapTable instance"
-            },
-            {
-                "name": "Author",
-                "kind": "u",
-                "desc": "Author of the Note"
-            },
             {
                 "name": "ColumnId",
                 "kind": "s",
@@ -1055,15 +1051,15 @@ export const ADAPTABLE_METAMODEL = {
                 "kind": "u",
                 "desc": "Value in Grid's Primary Key Column"
             },
+            {
+                "name": "Text",
+                "kind": "s",
+                "desc": "Value of the Note"
+            },
             {
                 "name": "Timestamp",
                 "kind": "n",
                 "desc": "When Note was made"
-            },
-            {
-                "name": "Value",
-                "kind": "s",
-                "desc": "Value of the Note"
             }
         ]
     },
@@ -1172,7 +1168,7 @@ export const ADAPTABLE_METAMODEL = {
                 "isOpt": true,
                 "gridInfo": "item",
                 "noCode": "item",
-                "defVal": "'adaptable_id'"
+                "defVal": "'adaptable_id_$random_number'"
             },
             {
                 "name": "adaptableStateKey",
@@ -1198,6 +1194,13 @@ export const ADAPTABLE_METAMODEL = {
                 "gridInfo": "item",
                 "defVal": "false"
             },
+            {
+                "name": "autoMigrateState",
+                "kind": "b",
+                "desc": "Automatically migrate the state from the previous version of Adaptable to the current version.",
+                "isOpt": true,
+                "defVal": "true"
+            },
             {
                 "name": "calendarOptions",
                 "kind": "R",
@@ -1236,7 +1239,7 @@ export const ADAPTABLE_METAMODEL = {
                 "ref": "ColumnOptions"
             },
             {
-                "name": "commentsOptions",
+                "name": "commentOptions",
                 "kind": "u",
                 "desc": "Options for managing AdapTable Comments",
                 "isOpt": true
@@ -1376,11 +1379,11 @@ export const ADAPTABLE_METAMODEL = {
                 "gridInfo": "container"
             },
             {
-                "name": "notesOptions",
+                "name": "noteOptions",
                 "kind": "R",
-                "desc": "Options for managing AdapTable Comments",
+                "desc": "Options for managing Notes",
                 "isOpt": true,
-                "ref": "NotesOptions"
+                "ref": "unknown"
             },
             {
                 "name": "notificationsOptions",
@@ -3244,7 +3247,7 @@ export const ADAPTABLE_METAMODEL = {
             },
             {
                 "name": "columnTypes",
-                "kind": "a",
+                "kind": "u",
                 "desc": "Optional list of Column Types - used primarily for Calculated and FreeText Columns",
                 "isOpt": true,
                 "defVal": "undefined"
@@ -3295,6 +3298,36 @@ export const ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "CommentableCellContext": {
+        "name": "CommentableCellContext",
+        "kind": "I",
+        "desc": "Context used when determining if a Comment can be added to a Cell"
+    },
+    "CommentsOptions": {
+        "name": "CommentsOptions",
+        "kind": "I",
+        "desc": "Options for managing Comments and Comment Threads in AdapTable",
+        "props": [
+            {
+                "name": "isCellCommentable",
+                "kind": "f",
+                "desc": "Whether a cell can be noted on TODO: check if it works",
+                "isOpt": true
+            },
+            {
+                "name": "loadCommentThreads",
+                "kind": "f",
+                "desc": "Called to load initial comments",
+                "isOpt": true
+            },
+            {
+                "name": "persistCommentThreads",
+                "kind": "f",
+                "desc": "Called when comments change",
+                "isOpt": true
+            }
+        ]
+    },
     "CompatibleContext": {
         "name": "CompatibleContext",
         "kind": "A",
@@ -4382,6 +4415,12 @@ export const ADAPTABLE_METAMODEL = {
                 "desc": "Callback function invoked when a batch successfully updates",
                 "isOpt": true
             },
+            {
+                "name": "flushAsync",
+                "kind": "b",
+                "desc": "Whether to flush async updates.",
+                "isOpt": true
+            },
             {
                 "name": "runAsync",
                 "kind": "b",
@@ -4692,7 +4731,7 @@ export const ADAPTABLE_METAMODEL = {
                 "name": "report",
                 "kind": "R",
                 "desc": "The exported report",
-                "ref": "unknown"
+                "ref": "Report"
             },
             {
                 "name": "reportData",
@@ -4833,6 +4872,12 @@ export const ADAPTABLE_METAMODEL = {
                 "kind": "u",
                 "desc": "All Expression Functions available to AdaptableQL"
             },
+            {
+                "name": "getRowNodes",
+                "kind": "u",
+                "desc": "Get custom list rows",
+                "isOpt": true
+            },
             {
                 "name": "namedQueryCallStack",
                 "kind": "a",
@@ -6091,6 +6136,20 @@ export const ADAPTABLE_METAMODEL = {
         "kind": "A",
         "desc": "Type for FDC3 Instrument List Context"
     },
+    "InteropioPluginOptions": {
+        "name": "InteropioPluginOptions",
+        "kind": "I",
+        "desc": "Options for using the Interop plugin",
+        "props": [
+            {
+                "name": "showAdaptableAlertsAsNotifications",
+                "kind": "b",
+                "desc": "Converts AdapTable Alerts configured to display in popup as Interop Notifications",
+                "isOpt": true,
+                "defVal": "true"
+            }
+        ]
+    },
     "IPushPullDomain": {
         "name": "IPushPullDomain",
         "kind": "I",
@@ -6287,6 +6346,12 @@ export const ADAPTABLE_METAMODEL = {
                 "desc": "Columns which are row-grouped when the Layout is applied",
                 "isOpt": true
             },
+            {
+                "name": "RowSummaries",
+                "kind": "a",
+                "desc": "Row summaries",
+                "isOpt": true
+            },
             {
                 "name": "SuppressAggFuncInHeader",
                 "kind": "b",
@@ -6708,8 +6773,8 @@ export const ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "NoteState": {
-        "name": "NoteState",
+    "NotesState": {
+        "name": "NotesState",
         "kind": "I",
         "desc": "Predefined Configuration for Notes Module",
         "props": [
@@ -7277,9 +7342,9 @@ export const ADAPTABLE_METAMODEL = {
             {
                 "name": "Notes",
                 "kind": "R",
-                "desc": "Collection of notes that can be edited on cell level",
+                "desc": "Collection of personal Notes that are edited at Cell level",
                 "isOpt": true,
-                "ref": "unknown"
+                "ref": "NotesState"
             },
             {
                 "name": "PlusMinus",
@@ -7465,7 +7530,7 @@ export const ADAPTABLE_METAMODEL = {
                 "name": "report",
                 "kind": "R",
                 "desc": "Report being exported",
-                "ref": "unknown"
+                "ref": "Report"
             }
         ]
     },
@@ -7757,8 +7822,8 @@ export const ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "Report_2": {
-        "name": "Report_2",
+    "Report": {
+        "name": "Report",
         "kind": "I",
         "desc": "A Report which can export data from AdapTable",
         "props": [
@@ -7809,7 +7874,7 @@ export const ADAPTABLE_METAMODEL = {
                 "name": "report",
                 "kind": "R",
                 "desc": "Definition of Report being Run",
-                "ref": "unknown"
+                "ref": "Report"
             },
             {
                 "name": "reportData",
@@ -8931,6 +8996,33 @@ export const ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "UpgradeConfig": {
+        "name": "UpgradeConfig",
+        "kind": "I",
+        "desc": "The upgrade config object",
+        "props": [
+            {
+                "name": "fromVersion",
+                "kind": "n",
+                "desc": "The version to upgrade from"
+            },
+            {
+                "name": "logger",
+                "kind": "R",
+                "desc": "The logger object",
+                "isOpt": true,
+                "defVal": "The console object",
+                "ref": "unknown"
+            },
+            {
+                "name": "toVersion",
+                "kind": "n",
+                "desc": "The version to upgrade to",
+                "isOpt": true,
+                "defVal": "The current version"
+            }
+        ]
+    },
     "UserColumnMenuItem": {
         "name": "UserColumnMenuItem",
         "kind": "I",
@@ -9113,6 +9205,27 @@ export const ADAPTABLE_METAMODEL = {
                 "desc": "Custom column values for Values Column Filter and Grid Filter Builder",
                 "isOpt": true
             },
+            {
+                "name": "loadingScreenDelay",
+                "kind": "n",
+                "desc": "Delay in milliseconds before Loading Screen appears. `showLoadingScreen` must be true for this to take effect",
+                "isOpt": true,
+                "defVal": "200"
+            },
+            {
+                "name": "loadingScreenText",
+                "kind": "s",
+                "desc": "Text to display in Loading Screen.",
+                "isOpt": true,
+                "defVal": "'Retrieving your settings and setting up the grid...'"
+            },
+            {
+                "name": "loadingScreenTitle",
+                "kind": "s",
+                "desc": "Title to display in Loading Screen.",
+                "isOpt": true,
+                "defVal": "'Initialising Grid'"
+            },
             {
                 "name": "objectTags",
                 "kind": "u",
@@ -9228,7 +9341,7 @@ export const ADAPTABLE_METAMODEL = {
     "ValuesFilterOptions": {
         "name": "ValuesFilterOptions",
         "kind": "I",
-        "desc": "Options for managing the Values (IN) Column Filter",
+        "desc": "Options for managing the Values (IN) Filter in Filter Bar and Filter Form",
         "props": [
             {
                 "name": "filterValuesUsingTime",
@@ -9249,12 +9362,12 @@ export const ADAPTABLE_METAMODEL = {
             },
             {
                 "name": "maxFilterValuesToDisplay",
-                "kind": "n",
-                "desc": "Distinct column items to display in Filter Form; useful with large datasource (though AdapTable offers virtualisation)",
+                "kind": "u",
+                "desc": "Distinct column items to display in Values Filter; useful with large datasource (though AdapTable offers virtualisation)",
                 "isOpt": true,
                 "gridInfo": "item",
                 "noCode": "item",
-                "defVal": "2,000"
+                "defVal": "undefined"
             },
             {
                 "name": "showDistinctFilteredValuesOnly",

package/src/migration/AdaptableUpgradeHelper.d.ts

@@ -0,0 +1,38 @@
+import { VersionUpgrade } from './VersionUpgrade';
+import { AdaptableState } from '../PredefinedConfig/AdaptableState';
+/**
+ * The upgrade config object
+ */
+export interface UpgradeConfig {
+    /**
+     * The version to upgrade from
+     */
+    fromVersion: number;
+    /**
+     * The version to upgrade to
+     *
+     * @defaultValue The current version
+     */
+    toVersion?: number;
+    /**
+     * The logger object
+     *
+     * @defaultValue The console object
+     */
+    logger?: MigrationLogger;
+}
+export interface MigrationLogger {
+    success: (message: string, ...optionalParams: any[]) => void;
+    info: (message: string, ...optionalParams: any[]) => void;
+    warn: (message: string, ...optionalParams: any[]) => void;
+    error: (message: string, ...optionalParams: any[]) => void;
+}
+export declare class AdaptableUpgradeHelper {
+    protected currentMajorVersion: number;
+    protected versionUpgrades: Map<number, VersionUpgrade>;
+    protected logger: MigrationLogger;
+    private constructor();
+    static migrateAdaptableState(state: AdaptableState, config: UpgradeConfig): AdaptableState;
+    private getCurrentMajorVersion;
+    private getConsoleLogger;
+}

package/src/migration/AdaptableUpgradeHelper.js

@@ -0,0 +1,48 @@
+import { VersionUpgrade17 } from './VersionUpgrade17';
+import { VersionUpgrade18 } from './VersionUpgrade18';
+import { ADAPTABLE_VERSION } from '../EnvVars';
+export class AdaptableUpgradeHelper {
+    constructor(logger) {
+        this.currentMajorVersion = this.getCurrentMajorVersion(ADAPTABLE_VERSION);
+        this.logger = logger || this.getConsoleLogger();
+        this.versionUpgrades = new Map();
+        this.versionUpgrades.set(17, new VersionUpgrade17(this.logger));
+        this.versionUpgrades.set(18, new VersionUpgrade18(this.logger));
+    }
+    static migrateAdaptableState(state, config) {
+        const upgradeHelper = new AdaptableUpgradeHelper(config.logger);
+        let fromVersion = (config === null || config === void 0 ? void 0 : config.fromVersion) || 16;
+        const toVersion = (config === null || config === void 0 ? void 0 : config.toVersion) || upgradeHelper.currentMajorVersion;
+        if (fromVersion >= toVersion) {
+            console.warn(`The fromVersion (${fromVersion}) should be less than toVersion (${toVersion})!`);
+            return state;
+        }
+        if (fromVersion < 16) {
+            // until version 16 we didn't have versioning
+            fromVersion = 16;
+        }
+        const versionUpgrades = Array.from(upgradeHelper.versionUpgrades.keys());
+        let updatedState = structuredClone(state);
+        for (const version of versionUpgrades) {
+            if (version > fromVersion && version <= toVersion) {
+                upgradeHelper.logger.info(`Migration to ${version} started...`);
+                updatedState = upgradeHelper.versionUpgrades.get(version).migrateState(updatedState);
+                upgradeHelper.logger.info(`Migration to ${version} finished!`);
+            }
+        }
+        return updatedState;
+    }
+    getCurrentMajorVersion(version) {
+        // is good enough for now, we just need to make sure we don't forget to update it
+        // TODO AFL is there a better way to do this for local development?
+        return parseInt(version.split('.')[0]) || 18;
+    }
+    getConsoleLogger() {
+        return {
+            success: console.log,
+            info: console.info,
+            warn: console.warn,
+            error: console.error,
+        };
+    }
+}

package/src/migration/VersionUpgrade.d.ts

@@ -0,0 +1,8 @@
+import { AdaptableState } from '../PredefinedConfig/AdaptableState';
+import { MigrationLogger } from './AdaptableUpgradeHelper';
+export declare abstract class VersionUpgrade {
+    protected logger: MigrationLogger;
+    constructor(logger: MigrationLogger);
+    abstract migrateState(state: AdaptableState): AdaptableState;
+    protected migrateStateWithMethods(state: AdaptableState, methods: ((state: AdaptableState) => AdaptableState)[]): AdaptableState;
+}

package/src/migration/VersionUpgrade.js

@@ -0,0 +1,11 @@
+export class VersionUpgrade {
+    constructor(logger) {
+        this.logger = logger;
+    }
+    migrateStateWithMethods(state, methods) {
+        for (let method of methods) {
+            state = method.call(this, state);
+        }
+        return state;
+    }
+}

package/src/migration/VersionUpgrade17.d.ts

@@ -0,0 +1,18 @@
+import { VersionUpgrade } from './VersionUpgrade';
+import { AdaptableState } from '../PredefinedConfig/AdaptableState';
+export declare class VersionUpgrade17 extends VersionUpgrade {
+    migrateState(state: AdaptableState): AdaptableState;
+    private migrateChartingState;
+    private migrateColumnFilterState;
+    private migrateDashboardState;
+    private migrateFlashinCellState;
+    private migrateFormatColumnState;
+    private migrateFreeTextColumnState;
+    private migrateGridFilterState;
+    private migrateNamedQueryState;
+    private migrateStyledColumnState;
+    private migrateToolPanelState;
+    private migrateAlertState;
+    private migrateCalculatedColumnState;
+    private migrateUserState;
+}