fix: add and export all available interfaces for public methods (#1577)

Lukas742 · web-flow · commit 2c866c7e0fe9 · 2021-05-12T14:20:33.000+02:00
diff --git a/packages/charts/tsconfig.json b/packages/charts/tsconfig.json
@@ -1,6 +1,4 @@
 {
   "extends": "../../tsconfig.json",
-  "include": [
-    "src/index.ts"
-  ]
+  "include": ["src/index.ts", "src/interfaces"]
 }
diff --git a/packages/main/src/components/ActionSheet/index.tsx b/packages/main/src/components/ActionSheet/index.tsx
@@ -22,7 +22,7 @@ import React, {
 } from 'react';
 import { createPortal } from 'react-dom';
 import { createUseStyles } from 'react-jss';
-import { Ui5ResponsivePopoverDomRef } from '../../interfaces/Ui5ResponsivePopoverDomRef';
+import { Ui5ResponsivePopoverDomRef } from '@ui5/webcomponents-react/interfaces/Ui5ResponsivePopoverDomRef';
 import { ButtonPropTypes } from '../../webComponents/Button';
 import { ResponsivePopoverPropTypes } from '../../webComponents/ResponsivePopover';
 import styles from './ActionSheet.jss';
diff --git a/packages/main/src/components/AnalyticalCard/index.tsx b/packages/main/src/components/AnalyticalCard/index.tsx
@@ -2,7 +2,7 @@ import { createUseStyles } from 'react-jss';
 import { StyleClassHelper } from '@ui5/webcomponents-react-base/dist/StyleClassHelper';
 import { usePassThroughHtmlProps } from '@ui5/webcomponents-react-base/dist/usePassThroughHtmlProps';
 import React, { FC, forwardRef, ReactNode, ReactNodeArray, Ref } from 'react';
-import { CommonProps } from '../../interfaces/CommonProps';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
 
 import styles from './AnalyticalCard.jss';
 
diff --git a/packages/main/src/components/AnalyticalCardHeader/index.tsx b/packages/main/src/components/AnalyticalCardHeader/index.tsx
@@ -12,7 +12,7 @@ import { FlexBoxWrap } from '@ui5/webcomponents-react/dist/FlexBoxWrap';
 import { ObjectStatus } from '@ui5/webcomponents-react/dist/ObjectStatus';
 import { ValueState } from '@ui5/webcomponents-react/dist/ValueState';
 import React, { FC, forwardRef, Ref, useCallback, useMemo } from 'react';
-import { CommonProps } from '../../interfaces/CommonProps';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
 import styles from './AnalyticalCardHeader.jss';
 
 export interface AnalyticalCardHeaderPropTypes extends CommonProps {
diff --git a/packages/main/src/components/AnalyticalTable/ColumnHeader/ColumnHeaderModal.tsx b/packages/main/src/components/AnalyticalTable/ColumnHeader/ColumnHeaderModal.tsx
@@ -21,7 +21,7 @@ import { StandardListItem } from '@ui5/webcomponents-react/dist/StandardListItem
 import React, { RefObject, useCallback, useEffect, useRef } from 'react';
 import { createPortal } from 'react-dom';
 import { createUseStyles } from 'react-jss';
-import { Ui5PopoverDomRef } from '../../../interfaces/Ui5PopoverDomRef';
+import { Ui5PopoverDomRef } from '@ui5/webcomponents-react/interfaces/Ui5PopoverDomRef';
 import { stopPropagation } from '../../../internal/stopPropagation';
 import { ColumnType } from '../types/ColumnType';
 
diff --git a/packages/main/src/components/AnalyticalTable/hooks/useTableScrollHandles.ts b/packages/main/src/components/AnalyticalTable/hooks/useTableScrollHandles.ts
@@ -1,6 +1,6 @@
 import { useConsolidatedRef } from '@ui5/webcomponents-react-base/dist/useConsolidatedRef';
 import { RefObject, useEffect, useRef } from 'react';
-import { AnalyticalTableDomRef } from '../../../interfaces/AnalyticalTableDomRef';
+import { AnalyticalTableDomRef } from '@ui5/webcomponents-react/interfaces/AnalyticalTableDomRef';
 
 export const useTableScrollHandles = (ref) => {
   const analyticalTableRef: RefObject<AnalyticalTableDomRef> = useConsolidatedRef(ref);
diff --git a/packages/main/src/components/AnalyticalTable/index.tsx b/packages/main/src/components/AnalyticalTable/index.tsx
@@ -38,8 +38,8 @@ import {
   useTable,
   useGlobalFilter
 } from 'react-table';
-import { AnalyticalTableColumnDefinition } from '../../interfaces/AnalyticalTableColumnDefinition';
-import { CommonProps } from '../../interfaces/CommonProps';
+import { AnalyticalTableColumnDefinition } from '@ui5/webcomponents-react/interfaces/AnalyticalTableColumnDefinition';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
 import styles from './AnayticalTable.jss';
 import { ColumnHeaderContainer } from './ColumnHeader/ColumnHeaderContainer';
 import { DefaultColumn } from './defaults/Column';
diff --git a/packages/main/src/components/Breadcrumbs/index.tsx b/packages/main/src/components/Breadcrumbs/index.tsx
@@ -16,7 +16,7 @@ import React, {
   useReducer
 } from 'react';
 import { createUseStyles } from 'react-jss';
-import { CommonProps } from '../../interfaces/CommonProps';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
 
 const SeparatorStyles = {
   BackSlash: '\\',
diff --git a/packages/main/src/components/DynamicPageHeader/index.tsx b/packages/main/src/components/DynamicPageHeader/index.tsx
@@ -4,7 +4,7 @@ import { usePassThroughHtmlProps } from '@ui5/webcomponents-react-base/dist/useP
 import { FlexBox } from '@ui5/webcomponents-react/dist/FlexBox';
 import { FlexBoxAlignItems } from '@ui5/webcomponents-react/dist/FlexBoxAlignItems';
 import React, { FC, forwardRef, ReactNode, ReactNodeArray, Ref, useMemo } from 'react';
-import { CommonProps } from '../../interfaces/CommonProps';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
 import { DynamicPageHeaderStyles } from './DynamicPageHeader.jss';
 import { isIE } from '@ui5/webcomponents-react-base/dist/Device';
 
diff --git a/packages/main/src/components/DynamicPageTitle/index.tsx b/packages/main/src/components/DynamicPageTitle/index.tsx
@@ -10,7 +10,7 @@ import { ToolbarSeparator } from '@ui5/webcomponents-react/dist/ToolbarSeparator
 import { ToolbarSpacer } from '@ui5/webcomponents-react/dist/ToolbarSpacer';
 import { ToolbarStyle } from '@ui5/webcomponents-react/dist/ToolbarStyle';
 import React, { Children, FC, forwardRef, ReactElement, ReactNode, ReactNodeArray, Ref } from 'react';
-import { CommonProps } from '../../interfaces/CommonProps';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
 import { DynamicPageTitleStyles } from './DynamicPageTitle.jss';
 import { isIE } from '@ui5/webcomponents-react-base/dist/Device';
 
diff --git a/packages/main/src/components/FilterBar/FilterDialog.tsx b/packages/main/src/components/FilterBar/FilterDialog.tsx
@@ -29,7 +29,7 @@ import { Text } from '@ui5/webcomponents-react/dist/Text';
 import { Title } from '@ui5/webcomponents-react/dist/Title';
 import { TitleLevel } from '@ui5/webcomponents-react/dist/TitleLevel';
 import React, { Children, cloneElement, ReactElement, useCallback, useEffect, useMemo, useRef, useState } from 'react';
-import { Ui5DialogDomRef } from '../../interfaces/Ui5DialogDomRef';
+import { Ui5DialogDomRef } from '@ui5/webcomponents-react/interfaces/Ui5DialogDomRef';
 import { stopPropagation } from '../../internal/stopPropagation';
 import styles from './FilterBarDialog.jss';
 import { filterValue, renderSearchWithValue } from './utils';
diff --git a/packages/main/src/components/FilterGroupItem/index.tsx b/packages/main/src/components/FilterGroupItem/index.tsx
@@ -6,7 +6,7 @@ import { BusyIndicatorSize } from '@ui5/webcomponents-react/dist/BusyIndicatorSi
 import { FlexBox } from '@ui5/webcomponents-react/dist/FlexBox';
 import { Label } from '@ui5/webcomponents-react/dist/Label';
 import React, { FC, forwardRef, ReactElement, RefObject } from 'react';
-import { CommonProps } from '../../interfaces/CommonProps';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
 import styles from './FilterGroupItem.jss';
 
 const useStyles = createUseStyles(styles, { name: 'FilterGroupItem' });
diff --git a/packages/main/src/components/FlexBox/index.tsx b/packages/main/src/components/FlexBox/index.tsx
@@ -6,7 +6,7 @@ import { FlexBoxDirection } from '@ui5/webcomponents-react/dist/FlexBoxDirection
 import { FlexBoxJustifyContent } from '@ui5/webcomponents-react/dist/FlexBoxJustifyContent';
 import { FlexBoxWrap } from '@ui5/webcomponents-react/dist/FlexBoxWrap';
 import React, { FC, forwardRef, ReactNode, ReactNodeArray, Ref } from 'react';
-import { CommonProps } from '../../interfaces/CommonProps';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
 import { styles } from './FlexBox.jss';
 
 const useStyles = createUseStyles(styles, { name: 'FlexBox' });
diff --git a/packages/main/src/components/Form/index.tsx b/packages/main/src/components/Form/index.tsx
@@ -19,7 +19,7 @@ import React, {
   useRef,
   useState
 } from 'react';
-import { CommonProps } from '../../interfaces/CommonProps';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
 import { styles } from './Form.jss';
 
 export interface FormPropTypes extends CommonProps {
diff --git a/packages/main/src/components/Loader/index.tsx b/packages/main/src/components/Loader/index.tsx
@@ -5,7 +5,7 @@ import { usePassThroughHtmlProps } from '@ui5/webcomponents-react-base/dist/useP
 import { PLEASE_WAIT } from '@ui5/webcomponents-react/dist/assets/i18n/i18n-defaults';
 import { LoaderType } from '@ui5/webcomponents-react/dist/LoaderType';
 import React, { CSSProperties, FC, forwardRef, RefObject, useEffect, useMemo, useState } from 'react';
-import { CommonProps } from '../../interfaces/CommonProps';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
 import { styles } from './Loader.jss';
 
 export interface LoaderProps extends CommonProps {
diff --git a/packages/main/src/components/MessageBox/index.tsx b/packages/main/src/components/MessageBox/index.tsx
@@ -45,8 +45,8 @@ import React, {
   useMemo
 } from 'react';
 import { createUseStyles } from 'react-jss';
-import { CommonProps } from '../../interfaces/CommonProps';
-import { Ui5DialogDomRef } from '../../interfaces/Ui5DialogDomRef';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
+import { Ui5DialogDomRef } from '@ui5/webcomponents-react/interfaces/Ui5DialogDomRef';
 import { stopPropagation } from '../../internal/stopPropagation';
 import styles from './MessageBox.jss';
 
diff --git a/packages/main/src/components/ObjectPage/ObjectPageAnchorBar.tsx b/packages/main/src/components/ObjectPage/ObjectPageAnchorBar.tsx
@@ -12,7 +12,7 @@ import { TabContainer } from '@ui5/webcomponents-react/dist/TabContainer';
 import { ToggleButton } from '@ui5/webcomponents-react/dist/ToggleButton';
 import React, { CSSProperties, forwardRef, ReactElement, RefObject, useCallback, useRef, useState } from 'react';
 import { createUseStyles } from 'react-jss';
-import { Ui5PopoverDomRef } from '../../interfaces/Ui5PopoverDomRef';
+import { Ui5PopoverDomRef } from '@ui5/webcomponents-react/interfaces/Ui5PopoverDomRef';
 import { stopPropagation } from '../../internal/stopPropagation';
 import { StandardListItem } from '../../webComponents/StandardListItem';
 import { ObjectPageAnchorButton } from './ObjectPageAnchorButton';
diff --git a/packages/main/src/components/ObjectPageSection/index.tsx b/packages/main/src/components/ObjectPageSection/index.tsx
@@ -3,7 +3,7 @@ import { useConsolidatedRef } from '@ui5/webcomponents-react-base/dist/useConsol
 import { usePassThroughHtmlProps } from '@ui5/webcomponents-react-base/dist/usePassThroughHtmlProps';
 import React, { FC, forwardRef, ReactNode, ReactNodeArray, RefObject } from 'react';
 import { createUseStyles } from 'react-jss';
-import { CommonProps } from '../../interfaces/CommonProps';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
 import { EmptyIdPropException } from '../ObjectPage/EmptyIdPropException';
 import styles from './ObjectPageSection.jss';
 
diff --git a/packages/main/src/components/ObjectPageSubSection/index.tsx b/packages/main/src/components/ObjectPageSubSection/index.tsx
@@ -4,7 +4,7 @@ import { useConsolidatedRef } from '@ui5/webcomponents-react-base/dist/useConsol
 import { usePassThroughHtmlProps } from '@ui5/webcomponents-react-base/dist/usePassThroughHtmlProps';
 import React, { FC, forwardRef, ReactNode, ReactNodeArray, RefObject } from 'react';
 import { createUseStyles } from 'react-jss';
-import { CommonProps } from '../../interfaces/CommonProps';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
 import { EmptyIdPropException } from '../ObjectPage/EmptyIdPropException';
 
 export interface ObjectPageSubSectionPropTypes extends CommonProps {
diff --git a/packages/main/src/components/ObjectStatus/index.tsx b/packages/main/src/components/ObjectStatus/index.tsx
@@ -9,7 +9,7 @@ import { Icon } from '@ui5/webcomponents-react/dist/Icon';
 import { ValueState } from '@ui5/webcomponents-react/dist/ValueState';
 import React, { FC, forwardRef, ReactNode, Ref, useMemo } from 'react';
 import { createUseStyles } from 'react-jss';
-import { CommonProps } from '../../interfaces/CommonProps';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
 import styles from './ObjectStatus.jss';
 
 export interface ObjectStatusPropTypes extends CommonProps {
diff --git a/packages/main/src/components/Text/index.tsx b/packages/main/src/components/Text/index.tsx
@@ -2,7 +2,7 @@ import { createUseStyles } from 'react-jss';
 import { StyleClassHelper } from '@ui5/webcomponents-react-base/dist/StyleClassHelper';
 import { usePassThroughHtmlProps } from '@ui5/webcomponents-react-base/dist/usePassThroughHtmlProps';
 import React, { FC, forwardRef, ReactNode, Ref } from 'react';
-import { CommonProps } from '../../interfaces/CommonProps';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
 import { TextStyles } from './Text.jss';
 
 export interface TextProps extends CommonProps {
diff --git a/packages/main/src/components/Toolbar/OverflowPopover.tsx b/packages/main/src/components/Toolbar/OverflowPopover.tsx
@@ -5,7 +5,7 @@ import { Popover } from '@ui5/webcomponents-react/dist/Popover';
 import { ToggleButton } from '@ui5/webcomponents-react/dist/ToggleButton';
 import React, { FC, ReactElement, ReactNode, useCallback, useEffect, useRef, useState } from 'react';
 import { createPortal } from 'react-dom';
-import { Ui5PopoverDomRef } from '../../interfaces/Ui5PopoverDomRef';
+import { Ui5PopoverDomRef } from '@ui5/webcomponents-react/interfaces/Ui5PopoverDomRef';
 import { stopPropagation } from '../../internal/stopPropagation';
 
 interface OverflowPopoverProps {
diff --git a/packages/main/src/components/VariantManagement/index.tsx b/packages/main/src/components/VariantManagement/index.tsx
@@ -18,8 +18,8 @@ import { Title } from '@ui5/webcomponents-react/dist/Title';
 import { TitleLevel } from '@ui5/webcomponents-react/dist/TitleLevel';
 import React, { FC, forwardRef, Ref, useCallback, useEffect, useMemo, useRef, useState } from 'react';
 import { createPortal } from 'react-dom';
-import { CommonProps } from '../../interfaces/CommonProps';
-import { Ui5ResponsivePopoverDomRef } from '../../interfaces/Ui5ResponsivePopoverDomRef';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
+import { Ui5ResponsivePopoverDomRef } from '@ui5/webcomponents-react/interfaces/Ui5ResponsivePopoverDomRef';
 import { stopPropagation } from '../../internal/stopPropagation';
 
 export interface VariantItem {
diff --git a/packages/main/src/interfaces/Ui5DatePickerDomRef.ts b/packages/main/src/interfaces/Ui5DatePickerDomRef.ts
@@ -0,0 +1,13 @@
+import { Ui5PickerDomRef } from './Ui5PickerDomRef';
+
+export interface Ui5DatePickerDomRef extends Ui5PickerDomRef {
+  /**
+   * Checks if a date is between the minimum and maximum date.
+   * @param value - A value to be checked
+   */
+  isInValidRange?: (value?: string) => boolean;
+  /**
+   * Opens the picker.
+   */
+  openPicker?: () => void;
+}
diff --git a/packages/main/src/interfaces/Ui5InputDomRef.ts b/packages/main/src/interfaces/Ui5InputDomRef.ts
@@ -0,0 +1,8 @@
+import { Ui5DomRef } from './Ui5DomRef';
+
+export interface Ui5InputDomRef extends Ui5DomRef {
+  /**
+   * Checks if the picker is open
+   */
+  isOpen?: () => boolean;
+}
diff --git a/packages/main/src/interfaces/Ui5PickerDomRef.ts b/packages/main/src/interfaces/Ui5PickerDomRef.ts
@@ -0,0 +1,25 @@
+import { Ui5DomRef } from './Ui5DomRef';
+
+export interface Ui5PickerDomRef extends Ui5DomRef {
+  /**
+   * Closes the picker
+   */
+  closePicker?: () => void;
+  /**
+   * Formats a Java Script date object into a string representing a locale date and time
+   * according to the `formatPattern` property of the TimePicker instance
+   * @param date - A Java Script date object to be formatted as string
+   */
+  formatValue?: (date: Date) => string;
+  /**
+   * Checks if the picker is open
+   */
+  isOpen?: () => boolean;
+  /**
+   * Checks if a value is valid against the current `formatPattern` value.
+   *
+   * __Note:__ an empty string is considered as valid value.
+   * @param value - The value to be tested against the current date format
+   */
+  isValid?: (value: string) => boolean;
+}
diff --git a/packages/main/src/interfaces/Ui5PopoverDomRef.ts b/packages/main/src/interfaces/Ui5PopoverDomRef.ts
@@ -6,7 +6,7 @@ export interface Ui5PopoverDomRef extends Ui5DomRef {
    * @param opener - The element that the popover is opened by.
    * @param preventInitialFocus - Prevents applying the focus inside the popover.
    */
-  openBy: (opener: HTMLElement, preventInitialFocus?: boolean) => void;
+  openBy: (opener: HTMLElement | EventTarget, preventInitialFocus?: boolean) => void;
   /**
    * Closes the popover/dialog.
    */
diff --git a/packages/main/src/interfaces/Ui5ResponsivePopoverDomRef.ts b/packages/main/src/interfaces/Ui5ResponsivePopoverDomRef.ts
@@ -5,7 +5,7 @@ export interface Ui5ResponsivePopoverDomRef extends Ui5DomRef {
    * Opens popover on desktop and dialog on mobile.
    * @param opener - The element that the popover is opened by.
    */
-  open: (opener: HTMLElement) => void;
+  open: (opener: HTMLElement | EventTarget) => void;
   /**
    * Closes the popover/dialog.
    */
diff --git a/packages/main/src/interfaces/Ui5ShellBarDomRef.ts b/packages/main/src/interfaces/Ui5ShellBarDomRef.ts
@@ -0,0 +1,9 @@
+import { Ui5DomRef } from './Ui5DomRef';
+
+export interface Ui5ShellBarDomRef extends Ui5DomRef {
+  /**
+   * Closes the overflow area.
+   * Useful to manually close the overflow after having suppressed automatic closing with preventDefault() of ShellbarItem's press event
+   */
+  closeOverflow?: () => void;
+}
diff --git a/packages/main/src/interfaces/Ui5TreeDomRef.ts b/packages/main/src/interfaces/Ui5TreeDomRef.ts
@@ -0,0 +1,10 @@
+import { Ui5DomRef } from './Ui5DomRef';
+
+export interface Ui5TreeDomRef extends Ui5DomRef {
+  /**
+   * Perform Depth-First-Search walk on the tree and run a callback on each node
+   *
+   * @param callback - function to execute on each node of the tree with 2 arguments: the node and the level
+   */
+  walk?: (callback: (treeNode: HTMLElement, level: number) => void) => void;
+}
diff --git a/packages/main/src/internal/withWebComponent.tsx b/packages/main/src/internal/withWebComponent.tsx
@@ -12,8 +12,8 @@ import React, {
   useEffect,
   useRef
 } from 'react';
-import { CommonProps } from '../interfaces/CommonProps';
-import { Ui5DomRef } from '../interfaces/Ui5DomRef';
+import { CommonProps } from '@ui5/webcomponents-react/interfaces/CommonProps';
+import { Ui5DomRef } from '@ui5/webcomponents-react/interfaces/Ui5DomRef';
 
 const capitalizeFirstLetter = (s: string) => s.charAt(0).toUpperCase() + s.slice(1);
 
@@ -123,7 +123,7 @@ export const withWebComponent = <T extends Record<string, any>>(
       .reduce((acc, [key, val]) => ({ ...acc, [key]: val }), {});
 
     const tagNameSuffix: string = getEffectiveScopingSuffixForTag(tagName);
-    const Component = ((tagNameSuffix ? `${tagName}-${tagNameSuffix}` : tagName) as unknown) as ComponentType<
+    const Component = (tagNameSuffix ? `${tagName}-${tagNameSuffix}` : tagName) as unknown as ComponentType<
       WithWebComponentPropTypes & { class: string }
     >;
 
@@ -144,5 +144,5 @@ export const withWebComponent = <T extends Record<string, any>>(
 
   WithWebComponent.displayName = `WithWebComponent(${tagName})`;
 
-  return (WithWebComponent as unknown) as ForwardRefRenderFunction<Ui5DomRef, T & WithWebComponentPropTypes>;
+  return WithWebComponent as unknown as ForwardRefRenderFunction<Ui5DomRef, T & WithWebComponentPropTypes>;
 };
diff --git a/packages/main/tsconfig.json b/packages/main/tsconfig.json
@@ -1,6 +1,4 @@
 {
   "extends": "../../tsconfig.json",
-  "include": [
-    "src/index.ts"
-  ]
+  "include": ["src/index.ts", "src/interfaces", "src/enums"]
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,4 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": "../../tsconfig.json",`
`3`		`- "include": [`
`4`		`- "src/index.ts"`
`5`		`- ]`
	`3`	`+ "include": ["src/index.ts", "src/interfaces"]`
`6`	`4`	`}`