roosterjs 9.45.2 → 9.47.0

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.45.2)
+// Type definitions for roosterjs (Version 9.47.0)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -1294,7 +1294,7 @@ type EntityFormatOperation = /**
     /**
  * Operations used by editTable() API
  */
-type TableOperation = TableVerticalInsertOperation | TableHorizontalInsertOperation | TableDeleteOperation | TableVerticalMergeOperation | TableHorizontalMergeOperation | TableCellMergeOperation | TableSplitOperation | TableAlignOperation | TableCellHorizontalAlignOperation | TableCellVerticalAlignOperation;
+type TableOperation = TableVerticalInsertOperation | TableHorizontalInsertOperation | TableDeleteOperation | TableVerticalMergeOperation | TableHorizontalMergeOperation | TableCellMergeOperation | TableSplitOperation | TableAlignOperation | TableCellHorizontalAlignOperation | TableCellVerticalAlignOperation | TableCellShiftOperation;
 
     /**
  * Operations used by editTable() API for insert table cell vertically
@@ -1428,6 +1428,18 @@ type TableCellVerticalAlignOperation = /**
  */
  | 'alignCellBottom';
 
+    /**
+ * Operations used by editTable() API to shift table cell content up or left
+ */
+type TableCellShiftOperation = /**
+ * Move the table cell content to the cell on the left
+ */
+'shiftCellsLeft'
+/**
+ * Move the table cell content to the cell above
+ */
+ | 'shiftCellsUp';
+
     /**
  * Specify what type of content to paste
  */
@@ -3000,6 +3012,18 @@ interface DomToModelListFormat {
 interface ModelToDomContext extends EditorContext, ModelToDomSelectionContext, ModelToDomFormatContext, ModelToDomSettings, RewriteFromModelContext  {
 }
 
+    /**
+ * Extended context used by segment and text handlers to carry per-paragraph segment state
+ */
+interface ModelToDomSegmentContext extends ModelToDomContext  {
+    /**
+     * Whether the current segment is the last segment in the paragraph,
+     * or there are no more Text segments after it (excluding SelectionMarkers).
+     * When true, trailing spaces should be converted to  .
+     */
+    noFollowingTextSegmentOrLast?: boolean;
+}
+
     /**
  * Represents internal data structure for a selection position, combined by block and segment node
  */
@@ -3140,7 +3164,7 @@ type ContentModelHandler<T extends ContentModelSegment | ContentModelBlockGroup
  * - For segments with decorators: decorator elements will also be included
  * - For inline entity segment, the delimiter SPANs will also be included
  */
-type ContentModelSegmentHandler<T extends ContentModelSegment> = (doc: Document, parent: Node, model: T, context: ModelToDomContext, segmentNodes: Node[]) => void;
+type ContentModelSegmentHandler<T extends ContentModelSegment> = (doc: Document, parent: Node, model: T, context: ModelToDomSegmentContext, segmentNodes: Node[]) => void;
 
     /**
  * Type of Content Model to DOM handler for block
@@ -3536,8 +3560,9 @@ interface Colors {
  * @param baseLValue Base value of light used for dark value calculation
  * @param colorType @optional Type of color, can be text, background, or border
  * @param element @optional Source HTML element of the color
+ * @param comparingColor @optional When generating dark color for background color, we can provide text color as comparingColor to make sure the generated dark border color has enough contrast with text color in dark mode
  */
-type ColorTransformFunction = (lightColor: string, baseLValue?: number, colorType?: 'text' | 'background' | 'border', element?: HTMLElement) => string;
+type ColorTransformFunction = (lightColor: string, baseLValue?: number, colorType?: 'text' | 'background' | 'border', element?: HTMLElement, comparingColor?: string) => string;
 
     /**
  * An interface of Editor, built on top of Content Model
@@ -7493,8 +7518,9 @@ function getColor(element: HTMLElement, isBackground: boolean, isDarkMode: boole
  * @param isBackground True to set background color, false to set text color
  * @param isDarkMode Whether element is in dark mode now
  * @param darkColorHandler @optional The dark color handler object to help manager dark mode color
+ * @param comparingColor @optional When generating dark color for background color, we can provide text color as comparingColor to make sure the generated dark border color has enough contrast with text color in dark mode
  */
-function setColor(element: HTMLElement, color: string | null | undefined, isBackground: boolean, isDarkMode: boolean, darkColorHandler?: DarkColorHandler): void;
+function setColor(element: HTMLElement, color: string | null | undefined, isBackground: boolean, isDarkMode: boolean, darkColorHandler?: DarkColorHandler, comparingColor?: string): void;
 
     /**
  * Parse color string to r/g/b value.
@@ -7573,6 +7599,13 @@ function getSelectionRootNode(selection: DOMSelection | undefined): Node | undef
  */
 function getDOMInsertPointRect(doc: Document, pos: DOMInsertPoint): Rect | null;
 
+    /**
+ * Remove the unselected content from the model
+ * @param model the model document
+ * @param selection The editor selection
+ * */
+function trimModelForSelection(model: ContentModelDocument, selection: DOMSelection): void;
+
     /**
  * Returns true when the event was fired from a key that produces a character value, otherwise false
  * This detection is not 100% accurate. event.key is not fully supported by all browsers, and in some browsers (e.g. IE),
@@ -7595,6 +7628,15 @@ function isModifierKey(event: KeyboardEvent): boolean;
  */
 function isCursorMovingKey(event: KeyboardEvent): boolean;
 
+    /**
+ * Get insertion point from coordinate.
+ * @param doc Parent document object
+ * @param domHelper The DOM helper of the editor
+ * @param x The cursor coordinate for the x-axis
+ * @param y The cursor coordinate for the y-axis
+ */
+function getNodePositionFromEvent(doc: Document, domHelper: DOMHelper, x: number, y: number): DOMInsertPoint | null;
+
     /**
  * Combine border value array back to string
  * @param values Input string values
@@ -7661,7 +7703,7 @@ function retrieveDocumentMetadata(doc: Document): Record<string, string>;
  * @param darkColorHandler The dark color handler object to help do color transformation
  * @param transformColorOptions Configuration options for controlling which elements and styles undergo color transformation.
  */
-function transformColor(rootNode: Node, includeSelf: boolean, direction: 'lightToDark' | 'darkToLight', darkColorHandler?: DarkColorHandler, transformColorOptions?: TransformColorOptions): void;
+function transformColor(rootNode: Node, includeSelf: boolean, direction: 'lightToDark' | 'darkToLight', darkColorHandler?: DarkColorHandler, transformColorOptions?: TransformColorOptions, defaultTextColor?: string): void;
 
     /**
  * Configuration options for controlling which elements and styles undergo color transformation.