@atlaskit/adf-schema 24.0.0 → 24.0.2

package/dist/types-ts4.0/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-ts4.0/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-ts4.0/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-ts4.0/schema/nodes/panel.d.ts

@@ -0,0 +1,38 @@
+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",
+    CUSTOM = "custom"
+}
+export interface PanelAttributes {
+    panelType: PanelType;
+    panelIcon?: string;
+    panelIconId?: string;
+    panelIconText?: string;
+    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 panel: (allowCustomPanel: boolean) => NodeSpec;

package/dist/types-ts4.0/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-ts4.0/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;

package/dist/types-ts4.0/schema/nodes/rule.d.ts

@@ -0,0 +1,8 @@
+import { NodeSpec } from 'prosemirror-model';
+/**
+ * @name rule_node
+ */
+export interface RuleDefinition {
+    type: 'rule';
+}
+export declare const rule: NodeSpec;

package/dist/types-ts4.0/schema/nodes/status.d.ts

@@ -0,0 +1,20 @@
+import { NodeSpec } from 'prosemirror-model';
+/**
+ * @name status_node
+ */
+export interface StatusDefinition {
+    type: 'status';
+    attrs: {
+        /**
+         * @minLength 1
+         */
+        text: string;
+        color: 'neutral' | 'purple' | 'blue' | 'red' | 'yellow' | 'green';
+        localId?: string;
+        /**
+         * Supported values are bold and subtle
+         */
+        style?: string;
+    };
+}
+export declare const status: NodeSpec;

package/dist/types-ts4.0/schema/nodes/tableNodes.d.ts

@@ -0,0 +1,113 @@
+import { Node as PmNode, NodeSpec } from 'prosemirror-model';
+import { CellAttributes } from '@atlaskit/editor-tables/types';
+import { PanelDefinition as Panel } from './panel';
+import { ParagraphDefinition as Paragraph, ParagraphWithAlignmentDefinition as ParagraphWithMarks } from './paragraph';
+import { BlockQuoteDefinition as Blockquote } from './blockquote';
+import { OrderedListDefinition as OrderedList } from './ordered-list';
+import { BulletListDefinition as BulletList } from './bullet-list';
+import { RuleDefinition as Rule } from './rule';
+import { HeadingDefinition as Heading, HeadingWithMarksDefinition as HeadingWithMarks } from './heading';
+import { CodeBlockDefinition as CodeBlock } from './code-block';
+import { MediaGroupDefinition as MediaGroup } from './media-group';
+import { MediaSingleDefinition as MediaSingle } from './media-single';
+import { DecisionListDefinition as DecisionList } from './decision-list';
+import { TaskListDefinition as TaskList } from './task-list';
+import { ExtensionDefinition as Extension } from './extension';
+import { BlockCardDefinition as BlockCard } from './block-card';
+import { EmbedCardDefinition as EmbedCard } from './embed-card';
+import { NestedExpandDefinition as NestedExpand } from './nested-expand';
+import { FragmentDefinition } from '../marks/fragment';
+export type { CellAttributes };
+export declare const tablePrefixSelector = "pm-table";
+export declare const tableCellSelector: string;
+export declare const tableHeaderSelector: string;
+export declare const tableCellContentWrapperSelector: string;
+export declare const tableCellContentDomSelector: string;
+export declare const getCellAttrs: (dom: HTMLElement, defaultValues?: CellAttributes) => {
+    colspan: number;
+    rowspan: number;
+    colwidth: number[] | null;
+    background: string | null;
+};
+export declare type CellDomAttrs = {
+    colspan?: string;
+    rowspan?: string;
+    style?: string;
+    colorname?: string;
+    'data-colwidth'?: string;
+    class?: string;
+};
+/**
+ * gets cell dom attributes based on node attributes
+ * @returns CellDomAttrs
+ */
+export declare const getCellDomAttrs: (node: PmNode) => CellDomAttrs;
+export declare const tableBackgroundColorPalette: Map<string, string>;
+export declare const tableBackgroundBorderColor: string;
+export declare const tableBackgroundColorNames: Map<string, string>;
+export declare type Layout = 'default' | 'full-width' | 'wide';
+export interface TableAttributes {
+    isNumberColumnEnabled?: boolean;
+    layout?: Layout;
+    __autoSize?: boolean;
+    /**
+     * @minLength 1
+     */
+    localId?: string;
+}
+/**
+ * @name table_node
+ */
+export interface TableDefinition {
+    type: 'table';
+    attrs?: TableAttributes;
+    /**
+     * @minItems 1
+     */
+    content: Array<TableRow>;
+    marks?: Array<FragmentDefinition>;
+}
+/**
+ * @name table_row_node
+ */
+export interface TableRow {
+    type: 'tableRow';
+    content: Array<TableHeader | TableCell>;
+}
+/**
+ * @name table_cell_content
+ * @minItems 1
+ * @allowUnsupportedBlock true
+ */
+export declare type TableCellContent = Array<Panel | Paragraph | ParagraphWithMarks | Blockquote | OrderedList | BulletList | Rule | Heading | HeadingWithMarks | CodeBlock | MediaGroup | MediaSingle | DecisionList | TaskList | Extension | BlockCard | NestedExpand | EmbedCard>;
+/**
+ * @name table_cell_node
+ */
+export interface TableCell {
+    type: 'tableCell';
+    attrs?: CellAttributes;
+    content: TableCellContent;
+}
+/**
+ * @name table_header_node
+ */
+export interface TableHeader {
+    type: 'tableHeader';
+    attrs?: CellAttributes;
+    content: TableCellContent;
+}
+export declare const table: NodeSpec;
+export declare const tableToJSON: (node: PmNode) => {
+    attrs: {
+        [key: string]: any;
+    };
+};
+export declare const tableRow: NodeSpec;
+export declare const tableCell: NodeSpec;
+export declare const toJSONTableCell: (node: PmNode) => {
+    attrs: Record<string, any>;
+};
+export declare const tableHeader: NodeSpec;
+export declare const toJSONTableHeader: (node: PmNode) => {
+    attrs: Record<string, any>;
+};

package/dist/types-ts4.0/schema/nodes/task-item.d.ts

@@ -0,0 +1,17 @@
+import { NodeSpec } from 'prosemirror-model';
+import { Inline } from './types/inline-content';
+/**
+ * @name taskItem_node
+ */
+export interface TaskItemDefinition {
+    type: 'taskItem';
+    /**
+     * @allowUnsupportedInline true
+     */
+    content?: Array<Inline>;
+    attrs: {
+        localId: string;
+        state: 'TODO' | 'DONE';
+    };
+}
+export declare const taskItem: NodeSpec;

package/dist/types-ts4.0/schema/nodes/task-list.d.ts

@@ -0,0 +1,21 @@
+import { NodeSpec } from 'prosemirror-model';
+import { TaskItemDefinition as TaskItemNode } from './task-item';
+export interface TaskListContent extends Array<TaskItemNode | TaskListDefinition> {
+    0: TaskItemNode;
+}
+/**
+ * @name taskList_node
+ */
+export interface TaskListDefinition {
+    type: 'taskList';
+    /**
+     * @minItems 1
+     * @allowUnsupportedBlock true
+     */
+    content: TaskListContent;
+    attrs: {
+        localId: string;
+    };
+}
+export declare const taskListSelector: string;
+export declare const taskList: NodeSpec;

package/dist/types-ts4.0/schema/nodes/text.d.ts

@@ -0,0 +1,15 @@
+import { NodeSpec } from 'prosemirror-model';
+/**
+ * @name text_node
+ */
+export interface TextDefinition {
+    type: 'text';
+    /**
+     * @minLength 1
+     */
+    text: string;
+    marks?: Array<any>;
+}
+export declare const text: NodeSpec & {
+    toDebugString?: () => string;
+};

package/dist/types-ts4.0/schema/nodes/types/block-content.d.ts

@@ -0,0 +1,22 @@
+import { ExpandDefinition as Expand } from '../expand';
+import { BodiedExtensionDefinition as BodiedExtension } from '../bodied-extension';
+import { PanelDefinition as Panel } from '../panel';
+import { ParagraphDefinition as Paragraph, ParagraphWithMarksDefinition as ParagraphWithMarks } from '../paragraph';
+import { BlockQuoteDefinition as Blockquote } from '../blockquote';
+import { OrderedListDefinition as OrderedList } from '../ordered-list';
+import { BulletListDefinition as BulletList } from '../bullet-list';
+import { RuleDefinition as Rule } from '../rule';
+import { HeadingDefinition as Heading, HeadingWithMarksDefinition as HeadingWithMarks } from '../heading';
+import { CodeBlockDefinition as CodeBlock } from '../code-block';
+import { MediaGroupDefinition as MediaGroup } from '../media-group';
+import { MediaSingleDefinition as MediaSingle } from '../media-single';
+import { DecisionListDefinition as DecisionList } from '../decision-list';
+import { TaskListDefinition as TaskList } from '../task-list';
+import { TableDefinition as Table } from '../tableNodes';
+import { ExtensionDefinition as Extension } from '../extension';
+import { BlockCardDefinition as BlockCard } from '../block-card';
+import { EmbedCardDefinition as EmbedCard } from '../embed-card';
+/**
+ * @name block_content
+ */
+export declare type BlockContent = Panel | Paragraph | ParagraphWithMarks | Blockquote | OrderedList | BulletList | Rule | Heading | HeadingWithMarks | CodeBlock | MediaGroup | MediaSingle | DecisionList | TaskList | Table | Expand | Extension | BodiedExtension | BlockCard | EmbedCard;

package/dist/types-ts4.0/schema/nodes/types/extensions.d.ts

@@ -0,0 +1,34 @@
+export declare type Layout = 'default' | 'wide' | 'full-width';
+export interface ExtensionAttributes {
+    /**
+     * @minLength 1
+     */
+    extensionKey: string;
+    /**
+     * @minLength 1
+     */
+    extensionType: string;
+    parameters?: object;
+    text?: string;
+    layout?: Layout;
+    /**
+     * @minLength 1
+     */
+    localId?: string;
+}
+export interface InlineExtensionAttributes {
+    /**
+     * @minLength 1
+     */
+    extensionKey: string;
+    /**
+     * @minLength 1
+     */
+    extensionType: string;
+    parameters?: object;
+    text?: string;
+    /**
+     * @minLength 1
+     */
+    localId?: string;
+}

package/dist/types-ts4.0/schema/nodes/types/inline-content.d.ts

@@ -0,0 +1,32 @@
+import { HardBreakDefinition as HardBreak } from '../hard-break';
+import { MentionDefinition as Mention } from '../mention';
+import { EmojiDefinition as Emoji } from '../emoji';
+import { InlineExtensionDefinition } from '../inline-extension';
+import { DateDefinition as Date } from '../date';
+import { PlaceholderDefinition as Placeholder } from '../placeholder';
+import { InlineCardDefinition as InlineCard } from '../inline-card';
+import { StatusDefinition as Status } from '../status';
+import { TextDefinition as Text } from '../text';
+import { MarksObject } from './mark';
+import { AnnotationMarkDefinition as Annotation, CodeDefinition as Code, EmDefinition as Em, LinkDefinition as Link, StrikeDefinition as Strike, StrongDefinition as Strong, SubSupDefinition as SubSup, TextColorDefinition as TextColor, UnderlineDefinition as Underline } from '../../marks';
+import { MediaInlineDefinition } from '../media-inline';
+/**
+ * @name formatted_text_inline_node
+ */
+export declare type InlineFormattedText = Text & MarksObject<Link | Em | Strong | Strike | SubSup | Underline | TextColor | Annotation>;
+/**
+ * @name link_text_inline_node
+ */
+export declare type InlineLinkText = Text & MarksObject<Link>;
+/**
+ * @name code_inline_node
+ */
+export declare type InlineCode = Text & MarksObject<Code | Link | Annotation>;
+/**
+ * @name atomic_inline_node
+ */
+export declare type InlineAtomic = HardBreak | Mention | Emoji | InlineExtensionDefinition | Date | Placeholder | InlineCard | Status | MediaInlineDefinition;
+/**
+ * @name inline_node
+ */
+export declare type Inline = InlineFormattedText | InlineCode | InlineAtomic;

package/dist/types-ts4.0/schema/nodes/types/mark.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @additionalProperties true
+ */
+export interface MarksObject<T> {
+    marks?: Array<T>;
+}
+/**
+ * @additionalProperties true
+ */
+export interface NoMark {
+    /**
+     * @maxItems 0
+     */
+    marks?: Array<any>;
+}

package/dist/types-ts4.0/schema/nodes/types/non-nestable-block-content.d.ts

@@ -0,0 +1,20 @@
+import { PanelDefinition as Panel } from '../panel';
+import { ParagraphDefinition as Paragraph } from '../paragraph';
+import { BlockQuoteDefinition as Blockquote } from '../blockquote';
+import { OrderedListDefinition as OrderedList } from '../ordered-list';
+import { BulletListDefinition as BulletList } from '../bullet-list';
+import { RuleDefinition as Rule } from '../rule';
+import { HeadingDefinition as Heading } from '../heading';
+import { CodeBlockDefinition as CodeBlock } from '../code-block';
+import { MediaGroupDefinition as MediaGroup } from '../media-group';
+import { MediaSingleDefinition as MediaSingle } from '../media-single';
+import { DecisionListDefinition as DecisionList } from '../decision-list';
+import { TaskListDefinition as TaskList } from '../task-list';
+import { TableDefinition as Table } from '../tableNodes';
+import { ExtensionDefinition as Extension } from '../extension';
+import { BlockCardDefinition as BlockCard } from '../block-card';
+import { EmbedCardDefinition as EmbedCard } from '../embed-card';
+/**
+ * @name non_nestable_block_content
+ */
+export declare type NonNestableBlockContent = Panel | Paragraph | Blockquote | OrderedList | BulletList | Rule | Heading | CodeBlock | MediaGroup | MediaSingle | DecisionList | TaskList | Table | Extension | BlockCard | EmbedCard;

package/dist/types-ts4.0/schema/nodes/types/rich-media-common.d.ts

@@ -0,0 +1,9 @@
+export declare type Layout = 'wrap-right' | 'center' | 'wrap-left' | 'wide' | 'full-width' | 'align-end' | 'align-start';
+export interface RichMediaAttributes {
+    /**
+     * @minimum 0
+     * @maximum 100
+     */
+    width?: number;
+    layout: Layout;
+}

package/dist/types-ts4.0/schema/nodes/unknown-block.d.ts

@@ -0,0 +1,3 @@
+import { NodeSpec } from 'prosemirror-model';
+declare const _default: NodeSpec;
+export default _default;

package/dist/types-ts4.0/schema/nodes/unsupported-block.d.ts

@@ -0,0 +1,2 @@
+import { NodeSpec } from 'prosemirror-model';
+export declare const unsupportedBlock: NodeSpec;

package/dist/types-ts4.0/schema/nodes/unsupported-inline.d.ts

@@ -0,0 +1,2 @@
+import { NodeSpec } from 'prosemirror-model';
+export declare const unsupportedInline: NodeSpec;

package/dist/types-ts4.0/schema/unsupported.d.ts

@@ -0,0 +1 @@
+export declare const unsupportedNodeTypesForMediaCards: Set<string>;

package/dist/types-ts4.0/steps/analytics.d.ts

@@ -0,0 +1,59 @@
+import { Node as PMNode } from 'prosemirror-model';
+import { Step, StepResult, StepMap, ReplaceStep, Mappable } from 'prosemirror-transform';
+export declare const analyticsStepType = "atlaskit-analytics";
+export declare const analyticsInvertStepType = "atlaskit-analytics-invert";
+export interface AnalyticsPayload {
+    action: string;
+    actionSubject: string;
+    actionSubjectId?: string | null;
+    attributes?: Record<string, any>;
+    eventType: string;
+}
+export interface AnalyticsWithChannel<P extends AnalyticsPayload> {
+    payload: P;
+    channel: string;
+}
+declare enum HISTORY_ACTIONS {
+    UNDID = "undid",
+    REDID = "redid"
+}
+interface UndoAnalyticsEventPayload {
+    action: HISTORY_ACTIONS.UNDID;
+    actionSubject: string;
+    actionSubjectId?: string;
+    attributes?: Record<string, any>;
+    eventType: string;
+}
+interface RedoAnalyticsEventPayload {
+    action: HISTORY_ACTIONS.REDID;
+    actionSubject: string;
+    actionSubjectId?: string;
+    attributes?: Record<string, any>;
+    eventType: string;
+}
+declare type AnalyticsInvertPayload = UndoAnalyticsEventPayload | RedoAnalyticsEventPayload;
+export declare type AnalyticsInvertStep = AnalyticsStep<AnalyticsInvertPayload>;
+/**
+ * Custom Prosemirror Step to fire our GAS V3 analytics events
+ * Using a Step means that it will work with prosemirror-history and we get
+ * undo/redo events for free
+ */
+export declare class AnalyticsStep<P extends AnalyticsPayload> extends Step {
+    analyticsEvents: AnalyticsWithChannel<P>[];
+    pos?: number;
+    private actionsToIgnore;
+    constructor(analyticsEvents: AnalyticsWithChannel<P>[], actionsToIgnore?: string[], pos?: number);
+    /**
+     * Generate new undo/redo analytics event when step is inverted
+     */
+    invert(): AnalyticsStep<AnalyticsInvertPayload>;
+    apply(doc: PMNode): StepResult<any>;
+    map(mapping: Mappable): AnalyticsStep<P>;
+    getMap(): StepMap;
+    merge(other: Step): AnalyticsStep<P> | null;
+    toJSON(): {
+        stepType: string;
+    };
+    static fromJSON(): ReplaceStep<any>;
+}
+export {};

package/dist/types-ts4.0/steps/set-attrs.d.ts

@@ -0,0 +1,23 @@
+import { Mappable, Step, StepResult } from 'prosemirror-transform';
+import { Node as ProseMirrorNode, Schema } from 'prosemirror-model';
+/**
+ * For more context on what this is about:
+ * @see https://discuss.prosemirror.net/t/preventing-image-placeholder-replacement-from-being-undone/1394
+ */
+export declare class SetAttrsStep extends Step {
+    pos: number;
+    attrs: object;
+    constructor(pos: number, attrs: object);
+    apply(doc: ProseMirrorNode): StepResult<any>;
+    invert(doc: ProseMirrorNode): SetAttrsStep;
+    map(mapping: Mappable): SetAttrsStep | null;
+    toJSON(): {
+        stepType: string;
+        pos: number;
+        attrs: object;
+    };
+    static fromJSON(_schema: Schema, json: {
+        pos?: number;
+        attrs: object;
+    }): SetAttrsStep;
+}