refactor: simplify types

Author: mdjastrzebski

src/native-state.ts

@@ -1,5 +1,5 @@
 import { ReactTestInstance } from 'react-test-renderer';
-import { ContentOffset } from './types';
+import { Point } from './types';
 
 /**
  * Simulated native state for unmanaged controls.
@@ -8,7 +8,7 @@ import { ContentOffset } from './types';
  */
 export type NativeState = {
   elementValues: WeakMap<ReactTestInstance, string>;
-  scrollPositions: WeakMap<ReactTestInstance, ContentOffset>;
+  scrollPositions: WeakMap<ReactTestInstance, Point>;
 };
 
 export let nativeState: NativeState | null = null;

src/types.ts

@@ -1,11 +1,19 @@
 /**
- * Scroll position of a scrollable element.
+ * Location of an element.
  */
-export interface ContentOffset {
+export interface Point {
   y: number;
   x: number;
 }
 
+/**
+ * Size of an element.
+ */
+export interface Size {
+  height: number;
+  width: number;
+}
+
 // TS autocomplete trick
 // Ref: https://github.com/microsoft/TypeScript/issues/29729#issuecomment-567871939
 export type StringWithAutocomplete<T> = T | (string & {});

src/user-event/event-builder/scroll-view.ts

@@ -1,18 +1,12 @@
-import { ContentOffset } from '../../types';
+import { Point, Size } from '../../types';
 import { baseSyntheticEvent } from './base';
 
 /**
  * Other options for constructing a scroll event.
  */
 export type ScrollEventOptions = {
-  contentSize?: {
-    height: number;
-    width: number;
-  };
-  layoutMeasurement?: {
-    height: number;
-    width: number;
-  };
+  contentSize?: Size;
+  layoutMeasurement?: Size;
 };
 
 /**
@@ -21,7 +15,7 @@ export type ScrollEventOptions = {
  * - Android: `{"contentInset": {"bottom": 0, "left": 0, "right": 0, "top": 0}, "contentOffset": {"x": 0, "y": 31.619047164916992}, "contentSize": {"height": 1624.761962890625, "width": 411.4285583496094}, "layoutMeasurement": {"height": 785.5238037109375, "width": 411.4285583496094}, "responderIgnoreScroll": true, "target": 139, "velocity": {"x": -1.3633992671966553, "y": -1.3633992671966553}}`
  */
 export const ScrollViewEventBuilder = {
-  scroll: (offset: ContentOffset = { y: 0, x: 0 }, options?: ScrollEventOptions) => {
+  scroll: (offset: Point = { y: 0, x: 0 }, options?: ScrollEventOptions) => {
     return {
       ...baseSyntheticEvent(),
       nativeEvent: {

src/user-event/event-builder/text-input.ts

@@ -1,4 +1,4 @@
-import { ContentSize } from '../utils/content-size';
+import { Size } from '../../types';
 import { TextRange } from '../utils/text-range';
 import { baseSyntheticEvent } from './base';
 
@@ -68,7 +68,7 @@ export const TextInputEventBuilder = {
    * - iOS: `{"contentSize": {"height": 21.666666666666668, "width": 11.666666666666666}, "target": 75}`
    * - Android: `{"contentSize": {"height": 61.45454406738281, "width": 352.7272644042969}, "target": 53}`
    */
-  contentSizeChange: ({ width, height }: ContentSize) => {
+  contentSizeChange: ({ width, height }: Size) => {
     return {
       ...baseSyntheticEvent(),
       nativeEvent: { contentSize: { width, height }, target: 0 },

src/user-event/scroll/scroll-to.ts

@@ -6,19 +6,13 @@ import { ErrorWithStack } from '../../helpers/errors';
 import { isHostScrollView } from '../../helpers/host-component-names';
 import { pick } from '../../helpers/object';
 import { nativeState } from '../../native-state';
-import { ContentOffset } from '../../types';
+import { Point, Size } from '../../types';
 import { dispatchEvent, wait } from '../utils';
 import { createScrollSteps, inertialInterpolator, linearInterpolator } from './utils';
 
 interface CommonScrollToOptions {
-  contentSize?: {
-    height: number;
-    width: number;
-  };
-  layoutMeasurement?: {
-    height: number;
-    width: number;
-  };
+  contentSize?: Size;
+  layoutMeasurement?: Size;
 }
 
 export interface VerticalScrollToOptions extends CommonScrollToOptions {
@@ -85,7 +79,7 @@ export async function scrollTo(
 async function emitDragScrollEvents(
   config: UserEventConfig,
   element: ReactTestInstance,
-  scrollSteps: ContentOffset[],
+  scrollSteps: Point[],
   scrollOptions: ScrollToOptions,
 ) {
   if (scrollSteps.length === 0) {
@@ -115,7 +109,7 @@ async function emitDragScrollEvents(
 async function emitMomentumScrollEvents(
   config: UserEventConfig,
   element: ReactTestInstance,
-  scrollSteps: ContentOffset[],
+  scrollSteps: Point[],
   scrollOptions: ScrollToOptions,
 ) {
   if (scrollSteps.length === 0) {

src/user-event/scroll/utils.ts

@@ -1,14 +1,14 @@
-import { ContentOffset } from '../../types';
+import { Point } from '../../types';
 
 const DEFAULT_STEPS_COUNT = 5;
 
 type InterpolatorFn = (end: number, start: number, steps: number) => number[];
 
 export function createScrollSteps(
-  target: Partial<ContentOffset>,
-  initialOffset: ContentOffset,
+  target: Partial<Point>,
+  initialOffset: Point,
   interpolator: InterpolatorFn,
-): ContentOffset[] {
+): Point[] {
   if (target.y != null) {
     return interpolator(target.y, initialOffset.y, DEFAULT_STEPS_COUNT).map((y) => ({
       y,

src/user-event/utils/content-size.ts

@@ -1,7 +1,4 @@
-export interface ContentSize {
-  width: number;
-  height: number;
-}
+import { Size } from '../../types';
 
 /**
  * Simple function for getting mock the size of given text.
@@ -13,8 +10,7 @@ export interface ContentSize {
  * @param text text to be measure
  * @returns width and height of the text
  */
-
-export function getTextContentSize(text: string): ContentSize {
+export function getTextContentSize(text: string): Size {
   const lines = text.split('\n');
   const maxLineLength = Math.max(...lines.map((line) => line.length));