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

Comparing version 0.26.4 to 0.27.0

lib-amd/editor/EditorPlugin.d.ts

 import type { PluginEvent } from '../event/PluginEvent';
-import type { IStandaloneEditor } from './IStandaloneEditor';
+import type { IEditor } from './IEditor';
 /**
@@ -17,3 +17,3 @@ * Interface of an editor plugin
      */
-    initialize: (editor: IStandaloneEditor) => void;
+    initialize: (editor: IEditor) => void;
     /**
@@ -20,0 +20,0 @@ * The last method that editor will call to a plugin before it is disposed.

lib-amd/format/ContentModelListItemFormat.d.ts

@@ -0,1 +1,2 @@
+import type { BackgroundColorFormat } from './formatParts/BackgroundColorFormat';
 import type { DirectionFormat } from './formatParts/DirectionFormat';
@@ -11,2 +12,2 @@ import type { LineHeightFormat } from './formatParts/LineHeightFormat';
  */
-export declare type ContentModelListItemFormat = DirectionFormat & LineHeightFormat & MarginFormat & PaddingFormat & TextAlignFormat & ListStyleFormat & TextIndentFormat;
+export declare type ContentModelListItemFormat = DirectionFormat & LineHeightFormat & MarginFormat & PaddingFormat & TextAlignFormat & ListStyleFormat & TextIndentFormat & BackgroundColorFormat;

lib-amd/index.d.ts

@@ -116,6 +116,6 @@ export { ContentModelSegmentFormat } from './format/ContentModelSegmentFormat';
 export { DarkColorHandler, Colors, ColorTransformFunction } from './context/DarkColorHandler';
-export { IStandaloneEditor } from './editor/IStandaloneEditor';
-export { StandaloneEditorOptions } from './editor/StandaloneEditorOptions';
-export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, FormatContentModel, StandaloneCoreApiMap, StandaloneEditorCore, ContentModelSettings, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, HasFocus, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, Paste, } from './editor/StandaloneEditorCore';
-export { StandaloneEditorCorePlugins } from './editor/StandaloneEditorCorePlugins';
+export { IEditor } from './editor/IEditor';
+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 { EditorCorePlugins } from './editor/EditorCorePlugins';
 export { EditorPlugin } from './editor/EditorPlugin';
@@ -122,0 +122,0 @@ export { PluginWithState } from './editor/PluginWithState';

lib-amd/parameter/InsertEntityOptions.d.ts

@@ -21,2 +21,6 @@ /**
     skipUndoSnapshot?: boolean;
+    /**
+     * Initial entity state, this is used when restore an undo snapshot to right after entity is inserted, this state will be used for set initial state of entity
+     */
+    initialEntityState?: string;
 }

lib-amd/pluginState/CopyPastePluginState.d.ts

@@ -0,1 +1,2 @@
+import type { PasteType } from '../enum/PasteType';
 /**
@@ -14,2 +15,6 @@ * The state object for CopyPastePlugin
     tempDiv: HTMLDivElement | null;
+    /**
+     * Default paste type. By default will use the normal (as-is) paste type.
+     */
+    defaultPasteType?: PasteType;
 }

lib-amd/pluginState/PluginState.d.ts

 import type { PluginWithState } from '../editor/PluginWithState';
-import type { StandaloneEditorCorePlugins } from '../editor/StandaloneEditorCorePlugins';
+import type { EditorCorePlugins } from '../editor/EditorCorePlugins';
 /**
  * Names of core plugins
  */
-export declare type PluginKey = keyof StandaloneEditorCorePlugins;
+export declare type PluginKey = keyof EditorCorePlugins;
 /**
  * Names of the core plugins that have plugin state
  */
-export declare type KeyOfStatePlugin<Key extends PluginKey> = StandaloneEditorCorePlugins[Key] extends PluginWithState<infer U> ? Key : never;
+export declare type KeyOfStatePlugin<Key extends PluginKey> = EditorCorePlugins[Key] extends PluginWithState<infer U> ? Key : never;
 /**
  * Get type of a plugin with state
  */
-export declare type TypeOfStatePlugin<Key extends PluginKey> = StandaloneEditorCorePlugins[Key] extends PluginWithState<infer U> ? U : never;
+export declare type TypeOfStatePlugin<Key extends PluginKey> = EditorCorePlugins[Key] extends PluginWithState<infer U> ? U : never;
 /**
@@ -16,0 +16,0 @@ * All names of plugins with plugin state

lib-mjs/editor/EditorPlugin.d.ts

 import type { PluginEvent } from '../event/PluginEvent';
-import type { IStandaloneEditor } from './IStandaloneEditor';
+import type { IEditor } from './IEditor';
 /**
@@ -17,3 +17,3 @@ * Interface of an editor plugin
      */
-    initialize: (editor: IStandaloneEditor) => void;
+    initialize: (editor: IEditor) => void;
     /**
@@ -20,0 +20,0 @@ * The last method that editor will call to a plugin before it is disposed.

lib-mjs/format/ContentModelListItemFormat.d.ts

@@ -0,1 +1,2 @@
+import type { BackgroundColorFormat } from './formatParts/BackgroundColorFormat';
 import type { DirectionFormat } from './formatParts/DirectionFormat';
@@ -11,2 +12,2 @@ import type { LineHeightFormat } from './formatParts/LineHeightFormat';
  */
-export declare type ContentModelListItemFormat = DirectionFormat & LineHeightFormat & MarginFormat & PaddingFormat & TextAlignFormat & ListStyleFormat & TextIndentFormat;
+export declare type ContentModelListItemFormat = DirectionFormat & LineHeightFormat & MarginFormat & PaddingFormat & TextAlignFormat & ListStyleFormat & TextIndentFormat & BackgroundColorFormat;

lib-mjs/index.d.ts

@@ -116,6 +116,6 @@ export { ContentModelSegmentFormat } from './format/ContentModelSegmentFormat';
 export { DarkColorHandler, Colors, ColorTransformFunction } from './context/DarkColorHandler';
-export { IStandaloneEditor } from './editor/IStandaloneEditor';
-export { StandaloneEditorOptions } from './editor/StandaloneEditorOptions';
-export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, FormatContentModel, StandaloneCoreApiMap, StandaloneEditorCore, ContentModelSettings, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, HasFocus, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, Paste, } from './editor/StandaloneEditorCore';
-export { StandaloneEditorCorePlugins } from './editor/StandaloneEditorCorePlugins';
+export { IEditor } from './editor/IEditor';
+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 { EditorCorePlugins } from './editor/EditorCorePlugins';
 export { EditorPlugin } from './editor/EditorPlugin';
@@ -122,0 +122,0 @@ export { PluginWithState } from './editor/PluginWithState';

lib-mjs/parameter/InsertEntityOptions.d.ts

@@ -21,2 +21,6 @@ /**
     skipUndoSnapshot?: boolean;
+    /**
+     * Initial entity state, this is used when restore an undo snapshot to right after entity is inserted, this state will be used for set initial state of entity
+     */
+    initialEntityState?: string;
 }

lib-mjs/pluginState/CopyPastePluginState.d.ts

@@ -0,1 +1,2 @@
+import type { PasteType } from '../enum/PasteType';
 /**
@@ -14,2 +15,6 @@ * The state object for CopyPastePlugin
     tempDiv: HTMLDivElement | null;
+    /**
+     * Default paste type. By default will use the normal (as-is) paste type.
+     */
+    defaultPasteType?: PasteType;
 }

lib-mjs/pluginState/PluginState.d.ts

 import type { PluginWithState } from '../editor/PluginWithState';
-import type { StandaloneEditorCorePlugins } from '../editor/StandaloneEditorCorePlugins';
+import type { EditorCorePlugins } from '../editor/EditorCorePlugins';
 /**
  * Names of core plugins
  */
-export declare type PluginKey = keyof StandaloneEditorCorePlugins;
+export declare type PluginKey = keyof EditorCorePlugins;
 /**
  * Names of the core plugins that have plugin state
  */
-export declare type KeyOfStatePlugin<Key extends PluginKey> = StandaloneEditorCorePlugins[Key] extends PluginWithState<infer U> ? Key : never;
+export declare type KeyOfStatePlugin<Key extends PluginKey> = EditorCorePlugins[Key] extends PluginWithState<infer U> ? Key : never;
 /**
  * Get type of a plugin with state
  */
-export declare type TypeOfStatePlugin<Key extends PluginKey> = StandaloneEditorCorePlugins[Key] extends PluginWithState<infer U> ? U : never;
+export declare type TypeOfStatePlugin<Key extends PluginKey> = EditorCorePlugins[Key] extends PluginWithState<infer U> ? U : never;
 /**
@@ -16,0 +16,0 @@ * All names of plugins with plugin state

lib/editor/EditorPlugin.d.ts

 import type { PluginEvent } from '../event/PluginEvent';
-import type { IStandaloneEditor } from './IStandaloneEditor';
+import type { IEditor } from './IEditor';
 /**
@@ -17,3 +17,3 @@ * Interface of an editor plugin
      */
-    initialize: (editor: IStandaloneEditor) => void;
+    initialize: (editor: IEditor) => void;
     /**
@@ -20,0 +20,0 @@ * The last method that editor will call to a plugin before it is disposed.

lib/format/ContentModelListItemFormat.d.ts

@@ -0,1 +1,2 @@
+import type { BackgroundColorFormat } from './formatParts/BackgroundColorFormat';
 import type { DirectionFormat } from './formatParts/DirectionFormat';
@@ -11,2 +12,2 @@ import type { LineHeightFormat } from './formatParts/LineHeightFormat';
  */
-export declare type ContentModelListItemFormat = DirectionFormat & LineHeightFormat & MarginFormat & PaddingFormat & TextAlignFormat & ListStyleFormat & TextIndentFormat;
+export declare type ContentModelListItemFormat = DirectionFormat & LineHeightFormat & MarginFormat & PaddingFormat & TextAlignFormat & ListStyleFormat & TextIndentFormat & BackgroundColorFormat;

lib/index.d.ts

@@ -116,6 +116,6 @@ export { ContentModelSegmentFormat } from './format/ContentModelSegmentFormat';
 export { DarkColorHandler, Colors, ColorTransformFunction } from './context/DarkColorHandler';
-export { IStandaloneEditor } from './editor/IStandaloneEditor';
-export { StandaloneEditorOptions } from './editor/StandaloneEditorOptions';
-export { CreateContentModel, CreateEditorContext, GetDOMSelection, SetContentModel, SetDOMSelection, FormatContentModel, StandaloneCoreApiMap, StandaloneEditorCore, ContentModelSettings, SwitchShadowEdit, TriggerEvent, AddUndoSnapshot, HasFocus, Focus, AttachDomEvent, RestoreUndoSnapshot, GetVisibleViewport, Paste, } from './editor/StandaloneEditorCore';
-export { StandaloneEditorCorePlugins } from './editor/StandaloneEditorCorePlugins';
+export { IEditor } from './editor/IEditor';
+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 { EditorCorePlugins } from './editor/EditorCorePlugins';
 export { EditorPlugin } from './editor/EditorPlugin';
@@ -122,0 +122,0 @@ export { PluginWithState } from './editor/PluginWithState';

lib/parameter/InsertEntityOptions.d.ts

@@ -21,2 +21,6 @@ /**
     skipUndoSnapshot?: boolean;
+    /**
+     * Initial entity state, this is used when restore an undo snapshot to right after entity is inserted, this state will be used for set initial state of entity
+     */
+    initialEntityState?: string;
 }

lib/pluginState/CopyPastePluginState.d.ts

@@ -0,1 +1,2 @@
+import type { PasteType } from '../enum/PasteType';
 /**
@@ -14,2 +15,6 @@ * The state object for CopyPastePlugin
     tempDiv: HTMLDivElement | null;
+    /**
+     * Default paste type. By default will use the normal (as-is) paste type.
+     */
+    defaultPasteType?: PasteType;
 }

lib/pluginState/PluginState.d.ts

 import type { PluginWithState } from '../editor/PluginWithState';
-import type { StandaloneEditorCorePlugins } from '../editor/StandaloneEditorCorePlugins';
+import type { EditorCorePlugins } from '../editor/EditorCorePlugins';
 /**
  * Names of core plugins
  */
-export declare type PluginKey = keyof StandaloneEditorCorePlugins;
+export declare type PluginKey = keyof EditorCorePlugins;
 /**
  * Names of the core plugins that have plugin state
  */
-export declare type KeyOfStatePlugin<Key extends PluginKey> = StandaloneEditorCorePlugins[Key] extends PluginWithState<infer U> ? Key : never;
+export declare type KeyOfStatePlugin<Key extends PluginKey> = EditorCorePlugins[Key] extends PluginWithState<infer U> ? Key : never;
 /**
  * Get type of a plugin with state
  */
-export declare type TypeOfStatePlugin<Key extends PluginKey> = StandaloneEditorCorePlugins[Key] extends PluginWithState<infer U> ? U : never;
+export declare type TypeOfStatePlugin<Key extends PluginKey> = EditorCorePlugins[Key] extends PluginWithState<infer U> ? U : never;
 /**
@@ -16,0 +16,0 @@ * All names of plugins with plugin state

package.json

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

No alert changes

Improved metrics

Total package byte prevSize

1335734

increased by0.11%

Lines of code

16847

increased by0.39%

No dependency changes