@adaptabletools/adaptable 18.0.0-canary.2 → 18.0.0-canary.4

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"
             }
         ]
     },
@@ -1236,7 +1226,7 @@ export const ADAPTABLE_METAMODEL = {
                 "ref": "ColumnOptions"
             },
             {
-                "name": "commentsOptions",
+                "name": "commentOptions",
                 "kind": "u",
                 "desc": "Options for managing AdapTable Comments",
                 "isOpt": true
@@ -1376,11 +1366,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 +3285,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 +4712,7 @@ export const ADAPTABLE_METAMODEL = {
                 "name": "report",
                 "kind": "R",
                 "desc": "The exported report",
-                "ref": "unknown"
+                "ref": "Report"
             },
             {
                 "name": "reportData",
@@ -6091,6 +6111,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 +6742,8 @@ export const ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "NoteState": {
-        "name": "NoteState",
+    "NotesState": {
+        "name": "NotesState",
         "kind": "I",
         "desc": "Predefined Configuration for Notes Module",
         "props": [
@@ -7277,9 +7311,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 +7499,7 @@ export const ADAPTABLE_METAMODEL = {
                 "name": "report",
                 "kind": "R",
                 "desc": "Report being exported",
-                "ref": "unknown"
+                "ref": "Report"
             }
         ]
     },
@@ -7757,8 +7791,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 +7843,7 @@ export const ADAPTABLE_METAMODEL = {
                 "name": "report",
                 "kind": "R",
                 "desc": "Definition of Report being Run",
-                "ref": "unknown"
+                "ref": "Report"
             },
             {
                 "name": "reportData",
@@ -9228,7 +9262,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 +9283,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/types.d.ts

@@ -22,12 +22,14 @@ export type { DataImportValidationError, DataImportOptions, DataImportFileHandle
 export type { DataSetOptions, DataSet, DataSetFormContext, } from './AdaptableOptions/DataSetOptions';
 export type { CellSummaryOptions } from './AdaptableOptions/CellSummaryOptions';
 export type { CustomSortOptions, ColumnValuesComparer } from './AdaptableOptions/CustomSortOptions';
-export type { NotesOptions, NotableCellContext } from './AdaptableOptions/NotesOptions';
+export type { NoteOptions as NotesOptions, NotableCellContext } from './AdaptableOptions/NoteOptions';
+export type { CommentsOptions, CommentableCellContext, CommentLoadContext as CommentsLoadContext } from './AdaptableOptions/CommentOptions';
 export type { GroupingOptions, BalancedGroupsKeyContext, } from './AdaptableOptions/GroupingOptions';
 export type { IPushPullPluginOptions } from './AdaptableOptions/IPushPullPluginOptions';
 export type { LayoutOptions, LayoutViewOptions, LayoutTagOptions, LayoutAvailableContext, AutoGenerateTagsForLayoutsContext, LayoutAssociatedObject, PivotPreviewColumnsContext, } from './AdaptableOptions/LayoutOptions';
 export type { ChartingOptions, ChartContainer, ExternalChartingContext, ExternalChartingOptions, } from './AdaptableOptions/ChartingOptions';
 export type { OpenFinPluginOptions } from './AdaptableOptions/OpenFinPluginOptions';
+export type { InteropioPluginOptions } from './AdaptableOptions/InteropioPluginOptions';
 export type { MasterDetailPluginOptions, DetailInitContext, } from './AdaptableOptions/MasterDetailPluginOptions';
 export type { DateInputOptions } from './AdaptableOptions/DateInputOptions';
 export type { ColumnFilterOptions, QuickFilterOptions, FilterFormOptions, ValuesFilterOptions, ColumnFilterContext, } from './AdaptableOptions/ColumnFilterOptions';
@@ -40,7 +42,7 @@ export type { AggregationColumns, WeightedAverageAggregation, } from './Predefin
 export type { AccessLevel, Entitlement } from './PredefinedConfig/Common/Entitlement';
 export type { FilterActionOnDataChange } from './PredefinedConfig/Common/FilterActionOnDataChange';
 export type { ConfigState } from './PredefinedConfig/ConfigState';
-export type { AdaptableNote, NotesState as NoteState, AdaptableNotes, } from './PredefinedConfig/NotesState';
+export type { AdaptableNote, NotesState, AdaptableNotes, } from './PredefinedConfig/NotesState';
 export type { TeamSharingOptions, SharedEntitiesContext, } from './AdaptableOptions/TeamSharingOptions';
 export type { ToolPanelOptions, CustomToolPanel, ToolPanelButtonContext, CustomToolPanelButtonContext, } from './AdaptableOptions/ToolPanelOptions';
 export type { UserInterfaceOptions, BasePermittedValues, PermittedValues, EditLookUpPermittedValues, FilterPermittedValues, CustomSortPermittedValues, BulkUpdatePermittedValues, EditLookUpContext, PermittedValuesContext, FilterPermittedValuesContext, BulkUpdatePermittedValuesContext, ObjectTagsContext, CustomIcon, } from './AdaptableOptions/UserInterfaceOptions';
@@ -81,6 +83,7 @@ export type { FreeTextColumnApi } from './Api/FreeTextColumnApi';
 export type { GridApi } from './Api/GridApi';
 export type { IPushPullApi } from './Api/IPushPullApi';
 export type { LayoutApi } from './Api/LayoutApi';
+export type { InteropioPluginApi } from './Api/InteropioPluginApi';
 export type { OpenFinApi } from './Api/OpenFinApi';
 export type { OptionsApi } from './Api/OptionsApi';
 export type { PluginsApi } from './Api/PluginsApi';