@sap-ux/fe-fpm-writer 0.11.0 → 0.13.1

package/dist/action/index.js

@@ -8,6 +8,7 @@ const path_1 = require("path");
 const ejs_1 = require("ejs");
 const validate_1 = require("../common/validate");
 const defaults_1 = require("../common/defaults");
+const event_handler_1 = require("../common/event-handler");
 /**
  * Enhances the provided custom action configuration with default data.
  *
@@ -74,13 +75,9 @@ function generateCustomAction(basePath, actionConfig, fs) {
     const manifest = fs.readJSON(manifestPath);
     const config = enhanceConfig(actionConfig, manifestPath, manifest);
     const root = path_1.join(__dirname, '../../templates');
-    // add event handler if requested
-    if (config.settings.eventHandler === true) {
-        const controllerPath = path_1.join(config.path, `${config.name}.js`);
-        if (!fs.exists(controllerPath)) {
-            fs.copyTpl(path_1.join(root, 'common/EventHandler.js'), controllerPath, config);
-        }
-        config.settings.eventHandler = `${config.ns}.${config.name}.onPress`;
+    // Apply event handler
+    if (config.eventHandler) {
+        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, root, config, config.eventHandler);
     }
     // enhance manifest with action definition and controller reference
     const actions = enhanceManifestAndGetActionsElementReference(manifest, config.target);

package/dist/action/types.d.ts

@@ -1,4 +1,4 @@
-import type { CustomElement, InternalCustomElement, Position } from '../common/types';
+import type { CustomElement, InternalCustomElement, Position, EventHandler } from '../common/types';
 export declare enum TargetControl {
     header = "header",
     footer = "footer",
@@ -11,7 +11,7 @@ export interface CustomActionTarget {
     navProperty?: string;
     qualifier?: string;
 }
-export interface CustomAction extends CustomElement {
+export interface CustomAction extends CustomElement, EventHandler {
     target: CustomActionTarget;
     settings: {
         text: string;
@@ -19,11 +19,6 @@ export interface CustomAction extends CustomElement {
         enabled?: string | true;
         requiresSelection?: boolean;
         position?: Position;
-        /**
-         * If not set (i.e. undefined) then no event handler is linked. If it is set true, a new one is created and linked to the action.
-         * If an existing event handler is to be used then its id needs to be provided as string.
-         */
-        eventHandler?: string | true;
     };
 }
 export declare type InternalCustomAction = CustomAction & InternalCustomElement;

package/dist/building-block/index.d.ts

@@ -0,0 +1,12 @@
+import type { Editor } from 'mem-fs-editor';
+import type { BuildingBlock, BuildingBlockConfig } from './types';
+/**
+ * Generates a building block into the provided xml view file.
+ *
+ * @param {string} basePath - the base path
+ * @param {BuildingBlockConfig} config - the building block configuration parameters
+ * @param {Editor} [fs] - the memfs editor instance
+ * @returns {Editor} the updated memfs editor instance
+ */
+export declare function generateBuildingBlock<T extends BuildingBlock>(basePath: string, config: BuildingBlockConfig<T>, fs?: Editor): Editor;
+//# sourceMappingURL=index.d.ts.map

package/dist/building-block/index.js

@@ -0,0 +1,157 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateBuildingBlock = void 0;
+const mem_fs_1 = require("mem-fs");
+const mem_fs_editor_1 = require("mem-fs-editor");
+const ejs_1 = require("ejs");
+const path_1 = require("path");
+const xmldom_1 = require("@xmldom/xmldom");
+const xpath = __importStar(require("xpath"));
+const xml_formatter_1 = __importDefault(require("xml-formatter"));
+const validate_1 = require("../common/validate");
+/**
+ * Generates a building block into the provided xml view file.
+ *
+ * @param {string} basePath - the base path
+ * @param {BuildingBlockConfig} config - the building block configuration parameters
+ * @param {Editor} [fs] - the memfs editor instance
+ * @returns {Editor} the updated memfs editor instance
+ */
+function generateBuildingBlock(basePath, config, fs) {
+    // Validate the base and view paths
+    if (!fs) {
+        fs = mem_fs_editor_1.create(mem_fs_1.create());
+    }
+    validate_1.validateBasePath(basePath, fs);
+    if (!fs.exists(path_1.join(basePath, config.viewOrFragmentPath))) {
+        throw new Error(`Invalid view path ${config.viewOrFragmentPath}.`);
+    }
+    // Read the view xml and template files and update contents of the view xml file
+    const xmlDocument = getUI5XmlDocument(basePath, config.viewOrFragmentPath, fs);
+    const templateDocument = getTemplateDocument(config.buildingBlockData, xmlDocument, fs);
+    fs = updateViewFile(basePath, config.viewOrFragmentPath, config.aggregationPath, xmlDocument, templateDocument, fs);
+    return fs;
+}
+exports.generateBuildingBlock = generateBuildingBlock;
+/**
+ * Returns the UI5 xml file document (view/fragment).
+ *
+ * @param {string} basePath - the base path
+ * @param {string} viewPath - the path of the xml view relative to the base path
+ * @param {Editor} fs - the memfs editor instance
+ * @returns {Document} the view xml file document
+ */
+function getUI5XmlDocument(basePath, viewPath, fs) {
+    let viewContent;
+    try {
+        viewContent = fs.read(path_1.join(basePath, viewPath));
+    }
+    catch (error) {
+        throw new Error(`Unable to read xml view file. Details: ${validate_1.getErrorMessage(error)}`);
+    }
+    const errorHandler = (level, message) => {
+        throw new Error(`Unable to parse xml view file. Details: [${level}] - ${message}`);
+    };
+    // Parse the xml view content
+    let viewDocument;
+    try {
+        viewDocument = new xmldom_1.DOMParser({ errorHandler }).parseFromString(viewContent);
+    }
+    catch (error) {
+        throw new Error(`Unable to parse xml view file. Details: ${validate_1.getErrorMessage(error)}`);
+    }
+    return viewDocument;
+}
+/**
+ * Returns the macros namespace from the xml document if it exists or creates a new one and returns it.
+ *
+ * @param {Document} ui5XmlDocument - the view/fragment xml file document
+ * @returns {string} the macros namespace
+ */
+function getOrAddMacrosNamespace(ui5XmlDocument) {
+    const namespaceMap = ui5XmlDocument.firstChild._nsMap;
+    const macrosNamespaceEntry = Object.entries(namespaceMap).find(([_, value]) => value === 'sap.fe.macros');
+    if (!macrosNamespaceEntry) {
+        ui5XmlDocument.firstChild._nsMap['macros'] = 'sap.fe.macros';
+    }
+    return macrosNamespaceEntry ? macrosNamespaceEntry[0] : 'macros';
+}
+/**
+ * Returns the template xml file document.
+ *
+ * @param {BuildingBlock} buildingBlockData - the building block data
+ * @param {Document} viewDocument - the view xml file document
+ * @param {Editor} fs - the memfs editor instance
+ * @returns {Document} the template xml file document
+ */
+function getTemplateDocument(buildingBlockData, viewDocument, fs) {
+    const templateFolderName = buildingBlockData.buildingBlockType;
+    const templateFilePath = path_1.join(__dirname, `../../templates/building-block/${templateFolderName}/View.xml`);
+    const templateContent = ejs_1.render(fs.read(templateFilePath), {
+        macrosNamespace: getOrAddMacrosNamespace(viewDocument),
+        data: buildingBlockData
+    });
+    const errorHandler = (level, message) => {
+        throw new Error(`Unable to parse template file with building block data. Details: [${level}] - ${message}`);
+    };
+    // Parse the rendered template content
+    let templateDocument;
+    try {
+        templateDocument = new xmldom_1.DOMParser({ errorHandler }).parseFromString(templateContent);
+    }
+    catch (error) {
+        throw new Error(`Unable to parse template file with building block data. Details: ${validate_1.getErrorMessage(error)}`);
+    }
+    return templateDocument;
+}
+/**
+ * Updates the view file by inserting the template as a child of the element specified in the aggregated xpath.
+ *
+ * @param {string} basePath - the base path
+ * @param {string} viewPath - the path of the xml view relative to the base path
+ * @param {string} aggregationPath - the aggregation xpath
+ * @param {Document} viewDocument - the view xml document
+ * @param {Document} templateDocument - the template xml document
+ * @param {Editor} [fs] - the memfs editor instance
+ * @returns {Editor} the updated memfs editor instance
+ */
+function updateViewFile(basePath, viewPath, aggregationPath, viewDocument, templateDocument, fs) {
+    const xpathSelect = xpath.useNamespaces(viewDocument.firstChild._nsMap);
+    // Find target aggregated element and append template as child
+    const targetNodes = xpathSelect(aggregationPath, viewDocument);
+    if (targetNodes && targetNodes.length > 0) {
+        const targetNode = targetNodes[0];
+        const sourceNode = viewDocument.importNode(templateDocument.documentElement, true);
+        targetNode.appendChild(sourceNode);
+        // Serialize and format new view xml document
+        const newXmlContent = new xmldom_1.XMLSerializer().serializeToString(viewDocument);
+        fs.write(path_1.join(basePath, viewPath), xml_formatter_1.default(newXmlContent));
+    }
+    else {
+        throw new Error(`Aggregation control not found ${aggregationPath}.`);
+    }
+    return fs;
+}
+//# sourceMappingURL=index.js.map

package/dist/building-block/types.d.ts

@@ -0,0 +1,351 @@
+/**
+ * Building block type.
+ *
+ * @enum {string}
+ */
+export declare enum BuildingBlockType {
+    FilterBar = "filter-bar",
+    Chart = "chart",
+    Field = "field"
+}
+/**
+ * Represents a building block control.
+ */
+export interface BuildingBlock {
+    /**
+     * Building block type.
+     */
+    buildingBlockType: BuildingBlockType;
+    /**
+     * Defines the path of the context used in the current page or block. This setting is defined by the framework.
+     */
+    contextPath?: string;
+    /**
+     * ID of the building block.
+     */
+    id: string;
+    /**
+     * Defines the relative path of the property in the metamodel, based on the current contextPath.
+     */
+    metaPath?: string;
+}
+/**
+ * Represents a Chart building block control.
+ * Usually, a contextPath and metaPath is expected.
+ *
+ * @example
+ * <macro:Chart id="Mychart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
+ * @extends {BuildingBlock}
+ */
+export interface Chart extends BuildingBlock {
+    /**
+     * ID of the FilterBar building block associated with the chart.
+     */
+    filterBar?: string;
+    /**
+     * Sets the personalization of the chart
+     */
+    personalization?: boolean | string;
+    /**
+     * Specifies the selection mode.
+     */
+    selectionMode?: string;
+    /**
+     * An event triggered when chart selections are changed.
+     * The event contains information about the data selected/deselected and the Boolean flag that indicates
+     * whether data is selected or deselected.
+     */
+    selectionChange?: string;
+}
+/**
+ * Represents a custom filter to be used inside the FilterBar.
+ * The template for the FilterField has to be provided as the default aggregation.
+ */
+export interface FilterField {
+    /**
+     * Reference to the key of another filter already displayed in the table to properly place this one.
+     */
+    anchor: string;
+    /**
+     * The property name of the FilterField.
+     */
+    key: string;
+    /**
+     * The text that will be displayed for this FilterField.
+     */
+    label: string;
+    /**
+     * If set the search will be automatically triggered, when a filter value was changed.
+     */
+    liveMode: boolean;
+    /**
+     * Defines where this filter should be placed relative to the defined anchor.
+     * Allowed values are `Before` and `After`.
+     */
+    placement: 'Before' | 'After';
+    /**
+     * Parameter which sets the visibility of the FilterBar building block.
+     */
+    visible: boolean;
+}
+/**
+ * Represents a Filter Bar building block control.
+ * Usually, a SelectionFields annotation is expected.
+ *
+ * @example
+ * <macro:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
+ * @extends {BuildingBlock}
+ */
+export interface FilterBar extends BuildingBlock {
+    /**
+     * This event is fired after either a filter value or the visibility of a filter item has been changed.
+     * The event contains conditions that will be used as filters.
+     */
+    filterChanged?: string;
+    /**
+     * This event is fired when the Go button is pressed or after a condition change.
+     */
+    search?: string;
+}
+/**
+ * Represents the format options for a field control.
+ */
+export interface FieldFormatOptions {
+    /**
+     * Defines how the field value and associated text will be displayed together.
+     * Allowed values are "Value", "Description", "ValueDescription" and "DescriptionValue"
+     */
+    displayMode?: 'Value' | 'Description' | 'ValueDescription' | 'DescriptionValue';
+    /**
+     * Defines if and how the field measure will be displayed.
+     * Allowed values are "Hidden" and "ReadOnly"
+     */
+    measureDisplayMode?: 'Hidden' | 'ReadOnly';
+    /**
+     * Defines how the full text will be displayed.
+     * Allowed values are "InPlace" and "Popover"
+     */
+    textExpandBehaviorDisplay?: 'InPlace' | 'Popover';
+    /**
+     * Maximum number of lines for multiline texts in edit mode.
+     */
+    textLinesEdit?: number;
+    /**
+     * Maximum number of characters from the beginning of the text field that are shown initially.
+     */
+    textMaxCharactersDisplay?: number;
+    /**
+     * Maximum number of lines that multiline texts in edit mode can grow to.
+     */
+    textMaxLines?: number;
+}
+/**
+ * Building block for creating a field based on the metadata provided by OData V4.
+ * Usually, a DataField or DataPoint annotation is expected, but the field can also be used to display
+ * a property from the entity type.
+ *
+ * @example
+ * <macro:Field id="MyField" metaPath="MyProperty" />
+ * @extends {BuildingBlock}
+ */
+export interface Field extends BuildingBlock {
+    /**
+     * A set of format options that can be configured.
+     */
+    formatOptions?: FieldFormatOptions;
+    /**
+     * An expression that allows you to control the read-only state of the field.
+     * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle
+     * to determine the current state.
+     */
+    readOnly?: boolean;
+    /**
+     * Option to add semantic objects to a field.
+     * Valid options are either a single semantic object, a stringified array of semantic objects
+     * or a single binding expression returning either a single semantic object or an array of semantic objects
+     */
+    semanticObject?: string;
+}
+/**
+ * Building block for creating a Form based on the metadata provided by OData V4.
+ * It is designed to work based on a FieldGroup annotation but can also work if you provide a
+ * ReferenceFacet or a CollectionFacet.
+ *
+ * @example
+ * <macro:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation" />
+ * @extends {BuildingBlock}
+ */
+export interface Form extends BuildingBlock {
+    /**
+     * The title of the form control.
+     */
+    title?: string;
+}
+/**
+ * Building block used to create a form element containing a label and a field.
+ *
+ * @extends {BuildingBlock}
+ */
+export interface FormElement extends BuildingBlock {
+    /**
+     * Label shown for the field. If not set, the label from the annotations will be shown.
+     */
+    label: string;
+    /**
+     * If set to false, the FormElement is not rendered.
+     */
+    visible: boolean;
+}
+/**
+ * Building block used to create a micro chart based on the metadata provided by OData V4.
+ *
+ * @extends {BuildingBlock}
+ */
+export interface MicroChart extends BuildingBlock {
+    /**
+     * Batch group ID along with which this call should be grouped.
+     */
+    batchGroupId?: string;
+    /**
+     * Show blank space in case there is no data in the chart.
+     */
+    hideOnNoData?: boolean;
+    /**
+     * To control the rendering of Title, Subtitle and Currency Labels. When the size is xs then we do not see
+     * the inner labels of the micro chart as well.
+     */
+    showOnlyChart?: boolean;
+    /**
+     * Size of the micro chart control.
+     */
+    size?: string;
+}
+/**
+ * Building block used to create a paginator control.
+ *
+ * @example
+ * <macro:Paginator id="someID" />
+ * @extends {BuildingBlock}
+ */
+export declare type Paginator = BuildingBlock;
+/**
+ * Building block used to create the share functionality.
+ * Please note that the 'Share in SAP Jam' option is only available on platforms that are integrated with SAP Jam.
+ * If you are consuming this macro in an environment where the SAP Fiori launchpad is not available,
+ * then the 'Save as Tile' option is not visible.
+ *
+ * @example
+ * <macro:Share id="someID" visible="true" />
+ * @extends {BuildingBlock}
+ */
+export interface Share extends BuildingBlock {
+    /**
+     * If set to false, the share control is not rendered.
+     */
+    visible: boolean;
+}
+/**
+ * Building block used to create a table based on the metadata provided by OData V4.
+ * Usually, a LineItem or PresentationVariant annotation is expected,
+ * but the table building block can also be used to display an EntitySet.
+ *
+ * @example
+ * <macro:Table id="MyTable" metaPath="@com.sap.vocabularies.UI.v1.LineItem" />
+ * @extends {BuildingBlock}
+ */
+export interface Table extends BuildingBlock {
+    /**
+     * An expression that allows you to control the 'busy' state of the table.
+     */
+    busy?: boolean;
+    /**
+     * Specifies the header text that is shown in the table.
+     */
+    enableAutoColumnWidth?: boolean;
+    /**
+     * Controls if the export functionality of the table is enabled or not.
+     * Default value is true.
+     */
+    enableExport?: boolean;
+    /**
+     * Controls whether the table can be opened in fullscreen mode or not.
+     */
+    enableFullScreen?: boolean;
+    /**
+     * Controls if the paste functionality of the table is enabled or not.
+     */
+    enablePaste?: boolean;
+    /**
+     * ID of the FilterBar building block associated with the table.
+     */
+    filterBar?: string;
+    /**
+     * Specifies the header text that is shown in the table.
+     */
+    header?: string;
+    /**
+     * Controls if the header text should be shown or not.
+     * Default value is true.
+     */
+    headerVisible?: boolean;
+    /**
+     * Defines whether to display the search action.
+     */
+    isSearchable?: boolean;
+    /**
+     * Groups menu actions by key.
+     */
+    menu?: string;
+    /**
+     * Controls which options should be enabled for the table personalization dialog.
+     * If it is set to `true`, all possible options for this kind of table are enabled.
+     * If it is set to `false`, personalization is disabled.
+     * You can also provide a more granular control for the personalization by providing a comma-separated list
+     * with the options you want to be available.
+     * Available options are: `Sort`, `Column` and `Filter`
+     */
+    personalization?: boolean | 'Sort' | 'Column' | 'Filter';
+    /**
+     * An expression that allows you to control the 'read-only' state of the table.
+     * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine
+     * the current state.
+     */
+    readOnly?: boolean;
+    /**
+     * Defines the selection mode to be used by the table.
+     * Allowed values are `None`, `Single`, `Multi` or `Auto`
+     */
+    selectionMode?: 'None' | 'Single' | 'Multi' | 'Auto';
+    /**
+     * Defines the type of table that will be used by the building block to render the data.
+     * Allowed values are `GridTable` and `ResponsiveTable`.
+     * Default value is `ResponsiveTable`.
+     */
+    type?: 'GridTable' | 'ResponsiveTable';
+    /**
+     * Controls the kind of variant management that should be enabled for the table.
+     * Allowed values are `Page`, `Control` and `None`.
+     * If the table is used within a SAP Fiori elements template, the default value will be taken from
+     * the current page variant management.
+     * Otherwise it's `None`.
+     */
+    variantManagement?: string;
+}
+/**
+ * Input configuration for the generate function.
+ */
+export interface BuildingBlockConfig<T extends BuildingBlock> {
+    /**
+     * The path of the view or fragment xml file relative to the base path.
+     */
+    viewOrFragmentPath: string;
+    /**
+     * The aggregation xpath.
+     */
+    aggregationPath: string;
+    /**
+     * The building block parameters.
+     */
+    buildingBlockData: T;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/building-block/types.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BuildingBlockType = void 0;
+/**
+ * Building block type.
+ *
+ * @enum {string}
+ */
+var BuildingBlockType;
+(function (BuildingBlockType) {
+    BuildingBlockType["FilterBar"] = "filter-bar";
+    BuildingBlockType["Chart"] = "chart";
+    BuildingBlockType["Field"] = "field";
+})(BuildingBlockType = exports.BuildingBlockType || (exports.BuildingBlockType = {}));
+//# sourceMappingURL=types.js.map

package/dist/column/index.js

@@ -7,6 +7,7 @@ const mem_fs_editor_1 = require("mem-fs-editor");
 const path_1 = require("path");
 const defaults_1 = require("../common/defaults");
 const validate_1 = require("../common/validate");
+const event_handler_1 = require("../common/event-handler");
 /**
  * Get the template folder for the given UI5 version.
  *
@@ -28,18 +29,20 @@ exports.getManifestRoot = getManifestRoot;
 /**
  * Enhances the provided custom table column configuration with default data.
  *
+ * @param {Editor} fs - the mem-fs editor instance
+ * @param {string} root - root path
  * @param {CustomTableColumn} data - a custom column configuration object
  * @param {string} manifestPath - path to the project's manifest.json
  * @param {Manifest} manifest - the application manifest
  * @returns enhanced configuration
  */
-function enhanceConfig(data, manifestPath, manifest) {
+function enhanceConfig(fs, root, data, manifestPath, manifest) {
     // clone input and set defaults
     const config = Object.assign({}, data);
     defaults_1.setCommonDefaults(config, manifestPath, manifest);
-    // set default event handler if it is to be created
-    if (config.eventHandler === true) {
-        config.eventHandler = `${config.ns}.${config.name}.onPress`;
+    // Apply event handler
+    if (config.eventHandler) {
+        config.eventHandler = event_handler_1.applyEventHandlerConfiguration(fs, root, config, config.eventHandler);
     }
     // generate column content
     const content = config.properties && config.properties.length > 0
@@ -66,11 +69,7 @@ function generateCustomColumn(basePath, customColumn, fs) {
     const manifest = fs.readJSON(manifestPath);
     const root = path_1.join(__dirname, '../../templates');
     // merge with defaults
-    const completeColumn = enhanceConfig(customColumn, manifestPath, manifest);
-    // add event handler if requested
-    if (completeColumn.eventHandler) {
-        fs.copyTpl(path_1.join(root, 'common/EventHandler.js'), path_1.join(completeColumn.path, `${completeColumn.name}.js`), completeColumn);
-    }
+    const completeColumn = enhanceConfig(fs, root, customColumn, manifestPath, manifest);
     // enhance manifest with column definition
     const manifestRoot = getManifestRoot(customColumn.ui5Version);
     const filledTemplate = ejs_1.render(fs.read(path_1.join(manifestRoot, `manifest.json`)), completeColumn);

package/dist/column/types.d.ts

@@ -1,4 +1,4 @@
-import type { CustomElement, InternalCustomElement, Position } from '../common/types';
+import type { CustomElement, InternalCustomElement, Position, EventHandler } from '../common/types';
 export declare enum Availability {
     'Default' = "Default",
     'Adaptation' = "Adaptation",
@@ -14,7 +14,7 @@ export declare type ColumnPropertiesType = string[];
  * Custom Column.
  *
  */
-export interface CustomTableColumn extends CustomElement {
+export interface CustomTableColumn extends CustomElement, EventHandler {
     /**
      * Name of the routing target
      */
@@ -31,11 +31,6 @@ export interface CustomTableColumn extends CustomElement {
      * The header is shown on the table as header, as well as in the add/remove dialog.
      */
     header: string;
-    /**
-     * If not set (i.e. undefined) then no event handler is linked. If it is set true, a new one is created and linked to the action.
-     * If an existing event handler is to be used then its id needs to be provided as string.
-     */
-    eventHandler?: string | true;
     /**
      * Optional control XML that will be generated into the fragment of table column. If the property isn't provided then a sample control will be generated.
      */

package/dist/common/event-handler.d.ts

@@ -0,0 +1,14 @@
+import type { Editor } from 'mem-fs-editor';
+import type { EventHandlerConfiguration, InternalCustomElement } from '../common/types';
+/**
+ * Method creates or updates handler js file and update 'settings.eventHandler' entry with namespace path entry to method.
+ *
+ * @param {Editor} fs - the memfs editor instance
+ * @param {string} root - the root path
+ * @param {InternalCustomElement} config - configuration
+ * @param {EventHandlerConfiguration | true | string} [eventHandler] - eventHandler for creation
+ * @param {boolean} [controllerSuffix=false] - append controller suffix to new file
+ * @returns {string} full namespace path to method
+ */
+export declare function applyEventHandlerConfiguration(fs: Editor, root: string, config: Partial<InternalCustomElement>, eventHandler: EventHandlerConfiguration | true | string, controllerSuffix?: boolean): string;
+//# sourceMappingURL=event-handler.d.ts.map