[flow] Fix Higher-order Component typing

[rosskevin]

So this one is huge.

Essentially, I mis-typed the HOCs, which was hiding errors for static analysis. Once I corrected the HOC types based on the docs, I then ran into a flow issue where it did not recognize defaultProps inside the wrapped component. Luckily, there is a published type in react-flow-types that solves it.

The remaining fallout was immense. Over 1700 flow errors. I have fixed all the errors, and there should be no functional changes except one: withTheme. In the interest of consistency (and these HOCs are not easy to type), I altered the execution of withTheme from withTheme(Component) to withTheme()(Component) to match everything else we have and the same pattern used in recompose.

For release notes, it isn't necessarily a breaking change, but this PR is bound to reveal existing flow errors in the user's code which was previously hidden.

Also:

• updated babel-plugin-flow-react-prop-types
• removed remaining $FlowFix Props|State from 0.53 conversion
• flow typed every remaining src tree component! We are 100%.

Breaking change

-  withTheme,
+  withTheme(),

[oliviertassinari]

I will hold future changes on the src. I'm gonna focus on upgrading enzyme.

[oliviertassinari]

I don't get it. Why changing the API?

[oliviertassinari]

It's unlikely that we will ever need configuration options.

[rosskevin]

Consistency. Sanity. My sanity. Seriously. If you want to edit it back, you can, but I'd just prefer one chosen HOC pattern.

[oliviertassinari]

Maybe @istarkov could give us some light here. For instance, I can see the pure typing.

https://github.com/acdlite/recompose/blob/6064554ccceb07d126f9df61d4d6221c5fc726ea/types/flow-typed/recompose_v0.24.x/flow_v0.55.x-/recompose_v0.24.x.js#L138

@rosskevin Are you saying that we need HigherOrderComponent to get flow going through the HOCs?

[oliviertassinari]

@rosskevin recompose seem to have HOC factories as well as HOCs depending on the use cases. I will work on this if you prefer 👼 .

[rosskevin]

HigherOrderComponent solves the default prop not found issue linked in the description.

[istarkov]

Yep, for most enhancers to type them properly they must be a function, pure is bad example as it just do nothing. So based on my experience there are no other ways

[rosskevin]

I'm back, working on the karma tests now.