@tiptap/extension-typography 2.5.0-beta.1 → 2.5.0-beta.3

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

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

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

@@ -0,0 +1 @@
+export declare function createStyleTag(style: string, nonce?: string, suffix?: 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.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

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

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/dist/packages/extension-typography/src/index.d.ts

@@ -1,3 +1,3 @@
-import { Typography } from './typography.js';
-export * from './typography.js';
-export default Typography;
+import { Typography } from './typography.js';
+export * from './typography.js';
+export default Typography;

package/dist/packages/extension-typography/src/typography.d.ts

@@ -1,140 +1,140 @@
-import { Extension } from '@tiptap/core';
-export interface TypographyOptions {
-    /**
-     * The em dash character.
-     * @default '—'
-     */
-    emDash: false | string;
-    /**
-     * The ellipsis character.
-     * @default '…'
-     */
-    ellipsis: false | string;
-    /**
-     * The open double quote character.
-     * @default '“'
-     */
-    openDoubleQuote: false | string;
-    /**
-     * The close double quote character.
-     * @default '”'
-     */
-    closeDoubleQuote: false | string;
-    /**
-     * The open single quote character.
-     * @default '‘'
-     */
-    openSingleQuote: false | string;
-    /**
-     * The close single quote character.
-     * @default '’'
-     */
-    closeSingleQuote: false | string;
-    /**
-     * The left arrow character.
-     * @default '←'
-     */
-    leftArrow: false | string;
-    /**
-     * The right arrow character.
-     * @default '→'
-     */
-    rightArrow: false | string;
-    /**
-     * The copyright character.
-     * @default '©'
-     */
-    copyright: false | string;
-    /**
-     * The trademark character.
-     * @default '™'
-     */
-    trademark: false | string;
-    /**
-     * The servicemark character.
-     * @default '℠'
-     */
-    servicemark: false | string;
-    /**
-     * The registered trademark character.
-     * @default '®'
-     */
-    registeredTrademark: false | string;
-    /**
-     * The one half character.
-     * @default '½'
-     */
-    oneHalf: false | string;
-    /**
-     * The plus minus character.
-     * @default '±'
-     */
-    plusMinus: false | string;
-    /**
-     * The not equal character.
-     * @default '≠'
-     */
-    notEqual: false | string;
-    /**
-     * The laquo character.
-     * @default '«'
-     */
-    laquo: false | string;
-    /**
-     * The raquo character.
-     * @default '»'
-     */
-    raquo: false | string;
-    /**
-     * The multiplication character.
-     * @default '×'
-     */
-    multiplication: false | string;
-    /**
-     * The superscript two character.
-     * @default '²'
-     */
-    superscriptTwo: false | string;
-    /**
-     * The superscript three character.
-     * @default '³'
-     */
-    superscriptThree: false | string;
-    /**
-     * The one quarter character.
-     * @default '¼'
-     */
-    oneQuarter: false | string;
-    /**
-     * The three quarters character.
-     * @default '¾'
-     */
-    threeQuarters: false | string;
-}
-export declare const emDash: (override?: string) => import("@tiptap/core").InputRule;
-export declare const ellipsis: (override?: string) => import("@tiptap/core").InputRule;
-export declare const openDoubleQuote: (override?: string) => import("@tiptap/core").InputRule;
-export declare const closeDoubleQuote: (override?: string) => import("@tiptap/core").InputRule;
-export declare const openSingleQuote: (override?: string) => import("@tiptap/core").InputRule;
-export declare const closeSingleQuote: (override?: string) => import("@tiptap/core").InputRule;
-export declare const leftArrow: (override?: string) => import("@tiptap/core").InputRule;
-export declare const rightArrow: (override?: string) => import("@tiptap/core").InputRule;
-export declare const copyright: (override?: string) => import("@tiptap/core").InputRule;
-export declare const trademark: (override?: string) => import("@tiptap/core").InputRule;
-export declare const servicemark: (override?: string) => import("@tiptap/core").InputRule;
-export declare const registeredTrademark: (override?: string) => import("@tiptap/core").InputRule;
-export declare const oneHalf: (override?: string) => import("@tiptap/core").InputRule;
-export declare const plusMinus: (override?: string) => import("@tiptap/core").InputRule;
-export declare const notEqual: (override?: string) => import("@tiptap/core").InputRule;
-export declare const laquo: (override?: string) => import("@tiptap/core").InputRule;
-export declare const raquo: (override?: string) => import("@tiptap/core").InputRule;
-export declare const multiplication: (override?: string) => import("@tiptap/core").InputRule;
-export declare const superscriptTwo: (override?: string) => import("@tiptap/core").InputRule;
-export declare const superscriptThree: (override?: string) => import("@tiptap/core").InputRule;
-export declare const oneQuarter: (override?: string) => import("@tiptap/core").InputRule;
-export declare const threeQuarters: (override?: string) => import("@tiptap/core").InputRule;
-/**
- * This extension allows you to add typography replacements for specific characters.
- * @see https://www.tiptap.dev/api/extensions/typography
- */
-export declare const Typography: Extension<TypographyOptions, any>;
+import { Extension } from '@tiptap/core';
+export interface TypographyOptions {
+    /**
+     * The em dash character.
+     * @default '—'
+     */
+    emDash: false | string;
+    /**
+     * The ellipsis character.
+     * @default '…'
+     */
+    ellipsis: false | string;
+    /**
+     * The open double quote character.
+     * @default '“'
+     */
+    openDoubleQuote: false | string;
+    /**
+     * The close double quote character.
+     * @default '”'
+     */
+    closeDoubleQuote: false | string;
+    /**
+     * The open single quote character.
+     * @default '‘'
+     */
+    openSingleQuote: false | string;
+    /**
+     * The close single quote character.
+     * @default '’'
+     */
+    closeSingleQuote: false | string;
+    /**
+     * The left arrow character.
+     * @default '←'
+     */
+    leftArrow: false | string;
+    /**
+     * The right arrow character.
+     * @default '→'
+     */
+    rightArrow: false | string;
+    /**
+     * The copyright character.
+     * @default '©'
+     */
+    copyright: false | string;
+    /**
+     * The trademark character.
+     * @default '™'
+     */
+    trademark: false | string;
+    /**
+     * The servicemark character.
+     * @default '℠'
+     */
+    servicemark: false | string;
+    /**
+     * The registered trademark character.
+     * @default '®'
+     */
+    registeredTrademark: false | string;
+    /**
+     * The one half character.
+     * @default '½'
+     */
+    oneHalf: false | string;
+    /**
+     * The plus minus character.
+     * @default '±'
+     */
+    plusMinus: false | string;
+    /**
+     * The not equal character.
+     * @default '≠'
+     */
+    notEqual: false | string;
+    /**
+     * The laquo character.
+     * @default '«'
+     */
+    laquo: false | string;
+    /**
+     * The raquo character.
+     * @default '»'
+     */
+    raquo: false | string;
+    /**
+     * The multiplication character.
+     * @default '×'
+     */
+    multiplication: false | string;
+    /**
+     * The superscript two character.
+     * @default '²'
+     */
+    superscriptTwo: false | string;
+    /**
+     * The superscript three character.
+     * @default '³'
+     */
+    superscriptThree: false | string;
+    /**
+     * The one quarter character.
+     * @default '¼'
+     */
+    oneQuarter: false | string;
+    /**
+     * The three quarters character.
+     * @default '¾'
+     */
+    threeQuarters: false | string;
+}
+export declare const emDash: (override?: string) => import("@tiptap/core").InputRule;
+export declare const ellipsis: (override?: string) => import("@tiptap/core").InputRule;
+export declare const openDoubleQuote: (override?: string) => import("@tiptap/core").InputRule;
+export declare const closeDoubleQuote: (override?: string) => import("@tiptap/core").InputRule;
+export declare const openSingleQuote: (override?: string) => import("@tiptap/core").InputRule;
+export declare const closeSingleQuote: (override?: string) => import("@tiptap/core").InputRule;
+export declare const leftArrow: (override?: string) => import("@tiptap/core").InputRule;
+export declare const rightArrow: (override?: string) => import("@tiptap/core").InputRule;
+export declare const copyright: (override?: string) => import("@tiptap/core").InputRule;
+export declare const trademark: (override?: string) => import("@tiptap/core").InputRule;
+export declare const servicemark: (override?: string) => import("@tiptap/core").InputRule;
+export declare const registeredTrademark: (override?: string) => import("@tiptap/core").InputRule;
+export declare const oneHalf: (override?: string) => import("@tiptap/core").InputRule;
+export declare const plusMinus: (override?: string) => import("@tiptap/core").InputRule;
+export declare const notEqual: (override?: string) => import("@tiptap/core").InputRule;
+export declare const laquo: (override?: string) => import("@tiptap/core").InputRule;
+export declare const raquo: (override?: string) => import("@tiptap/core").InputRule;
+export declare const multiplication: (override?: string) => import("@tiptap/core").InputRule;
+export declare const superscriptTwo: (override?: string) => import("@tiptap/core").InputRule;
+export declare const superscriptThree: (override?: string) => import("@tiptap/core").InputRule;
+export declare const oneQuarter: (override?: string) => import("@tiptap/core").InputRule;
+export declare const threeQuarters: (override?: string) => import("@tiptap/core").InputRule;
+/**
+ * This extension allows you to add typography replacements for specific characters.
+ * @see https://www.tiptap.dev/api/extensions/typography
+ */
+export declare const Typography: Extension<TypographyOptions, any>;