Deprecate builder API (#4103)

## Description

The time to deprecate builder API has come.

## Test plan

Checked in vsc that v2 related elements are marked as deprecated.

Author: m-bert

packages/react-native-gesture-handler/src/handlers/gestures/flingGesture.ts

@@ -3,6 +3,9 @@ import type { FlingGestureHandlerEventPayload } from '../GestureHandlerEventPayl
 import type { BaseGestureConfig } from './gesture';
 import { BaseGesture } from './gesture';
 
+/**
+ * @deprecated `FlingGesture` is deprecated and will be removed in the future. Please use `useFlingGesture` instead.
+ */
 export class FlingGesture extends BaseGesture<FlingGestureHandlerEventPayload> {
   public override config: BaseGestureConfig & FlingGestureConfig = {};
 
@@ -34,4 +37,7 @@ export class FlingGesture extends BaseGesture<FlingGestureHandlerEventPayload> {
   }
 }
 
+/**
+ * @deprecated `FlingGestureType` is deprecated and will be removed in the future. Please use `FlingGesture` instead.
+ */
 export type FlingGestureType = InstanceType<typeof FlingGesture>;

packages/react-native-gesture-handler/src/handlers/gestures/forceTouchGesture.ts

@@ -5,7 +5,7 @@ import type { BaseGestureConfig } from './gesture';
 import { ContinousBaseGesture } from './gesture';
 
 /**
- * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
+ * @deprecated `ForceTouchGestureChangeEventPayload` is deprecated and will be removed in the future.
  */
 export type ForceTouchGestureChangeEventPayload = {
   forceChange: number;
@@ -31,7 +31,7 @@ function changeEventCalculator(
 }
 
 /**
- * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
+ * @deprecated `ForceTouchGesture` is deprecated and will be removed in the future.
  */
 export class ForceTouchGesture extends ContinousBaseGesture<
   ForceTouchGestureHandlerEventPayload,
@@ -91,6 +91,6 @@ export class ForceTouchGesture extends ContinousBaseGesture<
 }
 
 /**
- * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
+ * @deprecated `ForceTouchGestureType` is deprecated and will be removed in the future.
  */
 export type ForceTouchGestureType = InstanceType<typeof ForceTouchGesture>;

packages/react-native-gesture-handler/src/handlers/gestures/gesture.ts

@@ -22,6 +22,9 @@ import type {
 import { getNextHandlerTag } from '../getNextHandlerTag';
 import type { GestureStateManagerType } from './gestureStateManager';
 
+/**
+ * @deprecated `GestureType` is deprecated and will be removed in the future. Please use `SingleGesture` instead.
+ */
 export type GestureType =
   | BaseGesture<Record<string, unknown>>
   | BaseGesture<Record<string, never>>
@@ -35,6 +38,9 @@ export type GestureType =
   | BaseGesture<NativeViewGestureHandlerPayload>
   | BaseGesture<HoverGestureHandlerEventPayload>;
 
+/**
+ * @deprecated `GestureRef` is deprecated and will be removed in the future.
+ */
 export type GestureRef =
   | number
   | GestureType

packages/react-native-gesture-handler/src/handlers/gestures/gestureComposition.ts

@@ -12,6 +12,9 @@ function extendRelation(
   }
 }
 
+/**
+ * @deprecated `ComposedGesture` is deprecated and will be removed in the future. Please use `useCompetingGestures` instead.
+ */
 export class ComposedGesture extends Gesture {
   protected gestures: Gesture[] = [];
   protected simultaneousGestures: GestureType[] = [];
@@ -70,6 +73,9 @@ export class ComposedGesture extends Gesture {
   }
 }
 
+/**
+ * @deprecated `SimultaneousGesture` is deprecated and will be removed in the future. Please use `useSimultaneousGestures` instead.
+ */
 export class SimultaneousGesture extends ComposedGesture {
   override prepare() {
     // This piece of magic works something like this:
@@ -96,6 +102,9 @@ export class SimultaneousGesture extends ComposedGesture {
   }
 }
 
+/**
+ * @deprecated `ExclusiveGesture` is deprecated and will be removed in the future. Please use `useExclusiveGestures` instead.
+ */
 export class ExclusiveGesture extends ComposedGesture {
   override prepare() {
     // Transforms the array of gestures into array of grouped raw (not composed) gestures
@@ -119,7 +128,19 @@ export class ExclusiveGesture extends ComposedGesture {
   }
 }
 
+/**
+ * @deprecated `ComposedGestureType` is deprecated and will be removed in the future. Please use `ComposedGesture` instead.
+ */
 export type ComposedGestureType = InstanceType<typeof ComposedGesture>;
+/**
+ * @deprecated `RaceGestureType` is deprecated and will be removed in the future. Please use `ComposedGesture` instead.
+ */
 export type RaceGestureType = ComposedGestureType;
+/**
+ * @deprecated `SimultaneousGestureType` is deprecated and will be removed in the future. Please use `ComposedGesture` instead.
+ */
 export type SimultaneousGestureType = InstanceType<typeof SimultaneousGesture>;
+/**
+ * @deprecated `ExclusiveGestureType` is deprecated and will be removed in the future. Please use `ComposedGesture` instead.
+ */
 export type ExclusiveGestureType = InstanceType<typeof ExclusiveGesture>;

packages/react-native-gesture-handler/src/handlers/gestures/gestureObjects.ts

@@ -16,6 +16,8 @@ import { RotationGesture } from './rotationGesture';
 import { TapGesture } from './tapGesture';
 
 /**
+ * @deprecated `Gesture` builder API is deprecated and will be removed in a future version of Gesture Handler. Please migrate to the new, hook-based API.
+ *
  * `Gesture` is the object that allows you to create and compose gestures.
  *
  * ### Remarks
@@ -25,6 +27,8 @@ import { TapGesture } from './tapGesture';
  */
 export const GestureObjects = {
   /**
+   * @deprecated `Gesture.Tap()` is deprecated and will be removed in the future. Please use `useTapGesture` instead.
+   *
    * A discrete gesture that recognizes one or many taps.
    * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/tap-gesture
    */
@@ -33,6 +37,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Pan()` is deprecated and will be removed in the future. Please use `usePanGesture` instead.
+   *
    * A continuous gesture that can recognize a panning (dragging) gesture and track its movement.
    * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pan-gesture
    */
@@ -41,6 +47,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Pinch()` is deprecated and will be removed in the future. Please use `usePinchGesture` instead.
+   *
    * A continuous gesture that recognizes pinch gesture. It allows for tracking the distance between two fingers and use that information to scale or zoom your content.
    * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/pinch-gesture
    */
@@ -49,6 +57,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Rotation()` is deprecated and will be removed in the future. Please use `useRotationGesture` instead.
+   *
    * A continuous gesture that can recognize rotation and track its movement.
    * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/rotation-gesture
    */
@@ -57,6 +67,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Fling()` is deprecated and will be removed in the future. Please use `useFlingGesture` instead.
+   *
    * A discrete gesture that activates when the movement is sufficiently fast.
    * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/fling-gesture
    */
@@ -65,6 +77,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.LongPress()` is deprecated and will be removed in the future. Please use `useLongPressGesture` instead.
+   *
    * A discrete gesture that activates when the corresponding view is pressed for a sufficiently long time.
    * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/long-press-gesture
    */
@@ -73,7 +87,7 @@ export const GestureObjects = {
   },
 
   /**
-   * @deprecated ForceTouch gesture is deprecated and will be removed in the future.
+   * @deprecated `Gesture.ForceTouch()` is deprecated and will be removed in the future.
    *
    *  #### iOS only
    * A continuous gesture that recognizes force of a touch. It allows for tracking pressure of touch on some iOS devices.
@@ -84,6 +98,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Native()` is deprecated and will be removed in the future. Please use `useNativeGesture` instead.
+   *
    * A gesture that allows other touch handling components to participate in RNGH's gesture system.
    * When used, the other component should be the direct child of a `GestureDetector`.
    * @see https://docs.swmansion.com/react-native-gesture-handler/docs/gestures/native-gesture
@@ -93,6 +109,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Manual()` is deprecated and will be removed in the future. Please use `useManualGesture` instead.
+   *
    * A plain gesture that has no specific activation criteria nor event data set.
    * Its state has to be controlled manually using a state manager.
    * It will not fail when all the pointers are lifted from the screen.
@@ -103,6 +121,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Hover()` is deprecated and will be removed in the future. Please use `useHoverGesture` instead.
+   *
    * A continuous gesture that can recognize hovering above the view it's attached to.
    * The hover effect may be activated by moving a mouse or a stylus over the view.
    *
@@ -113,6 +133,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Race()` is deprecated and will be removed in the future. Please use `useCompetingGestures` instead.
+   *
    * Builds a composed gesture consisting of gestures provided as parameters.
    * The first one that becomes active cancels the rest of gestures.
    * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#race
@@ -122,6 +144,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Simultaneous()` is deprecated and will be removed in the future. Please use `useSimultaneousGestures` instead.
+   *
    * Builds a composed gesture that allows all base gestures to run simultaneously.
    * @see https://docs.swmansion.com/react-native-gesture-handler/docs/fundamentals/gesture-composition/#simultaneous
    */
@@ -130,6 +154,8 @@ export const GestureObjects = {
   },
 
   /**
+   * @deprecated `Gesture.Exclusive()` is deprecated and will be removed in the future. Please use `useExclusiveGestures` instead.
+   *
    * Builds a composed gesture where only one of the provided gestures can become active.
    * Priority is decided through the order of gestures: the first one has higher priority
    * than the second one, second one has higher priority than the third one, and so on.

packages/react-native-gesture-handler/src/handlers/gestures/gestureStateManager.ts

@@ -1,6 +1,9 @@
 import { State } from '../../State';
 import { tagMessage } from '../../utils';
 
+/**
+ * @deprecated `LegacyGestureStateManagerType` is deprecated and will be removed in the future. Please use the new, hook-based API instead.
+ */
 export interface GestureStateManagerType {
   begin: () => void;
   activate: () => void;
@@ -49,6 +52,9 @@ function create(handlerTag: number): GestureStateManagerType {
   };
 }
 
+/**
+ * @deprecated `LegacyGestureStateManager` is deprecated and will be removed in the future. Please use the new, hook-based API instead.
+ */
 export const GestureStateManager = {
   create,
 };

packages/react-native-gesture-handler/src/handlers/gestures/hoverGesture.ts

@@ -41,6 +41,9 @@ function changeEventCalculator(
   return { ...current, ...changePayload };
 }
 
+/**
+ * @deprecated `HoverGesture` is deprecated and will be removed in the future. Please use `useHoverGesture` instead.
+ */
 export class HoverGesture extends ContinousBaseGesture<
   HoverGestureHandlerEventPayload,
   HoverGestureChangeEventPayload
@@ -75,4 +78,7 @@ export class HoverGesture extends ContinousBaseGesture<
   }
 }
 
+/**
+ * @deprecated `HoverGestureType` is deprecated and will be removed in the future. Please use `HoverGesture` instead.
+ */
 export type HoverGestureType = InstanceType<typeof HoverGesture>;

packages/react-native-gesture-handler/src/handlers/gestures/longPressGesture.ts

@@ -3,6 +3,9 @@ import type { LongPressGestureConfig } from '../LongPressGestureHandler';
 import type { BaseGestureConfig } from './gesture';
 import { BaseGesture } from './gesture';
 
+/**
+ * @deprecated `LongPressGesture` is deprecated and will be removed in the future. Please use `useLongPressGesture` instead.
+ */
 export class LongPressGesture extends BaseGesture<LongPressGestureHandlerEventPayload> {
   public override config: BaseGestureConfig & LongPressGestureConfig = {};
 
@@ -43,4 +46,7 @@ export class LongPressGesture extends BaseGesture<LongPressGestureHandlerEventPa
   }
 }
 
+/**
+ * @deprecated `LongPressGestureType` is deprecated and will be removed in the future. Please use `LongPressGesture` instead.
+ */
 export type LongPressGestureType = InstanceType<typeof LongPressGesture>;

packages/react-native-gesture-handler/src/handlers/gestures/manualGesture.ts

@@ -9,6 +9,9 @@ function changeEventCalculator(
   return current;
 }
 
+/**
+ * @deprecated `ManualGesture` is deprecated and will be removed in the future. Please use `useManualGesture` instead.
+ */
 export class ManualGesture extends ContinousBaseGesture<
   Record<string, never>,
   Record<string, never>
@@ -28,4 +31,7 @@ export class ManualGesture extends ContinousBaseGesture<
   }
 }
 
+/**
+ * @deprecated `ManualGestureType` is deprecated and will be removed in the future. Please use `ManualGesture` instead.
+ */
 export type ManualGestureType = InstanceType<typeof ManualGesture>;

packages/react-native-gesture-handler/src/handlers/gestures/nativeGesture.ts

@@ -3,6 +3,9 @@ import type { NativeViewGestureConfig } from '../NativeViewGestureHandler';
 import type { BaseGestureConfig } from './gesture';
 import { BaseGesture } from './gesture';
 
+/**
+ * @deprecated `NativeGesture` is deprecated and will be removed in the future. Please use `useNativeGesture` instead.
+ */
 export class NativeGesture extends BaseGesture<NativeViewGestureHandlerPayload> {
   public override config: BaseGestureConfig & NativeViewGestureConfig = {};
 
@@ -31,4 +34,7 @@ export class NativeGesture extends BaseGesture<NativeViewGestureHandlerPayload>
   }
 }
 
+/**
+ * @deprecated `NativeGestureType` is deprecated and will be removed in the future. Please use `NativeGesture` instead.
+ */
 export type NativeGestureType = InstanceType<typeof NativeGesture>;