@sap-ux/mockserver-config-writer 0.10.2 → 1.0.0

package/dist/app-info.js

@@ -1,7 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMainServiceDataSource = getMainServiceDataSource;
-exports.getODataSources = getODataSources;
 /**
  * Get the main service data source name from manifest.json.
  *
@@ -18,7 +14,7 @@ function getMainServiceDataSourceName(manifest) {
  * @param manifest - Parsed manifest.json
  * @returns - data source entry from manifest.json, parsed
  */
-function getMainServiceDataSource(manifest) {
+export function getMainServiceDataSource(manifest) {
     let dataSource;
     const dataSourceName = getMainServiceDataSourceName(manifest);
     if (dataSourceName) {
@@ -33,7 +29,7 @@ function getMainServiceDataSource(manifest) {
  * @param dataSourceType - optional to specify the type of OData sources to filter
  * @returns data sources of type 'OData'
  */
-function getODataSources(manifest, dataSourceType = 'OData') {
+export function getODataSources(manifest, dataSourceType = 'OData') {
     const result = {};
     const dataSources = manifest['sap.app']?.dataSources ?? {};
     for (const dataSource in dataSources) {

package/dist/i18n.js

@@ -1,22 +1,15 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-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"));
+import i18next from 'i18next';
+import translations from './translations/mockserver-config-writer.i18n.json' with { type: 'json' };
 const NS = 'mockserver-config-writer';
 let i18nInstance;
 /**
  * Initialize i18next with the translations for this module.
  */
-async function initI18n() {
-    i18nInstance = i18next_1.default.createInstance({
+export async function initI18n() {
+    i18nInstance = i18next.createInstance({
         resources: {
             en: {
-                [NS]: mockserver_config_writer_i18n_json_1.default
+                [NS]: translations
             }
         },
         lng: 'en',
@@ -34,7 +27,7 @@ async function initI18n() {
  * @param options additional options
  * @returns {string} localized string stored for the given key
  */
-function t(key, options) {
+export function t(key, options) {
     return i18nInstance.t(key, options);
 }
 initI18n().catch(() => {

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export { generateMockserverConfig, removeMockserverConfig } from './mockserver-config';
-export { getMockserverConfigQuestions } from './prompt';
-export { t } from './i18n';
-export * from './types';
+export { generateMockserverConfig, removeMockserverConfig } from './mockserver-config/index.js';
+export { getMockserverConfigQuestions } from './prompt/index.js';
+export { t } from './i18n.js';
+export * from './types/index.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,26 +1,5 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-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.t = exports.getMockserverConfigQuestions = exports.removeMockserverConfig = exports.generateMockserverConfig = void 0;
-var mockserver_config_1 = require("./mockserver-config");
-Object.defineProperty(exports, "generateMockserverConfig", { enumerable: true, get: function () { return mockserver_config_1.generateMockserverConfig; } });
-Object.defineProperty(exports, "removeMockserverConfig", { enumerable: true, get: function () { return mockserver_config_1.removeMockserverConfig; } });
-var prompt_1 = require("./prompt");
-Object.defineProperty(exports, "getMockserverConfigQuestions", { enumerable: true, get: function () { return prompt_1.getMockserverConfigQuestions; } });
-var i18n_1 = require("./i18n");
-Object.defineProperty(exports, "t", { enumerable: true, get: function () { return i18n_1.t; } });
-__exportStar(require("./types"), exports);
+export { generateMockserverConfig, removeMockserverConfig } from './mockserver-config/index.js';
+export { getMockserverConfigQuestions } from './prompt/index.js';
+export { t } from './i18n.js';
+export * from './types/index.js';
 //# sourceMappingURL=index.js.map

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

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import type { MockserverConfig } from '../types';
+import type { MockserverConfig } from '../types/index.js';
 /**
  *  Add mockserver configuration to a UI5 application.
  *

package/dist/mockserver-config/index.js

@@ -1,11 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateMockserverConfig = generateMockserverConfig;
-exports.removeMockserverConfig = removeMockserverConfig;
-const mem_fs_1 = require("mem-fs");
-const mem_fs_editor_1 = require("mem-fs-editor");
-const package_json_1 = require("./package-json");
-const ui5_mock_yaml_1 = require("./ui5-mock-yaml");
+import { create as createStorage } from 'mem-fs';
+import { create } from 'mem-fs-editor';
+import { enhancePackageJson, removeFromPackageJson } from './package-json.js';
+import { enhanceYaml, removeMockDataFolders, removeUi5MockYaml } from './ui5-mock-yaml.js';
 /**
  *  Add mockserver configuration to a UI5 application.
  *
@@ -14,14 +10,14 @@ const ui5_mock_yaml_1 = require("./ui5-mock-yaml");
  * @param fs - the memfs editor instance
  * @returns Promise<Editor> - memfs editor instance with updated files
  */
-async function generateMockserverConfig(basePath, data, fs) {
+export async function generateMockserverConfig(basePath, data, fs) {
     if (!fs) {
-        fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+        fs = create(createStorage());
     }
     if (!data.packageJsonConfig?.skip) {
-        (0, package_json_1.enhancePackageJson)(fs, basePath, data.packageJsonConfig);
+        enhancePackageJson(fs, basePath, data.packageJsonConfig);
     }
-    await (0, ui5_mock_yaml_1.enhanceYaml)(fs, basePath, data.webappPath, data.ui5MockYamlConfig);
+    await enhanceYaml(fs, basePath, data.webappPath, data.ui5MockYamlConfig);
     return fs;
 }
 /**
@@ -31,13 +27,13 @@ async function generateMockserverConfig(basePath, data, fs) {
  * @param fs - the memfs editor instance
  * @returns Promise<Editor> - memfs editor instance with updated files
  */
-async function removeMockserverConfig(basePath, fs) {
+export async function removeMockserverConfig(basePath, fs) {
     if (!fs) {
-        fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+        fs = create(createStorage());
     }
-    (0, package_json_1.removeFromPackageJson)(fs, basePath);
-    (0, ui5_mock_yaml_1.removeUi5MockYaml)(fs, basePath);
-    await (0, ui5_mock_yaml_1.removeMockDataFolders)(fs, basePath);
+    removeFromPackageJson(fs, basePath);
+    removeUi5MockYaml(fs, basePath);
+    await removeMockDataFolders(fs, basePath);
     return fs;
 }
 //# sourceMappingURL=index.js.map

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

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import type { PackageJsonMockConfig } from '../types';
+import type { PackageJsonMockConfig } from '../types/index.js';
 /**
  * Enhance the package.json with dependency for mockserver.
  *

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

@@ -1,8 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.enhancePackageJson = enhancePackageJson;
-exports.removeFromPackageJson = removeFromPackageJson;
-const node_path_1 = require("node:path");
+import { join } from 'node:path';
 /**
  * Enhance the package.json with dependency for mockserver.
  *
@@ -10,8 +6,8 @@ const node_path_1 = require("node:path");
  * @param basePath - path to application root, where package.json is
  * @param config - optional config for mockserver
  */
-function enhancePackageJson(fs, basePath, config) {
-    const packageJsonPath = (0, node_path_1.join)(basePath, 'package.json');
+export function enhancePackageJson(fs, basePath, config) {
+    const packageJsonPath = join(basePath, 'package.json');
     const packageJson = fs.readJSON(packageJsonPath);
     enhanceDependencies(packageJson, config?.mockserverModule, config?.mockserverVersion);
     enhanceScripts(fs, packageJson);
@@ -142,8 +138,8 @@ function removeMockserverUi5Dependencies(packageJson) {
  * @param fs - mem-fs reference to be used for file access
  * @param basePath - path to application root, where package.json is
  */
-function removeFromPackageJson(fs, basePath) {
-    const packageJsonPath = (0, node_path_1.join)(basePath, 'package.json');
+export function removeFromPackageJson(fs, basePath) {
+    const packageJsonPath = join(basePath, 'package.json');
     const packageJson = fs.readJSON(packageJsonPath);
     delete packageJson.scripts?.['start-mock'];
     if (packageJson.scripts && Object.keys(packageJson.scripts).length === 0) {

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

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import type { Ui5MockYamlConfig } from '../types';
+import type { Ui5MockYamlConfig } from '../types/index.js';
 /**
  * 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.

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

@@ -1,12 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.enhanceYaml = enhanceYaml;
-exports.removeMockDataFolders = removeMockDataFolders;
-exports.removeUi5MockYaml = removeUi5MockYaml;
-const node_path_1 = require("node: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");
+import { join, posix, relative, sep } from 'node:path';
+import { UI5Config } from '@sap-ux/ui5-config';
+import { DirName, FileName, getWebappPath, readUi5Yaml } from '@sap-ux/project-access';
+import { getODataSources } from '../app-info.js';
 /**
  * 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.
@@ -29,13 +24,13 @@ const app_info_1 = require("../app-info");
  * @param webappPath - path to webapp folder, where manifest.json is
  * @param config - optional config passed in by consumer
  */
-async function enhanceYaml(fs, basePath, webappPath, config) {
+export async function enhanceYaml(fs, basePath, webappPath, config) {
     const overwrite = !!config?.overwrite;
-    const ui5MockYamlPath = (0, node_path_1.join)(basePath, 'ui5-mock.yaml');
+    const ui5MockYamlPath = join(basePath, 'ui5-mock.yaml');
     let mockConfig;
-    const manifest = fs.readJSON((0, node_path_1.join)(webappPath, 'manifest.json'));
+    const manifest = fs.readJSON(join(webappPath, 'manifest.json'));
     // Prepare annotations list to be used in mockserver middleware config annotations
-    const annotationSource = Object.values((0, app_info_1.getODataSources)(manifest, 'ODataAnnotation'));
+    const annotationSource = Object.values(getODataSources(manifest, 'ODataAnnotation'));
     const annotationsConfig = [];
     annotationSource.forEach((annotation) => {
         // Ignore local annotations from YAML file, those are linked through manifest file
@@ -43,14 +38,14 @@ async function enhanceYaml(fs, basePath, webappPath, config) {
             const localUri = annotation.settings?.localUri;
             annotationsConfig.push({
                 localPath: localUri
-                    ? `.${node_path_1.posix.sep}${(0, node_path_1.relative)(basePath, (0, node_path_1.join)(webappPath, localUri)).replaceAll(node_path_1.sep, node_path_1.posix.sep)}`
+                    ? `.${posix.sep}${relative(basePath, join(webappPath, localUri)).replaceAll(sep, posix.sep)}`
                     : undefined,
                 urlPath: annotation.uri
             });
         }
     });
     // Prepare dataSources list to be used in mockserver middleware config services
-    const dataSources = (0, app_info_1.getODataSources)(manifest);
+    const dataSources = getODataSources(manifest);
     const dataSourcesConfig = [];
     for (const dataSource in dataSources) {
         const localUri = dataSources[dataSource].settings?.localUri;
@@ -59,7 +54,7 @@ async function enhanceYaml(fs, basePath, webappPath, config) {
             serviceName: dataSource,
             servicePath: dataSources[dataSource].uri,
             metadataPath: localUri
-                ? `.${node_path_1.posix.sep}${(0, node_path_1.relative)(basePath, (0, node_path_1.join)(webappPath, localUri)).replaceAll(node_path_1.sep, node_path_1.posix.sep)}`
+                ? `.${posix.sep}${relative(basePath, join(webappPath, localUri)).replaceAll(sep, posix.sep)}`
                 : undefined,
             resolveExternalServiceReferences
         });
@@ -68,7 +63,7 @@ async function enhanceYaml(fs, basePath, webappPath, config) {
         mockConfig = await updateUi5MockYamlConfig(fs, basePath, webappPath, ui5MockYamlPath, dataSourcesConfig, annotationsConfig, overwrite);
     }
     else {
-        mockConfig = fs.exists((0, node_path_1.join)(basePath, 'ui5.yaml'))
+        mockConfig = fs.exists(join(basePath, 'ui5.yaml'))
             ? await generateUi5MockYamlBasedOnUi5Yaml(fs, basePath, webappPath, dataSourcesConfig, annotationsConfig)
             : await generateNewUi5MockYamlConfig(manifest['sap.app']?.id || '', basePath, webappPath, dataSourcesConfig, annotationsConfig);
     }
@@ -81,16 +76,16 @@ async function enhanceYaml(fs, basePath, webappPath, config) {
  * @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, node_path_1.join)(webappPath, project_access_1.FileName.Manifest);
+export async function removeMockDataFolders(fs, basePath) {
+    const webappPath = await getWebappPath(basePath, fs);
+    const manifestPath = join(webappPath, 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, node_path_1.join)(webappPath, project_access_1.DirName.LocalService, serviceName, project_access_1.DirName.Data);
+            const mockdataPath = join(webappPath, DirName.LocalService, serviceName, DirName.Data);
             if (mockdataPath) {
                 fs.delete(mockdataPath);
             }
@@ -112,7 +107,7 @@ async function removeMockDataFolders(fs, basePath) {
  * @returns {*}  {Promise<UI5Config>} - Updated Yaml Doc
  */
 async function updateUi5MockYamlConfig(fs, basePath, webappPath, ui5MockYamlPath, dataSourcesConfig, annotationsConfig, overwrite = false) {
-    const existingUi5MockYamlConfig = await ui5_config_1.UI5Config.newInstance(fs.read(ui5MockYamlPath));
+    const existingUi5MockYamlConfig = await UI5Config.newInstance(fs.read(ui5MockYamlPath));
     if (overwrite) {
         const newMockserverMiddleware = await getNewMockserverMiddleware(basePath, webappPath, dataSourcesConfig, annotationsConfig);
         existingUi5MockYamlConfig.updateCustomMiddleware(newMockserverMiddleware);
@@ -135,7 +130,7 @@ async function updateUi5MockYamlConfig(fs, basePath, webappPath, ui5MockYamlPath
  * @returns {*}  {Promise<UI5Config>} - Update Yaml Doc
  */
 async function generateUi5MockYamlBasedOnUi5Yaml(fs, basePath, webappPath, dataSourcesConfig, annotationsConfig) {
-    const ui5MockYamlConfig = await (0, project_access_1.readUi5Yaml)(basePath, project_access_1.FileName.Ui5Yaml, fs);
+    const ui5MockYamlConfig = await readUi5Yaml(basePath, FileName.Ui5Yaml, fs);
     const ui5MockServerMiddleware = await getNewMockserverMiddleware(basePath, webappPath, dataSourcesConfig, annotationsConfig);
     ui5MockYamlConfig.updateCustomMiddleware(ui5MockServerMiddleware);
     return ui5MockYamlConfig;
@@ -151,7 +146,7 @@ async function generateUi5MockYamlBasedOnUi5Yaml(fs, basePath, webappPath, dataS
  * @returns {*}  {Promise<UI5Config>} - Update Yaml Doc
  */
 async function generateNewUi5MockYamlConfig(appId, basePath, webappPath, 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"');
+    const ui5MockYaml = await 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.addFioriToolsProxyMiddleware({ ui5: {} });
@@ -169,7 +164,7 @@ async function generateNewUi5MockYamlConfig(appId, basePath, webappPath, dataSou
  * @returns - mockserver middleware
  */
 async function getNewMockserverMiddleware(basePath, webappPath, dataSourcesConfig, annotationsConfig) {
-    const ui5MockYaml = await ui5_config_1.UI5Config.newInstance('');
+    const ui5MockYaml = await UI5Config.newInstance('');
     ui5MockYaml.addMockServerMiddleware(basePath, webappPath, dataSourcesConfig, annotationsConfig);
     const mockserverMiddleware = ui5MockYaml.findCustomMiddleware('sap-fe-mockserver');
     if (!mockserverMiddleware) {
@@ -183,8 +178,8 @@ async function getNewMockserverMiddleware(basePath, webappPath, dataSourcesConfi
  * @param fs - mem-fs reference to be used for file access
  * @param basePath - path to project root, where package.json and ui5.yaml is
  */
-function removeUi5MockYaml(fs, basePath) {
-    const ui5MockYamlPath = (0, node_path_1.join)(basePath, 'ui5-mock.yaml');
+export function removeUi5MockYaml(fs, basePath) {
+    const ui5MockYamlPath = join(basePath, 'ui5-mock.yaml');
     if (fs.exists(ui5MockYamlPath)) {
         fs.delete(ui5MockYamlPath);
     }

package/dist/prompt/index.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMockserverConfigQuestions = getMockserverConfigQuestions;
-const node_path_1 = require("node:path");
-const mem_fs_1 = require("mem-fs");
-const mem_fs_editor_1 = require("mem-fs-editor");
-const app_info_1 = require("../app-info");
-const __1 = require("..");
+import { join } from 'node:path';
+import { create as createStorage } from 'mem-fs';
+import { create } from 'mem-fs-editor';
+import { getODataSources, getMainServiceDataSource } from '../app-info.js';
+import { t } from '../index.js';
 /**
  * Return the list of questions to configure mockserver.
  *
@@ -15,17 +12,17 @@ const __1 = require("..");
  * @param params.fs - optional memfs editor instance
  * @returns - array of questions that serves as input for prompt module
  */
-function getMockserverConfigQuestions(params) {
+export function getMockserverConfigQuestions(params) {
     const prompts = [];
     const questionPath = {
         name: 'path',
-        message: (0, __1.t)('questions.pathToMock')
+        message: t('questions.pathToMock')
     };
     if (params?.webappPath) {
-        const fs = params.fs ?? (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
-        const manifest = JSON.parse(fs.read((0, node_path_1.join)(params.webappPath, 'manifest.json')));
-        const mainDataSourceUri = (0, app_info_1.getMainServiceDataSource)(manifest)?.uri ?? '';
-        const oDataSources = (0, app_info_1.getODataSources)(manifest);
+        const fs = params.fs ?? create(createStorage());
+        const manifest = JSON.parse(fs.read(join(params.webappPath, 'manifest.json')));
+        const mainDataSourceUri = getMainServiceDataSource(manifest)?.uri ?? '';
+        const oDataSources = getODataSources(manifest);
         const choices = [];
         for (const dsName in oDataSources) {
             choices.push({
@@ -46,7 +43,7 @@ function getMockserverConfigQuestions(params) {
         const questionOverwrite = {
             type: 'confirm',
             name: 'overwrite',
-            message: (0, __1.t)('questions.overwrite')
+            message: t('questions.overwrite')
         };
         prompts.push(questionOverwrite);
     }

package/dist/types/index.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=index.js.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.10.2",
+  "version": "1.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -10,6 +10,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Amockserver-config-writer"
   },
+  "type": "module",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [
@@ -22,8 +23,8 @@
     "i18next": "25.10.10",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
-    "@sap-ux/project-access": "1.38.1",
-    "@sap-ux/ui5-config": "0.31.1"
+    "@sap-ux/project-access": "2.0.0",
+    "@sap-ux/ui5-config": "1.0.0"
   },
   "devDependencies": {
     "@types/mem-fs": "1.1.2",
@@ -40,7 +41,7 @@
     "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
     "lint": "eslint",
     "lint:fix": "eslint --fix",
-    "test": "jest --ci --forceExit --detectOpenHandles --colors",
+    "test": "cross-env NODE_OPTIONS='--experimental-vm-modules' jest --ci --forceExit --detectOpenHandles --colors",
     "watch": "tsc --watch"
   }
 }