@ckeditor/ckeditor5-ai 48.2.0-alpha.7 → 48.3.0-alpha.0

package/dist/aicore/utils/buttonclasses.d.ts

@@ -1,12 +1,12 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module ai/aicore/utils/buttonclasses
- */
+* @module ai/aicore/utils/buttonclasses
+*/
 export declare const AI_BUTTON_CLASSES: {
-    readonly PRIMARY: "ck-ai-button-primary";
-    readonly SECONDARY: "ck-ai-button-secondary";
-    readonly TERTIARY: "ck-ai-button-tertiary";
+	readonly PRIMARY: "ck-ai-button-primary";
+	readonly SECONDARY: "ck-ai-button-secondary";
+	readonly TERTIARY: "ck-ai-button-tertiary";
 };

package/dist/aicore/utils/cleanupstreamingartifacts.d.ts

@@ -0,0 +1,12 @@
+/**
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+/**
+* @module ai/aicore/utils/cleanupstreamingartifacts
+*/
+import { type HTMLStreamer } from "./htmlstreamer.js";
+/**
+* Removes streaming artifacts left by {@link HTMLStreamer}: animation `<span>` wrappers and `data-id` attributes.
+*/
+export declare function cleanUpStreamingArtifacts(htmlStreamer: HTMLStreamer, targetElement: HTMLElement): void;

package/dist/aicore/utils/common-translations.d.ts

@@ -1,9 +1,9 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module ai/aicore/utils/common-translations
- */
-import type { Locale } from '@ckeditor/ckeditor5-utils';
+* @module ai/aicore/utils/common-translations
+*/
+import type { Locale } from "@ckeditor/ckeditor5-utils";
 export declare function getTranslation(locale: Locale, id: string, values?: string | number | Array<string | number>): string;

package/dist/aicore/utils/createandattachaibodycollection.d.ts

@@ -0,0 +1,19 @@
+/**
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+/**
+* @module ai/aicore/utils/createandattachaibodycollection
+*/
+import type { Locale } from "@ckeditor/ckeditor5-utils";
+import { BodyCollection } from "@ckeditor/ckeditor5-ui";
+import "../../../theme/common/aibody.css";
+/**
+* Creates a body collection dedicated to the AI features UI and attaches it to the DOM.
+*
+* The collection container is tagged with the `ck-ai-body` CSS class, which raises all balloon panels
+* rendered inside it above the AI overlay backdrop (see `--ck-ai-tabs-overlay-z-index`). Thanks to this,
+* any balloon added to the collection (including future ones) is displayed correctly when the AI UI
+* works in the overlay mode, without per-balloon CSS overrides.
+*/
+export declare function createAndAttachAIBodyCollection(locale: Locale): BodyCollection;

package/dist/aicore/utils/createresizebutton.d.ts

@@ -1,13 +1,13 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module ai/aicore/utils/createresizebutton
- */
-import type { Locale } from '@ckeditor/ckeditor5-utils';
-import { ButtonView, type View } from '@ckeditor/ckeditor5-ui';
-import '../../../theme/aitabs/aitabsresizebutton.css';
+* @module ai/aicore/utils/createresizebutton
+*/
+import type { Locale } from "@ckeditor/ckeditor5-utils";
+import { ButtonView, type View } from "@ckeditor/ckeditor5-ui";
+import "../../../theme/aitabs/aitabsresizebutton.css";
 export declare function createResizeButton<T extends View & {
-    isMaximized: boolean;
+	isMaximized: boolean;
 }>(locale: Locale, view: T): ButtonView;

package/dist/aicore/utils/createstartconversationbutton.d.ts

@@ -1,11 +1,11 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module ai/aicore/utils/createstartconversationbutton
- */
-import type { Locale } from '@ckeditor/ckeditor5-utils';
-import { ButtonView, type View } from '@ckeditor/ckeditor5-ui';
-import '../../../theme/common/aiheader.css';
+* @module ai/aicore/utils/createstartconversationbutton
+*/
+import type { Locale } from "@ckeditor/ckeditor5-utils";
+import { ButtonView, type View } from "@ckeditor/ckeditor5-ui";
+import "../../../theme/common/aiheader.css";
 export declare function createStartConversationButton<T extends View>(locale: Locale, view: T): ButtonView;

package/dist/aicore/utils/documentposition.d.ts

@@ -1,41 +1,41 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { type AnyNode, type Document, type DocumentPath } from './htmlparser.js';
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+import { type AnyNode, type Document, type DocumentPath } from "./htmlparser.js";
 /**
- * Represents a position in htmlparser's Document.
- *
- * * When the parent of the position is not a `Text`, the index represents the index of a child.
- * * When the parent of the positions is a `Text`, the index represents a character in that text node.
- */
+* Represents a position in htmlparser's Document.
+*
+* * When the parent of the position is not a `Text`, the index represents the index of a child.
+* * When the parent of the positions is a `Text`, the index represents a character in that text node.
+*/
 export declare class DocumentPosition {
-    readonly parent: AnyNode;
-    readonly index: number;
-    readonly document: Document;
-    constructor(document: Document, parent: AnyNode, index: number);
-    get path(): DocumentPath;
-    isEqual(otherPosition: DocumentPosition): boolean;
-    /**
-     * Returns the next node in the document. It traverses both horizontally and vertically (like a walker).
-     */
-    get nextNode(): AnyNode | null;
-    /**
-     * Returns the previous node in the document. It traverses both horizontally and vertically (like a walker).
-     */
-    get previousNode(): AnyNode | null;
-    /**
-     * Returns a position nudged to the word boundary so that the position does not split a word.
-     *
-     * For instance:
-     * * "fo^o bar baz" nudged to "start" will return "^foo bar baz",
-     * * "fo^o bar baz" nudged to "end" will return "foo ^bar baz",
-     * * "^foo bar baz" nudged any way will return "^foo bar baz",
-     * * "foo ^bar baz" nudged any way will return "foo ^bar baz",
-     */
-    getNudgedToWordBoundary(gravity?: 'start' | 'end'): DocumentPosition;
-    static createAfter(document: Document, node: AnyNode): DocumentPosition | null;
-    static createBefore(document: Document, node: AnyNode): DocumentPosition | null;
-    static createAt(document: Document, node: AnyNode, where?: 'start' | 'end' | number): DocumentPosition;
-    static createFromPath(document: Document, path: DocumentPath): DocumentPosition;
+	readonly parent: AnyNode;
+	readonly index: number;
+	readonly document: Document;
+	constructor(document: Document, parent: AnyNode, index: number);
+	get path(): DocumentPath;
+	isEqual(otherPosition: DocumentPosition): boolean;
+	/**
+	* Returns the next node in the document. It traverses both horizontally and vertically (like a walker).
+	*/
+	get nextNode(): AnyNode | null;
+	/**
+	* Returns the previous node in the document. It traverses both horizontally and vertically (like a walker).
+	*/
+	get previousNode(): AnyNode | null;
+	/**
+	* Returns a position nudged to the word boundary so that the position does not split a word.
+	*
+	* For instance:
+	* * "fo^o bar baz" nudged to "start" will return "^foo bar baz",
+	* * "fo^o bar baz" nudged to "end" will return "foo ^bar baz",
+	* * "^foo bar baz" nudged any way will return "^foo bar baz",
+	* * "foo ^bar baz" nudged any way will return "foo ^bar baz",
+	*/
+	getNudgedToWordBoundary(gravity?: "start" | "end"): DocumentPosition;
+	static createAfter(document: Document, node: AnyNode): DocumentPosition | null;
+	static createBefore(document: Document, node: AnyNode): DocumentPosition | null;
+	static createAt(document: Document, node: AnyNode, where?: "start" | "end" | number): DocumentPosition;
+	static createFromPath(document: Document, path: DocumentPath): DocumentPosition;
 }

package/dist/aicore/utils/documentrange.d.ts

@@ -1,46 +1,46 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module ai/aicore/utils/documentrange
- */
-import { DocumentPosition } from './documentposition.js';
-import { Document } from './htmlparser.js';
+* @module ai/aicore/utils/documentrange
+*/
+import { DocumentPosition } from "./documentposition.js";
+import { Document } from "./htmlparser.js";
 /**
- * Represents a range in a htmlparser's Document limited by two
- * {@link module:ai/aicore/utils/documentposition~DocumentPosition} instances.
- */
+* Represents a range in a htmlparser's Document limited by two
+* {@link module:ai/aicore/utils/documentposition~DocumentPosition} instances.
+*/
 export declare class DocumentRange {
-    readonly start: DocumentPosition;
-    readonly end: DocumentPosition;
-    constructor(start: DocumentPosition, end: DocumentPosition);
-    isEqual(otherRange: DocumentRange): boolean;
-    /**
-     * Nudges {@link #start} and {@link #end} positions to the word boundary so that the range does not split
-     * a word.
-     *
-     * See {@link module:ai/aicore/utils/documentposition~DocumentPosition#getNudgedToWordBoundary} for more details.
-     */
-    getNudgedToWordBoundary(): DocumentRange;
-    /**
-     * Returns a document with the content of this range. The content is extracted from the original document,
-     * preserving the original structure.
-     *
-     * For instance, for the following document and range:
-     *
-     * ```html
-     * <p>fo[o</p>
-     * <p>bar <b>ba]z</b></p>
-     * <p>qux</p>
-     * ```
-     *
-     * the resulting document will be
-     *
-     * ```html
-     * <p>o</p>
-     * <p>bar <b>ba</b></p>
-     * ```
-     */
-    getContent(): Document;
+	readonly start: DocumentPosition;
+	readonly end: DocumentPosition;
+	constructor(start: DocumentPosition, end: DocumentPosition);
+	isEqual(otherRange: DocumentRange): boolean;
+	/**
+	* Nudges {@link #start} and {@link #end} positions to the word boundary so that the range does not split
+	* a word.
+	*
+	* See {@link module:ai/aicore/utils/documentposition~DocumentPosition#getNudgedToWordBoundary} for more details.
+	*/
+	getNudgedToWordBoundary(): DocumentRange;
+	/**
+	* Returns a document with the content of this range. The content is extracted from the original document,
+	* preserving the original structure.
+	*
+	* For instance, for the following document and range:
+	*
+	* ```html
+	* <p>fo[o</p>
+	* <p>bar <b>ba]z</b></p>
+	* <p>qux</p>
+	* ```
+	*
+	* the resulting document will be
+	*
+	* ```html
+	* <p>o</p>
+	* <p>bar <b>ba</b></p>
+	* ```
+	*/
+	getContent(): Document;
 }

package/dist/aicore/utils/eventnames.d.ts

@@ -1,8 +1,8 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module ai/aicore/utils/eventnames
- */
+* @module ai/aicore/utils/eventnames
+*/
 export declare const AI_SUGGESTION_UI_EVENT_NAMES: readonly ["showChangeInText", "insertSuggestion", "applySuggestion", "rejectSuggestion", "mouseOverSuggestion", "mouseLeaveSuggestion", "toggleSuggestionDisplayMode", "like", "dislike"];

package/dist/aicore/utils/geteditorsfromcontext.d.ts

@@ -1,18 +1,18 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { type ContextInterface, Editor } from '@ckeditor/ckeditor5-core';
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+import { type ContextInterface, Editor } from "@ckeditor/ckeditor5-core";
 /**
- * Returns all editor instances registered on the context. For a single editor passed as `context`, returns `[ context ]`.
- * Returns an empty array when the context has no editors yet.
- */
+* Returns all editor instances registered on the context. For a single editor passed as `context`, returns `[ context ]`.
+* Returns an empty array when the context has no editors yet.
+*/
 export declare function getEditorsFromContext(context: ContextInterface | null | undefined): Array<Editor>;
 /**
- * Returns the editor that should drive user-driven AI operations when several editors share a {@link module:core/context~Context Context}:
- * the one with UI focus if any, otherwise the last editor that had UI focus (tracked by {@link module:ai/aicore/aiediting~AIEditing}),
- * otherwise the first editor in registration order.
- *
- * For a single editor passed as `context`, returns that editor.
- */
+* Returns the editor that should drive user-driven AI operations when several editors share a {@link module:core/context~Context Context}:
+* the one with UI focus if any, otherwise the last editor that had UI focus (tracked by {@link module:ai/aicore/aiediting~AIEditing}),
+* otherwise the first editor in registration order.
+*
+* For a single editor passed as `context`, returns that editor.
+*/
 export declare function getFocusedEditorFromContext(context: ContextInterface): Editor;

package/dist/aicore/utils/getoperationsfordocumentsuggestions.d.ts

@@ -0,0 +1,22 @@
+/**
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+/**
+* @module ai/aicore/utils/getoperationsfordocumentsuggestions
+*/
+import { type DocumentCompare, type DocumentCompareOptions } from "@ckeditor/ckeditor5-collaboration-core";
+import { type Operation } from "@ckeditor/ckeditor5-engine";
+import { type Editor } from "@ckeditor/ckeditor5-core";
+import type { DocumentSuggestions } from "./builddocumentsuggestionsmap.js";
+/**
+* Returns operations that need to be applied to the editor documents to apply the AI reply.
+* The result is a `Map` keyed by `documentId`, each entry holding the operations for that document.
+*/
+export declare function getOperationsForDocumentSuggestions({ documentSuggestions, transform, documentCompare, documentCompareOptions }: {
+	documentSuggestions: Map<string, DocumentSuggestions>;
+	transform: boolean;
+	documentCompare: DocumentCompare;
+	documentCompareOptions: DocumentCompareOptions;
+}): Map<string, Array<Operation>>;
+export declare function fixMarkerOperationOldRange(editor: Editor, operation: Operation): void;

package/dist/aicore/utils/getsuggestionpartsfromreply.d.ts

@@ -1,26 +1,26 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module ai/aicore/utils/getsuggestionpartsfromreply
- */
-import { type Editor } from '@ckeditor/ckeditor5-core';
-import { Document } from './htmlparser.js';
-import { type AIReplyChangeGroup } from '../model/aireply.js';
+* @module ai/aicore/utils/getsuggestionpartsfromreply
+*/
+import { type Editor } from "@ckeditor/ckeditor5-core";
+import { Document } from "./htmlparser.js";
+import { type AIReplyChangeGroup } from "../model/aireply.js";
 export declare function getSuggestionPartsFromReply({ changeGroups, documentContextContent, showDiff, trimUnchanged }: {
-    showDiff: boolean;
-    changeGroups: Array<AIReplyChangeGroup>;
-    documentContextContent: Map<string, Document>;
-    trimUnchanged?: boolean;
+	showDiff: boolean;
+	changeGroups: Array<AIReplyChangeGroup>;
+	documentContextContent: Map<string, Document>;
+	trimUnchanged?: boolean;
 }): Array<AISuggestionContentPartDefinition>;
 export declare function passThroughEditorDataPipeline(editor: Editor, before: Document, after: Document, showDiff: boolean, trimUnchanged?: boolean): {
-    content: Document;
-    hasChanges: boolean;
+	content: Document;
+	hasChanges: boolean;
 };
 export type AISuggestionContentPartDefinition = {
-    type: 'modified' | 'new' | 'removed' | 'context';
-    index: number;
-    content: Document;
-    hasChanges: boolean;
+	type: "modified" | "new" | "removed" | "context";
+	index: number;
+	content: Document;
+	hasChanges: boolean;
 };

package/dist/aicore/utils/htmlparser.d.ts

@@ -1,14 +1,14 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module ai/aicore/utils/htmlparser
- */
-import { parseDocument } from 'htmlparser2';
-import { append, appendChild, find, findAll, findOne, getChildren, isComment, isTag, prepend, prependChild, removeElement, replaceElement, textContent, getParent, hasChildren } from 'domutils';
-import render from 'dom-serializer';
-import { cloneNode, isDocument, isText, Element, Text, type AnyNode, type ChildNode, type Comment, Document, NodeWithChildren, type ParentNode } from 'domhandler';
+* @module ai/aicore/utils/htmlparser
+*/
+import { parseDocument } from "htmlparser2";
+import { append, appendChild, find, findAll, findOne, getChildren, isComment, isTag, prepend, prependChild, removeElement, replaceElement, textContent, getParent, hasChildren } from "domutils";
+import render from "dom-serializer";
+import { cloneNode, isDocument, isText, Element, Text, type AnyNode, type ChildNode, type Comment, Document, NodeWithChildren, type ParentNode } from "domhandler";
 export { cloneNode, find, findOne, findAll, getChildren, getParent, isComment, isDocument, isTag, isText, append, appendChild, prepend, prependChild, render, removeElement, replaceElement, textContent, hasChildren, Element, Document, NodeWithChildren, Text };
 export type { AnyNode, ParentNode, ChildNode };
 export declare function parse(html: string, options?: Parameters<typeof parseDocument>[1]): Document;
@@ -30,12 +30,12 @@ export declare function getNodeNestingLevel(node: ChildNode): number;
 export declare function removeElementsAfter(node: ChildNode): void;
 export declare function getNodePath(node: AnyNode): DocumentPath;
 /**
- * Represents a position in the HTML document as an array of numbers.
- *
- * Each number represents either:
- * - An index of an element among its siblings (for element nodes)
- * - A character position within a text node (for text nodes)
- *
- * Example: [0, 1, 2] means the third child of the second child of the first element.
- */
+* Represents a position in the HTML document as an array of numbers.
+*
+* Each number represents either:
+* - An index of an element among its siblings (for element nodes)
+* - A character position within a text node (for text nodes)
+*
+* Example: [0, 1, 2] means the third child of the second child of the first element.
+*/
 export type DocumentPath = ReadonlyArray<number>;

package/dist/aicore/utils/htmlstreamer.d.ts

@@ -1,89 +1,89 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { type Document } from './htmlparser.js';
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+import { type Document } from "./htmlparser.js";
 /**
- * The default animation for text nodes. It is a smooth fade-in animation from 0 to 1 opacity.
- */
+* The default animation for text nodes. It is a smooth fade-in animation from 0 to 1 opacity.
+*/
 export declare const DEFAULT_FADE_IN_ANIMATION = "animation: ck-html-streamer-fade-in .3s";
 /**
- * A class that streams arbitrary HTML content into a target DOM element in an incremental manner.
- *
- * It uses a virtual DOM to avoid flickering of images and other dynamic content.
- */
+* A class that streams arbitrary HTML content into a target DOM element in an incremental manner.
+*
+* It uses a virtual DOM to avoid flickering of images and other dynamic content.
+*/
 export declare class HTMLStreamer {
-    /**
-     * Creates an instance of HTMLStreamer.
-     */
-    constructor(options?: HTMLStreamerOptions);
-    /**
-     * Incrementally streams the HTML string into provided target DOM element.
-     *
-     * **Note**: This method can be called repeatedly with a new document to continue the previous call. The new parsed document
-     * must be an extension of the previous document (only growing, never shrinking).
-     *
-     * ## Basic example
-     *
-     * ```ts
-     * const document = parse( '<p>foo bar</p>' );
-     *
-     * const htmlStreamer = new HTMLStreamer( {
-     * 	targetElement,
-     * 	textNodeStyle: 'animation: my-animation .5s'
-     * } );
-     *
-     * await htmlStreamer.stream( { document } );
-     * ```
-     *
-     * after 10ms will stream:
-     *
-     * ```html
-     * <p></p>
-     * ```
-     *
-     * and after 20ms:
-     *
-     * ```html
-     * <p><span data-ck-html-streamer-word-chunk="" style="animation: my-animation .5s">foo </span></p>
-     * ```
-     *
-     * and after 30ms:
-     *
-     * ```html
-     * <p>
-     * 	<span data-ck-html-streamer-word-chunk="" style="animation: my-animation .5s">foo </span>
-     * 	<span data-ck-html-streamer-word-chunk="" style="animation: my-animation .5s">bar</span>
-     * </p>
-     * ```
-     */
-    stream({ document, targetElement, abortSignal }: {
-        document: Document;
-        targetElement: HTMLElement;
-        abortSignal?: AbortSignal;
-    }): Promise<void>;
-    /**
-     * Resets the HTMLStreamer to its initial state.
-     */
-    reset(): void;
-    /**
-     * Cleans up the animation `<span>` elements from the configured target element with minimum DOM manipulation.
-     */
-    cleanUpAnimations({ targetElement }: {
-        targetElement: HTMLElement;
-    }): void;
+	/**
+	* Creates an instance of HTMLStreamer.
+	*/
+	constructor(options?: HTMLStreamerOptions);
+	/**
+	* Incrementally streams the HTML string into provided target DOM element.
+	*
+	* **Note**: This method can be called repeatedly with a new document to continue the previous call. The new parsed document
+	* must be an extension of the previous document (only growing, never shrinking).
+	*
+	* ## Basic example
+	*
+	* ```ts
+	* const document = parse( '<p>foo bar</p>' );
+	*
+	* const htmlStreamer = new HTMLStreamer( {
+	* 	targetElement,
+	* 	textNodeStyle: 'animation: my-animation .5s'
+	* } );
+	*
+	* await htmlStreamer.stream( { document } );
+	* ```
+	*
+	* after 10ms will stream:
+	*
+	* ```html
+	* <p></p>
+	* ```
+	*
+	* and after 20ms:
+	*
+	* ```html
+	* <p><span data-ck-html-streamer-word-chunk="" style="animation: my-animation .5s">foo </span></p>
+	* ```
+	*
+	* and after 30ms:
+	*
+	* ```html
+	* <p>
+	* 	<span data-ck-html-streamer-word-chunk="" style="animation: my-animation .5s">foo </span>
+	* 	<span data-ck-html-streamer-word-chunk="" style="animation: my-animation .5s">bar</span>
+	* </p>
+	* ```
+	*/
+	stream({ document, targetElement, abortSignal }: {
+		document: Document;
+		targetElement: HTMLElement;
+		abortSignal?: AbortSignal;
+	}): Promise<void>;
+	/**
+	* Resets the HTMLStreamer to its initial state.
+	*/
+	reset(): void;
+	/**
+	* Cleans up the animation `<span>` elements from the configured target element with minimum DOM manipulation.
+	*/
+	cleanUpAnimations({ targetElement }: {
+		targetElement: HTMLElement;
+	}): void;
 }
 /**
- * Options for the HTMLStreamer.
- */
+* Options for the HTMLStreamer.
+*/
 interface HTMLStreamerOptions {
-    /**
-     * Delay between `stream()` updates in milliseconds. Default is 10ms.
-     */
-    delay?: number;
-    /**
-     * The `style` attribute value for `<span>` elements that wrap text nodes.
-     */
-    textNodeStyle?: string;
+	/**
+	* Delay between `stream()` updates in milliseconds. Default is 10ms.
+	*/
+	delay?: number;
+	/**
+	* The `style` attribute value for `<span>` elements that wrap text nodes.
+	*/
+	textNodeStyle?: string;
 }
 export {};