refactor(grid): mark lastSearchInfo readonly/getter-only (#14390)

Author: damyanpetev

projects/igniteui-angular/src/lib/grids/common/grid.interface.ts

@@ -933,7 +933,7 @@ export interface GridType extends IGridDataBindable {
     /** Represents the last search in the grid
      * It contains the search text (the user has entered), the match and some settings for the search
      */
-    lastSearchInfo: ISearchInfo;
+    readonly lastSearchInfo: ISearchInfo;
     /** @hidden @internal */
     page: number;
     /** @hidden @internal */

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

@@ -2864,15 +2864,9 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
     /**
      * Represents the last search information.
      */
-    public lastSearchInfo: ISearchInfo = {
-        searchText: '',
-        caseSensitive: false,
-        exactMatch: false,
-        activeMatchIndex: 0,
-        matchInfoCache: [],
-        matchCount: 0,
-        content: ''
-    };
+    public get lastSearchInfo(): ISearchInfo {
+        return this._lastSearchInfo;
+    }
 
     /**
      * @hidden @internal
@@ -3040,6 +3034,15 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
     protected _filterStrategy: IFilteringStrategy = new FilteringStrategy();
     protected _autoGeneratedCols = [];
     protected _dataView = [];
+    protected _lastSearchInfo: ISearchInfo = {
+        searchText: '',
+        caseSensitive: false,
+        exactMatch: false,
+        activeMatchIndex: 0,
+        matchInfoCache: [],
+        matchCount: 0,
+        content: ''
+    };
 
     /** @hidden @internal */
     public get paginator() {
@@ -5089,25 +5092,25 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
      * @param updateActiveInfo
      */
     public refreshSearch(updateActiveInfo?: boolean, endEdit = true): number {
-        if (this.lastSearchInfo.searchText) {
+        if (this._lastSearchInfo.searchText) {
             this.rebuildMatchCache();
 
             if (updateActiveInfo) {
                 const activeInfo = this.textHighlightService.highlightGroupsMap.get(this.id);
-                this.lastSearchInfo.matchInfoCache.forEach((match, i) => {
+                this._lastSearchInfo.matchInfoCache.forEach((match, i) => {
                     if (match.column === activeInfo.column &&
                         match.row === activeInfo.row &&
                         match.index === activeInfo.index &&
                         compareMaps(match.metadata, activeInfo.metadata)) {
-                        this.lastSearchInfo.activeMatchIndex = i;
+                        this._lastSearchInfo.activeMatchIndex = i;
                     }
                 });
             }
 
-            return this.find(this.lastSearchInfo.searchText,
+            return this.find(this._lastSearchInfo.searchText,
                 0,
-                this.lastSearchInfo.caseSensitive,
-                this.lastSearchInfo.exactMatch,
+                this._lastSearchInfo.caseSensitive,
+                this._lastSearchInfo.exactMatch,
                 false,
                 endEdit);
         } else {
@@ -5124,7 +5127,7 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
      * ```
      */
     public clearSearch() {
-        this.lastSearchInfo = {
+        this._lastSearchInfo = {
             searchText: '',
             caseSensitive: false,
             exactMatch: false,
@@ -7509,10 +7512,10 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
         const exactMatchResolved = exactMatch ? true : false;
         let rebuildCache = false;
 
-        if (this.lastSearchInfo.searchText !== text ||
-            this.lastSearchInfo.caseSensitive !== caseSensitiveResolved ||
-            this.lastSearchInfo.exactMatch !== exactMatchResolved) {
-            this.lastSearchInfo = {
+        if (this._lastSearchInfo.searchText !== text ||
+            this._lastSearchInfo.caseSensitive !== caseSensitiveResolved ||
+            this._lastSearchInfo.exactMatch !== exactMatchResolved) {
+            this._lastSearchInfo = {
                 searchText: text,
                 activeMatchIndex: 0,
                 caseSensitive: caseSensitiveResolved,
@@ -7524,7 +7527,7 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
 
             rebuildCache = true;
         } else {
-            this.lastSearchInfo.activeMatchIndex += increment;
+            this._lastSearchInfo.activeMatchIndex += increment;
         }
 
         if (rebuildCache) {
@@ -7539,15 +7542,15 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
             this.rebuildMatchCache();
         }
 
-        if (this.lastSearchInfo.activeMatchIndex >= this.lastSearchInfo.matchCount) {
-            this.lastSearchInfo.activeMatchIndex = 0;
-        } else if (this.lastSearchInfo.activeMatchIndex < 0) {
-            this.lastSearchInfo.activeMatchIndex = this.lastSearchInfo.matchCount - 1;
+        if (this._lastSearchInfo.activeMatchIndex >= this._lastSearchInfo.matchCount) {
+            this._lastSearchInfo.activeMatchIndex = 0;
+        } else if (this._lastSearchInfo.activeMatchIndex < 0) {
+            this._lastSearchInfo.activeMatchIndex = this._lastSearchInfo.matchCount - 1;
         }
 
-        if (this.lastSearchInfo.matchCount > 0) {
-            const matchInfo = this.lastSearchInfo.matchInfoCache[this.lastSearchInfo.activeMatchIndex];
-            this.lastSearchInfo = { ...this.lastSearchInfo };
+        if (this._lastSearchInfo.matchCount > 0) {
+            const matchInfo = this._lastSearchInfo.matchInfoCache[this._lastSearchInfo.activeMatchIndex];
+            this._lastSearchInfo = { ...this._lastSearchInfo };
 
             if (scroll !== false) {
                 this.scrollTo(matchInfo.row, matchInfo.column);
@@ -7564,15 +7567,15 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
             this.textHighlightService.clearActiveHighlight(this.id);
         }
 
-        return this.lastSearchInfo.matchCount;
+        return this._lastSearchInfo.matchCount;
     }
 
     private rebuildMatchCache() {
-        this.lastSearchInfo.matchInfoCache = [];
+        this._lastSearchInfo.matchInfoCache = [];
 
-        const caseSensitive = this.lastSearchInfo.caseSensitive;
-        const exactMatch = this.lastSearchInfo.exactMatch;
-        const searchText = caseSensitive ? this.lastSearchInfo.searchText : this.lastSearchInfo.searchText.toLowerCase();
+        const caseSensitive = this._lastSearchInfo.caseSensitive;
+        const exactMatch = this._lastSearchInfo.exactMatch;
+        const searchText = caseSensitive ? this._lastSearchInfo.searchText : this._lastSearchInfo.searchText.toLowerCase();
         const data = this.filteredSortedData;
         const columnItems = this.visibleColumns.filter((c) => !c.columnGroup).sort((c1, c2) => c1.visibleIndex - c2.visibleIndex);
 
@@ -7596,7 +7599,7 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
                                 metadata: new Map<string, boolean>([['pinned', this.isRecordPinnedByIndex(rowIndex)]])
                             };
 
-                            this.lastSearchInfo.matchInfoCache.push(mic);
+                            this._lastSearchInfo.matchInfoCache.push(mic);
                         }
                     } else {
                         let occurrenceIndex = 0;
@@ -7610,7 +7613,7 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
                                 metadata: new Map<string, boolean>([['pinned', this.isRecordPinnedByIndex(rowIndex)]])
                             };
 
-                            this.lastSearchInfo.matchInfoCache.push(mic);
+                            this._lastSearchInfo.matchInfoCache.push(mic);
 
                             searchValue = searchValue.substring(searchIndex + searchText.length);
                             searchIndex = searchValue.indexOf(searchText);
@@ -7620,7 +7623,7 @@ export abstract class IgxGridBaseDirective extends DisplayDensityBase implements
             });
         });
 
-        this.lastSearchInfo.matchCount = this.lastSearchInfo.matchInfoCache.length;
+        this._lastSearchInfo.matchCount = this._lastSearchInfo.matchInfoCache.length;
     }
 
     // TODO: About to Move to CRUD