@ckeditor/ckeditor5-code-block 44.1.0 → 44.2.0-alpha.1

package/dist/augmentation.d.ts

@@ -1,29 +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-licensing-options
- */
-import type { CodeBlock, CodeBlockCommand, CodeBlockConfig, CodeBlockEditing, CodeBlockUI, IndentCodeBlockCommand, OutdentCodeBlockCommand } from './index.js';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the {@link module:code-block/codeblock~CodeBlock} feature.
-         *
-         * Read more in {@link module:code-block/codeblockconfig~CodeBlockConfig}.
-         */
-        codeBlock?: CodeBlockConfig;
-    }
-    interface PluginsMap {
-        [CodeBlock.pluginName]: CodeBlock;
-        [CodeBlockEditing.pluginName]: CodeBlockEditing;
-        [CodeBlockUI.pluginName]: CodeBlockUI;
-    }
-    interface CommandsMap {
-        codeBlock: CodeBlockCommand;
-        indentCodeBlock: IndentCodeBlockCommand;
-        outdentCodeBlock: OutdentCodeBlockCommand;
-    }
-}

package/dist/codeblock.d.ts

@@ -1,37 +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-licensing-options
- */
-/**
- * @module code-block/codeblock
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import CodeBlockEditing from './codeblockediting.js';
-import CodeBlockUI from './codeblockui.js';
-/**
- * The code block plugin.
- *
- * For more information about this feature check the {@glink api/code-block package page} and the
- * {@glink features/code-blocks code block} feature guide.
- *
- * This is a "glue" plugin that loads the {@link module:code-block/codeblockediting~CodeBlockEditing code block editing feature}
- * and the {@link module:code-block/codeblockui~CodeBlockUI code block UI feature}.
- */
-export default class CodeBlock extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof CodeBlockEditing, typeof CodeBlockUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CodeBlock";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-}

package/dist/codeblockcommand.d.ts

@@ -1,64 +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-licensing-options
- */
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-/**
- * The code block command plugin.
- */
-export default class CodeBlockCommand extends Command {
-    /**
-     * Contains the last used language.
-     */
-    private _lastLanguage;
-    /**
-     * Contains language if any is selected, false otherwise.
-     * @observable
-     * @readonly
-     */
-    value: string | false;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command. When the command {@link #value is on}, all topmost code blocks within
-     * the selection will be removed. If it is off, all selected blocks will be flattened and
-     * wrapped by a code block.
-     *
-     * @fires execute
-     * @param options Command options.
-     * @param options.language The code block language.
-     * @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply a code block,
-     * otherwise the command will remove the code block. If not set, the command will act basing on its current value.
-     * @param options.usePreviousLanguageChoice If set on `true` and the `options.language` is not specified, the command
-     * will apply the previous language (if the command was already executed) when inserting the `codeBlock` element.
-     */
-    execute(options?: {
-        language?: string;
-        forceValue?: boolean;
-        usePreviousLanguageChoice?: boolean;
-    }): void;
-    /**
-     * Checks the command's {@link #value}.
-     *
-     * @returns The current value.
-     */
-    private _getValue;
-    /**
-     * Checks whether the command can be enabled in the current context.
-     *
-     * @returns Whether the command should be enabled.
-     */
-    private _checkEnabled;
-    private _applyCodeBlock;
-    private _removeCodeBlock;
-}

package/dist/codeblockconfig.d.ts

@@ -1,150 +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-licensing-options
- */
-/**
- * @module code-block/codeblockconfig
- */
-/**
- * The configuration of the {@link module:code-block/codeblock~CodeBlock code block feature}.
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		codeBlock:  ... // The code block feature configuration.
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface CodeBlockConfig {
-    /**
-     * The list of code languages available in the user interface to choose for a particular code block.
-     *
-     * The language of the code block is represented as a CSS class (by default prefixed by "language-") set on the
-     * `<code>` element, both when editing and in the editor data. The CSS class associated with the language
-     * can be used by third–party code syntax highlighters to detect and apply the correct highlighting.
-     *
-     * For instance, this language configuration:
-     *
-     * ```ts
-     * ClassicEditor
-     * 	.create( document.querySelector( '#editor' ), {
-     * 		codeBlock: {
-     * 			languages: [
-     * 				// ...
-     * 				{ language: 'javascript', label: 'JavaScript' },
-     * 				// ...
-     * 			]
-     * 		}
-     * 	} )
-     * 	.then( ... )
-     * 	.catch( ... );
-     * ```
-     *
-     * will result in the following structure of JavaScript code blocks in the editor editing and data:
-     *
-     * ```html
-     * <pre><code class="language-javascript">window.alert( 'Hello world!' )</code></pre>
-     * ```
-     *
-     * You can customize the CSS class by specifying an optional `class` property in the language definition.
-     * You can set **multiple classes** but **only the first one** will be used as defining language class:
-     *
-     * ```ts
-     * ClassicEditor
-     * 	.create( document.querySelector( '#editor' ), {
-     * 		codeBlock: {
-     * 			languages: [
-     * 				// Do not render the CSS class for the plain text code blocks.
-     * 				{ language: 'plaintext', label: 'Plain text', class: '' },
-     *
-     * 				// Use the "php-code" class for PHP code blocks.
-     * 				{ language: 'php', label: 'PHP', class: 'php-code' },
-     *
-     * 				// Use the "js" class for JavaScript code blocks.
-     * 				// Note that only the first ("js") class will determine the language of the block when loading data.
-     * 				{ language: 'javascript', label: 'JavaScript', class: 'js javascript js-code' },
-     *
-     * 				// Python code blocks will have the default "language-python" CSS class.
-     * 				{ language: 'python', label: 'Python' }
-     * 			]
-     * 		}
-     * } )
-     * .then( ... )
-     * .catch( ... );
-     * ```
-     *
-     * The default value of the language configuration is as follows:
-     *
-     * ```ts
-     * languages: [
-     * 	{ language: 'plaintext', label: 'Plain text' }, // The default language.
-     * 	{ language: 'c', label: 'C' },
-     * 	{ language: 'cs', label: 'C#' },
-     * 	{ language: 'cpp', label: 'C++' },
-     * 	{ language: 'css', label: 'CSS' },
-     * 	{ language: 'diff', label: 'Diff' },
-     * 	{ language: 'html', label: 'HTML' },
-     * 	{ language: 'java', label: 'Java' },
-     * 	{ language: 'javascript', label: 'JavaScript' },
-     * 	{ language: 'php', label: 'PHP' },
-     * 	{ language: 'python', label: 'Python' },
-     * 	{ language: 'ruby', label: 'Ruby' },
-     * 	{ language: 'typescript', label: 'TypeScript' },
-     * 	{ language: 'xml', label: 'XML' }
-     * ]
-     * ```
-     *
-     * **Note**: The first language defined in the configuration is considered the default one. This means it will be
-     * applied to code blocks loaded from the data that have no CSS `class` specified (or no matching `class` in the configuration).
-     * It will also be used when creating new code blocks using the main UI button. By default it is "Plain text".
-     */
-    languages?: Array<CodeBlockLanguageDefinition>;
-    /**
-     * A sequence of characters inserted or removed from the code block lines when its indentation
-     * is changed by the user, for instance, using <kbd>Tab</kbd> and <kbd>Shift</kbd>+<kbd>Tab</kbd> keys.
-     *
-     * The default value is a single tab character ("	", `\u0009` in Unicode).
-     *
-     * This configuration is used by `indentCodeBlock` and `outdentCodeBlock` commands (instances of
-     * {@link module:code-block/indentcodeblockcommand~IndentCodeBlockCommand}).
-     *
-     * **Note**: Setting this configuration to `false` will disable the code block indentation commands
-     * and associated keystrokes.
-     *
-     */
-    indentSequence?: string;
-}
-/**
- * The code block language descriptor. See {@link module:code-block/codeblockconfig~CodeBlockConfig#languages} to learn more.
- *
- * ```ts
- * {
- * 	language: 'javascript',
- * 	label: 'JavaScript'
- * }
- * ```
- */
-export interface CodeBlockLanguageDefinition {
-    /**
-     * The name of the language that will be stored in the model attribute. Also, when `class`
-     * is not specified, it will be used to create the CSS class associated with the language (prefixed by "language-").
-     */
-    language: string;
-    /**
-     * The human–readable label associated with the language and displayed in the UI.
-     */
-    label: string;
-    /**
-     * The CSS class associated with the language. When not specified the `language`
-     * property is used to create a class prefixed by "language-".
-     */
-    class?: string;
-}

package/dist/codeblockediting.d.ts

@@ -1,51 +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-licensing-options
- */
-/**
- * @module code-block/codeblockediting
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import { ShiftEnter } from 'ckeditor5/src/enter.js';
-/**
- * The editing part of the code block feature.
- *
- * Introduces the `'codeBlock'` command and the `'codeBlock'` model element.
- */
-export default class CodeBlockEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CodeBlockEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ShiftEnter];
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Observe when user enters or leaves code block and set proper aria value in global live announcer.
-     * This allows screen readers to indicate when the user has entered and left the specified code block.
-     *
-     * @internal
-     */
-    private _initAriaAnnouncements;
-}

package/dist/codeblockui.d.ts

@@ -1,37 +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-licensing-options
- */
-/**
- * @module code-block/codeblockui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import '../theme/codeblock.css';
-/**
- * The code block UI plugin.
- *
- * Introduces the `'codeBlock'` dropdown.
- */
-export default class CodeBlockUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "CodeBlockUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * A helper returning a collection of the `codeBlock` dropdown items representing languages
-     * available for the user to choose from.
-     */
-    private _getLanguageListItemDefinitions;
-}

package/dist/converters.d.ts

@@ -1,130 +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-licensing-options
- */
-/**
- * @module code-block/converters
- */
-import type { GetCallback } from 'ckeditor5/src/utils.js';
-import type { DowncastInsertEvent, Model, UpcastElementEvent, UpcastTextEvent, EditingView } from 'ckeditor5/src/engine.js';
-import type { CodeBlockLanguageDefinition } from './codeblockconfig.js';
-/**
- * A model-to-view (both editing and data) converter for the `codeBlock` element.
- *
- * Sample input:
- *
- * ```html
- * <codeBlock language="javascript">foo();<softBreak></softBreak>bar();</codeBlock>
- * ```
- *
- * Sample output (editing):
- *
- * ```html
- * <pre data-language="JavaScript"><code class="language-javascript">foo();<br />bar();</code></pre>
- * ```
- *
- * Sample output (data, see {@link module:code-block/converters~modelToDataViewSoftBreakInsertion}):
- *
- * ```html
- * <pre><code class="language-javascript">foo();\nbar();</code></pre>
- * ```
- *
- * @param languageDefs The normalized language configuration passed to the feature.
- * @param useLabels When `true`, the `<pre>` element will get a `data-language` attribute with a
- * human–readable label of the language. Used only in the editing.
- * @returns Returns a conversion callback.
- */
-export declare function modelToViewCodeBlockInsertion(model: Model, languageDefs: Array<CodeBlockLanguageDefinition>, useLabels?: boolean): GetCallback<DowncastInsertEvent>;
-/**
- * A model-to-data view converter for the new line (`softBreak`) separator.
- *
- * Sample input:
- *
- * ```html
- * <codeBlock ...>foo();<softBreak></softBreak>bar();</codeBlock>
- * ```
- *
- * Sample output:
- *
- * ```html
- * <pre><code ...>foo();\nbar();</code></pre>
- * ```
- *
- * @returns Returns a conversion callback.
- */
-export declare function modelToDataViewSoftBreakInsertion(model: Model): GetCallback<DowncastInsertEvent>;
-/**
- * A view-to-model converter for `<pre>` with the `<code>` HTML.
- *
- * Sample input:
- *
- * ```html
- * <pre><code class="language-javascript">foo();bar();</code></pre>
- * ```
- *
- * Sample output:
- *
- * ```html
- * <codeBlock language="javascript">foo();bar();</codeBlock>
- * ```
- *
- * @param languageDefs The normalized language configuration passed to the feature.
- * @returns Returns a conversion callback.
- */
-export declare function dataViewToModelCodeBlockInsertion(editingView: EditingView, languageDefs: Array<CodeBlockLanguageDefinition>): GetCallback<UpcastElementEvent>;
-/**
- * A view-to-model converter for new line characters in `<pre>`.
- *
- * Sample input:
- *
- * ```html
- * <pre><code class="language-javascript">foo();\nbar();</code></pre>
- * ```
- *
- * Sample output:
- *
- * ```html
- * <codeBlock language="javascript">foo();<softBreak></softBreak>bar();</codeBlock>
- * ```
- *
- * @returns {Function} Returns a conversion callback.
- */
-export declare function dataViewToModelTextNewlinesInsertion(): GetCallback<UpcastTextEvent>;
-/**
- * A view-to-model converter that handles orphan text nodes (white spaces, new lines, etc.)
- * that surround `<code>` inside `<pre>`.
- *
- * Sample input:
- *
- * ```html
- * // White spaces
- * <pre> <code>foo()</code> </pre>
- *
- * // White spaces
- * <pre>      <code>foo()</code>      </pre>
- *
- * // White spaces
- * <pre>			<code>foo()</code>			</pre>
- *
- * // New lines
- * <pre>
- * 	<code>foo()</code>
- * </pre>
- *
- * // Redundant text
- * <pre>ABC<code>foo()</code>DEF</pre>
- * ```
- *
- * Unified output for each case:
- *
- * ```html
- * <codeBlock language="plaintext">foo()</codeBlock>
- * ```
- *
- * @returns Returns a conversion callback.
- */
-export declare function dataViewToModelOrphanNodeConsumer(): GetCallback<UpcastElementEvent>;

package/dist/indentcodeblockcommand.d.ts

@@ -1,37 +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-licensing-options
- */
-/**
- * @module code-block/indentcodeblockcommand
- */
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-/**
- * The code block indentation increase command plugin.
- */
-export default class IndentCodeBlockCommand extends Command {
-    /**
-     * A sequence of characters added to the line when the command is executed.
-     */
-    private _indentSequence;
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command. When the command {@link #isEnabled is enabled}, the indentation of the
-     * code lines in the selection will be increased.
-     *
-     * @fires execute
-     */
-    execute(): void;
-    /**
-     * Checks whether the command can be enabled in the current context.
-     */
-    private _checkEnabled;
-}

package/dist/index.d.ts

@@ -1,19 +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-licensing-options
- */
-/**
- * @module code-block
- */
-export { default as CodeBlock } from './codeblock.js';
-export { default as CodeBlockEditing } from './codeblockediting.js';
-export { default as CodeBlockUI } from './codeblockui.js';
-export type { default as CodeBlockCommand } from './codeblockcommand.js';
-export type { default as IndentCodeBlockCommand } from './indentcodeblockcommand.js';
-export type { default as OutdentCodeBlockCommand } from './outdentcodeblockcommand.js';
-export type { CodeBlockConfig } from './codeblockconfig.js';
-import './augmentation.js';

package/dist/outdentcodeblockcommand.d.ts

@@ -1,37 +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-licensing-options
- */
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-/**
- * The code block indentation decrease command plugin.
- */
-export default class OutdentCodeBlockCommand extends Command {
-    /**
-     * A sequence of characters removed from the line when the command is executed.
-     */
-    private readonly _indentSequence;
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command. When the command {@link #isEnabled is enabled}, the indentation of the
-     * code lines in the selection will be decreased.
-     *
-     * @fires execute
-     */
-    execute(): void;
-    /**
-     * Checks whether the command can be enabled in the current context.
-     *
-     * @private
-     * @returns {Boolean} Whether the command should be enabled.
-     */
-    private _checkEnabled;
-}