@adaptabletools/adaptable 16.1.0 → 16.1.1-canary.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "16.1.0",
+  "version": "16.1.1-canary.0",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1698160309123;
+declare const _default: 1698254886109;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1698160309123;
+exports.default = 1698254886109;

package/src/AdaptableOptions/AdaptableOptions.d.ts

@@ -262,7 +262,7 @@ export interface AdaptableOptions<TData = any> {
     /**
      *
      */
-    dataImportOptions?: DataImportOptions<TData>;
+    dataImportOptions?: DataImportOptions;
     /**
      * Used for managing the AdapTable Plugins
      */

package/src/AdaptableOptions/DataImportOptions.d.ts

@@ -14,7 +14,7 @@ export interface DataImportOptions<T = Record<string, unknown>> {
     /**
      * Function to validate the imported Data
      */
-    validate?: (context: DataImportValidateContext) => DataImportValidationError[] | null;
+    validate?: (context: DataImportValidateContext<T>) => DataImportValidationError[] | undefined;
     /**
      * Function to apply the Import (instead of AdapTable)
      */
@@ -23,6 +23,10 @@ export interface DataImportOptions<T = Record<string, unknown>> {
      * Function to preprocess the data before it is imported
      */
     preprocessData?: (context: PreprocessDataContext<T>) => Record<string, unknown>[];
+    /**
+     * Function to get the Primary Key value for a row of data. It defaults to the value of the `AdaptableOptions.primaryKey` column
+     */
+    getPrimaryKeyValue?: (context: GetPrimaryKeyValueContext<T>) => string | number;
 }
 export interface PreprocessDataContext<T = Record<string, unknown>> extends BaseContext {
     /**
@@ -65,3 +69,12 @@ export interface DataImportValidateContext<T = Record<string, unknown>> extends
      */
     rowData: T;
 }
+/**
+ * Context that manages Data Validation
+ */
+export interface GetPrimaryKeyValueContext<T = Record<string, unknown>> extends BaseContext {
+    /**
+     * Data being imported
+     */
+    rowData: T;
+}

package/src/AdaptableOptions/MenuOptions.d.ts

@@ -4,13 +4,6 @@ import { AdaptableColumn, AdaptableIcon, AdaptableModule, BaseContext } from '..
  * Options for managing menus in AdapTable
  */
 export interface MenuOptions<TData = any> {
-    /**
-     * Adds 'Ungroup' Column Menu item to a row grouped column menu
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     */
-    showUngroupColumnMenuItem?: boolean;
     /**
      * Customised Context Menu. Default context menu items are available in the provided context.
      */
@@ -35,6 +28,14 @@ export interface MenuOptions<TData = any> {
      * @gridInfoItem
      */
     showAdaptableColumnMenu?: boolean | ((menuItem: AdaptableMenuItem, menuContext: ColumnMenuContext<TData>) => boolean);
+    /**
+     * Adds 'Ungroup' Column Menu item to a row grouped column menu
+     *
+     * @deprecated Now provided by AG Grid and property is ignored
+     * @defaultValue true
+     * @gridInfoItem
+     */
+    showUngroupColumnMenuItem?: boolean;
     /**
      * Order in which AG Grid, AdapTable and User Menu sections will appear in Column Menu (list or function)
      *
@@ -73,12 +74,12 @@ export interface CustomContextMenuContext<TData = any> extends ContextMenuContex
      */
     defaultAgGridMenuItems: AgGridMenuItem<AgGridContextMenuItemType>[];
     /**
-     * Default Adaptable Menu Items
+     * Default AdapTable Menu Items
      */
     defaultAdaptableMenuItems: AdaptableSystemMenuItem[];
 }
 /**
- * Context info provided when building Custom Context Menus
+ * Context info provided when building Custom Column Menus
  */
 export interface CustomColumnMenuContext<TData = any> extends ColumnMenuContext<TData> {
     /**
@@ -86,7 +87,7 @@ export interface CustomColumnMenuContext<TData = any> extends ColumnMenuContext<
      */
     defaultAgGridMenuItems: AgGridMenuItem<AgGridColumnMenuItemType>[];
     /**
-     * Default Adaptable Menu Items
+     * Default AdapTable Menu Items
      */
     defaultAdaptableMenuItems: AdaptableSystemMenuItem[];
 }

package/src/Api/Implementation/OptionsApiImpl.d.ts

@@ -43,5 +43,5 @@ export declare class OptionsApiImpl extends ApiBase implements OptionsApi {
     getFlashingCellOptions(): FlashingCellOptions;
     getSettingsPanelOptions(): SettingsPanelOptions;
     getFdc3Options(): Fdc3Options;
-    getDataImportOptions(): import("../../types").DataImportOptions<any>;
+    getDataImportOptions(): import("../../types").DataImportOptions<Record<string, unknown>>;
 }

package/src/View/DataImport/DataImportWizard/DataImportWizard.js

@@ -14,13 +14,19 @@ const ValidationSection_1 = require("./sections/ValidationSection");
 const DataImportWizard = (props) => {
     var _a;
     const adaptable = (0, AdaptableContext_1.useAdaptable)();
-    const primaryKey = adaptable.api.optionsApi.getPrimaryKey();
     const dataImportOptions = adaptable.api.optionsApi.getDataImportOptions();
     const module = adaptable.ModuleService.getModuleById('DataImport');
     const [rowData, setRowData] = React.useState(null);
     const [file, setFile] = React.useState(null);
     const [text, setText] = React.useState('');
     const [importType, setImportType] = React.useState('file');
+    const primaryKey = adaptable.api.optionsApi.getPrimaryKey();
+    const getPrimaryKeyValue = (rowData) => {
+        if (typeof dataImportOptions.getPrimaryKeyValue === 'function') {
+            return dataImportOptions.getPrimaryKeyValue(Object.assign(Object.assign({}, (0, ObjectFactory_1.createBaseContext)(adaptable.api)), { rowData }));
+        }
+        return rowData[primaryKey];
+    };
     const handleRowDataChange = React.useCallback((data) => {
         if (Array.isArray(data)) {
             setRowData(data);
@@ -120,8 +126,9 @@ const DataImportWizard = (props) => {
         }
         return (_a = rowData === null || rowData === void 0 ? void 0 : rowData.reduce) === null || _a === void 0 ? void 0 : _a.call(rowData, (acc, rowData) => {
             const error = dataImportOptions.validate(Object.assign({ rowData }, (0, ObjectFactory_1.createBaseContext)(adaptable.api)));
-            if (error && rowData[primaryKey] && error.length) {
-                acc[rowData[primaryKey]] = error;
+            const primaryKeyValue = getPrimaryKeyValue(rowData);
+            if (error && primaryKeyValue && error.length) {
+                acc[primaryKeyValue] = error;
             }
             return acc;
         }, {});
@@ -132,7 +139,7 @@ const DataImportWizard = (props) => {
     };
     const handleFinish = () => {
         const validData = rowData.filter((row) => {
-            const rowErrors = errors[row[primaryKey]];
+            const rowErrors = errors[getPrimaryKeyValue(row)];
             return !rowErrors || rowErrors.length === 0;
         });
         adaptable.api.dataImportApi.internalApi.importData(validData);

package/src/View/DataImport/DataImportWizard/sections/DataPreview.js

@@ -11,6 +11,7 @@ const Tag_1 = require("../../../../components/Tag");
 const AdaptableContext_1 = require("../../../AdaptableContext");
 const AdaptablePopover_1 = require("../../../AdaptablePopover");
 const UIHelper_1 = tslib_1.__importDefault(require("../../../UIHelper"));
+const ObjectFactory_1 = require("../../../../Utilities/ObjectFactory");
 const tableDOMProps = {
     style: {
         height: '100%',
@@ -34,6 +35,7 @@ const getCellError = (errors, primaryKeyValue, columnId) => {
 };
 const DataPreview = (props) => {
     const adaptable = (0, AdaptableContext_1.useAdaptable)();
+    const dataImportOptions = adaptable.api.optionsApi.getDataImportOptions();
     if (!props.data) {
         return (React.createElement(HelpBlock_1.default, { color: 'var(--ab-color-error)' },
             "No Data has been Imported. Go to ",
@@ -61,6 +63,12 @@ const DataPreview = (props) => {
             }
             return dataType;
         };
+        const getPrimaryKeyValue = (rowData) => {
+            if (typeof dataImportOptions.getPrimaryKeyValue === 'function') {
+                return dataImportOptions.getPrimaryKeyValue(Object.assign(Object.assign({}, (0, ObjectFactory_1.createBaseContext)(adaptable.api)), { rowData }));
+            }
+            return rowData[primaryKey];
+        };
         const infiniteColumns = adaptableColumnsInData.reduce((acc, column) => {
             const isPrimaryKey = column.columnId === primaryKey;
             let editable = !isPrimaryKey;
@@ -104,7 +112,7 @@ const DataPreview = (props) => {
             minWidth: 90,
             renderValue: (params) => {
                 try {
-                    const isExistingRow = adaptable.api.gridApi.getRowNodeForPrimaryKey(params.data[primaryKey]);
+                    const isExistingRow = adaptable.api.gridApi.getRowNodeForPrimaryKey(getPrimaryKeyValue(params.data));
                     return isExistingRow ? 'Update' : 'New';
                 }
                 catch (error) {

package/src/View/DataImport/systemFileHandlers.js

@@ -19,7 +19,7 @@ const parseCSV = (content) => {
             const item = {};
             for (let j = 0; j < headers.length; j++) {
                 const value = values[j];
-                item[headers[j]] = isNaN(Number(value)) ? value : Number(value);
+                item[headers[j]] = value === '' || isNaN(Number(value)) ? value : Number(value);
             }
             data.push(item);
         }

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

@@ -3238,6 +3238,16 @@ export declare const ADAPTABLE_METAMODEL: {
             desc: string;
         }[];
     };
+    GetPrimaryKeyValueContext: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+        }[];
+    };
     GlobalExpressionFunctionsContext: {
         name: string;
         kind: string;