roosterjs 9.44.0 → 9.45.1

package/dist/rooster.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for roosterjs (Version 9.44.0)
+// Type definitions for roosterjs (Version 9.45.1)
 // Generated by dts tool from roosterjs
 // Project: https://github.com/Microsoft/roosterjs
 
@@ -41,7 +41,7 @@ interface ReadonlyContentModelWithFormat<T extends ContentModelFormatBase> {
     /**
  * Format of Table
  */
-type ContentModelTableFormat = ContentModelBlockFormat & IdFormat & AriaFormat & BorderFormat & BorderBoxFormat & DirectionFormat & SpacingFormat & MarginFormat & DisplayFormat & TableLayoutFormat & SizeFormat & RoleFormat;
+type ContentModelTableFormat = ContentModelBlockFormat & IdFormat & AriaFormat & BorderFormat & BorderBoxFormat & DirectionFormat & SpacingFormat & MarginFormat & DisplayFormat & TableLayoutFormat & SizeFormat & RoleFormat & LegacyTableBorderFormat;
 
     /**
  * Represents base format of an element that supports dataset and/or metadata
@@ -267,6 +267,10 @@ interface FormatHandlerTypeMap {
      * Format for BorderBoxFormat
      */
     borderBox: BorderBoxFormat;
+    /**
+     * Format for the Border Colors
+     */
+    borderColor: BorderFormat;
     /**
      * Format for BoxShadowFormat
      */
@@ -315,6 +319,10 @@ interface FormatHandlerTypeMap {
      * Format for ItalicFormat
      */
     italic: ItalicFormat;
+    /**
+     * Format for LegacyTableBorderFormat
+     */
+    legacyTableBorder: LegacyTableBorderFormat;
     /**
      * Format for LetterSpacingFormat
      */
@@ -327,6 +335,10 @@ interface FormatHandlerTypeMap {
      * Format for LinkFormat
      */
     link: LinkFormat;
+    /**
+     * Format for TextAlignFormat under list item
+     */
+    listItemAlign: TextAlignFormat;
     /**
      * Format for ListThreadFormat (used by list item)
      */
@@ -919,6 +931,31 @@ type RoleFormat = {
     role?: string;
 };
 
+    /**
+ * Format for legacy table border.
+ * This is used for supporting legacy table border rendering in some scenarios.
+ */
+type LegacyTableBorderFormat = {
+    /**
+     * The value of border attribute on table element.
+     * Although this attribute is deprecated in HTML5, some email clients still rely on it.
+     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableElement/border
+     */
+    legacyTableBorder?: string;
+    /**
+     * The value of cellspacing attribute on table element.
+     * This attribute is deprecated in HTML5, but still used in some legacy scenarios.
+     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableElement/cellSpacing
+     */
+    cellSpacing?: string;
+    /**
+     * The value of cellpadding attribute on table element.
+     * This attribute is deprecated in HTML5, but still used in some legacy scenarios.
+     * https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableElement/cellPadding
+     */
+    cellPadding?: string;
+};
+
     /**
  * Represents dataset format of Content Model
  */
@@ -3714,7 +3751,11 @@ type ExperimentalFeature = GraduatedExperimentalFeature
 /**
  * Allow caching list item elements.
  */
- | 'CacheList';
+ | 'CacheList'
+/**
+ * Transform the table border colors when switching from light to dark mode
+ */
+ | 'TransformTableBorderColors';
 
     /**
  * Predefined experiment features (Graduated, only keep them for backward compatibility)
@@ -4675,6 +4716,10 @@ interface AutoLinkOptions {
  * Current running environment
  */
 interface EditorEnvironment {
+    /**
+     * Document object of the editor
+     */
+    readonly document: Document;
     /**
      * Whether editor is running on Mac
      */
@@ -6063,6 +6108,11 @@ interface PromotedLink {
     href: string;
 }
 
+    /**
+ * The keyfor BorderFormat
+ */
+type BorderKey = 'borderTop' | 'borderRight' | 'borderBottom' | 'borderLeft';
+
     /**
  * Editor plugin event interface
  */
@@ -6802,6 +6852,16 @@ const entityProcessor: ElementProcessor<HTMLElement>;
  */
 const tableProcessor: ElementProcessor<HTMLTableElement>;
 
+    /**
+ * Content Model Element Processor for format container elements (e.g., blockquote, div)
+ * Processes elements that create FormatContainer blocks in the content model.
+ * This processor can be used in processorOverride to customize how specific elements are processed.
+ * @param group The parent block group
+ * @param element The DOM element to process
+ * @param context DOM to Content Model context
+ */
+const formatContainerProcessor: ElementProcessor<HTMLElement>;
+
     /**
  * Get offset numbers of a regular (range based) selection.
  * If the selection start/end position is not in the given node, it will return -1 for the related value
@@ -7409,7 +7469,7 @@ function parseValueWithUnit(value?: string, currentSizePxOrElement?: number | HT
     /**
  * Keys of border items
  */
-const BorderKeys: (keyof BorderFormat & keyof CSSStyleDeclaration)[];
+const BorderKeys: (BorderKey & keyof BorderFormat & keyof CSSStyleDeclaration)[];
 
     /**
  * List of deprecated colors
@@ -7594,12 +7654,22 @@ function retrieveDocumentMetadata(doc: Document): Record<string, string>;
 
     /**
  * Edit and transform color of elements between light mode and dark mode
+ * By default, text and background colors are transformed for all elements.
  * @param rootNode The root DOM node to transform
  * @param includeSelf True to transform the root node as well, otherwise false
  * @param direction To specify the transform direction, light to dark, or dark to light
  * @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): void;
+function transformColor(rootNode: Node, includeSelf: boolean, direction: 'lightToDark' | 'darkToLight', darkColorHandler?: DarkColorHandler, transformColorOptions?: TransformColorOptions): void;
+
+    /**
+ * Configuration options for controlling which elements and styles undergo color transformation.
+ * By default, text and background colors are transformed for all elements.
+ */
+interface TransformColorOptions {
+    tableBorders: boolean;
+}
 
     /**
  * Normalize font family string to a standard format
@@ -7904,7 +7974,7 @@ function setFirstColumnFormatBorders(rows: ShallowMutableContentModelTableRow[],
  * Normalize a Content Model table, make sure:
  * 1. Fist cells are not spanned
  * 2. Only first column and row can have headers
- * 3. All cells have content and width
+ * 3. All cells have content
  * 4. Table and table row have correct width/height
  * 5. Spanned cell has no child blocks
  * 6. default format is correctly applied
@@ -8621,8 +8691,9 @@ function getContentForCopy(editor: IEditor, isCut: boolean, event: ClipboardEven
  * @param rows Number of rows in table
  * @param tableMetadataFormat (Optional) The table format that are stored as metadata. If not passed, the default format will be applied: background color: #FFF; border color: #ABABAB
  * @param format (Optional) The table format used for style attributes
+ * @param cellFormat (Optional) custom format for table cells, except for borders styles, for borders use tableMetadataFormat
  */
-function insertTable(editor: IEditor, columns: number, rows: number, tableMetadataFormat?: Partial<TableMetadataFormat>, format?: ContentModelTableFormat): void;
+function insertTable(editor: IEditor, columns: number, rows: number, tableMetadataFormat?: Partial<TableMetadataFormat>, format?: ContentModelTableFormat, customCellFormat?: ContentModelTableCellFormat): void;
 
     /**
  * Format current focused table with the given format
@@ -9203,7 +9274,7 @@ type OnTableEditorCreatedCallback = (featureType: TableEditFeatureName, element:
     /**
  * Names of table edit features
  */
-type TableEditFeatureName = 'HorizontalTableInserter' | 'VerticalTableInserter' | 'TableMover' | 'TableResizer' | 'TableSelector' | 'CellResizer';
+type TableEditFeatureName = 'HorizontalTableInserter' | 'VerticalTableInserter' | 'TableMover' | 'TableResizer' | 'TableSelector' | 'CellResizer' | 'TableRowSelector' | 'TableColumnSelector';
 
     /**
  * Represents a table and its container (logical root)