@ones-editor/editor 5.0.6-beta.DNP8216.1 → 5.0.6-beta.p8216.1

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

@@ -230,77 +230,12 @@ export interface OnesEditorDocServer {
     getVersionHelper?: () => OnesEditorDocVersionHelper | undefined;
     getRemoteUsers: () => OnesEditorRemoteUsers;
 }
-export type WikiMacroJSON = null | boolean | number | string | WikiMacroJSON[] | {
-    [key: string]: WikiMacroJSON;
-};
-export interface WikiMacroContent {
-    customData: WikiMacroJSON;
-    exportSpec: (ExportDSpecText | ExportDSpecImage | ExportDSpecLink)[];
-    resources: string[];
-}
-export interface WikiMacroLock {
-    blockId: string;
-    sessionId: string;
-    userId: string;
-    clientId: string;
-    leaseExpiresAt: number;
-}
-export interface WikiMacroRequest {
-    operation: 'beginEdit' | 'renewEdit' | 'saveData' | 'finishEdit' | 'cancelEdit' | 'getEditResult' | 'applyHistoryAction' | 'locks';
-    blockId?: string;
-    sessionId?: string;
-    fence?: string;
-    expectedRevision?: number;
-    content?: WikiMacroContent;
-    actionId?: string;
-    direction?: 'undo' | 'redo';
-    targetRequestId?: string;
-}
-export interface WikiMacroResult {
-    requestId?: string;
-    state?: 'active' | 'finished' | 'cancelled' | 'expired';
-    status?: 'processing' | 'completed';
-    error?: WikiMacroErrorDetails;
-    sessionId?: string;
-    fence?: string;
-    revision?: number;
-    finalRevision?: number;
-    documentVersion?: number;
-    leaseExpiresAt?: number;
-    beforeContent?: WikiMacroContent;
-    content?: WikiMacroContent;
-    actionId?: string;
-    locks?: WikiMacroLock[];
-}
-export interface WikiMacroErrorDetails {
-    code: string;
-    message?: string;
-    sizeBytes?: number;
-    limitBytes?: number;
-}
-export declare class WikiMacroError extends Error {
-    readonly requestId?: string | undefined;
-    readonly code: string;
-    readonly sizeBytes?: number;
-    readonly limitBytes?: number;
-    constructor(details: WikiMacroErrorDetails, requestId?: string | undefined);
-}
-export interface WikiMacroReply {
-    a: 'wikiMacro';
-    requestId?: string;
-    operation?: 'locks';
-    result?: WikiMacroResult;
-    error?: WikiMacroErrorDetails;
-    locks?: WikiMacroLock[];
-}
-export type WikiMacroLocksListener = (locks: WikiMacroLock[]) => void;
 export interface OnesEditorDoc extends OnesEditorDocServer {
-    requestWikiMacro: (message: WikiMacroRequest) => Promise<WikiMacroResult>;
-    onWikiMacroLocks: (listener: WikiMacroLocksListener) => () => void;
-    getDocumentVersion?: () => number | undefined;
     registerCallback: (callbacks: OnesEditorDocCallbacks) => void;
     unregisterCallback: (callbacks: OnesEditorDocCallbacks) => void;
     toJSON: () => DocObject;
+    /** Current collaboration revision, when this is a live document. */
+    getDocumentVersion?: () => number | undefined;
     getContainerBlocks: (containerId: string) => DocBlock[];
     findContainerBlocks: (containerId: string) => DocBlock[] | null;
     getBlockData: (containerId: string, blockIndex: number) => DocBlock;
@@ -345,14 +280,9 @@ export interface OnesEditorHistoryDataParseHandler {
     onUpdateComment: (commentId: string, local: boolean) => void;
     onUpdateCommentResolver: (commentId: string, local: boolean) => void;
 }
-export interface OnesEditorDocSnapshot {
-    doc: DocObject;
-    documentVersion?: number;
-}
 export interface OnesEditorDocVersionHelper {
     getVersions: (showPublished?: boolean) => Promise<DocVersion[]>;
     getVersion: (ver: number) => Promise<DocObject>;
-    getVersionSnapshot?: (ver: number) => Promise<OnesEditorDocSnapshot>;
     getLatestVersion: () => Promise<DocObject>;
     getHistoryData: (version: number, from?: number) => Promise<{
         doc: DocObject;

package/@ones-editor/core/src/core/doc/index.d.ts

@@ -7,4 +7,5 @@ export * from './block';
 export * from './to-plain-text';
 export * from './range';
 export * from './box';
+export * from './wiki-macro';
 export * from './repair-duplicated-block-ids';

package/@ones-editor/core/src/core/doc/wiki-macro.d.ts

@@ -0,0 +1,15 @@
+export declare const WIKI_MACRO_TYPE = "ones-open-wiki-macro";
+export interface WikiMacroData {
+    protocolVersion?: number;
+    resources?: unknown;
+    exportSpec?: unknown;
+}
+interface ExportItem {
+    type: string;
+    data: unknown;
+}
+export declare function getWikiMacroExportSpec(data: WikiMacroData | null | undefined): ExportItem[];
+export declare function getWikiMacroResources(data: WikiMacroData | null | undefined): string[];
+export declare function replaceWikiMacroResources(data: WikiMacroData | null | undefined, resources: Map<string, string>): void;
+export declare function wikiMacroToText(data: WikiMacroData | null | undefined): string;
+export {};

package/@ones-editor/core/src/core/doc/wiki-macro.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,4 +1,3 @@
 export * from './editor';
 export * from './actions';
 export { scrollIntoView, editorScrollIntoView } from './editor-dom';
-export { isWikiMacroElementLocked } from './wiki-macro-locks';

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

@@ -1,17 +1,11 @@
 import { EditorDocLocalActionCallbacks, OnesEditor } from '../types';
 import { BuildResourceUrlOptions, InsertBlockOptions, DocBlock, DocBlockDelta, DocBlockText, DocBlockTextActions, DocObject, OnesEditorDoc, OnesEditorDocCallbacks, OnesEditorDocRange, OnesEditorDocServerMeta, OnesEditorDocStatus, UploadResourceOptions, UploadResourceResult, UpdateBlockOptions } from '../doc';
-import { WikiMacroLocksListener, WikiMacroRequest, WikiMacroResult } from '../doc';
 import { EventCallbacks } from '../../utils';
 export default class EditorDoc extends EventCallbacks<OnesEditorDocCallbacks> implements OnesEditorDoc, OnesEditorDocCallbacks {
     private editor;
     externalDoc: OnesEditorDoc;
     localEvents: EditorDocLocalActionCallbacks[];
-    private unsubscribeMacroLocks?;
-    private subscribeMacroLocks;
     constructor(editor: OnesEditor, externalDoc: OnesEditorDoc, localEvents: EditorDocLocalActionCallbacks);
-    requestWikiMacro(message: WikiMacroRequest): Promise<WikiMacroResult>;
-    onWikiMacroLocks(listener: WikiMacroLocksListener): () => void;
-    getDocumentVersion(): number | undefined;
     beginBatchUpdate(): number;
     endBatchUpdate(): number;
     applyingRemoteOps(): boolean;

package/@ones-editor/core/src/core/types.d.ts

@@ -359,19 +359,13 @@ export interface OnesEditorUndoAction {
     getTimeStamp: () => number;
     getBatchActionId?: () => string | undefined;
 }
-export interface MacroEditActionOptions {
-    actionId: string;
-    blockId: string;
-    undo: () => Promise<void>;
-    redo: () => Promise<void>;
-    onError?: (error: Error) => void;
-}
 export interface OnesEditorUndoManager {
     reset: () => void;
     addAction: (action: OnesEditorUndoAction) => void;
-    registerMacroEditAction: (options: MacroEditActionOptions) => void;
-    setMacroEditSessionActive: (sessionId: string, active: boolean) => void;
-    destroy: () => void;
+    addAsyncAction: (action: OnesEditorAsyncUndoAction) => () => void;
+    acquireUndoLock: () => () => void;
+    undoAsync: () => Promise<boolean>;
+    redoAsync: () => Promise<boolean>;
     hasGroup: () => boolean;
     undo: () => boolean;
     redo: () => boolean;
@@ -381,6 +375,12 @@ export interface OnesEditorUndoManager {
     lastAction: () => OnesEditorUndoAction | null;
     undoTo: (action: OnesEditorUndoAction | null) => boolean;
 }
+export interface OnesEditorAsyncUndoAction {
+    onDiscard?: () => void;
+    undo: () => Promise<boolean>;
+    redo: () => Promise<boolean>;
+    onError: (error: unknown) => void;
+}
 export interface ShortcutRecords {
     [index: string]: (editor: OnesEditor, event: Event) => boolean | undefined;
 }
@@ -443,7 +443,6 @@ export interface BreakTextOptions {
 }
 export interface OnesEditorEvents {
     'docChanged': (editor: OnesEditor, local: boolean) => void;
-    'wikiMacroLocksChanged': (editor: OnesEditor) => void;
     'readonlyChanged': (editor: OnesEditor) => void;
     'selectionChanged': (editor: OnesEditor) => void;
     'focusBlockChanged': (editor: OnesEditor, newBlock: BlockElement | null, oldBlock: BlockElement | null) => void;
@@ -540,10 +539,6 @@ export interface OnesEditorDomEvents extends OnesEditorCustom {
     removeAllListeners: (element: Element | Document | Window, eventName?: string) => void;
 }
 export type InsertTextOptions = InsertBlockOptions;
-export interface OnesEditorDocResourceHook {
-    collect: (doc: DocObject) => readonly string[];
-    rewrite: (doc: DocObject, resources: Map<string, string>) => void;
-}
 export interface OnesEditor extends TypedEmitter<OnesEditorEvents> {
     readonly parent: HTMLElement;
     readonly rootElement: HTMLDivElement;
@@ -573,6 +568,7 @@ export interface OnesEditor extends TypedEmitter<OnesEditorEvents> {
     readonly settingsProvider: OnesEditorSettingsProvider;
     version: string;
     readonly: boolean;
+    acquireReadonly: () => () => void;
     destroyed: boolean;
     addCustom: <T extends OnesEditorCustom>(name: string, creator: OnesEditorCustomCreator<T>) => T;
     getCustom: <T extends OnesEditorCustom>(name: string) => T;
@@ -580,9 +576,6 @@ export interface OnesEditor extends TypedEmitter<OnesEditorEvents> {
     findCustom: <T extends OnesEditorCustom>(name: string) => T | null;
     findCustomByType: <T extends OnesEditorCustom>(className: new (editor: OnesEditor) => T) => T | null;
     destroyCustom: (name: string) => void;
-    addDocResourceHook: (hook: OnesEditorDocResourceHook) => () => void;
-    registerMacroEditAction: (options: MacroEditActionOptions) => void;
-    setMacroEditSessionActive: (sessionId: string, active: boolean) => void;
     getComponentOptions: <T>(name: string) => T | null;
     registerLocalEvents: (events: EditorDocLocalActionCallbacks) => void;
     createBlock: (path: BlockPath, container: ContainerElement, block: DocBlock) => BlockElement;
@@ -594,7 +587,7 @@ export interface OnesEditor extends TypedEmitter<OnesEditorEvents> {
         tryFocusToChildSimpleBlock?: boolean;
     }) => void;
     isWritable: () => boolean;
-    isBlockWritable: (block: BlockElement | BlockElement[], macroSessionId?: string) => boolean;
+    isBlockWritable: (block: BlockElement | BlockElement[]) => boolean;
     reload: () => void;
     getChildContainerData: (childContainerId: string) => DocBlocks;
     createChildContainer: (path: BlockPath, parentElement: HTMLElement, childContainerId: string) => ContainerElement;

package/@ones-editor/core/src/core/undo-manager/actions/async-action.d.ts

@@ -0,0 +1,7 @@
+import type { OnesEditor, OnesEditorAsyncUndoAction } from '../../types';
+import Action from './action';
+/** A server-confirmed edit session is one action, independent of synchronous groups. */
+export default class AsyncAction extends Action {
+    readonly operation: OnesEditorAsyncUndoAction;
+    constructor(editor: OnesEditor, operation: OnesEditorAsyncUndoAction);
+}

package/@ones-editor/core/src/core/undo-manager/undo-manager.d.ts

@@ -1,6 +1,6 @@
 import { DocBlock, DocBlockText, OnesEditorDocRange } from '../doc';
 import { EditorDocLocalActionCallbacks, OnesEditor, OnesEditorUndoAction, OnesEditorUndoManager } from '../types';
-import { MacroEditActionOptions } from '../types';
+import type { OnesEditorAsyncUndoAction } from '../types';
 import Action from './actions/action';
 declare class UndoManager implements OnesEditorUndoManager, EditorDocLocalActionCallbacks {
     editor: OnesEditor;
@@ -9,19 +9,19 @@ declare class UndoManager implements OnesEditorUndoManager, EditorDocLocalAction
     private currentGroup;
     private groupCounter;
     private undoRedoing;
-    private macroSessions;
-    private macroActionIds;
-    private pendingMacroAction;
-    private macroGeneration;
-    private destroyed;
-    registerMacroEditAction(options: MacroEditActionOptions): void;
-    setMacroEditSessionActive(sessionId: string, active: boolean): void;
-    destroy(): void;
-    private applyMacroAction;
+    private undoLocks;
+    private pendingAction?;
+    private resetVersion;
     constructor(editor: OnesEditor);
     reset(): void;
     prepareSaveUndoState(): void;
     addAction(action: OnesEditorUndoAction): void;
+    addAsyncAction(operation: OnesEditorAsyncUndoAction): () => void;
+    private discard;
+    acquireUndoLock(): () => void;
+    undoAsync(): Promise<boolean>;
+    redoAsync(): Promise<boolean>;
+    private runAsyncAction;
     private beginGroup;
     private endGroup;
     hasGroup(): boolean;

package/@ones-editor/core/src/core/undo-manager/undo-manager.test.d.ts

@@ -0,0 +1 @@
+export {};

package/@ones-editor/core/src/local-doc/index.d.ts

@@ -1,18 +1,12 @@
 import { DocBlock, DocBlockDelta, DocBlockText, OnesEditorDocServerMeta, DocBlockTextActions, DocObject, OnesEditorDoc, OnesEditorDocCallbacks, OnesEditorUser, UploadResourceOptions, UploadResourceResult } from '../core/doc';
-import { WikiMacroLocksListener, WikiMacroRequest, WikiMacroResult } from '../core/doc';
 import { EventCallbacks } from '../utils';
 import { RemoteUsers } from '../users';
 export declare class LocalDoc extends EventCallbacks<OnesEditorDocCallbacks> implements OnesEditorDoc {
     doc: DocObject;
     serviceUrl: string;
-    private documentVersion?;
     constructor(doc: DocObject | null, options?: {
         serverUrl?: string;
-        documentVersion?: number;
     });
-    requestWikiMacro(message: WikiMacroRequest): Promise<WikiMacroResult>;
-    onWikiMacroLocks(listener: WikiMacroLocksListener): () => void;
-    getDocumentVersion(): number | undefined;
     beginBatchUpdate(): number;
     endBatchUpdate(): number;
     toJSON(): DocObject;
@@ -38,6 +32,6 @@ export declare class LocalDoc extends EventCallbacks<OnesEditorDocCallbacks> imp
     getServerMeta(): OnesEditorDocServerMeta;
     getUser(): OnesEditorUser;
     getRemoteUsers(): RemoteUsers;
-    setDoc(doc: DocObject, documentVersion?: number): void;
+    setDoc(doc: DocObject): void;
     destroy(): void;
 }

package/@ones-editor/server-tools/src/to-markdown/embeds/wiki-macro.d.ts

@@ -0,0 +1,4 @@
+import type { DocEmbedBlock, DocObject } from '../../../../../@ones-editor/core';
+import type { Converters } from '../types';
+/** Images use the existing document-resource placeholder consumed by Wiki API. */
+export default function macroToMarkdown(converters: Converters, block: DocEmbedBlock, doc: DocObject): string;

package/@ones-editor/server-tools/src/to-markdown/embeds/wiki-macro.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -1,6 +1,5 @@
 import { Doc } from 'sharedb/lib/client';
 import { TypedEmitter } from 'tiny-typed-emitter';
-import { WikiMacroLocksListener, WikiMacroRequest, WikiMacroResult } from '../../../../@ones-editor/core';
 import { AuthMessage, RenewTokenFunc } from '../types';
 import './sharedb-ext';
 export interface AutoConnectionEvents {
@@ -34,17 +33,6 @@ export declare class AuthConnection extends TypedEmitter<AutoConnectionEvents> {
     private connectionStatus;
     private reauthing;
     private ready;
-    private macroRequests;
-    private macroLocksListeners;
-    private macroLocks;
-    private macroLocksKnown;
-    private macroLocksLoading;
-    private loadWikiMacroLocks;
-    requestWikiMacro(message: WikiMacroRequest): Promise<WikiMacroResult>;
-    onWikiMacroLocks(listener: WikiMacroLocksListener): () => void;
-    private handleWikiMacroReply;
-    private clearWikiMacroRequests;
-    private notifyWikiMacroLocks;
     pingOptions: {
         interval: number;
         timeout: number;

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

@@ -2,7 +2,7 @@ import { BuildResourceUrlOptions, DocVersion, OnesEditorDocVersionExtra } from '
 import { Doc } from 'sharedb/lib/client';
 import type { AxiosResponse } from 'axios';
 import { AuthConnection } from './auth-connection';
-import { EditorDoc, EditorDocSnapshot, RenewTokenFunc, AuthMessage, OnProgress, EditorOp, LinkDetails } from '../types';
+import { EditorDoc, RenewTokenFunc, AuthMessage, OnProgress, EditorOp, LinkDetails } from '../types';
 export default class ShareDBClient {
     connection: AuthConnection;
     private doc;
@@ -40,7 +40,6 @@ export default class ShareDBClient {
     request<T = unknown>(url: string, opt?: any): Promise<AxiosResponse<any, T>>;
     getVersions(): Promise<DocVersion[]>;
     getVersion(ver: number): Promise<EditorDoc>;
-    getVersionSnapshot(ver: number): Promise<EditorDocSnapshot>;
     getLatestVersion(): Promise<EditorDoc>;
     getVersionOps(version: number, from?: number): Promise<{
         doc: EditorDoc;

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

@@ -1,6 +1,4 @@
 import { BuildResourceUrlOptions, DocBlock, DocBlockDelta, DocBlockText, DocBlockTextActions, DocCommentResolver, DocObject, DocVersion, EventCallbacks, OnesEditorComment, OnesEditorDoc, OnesEditorDocHistoryData, OnesEditorDocServerMeta, OnesEditorDocStatus, OnesEditorDocVersionExtra, OnesEditorDocVersionHelper, OnesEditorHistoryDataParseHandler, UploadResourceOptions, UploadResourceResult } from '../../../../@ones-editor/core';
-import { WikiMacroLocksListener, WikiMacroRequest, WikiMacroResult } from '../../../../@ones-editor/core';
-import { OnesEditorDocSnapshot } from '../../../../@ones-editor/core';
 import { Doc } from 'sharedb/lib/client';
 import { LocalPresence } from 'sharedb/lib/sharedb';
 import RemoteCaretsHandler from './remote-caret-handler';
@@ -20,9 +18,6 @@ export default class ShareDBDoc extends EventCallbacks<ShareDBDocCallbacks> impl
     editStatus: EditStatus;
     _applyingRemoteOps: boolean;
     constructor(options: ShareDBDocOptions, client: ShareDBClient, doc: Doc, disableLogout?: boolean);
-    requestWikiMacro(message: WikiMacroRequest): Promise<WikiMacroResult>;
-    onWikiMacroLocks(listener: WikiMacroLocksListener): () => void;
-    getDocumentVersion(): number | undefined;
     beginBatchUpdate(): number;
     endBatchUpdate(): number;
     applyingRemoteOps(): boolean;
@@ -47,6 +42,7 @@ export default class ShareDBDoc extends EventCallbacks<ShareDBDocCallbacks> impl
     initPresence(): Promise<void>;
     private subscribe;
     data: () => any;
+    getDocumentVersion(): number | undefined;
     toJSON(): DocObject;
     private submitOp;
     createDoc: (data: EditorDoc) => Promise<void>;
@@ -104,7 +100,6 @@ export default class ShareDBDoc extends EventCallbacks<ShareDBDocCallbacks> impl
     getVersionHelper(): OnesEditorDocVersionHelper;
     getVersions(): Promise<DocVersion[]>;
     getVersion(ver: number): Promise<DocObject>;
-    getVersionSnapshot(ver: number): Promise<OnesEditorDocSnapshot>;
     getLatestVersion(): Promise<DocObject>;
     getHistoryData(version: number, from?: number | undefined): Promise<{
         doc: DocObject;

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

@@ -5,7 +5,6 @@ export interface ShareDBLocalDocOptions {
     resourceToken?: string;
     user: OnesEditorUser;
     docId: string;
-    documentVersion?: number;
     onReauth?: () => Promise<string>;
 }
 export default class ShareDBLocalDoc extends LocalDoc {

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

@@ -19,10 +19,6 @@ export type EditorDocBase = {
 export type EditorDoc = EditorDocBase & {
     [index: string]: BlocksType | unknown;
 };
-export interface EditorDocSnapshot {
-    doc: EditorDoc;
-    documentVersion?: number;
-}
 export interface AuthMessage {
     appId: string;
     docId: string;

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

@@ -1,5 +1,4 @@
 import { BuildResourceUrlOptions, DocObject, DocVersion, EventCallbacks, OnesEditorDocHistoryData, OnesEditorDocServer, OnesEditorDocServerMeta, OnesEditorDocVersionExtra, OnesEditorDocVersionHelper, OnesEditorHistoryDataParseHandler, RemoteUsers } from '../../../../@ones-editor/core';
-import { OnesEditorDocSnapshot } from '../../../../@ones-editor/core';
 import { AuthMessage, ShareDBDocCallbacks, ShareDBDocOptions } from '../types';
 import ShareDBSimpleClient from './simple-client';
 export default class ShareDBServer extends EventCallbacks<ShareDBDocCallbacks> implements OnesEditorDocServer, OnesEditorDocVersionHelper {
@@ -13,7 +12,6 @@ export default class ShareDBServer extends EventCallbacks<ShareDBDocCallbacks> i
     getVersionHelper(): OnesEditorDocVersionHelper;
     getVersions(showPublished?: boolean): Promise<DocVersion[]>;
     getVersion(ver: number): Promise<DocObject>;
-    getVersionSnapshot(ver: number): Promise<OnesEditorDocSnapshot>;
     getLatestVersion(): Promise<DocObject>;
     getHistoryData(version: number, from?: number | undefined): Promise<{
         doc: DocObject;

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

@@ -1,6 +1,6 @@
 import { BuildResourceUrlOptions, DocVersion, OnesEditorDocVersionExtra } from '../../../../@ones-editor/core';
 import { AxiosResponse } from 'axios';
-import { AuthMessage, EditorDoc, EditorDocSnapshot, EditorOp } from '../types';
+import { AuthMessage, EditorDoc, EditorOp } from '../types';
 export default class ShareDBSimpleClient {
     private serverUrl;
     auth: AuthMessage;
@@ -13,7 +13,6 @@ export default class ShareDBSimpleClient {
     request<T = unknown>(url: string, opt?: any): Promise<AxiosResponse<any, T>>;
     getVersions(showPublished: boolean): Promise<DocVersion[]>;
     getVersion(ver: number): Promise<EditorDoc>;
-    getVersionSnapshot(ver: number): Promise<EditorDocSnapshot>;
     getLatestVersion(): Promise<EditorDoc>;
     getVersionOps(version: number, from?: number): Promise<{
         doc: EditorDoc;