@tiptap/core 2.0.0-beta.14 → 2.0.0-beta.140

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,28 +140,39 @@ 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;
 };
@@ -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 default function callOrReturn<T>(value: T, context?: any, ...props: any[]): MaybeReturnType<T>;

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 default function deleteProps(obj: Record<string, any>, propOrProps: string | string[]): Record<string, any>;

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

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

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

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

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

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

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

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

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

@@ -0,0 +1 @@
+export default 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 default 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 default function isPlainObject(value: any): value is Record<string, any>;

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

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

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

@@ -0,0 +1 @@
+export default 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 default 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 default function mergeDeep(target: Record<string, any>, source: Record<string, any>): Record<string, any>;

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 default function objectIncludes(object1: Record<string, any>, object2: Record<string, any>, options?: {
+    strict: boolean;
+}): boolean;