@ones-editor/editor 2.3.4 → 2.4.0

package/@ones-editor/sharedb-doc/src/doc/auth-connection.d.ts

@@ -1,50 +1,60 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
-import { Connection, Doc } from 'sharedb/lib/client';
-import ReconnectingWebSocket, { Event } from 'reconnecting-websocket';
-import { AuthMessage, ReauthFunc } from '../types';
+import { Doc } from 'sharedb/lib/client';
+import { TypedEmitter } from 'tiny-typed-emitter';
+import { AuthMessage, RenewTokenFunc } from '../types';
 import './sharedb-ext';
-export declare class AuthConnection {
+export interface AutoConnectionEvents {
+    renewingToken: (count: number) => void;
+    renewedToken: (auth: AuthMessage) => void;
+    renewTokenError: (error: Error) => void;
+    reauthing: (count: number) => void;
+    authError: (error: Error) => void;
+    authRecover: (auth: AuthMessage) => void;
+    unknownError: (error: Error) => void;
+    connectionError: (error: Error) => void;
+    disconnected: (reason: string) => void;
+    writeConflictError: (error: Error) => void;
+    maxUsersError: () => void;
+    requestReloadError: (error: Error) => void;
+    ready: () => void;
+}
+export declare class AuthConnection extends TypedEmitter<AutoConnectionEvents> {
     url: string;
-    private reauthFunc?;
-    enabled: boolean;
-    connection?: Connection;
-    ws?: ReconnectingWebSocket;
-    retryCount: number;
-    events: EventEmitter;
-    token: string | null;
-    resourceToken: string | null;
+    private renewTokenFunc?;
+    private closed;
+    private connection?;
+    private ws?;
+    private token;
+    private resourceToken;
+    private authMessage;
+    private autoRenewToken;
+    private connectionStatus;
+    private reauthing;
+    private ready;
     pingOptions: {
         interval: number;
         timeout: number;
     };
-    constructor(url: string, reauthFunc?: ReauthFunc | undefined);
+    constructor(authMessage: AuthMessage, url: string, renewTokenFunc?: RenewTokenFunc | undefined);
     getBaseURL(): string;
     getBase64BaseURL(): string;
-    auth(auth: AuthMessage): Promise<{
+    getToken(): string;
+    getResourceToken(): string;
+    getAuthMessage(): AuthMessage;
+    verifyAuth(authMessage: AuthMessage): Promise<{
         read: string;
         user: string;
     }>;
     logout(): Promise<void>;
-    init(auth: AuthMessage): Promise<void>;
-    reConnect(token: string): Promise<void>;
-    _autoReAuth(): Promise<void>;
-    autoReAuth(): Promise<void>;
-    handleAuthError(): Promise<void>;
-    reAuth: () => Promise<void>;
+    init(): Promise<void>;
+    private handleAuthError;
+    private handleUnknownError;
+    private handleConnectionError;
+    private handleDisconnected;
     private emitPermissionError;
-    private emitAuthRecover;
-    private emitAuthError;
     private emitRequestReloadError;
     private emitWriteConflictError;
     private emitMaxUsersError;
-    handleMessage(message: object): void;
+    private handleMessage;
     get(collectionName: string, documentID: string): Doc;
-    addEventListener(event: 'open' | 'close' | 'error', callback: (e: Event | Error) => void): void;
-    onAuthError(callback: (error: Error) => void): void;
-    onAuthRecover(callback: () => void): void;
-    onWriteConflictError(callback: (error: Error) => void): void;
-    onMaxUsersError(callback: () => void): void;
-    onRequestReloadError(callback: (error: Error) => void): void;
     end(logout: boolean): void;
 }

package/@ones-editor/sharedb-doc/src/doc/auto-renew-token.d.ts

@@ -0,0 +1,16 @@
+import { TypedEmitter } from 'tiny-typed-emitter';
+import { AuthMessage, RenewTokenFunc } from '../types';
+export interface AutoRenewTokenEvents {
+    'renewingToken': (count: number) => void;
+    'renewedToken': (auth: AuthMessage) => void;
+    'renewTokenError': (error: Error) => void;
+}
+export declare class AutoRenewToken extends TypedEmitter<AutoRenewTokenEvents> {
+    private renewToken;
+    private retryCount;
+    private stop;
+    private running;
+    constructor(renewToken: RenewTokenFunc);
+    start(): Promise<void>;
+    destroy(): void;
+}

package/@ones-editor/sharedb-doc/src/doc/connection-status.d.ts

@@ -0,0 +1,19 @@
+import { Connection, Error as ShareDBError } from 'sharedb/lib/client';
+import type { ConnectionState } from 'sharedb/lib/sharedb';
+import { TypedEmitter } from 'tiny-typed-emitter';
+export interface ConnectionStatusEvents {
+    'connectionError': (error: ShareDBError) => void;
+    'unknownError': (error: ShareDBError) => void;
+    'disconnected': (reason: string) => void;
+}
+export declare class ConnectionStatus extends TypedEmitter<ConnectionStatusEvents> {
+    private connection;
+    constructor(connection: Connection);
+    handleClosed: () => void;
+    handleCommonError: (error: ShareDBError) => void;
+    handleConnecting: () => void;
+    handleConnected: () => void;
+    handleConnectionError: (error: ShareDBError) => void;
+    handleStateChanged: (newState: ConnectionState, reason: string) => void;
+    destroy(): void;
+}

package/@ones-editor/sharedb-doc/src/doc/edit-status.d.ts

@@ -0,0 +1,13 @@
+export interface EditStatusOptions {
+    dirtyTimeout?: number;
+    onDirtyTimeoutError?: () => void;
+    onClean?: () => void;
+}
+export declare class EditStatus {
+    private options;
+    private dirtyTimeout;
+    private waitingForSave;
+    constructor(options: EditStatusOptions);
+    setStatus(status: 'clean' | 'dirty'): void;
+    destroy(): void;
+}

package/@ones-editor/sharedb-doc/src/doc/sharedb-client.d.ts

@@ -1,34 +1,28 @@
 import { BuildResourceUrlOptions, DocVersion, OnesEditorDocVersionExtra } from '../../../../@ones-editor/core';
 import { Doc } from 'sharedb/lib/client';
-import { Event } from 'reconnecting-websocket';
 import type { AxiosResponse } from 'axios';
 import { AuthConnection } from './auth-connection';
-import { EditorDoc, ReauthFunc, AuthMessage, OnProgress, EditorOp, LinkDetails } from '../types';
+import { EditorDoc, RenewTokenFunc, AuthMessage, OnProgress, EditorOp, LinkDetails } from '../types';
 export default class ShareDBClient {
     connection: AuthConnection;
-    auth: AuthMessage;
     private doc;
     private reauthFunc?;
-    clientId: string;
-    constructor(auth: AuthMessage, serverUrl: string, reauthFunc?: ReauthFunc);
+    private _clientId;
+    constructor(auth: AuthMessage, serverUrl: string, reauthFunc?: RenewTokenFunc);
+    get clientId(): string;
     token(): string;
     resourceToken(): string;
+    authMessage(): AuthMessage;
     docId(): string;
     editorServer(): string;
     close(logout: boolean): void;
-    on(event: 'open' | 'close' | 'error', callback: (event: Event | Error) => void): void;
-    onAuthError(callback: (error: Error) => void): void;
-    onAuthRecover(callback: () => void): void;
-    onWriteConflictError(callback: (error: Error) => void): void;
-    onMaxUsersError(callback: () => void): void;
-    onRequestReloadError(callback: (error: Error) => void): void;
     /**
      * 根据Id生成一个文档对象，如果文档不存在，则创建一个新的。
      * @param id 待获取的containerId
      */
     getDoc: () => Promise<Doc<any>>;
     authOnly(): Promise<void>;
-    getResourceToken(): string | null;
+    getResourceToken(): string;
     hasDocContainer(): boolean;
     apiServer(): string;
     getFileUrlByHash(uploadFileUrl: string, hash: string, name: string, size: number, headers: {
@@ -57,5 +51,4 @@ export default class ShareDBClient {
     recognizeLink(url: string): Promise<LinkDetails>;
     getResourceId(url: string): string;
     buildResourceUrl(resourceId: string, options?: BuildResourceUrlOptions): string;
-    reAuth(auto?: boolean): void;
 }

package/@ones-editor/sharedb-doc/src/doc/sharedb-doc.d.ts

@@ -4,7 +4,9 @@ import { LocalPresence } from 'sharedb/lib/sharedb';
 import RemoteCaretsHandler from './remote-caret-handler';
 import { EditorDoc, ShareDBDocCallbacks, ShareDBDocOptions } from '../types';
 import ShareDBClient from './sharedb-client';
+import { EditStatus } from './edit-status';
 export default class ShareDBDoc extends EventCallbacks<ShareDBDocCallbacks> implements OnesEditorDoc, OnesEditorDocVersionHelper {
+    private options;
     doc: Doc;
     client: ShareDBClient;
     localPresence?: LocalPresence;
@@ -13,8 +15,8 @@ export default class ShareDBDoc extends EventCallbacks<ShareDBDocCallbacks> impl
     status: OnesEditorDocStatus;
     disableLogout: boolean;
     destroyed: boolean;
-    options: ShareDBDocOptions | null;
-    constructor(client: ShareDBClient, doc: Doc, disableLogout?: boolean);
+    editStatus: EditStatus;
+    constructor(options: ShareDBDocOptions, client: ShareDBClient, doc: Doc, disableLogout?: boolean);
     beginBatchUpdate(): number;
     endBatchUpdate(): number;
     static load(options: ShareDBDocOptions): Promise<ShareDBDoc>;
@@ -76,7 +78,6 @@ export default class ShareDBDoc extends EventCallbacks<ShareDBDocCallbacks> impl
     onCreateComment(commentId: string, local: boolean): void;
     onUpdateComment(commentId: string, local: boolean): void;
     onCustomMessage(msg: unknown): void;
-    onAuthRecover(): void;
     addResources(resourceIds: string[]): Promise<string[]>;
     uploadResource(file: File, options?: UploadResourceOptions): Promise<UploadResourceResult>;
     buildResourceUrl(resourceId: string, options?: BuildResourceUrlOptions): string;
@@ -108,5 +109,4 @@ export default class ShareDBDoc extends EventCallbacks<ShareDBDocCallbacks> impl
     recognizeLink(url: string): Promise<import("../types").LinkDetails>;
     parseHistoryData(historyData: OnesEditorDocHistoryData, handler: OnesEditorHistoryDataParseHandler): void;
     getServerMeta(): OnesEditorDocServerMeta;
-    triggerReAuth(auto?: boolean): void;
 }

package/@ones-editor/sharedb-doc/src/types.d.ts

@@ -1,4 +1,4 @@
-import { BuildResourceUrlOptions, DocBlock, DocComment, OnesEditorDocCallbacks, OnesEditorDocRange, OnesEditorUser, OnesEditorUserPermission, UploadResourceOptions, UploadResourceResult } from '../../../@ones-editor/core';
+import { BuildResourceUrlOptions, DocBlock, DocComment, OnesEditorDoc, OnesEditorDocCallbacks, OnesEditorDocRange, OnesEditorUser, OnesEditorUserPermission, UploadResourceOptions, UploadResourceResult } from '../../../@ones-editor/core';
 import { Op } from 'sharedb';
 export type { Op } from 'sharedb/lib/client';
 export type BlocksType = DocBlock[];
@@ -62,18 +62,33 @@ export declare const FileExtError: {
 };
 export declare const AuthHeader = "x-live-editor-token";
 export declare const BaseURLHeader = "x-live-editor-base-url";
-export type ReauthFunc = () => Promise<AuthMessage>;
+export type RenewTokenFunc = () => Promise<AuthMessage>;
 export type OnProgress = (percentage: number) => void;
 export interface ShareDBDocOptions {
     auth: AuthMessage;
     serverUrl: string;
-    reauthFunc?: ReauthFunc;
     autoCreateDoc?: boolean;
     templateData?: EditorDoc;
     disableLogout?: boolean;
+    dirtyTimeout?: number;
     onMaxUsersError?: () => void;
-    buildResourceUrl?: (resourceId: string, options?: BuildResourceUrlOptions) => string;
-    uploadResource?: (file: File, options?: UploadResourceOptions) => Promise<UploadResourceResult>;
+    onDirtyTimeoutError?: () => void;
+    onClean?: () => void;
+    onRenewingToken?: (count: number) => void;
+    onRenewedToken?: (auth: AuthMessage) => void;
+    onRenewTokenError?: (error: Error) => void;
+    onReauthing?: () => void;
+    onReauthError?: (error: Error) => void;
+    onReauthRecovered?: (auth: AuthMessage) => void;
+    onUnknownError?: (error: Error) => void;
+    onDisconnected?: (reason: string) => void;
+    onConnectionError?: (error: Error) => void;
+    onUploadResourceError?: (error: Error) => void;
+    onUploadResourceSuccess?: () => void;
+    renewTokenFunc?: RenewTokenFunc;
+    buildResourceUrl?: (doc: OnesEditorDoc, resourceId: string, options?: BuildResourceUrlOptions) => string;
+    uploadResource?: (doc: OnesEditorDoc, file: File, options?: UploadResourceOptions) => Promise<UploadResourceResult>;
+    onReady?: () => void;
 }
 export interface EditorOp {
     c: string;

package/@ones-editor/toc/src/toc-embed/render-toc.d.ts

@@ -1,3 +1,3 @@
 import { OnesEditor } from '../../../../@ones-editor/core';
 import { OnesEditorToc } from '../build-toc';
-export declare function renderToc(editor: OnesEditor, parent: HTMLElement, toc: OnesEditorToc): void;
+export declare function renderToc(editor: OnesEditor, parent: HTMLElement, toc: OnesEditorToc, hiddenHeadings?: Set<string>): void;