@ckeditor/ckeditor5-code-block 0.0.0-nightly-20260602.0 → 0.0.0-nightly-20260604.0

package/dist/codeblockediting.d.ts

@@ -37,4 +37,11 @@ export declare class CodeBlockEditing extends Plugin {
 	* @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/converters.d.ts

@@ -1 +1,131 @@
-export {};
+/**
+* @license Copyright (c) 2003-2026, 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 "@ckeditor/ckeditor5-utils";
+import type { DowncastInsertEvent, Model, UpcastElementEvent, UpcastTextEvent, EditingView } from "@ckeditor/ckeditor5-engine";
+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.
+* @internal
+*/
+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.
+* @internal
+*/
+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.
+* @internal
+*/
+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.
+* @internal
+*/
+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.
+* @internal
+*/
+export declare function dataViewToModelOrphanNodeConsumer(): GetCallback<UpcastElementEvent>;

package/dist/utils.d.ts

@@ -1 +1,193 @@
-export {};
+/**
+* @license Copyright (c) 2003-2026, 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/utils
+*/
+import type { Editor } from "@ckeditor/ckeditor5-core";
+import type { CodeBlockLanguageDefinition } from "./codeblockconfig.js";
+import type { ModelDocumentSelection, ModelElement, Model, ModelPosition, ModelSchema, ModelText, ViewUpcastWriter, ViewDocumentFragment } from "@ckeditor/ckeditor5-engine";
+import { type LocaleTranslate } from "@ckeditor/ckeditor5-utils";
+/**
+* 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.
+*
+* @internal
+*/
+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'
+* }
+* ```
+*
+* @internal
+*/
+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.
+*
+* @internal
+*/
+export declare function getLeadingWhiteSpaces(textNode: ModelText): 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.
+* @internal
+*/
+export declare function rawSnippetTextToViewDocumentFragment(writer: ViewUpcastWriter, 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.
+*
+* @internal
+*/
+export declare function getIndentOutdentPositions(model: Model): Array<ModelPosition>;
+/**
+* Checks if any of the blocks within the model selection is a code block.
+*
+* @internal
+*/
+export declare function isModelSelectionInCodeBlock(selection: ModelDocumentSelection): boolean;
+/**
+* Checks if an {@link module:engine/model/element~ModelElement Element} can become a code block.
+*
+* @param schema Model's schema.
+* @param element The element to be checked.
+* @returns Check result.
+* @internal
+*/
+export declare function canBeCodeBlock(schema: ModelSchema, element: ModelElement): boolean;
+/**
+* Get the translated message read by the screen reader when you enter or exit an element with your cursor.
+*
+* @internal
+*/
+export declare function getCodeBlockAriaAnnouncement(t: LocaleTranslate, languageDefs: Array<CodeBlockLanguageDefinition>, element: ModelElement, direction: "enter" | "leave"): string;
+/**
+* For given position, finds the closest position that is at the beginning of a line of code and returns a text node that is at the
+* beginning of the line (or `null` if there's no text node at the beginning of a given line).
+*
+* Line beings at the start of a code block element and after each `softBreak` element.
+*
+* Note: even though code block doesn't allow inline elements other than `<softBreak>` by default, some features may overwrite this rule,
+* so such inline elements are taken into account.
+*
+* Some examples of expected results:
+*
+* ```
+* <codeBlock>^</codeBlock>                                ->   null
+* <codeBlock>^foobar</codeBlock>                          ->   <codeBlock>[foobar]</codeBlock>
+* <codeBlock>foobar^</codeBlock>                          ->   <codeBlock>[foobar]</codeBlock>
+* <codeBlock>foo^bar</codeBlock>                          ->   <codeBlock>[foobar]</codeBlock>
+* <codeBlock>foo^<softBreak />bar</codeBlock>             ->   <codeBlock>[foo]<softBreak />bar</codeBlock>
+* <codeBlock>foo<softBreak />bar^</codeBlock>             ->   <codeBlock>foo<softBreak />[bar]</codeBlock>
+* <codeBlock>foo<softBreak />b^ar</codeBlock>             ->   <codeBlock>foo<softBreak />[bar]</codeBlock>
+* <codeBlock>foo<softBreak />^bar</codeBlock>             ->   <codeBlock>foo<softBreak />[bar]</codeBlock>
+* <codeBlock>^<element /></codeBlock>                     ->   null
+* <codeBlock><element />^</codeBlock>                     ->   null
+* <codeBlock>foo^<element /></codeBlock>                  ->   <codeBlock>[foo]<element /></codeBlock>
+* <codeBlock>foo<element />^</codeBlock>                  ->   <codeBlock>[foo]<element /></codeBlock>
+* <codeBlock>foo<element />bar^</codeBlock>               ->   <codeBlock>[foo]<element />bar</codeBlock>
+* <codeBlock><element />bar^</codeBlock>                  ->   null
+* <codeBlock>foo<softBreak />^<softBreak /></codeBlock>   ->   null
+* <codeBlock>foo<softBreak />^<element /></codeBlock>     ->   null
+* <codeBlock>foo<softBreak /><element />^</codeBlock>     ->   null
+* <codeBlock>foo<softBreak />bar<element />^</codeBlock>  ->   <codeBlock>foo<softBreak />[bar]<element /></codeBlock>
+* <codeBlock>foo<softBreak /><element />ba^r</codeBlock>  ->   null
+* ```
+*
+* @internal
+*/
+export declare function getTextNodeAtLineStart(position: ModelPosition, model: Model): ModelText | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-code-block",
-  "version": "0.0.0-nightly-20260602.0",
+  "version": "0.0.0-nightly-20260604.0",
   "description": "Code block feature for CKEditor 5.",
   "license": "SEE LICENSE IN LICENSE.md",
   "author": "CKSource (http://cksource.com/)",
@@ -26,13 +26,13 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "0.0.0-nightly-20260602.0",
-    "@ckeditor/ckeditor5-clipboard": "0.0.0-nightly-20260602.0",
-    "@ckeditor/ckeditor5-engine": "0.0.0-nightly-20260602.0",
-    "@ckeditor/ckeditor5-enter": "0.0.0-nightly-20260602.0",
-    "@ckeditor/ckeditor5-icons": "0.0.0-nightly-20260602.0",
-    "@ckeditor/ckeditor5-ui": "0.0.0-nightly-20260602.0",
-    "@ckeditor/ckeditor5-utils": "0.0.0-nightly-20260602.0"
+    "@ckeditor/ckeditor5-core": "0.0.0-nightly-20260604.0",
+    "@ckeditor/ckeditor5-clipboard": "0.0.0-nightly-20260604.0",
+    "@ckeditor/ckeditor5-engine": "0.0.0-nightly-20260604.0",
+    "@ckeditor/ckeditor5-enter": "0.0.0-nightly-20260604.0",
+    "@ckeditor/ckeditor5-icons": "0.0.0-nightly-20260604.0",
+    "@ckeditor/ckeditor5-ui": "0.0.0-nightly-20260604.0",
+    "@ckeditor/ckeditor5-utils": "0.0.0-nightly-20260604.0"
   },
   "files": [
     "dist",