@rjsf/utils 5.0.0-beta.15 → 5.0.0-beta.16

package/dist/index.d.ts

@@ -388,6 +388,8 @@ declare type ArrayFieldTemplateItemType<T = any, S extends StrictRJSFSchema = RJ
     className: string;
     /** A boolean value stating if the array item is disabled */
     disabled: boolean;
+    /** A boolean value stating whether new items can be added to the array */
+    canAdd: boolean;
     /** A boolean value stating whether the array item can be moved down */
     hasMoveDown: boolean;
     /** A boolean value stating whether the array item can be moved up */
@@ -398,6 +400,8 @@ declare type ArrayFieldTemplateItemType<T = any, S extends StrictRJSFSchema = RJ
     hasToolbar: boolean;
     /** A number stating the index the array item occurs in `items` */
     index: number;
+    /** A number stating the total number `items` in the array */
+    totalItems: number;
     /** Returns a function that adds a new item at `index` */
     onAddIndexClick: (index: number) => (event?: any) => void;
     /** Returns a function that removes the item at `index` */
@@ -526,7 +530,7 @@ interface WidgetProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extend
      */
     options: NonNullable<UIOptionsType<T, S, F>> & {
         /** The enum options list for a type that supports them */
-        enumOptions?: EnumOptionsType[];
+        enumOptions?: EnumOptionsType<S>[];
     };
     /** The `formContext` object that you passed to `Form` */
     formContext?: F;
@@ -551,6 +555,8 @@ declare type Widget<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
 declare type SubmitButtonProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
     /** The uiSchema for this widget */
     uiSchema?: UiSchema<T, S, F>;
+    /** The `registry` object */
+    registry: Registry<T, S, F>;
 };
 /** The type that defines the props for an Icon button, extending from a basic HTML button attributes */
 declare type IconButtonProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = React.ButtonHTMLAttributes<HTMLButtonElement> & {
@@ -560,6 +566,8 @@ declare type IconButtonProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F
     icon?: string | React.ReactElement;
     /** The uiSchema for this widget */
     uiSchema?: UiSchema<T, S, F>;
+    /** The `registry` object */
+    registry: Registry<T, S, F>;
 };
 /** The type that defines how to change the behavior of the submit button for the form */
 declare type UISchemaSubmitButtonOptions = {
@@ -663,14 +671,14 @@ declare type UiSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extend
     /** An object that contains all the potential UI options in a single object */
     "ui:options"?: UIOptionsType<T, S, F>;
 };
-/** A `CustomValidator` function takes in a `formData` and `errors` object and returns the given `errors` object back,
- * while potentially adding additional messages to the `errors`
+/** A `CustomValidator` function takes in a `formData`, `errors` and `uiSchema` objects and returns the given `errors`
+ * object back, while potentially adding additional messages to the `errors`
  */
-declare type CustomValidator<T = any> = (formData: T, errors: FormValidation<T>) => FormValidation<T>;
-/** An `ErrorTransformer` function will take in a list of `errors` and potentially return a transformation of those
- * errors in what ever way it deems necessary
+declare type CustomValidator<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = (formData: T, errors: FormValidation<T>, uiSchema?: UiSchema<T, S, F>) => FormValidation<T>;
+/** An `ErrorTransformer` function will take in a list of `errors` & a `uiSchema` and potentially return a
+ * transformation of those errors in what ever way it deems necessary
  */
-declare type ErrorTransformer = (errors: RJSFValidationError[]) => RJSFValidationError[];
+declare type ErrorTransformer<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = (errors: RJSFValidationError[], uiSchema?: UiSchema<T, S, F>) => RJSFValidationError[];
 /** The type that describes the data that is returned from the `ValidatorType.validateFormData()` function */
 declare type ValidationData<T> = {
     /** The validation errors as a list of `RJSFValidationError` objects */
@@ -681,7 +689,7 @@ declare type ValidationData<T> = {
 /** The interface that describes the validation functions that are provided by a Validator implementation used by the
  * schema utilities.
  */
-interface ValidatorType<T = any, S extends StrictRJSFSchema = RJSFSchema> {
+interface ValidatorType<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> {
     /** This function processes the `formData` with an optional user contributed `customValidate` function, which receives
      * the form data and a `errorHandler` function that will be used to add custom validation errors for each field. Also
      * supports a `transformErrors` function that will take the raw AJV validation errors, prior to custom validation and
@@ -691,8 +699,9 @@ interface ValidatorType<T = any, S extends StrictRJSFSchema = RJSFSchema> {
      * @param schema - The schema against which to validate the form data
      * @param [customValidate] - An optional function that is used to perform custom validation
      * @param [transformErrors] - An optional function that is used to transform errors after AJV validation
+     * @param [uiSchema] - An optional uiSchema that is passed to `transformErrors` and `customValidate`
      */
-    validateFormData(formData: T | undefined, schema: S, customValidate?: CustomValidator<T>, transformErrors?: ErrorTransformer): ValidationData<T>;
+    validateFormData(formData: T | undefined, schema: S, customValidate?: CustomValidator<T, S, F>, transformErrors?: ErrorTransformer<T, S, F>, uiSchema?: UiSchema<T, S, F>): ValidationData<T>;
     /** Converts an `errorSchema` into a list of `RJSFValidationErrors`
      *
      * @param errorSchema - The `ErrorSchema` instance to convert
@@ -729,7 +738,7 @@ interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
      *
      * @returns - The `ValidatorType`
      */
-    getValidator(): ValidatorType<T, S>;
+    getValidator(): ValidatorType<T, S, F>;
     /** Determines whether either the `validator` and `rootSchema` differ from the ones associated with this instance of
      * the `SchemaUtilsType`. If either `validator` or `rootSchema` are falsy, then return false to prevent the creation
      * of a new `SchemaUtilsType` with incomplete properties.
@@ -738,7 +747,7 @@ interface SchemaUtilsType<T = any, S extends StrictRJSFSchema = RJSFSchema, F ex
      * @param rootSchema - The root schema that will be compared against the current one
      * @returns - True if the `SchemaUtilsType` differs from the given `validator` or `rootSchema`
      */
-    doesSchemaUtilsDiffer(validator: ValidatorType<T, S>, rootSchema: S): boolean;
+    doesSchemaUtilsDiffer(validator: ValidatorType<T, S, F>, rootSchema: S): boolean;
     /** Returns the superset of `formData` that includes the given set updated to include any missing fields that have
      * computed to have defaults provided in the `schema`.
      *
@@ -860,7 +869,7 @@ declare function canExpand<T = any, S extends StrictRJSFSchema = RJSFSchema, F e
  * @param rootSchema - The root schema that will be forwarded to all the APIs
  * @returns - An implementation of a `SchemaUtilsType` interface
  */
-declare function createSchemaUtils<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S>, rootSchema: S): SchemaUtilsType<T, S, F>;
+declare function createSchemaUtils<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, rootSchema: S): SchemaUtilsType<T, S, F>;
 
 /** Given the `FileReader.readAsDataURL()` based `dataURI` extracts that data into an actual Blob along with the name
  * of that Blob if provided in the URL. If no name is provided, then the name falls back to `unknown`.
@@ -1251,7 +1260,7 @@ declare const UI_OPTIONS_KEY = "ui:options";
  *          object properties.
  * @returns - The resulting `formData` with all the defaults provided
  */
-declare function getDefaultFormState<T = any, S extends StrictRJSFSchema = RJSFSchema>(validator: ValidatorType<T, S>, theSchema: S, formData?: T, rootSchema?: S, includeUndefinedValues?: boolean | "excludeObjectChildren"): T | T[] | undefined;
+declare function getDefaultFormState<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, theSchema: S, formData?: T, rootSchema?: S, includeUndefinedValues?: boolean | "excludeObjectChildren"): T | T[] | undefined;
 
 /** Determines whether the combination of `schema` and `uiSchema` properties indicates that the label for the `schema`
  * should be displayed in a UI.
@@ -1262,7 +1271,7 @@ declare function getDefaultFormState<T = any, S extends StrictRJSFSchema = RJSFS
  * @param [rootSchema] - The root schema, used to primarily to look up `$ref`s
  * @returns - True if the label should be displayed or false if it should not
  */
-declare function getDisplayLabel<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S>, schema: S, uiSchema?: UiSchema<T, S, F>, rootSchema?: S): boolean;
+declare function getDisplayLabel<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, schema: S, uiSchema?: UiSchema<T, S, F>, rootSchema?: S): boolean;
 
 /** Given the `formData` and list of `options`, attempts to find the index of the option that best matches the data.
  *
@@ -1272,7 +1281,7 @@ declare function getDisplayLabel<T = any, S extends StrictRJSFSchema = RJSFSchem
  * @param rootSchema - The root schema, used to primarily to look up `$ref`s
  * @returns - The index of the matched option or 0 if none is available
  */
-declare function getMatchingOption<T = any, S extends StrictRJSFSchema = RJSFSchema>(validator: ValidatorType<T, S>, formData: T | undefined, options: S[], rootSchema: S): number;
+declare function getMatchingOption<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, formData: T | undefined, options: S[], rootSchema: S): number;
 
 /** Checks to see if the `schema` and `uiSchema` combination represents an array of files
  *
@@ -1282,7 +1291,7 @@ declare function getMatchingOption<T = any, S extends StrictRJSFSchema = RJSFSch
  * @param [rootSchema] - The root schema, used to primarily to look up `$ref`s
  * @returns - True if schema/uiSchema contains an array of files, otherwise false
  */
-declare function isFilesArray<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S>, schema: S, uiSchema?: UiSchema<T, S, F>, rootSchema?: S): boolean;
+declare function isFilesArray<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, schema: S, uiSchema?: UiSchema<T, S, F>, rootSchema?: S): boolean;
 
 /** Checks to see if the `schema` combination represents a multi-select
  *
@@ -1291,7 +1300,7 @@ declare function isFilesArray<T = any, S extends StrictRJSFSchema = RJSFSchema,
  * @param [rootSchema] - The root schema, used to primarily to look up `$ref`s
  * @returns - True if schema contains a multi-select, otherwise false
  */
-declare function isMultiSelect<T = any, S extends StrictRJSFSchema = RJSFSchema>(validator: ValidatorType<T, S>, schema: S, rootSchema?: S): boolean;
+declare function isMultiSelect<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, schema: S, rootSchema?: S): boolean;
 
 /** Checks to see if the `schema` combination represents a select
  *
@@ -1300,7 +1309,7 @@ declare function isMultiSelect<T = any, S extends StrictRJSFSchema = RJSFSchema>
  * @param [rootSchema] - The root schema, used to primarily to look up `$ref`s
  * @returns - True if schema contains a select, otherwise false
  */
-declare function isSelect<T = any, S extends StrictRJSFSchema = RJSFSchema>(validator: ValidatorType<T, S>, theSchema: S, rootSchema?: S): boolean;
+declare function isSelect<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, theSchema: S, rootSchema?: S): boolean;
 
 /** Merges the errors in `additionalErrorSchema` into the existing `validationData` by combining the hierarchies in the
  * two `ErrorSchema`s and then appending the error list from the `additionalErrorSchema` obtained by calling
@@ -1312,7 +1321,7 @@ declare function isSelect<T = any, S extends StrictRJSFSchema = RJSFSchema>(vali
  * @param [additionalErrorSchema] - The additional set of errors in an `ErrorSchema`
  * @returns - The `validationData` with the additional errors from `additionalErrorSchema` merged into it, if provided.
  */
-declare function mergeValidationData<T = any, S extends StrictRJSFSchema = RJSFSchema>(validator: ValidatorType<T, S>, validationData: ValidationData<T>, additionalErrorSchema?: ErrorSchema<T>): ValidationData<T>;
+declare function mergeValidationData<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, validationData: ValidationData<T>, additionalErrorSchema?: ErrorSchema<T>): ValidationData<T>;
 
 /** Retrieves an expanded schema that has had all of its conditions, additional properties, references and dependencies
  * resolved and merged into the `schema` given a `validator`, `rootSchema` and `rawFormData` that is used to do the
@@ -1324,7 +1333,7 @@ declare function mergeValidationData<T = any, S extends StrictRJSFSchema = RJSFS
  * @param [rawFormData] - The current formData, if any, to assist retrieving a schema
  * @returns - The schema having its conditions, additional properties, references and dependencies resolved
  */
-declare function retrieveSchema<T = any, S extends StrictRJSFSchema = RJSFSchema>(validator: ValidatorType<T, S>, schema: S, rootSchema?: S, rawFormData?: T): S;
+declare function retrieveSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, schema: S, rootSchema?: S, rawFormData?: T): S;
 
 /** Generates an `IdSchema` object for the `schema`, recursively
  *
@@ -1337,7 +1346,7 @@ declare function retrieveSchema<T = any, S extends StrictRJSFSchema = RJSFSchema
  * @param [idSeparator='_'] - The separator to use for the path segments in the id
  * @returns - The `IdSchema` object for the `schema`
  */
-declare function toIdSchema<T = any, S extends StrictRJSFSchema = RJSFSchema>(validator: ValidatorType<T, S>, schema: S, id?: string | null, rootSchema?: S, formData?: T, idPrefix?: string, idSeparator?: string): IdSchema<T>;
+declare function toIdSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, schema: S, id?: string | null, rootSchema?: S, formData?: T, idPrefix?: string, idSeparator?: string): IdSchema<T>;
 
 /** Generates an `PathSchema` object for the `schema`, recursively
  *
@@ -1348,6 +1357,6 @@ declare function toIdSchema<T = any, S extends StrictRJSFSchema = RJSFSchema>(va
  * @param [formData] - The current formData, if any, to assist retrieving a schema
  * @returns - The `PathSchema` object for the `schema`
  */
-declare function toPathSchema<T = any, S extends StrictRJSFSchema = RJSFSchema>(validator: ValidatorType<T, S>, schema: S, name?: string, rootSchema?: S, formData?: T): PathSchema<T>;
+declare function toPathSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, schema: S, name?: string, rootSchema?: S, formData?: T): PathSchema<T>;
 
 export { ADDITIONAL_PROPERTIES_KEY, ADDITIONAL_PROPERTY_FLAG, ALL_OF_KEY, ANY_OF_KEY, ArrayFieldDescriptionProps, ArrayFieldTemplateItemType, ArrayFieldTemplateProps, ArrayFieldTitleProps, CONST_KEY, CustomValidator, DEFAULT_KEY, DEFINITIONS_KEY, DEPENDENCIES_KEY, DateObject, DescriptionFieldProps, ENUM_KEY, ERRORS_KEY, EnumOptionsType, ErrorListProps, ErrorSchema, ErrorSchemaBuilder, ErrorTransformer, Field, FieldError, FieldErrorProps, FieldErrors, FieldHelpProps, FieldId, FieldPath, FieldProps, FieldTemplateProps, FieldValidation, FormContextType, FormValidation, GenericObjectType, ID_KEY, ITEMS_KEY, IconButtonProps, IdSchema, InputPropsType, NAME_KEY, ONE_OF_KEY, ObjectFieldTemplatePropertyType, ObjectFieldTemplateProps, PROPERTIES_KEY, PathSchema, REF_KEY, REQUIRED_KEY, RJSFSchema, RJSFValidationError, RJSF_ADDITONAL_PROPERTIES_FLAG, RangeSpecType, Registry, RegistryFieldsType, RegistryWidgetsType, SUBMIT_BTN_OPTIONS_KEY, SchemaUtilsType, StrictRJSFSchema, SubmitButtonProps, TemplatesType, TitleFieldProps, UIOptionsType, UISchemaSubmitButtonOptions, UI_FIELD_KEY, UI_OPTIONS_KEY, UI_WIDGET_KEY, UiSchema, UnsupportedFieldProps, ValidationData, ValidatorType, Widget, WidgetProps, WrapIfAdditionalTemplateProps, allowAdditionalItems, asNumber, canExpand, createSchemaUtils, dataURItoBlob, deepEquals, findSchemaDefinition, getDefaultFormState, getDisplayLabel, getInputProps, getMatchingOption, getSchemaType, getSubmitButtonOptions, getTemplate, getUiOptions, getWidget, guessType, hasWidget, isConstant, isCustomWidget, isFilesArray, isFixedItems, isMultiSelect, isObject, isSelect, localToUTC, mergeDefaultsWithFormData, mergeObjects, mergeSchemas, mergeValidationData, optionsList, orderProperties, pad, parseDateString, processSelectValue, rangeSpec, retrieveSchema, schemaRequiresTrueValue, shouldRender, toConstant, toDateString, toIdSchema, toPathSchema, utcToLocal };