@sap-ux/adp-tooling 1.0.16 → 1.0.17

package/dist/base/change-utils.js

@@ -1,11 +1,25 @@
-import path, { dirname } from 'node:path';
-import { fileURLToPath } from 'node:url';
+import path from 'node:path';
 import { existsSync, readFileSync, readdirSync } from 'node:fs';
-const __dirname = dirname(fileURLToPath(import.meta.url));
 import { DirName, getWebappPath } from '@sap-ux/project-access';
+import { getTemplatePath } from '../templates.js';
 import { FlexLayer, TemplateFileName, ChangeTypeMap } from '../types.js';
 import { renderFile } from 'ejs';
 import { replaceTextsWithI18nBindings, writeKeyUserTranslations } from '../writer/i18n/key-user-translations.js';
+/**
+ * Returns the change file extension matching the change's `fileType` (e.g. `.ctrl_variant`,
+ * `.annotation_change`, `.change`). Falls back to `.change` when `fileType` is missing or
+ * empty so malformed or legacy payloads do not produce extension-less files.
+ *
+ * The UI5 Flex frontend routes change files by their suffix; the suffix must match the
+ * embedded `fileType`, otherwise non-`change` types (e.g. `ctrl_variant`, `annotation_change`)
+ * are misclassified at runtime.
+ *
+ * @param fileType - The change's `fileType` value, if present.
+ * @returns The file extension, including the leading dot.
+ */
+function getChangeFileExtension(fileType) {
+    return fileType ? `.${fileType}` : '.change';
+}
 /**
  * Writes annotation changes to the specified project path using the provided `mem-fs-editor` instance.
  *
@@ -23,14 +37,14 @@ export async function writeAnnotationChange(projectPath, timestamp, annotation,
         const changesFolderPath = path.join(webappPath, DirName.Changes);
         const annotationsFolderPath = path.join(changesFolderPath, DirName.Annotations);
         if (change) {
-            const changeFileName = `${change.fileName}.change`;
+            const changeFileName = `${change.fileName}${getChangeFileExtension(change.fileType)}`;
             const changeFilePath = path.join(changesFolderPath, changeFileName);
             writeChangeToFile(changeFilePath, change, fs);
         }
         if (!annotation.filePath) {
             const annotationsTemplate = templatesPath
                 ? path.join(templatesPath, 'changes', TemplateFileName.Annotation)
-                : path.join(__dirname, '..', '..', 'templates', 'changes', TemplateFileName.Annotation);
+                : getTemplatePath(`changes/${TemplateFileName.Annotation}`);
             const { namespaces, serviceUrl } = annotation;
             const schemaNamespace = `local_${timestamp}`;
             renderFile(annotationsTemplate, { namespaces, path: serviceUrl, schemaNamespace }, {}, (err, str) => {
@@ -125,7 +139,7 @@ export async function writeChangeToFolder(projectPath, change, fs, dir = '') {
         if (dir) {
             targetFolderPath = path.join(targetFolderPath, dir);
         }
-        const fileName = `${change.fileName}.change`;
+        const fileName = `${change.fileName}${getChangeFileExtension(change.fileType)}`;
         const filePath = path.join(targetFolderPath, fileName);
         writeChangeToFile(filePath, change, fs);
     }

package/dist/cf/services/api.js

@@ -1,14 +1,12 @@
 import * as fs from 'node:fs';
 import axios from 'axios';
 import * as path from 'node:path';
-import { fileURLToPath } from 'node:url';
 import { Cli } from '@sap/cf-tools';
-import { dirname } from 'node:path';
-const __dirname = dirname(fileURLToPath(import.meta.url));
 import { isAppStudio } from '@sap-ux/btp-utils';
 import { t } from '../../i18n.js';
 import { getProjectNameForXsSecurity } from '../project/index.js';
 import { createServiceKey, getServiceKeys, requestCfApi } from './cli.js';
+import { getTemplatePath } from '../../templates.js';
 const PARAM_MAP = new Map([
     ['spaceGuids', 'space_guids'],
     ['planNames', 'service_plan_names'],
@@ -179,7 +177,7 @@ export async function createServiceInstance(plan, serviceInstanceName, serviceNa
         if (xsSecurityProjectName) {
             let xsSecurity = null;
             try {
-                const baseTmplPath = path.join(__dirname, '../../../templates');
+                const baseTmplPath = getTemplatePath();
                 const templatePath = templatePathOverwrite ?? baseTmplPath;
                 const filePath = path.resolve(templatePath, 'cf/xs-security.json');
                 const xsContent = fs.readFileSync(filePath, 'utf-8');

package/dist/preview/change-handler.js

@@ -1,9 +1,8 @@
 import { ChangeType, TemplateFileName } from '../types.js';
-import { basename, dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
+import { basename, join } from 'node:path';
 import { render } from 'ejs';
 import { randomBytes } from 'node:crypto';
-const __dirname = dirname(fileURLToPath(import.meta.url));
+import { getTemplatePath } from '../templates.js';
 import { ManifestService } from '../base/abap/manifest-service.js';
 import { getVariant, isTypescriptSupported } from '../base/helper.js';
 import { getAnnotationNamespaces } from '@sap-ux/odata-service-writer';
@@ -221,7 +220,7 @@ export function addXmlFragment(basePath, change, fs, logger, additionalChangeInf
     const templateConfig = fragmentTemplateDefinitions[additionalChangeInfo?.templateName ?? ''];
     try {
         if (templateConfig) {
-            const fragmentTemplatePath = join(__dirname, '../../templates/rta', templateConfig.path);
+            const fragmentTemplatePath = getTemplatePath(`rta/${templateConfig.path}`);
             const text = fs.read(fragmentTemplatePath);
             const changeTemplate = {
                 ...templateConfig.getData(change),
@@ -235,7 +234,7 @@ export function addXmlFragment(basePath, change, fs, logger, additionalChangeInf
         else {
             // use default fragment template
             const templateName = 'fragment.xml'; /* TemplateFileName.Fragment */
-            const fragmentTemplatePath = join(__dirname, '../../templates/rta', templateName);
+            const fragmentTemplatePath = getTemplatePath(`rta/${templateName}`);
             const text = fs.read(fragmentTemplatePath);
             const template = render(text, {
                 viewName: additionalChangeInfo?.viewName,
@@ -265,7 +264,7 @@ export async function addControllerExtension(rootPath, basePath, change, fs, log
     const fileName = basename(codeRef, '.js');
     const fullName = `${fileName}.${isTsSupported ? 'ts' : 'js'}`;
     const tmplFileName = isTsSupported ? TemplateFileName.TSController : TemplateFileName.Controller;
-    const tmplPath = join(__dirname, '../../templates/rta', tmplFileName);
+    const tmplPath = getTemplatePath(`rta/${tmplFileName}`);
     try {
         const text = fs.read(tmplPath);
         const id = (await getVariant(rootPath))?.id;

package/dist/preview/descriptor-change-handler.js

@@ -1,9 +1,8 @@
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
+import { join } from 'node:path';
 import { getFragmentPathFromTemplate } from './utils.js';
 import { randomBytes } from 'node:crypto';
 import { render } from 'ejs';
-const __dirname = dirname(fileURLToPath(import.meta.url));
+import { getTemplatePath } from '../templates.js';
 export const customFragmentConfig = {
     path: 'v4/custom-section.xml',
     getData: () => {
@@ -81,7 +80,7 @@ export function addCustomFragment(basePath, change, fs, logger) {
             }
             const fragmentPath = `${path}.fragment.xml`;
             const fullPath = join(basePath, fragmentPath);
-            const fragmentTemplatePath = join(__dirname, '../../templates/rta', config.path);
+            const fragmentTemplatePath = getTemplatePath(`rta/${config.path}`);
             const text = fs.read(fragmentTemplatePath);
             // Safe: Template files are from our own codebase (templates/rta/), config.path is from getConfig()
             // which only returns predefined paths (customFragmentConfig or customColumnFragmentConfig).

package/dist/preview/routes-handler.js

@@ -1,16 +1,14 @@
 import * as fs from 'node:fs';
 import * as os from 'node:os';
 import * as path from 'node:path';
-import { fileURLToPath } from 'node:url';
 import { renderFile } from 'ejs';
-import { dirname } from 'node:path';
-const __dirname = dirname(fileURLToPath(import.meta.url));
 import sanitize from 'sanitize-filename';
 import { isAppStudio } from '@sap-ux/btp-utils';
 import { TemplateFileName, HttpStatusCodes } from '../types.js';
 import { DirName } from '@sap-ux/project-access';
 import { ManifestService } from '../base/abap/manifest-service.js';
 import { getVariant, isTypescriptSupported } from '../base/helper.js';
+import { getTemplatePath } from '../templates.js';
 /**
  * @description Handles API Routes
  */
@@ -337,7 +335,7 @@ async function generateControllerFile(rootPath, filePath, name) {
     const id = (await getVariant(rootPath))?.id;
     const isTsSupported = isTypescriptSupported(rootPath);
     const tmplFileName = isTsSupported ? TemplateFileName.TSController : TemplateFileName.Controller;
-    const tmplPath = path.join(__dirname, '../../templates/rta', tmplFileName);
+    const tmplPath = getTemplatePath(`rta/${tmplFileName}`);
     const extensionPath = `${id}.${name}`;
     const templateData = isTsSupported ? { name, ns: id } : { extensionPath };
     renderFile(tmplPath, templateData, {}, (err, str) => {

package/dist/templates.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Locates template files relative to the dist folder.
+ * This helps to locate templates when this module is bundled and the dir structure is flattened, maintaining the relative paths.
+ *
+ * @param relativeTemplatePath - optional, the path of the required template relative to the ./templates folder. If not specified the root templates folder is returned.
+ * @returns the path of the template specified or templates root folder
+ */
+export declare function getTemplatePath(relativeTemplatePath?: string): string;
+//# sourceMappingURL=templates.d.ts.map

package/dist/templates.js

@@ -0,0 +1,14 @@
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+const __dirname = dirname(fileURLToPath(import.meta.url));
+/**
+ * Locates template files relative to the dist folder.
+ * This helps to locate templates when this module is bundled and the dir structure is flattened, maintaining the relative paths.
+ *
+ * @param relativeTemplatePath - optional, the path of the required template relative to the ./templates folder. If not specified the root templates folder is returned.
+ * @returns the path of the template specified or templates root folder
+ */
+export function getTemplatePath(relativeTemplatePath = '') {
+    return join(__dirname, '../templates', relativeTemplatePath);
+}
+//# sourceMappingURL=templates.js.map

package/dist/writer/index.js

@@ -1,5 +1,4 @@
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
+import { join } from 'node:path';
 import { create as createStorage } from 'mem-fs';
 import { create } from 'mem-fs-editor';
 import { getManifestContent } from './manifest/index.js';
@@ -8,8 +7,7 @@ import { writeTemplateToFolder, writeUI5Yaml, writeUI5DeployYaml } from './proje
 import { FlexLayer } from '../types.js';
 import { getApplicationType } from '../source/index.js';
 import { writeKeyUserChanges } from '../base/change-utils.js';
-const __dirname = dirname(fileURLToPath(import.meta.url));
-const baseTmplPath = join(__dirname, '../../templates');
+import { getTemplatePath } from '../templates.js';
 /**
  * Set default values for optional properties.
  *
@@ -50,7 +48,7 @@ export async function generate(basePath, config, fs) {
         fs = create(createStorage());
     }
     const fullConfig = setDefaults(config);
-    const templatePath = config.options?.templatePathOverwrite ?? baseTmplPath;
+    const templatePath = config.options?.templatePathOverwrite ?? getTemplatePath();
     writeI18nModels(basePath, fullConfig.app.i18nModels, fs);
     writeTemplateToFolder(templatePath, join(basePath), fullConfig, fs);
     await writeUI5DeployYaml(basePath, fullConfig, fs);
@@ -71,7 +69,7 @@ export async function migrate(basePath, config, fs) {
         fs = create(createStorage());
     }
     const fullConfig = setDefaults(config);
-    const tmplPath = join(baseTmplPath, 'project');
+    const tmplPath = join(getTemplatePath(), 'project');
     // Copy the specified files to target project
     fs.copyTpl(join(tmplPath, '**/ui5.yaml'), join(basePath), fullConfig, undefined, {
         globOptions: { dot: true }

package/dist/writer/project-utils.js

@@ -1,7 +1,6 @@
-import { dirname, join } from 'node:path';
-import { fileURLToPath } from 'node:url';
+import { join } from 'node:path';
 import { readFileSync } from 'node:fs';
-const __dirname = dirname(fileURLToPath(import.meta.url));
+import { getTemplatePath } from '../templates.js';
 import { enhanceUI5DeployYaml, enhanceUI5Yaml, hasDeployConfig, enhanceUI5YamlWithCustomConfig, enhanceUI5YamlWithCustomTask, enhanceUI5YamlWithTranspileMiddleware, enhanceUI5YamlWithCfCustomTask, enhanceUI5YamlWithFioriToolsMiddleware } from './options.js';
 import { UI5Config, UI5_DEFAULT, getEsmTypesVersion, getTypesPackage, getTypesVersion } from '@sap-ux/ui5-config';
 /**
@@ -15,7 +14,7 @@ export function getPackageJSONInfo() {
         version: 'NO_VERSION_FOUND'
     };
     try {
-        return JSON.parse(readFileSync(join(__dirname, '../../package.json'), 'utf-8'));
+        return JSON.parse(readFileSync(join(getTemplatePath(), '../package.json'), 'utf-8'));
     }
     catch (e) {
         return defaultPackage;
@@ -189,8 +188,7 @@ export async function writeUI5DeployYaml(projectPath, data, fs) {
  * @param {Editor} fs - The memfs editor instance.
  */
 export async function writeCfTemplates(basePath, variant, config, fs) {
-    const baseTmplPath = join(__dirname, '../../templates');
-    const templatePath = config.options?.templatePathOverwrite ?? baseTmplPath;
+    const templatePath = config.options?.templatePathOverwrite ?? getTemplatePath();
     const { app, project, options } = config;
     fs.copyTpl(join(templatePath, 'project/webapp/manifest.appdescr_variant'), join(project.folder, 'webapp', 'manifest.appdescr_variant'), { app: variant });
     fs.copyTpl(join(templatePath, 'cf/package.json'), join(project.folder, 'package.json'), {

package/package.json

@@ -10,7 +10,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aadp-tooling"
   },
-  "version": "1.0.16",
+  "version": "1.0.17",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -40,10 +40,10 @@
     "@sap-ux/axios-extension": "2.0.3",
     "@sap-ux/btp-utils": "2.0.2",
     "@sap-ux/i18n": "1.0.1",
-    "@sap-ux/inquirer-common": "1.0.11",
+    "@sap-ux/inquirer-common": "1.0.12",
     "@sap-ux/logger": "1.0.1",
     "@sap-ux/nodejs-utils": "1.0.3",
-    "@sap-ux/odata-service-writer": "1.0.6",
+    "@sap-ux/odata-service-writer": "1.0.7",
     "@sap-ux/project-access": "2.1.2",
     "@sap-ux/project-input-validator": "1.0.6",
     "@sap-ux/store": "2.0.1",