@rjsf/utils 5.3.1 → 5.5.0

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import React, { ReactElement, ComponentType, HTMLAttributes, StyleHTMLAttributes, ReactNode, ChangeEvent, ButtonHTMLAttributes } from 'react';
+import * as react from 'react';
+import react__default, { ReactElement, ComponentType, HTMLAttributes, StyleHTMLAttributes, ReactNode, ChangeEvent, ButtonHTMLAttributes } from 'react';
 import * as json_schema from 'json-schema';
 import { JSONSchema7 } from 'json-schema';
 
@@ -41,6 +42,8 @@ declare enum TranslatableString {
     ClearLabel = "Clear",
     /** Aria date label, used by DateWidget */
     AriaDateLabel = "Select a date",
+    /** File preview label, used by FileWidget */
+    PreviewLabel = "Preview",
     /** Decrement button aria label, used by UpDownWidget */
     DecrementAriaLabel = "Decrease value by 1",
     /** Increment button aria label, used by UpDownWidget */
@@ -605,6 +608,8 @@ type ObjectFieldTemplateProps<T = any, S extends StrictRJSFSchema = RJSFSchema,
     uiSchema?: UiSchema<T, S, F>;
     /** An object containing the id for this object & ids for its properties */
     idSchema: IdSchema<T>;
+    /** The optional validation errors in the form of an `ErrorSchema` */
+    errorSchema?: ErrorSchema<T>;
     /** The form data for the object */
     formData?: T;
     /** The `formContext` object that was passed to Form */
@@ -662,6 +667,10 @@ interface WidgetProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extend
     onFocus: (id: string, value: any) => void;
     /** The computed label for this widget, as a string */
     label: string;
+    /** A boolean value, if true, will cause the label to be hidden. This is useful for nested fields where you don't want
+     * to clutter the UI. Customized via `label` in the `UiSchema`
+     */
+    hideLabel?: boolean;
     /** A boolean value stating if the widget can accept multiple values */
     multiple?: boolean;
     /** An array of strings listing all generated error messages from encountered errors for this widget */
@@ -758,6 +767,8 @@ type UIOptionsBaseType<T = any, S extends StrictRJSFSchema = RJSFSchema, F exten
     readonly?: boolean;
     /** This property allows you to reorder the properties that are shown for a particular object */
     order?: string[];
+    /** Flag, if set to `true`, will cause the `FileWidget` to show a preview (with download for non-image files) */
+    filePreview?: boolean;
     /** Flag, if set to `true`, will mark a list of checkboxes as displayed all on one line instead of one per row */
     inline?: boolean;
     /** Used to change the input type (for example, `tel` or `email`) for an <input> */
@@ -850,7 +861,7 @@ interface ValidatorType<T = any, S extends StrictRJSFSchema = RJSFSchema, F exte
     /** Runs the pure validation of the `schema` and `formData` without any of the RJSF functionality. Provided for use
      * by the playground. Returns the `errors` from the validation
      *
-     * @param schema - The schema against which to validate the form data   * @param schema
+     * @param schema - The schema against which to validate the form data
      * @param formData - The form data to validate
      */
     rawValidation<Result = any>(schema: S, formData?: T): {
@@ -1359,6 +1370,19 @@ declare function isFixedItems<S extends StrictRJSFSchema = RJSFSchema>(schema: S
  */
 declare function isObject(thing: any): boolean;
 
+/** Helper function that will return the value to use for a widget `label` based on `hideLabel`. The `fallback` is used
+ * as the return value from the function when `hideLabel` is true. Due to the implementation of theme components, it
+ * may be necessary to return something other than `undefined` to cause the theme component to not render a label. Some
+ * themes require may `false` and others may require and empty string.
+ *
+ * @param [label] - The label string or component to render when not hidden
+ * @param [hideLabel] - Flag, if true, will cause the label to be hidden
+ * @param [fallback] - One of 3 values, `undefined` (the default), `false` or an empty string
+ * @returns - `fallback` if `hideLabel` is true, otherwise `label`
+ */
+declare function labelValue(label?: string | ReactElement, hideLabel?: boolean, fallback?: ''): undefined | string;
+declare function labelValue(label?: string | ReactElement, hideLabel?: boolean, fallback?: false | ''): string | false | ReactElement<any, string | react.JSXElementConstructor<any>> | undefined;
+
 /** Converts a local Date string into a UTC date string
  *
  * @param dateString - The string representation of a date as accepted by the `Date()` constructor
@@ -1479,7 +1503,7 @@ declare function schemaRequiresTrueValue<S extends StrictRJSFSchema = RJSFSchema
  * @param nextState - The next set of state against which to check
  * @returns - True if the component should be re-rendered, false otherwise
  */
-declare function shouldRender(component: React.Component, nextProps: any, nextState: any): boolean;
+declare function shouldRender(component: react__default.Component, nextProps: any, nextState: any): boolean;
 
 /** Returns the constant value from the schema when it is either a single value enum or has a const key. Otherwise
  * throws an error.
@@ -1731,4 +1755,4 @@ declare function toIdSchema<T = any, S extends StrictRJSFSchema = RJSFSchema, F
  */
 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, BaseInputTemplateProps, 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, GlobalUISchemaOptions, 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, TranslatableString, UIOptionsType, UISchemaSubmitButtonOptions, UI_FIELD_KEY, UI_GLOBAL_OPTIONS_KEY, UI_OPTIONS_KEY, UI_WIDGET_KEY, UiSchema, UnsupportedFieldProps, ValidationData, ValidatorType, Widget, WidgetProps, WrapIfAdditionalTemplateProps, allowAdditionalItems, ariaDescribedByIds, asNumber, canExpand, createSchemaUtils, dataURItoBlob, deepEquals, descriptionId, englishStringTranslator, enumOptionsDeselectValue, enumOptionsIndexForValue, enumOptionsIsSelected, enumOptionsSelectValue, enumOptionsValueForIndex, errorId, examplesId, findSchemaDefinition, getClosestMatchingOption, getDefaultFormState, getDisplayLabel, getFirstMatchingOption, getInputProps, getMatchingOption, getSchemaType, getSubmitButtonOptions, getTemplate, getUiOptions, getWidget, guessType, hasWidget, helpId, isConstant, isCustomWidget, isFilesArray, isFixedItems, isMultiSelect, isObject, isSelect, localToUTC, mergeDefaultsWithFormData, mergeObjects, mergeSchemas, mergeValidationData, optionId, optionsList, orderProperties, pad, parseDateString, rangeSpec, replaceStringParameters, retrieveSchema, sanitizeDataForNewSchema, schemaRequiresTrueValue, shouldRender, titleId, toConstant, toDateString, toIdSchema, toPathSchema, utcToLocal };
+export { ADDITIONAL_PROPERTIES_KEY, ADDITIONAL_PROPERTY_FLAG, ALL_OF_KEY, ANY_OF_KEY, ArrayFieldDescriptionProps, ArrayFieldTemplateItemType, ArrayFieldTemplateProps, ArrayFieldTitleProps, BaseInputTemplateProps, 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, GlobalUISchemaOptions, 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, TranslatableString, UIOptionsType, UISchemaSubmitButtonOptions, UI_FIELD_KEY, UI_GLOBAL_OPTIONS_KEY, UI_OPTIONS_KEY, UI_WIDGET_KEY, UiSchema, UnsupportedFieldProps, ValidationData, ValidatorType, Widget, WidgetProps, WrapIfAdditionalTemplateProps, allowAdditionalItems, ariaDescribedByIds, asNumber, canExpand, createSchemaUtils, dataURItoBlob, deepEquals, descriptionId, englishStringTranslator, enumOptionsDeselectValue, enumOptionsIndexForValue, enumOptionsIsSelected, enumOptionsSelectValue, enumOptionsValueForIndex, errorId, examplesId, findSchemaDefinition, getClosestMatchingOption, getDefaultFormState, getDisplayLabel, getFirstMatchingOption, getInputProps, getMatchingOption, getSchemaType, getSubmitButtonOptions, getTemplate, getUiOptions, getWidget, guessType, hasWidget, helpId, isConstant, isCustomWidget, isFilesArray, isFixedItems, isMultiSelect, isObject, isSelect, labelValue, localToUTC, mergeDefaultsWithFormData, mergeObjects, mergeSchemas, mergeValidationData, optionId, optionsList, orderProperties, pad, parseDateString, rangeSpec, replaceStringParameters, retrieveSchema, sanitizeDataForNewSchema, schemaRequiresTrueValue, shouldRender, titleId, toConstant, toDateString, toIdSchema, toPathSchema, utcToLocal };

package/dist/utils.cjs.development.js

@@ -2484,6 +2484,10 @@ function optionId(id, optionIndex) {
   return id + "-" + optionIndex;
 }
 
+function labelValue(label, hideLabel, fallback) {
+  return hideLabel ? fallback : label;
+}
+
 /** Converts a local Date string into a UTC date string
  *
  * @param dateString - The string representation of a date as accepted by the `Date()` constructor
@@ -2782,6 +2786,8 @@ exports.TranslatableString = void 0;
   TranslatableString["ClearLabel"] = "Clear";
   /** Aria date label, used by DateWidget */
   TranslatableString["AriaDateLabel"] = "Select a date";
+  /** File preview label, used by FileWidget */
+  TranslatableString["PreviewLabel"] = "Preview";
   /** Decrement button aria label, used by UpDownWidget */
   TranslatableString["DecrementAriaLabel"] = "Decrease value by 1";
   /** Increment button aria label, used by UpDownWidget */
@@ -2878,6 +2884,7 @@ exports.isFixedItems = isFixedItems;
 exports.isMultiSelect = isMultiSelect;
 exports.isObject = isObject;
 exports.isSelect = isSelect;
+exports.labelValue = labelValue;
 exports.localToUTC = localToUTC;
 exports.mergeDefaultsWithFormData = mergeDefaultsWithFormData;
 exports.mergeObjects = mergeObjects;