@rjsf/utils 5.1.0 → 5.2.0

package/dist/index.d.ts

@@ -2,6 +2,73 @@ import React, { StyleHTMLAttributes } from 'react';
 import * as json_schema from 'json-schema';
 import { JSONSchema7 } from 'json-schema';
 
+/** An enumeration of all the translatable strings used by `@rjsf/core` and its themes. The value of each of the
+ * enumeration keys is expected to be the actual english string. Some strings contain replaceable parameter values
+ * as indicated by `%1`, `%2`, etc. The number after the `%` indicates the order of the parameter. The ordering of
+ * parameters is important because some languages may choose to put the second parameter before the first in its
+ * translation. Also, some strings are rendered using `markdown-to-jsx` and thus support markdown and inline html.
+ */
+declare enum TranslatableString {
+    /** Fallback title of an array item, used by ArrayField */
+    ArrayItemTitle = "Item",
+    /** Missing items reason, used by ArrayField */
+    MissingItems = "Missing items definition",
+    /** Yes label, used by BooleanField */
+    YesLabel = "Yes",
+    /** No label, used by BooleanField */
+    NoLabel = "No",
+    /** Close label, used by ErrorList */
+    CloseLabel = "Close",
+    /** Errors label, used by ErrorList */
+    ErrorsLabel = "Errors",
+    /** New additionalProperties string default value, used by ObjectField */
+    NewStringDefault = "New Value",
+    /** Add button title, used by AddButton */
+    AddButton = "Add",
+    /** Add button title, used by AddButton */
+    AddItemButton = "Add Item",
+    /** Move down button title, used by IconButton */
+    MoveDownButton = "Move down",
+    /** Move up button title, used by IconButton */
+    MoveUpButton = "Move up",
+    /** Remove button title, used by IconButton */
+    RemoveButton = "Remove",
+    /** Now label, used by AltDateWidget */
+    NowLabel = "Now",
+    /** Clear label, used by AltDateWidget */
+    ClearLabel = "Clear",
+    /** Aria date label, used by DateWidget */
+    AriaDateLabel = "Select a date",
+    /** Decrement button aria label, used by UpDownWidget */
+    DecrementAriaLabel = "Decrease value by 1",
+    /** Increment button aria label, used by UpDownWidget */
+    IncrementAriaLabel = "Increase value by 1",
+    /** Unknown field type reason, where %1 will be replaced with the type as provided by SchemaField */
+    UnknownFieldType = "Unknown field type %1",
+    /** Option prefix, where %1 will be replaced with the option index as provided by MultiSchemaField */
+    OptionPrefix = "Option %1",
+    /** Option prefix, where %1 and %2 will be replaced by the schema title and option index, respectively as provided by
+     * MultiSchemaField
+     */
+    TitleOptionPrefix = "%1 option %2",
+    /** Key label, where %1 will be replaced by the label as provided by WrapIfAdditionalTemplate */
+    KeyLabel = "%1 Key",
+    /** Unsupported field schema, used by UnsupportedField */
+    UnsupportedField = "Unsupported field schema.",
+    /** Unsupported field schema, where %1 will be replaced by the idSchema.$id as provided by UnsupportedField */
+    UnsupportedFieldWithId = "Unsupported field schema for field <code>%1</code>.",
+    /** Unsupported field schema, where %1 will be replaced by the reason string as provided by UnsupportedField */
+    UnsupportedFieldWithReason = "Unsupported field schema: <em>%1</em>.",
+    /** Unsupported field schema, where %1 and %2 will be replaced by the idSchema.$id and reason strings, respectively,
+     * as provided by UnsupportedField
+     */
+    UnsupportedFieldWithIdAndReason = "Unsupported field schema for field <code>%1</code>: <em>%2</em>.",
+    /** File name, type and size info, where %1, %2 and %3 will be replaced by the file name, file type and file size as
+     * provided by FileWidget
+     */
+    FilesInfo = "<strong>%1</strong> (%2, %3 bytes)"
+}
+
 /** The representation of any generic object type, usually used as an intersection on other types to make them more
  * flexible in the properties they support (i.e. anything else)
  */
@@ -123,6 +190,8 @@ type ErrorListProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends
     schema: S;
     /** The uiSchema that was passed to `Form` */
     uiSchema?: UiSchema<T, S, F>;
+    /** The `registry` object */
+    registry: Registry<T, S, F>;
 };
 /** The properties that are passed to an `FieldErrorTemplate` implementation */
 type FieldErrorProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> = {
@@ -232,6 +301,8 @@ interface Registry<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends F
      * of the validation-schema-based utility functions
      */
     schemaUtils: SchemaUtilsType<T, S>;
+    /** The string translation function to use when displaying any of the RJSF strings in templates, fields or widgets */
+    translateString: (stringKey: TranslatableString, params?: string[]) => string;
 }
 /** The properties that are passed to a Field implementation */
 interface FieldProps<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any> extends GenericObjectType, Pick<React.HTMLAttributes<HTMLElement>, Exclude<keyof React.HTMLAttributes<HTMLElement>, "onBlur" | "onFocus" | "onChange">> {
@@ -947,6 +1018,16 @@ declare function dataURItoBlob(dataURI: string): {
  */
 declare function deepEquals(a: any, b: any): boolean;
 
+/** Translates a `TranslatableString` value `stringToTranslate` into english. When a `params` array is provided, each
+ * value in the array is used to replace any of the replaceable parameters in the `stringToTranslate` using the `%1`,
+ * `%2`, etc. replacement specifiers.
+ *
+ * @param stringToTranslate - The `TranslatableString` value to convert to english
+ * @param params - The optional list of replaceable parameter values to substitute into the english string
+ * @returns - The `stringToTranslate` itself with any replaceable parameter values substituted
+ */
+declare function englishStringTranslator(stringToTranslate: TranslatableString, params?: string[]): string;
+
 /** Removes the enum option value at the `valueIndex` from the currently `selected` (list of) value(s). If `selected` is
  * a list, then that list is updated to remove the enum option value with the `valueIndex` in `allEnumOptions`. If it is
  * a single value, then if the enum option value with the `valueIndex` in `allEnumOptions` matches `selected`, undefined
@@ -1324,6 +1405,16 @@ declare function parseDateString(dateString?: string, includeTime?: boolean): Da
  */
 declare function rangeSpec<S extends StrictRJSFSchema = RJSFSchema>(schema: S): RangeSpecType;
 
+/** Potentially substitutes all replaceable parameters with the associated value(s) from the `params` if available. When
+ * a `params` array is provided, each value in the array is used to replace any of the replaceable parameters in the
+ * `inputString` using the `%1`, `%2`, etc. replacement specifiers.
+ *
+ * @param inputString - The string which will be potentially updated with replacement parameters
+ * @param params - The optional list of replaceable parameter values to substitute into the english string
+ * @returns - The updated string with any replacement specifiers replaced
+ */
+declare function replaceStringParameters(inputString: string, params?: string[]): string;
+
 /** Check to see if a `schema` specifies that a value must be true. This happens when:
  * - `schema.const` is truthy
  * - `schema.enum` == `[true]`
@@ -1593,4 +1684,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, 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, ariaDescribedByIds, asNumber, canExpand, createSchemaUtils, dataURItoBlob, deepEquals, descriptionId, 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, 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, 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, TranslatableString, UIOptionsType, UISchemaSubmitButtonOptions, UI_FIELD_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 };

package/dist/utils.cjs.development.js

@@ -1868,6 +1868,36 @@ function dataURItoBlob(dataURI) {
   };
 }
 
+/** Potentially substitutes all replaceable parameters with the associated value(s) from the `params` if available. When
+ * a `params` array is provided, each value in the array is used to replace any of the replaceable parameters in the
+ * `inputString` using the `%1`, `%2`, etc. replacement specifiers.
+ *
+ * @param inputString - The string which will be potentially updated with replacement parameters
+ * @param params - The optional list of replaceable parameter values to substitute into the english string
+ * @returns - The updated string with any replacement specifiers replaced
+ */
+function replaceStringParameters(inputString, params) {
+  var output = inputString;
+  if (Array.isArray(params)) {
+    params.forEach(function (param, index) {
+      output = output.replace("%" + (index + 1), param);
+    });
+  }
+  return output;
+}
+
+/** Translates a `TranslatableString` value `stringToTranslate` into english. When a `params` array is provided, each
+ * value in the array is used to replace any of the replaceable parameters in the `stringToTranslate` using the `%1`,
+ * `%2`, etc. replacement specifiers.
+ *
+ * @param stringToTranslate - The `TranslatableString` value to convert to english
+ * @param params - The optional list of replaceable parameter values to substitute into the english string
+ * @returns - The `stringToTranslate` itself with any replaceable parameter values substituted
+ */
+function englishStringTranslator(stringToTranslate, params) {
+  return replaceStringParameters(stringToTranslate, params);
+}
+
 /** Returns the value(s) from `allEnumOptions` at the index(es) provided by `valueIndex`. If `valueIndex` is not an
  * array AND the index is not valid for `allEnumOptions`, `emptyValue` is returned. If `valueIndex` is an array, AND it
  * contains an invalid index, the returned array will have the resulting undefined values filtered out, leaving only
@@ -2687,6 +2717,76 @@ function utcToLocal(jsonDate) {
   return yyyy + "-" + MM + "-" + dd + "T" + hh + ":" + mm + ":" + ss + "." + SSS;
 }
 
+/** An enumeration of all the translatable strings used by `@rjsf/core` and its themes. The value of each of the
+ * enumeration keys is expected to be the actual english string. Some strings contain replaceable parameter values
+ * as indicated by `%1`, `%2`, etc. The number after the `%` indicates the order of the parameter. The ordering of
+ * parameters is important because some languages may choose to put the second parameter before the first in its
+ * translation. Also, some strings are rendered using `markdown-to-jsx` and thus support markdown and inline html.
+ */
+exports.TranslatableString = void 0;
+(function (TranslatableString) {
+  /** Fallback title of an array item, used by ArrayField */
+  TranslatableString["ArrayItemTitle"] = "Item";
+  /** Missing items reason, used by ArrayField */
+  TranslatableString["MissingItems"] = "Missing items definition";
+  /** Yes label, used by BooleanField */
+  TranslatableString["YesLabel"] = "Yes";
+  /** No label, used by BooleanField */
+  TranslatableString["NoLabel"] = "No";
+  /** Close label, used by ErrorList */
+  TranslatableString["CloseLabel"] = "Close";
+  /** Errors label, used by ErrorList */
+  TranslatableString["ErrorsLabel"] = "Errors";
+  /** New additionalProperties string default value, used by ObjectField */
+  TranslatableString["NewStringDefault"] = "New Value";
+  /** Add button title, used by AddButton */
+  TranslatableString["AddButton"] = "Add";
+  /** Add button title, used by AddButton */
+  TranslatableString["AddItemButton"] = "Add Item";
+  /** Move down button title, used by IconButton */
+  TranslatableString["MoveDownButton"] = "Move down";
+  /** Move up button title, used by IconButton */
+  TranslatableString["MoveUpButton"] = "Move up";
+  /** Remove button title, used by IconButton */
+  TranslatableString["RemoveButton"] = "Remove";
+  /** Now label, used by AltDateWidget */
+  TranslatableString["NowLabel"] = "Now";
+  /** Clear label, used by AltDateWidget */
+  TranslatableString["ClearLabel"] = "Clear";
+  /** Aria date label, used by DateWidget */
+  TranslatableString["AriaDateLabel"] = "Select a date";
+  /** Decrement button aria label, used by UpDownWidget */
+  TranslatableString["DecrementAriaLabel"] = "Decrease value by 1";
+  /** Increment button aria label, used by UpDownWidget */
+  TranslatableString["IncrementAriaLabel"] = "Increase value by 1";
+  // Strings with replaceable parameters
+  /** Unknown field type reason, where %1 will be replaced with the type as provided by SchemaField */
+  TranslatableString["UnknownFieldType"] = "Unknown field type %1";
+  /** Option prefix, where %1 will be replaced with the option index as provided by MultiSchemaField */
+  TranslatableString["OptionPrefix"] = "Option %1";
+  /** Option prefix, where %1 and %2 will be replaced by the schema title and option index, respectively as provided by
+   * MultiSchemaField
+   */
+  TranslatableString["TitleOptionPrefix"] = "%1 option %2";
+  /** Key label, where %1 will be replaced by the label as provided by WrapIfAdditionalTemplate */
+  TranslatableString["KeyLabel"] = "%1 Key";
+  // Strings with replaceable parameters AND/OR that support markdown and html
+  /** Unsupported field schema, used by UnsupportedField */
+  TranslatableString["UnsupportedField"] = "Unsupported field schema.";
+  /** Unsupported field schema, where %1 will be replaced by the idSchema.$id as provided by UnsupportedField */
+  TranslatableString["UnsupportedFieldWithId"] = "Unsupported field schema for field <code>%1</code>.";
+  /** Unsupported field schema, where %1 will be replaced by the reason string as provided by UnsupportedField */
+  TranslatableString["UnsupportedFieldWithReason"] = "Unsupported field schema: <em>%1</em>.";
+  /** Unsupported field schema, where %1 and %2 will be replaced by the idSchema.$id and reason strings, respectively,
+   * as provided by UnsupportedField
+   */
+  TranslatableString["UnsupportedFieldWithIdAndReason"] = "Unsupported field schema for field <code>%1</code>: <em>%2</em>.";
+  /** File name, type and size info, where %1, %2 and %3 will be replaced by the file name, file type and file size as
+   * provided by FileWidget
+   */
+  TranslatableString["FilesInfo"] = "<strong>%1</strong> (%2, %3 bytes)";
+})(exports.TranslatableString || (exports.TranslatableString = {}));
+
 exports.ADDITIONAL_PROPERTIES_KEY = ADDITIONAL_PROPERTIES_KEY;
 exports.ADDITIONAL_PROPERTY_FLAG = ADDITIONAL_PROPERTY_FLAG;
 exports.ALL_OF_KEY = ALL_OF_KEY;
@@ -2718,6 +2818,7 @@ exports.createSchemaUtils = createSchemaUtils;
 exports.dataURItoBlob = dataURItoBlob;
 exports.deepEquals = deepEquals;
 exports.descriptionId = descriptionId;
+exports.englishStringTranslator = englishStringTranslator;
 exports.enumOptionsDeselectValue = enumOptionsDeselectValue;
 exports.enumOptionsIndexForValue = enumOptionsIndexForValue;
 exports.enumOptionsIsSelected = enumOptionsIsSelected;
@@ -2758,6 +2859,7 @@ exports.orderProperties = orderProperties;
 exports.pad = pad;
 exports.parseDateString = parseDateString;
 exports.rangeSpec = rangeSpec;
+exports.replaceStringParameters = replaceStringParameters;
 exports.retrieveSchema = retrieveSchema;
 exports.sanitizeDataForNewSchema = sanitizeDataForNewSchema;
 exports.schemaRequiresTrueValue = schemaRequiresTrueValue;