@atlaskit/adf-schema/report.api.md

Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs

<!-- API Report Version: 2.3 -->

## API Report File for "@atlaskit/adf-schema"

> Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)

### Table of contents

- [Main Entry Types](#main-entry-types)
- [Peer Dependencies](#peer-dependencies)

### Main Entry Types

<!--SECTION START: Main Entry Types-->

```ts
import { CellAttributes } from '@atlaskit/editor-tables/types';
import LinkifyIt from 'linkify-it';
import { Mark } from 'prosemirror-model';
import { MarkSpec } from 'prosemirror-model';
import { Node as Node_2 } from 'prosemirror-model';
import { NodeSpec } from 'prosemirror-model';
import { Schema } from 'prosemirror-model';

// @public (undocumented)
export function acNameToEmoji(acName: NameToEmoji): {
  id: string;
  shortName: string;
  text: string;
};

// @public
const acNameToEmojiMap: {
  smile: string[];
  sad: string[];
  cheeky: string[];
  laugh: string[];
  wink: string[];
  information: string[];
  tick: string[];
  cross: string[];
  warning: string[];
  plus: string[];
  minus: string[];
  question: string[];
  'thumbs-up': string[];
  'thumbs-down': string[];
  'light-on': string[];
  'yellow-star': string[];
  'light-off': string[];
  'red-star': string[];
  'green-star': string[];
  'blue-star': string[];
  heart: string[];
  'broken-heart': string[];
};

// @public (undocumented)
export function acShortcutToEmoji(hipchatEmoticonShortName: string): {
  id: string;
  shortName: string;
  text: string;
};

// @public (undocumented)
export const alignment: MarkSpec;

// @public (undocumented)
export interface AlignmentAttributes {
  // (undocumented)
  align: 'center' | 'end';
}

// @public
export interface AlignmentMarkDefinition {
  // (undocumented)
  attrs: AlignmentAttributes;
  // (undocumented)
  type: 'alignment';
}

// @public
export const alignmentPositionMap: {
  [key: string]: string;
};

// @public (undocumented)
export const annotation: MarkSpec;

// @public (undocumented)
export type AnnotationDataAttributes = {
  'data-mark-type': string;
  'data-mark-annotation-type': AnnotationTypes;
  'data-id': AnnotationId;
  'data-mark-annotation-state'?: AnnotationMarkStates;
};

// @public (undocumented)
export type AnnotationId = string;

// @public (undocumented)
export interface AnnotationMarkAttributes {
  // (undocumented)
  annotationType: AnnotationTypes;
  // (undocumented)
  id: AnnotationId;
}

// @public
export interface AnnotationMarkDefinition {
  // (undocumented)
  attrs: AnnotationMarkAttributes;
  // (undocumented)
  type: 'annotation';
}

// @public (undocumented)
export enum AnnotationMarkStates {
  // (undocumented)
  ACTIVE = 'active',
  // (undocumented)
  RESOLVED = 'resolved',
}

// @public (undocumented)
export enum AnnotationTypes {
  // (undocumented)
  INLINE_COMMENT = 'inlineComment',
}

// @public (undocumented)
export const B100 = '#4C9AFF';

// @public (undocumented)
export const B400 = '#0052CC';

// @public (undocumented)
export const B50 = '#DEEBFF';

// @public (undocumented)
export const B500 = '#0747A6';

// @public (undocumented)
export const B75 = '#B3D4FF';

// @public (undocumented)
export const blockCard: NodeSpec;

// @public
export interface BlockCardDefinition {
  // (undocumented)
  attrs: CardAttributes;
  // (undocumented)
  type: 'blockCard';
}

// @public
export type BlockContent =
  | BlockCardDefinition
  | BlockQuoteDefinition
  | BodiedExtensionDefinition
  | BulletListDefinition
  | CodeBlockDefinition
  | DecisionListDefinition
  | EmbedCardDefinition
  | ExpandDefinition
  | ExtensionDefinition
  | HeadingDefinition
  | HeadingWithMarksDefinition
  | MediaGroupDefinition
  | MediaSingleDefinition
  | OrderedListDefinition
  | PanelDefinition
  | ParagraphDefinition
  | ParagraphWithMarksDefinition
  | RuleDefinition
  | TableDefinition
  | TaskListDefinition;

// @public (undocumented)
export const blockquote: NodeSpec;

// @public
export interface BlockQuoteDefinition {
  content: Array<ParagraphDefinition>;
  // (undocumented)
  type: 'blockquote';
}

// @public (undocumented)
export const bodiedExtension: NodeSpec;

// @public
interface BodiedExtensionBaseDefinition {
  // (undocumented)
  attrs: ExtensionAttributes;
  content: Array<NonNestableBlockContent>;
  // (undocumented)
  marks?: Array<any>;
  // (undocumented)
  type: 'bodiedExtension';
}

// @public
export type BodiedExtensionDefinition = BodiedExtensionBaseDefinition &
  MarksObject<DataConsumerDefinition | FragmentDefinition>;

// @public (undocumented)
export const border: MarkSpec;

// @public (undocumented)
type BorderColorKey = 'Bold gray' | 'Gray' | 'Subtle gray';

// @public (undocumented)
export const borderColorPalette: Map<string, BorderColorKey>;

// @public (undocumented)
export type BorderMarkAttributes = {
  size: number;
  color: string;
};

// @public
export interface BorderMarkDefinition {
  // (undocumented)
  attrs: BorderMarkAttributes;
  // (undocumented)
  type: 'border';
}

// @public (undocumented)
export const breakout: MarkSpec;

// @public (undocumented)
export type BreakoutMarkAttrs = {
  mode: 'full-width' | 'wide';
};

// @public
export interface BreakoutMarkDefinition {
  // (undocumented)
  attrs: BreakoutMarkAttrs;
  // (undocumented)
  type: 'breakout';
}

// @public (undocumented)
export function buildAnnotationMarkDataAttributes({
  id,
  annotationType,
  state,
}: BuildDataAttributesProps): AnnotationDataAttributes;

// @public (undocumented)
type BuildDataAttributesProps = AnnotationMarkAttributes & {
  state?: AnnotationMarkStates | null | undefined;
};

// @public (undocumented)
export const bulletList: NodeSpec;

// @public
export interface BulletListDefinition {
  // (undocumented)
  content: Array<ListItemDefinition>;
  // (undocumented)
  type: 'bulletList';
}

// @public (undocumented)
export const bulletListSelector = '.ak-ul';

// @public (undocumented)
export const caption: NodeSpec;

// @public
export interface CaptionDefinition {
  // (undocumented)
  content: Array<
    | DateDefinition
    | EmojiDefinition
    | HardBreakDefinition
    | InlineCardDefinition
    | InlineCode
    | InlineFormattedText
    | MentionDefinition
    | PlaceholderDefinition
    | StatusDefinition
  >;
  // (undocumented)
  type: 'caption';
}

// @public (undocumented)
export type CardAttributes = DataType | UrlType;

export { CellAttributes };

// @public (undocumented)
export type CellDomAttrs = {
  colspan?: string;
  rowspan?: string;
  style?: string;
  colorname?: string;
  'data-colwidth'?: string;
  'data-cell-background'?: string;
  class?: string;
};

// @public (undocumented)
export const code: MarkSpec;

// @public (undocumented)
export const codeBlock: NodeSpec;

// @public (undocumented)
export type CodeBlockAttrs = {
  language?: string;
};

// @public
export type CodeBlockBaseDefinition = {
  type: 'codeBlock';
  content?: Array<TextDefinition & NoMark>;
  marks?: Array<any>;
  attrs?: CodeBlockAttrs;
};

// @public
export type CodeBlockDefinition = CodeBlockBaseDefinition & NoMark;

// @public (undocumented)
export const codeBlockToJSON: (node: Node_2) => {
  attrs: Record<string, any>;
};

// @public
export type CodeBlockWithMarksDefinition = CodeBlockBaseDefinition &
  MarksObject<BreakoutMarkDefinition>;

// @public
export interface CodeDefinition {
  // (undocumented)
  type: 'code';
}

// @public (undocumented)
export const colorPalette: Map<string, TextColorKey>;

// @public @deprecated (undocumented)
export const colorPaletteExtended: Map<string, TextColorKey>;

// @public (undocumented)
export const confluenceInlineComment: MarkSpec;

// @public (undocumented)
export const confluenceJiraIssue: NodeSpec;

// @public (undocumented)
interface ConfluenceLinkMetadata {
  // (undocumented)
  anchorName?: null | string;
  // (undocumented)
  container?: ConfluenceLinkMetadata;
  // (undocumented)
  contentId?: null | string;
  // (undocumented)
  contentTitle?: null | string;
  // (undocumented)
  fileName?: null | string;
  // (undocumented)
  isRenamedTitle?: boolean;
  // (undocumented)
  linkType: string;
  // (undocumented)
  spaceKey?: null | string;
  // (undocumented)
  versionAtSave?: null | string;
}

// @public (undocumented)
export const confluenceUnsupportedBlock: NodeSpec;

// @public (undocumented)
export const confluenceUnsupportedInline: NodeSpec;

// @public (undocumented)
export const copyPrivateMediaAttributes: (
  from: Record<string, any>,
  to: Record<string, any>,
  map?: ((str: string) => string) | undefined,
) => void;

// @public
export function createSchema<
  N extends string = string,
  M extends string = string,
>(config: SchemaConfig<N, M>): Schema<N, M>;

// @public (undocumented)
export const dataConsumer: MarkSpec;

// @public (undocumented)
export interface DataConsumerAttributes {
  // (undocumented)
  sources: Array<DataConsumerSource>;
}

// @public
export interface DataConsumerDefinition {
  // (undocumented)
  attrs: DataConsumerAttributes;
  // (undocumented)
  type: 'dataConsumer';
}

// @public
type DataConsumerSource = string;

// @public
export const dataConsumerToJSON: (mark: Mark) => {
  type: string;
  attrs: {
    [key: string]: any;
  };
};

// @public (undocumented)
export interface DataType {
  data: object;
}

// @public (undocumented)
export const date: NodeSpec;

// @public
export interface DateDefinition {
  // (undocumented)
  attrs: {
    timestamp: string;
  };
  // (undocumented)
  type: 'date';
}

// @public (undocumented)
export const decisionItem: NodeSpec;

// @public
export interface DecisionItemDefinition {
  // (undocumented)
  attrs: {
    localId: string;
    state: string;
  };
  content?: Array<Inline>;
  // (undocumented)
  type: 'decisionItem';
}

// @public (undocumented)
export const decisionList: NodeSpec;

// @public
export interface DecisionListDefinition {
  // (undocumented)
  attrs: {
    localId: string;
  };
  content: Array<DecisionItemDefinition>;
  // (undocumented)
  type: 'decisionList';
}

// @public (undocumented)
export const decisionListSelector: string;

// @public (undocumented)
export const doc: NodeSpec;

// @public
export interface DocNode {
  content: Array<
    | BlockContent
    | CodeBlockWithMarksDefinition
    | ExpandWithBreakoutDefinition
    | LayoutSectionDefinition
    | ParagraphWithIndentationDefinition
  >;
  // (undocumented)
  type: 'doc';
  // (undocumented)
  version: 1;
}

// @public (undocumented)
export const em: MarkSpec;

// @public (undocumented)
export const embedCard: NodeSpec;

// @public (undocumented)
export interface EmbedCardAttributes extends RichMediaAttributes {
  // (undocumented)
  originalHeight?: number;
  // (undocumented)
  originalWidth?: number;
  url: string;
}

// @public
export interface EmbedCardDefinition {
  // (undocumented)
  attrs: EmbedCardAttributes;
  // (undocumented)
  type: 'embedCard';
}

// @public
export interface EmDefinition {
  // (undocumented)
  type: 'em';
}

// @public (undocumented)
export const emoji: NodeSpec;

// @public (undocumented)
export interface EmojiAttributes {
  // (undocumented)
  id?: string;
  // (undocumented)
  shortName: string;
  // (undocumented)
  text?: string;
}

// @public
export interface EmojiDefinition {
  // (undocumented)
  attrs: EmojiAttributes;
  // (undocumented)
  type: 'emoji';
}

// @public (undocumented)
export function emojiIdToAcName(emojiId: string): never;

// @public (undocumented)
export const expand: NodeSpec;

// @public
interface ExpandBaseDefinition {
  // (undocumented)
  attrs: {
    title?: string;
  };
  content: Array<NonNestableBlockContent>;
  // (undocumented)
  marks?: Array<any>;
  // (undocumented)
  type: 'expand';
}

// @public
export type ExpandDefinition = ExpandBaseDefinition & NoMark;

// @public (undocumented)
export const expandToJSON: (node: Node_2) => {
  attrs: {
    [key: string]: any;
  };
};

// @public
type ExpandWithBreakoutDefinition = ExpandBaseDefinition &
  MarksObject<BreakoutMarkDefinition>;

// @public (undocumented)
export const extension: NodeSpec;

// @public (undocumented)
interface ExtensionAttributes {
  // (undocumented)
  extensionKey: string;
  // (undocumented)
  extensionType: string;
  // (undocumented)
  layout?: ExtensionLayout;
  // (undocumented)
  localId?: string;
  // (undocumented)
  parameters?: object;
  // (undocumented)
  text?: string;
}

// @public
interface ExtensionBaseDefinition {
  // (undocumented)
  attrs: ExtensionAttributes;
  // (undocumented)
  marks?: Array<any>;
  // (undocumented)
  type: 'extension';
}

// @public
export type ExtensionDefinition = ExtensionBaseDefinition &
  MarksObject<DataConsumerDefinition | FragmentDefinition>;

// @public (undocumented)
export type ExtensionLayout = 'default' | 'full-width' | 'wide';

// @public (undocumented)
export interface ExternalMediaAttributes {
  // (undocumented)
  __external?: boolean;
  // (undocumented)
  alt?: string;
  // (undocumented)
  height?: number;
  // (undocumented)
  type: 'external';
  // (undocumented)
  url: string;
  // (undocumented)
  width?: number;
}

// @public (undocumented)
export const fragment: MarkSpec;

// @public (undocumented)
export interface FragmentAttributes {
  // (undocumented)
  localId: LocalId;
  // (undocumented)
  name?: string;
}

// @public
export interface FragmentDefinition {
  // (undocumented)
  attrs: FragmentAttributes;
  // (undocumented)
  type: 'fragment';
}

// @public (undocumented)
export const fragmentToJSON: (mark: Mark) => {
  type: string;
  attrs: {
    name?: any;
    localId: any;
  };
};

// @public (undocumented)
export const G200 = '#57D9A3';

// @public (undocumented)
export const G300 = '#36B37E';

// @public (undocumented)
export const G400 = '#00875A';

// @public (undocumented)
export const G50 = '#E3FCEF';

// @public (undocumented)
export const G500 = '#006644';

// @public (undocumented)
export const G75 = '#ABF5D1';

// @public (undocumented)
export const generateUuid: () => string;

// @public (undocumented)
export const getCellAttrs: (
  dom: HTMLElement,
  defaultValues?: CellAttributes,
) => {
  colspan: number;
  rowspan: number;
  colwidth: null | number[];
  background: null | string;
};

// @public
export const getCellDomAttrs: (node: Node_2) => CellDomAttrs;

// @public (undocumented)
export function getEmojiAcName({
  id,
  shortName,
}: {
  id: string;
  shortName: string;
}): string;

// @public (undocumented)
export function getLinkMatch(str?: string): Match | null;

// @public (undocumented)
export const hardBreak: NodeSpec;

// @public
export interface HardBreakDefinition {
  // (undocumented)
  attrs?: {
    text?: '\n';
  };
  // (undocumented)
  type: 'hardBreak';
}

// @public (undocumented)
export const heading: NodeSpec;

// @public
export interface HeadingBaseDefinition {
  // (undocumented)
  attrs: {
    level: number;
  };
  content?: Array<Inline>;
  // (undocumented)
  marks?: Array<any>;
  // (undocumented)
  type: 'heading';
}

// @public
export type HeadingDefinition = HeadingBaseDefinition & NoMark;

// @public
export type HeadingWithAlignmentDefinition = HeadingBaseDefinition &
  MarksObject<AlignmentMarkDefinition>;

// @public
export type HeadingWithIndentationDefinition = HeadingBaseDefinition &
  MarksObject<IndentationMarkDefinition>;

// @public (undocumented)
export type HeadingWithMarksDefinition =
  | HeadingWithAlignmentDefinition
  | HeadingWithIndentationDefinition;

// @public
export function hexToRgb(color: string): null | string;

// @public
export function hexToRgba(rawColor: string, alpha: number): null | string;

// @public (undocumented)
export const image: NodeSpec;

// @public (undocumented)
export const indentation: MarkSpec;

// @public (undocumented)
export interface IndentationMarkAttributes {
  level: number;
}

// @public
export interface IndentationMarkDefinition {
  // (undocumented)
  attrs: IndentationMarkAttributes;
  // (undocumented)
  type: 'indentation';
}

// @public
export type Inline = InlineAtomic | InlineCode | InlineFormattedText;

// @public
export type InlineAtomic =
  | DateDefinition
  | EmojiDefinition
  | HardBreakDefinition
  | InlineCardDefinition
  | InlineExtensionDefinition
  | MediaInlineDefinition
  | MentionDefinition
  | PlaceholderDefinition
  | StatusDefinition;

// @public (undocumented)
export const inlineCard: NodeSpec;

// @public
export interface InlineCardDefinition {
  // (undocumented)
  attrs: CardAttributes;
  // (undocumented)
  type: 'inlineCard';
}

// @public
export type InlineCode = TextDefinition &
  MarksObject<AnnotationMarkDefinition | CodeDefinition | LinkDefinition>;

// @public (undocumented)
export const inlineExtension: NodeSpec;

// @public (undocumented)
interface InlineExtensionAttributes {
  // (undocumented)
  extensionKey: string;
  // (undocumented)
  extensionType: string;
  // (undocumented)
  localId?: string;
  // (undocumented)
  parameters?: object;
  // (undocumented)
  text?: string;
}

// @public
interface InlineExtensionBaseDefinition {
  // (undocumented)
  attrs: InlineExtensionAttributes;
  // (undocumented)
  marks?: Array<any>;
  // (undocumented)
  type: 'inlineExtension';
}

// @public
export type InlineExtensionDefinition = InlineExtensionBaseDefinition &
  MarksObject<DataConsumerDefinition | FragmentDefinition>;

// @public
export type InlineFormattedText = TextDefinition &
  MarksObject<
    | AnnotationMarkDefinition
    | EmDefinition
    | LinkDefinition
    | StrikeDefinition
    | StrongDefinition
    | SubSupDefinition
    | TextColorDefinition
    | UnderlineDefinition
  >;

// @public
export type InlineLinkText = TextDefinition & MarksObject<LinkDefinition>;

// @public (undocumented)
export const inlineNodes: Set<string>;

// @public (undocumented)
export function isHex(color: string): boolean;

// @public (undocumented)
export function isRgb(color: string): boolean;

// @public
export const isSafeUrl: (url: string) => boolean;

// @public (undocumented)
export const layoutColumn: NodeSpec;

// @public
export interface LayoutColumnDefinition {
  // (undocumented)
  attrs: {
    width: number;
  };
  content: Array<BlockContent>;
  // (undocumented)
  type: 'layoutColumn';
}

// @public (undocumented)
export const layoutSection: NodeSpec;

// @public
type LayoutSectionBaseDefinition = {
  type: 'layoutSection';
  marks?: Array<BreakoutMarkDefinition>;
  content: Array<LayoutColumnDefinition>;
};

// @public (undocumented)
export type LayoutSectionDefinition =
  | LayoutSectionFullDefinition
  | LayoutSectionWithSingleColumnDefinition;

// @public
export type LayoutSectionFullDefinition = LayoutSectionBaseDefinition & {
  type: 'layoutSection';
  marks?: Array<BreakoutMarkDefinition>;
  content: Array<LayoutColumnDefinition>;
};

// @public
export type LayoutSectionWithSingleColumnDefinition =
  LayoutSectionBaseDefinition & {
    type: 'layoutSection';
    marks?: Array<BreakoutMarkDefinition>;
    content: Array<LayoutColumnDefinition>;
  };

// @public (undocumented)
export const link: MarkSpec;

// @public (undocumented)
export interface LinkAttributes {
  // (undocumented)
  __confluenceMetadata?: ConfluenceLinkMetadata;
  // (undocumented)
  collection?: string;
  href: string;
  // (undocumented)
  id?: string;
  // (undocumented)
  occurrenceKey?: string;
  // (undocumented)
  title?: string;
}

// @public
export interface LinkDefinition {
  // (undocumented)
  attrs: LinkAttributes;
  // (undocumented)
  type: 'link';
}

// @public (undocumented)
export const linkify: LinkifyIt.LinkifyIt;

// @public (undocumented)
export const linkifyMatch: (text: string) => Match[];

// @public (undocumented)
export const linkToJSON: (mark: Mark) => {
  type: string;
  attrs: Record<string, string>;
};

// @public (undocumented)
export const listItem: NodeSpec;

// @public (undocumented)
export interface ListItemArray
  extends Array<
    | BulletListDefinition
    | CodeBlockDefinition
    | MediaSingleDefinition
    | OrderedListDefinition
    | ParagraphDefinition
  > {
  // (undocumented)
  0: CodeBlockDefinition | MediaSingleDefinition | ParagraphDefinition;
}

// @public
export interface ListItemDefinition {
  // (undocumented)
  content: ListItemArray;
  // (undocumented)
  type: 'listItem';
}

// @public (undocumented)
type LocalId = string;

// @public
export interface MarksObject<T> {
  // (undocumented)
  marks?: Array<T>;
}

// @public (undocumented)
export interface Match {
  // (undocumented)
  index: number;
  // (undocumented)
  input?: string;
  // (undocumented)
  lastIndex: number;
  // (undocumented)
  length?: number;
  // (undocumented)
  raw: string;
  // (undocumented)
  schema: any;
  // (undocumented)
  text: string;
  // (undocumented)
  url: string;
}

// @public (undocumented)
export const media: NodeSpec;

// @public (undocumented)
export type MediaADFAttrs = ExternalMediaAttributes | MediaAttributes;

// @public (undocumented)
export interface MediaAttributes extends MediaBaseAttributes {
  // (undocumented)
  type: 'file' | 'link';
}

// @public (undocumented)
export interface MediaBaseAttributes {
  // (undocumented)
  __contextId?: null | string;
  // (undocumented)
  __displayType?: MediaDisplayType | null;
  // (undocumented)
  __external?: boolean;
  // (undocumented)
  __fileMimeType?: null | string;
  // (undocumented)
  __fileName?: null | string;
  // (undocumented)
  __fileSize?: null | number;
  // (undocumented)
  __mediaTraceId?: null | string;
  // (undocumented)
  alt?: string;
  // (undocumented)
  collection: string;
  // (undocumented)
  height?: number;
  // (undocumented)
  id: string;
  // (undocumented)
  occurrenceKey?: string;
  // (undocumented)
  width?: number;
}

// @public
interface MediaCaptionContent {
  content: [MediaDefinition, CaptionDefinition?];
}

// @public
export interface MediaDefinition {
  // (undocumented)
  attrs: MediaADFAttrs;
  // (undocumented)
  marks?: Array<BorderMarkDefinition | LinkDefinition>;
  // (undocumented)
  type: 'media';
}

// @public (undocumented)
export type MediaDisplayType = 'file' | 'thumbnail';

// @public (undocumented)
export const mediaGroup: NodeSpec;

// @public
export interface MediaGroupDefinition {
  content: Array<MediaDefinition>;
  // (undocumented)
  type: 'mediaGroup';
}

// @public (undocumented)
export const mediaInline: NodeSpec;

// @public (undocumented)
export interface MediaInlineAttributes extends MediaBaseAttributes {
  // (undocumented)
  data?: object;
  // (undocumented)
  type?: 'file' | 'link';
}

// @public
export interface MediaInlineDefinition {
  // (undocumented)
  attrs: MediaInlineAttributes;
  // (undocumented)
  marks?: Array<LinkDefinition>;
  // (undocumented)
  type: 'mediaInline';
}

// @public (undocumented)
export const mediaSingle: NodeSpec;

// @public
interface MediaSingleBaseDefinition {
  // (undocumented)
  attrs?: RichMediaAttributes;
  // (undocumented)
  marks?: Array<LinkDefinition>;
  // (undocumented)
  type: 'mediaSingle';
}

// @public (undocumented)
export type MediaSingleDefinition =
  | MediaSingleFullDefinition
  | MediaSingleWithCaptionDefinition;

// @public
interface MediaSingleFullContent {
  content: Array<MediaDefinition>;
}

// @public
type MediaSingleFullDefinition = MediaSingleBaseDefinition &
  MediaSingleFullContent;

// @public (undocumented)
export const mediaSingleToJSON: (node: Node_2) => {
  attrs: any;
};

// @public (undocumented)
export const mediaSingleWithCaption: NodeSpec;

// @public
type MediaSingleWithCaptionDefinition = MediaSingleBaseDefinition &
  MediaCaptionContent;

// @public (undocumented)
export const mediaToJSON: (node: Node_2) => {
  attrs: Record<string, any>;
};

// @public (undocumented)
export type MediaType = 'external' | 'file' | 'link';

// @public (undocumented)
export const mention: NodeSpec;

// @public (undocumented)
export interface MentionAttributes {
  // (undocumented)
  accessLevel?: string;
  // (undocumented)
  id: string;
  // (undocumented)
  text?: string;
  // (undocumented)
  userType?: MentionUserType;
}

// @public
export interface MentionDefinition {
  // (undocumented)
  attrs: MentionAttributes;
  // (undocumented)
  type: 'mention';
}

// @public (undocumented)
export const mentionToJSON: (node: Node_2) => {
  attrs: {
    [key: string]: any;
  };
};

// @public (undocumented)
export type MentionUserType = keyof typeof USER_TYPES;

// @public (undocumented)
export const N0 = '#FFFFFF';

// @public (undocumented)
export const N20 = '#F4F5F7';

// @public (undocumented)
export const N200 = '#6B778C';

// @public (undocumented)
export const N30 = '#EBECF0';

// @public (undocumented)
export const N300 = '#5E6C84';

// @public (undocumented)
export const N40 = '#DFE1E6';

// @public (undocumented)
export const N50 = '#C1C7D0';

// @public (undocumented)
export const N500 = '#42526E';

// @public (undocumented)
export const N60 = '#B3BAC5';

// @public (undocumented)
export const N80 = '#97A0AF';

// @public (undocumented)
export const N800 = '#172B4D';

// @public (undocumented)
export const N90 = '#8993A4';

// @public (undocumented)
export type NameToEmoji = keyof typeof acNameToEmojiMap;

// @public (undocumented)
export const nestedExpand: NodeSpec;

// @public
interface NestedExpandBaseDefinition {
  // (undocumented)
  attrs: {
    title?: string;
  };
  // (undocumented)
  content: NestedExpandContent;
  // (undocumented)
  type: 'nestedExpand';
}

// @public
export type NestedExpandContent = Array<
  | HeadingDefinition
  | MediaGroupDefinition
  | MediaSingleDefinition
  | ParagraphDefinition
>;

// @public
export type NestedExpandDefinition = NestedExpandBaseDefinition & NoMark;

// @public
export interface NoMark {
  // (undocumented)
  marks?: Array<any>;
}

// @public
export type NonNestableBlockContent =
  | BlockCardDefinition
  | BlockQuoteDefinition
  | BulletListDefinition
  | CodeBlockDefinition
  | DecisionListDefinition
  | EmbedCardDefinition
  | ExtensionDefinition
  | HeadingDefinition
  | MediaGroupDefinition
  | MediaSingleDefinition
  | OrderedListDefinition
  | PanelDefinition
  | ParagraphDefinition
  | RuleDefinition
  | TableDefinition
  | TaskListDefinition;

// @public
export function normalizeHexColor(
  color: null | string,
  defaultColor?: string,
): null | string;

// @public
export function normalizeUrl(url?: string): string;

// @public (undocumented)
export const orderedList: NodeSpec;

// @public
export interface OrderedListDefinition {
  // (undocumented)
  attrs?: {
    order?: number;
  };
  // (undocumented)
  content: Array<ListItemDefinition>;
  // (undocumented)
  type: 'orderedList';
}

// @public (undocumented)
export const orderedListSelector = '.ak-ol';

// @public (undocumented)
export const orderedListWithOrder: NodeSpec;

// @public (undocumented)
export const P100 = '#998DD9';

// @public (undocumented)
export const P300 = '#6554C0';

// @public (undocumented)
export const P400 = '#5243AA';

// @public (undocumented)
export const P50 = '#EAE6FF';

// @public (undocumented)
export const P500 = '#403294';

// @public (undocumented)
export const P75 = '#C0B6F2';

// @public (undocumented)
export const panel: (allowCustomPanel: boolean) => NodeSpec;

// @public (undocumented)
export interface PanelAttributes {
  // (undocumented)
  panelColor?: string;
  // (undocumented)
  panelIcon?: string;
  // (undocumented)
  panelIconId?: string;
  // (undocumented)
  panelIconText?: string;
  // (undocumented)
  panelType: PanelType;
}

// @public
export interface PanelDefinition {
  // (undocumented)
  attrs: PanelAttributes;
  content: Array<
    | BlockCardDefinition
    | BulletListDefinition
    | HeadingDefinition
    | OrderedListDefinition
    | ParagraphDefinition
  >;
  // (undocumented)
  type: 'panel';
}

// @public (undocumented)
export enum PanelType {
  // (undocumented)
  CUSTOM = 'custom',
  // (undocumented)
  ERROR = 'error',
  // (undocumented)
  INFO = 'info',
  // (undocumented)
  NOTE = 'note',
  // (undocumented)
  SUCCESS = 'success',
  // (undocumented)
  TIP = 'tip',
  // (undocumented)
  WARNING = 'warning',
}

// @public (undocumented)
export const paragraph: NodeSpec;

// @public
export interface ParagraphBaseDefinition {
  content?: Array<Inline>;
  // (undocumented)
  marks?: Array<any>;
  // (undocumented)
  type: 'paragraph';
}

// @public
export type ParagraphDefinition = ParagraphBaseDefinition & NoMark;

// @public
export type ParagraphWithAlignmentDefinition = ParagraphBaseDefinition &
  MarksObject<AlignmentMarkDefinition>;

// @public
export type ParagraphWithIndentationDefinition = ParagraphBaseDefinition &
  MarksObject<IndentationMarkDefinition>;

// @public (undocumented)
export type ParagraphWithMarksDefinition =
  | ParagraphWithAlignmentDefinition
  | ParagraphWithIndentationDefinition;

// @public (undocumented)
export const placeholder: NodeSpec;

// @public
export interface PlaceholderDefinition {
  // (undocumented)
  attrs: {
    text: string;
  };
  // (undocumented)
  type: 'placeholder';
}

// @public (undocumented)
export const R100 = '#FF8F73';

// @public (undocumented)
export const R300 = '#FF5630';

// @public (undocumented)
export const R400 = '#DE350B';

// @public
export const R50 = '#FFEBE6';

// @public (undocumented)
export const R500 = '#BF2600';

// @public (undocumented)
export const R75 = '#FFBDAD';

// @public (undocumented)
export function rgbToHex(value: string): null | string;

// @public (undocumented)
export interface RichMediaAttributes {
  // (undocumented)
  layout: RichMediaLayout;
  width?: number;
}

// @public (undocumented)
export type RichMediaLayout =
  | 'align-end'
  | 'align-start'
  | 'center'
  | 'full-width'
  | 'wide'
  | 'wrap-left'
  | 'wrap-right';

// @public (undocumented)
export const rule: NodeSpec;

// @public
export interface RuleDefinition {
  // (undocumented)
  type: 'rule';
}

// @public (undocumented)
export function sanitizeNodes(
  nodes: {
    [key: string]: NodeSpec;
  },
  supportedMarks: {
    [key: string]: MarkSpec;
  },
): {
  [key: string]: NodeSpec;
};

// @public (undocumented)
interface SchemaConfig<N = string, M = string> {
  // (undocumented)
  customMarkSpecs?: SchemaCustomMarkSpecs;
  // (undocumented)
  customNodeSpecs?: SchemaCustomNodeSpecs;
  // (undocumented)
  marks?: M[];
  // (undocumented)
  nodes: N[];
}

// @public (undocumented)
interface SchemaCustomMarkSpecs {
  // (undocumented)
  [name: string]: MarkSpec;
}

// @public (undocumented)
interface SchemaCustomNodeSpecs {
  // (undocumented)
  [name: string]: NodeSpec;
}

// @public (undocumented)
const status_2: NodeSpec;
export { status_2 as status };

// @public
export interface StatusDefinition {
  // (undocumented)
  attrs: {
    text: string;
    color: 'blue' | 'green' | 'neutral' | 'purple' | 'red' | 'yellow';
    localId?: string;
    style?: string;
  };
  // (undocumented)
  type: 'status';
}

// @public (undocumented)
export const strike: MarkSpec;

// @public
export interface StrikeDefinition {
  // (undocumented)
  type: 'strike';
}

// @public (undocumented)
export const strong: MarkSpec;

// @public
export interface StrongDefinition {
  // (undocumented)
  type: 'strong';
}

// @public (undocumented)
export const subsup: MarkSpec;

// @public (undocumented)
export interface SubSupAttributes {
  // (undocumented)
  type: 'sub' | 'sup';
}

// @public
export interface SubSupDefinition {
  // (undocumented)
  attrs: SubSupAttributes;
  // (undocumented)
  type: 'subsup';
}

// @public (undocumented)
export const T100 = '#79E2F2';

// @public (undocumented)
export const T300 = '#00B8D9';

// @public (undocumented)
export const T50 = '#E6FCFF';

// @public (undocumented)
export const T500 = '#008DA6';

// @public (undocumented)
export const T75 = '#B3F5FF';

// @public (undocumented)
export const table: NodeSpec;

// @public (undocumented)
export interface TableAttributes {
  // (undocumented)
  __autoSize?: boolean;
  // (undocumented)
  isNumberColumnEnabled?: boolean;
  // (undocumented)
  layout?: TableLayout;
  // (undocumented)
  localId?: string;
}

// @public (undocumented)
export const tableBackgroundBorderColor: string;

// @public (undocumented)
export const tableBackgroundColorNames: Map<string, string>;

// @public (undocumented)
export const tableBackgroundColorPalette: Map<string, string>;

// @public (undocumented)
export const tableCell: NodeSpec;

// @public
type TableCellContent = Array<
  | BlockCardDefinition
  | BlockQuoteDefinition
  | BulletListDefinition
  | CodeBlockDefinition
  | DecisionListDefinition
  | EmbedCardDefinition
  | ExtensionDefinition
  | HeadingDefinition
  | HeadingWithMarksDefinition
  | MediaGroupDefinition
  | MediaSingleDefinition
  | NestedExpandDefinition
  | OrderedListDefinition
  | PanelDefinition
  | ParagraphDefinition
  | ParagraphWithAlignmentDefinition
  | RuleDefinition
  | TaskListDefinition
>;

// @public (undocumented)
export const tableCellContentDomSelector: string;

// @public (undocumented)
export const tableCellContentWrapperSelector: string;

// @public
export interface TableCellDefinition {
  // (undocumented)
  attrs?: CellAttributes;
  // (undocumented)
  content: TableCellContent;
  // (undocumented)
  type: 'tableCell';
}

// @public (undocumented)
export const tableCellSelector: string;

// @public
export interface TableDefinition {
  // (undocumented)
  attrs?: TableAttributes;
  // (undocumented)
  content: Array<TableRowDefinition>;
  // (undocumented)
  marks?: Array<FragmentDefinition>;
  // (undocumented)
  type: 'table';
}

// @public (undocumented)
export const tableHeader: NodeSpec;

// @public
export interface TableHeaderDefinition {
  // (undocumented)
  attrs?: CellAttributes;
  // (undocumented)
  content: TableCellContent;
  // (undocumented)
  type: 'tableHeader';
}

// @public (undocumented)
export const tableHeaderSelector: string;

// @public (undocumented)
export type TableLayout = 'default' | 'full-width' | 'wide';

// @public (undocumented)
export const tablePrefixSelector = 'pm-table';

// @public (undocumented)
export const tableRow: NodeSpec;

// @public
export interface TableRowDefinition {
  // (undocumented)
  content: Array<TableCellDefinition | TableHeaderDefinition>;
  // (undocumented)
  type: 'tableRow';
}

// @public (undocumented)
export const tableToJSON: (node: Node_2) => {
  attrs: {
    [key: string]: any;
  };
};

// @public (undocumented)
export const taskItem: NodeSpec;

// @public
export interface TaskItemDefinition {
  // (undocumented)
  attrs: {
    localId: string;
    state: 'DONE' | 'TODO';
  };
  content?: Array<Inline>;
  // (undocumented)
  type: 'taskItem';
}

// @public (undocumented)
export const taskList: NodeSpec;

// @public (undocumented)
export interface TaskListContent
  extends Array<TaskItemDefinition | TaskListDefinition> {
  // (undocumented)
  0: TaskItemDefinition;
}

// @public
export interface TaskListDefinition {
  // (undocumented)
  attrs: {
    localId: string;
  };
  content: TaskListContent;
  // (undocumented)
  type: 'taskList';
}

// @public (undocumented)
export const taskListSelector: string;

// @public (undocumented)
export const text: NodeSpec & {
  toDebugString?: () => string;
};

// @public (undocumented)
export const textColor: MarkSpec;

// @public (undocumented)
export interface TextColorAttributes {
  color: string;
}

// @public
export interface TextColorDefinition {
  // (undocumented)
  attrs: TextColorAttributes;
  // (undocumented)
  type: 'textColor';
}

// @public (undocumented)
type TextColorKey =
  | 'Blue'
  | 'Dark blue'
  | 'Dark gray'
  | 'Dark green'
  | 'Dark purple'
  | 'Dark red'
  | 'Dark teal'
  | 'Green'
  | 'Light blue'
  | 'Light gray'
  | 'Light green'
  | 'Light purple'
  | 'Light red'
  | 'Light teal'
  | 'Light yellow'
  | 'Orange'
  | 'Purple'
  | 'Red'
  | 'Teal'
  | 'White'
  | 'Yellow';

// @public
export interface TextDefinition {
  // (undocumented)
  marks?: Array<any>;
  // (undocumented)
  text: string;
  // (undocumented)
  type: 'text';
}

// @public (undocumented)
export const toJSONTableCell: (node: Node_2) => {
  attrs: Record<string, any>;
};

// @public (undocumented)
export const toJSONTableHeader: (node: Node_2) => {
  attrs: Record<string, any>;
};

// @public (undocumented)
export const typeAheadQuery: MarkSpec;

// @public (undocumented)
export const underline: MarkSpec;

// @public
export interface UnderlineDefinition {
  // (undocumented)
  type: 'underline';
}

// @public (undocumented)
export const unknownBlock: NodeSpec;

// @public (undocumented)
export const unsupportedBlock: NodeSpec;

// @public (undocumented)
export const unsupportedInline: NodeSpec;

// @public (undocumented)
export const unsupportedMark: MarkSpec;

// @public (undocumented)
export const unsupportedNodeAttribute: MarkSpec;

// @public (undocumented)
export const unsupportedNodeTypesForMediaCards: Set<string>;

// @public (undocumented)
export interface UrlType {
  url: string;
}

// @public (undocumented)
enum USER_TYPES {
  // (undocumented)
  APP = 'APP',
  // (undocumented)
  DEFAULT = 'DEFAULT',
  // (undocumented)
  SPECIAL = 'SPECIAL',
}

// @public (undocumented)
export const uuid: {
  setStatic(value: false | string): void;
  generate(): string;
};

// @public (undocumented)
export const Y200 = '#FFC400';

// @public (undocumented)
export const Y400 = '#FF991F';

// @public (undocumented)
export const Y50 = '#FFFAE6';

// @public (undocumented)
export const Y500 = '#FF8B00';

// @public (undocumented)
export const Y75 = '#FFF0B3';

// (No @packageDocumentation comment for this package)
```

<!--SECTION END: Main Entry Types-->

### Peer Dependencies

<!--SECTION START: Peer Dependencies-->

```json
{}
```

<!--SECTION END: Peer Dependencies-->