@atlaskit/adf-schema
Version:
Shared package that contains the ADF-schema (json) and ProseMirror node/mark specs
38 lines (37 loc) • 2.1 kB
TypeScript
import type { DOMOutputSpec, Node as PMNode, NodeSpec, Mark, MarkSpec } from '@atlaskit/editor-prosemirror/model';
export type NodeSpecOptions<N extends PMNode> = {
parseDOM?: NodeSpec['parseDOM'];
toDebugString?: () => string;
toDOM?: (node: N) => DOMOutputSpec;
};
export type NodeSpecFactory = typeof createPMNodeSpecFactory;
export type MarkSpecOptions<M extends Mark> = {
parseDOM?: MarkSpec['parseDOM'];
toDebugString?: () => string;
toDOM?: (mark: M, inline: boolean) => DOMOutputSpec;
};
export type MarkSpecFactory = typeof createPMMarkSpecFactory;
/** Result of calling {@link createPMMarkSpecFactory} with a concrete mark spec (for isolated declarations). */
export type PMMarkSpecFactoryInstance<M extends Omit<Mark, 'toDOM' | 'parseDOM'> = Mark> = (options: MarkSpecOptions<M>) => MarkSpec;
/** Result of calling {@link createPMNodeSpecFactory} with a concrete node spec (for isolated declarations). */
export type PMNodeSpecFactoryInstance<N extends Omit<PMNode, 'toDOM' | 'parseDOM'> = PMNode> = (options: NodeSpecOptions<N>) => NodeSpec;
/**
* Factory method to attach custom parseDOM and/or toDOM for nodeSpec
*
* @example
* createPMNodeSpecFactory<SomeNode>(node)({parseDOM: {}, toDOM: (node) => {} });
*
* @param nodeSpec - NodeSpec without toDom and parseDom
* @returns A function for a node which allows the consumer to define toDom and parseDom
*/
export declare const createPMNodeSpecFactory: <N extends Omit<PMNode, "toDOM" | "parseDOM">>(nodeSpec: NodeSpec) => ({ parseDOM, toDOM, toDebugString }: NodeSpecOptions<N>) => NodeSpec;
/**
* Factory method to attach custom parseDOM and/or toDOM for markSpec
*
* @example
* createPMMarkSpecFactory<SomeMark>(mark)({parseDOM: {}, toDOM: (mark, inline) => {} });
*
* @param markSpec - Markspec without toDom and parseDom
* @returns A function for a mark which allows the consumer to define toDom and parseDom
*/
export declare const createPMMarkSpecFactory: <M extends Omit<Mark, "toDOM" | "parseDOM">>(markSpec: MarkSpec) => ({ parseDOM, toDOM, toDebugString }: MarkSpecOptions<M>) => MarkSpec;