@ckeditor/ckeditor5-import-word 41.3.0-alpha.4 → 41.3.0

package/dist/types/importword.d.ts

@@ -1,128 +0,0 @@
-/**
- * @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 import-word/importword
- * @publicApi
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-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.
- */
-export default class ImportWord extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImportWord";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImportWordEditing, typeof 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( editorElement, {
- * 		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: FormattingOptions;
-}
-export interface FormattingOptions {
-    /**
-     * 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/types/importwordcommand.d.ts

@@ -1,58 +0,0 @@
-/**
- * @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 import-word/importwordcommand
- * @publicApi
- */
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-/**
- * The import from Word command.
- *
- * It sends the Word file to the converter endpoint and inserts its content into the editor.
- */
-export default 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>;
-}
-/**
- * Fired when the converter service returned the HTML content that will be inserted into the editor.
- *
- * @eventName ~ImportWordCommand#dataInsert
- */
-export type DataInsertEvent = {
-    name: 'dataInsert';
-    args: [data: DataInsertEventData];
-};
-interface DataInsertEventData {
-    /**
-     * The HTML content to insertion.
-     */
-    html: string;
-}
-export {};

package/dist/types/importwordediting.d.ts

@@ -1,43 +0,0 @@
-/**
- * @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 import-word/importwordediting
- * @publicApi
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import { Notification } from 'ckeditor5/src/ui.js';
-import { ClipboardPipeline } from 'ckeditor5/src/clipboard.js';
-import 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}.
- */
-export default class ImportWordEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImportWordEditing";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Notification, typeof ClipboardPipeline, "CloudServices"];
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): Promise<void>;
-    /**
-     * Returns a token used by the import from Word plugin for communication with the Cloud Services.
-     */
-    getToken(): InitializedToken | null;
-}

package/dist/types/importwordui.d.ts

@@ -1,26 +0,0 @@
-/**
- * @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 import-word/importwordui
- * @publicApi
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * The ImportWordUI plugin. It introduces the `'importWord'` toolbar button.
- */
-export default class ImportWordUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImportWordUI";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/types/index.d.ts

@@ -1,16 +0,0 @@
-/**
- * @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 import-word
- */
-export { default as ImportWord, type ImportWordConfig } from './importword.js';
-export { default as ImportWordEditing } from './importwordediting.js';
-export { default as ImportWordUI } from './importwordui.js';
-export type { default as ImportWordCommand } from './importwordcommand.js';
-import './augmentation.js';