Merge pull request #5298 from marmelab/fix-types

More TS fixes

Author: fzaninotto

examples/demo/package.json

@@ -7,20 +7,20 @@
         "@material-ui/icons": "^4.9.1",
         "@types/inflection": "^1.5.28",
         "@types/recharts": "^1.8.10",
-        "data-generator-retail": "^3.0.0",
+        "data-generator-retail": "^3.9.0-beta.1",
         "fakerest": "~2.1.0",
         "fetch-mock": "~6.3.0",
         "json-graphql-server": "~2.1.3",
         "proxy-polyfill": "^0.3.0",
-        "ra-data-fakerest": "^3.0.0",
-        "ra-data-graphql-simple": "^3.0.0",
-        "ra-data-simple-rest": "^3.0.0",
-        "ra-i18n-polyglot": "^3.0.0",
-        "ra-input-rich-text": "^3.0.0",
-        "ra-language-english": "^3.0.0",
-        "ra-language-french": "^3.0.0",
+        "ra-data-fakerest": "^3.9.0-beta.1",
+        "ra-data-graphql-simple": "^3.9.0-beta.1",
+        "ra-data-simple-rest": "^3.9.0-beta.1",
+        "ra-i18n-polyglot": "^3.9.0-beta.1",
+        "ra-input-rich-text": "^3.9.0-beta.1",
+        "ra-language-english": "^3.9.0-beta.1",
+        "ra-language-french": "^3.9.0-beta.1",
         "react": "^16.9.0",
-        "react-admin": "^3.0.0",
+        "react-admin": "^3.9.0-beta.1",
         "react-app-polyfill": "^1.0.4",
         "react-dom": "^16.9.0",
         "react-redux": "^7.1.0",
@@ -54,4 +54,4 @@
         "source-map-explorer": "^2.0.0",
         "typescript": "^4.0.2"
     }
-}
+}

examples/simple/package.json

@@ -37,13 +37,13 @@
         "@babel/polyfill": "^7.10.4",
         "@material-ui/core": "^4.10.0",
         "@material-ui/icons": "^4.9.1",
-        "ra-data-fakerest": "^3.0.0",
-        "ra-i18n-polyglot": "^3.0.0",
-        "ra-input-rich-text": "^3.0.0",
-        "ra-language-english": "^3.0.0",
-        "ra-language-french": "^3.0.0",
+        "ra-data-fakerest": "^3.9.0-beta.1",
+        "ra-i18n-polyglot": "^3.9.0-beta.1",
+        "ra-input-rich-text": "^3.9.0-beta.1",
+        "ra-language-english": "^3.9.0-beta.1",
+        "ra-language-french": "^3.9.0-beta.1",
         "react": "^16.9.0",
-        "react-admin": "^3.0.0",
+        "react-admin": "^3.9.0-beta.1",
         "react-dom": "^16.9.0"
     }
 }

examples/tutorial/package.json

@@ -4,9 +4,9 @@
     "private": true,
     "dependencies": {
         "@material-ui/core": "^4.10.0",
-        "ra-data-json-server": "^3.0.0",
+        "ra-data-json-server": "^3.9.0-beta.1",
         "react": "^16.9.0",
-        "react-admin": "^3.0.0",
+        "react-admin": "^3.9.0-beta.1",
         "react-dom": "^16.9.0",
         "react-scripts": "^3.0.0"
     },
@@ -21,4 +21,4 @@
         "not ie <= 11",
         "not op_mini all"
     ]
-}
+}

packages/ra-core/src/controller/input/useReferenceArrayInputController.ts

@@ -216,15 +216,15 @@ interface ReferenceArrayInputProps {
 }
 
 interface Option {
-    basePath: string;
+    basePath?: string;
     filter?: any;
     filterToQuery?: (filter: any) => any;
     input: FieldInputProps<any, HTMLElement>;
     options?: any;
     perPage?: number;
     record?: Record;
     reference: string;
-    resource: string;
+    resource?: string;
     sort?: SortPayload;
     source: string;
 }

packages/ra-core/src/controller/useShowController.ts

@@ -15,7 +15,7 @@ export interface ShowProps {
     hasShow?: boolean;
     hasList?: boolean;
     id: Identifier;
-    resource: string;
+    resource?: string;
     [key: string]: any;
 }
 

packages/ra-core/src/dataProvider/index.ts

@@ -7,11 +7,11 @@ import Query from './Query';
 import cacheDataProviderProxy from './cacheDataProviderProxy';
 import undoableEventEmitter from './undoableEventEmitter';
 import useDataProvider from './useDataProvider';
-import useMutation from './useMutation';
-import useQuery from './useQuery';
-import useQueryWithStore from './useQueryWithStore';
+import useMutation, { UseMutationValue } from './useMutation';
+import useQuery, { UseQueryValue } from './useQuery';
+import useQueryWithStore, { QueryOptions } from './useQueryWithStore';
 import withDataProvider from './withDataProvider';
-import useGetOne from './useGetOne';
+import useGetOne, { UseGetOneHookValue } from './useGetOne';
 import useGetList from './useGetList';
 import useGetMany from './useGetMany';
 import useGetManyReference from './useGetManyReference';
@@ -24,6 +24,13 @@ import useDeleteMany from './useDeleteMany';
 import useRefreshWhenVisible from './useRefreshWhenVisible';
 import useIsAutomaticRefreshEnabled from './useIsAutomaticRefreshEnabled';
 
+export type {
+    QueryOptions,
+    UseMutationValue,
+    UseQueryValue,
+    UseGetOneHookValue,
+};
+
 export {
     cacheDataProviderProxy,
     convertLegacyDataProvider,

packages/ra-core/src/types.ts

@@ -387,12 +387,14 @@ export type LoginComponent = ComponentType<LoginComponentProps>;
 export type DashboardComponent = ComponentType<WithPermissionsChildrenParams>;
 
 export interface LayoutProps {
+    appBar?: ComponentType;
     dashboard?: DashboardComponent;
     logout?: ReactNode;
     menu?: ComponentType<{
         logout?: ReactNode;
         hasDashboard?: boolean;
     }>;
+    sideBar?: ComponentType;
     theme?: ThemeOptions;
     title?: TitleComponent;
 }

packages/ra-data-fakerest/package.json

@@ -44,6 +44,6 @@
         "rimraf": "^2.6.3"
     },
     "peerDependencies": {
-        "ra-core": "^3.0.0"
+        "ra-core": "^3.9.0-beta.1"
     }
 }

packages/ra-data-graphql-simple/package.json

@@ -40,7 +40,7 @@
     },
     "peerDependencies": {
         "graphql": "^14.1.1",
-        "ra-core": "^3.0.0"
+        "ra-core": "^3.9.0-beta.1"
     },
     "devDependencies": {
         "cross-env": "^5.2.0",

packages/ra-data-graphql/package.json

@@ -40,7 +40,7 @@
     },
     "peerDependencies": {
         "graphql": "^14.1.1",
-        "ra-core": "^3.0.0"
+        "ra-core": "^3.9.0-beta.1"
     },
     "devDependencies": {
         "cross-env": "^5.2.0",

packages/ra-data-simple-rest/package.json

@@ -32,6 +32,6 @@
         "rimraf": "^2.6.3"
     },
     "peerDependencies": {
-        "ra-core": "^3.0.0"
+        "ra-core": "^3.9.0-beta.1"
     }
 }

packages/ra-input-rich-text/package.json

@@ -40,8 +40,8 @@
         "watch": "tsc --outDir esm --module es2015 --watch"
     },
     "peerDependencies": {
-        "ra-core": "^3.0.0",
-        "ra-ui-materialui": "^4.3.3",
+        "ra-core": "^3.9.0-beta.1",
+        "ra-ui-materialui": "^3.9.0-beta.1",
         "react": "^16.9.0",
         "react-dom": "^16.9.0"
     },

packages/ra-ui-materialui/package.json

@@ -56,7 +56,7 @@
         "@material-ui/styles": "^4.3.3",
         "final-form": "^4.18.5",
         "final-form-arrays": "^3.0.1",
-        "ra-core": "^3.0.0",
+        "ra-core": "^3.9.0-beta.1",
         "react": "^16.9.0",
         "react-dom": "^16.9.0",
         "react-final-form": "^6.3.3",

packages/ra-ui-materialui/src/button/Button.tsx

@@ -13,6 +13,7 @@ import { ButtonProps as MuiButtonProps } from '@material-ui/core/Button';
 import { Theme } from '@material-ui/core';
 import classnames from 'classnames';
 import { Record, RedirectionSideEffect, useTranslate } from 'ra-core';
+import { LocationDescriptor } from 'history';
 
 /**
  * A generic Button with side icon. Only the icon is displayed on small screens.
@@ -133,7 +134,7 @@ interface Props {
     className?: string;
     color?: MuiPropTypes.Color;
     component?: ReactNode;
-    to?: string | { pathname: string; search: string };
+    to?: string | LocationDescriptor;
     disabled?: boolean;
     label?: string;
     size?: 'small' | 'medium' | 'large';

packages/ra-ui-materialui/src/button/DeleteWithConfirmButton.tsx

@@ -132,7 +132,7 @@ interface Props {
     undoable?: boolean;
 }
 
-type DeleteWithConfirmButtonProps = Props & ButtonProps;
+export type DeleteWithConfirmButtonProps = Props & ButtonProps;
 
 DeleteWithConfirmButton.propTypes = {
     basePath: PropTypes.string,

packages/ra-ui-materialui/src/button/index.ts

@@ -2,12 +2,16 @@ import BulkDeleteButton from './BulkDeleteButton';
 import BulkDeleteWithConfirmButton from './BulkDeleteWithConfirmButton';
 import BulkDeleteWithUndoButton from './BulkDeleteWithUndoButton';
 import BulkExportButton from './BulkExportButton';
-import Button from './Button';
+import Button, { ButtonProps } from './Button';
 import CloneButton from './CloneButton';
 import CreateButton from './CreateButton';
-import DeleteButton from './DeleteButton';
-import DeleteWithConfirmButton from './DeleteWithConfirmButton';
-import DeleteWithUndoButton from './DeleteWithUndoButton';
+import DeleteButton, { DeleteButtonProps } from './DeleteButton';
+import DeleteWithConfirmButton, {
+    DeleteWithConfirmButtonProps,
+} from './DeleteWithConfirmButton';
+import DeleteWithUndoButton, {
+    DeleteWithUndoButtonProps,
+} from './DeleteWithUndoButton';
 import EditButton from './EditButton';
 import ExportButton from './ExportButton';
 import ListButton from './ListButton';
@@ -17,6 +21,13 @@ import SortButton from './SortButton';
 import RefreshButton from './RefreshButton';
 import RefreshIconButton from './RefreshIconButton';
 
+export type {
+    ButtonProps,
+    DeleteButtonProps,
+    DeleteWithConfirmButtonProps,
+    DeleteWithUndoButtonProps,
+};
+
 export {
     BulkDeleteButton,
     BulkDeleteWithConfirmButton,

packages/ra-ui-materialui/src/detail/Show.js packages/ra-ui-materialui/src/detail/Show.tsx

@@ -4,10 +4,11 @@ import PropTypes from 'prop-types';
 import Card from '@material-ui/core/Card';
 import { makeStyles } from '@material-ui/core/styles';
 import classnames from 'classnames';
-import { useShowController } from 'ra-core';
+import { ShowControllerProps, useShowController } from 'ra-core';
 
 import DefaultActions from './ShowActions';
 import TitleForRecord from '../layout/TitleForRecord';
+import { ShowProps } from '../types';
 
 /**
  * Page component for the Show view
@@ -52,7 +53,9 @@ import TitleForRecord from '../layout/TitleForRecord';
  * );
  * export default App;
  */
-const Show = props => <ShowView {...props} {...useShowController(props)} />;
+const Show = (props: ShowProps) => (
+    <ShowView {...props} {...useShowController(props)} />
+);
 
 Show.propTypes = {
     actions: PropTypes.element,
@@ -69,7 +72,11 @@ Show.propTypes = {
     title: PropTypes.node,
 };
 
-export const ShowView = props => {
+interface ShowViewProps
+    extends ShowProps,
+        Omit<ShowControllerProps, 'resource'> {}
+
+export const ShowView = (props: ShowViewProps) => {
     const {
         actions,
         aside,
@@ -207,6 +214,6 @@ const sanitizeRestProps = ({
     permissions,
     translate,
     ...rest
-}) => rest;
+}: any) => rest;
 
 export default Show;

packages/ra-ui-materialui/src/detail/ShowActions.js packages/ra-ui-materialui/src/detail/ShowActions.tsx

@@ -1,5 +1,6 @@
 import * as React from 'react';
 import PropTypes from 'prop-types';
+import { Record } from 'ra-core';
 
 import { EditButton } from '../button';
 import TopToolbar from '../layout/TopToolbar';
@@ -12,7 +13,7 @@ const sanitizeRestProps = ({
     hasList,
     resource,
     ...rest
-}) => rest;
+}: any) => rest;
 
 /**
  * Action Toolbar for the Show view
@@ -39,12 +40,27 @@ const sanitizeRestProps = ({
  *         </Show>
  *     );
  */
-const ShowActions = ({ basePath, className, data, hasEdit, ...rest }) => (
+const ShowActions = ({
+    basePath,
+    className,
+    data,
+    hasEdit,
+    ...rest
+}: ShowActionsProps) => (
     <TopToolbar className={className} {...sanitizeRestProps(rest)}>
         {hasEdit && <EditButton basePath={basePath} record={data} />}
     </TopToolbar>
 );
 
+export interface ShowActionsProps {
+    basePath?: string;
+    className?: string;
+    data?: Record;
+    hasEdit?: boolean;
+    hasList?: boolean;
+    resource?: string;
+}
+
 ShowActions.propTypes = {
     basePath: PropTypes.string,
     className: PropTypes.string,