@ckeditor/ckeditor5-clipboard 38.1.1 → 38.2.0-alpha.1

package/src/index.d.ts

@@ -1,17 +1,17 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module clipboard
- */
-export { default as Clipboard } from './clipboard';
-export { default as ClipboardPipeline, type ClipboardContentInsertionEvent, type ClipboardInputTransformationEvent, type ClipboardInputTransformationData, type ViewDocumentClipboardOutputEvent } from './clipboardpipeline';
-export type { ClipboardEventData } from './clipboardobserver';
-export { default as DragDrop } from './dragdrop';
-export { default as PastePlainText } from './pasteplaintext';
-export { default as DragDropExperimental } from './dragdropexperimental';
-export { default as DragDropTarget } from './dragdroptarget';
-export { default as DragDropBlockToolbar } from './dragdropblocktoolbar';
-export type { ViewDocumentClipboardInputEvent, ViewDocumentCopyEvent, ViewDocumentCutEvent } from './clipboardobserver';
-import './augmentation';
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module clipboard
+ */
+export { default as Clipboard } from './clipboard.js';
+export { default as ClipboardPipeline, type ClipboardContentInsertionEvent, type ClipboardInputTransformationEvent, type ClipboardInputTransformationData, type ViewDocumentClipboardOutputEvent } from './clipboardpipeline.js';
+export type { ClipboardEventData } from './clipboardobserver.js';
+export { default as DragDrop } from './dragdrop.js';
+export { default as PastePlainText } from './pasteplaintext.js';
+export { default as DragDropExperimental } from './dragdropexperimental.js';
+export { default as DragDropTarget } from './dragdroptarget.js';
+export { default as DragDropBlockToolbar } from './dragdropblocktoolbar.js';
+export type { ViewDocumentClipboardInputEvent, ViewDocumentCopyEvent, ViewDocumentCutEvent } from './clipboardobserver.js';
+import './augmentation.js';

package/src/index.js

@@ -1,15 +1,15 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module clipboard
- */
-export { default as Clipboard } from './clipboard';
-export { default as ClipboardPipeline } from './clipboardpipeline';
-export { default as DragDrop } from './dragdrop';
-export { default as PastePlainText } from './pasteplaintext';
-export { default as DragDropExperimental } from './dragdropexperimental';
-export { default as DragDropTarget } from './dragdroptarget';
-export { default as DragDropBlockToolbar } from './dragdropblocktoolbar';
-import './augmentation';
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module clipboard
+ */
+export { default as Clipboard } from './clipboard.js';
+export { default as ClipboardPipeline } from './clipboardpipeline.js';
+export { default as DragDrop } from './dragdrop.js';
+export { default as PastePlainText } from './pasteplaintext.js';
+export { default as DragDropExperimental } from './dragdropexperimental.js';
+export { default as DragDropTarget } from './dragdroptarget.js';
+export { default as DragDropBlockToolbar } from './dragdropblocktoolbar.js';
+import './augmentation.js';

package/src/lineview.d.ts

@@ -1,45 +1,45 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module clipboard/lineview
- */
-import { View } from '@ckeditor/ckeditor5-ui';
-/**
- * The horizontal drop target line view.
- */
-export default class LineView extends View {
-    /**
-     * Controls whether the line is visible.
-     *
-     * @observable
-     * @default false
-     */
-    isVisible: boolean;
-    /**
-     * Controls the line position x coordinate.
-     *
-     * @observable
-     * @default null
-     */
-    left: number | null;
-    /**
-     * Controls the line width.
-     *
-     * @observable
-     * @default null
-     */
-    width: number | null;
-    /**
-     * Controls the line position y coordinate.
-     *
-     * @observable
-     * @default null
-     */
-    top: number | null;
-    /**
-     * @inheritDoc
-     */
-    constructor();
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module clipboard/lineview
+ */
+import { View } from '@ckeditor/ckeditor5-ui';
+/**
+ * The horizontal drop target line view.
+ */
+export default class LineView extends View {
+    /**
+     * Controls whether the line is visible.
+     *
+     * @observable
+     * @default false
+     */
+    isVisible: boolean;
+    /**
+     * Controls the line position x coordinate.
+     *
+     * @observable
+     * @default null
+     */
+    left: number | null;
+    /**
+     * Controls the line width.
+     *
+     * @observable
+     * @default null
+     */
+    width: number | null;
+    /**
+     * Controls the line position y coordinate.
+     *
+     * @observable
+     * @default null
+     */
+    top: number | null;
+    /**
+     * @inheritDoc
+     */
+    constructor();
+}

package/src/lineview.js

@@ -1,44 +1,44 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module clipboard/lineview
- */
-/* istanbul ignore file -- @preserve */
-import { View } from '@ckeditor/ckeditor5-ui';
-import { toUnit } from '@ckeditor/ckeditor5-utils';
-const toPx = toUnit('px');
-/**
- * The horizontal drop target line view.
- */
-export default class LineView extends View {
-    /**
-     * @inheritDoc
-     */
-    constructor() {
-        super();
-        const bind = this.bindTemplate;
-        this.set({
-            isVisible: false,
-            left: null,
-            top: null,
-            width: null
-        });
-        this.setTemplate({
-            tag: 'div',
-            attributes: {
-                class: [
-                    'ck',
-                    'ck-clipboard-drop-target-line',
-                    bind.if('isVisible', 'ck-hidden', value => !value)
-                ],
-                style: {
-                    left: bind.to('left', left => toPx(left)),
-                    top: bind.to('top', top => toPx(top)),
-                    width: bind.to('width', width => toPx(width))
-                }
-            }
-        });
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module clipboard/lineview
+ */
+/* istanbul ignore file -- @preserve */
+import { View } from '@ckeditor/ckeditor5-ui';
+import { toUnit } from '@ckeditor/ckeditor5-utils';
+const toPx = toUnit('px');
+/**
+ * The horizontal drop target line view.
+ */
+export default class LineView extends View {
+    /**
+     * @inheritDoc
+     */
+    constructor() {
+        super();
+        const bind = this.bindTemplate;
+        this.set({
+            isVisible: false,
+            left: null,
+            top: null,
+            width: null
+        });
+        this.setTemplate({
+            tag: 'div',
+            attributes: {
+                class: [
+                    'ck',
+                    'ck-clipboard-drop-target-line',
+                    bind.if('isVisible', 'ck-hidden', value => !value)
+                ],
+                style: {
+                    left: bind.to('left', left => toPx(left)),
+                    top: bind.to('top', top => toPx(top)),
+                    width: bind.to('width', width => toPx(width))
+                }
+            }
+        });
+    }
+}

package/src/pasteplaintext.d.ts

@@ -1,28 +1,28 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module clipboard/pasteplaintext
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import ClipboardPipeline from './clipboardpipeline';
-/**
- * The plugin detects the user's intention to paste plain text.
- *
- * For example, it detects the <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>V</kbd> keystroke.
- */
-export default class PastePlainText extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "PastePlainText";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ClipboardPipeline];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module clipboard/pasteplaintext
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import ClipboardPipeline from './clipboardpipeline.js';
+/**
+ * The plugin detects the user's intention to paste plain text.
+ *
+ * For example, it detects the <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>V</kbd> keystroke.
+ */
+export default class PastePlainText extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "PastePlainText";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ClipboardPipeline];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/src/pasteplaintext.js

@@ -1,82 +1,82 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module clipboard/pasteplaintext
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import ClipboardObserver from './clipboardobserver';
-import ClipboardPipeline from './clipboardpipeline';
-/**
- * The plugin detects the user's intention to paste plain text.
- *
- * For example, it detects the <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>V</kbd> keystroke.
- */
-export default class PastePlainText extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'PastePlainText';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [ClipboardPipeline];
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const model = editor.model;
-        const view = editor.editing.view;
-        const viewDocument = view.document;
-        const selection = model.document.selection;
-        let shiftPressed = false;
-        view.addObserver(ClipboardObserver);
-        this.listenTo(viewDocument, 'keydown', (evt, data) => {
-            shiftPressed = data.shiftKey;
-        });
-        editor.plugins.get(ClipboardPipeline).on('contentInsertion', (evt, data) => {
-            // Plain text can be determined based on the event flag (#7799) or auto-detection (#1006). If detected,
-            // preserve selection attributes on pasted items.
-            if (!shiftPressed && !isPlainTextFragment(data.content, model.schema)) {
-                return;
-            }
-            model.change(writer => {
-                // Formatting attributes should be preserved.
-                const textAttributes = Array.from(selection.getAttributes())
-                    .filter(([key]) => model.schema.getAttributeProperties(key).isFormatting);
-                if (!selection.isCollapsed) {
-                    model.deleteContent(selection, { doNotAutoparagraph: true });
-                }
-                // Also preserve other attributes if they survived the content deletion (because they were not fully selected).
-                // For example linkHref is not a formatting attribute but it should be preserved if pasted text was in the middle
-                // of a link.
-                textAttributes.push(...selection.getAttributes());
-                const range = writer.createRangeIn(data.content);
-                for (const item of range.getItems()) {
-                    if (item.is('$textProxy')) {
-                        writer.setAttributes(textAttributes, item);
-                    }
-                }
-            });
-        });
-    }
-}
-/**
- * Returns true if specified `documentFragment` represents a plain text.
- */
-function isPlainTextFragment(documentFragment, schema) {
-    if (documentFragment.childCount > 1) {
-        return false;
-    }
-    const child = documentFragment.getChild(0);
-    if (schema.isObject(child)) {
-        return false;
-    }
-    return Array.from(child.getAttributeKeys()).length == 0;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module clipboard/pasteplaintext
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import ClipboardObserver from './clipboardobserver.js';
+import ClipboardPipeline from './clipboardpipeline.js';
+/**
+ * The plugin detects the user's intention to paste plain text.
+ *
+ * For example, it detects the <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>V</kbd> keystroke.
+ */
+export default class PastePlainText extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'PastePlainText';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ClipboardPipeline];
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const model = editor.model;
+        const view = editor.editing.view;
+        const viewDocument = view.document;
+        const selection = model.document.selection;
+        let shiftPressed = false;
+        view.addObserver(ClipboardObserver);
+        this.listenTo(viewDocument, 'keydown', (evt, data) => {
+            shiftPressed = data.shiftKey;
+        });
+        editor.plugins.get(ClipboardPipeline).on('contentInsertion', (evt, data) => {
+            // Plain text can be determined based on the event flag (#7799) or auto-detection (#1006). If detected,
+            // preserve selection attributes on pasted items.
+            if (!shiftPressed && !isPlainTextFragment(data.content, model.schema)) {
+                return;
+            }
+            model.change(writer => {
+                // Formatting attributes should be preserved.
+                const textAttributes = Array.from(selection.getAttributes())
+                    .filter(([key]) => model.schema.getAttributeProperties(key).isFormatting);
+                if (!selection.isCollapsed) {
+                    model.deleteContent(selection, { doNotAutoparagraph: true });
+                }
+                // Also preserve other attributes if they survived the content deletion (because they were not fully selected).
+                // For example linkHref is not a formatting attribute but it should be preserved if pasted text was in the middle
+                // of a link.
+                textAttributes.push(...selection.getAttributes());
+                const range = writer.createRangeIn(data.content);
+                for (const item of range.getItems()) {
+                    if (item.is('$textProxy')) {
+                        writer.setAttributes(textAttributes, item);
+                    }
+                }
+            });
+        });
+    }
+}
+/**
+ * Returns true if specified `documentFragment` represents a plain text.
+ */
+function isPlainTextFragment(documentFragment, schema) {
+    if (documentFragment.childCount > 1) {
+        return false;
+    }
+    const child = documentFragment.getChild(0);
+    if (schema.isObject(child)) {
+        return false;
+    }
+    return Array.from(child.getAttributeKeys()).length == 0;
+}

package/src/utils/normalizeclipboarddata.d.ts

@@ -1,15 +1,15 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module clipboard/utils/normalizeclipboarddata
- */
-/**
- * Removes some popular browser quirks out of the clipboard data (HTML).
- * Removes all HTML comments. These are considered an internal thing and it makes little sense if they leak into the editor data.
- *
- * @param data The HTML data to normalize.
- * @returns Normalized HTML.
- */
-export default function normalizeClipboardData(data: string): string;
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module clipboard/utils/normalizeclipboarddata
+ */
+/**
+ * Removes some popular browser quirks out of the clipboard data (HTML).
+ * Removes all HTML comments. These are considered an internal thing and it makes little sense if they leak into the editor data.
+ *
+ * @param data The HTML data to normalize.
+ * @returns Normalized HTML.
+ */
+export default function normalizeClipboardData(data: string): string;

package/src/utils/normalizeclipboarddata.js

@@ -1,27 +1,27 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module clipboard/utils/normalizeclipboarddata
- */
-/**
- * Removes some popular browser quirks out of the clipboard data (HTML).
- * Removes all HTML comments. These are considered an internal thing and it makes little sense if they leak into the editor data.
- *
- * @param data The HTML data to normalize.
- * @returns Normalized HTML.
- */
-export default function normalizeClipboardData(data) {
-    return data
-        .replace(/<span(?: class="Apple-converted-space"|)>(\s+)<\/span>/g, (fullMatch, spaces) => {
-        // Handle the most popular and problematic case when even a single space becomes an nbsp;.
-        // Decode those to normal spaces. Read more in https://github.com/ckeditor/ckeditor5-clipboard/issues/2.
-        if (spaces.length == 1) {
-            return ' ';
-        }
-        return spaces;
-    })
-        // Remove all HTML comments.
-        .replace(/<!--[\s\S]*?-->/g, '');
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module clipboard/utils/normalizeclipboarddata
+ */
+/**
+ * Removes some popular browser quirks out of the clipboard data (HTML).
+ * Removes all HTML comments. These are considered an internal thing and it makes little sense if they leak into the editor data.
+ *
+ * @param data The HTML data to normalize.
+ * @returns Normalized HTML.
+ */
+export default function normalizeClipboardData(data) {
+    return data
+        .replace(/<span(?: class="Apple-converted-space"|)>(\s+)<\/span>/g, (fullMatch, spaces) => {
+        // Handle the most popular and problematic case when even a single space becomes an nbsp;.
+        // Decode those to normal spaces. Read more in https://github.com/ckeditor/ckeditor5-clipboard/issues/2.
+        if (spaces.length == 1) {
+            return ' ';
+        }
+        return spaces;
+    })
+        // Remove all HTML comments.
+        .replace(/<!--[\s\S]*?-->/g, '');
+}

package/src/utils/plaintexttohtml.d.ts

@@ -1,14 +1,14 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module clipboard/utils/plaintexttohtml
- */
-/**
- * Converts plain text to its HTML-ized version.
- *
- * @param text The plain text to convert.
- * @returns HTML generated from the plain text.
- */
-export default function plainTextToHtml(text: string): string;
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module clipboard/utils/plaintexttohtml
+ */
+/**
+ * Converts plain text to its HTML-ized version.
+ *
+ * @param text The plain text to convert.
+ * @returns HTML generated from the plain text.
+ */
+export default function plainTextToHtml(text: string): string;