@react-native-oh-tpl/react-native-gesture-handler 2.12.1-0.0.1 → 2.12.6-1

package/src/handlers/gestureHandlerCommon.ts

@@ -1,249 +1,14 @@
-// Previous types exported gesture handlers as classes which creates an interface and variable, both named the same as class.
-// Without those types, we'd introduce breaking change, forcing users to prefix every handler type specification with typeof
-// e.g. React.createRef<TapGestureHandler> -> React.createRef<typeof TapGestureHandler>.
-// See https://www.typescriptlang.org/docs/handbook/classes.html#constructor-functions for reference.
-import * as React from 'react';
-import { Platform, findNodeHandle as findNodeHandleRN } from 'react-native';
-
-import { State } from '../State';
-import { TouchEventType } from '../TouchEventType';
-import { ValueOf } from '../typeUtils';
-import { handlerIDToTag } from './handlersRegistry';
-import { toArray } from '../utils';
-import RNGestureHandlerModule from '../RNGestureHandlerModule';
-import { ghQueueMicrotask } from '../ghQueueMicrotask';
-
-const commonProps = [
-  'id',
-  'enabled',
-  'shouldCancelWhenOutside',
-  'hitSlop',
-  'cancelsTouchesInView',
-  'userSelect',
-  'activeCursor',
-] as const;
-
-const componentInteractionProps = [
-  'waitFor',
-  'simultaneousHandlers',
-  'blocksHandlers',
-] as const;
-
-export const baseGestureHandlerProps = [
-  ...commonProps,
-  ...componentInteractionProps,
-  'onBegan',
-  'onFailed',
-  'onCancelled',
-  'onActivated',
-  'onEnded',
-  'onGestureEvent',
-  'onHandlerStateChange',
-] as const;
-
-export const baseGestureHandlerWithMonitorProps = [
-  ...commonProps,
-  'needsPointerData',
-  'manualActivation',
-];
-
-export interface GestureEventPayload {
-  handlerTag: number;
-  numberOfPointers: number;
-  state: ValueOf<typeof State>;
-}
-export interface HandlerStateChangeEventPayload extends GestureEventPayload {
-  oldState: ValueOf<typeof State>;
-}
-
-export type HitSlop =
-  | number
-  | Partial<
-      Record<
-        'left' | 'right' | 'top' | 'bottom' | 'vertical' | 'horizontal',
-        number
-      >
-    >
-  | Record<'width' | 'left', number>
-  | Record<'width' | 'right', number>
-  | Record<'height' | 'top', number>
-  | Record<'height' | 'bottom', number>;
-
-export type UserSelect = 'none' | 'auto' | 'text';
-export type ActiveCursor =
-  | 'auto'
-  | 'default'
-  | 'none'
-  | 'context-menu'
-  | 'help'
-  | 'pointer'
-  | 'progress'
-  | 'wait'
-  | 'cell'
-  | 'crosshair'
-  | 'text'
-  | 'vertical-text'
-  | 'alias'
-  | 'copy'
-  | 'move'
-  | 'no-drop'
-  | 'not-allowed'
-  | 'grab'
-  | 'grabbing'
-  | 'e-resize'
-  | 'n-resize'
-  | 'ne-resize'
-  | 'nw-resize'
-  | 's-resize'
-  | 'se-resize'
-  | 'sw-resize'
-  | 'w-resize'
-  | 'ew-resize'
-  | 'ns-resize'
-  | 'nesw-resize'
-  | 'nwse-resize'
-  | 'col-resize'
-  | 'row-resize'
-  | 'all-scroll'
-  | 'zoom-in'
-  | 'zoom-out';
-
-//TODO(TS) events in handlers
-
-export interface GestureEvent<ExtraEventPayloadT = Record<string, unknown>> {
-  nativeEvent: Readonly<GestureEventPayload & ExtraEventPayloadT>;
-}
-export interface HandlerStateChangeEvent<
-  ExtraEventPayloadT = Record<string, unknown>
-> {
-  nativeEvent: Readonly<HandlerStateChangeEventPayload & ExtraEventPayloadT>;
-}
-
-export type TouchData = {
-  id: number;
-  x: number;
-  y: number;
-  absoluteX: number;
-  absoluteY: number;
-};
-
-export type GestureTouchEvent = {
-  handlerTag: number;
-  numberOfTouches: number;
-  state: ValueOf<typeof State>;
-  eventType: TouchEventType;
-  allTouches: TouchData[];
-  changedTouches: TouchData[];
-};
-
-export type GestureUpdateEvent<GestureEventPayloadT = Record<string, unknown>> =
-  GestureEventPayload & GestureEventPayloadT;
-
-export type GestureStateChangeEvent<
-  GestureStateChangeEventPayloadT = Record<string, unknown>
-> = HandlerStateChangeEventPayload & GestureStateChangeEventPayloadT;
-
-export type CommonGestureConfig = {
-  enabled?: boolean;
-  shouldCancelWhenOutside?: boolean;
-  hitSlop?: HitSlop;
-  userSelect?: UserSelect;
-  activeCursor?: ActiveCursor;
-};
-
-// Events payloads are types instead of interfaces due to TS limitation.
-// See https://github.com/microsoft/TypeScript/issues/15300 for more info.
-export type BaseGestureHandlerProps<
-  ExtraEventPayloadT extends Record<string, unknown> = Record<string, unknown>
-> = CommonGestureConfig & {
-  id?: string;
-  waitFor?: React.Ref<unknown> | React.Ref<unknown>[];
-  simultaneousHandlers?: React.Ref<unknown> | React.Ref<unknown>[];
-  blocksHandlers?: React.Ref<unknown> | React.Ref<unknown>[];
-  testID?: string;
-  cancelsTouchesInView?: boolean;
-  // TODO(TS) - fix event types
-  onBegan?: (event: HandlerStateChangeEvent) => void;
-  onFailed?: (event: HandlerStateChangeEvent) => void;
-  onCancelled?: (event: HandlerStateChangeEvent) => void;
-  onActivated?: (event: HandlerStateChangeEvent) => void;
-  onEnded?: (event: HandlerStateChangeEvent) => void;
-
-  //TODO(TS) consider using NativeSyntheticEvent
-  onGestureEvent?: (event: GestureEvent<ExtraEventPayloadT>) => void;
-  onHandlerStateChange?: (
-    event: HandlerStateChangeEvent<ExtraEventPayloadT>
-  ) => void;
-  // implicit `children` prop has been removed in @types/react^18.0.0
-  children?: React.ReactNode;
-};
-
-function isConfigParam(param: unknown, name: string) {
-  // param !== Object(param) returns false if `param` is a function
-  // or an object and returns true if `param` is null
-  return (
-    param !== undefined &&
-    (param !== Object(param) ||
-      !('__isNative' in (param as Record<string, unknown>))) &&
-    name !== 'onHandlerStateChange' &&
-    name !== 'onGestureEvent'
-  );
-}
-
-export function filterConfig(
-  props: Record<string, unknown>,
-  validProps: string[],
-  defaults: Record<string, unknown> = {}
-) {
-  const filteredConfig = { ...defaults };
-  for (const key of validProps) {
-    let value = props[key];
-    if (isConfigParam(value, key)) {
-      if (key === 'simultaneousHandlers' || key === 'waitFor') {
-        value = transformIntoHandlerTags(props[key]);
-      } else if (key === 'hitSlop' && typeof value !== 'object') {
-        value = { top: value, left: value, bottom: value, right: value };
-      }
-      filteredConfig[key] = value;
-    }
-  }
-  return filteredConfig;
-}
-
-function transformIntoHandlerTags(handlerIDs: any) {
-  handlerIDs = toArray(handlerIDs);
-
-  if (Platform.OS === 'web') {
-    return handlerIDs
-      .map(({ current }: { current: any }) => current)
-      .filter((handle: any) => handle);
-  }
-  // converts handler string IDs into their numeric tags
-  return handlerIDs
-    .map(
-      (handlerID: any) =>
-        handlerIDToTag[handlerID] || handlerID.current?.handlerTag || -1
-    )
-    .filter((handlerTag: number) => handlerTag > 0);
-}
-
-export function findNodeHandle(
-  node: null | number | React.Component<any, any> | React.ComponentClass<any>
-): null | number | React.Component<any, any> | React.ComponentClass<any> {
-  if (Platform.OS === 'web') {
-    return node;
-  }
-  return findNodeHandleRN(node);
-}
+import { RNGestureHandlerModule } from '../RNGestureHandlerModule'; // RNGH: patch
 
 let flushOperationsScheduled = false;
 
 export function scheduleFlushOperations() {
   if (!flushOperationsScheduled) {
     flushOperationsScheduled = true;
-    ghQueueMicrotask(() => {
-      RNGestureHandlerModule.flushOperations();
-
+    queueMicrotask(() => {
+      if (RNGestureHandlerModule) {
+        RNGestureHandlerModule.flushOperations();
+      }
       flushOperationsScheduled = false;
     });
   }

package/src/handlers/gestures/GestureDetector.tsx

@@ -1,3 +1,8 @@
+/**
+ * Why is this file patched?
+ * - replacing import to RNGestureHandlerModule - original code uses (old) Native Modules but RNOH supports only Turbo Modules
+ */
+
 import React, { useContext, useEffect, useRef, useState } from 'react';
 import {
   GestureType,
@@ -5,10 +10,10 @@ import {
   BaseGesture,
   GestureRef,
   CALLBACK_TYPE,
-} from './gesture';
-import { Reanimated, SharedValue } from './reanimatedWrapper';
-import { registerHandler, unregisterHandler } from '../handlersRegistry';
-import RNGestureHandlerModule from '../../RNGestureHandlerModule';
+} from 'react-native-gesture-handler/src/handlers/gestures/gesture';
+import { Reanimated, SharedValue } from 'react-native-gesture-handler/src/handlers/gestures/reanimatedWrapper';
+import { registerHandler, unregisterHandler } from 'react-native-gesture-handler/src/handlers/handlersRegistry';
+import { RNGestureHandlerModule } from '../../RNGestureHandlerModule'; // RNGH: patch
 import {
   baseGestureHandlerWithMonitorProps,
   filterConfig,
@@ -17,37 +22,41 @@ import {
   GestureUpdateEvent,
   GestureStateChangeEvent,
   HandlerStateChangeEvent,
-  scheduleFlushOperations,
   UserSelect,
-} from '../gestureHandlerCommon';
+} from 'react-native-gesture-handler/src/handlers/gestureHandlerCommon';
+import {
+  scheduleFlushOperations,
+} from '../gestureHandlerCommon'; // RNGH: patch
 import {
   GestureStateManager,
   GestureStateManagerType,
-} from './gestureStateManager';
-import { flingGestureHandlerProps } from '../FlingGestureHandler';
-import { forceTouchGestureHandlerProps } from '../ForceTouchGestureHandler';
-import { longPressGestureHandlerProps } from '../LongPressGestureHandler';
+} from 'react-native-gesture-handler/src/handlers/gestures/gestureStateManager';
+import { flingGestureHandlerProps } from 'react-native-gesture-handler/src/handlers/FlingGestureHandler';
+import { forceTouchGestureHandlerProps } from 'react-native-gesture-handler/src/handlers/ForceTouchGestureHandler';
+import { longPressGestureHandlerProps } from 'react-native-gesture-handler/src/handlers/LongPressGestureHandler';
 import {
   panGestureHandlerProps,
   panGestureHandlerCustomNativeProps,
-} from '../PanGestureHandler';
-import { tapGestureHandlerProps } from '../TapGestureHandler';
-import { hoverGestureHandlerProps } from './hoverGesture';
-import { State } from '../../State';
-import { TouchEventType } from '../../TouchEventType';
-import { ComposedGesture } from './gestureComposition';
-import { ActionType } from '../../ActionType';
-import { isFabric, isJestEnv, tagMessage } from '../../utils';
-import { getReactNativeVersion } from '../../getReactNativeVersion';
-import { getShadowNodeFromRef } from '../../getShadowNodeFromRef';
+} from 'react-native-gesture-handler/src/handlers/PanGestureHandler';
+import { tapGestureHandlerProps } from 'react-native-gesture-handler/src/handlers/TapGestureHandler';
+import { State } from 'react-native-gesture-handler/src/State';
+import { TouchEventType } from 'react-native-gesture-handler/src/TouchEventType';
+import { ComposedGesture } from 'react-native-gesture-handler/src/handlers/gestures/gestureComposition';
+import { ActionType } from 'react-native-gesture-handler/src/ActionType';
+import {
+  isFabric,
+  isJestEnv,
+  REACT_NATIVE_VERSION,
+  tagMessage,
+} from 'react-native-gesture-handler/src/utils';
+import { getShadowNodeFromRef } from 'react-native-gesture-handler/src/getShadowNodeFromRef';
 import { Platform } from 'react-native';
-import type RNGestureHandlerModuleWeb from '../../RNGestureHandlerModule.web';
-import { onGestureHandlerEvent } from './eventReceiver';
-import { RNRenderer } from '../../RNRenderer';
-import { isNewWebImplementationEnabled } from '../../EnableNewWebImplementation';
-import { nativeViewGestureHandlerProps } from '../NativeViewGestureHandler';
-import GestureHandlerRootViewContext from '../../GestureHandlerRootViewContext';
-import { ghQueueMicrotask } from '../../ghQueueMicrotask';
+import type RNGestureHandlerModuleWeb from 'react-native-gesture-handler/src/RNGestureHandlerModule.web';
+import { onGestureHandlerEvent } from 'react-native-gesture-handler/src/handlers/gestures/eventReceiver';
+import { RNRenderer } from 'react-native-gesture-handler/src/RNRenderer';
+import { isNewWebImplementationEnabled } from 'react-native-gesture-handler/src/EnableNewWebImplementation';
+import { nativeViewGestureHandlerProps } from 'react-native-gesture-handler/src/handlers/NativeViewGestureHandler';
+import GestureHandlerRootViewContext from 'react-native-gesture-handler/src/GestureHandlerRootViewContext';
 
 declare const global: {
   isFormsStackingContext: (node: unknown) => boolean | null; // JSI function
@@ -61,7 +70,6 @@ const ALLOWED_PROPS = [
   ...longPressGestureHandlerProps,
   ...forceTouchGestureHandlerProps,
   ...flingGestureHandlerProps,
-  ...hoverGestureHandlerProps,
   ...nativeViewGestureHandlerProps,
 ];
 
@@ -156,7 +164,7 @@ function attachHandlers({
 
   // use queueMicrotask to extract handlerTags, because all refs should be initialized
   // when it's ran
-  ghQueueMicrotask(() => {
+  queueMicrotask(() => {
     if (!mountedRef.current) {
       return;
     }
@@ -176,7 +184,7 @@ function attachHandlers({
 
   // use queueMicrotask to extract handlerTags, because all refs should be initialized
   // when it's ran
-  ghQueueMicrotask(() => {
+  queueMicrotask(() => {
     if (!mountedRef.current) {
       return;
     }
@@ -193,17 +201,11 @@ function attachHandlers({
         );
       }
 
-      let blocksHandlers: number[] = [];
-      if (handler.config.blocksHandlers) {
-        blocksHandlers = extractValidHandlerTags(handler.config.blocksHandlers);
-      }
-
       RNGestureHandlerModule.updateGestureHandler(
         handler.handlerTag,
         filterConfig(handler.config, ALLOWED_PROPS, {
           simultaneousHandlers: simultaneousWith,
           waitFor: requireToFail,
-          blocksHandlers: blocksHandlers,
         })
       );
     }
@@ -270,7 +272,7 @@ function updateHandlers(
   // use queueMicrotask to extract handlerTags, because when it's ran, all refs should be updated
   // and handlerTags in BaseGesture references should be updated in the loop above (we need to wait
   // in case of external relations)
-  ghQueueMicrotask(() => {
+  queueMicrotask(() => {
     if (!mountedRef.current) {
       return;
     }
@@ -567,7 +569,6 @@ function validateDetectorChildren(ref: any) {
   //         /       \
   //   NativeView  NativeView
   if (__DEV__ && Platform.OS !== 'web') {
-    const REACT_NATIVE_VERSION = getReactNativeVersion();
     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     const wrapType =
       REACT_NATIVE_VERSION.minor > 63 || REACT_NATIVE_VERSION.major > 0
@@ -618,7 +619,7 @@ interface GestureDetectorState {
 }
 export const GestureDetector = (props: GestureDetectorProps) => {
   const rootViewContext = useContext(GestureHandlerRootViewContext);
-  if (__DEV__ && !rootViewContext && !isJestEnv() && Platform.OS !== 'web') {
+  if (__DEV__ && !rootViewContext && !isJestEnv() && Platform.OS !== 'web' && (Platform.OS as any) !== "harmony") { // RNOH: patch
     throw new Error(
       'GestureDetector must be used as a descendant of GestureHandlerRootView. Otherwise the gestures will not be recognized. See https://docs.swmansion.com/react-native-gesture-handler/docs/installation for more details.'
     );