@atlaskit/editor-core/src/prosemirror/prosemirror-model/schema.d.ts

A package contains Atlassian editor core functionality

import OrderedMap = require('orderedmap');
import { Fragment, Mark, Node, ParseRule } from './';
import { DOMOutputSpec } from './to_dom';

export interface AttributeSpec {
  default?: any;
  compute?: () => any;
}

export interface MarkSpec {
  attrs?: { [key: string]: AttributeSpec };
  inclusive?: boolean;
  excludes?: string;
  group?: string;
  toDOM?: (mark: Mark) => DOMOutputSpec;
  parseDOM?: ParseRule[];
}

export interface NodeSpec {
  atom?: boolean;
  content?: string;
  group?: string;
  inline?: boolean;
  attrs?: { [key: string]: AttributeSpec };
  selectable?: boolean;
  draggable?: boolean;
  isolating?: boolean;
  code?: boolean;
  defining?: boolean;
  toDOM?: (_0: Node) => {};
  parseDOM?: ParseRule[];
  tableRole?: string;
}

export class NodeType {
  name: string;
  schema: Schema<any, any>;
  spec: NodeSpec;
  isBlock: boolean;
  isText: boolean;
  isInline: boolean;
  isTextblock: boolean;
  inlineContent: boolean;
  isLeaf: boolean;
  isAtom: boolean;
  create(attrs?: { [key: string]: any }, content?: Fragment | Node | Node[], marks?: Mark[]): Node;
  createChecked(attrs?: { [key: string]: any }, content?: Fragment | Node | Node[], marks?: Mark[]): Node;
  createAndFill(attrs?: { [key: string]: any }, content?: Fragment | Node | Node[], marks?: Mark[]): Node | null;
  validContent(content: Fragment, attrs?: { [key: string]: any }): boolean;
}

export class MarkType {
  name: string;
  schema: Schema<any, any>;
  spec: MarkSpec;
  create(attrs?: { [key: string]: any }): Mark;
  removeFromSet(set: Mark[]): Mark[];
  isInSet(set: Mark[]): Mark | null;
  excludes(type: MarkType): boolean;
}

export class Schema<N, M> {
  constructor(spec: SchemaSpec<N, M>);

  spec: SchemaSpec<N, M>;
  nodes: { [K in keyof N]: NodeType };
  marks: { [K in keyof M]: MarkType };
  cached: { [key: string]: any };
  topNodeType: NodeType;
  node(type: string | NodeType, attrs?: { [key: string]: any }, content?: Fragment | Node | Node[], marks?: Mark[]): Node;
  text(text: string, marks?: Mark[]): Node;
  mark(type: string | MarkType, attrs?: { [key: string]: any }): Mark;
  nodeFromJSON(json: { [key: string]: any }): Node;
  markFromJSON(json: { [key: string]: any }): Mark;
}

export interface SchemaSpec<N, M> {
  nodes: { [K in keyof N]: NodeSpec } | OrderedMap<NodeSpec>;
  marks?: { [K in keyof M]: MarkSpec } | OrderedMap<MarkSpec>;
  topNode?: string;
}