@ckeditor/ckeditor5-code-block 41.3.0-alpha.4 → 41.3.0

package/dist/types/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-oss-license
- */
-/**
- * @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/types/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-oss-license
- */
-/**
- * @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/types/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-oss-license
- */
-/**
- * @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/types/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-oss-license
- */
-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;
-}

package/dist/types/utils.d.ts

@@ -1,142 +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 code-block/utils
- */
-import type { Editor } from 'ckeditor5/src/core.js';
-import type { CodeBlockLanguageDefinition } from './codeblockconfig.js';
-import type { DocumentSelection, Element, Model, Position, Schema, Text, UpcastWriter, ViewDocumentFragment } from 'ckeditor5/src/engine.js';
-/**
- * Returns code block languages as defined in `config.codeBlock.languages` but processed:
- *
- * * To consider the editor localization, i.e. to display {@link module:code-block/codeblockconfig~CodeBlockLanguageDefinition}
- * in the correct language. There is no way to use {@link module:utils/locale~Locale#t} when the user
- * configuration is defined because the editor does not exist yet.
- * * To make sure each definition has a CSS class associated with it even if not specified
- * in the original configuration.
- */
-export declare function getNormalizedAndLocalizedLanguageDefinitions(editor: Editor): Array<CodeBlockLanguageDefinition>;
-/**
- * Returns an object associating certain language definition properties with others. For instance:
- *
- * For:
- *
- * ```ts
- * const definitions = {
- * 	{ language: 'php', class: 'language-php', label: 'PHP' },
- * 	{ language: 'javascript', class: 'js', label: 'JavaScript' },
- * };
- *
- * getPropertyAssociation( definitions, 'class', 'language' );
- * ```
- *
- * returns:
- *
- * ```ts
- * {
- * 	'language-php': 'php',
- * 	'js': 'javascript'
- * }
- * ```
- *
- * and
- *
- * ```ts
- * getPropertyAssociation( definitions, 'language', 'label' );
- * ```
- *
- * returns:
- *
- * ```ts
- * {
- * 	'php': 'PHP',
- * 	'javascript': 'JavaScript'
- * }
- * ```
- */
-export declare function getPropertyAssociation(languageDefs: Array<CodeBlockLanguageDefinition>, key: keyof CodeBlockLanguageDefinition, value: keyof CodeBlockLanguageDefinition): Record<string, string>;
-/**
- * For a given model text node, it returns white spaces that precede other characters in that node.
- * This corresponds to the indentation part of the code block line.
- */
-export declare function getLeadingWhiteSpaces(textNode: Text): string;
-/**
- * For plain text containing the code (a snippet), it returns a document fragment containing
- * view text nodes separated by `<br>` elements (in place of new line characters "\n"), for instance:
- *
- * Input:
- *
- * ```ts
- * "foo()\n
- * bar()"
- * ```
- *
- * Output:
- *
- * ```html
- * <DocumentFragment>
- * 	"foo()"
- * 	<br/>
- * 	"bar()"
- * </DocumentFragment>
- * ```
- *
- * @param text The raw code text to be converted.
- */
-export declare function rawSnippetTextToViewDocumentFragment(writer: UpcastWriter, text: string): ViewDocumentFragment;
-/**
- * Returns an array of all model positions within the selection that represent code block lines.
- *
- * If the selection is collapsed, it returns the exact selection anchor position:
- *
- * ```html
- * <codeBlock>[]foo</codeBlock>        ->     <codeBlock>^foo</codeBlock>
- * <codeBlock>foo[]bar</codeBlock>     ->     <codeBlock>foo^bar</codeBlock>
- * ```
- *
- * Otherwise, it returns positions **before** each text node belonging to all code blocks contained by the selection:
- *
- * ```html
- * <codeBlock>                                <codeBlock>
- *     foo[bar                                   ^foobar
- *     <softBreak></softBreak>         ->        <softBreak></softBreak>
- *     baz]qux                                   ^bazqux
- * </codeBlock>                               </codeBlock>
- * ```
- *
- * It also works across other non–code blocks:
- *
- * ```html
- * <codeBlock>                                <codeBlock>
- *     foo[bar                                   ^foobar
- * </codeBlock>                               </codeBlock>
- * <paragraph>text</paragraph>         ->     <paragraph>text</paragraph>
- * <codeBlock>                                <codeBlock>
- *     baz]qux                                   ^bazqux
- * </codeBlock>                               </codeBlock>
- * ```
- *
- * **Note:** The positions are in reverse order so they do not get outdated when iterating over them and
- * the writer inserts or removes elements at the same time.
- *
- * **Note:** The position is located after the leading white spaces in the text node.
- */
-export declare function getIndentOutdentPositions(model: Model): Array<Position>;
-/**
- * Checks if any of the blocks within the model selection is a code block.
- */
-export declare function isModelSelectionInCodeBlock(selection: DocumentSelection): boolean;
-/**
- * Checks if an {@link module:engine/model/element~Element Element} can become a code block.
- *
- * @param schema Model's schema.
- * @param element The element to be checked.
- * @returns Check result.
- */
-export declare function canBeCodeBlock(schema: Schema, element: Element): boolean;