@rjsf/utils 5.0.2 → 5.2.0

package/dist/utils.esm.js

@@ -1071,17 +1071,48 @@ function getInnerSchemaForArrayItem(schema, additionalItems, idx) {
   }
   return {};
 }
+/** Either add `computedDefault` at `key` into `obj` or not add it based on its value and the value of
+ * `includeUndefinedValues`. Generally undefined `computedDefault` values are added only when `includeUndefinedValues`
+ * is either true or "excludeObjectChildren". If `includeUndefinedValues` is false, then non-undefined and
+ * non-empty-object values will be added.
+ *
+ * @param obj - The object into which the computed default may be added
+ * @param key - The key into the object at which the computed default may be added
+ * @param computedDefault - The computed default value that maybe should be added to the obj
+ * @param includeUndefinedValues - Optional flag, if true, cause undefined values to be added as defaults.
+ *          If "excludeObjectChildren", cause undefined values for this object and pass `includeUndefinedValues` as
+ *          false when computing defaults for any nested object properties. If "allowEmptyObject", prevents undefined
+ *          values in this object while allow the object itself to be empty and passing `includeUndefinedValues` as
+ *          false when computing defaults for any nested object properties.
+ * @param requiredFields - The list of fields that are required
+ */
+function maybeAddDefaultToObject(obj, key, computedDefault, includeUndefinedValues, requiredFields) {
+  if (requiredFields === void 0) {
+    requiredFields = [];
+  }
+  if (includeUndefinedValues) {
+    obj[key] = computedDefault;
+  } else if (isObject(computedDefault)) {
+    // Store computedDefault if it's a non-empty object (e.g. not {})
+    if (!isEmpty(computedDefault) || requiredFields.includes(key)) {
+      obj[key] = computedDefault;
+    }
+  } else if (computedDefault !== undefined) {
+    // Store computedDefault if it's a defined primitive (e.g. true)
+    obj[key] = computedDefault;
+  }
+}
 /** Computes the defaults for the current `schema` given the `rawFormData` and `parentDefaults` if any. This drills into
  * each level of the schema, recursively, to fill out every level of defaults provided by the schema.
  *
  * @param validator - an implementation of the `ValidatorType` interface that will be used when necessary
- * @param schema - The schema for which the default state is desired
+ * @param rawSchema - The schema for which the default state is desired
  * @param [parentDefaults] - Any defaults provided by the parent field in the schema
  * @param [rootSchema] - The options root schema, used to primarily to look up `$ref`s
  * @param [rawFormData] - The current formData, if any, onto which to provide any missing defaults
  * @param [includeUndefinedValues=false] - Optional flag, if true, cause undefined values to be added as defaults.
- *          If "excludeObjectChildren", pass `includeUndefinedValues` as false when computing defaults for any nested
- *          object properties.
+ *          If "excludeObjectChildren", cause undefined values for this object and pass `includeUndefinedValues` as
+ *          false when computing defaults for any nested object properties.
  * @returns - The resulting `formData` with all the defaults provided
  */
 function computeDefaults(validator, rawSchema, parentDefaults, rootSchema, rawFormData, includeUndefinedValues) {
@@ -1113,8 +1144,14 @@ function computeDefaults(validator, rawSchema, parentDefaults, rootSchema, rawFo
       return computeDefaults(validator, itemSchema, Array.isArray(parentDefaults) ? parentDefaults[idx] : undefined, rootSchema, formData, includeUndefinedValues);
     });
   } else if (ONE_OF_KEY in schema) {
+    if (schema.oneOf.length === 0) {
+      return undefined;
+    }
     schema = schema.oneOf[getClosestMatchingOption(validator, rootSchema, isEmpty(formData) ? undefined : formData, schema.oneOf, 0)];
   } else if (ANY_OF_KEY in schema) {
+    if (schema.anyOf.length === 0) {
+      return undefined;
+    }
     schema = schema.anyOf[getClosestMatchingOption(validator, rootSchema, isEmpty(formData) ? undefined : formData, schema.anyOf, 0)];
   }
   // Not defaults defined for this node, fallback to generic typed ones.
@@ -1124,23 +1161,25 @@ function computeDefaults(validator, rawSchema, parentDefaults, rootSchema, rawFo
   switch (getSchemaType(schema)) {
     // We need to recur for object schema inner default values.
     case "object":
-      return Object.keys(schema.properties || {}).reduce(function (acc, key) {
-        // Compute the defaults for this node, with the parent defaults we might
-        // have from a previous run: defaults[key].
-        var computedDefault = computeDefaults(validator, get(schema, [PROPERTIES_KEY, key]), get(defaults, [key]), rootSchema, get(formData, [key]), includeUndefinedValues === "excludeObjectChildren" ? false : includeUndefinedValues);
-        if (includeUndefinedValues) {
-          acc[key] = computedDefault;
-        } else if (isObject(computedDefault)) {
-          // Store computedDefault if it's a non-empty object (e.g. not {})
-          if (!isEmpty(computedDefault)) {
-            acc[key] = computedDefault;
-          }
-        } else if (computedDefault !== undefined) {
-          // Store computedDefault if it's a defined primitive (e.g. true)
-          acc[key] = computedDefault;
+      {
+        var objectDefaults = Object.keys(schema.properties || {}).reduce(function (acc, key) {
+          // Compute the defaults for this node, with the parent defaults we might
+          // have from a previous run: defaults[key].
+          var computedDefault = computeDefaults(validator, get(schema, [PROPERTIES_KEY, key]), get(defaults, [key]), rootSchema, get(formData, [key]), includeUndefinedValues === true);
+          maybeAddDefaultToObject(acc, key, computedDefault, includeUndefinedValues, schema.required);
+          return acc;
+        }, {});
+        if (schema.additionalProperties && isObject(defaults)) {
+          var additionalPropertiesSchema = isObject(schema.additionalProperties) ? schema.additionalProperties : {}; // as per spec additionalProperties may be either schema or boolean
+          Object.keys(defaults).filter(function (key) {
+            return !schema.properties || !schema.properties[key];
+          }).forEach(function (key) {
+            var computedDefault = computeDefaults(validator, additionalPropertiesSchema, get(defaults, [key]), rootSchema, get(formData, [key]), includeUndefinedValues === true);
+            maybeAddDefaultToObject(objectDefaults, key, computedDefault, includeUndefinedValues);
+          });
         }
-        return acc;
-      }, {});
+        return objectDefaults;
+      }
     case "array":
       // Inject defaults into existing array defaults
       if (Array.isArray(defaults)) {
@@ -1182,8 +1221,8 @@ function computeDefaults(validator, rawSchema, parentDefaults, rootSchema, rawFo
  * @param [formData] - The current formData, if any, onto which to provide any missing defaults
  * @param [rootSchema] - The root schema, used to primarily to look up `$ref`s
  * @param [includeUndefinedValues=false] - Optional flag, if true, cause undefined values to be added as defaults.
- *          If "excludeObjectChildren", pass `includeUndefinedValues` as false when computing defaults for any nested
- *          object properties.
+ *          If "excludeObjectChildren", cause undefined values for this object and pass `includeUndefinedValues` as
+ *          false when computing defaults for any nested object properties.
  * @returns - The resulting `formData` with all the defaults provided
  */
 function getDefaultFormState(validator, theSchema, formData, rootSchema, includeUndefinedValues) {
@@ -1805,6 +1844,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
@@ -2624,5 +2693,75 @@ function utcToLocal(jsonDate) {
   return yyyy + "-" + MM + "-" + dd + "T" + hh + ":" + mm + ":" + ss + "." + SSS;
 }
 
-export { ADDITIONAL_PROPERTIES_KEY, ADDITIONAL_PROPERTY_FLAG, ALL_OF_KEY, ANY_OF_KEY, CONST_KEY, DEFAULT_KEY, DEFINITIONS_KEY, DEPENDENCIES_KEY, ENUM_KEY, ERRORS_KEY, ErrorSchemaBuilder, ID_KEY, ITEMS_KEY, NAME_KEY, ONE_OF_KEY, PROPERTIES_KEY, REF_KEY, REQUIRED_KEY, RJSF_ADDITONAL_PROPERTIES_FLAG, SUBMIT_BTN_OPTIONS_KEY, UI_FIELD_KEY, UI_OPTIONS_KEY, UI_WIDGET_KEY, 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 };
+/** 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.
+ */
+var TranslatableString;
+(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)";
+})(TranslatableString || (TranslatableString = {}));
+
+export { ADDITIONAL_PROPERTIES_KEY, ADDITIONAL_PROPERTY_FLAG, ALL_OF_KEY, ANY_OF_KEY, CONST_KEY, DEFAULT_KEY, DEFINITIONS_KEY, DEPENDENCIES_KEY, ENUM_KEY, ERRORS_KEY, ErrorSchemaBuilder, ID_KEY, ITEMS_KEY, NAME_KEY, ONE_OF_KEY, PROPERTIES_KEY, REF_KEY, REQUIRED_KEY, RJSF_ADDITONAL_PROPERTIES_FLAG, SUBMIT_BTN_OPTIONS_KEY, TranslatableString, UI_FIELD_KEY, UI_OPTIONS_KEY, UI_WIDGET_KEY, 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 };
 //# sourceMappingURL=utils.esm.js.map