react-native/src/private/specs_DEPRECATED/modules/NativeAnimatedTurboModule.js

A framework for building native apps using React

/**
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 * @flow strict-local
 * @format
 */

import type {TurboModule} from '../../../../Libraries/TurboModule/RCTExport';
import type {UnsafeObject} from '../../../../Libraries/Types/CodegenTypes';

import shouldUseTurboAnimatedModule from '../../../../Libraries/Animated/shouldUseTurboAnimatedModule';
import * as TurboModuleRegistry from '../../../../Libraries/TurboModule/TurboModuleRegistry';

type EndResult = {finished: boolean, value?: number, offset?: number, ...};
type EndCallback = (result: EndResult) => void;
type SaveValueCallback = (value: number) => void;

export type EventMapping = {
  nativeEventPath: Array<string>,
  animatedValueTag: ?number,
};

// The config has different keys depending on the type of the Node
// TODO(T54896888): Make these types strict
export type AnimatedNodeConfig = UnsafeObject;
export type AnimatingNodeConfig = UnsafeObject;

export interface Spec extends TurboModule {
  readonly startOperationBatch: () => void;
  readonly finishOperationBatch: () => void;
  readonly createAnimatedNode: (
    tag: number,
    config: AnimatedNodeConfig,
  ) => void;
  readonly updateAnimatedNodeConfig?: (
    tag: number,
    config: AnimatedNodeConfig,
  ) => void;
  readonly getValue: (
    tag: number,
    saveValueCallback: SaveValueCallback,
  ) => void;
  readonly startListeningToAnimatedNodeValue: (tag: number) => void;
  readonly stopListeningToAnimatedNodeValue: (tag: number) => void;
  readonly connectAnimatedNodes: (parentTag: number, childTag: number) => void;
  readonly disconnectAnimatedNodes: (
    parentTag: number,
    childTag: number,
  ) => void;
  readonly startAnimatingNode: (
    animationId: number,
    nodeTag: number,
    config: AnimatingNodeConfig,
    endCallback: EndCallback,
  ) => void;
  readonly stopAnimation: (animationId: number) => void;
  readonly setAnimatedNodeValue: (nodeTag: number, value: number) => void;
  readonly setAnimatedNodeOffset: (nodeTag: number, offset: number) => void;
  readonly flattenAnimatedNodeOffset: (nodeTag: number) => void;
  readonly extractAnimatedNodeOffset: (nodeTag: number) => void;
  readonly connectAnimatedNodeToView: (
    nodeTag: number,
    viewTag: number,
  ) => void;
  readonly disconnectAnimatedNodeFromView: (
    nodeTag: number,
    viewTag: number,
  ) => void;
  readonly restoreDefaultValues: (nodeTag: number) => void;
  readonly dropAnimatedNode: (tag: number) => void;
  readonly addAnimatedEventToView: (
    viewTag: number,
    eventName: string,
    eventMapping: EventMapping,
  ) => void;
  readonly removeAnimatedEventFromView: (
    viewTag: number,
    eventName: string,
    animatedNodeTag: number,
  ) => void;

  // Events
  readonly addListener: (eventName: string) => void;
  readonly removeListeners: (count: number) => void;

  // All of the above in a batched mode
  readonly queueAndExecuteBatchedOperations?: (
    operationsAndArgs: Array<unknown>,
  ) => void;
}

const NativeModule: ?Spec = shouldUseTurboAnimatedModule()
  ? TurboModuleRegistry.get<Spec>('NativeAnimatedTurboModule')
  : null;

export default NativeModule;