Merge branch 'master' into mpopov/filtering-dropdown

Author: simeonoff

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

@@ -24,7 +24,7 @@ import {
     TransactionEventOrigin,
     StateUpdateEvent
 } from '../../services/transaction/transaction';
-import { IgxHierarchicalTransactionService } from '../../services/public_api';
+import { HierarchicalTransactionService } from '../../services/public_api';
 import { IgxFilteringService } from '../filtering/grid-filtering.service';
 import { IgxGridSummaryService } from '../summaries/grid-summary.service';
 import { IgxGridSelectionService, IgxGridCRUDService } from '../selection/selection.service';
@@ -78,7 +78,7 @@ export class IgxTreeGridComponent extends IgxGridBaseDirective implements GridTy
     private _id = `igx-tree-grid-${NEXT_ID++}`;
     private _data;
     private _rowLoadingIndicatorTemplate: TemplateRef<any>;
-    protected _transactions: IgxHierarchicalTransactionService<HierarchicalTransaction, HierarchicalState>;
+    protected _transactions: HierarchicalTransactionService<HierarchicalTransaction, HierarchicalState>;
 
     /**
      * An @Input property that sets the value of the `id` attribute. If not provided it will be automatically generated.

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

@@ -17,3 +17,4 @@ export * from './transaction/igx-transaction';
 export * from './transaction/base-transaction';
 export * from './transaction/transaction';
 export * from './transaction/igx-hierarchical-transaction';
+export * from './transaction/hierarchical-transaction';

projects/igniteui-angular/src/lib/services/transaction/README.md

@@ -47,3 +47,9 @@ and then inject it in the component's constructor:
    |clear                  | Clears all transactions                                       | id?                       |
    |startPending           | Starts pending transactions. All transactions passed after call to startPending will not be added to transaction log | - |
    |endPending             | Clears all pending transactions and aggregated pending state. If commit is set to true commits pending states as single transaction | commit |
+
+### HierarchicalTransactionService
+
+   | Name                  | Description                                                   | Parameters                |
+   |-----------------------|---------------------------------------------------------------|---------------------------|
+   |commit                 | Applies all transactions over the provided data               | data, primaryKey, childDataKey, id?                 |

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

@@ -0,0 +1,20 @@
+import { TransactionService, HierarchicalState, HierarchicalTransaction } from './transaction';
+
+export interface HierarchicalTransactionService<T extends HierarchicalTransaction, S extends HierarchicalState>
+    extends TransactionService<T, S> {
+    /**
+     * Applies all transactions over the provided data
+     * @param data Data source to update
+     * @param id Optional record id to commit transactions for
+     */
+    commit(data: any[], id?: any): void;
+    /**
+     * Applies all transactions over the provided data
+     * @param data Data source to update
+     * @param primaryKey Primary key of the hierarchical data
+     * @param childDataKey Key of child data collection
+     * @param id Optional record id to commit transactions for
+     */
+    // tslint:disable-next-line: unified-signatures
+    commit(data: any[], primaryKey: any, childDataKey: any, id?: any): void;
+}

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

@@ -3,11 +3,12 @@ import { Injectable } from '@angular/core';
 import { IgxTransactionService } from './igx-transaction';
 import { DataUtil } from '../../data-operations/data-util';
 import { cloneValue } from '../../core/utils';
+import { HierarchicalTransactionService } from './hierarchical-transaction';
 
 /** @experimental @hidden */
 @Injectable()
 export class IgxHierarchicalTransactionService<T extends HierarchicalTransaction, S extends HierarchicalState>
-    extends IgxTransactionService<T, S> {
+    extends IgxTransactionService<T, S> implements HierarchicalTransactionService<T, S> {
 
     public getAggregatedChanges(mergeChanges: boolean): T[] {
         const result: T[] = [];
@@ -51,23 +52,16 @@ export class IgxHierarchicalTransactionService<T extends HierarchicalTransaction
         }
     }
 
-    /**
-     * Applies all transactions over the provided data
-     * @param data Data source to update
-     * @param primaryKey Primary key of the hierarchical data
-     * @param childDataKey Key of child data collection
-     * @param id Optional record id to commit transactions for
-     */
-    public commit(data: any[], primaryKey?: any, childDataKey?: any, id?: any): void {
+    public commit(data: any[], primaryKeyOrId?: any, childDataKey?: any, id?: any): void {
         if (childDataKey !== undefined) {
             let transactions = this.getAggregatedChanges(true);
             if (id !== undefined) {
                 transactions = transactions.filter(t => t.id === id);
             }
-            DataUtil.mergeHierarchicalTransactions(data, transactions, childDataKey, primaryKey, true);
+            DataUtil.mergeHierarchicalTransactions(data, transactions, childDataKey, primaryKeyOrId, true);
             this.clear(id);
         } else {
-            super.commit(data, id);
+            super.commit(data, primaryKeyOrId);
         }
     }