@atlaskit/adf-schema 28.1.12 → 28.2.0

package/src/schema/nodes/emoji.ts

@@ -1,89 +0,0 @@
-import { Node, NodeSpec } from '@atlaskit/editor-prosemirror/model';
-import { acNameToEmoji, acShortcutToEmoji } from '../../utils/confluence/emoji';
-
-/**
- * @name emoji_node
- */
-export interface EmojiDefinition {
-  type: 'emoji';
-  attrs: EmojiAttributes;
-}
-
-export interface EmojiAttributes {
-  id?: string; // Optional to support legacy formats
-  shortName: string;
-  text?: string;
-}
-
-export const emoji: NodeSpec = {
-  inline: true,
-  group: 'inline',
-  selectable: true,
-  attrs: {
-    shortName: { default: '' },
-    id: { default: '' },
-    text: { default: '' },
-  },
-  parseDOM: [
-    // Handle copy/paste beautiful panel from renderer />
-    {
-      tag: 'div.ak-editor-panel__icon span',
-      ignore: true,
-    },
-    {
-      tag: 'span[data-emoji-short-name]',
-      getAttrs: (domNode) => {
-        const dom = domNode as HTMLElement;
-        return {
-          shortName:
-            dom.getAttribute('data-emoji-short-name') ||
-            emoji.attrs!.shortName.default,
-          id: dom.getAttribute('data-emoji-id') || emoji.attrs!.id.default,
-          text:
-            dom.getAttribute('data-emoji-text') || emoji.attrs!.text.default,
-        };
-      },
-    },
-    // Handle copy/paste from old <ac:emoticon />
-    {
-      tag: 'img[data-emoticon-name]',
-      getAttrs: (dom) =>
-        acNameToEmoji(
-          (dom as Element).getAttribute('data-emoticon-name') as any,
-        ),
-    },
-    // Handle copy/paste from old <ac:hipchat-emoticons />
-    {
-      tag: 'img[data-hipchat-emoticon]',
-      getAttrs: (dom) =>
-        acShortcutToEmoji(
-          (dom as Element).getAttribute('data-hipchat-emoticon')!,
-        ),
-    },
-    // Handle copy/paste from bitbucket's <img class="emoji" />
-    {
-      tag: 'img.emoji[data-emoji-short-name]',
-      getAttrs: (domNode) => {
-        const dom = domNode as HTMLElement;
-        return {
-          shortName:
-            dom.getAttribute('data-emoji-short-name') ||
-            emoji.attrs!.shortName.default,
-          id: dom.getAttribute('data-emoji-id') || emoji.attrs!.id.default,
-          text:
-            dom.getAttribute('data-emoji-text') || emoji.attrs!.text.default,
-        };
-      },
-    },
-  ],
-  toDOM(node: Node) {
-    const { shortName, id, text } = node.attrs;
-    const attrs = {
-      'data-emoji-short-name': shortName,
-      'data-emoji-id': id,
-      'data-emoji-text': text,
-      contenteditable: 'false',
-    };
-    return ['span', attrs, text];
-  },
-};

package/src/schema/nodes/expand.ts

@@ -1,101 +0,0 @@
-import { NodeSpec, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import { BreakoutMarkDefinition } from '../marks';
-import { MarksObject, NoMark } from './types/mark';
-import { NonNestableBlockContent } from './types/non-nestable-block-content';
-
-/**
- * @name expand_node
- */
-export interface ExpandBaseDefinition {
-  type: 'expand';
-  attrs: {
-    title?: string;
-  };
-  /**
-   * @minItems 1
-   * @allowUnsupportedBlock true
-   */
-  content: Array<NonNestableBlockContent>;
-  marks?: Array<any>;
-}
-
-/**
- * @name expand_with_no_mark_node
- */
-export type ExpandDefinition = ExpandBaseDefinition & NoMark;
-
-/**
- * @name expand_with_breakout_mark_node
- */
-export type ExpandWithBreakoutDefinition = ExpandBaseDefinition &
-  MarksObject<BreakoutMarkDefinition>;
-
-function getExpandAttrs(domNode: Node | string) {
-  const dom = domNode as HTMLElement;
-  return {
-    title: dom.getAttribute('data-title'),
-    __expanded: true,
-  };
-}
-
-export const expand: NodeSpec = {
-  inline: false,
-  group: 'block',
-  marks: 'dataConsumer fragment unsupportedMark unsupportedNodeAttribute',
-  content:
-    '(paragraph | panel | blockquote | orderedList | bulletList | rule | heading | codeBlock | mediaGroup | mediaSingle | decisionList | taskList | table | blockCard | embedCard | extension | unsupportedBlock)+',
-  isolating: true,
-  selectable: true,
-  attrs: {
-    title: { default: '' },
-    __expanded: { default: true },
-  },
-  parseDOM: [
-    {
-      context: 'table//',
-      tag: 'div[data-node-type="expand"]',
-      getAttrs: getExpandAttrs,
-    },
-    {
-      context: 'expand//',
-      tag: '[data-node-type="expand"]',
-      skip: true,
-    },
-    {
-      context: 'nestedExpand//',
-      tag: '[data-node-type="expand"]',
-      skip: true,
-    },
-    {
-      tag: '[data-node-type="nestedExpand"] button',
-      ignore: true,
-    },
-    {
-      tag: '[data-node-type="expand"] button',
-      ignore: true,
-    },
-    {
-      tag: 'div[data-node-type="expand"]',
-      getAttrs: getExpandAttrs,
-    },
-  ],
-  toDOM(node: PMNode) {
-    const attrs = {
-      'data-node-type': 'expand',
-      'data-title': node.attrs.title,
-      'data-expanded': node.attrs.__expanded,
-    };
-    return ['div', attrs, 0];
-  },
-};
-
-export const toJSON = (node: PMNode) => ({
-  attrs: Object.keys(node.attrs)
-    .filter((key) => !key.startsWith('__'))
-    .reduce<typeof node.attrs>((obj, key) => {
-      return {
-        ...obj,
-        [key]: node.attrs[key],
-      };
-    }, {}),
-});

package/src/schema/nodes/extension.ts

@@ -1,60 +0,0 @@
-import { Node as PMNode, NodeSpec } from '@atlaskit/editor-prosemirror/model';
-import { ExtensionAttributes } from './types/extensions';
-import { getExtensionAttrs } from '../../utils/extensions';
-import { MarksObject } from './types/mark';
-import { DataConsumerDefinition } from '../marks/data-consumer';
-import { FragmentDefinition } from '../marks/fragment';
-
-/**
- * @name extension_node
- */
-export interface ExtensionBaseDefinition {
-  type: 'extension';
-  attrs: ExtensionAttributes;
-  marks?: Array<any>;
-}
-
-/**
- * @name extension_with_marks_node
- */
-export type ExtensionDefinition = ExtensionBaseDefinition &
-  MarksObject<DataConsumerDefinition | FragmentDefinition>;
-
-const createExtensionNodeSpec = (): NodeSpec => {
-  const nodeSpec: 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 as HTMLElement),
-      },
-    ],
-    toDOM(node: PMNode) {
-      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();

package/src/schema/nodes/hard-break.ts

@@ -1,21 +0,0 @@
-import { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-
-/**
- * @name hardBreak_node
- */
-export interface HardBreakDefinition {
-  type: 'hardBreak';
-  attrs?: {
-    text?: '\n';
-  };
-}
-
-export const hardBreak: NodeSpec = {
-  inline: true,
-  group: 'inline',
-  selectable: false,
-  parseDOM: [{ tag: 'br' }],
-  toDOM() {
-    return ['br'];
-  },
-};

package/src/schema/nodes/heading.ts

@@ -1,64 +0,0 @@
-import { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-import { AlignmentMarkDefinition, IndentationMarkDefinition } from '../marks';
-import { MarksObject, NoMark } from './types/mark';
-import { Inline } from './types/inline-content';
-
-/**
- * @name heading_node
- */
-export interface HeadingBaseDefinition {
-  type: 'heading';
-  /**
-   * @allowUnsupportedInline true
-   */
-  content?: Array<Inline>;
-  marks?: Array<any>;
-  attrs: {
-    /**
-     * @minimum 1
-     * @maximum 6
-     */
-    level: number;
-  };
-}
-
-/**
- * @name heading_with_no_marks_node
- */
-export type HeadingDefinition = HeadingBaseDefinition & NoMark;
-
-// Check `paragraph` node for why we are doing things like this
-/**
- * @name heading_with_alignment_node
- */
-export type HeadingWithAlignmentDefinition = HeadingBaseDefinition &
-  MarksObject<AlignmentMarkDefinition>;
-
-/**
- * @name heading_with_indentation_node
- */
-export type HeadingWithIndentationDefinition = HeadingBaseDefinition &
-  MarksObject<IndentationMarkDefinition>;
-
-export type HeadingWithMarksDefinition =
-  | HeadingWithAlignmentDefinition
-  | HeadingWithIndentationDefinition;
-
-export const heading: NodeSpec = {
-  attrs: { level: { default: 1 } },
-  content: `inline*`,
-  group: 'block',
-  defining: true,
-  selectable: false,
-  parseDOM: [
-    { tag: 'h1', attrs: { level: 1 } },
-    { tag: 'h2', attrs: { level: 2 } },
-    { tag: 'h3', attrs: { level: 3 } },
-    { tag: 'h4', attrs: { level: 4 } },
-    { tag: 'h5', attrs: { level: 5 } },
-    { tag: 'h6', attrs: { level: 6 } },
-  ],
-  toDOM(node) {
-    return ['h' + node.attrs['level'], 0];
-  },
-};

package/src/schema/nodes/image.ts

@@ -1,32 +0,0 @@
-import { NodeSpec, Node } from '@atlaskit/editor-prosemirror/model';
-
-export const image: NodeSpec = {
-  group: 'inline',
-  inline: true,
-  attrs: {
-    src: { default: '' },
-    alt: { default: '' },
-    title: { default: null },
-  },
-  draggable: true,
-  parseDOM: [
-    {
-      tag: 'img[src^="data:image/"]',
-      ignore: true,
-    },
-    {
-      tag: 'img[src]',
-      getAttrs(domNode) {
-        const dom = domNode as HTMLElement;
-        return {
-          src: dom.getAttribute('src'),
-          alt: dom.getAttribute('alt'),
-          title: dom.getAttribute('title'),
-        };
-      },
-    },
-  ],
-  toDOM(node: Node) {
-    return ['img', node.attrs];
-  },
-};

package/src/schema/nodes/inline-card.ts

@@ -1,70 +0,0 @@
-import { NodeSpec, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import { CardAttributes } from './block-card';
-
-/**
- * @name inlineCard_node
- */
-export interface InlineCardDefinition {
-  type: 'inlineCard';
-  attrs: CardAttributes;
-}
-
-export const inlineCard: NodeSpec = {
-  inline: true,
-  group: 'inline',
-  selectable: true,
-  draggable: true,
-  attrs: {
-    url: { default: null },
-    data: { default: null },
-  },
-  parseDOM: [
-    {
-      tag: 'a[data-inline-card], span[data-inline-card]',
-
-      // bump priority higher than hyperlink
-      priority: 100,
-
-      getAttrs: (dom) => {
-        const anchor = dom as HTMLAnchorElement;
-        const data = anchor.getAttribute('data-card-data');
-
-        /* Support attrs from Editor and Renderer */
-        return {
-          url:
-            anchor.getAttribute('href') ||
-            anchor.getAttribute('data-card-url') ||
-            null,
-          data: data ? JSON.parse(data) : null,
-        };
-      },
-    },
-
-    // for renderer
-    {
-      tag: 'div[data-inline-card]',
-
-      getAttrs: (dom) => {
-        const anchor = dom as HTMLDivElement;
-        const data = anchor.getAttribute('data-card-data');
-
-        return {
-          url: anchor.getAttribute('data-card-url'),
-          data: data ? JSON.parse(data) : null,
-        };
-      },
-    },
-  ],
-  toDOM(node: PMNode) {
-    const attrs = {
-      'data-inline-card': '',
-      href: node.attrs.url || '',
-      'data-card-data': node.attrs.data ? JSON.stringify(node.attrs.data) : '',
-    };
-    if (node.attrs.url) {
-      return ['a', attrs, node.attrs.url];
-    } else {
-      return ['a', attrs];
-    }
-  },
-};

package/src/schema/nodes/inline-extension.ts

@@ -1,57 +0,0 @@
-import { NodeSpec, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import { getExtensionAttrs } from '../../utils/extensions';
-import { InlineExtensionAttributes } from './types/extensions';
-import { MarksObject } from './types/mark';
-import { DataConsumerDefinition } from '../marks/data-consumer';
-import { FragmentDefinition } from '../marks/fragment';
-
-/**
- * @name inlineExtension_node
- */
-export interface InlineExtensionBaseDefinition {
-  type: 'inlineExtension';
-  attrs: InlineExtensionAttributes;
-  marks?: Array<any>;
-}
-
-/**
- * @name inlineExtension_with_marks_node
- */
-export type InlineExtensionDefinition = InlineExtensionBaseDefinition &
-  MarksObject<DataConsumerDefinition | FragmentDefinition>;
-
-const createInlineExtensionNodeSpec = (): NodeSpec => {
-  const nodeSpec: 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 as HTMLElement, true),
-      },
-    ],
-    toDOM(node: PMNode) {
-      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();

package/src/schema/nodes/layout-column.ts

@@ -1,68 +0,0 @@
-import { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-import { BlockContent } from './types/block-content';
-
-/**
- * @name layoutColumn_node
- */
-export interface LayoutColumnDefinition {
-  type: 'layoutColumn';
-  attrs: {
-    /**
-     * @minimum 0
-     * @maximum 100
-     */
-    width: number;
-  };
-  /**
-   * @minItems 1
-   * @allowUnsupportedBlock true
-   */
-  content: Array<BlockContent>;
-}
-
-export const layoutColumn: NodeSpec = {
-  content: '(block|unsupportedBlock)+',
-  isolating: true,
-  marks:
-    'alignment indentation dataConsumer fragment unsupportedMark unsupportedNodeAttribute',
-  selectable: false,
-  attrs: {
-    width: {
-      default: undefined,
-    },
-  },
-  parseDOM: [
-    {
-      context: 'layoutColumn//',
-      tag: 'div[data-layout-column]',
-      skip: true,
-    },
-    {
-      tag: 'div[data-layout-column]',
-      getAttrs: (domNode) => {
-        const dom = domNode as HTMLElement;
-        return {
-          width: Number(dom.getAttribute('data-column-width')) || undefined,
-        };
-      },
-    },
-  ],
-  toDOM(node) {
-    const attrs: Record<string, string> = {
-      'data-layout-column': 'true',
-    };
-    const { width } = node.attrs;
-    if (width) {
-      attrs['style'] = `flex-basis: ${width}%`;
-      attrs['data-column-width'] = width;
-    }
-
-    // We need to apply a attribute to the inner most child to help
-    // ProseMirror identify its boundaries better.
-    const contentAttrs: Record<string, string> = {
-      'data-layout-content': 'true',
-    };
-
-    return ['div', attrs, ['div', contentAttrs, 0]];
-  },
-};

package/src/schema/nodes/layout-section.ts

@@ -1,93 +0,0 @@
-import { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-import { LayoutColumnDefinition } from './layout-column';
-import { BreakoutMarkDefinition } from '../marks';
-
-/**
- * @name layoutSection_node
- */
-export type LayoutSectionBaseDefinition = {
-  type: 'layoutSection';
-  marks?: Array<BreakoutMarkDefinition>;
-  // Can't use Array<any> because `prosemirror-schema-compatibility-tests` can't handle it.
-  content: Array<LayoutColumnDefinition>;
-};
-
-/**
- * Need duplicate `type` and `marks` to make both validator and json-schema satisfied
- */
-
-/**
- * @name layoutSection_full_node
- */
-export type LayoutSectionFullDefinition = LayoutSectionBaseDefinition & {
-  type: 'layoutSection';
-  marks?: Array<BreakoutMarkDefinition>;
-  /**
-   * @minItems 2
-   * @maxItems 3
-   * @allowUnsupportedBlock true
-   */
-  content: Array<LayoutColumnDefinition>;
-};
-
-/**
- * @stage 0
- * @name layoutSection_with_single_column_node
- */
-export type LayoutSectionWithSingleColumnDefinition =
-  LayoutSectionBaseDefinition & {
-    type: 'layoutSection';
-    marks?: Array<BreakoutMarkDefinition>;
-    /**
-     * @minItems 1
-     * @maxItems 3
-     * @allowUnsupportedBlock true
-     */
-    content: Array<LayoutColumnDefinition>;
-  };
-
-export type LayoutSectionDefinition =
-  | LayoutSectionFullDefinition
-  | LayoutSectionWithSingleColumnDefinition;
-
-export const layoutSection: NodeSpec = {
-  content:
-    '(layoutColumn | unsupportedBlock){1,3} unsupportedBlock* | unsupportedBlock+',
-  marks: 'unsupportedMark unsupportedNodeAttribute',
-  isolating: true,
-  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];
-  },
-};
-
-export const layoutSectionWithSingleColumn: NodeSpec = {
-  content:
-    '(layoutColumn | unsupportedBlock){1,3} unsupportedBlock* | unsupportedBlock+',
-  marks: 'unsupportedMark unsupportedNodeAttribute',
-  isolating: true,
-  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];
-  },
-};

package/src/schema/nodes/list-item.ts

@@ -1,13 +0,0 @@
-import { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-
-export const listItem: NodeSpec = {
-  content:
-    '(paragraph | mediaSingle | codeBlock | unsupportedBlock) (paragraph | bulletList | orderedList | mediaSingle | codeBlock | unsupportedBlock)*',
-  marks: 'unsupportedMark unsupportedNodeAttribute',
-  defining: true,
-  selectable: false,
-  parseDOM: [{ tag: 'li' }],
-  toDOM() {
-    return ['li', 0];
-  },
-};