import {TagRenderingConfigJson} from "./TagRenderingConfigJson"; import Translations from "../../UI/i18n/Translations"; import {FromJSON} from "./FromJSON"; import ValidatedTextField from "../../UI/Input/ValidatedTextField"; import {Translation} from "../../UI/i18n/Translation"; import {Utils} from "../../Utils"; import {TagUtils} from "../../Logic/Tags/TagUtils"; import {And} from "../../Logic/Tags/And"; import {TagsFilter} from "../../Logic/Tags/TagsFilter"; /*** * The parsed version of TagRenderingConfigJSON * Identical data, but with some methods and validation */ export default class TagRenderingConfig { readonly render?: Translation; readonly question?: Translation; readonly condition?: TagsFilter; readonly configuration_warnings: string[] = [] readonly freeform?: { readonly key: string, readonly type: string, readonly addExtraTags: TagsFilter[]; }; readonly multiAnswer: boolean; readonly mappings?: { readonly if: TagsFilter, readonly ifnot?: TagsFilter, readonly then: Translation readonly hideInAnswer: boolean | TagsFilter }[] readonly roaming: boolean; constructor(json: string | TagRenderingConfigJson, conditionIfRoaming: TagsFilter, context?: string) { if (json === "questions") { // Very special value this.render = null; this.question = null; this.condition = null; } if (json === undefined) { throw "Initing a TagRenderingConfig with undefined in " + context; } if (typeof json === "string") { this.render = Translations.T(json, context + ".render"); this.multiAnswer = false; return; } this.render = Translations.T(json.render, context + ".render"); this.question = Translations.T(json.question, context + ".question"); this.roaming = json.roaming ?? false; const condition = FromJSON.Tag(json.condition ?? {"and": []}, `${context}.condition`); if (this.roaming && conditionIfRoaming !== undefined) { this.condition = new And([condition, conditionIfRoaming]); } else { this.condition = condition; } if (json.freeform) { this.freeform = { key: json.freeform.key, type: json.freeform.type ?? "string", addExtraTags: json.freeform.addExtraTags?.map((tg, i) => FromJSON.Tag(tg, `${context}.extratag[${i}]`)) ?? [] } if (json.freeform["extraTags"] !== undefined) { throw `Freeform.extraTags is defined. This should probably be 'freeform.addExtraTag' (at ${context})` } if (this.freeform.key === undefined || this.freeform.key === "") { throw `Freeform.key is undefined or the empty string - this is not allowed; either fill out something or remove the freeform block alltogether. Error in ${context}` } if (ValidatedTextField.AllTypes[this.freeform.type] === undefined) { const knownKeys = ValidatedTextField.tpList.map(tp => tp.name).join(", "); throw `Freeform.key ${this.freeform.key} is an invalid type. Known keys are ${knownKeys}` } if (this.freeform.addExtraTags) { const usedKeys = new And(this.freeform.addExtraTags).usedKeys(); if (usedKeys.indexOf(this.freeform.key) >= 0) { throw `The freeform key ${this.freeform.key} will be overwritten by one of the extra tags, as they use the same key too. This is in ${context}`; } } } this.multiAnswer = json.multiAnswer ?? false if (json.mappings) { if(!Array.isArray(json.mappings)){ throw "Tagrendering has a 'mappings'-object, but expected a list ("+context+")" } this.mappings = json.mappings.map((mapping, i) => { if (mapping.then === undefined) { throw `${context}.mapping[${i}]: Invalid mapping: if without body` } if (mapping.ifnot !== undefined && !this.multiAnswer) { throw `${context}.mapping[${i}]: Invalid mapping: ifnot defined, but the tagrendering is not a multianswer` } let hideInAnswer: boolean | TagsFilter = false; if (typeof mapping.hideInAnswer === "boolean") { hideInAnswer = mapping.hideInAnswer; } else if (mapping.hideInAnswer !== undefined) { hideInAnswer = FromJSON.Tag(mapping.hideInAnswer, `${context}.mapping[${i}].hideInAnswer`); } const mappingContext = `${context}.mapping[${i}]` const mp = { if: FromJSON.Tag(mapping.if, `${mappingContext}.if`), ifnot: (mapping.ifnot !== undefined ? FromJSON.Tag(mapping.ifnot, `${mappingContext}.ifnot`) : undefined), then: Translations.T(mapping.then, `{mappingContext}.then`), hideInAnswer: hideInAnswer }; if (this.question) { if (hideInAnswer !== true && mp.if !== undefined && !mp.if.isUsableAsAnswer()) { throw `${context}.mapping[${i}].if: This value cannot be used to answer a question, probably because it contains a regex or an OR. Either change it or set 'hideInAnswer'` } if (hideInAnswer !== true && !(mp.ifnot?.isUsableAsAnswer() ?? true)) { throw `${context}.mapping[${i}].ifnot: This value cannot be used to answer a question, probably because it contains a regex or an OR. Either change it or set 'hideInAnswer'` } } return mp; }); } if (this.question && this.freeform?.key === undefined && this.mappings === undefined) { throw `${context}: A question is defined, but no mappings nor freeform (key) are. The question is ${this.question.txt} at ${context}` } if (this.freeform && this.render === undefined) { throw `${context}: Detected a freeform key without rendering... Key: ${this.freeform.key} in ${context}` } if (this.render && this.question && this.freeform === undefined) { throw `${context}: Detected a tagrendering which takes input without freeform key in ${context}; the question is ${this.question.txt}` } if (!json.multiAnswer && this.mappings !== undefined && this.question !== undefined) { let keys = [] for (let i = 0; i < this.mappings.length; i++) { const mapping = this.mappings[i]; if (mapping.if === undefined) { throw `${context}.mappings[${i}].if is undefined` } keys.push(...mapping.if.usedKeys()) } keys = Utils.Dedup(keys) for (let i = 0; i < this.mappings.length; i++) { const mapping = this.mappings[i]; if (mapping.hideInAnswer) { continue } const usedKeys = mapping.if.usedKeys(); for (const expectedKey of keys) { if (usedKeys.indexOf(expectedKey) < 0) { const msg = `${context}.mappings[${i}]: This mapping only defines values for ${usedKeys.join(', ')}, but it should also give a value for ${expectedKey}` this.configuration_warnings.push(msg) } } } } if (this.question !== undefined && json.multiAnswer) { if ((this.mappings?.length ?? 0) === 0) { throw `${context} MultiAnswer is set, but no mappings are defined` } let allKeys = []; let allHaveIfNot = true; for (const mapping of this.mappings) { if (mapping.hideInAnswer) { continue; } if (mapping.ifnot === undefined) { allHaveIfNot = false; } allKeys = allKeys.concat(mapping.if.usedKeys()); } allKeys = Utils.Dedup(allKeys); if (allKeys.length > 1 && !allHaveIfNot) { throw `${context}: A multi-answer is defined, which generates values over multiple keys. Please define ifnot-tags too on every mapping` } } } /** * Returns true if it is known or not shown, false if the question should be asked * @constructor */ public IsKnown(tags: any): boolean { if (this.condition && !this.condition.matchesProperties(tags)) { // Filtered away by the condition return true; } if (this.multiAnswer) { for (const m of this.mappings ?? []) { if (TagUtils.MatchesMultiAnswer(m.if, tags)) { return true; } } const free = this.freeform?.key if (free !== undefined) { return tags[free] !== undefined } return false } if (this.GetRenderValue(tags) !== undefined) { // This value is known and can be rendered return true; } return false; } public IsQuestionBoxElement(): boolean { return this.question === null && this.condition === null; } /** * Gets the correct rendering value (or undefined if not known) * @constructor */ public GetRenderValue(tags: any): Translation { if (this.mappings !== undefined && !this.multiAnswer) { for (const mapping of this.mappings) { if (mapping.if === undefined) { return mapping.then; } if (mapping.if.matchesProperties(tags)) { return mapping.then; } } } if (this.freeform?.key === undefined) { return this.render; } if (tags[this.freeform.key] !== undefined) { return this.render; } return undefined; } public ExtractImages(isIcon: boolean): Set { const usedIcons = new Set() this.render?.ExtractImages(isIcon)?.forEach(usedIcons.add, usedIcons) for (const mapping of this.mappings ?? []) { mapping.then.ExtractImages(isIcon).forEach(usedIcons.add, usedIcons) } return usedIcons; } }