roosterjs-content-model-types 0.0.3

package/lib-amd/enum/EntityOperation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EntityOperation.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/enum/EntityOperation.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * Define entity lifecycle related operations\r\n */\r\nexport type EntityLifecycleOperation =\r\n    /**\r\n     * Notify plugins that there is a new plugin was added into editor.\r\n     * Plugin can handle this event to entity hydration.\r\n     * This event will be only fired once for each entity DOM node.\r\n     * After undo, or copy/paste, since new DOM nodes were added, this event will be fired\r\n     * for those entities represented by newly added nodes.\r\n     */\r\n    | 'newEntity'\r\n\r\n    /**\r\n     * Notify plugins that editor is generating HTML content for save.\r\n     * Plugin should use this event to remove any temporary content, and only leave DOM nodes that\r\n     * should be saved as HTML string.\r\n     * This event will provide a cloned DOM tree for each entity, do NOT compare the DOM nodes with cached nodes\r\n     * because it will always return false.\r\n     */\r\n    | 'replaceTemporaryContent'\r\n    /**\r\n     * Notify plugins that a new entity state need to be updated to an entity.\r\n     * This is normally happened when user undo/redo the content with an entity snapshot added by a plugin that handles entity\r\n     */\r\n    | 'updateEntityState'\r\n\r\n    /**\r\n     * Notify plugins that user is clicking target to an entity\r\n     */\r\n    | 'click';\r\n\r\n/**\r\n * Define entity removal related operations\r\n */\r\nexport type EntityRemovalOperation =\r\n    /**\r\n     * Notify plugins that user is removing an entity from its start position using DELETE key\r\n     */\r\n    | 'removeFromStart'\r\n\r\n    /**\r\n     * Notify plugins that user is remove an entity from its end position using BACKSPACE key\r\n     */\r\n    | 'removeFromEnd'\r\n\r\n    /**\r\n     * Notify plugins that an entity is being overwritten.\r\n     * This can be caused by key in, cut, paste, delete, backspace ... on a selection\r\n     * which contains some entities.\r\n     */\r\n    | 'overwrite';\r\n\r\n/**\r\n * Define possible operations to an entity\r\n */\r\nexport type EntityOperation = EntityLifecycleOperation | EntityRemovalOperation;\r\n"]}

package/lib-amd/enum/ExportContentMode.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The mode parameter type for exportContent API
+ */
+export declare type ExportContentMode = 
+/**
+ * Export to clean HTML in light color mode with dehydrated entities
+ */
+'HTML'
+/**
+ * Export to plain text
+ */
+ | 'PlainText'
+/**
+ * Export to plain text via browser's textContent property
+ */
+ | 'PlainTextFast';

package/lib-amd/enum/ExportContentMode.js

@@ -0,0 +1,5 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});
+//# sourceMappingURL=ExportContentMode.js.map

package/lib-amd/enum/ExportContentMode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExportContentMode.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/enum/ExportContentMode.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * The mode parameter type for exportContent API\r\n */\r\nexport type ExportContentMode =\r\n    /**\r\n     * Export to clean HTML in light color mode with dehydrated entities\r\n     */\r\n    | 'HTML'\r\n\r\n    /**\r\n     * Export to plain text\r\n     */\r\n    | 'PlainText'\r\n\r\n    /**\r\n     * Export to plain text via browser's textContent property\r\n     */\r\n    | 'PlainTextFast';\r\n"]}

package/lib-amd/enum/InsertEntityPosition.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Define the position of the entity to insert. It can be:
+ * "focus": insert at current focus. If insert a block entity, it will be inserted under the paragraph where focus is
+ * "begin": insert at beginning of content. When insert an inline entity, it will be wrapped with a paragraph.
+ * "end": insert at end of content. When insert an inline entity, it will be wrapped with a paragraph.
+ * "root": insert at the root level of current region
+ */
+export declare type InsertEntityPosition = 'focus' | 'begin' | 'end' | 'root';

package/lib-amd/enum/InsertEntityPosition.js

@@ -0,0 +1,5 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});
+//# sourceMappingURL=InsertEntityPosition.js.map

package/lib-amd/enum/InsertEntityPosition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InsertEntityPosition.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/enum/InsertEntityPosition.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * Define the position of the entity to insert. It can be:\r\n * \"focus\": insert at current focus. If insert a block entity, it will be inserted under the paragraph where focus is\r\n * \"begin\": insert at beginning of content. When insert an inline entity, it will be wrapped with a paragraph.\r\n * \"end\": insert at end of content. When insert an inline entity, it will be wrapped with a paragraph.\r\n * \"root\": insert at the root level of current region\r\n */\r\nexport type InsertEntityPosition = 'focus' | 'begin' | 'end' | 'root';\r\n"]}

package/lib-amd/enum/PasteType.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Specify what type of content to paste
+ */
+export declare type PasteType = 
+/**
+ * Default paste behavior
+ */
+'normal'
+/**
+ * Paste only the plain text
+ */
+ | 'asPlainText'
+/**
+ * Apply the current style to pasted content
+ */
+ | 'mergeFormat'
+/**
+ * If there is a image uri in the clipboard, paste the content as image element
+ */
+ | 'asImage';

package/lib-amd/enum/PasteType.js

@@ -0,0 +1,5 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});
+//# sourceMappingURL=PasteType.js.map

package/lib-amd/enum/PasteType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PasteType.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/enum/PasteType.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * Specify what type of content to paste\r\n */\r\nexport type PasteType =\r\n    /**\r\n     * Default paste behavior\r\n     */\r\n    | 'normal'\r\n\r\n    /**\r\n     * Paste only the plain text\r\n     */\r\n    | 'asPlainText'\r\n\r\n    /**\r\n     * Apply the current style to pasted content\r\n     */\r\n    | 'mergeFormat'\r\n\r\n    /**\r\n     * If there is a image uri in the clipboard, paste the content as image element\r\n     */\r\n    | 'asImage';\r\n"]}

package/lib-amd/enum/SegmentType.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Type of Segment in Content Model
+ */
+export declare type ContentModelSegmentType = 
+/**
+ * Represents a text node
+ */
+'Text'
+/**
+ * Represents a BR element
+ */
+ | 'Br'
+/**
+ * Represents an IMG element
+ */
+ | 'Image'
+/**
+ * Represents a selection marker. A selection marker is an empty segment that mark the start/end of selection
+ */
+ | 'SelectionMarker'
+/**
+ * Represents a general segment that doesn't have a special type
+ */
+ | 'General'
+/**
+ * Represents an inline entity
+ */
+ | 'Entity';

package/lib-amd/enum/SegmentType.js

@@ -0,0 +1,5 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});
+//# sourceMappingURL=SegmentType.js.map

package/lib-amd/enum/SegmentType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SegmentType.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/enum/SegmentType.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * Type of Segment in Content Model\r\n */\r\nexport type ContentModelSegmentType =\r\n    /**\r\n     * Represents a text node\r\n     */\r\n    | 'Text'\r\n\r\n    /**\r\n     * Represents a BR element\r\n     */\r\n    | 'Br'\r\n\r\n    /**\r\n     * Represents an IMG element\r\n     */\r\n    | 'Image'\r\n\r\n    /**\r\n     * Represents a selection marker. A selection marker is an empty segment that mark the start/end of selection\r\n     */\r\n    | 'SelectionMarker'\r\n\r\n    /**\r\n     * Represents a general segment that doesn't have a special type\r\n     */\r\n    | 'General'\r\n\r\n    /**\r\n     * Represents an inline entity\r\n     */\r\n    | 'Entity';\r\n"]}

package/lib-amd/enum/TableOperation.d.ts

@@ -0,0 +1,136 @@
+/**
+ * Operations used by editTable() API for insert table cell vertically
+ */
+export declare type TableVerticalInsertOperation = 
+/**
+ * Insert a row above current row
+ */
+'insertAbove'
+/**
+ * Insert a row below current row
+ */
+ | 'insertBelow';
+/**
+ * Operations used by editTable() API for insert table cell horizontally
+ */
+export declare type TableHorizontalInsertOperation = 
+/**
+ * Insert a column on the left of current column
+ */
+'insertLeft'
+/**
+ * Insert a column on the right of current column
+ */
+ | 'insertRight';
+/**
+ * Operations used by editTable() API for delete table cells
+ */
+export declare type TableDeleteOperation = 
+/**
+ * Delete the whole table
+ */
+'deleteTable'
+/**
+ * Delete current column
+ */
+ | 'deleteColumn'
+/**
+ * Delete current row
+ */
+ | 'deleteRow';
+/**
+ * Operations used by editTable() API for merge table cells vertically
+ */
+export declare type TableVerticalMergeOperation = 
+/**
+ * Merge current row with the row above
+ */
+'mergeAbove'
+/**
+ * Merge current row with the row below
+ */
+ | 'mergeBelow';
+/**
+ * Operations used by editTable() API for merge table cells horizontally
+ */
+export declare type TableHorizontalMergeOperation = 
+/**
+ * Merge current column with the column on the left
+ */
+'mergeLeft'
+/**
+ * Merge current column with the column on the right
+ */
+ | 'mergeRight';
+/**
+ * Operations used by editTable() API for merge selected table cells
+ */
+export declare type TableCellMergeOperation = 
+/**
+ * Merge all selected cells
+ */
+'mergeCells';
+/**
+ * Operations used by editTable() API for split table cells
+ */
+export declare type TableSplitOperation = 
+/**
+ * Split current table cell horizontally
+ */
+'splitHorizontally'
+/**
+ * Split current table cell vertically
+ */
+ | 'splitVertically';
+/**
+ * Operations used by editTable() API for align table
+ */
+export declare type TableAlignOperation = 
+/**
+ * Align current table at the center
+ */
+'alignCenter'
+/**
+ * Align current table at the left
+ */
+ | 'alignLeft'
+/**
+ * Align current table at the right
+ */
+ | 'alignRight';
+/**
+ * Operations used by editTable() API for align table cell horizontally
+ */
+export declare type TableCellHorizontalAlignOperation = 
+/**
+ * Align current content table cell at the left
+ */
+'alignCellLeft'
+/**
+ * Align current content table cell at the center
+ */
+ | 'alignCellCenter'
+/**
+ * Align current content table cell at the right
+ */
+ | 'alignCellRight';
+/**
+ * Operations used by editTable() API for align table cell vertically
+ */
+export declare type TableCellVerticalAlignOperation = 
+/**
+ * Align current content table cell at the top
+ */
+'alignCellTop'
+/**
+ * Align current table cell at the middle
+ */
+ | 'alignCellMiddle'
+/**
+ * Align current table cell at the bottom
+ */
+ | 'alignCellBottom';
+/**
+ * Operations used by editTable() API
+ */
+export declare type TableOperation = TableVerticalInsertOperation | TableHorizontalInsertOperation | TableDeleteOperation | TableVerticalMergeOperation | TableHorizontalMergeOperation | TableCellMergeOperation | TableSplitOperation | TableAlignOperation | TableCellHorizontalAlignOperation | TableCellVerticalAlignOperation;

package/lib-amd/enum/TableOperation.js

@@ -0,0 +1,5 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});
+//# sourceMappingURL=TableOperation.js.map

package/lib-amd/enum/TableOperation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TableOperation.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/enum/TableOperation.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * Operations used by editTable() API for insert table cell vertically\r\n */\r\nexport type TableVerticalInsertOperation =\r\n    /**\r\n     * Insert a row above current row\r\n     */\r\n    | 'insertAbove'\r\n\r\n    /**\r\n     * Insert a row below current row\r\n     */\r\n    | 'insertBelow';\r\n\r\n/**\r\n * Operations used by editTable() API for insert table cell horizontally\r\n */\r\nexport type TableHorizontalInsertOperation =\r\n    /**\r\n     * Insert a column on the left of current column\r\n     */\r\n    | 'insertLeft'\r\n\r\n    /**\r\n     * Insert a column on the right of current column\r\n     */\r\n    | 'insertRight';\r\n\r\n/**\r\n * Operations used by editTable() API for delete table cells\r\n */\r\nexport type TableDeleteOperation =\r\n    /**\r\n     * Delete the whole table\r\n     */\r\n    | 'deleteTable'\r\n\r\n    /**\r\n     * Delete current column\r\n     */\r\n    | 'deleteColumn'\r\n\r\n    /**\r\n     * Delete current row\r\n     */\r\n    | 'deleteRow';\r\n\r\n/**\r\n * Operations used by editTable() API for merge table cells vertically\r\n */\r\nexport type TableVerticalMergeOperation =\r\n    /**\r\n     * Merge current row with the row above\r\n     */\r\n    | 'mergeAbove'\r\n\r\n    /**\r\n     * Merge current row with the row below\r\n     */\r\n    | 'mergeBelow';\r\n\r\n/**\r\n * Operations used by editTable() API for merge table cells horizontally\r\n */\r\nexport type TableHorizontalMergeOperation =\r\n    /**\r\n     * Merge current column with the column on the left\r\n     */\r\n    | 'mergeLeft'\r\n\r\n    /**\r\n     * Merge current column with the column on the right\r\n     */\r\n    | 'mergeRight';\r\n\r\n/**\r\n * Operations used by editTable() API for merge selected table cells\r\n */\r\nexport type TableCellMergeOperation =\r\n    /**\r\n     * Merge all selected cells\r\n     */\r\n    'mergeCells';\r\n\r\n/**\r\n * Operations used by editTable() API for split table cells\r\n */\r\nexport type TableSplitOperation =\r\n    /**\r\n     * Split current table cell horizontally\r\n     */\r\n    | 'splitHorizontally'\r\n\r\n    /**\r\n     * Split current table cell vertically\r\n     */\r\n    | 'splitVertically';\r\n\r\n/**\r\n * Operations used by editTable() API for align table\r\n */\r\nexport type TableAlignOperation =\r\n    /**\r\n     * Align current table at the center\r\n     */\r\n    | 'alignCenter'\r\n\r\n    /**\r\n     * Align current table at the left\r\n     */\r\n    | 'alignLeft'\r\n\r\n    /**\r\n     * Align current table at the right\r\n     */\r\n    | 'alignRight';\r\n\r\n/**\r\n * Operations used by editTable() API for align table cell horizontally\r\n */\r\nexport type TableCellHorizontalAlignOperation =\r\n    /**\r\n     * Align current content table cell at the left\r\n     */\r\n    | 'alignCellLeft'\r\n\r\n    /**\r\n     * Align current content table cell at the center\r\n     */\r\n    | 'alignCellCenter'\r\n\r\n    /**\r\n     * Align current content table cell at the right\r\n     */\r\n    | 'alignCellRight';\r\n\r\n/**\r\n * Operations used by editTable() API for align table cell vertically\r\n */\r\nexport type TableCellVerticalAlignOperation =\r\n    /**\r\n     * Align current content table cell at the top\r\n     */\r\n    | 'alignCellTop'\r\n\r\n    /**\r\n     * Align current table cell at the middle\r\n     */\r\n    | 'alignCellMiddle'\r\n\r\n    /**\r\n     * Align current table cell at the bottom\r\n     */\r\n    | 'alignCellBottom';\r\n\r\n/**\r\n * Operations used by editTable() API\r\n */\r\nexport type TableOperation =\r\n    | TableVerticalInsertOperation\r\n    | TableHorizontalInsertOperation\r\n    | TableDeleteOperation\r\n    | TableVerticalMergeOperation\r\n    | TableHorizontalMergeOperation\r\n    | TableCellMergeOperation\r\n    | TableSplitOperation\r\n    | TableAlignOperation\r\n    | TableCellHorizontalAlignOperation\r\n    | TableCellVerticalAlignOperation;\r\n"]}

package/lib-amd/event/BasePluginEvent.d.ts

@@ -0,0 +1,27 @@
+import type { PluginEventType } from './PluginEventType';
+/**
+ * Editor plugin event interface
+ */
+export interface BasePluginEvent<TPluginEventType extends PluginEventType> {
+    /**
+     * Type of this event
+     */
+    eventType: TPluginEventType;
+    /**
+     * An optional event cache.
+     * This will be consumed by event cache API to store some expensive calculation result.
+     * So that for the same event across plugins, the result doesn't need to be calculated again
+     */
+    eventDataCache?: {
+        [key: string]: any;
+    };
+}
+/**
+ * Editor plugin event interface
+ */
+export interface BasePluginDomEvent<TPluginEventType extends PluginEventType, TRawEvent extends Event> extends BasePluginEvent<TPluginEventType> {
+    /**
+     * Raw DOM event
+     */
+    rawEvent: TRawEvent;
+}

package/lib-amd/event/BasePluginEvent.js

@@ -0,0 +1,5 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});
+//# sourceMappingURL=BasePluginEvent.js.map

package/lib-amd/event/BasePluginEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BasePluginEvent.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/event/BasePluginEvent.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginEventType } from './PluginEventType';\r\n\r\n/**\r\n * Editor plugin event interface\r\n */\r\nexport interface BasePluginEvent<TPluginEventType extends PluginEventType> {\r\n    /**\r\n     * Type of this event\r\n     */\r\n    eventType: TPluginEventType;\r\n\r\n    /**\r\n     * An optional event cache.\r\n     * This will be consumed by event cache API to store some expensive calculation result.\r\n     * So that for the same event across plugins, the result doesn't need to be calculated again\r\n     */\r\n    eventDataCache?: { [key: string]: any };\r\n}\r\n\r\n/**\r\n * Editor plugin event interface\r\n */\r\nexport interface BasePluginDomEvent<\r\n    TPluginEventType extends PluginEventType,\r\n    TRawEvent extends Event\r\n> extends BasePluginEvent<TPluginEventType> {\r\n    /**\r\n     * Raw DOM event\r\n     */\r\n    rawEvent: TRawEvent;\r\n}\r\n"]}

package/lib-amd/event/BeforeCutCopyEvent.d.ts

@@ -0,0 +1,18 @@
+import type { BasePluginDomEvent } from './BasePluginEvent';
+/**
+ * Provides a chance for plugin to change the content before it is copied from editor.
+ */
+export interface BeforeCutCopyEvent extends BasePluginDomEvent<'beforeCutCopy', ClipboardEvent> {
+    /**
+     * An object contains all related data for pasting
+     */
+    clonedRoot: HTMLDivElement;
+    /**
+     * The selection range under cloned root
+     */
+    range: Range;
+    /**
+     * Whether this is a cut event
+     */
+    isCut: boolean;
+}

package/lib-amd/event/BeforeCutCopyEvent.js

@@ -0,0 +1,5 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});
+//# sourceMappingURL=BeforeCutCopyEvent.js.map

package/lib-amd/event/BeforeCutCopyEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BeforeCutCopyEvent.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/event/BeforeCutCopyEvent.ts"],"names":[],"mappings":"","sourcesContent":["import type { BasePluginDomEvent } from './BasePluginEvent';\r\n\r\n/**\r\n * Provides a chance for plugin to change the content before it is copied from editor.\r\n */\r\nexport interface BeforeCutCopyEvent extends BasePluginDomEvent<'beforeCutCopy', ClipboardEvent> {\r\n    /**\r\n     * An object contains all related data for pasting\r\n     */\r\n    clonedRoot: HTMLDivElement;\r\n\r\n    /**\r\n     * The selection range under cloned root\r\n     */\r\n    range: Range;\r\n\r\n    /**\r\n     * Whether this is a cut event\r\n     */\r\n    isCut: boolean;\r\n}\r\n"]}

package/lib-amd/event/BeforeDisposeEvent.d.ts

@@ -0,0 +1,6 @@
+import type { BasePluginEvent } from './BasePluginEvent';
+/**
+ * Provides a chance for plugin to change the content before it is pasted into editor.
+ */
+export interface BeforeDisposeEvent extends BasePluginEvent<'beforeDispose'> {
+}

package/lib-amd/event/BeforeDisposeEvent.js

@@ -0,0 +1,5 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});
+//# sourceMappingURL=BeforeDisposeEvent.js.map

package/lib-amd/event/BeforeDisposeEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BeforeDisposeEvent.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/event/BeforeDisposeEvent.ts"],"names":[],"mappings":"","sourcesContent":["import type { BasePluginEvent } from './BasePluginEvent';\r\n\r\n/**\r\n * Provides a chance for plugin to change the content before it is pasted into editor.\r\n */\r\nexport interface BeforeDisposeEvent extends BasePluginEvent<'beforeDispose'> {}\r\n"]}

package/lib-amd/event/BeforeKeyboardEditingEvent.d.ts

@@ -0,0 +1,6 @@
+import type { BasePluginDomEvent } from './BasePluginEvent';
+/**
+ * Provides a chance for plugin to change the content before it is copied from editor.
+ */
+export interface BeforeKeyboardEditingEvent extends BasePluginDomEvent<'beforeKeyboardEditing', KeyboardEvent> {
+}

package/lib-amd/event/BeforeKeyboardEditingEvent.js

@@ -0,0 +1,5 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});
+//# sourceMappingURL=BeforeKeyboardEditingEvent.js.map

package/lib-amd/event/BeforeKeyboardEditingEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BeforeKeyboardEditingEvent.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/event/BeforeKeyboardEditingEvent.ts"],"names":[],"mappings":"","sourcesContent":["import type { BasePluginDomEvent } from './BasePluginEvent';\r\n\r\n/**\r\n * Provides a chance for plugin to change the content before it is copied from editor.\r\n */\r\nexport interface BeforeKeyboardEditingEvent\r\n    extends BasePluginDomEvent<'beforeKeyboardEditing', KeyboardEvent> {}\r\n"]}

package/lib-amd/event/BeforePasteEvent.d.ts

@@ -0,0 +1,50 @@
+import type { DomToModelOptionForSanitizing } from '../context/DomToModelOption';
+import type { PasteType } from '../enum/PasteType';
+import type { ClipboardData } from '../parameter/ClipboardData';
+import type { BasePluginEvent } from './BasePluginEvent';
+import type { ContentModelDocument } from '../group/ContentModelDocument';
+import type { InsertPoint } from '../selection/InsertPoint';
+/**
+ * A function type used by merging pasted content into current Content Model
+ * @param target Target Content Model to merge into
+ * @param source Source Content Model to merge from
+ * @returns Insert point after merge
+ */
+export declare type MergePastedContentFunc = (target: ContentModelDocument, source: ContentModelDocument) => InsertPoint | null;
+/**
+ * Data of BeforePasteEvent
+ */
+export interface BeforePasteEvent extends BasePluginEvent<'beforePaste'> {
+    /**
+     * An object contains all related data for pasting
+     */
+    readonly clipboardData: ClipboardData;
+    /**
+     * HTML Document Fragment which will be inserted into content
+     */
+    readonly fragment: DocumentFragment;
+    /**
+     * Stripped HTML string before "StartFragment" comment
+     */
+    readonly htmlBefore: string;
+    /**
+     * Stripped HTML string after "EndFragment" comment
+     */
+    readonly htmlAfter: string;
+    /**
+     * Attributes of the root "HTML" tag
+     */
+    readonly htmlAttributes: Record<string, string>;
+    /**
+     * Paste type option (as plain text, merge format, normal, as image)
+     */
+    readonly pasteType: PasteType;
+    /**
+     * domToModel Options to use when creating the content model from the paste fragment
+     */
+    readonly domToModelOption: DomToModelOptionForSanitizing;
+    /**
+     * customizedMerge Customized merge function to use when merging the paste fragment into the editor
+     */
+    customizedMerge?: MergePastedContentFunc;
+}

package/lib-amd/event/BeforePasteEvent.js

@@ -0,0 +1,5 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});
+//# sourceMappingURL=BeforePasteEvent.js.map

package/lib-amd/event/BeforePasteEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BeforePasteEvent.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/event/BeforePasteEvent.ts"],"names":[],"mappings":"","sourcesContent":["import type { DomToModelOptionForSanitizing } from '../context/DomToModelOption';\r\nimport type { PasteType } from '../enum/PasteType';\r\nimport type { ClipboardData } from '../parameter/ClipboardData';\r\nimport type { BasePluginEvent } from './BasePluginEvent';\r\nimport type { ContentModelDocument } from '../group/ContentModelDocument';\r\nimport type { InsertPoint } from '../selection/InsertPoint';\r\n\r\n/**\r\n * A function type used by merging pasted content into current Content Model\r\n * @param target Target Content Model to merge into\r\n * @param source Source Content Model to merge from\r\n * @returns Insert point after merge\r\n */\r\nexport type MergePastedContentFunc = (\r\n    target: ContentModelDocument,\r\n    source: ContentModelDocument\r\n) => InsertPoint | null;\r\n\r\n/**\r\n * Data of BeforePasteEvent\r\n */\r\nexport interface BeforePasteEvent extends BasePluginEvent<'beforePaste'> {\r\n    /**\r\n     * An object contains all related data for pasting\r\n     */\r\n    readonly clipboardData: ClipboardData;\r\n\r\n    /**\r\n     * HTML Document Fragment which will be inserted into content\r\n     */\r\n    readonly fragment: DocumentFragment;\r\n\r\n    /**\r\n     * Stripped HTML string before \"StartFragment\" comment\r\n     */\r\n    readonly htmlBefore: string;\r\n\r\n    /**\r\n     * Stripped HTML string after \"EndFragment\" comment\r\n     */\r\n    readonly htmlAfter: string;\r\n\r\n    /**\r\n     * Attributes of the root \"HTML\" tag\r\n     */\r\n    readonly htmlAttributes: Record<string, string>;\r\n\r\n    /**\r\n     * Paste type option (as plain text, merge format, normal, as image)\r\n     */\r\n    readonly pasteType: PasteType;\r\n\r\n    /**\r\n     * domToModel Options to use when creating the content model from the paste fragment\r\n     */\r\n    readonly domToModelOption: DomToModelOptionForSanitizing;\r\n\r\n    /**\r\n     * customizedMerge Customized merge function to use when merging the paste fragment into the editor\r\n     */\r\n    customizedMerge?: MergePastedContentFunc;\r\n}\r\n"]}

package/lib-amd/event/BeforeSetContentEvent.d.ts

@@ -0,0 +1,11 @@
+import type { BasePluginEvent } from './BasePluginEvent';
+/**
+ * The event to be triggered before SetContent API is called.
+ * Handle this event to cache anything you need from editor before it is gone.
+ */
+export interface BeforeSetContentEvent extends BasePluginEvent<'beforeSetContent'> {
+    /**
+     * New content HTML that is about to set to editor
+     */
+    newContent: string;
+}

package/lib-amd/event/BeforeSetContentEvent.js

@@ -0,0 +1,5 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});
+//# sourceMappingURL=BeforeSetContentEvent.js.map

package/lib-amd/event/BeforeSetContentEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BeforeSetContentEvent.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/event/BeforeSetContentEvent.ts"],"names":[],"mappings":"","sourcesContent":["import type { BasePluginEvent } from './BasePluginEvent';\r\n\r\n/**\r\n * The event to be triggered before SetContent API is called.\r\n * Handle this event to cache anything you need from editor before it is gone.\r\n */\r\nexport interface BeforeSetContentEvent extends BasePluginEvent<'beforeSetContent'> {\r\n    /**\r\n     * New content HTML that is about to set to editor\r\n     */\r\n    newContent: string;\r\n}\r\n"]}

package/lib-amd/event/ContentChangedEvent.d.ts

@@ -0,0 +1,61 @@
+import type { AnnounceData } from '../parameter/AnnounceData';
+import type { BasePluginEvent } from './BasePluginEvent';
+import type { EntityState } from '../parameter/FormatContentModelContext';
+import type { ContentModelEntity } from '../entity/ContentModelEntity';
+import type { EntityRemovalOperation } from '../enum/EntityOperation';
+import type { ContentModelDocument } from '../group/ContentModelDocument';
+import type { DOMSelection } from '../selection/DOMSelection';
+/**
+ * Represents an entity that has been changed during a content change process
+ */
+export interface ChangedEntity {
+    /**
+     * The changed entity
+     */
+    entity: ContentModelEntity;
+    /**
+     * Operation that causes the change
+     */
+    operation: EntityRemovalOperation | 'newEntity';
+    /**
+     * @optional Raw DOM event that causes the change
+     */
+    rawEvent?: Event;
+}
+/**
+ * Represents a change to the editor made by another plugin with content model inside
+ */
+export interface ContentChangedEvent extends BasePluginEvent<'contentChanged'> {
+    /**
+     * The content model that is applied which causes this content changed event
+     */
+    readonly contentModel?: ContentModelDocument;
+    /**
+     * Selection range applied to the document
+     */
+    readonly selection?: DOMSelection;
+    /**
+     * Entities got changed (added or removed) during the content change process
+     */
+    readonly changedEntities?: ChangedEntity[];
+    /**
+     * Entity states related to this event
+     */
+    readonly entityStates?: EntityState[];
+    /**
+     * Source of the change
+     */
+    readonly source: string;
+    /**
+     * Optional related data
+     */
+    readonly data?: any;
+    /**
+     * Optional property to store the format api name when using ChangeSource.Format
+     */
+    readonly formatApiName?: string;
+    /**
+     * @optional Announce data from this content changed event.
+     */
+    readonly announceData?: AnnounceData;
+}

package/lib-amd/event/ContentChangedEvent.js

@@ -0,0 +1,5 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});
+//# sourceMappingURL=ContentChangedEvent.js.map

package/lib-amd/event/ContentChangedEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentChangedEvent.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/event/ContentChangedEvent.ts"],"names":[],"mappings":"","sourcesContent":["import type { AnnounceData } from '../parameter/AnnounceData';\r\nimport type { BasePluginEvent } from './BasePluginEvent';\r\nimport type { EntityState } from '../parameter/FormatContentModelContext';\r\nimport type { ContentModelEntity } from '../entity/ContentModelEntity';\r\nimport type { EntityRemovalOperation } from '../enum/EntityOperation';\r\nimport type { ContentModelDocument } from '../group/ContentModelDocument';\r\nimport type { DOMSelection } from '../selection/DOMSelection';\r\n\r\n/**\r\n * Represents an entity that has been changed during a content change process\r\n */\r\nexport interface ChangedEntity {\r\n    /**\r\n     * The changed entity\r\n     */\r\n    entity: ContentModelEntity;\r\n\r\n    /**\r\n     * Operation that causes the change\r\n     */\r\n    operation: EntityRemovalOperation | 'newEntity';\r\n\r\n    /**\r\n     * @optional Raw DOM event that causes the change\r\n     */\r\n    rawEvent?: Event;\r\n}\r\n\r\n/**\r\n * Represents a change to the editor made by another plugin with content model inside\r\n */\r\nexport interface ContentChangedEvent extends BasePluginEvent<'contentChanged'> {\r\n    /**\r\n     * The content model that is applied which causes this content changed event\r\n     */\r\n    readonly contentModel?: ContentModelDocument;\r\n\r\n    /**\r\n     * Selection range applied to the document\r\n     */\r\n    readonly selection?: DOMSelection;\r\n\r\n    /**\r\n     * Entities got changed (added or removed) during the content change process\r\n     */\r\n    readonly changedEntities?: ChangedEntity[];\r\n\r\n    /**\r\n     * Entity states related to this event\r\n     */\r\n    readonly entityStates?: EntityState[];\r\n\r\n    /**\r\n     * Source of the change\r\n     */\r\n    readonly source: string;\r\n\r\n    /**\r\n     * Optional related data\r\n     */\r\n    readonly data?: any;\r\n\r\n    /**\r\n     * Optional property to store the format api name when using ChangeSource.Format\r\n     */\r\n    readonly formatApiName?: string;\r\n\r\n    /**\r\n     * @optional Announce data from this content changed event.\r\n     */\r\n    readonly announceData?: AnnounceData;\r\n}\r\n"]}

package/lib-amd/event/ContextMenuEvent.d.ts

@@ -0,0 +1,12 @@
+import type { BasePluginDomEvent } from './BasePluginEvent';
+/**
+ * This interface represents a PluginEvent wrapping native ContextMenu event
+ */
+export interface ContextMenuEvent extends BasePluginDomEvent<'contextMenu', MouseEvent> {
+    /**
+     * A callback array to let editor retrieve context menu item related to this event.
+     * Plugins can add their own getter callback to this array,
+     * items from each getter will be separated by a splitter item represented by null
+     */
+    items: any[];
+}

package/lib-amd/event/ContextMenuEvent.js

@@ -0,0 +1,5 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});
+//# sourceMappingURL=ContextMenuEvent.js.map

package/lib-amd/event/ContextMenuEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContextMenuEvent.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/event/ContextMenuEvent.ts"],"names":[],"mappings":"","sourcesContent":["import type { BasePluginDomEvent } from './BasePluginEvent';\r\n\r\n/**\r\n * This interface represents a PluginEvent wrapping native ContextMenu event\r\n */\r\nexport interface ContextMenuEvent extends BasePluginDomEvent<'contextMenu', MouseEvent> {\r\n    /**\r\n     * A callback array to let editor retrieve context menu item related to this event.\r\n     * Plugins can add their own getter callback to this array,\r\n     * items from each getter will be separated by a splitter item represented by null\r\n     */\r\n    items: any[];\r\n}\r\n"]}

package/lib-amd/event/EditImageEvent.d.ts

@@ -0,0 +1,25 @@
+import type { BasePluginEvent } from './BasePluginEvent';
+/**
+ * Represents an event that will be fired when an inline image is edited by user, and the src
+ * attribute of the image is about to be changed
+ */
+export interface EditImageEvent extends BasePluginEvent<'editImage'> {
+    /**
+     * The image element that is being changed
+     */
+    readonly image: HTMLImageElement;
+    /**
+     * Original src of the image before all editing in current editor session.
+     */
+    readonly originalSrc: string;
+    /**
+     * Src of the image before current batch of editing
+     * Plugin can check this value to know which image is not used after the change.
+     */
+    readonly previousSrc: string;
+    /**
+     * New src of the changed image, in DataUri format.
+     * Plugin can modify this string so that the modified one will be set to the image element
+     */
+    newSrc: string;
+}

package/lib-amd/event/EditImageEvent.js

@@ -0,0 +1,5 @@
+define(["require", "exports"], function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});
+//# sourceMappingURL=EditImageEvent.js.map

package/lib-amd/event/EditImageEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EditImageEvent.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/event/EditImageEvent.ts"],"names":[],"mappings":"","sourcesContent":["import type { BasePluginEvent } from './BasePluginEvent';\r\n\r\n/**\r\n * Represents an event that will be fired when an inline image is edited by user, and the src\r\n * attribute of the image is about to be changed\r\n */\r\nexport interface EditImageEvent extends BasePluginEvent<'editImage'> {\r\n    /**\r\n     * The image element that is being changed\r\n     */\r\n    readonly image: HTMLImageElement;\r\n\r\n    /**\r\n     * Original src of the image before all editing in current editor session.\r\n     */\r\n    readonly originalSrc: string;\r\n\r\n    /**\r\n     * Src of the image before current batch of editing\r\n     * Plugin can check this value to know which image is not used after the change.\r\n     */\r\n    readonly previousSrc: string;\r\n\r\n    /**\r\n     * New src of the changed image, in DataUri format.\r\n     * Plugin can modify this string so that the modified one will be set to the image element\r\n     */\r\n    newSrc: string;\r\n}\r\n"]}

package/lib-amd/event/EditorInputEvent.d.ts

@@ -0,0 +1,10 @@
+import type { BasePluginEvent } from './BasePluginEvent';
+/**
+ * This interface represents a PluginEvent wrapping native input / textinput event
+ */
+export interface EditorInputEvent extends BasePluginEvent<'input'> {
+    /**
+     * Raw Input Event
+     */
+    rawEvent: InputEvent;
+}