@rjsf/utils 5.11.2 → 5.12.0

package/lib/schema/getDefaultFormState.d.ts

@@ -0,0 +1,66 @@
+import { Experimental_DefaultFormStateBehavior, FormContextType, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types';
+/** Enum that indicates how `schema.additionalItems` should be handled by the `getInnerSchemaForArrayItem()` function.
+ */
+export declare enum AdditionalItemsHandling {
+    Ignore = 0,
+    Invert = 1,
+    Fallback = 2
+}
+/** Given a `schema` will return an inner schema that for an array item. This is computed differently based on the
+ * `additionalItems` enum and the value of `idx`. There are four possible returns:
+ * 1. If `idx` is >= 0, then if `schema.items` is an array the `idx`th element of the array is returned if it is a valid
+ *    index and not a boolean, otherwise it falls through to 3.
+ * 2. If `schema.items` is not an array AND truthy and not a boolean, then `schema.items` is returned since it actually
+ *    is a schema, otherwise it falls through to 3.
+ * 3. If `additionalItems` is not `AdditionalItemsHandling.Ignore` and `schema.additionalItems` is an object, then
+ *    `schema.additionalItems` is returned since it actually is a schema, otherwise it falls through to 4.
+ * 4. {} is returned representing an empty schema
+ *
+ * @param schema - The schema from which to get the particular item
+ * @param [additionalItems=AdditionalItemsHandling.Ignore] - How do we want to handle additional items?
+ * @param [idx=-1] - Index, if non-negative, will be used to return the idx-th element in a `schema.items` array
+ * @returns - The best fit schema object from the `schema` given the `additionalItems` and `idx` modifiers
+ */
+export declare function getInnerSchemaForArrayItem<S extends StrictRJSFSchema = RJSFSchema>(schema: S, additionalItems?: AdditionalItemsHandling, idx?: number): S;
+interface ComputeDefaultsProps<T = any, S extends StrictRJSFSchema = RJSFSchema> {
+    parentDefaults?: T;
+    rootSchema?: S;
+    rawFormData?: T;
+    includeUndefinedValues?: boolean | 'excludeObjectChildren';
+    _recurseList?: string[];
+    experimental_defaultFormStateBehavior?: Experimental_DefaultFormStateBehavior;
+    required?: boolean;
+}
+/** 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 rawSchema - The schema for which the default state is desired
+ * @param [props] - Optional props for this function
+ * @param [props.parentDefaults] - Any defaults provided by the parent field in the schema
+ * @param [props.rootSchema] - The options root schema, used to primarily to look up `$ref`s
+ * @param [props.rawFormData] - The current formData, if any, onto which to provide any missing defaults
+ * @param [props.includeUndefinedValues=false] - 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.
+ * @param [props._recurseList=[]] - The list of ref names currently being recursed, used to prevent infinite recursion
+ * @param [props.experimental_defaultFormStateBehavior] Optional configuration object, if provided, allows users to override default form state behavior
+ * @param [props.required] - Optional flag, if true, indicates this schema was required in the parent schema.
+ * @returns - The resulting `formData` with all the defaults provided
+ */
+export declare function computeDefaults<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, rawSchema: S, { parentDefaults, rawFormData, rootSchema, includeUndefinedValues, _recurseList, experimental_defaultFormStateBehavior, required, }?: ComputeDefaultsProps<T, S>): T | T[] | undefined;
+/** 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`.
+ *
+ * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
+ * @param theSchema - The schema for which the default state is desired
+ * @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", cause undefined values for this object and pass `includeUndefinedValues` as
+ *          false when computing defaults for any nested object properties.
+ * @param [experimental_defaultFormStateBehavior] Optional configuration object, if provided, allows users to override default form state behavior
+ * @returns - The resulting `formData` with all the defaults provided
+ */
+export default 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', experimental_defaultFormStateBehavior?: Experimental_DefaultFormStateBehavior): T | T[] | undefined;
+export {};

package/lib/schema/getDefaultFormState.js

@@ -0,0 +1,351 @@
+import { __rest } from "tslib";
+import get from 'lodash/get';
+import isEmpty from 'lodash/isEmpty';
+import { ANY_OF_KEY, DEFAULT_KEY, DEPENDENCIES_KEY, PROPERTIES_KEY, ONE_OF_KEY, REF_KEY } from '../constants';
+import findSchemaDefinition from '../findSchemaDefinition';
+import getClosestMatchingOption from './getClosestMatchingOption';
+import getDiscriminatorFieldFromSchema from '../getDiscriminatorFieldFromSchema';
+import getSchemaType from '../getSchemaType';
+import isObject from '../isObject';
+import isFixedItems from '../isFixedItems';
+import mergeDefaultsWithFormData from '../mergeDefaultsWithFormData';
+import mergeObjects from '../mergeObjects';
+import mergeSchemas from '../mergeSchemas';
+import isMultiSelect from './isMultiSelect';
+import retrieveSchema, { resolveDependencies } from './retrieveSchema';
+/** Enum that indicates how `schema.additionalItems` should be handled by the `getInnerSchemaForArrayItem()` function.
+ */
+export var AdditionalItemsHandling;
+(function (AdditionalItemsHandling) {
+    AdditionalItemsHandling[AdditionalItemsHandling["Ignore"] = 0] = "Ignore";
+    AdditionalItemsHandling[AdditionalItemsHandling["Invert"] = 1] = "Invert";
+    AdditionalItemsHandling[AdditionalItemsHandling["Fallback"] = 2] = "Fallback";
+})(AdditionalItemsHandling || (AdditionalItemsHandling = {}));
+/** Given a `schema` will return an inner schema that for an array item. This is computed differently based on the
+ * `additionalItems` enum and the value of `idx`. There are four possible returns:
+ * 1. If `idx` is >= 0, then if `schema.items` is an array the `idx`th element of the array is returned if it is a valid
+ *    index and not a boolean, otherwise it falls through to 3.
+ * 2. If `schema.items` is not an array AND truthy and not a boolean, then `schema.items` is returned since it actually
+ *    is a schema, otherwise it falls through to 3.
+ * 3. If `additionalItems` is not `AdditionalItemsHandling.Ignore` and `schema.additionalItems` is an object, then
+ *    `schema.additionalItems` is returned since it actually is a schema, otherwise it falls through to 4.
+ * 4. {} is returned representing an empty schema
+ *
+ * @param schema - The schema from which to get the particular item
+ * @param [additionalItems=AdditionalItemsHandling.Ignore] - How do we want to handle additional items?
+ * @param [idx=-1] - Index, if non-negative, will be used to return the idx-th element in a `schema.items` array
+ * @returns - The best fit schema object from the `schema` given the `additionalItems` and `idx` modifiers
+ */
+export function getInnerSchemaForArrayItem(schema, additionalItems = AdditionalItemsHandling.Ignore, idx = -1) {
+    if (idx >= 0) {
+        if (Array.isArray(schema.items) && idx < schema.items.length) {
+            const item = schema.items[idx];
+            if (typeof item !== 'boolean') {
+                return item;
+            }
+        }
+    }
+    else if (schema.items && !Array.isArray(schema.items) && typeof schema.items !== 'boolean') {
+        return schema.items;
+    }
+    if (additionalItems !== AdditionalItemsHandling.Ignore && isObject(schema.additionalItems)) {
+        return schema.additionalItems;
+    }
+    return {};
+}
+/** Either add `computedDefault` at `key` into `obj` or not add it based on its value, the value of
+ * `includeUndefinedValues`, the value of `emptyObjectFields` and if its parent field is required. Generally undefined
+ * `computedDefault` values are added only when `includeUndefinedValues` is either true/"excludeObjectChildren". If `
+ * includeUndefinedValues` is false and `emptyObjectFields` is not "skipDefaults", then non-undefined and non-empty-object
+ * values will be added based on certain conditions.
+ *
+ * @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 isParentRequired - The optional boolean that indicates whether the parent field is required
+ * @param requiredFields - The list of fields that are required
+ * @param experimental_defaultFormStateBehavior - Optional configuration object, if provided, allows users to override
+ *        default form state behavior
+ */
+function maybeAddDefaultToObject(obj, key, computedDefault, includeUndefinedValues, isParentRequired, requiredFields = [], experimental_defaultFormStateBehavior = {}) {
+    const { emptyObjectFields = 'populateAllDefaults' } = experimental_defaultFormStateBehavior;
+    if (includeUndefinedValues) {
+        obj[key] = computedDefault;
+    }
+    else if (emptyObjectFields !== 'skipDefaults') {
+        if (isObject(computedDefault)) {
+            // If isParentRequired is undefined, then we are at the root level of the schema so defer to the requiredness of
+            // the field key itself in the `requiredField` list
+            const isSelfOrParentRequired = isParentRequired === undefined ? requiredFields.includes(key) : isParentRequired;
+            // Store computedDefault if it's a non-empty object(e.g. not {}) and satisfies certain conditions
+            // Condition 1: If computedDefault is not empty or if the key is a required field
+            // Condition 2: If the parent object is required or emptyObjectFields is not 'populateRequiredDefaults'
+            if ((!isEmpty(computedDefault) || requiredFields.includes(key)) &&
+                (isSelfOrParentRequired || emptyObjectFields !== 'populateRequiredDefaults')) {
+                obj[key] = computedDefault;
+            }
+        }
+        else if (
+        // Store computedDefault if it's a defined primitive (e.g., true) and satisfies certain conditions
+        // Condition 1: computedDefault is not undefined
+        // Condition 2: If emptyObjectFields is 'populateAllDefaults' or if the key is a required field
+        computedDefault !== undefined &&
+            (emptyObjectFields === 'populateAllDefaults' || requiredFields.includes(key))) {
+            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 rawSchema - The schema for which the default state is desired
+ * @param [props] - Optional props for this function
+ * @param [props.parentDefaults] - Any defaults provided by the parent field in the schema
+ * @param [props.rootSchema] - The options root schema, used to primarily to look up `$ref`s
+ * @param [props.rawFormData] - The current formData, if any, onto which to provide any missing defaults
+ * @param [props.includeUndefinedValues=false] - 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.
+ * @param [props._recurseList=[]] - The list of ref names currently being recursed, used to prevent infinite recursion
+ * @param [props.experimental_defaultFormStateBehavior] Optional configuration object, if provided, allows users to override default form state behavior
+ * @param [props.required] - Optional flag, if true, indicates this schema was required in the parent schema.
+ * @returns - The resulting `formData` with all the defaults provided
+ */
+export function computeDefaults(validator, rawSchema, { parentDefaults, rawFormData, rootSchema = {}, includeUndefinedValues = false, _recurseList = [], experimental_defaultFormStateBehavior = undefined, required, } = {}) {
+    var _a, _b;
+    const formData = (isObject(rawFormData) ? rawFormData : {});
+    const schema = isObject(rawSchema) ? rawSchema : {};
+    // Compute the defaults recursively: give highest priority to deepest nodes.
+    let defaults = parentDefaults;
+    // If we get a new schema, then we need to recompute defaults again for the new schema found.
+    let schemaToCompute = null;
+    let updatedRecurseList = _recurseList;
+    if (isObject(defaults) && isObject(schema.default)) {
+        // For object defaults, only override parent defaults that are defined in
+        // schema.default.
+        defaults = mergeObjects(defaults, schema.default);
+    }
+    else if (DEFAULT_KEY in schema) {
+        defaults = schema.default;
+    }
+    else if (REF_KEY in schema) {
+        const refName = schema[REF_KEY];
+        // Use referenced schema defaults for this node.
+        if (!_recurseList.includes(refName)) {
+            updatedRecurseList = _recurseList.concat(refName);
+            schemaToCompute = findSchemaDefinition(refName, rootSchema);
+        }
+    }
+    else if (DEPENDENCIES_KEY in schema) {
+        const resolvedSchema = resolveDependencies(validator, schema, rootSchema, false, formData);
+        schemaToCompute = resolvedSchema[0]; // pick the first element from resolve dependencies
+    }
+    else if (isFixedItems(schema)) {
+        defaults = schema.items.map((itemSchema, idx) => computeDefaults(validator, itemSchema, {
+            rootSchema,
+            includeUndefinedValues,
+            _recurseList,
+            experimental_defaultFormStateBehavior,
+            parentDefaults: Array.isArray(parentDefaults) ? parentDefaults[idx] : undefined,
+            rawFormData: formData,
+            required,
+        }));
+    }
+    else if (ONE_OF_KEY in schema) {
+        const { oneOf } = schema, remaining = __rest(schema, ["oneOf"]);
+        if (oneOf.length === 0) {
+            return undefined;
+        }
+        const discriminator = getDiscriminatorFieldFromSchema(schema);
+        schemaToCompute = oneOf[getClosestMatchingOption(validator, rootSchema, isEmpty(formData) ? undefined : formData, oneOf, 0, discriminator)];
+        schemaToCompute = mergeSchemas(remaining, schemaToCompute);
+    }
+    else if (ANY_OF_KEY in schema) {
+        const { anyOf } = schema, remaining = __rest(schema, ["anyOf"]);
+        if (anyOf.length === 0) {
+            return undefined;
+        }
+        const discriminator = getDiscriminatorFieldFromSchema(schema);
+        schemaToCompute = anyOf[getClosestMatchingOption(validator, rootSchema, isEmpty(formData) ? undefined : formData, anyOf, 0, discriminator)];
+        schemaToCompute = mergeSchemas(remaining, schemaToCompute);
+    }
+    if (schemaToCompute) {
+        return computeDefaults(validator, schemaToCompute, {
+            rootSchema,
+            includeUndefinedValues,
+            _recurseList: updatedRecurseList,
+            experimental_defaultFormStateBehavior,
+            parentDefaults: defaults,
+            rawFormData: formData,
+            required,
+        });
+    }
+    // No defaults defined for this node, fallback to generic typed ones.
+    if (defaults === undefined) {
+        defaults = schema.default;
+    }
+    switch (getSchemaType(schema)) {
+        // We need to recurse for object schema inner default values.
+        case 'object': {
+            const objectDefaults = Object.keys(schema.properties || {}).reduce((acc, key) => {
+                var _a;
+                // Compute the defaults for this node, with the parent defaults we might
+                // have from a previous run: defaults[key].
+                const computedDefault = computeDefaults(validator, get(schema, [PROPERTIES_KEY, key]), {
+                    rootSchema,
+                    _recurseList,
+                    experimental_defaultFormStateBehavior,
+                    includeUndefinedValues: includeUndefinedValues === true,
+                    parentDefaults: get(defaults, [key]),
+                    rawFormData: get(formData, [key]),
+                    required: (_a = schema.required) === null || _a === void 0 ? void 0 : _a.includes(key),
+                });
+                maybeAddDefaultToObject(acc, key, computedDefault, includeUndefinedValues, required, schema.required, experimental_defaultFormStateBehavior);
+                return acc;
+            }, {});
+            if (schema.additionalProperties) {
+                // as per spec additionalProperties may be either schema or boolean
+                const additionalPropertiesSchema = isObject(schema.additionalProperties) ? schema.additionalProperties : {};
+                const keys = new Set();
+                if (isObject(defaults)) {
+                    Object.keys(defaults)
+                        .filter((key) => !schema.properties || !schema.properties[key])
+                        .forEach((key) => keys.add(key));
+                }
+                let formDataRequired;
+                if (isObject(formData)) {
+                    formDataRequired = [];
+                    Object.keys(formData)
+                        .filter((key) => !schema.properties || !schema.properties[key])
+                        .forEach((key) => {
+                        keys.add(key);
+                        formDataRequired.push(key);
+                    });
+                }
+                keys.forEach((key) => {
+                    var _a;
+                    const computedDefault = computeDefaults(validator, additionalPropertiesSchema, {
+                        rootSchema,
+                        _recurseList,
+                        experimental_defaultFormStateBehavior,
+                        includeUndefinedValues: includeUndefinedValues === true,
+                        parentDefaults: get(defaults, [key]),
+                        rawFormData: get(formData, [key]),
+                        required: (_a = schema.required) === null || _a === void 0 ? void 0 : _a.includes(key),
+                    });
+                    // Since these are additional properties we don’t need to add the `experimental_defaultFormStateBehavior` prop
+                    maybeAddDefaultToObject(objectDefaults, key, computedDefault, includeUndefinedValues, required, formDataRequired);
+                });
+            }
+            return objectDefaults;
+        }
+        case 'array': {
+            const neverPopulate = ((_a = experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.arrayMinItems) === null || _a === void 0 ? void 0 : _a.populate) === 'never';
+            const ignoreMinItemsFlagSet = ((_b = experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.arrayMinItems) === null || _b === void 0 ? void 0 : _b.populate) === 'requiredOnly';
+            // Inject defaults into existing array defaults
+            if (Array.isArray(defaults)) {
+                defaults = defaults.map((item, idx) => {
+                    const schemaItem = getInnerSchemaForArrayItem(schema, AdditionalItemsHandling.Fallback, idx);
+                    return computeDefaults(validator, schemaItem, {
+                        rootSchema,
+                        _recurseList,
+                        experimental_defaultFormStateBehavior,
+                        parentDefaults: item,
+                        required,
+                    });
+                });
+            }
+            // Deeply inject defaults into already existing form data
+            if (Array.isArray(rawFormData)) {
+                const schemaItem = getInnerSchemaForArrayItem(schema);
+                if (neverPopulate) {
+                    defaults = rawFormData;
+                }
+                else {
+                    defaults = rawFormData.map((item, idx) => {
+                        return computeDefaults(validator, schemaItem, {
+                            rootSchema,
+                            _recurseList,
+                            experimental_defaultFormStateBehavior,
+                            rawFormData: item,
+                            parentDefaults: get(defaults, [idx]),
+                            required,
+                        });
+                    });
+                }
+            }
+            if (neverPopulate) {
+                return defaults !== null && defaults !== void 0 ? defaults : [];
+            }
+            if (ignoreMinItemsFlagSet && !required) {
+                // If no form data exists or defaults are set leave the field empty/non-existent, otherwise
+                // return form data/defaults
+                return defaults ? defaults : undefined;
+            }
+            const defaultsLength = Array.isArray(defaults) ? defaults.length : 0;
+            if (!schema.minItems ||
+                isMultiSelect(validator, schema, rootSchema) ||
+                schema.minItems <= defaultsLength) {
+                return defaults ? defaults : [];
+            }
+            const defaultEntries = (defaults || []);
+            const fillerSchema = getInnerSchemaForArrayItem(schema, AdditionalItemsHandling.Invert);
+            const fillerDefault = fillerSchema.default;
+            // Calculate filler entries for remaining items (minItems - existing raw data/defaults)
+            const fillerEntries = new Array(schema.minItems - defaultsLength).fill(computeDefaults(validator, fillerSchema, {
+                parentDefaults: fillerDefault,
+                rootSchema,
+                _recurseList,
+                experimental_defaultFormStateBehavior,
+                required,
+            }));
+            // then fill up the rest with either the item default or empty, up to minItems
+            return defaultEntries.concat(fillerEntries);
+        }
+    }
+    return defaults;
+}
+/** 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`.
+ *
+ * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
+ * @param theSchema - The schema for which the default state is desired
+ * @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", cause undefined values for this object and pass `includeUndefinedValues` as
+ *          false when computing defaults for any nested object properties.
+ * @param [experimental_defaultFormStateBehavior] Optional configuration object, if provided, allows users to override default form state behavior
+ * @returns - The resulting `formData` with all the defaults provided
+ */
+export default function getDefaultFormState(validator, theSchema, formData, rootSchema, includeUndefinedValues = false, experimental_defaultFormStateBehavior) {
+    if (!isObject(theSchema)) {
+        throw new Error('Invalid schema: ' + theSchema);
+    }
+    const schema = retrieveSchema(validator, theSchema, rootSchema, formData);
+    const defaults = computeDefaults(validator, schema, {
+        rootSchema,
+        includeUndefinedValues,
+        experimental_defaultFormStateBehavior,
+        rawFormData: formData,
+    });
+    if (formData === undefined || formData === null || (typeof formData === 'number' && isNaN(formData))) {
+        // No form data? Use schema defaults.
+        return defaults;
+    }
+    const { mergeExtraDefaults } = (experimental_defaultFormStateBehavior === null || experimental_defaultFormStateBehavior === void 0 ? void 0 : experimental_defaultFormStateBehavior.arrayMinItems) || {};
+    if (isObject(formData)) {
+        return mergeDefaultsWithFormData(defaults, formData, mergeExtraDefaults);
+    }
+    if (Array.isArray(formData)) {
+        return mergeDefaultsWithFormData(defaults, formData, mergeExtraDefaults);
+    }
+    return formData;
+}
+//# sourceMappingURL=getDefaultFormState.js.map

package/lib/schema/getDefaultFormState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDefaultFormState.js","sourceRoot":"","sources":["../../src/schema/getDefaultFormState.ts"],"names":[],"mappings":";AAAA,OAAO,GAAG,MAAM,YAAY,CAAC;AAC7B,OAAO,OAAO,MAAM,gBAAgB,CAAC;AAErC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC9G,OAAO,oBAAoB,MAAM,yBAAyB,CAAC;AAC3D,OAAO,wBAAwB,MAAM,4BAA4B,CAAC;AAClE,OAAO,+BAA+B,MAAM,oCAAoC,CAAC;AACjF,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAC7C,OAAO,QAAQ,MAAM,aAAa,CAAC;AACnC,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAC3C,OAAO,yBAAyB,MAAM,8BAA8B,CAAC;AACrE,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAC3C,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAS3C,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAC5C,OAAO,cAAc,EAAE,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvE;GACG;AACH,MAAM,CAAN,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,yEAAM,CAAA;IACN,yEAAM,CAAA;IACN,6EAAQ,CAAA;AACV,CAAC,EAJW,uBAAuB,KAAvB,uBAAuB,QAIlC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,0BAA0B,CACxC,MAAS,EACT,kBAA2C,uBAAuB,CAAC,MAAM,EACzE,GAAG,GAAG,CAAC,CAAC;IAER,IAAI,GAAG,IAAI,CAAC,EAAE;QACZ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,EAAE;YAC5D,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC/B,IAAI,OAAO,IAAI,KAAK,SAAS,EAAE;gBAC7B,OAAO,IAAS,CAAC;aAClB;SACF;KACF;SAAM,IAAI,MAAM,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE;QAC5F,OAAO,MAAM,CAAC,KAAU,CAAC;KAC1B;IACD,IAAI,eAAe,KAAK,uBAAuB,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE;QAC1F,OAAO,MAAM,CAAC,eAAoB,CAAC;KACpC;IACD,OAAO,EAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAS,uBAAuB,CAC9B,GAAsB,EACtB,GAAW,EACX,eAAoC,EACpC,sBAAyD,EACzD,gBAA0B,EAC1B,iBAA2B,EAAE,EAC7B,wCAA+E,EAAE;IAEjF,MAAM,EAAE,iBAAiB,GAAG,qBAAqB,EAAE,GAAG,qCAAqC,CAAC;IAC5F,IAAI,sBAAsB,EAAE;QAC1B,GAAG,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC;KAC5B;SAAM,IAAI,iBAAiB,KAAK,cAAc,EAAE;QAC/C,IAAI,QAAQ,CAAC,eAAe,CAAC,EAAE;YAC7B,gHAAgH;YAChH,mDAAmD;YACnD,MAAM,sBAAsB,GAAG,gBAAgB,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC;YAChH,iGAAiG;YACjG,iFAAiF;YACjF,uGAAuG;YACvG,IACE,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC3D,CAAC,sBAAsB,IAAI,iBAAiB,KAAK,0BAA0B,CAAC,EAC5E;gBACA,GAAG,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC;aAC5B;SACF;aAAM;QACL,kGAAkG;QAClG,gDAAgD;QAChD,+FAA+F;QAC/F,eAAe,KAAK,SAAS;YAC7B,CAAC,iBAAiB,KAAK,qBAAqB,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAC7E;YACA,GAAG,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC;SAC5B;KACF;AACH,CAAC;AAYD;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,eAAe,CAC7B,SAAiC,EACjC,SAAY,EACZ,EACE,cAAc,EACd,WAAW,EACX,UAAU,GAAG,EAAO,EACpB,sBAAsB,GAAG,KAAK,EAC9B,YAAY,GAAG,EAAE,EACjB,qCAAqC,GAAG,SAAS,EACjD,QAAQ,MACsB,EAAE;;IAElC,MAAM,QAAQ,GAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAM,CAAC;IACpE,MAAM,MAAM,GAAM,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAE,EAAQ,CAAC;IAC9D,4EAA4E;IAC5E,IAAI,QAAQ,GAAwB,cAAc,CAAC;IACnD,6FAA6F;IAC7F,IAAI,eAAe,GAAa,IAAI,CAAC;IACrC,IAAI,kBAAkB,GAAG,YAAY,CAAC;IAEtC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;QAClD,yEAAyE;QACzE,kBAAkB;QAClB,QAAQ,GAAG,YAAY,CAAC,QAAS,EAAE,MAAM,CAAC,OAA4B,CAAM,CAAC;KAC9E;SAAM,IAAI,WAAW,IAAI,MAAM,EAAE;QAChC,QAAQ,GAAG,MAAM,CAAC,OAAuB,CAAC;KAC3C;SAAM,IAAI,OAAO,IAAI,MAAM,EAAE;QAC5B,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAChC,gDAAgD;QAChD,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAQ,CAAC,EAAE;YACpC,kBAAkB,GAAG,YAAY,CAAC,MAAM,CAAC,OAAQ,CAAC,CAAC;YACnD,eAAe,GAAG,oBAAoB,CAAI,OAAO,EAAE,UAAU,CAAC,CAAC;SAChE;KACF;SAAM,IAAI,gBAAgB,IAAI,MAAM,EAAE;QACrC,MAAM,cAAc,GAAG,mBAAmB,CAAU,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACpG,eAAe,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,mDAAmD;KACzF;SAAM,IAAI,YAAY,CAAC,MAAM,CAAC,EAAE;QAC/B,QAAQ,GAAI,MAAM,CAAC,KAAc,CAAC,GAAG,CAAC,CAAC,UAAa,EAAE,GAAW,EAAE,EAAE,CACnE,eAAe,CAAO,SAAS,EAAE,UAAU,EAAE;YAC3C,UAAU;YACV,sBAAsB;YACtB,YAAY;YACZ,qCAAqC;YACrC,cAAc,EAAE,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;YAC/E,WAAW,EAAE,QAAa;YAC1B,QAAQ;SACT,CAAC,CACI,CAAC;KACV;SAAM,IAAI,UAAU,IAAI,MAAM,EAAE;QAC/B,MAAM,EAAE,KAAK,KAAmB,MAAM,EAApB,SAAS,UAAK,MAAM,EAAhC,SAAuB,CAAS,CAAC;QACvC,IAAI,KAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YACvB,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,aAAa,GAAG,+BAA+B,CAAI,MAAM,CAAC,CAAC;QACjE,eAAe,GAAG,KAAM,CACtB,wBAAwB,CACtB,SAAS,EACT,UAAU,EACV,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EACxC,KAAY,EACZ,CAAC,EACD,aAAa,CACd,CACG,CAAC;QACP,eAAe,GAAG,YAAY,CAAC,SAAS,EAAE,eAAe,CAAM,CAAC;KACjE;SAAM,IAAI,UAAU,IAAI,MAAM,EAAE;QAC/B,MAAM,EAAE,KAAK,KAAmB,MAAM,EAApB,SAAS,UAAK,MAAM,EAAhC,SAAuB,CAAS,CAAC;QACvC,IAAI,KAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YACvB,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,aAAa,GAAG,+BAA+B,CAAI,MAAM,CAAC,CAAC;QACjE,eAAe,GAAG,KAAM,CACtB,wBAAwB,CACtB,SAAS,EACT,UAAU,EACV,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,EACxC,KAAY,EACZ,CAAC,EACD,aAAa,CACd,CACG,CAAC;QACP,eAAe,GAAG,YAAY,CAAC,SAAS,EAAE,eAAe,CAAM,CAAC;KACjE;IAED,IAAI,eAAe,EAAE;QACnB,OAAO,eAAe,CAAU,SAAS,EAAE,eAAe,EAAE;YAC1D,UAAU;YACV,sBAAsB;YACtB,YAAY,EAAE,kBAAkB;YAChC,qCAAqC;YACrC,cAAc,EAAE,QAAyB;YACzC,WAAW,EAAE,QAAa;YAC1B,QAAQ;SACT,CAAC,CAAC;KACJ;IAED,qEAAqE;IACrE,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,QAAQ,GAAG,MAAM,CAAC,OAAuB,CAAC;KAC3C;IAED,QAAQ,aAAa,CAAI,MAAM,CAAC,EAAE;QAChC,6DAA6D;QAC7D,KAAK,QAAQ,CAAC,CAAC;YACb,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAsB,EAAE,GAAW,EAAE,EAAE;;gBACzG,wEAAwE;gBACxE,2CAA2C;gBAC3C,MAAM,eAAe,GAAG,eAAe,CAAU,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC,EAAE;oBAC9F,UAAU;oBACV,YAAY;oBACZ,qCAAqC;oBACrC,sBAAsB,EAAE,sBAAsB,KAAK,IAAI;oBACvD,cAAc,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC;oBACpC,WAAW,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC;oBACjC,QAAQ,EAAE,MAAA,MAAM,CAAC,QAAQ,0CAAE,QAAQ,CAAC,GAAG,CAAC;iBACzC,CAAC,CAAC;gBACH,uBAAuB,CACrB,GAAG,EACH,GAAG,EACH,eAAe,EACf,sBAAsB,EACtB,QAAQ,EACR,MAAM,CAAC,QAAQ,EACf,qCAAqC,CACtC,CAAC;gBACF,OAAO,GAAG,CAAC;YACb,CAAC,EAAE,EAAE,CAAM,CAAC;YACZ,IAAI,MAAM,CAAC,oBAAoB,EAAE;gBAC/B,mEAAmE;gBACnE,MAAM,0BAA0B,GAAG,QAAQ,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5G,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;gBAC/B,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE;oBACtB,MAAM,CAAC,IAAI,CAAC,QAA6B,CAAC;yBACvC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;yBAC9D,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;iBACpC;gBACD,IAAI,gBAA0B,CAAC;gBAC/B,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE;oBACtB,gBAAgB,GAAG,EAAE,CAAC;oBACtB,MAAM,CAAC,IAAI,CAAC,QAA6B,CAAC;yBACvC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;yBAC9D,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;wBACf,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;wBACd,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAC7B,CAAC,CAAC,CAAC;iBACN;gBACD,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;;oBACnB,MAAM,eAAe,GAAG,eAAe,CAAC,SAAS,EAAE,0BAA+B,EAAE;wBAClF,UAAU;wBACV,YAAY;wBACZ,qCAAqC;wBACrC,sBAAsB,EAAE,sBAAsB,KAAK,IAAI;wBACvD,cAAc,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC;wBACpC,WAAW,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC;wBACjC,QAAQ,EAAE,MAAA,MAAM,CAAC,QAAQ,0CAAE,QAAQ,CAAC,GAAG,CAAC;qBACzC,CAAC,CAAC;oBACH,8GAA8G;oBAC9G,uBAAuB,CACrB,cAAmC,EACnC,GAAG,EACH,eAAe,EACf,sBAAsB,EACtB,QAAQ,EACR,gBAAgB,CACjB,CAAC;gBACJ,CAAC,CAAC,CAAC;aACJ;YACD,OAAO,cAAc,CAAC;SACvB;QACD,KAAK,OAAO,CAAC,CAAC;YACZ,MAAM,aAAa,GAAG,CAAA,MAAA,qCAAqC,aAArC,qCAAqC,uBAArC,qCAAqC,CAAE,aAAa,0CAAE,QAAQ,MAAK,OAAO,CAAC;YACjG,MAAM,qBAAqB,GAAG,CAAA,MAAA,qCAAqC,aAArC,qCAAqC,uBAArC,qCAAqC,CAAE,aAAa,0CAAE,QAAQ,MAAK,cAAc,CAAC;YAEhH,+CAA+C;YAC/C,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBAC3B,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;oBACpC,MAAM,UAAU,GAAM,0BAA0B,CAAI,MAAM,EAAE,uBAAuB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;oBACnG,OAAO,eAAe,CAAU,SAAS,EAAE,UAAU,EAAE;wBACrD,UAAU;wBACV,YAAY;wBACZ,qCAAqC;wBACrC,cAAc,EAAE,IAAI;wBACpB,QAAQ;qBACT,CAAC,CAAC;gBACL,CAAC,CAAQ,CAAC;aACX;YAED,yDAAyD;YACzD,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;gBAC9B,MAAM,UAAU,GAAM,0BAA0B,CAAI,MAAM,CAAC,CAAC;gBAC5D,IAAI,aAAa,EAAE;oBACjB,QAAQ,GAAG,WAAW,CAAC;iBACxB;qBAAM;oBACL,QAAQ,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC,IAAO,EAAE,GAAW,EAAE,EAAE;wBAClD,OAAO,eAAe,CAAU,SAAS,EAAE,UAAU,EAAE;4BACrD,UAAU;4BACV,YAAY;4BACZ,qCAAqC;4BACrC,WAAW,EAAE,IAAI;4BACjB,cAAc,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,GAAG,CAAC,CAAC;4BACpC,QAAQ;yBACT,CAAC,CAAC;oBACL,CAAC,CAAQ,CAAC;iBACX;aACF;YAED,IAAI,aAAa,EAAE;gBACjB,OAAO,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,EAAE,CAAC;aACvB;YACD,IAAI,qBAAqB,IAAI,CAAC,QAAQ,EAAE;gBACtC,2FAA2F;gBAC3F,4BAA4B;gBAC5B,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;aACxC;YAED,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YACrE,IACE,CAAC,MAAM,CAAC,QAAQ;gBAChB,aAAa,CAAU,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC;gBACrD,MAAM,CAAC,QAAQ,IAAI,cAAc,EACjC;gBACA,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;aACjC;YAED,MAAM,cAAc,GAAQ,CAAC,QAAQ,IAAI,EAAE,CAAQ,CAAC;YACpD,MAAM,YAAY,GAAM,0BAA0B,CAAI,MAAM,EAAE,uBAAuB,CAAC,MAAM,CAAC,CAAC;YAC9F,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAC;YAE3C,uFAAuF;YACvF,MAAM,aAAa,GAAQ,IAAI,KAAK,CAAC,MAAM,CAAC,QAAQ,GAAG,cAAc,CAAC,CAAC,IAAI,CACzE,eAAe,CAAY,SAAS,EAAE,YAAY,EAAE;gBAClD,cAAc,EAAE,aAAa;gBAC7B,UAAU;gBACV,YAAY;gBACZ,qCAAqC;gBACrC,QAAQ;aACT,CAAC,CACI,CAAC;YACT,8EAA8E;YAC9E,OAAO,cAAc,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;SAC7C;KACF;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,UAAU,mBAAmB,CAKzC,SAAiC,EACjC,SAAY,EACZ,QAAY,EACZ,UAAc,EACd,yBAA4D,KAAK,EACjE,qCAA6E;IAE7E,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,kBAAkB,GAAG,SAAS,CAAC,CAAC;KACjD;IACD,MAAM,MAAM,GAAG,cAAc,CAAU,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAC;IACnF,MAAM,QAAQ,GAAG,eAAe,CAAU,SAAS,EAAE,MAAM,EAAE;QAC3D,UAAU;QACV,sBAAsB;QACtB,qCAAqC;QACrC,WAAW,EAAE,QAAQ;KACtB,CAAC,CAAC;IACH,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,IAAI,IAAI,CAAC,OAAO,QAAQ,KAAK,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE;QACpG,qCAAqC;QACrC,OAAO,QAAQ,CAAC;KACjB;IACD,MAAM,EAAE,kBAAkB,EAAE,GAAG,CAAA,qCAAqC,aAArC,qCAAqC,uBAArC,qCAAqC,CAAE,aAAa,KAAI,EAAE,CAAC;IAC1F,IAAI,QAAQ,CAAC,QAAQ,CAAC,EAAE;QACtB,OAAO,yBAAyB,CAAI,QAAa,EAAE,QAAQ,EAAE,kBAAkB,CAAC,CAAC;KAClF;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAC3B,OAAO,yBAAyB,CAAM,QAAe,EAAE,QAAQ,EAAE,kBAAkB,CAAC,CAAC;KACtF;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/lib/schema/getDisplayLabel.d.ts

@@ -0,0 +1,12 @@
+import { FormContextType, GlobalUISchemaOptions, RJSFSchema, StrictRJSFSchema, UiSchema, ValidatorType } from '../types';
+/** Determines whether the combination of `schema` and `uiSchema` properties indicates that the label for the `schema`
+ * should be displayed in a UI.
+ *
+ * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
+ * @param schema - The schema for which the display label flag is desired
+ * @param [uiSchema={}] - The UI schema from which to derive potentially displayable information
+ * @param [rootSchema] - The root schema, used to primarily to look up `$ref`s
+ * @param [globalOptions={}] - The optional Global UI Schema from which to get any fallback `xxx` options
+ * @returns - True if the label should be displayed or false if it should not
+ */
+export default 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, globalOptions?: GlobalUISchemaOptions): boolean;

package/lib/schema/getDisplayLabel.js

@@ -0,0 +1,39 @@
+import { UI_FIELD_KEY, UI_WIDGET_KEY } from '../constants';
+import getSchemaType from '../getSchemaType';
+import getUiOptions from '../getUiOptions';
+import isCustomWidget from '../isCustomWidget';
+import isFilesArray from './isFilesArray';
+import isMultiSelect from './isMultiSelect';
+/** Determines whether the combination of `schema` and `uiSchema` properties indicates that the label for the `schema`
+ * should be displayed in a UI.
+ *
+ * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
+ * @param schema - The schema for which the display label flag is desired
+ * @param [uiSchema={}] - The UI schema from which to derive potentially displayable information
+ * @param [rootSchema] - The root schema, used to primarily to look up `$ref`s
+ * @param [globalOptions={}] - The optional Global UI Schema from which to get any fallback `xxx` options
+ * @returns - True if the label should be displayed or false if it should not
+ */
+export default function getDisplayLabel(validator, schema, uiSchema = {}, rootSchema, globalOptions) {
+    const uiOptions = getUiOptions(uiSchema, globalOptions);
+    const { label = true } = uiOptions;
+    let displayLabel = !!label;
+    const schemaType = getSchemaType(schema);
+    if (schemaType === 'array') {
+        displayLabel =
+            isMultiSelect(validator, schema, rootSchema) ||
+                isFilesArray(validator, schema, uiSchema, rootSchema) ||
+                isCustomWidget(uiSchema);
+    }
+    if (schemaType === 'object') {
+        displayLabel = false;
+    }
+    if (schemaType === 'boolean' && !uiSchema[UI_WIDGET_KEY]) {
+        displayLabel = false;
+    }
+    if (uiSchema[UI_FIELD_KEY]) {
+        displayLabel = false;
+    }
+    return displayLabel;
+}
+//# sourceMappingURL=getDisplayLabel.js.map

package/lib/schema/getDisplayLabel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDisplayLabel.js","sourceRoot":"","sources":["../../src/schema/getDisplayLabel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,aAAa,MAAM,kBAAkB,CAAC;AAC7C,OAAO,YAAY,MAAM,iBAAiB,CAAC;AAC3C,OAAO,cAAc,MAAM,mBAAmB,CAAC;AAS/C,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAC1C,OAAO,aAAa,MAAM,iBAAiB,CAAC;AAE5C;;;;;;;;;GASG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CAKrC,SAAiC,EACjC,MAAS,EACT,WAA8B,EAAE,EAChC,UAAc,EACd,aAAqC;IAErC,MAAM,SAAS,GAAG,YAAY,CAAU,QAAQ,EAAE,aAAa,CAAC,CAAC;IACjE,MAAM,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,SAAS,CAAC;IACnC,IAAI,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC;IAC3B,MAAM,UAAU,GAAG,aAAa,CAAI,MAAM,CAAC,CAAC;IAE5C,IAAI,UAAU,KAAK,OAAO,EAAE;QAC1B,YAAY;YACV,aAAa,CAAU,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC;gBACrD,YAAY,CAAU,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC;gBAC9D,cAAc,CAAC,QAAQ,CAAC,CAAC;KAC5B;IAED,IAAI,UAAU,KAAK,QAAQ,EAAE;QAC3B,YAAY,GAAG,KAAK,CAAC;KACtB;IACD,IAAI,UAAU,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;QACxD,YAAY,GAAG,KAAK,CAAC;KACtB;IACD,IAAI,QAAQ,CAAC,YAAY,CAAC,EAAE;QAC1B,YAAY,GAAG,KAAK,CAAC;KACtB;IACD,OAAO,YAAY,CAAC;AACtB,CAAC"}

package/lib/schema/getFirstMatchingOption.d.ts

@@ -0,0 +1,13 @@
+import { FormContextType, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types';
+/** Given the `formData` and list of `options`, attempts to find the index of the first option that matches the data.
+ * Always returns the first option if there is nothing that matches.
+ *
+ * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
+ * @param formData - The current formData, if any, used to figure out a match
+ * @param options - The list of options to find a matching options from
+ * @param rootSchema - The root schema, used to primarily to look up `$ref`s
+ * @param [discriminatorField] - The optional name of the field within the options object whose value is used to
+ *          determine which option is selected
+ * @returns - The index of the first matched option or 0 if none is available
+ */
+export default function getFirstMatchingOption<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, formData: T | undefined, options: S[], rootSchema: S, discriminatorField?: string): number;

package/lib/schema/getFirstMatchingOption.js

@@ -0,0 +1,16 @@
+import getMatchingOption from './getMatchingOption';
+/** Given the `formData` and list of `options`, attempts to find the index of the first option that matches the data.
+ * Always returns the first option if there is nothing that matches.
+ *
+ * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
+ * @param formData - The current formData, if any, used to figure out a match
+ * @param options - The list of options to find a matching options from
+ * @param rootSchema - The root schema, used to primarily to look up `$ref`s
+ * @param [discriminatorField] - The optional name of the field within the options object whose value is used to
+ *          determine which option is selected
+ * @returns - The index of the first matched option or 0 if none is available
+ */
+export default function getFirstMatchingOption(validator, formData, options, rootSchema, discriminatorField) {
+    return getMatchingOption(validator, formData, options, rootSchema, discriminatorField);
+}
+//# sourceMappingURL=getFirstMatchingOption.js.map

package/lib/schema/getFirstMatchingOption.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFirstMatchingOption.js","sourceRoot":"","sources":["../../src/schema/getFirstMatchingOption.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,qBAAqB,CAAC;AAGpD;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,UAAU,sBAAsB,CAK5C,SAAiC,EACjC,QAAuB,EACvB,OAAY,EACZ,UAAa,EACb,kBAA2B;IAE3B,OAAO,iBAAiB,CAAU,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,kBAAkB,CAAC,CAAC;AAClG,CAAC"}

package/lib/schema/getMatchingOption.d.ts

@@ -0,0 +1,14 @@
+import { FormContextType, RJSFSchema, StrictRJSFSchema, ValidatorType } from '../types';
+/** Given the `formData` and list of `options`, attempts to find the index of the option that best matches the data.
+ * Deprecated, use `getFirstMatchingOption()` instead.
+ *
+ * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
+ * @param formData - The current formData, if any, used to figure out a match
+ * @param options - The list of options to find a matching options from
+ * @param rootSchema - The root schema, used to primarily to look up `$ref`s
+ * @param [discriminatorField] - The optional name of the field within the options object whose value is used to
+ *          determine which option is selected
+ * @returns - The index of the matched option or 0 if none is available
+ * @deprecated
+ */
+export default function getMatchingOption<T = any, S extends StrictRJSFSchema = RJSFSchema, F extends FormContextType = any>(validator: ValidatorType<T, S, F>, formData: T | undefined, options: S[], rootSchema: S, discriminatorField?: string): number;

package/lib/schema/getMatchingOption.js

@@ -0,0 +1,80 @@
+import { __rest } from "tslib";
+import get from 'lodash/get';
+import has from 'lodash/has';
+import { PROPERTIES_KEY } from '../constants';
+/** Given the `formData` and list of `options`, attempts to find the index of the option that best matches the data.
+ * Deprecated, use `getFirstMatchingOption()` instead.
+ *
+ * @param validator - An implementation of the `ValidatorType` interface that will be used when necessary
+ * @param formData - The current formData, if any, used to figure out a match
+ * @param options - The list of options to find a matching options from
+ * @param rootSchema - The root schema, used to primarily to look up `$ref`s
+ * @param [discriminatorField] - The optional name of the field within the options object whose value is used to
+ *          determine which option is selected
+ * @returns - The index of the matched option or 0 if none is available
+ * @deprecated
+ */
+export default function getMatchingOption(validator, formData, options, rootSchema, discriminatorField) {
+    // For performance, skip validating subschemas if formData is undefined. We just
+    // want to get the first option in that case.
+    if (formData === undefined) {
+        return 0;
+    }
+    for (let i = 0; i < options.length; i++) {
+        const option = options[i];
+        // If we have a discriminator field, then we will use this to make the determination
+        if (discriminatorField && has(option, [PROPERTIES_KEY, discriminatorField])) {
+            const value = get(formData, discriminatorField);
+            const discriminator = get(option, [PROPERTIES_KEY, discriminatorField], {});
+            if (validator.isValid(discriminator, value, rootSchema)) {
+                return i;
+            }
+        }
+        else if (option[PROPERTIES_KEY]) {
+            // If the schema describes an object then we need to add slightly more
+            // strict matching to the schema, because unless the schema uses the
+            // "requires" keyword, an object will match the schema as long as it
+            // doesn't have matching keys with a conflicting type. To do this we use an
+            // "anyOf" with an array of requires. This augmentation expresses that the
+            // schema should match if any of the keys in the schema are present on the
+            // object and pass validation.
+            //
+            // Create an "anyOf" schema that requires at least one of the keys in the
+            // "properties" object
+            const requiresAnyOf = {
+                anyOf: Object.keys(option[PROPERTIES_KEY]).map((key) => ({
+                    required: [key],
+                })),
+            };
+            let augmentedSchema;
+            // If the "anyOf" keyword already exists, wrap the augmentation in an "allOf"
+            if (option.anyOf) {
+                // Create a shallow clone of the option
+                const shallowClone = __rest(option, []);
+                if (!shallowClone.allOf) {
+                    shallowClone.allOf = [];
+                }
+                else {
+                    // If "allOf" already exists, shallow clone the array
+                    shallowClone.allOf = shallowClone.allOf.slice();
+                }
+                shallowClone.allOf.push(requiresAnyOf);
+                augmentedSchema = shallowClone;
+            }
+            else {
+                augmentedSchema = Object.assign({}, option, requiresAnyOf);
+            }
+            // Remove the "required" field as it's likely that not all fields have
+            // been filled in yet, which will mean that the schema is not valid
+            delete augmentedSchema.required;
+            if (validator.isValid(augmentedSchema, formData, rootSchema)) {
+                return i;
+            }
+        }
+        else if (validator.isValid(option, formData, rootSchema)) {
+            return i;
+        }
+    }
+    return 0;
+}
+//# sourceMappingURL=getMatchingOption.js.map

package/lib/schema/getMatchingOption.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getMatchingOption.js","sourceRoot":"","sources":["../../src/schema/getMatchingOption.ts"],"names":[],"mappings":";AAAA,OAAO,GAAG,MAAM,YAAY,CAAC;AAC7B,OAAO,GAAG,MAAM,YAAY,CAAC;AAE7B,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAG9C;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAKvC,SAAiC,EACjC,QAAuB,EACvB,OAAY,EACZ,UAAa,EACb,kBAA2B;IAE3B,gFAAgF;IAChF,6CAA6C;IAC7C,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,OAAO,CAAC,CAAC;KACV;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QACvC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;QAE1B,oFAAoF;QACpF,IAAI,kBAAkB,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC,EAAE;YAC3E,MAAM,KAAK,GAAG,GAAG,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;YAChD,MAAM,aAAa,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,cAAc,EAAE,kBAAkB,CAAC,EAAE,EAAE,CAAC,CAAC;YAC5E,IAAI,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,KAAK,EAAE,UAAU,CAAC,EAAE;gBACvD,OAAO,CAAC,CAAC;aACV;SACF;aAAM,IAAI,MAAM,CAAC,cAAc,CAAC,EAAE;YACjC,sEAAsE;YACtE,oEAAoE;YACpE,oEAAoE;YACpE,2EAA2E;YAC3E,0EAA0E;YAC1E,0EAA0E;YAC1E,8BAA8B;YAC9B,EAAE;YACF,yEAAyE;YACzE,sBAAsB;YACtB,MAAM,aAAa,GAAG;gBACpB,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;oBACvD,QAAQ,EAAE,CAAC,GAAG,CAAC;iBAChB,CAAC,CAAC;aACJ,CAAC;YAEF,IAAI,eAAe,CAAC;YAEpB,6EAA6E;YAC7E,IAAI,MAAM,CAAC,KAAK,EAAE;gBAChB,uCAAuC;gBACvC,MAAW,YAAY,UAAK,MAAM,EAA5B,EAAmB,CAAS,CAAC;gBAEnC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE;oBACvB,YAAY,CAAC,KAAK,GAAG,EAAE,CAAC;iBACzB;qBAAM;oBACL,qDAAqD;oBACrD,YAAY,CAAC,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;iBACjD;gBAED,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAEvC,eAAe,GAAG,YAAY,CAAC;aAChC;iBAAM;gBACL,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;aAC5D;YAED,sEAAsE;YACtE,mEAAmE;YACnE,OAAO,eAAe,CAAC,QAAQ,CAAC;YAEhC,IAAI,SAAS,CAAC,OAAO,CAAC,eAAe,EAAE,QAAQ,EAAE,UAAU,CAAC,EAAE;gBAC5D,OAAO,CAAC,CAAC;aACV;SACF;aAAM,IAAI,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC,EAAE;YAC1D,OAAO,CAAC,CAAC;SACV;KACF;IACD,OAAO,CAAC,CAAC;AACX,CAAC"}