@opentiny/fluent-editor 3.20.3 → 3.21.0

package/types/config/types/content-change.interface.d.ts

@@ -0,0 +1,13 @@
+export interface IContentChange {
+    content: any;
+    delta: any;
+    editor: any;
+    html: string | null;
+    oldDelta: any;
+    source: string;
+    text: string;
+    textCount: number;
+    wordCount: number;
+    htmlCount: number;
+    isChanged?: boolean;
+}

package/types/config/types/content-save.interface.d.ts

@@ -0,0 +1,6 @@
+export interface IContentSave {
+    editor: any;
+    content: any;
+    html: string | null;
+    text: string;
+}

package/types/config/types/counter-option.interface.d.ts

@@ -0,0 +1,9 @@
+import { AnyFunction } from './type';
+
+export interface ICounterOption {
+    format?: 'text' | 'html';
+    unit?: 'word' | 'char';
+    count?: number;
+    template?: string | AnyFunction;
+    errorTemplate?: string | AnyFunction;
+}

package/types/config/types/editor-config.interface.d.ts

@@ -0,0 +1,21 @@
+import { QuillOptions } from 'quill';
+import { ScreenShotOptions } from '../../screenshot';
+import { IEditorModules } from './editor-modules.interface';
+import { EditorFormat } from './type';
+
+export interface IEditorConfig extends QuillOptions {
+    format?: EditorFormat;
+    modules?: IEditorModules;
+    screenshotOnStaticPage?: boolean;
+    scrollingContainer?: HTMLElement | string | null;
+    trackChanges?: 'user' | 'all';
+    autoProtocol?: boolean | string;
+    editorPaste?: any;
+    uploadOption?: {
+        imageUploadToServer?: boolean;
+        imageAccept?: Array<string>[] | string;
+        fileAccept?: Array<string>[] | string;
+        isVideoPlay?: boolean;
+    };
+    screenshot?: Partial<ScreenShotOptions>;
+}

package/types/config/types/editor-modules.interface.d.ts

@@ -0,0 +1,31 @@
+import { ToolbarOption } from './type';
+
+export interface IEditorModules {
+    [key: string]: any;
+    clipboard?: {
+        matchers?: any[];
+        matchVisual?: boolean;
+    } | boolean;
+    history?: {
+        delay?: number;
+        maxStack?: number;
+        userOnly?: boolean;
+    } | boolean;
+    keyboard?: {
+        bindings?: any;
+    } | boolean;
+    syntax?: {
+        interval?: number;
+        languages?: {
+            key: string;
+            label: string;
+        }[];
+        hljs?: any;
+    } | boolean;
+    toolbar?: (string | string[])[][] | ToolbarOption | string | {
+        container?: string | string[] | ToolbarOption;
+        handlers?: {
+            [key: string]: any;
+        };
+    } | boolean;
+}

package/types/config/types/editor-toolbar.interface.d.ts

@@ -0,0 +1,6 @@
+import { default as Toolbar } from 'quill/modules/toolbar';
+import { FluentEditor } from '../../fluent-editor';
+
+export interface FluentEditorToolbar extends Toolbar {
+    quill: FluentEditor;
+}

package/types/config/types/file-operation.interface.d.ts

@@ -0,0 +1,12 @@
+import { AnyFunction } from './type';
+
+export interface FileOperation {
+    operation: string;
+    hasRejectedFile?: boolean;
+    data: {
+        fileId?: string;
+        file?: File;
+        files?: Array<File>;
+    };
+    callback?: AnyFunction;
+}

package/types/config/types/focus-change.interface.d.ts

@@ -0,0 +1,4 @@
+export interface IFocusChange {
+    editor: any;
+    source: string;
+}

package/types/config/types/fullscreen-module.interface.d.ts

@@ -0,0 +1,4 @@
+export interface IFullscreenModule {
+    mode?: 'normal' | 'immersive';
+    zIndex: number;
+}

package/types/config/types/help-panel-item.interface.d.ts

@@ -0,0 +1,5 @@
+export interface IHelpPanelItem {
+    icon: string;
+    text: string;
+    hotkey: string[];
+}

package/types/config/types/help-panel-option.interface.d.ts

@@ -0,0 +1,7 @@
+import { IHelpPanelItem } from './help-panel-item.interface';
+
+export interface IHelpPanelOption {
+    id: string;
+    title: string;
+    content: IHelpPanelItem[];
+}

package/types/config/types/image-module.interface.d.ts

@@ -0,0 +1,3 @@
+export interface ImageModule {
+    zIndex: number;
+}

package/types/config/types/image-upload.interface.d.ts

@@ -0,0 +1,7 @@
+import { AnyFunction } from './type';
+
+export interface ImageUpload {
+    file: File;
+    hasRejectedImage?: boolean;
+    callback: AnyFunction;
+}

package/types/config/types/index.d.ts

@@ -0,0 +1,23 @@
+export * from './additional-toolbar-item.interface';
+export * from './content-change.interface';
+export * from './content-save.interface';
+export * from './counter-option.interface';
+export * from './editor-config.interface';
+export * from './editor-modules.interface';
+export * from './editor-toolbar.interface';
+export * from './file-operation.interface';
+export * from './focus-change.interface';
+export * from './fullscreen-module.interface';
+export * from './help-panel-option.interface';
+export * from './image-module.interface';
+export * from './image-upload.interface';
+export * from './load-on-demand-module.interface';
+export * from './mention-module.interface';
+export * from './paste-change.interface';
+export * from './quick-menu-module.interface';
+export * from './range.interface';
+export * from './registry-options.interface';
+export * from './selection-change.interface';
+export * from './toolbar-item.interface';
+export * from './type';
+export * from './validate-error.interface';

package/types/config/types/load-on-demand-module.interface.d.ts

@@ -0,0 +1,5 @@
+export interface ILoadOnDemandModule {
+    mode?: 'line' | 'text';
+    limit?: number;
+    lazy?: boolean;
+}

package/types/config/types/mention-module.interface.d.ts

@@ -0,0 +1,8 @@
+export interface IMentionModule {
+    data: object[];
+    itemKey: string;
+    searchKey: string;
+    mentionSearchFn?: (term: string) => Promise<any[]>;
+    mentionSelect?: any;
+    mentionRemove?: any;
+}

package/types/config/types/paste-change.interface.d.ts

@@ -0,0 +1,6 @@
+import { AnyFunction } from './type';
+
+export interface IPasteChange {
+    files: File[];
+    callback: AnyFunction;
+}

package/types/config/types/quick-menu-module.interface.d.ts

@@ -0,0 +1,3 @@
+export interface IQuickMenuModule {
+    zIndex: number;
+}

package/types/config/types/range.interface.d.ts

@@ -0,0 +1,4 @@
+export interface IRange {
+    index: number;
+    length: number;
+}

package/types/config/types/registry-options.interface.d.ts

@@ -0,0 +1,5 @@
+export interface IRegistryOption {
+    importUrl?: string;
+    params?: any;
+    register?: any;
+}

package/types/config/types/selection-change.interface.d.ts

@@ -0,0 +1,8 @@
+import { IRange } from './range.interface';
+
+export interface ISelectionChange {
+    editor: any;
+    oldRange: IRange | null;
+    range: IRange | null;
+    source: string;
+}

package/types/config/types/toolbar-item.interface.d.ts

@@ -0,0 +1,13 @@
+export interface IToolbarItem {
+    indent?: string;
+    list?: string;
+    direction?: string;
+    header?: number | (boolean | number)[];
+    color?: string[];
+    background?: string[];
+    align?: string[];
+    script?: string;
+    font?: string[];
+    size?: boolean[] | string[];
+    lineheight?: number[];
+}

package/types/config/types/type.d.ts

@@ -0,0 +1,5 @@
+import { IToolbarItem } from './toolbar-item.interface';
+
+export type ToolbarOption = (string[] | IToolbarItem[] | string | IToolbarItem)[];
+export type EditorFormat = 'object' | 'json' | 'html' | 'text';
+export type AnyFunction = (...args: any[]) => any;

package/types/config/types/validate-error.interface.d.ts

@@ -0,0 +1,13 @@
+export interface IValidateError {
+    minLengthError?: {
+        given: number;
+        minLength: number;
+    };
+    maxLengthError?: {
+        given: number;
+        maxLength: number;
+    };
+    requiredError?: {
+        empty: boolean;
+    };
+}

package/types/counter/index.d.ts

@@ -0,0 +1,12 @@
+import { ICounterOption } from '../config/types';
+import { default as Quill } from 'quill';
+
+export default class Counter {
+    private quill;
+    container: HTMLDivElement;
+    options: ICounterOption;
+    defaultOptions: ICounterOption;
+    constructor(quill: Quill, options: ICounterOption);
+    renderCount: () => void;
+    getContentLength(format: any): number;
+}

package/types/custom-clipboard.d.ts

@@ -0,0 +1,26 @@
+declare const Clipboard: unknown;
+declare class CustomClipboard extends Clipboard {
+    quill: any;
+    convert: any;
+    onCopy: any;
+    matchers: any;
+    prepareMatching(container: any, nodeMatches: any): any[][];
+    onCaptureCopy(e: any, isCut?: boolean): void;
+    onCapturePaste(e: any): void;
+    onPaste(range: any, { html, text, files: clipboardFiles, rtf }: {
+        html: any;
+        text: any;
+        files: any;
+        rtf: any;
+    }): void;
+    files2urls(files: any, placeholders: any, originalUrls: any, pastedDelta: any, imageIndexs: any): Promise<any[]>;
+    flipFilesArray(filesArr: any): any[][];
+    convertHexToBase64(hexString: any): string;
+    extractImageDataFromRtf(rtfData: any): any[];
+    extractFilesFromDelta(delta: any, clipboardFiles: any, hexImages?: any): Promise<any[]>;
+    getImgSelection(delta: any, imageIndex: any): {
+        index: number;
+        length: number;
+    };
+}
+export default CustomClipboard;

package/types/custom-image/BlotFormatter.d.ts

@@ -0,0 +1,24 @@
+import { default as Action } from './actions/Action';
+import { Options } from './Options';
+import { default as BlotSpec } from './specs/BlotSpec';
+
+export default class BlotFormatter {
+    quill: any;
+    options: Options;
+    currentSpec: BlotSpec;
+    specs: BlotSpec[];
+    overlay: HTMLElement;
+    actions: Action[];
+    observer: any;
+    static register(): void;
+    constructor(quill: any, options?: any);
+    show(spec: BlotSpec): void;
+    hide(): void;
+    update(): void;
+    createActions(spec: BlotSpec): void;
+    destroyActions(): void;
+    repositionOverlay(): void;
+    setUserSelect(value: string): void;
+    onClick: () => void;
+    hideImageOverlay: (event: any) => void;
+}

package/types/custom-image/Options.d.ts

@@ -0,0 +1,36 @@
+export interface OverlayOptions {
+    className: string;
+    style: Record<string, string>;
+}
+export interface ResizeOptions {
+    handleClassName: string;
+    handleStyle: Record<string, string>;
+}
+export interface AlignOptions {
+    attribute: string;
+    aligner: {
+        applyStyle: boolean;
+    };
+    icons: {
+        left: string;
+        center: string;
+        right: string;
+    };
+    toolbar: {
+        allowDeselect: boolean;
+        mainClassName: string;
+        mainStyle: any;
+        buttonClassName: string;
+        addButtonSelectStyle: boolean;
+        buttonStyle: any;
+        svgStyle: any;
+    };
+}
+export interface Options {
+    specs: any;
+    overlay: OverlayOptions;
+    align: AlignOptions;
+    resize: ResizeOptions;
+}
+declare const DefaultOptions: Options;
+export default DefaultOptions;

package/types/custom-image/actions/Action.d.ts

@@ -0,0 +1,7 @@
+export default class Action {
+    formatter: any;
+    constructor(formatter: any);
+    onCreate(): void;
+    onDestroy(): void;
+    onUpdate(): void;
+}

package/types/custom-image/actions/CustomResizeAction.d.ts

@@ -0,0 +1,24 @@
+import { default as Action } from './Action';
+
+export default class CustomResizeAction extends Action {
+    topLeftHandle: HTMLElement;
+    topRightHandle: HTMLElement;
+    bottomRightHandle: HTMLElement;
+    bottomLeftHandle: HTMLElement;
+    dragHandle: HTMLElement;
+    dragStartX: number;
+    preDragWidth: number;
+    targetRatio: number;
+    maxWidth: number;
+    minWidth: number;
+    constructor(formatter: any);
+    onCreate(): void;
+    onDestroy(): void;
+    createHandle(position: string, cursor: string): HTMLElement;
+    repositionHandles(handleStyle: any): void;
+    setCursor(value: string): void;
+    onMouseDown: (event: MouseEvent) => void;
+    findTd: (node: HTMLElement, level: number) => any;
+    onDrag: (event: MouseEvent) => void;
+    onMouseUp: () => void;
+}

package/types/custom-image/actions/DeleteAction.d.ts

@@ -0,0 +1,7 @@
+import { default as Action } from './Action';
+
+export default class DeleteAction extends Action {
+    onCreate(): void;
+    onDestroy(): void;
+    onKeyUp: (event: any) => void;
+}

package/types/custom-image/image.d.ts

@@ -0,0 +1,28 @@
+declare const Embed: unknown;
+declare const Inline: unknown;
+declare class CustomImage extends Embed {
+    static ID_SEED: number;
+    static blotName: string;
+    static tagName: string;
+    domNode: any;
+    parent: any;
+    scroll: any;
+    next: any;
+    static create(value: any): any;
+    static formats(domNode: any): {};
+    static match(url: any): boolean;
+    static register(): void;
+    static sanitize(url: any): any;
+    static value(domNode: any): any;
+    format(name: any, value: any): void;
+    unWrap(): void;
+    wrap(name: any, value: any): any;
+}
+declare class CustomImageContainer extends Inline {
+    static tagName: string;
+    static className: string;
+    static blotName: string;
+    static allowedChildren: typeof CustomImage[];
+    constructor(scroll: any, domNode: any);
+}
+export { CustomImage as default, CustomImageContainer as ImageContainerBlot };

package/types/custom-image/specs/BlotSpec.d.ts

@@ -0,0 +1,13 @@
+import { default as ResizeAction } from '../actions/CustomResizeAction';
+import { default as DeleteAction } from '../actions/DeleteAction';
+
+export default class BlotSpec {
+    formatter: any;
+    constructor(formatter: any);
+    init(): void;
+    getActions(): (typeof ResizeAction | typeof DeleteAction)[];
+    getTargetElement(): any;
+    getOverlayElement(): any;
+    setSelection(): void;
+    onHide(): void;
+}

package/types/custom-image/specs/CustomImageSpec.d.ts

@@ -0,0 +1,21 @@
+import { default as CustomResizeAction } from '../actions/CustomResizeAction';
+import { default as DeleteAction } from '../actions/DeleteAction';
+import { default as ImageSpec } from './ImageSpec';
+
+export declare class CustomImageSpec extends ImageSpec {
+    formatter: any;
+    editorElem: HTMLElement | undefined;
+    observer: any;
+    oldRootScrollTop: any;
+    constructor(formatter: any);
+    handleQuillRootScroll(): void;
+    init(): void;
+    getActions(): (typeof CustomResizeAction | typeof DeleteAction)[];
+    imageMouseOver(event: any): void;
+    imageMouseout: (event: any) => void;
+    addImagePreviewOverlay(event: any): void;
+    removeImagePreviewOverlay(): void;
+    onHide(): void;
+    resetOverlayMarginTop(): void;
+    onClick: (event: MouseEvent) => void;
+}

package/types/custom-image/specs/ImageSpec.d.ts

@@ -0,0 +1,10 @@
+import { default as BlotSpec } from './BlotSpec';
+
+export default class ImageSpec extends BlotSpec {
+    img: any;
+    constructor(formatter: any);
+    init(): void;
+    getTargetElement(): any;
+    onHide(): void;
+    onClick: (event: MouseEvent) => void;
+}

package/types/custom-uploader.d.ts

@@ -0,0 +1,30 @@
+import { Range } from 'quill/core/quill';
+
+interface InsertFileData {
+    code: number;
+    message?: string;
+    data: {
+        title: string;
+        size: number;
+        src: string;
+    };
+}
+declare const Uploader: unknown;
+declare class CustomUploader extends Uploader {
+    quill: any;
+    options: any;
+    upload(range: any, files: any, isFile?: any): void;
+    isAllowedFileType: (accept: Array<string> | string, file: File) => boolean;
+    handleUploadFile(range: any, files: any, _hasRejectedFile: any): void;
+    insertFileToEditor(range: Range, file: File, { code, message, data }: InsertFileData): void;
+    insertImageToEditor(range: any, { code, message, data }: {
+        code: any;
+        message: any;
+        data: any;
+    }): void;
+    handleUploadImage(range: any, { file, files }: {
+        file: any;
+        files: any;
+    }, hasRejectedImage: any): void;
+}
+export default CustomUploader;

package/types/emoji/emoji-list/index.d.ts

@@ -0,0 +1 @@
+export { peopleEmoji } from './people';

package/types/emoji/emoji-list/people.d.ts

@@ -0,0 +1 @@
+export declare const peopleEmoji: any[];

package/types/emoji/emoji-list.d.ts

@@ -0,0 +1,2 @@
+declare const emojiList: any[];
+export default emojiList;

package/types/emoji/emoji-map.d.ts

@@ -0,0 +1,2 @@
+declare const emojiMap: {};
+export default emojiMap;

package/types/emoji/formats/emoji-blot.d.ts

@@ -0,0 +1,13 @@
+declare const Embed: unknown;
+declare class EmojiBlot extends Embed {
+    static emojiClass: string;
+    static emojiPrefix: any;
+    static tagName: string;
+    static blotName: string;
+    static className: string;
+    static create(value: any): any;
+    static value(node: any): any;
+    static buildSpan(value: any, node: any): void;
+    static parseUnicode(string: any): any;
+}
+export default EmojiBlot;

package/types/emoji/index.d.ts

@@ -0,0 +1,10 @@
+import { default as EmojiBlot } from './formats/emoji-blot';
+import { default as ShortNameEmoji } from './modules/emoji';
+import { default as ToolbarEmoji } from './modules/toolbar-emoji';
+
+declare const _default: {
+    EmojiBlot: typeof EmojiBlot;
+    ShortNameEmoji: typeof ShortNameEmoji;
+    ToolbarEmoji: typeof ToolbarEmoji;
+};
+export default _default;

package/types/emoji/modules/emoji.d.ts

@@ -0,0 +1,38 @@
+declare const Module: unknown;
+declare class ShortNameEmoji extends Module {
+    static DEFAULTS: {
+        emojiList: any[];
+        fuse: {
+            shouldSort: boolean;
+            threshold: number;
+            location: number;
+            distance: number;
+            maxPatternLength: number;
+            minMatchCharLength: number;
+            keys: string[];
+        };
+    };
+    emojiList: any;
+    quill: any;
+    fuse: any;
+    onOpen: any;
+    onClose: any;
+    container: HTMLUListElement;
+    onSelectionChange: any;
+    onTextChange: any;
+    open: boolean;
+    atIndex: any;
+    focusedButton: any;
+    isWhiteSpace: (ch: any) => boolean;
+    query: any;
+    buttons: any;
+    options: any;
+    constructor(quill: any, options: any);
+    triggerPicker(range: any, _context: any): boolean;
+    handleArrow(): boolean;
+    update(event: any): void;
+    maybeUnfocus(): void;
+    renderCompletions(emojis: any, evt: any): void;
+    close(value: any, trailingDelete?: number): void;
+}
+export default ShortNameEmoji;

package/types/emoji/modules/toolbar-emoji.d.ts

@@ -0,0 +1,8 @@
+declare const Module: unknown;
+declare class ToolbarEmoji extends Module {
+    quill: any;
+    toolbar: any;
+    constructor(quill: any, options: any);
+    checkPalatteExist(): void;
+}
+export default ToolbarEmoji;

package/types/emoji/utils.d.ts

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

package/types/file/formats/file.d.ts

@@ -0,0 +1,15 @@
+declare const Embed: unknown;
+declare class File extends Embed {
+    static blotName: string;
+    static tagName: string;
+    static className: string;
+    static PROTOCOL_WHITELIST: string[];
+    statics: any;
+    domNode: any;
+    static create(value: any): any;
+    static value(domNode: any): any;
+    static formats(domNode: any): any;
+    static getFormats(domNode: any): any;
+    static sanitize(url: any): any;
+}
+export default File;

package/types/file/index.d.ts

@@ -0,0 +1,11 @@
+import { default as FileBar } from './modules/file-bar';
+
+declare const Module: unknown;
+declare class FileModule extends Module {
+    quill: any;
+    fileBar: FileBar;
+    static register(): void;
+    constructor(quill: any, options: any);
+    clickEvent(event: any): void;
+}
+export default FileModule;

package/types/file/modules/file-bar.d.ts

@@ -0,0 +1,14 @@
+export default class FileBar {
+    quill: any;
+    file: any;
+    domNode: HTMLElement;
+    fileRange: any;
+    template: string;
+    constructor(quill: any, target: any);
+    createFileBar(): void;
+    destroy(): void;
+    operateFile(event: any, operate: any): void;
+    setPosition(): void;
+    css(domNode: any, rules: any): void;
+    formatDate(timestamp: any): string;
+}