Simplify type assertions

solimant · solimant · commit 3eb7e6180506 · 2024-07-02T02:26:57.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,20 @@ should change the heading of the (upcoming) version to include a major version b
 
 -->
 
+# 5.18.7
+
+## @rjsf/utils
+
+- Fix IdSchema and PathSchema types ([#4196](https://github.com/rjsf-team/react-jsonschema-form/pull/4196))
+
+## @rjsf/validator-ajv6
+
+- Fix IdSchema and PathSchema types ([#4196](https://github.com/rjsf-team/react-jsonschema-form/pull/4196))
+
+## @rjsf/validator-ajv8
+
+- Fix IdSchema and PathSchema types ([#4196](https://github.com/rjsf-team/react-jsonschema-form/pull/4196))
+
 # 5.18.6
 
 ## @rjsf/antd
diff --git a/packages/utils/src/schema/toIdSchema.ts b/packages/utils/src/schema/toIdSchema.ts
@@ -3,7 +3,7 @@ import isEqual from 'lodash/isEqual';
 
 import { ALL_OF_KEY, DEPENDENCIES_KEY, ID_KEY, ITEMS_KEY, PROPERTIES_KEY, REF_KEY } from '../constants';
 import isObject from '../isObject';
-import { FormContextType, IdSchema, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types';
+import { FormContextType, GenericObjectType, IdSchema, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types';
 import retrieveSchema from './retrieveSchema';
 import getSchemaType from '../getSchemaType';
 
@@ -59,16 +59,12 @@ function toIdSchemaInternal<T = any, S extends StrictRJSFSchema = RJSFSchema, F
     );
   }
   const $id = id || idPrefix;
-  const idSchema: IdSchema = { $id } as IdSchema<T>;
+  const idSchema: IdSchema<T> = { $id } as IdSchema<T>;
   if (getSchemaType<S>(schema) === 'object' && PROPERTIES_KEY in schema) {
     for (const name in schema.properties) {
       const field = get(schema, [PROPERTIES_KEY, name]);
       const fieldId = idSchema[ID_KEY] + idSeparator + name;
-      (idSchema as { [key in keyof IdSchema<T>]: IdSchema<T> })[name as keyof IdSchema<T>] = toIdSchemaInternal<
-        T,
-        S,
-        F
-      >(
+      (idSchema as IdSchema<GenericObjectType>)[name] = toIdSchemaInternal<T, S, F>(
         validator,
         isObject(field) ? field : {},
         idPrefix,
@@ -82,7 +78,7 @@ function toIdSchemaInternal<T = any, S extends StrictRJSFSchema = RJSFSchema, F
       );
     }
   }
-  return idSchema as IdSchema<T>;
+  return idSchema;
 }
 
 /** Generates an `IdSchema` object for the `schema`, recursively
diff --git a/packages/utils/src/schema/toPathSchema.ts b/packages/utils/src/schema/toPathSchema.ts
@@ -15,7 +15,7 @@ import {
   RJSF_ADDITIONAL_PROPERTIES_FLAG,
 } from '../constants';
 import getDiscriminatorFieldFromSchema from '../getDiscriminatorFieldFromSchema';
-import { FormContextType, PathSchema, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types';
+import { FormContextType, GenericObjectType, PathSchema, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types';
 import getClosestMatchingOption from './getClosestMatchingOption';
 import retrieveSchema from './retrieveSchema';
 
@@ -53,9 +53,9 @@ function toPathSchemaInternal<T = any, S extends StrictRJSFSchema = RJSFSchema,
     }
   }
 
-  let pathSchema: PathSchema = {
+  let pathSchema: PathSchema<T> = {
     [NAME_KEY]: name.replace(/^\./, ''),
-  } as PathSchema;
+  } as PathSchema<T>;
 
   if (ONE_OF_KEY in schema || ANY_OF_KEY in schema) {
     const xxxOf: S[] = ONE_OF_KEY in schema ? (schema.oneOf as S[]) : (schema.anyOf as S[]);
@@ -78,52 +78,55 @@ function toPathSchemaInternal<T = any, S extends StrictRJSFSchema = RJSFSchema,
     if (Array.isArray(schemaItems)) {
       formData.forEach((element, i: number) => {
         if (schemaItems[i]) {
-          (pathSchema as { [key in keyof PathSchema<T>]: PathSchema<T> })[i as keyof PathSchema<T>] =
-            toPathSchemaInternal<T, S, F>(
-              validator,
-              schemaItems[i] as S,
-              `${name}.${i}`,
-              rootSchema,
-              element,
-              _recurseList
-            );
+          (pathSchema as PathSchema<T[]>)[i] = toPathSchemaInternal<T, S, F>(
+            validator,
+            schemaItems[i] as S,
+            `${name}.${i}`,
+            rootSchema,
+            element,
+            _recurseList
+          );
         } else if (schemaAdditionalItems) {
-          (pathSchema as { [key in keyof PathSchema<T>]: PathSchema<T> })[i as keyof PathSchema<T>] =
-            toPathSchemaInternal<T, S, F>(
-              validator,
-              schemaAdditionalItems as S,
-              `${name}.${i}`,
-              rootSchema,
-              element,
-              _recurseList
-            );
+          (pathSchema as PathSchema<T[]>)[i] = toPathSchemaInternal<T, S, F>(
+            validator,
+            schemaAdditionalItems as S,
+            `${name}.${i}`,
+            rootSchema,
+            element,
+            _recurseList
+          );
         } else {
           console.warn(`Unable to generate path schema for "${name}.${i}". No schema defined for it`);
         }
       });
     } else {
       formData.forEach((element, i: number) => {
-        (pathSchema as { [key in keyof PathSchema<T>]: PathSchema<T> })[i as keyof PathSchema<T>] =
-          toPathSchemaInternal<T, S, F>(validator, schemaItems as S, `${name}.${i}`, rootSchema, element, _recurseList);
+        (pathSchema as PathSchema<T[]>)[i] = toPathSchemaInternal<T, S, F>(
+          validator,
+          schemaItems as S,
+          `${name}.${i}`,
+          rootSchema,
+          element,
+          _recurseList
+        );
       });
     }
   } else if (PROPERTIES_KEY in schema) {
     for (const property in schema.properties) {
       const field = get(schema, [PROPERTIES_KEY, property]);
-      (pathSchema as { [key in keyof PathSchema<T>]: PathSchema<T> })[property as keyof PathSchema<T>] =
-        toPathSchemaInternal<T, S, F>(
-          validator,
-          field,
-          `${name}.${property}`,
-          rootSchema,
-          // It's possible that formData is not an object -- this can happen if an
-          // array item has just been added, but not populated with data yet
-          get(formData, [property]),
-          _recurseList
-        );
+      (pathSchema as PathSchema<GenericObjectType>)[property] = toPathSchemaInternal<T, S, F>(
+        validator,
+        field,
+        `${name}.${property}`,
+        rootSchema,
+        // It's possible that formData is not an object -- this can happen if an
+        // array item has just been added, but not populated with data yet
+        get(formData, [property]),
+        _recurseList
+      );
     }
   }
-  return pathSchema as PathSchema<T>;
+  return pathSchema;
 }
 
 /** Generates an `PathSchema` object for the `schema`, recursively
diff --git a/packages/utils/src/types.ts b/packages/utils/src/types.ts
@@ -145,7 +145,11 @@ export type FieldPath = {
 };
 
 /** Type describing a recursive structure of `FieldPath`s for an object with a non-empty set of keys */
-export type PathSchema<T = any> = T extends GenericObjectType
+export type PathSchema<T = any> = T extends Array<infer U>
+  ? FieldPath & {
+      [i: number]: PathSchema<U>;
+    }
+  : T extends GenericObjectType
   ? FieldPath & {
       /** The set of names for fields in the recursive object structure */
       [key in keyof T]?: PathSchema<T[key]>;
diff --git a/packages/utils/test/schema/types.ts b/packages/utils/test/schema/types.ts
@@ -6,7 +6,7 @@ export interface TestValidatorParams<T = any> {
   errorList?: RJSFValidationError[][];
 }
 
-export interface TestValidatorType extends ValidatorType {
+export interface TestValidatorType<T = any> extends ValidatorType<T> {
   // eslint-disable-next-line no-unused-vars
   setReturnValues(params?: TestValidatorParams): void;
 }
diff --git a/packages/validator-ajv6/test/utilsTests/getTestValidator.ts b/packages/validator-ajv6/test/utilsTests/getTestValidator.ts
@@ -16,14 +16,14 @@ import { customizeValidator, CustomValidatorOptionsType } from '../../src';
  *
  * @param options
  */
-export default function getTestValidator<T = any>(options: CustomValidatorOptionsType): TestValidatorType {
+export default function getTestValidator<T = any>(options: CustomValidatorOptionsType): TestValidatorType<T> {
   const validator = customizeValidator<T>(options);
   return {
     validateFormData(
       formData: T,
       schema: RJSFSchema,
-      customValidate?: CustomValidator,
-      transformErrors?: ErrorTransformer
+      customValidate?: CustomValidator<T>,
+      transformErrors?: ErrorTransformer<T>
     ): ValidationData<T> {
       return validator.validateFormData(formData, schema, customValidate, transformErrors);
     },
diff --git a/packages/validator-ajv8/test/utilsTests/getTestValidator.ts b/packages/validator-ajv8/test/utilsTests/getTestValidator.ts
@@ -16,14 +16,14 @@ import { customizeValidator, CustomValidatorOptionsType } from '../../src';
  *
  * @param options
  */
-export default function getTestValidator<T = any>(options: CustomValidatorOptionsType): TestValidatorType {
+export default function getTestValidator<T = any>(options: CustomValidatorOptionsType): TestValidatorType<T> {
   const validator = customizeValidator<T>(options);
   return {
     validateFormData(
       formData: T | undefined,
       schema: RJSFSchema,
-      customValidate?: CustomValidator,
-      transformErrors?: ErrorTransformer
+      customValidate?: CustomValidator<T>,
+      transformErrors?: ErrorTransformer<T>
     ): ValidationData<T> {
       return validator.validateFormData(formData, schema, customValidate, transformErrors);
     },

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ export interface TestValidatorParams<T = any> {`
`6`	`6`	`errorList?: RJSFValidationError[][];`
`7`	`7`	`}`
`8`	`8`
`9`		`-export interface TestValidatorType extends ValidatorType {`
	`9`	`+export interface TestValidatorType<T = any> extends ValidatorType<T> {`
`10`	`10`	`// eslint-disable-next-line no-unused-vars`
`11`	`11`	`setReturnValues(params?: TestValidatorParams): void;`
`12`	`12`	`}`