chore(*): Addressing pr comments

Author: 3phase

CHANGELOG.md

@@ -5,9 +5,9 @@ All notable changes for each version of this project will be documented in this
 ## 10.0.0
 
 ### General
-- `IgxTransaction` - The `onStateUpdate` now emits with information of its origin. The emitted value is of type `IStateUpdateEvent`, which has two properies:
-    - `origin` - a mandatory property. It can vary within the values of the `TransactionEventOrigin` interface; 
-    - `actions` - an optional property that contains information about the transactions, that caused the emission of the event. It is used by `undo` and `redo`.
+- `IgxTransaction` - The `onStateUpdate` now emits with information of its origin. The emitted value is of type `StateUpdateEvent`, which has two properies:
+    - `origin` - it can vary within the values of the `TransactionEventOrigin` interface; 
+    - `actions` - contains information about the transactions, that caused the emission of the event.
 
 
 ## 9.1.1

projects/igniteui-angular/src/lib/grids/grid-base.directive.ts

@@ -47,7 +47,7 @@ import {
     PositionSettings,
     ConnectedPositioningStrategy,
     ContainerPositionStrategy,
-    IStateUpdateEvent,
+    StateUpdateEvent,
     TransactionEventOrigin
 } from '../services/public_api';
 import { GridBaseAPIService } from './api.service';
@@ -2858,7 +2858,7 @@ export class IgxGridBaseDirective extends DisplayDensityBase implements
             this.summaryService.clearSummaryCache(args);
         });
 
-        this.transactions.onStateUpdate.pipe(destructor).subscribe((event?: IStateUpdateEvent) => {
+        this.transactions.onStateUpdate.pipe(destructor).subscribe((event?: StateUpdateEvent) => {
             let actions = [];
             if (event.origin === TransactionEventOrigin.REDO) {
                 actions = event.actions ? event.actions.filter(x => x.transaction.type === TransactionType.DELETE) : [];

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

@@ -22,7 +22,7 @@ import {
     HierarchicalState,
     TransactionType,
     TransactionEventOrigin,
-    IStateUpdateEvent
+    StateUpdateEvent
 } from '../../services/transaction/transaction';
 import { IgxHierarchicalTransactionService } from '../../services/public_api';
 import { IgxFilteringService } from '../filtering/grid-filtering.service';
@@ -353,7 +353,7 @@ export class IgxTreeGridComponent extends IgxGridBaseDirective implements GridTy
             this.loadChildrenOnRowExpansion(args);
         });
 
-        this.transactions.onStateUpdate.pipe(takeUntil<any>(this.destroy$)).subscribe((event?: IStateUpdateEvent) => {
+        this.transactions.onStateUpdate.pipe(takeUntil<any>(this.destroy$)).subscribe((event?: StateUpdateEvent) => {
             let actions = [];
             if (event.origin === TransactionEventOrigin.REDO) {
                 actions = event.actions ? event.actions.filter(x => x.transaction.type === TransactionType.DELETE) : [];

projects/igniteui-angular/src/lib/services/transaction/base-transaction.ts

@@ -1,4 +1,4 @@
-import { TransactionService, Transaction, State, IStateUpdateEvent } from './transaction';
+import { TransactionService, Transaction, State, StateUpdateEvent } from './transaction';
 import { EventEmitter, Injectable } from '@angular/core';
 import { isObject, mergeObjects, cloneValue } from '../../core/utils';
 
@@ -32,7 +32,7 @@ export class IgxBaseTransactionService<T extends Transaction, S extends State> i
     /**
      * @inheritdoc
      */
-    public onStateUpdate = new EventEmitter<IStateUpdateEvent>();
+    public onStateUpdate = new EventEmitter<StateUpdateEvent>();
 
     /**
      * @inheritdoc

projects/igniteui-angular/src/lib/services/transaction/igx-transaction.ts

@@ -1,4 +1,4 @@
-import { Transaction, State, TransactionType, IStateUpdateEvent, TransactionEventOrigin } from './transaction';
+import { Transaction, State, TransactionType, StateUpdateEvent, TransactionEventOrigin } from './transaction';
 import { IgxBaseTransactionService } from './base-transaction';
 import { EventEmitter, Injectable } from '@angular/core';
 import { isObject, mergeObjects, cloneValue } from '../../core/utils';
@@ -27,7 +27,7 @@ export class IgxTransactionService<T extends Transaction, S extends State> exten
     /**
      * @inheritdoc
      */
-    public onStateUpdate = new EventEmitter<IStateUpdateEvent>();
+    public onStateUpdate = new EventEmitter<StateUpdateEvent>();
 
     /**
      * @inheritdoc
@@ -45,9 +45,10 @@ export class IgxTransactionService<T extends Transaction, S extends State> exten
         transactions.push(transaction);
 
         if (!this._isPending) {
-            this._undoStack.push([{ transaction, recordRef }]);
+            const actions = [{ transaction, recordRef }];
+            this._undoStack.push(actions);
             this._redoStack = [];
-            this.onStateUpdate.emit({ origin: TransactionEventOrigin.ADD });
+            this.onStateUpdate.emit({ origin: TransactionEventOrigin.ADD, actions: actions });
         }
     }
 
@@ -127,7 +128,7 @@ export class IgxTransactionService<T extends Transaction, S extends State> exten
             this._undoStack.push(actions);
             this._redoStack = [];
 
-            this.onStateUpdate.emit({ origin: TransactionEventOrigin.END});
+            this.onStateUpdate.emit({ origin: TransactionEventOrigin.END, actions});
         }
         super.endPending(commit);
     }
@@ -167,7 +168,7 @@ export class IgxTransactionService<T extends Transaction, S extends State> exten
             this._undoStack = [];
         }
         this._redoStack = [];
-        this.onStateUpdate.emit({ origin: TransactionEventOrigin.CLEAR });
+        this.onStateUpdate.emit({ origin: TransactionEventOrigin.CLEAR, actions: []});
     }
 
     /**
@@ -205,7 +206,7 @@ export class IgxTransactionService<T extends Transaction, S extends State> exten
             }
 
             this._undoStack.push(actions);
-            this.onStateUpdate.emit({ origin: TransactionEventOrigin.REDO, actions: actions });
+            this.onStateUpdate.emit({ origin: TransactionEventOrigin.REDO, actions });
         }
     }
 

projects/igniteui-angular/src/lib/services/transaction/transaction.ts

@@ -35,9 +35,14 @@ export interface State {
     type: TransactionType;
 }
 
-export interface IStateUpdateEvent {
+export interface Action {
+    transaction: Transaction;
+    recordRef: any;
+}
+
+export interface StateUpdateEvent {
     origin: TransactionEventOrigin;
-    actions?: any;
+    actions: Array<Action>;
 }
 
 /**
@@ -57,7 +62,7 @@ export interface TransactionService<T extends Transaction, S extends State> {
     /**
      * Event fired when transaction state has changed - add transaction, commit all transactions, undo and redo
      */
-    onStateUpdate?: EventEmitter<IStateUpdateEvent>;
+    onStateUpdate?: EventEmitter<StateUpdateEvent>;
 
     /**
      * @returns if there are any transactions in the Undo stack