When checking my Typescript code react-native-reanimated generates 99 errors.

[dcorbin]

Several of my projects use tsc to check all the code for in a commit hook. Seems like a good practice to me, so I'm trying to add this to my project that uses reanimated ("~3.17.4"). However, when I do I get 99 errors (see attachment tsc-out.txt) out of various files in the reanimated src tree. Would love to know how to get past this.

reanimated seems notably different from other libraries in that I find I'm having to import "deep into the src tree" to get access to some types, instead of having a public API in index.ts that has everything. Am I wrong to be doing this?

tsc-out.txt

[dcorbin]

Here are the "deep" imports I find myself using:

import { ComplexAnimationBuilder } from 'react-native-reanimated/src/layoutReanimation/animationBuilder';
import { KeyframeProps } from 'react-native-reanimated/src/commonTypes.ts';
import { ReanimatedKeyframe } from 'react-native-reanimated/lib/typescript/layoutReanimation/animationBuilder/Keyframe';
import { SharedValue } from 'react-native-reanimated/src/commonTypes.ts';
import { ValidKeyframeProps } from 'react-native-reanimated/lib/typescript/commonTypes';

[MatiPl01]

Hey! You should import everything from 'react-native-reanimated', not from internal files. If anything changes in Reanimated, TypeScript won't be able to properly resolver types as they might have been moved to another location.

Importing types from particular files of libraries is a very bad practice and you should be never doing that.

[MatiPl01]

It is interesting that you say:

reanimated seems notably different from other libraries in that I find I'm having to import "deep into the src tree" to get access to some types

In general, libraries should export everything what is necessary from the index file in their sources, so that everything can be imported directly. If some types aren't available, that means either someone forgot to export them or they are used internally and shouldn't be used by the library user.

If you need some types that aren't available in the public API, you can always open a PR or ask us to export them. Alternatively, you can just copy the type definition from reanimated or other library and declare this type directly in your codebase.

[MatiPl01]

I marked this comment as answer, because the discussion seems to be finished and this comment answers the original question.

[dcorbin]

Well, exposing KeyFrameProps would be very nice. I have some code that is building them. I can get around that one for now by use StyleProps, but I don't know that's true forever.

And I need EntryOrExitLayoutType or at the least ReanimatedKeyframe. Since EntryOrExitLayoutType is in fact part of a public API (entering, exiting), it seems like it should be there. I need to declare types of things that might be passed to that public API.

[MatiPl01]

Ok, so you need these 3 types, right?

• KeyFrameProps
• EntryOrExitLayoutType
• ReanimatedKeyframe

I will open a PR that exports them.

[dcorbin]

That will do. The others I was able to find a type further up the heirarchy that was properly exported and meets the needs. Thanks.

[MatiPl01]

I opened a PR here: #7546
You can expect these types to be available in the next release of Reanimated.