@tiptap/core 2.0.0-beta.213 → 2.0.0-beta.215

package/dist/packages/core/src/helpers/createChainableState.d.ts

@@ -0,0 +1,5 @@
+import { EditorState, Transaction } from '@tiptap/pm/state';
+export declare function createChainableState(config: {
+    transaction: Transaction;
+    state: EditorState;
+}): EditorState;

package/dist/packages/core/src/helpers/createDocument.d.ts

@@ -0,0 +1,3 @@
+import { Node as ProseMirrorNode, ParseOptions, Schema } from '@tiptap/pm/model';
+import { Content } from '../types';
+export declare function createDocument(content: Content, schema: Schema, parseOptions?: ParseOptions): ProseMirrorNode;

package/dist/packages/core/src/helpers/createNodeFromContent.d.ts

@@ -0,0 +1,7 @@
+import { Fragment, Node as ProseMirrorNode, ParseOptions, Schema } from '@tiptap/pm/model';
+import { Content } from '../types';
+export declare type CreateNodeFromContentOptions = {
+    slice?: boolean;
+    parseOptions?: ParseOptions;
+};
+export declare function createNodeFromContent(content: Content, schema: Schema, options?: CreateNodeFromContentOptions): ProseMirrorNode | Fragment;

package/dist/packages/core/src/helpers/defaultBlockAt.d.ts

@@ -0,0 +1,2 @@
+import { ContentMatch, NodeType } from '@tiptap/pm/model';
+export declare function defaultBlockAt(match: ContentMatch): NodeType | null;

package/dist/packages/core/src/helpers/findChildren.d.ts

@@ -0,0 +1,3 @@
+import { Node as ProseMirrorNode } from '@tiptap/pm/model';
+import { NodeWithPos, Predicate } from '../types';
+export declare function findChildren(node: ProseMirrorNode, predicate: Predicate): NodeWithPos[];

package/dist/packages/core/src/helpers/findChildrenInRange.d.ts

@@ -0,0 +1,6 @@
+import { Node as ProseMirrorNode } from '@tiptap/pm/model';
+import { NodeWithPos, Predicate, Range } from '../types';
+/**
+ * Same as `findChildren` but searches only within a `range`.
+ */
+export declare function findChildrenInRange(node: ProseMirrorNode, range: Range, predicate: Predicate): NodeWithPos[];

package/dist/packages/core/src/helpers/findParentNode.d.ts

@@ -0,0 +1,8 @@
+import { Selection } from '@tiptap/pm/state';
+import { Predicate } from '../types';
+export declare function findParentNode(predicate: Predicate): (selection: Selection) => {
+    pos: number;
+    start: number;
+    depth: number;
+    node: import("prosemirror-model").Node;
+} | undefined;

package/dist/packages/core/src/helpers/findParentNodeClosestToPos.d.ts

@@ -0,0 +1,8 @@
+import { Node as ProseMirrorNode, ResolvedPos } from '@tiptap/pm/model';
+import { Predicate } from '../types';
+export declare function findParentNodeClosestToPos($pos: ResolvedPos, predicate: Predicate): {
+    pos: number;
+    start: number;
+    depth: number;
+    node: ProseMirrorNode;
+} | undefined;

package/dist/packages/core/src/helpers/generateHTML.d.ts

@@ -0,0 +1,2 @@
+import { Extensions, JSONContent } from '../types';
+export declare function generateHTML(doc: JSONContent, extensions: Extensions): string;

package/dist/packages/core/src/helpers/generateJSON.d.ts

@@ -0,0 +1,2 @@
+import { Extensions } from '../types';
+export declare function generateJSON(html: string, extensions: Extensions): Record<string, any>;

package/dist/packages/core/src/helpers/generateText.d.ts

@@ -0,0 +1,5 @@
+import { Extensions, JSONContent, TextSerializer } from '../types';
+export declare function generateText(doc: JSONContent, extensions: Extensions, options?: {
+    blockSeparator?: string;
+    textSerializers?: Record<string, TextSerializer>;
+}): string;

package/dist/packages/core/src/helpers/getAttributes.d.ts

@@ -0,0 +1,3 @@
+import { MarkType, NodeType } from '@tiptap/pm/model';
+import { EditorState } from '@tiptap/pm/state';
+export declare function getAttributes(state: EditorState, typeOrName: string | NodeType | MarkType): Record<string, any>;

package/dist/packages/core/src/helpers/getAttributesFromExtensions.d.ts

@@ -0,0 +1,6 @@
+import { ExtensionAttribute, Extensions } from '../types';
+/**
+ * Get a list of all extension attributes defined in `addAttribute` and `addGlobalAttribute`.
+ * @param extensions List of extensions
+ */
+export declare function getAttributesFromExtensions(extensions: Extensions): ExtensionAttribute[];

package/dist/packages/core/src/helpers/getChangedRanges.d.ts

@@ -0,0 +1,11 @@
+import { Transform } from '@tiptap/pm/transform';
+import { Range } from '../types';
+export declare type ChangedRange = {
+    oldRange: Range;
+    newRange: Range;
+};
+/**
+ * Returns a list of changed ranges
+ * based on the first and last state of all steps.
+ */
+export declare function getChangedRanges(transform: Transform): ChangedRange[];

package/dist/packages/core/src/helpers/getDebugJSON.d.ts

@@ -0,0 +1,8 @@
+import { Node as ProseMirrorNode } from '@tiptap/pm/model';
+import { JSONContent } from '../types';
+interface DebugJSONContent extends JSONContent {
+    from: number;
+    to: number;
+}
+export declare function getDebugJSON(node: ProseMirrorNode, startOffset?: number): DebugJSONContent;
+export {};

package/dist/packages/core/src/helpers/getExtensionField.d.ts

@@ -0,0 +1,2 @@
+import { AnyExtension, MaybeThisParameterType, RemoveThis } from '../types';
+export declare function getExtensionField<T = any>(extension: AnyExtension, field: string, context?: Omit<MaybeThisParameterType<T>, 'parent'>): RemoveThis<T>;

package/dist/packages/core/src/helpers/getHTMLFromFragment.d.ts

@@ -0,0 +1,2 @@
+import { Fragment, Schema } from '@tiptap/pm/model';
+export declare function getHTMLFromFragment(fragment: Fragment, schema: Schema): string;

package/dist/packages/core/src/helpers/getMarkAttributes.d.ts

@@ -0,0 +1,3 @@
+import { MarkType } from '@tiptap/pm/model';
+import { EditorState } from '@tiptap/pm/state';
+export declare function getMarkAttributes(state: EditorState, typeOrName: string | MarkType): Record<string, any>;

package/dist/packages/core/src/helpers/getMarkRange.d.ts

@@ -0,0 +1,3 @@
+import { MarkType, ResolvedPos } from '@tiptap/pm/model';
+import { Range } from '../types';
+export declare function getMarkRange($pos: ResolvedPos, type: MarkType, attributes?: Record<string, any>): Range | void;

package/dist/packages/core/src/helpers/getMarkType.d.ts

@@ -0,0 +1,2 @@
+import { MarkType, Schema } from '@tiptap/pm/model';
+export declare function getMarkType(nameOrType: string | MarkType, schema: Schema): MarkType;

package/dist/packages/core/src/helpers/getMarksBetween.d.ts

@@ -0,0 +1,3 @@
+import { Node as ProseMirrorNode } from '@tiptap/pm/model';
+import { MarkRange } from '../types';
+export declare function getMarksBetween(from: number, to: number, doc: ProseMirrorNode): MarkRange[];

package/dist/packages/core/src/helpers/getNodeAttributes.d.ts

@@ -0,0 +1,3 @@
+import { NodeType } from '@tiptap/pm/model';
+import { EditorState } from '@tiptap/pm/state';
+export declare function getNodeAttributes(state: EditorState, typeOrName: string | NodeType): Record<string, any>;

package/dist/packages/core/src/helpers/getNodeType.d.ts

@@ -0,0 +1,2 @@
+import { NodeType, Schema } from '@tiptap/pm/model';
+export declare function getNodeType(nameOrType: string | NodeType, schema: Schema): NodeType;

package/dist/packages/core/src/helpers/getRenderedAttributes.d.ts

@@ -0,0 +1,3 @@
+import { Mark, Node } from '@tiptap/pm/model';
+import { ExtensionAttribute } from '../types';
+export declare function getRenderedAttributes(nodeOrMark: Node | Mark, extensionAttributes: ExtensionAttribute[]): Record<string, any>;

package/dist/packages/core/src/helpers/getSchema.d.ts

@@ -0,0 +1,3 @@
+import { Schema } from '@tiptap/pm/model';
+import { Extensions } from '../types';
+export declare function getSchema(extensions: Extensions): Schema;

package/dist/packages/core/src/helpers/getSchemaByResolvedExtensions.d.ts

@@ -0,0 +1,3 @@
+import { Schema } from '@tiptap/pm/model';
+import { Extensions } from '../types';
+export declare function getSchemaByResolvedExtensions(extensions: Extensions): Schema;

package/dist/packages/core/src/helpers/getSchemaTypeByName.d.ts

@@ -0,0 +1,2 @@
+import { MarkType, NodeType, Schema } from '@tiptap/pm/model';
+export declare function getSchemaTypeByName(name: string, schema: Schema): NodeType | MarkType | null;

package/dist/packages/core/src/helpers/getSchemaTypeNameByName.d.ts

@@ -0,0 +1,2 @@
+import { Schema } from '@tiptap/pm/model';
+export declare function getSchemaTypeNameByName(name: string, schema: Schema): 'node' | 'mark' | null;

package/dist/packages/core/src/helpers/getSplittedAttributes.d.ts

@@ -0,0 +1,2 @@
+import { ExtensionAttribute } from '../types';
+export declare function getSplittedAttributes(extensionAttributes: ExtensionAttribute[], typeName: string, attributes: Record<string, any>): Record<string, any>;

package/dist/packages/core/src/helpers/getText.d.ts

@@ -0,0 +1,6 @@
+import { Node as ProseMirrorNode } from '@tiptap/pm/model';
+import { TextSerializer } from '../types';
+export declare function getText(node: ProseMirrorNode, options?: {
+    blockSeparator?: string;
+    textSerializers?: Record<string, TextSerializer>;
+}): string;

package/dist/packages/core/src/helpers/getTextBetween.d.ts

@@ -0,0 +1,6 @@
+import { Node as ProseMirrorNode } from '@tiptap/pm/model';
+import { Range, TextSerializer } from '../types';
+export declare function getTextBetween(startNode: ProseMirrorNode, range: Range, options?: {
+    blockSeparator?: string;
+    textSerializers?: Record<string, TextSerializer>;
+}): string;

package/dist/packages/core/src/helpers/getTextContentFromNodes.d.ts

@@ -0,0 +1,2 @@
+import { ResolvedPos } from '@tiptap/pm/model';
+export declare const getTextContentFromNodes: ($from: ResolvedPos, maxMatch?: number) => string;

package/dist/packages/core/src/helpers/getTextSerializersFromSchema.d.ts

@@ -0,0 +1,3 @@
+import { Schema } from '@tiptap/pm/model';
+import { TextSerializer } from '../types';
+export declare function getTextSerializersFromSchema(schema: Schema): Record<string, TextSerializer>;

package/dist/packages/core/src/helpers/index.d.ts

@@ -0,0 +1,33 @@
+export * from './combineTransactionSteps';
+export * from './defaultBlockAt';
+export * from './findChildren';
+export * from './findChildrenInRange';
+export * from './findParentNode';
+export * from './findParentNodeClosestToPos';
+export * from './generateHTML';
+export * from './generateJSON';
+export * from './generateText';
+export * from './getAttributes';
+export * from './getChangedRanges';
+export * from './getDebugJSON';
+export * from './getExtensionField';
+export * from './getHTMLFromFragment';
+export * from './getMarkAttributes';
+export * from './getMarkRange';
+export * from './getMarksBetween';
+export * from './getMarkType';
+export * from './getNodeAttributes';
+export * from './getNodeType';
+export * from './getSchema';
+export * from './getText';
+export * from './getTextBetween';
+export * from './getTextContentFromNodes';
+export * from './getTextSerializersFromSchema';
+export * from './isActive';
+export * from './isList';
+export * from './isMarkActive';
+export * from './isNodeActive';
+export * from './isNodeEmpty';
+export * from './isNodeSelection';
+export * from './isTextSelection';
+export * from './posToDOMRect';

package/dist/packages/core/src/helpers/injectExtensionAttributesToParseRule.d.ts

@@ -0,0 +1,9 @@
+import { ParseRule } from '@tiptap/pm/model';
+import { ExtensionAttribute } from '../types';
+/**
+ * This function merges extension attributes into parserule attributes (`attrs` or `getAttrs`).
+ * Cancels when `getAttrs` returned `false`.
+ * @param parseRule ProseMirror ParseRule
+ * @param extensionAttributes List of attributes to inject
+ */
+export declare function injectExtensionAttributesToParseRule(parseRule: ParseRule, extensionAttributes: ExtensionAttribute[]): ParseRule;

package/dist/packages/core/src/helpers/isActive.d.ts

@@ -0,0 +1,2 @@
+import { EditorState } from '@tiptap/pm/state';
+export declare function isActive(state: EditorState, name: string | null, attributes?: Record<string, any>): boolean;

package/dist/packages/core/src/helpers/isExtensionRulesEnabled.d.ts

@@ -0,0 +1,2 @@
+import { AnyExtension, EnableRules } from '../types';
+export declare function isExtensionRulesEnabled(extension: AnyExtension, enabled: EnableRules): boolean;

package/dist/packages/core/src/helpers/isList.d.ts

@@ -0,0 +1,2 @@
+import { Extensions } from '../types';
+export declare function isList(name: string, extensions: Extensions): boolean;

package/dist/packages/core/src/helpers/isMarkActive.d.ts

@@ -0,0 +1,3 @@
+import { MarkType } from '@tiptap/pm/model';
+import { EditorState } from '@tiptap/pm/state';
+export declare function isMarkActive(state: EditorState, typeOrName: MarkType | string | null, attributes?: Record<string, any>): boolean;

package/dist/packages/core/src/helpers/isNodeActive.d.ts

@@ -0,0 +1,3 @@
+import { NodeType } from '@tiptap/pm/model';
+import { EditorState } from '@tiptap/pm/state';
+export declare function isNodeActive(state: EditorState, typeOrName: NodeType | string | null, attributes?: Record<string, any>): boolean;

package/dist/packages/core/src/helpers/isNodeEmpty.d.ts

@@ -0,0 +1,2 @@
+import { Node as ProseMirrorNode } from '@tiptap/pm/model';
+export declare function isNodeEmpty(node: ProseMirrorNode): boolean;

package/dist/packages/core/src/helpers/isNodeSelection.d.ts

@@ -0,0 +1,2 @@
+import { NodeSelection } from '@tiptap/pm/state';
+export declare function isNodeSelection(value: unknown): value is NodeSelection;

package/dist/packages/core/src/helpers/isTextSelection.d.ts

@@ -0,0 +1,2 @@
+import { TextSelection } from '@tiptap/pm/state';
+export declare function isTextSelection(value: unknown): value is TextSelection;

package/dist/packages/core/src/helpers/posToDOMRect.d.ts

@@ -0,0 +1,2 @@
+import { EditorView } from '@tiptap/pm/view';
+export declare function posToDOMRect(view: EditorView, from: number, to: number): DOMRect;

package/dist/packages/core/src/helpers/resolveFocusPosition.d.ts

@@ -0,0 +1,4 @@
+import { Node as ProseMirrorNode } from '@tiptap/pm/model';
+import { Selection } from '@tiptap/pm/state';
+import { FocusPosition } from '../types';
+export declare function resolveFocusPosition(doc: ProseMirrorNode, position?: FocusPosition): Selection | null;

package/dist/packages/core/src/helpers/selectionToInsertionEnd.d.ts

@@ -0,0 +1,2 @@
+import { Transaction } from '@tiptap/pm/state';
+export declare function selectionToInsertionEnd(tr: Transaction, startLen: number, bias: number): void;

package/dist/packages/core/src/helpers/splitExtensions.d.ts

@@ -0,0 +1,9 @@
+import { Extension } from '../Extension';
+import { Mark } from '../Mark';
+import { Node } from '../Node';
+import { Extensions } from '../types';
+export declare function splitExtensions(extensions: Extensions): {
+    baseExtensions: Extension<any, any>[];
+    nodeExtensions: Node<any, any>[];
+    markExtensions: Mark<any, any>[];
+};

package/dist/packages/core/src/index.d.ts

@@ -0,0 +1,23 @@
+export * from './CommandManager';
+export * from './Editor';
+export * from './Extension';
+export * as extensions from './extensions';
+export * from './helpers';
+export * from './InputRule';
+export * from './inputRules';
+export * from './Mark';
+export * from './Node';
+export * from './NodeView';
+export * from './PasteRule';
+export * from './pasteRules';
+export * from './Tracker';
+export * from './types';
+export * from './utilities';
+export interface Commands<ReturnType = any> {
+}
+export interface ExtensionConfig<Options = any, Storage = any> {
+}
+export interface NodeConfig<Options = any, Storage = any> {
+}
+export interface MarkConfig<Options = any, Storage = any> {
+}

package/dist/packages/core/src/inputRules/index.d.ts

@@ -0,0 +1,5 @@
+export * from './markInputRule';
+export * from './nodeInputRule';
+export * from './textblockTypeInputRule';
+export * from './textInputRule';
+export * from './wrappingInputRule';

package/dist/packages/core/src/inputRules/markInputRule.d.ts

@@ -0,0 +1,12 @@
+import { MarkType } from '@tiptap/pm/model';
+import { InputRule, InputRuleFinder } from '../InputRule';
+import { ExtendedRegExpMatchArray } from '../types';
+/**
+ * Build an input rule that adds a mark when the
+ * matched text is typed into it.
+ */
+export declare function markInputRule(config: {
+    find: InputRuleFinder;
+    type: MarkType;
+    getAttributes?: Record<string, any> | ((match: ExtendedRegExpMatchArray) => Record<string, any>) | false | null;
+}): InputRule;

package/dist/packages/core/src/inputRules/nodeInputRule.d.ts

@@ -0,0 +1,12 @@
+import { NodeType } from '@tiptap/pm/model';
+import { InputRule, InputRuleFinder } from '../InputRule';
+import { ExtendedRegExpMatchArray } from '../types';
+/**
+ * Build an input rule that adds a node when the
+ * matched text is typed into it.
+ */
+export declare function nodeInputRule(config: {
+    find: InputRuleFinder;
+    type: NodeType;
+    getAttributes?: Record<string, any> | ((match: ExtendedRegExpMatchArray) => Record<string, any>) | false | null;
+}): InputRule;

package/dist/packages/core/src/inputRules/textInputRule.d.ts

@@ -0,0 +1,9 @@
+import { InputRule, InputRuleFinder } from '../InputRule';
+/**
+ * Build an input rule that replaces text when the
+ * matched text is typed into it.
+ */
+export declare function textInputRule(config: {
+    find: InputRuleFinder;
+    replace: string;
+}): InputRule;

package/dist/packages/core/src/inputRules/textblockTypeInputRule.d.ts

@@ -0,0 +1,14 @@
+import { NodeType } from '@tiptap/pm/model';
+import { InputRule, InputRuleFinder } from '../InputRule';
+import { ExtendedRegExpMatchArray } from '../types';
+/**
+ * Build an input rule that changes the type of a textblock when the
+ * matched text is typed into it. When using a regular expresion you’ll
+ * probably want the regexp to start with `^`, so that the pattern can
+ * only occur at the start of a textblock.
+ */
+export declare function textblockTypeInputRule(config: {
+    find: InputRuleFinder;
+    type: NodeType;
+    getAttributes?: Record<string, any> | ((match: ExtendedRegExpMatchArray) => Record<string, any>) | false | null;
+}): InputRule;

package/dist/packages/core/src/inputRules/wrappingInputRule.d.ts

@@ -0,0 +1,23 @@
+import { Node as ProseMirrorNode, NodeType } from '@tiptap/pm/model';
+import { InputRule, InputRuleFinder } from '../InputRule';
+import { ExtendedRegExpMatchArray } from '../types';
+/**
+ * Build an input rule for automatically wrapping a textblock when a
+ * given string is typed. When using a regular expresion you’ll
+ * probably want the regexp to start with `^`, so that the pattern can
+ * only occur at the start of a textblock.
+ *
+ * `type` is the type of node to wrap in.
+ *
+ * By default, if there’s a node with the same type above the newly
+ * wrapped node, the rule will try to join those
+ * two nodes. You can pass a join predicate, which takes a regular
+ * expression match and the node before the wrapped node, and can
+ * return a boolean to indicate whether a join should happen.
+ */
+export declare function wrappingInputRule(config: {
+    find: InputRuleFinder;
+    type: NodeType;
+    getAttributes?: Record<string, any> | ((match: ExtendedRegExpMatchArray) => Record<string, any>) | false | null;
+    joinPredicate?: (match: ExtendedRegExpMatchArray, node: ProseMirrorNode) => boolean;
+}): InputRule;

package/dist/packages/core/src/pasteRules/index.d.ts

@@ -0,0 +1,3 @@
+export * from './markPasteRule';
+export * from './nodePasteRule';
+export * from './textPasteRule';

package/dist/packages/core/src/pasteRules/markPasteRule.d.ts

@@ -0,0 +1,12 @@
+import { MarkType } from '@tiptap/pm/model';
+import { PasteRule, PasteRuleFinder } from '../PasteRule';
+import { ExtendedRegExpMatchArray } from '../types';
+/**
+ * Build an paste rule that adds a mark when the
+ * matched text is pasted into it.
+ */
+export declare function markPasteRule(config: {
+    find: PasteRuleFinder;
+    type: MarkType;
+    getAttributes?: Record<string, any> | ((match: ExtendedRegExpMatchArray) => Record<string, any>) | false | null;
+}): PasteRule;

package/dist/packages/core/src/pasteRules/nodePasteRule.d.ts

@@ -0,0 +1,12 @@
+import { NodeType } from '@tiptap/pm/model';
+import { PasteRule } from '../PasteRule';
+import { ExtendedRegExpMatchArray } from '../types';
+/**
+ * Build an paste rule that adds a node when the
+ * matched text is pasted into it.
+ */
+export declare function nodePasteRule(config: {
+    find: RegExp;
+    type: NodeType;
+    getAttributes?: Record<string, any> | ((match: ExtendedRegExpMatchArray) => Record<string, any>) | false | null;
+}): PasteRule;

package/dist/packages/core/src/pasteRules/textPasteRule.d.ts

@@ -0,0 +1,9 @@
+import { PasteRule, PasteRuleFinder } from '../PasteRule';
+/**
+ * Build an paste rule that replaces text when the
+ * matched text is pasted into it.
+ */
+export declare function textPasteRule(config: {
+    find: PasteRuleFinder;
+    replace: string;
+}): PasteRule;

package/dist/packages/core/src/style.d.ts

@@ -0,0 +1 @@
+export declare const style = ".ProseMirror {\n  position: relative;\n}\n\n.ProseMirror {\n  word-wrap: break-word;\n  white-space: pre-wrap;\n  white-space: break-spaces;\n  -webkit-font-variant-ligatures: none;\n  font-variant-ligatures: none;\n  font-feature-settings: \"liga\" 0; /* the above doesn't seem to work in Edge */\n}\n\n.ProseMirror [contenteditable=\"false\"] {\n  white-space: normal;\n}\n\n.ProseMirror [contenteditable=\"false\"] [contenteditable=\"true\"] {\n  white-space: pre-wrap;\n}\n\n.ProseMirror pre {\n  white-space: pre-wrap;\n}\n\nimg.ProseMirror-separator {\n  display: inline !important;\n  border: none !important;\n  margin: 0 !important;\n  width: 1px !important;\n  height: 1px !important;\n}\n\n.ProseMirror-gapcursor {\n  display: none;\n  pointer-events: none;\n  position: absolute;\n  margin: 0;\n}\n\n.ProseMirror-gapcursor:after {\n  content: \"\";\n  display: block;\n  position: absolute;\n  top: -2px;\n  width: 20px;\n  border-top: 1px solid black;\n  animation: ProseMirror-cursor-blink 1.1s steps(2, start) infinite;\n}\n\n@keyframes ProseMirror-cursor-blink {\n  to {\n    visibility: hidden;\n  }\n}\n\n.ProseMirror-hideselection *::selection {\n  background: transparent;\n}\n\n.ProseMirror-hideselection *::-moz-selection {\n  background: transparent;\n}\n\n.ProseMirror-hideselection * {\n  caret-color: transparent;\n}\n\n.ProseMirror-focused .ProseMirror-gapcursor {\n  display: block;\n}\n\n.tippy-box[data-animation=fade][data-state=hidden] {\n  opacity: 0\n}";