@atlaskit/adf-schema 19.2.0

package/dist/types/schema/nodes/inline-extension.d.ts

@@ -0,0 +1,21 @@
+import { NodeSpec } from 'prosemirror-model';
+import { InlineExtensionAttributes } from './types/extensions';
+import { MarksObject, NoMark } from './types/mark';
+import { DataConsumerDefinition } from '../marks/data-consumer';
+/**
+ * @name inlineExtension_node
+ */
+export interface InlineExtensionBaseDefinition {
+    type: 'inlineExtension';
+    attrs: InlineExtensionAttributes;
+    marks?: Array<any>;
+}
+/**
+ * @name inlineExtension_with_no_marks_node
+ */
+export declare type InlineExtensionDefinition = InlineExtensionBaseDefinition & NoMark;
+/**
+ * @name inlineExtension_with_marks_node
+ */
+export declare type InlineExtensionWithMarksDefinition = InlineExtensionBaseDefinition & MarksObject<DataConsumerDefinition>;
+export declare const inlineExtension: NodeSpec;

package/dist/types/schema/nodes/layout-column.d.ts

@@ -0,0 +1,21 @@
+import { NodeSpec } from '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 declare const layoutColumn: NodeSpec;

package/dist/types/schema/nodes/layout-section.d.ts

@@ -0,0 +1,44 @@
+import { NodeSpec } from 'prosemirror-model';
+import { LayoutColumnDefinition } from './layout-column';
+import { BreakoutMarkDefinition } from '../marks';
+/**
+ * @name layoutSection_node
+ */
+export declare type LayoutSectionBaseDefinition = {
+    type: 'layoutSection';
+    marks?: Array<BreakoutMarkDefinition>;
+    content: Array<LayoutColumnDefinition>;
+};
+/**
+ * Need duplicate `type` and `marks` to make both validator and json-schema satisfied
+ */
+/**
+ * @name layoutSection_full_node
+ */
+export declare type LayoutSectionFullDefinition = LayoutSectionBaseDefinition & {
+    type: 'layoutSection';
+    marks?: Array<BreakoutMarkDefinition>;
+    /**
+     * @minItems 1
+     * @maxItems 3
+     * @allowUnsupportedBlock true
+     */
+    content: Array<LayoutColumnDefinition>;
+};
+/**
+ * @stage 0
+ * @name layoutSection_with_single_column_node
+ */
+export declare type LayoutSectionWithSingleColumnDefinition = LayoutSectionBaseDefinition & {
+    type: 'layoutSection';
+    marks?: Array<BreakoutMarkDefinition>;
+    /**
+     * @minItems 1
+     * @maxItems 3
+     * @allowUnsupportedBlock true
+     */
+    content: Array<LayoutColumnDefinition>;
+};
+export declare type LayoutSectionDefinition = LayoutSectionFullDefinition | LayoutSectionWithSingleColumnDefinition;
+export declare const layoutSection: NodeSpec;
+export declare const layoutSectionWithSingleColumn: NodeSpec;

package/dist/types/schema/nodes/list-item.d.ts

@@ -0,0 +1,20 @@
+import { NodeSpec } from 'prosemirror-model';
+import { ParagraphDefinition as Paragraph } from './paragraph';
+import { OrderedListDefinition as OrderedList } from './ordered-list';
+import { BulletListDefinition as BulletList } from './bullet-list';
+import { MediaSingleDefinition as MediaSingle } from './media-single';
+import { CodeBlockDefinition as CodeBlock } from './code-block';
+export interface ListItemArray extends Array<Paragraph | OrderedList | BulletList | MediaSingle | CodeBlock> {
+    0: Paragraph | MediaSingle | CodeBlock;
+}
+/**
+ * @name listItem_node
+ */
+export interface ListItemDefinition {
+    type: 'listItem';
+    /**
+     * @minItems 1
+     */
+    content: ListItemArray;
+}
+export declare const listItem: NodeSpec;

package/dist/types/schema/nodes/media-group.d.ts

@@ -0,0 +1,14 @@
+import { NodeSpec } from 'prosemirror-model';
+import { MediaDefinition as Media } from './media';
+/**
+ * @name mediaGroup_node
+ */
+export interface MediaGroupDefinition {
+    type: 'mediaGroup';
+    /**
+     * @minItems 1
+     *  @allowUnsupportedBlock true
+     */
+    content: Array<Media>;
+}
+export declare const mediaGroup: NodeSpec;

package/dist/types/schema/nodes/media-inline.d.ts

@@ -0,0 +1,16 @@
+import { NodeSpec } from 'prosemirror-model';
+import { LinkDefinition } from '../marks/link';
+import { MediaBaseAttributes } from './media';
+export interface MediaInlineAttributes extends MediaBaseAttributes {
+    data?: object;
+}
+/**
+ * @stage 0
+ * @name mediaInline_node
+ */
+export interface MediaInlineDefinition {
+    type: 'mediaInline';
+    attrs: MediaInlineAttributes;
+    marks?: Array<LinkDefinition>;
+}
+export declare const mediaInline: NodeSpec;

package/dist/types/schema/nodes/media-single.d.ts

@@ -0,0 +1,59 @@
+import { NodeSpec, Node } from 'prosemirror-model';
+import { MediaDefinition as Media } from './media';
+import { LinkDefinition } from '../marks/link';
+import { RichMediaAttributes } from './types/rich-media-common';
+import { CaptionDefinition as Caption } from './caption';
+export declare type MediaSingleDefinition = MediaSingleFullDefinition | MediaSingleWithCaptionDefinition;
+/**
+ * @name mediaSingle_node
+ * @additionalProperties true
+ */
+export interface MediaSingleBaseDefinition {
+    type: 'mediaSingle';
+    attrs?: RichMediaAttributes;
+    marks?: Array<LinkDefinition>;
+}
+/**
+ * @additionalProperties true
+ */
+export interface MediaSingleFullContent {
+    /**
+     * @minItems 1
+     * @maxItems 1
+     * @allowUnsupportedBlock true
+     */
+    content: Array<Media>;
+}
+/**
+ * @name mediaSingle_full_node
+ */
+export declare type MediaSingleFullDefinition = MediaSingleBaseDefinition & MediaSingleFullContent;
+/**
+ * @additionalProperties true
+ */
+export interface MediaCaptionContent {
+    /**
+     * @minItems 1
+     * @maxItems 2
+     * @allowUnsupportedBlock true
+     */
+    content: [Media, Caption?];
+}
+/**
+ * @name mediaSingle_caption_node
+ * @stage 0
+ */
+export declare type MediaSingleWithCaptionDefinition = MediaSingleBaseDefinition & MediaCaptionContent;
+export declare const defaultAttrs: {
+    width: {
+        default: null;
+    };
+    layout: {
+        default: string;
+    };
+};
+export declare const mediaSingle: NodeSpec;
+export declare const mediaSingleWithCaption: NodeSpec;
+export declare const toJSON: (node: Node) => {
+    attrs: any;
+};

package/dist/types/schema/nodes/media.d.ts

@@ -0,0 +1,60 @@
+import { NodeSpec, Node as PMNode } from 'prosemirror-model';
+import { LinkDefinition } from '../marks/link';
+export declare type MediaType = 'file' | 'link' | 'external';
+export declare type DisplayType = 'file' | 'thumbnail';
+export declare type DefaultAttributes<T> = {
+    [P in keyof T]: {
+        default?: T[P] | null;
+    };
+};
+/**
+ * @name media_node
+ */
+export interface MediaDefinition {
+    type: 'media';
+    /**
+     * @minItems 1
+     */
+    attrs: MediaADFAttrs;
+    marks?: Array<LinkDefinition>;
+}
+export interface MediaBaseAttributes {
+    /**
+     * @minLength 1
+     */
+    id: string;
+    collection: string;
+    height?: number;
+    width?: number;
+    /**
+     * @minLength 1
+     */
+    occurrenceKey?: string;
+    alt?: string;
+    __fileName?: string | null;
+    __fileSize?: number | null;
+    __fileMimeType?: string | null;
+    __displayType?: DisplayType | null;
+    __contextId?: string;
+    __external?: boolean;
+}
+export interface MediaAttributes extends MediaBaseAttributes {
+    type: 'file' | 'link';
+}
+export interface ExternalMediaAttributes {
+    type: 'external';
+    url: string;
+    alt?: string;
+    width?: number;
+    height?: number;
+    __external?: boolean;
+}
+export declare type MediaADFAttrs = MediaAttributes | ExternalMediaAttributes;
+export declare const defaultAttrs: DefaultAttributes<MediaADFAttrs>;
+export declare const createMediaSpec: (attributes: Partial<NodeSpec['attrs']>, inline?: boolean) => NodeSpec;
+export declare const media: NodeSpec;
+export declare const camelCaseToKebabCase: (str: string) => string;
+export declare const copyPrivateAttributes: (from: Record<string, any>, to: Record<string, any>, map?: ((str: string) => string) | undefined) => void;
+export declare const toJSON: (node: PMNode) => {
+    attrs: Record<string, any>;
+};

package/dist/types/schema/nodes/mention.d.ts

@@ -0,0 +1,26 @@
+import { NodeSpec, Node as PMNode } from 'prosemirror-model';
+export declare enum USER_TYPES {
+    DEFAULT = "DEFAULT",
+    SPECIAL = "SPECIAL",
+    APP = "APP"
+}
+export declare type UserType = keyof typeof USER_TYPES;
+export interface MentionAttributes {
+    id: string;
+    text?: string;
+    userType?: UserType;
+    accessLevel?: string;
+}
+/**
+ * @name mention_node
+ */
+export interface MentionDefinition {
+    type: 'mention';
+    attrs: MentionAttributes;
+}
+export declare const mention: NodeSpec;
+export declare const toJSON: (node: PMNode) => {
+    attrs: {
+        [key: string]: any;
+    };
+};

package/dist/types/schema/nodes/nested-expand.d.ts

@@ -0,0 +1,27 @@
+import { NodeSpec } from 'prosemirror-model';
+import { NoMark } from './types/mark';
+import { ParagraphDefinition as Paragraph } from './paragraph';
+import { HeadingDefinition as Heading } from './heading';
+import { MediaSingleDefinition as MediaSingle } from './media-single';
+import { MediaGroupDefinition as MediaGroup } from './media-group';
+/**
+ * @name nestedExpand_content
+ * @minItems 1
+ * @allowUnsupportedBlock true
+ */
+export declare type NestedExpandContent = Array<Paragraph | Heading | MediaSingle | MediaGroup>;
+/**
+ * @name nestedExpand_node
+ */
+export interface NestedExpandBaseDefinition {
+    type: 'nestedExpand';
+    attrs: {
+        title?: string;
+    };
+    content: NestedExpandContent;
+}
+/**
+ * @name nestedExpand_with_no_marks_node
+ */
+export declare type NestedExpandDefinition = NestedExpandBaseDefinition & NoMark;
+export declare const nestedExpand: NodeSpec;

package/dist/types/schema/nodes/ordered-list.d.ts

@@ -0,0 +1,20 @@
+import { NodeSpec } from 'prosemirror-model';
+import { ListItemDefinition as ListItemNode } from './list-item';
+/**
+ * @name orderedList_node
+ */
+export interface OrderedListDefinition {
+    type: 'orderedList';
+    /**
+     * @minItems 1
+     */
+    content: Array<ListItemNode>;
+    attrs?: {
+        /**
+         * @minimum 1
+         */
+        order: number;
+    };
+}
+export declare const orderedListSelector = ".ak-ol";
+export declare const orderedList: NodeSpec;

package/dist/types/schema/nodes/panel.d.ts

@@ -0,0 +1,46 @@
+import { NodeSpec } from 'prosemirror-model';
+import { ParagraphDefinition as Paragraph } from './paragraph';
+import { OrderedListDefinition as OrderedList } from './ordered-list';
+import { BulletListDefinition as BulletList } from './bullet-list';
+import { HeadingDefinition as Heading } from './heading';
+import { BlockCardDefinition as BlockCard } from './block-card';
+export declare enum PanelType {
+    INFO = "info",
+    NOTE = "note",
+    TIP = "tip",
+    WARNING = "warning",
+    ERROR = "error",
+    SUCCESS = "success",
+    /**
+     * @stage 0
+     */
+    CUSTOM = "custom"
+}
+export interface PanelAttributes {
+    panelType: PanelType;
+    /**
+     * @stage 0
+     */
+    panelIcon?: string;
+    /**
+     * @stage 0
+     */
+    panelColor?: string;
+}
+/**
+ * @name panel_node
+ */
+export interface PanelDefinition {
+    type: 'panel';
+    attrs: PanelAttributes;
+    /**
+     * @minItems 1
+     * @allowUnsupportedBlock true
+     */
+    content: Array<Paragraph | Heading | OrderedList | BulletList | BlockCard>;
+}
+export interface DOMAttributes {
+    [propName: string]: string;
+}
+export declare const customPanel: NodeSpec;
+export declare const panel: NodeSpec;

package/dist/types/schema/nodes/paragraph.d.ts

@@ -0,0 +1,37 @@
+import { NodeSpec } from 'prosemirror-model';
+import { AlignmentMarkDefinition, IndentationMarkDefinition } from '../marks';
+import { MarksObject, NoMark } from './types/mark';
+import { Inline } from './types/inline-content';
+/**
+ * @name paragraph_node
+ */
+export interface ParagraphBaseDefinition {
+    type: 'paragraph';
+    /**
+     * @allowUnsupportedInline true
+     */
+    content?: Array<Inline>;
+    marks?: Array<any>;
+}
+/**
+ * @name paragraph_with_no_marks_node
+ */
+export declare type ParagraphDefinition = ParagraphBaseDefinition & NoMark;
+/**
+ * NOTE: Need this because TS is too smart and inline everything.
+ * So we need to give them separate identity.
+ * Probably there's a way to solve it but that will need time and exploration.
+ * // http://bit.ly/2raXFX5
+ * type T1 = X | Y
+ * type T2 = A | T1 | B // T2 = A | X | Y | B
+ */
+/**
+ * @name paragraph_with_alignment_node
+ */
+export declare type ParagraphWithAlignmentDefinition = ParagraphBaseDefinition & MarksObject<AlignmentMarkDefinition>;
+/**
+ * @name paragraph_with_indentation_node
+ */
+export declare type ParagraphWithIndentationDefinition = ParagraphBaseDefinition & MarksObject<IndentationMarkDefinition>;
+export declare type ParagraphWithMarksDefinition = ParagraphWithAlignmentDefinition | ParagraphWithIndentationDefinition;
+export declare const paragraph: NodeSpec;

package/dist/types/schema/nodes/placeholder.d.ts

@@ -0,0 +1,11 @@
+import { NodeSpec } from 'prosemirror-model';
+/**
+ * @name placeholder_node
+ */
+export interface PlaceholderDefinition {
+    type: 'placeholder';
+    attrs: {
+        text: string;
+    };
+}
+export declare const placeholder: NodeSpec;