ya-bbcode 5.0.0 → 5.1.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2018 Nodecraft Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2018 Nodecraft Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -3,8 +3,7 @@ Yet another BBCode parser.
 `npm install ya-bbcode --save`
 
 [![npm version](https://badge.fury.io/js/ya-bbcode.svg)](https://badge.fury.io/js/ya-bbcode)
-[![Actions Status](https://github.com/nodecraft/ya-bbcode/workflows/Test/badge.svg)](https://github.com/nodecraft/ya-bbcode/actions)
-[![Coverage Status](https://coveralls.io/repos/github/nodecraft/ya-bbcode/badge.svg)](https://coveralls.io/github/nodecraft/ya-bbcode)
+[![CI](https://github.com/nodecraft/ya-bbcode/actions/workflows/ci.yml/badge.svg)](https://github.com/nodecraft/ya-bbcode/actions/workflows/ci.yml)
 
 ## Usage
 
@@ -37,3 +36,6 @@ parser.clearTags();
  - **Zero dependencies**: Lightweight with no external dependencies
  - **Correct parsing**: Parent nodes are parsed before children in nested format
  - **Customizable**: Easy to add or override tags
+
+### Changelog
+Release notes are published on [GitHub Releases](https://github.com/nodecraft/ya-bbcode/releases). Notes for 5.0.0 and earlier are in [CHANGELOG.md](CHANGELOG.md).

package/dist/ya-bbcode.cjs

@@ -1,5 +1,24 @@
-
-//#region src/ya-bbcode.ts
+// src/ya-bbcode.ts
+const PLACEHOLDER_START = "\0";
+const PLACEHOLDER_END = ";";
+function placeholder(index) {
+	return PLACEHOLDER_START + index + PLACEHOLDER_END;
+}
+function replaceFirst(content, search, replacement) {
+	const index = content.indexOf(search);
+	if (index === -1) return content;
+	return content.slice(0, index) + replacement + content.slice(index + search.length);
+}
+const sanitizedEntities = {
+	"&": "&",
+	"&lt;": "<",
+	"&gt;": ">",
+	"&quot;": "\"",
+	"&#39;": "'"
+};
+function unescapeSanitized(value) {
+	return value.replaceAll(/&(?:amp|lt|gt|quot|#39);/g, (entity) => sanitizedEntities[entity]);
+}
 /**
 * Escapes HTML attribute values to prevent XSS
 * Encodes quotes, angle brackets, and other special characters
@@ -14,12 +33,19 @@ function escapeHtmlAttr(value) {
 	};
 	return String(value).replaceAll(/["&'<>]/g, (char) => attrEntities[char] || char);
 }
+function normalizeUrl(url) {
+	let start = 0;
+	let end = url.length;
+	while (start < end && url.charAt(start) <= " ") start++;
+	while (end > start && url.charAt(end - 1) <= " ") end--;
+	return url.slice(start, end).replaceAll(/[\t\n\r]/g, "");
+}
 /**
 * Validates and sanitizes URLs to prevent javascript: and data: URL attacks
 * Only allows safe URL schemes based on the allowedSchemes list
 */
 function sanitizeUrl(url, allowedSchemes) {
-	const trimmed = String(url).trim();
+	const trimmed = normalizeUrl(String(url));
 	if (!trimmed) return "#";
 	if (/^\.{0,2}\//.test(trimmed)) return trimmed;
 	if (trimmed.startsWith("#")) return trimmed;
@@ -46,7 +72,7 @@ function parseTagAttributes(tagContent) {
 	const parts = tagContent.split(/\s+/);
 	const attrs = Object.create(null);
 	let firstValue = "";
-	const dangerousKeys = new Set([
+	const dangerousKeys = /* @__PURE__ */ new Set([
 		"__proto__",
 		"constructor",
 		"prototype"
@@ -75,7 +101,7 @@ var yabbcode = class {
 	tags = {
 		"url": {
 			type: "replace",
-			open: (attr) => `<a href="${escapeHtmlAttr(sanitizeUrl(attr, this.config.allowedSchemes ?? [
+			open: (attr) => `<a href="${escapeHtmlAttr(sanitizeUrl(this.#unsanitize(attr), this.config.allowedSchemes ?? [
 				"http",
 				"https",
 				"mailto",
@@ -86,7 +112,7 @@ var yabbcode = class {
 		},
 		"quote": {
 			type: "replace",
-			open: (attr) => `<blockquote author="${escapeHtmlAttr(attr)}">`,
+			open: (attr) => `<blockquote author="${escapeHtmlAttr(this.#unsanitize(attr))}">`,
 			close: "</blockquote>"
 		},
 		"b": {
@@ -139,6 +165,11 @@ var yabbcode = class {
 			open: "<code>",
 			close: "</code>"
 		},
+		"hr": {
+			type: "replace",
+			open: "<hr/>",
+			close: null
+		},
 		"strike": {
 			type: "replace",
 			open: "<span class=\"yabbcode-strike\">",
@@ -162,40 +193,41 @@ var yabbcode = class {
 		"*": {
 			type: "replace",
 			open: "<li>",
-			close: null
+			close: "</li>",
+			autoClose: "</li>"
 		},
 		"img": {
 			type: "content",
 			replace: (attr, content) => {
 				if (!content) return "";
-				return `<img src="${escapeHtmlAttr(content)}" alt="${escapeHtmlAttr(attr)}"/>`;
+				return `<img src="${escapeHtmlAttr(this.#unsanitize(content))}" alt="${escapeHtmlAttr(this.#unsanitize(attr))}"/>`;
 			}
 		},
 		"noparse": { type: "ignore" }
 	};
 	regex = {
-		tags: /(\[[^\]^]+])/g,
+		tags: /(\[[^\]^]+\])/g,
 		newline: /\r\n|\r|\n/g,
-		placeholders: /\[TAG-[1-9]+]/g
+		placeholders: /\0(\d+);/g
 	};
 	config;
 	contentModules = {
-		replace: (tag, module$1, content) => {
-			let open = module$1.open;
-			let close = module$1.close;
+		replace: (tag, module, content) => {
+			let open = module.open;
+			let close = module.close;
 			if (typeof open === "function") open = open(tag.attr, tag.attrs);
 			if (typeof close === "function") close = close(tag.attr, tag.attrs);
-			if (open && !tag.isClosing) content = content.replace("[TAG-" + tag.index + "]", open);
-			if (close && tag.closing) content = content.replace("[TAG-" + tag.closing.index + "]", close);
+			if (open && !tag.isClosing) content = replaceFirst(content, placeholder(tag.index), open);
+			if (close && tag.closing) content = replaceFirst(content, placeholder(tag.closing.index), close);
 			return content;
 		},
-		content: (tag, module$1, content) => {
+		content: (tag, module, content) => {
 			if (!tag.closing) return content;
-			const openTag = "[TAG-" + tag.index + "]";
-			const closeTag = "[TAG-" + tag.closing.index + "]";
+			const openTag = placeholder(tag.index);
+			const closeTag = placeholder(tag.closing.index);
 			const start = content.indexOf(openTag);
 			const end = content.indexOf(closeTag);
-			let replace = module$1.replace;
+			let replace = module.replace;
 			const innerContent = content.slice(start + openTag.length, end);
 			if (typeof replace === "function") replace = replace(tag.attr, innerContent, tag.attrs);
 			const contentStart = content.slice(0, Math.max(0, start));
@@ -203,12 +235,12 @@ var yabbcode = class {
 			return contentStart + replace + contentEnd;
 		},
 		ignore: (tag, _module, content) => {
-			const openTag = "[TAG-" + tag.index + "]";
+			const openTag = placeholder(tag.index);
 			const start = content.indexOf(openTag);
 			let closeTag = "";
 			let end = content.length;
 			if (tag.closing) {
-				closeTag = "[TAG-" + tag.closing.index + "]";
+				closeTag = placeholder(tag.closing.index);
 				end = content.indexOf(closeTag);
 			}
 			let innerContent = content.slice(start + openTag.length, end);
@@ -238,56 +270,107 @@ var yabbcode = class {
 		if (config.sanitizeHtml !== void 0) this.config.sanitizeHtml = config.sanitizeHtml;
 		if (config.allowedSchemes !== void 0) this.config.allowedSchemes = config.allowedSchemes;
 	}
+	#getTag(name) {
+		if (!Object.hasOwn(this.tags, name)) return;
+		return this.tags[name];
+	}
+	#convertNewlines(input) {
+		if (!this.config.newline) return input;
+		if (this.config.paragraph) return input.replace(this.regex.newline, "</p><p>");
+		return input.replace(this.regex.newline, "<br/>");
+	}
+	#applyLayout(input) {
+		input = this.#convertNewlines(input);
+		if (this.config.paragraph) input = "<p>" + input + "</p>";
+		return input;
+	}
+	#unsanitize(value) {
+		if (!this.config.sanitizeHtml) return value;
+		return unescapeSanitized(value);
+	}
 	#ignoreLoop(tagsMap, content) {
 		for (const tag of tagsMap) {
-			content = content.replace("[TAG-" + tag.index + "]", tag.raw);
-			if (tag.closing) content = content.replace("[TAG-" + tag.closing.index + "]", tag.closing.raw);
+			content = replaceFirst(content, placeholder(tag.index), tag.raw);
+			if (tag.closing) content = replaceFirst(content, placeholder(tag.closing.index), tag.closing.raw);
 			if (tag.children.length > 0) content = this.#ignoreLoop(tag.children, content);
 		}
 		return content;
 	}
-	#contentLoop(tagsMap, content) {
+	#contentLoop(tagsMap, content, parentClosingTagIndex) {
 		if (tagsMap.length > 50) {
-			if (!tagsMap.some((tag) => {
-				const module$1 = this.tags[tag.module];
-				return module$1 && (module$1.type === "content" || module$1.type === "ignore");
-			})) return this.#contentLoopOptimized(tagsMap, content);
+			const hasSpecialType = (tag) => {
+				const module = this.#getTag(tag.module);
+				if (module) {
+					if (module.type === "content" || module.type === "ignore") return true;
+					if (module.type === "replace" && module.autoClose) return true;
+				}
+				return tag.children.some((child) => hasSpecialType(child));
+			};
+			if (!tagsMap.some((tag) => hasSpecialType(tag))) return this.#contentLoopOptimized(tagsMap, content);
 		}
-		for (const tag of tagsMap) {
-			let module$1 = this.tags[tag.module];
-			if (!module$1) module$1 = {
+		for (let i = 0; i < tagsMap.length; i++) {
+			const tag = tagsMap[i];
+			if (!tag) continue;
+			let module = this.#getTag(tag.module);
+			if (!module) module = {
 				type: "replace",
 				open: tag.raw,
 				close: tag.closing ? tag.closing.raw : ""
 			};
-			if (!this.contentModules[module$1.type]) throw new Error("Cannot parse content block. Invalid block type [" + module$1.type + "] provided for tag [" + tag.module + "]");
-			if (module$1.type === "replace") content = this.contentModules.replace(tag, module$1, content);
-			else if (module$1.type === "content") content = this.contentModules.content(tag, module$1, content);
-			else if (module$1.type === "ignore") content = this.contentModules.ignore(tag, module$1, content);
-			if (tag.children.length > 0 && module$1.type !== "ignore") content = this.#contentLoop(tag.children, content);
+			if (!this.contentModules[module.type]) throw new Error("Cannot parse content block. Invalid block type [" + module.type + "] provided for tag [" + tag.module + "]");
+			if (module.type === "replace") {
+				const replaceModule = module;
+				let open = replaceModule.open;
+				if (typeof open === "function") open = open(tag.attr, tag.attrs);
+				if (open && !tag.isClosing) content = replaceFirst(content, placeholder(tag.index), open);
+				if (tag.children.length > 0) {
+					const closingIndex = tag.closing?.index;
+					content = this.#contentLoop(tag.children, content, closingIndex);
+				}
+				if (replaceModule.autoClose && !tag.closing) {
+					let autoClose = replaceModule.autoClose;
+					if (typeof autoClose === "function") autoClose = autoClose(tag.attr, tag.attrs);
+					let insertBefore;
+					for (let siblingIndex = i + 1; siblingIndex < tagsMap.length; siblingIndex++) {
+						const sibling = tagsMap[siblingIndex];
+						if (sibling?.module === tag.module) {
+							insertBefore = placeholder(sibling.index);
+							break;
+						}
+					}
+					if (insertBefore === void 0 && parentClosingTagIndex !== void 0) insertBefore = placeholder(parentClosingTagIndex);
+					if (insertBefore && autoClose) content = replaceFirst(content, insertBefore, autoClose + insertBefore);
+				}
+				let close = replaceModule.close;
+				if (typeof close === "function") close = close(tag.attr, tag.attrs);
+				if (close && tag.closing) content = replaceFirst(content, placeholder(tag.closing.index), close);
+			} else if (module.type === "content") {
+				if (tag.children.length > 0) content = this.#contentLoop(tag.children, content, tag.closing?.index);
+				content = this.contentModules.content(tag, module, content);
+			} else if (module.type === "ignore") content = this.contentModules.ignore(tag, module, content);
 		}
 		return content;
 	}
 	#contentLoopOptimized(tagsMap, content) {
 		const replacements = /* @__PURE__ */ new Map();
 		const processTag = (tag) => {
-			let module$1 = this.tags[tag.module];
-			if (!module$1) module$1 = {
+			let module = this.#getTag(tag.module);
+			if (!module) module = {
 				type: "replace",
 				open: tag.raw,
 				close: tag.closing ? tag.closing.raw : ""
 			};
-			if (module$1.type !== "replace") return;
-			let open = module$1.open;
-			let close = module$1.close;
+			if (module.type !== "replace") return;
+			let open = module.open;
+			let close = module.close;
 			if (typeof open === "function") open = open(tag.attr, tag.attrs);
 			if (typeof close === "function") close = close(tag.attr, tag.attrs);
-			if (open && !tag.isClosing) replacements.set("[TAG-" + tag.index + "]", open);
-			if (close && tag.closing) replacements.set("[TAG-" + tag.closing.index + "]", close);
-			if (tag.children.length > 0) for (const child of tag.children) processTag(child);
+			if (open && !tag.isClosing) replacements.set(placeholder(tag.index), open);
+			if (close && tag.closing) replacements.set(placeholder(tag.closing.index), close);
+			for (const child of tag.children) processTag(child);
 		};
 		for (const tag of tagsMap) processTag(tag);
-		return content.replaceAll(/\[TAG-(\d+)]/g, (match) => replacements.get(match) || "");
+		return content.replaceAll(this.regex.placeholders, (match) => replacements.get(match) ?? match);
 	}
 	#tagLoop(tagsMap, parent) {
 		const stack = [];
@@ -308,10 +391,9 @@ var yabbcode = class {
 						openTag.children = [];
 						for (let childIndex = childStart; childIndex < i; childIndex++) {
 							const childTag = tagsMap[childIndex];
-							if (childTag && !childTag.isClosing && childTag.parent === null) {
-								childTag.parent = openTag.index;
-								openTag.children.push(childTag);
-							}
+							if (!(childTag && !childTag.isClosing && childTag.parent === null)) continue;
+							childTag.parent = openTag.index;
+							openTag.children.push(childTag);
 						}
 					}
 					stack.splice(stackIndex, 1);
@@ -326,23 +408,21 @@ var yabbcode = class {
 		for (const tag of stack) {
 			tag.matchTag = false;
 			const childStart = (tag.stackIndex ?? 0) + 1;
-			if (childStart < tagsMap.length) {
-				tag.children = [];
-				for (let childIndex = childStart; childIndex < tagsMap.length; childIndex++) {
-					const childTag = tagsMap[childIndex];
-					if (childTag && !childTag.isClosing && childTag.parent === null) {
-						childTag.parent = tag.index;
-						tag.children.push(childTag);
-					}
-				}
+			if (!(childStart < tagsMap.length)) continue;
+			tag.children = [];
+			for (let childIndex = childStart; childIndex < tagsMap.length; childIndex++) {
+				const childTag = tagsMap[childIndex];
+				if (!(childTag && !childTag.isClosing && childTag.parent === null)) continue;
+				childTag.parent = tag.index;
+				tag.children.push(childTag);
 			}
 		}
 		const result = [];
-		for (const tag of tagsMap) if (!tag.isClosing) {
-			if (parent === void 0 && tag.parent === null || parent !== void 0 && tag.parent === parent) {
-				if (tag.children.length > 0) tag.children = this.#tagLoop(tag.children, tag.index);
-				result.push(tag);
-			}
+		for (const tag of tagsMap) {
+			if (tag.isClosing) continue;
+			if (!(parent === void 0 && tag.parent === null || parent !== void 0 && tag.parent === parent)) continue;
+			if (tag.children.length > 0) tag.children = this.#tagLoop(tag.children, tag.index);
+			result.push(tag);
 		}
 		return result;
 	}
@@ -362,7 +442,7 @@ var yabbcode = class {
 	}
 	parse(bbcInput) {
 		if (typeof bbcInput === "boolean" || typeof bbcInput !== "string" && Number.isNaN(Number(bbcInput))) return "";
-		let input = String(bbcInput);
+		let input = String(bbcInput).replaceAll(PLACEHOLDER_START, "");
 		if (this.config.sanitizeHtml) {
 			const htmlEntities = {
 				"&": "&amp;",
@@ -375,10 +455,7 @@ var yabbcode = class {
 		}
 		let tagsMap = [];
 		const tags = String(input).match(this.regex.tags);
-		if (this.config.newline) if (this.config.paragraph) input = input.replace(this.regex.newline, "</p><p>");
-		else input = input.replace(this.regex.newline, "<br/>");
-		if (this.config.paragraph) input = "<p>" + input + "</p>";
-		if (!tags || tags.length === 0) return input;
+		if (!tags || tags.length === 0) return this.#applyLayout(input);
 		for (const [i, tag] of tags.entries()) {
 			const tagContent = tag.slice(1, -1);
 			const isClosing = tagContent.startsWith("/");
@@ -394,17 +471,17 @@ var yabbcode = class {
 					attrs: {}
 				};
 			} else if (spaceIndex === -1 || equalsIndex !== -1 && equalsIndex < spaceIndex) {
-				moduleName = (contentToParse.split("=")[0] ?? "").toLowerCase();
+				moduleName = (contentToParse.split("=", 1)[0] ?? "").toLowerCase();
 				parsedAttrs = parseTagAttributes(contentToParse);
 			} else {
-				moduleName = (contentToParse.split(/\s+/)[0] ?? "").toLowerCase();
+				moduleName = (contentToParse.split(/\s+/, 1)[0] ?? "").toLowerCase();
 				parsedAttrs = parseTagAttributes(contentToParse);
 			}
 			const item = {
 				index: i,
 				module: moduleName,
 				isClosing,
-				raw: tag,
+				raw: this.#convertNewlines(tag),
 				attr: parsedAttrs.attr,
 				attrs: parsedAttrs.attrs,
 				children: [],
@@ -413,20 +490,19 @@ var yabbcode = class {
 			};
 			tagsMap.push(item);
 		}
-		if (tags.length <= 3) for (const [i, tag] of tags.entries()) input = input.replace(tag, "[TAG-" + i + "]");
+		if (tags.length <= 3) for (const [i, tag] of tags.entries()) input = replaceFirst(input, tag, placeholder(i));
 		else {
 			const tagPositions = [];
 			let lastIndex = 0;
 			for (const [i, tag] of tags.entries()) {
 				const pos = input.indexOf(tag, lastIndex);
-				if (pos !== -1) {
-					tagPositions.push({
-						pos,
-						tag,
-						placeholder: "[TAG-" + i + "]"
-					});
-					lastIndex = pos + tag.length;
-				}
+				if (pos === -1) continue;
+				tagPositions.push({
+					pos,
+					tag,
+					placeholder: placeholder(i)
+				});
+				lastIndex = pos + tag.length;
 			}
 			if (tagPositions.length > 0) {
 				const parts = [];
@@ -440,14 +516,17 @@ var yabbcode = class {
 				input = parts.join("");
 			}
 		}
+		input = this.#applyLayout(input);
 		tagsMap = this.#tagLoop(tagsMap);
 		input = this.#contentLoop(tagsMap, input);
-		if (this.config.cleanUnmatchable) input = input.replace(this.regex.placeholders, "");
-		return input;
+		if (this.config.cleanUnmatchable) return input.replaceAll(this.regex.placeholders, "");
+		return input.replaceAll(this.regex.placeholders, (_match, index) => {
+			let raw = tags[Number(index)] ?? "";
+			if (!this.config.sanitizeHtml) raw = escapeHtmlAttr(raw);
+			return this.#convertNewlines(raw);
+		});
 	}
 };
-var ya_bbcode_default = yabbcode;
 
-//#endregion
-module.exports = ya_bbcode_default;
+module.exports = yabbcode;
 //# sourceMappingURL=ya-bbcode.cjs.map