@kaitify/core 0.0.1-beta.1

package/lib/extensions/Extension.d.ts

@@ -0,0 +1,172 @@
+import { Editor, EditorCommandsType, KNode, KNodeMarksType, KNodeStylesType, RuleFunctionType, Selection } from '../model';
+/**
+ * 创建扩展的入参类型
+ */
+export type ExtensionCreateOptionType = {
+    /**
+     * 扩展名称
+     */
+    name: string;
+    /**
+     * 置空的标签
+     */
+    emptyRenderTags?: string[];
+    /**
+     * 额外保留的标签
+     */
+    extraKeepTags?: string[];
+    /**
+     * 自定义格式化规则
+     */
+    formatRules?: RuleFunctionType[];
+    /**
+     * 自定义dom转为非文本节点的后续处理
+     */
+    domParseNodeCallback?: (this: Editor, node: KNode) => KNode;
+    /**
+     * 光标变化回调
+     */
+    onSelectionUpdate?: (this: Editor, selection: Selection) => void;
+    /**
+     * 插入段落时回调
+     */
+    onInsertParagraph?: (this: Editor, node: KNode) => void;
+    /**
+     * 完成删除回调
+     */
+    onDeleteComplete?: (this: Editor) => void;
+    /**
+     * 光标在编辑器内时键盘按下回调
+     */
+    onKeydown?: (this: Editor, event: KeyboardEvent) => void;
+    /**
+     * 光标在编辑器内时键盘松开回调
+     */
+    onKeyup?: (this: Editor, event: KeyboardEvent) => void;
+    /**
+     * 编辑器聚焦时回调
+     */
+    onFocus?: (this: Editor, event: FocusEvent) => void;
+    /**
+     * 编辑器失焦时回调
+     */
+    onBlur?: (this: Editor, event: FocusEvent) => void;
+    /**
+     * 节点粘贴保留标记的自定义方法
+     */
+    pasteKeepMarks?: (this: Editor, node: KNode) => KNodeMarksType;
+    /**
+     * 节点粘贴保留样式的自定义方法
+     */
+    pasteKeepStyles?: (this: Editor, node: KNode) => KNodeStylesType;
+    /**
+     * 视频更新前回调
+     */
+    beforeUpdateView?: (this: Editor) => void;
+    /**
+     * 视图更新后回调
+     */
+    afterUpdateView?: (this: Editor) => void;
+    /**
+     * 在删除和换行操作中块节点节点从其父节点中抽离出去成为与父节点同级的节点后触发，如果返回true则表示继续使用默认逻辑，会将该节点转为段落，返回false则不走默认逻辑，需要自定义处理
+     */
+    onDetachMentBlockFromParentCallback?: (this: Editor, node: KNode) => boolean;
+    /**
+     * 编辑器updateView执行时，通过比对新旧节点数组获取需要格式化的节点，在这些节点被格式化前，触发此方法，回调参数即当前需要被格式化的节点，该方法返回一个节点，返回的节点将会被格式化，如果你不需要任何特殊处理，返回入参提供的节点即可
+     */
+    beforePatchNodeToFormat?: (this: Editor, node: KNode) => KNode;
+    /**
+     * 自定义命令
+     */
+    addCommands?: (this: Editor) => EditorCommandsType;
+};
+/**
+ * 扩展
+ */
+export declare class Extension {
+    /**
+     * 扩展名称
+     */
+    name: string;
+    /**
+     * 是否已注册
+     */
+    registered: boolean;
+    /**
+     * 置空的标签
+     */
+    emptyRenderTags: string[];
+    /**
+     * 额外保留的标签
+     */
+    extraKeepTags: string[];
+    /**
+     * 自定义格式化规则
+     */
+    formatRules: RuleFunctionType[];
+    /**
+     * 自定义dom转为非文本节点的后续处理
+     */
+    domParseNodeCallback?: (this: Editor, node: KNode) => KNode;
+    /**
+     * 光标变化回调
+     */
+    onSelectionUpdate?: (this: Editor, selection: Selection) => void;
+    /**
+     * 插入段落时回调
+     */
+    onInsertParagraph?: (this: Editor, node: KNode) => void;
+    /**
+     * 完成删除回调
+     */
+    onDeleteComplete?: (this: Editor) => void;
+    /**
+     * 光标在编辑器内时键盘按下回调
+     */
+    onKeydown?: (this: Editor, event: KeyboardEvent) => void;
+    /**
+     * 光标在编辑器内时键盘松开回调
+     */
+    onKeyup?: (this: Editor, event: KeyboardEvent) => void;
+    /**
+     * 编辑器聚焦时回调
+     */
+    onFocus?: (this: Editor, event: FocusEvent) => void;
+    /**
+     * 编辑器失焦时回调
+     */
+    onBlur?: (this: Editor, event: FocusEvent) => void;
+    /**
+     * 节点粘贴保留标记的自定义方法
+     */
+    pasteKeepMarks?: (this: Editor, node: KNode) => KNodeMarksType;
+    /**
+     * 节点粘贴保留样式的自定义方法
+     */
+    pasteKeepStyles?: (this: Editor, node: KNode) => KNodeStylesType;
+    /**
+     * 视频更新前回调
+     */
+    beforeUpdateView?: (this: Editor) => void;
+    /**
+     * 视图更新后回调
+     */
+    afterUpdateView?: (this: Editor) => void;
+    /**
+     * 在删除和换行操作中块节点节点从其父节点中抽离出去成为与父节点同级的节点后触发，如果返回true则表示继续使用默认逻辑，会将该节点转为段落，返回false则不走默认逻辑，需要自定义处理
+     */
+    onDetachMentBlockFromParentCallback?: (this: Editor, node: KNode) => boolean;
+    /**
+     * 编辑器updateView执行时，通过比对新旧节点数组获取需要格式化的节点，在这些节点被格式化前，触发此方法，回调参数即当前需要被格式化的节点，该方法返回一个节点，返回的节点将会被格式化，如果你不需要任何特殊处理，返回入参提供的节点即可
+     */
+    beforePatchNodeToFormat?: (this: Editor, node: KNode) => KNode;
+    /**
+     * 自定义命令
+     */
+    addCommands?: (this: Editor) => EditorCommandsType;
+    constructor(name: string);
+    /**
+     * 创建扩展
+     */
+    static create(options: ExtensionCreateOptionType): Extension;
+}

package/lib/extensions/align/index.d.ts

@@ -0,0 +1,10 @@
+import { Extension } from '../Extension';
+export type AlignValueType = 'left' | 'right' | 'center' | 'justify';
+declare module '../../model' {
+    interface EditorCommandsType {
+        isAlign?: (value: AlignValueType) => boolean;
+        setAlign?: (value: AlignValueType) => Promise<void>;
+        unsetAlign?: (value: AlignValueType) => Promise<void>;
+    }
+}
+export declare const AlignExtension: () => Extension;

package/lib/extensions/attachment/index.d.ts

@@ -0,0 +1,29 @@
+import { KNode } from '../../model';
+import { Extension } from '../Extension';
+export type SetAttachmentOptionType = {
+    url: string;
+    text: string;
+    icon?: string;
+};
+export type UpdateAttachmentOptionType = {
+    url?: string;
+    text?: string;
+    icon?: string;
+};
+export type AttachmentExtensionPropsType = {
+    icon: string;
+};
+declare module '../../model' {
+    interface EditorCommandsType {
+        getAttachment?: () => KNode | null;
+        hasAttachment?: () => boolean;
+        setAttachment?: (options: SetAttachmentOptionType) => Promise<void>;
+        updateAttachment?: (options: UpdateAttachmentOptionType) => Promise<void>;
+        getAttachmentInfo?: () => {
+            url: string;
+            text: string;
+            icon: string;
+        } | null;
+    }
+}
+export declare const AttachmentExtension: (props?: AttachmentExtensionPropsType) => Extension;

package/lib/extensions/back-color/index.d.ts

@@ -0,0 +1,9 @@
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        isBackColor?: (value: string) => boolean;
+        setBackColor?: (value: string) => Promise<void>;
+        unsetBackColor?: (value: string) => Promise<void>;
+    }
+}
+export declare const BackColorExtension: () => Extension;

package/lib/extensions/blockquote/index.d.ts

@@ -0,0 +1,12 @@
+import { KNode } from '../../model';
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        getBlockquote?: () => KNode | null;
+        hasBlockquote?: () => boolean;
+        allBlockquote?: () => boolean;
+        setBlockquote?: () => Promise<void>;
+        unsetBlockquote?: () => Promise<void>;
+    }
+}
+export declare const BlockquoteExtension: () => Extension;

package/lib/extensions/bold/index.d.ts

@@ -0,0 +1,9 @@
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        isBold?: () => boolean;
+        setBold?: () => Promise<void>;
+        unsetBold?: () => Promise<void>;
+    }
+}
+export declare const BoldExtension: () => Extension;

package/lib/extensions/code/index.d.ts

@@ -0,0 +1,12 @@
+import { KNode } from '../../model';
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        getCode?: () => KNode | null;
+        hasCode?: () => boolean;
+        allCode?: () => boolean;
+        setCode?: () => Promise<void>;
+        unsetCode?: () => Promise<void>;
+    }
+}
+export declare const CodeExtension: () => Extension;

package/lib/extensions/code-block/hljs.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 支持的语言列表
+ */
+export declare const HljsLanguages: readonly ["plaintext", "json", "javascript", "java", "typescript", "python", "php", "css", "less", "scss", "html", "markdown", "objectivec", "swift", "dart", "nginx", "http", "go", "ruby", "c", "cpp", "csharp", "sql", "shell", "r", "kotlin", "rust"];
+/**
+ * 语言类型
+ */
+export type HljsLanguageType = (typeof HljsLanguages)[number];
+/**
+ * 获取经过hljs处理的html元素
+ */
+export declare const getHljsHtml: (code: string, language: string) => string;

package/lib/extensions/code-block/index.d.ts

@@ -0,0 +1,15 @@
+import { KNode } from '../../model';
+import { Extension } from '../Extension';
+import { HljsLanguageType } from './hljs';
+declare module '../../model' {
+    interface EditorCommandsType {
+        getCodeBlock?: () => KNode | null;
+        hasCodeBlock?: () => boolean;
+        allCodeBlock?: () => boolean;
+        setCodeBlock?: () => Promise<void>;
+        unsetCodeBlock?: () => Promise<void>;
+        updateCodeBlockLanguage?: (language: HljsLanguageType) => Promise<void>;
+    }
+}
+export declare const CodeBlockExtension: () => Extension;
+export * from './hljs';

package/lib/extensions/color/index.d.ts

@@ -0,0 +1,9 @@
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        isColor?: (value: string) => boolean;
+        setColor?: (value: string) => Promise<void>;
+        unsetColor?: (value: string) => Promise<void>;
+    }
+}
+export declare const ColorExtension: () => Extension;

package/lib/extensions/font-family/index.d.ts

@@ -0,0 +1,9 @@
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        isFontFamily?: (value: string) => boolean;
+        setFontFamily?: (value: string) => Promise<void>;
+        unsetFontFamily?: (value: string) => Promise<void>;
+    }
+}
+export declare const FontFamilyExtension: () => Extension;

package/lib/extensions/font-size/index.d.ts

@@ -0,0 +1,9 @@
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        isFontSize?: (value: string) => boolean;
+        setFontSize?: (value: string) => Promise<void>;
+        unsetFontSize?: (value: string) => Promise<void>;
+    }
+}
+export declare const FontSizeExtension: () => Extension;

package/lib/extensions/heading/index.d.ts

@@ -0,0 +1,13 @@
+import { KNode } from '../../model';
+import { Extension } from '../Extension';
+export type HeadingLevelType = 0 | 1 | 2 | 3 | 4 | 5 | 6;
+declare module '../../model' {
+    interface EditorCommandsType {
+        getHeading?: (level: HeadingLevelType) => KNode | null;
+        hasHeading?: (level: HeadingLevelType) => boolean;
+        allHeading?: (level: HeadingLevelType) => boolean;
+        setHeading?: (level: HeadingLevelType) => Promise<void>;
+        unsetHeading?: (level: HeadingLevelType) => Promise<void>;
+    }
+}
+export declare const HeadingExtension: () => Extension;

package/lib/extensions/history/index.d.ts

@@ -0,0 +1,10 @@
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        canUndo?: () => boolean;
+        canRedo?: () => boolean;
+        undo?: () => Promise<void>;
+        redo?: () => Promise<void>;
+    }
+}
+export declare const HistoryExtension: () => Extension;

package/lib/extensions/horizontal/index.d.ts

@@ -0,0 +1,7 @@
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        setHorizontal?: () => Promise<void>;
+    }
+}
+export declare const HorizontalExtension: () => Extension;

package/lib/extensions/image/index.d.ts

@@ -0,0 +1,26 @@
+import { KNode } from '../../model';
+import { Extension } from '../Extension';
+/**
+ * 插入图片方法入参类型
+ */
+export type SetImageOptionType = {
+    src: string;
+    alt?: string;
+    width?: string;
+};
+/**
+ * 更新图片方法入参类型
+ */
+export type UpdateImageOptionType = {
+    src?: string;
+    alt?: string;
+};
+declare module '../../model' {
+    interface EditorCommandsType {
+        getImage?: () => KNode | null;
+        hasImage?: () => boolean;
+        setImage?: (options: SetImageOptionType) => Promise<void>;
+        updateImage?: (options: UpdateImageOptionType) => Promise<void>;
+    }
+}
+export declare const ImageExtension: () => Extension;

package/lib/extensions/indent/index.d.ts

@@ -0,0 +1,8 @@
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        setIncreaseIndent?: () => Promise<void>;
+        setDecreaseIndent?: () => Promise<void>;
+    }
+}
+export declare const IndentExtension: () => Extension;

package/lib/extensions/index.d.ts

@@ -0,0 +1,29 @@
+export * from './Extension';
+export * from './text';
+export * from './history';
+export * from './image';
+export * from './video';
+export * from './bold';
+export * from './italic';
+export * from './strikethrough';
+export * from './underline';
+export * from './superscript';
+export * from './subscript';
+export * from './code';
+export * from './font-size';
+export * from './font-family';
+export * from './color';
+export * from './back-color';
+export * from './link';
+export * from './align';
+export * from './line-height';
+export * from './indent';
+export * from './horizontal';
+export * from './blockquote';
+export * from './heading';
+export * from './list';
+export * from './task';
+export * from './math';
+export * from './code-block';
+export * from './attachment';
+export * from './table';

package/lib/extensions/italic/index.d.ts

@@ -0,0 +1,9 @@
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        isItalic?: () => boolean;
+        setItalic?: () => Promise<void>;
+        unsetItalic?: () => Promise<void>;
+    }
+}
+export declare const ItalicExtension: () => Extension;

package/lib/extensions/line-height/index.d.ts

@@ -0,0 +1,9 @@
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        isLineHeight?: (value: string | number) => boolean;
+        setLineHeight?: (value: string | number) => Promise<void>;
+        unsetLineHeight?: (value: string | number) => Promise<void>;
+    }
+}
+export declare const LineHeightExtension: () => Extension;

package/lib/extensions/link/index.d.ts

@@ -0,0 +1,27 @@
+import { KNode } from '../../model';
+import { Extension } from '../Extension';
+/**
+ * 插入链接方法入参类型
+ */
+export type SetLinkOptionType = {
+    href: string;
+    text?: string;
+    newOpen?: boolean;
+};
+/**
+ * 更新链接方法入参类型
+ */
+export type UpdateLinkOptionType = {
+    href?: string;
+    newOpen?: boolean;
+};
+declare module '../../model' {
+    interface EditorCommandsType {
+        getLink?: () => KNode | null;
+        hasLink?: () => boolean;
+        setLink?: (options: SetLinkOptionType) => Promise<void>;
+        updateLink?: (options: UpdateLinkOptionType) => Promise<void>;
+        unsetLink?: () => Promise<void>;
+    }
+}
+export declare const LinkExtension: () => Extension;

package/lib/extensions/list/index.d.ts

@@ -0,0 +1,18 @@
+import { KNode } from '../../model';
+import { Extension } from '../Extension';
+export type OrderedListType = 'decimal' | 'lower-alpha' | 'upper-alpha' | 'lower-roman' | 'upper-roman' | 'lower-greek' | 'cjk-ideographic';
+export type UnorderListType = 'disc' | 'circle' | 'square';
+export type ListOptionsType = {
+    ordered?: boolean;
+    listType?: OrderedListType | UnorderListType;
+};
+declare module '../../model' {
+    interface EditorCommandsType {
+        getList?: (options: ListOptionsType) => KNode | null;
+        hasList?: (options: ListOptionsType) => boolean;
+        allList?: (options: ListOptionsType) => boolean;
+        setList?: (options: ListOptionsType) => Promise<void>;
+        unsetList?: (options: ListOptionsType) => Promise<void>;
+    }
+}
+export declare const ListExtension: () => Extension;

package/lib/extensions/math/index.d.ts

@@ -0,0 +1,11 @@
+import { KNode } from '../../model';
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        getMath?: () => KNode | null;
+        hasMath?: () => boolean;
+        setMath?: (value: string) => Promise<void>;
+        updateMath?: (value: string) => Promise<void>;
+    }
+}
+export declare const MathExtension: () => Extension;

package/lib/extensions/strikethrough/index.d.ts

@@ -0,0 +1,9 @@
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        isStrikethrough?: () => boolean;
+        setStrikethrough?: () => Promise<void>;
+        unsetStrikethrough?: () => Promise<void>;
+    }
+}
+export declare const StrikethroughExtension: () => Extension;

package/lib/extensions/subscript/index.d.ts

@@ -0,0 +1,9 @@
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        isSubscript?: () => boolean;
+        setSubscript?: () => Promise<void>;
+        unsetSubscript?: () => Promise<void>;
+    }
+}
+export declare const SubscriptExtension: () => Extension;

package/lib/extensions/superscript/index.d.ts

@@ -0,0 +1,9 @@
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        isSuperscript?: () => boolean;
+        setSuperscript?: () => Promise<void>;
+        unsetSuperscript?: () => Promise<void>;
+    }
+}
+export declare const SuperscriptExtension: () => Extension;

package/lib/extensions/table/index.d.ts

@@ -0,0 +1,21 @@
+import { KNode } from '../../model';
+import { Extension } from '../Extension';
+export type TableCellsMergeDirectionType = 'left' | 'top' | 'right' | 'bottom';
+declare module '../../model' {
+    interface EditorCommandsType {
+        getTable?: () => KNode | null;
+        hasTable?: () => boolean;
+        canMergeTableCells?: (direction: TableCellsMergeDirectionType) => boolean;
+        setTable?: ({ rows, columns }: {
+            rows: number;
+            columns: number;
+        }) => Promise<void>;
+        unsetTable?: () => Promise<void>;
+        mergeTableCell?: (direction: TableCellsMergeDirectionType) => Promise<void>;
+        addTableRow?: (direction: 'top' | 'bottom') => Promise<void>;
+        deleteTableRow?: () => Promise<void>;
+        addTableColumn?: (direction: 'left' | 'right') => Promise<void>;
+        deleteTableColumn?: () => Promise<void>;
+    }
+}
+export declare const TableExtension: () => Extension;

package/lib/extensions/task/index.d.ts

@@ -0,0 +1,12 @@
+import { KNode } from '../../model';
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        getTask?: () => KNode | null;
+        hasTask?: () => boolean;
+        allTask?: () => boolean;
+        setTask?: () => Promise<void>;
+        unsetTask?: () => Promise<void>;
+    }
+}
+export declare const TaskExtension: () => Extension;

package/lib/extensions/text/index.d.ts

@@ -0,0 +1,14 @@
+import { KNodeMarksType, KNodeStylesType } from '../../model';
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        isTextStyle?: (styleName: string, styleValue?: string | number) => boolean;
+        isTextMark?: (markName: string, markValue?: string | number) => boolean;
+        setTextStyle?: (styles: KNodeStylesType, updateView?: boolean) => Promise<void>;
+        setTextMark?: (marks: KNodeMarksType, updateView?: boolean) => Promise<void>;
+        removeTextStyle?: (styleNames?: string[], updateView?: boolean) => Promise<void>;
+        removeTextMark?: (markNames?: string[], updateView?: boolean) => Promise<void>;
+        clearFormat?: () => Promise<void>;
+    }
+}
+export declare const TextExtension: () => Extension;

package/lib/extensions/underline/index.d.ts

@@ -0,0 +1,9 @@
+import { Extension } from '../Extension';
+declare module '../../model' {
+    interface EditorCommandsType {
+        isUnderline?: () => boolean;
+        setUnderline?: () => Promise<void>;
+        unsetUnderline?: () => Promise<void>;
+    }
+}
+export declare const UnderlineExtension: () => Extension;

package/lib/extensions/video/index.d.ts

@@ -0,0 +1,27 @@
+import { KNode } from '../../model';
+import { Extension } from '../Extension';
+/**
+ * 插入视频方法入参类型
+ */
+export type SetVideoOptionType = {
+    src: string;
+    width?: string;
+    autoplay?: boolean;
+};
+/**
+ * 更新视频方法入参类型
+ */
+export type UpdateVideoOptionType = {
+    controls?: boolean;
+    muted?: boolean;
+    loop?: boolean;
+};
+declare module '../../model' {
+    interface EditorCommandsType {
+        getVideo?: () => KNode | null;
+        hasVideo?: () => boolean;
+        setVideo?: (options: SetVideoOptionType) => Promise<void>;
+        updateVideo?: (options: UpdateVideoOptionType) => Promise<void>;
+    }
+}
+export declare const VideoExtension: () => Extension;

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from './model';
+export * from './extensions';
+export * from './view';