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

Comparing version 0.27.0 to 0.28.0

lib-amd/editor/EditorCore.d.ts

@@ -5,4 +5,2 @@ import type { DOMHelper } from '../parameter/DOMHelper';
 import type { EditorPlugin } from './EditorPlugin';
-import type { ClipboardData } from '../parameter/ClipboardData';
-import type { PasteType } from '../enum/PasteType';
 import type { DOMEventRecord } from '../parameter/DOMEventRecord';
@@ -15,7 +13,6 @@ import type { Snapshot } from '../parameter/Snapshot';
 import type { DomToModelOption } from '../context/DomToModelOption';
-import type { DomToModelSettings } from '../context/DomToModelSettings';
 import type { EditorContext } from '../context/EditorContext';
 import type { EditorEnvironment } from '../parameter/EditorEnvironment';
 import type { ModelToDomOption } from '../context/ModelToDomOption';
-import type { ModelToDomSettings, OnNodeCreated } from '../context/ModelToDomSettings';
+import type { OnNodeCreated } from '../context/ModelToDomSettings';
 import type { TrustedHTMLHandler } from '../parameter/TrustedHTMLHandler';
@@ -34,5 +31,6 @@ import type { Rect } from '../parameter/Rect';
  * @param option The option to customize the behavior of DOM to Content Model conversion
- * @param selectionOverride When passed, use this selection range instead of current selection in editor
+ * @param selectionOverride When passed a valid selection, use this selection range instead of current selection in editor.
+ * When pass "none", it means we don't need a selection in content model
  */
-export declare type CreateContentModel = (core: EditorCore, option?: DomToModelOption, selectionOverride?: DOMSelection) => ContentModelDocument;
+export declare type CreateContentModel = (core: EditorCore, option?: DomToModelOption, selectionOverride?: DOMSelection | 'none') => ContentModelDocument;
 /**
@@ -96,8 +94,2 @@ * Get current DOM selection from editor
 /**
- * Check if the editor has focus now
- * @param core The EditorCore object
- * @returns True if the editor has focus, otherwise false
- */
-export declare type HasFocus = (core: EditorCore) => boolean;
-/**
  * Focus to editor. If there is a cached selection range, use it as current selection
@@ -120,9 +112,2 @@ * @param core The EditorCore object
 /**
- * Paste into editor using a clipboardData object
- * @param core The EditorCore object.
- * @param clipboardData Clipboard data retrieved from clipboard
- * @param pasteType Type of content to paste. @default normal
- */
-export declare type Paste = (core: EditorCore, clipboardData: ClipboardData, pasteType: PasteType) => void;
-/**
  * The interface for the map of core API for Editor.
@@ -133,5 +118,7 @@ * Editor can call call API from this map under EditorCore object
     /**
-     * Create a EditorContext object used by ContentModel API
+     * Create Content Model from DOM tree in this editor
      * @param core The EditorCore object
-     * @param saveIndex True to allow saving index info into node using domIndexer, otherwise false
+     * @param option The option to customize the behavior of DOM to Content Model conversion
+     * @param selectionOverride When passed a valid selection, use this selection range instead of current selection in editor.
+     * When pass "none", it means we don't need a selection in content model
      */
@@ -186,8 +173,2 @@ createEditorContext: CreateEditorContext;
     /**
-     * Check if the editor has focus now
-     * @param core The EditorCore object
-     * @returns True if the editor has focus, otherwise false
-     */
-    hasFocus: HasFocus;
-    /**
      * Focus to editor. If there is a cached selection range, use it as current selection
@@ -225,9 +206,2 @@ * @param core The EditorCore object
     triggerEvent: TriggerEvent;
-    /**
-     * Paste into editor using a clipboardData object
-     * @param editor The editor to paste content into
-     * @param clipboardData Clipboard data retrieved from clipboard
-     * @param pasteType Type of content to paste. @default normal
-     */
-    paste: Paste;
 }
@@ -261,10 +235,2 @@ /**
     /**
-     * Settings used by DOM to Content Model conversion
-     */
-    readonly domToModelSettings: ContentModelSettings<DomToModelOption, DomToModelSettings>;
-    /**
-     * Settings used by Content Model to DOM conversion
-     */
-    readonly modelToDomSettings: ContentModelSettings<ModelToDomOption, ModelToDomSettings>;
-    /**
      * Editor running environment
@@ -295,20 +261,1 @@ */
 }
-/**
- * Default DOM and Content Model conversion settings for an editor
- */
-export interface ContentModelSettings<OptionType, ConfigType> {
-    /**
-     * Built in options used by editor
-     */
-    builtIn: OptionType;
-    /**
-     * Customize options passed in from Editor Options, used for overwrite default option.
-     * This will also be used by copy/paste
-     */
-    customized: OptionType;
-    /**
-     * Configuration calculated from default and customized options.
-     * This is a cached object so that we don't need to cache it every time when we use Content Model
-     */
-    calculated: ConfigType;
-}

lib-amd/editor/IEditor.d.ts

 import type { DOMHelper } from '../parameter/DOMHelper';
 import type { PluginEventData, PluginEventFromType } from '../event/PluginEventData';
 import type { PluginEventType } from '../event/PluginEventType';
-import type { PasteType } from '../enum/PasteType';
-import type { ClipboardData } from '../parameter/ClipboardData';
 import type { DOMEventRecord } from '../parameter/DOMEventRecord';
@@ -33,4 +31,6 @@ import type { SnapshotsManager } from '../parameter/SnapshotsManager';
      * instead to improve performance. This is mostly used for retrieve current format state.
+     * - clean: Similar with disconnected, this will return a disconnected model, the difference is "clean" mode will not include any selection info.
+     * This is usually used for exporting content
      */
-    getContentModelCopy(mode: 'connected' | 'disconnected' | 'reduced'): ContentModelDocument;
+    getContentModelCopy(mode: 'connected' | 'disconnected' | 'reduced' | 'clean'): ContentModelDocument;
     /**
@@ -139,8 +139,2 @@ * Get current running environment, such as if editor is running on Mac
     /**
-     * Paste into editor using a clipboardData object
-     * @param clipboardData Clipboard data retrieved from clipboard
-     * @param pasteType Type of paste
-     */
-    pasteFromClipboard(clipboardData: ClipboardData, pasteType?: PasteType): void;
-    /**
      * Get a darkColorHandler object for this editor.
@@ -147,0 +141,0 @@ */

lib-amd/index.d.ts

@@ -118,3 +118,3 @@ export { ContentModelSegmentFormat } from './format/ContentModelSegmentFormat';
 export { EditorOptions } from './editor/EditorOptions';
-export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, FormatContentModel, CoreApiMap, EditorCore, ContentModelSettings, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, HasFocus, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, Paste, } from './editor/EditorCore';
+export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, FormatContentModel, CoreApiMap, EditorCore, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, } from './editor/EditorCore';
 export { EditorCorePlugins } from './editor/EditorCorePlugins';
@@ -134,3 +134,3 @@ export { EditorPlugin } from './editor/EditorPlugin';
 export { ContextMenuPluginState } from './pluginState/ContextMenuPluginState';
-export { EditorEnvironment } from './parameter/EditorEnvironment';
+export { EditorEnvironment, ContentModelSettings } from './parameter/EditorEnvironment';
 export { EntityState, DeletedEntity, FormatContentModelContext, } from './parameter/FormatContentModelContext';
@@ -153,2 +153,5 @@ export { FormatContentModelOptions, ContentModelFormatter, } from './parameter/FormatContentModelOptions';
 export { DOMHelper } from './parameter/DOMHelper';
+export { ImageEditOperation, ImageEditor } from './parameter/ImageEditor';
+export { CachedElementHandler, CloneModelOptions } from './parameter/CloneModelOptions';
+export { LinkData } from './parameter/LinkData';
 export { BasePluginEvent, BasePluginDomEvent } from './event/BasePluginEvent';
@@ -155,0 +158,0 @@ export { BeforeCutCopyEvent } from './event/BeforeCutCopyEvent';

lib-amd/parameter/DOMHelper.d.ts

@@ -48,2 +48,15 @@ /**
     getDomStyle<T extends keyof CSSStyleDeclaration>(style: T): CSSStyleDeclaration[T];
+    /**
+     * Find closest element ancestor start from the given node which matches the given selector
+     * @param node Find ancestor start from this node
+     * @param selector The expected selector. If null, return the first HTML Element found from start node
+     * @returns An HTML element which matches the given selector. If the given start node matches the selector,
+     * returns the given node
+     */
+    findClosestElementAncestor(node: Node, selector?: string): HTMLElement | null;
+    /**
+     * Check if the editor has focus now
+     * @returns True if the editor has focus, otherwise false
+     */
+    hasFocus(): boolean;
 }

lib-amd/parameter/EditorEnvironment.d.ts

@@ -0,2 +1,25 @@
+import type { DomToModelOption } from '../context/DomToModelOption';
+import type { DomToModelSettings } from '../context/DomToModelSettings';
+import type { ModelToDomOption } from '../context/ModelToDomOption';
+import type { ModelToDomSettings } from '../context/ModelToDomSettings';
 /**
+ * Default DOM and Content Model conversion settings for an editor
+ */
+export interface ContentModelSettings<OptionType, ConfigType> {
+    /**
+     * Built in options used by editor
+     */
+    builtIn: OptionType;
+    /**
+     * Customize options passed in from Editor Options, used for overwrite default option.
+     * This will also be used by copy/paste
+     */
+    customized: OptionType;
+    /**
+     * Configuration calculated from default and customized options.
+     * This is a cached object so that we don't need to cache it every time when we use Content Model
+     */
+    calculated: ConfigType;
+}
+/**
  * Current running environment
@@ -8,15 +31,23 @@ */
      */
-    isMac?: boolean;
+    readonly isMac?: boolean;
     /**
      * Whether editor is running on Android
      */
-    isAndroid?: boolean;
+    readonly isAndroid?: boolean;
     /**
      * Whether editor is running on Safari browser
      */
-    isSafari?: boolean;
+    readonly isSafari?: boolean;
     /**
      * Whether current browser is on mobile or a tablet
      */
-    isMobileOrTablet?: boolean;
+    readonly isMobileOrTablet?: boolean;
+    /**
+     * Settings used by DOM to Content Model conversion
+     */
+    readonly domToModelSettings: ContentModelSettings<DomToModelOption, DomToModelSettings>;
+    /**
+     * Settings used by Content Model to DOM conversion
+     */
+    readonly modelToDomSettings: ContentModelSettings<ModelToDomOption, ModelToDomSettings>;
 }

lib-mjs/editor/EditorCore.d.ts

@@ -5,4 +5,2 @@ import type { DOMHelper } from '../parameter/DOMHelper';
 import type { EditorPlugin } from './EditorPlugin';
-import type { ClipboardData } from '../parameter/ClipboardData';
-import type { PasteType } from '../enum/PasteType';
 import type { DOMEventRecord } from '../parameter/DOMEventRecord';
@@ -15,7 +13,6 @@ import type { Snapshot } from '../parameter/Snapshot';
 import type { DomToModelOption } from '../context/DomToModelOption';
-import type { DomToModelSettings } from '../context/DomToModelSettings';
 import type { EditorContext } from '../context/EditorContext';
 import type { EditorEnvironment } from '../parameter/EditorEnvironment';
 import type { ModelToDomOption } from '../context/ModelToDomOption';
-import type { ModelToDomSettings, OnNodeCreated } from '../context/ModelToDomSettings';
+import type { OnNodeCreated } from '../context/ModelToDomSettings';
 import type { TrustedHTMLHandler } from '../parameter/TrustedHTMLHandler';
@@ -34,5 +31,6 @@ import type { Rect } from '../parameter/Rect';
  * @param option The option to customize the behavior of DOM to Content Model conversion
- * @param selectionOverride When passed, use this selection range instead of current selection in editor
+ * @param selectionOverride When passed a valid selection, use this selection range instead of current selection in editor.
+ * When pass "none", it means we don't need a selection in content model
  */
-export declare type CreateContentModel = (core: EditorCore, option?: DomToModelOption, selectionOverride?: DOMSelection) => ContentModelDocument;
+export declare type CreateContentModel = (core: EditorCore, option?: DomToModelOption, selectionOverride?: DOMSelection | 'none') => ContentModelDocument;
 /**
@@ -96,8 +94,2 @@ * Get current DOM selection from editor
 /**
- * Check if the editor has focus now
- * @param core The EditorCore object
- * @returns True if the editor has focus, otherwise false
- */
-export declare type HasFocus = (core: EditorCore) => boolean;
-/**
  * Focus to editor. If there is a cached selection range, use it as current selection
@@ -120,9 +112,2 @@ * @param core The EditorCore object
 /**
- * Paste into editor using a clipboardData object
- * @param core The EditorCore object.
- * @param clipboardData Clipboard data retrieved from clipboard
- * @param pasteType Type of content to paste. @default normal
- */
-export declare type Paste = (core: EditorCore, clipboardData: ClipboardData, pasteType: PasteType) => void;
-/**
  * The interface for the map of core API for Editor.
@@ -133,5 +118,7 @@ * Editor can call call API from this map under EditorCore object
     /**
-     * Create a EditorContext object used by ContentModel API
+     * Create Content Model from DOM tree in this editor
      * @param core The EditorCore object
-     * @param saveIndex True to allow saving index info into node using domIndexer, otherwise false
+     * @param option The option to customize the behavior of DOM to Content Model conversion
+     * @param selectionOverride When passed a valid selection, use this selection range instead of current selection in editor.
+     * When pass "none", it means we don't need a selection in content model
      */
@@ -186,8 +173,2 @@ createEditorContext: CreateEditorContext;
     /**
-     * Check if the editor has focus now
-     * @param core The EditorCore object
-     * @returns True if the editor has focus, otherwise false
-     */
-    hasFocus: HasFocus;
-    /**
      * Focus to editor. If there is a cached selection range, use it as current selection
@@ -225,9 +206,2 @@ * @param core The EditorCore object
     triggerEvent: TriggerEvent;
-    /**
-     * Paste into editor using a clipboardData object
-     * @param editor The editor to paste content into
-     * @param clipboardData Clipboard data retrieved from clipboard
-     * @param pasteType Type of content to paste. @default normal
-     */
-    paste: Paste;
 }
@@ -261,10 +235,2 @@ /**
     /**
-     * Settings used by DOM to Content Model conversion
-     */
-    readonly domToModelSettings: ContentModelSettings<DomToModelOption, DomToModelSettings>;
-    /**
-     * Settings used by Content Model to DOM conversion
-     */
-    readonly modelToDomSettings: ContentModelSettings<ModelToDomOption, ModelToDomSettings>;
-    /**
      * Editor running environment
@@ -295,20 +261,1 @@ */
 }
-/**
- * Default DOM and Content Model conversion settings for an editor
- */
-export interface ContentModelSettings<OptionType, ConfigType> {
-    /**
-     * Built in options used by editor
-     */
-    builtIn: OptionType;
-    /**
-     * Customize options passed in from Editor Options, used for overwrite default option.
-     * This will also be used by copy/paste
-     */
-    customized: OptionType;
-    /**
-     * Configuration calculated from default and customized options.
-     * This is a cached object so that we don't need to cache it every time when we use Content Model
-     */
-    calculated: ConfigType;
-}

lib-mjs/editor/IEditor.d.ts

 import type { DOMHelper } from '../parameter/DOMHelper';
 import type { PluginEventData, PluginEventFromType } from '../event/PluginEventData';
 import type { PluginEventType } from '../event/PluginEventType';
-import type { PasteType } from '../enum/PasteType';
-import type { ClipboardData } from '../parameter/ClipboardData';
 import type { DOMEventRecord } from '../parameter/DOMEventRecord';
@@ -33,4 +31,6 @@ import type { SnapshotsManager } from '../parameter/SnapshotsManager';
      * instead to improve performance. This is mostly used for retrieve current format state.
+     * - clean: Similar with disconnected, this will return a disconnected model, the difference is "clean" mode will not include any selection info.
+     * This is usually used for exporting content
      */
-    getContentModelCopy(mode: 'connected' | 'disconnected' | 'reduced'): ContentModelDocument;
+    getContentModelCopy(mode: 'connected' | 'disconnected' | 'reduced' | 'clean'): ContentModelDocument;
     /**
@@ -139,8 +139,2 @@ * Get current running environment, such as if editor is running on Mac
     /**
-     * Paste into editor using a clipboardData object
-     * @param clipboardData Clipboard data retrieved from clipboard
-     * @param pasteType Type of paste
-     */
-    pasteFromClipboard(clipboardData: ClipboardData, pasteType?: PasteType): void;
-    /**
      * Get a darkColorHandler object for this editor.
@@ -147,0 +141,0 @@ */

lib-mjs/index.d.ts

@@ -118,3 +118,3 @@ export { ContentModelSegmentFormat } from './format/ContentModelSegmentFormat';
 export { EditorOptions } from './editor/EditorOptions';
-export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, FormatContentModel, CoreApiMap, EditorCore, ContentModelSettings, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, HasFocus, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, Paste, } from './editor/EditorCore';
+export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, FormatContentModel, CoreApiMap, EditorCore, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, } from './editor/EditorCore';
 export { EditorCorePlugins } from './editor/EditorCorePlugins';
@@ -134,3 +134,3 @@ export { EditorPlugin } from './editor/EditorPlugin';
 export { ContextMenuPluginState } from './pluginState/ContextMenuPluginState';
-export { EditorEnvironment } from './parameter/EditorEnvironment';
+export { EditorEnvironment, ContentModelSettings } from './parameter/EditorEnvironment';
 export { EntityState, DeletedEntity, FormatContentModelContext, } from './parameter/FormatContentModelContext';
@@ -153,2 +153,5 @@ export { FormatContentModelOptions, ContentModelFormatter, } from './parameter/FormatContentModelOptions';
 export { DOMHelper } from './parameter/DOMHelper';
+export { ImageEditOperation, ImageEditor } from './parameter/ImageEditor';
+export { CachedElementHandler, CloneModelOptions } from './parameter/CloneModelOptions';
+export { LinkData } from './parameter/LinkData';
 export { BasePluginEvent, BasePluginDomEvent } from './event/BasePluginEvent';
@@ -155,0 +158,0 @@ export { BeforeCutCopyEvent } from './event/BeforeCutCopyEvent';

lib-mjs/parameter/DOMHelper.d.ts

@@ -48,2 +48,15 @@ /**
     getDomStyle<T extends keyof CSSStyleDeclaration>(style: T): CSSStyleDeclaration[T];
+    /**
+     * Find closest element ancestor start from the given node which matches the given selector
+     * @param node Find ancestor start from this node
+     * @param selector The expected selector. If null, return the first HTML Element found from start node
+     * @returns An HTML element which matches the given selector. If the given start node matches the selector,
+     * returns the given node
+     */
+    findClosestElementAncestor(node: Node, selector?: string): HTMLElement | null;
+    /**
+     * Check if the editor has focus now
+     * @returns True if the editor has focus, otherwise false
+     */
+    hasFocus(): boolean;
 }

lib-mjs/parameter/EditorEnvironment.d.ts

@@ -0,2 +1,25 @@
+import type { DomToModelOption } from '../context/DomToModelOption';
+import type { DomToModelSettings } from '../context/DomToModelSettings';
+import type { ModelToDomOption } from '../context/ModelToDomOption';
+import type { ModelToDomSettings } from '../context/ModelToDomSettings';
 /**
+ * Default DOM and Content Model conversion settings for an editor
+ */
+export interface ContentModelSettings<OptionType, ConfigType> {
+    /**
+     * Built in options used by editor
+     */
+    builtIn: OptionType;
+    /**
+     * Customize options passed in from Editor Options, used for overwrite default option.
+     * This will also be used by copy/paste
+     */
+    customized: OptionType;
+    /**
+     * Configuration calculated from default and customized options.
+     * This is a cached object so that we don't need to cache it every time when we use Content Model
+     */
+    calculated: ConfigType;
+}
+/**
  * Current running environment
@@ -8,15 +31,23 @@ */
      */
-    isMac?: boolean;
+    readonly isMac?: boolean;
     /**
      * Whether editor is running on Android
      */
-    isAndroid?: boolean;
+    readonly isAndroid?: boolean;
     /**
      * Whether editor is running on Safari browser
      */
-    isSafari?: boolean;
+    readonly isSafari?: boolean;
     /**
      * Whether current browser is on mobile or a tablet
      */
-    isMobileOrTablet?: boolean;
+    readonly isMobileOrTablet?: boolean;
+    /**
+     * Settings used by DOM to Content Model conversion
+     */
+    readonly domToModelSettings: ContentModelSettings<DomToModelOption, DomToModelSettings>;
+    /**
+     * Settings used by Content Model to DOM conversion
+     */
+    readonly modelToDomSettings: ContentModelSettings<ModelToDomOption, ModelToDomSettings>;
 }

lib/editor/EditorCore.d.ts

@@ -5,4 +5,2 @@ import type { DOMHelper } from '../parameter/DOMHelper';
 import type { EditorPlugin } from './EditorPlugin';
-import type { ClipboardData } from '../parameter/ClipboardData';
-import type { PasteType } from '../enum/PasteType';
 import type { DOMEventRecord } from '../parameter/DOMEventRecord';
@@ -15,7 +13,6 @@ import type { Snapshot } from '../parameter/Snapshot';
 import type { DomToModelOption } from '../context/DomToModelOption';
-import type { DomToModelSettings } from '../context/DomToModelSettings';
 import type { EditorContext } from '../context/EditorContext';
 import type { EditorEnvironment } from '../parameter/EditorEnvironment';
 import type { ModelToDomOption } from '../context/ModelToDomOption';
-import type { ModelToDomSettings, OnNodeCreated } from '../context/ModelToDomSettings';
+import type { OnNodeCreated } from '../context/ModelToDomSettings';
 import type { TrustedHTMLHandler } from '../parameter/TrustedHTMLHandler';
@@ -34,5 +31,6 @@ import type { Rect } from '../parameter/Rect';
  * @param option The option to customize the behavior of DOM to Content Model conversion
- * @param selectionOverride When passed, use this selection range instead of current selection in editor
+ * @param selectionOverride When passed a valid selection, use this selection range instead of current selection in editor.
+ * When pass "none", it means we don't need a selection in content model
  */
-export declare type CreateContentModel = (core: EditorCore, option?: DomToModelOption, selectionOverride?: DOMSelection) => ContentModelDocument;
+export declare type CreateContentModel = (core: EditorCore, option?: DomToModelOption, selectionOverride?: DOMSelection | 'none') => ContentModelDocument;
 /**
@@ -96,8 +94,2 @@ * Get current DOM selection from editor
 /**
- * Check if the editor has focus now
- * @param core The EditorCore object
- * @returns True if the editor has focus, otherwise false
- */
-export declare type HasFocus = (core: EditorCore) => boolean;
-/**
  * Focus to editor. If there is a cached selection range, use it as current selection
@@ -120,9 +112,2 @@ * @param core The EditorCore object
 /**
- * Paste into editor using a clipboardData object
- * @param core The EditorCore object.
- * @param clipboardData Clipboard data retrieved from clipboard
- * @param pasteType Type of content to paste. @default normal
- */
-export declare type Paste = (core: EditorCore, clipboardData: ClipboardData, pasteType: PasteType) => void;
-/**
  * The interface for the map of core API for Editor.
@@ -133,5 +118,7 @@ * Editor can call call API from this map under EditorCore object
     /**
-     * Create a EditorContext object used by ContentModel API
+     * Create Content Model from DOM tree in this editor
      * @param core The EditorCore object
-     * @param saveIndex True to allow saving index info into node using domIndexer, otherwise false
+     * @param option The option to customize the behavior of DOM to Content Model conversion
+     * @param selectionOverride When passed a valid selection, use this selection range instead of current selection in editor.
+     * When pass "none", it means we don't need a selection in content model
      */
@@ -186,8 +173,2 @@ createEditorContext: CreateEditorContext;
     /**
-     * Check if the editor has focus now
-     * @param core The EditorCore object
-     * @returns True if the editor has focus, otherwise false
-     */
-    hasFocus: HasFocus;
-    /**
      * Focus to editor. If there is a cached selection range, use it as current selection
@@ -225,9 +206,2 @@ * @param core The EditorCore object
     triggerEvent: TriggerEvent;
-    /**
-     * Paste into editor using a clipboardData object
-     * @param editor The editor to paste content into
-     * @param clipboardData Clipboard data retrieved from clipboard
-     * @param pasteType Type of content to paste. @default normal
-     */
-    paste: Paste;
 }
@@ -261,10 +235,2 @@ /**
     /**
-     * Settings used by DOM to Content Model conversion
-     */
-    readonly domToModelSettings: ContentModelSettings<DomToModelOption, DomToModelSettings>;
-    /**
-     * Settings used by Content Model to DOM conversion
-     */
-    readonly modelToDomSettings: ContentModelSettings<ModelToDomOption, ModelToDomSettings>;
-    /**
      * Editor running environment
@@ -295,20 +261,1 @@ */
 }
-/**
- * Default DOM and Content Model conversion settings for an editor
- */
-export interface ContentModelSettings<OptionType, ConfigType> {
-    /**
-     * Built in options used by editor
-     */
-    builtIn: OptionType;
-    /**
-     * Customize options passed in from Editor Options, used for overwrite default option.
-     * This will also be used by copy/paste
-     */
-    customized: OptionType;
-    /**
-     * Configuration calculated from default and customized options.
-     * This is a cached object so that we don't need to cache it every time when we use Content Model
-     */
-    calculated: ConfigType;
-}

lib/editor/IEditor.d.ts

 import type { DOMHelper } from '../parameter/DOMHelper';
 import type { PluginEventData, PluginEventFromType } from '../event/PluginEventData';
 import type { PluginEventType } from '../event/PluginEventType';
-import type { PasteType } from '../enum/PasteType';
-import type { ClipboardData } from '../parameter/ClipboardData';
 import type { DOMEventRecord } from '../parameter/DOMEventRecord';
@@ -33,4 +31,6 @@ import type { SnapshotsManager } from '../parameter/SnapshotsManager';
      * instead to improve performance. This is mostly used for retrieve current format state.
+     * - clean: Similar with disconnected, this will return a disconnected model, the difference is "clean" mode will not include any selection info.
+     * This is usually used for exporting content
      */
-    getContentModelCopy(mode: 'connected' | 'disconnected' | 'reduced'): ContentModelDocument;
+    getContentModelCopy(mode: 'connected' | 'disconnected' | 'reduced' | 'clean'): ContentModelDocument;
     /**
@@ -139,8 +139,2 @@ * Get current running environment, such as if editor is running on Mac
     /**
-     * Paste into editor using a clipboardData object
-     * @param clipboardData Clipboard data retrieved from clipboard
-     * @param pasteType Type of paste
-     */
-    pasteFromClipboard(clipboardData: ClipboardData, pasteType?: PasteType): void;
-    /**
      * Get a darkColorHandler object for this editor.
@@ -147,0 +141,0 @@ */

lib/index.d.ts

@@ -118,3 +118,3 @@ export { ContentModelSegmentFormat } from './format/ContentModelSegmentFormat';
 export { EditorOptions } from './editor/EditorOptions';
-export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, FormatContentModel, CoreApiMap, EditorCore, ContentModelSettings, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, HasFocus, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, Paste, } from './editor/EditorCore';
+export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, FormatContentModel, CoreApiMap, EditorCore, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, } from './editor/EditorCore';
 export { EditorCorePlugins } from './editor/EditorCorePlugins';
@@ -134,3 +134,3 @@ export { EditorPlugin } from './editor/EditorPlugin';
 export { ContextMenuPluginState } from './pluginState/ContextMenuPluginState';
-export { EditorEnvironment } from './parameter/EditorEnvironment';
+export { EditorEnvironment, ContentModelSettings } from './parameter/EditorEnvironment';
 export { EntityState, DeletedEntity, FormatContentModelContext, } from './parameter/FormatContentModelContext';
@@ -153,2 +153,5 @@ export { FormatContentModelOptions, ContentModelFormatter, } from './parameter/FormatContentModelOptions';
 export { DOMHelper } from './parameter/DOMHelper';
+export { ImageEditOperation, ImageEditor } from './parameter/ImageEditor';
+export { CachedElementHandler, CloneModelOptions } from './parameter/CloneModelOptions';
+export { LinkData } from './parameter/LinkData';
 export { BasePluginEvent, BasePluginDomEvent } from './event/BasePluginEvent';
@@ -155,0 +158,0 @@ export { BeforeCutCopyEvent } from './event/BeforeCutCopyEvent';

lib/parameter/DOMHelper.d.ts

@@ -48,2 +48,15 @@ /**
     getDomStyle<T extends keyof CSSStyleDeclaration>(style: T): CSSStyleDeclaration[T];
+    /**
+     * Find closest element ancestor start from the given node which matches the given selector
+     * @param node Find ancestor start from this node
+     * @param selector The expected selector. If null, return the first HTML Element found from start node
+     * @returns An HTML element which matches the given selector. If the given start node matches the selector,
+     * returns the given node
+     */
+    findClosestElementAncestor(node: Node, selector?: string): HTMLElement | null;
+    /**
+     * Check if the editor has focus now
+     * @returns True if the editor has focus, otherwise false
+     */
+    hasFocus(): boolean;
 }

lib/parameter/EditorEnvironment.d.ts

@@ -0,2 +1,25 @@
+import type { DomToModelOption } from '../context/DomToModelOption';
+import type { DomToModelSettings } from '../context/DomToModelSettings';
+import type { ModelToDomOption } from '../context/ModelToDomOption';
+import type { ModelToDomSettings } from '../context/ModelToDomSettings';
 /**
+ * Default DOM and Content Model conversion settings for an editor
+ */
+export interface ContentModelSettings<OptionType, ConfigType> {
+    /**
+     * Built in options used by editor
+     */
+    builtIn: OptionType;
+    /**
+     * Customize options passed in from Editor Options, used for overwrite default option.
+     * This will also be used by copy/paste
+     */
+    customized: OptionType;
+    /**
+     * Configuration calculated from default and customized options.
+     * This is a cached object so that we don't need to cache it every time when we use Content Model
+     */
+    calculated: ConfigType;
+}
+/**
  * Current running environment
@@ -8,15 +31,23 @@ */
      */
-    isMac?: boolean;
+    readonly isMac?: boolean;
     /**
      * Whether editor is running on Android
      */
-    isAndroid?: boolean;
+    readonly isAndroid?: boolean;
     /**
      * Whether editor is running on Safari browser
      */
-    isSafari?: boolean;
+    readonly isSafari?: boolean;
     /**
      * Whether current browser is on mobile or a tablet
      */
-    isMobileOrTablet?: boolean;
+    readonly isMobileOrTablet?: boolean;
+    /**
+     * Settings used by DOM to Content Model conversion
+     */
+    readonly domToModelSettings: ContentModelSettings<DomToModelOption, DomToModelSettings>;
+    /**
+     * Settings used by Content Model to DOM conversion
+     */
+    readonly modelToDomSettings: ContentModelSettings<ModelToDomOption, ModelToDomSettings>;
 }

package.json

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

New alerts

SPDX disjunction

License

SPDX disjunction for an artifact's license information

Found 1 instance in 1 package

Fixed alerts

SPDX disjunction

License

SPDX disjunction for an artifact's license information

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1349474

increased by1.03%

Number of package files

1587

increased by1.73%

Lines of code

17093

increased by1.46%

No dependency changes