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

package/types/modules/ai/types.d.ts

@@ -1,16 +1,16 @@
-export interface OperationMenuItem {
-    id: string;
-    text: string;
-    icon?: string;
-}
-export interface ResultMenuItem {
-    text: string;
-    icon: string;
-    selectText?: string;
-}
-export interface AIOptions {
-    host?: string;
-    apiKey: string;
-    model?: string;
-    contentMaxLength?: number;
-}
+export interface OperationMenuItem {
+    id: string;
+    text: string;
+    icon?: string;
+}
+export interface ResultMenuItem {
+    text: string;
+    icon: string;
+    selectText?: string;
+}
+export interface AIOptions {
+    host?: string;
+    apiKey: string;
+    model?: string;
+    contentMaxLength?: number;
+}

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

@@ -1,29 +1,28 @@
 import { default as QuillCursors } from 'quill-cursors';
 import { Awareness } from 'y-protocols/awareness';
 import { default as FluentEditor } from '../../../core/fluent-editor';
-
-import * 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): (() => void) | void;
+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/index.d.ts

@@ -1,2 +1,2 @@
-export * from './awareness';
-export * from './y-indexeddb';
+export * from './awareness';
+export * from './y-indexeddb';

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

@@ -1,3 +1,3 @@
-import { Doc } from 'yjs';
-
-export declare function setupIndexedDB(doc: Doc): () => void;
+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

@@ -1,25 +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 { default as QuillCursors } from 'quill-cursors';
-import { Awareness } from 'y-protocols/awareness';
-
-import * as Y from 'yjs';
-export declare class CollaborativeEditor {
-    quill: FluentEditor;
-    options: YjsOptions;
-    private ydoc;
-    private provider;
-    private awareness;
-    private cursors;
-    private cleanupBindings;
-    private clearIndexedDB;
-    constructor(quill: FluentEditor, options: YjsOptions);
-    getAwareness(): Awareness;
-    getProvider(): UnifiedProvider;
-    getYDoc(): Y.Doc;
-    get isConnected(): boolean;
-    get isSynced(): boolean;
-    getCursors(): QuillCursors;
-    destroy(): Promise<void>;
-}
+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/index.d.ts

@@ -1,2 +1,2 @@
-export * from './module';
-export * from './types';
+export * from './module';
+export * from './types';

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

@@ -1,12 +1,11 @@
 import { default as FluentEditor } from '../../fluent-editor';
-
-export declare class CollaborationModule {
-    quill: FluentEditor;
-    options: any;
-    private collaborativeEditor;
-    constructor(quill: FluentEditor, options: any);
-    getCursors(): import('quill-cursors').default;
-    getAwareness(): import('y-protocols/awareness').Awareness;
-    getProvider(): import('./provider').UnifiedProvider;
-    destroy(): Promise<void>;
-}
+export declare class CollaborationModule {
+    quill: FluentEditor;
+    options: any;
+    private collaborativeEditor;
+    constructor(quill: FluentEditor, options: any);
+    getCursors(): import('quill-cursors').default;
+    getAwareness(): import('y-protocols/awareness').Awareness;
+    getProvider(): import('./provider').UnifiedProvider;
+    destroy(): Promise<void>;
+}

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

@@ -1,3 +1,3 @@
-export * from './providerRegistry';
-export * from './webrtc';
-export * from './websocket';
+export * from './providerRegistry';
+export * from './webrtc';
+export * from './websocket';

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

@@ -1,26 +1,26 @@
 import { Awareness } from 'y-protocols/awareness';
-import { 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;
-} & 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;
+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

@@ -1,37 +1,37 @@
 import { Awareness } from 'y-protocols/awareness';
-import { ProviderEventHandlers } from '../types';
-import { UnifiedProvider } from './providerRegistry';
 import { WebrtcProvider } from 'y-webrtc';
-
-import * 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, }: {
-        options: WebRTCProviderOptions;
-        awareness?: Awareness;
-        doc?: Y.Doc;
-    } & ProviderEventHandlers);
-    get isConnected(): boolean;
-    get isSynced(): boolean;
-    getProvider(): WebrtcProvider;
-}
+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

@@ -1,41 +1,41 @@
-import { ProviderEventHandlers } from '../types';
-import { UnifiedProvider } from './providerRegistry';
 import { Awareness } from 'y-protocols/awareness';
 import { WebsocketProvider } from 'y-websocket';
-
-import * as Y from 'yjs';
-export interface WebsocketProviderOptions {
-    serverUrl: string;
-    roomName: string;
-    connect?: boolean;
-    awareness?: any;
-    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, }: {
-        options: WebsocketProviderOptions;
-        awareness?: Awareness;
-        doc?: Y.Doc;
-    } & ProviderEventHandlers);
-    get isConnected(): boolean;
-    get isSynced(): boolean;
-    getProvider(): WebsocketProvider;
-}
+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

@@ -1,37 +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 YjsOptions {
-    ydoc?: Y.Doc;
-    provider: (WebRTCProviderConfig | WebsocketProviderConfig | CustomProviderConfig);
-    awareness?: AwarenessOptions;
-    offline?: boolean;
-    cursors?: CursorsConfig;
-    onConnect?: () => void;
-    onDisconnect?: () => void;
-    onError?: (error: any) => void;
-    onSyncChange?: (isSynced: boolean) => void;
-}
+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/counter.d.ts

@@ -1,24 +1,23 @@
 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;
-    options: ICounterOption;
-    constructor(quill: FluentEditor, options: ICounterOption);
-    resolveOptions(options: ICounterOption): {
-        format: string;
-        unit: string;
-        template: string;
-        count: number;
-    } & ICounterOption;
-    renderCount: () => void;
-    getContentLength(format: any): number;
-}
+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;
+    options: ICounterOption;
+    constructor(quill: FluentEditor, options: ICounterOption);
+    resolveOptions(options: ICounterOption): {
+        format: string;
+        unit: string;
+        template: string;
+        count: number;
+    } & ICounterOption;
+    renderCount: () => void;
+    getContentLength(format: any): number;
+}

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

@@ -1,26 +1,25 @@
 import { default as TypeClipboard } from 'quill/modules/clipboard';
 import { default as FluentEditor } from '../fluent-editor';
-
-declare const Clipboard: typeof TypeClipboard;
-export declare class CustomClipboard extends Clipboard {
-    quill: FluentEditor;
-    prepareMatching(container: HTMLElement, nodeMatches: any): any[][];
-    onCaptureCopy(e: any, isCut?: boolean): void;
-    onCapturePaste(e: ClipboardEvent): void;
-    onPaste(range: any, { html, text, files: clipboardFiles, rtf }: {
-        html: any;
-        text: any;
-        files: any;
-        rtf: any;
-    }): void;
-    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[];
-    extractFilesFromDelta(delta: any, clipboardFiles: any, hexImages?: any): Promise<any[]>;
-    getImgSelection(delta: any, imageIndex: any): {
-        index: number;
-        length: number;
-    };
-}
-export {};
+declare const Clipboard: typeof TypeClipboard;
+export declare class CustomClipboard extends Clipboard {
+    quill: FluentEditor;
+    prepareMatching(container: HTMLElement, nodeMatches: any): any[][];
+    onCaptureCopy(e: any, isCut?: boolean): void;
+    onCapturePaste(e: ClipboardEvent): void;
+    onPaste(range: any, { html, text, files: clipboardFiles, rtf }: {
+        html: any;
+        text: any;
+        files: any;
+        rtf: any;
+    }): void;
+    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[];
+    extractFilesFromDelta(delta: any, clipboardFiles: any, hexImages?: any): Promise<any[]>;
+    getImgSelection(delta: any, imageIndex: any): {
+        index: number;
+        length: number;
+    };
+}
+export {};

package/types/modules/custom-image/actions/action.d.ts

@@ -1,9 +1,8 @@
 import { BlotFormatter } from '../blot-formatter';
-
-export declare class Action {
-    formatter: BlotFormatter;
-    constructor(formatter: BlotFormatter);
-    onCreate(): void;
-    onDestroy(): void;
-    onUpdate(): void;
-}
+export declare class Action {
+    formatter: BlotFormatter;
+    constructor(formatter: BlotFormatter);
+    onCreate(): void;
+    onDestroy(): void;
+    onUpdate(): void;
+}