fix(ToolTip/index.ts): Exports TooltipProps as a type to help babel.

[gradybknight]

TooltipProps is exported but contains only TS code. Babel removes this at compile time throwing an
error with --isolatedModules flag.

4853

What: Closes #4853

Additional issues: n/a

[patternfly-build]

PF4 preview: https://patternfly-react-pr-4854.surge.sh
A11y report: https://patternfly-react-pr-4854-coverage.surge.sh
A11y report: https://patternfly-react-pr-4854-a11y.surge.sh

[KKoukiou]

It seems like 'TooltipProps' was incorrectly exported in the first place.
Seems that there are more cases in the codebase the Properties types are exported - but honestly I don't see the usecase for it.
Unless you have a usecase to use it, I would rather not export it.

[KKoukiou]

This won't work either - CI fails with:

packages/react-table/src/components/Table/base/types.tsx:9:10 - error TS2305: Module '"../../../../../react-core/dist/js"' has no exported member 'TooltipProps'.

9 import { TooltipProps, PopoverProps } from '@patternfly/react-core';
           ~~~~~~~~~~~~

packages/react-table/src/components/Table/HeaderCellInfoWrapper.tsx:5:36 - error TS2305: Module '"../../../../react-core/dist/js"' has no exported member 'TooltipProps'.

5 import { Button, Tooltip, Popover, TooltipProps, PopoverProps } from '@patternfly/react-core';
                                    ~~~~~~~~~~~~

and much more errors since they expect in many places that that property is globally exported.

I am wondering if the correct approach is to remove it as you did and then import from direct file:

import { TooltipProps } from '@patternfly/react-core/src/components/Tooltip/Tooltip

in all internal usages of it.

Maybe we should just not export it as a type and put it bellow with the other exports. Maybe @redallen could give a better solution.

[gradybknight]

Sorry about the multiple failures. I think the first solution was probably the most benign one: my understanding is that exporting as type (e.g. export type {TooltipProps} from './ToolTip'). This way all the files which point to index still have access to the type but Babel can safely compile it away as needed.

[KKoukiou]

Sorry about the multiple failures. I think the first solution was probably the most benign one: my understanding is that exporting as type (e.g. export type {TooltipProps} from './ToolTip'). This way all the files which point to index still have access to the type but Babel can safely compile it away as needed.

Sure - sorry for misleading. Would you like to also update packages/react-core/src/components/Popover/index.ts ?
It suffers from the same problem.

[gradybknight]

Yep, will do. It's probably going to be at the end of the work day though (US time).

[redallen]

Hey @gradybknight,

I'm a little confused why you are using babel on @patternfly/react-core/src/components/Tooltip/index.ts. We provide transpiled JS in @patternfly/react-core/dist/esm/components/Tooltip/index.js or @patternfly/react-core/dist/js/components/Tooltip/index.js. This compiled JS does not include types as exports, but rather only export { Tooltip, TooltipPosition } from './Tooltip';.

You can easily support the "isolatedModules": true option if needbe in this PR by adding it to package/tsconfig.base.json and fixing the resulting errors from yarn build by separating type exports in index.ts files to export type { SomeType } from './Component';. There are only 3: Popover, Tooltip, and BaseLayout (in react-topology).

Thanks!

• Zack

[codecov-commenter]

Codecov Report

Merging #4854 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #4854   +/-   ##
=======================================
  Coverage   52.73%   52.73%           
=======================================
  Files         525      525           
  Lines        9473     9473           
  Branches     3486     3486           
=======================================
  Hits         4996     4996           
  Misses       3848     3848           
  Partials      629      629           

Flag	Coverage Δ
#patternfly4	52.73% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...ages/react-core/src/components/Popover/Popover.tsx	42.47% <ø> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 03d3fb9...0978be5. Read the comment docs.