@sap-ux/create 0.7.19 → 0.7.21

package/README.md

@@ -26,6 +26,11 @@ Calling `sap-ux add html` will add html files for local preview and testing to t
 ```sh
 sap-ux change add html ui5-test.yaml
 ```
+### annotations
+Calling `sap-ux add annotations` allows adding an annotation to the OData Source of the base application in an adaptation project.
+```sh
+sap-ux add annotations /path/to/adaptation-project
+```
 
 ## change
 Calling `sap-ux change` allows changing a feature of a project.

package/dist/cli/add/annotations-to-odata.d.ts

@@ -0,0 +1,8 @@
+import type { Command } from 'commander';
+/**
+ * Add a new sub-command to add annotations to odata service of an adaptation project to the given command.
+ *
+ * @param {Command} cmd - The command to add the add annotations-to-odata sub-command to.
+ */
+export declare function addAnnotationsToOdataCommand(cmd: Command): void;
+//# sourceMappingURL=annotations-to-odata.d.ts.map

package/dist/cli/add/annotations-to-odata.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addAnnotationsToOdataCommand = void 0;
+const adp_tooling_1 = require("@sap-ux/adp-tooling");
+const tracing_1 = require("../../tracing");
+const common_1 = require("../../common");
+const validation_1 = require("../../validation/validation");
+let loginAttempts = 3;
+/**
+ * Add a new sub-command to add annotations to odata service of an adaptation project to the given command.
+ *
+ * @param {Command} cmd - The command to add the add annotations-to-odata sub-command to.
+ */
+function addAnnotationsToOdataCommand(cmd) {
+    cmd.command('annotations [path]')
+        .option('-s, --simulate', 'simulate only do not write or install')
+        .option('-c, --config <string>', 'Path to project configuration file in YAML format', 'ui5.yaml')
+        .action(async (path, options) => {
+        await addAnnotationsToOdata(path, !!options.simulate, options.config);
+    });
+}
+exports.addAnnotationsToOdataCommand = addAnnotationsToOdataCommand;
+/**
+ * Changes the data source of an adaptation project.
+ *
+ * @param {string} basePath - The path to the adaptation project.
+ * @param {boolean} simulate - If set to true, then no files will be written to the filesystem.
+ * @param {string} yamlPath - The path to the project configuration file in YAML format.
+ */
+async function addAnnotationsToOdata(basePath, simulate, yamlPath) {
+    const logger = (0, tracing_1.getLogger)();
+    try {
+        if (!basePath) {
+            basePath = process.cwd();
+        }
+        await (0, validation_1.validateAdpProject)(basePath);
+        const variant = (0, adp_tooling_1.getVariant)(basePath);
+        const adpConfig = await (0, adp_tooling_1.getAdpConfig)(basePath, yamlPath);
+        const dataSources = await (0, adp_tooling_1.getManifestDataSources)(variant.reference, adpConfig, logger);
+        const answers = await (0, common_1.promptYUIQuestions)((0, adp_tooling_1.getPromptsForAddAnnotationsToOData)(basePath, dataSources), false);
+        const fs = await (0, adp_tooling_1.generateChange)(basePath, "appdescr_app_addAnnotationsToOData" /* ChangeType.ADD_ANNOTATIONS_TO_ODATA */, {
+            variant,
+            answers
+        });
+        if (!simulate) {
+            await new Promise((resolve) => fs.commit(resolve));
+        }
+        else {
+            await (0, tracing_1.traceChanges)(fs);
+        }
+    }
+    catch (error) {
+        logger.error(error.message);
+        if (error.response?.status === 401 && loginAttempts) {
+            loginAttempts--;
+            logger.error(`Authentication failed. Please check your credentials. Login attempts left: ${loginAttempts}`);
+            await addAnnotationsToOdata(basePath, simulate, yamlPath);
+            return;
+        }
+        logger.debug(error);
+    }
+}
+//# sourceMappingURL=annotations-to-odata.js.map

package/dist/cli/add/index.js

@@ -7,6 +7,7 @@ const smartlinks_config_1 = require("./smartlinks-config");
 const cds_plugin_ui_1 = require("./cds-plugin-ui");
 const navigation_config_1 = require("./navigation-config");
 const cards_editor_1 = require("./cards-editor");
+const annotations_to_odata_1 = require("./annotations-to-odata");
 const html_1 = require("./html");
 /**
  * Return 'create-fiori add *' commands. Commands include also the handler action.
@@ -25,6 +26,8 @@ function getAddCommands() {
     (0, navigation_config_1.addInboundNavigationConfigCommand)(addCommands);
     // create-fiori add cards-editor
     (0, cards_editor_1.addCardsEditorConfigCommand)(addCommands);
+    // create-fiori add annotations-to-odata
+    (0, annotations_to_odata_1.addAnnotationsToOdataCommand)(addCommands);
     // create-fiori add html
     (0, html_1.addAddHtmlFilesCmd)(addCommands);
     return addCommands;

package/dist/cli/change/change-data-source.js

@@ -3,11 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.addChangeDataSourceCommand = void 0;
 const adp_tooling_1 = require("@sap-ux/adp-tooling");
 const tracing_1 = require("../../tracing");
-const fs_1 = require("fs");
-const path_1 = require("path");
-const ui5_config_1 = require("@sap-ux/ui5-config");
 const common_1 = require("../../common");
-const project_access_1 = require("@sap-ux/project-access");
+const validation_1 = require("../../validation/validation");
 let loginAttempts = 3;
 /**
  * Add a new sub-command to change the data source of an adaptation project to the given command.
@@ -19,7 +16,7 @@ function addChangeDataSourceCommand(cmd) {
         .option('-s, --simulate', 'simulate only do not write or install')
         .option('-c, --config <string>', 'Path to project configuration file in YAML format', 'ui5.yaml')
         .action(async (path, options) => {
-        await changeDataSource(path, { ...options }, !!options.simulate, options.config);
+        await changeDataSource(path, !!options.simulate, options.config);
     });
 }
 exports.addChangeDataSourceCommand = addChangeDataSourceCommand;
@@ -27,34 +24,19 @@ exports.addChangeDataSourceCommand = addChangeDataSourceCommand;
  * Changes the data source of an adaptation project.
  *
  * @param {string} basePath - The path to the adaptation project.
- * @param {PromptDefaults} defaults - The default values for the prompts.
  * @param {boolean} simulate - If set to true, then no files will be written to the filesystem.
  * @param {string} yamlPath - The path to the project configuration file in YAML format.
  */
-async function changeDataSource(basePath, defaults, simulate, yamlPath) {
+async function changeDataSource(basePath, simulate, yamlPath) {
     const logger = (0, tracing_1.getLogger)();
     try {
         if (!basePath) {
             basePath = process.cwd();
         }
-        if ((await (0, project_access_1.getAppType)(basePath)) !== 'Fiori Adaptation') {
-            throw new Error('This command can only be used for an Adaptation Project');
-        }
-        checkEnvironment(basePath);
-        const variant = getVariant(basePath);
-        const ui5ConfigPath = (0, path_1.isAbsolute)(yamlPath) ? yamlPath : (0, path_1.join)(basePath, yamlPath);
-        const ui5Conf = await ui5_config_1.UI5Config.newInstance((0, fs_1.readFileSync)(ui5ConfigPath, 'utf-8'));
-        const customMiddlerware = ui5Conf.findCustomMiddleware('fiori-tools-preview') ??
-            ui5Conf.findCustomMiddleware('preview-middleware');
-        const adp = customMiddlerware?.configuration?.adp;
-        if (!adp) {
-            throw new Error('No system configuration found in ui5.yaml');
-        }
-        const manifest = await (0, adp_tooling_1.getManifest)(variant.reference, adp, logger);
-        const dataSources = manifest['sap.app'].dataSources;
-        if (!dataSources) {
-            throw new Error('No data sources found in the manifest');
-        }
+        await (0, validation_1.validateAdpProject)(basePath);
+        const variant = (0, adp_tooling_1.getVariant)(basePath);
+        const adpConfig = await (0, adp_tooling_1.getAdpConfig)(basePath, yamlPath);
+        const dataSources = await (0, adp_tooling_1.getManifestDataSources)(variant.reference, adpConfig, logger);
         const answers = await (0, common_1.promptYUIQuestions)((0, adp_tooling_1.getPromptsForChangeDataSource)(dataSources), false);
         const fs = await (0, adp_tooling_1.generateChange)(basePath, "appdescr_app_changeDataSource" /* ChangeType.CHANGE_DATA_SOURCE */, {
             variant,
@@ -73,34 +55,10 @@ async function changeDataSource(basePath, defaults, simulate, yamlPath) {
         if (error.response?.status === 401 && loginAttempts) {
             loginAttempts--;
             logger.error(`Authentication failed. Please check your credentials. Login attempts left: ${loginAttempts}`);
-            await changeDataSource(basePath, defaults, simulate, yamlPath);
+            await changeDataSource(basePath, simulate, yamlPath);
             return;
         }
         logger.debug(error);
     }
 }
-/**
- * Get the app descriptor variant.
- *
- * @param {string} basePath - The path to the adaptation project.
- * @returns {DescriptorVariant} The app descriptor variant.
- */
-function getVariant(basePath) {
-    return JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(basePath, 'webapp', 'manifest.appdescr_variant'), 'utf-8'));
-}
-/**
- * Check if the project is a CF project.
- *
- * @param {string} basePath - The path to the adaptation project.
- * @throws {Error} If the project is a CF project.
- */
-function checkEnvironment(basePath) {
-    const configJsonPath = (0, path_1.join)(basePath, '.adp', 'config.json');
-    if ((0, fs_1.existsSync)(configJsonPath)) {
-        const config = JSON.parse((0, fs_1.readFileSync)(configJsonPath, 'utf-8'));
-        if (config.environment === 'CF') {
-            throw new Error('Changing data source is not supported for CF projects.');
-        }
-    }
-}
 //# sourceMappingURL=change-data-source.js.map

package/dist/validation/validation.d.ts

@@ -13,4 +13,10 @@ export declare function validateBasePath(basePath: string, ui5YamlPath?: string)
  * @returns - true if fs contains deletions; false otherwise
  */
 export declare function hasFileDeletes(fs: Editor): boolean;
+/**
+ * Validate if adaptation project is supported for command, throws an error if not supported.
+ *
+ * @param basePath - path to the adaptation project
+ */
+export declare function validateAdpProject(basePath: string): Promise<void>;
 //# sourceMappingURL=validation.d.ts.map

package/dist/validation/validation.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasFileDeletes = exports.validateBasePath = void 0;
+exports.validateAdpProject = exports.hasFileDeletes = exports.validateBasePath = void 0;
 const project_access_1 = require("@sap-ux/project-access");
 const fs_1 = require("fs");
 const path_1 = require("path");
+const adp_tooling_1 = require("@sap-ux/adp-tooling");
 /**
  * Validate base path of app, throw error if file is missing.
  *
@@ -33,4 +34,18 @@ function hasFileDeletes(fs) {
     return !!Object.keys(changedFiles).find((fileName) => changedFiles[fileName].state === 'deleted');
 }
 exports.hasFileDeletes = hasFileDeletes;
+/**
+ * Validate if adaptation project is supported for command, throws an error if not supported.
+ *
+ * @param basePath - path to the adaptation project
+ */
+async function validateAdpProject(basePath) {
+    if ((await (0, project_access_1.getAppType)(basePath)) !== 'Fiori Adaptation') {
+        throw new Error('This command can only be used for an adaptation project');
+    }
+    if ((0, adp_tooling_1.isCFEnvironment)(basePath)) {
+        throw new Error('This command is not supported for CF projects.');
+    }
+}
+exports.validateAdpProject = validateAdpProject;
 //# sourceMappingURL=validation.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/create",
   "description": "SAP Fiori tools module to add or remove features",
-  "version": "0.7.19",
+  "version": "0.7.21",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -30,15 +30,15 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "prompts": "2.4.2",
-    "@sap-ux/adp-tooling": "0.12.12",
-    "@sap-ux/app-config-writer": "0.4.9",
-    "@sap-ux/cap-config-writer": "0.7.0",
-    "@sap-ux/inquirer-common": "0.4.1",
+    "@sap-ux/adp-tooling": "0.12.14",
+    "@sap-ux/app-config-writer": "0.4.10",
+    "@sap-ux/cap-config-writer": "0.7.1",
     "@sap-ux/cards-editor-config-writer": "0.4.1",
+    "@sap-ux/inquirer-common": "0.4.1",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/mockserver-config-writer": "0.6.1",
-    "@sap-ux/preview-middleware": "0.16.18",
-    "@sap-ux/project-access": "1.25.5",
+    "@sap-ux/preview-middleware": "0.16.20",
+    "@sap-ux/project-access": "1.25.6",
     "@sap-ux/system-access": "0.5.2",
     "@sap-ux/ui5-config": "0.23.1"
   },