@ckeditor/ckeditor5-template 44.1.0 → 44.2.0-alpha.0

package/dist/augmentation.d.ts

@@ -1,27 +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 { Template, TemplateCommand, TemplateEditing, TemplateUI, TemplateConfig } from './index.js';
-declare module '@ckeditor/ckeditor5-core' {
-    interface PluginsMap {
-        [Template.pluginName]: Template;
-        [TemplateEditing.pluginName]: TemplateEditing;
-        [TemplateUI.pluginName]: TemplateUI;
-    }
-    interface CommandsMap {
-        insertTemplate: TemplateCommand;
-    }
-    interface EditorConfig {
-        /**
-         * The configuration of the {@link module:template/template~Template} feature.
-         *
-         * Read more in {@link module:template/template~TemplateConfig}.
-         */
-        template?: TemplateConfig;
-    }
-}

package/dist/index.d.ts

@@ -1,17 +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 template
- */
-export { default as Template } from './template.js';
-export { default as TemplateCommand } from './templatecommand.js';
-export { default as TemplateEditing } from './templateediting.js';
-export { default as TemplateUI } from './templateui.js';
-export type { TemplateConfig, TemplateDefinition } from './template.js';
-import './augmentation.js';

package/dist/legacyerrors.d.ts

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

package/dist/template.d.ts

@@ -1,127 +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 template/template
- * @publicApi
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import TemplateEditing from './templateediting.js';
-import TemplateUI from './templateui.js';
-/**
- * The template feature.
- *
- * For a detailed overview, check the {@glink features/template Content templates} feature guide.
- */
-export default class Template extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TemplateEditing, typeof TemplateUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Template";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-}
-/**
- * The configuration of the template feature.
- *
- * ```ts
- * ClassicEditor
- *	.create( {
- * 		template: ... // Template feature configuration.
- *	} )
- *	.then( ... )
- *	.catch( ... );
- *```
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface TemplateConfig {
-    /**
-     * A list of all template definitions to be displayed in the `'insertTemplate'` UI dropdown.
-     *
-     * An example configuration:
-     *
-     * ```json
-     * {
-     * 	template: {
-     * 		definitions: [
-     * 			{
-     * 				title: 'Issue acknowledgement (plain text)',
-     * 				data: 'Dear customer, thank you for your report! The issue is currently being worked on by our development team.'
-     * 			},
-     * 			{
-     * 				title: 'Signature (multi-line)',
-     * 				data: '<p><b>Jane Doe</b></p><p>Marketing Specialist at <a href="https://example.com>Example.com</a></p>',
-     * 				description: 'Author signature with the link to the website.'
-     * 			},
-     * 			{
-     * 				title: 'Example table',
-     * 				data: '<table><tr><td>Cell #1</td><td></td></tr><tr><td></td><td>Cell #2</td></tr></table>',
-     * 				icon: '<svg viewBox="0 0 45 45" xmlns="http://www.w3.org/2000/svg">...</svg>',
-     * 				description: 'This template inserts a table.'
-     * 			},
-     * 			{
-     * 				title: 'Insert userAgent data',
-     * 				data: navigator.userAgent
-     * 			},
-     * 			{
-     * 				title: 'Insert translate to English link (function)',
-     * 				data: () => '<a href="' + location.href + '/en" title="Translate to English">Translate to English</a>'
-     * 			},
-     * 			// ...
-     * 		]
-     * 	}
-     * }
-     * ```
-     */
-    definitions?: Array<TemplateDefinition>;
-}
-/**
- * An object describing a single template definition.
- *
- * ```json
- * {
- * // Mandatory fields:
- * 	title: 'Example template',
- * 	data: '<table><tr><td>Cell #1</td><td></td></tr><tr><td></td><td>Cell #2</td></tr></table>',
- *
- * 	// Optional configuration:
- * 	icon: '<svg viewBox="0 0 45 45" xmlns="http://www.w3.org/2000/svg">...</svg>',
- * 	description: 'This template inserts a table.'
- * }
- * ```
- */
-export type TemplateDefinition = {
-    /**
-     * The title of the template.
-     */
-    title: string;
-    /**
-     * An HTML string to be inserted into the document or a callback function that returns an HTML string
-     * to be inserted into the document when the template is selected.
-     */
-    data: (() => string) | string;
-    /**
-     * An optional SVG string representing the icon of the template. The default size of the icon is 45x45 pixels.
-     * Be sure to set the correct `viewBox` attribute in the icon source. If not provided, a generic icon will be used instead.
-     */
-    icon?: string;
-    /**
-     * An optional long description of the template presented to the users.
-     */
-    description?: string;
-};

package/dist/templatecommand.d.ts

@@ -1,27 +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 template/templatecommand
- * @publicApi
- */
-import { Command } from 'ckeditor5/src/core.js';
-/**
- * The template command.
- *
- * Inserts a template into the editor content.
- */
-export default class TemplateCommand extends Command {
-    /**
-     * Inserts the template data at the position of the selection.
-     *
-     * @fires execute
-     * @param templateData Template data should be a raw HTML string or a function that returns one.
-     */
-    execute(templateData: string | Function): void;
-}

package/dist/templateediting.d.ts

@@ -1,34 +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 template/templateediting
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-/**
- * The template editing plugin.
- */
-export default class TemplateEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TemplateEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-}

package/dist/templateui.d.ts

@@ -1,41 +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 template/templateui
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import '../theme/template.css';
-/**
- * The UI plugin of the template feature.
- *
- * It registers the `'insertTemplate'` UI dropdown in the editor's {@link module:ui/componentfactory~ComponentFactory component factory}
- * that displays a list of templates and allows to insert them into the editor content.
- */
-export default class TemplateUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TemplateUI";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get isPremiumPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-}

package/dist/ui/templatelistbuttonview.d.ts

@@ -1,108 +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 template/ui/templatelistbuttonview
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-import { ButtonView, HighlightedTextView, View } from 'ckeditor5/src/ui.js';
-import type { TemplateDefinition } from '../template.js';
-/**
- * A class representing an individual button (template) in the list. Renders a rich preview of the template option.
- *
- * @protected
- */
-export default class TemplateListButtonView extends ButtonView {
-    /**
-     * The definition of the template that the button will apply when executed.
-     *
-     * @readonly
-     */
-    templateDefinition: TemplateDefinition;
-    /**
-     * The view rendering the text part of the template definition.
-     *
-     * @protected
-     * @readonly
-     */
-    textPartView: TextPartView | null;
-    /**
-     * Creates an instance of the {@link module:template/ui/templatelistbuttonview~TemplateListButtonView} class.
-     *
-     * @param locale The localization services instance.
-     * @param templateDefinition The definition of the template.
-     */
-    constructor(locale: Locale, templateDefinition: TemplateDefinition);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    destroy(): void;
-    /**
-     * Tells whether the `title` or `description` of the {@link #templateDefinition} match against the provided regular expression.
-     *
-     * @param regExp A regular expression to match the definition against.
-     * @returns When the match is positive, an object with the `title` and `description` keys is returned that describes
-     * the match. Otherwise, this method returns `null`.
-     */
-    isMatching(regExp: RegExp): object | null;
-    /**
-     * Highlights a subset of the {@link #textPartView} text according to a specified regular expression. When `null` is passed,
-     * the highlighting is turned off.
-     *
-     * @param regExp A regular expression used to highlight the matching text in the {@link #textPartView}.
-     */
-    highlightText(regExp: RegExp | null): void;
-}
-/**
- * A view representing the title and the description of the template.
- *
- * @protected
- */
-export declare class TextPartView extends View {
-    /**
-     * The title text of the template.
-     *
-     * @readonly
-     */
-    title: string;
-    /**
-     * The description text of the template.
-     *
-     * @readonly
-     */
-    description: string | undefined;
-    /**
-     * Renders the title text of a template.
-     *
-     * **Note**: It acts as a label of the entire button in the context of accessibility.
-     *
-     * @readonly
-     */
-    titleView: HighlightedTextView;
-    /**
-     * Renders the description text of a template.
-     *
-     * @readonly
-     */
-    descriptionView: HighlightedTextView;
-    /**
-     * Creates an instance of the text part view.
-     *
-     * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
-     * @param templateDefinition The definition of the template.
-     * @param labelId A unique ID that connects the entire button with the {@link #titleView} in the context of accessibility.
-     */
-    constructor(locale: Locale, templateDefinition: TemplateDefinition, labelId: string);
-    /**
-     * Highlights a subset of the {@link #titleView} and {@link #descriptionView} text according to a specified regular expression.
-     *
-     * @param regExp
-     */
-    highlightText(regExp: RegExp | null): void;
-}

package/dist/ui/templatelistitemview.d.ts

@@ -1,38 +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 template/ui/templatelistitemview
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-import { ListItemView } from 'ckeditor5/src/ui.js';
-import type TemplateListButtonView from './templatelistbuttonview.js';
-/**
- * A view representing an item in the list of tempaltes.
- *
- * @protected
- */
-export default class TemplateListItemView extends ListItemView {
-    /**
-     * The initial index of the item in the list of templates.
-     * Useful while searching and sorting to reverse the list to the same order.
-     */
-    readonly originalIndex: number;
-    /**
-     * The instance of the template button view containing the title,
-     * icon, and description of the template.
-     */
-    buttonView: TemplateListButtonView | null;
-    /**
-     * Creates an instance of the {@link module:template/ui/templatelistitemview~TemplateListItemView} class.
-     *
-     * @param locale The localization services instance.
-     * @param originalIndex The initial index of the item in the list of templates.
-     */
-    constructor(locale: Locale, originalIndex: number);
-}

package/dist/ui/templatelistview.d.ts

@@ -1,42 +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 template/ui/templatelistview
- */
-import { ListView, type FilteredView } from 'ckeditor5/src/ui.js';
-/**
- * The template list view class with filtering and sorting.
- *
- * @private
- */
-export default class TemplateListView extends ListView implements FilteredView {
-    /**
-     * Filters the list of templates according to a specified regular expression. The filtered list is sorted so that items that
-     * match the regular expression in their titles are displayed first.
-     *
-     * Matching items highlight the regular expression (query) in their titles and/or descriptions.
-     *
-     * **Note**: The `Collection` (also `ViewCollection`) class does not provide sorting functionality. Thus, the functionality
-     * implemented in this method is **extremely inefficient** because it clones the entire collection, sorts it as an array,
-     * then purges the original collection and sets it from scratch with the sorted array. Purging and resetting the
-     * collection triggers an avalanche of `add` and `remove` events synchronously handled by the `Template` (UI bindings)
-     * and **rendered in the DOM**. As long as sorting takes shorter than rendering of the DOM this should not be noticeable
-     * but the moment it does not, the UI will start glitching. A proper `Collection#sort` is needed to work around
-     * this overhead (see https://github.com/ckeditor/ckeditor5/issues/2065).
-     *
-     * **Note**: Passing `null` to this method resets the list to its original state.
-     *
-     * @param regExp A regular expression used to match the list title and description.
-     * @returns True if some list items matched the regular expression. False otherwise.
-     */
-    filter(regExp: RegExp | null): {
-        resultsCount: number;
-        totalItemsCount: number;
-    };
-}

package/dist/utils/common-translations.d.ts

@@ -1,13 +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 template/utils/common-translations
- */
-import type { Locale } from 'ckeditor5/src/utils.js';
-export declare function getTranslation(locale: Locale, id: string, ...args: Array<any>): string;