Add 'option' generic types for resource definitions

marmelab · Apr 6, 2023 · 7610fd3 · 7610fd3
1 parent 6d04d1b
commit 7610fd3
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 9 deletions.
diff --git a/packages/ra-core/src/core/ResourceDefinitionContext.tsx b/packages/ra-core/src/core/ResourceDefinitionContext.tsx
@@ -2,10 +2,10 @@ import * as React from 'react';
 import { createContext, useCallback, useState, useMemo } from 'react';
 import isEqual from 'lodash/isEqual';
 
-import { ResourceDefinition } from '../types';
+import { ResourceDefinition, ResourceOptions } from '../types';
 
-export type ResourceDefinitions = {
-    [name: string]: ResourceDefinition;
+export type ResourceDefinitions<OptionsType extends ResourceOptions = any> = {
+    [name: string]: ResourceDefinition<OptionsType>;
 };
 
 export type ResourceDefinitionContextValue = {

diff --git a/packages/ra-core/src/core/useResourceDefinition.ts b/packages/ra-core/src/core/useResourceDefinition.ts
@@ -3,7 +3,7 @@ import defaults from 'lodash/defaults';
 
 import { useResourceDefinitions } from './useResourceDefinitions';
 import { useResourceContext } from './useResourceContext';
-import { ResourceDefinition } from '../types';
+import { ResourceDefinition, ResourceOptions } from '../types';
 
 /**
  * Hook to get the definition of a given resource
@@ -26,9 +26,11 @@ import { ResourceDefinition } from '../types';
  *
  * const definition = useResourceDefinition({ resource: 'posts' });
  */
-export const useResourceDefinition = (
+export const useResourceDefinition = <
+    OptionsType extends ResourceOptions = any
+>(
     props?: UseResourceDefinitionOptions
-): ResourceDefinition => {
+): ResourceDefinition<OptionsType> => {
     const resource = useResourceContext(props);
     const resourceDefinitions = useResourceDefinitions();
     const { hasCreate, hasEdit, hasList, hasShow, recordRepresentation } =

diff --git a/packages/ra-core/src/core/useResourceDefinitions.ts b/packages/ra-core/src/core/useResourceDefinitions.ts
@@ -19,5 +19,7 @@ import { useResourceDefinitionContext } from './useResourceDefinitionContext';
  * //   recordRepresentation: 'title',
  * // }
  */
-export const useResourceDefinitions = (): ResourceDefinitions =>
+export const useResourceDefinitions = <
+    OptionsType = any
+>(): ResourceDefinitions<OptionsType> =>
     useResourceDefinitionContext().definitions;
diff --git a/packages/ra-core/src/types.ts b/packages/ra-core/src/types.ts
@@ -275,9 +275,9 @@ export type LegacyDataProvider = (
 
 export type RecordToStringFunction = (record: any) => string;
 
-export interface ResourceDefinition {
+export interface ResourceDefinition<OptionsType extends ResourceOptions = any> {
     readonly name: string;
-    readonly options?: any;
+    readonly options?: OptionsType;
     readonly hasList?: boolean;
     readonly hasEdit?: boolean;
     readonly hasShow?: boolean;