@yuneta/gobj-js 7.26.2 → 7.26.3

package/dist/gobj-js.umd.js

@@ -5404,6 +5404,68 @@
 	/***************************************************************************
 	*
 	***************************************************************************/
+	/***************************************************************************
+	*  Markup that createElement2() inserts AS HTML, said out loud.
+	*
+	*  createElement2() reads a string that starts with '<' as markup. That
+	*  decision depends on the CONTENT of the string, not on who wrote it, so
+	*  a value from a backend or typed by a user that starts with '<' runs as
+	*  html. html_markup() is the explicit way to ask for markup: the string
+	*  is the caller's own (an icon, an svg), never data.
+	*
+	*      ['span', {class: 'icon'}, html_markup('<i class="yi-copy"></i>')]
+	*
+	*  With set_strings_are_text(true) a plain string is ALWAYS text and
+	*  html_markup() is the only way to insert markup.
+	***************************************************************************/
+	var HtmlMarkup = class {
+		constructor(html) {
+			this.html = html;
+			Object.freeze(this);
+		}
+		toString() {
+			return this.html;
+		}
+	};
+	function html_markup(html) {
+		if (typeof html !== "string") {
+			log_error(`html_markup: not a string, type ${typeof html}`);
+			return new HtmlMarkup("");
+		}
+		return new HtmlMarkup(html);
+	}
+	function is_html_markup(v) {
+		return v instanceof HtmlMarkup;
+	}
+	function markup_fragment(markup) {
+		const template = document.createElement("template");
+		template.innerHTML = markup.html.trim();
+		return template.content;
+	}
+	var __strings_are_text__ = false;
+	var __markup_strings_warned__ = /* @__PURE__ */ new Set();
+	/***************************************************************************
+	*  The mode of createElement2() for a plain string that starts with '<':
+	*      false (default): it is markup, as it always was.
+	*      true:            it is TEXT; markup is asked for with html_markup().
+	*  An app turns it on once its own code and the libraries it mounts pass
+	*  every deliberate markup through html_markup(). A string that starts
+	*  with '<' is then logged once (a deliberate one not migrated yet, or a
+	*  datum that used to run as html).
+	***************************************************************************/
+	function set_strings_are_text(on) {
+		__strings_are_text__ = !!on;
+	}
+	function strings_are_text() {
+		return __strings_are_text__;
+	}
+	function warn_markup_string(content) {
+		if (__markup_strings_warned__.size >= 100) return;
+		const key = content.slice(0, 80);
+		if (__markup_strings_warned__.has(key)) return;
+		__markup_strings_warned__.add(key);
+		log_warning(`createElement2: a string that starts with '<' is TEXT (set_strings_are_text): use html_markup() if it is markup: ${JSON.stringify(key)}`);
+	}
 	function createOneHtml(htmlString) {
 		const template = document.createElement("template");
 		template.innerHTML = htmlString.trim();
@@ -5565,6 +5627,7 @@
 	*                  if string begins with '<' then
 	*                      it will be converted to HTMLElement
 	*                          content = createOneHtml(string)
+	*                  | html_markup(string): markup, said out loud (any mode)
 	*                  ⚠️ So a string is MARKUP when it starts with '<': never
 	*                  pass DATA (a value from a backend, a name a user typed)
 	*                  as a bare string, or "<img src=x onerror=...>" runs.
@@ -5574,6 +5637,8 @@
 	*                  appended as it is and a string is always text -- but a
 	*                  list whose first item is a string is read as ONE
 	*                  description (the string is its tag).
+	*                  With set_strings_are_text(true) a plain string is
+	*                  always text, and markup only comes in html_markup().
 	*                  if attrs['i18n'] is not empty then (or 'data-i18n' or 'data_i18next')
 	*                          it will be overridden with the translation
 	*                          content = translate(attrs['i18n']));
@@ -5616,19 +5681,24 @@
 				el.setAttribute("data-i18n", data_i18next);
 			}
 		} else el.setAttribute(attr, attrs[attr]);
-		if (is_string(content)) {
+		if (is_html_markup(content)) el.appendChild(markup_fragment(content));
+		else if (is_string(content)) {
 			content = content.trim();
-			if (content.length > 0 && content[0] === "<") el.appendChild(createOneHtml(content));
-			else if (translate_fn && data_i18next) {
-				let translated = translate_fn(data_i18next);
-				el.textContent = translated ? translated : content;
-			} else el.textContent = content;
+			if (content.length > 0 && content[0] === "<" && !__strings_are_text__) el.appendChild(createOneHtml(content));
+			else {
+				if (content.length > 0 && content[0] === "<") warn_markup_string(content);
+				if (translate_fn && data_i18next) {
+					let translated = translate_fn(data_i18next);
+					el.textContent = translated ? translated : content;
+				} else el.textContent = content;
+			}
 		} else if (is_array(content)) {
 			if (content.length > 0) {
 				if (is_string(content[0])) el.appendChild(createElement2(content, translate_fn));
 				else for (let child of content) if (Array.isArray(child)) {
 					if (child.length > 0) el.appendChild(createElement2(child, translate_fn));
 				} else if (child instanceof Node) el.appendChild(child);
+				else if (is_html_markup(child)) el.appendChild(markup_fragment(child));
 				else if (is_string(child)) el.appendChild(document.createTextNode(child));
 				else if (child !== null && child !== void 0 && child !== false) log_error(`createElement2: child ignored, type ${typeof child}`);
 			}
@@ -7979,6 +8049,7 @@
 	exports.gobj_yuno_id = gobj_yuno_id;
 	exports.gobj_yuno_name = gobj_yuno_name;
 	exports.gobj_yuno_role = gobj_yuno_role;
+	exports.html_markup = html_markup;
 	exports.id_index_in_obj_list = id_index_in_obj_list;
 	exports.index_in_list = index_in_list;
 	exports.is_array = is_array;
@@ -7986,6 +8057,7 @@
 	exports.is_date = is_date;
 	exports.is_function = is_function;
 	exports.is_gobj = is_gobj;
+	exports.is_html_markup = is_html_markup;
 	exports.is_metadata_key = is_metadata_key;
 	exports.is_null = is_null;
 	exports.is_number = is_number;
@@ -8077,6 +8149,7 @@
 	exports.set_console_log_filter = set_console_log_filter;
 	exports.set_log_callback = set_log_callback;
 	exports.set_remote_log_functions = set_remote_log_functions;
+	exports.set_strings_are_text = set_strings_are_text;
 	exports.set_timeout = set_timeout;
 	exports.set_timeout_periodic = set_timeout_periodic;
 	exports.sprintf = sprintf;
@@ -8084,6 +8157,7 @@
 	exports.str_in_list = str_in_list;
 	exports.strcasecmp = strcasecmp;
 	exports.strcmp = strcmp;
+	exports.strings_are_text = strings_are_text;
 	exports.strncmp = strncmp;
 	exports.strs_in_list = strs_in_list;
 	exports.strstr = strstr;