export class MappingField extends foundry.data.fields.ObjectField { constructor(model, options) { if (!(model instanceof foundry.data.fields.DataField)) { throw new Error('MappingField must have a DataField as its contained element'); } super(options); /** * The embedded DataField definition which is contained in this field. * @type {DataField} */ this.model = model; } /* -------------------------------------------- */ /** @inheritdoc */ static get _defaults() { return foundry.utils.mergeObject(super._defaults, { initialKeys: null, initialValue: null, initialKeysOnly: false }); } /* -------------------------------------------- */ /** @inheritdoc */ _cleanType(value, options) { Object.entries(value).forEach(([k, v]) => (value[k] = this.model.clean(v, options))); return value; } /* -------------------------------------------- */ /** @inheritdoc */ getInitialValue(data) { let keys = this.initialKeys; const initial = super.getInitialValue(data); if (!keys || !foundry.utils.isEmpty(initial)) return initial; if (!(keys instanceof Array)) keys = Object.keys(keys); for (const key of keys) initial[key] = this._getInitialValueForKey(key); return initial; } /* -------------------------------------------- */ /** * Get the initial value for the provided key. * @param {string} key Key within the object being built. * @param {object} [object] Any existing mapping data. * @returns {*} Initial value based on provided field type. */ _getInitialValueForKey(key, object) { const initial = this.model.getInitialValue(); return this.initialValue?.(key, initial, object) ?? initial; } /* -------------------------------------------- */ /** @override */ _validateType(value, options = {}) { if (foundry.utils.getType(value) !== 'Object') throw new Error('must be an Object'); const errors = this._validateValues(value, options); if (!foundry.utils.isEmpty(errors)) throw new foundry.data.fields.ModelValidationError(errors); } /* -------------------------------------------- */ /** * Validate each value of the object. * @param {object} value The object to validate. * @param {object} options Validation options. * @returns {Object} An object of value-specific errors by key. */ _validateValues(value, options) { const errors = {}; for (const [k, v] of Object.entries(value)) { const error = this.model.validate(v, options); if (error) errors[k] = error; } return errors; } /* -------------------------------------------- */ /** @override */ initialize(value, model, options = {}) { if (!value) return value; const obj = {}; const initialKeys = this.initialKeys instanceof Array ? this.initialKeys : Object.keys(this.initialKeys ?? {}); const keys = this.initialKeysOnly ? initialKeys : Object.keys(value); for (const key of keys) { const data = value[key] ?? this._getInitialValueForKey(key, value); obj[key] = this.model.initialize(data, model, options); } return obj; } /* -------------------------------------------- */ /** @inheritdoc */ _getField(path) { if (path.length === 0) return this; else if (path.length === 1) return this.model; path.shift(); return this.model._getField(path); } }