@sap-ux/fe-fpm-writer 1.2.1 → 1.3.0

package/dist/building-block/index.js

@@ -7,7 +7,7 @@ import { DOMParser, XMLSerializer } from '@xmldom/xmldom';
 import format from 'xml-formatter';
 import * as xpath from 'xpath';
 import { getMinimumUI5Version } from '@sap-ux/project-access';
-import { BuildingBlockType, PAGE_TEMPLATE_TYPE_FULL, bindingContextAbsolute } from './types.js';
+import { BuildingBlockType, PageTemplateType, bindingContextAbsolute } from './types.js';
 import { getErrorMessage, validateBasePath, validateDependenciesLibs } from '../common/validate.js';
 import { getTemplatePath } from '../templates.js';
 import { CodeSnippetLanguage } from '../prompts/types.js';
@@ -30,7 +30,7 @@ const PLACEHOLDERS = {
  * @returns true if full Page template
  */
 function isFullPageTemplate(data) {
-    return data.buildingBlockType === BuildingBlockType.Page && data.templateType === PAGE_TEMPLATE_TYPE_FULL;
+    return data.buildingBlockType === BuildingBlockType.Page && data.templateType === PageTemplateType.Full;
 }
 /**
  * Generates a building block into the provided xml view file.

package/dist/building-block/processAggregation.js

@@ -7,7 +7,7 @@ import format from 'xml-formatter';
 import * as xpath from 'xpath';
 import { coerce, lt } from 'semver';
 import { getMinimumUI5Version } from '@sap-ux/project-access';
-import { BuildingBlockType, PAGE_AGGREGATIONS, PAGE_FULL_TEMPLATE_MIN_UI5_VERSION, PAGE_TEMPLATE_COMMENT, PAGE_TEMPLATE_TYPE_FULL } from './types.js';
+import { BuildingBlockType, PAGE_AGGREGATIONS, MIN_UI5_VERSION_PAGE_BUILDING_BLOCK_FULL_LAYOUT, PAGE_TEMPLATE_COMMENT, PageTemplateType } from './types.js';
 import { getTemplatePath } from '../templates.js';
 import { createIdGenerator } from '../common/file.js';
 import { getErrorMessage } from '../common/validate.js';
@@ -53,7 +53,7 @@ export function getPageAggregationNames(data) {
     if (data.buildingBlockType !== BuildingBlockType.Page) {
         return undefined;
     }
-    return data.templateType === PAGE_TEMPLATE_TYPE_FULL ? PAGE_AGGREGATIONS : undefined;
+    return data.templateType === PageTemplateType.Full ? PAGE_AGGREGATIONS : undefined;
 }
 /**
  * Throws if the manifest's minUI5Version is set and does not meet the 1.145.0 requirement for the full Page template.
@@ -63,7 +63,7 @@ export function getPageAggregationNames(data) {
  */
 export function validateFullPageTemplateVersion(manifest) {
     const minUI5Version = manifest ? coerce(getMinimumUI5Version(manifest)) : undefined;
-    if (minUI5Version && lt(minUI5Version, PAGE_FULL_TEMPLATE_MIN_UI5_VERSION)) {
+    if (minUI5Version && lt(minUI5Version, MIN_UI5_VERSION_PAGE_BUILDING_BLOCK_FULL_LAYOUT)) {
         const t = translate(i18nNamespaces.buildingBlock, 'pageBuildingBlock.');
         throw new Error(`${t('fullTemplateMinUi5VersionRequirement', { minUI5Version: minUI5Version.version })}`);
     }

package/dist/building-block/prompts/questions/page.js

@@ -1,6 +1,6 @@
 import { i18nNamespaces, translate } from '../../../i18n.js';
 import { getBuildingBlockIdPrompt, getViewOrFragmentPathPrompt, getAggregationPathPrompt } from '../utils/index.js';
-import { BuildingBlockType, PAGE_FULL_TEMPLATE_MIN_UI5_VERSION, PAGE_TEMPLATE_TYPE_BASIC, PAGE_TEMPLATE_TYPE_FULL } from '../../types.js';
+import { BuildingBlockType, MIN_UI5_VERSION_PAGE_BUILDING_BLOCK_FULL_LAYOUT, PageTemplateType } from '../../types.js';
 import { SapShortTextType, SapLongTextType } from '@sap-ux/i18n';
 import { getMinimumUI5Version } from '@sap-ux/project-access';
 import { coerce, lt } from 'semver';
@@ -15,7 +15,7 @@ export async function getPageBuildingBlockPrompts(context) {
     const t = translate(i18nNamespaces.buildingBlock, 'prompts.page.');
     const { content: manifest } = await getManifest(context.appPath, context.fs, false);
     const minUI5Version = manifest ? coerce(getMinimumUI5Version(manifest)) : undefined;
-    const hideTemplateType = !!minUI5Version && lt(minUI5Version, PAGE_FULL_TEMPLATE_MIN_UI5_VERSION);
+    const hideTemplateType = !!minUI5Version && lt(minUI5Version, MIN_UI5_VERSION_PAGE_BUILDING_BLOCK_FULL_LAYOUT);
     return {
         questions: [
             ...(hideTemplateType
@@ -25,10 +25,10 @@ export async function getPageBuildingBlockPrompts(context) {
                         type: 'list',
                         name: 'buildingBlockData.templateType',
                         message: t('templateType.message'),
-                        default: PAGE_TEMPLATE_TYPE_BASIC,
+                        default: PageTemplateType.Basic,
                         choices: [
-                            { value: PAGE_TEMPLATE_TYPE_BASIC, name: t('templateType.basic') },
-                            { value: PAGE_TEMPLATE_TYPE_FULL, name: t('templateType.full') }
+                            { value: PageTemplateType.Basic, name: t('templateType.basic') },
+                            { value: PageTemplateType.Full, name: t('templateType.full') }
                         ],
                         guiOptions: { mandatory: true }
                     }
@@ -80,7 +80,7 @@ export async function getPageBuildingBlockPrompts(context) {
         initialAnswers: {
             buildingBlockData: {
                 buildingBlockType: BuildingBlockType.Page,
-                ...(hideTemplateType ? { templateType: PAGE_TEMPLATE_TYPE_BASIC } : {})
+                ...(hideTemplateType ? { templateType: PageTemplateType.Basic } : {})
             }
         }
     };

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

@@ -1,5 +1,14 @@
 import type { IdGeneratorFunction } from '../common/file.js';
 import type { CustomElement, CustomFragment, EventHandler, FragmentContentData, Position } from '../common/types.js';
+export declare const PageTemplateType: {
+    readonly Full: "full";
+    readonly Basic: "basic";
+};
+export type PageTemplateType = (typeof PageTemplateType)[keyof typeof PageTemplateType];
+/** Minimum UI5 version required for page building blocks. */
+export declare const MIN_UI5_VERSION_PAGE_BUILDING_BLOCK: "1.136.0";
+/** Minimum UI5 version required for full layout page building blocks. */
+export declare const MIN_UI5_VERSION_PAGE_BUILDING_BLOCK_FULL_LAYOUT: "1.145.0";
 /**
  * Building block type.
  *
@@ -390,10 +399,6 @@ export interface Page extends BuildingBlock {
      */
     aggregations?: Partial<Record<PageAggregationName, string>>;
 }
-export declare const PAGE_TEMPLATE_TYPE_FULL: "full";
-export declare const PAGE_TEMPLATE_TYPE_BASIC: "basic";
-export type PageTemplateType = typeof PAGE_TEMPLATE_TYPE_FULL | typeof PAGE_TEMPLATE_TYPE_BASIC;
-export declare const PAGE_FULL_TEMPLATE_MIN_UI5_VERSION = "1.145.0";
 export declare const PAGE_TEMPLATE_COMMENT = "This is a sample template, event handlers should be added for implementation";
 export declare const MACROS_NAMESPACE_URI = "sap.fe.macros";
 /**

package/dist/building-block/types.js

@@ -1,3 +1,11 @@
+export const PageTemplateType = {
+    Full: 'full',
+    Basic: 'basic'
+};
+/** Minimum UI5 version required for page building blocks. */
+export const MIN_UI5_VERSION_PAGE_BUILDING_BLOCK = '1.136.0';
+/** Minimum UI5 version required for full layout page building blocks. */
+export const MIN_UI5_VERSION_PAGE_BUILDING_BLOCK_FULL_LAYOUT = '1.145.0';
 /**
  * Building block type.
  *
@@ -37,9 +45,6 @@ export const PAGE_AGGREGATIONS = [
     'items',
     'footer'
 ];
-export const PAGE_TEMPLATE_TYPE_FULL = 'full';
-export const PAGE_TEMPLATE_TYPE_BASIC = 'basic';
-export const PAGE_FULL_TEMPLATE_MIN_UI5_VERSION = '1.145.0';
 export const PAGE_TEMPLATE_COMMENT = 'This is a sample template, event handlers should be added for implementation';
 export const MACROS_NAMESPACE_URI = 'sap.fe.macros';
 //# sourceMappingURL=types.js.map

package/dist/index.d.ts

@@ -21,9 +21,8 @@ export { enableFPM } from './app/index.js';
 export type { FPMConfig } from './app/index.js';
 export { validateBasePath, validateVersion } from './common/validate.js';
 export { createIdGenerator, type IdGeneratorFunction, getRelativeTemplateComponentPath } from './common/file.js';
-export { BuildingBlockType } from './building-block/types.js';
-export type { FilterBar, Form, Chart, Field, FieldFormatOptions, Table, BuildingBlockConfig, Page, CustomColumn, CustomFilterField, CustomFormField, RichTextEditor, ButtonGroupConfig, Action, PageTemplateType } from './building-block/types.js';
-export { PAGE_TEMPLATE_TYPE_FULL, PAGE_TEMPLATE_TYPE_BASIC, PAGE_AGGREGATIONS } from './building-block/types.js';
+export { BuildingBlockType, PageTemplateType, PAGE_AGGREGATIONS, MIN_UI5_VERSION_PAGE_BUILDING_BLOCK, MIN_UI5_VERSION_PAGE_BUILDING_BLOCK_FULL_LAYOUT } from './building-block/types.js';
+export type { FilterBar, Form, Chart, Field, FieldFormatOptions, Table, BuildingBlockConfig, Page, CustomColumn, CustomFilterField, CustomFormField, RichTextEditor, ButtonGroupConfig, Action } from './building-block/types.js';
 export type { PageAggregationName, GenerateBuildingBlockAggregationConfig } from './building-block/types.js';
 export { generateBuildingBlock, getSerializedFileContent, generateBuildingBlockAggregation } from './building-block/index.js';
 export type { ChartPromptsAnswer, FilterBarPromptsAnswer, FormPromptsAnswer, TablePromptsAnswer, PagePromptsAnswer, RichTextEditorPromptsAnswer, RichTextEditorButtonGroupsPromptsAnswer, BuildingBlockTypePromptsAnswer } from './building-block/prompts/questions/index.js';

package/dist/index.js

@@ -12,8 +12,7 @@ export { generateCustomView } from './view/index.js';
 export { enableFPM } from './app/index.js';
 export { validateBasePath, validateVersion } from './common/validate.js';
 export { createIdGenerator, getRelativeTemplateComponentPath } from './common/file.js';
-export { BuildingBlockType } from './building-block/types.js';
-export { PAGE_TEMPLATE_TYPE_FULL, PAGE_TEMPLATE_TYPE_BASIC, PAGE_AGGREGATIONS } from './building-block/types.js';
+export { BuildingBlockType, PageTemplateType, PAGE_AGGREGATIONS, MIN_UI5_VERSION_PAGE_BUILDING_BLOCK, MIN_UI5_VERSION_PAGE_BUILDING_BLOCK_FULL_LAYOUT } from './building-block/types.js';
 export { generateBuildingBlock, getSerializedFileContent, generateBuildingBlockAggregation } from './building-block/index.js';
 export { PromptsType, PromptsAPI } from './prompts/index.js';
 export { ControllerExtensionPageType } from './controller-extension/types.js';

package/dist/page/custom.js

@@ -11,7 +11,7 @@ import { coerce, gte, lt } from 'semver';
 import { addExtensionTypes, getManifestPath } from '../common/utils.js';
 import { copyTpl, extendJSON, createIdGenerator } from '../common/file.js';
 import { generateBuildingBlock } from '../building-block/index.js';
-import { BuildingBlockType } from '../building-block/types.js';
+import { BuildingBlockType, PageTemplateType, MIN_UI5_VERSION_PAGE_BUILDING_BLOCK, MIN_UI5_VERSION_PAGE_BUILDING_BLOCK_FULL_LAYOUT } from '../building-block/types.js';
 import { augmentXpathWithLocalNames } from '../building-block/prompts/utils/index.js';
 import { i18nNamespaces, translate } from '../i18n.js';
 /**
@@ -70,9 +70,10 @@ export function getTemplateRoot(ui5Version) {
  * Handles the creation of a page building block for a custom page.
  *
  * @param {string} basePath - The base path of the UI5 application.
- * @param {{ pageBuildingBlockTitle: string; minUI5Version?: string }} data - Object containing the building block title and optional minimum UI5 version.
- * @param data.pageBuildingBlockTitle
- * @param data.minUI5Version
+ * @param data - Object containing the building block configuration.
+ * @param {string} data.pageBuildingBlockTitle - The title for the page building block.
+ * @param {PageTemplateType} [data.pageBuildingBlockTemplateType] - The layout template type ('full' or 'basic'). Defaults to 'basic' if the UI5 version does not meet the full layout requirement.
+ * @param {string} [data.minUI5Version] - The minimum UI5 version of the application. Used to validate layout compatibility.
  * @param {string} viewPath - The path to the view XML file.
  * @param {Editor} fs - The memfs editor instance.
  * @param {(baseId: string) => Promise<string>} generateId - Function to generate unique IDs for the building block elements.
@@ -82,10 +83,23 @@ export function getTemplateRoot(ui5Version) {
 async function handlePageBuildingBlock(basePath, data, viewPath, fs, generateId, log) {
     const minVersion = coerce(data.minUI5Version);
     const t = translate(i18nNamespaces.buildingBlock, 'pageBuildingBlock.');
-    if (minVersion && lt(minVersion.version, '1.136.0')) {
-        log?.warn(t('minUi5VersionRequirement', { minUI5Version: data.minUI5Version }));
+    if (minVersion && lt(minVersion.version, MIN_UI5_VERSION_PAGE_BUILDING_BLOCK)) {
+        log?.warn(t('minUi5VersionRequirement', {
+            minUI5Version: data.minUI5Version,
+            minUi5VersionForPageBuildingBlock: MIN_UI5_VERSION_PAGE_BUILDING_BLOCK
+        }));
         return;
     }
+    let templateType = data.pageBuildingBlockTemplateType;
+    if (templateType === PageTemplateType.Full &&
+        minVersion &&
+        lt(minVersion.version, MIN_UI5_VERSION_PAGE_BUILDING_BLOCK_FULL_LAYOUT)) {
+        log?.warn(t('minUi5VersionRequirementFullLayout', {
+            minUI5Version: data.minUI5Version,
+            minUi5VersionForFullLayout: MIN_UI5_VERSION_PAGE_BUILDING_BLOCK_FULL_LAYOUT
+        }));
+        templateType = PageTemplateType.Basic;
+    }
     const pageId = generateId('Page');
     await generateBuildingBlock(basePath, {
         viewOrFragmentPath: relative(basePath, viewPath),
@@ -95,7 +109,8 @@ async function handlePageBuildingBlock(basePath, data, viewPath, fs, generateId,
             id: pageId,
             buildingBlockType: BuildingBlockType.Page,
             generateId,
-            title: data.pageBuildingBlockTitle
+            title: data.pageBuildingBlockTitle,
+            templateType: templateType
         }
     }, fs);
 }
@@ -142,7 +157,11 @@ export async function generate(basePath, data, fs, log) {
         }
     }
     if (data.pageBuildingBlockTitle) {
-        await handlePageBuildingBlock(basePath, { pageBuildingBlockTitle: data.pageBuildingBlockTitle, minUI5Version: data.minUI5Version }, viewPath, fs, fnGenerateId, log);
+        await handlePageBuildingBlock(basePath, {
+            pageBuildingBlockTitle: data.pageBuildingBlockTitle,
+            pageBuildingBlockTemplateType: data.pageBuildingBlockTemplateType,
+            minUI5Version: data.minUI5Version
+        }, viewPath, fs, fnGenerateId, log);
     }
     const ext = data.typescript ? 'ts' : 'js';
     const controllerPath = join(config.path, `${config.name}.controller.${ext}`);

package/dist/page/types.d.ts

@@ -1,4 +1,5 @@
 import type { CustomElement, InternalCustomElement, WriterConfig } from '../common/types.js';
+import type { PageTemplateType } from '../building-block/types.js';
 /**
  * Incoming navigation configuration.
  */
@@ -111,6 +112,10 @@ export interface CustomPage extends FpmPage, CustomElement {
      * If page building block title is defined then it will be used to automatically add a macro page to the generated custom page.
      */
     pageBuildingBlockTitle?: string;
+    /**
+     * The template type for the page building block. 'full' generates an enhanced layout with all aggregations; 'basic' is the default minimal tag.
+     */
+    pageBuildingBlockTemplateType?: PageTemplateType;
 }
 export interface FCL {
     /**

package/dist/prompts/translations/i18n.d.ts

@@ -277,7 +277,7 @@ declare const ns1: {
     };
     pageBuildingBlock: {
         minUi5VersionRequirement: string;
-        fullTemplateMinUi5VersionRequirement: string;
+        minUi5VersionRequirementFullLayout: string;
     };
     richTextEditorBuildingBlock: {
         minUi5VersionRequirement: string;

package/dist/prompts/translations/i18n.js

@@ -305,8 +305,8 @@ const ns1 = {
         }
     },
     'pageBuildingBlock': {
-        'minUi5VersionRequirement': 'The Page building block feature requires SAPUI5 1.136.0 or higher. The current version is {{ minUI5Version }}, so the Page building block will not be added.',
-        'fullTemplateMinUi5VersionRequirement': 'The full Page building block feature requires SAPUI5 1.145.0 or higher. The current version is {{ minUI5Version }}, so the full template will not be added.'
+        'minUi5VersionRequirement': 'The Page building block feature requires SAPUI5 {{ minUi5VersionForPageBuildingBlock }} or higher. The current version is {{ minUI5Version }}, so the Page building block will not be added.',
+        'minUi5VersionRequirementFullLayout': 'Full Layout requires SAPUI5 {{ minUi5VersionForFullLayout }} or higher. The current version is {{ minUI5Version }}, so Basic Layout will be applied instead.'
     },
     'richTextEditorBuildingBlock': {
         'minUi5VersionRequirement': 'The Rich Text Editor building block feature requires SAPUI5 1.117.0 or higher. The current version is {{ minUI5Version }}, so the Rich Text Editor building block will not be added.'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -33,8 +33,8 @@
     "xpath": "0.0.34",
     "@sap-ux/fiori-annotation-api": "1.0.15",
     "@sap-ux/i18n": "1.0.2",
-    "@sap-ux/logger": "1.0.3",
-    "@sap-ux/project-access": "2.1.6"
+    "@sap-ux/project-access": "2.1.6",
+    "@sap-ux/logger": "1.0.3"
   },
   "devDependencies": {
     "@jest/globals": "30.4.1",