Merge pull request #105 from Kitware/export-types

floryst · web-flow · commit 0cc38787e67e · 2023-03-15T10:08:20.000-04:00
feat(types): export types
diff --git a/package.json b/package.json
@@ -8,6 +8,7 @@
   "type": "module",
   "main": "dist/umd/react-vtk.js",
   "module": "dist/esm/index.js",
+  "types": "dist/esm/src/index.d.ts",
   "source": "src/index.ts",
   "dependencies": {
     "@babel/eslint-parser": "^7.19.1",
diff --git a/src/core/Algorithm.tsx b/src/core/Algorithm.tsx
@@ -12,7 +12,7 @@ import {
   useRepresentation,
 } from './contexts';
 
-interface Props extends PropsWithChildren {
+export interface AlgorithmProps extends PropsWithChildren {
   /**
    * Can either be a string containing the name of the vtkClass or a vtk object constructor.
    *
@@ -29,7 +29,7 @@ interface Props extends PropsWithChildren {
   port?: number;
 }
 
-export default function Algorithm(props: Props) {
+export default function Algorithm(props: AlgorithmProps) {
   const prev = usePrevious(props);
   const { vtkClass, state, port = 0 } = props;
 
diff --git a/src/core/DataArray.ts b/src/core/DataArray.ts
@@ -10,7 +10,7 @@ import { usePrevious } from '../utils/usePrevious';
 import useUnmount from '../utils/useUnmount';
 import { useDataset, useFieldData } from './contexts';
 
-interface Props {
+export interface DataArrayProps {
   /**
    * The ID used to identify this component.
    */
@@ -49,7 +49,7 @@ const DefaultProps = {
   numberOfComponents: 1,
 };
 
-export default function DataArray(props: Props) {
+export default function DataArray(props: DataArrayProps) {
   const prev = usePrevious({ ...DefaultProps, ...props });
 
   const [daRef, getDataArray] = useGetterRef(() => {
diff --git a/src/core/Geometry2DRepresentation.tsx b/src/core/Geometry2DRepresentation.tsx
@@ -30,7 +30,7 @@ import useCoordinate from './modules/useCoordinate';
 import useMapper from './modules/useMapper';
 import useProp from './modules/useProp';
 
-interface Props extends PropsWithChildren {
+export interface Geometry2DRepresentationProps extends PropsWithChildren {
   /**
    * The ID used to identify this component.
    */
@@ -76,7 +76,7 @@ const DefaultProps = {
 };
 
 export default forwardRef(function Geometry2DRepresentation(
-  props: Props,
+  props: Geometry2DRepresentationProps,
   fwdRef
 ) {
   const [modifiedRef, trackModified, resetModified] = useBooleanAccumulator();
diff --git a/src/core/GeometryRepresentation.tsx b/src/core/GeometryRepresentation.tsx
@@ -27,7 +27,7 @@ import useColorTransferFunction from './modules/useColorTransferFunction';
 import useMapper from './modules/useMapper';
 import useProp from './modules/useProp';
 
-interface Props extends PropsWithChildren {
+export interface GeometryRepresentationProps extends PropsWithChildren {
   /**
    * The ID used to identify this component.
    */
@@ -96,7 +96,7 @@ const DefaultProps = {
 };
 
 export default forwardRef(function GeometryRepresentation(
-  props: Props,
+  props: GeometryRepresentationProps,
   fwdRef
 ) {
   const [modifiedRef, trackModified, resetModified] = useBooleanAccumulator();
diff --git a/src/core/ImageData.tsx b/src/core/ImageData.tsx
@@ -13,7 +13,7 @@ import useGetterRef from '../utils/useGetterRef';
 import useUnmount from '../utils/useUnmount';
 import { DatasetContext, useDownstream, useRepresentation } from './contexts';
 
-interface Props extends PropsWithChildren {
+export interface ImageDataProps extends PropsWithChildren {
   /**
    * downstream connection port
    */
@@ -48,7 +48,7 @@ const DefaultProps = {
   direction: [1, 0, 0, 0, 1, 0, 0, 0, 1] as Matrix3x3,
 };
 
-export default forwardRef(function PolyData(props: Props, fwdRef) {
+export default forwardRef(function PolyData(props: ImageDataProps, fwdRef) {
   const {
     port = DefaultProps.port,
     dimensions = DefaultProps.dimensions,
diff --git a/src/core/MultiViewRoot.tsx b/src/core/MultiViewRoot.tsx
@@ -13,17 +13,19 @@ import {
 } from '../utils/ResizeWatcher';
 import { MultiViewRootContext } from './contexts';
 import OpenGLRenderWindow, {
-  Props as OpenGLRenderWindowProps,
+  OpenGLRenderWindowProps,
 } from './OpenGLRenderWindow';
 import RenderWindow from './RenderWindow';
 
-interface Props extends PropsWithChildren, OpenGLRenderWindowProps {}
+export interface MultiViewRootProps
+  extends PropsWithChildren,
+    OpenGLRenderWindowProps {}
 
 const RW_STYLE: CSSProperties = {
   pointerEvents: 'none',
 };
 
-export default function MultiViewRoot(props: Props) {
+export default function MultiViewRoot(props: MultiViewRootProps) {
   const openGLRenderWindowRef = useRef<IOpenGLRenderWindow | null>(null);
   const renderWindowRef = useRef<IRenderWindow | null>(null);
   const resizeWatcherRef = useRef<IResizeWatcher>(new ResizeWatcher());
diff --git a/src/core/OpenGLRenderWindow.tsx b/src/core/OpenGLRenderWindow.tsx
@@ -22,11 +22,16 @@ const RENDERWINDOW_STYLE: CSSProperties = {
   overflow: 'hidden',
 };
 
-export interface Props extends PropsWithChildren, HTMLProps<HTMLDivElement> {
+export interface OpenGLRenderWindowProps
+  extends PropsWithChildren,
+    HTMLProps<HTMLDivElement> {
   renderWindowStyle?: CSSProperties;
 }
 
-export default forwardRef(function OpenGLRenderWindow(props: Props, fwdRef) {
+export default forwardRef(function OpenGLRenderWindow(
+  props: OpenGLRenderWindowProps,
+  fwdRef
+) {
   const rwContainerRef = useRef<HTMLDivElement | null>(null);
 
   const [viewRef, getRWView] = useGetterRef(() => {
diff --git a/src/core/Picking.ts b/src/core/Picking.ts
@@ -52,7 +52,7 @@ function useOpenGLHardwareSelector() {
   return getSelector;
 }
 
-interface Props {
+export interface PickingProps {
   /**
    * Whether to enable picking and callbacks.
    *
@@ -112,7 +112,7 @@ const DefaultProps = {
   onHoverDebounceWait: 4,
 };
 
-export default forwardRef(function ViewPicking(props: Props, fwdRef) {
+export default forwardRef(function ViewPicking(props: PickingProps, fwdRef) {
   const openGLRenderWindowAPI = useContext(OpenGLRenderWindowContext);
   const rendererAPI = useContext(RendererContext);
   const viewAPI = useContext(ViewContext);
diff --git a/src/core/PolyData.tsx b/src/core/PolyData.tsx
@@ -19,7 +19,7 @@ import { usePrevious } from '../utils/usePrevious';
 import useUnmount from '../utils/useUnmount';
 import { DatasetContext, useDownstream, useRepresentation } from './contexts';
 
-interface Props extends PropsWithChildren {
+export interface PolyDataProps extends PropsWithChildren {
   /**
    * downstream connection port
    */
@@ -86,7 +86,7 @@ const DefaultProps = {
   connectivity: 'manual',
 };
 
-export default forwardRef(function PolyData(props: Props, fwdRef) {
+export default forwardRef(function PolyData(props: PolyDataProps, fwdRef) {
   const {
     port = DefaultProps.port,
     points = DefaultProps.points,
diff --git a/src/core/RenderWindow.tsx b/src/core/RenderWindow.tsx
@@ -18,9 +18,12 @@ import useUnmount from '../utils/useUnmount';
 import { OpenGLRenderWindowContext, RenderWindowContext } from './contexts';
 import useInteractor from './modules/useInteractor';
 
-export type Props = PropsWithChildren;
+export type RenderWindowProps = PropsWithChildren;
 
-export default forwardRef(function RenderWindow(props: Props, fwdRef) {
+export default forwardRef(function RenderWindow(
+  props: RenderWindowProps,
+  fwdRef
+) {
   const openGLRenderWindow = useContext(OpenGLRenderWindowContext);
   if (!openGLRenderWindow) throw new Error('No OpenGL Render Window!');
 
diff --git a/src/core/Renderer.tsx b/src/core/Renderer.tsx
@@ -17,7 +17,7 @@ import useUnmount from '../utils/useUnmount';
 import { RendererContext, useRenderWindowContext } from './contexts';
 import useCamera from './modules/useCamera';
 
-export interface Props extends PropsWithChildren {
+export interface RendererProps extends PropsWithChildren {
   /**
    * The color of the view background using 3 floating numbers
    * between 0-1 of Red, Green, Blue component.
@@ -54,7 +54,7 @@ export const DefaultProps = {
   autoResetCamera: true,
 };
 
-export default forwardRef(function Renderer(props: Props, fwdRef) {
+export default forwardRef(function Renderer(props: RendererProps, fwdRef) {
   const renderWindow = useRenderWindowContext();
   const [modifiedRef, trackModified, resetModified] = useBooleanAccumulator();
 
diff --git a/src/core/ShareDataSet.tsx b/src/core/ShareDataSet.tsx
@@ -132,7 +132,7 @@ export function ShareDataSetRoot(props: PropsWithChildren) {
   );
 }
 
-interface RegisterDataSetProps extends PropsWithChildren {
+export interface RegisterDataSetProps extends PropsWithChildren {
   id: string;
 }
 
@@ -190,7 +190,7 @@ export function RegisterDataSet(props: RegisterDataSetProps) {
   );
 }
 
-interface UseDataSetProps extends PropsWithChildren {
+export interface UseDataSetProps extends PropsWithChildren {
   id: string;
   port?: number;
 }
diff --git a/src/core/SliceRepresentation.tsx b/src/core/SliceRepresentation.tsx
@@ -27,7 +27,7 @@ import useColorTransferFunction from './modules/useColorTransferFunction';
 import useMapper from './modules/useMapper';
 import useProp from './modules/useProp';
 
-interface Props extends PropsWithChildren {
+export interface SliceRepresentationProps extends PropsWithChildren {
   /**
    * The ID used to identify this component.
    */
@@ -94,7 +94,10 @@ const DefaultProps = {
   colorDataRange: 'auto' as const,
 };
 
-export default forwardRef(function SliceRepresentation(props: Props, fwdRef) {
+export default forwardRef(function SliceRepresentation(
+  props: SliceRepresentationProps,
+  fwdRef
+) {
   const [modifiedRef, trackModified, resetModified] = useBooleanAccumulator();
   const [dataAvailable, setDataAvailable] = useState(false);
 
diff --git a/src/core/View.tsx b/src/core/View.tsx
@@ -10,9 +10,10 @@ import { IView } from '../types';
 import { MultiViewRootContext } from './contexts';
 import ParentedView from './internal/ParentedView';
 import SingleView from './internal/SingleView';
-import { Props } from './internal/view-shared';
+import { ViewProps } from './internal/view-shared';
+export type { ViewProps } from './internal/view-shared';
 
-export default forwardRef(function View(props: Props, fwdRef) {
+export default forwardRef(function View(props: ViewProps, fwdRef) {
   const singleViewRef = useRef<IView | null>(null);
   const parentedViewRef = useRef<IView | null>(null);
 
diff --git a/src/core/internal/ParentedView.tsx b/src/core/internal/ParentedView.tsx
@@ -26,12 +26,15 @@ import {
   useInteractorStyleManipulatorSettings,
 } from '../modules/useInteractorStyle';
 import Renderer from '../Renderer';
-import { DefaultProps, Props } from './view-shared';
+import { DefaultProps, ViewProps } from './view-shared';
 
 /**
  * A View that is within a MultiViewRoot.
  */
-const ParentedView = forwardRef(function ParentedView(props: Props, fwdRef) {
+const ParentedView = forwardRef(function ParentedView(
+  props: ViewProps,
+  fwdRef
+) {
   const containerRef = useRef<HTMLDivElement | null>(null);
   const rendererRef = useRef<IRenderer | null>(null);
 
diff --git a/src/core/internal/SingleView.tsx b/src/core/internal/SingleView.tsx
@@ -23,12 +23,12 @@ import {
 import OpenGLRenderWindow from '../OpenGLRenderWindow';
 import Renderer from '../Renderer';
 import RenderWindow from '../RenderWindow';
-import { DefaultProps, Props } from './view-shared';
+import { DefaultProps, ViewProps } from './view-shared';
 
 /**
  * A standalone View (not within a MultiViewRoot).
  */
-const SingleView = forwardRef(function SingleView(props: Props, fwdRef) {
+const SingleView = forwardRef(function SingleView(props: ViewProps, fwdRef) {
   // view API just exposes the render window + renderer
   const openGLRenderWindowRef = useRef<IOpenGLRenderWindow | null>(null);
   const renderWindowRef = useRef<IRenderWindow | null>(null);
@@ -44,7 +44,7 @@ const SingleView = forwardRef(function SingleView(props: Props, fwdRef) {
 
   const openGLRenderWindowProps = omit(
     props,
-    ...([...Object.keys(rendererProps)] as (keyof Props)[])
+    ...([...Object.keys(rendererProps)] as (keyof ViewProps)[])
   );
 
   // --- interactor style --- //
diff --git a/src/core/internal/view-shared.ts b/src/core/internal/view-shared.ts
@@ -1,10 +1,10 @@
 import { PropsWithChildren } from 'react';
 import { ManipulatorSettings } from '../modules/useInteractorStyle';
-import { Props as OpenGLRenderWindowProps } from '../OpenGLRenderWindow';
-import { Props as RendererProps } from '../Renderer';
-import { Props as RenderWindowProps } from '../RenderWindow';
+import { OpenGLRenderWindowProps } from '../OpenGLRenderWindow';
+import { RendererProps } from '../Renderer';
+import { RenderWindowProps } from '../RenderWindow';
 
-export interface Props
+export interface ViewProps
   extends PropsWithChildren,
     OpenGLRenderWindowProps,
     RenderWindowProps,
diff --git a/src/index.ts b/src/index.ts
@@ -4,26 +4,41 @@ import '@kitware/vtk.js/Rendering/OpenGL/Profiles/Glyph';
 import '@kitware/vtk.js/Rendering/OpenGL/Profiles/Volume';
 
 export { default as Algorithm } from './core/Algorithm';
+export type { AlgorithmProps } from './core/Algorithm';
+export { default as CellData } from './core/CellData';
 export * as Contexts from './core/contexts';
 export { default as DataArray } from './core/DataArray';
+export type { DataArrayProps } from './core/DataArray';
+export { default as FieldData } from './core/FieldData';
 export { default as Geometry2DRepresentation } from './core/Geometry2DRepresentation';
+export type { Geometry2DRepresentationProps } from './core/Geometry2DRepresentation';
 export { default as GeometryRepresentation } from './core/GeometryRepresentation';
+export type { GeometryRepresentationProps } from './core/GeometryRepresentation';
 export { default as ImageData } from './core/ImageData';
+export type { ImageDataProps } from './core/ImageData';
 export { default as MultiViewRoot } from './core/MultiViewRoot';
-export * from './core/Picking';
+export type { MultiViewRootProps } from './core/MultiViewRoot';
 export { default as Picking } from './core/Picking';
+export type {
+  FrustumPickResult,
+  PickingProps,
+  PickResult,
+} from './core/Picking';
 export { default as PointData } from './core/PointData';
 export { default as PolyData } from './core/PolyData';
+export type { PolyDataProps } from './core/PolyData';
 export { default as Reader } from './core/Reader';
+export type { ReaderProps } from './core/Reader';
 export {
   RegisterDataSet,
   ShareDataSetRoot,
   UseDataSet,
 } from './core/ShareDataSet';
+export type {
+  RegisterDataSetProps,
+  UseDataSetProps,
+} from './core/ShareDataSet';
 export { default as SliceRepresentation } from './core/SliceRepresentation';
+export type { SliceRepresentationProps } from './core/SliceRepresentation';
 export { default as View } from './core/View';
-
-// TODO should we expose these?
-// export { default as OpenGLRenderWindow } from './core/OpenGLRenderWindow';
-// export { default as Renderer } from './core/Renderer';
-// export { default as RenderWindow } from './core/RenderWindow';
+export type { ViewProps } from './core/View';

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ import {`
`12`	`12`	`useRepresentation,`
`13`	`13`	`} from './contexts';`
`14`	`14`
`15`		`-interface Props extends PropsWithChildren {`
	`15`	`+export interface AlgorithmProps extends PropsWithChildren {`
`16`	`16`	`/**`
`17`	`17`	`* Can either be a string containing the name of the vtkClass or a vtk object constructor.`
`18`	`18`	`*`
`@@ -29,7 +29,7 @@ interface Props extends PropsWithChildren {`
`29`	`29`	`port?: number;`
`30`	`30`	`}`
`31`	`31`
`32`		`-export default function Algorithm(props: Props) {`
	`32`	`+export default function Algorithm(props: AlgorithmProps) {`
`33`	`33`	`const prev = usePrevious(props);`
`34`	`34`	`const { vtkClass, state, port = 0 } = props;`
`35`	`35`