refactor(grids): extract refresh-options util and cast DataController getters

Author: bit-byte0

packages/devextreme/js/__internal/grids/grid_core/data_controller/data_controller.ts

@@ -66,6 +66,7 @@ import type {
   UserState,
 } from './types';
 import { resolvePaginate, syncPaging } from './utils/paging';
+import { getRefreshOptions } from './utils/refresh';
 import { generateRowValues } from './utils/row_values';
 
 export class DataController extends DataHelperMixin(modules.Controller) {
@@ -1658,7 +1659,7 @@ export class DataController extends DataHelperMixin(modules.Controller) {
   }
 
   public isCustomLoading(): boolean {
-    return !!(this._isCustomLoading || this._dataSource?.isCustomLoading());
+    return this._isCustomLoading || !!this._dataSource?.isCustomLoading();
   }
 
   public beginCustomLoading(messageText?: string): void {
@@ -1677,12 +1678,7 @@ export class DataController extends DataHelperMixin(modules.Controller) {
    * @extended: virtual_scrolling, selection
    */
   public refresh(options?: boolean | RefreshOptions): DeferredObj<unknown> {
-    let refreshOptions: RefreshOptions = { reload: true, lookup: true };
-    if (options === true) {
-      refreshOptions = { reload: true, changesOnly: true };
-    } else if (options) {
-      refreshOptions = options;
-    }
+    const refreshOptions = getRefreshOptions(options);
 
     const dataSource = this.getDataSource();
     const { changesOnly } = refreshOptions;
@@ -1736,7 +1732,7 @@ export class DataController extends DataHelperMixin(modules.Controller) {
   /**
    * @extended editing
    */
-  public repaintRows(rowIndexes: number | (number | undefined)[], changesOnly?: boolean): void {
+  public repaintRows(rowIndexes: number | (number | undefined)[] | undefined, changesOnly?: boolean): void {
     const rowIndices = Array.isArray(rowIndexes) ? rowIndexes : [rowIndexes];
 
     if (rowIndices.length > 1 || isDefined(rowIndices[0])) {
@@ -1763,8 +1759,8 @@ export class DataController extends DataHelperMixin(modules.Controller) {
     };
   }
 
-  public getCachedStoreData(): unknown {
-    return this._dataSource?.getCachedStoreData();
+  public getCachedStoreData(): RawItemData[] | undefined {
+    return this._dataSource?.getCachedStoreData() as RawItemData[] | undefined;
   }
 
   /**
@@ -1777,42 +1773,42 @@ export class DataController extends DataHelperMixin(modules.Controller) {
   }
 
   public load(): DeferredObj<unknown> {
-    return this._dataSource?.load();
+    return this._dataSource?.load() as DeferredObj<unknown>;
   }
 
   /**
    * @extended: editing, virtual_scrolling
    */
 
   public reload(reload?: boolean, changesOnly?: boolean): DeferredObj<unknown> {
-    return this._dataSource?.reload(reload, changesOnly);
+    return this._dataSource?.reload(reload, changesOnly) as DeferredObj<unknown>;
   }
 
   public push(...args: unknown[]): unknown {
     return this._dataSource?.push(...args);
   }
 
   private itemsCount(): number {
-    return this._dataSource ? this._dataSource.itemsCount() : 0;
+    return (this._dataSource ? this._dataSource.itemsCount() : 0) as number;
   }
 
   public totalItemsCount(): number {
-    return this._dataSource ? this._dataSource.totalItemsCount() : 0;
+    return (this._dataSource ? this._dataSource.totalItemsCount() : 0) as number;
   }
 
   public hasKnownLastPage(): boolean {
-    return this._dataSource ? this._dataSource.hasKnownLastPage() : true;
+    return (this._dataSource ? this._dataSource.hasKnownLastPage() : true) as boolean;
   }
 
   /**
    * @extended: state_storing
    */
   public isLoaded(): boolean {
-    return this._dataSource ? this._dataSource.isLoaded() : true;
+    return (this._dataSource ? this._dataSource.isLoaded() : true) as boolean;
   }
 
   public totalCount(): number {
-    return this._dataSource ? this._dataSource.totalCount() : 0;
+    return (this._dataSource ? this._dataSource.totalCount() : 0) as number;
   }
 
   public hasLoadOperation(): boolean {

packages/devextreme/js/__internal/grids/grid_core/data_controller/types.ts

@@ -22,7 +22,7 @@ export interface RefreshOptions {
 }
 
 export interface UserState {
-  searchText: unknown;
+  searchText: string | undefined;
   pageIndex: number;
   pageSize: number;
   expandedRowKeys?: unknown;

packages/devextreme/js/__internal/grids/grid_core/data_controller/utils/__tests__/refresh.test.ts

@@ -0,0 +1,20 @@
+import { describe, expect, it } from '@jest/globals';
+
+import { getRefreshOptions } from '../refresh';
+
+describe('getRefreshOptions', () => {
+  it('should reload with changes only when options is true', () => {
+    expect(getRefreshOptions(true)).toEqual({ reload: true, changesOnly: true });
+  });
+
+  it('should reload with lookup when options is falsy', () => {
+    expect(getRefreshOptions()).toEqual({ reload: true, lookup: true });
+    expect(getRefreshOptions(false)).toEqual({ reload: true, lookup: true });
+  });
+
+  it('should return the passed options object as is', () => {
+    const options = { load: true, changesOnly: true };
+
+    expect(getRefreshOptions(options)).toBe(options);
+  });
+});

packages/devextreme/js/__internal/grids/grid_core/data_controller/utils/refresh.ts

@@ -0,0 +1,13 @@
+import type { RefreshOptions } from '../types';
+
+export function getRefreshOptions(options?: boolean | RefreshOptions): RefreshOptions {
+  if (options === true) {
+    return { reload: true, changesOnly: true };
+  }
+
+  if (!options) {
+    return { reload: true, lookup: true };
+  }
+
+  return options;
+}