@amazon-devices/react-native-gesture-handler 2.0.1758683737 → 4.0.0

package/src/handlers/gestures/GestureDetector/useAnimatedGesture.ts

@@ -0,0 +1,209 @@
+import { HandlerCallbacks, CALLBACK_TYPE } from '../gesture';
+import { Reanimated } from '../reanimatedWrapper';
+import {
+  GestureTouchEvent,
+  GestureUpdateEvent,
+  GestureStateChangeEvent,
+} from '../../gestureHandlerCommon';
+import {
+  GestureStateManager,
+  GestureStateManagerType,
+} from '../gestureStateManager';
+import { State } from '../../../State';
+import { TouchEventType } from '../../../TouchEventType';
+import { tagMessage } from '../../../utils';
+import { AttachedGestureState } from './types';
+
+function getHandler(
+  type: CALLBACK_TYPE,
+  gesture: HandlerCallbacks<Record<string, unknown>>
+) {
+  'worklet';
+  switch (type) {
+    case CALLBACK_TYPE.BEGAN:
+      return gesture.onBegin;
+    case CALLBACK_TYPE.START:
+      return gesture.onStart;
+    case CALLBACK_TYPE.UPDATE:
+      return gesture.onUpdate;
+    case CALLBACK_TYPE.CHANGE:
+      return gesture.onChange;
+    case CALLBACK_TYPE.END:
+      return gesture.onEnd;
+    case CALLBACK_TYPE.FINALIZE:
+      return gesture.onFinalize;
+    case CALLBACK_TYPE.TOUCHES_DOWN:
+      return gesture.onTouchesDown;
+    case CALLBACK_TYPE.TOUCHES_MOVE:
+      return gesture.onTouchesMove;
+    case CALLBACK_TYPE.TOUCHES_UP:
+      return gesture.onTouchesUp;
+    case CALLBACK_TYPE.TOUCHES_CANCELLED:
+      return gesture.onTouchesCancelled;
+  }
+}
+
+function touchEventTypeToCallbackType(
+  eventType: TouchEventType
+): CALLBACK_TYPE {
+  'worklet';
+  switch (eventType) {
+    case TouchEventType.TOUCHES_DOWN:
+      return CALLBACK_TYPE.TOUCHES_DOWN;
+    case TouchEventType.TOUCHES_MOVE:
+      return CALLBACK_TYPE.TOUCHES_MOVE;
+    case TouchEventType.TOUCHES_UP:
+      return CALLBACK_TYPE.TOUCHES_UP;
+    case TouchEventType.TOUCHES_CANCELLED:
+      return CALLBACK_TYPE.TOUCHES_CANCELLED;
+  }
+  return CALLBACK_TYPE.UNDEFINED;
+}
+
+function runWorklet(
+  type: CALLBACK_TYPE,
+  gesture: HandlerCallbacks<Record<string, unknown>>,
+  event: GestureStateChangeEvent | GestureUpdateEvent | GestureTouchEvent,
+  ...args: unknown[]
+) {
+  'worklet';
+  const handler = getHandler(type, gesture);
+  if (gesture.isWorklet[type]) {
+    // @ts-ignore Logic below makes sure the correct event is send to the
+    // correct handler.
+    handler?.(event, ...args);
+  } else if (handler) {
+    console.warn(tagMessage('Animated gesture callback must be a worklet'));
+  }
+}
+
+function isStateChangeEvent(
+  event: GestureUpdateEvent | GestureStateChangeEvent | GestureTouchEvent
+): event is GestureStateChangeEvent {
+  'worklet';
+  // @ts-ignore Yes, the oldState prop is missing on GestureTouchEvent, that's the point
+  return event.oldState != null;
+}
+
+function isTouchEvent(
+  event: GestureUpdateEvent | GestureStateChangeEvent | GestureTouchEvent
+): event is GestureTouchEvent {
+  'worklet';
+  return event.eventType != null;
+}
+
+export function useAnimatedGesture(
+  preparedGesture: AttachedGestureState,
+  needsRebuild: boolean
+) {
+  if (!Reanimated) {
+    return;
+  }
+
+  // Hooks are called conditionally, but the condition is whether the
+  // react-native-reanimated is installed, which shouldn't change while running
+  // eslint-disable-next-line react-hooks/rules-of-hooks
+  const sharedHandlersCallbacks = Reanimated.useSharedValue<
+    HandlerCallbacks<Record<string, unknown>>[] | null
+  >(null);
+
+  // eslint-disable-next-line react-hooks/rules-of-hooks
+  const lastUpdateEvent = Reanimated.useSharedValue<
+    (GestureUpdateEvent | undefined)[]
+  >([]);
+
+  // not every gesture needs a state controller, init them lazily
+  const stateControllers: GestureStateManagerType[] = [];
+
+  const callback = (
+    event: GestureStateChangeEvent | GestureUpdateEvent | GestureTouchEvent
+  ) => {
+    'worklet';
+
+    const currentCallback = sharedHandlersCallbacks.value;
+    if (!currentCallback) {
+      return;
+    }
+
+    for (let i = 0; i < currentCallback.length; i++) {
+      const gesture = currentCallback[i];
+
+      if (event.handlerTag !== gesture.handlerTag) {
+        continue;
+      }
+
+      if (isStateChangeEvent(event)) {
+        if (
+          event.oldState === State.UNDETERMINED &&
+          event.state === State.BEGAN
+        ) {
+          runWorklet(CALLBACK_TYPE.BEGAN, gesture, event);
+        } else if (
+          (event.oldState === State.BEGAN ||
+            event.oldState === State.UNDETERMINED) &&
+          event.state === State.ACTIVE
+        ) {
+          runWorklet(CALLBACK_TYPE.START, gesture, event);
+          lastUpdateEvent.value[gesture.handlerTag] = undefined;
+        } else if (
+          event.oldState !== event.state &&
+          event.state === State.END
+        ) {
+          if (event.oldState === State.ACTIVE) {
+            runWorklet(CALLBACK_TYPE.END, gesture, event, true);
+          }
+          runWorklet(CALLBACK_TYPE.FINALIZE, gesture, event, true);
+        } else if (
+          (event.state === State.FAILED || event.state === State.CANCELLED) &&
+          event.state !== event.oldState
+        ) {
+          if (event.oldState === State.ACTIVE) {
+            runWorklet(CALLBACK_TYPE.END, gesture, event, false);
+          }
+          runWorklet(CALLBACK_TYPE.FINALIZE, gesture, event, false);
+        }
+      } else if (isTouchEvent(event)) {
+        if (
+          !stateControllers[i] ||
+          stateControllers[i].handlerTag !== event.handlerTag
+        ) {
+          stateControllers[i] = GestureStateManager.create(event.handlerTag);
+        }
+
+        if (event.eventType !== TouchEventType.UNDETERMINED) {
+          runWorklet(
+            touchEventTypeToCallbackType(event.eventType),
+            gesture,
+            event,
+            stateControllers[i]
+          );
+        }
+      } else {
+        runWorklet(CALLBACK_TYPE.UPDATE, gesture, event);
+
+        if (gesture.onChange && gesture.changeEventCalculator) {
+          runWorklet(
+            CALLBACK_TYPE.CHANGE,
+            gesture,
+            gesture.changeEventCalculator?.(
+              event,
+              lastUpdateEvent.value[gesture.handlerTag]
+            )
+          );
+
+          lastUpdateEvent.value[gesture.handlerTag] = event;
+        }
+      }
+    }
+  };
+
+  // eslint-disable-next-line react-hooks/rules-of-hooks
+  const event = Reanimated.useEvent(
+    callback,
+    ['onGestureHandlerStateChange', 'onGestureHandlerEvent'],
+    needsRebuild
+  );
+
+  preparedGesture.animatedEventHandler = event;
+  preparedGesture.animatedHandlers = sharedHandlersCallbacks;
+}

package/src/handlers/gestures/GestureDetector/useDetectorUpdater.ts

@@ -0,0 +1,69 @@
+import React, { useCallback } from 'react';
+import { GestureType } from '../gesture';
+import { ComposedGesture } from '../gestureComposition';
+
+import {
+  AttachedGestureState,
+  GestureDetectorState,
+  WebEventHandler,
+} from './types';
+import { attachHandlers } from './attachHandlers';
+import { updateHandlers } from './updateHandlers';
+import { needsToReattach } from './needsToReattach';
+import { dropHandlers } from './dropHandlers';
+import { useForceRender, validateDetectorChildren } from './utils';
+import findNodeHandle from '../../../findNodeHandle';
+
+// Returns a function that's responsible for updating the attached gestures
+// If the view has changed, it will reattach the handlers to the new view
+// If the view remains the same, it will update the handlers with the new config
+export function useDetectorUpdater(
+  state: GestureDetectorState,
+  preparedGesture: AttachedGestureState,
+  gesturesToAttach: GestureType[],
+  gestureConfig: ComposedGesture | GestureType,
+  webEventHandlersRef: React.RefObject<WebEventHandler>
+) {
+  const forceRender = useForceRender();
+  const updateAttachedGestures = useCallback(
+    // skipConfigUpdate is used to prevent unnecessary updates when only checking if the view has changed
+    (skipConfigUpdate?: boolean) => {
+      // If the underlying view has changed we need to reattach handlers to the new view
+      const viewTag = findNodeHandle(state.viewRef) as number;
+      const didUnderlyingViewChange = viewTag !== state.previousViewTag;
+
+      if (
+        didUnderlyingViewChange ||
+        needsToReattach(preparedGesture, gesturesToAttach)
+      ) {
+        validateDetectorChildren(state.viewRef);
+        dropHandlers(preparedGesture);
+        attachHandlers({
+          preparedGesture,
+          gestureConfig,
+          gesturesToAttach,
+          webEventHandlersRef,
+          viewTag,
+        });
+
+        if (didUnderlyingViewChange) {
+          state.previousViewTag = viewTag;
+          state.forceRebuildReanimatedEvent = true;
+          forceRender();
+        }
+      } else if (!skipConfigUpdate) {
+        updateHandlers(preparedGesture, gestureConfig, gesturesToAttach);
+      }
+    },
+    [
+      forceRender,
+      gestureConfig,
+      gesturesToAttach,
+      preparedGesture,
+      state,
+      webEventHandlersRef,
+    ]
+  );
+
+  return updateAttachedGestures;
+}

package/src/handlers/gestures/GestureDetector/useMountReactions.ts

@@ -0,0 +1,51 @@
+import { transformIntoHandlerTags } from '../../utils';
+import { MountRegistry } from '../../../mountRegistry';
+import { AttachedGestureState } from './types';
+import { useEffect } from 'react';
+import { GestureRef } from '../gesture';
+
+function shouldUpdateDetector(
+  relation: GestureRef[] | undefined,
+  gesture: { handlerTag: number }
+) {
+  if (relation === undefined) {
+    return false;
+  }
+
+  for (const tag of transformIntoHandlerTags(relation)) {
+    if (tag === gesture.handlerTag) {
+      return true;
+    }
+  }
+
+  return false;
+}
+
+export function useMountReactions(
+  updateDetector: () => void,
+  state: AttachedGestureState
+) {
+  useEffect(() => {
+    return MountRegistry.addMountListener((gesture) => {
+      // At this point the ref in the gesture config should be updated, so we can check if one of the gestures
+      // set in a relation with the gesture got mounted. If so, we need to update the detector to propagate
+      // the changes to the native side.
+      for (const attachedGesture of state.attachedGestures) {
+        const blocksHandlers = attachedGesture.config.blocksHandlers;
+        const requireToFail = attachedGesture.config.requireToFail;
+        const simultaneousWith = attachedGesture.config.simultaneousWith;
+
+        if (
+          shouldUpdateDetector(blocksHandlers, gesture) ||
+          shouldUpdateDetector(requireToFail, gesture) ||
+          shouldUpdateDetector(simultaneousWith, gesture)
+        ) {
+          updateDetector();
+
+          // We can safely return here, if any other gestures should be updated, they will be by the above call
+          return;
+        }
+      }
+    });
+  }, [updateDetector, state]);
+}

package/src/handlers/gestures/GestureDetector/useViewRefHandler.ts

@@ -0,0 +1,58 @@
+import { isFabric, tagMessage } from '../../../utils';
+import { getShadowNodeFromRef } from '../../../getShadowNodeFromRef';
+
+import { GestureDetectorState } from './types';
+import React, { useCallback } from 'react';
+import { Platform } from 'react-native';
+import findNodeHandle from '../../../findNodeHandle';
+
+declare const global: {
+  isViewFlatteningDisabled: (node: unknown) => boolean | null; // JSI function
+};
+
+// Ref handler for the Wrap component attached under the GestureDetector.
+// It's responsible for setting the viewRef on the state and triggering the reattaching of handlers
+// if the view has changed.
+export function useViewRefHandler(
+  state: GestureDetectorState,
+  updateAttachedGestures: (skipConfigUpdate?: boolean) => void
+) {
+  const refHandler = useCallback(
+    (ref: React.Component | null) => {
+      if (ref === null) {
+        return;
+      }
+
+      state.viewRef = ref;
+
+      // if it's the first render, also set the previousViewTag to prevent reattaching gestures when not needed
+      if (state.previousViewTag === -1) {
+        state.previousViewTag = findNodeHandle(state.viewRef) as number;
+      }
+
+      // Pass true as `skipConfigUpdate`. Here we only want to trigger the eventual reattaching of handlers
+      // in case the view has changed. If the view doesn't change, the update will be handled by detector.
+      if (!state.firstRender) {
+        updateAttachedGestures(true);
+      }
+
+      if (__DEV__ && isFabric() && global.isViewFlatteningDisabled) {
+        const node = getShadowNodeFromRef(ref);
+        // amznmod_react - isViewFlatteningDisabled is not available on kepler.
+        // View flattening is not applicable on kepler, skip the check.
+        // @ts-ignore 'kepler' is a valid Platform.OS value on Kepler devices
+        if (Platform.OS !== 'kepler' && global.isViewFlatteningDisabled(node) === false) {
+          console.error(
+            tagMessage(
+              'GestureDetector has received a child that may get view-flattened. ' +
+                '\nTo prevent it from misbehaving you need to wrap the child with a `<View collapsable={false}>`.'
+            )
+          );
+        }
+      }
+    },
+    [state, updateAttachedGestures]
+  );
+
+  return refHandler;
+}

package/src/handlers/gestures/GestureDetector/utils.ts

@@ -0,0 +1,181 @@
+import { Platform } from 'react-native';
+
+import { isTestEnv, tagMessage } from '../../../utils';
+import { GestureRef, BaseGesture, GestureType } from '../gesture';
+
+import { flingGestureHandlerProps } from '../../FlingGestureHandler';
+import { forceTouchGestureHandlerProps } from '../../ForceTouchGestureHandler';
+import { longPressGestureHandlerProps } from '../../LongPressGestureHandler';
+import {
+  panGestureHandlerProps,
+  panGestureHandlerCustomNativeProps,
+} from '../../PanGestureHandler';
+import { tapGestureHandlerProps } from '../../TapGestureHandler';
+import { hoverGestureHandlerProps } from '../hoverGesture';
+import { nativeViewGestureHandlerProps } from '../../NativeViewGestureHandler';
+import {
+  HandlerStateChangeEvent,
+  baseGestureHandlerWithDetectorProps,
+} from '../../gestureHandlerCommon';
+import { isNewWebImplementationEnabled } from '../../../EnableNewWebImplementation';
+import { RNRenderer } from '../../../RNRenderer';
+import { useCallback, useRef, useState } from 'react';
+import { Reanimated } from '../reanimatedWrapper';
+import { onGestureHandlerEvent } from '../eventReceiver';
+import { WebEventHandler } from './types';
+
+export const ALLOWED_PROPS = [
+  ...baseGestureHandlerWithDetectorProps,
+  ...tapGestureHandlerProps,
+  ...panGestureHandlerProps,
+  ...panGestureHandlerCustomNativeProps,
+  ...longPressGestureHandlerProps,
+  ...forceTouchGestureHandlerProps,
+  ...flingGestureHandlerProps,
+  ...hoverGestureHandlerProps,
+  ...nativeViewGestureHandlerProps,
+];
+
+function convertToHandlerTag(ref: GestureRef): number {
+  if (typeof ref === 'number') {
+    return ref;
+  } else if (ref instanceof BaseGesture) {
+    return ref.handlerTag;
+  } else {
+    // @ts-ignore in this case it should be a ref either to gesture object or
+    // a gesture handler component, in both cases handlerTag property exists
+    return ref.current?.handlerTag ?? -1;
+  }
+}
+
+function extractValidHandlerTags(interactionGroup: GestureRef[] | undefined) {
+  return (
+    interactionGroup?.map(convertToHandlerTag)?.filter((tag) => tag > 0) ?? []
+  );
+}
+
+export function extractGestureRelations(gesture: GestureType) {
+  const requireToFail = extractValidHandlerTags(gesture.config.requireToFail);
+  const simultaneousWith = extractValidHandlerTags(
+    gesture.config.simultaneousWith
+  );
+  const blocksHandlers = extractValidHandlerTags(gesture.config.blocksHandlers);
+
+  return {
+    waitFor: requireToFail,
+    simultaneousHandlers: simultaneousWith,
+    blocksHandlers: blocksHandlers,
+  };
+}
+
+export function checkGestureCallbacksForWorklets(gesture: GestureType) {
+  if (!__DEV__) {
+    return;
+  }
+  // If a gesture is explicitly marked to run on the JS thread there is no need to check
+  // if callbacks are worklets as the user is aware they will be ran on the JS thread
+  if (gesture.config.runOnJS) {
+    return;
+  }
+
+  const areSomeNotWorklets = gesture.handlers.isWorklet.includes(false);
+  const areSomeWorklets = gesture.handlers.isWorklet.includes(true);
+
+  // If some of the callbacks are worklets and some are not, and the gesture is not
+  // explicitly marked with `.runOnJS(true)` show an error
+  if (areSomeNotWorklets && areSomeWorklets) {
+    console.error(
+      tagMessage(
+        `Some of the callbacks in the gesture are worklets and some are not. Either make sure that all calbacks are marked as 'worklet' if you wish to run them on the UI thread or use '.runOnJS(true)' modifier on the gesture explicitly to run all callbacks on the JS thread.`
+      )
+    );
+  }
+
+  if (Reanimated === undefined) {
+    // If Reanimated is not available, we can't run worklets, so we shouldn't show the warning
+    return;
+  }
+
+  const areAllNotWorklets = !areSomeWorklets && areSomeNotWorklets;
+  // If none of the callbacks are worklets and the gesture is not explicitly marked with
+  // `.runOnJS(true)` show a warning
+  if (areAllNotWorklets && !isTestEnv()) {
+    console.warn(
+      tagMessage(
+        `None of the callbacks in the gesture are worklets. If you wish to run them on the JS thread use '.runOnJS(true)' modifier on the gesture to make this explicit. Otherwise, mark the callbacks as 'worklet' to run them on the UI thread.`
+      )
+    );
+  }
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function validateDetectorChildren(ref: any) {
+  // Finds the first native view under the Wrap component and traverses the fiber tree upwards
+  // to check whether there is more than one native view as a pseudo-direct child of GestureDetector
+  // i.e. this is not ok:
+  //            Wrap
+  //             |
+  //            / \
+  //           /   \
+  //          /     \
+  //         /       \
+  //   NativeView  NativeView
+  //
+  // but this is fine:
+  //            Wrap
+  //             |
+  //         NativeView
+  //             |
+  //            / \
+  //           /   \
+  //          /     \
+  //         /       \
+  //   NativeView  NativeView
+  if (__DEV__ && Platform.OS !== 'web') {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const wrapType =
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+      ref._reactInternals.elementType;
+
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    let instance =
+      RNRenderer.findHostInstance_DEPRECATED(
+        ref
+      )._internalFiberInstanceHandleDEV;
+
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+    while (instance && instance.elementType !== wrapType) {
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+      if (instance.sibling) {
+        throw new Error(
+          'GestureDetector has more than one native view as its children. This can happen if you are using a custom component that renders multiple views, like React.Fragment. You should wrap content of GestureDetector with a <View> or <Animated.View>.'
+        );
+      }
+
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
+      instance = instance.return;
+    }
+  }
+}
+
+export function useForceRender() {
+  const [renderState, setRenderState] = useState(false);
+  const forceRender = useCallback(() => {
+    setRenderState(!renderState);
+  }, [renderState, setRenderState]);
+
+  return forceRender;
+}
+
+export function useWebEventHandlers() {
+  return useRef<WebEventHandler>({
+    onGestureHandlerEvent: (e: HandlerStateChangeEvent<unknown>) => {
+      onGestureHandlerEvent(e.nativeEvent);
+    },
+    onGestureHandlerStateChange: isNewWebImplementationEnabled()
+      ? (e: HandlerStateChangeEvent<unknown>) => {
+          onGestureHandlerEvent(e.nativeEvent);
+        }
+      : undefined,
+  });
+}

package/src/handlers/gestures/eventReceiver.ts

@@ -132,26 +132,27 @@ export function onGestureHandlerEvent(
 
 export function startListening() {
   stopListening();
-
-  // @ts-ignore types not correct?
+  // @ts-ignore
   if (Platform.OS === 'kepler') {
-    const eventEmitter = new NativeEventEmitter(RNGestureHandlerModule as typeof KeplerGestureHandlerModule);
+    // @ts-ignore
+    const eventEmitter = new NativeEventEmitter(RNGestureHandlerModule as typeof KeplerGestureHandlerModule)
 
     gestureHandlerEventSubscription = eventEmitter.addListener(
       'onGestureHandlerEvent',
       onGestureHandlerEvent
     );
-
+ 
     gestureHandlerStateChangeEventSubscription = eventEmitter.addListener(
       'onGestureHandlerStateChange',
       onGestureHandlerEvent
     );
   } else {
+    console.log(["[SWM] outside kepler"])
     gestureHandlerEventSubscription = DeviceEventEmitter.addListener(
       'onGestureHandlerEvent',
       onGestureHandlerEvent
     );
-
+  
     gestureHandlerStateChangeEventSubscription = DeviceEventEmitter.addListener(
       'onGestureHandlerStateChange',
       onGestureHandlerEvent

package/src/handlers/gestures/flingGesture.ts

@@ -1,8 +1,6 @@
 import { BaseGesture, BaseGestureConfig } from './gesture';
-import {
-  FlingGestureConfig,
-  FlingGestureHandlerEventPayload,
-} from '../FlingGestureHandler';
+import { FlingGestureConfig } from '../FlingGestureHandler';
+import type { FlingGestureHandlerEventPayload } from '../GestureHandlerEventPayload';
 
 export class FlingGesture extends BaseGesture<FlingGestureHandlerEventPayload> {
   public config: BaseGestureConfig & FlingGestureConfig = {};
@@ -13,11 +11,22 @@ export class FlingGesture extends BaseGesture<FlingGestureHandlerEventPayload> {
     this.handlerName = 'FlingGestureHandler';
   }
 
+  /**
+   * Determine exact number of points required to handle the fling gesture.
+   * @param pointers
+   */
   numberOfPointers(pointers: number) {
     this.config.numberOfPointers = pointers;
     return this;
   }
 
+  /**
+   * Expressed allowed direction of movement.
+   * Expected values are exported as constants in the Directions object.
+   * Arguments can be combined using `|` operator. Default value is set to `Directions.RIGHT`.
+   * @param direction
+   * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/fling-gesture/#directionvalue-directions
+   */
   direction(direction: number) {
     this.config.direction = direction;
     return this;