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

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

@@ -0,0 +1,214 @@
+import { Mark as ProseMirrorMark, Node as ProseMirrorNode, ParseOptions } from '@tiptap/pm/model';
+import { EditorState, Transaction } from '@tiptap/pm/state';
+import { Decoration, EditorProps, EditorView, NodeView } from '@tiptap/pm/view';
+import { Commands, ExtensionConfig, MarkConfig, NodeConfig } from '.';
+import { Editor } from './Editor';
+import { Extension } from './Extension';
+import { Mark } from './Mark';
+import { Node } from './Node';
+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;
+    };
+    create: {
+        editor: Editor;
+    };
+    update: {
+        editor: Editor;
+        transaction: Transaction;
+    };
+    selectionUpdate: {
+        editor: Editor;
+        transaction: Transaction;
+    };
+    transaction: {
+        editor: Editor;
+        transaction: Transaction;
+    };
+    focus: {
+        editor: Editor;
+        event: FocusEvent;
+        transaction: Transaction;
+    };
+    blur: {
+        editor: Editor;
+        event: FocusEvent;
+        transaction: Transaction;
+    };
+    destroy: void;
+}
+export declare type EnableRules = (AnyExtension | string)[] | boolean;
+export interface EditorOptions {
+    element: Element;
+    content: Content;
+    extensions: Extensions;
+    injectCSS: boolean;
+    injectNonce: string | undefined;
+    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;
+    commands: SingleCommands;
+    can: () => CanCommands;
+    chain: () => ChainedCommands;
+    state: EditorState;
+    view: EditorView;
+    dispatch: ((args?: any) => any) | undefined;
+};
+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: Record<string, any>) => Record<string, any> | null) | null;
+    parseHTML?: ((element: HTMLElement) => any | null) | null;
+    keepOnSplit: boolean;
+    isRequired?: boolean;
+};
+export declare type Attributes = {
+    [key: string]: Attribute;
+};
+export declare type ExtensionAttribute = {
+    type: string;
+    name: string;
+    attribute: Required<Attribute>;
+};
+export declare type GlobalAttributes = {
+    types: string[];
+    attributes: {
+        [key: string]: Attribute;
+    };
+}[];
+export declare type PickValue<T, K extends keyof T> = T[K];
+export declare type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
+export declare type Diff<T extends keyof any, U extends keyof any> = ({
+    [P in T]: P;
+} & {
+    [P in U]: never;
+} & {
+    [x: string]: never;
+})[T];
+export declare type Overwrite<T, U> = Pick<T, Diff<keyof T, keyof U>> & U;
+export declare type ValuesOf<T> = T[keyof T];
+export declare type KeysWithTypeOf<T, Type> = {
+    [P in keyof T]: T[P] extends Type ? P : never;
+}[keyof T];
+export declare type NodeViewProps = {
+    editor: Editor;
+    node: ProseMirrorNode;
+    decorations: Decoration[];
+    selected: boolean;
+    extension: Node;
+    getPos: () => number;
+    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: Record<string, any>;
+    decorations: Decoration[];
+    extension: Node;
+};
+export declare type NodeViewRenderer = (props: NodeViewRendererProps) => NodeView | {};
+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<Command>[Item];
+};
+export declare type SingleCommands = {
+    [Item in keyof UnionCommands]: UnionCommands<boolean>[Item];
+};
+export declare type ChainedCommands = {
+    [Item in keyof UnionCommands]: UnionCommands<ChainedCommands>[Item];
+} & {
+    run: () => boolean;
+};
+export declare type CanCommands = SingleCommands & {
+    chain: () => ChainedCommands;
+};
+export declare type FocusPosition = 'start' | 'end' | 'all' | number | boolean | null;
+export declare type Range = {
+    from: number;
+    to: number;
+};
+export declare type NodeRange = {
+    node: ProseMirrorNode;
+    from: number;
+    to: number;
+};
+export declare type MarkRange = {
+    mark: ProseMirrorMark;
+    from: number;
+    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;
+    range: Range;
+}) => string;
+export declare type ExtendedRegExpMatchArray = RegExpMatchArray & {
+    data?: Record<string, any>;
+};
+export declare type Dispatch = ((args?: any) => any) | undefined;

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

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

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

@@ -0,0 +1 @@
+export declare function createStyleTag(style: string, nonce?: string): HTMLStyleElement;

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

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

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

@@ -0,0 +1 @@
+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

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

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

@@ -0,0 +1,20 @@
+export * from './callOrReturn';
+export * from './createStyleTag';
+export * from './deleteProps';
+export * from './elementFromString';
+export * from './escapeForRegEx';
+export * from './findDuplicates';
+export * from './fromString';
+export * from './isEmptyObject';
+export * from './isFunction';
+export * from './isiOS';
+export * from './isMacOS';
+export * from './isNumber';
+export * from './isPlainObject';
+export * from './isRegExp';
+export * from './isString';
+export * from './mergeAttributes';
+export * from './mergeDeep';
+export * from './minMax';
+export * from './objectIncludes';
+export * from './removeDuplicates';

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

@@ -0,0 +1 @@
+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/isPlainObject.d.ts

@@ -0,0 +1 @@
+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/isString.d.ts

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

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

@@ -0,0 +1 @@
+export declare function mergeAttributes(...objects: Record<string, any>[]): Record<string, any>;

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

@@ -0,0 +1 @@
+export declare function mergeDeep(target: Record<string, any>, source: Record<string, any>): Record<string, any>;

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

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

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

@@ -0,0 +1,8 @@
+/**
+ * Check if object1 includes object2
+ * @param object1 Object
+ * @param object2 Object
+ */
+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[];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/core",
   "description": "headless rich text editor",
-  "version": "2.0.0-beta.213",
+  "version": "2.0.0-beta.215",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -18,14 +18,15 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./dist/packages/core/src/index.d.ts",
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     }
   },
   "main": "dist/index.cjs",
   "module": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "umd": "dist/index.umd.js",
+  "types": "dist/packages/core/src/index.d.ts",
   "files": [
     "src",
     "dist"
@@ -34,7 +35,7 @@
     "@tiptap/pm": "^2.0.0-beta.209"
   },
   "devDependencies": {
-    "@tiptap/pm": "^2.0.0-beta.213"
+    "@tiptap/pm": "^2.0.0-beta.215"
   },
   "repository": {
     "type": "git",
@@ -43,17 +44,7 @@
   },
   "sideEffects": false,
   "scripts": {
-    "build": "tsup"
-  },
-  "tsup": {
-    "entry": [
-      "src/index.ts"
-    ],
-    "dts": true,
-    "splitting": true,
-    "format": [
-      "esm",
-      "cjs"
-    ]
+    "clean": "rm -rf dist",
+    "build": "npm run clean && rollup -c"
   }
 }