@sap-ux/mockserver-config-writer 0.0.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,33 @@
+# @sap-ux/mockserver-config-writer
+
+Adds or removes configuration for mockserver module `@sap-ux/ui5-middleware-fe-mockserver` to SAP UX project.
+
+## Installation
+Npm
+`npm install --save @sap-ux/mockserver-config-writer`
+
+Yarn
+`yarn add @sap-ux/mockserver-config-writer`
+
+Pnpm
+`pnpm add @sap-ux/mockserver-config-writer`
+
+## Usage
+```Typescript
+import { generateMockserverConfig } from '@sap-ux/mockserver-config-writer';
+import { join } from 'path';
+
+const basePath = join(__dirname, 'test/fixtures/bare-minimum');
+const fs = await generateMockserverConfig(
+    basePath,
+    {
+        webappPath: join(basePath, 'webapp'),
+});
+
+fs.commit();
+```
+
+See more complex example in [`/test/unit`](./test/unit)
+## Keywords
+SAP Fiori elements
+SAP Fiori - UI5 middleware for the Fiori elements mock server

package/dist/app-info.d.ts

@@ -0,0 +1,18 @@
+import type { Manifest, ManifestNamespace } from '@sap-ux/project-access';
+/**
+ * Get the main service data source entry from manifest.json.
+ *
+ * @param manifest - Parsed manifest.json
+ * @returns - data source entry from manifest.json, parsed
+ */
+export declare function getMainServiceDataSource(manifest: Manifest): ManifestNamespace.DataSource | undefined;
+/**
+ * Get the data sources of type 'OData' from manifest.
+ *
+ * @param manifest - the parsed manifest.json
+ * @returns data sources of type 'OData'
+ */
+export declare function getODataSources(manifest: Manifest): {
+    [k: string]: ManifestNamespace.DataSource;
+};
+//# sourceMappingURL=app-info.d.ts.map

package/dist/app-info.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getODataSources = exports.getMainServiceDataSource = void 0;
+/**
+ * Get the main service data source entry from manifest.json.
+ *
+ * @param manifest - Parsed manifest.json
+ * @returns - data source entry from manifest.json, parsed
+ */
+function getMainServiceDataSource(manifest) {
+    var _a, _b;
+    let dataSource;
+    const model = ((_a = manifest['sap.ovp']) === null || _a === void 0 ? void 0 : _a.globalFilterModel) || '';
+    const dataSourceName = manifest['sap.ui5'] && manifest['sap.ui5'].models && manifest['sap.ui5'].models[model]
+        ? manifest['sap.ui5'].models[model].dataSource
+        : undefined;
+    if (dataSourceName) {
+        dataSource = (_b = manifest['sap.app'].dataSources) === null || _b === void 0 ? void 0 : _b[dataSourceName];
+    }
+    return dataSource;
+}
+exports.getMainServiceDataSource = getMainServiceDataSource;
+/**
+ * Get the data sources of type 'OData' from manifest.
+ *
+ * @param manifest - the parsed manifest.json
+ * @returns data sources of type 'OData'
+ */
+function getODataSources(manifest) {
+    var _a;
+    const result = {};
+    const dataSources = ((_a = manifest['sap.app']) === null || _a === void 0 ? void 0 : _a.dataSources) || {};
+    for (const dataSource in dataSources) {
+        if (dataSources[dataSource].uri && dataSources[dataSource].type === 'OData') {
+            result[dataSource] = dataSources[dataSource];
+        }
+    }
+    return result;
+}
+exports.getODataSources = getODataSources;
+//# sourceMappingURL=app-info.js.map

package/dist/i18n.d.ts

@@ -0,0 +1,14 @@
+import type { TOptions } from 'i18next';
+/**
+ * Initialize i18next with the translations for this module.
+ */
+export declare function initI18n(): Promise<void>;
+/**
+ * Helper function facading the call to i18next.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+export declare function t(key: string, options?: TOptions): string;
+//# sourceMappingURL=i18n.d.ts.map

package/dist/i18n.js

@@ -0,0 +1,50 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.t = exports.initI18n = void 0;
+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';
+/**
+ * Initialize i18next with the translations for this module.
+ */
+function initI18n() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield i18next_1.default.init({
+            resources: {
+                en: {
+                    [NS]: mockserver_config_writer_i18n_json_1.default
+                }
+            },
+            lng: 'en',
+            fallbackLng: 'en',
+            defaultNS: NS,
+            ns: [NS]
+        });
+    });
+}
+exports.initI18n = initI18n;
+/**
+ * Helper function facading the call to i18next.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+function t(key, options) {
+    return i18next_1.default.t(key, options);
+}
+exports.t = t;
+initI18n();
+//# sourceMappingURL=i18n.js.map

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,20 @@
+import type { Editor } from 'mem-fs-editor';
+import type { MockserverConfig } from '../types';
+/**
+ *  Add mockserver configuration to a UI5 application.
+ *
+ * @param basePath - the base path where the package.json and ui5.yaml is
+ * @param data - configuration of the mockserver
+ * @param fs - the memfs editor instance
+ * @returns Promise<Editor> - memfs editor instance with updated files
+ */
+export declare function generateMockserverConfig(basePath: string, data: MockserverConfig, fs?: Editor): Promise<Editor>;
+/**
+ * Remove mockserver configuration.
+ *
+ * @param basePath - the base path where the package.json and ui5.yaml is
+ * @param fs - the memfs editor instance
+ * @returns Promise<Editor> - memfs editor instance with updated files
+ */
+export declare function removeMockserverConfig(basePath: string, fs?: Editor): Editor;
+//# sourceMappingURL=index.d.ts.map

package/dist/mockserver-config/index.js

@@ -0,0 +1,52 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeMockserverConfig = exports.generateMockserverConfig = void 0;
+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");
+/**
+ *  Add mockserver configuration to a UI5 application.
+ *
+ * @param basePath - the base path where the package.json and ui5.yaml is
+ * @param data - configuration of the mockserver
+ * @param fs - the memfs editor instance
+ * @returns Promise<Editor> - memfs editor instance with updated files
+ */
+function generateMockserverConfig(basePath, data, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!fs) {
+            fs = mem_fs_editor_1.create(mem_fs_1.create());
+        }
+        package_json_1.enhancePackageJson(fs, basePath, data.packageJsonConfig);
+        yield ui5_mock_yaml_1.enhanceYaml(fs, basePath, data.webappPath, data.ui5MockYamlConfig);
+        return fs;
+    });
+}
+exports.generateMockserverConfig = generateMockserverConfig;
+/**
+ * Remove mockserver configuration.
+ *
+ * @param basePath - the base path where the package.json and ui5.yaml is
+ * @param fs - the memfs editor instance
+ * @returns Promise<Editor> - memfs editor instance with updated files
+ */
+function removeMockserverConfig(basePath, fs) {
+    if (!fs) {
+        fs = mem_fs_editor_1.create(mem_fs_1.create());
+    }
+    package_json_1.removeFromPackageJson(fs, basePath);
+    ui5_mock_yaml_1.removeUi5MockYaml(fs, basePath);
+    return fs;
+}
+exports.removeMockserverConfig = removeMockserverConfig;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,18 @@
+import type { Editor } from 'mem-fs-editor';
+import type { PackageJsonMockConfig } from '../types';
+/**
+ * Enhance the package.json with dependency for mockserver.
+ *
+ * @param fs - mem-fs reference to be used for file access
+ * @param basePath - path to application root, where package.json is
+ * @param config - optional config for mockserver
+ */
+export declare function enhancePackageJson(fs: Editor, basePath: string, config?: PackageJsonMockConfig): void;
+/**
+ * Remove mockserver script and dependencies from package.json.
+ *
+ * @param fs - mem-fs reference to be used for file access
+ * @param basePath - path to application root, where package.json is
+ */
+export declare function removeFromPackageJson(fs: Editor, basePath: string): void;
+//# sourceMappingURL=package-json.d.ts.map

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

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeFromPackageJson = exports.enhancePackageJson = void 0;
+const path_1 = require("path");
+/**
+ * Enhance the package.json with dependency for mockserver.
+ *
+ * @param fs - mem-fs reference to be used for file access
+ * @param basePath - path to application root, where package.json is
+ * @param config - optional config for mockserver
+ */
+function enhancePackageJson(fs, basePath, config) {
+    const packageJsonPath = path_1.join(basePath, 'package.json');
+    const packageJson = fs.readJSON(packageJsonPath);
+    enhanceDependencies(packageJson, config === null || config === void 0 ? void 0 : config.mockserverModule, config === null || config === void 0 ? void 0 : config.mockserverVersion);
+    enhanceScripts(fs, packageJson);
+    fs.writeJSON(packageJsonPath, packageJson);
+}
+exports.enhancePackageJson = enhancePackageJson;
+/**
+ * Add mockserver dependencies to package.json content.
+ * Takes also care of removing deprecated old module.
+ *
+ * @param packageJson - parsed package.json content
+ * @param mockserverModule - npm name of the mockserver module
+ * @param version - npm version string
+ */
+function enhanceDependencies(packageJson, mockserverModule = '@sap-ux/ui5-middleware-fe-mockserver', version = '2') {
+    var _a;
+    packageJson.devDependencies = packageJson.devDependencies || {};
+    delete packageJson.devDependencies['@sap/ux-ui5-fe-mockserver-middleware'];
+    packageJson.devDependencies[mockserverModule] = version;
+    packageJson.ui5 || (packageJson.ui5 = {});
+    (_a = packageJson.ui5).dependencies || (_a.dependencies = []);
+    const ui5Dependencies = packageJson.ui5.dependencies.filter((dep) => dep !== '@sap/ux-ui5-fe-mockserver-middleware');
+    if (!ui5Dependencies.includes(mockserverModule)) {
+        ui5Dependencies.push(mockserverModule);
+    }
+    packageJson.ui5.dependencies = ui5Dependencies;
+}
+/**
+ * Add or update start-mock script to package.json.
+ *
+ * @param fs - mem-fs reference to be used for file access
+ * @param packageJson - path to package.json
+ */
+function enhanceScripts(fs, packageJson) {
+    packageJson.scripts || (packageJson.scripts = {});
+    packageJson.scripts['start-mock'] =
+        copyStartScript(packageJson.scripts.start) || `fiori run --config ./ui5-mock.yaml --open \"/\"`;
+}
+/**
+ * Return a copy of package.json's 'start' script with added or replaced config pointing to ui5-mock.yaml.
+ * In case start script can't be copied or is undefined, return undefined.
+ *
+ * @param startScript - start script from package.json
+ * @returns - copy of start script with config to ui5.yaml, undefined if start script can't be copied
+ */
+function copyStartScript(startScript) {
+    if (typeof startScript !== 'string') {
+        return undefined;
+    }
+    const fioriRun = 'fiori run';
+    const fioriRunIndex = startScript.indexOf(fioriRun);
+    if (fioriRunIndex < 0) {
+        return undefined;
+    }
+    const configStartIndex = startScript.indexOf('--config', fioriRunIndex);
+    const startMockScript = configStartIndex < 0
+        ? startScript.replace(fioriRun, `${fioriRun} --config ./ui5-mock.yaml`)
+        : replaceConfig(startScript, configStartIndex);
+    return startMockScript;
+}
+/**
+ * Replace the --config <any/path> in script with --config ./ui5-mock.yaml and return as new string.
+ *
+ * @param startScript - script that contains --config path/to/any.yaml
+ * @param configStartIndex - index in string where --config starts (first after fiori run)
+ * @returns - new script string with replaced --config
+ */
+function replaceConfig(startScript, configStartIndex) {
+    const argStart = configStartIndex + '--config'.length + 1;
+    const yamlStart = startScript.slice(argStart).search(/[^\s]/) + argStart;
+    let separator = ' ';
+    let quotischSepOffset = 0;
+    if (startScript[yamlStart] === '"' || startScript[yamlStart] === "'") {
+        separator = startScript[yamlStart];
+        quotischSepOffset = 1;
+    }
+    let yamlEnd = startScript.indexOf(separator, yamlStart + quotischSepOffset);
+    yamlEnd = yamlEnd === -1 ? startScript.length : yamlEnd + quotischSepOffset;
+    const startMockScript = `${startScript.substring(0, argStart)}./ui5-mock.yaml${startScript.substring(yamlEnd)}`;
+    return startMockScript;
+}
+/**
+ * Remove mockserver script and dependencies from package.json.
+ *
+ * @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) {
+    var _a, _b, _c, _d;
+    const packageJsonPath = path_1.join(basePath, 'package.json');
+    const packageJson = fs.readJSON(packageJsonPath);
+    (_a = packageJson.scripts) === null || _a === void 0 ? true : delete _a['start-mock'];
+    if (packageJson.scripts && Object.keys(packageJson.scripts).length === 0) {
+        delete packageJson.scripts;
+    }
+    (_b = packageJson.devDependencies) === null || _b === void 0 ? true : delete _b['@sap/ux-ui5-fe-mockserver-middleware'];
+    (_c = packageJson.devDependencies) === null || _c === void 0 ? true : delete _c['@sap-ux/ui5-middleware-fe-mockserver'];
+    if (packageJson.devDependencies && Object.keys(packageJson.devDependencies).length === 0) {
+        delete packageJson.devDependencies;
+    }
+    if (((_d = packageJson.ui5) === null || _d === void 0 ? void 0 : _d.dependencies) && Array.isArray(packageJson.ui5.dependencies)) {
+        packageJson.ui5.dependencies = packageJson.ui5.dependencies.filter((d) => d !== '@sap/ux-ui5-fe-mockserver-middleware' && d !== '@sap-ux/ui5-middleware-fe-mockserver');
+        if (packageJson.ui5.dependencies.length === 0) {
+            delete packageJson.ui5.dependencies;
+        }
+    }
+    if (packageJson.ui5 && Object.keys(packageJson.ui5).length === 0) {
+        delete packageJson.ui5;
+    }
+    fs.writeJSON(packageJsonPath, packageJson);
+}
+exports.removeFromPackageJson = removeFromPackageJson;
+//# sourceMappingURL=package-json.js.map

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

@@ -0,0 +1,31 @@
+import type { Editor } from 'mem-fs-editor';
+import type { Ui5MockYamlConfig } from '../types';
+/**
+ * Enhance or create the ui5-mock.yaml with mockserver config.
+ * Following enhancement strategy is applied:
+ *
+ * ui5-mock.yaml exists
+ * -----------------------------
+ * Update or create middleware configuration for 'sap-fe-mockserver' with the latest configuration.
+ * Other parts of the ui5-mock.yaml will not be modified.
+ *
+ * ui5-mock.yaml does not exist
+ * -----------------------------
+ * If ui5.yaml exists, copy it and add/update the 'sap-fe-mockserver' middleware configuration.
+ * If ui5.yaml does not exist, create a new ui5-mock.yaml file with 'sap-fe-mockserver' middleware
+ * configuration and basic default configuration for 'fiori-tools-proxy' and 'fiori-tools-appreload'.
+ *
+ * @param fs - mem-fs reference to be used for file access
+ * @param basePath - path to project root, where package.json and ui5.yaml is
+ * @param webappPath - path to webapp folder, where manifest.json is
+ * @param config - optional config passed in by consumer
+ */
+export declare function enhanceYaml(fs: Editor, basePath: string, webappPath: string, config?: Ui5MockYamlConfig): Promise<void>;
+/**
+ * Delete ui5-mock.yaml file 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 removeUi5MockYaml(fs: Editor, basePath: string): void;
+//# sourceMappingURL=ui5-mock-yaml.d.ts.map

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

@@ -0,0 +1,132 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeUi5MockYaml = exports.enhanceYaml = void 0;
+const path_1 = require("path");
+const ui5_config_1 = require("@sap-ux/ui5-config");
+const app_info_1 = require("../app-info");
+/**
+ * Enhance or create the ui5-mock.yaml with mockserver config.
+ * Following enhancement strategy is applied:
+ *
+ * ui5-mock.yaml exists
+ * -----------------------------
+ * Update or create middleware configuration for 'sap-fe-mockserver' with the latest configuration.
+ * Other parts of the ui5-mock.yaml will not be modified.
+ *
+ * ui5-mock.yaml does not exist
+ * -----------------------------
+ * If ui5.yaml exists, copy it and add/update the 'sap-fe-mockserver' middleware configuration.
+ * If ui5.yaml does not exist, create a new ui5-mock.yaml file with 'sap-fe-mockserver' middleware
+ * configuration and basic default configuration for 'fiori-tools-proxy' and 'fiori-tools-appreload'.
+ *
+ * @param fs - mem-fs reference to be used for file access
+ * @param basePath - path to project root, where package.json and ui5.yaml is
+ * @param webappPath - path to webapp folder, where manifest.json is
+ * @param config - optional config passed in by consumer
+ */
+function enhanceYaml(fs, basePath, webappPath, config) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        const ui5MockYamlPath = path_1.join(basePath, 'ui5-mock.yaml');
+        let mockConfig;
+        const manifest = fs.readJSON(path_1.join(webappPath, 'manifest.json'));
+        const mockserverPath = (config === null || config === void 0 ? void 0 : config.path) || ((_a = app_info_1.getMainServiceDataSource(manifest)) === null || _a === void 0 ? void 0 : _a.uri);
+        if (fs.exists(ui5MockYamlPath)) {
+            mockConfig = yield updateUi5MockYamlConfig(fs, ui5MockYamlPath, mockserverPath);
+        }
+        else {
+            mockConfig = fs.exists(path_1.join(basePath, 'ui5.yaml'))
+                ? yield generateUi5MockYamlBasedOnUi5Yaml(fs, basePath, mockserverPath)
+                : yield generateNewUi5MockYamlConfig(((_b = manifest['sap.app']) === null || _b === void 0 ? void 0 : _b.id) || '', mockserverPath);
+        }
+        const yaml = mockConfig.toString();
+        fs.write(ui5MockYamlPath, yaml);
+    });
+}
+exports.enhanceYaml = enhanceYaml;
+/**
+ * Update existing ui5-mock.yaml config. This will add or replace existing middleware configuration
+ * '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
+ */
+function updateUi5MockYamlConfig(fs, ui5MockYamlPath, path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const existingUi5MockYamlConfig = yield ui5_config_1.UI5Config.newInstance(fs.read(ui5MockYamlPath));
+        existingUi5MockYamlConfig.updateCustomMiddleware(yield getNewMockserverMiddleware(path));
+        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
+ */
+function generateUi5MockYamlBasedOnUi5Yaml(fs, basePath, path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const ui5MockYamlConfig = yield ui5_config_1.UI5Config.newInstance(fs.read(path_1.join(basePath, 'ui5.yaml')));
+        ui5MockYamlConfig.updateCustomMiddleware(yield getNewMockserverMiddleware(path));
+        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
+ */
+function generateNewUi5MockYamlConfig(appId, path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const ui5MockYaml = yield 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);
+        return ui5MockYaml;
+    });
+}
+/**
+ * Return new mockserver middleware.
+ *
+ * @param [path] - optional path for mockserver config
+ * @returns - mockserver middleware
+ */
+function getNewMockserverMiddleware(path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const ui5MockYaml = yield ui5_config_1.UI5Config.newInstance('');
+        ui5MockYaml.addMockServerMiddleware(path);
+        const mockserverMiddleware = ui5MockYaml.findCustomMiddleware('sap-fe-mockserver');
+        if (!mockserverMiddleware) {
+            throw Error('Could not create new mockserver config');
+        }
+        return mockserverMiddleware;
+    });
+}
+/**
+ * Delete ui5-mock.yaml file 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
+ */
+function removeUi5MockYaml(fs, basePath) {
+    const ui5MockYamlPath = path_1.join(basePath, 'ui5-mock.yaml');
+    if (fs.exists(ui5MockYamlPath)) {
+        fs.delete(ui5MockYamlPath);
+    }
+}
+exports.removeUi5MockYaml = removeUi5MockYaml;
+//# sourceMappingURL=ui5-mock-yaml.js.map

package/dist/prompt/index.d.ts

@@ -0,0 +1,15 @@
+import type { Editor } from 'mem-fs-editor';
+import type { PromptObject } from 'prompts';
+/**
+ * Return the list of questions to configure mockserver.
+ *
+ * @param params - optional parameters used to fill default values
+ * @param params.webappPath - optional path to webapp folder, where manifest is
+ * @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;
+    fs?: Editor;
+}): PromptObject[];
+//# sourceMappingURL=index.d.ts.map

package/dist/prompt/index.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMockserverConfigQuestions = void 0;
+const path_1 = require("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("..");
+/**
+ * Return the list of questions to configure mockserver.
+ *
+ * @param params - optional parameters used to fill default values
+ * @param params.webappPath - optional path to webapp folder, where manifest is
+ * @param params.fs - optional memfs editor instance
+ * @returns - array of questions that serves as input for prompt module
+ */
+function getMockserverConfigQuestions(params) {
+    var _a, _b;
+    const question = {
+        name: 'path',
+        message: __1.t('questions.pathToMock')
+    };
+    if (params === null || params === void 0 ? void 0 : params.webappPath) {
+        const fs = params.fs || mem_fs_editor_1.create(mem_fs_1.create());
+        const manifest = JSON.parse(fs.read(path_1.join(params.webappPath, 'manifest.json')));
+        const mainDataSourceUri = ((_a = app_info_1.getMainServiceDataSource(manifest)) === null || _a === void 0 ? void 0 : _a.uri) || '';
+        const oDataSources = app_info_1.getODataSources(manifest);
+        const choices = [];
+        for (const dsName in oDataSources) {
+            choices.push({
+                title: `${dsName}: ${oDataSources[dsName].uri}`,
+                value: oDataSources[dsName].uri,
+                description: ((_b = oDataSources[dsName].settings) === null || _b === void 0 ? void 0 : _b.odataVersion) || undefined
+            });
+        }
+        if (choices.length > 0) {
+            question.type = 'select';
+            question.choices = choices;
+            question.initial = choices.findIndex((c) => c.value === mainDataSourceUri);
+        }
+    }
+    question.type || (question.type = 'text');
+    return [question];
+}
+exports.getMockserverConfigQuestions = getMockserverConfigQuestions;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,5 @@
+{
+    "questions": {
+        "pathToMock": "Path to mocked service"
+    }
+}

package/dist/types/index.d.ts

@@ -0,0 +1,14 @@
+export interface MockserverConfig {
+    webappPath: string;
+    packageJsonConfig?: PackageJsonMockConfig;
+    ui5MockYamlConfig?: Ui5MockYamlConfig;
+}
+export interface PackageJsonMockConfig {
+    script?: string;
+    mockserverModule?: string;
+    mockserverVersion?: string;
+}
+export interface Ui5MockYamlConfig {
+    path?: string;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.js

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

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@sap-ux/mockserver-config-writer",
+  "description": "Add or update configuration for SAP Fiori tools mockserver",
+  "version": "0.0.2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/mockserver-config-writer"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Amockserver-config-writer"
+  },
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "files": [
+    "LICENSE",
+    "dist",
+    "!dist/*.map",
+    "!dist/**/*.map"
+  ],
+  "dependencies": {
+    "@sap-ux/ui5-config": "0.16.1",
+    "i18next": "20.3.2",
+    "mem-fs": "2.1.0",
+    "mem-fs-editor": "9.4.0"
+  },
+  "devDependencies": {
+    "@sap-ux/project-access": "1.0.4",
+    "@types/mem-fs": "1.1.2",
+    "@types/mem-fs-editor": "7.0.1",
+    "@types/prompts": "2.0.14",
+    "prompts": "2.4.2"
+  },
+  "engines": {
+    "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",
+    "node": ">= 14.16.0 < 15.0.0 || >=16.1.0 < 17.0.0 || >=18.0.0 < 19.0.0"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rimraf dist coverage *.tsbuildinfo",
+    "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors",
+    "watch": "tsc --watch"
+  }
+}