@sap-ux/adp-tooling 0.12.22 → 0.12.25

package/dist/prompts/add-component-usages/index.d.ts

@@ -0,0 +1,12 @@
+import type { YUIQuestion } from '@sap-ux/inquirer-common';
+import type { UI5FlexLayer } from '@sap-ux/project-access';
+import { type AddComponentUsageAnswers } from '../../types';
+/**
+ * Gets the prompts for adding a component usage.
+ *
+ * @param {string} basePath - The base path of the project.
+ * @param {UI5FlexLayer} layer - The layer of the project.
+ * @returns {YUIQuestion<AddComponentUsageAnswers>[]} The questions/prompts.
+ */
+export declare function getPrompts(basePath: string, layer: UI5FlexLayer): YUIQuestion<AddComponentUsageAnswers>[];
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,192 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPrompts = void 0;
+const change_utils_1 = require("../../base/change-utils");
+const i18n_1 = require("../../i18n");
+const project_input_validator_1 = require("@sap-ux/project-input-validator");
+/**
+ * Exucute generic validation for input.
+ *
+ * @param value The value to validate.
+ * @returns {string | boolean} An error message if the value is an empty string, or true if it is not.
+ */
+function validatePromptInput(value) {
+    const validators = [project_input_validator_1.validateEmptyString, project_input_validator_1.validateEmptySpaces, project_input_validator_1.validateSpecialChars];
+    for (const validator of validators) {
+        const validationResult = validator(value);
+        if (typeof validationResult === 'string') {
+            return validationResult;
+        }
+    }
+    return true;
+}
+/**
+ * Validates the input for the component usage ID.
+ *
+ * @param value The value to validate.
+ * @param changeFiles The change files to check for duplication.
+ * @param isCustomerBase Flag to check if the project is customer scenario.
+ * @returns {string | boolean} An error message if the value is invalid, or true if it is not.
+ */
+function validatePromptId(value, changeFiles, isCustomerBase) {
+    const validationResult = validatePromptInput(value);
+    if (typeof validationResult === 'string') {
+        return validationResult;
+    }
+    if (isCustomerBase && !(0, project_input_validator_1.hasCustomerPrefix)(value)) {
+        return (0, i18n_1.t)('validators.errorInputInvalidValuePrefix', {
+            value: (0, i18n_1.t)('prompts.component.usageIdLabel'),
+            prefix: "customer." /* NamespacePrefix.CUSTOMER */
+        });
+    }
+    if ((0, project_input_validator_1.hasContentDuplication)(value, 'dataSource', changeFiles)) {
+        return (0, i18n_1.t)('validators.errorDuplicateValueComponentId');
+    }
+    return true;
+}
+/**
+ * Validates the input for the library reference.
+ *
+ * @param value The value to validate.
+ * @param changeFiles The change files to check for duplication.
+ * @param isCustomerBase Flag to check if the project is customer scenario.
+ * @returns {string | boolean} An error message if the value is invalid, or true if it is not.
+ */
+function validatePromptLibrary(value, changeFiles, isCustomerBase) {
+    const validationResult = validatePromptInput(value);
+    if (typeof validationResult === 'string') {
+        return validationResult;
+    }
+    if (isCustomerBase && !(0, project_input_validator_1.hasCustomerPrefix)(value)) {
+        return (0, i18n_1.t)('validators.errorInputInvalidValuePrefix', {
+            value: (0, i18n_1.t)('prompts.component.libraryLabel'),
+            prefix: "customer." /* NamespacePrefix.CUSTOMER */
+        });
+    }
+    if ((0, project_input_validator_1.hasContentDuplication)(value, 'dataSource', changeFiles)) {
+        return (0, i18n_1.t)('validators.errorDuplicateValueLibrary');
+    }
+    return true;
+}
+/**
+ * Validates a JSON string.
+ *
+ * @param value The JSON string to validate.
+ * @returns {boolean | string} True if the JSON is valid, or an error message if validation fails.
+ */
+function validatePromptJSON(value) {
+    const validationResult = (0, project_input_validator_1.validateEmptyString)(value);
+    if (typeof validationResult === 'string') {
+        return true;
+    }
+    return (0, project_input_validator_1.validateJSON)(value);
+}
+/**
+ * Gets the prompts for adding a component usage.
+ *
+ * @param {string} basePath - The base path of the project.
+ * @param {UI5FlexLayer} layer - The layer of the project.
+ * @returns {YUIQuestion<AddComponentUsageAnswers>[]} The questions/prompts.
+ */
+function getPrompts(basePath, layer) {
+    const componentUsageChangeFiles = (0, change_utils_1.getChangesByType)(basePath, "appdescr_ui5_addComponentUsages" /* ChangeType.ADD_COMPONENT_USAGES */, 'manifest');
+    const libraryChangeFiles = (0, change_utils_1.getChangesByType)(basePath, "appdescr_ui5_addLibraries" /* ChangeType.ADD_LIBRARY_REFERENCE */, 'manifest');
+    const isCustomerBase = layer === "CUSTOMER_BASE" /* FlexLayer.CUSTOMER_BASE */;
+    const isLazyDropDownOptions = [
+        { name: (0, i18n_1.t)('choices.true'), value: 'true' },
+        { name: (0, i18n_1.t)('choices.false'), value: 'false' }
+    ];
+    return [
+        {
+            type: 'input',
+            name: `id`,
+            message: (0, i18n_1.t)('prompts.component.usageIdLabel'),
+            validate: (value) => validatePromptId(value, componentUsageChangeFiles, isCustomerBase),
+            default: isCustomerBase ? "customer." /* NamespacePrefix.CUSTOMER */ : "" /* NamespacePrefix.EMPTY */,
+            store: false,
+            guiOptions: {
+                mandatory: true,
+                hint: (0, i18n_1.t)('prompts.component.usageIdTooltip')
+            }
+        },
+        {
+            type: 'input',
+            name: 'name',
+            message: (0, i18n_1.t)('prompts.component.nameLabel'),
+            validate: validatePromptInput,
+            store: false,
+            guiOptions: {
+                mandatory: true,
+                hint: (0, i18n_1.t)('prompts.component.nameTooltip')
+            }
+        },
+        {
+            type: 'list',
+            name: 'isLazy',
+            message: (0, i18n_1.t)('prompts.component.isLazyLabel'),
+            choices: isLazyDropDownOptions,
+            default: isLazyDropDownOptions[1].value,
+            store: false,
+            guiOptions: {
+                mandatory: true,
+                hint: (0, i18n_1.t)('prompts.component.isLazyTooltip')
+            }
+        },
+        {
+            type: 'editor',
+            name: `settings`,
+            message: (0, i18n_1.t)('prompts.component.settingsLabel'),
+            validate: validatePromptJSON,
+            store: false,
+            guiOptions: {
+                hint: (0, i18n_1.t)('prompts.component.tooltip', { input: (0, i18n_1.t)('prompts.component.settingsLabel') })
+            }
+        },
+        {
+            type: 'editor',
+            name: `data`,
+            message: (0, i18n_1.t)('prompts.component.dataLabel'),
+            validate: validatePromptJSON,
+            store: false,
+            guiOptions: {
+                hint: (0, i18n_1.t)('prompts.component.tooltip', { input: (0, i18n_1.t)('prompts.component.dataLabel') })
+            }
+        },
+        {
+            type: 'confirm',
+            name: 'shouldAddLibrary',
+            message: (0, i18n_1.t)('prompts.component.shouldAddLibraryLabel'),
+            default: false,
+            guiOptions: {
+                hint: (0, i18n_1.t)('prompts.component.shouldAddLibraryTooltip')
+            }
+        },
+        {
+            type: 'input',
+            name: 'library',
+            message: (0, i18n_1.t)('prompts.component.libraryLabel'),
+            guiOptions: {
+                mandatory: true,
+                hint: (0, i18n_1.t)('prompts.component.libraryTooltip')
+            },
+            validate: (value) => validatePromptLibrary(value, libraryChangeFiles, isCustomerBase),
+            store: false,
+            when: (answers) => answers.shouldAddLibrary
+        },
+        {
+            type: 'list',
+            name: `libraryIsLazy`,
+            message: (0, i18n_1.t)('prompts.component.libraryIsLazyLabel'),
+            choices: isLazyDropDownOptions,
+            default: isLazyDropDownOptions[1].value,
+            store: false,
+            guiOptions: {
+                mandatory: true,
+                hint: (0, i18n_1.t)('prompts.component.libraryIsLazyTooltip')
+            },
+            when: (answers) => answers.shouldAddLibrary
+        }
+    ];
+}
+exports.getPrompts = getPrompts;
+//# sourceMappingURL=index.js.map

package/dist/prompts/index.d.ts

@@ -1,4 +1,5 @@
 export { getPrompts as getPromptsForChangeDataSource } from './change-data-source';
+export { getPrompts as getPromptsForAddComponentUsages } from './add-component-usages';
 export { getPrompts as getPromptsForNewModel } from './add-new-model';
 export { getPrompts as getPromptsForChangeInbound } from './change-inbound';
 export { getPrompts as getPromptsForAddAnnotationsToOData } from './add-annotations-to-odata';

package/dist/prompts/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPromptsForAddAnnotationsToOData = exports.getPromptsForChangeInbound = exports.getPromptsForNewModel = exports.getPromptsForChangeDataSource = void 0;
+exports.getPromptsForAddAnnotationsToOData = exports.getPromptsForChangeInbound = exports.getPromptsForNewModel = exports.getPromptsForAddComponentUsages = exports.getPromptsForChangeDataSource = void 0;
 var change_data_source_1 = require("./change-data-source");
 Object.defineProperty(exports, "getPromptsForChangeDataSource", { enumerable: true, get: function () { return change_data_source_1.getPrompts; } });
+var add_component_usages_1 = require("./add-component-usages");
+Object.defineProperty(exports, "getPromptsForAddComponentUsages", { enumerable: true, get: function () { return add_component_usages_1.getPrompts; } });
 var add_new_model_1 = require("./add-new-model");
 Object.defineProperty(exports, "getPromptsForNewModel", { enumerable: true, get: function () { return add_new_model_1.getPrompts; } });
 var change_inbound_1 = require("./change-inbound");

package/dist/translations/adp-tooling.i18n.json

@@ -29,6 +29,24 @@
         "oDataAnnotationDataSourceUriTooltip": "Enter URI for the OData annotation data source",
         "oDataAnnotationSettingsLabel": "OData Annotation Settings",
         "oDataAnnotationSettingsTooltip": "If needed enter any additional {{value}} settings in the 'key':'value1','key2':'value2' format",
+        "component": {
+            "usage": "Component usage",
+            "usageIdLabel": "Component Usage ID",
+            "usageIdTooltip": "Enter the component usage ID you want to add",
+            "nameLabel": "Component Name",
+            "nameTooltip": "Enter the name of the component you want to add",
+            "isLazyLabel": "Set Component as Lazy",
+            "isLazyTooltip": "Select if the component should be lazy or not",
+            "settingsLabel": "Component Settings",
+            "dataLabel": "Component Data",
+            "tooltip": "If needed enter any additional {{input}} in the  \"key1\":\"value1\",\"key2\":\"value2\" format",
+            "shouldAddLibraryLabel": "Do you want to add library reference?",
+            "shouldAddLibraryTooltip": "Choose if you want to add library reference",
+            "libraryLabel": "Library Reference",
+            "libraryTooltip": "Enter the library reference",
+            "libraryIsLazyLabel": "Set Library as Lazy",
+            "libraryIsLazyTooltip": "Choose if you want the library reference to be lazy or not"
+        },
         "title": "Title",
         "subtitle": "Subtitle",
         "icon": "Icon"
@@ -44,11 +62,15 @@
         "annotationFileAlreadyExists": "There is already an annotation file with the same name, please choose another file or rename the file and select it again",
         "errorDuplicatedValueOData": "OData Annotation or OData Service with the same name was already added to the project",
         "errorDuplicatedValueSapui5Model": "SAPUI5 Model with the same name was already added to the project",
+        "errorDuplicateValueComponentId": "Component usage with the same name was already added to the project",
+        "errorDuplicateValueLibrary": "Library with the same name was already added to the project",
         "errorDuplicateNamesOData": "OData Service Name must be different from OData Annotation Data Source Name",
         "errorInputInvalidValuePrefix": "{{value}} should start with '{{prefix}}'",
         "errorInvalidDataSourceURI": "Invalid URI. Should start and end with '/' and contain no spaces"
     },
     "choices": {
+        "true": "true",
+        "false": "false",
         "annotationFile": {
             "selectFromWorkspace": "Select annotation file from workspace",
             "createEmptyFile": "Create an empty annotation file"

package/dist/types.d.ts

@@ -261,26 +261,26 @@ export declare const enum AnnotationFileSelectType {
     NewEmptyFile = 2
 }
 export interface ComponentUsagesData {
-    projectData: AdpProjectData;
-    timestamp: number;
-    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;
-    };
-    library: {
-        /** Reference to the component's library. */
-        reference: string;
-        /** Optional flag indicating if the library reference is lazy. */
-        referenceIsLazy?: string;
-    };
+    variant: DescriptorVariant;
+    answers: AddComponentUsageAnswers;
+}
+export interface AddComponentUsageAnswers {
+    /** Indicates whether the component is loaded lazily. */
+    isLazy: string;
+    /** Unique ID for the component usage. */
+    id: 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 {
     variant: DescriptorVariant;

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({ component }) {
-        const { data, usageId, settings, isLazy, name } = component;
+    constructContent({ answers }) {
+        const { data, id, settings, isLazy, name } = answers;
         const componentUsages = {
-            [usageId]: {
+            [id]: {
                 name,
                 lazy: isLazy === 'true',
                 settings: (0, change_utils_1.parseStringToObject)(settings),
@@ -43,15 +43,14 @@ class ComponentUsagesWriter {
      * @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.
      */
-    constructLibContent(data) {
-        const library = data.library;
-        if (!library.reference) {
+    constructLibContent({ answers }) {
+        if (!answers.library) {
             return undefined;
         }
         return {
             libraries: {
-                [library.reference]: {
-                    lazy: library.referenceIsLazy === 'true'
+                [answers.library]: {
+                    lazy: answers.libraryIsLazy === 'true'
                 }
             }
         };
@@ -65,13 +64,14 @@ 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.projectData, data.timestamp, componentUsagesContent, "appdescr_ui5_addComponentUsages" /* ChangeType.ADD_COMPONENT_USAGES */);
-        (0, change_utils_1.writeChangeToFolder)(this.projectPath, compUsagesChange, `id_${data.timestamp}_addComponentUsages.change`, this.fs, project_access_1.DirName.Manifest);
+        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) {
-            data.timestamp += 1;
-            const refLibChange = (0, change_utils_1.getChange)(data.projectData, data.timestamp, libRefContent, "appdescr_ui5_addLibraries" /* ChangeType.ADD_LIBRARY_REFERENCE */);
-            (0, change_utils_1.writeChangeToFolder)(this.projectPath, refLibChange, `id_${data.timestamp}_addLibraries.change`, this.fs, project_access_1.DirName.Manifest);
+            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);
         }
     }
 }

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.22",
+  "version": "0.12.25",
   "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.1",
+    "@sap-ux/axios-extension": "1.16.2",
     "@sap-ux/btp-utils": "0.15.0",
     "@sap-ux/inquirer-common": "0.4.3",
     "@sap-ux/logger": "0.6.0",
-    "@sap-ux/project-access": "1.26.1",
+    "@sap-ux/project-access": "1.26.3",
     "@sap-ux/project-input-validator": "0.3.2",
-    "@sap-ux/system-access": "0.5.3",
+    "@sap-ux/system-access": "0.5.4",
     "@sap-ux/ui5-config": "0.23.1"
   },
   "devDependencies": {