feat: notify onValidationError on paste if validation failed

packages/common/src/extensions/__tests__/slickCellExternalCopyManager.spec.ts

@@ -23,6 +23,7 @@ const mockGetSelectionModel = {
 const returnValueStub = jest.fn();
 const gridStub = {
   getActiveCell: jest.fn(),
+  getActiveCellNode: jest.fn(),
   getColumns: jest.fn().mockReturnValue([
     { id: 'firstName', field: 'firstName', name: 'First Name', },
     { id: 'lastName', field: 'lastName', name: 'Last Name' },
@@ -47,6 +48,7 @@ const gridStub = {
   triggerEvent: jest.fn().mockReturnValue({ getReturnValue: returnValueStub }),
   onCellChange: new SlickEvent(),
   onKeyDown: new SlickEvent(),
+  onValidationError: new SlickEvent(),
 } as unknown as SlickGrid;
 
 const mockCellSelectionModel = {
@@ -67,6 +69,7 @@ const mockTextEditor = {
   applyValue: jest.fn(),
   loadValue: jest.fn(),
   serializeValue: jest.fn(),
+  validate: jest.fn().mockReturnValue({ valid: true, msg: null }),
 } as unknown as InputEditor;
 
 const mockTextEditorImplementation = jest.fn().mockImplementation(() => mockTextEditor);
@@ -80,9 +83,9 @@ describe('CellExternalCopyManager', () => {
   lastNameElm.textContent = 'Last Name';
   const mockEventCallback = () => { };
   const mockColumns = [
-    { id: 'firstName', field: 'firstName', name: 'First Name', editor: Editors.text, editorClass: Editors.text },
+    { id: 'firstName', field: 'firstName', name: 'First Name', editor: { model: Editors.text }, editorClass: Editors.text },
     { id: 'lastName', field: 'lastName', name: lastNameElm, },
-    { id: 'age', field: 'age', name: 'Age', editor: Editors.text, editorClass: Editors.text },
+    { id: 'age', field: 'age', name: 'Age', editor: { model: Editors.text }, editorClass: Editors.text },
   ] as Column[];
   let plugin: SlickCellExternalCopyManager;
   const gridOptionsMock = {
@@ -196,6 +199,22 @@ describe('CellExternalCopyManager', () => {
       expect(applyValSpy).toHaveBeenCalledWith(mockItem, 'some value');
     });
 
+    it('should call "setDataItemValueForColumn" and expect an onValidationError triggered if validation failed', () => {
+      const validationResults = { valid: false, msg: 'foobar' };
+      const applyValSpy = jest.spyOn(mockTextEditor, 'applyValue');
+      const loadValSpy = jest.spyOn(mockTextEditor, 'loadValue');
+      const validationSpy = jest.spyOn(mockTextEditor, 'validate').mockReturnValue(validationResults);
+      const notifySpy = jest.spyOn(gridStub.onValidationError, 'notify');
+      const mockItem = { firstName: 'John', lastName: 'Doe' };
+      plugin.init(gridStub);
+      plugin.setDataItemValueForColumn(mockItem, mockColumns[0], 'some value');
+
+      expect(loadValSpy).toHaveBeenCalledWith(mockItem);
+      expect(applyValSpy).toHaveBeenCalledWith(mockItem, 'some value');
+      expect(validationSpy).toHaveBeenCalled();
+      expect(notifySpy).toHaveBeenCalledWith(expect.objectContaining({ validationResults }));
+    });
+
     it('should call "setDataItemValueForColumn" and expect item last name to change with new value when no Editor is provided', () => {
       const mockItem = { firstName: 'John', lastName: 'Doe' };
       plugin.init(gridStub);

packages/common/src/extensions/slickCellExternalCopyManager.ts

@@ -1,6 +1,6 @@
 import { createDomElement, getHtmlStringOutput, stripTags } from '@slickgrid-universal/utils';
 
-import type { Column, ExcelCopyBufferOption, ExternalCopyClipCommand, OnEventArgs } from '../interfaces/index';
+import type { Column, Editor, ExcelCopyBufferOption, ExternalCopyClipCommand, OnEventArgs } from '../interfaces/index';
 import { SlickEvent, SlickEventData, SlickEventHandler, type SlickGrid, SlickRange, type SlickDataView, Utils as SlickUtils } from '../core/index';
 
 // using external SlickGrid JS libraries
@@ -127,15 +127,15 @@ export class SlickCellExternalCopyManager {
 
     // if a custom getter is not defined, we call serializeValue of the editor to serialize
     if (columnDef) {
-      if (columnDef.editor) {
+      if (columnDef.editor?.model) {
         const tmpP = document.createElement('p');
-        const editor = new (columnDef as any).editor({
+        const editor = new (columnDef as any).editor.model({
           container: tmpP,  // a dummy container
           column: columnDef,
           event,
           position: { top: 0, left: 0 },  // a dummy position required by some editors
           grid: this._grid,
-        });
+        }) as Editor;
         editor.loadValue(item);
         retVal = editor.serializeValue();
         editor.destroy();
@@ -155,15 +155,29 @@ export class SlickCellExternalCopyManager {
       }
 
       // if a custom setter is not defined, we call applyValue of the editor to unserialize
-      if (columnDef.editor) {
+      if (columnDef.editor?.model) {
         const tmpDiv = document.createElement('div');
-        const editor = new (columnDef as any).editor({
+        const editor = new (columnDef as any).editor.model({
           container: tmpDiv, // a dummy container
           column: columnDef,
           position: { top: 0, left: 0 },  // a dummy position required by some editors
           grid: this._grid
-        });
+        }) as Editor;
         editor.loadValue(item);
+        const validationResults = editor.validate(undefined, value);
+        if (!validationResults.valid) {
+          const activeCell = this._grid.getActiveCell()!;
+          this._grid.onValidationError.notify({
+            editor,
+            cellNode: this._grid.getActiveCellNode()!,
+            validationResults,
+            row: activeCell?.row,
+            cell: activeCell?.cell,
+            column: columnDef,
+            grid: this._grid,
+          });
+        }
+
         editor.applyValue(item, value);
         editor.destroy();
         tmpDiv.remove();