@atlaskit/adf-schema 37.2.1 → 38.0.0

package/dist/es2019/schema/nodes/extension.js

@@ -1,4 +1,5 @@
 import { getExtensionAttrs } from '../../utils/extensions';
+import { extension as extensionFactory } from '../../next-schema/generated/nodeTypes';
 
 /**
  * @name extension_node
@@ -8,49 +9,21 @@ import { getExtensionAttrs } from '../../utils/extensions';
  * @name extension_with_marks_node
  */
 
-const createExtensionNodeSpec = () => {
-  const nodeSpec = {
-    inline: false,
-    group: 'block',
-    atom: true,
-    selectable: true,
-    attrs: {
-      extensionType: {
-        default: ''
-      },
-      extensionKey: {
-        default: ''
-      },
-      parameters: {
-        default: null
-      },
-      text: {
-        default: null
-      },
-      layout: {
-        default: 'default'
-      },
-      localId: {
-        default: null
-      }
-    },
-    parseDOM: [{
-      tag: '[data-node-type="extension"]',
-      getAttrs: domNode => getExtensionAttrs(domNode)
-    }],
-    toDOM(node) {
-      const attrs = {
-        'data-node-type': 'extension',
-        'data-extension-type': node.attrs.extensionType,
-        'data-extension-key': node.attrs.extensionKey,
-        'data-text': node.attrs.text,
-        'data-parameters': JSON.stringify(node.attrs.parameters),
-        'data-layout': node.attrs.layout,
-        'data-local-id:': node.attrs.localId
-      };
-      return ['div', attrs];
-    }
-  };
-  return nodeSpec;
-};
-export const extension = createExtensionNodeSpec();
+export const extension = extensionFactory({
+  parseDOM: [{
+    tag: '[data-node-type="extension"]',
+    getAttrs: domNode => getExtensionAttrs(domNode)
+  }],
+  toDOM(node) {
+    const attrs = {
+      'data-node-type': 'extension',
+      'data-extension-type': node.attrs.extensionType,
+      'data-extension-key': node.attrs.extensionKey,
+      'data-text': node.attrs.text,
+      'data-parameters': JSON.stringify(node.attrs.parameters),
+      'data-layout': node.attrs.layout,
+      'data-local-id:': node.attrs.localId
+    };
+    return ['div', attrs];
+  }
+});

package/dist/es2019/schema/nodes/hard-break.js

@@ -1,15 +1,14 @@
+import { hardBreak as hardBreakFactory } from '../../next-schema/generated/nodeTypes';
+
 /**
  * @name hardBreak_node
  */
 
-export const hardBreak = {
-  inline: true,
-  group: 'inline',
-  selectable: false,
+export const hardBreak = hardBreakFactory({
   parseDOM: [{
     tag: 'br'
   }],
   toDOM() {
     return ['br'];
   }
-};
+});

package/dist/es2019/schema/nodes/heading.js

@@ -1,3 +1,5 @@
+import { heading as headingFactory } from '../../next-schema/generated/nodeTypes';
+
 /**
  * @name heading_node
  */
@@ -22,19 +24,7 @@ const getAttrs = level => domNode => {
     localId: domNode.getAttribute('data-local-id') || ((_heading$attrs = heading.attrs) === null || _heading$attrs === void 0 ? void 0 : (_heading$attrs$localI = _heading$attrs.localId) === null || _heading$attrs$localI === void 0 ? void 0 : _heading$attrs$localI.default)
   };
 };
-export const heading = {
-  attrs: {
-    level: {
-      default: 1
-    },
-    localId: {
-      default: null
-    }
-  },
-  content: `inline*`,
-  group: 'block',
-  defining: true,
-  selectable: false,
+export const heading = headingFactory({
   parseDOM: [{
     tag: 'h1',
     getAttrs: getAttrs(1)
@@ -65,4 +55,4 @@ export const heading = {
     }] : [];
     return [name, ...attrs, 0];
   }
-};
+});

package/dist/es2019/schema/nodes/image.js

@@ -1,18 +1,5 @@
-export const image = {
-  group: 'inline',
-  inline: true,
-  attrs: {
-    src: {
-      default: ''
-    },
-    alt: {
-      default: ''
-    },
-    title: {
-      default: null
-    }
-  },
-  draggable: true,
+import { image as imageFactory } from '../../next-schema/generated/nodeTypes';
+export const image = imageFactory({
   parseDOM: [{
     tag: 'img[src^="data:image/"]',
     ignore: true
@@ -30,4 +17,4 @@ export const image = {
   toDOM(node) {
     return ['img', node.attrs];
   }
-};
+});

package/dist/es2019/schema/nodes/inline-card.js

@@ -1,20 +1,10 @@
+import { inlineCard as inlineCardFactory } from '../../next-schema/generated/nodeTypes';
+
 /**
  * @name inlineCard_node
  */
 
-export const inlineCard = {
-  inline: true,
-  group: 'inline',
-  selectable: true,
-  draggable: true,
-  attrs: {
-    url: {
-      default: null
-    },
-    data: {
-      default: null
-    }
-  },
+export const inlineCard = inlineCardFactory({
   parseDOM: [{
     tag: 'a[data-inline-card], span[data-inline-card]',
     // bump priority higher than hyperlink
@@ -54,4 +44,4 @@ export const inlineCard = {
       return ['a', attrs];
     }
   }
-};
+});

package/dist/es2019/schema/nodes/inline-extension.js

@@ -1,4 +1,5 @@
 import { getExtensionAttrs } from '../../utils/extensions';
+import { inlineExtensionWithMarks as inlineExtensionWithMarksFactory } from '../../next-schema/generated/nodeTypes';
 
 /**
  * @name inlineExtension_node
@@ -8,44 +9,20 @@ import { getExtensionAttrs } from '../../utils/extensions';
  * @name inlineExtension_with_marks_node
  */
 
-const createInlineExtensionNodeSpec = () => {
-  const nodeSpec = {
-    inline: true,
-    group: 'inline',
-    selectable: true,
-    attrs: {
-      extensionType: {
-        default: ''
-      },
-      extensionKey: {
-        default: ''
-      },
-      parameters: {
-        default: null
-      },
-      text: {
-        default: null
-      },
-      localId: {
-        default: null
-      }
-    },
-    parseDOM: [{
-      tag: 'span[data-extension-type]',
-      getAttrs: domNode => getExtensionAttrs(domNode, true)
-    }],
-    toDOM(node) {
-      const attrs = {
-        'data-extension-type': node.attrs.extensionType,
-        'data-extension-key': node.attrs.extensionKey,
-        'data-text': node.attrs.text,
-        'data-parameters': JSON.stringify(node.attrs.parameters),
-        'data-local-id:': node.attrs.localId,
-        contenteditable: 'false'
-      };
-      return ['span', attrs];
-    }
-  };
-  return nodeSpec;
-};
-export const inlineExtension = createInlineExtensionNodeSpec();
+export const inlineExtension = inlineExtensionWithMarksFactory({
+  parseDOM: [{
+    tag: 'span[data-extension-type]',
+    getAttrs: domNode => getExtensionAttrs(domNode, true)
+  }],
+  toDOM(node) {
+    const attrs = {
+      'data-extension-type': node.attrs.extensionType,
+      'data-extension-key': node.attrs.extensionKey,
+      'data-text': node.attrs.text,
+      'data-parameters': JSON.stringify(node.attrs.parameters),
+      'data-local-id:': node.attrs.localId,
+      contenteditable: 'false'
+    };
+    return ['span', attrs];
+  }
+});

package/dist/es2019/schema/nodes/layout-column.js

@@ -1,17 +1,10 @@
+import { layoutColumn as layoutColumnFactory } from '../../next-schema/generated/nodeTypes';
+
 /**
  * @name layoutColumn_node
  */
 
-export const layoutColumn = {
-  content: '(block|unsupportedBlock)+',
-  isolating: true,
-  marks: 'alignment indentation dataConsumer fragment unsupportedMark unsupportedNodeAttribute',
-  selectable: false,
-  attrs: {
-    width: {
-      default: undefined
-    }
-  },
+export const layoutColumn = layoutColumnFactory({
   parseDOM: [{
     context: 'layoutColumn//',
     tag: 'div[data-layout-column]',
@@ -34,7 +27,7 @@ export const layoutColumn = {
     } = node.attrs;
     if (width) {
       attrs['style'] = `flex-basis: ${width}%`;
-      attrs['data-column-width'] = width;
+      attrs['data-column-width'] = `${width}`;
     }
 
     // We need to apply a attribute to the inner most child to help
@@ -44,4 +37,4 @@ export const layoutColumn = {
     };
     return ['div', attrs, ['div', contentAttrs, 0]];
   }
-};
+});

package/dist/es2019/schema/nodes/layout-section.js

@@ -1,3 +1,6 @@
+import { layoutSection as layoutSectionFactory } from '../../next-schema/generated/nodeTypes';
+import { layoutSectionFull as layoutSectionFullFactory } from '../../next-schema/generated/nodeTypes';
+
 /**
  * @name layoutSection_node
  */
@@ -15,10 +18,7 @@
  * @name layoutSection_with_single_column_node
  */
 
-export const layoutSection = {
-  content: '(layoutColumn | unsupportedBlock){1,3} unsupportedBlock* | unsupportedBlock+',
-  marks: 'unsupportedMark unsupportedNodeAttribute',
-  isolating: true,
+export const layoutSection = layoutSectionFactory({
   parseDOM: [{
     context: 'layoutSection//|layoutColumn//',
     tag: 'div[data-layout-section]',
@@ -32,11 +32,25 @@ export const layoutSection = {
     };
     return ['div', attrs, 0];
   }
-};
-export const layoutSectionWithSingleColumn = {
-  content: '(layoutColumn | unsupportedBlock){1,3} unsupportedBlock* | unsupportedBlock+',
-  marks: 'unsupportedMark unsupportedNodeAttribute',
-  isolating: true,
+});
+export const layoutSectionFull = layoutSectionFullFactory({
+  parseDOM: [{
+    context: 'layoutSection//|layoutColumn//',
+    tag: 'div[data-layout-section]',
+    skip: true
+  }, {
+    tag: 'div[data-layout-section]'
+  }],
+  toDOM() {
+    const attrs = {
+      'data-layout-section': 'true'
+    };
+    return ['div', attrs, 0];
+  }
+});
+
+// it's same as layoutSection
+export const layoutSectionWithSingleColumn = layoutSectionFactory({
   parseDOM: [{
     context: 'layoutSection//|layoutColumn//',
     tag: 'div[data-layout-section]',
@@ -50,4 +64,4 @@ export const layoutSectionWithSingleColumn = {
     };
     return ['div', attrs, 0];
   }
-};
+});

package/dist/es2019/schema/nodes/list-item.js

@@ -1,29 +1,23 @@
-export const listItem = {
-  content: '(paragraph | mediaSingle | codeBlock | unsupportedBlock) (paragraph | bulletList | orderedList | mediaSingle | codeBlock | unsupportedBlock)*',
-  marks: 'unsupportedMark unsupportedNodeAttribute',
-  defining: true,
-  selectable: false,
+import { listItem as listItemFactory } from '../../next-schema/generated/nodeTypes';
+import { listItemLegacy as listItemLegacyFactory } from '../../next-schema/generated/nodeTypes';
+export const listItem = listItemLegacyFactory({
   parseDOM: [{
     tag: 'li'
   }],
   toDOM() {
     return ['li', 0];
   }
-};
+});
 
 /**
  * @name list_item_with_task
  * @description this node allows task-list to be nested inside list-item
  */
-export const listItemWithTask = {
-  content: '(paragraph | mediaSingle | codeBlock | unsupportedBlock) (paragraph | bulletList | orderedList | taskList | mediaSingle | codeBlock | unsupportedBlock)*',
-  marks: 'unsupportedMark unsupportedNodeAttribute',
-  defining: true,
-  selectable: false,
+export const listItemWithTask = listItemFactory({
   parseDOM: [{
     tag: 'li'
   }],
   toDOM() {
     return ['li', 0];
   }
-};
+});

package/dist/es2019/schema/nodes/media-group.js

@@ -1,3 +1,5 @@
+import { mediaGroup as mediaGroupFactory } from '../../next-schema/generated/nodeTypes';
+
 /**
  * @name mediaGroup_node
  */
@@ -5,13 +7,7 @@
 // Temporary due to an existing issue in validator below:
 // https://product-fabric.atlassian.net/jira/servicedesk/projects/DTR/queues/issue/DTR-1429
 // TODO: Remove border and link marks from white list
-export const mediaGroup = {
-  inline: false,
-  group: 'block',
-  content: '(media|unsupportedBlock)+',
-  attrs: {},
-  marks: 'unsupportedMark unsupportedNodeAttribute annotation border link',
-  selectable: false,
+export const mediaGroup = mediaGroupFactory({
   parseDOM: [{
     tag: 'div[data-node-type="mediaGroup"]'
   }, {
@@ -22,4 +18,4 @@ export const mediaGroup = {
       'data-node-type': 'mediaGroup'
     }, 0];
   }
-};
+});

package/dist/es2019/schema/nodes/media-inline.js

@@ -1,7 +1,8 @@
-import { createMediaSpec, defaultAttrs } from './media';
+import { createMediaSpec } from './media';
+import { mediaInline as mediaInlineFactory } from '../../next-schema/generated/nodeTypes';
 
 /**
  * @name mediaInline_node
  */
 
-export const mediaInline = createMediaSpec(defaultAttrs, true);
+export const mediaInline = createMediaSpec(mediaInlineFactory({}).attrs, true);

package/dist/es2019/schema/nodes/media-single.js

@@ -1,5 +1,6 @@
 import { WidthType } from './types/rich-media-common';
 import { isDOMElement } from '../../utils/parseDOM';
+import { mediaSingle as mediaSingleFactory, mediaSingleCaption as mediaSingleCaptionFactory, mediaSingleFull as mediaSingleFullFactory, mediaSingleWidthType as mediaSingleWidthTypeFactory } from '../../next-schema/generated/nodeTypes';
 
 /**
  * @name mediaSingle_node
@@ -35,8 +36,6 @@ export const mediaSingleSpec = ({
   withCaption = false,
   withExtendedWidthTypes = false
 }) => {
-  const content = withCaption ? 'media|unsupportedBlock+|media (caption|unsupportedBlock) unsupportedBlock*' : 'media|unsupportedBlock+|media unsupportedBlock+';
-  const atom = !withCaption;
   const getAttrs = dom => {
     if (!isDOMElement(dom)) {
       // this should never happen
@@ -90,19 +89,40 @@ export const mediaSingleSpec = ({
     }
     return attrs;
   };
-  return {
-    inline: false,
-    group: 'block',
-    selectable: true,
-    atom,
-    content,
-    attrs: withExtendedWidthTypes ? {
-      ...defaultAttrs,
-      widthType: {
-        default: null
+  if (withExtendedWidthTypes && withCaption) {
+    return mediaSingleFullFactory({
+      parseDOM: [{
+        tag: 'div[data-node-type="mediaSingle"]',
+        getAttrs
+      }],
+      toDOM(node) {
+        return ['div', getAttrsFromNode(node), 0];
       }
-    } : defaultAttrs,
-    marks: 'unsupportedMark unsupportedNodeAttribute annotation border link',
+    });
+  }
+  if (withExtendedWidthTypes && !withCaption) {
+    return mediaSingleWidthTypeFactory({
+      parseDOM: [{
+        tag: 'div[data-node-type="mediaSingle"]',
+        getAttrs
+      }],
+      toDOM(node) {
+        return ['div', getAttrsFromNode(node), 0];
+      }
+    });
+  }
+  if (!withExtendedWidthTypes && withCaption) {
+    return mediaSingleCaptionFactory({
+      parseDOM: [{
+        tag: 'div[data-node-type="mediaSingle"]',
+        getAttrs
+      }],
+      toDOM(node) {
+        return ['div', getAttrsFromNode(node), 0];
+      }
+    });
+  }
+  return mediaSingleFactory({
     parseDOM: [{
       tag: 'div[data-node-type="mediaSingle"]',
       getAttrs
@@ -110,7 +130,7 @@ export const mediaSingleSpec = ({
     toDOM(node) {
       return ['div', getAttrsFromNode(node), 0];
     }
-  };
+  });
 };
 export const mediaSingle = mediaSingleSpec({
   withCaption: false,

package/dist/es2019/schema/nodes/media.js

@@ -1,56 +1,12 @@
 import { N30 } from '../../utils/colors';
+import { media as mediaFactory } from '../../next-schema/generated/nodeTypes';
+import { mediaInline as mediaInlineFactory } from '../../next-schema/generated/nodeTypes';
 
 /**
  * @name media_node
  */
 
-export const defaultAttrs = {
-  id: {
-    default: ''
-  },
-  type: {
-    default: 'file'
-  },
-  collection: {
-    default: ''
-  },
-  occurrenceKey: {
-    default: null
-  },
-  alt: {
-    default: ''
-  },
-  width: {
-    default: null
-  },
-  height: {
-    default: null
-  },
-  url: {
-    default: null
-  },
-  __fileName: {
-    default: null
-  },
-  __fileSize: {
-    default: null
-  },
-  __fileMimeType: {
-    default: null
-  },
-  __displayType: {
-    default: null
-  },
-  __contextId: {
-    default: null
-  },
-  __mediaTraceId: {
-    default: null
-  },
-  __external: {
-    default: false
-  }
-};
+export const defaultAttrs = mediaFactory({}).attrs;
 export const createMediaSpec = (attributes, inline = false) => {
   const domNodeType = inline ? 'span' : 'div';
   const nodeName = inline ? 'mediaInline' : 'media';
@@ -104,39 +60,40 @@ export const createMediaSpec = (attributes, inline = false) => {
       }
     });
   }
-  return {
-    selectable: true,
-    inline,
-    ...(inline && {
-      group: 'inline'
-    }),
-    attrs: attributes,
-    parseDOM,
-    toDOM(node) {
-      const attrs = {
-        'data-id': node.attrs.id,
-        'data-node-type': `${nodeName}`,
-        'data-type': node.attrs.type,
-        'data-collection': node.attrs.collection,
-        'data-occurrence-key': node.attrs.occurrenceKey,
-        'data-width': node.attrs.width,
-        'data-height': node.attrs.height,
-        'data-url': node.attrs.url,
-        'data-alt': node.attrs.alt,
-        // toDOM is used for static rendering as well as editor rendering. This comes into play for
-        // emails, copy/paste, etc, so the title and styling here *is* useful (despite a React-based
-        // node view being used for editing).
-        title: 'Attachment',
-        // Manually kept in sync with the style of media cards. The goal is to render a plain gray
-        // rectangle that provides an affordance for media.
-        style: `display: inline-block; border-radius: 3px; background: ${N30}; box-shadow: 0 1px 1px rgba(9, 30, 66, 0.2), 0 0 1px 0 rgba(9, 30, 66, 0.24);`
-      };
-      copyPrivateAttributes(node.attrs, attrs, key => `data-${camelCaseToKebabCase(key.slice(2))}`);
-      return [`${domNodeType}`, attrs];
-    }
+  const toDOM = node => {
+    const attrs = {
+      'data-id': node.attrs.id,
+      'data-node-type': `${nodeName}`,
+      'data-type': node.attrs.type,
+      'data-collection': node.attrs.collection,
+      'data-occurrence-key': node.attrs.occurrenceKey,
+      'data-width': node.attrs.width,
+      'data-height': node.attrs.height,
+      'data-url': node.attrs.url,
+      'data-alt': node.attrs.alt,
+      // toDOM is used for static rendering as well as editor rendering. This comes into play for
+      // emails, copy/paste, etc, so the title and styling here *is* useful (despite a React-based
+      // node view being used for editing).
+      title: 'Attachment',
+      // Manually kept in sync with the style of media cards. The goal is to render a plain gray
+      // rectangle that provides an affordance for media.
+      style: `display: inline-block; border-radius: 3px; background: ${N30}; box-shadow: 0 1px 1px rgba(9, 30, 66, 0.2), 0 0 1px 0 rgba(9, 30, 66, 0.24);`
+    };
+    copyPrivateAttributes(node.attrs, attrs, key => `data-${camelCaseToKebabCase(key.slice(2))}`);
+    return [`${domNodeType}`, attrs];
   };
+  if (inline) {
+    return mediaInlineFactory({
+      parseDOM,
+      toDOM
+    });
+  }
+  return mediaFactory({
+    parseDOM,
+    toDOM
+  });
 };
-export const media = createMediaSpec(defaultAttrs);
+export const media = createMediaSpec(defaultAttrs, false);
 export const camelCaseToKebabCase = str => str.replace(/([^A-Z]+)([A-Z])/g, (_, x, y) => `${x}-${y.toLowerCase()}`);
 export const copyPrivateAttributes = (from, to, map) => {
   if (media.attrs) {

package/dist/es2019/schema/nodes/mention.js

@@ -1,4 +1,5 @@
 import { uuid } from '../../utils';
+import { mention as mentionFactory } from '../../next-schema/generated/nodeTypes';
 export let USER_TYPES = /*#__PURE__*/function (USER_TYPES) {
   USER_TYPES["DEFAULT"] = "DEFAULT";
   USER_TYPES["SPECIAL"] = "SPECIAL";
@@ -10,27 +11,7 @@ export let USER_TYPES = /*#__PURE__*/function (USER_TYPES) {
  * @name mention_node
  */
 
-export const mention = {
-  inline: true,
-  group: 'inline',
-  selectable: true,
-  attrs: {
-    id: {
-      default: ''
-    },
-    text: {
-      default: ''
-    },
-    accessLevel: {
-      default: ''
-    },
-    userType: {
-      default: null
-    },
-    localId: {
-      default: null
-    }
-  },
+export const mention = mentionFactory({
   parseDOM: [{
     tag: 'span[data-mention-id]',
     getAttrs: domNode => {
@@ -69,7 +50,7 @@ export const mention = {
     }
     return ['span', attrs, text];
   }
-};
+});
 const isOptional = key => {
   return ['userType', 'localId'].indexOf(key) > -1;
 };