@atlaskit/adf-schema 37.2.0 → 38.0.0

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;
 };

package/dist/es2019/schema/nodes/multi-bodied-extension.js

@@ -1,4 +1,6 @@
 import { getExtensionAttrs } from '../../utils/extensions';
+import { multiBodiedExtensionStage0 as multiBodiedExtensionStage0Factory } from '../../next-schema/generated/nodeTypes';
+import { extensionFrameStage0 as extensionFrameStage0Factory } from '../../next-schema/generated/nodeTypes';
 
 /**
  * @stage 0
@@ -9,14 +11,7 @@ import { getExtensionAttrs } from '../../utils/extensions';
 /**
  * @returns NodeSpec for ExtensionFrameDefinition
  */
-export const extensionFrame = {
-  content: '(paragraph | panel | blockquote | orderedList | bulletList | rule | heading | codeBlock | mediaGroup | mediaSingle | decisionList | taskList | table | extension | bodiedExtension | unsupportedBlock | blockCard | embedCard)+',
-  isolating: true,
-  marks: 'dataConsumer fragment',
-  definingAsContext: false,
-  definingForContent: true,
-  selectable: false,
-  attrs: {},
+export const extensionFrame = extensionFrameStage0Factory({
   parseDOM: [{
     context: 'extensionFrame//',
     tag: 'div[data-extension-frame]',
@@ -30,7 +25,7 @@ export const extensionFrame = {
     };
     return ['div', attrs, 0];
   }
-};
+});
 
 /**
  * @stage 0
@@ -38,57 +33,25 @@ export const extensionFrame = {
  * @description Wraps multiple extensionFrame objects.
  */
 
-/**
- * @returns NodeSpec for MultiBodiedExtensionDefinition
- */
-const createMultiBodiedExtensionNodeSpec = () => {
-  const nodeSpec = {
-    inline: false,
-    group: 'blockRootOnly',
-    content: 'extensionFrame+',
-    definingAsContext: true,
-    selectable: true,
-    attrs: {
-      extensionKey: {
-        default: ''
-      },
-      extensionType: {
-        default: ''
-      },
-      parameters: {
-        default: null
-      },
-      text: {
-        default: null
-      },
-      layout: {
-        default: 'default'
-      },
-      localId: {
-        default: null
-      }
-    },
-    parseDOM: [{
-      context: 'multiBodiedExtension//',
-      tag: '[data-node-type="multi-bodied-extension"]',
-      skip: true
-    }, {
-      tag: '[data-node-type="multi-bodied-extension"]',
-      getAttrs: domNode => getExtensionAttrs(domNode)
-    }],
-    toDOM(node) {
-      const attrs = {
-        'data-node-type': 'multi-bodied-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, 0];
-    }
-  };
-  return nodeSpec;
-};
-export const multiBodiedExtension = createMultiBodiedExtensionNodeSpec();
+export const multiBodiedExtension = multiBodiedExtensionStage0Factory({
+  parseDOM: [{
+    context: 'multiBodiedExtension//',
+    tag: '[data-node-type="multi-bodied-extension"]',
+    skip: true
+  }, {
+    tag: '[data-node-type="multi-bodied-extension"]',
+    getAttrs: domNode => getExtensionAttrs(domNode)
+  }],
+  toDOM(node) {
+    const attrs = {
+      'data-node-type': 'multi-bodied-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, 0];
+  }
+});

package/dist/es2019/schema/nodes/nested-expand.js

@@ -1,3 +1,5 @@
+import { nestedExpand as nestedExpandFactory } from '../../next-schema/generated/nodeTypes';
+
 /**
  * @name nestedExpand_content
  * @minItems 1
@@ -12,55 +14,37 @@
  * @name nestedExpand_with_no_marks_node
  */
 
-const createNestedExpandSpec = () => {
-  const nestedExpandSpec = {
-    inline: false,
-    marks: 'unsupportedMark unsupportedNodeAttribute',
-    isolating: true,
-    selectable: true,
-    attrs: {
-      title: {
-        default: ''
-      },
-      __expanded: {
-        default: true
-      }
-    },
-    parseDOM: [{
-      context: 'nestedExpand//',
-      tag: '[data-node-type="nestedExpand"]',
-      skip: true
-    }, {
-      tag: '[data-node-type="nestedExpand"] button',
-      ignore: true
-    }, {
-      tag: '[data-node-type="expand"] button',
-      ignore: true
-    }, {
-      tag: 'div[data-node-type="nestedExpand"]',
-      getAttrs: domNode => {
-        const dom = domNode;
-        return {
-          title: dom.getAttribute('data-title'),
-          __expanded: true
-        };
-      }
-    }],
-    toDOM(node) {
-      const attrs = {
-        'data-node-type': 'nestedExpand',
-        'data-title': node.attrs.title,
-        'data-expanded': node.attrs.__expanded
-      };
-      return ['div', attrs, 0];
-    }
-  };
-  nestedExpandSpec.content = '(paragraph | heading | mediaSingle | mediaGroup | codeBlock | bulletList | orderedList | taskList | decisionList | rule | panel | blockquote | unsupportedBlock)+';
-  return nestedExpandSpec;
-};
-
 /**
  * @name nestedExpand
  * @description an expand that can be nested (eg. inside table, layout).
  */
-export const nestedExpand = createNestedExpandSpec();
+export const nestedExpand = nestedExpandFactory({
+  parseDOM: [{
+    context: 'nestedExpand//',
+    tag: '[data-node-type="nestedExpand"]',
+    skip: true
+  }, {
+    tag: '[data-node-type="nestedExpand"] button',
+    ignore: true
+  }, {
+    tag: '[data-node-type="expand"] button',
+    ignore: true
+  }, {
+    tag: 'div[data-node-type="nestedExpand"]',
+    getAttrs: domNode => {
+      const dom = domNode;
+      return {
+        title: dom.getAttribute('data-title'),
+        __expanded: true
+      };
+    }
+  }],
+  toDOM(node) {
+    const attrs = {
+      'data-node-type': 'nestedExpand',
+      'data-title': node.attrs.title,
+      'data-expanded': node.attrs.__expanded
+    };
+    return ['div', attrs, 0];
+  }
+});

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

@@ -1,14 +1,6 @@
+import { orderedList as orderedListFactory } from '../../next-schema/generated/nodeTypes';
 export const orderedListSelector = '.ak-ol';
-export const orderedList = {
-  group: 'block',
-  attrs: {
-    order: {
-      default: 1
-    }
-  },
-  content: 'listItem+',
-  marks: 'unsupportedMark unsupportedNodeAttribute',
-  selectable: false,
+export const orderedList = orderedListFactory({
   parseDOM: [{
     tag: 'ol'
   }],
@@ -18,7 +10,7 @@ export const orderedList = {
     };
     return ['ol', attrs, 0];
   }
-};
+});
 
 // resolve "start" to a safe, 0+ integer, otherwise return undefined
 // Note: Any changes to this function should also be made to "resolveOrder"
@@ -33,8 +25,7 @@ const resolveStart = start => {
   }
   return Math.floor(Math.max(num, 0));
 };
-export const orderedListWithOrder = {
-  ...orderedList,
+export const orderedListWithOrder = orderedListFactory({
   parseDOM: [{
     tag: 'ol',
     getAttrs: domNode => {
@@ -60,4 +51,4 @@ export const orderedListWithOrder = {
     };
     return ['ol', attrs, 0];
   }
-};
+});

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

@@ -1,3 +1,4 @@
+import { panel as panelFactory, panelLegacy as panelLegacyFactory } from '../../next-schema/generated/nodeTypes';
 export let PanelType = /*#__PURE__*/function (PanelType) {
   PanelType["INFO"] = "info";
   PanelType["NOTE"] = "note";
@@ -13,26 +14,6 @@ export let PanelType = /*#__PURE__*/function (PanelType) {
  * @name panel_node
  */
 
-const getDefaultAttrs = () => {
-  const attrs = {
-    panelType: {
-      default: 'info'
-    },
-    panelIcon: {
-      default: null
-    },
-    panelIconId: {
-      default: null
-    },
-    panelIconText: {
-      default: null
-    },
-    panelColor: {
-      default: null
-    }
-  };
-  return attrs;
-};
 const getDomAttrs = nodeAttrs => {
   const attrs = {
     'data-panel-type': nodeAttrs.panelType,
@@ -61,12 +42,7 @@ const getParseDOMAttrs = (allowCustomPanel, dom) => {
   return parseDOMAttrs;
 };
 export const panel = allowCustomPanel => {
-  const panelNodeSpec = {
-    group: 'block',
-    content: '(paragraph | heading | bulletList | orderedList | blockCard | unsupportedBlock)+',
-    marks: 'unsupportedMark unsupportedNodeAttribute',
-    attrs: getDefaultAttrs(),
-    selectable: true,
+  const panelNodeSpec = panelLegacyFactory({
     parseDOM: [{
       tag: 'div[data-panel-type]',
       getAttrs: dom => getParseDOMAttrs(allowCustomPanel, dom)
@@ -78,7 +54,7 @@ export const panel = allowCustomPanel => {
       };
       return ['div', attrs, ['div', contentAttrs, 0]];
     }
-  };
+  });
   return panelNodeSpec;
 };
 
@@ -89,12 +65,7 @@ export const panel = allowCustomPanel => {
  * addition to content allowed inside panel
  */
 export const extendedPanel = allowCustomPanel => {
-  const panelNodeSpec = {
-    group: 'block',
-    content: '(paragraph | heading | bulletList | orderedList | blockCard | mediaGroup | mediaSingle | codeBlock | taskList | rule | decisionList | unsupportedBlock)+',
-    marks: 'unsupportedMark unsupportedNodeAttribute',
-    attrs: getDefaultAttrs(),
-    selectable: true,
+  const panelNodeSpec = panelFactory({
     parseDOM: [{
       tag: 'div[data-panel-type]',
       getAttrs: dom => getParseDOMAttrs(allowCustomPanel, dom)
@@ -106,6 +77,6 @@ export const extendedPanel = allowCustomPanel => {
       };
       return ['div', attrs, ['div', contentAttrs, 0]];
     }
-  };
+  });
   return panelNodeSpec;
 };

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

@@ -1,3 +1,5 @@
+import { paragraph as paragraphFactory } from '../../next-schema/generated/nodeTypes';
+
 /**
  * @name paragraph_node
  */
@@ -23,16 +25,7 @@
  * @name paragraph_with_indentation_node
  */
 
-export const paragraph = {
-  selectable: false,
-  content: 'inline*',
-  group: 'block',
-  attrs: {
-    localId: {
-      default: null
-    }
-  },
-  marks: 'strong code em link border strike subsup textColor backgroundColor typeAheadQuery underline confluenceInlineComment annotation unsupportedMark unsupportedNodeAttribute dataConsumer fragment',
+export const paragraph = paragraphFactory({
   parseDOM: [{
     tag: 'p',
     getAttrs: domNode => {
@@ -54,4 +47,4 @@ export const paragraph = {
     }] : [];
     return [name, ...attrs, 0];
   }
-};
+});

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

@@ -1,17 +1,10 @@
+import { placeholder as placeholderFactory } from '../../next-schema/generated/nodeTypes';
+
 /**
  * @name placeholder_node
  */
 
-export const placeholder = {
-  inline: true,
-  group: 'inline',
-  selectable: false,
-  marks: '',
-  attrs: {
-    text: {
-      default: ''
-    }
-  },
+export const placeholder = placeholderFactory({
   parseDOM: [{
     tag: 'span[data-placeholder]',
     getAttrs: dom => ({
@@ -29,4 +22,4 @@ export const placeholder = {
     };
     return ['span', attrs, text];
   }
-};
+});

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

@@ -1,14 +1,15 @@
+import { rule as ruleFactory } from '../../next-schema/generated/nodeTypes';
+
 /**
  * @name rule_node
  */
 
 const hrDOM = ['hr'];
-export const rule = {
-  group: 'block',
+export const rule = ruleFactory({
   parseDOM: [{
     tag: 'hr'
   }],
   toDOM() {
     return hrDOM;
   }
-};
+});

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

@@ -1,27 +1,11 @@
 import { uuid } from '../../utils/uuid';
+import { status as statusFactory } from '../../next-schema/generated/nodeTypes';
 
 /**
  * @name status_node
  */
 
-export const status = {
-  inline: true,
-  group: 'inline',
-  selectable: true,
-  attrs: {
-    text: {
-      default: ''
-    },
-    color: {
-      default: ''
-    },
-    localId: {
-      default: uuid.generate()
-    },
-    style: {
-      default: ''
-    }
-  },
+export const status = statusFactory({
   parseDOM: [{
     tag: 'span[data-node-type="status"]',
     getAttrs: domNode => {
@@ -50,4 +34,4 @@ export const status = {
     };
     return ['span', attrs, text];
   }
-};
+});