@ones-editor/editor 2.3.2 → 2.3.4

package/@ones-editor/media-embed/src/types.d.ts

@@ -1,4 +1,4 @@
-import type { OnesEditor, DocEmbedBlock, DocEmbedData } from '../../../@ones-editor/core';
+import type { OnesEditor, DocEmbedBlock, DocEmbedData, BlockElement } from '../../../@ones-editor/core';
 import { MediaType } from './constant';
 export type MediaKeys = `${MediaType}`;
 export interface MediaEmbedOptions {
@@ -11,6 +11,7 @@ export interface MediaEmbedOptions {
     callbacks?: {
         onError?: (editor: OnesEditor, error: Error) => void;
     };
+    onMediaPreview?: (editor: OnesEditor, block: BlockElement, itemId: string) => void;
 }
 export interface MediaEmbedData extends DocEmbedData {
     fileName?: string;

package/@ones-editor/misc/src/index.d.ts

@@ -1,3 +1,4 @@
 export * from './image';
 export * from './title';
 export * from './image-downloader';
+export * from './re-auth';

package/@ones-editor/misc/src/re-auth/index.d.ts

@@ -0,0 +1,23 @@
+import { TypedEmitter } from 'tiny-typed-emitter';
+import { OnesEditor, OnesEditorCustom, OnesEditorDocCallbacks } from '../../../../@ones-editor/core';
+import ReAuthToolbar from './ui/toolbar';
+import './locale';
+type EventCallback = (() => void) | undefined;
+declare const DOC_RE_AUTH_KEYS = "doc-re-auth-event";
+type ReAuthEvent = {
+    tokenExpired: () => void;
+};
+declare class DocReAuthCallbacks extends TypedEmitter<ReAuthEvent> implements OnesEditorCustom, OnesEditorDocCallbacks {
+    private editor;
+    private authErrorCallback;
+    private authRecoverCallback;
+    reAuthToolbar: ReAuthToolbar;
+    constructor(editor: OnesEditor);
+    handleReAuth: () => void;
+    addAuthListen(event: 'authError' | 'authRecover', callback: EventCallback): void;
+    removeListeners(): void;
+    destroy: () => void;
+    onError: (error: Error) => void;
+    onAuthRecover: () => void;
+}
+export { ReAuthToolbar, DocReAuthCallbacks, DOC_RE_AUTH_KEYS, };

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

@@ -1,60 +1,50 @@
-import { Doc } from 'sharedb/lib/client';
-import { TypedEmitter } from 'tiny-typed-emitter';
-import { AuthMessage, RenewTokenFunc } from '../types';
+/// <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 './sharedb-ext';
-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> {
+export declare class AuthConnection {
     url: string;
-    private renewTokenFunc?;
-    private closed;
-    private connection?;
-    private ws?;
-    private token;
-    private resourceToken;
-    private authMessage;
-    private autoRenewToken;
-    private connectionStatus;
-    private reauthing;
-    private ready;
+    private reauthFunc?;
+    enabled: boolean;
+    connection?: Connection;
+    ws?: ReconnectingWebSocket;
+    retryCount: number;
+    events: EventEmitter;
+    token: string | null;
+    resourceToken: string | null;
     pingOptions: {
         interval: number;
         timeout: number;
     };
-    constructor(authMessage: AuthMessage, url: string, renewTokenFunc?: RenewTokenFunc | undefined);
+    constructor(url: string, reauthFunc?: ReauthFunc | undefined);
     getBaseURL(): string;
     getBase64BaseURL(): string;
-    getToken(): string;
-    getResourceToken(): string;
-    getAuthMessage(): AuthMessage;
-    verifyAuth(authMessage: AuthMessage): Promise<{
+    auth(auth: AuthMessage): Promise<{
         read: string;
         user: string;
     }>;
     logout(): Promise<void>;
-    init(): Promise<void>;
-    private handleAuthError;
-    private handleUnknownError;
-    private handleConnectionError;
-    private handleDisconnected;
+    init(auth: AuthMessage): Promise<void>;
+    reConnect(token: string): Promise<void>;
+    _autoReAuth(): Promise<void>;
+    autoReAuth(): Promise<void>;
+    handleAuthError(): Promise<void>;
+    reAuth: () => Promise<void>;
     private emitPermissionError;
+    private emitAuthRecover;
+    private emitAuthError;
     private emitRequestReloadError;
     private emitWriteConflictError;
     private emitMaxUsersError;
-    private handleMessage;
+    handleMessage(message: object): void;
     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/sharedb-client.d.ts

@@ -1,28 +1,34 @@
 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, RenewTokenFunc, AuthMessage, OnProgress, EditorOp, LinkDetails } from '../types';
+import { EditorDoc, ReauthFunc, AuthMessage, OnProgress, EditorOp, LinkDetails } from '../types';
 export default class ShareDBClient {
     connection: AuthConnection;
+    auth: AuthMessage;
     private doc;
     private reauthFunc?;
-    private _clientId;
-    constructor(auth: AuthMessage, serverUrl: string, reauthFunc?: RenewTokenFunc);
-    get clientId(): string;
+    clientId: string;
+    constructor(auth: AuthMessage, serverUrl: string, reauthFunc?: ReauthFunc);
     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;
+    getResourceToken(): string | null;
     hasDocContainer(): boolean;
     apiServer(): string;
     getFileUrlByHash(uploadFileUrl: string, hash: string, name: string, size: number, headers: {
@@ -51,4 +57,5 @@ 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,9 +4,7 @@ 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;
@@ -15,8 +13,8 @@ export default class ShareDBDoc extends EventCallbacks<ShareDBDocCallbacks> impl
     status: OnesEditorDocStatus;
     disableLogout: boolean;
     destroyed: boolean;
-    editStatus: EditStatus;
-    constructor(options: ShareDBDocOptions, client: ShareDBClient, doc: Doc, disableLogout?: boolean);
+    options: ShareDBDocOptions | null;
+    constructor(client: ShareDBClient, doc: Doc, disableLogout?: boolean);
     beginBatchUpdate(): number;
     endBatchUpdate(): number;
     static load(options: ShareDBDocOptions): Promise<ShareDBDoc>;
@@ -78,6 +76,7 @@ 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;
@@ -109,4 +108,5 @@ 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, OnesEditorDoc, OnesEditorDocCallbacks, OnesEditorDocRange, OnesEditorUser, OnesEditorUserPermission, UploadResourceOptions, UploadResourceResult } from '../../../@ones-editor/core';
+import { BuildResourceUrlOptions, DocBlock, DocComment, 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,33 +62,18 @@ export declare const FileExtError: {
 };
 export declare const AuthHeader = "x-live-editor-token";
 export declare const BaseURLHeader = "x-live-editor-base-url";
-export type RenewTokenFunc = () => Promise<AuthMessage>;
+export type ReauthFunc = () => 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;
-    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;
+    buildResourceUrl?: (resourceId: string, options?: BuildResourceUrlOptions) => string;
+    uploadResource?: (file: File, options?: UploadResourceOptions) => Promise<UploadResourceResult>;
 }
 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, hiddenHeadings?: Set<string>): void;
+export declare function renderToc(editor: OnesEditor, parent: HTMLElement, toc: OnesEditorToc): void;