@sap-ux/adp-tooling 0.12.39 → 0.12.41

package/dist/base/change-utils.d.ts

@@ -13,12 +13,12 @@ interface InboundChange extends ManifestChangeProperties {
  *
  * @param {string} projectPath - The root path of the project.
  * @param {number} timestamp - The timestamp of the change.
- * @param {AnnotationsData} data - The data object containing information about the annotation change.
+ * @param {AnnotationsData} annotation - The annotation data.
  * @param {ManifestChangeProperties} change - The annotation data change that will be written.
  * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
  * @returns {void}
  */
-export declare function writeAnnotationChange(projectPath: string, timestamp: number, data: AnnotationsData, change: ManifestChangeProperties, fs: Editor): void;
+export declare function writeAnnotationChange(projectPath: string, timestamp: number, annotation: AnnotationsData['annotation'], change: ManifestChangeProperties, fs: Editor): void;
 /**
  * Writes a given change object to a file within a specified folder in the project's 'changes' directory.
  * If an additional subdirectory is specified, the change file is written there.

package/dist/base/change-utils.js

@@ -12,27 +12,26 @@ const project_access_1 = require("@sap-ux/project-access");
  *
  * @param {string} projectPath - The root path of the project.
  * @param {number} timestamp - The timestamp of the change.
- * @param {AnnotationsData} data - The data object containing information about the annotation change.
+ * @param {AnnotationsData} annotation - The annotation data.
  * @param {ManifestChangeProperties} change - The annotation data change that will be written.
  * @param {Editor} fs - The `mem-fs-editor` instance used for file operations.
  * @returns {void}
  */
-function writeAnnotationChange(projectPath, timestamp, data, change, fs) {
+function writeAnnotationChange(projectPath, timestamp, annotation, change, fs) {
     try {
-        const { fileName, answers } = data;
         const changeFileName = `id_${timestamp}_addAnnotationsToOData.change`;
         const changesFolderPath = path_1.default.join(projectPath, project_access_1.DirName.Webapp, project_access_1.DirName.Changes);
         const changeFilePath = path_1.default.join(changesFolderPath, project_access_1.DirName.Manifest, changeFileName);
         const annotationsFolderPath = path_1.default.join(changesFolderPath, project_access_1.DirName.Annotations);
         writeChangeToFile(changeFilePath, change, fs);
-        if (!answers.filePath) {
+        if (!annotation.filePath) {
             const annotationsTemplate = path_1.default.join(__dirname, '..', '..', 'templates', 'changes', "annotation.xml" /* TemplateFileName.Annotation */);
-            fs.copy(annotationsTemplate, path_1.default.join(annotationsFolderPath, fileName ?? ''));
+            fs.copy(annotationsTemplate, path_1.default.join(annotationsFolderPath, annotation.fileName ?? ''));
         }
         else {
-            const selectedDir = path_1.default.dirname(answers.filePath);
+            const selectedDir = path_1.default.dirname(annotation.filePath);
             if (selectedDir !== annotationsFolderPath) {
-                fs.copy(answers.filePath, path_1.default.join(annotationsFolderPath, fileName ?? ''));
+                fs.copy(annotation.filePath, path_1.default.join(annotationsFolderPath, annotation.fileName ?? ''));
             }
         }
     }

package/dist/prompts/add-component-usages/index.js

@@ -100,7 +100,7 @@ function getPrompts(basePath, layer) {
     return [
         {
             type: 'input',
-            name: `id`,
+            name: `usageId`,
             message: (0, i18n_1.t)('prompts.component.usageIdLabel'),
             validate: (value) => validatePromptId(value, componentUsageChangeFiles, isCustomerBase),
             default: isCustomerBase ? "customer." /* NamespacePrefix.CUSTOMER */ : "" /* NamespacePrefix.EMPTY */,

package/dist/prompts/add-new-model/index.js

@@ -83,7 +83,7 @@ function validatePromptODataName(value, answers, isCustomerBase, changeFiles) {
     if ((0, project_input_validator_1.hasContentDuplication)(value, 'dataSource', changeFiles)) {
         return (0, i18n_1.t)('validators.errorDuplicatedValueOData');
     }
-    if (value === answers.dataSourceName) {
+    if (answers.addAnnotationMode && value === answers.dataSourceName) {
         return (0, i18n_1.t)('validators.errorDuplicateNamesOData');
     }
     return true;

package/dist/types.d.ts

@@ -252,42 +252,96 @@ export declare const enum ChangeType {
  */
 export type GeneratorData<T extends ChangeType> = T extends ChangeType.ADD_ANNOTATIONS_TO_ODATA ? AnnotationsData : T extends ChangeType.ADD_COMPONENT_USAGES ? ComponentUsagesData : T extends ChangeType.ADD_LIBRARY_REFERENCE ? ComponentUsagesData : T extends ChangeType.ADD_NEW_MODEL ? NewModelData : T extends ChangeType.CHANGE_DATA_SOURCE ? DataSourceData : T extends ChangeType.CHANGE_INBOUND ? InboundData : never;
 export interface AnnotationsData {
-    fileName?: string;
     variant: DescriptorVariant;
-    answers: AddAnnotationsAnswers;
+    annotation: {
+        /** Optional name of the annotation file. */
+        fileName?: string;
+        /** Data source associated with the annotation. */
+        dataSource: string;
+        /** Optional path to the annotation file. */
+        filePath?: string;
+    };
 }
 export declare const enum AnnotationFileSelectType {
     ExistingFile = 1,
     NewEmptyFile = 2
 }
-export interface ComponentUsagesData {
+export interface ComponentUsagesDataBase {
     variant: DescriptorVariant;
-    answers: AddComponentUsageAnswers;
+    component: {
+        /** Indicates whether the component is loaded lazily. */
+        isLazy: string;
+        /** Unique ID for the component usage. */
+        usageId: string;
+        /** Name of the component. */
+        name: string;
+        /** Serialized data specific to the component. */
+        data: string;
+        /** Settings related to the component. */
+        settings: string;
+    };
+}
+export interface ComponentUsagesDataWithLibrary extends ComponentUsagesDataBase {
+    library: {
+        /** Reference to the component's library. */
+        reference: string;
+        /** Optional flag indicating if the library reference is lazy. */
+        referenceIsLazy: string;
+    };
 }
-export interface AddComponentUsageAnswers {
+export type ComponentUsagesData = ComponentUsagesDataBase | ComponentUsagesDataWithLibrary;
+export type AddComponentUsageAnswersWithoutLibrary = {
+    /** Indicates whether a library reference should be added */
+    shouldAddLibrary: false;
+};
+export type addComponentUsageAnswersWithLibrary = {
+    /** Indicates whether a library reference should be added */
+    shouldAddLibrary: true;
+    /** Reference to the component's library. */
+    library: string;
+    /** Indicates whether the library reference is loaded lazily. */
+    libraryIsLazy: string;
+};
+export type AddComponentUsageAnswersBase = {
     /** Indicates whether the component is loaded lazily. */
     isLazy: string;
     /** Unique ID for the component usage. */
-    id: string;
+    usageId: string;
     /** Name of the component. */
     name: string;
     /** Serialized data specific to the component. */
     data: string;
     /** Settings related to the component. */
     settings: string;
-    /** Indicates whether a library reference should be added */
-    shouldAddLibrary: boolean;
-    /** Reference to the component's library. */
-    library?: string;
-    /** Indicates whether the library reference is loaded lazily. */
-    libraryIsLazy?: string;
-}
-export interface NewModelData {
+};
+export type AddComponentUsageAnswers = AddComponentUsageAnswersBase & (AddComponentUsageAnswersWithoutLibrary | addComponentUsageAnswersWithLibrary);
+export interface NewModelDataBase {
     variant: DescriptorVariant;
-    answers: NewModelAnswers;
+    service: {
+        /** Name of the OData service. */
+        name: string;
+        /** URI of the OData service. */
+        uri: string;
+        /** Name of the OData service model. */
+        modelName: string;
+        /** Version of OData used. */
+        version: string;
+        /** Settings for the OData service model. */
+        modelSettings?: string;
+    };
 }
-export interface NewModelAnswers {
-    addAnnotationMode: boolean;
+export interface NewModelDataWithAnnotations extends NewModelDataBase {
+    annotation: {
+        /** Name of the OData annotation data source. */
+        dataSourceName: string;
+        /** Optional URI of the OData annotation data source. */
+        dataSourceURI?: string;
+        /** Optional settings for the OData annotation. */
+        settings?: string;
+    };
+}
+export type NewModelData = NewModelDataBase | NewModelDataWithAnnotations;
+export interface NewModelAnswersBase {
     /** Name of the OData service. */
     name: string;
     /** URI of the OData service. */
@@ -298,6 +352,9 @@ export interface NewModelAnswers {
     version: string;
     /** Settings for the OData service model. */
     modelSettings: string;
+}
+export interface NewModelAnswersWithAnnotations extends NewModelAnswersBase {
+    addAnnotationMode: true;
     /** Name of the OData annotation data source. */
     dataSourceName: string;
     /** Optional URI of the OData annotation data source. */
@@ -305,12 +362,28 @@ export interface NewModelAnswers {
     /** Optional settings for the OData annotation. */
     annotationSettings?: string;
 }
+export interface NewModelAnswersWithoutAnnotations extends NewModelAnswersBase {
+    addAnnotationMode: false;
+}
+export type NewModelAnswers = NewModelAnswersBase & (NewModelAnswersWithAnnotations | NewModelAnswersWithoutAnnotations);
 export interface DataSourceData {
     variant: DescriptorVariant;
     dataSources: Record<string, ManifestNamespace.DataSource>;
-    answers: ChangeDataSourceAnswers;
+    service: {
+        /** Data source identifier. */
+        id: string;
+        /** URI of the data source. */
+        uri: string;
+        /** Optional maximum age for the data source cache. */
+        maxAge?: number;
+        /** URI for the OData annotation source. */
+        annotationUri?: string;
+    };
 }
-export interface InboundChangeAnswers {
+export type RequireAtLeastOne<T> = {
+    [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
+}[keyof T];
+export interface InboundChangeAnswersBase {
     /** Title associated with the inbound navigation data. */
     title: string;
     /** Subtitle associated with the inbound navigation data. */
@@ -318,11 +391,19 @@ export interface InboundChangeAnswers {
     /** Icon associated with the inbound navigation data. */
     icon: string;
 }
+export type InboundChangeAnswers = RequireAtLeastOne<InboundChangeAnswersBase>;
 export interface InboundData {
     /** Identifier for the inbound navigation data. */
     inboundId: string;
     variant: DescriptorVariant;
-    answers: InboundChangeAnswers;
+    flp: RequireAtLeastOne<{
+        /** Title associated with the inbound navigation data. */
+        title: string;
+        /** Subtitle associated with the inbound navigation data. */
+        subtitle: string;
+        /** Icon associated with the inbound navigation data. */
+        icon: string;
+    }>;
 }
 export interface InboundContent {
     inboundId: string;

package/dist/writer/changes/writers/annotations-writer.js

@@ -47,13 +47,13 @@ class AnnotationsWriter {
      * @returns {object} The constructed content object for the annotation change.
      */
     constructContent(data) {
-        const { variant: { layer }, fileName, answers: { id } } = data;
+        const { variant: { layer }, annotation: { dataSource, fileName } } = data;
         const annotationFileNameWithoutExtension = fileName?.toLocaleLowerCase().replace('.xml', '');
         const annotationNameSpace = layer === "CUSTOMER_BASE" /* FlexLayer.CUSTOMER_BASE */
             ? `customer.annotation.${annotationFileNameWithoutExtension}`
             : `annotation.${annotationFileNameWithoutExtension}`;
         return {
-            dataSourceId: `${id}`,
+            dataSourceId: `${dataSource}`,
             annotations: [annotationNameSpace],
             annotationsInsertPosition: 'END',
             dataSource: {
@@ -70,8 +70,8 @@ class AnnotationsWriter {
      * @param {AnnotationsData} data - The answers object containing user choices.
      * @returns {string | undefined} The determined filename for the annotation file.
      */
-    getAnnotationFileName({ answers }) {
-        return answers.filePath ? path_1.default.basename(answers.filePath) : `annotation_${Date.now()}.xml`;
+    getAnnotationFileName({ annotation }) {
+        return annotation.filePath ? path_1.default.basename(annotation.filePath) : `annotation_${Date.now()}.xml`;
     }
     /**
      * Writes the annotation change to the project based on the provided data.
@@ -80,17 +80,17 @@ class AnnotationsWriter {
      * @returns {Promise<void>} A promise that resolves when the change writing process is completed.
      */
     async write(data) {
-        const { variant } = data;
-        data.fileName = this.getAnnotationFileName(data);
-        if (data.answers.filePath) {
-            data.answers.filePath = (0, path_1.isAbsolute)(data.answers.filePath)
-                ? data.answers.filePath
-                : path_1.default.join(this.projectPath, data.answers.filePath);
+        const { variant, annotation } = data;
+        annotation.fileName = annotation.fileName ?? this.getAnnotationFileName(data);
+        if (annotation.filePath) {
+            annotation.filePath = (0, path_1.isAbsolute)(annotation.filePath)
+                ? annotation.filePath
+                : path_1.default.join(this.projectPath, annotation.filePath);
         }
         const content = this.constructContent(data);
         const timestamp = Date.now();
         const change = (0, change_utils_1.getChange)(variant, timestamp, content, "appdescr_app_addAnnotationsToOData" /* ChangeType.ADD_ANNOTATIONS_TO_ODATA */);
-        (0, change_utils_1.writeAnnotationChange)(this.projectPath, timestamp, data, change, this.fs);
+        (0, change_utils_1.writeAnnotationChange)(this.projectPath, timestamp, data.annotation, change, this.fs);
     }
 }
 exports.AnnotationsWriter = AnnotationsWriter;

package/dist/writer/changes/writers/component-usages-writer.d.ts

@@ -21,8 +21,8 @@ export declare class ComponentUsagesWriter implements IWriter<ComponentUsagesDat
     /**
      * Constructs the content for an library reference change based on provided data.
      *
-     * @param {ComponentUsagesData} data - The answers object containing information needed to construct the content property.
-     * @returns {object | undefined} The constructed content object for the library reference change.
+     * @param {ComponentUsagesData} library - The answers object containing information needed to construct the content property.
+     * @returns {object} The constructed content object for the library reference change.
      */
     private constructLibContent;
     /**

package/dist/writer/changes/writers/component-usages-writer.js

@@ -23,10 +23,10 @@ class ComponentUsagesWriter {
      * @param {ComponentUsagesData} data - The answers object containing information needed to construct the content property.
      * @returns {object} The constructed content object for the component usages change.
      */
-    constructContent({ answers }) {
-        const { data, id, settings, isLazy, name } = answers;
+    constructContent({ component }) {
+        const { data, usageId, settings, isLazy, name } = component;
         const componentUsages = {
-            [id]: {
+            [usageId]: {
                 name,
                 lazy: isLazy === 'true',
                 settings: (0, change_utils_1.parseStringToObject)(settings),
@@ -40,17 +40,15 @@ class ComponentUsagesWriter {
     /**
      * Constructs the content for an library reference change based on provided data.
      *
-     * @param {ComponentUsagesData} data - The answers object containing information needed to construct the content property.
-     * @returns {object | undefined} The constructed content object for the library reference change.
+     * @param {ComponentUsagesData} library - The answers object containing information needed to construct the content property.
+     * @returns {object} The constructed content object for the library reference change.
      */
-    constructLibContent({ answers }) {
-        if (!answers.library) {
-            return undefined;
-        }
+    constructLibContent({ library }) {
+        const { reference, referenceIsLazy } = library;
         return {
             libraries: {
-                [answers.library]: {
-                    lazy: answers.libraryIsLazy === 'true'
+                [reference]: {
+                    lazy: referenceIsLazy === 'true'
                 }
             }
         };
@@ -63,16 +61,16 @@ class ComponentUsagesWriter {
      */
     async write(data) {
         const componentUsagesContent = this.constructContent(data);
-        const libRefContent = this.constructLibContent(data);
         const timestamp = Date.now();
-        const shouldAddLibRef = libRefContent !== undefined;
         const compUsagesChange = (0, change_utils_1.getChange)(data.variant, timestamp, componentUsagesContent, "appdescr_ui5_addComponentUsages" /* ChangeType.ADD_COMPONENT_USAGES */);
         (0, change_utils_1.writeChangeToFolder)(this.projectPath, compUsagesChange, `id_${timestamp}_addComponentUsages.change`, this.fs, project_access_1.DirName.Manifest);
-        if (shouldAddLibRef) {
-            const libTimestamp = timestamp + 1;
-            const refLibChange = (0, change_utils_1.getChange)(data.variant, libTimestamp, libRefContent, "appdescr_ui5_addLibraries" /* ChangeType.ADD_LIBRARY_REFERENCE */);
-            (0, change_utils_1.writeChangeToFolder)(this.projectPath, refLibChange, `id_${libTimestamp}_addLibraries.change`, this.fs, project_access_1.DirName.Manifest);
+        if (!('library' in data)) {
+            return;
         }
+        const libRefContent = this.constructLibContent(data);
+        const libTimestamp = timestamp + 1;
+        const refLibChange = (0, change_utils_1.getChange)(data.variant, libTimestamp, libRefContent, "appdescr_ui5_addLibraries" /* ChangeType.ADD_LIBRARY_REFERENCE */);
+        (0, change_utils_1.writeChangeToFolder)(this.projectPath, refLibChange, `id_${libTimestamp}_addLibraries.change`, this.fs, project_access_1.DirName.Manifest);
     }
 }
 exports.ComponentUsagesWriter = ComponentUsagesWriter;

package/dist/writer/changes/writers/data-source-writer.js

@@ -52,8 +52,8 @@ class DataSourceWriter {
      * @returns {Promise<void>} A promise that resolves when the change writing process is completed.
      */
     async write(data) {
-        const { variant, dataSources, answers } = data;
-        const { id, uri, maxAge, annotationUri } = answers;
+        const { variant, dataSources, service } = data;
+        const { id, uri, maxAge, annotationUri } = service;
         const annotationId = dataSources[id].settings?.annotations?.[0];
         const timestamp = Date.now();
         const content = this.constructContent(id, uri, maxAge);

package/dist/writer/changes/writers/inbound-writer.js

@@ -39,7 +39,7 @@ class InboundWriter {
      * @returns {void}
      */
     getEnhancedContent(data, content) {
-        const { icon, title, subtitle } = data.answers;
+        const { icon, title, subtitle } = data.flp;
         if (title) {
             content.entityPropertyChange.push({
                 propertyPath: 'title',

package/dist/writer/changes/writers/new-model-writer.d.ts

@@ -14,7 +14,7 @@ export declare class NewModelWriter implements IWriter<NewModelData> {
     /**
      * Constructs the content for an new model change based on provided data.
      *
-     * @param {NewModelAnswers} data - The answers object containing information needed to construct the content property.
+     * @param {NewModelData} data - The answers object containing information needed to construct the content property.
      * @returns {object} The constructed content object for the new model change.
      */
     private constructContent;

package/dist/writer/changes/writers/new-model-writer.js

@@ -20,37 +20,39 @@ class NewModelWriter {
     /**
      * Constructs the content for an new model change based on provided data.
      *
-     * @param {NewModelAnswers} data - The answers object containing information needed to construct the content property.
+     * @param {NewModelData} data - The answers object containing information needed to construct the content property.
      * @returns {object} The constructed content object for the new model change.
      */
-    constructContent({ name, uri, addAnnotationMode, dataSourceName, modelName, modelSettings, version, dataSourceURI, annotationSettings }) {
+    constructContent(data) {
+        const { service } = data;
         const content = {
             dataSource: {
-                [name]: {
-                    uri,
+                [service.name]: {
+                    uri: service.uri,
                     type: 'OData',
                     settings: {
-                        odataVersion: version
+                        odataVersion: service.version
                     }
                 }
             },
             model: {
-                [modelName]: {
-                    dataSource: name
+                [service.modelName]: {
+                    dataSource: service.name
                 }
             }
         };
-        if (modelSettings && modelSettings.length !== 0) {
-            content.model[modelName].settings = (0, change_utils_1.parseStringToObject)(modelSettings);
+        if (service.modelSettings && service.modelSettings.length !== 0) {
+            content.model[service.modelName].settings = (0, change_utils_1.parseStringToObject)(service.modelSettings);
         }
-        if (addAnnotationMode) {
-            content.dataSource[name].settings.annotations = [`${dataSourceName}`];
-            content.dataSource[dataSourceName] = {
-                uri: dataSourceURI,
+        if ('annotation' in data) {
+            const { annotation } = data;
+            content.dataSource[service.name].settings.annotations = [`${annotation.dataSourceName}`];
+            content.dataSource[annotation.dataSourceName] = {
+                uri: annotation.dataSourceURI,
                 type: 'ODataAnnotation'
             };
-            if (annotationSettings && annotationSettings.length !== 0) {
-                content.dataSource[dataSourceName].settings = (0, change_utils_1.parseStringToObject)(annotationSettings);
+            if (annotation.settings && annotation.settings.length !== 0) {
+                content.dataSource[annotation.dataSourceName].settings = (0, change_utils_1.parseStringToObject)(annotation.settings);
             }
         }
         return content;
@@ -63,7 +65,7 @@ class NewModelWriter {
      */
     async write(data) {
         const timestamp = Date.now();
-        const content = this.constructContent(data.answers);
+        const content = this.constructContent(data);
         const change = (0, change_utils_1.getChange)(data.variant, timestamp, content, "appdescr_ui5_addNewModel" /* ChangeType.ADD_NEW_MODEL */);
         (0, change_utils_1.writeChangeToFolder)(this.projectPath, change, `id_${timestamp}_addNewModel.change`, this.fs, project_access_1.DirName.Manifest);
     }

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.12.39",
+  "version": "0.12.41",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -32,13 +32,13 @@
     "prompts": "2.4.2",
     "sanitize-filename": "1.6.3",
     "uuid": "10.0.0",
-    "@sap-ux/axios-extension": "1.16.4",
-    "@sap-ux/btp-utils": "0.15.1",
+    "@sap-ux/axios-extension": "1.16.5",
+    "@sap-ux/btp-utils": "0.15.2",
     "@sap-ux/inquirer-common": "0.4.6",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/project-access": "1.26.8",
     "@sap-ux/project-input-validator": "0.3.3",
-    "@sap-ux/system-access": "0.5.9",
+    "@sap-ux/system-access": "0.5.10",
     "@sap-ux/ui5-config": "0.24.0"
   },
   "devDependencies": {