roosterjs-content-model-types - npm Package Compare versions

Comparing version 0.24.0 to 0.25.0

lib-amd/editor/IStandaloneEditor.d.ts

@@ -0,1 +1,2 @@
+import type { DOMHelper } from '../parameter/DOMHelper';
 import type { PluginEventData, PluginEventFromType } from '../event/PluginEventData';
@@ -11,6 +12,3 @@ import type { PluginEventType } from '../event/PluginEventType';
 import type { DOMSelection } from '../selection/DOMSelection';
-import type { DomToModelOption } from '../context/DomToModelOption';
 import type { EditorEnvironment } from '../parameter/EditorEnvironment';
-import type { ModelToDomOption } from '../context/ModelToDomOption';
-import type { OnNodeCreated } from '../context/ModelToDomSettings';
 import type { ContentModelFormatter, FormatWithContentModelOptions } from '../parameter/FormatWithContentModelOptions';
@@ -26,16 +24,14 @@ import type { DarkColorHandler } from '../context/DarkColorHandler';
      * Create Content Model from DOM tree in this editor
-     * @param rootNode Optional start node. If provided, Content Model will be created from this node (including itself),
-     * otherwise it will create Content Model for the whole content in editor.
-     * @param option The options to customize the behavior of DOM to Content Model conversion
-     * @param selectionOverride When specified, use this selection to override existing selection inside editor
+     * @param mode What kind of Content Model we want. Currently we support the following values:
+     * - connected: Returns a connect Content Model object. "Connected" means if there is any entity inside editor, the returned Content Model will
+     * contain the same wrapper element for entity. This option should only be used in some special cases. In most cases we should use "disconnected"
+     * to get a fully disconnected Content Model so that any change to the model will not impact editor content.
+     * - disconnected: Returns a disconnected clone of Content Model from editor which you can do any change on it and it won't impact the editor content.
+     * If there is any entity in editor, the returned object will contain cloned copy of entity wrapper element.
+     * If editor is in dark mode, the cloned entity will be converted back to light mode.
+     * - reduced: Returns a reduced Content Model that only contains the model of current selection. If there is already a up-to-date cached model, use it
+     * instead to improve performance. This is mostly used for retrieve current format state.
      */
-    createContentModel(option?: DomToModelOption, selectionOverride?: DOMSelection): ContentModelDocument;
+    getContentModelCopy(mode: 'connected' | 'disconnected' | 'reduced'): ContentModelDocument;
     /**
-     * Set content with content model
-     * @param model The content model to set
-     * @param option Additional options to customize the behavior of Content Model to DOM conversion
-     * @param onNodeCreated An optional callback that will be called when a DOM node is created
-     */
-    setContentModel(model: ContentModelDocument, option?: ModelToDomOption, onNodeCreated?: OnNodeCreated): DOMSelection | null;
-    /**
      * Get current running environment, such as if editor is running on Mac
@@ -74,2 +70,6 @@ */
     /**
+     * Get a DOM Helper object to help access DOM tree in editor
+     */
+    getDOMHelper(): DOMHelper;
+    /**
      * Get document which contains this editor
@@ -108,15 +108,2 @@ * @returns The HTML document which contains this editor
     /**
-     * Get current zoom scale, default value is 1
-     * When editor is put under a zoomed container, need to pass the zoom scale number using EditorOptions.zoomScale
-     * to let editor behave correctly especially for those mouse drag/drop behaviors
-     * @returns current zoom scale number
-     */
-    getZoomScale(): number;
-    /**
-     * Set current zoom scale, default value is 1
-     * When editor is put under a zoomed container, need to pass the zoom scale number using EditorOptions.zoomScale
-     * to let editor behave correctly especially for those mouse drag/drop behaviors
-     */
-    setZoomScale(scale: number): void;
-    /**
      * Add a single undo snapshot to undo stack
@@ -158,7 +145,2 @@ */
     /**
-     * Check if the given DOM node is in editor
-     * @param node The node to check
-     */
-    isNodeInEditor(node: Node): boolean;
-    /**
      * Paste into editor using a clipboardData object
@@ -165,0 +147,0 @@ * @param clipboardData Clipboard data retrieved from clipboard

lib-amd/editor/StandaloneEditorCore.d.ts

@@ -0,1 +1,2 @@
+import type { DOMHelper } from '../parameter/DOMHelper';
 import type { PluginEvent } from '../event/PluginEvent';
@@ -24,4 +25,5 @@ import type { PluginState } from '../pluginState/PluginState';
  * @param core The StandaloneEditorCore object
+ * @param saveIndex True to allow saving index info into node using domIndexer, otherwise false
  */
-export declare type CreateEditorContext = (core: StandaloneEditorCore) => EditorContext;
+export declare type CreateEditorContext = (core: StandaloneEditorCore, saveIndex: boolean) => EditorContext;
 /**
@@ -129,2 +131,3 @@ * Create Content Model from DOM tree in this editor
      * @param core The StandaloneEditorCore object
+     * @param saveIndex True to allow saving index info into node using domIndexer, otherwise false
      */
@@ -269,2 +272,6 @@ createEditorContext: CreateEditorContext;
     /**
+     * A helper class to provide DOM access APIs
+     */
+    readonly domHelper: DOMHelper;
+    /**
      * A callback to be invoked when any exception is thrown during disposing editor
@@ -275,9 +282,2 @@ * @param plugin The plugin that causes exception
     readonly disposeErrorHandler?: (plugin: EditorPlugin, error: Error) => void;
-    /**
-     * @deprecated Will be removed soon.
-     * Current zoom scale, default value is 1
-     * When editor is put under a zoomed container, need to pass the zoom scale number using this property
-     * to let editor behave correctly especially for those mouse drag/drop behaviors
-     */
-    zoomScale: number;
 }
@@ -284,0 +284,0 @@ /**

lib-amd/editor/StandaloneEditorCorePlugins.d.ts

@@ -0,1 +1,2 @@
+import type { ContextMenuPluginState } from '../pluginState/ContextMenuPluginState';
 import type { PluginWithState } from './PluginWithState';
@@ -43,2 +44,6 @@ import type { CopyPastePluginState } from '../pluginState/CopyPastePluginState';
     /**
+     * Undo plugin provides the ability get context menu items and trigger ContextMenu event
+     */
+    readonly contextMenu: PluginWithState<ContextMenuPluginState>;
+    /**
      * Lifecycle plugin handles editor initialization and disposing
@@ -45,0 +50,0 @@ */

lib-amd/editor/StandaloneEditorOptions.d.ts

@@ -95,9 +95,2 @@ import type { Colors, ColorTransformFunction } from '../context/DarkColorHandler';
     disposeErrorHandler?: (plugin: EditorPlugin, error: Error) => void;
-    /**
-     * @deprecated
-     * Current zoom scale, @default value is 1
-     * When editor is put under a zoomed container, need to pass the zoom scale number using this property
-     * to let editor behave correctly especially for those mouse drag/drop behaviors
-     */
-    zoomScale?: number;
 }

lib-amd/event/ZoomChangedEvent.d.ts

@@ -9,6 +9,2 @@ import type { BasePluginEvent } from './BasePluginEvent';
     /**
-     * Zoom scale value before this change
-     */
-    oldZoomScale: number;
-    /**
      * Zoom scale value after this change
@@ -15,0 +11,0 @@ */

lib-amd/format/formatParts/MarginFormat.d.ts

@@ -21,10 +21,2 @@ /**
     marginLeft?: string;
-    /**
-     * Margin-block start value
-     */
-    marginBlockStart?: string;
-    /**
-     * Margin-block end value
-     */
-    marginBlockEnd?: string;
 };

lib-amd/index.d.ts

@@ -111,2 +111,3 @@ export { ContentModelSegmentFormat } from './format/ContentModelSegmentFormat';
 export { ContentModelDomIndexer } from './context/ContentModelDomIndexer';
+export { TextMutationObserver } from './context/TextMutationObserver';
 export { DefinitionType } from './metadata/DefinitionType';
@@ -131,2 +132,3 @@ export { ArrayItemType, DefinitionBase, StringDefinition, NumberDefinition, BooleanDefinition, ArrayDefinition, ObjectPropertyDefinition, ObjectDefinition, Definition, } from './metadata/Definition';
 export { PluginKey, KeyOfStatePlugin, TypeOfStatePlugin, StatePluginKeys, GenericPluginState, PluginState, } from './pluginState/PluginState';
+export { ContextMenuPluginState } from './pluginState/ContextMenuPluginState';
 export { EditorEnvironment } from './parameter/EditorEnvironment';
@@ -149,2 +151,3 @@ export { EntityState, DeletedEntity, FormatWithContentModelContext, } from './parameter/FormatWithContentModelContext';
 export { ValueSanitizer } from './parameter/ValueSanitizer';
+export { DOMHelper } from './parameter/DOMHelper';
 export { BasePluginEvent, BasePluginDomEvent } from './event/BasePluginEvent';
@@ -151,0 +154,0 @@ export { BeforeCutCopyEvent } from './event/BeforeCutCopyEvent';

lib-amd/parameter/ContentModelFormatState.d.ts

@@ -143,6 +143,2 @@ import type { TableMetadataFormat } from '../format/metadata/TableMetadataFormat';
     isDarkMode?: boolean;
-    /**
-     * Current zoom scale of editor
-     */
-    zoomScale?: number;
 }

lib-amd/parameter/Snapshot.d.ts

@@ -25,2 +25,7 @@ import type { TableSelectionCoordinates } from '../selection/TableSelectionCoordinates';
     end: number[];
+    /**
+     * Whether the selection was from left to right (in document order) or
+     * right to left (reverse of document order)
+     */
+    isReverted: boolean;
 }
@@ -27,0 +32,0 @@ /**

lib-amd/pluginState/ContentModelCachePluginState.d.ts

@@ -0,1 +1,2 @@
+import type { TextMutationObserver } from '../context/TextMutationObserver';
 import type { ContentModelDocument } from '../group/ContentModelDocument';
@@ -20,2 +21,6 @@ import type { ContentModelDomIndexer } from '../context/ContentModelDomIndexer';
     domIndexer?: ContentModelDomIndexer;
+    /**
+     * @optional A wrapper of MutationObserver to help detect text changes in editor
+     */
+    textMutationObserver?: TextMutationObserver;
 }

lib-amd/selection/DOMSelection.d.ts

@@ -28,2 +28,7 @@ import type { TableSelectionCoordinates } from '../selection/TableSelectionCoordinates';
     range: Range;
+    /**
+     * Whether the selection was from left to right (in document order) or
+     * right to left (reverse of document order)
+     */
+    isReverted: boolean;
 }
@@ -30,0 +35,0 @@ /**

lib-mjs/editor/IStandaloneEditor.d.ts

@@ -0,1 +1,2 @@
+import type { DOMHelper } from '../parameter/DOMHelper';
 import type { PluginEventData, PluginEventFromType } from '../event/PluginEventData';
@@ -11,6 +12,3 @@ import type { PluginEventType } from '../event/PluginEventType';
 import type { DOMSelection } from '../selection/DOMSelection';
-import type { DomToModelOption } from '../context/DomToModelOption';
 import type { EditorEnvironment } from '../parameter/EditorEnvironment';
-import type { ModelToDomOption } from '../context/ModelToDomOption';
-import type { OnNodeCreated } from '../context/ModelToDomSettings';
 import type { ContentModelFormatter, FormatWithContentModelOptions } from '../parameter/FormatWithContentModelOptions';
@@ -26,16 +24,14 @@ import type { DarkColorHandler } from '../context/DarkColorHandler';
      * Create Content Model from DOM tree in this editor
-     * @param rootNode Optional start node. If provided, Content Model will be created from this node (including itself),
-     * otherwise it will create Content Model for the whole content in editor.
-     * @param option The options to customize the behavior of DOM to Content Model conversion
-     * @param selectionOverride When specified, use this selection to override existing selection inside editor
+     * @param mode What kind of Content Model we want. Currently we support the following values:
+     * - connected: Returns a connect Content Model object. "Connected" means if there is any entity inside editor, the returned Content Model will
+     * contain the same wrapper element for entity. This option should only be used in some special cases. In most cases we should use "disconnected"
+     * to get a fully disconnected Content Model so that any change to the model will not impact editor content.
+     * - disconnected: Returns a disconnected clone of Content Model from editor which you can do any change on it and it won't impact the editor content.
+     * If there is any entity in editor, the returned object will contain cloned copy of entity wrapper element.
+     * If editor is in dark mode, the cloned entity will be converted back to light mode.
+     * - reduced: Returns a reduced Content Model that only contains the model of current selection. If there is already a up-to-date cached model, use it
+     * instead to improve performance. This is mostly used for retrieve current format state.
      */
-    createContentModel(option?: DomToModelOption, selectionOverride?: DOMSelection): ContentModelDocument;
+    getContentModelCopy(mode: 'connected' | 'disconnected' | 'reduced'): ContentModelDocument;
     /**
-     * Set content with content model
-     * @param model The content model to set
-     * @param option Additional options to customize the behavior of Content Model to DOM conversion
-     * @param onNodeCreated An optional callback that will be called when a DOM node is created
-     */
-    setContentModel(model: ContentModelDocument, option?: ModelToDomOption, onNodeCreated?: OnNodeCreated): DOMSelection | null;
-    /**
      * Get current running environment, such as if editor is running on Mac
@@ -74,2 +70,6 @@ */
     /**
+     * Get a DOM Helper object to help access DOM tree in editor
+     */
+    getDOMHelper(): DOMHelper;
+    /**
      * Get document which contains this editor
@@ -108,15 +108,2 @@ * @returns The HTML document which contains this editor
     /**
-     * Get current zoom scale, default value is 1
-     * When editor is put under a zoomed container, need to pass the zoom scale number using EditorOptions.zoomScale
-     * to let editor behave correctly especially for those mouse drag/drop behaviors
-     * @returns current zoom scale number
-     */
-    getZoomScale(): number;
-    /**
-     * Set current zoom scale, default value is 1
-     * When editor is put under a zoomed container, need to pass the zoom scale number using EditorOptions.zoomScale
-     * to let editor behave correctly especially for those mouse drag/drop behaviors
-     */
-    setZoomScale(scale: number): void;
-    /**
      * Add a single undo snapshot to undo stack
@@ -158,7 +145,2 @@ */
     /**
-     * Check if the given DOM node is in editor
-     * @param node The node to check
-     */
-    isNodeInEditor(node: Node): boolean;
-    /**
      * Paste into editor using a clipboardData object
@@ -165,0 +147,0 @@ * @param clipboardData Clipboard data retrieved from clipboard

lib-mjs/editor/StandaloneEditorCore.d.ts

@@ -0,1 +1,2 @@
+import type { DOMHelper } from '../parameter/DOMHelper';
 import type { PluginEvent } from '../event/PluginEvent';
@@ -24,4 +25,5 @@ import type { PluginState } from '../pluginState/PluginState';
  * @param core The StandaloneEditorCore object
+ * @param saveIndex True to allow saving index info into node using domIndexer, otherwise false
  */
-export declare type CreateEditorContext = (core: StandaloneEditorCore) => EditorContext;
+export declare type CreateEditorContext = (core: StandaloneEditorCore, saveIndex: boolean) => EditorContext;
 /**
@@ -129,2 +131,3 @@ * Create Content Model from DOM tree in this editor
      * @param core The StandaloneEditorCore object
+     * @param saveIndex True to allow saving index info into node using domIndexer, otherwise false
      */
@@ -269,2 +272,6 @@ createEditorContext: CreateEditorContext;
     /**
+     * A helper class to provide DOM access APIs
+     */
+    readonly domHelper: DOMHelper;
+    /**
      * A callback to be invoked when any exception is thrown during disposing editor
@@ -275,9 +282,2 @@ * @param plugin The plugin that causes exception
     readonly disposeErrorHandler?: (plugin: EditorPlugin, error: Error) => void;
-    /**
-     * @deprecated Will be removed soon.
-     * Current zoom scale, default value is 1
-     * When editor is put under a zoomed container, need to pass the zoom scale number using this property
-     * to let editor behave correctly especially for those mouse drag/drop behaviors
-     */
-    zoomScale: number;
 }
@@ -284,0 +284,0 @@ /**

lib-mjs/editor/StandaloneEditorCorePlugins.d.ts

@@ -0,1 +1,2 @@
+import type { ContextMenuPluginState } from '../pluginState/ContextMenuPluginState';
 import type { PluginWithState } from './PluginWithState';
@@ -43,2 +44,6 @@ import type { CopyPastePluginState } from '../pluginState/CopyPastePluginState';
     /**
+     * Undo plugin provides the ability get context menu items and trigger ContextMenu event
+     */
+    readonly contextMenu: PluginWithState<ContextMenuPluginState>;
+    /**
      * Lifecycle plugin handles editor initialization and disposing
@@ -45,0 +50,0 @@ */

lib-mjs/editor/StandaloneEditorOptions.d.ts

@@ -95,9 +95,2 @@ import type { Colors, ColorTransformFunction } from '../context/DarkColorHandler';
     disposeErrorHandler?: (plugin: EditorPlugin, error: Error) => void;
-    /**
-     * @deprecated
-     * Current zoom scale, @default value is 1
-     * When editor is put under a zoomed container, need to pass the zoom scale number using this property
-     * to let editor behave correctly especially for those mouse drag/drop behaviors
-     */
-    zoomScale?: number;
 }

lib-mjs/event/ZoomChangedEvent.d.ts

@@ -9,6 +9,2 @@ import type { BasePluginEvent } from './BasePluginEvent';
     /**
-     * Zoom scale value before this change
-     */
-    oldZoomScale: number;
-    /**
      * Zoom scale value after this change
@@ -15,0 +11,0 @@ */

lib-mjs/format/formatParts/MarginFormat.d.ts

@@ -21,10 +21,2 @@ /**
     marginLeft?: string;
-    /**
-     * Margin-block start value
-     */
-    marginBlockStart?: string;
-    /**
-     * Margin-block end value
-     */
-    marginBlockEnd?: string;
 };

lib-mjs/index.d.ts

@@ -111,2 +111,3 @@ export { ContentModelSegmentFormat } from './format/ContentModelSegmentFormat';
 export { ContentModelDomIndexer } from './context/ContentModelDomIndexer';
+export { TextMutationObserver } from './context/TextMutationObserver';
 export { DefinitionType } from './metadata/DefinitionType';
@@ -131,2 +132,3 @@ export { ArrayItemType, DefinitionBase, StringDefinition, NumberDefinition, BooleanDefinition, ArrayDefinition, ObjectPropertyDefinition, ObjectDefinition, Definition, } from './metadata/Definition';
 export { PluginKey, KeyOfStatePlugin, TypeOfStatePlugin, StatePluginKeys, GenericPluginState, PluginState, } from './pluginState/PluginState';
+export { ContextMenuPluginState } from './pluginState/ContextMenuPluginState';
 export { EditorEnvironment } from './parameter/EditorEnvironment';
@@ -149,2 +151,3 @@ export { EntityState, DeletedEntity, FormatWithContentModelContext, } from './parameter/FormatWithContentModelContext';
 export { ValueSanitizer } from './parameter/ValueSanitizer';
+export { DOMHelper } from './parameter/DOMHelper';
 export { BasePluginEvent, BasePluginDomEvent } from './event/BasePluginEvent';
@@ -151,0 +154,0 @@ export { BeforeCutCopyEvent } from './event/BeforeCutCopyEvent';

lib-mjs/parameter/ContentModelFormatState.d.ts

@@ -143,6 +143,2 @@ import type { TableMetadataFormat } from '../format/metadata/TableMetadataFormat';
     isDarkMode?: boolean;
-    /**
-     * Current zoom scale of editor
-     */
-    zoomScale?: number;
 }

lib-mjs/parameter/Snapshot.d.ts

@@ -25,2 +25,7 @@ import type { TableSelectionCoordinates } from '../selection/TableSelectionCoordinates';
     end: number[];
+    /**
+     * Whether the selection was from left to right (in document order) or
+     * right to left (reverse of document order)
+     */
+    isReverted: boolean;
 }
@@ -27,0 +32,0 @@ /**

lib-mjs/pluginState/ContentModelCachePluginState.d.ts

@@ -0,1 +1,2 @@
+import type { TextMutationObserver } from '../context/TextMutationObserver';
 import type { ContentModelDocument } from '../group/ContentModelDocument';
@@ -20,2 +21,6 @@ import type { ContentModelDomIndexer } from '../context/ContentModelDomIndexer';
     domIndexer?: ContentModelDomIndexer;
+    /**
+     * @optional A wrapper of MutationObserver to help detect text changes in editor
+     */
+    textMutationObserver?: TextMutationObserver;
 }

lib-mjs/selection/DOMSelection.d.ts

@@ -28,2 +28,7 @@ import type { TableSelectionCoordinates } from '../selection/TableSelectionCoordinates';
     range: Range;
+    /**
+     * Whether the selection was from left to right (in document order) or
+     * right to left (reverse of document order)
+     */
+    isReverted: boolean;
 }
@@ -30,0 +35,0 @@ /**

lib/editor/IStandaloneEditor.d.ts

@@ -0,1 +1,2 @@
+import type { DOMHelper } from '../parameter/DOMHelper';
 import type { PluginEventData, PluginEventFromType } from '../event/PluginEventData';
@@ -11,6 +12,3 @@ import type { PluginEventType } from '../event/PluginEventType';
 import type { DOMSelection } from '../selection/DOMSelection';
-import type { DomToModelOption } from '../context/DomToModelOption';
 import type { EditorEnvironment } from '../parameter/EditorEnvironment';
-import type { ModelToDomOption } from '../context/ModelToDomOption';
-import type { OnNodeCreated } from '../context/ModelToDomSettings';
 import type { ContentModelFormatter, FormatWithContentModelOptions } from '../parameter/FormatWithContentModelOptions';
@@ -26,16 +24,14 @@ import type { DarkColorHandler } from '../context/DarkColorHandler';
      * Create Content Model from DOM tree in this editor
-     * @param rootNode Optional start node. If provided, Content Model will be created from this node (including itself),
-     * otherwise it will create Content Model for the whole content in editor.
-     * @param option The options to customize the behavior of DOM to Content Model conversion
-     * @param selectionOverride When specified, use this selection to override existing selection inside editor
+     * @param mode What kind of Content Model we want. Currently we support the following values:
+     * - connected: Returns a connect Content Model object. "Connected" means if there is any entity inside editor, the returned Content Model will
+     * contain the same wrapper element for entity. This option should only be used in some special cases. In most cases we should use "disconnected"
+     * to get a fully disconnected Content Model so that any change to the model will not impact editor content.
+     * - disconnected: Returns a disconnected clone of Content Model from editor which you can do any change on it and it won't impact the editor content.
+     * If there is any entity in editor, the returned object will contain cloned copy of entity wrapper element.
+     * If editor is in dark mode, the cloned entity will be converted back to light mode.
+     * - reduced: Returns a reduced Content Model that only contains the model of current selection. If there is already a up-to-date cached model, use it
+     * instead to improve performance. This is mostly used for retrieve current format state.
      */
-    createContentModel(option?: DomToModelOption, selectionOverride?: DOMSelection): ContentModelDocument;
+    getContentModelCopy(mode: 'connected' | 'disconnected' | 'reduced'): ContentModelDocument;
     /**
-     * Set content with content model
-     * @param model The content model to set
-     * @param option Additional options to customize the behavior of Content Model to DOM conversion
-     * @param onNodeCreated An optional callback that will be called when a DOM node is created
-     */
-    setContentModel(model: ContentModelDocument, option?: ModelToDomOption, onNodeCreated?: OnNodeCreated): DOMSelection | null;
-    /**
      * Get current running environment, such as if editor is running on Mac
@@ -74,2 +70,6 @@ */
     /**
+     * Get a DOM Helper object to help access DOM tree in editor
+     */
+    getDOMHelper(): DOMHelper;
+    /**
      * Get document which contains this editor
@@ -108,15 +108,2 @@ * @returns The HTML document which contains this editor
     /**
-     * Get current zoom scale, default value is 1
-     * When editor is put under a zoomed container, need to pass the zoom scale number using EditorOptions.zoomScale
-     * to let editor behave correctly especially for those mouse drag/drop behaviors
-     * @returns current zoom scale number
-     */
-    getZoomScale(): number;
-    /**
-     * Set current zoom scale, default value is 1
-     * When editor is put under a zoomed container, need to pass the zoom scale number using EditorOptions.zoomScale
-     * to let editor behave correctly especially for those mouse drag/drop behaviors
-     */
-    setZoomScale(scale: number): void;
-    /**
      * Add a single undo snapshot to undo stack
@@ -158,7 +145,2 @@ */
     /**
-     * Check if the given DOM node is in editor
-     * @param node The node to check
-     */
-    isNodeInEditor(node: Node): boolean;
-    /**
      * Paste into editor using a clipboardData object
@@ -165,0 +147,0 @@ * @param clipboardData Clipboard data retrieved from clipboard

lib/editor/StandaloneEditorCore.d.ts

@@ -0,1 +1,2 @@
+import type { DOMHelper } from '../parameter/DOMHelper';
 import type { PluginEvent } from '../event/PluginEvent';
@@ -24,4 +25,5 @@ import type { PluginState } from '../pluginState/PluginState';
  * @param core The StandaloneEditorCore object
+ * @param saveIndex True to allow saving index info into node using domIndexer, otherwise false
  */
-export declare type CreateEditorContext = (core: StandaloneEditorCore) => EditorContext;
+export declare type CreateEditorContext = (core: StandaloneEditorCore, saveIndex: boolean) => EditorContext;
 /**
@@ -129,2 +131,3 @@ * Create Content Model from DOM tree in this editor
      * @param core The StandaloneEditorCore object
+     * @param saveIndex True to allow saving index info into node using domIndexer, otherwise false
      */
@@ -269,2 +272,6 @@ createEditorContext: CreateEditorContext;
     /**
+     * A helper class to provide DOM access APIs
+     */
+    readonly domHelper: DOMHelper;
+    /**
      * A callback to be invoked when any exception is thrown during disposing editor
@@ -275,9 +282,2 @@ * @param plugin The plugin that causes exception
     readonly disposeErrorHandler?: (plugin: EditorPlugin, error: Error) => void;
-    /**
-     * @deprecated Will be removed soon.
-     * Current zoom scale, default value is 1
-     * When editor is put under a zoomed container, need to pass the zoom scale number using this property
-     * to let editor behave correctly especially for those mouse drag/drop behaviors
-     */
-    zoomScale: number;
 }
@@ -284,0 +284,0 @@ /**

lib/editor/StandaloneEditorCorePlugins.d.ts

@@ -0,1 +1,2 @@
+import type { ContextMenuPluginState } from '../pluginState/ContextMenuPluginState';
 import type { PluginWithState } from './PluginWithState';
@@ -43,2 +44,6 @@ import type { CopyPastePluginState } from '../pluginState/CopyPastePluginState';
     /**
+     * Undo plugin provides the ability get context menu items and trigger ContextMenu event
+     */
+    readonly contextMenu: PluginWithState<ContextMenuPluginState>;
+    /**
      * Lifecycle plugin handles editor initialization and disposing
@@ -45,0 +50,0 @@ */

lib/editor/StandaloneEditorOptions.d.ts

@@ -95,9 +95,2 @@ import type { Colors, ColorTransformFunction } from '../context/DarkColorHandler';
     disposeErrorHandler?: (plugin: EditorPlugin, error: Error) => void;
-    /**
-     * @deprecated
-     * Current zoom scale, @default value is 1
-     * When editor is put under a zoomed container, need to pass the zoom scale number using this property
-     * to let editor behave correctly especially for those mouse drag/drop behaviors
-     */
-    zoomScale?: number;
 }

lib/event/ZoomChangedEvent.d.ts

@@ -9,6 +9,2 @@ import type { BasePluginEvent } from './BasePluginEvent';
     /**
-     * Zoom scale value before this change
-     */
-    oldZoomScale: number;
-    /**
      * Zoom scale value after this change
@@ -15,0 +11,0 @@ */

lib/format/formatParts/MarginFormat.d.ts

@@ -21,10 +21,2 @@ /**
     marginLeft?: string;
-    /**
-     * Margin-block start value
-     */
-    marginBlockStart?: string;
-    /**
-     * Margin-block end value
-     */
-    marginBlockEnd?: string;
 };

lib/index.d.ts

@@ -111,2 +111,3 @@ export { ContentModelSegmentFormat } from './format/ContentModelSegmentFormat';
 export { ContentModelDomIndexer } from './context/ContentModelDomIndexer';
+export { TextMutationObserver } from './context/TextMutationObserver';
 export { DefinitionType } from './metadata/DefinitionType';
@@ -131,2 +132,3 @@ export { ArrayItemType, DefinitionBase, StringDefinition, NumberDefinition, BooleanDefinition, ArrayDefinition, ObjectPropertyDefinition, ObjectDefinition, Definition, } from './metadata/Definition';
 export { PluginKey, KeyOfStatePlugin, TypeOfStatePlugin, StatePluginKeys, GenericPluginState, PluginState, } from './pluginState/PluginState';
+export { ContextMenuPluginState } from './pluginState/ContextMenuPluginState';
 export { EditorEnvironment } from './parameter/EditorEnvironment';
@@ -149,2 +151,3 @@ export { EntityState, DeletedEntity, FormatWithContentModelContext, } from './parameter/FormatWithContentModelContext';
 export { ValueSanitizer } from './parameter/ValueSanitizer';
+export { DOMHelper } from './parameter/DOMHelper';
 export { BasePluginEvent, BasePluginDomEvent } from './event/BasePluginEvent';
@@ -151,0 +154,0 @@ export { BeforeCutCopyEvent } from './event/BeforeCutCopyEvent';

lib/parameter/ContentModelFormatState.d.ts

@@ -143,6 +143,2 @@ import type { TableMetadataFormat } from '../format/metadata/TableMetadataFormat';
     isDarkMode?: boolean;
-    /**
-     * Current zoom scale of editor
-     */
-    zoomScale?: number;
 }

lib/parameter/Snapshot.d.ts

@@ -25,2 +25,7 @@ import type { TableSelectionCoordinates } from '../selection/TableSelectionCoordinates';
     end: number[];
+    /**
+     * Whether the selection was from left to right (in document order) or
+     * right to left (reverse of document order)
+     */
+    isReverted: boolean;
 }
@@ -27,0 +32,0 @@ /**

lib/pluginState/ContentModelCachePluginState.d.ts

@@ -0,1 +1,2 @@
+import type { TextMutationObserver } from '../context/TextMutationObserver';
 import type { ContentModelDocument } from '../group/ContentModelDocument';
@@ -20,2 +21,6 @@ import type { ContentModelDomIndexer } from '../context/ContentModelDomIndexer';
     domIndexer?: ContentModelDomIndexer;
+    /**
+     * @optional A wrapper of MutationObserver to help detect text changes in editor
+     */
+    textMutationObserver?: TextMutationObserver;
 }

lib/selection/DOMSelection.d.ts

@@ -28,2 +28,7 @@ import type { TableSelectionCoordinates } from '../selection/TableSelectionCoordinates';
     range: Range;
+    /**
+     * Whether the selection was from left to right (in document order) or
+     * right to left (reverse of document order)
+     */
+    isReverted: boolean;
 }
@@ -30,0 +35,0 @@ /**

package.json

@@ -5,3 +5,3 @@ {
     "dependencies": {},
-    "version": "0.24.0",
+    "version": "0.25.0",
     "main": "./lib/index.js",
@@ -8,0 +8,0 @@ "typings": "./lib/index.d.ts",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1324339

increased by0.98%

Number of package files

1551

increased by1.77%

Lines of code

16597

increased by0.8%

No dependency changes