@ckeditor/ckeditor5-block-quote 0.0.0-internal-20241017.0

package/lang/translations/ug.po

@@ -0,0 +1,22 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Uyghur (https://app.transifex.com/ckeditor/teams/11143/ug/)\n"
+"Language: ug\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "Toolbar button tooltip for the Block quote feature."
+msgid "Block quote"
+msgstr "نەقىل"

package/lang/translations/uk.po

@@ -0,0 +1,22 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Ukrainian (https://app.transifex.com/ckeditor/teams/11143/uk/)\n"
+"Language: uk\n"
+"Plural-Forms: nplurals=4; plural=(n % 1 == 0 && n % 10 == 1 && n % 100 != 11 ? 0 : n % 1 == 0 && n % 10 >= 2 && n % 10 <= 4 && (n % 100 < 12 || n % 100 > 14) ? 1 : n % 1 == 0 && (n % 10 ==0 || (n % 10 >=5 && n % 10 <=9) || (n % 100 >=11 && n % 100 <=14 )) ? 2: 3);\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "Toolbar button tooltip for the Block quote feature."
+msgid "Block quote"
+msgstr "Цитата"

package/lang/translations/ur.po

@@ -0,0 +1,22 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Urdu (https://app.transifex.com/ckeditor/teams/11143/ur/)\n"
+"Language: ur\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "Toolbar button tooltip for the Block quote feature."
+msgid "Block quote"
+msgstr "خانہ اقتباس"

package/lang/translations/uz.po

@@ -0,0 +1,22 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Uzbek (https://app.transifex.com/ckeditor/teams/11143/uz/)\n"
+"Language: uz\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "Toolbar button tooltip for the Block quote feature."
+msgid "Block quote"
+msgstr "Iqtibos"

package/lang/translations/vi.po

@@ -0,0 +1,22 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Vietnamese (https://app.transifex.com/ckeditor/teams/11143/vi/)\n"
+"Language: vi\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "Toolbar button tooltip for the Block quote feature."
+msgid "Block quote"
+msgstr "Trích dẫn"

package/lang/translations/zh-cn.po

@@ -0,0 +1,22 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Chinese (China) (https://app.transifex.com/ckeditor/teams/11143/zh_CN/)\n"
+"Language: zh_CN\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "Toolbar button tooltip for the Block quote feature."
+msgid "Block quote"
+msgstr "块引用"

package/lang/translations/zh.po

@@ -0,0 +1,22 @@
+# Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+#
+#                                     !!! IMPORTANT !!!
+#
+#         Before you edit this file, please keep in mind that contributing to the project
+#                translations is possible ONLY via the Transifex online service.
+#
+#         To submit your translations, visit https://www.transifex.com/ckeditor/ckeditor5.
+#
+#                   To learn more, check out the official contributor's guide:
+#     https://ckeditor.com/docs/ckeditor5/latest/framework/guides/contributing/contributing.html
+#
+msgid ""
+msgstr ""
+"Language-Team: Chinese (Taiwan) (https://app.transifex.com/ckeditor/teams/11143/zh_TW/)\n"
+"Language: zh_TW\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+msgctxt "Toolbar button tooltip for the Block quote feature."
+msgid "Block quote"
+msgstr "段落引用"

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@ckeditor/ckeditor5-block-quote",
+  "version": "0.0.0-internal-20241017.0",
+  "description": "Block quote feature for CKEditor 5.",
+  "keywords": [
+    "ckeditor",
+    "ckeditor5",
+    "ckeditor 5",
+    "ckeditor5-feature",
+    "ckeditor5-plugin",
+    "ckeditor5-dll"
+  ],
+  "type": "module",
+  "main": "src/index.js",
+  "dependencies": {
+    "@ckeditor/ckeditor5-core": "0.0.0-internal-20241017.0",
+    "@ckeditor/ckeditor5-enter": "0.0.0-internal-20241017.0",
+    "@ckeditor/ckeditor5-typing": "0.0.0-internal-20241017.0",
+    "@ckeditor/ckeditor5-ui": "0.0.0-internal-20241017.0",
+    "@ckeditor/ckeditor5-utils": "0.0.0-internal-20241017.0",
+    "ckeditor5": "0.0.0-internal-20241017.0"
+  },
+  "author": "CKSource (http://cksource.com/)",
+  "license": "GPL-2.0-or-later",
+  "homepage": "https://ckeditor.com/ckeditor-5",
+  "bugs": "https://github.com/ckeditor/ckeditor5/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ckeditor/ckeditor5.git",
+    "directory": "packages/ckeditor5-block-quote"
+  },
+  "files": [
+    "dist",
+    "lang",
+    "src/**/*.js",
+    "src/**/*.d.ts",
+    "theme",
+    "build",
+    "ckeditor5-metadata.json",
+    "CHANGELOG.md"
+  ],
+  "types": "src/index.d.ts"
+}

package/src/augmentation.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @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 { BlockQuote, BlockQuoteCommand, BlockQuoteEditing, BlockQuoteUI } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [BlockQuote.pluginName]: BlockQuote;
+        [BlockQuoteEditing.pluginName]: BlockQuoteEditing;
+        [BlockQuoteUI.pluginName]: BlockQuoteUI;
+    }
+    interface CommandsMap {
+        blockQuote: BlockQuoteCommand;
+    }
+}

package/src/augmentation.js

@@ -0,0 +1,5 @@
+/**
+ * @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
+ */
+export {};

package/src/blockquote.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @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 block-quote/blockquote
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import BlockQuoteEditing from './blockquoteediting.js';
+import BlockQuoteUI from './blockquoteui.js';
+/**
+ * The block quote plugin.
+ *
+ * For more information about this feature check the {@glink api/block-quote package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:block-quote/blockquoteediting~BlockQuoteEditing block quote editing feature}
+ * and {@link module:block-quote/blockquoteui~BlockQuoteUI block quote UI feature}.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class BlockQuote extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof BlockQuoteEditing, typeof BlockQuoteUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "BlockQuote";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+}

package/src/blockquote.js

@@ -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
+ */
+/**
+ * @module block-quote/blockquote
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import BlockQuoteEditing from './blockquoteediting.js';
+import BlockQuoteUI from './blockquoteui.js';
+/**
+ * The block quote plugin.
+ *
+ * For more information about this feature check the {@glink api/block-quote package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:block-quote/blockquoteediting~BlockQuoteEditing block quote editing feature}
+ * and {@link module:block-quote/blockquoteui~BlockQuoteUI block quote UI feature}.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class BlockQuote extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [BlockQuoteEditing, BlockQuoteUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'BlockQuote';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin() {
+        return true;
+    }
+}

package/src/blockquotecommand.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @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 block-quote/blockquotecommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+/**
+ * The block quote command plugin.
+ *
+ * @extends module:core/command~Command
+ */
+export default class BlockQuoteCommand extends Command {
+    /**
+     * Whether the selection starts in a block quote.
+     *
+     * @observable
+     * @readonly
+     */
+    value: boolean;
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command. When the command {@link #value is on}, all top-most block quotes within
+     * the selection will be removed. If it is off, all selected blocks will be wrapped with
+     * a block quote.
+     *
+     * @fires execute
+     * @param options Command options.
+     * @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply a block quote,
+     * otherwise the command will remove the block quote. If not set, the command will act basing on its current value.
+     */
+    execute(options?: {
+        forceValue?: boolean;
+    }): void;
+    /**
+     * Checks the command's {@link #value}.
+     */
+    private _getValue;
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    private _checkEnabled;
+    /**
+     * Removes the quote from given blocks.
+     *
+     * If blocks which are supposed to be "unquoted" are in the middle of a quote,
+     * start it or end it, then the quote will be split (if needed) and the blocks
+     * will be moved out of it, so other quoted blocks remained quoted.
+     */
+    private _removeQuote;
+    /**
+     * Applies the quote to given blocks.
+     */
+    private _applyQuote;
+}

package/src/blockquotecommand.js

@@ -0,0 +1,172 @@
+/**
+ * @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 block-quote/blockquotecommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+import { first } from 'ckeditor5/src/utils.js';
+/**
+ * The block quote command plugin.
+ *
+ * @extends module:core/command~Command
+ */
+export default class BlockQuoteCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        this.value = this._getValue();
+        this.isEnabled = this._checkEnabled();
+    }
+    /**
+     * Executes the command. When the command {@link #value is on}, all top-most block quotes within
+     * the selection will be removed. If it is off, all selected blocks will be wrapped with
+     * a block quote.
+     *
+     * @fires execute
+     * @param options Command options.
+     * @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply a block quote,
+     * otherwise the command will remove the block quote. If not set, the command will act basing on its current value.
+     */
+    execute(options = {}) {
+        const model = this.editor.model;
+        const schema = model.schema;
+        const selection = model.document.selection;
+        const blocks = Array.from(selection.getSelectedBlocks());
+        const value = (options.forceValue === undefined) ? !this.value : options.forceValue;
+        model.change(writer => {
+            if (!value) {
+                this._removeQuote(writer, blocks.filter(findQuote));
+            }
+            else {
+                const blocksToQuote = blocks.filter(block => {
+                    // Already quoted blocks needs to be considered while quoting too
+                    // in order to reuse their <bQ> elements.
+                    return findQuote(block) || checkCanBeQuoted(schema, block);
+                });
+                this._applyQuote(writer, blocksToQuote);
+            }
+        });
+    }
+    /**
+     * Checks the command's {@link #value}.
+     */
+    _getValue() {
+        const selection = this.editor.model.document.selection;
+        const firstBlock = first(selection.getSelectedBlocks());
+        // In the current implementation, the block quote must be an immediate parent of a block element.
+        return !!(firstBlock && findQuote(firstBlock));
+    }
+    /**
+     * Checks whether the command can be enabled in the current context.
+     *
+     * @returns Whether the command should be enabled.
+     */
+    _checkEnabled() {
+        if (this.value) {
+            return true;
+        }
+        const selection = this.editor.model.document.selection;
+        const schema = this.editor.model.schema;
+        const firstBlock = first(selection.getSelectedBlocks());
+        if (!firstBlock) {
+            return false;
+        }
+        return checkCanBeQuoted(schema, firstBlock);
+    }
+    /**
+     * Removes the quote from given blocks.
+     *
+     * If blocks which are supposed to be "unquoted" are in the middle of a quote,
+     * start it or end it, then the quote will be split (if needed) and the blocks
+     * will be moved out of it, so other quoted blocks remained quoted.
+     */
+    _removeQuote(writer, blocks) {
+        // Unquote all groups of block. Iterate in the reverse order to not break following ranges.
+        getRangesOfBlockGroups(writer, blocks).reverse().forEach(groupRange => {
+            if (groupRange.start.isAtStart && groupRange.end.isAtEnd) {
+                writer.unwrap(groupRange.start.parent);
+                return;
+            }
+            // The group of blocks are at the beginning of an <bQ> so let's move them left (out of the <bQ>).
+            if (groupRange.start.isAtStart) {
+                const positionBefore = writer.createPositionBefore(groupRange.start.parent);
+                writer.move(groupRange, positionBefore);
+                return;
+            }
+            // The blocks are in the middle of an <bQ> so we need to split the <bQ> after the last block
+            // so we move the items there.
+            if (!groupRange.end.isAtEnd) {
+                writer.split(groupRange.end);
+            }
+            // Now we are sure that groupRange.end.isAtEnd is true, so let's move the blocks right.
+            const positionAfter = writer.createPositionAfter(groupRange.end.parent);
+            writer.move(groupRange, positionAfter);
+        });
+    }
+    /**
+     * Applies the quote to given blocks.
+     */
+    _applyQuote(writer, blocks) {
+        const quotesToMerge = [];
+        // Quote all groups of block. Iterate in the reverse order to not break following ranges.
+        getRangesOfBlockGroups(writer, blocks).reverse().forEach(groupRange => {
+            let quote = findQuote(groupRange.start);
+            if (!quote) {
+                quote = writer.createElement('blockQuote');
+                writer.wrap(groupRange, quote);
+            }
+            quotesToMerge.push(quote);
+        });
+        // Merge subsequent <bQ> elements. Reverse the order again because this time we want to go through
+        // the <bQ> elements in the source order (due to how merge works – it moves the right element's content
+        // to the first element and removes the right one. Since we may need to merge a couple of subsequent `<bQ>` elements
+        // we want to keep the reference to the first (furthest left) one.
+        quotesToMerge.reverse().reduce((currentQuote, nextQuote) => {
+            if (currentQuote.nextSibling == nextQuote) {
+                writer.merge(writer.createPositionAfter(currentQuote));
+                return currentQuote;
+            }
+            return nextQuote;
+        });
+    }
+}
+function findQuote(elementOrPosition) {
+    return elementOrPosition.parent.name == 'blockQuote' ? elementOrPosition.parent : null;
+}
+/**
+ * Returns a minimal array of ranges containing groups of subsequent blocks.
+ *
+ * content:         abcdefgh
+ * blocks:          [ a, b, d, f, g, h ]
+ * output ranges:   [ab]c[d]e[fgh]
+ */
+function getRangesOfBlockGroups(writer, blocks) {
+    let startPosition;
+    let i = 0;
+    const ranges = [];
+    while (i < blocks.length) {
+        const block = blocks[i];
+        const nextBlock = blocks[i + 1];
+        if (!startPosition) {
+            startPosition = writer.createPositionBefore(block);
+        }
+        if (!nextBlock || block.nextSibling != nextBlock) {
+            ranges.push(writer.createRange(startPosition, writer.createPositionAfter(block)));
+            startPosition = null;
+        }
+        i++;
+    }
+    return ranges;
+}
+/**
+ * Checks whether <bQ> can wrap the block.
+ */
+function checkCanBeQuoted(schema, block) {
+    // TMP will be replaced with schema.checkWrap().
+    const isBQAllowed = schema.checkChild(block.parent, 'blockQuote');
+    const isBlockAllowedInBQ = schema.checkChild(['$root', 'blockQuote'], block);
+    return isBQAllowed && isBlockAllowedInBQ;
+}

package/src/blockquoteediting.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @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 block-quote/blockquoteediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { Enter } from 'ckeditor5/src/enter.js';
+import { Delete } from 'ckeditor5/src/typing.js';
+/**
+ * The block quote editing.
+ *
+ * Introduces the `'blockQuote'` command and the `'blockQuote'` model element.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class BlockQuoteEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "BlockQuoteEditing";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof Enter, typeof Delete];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}