feat: makes display function returns a generic and makes it more lax …

…by defaulting it to string|null feat: makes react-hook-form adapter return more lax by allowing it to return JSX.Element | null
blb-ventures · May 12, 2023 · 31280b3 · 31280b3
1 parent c62445b
commit 31280b3
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 17 deletions.
diff --git a/src/adapters/react-hook-form/react-hook-form-item.tsx b/src/adapters/react-hook-form/react-hook-form-item.tsx
@@ -10,6 +10,7 @@ export interface ReactHookFormItemProps<
   Resources extends APIResources,
   FieldKinds extends PropertyKey,
   FieldObjectKinds extends PropertyKey,
+  FormResult extends JSX.Element | null = JSX.Element | null,
   FormType extends FieldValues = FieldValues,
 > {
   name?: string;
@@ -18,13 +19,14 @@ export interface ReactHookFormItemProps<
   componentProps?: Record<string, unknown>;
   formItemProps?: Partial<ControllerProps>;
   FormControlWrapper?: FC<FormControlWrapperProps>;
-  manager: ResourceManager<Resources, FieldKinds, FieldObjectKinds, JSX.Element, any, any>;
+  manager: ResourceManager<Resources, FieldKinds, FieldObjectKinds, FormResult, any, any>;
 }
 
 export const ReactHookFormItem = <
   Resources extends APIResources,
   FieldKinds extends PropertyKey,
   FieldObjectKinds extends PropertyKey,
+  FormResult extends JSX.Element | null = JSX.Element | null,
   FormType extends FieldValues = FieldValues,
 >({
   control,
@@ -34,7 +36,7 @@ export const ReactHookFormItem = <
   FormControlWrapper,
   name,
   manager,
-}: ReactHookFormItemProps<Resources, FieldKinds, FieldObjectKinds, FormType>) => {
+}: ReactHookFormItemProps<Resources, FieldKinds, FieldObjectKinds, FormResult, FormType>) => {
   const defaultValue = useMemo(() => (isAPIField(field) ? field.defaultValue : undefined), [field]);
   return (
     <Controller

diff --git a/src/adapters/react/react-field.tsx b/src/adapters/react/react-field.tsx
@@ -6,21 +6,23 @@ export interface ReactFieldProps<
   Resources extends APIResources,
   FieldKinds extends PropertyKey,
   FieldObjectKinds extends PropertyKey,
+  FormResult = JSX.Element | null,
 > {
   field: APIFieldUnion;
-  manager: ResourceManager<Resources, FieldKinds, FieldObjectKinds, JSX.Element, any, any>;
+  manager: ResourceManager<Resources, FieldKinds, FieldObjectKinds, FormResult, any, any>;
   componentProps?: any;
 }
 
 export const ReactField = <
   Resources extends APIResources,
   FieldKinds extends PropertyKey,
   FieldObjectKinds extends PropertyKey,
+  FormResult = JSX.Element | null,
 >({
   field,
   componentProps,
   manager,
-}: ReactFieldProps<Resources, FieldKinds, FieldObjectKinds>) => {
+}: ReactFieldProps<Resources, FieldKinds, FieldObjectKinds, FormResult>) => {
   const formField = useMemo(
     () => manager.getFieldFormField(field, componentProps),
     [field, manager],

diff --git a/src/resource.ts b/src/resource.ts
@@ -6,8 +6,13 @@ import {
   FieldValidation,
 } from './resource.interface';
 
-export interface KindManager<Kind extends APIFieldUnion, FormResult, ValidationResult> {
-  display(field: Kind, value: any): string;
+export interface KindManager<
+  Kind extends APIFieldUnion,
+  FormResult,
+  ValidationResult,
+  DisplayResult = string | null,
+> {
+  display(field: Kind, value: any): DisplayResult;
   validation(field: Kind, validation?: FieldValidation): ValidationResult;
   formField(field: Kind, props?: any): FormResult;
 }
@@ -18,14 +23,23 @@ export interface ManagerOptions<
   FormResult,
   ValidationResult,
   ValidationSchema,
+  DisplayResult = string | null,
 > {
-  fieldManagerByKind: Record<FieldKinds, KindManager<APIField, FormResult, ValidationResult>>;
+  fieldManagerByKind: Record<
+    FieldKinds,
+    KindManager<APIField, FormResult, ValidationResult, DisplayResult>
+  >;
   fieldObjectManagerByKind: Record<
     FieldObjectKinds,
-    KindManager<APIFieldObject, FormResult, ValidationResult>
+    KindManager<APIFieldObject, FormResult, ValidationResult, DisplayResult>
+  >;
+  defaultFieldManager: KindManager<APIField, FormResult, ValidationResult, DisplayResult>;
+  defaultFieldObjectManager: KindManager<
+    APIFieldObject,
+    FormResult,
+    ValidationResult,
+    DisplayResult
   >;
-  defaultFieldManager: KindManager<APIField, FormResult, ValidationResult>;
-  defaultFieldObjectManager: KindManager<APIFieldObject, FormResult, ValidationResult>;
   validationSchemaBuilder: (
     fieldValidationTuple: [APIField, ValidationResult][],
   ) => ValidationSchema;
@@ -38,15 +52,24 @@ export class ResourceManager<
   FormResult,
   ValidationResult,
   ValidationSchema,
+  DisplayResult = string | null,
 > {
   resources: Resources;
-  fieldManagerByKind: Record<FieldKinds, KindManager<APIField, FormResult, ValidationResult>>;
+  fieldManagerByKind: Record<
+    FieldKinds,
+    KindManager<APIField, FormResult, ValidationResult, DisplayResult>
+  >;
   fieldObjectManagerByKind: Record<
     FieldObjectKinds,
-    KindManager<APIFieldObject, FormResult, ValidationResult>
+    KindManager<APIFieldObject, FormResult, ValidationResult, DisplayResult>
+  >;
+  defaultFieldManager: KindManager<APIField, FormResult, ValidationResult, DisplayResult>;
+  defaultFieldObjectManager: KindManager<
+    APIFieldObject,
+    FormResult,
+    ValidationResult,
+    DisplayResult
   >;
-  defaultFieldManager: KindManager<APIField, FormResult, ValidationResult>;
-  defaultFieldObjectManager: KindManager<APIFieldObject, FormResult, ValidationResult>;
   validationSchemaBuilder: (
     fieldValidationTuple: [APIField, ValidationResult][],
   ) => ValidationSchema;
@@ -58,7 +81,8 @@ export class ResourceManager<
       FieldObjectKinds,
       FormResult,
       ValidationResult,
-      ValidationSchema
+      ValidationSchema,
+      DisplayResult
     >,
   ) {
     this.resources = resources;
@@ -68,7 +92,9 @@ export class ResourceManager<
     this.fieldObjectManagerByKind = options.fieldObjectManagerByKind;
   }
 
-  getManager(field: APIFieldUnion): KindManager<APIFieldUnion, FormResult, ValidationResult> {
+  getManager(
+    field: APIFieldUnion,
+  ): KindManager<APIFieldUnion, FormResult, ValidationResult, DisplayResult> {
     if ('kind' in field) {
       if (field.kind in this.fieldManagerByKind) {
         return this.fieldManagerByKind[field.kind as FieldKinds];
@@ -81,7 +107,7 @@ export class ResourceManager<
     return this.defaultFieldObjectManager;
   }
 
-  getFieldDisplay(field: APIFieldUnion, value?: FieldValidation): string {
+  getFieldDisplay(field: APIFieldUnion, value?: FieldValidation): DisplayResult {
     return this.getManager(field).display(field, value);
   }