@sap-ux/adp-tooling 0.14.34 → 0.14.35

package/dist/preview/adp-preview.d.ts

@@ -2,7 +2,7 @@ import type { ReaderCollection } from '@ui5/fs';
 import type { MiddlewareUtils } from '@ui5/server';
 import type { NextFunction, Request, Response, Router } from 'express';
 import type { Logger, ToolsLogger } from '@sap-ux/logger';
-import type { UI5FlexLayer } from '@sap-ux/project-access';
+import { type UI5FlexLayer } from '@sap-ux/project-access';
 import type { MergedAppDescriptor } from '@sap-ux/axios-extension';
 import type { AdpPreviewConfig, CommonChangeProperties, DescriptorVariant, OperationType, CommonAdditionalChangeInfoProperties } from '../types';
 import type { Editor } from 'mem-fs-editor';

package/dist/preview/adp-preview.js

@@ -8,6 +8,7 @@ const adm_zip_1 = __importDefault(require("adm-zip"));
 const system_access_1 = require("@sap-ux/system-access");
 const routes_handler_1 = __importDefault(require("./routes-handler"));
 const change_handler_1 = require("./change-handler");
+const descriptor_change_handler_1 = require("./descriptor-change-handler");
 /**
  * Instance of an adaptation project handling requests and data transformation.
  */
@@ -218,6 +219,9 @@ class AdpPreview {
                 if ((0, change_handler_1.isAddAnnotationChange)(change)) {
                     await (0, change_handler_1.addAnnotationFile)(this.util.getProject().getSourcePath(), this.util.getProject().getRootPath(), change, fs, logger, this.provider);
                 }
+                if ((0, change_handler_1.isV4DescriptorChange)(change)) {
+                    (0, descriptor_change_handler_1.addCustomSectionFragment)(this.util.getProject().getSourcePath(), change, fs, logger);
+                }
                 break;
             default:
                 // no need to handle delete changes

package/dist/preview/change-handler.d.ts

@@ -1,7 +1,17 @@
 import type { Editor } from 'mem-fs-editor';
-import type { AddXMLChange, CommonChangeProperties, CodeExtChange, AnnotationFileChange, CommonAdditionalChangeInfoProperties } from '../types';
+import type { AddXMLChange, CommonChangeProperties, CodeExtChange, AnnotationFileChange, CommonAdditionalChangeInfoProperties, AppDescriptorV4Change } from '../types';
 import type { Logger } from '@sap-ux/logger';
 import type { AbapServiceProvider } from '@sap-ux/axios-extension';
+interface FragmentTemplateConfig<T = {
+    [key: string]: any;
+}> {
+    /**
+     * Relative path to ../../templates/rta, includes template file name
+     */
+    path: string;
+    getData: (change: AddXMLChange) => T;
+}
+export declare const fragmentTemplateDefinitions: Record<string, FragmentTemplateConfig>;
 /**
  * A mapping object that defines how to extract change content data from changes based on their type.
  */
@@ -45,6 +55,14 @@ export declare function isCodeExtChange(change: CommonChangeProperties): change
  *          indicating the change is of type `AnnotationFileChange`.
  */
 export declare function isAddAnnotationChange(change: CommonChangeProperties): change is AnnotationFileChange;
+/**
+ * Determines whether a given change is of type `V4 Descriptor Change`.
+ *
+ * @param {CommonChangeProperties} change - The change object to check.
+ * @returns {boolean} `true` if the `changeType` is either 'appdescr_fe_changePageConfiguration',
+ *          indicating the change is of type `V4 Descriptor Change`.
+ */
+export declare function isV4DescriptorChange(change: CommonChangeProperties): change is AppDescriptorV4Change;
 /**
  * Asynchronously adds an XML fragment to the project if it doesn't already exist.
  *
@@ -76,4 +94,5 @@ export declare function addControllerExtension(rootPath: string, basePath: strin
  *@param {AbapServiceProvider} provider - abap provider.
  */
 export declare function addAnnotationFile(basePath: string, projectRoot: string, change: AnnotationFileChange, fs: Editor, logger: Logger, provider: AbapServiceProvider): Promise<void>;
+export {};
 //# sourceMappingURL=change-handler.d.ts.map

package/dist/preview/change-handler.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.moduleNameContentMap = void 0;
+exports.moduleNameContentMap = exports.fragmentTemplateDefinitions = void 0;
 exports.tryFixChange = tryFixChange;
 exports.isAddXMLChange = isAddXMLChange;
 exports.isCodeExtChange = isCodeExtChange;
 exports.isAddAnnotationChange = isAddAnnotationChange;
+exports.isV4DescriptorChange = isV4DescriptorChange;
 exports.addXmlFragment = addXmlFragment;
 exports.addControllerExtension = addControllerExtension;
 exports.addAnnotationFile = addAnnotationFile;
@@ -25,7 +26,7 @@ const V4_MDC_TABLE_COLUMN = 'V4_MDC_TABLE_COLUMN';
 const ANALYTICAL_TABLE_COLUMN = 'ANALYTICAL_TABLE_COLUMN';
 const GRID_TREE_TABLE_COLUMN = 'GRID_TREE_TABLE_COLUMN';
 const TABLE_ACTION = 'TABLE_ACTION';
-const fragmentTemplateDefinitions = {
+exports.fragmentTemplateDefinitions = {
     [OBJECT_PAGE_CUSTOM_SECTION]: {
         path: 'common/op-custom-section.xml',
         getData: () => {
@@ -203,6 +204,16 @@ function isCodeExtChange(change) {
 function isAddAnnotationChange(change) {
     return change.changeType === 'appdescr_app_addAnnotationsToOData';
 }
+/**
+ * Determines whether a given change is of type `V4 Descriptor Change`.
+ *
+ * @param {CommonChangeProperties} change - The change object to check.
+ * @returns {boolean} `true` if the `changeType` is either 'appdescr_fe_changePageConfiguration',
+ *          indicating the change is of type `V4 Descriptor Change`.
+ */
+function isV4DescriptorChange(change) {
+    return change.changeType === 'appdescr_fe_changePageConfiguration';
+}
 /**
  * Asynchronously adds an XML fragment to the project if it doesn't already exist.
  *
@@ -215,7 +226,7 @@ function isAddAnnotationChange(change) {
 function addXmlFragment(basePath, change, fs, logger, additionalChangeInfo) {
     const { fragmentPath } = change.content;
     const fullPath = (0, path_1.join)(basePath, project_access_1.DirName.Changes, fragmentPath);
-    const templateConfig = fragmentTemplateDefinitions[additionalChangeInfo?.templateName ?? ''];
+    const templateConfig = exports.fragmentTemplateDefinitions[additionalChangeInfo?.templateName ?? ''];
     try {
         if (templateConfig) {
             const fragmentTemplatePath = (0, path_1.join)(__dirname, '../../templates/rta', templateConfig.path);

package/dist/preview/descriptor-change-handler.d.ts

@@ -0,0 +1,28 @@
+import type { Editor } from 'mem-fs-editor';
+import { type AppDescriptorV4Change } from '../types';
+import type { Logger } from '@sap-ux/logger';
+export declare const customFragmentConfig: {
+    path: string;
+    getData: () => {
+        ids: Record<string, string>;
+    };
+};
+/**
+ * Checks if the given object has a 'template' property of type string.
+ *
+ * @param obj - The object to check.
+ * @returns True if the object has a 'template' property of type string, false otherwise.
+ */
+export declare function hasTemplate(obj: unknown): obj is {
+    template: string;
+};
+/**
+ * Adds a custom XML fragment file based on the provided AppDescriptorV4Change and template configuration.
+ *
+ * @param basePath - The base path where the fragment should be created.
+ * @param change - The AppDescriptorV4Change object containing change details.
+ * @param fs - The mem-fs-editor instance for file operations.
+ * @param logger - The logger instance for logging information and errors.
+ */
+export declare function addCustomSectionFragment(basePath: string, change: AppDescriptorV4Change, fs: Editor, logger: Logger): void;
+//# sourceMappingURL=descriptor-change-handler.d.ts.map

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

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customFragmentConfig = void 0;
+exports.hasTemplate = hasTemplate;
+exports.addCustomSectionFragment = addCustomSectionFragment;
+const path_1 = require("path");
+const utils_1 = require("./utils");
+const crypto_1 = require("crypto");
+const ejs_1 = require("ejs");
+exports.customFragmentConfig = {
+    path: 'v4/custom-section.xml',
+    getData: () => {
+        const uuid = (0, crypto_1.randomBytes)(4).toString('hex');
+        return {
+            ids: {
+                hBox: `hbox-${uuid}`
+            }
+        };
+    }
+};
+/**
+ * Checks if the given object has a 'template' property of type string.
+ *
+ * @param obj - The object to check.
+ * @returns True if the object has a 'template' property of type string, false otherwise.
+ */
+function hasTemplate(obj) {
+    return typeof obj === 'object' && obj !== null && 'template' in obj && typeof obj.template === 'string';
+}
+/**
+ * Adds a custom XML fragment file based on the provided AppDescriptorV4Change and template configuration.
+ *
+ * @param basePath - The base path where the fragment should be created.
+ * @param change - The AppDescriptorV4Change object containing change details.
+ * @param fs - The mem-fs-editor instance for file operations.
+ * @param logger - The logger instance for logging information and errors.
+ */
+function addCustomSectionFragment(basePath, change, fs, logger) {
+    const propertyValue = change.content.entityPropertyChange.propertyValue;
+    const isCustomSectionPropertyPath = change.content.entityPropertyChange.propertyPath.startsWith('content/body/sections/');
+    if (isCustomSectionPropertyPath && hasTemplate(propertyValue)) {
+        const { template } = propertyValue;
+        const path = (0, utils_1.getFragmentPathFromTemplate)(template, change);
+        try {
+            if (!path) {
+                throw new Error('Fragment Path could not be determined');
+            }
+            const fragmentPath = `${path}.fragment.xml`;
+            const fullPath = (0, path_1.join)(basePath, fragmentPath);
+            const fragmentTemplatePath = (0, path_1.join)(__dirname, '../../templates/rta', exports.customFragmentConfig.path);
+            const text = fs.read(fragmentTemplatePath);
+            const template = (0, ejs_1.render)(text, exports.customFragmentConfig.getData());
+            fs.write(fullPath, template);
+            logger.info(`XML Fragment "${fragmentPath}" was created`);
+        }
+        catch (error) {
+            logger.error(`Failed to create XML Fragment: ${error}`);
+        }
+    }
+}
+//# sourceMappingURL=descriptor-change-handler.js.map

package/dist/preview/utils.d.ts

@@ -0,0 +1,10 @@
+import type { AppDescriptorV4Change } from '../types';
+/**
+ * Generates the fragment path from the given template string and change object.
+ *
+ * @param template - The template string representing the fragment.
+ * @param change - The AppDescriptorV4Change object containing change details.
+ * @returns The computed fragment path as a string.
+ */
+export declare function getFragmentPathFromTemplate(template: string, change: AppDescriptorV4Change): string | undefined;
+//# sourceMappingURL=utils.d.ts.map

package/dist/preview/utils.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFragmentPathFromTemplate = getFragmentPathFromTemplate;
+const project_access_1 = require("@sap-ux/project-access");
+const path_1 = require("path");
+/**
+ * Generates the fragment path from the given template string and change object.
+ *
+ * @param template - The template string representing the fragment.
+ * @param change - The AppDescriptorV4Change object containing change details.
+ * @returns The computed fragment path as a string.
+ */
+function getFragmentPathFromTemplate(template, change) {
+    const segments = template.split(`${change.projectId}.${project_access_1.DirName.Changes}.${project_access_1.DirName.Fragments}.`);
+    const [namespace, fileName] = segments;
+    if (segments.length === 2 && namespace === '') {
+        return (0, path_1.join)(project_access_1.DirName.Changes, project_access_1.DirName.Fragments, fileName);
+    }
+    return undefined;
+}
+//# sourceMappingURL=utils.js.map

package/dist/types.d.ts

@@ -260,6 +260,16 @@ export interface AddXMLChange extends CommonChangeProperties {
     dependentSelector: Record<string, unknown>;
     jsOnly: boolean;
 }
+export interface AppDescriptorV4Change<T = unknown> extends CommonChangeProperties {
+    changeType: 'appdescr_fe_changePageConfiguration';
+    content: {
+        entityPropertyChange: {
+            propertyPath: string;
+            operation: string;
+            propertyValue: string | boolean | number | T;
+        };
+    };
+}
 export interface CodeExtChange extends CommonChangeProperties {
     changeType: 'codeExt';
     content: {

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aadp-tooling"
   },
-  "version": "0.14.34",
+  "version": "0.14.35",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",

package/templates/rta/common/op-custom-section.xml

@@ -6,7 +6,7 @@
 >
     <uxap:ObjectPageSection
         id="<%- ids.objectPageSection %>"
-        title="New custom section"
+        title="New Custom Section"
     >
         <uxap:ObjectPageSubSection id="<%- ids.objectPageSubSection %>">
             <HBox id="<%- ids.hBox %>">

package/templates/rta/v4/custom-section.xml

@@ -0,0 +1,9 @@
+<!-- Use stable and unique IDs!-->
+<core:FragmentDefinition
+    xmlns:core='sap.ui.core'
+    xmlns='sap.m'
+>
+    <HBox id="<%- ids.hBox %>">
+        <!--  add your xml here -->
+    </HBox>
+</core:FragmentDefinition>