@adaptabletools/adaptable 12.0.0-canary.2 → 12.0.0-canary.3

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

@@ -31,7 +31,7 @@ export declare const ADAPTABLE_METAMODEL: {
             reference?: undefined;
         })[];
     };
-    ActionColumnButtonContext: {
+    ActionColumnContext: {
         name: string;
         kind: string;
         description: string;
@@ -756,26 +756,6 @@ export declare const ADAPTABLE_METAMODEL: {
             reference?: undefined;
         })[];
     };
-    AlertButtonContext: {
-        name: string;
-        kind: string;
-        description: string;
-        properties: ({
-            name: string;
-            kind: string;
-            description: string;
-            uiLabel: string;
-            reference: string;
-            isOptional?: undefined;
-        } | {
-            name: string;
-            kind: string;
-            description: string;
-            uiLabel: string;
-            isOptional: boolean;
-            reference: string;
-        })[];
-    };
     AlertDefinition: {
         name: string;
         kind: string;
@@ -820,6 +800,18 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         description: string;
     };
+    AlertFormContext: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference: string;
+        }[];
+    };
     AlertMessageContext: {
         name: string;
         kind: string;
@@ -1606,6 +1598,31 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         description: string;
     };
+    CreatedRowFormInfo: {
+        name: string;
+        kind: string;
+        description: string;
+    };
+    CreateRowFormContext: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: ({
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            isOptional: boolean;
+            reference: string;
+        } | {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            isOptional?: undefined;
+            reference?: undefined;
+        })[];
+    };
     CustomDestination: {
         name: string;
         kind: string;
@@ -1984,6 +2001,18 @@ export declare const ADAPTABLE_METAMODEL: {
             uiLabel: string;
         }[];
     };
+    DataSetFormContext: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference: string;
+        }[];
+    };
     DataUpdateConfig: {
         name: string;
         kind: string;
@@ -2021,6 +2050,16 @@ export declare const ADAPTABLE_METAMODEL: {
             defaultValue: string;
         }[];
     };
+    DeletedRowFormInfo: {
+        name: string;
+        kind: string;
+        description: string;
+    };
+    EditedRowFormInfo: {
+        name: string;
+        kind: string;
+        description: string;
+    };
     EditLookUpPermittedValues: {
         name: string;
         kind: string;
@@ -2059,6 +2098,24 @@ export declare const ADAPTABLE_METAMODEL: {
             defaultValue?: undefined;
         })[];
     };
+    EditRowFormContext: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: ({
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference: string;
+        } | {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference?: undefined;
+        })[];
+    };
     EntitlementOptions: {
         name: string;
         kind: string;
@@ -2555,6 +2612,18 @@ export declare const ADAPTABLE_METAMODEL: {
             isOptional: boolean;
         }[];
     };
+    FormContext: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+            reference: string;
+        }[];
+    };
     FreeTextColumn: {
         name: string;
         kind: string;
@@ -3676,6 +3745,11 @@ export declare const ADAPTABLE_METAMODEL: {
             reference: string;
         })[];
     };
+    RowFormContext: {
+        name: string;
+        kind: string;
+        description: string;
+    };
     RowFormOptions: {
         name: string;
         kind: string;
@@ -3696,6 +3770,16 @@ export declare const ADAPTABLE_METAMODEL: {
             defaultValue: string;
         })[];
     };
+    RowFormSubmittedInfo: {
+        name: string;
+        kind: string;
+        description: string;
+    };
+    RowFormType: {
+        name: string;
+        kind: string;
+        description: string;
+    };
     RowInfo: {
         name: string;
         kind: string;

package/src/metamodel/adaptable.metamodel.js

@@ -48,8 +48,8 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "ActionColumnButtonContext": {
-        "name": "ActionColumnButtonContext",
+    "ActionColumnContext": {
+        "name": "ActionColumnContext",
         "kind": "Interface",
         "description": "Context required by functions when using an Action Column Button",
         "properties": [
@@ -1963,28 +1963,6 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
-    "AlertButtonContext": {
-        "name": "AlertButtonContext",
-        "kind": "Interface",
-        "description": "Context required by functions when using an Alert Button",
-        "properties": [
-            {
-                "name": "alert",
-                "kind": "REFERENCE",
-                "description": "Alert that has been triggered",
-                "uiLabel": "Alert",
-                "reference": "AdaptableAlert"
-            },
-            {
-                "name": "formData",
-                "kind": "REFERENCE",
-                "description": "Data in the Alert Form",
-                "uiLabel": "Form Data",
-                "isOptional": true,
-                "reference": "unknown"
-            }
-        ]
-    },
     "AlertDefinition": {
         "name": "AlertDefinition",
         "kind": "Interface",
@@ -2054,6 +2032,20 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "TypeAlias",
         "description": "Form to show in an Alert"
     },
+    "AlertFormContext": {
+        "name": "AlertFormContext",
+        "kind": "Interface",
+        "description": "Context required by functions when using an Alert Button",
+        "properties": [
+            {
+                "name": "alert",
+                "kind": "REFERENCE",
+                "description": "Alert that has been triggered",
+                "uiLabel": "Alert",
+                "reference": "AdaptableAlert"
+            }
+        ]
+    },
     "AlertMessageContext": {
         "name": "AlertMessageContext",
         "kind": "Interface",
@@ -4166,6 +4158,32 @@ exports.ADAPTABLE_METAMODEL = {
         "kind": "TypeAlias",
         "description": "All available Country Intents"
     },
+    "CreatedRowFormInfo": {
+        "name": "CreatedRowFormInfo",
+        "kind": "Interface",
+        "description": "Info passed into RowFormSubmitted Event for Created Rows"
+    },
+    "CreateRowFormContext": {
+        "name": "CreateRowFormContext",
+        "kind": "Interface",
+        "description": "Context used in a Create Row Form",
+        "properties": [
+            {
+                "name": "clonedRowNode",
+                "kind": "REFERENCE",
+                "description": "The RowNode being cloned",
+                "uiLabel": "Cloned Row Node",
+                "isOptional": true,
+                "reference": "unknown"
+            },
+            {
+                "name": "type",
+                "kind": "unknown",
+                "description": "Type of the Context",
+                "uiLabel": "Type"
+            }
+        ]
+    },
     "CustomDestination": {
         "name": "CustomDestination",
         "kind": "Interface",
@@ -4463,13 +4481,6 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Custom Toolbar which hosts the Button",
                 "uiLabel": "Custom Toolbar",
                 "reference": "CustomToolbar"
-            },
-            {
-                "name": "dashboardState",
-                "kind": "REFERENCE",
-                "description": "Current Dashboard State",
-                "uiLabel": "Dashboard State",
-                "reference": "DashboardState"
             }
         ]
     },
@@ -5070,6 +5081,20 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "DataSetFormContext": {
+        "name": "DataSetFormContext",
+        "kind": "Interface",
+        "description": "Used when a DataSet displays a Form",
+        "properties": [
+            {
+                "name": "dataSet",
+                "kind": "REFERENCE",
+                "description": "The DataSet which triggered the Form",
+                "uiLabel": "Data Set",
+                "reference": "DataSet"
+            }
+        ]
+    },
     "DataUpdateConfig": {
         "name": "DataUpdateConfig",
         "kind": "Interface",
@@ -5167,6 +5192,16 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "DeletedRowFormInfo": {
+        "name": "DeletedRowFormInfo",
+        "kind": "Interface",
+        "description": "Info passed into RowFormSubmitted Event for Deleted Rows"
+    },
+    "EditedRowFormInfo": {
+        "name": "EditedRowFormInfo",
+        "kind": "Interface",
+        "description": "Info passed into RowFormSubmitted Event for Edited Rows"
+    },
     "EditLookUpPermittedValues": {
         "name": "EditLookUpPermittedValues",
         "kind": "Interface",
@@ -5175,7 +5210,7 @@ exports.ADAPTABLE_METAMODEL = {
     "EditOptions": {
         "name": "EditOptions",
         "kind": "Interface",
-        "description": "Options related to Editing in Adaptable.",
+        "description": "Options related to Editing in Adaptable - includes Server Validation, Smart Edit Operations and Row Forms",
         "properties": [
             {
                 "name": "displayServerValidationMessages",
@@ -5217,6 +5252,26 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "EditRowFormContext": {
+        "name": "EditRowFormContext",
+        "kind": "Interface",
+        "description": "Context used in an Edit Row Form",
+        "properties": [
+            {
+                "name": "rowNode",
+                "kind": "REFERENCE",
+                "description": "The RowNode being edited",
+                "uiLabel": "Row Node",
+                "reference": "unknown"
+            },
+            {
+                "name": "type",
+                "kind": "unknown",
+                "description": "Type of the Context",
+                "uiLabel": "Type"
+            }
+        ]
+    },
     "EntitlementOptions": {
         "name": "EntitlementOptions",
         "kind": "Interface",
@@ -7092,6 +7147,20 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "FormContext": {
+        "name": "FormContext",
+        "kind": "Interface",
+        "description": "Context supplied to Buttons that appear in an Adaptable Form",
+        "properties": [
+            {
+                "name": "formData",
+                "kind": "REFERENCE",
+                "description": "Adaptable Form Data",
+                "uiLabel": "Form Data",
+                "reference": "unknown"
+            }
+        ]
+    },
     "FreeTextColumn": {
         "name": "FreeTextColumn",
         "kind": "Interface",
@@ -10788,6 +10857,11 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "RowFormContext": {
+        "name": "RowFormContext",
+        "kind": "TypeAlias",
+        "description": "Context passed into a Row Form - can be `CreateRowFormContext` or `EditRowFormContext`"
+    },
     "RowFormOptions": {
         "name": "RowFormOptions",
         "kind": "Interface",
@@ -10834,6 +10908,16 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "RowFormSubmittedInfo": {
+        "name": "RowFormSubmittedInfo",
+        "kind": "TypeAlias",
+        "description": "Info passed into RowFormSubmitted Event - can be `CreatedRowFormInfo` or `EditedRowFormInfo` or `DeletedRowFormInfo`"
+    },
+    "RowFormType": {
+        "name": "RowFormType",
+        "kind": "TypeAlias",
+        "description": "Type of Row Form - Created, Edited or Deleted"
+    },
     "RowInfo": {
         "name": "RowInfo",
         "kind": "Interface",

package/src/types.d.ts

@@ -10,7 +10,7 @@ export { AdaptablePlugin } from './AdaptableOptions/AdaptablePlugin';
 export type { ContainerOptions } from './AdaptableOptions/ContainerOptions';
 export type { FlashingCellOptions } from './AdaptableOptions/FlashingCellOptions';
 export type { TOAST_POSITIONS, NotificationsOptions, } from './AdaptableOptions/NotificationsOptions';
-export type { AlertOptions, ActionHandler, AlertForm, AlertButtonContext, AlertMessageContext, } from './AdaptableOptions/AlertOptions';
+export type { AlertOptions, ActionHandler, AlertForm, AlertFormContext, AlertMessageContext, } from './AdaptableOptions/AlertOptions';
 export type { DashboardOptions, CustomToolbar, DashboardButtonContext, CustomToolbarButtonContext, } from './AdaptableOptions/DashboardOptions';
 export type { EditOptions, RowFormOptions, FormParamContext, FormFieldLabelContext, RowFormContext, CreateRowFormContext, EditRowFormContext, ValidationResult, SmartEditCustomOperation, SmartEditOperation, SmartEditOperationContext, } from './AdaptableOptions/EditOptions';
 export type { ExportOptions, SystemExportDestination, SystemExportDestinations, CustomDestination, CustomReport, DataFormatType, ExportFormContext, ReportContext, } from './AdaptableOptions/ExportOptions';
@@ -31,7 +31,7 @@ export type { FilterActionOnDataChange } from './PredefinedConfig/Common/FilterA
 export type { ConfigState } from './PredefinedConfig/ConfigState';
 export type { TeamSharingOptions } from './AdaptableOptions/TeamSharingOptions';
 export type { ToolPanelOptions, CustomToolPanel, ToolPanelButtonContext, CustomToolPanelButtonContext, } from './AdaptableOptions/ToolPanelOptions';
-export type { UserInterfaceOptions, CellValuesList, BasePermittedValues, PermittedValues, EditLookUpPermittedValues, FilterPermittedValues, CustomSortPermittedValues, BulkUpdatePermittedValues, EditLookUpContext, PermittedValuesContext, FilterPermittedValuesContext, BulkUpdatePermittedValuesContext, GridInfoSections, GridInfoSection, ObjectTagsContext, CustomDisplayFormatter, ActionColumnButtonContext, ActionColumn, ActionColumnSettings, ActionOptions, } from './AdaptableOptions/UserInterfaceOptions';
+export type { UserInterfaceOptions, CellValuesList, BasePermittedValues, PermittedValues, EditLookUpPermittedValues, FilterPermittedValues, CustomSortPermittedValues, BulkUpdatePermittedValues, EditLookUpContext, PermittedValuesContext, FilterPermittedValuesContext, BulkUpdatePermittedValuesContext, GridInfoSections, GridInfoSection, ObjectTagsContext, CustomDisplayFormatter, ActionColumnContext, ActionColumn, ActionColumnSettings, ActionOptions, } from './AdaptableOptions/UserInterfaceOptions';
 export type { MenuOptions } from './AdaptableOptions/MenuOptions';
 export type { CustomSettingsPanel, SettingsPanelOptions, } from './AdaptableOptions/SettingsPanelOptions';
 export type { EntitlementOptions, EntitlementContext } from './AdaptableOptions/EntitlementOptions';

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "12.0.0-canary.2";
+declare const _default: "12.0.0-canary.3";
 export default _default;

package/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '12.0.0-canary.2'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version
+exports.default = '12.0.0-canary.3'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version