ya-bbcode 3.1.0 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ya-bbcode",
-	"version": "3.1.0",
+	"version": "4.0.0",
 	"description": "Yet another BBCode Parser",
 	"keywords": [
 		"bbc",
@@ -34,23 +34,22 @@
 	"lint-staged": {
 		"*.js": "eslint --cache"
 	},
-	"dependencies": {},
 	"devDependencies": {
-		"@commitlint/cli": "^17.4.2",
-		"@commitlint/config-conventional": "^17.4.2",
-		"@nodecraft/eslint-config": "^22.0.0",
-		"ava": "^5.1.1",
+		"@commitlint/cli": "^17.6.5",
+		"@commitlint/config-conventional": "^17.6.5",
+		"@nodecraft/eslint-config": "^25.0.1",
+		"ava": "^5.3.0",
 		"coveralls": "^3.1.1",
-		"eslint": "^8.32.0",
+		"eslint": "^8.41.0",
 		"eslint-plugin-json": "^3.1.0",
 		"eslint-plugin-node": "^11.1.0",
-		"eslint-plugin-unicorn": "^45.0.2",
+		"eslint-plugin-unicorn": "^47.0.0",
 		"husky": "^8.0.3",
-		"lint-staged": "^13.1.0",
+		"lint-staged": "^13.2.2",
 		"nyc": "^15.1.0"
 	},
 	"engines": {
-		"node": ">=14",
+		"node": ">=16",
 		"npm": ">=8"
 	}
 }

package/ya-bbcode.d.ts

@@ -1,38 +1,39 @@
-export = yabbcode
-
-declare class yabbcode {
-	/**
-	 * Create a new bbcode parser
-	 */
-	constructor(config?: {
-		newline?: boolean
-		paragraph?: boolean
-		cleanUnmatchable?: boolean
-	})
-	/**
-	 * Parse bbcode
-	 * @param bbc bbcode to parse
-	 */
-	parse(bbc: any): string
-	/**
-	 * Remove all default or registered tags
-	 */
-	clearTags(): this
-	/**
-	 * Add custom tags
-	 * @param tag tag name
-	 * @param options options to parse the tag
-	 */
-	registerTag(tag: string, options: {
-		type: 'replace'
-		open: ((attr: string) => string) | string
-		close: ((attr: string) => string) | string | null
-	}): this
-	registerTag(tag: string, options: {
-		type: 'content',
-		replace: (attr: string, content: string) => string
-	}): this
-	registerTag(tag: string, options: {
-		type: 'ignore'
-	}): this
+export = yabbcode
+
+declare class yabbcode {
+	/**
+	 * Create a new bbcode parser
+	 */
+	constructor(config?: {
+		newline?: boolean
+		paragraph?: boolean
+		cleanUnmatchable?: boolean
+		sanitizeHtml?: boolean
+	})
+	/**
+	 * Parse bbcode
+	 * @param bbc bbcode to parse
+	 */
+	parse(bbc: any): string
+	/**
+	 * Remove all default or registered tags
+	 */
+	clearTags(): this
+	/**
+	 * Add custom tags
+	 * @param tag tag name
+	 * @param options options to parse the tag
+	 */
+	registerTag(tag: string, options: {
+		type: 'replace'
+		open: ((attr: string) => string) | string
+		close: ((attr: string) => string) | string | null
+	}): this
+	registerTag(tag: string, options: {
+		type: 'content',
+		replace: (attr: string, content: string) => string
+	}): this
+	registerTag(tag: string, options: {
+		type: 'ignore'
+	}): this
 }

package/ya-bbcode.js

@@ -90,7 +90,7 @@ class yabbcode {
 		'img': {
 			type: 'content',
 			replace: (attr, content) => {
-				if(!content){
+				if(!content) {
 					return '';
 				}
 				return `<img src="${content}" alt="${attr || ''}"/>`;
@@ -109,32 +109,32 @@ class yabbcode {
 		replace: (tag, module, content) => {
 			let open = module.open;
 			let close = module.close;
-			if(typeof(open) === 'function'){
+			if(typeof(open) === 'function') {
 				open = open(tag.attr);
 			}
-			if(typeof(close) === 'function'){
+			if(typeof(close) === 'function') {
 				close = close(tag.attr);
 			}
 			// do the replace
-			if(open && !tag.isClosing){
+			if(open && !tag.isClosing) {
 				//content = content
 				content = content.replace('[TAG-' + tag.index + ']', open);
 			}
-			if(close && tag.closing){
+			if(close && tag.closing) {
 				content = content.replace('[TAG-' + tag.closing.index + ']', close);
 			}
 			return content;
 		},
 		content: (tag, module, content) => {
-			if(!tag.closing){ return content; }
-			const openTag = "[TAG-" + tag.index + "]";
-			const closeTag = "[TAG-" + tag.closing.index + "]";
+			if(!tag.closing) { return content; }
+			const openTag = '[TAG-' + tag.index + ']';
+			const closeTag = '[TAG-' + tag.closing.index + ']';
 			const start = content.indexOf(openTag);
 			const end = content.indexOf(closeTag);
 			let	replace = module.replace;
 
 			const innerContent = content.slice(start + openTag.length, end);
-			if(typeof(replace) === 'function'){
+			if(typeof(replace) === 'function') {
 				replace = replace(tag.attr, innerContent);
 			}
 
@@ -144,12 +144,12 @@ class yabbcode {
 			return contentStart + replace + contentEnd;
 		},
 		ignore: (tag, module, content) => {
-			const openTag = "[TAG-" + tag.index + "]";
+			const openTag = '[TAG-' + tag.index + ']';
 			const start = content.indexOf(openTag);
-			let closeTag = "";
+			let closeTag = '';
 			let end = content.length;
-			if(tag.closing){
-				closeTag = "[TAG-" + tag.closing.index + "]";
+			if(tag.closing) {
+				closeTag = '[TAG-' + tag.closing.index + ']';
 				end = content.indexOf(closeTag);
 			}
 			let innerContent = content.slice(start + openTag.length, end);
@@ -159,40 +159,44 @@ class yabbcode {
 			return contentStart + innerContent + contentEnd;
 		},
 	};
-	constructor(config = {}){
+	constructor(config = {}) {
 		this.config = {
 			newline: true,
 			paragraph: false,
 			cleanUnmatchable: true,
+			sanitizeHtml: true,
 		};
-		if(config.newline !== undefined){
+		if(config.newline !== undefined) {
 			this.config.newline = config.newline;
 		}
-		if(config.paragraph !== undefined){
+		if(config.paragraph !== undefined) {
 			this.config.paragraph = config.paragraph;
 		}
-		if(config.cleanUnmatchable !== undefined){
+		if(config.cleanUnmatchable !== undefined) {
 			this.config.cleanUnmatchable = config.cleanUnmatchable;
 		}
+		if(config.sanitizeHtml !== undefined) {
+			this.config.sanitizeHtml = config.sanitizeHtml;
+		}
 	}
 
-	#ignoreLoop = function(tagsMap, content){
-		for(const tag of tagsMap){
+	#ignoreLoop = function(tagsMap, content) {
+		for(const tag of tagsMap) {
 			content = content.replace('[TAG-' + tag.index + ']', tag.raw);
-			if(tag.closing){
+			if(tag.closing) {
 				content = content.replace('[TAG-' + tag.closing.index + ']', tag.closing.raw);
 			}
-			if(tag.children.length > 0){
+			if(tag.children.length > 0) {
 				content = this.#ignoreLoop(tag.children, content);
 			}
 		}
 		return content;
 	};
 
-	#contentLoop = function(tagsMap, content){
-		for(const tag of tagsMap){
+	#contentLoop = function(tagsMap, content) {
+		for(const tag of tagsMap) {
 			let module = this.tags[tag.module];
-			if(!module){
+			if(!module) {
 				// ignore invalid BBCode
 				module = {
 					type: 'replace',
@@ -200,11 +204,11 @@ class yabbcode {
 					close: tag.closing && tag.closing.raw || '',
 				};
 			}
-			if(!this.contentModules[module.type]){
-				throw new Error("Cannot parse content block. Invalid block type [" + module.type + "] provided for tag [" + tag.module + "]");
+			if(!this.contentModules[module.type]) {
+				throw new Error('Cannot parse content block. Invalid block type [' + module.type + '] provided for tag [' + tag.module + ']');
 			}
 			content = this.contentModules[module.type](tag, module, content);
-			if(tag.children.length > 0 && module.type !== 'ignore'){
+			if(tag.children.length > 0 && module.type !== 'ignore') {
 				content = this.#contentLoop(tag.children, content);
 			}
 		}
@@ -212,15 +216,15 @@ class yabbcode {
 		return content;
 	};
 
-	#tagLoop = function(tagsMap, parent){
+	#tagLoop = function(tagsMap, parent) {
 		let currentTagIndex = 0;
-		while(currentTagIndex < tagsMap.length){
+		while(currentTagIndex < tagsMap.length) {
 			let found = false;
-			if(tagsMap[currentTagIndex].matchTag !== null || tagsMap[currentTagIndex].isClosing){
+			if(tagsMap[currentTagIndex].matchTag !== null || tagsMap[currentTagIndex].isClosing) {
 				currentTagIndex++;
 				continue; // already handled this tag / not closing
 			}
-			for(const [i, item] of tagsMap.entries()){
+			for(const [i, item] of tagsMap.entries()) {
 				if(
 					found ||
 					tagsMap[currentTagIndex].matchTag !== null ||
@@ -228,7 +232,7 @@ class yabbcode {
 					item.matchTag !== null ||
 					!item.isClosing ||
 					tagsMap[currentTagIndex].module !== item.module
-				){
+				) {
 					continue;
 				}
 				tagsMap[i].matchTag = tagsMap[currentTagIndex].index;
@@ -238,7 +242,7 @@ class yabbcode {
 
 			const childStart = currentTagIndex + 1;
 
-			if(found !== false){
+			if(found !== false) {
 				tagsMap[currentTagIndex].closing = tagsMap[tagsMap[currentTagIndex].matchTag];
 			}else{
 				tagsMap[currentTagIndex].matchTag = false;
@@ -246,7 +250,7 @@ class yabbcode {
 			}
 
 			// sweep children
-			if(childStart < found){
+			if(childStart < found) {
 				tagsMap[currentTagIndex].children = tagsMap.slice(childStart, found).map((child) => {
 					child.parent = tagsMap[currentTagIndex].index;
 					return child;
@@ -254,7 +258,7 @@ class yabbcode {
 			}
 
 			let i = childStart;
-			while(i < found){
+			while(i < found) {
 				tagsMap[i].parent = tagsMap[currentTagIndex].index;
 				i++;
 			}
@@ -267,48 +271,57 @@ class yabbcode {
 		tagsMap = tagsMap.filter(item => !((parent === undefined && item.parent !== null) || (item.parent !== null && item.parent !== parent) || item.isClosing));
 
 		return tagsMap.map((tag) => {
-			if(tag.children.length > 0){
+			if(tag.children.length > 0) {
 				tag.children = this.#tagLoop(tag.children, tag.index);
 			}
 			return tag;
 		});
 	};
 
-	clearTags(){
+	clearTags() {
 		this.tags = {};
 		return this;
 	}
 
-	registerTag(tag, options){
+	registerTag(tag, options) {
 		this.tags[String(tag).toLowerCase()] = options;
 		return this;
 	}
 
-	parse(bbcInput){
-		if(typeof(bbcInput) === 'boolean' || typeof(bbcInput) !== 'string' && Number.isNaN(Number(bbcInput))){ return ''; }
+	parse(bbcInput) {
+		if(typeof(bbcInput) === 'boolean' || typeof(bbcInput) !== 'string' && Number.isNaN(Number(bbcInput))) { return ''; }
 		// eslint-disable-next-line unicorn/prefer-spread
 		let input = String(bbcInput).slice(0); // cheap string clone
+		if(this.config.sanitizeHtml) {
+			input = input
+				.replaceAll('&', '&amp;')
+				.replaceAll('<', '&lt;')
+				.replaceAll('>', '&gt;')
+				.replaceAll('"', '&quot;')
+				.replaceAll('\'', '&#39;');
+		}
+
 		// reset
 		let tagsMap = [];
 		// split input into tags by index
 		const tags = String(input).match(this.regex.tags);
 
-		if(this.config.newline){
-			if(this.config.paragraph){
-				input = input.replace(this.regex.newline, "</p><p>");
+		if(this.config.newline) {
+			if(this.config.paragraph) {
+				input = input.replace(this.regex.newline, '</p><p>');
 			}else{
-				input = input.replace(this.regex.newline, "<br/>");
+				input = input.replace(this.regex.newline, '<br/>');
 			}
 		}
-		if(this.config.paragraph){
+		if(this.config.paragraph) {
 			input = '<p>' + input + '</p>';
 		}
 
 		// handle when no tags are present
-		if(!tags || tags.length === 0){
+		if(!tags || tags.length === 0) {
 			return input;
 		}
-		for(const [i, tag] of tags.entries()){
+		for(const [i, tag] of tags.entries()) {
 			const parts = tag.slice(1, -1).split('=');
 			const item = {
 				index: i,
@@ -321,7 +334,7 @@ class yabbcode {
 				parent: null,
 				matchTag: null,
 			};
-			if(item.isClosing){
+			if(item.isClosing) {
 				item.module = item.module.slice(1);
 			}
 
@@ -332,7 +345,7 @@ class yabbcode {
 		tagsMap = this.#tagLoop(tagsMap);
 		// put back all non-found matches?
 		input = this.#contentLoop(tagsMap, input);
-		if(this.config.cleanUnmatchable){
+		if(this.config.cleanUnmatchable) {
 			input = input.replace(this.regex.placeholders, '');
 		}
 		return input;