@knotx/plugins-history 0.2.6 → 0.2.8

package/dist/index.cjs

@@ -82,6 +82,9 @@ class History extends (_a = core.BasePlugin, _canUndo_dec = [decorators.register
     __publicField(this, "currentIndex", -1);
     __publicField(this, "isUndoRedo", false);
     __publicField(this, "maxHistory");
+    __publicField(this, "tagMap", /* @__PURE__ */ new Map());
+    __publicField(this, "operationBuffer", {});
+    __publicField(this, "operations$", new rxjs.Subject());
     __publicField(this, "canUndo", __runInitializers(_init, 8, this, false)), __runInitializers(_init, 11, this);
     __publicField(this, "canRedo", __runInitializers(_init, 12, this, false)), __runInitializers(_init, 15, this);
     __publicField(this, "ref", __runInitializers(_init, 16, this, this)), __runInitializers(_init, 19, this);
@@ -98,17 +101,32 @@ class History extends (_a = core.BasePlugin, _canUndo_dec = [decorators.register
     __publicField(this, "edgesManager", __runInitializers(_init, 28, this)), __runInitializers(_init, 31, this);
     __publicField(this, "dataManagers", /* @__PURE__ */ new Map());
   }
-  init(config) {
-    var _a2;
+  init(config = {}) {
+    var _a2, _b;
     this.maxHistory = (_a2 = config.maxHistory) != null ? _a2 : 50;
+    const debounceTimeConfig = (_b = config.debounceTime) != null ? _b : 20;
     this.dataManagers.set(this.nodesManager.tag, this.nodesManager);
     this.dataManagers.set(this.edgesManager.tag, this.edgesManager);
     this.dataManagers.forEach((dataManager) => {
       this.addOperationPipe(dataManager);
     });
+    this.subscriptions.push(
+      this.operations$.pipe(
+        rxjs.tap(([tag, operation]) => {
+          if (!this.operationBuffer[tag]) {
+            this.operationBuffer[tag] = [];
+          }
+          this.operationBuffer[tag].push(operation);
+        }),
+        rxjs.debounceTime(debounceTimeConfig)
+      ).subscribe(() => {
+        this.flushOperationBuffer();
+      })
+    );
   }
   destroy() {
     this.dataManagers.clear();
+    this.tagMap.clear();
   }
   addOperationPipe(dataManager) {
     dataManager.addDataOperationPipe({
@@ -119,17 +137,22 @@ class History extends (_a = core.BasePlugin, _canUndo_dec = [decorators.register
           }
           if (!this.isUndoRedo) {
             const enrichedOperation = this.enrichOperation(dataManager, operation);
-            this.pushHistory({
-              value: {
-                [dataManager.tag]: [enrichedOperation]
-              },
-              timestamp: Date.now()
-            });
+            this.operations$.next([dataManager.tag, enrichedOperation]);
           }
         })
       )
     });
   }
+  flushOperationBuffer() {
+    if (Object.keys(this.operationBuffer).length === 0) {
+      return;
+    }
+    this.pushHistory({
+      value: __spreadValues({}, this.operationBuffer),
+      timestamp: Date.now()
+    });
+    this.operationBuffer = {};
+  }
   enrichOperation(dataManager, operation) {
     switch (operation.type) {
       case "update": {
@@ -175,6 +198,7 @@ class History extends (_a = core.BasePlugin, _canUndo_dec = [decorators.register
   undo() {
     if (!this.canUndo)
       return;
+    this.flushOperationBufferImmediately();
     const state = this.history[this.currentIndex];
     this.isUndoRedo = true;
     try {
@@ -196,6 +220,7 @@ class History extends (_a = core.BasePlugin, _canUndo_dec = [decorators.register
   redo() {
     if (!this.canRedo)
       return;
+    this.flushOperationBufferImmediately();
     this.currentIndex++;
     const state = this.history[this.currentIndex];
     this.isUndoRedo = true;
@@ -214,6 +239,51 @@ class History extends (_a = core.BasePlugin, _canUndo_dec = [decorators.register
       this.isUndoRedo = false;
     }
   }
+  addTag(tag) {
+    this.flushOperationBufferImmediately();
+    this.tagMap.set(tag, this.history[this.currentIndex]);
+  }
+  removeTag(tag) {
+    this.tagMap.delete(tag);
+  }
+  toTag(tag) {
+    this.flushOperationBufferImmediately();
+    const tagIndex = this.ensureTagIndex(tag);
+    if (tagIndex === false) {
+      return;
+    }
+    if (this.currentIndex > tagIndex) {
+      let offset = this.currentIndex - tagIndex;
+      while (offset > 0) {
+        this.undo();
+        offset--;
+      }
+    } else if (this.currentIndex < tagIndex) {
+      let offset = tagIndex - this.currentIndex;
+      while (offset > 0) {
+        this.redo();
+        offset--;
+      }
+    }
+  }
+  clearTags() {
+    this.tagMap.clear();
+  }
+  ensureTagIndex(tag) {
+    if (!this.tagMap.has(tag)) {
+      return false;
+    }
+    const state = this.tagMap.get(tag);
+    if (typeof state === "undefined") {
+      return -1;
+    }
+    const stateIndex = this.history.indexOf(state);
+    if (stateIndex === -1) {
+      this.removeTag(tag);
+      return false;
+    }
+    return stateIndex;
+  }
   reverseOperation(dataManager, operation) {
     switch (operation.type) {
       case "add":
@@ -238,6 +308,12 @@ class History extends (_a = core.BasePlugin, _canUndo_dec = [decorators.register
         break;
     }
   }
+  /**
+   * 立即处理操作缓冲区，不等待 debounce
+   */
+  flushOperationBufferImmediately() {
+    this.flushOperationBuffer();
+  }
 }
 _init = __decoratorStart(_a);
 __decorateElement(_init, 1, "init", _init_dec, History);

package/dist/index.d.cts

@@ -13,17 +13,23 @@ declare module '@knotx/core' {
 interface IHistory {
     undo: () => void;
     redo: () => void;
+    addTag: (tag: string) => void;
+    removeTag: (tag: string) => void;
+    toTag: (tag: string) => void;
+    clearTags: () => void;
 }
+type HistoryOperation<T extends Record<string, IData>> = DataOperation<T[keyof T]> & {
+    originalData?: Partial<T[keyof T]>;
+};
 interface HistoryState<T extends Record<string, IData> = Record<string, any>> {
     value: {
-        [key: string]: Array<DataOperation<T[keyof T]> & {
-            originalData?: Partial<T[keyof T]>;
-        }>;
+        [key: string]: HistoryOperation<T>[];
     };
     timestamp: number;
 }
 interface HistoryConfig {
     maxHistory?: number;
+    debounceTime?: number;
 }
 declare class History<T extends Record<string, IData> = Record<string, any>> extends BasePlugin<'history', HistoryConfig> {
     name: "history";
@@ -31,6 +37,9 @@ declare class History<T extends Record<string, IData> = Record<string, any>> ext
     private currentIndex;
     private isUndoRedo;
     private maxHistory;
+    private tagMap;
+    private operationBuffer;
+    private operations$;
     canUndo: boolean;
     canRedo: boolean;
     ref: this;
@@ -38,15 +47,25 @@ declare class History<T extends Record<string, IData> = Record<string, any>> ext
     private nodesManager;
     private edgesManager;
     private dataManagers;
-    init(config: HistoryConfig): void;
+    init(config?: HistoryConfig): void;
     destroy(): void;
     private addOperationPipe;
+    private flushOperationBuffer;
     private enrichOperation;
     private pushHistory;
     private updateCanUndoRedo;
     undo(): void;
     redo(): void;
+    addTag(tag: string): void;
+    removeTag(tag: string): void;
+    toTag(tag: string): void;
+    clearTags(): void;
+    private ensureTagIndex;
     private reverseOperation;
+    /**
+     * 立即处理操作缓冲区，不等待 debounce
+     */
+    private flushOperationBufferImmediately;
 }
 
-export { History, type HistoryConfig, type HistoryState, type IHistory };
+export { History, type HistoryConfig, type HistoryOperation, type HistoryState, type IHistory };

package/dist/index.d.mts

@@ -13,17 +13,23 @@ declare module '@knotx/core' {
 interface IHistory {
     undo: () => void;
     redo: () => void;
+    addTag: (tag: string) => void;
+    removeTag: (tag: string) => void;
+    toTag: (tag: string) => void;
+    clearTags: () => void;
 }
+type HistoryOperation<T extends Record<string, IData>> = DataOperation<T[keyof T]> & {
+    originalData?: Partial<T[keyof T]>;
+};
 interface HistoryState<T extends Record<string, IData> = Record<string, any>> {
     value: {
-        [key: string]: Array<DataOperation<T[keyof T]> & {
-            originalData?: Partial<T[keyof T]>;
-        }>;
+        [key: string]: HistoryOperation<T>[];
     };
     timestamp: number;
 }
 interface HistoryConfig {
     maxHistory?: number;
+    debounceTime?: number;
 }
 declare class History<T extends Record<string, IData> = Record<string, any>> extends BasePlugin<'history', HistoryConfig> {
     name: "history";
@@ -31,6 +37,9 @@ declare class History<T extends Record<string, IData> = Record<string, any>> ext
     private currentIndex;
     private isUndoRedo;
     private maxHistory;
+    private tagMap;
+    private operationBuffer;
+    private operations$;
     canUndo: boolean;
     canRedo: boolean;
     ref: this;
@@ -38,15 +47,25 @@ declare class History<T extends Record<string, IData> = Record<string, any>> ext
     private nodesManager;
     private edgesManager;
     private dataManagers;
-    init(config: HistoryConfig): void;
+    init(config?: HistoryConfig): void;
     destroy(): void;
     private addOperationPipe;
+    private flushOperationBuffer;
     private enrichOperation;
     private pushHistory;
     private updateCanUndoRedo;
     undo(): void;
     redo(): void;
+    addTag(tag: string): void;
+    removeTag(tag: string): void;
+    toTag(tag: string): void;
+    clearTags(): void;
+    private ensureTagIndex;
     private reverseOperation;
+    /**
+     * 立即处理操作缓冲区，不等待 debounce
+     */
+    private flushOperationBufferImmediately;
 }
 
-export { History, type HistoryConfig, type HistoryState, type IHistory };
+export { History, type HistoryConfig, type HistoryOperation, type HistoryState, type IHistory };

package/dist/index.d.ts

@@ -13,17 +13,23 @@ declare module '@knotx/core' {
 interface IHistory {
     undo: () => void;
     redo: () => void;
+    addTag: (tag: string) => void;
+    removeTag: (tag: string) => void;
+    toTag: (tag: string) => void;
+    clearTags: () => void;
 }
+type HistoryOperation<T extends Record<string, IData>> = DataOperation<T[keyof T]> & {
+    originalData?: Partial<T[keyof T]>;
+};
 interface HistoryState<T extends Record<string, IData> = Record<string, any>> {
     value: {
-        [key: string]: Array<DataOperation<T[keyof T]> & {
-            originalData?: Partial<T[keyof T]>;
-        }>;
+        [key: string]: HistoryOperation<T>[];
     };
     timestamp: number;
 }
 interface HistoryConfig {
     maxHistory?: number;
+    debounceTime?: number;
 }
 declare class History<T extends Record<string, IData> = Record<string, any>> extends BasePlugin<'history', HistoryConfig> {
     name: "history";
@@ -31,6 +37,9 @@ declare class History<T extends Record<string, IData> = Record<string, any>> ext
     private currentIndex;
     private isUndoRedo;
     private maxHistory;
+    private tagMap;
+    private operationBuffer;
+    private operations$;
     canUndo: boolean;
     canRedo: boolean;
     ref: this;
@@ -38,15 +47,25 @@ declare class History<T extends Record<string, IData> = Record<string, any>> ext
     private nodesManager;
     private edgesManager;
     private dataManagers;
-    init(config: HistoryConfig): void;
+    init(config?: HistoryConfig): void;
     destroy(): void;
     private addOperationPipe;
+    private flushOperationBuffer;
     private enrichOperation;
     private pushHistory;
     private updateCanUndoRedo;
     undo(): void;
     redo(): void;
+    addTag(tag: string): void;
+    removeTag(tag: string): void;
+    toTag(tag: string): void;
+    clearTags(): void;
+    private ensureTagIndex;
     private reverseOperation;
+    /**
+     * 立即处理操作缓冲区，不等待 debounce
+     */
+    private flushOperationBufferImmediately;
 }
 
-export { History, type HistoryConfig, type HistoryState, type IHistory };
+export { History, type HistoryConfig, type HistoryOperation, type HistoryState, type IHistory };

package/dist/index.js

@@ -1,6 +1,6 @@
 import { isDraftOperation, isInitOperation, flattenOperations, BasePlugin } from '@knotx/core';
 import { register, inject, OnInit, OnDestroy } from '@knotx/decorators';
-import { pipe, tap } from 'rxjs';
+import { Subject, tap, debounceTime, pipe } from 'rxjs';
 
 var __create = Object.create;
 var __defProp = Object.defineProperty;
@@ -80,6 +80,9 @@ class History extends (_a = BasePlugin, _canUndo_dec = [register("canUndo")], _c
     __publicField(this, "currentIndex", -1);
     __publicField(this, "isUndoRedo", false);
     __publicField(this, "maxHistory");
+    __publicField(this, "tagMap", /* @__PURE__ */ new Map());
+    __publicField(this, "operationBuffer", {});
+    __publicField(this, "operations$", new Subject());
     __publicField(this, "canUndo", __runInitializers(_init, 8, this, false)), __runInitializers(_init, 11, this);
     __publicField(this, "canRedo", __runInitializers(_init, 12, this, false)), __runInitializers(_init, 15, this);
     __publicField(this, "ref", __runInitializers(_init, 16, this, this)), __runInitializers(_init, 19, this);
@@ -96,17 +99,32 @@ class History extends (_a = BasePlugin, _canUndo_dec = [register("canUndo")], _c
     __publicField(this, "edgesManager", __runInitializers(_init, 28, this)), __runInitializers(_init, 31, this);
     __publicField(this, "dataManagers", /* @__PURE__ */ new Map());
   }
-  init(config) {
-    var _a2;
+  init(config = {}) {
+    var _a2, _b;
     this.maxHistory = (_a2 = config.maxHistory) != null ? _a2 : 50;
+    const debounceTimeConfig = (_b = config.debounceTime) != null ? _b : 20;
     this.dataManagers.set(this.nodesManager.tag, this.nodesManager);
     this.dataManagers.set(this.edgesManager.tag, this.edgesManager);
     this.dataManagers.forEach((dataManager) => {
       this.addOperationPipe(dataManager);
     });
+    this.subscriptions.push(
+      this.operations$.pipe(
+        tap(([tag, operation]) => {
+          if (!this.operationBuffer[tag]) {
+            this.operationBuffer[tag] = [];
+          }
+          this.operationBuffer[tag].push(operation);
+        }),
+        debounceTime(debounceTimeConfig)
+      ).subscribe(() => {
+        this.flushOperationBuffer();
+      })
+    );
   }
   destroy() {
     this.dataManagers.clear();
+    this.tagMap.clear();
   }
   addOperationPipe(dataManager) {
     dataManager.addDataOperationPipe({
@@ -117,17 +135,22 @@ class History extends (_a = BasePlugin, _canUndo_dec = [register("canUndo")], _c
           }
           if (!this.isUndoRedo) {
             const enrichedOperation = this.enrichOperation(dataManager, operation);
-            this.pushHistory({
-              value: {
-                [dataManager.tag]: [enrichedOperation]
-              },
-              timestamp: Date.now()
-            });
+            this.operations$.next([dataManager.tag, enrichedOperation]);
           }
         })
       )
     });
   }
+  flushOperationBuffer() {
+    if (Object.keys(this.operationBuffer).length === 0) {
+      return;
+    }
+    this.pushHistory({
+      value: __spreadValues({}, this.operationBuffer),
+      timestamp: Date.now()
+    });
+    this.operationBuffer = {};
+  }
   enrichOperation(dataManager, operation) {
     switch (operation.type) {
       case "update": {
@@ -173,6 +196,7 @@ class History extends (_a = BasePlugin, _canUndo_dec = [register("canUndo")], _c
   undo() {
     if (!this.canUndo)
       return;
+    this.flushOperationBufferImmediately();
     const state = this.history[this.currentIndex];
     this.isUndoRedo = true;
     try {
@@ -194,6 +218,7 @@ class History extends (_a = BasePlugin, _canUndo_dec = [register("canUndo")], _c
   redo() {
     if (!this.canRedo)
       return;
+    this.flushOperationBufferImmediately();
     this.currentIndex++;
     const state = this.history[this.currentIndex];
     this.isUndoRedo = true;
@@ -212,6 +237,51 @@ class History extends (_a = BasePlugin, _canUndo_dec = [register("canUndo")], _c
       this.isUndoRedo = false;
     }
   }
+  addTag(tag) {
+    this.flushOperationBufferImmediately();
+    this.tagMap.set(tag, this.history[this.currentIndex]);
+  }
+  removeTag(tag) {
+    this.tagMap.delete(tag);
+  }
+  toTag(tag) {
+    this.flushOperationBufferImmediately();
+    const tagIndex = this.ensureTagIndex(tag);
+    if (tagIndex === false) {
+      return;
+    }
+    if (this.currentIndex > tagIndex) {
+      let offset = this.currentIndex - tagIndex;
+      while (offset > 0) {
+        this.undo();
+        offset--;
+      }
+    } else if (this.currentIndex < tagIndex) {
+      let offset = tagIndex - this.currentIndex;
+      while (offset > 0) {
+        this.redo();
+        offset--;
+      }
+    }
+  }
+  clearTags() {
+    this.tagMap.clear();
+  }
+  ensureTagIndex(tag) {
+    if (!this.tagMap.has(tag)) {
+      return false;
+    }
+    const state = this.tagMap.get(tag);
+    if (typeof state === "undefined") {
+      return -1;
+    }
+    const stateIndex = this.history.indexOf(state);
+    if (stateIndex === -1) {
+      this.removeTag(tag);
+      return false;
+    }
+    return stateIndex;
+  }
   reverseOperation(dataManager, operation) {
     switch (operation.type) {
       case "add":
@@ -236,6 +306,12 @@ class History extends (_a = BasePlugin, _canUndo_dec = [register("canUndo")], _c
         break;
     }
   }
+  /**
+   * 立即处理操作缓冲区，不等待 debounce
+   */
+  flushOperationBufferImmediately() {
+    this.flushOperationBuffer();
+  }
 }
 _init = __decoratorStart(_a);
 __decorateElement(_init, 1, "init", _init_dec, History);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knotx/plugins-history",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "description": "History Plugin for Knotx",
   "author": "boenfu",
   "license": "MIT",
@@ -29,13 +29,13 @@
   ],
   "dependencies": {
     "rxjs": "^7.8.1",
-    "@knotx/core": "0.2.6",
-    "@knotx/decorators": "0.2.6"
+    "@knotx/core": "0.2.7",
+    "@knotx/decorators": "0.2.7"
   },
   "devDependencies": {
-    "@knotx/build-config": "0.2.6",
-    "@knotx/eslint-config": "0.2.6",
-    "@knotx/typescript-config": "0.2.6"
+    "@knotx/build-config": "0.2.7",
+    "@knotx/eslint-config": "0.2.7",
+    "@knotx/typescript-config": "0.2.7"
   },
   "scripts": {
     "build": "unbuild",