roosterjs 9.30.0 → 9.32.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.30.0)
+// Type definitions for roosterjs (Version 9.32.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -5101,6 +5101,13 @@ 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
@@ -5874,6 +5881,18 @@ interface BasePluginDomEvent<TPluginEventType extends PluginEventType, TRawEvent
     rawEvent: TRawEvent;
 }
 
+    /**
+ * Fired when an undo snapshot is about to be added
+ */
+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.
  */
@@ -5981,6 +6000,12 @@ 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
      */
@@ -6236,7 +6261,7 @@ interface MouseUpEvent extends BasePluginDomEvent<'mouseUp', MouseEvent> {
     /**
  * Editor plugin event interface
  */
-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;
+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.
@@ -6376,7 +6401,12 @@ 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
@@ -8455,9 +8485,9 @@ function setAlignment(editor: IEditor, alignment: 'left' | 'center' | 'right' |
     /**
  * Set text direction of selected paragraphs (Left to right or Right to left)
  * @param editor The editor to set alignment
- * @param direction Direction value: ltr (Left to right) or rtl (Right to left)
+ * @param direction Direction value: ltr (Left to right) or rtl (Right to left), or 'auto' (Based on the first characters of the document, set the direction automatically)
  */
-function setDirection(editor: IEditor, direction: 'ltr' | 'rtl'): void;
+function setDirection(editor: IEditor, direction: 'ltr' | 'rtl' | 'auto'): void;
 
     /**
  * Set heading level of selected paragraphs

package/dist/rooster.js

@@ -2313,6 +2313,11 @@ exports.setModelDirection = void 0;
 var findListItemsInSameThread_1 = __webpack_require__(/*! ../list/findListItemsInSameThread */ "./packages/roosterjs-content-model-api/lib/modelApi/list/findListItemsInSameThread.ts");
 var splitSelectedParagraphByBr_1 = __webpack_require__(/*! ./splitSelectedParagraphByBr */ "./packages/roosterjs-content-model-api/lib/modelApi/block/splitSelectedParagraphByBr.ts");
 var roosterjs_content_model_dom_1 = __webpack_require__(/*! roosterjs-content-model-dom */ "./packages/roosterjs-content-model-dom/lib/index.ts");
+// Regexes for character direction detection
+// Strongly typed RTL character ranges. Referenced unicode's DerivedBidiClass.txt, excluding things in the 2 bit range.
+var RTL_CHAR_REGEX = /[\u0590-\u05FF\u0600-\u08FF\uFB1D-\uFDFF\uFE70-\uFEFF]/g;
+var URL_CHAR_REGEX = /http\S+|www\S+|https\S+|<a\s+(?:[^>]*?\s+)?href=(["']).*?\1.*?>.*?<\/a>/g;
+var WHITESPACE_REGEX = /\s/g;
 /**
  * @internal
  */
@@ -2321,18 +2326,25 @@ function setModelDirection(model, direction) {
     var paragraphOrListItemOrTable = (0, roosterjs_content_model_dom_1.getOperationalBlocks)(model, ['ListItem'], ['TableCell']);
     paragraphOrListItemOrTable.forEach(function (_a) {
         var block = _a.block;
+        var calcDirection;
+        if (direction === 'auto') {
+            calcDirection = determineTextDirection(block);
+        }
+        else {
+            calcDirection = direction;
+        }
         if ((0, roosterjs_content_model_dom_1.isBlockGroupOfType)(block, 'ListItem')) {
             var items = (0, findListItemsInSameThread_1.findListItemsInSameThread)(model, block);
             items.forEach(function (readonlyItem) {
                 var item = (0, roosterjs_content_model_dom_1.mutateBlock)(readonlyItem);
                 item.levels.forEach(function (level) {
-                    level.format.direction = direction;
+                    level.format.direction = calcDirection;
                 });
-                item.blocks.forEach(function (block) { return internalSetDirection(block, direction); });
+                item.blocks.forEach(function (block) { return internalSetDirection(block, calcDirection); });
             });
         }
         else if (block) {
-            internalSetDirection(block, direction);
+            internalSetDirection(block, calcDirection);
         }
     });
     return paragraphOrListItemOrTable.length > 0;
@@ -2379,6 +2391,31 @@ function setProperty(format, key, value) {
         delete format[key];
     }
 }
+// Designed to match browser's 'auto' detection, by scanning over the inner text until it hits a strong LTR/RTL character
+function determineTextDirection(block) {
+    if (block.blockType === 'Paragraph') {
+        var findTextSegements = block.segments.filter(function (seg) { return seg.segmentType === 'Text'; });
+        var innerText = findTextSegements.length > 0
+            ? findTextSegements.reduce(function (prev, seg) { return prev + seg.text; }, '')
+            : undefined;
+        if (!!innerText) {
+            // Remove links
+            innerText = innerText.replace(URL_CHAR_REGEX, '');
+            // Remove whitespace
+            innerText = innerText.replace(WHITESPACE_REGEX, '');
+            var rtlMatches = innerText.match(RTL_CHAR_REGEX);
+            var rtlCount = rtlMatches ? rtlMatches.length : 0;
+            var ltrCount = innerText.length - rtlCount;
+            return rtlCount > ltrCount ? 'rtl' : 'ltr';
+        }
+        else {
+            return 'ltr'; // Default to LTR if no text is found
+        }
+    }
+    else {
+        return 'ltr';
+    }
+}
 
 
 /***/ }),
@@ -4884,7 +4921,7 @@ var setModelDirection_1 = __webpack_require__(/*! ../../modelApi/block/setModelD
 /**
  * Set text direction of selected paragraphs (Left to right or Right to left)
  * @param editor The editor to set alignment
- * @param direction Direction value: ltr (Left to right) or rtl (Right to left)
+ * @param direction Direction value: ltr (Left to right) or rtl (Right to left), or 'auto' (Based on the first characters of the document, set the direction automatically)
  */
 function setDirection(editor, direction) {
     editor.focus();
@@ -8561,6 +8598,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;
@@ -8597,6 +8640,7 @@ var addUndoSnapshot = function (core, canUndoByBackspace, entityStates) {
         }
         snapshot = {
             html: html,
+            additionalState: beforeAddUndoSnapshotEvent.additionalState,
             entityStates: entityStates,
             isDarkMode: !!lifecycle.isDarkMode,
             selection: selection,
@@ -9709,6 +9753,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,
         };
@@ -14367,6 +14412,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);
@@ -14432,6 +14479,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) ||
@@ -31858,7 +31910,7 @@ function keyboardEnter(editor, rawEvent, handleNormalEnter) {
             var steps = rawEvent.shiftKey
                 ? []
                 : [handleAutoLink_1.handleAutoLink, handleEnterOnList_1.handleEnterOnList, deleteEmptyQuote_1.deleteEmptyQuote];
-            if (handleNormalEnter || hasEnterForEntity((_a = result.insertPoint) === null || _a === void 0 ? void 0 : _a.paragraph)) {
+            if (handleNormalEnter || handleEnterForEntity((_a = result.insertPoint) === null || _a === void 0 ? void 0 : _a.paragraph)) {
                 steps.push(handleEnterOnParagraph_1.handleEnterOnParagraph);
             }
             (0, roosterjs_content_model_dom_1.runEditSteps)(steps, result);
@@ -31882,9 +31934,9 @@ function keyboardEnter(editor, rawEvent, handleNormalEnter) {
     });
 }
 exports.keyboardEnter = keyboardEnter;
-function hasEnterForEntity(paragraph) {
+function handleEnterForEntity(paragraph) {
     return (paragraph &&
-        (paragraph.isImplicit || paragraph.segments.some(function (x) { return x.segmentType == 'SelectionMarker'; })));
+        (paragraph.isImplicit || paragraph.segments.some(function (x) { return x.segmentType == 'Entity'; })));
 }