@opentiny/fluent-editor 4.0.0-alpha.8 → 4.0.0-beta.0

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

@@ -0,0 +1,55 @@
+export declare const BIG_DELTA_LIMIT = 2000;
+export declare const CHANGE_LANGUAGE_EVENT = "change-language";
+export declare const defaultLanguage = "en-US";
+export declare const IMAGE_UPLOADER_MIME_TYPES: string[];
+export declare const OTHER_FILE_UPLOADER_MIME_TYPES: string[];
+export declare const AUDIO_VIDEO_UPLOADER_MIME_TYPES: string[];
+export declare const DOC_UPLOADER_MIME_TYPES: string[];
+export declare const XSL_UPLOADER_MIME_TYPES: string[];
+export declare const PPT_UPLOADER_MIME_TYPES: string[];
+export declare const COMPRESSED_UPLOADER_MIME_TYPES: string[];
+export declare const FILE_UPLOADER_MIME_TYPES: string[];
+export declare const DEFAULT_TOOLBAR: (string[] | {
+    header: any[];
+}[] | {
+    list: string;
+}[])[];
+export declare const FULL_TOOLBAR: (({
+    header: (number | boolean)[];
+    font?: undefined;
+    size?: undefined;
+    'line-height'?: undefined;
+} | {
+    font: (string | boolean)[];
+    header?: undefined;
+    size?: undefined;
+    'line-height'?: undefined;
+} | {
+    size: (string | boolean)[];
+    header?: undefined;
+    font?: undefined;
+    'line-height'?: undefined;
+} | {
+    'line-height': (string | boolean)[];
+    header?: undefined;
+    font?: undefined;
+    size?: undefined;
+})[] | ({
+    color: any[];
+    background?: undefined;
+} | {
+    background: any[];
+    color?: undefined;
+})[] | {
+    align: string;
+}[] | {
+    list: string;
+}[] | {
+    script: string;
+}[] | {
+    indent: string;
+}[] | {
+    direction: string;
+}[] | (string | {
+    'table-up': any[];
+})[])[];

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

@@ -0,0 +1,125 @@
+export declare const 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;
+    '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;
+    'mind-map': string;
+    'flow-chart': 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;
+};

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

@@ -0,0 +1,125 @@
+export declare const 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;
+    '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;
+    'mind-map': string;
+    'flow-chart': 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;
+};

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

@@ -0,0 +1,45 @@
+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';
+import { FlowChartOptions } from '../../modules/flow-chart/options';
+import { MindMapOptions } from '../../modules/mind-map/options';
+export type ToolbarOptions = {
+    container?: HTMLElement | (Record<string, any>[] | string[] | (string | Record<string, any>)[])[];
+} & ToolbarProps;
+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'?: 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>;
+    'mind-map'?: boolean | Partial<MindMapOptions>;
+    'flow-chart'?: boolean | Partial<FlowChartOptions>;
+}

package/types/index.d.ts

@@ -0,0 +1,8 @@
+import { default as FluentEditor } from './fluent-editor';
+export * from './attributors';
+export * from './config';
+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/collaborative-editing/awareness/awareness.d.ts

@@ -0,0 +1,28 @@
+import { default as QuillCursors } from 'quill-cursors';
+import { Awareness } from 'y-protocols/awareness';
+import { default as FluentEditor } from '../../../core/fluent-editor';
+import type * as Y from 'yjs';
+export interface AwarenessState {
+    name?: string;
+    color?: string;
+}
+export interface AwarenessEvents {
+    change?: (changes: {
+        added: number[];
+        updated: number[];
+        removed: number[];
+    }, transactionOrigin: any) => void;
+    update?: ({ added, updated, removed }: {
+        added: number[];
+        updated: number[];
+        removed: number[];
+    }, origin: any) => void;
+    destroy?: () => void;
+}
+export interface AwarenessOptions {
+    state?: AwarenessState;
+    events?: AwarenessEvents;
+    timeout?: number | undefined;
+}
+export declare function setupAwareness(options?: AwarenessOptions, defaultAwareness?: Awareness): Awareness | null;
+export declare function bindAwarenessToCursors(awareness: Awareness, cursorsModule: QuillCursors, quill: FluentEditor, yText: Y.Text, Yjs: typeof Y): (() => void) | void;

package/types/modules/collaborative-editing/awareness/y-indexeddb.d.ts

@@ -0,0 +1,3 @@
+import { IndexeddbPersistence } from 'y-indexeddb';
+import type * as Y from 'yjs';
+export declare function setupIndexedDB(doc: Y.Doc, IndexeddbPersistenceClass?: typeof IndexeddbPersistence): () => void;

package/types/modules/collaborative-editing/collaborative-editing.d.ts

@@ -0,0 +1,25 @@
+import { default as QuillCursors } from 'quill-cursors';
+import { Awareness } from 'y-protocols/awareness';
+import { default as FluentEditor } from '../../fluent-editor';
+import { UnifiedProvider } from './provider/providerRegistry';
+import { YjsOptions } from './types';
+import type * as Y from 'yjs';
+export declare class CollaborativeEditor {
+    quill: FluentEditor;
+    options: YjsOptions;
+    private ydoc;
+    private provider;
+    private awareness;
+    private cursors;
+    private cleanupBindings;
+    private clearIndexedDB;
+    private deps;
+    constructor(quill: FluentEditor, options: YjsOptions);
+    getAwareness(): Awareness;
+    getProvider(): UnifiedProvider;
+    getYDoc(): Y.Doc;
+    get isConnected(): boolean;
+    get isSynced(): boolean;
+    getCursors(): QuillCursors;
+    destroy(): Promise<void>;
+}

package/types/modules/collaborative-editing/provider/providerRegistry.d.ts

@@ -0,0 +1,26 @@
+import { Awareness } from 'y-protocols/awareness';
+import { CollaborativeEditingDeps, ProviderEventHandlers } from '../types';
+import type * as Y from 'yjs';
+export type ProviderRegistry = Record<string, ProviderConstructor>;
+export type ProviderConstructor<T = any> = new (props: ProviderConstructorProps<T>) => UnifiedProvider;
+export type ProviderConstructorProps<T = any> = {
+    options: T;
+    awareness?: Awareness;
+    doc?: Y.Doc;
+    deps?: CollaborativeEditingDeps;
+} & ProviderEventHandlers;
+export interface UnifiedProvider extends ProviderEventHandlers {
+    awareness: Awareness;
+    document: Y.Doc;
+    type: 'webrtc' | 'websocket' | string;
+    connect: () => void;
+    destroy: () => void;
+    disconnect: () => void;
+    isConnected: boolean;
+    isSynced: boolean;
+}
+export declare function registerProviderType<T>(type: string, providerClass: ProviderConstructor<T>): void;
+export declare function getProviderClass(type: string): ProviderConstructor | undefined;
+export declare function createProvider({ type, ...props }: ProviderConstructorProps & {
+    type: string;
+}): UnifiedProvider;

package/types/modules/collaborative-editing/provider/webrtc.d.ts

@@ -0,0 +1,37 @@
+import { Awareness } from 'y-protocols/awareness';
+import { WebrtcProvider } from 'y-webrtc';
+import { CollaborativeEditingDeps, ProviderEventHandlers } from '../types';
+import { UnifiedProvider } from './providerRegistry';
+import type * as Y from 'yjs';
+export interface WebRTCProviderOptions {
+    roomName: string;
+    filterBcConns?: boolean;
+    maxConns?: number;
+    password?: string;
+    peerOpts?: Record<string, unknown>;
+    signaling?: string[];
+}
+export declare class WebRTCProviderWrapper implements UnifiedProvider {
+    private provider;
+    private _isConnected;
+    private _isSynced;
+    onConnect?: () => void;
+    onDisconnect?: () => void;
+    onError?: (error: Error) => void;
+    onSyncChange?: (isSynced: boolean) => void;
+    document: Y.Doc;
+    awareness: Awareness;
+    type: 'webrtc';
+    connect: () => void;
+    destroy: () => void;
+    disconnect: () => void;
+    constructor({ awareness, doc, options, onConnect, onDisconnect, onError, onSyncChange, deps, }: {
+        options: WebRTCProviderOptions;
+        awareness?: Awareness;
+        doc?: Y.Doc;
+        deps?: CollaborativeEditingDeps;
+    } & ProviderEventHandlers);
+    get isConnected(): boolean;
+    get isSynced(): boolean;
+    getProvider(): WebrtcProvider;
+}

package/types/modules/collaborative-editing/provider/websocket.d.ts

@@ -0,0 +1,41 @@
+import { Awareness } from 'y-protocols/awareness';
+import { WebsocketProvider } from 'y-websocket';
+import { CollaborativeEditingDeps, ProviderEventHandlers } from '../types';
+import { UnifiedProvider } from './providerRegistry';
+import type * as Y from 'yjs';
+export interface WebsocketProviderOptions {
+    serverUrl: string;
+    roomName: string;
+    connect?: boolean;
+    awareness?: Awareness;
+    params?: Record<string, string>;
+    protocols?: string[];
+    WebSocketPolyfill?: typeof WebSocket;
+    resyncInterval?: number;
+    maxBackoffTime?: number;
+    disableBc?: boolean;
+}
+export declare class WebsocketProviderWrapper implements UnifiedProvider {
+    private provider;
+    private _isConnected;
+    private _isSynced;
+    onConnect?: () => void;
+    onDisconnect?: () => void;
+    onError?: (error: Error) => void;
+    onSyncChange?: (isSynced: boolean) => void;
+    document: Y.Doc;
+    awareness: Awareness;
+    type: 'websocket';
+    connect: () => void;
+    destroy: () => void;
+    disconnect: () => void;
+    constructor({ awareness, doc, options, onConnect, onDisconnect, onError, onSyncChange, deps, }: {
+        options: WebsocketProviderOptions;
+        awareness?: Awareness;
+        doc?: Y.Doc;
+        deps?: CollaborativeEditingDeps;
+    } & ProviderEventHandlers);
+    get isConnected(): boolean;
+    get isSynced(): boolean;
+    getProvider(): WebsocketProvider;
+}

package/types/modules/collaborative-editing/types.d.ts

@@ -0,0 +1,53 @@
+import { default as QuillCursors } from 'quill-cursors';
+import { IndexeddbPersistence } from 'y-indexeddb';
+import { Awareness } from 'y-protocols/awareness';
+import { QuillBinding } from 'y-quill';
+import { WebrtcProvider } from 'y-webrtc';
+import { WebsocketProvider } from 'y-websocket';
+import { AwarenessOptions } from './awareness';
+import { WebRTCProviderOptions, WebsocketProviderOptions } from './provider';
+import type * as Y from 'yjs';
+export interface ProviderEventHandlers {
+    onConnect?: () => void;
+    onDisconnect?: () => void;
+    onError?: (error: Error) => void;
+    onSyncChange?: (isSynced: boolean) => void;
+}
+export interface BaseYjsProviderConfig extends ProviderEventHandlers {
+    options: Record<string, any>;
+    type: string;
+}
+export type WebRTCProviderConfig = BaseYjsProviderConfig & {
+    options: WebRTCProviderOptions;
+    type: 'webrtc';
+};
+export type WebsocketProviderConfig = BaseYjsProviderConfig & {
+    options: WebsocketProviderOptions;
+    type: 'websocket';
+};
+export type CustomProviderConfig = BaseYjsProviderConfig & {
+    options: Record<string, any>;
+    type: string;
+};
+export type CursorsConfig = boolean | object;
+export interface CollaborativeEditingDeps {
+    Y: typeof Y;
+    Awareness: typeof Awareness;
+    QuillBinding: typeof QuillBinding;
+    QuillCursors: typeof QuillCursors;
+    WebsocketProvider?: typeof WebsocketProvider;
+    WebrtcProvider?: typeof WebrtcProvider;
+    IndexeddbPersistence?: typeof IndexeddbPersistence;
+}
+export interface YjsOptions {
+    ydoc?: Y.Doc;
+    provider: (WebRTCProviderConfig | WebsocketProviderConfig | CustomProviderConfig);
+    awareness?: AwarenessOptions;
+    offline?: boolean;
+    cursors?: CursorsConfig;
+    deps?: CollaborativeEditingDeps;
+    onConnect?: () => void;
+    onDisconnect?: () => void;
+    onError?: (error: Error) => void;
+    onSyncChange?: (isSynced: boolean) => void;
+}

package/types/modules/flow-chart/config-utils.d.ts

@@ -0,0 +1,10 @@
+import { default as Quill } from 'quill';
+export declare function getGridConfig(quill: Quill | null): any;
+export declare function getBackgroundConfig(quill: Quill | null): false | object;
+export declare function getResizeConfig(quill: Quill | null): boolean;
+export declare function getAllConfigs(quill: Quill | null): {
+    gridConfig: any;
+    backgroundConfig: false | object;
+    resizeConfig: boolean;
+    deps?: any;
+};

package/types/modules/flow-chart/formats/flow-chart-blot.d.ts

@@ -0,0 +1,43 @@
+import { Root } from 'parchment';
+import { BlockEmbed as TypeBlockEmbed } from 'quill/blots/block';
+import { default as Quill } from 'quill';
+declare const BlockEmbed: typeof TypeBlockEmbed;
+declare class FlowChartPlaceholderBlot extends BlockEmbed {
+    static blotName: string;
+    static tagName: string;
+    static className: string;
+    quill: Quill | null;
+    flowChart: any | null;
+    data: any;
+    contextMenu: HTMLElement | null;
+    currentElement: any;
+    width: number;
+    height: number;
+    parentObserver: MutationObserver | null;
+    nextPObserver: MutationObserver | null;
+    constructor(scroll: Root, domNode: HTMLElement);
+    static value(domNode: HTMLElement): any;
+    static create(value: any): HTMLElement;
+    private static findQuill;
+    attach(): void;
+    initFlowChart(): void;
+    insertFlowChartEditor(): void;
+    addMouseHoverEvents(): void;
+    getControlElements(): {
+        leftUpControl: HTMLElement | null;
+        control: HTMLElement | null;
+        panelStatusIcon: HTMLElement | null;
+    };
+    showControlPanel(): void;
+    hideControlPanel(): void;
+    observeOwnParentChange(): void;
+    observeParentAlignment(): void;
+    updateAlignmentStyle(): void;
+    observeNextPElement(): void;
+    handleNodeDblClick(event: any): void;
+    createEditInput(nodeData: any, position: any, e: any): void;
+    updateText(nodeId: string, text: string): void;
+    destroyFlowChart(): void;
+    remove(): void;
+}
+export default FlowChartPlaceholderBlot;

package/types/modules/flow-chart/i18n/en-us.d.ts

@@ -0,0 +1,26 @@
+export declare const FLOW_CHART_EN_US: {
+    'flowChart.controlPanel.export': string;
+    'flowChart.controlPanel.import': string;
+    'flowChart.controlPanel.setEdgeTypeTitle': string;
+    'flowChart.dndPanel.selection': string;
+    'flowChart.dndPanel.rectangle': string;
+    'flowChart.dndPanel.circle': string;
+    'flowChart.dndPanel.ellipse': string;
+    'flowChart.dndPanel.diamond': string;
+    'flowChart.controlPanel.zoomOut': string;
+    'flowChart.controlPanel.zoomIn': string;
+    'flowChart.controlPanel.fit': string;
+    'flowChart.controlPanel.back': string;
+    'flowChart.controlPanel.forward': string;
+    'flowChart.controlPanel.zoomOutTitle': string;
+    'flowChart.controlPanel.zoomInTitle': string;
+    'flowChart.controlPanel.fitTitle': string;
+    'flowChart.controlPanel.backTitle': string;
+    'flowChart.controlPanel.forwardTitle': string;
+    'flowChart.contextMenu.copy': string;
+    'flowChart.contextMenu.deleteContent': string;
+    'flowChart.contextMenu.deleteNode': string;
+    'flowChart.contextMenu.deleteEdge': string;
+    'flowChart.controlPanel.panelStatusTitle': string;
+    'flowChart.controlPanel.screenTypeTitle': string;
+};

package/types/modules/flow-chart/i18n/index.d.ts

@@ -0,0 +1 @@
+export declare function registerFlowChartI18N(I18N: any): void;