@atlaskit/adf-schema 54.0.2 → 54.0.4

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

@@ -1,57 +0,0 @@
-import type { LayoutColumnDefinition } from './layout-column';
-import type { BreakoutMarkDefinition } from '../marks';
-import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-/**
- * @name layoutSection_node
- */
-export type LayoutSectionBaseDefinition = {
-    attrs?: {
-        localId?: string;
-    };
-    content: Array<LayoutColumnDefinition>;
-    marks?: Array<BreakoutMarkDefinition>;
-    type: 'layoutSection';
-};
-/**
- * Need duplicate `type` and `marks` to make both validator and json-schema satisfied
- */
-/**
- * @name layoutSection_full_node
- */
-export type LayoutSectionFullDefinition = LayoutSectionBaseDefinition & {
-    /**
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @minItems 2
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @maxItems 3
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @allowUnsupportedBlock true
-     */
-    content: Array<LayoutColumnDefinition>;
-    marks?: Array<BreakoutMarkDefinition>;
-    type: 'layoutSection';
-};
-/**
- // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
- * @stage 0
- * @name layoutSection_with_single_column_node
- */
-export type LayoutSectionWithSingleColumnDefinition = LayoutSectionBaseDefinition & {
-    /**
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @minItems 1
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @maxItems 3
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @allowUnsupportedBlock true
-     */
-    content: Array<LayoutColumnDefinition>;
-    marks?: Array<BreakoutMarkDefinition>;
-    type: 'layoutSection';
-};
-export type LayoutSectionDefinition = LayoutSectionFullDefinition | LayoutSectionWithSingleColumnDefinition;
-export declare const layoutSection: NodeSpec;
-export declare const layoutSectionFull: NodeSpec;
-export declare const layoutSectionWithSingleColumn: NodeSpec;
-export declare const layoutSectionWithLocalId: NodeSpec;
-export declare const layoutSectionWithSingleColumnLocalId: NodeSpec;

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

@@ -1,9 +0,0 @@
-import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-/**
- * @name list_item
- */
-export declare const listItem: NodeSpec;
-/**
- * @name list_item_with_local_id
- */
-export declare const listItemWithLocalId: NodeSpec;

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

@@ -1,16 +0,0 @@
-import type { MediaDefinition as Media } from './media';
-import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-/**
- * @name mediaGroup_node
- */
-export interface MediaGroupDefinition {
-    /**
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @minItems 1
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     *  @allowUnsupportedBlock true
-     */
-    content: Array<Media>;
-    type: 'mediaGroup';
-}
-export declare const mediaGroup: NodeSpec;

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

@@ -1,20 +0,0 @@
-import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-import type { LinkDefinition } from '../marks/link';
-import type { MediaBaseAttributes } from './media';
-import type { BorderMarkDefinition } from '../marks/border';
-import type { AnnotationMarkDefinition } from '../marks/annotation';
-export interface MediaInlineAttributes extends MediaBaseAttributes {
-    data?: object;
-    type?: 'file' | 'link' | 'image';
-    url?: string | null;
-}
-/**
- * @name mediaInline_node
- */
-export interface MediaInlineDefinition {
-    attrs: MediaInlineAttributes;
-    marks?: Array<LinkDefinition | BorderMarkDefinition | AnnotationMarkDefinition>;
-    type: 'mediaInline';
-}
-export declare const mediaInline: NodeSpec;
-export declare const mediaInlineWithLocalId: NodeSpec;

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

@@ -1,78 +0,0 @@
-import type { NodeSpec, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { MediaDefinition as Media } from './media';
-import type { LinkDefinition } from '../marks/link';
-import type { ExtendedMediaAttributes } from './types/rich-media-common';
-import type { CaptionDefinition as Caption } from './caption';
-export type MediaSingleDefinition = MediaSingleFullDefinition | MediaSingleWithCaptionDefinition;
-/**
- * @name mediaSingle_node
- // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
- * @additionalProperties true
- */
-export interface MediaSingleBaseDefinition {
-    attrs?: ExtendedMediaAttributes;
-    marks?: Array<LinkDefinition>;
-    type: 'mediaSingle';
-}
-/**
- // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
- * @additionalProperties true
- */
-export interface MediaCaptionContent {
-    /**
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @minItems 1
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @maxItems 2
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @allowUnsupportedBlock true
-     */
-    content: [
-        Media,
-        Caption?
-    ];
-}
-/**
- * @name mediaSingle_caption_node
- */
-export type MediaSingleWithCaptionDefinition = MediaSingleBaseDefinition & MediaCaptionContent;
-/**
- // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
- * @additionalProperties true
- */
-export interface MediaSingleFullContent {
-    /**
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @minItems 1
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @maxItems 1
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @allowUnsupportedBlock true
-     */
-    content: Array<Media>;
-}
-/**
- * @name mediaSingle_full_node
- */
-export type MediaSingleFullDefinition = MediaSingleBaseDefinition & MediaSingleFullContent;
-export declare const defaultAttrs: {
-    layout: {
-        default: string;
-    };
-    width: {
-        default: null;
-    };
-};
-export declare const mediaSingleSpec: ({ withCaption, withExtendedWidthTypes, generateLocalId, }: {
-    generateLocalId?: boolean | undefined;
-    withCaption?: boolean | undefined;
-    withExtendedWidthTypes?: boolean | undefined;
-}) => NodeSpec;
-export declare const mediaSingle: NodeSpec;
-export declare const mediaSingleWithCaption: NodeSpec;
-export declare const mediaSingleWithWidthType: NodeSpec;
-export declare const mediaSingleFull: NodeSpec;
-export declare const mediaSingleFullWithLocalId: NodeSpec;
-export declare const toJSON: (node: PMNode) => {
-    attrs: any;
-};

package/dist/types-ts4.5/schema/nodes/media.d.ts

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

package/dist/types-ts4.5/schema/nodes/mention.d.ts

@@ -1,31 +0,0 @@
-import type { Attrs, NodeSpec, Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import type { AnnotationMarkDefinition } from '../marks/annotation';
-export declare enum USER_TYPES {
-    DEFAULT = "DEFAULT",
-    SPECIAL = "SPECIAL",
-    APP = "APP"
-}
-export type UserType = keyof typeof USER_TYPES;
-export interface MentionAttributes {
-    accessLevel?: string;
-    id: string;
-    localId?: string;
-    text?: string;
-    userType?: UserType;
-}
-/**
- * @name mention_node
- */
-export interface MentionDefinition {
-    attrs: MentionAttributes;
-    /**
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @stage 0
-     */
-    marks?: Array<AnnotationMarkDefinition>;
-    type: 'mention';
-}
-export declare const mention: NodeSpec;
-export declare const toJSON: (node: PMNode) => {
-    attrs: Attrs;
-};

package/dist/types-ts4.5/schema/nodes/multi-bodied-extension.d.ts

@@ -1,55 +0,0 @@
-import type { ExtensionAttributes } from './types/extensions';
-import type { BodiedExtensionDefinition as BodiedExtension } from './bodied-extension';
-import type { PanelDefinition as Panel } from './panel';
-import type { ParagraphDefinition as Paragraph } from './paragraph';
-import type { BlockQuoteDefinition as Blockquote } from './blockquote';
-import type { OrderedListDefinition as OrderedList, BulletListDefinition as BulletList } from './types/list';
-import type { RuleDefinition as Rule } from './rule';
-import type { HeadingDefinition as Heading } from './heading';
-import type { CodeBlockDefinition as CodeBlock } from './code-block';
-import type { MediaGroupDefinition as MediaGroup } from './media-group';
-import type { MediaSingleDefinition as MediaSingle } from './media-single';
-import type { DecisionListDefinition as DecisionList } from './decision-list';
-import type { TaskListDefinition as TaskList } from './task-list';
-import type { TableDefinition as Table } from './tableNodes';
-import type { ExtensionDefinition as Extension } from './extension';
-import type { BlockCardDefinition as BlockCard } from './block-card';
-import type { EmbedCardDefinition as EmbedCard } from './embed-card';
-import type { DataConsumerDefinition, FragmentDefinition } from '../marks';
-import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-/**
- // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
- * @stage 0
- * @name extensionFrame_node
- * @description Wraps the block content
- */
-export interface ExtensionFrameDefinition {
-    /**
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @minItems 1
-     */
-    content: Array<BodiedExtension | Panel | Paragraph | Blockquote | OrderedList | BulletList | Rule | Heading | CodeBlock | MediaGroup | MediaSingle | DecisionList | TaskList | Table | Extension | BlockCard | EmbedCard>;
-    marks?: Array<DataConsumerDefinition | FragmentDefinition>;
-    type: 'extensionFrame';
-}
-/**
- * @returns NodeSpec for ExtensionFrameDefinition
- */
-export declare const extensionFrame: NodeSpec;
-/**
- // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
- * @stage 0
- * @name multiBodiedExtension_node
- * @description Wraps multiple extensionFrame objects.
- */
-export interface MultiBodiedExtensionDefinition {
-    attrs: ExtensionAttributes;
-    /**
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @minLength 1
-     */
-    content: Array<ExtensionFrameDefinition>;
-    marks?: Array<any>;
-    type: 'multiBodiedExtension';
-}
-export declare const multiBodiedExtension: NodeSpec;

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

@@ -1,43 +0,0 @@
-import type { NoMark } from './types/mark';
-import type { ParagraphDefinition as Paragraph } from './paragraph';
-import type { HeadingDefinition as Heading } from './heading';
-import type { MediaSingleDefinition as MediaSingle } from './media-single';
-import type { MediaGroupDefinition as MediaGroup } from './media-group';
-import type { CodeBlockDefinition as CodeBlock } from './code-block';
-import type { BulletListDefinition as BulletList, OrderedListDefinition as OrderedList } from './types/list';
-import type { TaskListDefinition as TaskList } from './task-list';
-import type { DecisionListDefinition as DecisionList } from './decision-list';
-import type { RuleDefinition as Rule } from './rule';
-import type { PanelDefinition as Panel } from './panel';
-import type { BlockQuoteDefinition as BlockQuote } from './blockquote';
-import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-/**
- * @name nestedExpand_content
- // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
- * @minItems 1
- // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
- * @allowUnsupportedBlock true
- */
-export type NestedExpandContent = Array<Paragraph | Heading | MediaSingle | MediaGroup | CodeBlock | BulletList | OrderedList | TaskList | DecisionList | Rule | Panel | BlockQuote>;
-/**
- * @name nestedExpand_node
- */
-export interface NestedExpandBaseDefinition {
-    attrs: {
-        __expanded?: boolean;
-        localId?: string;
-        title?: string;
-    };
-    content: NestedExpandContent;
-    type: 'nestedExpand';
-}
-/**
- * @name nestedExpand_with_no_marks_node
- */
-export type NestedExpandDefinition = NestedExpandBaseDefinition & NoMark;
-/**
- * @name nestedExpand
- * @description an expand that can be nested (eg. inside table, layout).
- */
-export declare const nestedExpand: NodeSpec;
-export declare const nestedExpandWithLocalId: NodeSpec;

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

@@ -1,6 +0,0 @@
-import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-export declare const orderedListSelector = ".ak-ol";
-export declare const orderedList: NodeSpec;
-export declare const orderedListWithLocalId: NodeSpec;
-export declare const orderedListWithOrder: NodeSpec;
-export declare const orderedListWithOrderAndLocalId: NodeSpec;

package/dist/types-ts4.5/schema/nodes/panel.d.ts

@@ -1,64 +0,0 @@
-import type { ParagraphDefinition as Paragraph } from './paragraph';
-import type { OrderedListDefinition as OrderedList, BulletListDefinition as BulletList } from './types/list';
-import type { HeadingDefinition as Heading } from './heading';
-import type { BlockCardDefinition as BlockCard } from './block-card';
-import type { CodeBlockDefinition as CodeBlock } from './code-block';
-import type { MediaGroupDefinition as MediaGroup } from './media-group';
-import type { MediaSingleDefinition as MediaSingle } from './media-single';
-import type { DecisionListDefinition as DecisionList } from './decision-list';
-import type { TaskListDefinition as TaskList } from './task-list';
-import type { RuleDefinition as Rule } from './rule';
-import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-export declare enum PanelType {
-    INFO = "info",
-    NOTE = "note",
-    TIP = "tip",
-    WARNING = "warning",
-    ERROR = "error",
-    SUCCESS = "success",
-    CUSTOM = "custom"
-}
-export interface PanelAttributes {
-    localId?: string;
-    panelColor?: string;
-    panelIcon?: string;
-    panelIconId?: string;
-    panelIconText?: string;
-    panelType: PanelType;
-}
-/**
- * @name panel_node
- */
-export interface PanelDefinition {
-    attrs: PanelAttributes;
-    /**
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @minItems 1
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @allowUnsupportedBlock true
-     */
-    content: Array<Paragraph | Heading | OrderedList | BulletList | BlockCard | CodeBlock | MediaGroup | MediaSingle | DecisionList | TaskList | Rule>;
-    type: 'panel';
-}
-export interface DOMAttributes {
-    [propName: string]: string;
-}
-/**
- * @name extended_panel
- *
- * it allows more content to be nested as compared to panel node.
- * Specifically, it allows Media, action, code-block, rule and decision nodes in
- * addition to content allowed inside panel
- */
-export declare const extendedPanel: (allowCustomPanel: boolean) => NodeSpec;
-export declare const extendedPanelWithLocalId: (allowCustomPanel: boolean) => NodeSpec;
-/**
- * @name extended_panel_c1
- *
- * Depth-level-1 variant of panel. Allows all standard panel content
- * plus table nodes. Derives its parseDOM/toDOM behaviour from the same
- * createPanelNodeSpecOptions helper as extendedPanel so that allowCustomPanel
- * and generateLocalId propagate identically.
- */
-export declare const extendedPanelC1: (allowCustomPanel: boolean) => NodeSpec;
-export declare const extendedPanelC1WithLocalId: (allowCustomPanel: boolean) => NodeSpec;

package/dist/types-ts4.5/schema/nodes/paragraph.d.ts

@@ -1,45 +0,0 @@
-import type { AlignmentMarkDefinition, IndentationMarkDefinition } from '../marks';
-import type { MarksObject, NoMark } from './types/mark';
-import type { Inline } from './types/inline-content';
-import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-export interface ParagraphAttributes {
-    /**
-     * An optional UUID for unique identification of the node
-     */
-    localId?: string;
-}
-/**
- * @name paragraph_node
- */
-export interface ParagraphBaseDefinition {
-    attrs?: ParagraphAttributes;
-    /**
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @allowUnsupportedInline true
-     */
-    content?: Array<Inline>;
-    marks?: Array<any>;
-    type: 'paragraph';
-}
-/**
- * @name paragraph_with_no_marks_node
- */
-export 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 type ParagraphWithAlignmentDefinition = ParagraphBaseDefinition & MarksObject<AlignmentMarkDefinition>;
-/**
- * @name paragraph_with_indentation_node
- */
-export type ParagraphWithIndentationDefinition = ParagraphBaseDefinition & MarksObject<IndentationMarkDefinition>;
-export type ParagraphWithMarksDefinition = ParagraphWithAlignmentDefinition | ParagraphWithIndentationDefinition;
-export declare const paragraph: NodeSpec;

package/dist/types-ts4.5/schema/nodes/placeholder.d.ts

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

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

@@ -1,12 +0,0 @@
-import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-/**
- * @name rule_node
- */
-export interface RuleDefinition {
-    attrs?: {
-        localId?: string;
-    };
-    type: 'rule';
-}
-export declare const rule: NodeSpec;
-export declare const ruleWithLocalId: NodeSpec;

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

@@ -1,27 +0,0 @@
-import type { AnnotationMarkDefinition } from '../marks/annotation';
-import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-/**
- * @name status_node
- */
-export interface StatusDefinition {
-    attrs: {
-        color: 'neutral' | 'purple' | 'blue' | 'red' | 'yellow' | 'green';
-        localId?: string;
-        /**
-         * Supported values are bold, subtle, and mixedCase
-         */
-        style?: string;
-        /**
-         // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-         * @minLength 1
-         */
-        text: string;
-    };
-    /**
-     // eslint-disable-next-line eslint-plugin-jsdoc/check-tag-names
-     * @stage 0
-     */
-    marks?: Array<AnnotationMarkDefinition>;
-    type: 'status';
-}
-export declare const status: NodeSpec;

package/dist/types-ts4.5/schema/nodes/sync-block.d.ts

@@ -1,23 +0,0 @@
-import type { NodeSpec } from '@atlaskit/editor-prosemirror/model';
-import type { BreakoutMarkDefinition } from '../marks';
-export interface SyncBlockAttrs {
-    /**
-     * An optional UUID for unique identification of the node
-     */
-    localId: string;
-    /**
-     * The ID of the resource to be synchronized.
-     */
-    resourceId: string;
-}
-/**
- * Represents a block node that is designed to be synchronized
- * with an external resource across different products.
- * @name syncBlock_node
- */
-export interface SyncBlockDefinition {
-    attrs: SyncBlockAttrs;
-    marks?: Array<BreakoutMarkDefinition>;
-    type: 'syncBlock';
-}
-export declare const syncBlock: NodeSpec;