@sap-ux/adp-tooling 0.12.17 → 0.12.19

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

@@ -64,7 +64,17 @@ export declare function parseStringToObject(str: string): {
  * // Returns the string "nonJSONValue" because it cannot be parsed as JSON
  * getParsedPropertyValue('nonJSONValue');
  */
-export declare function getParsedPropertyValue(propertyValue: PropertyValueType): PropertyValueType;
+export declare function getParsedPropertyValue(propertyValue: string): PropertyValueType;
+/**
+ * Retrieves all change files from a specified project path that match a given change type,
+ * optionally within a specific subdirectory.
+ *
+ * @param {string} projectPath - The base path of the project.
+ * @param {ChangeType} changeType - The type of changes to filter by, ensuring only changes of this type are returned.
+ * @param {string} [subDir] - Optional subdirectory within the main changes directory.
+ * @returns An array of change objects matching the specified change type.
+ */
+export declare function getChangesByType(projectPath: string, changeType: ChangeType, subDir?: string): ManifestChangeProperties[];
 /**
  * Searches for a change file with a specific inbound ID within a project's change directory.
  *

package/dist/base/change-utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getChange = exports.findChangeWithInboundId = exports.getParsedPropertyValue = exports.parseStringToObject = exports.writeChangeToFile = exports.writeChangeToFolder = exports.writeAnnotationChange = void 0;
+exports.getChange = exports.findChangeWithInboundId = exports.getChangesByType = exports.getParsedPropertyValue = exports.parseStringToObject = exports.writeChangeToFile = exports.writeChangeToFolder = exports.writeAnnotationChange = void 0;
 const path_1 = __importDefault(require("path"));
 const fs_1 = require("fs");
 const project_access_1 = require("@sap-ux/project-access");
@@ -118,6 +118,48 @@ function getParsedPropertyValue(propertyValue) {
     }
 }
 exports.getParsedPropertyValue = getParsedPropertyValue;
+/**
+ * Retrieves all change files from a specified project path that match a given change type,
+ * optionally within a specific subdirectory.
+ *
+ * @param {string} projectPath - The base path of the project.
+ * @param {ChangeType} changeType - The type of changes to filter by, ensuring only changes of this type are returned.
+ * @param {string} [subDir] - Optional subdirectory within the main changes directory.
+ * @returns An array of change objects matching the specified change type.
+ */
+function getChangesByType(projectPath, changeType, subDir) {
+    try {
+        let targetDir = `${projectPath}/webapp/changes`;
+        if (!(0, fs_1.existsSync)(targetDir)) {
+            return [];
+        }
+        if (subDir) {
+            targetDir = `${targetDir}/${subDir}`;
+            if (!(0, fs_1.existsSync)(targetDir)) {
+                return [];
+            }
+        }
+        const fileNames = (0, fs_1.readdirSync)(targetDir, { withFileTypes: true })
+            .filter((dirent) => dirent.isFile() && dirent.name.endsWith('.change'))
+            .map((dirent) => dirent.name);
+        if (fileNames.length === 0) {
+            return [];
+        }
+        const changeFiles = fileNames
+            .map((fileName) => {
+            const filePath = path_1.default.resolve(targetDir, fileName);
+            const fileContent = (0, fs_1.readFileSync)(filePath, 'utf-8');
+            const change = JSON.parse(fileContent);
+            return change;
+        })
+            .filter((changeFileObject) => changeFileObject.changeType === changeType);
+        return changeFiles;
+    }
+    catch (e) {
+        throw new Error(`Error reading change files: ${e.message}`);
+    }
+}
+exports.getChangesByType = getChangesByType;
 /**
  * Searches for a change file with a specific inbound ID within a project's change directory.
  *

package/dist/base/prompt.js

@@ -4,10 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.promptTarget = exports.promptGeneratorInput = void 0;
+const uuid_1 = require("uuid");
 const prompts_1 = __importDefault(require("prompts"));
 const system_access_1 = require("@sap-ux/system-access");
-const validators_1 = require("./validators");
-const uuid_1 = require("uuid");
+const project_input_validator_1 = require("@sap-ux/project-input-validator");
 const project_utils_1 = require("../writer/project-utils");
 /**
  * Prompt the user for the required properties for an adaptation project.
@@ -114,7 +114,7 @@ async function promptTarget(defaults, logger) {
                     name: 'url',
                     message: 'Target system url:',
                     initial: target.url,
-                    validate: validators_1.isNotEmptyString,
+                    validate: project_input_validator_1.validateEmptyString,
                     format: (input) => input.trim()
                 },
                 {
@@ -122,7 +122,7 @@ async function promptTarget(defaults, logger) {
                     name: 'client',
                     message: 'Client (optional):',
                     initial: target.client,
-                    validate: validators_1.isValidSapClient
+                    validate: project_input_validator_1.validateClient
                 }
             ]);
             const systemInfo = await fetchSystemInformation(target, defaults.ignoreCertErrors, logger);

package/dist/index.d.ts

@@ -1,11 +1,10 @@
 export * from './types';
 export * from './prompts';
-export * from './preview/adp-preview';
-export * from './base/helper';
-export * from './base/validators';
+export * from './base/cf';
 export * from './base/abap';
+export * from './base/helper';
+export * from './preview/adp-preview';
 export { generate, migrate } from './writer';
 export { generateChange } from './writer/editors';
 export { promptGeneratorInput, PromptDefaults } from './base/prompt';
-export { isCFEnvironment } from './base/cf';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,13 +14,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCFEnvironment = exports.promptGeneratorInput = exports.generateChange = exports.migrate = exports.generate = void 0;
+exports.promptGeneratorInput = exports.generateChange = exports.migrate = exports.generate = void 0;
 __exportStar(require("./types"), exports);
 __exportStar(require("./prompts"), exports);
-__exportStar(require("./preview/adp-preview"), exports);
-__exportStar(require("./base/helper"), exports);
-__exportStar(require("./base/validators"), exports);
+__exportStar(require("./base/cf"), exports);
 __exportStar(require("./base/abap"), exports);
+__exportStar(require("./base/helper"), exports);
+__exportStar(require("./preview/adp-preview"), exports);
 var writer_1 = require("./writer");
 Object.defineProperty(exports, "generate", { enumerable: true, get: function () { return writer_1.generate; } });
 Object.defineProperty(exports, "migrate", { enumerable: true, get: function () { return writer_1.migrate; } });
@@ -28,6 +28,4 @@ var editors_1 = require("./writer/editors");
 Object.defineProperty(exports, "generateChange", { enumerable: true, get: function () { return editors_1.generateChange; } });
 var prompt_1 = require("./base/prompt");
 Object.defineProperty(exports, "promptGeneratorInput", { enumerable: true, get: function () { return prompt_1.promptGeneratorInput; } });
-var cf_1 = require("./base/cf");
-Object.defineProperty(exports, "isCFEnvironment", { enumerable: true, get: function () { return cf_1.isCFEnvironment; } });
 //# sourceMappingURL=index.js.map

package/dist/prompts/add-annotations-to-odata/index.js

@@ -4,7 +4,7 @@ exports.getPrompts = void 0;
 const i18n_1 = require("../../i18n");
 const project_access_1 = require("@sap-ux/project-access");
 const fs_1 = require("fs");
-const validators_1 = require("../../base/validators");
+const project_input_validator_1 = require("@sap-ux/project-input-validator");
 const path_1 = require("path");
 /**
  * Gets the prompts for adding annotations to OData service.
@@ -56,8 +56,9 @@ function getPrompts(basePath, dataSources) {
             default: '',
             when: (answers) => answers.id !== '' && answers.fileSelectOption === 1 /* AnnotationFileSelectType.ExistingFile */,
             validate: (value) => {
-                if (!(0, validators_1.isNotEmptyString)(value)) {
-                    return (0, i18n_1.t)('validators.inputCannotBeEmpty');
+                const validationResult = (0, project_input_validator_1.validateEmptyString)(value);
+                if (typeof validationResult === 'string') {
+                    return validationResult;
                 }
                 const filePath = (0, path_1.isAbsolute)(value) ? value : (0, path_1.join)(basePath, value);
                 if (!(0, fs_1.existsSync)(filePath)) {

package/dist/prompts/add-new-model/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 NewModelAnswers } from '../../types';
+/**
+ * Gets the prompts for adding the new model.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {UI5FlexLayer} layer - UI5 Flex layer.
+ * @returns {YUIQuestion<NewModelAnswers>[]} The questions/prompts.
+ */
+export declare function getPrompts(projectPath: string, layer: UI5FlexLayer): YUIQuestion<NewModelAnswers>[];
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1,265 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPrompts = void 0;
+const i18n_1 = require("../../i18n");
+const change_utils_1 = require("../../base/change-utils");
+const cf_1 = require("../../base/cf");
+const project_input_validator_1 = require("@sap-ux/project-input-validator");
+const oDataVersions = [
+    { name: '2.0', value: '2.0' },
+    { name: '4.0', value: '4.0' }
+];
+/**
+ * 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 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);
+}
+/**
+ * Validates the OData Service name prompt.
+ *
+ * @param value The value to validate.
+ * @param answers The answers object.
+ * @param isCustomerBase Whether the validation is for customer usage.
+ * @param changeFiles The list of existing change files to check against.
+ * @returns {boolean | string} True if no duplication is found, or an error message if validation fails.
+ */
+function validatePromptODataName(value, answers, isCustomerBase, changeFiles) {
+    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.oDataServiceNameLabel'),
+            prefix: "customer." /* NamespacePrefix.CUSTOMER */
+        });
+    }
+    if ((0, project_input_validator_1.hasContentDuplication)(value, 'dataSource', changeFiles)) {
+        return (0, i18n_1.t)('validators.errorDuplicatedValueOData');
+    }
+    if (value === answers.dataSourceName) {
+        return (0, i18n_1.t)('validators.errorDuplicateNamesOData');
+    }
+    return true;
+}
+/**
+ * Validates the OData Annotation name prompt.
+ *
+ * @param value The value to validate.
+ * @param answers The answers object.
+ * @param isCustomerBase Whether the validation is for customer usage.
+ * @param changeFiles The list of existing change files to check against.
+ * @returns {boolean | string} True if no duplication is found, or an error message if validation fails.
+ */
+function validatePromptODataAnnotationsName(value, answers, isCustomerBase, changeFiles) {
+    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.oDataAnnotationDataSourceNameLabel'),
+            prefix: "customer." /* NamespacePrefix.CUSTOMER */
+        });
+    }
+    if ((0, project_input_validator_1.hasContentDuplication)(value, 'dataSource', changeFiles)) {
+        return (0, i18n_1.t)('validators.errorDuplicatedValueOData');
+    }
+    if (value === answers.name) {
+        return (0, i18n_1.t)('validators.errorDuplicateNamesOData');
+    }
+    return true;
+}
+/**
+ * Validates the model name prompts.
+ *
+ * @param value The value to validate.
+ * @param isCustomerBase Whether the validation is for customer usage.
+ * @param changeFiles The list of existing change files to check against.
+ * @returns {boolean | string} True if no duplication is found, or an error message if validation fails.
+ */
+function validatePromptModelName(value, isCustomerBase, changeFiles) {
+    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.oDataServiceModelNameLabel'),
+            prefix: "customer." /* NamespacePrefix.CUSTOMER */
+        });
+    }
+    if ((0, project_input_validator_1.hasContentDuplication)(value, 'model', changeFiles)) {
+        return (0, i18n_1.t)('validators.errorDuplicatedValueSapui5Model');
+    }
+    return true;
+}
+/**
+ * Validates the OData Source URI prompt.
+ *
+ * @param value The value to validate.
+ * @returns {boolean | string} True if the URI is valid, or an error message if validation fails.
+ */
+function validatePromptURI(value) {
+    const validationResult = (0, project_input_validator_1.validateEmptyString)(value);
+    if (typeof validationResult === 'string') {
+        return validationResult;
+    }
+    if (!(0, project_input_validator_1.isDataSourceURI)(value)) {
+        return (0, i18n_1.t)('validators.errorInvalidDataSourceURI');
+    }
+    return true;
+}
+/**
+ * Gets the prompts for adding the new model.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {UI5FlexLayer} layer - UI5 Flex layer.
+ * @returns {YUIQuestion<NewModelAnswers>[]} The questions/prompts.
+ */
+function getPrompts(projectPath, layer) {
+    const isCustomerBase = "CUSTOMER_BASE" /* FlexLayer.CUSTOMER_BASE */ === layer;
+    const defaultSeviceName = isCustomerBase ? "customer." /* NamespacePrefix.CUSTOMER */ : "" /* NamespacePrefix.EMPTY */;
+    const isCFEnv = (0, cf_1.isCFEnvironment)(projectPath);
+    const changeFiles = (0, change_utils_1.getChangesByType)(projectPath, "appdescr_ui5_addNewModel" /* ChangeType.ADD_NEW_MODEL */, 'manifest');
+    return [
+        {
+            type: 'input',
+            name: 'name',
+            message: (0, i18n_1.t)('prompts.oDataServiceNameLabel'),
+            default: defaultSeviceName,
+            store: false,
+            validate: (value, answers) => {
+                return validatePromptODataName(value, answers, isCustomerBase, changeFiles);
+            },
+            guiOptions: {
+                mandatory: true,
+                hint: (0, i18n_1.t)('prompts.oDataServiceNameTooltip')
+            }
+        },
+        {
+            type: 'input',
+            name: 'uri',
+            message: (0, i18n_1.t)('prompts.oDataServiceUriLabel'),
+            guiOptions: {
+                mandatory: true,
+                hint: (0, i18n_1.t)('prompts.oDataServiceUriTooltip')
+            },
+            validate: validatePromptURI,
+            store: false
+        },
+        {
+            type: 'list',
+            name: 'version',
+            message: (0, i18n_1.t)('prompts.oDataServiceVersionLabel'),
+            choices: oDataVersions,
+            default: (answers) => {
+                if (answers.uri?.startsWith(isCFEnv ? '/odata/v4/' : '/sap/opu/odata4/')) {
+                    return oDataVersions[1].value;
+                }
+                return oDataVersions[0].value;
+            },
+            store: false,
+            validate: project_input_validator_1.validateEmptyString,
+            guiOptions: {
+                mandatory: true,
+                hint: (0, i18n_1.t)('prompts.oDataServiceVersionTooltip'),
+                applyDefaultWhenDirty: true
+            }
+        },
+        {
+            type: 'input',
+            name: 'modelName',
+            message: (0, i18n_1.t)('prompts.oDataServiceModelNameLabel'),
+            guiOptions: {
+                mandatory: true,
+                hint: (0, i18n_1.t)('prompts.oDataServiceModelNameTooltip')
+            },
+            default: defaultSeviceName,
+            validate: (value) => {
+                return validatePromptModelName(value, isCustomerBase, changeFiles);
+            },
+            store: false
+        },
+        {
+            type: 'editor',
+            name: 'modelSettings',
+            message: (0, i18n_1.t)('prompts.oDataServiceModelSettingsLabel'),
+            store: false,
+            validate: validatePromptJSON,
+            guiOptions: {
+                hint: (0, i18n_1.t)('prompts.oDataServiceModelSettingsTooltip')
+            }
+        },
+        {
+            type: 'confirm',
+            name: 'addAnnotationMode',
+            message: 'Do you want to add annotation?',
+            default: false
+        },
+        {
+            type: 'input',
+            name: 'dataSourceName',
+            message: (0, i18n_1.t)('prompts.oDataAnnotationDataSourceNameLabel'),
+            validate: (value, answers) => {
+                return validatePromptODataAnnotationsName(value, answers, isCustomerBase, changeFiles);
+            },
+            default: defaultSeviceName,
+            store: false,
+            guiOptions: {
+                mandatory: true,
+                hint: (0, i18n_1.t)('prompts.oDataAnnotationDataSourceNameTooltip')
+            },
+            when: (answers) => answers.addAnnotationMode
+        },
+        {
+            type: 'input',
+            name: 'dataSourceURI',
+            message: (0, i18n_1.t)('prompts.oDataAnnotationDataSourceUriLabel'),
+            validate: project_input_validator_1.validateEmptyString,
+            store: false,
+            guiOptions: {
+                mandatory: true,
+                hint: (0, i18n_1.t)('prompts.oDataAnnotationDataSourceUriTooltip')
+            },
+            when: (answers) => answers.addAnnotationMode
+        },
+        {
+            type: 'editor',
+            name: 'annotationSettings',
+            message: (0, i18n_1.t)('prompts.oDataAnnotationSettingsLabel'),
+            validate: validatePromptJSON,
+            store: false,
+            guiOptions: {
+                hint: (0, i18n_1.t)('prompts.oDataAnnotationSettingsTooltip')
+            },
+            when: (answers) => answers.addAnnotationMode
+        }
+    ];
+}
+exports.getPrompts = getPrompts;
+//# sourceMappingURL=index.js.map

package/dist/prompts/change-data-source/index.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPrompts = void 0;
 const i18n_1 = require("../../i18n");
 const project_access_1 = require("@sap-ux/project-access");
-const validators_1 = require("../../base/validators");
+const project_input_validator_1 = require("@sap-ux/project-input-validator");
 /**
  * Gets the prompts for changing the data source.
  *
@@ -33,7 +33,7 @@ function getPrompts(dataSources) {
                 mandatory: true,
                 hint: (0, i18n_1.t)('prompts.oDataSourceURITooltip')
             },
-            validate: validators_1.isNotEmptyString,
+            validate: project_input_validator_1.validateEmptyString,
             when: !!dataSourceIds.length,
             store: false
         },

package/dist/prompts/change-inbound/index.d.ts

@@ -0,0 +1,9 @@
+import type { YUIQuestion } from '@sap-ux/inquirer-common';
+import type { InboundChangeAnswers } from '../../types';
+/**
+ * Gets the prompts for Inbound Change.
+ *
+ * @returns {YUIQuestion<InboundChangeAnswers>[]} The questions/prompts.
+ */
+export declare function getPrompts(): YUIQuestion<InboundChangeAnswers>[];
+//# sourceMappingURL=index.d.ts.map

package/dist/prompts/change-inbound/index.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPrompts = void 0;
+const i18n_1 = require("../../i18n");
+/**
+ * Gets the prompts for Inbound Change.
+ *
+ * @returns {YUIQuestion<InboundChangeAnswers>[]} The questions/prompts.
+ */
+function getPrompts() {
+    return [
+        {
+            type: 'input',
+            name: 'title',
+            message: (0, i18n_1.t)('prompts.title'),
+            guiOptions: {
+                hint: (0, i18n_1.t)('tooltips.title')
+            },
+            validate: (value, answers) => answers.subTitle || answers.icon !== '' || value ? true : (0, i18n_1.t)('missingIconOrTitleOrSubtitle'),
+            store: false
+        },
+        {
+            type: 'input',
+            name: 'subtitle',
+            message: (0, i18n_1.t)('prompts.subtitle'),
+            guiOptions: {
+                hint: (0, i18n_1.t)('tooltips.subtitle')
+            },
+            validate: (value, answers) => value || answers.icon !== '' || answers.title !== '' ? true : (0, i18n_1.t)('missingIconOrTitleOrSubtitle'),
+            store: false
+        },
+        {
+            type: 'input',
+            name: 'icon',
+            message: (0, i18n_1.t)('prompts.icon'),
+            guiOptions: {
+                hint: (0, i18n_1.t)('tooltips.icon')
+            },
+            store: false,
+            validate: (value, answers) => answers.subTitle || value || answers.title !== '' ? true : (0, i18n_1.t)('missingIconOrTitleOrSubtitle')
+        }
+    ];
+}
+exports.getPrompts = getPrompts;
+//# sourceMappingURL=index.js.map

package/dist/prompts/index.d.ts

@@ -1,3 +1,5 @@
 export { getPrompts as getPromptsForChangeDataSource } from './change-data-source';
+export { getPrompts as getPromptsForNewModel } from './add-new-model';
+export { getPrompts as getPromptsForChangeInbound } from './change-inbound';
 export { getPrompts as getPromptsForAddAnnotationsToOData } from './add-annotations-to-odata';
 //# sourceMappingURL=index.d.ts.map

package/dist/prompts/index.js

@@ -1,8 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPromptsForAddAnnotationsToOData = exports.getPromptsForChangeDataSource = void 0;
+exports.getPromptsForAddAnnotationsToOData = exports.getPromptsForChangeInbound = exports.getPromptsForNewModel = 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_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");
+Object.defineProperty(exports, "getPromptsForChangeInbound", { enumerable: true, get: function () { return change_inbound_1.getPrompts; } });
 var add_annotations_to_odata_1 = require("./add-annotations-to-odata");
 Object.defineProperty(exports, "getPromptsForAddAnnotationsToOData", { enumerable: true, get: function () { return add_annotations_to_odata_1.getPrompts; } });
 //# sourceMappingURL=index.js.map

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

@@ -8,21 +8,50 @@
         "maxAgeTooltip": "(Optional) Enter the time in seconds it takes for a cached response of the service to expire.",
         "oDataAnnotationSourceURILabel": "OData Annotation Data Source URI",
         "oDataAnnotationSourceURITooltip": "Server side annotations have been detected for the selected OData service. If needed, enter new annotation data source URI  for the changed service",
-        "addAnnotationOdataSourceTooltip": "Select the annotation file from your workspace",
         "fileSelectOptionLabel": "Annotation XML",
         "fileSelectOptionTooltip": "Select the annotation file source",
         "filePathLabel": "Annotation File path",
-        "filePathTooltip": "Select the annotation file from your workspace"
+        "filePathTooltip": "Select the annotation file from your workspace",
+        "addAnnotationOdataSourceTooltip": "Select the annotation file from your workspace",
+        "oDataServiceNameLabel": "OData Service Name",
+        "oDataServiceNameTooltip": "Enter a name for the OData service you want to add",
+        "oDataServiceUriLabel": "OData Service URI",
+        "oDataServiceUriTooltip": "Enter the URI for the OData service you want to add, e.g. /path/to/odata/",
+        "oDataServiceVersionLabel": "OData Version",
+        "oDataServiceVersionTooltip": "Select the version of OData of the service you want to add",
+        "oDataServiceModelNameLabel": "OData Service SAPUI5 Model Name",
+        "oDataServiceModelNameTooltip": "Enter a name for the SAPUI5 model you want to use from the service",
+        "oDataServiceModelSettingsLabel": "OData Service SAPUI5 Model Settings",
+        "oDataServiceModelSettingsTooltip": "If needed enter any additional model settings in the 'key1':'value1','key2':'value2' format",
+        "oDataAnnotationDataSourceNameLabel": "OData Annotation Data Source Name",
+        "oDataAnnotationDataSourceNameTooltip": "Enter a name for the OData annotation data source",
+        "oDataAnnotationDataSourceUriLabel": "OData Annotation Data Source URI",
+        "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",
+        "title": "Title",
+        "subtitle": "Subtitle",
+        "icon": "Icon"
+    },
+    "tooltips": {
+        "title": "Enter title for your FLP configuration",
+        "subtitle": "Enter subtitle for your FLP configuration",
+        "icon": "Enter icon path for your FLP configuration"
+    },
+    "validators": {
+        "missingIconOrTitleOrSubtitle": "At least one of Title, Subtitle and Icon should have a value.",
+        "fileDoesNotExist": "The file doesn't exist",
+        "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",
+        "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": {
         "annotationFile": {
             "selectFromWorkspace": "Select annotation file from workspace",
             "createEmptyFile": "Create an empty annotation file"
         }
-    },
-    "validators": {
-        "inputCannotBeEmpty": "Input cannot be empty.",
-        "fileDoesNotExist": "The file doesn't exist",
-        "annotationFileAlreadyExists": "There is already an annotation file with the same name, please choose another file or rename the file and select it again"
     }
 }

package/dist/types.d.ts

@@ -8,7 +8,12 @@ export interface DescriptorVariant {
     reference: string;
     id: string;
     namespace: string;
-    content: object[];
+    content: DescriptorVariantContent[];
+}
+export interface DescriptorVariantContent {
+    changeType: string;
+    content: Record<string, unknown>;
+    texts?: string;
 }
 export interface ToolsSupport {
     id: string;
@@ -172,12 +177,19 @@ export interface CodeExtChange extends CommonChangeProperties {
         controllerName: string;
     };
 }
-export declare const CUSTOMER_BASE = "CUSTOMER_BASE";
 export declare const enum TemplateFileName {
     Fragment = "fragment.xml",
     Controller = "controller.ejs",
     Annotation = "annotation.xml"
 }
+export declare const enum FlexLayer {
+    CUSTOMER_BASE = "CUSTOMER_BASE",
+    VENDOR = "VENDOR"
+}
+export declare const enum NamespacePrefix {
+    CUSTOMER = "customer.",
+    EMPTY = ""
+}
 export declare const enum HttpStatusCodes {
     OK = 200,
     CREATED = 201,
@@ -271,51 +283,46 @@ export interface ComponentUsagesData {
     };
 }
 export interface NewModelData {
-    projectData: AdpProjectData;
-    timestamp: number;
-    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;
-    };
-    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;
-    };
-    /** Indicates whether annotation mode is added. */
+    variant: DescriptorVariant;
+    answers: NewModelAnswers;
+}
+export interface NewModelAnswers {
     addAnnotationMode: boolean;
+    /** 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;
+    /** 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. */
+    annotationSettings?: string;
 }
 export interface DataSourceData {
     variant: DescriptorVariant;
     dataSources: Record<string, ManifestNamespace.DataSource>;
     answers: ChangeDataSourceAnswers;
 }
+export interface InboundChangeAnswers {
+    /** 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 InboundData {
-    projectData: AdpProjectData;
-    timestamp: number;
     /** Identifier for the inbound navigation data. */
     inboundId: string;
-    flp: {
-        /** Title associated with the inbound navigation data. */
-        title: PropertyValueType;
-        /** Subtitle associated with the inbound navigation data. */
-        subTitle: PropertyValueType;
-        /** Icon associated with the inbound navigation data. */
-        icon: PropertyValueType;
-    };
-    /** Optional flag indicating if the project is in safe mode. */
-    isInSafeMode?: boolean;
+    variant: DescriptorVariant;
+    answers: InboundChangeAnswers;
 }
 export interface InboundContent {
     inboundId: string;

package/dist/types.js

@@ -1,5 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CUSTOMER_BASE = void 0;
-exports.CUSTOMER_BASE = 'CUSTOMER_BASE';
 //# sourceMappingURL=types.js.map

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

@@ -25,7 +25,6 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AnnotationsWriter = void 0;
 const path_1 = __importStar(require("path"));
-const types_1 = require("../../../types");
 const change_utils_1 = require("../../../base/change-utils");
 /**
  * Handles the creation and writing of annotations data changes for a project.
@@ -50,7 +49,7 @@ class AnnotationsWriter {
     constructContent(data) {
         const { variant: { layer }, fileName, answers: { id } } = data;
         const annotationFileNameWithoutExtension = fileName?.toLocaleLowerCase().replace('.xml', '');
-        const annotationNameSpace = layer === types_1.CUSTOMER_BASE
+        const annotationNameSpace = layer === "CUSTOMER_BASE" /* FlexLayer.CUSTOMER_BASE */
             ? `customer.annotation.${annotationFileNameWithoutExtension}`
             : `annotation.${annotationFileNameWithoutExtension}`;
         return {

package/dist/writer/changes/writers/inbound-writer.d.ts

@@ -26,14 +26,6 @@ export declare class InboundWriter implements IWriter<InboundData> {
      * @returns {void}
      */
     private getEnhancedContent;
-    /**
-     * Processes the provided answers object to parse its properties into the correct format.
-     *
-     * @param {InboundData} data - An object containing raw answers for inboundId, title, subTitle, and icon.
-     * @returns {InboundData} A new answers object with properties modified
-     *                           to ensure they are in the correct format for use in content construction.
-     */
-    private getModifiedData;
     /**
      * Writes the inbound data change to the project based on the provided data.
      *

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

@@ -39,47 +39,29 @@ class InboundWriter {
      * @returns {void}
      */
     getEnhancedContent(data, content) {
-        const { icon, title, subTitle } = data.flp;
+        const { icon, title, subTitle } = data.answers;
         if (title) {
             content.entityPropertyChange.push({
                 propertyPath: 'title',
                 operation: 'UPSERT',
-                propertyValue: title
+                propertyValue: (0, change_utils_1.getParsedPropertyValue)(title)
             });
         }
         if (subTitle) {
             content.entityPropertyChange.push({
                 propertyPath: 'subTitle',
                 operation: 'UPSERT',
-                propertyValue: subTitle
+                propertyValue: (0, change_utils_1.getParsedPropertyValue)(subTitle)
             });
         }
         if (icon) {
             content.entityPropertyChange.push({
                 propertyPath: 'icon',
                 operation: 'UPSERT',
-                propertyValue: icon
+                propertyValue: (0, change_utils_1.getParsedPropertyValue)(icon)
             });
         }
     }
-    /**
-     * Processes the provided answers object to parse its properties into the correct format.
-     *
-     * @param {InboundData} data - An object containing raw answers for inboundId, title, subTitle, and icon.
-     * @returns {InboundData} A new answers object with properties modified
-     *                           to ensure they are in the correct format for use in content construction.
-     */
-    getModifiedData(data) {
-        const { title, subTitle, icon } = data.flp;
-        return {
-            ...data,
-            flp: {
-                title: (0, change_utils_1.getParsedPropertyValue)(title),
-                subTitle: (0, change_utils_1.getParsedPropertyValue)(subTitle),
-                icon: (0, change_utils_1.getParsedPropertyValue)(icon)
-            }
-        };
-    }
     /**
      * Writes the inbound data change to the project based on the provided data.
      *
@@ -87,16 +69,16 @@ class InboundWriter {
      * @returns {Promise<void>} A promise that resolves when the change writing process is completed.
      */
     async write(data) {
-        const answers = this.getModifiedData(data);
-        const { changeWithInboundId, filePath } = (0, change_utils_1.findChangeWithInboundId)(this.projectPath, answers.inboundId);
+        const { changeWithInboundId, filePath } = (0, change_utils_1.findChangeWithInboundId)(this.projectPath, data.inboundId);
+        const timestamp = Date.now();
         if (!changeWithInboundId) {
-            const content = this.constructContent(answers);
-            const change = (0, change_utils_1.getChange)(data.projectData, data.timestamp, content, "appdescr_app_changeInbound" /* ChangeType.CHANGE_INBOUND */);
-            (0, change_utils_1.writeChangeToFolder)(this.projectPath, change, `id_${data.timestamp}_changeInbound.change`, this.fs, project_access_1.DirName.Manifest);
+            const content = this.constructContent(data);
+            const change = (0, change_utils_1.getChange)(data.variant, timestamp, content, "appdescr_app_changeInbound" /* ChangeType.CHANGE_INBOUND */);
+            (0, change_utils_1.writeChangeToFolder)(this.projectPath, change, `id_${timestamp}_changeInbound.change`, this.fs, project_access_1.DirName.Manifest);
         }
         else {
             if (changeWithInboundId.content) {
-                this.getEnhancedContent(answers, changeWithInboundId.content);
+                this.getEnhancedContent(data, changeWithInboundId.content);
             }
             (0, change_utils_1.writeChangeToFile)(filePath, changeWithInboundId, this.fs);
         }

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 {NewModelData} data - The answers object containing information needed to construct the content property.
+     * @param {NewModelAnswers} 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,37 @@ class NewModelWriter {
     /**
      * Constructs the content for an new model change based on provided data.
      *
-     * @param {NewModelData} data - The answers object containing information needed to construct the content property.
+     * @param {NewModelAnswers} data - The answers object containing information needed to construct the content property.
      * @returns {object} The constructed content object for the new model change.
      */
-    constructContent({ service, annotation, addAnnotationMode }) {
+    constructContent({ name, uri, addAnnotationMode, dataSourceName, modelName, modelSettings, version, dataSourceURI, annotationSettings }) {
         const content = {
             dataSource: {
-                [service.name]: {
-                    uri: service.uri,
+                [name]: {
+                    uri,
                     type: 'OData',
                     settings: {
-                        odataVersion: service.version
+                        odataVersion: version
                     }
                 }
             },
             model: {
-                [service.modelName]: {
-                    dataSource: service.name
+                [modelName]: {
+                    dataSource: name
                 }
             }
         };
-        if (service.modelSettings && service.modelSettings.length !== 0) {
-            content.model[service.modelName].settings = (0, change_utils_1.parseStringToObject)(service.modelSettings);
+        if (modelSettings && modelSettings.length !== 0) {
+            content.model[modelName].settings = (0, change_utils_1.parseStringToObject)(modelSettings);
         }
         if (addAnnotationMode) {
-            content.dataSource[service.name].settings.annotations = [`${annotation.dataSourceName}`];
-            content.dataSource[annotation.dataSourceName] = {
-                uri: annotation.dataSourceURI,
+            content.dataSource[name].settings.annotations = [`${dataSourceName}`];
+            content.dataSource[dataSourceName] = {
+                uri: dataSourceURI,
                 type: 'ODataAnnotation'
             };
-            if (annotation.settings && annotation.settings.length !== 0) {
-                content.dataSource[annotation.dataSourceName].settings = (0, change_utils_1.parseStringToObject)(annotation.settings);
+            if (annotationSettings && annotationSettings.length !== 0) {
+                content.dataSource[dataSourceName].settings = (0, change_utils_1.parseStringToObject)(annotationSettings);
             }
         }
         return content;
@@ -62,9 +62,10 @@ class NewModelWriter {
      * @returns {Promise<void>} A promise that resolves when the change writing process is completed.
      */
     async write(data) {
-        const content = this.constructContent(data);
-        const change = (0, change_utils_1.getChange)(data.projectData, data.timestamp, content, "appdescr_ui5_addNewModel" /* ChangeType.ADD_NEW_MODEL */);
-        (0, change_utils_1.writeChangeToFolder)(this.projectPath, change, `id_${data.timestamp}_addNewModel.change`, this.fs, project_access_1.DirName.Manifest);
+        const timestamp = Date.now();
+        const content = this.constructContent(data.answers);
+        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);
     }
 }
 exports.NewModelWriter = NewModelWriter;

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.17",
+  "version": "0.12.19",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -34,9 +34,10 @@
     "uuid": "10.0.0",
     "@sap-ux/axios-extension": "1.16.1",
     "@sap-ux/btp-utils": "0.15.0",
-    "@sap-ux/inquirer-common": "0.4.2",
+    "@sap-ux/inquirer-common": "0.4.3",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/project-access": "1.25.7",
+    "@sap-ux/project-input-validator": "0.3.2",
     "@sap-ux/system-access": "0.5.3",
     "@sap-ux/ui5-config": "0.23.1"
   },

package/dist/base/validators.d.ts

@@ -1,15 +0,0 @@
-/**
- * Checks if the input is a non-empty string.
- *
- * @param input - input to check
- * @returns true if the input is a non-empty string
- */
-export declare function isNotEmptyString(input: string | undefined): boolean;
-/**
- * Checks if the input is a valid SAP client.
- *
- * @param input - input to check
- * @returns true if the input is a valid SAP client
- */
-export declare function isValidSapClient(input: string | undefined): boolean;
-//# sourceMappingURL=validators.d.ts.map

package/dist/base/validators.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isValidSapClient = exports.isNotEmptyString = void 0;
-/**
- * Checks if the input is a non-empty string.
- *
- * @param input - input to check
- * @returns true if the input is a non-empty string
- */
-function isNotEmptyString(input) {
-    return typeof input === 'string' && input.trim().length > 0;
-}
-exports.isNotEmptyString = isNotEmptyString;
-/**
- * Checks if the input is a valid SAP client.
- *
- * @param input - input to check
- * @returns true if the input is a valid SAP client
- */
-function isValidSapClient(input) {
-    return !input || (input.length < 4 && !!new RegExp(/^\d*$/).exec(input));
-}
-exports.isValidSapClient = isValidSapClient;
-//# sourceMappingURL=validators.js.map