Add PointerEvent support to getEventCoordinates method (#437)

Co-authored-by: Roman Kartsev <roman.kartsev@revolut.com>
Co-authored-by: Claudéric Demers <clauderic.d@gmail.com>

.changeset/fix-pointerseensor-cypress.md

@@ -0,0 +1,6 @@
+---
+"@dnd-kit/modifiers": patch
+"@dnd-kit/utilities": patch
+---
+
+Added PointerEvent support to the `getEventCoordinates` method. This fixes testing the PointerSensor with Cypress (#436)

packages/modifiers/src/snapCenterToCursor.ts

@@ -2,7 +2,7 @@ import type {Modifier} from '@dnd-kit/core';
 import {
   getEventCoordinates,
   isTouchEvent,
-  isMouseEvent,
+  hasViewportRelativeCoordinates,
 } from '@dnd-kit/utilities';
 
 export const snapCenterToCursor: Modifier = ({
@@ -13,7 +13,8 @@ export const snapCenterToCursor: Modifier = ({
   if (
     activeNodeRect &&
     activatorEvent &&
-    (isTouchEvent(activatorEvent) || isMouseEvent(activatorEvent))
+    (isTouchEvent(activatorEvent) ||
+      hasViewportRelativeCoordinates(activatorEvent))
   ) {
     const activatorCoordinates = getEventCoordinates(activatorEvent);
     const offsetX = activatorCoordinates.x - activeNodeRect.left;

packages/utilities/src/coordinates/getEventCoordinates.ts

@@ -1,5 +1,5 @@
 import type {Coordinates} from './types';
-import {isMouseEvent, isTouchEvent} from '../event';
+import {isTouchEvent, hasViewportRelativeCoordinates} from '../event';
 
 /**
  * Returns the normalized x and y coordinates for mouse and touch events.
@@ -23,7 +23,7 @@ export function getEventCoordinates(event: Event): Coordinates {
     }
   }
 
-  if (isMouseEvent(event)) {
+  if (hasViewportRelativeCoordinates(event)) {
     return {
       x: event.clientX,
       y: event.clientY,

packages/utilities/src/event/hasViewportRelativeCoordinates.ts

@@ -0,0 +1,5 @@
+export function hasViewportRelativeCoordinates(
+  event: Event
+): event is Event & Pick<PointerEvent, 'clientX' | 'clientY'> {
+  return 'clientX' in event && 'clientY' in event;
+}

packages/utilities/src/event/index.ts

@@ -1,2 +1,2 @@
-export {isMouseEvent} from './isMouseEvent';
+export {hasViewportRelativeCoordinates} from './hasViewportRelativeCoordinates';
 export {isTouchEvent} from './isTouchEvent';

packages/utilities/src/index.ts

@@ -12,6 +12,6 @@ export type {Coordinates} from './coordinates';
 export {getEventCoordinates} from './coordinates';
 export {CSS} from './css';
 export type {Transform, Transition} from './css';
-export {isMouseEvent, isTouchEvent} from './event';
+export {hasViewportRelativeCoordinates, isTouchEvent} from './event';
 export {canUseDOM} from './execution-context';
 export type {Arguments, FirstArgument, Without} from './types';