roosterjs 9.30.0 → 9.31.0

package/dist/rooster-amd.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.30.0)
+// Type definitions for roosterjs (Version 9.31.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -5100,6 +5100,13 @@ export interface Snapshot {
      * HTML content string
      */
     html: string;
+    /**
+     * Additional state supplied by plugins. When doing an undo/redo to this snapshot, this state will be added to the
+     * content model context as additional state.
+     */
+    additionalState?: {
+        [key: string]: string;
+    };
     /**
      * Entity states related to this undo snapshots. When undo/redo to this snapshot, each entity state will trigger
      * an EntityOperation event with operation = EntityOperation.UpdateEntityState
@@ -5873,6 +5880,18 @@ export interface BasePluginDomEvent<TPluginEventType extends PluginEventType, TR
     rawEvent: TRawEvent;
 }
 
+/**
+ * Fired when an undo snapshot is about to be added
+ */
+export interface BeforeAddUndoSnapshotEvent extends BasePluginEvent<'beforeAddUndoSnapshot'> {
+    /**
+     * Additional state to be added to the snapshot
+     */
+    additionalState: {
+        [key: string]: string;
+    };
+}
+
 /**
  * Provides a chance for plugin to change the content before it is copied from editor.
  */
@@ -5980,6 +5999,12 @@ export interface ContentChangedEvent extends BasePluginEvent<'contentChanged'> {
      * Entities got changed (added or removed) during the content change process
      */
     readonly changedEntities?: ChangedEntity[];
+    /**
+     * Additional state added to the snapshot by plugins
+     */
+    readonly additionalState?: {
+        [key: string]: string;
+    };
     /**
      * Entity states related to this event
      */
@@ -6235,7 +6260,7 @@ export interface MouseUpEvent extends BasePluginDomEvent<'mouseUp', MouseEvent>
 /**
  * Editor plugin event interface
  */
-export type PluginEvent = BeforeCutCopyEvent | BeforeDisposeEvent | BeforeKeyboardEditingEvent | BeforeLogicalRootChangeEvent | BeforePasteEvent | BeforeSetContentEvent | CompositionEndEvent | ContentChangedEvent | ContextMenuEvent | RewriteFromModelEvent | EditImageEvent | EditorReadyEvent | EnterShadowEditEvent | EntityOperationEvent | ExtractContentWithDomEvent | EditorInputEvent | KeyDownEvent | KeyPressEvent | KeyUpEvent | LeaveShadowEditEvent | LogicalRootChangedEvent | MouseDownEvent | MouseUpEvent | ScrollEvent | SelectionChangedEvent | ZoomChangedEvent;
+export type PluginEvent = BeforeAddUndoSnapshotEvent | BeforeCutCopyEvent | BeforeDisposeEvent | BeforeKeyboardEditingEvent | BeforeLogicalRootChangeEvent | BeforePasteEvent | BeforeSetContentEvent | CompositionEndEvent | ContentChangedEvent | ContextMenuEvent | RewriteFromModelEvent | EditImageEvent | EditorReadyEvent | EnterShadowEditEvent | EntityOperationEvent | ExtractContentWithDomEvent | EditorInputEvent | KeyDownEvent | KeyPressEvent | KeyUpEvent | LeaveShadowEditEvent | LogicalRootChangedEvent | MouseDownEvent | MouseUpEvent | ScrollEvent | SelectionChangedEvent | ZoomChangedEvent;
 
 /**
  * A type to extract data part of a plugin event type. Data part is the plugin event without eventType field.
@@ -6375,7 +6400,12 @@ export type PluginEventType = /**
  * This event is used to clean up any features from the old logical root
  * before the new logical root is set.
  */
- | 'beforeLogicalRootChange';
+ | 'beforeLogicalRootChange'
+/**
+ * Before an undo snapshot is added to the undo stack.
+ * This event is used to give plugins a chance to add additional state to the snapshot.
+ */
+ | 'beforeAddUndoSnapshot';
 
 /**
  * This interface represents a PluginEvent wrapping native scroll event

package/dist/rooster-amd.js

@@ -8560,6 +8560,12 @@ var addUndoSnapshot = function (core, canUndoByBackspace, entityStates) {
     var lifecycle = core.lifecycle, physicalRoot = core.physicalRoot, logicalRoot = core.logicalRoot, undo = core.undo;
     var snapshot = null;
     if (!lifecycle.shadowEditFragment) {
+        // Give plugins the chance to add additional state to the snapshot
+        var beforeAddUndoSnapshotEvent = {
+            eventType: 'beforeAddUndoSnapshot',
+            additionalState: {},
+        };
+        core.api.triggerEvent(core, beforeAddUndoSnapshotEvent, false);
         // Need to create snapshot selection before retrieve innerHTML since HTML can be changed during creating selection when normalize table
         var selection = (0, createSnapshotSelection_1.createSnapshotSelection)(core);
         var html = physicalRoot.innerHTML;
@@ -8596,6 +8602,7 @@ var addUndoSnapshot = function (core, canUndoByBackspace, entityStates) {
         }
         snapshot = {
             html: html,
+            additionalState: beforeAddUndoSnapshotEvent.additionalState,
             entityStates: entityStates,
             isDarkMode: !!lifecycle.isDarkMode,
             selection: selection,
@@ -9708,6 +9715,7 @@ var restoreUndoSnapshot = function (core, snapshot) {
         (0, restoreSnapshotColors_1.restoreSnapshotColors)(core, snapshot);
         var event_1 = {
             eventType: 'contentChanged',
+            additionalState: snapshot.additionalState,
             entityStates: snapshot.entityStates,
             source: roosterjs_content_model_dom_1.ChangeSource.SetContent,
         };
@@ -14366,6 +14374,8 @@ var SnapshotsManagerImpl = /** @class */ (function () {
         var currentSnapshot = this.snapshots.snapshots[this.snapshots.currentIndex];
         var isSameSnapshot = currentSnapshot &&
             currentSnapshot.html == snapshot.html &&
+            !currentSnapshot.additionalState &&
+            !snapshot.additionalState &&
             !currentSnapshot.entityStates &&
             !snapshot.entityStates;
         var addSnapshot = !currentSnapshot || shouldAddSnapshot(currentSnapshot, snapshot);
@@ -14431,6 +14441,11 @@ function createSnapshotsManager(snapshots) {
 exports.createSnapshotsManager = createSnapshotsManager;
 function shouldAddSnapshot(currentSnapshot, snapshot) {
     return (currentSnapshot.html !== snapshot.html ||
+        (currentSnapshot.additionalState &&
+            snapshot.additionalState &&
+            JSON.stringify(currentSnapshot.additionalState) !==
+                JSON.stringify(snapshot.additionalState)) ||
+        (!currentSnapshot.additionalState && snapshot.additionalState) ||
         (currentSnapshot.entityStates &&
             snapshot.entityStates &&
             currentSnapshot.entityStates !== snapshot.entityStates) ||