Deprecate rowID and primaryKey in grid interfaces (#13427)

* refactor(Grid): deprecate rowID and rowData props from the grid eventArgs #10617

* chore(*): address review comment for editDoneArgs

* chore(*): update the tests according new API changes

* chore(*): fix tests accordinly newly addressed API changes

* chore(*): fix rowEditDone event args

* fix(*): do not clear summaries when row edit is not complete #10617

* chore(*): fix linting errors

* chore(grid): separate grid and cell event interfaces, events reorganization

* chore(*): add proper description for interfaces

* chore(*): fix the description of the deprecated properties

* feat(*): expose new event arguments for grid rowAdd and rowDelete  #10617

* chore(*): add key and deprecate primaryKey event args

* chore(*): address the issues in the test due to changes in the event arguments

* chore(*): fix some linting errors

* chore(*): fix failing test

* chore(*): fix failing tests

* chore(*): change the version for the deprecation of rowId and rowData props

* chore(*): describe in the changelog the deprecated props rowID and  rowData

* chore(*): remove some leftover comment

* chore(*): apply some of the review comments

* Update CHANGELOG.md

Co-authored-by: Konstantin Dinev <[email protected]>

* chore(*): address some more comments

* feat(*): reintroduce primaryKey prop and introduce rowKey instead key #10617

* test(Grid): fix the test with reintroduced props primaryKey and rowKey #10617

* feat(*): remove the deprecation of rowData prop and remove data prop #10617

* chore(*): drop the new interfaces entirely

* test(Grid): address the latest changes in the gridEdit events #10617

* chore(*): remove cellID and and column from IRowDataCancelableEventArgs

* chore(*): deprecate data and introduce rowData in IBaseRowDataEventArgs

* chore(*): deprecate key, introduce rowKey

* chore(*): remove unnecessary added key prop in IRowDataEventArgs

* chore(*): unify rowKey prop for the rest of the interfaces

* chore(*): update the changelog

* chore(*): remove unused interface

* chore(*): update changelog for pivot

* chore(*): update changelog for pivot

* Apply suggestions

minor formatting and redundant comments

* chore(*): add wrongfully removed comments

* chore(*): should not use deprecated props internally

* chore(*): fix indentation

* feat(*): IRowDataCancelableEventArgs to extend IGridEditEventArgs #10617

* chore(*): update the deprecation version and the changelog description

* chore(*): changelog enhcaements

* chore(*): fix typo in interace name

* Update projects/igniteui-angular/src/lib/grids/summaries/grid-summary.service.ts

* Update projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid.component.ts

* Update projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-crud.spec.ts

* Update projects/igniteui-angular/src/lib/grids/tree-grid/tree-grid-crud.spec.ts

* Update projects/igniteui-angular/src/lib/action-strip/grid-actions/grid-editing-actions.component.spec.ts

* chore(*): fix incorrect work usage

* chore(grid): cleanup redundant comments

* chore(grid): row data cancelable spelling; consistent w/ base interface

* docs(grid): update events changelog

* docs(changelog): grid event arg deprecations separate section

---------

Co-authored-by: Hristo Anastasov <[email protected]>
Co-authored-by: Stamen Stoychev <[email protected]>
Co-authored-by: Konstantin Dinev <[email protected]>
Co-authored-by: Damyan Petev <[email protected]>

Author: 5 people

CHANGELOG.md

@@ -9,7 +9,7 @@ All notable changes for each version of this project will be documented in this
 - `IgxTree`
     - Added new property `toggleNodeOnClick` that determines whether clicking over a node will change its expanded state or not. Set to `false` by default.
 - `IgxPivotGrid`
-    - `IPivotDimension` interface now exposes a property called `displayName` similar to the one in the `IPivotValue` interface. This property is optional and will be displayed inside the chips for rows and columns in the `IgxPivotGrid`. If the `displayName` proeprty is not set, `memberName` will be used as a fallback.
+    - `IPivotDimension` interface now exposes a property called `displayName` similar to the one in the `IPivotValue` interface. This property is optional and will be displayed inside the chips for rows and columns in the `IgxPivotGrid`. If the `displayName` property is not set, `memberName` will be used as a fallback.
 - New directive -  `igxIconButton` directive that provides a way to use an icon as a fully functional button has been added. The new `igxIconButton` comes in three types - flat, outlined and contained (default). All `igxButton`'s with type `icon` will be automatically migrated to the new `igxIconButton`'s with `ng update`.
 - `IgxButton`
     - **Behavioral Change** `buttonSelected` event is now emitted not only when a button gets selected, but also when it gets deselected. However, the event is no longer being emitted on initialization. If this event was used in a scenario where it is assumed that the button gets selected, it's a good idea the logic to be branched now based on `eventArgs.selected` condition.
@@ -20,7 +20,16 @@ All notable changes for each version of this project will be documented in this
     - The `igxButtonColor` and `igxButtonBackground` input properties have been deprecated and will be removed in a future version.
 - `IgxForOf`
     - Unified logic for vertical and horizontal virtualization such as - caching, updating, max browser size exceeding.
-    - Addded new method - `addScroll` that can shift the scroll thumb by the specified amount in pixels (negative number to scroll to previous, positive to scroll next). Similar to `addScrollTop` but works for both vertical and horizontal virtualization.
+    - Added new method - `addScroll` that can shift the scroll thumb by the specified amount in pixels (negative number to scroll to previous, positive to scroll next). Similar to `addScrollTop` but works for both vertical and horizontal virtualization.
+
+
+- `IgxGrid`, `IgxTreeGrid`, `IgxHierarchicalGrid`
+    - **Breaking Changes**
+        - `rowAdd` and `rowDelete` events now emit event argument of type `IRowDataCancelableEventArgs` instead of `IGridEditEventArgs`. The two interfaces are still compatible, however redundant for these events properties `cellID`, `newValue`, `oldValue`, `isAddRow` are deprecated in `IRowDataCancelableEventArgs` and will be removed in a future version. Switching to the correct new interfaces should reveal any deprecated use that can be safely removed.
+    - **Deprecations**
+        - `rowID` property has been deprecated in the following interfaces: `IGridEditDoneEventArgs`, `IPathSegment`, `IRowToggleEventArgs`, `IPinRowEventArgs`, `IgxAddRowParent` and will be removed in a future version. Use `rowKey` instead.
+        - `primaryKey` property has been deprecated in the following interfaces: `IRowDataEventArgs`, `IGridEditDoneEventArgs`. Use `rowKey` instead.
+        - `data` property has been deprecated in the following interfaces: `IRowDataEventArgs`. Use `rowData` instead.
 
 ## 17.0.0
 ### General
@@ -33,14 +42,14 @@ All notable changes for each version of this project will be documented in this
     - `igniteui-angular-i18n` is now tree-shakeable
     - `igniteui-angular/animations` is now tree-shakeable
     - `igniteui-angular` components have improved tree-shaking
-    - **Breaking Change** `getCurrentResourceStrings` has been removed. Use the specific component string imports instead. 
+    - **Breaking Change** `getCurrentResourceStrings` has been removed. Use the specific component string imports instead.
         - E.g. EN strings come from `igniteui-angular`: `import { GridResourceStringsEN } from 'igniteui-angular';`
         - E.g. DE or other language strings come from `igniteui-angular-i18n`: `import { GridResourceStringsDE } from 'igniteui-angular-i18n';`
 - DisplayDensity token and inputs are deprecated in favor of `--ig-size` theming
 - We're working on reducing the library size
     - `IgxRadioComponent` size has been reduced in half
     - `IgxSwitchComponent` size has been reduced in half
-- `IgxRadioComponent` 
+- `IgxRadioComponent`
     - **Breaking Change** `IChangeRadioEventArgs` is now `IChangeCheckboxEventArgs`. `ng update` to `17.0.0` will automatically migrate this for you.
     - **Breaking Change** `RadioLabelPosition` is now `LabelPosition`. `ng update` to `17.0.0` will automatically migrate this for you.
 - `IgxSwitchComponent`
@@ -49,7 +58,7 @@ All notable changes for each version of this project will be documented in this
 - `IgxCombo`
     - **Breaking Change** `IComboSelectionChangingEventArgs` properties `newSelection` and `oldSelection` have been renamed to `newValue` and `oldValue` respectively to better reflect their function. Just like Combo's `value`, those will emit either the specified property values or full data items depending on whether `valueKey` is set or not. Automatic migrations are available and will be applied on `ng update`.
     - `IComboSelectionChangingEventArgs` exposes two new properties `newSelection` and `oldSelection` in place of the old ones that are no longer affected by `valueKey` and consistently emit items from Combo's `data`.
-      
+
       Note: In remote data scenarios with `valueKey` set, selected items that are not currently part of the loaded data chunk will be emitted a partial item data object with the `valueKey` property.
     - **Breaking Change** - `IComboSelectionChangingEventArgs` properties `added` and `removed` now always contain data items, regardless of `valueKey` being set. This aligns them with the updated `newSelection` and `oldSelection` properties, including the same limitation for remote data as described above.
 - `IgxSimpleCombo`
@@ -61,11 +70,11 @@ All notable changes for each version of this project will be documented in this
 - `IgxCombo`,`IgxSimpleCombo`
     - **Breaking Change** The `displayValue` property now returns the display text as expected (instead of display values in array).
 
+=======
 ## 16.1.5
 ### General
 - `IgxButtonGroup`:
     - Reverted cancellable on `selected` and `deselected` events (added in 15.1.24) as it was breaking firing order and related handling.
-
 ## 16.1.4
 ### New Features
 - `Themes`:
@@ -107,7 +116,7 @@ All notable changes for each version of this project will be documented in this
      ```
 - `IgxBadge`:
     - Material icons extended along with any other custom icon set can now be used inside the badge component.
-    - Code example: 
+    - Code example:
 
      ```typescript
      import { IgxBadgeComponent, IgxIconService } from 'igniteui-angular';
@@ -150,7 +159,7 @@ All notable changes for each version of this project will be documented in this
     ```
 
     ```css
-    /* 
+    /*
     Add --ig-size to a component or global file.
     Available values are:
     compact: --ig-size-small

projects/igniteui-angular/src/lib/action-strip/grid-actions/grid-editing-actions.component.spec.ts

@@ -15,7 +15,7 @@ import { IgxTreeGridEditActionsComponent } from '../../test-utils/tree-grid-comp
 import { IgxGridEditingActionsComponent } from './grid-editing-actions.component';
 import { IgxGridPinningActionsComponent } from './grid-pinning-actions.component';
 import { IgxActionStripComponent } from '../action-strip.component';
-import { IgxColumnComponent } from '../../grids/public_api';
+import { IRowDataCancelableEventArgs, IgxColumnComponent } from '../../grids/public_api';
 
 describe('igxGridEditingActions #grid ', () => {
     let fixture;
@@ -203,6 +203,7 @@ describe('igxGridEditingActions #grid ', () => {
             expect(grid.rowPinning.emit).toHaveBeenCalledTimes(1);
             expect(grid.rowPinning.emit).toHaveBeenCalledWith({
                 rowID : row.key,
+                rowKey: row.key,
                 insertAtIndex: 0,
                 isPinned: true,
                 row,
@@ -220,6 +221,7 @@ describe('igxGridEditingActions #grid ', () => {
             expect(grid.rowPinning.emit).toHaveBeenCalledTimes(2);
             expect(grid.rowPinning.emit).toHaveBeenCalledWith({
                 rowID : row5.key,
+                rowKey: row5.key,
                 insertAtIndex: 1,
                 isPinned: true,
                 row: row5,
@@ -355,18 +357,22 @@ describe('igxGridEditingActions #grid ', () => {
             expect(editActions[3].componentInstance.iconName).toBe('delete');
             const deleteChildBtn = editActions[3].componentInstance;
 
-            const rowDeleteArgs = {
+            const rowDeleteArgs: IRowDataCancelableEventArgs = {
                 rowID: row.key,
                 primaryKey: row.key,
+                rowKey: row.key,
                 cancel: false,
                 rowData: treeGrid.getRowData(row.key),
+                data: treeGrid.getRowData(row.key),
                 oldValue: null,
-                owner: treeGrid
+                owner: treeGrid,
             };
 
             const rowDeletedArgs = {
                 data: treeGrid.getRowData(row.key),
+                rowData: treeGrid.getRowData(row.key),
                 primaryKey: row.key,
+                rowKey: row.key,
                 owner: treeGrid
             };
 

projects/igniteui-angular/src/lib/grids/api.service.ts

@@ -141,9 +141,10 @@ export class GridBaseAPIService<T extends GridType> implements GridServiceType {
         if (!cell) {
             return;
         }
-        const args = cell.createEditEventArgs(true);
-
-        this.grid.summaryService.clearSummaryCache(args);
+        const args = cell.createCellEditEventArgs(true);
+        if (!this.grid.crudService.row) { // should not recalculate summaries when there is row in edit mode
+            this.grid.summaryService.clearSummaryCache(args);
+        }
         const data = this.getRowData(cell.id.rowID);
         const newRowData = reverseMapper(cell.column.field, args.newValue);
         this.updateData(this.grid, cell.id.rowID, data, cell.rowData, newRowData);
@@ -187,7 +188,7 @@ export class GridBaseAPIService<T extends GridType> implements GridServiceType {
         const hasSummarized = grid.hasSummarizedColumns;
         this.crudService.updateRowEditData(row, value);
 
-        const args = row.createEditEventArgs(true, event);
+        const args = row.createRowEditEventArgs(true, event);
 
         // If no valid row is found
         if (index === -1) {
@@ -338,7 +339,7 @@ export class GridBaseAPIService<T extends GridType> implements GridServiceType {
     public deleteRowById(rowId: any): any {
         let index: number;
         const grid = this.grid;
-        const data = this.get_all_data();
+        const data = this.get_all_data(grid.transactions.enabled);
         if (grid.primaryKey) {
             // eslint-disable-next-line @typescript-eslint/no-shadow
             index = data.map((record) => record[grid.primaryKey]).indexOf(rowId);
@@ -360,7 +361,7 @@ export class GridBaseAPIService<T extends GridType> implements GridServiceType {
 
         const record = data[index];
         const key = record ? record[grid.primaryKey] : undefined;
-        grid.rowDeletedNotifier.next({ data: record, owner: grid, primaryKey: key });
+        grid.rowDeletedNotifier.next({ data: record, rowData: record, owner: grid, primaryKey: key, rowKey: key });
 
         this.deleteRowFromData(rowId, index);
 
@@ -424,6 +425,7 @@ export class GridBaseAPIService<T extends GridType> implements GridServiceType {
         }
 
         const args: IRowToggleEventArgs = {
+            rowKey: rowID,
             rowID,
             expanded,
             event,
@@ -585,6 +587,7 @@ export class GridBaseAPIService<T extends GridType> implements GridServiceType {
     public get_pin_row_event_args(rowID: any, index?: number, row?: RowType, pinned?: boolean) {
         const eventArgs: IPinRowEventArgs = {
             isPinned: pinned ? true : false,
+            rowKey: rowID,
             rowID,
             row,
             cancel: false