@lonli-lokli/dynamic-forms-utils/lib/mergeDefaultsWithFormData.js

Utility functions for @lonli-lokli/dynamic-forms-core

import get from 'lodash-es/get.js';
import isObject from './isObject.js';
import isNil from 'lodash-es/isNil.js';
/** Merges the `defaults` object of type `T` into the `formData` of type `T`
 *
 * When merging defaults and form data, we want to merge in this specific way:
 * - objects are deeply merged
 * - arrays are merged in such a way that:
 *   - when the array is set in form data, only array entries set in form data
 *     are deeply merged; additional entries from the defaults are ignored unless `mergeExtraArrayDefaults` is true, in
 *     which case the extras are appended onto the end of the form data
 *   - when the array is not set in form data, the default is copied over
 * - scalars are overwritten/set by form data unless undefined and there is a default AND `defaultSupercedesUndefined`
 *   is true
 *
 * @param [defaults] - The defaults to merge
 * @param [formData] - The form data into which the defaults will be merged
 * @param [mergeExtraArrayDefaults=false] - If true, any additional default array entries are appended onto the formData
 * @param [defaultSupercedesUndefined=false] - If true, an explicit undefined value will be overwritten by the default value
 * @param [overrideFormDataWithDefaultsStrategy='noop'] - If not 'noop', the default value will overwrite the form data value. Values can be either replaced or merged, if the value
 *        doesn't exist in the default, we take it from formData and in the case where the value is set to undefined in formData.
 *       This is useful when we have already merged formData with defaults and want to add an additional field from formData
 *       that does not exist in defaults.
 * @returns - The resulting merged form data with defaults
 */
export default function mergeDefaultsWithFormData(defaults, formData, mergeExtraArrayDefaults = false, defaultSupercedesUndefined = false, overrideFormDataWithDefaultsStrategy = 'noop') {
    if (Array.isArray(formData)) {
        const defaultsArray = Array.isArray(defaults) ? defaults : [];
        // If overrideFormDataWithDefaultsStrategy is not noop, we want to override the formData with the defaults
        const overrideArray = overrideFormDataWithDefaultsStrategy !== 'noop' ? defaultsArray : formData;
        const overrideOppositeArray = overrideFormDataWithDefaultsStrategy !== 'noop' ? formData : defaultsArray;
        const mapped = overrideArray.map((value, idx) => {
            // We want to explicitly make sure that the value is NOT undefined since null, 0 and empty space are valid values
            if (overrideOppositeArray[idx] !== undefined) {
                return mergeDefaultsWithFormData(defaultsArray[idx], formData[idx], mergeExtraArrayDefaults, defaultSupercedesUndefined, overrideFormDataWithDefaultsStrategy);
            }
            return value;
        });
        // Merge any extra defaults when mergeExtraArrayDefaults is true
        // Or when overrideFormDataWithDefaults is not noop and the default array is shorter than the formData array
        if ((mergeExtraArrayDefaults || overrideFormDataWithDefaultsStrategy === 'merge') &&
            mapped.length < overrideOppositeArray.length) {
            mapped.push(...overrideOppositeArray.slice(mapped.length));
        }
        return mapped;
    }
    if (isObject(formData)) {
        const iterationSource = overrideFormDataWithDefaultsStrategy === 'replace' ? (defaults !== null && defaults !== void 0 ? defaults : {}) : formData;
        const acc = Object.assign({}, defaults); // Prevent mutation of source object.
        return Object.keys(iterationSource).reduce((acc, key) => {
            const keyValue = get(formData, key);
            const keyExistsInDefaults = isObject(defaults) && key in defaults;
            const keyExistsInFormData = key in formData;
            // overrideFormDataWithDefaultsStrategy can be 'merge' only when the key value exists in defaults
            // Or if the key value doesn't exist in formData
            const keyOverrideDefaultStrategy = overrideFormDataWithDefaultsStrategy === 'replace'
                ? 'replace'
                : keyExistsInDefaults || !keyExistsInFormData
                    ? overrideFormDataWithDefaultsStrategy
                    : 'noop';
            acc[key] = mergeDefaultsWithFormData(defaults ? get(defaults, key) : {}, keyValue, mergeExtraArrayDefaults, defaultSupercedesUndefined, keyOverrideDefaultStrategy);
            return acc;
        }, acc);
    }
    /**
     * If the defaultSupercedesUndefined flag is true
     *    And formData is set to undefined or null and defaults are defined
     *    Or if formData is a number and is NaN return defaults
     * Or if overrideFormDataWithDefaults flag is true and formData is set to not undefined/null return defaults
     */
    if ((defaultSupercedesUndefined &&
        ((!isNil(defaults) && isNil(formData)) || (typeof formData === 'number' && isNaN(formData)))) ||
        (overrideFormDataWithDefaultsStrategy === 'merge' && !isNil(formData))) {
        return defaults;
    }
    return overrideFormDataWithDefaultsStrategy === 'replace' ? (defaults !== null && defaults !== void 0 ? defaults : formData) : formData;
}
//# sourceMappingURL=mergeDefaultsWithFormData.js.map