Update FieldConfig interface to accept first the field value type bef…

…ore the Form
elastic · Oct 2, 2020 · 24e358d · 24e358d
1 parent 7def426
commit 24e358d
Show file tree

Hide file tree

Showing 11 changed files with 24 additions and 16 deletions.
diff --git a/src/plugins/es_ui_shared/static/forms/hook_form_lib/components/use_field.tsx b/src/plugins/es_ui_shared/static/forms/hook_form_lib/components/use_field.tsx
@@ -25,7 +25,7 @@ import { useFormContext } from '../form_context';
 
 export interface Props<T> {
   path: string;
-  config?: FieldConfig<any, T>;
+  config?: FieldConfig<T>;
   defaultValue?: T;
   component?: FunctionComponent<any>;
   componentProps?: Record<string, any>;
@@ -52,12 +52,12 @@ function UseFieldComp<T = unknown>(props: Props<T>) {
   const ComponentToRender = component ?? 'input';
   const propsToForward = { ...componentProps, ...rest };
 
-  const fieldConfig: FieldConfig<any, T> & { initialValue?: T } =
+  const fieldConfig: FieldConfig<T> & { initialValue?: T } =
     config !== undefined
       ? { ...config }
       : ({
           ...form.__readFieldConfigFromSchema(path),
-        } as Partial<FieldConfig<any, T>>);
+        } as Partial<FieldConfig<T>>);
 
   if (defaultValue !== undefined) {
     // update the form "defaultValue" ref object so when/if we reset the form we can go back to this value

diff --git a/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/use_field.ts b/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/use_field.ts
@@ -30,7 +30,7 @@ export interface InternalFieldConfig<T> {
 export const useField = <T>(
   form: FormHook,
   path: string,
-  config: FieldConfig<any, T> & InternalFieldConfig<T> = {},
+  config: FieldConfig<T> & InternalFieldConfig<T> = {},
   valueChangeListener?: (value: T) => void
 ) => {
   const {

diff --git a/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/use_form_data.ts b/src/plugins/es_ui_shared/static/forms/hook_form_lib/hooks/use_form_data.ts
@@ -63,7 +63,11 @@ export const useFormData = <T extends object = FormData>(options: Options = {}):
           ? (watch as string[])
           : ([watch] as string[]);
 
-        if (valuesToWatchArray.some((value) => previousRawData.current[value] !== raw[value])) {
+        if (
+          valuesToWatchArray.some(
+            (value) => previousRawData.current[value] !== raw[value as keyof T]
+          )
+        ) {
           previousRawData.current = raw;
           // Only update the state if one of the field we watch has changed.
           setFormData(raw);

diff --git a/src/plugins/es_ui_shared/static/forms/hook_form_lib/types.ts b/src/plugins/es_ui_shared/static/forms/hook_form_lib/types.ts
@@ -70,7 +70,7 @@ export interface FormHook<T extends FormData = FormData, I extends FormData = T>
 }
 
 export type FormSchema<T extends FormData = FormData> = {
-  [K in keyof T]?: FieldConfig<T, T[K]> | FormSchema<T[K]>;
+  [K in keyof T]?: FieldConfig<T[K], T> | FormSchema<T[K]>;
 };
 
 export interface FormConfig<T extends FormData = FormData, I extends FormData = T> {
@@ -135,7 +135,7 @@ export interface FieldHook<T = unknown> {
   __serializeValue: (rawValue?: T) => unknown;
 }
 
-export interface FieldConfig<T extends FormData = any, ValueType = unknown> {
+export interface FieldConfig<ValueType = unknown, T extends FormData = FormData> {
   readonly label?: string;
   readonly labelAppend?: string | ReactNode;
   readonly helpText?: string | ReactNode;
@@ -177,7 +177,7 @@ export interface ValidationFuncArg<T extends FormData, V = unknown> {
   errors: readonly ValidationError[];
 }
 
-export type ValidationFunc<T extends FormData = any, E = string, V = unknown> = (
+export type ValidationFunc<T extends FormData = any, E extends string = string, V = unknown> = (
   data: ValidationFuncArg<T, V>
 ) => ValidationError<E> | void | undefined | Promise<ValidationError<E> | void | undefined>;
 
@@ -198,7 +198,11 @@ type FormatterFunc = (value: any, formData: FormData) => unknown;
 // string | number | boolean | string[] ...
 type FieldValue = unknown;
 
-export interface ValidationConfig<T extends FormData = any, E = string, V = unknown> {
+export interface ValidationConfig<
+  T extends FormData = any,
+  E extends string = string,
+  V = unknown
+> {
   validator: ValidationFunc<T, E, V>;
   type?: string;
   /**

diff --git a/...mappings_editor/components/document_fields/field_parameters/other_type_json_parameter.tsx b/...mappings_editor/components/document_fields/field_parameters/other_type_json_parameter.tsx
@@ -23,7 +23,7 @@ const { isJsonField } = fieldValidators;
  * We use it to store custom defined parameters in a field called "otherTypeJson".
  */
 
-const fieldConfig: FieldConfig<any, any> = {
+const fieldConfig: FieldConfig<any> = {
   label: i18n.translate('xpack.idxMgmt.mappingsEditor.otherTypeJsonFieldLabel', {
     defaultMessage: 'Type Parameters JSON',
   }),

diff --git a/x-pack/plugins/index_management/public/application/components/mappings_editor/lib/utils.ts b/x-pack/plugins/index_management/public/application/components/mappings_editor/lib/utils.ts
@@ -92,7 +92,7 @@ export const getTypeLabelFromField = (field: Field) => {
 export const getFieldConfig = <T = unknown>(
   param: ParameterName,
   prop?: string
-): FieldConfig<any, T> => {
+): FieldConfig<T> => {
   if (prop !== undefined) {
     if (
       !(PARAMETERS_DEFINITION[param] as any).props ||

diff --git a/...s/index_management/public/application/components/mappings_editor/types/document_fields.ts b/...s/index_management/public/application/components/mappings_editor/types/document_fields.ts
@@ -25,7 +25,7 @@ export interface DataTypeDefinition {
 export interface ParameterDefinition {
   title?: string;
   description?: JSX.Element | string;
-  fieldConfig: FieldConfig<any, any>;
+  fieldConfig: FieldConfig<any>;
   schema?: any;
   props?: { [key: string]: ParameterDefinition };
   documentation?: {

diff --git a/...ors_editor/components/processor_form/processors/common_fields/common_processor_fields.tsx b/...ors_editor/components/processor_form/processors/common_fields/common_processor_fields.tsx
@@ -18,7 +18,7 @@ import {
 import { TextEditor } from '../../field_components';
 import { to, from, EDITOR_PX_HEIGHT } from '../shared';
 
-const ignoreFailureConfig: FieldConfig<any, any> = {
+const ignoreFailureConfig: FieldConfig<any> = {
   defaultValue: false,
   deserializer: to.booleanOrUndef,
   serializer: from.undefinedIfValue(false),

diff --git a/...ion/components/pipeline_processors_editor/components/processor_form/processors/custom.tsx b/...ion/components/pipeline_processors_editor/components/processor_form/processors/custom.tsx
@@ -20,7 +20,7 @@ import { XJsonEditor } from '../field_components';
 import { Fields } from '../processor_form.container';
 import { EDITOR_PX_HEIGHT } from './shared';
 
-const customConfig: FieldConfig<any, any> = {
+const customConfig: FieldConfig<any> = {
   type: FIELD_TYPES.TEXT,
   label: i18n.translate('xpack.ingestPipelines.pipelineEditor.customForm.optionsFieldLabel', {
     defaultMessage: 'Configuration',

diff --git a/...tion/components/pipeline_processors_editor/components/processor_form/processors/shared.ts b/...tion/components/pipeline_processors_editor/components/processor_form/processors/shared.ts
@@ -74,6 +74,6 @@ export const EDITOR_PX_HEIGHT = {
   large: 300,
 };
 
-export type FieldsConfig = Record<string, FieldConfig<any, any>>;
+export type FieldsConfig = Record<string, FieldConfig<any>>;
 
 export type FormFieldsComponent = FunctionComponent<{ initialFieldValues?: Record<string, any> }>;
diff --git a/...essors_editor/components/test_pipeline/test_pipeline_tabs/tab_documents/tab_documents.tsx b/...essors_editor/components/test_pipeline/test_pipeline_tabs/tab_documents/tab_documents.tsx
@@ -75,7 +75,7 @@ const i18nTexts = {
   ),
 };
 
-const documentFieldConfig: FieldConfig<any, string> = {
+const documentFieldConfig: FieldConfig<string> = {
   label: i18n.translate(
     'xpack.ingestPipelines.testPipelineFlyout.documentsForm.documentsFieldLabel',
     {