@tiptap/extension-character-count 3.0.0 → 3.0.1

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

@@ -1,255 +0,0 @@
-import { Mark as ProseMirrorMark, Node as ProseMirrorNode, NodeType, ParseOptions } from '@tiptap/pm/model';
-import { EditorState, Transaction } from '@tiptap/pm/state';
-import { Decoration, EditorProps, EditorView, NodeView } from '@tiptap/pm/view';
-import { Editor } from './Editor.js';
-import { Extension } from './Extension.js';
-import { Commands, ExtensionConfig, MarkConfig, NodeConfig } from './index.js';
-import { Mark } from './Mark.js';
-import { Node } from './Node.js';
-export type AnyConfig = ExtensionConfig | NodeConfig | MarkConfig;
-export type AnyExtension = Extension | Node | Mark;
-export type Extensions = AnyExtension[];
-export 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 type Primitive = null | undefined | string | number | boolean | symbol | bigint;
-export type RemoveThis<T> = T extends (...args: any) => any ? (...args: Parameters<T>) => ReturnType<T> : T;
-export type MaybeReturnType<T> = T extends (...args: any) => any ? ReturnType<T> : T;
-export type MaybeThisParameterType<T> = Exclude<T, Primitive> extends (...args: any) => any ? ThisParameterType<Exclude<T, Primitive>> : any;
-export interface EditorEvents {
-    beforeCreate: {
-        editor: Editor;
-    };
-    create: {
-        editor: Editor;
-    };
-    contentError: {
-        editor: Editor;
-        error: Error;
-        /**
-         * If called, will re-initialize the editor with the collaboration extension removed.
-         * This will prevent syncing back deletions of content not present in the current schema.
-         */
-        disableCollaboration: () => void;
-    };
-    update: {
-        editor: Editor;
-        transaction: Transaction;
-    };
-    selectionUpdate: {
-        editor: Editor;
-        transaction: Transaction;
-    };
-    beforeTransaction: {
-        editor: Editor;
-        transaction: Transaction;
-        nextState: EditorState;
-    };
-    transaction: {
-        editor: Editor;
-        transaction: Transaction;
-    };
-    focus: {
-        editor: Editor;
-        event: FocusEvent;
-        transaction: Transaction;
-    };
-    blur: {
-        editor: Editor;
-        event: FocusEvent;
-        transaction: Transaction;
-    };
-    destroy: void;
-}
-export 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;
-    coreExtensionOptions?: {
-        clipboardTextSerializer?: {
-            blockSeparator?: string;
-        };
-    };
-    enableInputRules: EnableRules;
-    enablePasteRules: EnableRules;
-    enableCoreExtensions: boolean;
-    /**
-     * If `true`, the editor will check the content for errors on initialization.
-     * Emitting the `contentError` event if the content is invalid.
-     * Which can be used to show a warning or error message to the user.
-     * @default false
-     */
-    enableContentCheck: boolean;
-    onBeforeCreate: (props: EditorEvents['beforeCreate']) => void;
-    onCreate: (props: EditorEvents['create']) => void;
-    /**
-     * Called when the editor encounters an error while parsing the content.
-     * Only enabled if `enableContentCheck` is `true`.
-     */
-    onContentError: (props: EditorEvents['contentError']) => 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 type HTMLContent = string;
-export 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 type Content = HTMLContent | JSONContent | JSONContent[] | null;
-export type CommandProps = {
-    editor: Editor;
-    tr: Transaction;
-    commands: SingleCommands;
-    can: () => CanCommands;
-    chain: () => ChainedCommands;
-    state: EditorState;
-    view: EditorView;
-    dispatch: ((args?: any) => any) | undefined;
-};
-export type Command = (props: CommandProps) => boolean;
-export type CommandSpec = (...args: any[]) => Command;
-export type KeyboardShortcutCommand = (props: {
-    editor: Editor;
-}) => boolean;
-export 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 type Attributes = {
-    [key: string]: Attribute;
-};
-export type ExtensionAttribute = {
-    type: string;
-    name: string;
-    attribute: Required<Attribute>;
-};
-export type GlobalAttributes = {
-    /**
-     * The node & mark types this attribute should be applied to.
-     */
-    types: string[];
-    /**
-     * The attributes to add to the node or mark types.
-     */
-    attributes: {
-        [key: string]: Attribute;
-    };
-}[];
-export type PickValue<T, K extends keyof T> = T[K];
-export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
-export type Diff<T extends keyof any, U extends keyof any> = ({
-    [P in T]: P;
-} & {
-    [P in U]: never;
-} & {
-    [x: string]: never;
-})[T];
-export type Overwrite<T, U> = Pick<T, Diff<keyof T, keyof U>> & U;
-export type ValuesOf<T> = T[keyof T];
-export type KeysWithTypeOf<T, Type> = {
-    [P in keyof T]: T[P] extends Type ? P : never;
-}[keyof T];
-export type DecorationWithType = Decoration & {
-    type: NodeType;
-};
-export type NodeViewProps = {
-    editor: Editor;
-    node: ProseMirrorNode;
-    decorations: DecorationWithType[];
-    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;
-    contentDOMElementTag: string;
-}
-export type NodeViewRendererProps = {
-    editor: Editor;
-    node: ProseMirrorNode;
-    getPos: (() => number) | boolean;
-    HTMLAttributes: Record<string, any>;
-    decorations: Decoration[];
-    extension: Node;
-};
-export type NodeViewRenderer = (props: NodeViewRendererProps) => NodeView | {};
-export type AnyCommands = Record<string, (...args: any[]) => Command>;
-export type UnionCommands<T = Command> = UnionToIntersection<ValuesOf<Pick<Commands<T>, KeysWithTypeOf<Commands<T>, {}>>>>;
-export type RawCommands = {
-    [Item in keyof UnionCommands]: UnionCommands<Command>[Item];
-};
-export type SingleCommands = {
-    [Item in keyof UnionCommands]: UnionCommands<boolean>[Item];
-};
-export type ChainedCommands = {
-    [Item in keyof UnionCommands]: UnionCommands<ChainedCommands>[Item];
-} & {
-    run: () => boolean;
-};
-export type CanCommands = SingleCommands & {
-    chain: () => ChainedCommands;
-};
-export type FocusPosition = 'start' | 'end' | 'all' | number | boolean | null;
-export type Range = {
-    from: number;
-    to: number;
-};
-export type NodeRange = {
-    node: ProseMirrorNode;
-    from: number;
-    to: number;
-};
-export type MarkRange = {
-    mark: ProseMirrorMark;
-    from: number;
-    to: number;
-};
-export type Predicate = (node: ProseMirrorNode) => boolean;
-export type NodeWithPos = {
-    node: ProseMirrorNode;
-    pos: number;
-};
-export type TextSerializer = (props: {
-    node: ProseMirrorNode;
-    pos: number;
-    parent: ProseMirrorNode;
-    index: number;
-    range: Range;
-}) => string;
-export type ExtendedRegExpMatchArray = RegExpMatchArray & {
-    data?: Record<string, any>;
-};
-export type Dispatch = ((args?: any) => any) | undefined;

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

@@ -1,9 +0,0 @@
-import { MaybeReturnType } from '../types.js';
-/**
- * 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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1 +0,0 @@
-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 +0,0 @@
-export declare function minMax(value?: number, min?: number, max?: number): number;

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

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

@@ -1,8 +0,0 @@
-/**
- * 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, space?: string | number): string;
-    (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
-}): T[];

package/dist/packages/extension-character-count/src/character-count.d.ts

@@ -1,42 +0,0 @@
-import { Extension } from '@tiptap/core';
-import { Node as ProseMirrorNode } from '@tiptap/pm/model';
-export interface CharacterCountOptions {
-    /**
-     * The maximum number of characters that should be allowed. Defaults to `0`.
-     * @default null
-     * @example 180
-     */
-    limit: number | null | undefined;
-    /**
-     * The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.
-     * If set to `nodeSize`, the nodeSize of the document is used.
-     * @default 'textSize'
-     * @example 'textSize'
-     */
-    mode: 'textSize' | 'nodeSize';
-}
-export interface CharacterCountStorage {
-    /**
-     * Get the number of characters for the current document.
-     * @param options The options for the character count. (optional)
-     * @param options.node The node to get the characters from. Defaults to the current document.
-     * @param options.mode The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.
-     */
-    characters: (options?: {
-        node?: ProseMirrorNode;
-        mode?: 'textSize' | 'nodeSize';
-    }) => number;
-    /**
-     * Get the number of words for the current document.
-     * @param options The options for the character count. (optional)
-     * @param options.node The node to get the words from. Defaults to the current document.
-     */
-    words: (options?: {
-        node?: ProseMirrorNode;
-    }) => number;
-}
-/**
- * This extension allows you to count the characters and words of your document.
- * @see https://tiptap.dev/api/extensions/character-count
- */
-export declare const CharacterCount: Extension<CharacterCountOptions, CharacterCountStorage>;

package/dist/packages/extension-character-count/src/index.d.ts

@@ -1,3 +0,0 @@
-import { CharacterCount } from './character-count.js';
-export * from './character-count.js';
-export default CharacterCount;

package/src/character-count.ts

@@ -1,144 +0,0 @@
-import { Extension } from '@tiptap/core'
-import { Node as ProseMirrorNode } from '@tiptap/pm/model'
-import { Plugin, PluginKey } from '@tiptap/pm/state'
-
-export interface CharacterCountOptions {
-  /**
-   * The maximum number of characters that should be allowed. Defaults to `0`.
-   * @default null
-   * @example 180
-   */
-  limit: number | null | undefined
-  /**
-   * The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.
-   * If set to `nodeSize`, the nodeSize of the document is used.
-   * @default 'textSize'
-   * @example 'textSize'
-   */
-  mode: 'textSize' | 'nodeSize'
-}
-
-export interface CharacterCountStorage {
-  /**
-   * Get the number of characters for the current document.
-   * @param options The options for the character count. (optional)
-   * @param options.node The node to get the characters from. Defaults to the current document.
-   * @param options.mode The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.
-   */
-  characters: (options?: { node?: ProseMirrorNode; mode?: 'textSize' | 'nodeSize' }) => number
-
-  /**
-   * Get the number of words for the current document.
-   * @param options The options for the character count. (optional)
-   * @param options.node The node to get the words from. Defaults to the current document.
-   */
-  words: (options?: { node?: ProseMirrorNode }) => number
-}
-
-/**
- * This extension allows you to count the characters and words of your document.
- * @see https://tiptap.dev/api/extensions/character-count
- */
-export const CharacterCount = Extension.create<CharacterCountOptions, CharacterCountStorage>({
-  name: 'characterCount',
-
-  addOptions() {
-    return {
-      limit: null,
-      mode: 'textSize',
-    }
-  },
-
-  addStorage() {
-    return {
-      characters: () => 0,
-      words: () => 0,
-    }
-  },
-
-  onBeforeCreate() {
-    this.storage.characters = options => {
-      const node = options?.node || this.editor.state.doc
-      const mode = options?.mode || this.options.mode
-
-      if (mode === 'textSize') {
-        const text = node.textBetween(0, node.content.size, undefined, ' ')
-
-        return text.length
-      }
-
-      return node.nodeSize
-    }
-
-    this.storage.words = options => {
-      const node = options?.node || this.editor.state.doc
-      const text = node.textBetween(0, node.content.size, ' ', ' ')
-      const words = text.split(' ').filter(word => word !== '')
-
-      return words.length
-    }
-  },
-
-  addProseMirrorPlugins() {
-    return [
-      new Plugin({
-        key: new PluginKey('characterCount'),
-        filterTransaction: (transaction, state) => {
-          const limit = this.options.limit
-
-          // Nothing has changed or no limit is defined. Ignore it.
-          if (!transaction.docChanged || limit === 0 || limit === null || limit === undefined) {
-            return true
-          }
-
-          const oldSize = this.storage.characters({ node: state.doc })
-          const newSize = this.storage.characters({ node: transaction.doc })
-
-          // Everything is in the limit. Good.
-          if (newSize <= limit) {
-            return true
-          }
-
-          // The limit has already been exceeded but will be reduced.
-          if (oldSize > limit && newSize > limit && newSize <= oldSize) {
-            return true
-          }
-
-          // The limit has already been exceeded and will be increased further.
-          if (oldSize > limit && newSize > limit && newSize > oldSize) {
-            return false
-          }
-
-          const isPaste = transaction.getMeta('paste')
-
-          // Block all exceeding transactions that were not pasted.
-          if (!isPaste) {
-            return false
-          }
-
-          // For pasted content, we try to remove the exceeding content.
-          const pos = transaction.selection.$head.pos
-          const over = newSize - limit
-          const from = pos - over
-          const to = pos
-
-          // It’s probably a bad idea to mutate transactions within `filterTransaction`
-          // but for now this is working fine.
-          transaction.deleteRange(from, to)
-
-          // In some situations, the limit will continue to be exceeded after trimming.
-          // This happens e.g. when truncating within a complex node (e.g. table)
-          // and ProseMirror has to close this node again.
-          // If this is the case, we prevent the transaction completely.
-          const updatedSize = this.storage.characters({ node: transaction.doc })
-
-          if (updatedSize > limit) {
-            return false
-          }
-
-          return true
-        },
-      }),
-    ]
-  },
-})