@atlaskit/editor-common 72.2.0 → 72.2.2

package/dist/es2019/utils/validator.js

@@ -4,7 +4,6 @@ export const ADFStages = {
   FINAL: 'final',
   STAGE_0: 'stage0'
 };
-
 /*
  * It's important that this order follows the marks rank defined here:
  * https://product-fabric.atlassian.net/wiki/spaces/E/pages/11174043/Document+structure#Documentstructure-Rank
@@ -13,57 +12,49 @@ export const markOrder = ['fragment', 'link', 'em', 'strong', 'textColor', 'stri
 export const isSubSupType = type => {
   return type === 'sub' || type === 'sup';
 };
+
 /*
  * Sorts mark by the predefined order above
  */
-
 export const getMarksByOrder = marks => {
   return [...marks].sort((a, b) => markOrder.indexOf(a.type.name) - markOrder.indexOf(b.type.name));
 };
+
 /*
  * Check if two marks are the same by comparing type and attrs
  */
-
 export const isSameMark = (mark, otherMark) => {
   if (!mark || !otherMark) {
     return false;
   }
-
   return mark.eq(otherMark);
 };
 export const getValidDocument = (doc, schema = defaultSchema, adfStage = 'final') => {
   const node = getValidNode(doc, schema, adfStage);
-
   if (node.type === 'doc') {
     node.content = wrapInlineNodes(node.content);
     return node;
   }
-
   return null;
 };
-
 const wrapInlineNodes = (nodes = []) => {
   return nodes.map(node => inlineNodes.has(node.type) ? {
     type: 'paragraph',
     content: [node]
   } : node);
 };
-
 export const getValidContent = (content, schema = defaultSchema, adfStage = 'final') => {
   return content.map(node => getValidNode(node, schema, adfStage));
 };
 const TEXT_COLOR_PATTERN = /^#[0-9a-fA-F]{6}$/;
 const RELATIVE_LINK = /^\//;
 const ANCHOR_LINK = /^#/;
-
 const flattenUnknownBlockTree = (node, schema = defaultSchema, adfStage = 'final') => {
   const output = [];
   let isPrevLeafNode = false;
-
   for (let i = 0; i < node.content.length; i++) {
     const childNode = node.content[i];
     const isLeafNode = !(childNode.content && childNode.content.length);
-
     if (i > 0) {
       if (isPrevLeafNode) {
         output.push({
@@ -76,25 +67,21 @@ const flattenUnknownBlockTree = (node, schema = defaultSchema, adfStage = 'final
         });
       }
     }
-
     if (isLeafNode) {
       output.push(getValidNode(childNode, schema, adfStage));
     } else {
       output.push(...flattenUnknownBlockTree(childNode, schema, adfStage));
     }
-
     isPrevLeafNode = isLeafNode;
   }
-
   return output;
 };
+
 /**
  * Sanitize unknown node tree
  *
  * @see https://product-fabric.atlassian.net/wiki/spaces/E/pages/11174043/Document+structure#Documentstructure-ImplementationdetailsforHCNGwebrenderer
  */
-
-
 export const getValidUnknownNode = node => {
   const {
     attrs = {},
@@ -102,7 +89,6 @@ export const getValidUnknownNode = node => {
     text,
     type
   } = node;
-
   if (!content || !content.length) {
     const unknownInlineNode = {
       type: 'text',
@@ -111,7 +97,6 @@ export const getValidUnknownNode = node => {
     const {
       textUrl
     } = attrs;
-
     if (textUrl && isSafeUrl(textUrl)) {
       unknownInlineNode.marks = [{
         type: 'link',
@@ -120,37 +105,32 @@ export const getValidUnknownNode = node => {
         }
       }];
     }
-
     return unknownInlineNode;
   }
+
   /*
    * Find leaf nodes and join them. If leaf nodes' parent node is the same node
    * join with a blank space, otherwise they are children of different branches, i.e.
    * we need to join them with a hardBreak node
    */
-
-
   return {
     type: 'unknownBlock',
     content: flattenUnknownBlockTree(node)
   };
 };
-
 const getValidMarks = (marks, adfStage = 'final') => {
   if (marks && marks.length > 0) {
     return marks.reduce((acc, mark) => {
       const validMark = getValidMark(mark, adfStage);
-
       if (validMark) {
         acc.push(validMark);
       }
-
       return acc;
     }, []);
   }
-
   return marks;
 };
+
 /*
  * This method will validate a Node according to the spec defined here
  * https://product-fabric.atlassian.net/wiki/spaces/E/pages/11174043/Document+structure#Documentstructure-Nodes
@@ -160,8 +140,6 @@ const getValidMarks = (marks, adfStage = 'final') => {
  * If a node is not recognized or is missing required attributes, we should return 'unknown'
  *
  */
-
-
 export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'final') => {
   const {
     attrs,
@@ -178,16 +156,14 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
     text,
     type
   };
-
   if (content) {
     node.content = content = getValidContent(content, schema, adfStage);
-  } // If node type doesn't exist in schema, make it an unknown node
-
+  }
 
+  // If node type doesn't exist in schema, make it an unknown node
   if (!schema.nodes[type]) {
     return getValidUnknownNode(node);
   }
-
   if (type) {
     switch (type) {
       case 'doc':
@@ -195,17 +171,14 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
           const {
             version
           } = originalNode;
-
           if (version && content && content.length) {
             return {
               type,
               content
             };
           }
-
           break;
         }
-
       case 'codeBlock':
         {
           if (content) {
@@ -216,11 +189,9 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
                   text: val.text
                 });
               }
-
               return acc;
             }, []);
           }
-
           if (attrs && attrs.language) {
             return {
               type,
@@ -229,14 +200,12 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               marks
             };
           }
-
           return {
             type,
             content,
             marks
           };
         }
-
       case 'date':
         {
           if (attrs && attrs.timestamp) {
@@ -245,10 +214,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               attrs
             };
           }
-
           break;
         }
-
       case 'status':
         {
           if (attrs && attrs.text && attrs.color) {
@@ -257,10 +224,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               attrs
             };
           }
-
           break;
         }
-
       case 'emoji':
         {
           if (attrs && attrs.shortName) {
@@ -269,10 +234,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               attrs
             };
           }
-
           break;
         }
-
       case 'inlineExtension':
       case 'extension':
         {
@@ -282,10 +245,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               attrs
             };
           }
-
           break;
         }
-
       case 'inlineCard':
       case 'blockCard':
         {
@@ -295,10 +256,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               attrs
             };
           }
-
           break;
         }
-
       case 'embedCard':
         {
           if (attrs && (attrs.url && isSafeUrl(attrs.url) || attrs.data && attrs.data.url && isSafeUrl(attrs.data.url)) && attrs.layout) {
@@ -307,10 +266,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               attrs
             };
           }
-
           break;
         }
-
       case 'bodiedExtension':
         {
           if (attrs && attrs.extensionType && attrs.extensionKey && content) {
@@ -320,17 +277,14 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               content
             };
           }
-
           break;
         }
-
       case 'hardBreak':
         {
           return {
             type
           };
         }
-
       case 'caption':
         {
           if (content) {
@@ -339,15 +293,12 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               content
             };
           }
-
           break;
         }
-
       case 'mediaInline':
         {
           let mediaId = '';
           let mediaCollection = [];
-
           if (attrs) {
             const {
               id,
@@ -356,7 +307,6 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
             mediaId = id;
             mediaCollection = collection;
           }
-
           if (mediaId && mediaCollection) {
             return {
               type,
@@ -364,17 +314,14 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               marks
             };
           }
-
           break;
         }
-
       case 'media':
         {
           let mediaId = '';
           let mediaType = '';
           let mediaCollection = [];
           let mediaUrl = '';
-
           if (attrs) {
             const {
               id,
@@ -387,7 +334,6 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
             mediaCollection = collection;
             mediaUrl = url;
           }
-
           if (mediaType === 'external' && !!mediaUrl) {
             const mediaAttrs = {
               type: mediaType,
@@ -395,11 +341,9 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               width: attrs.width,
               height: attrs.height
             };
-
             if (attrs.alt) {
               mediaAttrs.alt = attrs.alt;
             }
-
             return {
               type,
               attrs: mediaAttrs
@@ -410,19 +354,15 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               id: mediaId,
               collection: mediaCollection
             };
-
             if (attrs.width) {
               mediaAttrs.width = attrs.width;
             }
-
             if (attrs.height) {
               mediaAttrs.height = attrs.height;
             }
-
             if (attrs.alt) {
               mediaAttrs.alt = attrs.alt;
             }
-
             const getMarks = getValidMarks(marks, adfStage);
             return getMarks ? {
               type,
@@ -433,10 +373,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               attrs: mediaAttrs
             };
           }
-
           break;
         }
-
       case 'mediaGroup':
         {
           if (Array.isArray(content) && !content.some(e => e.type !== 'media')) {
@@ -445,15 +383,12 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               content
             };
           }
-
           break;
         }
-
       case 'mediaSingle':
         {
           const containsJustMedia = Array.isArray(content) && content.length === 1 && content[0].type === 'media';
           const containsMediaAndCaption = Array.isArray(content) && content.length === 2 && content[0].type === 'media' && content[1].type === 'caption';
-
           if (containsJustMedia || containsMediaAndCaption) {
             return {
               type,
@@ -462,16 +397,13 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               marks: getValidMarks(marks, adfStage)
             };
           }
-
           break;
         }
-
       case 'mention':
         {
           let mentionText = '';
           let mentionId;
           let mentionAccess;
-
           if (attrs) {
             const {
               text,
@@ -483,11 +415,9 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
             mentionId = id;
             mentionAccess = accessLevel;
           }
-
           if (!mentionText) {
             mentionText = text || '@unknown';
           }
-
           if (mentionText && mentionId) {
             const mentionNode = {
               type,
@@ -497,17 +427,13 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
                 accessLevel: ''
               }
             };
-
             if (mentionAccess) {
               mentionNode.attrs.accessLevel = mentionAccess;
             }
-
             return mentionNode;
           }
-
           break;
         }
-
       case 'paragraph':
         {
           return marks ? {
@@ -519,20 +445,17 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
             content: content || []
           };
         }
-
       case 'rule':
         {
           return {
             type
           };
         }
-
       case 'text':
         {
           let {
             marks
           } = node;
-
           if (text) {
             return marks ? {
               type,
@@ -543,19 +466,15 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               text
             };
           }
-
           break;
         }
-
       case 'heading':
         {
           if (attrs) {
             const {
               level
             } = attrs;
-
             const between = (x, a, b) => x >= a && x <= b;
-
             if (level && between(level, 1, 6)) {
               return marks ? {
                 type,
@@ -573,10 +492,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               };
             }
           }
-
           break;
         }
-
       case 'bulletList':
         {
           if (content) {
@@ -585,10 +502,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               content
             };
           }
-
           break;
         }
-
       case 'orderedList':
         {
           if (content) {
@@ -600,10 +515,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               }
             };
           }
-
           break;
         }
-
       case 'listItem':
         {
           if (content) {
@@ -612,10 +525,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               content: wrapInlineNodes(content)
             };
           }
-
           break;
         }
-
       case 'blockquote':
         {
           if (content) {
@@ -624,17 +535,14 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               content
             };
           }
-
           break;
         }
-
       case 'panel':
         {
           if (attrs && content) {
             const {
               panelType
             } = attrs;
-
             if (Object.values(PanelType).includes(panelType)) {
               return {
                 type,
@@ -643,10 +551,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               };
             }
           }
-
           break;
         }
-
       case 'layoutSection':
         {
           if (content) {
@@ -656,10 +562,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               content
             };
           }
-
           break;
         }
-
       case 'layoutColumn':
         {
           if (attrs && content) {
@@ -671,10 +575,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               };
             }
           }
-
           break;
         }
-
       case 'decisionList':
         {
           return {
@@ -685,7 +587,6 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
             }
           };
         }
-
       case 'decisionItem':
         {
           return {
@@ -697,7 +598,6 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
             }
           };
         }
-
       case 'taskList':
         {
           return {
@@ -708,7 +608,6 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
             }
           };
         }
-
       case 'taskItem':
         {
           return {
@@ -720,7 +619,6 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
             }
           };
         }
-
       case 'table':
         {
           if (Array.isArray(content) && content.length > 0 && !content.some(e => e.type !== 'tableRow')) {
@@ -728,22 +626,20 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               return {
                 type,
                 content,
-                attrs: { ...attrs,
+                attrs: {
+                  ...attrs,
                   localId: (attrs === null || attrs === void 0 ? void 0 : attrs.localId) || uuid()
                 }
               };
             }
-
             return {
               type,
               content,
               attrs
             };
           }
-
           break;
         }
-
       case 'tableRow':
         {
           if (Array.isArray(content) && content.length > 0 && !content.some(e => e.type !== 'tableCell' && e.type !== 'tableHeader')) {
@@ -752,44 +648,35 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               content
             };
           }
-
           break;
         }
-
       case 'tableCell':
       case 'tableHeader':
         {
           if (content) {
             const cellAttrs = {};
-
             if (attrs) {
               if (attrs.colspan && attrs.colspan > 1) {
                 cellAttrs.colspan = attrs.colspan;
               }
-
               if (attrs.rowspan && attrs.rowspan > 1) {
                 cellAttrs.rowspan = attrs.rowspan;
               }
-
               if (attrs.background) {
                 cellAttrs.background = attrs.background;
               }
-
               if (attrs.colwidth && Array.isArray(attrs.colwidth)) {
                 cellAttrs.colwidth = attrs.colwidth;
               }
             }
-
             return {
               type,
               content: wrapInlineNodes(content),
               attrs: attrs ? cellAttrs : undefined
             };
           }
-
           break;
         }
-
       case 'image':
         {
           if (attrs && attrs.src) {
@@ -798,10 +685,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               attrs
             };
           }
-
           break;
         }
-
       case 'placeholder':
         {
           if (attrs && typeof attrs.text !== 'undefined') {
@@ -810,10 +695,8 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
               attrs
             };
           }
-
           break;
         }
-
       case 'expand':
       case 'nestedExpand':
         {
@@ -826,9 +709,9 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
         }
     }
   }
-
   return getValidUnknownNode(node);
 };
+
 /*
  * This method will validate a Mark according to the spec defined here
  * https://product-fabric.atlassian.net/wiki/spaces/E/pages/11174043/Document+structure#Documentstructure-Marks
@@ -838,13 +721,11 @@ export const getValidNode = (originalNode, schema = defaultSchema, adfStage = 'f
  * If a node is not recognized or is missing required attributes, we should return null
  *
  */
-
 export const getValidMark = (mark, adfStage = 'final') => {
   const {
     attrs,
     type
   } = mark;
-
   if (type) {
     switch (type) {
       case 'code':
@@ -853,14 +734,12 @@ export const getValidMark = (mark, adfStage = 'final') => {
             type
           };
         }
-
       case 'em':
         {
           return {
             type
           };
         }
-
       case 'link':
         {
           if (attrs) {
@@ -870,19 +749,15 @@ export const getValidMark = (mark, adfStage = 'final') => {
               __confluenceMetadata
             } = attrs;
             let linkHref = href || url;
-
             if (linkHref && linkHref.indexOf(':') === -1 && !RELATIVE_LINK.test(linkHref) && !ANCHOR_LINK.test(linkHref)) {
               linkHref = `http://${linkHref}`;
             }
-
             const linkAttrs = {
               href: linkHref
             };
-
             if (__confluenceMetadata) {
               linkAttrs.__confluenceMetadata = __confluenceMetadata;
             }
-
             if (linkHref && isSafeUrl(linkHref)) {
               return {
                 type,
@@ -890,29 +765,24 @@ export const getValidMark = (mark, adfStage = 'final') => {
               };
             }
           }
-
           break;
         }
-
       case 'strike':
         {
           return {
             type
           };
         }
-
       case 'strong':
         {
           return {
             type
           };
         }
-
       case 'subsup':
         {
           if (attrs && attrs['type']) {
             const subSupType = attrs['type'];
-
             if (isSubSupType(subSupType)) {
               return {
                 type,
@@ -922,10 +792,8 @@ export const getValidMark = (mark, adfStage = 'final') => {
               };
             }
           }
-
           break;
         }
-
       case 'textColor':
         {
           if (attrs && TEXT_COLOR_PATTERN.test(attrs.color)) {
@@ -934,17 +802,14 @@ export const getValidMark = (mark, adfStage = 'final') => {
               attrs
             };
           }
-
           break;
         }
-
       case 'underline':
         {
           return {
             type
           };
         }
-
       case 'annotation':
         {
           return {
@@ -954,7 +819,6 @@ export const getValidMark = (mark, adfStage = 'final') => {
         }
     }
   }
-
   if (adfStage === 'stage0') {
     switch (type) {
       case 'confluenceInlineComment':
@@ -964,7 +828,6 @@ export const getValidMark = (mark, adfStage = 'final') => {
             attrs
           };
         }
-
       case 'dataConsumer':
         {
           return {
@@ -972,7 +835,6 @@ export const getValidMark = (mark, adfStage = 'final') => {
             attrs
           };
         }
-
       case 'fragment':
         {
           return {
@@ -982,6 +844,5 @@ export const getValidMark = (mark, adfStage = 'final') => {
         }
     }
   }
-
   return null;
 };