@sap-ux/fe-fpm-writer 0.43.19 → 0.43.21

package/dist/building-block/index.js

@@ -217,8 +217,10 @@ function getTemplateContent(buildingBlockData, viewDocument, manifest, fs, usePl
         // or for equal or below UI5 v1.96.0 contextPath is applied
         const minUI5Version = manifest ? (0, semver_1.coerce)((0, project_access_1.getMinimumUI5Version)(manifest)) : undefined;
         let targetProperty;
-        if (buildingBlockData.buildingBlockType === types_1.BuildingBlockType.RichTextEditor) {
-            // Get target property for RichTextEditor building block
+        if ((buildingBlockData.buildingBlockType === types_1.BuildingBlockType.RichTextEditor ||
+            buildingBlockData.buildingBlockType === types_1.BuildingBlockType.CustomFormField) &&
+            'targetProperty' in buildingBlockData &&
+            typeof buildingBlockData.targetProperty === 'string') {
             targetProperty = buildingBlockData.targetProperty;
         }
         const applyContextPath = buildingBlockData.buildingBlockType === types_1.BuildingBlockType.Chart ||

package/dist/building-block/processor.js

@@ -74,6 +74,12 @@ exports.BUILDING_BLOCK_CONFIG = {
         namespace: { uri: 'sap.fe.macros.filterBar', prefix: 'macros' },
         processor: processCustomFilterField
     },
+    [types_1.BuildingBlockType.CustomFormField]: {
+        aggregationConfig: { aggregationName: 'fields', elementName: 'FormElement' },
+        templateFile: 'common/Fragment.xml',
+        namespace: { uri: 'sap.fe.macros', prefix: 'macros' },
+        processor: processCustomFormField
+    },
     [types_1.BuildingBlockType.RichTextEditorButtonGroups]: {
         aggregationConfig: { aggregationName: 'buttonGroups', elementName: 'ButtonGroup' },
         namespace: { uri: 'sap.fe.macros', prefix: 'macros' },
@@ -179,6 +185,36 @@ function processCustomFilterField(buildingBlockData, context) {
         fs.copyTpl((0, templates_1.getTemplatePath)(config.templateFile), viewPath, filterConfig);
     }
 }
+/**
+ * Processes custom form field building block.
+ *
+ * @param {BuildingBlock} buildingBlockData - The building block data
+ * @param {ProcessingContext} context - Processing context
+ */
+function processCustomFormField(buildingBlockData, context) {
+    const { fs, viewPath } = context;
+    if (!isBuildingBlockType(buildingBlockData, types_1.BuildingBlockType.CustomFormField)) {
+        throw new Error('Expected CustomFormField building block data');
+    }
+    if (!buildingBlockData.embededFragment) {
+        throw new Error('EmbeddedFragment is required for CustomFormField');
+    }
+    const config = getBuildingBlockConfig(types_1.BuildingBlockType.CustomFormField);
+    const formFieldConfig = buildingBlockData.embededFragment;
+    let processedEventHandler;
+    // Apply event handler
+    if (formFieldConfig.eventHandler) {
+        processedEventHandler = (0, event_handler_1.applyEventHandlerConfiguration)(fs, formFieldConfig, formFieldConfig.eventHandler, {
+            controllerSuffix: false,
+            typescript: formFieldConfig.typescript
+        });
+        formFieldConfig.eventHandler = processedEventHandler;
+    }
+    formFieldConfig.content ??= (0, defaults_1.getDefaultFragmentContent)('Custom Form Field Content', buildingBlockData.generateId, processedEventHandler);
+    if (viewPath && !fs.exists(viewPath)) {
+        fs.copyTpl((0, templates_1.getTemplatePath)(config.templateFile), viewPath, formFieldConfig);
+    }
+}
 /**
  * Extracts a ButtonGroupConfig from an XML element.
  *
@@ -437,7 +473,8 @@ function processBuildingBlock(buildingBlockData, xmlDocument, manifestPath, mani
     }
     // Process embedded fragment for types that support it
     if ((isBuildingBlockType(buildingBlockData, types_1.BuildingBlockType.CustomColumn) ||
-        isBuildingBlockType(buildingBlockData, types_1.BuildingBlockType.CustomFilterField)) &&
+        isBuildingBlockType(buildingBlockData, types_1.BuildingBlockType.CustomFilterField) ||
+        isBuildingBlockType(buildingBlockData, types_1.BuildingBlockType.CustomFormField)) &&
         buildingBlockData.embededFragment) {
         embeddedFragment = (0, defaults_1.setCommonDefaults)(buildingBlockData.embededFragment, manifestPath, manifest);
         viewPath = (0, node_path_1.join)(embeddedFragment.path, `${embeddedFragment.fragmentFile ?? embeddedFragment.name}.fragment.xml`);

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

@@ -9,6 +9,7 @@ export declare enum BuildingBlockType {
     FilterBar = "filter-bar",
     Chart = "chart",
     CustomFilterField = "custom-filter-field",
+    CustomFormField = "custom-form-field",
     Field = "field",
     Form = "form",
     Page = "page",
@@ -419,6 +420,48 @@ export interface CustomFilterField extends BuildingBlock {
      */
     embededFragment?: EmbededFragment;
 }
+/**
+ * Represents a custom form field building block.
+ * Custom form fields can be added to Form building blocks using the FormElement control.
+ *
+ * @see https://sapui5.hana.ondemand.com/#/api/sap.fe.macros.FormElement
+ * @example
+ * <macros:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.FieldGroup#General">
+ *   <macros:fields>
+ *     <macros:FormElement
+ *       label="Custom Field"
+ *       placement="After"
+ *       anchor="DataField::ExistingProperty">
+ *       <macros:fields>
+ *         <core:Fragment fragmentName="myApp.ext.CustomField" type="XML" />
+ *       </macros:fields>
+ *     </macros:FormElement>
+ *   </macros:fields>
+ * </macros:Form>
+ * @extends {BuildingBlock}
+ */
+export interface CustomFormField extends BuildingBlock {
+    /**
+     * Optional key for the FormElement.
+     */
+    formElementKey?: string;
+    /**
+     * The text that will be displayed as label for this FormElement.
+     */
+    label: string;
+    /**
+     * Position of the custom form field relative to an anchor element.
+     */
+    position?: Position;
+    /**
+     * The fragment that contains the template for the custom form field.
+     */
+    embededFragment: EmbededFragment;
+    /**
+     * Property used to construct the metaPath for the custom form field, e.g. "EntitySet/targetProperty".
+     */
+    targetProperty?: string;
+}
 export interface CustomColumn extends BuildingBlock {
     title: string;
     width?: string;

package/dist/building-block/types.js

@@ -11,6 +11,7 @@ var BuildingBlockType;
     BuildingBlockType["FilterBar"] = "filter-bar";
     BuildingBlockType["Chart"] = "chart";
     BuildingBlockType["CustomFilterField"] = "custom-filter-field";
+    BuildingBlockType["CustomFormField"] = "custom-form-field";
     BuildingBlockType["Field"] = "field";
     BuildingBlockType["Form"] = "form";
     BuildingBlockType["Page"] = "page";

package/dist/index.d.ts

@@ -15,7 +15,7 @@ export { generateCustomView } from './view';
 export { enableFPM, FPMConfig } from './app';
 export { validateBasePath, validateVersion } from './common/validate';
 export { createIdGenerator, type IdGeneratorFunction, getRelativeTemplateComponentPath } from './common/file';
-export { BuildingBlockType, FilterBar, Form, Chart, Field, FieldFormatOptions, Table, BuildingBlockConfig, Page, CustomColumn, CustomFilterField, RichTextEditor, ButtonGroupConfig, Action } from './building-block/types';
+export { BuildingBlockType, FilterBar, Form, Chart, Field, FieldFormatOptions, Table, BuildingBlockConfig, Page, CustomColumn, CustomFilterField, CustomFormField, RichTextEditor, ButtonGroupConfig, Action } from './building-block/types';
 export { generateBuildingBlock, getSerializedFileContent } from './building-block';
 export { ChartPromptsAnswer, FilterBarPromptsAnswer, FormPromptsAnswer, TablePromptsAnswer, PagePromptsAnswer, RichTextEditorPromptsAnswer, RichTextEditorButtonGroupsPromptsAnswer, BuildingBlockTypePromptsAnswer } from './building-block/prompts/questions';
 export { PromptsType, SupportedGeneratorAnswers, PromptsAPI, PromptsGroup, Prompts, ValidationResults, Answers, Subset, CodeSnippet } from './prompts';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.43.19",
+  "version": "0.43.21",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -30,9 +30,9 @@
     "semver": "7.7.4",
     "xml-formatter": "3.7.0",
     "xpath": "0.0.34",
-    "@sap-ux/fiori-annotation-api": "0.9.41",
+    "@sap-ux/fiori-annotation-api": "0.9.42",
     "@sap-ux/i18n": "0.3.10",
-    "@sap-ux/project-access": "1.35.19",
+    "@sap-ux/project-access": "1.35.20",
     "@sap-ux/logger": "0.8.5"
   },
   "devDependencies": {

package/templates/building-block/custom-form-field/View.xml

@@ -0,0 +1,14 @@
+<% if (!config?.hasAggregation) { %><<%- macrosNamespace %>:fields><% } %>
+<<%- config?.aggregationNamespace %>:FormElement 
+	<% if (data.formElementKey) { %> key="<%- data.formElementKey %>"<% } %>
+	label="<%- data.label %>"
+	<% if (data.id) { %> id="<%- data.id %>"<% } %>
+	<% if (data.metaPath) { %> metaPath="<%- data.metaPath %>"<% } %>
+	<% if (data.contextPath) { %> contextPath="<%- data.contextPath %>"<% } %>
+	<% if (data.position?.anchor) { %> anchor="<%- data.position.anchor %>"<% } %>
+	<% if (data.position?.placement) { %> placement="<%- data.position.placement %>"<% } %>>
+	<<%- macrosNamespace %>:fields>
+		<core:Fragment fragmentName="<%- data.embededFragment.ns %>.<%- data.embededFragment.name %>" type="XML" />
+	</<%- macrosNamespace %>:fields>
+</<%- config?.aggregationNamespace %>:FormElement>
+<% if (!config?.hasAggregation) { %></<%- macrosNamespace %>:fields><% } %>