@ckeditor/ckeditor5-ai 48.5.0-alpha.6 → 48.5.0

package/dist/aisdk/documentcompare.d.ts

@@ -24,10 +24,10 @@ import { type DocumentCompareSnapshot } from "./documentsnapshot.js";
 * and applies granular changes:
 *
 * ```ts
-* await documentCompare.process( async data => callMyService( data ) );
+* await documentCompare.process( async snapshot => callMyService( snapshot.content ) );
 *
 * // Or, to apply changes as suggestions:
-* await documentCompare.process( async data => callMyService( data ), { asSuggestions: true } );
+* await documentCompare.process( async snapshot => callMyService( snapshot.content ), { asSuggestions: true } );
 * ```
 *
 * Some integrations need to process the data in separate steps (e.g. backend processing, or when changes
@@ -104,7 +104,7 @@ export declare class DocumentCompare extends Plugin {
 	* external processing (e.g. an AI service), then diffs returned data and applies granular changes to the document.
 	*
 	* If diffing or applying fails, the underlying error is rethrown and can be further handled,
-	* unless `options.setDataOnError` is set, in which case the current document is instead
+	* unless `options.overwriteOnError` is set, in which case the current document is instead
 	* fully replaced with the processed data, the same way as if `editor.setData()` was used.
 	* In this case, changes that happened to the document after the snapshot was taken will be overwritten.
 	*
@@ -113,7 +113,7 @@ export declare class DocumentCompare extends Plugin {
 	* @returns `true` when the process finished successfully and changes were applied granularly,
 	* `false` when the full-replacement fallback was used.
 	*/
-	process(callback: (snapshot: DocumentCompareSnapshot) => Promise<Record<string, string>>, options?: DocumentCompareProcessOptions): Promise<boolean>;
+	process(callback: (snapshot: DocumentCompareSnapshot) => Promise<string | Record<string, string>>, options?: DocumentCompareProcessOptions): Promise<boolean>;
 }
 /**
 * Describes how a comparison is computed and, once recorded on a {@link ~DocumentComparePatch patch}, how it is applied.
@@ -139,7 +139,7 @@ export interface DocumentCompareProcessOptions extends DocumentCompareDiffOption
 	* Note, that the overwrite is also performed in real-time collaboration environment, and it may roll back some edits made by remote
 	* users while `callback` was processing. Opt in only when overwriting the whole document is acceptable.
 	*/
-	setDataOnError?: boolean;
+	overwriteOnError?: boolean;
 }
 /**
 * The result of comparing a snapshot against processed data: the operations to bring the document to the new state,