@amazon-devices/lottie-react-native 2.0.1758683737

package/src/specs/LottieAnimationViewNativeComponent.ts

@@ -0,0 +1,170 @@
+/*
+ * Portions of this file are copyright (c) 2023 Amazon.com, Inc. or its affiliates.  All rights reserved.
+ *
+ * PORTIONS OF THIS FILE ARE AMAZON PROPRIETARY/CONFIDENTIAL.  USE IS SUBJECT TO LICENSE TERMS.
+ *
+ * Amazon modifications are indicated by [amznmod_* comments].
+ */
+
+/*
+ * Changelog:
+ * Set up lottie-react-native package to build for Kepler
+ */
+
+import type {
+  BubblingEventHandler,
+  Int32,
+  Double,
+  Float,
+} from 'react-native/Libraries/Types/CodegenTypes';
+import codegenNativeCommands from 'react-native/Libraries/Utilities/codegenNativeCommands';
+import type { HostComponent, ProcessedColorValue, ViewProps } from 'react-native';
+import register from '@amazon-devices/react-native-kepler/Libraries/Utilities/registerGeneratedViewConfig';
+
+export type OnAnimationFinishEvent = Readonly<{
+  isCancelled: boolean;
+}>;
+
+// amznmod_react - add EmptyEvent type
+export type EmptyEvent = {
+  // Nothing to return in this event
+};
+
+type ColorFilterStruct = Readonly<{
+  keypath: string;
+  color: ProcessedColorValue;
+}>;
+
+type TextFilterIOSStruct = Readonly<{
+  keypath: string;
+  text: string;
+}>;
+
+type TextFilterAndroidStruct = Readonly<{
+  find: string;
+  replace: string;
+}>;
+
+type TextFilterKeplerStruct = Readonly<{
+  keypath: string;
+  text: string;
+}>;
+
+export interface NativeProps extends ViewProps {
+  // amznmod_react - add autoPlay as native prop to avoid component mount race condition
+  autoPlay?: boolean;
+  resizeMode?: string;
+  renderMode?: string;
+  sourceName?: string;
+  sourceJson?: string;
+  sourceURL?: string;
+  imageAssetsFolder?: string;
+  progress?: Float;
+  speed?: Double;
+  loop?: boolean;
+  enableMergePathsAndroidForKitKatAndAbove?: boolean;
+  hardwareAccelerationAndroid?: boolean;
+  cacheComposition?: boolean;
+  colorFilters?: ReadonlyArray<ColorFilterStruct>;
+  // dummy that solves codegen issue when there's a ReadonlyArray<Object> without another Object prop
+  // https://github.com/reactwg/react-native-new-architecture/discussions/104
+  dummy?: Readonly<{ dummy: boolean }>;
+  textFiltersAndroid?: ReadonlyArray<TextFilterAndroidStruct>;
+  textFiltersIOS?: ReadonlyArray<TextFilterIOSStruct>;
+  // amznmod_react - add textFiltersKepler prop
+  textFiltersKepler?: ReadonlyArray<TextFilterKeplerStruct>;
+  onAnimationFinish?: BubblingEventHandler<
+    OnAnimationFinishEvent,
+    'onAnimationFinish'
+  >;
+  // amznmod_react - add onAnimation... callbacks
+  onAnimationLoad?: BubblingEventHandler<EmptyEvent>;
+  onAnimationPlay?: BubblingEventHandler<EmptyEvent>;
+  onAnimationPause?: BubblingEventHandler<EmptyEvent>;
+  onAnimationResume?: BubblingEventHandler<EmptyEvent>;
+  // PROJ*-136246 - deprecate onAnimationJsonLoad in MR33
+  onAnimationJsonLoad?: BubblingEventHandler<EmptyEvent>;
+}
+
+// amznmod_react - change NativeComponentType to HostComponent
+type LottieViewNativeComponentType = HostComponent<NativeProps>;
+
+interface NativeCommands {
+  play: (
+    viewRef: React.ElementRef<LottieViewNativeComponentType>,
+    startFrame: Int32,
+    endFrame: Int32,
+  ) => void;
+  reset: (viewRef: React.ElementRef<LottieViewNativeComponentType>) => void;
+  pause: (viewRef: React.ElementRef<LottieViewNativeComponentType>) => void;
+  resume: (viewRef: React.ElementRef<LottieViewNativeComponentType>) => void;
+}
+
+export const Commands: NativeCommands = codegenNativeCommands<NativeCommands>({
+  supportedCommands: ['play', 'reset', 'pause', 'resume'],
+});
+
+// amznmod_react - native component registration to build for Kepler
+const LottieNativeComponent = 'LottieAnimationView'
+const viewConfig = {
+  autoPlay: true,
+  sourceName: true,
+  resizeMode: true,
+  renderMode: true,
+  sourceJson: true,
+  sourceURL: true,
+  imageAssetsFolder: true,
+  progress: true,
+  speed: true,
+  loop: true,
+  enableMergePathsAndroidForKitKatAndAbove: true,
+  hardwareAccelerationAndroid: true,
+  cacheComposition: true,
+  colorFilters: true,
+  textFiltersAndroid: true,
+  textFiltersIOS: true,
+  textFiltersKepler: true,
+};
+
+const bubblingEventTypes = {
+  topOnAnimationFinish: {
+    phasedRegistrationNames: {
+      bubbled: 'onAnimationFinish',
+      captured: 'onAnimationFinishCapture'
+    }
+  },
+  topOnAnimationLoad: {
+    phasedRegistrationNames: {
+      bubbled: 'onAnimationLoad',
+      captured: 'onAnimationLoadCapture'
+    }
+  },
+  // PROJ*-136246 - deprecate onAnimationJsonLoad in MR33
+  topOnAnimationJsonLoad: {
+    phasedRegistrationNames: {
+      bubbled: 'onAnimationJsonLoad',
+      captured: 'onAnimationJsonLoadCapture'
+    }
+  },
+  topOnAnimationPlay: {
+    phasedRegistrationNames: {
+      bubbled: 'onAnimationPlay',
+      captured: 'onAnimationPlayCapture'
+    }
+  },
+  topOnAnimationPause: {
+    phasedRegistrationNames: {
+      bubbled: 'onAnimationPause',
+      captured: 'onAnimationPauseCapture'
+    }
+  },
+  topOnAnimationResume: {
+    phasedRegistrationNames: {
+      bubbled: 'onAnimationResume',
+      captured: 'onAnimationResumeCapture'
+    }
+  }
+};
+
+register(LottieNativeComponent, {uiViewClassName: LottieNativeComponent, validAttributes: viewConfig, bubblingEventTypes: bubblingEventTypes});
+export default (LottieNativeComponent as unknown) as HostComponent<NativeProps>;