Export and add internal tags for entities indended to be internal. (#18644)

Internal: Export and add internal tags for entities intended to be internal.

Author: Mati365

docs/_snippets/framework/tutorials/inline-widget.js

@@ -16,7 +16,7 @@ import {
 	Widget,
 	toWidget,
 	viewToModelPositionOutsideModelElement,
-	ViewModel,
+	UIModel,
 	addListToDropdown,
 	createDropdown,
 	Collection
@@ -106,7 +106,7 @@ function getDropdownItemsDefinitions( placeholderNames ) {
 	for ( const name of placeholderNames ) {
 		const definition = {
 			type: 'button',
-			model: new ViewModel( {
+			model: new UIModel( {
 				commandParam: name,
 				label: name,
 				withText: true

docs/_snippets/framework/ui/ui-dropdown.js

@@ -10,7 +10,7 @@ import {
 	addListToDropdown,
 	addToolbarToDropdown,
 	createDropdown,
-	ViewModel,
+	UIModel,
 	IconBold,
 	IconItalic,
 	Collection,
@@ -22,14 +22,14 @@ const locale = new Locale();
 const collection = new Collection();
 collection.add( {
 	type: 'button',
-	model: new ViewModel( {
+	model: new UIModel( {
 		label: 'Button',
 		withText: true
 	} )
 } );
 collection.add( {
 	type: 'switchbutton',
-	model: new ViewModel( {
+	model: new UIModel( {
 		label: 'Switch button',
 		withText: true
 	} )

docs/framework/architecture/ui-components.md

@@ -344,22 +344,22 @@ import {
     Collection,
     createDropdown,
     Locale,
-    ViewModel
+    UIModel
 } from 'ckeditor5';
 
 const locale = new Locale();
 
 const collection = new Collection();
 collection.add( {
 	type: 'button',
-	model: new ViewModel( {
+	model: new UIModel( {
 		label: 'Button',
 		withText: true
 	} )
 } );
 collection.add( {
 	type: 'switchbutton',
-	model: new ViewModel( {
+	model: new UIModel( {
 		label: 'Switch button',
 		withText: true
 	} )

docs/framework/architecture/ui-library.md

@@ -399,7 +399,7 @@ The {@link module:ui/list/listview~ListView} can be added to a dropdown using th
 
 <code-switcher>
 ```js
-import { ViewModel, addListToDropdown, createDropdown, Collection } from 'ckeditor5';
+import { UIModel, addListToDropdown, createDropdown, Collection } from 'ckeditor5';
 
 // The default dropdown.
 const dropdownView = createDropdown( locale );
@@ -409,15 +409,15 @@ const items = new Collection();
 
 items.add( {
 	type: 'button',
-	model: new ViewModel( {
+	model: new UIModel( {
 		withText: true,
 		label: 'Foo'
 	} )
 } );
 
 items.add( {
 	type: 'button',
-	model: new ViewModel( {
+	model: new UIModel( {
 		withText: true,
 		label: 'Bar'
 	} )

docs/tutorials/widgets/implementing-an-inline-widget.md

@@ -11,7 +11,7 @@ In this tutorial, you will learn how to implement an inline widget. You will bui
 <info-box warning>
 	**We have an official implementation of this feature!**
 
-	While this tutorial was created for learning purposes, it only offers a basic, simplified solution. We have an official implementation of this mechanism, called the {@link features/merge-fields merge fields} feature. It is much more robust than the solution presented here, and offers many configuration options. 
+	While this tutorial was created for learning purposes, it only offers a basic, simplified solution. We have an official implementation of this mechanism, called the {@link features/merge-fields merge fields} feature. It is much more robust than the solution presented here, and offers many configuration options.
 info-box>
 
 First, you will use widget utilities and conversion to define the behavior of this feature. Later on, you will use dropdown utilities to create a dropdown that will allow for inserting new placeholders. You will also learn how to use the editor configuration to define allowed placeholder names.
@@ -444,7 +444,7 @@ In this tutorial, you will create a dropdown with a list of available placeholde
 
 import {
 	Plugin,
-	ViewModel,
+	UIModel,
 	addListToDropdown,
 	createDropdown,
 	Collection
@@ -493,7 +493,7 @@ function getDropdownItemsDefinitions( placeholderNames ) {
 	for ( const name of placeholderNames ) {
 		const definition = {
 			type: 'button',
-			model: new ViewModel( {
+			model: new UIModel( {
 				commandParam: name,
 				label: name,
 				withText: true

packages/ckeditor5-adapter-ckfinder/src/index.ts

@@ -8,5 +8,10 @@
  */
 
 export { CKFinderUploadAdapter } from './uploadadapter.js';
+export {
+	getCsrfToken as _getCKFinderCsrfToken,
+	getCookie as _getCKFinderCookie,
+	setCookie as _setCKFinderCookie
+} from './utils.js';
 
 import './augmentation.js';

packages/ckeditor5-adapter-ckfinder/src/utils.ts

@@ -15,6 +15,8 @@ const tokenCharset = 'abcdefghijklmnopqrstuvwxyz0123456789';
  * Returns the CSRF token value. The value is a hash stored in `document.cookie`
  * under the `ckCsrfToken` key. The CSRF token can be used to secure the communication
  * between the web browser and the CKFinder server.
+ *
+ * @internal
  */
 export function getCsrfToken(): string {
 	let token = getCookie( TOKEN_COOKIE_NAME );
@@ -29,6 +31,8 @@ export function getCsrfToken(): string {
 
 /**
  * Returns the value of the cookie with a given name or `null` if the cookie is not found.
+ *
+ * @internal
  */
 export function getCookie( name: string ): string | null {
 	name = name.toLowerCase();
@@ -48,6 +52,8 @@ export function getCookie( name: string ): string | null {
 
 /**
  * Sets the value of the cookie with a given name.
+ *
+ * @internal
  */
 export function setCookie( name: string, value: string ): void {
 	document.cookie = encodeURIComponent( name ) + '=' + encodeURIComponent( value ) + ';path=/';

packages/ckeditor5-alignment/src/index.ts

@@ -13,4 +13,11 @@ export { AlignmentUI } from './alignmentui.js';
 export { AlignmentCommand } from './alignmentcommand.js';
 export type { AlignmentConfig } from './alignmentconfig.js';
 
+export {
+	supportedOptions as _ALIGNMENT_SUPPORTED_OPTIONS,
+	isSupported as _isAlignmentSupported,
+	isDefault as _isDefaultAlignment,
+	normalizeAlignmentOptions as _normalizeAlignmentOptions
+} from './utils.js';
+
 import './augmentation.js';

packages/ckeditor5-alignment/src/utils.ts

@@ -17,12 +17,15 @@ import type { AlignmentFormat, SupportedOption } from './alignmentconfig.js';
  * * `'right'`,
  * * `'center'`,
  * * `'justify'`
+ *
+ * @internal
  */
 export const supportedOptions: ReadonlyArray<SupportedOption> = [ 'left', 'right', 'center', 'justify' ];
 
 /**
  * Checks whether the passed option is supported by {@link module:alignment/alignmentediting~AlignmentEditing}.
  *
+ * @internal
  * @param option The option value to check.
  */
 export function isSupported( option: string ): boolean {
@@ -33,6 +36,7 @@ export function isSupported( option: string ): boolean {
  * Checks whether alignment is the default one considering the direction
  * of the editor content.
  *
+ * @internal
  * @param alignment The name of the alignment to check.
  * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
  */
@@ -49,6 +53,7 @@ export function isDefault( alignment: string, locale: Locale ): boolean {
 /**
  * Brings the configuration to the common form, an array of objects.
  *
+ * @internal
  * @param configuredOptions Alignment plugin configuration.
  * @returns Normalized object holding the configuration.
  */

packages/ckeditor5-basic-styles/src/index.ts

@@ -30,4 +30,6 @@ export { UnderlineEditing } from './underline/underlineediting.js';
 export { UnderlineUI } from './underline/underlineui.js';
 export { AttributeCommand } from './attributecommand.js';
 
+export { getButtonCreator as _getBasicStylesButtonCreator } from './utils.js';
+
 import './augmentation.js';

packages/ckeditor5-basic-styles/src/utils.ts

@@ -13,6 +13,8 @@ import { MenuBarMenuListItemButtonView, type ButtonView } from 'ckeditor5/src/ui
 
 /**
  * Returns a function that creates a (toolbar or menu bar) button for a basic style feature.
+ *
+ * @internal
  */
 export function getButtonCreator( {
 	editor, commandName, plugin, icon, label, keystroke

packages/ckeditor5-bookmark/src/index.ts

@@ -15,4 +15,6 @@ export { UpdateBookmarkCommand } from './updatebookmarkcommand.js';
 
 export type { BookmarkConfig } from './bookmarkconfig.js';
 
+export { isBookmarkIdValid as _isBookmarkIdValid } from './utils.js';
+
 import './augmentation.js';

packages/ckeditor5-bookmark/src/utils.ts

@@ -9,6 +9,8 @@
 
 /**
  * Returns `true` if the bookmark id is valid; otherwise, returns `false`.
+ *
+ * @internal
  */
 export function isBookmarkIdValid( id: string ): boolean {
 	if ( !id || typeof id !== 'string' ) {

packages/ckeditor5-ckbox/src/ckboxconfig.ts

@@ -279,13 +279,17 @@ export interface CKBoxUploadConfig {
  * Asset definition.
  *
  * The definition contains the unique `id`, asset `type` and an `attributes` definition.
+ *
+ * @internal
  */
 export type CKBoxAssetDefinition = CKBoxAssetImageDefinition | CKBoxAssetLinkDefinition;
 
 /**
  * Image asset definition.
  *
  * The definition contains the unique `id`, asset `type` and an `attributes` definition.
+ *
+ * @internal
  */
 export interface CKBoxAssetImageDefinition {
 
@@ -309,6 +313,8 @@ export interface CKBoxAssetImageDefinition {
  * Link asset definition.
  *
  * The definition contains the unique `id`, asset `type` and an `attributes` definition.
+ *
+ * @internal
  */
 export interface CKBoxAssetLinkDefinition {
 
@@ -357,6 +363,8 @@ export interface CKBoxAssetLinkDefinition {
  * 	imageTextAlternative: 'An alternative text for the image'
  * }
  * ```
+ *
+ * @internal
  */
 export interface CKBoxAssetImageAttributesDefinition {
 
@@ -406,6 +414,8 @@ export interface CKBoxAssetImageAttributesDefinition {
  * 	linkHref: 'https://example.com/assets/asset-id/file.pdf'
  * }
  * ```
+ *
+ * @internal
  */
 export interface CKBoxAssetLinkAttributesDefinition {
 

packages/ckeditor5-ckbox/src/index.ts

@@ -18,4 +18,25 @@ export { CKBoxImageEditCommand } from './ckboximageedit/ckboximageeditcommand.js
 
 export type { CKBoxConfig } from './ckboxconfig.js';
 
+export {
+	getImageUrls as _getCKBoxImageUrls,
+	getWorkspaceId as _getCKBoxWorkspaceId,
+	blurHashToDataUrl as _ckboxBlurHashToDataUrl,
+	sendHttpRequest as _sendCKBoxHttpRequest,
+	convertMimeTypeToExtension as _ckBoxConvertMimeTypeToExtension,
+	getContentTypeOfUrl as _getCKBoxContentTypeOfUrl,
+	getFileExtension as _getCKBoxFileExtension
+} from './utils.js';
+
+export type {
+	CKBoxAssetDefinition as _CKBoxAssetDefinition,
+	CKBoxAssetImageDefinition as _CKBoxAssetImageDefinition,
+	CKBoxAssetLinkDefinition as _CKBoxAssetLinkDefinition,
+	CKBoxAssetImageAttributesDefinition as _CKBoxAssetImageAttributesDefinition,
+	CKBoxAssetLinkAttributesDefinition as _CKBoxAssetLinkAttributesDefinition
+} from './ckboxconfig.js';
+
+export { createEditabilityChecker as _createCKBoxEditabilityChecker } from './ckboximageedit/utils.js';
+export { prepareImageAssetAttributes as _prepareCKBoxImageAssetAttributes } from './ckboxcommand.js';
+
 import './augmentation.js';

packages/ckeditor5-ckbox/src/utils.ts

@@ -16,6 +16,8 @@ import { decode } from 'blurhash';
  * Converts image source set provided by the CKBox into an object containing:
  * - responsive URLs for the "webp" image format,
  * - one fallback URL for browsers that do not support the "webp" format.
+ *
+ * @internal
  */
 export function getImageUrls( imageUrls: CKBoxImageUrls ): {
 	imageFallbackUrl: string;
@@ -56,6 +58,7 @@ export function getImageUrls( imageUrls: CKBoxImageUrls ): {
  * Returns a workspace id to use for communication with the CKBox service.
  *
  * @param defaultWorkspaceId The default workspace to use taken from editor config.
+ * @internal
  */
 export function getWorkspaceId( token: InitializedToken, defaultWorkspaceId?: string ): string | null {
 	const [ , binaryTokenPayload ] = token.value.split( '.' );
@@ -81,6 +84,8 @@ const BLUR_RESOLUTION = 32;
 
 /**
  * Generates an image data URL from its `blurhash` representation.
+ *
+ * @internal
  */
 export function blurHashToDataUrl( hash?: string ): string | undefined {
 	if ( !hash ) {
@@ -205,13 +210,17 @@ const MIME_TO_EXTENSION: Record = {
 
 /**
  * Returns an extension a typical file in the specified `mimeType` format would have.
+ *
+ * @internal
  */
 export function convertMimeTypeToExtension( mimeType: string ): string {
 	return MIME_TO_EXTENSION[ mimeType ];
 }
 
 /**
  * Tries to fetch the given `url` and returns 'content-type' of the response.
+ *
+ * @internal
  */
 export async function getContentTypeOfUrl( url: string, options: { signal: AbortSignal } ): Promise<string> {
 	try {
@@ -233,6 +242,8 @@ export async function getContentTypeOfUrl( url: string, options: { signal: Abort
 
 /**
  * Returns an extension from the given value.
+ *
+ * @internal
  */
 export function getFileExtension( file: File ): string {
 	const fileName = file.name;

packages/ckeditor5-ckbox/tests/ckboxui.js

@@ -14,7 +14,7 @@ import { CloudServices } from '@ckeditor/ckeditor5-cloud-services/src/cloudservi
 import { ClassicTestEditor } from '@ckeditor/ckeditor5-core/tests/_utils/classictesteditor.js';
 import { CloudServicesCoreMock } from './_utils/cloudservicescoremock.js';
 import { ImageInsertUI } from '@ckeditor/ckeditor5-image/src/imageinsert/imageinsertui.js';
-import { ViewModel } from '@ckeditor/ckeditor5-ui/src/model.js';
+import { UIModel } from '@ckeditor/ckeditor5-ui/src/model.js';
 import { testUtils } from '@ckeditor/ckeditor5-core/tests/_utils/utils.js';
 import { IconImageAssetManager, IconBrowseFiles } from 'ckeditor5/src/icons.js';
 
@@ -265,7 +265,7 @@ describe( 'CKBoxUI', () => {
 
 	function mockAnotherIntegration() {
 		const insertImageUI = editor.plugins.get( 'ImageInsertUI' );
-		const observable = new ViewModel( { isEnabled: true } );
+		const observable = new UIModel( { isEnabled: true } );
 
 		insertImageUI.registerIntegration( {
 			name: 'url',

packages/ckeditor5-ckfinder/tests/ckfinderui.js

@@ -15,7 +15,7 @@ import { ButtonView } from '@ckeditor/ckeditor5-ui/src/button/buttonview.js';
 import { MenuBarMenuListItemButtonView } from '@ckeditor/ckeditor5-ui/src/menubar/menubarmenulistitembuttonview.js';
 
 import { CKFinder } from '../src/ckfinder.js';
-import { ViewModel } from '@ckeditor/ckeditor5-ui/src/model.js';
+import { UIModel } from '@ckeditor/ckeditor5-ui/src/model.js';
 import { CKFinderUI } from '../src/ckfinderui.js';
 
 describe( 'CKFinderUI', () => {
@@ -204,7 +204,7 @@ describe( 'CKFinderUI', () => {
 
 	function mockAnotherIntegration() {
 		const insertImageUI = editor.plugins.get( 'ImageInsertUI' );
-		const observable = new ViewModel( { isEnabled: true } );
+		const observable = new UIModel( { isEnabled: true } );
 
 		insertImageUI.registerIntegration( {
 			name: 'url',