@ckeditor/ckeditor5-merge-fields 0.0.0-internal-20241017.0

package/src/insertmergefieldblockcommand.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+const _0x423fe3=_0x5220;(function(_0x57058a,_0x4313e0){const _0x44febb=_0x5220,_0x34987b=_0x57058a();while(!![]){try{const _0x340daa=-parseInt(_0x44febb(0x205))/0x1*(-parseInt(_0x44febb(0x1f6))/0x2)+parseInt(_0x44febb(0x202))/0x3*(parseInt(_0x44febb(0x209))/0x4)+parseInt(_0x44febb(0x1f7))/0x5*(-parseInt(_0x44febb(0x1fc))/0x6)+-parseInt(_0x44febb(0x1fe))/0x7+-parseInt(_0x44febb(0x201))/0x8*(-parseInt(_0x44febb(0x206))/0x9)+-parseInt(_0x44febb(0x1f1))/0xa+parseInt(_0x44febb(0x204))/0xb;if(_0x340daa===_0x4313e0)break;else _0x34987b['push'](_0x34987b['shift']());}catch(_0x327a5e){_0x34987b['push'](_0x34987b['shift']());}}}(_0x4166,0xc855c));import{Command as _0x4af1e5}from'ckeditor5/src/core.js';import{findOptimalInsertionRange as _0x3ad265}from'ckeditor5/src/widget.js';function _0x4166(){const _0x419a63=['insertObject','auto','refresh','2644020VLTvfE','document','isLimit','schema','model','261194qaDIbU','207590cnxgjc','execute','change','createElement','string','138KmxWZi','mergeFieldBlock','9547167QxSMwN','isEnabled','parent','3096576TrBiVn','128058wYLXIS','editor','22761970XxfqIu','1QfmHRX','27DkkQaV','start','checkChild','4rLUjAW','isEmpty','selection'];_0x4166=function(){return _0x419a63;};return _0x4166();}function _0x5220(_0x3e36b9,_0x43b482){const _0x4166cc=_0x4166();return _0x5220=function(_0x522068,_0x1b8641){_0x522068=_0x522068-0x1f1;let _0x51a803=_0x4166cc[_0x522068];return _0x51a803;},_0x5220(_0x3e36b9,_0x43b482);}export default class i extends _0x4af1e5{[_0x423fe3(0x20e)](){const _0x22c70b=_0x423fe3,_0x42ef31=this[_0x22c70b(0x203)][_0x22c70b(0x1f5)],_0x36b79b=_0x42ef31[_0x22c70b(0x1f2)][_0x22c70b(0x20b)];this[_0x22c70b(0x1ff)]=function(_0x185420,_0x1a1c98){const _0x11a115=_0x22c70b,_0x4d6947=_0x3ad265(_0x185420,_0x1a1c98);let _0x1a230c=_0x4d6947[_0x11a115(0x207)][_0x11a115(0x200)];return _0x1a230c[_0x11a115(0x20a)]&&!_0x1a1c98[_0x11a115(0x1f4)][_0x11a115(0x1f3)](_0x1a230c)&&(_0x1a230c=_0x1a230c[_0x11a115(0x200)]),_0x1a1c98[_0x11a115(0x1f4)][_0x11a115(0x208)](_0x1a230c,_0x11a115(0x1fd));}(_0x36b79b,_0x42ef31);}[_0x423fe3(0x1f8)](_0x242960,_0x3c4075){const _0x350cda=_0x423fe3;if(!_0x242960||_0x350cda(0x1fb)!=typeof _0x242960)return;const _0x1674ec=this[_0x350cda(0x203)][_0x350cda(0x1f5)];_0x1674ec[_0x350cda(0x1f9)](_0xbee05b=>{const _0x55ffe3=_0x350cda,_0x1469da=_0xbee05b[_0x55ffe3(0x1fa)](_0x55ffe3(0x1fd),{'id':_0x242960});_0x1674ec[_0x55ffe3(0x20c)](_0x1469da,_0x1674ec[_0x55ffe3(0x1f2)][_0x55ffe3(0x20b)],null,{'setSelection':'on','findOptimalPosition':!0x1===_0x3c4075?void 0x0:_0x55ffe3(0x20d)});});}}

package/src/insertmergefieldcommand.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @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 merge-fields/insertmergefieldcommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+/**
+ * The insert merge field element command.
+ *
+ * The command is registered by {@link module:merge-fields/mergefieldsediting~MergeFieldsEditing} as `'insertMergeField'`.
+ *
+ * To insert a merge field element at the current selection, execute the command passing the merge field id as a parameter:
+ *
+ * ```ts
+ * editor.execute( 'insertMergeField', 'clientName' );
+ * ```
+ */
+export default class InsertMergeFieldCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Inserts a new merge field element with the given `id` attribute at the current selection.
+     *
+     * @fires execute
+     */
+    execute(mergeFieldId: string): void;
+}

package/src/insertmergefieldcommand.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+const _0x41ed08=_0x85a6;(function(_0x3a1844,_0x3bb3cf){const _0x49cf05=_0x85a6,_0x508b5e=_0x3a1844();while(!![]){try{const _0x350f29=parseInt(_0x49cf05(0x199))/0x1+-parseInt(_0x49cf05(0x19a))/0x2+parseInt(_0x49cf05(0x1b1))/0x3+parseInt(_0x49cf05(0x195))/0x4*(parseInt(_0x49cf05(0x19b))/0x5)+parseInt(_0x49cf05(0x193))/0x6*(-parseInt(_0x49cf05(0x1b0))/0x7)+parseInt(_0x49cf05(0x19f))/0x8*(parseInt(_0x49cf05(0x1a7))/0x9)+parseInt(_0x49cf05(0x1af))/0xa*(-parseInt(_0x49cf05(0x1a1))/0xb);if(_0x350f29===_0x3bb3cf)break;else _0x508b5e['push'](_0x508b5e['shift']());}catch(_0x3110fa){_0x508b5e['push'](_0x508b5e['shift']());}}}(_0x2bf9,0x6a6f9));import{Command as _0xa8bfb8}from'ckeditor5/src/core.js';function _0x85a6(_0x4c4e58,_0x2d0b79){const _0x2bf9b2=_0x2bf9();return _0x85a6=function(_0x85a656,_0x1c72f5){_0x85a656=_0x85a656-0x193;let _0x403bd9=_0x2bf9b2[_0x85a656];return _0x403bd9;},_0x85a6(_0x4c4e58,_0x2d0b79);}function _0x2bf9(){const _0x735914=['createElement','refresh','editor','3888279MFtBWn','focus','deleteContent','checkChild','selection','checkAttribute','setAttribute','change','2550090pyPxdk','1369669EDEfhz','212418wNzfiV','6WbmKMS','string','3005956Xzvfjn','insertContent','execute','schema','256051bksmAH','227444RthPsl','5iVAOrl','model','isEnabled','after','8pXKZUD','getAttributes','33icbUjK','mergeField','document'];_0x2bf9=function(){return _0x735914;};return _0x2bf9();}export default class r extends _0xa8bfb8{[_0x41ed08(0x1a5)](){const _0x4ec1f1=_0x41ed08,_0x59a589=this[_0x4ec1f1(0x1a6)][_0x4ec1f1(0x19c)],_0x86e86d=_0x59a589[_0x4ec1f1(0x198)][_0x4ec1f1(0x1aa)](_0x59a589[_0x4ec1f1(0x1a3)][_0x4ec1f1(0x1ab)][_0x4ec1f1(0x1a8)],_0x4ec1f1(0x1a2));this[_0x4ec1f1(0x19d)]=_0x86e86d;}[_0x41ed08(0x197)](_0x187a06){const _0x3585ce=_0x41ed08;if(!_0x187a06||_0x3585ce(0x194)!=typeof _0x187a06)return;const _0x873a34=this[_0x3585ce(0x1a6)][_0x3585ce(0x19c)];_0x873a34[_0x3585ce(0x1ae)](_0x1cec19=>{const _0x4c9fd2=_0x3585ce;_0x873a34[_0x4c9fd2(0x1a9)](_0x873a34[_0x4c9fd2(0x1a3)][_0x4c9fd2(0x1ab)]);const _0x592210=_0x1cec19[_0x4c9fd2(0x1a4)](_0x4c9fd2(0x1a2),{'id':_0x187a06});for(const [_0x290719,_0x5d3b36]of _0x873a34[_0x4c9fd2(0x1a3)][_0x4c9fd2(0x1ab)][_0x4c9fd2(0x1a0)]())_0x873a34[_0x4c9fd2(0x198)][_0x4c9fd2(0x1ac)](_0x592210,_0x290719)&&_0x1cec19[_0x4c9fd2(0x1ad)](_0x290719,_0x5d3b36,_0x592210);_0x873a34[_0x4c9fd2(0x196)](_0x592210,_0x873a34[_0x4c9fd2(0x1a3)][_0x4c9fd2(0x1ab)],0x0,{'setSelection':_0x4c9fd2(0x19e)});});}}

package/src/mergefields.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @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 merge-fields/mergefields
+ * @publicApi
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import MergeFieldsEditing from './mergefieldsediting.js';
+import MergeFieldsUI from './mergefieldsui.js';
+/**
+ * The merge fields feature.
+ *
+ * For a detailed overview, check the {@glink features/merge-fields Merge fields} feature documentation.
+ *
+ * @extends module:core/plugin~Plugin
+ */
+export default class MergeFields extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof MergeFieldsEditing, typeof MergeFieldsUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "MergeFields";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    static get isPremiumPlugin(): true;
+}

package/src/mergefields.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+function _0x2ad3(){var _0x5caf9c=['MergeFields','3500704KGDPbi','2590iyNwqN','18npxoUN','752863zhMjJO','21816310fCYZqU','isPremiumPlugin','7oiGmWt','pluginName','6767106YLMybk','isOfficialPlugin','94926pvAqbO','3364bfXFJq','requires','94156lrNBYa'];_0x2ad3=function(){return _0x5caf9c;};return _0x2ad3();}function _0x2d15(_0x40a1fa,_0x5d489a){var _0x2ad32c=_0x2ad3();return _0x2d15=function(_0x2d1517,_0x2ded8b){_0x2d1517=_0x2d1517-0x1cb;var _0x5a3c83=_0x2ad32c[_0x2d1517];return _0x5a3c83;},_0x2d15(_0x40a1fa,_0x5d489a);}var _0x20df0a=_0x2d15;(function(_0x7acea2,_0x495c78){var _0x10fcd8=_0x2d15,_0x295ca0=_0x7acea2();while(!![]){try{var _0xe531e7=-parseInt(_0x10fcd8(0x1d6))/0x1+-parseInt(_0x10fcd8(0x1d1))/0x2+parseInt(_0x10fcd8(0x1ce))/0x3+-parseInt(_0x10fcd8(0x1cf))/0x4*(parseInt(_0x10fcd8(0x1d4))/0x5)+parseInt(_0x10fcd8(0x1cc))/0x6*(-parseInt(_0x10fcd8(0x1d9))/0x7)+-parseInt(_0x10fcd8(0x1d3))/0x8*(-parseInt(_0x10fcd8(0x1d5))/0x9)+parseInt(_0x10fcd8(0x1d7))/0xa;if(_0xe531e7===_0x495c78)break;else _0x295ca0['push'](_0x295ca0['shift']());}catch(_0x1a5941){_0x295ca0['push'](_0x295ca0['shift']());}}}(_0x2ad3,0xb101b));import{Plugin as _0x26a5ff}from'ckeditor5/src/core.js';import _0x949a97 from'./mergefieldsediting.js';import _0x3f7eb from'./mergefieldsui.js';export default class u extends _0x26a5ff{static get[_0x20df0a(0x1d0)](){return[_0x949a97,_0x3f7eb];}static get[_0x20df0a(0x1cb)](){var _0x2a9982=_0x20df0a;return _0x2a9982(0x1d2);}static get[_0x20df0a(0x1cd)](){return!0x0;}static get[_0x20df0a(0x1d8)](){return!0x0;}}

package/src/mergefieldsconfig.d.ts

@@ -0,0 +1,241 @@
+/**
+ * @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 merge-fields/mergefieldsconfig
+ * @publicApi
+ */
+import type { Editor } from 'ckeditor5/src/core.js';
+/**
+ * The configuration of the merge fields feature.
+ *
+ * The properties defined in this config are set in the `config.mergeFields` namespace.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		mergeFields: {
+ * 			// Merge fields configuration.
+ * 		}
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface MergeFieldsConfig {
+    /**
+     * The definitions of the merge fields that can be used in the editor.
+     * It's allowed to define them in any combination of groups and individual merge fields.
+     * The order of the definitions is respected when displaying the merge fields in the UI dropdown
+     * except that merge fields that are not assigned to any group are displayed at the
+     * very bottom of the list.
+     */
+    definitions?: Array<GroupDefinition | MergeFieldDefinition>;
+    /**
+     * A prefix used to identify merge fields in the editor data.
+     *
+     * The list of allowed characters includes: ``'"`!#%:;=@{}~$()*+/?[\]^|``.
+     *
+     * @default '\{\{'
+     */
+    prefix?: string;
+    /**
+     * A suffix used to identify merge fields in the editor data.
+     *
+     * The list of allowed characters includes: ``'"`!#%:;=@{}~$()*+/?[\]^|``.
+     *
+     * @default '\}\}'
+     */
+    suffix?: string;
+    /**
+     * The data sets that can be displayed in place of the merge fields in the editor.
+     *
+     * @default []
+     */
+    dataSets?: Array<DataSetDefinition>;
+    /**
+     * Determines the available preview modes in the dropdown and menu bar. Possible values are:
+     *
+     * * `'$labels'` - adds the option to display the labels of the merge fields.
+     * * `'$defaultValues'` - adds the option to display the default values.
+     * * `'$dataSets'` - adds the options to display each of the configured data sets.
+     *
+     * At least one mode must be enabled. If more than one preview mode is configured,
+     * you can add `previewMergeFields` button to the toolbar to switch between them,
+     * and the menu bar button will be added automatically to the `View` category.
+     *
+     * @default [ '$labels', '$defaultValues', '$dataSets' ]
+     */
+    previewModes?: Array<string>;
+    /**
+     * A name of the preview mode that should be active when the editor is initialized. Possible values are:
+     *
+     * * `'$labels'` - displays the labels of the merge fields,
+     * * `'$defaultValues'` - displays the default values,
+     * * one of the configured {@link module:merge-fields/mergefieldsconfig~MergeFieldsConfig#dataSets data sets} identifiers.
+     *
+     * If not set, it will default to the one of the {@link ~MergeFieldsConfig#previewModes available preview modes}, with the priority as
+     * in the list above.
+     */
+    initialPreviewMode?: string;
+    /**
+     * A flag indicating whether the feature preview mode should interpret merge fields
+     * {@link ~DataSetDefinition#values data set values} and {@link ~MergeFieldDefinition#defaultValue default values} as HTML strings and
+     * render them as HTML.
+     *
+     * When set to `true`, the merge field value will be interpreted and rendered as HTML. For example, `'<img src="image.jpg" />'` merge
+     * field value will be previewed as the image located at given `src`.
+     *
+     * When set to `false`, the merge field value will be interpreted as a regular text. For example, `'<img src="image.jpg" />'` will be
+     * displayed exactly as defined, meaning that text `<img src="image.jpg" />` will be displayed instead of an image.
+     *
+     * By default, it is set to `false`.
+     *
+     * Read more about the security of previewing merge fields HTML values in the
+     * {@glink features/merge-fields#using-html-tags-in-merge-fields-values Merge fields feature} documentation.
+     *
+     * @default false
+     */
+    previewHtmlValues?: boolean;
+    /**
+     * Callback used to sanitize the HTML used in merge fields values when they are previewed inside the editor.
+     *
+     * We strongly recommend overwriting the default function to avoid XSS vulnerabilities.
+     *
+     * Read more about the security aspect of this feature in {@glink features/merge-fields#using-html-tags-in-merge-fields-values Merge
+     * fields feature} documentation.
+     *
+     * The function receives the input HTML (as a string), and should return an object
+     * that matches the {@link module:merge-fields/mergefieldsconfig~MergeFieldsSanitizeOutput} interface.
+     *
+     * ```ts
+     * ClassicEditor
+     *   .create( editorElement, {
+     *     mergeFields: {
+     *       previewHtmlValues: true,
+     *       sanitizeHtml( inputHtml ) {
+     *         // Strip unsafe elements and attributes, e.g.:
+     *         // the `<script>` elements and `on*` attributes.
+     *         const outputHtml = sanitize( inputHtml );
+     *
+     *         return {
+     *           html: outputHtml,
+     *           // true or false depending on whether the sanitizer stripped anything.
+     *           hasChanged: ...
+     *         };
+     *       },
+     *     }
+     *   } )
+     *   .then( ... )
+     *   .catch( ... );
+     * ```
+     *
+     * **Note:** The function is used only when the feature
+     * {@link module:merge-fields/mergefieldsconfig~MergeFieldsConfig#previewHtmlValues is configured to render previews}.
+     */
+    sanitizeHtml?: (html: string) => MergeFieldsSanitizeOutput;
+}
+/**
+ * An object returned by the {@link module:merge-fields/mergefieldsconfig~MergeFieldsConfig#sanitizeHtml} function.
+ */
+export interface MergeFieldsSanitizeOutput {
+    /**
+     * An output (safe) HTML that will be inserted into the {@glink framework/architecture/editing-engine editing view}.
+     */
+    html: string;
+    /**
+     * A flag that indicates whether the output HTML is different than the input value.
+     */
+    hasChanged: boolean;
+}
+export type GroupDefinition = {
+    /**
+     * The unique identifier of the group.
+     *
+     * If {@link GroupDefinition#groupLabel} is not specified, the ID will be used as a label in the UI.
+     */
+    groupId: string;
+    /**
+     * The human-readable label of the group.
+     *
+     * It is displayed by the feature's UI.
+     */
+    groupLabel?: string;
+    /**
+     * The array of merge fields definitions that belong to the group.
+     */
+    definitions: Array<MergeFieldDefinition>;
+};
+export type MergeFieldDefinition = {
+    /**
+     * The unique identifier of the merge field.
+     *
+     * If {@link MergeFieldDefinition#label} is not specified, the ID will be used as a label.
+     *
+     * The list of allowed characters includes: `a-z`, `A-Z`, `0-9`, `_`, `.`, and `-`.
+     */
+    id: string;
+    /**
+     * The human-readable label of the merge field.
+     *
+     * It is displayed by the feature's UI and inside the editing area.
+     */
+    label?: string;
+    /**
+     * The type of the merge field. It determines how the merge field is rendered in the editor editing area.
+     *
+     * Possible options are `text` (meaning the merge field will be inline) and `block`.
+     *
+     * @default 'text'
+     */
+    type?: MergeFieldType;
+    /**
+     * The height of the block merge field in pixels.
+     *
+     * It is used only for merge fields of type `block`. If unset, the default block merge field height is 120 pixels.
+     *
+     * @default 120
+     */
+    height?: number;
+    /**
+     * Default value of the merge field.
+     *
+     * It is used if a value for given merge field has not been provided in a data set and in the default values preview mode.
+     */
+    defaultValue?: MergeFieldDataSetValue;
+};
+export type DataSetDefinition = {
+    /**
+     * A unique identifier of the data set. It cannot start with `$`, as it is reserved for internal use.
+     */
+    id: string;
+    /**
+     * A human-readable label of the data set.
+     */
+    label?: string;
+    /**
+     * The data to be displayed in the editor in place of merge fields when the data set is previewed.
+     *
+     * The keys of this object are merge field IDs, while values are the merge field values, which can be strings or functions.
+     * If the value is specified as a function, it should return a string. The function will be evaluated each time the data set values
+     * are retrieved.
+     *
+     * ```ts
+     * const mergeFieldsConfig = {
+     * 	dataSets: [
+     *		id: 'customDataSet',
+     *		values: {
+     *			companyName: 'CKSource',
+     *			productName: 'CKEditor 5'
+     *		}
+     *	]
+     * };
+     * ```
+     */
+    values: Record<string, MergeFieldDataSetValue>;
+};
+export type MergeFieldDataSetValue = string | ((editor: Editor) => string);
+export type MergeFieldType = 'text' | 'block';

package/src/mergefieldsconfig.js

@@ -0,0 +1,23 @@
+/*
+ *             Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ *
+ *
+ *
+ *
+ *          +---------------------------------------------------------------------------------+
+ *          |                                                                                 |
+ *          |                                 Hello stranger!                                 |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          |   What you're currently looking at is the source code of a legally protected,   |
+ *          |    proprietary software. Any attempts to deobfuscate / disassemble this code    |
+ *          |               are forbidden and will result in legal consequences.              |
+ *          |                                                                                 |
+ *          |                                                                                 |
+ *          +---------------------------------------------------------------------------------+
+ *
+ *
+ *
+ *
+ */
+export{};

package/src/mergefieldsediting.d.ts

@@ -0,0 +1,113 @@
+/**
+ * @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 { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import type { MergeFieldDefinition, MergeFieldType } from './mergefieldsconfig.js';
+/**
+ * The merge fields editing feature.
+ */
+export default class MergeFieldsEditing extends Plugin {
+    /**
+     * The current preview mode for merge fields. Determines the merge field values displayed in the editor.
+     *
+     * @observable
+     */
+    previewMode: string;
+    /**
+     * All configured preview modes, available to be set as a value for {@link #previewMode}.
+     */
+    readonly availablePreviewModes: Array<string>;
+    /**
+     * A flat list of all merge field definitions.
+     */
+    flattenedMergeFieldDefinitions: Array<MergeFieldDefinition>;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "MergeFieldsEditing";
+    /**
+     * @inheritDoc
+     */
+    static get isOfficialPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    static get isPremiumPlugin(): true;
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    /**
+     * Returns an object with default merge fields values.
+     *
+     * Custom merge fields (created by user, not defined in the config) will be returned as well, and their value will be set to `null`.
+     *
+     * Values defined as functions are evaluated and their result is returned.
+     */
+    getDefaultValues(): MergeFieldsValues;
+    /**
+     * Returns an object with merge fields values defined for given data set.
+     *
+     * Custom merge fields (created by user, not defined in the config) will be returned as well, and their value will be set to `null`.
+     *
+     * Values defined as functions are evaluated and their result is returned.
+     *
+     * If the data set is not found, it throws an error.
+     *
+     * @param dataSetId
+     * @param useDefaultValues If set to `true`, merge field default value will be used for these merge fields, for which the data
+     * was not defined. If default value is not configured for given merge field, `null` will be still returned.
+     */
+    getDataSetValues(dataSetId: string, useDefaultValues?: boolean): MergeFieldsValues;
+    /**
+     * Retrieves the label for the merge field with the given id.
+     *
+     * If the merge field definition for given id was not found, or a label was not specified, the merge field id is returned instead.
+     */
+    getLabel(id: string): string;
+    /**
+     * Returns the default value for the merge field with the given id.
+     *
+     * If the merge field default value was specified as a callback, it will be executed and the result will be returned.
+     *
+     * If the merge field definition for given id was not found, or a default value was not specified, `null` is returned.
+     */
+    getMergeFieldDefaultValue(id: string): string | null;
+    /**
+     * Returns the value specified for merge field with the given in given data set.
+     *
+     * If the merge field value was specified as a callback, it will be executed and the result will be returned.
+     *
+     * If the merge field definition for given id was not found, or the data set has no value for this merge field, `null` is returned.
+     */
+    getMergeFieldValue(id: string, dataSetId: string): string | null;
+    /**
+     * Returns the type of the merge field with the given id.
+     *
+     * Possible values are: `text`, `block`, `image`.
+     */
+    getMergeFieldType(id: string): MergeFieldType;
+    /**
+     * Returns ids of all merge fields that are present in the document.
+     */
+    getDocumentMergeFieldsIds(): Array<string>;
+    /**
+     * Returns ids of all merge fields defined in the configuration and custom merge fields added by the user that exist in the document.
+     */
+    getMergeFieldsIds(): Array<string>;
+    /**
+     * Returns the merge field definition for the given id.
+     */
+    getDefinition(id: string): MergeFieldDefinition | null;
+}
+type MergeFieldsValues = Record<string, string | null>;
+export {};