@sap-ux/mockserver-config-writer 0.6.7 → 0.7.0

package/dist/app-info.js

@@ -2,6 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getMainServiceDataSource = getMainServiceDataSource;
 exports.getODataSources = getODataSources;
+/**
+ * Get the main service data source name from manifest.json.
+ *
+ * @param manifest - Parsed manifest.json
+ * @returns - data source name from manifest.json
+ */
+function getMainServiceDataSourceName(manifest) {
+    const modelName = manifest['sap.ovp']?.globalFilterModel ?? '';
+    return manifest['sap.ui5']?.models?.[modelName]?.dataSource;
+}
 /**
  * Get the main service data source entry from manifest.json.
  *
@@ -10,10 +20,7 @@ exports.getODataSources = getODataSources;
  */
 function getMainServiceDataSource(manifest) {
     let dataSource;
-    const model = manifest['sap.ovp']?.globalFilterModel || '';
-    const dataSourceName = manifest['sap.ui5'] && manifest['sap.ui5'].models?.[model]
-        ? manifest['sap.ui5'].models[model].dataSource
-        : undefined;
+    const dataSourceName = getMainServiceDataSourceName(manifest);
     if (dataSourceName) {
         dataSource = manifest['sap.app'].dataSources?.[dataSourceName];
     }
@@ -28,7 +35,7 @@ function getMainServiceDataSource(manifest) {
  */
 function getODataSources(manifest, dataSourceType = 'OData') {
     const result = {};
-    const dataSources = manifest['sap.app']?.dataSources || {};
+    const dataSources = manifest['sap.app']?.dataSources ?? {};
     for (const dataSource in dataSources) {
         if (dataSources[dataSource].uri && dataSources[dataSource].type === dataSourceType) {
             result[dataSource] = dataSources[dataSource];

package/dist/i18n.js

@@ -7,12 +7,13 @@ exports.initI18n = initI18n;
 exports.t = t;
 const i18next_1 = __importDefault(require("i18next"));
 const mockserver_config_writer_i18n_json_1 = __importDefault(require("./translations/mockserver-config-writer.i18n.json"));
-const NS = 'odata-service-writer';
+const NS = 'mockserver-config-writer';
+let i18nInstance;
 /**
  * Initialize i18next with the translations for this module.
  */
 async function initI18n() {
-    await i18next_1.default.init({
+    i18nInstance = i18next_1.default.createInstance({
         resources: {
             en: {
                 [NS]: mockserver_config_writer_i18n_json_1.default
@@ -23,6 +24,7 @@ async function initI18n() {
         defaultNS: NS,
         ns: [NS]
     });
+    await i18nInstance.init();
 }
 /**
  * Helper function facading the call to i18next.
@@ -32,7 +34,7 @@ async function initI18n() {
  * @returns {string} localized string stored for the given key
  */
 function t(key, options) {
-    return i18next_1.default.t(key, options);
+    return i18nInstance.t(key, options);
 }
 initI18n().catch(() => {
     // Ignore any errors since the write will still work

package/dist/mockserver-config/index.d.ts

@@ -16,5 +16,5 @@ export declare function generateMockserverConfig(basePath: string, data: Mockser
  * @param fs - the memfs editor instance
  * @returns Promise<Editor> - memfs editor instance with updated files
  */
-export declare function removeMockserverConfig(basePath: string, fs?: Editor): Editor;
+export declare function removeMockserverConfig(basePath: string, fs?: Editor): Promise<Editor>;
 //# sourceMappingURL=index.d.ts.map

package/dist/mockserver-config/index.js

@@ -29,12 +29,13 @@ async function generateMockserverConfig(basePath, data, fs) {
  * @param fs - the memfs editor instance
  * @returns Promise<Editor> - memfs editor instance with updated files
  */
-function removeMockserverConfig(basePath, fs) {
+async function removeMockserverConfig(basePath, fs) {
     if (!fs) {
         fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     }
     (0, package_json_1.removeFromPackageJson)(fs, basePath);
     (0, ui5_mock_yaml_1.removeUi5MockYaml)(fs, basePath);
+    await (0, ui5_mock_yaml_1.removeMockDataFolders)(fs, basePath);
     return fs;
 }
 //# sourceMappingURL=index.js.map

package/dist/mockserver-config/package-json.js

@@ -26,7 +26,7 @@ function enhancePackageJson(fs, basePath, config) {
  * @param version - npm version string
  */
 function enhanceDependencies(packageJson, mockserverModule = '@sap-ux/ui5-middleware-fe-mockserver', version = '2') {
-    packageJson.devDependencies = packageJson.devDependencies || {};
+    packageJson.devDependencies = packageJson.devDependencies ?? {};
     delete packageJson.devDependencies['@sap/ux-ui5-fe-mockserver-middleware'];
     packageJson.devDependencies[mockserverModule] = version;
     if (isUi5CliHigherTwo(packageJson.devDependencies)) {

package/dist/mockserver-config/ui5-mock-yaml.d.ts

@@ -2,6 +2,8 @@ import type { Editor } from 'mem-fs-editor';
 import type { Ui5MockYamlConfig } from '../types';
 /**
  * Enhance or create the ui5-mock.yaml with mockserver config.
+ * Mockserver config services and annotations are collected from associated manifest.json file of the project.
+ * If there aren't any services or annotations defined in manifest dataSources section, then mockserver config will be generated without those.
  * Following enhancement strategy is applied:
  *
  * ui5-mock.yaml exists
@@ -21,6 +23,13 @@ import type { Ui5MockYamlConfig } from '../types';
  * @param config - optional config passed in by consumer
  */
 export declare function enhanceYaml(fs: Editor, basePath: string, webappPath: string, config?: Ui5MockYamlConfig): Promise<void>;
+/**
+ * Deletes mock data folders for all services from mem-fs.
+ *
+ * @param fs - mem-fs reference to be used for file access
+ * @param basePath - path to project root, where package.json and ui5.yaml is
+ */
+export declare function removeMockDataFolders(fs: Editor, basePath: string): Promise<void>;
 /**
  * Delete ui5-mock.yaml file from mem-fs.
  *

package/dist/mockserver-config/ui5-mock-yaml.js

@@ -1,12 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.enhanceYaml = enhanceYaml;
+exports.removeMockDataFolders = removeMockDataFolders;
 exports.removeUi5MockYaml = removeUi5MockYaml;
 const path_1 = require("path");
 const ui5_config_1 = require("@sap-ux/ui5-config");
+const project_access_1 = require("@sap-ux/project-access");
 const app_info_1 = require("../app-info");
 /**
  * Enhance or create the ui5-mock.yaml with mockserver config.
+ * Mockserver config services and annotations are collected from associated manifest.json file of the project.
+ * If there aren't any services or annotations defined in manifest dataSources section, then mockserver config will be generated without those.
  * Following enhancement strategy is applied:
  *
  * ui5-mock.yaml exists
@@ -26,82 +30,127 @@ const app_info_1 = require("../app-info");
  * @param config - optional config passed in by consumer
  */
 async function enhanceYaml(fs, basePath, webappPath, config) {
+    const overwrite = !!config?.overwrite;
     const ui5MockYamlPath = (0, path_1.join)(basePath, 'ui5-mock.yaml');
     let mockConfig;
     const manifest = fs.readJSON((0, path_1.join)(webappPath, 'manifest.json'));
-    const mockserverPath = config?.path || (0, app_info_1.getMainServiceDataSource)(manifest)?.uri;
+    // Prepare annotations list to be used in mockserver middleware config annotations
     const annotationSource = Object.values((0, app_info_1.getODataSources)(manifest, 'ODataAnnotation'));
     const annotationsConfig = annotationSource.map((annotation) => ({
         localPath: `./webapp/${annotation.settings?.localUri}`,
         urlPath: annotation.uri
     }));
+    // Prepare dataSources list to be used in mockserver middleware config services
+    const dataSources = (0, app_info_1.getODataSources)(manifest);
+    const dataSourcesConfig = [];
+    for (const dataSource in dataSources) {
+        const localUri = dataSources[dataSource].settings?.localUri;
+        dataSourcesConfig.push({
+            serviceName: dataSource,
+            servicePath: dataSources[dataSource].uri,
+            metadataPath: localUri ? `./webapp/${localUri}` : undefined
+        });
+    }
     if (fs.exists(ui5MockYamlPath)) {
-        mockConfig = await updateUi5MockYamlConfig(fs, ui5MockYamlPath, mockserverPath, annotationsConfig);
+        mockConfig = await updateUi5MockYamlConfig(fs, ui5MockYamlPath, dataSourcesConfig, annotationsConfig, overwrite);
     }
     else {
         mockConfig = fs.exists((0, path_1.join)(basePath, 'ui5.yaml'))
-            ? await generateUi5MockYamlBasedOnUi5Yaml(fs, basePath, mockserverPath, annotationsConfig)
-            : await generateNewUi5MockYamlConfig(manifest['sap.app']?.id || '', mockserverPath, annotationsConfig);
+            ? await generateUi5MockYamlBasedOnUi5Yaml(fs, basePath, dataSourcesConfig, annotationsConfig)
+            : await generateNewUi5MockYamlConfig(manifest['sap.app']?.id || '', dataSourcesConfig, annotationsConfig);
     }
     const yaml = mockConfig.toString();
     fs.write(ui5MockYamlPath, yaml);
 }
 /**
- * Update existing ui5-mock.yaml config. This will add or replace existing middleware configuration
+ * Deletes mock data folders for all services from mem-fs.
+ *
+ * @param fs - mem-fs reference to be used for file access
+ * @param basePath - path to project root, where package.json and ui5.yaml is
+ */
+async function removeMockDataFolders(fs, basePath) {
+    const webappPath = await (0, project_access_1.getWebappPath)(basePath, fs);
+    const manifestPath = (0, path_1.join)(webappPath, project_access_1.FileName.Manifest);
+    const manifest = fs.readJSON(manifestPath);
+    // Read service names from manifest.json
+    const dataSources = manifest['sap.app'].dataSources;
+    if (dataSources) {
+        const serviceNames = Object.keys(dataSources);
+        serviceNames.forEach((serviceName) => {
+            const mockdataPath = (0, path_1.join)(webappPath, project_access_1.DirName.LocalService, serviceName, project_access_1.DirName.Data);
+            if (mockdataPath) {
+                fs.delete(mockdataPath);
+            }
+        });
+    }
+}
+/**
+ * Update existing ui5-mock.yaml config. This will add or replace existing middleware configuration.
+ * If 'overwrite' is set to true, then mockserver middleware configuration would be replaced else only enhanced with data from 'name' and 'path'.
  * 'sap-fe-mockserver' with state of the art config.
  *
  * @param fs - Editor instance to read existing information
  * @param ui5MockYamlPath - path to ui5-mock.yaml file
- * @param [path] - optional url path the mockserver listens to
- * @param annotationsConfig - optional annotations config to add to mockserver middleware
- * @returns {*}  {Promise<UI5Config>} - Update Yaml Doc
+ * @param dataSourcesConfig - dataSources config from manifest to add to mockserver middleware services list
+ * @param annotationsConfig - annotations config to add to mockserver mockserver middleware annotations list
+ * @param overwrite - optional, whether to overwrite existing annotations and services
+ * @returns {*}  {Promise<UI5Config>} - Updated Yaml Doc
  */
-async function updateUi5MockYamlConfig(fs, ui5MockYamlPath, path, annotationsConfig) {
+async function updateUi5MockYamlConfig(fs, ui5MockYamlPath, dataSourcesConfig, annotationsConfig, overwrite = false) {
     const existingUi5MockYamlConfig = await ui5_config_1.UI5Config.newInstance(fs.read(ui5MockYamlPath));
-    existingUi5MockYamlConfig.updateCustomMiddleware(await getNewMockserverMiddleware(path, annotationsConfig));
+    if (overwrite) {
+        const newMockserverMiddleware = await getNewMockserverMiddleware(dataSourcesConfig, annotationsConfig);
+        existingUi5MockYamlConfig.updateCustomMiddleware(newMockserverMiddleware);
+    }
+    else {
+        for (const dataSourceName in dataSourcesConfig) {
+            existingUi5MockYamlConfig.addServiceToMockserverMiddleware(dataSourcesConfig[dataSourceName], undefined, annotationsConfig);
+        }
+    }
     return existingUi5MockYamlConfig;
 }
 /**
  * Create a new ui5-mock.yaml based on existing ui5.yaml.
  *
  * @param fs - Editor instance to read existing information
- * @param basePath -
- * @param [path] - optional path for mockserver config
- * @param annotationsConfig - optional annotations config to add to mockserver middleware
+ * @param basePath - the base path where the package.json and ui5.yaml is
+ * @param dataSourcesConfig - dataSources config from manifest to add to mockserver middleware services list
+ * @param annotationsConfig - annotations config to add to mockserver mockserver middleware annotations list
  * @returns {*}  {Promise<UI5Config>} - Update Yaml Doc
  */
-async function generateUi5MockYamlBasedOnUi5Yaml(fs, basePath, path, annotationsConfig) {
-    const ui5MockYamlConfig = await ui5_config_1.UI5Config.newInstance(fs.read((0, path_1.join)(basePath, 'ui5.yaml')));
-    ui5MockYamlConfig.updateCustomMiddleware(await getNewMockserverMiddleware(path, annotationsConfig));
+async function generateUi5MockYamlBasedOnUi5Yaml(fs, basePath, dataSourcesConfig, annotationsConfig) {
+    const ui5MockYamlConfig = await (0, project_access_1.readUi5Yaml)(basePath, project_access_1.FileName.Ui5Yaml, fs);
+    const ui5MockServerMiddleware = await getNewMockserverMiddleware(dataSourcesConfig, annotationsConfig);
+    ui5MockYamlConfig.updateCustomMiddleware(ui5MockServerMiddleware);
     return ui5MockYamlConfig;
 }
 /**
  * Create fresh ui5-mock.yaml configuration which can be stringified and written.
  *
  * @param appId - application id
- * @param [path] - optional url path the mockserver listens to
- * @param annotationsConfig - optional annotations config to add to mockserver middleware
+ * @param dataSourcesConfig - dataSources config from manifest to add to mockserver middleware services list
+ * @param annotationsConfig - annotations config to add to mockserver mockserver middleware annotations list
  * @returns {*}  {Promise<UI5Config>} - Update Yaml Doc
  */
-async function generateNewUi5MockYamlConfig(appId, path, annotationsConfig) {
+async function generateNewUi5MockYamlConfig(appId, dataSourcesConfig, annotationsConfig) {
     const ui5MockYaml = await ui5_config_1.UI5Config.newInstance('# yaml-language-server: $schema=https://sap.github.io/ui5-tooling/schema/ui5.yaml.json\n\nspecVersion: "2.5"');
     ui5MockYaml.setMetadata({ name: appId });
     ui5MockYaml.setType('application');
     ui5MockYaml.addFioriToolsProxydMiddleware({ ui5: {} });
     ui5MockYaml.addFioriToolsAppReloadMiddleware();
-    ui5MockYaml.addMockServerMiddleware(path, annotationsConfig);
+    ui5MockYaml.addMockServerMiddleware(dataSourcesConfig, annotationsConfig);
     return ui5MockYaml;
 }
 /**
  * Return new mockserver middleware.
  *
- * @param [path] - optional path for mockserver config
- * @param annotationsConfig - optional annotations config to add to mockserver middleware
+ * @param dataSourcesConfig - dataSources config from manifest to add to mockserver middleware services list
+ * @param annotationsConfig - annotations config to add to mockserver mockserver middleware annotations list
  * @returns - mockserver middleware
  */
-async function getNewMockserverMiddleware(path, annotationsConfig) {
+async function getNewMockserverMiddleware(dataSourcesConfig, annotationsConfig) {
     const ui5MockYaml = await ui5_config_1.UI5Config.newInstance('');
-    ui5MockYaml.addMockServerMiddleware(path, annotationsConfig);
+    ui5MockYaml.addMockServerMiddleware(dataSourcesConfig, annotationsConfig);
     const mockserverMiddleware = ui5MockYaml.findCustomMiddleware('sap-fe-mockserver');
     if (!mockserverMiddleware) {
         throw Error('Could not create new mockserver config');

package/dist/prompt/index.d.ts

@@ -5,11 +5,13 @@ import type { PromptObject } from 'prompts';
  *
  * @param params - optional parameters used to fill default values
  * @param params.webappPath - optional path to webapp folder, where manifest is
+ * @param params.askForOverwrite - optional, whether to overwrite services in mockserver config
  * @param params.fs - optional memfs editor instance
  * @returns - array of questions that serves as input for prompt module
  */
 export declare function getMockserverConfigQuestions(params?: {
     webappPath?: string;
+    askForOverwrite?: boolean;
     fs?: Editor;
 }): PromptObject[];
 //# sourceMappingURL=index.d.ts.map

package/dist/prompt/index.js

@@ -11,34 +11,45 @@ const __1 = require("..");
  *
  * @param params - optional parameters used to fill default values
  * @param params.webappPath - optional path to webapp folder, where manifest is
+ * @param params.askForOverwrite - optional, whether to overwrite services in mockserver config
  * @param params.fs - optional memfs editor instance
  * @returns - array of questions that serves as input for prompt module
  */
 function getMockserverConfigQuestions(params) {
-    const question = {
+    const prompts = [];
+    const questionPath = {
         name: 'path',
         message: (0, __1.t)('questions.pathToMock')
     };
     if (params?.webappPath) {
-        const fs = params.fs || (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+        const fs = params.fs ?? (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
         const manifest = JSON.parse(fs.read((0, path_1.join)(params.webappPath, 'manifest.json')));
-        const mainDataSourceUri = (0, app_info_1.getMainServiceDataSource)(manifest)?.uri || '';
+        const mainDataSourceUri = (0, app_info_1.getMainServiceDataSource)(manifest)?.uri ?? '';
         const oDataSources = (0, app_info_1.getODataSources)(manifest);
         const choices = [];
         for (const dsName in oDataSources) {
             choices.push({
                 title: `${dsName}: ${oDataSources[dsName].uri}`,
                 value: oDataSources[dsName].uri,
-                description: oDataSources[dsName].settings?.odataVersion || undefined
+                description: oDataSources[dsName].settings?.odataVersion ?? undefined
             });
         }
         if (choices.length > 0) {
-            question.type = 'select';
-            question.choices = choices;
-            question.initial = choices.findIndex((c) => c.value === mainDataSourceUri);
+            questionPath.type = 'select';
+            questionPath.choices = choices;
+            questionPath.initial = choices.findIndex((c) => c.value === mainDataSourceUri);
         }
     }
-    question.type ||= 'text';
-    return [question];
+    questionPath.type ||= 'text';
+    prompts.push(questionPath);
+    if (params?.askForOverwrite) {
+        const questionOverwrite = {
+            type: 'confirm',
+            name: 'overwrite',
+            message: (0, __1.t)('questions.overwrite')
+        };
+        prompts.push(questionOverwrite);
+    }
+    return prompts;
 }
 //# sourceMappingURL=index.js.map

package/dist/translations/mockserver-config-writer.i18n.json

@@ -1,5 +1,6 @@
 {
     "questions": {
-        "pathToMock": "Path to mocked service"
+        "pathToMock": "Path to mocked service",
+        "overwrite": "Overwrite services"
     }
 }

package/dist/types/index.d.ts

@@ -9,6 +9,6 @@ export interface PackageJsonMockConfig {
     mockserverVersion?: string;
 }
 export interface Ui5MockYamlConfig {
-    path?: string;
+    overwrite?: boolean;
 }
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/mockserver-config-writer",
   "description": "Add or update configuration for SAP Fiori tools mockserver",
-  "version": "0.6.7",
+  "version": "0.7.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -22,14 +22,14 @@
     "i18next": "20.6.1",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
-    "@sap-ux/ui5-config": "0.25.2"
+    "@sap-ux/ui5-config": "0.26.0"
   },
   "devDependencies": {
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
     "@types/prompts": "2.4.4",
     "prompts": "2.4.2",
-    "@sap-ux/project-access": "1.28.7"
+    "@sap-ux/project-access": "1.28.8"
   },
   "engines": {
     "node": ">=18.x"