Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Untangle types file dependencies #6319

Merged
merged 1 commit into from
Jul 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions packages/react-native-reanimated/src/Animated.ts
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
'use strict';
import type { Extrapolate as _Extrapolate } from './interpolateColor';
import type { SharedValue as _SharedValue } from './commonTypes';
import type {
SharedValue as _SharedValue,
AnimatedTransform as _AnimatedTransform,
AnimateStyle as _AnimateStyle,
StylesOrDefault as _StylesOrDefault,
EasingFunction as _EasingFunction,
} from './commonTypes';
import type { DerivedValue as _DerivedValue } from './hook/useDerivedValue';
import type {
TransformStyleTypes as _TransformStyleTypes,
Adaptable as _Adaptable,
AdaptTransforms as _AdaptTransforms,
AnimatedTransform as _AnimatedTransform,
AnimateStyle as _AnimateStyle,
StylesOrDefault as _StylesOrDefault,
AnimateProps as _AnimateProps,
} from './helperTypes';
import type { EasingFunction as _EasingFunction } from './Easing';

import type { AnimatedScrollViewProps as _AnimatedScrollViewProps } from './component/ScrollView';
import type { FlatListPropsWithLayout as _FlatListPropsWithLayout } from './component/FlatList';
Expand Down
3 changes: 1 addition & 2 deletions packages/react-native-reanimated/src/Easing.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
'use strict';
import { Bezier } from './Bezier';
import type { EasingFunction } from './commonTypes';

/**
* The `Easing` module implements common easing functions. This module is used
Expand Down Expand Up @@ -47,8 +48,6 @@ import { Bezier } from './Bezier';
* - [`out`](docs/easing.html#out) runs an easing function backwards
*/

export type EasingFunction = (t: number) => number;

/**
* @deprecated Please use {@link EasingFunction} type instead.
*/
Expand Down
8 changes: 6 additions & 2 deletions packages/react-native-reanimated/src/UpdateProps.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@
'use strict';
import type { MutableRefObject } from 'react';
import { processColorsInProps } from './Colors';
import type { ShadowNodeWrapper, SharedValue, StyleProps } from './commonTypes';
import type { AnimatedStyle } from './helperTypes';
import type {
ShadowNodeWrapper,
SharedValue,
StyleProps,
AnimatedStyle,
} from './commonTypes';
import type { Descriptor } from './hook/commonTypes';
import type { ReanimatedHTMLElement } from './js-reanimated';
import { _updatePropsJS } from './js-reanimated';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import type {
Animation,
Timestamp,
AnimationCallback,
AnimatedStyle,
} from '../commonTypes';
import type { AnimatedStyle } from '../helperTypes';

export interface HigherOrderAnimation {
isHigherOrder?: boolean;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ import type {
Animation,
NestedObject,
NestedObjectValues,
AnimatedStyle,
} from '../commonTypes';
import type { AnimatedStyle } from '../helperTypes';
import type { StyleLayoutAnimation } from './commonTypes';
import { withTiming } from './timing';
import { ColorProperties, processColor } from '../Colors';
Expand Down
3 changes: 2 additions & 1 deletion packages/react-native-reanimated/src/animation/timing.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
'use strict';
import type { EasingFunction, EasingFunctionFactory } from '../Easing';
import type { EasingFunctionFactory } from '../Easing';
import { Easing } from '../Easing';
import {
assertEasingIsWorklet,
Expand All @@ -12,6 +12,7 @@ import type {
Timestamp,
AnimatableValue,
ReduceMotion,
EasingFunction,
} from '../commonTypes';

/**
Expand Down
3 changes: 2 additions & 1 deletion packages/react-native-reanimated/src/animation/util.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import type {
AnimationObject,
Timestamp,
AnimatableValueObject,
EasingFunction,
} from '../commonTypes';
import type {
AffineMatrixFlat,
Expand All @@ -33,7 +34,7 @@ import {
getRotationMatrix,
} from './transformationMatrix/matrixUtils';
import { shouldBeUseWeb } from '../PlatformChecker';
import type { EasingFunction, EasingFunctionFactory } from '../Easing';
import type { EasingFunctionFactory } from '../Easing';
import { ReducedMotionManager } from '../ReducedMotion';

let IN_STYLE_UPDATER = false;
Expand Down
54 changes: 53 additions & 1 deletion packages/react-native-reanimated/src/commonTypes.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
'use strict';
import type { ViewStyle, TextStyle } from 'react-native';
import type {
ViewStyle,
TextStyle,
TransformsStyle,
ImageStyle,
} from 'react-native';

export type RequiredKeys<T, K extends keyof T> = T & Required<Pick<T, K>>;
export interface StyleProps extends ViewStyle, TextStyle {
Expand Down Expand Up @@ -306,3 +311,50 @@ export enum ReduceMotion {
Always = 'always',
Never = 'never',
}

export type EasingFunction = (t: number) => number;

export type TransformArrayItem = Extract<
TransformsStyle['transform'],
Array<unknown>
>[number];

type MaybeSharedValue<Value> =
| Value
| (Value extends AnimatableValue ? SharedValue<Value> : never);

type MaybeSharedValueRecursive<Value> = Value extends (infer Item)[]
? SharedValue<Item[]> | (MaybeSharedValueRecursive<Item> | Item)[]
: Value extends object
?
| SharedValue<Value>
| {
[Key in keyof Value]:
| MaybeSharedValueRecursive<Value[Key]>
| Value[Key];
}
: MaybeSharedValue<Value>;

type DefaultStyle = ViewStyle & ImageStyle & TextStyle;

// Ideally we want AnimatedStyle to not be generic, but there are
// so many depenedencies on it being generic that it's not feasible at the moment.
export type AnimatedStyle<Style = DefaultStyle> =
| Style
| MaybeSharedValueRecursive<Style>;

export type AnimatedTransform = MaybeSharedValueRecursive<
TransformsStyle['transform']
>;

/**
* @deprecated Please use {@link AnimatedStyle} type instead.
*/
export type AnimateStyle<Style = DefaultStyle> = AnimatedStyle<Style>;

/**
* @deprecated This type is no longer relevant.
*/
export type StylesOrDefault<T> = 'style' extends keyof T
? MaybeSharedValueRecursive<T['style']>
: Record<string, unknown>;
3 changes: 2 additions & 1 deletion packages/react-native-reanimated/src/component/FlatList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ import { AnimatedView } from './View';
import { createAnimatedComponent } from '../createAnimatedComponent';
import type { ILayoutAnimationBuilder } from '../layoutReanimation/animationBuilder/commonTypes';
import { LayoutAnimationConfig } from './LayoutAnimationConfig';
import type { AnimatedProps, AnimatedStyle } from '../helperTypes';
import type { AnimatedStyle } from '../commonTypes';
import type { AnimatedProps } from '../helperTypes';

const AnimatedFlatList = createAnimatedComponent(FlatList);

Expand Down
58 changes: 5 additions & 53 deletions packages/react-native-reanimated/src/helperTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,12 @@ until time comes to refactor the code and get necessary types right.
This will not be easy though!
*/

import type { RegisteredStyle, StyleProp } from 'react-native';
import type {
ImageStyle,
RegisteredStyle,
StyleProp,
TextStyle,
TransformsStyle,
ViewStyle,
} from 'react-native';
import type { AnimatableValue, SharedValue } from './commonTypes';
AnimatedStyle,
SharedValue,
TransformArrayItem,
} from './commonTypes';
import type { BaseAnimationBuilder } from './layoutReanimation/animationBuilder/BaseAnimationBuilder';
import type {
EntryExitAnimationFunction,
Expand All @@ -24,39 +21,6 @@ import type {
import type { ReanimatedKeyframe } from './layoutReanimation/animationBuilder/Keyframe';
import type { SharedTransition } from './layoutReanimation/sharedTransitions';

export type TransformArrayItem = Extract<
TransformsStyle['transform'],
Array<unknown>
>[number];

export type AnimatedTransform = MaybeSharedValueRecursive<
TransformsStyle['transform']
>;

type MaybeSharedValue<Value> =
| Value
| (Value extends AnimatableValue ? SharedValue<Value> : never);

type MaybeSharedValueRecursive<Value> = Value extends (infer Item)[]
? SharedValue<Item[]> | (MaybeSharedValueRecursive<Item> | Item)[]
: Value extends object
?
| SharedValue<Value>
| {
[Key in keyof Value]:
| MaybeSharedValueRecursive<Value[Key]>
| Value[Key];
}
: MaybeSharedValue<Value>;

type DefaultStyle = ViewStyle & ImageStyle & TextStyle;

// Ideally we want AnimatedStyle to not be generic, but there are
// so many depenedencies on it being generic that it's not feasible at the moment.
export type AnimatedStyle<Style = DefaultStyle> =
| Style
| MaybeSharedValueRecursive<Style>;

type EntryOrExitLayoutType =
| BaseAnimationBuilder
| typeof BaseAnimationBuilder
Expand Down Expand Up @@ -181,18 +145,6 @@ export type AdaptTransforms<T> = {
*/
export type TransformStyleTypes = TransformArrayItem;

/**
* @deprecated Please use {@link AnimatedStyle} type instead.
*/
export type AnimateStyle<Style = DefaultStyle> = AnimatedStyle<Style>;

/**
* @deprecated This type is no longer relevant.
*/
export type StylesOrDefault<T> = 'style' extends keyof T
? MaybeSharedValueRecursive<T['style']>
: Record<string, unknown>;

/**
* @deprecated This type is no longer relevant.
*/
Expand Down
2 changes: 1 addition & 1 deletion packages/react-native-reanimated/src/hook/commonTypes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import type {
ShadowNodeWrapper,
SharedValue,
WorkletFunction,
AnimatedStyle,
} from '../commonTypes';
import type {
ImageStyle,
Expand All @@ -14,7 +15,6 @@ import type {
NativeScrollEvent,
} from 'react-native';
import type { ViewDescriptorsSet } from '../ViewDescriptorsSet';
import type { AnimatedStyle } from '../helperTypes';
import type { ReanimatedHTMLElement } from '../js-reanimated';

export type DependencyList = Array<unknown> | undefined;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ import type {
WorkletFunction,
AnimatedPropsAdapterFunction,
AnimatedPropsAdapterWorklet,
AnimatedStyle,
} from '../commonTypes';
import type { AnimatedStyle } from '../helperTypes';
import { isWorkletFunction } from '../commonTypes';

const SHOULD_BE_USE_WEB = shouldBeUseWeb();
Expand Down
12 changes: 6 additions & 6 deletions packages/react-native-reanimated/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@ export {
useInterpolateConfig,
} from './interpolateColor';
export type {
EasingFunction,
EasingFn,
EasingFunctionFactory,
EasingFactoryFn,
Expand Down Expand Up @@ -245,6 +244,12 @@ export type {
AnimatedKeyboardInfo,
AnimatedKeyboardOptions,
MeasuredDimensions,
EasingFunction,
AnimatedTransform,
TransformArrayItem,
AnimateStyle,
AnimatedStyle,
StylesOrDefault,
} from './commonTypes';
export {
SensorType,
Expand Down Expand Up @@ -272,13 +277,8 @@ export type {
AdaptTransforms,
AnimateProps,
AnimatedProps,
AnimatedTransform,
TransformStyleTypes,
TransformArrayItem,
AnimateStyle,
AnimatedStyle,
AnimatedStyleProp,
StylesOrDefault,
} from './helperTypes';
export type { AnimatedScrollViewProps } from './component/ScrollView';
export type { FlatListPropsWithLayout } from './component/FlatList';
Expand Down
3 changes: 1 addition & 2 deletions packages/react-native-reanimated/src/js-reanimated/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
'use strict';
import JSReanimated from './JSReanimated';
import type { StyleProps } from '../commonTypes';
import type { AnimatedStyle } from '../helperTypes';
import type { StyleProps, AnimatedStyle } from '../commonTypes';
import {
createReactDOMStyle,
createTransformValue,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ import type {
BaseBuilderAnimationConfig,
LayoutAnimationAndConfig,
} from './commonTypes';
import type { EasingFunction } from '../../Easing';
import { BaseAnimationBuilder } from './BaseAnimationBuilder';
import type { StyleProps } from '../../commonTypes';
import type { StyleProps, EasingFunction } from '../../commonTypes';
import { assertEasingIsWorklet } from '../../animation/util';

export class ComplexAnimationBuilder extends BaseAnimationBuilder {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
'use strict';
import type { EasingFunction } from '../../Easing';
import { Easing } from '../../Easing';
import { withDelay, withSequence, withTiming } from '../../animation';
import type {
Expand All @@ -9,8 +8,11 @@ import type {
KeyframeProps,
StylePropsWithArrayTransform,
} from './commonTypes';
import type { StyleProps } from '../../commonTypes';
import type { TransformArrayItem } from '../../helperTypes';
import type {
StyleProps,
EasingFunction,
TransformArrayItem,
} from '../../commonTypes';
import { ReduceMotion } from '../../commonTypes';
import {
assertEasingIsWorklet,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
'use strict';
import type { TransformArrayItem } from '../../helperTypes';
import type { EasingFunction } from '../../Easing';
import type { ShareableRef, StyleProps } from '../../commonTypes';
import type {
ShareableRef,
StyleProps,
TransformArrayItem,
EasingFunction,
} from '../../commonTypes';

export type LayoutAnimationsOptions =
| 'originX'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import type {
LayoutAnimationFunction,
} from '../animationBuilder/commonTypes';
import { BaseAnimationBuilder } from '../animationBuilder';
import type { EasingFunction } from '../../Easing';
import type { EasingFunction } from '../../commonTypes';
import { Easing } from '../../Easing';
import { withTiming } from '../../animation';
import { assertEasingIsWorklet } from '../../animation/util';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@ import type {
import { BaseAnimationBuilder } from '../animationBuilder';
import { withSequence, withTiming } from '../../animation';
import { FadeIn, FadeOut } from '../defaultAnimations/Fade';
import type { AnimatableValue, AnimationObject } from '../../commonTypes';
import type { TransformArrayItem } from '../../helperTypes';
import type {
AnimatableValue,
AnimationObject,
TransformArrayItem,
} from '../../commonTypes';

export class EntryExitTransition
extends BaseAnimationBuilder
Expand Down
Loading