@sap-ux/fe-fpm-writer 0.43.12 → 0.43.13

package/dist/building-block/index.js

@@ -75,7 +75,7 @@ async function generateBuildingBlock(basePath, config, fs) {
     // Validate the base and view paths
     fs ??= (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     await (0, validate_1.validateBasePath)(basePath, fs, []);
-    const fnGenerateId = config.buildingBlockData.generateId ?? (await (0, file_1.createIdGenerator)(basePath, fs));
+    const fnGenerateId = config.buildingBlockData.generateId ?? (await (0, file_1.createIdGenerator)({ basePath, fsEditor: fs }));
     if (!fs.exists((0, node_path_1.join)(basePath, viewOrFragmentPath))) {
         throw new Error(`Invalid view path ${viewOrFragmentPath}.`);
     }

package/dist/column/index.js

@@ -71,7 +71,7 @@ async function generateCustomColumn(basePath, customColumn, fs) {
     (0, validate_1.validateVersion)(customColumn.minUI5Version);
     fs ??= (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     await (0, validate_1.validateBasePath)(basePath, fs);
-    const fnGenerateId = await (0, file_1.createIdGenerator)(basePath, fs);
+    const fnGenerateId = await (0, file_1.createIdGenerator)({ basePath, fsEditor: fs });
     const { path: manifestPath, content: manifest } = await (0, utils_1.getManifest)(basePath, fs);
     // merge with defaults
     const completeColumn = enhanceConfig(fs, customColumn, manifestPath, manifest, fnGenerateId);

package/dist/common/file.d.ts

@@ -1,5 +1,43 @@
 import type { CopyOptions, Editor } from 'mem-fs-editor';
 import type { TabInfo } from '../common/types';
+/**
+ * Options for creating an ID generator with cached file contents.
+ */
+export interface CreateIdGeneratorWithCacheOptions {
+    basePath?: never;
+    fsEditor?: never;
+    /**
+     *
+     * cache for file contents to optimize ID generation.
+     */
+    fileContentCache: string[];
+}
+/**
+ * Options for creating an ID generator with filesystem access.
+ */
+export interface CreateIdGeneratorWithFilesystemOptions {
+    /**
+     * Base path of the project.
+     */
+    basePath: string;
+    /**
+     * mem-fs-editor instance.
+     */
+    fsEditor: Editor;
+    fileContentCache?: string[];
+}
+/**
+ * Options for creating an empty ID generator (no validation).
+ */
+export interface CreateIdGeneratorEmptyOptions {
+    basePath?: never;
+    fsEditor?: never;
+    fileContentCache?: never;
+}
+/**
+ * Options for creating an ID generator.
+ */
+export type CreateIdGeneratorOptions = CreateIdGeneratorWithCacheOptions | CreateIdGeneratorWithFilesystemOptions | CreateIdGeneratorEmptyOptions;
 interface ButtonGroup {
     id?: string;
 }
@@ -65,11 +103,10 @@ export declare function getFragmentAndViewFiles(appPath: string, fs: Editor): Pr
  * Creates an ID generator function for a given base path and editor.
  * The generator ensures unique IDs across all fragment and view files in the project.
  *
- * @param basePath - Base path of the project
- * @param fsEditor - mem-fs-editor instance
- * @returns A function that generates unique IDs based on a base ID string
+ * @param options - Options for creating the ID generator
+ * @returns A function that generates unique IDs based on a base ID string, or a Promise resolving to such function
  */
-export declare function createIdGenerator(basePath: string | undefined, fsEditor: Editor): Promise<(baseId: string) => string>;
+export declare function createIdGenerator(options?: CreateIdGeneratorOptions): Promise<IdGeneratorFunction> | IdGeneratorFunction;
 export declare const COPY_TEMPLATE_OPTIONS: CopyOptions & {
     noGlob: boolean;
 };

package/dist/common/file.js

@@ -10,7 +10,7 @@ exports.copyTpl = copyTpl;
 exports.getRelativeTemplateComponentPath = getRelativeTemplateComponentPath;
 const node_path_1 = require("node:path");
 const file_1 = require("@sap-ux/project-access/dist/file");
-const utils_1 = require("./utils");
+const xmldom_1 = require("@xmldom/xmldom");
 const CHAR_SPACE = ' ';
 const CHAR_TAB = '\t';
 exports.CONFIG = {
@@ -105,20 +105,24 @@ exports.CONFIG = {
  * Generates a unique element ID that is not already used in any view or fragment file.
  * Uses an incremental counter for predictable, readable IDs.
  *
- * @param fs - The file system object for reading files
  * @param baseId - The base name for the ID (e.g., 'filterBar', 'chart')
- * @param filteredFiles - The list of files to check for ID availability
+ * @param filteredFilesContent - The list of files to check for ID availability
  * @param validatedIds - A list of IDs that have already been validated in the current session to avoid duplicates
  * @returns A unique ID that is available across all view and fragment files
  */
-function generateUniqueElementId(fs, baseId, filteredFiles, validatedIds = []) {
+function generateUniqueElementId(baseId, filteredFilesContent, validatedIds = []) {
     const maxAttempts = 1000;
-    if (filteredFiles.every((file) => (0, utils_1.isElementIdAvailable)(fs, file, baseId)) && !validatedIds.includes(baseId)) {
+    function checkElementIdAvailable(id, xmlContent) {
+        const xmlDocument = new xmldom_1.DOMParser({ errorHandler: () => { } }).parseFromString(xmlContent);
+        return xmlDocument.documentElement ? !xmlDocument.getElementById(id) : true;
+    }
+    if (filteredFilesContent.every((content) => content === '' || checkElementIdAvailable(baseId, content)) &&
+        !validatedIds.includes(baseId)) {
         return baseId;
     }
     for (let counter = 1; counter < maxAttempts; counter++) {
         const candidateId = `${baseId}${counter}`;
-        if (filteredFiles.every((file) => (0, utils_1.isElementIdAvailable)(fs, file, candidateId)) &&
+        if (filteredFilesContent.every((content) => content === '' || checkElementIdAvailable(candidateId, content)) &&
             !validatedIds.includes(candidateId)) {
             return candidateId;
         }
@@ -142,18 +146,26 @@ async function getFragmentAndViewFiles(appPath, fs) {
  * Creates an ID generator function for a given base path and editor.
  * The generator ensures unique IDs across all fragment and view files in the project.
  *
- * @param basePath - Base path of the project
- * @param fsEditor - mem-fs-editor instance
- * @returns A function that generates unique IDs based on a base ID string
+ * @param options - Options for creating the ID generator
+ * @returns A function that generates unique IDs based on a base ID string, or a Promise resolving to such function
  */
-async function createIdGenerator(basePath, fsEditor) {
-    let files = [];
-    if (basePath) {
-        files = await getFragmentAndViewFiles(basePath, fsEditor);
-    }
-    return (baseId, validatedIds = []) => {
-        return generateUniqueElementId(fsEditor, baseId, files, validatedIds);
+function createIdGenerator(options = {}) {
+    const { basePath, fsEditor, fileContentCache = [] } = options;
+    const createGenerator = (fileContents) => {
+        return (baseId, validatedIds = []) => {
+            return generateUniqueElementId(baseId, fileContents, validatedIds);
+        };
     };
+    if (fileContentCache.length > 0) {
+        return createGenerator(fileContentCache);
+    }
+    if (fsEditor && basePath) {
+        return getFragmentAndViewFiles(basePath, fsEditor).then((filePaths) => {
+            const fileContents = filePaths.map((path) => fsEditor.read(path).toString());
+            return createGenerator(fileContents);
+        });
+    }
+    return createGenerator([]);
 }
 // `noGlob` is supported in `mem-fs-editor` v9,
 // but is missing from `@types/mem-fs-editor` (no v9 typings), so we extend the type here.

package/dist/field/index.js

@@ -53,7 +53,7 @@ async function generateCustomField(basePath, customField, fs) {
     (0, validate_1.validateVersion)(customField.minUI5Version);
     fs ??= (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     await (0, validate_1.validateBasePath)(basePath, fs);
-    const generateId = await (0, file_1.createIdGenerator)(basePath, fs);
+    const generateId = await (0, file_1.createIdGenerator)({ basePath, fsEditor: fs });
     const { path: manifestPath, content: manifest } = await (0, utils_1.getManifest)(basePath, fs);
     // merge with defaults
     const completeField = enhanceConfig(fs, customField, manifestPath, manifest, generateId);

package/dist/filter/index.js

@@ -48,7 +48,7 @@ async function generateCustomFilter(basePath, filterConfig, fs) {
         fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     }
     await (0, validate_1.validateBasePath)(basePath, fs);
-    const fnGenerateId = await (0, file_1.createIdGenerator)(basePath, fs);
+    const fnGenerateId = await (0, file_1.createIdGenerator)({ basePath, fsEditor: fs });
     const { path: manifestPath, content: manifest } = await (0, utils_1.getManifest)(basePath, fs);
     const config = enhanceConfig(filterConfig, manifestPath, manifest);
     // Apply event handler

package/dist/index.d.ts

@@ -14,6 +14,7 @@ export { CustomView } from './view/types';
 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 { generateBuildingBlock, getSerializedFileContent } from './building-block';
 export { ChartPromptsAnswer, FilterBarPromptsAnswer, FormPromptsAnswer, TablePromptsAnswer, PagePromptsAnswer, RichTextEditorPromptsAnswer, RichTextEditorButtonGroupsPromptsAnswer, BuildingBlockTypePromptsAnswer } from './building-block/prompts/questions';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initI18n = exports.generateCustomField = exports.generateControllerExtension = exports.ControllerExtensionPageType = exports.PromptsAPI = exports.PromptsType = exports.getSerializedFileContent = exports.generateBuildingBlock = exports.BuildingBlockType = exports.validateVersion = exports.validateBasePath = exports.enableFPM = exports.generateCustomView = exports.generateCustomFilter = exports.generateCustomHeaderSection = exports.generateCustomSubSection = exports.generateCustomSection = exports.DesignTime = exports.RequestGroupId = exports.generateCustomColumn = exports.generateActionMenu = exports.ActionMenuTargetControl = exports.generateCustomAction = exports.TargetControl = exports.generateListReport = exports.generateObjectPage = exports.generateCustomPage = void 0;
+exports.initI18n = exports.generateCustomField = exports.generateControllerExtension = exports.ControllerExtensionPageType = exports.PromptsAPI = exports.PromptsType = exports.getSerializedFileContent = exports.generateBuildingBlock = exports.BuildingBlockType = exports.getRelativeTemplateComponentPath = exports.createIdGenerator = exports.validateVersion = exports.validateBasePath = exports.enableFPM = exports.generateCustomView = exports.generateCustomFilter = exports.generateCustomHeaderSection = exports.generateCustomSubSection = exports.generateCustomSection = exports.DesignTime = exports.RequestGroupId = exports.generateCustomColumn = exports.generateActionMenu = exports.ActionMenuTargetControl = exports.generateCustomAction = exports.TargetControl = exports.generateListReport = exports.generateObjectPage = exports.generateCustomPage = void 0;
 var page_1 = require("./page");
 Object.defineProperty(exports, "generateCustomPage", { enumerable: true, get: function () { return page_1.generateCustomPage; } });
 Object.defineProperty(exports, "generateObjectPage", { enumerable: true, get: function () { return page_1.generateObjectPage; } });
@@ -31,6 +31,9 @@ Object.defineProperty(exports, "enableFPM", { enumerable: true, get: function ()
 var validate_1 = require("./common/validate");
 Object.defineProperty(exports, "validateBasePath", { enumerable: true, get: function () { return validate_1.validateBasePath; } });
 Object.defineProperty(exports, "validateVersion", { enumerable: true, get: function () { return validate_1.validateVersion; } });
+var file_1 = require("./common/file");
+Object.defineProperty(exports, "createIdGenerator", { enumerable: true, get: function () { return file_1.createIdGenerator; } });
+Object.defineProperty(exports, "getRelativeTemplateComponentPath", { enumerable: true, get: function () { return file_1.getRelativeTemplateComponentPath; } });
 var types_4 = require("./building-block/types");
 Object.defineProperty(exports, "BuildingBlockType", { enumerable: true, get: function () { return types_4.BuildingBlockType; } });
 var building_block_1 = require("./building-block");

package/dist/page/custom.js

@@ -118,7 +118,7 @@ async function generate(basePath, data, fs, log) {
     (0, validate_1.validateVersion)(data.minUI5Version);
     await (0, common_1.validatePageConfig)(basePath, data, fs, []);
     const manifestPath = await (0, utils_1.getManifestPath)(basePath, fs);
-    const fnGenerateId = await (0, file_1.createIdGenerator)(basePath, fs);
+    const fnGenerateId = await (0, file_1.createIdGenerator)({ basePath, fsEditor: fs });
     const config = enhanceData(data, manifestPath, fs);
     // merge content into existing files
     const root = getTemplateRoot(data.minUI5Version);

package/dist/section/index.js

@@ -85,7 +85,7 @@ async function generate(basePath, customSection, manifestTemplateRoot, fs) {
     (0, validate_1.validateVersion)(customSection.minUI5Version);
     fs ??= (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     await (0, validate_1.validateBasePath)(basePath, fs);
-    const fnGenerateId = await (0, file_1.createIdGenerator)(basePath, fs);
+    const fnGenerateId = await (0, file_1.createIdGenerator)({ basePath, fsEditor: fs });
     const { path: manifestPath, content: manifest } = await (0, utils_1.getManifest)(basePath, fs);
     // merge with defaults
     const completeSection = enhanceConfig(fs, customSection, manifestPath, manifest, fnGenerateId);
@@ -113,7 +113,7 @@ async function generate(basePath, customSection, manifestTemplateRoot, fs) {
  */
 async function generateCustomHeaderSection(basePath, customHeaderSection, fs) {
     const fsEditor = fs ?? (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
-    const fnGenerateId = await (0, file_1.createIdGenerator)(basePath, fsEditor); // initialize ID generator to ensure unique IDs across both section and edit fragment
+    const fnGenerateId = await (0, file_1.createIdGenerator)({ basePath, fsEditor }); // initialize ID generator to ensure unique IDs across both section and edit fragment
     const manifestRoot = getManifestRoot('header-section', customHeaderSection.minUI5Version);
     const minVersion = (0, semver_1.coerce)(customHeaderSection.minUI5Version);
     let editSection;

package/dist/view/index.js

@@ -85,7 +85,7 @@ async function generateCustomView(basePath, customView, fs) {
     (0, validate_1.validateVersion)(customView.minUI5Version);
     fs ??= (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     await (0, validate_1.validateBasePath)(basePath, fs);
-    const fnGenerateId = await (0, file_1.createIdGenerator)(basePath, fs);
+    const fnGenerateId = await (0, file_1.createIdGenerator)({ basePath, fsEditor: fs });
     const { path: manifestPath, content: manifest } = await (0, utils_1.getManifest)(basePath, fs);
     // merge with defaults
     const completeView = enhanceConfig(fs, customView, manifestPath, manifest, fnGenerateId);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/fe-fpm-writer",
   "description": "SAP Fiori elements flexible programming model writer",
-  "version": "0.43.12",
+  "version": "0.43.13",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",