@ckeditor/ckeditor5-export-word 41.3.1 → 41.4.0

package/dist/translations/ur.umd.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+(_0x193353=>{const {ur:{dictionary:_0x5d8854,getPluralForm:_0x47743f}}={'ur':{'dictionary':{'Export\x20to\x20Word':'ورڈ\x20دستاویز\x20برآمد','An\x20error\x20occurred\x20while\x20generating\x20the\x20Word\x20file.':'ورڈ\x20دستاویز\x20بناننے\x20میں\x20نقص\x20واقع\x20ہوا۔','Word\x20document\x20export\x20started':'','Word\x20document\x20export\x20failed':'','Word\x20document\x20export\x20successful':'','Exporting\x20Word\x20document':''},'getPluralForm':_0x18b32e=>0x1!=_0x18b32e}};_0x193353['ur']||={'dictionary':{},'getPluralForm':null},_0x193353['ur']['dictionary']=Object['assign'](_0x193353['ur']['dictionary'],_0x5d8854),_0x193353['ur']['getPluralForm']=_0x47743f;})(window['CKEDITOR_TRANSLATIONS']||={});

package/dist/translations/vi.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+import type { Translations } from 'ckeditor5';
+declare const translations: Translations;
+export default translations;

package/dist/translations/vi.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+export default{'vi':{'dictionary':{'Export\x20to\x20Word':'Xuất\x20ra\x20định\x20dạng\x20Word','An\x20error\x20occurred\x20while\x20generating\x20the\x20Word\x20file.':'Đã\x20xảy\x20ra\x20lỗi\x20khi\x20tạo\x20tệp\x20Word.','Word\x20document\x20export\x20started':'Đã\x20bắt\x20đầu\x20xuất\x20tài\x20liệu\x20Word','Word\x20document\x20export\x20failed':'Không\x20xuất\x20được\x20tài\x20liệu\x20Word','Word\x20document\x20export\x20successful':'Đã\x20xuất\x20tài\x20liệu\x20Word\x20thành\x20công','Exporting\x20Word\x20document':'Đang\x20xuất\x20tài\x20liệu\x20Word'},'getPluralForm':_0x23cc66=>0x0}};

package/dist/translations/vi.umd.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+(_0xee0fc5=>{const {vi:{dictionary:_0x2b33f3,getPluralForm:_0x216f52}}={'vi':{'dictionary':{'Export\x20to\x20Word':'Xuất\x20ra\x20định\x20dạng\x20Word','An\x20error\x20occurred\x20while\x20generating\x20the\x20Word\x20file.':'Đã\x20xảy\x20ra\x20lỗi\x20khi\x20tạo\x20tệp\x20Word.','Word\x20document\x20export\x20started':'Đã\x20bắt\x20đầu\x20xuất\x20tài\x20liệu\x20Word','Word\x20document\x20export\x20failed':'Không\x20xuất\x20được\x20tài\x20liệu\x20Word','Word\x20document\x20export\x20successful':'Đã\x20xuất\x20tài\x20liệu\x20Word\x20thành\x20công','Exporting\x20Word\x20document':'Đang\x20xuất\x20tài\x20liệu\x20Word'},'getPluralForm':_0x1f690f=>0x0}};_0xee0fc5['vi']||={'dictionary':{},'getPluralForm':null},_0xee0fc5['vi']['dictionary']=Object['assign'](_0xee0fc5['vi']['dictionary'],_0x2b33f3),_0xee0fc5['vi']['getPluralForm']=_0x216f52;})(window['CKEDITOR_TRANSLATIONS']||={});

package/dist/translations/zh-cn.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+import type { Translations } from 'ckeditor5';
+declare const translations: Translations;
+export default translations;

package/dist/translations/zh-cn.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+export default{'zh-cn':{'dictionary':{'Export\x20to\x20Word':'导出Word文档','An\x20error\x20occurred\x20while\x20generating\x20the\x20Word\x20file.':'生成Word文档时发生了异常。','Word\x20document\x20export\x20started':'Word\x20文档导出开始','Word\x20document\x20export\x20failed':'Word\x20文档导出失败','Word\x20document\x20export\x20successful':'Word\x20文档导出成功','Exporting\x20Word\x20document':'正在导出\x20Word\x20文档'},'getPluralForm':_0x7e35de=>0x0}};

package/dist/translations/zh-cn.umd.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+(_0x39c45a=>{const {'zh-cn':{dictionary:_0x350140,getPluralForm:_0x4c86d1}}={'zh-cn':{'dictionary':{'Export\x20to\x20Word':'导出Word文档','An\x20error\x20occurred\x20while\x20generating\x20the\x20Word\x20file.':'生成Word文档时发生了异常。','Word\x20document\x20export\x20started':'Word\x20文档导出开始','Word\x20document\x20export\x20failed':'Word\x20文档导出失败','Word\x20document\x20export\x20successful':'Word\x20文档导出成功','Exporting\x20Word\x20document':'正在导出\x20Word\x20文档'},'getPluralForm':_0x2da13a=>0x0}};_0x39c45a['zh-cn']||={'dictionary':{},'getPluralForm':null},_0x39c45a['zh-cn']['dictionary']=Object['assign'](_0x39c45a['zh-cn']['dictionary'],_0x350140),_0x39c45a['zh-cn']['getPluralForm']=_0x4c86d1;})(window['CKEDITOR_TRANSLATIONS']||={});

package/dist/translations/zh.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+import type { Translations } from 'ckeditor5';
+declare const translations: Translations;
+export default translations;

package/dist/translations/zh.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+export default{'zh':{'dictionary':{'Export\x20to\x20Word':'匯出到\x20Word','An\x20error\x20occurred\x20while\x20generating\x20the\x20Word\x20file.':'產生\x20Word\x20檔案時出錯。','Word\x20document\x20export\x20started':'Word\x20文件匯出開始','Word\x20document\x20export\x20failed':'Word\x20文件匯出失敗','Word\x20document\x20export\x20successful':'Word\x20文件匯出成功','Exporting\x20Word\x20document':'正在匯出\x20Word\x20文件'},'getPluralForm':_0x5bf61f=>0x0}};

package/dist/translations/zh.umd.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+(_0x7410ed=>{const {zh:{dictionary:_0x1ce7a9,getPluralForm:_0xae863d}}={'zh':{'dictionary':{'Export\x20to\x20Word':'匯出到\x20Word','An\x20error\x20occurred\x20while\x20generating\x20the\x20Word\x20file.':'產生\x20Word\x20檔案時出錯。','Word\x20document\x20export\x20started':'Word\x20文件匯出開始','Word\x20document\x20export\x20failed':'Word\x20文件匯出失敗','Word\x20document\x20export\x20successful':'Word\x20文件匯出成功','Exporting\x20Word\x20document':'正在匯出\x20Word\x20文件'},'getPluralForm':_0xfc4899=>0x0}};_0x7410ed['zh']||={'dictionary':{},'getPluralForm':null},_0x7410ed['zh']['dictionary']=Object['assign'](_0x7410ed['zh']['dictionary'],_0x1ce7a9),_0x7410ed['zh']['getPluralForm']=_0xae863d;})(window['CKEDITOR_TRANSLATIONS']||={});

package/dist/types/augmentation.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { ExportWordConfig, ExportWord, ExportWordCommand } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the {@link module:export-word/exportword~ExportWord export to Word feature}.
+         *
+         * Read more in {@link module:export-word/exportword~ExportWordConfig}.
+         */
+        exportWord?: ExportWordConfig;
+    }
+    interface PluginsMap {
+        [ExportWord.pluginName]: ExportWord;
+    }
+    interface CommandsMap {
+        exportWord: ExportWordCommand;
+    }
+}

package/dist/types/exportword.d.ts

@@ -0,0 +1,236 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module export-word/exportword
+ * @publicApi
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import { Notification } from 'ckeditor5/src/ui.js';
+import type { InitializedToken, TokenUrl } from '@ckeditor/ckeditor5-cloud-services';
+import ExportWordUI from './exportwordui.js';
+/**
+ * The export to Word feature.
+ *
+ * It allows you to generate a Word file directly from the editor content.
+ *
+ * For a detailed overview, check the {@glink features/converters/export-word export to Word} feature documentation.
+ */
+export default class ExportWord extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ExportWord";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly ["CloudServices", typeof Notification, typeof ExportWordUI];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}
+/**
+ * The configuration of the export to Word feature. It is used by the Word export features from
+ * the `@ckeditor/ckeditor5-export-word` package.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		exportWord: ... // Export to Word feature options.
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface ExportWordConfig {
+    /**
+     * Paths to the `.css` files containing additional styling for the editor's content (**the order of provided items matters**).
+     *
+     * ```ts
+     * const exportWordConfig = {
+     * 	stylesheets: [ './path/to/custom-style.css' ]
+     * }
+     * ```
+     *
+     * **NOTE:** If `stylesheets` are not provided, the plugin will sent only
+     * {@glink installation/advanced/content-styles#the-full-list-of-content-styles the default editor content styles} to the converter.
+     *
+     * **Default editor's content styles**:
+     * {@glink installation/advanced/content-styles#the-full-list-of-content-styles The default editor content styles}
+     * are applied to the generated Word file thanks to the 'EDITOR_STYLES' token, which is provided to the `stylesheets` by default.
+     * If you don't want them to be applied, you have to omit the token:
+     *
+     * ```ts
+     * const exportWordConfig = {
+     * 	stylesheets: [ './path/to/custom-editor-styles.css' ]
+     * }
+     * ```
+     *
+     * **Custom styling:** For more advanced styling, your configuration should look like this:
+     *
+     * ```ts
+     * const exportWordConfig = {
+     * 	stylesheets: [
+     * 		'EDITOR_STYLES',
+     * 		'./path/to/custom-styles.css'
+     * 	]
+     * }
+     * ```
+     *
+     * @default `[ 'EDITOR_STYLES' ]`
+     */
+    stylesheets?: Array<string>;
+    /**
+     * The name of the generated Word file.
+     *
+     * ```ts
+     * // Static file name.
+     * const exportWordConfig = {
+     * 	fileName: 'my-document.docx'
+     * }
+     *
+     *
+     * // Dynamic file name.
+     * const exportWordConfig = {
+     * 	fileName: () => {
+     * 		const articleTitle = document.querySelector( '#title' );
+     *
+     * 		return `${ articleTitle.value }.docx`;
+     * 	}
+     * }
+     * ```
+     *
+     * **NOTE:** The file name must contain the `.docx` extension.
+     * Otherwise your operating system or device may have trouble identifying the file type.
+     *
+     * @default 'document.docx'
+     */
+    fileName?: string | (() => string);
+    /**
+     * A URL to the Docx converter.
+     *
+     * ```ts
+     * const exportWordConfig = {
+     * 	converterUrl: 'https://myconverter.com/v1/'
+     * }
+     * ```
+     *
+     * **NOTE:** The plugin uses the default HTML to Word converter delivered by CKEditor Cloud Services.
+     * You can provide a URL to an on-premises converter instead.
+     *
+     * @default 'https://docx-converter.cke-cs.com/v1/convert'
+     */
+    converterUrl?: string;
+    /**
+     * The CKEditor Cloud Services HTML to DOCX Converter [configuration options](https://docx-converter.cke-cs.com/docs#section/Options).
+     *
+     * **NOTE:** Configuring the plugin is not mandatory.
+     *
+     * ```ts
+     * const exportWordConfig = {
+     * 	converterOptions: {
+     * 		...
+     * 	}
+     * }
+     * ```
+     *
+     * @default `{
+     * 	format: 'A4',
+     * 	margin_top: '1in',
+     * 	margin_bottom: '1in',
+     * 	margin_right: '1in',
+     * 	margin_left: '1in',
+     * 	header: undefined,
+     * 	footer: undefined,
+     * 	comments: undefined,
+     * 	suggestions: undefined,
+     * 	orientation: 'portrait',
+     * 	auto_pagination: true,
+     * 	base_url: undefined,
+     * 	timezone: 'UTC'
+     * }`
+     */
+    converterOptions?: ExportWordConverterOptions;
+    /**
+     * A function to gather the HTML to be converted to Word.
+     *
+     * **NOTE:** This option may be useful when the editor does not have a `getData()` method,
+     * or if the HTML to be converted should be different than the edited one.
+     *
+     * ```ts
+     * const exportWordConfig = {
+     * 	dataCallback: ( editor ) => {
+     * 		return `
+     * 			<header id="header">${ editor.data.get( { rootName: 'header' } ) }</header>
+     * 			<div id="content">${ editor.data.get( { rootName: 'content' } ) }</div>
+     * 		`;
+     * 	}
+     * }
+     * ```
+     *
+     * @default `( editor ) => editor.getData( { pagination: true } )
+     *
+     * If using the {@glink features/pagination/pagination pagination} feature, the `pagination:true` option inserts additional markers into
+     * editor's data. Thanks to that, the Docx converter creates a Word document similar to what is displayed in the editor.
+     */
+    dataCallback?: (editor: Editor) => 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 export to Word feature.
+     *
+     * **Note:** The token can be disabled with the `false` value provided.
+     *
+     * See: {@link module:cloud-services/cloudservicesconfig~CloudServicesConfig#tokenUrl}
+     */
+    tokenUrl?: TokenUrl | false;
+    /**
+     * The authentication token.
+     *
+     * See: {@link module:cloud-services/cloudservices~CloudServices#token}
+     */
+    token?: InitializedToken;
+}
+export type ExportWordConverterOptions = {
+    format?: ExportWordConverterFormatOption;
+    margin_top?: string;
+    margin_bottom?: string;
+    margin_right?: string;
+    margin_left?: string;
+    header?: ExportWordConverterHeaderFooterOption;
+    footer?: ExportWordConverterHeaderFooterOption;
+    comments?: ExportWordConverterCommentsOption;
+    suggestions?: ExportWordConverterSuggestionsOption;
+    orientation?: ExportWordConverterOrientationOption;
+    auto_pagination?: boolean;
+    base_url?: string;
+    timezone?: string;
+};
+export type ExportWordConverterFormatOption = 'Letter' | 'Legal' | 'Tabloid' | 'Statement' | 'Executive' | 'A3' | 'A4' | 'A5' | 'A6' | 'B4' | 'B5';
+export type ExportWordConverterOrientationOption = 'portrait' | 'landscape';
+export type ExportWordConverterHeaderFooterOption = Array<{
+    html?: string;
+    css?: string;
+    type?: 'default' | 'even' | 'odd' | 'first';
+}>;
+export type ExportWordConverterCommentsOption = {
+    [id: string]: Array<{
+        author: string;
+        created: Date;
+        content?: string;
+        is_resolved: boolean;
+    }>;
+};
+export type ExportWordConverterSuggestionsOption = {
+    [id: string]: {
+        author: string;
+        created: Date | null;
+    };
+};

package/dist/types/exportwordcommand.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module export-word/exportwordcommand
+ * @publicApi
+ */
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+import { type ExportWordConfig } from './exportword.js';
+/**
+ * The export to Word command.
+ *
+ * It takes the editor's HTML and CSS rules from the document and sends them to the HTML to Word converter.
+ * After processing, the converter will send back a Word file for download.
+ */
+export default class ExportWordCommand extends Command {
+    /**
+     * A command state that indicates if the command is currently executing.
+     *
+     * @observable
+     */
+    isBusy: boolean;
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * @inheritDoc
+     */
+    execute(options?: ExportWordConfig): Promise<void>;
+}

package/dist/types/exportwordui.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module export-word/exportwordui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The export to Word UI feature.
+ *
+ * It introduces 'Export to Word' button in toolbar and menu bar.
+ */
+export default class ExportWordUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ExportWordUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module export-word
+ */
+export { default as ExportWord, type ExportWordConfig } from './exportword.js';
+export type { default as ExportWordCommand } from './exportwordcommand.js';
+import './augmentation.js';

package/dist/types/utils.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { Editor } from 'ckeditor5/src/core.js';
+import type { Collection } from 'ckeditor5/src/utils.js';
+import type { ExportWordConverterOptions, ExportWordConverterCommentsOption, ExportWordConverterSuggestionsOption } from './exportword.js';
+import type { CommentThread } from '@ckeditor/ckeditor5-comments';
+import type { SuggestionJSON } from '@ckeditor/ckeditor5-track-changes';
+import type { User } from '@ckeditor/ckeditor5-collaboration-core';
+/**
+ * A helper function for getting concatenated CSS rules from external stylesheets.
+ *
+ * @param stylesheets An array of stylesheet paths delivered by the user through the plugin configuration.
+ */
+export declare function getStyles(stylesheets?: Array<string>): Promise<string>;
+/**
+ * A helper function for getting a proper options object containing
+ * comments, suggestions and the browser's timezone for the "Export to Word" converter.
+ *
+ * @param editor  An editor instance.
+ */
+export declare function getConverterOptions(editor: Editor): ExportWordConverterOptions;
+/**
+ * A helper function for getting a comments object for the converter options.
+ *
+ * @param threads The comment threads array.
+ */
+export declare function getComments(threads: Array<CommentThread>): ExportWordConverterCommentsOption;
+/**
+ * A helper function for getting a suggestions object for the converter options.
+ *
+ * @param suggestions The suggestions array.
+ * @param users A list of all users in the editor.
+ */
+export declare function getSuggestions(suggestions: Array<SuggestionJSON>, users: Collection<User>): ExportWordConverterSuggestionsOption;

package/lang/contexts.json

@@ -1,4 +1,8 @@
 {
   "Export to Word": "A toolbar button tooltip for a Word export feature.",
-  "An error occurred while generating the Word file.": "An error message shown to the user when an error occurred during the generation of the Word file."
+  "An error occurred while generating the Word file.": "An error message shown to the user when an error occurred during the generation of the Word file.",
+  "Word document export started": "Aria status message indicating start of word document export. Example: 'Word document export started'.",
+  "Word document export failed": "Aria status message indicating failed Word document export. Example: 'Word document export failed'.",
+  "Word document export successful": "Aria status message indicating successful Word document export. Example: 'Word document export successful'.",
+  "Exporting Word document": "Aria label set on Export to Word button while exporting the Word file."
 }

package/lang/translations/ar.po

@@ -24,3 +24,19 @@ msgstr "تصدير إلى Word"
 msgctxt "An error message shown to the user when an error occurred during the generation of the Word file."
 msgid "An error occurred while generating the Word file."
 msgstr "حدث خطأ ما، أثناء استخراج ملف Word."
+
+msgctxt "Aria status message indicating start of word document export. Example: 'Word document export started'."
+msgid "Word document export started"
+msgstr "بدأ تصدير مستند Word"
+
+msgctxt "Aria status message indicating failed Word document export. Example: 'Word document export failed'."
+msgid "Word document export failed"
+msgstr "فشل تصدير مستند Word"
+
+msgctxt "Aria status message indicating successful Word document export. Example: 'Word document export successful'."
+msgid "Word document export successful"
+msgstr "تم تصدير مستند Word بنجاح"
+
+msgctxt "Aria label set on Export to Word button while exporting the Word file."
+msgid "Exporting Word document"
+msgstr "تصدير مستند Word"

package/lang/translations/bg.po

@@ -24,3 +24,19 @@ msgstr "Експорт към Word"
 msgctxt "An error message shown to the user when an error occurred during the generation of the Word file."
 msgid "An error occurred while generating the Word file."
 msgstr "Възникна грешка при генериране на файл в Word."
+
+msgctxt "Aria status message indicating start of word document export. Example: 'Word document export started'."
+msgid "Word document export started"
+msgstr "Започнато прехвърляне на документ от Word"
+
+msgctxt "Aria status message indicating failed Word document export. Example: 'Word document export failed'."
+msgid "Word document export failed"
+msgstr "Неуспешно прехвърляне на документ от Word"
+
+msgctxt "Aria status message indicating successful Word document export. Example: 'Word document export successful'."
+msgid "Word document export successful"
+msgstr "Прехвърлянето на документ от Word е успешно"
+
+msgctxt "Aria label set on Export to Word button while exporting the Word file."
+msgid "Exporting Word document"
+msgstr "Прехвърляне на документ в Word"