use required argument "mode" instead of optional "deselect"

Author: dmirgaev

packages/devextreme/js/__internal/grids/grid_core/ai_assistant/commands/__tests__/selection.test.ts

@@ -271,49 +271,62 @@ describe('selectByIndexesCommand', () => {
   afterEach(() => afterTest());
 
   describe('schema', () => {
-    it('accepts an array of positive integers with deselect', () => {
+    it('accepts an array of positive integers with mode deselect', () => {
       expect(selectByIndexesCommand.schema.safeParse({
-        indexes: [1, 2, 3], deselect: true,
+        indexes: [1, 2, 3], mode: 'deselect',
+      }).success).toBe(true);
+    });
+
+    it('accepts mode select', () => {
+      expect(selectByIndexesCommand.schema.safeParse({
+        indexes: [1], mode: 'select',
       }).success).toBe(true);
     });
 
     it('rejects when indexes is missing', () => {
-      expect(selectByIndexesCommand.schema.safeParse({}).success).toBe(false);
+      expect(selectByIndexesCommand.schema.safeParse({ mode: 'select' }).success).toBe(false);
     });
 
-    it('accepts when deselect is omitted (optional)', () => {
+    it('rejects when mode is missing', () => {
       expect(selectByIndexesCommand.schema.safeParse({
         indexes: [1],
-      }).success).toBe(true);
+      }).success).toBe(false);
+    });
+
+    it('rejects an invalid mode value', () => {
+      expect(selectByIndexesCommand.schema.safeParse({
+        indexes: [1], mode: 'toggle',
+      }).success).toBe(false);
     });
 
     it('rejects when indexes is an empty array', () => {
       expect(selectByIndexesCommand.schema.safeParse({
-        indexes: [],
+        indexes: [], mode: 'select',
       }).success).toBe(false);
     });
 
     it('rejects zero (indexes are 1-based)', () => {
       expect(selectByIndexesCommand.schema.safeParse({
-        indexes: [0],
+        indexes: [0], mode: 'select',
       }).success).toBe(false);
     });
 
     it('rejects negative indexes', () => {
       expect(selectByIndexesCommand.schema.safeParse({
-        indexes: [-1],
+        indexes: [-1], mode: 'select',
       }).success).toBe(false);
     });
 
     it('rejects non-integer indexes', () => {
       expect(selectByIndexesCommand.schema.safeParse({
-        indexes: [1.5],
+        indexes: [1.5], mode: 'select',
       }).success).toBe(false);
     });
 
     it('rejects unknown properties', () => {
       expect(selectByIndexesCommand.schema.safeParse({
         indexes: [1],
+        mode: 'select',
         extra: 1,
       }).success).toBe(false);
     });
@@ -326,7 +339,7 @@ describe('selectByIndexesCommand', () => {
       const callbacks = createCallbacks();
 
       const result = await selectByIndexesCommand.execute(instance, callbacks)({
-        indexes: [1],
+        indexes: [1], mode: 'select',
       });
 
       expect(result.status).toBe('failure');
@@ -340,7 +353,7 @@ describe('selectByIndexesCommand', () => {
 
       // Three rows in createGrid; 1-based index 100 has no row on the current page.
       const result = await selectByIndexesCommand.execute(instance, callbacks)({
-        indexes: [1, 100],
+        indexes: [1, 100], mode: 'select',
       });
 
       expect(result.status).toBe('failure');
@@ -360,7 +373,7 @@ describe('selectByIndexesCommand', () => {
       const callbacks = createCallbacks();
 
       const result = await selectByIndexesCommand.execute(instance, callbacks)({
-        indexes: [1],
+        indexes: [1], mode: 'select',
       });
 
       expect(result.status).toBe('failure');
@@ -373,21 +386,21 @@ describe('selectByIndexesCommand', () => {
       const callbacks = createCallbacks();
 
       const result = await selectByIndexesCommand.execute(instance, callbacks)({
-        indexes: [1, 3],
+        indexes: [1, 3], mode: 'select',
       });
 
       expect(selectSpy).toHaveBeenCalledWith([0, 2]);
       expect(result.status).toBe('success');
     });
 
-    it('selects when deselect is omitted (defaults to selecting)', async () => {
+    it('selects when mode is select', async () => {
       const instance = await createGrid();
       const selectSpy = jest.spyOn(instance, 'selectRowsByIndexes').mockReturnValue(Promise.resolve([]) as never);
       const deselectSpy = jest.spyOn(instance, 'deselectRows');
       const callbacks = createCallbacks();
 
       const result = await selectByIndexesCommand.execute(instance, callbacks)({
-        indexes: [1, 3],
+        indexes: [1, 3], mode: 'select',
       });
 
       expect(selectSpy).toHaveBeenCalledWith([0, 2]);
@@ -402,7 +415,7 @@ describe('selectByIndexesCommand', () => {
       const callbacks = createCallbacks();
 
       const result = await selectByIndexesCommand.execute(instance, callbacks)({
-        indexes: [1], deselect: true,
+        indexes: [1], mode: 'deselect',
       });
 
       expect(deselectSpy).toHaveBeenCalledWith([1]);
@@ -418,7 +431,7 @@ describe('selectByIndexesCommand', () => {
       const callbacks = createCallbacks();
 
       const result = await selectByIndexesCommand.execute(instance, callbacks)({
-        indexes: [1],
+        indexes: [1], mode: 'select',
       });
 
       expect(result.status).toBe('failure');
@@ -431,7 +444,7 @@ describe('selectByIndexesCommand', () => {
       const callbacks = createCallbacks();
 
       const result = await selectByIndexesCommand.execute(instance, callbacks)({
-        indexes: [1],
+        indexes: [1], mode: 'select',
       });
 
       expect(result.status).toBe('failure');
@@ -444,7 +457,7 @@ describe('selectByIndexesCommand', () => {
       const callbacks = createCallbacks();
 
       const result = await selectByIndexesCommand.execute(instance, callbacks)({
-        indexes: [1], deselect: true,
+        indexes: [1], mode: 'deselect',
       });
 
       expect(result.status).toBe('failure');
@@ -458,7 +471,7 @@ describe('selectByIndexesCommand', () => {
       const callbacks = createCallbacks();
 
       await selectByIndexesCommand.execute(instance, callbacks)({
-        indexes: [1, 3],
+        indexes: [1, 3], mode: 'select',
       });
 
       expect(callbacks.success).toHaveBeenCalledWith('Select row(s) number 1, 3 on the current page.');
@@ -470,7 +483,7 @@ describe('selectByIndexesCommand', () => {
       const callbacks = createCallbacks();
 
       await selectByIndexesCommand.execute(instance, callbacks)({
-        indexes: [1], deselect: true,
+        indexes: [1], mode: 'deselect',
       });
 
       expect(callbacks.success).toHaveBeenCalledWith('Deselect row(s) number 1 on the current page.');
@@ -481,7 +494,7 @@ describe('selectByIndexesCommand', () => {
       const callbacks = createCallbacks();
 
       await selectByIndexesCommand.execute(instance, callbacks)({
-        indexes: [1],
+        indexes: [1], mode: 'select',
       });
 
       expect(callbacks.failure).toHaveBeenCalledWith('Select row(s) number 1 on the current page.');

packages/devextreme/js/__internal/grids/grid_core/ai_assistant/commands/selection.ts

@@ -3,8 +3,7 @@ import { z } from 'zod';
 
 import { defineGridCommand } from './defineGridCommand';
 import {
-  // eslint-disable-next-line spellcheck/spell-checker
-  compositeKeyPairSchema, isKeyShapeValid, normalizeKey, optionalNullish,
+  compositeKeyPairSchema, isKeyShapeValid, normalizeKey,
 } from './utils';
 
 const selectByKeysCommandSchema = z.object({
@@ -48,22 +47,21 @@ export const selectByKeysCommand = defineGridCommand({
 
 const selectByIndexesCommandSchema = z.object({
   indexes: z.array(z.number().int().min(1)).min(1),
-  // eslint-disable-next-line spellcheck/spell-checker
-  deselect: optionalNullish(z.boolean()),
+  mode: z.enum(['select', 'deselect']),
 }).strict();
 
 export const selectByIndexesCommand = defineGridCommand({
   name: 'selectByIndexes',
   description: 'Select or deselect specific rows by their 1-based indexes within the current page. '
     + 'Index 1 is the first row on the visible page; group/header rows are not addressable. '
-    + 'Set deselect to true to remove the listed rows from the current selection (e.g. "unselect row 1"); omit it or set it to false to select them. '
-    + 'When deselect is false or omitted, the listed rows replace the current selection. '
+    + 'Set mode to "deselect" to remove the listed rows from the current selection (e.g. "unselect row 1"); set it to "select" to select them. '
+    + 'When mode is "select", the listed rows replace the current selection. '
     + 'To target rows that are not on the current page, use selectByKeys, or call pageIndex first to switch the page. '
     + 'To clear selection only within the current selectAll scope, use deselectAll; to clear selection across all pages regardless of selectAllMode, use clearSelection.',
   schema: selectByIndexesCommandSchema,
   execute: (component, { success, failure }) => async (args): Promise<CommandResult> => {
     const rowIndexes = args.indexes.join(', ');
-    const action = args.deselect ? 'Deselect' : 'Select';
+    const action = args.mode === 'deselect' ? 'Deselect' : 'Select';
     const defaultMessage = `${action} row(s) number ${rowIndexes} on the current page.`;
 
     if (component.option('selection.mode') === 'none') {
@@ -81,11 +79,17 @@ export const selectByIndexesCommand = defineGridCommand({
     }
 
     try {
-      if (args.deselect) {
-        const itemKeys = normalizedRowIndexes.map((index) => items[index].key);
-        await component.deselectRows(itemKeys);
-      } else {
-        await component.selectRowsByIndexes(normalizedRowIndexes);
+      switch (args.mode) {
+        case 'deselect': {
+          const itemKeys = normalizedRowIndexes.map((index) => items[index].key);
+          await component.deselectRows(itemKeys);
+          break;
+        }
+        case 'select':
+          await component.selectRowsByIndexes(normalizedRowIndexes);
+          break;
+        default:
+          return failure(defaultMessage);
       }
 
       return success(defaultMessage);

packages/devextreme/js/common/grids.d.ts

@@ -222,7 +222,7 @@ export type PredefinedCommands = {
   };
   selectByIndexes: {
     indexes: number[];
-    deselect?: boolean;
+    mode: 'select' | 'deselect';
   };
   selectAll: {};
   deselectAll: {};

packages/devextreme/ts/dx.all.d.ts

@@ -6611,7 +6611,7 @@ declare module DevExpress.common.grids {
     };
     selectByIndexes: {
       indexes: number[];
-      deselect?: boolean;
+      mode: 'select' | 'deselect';
     };
     selectAll: {};
     deselectAll: {};