@ckeditor/ckeditor5-paste-from-office 45.2.1 → 46.0.0-alpha.0

package/src/normalizers/googledocsnormalizer.js

@@ -5,15 +5,17 @@
 /**
  * @module paste-from-office/normalizers/googledocsnormalizer
  */
-import { UpcastWriter } from 'ckeditor5/src/engine.js';
-import removeBoldWrapper from '../filters/removeboldwrapper.js';
-import transformBlockBrsToParagraphs from '../filters/br.js';
+import { ViewUpcastWriter } from 'ckeditor5/src/engine.js';
+import { removeBoldWrapper } from '../filters/removeboldwrapper.js';
+import { transformBlockBrsToParagraphs } from '../filters/br.js';
 import { unwrapParagraphInListItem } from '../filters/list.js';
 const googleDocsMatch = /id=("|')docs-internal-guid-[-0-9a-f]+("|')/i;
 /**
  * Normalizer for the content pasted from Google Docs.
+ *
+ * @internal
  */
-export default class GoogleDocsNormalizer {
+export class GoogleDocsNormalizer {
     document;
     /**
      * Creates a new `GoogleDocsNormalizer` instance.
@@ -33,7 +35,7 @@ export default class GoogleDocsNormalizer {
      * @inheritDoc
      */
     execute(data) {
-        const writer = new UpcastWriter(this.document);
+        const writer = new ViewUpcastWriter(this.document);
         const { body: documentFragment } = data._parsedData;
         removeBoldWrapper(documentFragment, writer);
         unwrapParagraphInListItem(documentFragment, writer);

package/src/normalizers/googlesheetsnormalizer.d.ts

@@ -6,11 +6,13 @@
  * @module paste-from-office/normalizers/googlesheetsnormalizer
  */
 import { type ViewDocument } from 'ckeditor5/src/engine.js';
-import type { Normalizer, NormalizerData } from '../normalizer.js';
+import type { PasteFromOfficeNormalizer, PasteFromOfficeNormalizerData } from '../normalizer.js';
 /**
  * Normalizer for the content pasted from Google Sheets.
+ *
+ * @internal
  */
-export default class GoogleSheetsNormalizer implements Normalizer {
+export declare class GoogleSheetsNormalizer implements PasteFromOfficeNormalizer {
     readonly document: ViewDocument;
     /**
      * Creates a new `GoogleSheetsNormalizer` instance.
@@ -25,5 +27,5 @@ export default class GoogleSheetsNormalizer implements Normalizer {
     /**
      * @inheritDoc
      */
-    execute(data: NormalizerData): void;
+    execute(data: PasteFromOfficeNormalizerData): void;
 }

package/src/normalizers/googlesheetsnormalizer.js

@@ -5,16 +5,18 @@
 /**
  * @module paste-from-office/normalizers/googlesheetsnormalizer
  */
-import { UpcastWriter } from 'ckeditor5/src/engine.js';
-import removeXmlns from '../filters/removexmlns.js';
-import removeGoogleSheetsTag from '../filters/removegooglesheetstag.js';
-import removeInvalidTableWidth from '../filters/removeinvalidtablewidth.js';
-import removeStyleBlock from '../filters/removestyleblock.js';
+import { ViewUpcastWriter } from 'ckeditor5/src/engine.js';
+import { removeXmlns } from '../filters/removexmlns.js';
+import { removeGoogleSheetsTag } from '../filters/removegooglesheetstag.js';
+import { removeInvalidTableWidth } from '../filters/removeinvalidtablewidth.js';
+import { removeStyleBlock } from '../filters/removestyleblock.js';
 const googleSheetsMatch = /<google-sheets-html-origin/i;
 /**
  * Normalizer for the content pasted from Google Sheets.
+ *
+ * @internal
  */
-export default class GoogleSheetsNormalizer {
+export class GoogleSheetsNormalizer {
     document;
     /**
      * Creates a new `GoogleSheetsNormalizer` instance.
@@ -34,7 +36,7 @@ export default class GoogleSheetsNormalizer {
      * @inheritDoc
      */
     execute(data) {
-        const writer = new UpcastWriter(this.document);
+        const writer = new ViewUpcastWriter(this.document);
         const { body: documentFragment } = data._parsedData;
         removeGoogleSheetsTag(documentFragment, writer);
         removeXmlns(documentFragment, writer);

package/src/normalizers/mswordnormalizer.d.ts

@@ -3,15 +3,15 @@
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
  */
 import { type ViewDocument } from 'ckeditor5/src/engine.js';
-import type { Normalizer, NormalizerData } from '../normalizer.js';
+import type { PasteFromOfficeNormalizer, PasteFromOfficeNormalizerData } from '../normalizer.js';
 /**
  * Normalizer for the content pasted from Microsoft Word.
  */
-export default class MSWordNormalizer implements Normalizer {
+export declare class PasteFromOfficeMSWordNormalizer implements PasteFromOfficeNormalizer {
     readonly document: ViewDocument;
     readonly hasMultiLevelListPlugin: boolean;
     /**
-     * Creates a new `MSWordNormalizer` instance.
+     * Creates a new `PasteFromOfficeMSWordNormalizer` instance.
      *
      * @param document View document.
      */
@@ -23,5 +23,5 @@ export default class MSWordNormalizer implements Normalizer {
     /**
      * @inheritDoc
      */
-    execute(data: NormalizerData): void;
+    execute(data: PasteFromOfficeNormalizerData): void;
 }

package/src/normalizers/mswordnormalizer.js

@@ -5,22 +5,22 @@
 /**
  * @module paste-from-office/normalizers/mswordnormalizer
  */
-import transformBookmarks from '../filters/bookmark.js';
+import { transformBookmarks } from '../filters/bookmark.js';
 import { transformListItemLikeElementsIntoLists } from '../filters/list.js';
 import { replaceImagesSourceWithBase64 } from '../filters/image.js';
-import removeMSAttributes from '../filters/removemsattributes.js';
-import transformTables from '../filters/table.js';
-import { UpcastWriter } from 'ckeditor5/src/engine.js';
+import { removeMSAttributes } from '../filters/removemsattributes.js';
+import { transformTables } from '../filters/table.js';
+import { ViewUpcastWriter } from 'ckeditor5/src/engine.js';
 const msWordMatch1 = /<meta\s*name="?generator"?\s*content="?microsoft\s*word\s*\d+"?\/?>/i;
 const msWordMatch2 = /xmlns:o="urn:schemas-microsoft-com/i;
 /**
  * Normalizer for the content pasted from Microsoft Word.
  */
-export default class MSWordNormalizer {
+export class PasteFromOfficeMSWordNormalizer {
     document;
     hasMultiLevelListPlugin;
     /**
-     * Creates a new `MSWordNormalizer` instance.
+     * Creates a new `PasteFromOfficeMSWordNormalizer` instance.
      *
      * @param document View document.
      */
@@ -38,7 +38,7 @@ export default class MSWordNormalizer {
      * @inheritDoc
      */
     execute(data) {
-        const writer = new UpcastWriter(this.document);
+        const writer = new ViewUpcastWriter(this.document);
         const { body: documentFragment, stylesString } = data._parsedData;
         transformBookmarks(documentFragment, writer);
         transformListItemLikeElementsIntoLists(documentFragment, stylesString, this.hasMultiLevelListPlugin);

package/src/pastefromoffice.d.ts

@@ -13,14 +13,14 @@ import { ClipboardPipeline } from 'ckeditor5/src/clipboard.js';
  * This plugin handles content pasted from Office apps and transforms it (if necessary)
  * to a valid structure which can then be understood by the editor features.
  *
- * Transformation is made by a set of predefined {@link module:paste-from-office/normalizer~Normalizer normalizers}.
+ * Transformation is made by a set of predefined {@link module:paste-from-office/normalizer~PasteFromOfficeNormalizer normalizers}.
  * This plugin includes following normalizers:
- * * {@link module:paste-from-office/normalizers/mswordnormalizer~MSWordNormalizer Microsoft Word normalizer}
+ * * {@link module:paste-from-office/normalizers/mswordnormalizer~PasteFromOfficeMSWordNormalizer Microsoft Word normalizer}
  * * {@link module:paste-from-office/normalizers/googledocsnormalizer~GoogleDocsNormalizer Google Docs normalizer}
  *
  * For more information about this feature check the {@glink api/paste-from-office package page}.
  */
-export default class PasteFromOffice extends Plugin {
+export declare class PasteFromOffice extends Plugin {
     /**
      * @inheritDoc
      */

package/src/pastefromoffice.js

@@ -7,24 +7,24 @@
  */
 import { Plugin } from 'ckeditor5/src/core.js';
 import { ClipboardPipeline } from 'ckeditor5/src/clipboard.js';
-import MSWordNormalizer from './normalizers/mswordnormalizer.js';
-import GoogleDocsNormalizer from './normalizers/googledocsnormalizer.js';
-import GoogleSheetsNormalizer from './normalizers/googlesheetsnormalizer.js';
-import { parseHtml } from './filters/parse.js';
+import { PasteFromOfficeMSWordNormalizer } from './normalizers/mswordnormalizer.js';
+import { GoogleDocsNormalizer } from './normalizers/googledocsnormalizer.js';
+import { GoogleSheetsNormalizer } from './normalizers/googlesheetsnormalizer.js';
+import { parsePasteOfficeHtml } from './filters/parse.js';
 /**
  * The Paste from Office plugin.
  *
  * This plugin handles content pasted from Office apps and transforms it (if necessary)
  * to a valid structure which can then be understood by the editor features.
  *
- * Transformation is made by a set of predefined {@link module:paste-from-office/normalizer~Normalizer normalizers}.
+ * Transformation is made by a set of predefined {@link module:paste-from-office/normalizer~PasteFromOfficeNormalizer normalizers}.
  * This plugin includes following normalizers:
- * * {@link module:paste-from-office/normalizers/mswordnormalizer~MSWordNormalizer Microsoft Word normalizer}
+ * * {@link module:paste-from-office/normalizers/mswordnormalizer~PasteFromOfficeMSWordNormalizer Microsoft Word normalizer}
  * * {@link module:paste-from-office/normalizers/googledocsnormalizer~GoogleDocsNormalizer Google Docs normalizer}
  *
  * For more information about this feature check the {@glink api/paste-from-office package page}.
  */
-export default class PasteFromOffice extends Plugin {
+export class PasteFromOffice extends Plugin {
     /**
      * @inheritDoc
      */
@@ -52,7 +52,7 @@ export default class PasteFromOffice extends Plugin {
         const viewDocument = editor.editing.view.document;
         const normalizers = [];
         const hasMultiLevelListPlugin = this.editor.plugins.has('MultiLevelList');
-        normalizers.push(new MSWordNormalizer(viewDocument, hasMultiLevelListPlugin));
+        normalizers.push(new PasteFromOfficeMSWordNormalizer(viewDocument, hasMultiLevelListPlugin));
         normalizers.push(new GoogleDocsNormalizer(viewDocument));
         normalizers.push(new GoogleSheetsNormalizer(viewDocument));
         clipboardPipeline.on('inputTransformation', (evt, data) => {
@@ -67,7 +67,7 @@ export default class PasteFromOffice extends Plugin {
             const activeNormalizer = normalizers.find(normalizer => normalizer.isActive(htmlString));
             if (activeNormalizer) {
                 if (!data._parsedData) {
-                    data._parsedData = parseHtml(htmlString, viewDocument.stylesProcessor);
+                    data._parsedData = parsePasteOfficeHtml(htmlString, viewDocument.stylesProcessor);
                 }
                 activeNormalizer.execute(data);
                 data._isTransformedWithPasteFromOffice = true;