@chayns-components/format 5.0.0-beta.1007

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Tobit Laboratories AG
+
+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

@@ -0,0 +1,11 @@
+# `format`
+
+> TODO: description
+
+## Usage
+
+```
+const format = require('format');
+
+// TODO: DEMONSTRATE API
+```

package/lib/cjs/constants/format.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.BB_CODE_HTML_TAG_PREFIX = void 0;
+const BB_CODE_HTML_TAG_PREFIX = exports.BB_CODE_HTML_TAG_PREFIX = 'bb-code-';
+//# sourceMappingURL=format.js.map

package/lib/cjs/constants/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","names":["BB_CODE_HTML_TAG_PREFIX","exports"],"sources":["../../../src/constants/format.ts"],"sourcesContent":["export const BB_CODE_HTML_TAG_PREFIX = 'bb-code-';\n"],"mappings":";;;;;;AAAO,MAAMA,uBAAuB,GAAAC,OAAA,CAAAD,uBAAA,GAAG,UAAU","ignoreList":[]}

package/lib/cjs/index.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "BB_CODE_HTML_TAG_PREFIX", {
+  enumerable: true,
+  get: function () {
+    return _format.BB_CODE_HTML_TAG_PREFIX;
+  }
+});
+Object.defineProperty(exports, "formatStringToHtml", {
+  enumerable: true,
+  get: function () {
+    return _formatString.formatStringToHtml;
+  }
+});
+var _format = require("./constants/format");
+var _formatString = require("./utils/formatString/formatString");
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_format","require","_formatString"],"sources":["../../src/index.ts"],"sourcesContent":["export { BB_CODE_HTML_TAG_PREFIX } from './constants/format';\nexport type { TableObject } from './types/format';\nexport { formatStringToHtml } from './utils/formatString/formatString';\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAEA,IAAAC,aAAA,GAAAD,OAAA","ignoreList":[]}

package/lib/cjs/types/format.js

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=format.js.map

package/lib/cjs/types/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","names":[],"sources":["../../../src/types/format.ts"],"sourcesContent":["export type TableObject = {\n    raw: string;\n    csv: string;\n    id: string;\n};\n"],"mappings":"","ignoreList":[]}

package/lib/cjs/utils/escape.js

@@ -0,0 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.escapeHtmlInText = void 0;
+const escapeHtmlInText = text => text.replace(/</g, '&lt;').replace(/>/g, '&gt;');
+exports.escapeHtmlInText = escapeHtmlInText;
+//# sourceMappingURL=escape.js.map

package/lib/cjs/utils/escape.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"escape.js","names":["escapeHtmlInText","text","replace","exports"],"sources":["../../../src/utils/escape.ts"],"sourcesContent":["export const escapeHtmlInText = (text: string): string =>\n    text.replace(/</g, '&lt;').replace(/>/g, '&gt;');\n"],"mappings":";;;;;;AAAO,MAAMA,gBAAgB,GAAIC,IAAY,IACzCA,IAAI,CAACC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAACA,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;AAACC,OAAA,CAAAH,gBAAA,GAAAA,gBAAA","ignoreList":[]}

package/lib/cjs/utils/formatString/bb-code/findBBCode.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.findFirstBBCode = findFirstBBCode;
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+const BB_REGEX = /(\[([a-zA-Z0-9_]*)(.*?)\])(.*?)(\[\/\2\])/s;
+// Also matches "\" before quote to fix button for voucher messages
+const PARAMETER_REGEX = /([\w]*?)=\\?["„“‚'‘](.*?)["“”‘'’]/g;
+// TODO Use external package instead of RegExp to parse BBCode.
+//  It is not recommended to use RegExp to parse markup languages like BBCode, because it is not possible to parse nested tags with it.
+
+// Finds and returns the first BBCode tag in the input string.
+function findFirstBBCode(inputString) {
+  const matches = BB_REGEX.exec(inputString);
+  if (matches !== null) {
+    const [fullMatch, openingTag, tag, params, content, closingTag] = matches;
+    const {
+      index
+    } = matches;
+    if (fullMatch === undefined || tag === undefined || params === undefined || content === undefined || openingTag === undefined || closingTag === undefined) return null;
+    const parameters = {};
+    let match = null;
+    // eslint-disable-next-line no-cond-assign
+    while (match = PARAMETER_REGEX.exec(params)) {
+      const [, key, value] = match;
+      if (value) {
+        parameters[key || 'url'] = value;
+      }
+    }
+    return {
+      fullMatch,
+      tag,
+      parameters,
+      content,
+      index,
+      openingTag,
+      closingTag
+    };
+  }
+  return null;
+}
+//# sourceMappingURL=findBBCode.js.map

package/lib/cjs/utils/formatString/bb-code/findBBCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"findBBCode.js","names":["BB_REGEX","PARAMETER_REGEX","findFirstBBCode","inputString","matches","exec","fullMatch","openingTag","tag","params","content","closingTag","index","undefined","parameters","match","key","value"],"sources":["../../../../../src/utils/formatString/bb-code/findBBCode.ts"],"sourcesContent":["// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n// @ts-ignore\nconst BB_REGEX = /(\\[([a-zA-Z0-9_]*)(.*?)\\])(.*?)(\\[\\/\\2\\])/s;\n// Also matches \"\\\" before quote to fix button for voucher messages\nconst PARAMETER_REGEX = /([\\w]*?)=\\\\?[\"„“‚'‘](.*?)[\"“”‘'’]/g;\n\nexport interface BBCodeMatch {\n    fullMatch: string;\n    tag: string;\n    parameters: Record<string, string>;\n    content: string;\n    index: number;\n    openingTag: string;\n    closingTag: string;\n}\n\n// TODO Use external package instead of RegExp to parse BBCode.\n//  It is not recommended to use RegExp to parse markup languages like BBCode, because it is not possible to parse nested tags with it.\n\n// Finds and returns the first BBCode tag in the input string.\nexport function findFirstBBCode(inputString: string): BBCodeMatch | null {\n    const matches = BB_REGEX.exec(inputString);\n\n    if (matches !== null) {\n        const [fullMatch, openingTag, tag, params, content, closingTag] = matches;\n        const { index } = matches;\n\n        if (\n            fullMatch === undefined ||\n            tag === undefined ||\n            params === undefined ||\n            content === undefined ||\n            openingTag === undefined ||\n            closingTag === undefined\n        )\n            return null;\n\n        const parameters: Record<string, string> = {};\n\n        let match: RegExpExecArray | null = null;\n        // eslint-disable-next-line no-cond-assign\n        while ((match = PARAMETER_REGEX.exec(params))) {\n            const [, key, value] = match;\n\n            if (value) {\n                parameters[key || 'url'] = value;\n            }\n        }\n\n        return {\n            fullMatch,\n            tag,\n            parameters,\n            content,\n            index,\n            openingTag,\n            closingTag,\n        };\n    }\n\n    return null;\n}\n"],"mappings":";;;;;;AAAA;AACA;AACA,MAAMA,QAAQ,GAAG,4CAA4C;AAC7D;AACA,MAAMC,eAAe,GAAG,oCAAoC;AAY5D;AACA;;AAEA;AACO,SAASC,eAAeA,CAACC,WAAmB,EAAsB;EACrE,MAAMC,OAAO,GAAGJ,QAAQ,CAACK,IAAI,CAACF,WAAW,CAAC;EAE1C,IAAIC,OAAO,KAAK,IAAI,EAAE;IAClB,MAAM,CAACE,SAAS,EAAEC,UAAU,EAAEC,GAAG,EAAEC,MAAM,EAAEC,OAAO,EAAEC,UAAU,CAAC,GAAGP,OAAO;IACzE,MAAM;MAAEQ;IAAM,CAAC,GAAGR,OAAO;IAEzB,IACIE,SAAS,KAAKO,SAAS,IACvBL,GAAG,KAAKK,SAAS,IACjBJ,MAAM,KAAKI,SAAS,IACpBH,OAAO,KAAKG,SAAS,IACrBN,UAAU,KAAKM,SAAS,IACxBF,UAAU,KAAKE,SAAS,EAExB,OAAO,IAAI;IAEf,MAAMC,UAAkC,GAAG,CAAC,CAAC;IAE7C,IAAIC,KAA6B,GAAG,IAAI;IACxC;IACA,OAAQA,KAAK,GAAGd,eAAe,CAACI,IAAI,CAACI,MAAM,CAAC,EAAG;MAC3C,MAAM,GAAGO,GAAG,EAAEC,KAAK,CAAC,GAAGF,KAAK;MAE5B,IAAIE,KAAK,EAAE;QACPH,UAAU,CAACE,GAAG,IAAI,KAAK,CAAC,GAAGC,KAAK;MACpC;IACJ;IAEA,OAAO;MACHX,SAAS;MACTE,GAAG;MACHM,UAAU;MACVJ,OAAO;MACPE,KAAK;MACLL,UAAU;MACVI;IACJ,CAAC;EACL;EAEA,OAAO,IAAI;AACf","ignoreList":[]}

package/lib/cjs/utils/formatString/bb-code/formatBBCode.js

@@ -0,0 +1,94 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.unescapeBBCodeSquareBrackets = exports.parseBBCode = exports.escapeBBCodeSquareBrackets = void 0;
+var _format = require("../../../constants/format");
+var _findBBCode = require("./findBBCode");
+const BLOCK_LEVEL_TAGS = ['center', 'ul', 'ol', 'li', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'p'];
+const INLINE_LEVEL_TAGS = ['b', 'strong', 'i', 'em', 'u', 's', 'span', 'img'];
+// Parses BB-Code to HTML recursively.
+// When justEscapeSquareBrackets is true, square brackets are escaped to prevent conflicts between markdown and BB Code.
+// In that case the function only escapes square brackets and doesn't remove line breaks.
+const parseBBCode = (text, options) => {
+  const {
+    customBlockLevelBBCodeTags: customBlockLevelTags = [],
+    customInlineLevelBBCodeTags: customInlineLevelTags = [],
+    justEscapeSquareBrackets = false
+  } = options || {};
+  let html = text;
+
+  // This index is used to keep track of the position in the html string that is being parsed.
+  let parseBehindIndex = 0;
+  while (parseBehindIndex < html.length) {
+    const htmlToParse = html.slice(parseBehindIndex);
+    const firstBBCodeMatch = (0, _findBBCode.findFirstBBCode)(htmlToParse);
+
+    // Stops parsing if no BB-Code is found.
+    if (!firstBBCodeMatch) {
+      return html;
+    }
+    const {
+      content,
+      fullMatch,
+      parameters,
+      index,
+      openingTag,
+      closingTag
+    } = firstBBCodeMatch;
+    const Tag = firstBBCodeMatch.tag.toLowerCase();
+    const isValidTag = [...BLOCK_LEVEL_TAGS, ...customBlockLevelTags, ...INLINE_LEVEL_TAGS, ...customInlineLevelTags].includes(Tag);
+    const isBlockLevelTag = [...BLOCK_LEVEL_TAGS, ...customBlockLevelTags].includes(Tag);
+
+    // Ignores tags that are not supported.
+    if (!isValidTag) {
+      // The parsing continues behind the first square bracket of the BB-Code tag.
+      parseBehindIndex += index + 1;
+      // eslint-disable-next-line no-continue
+      continue;
+    }
+
+    // Converts BB-Code tag's content before converting itself, because it may contain other BB-Codes.
+    let parsedContent = parseBBCode(content, options);
+    if (justEscapeSquareBrackets) {
+      const indexOfFullMatch = html.indexOf(fullMatch);
+      const escapedOpeningTag = escapeBBCodeSquareBrackets(openingTag);
+      const escapedClosingTag = escapeBBCodeSquareBrackets(closingTag);
+
+      // Removes leading and trailing line-breaks from within bb code elements, to prevent unwanted spacing.
+      // This needs to be done before formatting Markdown, so the Markdown formatting doesn't interpret line breaks unexpectedly.
+      parsedContent = parsedContent.replace(/^\n+|\n+$/g, '');
+
+      // Simply escapes the square brackets of the BB-Code opening and closing tag.
+      html = html.slice(0, indexOfFullMatch) + escapedOpeningTag + parsedContent + escapedClosingTag + html.slice(indexOfFullMatch + fullMatch.length);
+
+      // Continues parsing behind the parsed bb-code.
+      parseBehindIndex = indexOfFullMatch + escapedOpeningTag.length + parsedContent.length + escapedClosingTag.length;
+    } else {
+      const indexOfFullMatch = html.indexOf(fullMatch);
+      let htmlAfterTag = html.slice(indexOfFullMatch + fullMatch.length);
+
+      // Removes leading line-break (ONE, NOT ALL) after block level elements, to prevent unwanted spacing.
+      if (isBlockLevelTag) {
+        htmlAfterTag = htmlAfterTag.replace(/^\n/, '');
+      }
+      const isCustomTag = [...customBlockLevelTags, ...customInlineLevelTags].includes(Tag);
+      const htmlTag = isCustomTag ? `${_format.BB_CODE_HTML_TAG_PREFIX}${Tag}` : Tag;
+      const openingHtmlTag = `<${htmlTag}${Object.entries(parameters).length > 0 ? ' ' : ''}${Object.entries(parameters).map(([key, value]) => `${key}="${value}"`).join(' ')}>`;
+      const closingHtmlTag = `</${htmlTag}>`;
+      const element = Tag === 'img' ? openingHtmlTag : openingHtmlTag + parsedContent + closingHtmlTag;
+      html = `${html.slice(0, indexOfFullMatch)}${element}${htmlAfterTag}`;
+
+      // Continues parsing behind the parsed bb-code.
+      parseBehindIndex = indexOfFullMatch + element.length;
+    }
+  }
+  return html;
+};
+exports.parseBBCode = parseBBCode;
+const escapeBBCodeSquareBrackets = text => text.replaceAll('[', '&zwj;[&zwj;').replaceAll(']', '&zwj;]&zwj;');
+exports.escapeBBCodeSquareBrackets = escapeBBCodeSquareBrackets;
+const unescapeBBCodeSquareBrackets = text => text.replaceAll('&zwj;[&zwj;', '[').replaceAll('&zwj;]&zwj;', ']');
+exports.unescapeBBCodeSquareBrackets = unescapeBBCodeSquareBrackets;
+//# sourceMappingURL=formatBBCode.js.map

package/lib/cjs/utils/formatString/bb-code/formatBBCode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatBBCode.js","names":["_format","require","_findBBCode","BLOCK_LEVEL_TAGS","INLINE_LEVEL_TAGS","parseBBCode","text","options","customBlockLevelBBCodeTags","customBlockLevelTags","customInlineLevelBBCodeTags","customInlineLevelTags","justEscapeSquareBrackets","html","parseBehindIndex","length","htmlToParse","slice","firstBBCodeMatch","findFirstBBCode","content","fullMatch","parameters","index","openingTag","closingTag","Tag","tag","toLowerCase","isValidTag","includes","isBlockLevelTag","parsedContent","indexOfFullMatch","indexOf","escapedOpeningTag","escapeBBCodeSquareBrackets","escapedClosingTag","replace","htmlAfterTag","isCustomTag","htmlTag","BB_CODE_HTML_TAG_PREFIX","openingHtmlTag","Object","entries","map","key","value","join","closingHtmlTag","element","exports","replaceAll","unescapeBBCodeSquareBrackets"],"sources":["../../../../../src/utils/formatString/bb-code/formatBBCode.ts"],"sourcesContent":["import { BB_CODE_HTML_TAG_PREFIX } from '../../../constants/format';\nimport { findFirstBBCode } from './findBBCode';\n\nconst BLOCK_LEVEL_TAGS = ['center', 'ul', 'ol', 'li', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'p'];\nconst INLINE_LEVEL_TAGS = ['b', 'strong', 'i', 'em', 'u', 's', 'span', 'img'];\n\nexport interface ParseBBCodesOptions {\n    customBlockLevelBBCodeTags?: string[];\n    customInlineLevelBBCodeTags?: string[];\n}\n\ninterface ParseBBCodePrivateOptions extends ParseBBCodesOptions {\n    justEscapeSquareBrackets?: boolean;\n}\n\n// Parses BB-Code to HTML recursively.\n// When justEscapeSquareBrackets is true, square brackets are escaped to prevent conflicts between markdown and BB Code.\n// In that case the function only escapes square brackets and doesn't remove line breaks.\nexport const parseBBCode = (text: string, options?: ParseBBCodePrivateOptions) => {\n    const {\n        customBlockLevelBBCodeTags: customBlockLevelTags = [],\n        customInlineLevelBBCodeTags: customInlineLevelTags = [],\n        justEscapeSquareBrackets = false,\n    } = options || {};\n\n    let html = text;\n\n    // This index is used to keep track of the position in the html string that is being parsed.\n    let parseBehindIndex = 0;\n\n    while (parseBehindIndex < html.length) {\n        const htmlToParse = html.slice(parseBehindIndex);\n\n        const firstBBCodeMatch = findFirstBBCode(htmlToParse);\n\n        // Stops parsing if no BB-Code is found.\n        if (!firstBBCodeMatch) {\n            return html;\n        }\n\n        const { content, fullMatch, parameters, index, openingTag, closingTag } = firstBBCodeMatch;\n\n        const Tag = firstBBCodeMatch.tag.toLowerCase();\n        const isValidTag = [\n            ...BLOCK_LEVEL_TAGS,\n            ...customBlockLevelTags,\n            ...INLINE_LEVEL_TAGS,\n            ...customInlineLevelTags,\n        ].includes(Tag);\n        const isBlockLevelTag = [...BLOCK_LEVEL_TAGS, ...customBlockLevelTags].includes(Tag);\n\n        // Ignores tags that are not supported.\n        if (!isValidTag) {\n            // The parsing continues behind the first square bracket of the BB-Code tag.\n            parseBehindIndex += index + 1;\n            // eslint-disable-next-line no-continue\n            continue;\n        }\n\n        // Converts BB-Code tag's content before converting itself, because it may contain other BB-Codes.\n        let parsedContent = parseBBCode(content, options);\n\n        if (justEscapeSquareBrackets) {\n            const indexOfFullMatch = html.indexOf(fullMatch);\n            const escapedOpeningTag = escapeBBCodeSquareBrackets(openingTag);\n            const escapedClosingTag = escapeBBCodeSquareBrackets(closingTag);\n\n            // Removes leading and trailing line-breaks from within bb code elements, to prevent unwanted spacing.\n            // This needs to be done before formatting Markdown, so the Markdown formatting doesn't interpret line breaks unexpectedly.\n            parsedContent = parsedContent.replace(/^\\n+|\\n+$/g, '');\n\n            // Simply escapes the square brackets of the BB-Code opening and closing tag.\n            html =\n                html.slice(0, indexOfFullMatch) +\n                escapedOpeningTag +\n                parsedContent +\n                escapedClosingTag +\n                html.slice(indexOfFullMatch + fullMatch.length);\n\n            // Continues parsing behind the parsed bb-code.\n            parseBehindIndex =\n                indexOfFullMatch +\n                escapedOpeningTag.length +\n                parsedContent.length +\n                escapedClosingTag.length;\n        } else {\n            const indexOfFullMatch = html.indexOf(fullMatch);\n\n            let htmlAfterTag = html.slice(indexOfFullMatch + fullMatch.length);\n\n            // Removes leading line-break (ONE, NOT ALL) after block level elements, to prevent unwanted spacing.\n            if (isBlockLevelTag) {\n                htmlAfterTag = htmlAfterTag.replace(/^\\n/, '');\n            }\n\n            const isCustomTag = [...customBlockLevelTags, ...customInlineLevelTags].includes(Tag);\n            const htmlTag = isCustomTag ? `${BB_CODE_HTML_TAG_PREFIX}${Tag}` : Tag;\n            const openingHtmlTag = `<${htmlTag}${Object.entries(parameters).length > 0 ? ' ' : ''}${Object.entries(\n                parameters,\n            )\n                .map(([key, value]) => `${key}=\"${value}\"`)\n                .join(' ')}>`;\n            const closingHtmlTag = `</${htmlTag}>`;\n\n            const element =\n                Tag === 'img' ? openingHtmlTag : openingHtmlTag + parsedContent + closingHtmlTag;\n\n            html = `${html.slice(0, indexOfFullMatch)}${element}${htmlAfterTag}`;\n\n            // Continues parsing behind the parsed bb-code.\n            parseBehindIndex = indexOfFullMatch + element.length;\n        }\n    }\n\n    return html;\n};\n\nexport const escapeBBCodeSquareBrackets = (text: string) =>\n    text.replaceAll('[', '&zwj;[&zwj;').replaceAll(']', '&zwj;]&zwj;');\n\nexport const unescapeBBCodeSquareBrackets = (text: string) =>\n    text.replaceAll('&zwj;[&zwj;', '[').replaceAll('&zwj;]&zwj;', ']');\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,WAAA,GAAAD,OAAA;AAEA,MAAME,gBAAgB,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC;AAC9F,MAAMC,iBAAiB,GAAG,CAAC,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC;AAW7E;AACA;AACA;AACO,MAAMC,WAAW,GAAGA,CAACC,IAAY,EAAEC,OAAmC,KAAK;EAC9E,MAAM;IACFC,0BAA0B,EAAEC,oBAAoB,GAAG,EAAE;IACrDC,2BAA2B,EAAEC,qBAAqB,GAAG,EAAE;IACvDC,wBAAwB,GAAG;EAC/B,CAAC,GAAGL,OAAO,IAAI,CAAC,CAAC;EAEjB,IAAIM,IAAI,GAAGP,IAAI;;EAEf;EACA,IAAIQ,gBAAgB,GAAG,CAAC;EAExB,OAAOA,gBAAgB,GAAGD,IAAI,CAACE,MAAM,EAAE;IACnC,MAAMC,WAAW,GAAGH,IAAI,CAACI,KAAK,CAACH,gBAAgB,CAAC;IAEhD,MAAMI,gBAAgB,GAAG,IAAAC,2BAAe,EAACH,WAAW,CAAC;;IAErD;IACA,IAAI,CAACE,gBAAgB,EAAE;MACnB,OAAOL,IAAI;IACf;IAEA,MAAM;MAAEO,OAAO;MAAEC,SAAS;MAAEC,UAAU;MAAEC,KAAK;MAAEC,UAAU;MAAEC;IAAW,CAAC,GAAGP,gBAAgB;IAE1F,MAAMQ,GAAG,GAAGR,gBAAgB,CAACS,GAAG,CAACC,WAAW,CAAC,CAAC;IAC9C,MAAMC,UAAU,GAAG,CACf,GAAG1B,gBAAgB,EACnB,GAAGM,oBAAoB,EACvB,GAAGL,iBAAiB,EACpB,GAAGO,qBAAqB,CAC3B,CAACmB,QAAQ,CAACJ,GAAG,CAAC;IACf,MAAMK,eAAe,GAAG,CAAC,GAAG5B,gBAAgB,EAAE,GAAGM,oBAAoB,CAAC,CAACqB,QAAQ,CAACJ,GAAG,CAAC;;IAEpF;IACA,IAAI,CAACG,UAAU,EAAE;MACb;MACAf,gBAAgB,IAAIS,KAAK,GAAG,CAAC;MAC7B;MACA;IACJ;;IAEA;IACA,IAAIS,aAAa,GAAG3B,WAAW,CAACe,OAAO,EAAEb,OAAO,CAAC;IAEjD,IAAIK,wBAAwB,EAAE;MAC1B,MAAMqB,gBAAgB,GAAGpB,IAAI,CAACqB,OAAO,CAACb,SAAS,CAAC;MAChD,MAAMc,iBAAiB,GAAGC,0BAA0B,CAACZ,UAAU,CAAC;MAChE,MAAMa,iBAAiB,GAAGD,0BAA0B,CAACX,UAAU,CAAC;;MAEhE;MACA;MACAO,aAAa,GAAGA,aAAa,CAACM,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;;MAEvD;MACAzB,IAAI,GACAA,IAAI,CAACI,KAAK,CAAC,CAAC,EAAEgB,gBAAgB,CAAC,GAC/BE,iBAAiB,GACjBH,aAAa,GACbK,iBAAiB,GACjBxB,IAAI,CAACI,KAAK,CAACgB,gBAAgB,GAAGZ,SAAS,CAACN,MAAM,CAAC;;MAEnD;MACAD,gBAAgB,GACZmB,gBAAgB,GAChBE,iBAAiB,CAACpB,MAAM,GACxBiB,aAAa,CAACjB,MAAM,GACpBsB,iBAAiB,CAACtB,MAAM;IAChC,CAAC,MAAM;MACH,MAAMkB,gBAAgB,GAAGpB,IAAI,CAACqB,OAAO,CAACb,SAAS,CAAC;MAEhD,IAAIkB,YAAY,GAAG1B,IAAI,CAACI,KAAK,CAACgB,gBAAgB,GAAGZ,SAAS,CAACN,MAAM,CAAC;;MAElE;MACA,IAAIgB,eAAe,EAAE;QACjBQ,YAAY,GAAGA,YAAY,CAACD,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;MAClD;MAEA,MAAME,WAAW,GAAG,CAAC,GAAG/B,oBAAoB,EAAE,GAAGE,qBAAqB,CAAC,CAACmB,QAAQ,CAACJ,GAAG,CAAC;MACrF,MAAMe,OAAO,GAAGD,WAAW,GAAG,GAAGE,+BAAuB,GAAGhB,GAAG,EAAE,GAAGA,GAAG;MACtE,MAAMiB,cAAc,GAAG,IAAIF,OAAO,GAAGG,MAAM,CAACC,OAAO,CAACvB,UAAU,CAAC,CAACP,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,GAAG6B,MAAM,CAACC,OAAO,CAClGvB,UACJ,CAAC,CACIwB,GAAG,CAAC,CAAC,CAACC,GAAG,EAAEC,KAAK,CAAC,KAAK,GAAGD,GAAG,KAAKC,KAAK,GAAG,CAAC,CAC1CC,IAAI,CAAC,GAAG,CAAC,GAAG;MACjB,MAAMC,cAAc,GAAG,KAAKT,OAAO,GAAG;MAEtC,MAAMU,OAAO,GACTzB,GAAG,KAAK,KAAK,GAAGiB,cAAc,GAAGA,cAAc,GAAGX,aAAa,GAAGkB,cAAc;MAEpFrC,IAAI,GAAG,GAAGA,IAAI,CAACI,KAAK,CAAC,CAAC,EAAEgB,gBAAgB,CAAC,GAAGkB,OAAO,GAAGZ,YAAY,EAAE;;MAEpE;MACAzB,gBAAgB,GAAGmB,gBAAgB,GAAGkB,OAAO,CAACpC,MAAM;IACxD;EACJ;EAEA,OAAOF,IAAI;AACf,CAAC;AAACuC,OAAA,CAAA/C,WAAA,GAAAA,WAAA;AAEK,MAAM+B,0BAA0B,GAAI9B,IAAY,IACnDA,IAAI,CAAC+C,UAAU,CAAC,GAAG,EAAE,aAAa,CAAC,CAACA,UAAU,CAAC,GAAG,EAAE,aAAa,CAAC;AAACD,OAAA,CAAAhB,0BAAA,GAAAA,0BAAA;AAEhE,MAAMkB,4BAA4B,GAAIhD,IAAY,IACrDA,IAAI,CAAC+C,UAAU,CAAC,aAAa,EAAE,GAAG,CAAC,CAACA,UAAU,CAAC,aAAa,EAAE,GAAG,CAAC;AAACD,OAAA,CAAAE,4BAAA,GAAAA,4BAAA","ignoreList":[]}

package/lib/cjs/utils/formatString/formatString.js

@@ -0,0 +1,83 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.formatStringToHtml = void 0;
+var _escape = require("../escape");
+var _formatBBCode = require("./bb-code/formatBBCode");
+var _formatMarkdown = require("./markdown/formatMarkdown");
+// This function takes a string and returns formatted html as a string.
+const formatStringToHtml = (string, options) => {
+  if (!string) {
+    return {
+      html: '',
+      tables: []
+    };
+  }
+  const {
+    parseMarkdown: parseMarkdownOption = true,
+    parseBBCode: parseBBCodeOption = false,
+    customInlineLevelBBCodeTags = [],
+    customBlockLevelBBCodeTags = []
+  } = options || {};
+  let formattedString = string;
+
+  // Needs to get the tables before escaping html and parsing bb-code, so the original content can be extracted.
+  const tables = [];
+  if (parseMarkdownOption) {
+    try {
+      tables.push(...(0, _formatMarkdown.getMarkdownTables)(formattedString));
+    } catch (error) {
+      console.warn('[@chayns-components/format] Warning: Failed to get markdown tables', error);
+    }
+  }
+
+  // Escape HTML entities.
+  formattedString = (0, _escape.escapeHtmlInText)(formattedString);
+
+  // Escape BB-Code, to prevent conflicts between markdown and bb-code. Specifically [b]test[/b]() would be a problem, since markdown interprets parts of this as a link.
+
+  // Parses markdown to HTML.
+  if (parseMarkdownOption) {
+    try {
+      if (parseBBCodeOption) {
+        // Escapes BB-Code brackets.
+        formattedString = (0, _formatBBCode.parseBBCode)(formattedString, {
+          customInlineLevelBBCodeTags,
+          customBlockLevelBBCodeTags,
+          justEscapeSquareBrackets: true
+        });
+      }
+      formattedString = (0, _formatMarkdown.parseMarkdown)(formattedString, parseBBCodeOption);
+
+      // Remove trailing \n
+      formattedString = formattedString.replace(/\n$/, '');
+      if (parseBBCodeOption) {
+        // Unescapes BB-Code brackets.
+        formattedString = (0, _formatBBCode.unescapeBBCodeSquareBrackets)(formattedString);
+      }
+    } catch (error) {
+      console.warn('[@chayns-components/format] Warning: Failed to parse markdown', error);
+    }
+  }
+
+  // Parses BB-Code to HTML.
+  if (parseBBCodeOption) {
+    try {
+      formattedString = (0, _formatBBCode.parseBBCode)(formattedString, {
+        customInlineLevelBBCodeTags,
+        customBlockLevelBBCodeTags
+      });
+      formattedString = (0, _formatBBCode.unescapeBBCodeSquareBrackets)(formattedString);
+    } catch (error) {
+      console.warn('[@chayns-components/format] Warning: Failed to parse bb-code', error);
+    }
+  }
+  return {
+    html: formattedString,
+    tables
+  };
+};
+exports.formatStringToHtml = formatStringToHtml;
+//# sourceMappingURL=formatString.js.map

package/lib/cjs/utils/formatString/formatString.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatString.js","names":["_escape","require","_formatBBCode","_formatMarkdown","formatStringToHtml","string","options","html","tables","parseMarkdown","parseMarkdownOption","parseBBCode","parseBBCodeOption","customInlineLevelBBCodeTags","customBlockLevelBBCodeTags","formattedString","push","getMarkdownTables","error","console","warn","escapeHtmlInText","justEscapeSquareBrackets","replace","unescapeBBCodeSquareBrackets","exports"],"sources":["../../../../src/utils/formatString/formatString.ts"],"sourcesContent":["import type { TableObject } from '../../types/format';\nimport { escapeHtmlInText } from '../escape';\nimport {\n    parseBBCode,\n    ParseBBCodesOptions,\n    unescapeBBCodeSquareBrackets,\n} from './bb-code/formatBBCode';\nimport { getMarkdownTables, parseMarkdown } from './markdown/formatMarkdown';\n\ninterface FormatStringOptions extends ParseBBCodesOptions {\n    parseMarkdown?: boolean;\n    parseBBCode?: boolean;\n}\n\ninterface FormatStringResult {\n    html: string;\n    tables: TableObject[];\n}\n\n// This function takes a string and returns formatted html as a string.\nexport const formatStringToHtml = (\n    string: string,\n    options?: FormatStringOptions,\n): FormatStringResult => {\n    if (!string) {\n        return {\n            html: '',\n            tables: [],\n        };\n    }\n\n    const {\n        parseMarkdown: parseMarkdownOption = true,\n        parseBBCode: parseBBCodeOption = false,\n        customInlineLevelBBCodeTags = [],\n        customBlockLevelBBCodeTags = [],\n    } = options || {};\n\n    let formattedString = string;\n\n    // Needs to get the tables before escaping html and parsing bb-code, so the original content can be extracted.\n    const tables: TableObject[] = [];\n    if (parseMarkdownOption) {\n        try {\n            tables.push(...getMarkdownTables(formattedString));\n        } catch (error) {\n            console.warn(\n                '[@chayns-components/format] Warning: Failed to get markdown tables',\n                error,\n            );\n        }\n    }\n\n    // Escape HTML entities.\n    formattedString = escapeHtmlInText(formattedString);\n\n    // Escape BB-Code, to prevent conflicts between markdown and bb-code. Specifically [b]test[/b]() would be a problem, since markdown interprets parts of this as a link.\n\n    // Parses markdown to HTML.\n    if (parseMarkdownOption) {\n        try {\n            if (parseBBCodeOption) {\n                // Escapes BB-Code brackets.\n                formattedString = parseBBCode(formattedString, {\n                    customInlineLevelBBCodeTags,\n                    customBlockLevelBBCodeTags,\n                    justEscapeSquareBrackets: true,\n                });\n            }\n\n            formattedString = parseMarkdown(formattedString, parseBBCodeOption);\n\n            // Remove trailing \\n\n            formattedString = formattedString.replace(/\\n$/, '');\n\n            if (parseBBCodeOption) {\n                // Unescapes BB-Code brackets.\n                formattedString = unescapeBBCodeSquareBrackets(formattedString);\n            }\n        } catch (error) {\n            console.warn('[@chayns-components/format] Warning: Failed to parse markdown', error);\n        }\n    }\n\n    // Parses BB-Code to HTML.\n    if (parseBBCodeOption) {\n        try {\n            formattedString = parseBBCode(formattedString, {\n                customInlineLevelBBCodeTags,\n                customBlockLevelBBCodeTags,\n            });\n            formattedString = unescapeBBCodeSquareBrackets(formattedString);\n        } catch (error) {\n            console.warn('[@chayns-components/format] Warning: Failed to parse bb-code', error);\n        }\n    }\n\n    return {\n        html: formattedString,\n        tables,\n    };\n};\n"],"mappings":";;;;;;AACA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAKA,IAAAE,eAAA,GAAAF,OAAA;AAYA;AACO,MAAMG,kBAAkB,GAAGA,CAC9BC,MAAc,EACdC,OAA6B,KACR;EACrB,IAAI,CAACD,MAAM,EAAE;IACT,OAAO;MACHE,IAAI,EAAE,EAAE;MACRC,MAAM,EAAE;IACZ,CAAC;EACL;EAEA,MAAM;IACFC,aAAa,EAAEC,mBAAmB,GAAG,IAAI;IACzCC,WAAW,EAAEC,iBAAiB,GAAG,KAAK;IACtCC,2BAA2B,GAAG,EAAE;IAChCC,0BAA0B,GAAG;EACjC,CAAC,GAAGR,OAAO,IAAI,CAAC,CAAC;EAEjB,IAAIS,eAAe,GAAGV,MAAM;;EAE5B;EACA,MAAMG,MAAqB,GAAG,EAAE;EAChC,IAAIE,mBAAmB,EAAE;IACrB,IAAI;MACAF,MAAM,CAACQ,IAAI,CAAC,GAAG,IAAAC,iCAAiB,EAACF,eAAe,CAAC,CAAC;IACtD,CAAC,CAAC,OAAOG,KAAK,EAAE;MACZC,OAAO,CAACC,IAAI,CACR,oEAAoE,EACpEF,KACJ,CAAC;IACL;EACJ;;EAEA;EACAH,eAAe,GAAG,IAAAM,wBAAgB,EAACN,eAAe,CAAC;;EAEnD;;EAEA;EACA,IAAIL,mBAAmB,EAAE;IACrB,IAAI;MACA,IAAIE,iBAAiB,EAAE;QACnB;QACAG,eAAe,GAAG,IAAAJ,yBAAW,EAACI,eAAe,EAAE;UAC3CF,2BAA2B;UAC3BC,0BAA0B;UAC1BQ,wBAAwB,EAAE;QAC9B,CAAC,CAAC;MACN;MAEAP,eAAe,GAAG,IAAAN,6BAAa,EAACM,eAAe,EAAEH,iBAAiB,CAAC;;MAEnE;MACAG,eAAe,GAAGA,eAAe,CAACQ,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;MAEpD,IAAIX,iBAAiB,EAAE;QACnB;QACAG,eAAe,GAAG,IAAAS,0CAA4B,EAACT,eAAe,CAAC;MACnE;IACJ,CAAC,CAAC,OAAOG,KAAK,EAAE;MACZC,OAAO,CAACC,IAAI,CAAC,+DAA+D,EAAEF,KAAK,CAAC;IACxF;EACJ;;EAEA;EACA,IAAIN,iBAAiB,EAAE;IACnB,IAAI;MACAG,eAAe,GAAG,IAAAJ,yBAAW,EAACI,eAAe,EAAE;QAC3CF,2BAA2B;QAC3BC;MACJ,CAAC,CAAC;MACFC,eAAe,GAAG,IAAAS,0CAA4B,EAACT,eAAe,CAAC;IACnE,CAAC,CAAC,OAAOG,KAAK,EAAE;MACZC,OAAO,CAACC,IAAI,CAAC,8DAA8D,EAAEF,KAAK,CAAC;IACvF;EACJ;EAEA,OAAO;IACHX,IAAI,EAAEQ,eAAe;IACrBP;EACJ,CAAC;AACL,CAAC;AAACiB,OAAA,CAAArB,kBAAA,GAAAA,kBAAA","ignoreList":[]}