roosterjs-content-model-types 0.0.3

package/lib-amd/parameter/ContentModelFormatState.d.ts

@@ -0,0 +1,143 @@
+import type { TableMetadataFormat } from '../format/metadata/TableMetadataFormat';
+import type { ImageFormatState } from './ImageFormatState';
+/**
+ * The format object state in Content Model
+ */
+export interface ContentModelFormatState {
+    /**
+     * Whether the text is bolded
+     */
+    isBold?: boolean;
+    /**
+     * Whether the text is italic
+     */
+    isItalic?: boolean;
+    /**
+     * Whether the text has underline
+     */
+    isUnderline?: boolean;
+    /**
+     * Whether the text has strike through line
+     */
+    isStrikeThrough?: boolean;
+    /**
+     * Whether the text is in subscript mode
+     */
+    isSubscript?: boolean;
+    /**
+     * Whether the text is in superscript mode
+     */
+    isSuperscript?: boolean;
+    /**
+     * Whether the text is in bullet mode
+     */
+    isBullet?: boolean;
+    /**
+     * Whether the text is in numbering mode
+     */
+    isNumbering?: boolean;
+    /**
+     * Whether the text is in block quote
+     */
+    isBlockQuote?: boolean;
+    /**
+     * Whether the text is in Code element
+     */
+    isCodeInline?: boolean;
+    /**
+     * Whether the text is in Code block
+     */
+    isCodeBlock?: boolean;
+    /**
+     * Whether unlink command can be called to the text
+     */
+    canUnlink?: boolean;
+    /**
+     * Whether the selected text is multiline
+     */
+    isMultilineSelection?: boolean;
+    /**
+     * Whether add image alt text command can be called to the text
+     */
+    canAddImageAltText?: boolean;
+    /**
+     * Heading level (0-6, 0 means no heading)
+     */
+    headingLevel?: number;
+    /**
+     * Whether the cursor is in table
+     */
+    isInTable?: boolean;
+    /**
+     * Format of table, if there is table at cursor position
+     */
+    tableFormat?: TableMetadataFormat;
+    /**
+     * If there is a table, whether the table has header row
+     */
+    tableHasHeader?: boolean;
+    /**
+     * Whether we can execute table cell merge operation
+     */
+    canMergeTableCell?: boolean;
+    /**
+     * Font name
+     */
+    fontName?: string;
+    /**
+     * Font size
+     */
+    fontSize?: string;
+    /**
+     * Background color
+     */
+    backgroundColor?: string;
+    /**
+     * Text color
+     */
+    textColor?: string;
+    /**
+     * Line height
+     */
+    lineHeight?: string;
+    /**
+     * Margin Top
+     */
+    marginTop?: string;
+    /**
+     * Margin Bottom
+     */
+    marginBottom?: string;
+    /**
+     * Text Align
+     */
+    textAlign?: string;
+    /**
+     * Direction of the element ('ltr' or 'rtl')
+     */
+    direction?: string;
+    /**
+     * Font weight
+     */
+    fontWeight?: string;
+    /**
+     * Format of image, if there is table at cursor position
+     */
+    imageFormat?: ImageFormatState;
+    /**
+     * Letter spacing
+     */
+    letterSpacing?: string;
+    /**
+     * Whether the content can be undone
+     */
+    canUndo?: boolean;
+    /**
+     * Whether the content ca nbe redone
+     */
+    canRedo?: boolean;
+    /**
+     * Whether editor is in dark mode
+     */
+    isDarkMode?: boolean;
+}

package/lib-amd/parameter/ContentModelFormatState.js

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

package/lib-amd/parameter/ContentModelFormatState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContentModelFormatState.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/parameter/ContentModelFormatState.ts"],"names":[],"mappings":"","sourcesContent":["import type { TableMetadataFormat } from '../format/metadata/TableMetadataFormat';\r\nimport type { ImageFormatState } from './ImageFormatState';\r\n\r\n/**\r\n * The format object state in Content Model\r\n */\r\nexport interface ContentModelFormatState {\r\n    /**\r\n     * Whether the text is bolded\r\n     */\r\n    isBold?: boolean;\r\n\r\n    /**\r\n     * Whether the text is italic\r\n     */\r\n    isItalic?: boolean;\r\n\r\n    /**\r\n     * Whether the text has underline\r\n     */\r\n    isUnderline?: boolean;\r\n\r\n    /**\r\n     * Whether the text has strike through line\r\n     */\r\n    isStrikeThrough?: boolean;\r\n\r\n    /**\r\n     * Whether the text is in subscript mode\r\n     */\r\n    isSubscript?: boolean;\r\n\r\n    /**\r\n     * Whether the text is in superscript mode\r\n     */\r\n    isSuperscript?: boolean;\r\n\r\n    /**\r\n     * Whether the text is in bullet mode\r\n     */\r\n    isBullet?: boolean;\r\n\r\n    /**\r\n     * Whether the text is in numbering mode\r\n     */\r\n    isNumbering?: boolean;\r\n\r\n    /**\r\n     * Whether the text is in block quote\r\n     */\r\n    isBlockQuote?: boolean;\r\n\r\n    /**\r\n     * Whether the text is in Code element\r\n     */\r\n    isCodeInline?: boolean;\r\n\r\n    /**\r\n     * Whether the text is in Code block\r\n     */\r\n    isCodeBlock?: boolean;\r\n\r\n    /**\r\n     * Whether unlink command can be called to the text\r\n     */\r\n    canUnlink?: boolean;\r\n\r\n    /**\r\n     * Whether the selected text is multiline\r\n     */\r\n    isMultilineSelection?: boolean;\r\n\r\n    /**\r\n     * Whether add image alt text command can be called to the text\r\n     */\r\n    canAddImageAltText?: boolean;\r\n\r\n    /**\r\n     * Heading level (0-6, 0 means no heading)\r\n     */\r\n    headingLevel?: number;\r\n\r\n    /**\r\n     * Whether the cursor is in table\r\n     */\r\n    isInTable?: boolean;\r\n\r\n    /**\r\n     * Format of table, if there is table at cursor position\r\n     */\r\n    tableFormat?: TableMetadataFormat;\r\n\r\n    /**\r\n     * If there is a table, whether the table has header row\r\n     */\r\n    tableHasHeader?: boolean;\r\n\r\n    /**\r\n     * Whether we can execute table cell merge operation\r\n     */\r\n    canMergeTableCell?: boolean;\r\n\r\n    /**\r\n     * Font name\r\n     */\r\n    fontName?: string;\r\n\r\n    /**\r\n     * Font size\r\n     */\r\n    fontSize?: string;\r\n\r\n    /**\r\n     * Background color\r\n     */\r\n    backgroundColor?: string;\r\n\r\n    /**\r\n     * Text color\r\n     */\r\n    textColor?: string;\r\n\r\n    /**\r\n     * Line height\r\n     */\r\n    lineHeight?: string;\r\n\r\n    /**\r\n     * Margin Top\r\n     */\r\n    marginTop?: string;\r\n\r\n    /**\r\n     * Margin Bottom\r\n     */\r\n    marginBottom?: string;\r\n\r\n    /**\r\n     * Text Align\r\n     */\r\n    textAlign?: string;\r\n\r\n    /**\r\n     * Direction of the element ('ltr' or 'rtl')\r\n     */\r\n    direction?: string;\r\n\r\n    /**\r\n     * Font weight\r\n     */\r\n    fontWeight?: string;\r\n\r\n    /**\r\n     * Format of image, if there is table at cursor position\r\n     */\r\n    imageFormat?: ImageFormatState;\r\n\r\n    /**\r\n     * Letter spacing\r\n     */\r\n    letterSpacing?: string;\r\n\r\n    /**\r\n     * Whether the content can be undone\r\n     */\r\n    canUndo?: boolean;\r\n\r\n    /**\r\n     * Whether the content ca nbe redone\r\n     */\r\n    canRedo?: boolean;\r\n\r\n    /**\r\n     * Whether editor is in dark mode\r\n     */\r\n    isDarkMode?: boolean;\r\n}\r\n"]}

package/lib-amd/parameter/DOMEventRecord.d.ts

@@ -0,0 +1,19 @@
+import type { PluginEventType } from '../event/PluginEventType';
+/**
+ * Handler function type of DOM event
+ */
+export declare type DOMEventHandlerFunction<E = Event> = (event: E) => void;
+/**
+ * DOM event handler object with mapped plugin event type and handler function
+ */
+export interface DOMEventRecord<E = Event> {
+    /**
+     * Type of plugin event. The DOM event will be mapped with this plugin event type
+     */
+    pluginEventType?: PluginEventType | null;
+    /**
+     * Handler function. Besides the mapped plugin event type, this function will also be triggered
+     * when correlated DOM event is fired
+     */
+    beforeDispatch?: DOMEventHandlerFunction<E> | null;
+}

package/lib-amd/parameter/DOMEventRecord.js

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

package/lib-amd/parameter/DOMEventRecord.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DOMEventRecord.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/parameter/DOMEventRecord.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginEventType } from '../event/PluginEventType';\r\n\r\n/**\r\n * Handler function type of DOM event\r\n */\r\nexport type DOMEventHandlerFunction<E = Event> = (event: E) => void;\r\n\r\n/**\r\n * DOM event handler object with mapped plugin event type and handler function\r\n */\r\nexport interface DOMEventRecord<E = Event> {\r\n    /**\r\n     * Type of plugin event. The DOM event will be mapped with this plugin event type\r\n     */\r\n    pluginEventType?: PluginEventType | null;\r\n\r\n    /**\r\n     * Handler function. Besides the mapped plugin event type, this function will also be triggered\r\n     * when correlated DOM event is fired\r\n     */\r\n    beforeDispatch?: DOMEventHandlerFunction<E> | null;\r\n}\r\n"]}

package/lib-amd/parameter/DOMHelper.d.ts

@@ -0,0 +1,48 @@
+/**
+ * A helper class to provide DOM access APIs
+ */
+export interface DOMHelper {
+    /**
+     * Check if the given DOM node is in editor
+     * @param node The node to check
+     */
+    isNodeInEditor(node: Node): boolean;
+    /**
+     * Query HTML elements in editor by tag name.
+     * Be careful of this function since it will also return element under entity.
+     * @param tag Tag name of the element to query
+     * @returns HTML Element array of the query result
+     */
+    queryElements<TTag extends keyof HTMLElementTagNameMap>(tag: TTag): HTMLElementTagNameMap[TTag][];
+    /**
+     * Query HTML elements in editor by a selector string
+     * Be careful of this function since it will also return element under entity.
+     * @param selector Selector string to query
+     * @returns HTML Element array of the query result
+     */
+    queryElements(selector: string): HTMLElement[];
+    /**
+     * Get plain text content of editor using textContent property
+     */
+    getTextContent(): string;
+    /**
+     * Calculate current zoom scale of editor
+     */
+    calculateZoomScale(): number;
+    /**
+     * Set DOM attribute of editor content DIV
+     * @param name Name of the attribute
+     * @param value Value of the attribute
+     */
+    setDomAttribute(name: string, value: string | null): void;
+    /**
+     * Get DOM attribute of editor content DIV, null if there is no such attribute.
+     * @param name Name of the attribute
+     */
+    getDomAttribute(name: string): string | null;
+    /**
+     * Get DOM style of editor content DIV
+     * @param style Name of the style
+     */
+    getDomStyle<T extends keyof CSSStyleDeclaration>(style: T): CSSStyleDeclaration[T];
+}

package/lib-amd/parameter/DOMHelper.js

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

package/lib-amd/parameter/DOMHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DOMHelper.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/parameter/DOMHelper.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * A helper class to provide DOM access APIs\r\n */\r\nexport interface DOMHelper {\r\n    /**\r\n     * Check if the given DOM node is in editor\r\n     * @param node The node to check\r\n     */\r\n    isNodeInEditor(node: Node): boolean;\r\n\r\n    /**\r\n     * Query HTML elements in editor by tag name.\r\n     * Be careful of this function since it will also return element under entity.\r\n     * @param tag Tag name of the element to query\r\n     * @returns HTML Element array of the query result\r\n     */\r\n    queryElements<TTag extends keyof HTMLElementTagNameMap>(\r\n        tag: TTag\r\n    ): HTMLElementTagNameMap[TTag][];\r\n\r\n    /**\r\n     * Query HTML elements in editor by a selector string\r\n     * Be careful of this function since it will also return element under entity.\r\n     * @param selector Selector string to query\r\n     * @returns HTML Element array of the query result\r\n     */\r\n    queryElements(selector: string): HTMLElement[];\r\n\r\n    /**\r\n     * Get plain text content of editor using textContent property\r\n     */\r\n    getTextContent(): string;\r\n\r\n    /**\r\n     * Calculate current zoom scale of editor\r\n     */\r\n    calculateZoomScale(): number;\r\n\r\n    /**\r\n     * Set DOM attribute of editor content DIV\r\n     * @param name Name of the attribute\r\n     * @param value Value of the attribute\r\n     */\r\n    setDomAttribute(name: string, value: string | null): void;\r\n\r\n    /**\r\n     * Get DOM attribute of editor content DIV, null if there is no such attribute.\r\n     * @param name Name of the attribute\r\n     */\r\n    getDomAttribute(name: string): string | null;\r\n\r\n    /**\r\n     * Get DOM style of editor content DIV\r\n     * @param style Name of the style\r\n     */\r\n    getDomStyle<T extends keyof CSSStyleDeclaration>(style: T): CSSStyleDeclaration[T];\r\n}\r\n"]}

package/lib-amd/parameter/DeleteSelectionStep.d.ts

@@ -0,0 +1,49 @@
+import type { ContentModelParagraph } from '../block/ContentModelParagraph';
+import type { DeleteResult } from '../enum/DeleteResult';
+import type { FormatContentModelContext } from './FormatContentModelContext';
+import type { InsertPoint } from '../selection/InsertPoint';
+import type { TableSelectionContext } from '../selection/TableSelectionContext';
+/**
+ * Result of deleteSelection API
+ */
+export interface DeleteSelectionResult {
+    /**
+     * Insert point position after delete, or null if there is no insert point
+     */
+    insertPoint: InsertPoint | null;
+    /**
+     * Delete result
+     */
+    deleteResult: DeleteResult;
+}
+/**
+ * A context object used by DeleteSelectionStep
+ */
+export interface DeleteSelectionContext extends DeleteSelectionResult {
+    /**
+     * Last paragraph after previous step
+     */
+    lastParagraph?: ContentModelParagraph;
+    /**
+     * Last table context after previous step
+     */
+    lastTableContext?: TableSelectionContext;
+    /**
+     * Format context provided by formatContentModel API
+     */
+    formatContext?: FormatContentModelContext;
+}
+/**
+ * DeleteSelectionContext with a valid insert point that can be handled by next step
+ */
+export interface ValidDeleteSelectionContext extends DeleteSelectionContext {
+    /**
+     * Insert point position after delete
+     */
+    insertPoint: InsertPoint;
+}
+/**
+ * Represents a step function for deleteSelection API
+ * @param context The valid delete selection context object returned from previous step
+ */
+export declare type DeleteSelectionStep = (context: ValidDeleteSelectionContext) => void;

package/lib-amd/parameter/DeleteSelectionStep.js

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

package/lib-amd/parameter/DeleteSelectionStep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DeleteSelectionStep.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/parameter/DeleteSelectionStep.ts"],"names":[],"mappings":"","sourcesContent":["import type { ContentModelParagraph } from '../block/ContentModelParagraph';\r\nimport type { DeleteResult } from '../enum/DeleteResult';\r\nimport type { FormatContentModelContext } from './FormatContentModelContext';\r\nimport type { InsertPoint } from '../selection/InsertPoint';\r\nimport type { TableSelectionContext } from '../selection/TableSelectionContext';\r\n\r\n/**\r\n * Result of deleteSelection API\r\n */\r\nexport interface DeleteSelectionResult {\r\n    /**\r\n     * Insert point position after delete, or null if there is no insert point\r\n     */\r\n    insertPoint: InsertPoint | null;\r\n\r\n    /**\r\n     * Delete result\r\n     */\r\n    deleteResult: DeleteResult;\r\n}\r\n\r\n/**\r\n * A context object used by DeleteSelectionStep\r\n */\r\nexport interface DeleteSelectionContext extends DeleteSelectionResult {\r\n    /**\r\n     * Last paragraph after previous step\r\n     */\r\n    lastParagraph?: ContentModelParagraph;\r\n\r\n    /**\r\n     * Last table context after previous step\r\n     */\r\n    lastTableContext?: TableSelectionContext;\r\n\r\n    /**\r\n     * Format context provided by formatContentModel API\r\n     */\r\n    formatContext?: FormatContentModelContext;\r\n}\r\n\r\n/**\r\n * DeleteSelectionContext with a valid insert point that can be handled by next step\r\n */\r\nexport interface ValidDeleteSelectionContext extends DeleteSelectionContext {\r\n    /**\r\n     * Insert point position after delete\r\n     */\r\n    insertPoint: InsertPoint;\r\n}\r\n\r\n/**\r\n * Represents a step function for deleteSelection API\r\n * @param context The valid delete selection context object returned from previous step\r\n */\r\nexport type DeleteSelectionStep = (context: ValidDeleteSelectionContext) => void;\r\n"]}

package/lib-amd/parameter/EdgeLinkPreview.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The link preview pasted info provided by Edge
+ */
+export interface EdgeLinkPreview {
+    /**
+     * Domain of the source page
+     */
+    domain: string;
+    /**
+     * Preferred paste format
+     */
+    preferred_format: string;
+    /**
+     * Title of the source page
+     */
+    title: string;
+    /**
+     * Type of the paste content
+     */
+    type: string;
+    /**
+     * Url of the source page
+     */
+    url: string;
+}

package/lib-amd/parameter/EdgeLinkPreview.js

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

package/lib-amd/parameter/EdgeLinkPreview.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EdgeLinkPreview.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/parameter/EdgeLinkPreview.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * The link preview pasted info provided by Edge\r\n */\r\nexport interface EdgeLinkPreview {\r\n    /**\r\n     * Domain of the source page\r\n     */\r\n    domain: string;\r\n\r\n    /**\r\n     * Preferred paste format\r\n     */\r\n    preferred_format: string;\r\n\r\n    /**\r\n     * Title of the source page\r\n     */\r\n    title: string;\r\n\r\n    /**\r\n     * Type of the paste content\r\n     */\r\n    type: string;\r\n\r\n    /**\r\n     * Url of the source page\r\n     */\r\n    url: string;\r\n}\r\n"]}

package/lib-amd/parameter/EditorEnvironment.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Current running environment
+ */
+export interface EditorEnvironment {
+    /**
+     * Whether editor is running on Mac
+     */
+    isMac?: boolean;
+    /**
+     * Whether editor is running on Android
+     */
+    isAndroid?: boolean;
+    /**
+     * Whether editor is running on Safari browser
+     */
+    isSafari?: boolean;
+    /**
+     * Whether current browser is on mobile or a tablet
+     */
+    isMobileOrTablet?: boolean;
+}

package/lib-amd/parameter/EditorEnvironment.js

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

package/lib-amd/parameter/EditorEnvironment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EditorEnvironment.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/parameter/EditorEnvironment.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * Current running environment\r\n */\r\nexport interface EditorEnvironment {\r\n    /**\r\n     * Whether editor is running on Mac\r\n     */\r\n    isMac?: boolean;\r\n\r\n    /**\r\n     * Whether editor is running on Android\r\n     */\r\n    isAndroid?: boolean;\r\n\r\n    /**\r\n     * Whether editor is running on Safari browser\r\n     */\r\n    isSafari?: boolean;\r\n\r\n    /**\r\n     * Whether current browser is on mobile or a tablet\r\n     */\r\n    isMobileOrTablet?: boolean;\r\n}\r\n"]}

package/lib-amd/parameter/FormatContentModelContext.d.ts

@@ -0,0 +1,86 @@
+import type { ContentModelEntity } from '../entity/ContentModelEntity';
+import type { ContentModelImage } from '../segment/ContentModelImage';
+import type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';
+import type { EntityRemovalOperation } from '../enum/EntityOperation';
+/**
+ * State for an entity. This is used for storing entity undo snapshot
+ */
+export interface EntityState {
+    /**
+     * Type of the entity
+     */
+    type: string;
+    /**
+     * Id of the entity
+     */
+    id: string;
+    /**
+     * The state of this entity to store into undo snapshot.
+     * The state can be any string, or a serialized JSON object.
+     * We are using string here instead of a JSON object to make sure the whole state is serializable.
+     */
+    state: string;
+}
+/**
+ * Represents an entity that is deleted by a specified entity operation
+ */
+export interface DeletedEntity {
+    /**
+     * The deleted entity
+     */
+    entity: ContentModelEntity;
+    /**
+     * The operation that causes this entity to be deleted
+     */
+    operation: EntityRemovalOperation;
+}
+/**
+ * Context object for API formatWithContentModel
+ */
+export interface FormatContentModelContext {
+    /**
+     * New entities added during the format process
+     */
+    readonly newEntities: ContentModelEntity[];
+    /**
+     * Entities got deleted during formatting. Need to be set by the formatter function
+     */
+    readonly deletedEntities: DeletedEntity[];
+    /**
+     * Images inserted in the editor that needs to have their size adjusted
+     */
+    readonly newImages: ContentModelImage[];
+    /**
+     * Raw Event that triggers this format call
+     */
+    readonly rawEvent?: Event;
+    /**
+     * @optional
+     * When pass true, skip adding undo snapshot when write Content Model back to DOM.
+     * Need to be set by the formatter function
+     */
+    skipUndoSnapshot?: boolean;
+    /**
+     * @optional
+     * When set to true, formatWithContentModel API will not keep cached Content Model. Next time when we need a Content Model, a new one will be created
+     */
+    clearModelCache?: boolean;
+    /**
+     * @optional
+     * Specify new pending format.
+     * To keep current format event selection position is changed, set this value to "preserved", editor will update pending format position to the new position
+     * To set a new pending format, set this property to the format object
+     * Otherwise, leave it there and editor will automatically decide if the original pending format is still available
+     */
+    newPendingFormat?: ContentModelSegmentFormat | 'preserve';
+    /**
+     * @optional Entity states related to the format API that will be added together with undo snapshot.
+     * When entity states are set, each entity state will cause an EntityOperation event with operation = EntityOperation.UpdateEntityState
+     * when undo/redo to this snapshot
+     */
+    entityStates?: EntityState[];
+    /**
+     * @optional Set to true if this action can be undone when user press Backspace key (aka Auto Complete).
+     */
+    canUndoByBackspace?: boolean;
+}

package/lib-amd/parameter/FormatContentModelContext.js

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

package/lib-amd/parameter/FormatContentModelContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormatContentModelContext.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/parameter/FormatContentModelContext.ts"],"names":[],"mappings":"","sourcesContent":["import type { ContentModelEntity } from '../entity/ContentModelEntity';\r\nimport type { ContentModelImage } from '../segment/ContentModelImage';\r\nimport type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';\r\nimport type { EntityRemovalOperation } from '../enum/EntityOperation';\r\n\r\n/**\r\n * State for an entity. This is used for storing entity undo snapshot\r\n */\r\nexport interface EntityState {\r\n    /**\r\n     * Type of the entity\r\n     */\r\n    type: string;\r\n\r\n    /**\r\n     * Id of the entity\r\n     */\r\n    id: string;\r\n\r\n    /**\r\n     * The state of this entity to store into undo snapshot.\r\n     * The state can be any string, or a serialized JSON object.\r\n     * We are using string here instead of a JSON object to make sure the whole state is serializable.\r\n     */\r\n    state: string;\r\n}\r\n\r\n/**\r\n * Represents an entity that is deleted by a specified entity operation\r\n */\r\nexport interface DeletedEntity {\r\n    /**\r\n     * The deleted entity\r\n     */\r\n    entity: ContentModelEntity;\r\n\r\n    /**\r\n     * The operation that causes this entity to be deleted\r\n     */\r\n    operation: EntityRemovalOperation;\r\n}\r\n\r\n/**\r\n * Context object for API formatWithContentModel\r\n */\r\nexport interface FormatContentModelContext {\r\n    /**\r\n     * New entities added during the format process\r\n     */\r\n    readonly newEntities: ContentModelEntity[];\r\n\r\n    /**\r\n     * Entities got deleted during formatting. Need to be set by the formatter function\r\n     */\r\n    readonly deletedEntities: DeletedEntity[];\r\n\r\n    /**\r\n     * Images inserted in the editor that needs to have their size adjusted\r\n     */\r\n    readonly newImages: ContentModelImage[];\r\n\r\n    /**\r\n     * Raw Event that triggers this format call\r\n     */\r\n    readonly rawEvent?: Event;\r\n\r\n    /**\r\n     * @optional\r\n     * When pass true, skip adding undo snapshot when write Content Model back to DOM.\r\n     * Need to be set by the formatter function\r\n     */\r\n    skipUndoSnapshot?: boolean;\r\n\r\n    /**\r\n     * @optional\r\n     * When set to true, formatWithContentModel API will not keep cached Content Model. Next time when we need a Content Model, a new one will be created\r\n     */\r\n    clearModelCache?: boolean;\r\n\r\n    /**\r\n     * @optional\r\n     * Specify new pending format.\r\n     * To keep current format event selection position is changed, set this value to \"preserved\", editor will update pending format position to the new position\r\n     * To set a new pending format, set this property to the format object\r\n     * Otherwise, leave it there and editor will automatically decide if the original pending format is still available\r\n     */\r\n    newPendingFormat?: ContentModelSegmentFormat | 'preserve';\r\n\r\n    /**\r\n     * @optional Entity states related to the format API that will be added together with undo snapshot.\r\n     * When entity states are set, each entity state will cause an EntityOperation event with operation = EntityOperation.UpdateEntityState\r\n     * when undo/redo to this snapshot\r\n     */\r\n    entityStates?: EntityState[];\r\n\r\n    /**\r\n     * @optional Set to true if this action can be undone when user press Backspace key (aka Auto Complete).\r\n     */\r\n    canUndoByBackspace?: boolean;\r\n}\r\n"]}

package/lib-amd/parameter/FormatContentModelOptions.d.ts

@@ -0,0 +1,42 @@
+import type { ContentModelDocument } from '../group/ContentModelDocument';
+import type { DOMSelection } from '../selection/DOMSelection';
+import type { FormatContentModelContext } from './FormatContentModelContext';
+import type { OnNodeCreated } from '../context/ModelToDomSettings';
+/**
+ * Options for API formatWithContentModel
+ */
+export interface FormatContentModelOptions {
+    /**
+     * Name of the format API
+     */
+    apiName?: string;
+    /**
+     * Raw event object that triggers this call
+     */
+    rawEvent?: Event;
+    /**
+     * Change source used for triggering a ContentChanged event. @default ChangeSource.Format.
+     */
+    changeSource?: string;
+    /**
+     * An optional callback that will be called when a DOM node is created
+     * @param modelElement The related Content Model element
+     * @param node The node created for this model element
+     */
+    onNodeCreated?: OnNodeCreated;
+    /**
+     * Optional callback to get an object used for change data in ContentChangedEvent
+     */
+    getChangeData?: () => any;
+    /**
+     * When specified, use this selection range to override current selection inside editor
+     */
+    selectionOverride?: DOMSelection;
+}
+/**
+ * Type of formatter used for format Content Model.
+ * @param model The source Content Model to format
+ * @param context A context object used for pass in and out more parameters
+ * @returns True means the model is changed and need to write back to editor, otherwise false
+ */
+export declare type ContentModelFormatter = (model: ContentModelDocument, context: FormatContentModelContext) => boolean;

package/lib-amd/parameter/FormatContentModelOptions.js

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

package/lib-amd/parameter/FormatContentModelOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormatContentModelOptions.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/parameter/FormatContentModelOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { ContentModelDocument } from '../group/ContentModelDocument';\r\nimport type { DOMSelection } from '../selection/DOMSelection';\r\nimport type { FormatContentModelContext } from './FormatContentModelContext';\r\nimport type { OnNodeCreated } from '../context/ModelToDomSettings';\r\n\r\n/**\r\n * Options for API formatWithContentModel\r\n */\r\nexport interface FormatContentModelOptions {\r\n    /**\r\n     * Name of the format API\r\n     */\r\n    apiName?: string;\r\n\r\n    /**\r\n     * Raw event object that triggers this call\r\n     */\r\n    rawEvent?: Event;\r\n\r\n    /**\r\n     * Change source used for triggering a ContentChanged event. @default ChangeSource.Format.\r\n     */\r\n    changeSource?: string;\r\n\r\n    /**\r\n     * An optional callback that will be called when a DOM node is created\r\n     * @param modelElement The related Content Model element\r\n     * @param node The node created for this model element\r\n     */\r\n    onNodeCreated?: OnNodeCreated;\r\n\r\n    /**\r\n     * Optional callback to get an object used for change data in ContentChangedEvent\r\n     */\r\n    getChangeData?: () => any;\r\n\r\n    /**\r\n     * When specified, use this selection range to override current selection inside editor\r\n     */\r\n    selectionOverride?: DOMSelection;\r\n}\r\n\r\n/**\r\n * Type of formatter used for format Content Model.\r\n * @param model The source Content Model to format\r\n * @param context A context object used for pass in and out more parameters\r\n * @returns True means the model is changed and need to write back to editor, otherwise false\r\n */\r\nexport type ContentModelFormatter = (\r\n    model: ContentModelDocument,\r\n    context: FormatContentModelContext\r\n) => boolean;\r\n"]}

package/lib-amd/parameter/ImageFormatState.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Image Format
+ */
+export interface ImageFormatState {
+    /**
+     * Border color
+     */
+    borderColor?: string;
+    /**
+     * Border width
+     */
+    borderWidth?: string;
+    /**
+     * Border style
+     */
+    borderStyle?: string;
+    /**
+     * Border radius
+     */
+    borderRadius?: string;
+    /**
+     * Box Shadow style
+     */
+    boxShadow?: string;
+}

package/lib-amd/parameter/ImageFormatState.js

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

package/lib-amd/parameter/ImageFormatState.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ImageFormatState.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/parameter/ImageFormatState.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * Image Format\r\n */\r\nexport interface ImageFormatState {\r\n    /**\r\n     * Border color\r\n     */\r\n    borderColor?: string;\r\n    /**\r\n     * Border width\r\n     */\r\n    borderWidth?: string;\r\n    /**\r\n     * Border style\r\n     */\r\n    borderStyle?: string;\r\n\r\n    /**\r\n     * Border radius\r\n     */\r\n    borderRadius?: string;\r\n\r\n    /**\r\n     * Box Shadow style\r\n     */\r\n    boxShadow?: string;\r\n}\r\n"]}

package/lib-amd/parameter/InsertEntityOptions.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Options for insertEntity API
+ */
+export interface InsertEntityOptions {
+    /**
+     * Content node of the entity. If not passed, an empty entity will be created
+     */
+    contentNode?: Node;
+    /**
+     * Whether move focus after entity after insert
+     */
+    focusAfterEntity?: boolean;
+    /**
+     * "Display" value of the entity wrapper. By default, block entity will have no display, inline entity will have display: inline-block
+     */
+    wrapperDisplay?: 'inline' | 'block' | 'none' | 'inline-block';
+    /**
+     * Whether skip adding an undo snapshot around
+     */
+    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;
+}

package/lib-amd/parameter/InsertEntityOptions.js

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

package/lib-amd/parameter/InsertEntityOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InsertEntityOptions.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-types/lib/parameter/InsertEntityOptions.ts"],"names":[],"mappings":"","sourcesContent":["/**\r\n * Options for insertEntity API\r\n */\r\nexport interface InsertEntityOptions {\r\n    /**\r\n     * Content node of the entity. If not passed, an empty entity will be created\r\n     */\r\n    contentNode?: Node;\r\n\r\n    /**\r\n     * Whether move focus after entity after insert\r\n     */\r\n    focusAfterEntity?: boolean;\r\n\r\n    /**\r\n     * \"Display\" value of the entity wrapper. By default, block entity will have no display, inline entity will have display: inline-block\r\n     */\r\n    wrapperDisplay?: 'inline' | 'block' | 'none' | 'inline-block';\r\n\r\n    /**\r\n     * Whether skip adding an undo snapshot around\r\n     */\r\n    skipUndoSnapshot?: boolean;\r\n\r\n    /**\r\n     * 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\r\n     */\r\n    initialEntityState?: string;\r\n}\r\n"]}

package/lib-amd/parameter/Rect.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This represents a rect inside editor
+ */
+export interface Rect {
+    /**
+     * Top
+     */
+    top: number;
+    /**
+     * Bottom
+     */
+    bottom: number;
+    /**
+     * Left
+     */
+    left: number;
+    /**
+     * Right
+     */
+    right: number;
+}

package/lib-amd/parameter/Rect.js

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