@adaptabletools/adaptable 18.0.0-canary.3 → 18.0.0-canary.5

package/src/components/InfiniteTable/index.js

@@ -1,8 +1,8 @@
 import { InfiniteTable } from '@infinite-table/infinite-react';
 export * from '@infinite-table/infinite-react';
-import env from '../../env';
+import { INFINITE_TABLE_LICENSE_KEY } from '../../EnvVars';
 const defaultProps = InfiniteTable.defaultProps;
-defaultProps.licenseKey = env.INFINITE_TABLE_LICENSE_KEY;
+defaultProps.licenseKey = INFINITE_TABLE_LICENSE_KEY;
 defaultProps.sortable = false;
 defaultProps.rowHeight = '--ab-grid-row-height';
 defaultProps.draggableColumns = false;

package/src/components/Modal/index.d.ts

@@ -1,5 +1,6 @@
 import * as React from 'react';
 import { FlexProps } from 'rebass';
+export declare const ensurePortalElement: () => HTMLElement;
 export interface ModalProps extends FlexProps {
     isOpen?: boolean;
     baseZIndex?: number;

package/src/components/Modal/index.js

@@ -9,15 +9,16 @@ import { baseClassName, default as Backdrop } from './Backdrop';
 import { createUuid } from '../utils/uuid';
 import { isBrowserDocumentAvailable } from '../../View/UIHelper';
 let portalElement;
-const ensurePortalElement = () => {
+export const ensurePortalElement = () => {
     if (!isBrowserDocumentAvailable()) {
-        return;
+        return null;
     }
     if (portalElement) {
-        return;
+        return portalElement;
     }
     portalElement = document.createElement('div');
     document.body.appendChild(portalElement);
+    return portalElement;
 };
 let globalCounter = 0;
 export const Modal = (props) => {

package/src/components/Select/Select.d.ts

@@ -10,6 +10,8 @@ export type SelectProps<SelectValue extends unknown, IsMulti extends boolean = f
     options: readonly SelectOption<SelectValue>[] | SelectOption<SelectValue>[];
     disabled?: boolean;
     menuPosition?: 'fixed' | 'absolute';
+    menuPlacement?: 'auto' | 'bottom' | 'top';
+    searchable?: boolean;
     isClearable?: boolean;
     isMulti?: IsMulti;
     onChange: (value: IsMulti extends true ? SelectValue[] : SelectValue) => void;

package/src/components/Select/Select.js

@@ -12,7 +12,7 @@ const commonStyles = ({ isFocused, isDisabled, }) => {
     };
 };
 export const Select = function (props) {
-    var _a, _b, _c, _d, _e, _f, _g;
+    var _a, _b, _c, _d, _e, _f, _g, _h;
     const doesOptionMatchValue = function (option) {
         if (typeof option.value === 'object' && option.value instanceof Date) {
             return isSameDay(option.value, props.value);
@@ -80,7 +80,7 @@ export const Select = function (props) {
                 React.createElement(Icon, { name: "triangle-down", style: { height: 20, width: 20 } })));
         };
     }, []);
-    return (React.createElement(SelectComponent, { onInputChange: props.onInputChange, onFocus: props.onFocus, isLoading: props.isLoding, options: props.options, className: props.className, isDisabled: disabled, isMulti: props.isMulti, value: selectedOption, menuPosition: (_g = props.menuPosition) !== null && _g !== void 0 ? _g : 'absolute', 
+    return (React.createElement(SelectComponent, { onInputChange: props.onInputChange, onFocus: props.onFocus, isLoading: props.isLoding, options: props.options, className: props.className, isDisabled: disabled, menuPlacement: (_g = props.menuPlacement) !== null && _g !== void 0 ? _g : 'auto', isSearchable: props.searchable, isMulti: props.isMulti, value: selectedOption, menuPosition: (_h = props.menuPosition) !== null && _h !== void 0 ? _h : 'absolute', 
         // This needed so the menu is not clipped by overflow: hidden
         menuPortalTarget: document.body, isClearable: props.isClearable, onChange: (option) => {
             if (props.isMulti) {

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     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: 1707926744158 || Date.now(),
-    VERSION: "18.0.0-canary.3" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1710513512221 || Date.now(),
+    VERSION: "18.0.0-canary.5" || '--current-version--',
 };

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

@@ -681,6 +681,15 @@ export declare const ADAPTABLE_METAMODEL: {
             noCode: string;
             defVal?: undefined;
             ref?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            defVal: string;
+            gridInfo?: undefined;
+            noCode?: undefined;
+            ref?: undefined;
         } | {
             name: string;
             kind: string;
@@ -735,15 +744,6 @@ export declare const ADAPTABLE_METAMODEL: {
             gridInfo?: undefined;
             defVal?: undefined;
             ref?: undefined;
-        } | {
-            name: string;
-            kind: string;
-            desc: string;
-            isOpt: boolean;
-            defVal: string;
-            gridInfo?: undefined;
-            noCode?: undefined;
-            ref?: undefined;
         } | {
             name: string;
             kind: string;
@@ -1927,6 +1927,22 @@ export declare const ADAPTABLE_METAMODEL: {
             ref: string;
         })[];
     };
+    CommentableCellContext: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
+    CommentsOptions: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+        }[];
+    };
     CompatibleContext: {
         name: string;
         kind: string;
@@ -3659,6 +3675,18 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    InteropioPluginOptions: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            defVal: string;
+        }[];
+    };
     IPushPullDomain: {
         name: string;
         kind: string;
@@ -3955,7 +3983,7 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt: boolean;
         }[];
     };
-    NoteState: {
+    NotesState: {
         name: string;
         kind: string;
         desc: string;
@@ -4512,7 +4540,7 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt?: undefined;
         })[];
     };
-    Report_2: {
+    Report: {
         name: string;
         kind: string;
         desc: string;

package/src/metamodel/adaptable.metamodel.js

@@ -1035,16 +1035,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 +1045,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"
             }
         ]
     },
@@ -1198,6 +1188,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 +1233,7 @@ export const ADAPTABLE_METAMODEL = {
                 "ref": "ColumnOptions"
             },
             {
-                "name": "commentsOptions",
+                "name": "commentOptions",
                 "kind": "u",
                 "desc": "Options for managing AdapTable Comments",
                 "isOpt": true
@@ -1376,11 +1373,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",
@@ -3295,6 +3292,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",
@@ -4692,7 +4719,7 @@ export const ADAPTABLE_METAMODEL = {
                 "name": "report",
                 "kind": "R",
                 "desc": "The exported report",
-                "ref": "unknown"
+                "ref": "Report"
             },
             {
                 "name": "reportData",
@@ -6091,6 +6118,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",
@@ -6708,8 +6749,8 @@ export const ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "NoteState": {
-        "name": "NoteState",
+    "NotesState": {
+        "name": "NotesState",
         "kind": "I",
         "desc": "Predefined Configuration for Notes Module",
         "props": [
@@ -7277,9 +7318,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 +7506,7 @@ export const ADAPTABLE_METAMODEL = {
                 "name": "report",
                 "kind": "R",
                 "desc": "Report being exported",
-                "ref": "unknown"
+                "ref": "Report"
             }
         ]
     },
@@ -7757,8 +7798,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 +7850,7 @@ export const ADAPTABLE_METAMODEL = {
                 "name": "report",
                 "kind": "R",
                 "desc": "Definition of Report being Run",
-                "ref": "unknown"
+                "ref": "Report"
             },
             {
                 "name": "reportData",
@@ -9228,7 +9269,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 +9290,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;
+}