Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
…3307) fix: #3239 by providing a new `ErrorSchemaBuilder` class in `@rjsf/utils` - In `@rjsf/utils` added `ErrorSchemaBuilder` to facilitate building `ErrorSchema` objects without the need for fancy casting - Exported the new class as part of the main `index.js` - Added 100% unit tests - In `@rjsf/validator-ajv6` and `@rjsf/validator-ajv8` updated the `toErrorSchema()` function to use the `ErrorSchemaBuilder` to simplify the implementation - Also updated the tests to use the `ErrorSchemaBuilder` to replace the expected values that required doing `as ErrorSchema` casting - Updated the `utility-functions.md` file to document `ErrorSchemaBuilder` - Updated the `CHANGELOG.md` accordingly for this fix as well as PR #3297
- Loading branch information
1 parent
8ebbb42
commit e35f61a
Showing
9 changed files
with
548 additions
and
99 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| import cloneDeep from "lodash/cloneDeep"; | ||
| import get from "lodash/get"; | ||
| import set from "lodash/set"; | ||
|
|
||
| import { ErrorSchema } from "./types"; | ||
| import { ERRORS_KEY } from "./constants"; | ||
|
|
||
| /** The `ErrorSchemaBuilder<T>` is used to build an `ErrorSchema<T>` since the definition of the `ErrorSchema` type is | ||
| * designed for reading information rather than writing it. Use this class to add, replace or clear errors in an error | ||
| * schema by using either dotted path or an array of path names. Once you are done building the `ErrorSchema`, you can | ||
| * get the result and/or reset all the errors back to an initial set and start again. | ||
| */ | ||
| export default class ErrorSchemaBuilder<T = any> { | ||
| /** The error schema being built | ||
| * | ||
| * @private | ||
| */ | ||
| private errorSchema: ErrorSchema<T> = {}; | ||
|
|
||
| /** Construct an `ErrorSchemaBuilder` with an optional initial set of errors in an `ErrorSchema`. | ||
| * | ||
| * @param [initialSchema] - The optional set of initial errors, that will be cloned into the class | ||
| */ | ||
| constructor(initialSchema?: ErrorSchema<T>) { | ||
| this.resetAllErrors(initialSchema); | ||
| } | ||
|
|
||
| /** Returns the `ErrorSchema` that has been updated by the methods of the `ErrorSchemaBuilder` | ||
| */ | ||
| get ErrorSchema() { | ||
| return this.errorSchema; | ||
| } | ||
|
|
||
| /** Will get an existing `ErrorSchema` at the specified `pathOfError` or create and return one. | ||
| * | ||
| * @param [pathOfError] - The optional path into the `ErrorSchema` at which to add the error(s) | ||
| * @returns - The error block for the given `pathOfError` or the root if not provided | ||
| * @private | ||
| */ | ||
| private getOrCreateErrorBlock(pathOfError?: string | string[]) { | ||
| const hasPath = | ||
| (Array.isArray(pathOfError) && pathOfError.length > 0) || | ||
| typeof pathOfError === "string"; | ||
| let errorBlock: ErrorSchema = hasPath | ||
| ? get(this.errorSchema, pathOfError) | ||
| : this.errorSchema; | ||
| if (!errorBlock && pathOfError) { | ||
| errorBlock = {}; | ||
| set(this.errorSchema, pathOfError, errorBlock); | ||
| } | ||
| return errorBlock; | ||
| } | ||
|
|
||
| /** Resets all errors in the `ErrorSchemaBuilder` back to the `initialSchema` if provided, otherwise an empty set. | ||
| * | ||
| * @param [initialSchema] - The optional set of initial errors, that will be cloned into the class | ||
| * @returns - The `ErrorSchemaBuilder` object for chaining purposes | ||
| */ | ||
| resetAllErrors(initialSchema?: ErrorSchema<T>) { | ||
| this.errorSchema = initialSchema ? cloneDeep(initialSchema) : {}; | ||
| return this; | ||
| } | ||
|
|
||
| /** Adds the `errorOrList` to the list of errors in the `ErrorSchema` at either the root level or the location within | ||
| * the schema described by the `pathOfError`. For more information about how to specify the path see the | ||
| * [eslint lodash plugin docs](https://github.com/wix/eslint-plugin-lodash/blob/master/docs/rules/path-style.md). | ||
| * | ||
| * @param errorOrList - The error or list of errors to add into the `ErrorSchema` | ||
| * @param [pathOfError] - The optional path into the `ErrorSchema` at which to add the error(s) | ||
| * @returns - The `ErrorSchemaBuilder` object for chaining purposes | ||
| */ | ||
| addErrors(errorOrList: string | string[], pathOfError?: string | string[]) { | ||
| const errorBlock: ErrorSchema = this.getOrCreateErrorBlock(pathOfError); | ||
| let errorsList = get(errorBlock, ERRORS_KEY); | ||
| if (!Array.isArray(errorsList)) { | ||
| errorsList = []; | ||
| errorBlock[ERRORS_KEY] = errorsList; | ||
| } | ||
|
|
||
| if (Array.isArray(errorOrList)) { | ||
| errorsList.push(...errorOrList); | ||
| } else { | ||
| errorsList.push(errorOrList); | ||
| } | ||
| return this; | ||
| } | ||
|
|
||
| /** Sets/replaces the `errorOrList` as the error(s) in the `ErrorSchema` at either the root level or the location | ||
| * within the schema described by the `pathOfError`. For more information about how to specify the path see the | ||
| * [eslint lodash plugin docs](https://github.com/wix/eslint-plugin-lodash/blob/master/docs/rules/path-style.md). | ||
| * | ||
| * @param errorOrList - The error or list of errors to set into the `ErrorSchema` | ||
| * @param [pathOfError] - The optional path into the `ErrorSchema` at which to set the error(s) | ||
| * @returns - The `ErrorSchemaBuilder` object for chaining purposes | ||
| */ | ||
| setErrors(errorOrList: string | string[], pathOfError?: string | string[]) { | ||
| const errorBlock: ErrorSchema = this.getOrCreateErrorBlock(pathOfError); | ||
| // Effectively clone the array being given to prevent accidental outside manipulation of the given list | ||
| const listToAdd = Array.isArray(errorOrList) | ||
| ? [...errorOrList] | ||
| : [errorOrList]; | ||
| set(errorBlock, ERRORS_KEY, listToAdd); | ||
| return this; | ||
| } | ||
|
|
||
| /** Clears the error(s) in the `ErrorSchema` at either the root level or the location within the schema described by | ||
| * the `pathOfError`. For more information about how to specify the path see the | ||
| * [eslint lodash plugin docs](https://github.com/wix/eslint-plugin-lodash/blob/master/docs/rules/path-style.md). | ||
| * | ||
| * @param [pathOfError] - The optional path into the `ErrorSchema` at which to clear the error(s) | ||
| * @returns - The `ErrorSchemaBuilder` object for chaining purposes | ||
| */ | ||
| clearErrors(pathOfError?: string | string[]) { | ||
| const errorBlock: ErrorSchema = this.getOrCreateErrorBlock(pathOfError); | ||
| set(errorBlock, ERRORS_KEY, []); | ||
| return this; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.