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

package/dist/augmentation.d.ts

@@ -1,23 +1,23 @@
 /**
- * @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 { ImportWordConfig, ImportWord, ImportWordEditing, ImportWordUI, ImportWordCommand } from './index.js';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the {@link module:import-word/importword~ImportWord import from Word feature}.
-         *
-         * Read more in {@link module:import-word/importword~ImportWordConfig}.
-         */
-        importWord?: ImportWordConfig;
-    }
-    interface PluginsMap {
-        [ImportWord.pluginName]: ImportWord;
-        [ImportWordEditing.pluginName]: ImportWordEditing;
-        [ImportWordUI.pluginName]: ImportWordUI;
-    }
-    interface CommandsMap {
-        importWord: ImportWordCommand;
-    }
+* @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 { ImportWordConfig, ImportWord, ImportWordEditing, ImportWordUI, ImportWordCommand } from "./index.js";
+declare module "@ckeditor/ckeditor5-core" {
+	interface EditorConfig {
+		/**
+		* The configuration of the {@link module:import-word/importword~ImportWord import from Word feature}.
+		*
+		* Read more in {@link module:import-word/importword~ImportWordConfig}.
+		*/
+		importWord?: ImportWordConfig;
+	}
+	interface PluginsMap {
+		[ImportWord.pluginName]: ImportWord;
+		[ImportWordEditing.pluginName]: ImportWordEditing;
+		[ImportWordUI.pluginName]: ImportWordUI;
+	}
+	interface CommandsMap {
+		importWord: ImportWordCommand;
+	}
 }

package/dist/importword.d.ts

@@ -1,132 +1,132 @@
 /**
- * @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 import-word/importword
- * @publicApi
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import type { TokenUrl } from '@ckeditor/ckeditor5-cloud-services';
-import { ImportWordUI } from './importwordui.js';
-import { ImportWordEditing } from './importwordediting.js';
+* @module import-word/importword
+* @publicApi
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import type { TokenUrl } from "@ckeditor/ckeditor5-cloud-services";
+import { ImportWordUI } from "./importwordui.js";
+import { ImportWordEditing } from "./importwordediting.js";
 /**
- * The import from Word feature.
- *
- * It allows importing content from a Word file directly into CKEditor 5.
- *
- * This is a "glue" plugin which enables:
- *
- * * {@link module:import-word/importwordediting~ImportWordEditing},
- * * {@link module:import-word/importwordui~ImportWordUI},
- *
- * For a detailed overview, check the {@glink features/converters/import-word/import-word import from Word} feature documentation.
- */
+* The import from Word feature.
+*
+* It allows importing content from a Word file directly into CKEditor 5.
+*
+* This is a "glue" plugin which enables:
+*
+* * {@link module:import-word/importwordediting~ImportWordEditing},
+* * {@link module:import-word/importwordui~ImportWordUI},
+*
+* For a detailed overview, check the {@glink features/converters/import-word/import-word import from Word} feature documentation.
+*/
 export declare class ImportWord extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImportWord";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImportWordEditing, typeof ImportWordUI];
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ImportWord";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[ImportWordEditing, ImportWordUI]>;
 }
 /**
- * The configuration of the {@link module:import-word/importword~ImportWord import from Word feature}.
- *
- * The configuration for the import from Word feature requires providing the
- * {@link module:import-word/importword~ImportWordConfig#tokenUrl `config.importWord.tokenUrl`}:
- *
- * ```ts
- * ClassicEditor
- * 	.create( {
- * 		importWord: {
- * 			tokenUrl: 'https://example.com/cs-token-endpoint'
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
+* The configuration of the {@link module:import-word/importword~ImportWord import from Word feature}.
+*
+* The configuration for the import from Word feature requires providing the
+* {@link module:import-word/importword~ImportWordConfig#tokenUrl `config.importWord.tokenUrl`}:
+*
+* ```ts
+* ClassicEditor
+* 	.create( {
+* 		importWord: {
+* 			tokenUrl: 'https://example.com/cs-token-endpoint'
+* 		}
+* 	} )
+* 	.then( ... )
+* 	.catch( ... );
+* ```
+*
+* See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+*/
 export interface ImportWordConfig {
-    /**
-     * A URL to the Docx converter.
-     *
-     * ```ts
-     * const importWordConfig = {
-     * 	converterUrl: 'https://myconverter.com/v1/'
-     * }
-     * ```
-     *
-     * **Note:** The plugin uses the default Word to HTML converter delivered by CKEditor Cloud Services.
-     * You can provide a URL to an on-premises converter instead.
-     *
-     * @default 'https://docx-converter.cke-cs.com/v2/convert/docx-html'
-     */
-    converterUrl?: string;
-    /**
-     * A token URL or a token request function. This field is optional and should be used only when a different `tokenUrl`
-     * is required for the Import from Word feature.
-     *
-     * **Note:** The token can be disabled with the `false` value provided.
-     *
-     * See: {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl}
-     */
-    tokenUrl?: TokenUrl;
-    formatting: ImportWordFormattingOptions;
+	/**
+	* A URL to the Docx converter.
+	*
+	* ```ts
+	* const importWordConfig = {
+	* 	converterUrl: 'https://myconverter.com/v1/'
+	* }
+	* ```
+	*
+	* **Note:** The plugin uses the default Word to HTML converter delivered by CKEditor Cloud Services.
+	* You can provide a URL to an on-premises converter instead.
+	*
+	* @default 'https://docx-converter.cke-cs.com/v2/convert/docx-html'
+	*/
+	converterUrl?: string;
+	/**
+	* A token URL or a token request function. This field is optional and should be used only when a different `tokenUrl`
+	* is required for the Import from Word feature.
+	*
+	* **Note:** The token can be disabled with the `false` value provided.
+	*
+	* See: {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl}
+	*/
+	tokenUrl?: TokenUrl;
+	formatting: ImportWordFormattingOptions;
 }
 export interface ImportWordFormattingOptions {
-    /**
-     * Controls whether the additional formatting dedicated to minimizing differences between default Word styles
-     * and default HTML formatting should be included in the generated document.
-     *
-     * If `inline`, the converter service preserves the formatting to be consistent with Word ones.
-     * For example, in Word headings are not bold by default, whereas in HTML, they are. Enabling this option
-     * appends font-weight: normal to all headings.
-     *
-     * @default false
-     */
-    resets?: 'none' | 'inline';
-    /**
-     * Controls whether formatting set by default (like the default font size or default font family)
-     * should be included in the generated document.
-     *
-     * If `inline`, the converter service preserves the default formatting of the imported Word document.
-     *
-     * @default 'none'
-     */
-    defaults?: 'none' | 'inline';
-    /**
-     * Controls whether Word styles should be included in the generated document.
-     *
-     * If `inline`, the converter service preserves the default styles of the imported Word document.
-     *
-     * @default 'inline'
-     */
-    styles?: 'none' | 'inline';
-    /**
-     * Defines which formatting styles should be kept for the imported comments text.
-     *
-     * Possible values are:
-     *
-     * * `'basic'` - basic styles are kept (bold, italic, underline, strikethrough and links),
-     * * `'none'` - comment text is imported without any styling,
-     * * `'full'` - all styles are kept (not recommended).
-     *
-     * **Note:** Please remember that importing comments requires installing the {@link module:comments/comments~Comments} feature.
-     *
-     * @default 'basic'
-     */
-    comments?: 'basic' | 'none' | 'full';
+	/**
+	* Controls whether the additional formatting dedicated to minimizing differences between default Word styles
+	* and default HTML formatting should be included in the generated document.
+	*
+	* If `inline`, the converter service preserves the formatting to be consistent with Word ones.
+	* For example, in Word headings are not bold by default, whereas in HTML, they are. Enabling this option
+	* appends font-weight: normal to all headings.
+	*
+	* @default false
+	*/
+	resets?: "none" | "inline";
+	/**
+	* Controls whether formatting set by default (like the default font size or default font family)
+	* should be included in the generated document.
+	*
+	* If `inline`, the converter service preserves the default formatting of the imported Word document.
+	*
+	* @default 'none'
+	*/
+	defaults?: "none" | "inline";
+	/**
+	* Controls whether Word styles should be included in the generated document.
+	*
+	* If `inline`, the converter service preserves the default styles of the imported Word document.
+	*
+	* @default 'inline'
+	*/
+	styles?: "none" | "inline";
+	/**
+	* Defines which formatting styles should be kept for the imported comments text.
+	*
+	* Possible values are:
+	*
+	* * `'basic'` - basic styles are kept (bold, italic, underline, strikethrough and links),
+	* * `'none'` - comment text is imported without any styling,
+	* * `'full'` - all styles are kept (not recommended).
+	*
+	* **Note:** Please remember that importing comments requires installing the {@link module:comments/comments~Comments} feature.
+	*
+	* @default 'basic'
+	*/
+	comments?: "basic" | "none" | "full";
 }

package/dist/importwordcommand.d.ts

@@ -1,99 +1,99 @@
 /**
- * @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 import-word/importwordcommand
- * @publicApi
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
-import { type Batch } from '@ckeditor/ckeditor5-engine';
+* @module import-word/importwordcommand
+* @publicApi
+*/
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
+import { type Batch } from "@ckeditor/ckeditor5-engine";
 /**
- * The import from Word command.
- *
- * It sends the Word file to the converter endpoint and inserts its content into the editor.
- */
+* The import from Word command.
+*
+* It sends the Word file to the converter endpoint and inserts its content into the editor.
+*/
 export declare class ImportWordCommand extends Command {
-    /**
-     * A command state that indicates if the command is currently executing.
-     *
-     * @observable
-     */
-    isBusy: boolean;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command. Sends the provided file instance to the converter service endpoint and inserts the result into the model.
-     *
-     * @fires execute
-     * @param file The Word file instance to be uploaded for conversion.
-     * @param [serviceConfig] Additional options to pass to the converter service.
-     */
-    execute(file: File, serviceConfig?: Record<string, unknown>): Promise<unknown>;
+	/**
+	* A command state that indicates if the command is currently executing.
+	*
+	* @observable
+	*/
+	isBusy: boolean;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	override refresh(): void;
+	/**
+	* Executes the command. Sends the provided file instance to the converter service endpoint and inserts the result into the model.
+	*
+	* @fires execute
+	* @param file The Word file instance to be uploaded for conversion.
+	* @param [serviceConfig] Additional options to pass to the converter service.
+	*/
+	override execute(file: File, serviceConfig?: Record<string, unknown>): Promise<unknown>;
 }
 /**
- * Fired when the converter service returned the HTML content that will be inserted into the editor.
- *
- * @eventName ~ImportWordCommand#dataInsert
- */
+* Fired when the converter service returned the HTML content that will be inserted into the editor.
+*
+* @eventName ~ImportWordCommand#dataInsert
+*/
 export type ImportWordDataInsertEvent = {
-    name: 'dataInsert';
-    args: [data: ImportWordDataInsertEventData];
+	name: "dataInsert";
+	args: [data: ImportWordDataInsertEventData];
 };
 export interface ImportWordDataInsertEventData {
-    /**
-     * The batch used to undo all changes made by the command. Each time the command is executed, a new batch is created.
-     * Use it when some additional changes should be added to the document as part of the same undo step.
-     */
-    readonly undoStepBatch: Batch;
-    /**
-     * The HTML content to insertion.
-     */
-    html: string;
-    /**
-     * The headers definitions extracted from the Word document.
-     * Contains HTML content for different types of headers (default, first page, odd/even pages).
-     */
-    headers?: ImportWordDataHeaderFooterDefinitions;
-    /**
-     * The footers definitions extracted from the Word document.
-     * Contains HTML content for different types of footers (default, first page, odd/even pages).
-     */
-    footers?: ImportWordDataHeaderFooterDefinitions;
+	/**
+	* The batch used to undo all changes made by the command. Each time the command is executed, a new batch is created.
+	* Use it when some additional changes should be added to the document as part of the same undo step.
+	*/
+	readonly undoStepBatch: Batch;
+	/**
+	* The HTML content to insertion.
+	*/
+	html: string;
+	/**
+	* The headers definitions extracted from the Word document.
+	* Contains HTML content for different types of headers (default, first page, odd/even pages).
+	*/
+	headers?: ImportWordDataHeaderFooterDefinitions;
+	/**
+	* The footers definitions extracted from the Word document.
+	* Contains HTML content for different types of footers (default, first page, odd/even pages).
+	*/
+	footers?: ImportWordDataHeaderFooterDefinitions;
 }
 /**
- * Represents a collection of header or footer definitions corresponding to different page types.
- */
+* Represents a collection of header or footer definitions corresponding to different page types.
+*/
 export interface ImportWordDataHeaderFooterDefinitions {
-    /**
-     * Content for the default header/footer. Used for all pages unless specific overrides (first/odd/even) apply.
-     */
-    default?: ImportWordDataHeaderFooterContent;
-    /**
-     * Content for the first page header/footer.
-     */
-    first?: ImportWordDataHeaderFooterContent;
-    /**
-     * Content for the odd pages header/footer.
-     */
-    odd?: ImportWordDataHeaderFooterContent;
-    /**
-     * Content for the even pages header/footer.
-     */
-    even?: ImportWordDataHeaderFooterContent;
+	/**
+	* Content for the default header/footer. Used for all pages unless specific overrides (first/odd/even) apply.
+	*/
+	default?: ImportWordDataHeaderFooterContent;
+	/**
+	* Content for the first page header/footer.
+	*/
+	first?: ImportWordDataHeaderFooterContent;
+	/**
+	* Content for the odd pages header/footer.
+	*/
+	odd?: ImportWordDataHeaderFooterContent;
+	/**
+	* Content for the even pages header/footer.
+	*/
+	even?: ImportWordDataHeaderFooterContent;
 }
 /**
- * Represents the content of a single header or footer variant.
- */
+* Represents the content of a single header or footer variant.
+*/
 export interface ImportWordDataHeaderFooterContent {
-    /**
-     * The HTML content of the header or footer.
-     */
-    html: string;
+	/**
+	* The HTML content of the header or footer.
+	*/
+	html: string;
 }

package/dist/importwordediting.d.ts

@@ -1,43 +1,43 @@
 /**
- * @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 import-word/importwordediting
- * @publicApi
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { Notification } from '@ckeditor/ckeditor5-ui';
-import { ClipboardPipeline } from '@ckeditor/ckeditor5-clipboard';
-import { CloudServices, type InitializedToken } from '@ckeditor/ckeditor5-cloud-services';
+* @module import-word/importwordediting
+* @publicApi
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { Notification } from "@ckeditor/ckeditor5-ui";
+import { ClipboardPipeline } from "@ckeditor/ckeditor5-clipboard";
+import { CloudServices, type InitializedToken } from "@ckeditor/ckeditor5-cloud-services";
 /**
- * The editing part of the import from Word feature.
- *
- * It registers the {@link module:import-word/importwordcommand~ImportWordCommand `'importWord'` command}.
- */
+* The editing part of the import from Word feature.
+*
+* It registers the {@link module:import-word/importwordcommand~ImportWordCommand `'importWord'` command}.
+*/
 export declare class ImportWordEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImportWordEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Notification, typeof ClipboardPipeline, typeof CloudServices];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Returns a token used by the import from Word plugin for communication with the Cloud Services.
-     */
-    getToken(): Promise<InitializedToken | null>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ImportWordEditing";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[Notification, ClipboardPipeline, CloudServices]>;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Returns a token used by the import from Word plugin for communication with the Cloud Services.
+	*/
+	getToken(): Promise<InitializedToken | null>;
 }

package/dist/importwordui.d.ts

@@ -1,30 +1,30 @@
 /**
- * @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 import-word/importwordui
- * @publicApi
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
+* @module import-word/importwordui
+* @publicApi
+*/
+import { Plugin } from "@ckeditor/ckeditor5-core";
 /**
- * The ImportWordUI plugin. It introduces the `'importWord'` toolbar button.
- */
+* The ImportWordUI plugin. It introduces the `'importWord'` toolbar button.
+*/
 export declare class ImportWordUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImportWordUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ImportWordUI";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static override get isPremiumPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
 }

package/dist/index.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 import-word
- */
-export { ImportWord, type ImportWordConfig, type ImportWordFormattingOptions } from './importword.js';
-export { ImportWordEditing } from './importwordediting.js';
-export { ImportWordUI } from './importwordui.js';
-export { ImportWordCommand, type ImportWordDataInsertEvent, type ImportWordDataInsertEventData, type ImportWordDataHeaderFooterDefinitions, type ImportWordDataHeaderFooterContent } from './importwordcommand.js';
-import './augmentation.js';
+* @module import-word
+*/
+export { ImportWord, type ImportWordConfig, type ImportWordFormattingOptions } from "./importword.js";
+export { ImportWordEditing } from "./importwordediting.js";
+export { ImportWordUI } from "./importwordui.js";
+export { ImportWordCommand, type ImportWordDataInsertEvent, type ImportWordDataInsertEventData, type ImportWordDataHeaderFooterDefinitions, type ImportWordDataHeaderFooterContent } from "./importwordcommand.js";
+import "./augmentation.js";