@atlaskit/editor-jira-transformer 8.2.3 → 8.2.5

package/dist/es2019/index.js

@@ -9,70 +9,64 @@ export class JIRATransformer {
     this.customEncoders = customEncoders || {};
     this.mediaContextInfo = mediaContextInfo;
   }
-
   encode(node) {
     this.doc = this.makeDocument();
     this.doc.body.appendChild(this.encodeFragment(node.content));
-    const html = this.doc.body.innerHTML; // JIRA encodes empty documents as an empty string
+    const html = this.doc.body.innerHTML;
 
+    // JIRA encodes empty documents as an empty string
     if (html === '<p></p>') {
       return '';
-    } // Normalise to XHTML style self closing tags.
-
+    }
 
+    // Normalise to XHTML style self closing tags.
     return html.replace(/<br><\/br>/g, '<br />').replace(/<br>/g, '<br />').replace(/<hr><\/hr>/g, '<hr />').replace(/<hr>/g, '<hr />').replace(/&amp;/g, '&');
   }
-
   parse(html) {
     const convertedNodes = new WeakMap();
     const dom = fixDoc(parseHtml(html)).querySelector('body');
-    const nodes = bfsOrder(dom); // JIRA encodes empty content as a single nbsp
+    const nodes = bfsOrder(dom);
 
+    // JIRA encodes empty content as a single nbsp
     if (nodes.length === 1 && nodes[0].textContent === '\xa0') {
       const schemaNodes = this.schema.nodes;
       return schemaNodes.doc.createChecked({}, schemaNodes.paragraph.createChecked());
-    } // Process through nodes in reverse (so deepest child elements are first).
-
+    }
 
+    // Process through nodes in reverse (so deepest child elements are first).
     for (let i = nodes.length - 1; i >= 0; i--) {
-      const node = nodes[i]; // for tables we take tbody content, because tbody is not in schema so the whole bfs thing wouldn't work
-
+      const node = nodes[i];
+      // for tables we take tbody content, because tbody is not in schema so the whole bfs thing wouldn't work
       const targetNode = node.tagName && node.tagName.toUpperCase() === 'TABLE' ? node.firstChild : node;
       const content = this.getContent(targetNode, convertedNodes);
       const candidate = convert(content, node, this.schema);
-
       if (typeof candidate !== 'undefined') {
         convertedNodes.set(node, candidate);
       }
     }
+    const content = this.getContent(dom, convertedNodes);
 
-    const content = this.getContent(dom, convertedNodes); // Dangling inline nodes can't be directly inserted into a document, so
+    // Dangling inline nodes can't be directly inserted into a document, so
     // we attempt to wrap in a paragraph.
-
     const compatibleContent = this.schema.nodes.doc.validContent(content) ? content : ensureBlocks(content, this.schema);
     return this.schema.nodes.doc.createChecked({}, compatibleContent);
   }
+
   /*
    * Contructs a struct string of replacement blocks and marks for a given node
    */
-
-
   getContent(node, convertedNodes) {
     let fragment = Fragment.fromArray([]);
     let childIndex;
-
     for (childIndex = 0; childIndex < node.childNodes.length; childIndex++) {
       const child = node.childNodes[childIndex];
       const thing = convertedNodes.get(child);
-
       if (thing instanceof Fragment || thing instanceof PMNode) {
         fragment = fragment.append(Fragment.from(thing));
       }
     }
-
     return fragment;
   }
-
   encodeNode(node) {
     const {
       blockquote,
@@ -91,19 +85,23 @@ export class JIRATransformer {
       mediaSingle,
       media,
       table
-    } = this.schema.nodes; // We compare node type names in this method rather than
+    } = this.schema.nodes;
+
+    // We compare node type names in this method rather than
     // node types directly as the node comparision fails.
+
     // This suggests the schema which is coming from
     // the doc has been recreated after being passed
     // to this transformer on setup which is somewhat
     // unexpected.
+
     // This package is internally (within editor) considered
     // "obsolete", and we are aiming to either hand over
     // or deprecate.
+
     // This "fix" is being done to unblock an existing
     // consumer so they can apply an unrelated security
     // upgrade.
-
     if (node.isText) {
       return this.encodeText(node);
     } else if (node.type.name === heading.name) {
@@ -115,7 +113,6 @@ export class JIRATransformer {
     } else if (node.type.name === hardBreak.name) {
       return this.encodeHardBreak();
     }
-
     if (isSchemaWithLists(this.schema)) {
       if (node.type.name === bulletList.name) {
         return this.encodeBulletList(node);
@@ -125,23 +122,18 @@ export class JIRATransformer {
         return this.encodeListItem(node);
       }
     }
-
     if (isSchemaWithMentions(this.schema) && node.type.name === mention.name) {
       return this.encodeMention(node, this.customEncoders.mention);
     }
-
     if (isSchemaWithEmojis(this.schema) && node.type.name === emoji.name) {
       return this.encodeEmoji(node);
     }
-
     if (isSchemaWithCodeBlock(this.schema) && node.type.name === codeBlock.name) {
       return this.encodeCodeBlock(node);
     }
-
     if (isSchemaWithBlockQuotes(this.schema) && node.type.name === blockquote.name) {
       return this.encodeBlockQuote(node);
     }
-
     if (isSchemaWithMedia(this.schema)) {
       if (node.type.name === mediaGroup.name) {
         return this.encodeMediaGroup(node);
@@ -151,27 +143,22 @@ export class JIRATransformer {
         return this.encodeMedia(node);
       }
     }
-
     if (isSchemaWithTables(this.schema) && node.type.name === table.name) {
       return this.encodeTable(node);
     }
-
     throw new Error(`Unexpected node '${node.type.name}' for HTML encoding`);
   }
-
   makeDocument() {
     const doc = document.implementation.createHTMLDocument('');
     doc.body = doc.createElement('body');
     doc.documentElement.appendChild(doc.body);
     return doc;
   }
-
   encodeFragment(fragment) {
     const documentFragment = this.doc.createDocumentFragment();
     fragment.forEach(node => documentFragment.appendChild(this.encodeNode(node)));
     return documentFragment;
   }
-
   encodeHeading(node) {
     function anchorNameEncode(name) {
       const noSpaces = name.replace(/ /g, '');
@@ -179,11 +166,10 @@ export class JIRATransformer {
       const specialsEncoded = uriEncoded.replace(/[!'()*]/g, c => '%' + c.charCodeAt(0).toString(16));
       return specialsEncoded;
     }
-
     const {
       level
-    } = node.attrs; // @see ED-4708
-
+    } = node.attrs;
+    // @see ED-4708
     const elem = this.doc.createElement(`h${level === 6 ? 5 : level}`);
     const anchor = this.doc.createElement('a');
     anchor.setAttribute('name', anchorNameEncode(node.textContent));
@@ -191,13 +177,11 @@ export class JIRATransformer {
     elem.appendChild(this.encodeFragment(node.content));
     return elem;
   }
-
   encodeParagraph(node) {
     const elem = this.doc.createElement('p');
     elem.appendChild(this.encodeFragment(node.content));
     return elem;
   }
-
   encodeText(node) {
     if (node.text) {
       const root = this.doc.createDocumentFragment();
@@ -213,127 +197,102 @@ export class JIRATransformer {
         underline,
         textColor
       } = this.schema.marks;
-
       for (const mark of node.marks) {
         switch (mark.type) {
           case strong:
             elem = elem.appendChild(this.doc.createElement('b'));
             break;
-
           case em:
             elem = elem.appendChild(this.doc.createElement('em'));
             break;
-
           case code:
             elem = elem.appendChild(this.doc.createElement('tt'));
             break;
-
           case strike:
             elem = elem.appendChild(this.doc.createElement('del'));
             break;
-
           case underline:
             elem = elem.appendChild(this.doc.createElement('ins'));
             break;
-
           case subsup:
             elem = elem.appendChild(this.doc.createElement(mark.attrs['type']));
             break;
-
           case link:
             const linkElem = this.doc.createElement('a');
             const href = mark.attrs['href'];
-            /** JIRA always expects external-link attribute set on links created via editor unless its #fragment */
 
+            /** JIRA always expects external-link attribute set on links created via editor unless its #fragment */
             if (!href.match(/^#/)) {
               linkElem.setAttribute('class', 'external-link');
               linkElem.setAttribute('rel', 'nofollow');
             }
-
             linkElem.setAttribute('href', href);
-
             if (mark.attrs['title']) {
               linkElem.setAttribute('title', mark.attrs['title']);
             }
-
             elem = elem.appendChild(linkElem);
             break;
-
           case textColor:
             const fontElem = this.doc.createElement('font');
             fontElem.setAttribute('color', mark.attrs['color']);
             elem = elem.appendChild(fontElem);
             break;
-
           case typeAheadQuery:
             break;
-
           default:
             throw new Error(`Unable to encode mark '${mark.type.name}'`);
         }
       }
-
       elem.textContent = node.text;
       return root;
     } else {
       return this.doc.createTextNode('');
     }
   }
-
   encodeHardBreak() {
     return this.doc.createElement('br');
   }
-
   encodeHorizontalRule() {
     return this.doc.createElement('hr');
   }
-
   encodeBulletList(node) {
     const elem = this.doc.createElement('ul');
     elem.setAttribute('class', 'alternate');
     elem.setAttribute('type', 'disc');
     elem.appendChild(this.encodeFragment(node.content));
-
     for (let index = 0; index < elem.childElementCount; index++) {
       elem.children[index].setAttribute('data-parent', 'ul');
     }
-
     return elem;
   }
-
   encodeOrderedList(node) {
     const elem = this.doc.createElement('ol');
     elem.appendChild(this.encodeFragment(node.content));
-
     for (let index = 0; index < elem.childElementCount; index++) {
       elem.children[index].setAttribute('data-parent', 'ol');
     }
-
     return elem;
   }
-
   encodeListItem(node) {
     const elem = this.doc.createElement('li');
-
     if (node.content.childCount) {
       let hasBlocks = false;
       node.content.forEach(childNode => {
         if (childNode.type === this.schema.nodes.bulletList || childNode.type === this.schema.nodes.orderedList) {
           const list = this.encodeNode(childNode);
+
           /**
            * Changing type for nested list:
            *
            * Second level -> circle
            * Third and deeper -> square
            */
-
           if (list instanceof HTMLElement && list.tagName === 'UL') {
             list.setAttribute('type', 'circle');
             [].forEach.call(list.querySelectorAll('ul'), ul => {
               ul.setAttribute('type', 'square');
             });
           }
-
           elem.appendChild(list);
         } else if (childNode.type.name === 'paragraph' && !hasBlocks) {
           // Strip the paragraph node from the list item.
@@ -342,15 +301,12 @@ export class JIRATransformer {
           if (childNode.isBlock) {
             hasBlocks = true;
           }
-
           elem.appendChild(this.encodeNode(childNode));
         }
       });
     }
-
     return elem;
   }
-
   encodeMention(node, encoder) {
     const elem = this.doc.createElement('a');
     elem.setAttribute('class', 'user-hover');
@@ -359,45 +315,39 @@ export class JIRATransformer {
     elem.appendChild(this.doc.createTextNode(node.attrs.text));
     return elem;
   }
-
   encodeEmoji(node) {
     return this.doc.createTextNode(node.attrs && node.attrs.text);
   }
-
   encodeCodeBlock(node) {
     const elem = this.doc.createElement('div');
     elem.setAttribute('class', 'code panel');
     const content = this.doc.createElement('div');
     content.setAttribute('class', 'codeContent panelContent');
-    const pre = this.doc.createElement('pre'); // java is default language for JIRA
-
+    const pre = this.doc.createElement('pre');
+    // java is default language for JIRA
     pre.setAttribute('class', `code-${(node.attrs.language || 'plain').toLocaleLowerCase()}`);
     pre.appendChild(this.encodeFragment(node.content));
     content.appendChild(pre);
     elem.appendChild(content);
     return elem;
   }
-
   encodeBlockQuote(node) {
     const elem = this.doc.createElement('blockquote');
     elem.appendChild(this.encodeFragment(node.content));
     return elem;
   }
-
   encodeMediaGroup(node) {
     const elem = this.doc.createElement('p');
     elem.setAttribute('class', 'mediaGroup');
     elem.appendChild(this.encodeFragment(node.content));
     return elem;
   }
-
   encodeMediaSingle(node) {
     const elem = this.doc.createElement('p');
     elem.setAttribute('class', 'mediaSingle');
     elem.appendChild(this.encodeFragment(node.content));
     return elem;
   }
-
   addDataToNode(domNode, mediaNode, defaultDisplayType = 'thumbnail') {
     const {
       id,
@@ -407,30 +357,24 @@ export class JIRATransformer {
       __displayType,
       width,
       height
-    } = mediaNode.attrs; // Order of dataset matters in IE Edge, please keep the current order
-
+    } = mediaNode.attrs;
+    // Order of dataset matters in IE Edge, please keep the current order
     domNode.setAttribute('data-attachment-type', __displayType || defaultDisplayType);
-
     if (__fileName) {
       domNode.setAttribute('data-attachment-name', __fileName);
     }
-
     if (width) {
       domNode.setAttribute('data-width', width);
     }
-
     if (height) {
       domNode.setAttribute('data-height', height);
     }
-
     domNode.setAttribute('data-media-services-type', type);
     domNode.setAttribute('data-media-services-id', id);
-
     if (collection) {
       domNode.setAttribute('data-media-services-collection', collection);
     }
   }
-
   buildURLWithContextInfo(fileId, contextInfo) {
     const {
       clientId,
@@ -440,17 +384,14 @@ export class JIRATransformer {
     } = contextInfo;
     return `${baseUrl}/file/${fileId}/image?token=${token}&client=${clientId}&collection=${collection}&width=200&height=200&mode=fit`;
   }
-
   isImageMimeType(mimeType) {
     return mimeType && mimeType.indexOf('image/') > -1;
   }
-
   encodeMedia(node) {
     // span.image-wrap > a > jira-attachment-thumbnail > img[data-media-*] > content
     // span.no-br > a[data-media] > content
     const elem = this.doc.createElement('span');
     const a = this.doc.createElement('a');
-
     if (node.attrs.__displayType === 'file' || !(node.attrs.__displayType || this.isImageMimeType(node.attrs.__fileMimeType))) {
       elem.setAttribute('class', 'nobr');
       this.addDataToNode(a, node, 'file');
@@ -458,24 +399,21 @@ export class JIRATransformer {
     } else {
       elem.setAttribute('class', 'image-wrap');
       const img = this.doc.createElement('img');
-      img.setAttribute('alt', node.attrs.__fileName); // Newly uploaded items have collection
-
+      img.setAttribute('alt', node.attrs.__fileName);
+      // Newly uploaded items have collection
       if (node.attrs.collection && this.mediaContextInfo && this.mediaContextInfo.uploadContext) {
         img.setAttribute('src', this.buildURLWithContextInfo(node.attrs.id, this.mediaContextInfo.uploadContext));
       } else if (this.mediaContextInfo && this.mediaContextInfo.viewContext) {
         img.setAttribute('src', this.buildURLWithContextInfo(node.attrs.id, this.mediaContextInfo.viewContext));
       }
-
       this.addDataToNode(img, node);
       const jiraThumb = this.doc.createElement('jira-attachment-thumbnail');
       jiraThumb.appendChild(img);
       a.appendChild(jiraThumb);
     }
-
     elem.appendChild(a);
     return elem;
   }
-
   encodeTable(node) {
     const elem = this.doc.createElement('table');
     const tbody = this.doc.createElement('tbody');
@@ -496,5 +434,4 @@ export class JIRATransformer {
     elem.setAttribute('class', 'confluenceTable');
     return elem;
   }
-
 }

package/dist/es2019/parse-html.js

@@ -6,7 +6,6 @@ export default function (fragment) {
   collapse(tree.documentElement, isBlock);
   return tree;
 }
-
 function isBlock(node) {
   // these blocks are mainly used to collapse whitespace between the blocks
   // (preventing spurious text nodes of ' ')
@@ -62,6 +61,5 @@ function isBlock(node) {
     case 'UL':
       return true;
   }
-
   return false;
 }