@tiptap/core 2.0.0-beta.17 → 2.0.0-beta.170

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

@@ -0,0 +1,14 @@
+import { InputRule, InputRuleFinder } from '../InputRule';
+import { NodeType } from 'prosemirror-model';
+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 { InputRule, InputRuleFinder } from '../InputRule';
+import { NodeType, Node as ProseMirrorNode } from 'prosemirror-model';
+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/markPasteRule.d.ts

@@ -1,3 +1,12 @@
-import { Plugin } from 'prosemirror-state';
+import { PasteRule, PasteRuleFinder } from '../PasteRule';
 import { MarkType } from 'prosemirror-model';
-export default function (regexp: RegExp, type: MarkType, getAttrs?: (match: any) => any): Plugin;
+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/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

@@ -1,2 +1 @@
-declare const style = ".ProseMirror {\n  position: relative;\n}\n\n.ProseMirror {\n  word-wrap: break-word;\n  white-space: pre-wrap;\n  -webkit-font-variant-ligatures: none;\n  font-variant-ligatures: none;\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\n.ProseMirror-gapcursor {\n  display: none;\n  pointer-events: none;\n  position: absolute;\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}";
-export default style;
+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}";

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

@@ -5,49 +5,84 @@ import { Extension } from './Extension';
 import { Node } from './Node';
 import { Mark } from './Mark';
 import { Editor } from './Editor';
-import { Commands } from '.';
-export declare type Extensions = (Extension | Node | Mark)[];
-export interface EditorOptions {
-    element: Element;
-    content: Content;
-    extensions: Extensions;
-    injectCSS: boolean;
-    autofocus: FocusPosition;
-    editable: boolean;
-    editorProps: EditorProps;
-    parseOptions: ParseOptions;
-    enableInputRules: boolean;
-    enablePasteRules: boolean;
-    onCreate: (props: {
+import { Commands, ExtensionConfig, NodeConfig, MarkConfig } from '.';
+export declare type AnyConfig = ExtensionConfig | NodeConfig | MarkConfig;
+export declare type AnyExtension = Extension | Node | Mark;
+export declare type Extensions = AnyExtension[];
+export declare type ParentConfig<T> = Partial<{
+    [P in keyof T]: Required<T>[P] extends (...args: any) => any ? (...args: Parameters<Required<T>[P]>) => ReturnType<Required<T>[P]> : T[P];
+}>;
+export declare type Primitive = null | undefined | string | number | boolean | symbol | bigint;
+export declare type RemoveThis<T> = T extends (...args: any) => any ? (...args: Parameters<T>) => ReturnType<T> : T;
+export declare type MaybeReturnType<T> = T extends (...args: any) => any ? ReturnType<T> : T;
+export declare type MaybeThisParameterType<T> = Exclude<T, Primitive> extends (...args: any) => any ? ThisParameterType<Exclude<T, Primitive>> : any;
+export interface EditorEvents {
+    beforeCreate: {
         editor: Editor;
-    }) => void;
-    onUpdate: (props: {
+    };
+    create: {
         editor: Editor;
-    }) => void;
-    onViewUpdate: (props: {
+    };
+    update: {
         editor: Editor;
-    }) => void;
-    onSelectionUpdate: (props: {
+        transaction: Transaction;
+    };
+    selectionUpdate: {
         editor: Editor;
-    }) => void;
-    onTransaction: (props: {
+        transaction: Transaction;
+    };
+    transaction: {
         editor: Editor;
         transaction: Transaction;
-    }) => void;
-    onFocus: (props: {
+    };
+    focus: {
         editor: Editor;
         event: FocusEvent;
-    }) => void;
-    onBlur: (props: {
+        transaction: Transaction;
+    };
+    blur: {
         editor: Editor;
         event: FocusEvent;
-    }) => void;
-    onResize: (props: {
-        editor: Editor;
-    }) => void;
-    onDestroy: () => void;
+        transaction: Transaction;
+    };
+    destroy: void;
 }
-export declare type Content = string | JSON | null;
+export declare type EnableRules = (AnyExtension | string)[] | boolean;
+export interface EditorOptions {
+    element: Element;
+    content: Content;
+    extensions: Extensions;
+    injectCSS: boolean;
+    autofocus: FocusPosition;
+    editable: boolean;
+    editorProps: EditorProps;
+    parseOptions: ParseOptions;
+    enableInputRules: EnableRules;
+    enablePasteRules: EnableRules;
+    enableCoreExtensions: boolean;
+    onBeforeCreate: (props: EditorEvents['beforeCreate']) => void;
+    onCreate: (props: EditorEvents['create']) => void;
+    onUpdate: (props: EditorEvents['update']) => void;
+    onSelectionUpdate: (props: EditorEvents['selectionUpdate']) => void;
+    onTransaction: (props: EditorEvents['transaction']) => void;
+    onFocus: (props: EditorEvents['focus']) => void;
+    onBlur: (props: EditorEvents['blur']) => void;
+    onDestroy: (props: EditorEvents['destroy']) => void;
+}
+export declare type HTMLContent = string;
+export declare type JSONContent = {
+    type?: string;
+    attrs?: Record<string, any>;
+    content?: JSONContent[];
+    marks?: {
+        type: string;
+        attrs?: Record<string, any>;
+        [key: string]: any;
+    }[];
+    text?: string;
+    [key: string]: any;
+};
+export declare type Content = HTMLContent | JSONContent | JSONContent[] | null;
 export declare type CommandProps = {
     editor: Editor;
     tr: Transaction;
@@ -60,17 +95,14 @@ export declare type CommandProps = {
 };
 export declare type Command = (props: CommandProps) => boolean;
 export declare type CommandSpec = (...args: any[]) => Command;
+export declare type KeyboardShortcutCommand = (props: {
+    editor: Editor;
+}) => boolean;
 export declare type Attribute = {
     default: any;
     rendered?: boolean;
-    renderHTML?: ((attributes: {
-        [key: string]: any;
-    }) => {
-        [key: string]: any;
-    } | null) | null;
-    parseHTML?: ((element: HTMLElement) => {
-        [key: string]: any;
-    } | null) | null;
+    renderHTML?: ((attributes: Record<string, any>) => Record<string, any> | null) | null;
+    parseHTML?: ((element: HTMLElement) => any | null) | null;
     keepOnSplit: boolean;
 };
 export declare type Attributes = {
@@ -97,9 +129,6 @@ export declare type Diff<T extends keyof any, U extends keyof any> = ({
     [x: string]: never;
 })[T];
 export declare type Overwrite<T, U> = Pick<T, Diff<keyof T, keyof U>> & U;
-export declare type AnyObject = {
-    [key: string]: any;
-};
 export declare type ValuesOf<T> = T[keyof T];
 export declare type KeysWithTypeOf<T, Type> = ({
     [P in keyof T]: T[P] extends Type ? P : never;
@@ -111,35 +140,46 @@ export declare type NodeViewProps = {
     selected: boolean;
     extension: Node;
     getPos: () => number;
-    updateAttributes: (attributes: AnyObject) => void;
+    updateAttributes: (attributes: Record<string, any>) => void;
+    deleteNode: () => void;
 };
+export interface NodeViewRendererOptions {
+    stopEvent: ((props: {
+        event: Event;
+    }) => boolean) | null;
+    ignoreMutation: ((props: {
+        mutation: MutationRecord | {
+            type: 'selection';
+            target: Element;
+        };
+    }) => boolean) | null;
+}
 export declare type NodeViewRendererProps = {
     editor: Editor;
     node: ProseMirrorNode;
     getPos: (() => number) | boolean;
-    HTMLAttributes: {
-        [key: string]: any;
-    };
+    HTMLAttributes: Record<string, any>;
     decorations: Decoration[];
     extension: Node;
 };
 export declare type NodeViewRenderer = (props: NodeViewRendererProps) => (NodeView | {});
-export declare type UnionCommands = UnionToIntersection<ValuesOf<Pick<Commands, KeysWithTypeOf<Commands, {}>>>>;
+export declare type AnyCommands = Record<string, (...args: any[]) => Command>;
+export declare type UnionCommands<T = Command> = UnionToIntersection<ValuesOf<Pick<Commands<T>, KeysWithTypeOf<Commands<T>, {}>>>>;
 export declare type RawCommands = {
-    [Item in keyof UnionCommands]: UnionCommands[Item] extends (...args: any[]) => any ? (...args: Parameters<UnionCommands[Item]>) => Command : never;
+    [Item in keyof UnionCommands]: UnionCommands<Command>[Item];
 };
 export declare type SingleCommands = {
-    [Item in keyof RawCommands]: RawCommands[Item] extends (...args: any[]) => any ? (...args: Parameters<RawCommands[Item]>) => boolean : never;
+    [Item in keyof UnionCommands]: UnionCommands<boolean>[Item];
 };
 export declare type ChainedCommands = {
-    [Item in keyof RawCommands]: RawCommands[Item] extends (...args: any[]) => any ? (...args: Parameters<RawCommands[Item]>) => ChainedCommands : never;
+    [Item in keyof UnionCommands]: UnionCommands<ChainedCommands>[Item];
 } & {
     run: () => boolean;
 };
 export declare type CanCommands = SingleCommands & {
     chain: () => ChainedCommands;
 };
-export declare type FocusPosition = 'start' | 'end' | number | boolean | null;
+export declare type FocusPosition = 'start' | 'end' | 'all' | number | boolean | null;
 export declare type Range = {
     from: number;
     to: number;
@@ -155,3 +195,16 @@ export declare type MarkRange = {
     to: number;
 };
 export declare type Predicate = (node: ProseMirrorNode) => boolean;
+export declare type NodeWithPos = {
+    node: ProseMirrorNode;
+    pos: number;
+};
+export declare type TextSerializer = (props: {
+    node: ProseMirrorNode;
+    pos: number;
+    parent: ProseMirrorNode;
+    index: number;
+}) => string;
+export declare type ExtendedRegExpMatchArray = RegExpMatchArray & {
+    data?: Record<string, any>;
+};

package/dist/packages/core/src/utilities/callOrReturn.d.ts

@@ -1,3 +1,4 @@
+import { MaybeReturnType } from '../types';
 /**
  * Optionally calls `value` as a function.
  * Otherwise it is returned directly.
@@ -5,4 +6,4 @@
  * @param context Optional context to bind to function.
  * @param props Optional props to pass to function.
  */
-export default function callOrReturn(value: any, context?: any, ...props: any[]): any;
+export declare function callOrReturn<T>(value: T, context?: any, ...props: any[]): MaybeReturnType<T>;

package/dist/packages/core/src/utilities/createStyleTag.d.ts

@@ -1 +1 @@
-export default function createStyleTag(style: string): HTMLStyleElement;
+export declare function createStyleTag(style: string): HTMLStyleElement;

package/dist/packages/core/src/utilities/deleteProps.d.ts

@@ -1,7 +1,6 @@
-import { AnyObject } from '../types';
 /**
  * Remove a property or an array of properties from an object
  * @param obj Object
  * @param key Key to remove
  */
-export default function deleteProps(obj: AnyObject, propOrProps: string | string[]): AnyObject;
+export declare function deleteProps(obj: Record<string, any>, propOrProps: string | string[]): Record<string, any>;

package/dist/packages/core/src/utilities/elementFromString.d.ts

@@ -1 +1 @@
-export default function elementFromString(value: string): HTMLElement;
+export declare function elementFromString(value: string): HTMLElement;

package/dist/packages/core/src/utilities/escapeForRegEx.d.ts

@@ -0,0 +1 @@
+export declare function escapeForRegEx(string: string): string;

package/dist/packages/core/src/utilities/findDuplicates.d.ts

@@ -0,0 +1 @@
+export declare function findDuplicates(items: any[]): any[];

package/dist/packages/core/src/utilities/fromString.d.ts

@@ -1 +1 @@
-export default function fromString(value: any): any;
+export declare function fromString(value: any): any;

package/dist/packages/core/src/utilities/isClass.d.ts

@@ -1 +1 @@
-export default function isClass(item: any): boolean;
+export declare function isClass(value: any): boolean;

package/dist/packages/core/src/utilities/isEmptyObject.d.ts

@@ -1 +1 @@
-export default function isEmptyObject(object?: {}): boolean;
+export declare function isEmptyObject(value?: {}): boolean;

package/dist/packages/core/src/utilities/isFunction.d.ts

@@ -0,0 +1 @@
+export declare function isFunction(value: any): value is Function;

package/dist/packages/core/src/utilities/isMacOS.d.ts

@@ -0,0 +1 @@
+export declare function isMacOS(): boolean;

package/dist/packages/core/src/utilities/isNumber.d.ts

@@ -0,0 +1 @@
+export declare function isNumber(value: any): value is number;

package/dist/packages/core/src/utilities/isObject.d.ts

@@ -1 +1 @@
-export default function isObject(item: any): boolean;
+export declare function isObject(value: any): boolean;

package/dist/packages/core/src/utilities/isPlainObject.d.ts

@@ -1 +1 @@
-export default function isPlainObject(payload: any): payload is Record<string, any>;
+export declare function isPlainObject(value: any): value is Record<string, any>;

package/dist/packages/core/src/utilities/isRegExp.d.ts

@@ -0,0 +1 @@
+export declare function isRegExp(value: any): value is RegExp;

package/dist/packages/core/src/utilities/isiOS.d.ts

@@ -0,0 +1 @@
+export declare function isiOS(): boolean;

package/dist/packages/core/src/utilities/mergeAttributes.d.ts

@@ -1,2 +1 @@
-import { AnyObject } from '../types';
-export default function mergeAttributes(...objects: AnyObject[]): AnyObject;
+export declare function mergeAttributes(...objects: Record<string, any>[]): Record<string, any>;

package/dist/packages/core/src/utilities/mergeDeep.d.ts

@@ -1,2 +1 @@
-import { AnyObject } from '../types';
-export default function mergeDeep(target: AnyObject, source: AnyObject): AnyObject;
+export declare function mergeDeep(target: Record<string, any>, source: Record<string, any>): Record<string, any>;

package/dist/packages/core/src/utilities/minMax.d.ts

@@ -1 +1 @@
-export default function minMax(value?: number, min?: number, max?: number): number;
+export declare function minMax(value?: number, min?: number, max?: number): number;

package/dist/packages/core/src/utilities/objectIncludes.d.ts

@@ -1,7 +1,8 @@
-import { AnyObject } from '../types';
 /**
  * Check if object1 includes object2
  * @param object1 Object
  * @param object2 Object
  */
-export default function objectIncludes(object1: AnyObject, object2: AnyObject): boolean;
+export declare function objectIncludes(object1: Record<string, any>, object2: Record<string, any>, options?: {
+    strict: boolean;
+}): boolean;

package/dist/packages/core/src/utilities/removeDuplicates.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Removes duplicated values within an array.
+ * Supports numbers, strings and objects.
+ */
+export declare function removeDuplicates<T>(array: T[], by?: {
+    (value: any, replacer?: ((this: any, key: string, value: any) => any) | undefined, space?: string | number | undefined): string;
+    (value: any, replacer?: (string | number)[] | null | undefined, space?: string | number | undefined): string;
+}): T[];