@atlaskit/adf-schema 36.4.0 → 36.5.0

package/dist/es2019/next-schema/nodes/mediaInline.js

@@ -0,0 +1,72 @@
+import { $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { annotation } from '../marks/annotation';
+import { border } from '../marks/border';
+import { link } from '../marks/link';
+import { caption } from './caption';
+import { media } from './media';
+export const mediaInline = adfNode('mediaInline').define({
+  selectable: true,
+  atom: false,
+  marks: [link, border, annotation],
+  attrs: {
+    data: {
+      type: 'object',
+      optional: true
+    },
+    type: {
+      type: 'enum',
+      values: ['file', 'link', 'image'],
+      optional: true
+    },
+    id: {
+      type: 'string'
+    },
+    collection: {
+      type: 'string'
+    },
+    occurrenceKey: {
+      type: 'string',
+      optional: true
+    },
+    width: {
+      type: 'number',
+      default: null,
+      optional: true
+    },
+    height: {
+      type: 'number',
+      default: null,
+      optional: true
+    },
+    __fileName: {
+      type: 'string',
+      optional: true
+    },
+    __fileSize: {
+      type: 'number',
+      optional: true
+    },
+    __fileMimeType: {
+      type: 'string',
+      optional: true
+    },
+    __displayType: {
+      type: 'enum',
+      values: ['file', 'thumbnail'],
+      optional: true
+    },
+    __contextId: {
+      type: 'string',
+      optional: true
+    },
+    __mediaTraceId: {
+      type: 'string',
+      optional: true
+    },
+    __external: {
+      type: 'boolean',
+      optional: true
+    }
+  },
+  content: [$or(media), $or(caption)]
+});

package/dist/es2019/next-schema/nodes/mediaSingle.js

@@ -0,0 +1,33 @@
+import { $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { link } from '../marks/link';
+import { caption } from './caption';
+import { media } from './media';
+export const mediaSingle = adfNode('mediaSingle').define({
+  atom: false,
+  selectable: true,
+  marks: [link],
+  attrs: {
+    width: {
+      type: 'number',
+      minimum: 0,
+      // maximum: 100, – can't encode both? 100 is for percentage, and for pixel it's unlimited
+      default: null,
+      optional: true
+    },
+    layout: {
+      type: 'enum',
+      values: ['wrap-right', 'center', 'wrap-left', 'wide', 'full-width', 'align-end', 'align-start'],
+      default: 'center'
+    },
+    widthType: {
+      type: 'enum',
+      values: ['pixel', 'percentage'],
+      default: 'percentage',
+      optional: true
+    }
+  },
+  content: [$or(media)]
+}).variant('caption', {
+  atom: false,
+  content: [$or(media), $or(caption)]
+});

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

@@ -0,0 +1,27 @@
+import { adfNode } from '@atlaskit/adf-schema-generator';
+export const mention = adfNode('mention').define({
+  inline: true,
+  selectable: true,
+  attrs: {
+    id: {
+      type: 'string',
+      default: ''
+    },
+    text: {
+      type: 'string',
+      default: '',
+      optional: true
+    },
+    accessLevel: {
+      type: 'string',
+      default: '',
+      optional: true
+    },
+    userType: {
+      type: 'enum',
+      values: ['DEFAULT', 'SPECIAL', 'APP'],
+      default: null,
+      optional: true
+    }
+  }
+});

package/dist/es2019/next-schema/nodes/multiBodiedExtension.js

@@ -0,0 +1,40 @@
+import { $onePlus, $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { blockRootOnlyGroup } from '../groups/blockRootOnlyGroup';
+import { extensionFrame } from './extensionFrame';
+export const multiBodiedExtension = adfNode('multiBodiedExtension').define({
+  definingAsContext: true,
+  selectable: true,
+  group: blockRootOnlyGroup,
+  attrs: {
+    extensionKey: {
+      type: 'string',
+      default: ''
+    },
+    extensionType: {
+      type: 'string',
+      default: ''
+    },
+    parameters: {
+      type: 'object',
+      optional: true,
+      default: null
+    },
+    text: {
+      type: 'string',
+      optional: true,
+      default: null
+    },
+    layout: {
+      type: 'enum',
+      values: ['default', 'wide', 'full-width'],
+      optional: true,
+      default: 'default'
+    },
+    localId: {
+      type: 'string',
+      optional: true,
+      default: null
+    }
+  },
+  content: [$onePlus($or(extensionFrame))]
+});

package/dist/es2019/next-schema/nodes/nestedExpand.js

@@ -0,0 +1,29 @@
+import { $onePlus, $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { blockquote } from './blockquote';
+import { codeBlock } from './codeBlock';
+import { decisionList } from './decisionList';
+import { heading } from './heading';
+import { bulletList, orderedList } from './list';
+import { mediaGroup } from './mediaGroup';
+import { mediaSingle } from './mediaSingle';
+import { panel } from './panel';
+import { paragraph } from './paragraph';
+import { rule } from './rule';
+import { taskList } from './task';
+export const nestedExpand = adfNode('nestedExpand').define({
+  isolating: true,
+  selectable: true,
+  attrs: {
+    title: {
+      type: 'string',
+      default: '',
+      optional: true
+    },
+    __expanded: {
+      type: 'boolean',
+      default: true,
+      optional: true
+    }
+  },
+  content: [$onePlus($or(paragraph, heading, mediaSingle, mediaGroup, codeBlock, bulletList, orderedList, taskList, decisionList, rule, panel, blockquote))]
+});

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

@@ -0,0 +1,42 @@
+import { $onePlus, $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { blockCard } from './blockCard';
+import { codeBlock } from './codeBlock';
+import { decisionList } from './decisionList';
+import { heading } from './heading';
+import { bulletList, orderedList } from './list';
+import { mediaGroup } from './mediaGroup';
+import { mediaSingle } from './mediaSingle';
+import { paragraph } from './paragraph';
+import { rule } from './rule';
+import { taskList } from './task';
+export const panel = adfNode('panel').define({
+  selectable: true,
+  attrs: {
+    panelType: {
+      type: 'enum',
+      values: ['info', 'note', 'tip', 'warning', 'error', 'success'],
+      default: 'info'
+    },
+    panelIcon: {
+      type: 'string',
+      default: null,
+      optional: true
+    },
+    panelIconId: {
+      type: 'string',
+      default: null,
+      optional: true
+    },
+    panelIconText: {
+      type: 'string',
+      default: null,
+      optional: true
+    },
+    panelColor: {
+      type: 'string',
+      default: null,
+      optional: true
+    }
+  },
+  content: [$onePlus($or(paragraph, heading, bulletList, orderedList, blockCard, codeBlock, mediaGroup, mediaSingle, decisionList, taskList, rule))]
+});

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

@@ -0,0 +1,15 @@
+import { $or, $zeroPlus, adfNode } from '@atlaskit/adf-schema-generator';
+import { inlineGroup } from '../groups/inlineGroup';
+import { alignment } from '../marks/alignment';
+import { indentation } from '../marks/indentation';
+export const paragraph = adfNode('paragraph').define({
+  selectable: false,
+  marks: [alignment],
+  content: [$zeroPlus($or(inlineGroup))]
+}).variant('with_alignment', {
+  marks: [alignment]
+}).variant('with_indentation', {
+  marks: [indentation]
+}).variant('with_marks', {
+  marks: [alignment, indentation]
+});

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

@@ -0,0 +1,10 @@
+import { adfNode } from '@atlaskit/adf-schema-generator';
+export const placeholder = adfNode('placeholder').define({
+  selectable: false,
+  attrs: {
+    text: {
+      type: 'string',
+      default: ''
+    }
+  }
+});

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

@@ -0,0 +1,2 @@
+import { adfNode } from '@atlaskit/adf-schema-generator';
+export const rule = adfNode('rule').define({});

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

@@ -0,0 +1,25 @@
+import { adfNode } from '@atlaskit/adf-schema-generator';
+export const status = adfNode('status').define({
+  selectable: true,
+  attrs: {
+    text: {
+      type: 'string',
+      default: ''
+    },
+    color: {
+      type: 'enum',
+      values: ['neutral', 'purple', 'blue', 'red', 'yellow', 'green'],
+      default: ''
+    },
+    localId: {
+      type: 'string',
+      optional: true,
+      default: ''
+    },
+    style: {
+      type: 'string',
+      optional: true,
+      default: ''
+    }
+  }
+});

package/dist/es2019/next-schema/nodes/table.js

@@ -0,0 +1,37 @@
+import { $onePlus, $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { fragment } from '../marks/fragment';
+import { tableRow } from './tableRow';
+export const table = adfNode('table').define({
+  isolating: true,
+  selectable: true,
+  marks: [fragment],
+  attrs: {
+    isNumberColumnEnabled: {
+      type: 'boolean',
+      default: false,
+      optional: true
+    },
+    layout: {
+      type: 'enum',
+      values: ['default', 'wide', 'full-width'],
+      default: 'default',
+      optional: true
+    },
+    localId: {
+      type: 'string',
+      default: '',
+      optional: true
+    },
+    width: {
+      type: 'number',
+      default: null,
+      optional: true
+    },
+    __autoSize: {
+      type: 'boolean',
+      default: false,
+      optional: true
+    }
+  },
+  content: [$onePlus($or(tableRow))]
+});

package/dist/es2019/next-schema/nodes/tableCell.js

@@ -0,0 +1,44 @@
+import { $onePlus, $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { blockCard } from './blockCard';
+import { blockquote } from './blockquote';
+import { codeBlock } from './codeBlock';
+import { decisionList } from './decisionList';
+import { embedCard } from './embedCard';
+import { extension } from './extension';
+import { heading } from './heading';
+import { bulletList, orderedList } from './list';
+import { mediaGroup } from './mediaGroup';
+import { mediaSingle } from './mediaSingle';
+import { nestedExpand } from './nestedExpand';
+import { panel } from './panel';
+import { paragraph } from './paragraph';
+import { rule } from './rule';
+import { taskList } from './task';
+export const tableCell = adfNode('tableCell').define({
+  isolating: true,
+  selectable: false,
+  tableRole: 'cell',
+  attrs: {
+    colspan: {
+      type: 'number',
+      default: 1,
+      optional: true
+    },
+    rowspan: {
+      type: 'number',
+      default: 1,
+      optional: true
+    },
+    colswidth: {
+      type: 'numberList',
+      default: [],
+      optional: true
+    },
+    background: {
+      type: 'string',
+      default: '',
+      optional: true
+    }
+  },
+  content: [$onePlus($or(panel, paragraph, paragraph.use('with_marks'), blockquote, orderedList, bulletList, rule, heading, heading.use('with_alignment'), heading.use('with_indentation'), codeBlock, mediaGroup, mediaSingle, decisionList, taskList, extension, blockCard, nestedExpand, embedCard))]
+});

package/dist/es2019/next-schema/nodes/tableHeader.js

@@ -0,0 +1,44 @@
+import { $onePlus, $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { blockCard } from './blockCard';
+import { blockquote } from './blockquote';
+import { codeBlock } from './codeBlock';
+import { decisionList } from './decisionList';
+import { embedCard } from './embedCard';
+import { extension } from './extension';
+import { heading } from './heading';
+import { bulletList, orderedList } from './list';
+import { mediaGroup } from './mediaGroup';
+import { mediaSingle } from './mediaSingle';
+import { nestedExpand } from './nestedExpand';
+import { panel } from './panel';
+import { paragraph } from './paragraph';
+import { rule } from './rule';
+import { taskList } from './task';
+export const tableHeader = adfNode('tableHeader').define({
+  isolating: true,
+  selectable: false,
+  tableRole: 'header_cell',
+  attrs: {
+    colspan: {
+      type: 'number',
+      default: 1,
+      optional: true
+    },
+    rowspan: {
+      type: 'number',
+      default: 1,
+      optional: true
+    },
+    colswidth: {
+      type: 'numberList',
+      default: [],
+      optional: true
+    },
+    background: {
+      type: 'string',
+      default: '',
+      optional: true
+    }
+  },
+  content: [$onePlus($or(panel, paragraph, paragraph.use('with_marks'), blockquote, orderedList, bulletList, rule, heading, heading.use('with_alignment'), heading.use('with_indentation'), codeBlock, mediaGroup, mediaSingle, decisionList, taskList, extension, blockCard, nestedExpand, embedCard))]
+});

package/dist/es2019/next-schema/nodes/tableRow.js

@@ -0,0 +1,7 @@
+import { $onePlus, $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { tableCell } from './tableCell';
+import { tableHeader } from './tableHeader';
+export const tableRow = adfNode('tableRow').define({
+  selectable: false,
+  content: [$onePlus($or(tableCell, tableHeader))]
+});

package/dist/es2019/next-schema/nodes/task.js

@@ -0,0 +1,31 @@
+import { $onePlus, $or, $zeroPlus, adfNode } from '@atlaskit/adf-schema-generator';
+import { inlineGroup } from '../groups/inlineGroup';
+export const taskItem = adfNode('taskItem');
+export const taskList = adfNode('taskList');
+taskItem.define({
+  defining: true,
+  selectable: false,
+  attrs: {
+    localId: {
+      type: 'string',
+      default: ''
+    },
+    state: {
+      type: 'enum',
+      values: ['TODO', 'DONE'],
+      default: 'TODO'
+    }
+  },
+  content: [$zeroPlus($or(inlineGroup))]
+});
+taskList.define({
+  defining: true,
+  selectable: false,
+  attrs: {
+    localId: {
+      type: 'string',
+      default: ''
+    }
+  },
+  content: [$onePlus($or(taskItem)), $zeroPlus($or(taskItem, taskList))]
+});

package/dist/es2019/next-schema/nodes/text.js

@@ -0,0 +1,15 @@
+import { adfNode } from '@atlaskit/adf-schema-generator';
+import { annotation } from '../marks/annotation';
+import { code } from '../marks/code';
+import { em } from '../marks/em';
+import { link } from '../marks/link';
+import { strike } from '../marks/strike';
+import { strong } from '../marks/strong';
+import { subsup } from '../marks/subsup';
+import { textColor } from '../marks/textColor';
+import { underline } from '../marks/underline';
+export const text = adfNode('text').define({}).variant('formatted', {
+  marks: [link, em, strong, strike, subsup, underline, textColor, annotation]
+}).variant('code_inline', {
+  marks: [code, link, annotation]
+});

package/dist/esm/next-schema/full-schema.adf.js

@@ -0,0 +1,9 @@
+import { $onePlus, $or, adfNode } from '@atlaskit/adf-schema-generator';
+import { blockGroup } from './groups/blockGroup';
+import { layoutSection } from './nodes/layoutSection';
+import { blockRootOnlyGroup } from './groups/blockRootOnlyGroup';
+var doc = adfNode('doc').define({
+  root: true,
+  content: [$onePlus($or(blockGroup, layoutSection, blockRootOnlyGroup))]
+});
+export default doc;

package/dist/esm/next-schema/groups/alignementMarkExclusionGroup.js

@@ -0,0 +1,3 @@
+import { adfMarkGroup } from '@atlaskit/adf-schema-generator';
+import { alignment } from '../marks/alignment';
+export var alignementMarkExclusionGroup = adfMarkGroup('alignmentMarkExclusion', [alignment]);

package/dist/esm/next-schema/groups/annotationGroup.js

@@ -0,0 +1,2 @@
+import { adfMarkGroup } from '@atlaskit/adf-schema-generator';
+export var annotationGroup = adfMarkGroup('annotation');

package/dist/esm/next-schema/groups/blockGroup.js

@@ -0,0 +1,19 @@
+import { adfNodeGroup } from '@atlaskit/adf-schema-generator';
+import { blockCard } from '../nodes/blockCard';
+import { blockquote } from '../nodes/blockquote';
+import { bodiedExtension } from '../nodes/bodiedExtension';
+import { codeBlock } from '../nodes/codeBlock';
+import { decisionList } from '../nodes/decisionList';
+import { embedCard } from '../nodes/embedCard';
+import { expand } from '../nodes/expand';
+import { extension } from '../nodes/extension';
+import { heading } from '../nodes/heading';
+import { bulletList, orderedList } from '../nodes/list';
+import { mediaGroup } from '../nodes/mediaGroup';
+import { mediaSingle } from '../nodes/mediaSingle';
+import { panel } from '../nodes/panel';
+import { paragraph } from '../nodes/paragraph';
+import { rule } from '../nodes/rule';
+import { table } from '../nodes/table';
+import { taskList } from '../nodes/task';
+export var blockGroup = adfNodeGroup('block', [blockCard, codeBlock, mediaSingle, paragraph.use('with_marks'), taskList, orderedList, bulletList, blockquote, decisionList, embedCard, extension, heading, mediaGroup, rule, panel, table, bodiedExtension, expand]);

package/dist/esm/next-schema/groups/blockRootOnlyGroup.js

@@ -0,0 +1,2 @@
+import { adfNodeGroup } from '@atlaskit/adf-schema-generator';
+export var blockRootOnlyGroup = adfNodeGroup('blockRootOnly');

package/dist/esm/next-schema/groups/colorGroup.js

@@ -0,0 +1,3 @@
+import { adfMarkGroup } from '@atlaskit/adf-schema-generator';
+import { textColor } from '../marks/textColor';
+export var colorGroup = adfMarkGroup('color', [textColor]);

package/dist/esm/next-schema/groups/fontStyleGroup.js

@@ -0,0 +1,7 @@
+import { adfMarkGroup } from '@atlaskit/adf-schema-generator';
+import { em } from '../marks/em';
+import { strike } from '../marks/strike';
+import { strong } from '../marks/strong';
+import { subsup } from '../marks/subsup';
+import { underline } from '../marks/underline';
+export var fontStyleGroup = adfMarkGroup('fontStyle', [em, strike, strong, subsup, underline]);

package/dist/esm/next-schema/groups/indentationMarkExclusionGroup.js

@@ -0,0 +1,3 @@
+import { adfMarkGroup } from '@atlaskit/adf-schema-generator';
+import { indentation } from '../marks/indentation';
+export var indentationMarkExclusionGroup = adfMarkGroup('indentationMarkExclusion', [indentation]);

package/dist/esm/next-schema/groups/inlineGroup.js

@@ -0,0 +1,12 @@
+import { adfNodeGroup } from '@atlaskit/adf-schema-generator';
+import { date } from '../nodes/date';
+import { emoji } from '../nodes/emoji';
+import { hardBreak } from '../nodes/hardBreak';
+import { inlineCard } from '../nodes/inlineCard';
+import { mention } from '../nodes/mention';
+import { placeholder } from '../nodes/placeholder';
+import { text } from '../nodes/text';
+import { status } from '../nodes/status';
+import { inlineExtension } from '../nodes/inlineExtension';
+import { mediaInline } from '../nodes/mediaInline';
+export var inlineGroup = adfNodeGroup('inline', [text, date, emoji, hardBreak, inlineCard, mention, placeholder, status, inlineExtension, mediaInline]);

package/dist/esm/next-schema/groups/linkMarkGroup.js

@@ -0,0 +1,3 @@
+import { adfMarkGroup } from '@atlaskit/adf-schema-generator';
+import { link } from '../marks/link';
+export var linkMarkGroup = adfMarkGroup('link', [link]);

package/dist/esm/next-schema/groups/nonNestableBlockContentGroup.js

@@ -0,0 +1,19 @@
+import { blockCard } from '../nodes/blockCard';
+import { blockquote } from '../nodes/blockquote';
+import { codeBlock } from '../nodes/codeBlock';
+import { decisionList } from '../nodes/decisionList';
+import { embedCard } from '../nodes/embedCard';
+import { extension } from '../nodes/extension';
+import { heading } from '../nodes/heading';
+import { bulletList, orderedList } from '../nodes/list';
+import { mediaGroup } from '../nodes/mediaGroup';
+import { mediaSingle } from '../nodes/mediaSingle';
+import { panel } from '../nodes/panel';
+import { paragraph } from '../nodes/paragraph';
+import { rule } from '../nodes/rule';
+import { table } from '../nodes/table';
+import { taskList } from '../nodes/task';
+
+// Not an actual group, but a collection of nodes that can't be nested inside each other
+// TODO: make it an actual group
+export var nonNestableBlockContent = [panel, paragraph, blockquote, orderedList, bulletList, rule, heading, codeBlock, mediaGroup, mediaSingle, decisionList, taskList, table, extension, blockCard, embedCard];

package/dist/esm/next-schema/groups/searchQueryMarkGroup.js

@@ -0,0 +1,2 @@
+import { adfMarkGroup } from '@atlaskit/adf-schema-generator';
+export var searchQueryMarkGroup = adfMarkGroup('searchQuery');

package/dist/esm/next-schema/marks/alignment.js

@@ -0,0 +1,12 @@
+import { adfMark } from '@atlaskit/adf-schema-generator';
+import { indentationMarkExclusionGroup } from '../groups/indentationMarkExclusionGroup';
+export var alignment = adfMark('alignment').define({
+  excludes: [indentationMarkExclusionGroup],
+  attrs: {
+    align: {
+      type: 'enum',
+      values: ['center', 'end'],
+      default: 'center'
+    }
+  }
+});

package/dist/esm/next-schema/marks/annotation.js

@@ -0,0 +1,15 @@
+import { adfMark } from '@atlaskit/adf-schema-generator';
+export var annotation = adfMark('annotation').define({
+  inclusive: true,
+  attrs: {
+    id: {
+      type: 'string',
+      default: ''
+    },
+    annotationType: {
+      type: 'enum',
+      values: ['inlineComment'],
+      default: 'inlineComment'
+    }
+  }
+});

package/dist/esm/next-schema/marks/border.js

@@ -0,0 +1,14 @@
+import { adfMark } from '@atlaskit/adf-schema-generator';
+export var border = adfMark('border').define({
+  inclusive: false,
+  attrs: {
+    size: {
+      type: 'number',
+      minimum: 1,
+      maximum: 3
+    },
+    color: {
+      type: 'string'
+    }
+  }
+});

package/dist/esm/next-schema/marks/breakout.js

@@ -0,0 +1,12 @@
+import { adfMark } from '@atlaskit/adf-schema-generator';
+export var breakout = adfMark('breakout').define({
+  spanning: false,
+  inclusive: true,
+  attrs: {
+    mode: {
+      type: 'enum',
+      values: ['wide', 'full-width'],
+      default: 'wide'
+    }
+  }
+});