@atlaskit/editor-wikimarkup-transformer 11.1.14 → 11.1.16

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/editor-wikimarkup-transformer
 
+## 11.1.16
+
+### Patch Changes
+
+- [`5ae242b554c`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5ae242b554c) - updated logic to handle multiple linebreaks inside a macro within a list
+
+## 11.1.15
+
+### Patch Changes
+
+- [`7c57f6550f7`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7c57f6550f7) - Updated metacharacter escaping logic in encoder
+
 ## 11.1.14
 
 ### Patch Changes

package/dist/cjs/encoder/nodes/text.js

@@ -30,6 +30,7 @@ var markEncoderMapping = new Map([['em', _em.em], ['strike', _strike.strike], ['
  */
 var MENTION_ESCAPE_PATTERN = '(\\[~)'; // Matches pattern like [~
 var MEDIA_ESCAPE_PATTERN = '(![^ !]+)(!)'; // Matches non space content between two consecutive "!" e.g. !filename.txt!
+var MEDIA_GROUP_ESCAPE_PATTERN = '(\\[\\^[^ ]+)(\\])'; // Matches non space content between two consecutive "[^" "]" e.g. [^filename.txt]
 
 /**
  * Checks if the node's content needs to be escaped before continuing processing.
@@ -53,9 +54,9 @@ function escapingWikiFormatter(text) {
   var pattern = [MENTION_ESCAPE_PATTERN].concat((0, _toConsumableArray2.default)(_keyword.macroKeywordTokenMap.map(function (macro) {
     return "(".concat(macro.regex.source.replace('^', ''), ")");
   }))).join('|');
-  return text.replace(new RegExp(pattern, 'g'), '\\$&').replace(new RegExp(MEDIA_ESCAPE_PATTERN, 'g'), '\\$1\\$2'); // Extra step required for media as currently both ends need to be escaped e.q. !filename.txt!
+  return text.replace(new RegExp(pattern, 'g'), '\\$&').replace(new RegExp(MEDIA_ESCAPE_PATTERN, 'g'), '\\$1\\$2') // Extra step required for media as currently both ends need to be escaped e.q. !filename.txt!
+  .replace(new RegExp(MEDIA_GROUP_ESCAPE_PATTERN, 'g'), '\\$1\\$2');
 }
-
 var text = function text(node) {
   var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
     parent = _ref.parent;

package/dist/cjs/parser/tokenize/list.js

@@ -42,8 +42,16 @@ var list = function list(_ref) {
   var builder = null;
   var contentBuffer = [];
   var output = [];
+  var isWithinMacro = false;
+  var macroLength = 0;
   while (index < input.length) {
     var char = input.charAt(index);
+
+    // Reset macro flags -> if we finished parsing the macro block. There can be multiple concecutive macros in a same listItem
+    if (isWithinMacro && index === macroLength) {
+      isWithinMacro = false;
+      macroLength = 0;
+    }
     switch (state) {
       case processState.NEW_LINE:
         {
@@ -107,7 +115,8 @@ var list = function list(_ref) {
 
           // If we encounter an empty line, we should end the list
           var emptyLineMatch = substring.match(EMPTY_LINE_REGEXP);
-          if (emptyLineMatch) {
+          // ADFEXP-371 -> We should not end the list if we are inside a macro and we encountered a new line
+          if (emptyLineMatch && !isWithinMacro) {
             state = processState.END;
             continue;
           }
@@ -143,33 +152,42 @@ var list = function list(_ref) {
           if (token.type === 'text') {
             buffer.push(token.text);
           } else {
-            var _contentBuffer3;
             // We found a macro in the list...
             if (!builder) {
               // Something is really wrong here
               return fallback(input, position);
             }
-            if (buffer.length > 0) {
-              var _contentBuffer2;
-              /**
-               * Wrapup what is already in the string buffer and save it to
-               * contentBuffer
-               */
-              var _content = (0, _text.parseString)({
-                ignoreTokenTypes: ignoreTokenTypes,
-                schema: schema,
-                context: context,
-                input: buffer.join(''),
-                includeLeadingSpace: true
-              });
-              (_contentBuffer2 = contentBuffer).push.apply(_contentBuffer2, (0, _toConsumableArray2.default)(sanitize(_content, schema)));
-              buffer = [];
+            //   if (buffer.length > 0) {
+            //     /**
+            //      * Wrapup what is already in the string buffer and save it to
+            //      * contentBuffer
+            //      */
+            //     const content = parseString({
+            //       ignoreTokenTypes,
+            //       schema,
+            //       context,
+            //       input: buffer.join(''),
+            //       includeLeadingSpace: true,
+            //     });
+            //     contentBuffer.push(...sanitize(content, schema));
+            //     buffer = [];
+            //   }
+
+            //   contentBuffer.push(...sanitize(token.nodes, schema));
+            // }
+            // index += token.length;
+            // state = processState.BUFFER;
+            // continue;
+
+            // ADFEXP-371 -> check if we encountered a macro and also that we are not inside a macro block already.
+            if (token && !isWithinMacro) {
+              isWithinMacro = true;
+              // macroLength will help to reset the isWithinMacro flag once we have sucessfully parsed entire macro block
+              macroLength = index + token.length;
             }
-            (_contentBuffer3 = contentBuffer).push.apply(_contentBuffer3, (0, _toConsumableArray2.default)(sanitize(token.nodes, schema)));
           }
-          index += token.length;
-          state = processState.BUFFER;
-          continue;
+          buffer.push(char);
+          break;
         }
       case processState.END:
         {
@@ -178,16 +196,16 @@ var list = function list(_ref) {
             return fallback(input, position);
           }
           if (buffer.length > 0) {
-            var _contentBuffer4;
+            var _contentBuffer2;
             // Wrap up previous list item and clear buffer
-            var _content2 = (0, _text.parseString)({
+            var _content = (0, _text.parseString)({
               ignoreTokenTypes: ignoreTokenTypes,
               schema: schema,
               context: context,
               input: buffer.join(''),
               includeLeadingSpace: true
             });
-            (_contentBuffer4 = contentBuffer).push.apply(_contentBuffer4, (0, _toConsumableArray2.default)(_content2));
+            (_contentBuffer2 = contentBuffer).push.apply(_contentBuffer2, (0, _toConsumableArray2.default)(_content));
           }
           builder.add([{
             style: lastListSymbols,
@@ -204,16 +222,16 @@ var list = function list(_ref) {
     index++;
   }
   if (buffer.length > 0) {
-    var _contentBuffer5;
+    var _contentBuffer3;
     // Wrap up what's left in the buffer
-    var _content3 = (0, _text.parseString)({
+    var _content2 = (0, _text.parseString)({
       ignoreTokenTypes: ignoreTokenTypes,
       schema: schema,
       context: context,
       input: buffer.join(''),
       includeLeadingSpace: true
     });
-    (_contentBuffer5 = contentBuffer).push.apply(_contentBuffer5, (0, _toConsumableArray2.default)(_content3));
+    (_contentBuffer3 = contentBuffer).push.apply(_contentBuffer3, (0, _toConsumableArray2.default)(_content2));
   }
   if (builder) {
     builder.add([{

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-wikimarkup-transformer",
-	"version": "11.1.14",
+	"version": "11.1.16",
 	"sideEffects": false
 }

package/dist/es2019/encoder/nodes/text.js

@@ -23,6 +23,7 @@ const markEncoderMapping = new Map([['em', em], ['strike', strike], ['strong', s
  */
 const MENTION_ESCAPE_PATTERN = '(\\[~)'; // Matches pattern like [~
 const MEDIA_ESCAPE_PATTERN = '(![^ !]+)(!)'; // Matches non space content between two consecutive "!" e.g. !filename.txt!
+const MEDIA_GROUP_ESCAPE_PATTERN = '(\\[\\^[^ ]+)(\\])'; // Matches non space content between two consecutive "[^" "]" e.g. [^filename.txt]
 
 /**
  * Checks if the node's content needs to be escaped before continuing processing.
@@ -42,9 +43,9 @@ const isEscapeNeeded = (node, parent) => {
  */
 function escapingWikiFormatter(text) {
   const pattern = [MENTION_ESCAPE_PATTERN, ...macroKeywordTokenMap.map(macro => `(${macro.regex.source.replace('^', '')})`)].join('|');
-  return text.replace(new RegExp(pattern, 'g'), '\\$&').replace(new RegExp(MEDIA_ESCAPE_PATTERN, 'g'), '\\$1\\$2'); // Extra step required for media as currently both ends need to be escaped e.q. !filename.txt!
+  return text.replace(new RegExp(pattern, 'g'), '\\$&').replace(new RegExp(MEDIA_ESCAPE_PATTERN, 'g'), '\\$1\\$2') // Extra step required for media as currently both ends need to be escaped e.q. !filename.txt!
+  .replace(new RegExp(MEDIA_GROUP_ESCAPE_PATTERN, 'g'), '\\$1\\$2');
 }
-
 export const text = (node, {
   parent
 } = {}) => {

package/dist/es2019/parser/tokenize/list.js

@@ -33,8 +33,16 @@ export const list = ({
   let builder = null;
   let contentBuffer = [];
   const output = [];
+  let isWithinMacro = false;
+  let macroLength = 0;
   while (index < input.length) {
     const char = input.charAt(index);
+
+    // Reset macro flags -> if we finished parsing the macro block. There can be multiple concecutive macros in a same listItem
+    if (isWithinMacro && index === macroLength) {
+      isWithinMacro = false;
+      macroLength = 0;
+    }
     switch (state) {
       case processState.NEW_LINE:
         {
@@ -96,7 +104,8 @@ export const list = ({
 
           // If we encounter an empty line, we should end the list
           const emptyLineMatch = substring.match(EMPTY_LINE_REGEXP);
-          if (emptyLineMatch) {
+          // ADFEXP-371 -> We should not end the list if we are inside a macro and we encountered a new line
+          if (emptyLineMatch && !isWithinMacro) {
             state = processState.END;
             continue;
           }
@@ -137,26 +146,37 @@ export const list = ({
               // Something is really wrong here
               return fallback(input, position);
             }
-            if (buffer.length > 0) {
-              /**
-               * Wrapup what is already in the string buffer and save it to
-               * contentBuffer
-               */
-              const content = parseString({
-                ignoreTokenTypes,
-                schema,
-                context,
-                input: buffer.join(''),
-                includeLeadingSpace: true
-              });
-              contentBuffer.push(...sanitize(content, schema));
-              buffer = [];
+            //   if (buffer.length > 0) {
+            //     /**
+            //      * Wrapup what is already in the string buffer and save it to
+            //      * contentBuffer
+            //      */
+            //     const content = parseString({
+            //       ignoreTokenTypes,
+            //       schema,
+            //       context,
+            //       input: buffer.join(''),
+            //       includeLeadingSpace: true,
+            //     });
+            //     contentBuffer.push(...sanitize(content, schema));
+            //     buffer = [];
+            //   }
+
+            //   contentBuffer.push(...sanitize(token.nodes, schema));
+            // }
+            // index += token.length;
+            // state = processState.BUFFER;
+            // continue;
+
+            // ADFEXP-371 -> check if we encountered a macro and also that we are not inside a macro block already.
+            if (token && !isWithinMacro) {
+              isWithinMacro = true;
+              // macroLength will help to reset the isWithinMacro flag once we have sucessfully parsed entire macro block
+              macroLength = index + token.length;
             }
-            contentBuffer.push(...sanitize(token.nodes, schema));
           }
-          index += token.length;
-          state = processState.BUFFER;
-          continue;
+          buffer.push(char);
+          break;
         }
       case processState.END:
         {

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-wikimarkup-transformer",
-	"version": "11.1.14",
+	"version": "11.1.16",
 	"sideEffects": false
 }

package/dist/esm/encoder/nodes/text.js

@@ -24,6 +24,7 @@ var markEncoderMapping = new Map([['em', em], ['strike', strike], ['strong', str
  */
 var MENTION_ESCAPE_PATTERN = '(\\[~)'; // Matches pattern like [~
 var MEDIA_ESCAPE_PATTERN = '(![^ !]+)(!)'; // Matches non space content between two consecutive "!" e.g. !filename.txt!
+var MEDIA_GROUP_ESCAPE_PATTERN = '(\\[\\^[^ ]+)(\\])'; // Matches non space content between two consecutive "[^" "]" e.g. [^filename.txt]
 
 /**
  * Checks if the node's content needs to be escaped before continuing processing.
@@ -47,9 +48,9 @@ function escapingWikiFormatter(text) {
   var pattern = [MENTION_ESCAPE_PATTERN].concat(_toConsumableArray(macroKeywordTokenMap.map(function (macro) {
     return "(".concat(macro.regex.source.replace('^', ''), ")");
   }))).join('|');
-  return text.replace(new RegExp(pattern, 'g'), '\\$&').replace(new RegExp(MEDIA_ESCAPE_PATTERN, 'g'), '\\$1\\$2'); // Extra step required for media as currently both ends need to be escaped e.q. !filename.txt!
+  return text.replace(new RegExp(pattern, 'g'), '\\$&').replace(new RegExp(MEDIA_ESCAPE_PATTERN, 'g'), '\\$1\\$2') // Extra step required for media as currently both ends need to be escaped e.q. !filename.txt!
+  .replace(new RegExp(MEDIA_GROUP_ESCAPE_PATTERN, 'g'), '\\$1\\$2');
 }
-
 export var text = function text(node) {
   var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
     parent = _ref.parent;

package/dist/esm/parser/tokenize/list.js

@@ -34,8 +34,16 @@ export var list = function list(_ref) {
   var builder = null;
   var contentBuffer = [];
   var output = [];
+  var isWithinMacro = false;
+  var macroLength = 0;
   while (index < input.length) {
     var char = input.charAt(index);
+
+    // Reset macro flags -> if we finished parsing the macro block. There can be multiple concecutive macros in a same listItem
+    if (isWithinMacro && index === macroLength) {
+      isWithinMacro = false;
+      macroLength = 0;
+    }
     switch (state) {
       case processState.NEW_LINE:
         {
@@ -99,7 +107,8 @@ export var list = function list(_ref) {
 
           // If we encounter an empty line, we should end the list
           var emptyLineMatch = substring.match(EMPTY_LINE_REGEXP);
-          if (emptyLineMatch) {
+          // ADFEXP-371 -> We should not end the list if we are inside a macro and we encountered a new line
+          if (emptyLineMatch && !isWithinMacro) {
             state = processState.END;
             continue;
           }
@@ -135,33 +144,42 @@ export var list = function list(_ref) {
           if (token.type === 'text') {
             buffer.push(token.text);
           } else {
-            var _contentBuffer3;
             // We found a macro in the list...
             if (!builder) {
               // Something is really wrong here
               return fallback(input, position);
             }
-            if (buffer.length > 0) {
-              var _contentBuffer2;
-              /**
-               * Wrapup what is already in the string buffer and save it to
-               * contentBuffer
-               */
-              var _content = parseString({
-                ignoreTokenTypes: ignoreTokenTypes,
-                schema: schema,
-                context: context,
-                input: buffer.join(''),
-                includeLeadingSpace: true
-              });
-              (_contentBuffer2 = contentBuffer).push.apply(_contentBuffer2, _toConsumableArray(sanitize(_content, schema)));
-              buffer = [];
+            //   if (buffer.length > 0) {
+            //     /**
+            //      * Wrapup what is already in the string buffer and save it to
+            //      * contentBuffer
+            //      */
+            //     const content = parseString({
+            //       ignoreTokenTypes,
+            //       schema,
+            //       context,
+            //       input: buffer.join(''),
+            //       includeLeadingSpace: true,
+            //     });
+            //     contentBuffer.push(...sanitize(content, schema));
+            //     buffer = [];
+            //   }
+
+            //   contentBuffer.push(...sanitize(token.nodes, schema));
+            // }
+            // index += token.length;
+            // state = processState.BUFFER;
+            // continue;
+
+            // ADFEXP-371 -> check if we encountered a macro and also that we are not inside a macro block already.
+            if (token && !isWithinMacro) {
+              isWithinMacro = true;
+              // macroLength will help to reset the isWithinMacro flag once we have sucessfully parsed entire macro block
+              macroLength = index + token.length;
             }
-            (_contentBuffer3 = contentBuffer).push.apply(_contentBuffer3, _toConsumableArray(sanitize(token.nodes, schema)));
           }
-          index += token.length;
-          state = processState.BUFFER;
-          continue;
+          buffer.push(char);
+          break;
         }
       case processState.END:
         {
@@ -170,16 +188,16 @@ export var list = function list(_ref) {
             return fallback(input, position);
           }
           if (buffer.length > 0) {
-            var _contentBuffer4;
+            var _contentBuffer2;
             // Wrap up previous list item and clear buffer
-            var _content2 = parseString({
+            var _content = parseString({
               ignoreTokenTypes: ignoreTokenTypes,
               schema: schema,
               context: context,
               input: buffer.join(''),
               includeLeadingSpace: true
             });
-            (_contentBuffer4 = contentBuffer).push.apply(_contentBuffer4, _toConsumableArray(_content2));
+            (_contentBuffer2 = contentBuffer).push.apply(_contentBuffer2, _toConsumableArray(_content));
           }
           builder.add([{
             style: lastListSymbols,
@@ -196,16 +214,16 @@ export var list = function list(_ref) {
     index++;
   }
   if (buffer.length > 0) {
-    var _contentBuffer5;
+    var _contentBuffer3;
     // Wrap up what's left in the buffer
-    var _content3 = parseString({
+    var _content2 = parseString({
       ignoreTokenTypes: ignoreTokenTypes,
       schema: schema,
       context: context,
       input: buffer.join(''),
       includeLeadingSpace: true
     });
-    (_contentBuffer5 = contentBuffer).push.apply(_contentBuffer5, _toConsumableArray(_content3));
+    (_contentBuffer3 = contentBuffer).push.apply(_contentBuffer3, _toConsumableArray(_content2));
   }
   if (builder) {
     builder.add([{

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/editor-wikimarkup-transformer",
-	"version": "11.1.14",
+	"version": "11.1.16",
 	"sideEffects": false
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-wikimarkup-transformer",
-  "version": "11.1.14",
+  "version": "11.1.16",
   "description": "Wiki markup transformer for JIRA and Confluence",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -33,7 +33,7 @@
   "devDependencies": {
     "@atlaskit/activity": "^1.0.1",
     "@atlaskit/docs": "*",
-    "@atlaskit/editor-common": "^72.8.0",
+    "@atlaskit/editor-common": "^72.9.0",
     "@atlaskit/editor-core": "^182.1.0",
     "@atlaskit/editor-test-helpers": "^18.2.0",
     "@atlaskit/mention": "^22.0.0",