Merge pull request #8862 from marmelab/record-types

fzaninotto · web-flow · commit cdd3995f3b4f · 2023-05-11T18:12:00.000+02:00
Update RaRecord type &amp; fix some other types
diff --git a/examples/demo/src/dashboard/PendingReviews.tsx b/examples/demo/src/dashboard/PendingReviews.tsx
@@ -71,16 +71,20 @@ const PendingReviews = () => {
                                 reference="customers"
                                 link={false}
                             >
-                                <FunctionField
-                                    render={(customer: Customer) => (
-                                        <Avatar
-                                            src={`${customer.avatar}?size=32x32`}
-                                            sx={{
-                                                bgcolor: 'background.paper',
-                                            }}
-                                            alt={`${customer.first_name} ${customer.last_name}`}
-                                        />
-                                    )}
+                                <FunctionField<Customer>
+                                    render={customer =>
+                                        customer ? (
+                                            <Avatar
+                                                src={`${customer.avatar}?size=32x32`}
+                                                sx={{
+                                                    bgcolor: 'background.paper',
+                                                }}
+                                                alt={`${customer.first_name} ${customer.last_name}`}
+                                            />
+                                        ) : (
+                                            ''
+                                        )
+                                    }
                                 />
                             </ReferenceField>
                         </ListItemAvatar>
diff --git a/examples/demo/src/reviews/ReviewItem.tsx b/examples/demo/src/reviews/ReviewItem.tsx
@@ -16,10 +16,10 @@ import {
 } from 'react-admin';
 
 import AvatarField from '../visitors/AvatarField';
-import { Review, Customer } from './../types';
+import { Customer } from './../types';
 
 export const ReviewItem = () => {
-    const record = useRecordContext<Review>();
+    const record = useRecordContext();
     const createPath = useCreatePath();
     if (!record) {
         return null;
@@ -53,8 +53,8 @@ export const ReviewItem = () => {
                                 reference="customers"
                                 link={false}
                             >
-                                <FunctionField
-                                    render={(record?: Customer) =>
+                                <FunctionField<Customer>
+                                    render={record =>
                                         record
                                             ? `${record.first_name} ${record.last_name}`
                                             : ''
diff --git a/packages/ra-core/src/controller/record/useRecordContext.ts b/packages/ra-core/src/controller/record/useRecordContext.ts
@@ -1,5 +1,4 @@
 import { useContext } from 'react';
-import { RaRecord } from '../../types';
 import { RecordContext } from './RecordContext';
 
 /**
@@ -31,7 +30,7 @@ import { RecordContext } from './RecordContext';
  * @returns {RaRecord} A record object
  */
 export const useRecordContext = <
-    RecordType extends RaRecord | Omit<RaRecord, 'id'> = RaRecord
+    RecordType extends Record<string, unknown> = Record<string, any>
 >(
     props?: UseRecordContextParams<RecordType>
 ): RecordType | undefined => {
@@ -43,7 +42,7 @@ export const useRecordContext = <
 };
 
 export interface UseRecordContextParams<
-    RecordType extends RaRecord | Omit<RaRecord, 'id'> = RaRecord
+    RecordType extends Record<string, unknown> = Record<string, unknown>
 > {
     record?: RecordType;
     [key: string]: any;
diff --git a/packages/ra-core/src/dataProvider/useGetMany.ts b/packages/ra-core/src/dataProvider/useGetMany.ts
@@ -113,5 +113,5 @@ export const useGetMany = <RecordType extends RaRecord = any>(
 };
 
 export type UseGetManyHookValue<
-    RecordType extends RaRecord = any
+    RecordType extends RaRecord = RaRecord
 > = UseQueryResult<RecordType[], Error>;
diff --git a/packages/ra-core/src/dataProvider/useGetRecordId.ts b/packages/ra-core/src/dataProvider/useGetRecordId.ts
@@ -1,6 +1,6 @@
 import { useParams } from 'react-router-dom';
 import { useRecordContext } from '../controller';
-import { Identifier } from '../types';
+import { Identifier, RaRecord } from '../types';
 
 /**
  * Helper hook to get the current `recordId`.
@@ -15,7 +15,7 @@ import { Identifier } from '../types';
  * const recordId = useGetRecordId();
  */
 export function useGetRecordId(recordId?: Identifier): Identifier {
-    const contextRecord = useRecordContext();
+    const contextRecord = useRecordContext<RaRecord>();
     const { id: routeId } = useParams<'id'>();
     const actualRecordId = recordId ?? contextRecord?.id ?? routeId;
     if (actualRecordId == null)
diff --git a/packages/ra-core/src/routing/types.ts b/packages/ra-core/src/routing/types.ts
@@ -1,8 +1,11 @@
 import { RaRecord } from '../types';
 
-export type LinkToFunctionType = (
-    record: RaRecord,
+export type LinkToFunctionType<RecordType extends RaRecord = RaRecord> = (
+    record: RecordType,
     reference: string
 ) => string;
 
-export type LinkToType = string | false | LinkToFunctionType;
+export type LinkToType<RecordType extends RaRecord = RaRecord> =
+    | string
+    | false
+    | LinkToFunctionType<RecordType>;
diff --git a/packages/ra-core/src/types.ts b/packages/ra-core/src/types.ts
@@ -9,9 +9,9 @@ import { AuthActionType } from './auth/types';
 
 export type Identifier = string | number;
 
-export interface RaRecord {
-    id: Identifier;
-    [key: string]: any;
+export interface RaRecord<IdentifierType extends Identifier = Identifier>
+    extends Record<string, any> {
+    id: IdentifierType;
 }
 
 export interface SortPayload {
@@ -93,7 +93,7 @@ export type DataProvider<ResourceType extends string = string> = {
 
     getOne: <RecordType extends RaRecord = any>(
         resource: ResourceType,
-        params: GetOneParams
+        params: GetOneParams<RecordType>
     ) => Promise<GetOneResult<RecordType>>;
 
     getMany: <RecordType extends RaRecord = any>(
diff --git a/packages/ra-ui-materialui/src/field/FunctionField.tsx b/packages/ra-ui-materialui/src/field/FunctionField.tsx
@@ -18,7 +18,9 @@ import { PublicFieldProps, InjectedFieldProps, fieldPropTypes } from './types';
  * />
  */
 
-export const FunctionField = <RecordType extends unknown = any>(
+export const FunctionField = <
+    RecordType extends Record<string, unknown> = Record<string, any>
+>(
     props: FunctionFieldProps<RecordType>
 ) => {
     const { className, source = '', render, ...rest } = props;
@@ -46,8 +48,9 @@ FunctionField.propTypes = {
     render: PropTypes.func.isRequired,
 };
 
-export interface FunctionFieldProps<RecordType extends unknown = any>
-    extends PublicFieldProps,
+export interface FunctionFieldProps<
+    RecordType extends Record<string, unknown> = Record<string, any>
+> extends PublicFieldProps,
         InjectedFieldProps<RecordType>,
         Omit<TypographyProps, 'textAlign'> {
     render: (record?: RecordType, source?: string) => any;
diff --git a/packages/ra-ui-materialui/src/field/ReferenceField.tsx b/packages/ra-ui-materialui/src/field/ReferenceField.tsx
@@ -112,7 +112,7 @@ export interface ReferenceFieldProps<RecordType extends RaRecord = any>
     resource?: string;
     source: string;
     translateChoice?: Function | boolean;
-    link?: LinkToType;
+    link?: LinkToType<RecordType>;
     sx?: SxProps;
 }
 
diff --git a/packages/ra-ui-materialui/src/field/ReferenceOneField.tsx b/packages/ra-ui-materialui/src/field/ReferenceOneField.tsx
@@ -103,7 +103,7 @@ export interface ReferenceOneFieldProps<RecordType extends RaRecord = any>
     target: string;
     sort?: SortPayload;
     filter?: any;
-    link?: LinkToType;
+    link?: LinkToType<RecordType>;
     queryOptions?: UseQueryOptions<{
         data: RecordType[];
         total: number;

Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ export interface ReferenceFieldProps<RecordType extends RaRecord = any>`
`112`	`112`	`resource?: string;`
`113`	`113`	`source: string;`
`114`	`114`	`translateChoice?: Function \| boolean;`
`115`		`- link?: LinkToType;`
	`115`	`+ link?: LinkToType<RecordType>;`
`116`	`116`	`sx?: SxProps;`
`117`	`117`	`}`
`118`	`118`