@rjsf/utils 5.1.0 → 5.2.0

package/dist/utils.umd.development.js

@@ -1852,6 +1852,36 @@
     };
   }
 
+  /** 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
@@ -2671,6 +2701,76 @@
     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;
@@ -2702,6 +2802,7 @@
   exports.dataURItoBlob = dataURItoBlob;
   exports.deepEquals = deepEquals;
   exports.descriptionId = descriptionId;
+  exports.englishStringTranslator = englishStringTranslator;
   exports.enumOptionsDeselectValue = enumOptionsDeselectValue;
   exports.enumOptionsIndexForValue = enumOptionsIndexForValue;
   exports.enumOptionsIsSelected = enumOptionsIsSelected;
@@ -2742,6 +2843,7 @@
   exports.pad = pad;
   exports.parseDateString = parseDateString;
   exports.rangeSpec = rangeSpec;
+  exports.replaceStringParameters = replaceStringParameters;
   exports.retrieveSchema = retrieveSchema;
   exports.sanitizeDataForNewSchema = sanitizeDataForNewSchema;
   exports.schemaRequiresTrueValue = schemaRequiresTrueValue;