@ckeditor/ckeditor5-paste-from-office-enhanced 41.3.0-alpha.4 → 41.3.1

package/dist/types/normalizers/propagator/msofficeinlinestylepropagator.d.ts

@@ -1,47 +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
- */
-import { type NormalizerData, MSWordNormalizer } from '@ckeditor/ckeditor5-paste-from-office';
-/**
- * A normalizer that propagates inline styles from block element into `span` element with style properties
- * and/or creates an `HTML` structure based on early mentioned block element styles.
- *
- * Normalizers are registered by the {@link module:paste-from-office-enhanced/pastefromofficeenhanced~PasteFromOfficeEnhanced}
- * plugin and run on {@link module:clipboard/clipboardpipeline~ClipboardPipeline#event:inputTransformation inputTransformation event}.
- * They detect environment-specific quirks and transform it into a form compatible with other CKEditor features.
- *
- * This particular normalizer turns a pasted content such as:
- *
- * ```html
- * <p style="color:red;font-size:10px;font-weight:bold;">
- *  foo
- * </p>
- * ```
- *
- * into:
- *
- * ```html
- * <p>
- *  <span style="color:red;font-size:10px">
- *   <strong>
- *    foo
- *   </strong>
- *  </span>
- * </p>
- * ```
- */
-export default class MSOfficeInlineStylePropagator extends MSWordNormalizer {
-    /**
-     * @inheritDoc
-     */
-    execute(data: NormalizerData): void;
-    /**
-     * @inheritDoc
-     */
-    isActive(htmlString: string): boolean;
-}

package/dist/types/normalizers/propagator/utils.d.ts

@@ -1,101 +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 paste-from-office-enhanced/normalizers/msofficeinlinestylepropagator/utils
- */
-import type { UpcastWriter, ViewElement } from 'ckeditor5/src/engine.js';
-/**
- * The list of all `CSS` properties that need to be propagated.
- *
- * @protected
- */
-export declare const CSS_PROPERTIES_TO_PROPAGATE: readonly ["color", "font-family", "font-size", "text-decoration", "text-decoration-line", "font-weight", "font-style", "vertical-align"];
-/**
- * The list of `CSS` properties that needs to be propagated as an inline `<span>` element.
- *
- * It's a subset of `CSS_PROPERTIES_TO_PROPAGATE`.
- *
- * @protected
- */
-export declare const CSS_PROPERTIES_TO_BE_SPANS: readonly ["color", "font-family", "font-size"];
-export type CSSPropertyValueAssertion = (value: string) => boolean;
-export type CSSPropertyValueToElementNameMap = readonly [string | CSSPropertyValueAssertion, string];
-/**
- * The map of style to element propagate as a HTML elements
- * (e.g. `text-decoration` with the `underline` value is propagated to `<u>`,
- * or `font-weight` with the `bold` value is propagated to `<strong>`).
- *
- * @protected
- */
-export declare const CSS_PROPERTIES_TO_BE_HTML_ELEMENTS: {
-    [key in Exclude<typeof CSS_PROPERTIES_TO_PROPAGATE[number], typeof CSS_PROPERTIES_TO_BE_SPANS[number]>]: ReadonlyArray<CSSPropertyValueToElementNameMap>;
-};
-/**
- * Checks whether the given property should be propagated at all.
- *
- * @param property
- * @returns
- */
-export declare function isPropertyToBePropagated(property: string): property is typeof CSS_PROPERTIES_TO_PROPAGATE[number];
-/**
- * Checks whether the given property should be propagated as a span element.
- *
- * @param property
- * @returns
- */
-export declare function isPropertyToBePropagatedAsSpan(property: string): property is typeof CSS_PROPERTIES_TO_BE_SPANS[number];
-/**
- * Checks whether the given property should be propagated as an HTML element.
- *
- * @param property
- * @returns
- */
-export declare function isPropertyToBePropagatedAsHTMLElement(property: string): property is keyof typeof CSS_PROPERTIES_TO_BE_HTML_ELEMENTS;
-/**
- * Collects a list of styles to propagate from a block element.
- *
- * @param element The source `ViewElement`.
- * @returns List of valid CSS properties to propagate.
- */
-export declare function getStylePropertyNamesToPropagate(element: ViewElement): Array<typeof CSS_PROPERTIES_TO_PROPAGATE[number]>;
-/**
- * Executes styles propagation.
- *
- * @param element The source `ViewElement`.
- * @param writer `UpcastWriter` instance.
- * @param propertiesToPropagate List of valid CSS properties to propagate.
- */
-export declare function propagateStyleProperties(element: ViewElement, writer: UpcastWriter, propertiesToPropagate: Array<string>): void;
-/**
- * Creates an `HTML` structure based on styles propagated from parent block element.
- *
- * @param element The source `ViewElement`.
- * @param writer `UpcastWriter` instance.
- * @param stylesToBeHtmlElements List of styles properties to be propagated as a HTML elements.
- */
-export declare function propagateStylesAsHTMLElements(element: ViewElement, writer: UpcastWriter, stylesToBeHtmlElements: Partial<typeof CSS_PROPERTIES_TO_BE_HTML_ELEMENTS>): void;
-/**
- * Creates a `span` as a first child of the `element` with styles propagated from parent block element.
- *
- * @param element The source `ViewElement`.
- * @param writer `UpcastWriter` instance.
- * @param spanStyles List of styles properties to propagate.
- */
-export declare function propagateStylesAsSpan(element: ViewElement, writer: UpcastWriter, spanStyles: Partial<Record<typeof CSS_PROPERTIES_TO_BE_SPANS[number], string>>): void;
-/**
- * Collects and filters element styles into proper objects for further propagation.
- *
- * @param element The source `ViewElement`.
- * @param propertiesToPropagate The array of style properties to propagate.
- * @returns An object with properties to propagate filtered into styles that will be propagated onto `span` and as a HTML elements.
- */
-export declare function getStylesToPropagate(element: ViewElement, propertiesToPropagate: Array<string>): {
-    spanStyles: Partial<Record<typeof CSS_PROPERTIES_TO_BE_SPANS[number], string>>;
-    stylesToBeHtmlElements: Partial<typeof CSS_PROPERTIES_TO_BE_HTML_ELEMENTS>;
-};

package/dist/types/pastefromofficeenhanced.d.ts

@@ -1,33 +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 paste-from-office-enhanced/pastefromofficeenhanced
- * @publicApi
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import PasteFromOfficeEnhancedInliner from './pastefromofficeenhancedinliner.js';
-import PasteFromOfficeEnhancedPropagator from './pastefromofficeenhancedpropagator.js';
-/**
- * The Paste from Office Enhanced feature.
- *
- * Introduces seamless content pasting from MS Office applications with improved formatting retention for a smoother
- * and more efficient workflow.
- *
- * For a detailed overview, check the {@glink features/pasting/paste-from-office Paste from Office Enhanced feature guide}.
- */
-export default class PasteFromOfficeEnhanced extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "PasteFromOfficeEnhanced";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly ["PasteFromOffice", typeof PasteFromOfficeEnhancedInliner, typeof PasteFromOfficeEnhancedPropagator];
-}

package/dist/types/pastefromofficeenhancedinliner.d.ts

@@ -1,33 +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 paste-from-office-enhanced/pastefromofficeenhancedinliner
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * The Paste from Office Enhanced inliner plugin that inlines styles passed along the content from MS Office.
- */
-export default class PasteFromOfficeEnhancedInliner extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "PasteFromOfficeEnhancedInliner";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly ["PasteFromOffice"];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-}

package/dist/types/pastefromofficeenhancedpropagator.d.ts

@@ -1,40 +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 paste-from-office-enhanced/pastefromofficeenhancedpropagator
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-/**
- * The Paste from Office Enhanced propagator that propagates inline styles from block elements to:
- * * `span` element with `style` properties,
- * * `HTML` structures based block element styles.
- */
-export default class PasteFromOfficeEnhancedPropagator extends Plugin {
-    licenseKey: string;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "PasteFromOfficeEnhancedPropagator";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly ["PasteFromOffice"];
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-}

package/dist/types/utils.d.ts

@@ -1,15 +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
- */
-/**
- * Check if content was pasted from MS Excel.
- *
- * @param html
- * @returns True if content is pasted from MS Excel
- */
-export declare function isMSExcelContent(html: string): boolean;