@opentiny/fluent-editor 4.0.0-alpha.0 → 4.0.0-alpha.2

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

@@ -1,278 +1,4 @@
 export declare const BIG_DELTA_LIMIT = 2000;
-export declare const LANG_CONF: {
-    'en-US': {
-        header: string;
-        normal: string;
-        h1: string;
-        h2: string;
-        h3: string;
-        h4: string;
-        h5: string;
-        h6: string;
-        'line-height': string;
-        songti: string;
-        yahei: string;
-        kaiti: string;
-        heiti: string;
-        lishu: string;
-        left: string;
-        center: string;
-        right: string;
-        codeblock: string;
-        globallink: string;
-        'exit-fullscreen': string;
-        help: string;
-        more: string;
-        'help-format': string;
-        'help-insert': string;
-        'help-operation': string;
-        mention: string;
-        'quick-menu': string;
-        'toggle-help-panel': string;
-        'scroll-table': string;
-        'mouse-wheel': string;
-        save: string;
-        'copy-cells': string;
-        'copy-table': string;
-        'cut-cells': string;
-        'empty-cells': string;
-        'insert-row-up': string;
-        'insert-row-down': string;
-        'insert-column-left': string;
-        'insert-column-right': string;
-        'merge-cells': string;
-        'unmerge-cells': string;
-        'delete-row': string;
-        'delete-column': string;
-        'delete-table': string;
-        'default-link-text': string;
-        basicblock: string;
-        linkplaceholder: string;
-        'counter-template': string;
-        char: string;
-        word: string;
-        'counter-limit-tips': string;
-        'ie-msg': string;
-        loading: string;
-        pasting: string;
-        'img-error': string;
-        'img-error-info': string;
-        'last-modified': string;
-        screenshot: string;
-        uploading: string;
-        'sub-title-bg-color': string;
-        emoji: string;
-        fullscreen: string;
-        blockquote: string;
-        undo: string;
-        redo: string;
-        clean: string;
-        bold: string;
-        italic: string;
-        underline: string;
-        strike: string;
-        image: string;
-        file: string;
-        link: string;
-        code: string;
-        table: string;
-        'table-up': string;
-        'code-block': string;
-        formula: string;
-        'format-painter': string;
-        divider: string;
-        video: string;
-        color: string;
-        background: string;
-        font: string;
-        size: string;
-        list: string;
-        'list-ordered': string;
-        'list-bullet': string;
-        'list-check': string;
-        'align-left': string;
-        'align-center': string;
-        'align-right': string;
-        'align-justify': string;
-        'direction-ltr': string;
-        'direction-rtl': string;
-        'indent--1': string;
-        'indent-+1': string;
-        'script-super': string;
-        'script-sub': string;
-        'header-normal': string;
-        'header-1': string;
-        'header-2': string;
-        'header-3': string;
-        'header-4': string;
-        'header-5': string;
-        'header-6': string;
-        'header-list': string;
-        'input-recall-menu-placeholder': string;
-        'clear-color': string;
-        'custom-color': string;
-        fullCheckboxText: string;
-        customBtnText: string;
-        confirmText: string;
-        cancelText: string;
-        rowText: string;
-        colText: string;
-        notPositiveNumberError: string;
-        custom: string;
-        clear: string;
-        transparent: string;
-        perWidthInsufficient: string;
-        CopyCell: string;
-        CutCell: string;
-        InsertTop: string;
-        InsertRight: string;
-        InsertBottom: string;
-        InsertLeft: string;
-        MergeCell: string;
-        SplitCell: string;
-        DeleteRow: string;
-        DeleteColumn: string;
-        DeleteTable: string;
-        BackgroundColor: string;
-        BorderColor: string;
-    };
-    'zh-CN': {
-        header: string;
-        normal: string;
-        h1: string;
-        h2: string;
-        h3: string;
-        h4: string;
-        h5: string;
-        h6: string;
-        'line-height': string;
-        songti: string;
-        yahei: string;
-        kaiti: string;
-        heiti: string;
-        lishu: string;
-        left: string;
-        center: string;
-        right: string;
-        codeblock: string;
-        globallink: string;
-        'exit-fullscreen': string;
-        help: string;
-        more: string;
-        'help-format': string;
-        'help-insert': string;
-        'help-operation': string;
-        mention: string;
-        'quick-menu': string;
-        'toggle-help-panel': string;
-        'scroll-table': string;
-        'mouse-wheel': string;
-        save: string;
-        'copy-cells': string;
-        'copy-table': string;
-        'cut-cells': string;
-        'empty-cells': string;
-        'insert-row-up': string;
-        'insert-row-down': string;
-        'insert-column-left': string;
-        'insert-column-right': string;
-        'merge-cells': string;
-        'unmerge-cells': string;
-        'delete-row': string;
-        'delete-column': string;
-        'delete-table': string;
-        'default-link-text': string;
-        basicblock: string;
-        linkplaceholder: string;
-        'counter-template': string;
-        char: string;
-        word: string;
-        'counter-limit-tips': string;
-        'ie-msg': string;
-        loading: string;
-        pasting: string;
-        'img-error': string;
-        'img-error-info': string;
-        'last-modified': string;
-        screenshot: string;
-        uploading: string;
-        'sub-title-bg-color': string;
-        emoji: string;
-        fullscreen: string;
-        blockquote: string;
-        undo: string;
-        redo: string;
-        clean: string;
-        bold: string;
-        italic: string;
-        underline: string;
-        strike: string;
-        image: string;
-        file: string;
-        link: string;
-        divider: string;
-        code: string;
-        table: string;
-        'table-up': string;
-        'code-block': string;
-        formula: string;
-        'format-painter': string;
-        video: string;
-        color: string;
-        background: string;
-        font: string;
-        size: string;
-        list: string;
-        'list-ordered': string;
-        'list-bullet': string;
-        'list-check': string;
-        'align-left': string;
-        'align-center': string;
-        'align-right': string;
-        'align-justify': string;
-        'direction-ltr': string;
-        'direction-rtl': string;
-        'indent--1': string;
-        'indent-+1': string;
-        'script-super': string;
-        'script-sub': string;
-        'header-normal': string;
-        'header-1': string;
-        'header-2': string;
-        'header-3': string;
-        'header-4': string;
-        'header-5': string;
-        'header-6': string;
-        'header-list': string;
-        'input-recall-menu-placeholder': string;
-        'clear-color': string;
-        'custom-color': string;
-        fullCheckboxText: string;
-        customBtnText: string;
-        confirmText: string;
-        cancelText: string;
-        rowText: string;
-        colText: string;
-        notPositiveNumberError: string;
-        custom: string;
-        clear: string;
-        transparent: string;
-        perWidthInsufficient: string;
-        CopyCell: string;
-        CutCell: string;
-        InsertTop: string;
-        InsertRight: string;
-        InsertBottom: string;
-        InsertLeft: string;
-        MergeCell: string;
-        SplitCell: string;
-        DeleteRow: string;
-        DeleteColumn: string;
-        DeleteTable: string;
-        BackgroundColor: string;
-        BorderColor: string;
-    };
-};
 export declare const CHANGE_LANGUAGE_EVENT = "change-language";
 export declare const defaultLanguage = "en-US";
 export declare const IMAGE_UPLOADER_MIME_TYPES: string[];

package/types/config/editor.utils.d.ts

@@ -38,4 +38,3 @@ export declare function getEventComposedPath(evt: any): any;
 export declare function sanitize(url: any, protocols: any): any;
 export declare function hadProtocol(url: string): boolean;
 export declare function isInside(position: any, dom: any): boolean;
-export declare const isPureIE: boolean;

package/types/config/i18n/en-us.d.ts

@@ -30,19 +30,6 @@ export declare const EN_US: {
     'scroll-table': string;
     'mouse-wheel': string;
     save: string;
-    'copy-cells': string;
-    'copy-table': string;
-    'cut-cells': string;
-    'empty-cells': string;
-    'insert-row-up': string;
-    'insert-row-down': string;
-    'insert-column-left': string;
-    'insert-column-right': string;
-    'merge-cells': string;
-    'unmerge-cells': string;
-    'delete-row': string;
-    'delete-column': string;
-    'delete-table': string;
     'default-link-text': string;
     basicblock: string;
     linkplaceholder: string;

package/types/config/i18n/zh-cn.d.ts

@@ -30,19 +30,6 @@ export declare const ZH_CN: {
     'scroll-table': string;
     'mouse-wheel': string;
     save: string;
-    'copy-cells': string;
-    'copy-table': string;
-    'cut-cells': string;
-    'empty-cells': string;
-    'insert-row-up': string;
-    'insert-row-down': string;
-    'insert-column-left': string;
-    'insert-column-right': string;
-    'merge-cells': string;
-    'unmerge-cells': string;
-    'delete-row': string;
-    'delete-column': string;
-    'delete-table': string;
     'default-link-text': string;
     basicblock: string;
     linkplaceholder: string;

package/types/config/index.d.ts

@@ -1,6 +1,7 @@
 export * from './editor.config';
 export * from './editor.utils';
-export declare function inputFile(type: any, accept: any): void;
+export * from './types';
+export declare function inputFile(type: 'image' | 'video' | 'file', accept: string[]): void;
 export declare function getListValue(value: any, preListValue: any): any;
 /** css namespace */
 export declare const namespace = "fe";

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

@@ -1,38 +1,12 @@
 import { QuillOptions } from 'quill';
 import { ScreenShotOptions } from '../../tools/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?: {
-        imageUpload?: ({ file, callback, editor }: {
-            file: any;
-            callback: any;
-            editor: any;
-        }) => void;
-        imageAccept?: Array<string>[] | string;
-        fileAccept?: Array<string>[] | string;
-        fileUpload: ({ file, callback, editor }: {
-            file: any;
-            callback: any;
-            editor: any;
-        }) => void;
-        isVideoPlay?: boolean;
-        maxSize?: number;
-        success?: (file: File) => void;
-        fail?: (file: File) => void;
-        multiple?: boolean;
-    };
     screenshot?: Partial<ScreenShotOptions>;
-    i18n?: {
-        lang?: string;
-        langText?: Record<string, string>;
-    };
 }

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

@@ -1,20 +1,27 @@
-import { ToolbarOption } from './type';
+import { ToolbarProps } from 'quill/modules/toolbar';
+import { I18NOptions, ICounterOption, MentionOption, ShortCutKeyInputOptions } from '../../modules';
+import { BlotFormatterOptionsInput } from '../../modules/custom-image/options';
+import { FileUploaderOptions } from '../../modules/custom-uploader';
+import { EmojiModuleOptions } from '../../modules/emoji';
 
+export type ToolbarOptions = {
+    container?: HTMLElement | (Record<string, any>[] | string[] | (string | Record<string, any>)[])[];
+} & ToolbarProps;
 export interface IEditorModules {
     [key: string]: any;
-    clipboard?: {
+    'clipboard'?: {
         matchers?: any[];
         matchVisual?: boolean;
     } | boolean;
-    history?: {
+    'history'?: {
         delay?: number;
         maxStack?: number;
         userOnly?: boolean;
     } | boolean;
-    keyboard?: {
+    'keyboard'?: {
         bindings?: any;
     } | boolean;
-    syntax?: {
+    'syntax'?: {
         interval?: number;
         languages?: {
             key: string;
@@ -22,10 +29,14 @@ export interface IEditorModules {
         }[];
         hljs?: any;
     } | boolean;
-    toolbar?: (string | string[])[][] | ToolbarOption | string | {
-        container?: string | string[] | ToolbarOption;
-        handlers?: {
-            [key: string]: any;
-        };
-    } | boolean;
+    'toolbar'?: boolean | ToolbarOptions | ToolbarOptions['container'] | string[];
+    'uploader'?: boolean | Partial<FileUploaderOptions>;
+    'shortcut-key'?: boolean | Partial<ShortCutKeyInputOptions>;
+    'mention'?: boolean | MentionOption;
+    'i18n'?: boolean | Partial<I18NOptions>;
+    'counter'?: boolean | ICounterOption;
+    'emoji'?: boolean | EmojiModuleOptions;
+    'file'?: boolean;
+    'mathlive'?: boolean;
+    'image'?: boolean | Partial<BlotFormatterOptionsInput>;
 }

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

@@ -1,23 +1,3 @@
-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/type.d.ts

@@ -1,6 +1,2 @@
-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;
 export type Constructor<T = any, U extends Array<any> = any[]> = new (...args: U) => T;

package/types/core/fluent-editor.d.ts

@@ -1,13 +1,14 @@
 import { ExpandedQuillOptions, default as Quill } from 'quill';
 import { IEditorConfig } from '../config/types';
+import { FileUploader } from '../modules/custom-uploader';
 
 declare class FluentEditor extends Quill {
     isFullscreen: boolean;
     options: IEditorConfig & ExpandedQuillOptions;
+    uploader: FileUploader;
     static register(...args: any[]): void;
     get lang(): string;
     constructor(container: HTMLElement | string, options?: IEditorConfig);
-    getLangText(name: string): any;
+    getLangText(name: string): string;
 }
-export type { Module, Parchment as TypeParchment, } from 'quill';
 export default FluentEditor;

package/types/formats/emoji.d.ts

@@ -0,0 +1,9 @@
+import { default as TypeInline } from 'quill/blots/inline';
+
+declare const Inline: typeof TypeInline;
+export declare class EmojiBlot extends Inline {
+    static blotName: string;
+    static tagName: string;
+    static className: string;
+}
+export {};

package/types/formats/index.d.ts

@@ -0,0 +1,4 @@
+export * from './emoji';
+export * from './soft-break';
+export * from './strike';
+export * from './video';

package/types/formats/soft-break.d.ts

@@ -1,14 +1,13 @@
-declare const Embed: unknown;
-declare class SoftBreak extends Embed {
+import { default as TypeEmbed } from 'quill/blots/embed';
+
+declare const Embed: typeof TypeEmbed;
+export declare class SoftBreak extends Embed {
     static blotName: string;
     static tagName: string;
     static className: string;
-    domNode: any;
-    prev: any;
-    next: any;
     remove: () => void;
-    static create(): any;
+    static create(): Node;
     optimize(): void;
     length(): number;
 }
-export default SoftBreak;
+export {};

package/types/formats/strike.d.ts

@@ -1,7 +1,9 @@
-declare const Inline: unknown;
-declare class StrikeBlot extends Inline {
+import { default as TypeInline } from 'quill/blots/inline';
+
+declare const Inline: typeof TypeInline;
+export declare class StrikeBlot extends Inline {
     static blotName: string;
-    static className: string;
     static tagName: string;
+    static className: string;
 }
-export default StrikeBlot;
+export {};

package/types/formats/video.d.ts

@@ -1,16 +1,14 @@
-import { Parchment as TypeParchment } from 'quill';
+import { BlockEmbed as TypeBlockEmbed } from 'quill/blots/block';
 
-declare const BlockEmbed: TypeParchment.BlotConstructor;
-declare class Video extends BlockEmbed {
+declare const BlockEmbed: typeof TypeBlockEmbed;
+export declare class Video extends BlockEmbed {
     static blotName: string;
     static tagName: string;
     static SANITIZED_URL: string;
     static PROTOCOL_WHITELIST: string[];
     static className: string;
-    statics: any;
-    domNode: any;
     static sanitize(url: any): any;
     static create(value: any): HTMLElement;
     static value(domNode: any): any;
 }
-export default Video;
+export {};

package/types/index.d.ts

@@ -1,7 +1,9 @@
 import { default as FluentEditor } from './fluent-editor';
 
-export * from './config';
-export * from './modules/table-up';
-export * from './modules/toolbar/toolbar-tip';
+export * from './attributors';
+export * from './config/types';
+export * from './formats';
+export * from './modules';
 export { generateTableUpShortKeyMenu } from 'quill-shortcut-key';
 export default FluentEditor;
+export { AttributeMap, Delta, Op, OpIterator, Parchment, Range } from 'quill/core';

package/types/modules/counter.d.ts

@@ -1,6 +1,13 @@
-import { ICounterOption } from '../config/types';
+import { AnyFunction } from '../config';
 import { default as FluentEditor } from '../fluent-editor';
 
+export interface ICounterOption {
+    format?: 'text' | 'html';
+    unit?: 'word' | 'char';
+    count?: number;
+    template?: string | AnyFunction;
+    errorTemplate?: string | AnyFunction;
+}
 export default class Counter {
     quill: FluentEditor;
     container: HTMLDivElement;
@@ -9,7 +16,7 @@ export default class Counter {
     resolveOptions(options: ICounterOption): {
         format: string;
         unit: string;
-        template: any;
+        template: string;
         count: number;
     } & ICounterOption;
     renderCount: () => void;

package/types/modules/custom-clipboard.d.ts

@@ -2,12 +2,9 @@ import { default as TypeClipboard } from 'quill/modules/clipboard';
 import { default as FluentEditor } from '../fluent-editor';
 
 declare const Clipboard: typeof TypeClipboard;
-declare class CustomClipboard extends Clipboard {
+export declare class CustomClipboard extends Clipboard {
     quill: FluentEditor;
-    convert: any;
-    onCopy: any;
-    matchers: any;
-    prepareMatching(container: any, nodeMatches: any): any[][];
+    prepareMatching(container: HTMLElement, nodeMatches: any): any[][];
     onCaptureCopy(e: any, isCut?: boolean): void;
     onCapturePaste(e: ClipboardEvent): void;
     onPaste(range: any, { html, text, files: clipboardFiles, rtf }: {
@@ -16,7 +13,7 @@ declare class CustomClipboard extends Clipboard {
         files: any;
         rtf: any;
     }): void;
-    files2urls(files: any, placeholders: any, originalUrls: any, pastedDelta: any, imageIndexs: any): Promise<any[]>;
+    files2urls(files: File[], placeholders: any, originalUrls: any, pastedDelta: any, imageIndexs: any): Promise<unknown[]>;
     flipFilesArray(filesArr: any): any[][];
     convertHexToBase64(hexString: any): string;
     extractImageDataFromRtf(rtfData: any): any[];
@@ -26,4 +23,4 @@ declare class CustomClipboard extends Clipboard {
         length: number;
     };
 }
-export default CustomClipboard;
+export {};