@sap-ux/launch-config 0.2.0

package/dist/launch-config-crud/writer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"writer.js","sourceRoot":"","sources":["../../src/launch-config-crud/writer.ts"],"names":[],"mappings":";;;AAAA,mCAAiD;AACjD,iDAAuC;AAEvC,+CAAkD;AAGlD;;;;;;;;;GASG;AACI,KAAK,UAAU,gBAAgB,CAClC,OAA6C,EAC7C,QAAgB,EAChB,QAAkB,EAClB,UAA+B,EAAE,EACjC,EAAW;IAEX,IAAI,CAAC,EAAE,EAAE,CAAC;QACN,EAAE,GAAG,IAAA,sBAAM,EAAC,IAAA,eAAa,GAAE,CAAC,CAAC;IACjC,CAAC;IACD,MAAM,UAAU,GAAG,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACrC,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC;QAC7B,OAAO,CAAC,iBAAiB,GAAG;YACxB,OAAO,EAAE,CAAC;YACV,YAAY,EAAE,IAAI;SACrB,CAAC;IACN,CAAC;IACD,4BAA4B;IAC5B,MAAM,KAAK,GAAG,IAAA,qBAAM,EAAC,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7D,MAAM,OAAO,GAAG,IAAA,yBAAU,EAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAC9C,wBAAwB;IACxB,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;AAChC,CAAC;AAtBD,4CAsBC"}

package/dist/project-discovery/project.d.ts

@@ -0,0 +1,14 @@
+import { type FioriOptions } from '../types';
+import type { Logger } from '@sap-ux/logger';
+/**
+ * Try to find out default values for the configuration for a given project root.
+ *
+ * @param projectRoot - root of the project, where package.json is.
+ * @param options - optional options.
+ * @param options.logger - optional, the logger instance.
+ * @returns default configuration options.
+ */
+export declare function getDefaultLaunchConfigOptionsForProject(projectRoot: string, options?: {
+    logger?: Logger;
+}): Promise<FioriOptions>;
+//# sourceMappingURL=project.d.ts.map

package/dist/project-discovery/project.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../../src/project-discovery/project.ts"],"names":[],"mappings":"AAKA,OAAO,EAAa,KAAK,YAAY,EAAE,MAAM,UAAU,CAAC;AAExD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAmC7C;;;;;;;GAOG;AACH,wBAAsB,uCAAuC,CACzD,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAC9B,OAAO,CAAC,YAAY,CAAC,CA+BvB"}

package/dist/project-discovery/project.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultLaunchConfigOptionsForProject = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const project_access_1 = require("@sap-ux/project-access");
+const jsonc_parser_1 = require("jsonc-parser");
+const types_1 = require("../types");
+/**
+ * Find out starting HTML file for project using package.json.
+ *
+ * @param projectRoot - root of the project, where package.json is.
+ * @returns file to start launch configuration with.
+ */
+async function getStartFileFromPackageFile(projectRoot) {
+    const pckJsonPath = (0, path_1.join)(projectRoot, project_access_1.FileName.Package);
+    const packageJson = (0, jsonc_parser_1.parse)(await fs_1.promises.readFile(pckJsonPath, { encoding: 'utf8' }));
+    const scripts = packageJson.scripts;
+    // default html file
+    let startHtmlFile = 'test/flpSandbox.html';
+    if (scripts) {
+        // parse package.json and try to find start file for fiori run command
+        Object.entries(scripts).forEach(([key, value]) => {
+            const match = value?.match(/fiori run/);
+            if (match && key === 'start') {
+                const scriptParts = value?.split(' ');
+                // search for --open argument
+                const openIndex = scriptParts?.indexOf(types_1.Arguments.Open) !== -1
+                    ? scriptParts?.indexOf(types_1.Arguments.Open)
+                    : scriptParts.indexOf('-o');
+                if (openIndex !== undefined && openIndex !== -1 && scriptParts) {
+                    startHtmlFile = scriptParts[openIndex + 1];
+                }
+            }
+        });
+    }
+    // --open could be specified without a value
+    return (startHtmlFile ?? '').replace(/["']/g, '');
+}
+/**
+ * Try to find out default values for the configuration for a given project root.
+ *
+ * @param projectRoot - root of the project, where package.json is.
+ * @param options - optional options.
+ * @param options.logger - optional, the logger instance.
+ * @returns default configuration options.
+ */
+async function getDefaultLaunchConfigOptionsForProject(projectRoot, options) {
+    const logger = options?.logger;
+    let name = '';
+    let ui5Version = '';
+    let startFile;
+    let backendConfigs;
+    let oDataVersion; // 4.0 or 2.0
+    const visible = true;
+    try {
+        const manifestPath = (0, path_1.join)(projectRoot, project_access_1.DirName.Webapp, project_access_1.FileName.Manifest);
+        const manifestContent = (0, jsonc_parser_1.parse)(await fs_1.promises.readFile(manifestPath, { encoding: 'utf8' }));
+        oDataVersion = manifestContent['sap.app']?.dataSources?.mainService.settings?.odataVersion;
+        name = `Launch Fiori app: ${(0, path_1.basename)(projectRoot)}`;
+        ui5Version = 'latest'; // reactivate code to find ui5 version in project-access
+        startFile = await getStartFileFromPackageFile(projectRoot);
+        const ui5YamlConfig = await (0, project_access_1.readUi5Yaml)(projectRoot, project_access_1.FileName.Ui5Yaml);
+        // read backend configurations from ui5.yaml
+        backendConfigs =
+            ui5YamlConfig.findCustomMiddleware('fiori-tools-proxy')?.configuration.backend;
+    }
+    catch (error) {
+        logger?.error(`Error while getting the default configuration for project '${projectRoot}'`);
+    }
+    return {
+        name,
+        projectRoot,
+        oDataVersion,
+        ui5Version,
+        startFile,
+        backendConfigs,
+        visible
+    };
+}
+exports.getDefaultLaunchConfigOptionsForProject = getDefaultLaunchConfigOptionsForProject;
+//# sourceMappingURL=project.js.map

package/dist/project-discovery/project.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project.js","sourceRoot":"","sources":["../../src/project-discovery/project.ts"],"names":[],"mappings":";;;AAAA,2BAAoC;AACpC,+BAAsC;AAEtC,2DAAwE;AACxE,+CAAqC;AACrC,oCAAwD;AAIxD;;;;;GAKG;AACH,KAAK,UAAU,2BAA2B,CAAC,WAAmB;IAC1D,MAAM,WAAW,GAAG,IAAA,WAAI,EAAC,WAAW,EAAE,yBAAQ,CAAC,OAAO,CAAC,CAAC;IACxD,MAAM,WAAW,GAAG,IAAA,oBAAK,EAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAY,CAAC;IAC3F,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC;IACpC,oBAAoB;IACpB,IAAI,aAAa,GAAG,sBAAsB,CAAC;IAC3C,IAAI,OAAO,EAAE,CAAC;QACV,sEAAsE;QACtE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC7C,MAAM,KAAK,GAAG,KAAK,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;YACxC,IAAI,KAAK,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;gBAC3B,MAAM,WAAW,GAAG,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;gBACtC,6BAA6B;gBAC7B,MAAM,SAAS,GACX,WAAW,EAAE,OAAO,CAAC,iBAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBACvC,CAAC,CAAC,WAAW,EAAE,OAAO,CAAC,iBAAS,CAAC,IAAI,CAAC;oBACtC,CAAC,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACpC,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,CAAC,CAAC,IAAI,WAAW,EAAE,CAAC;oBAC7D,aAAa,GAAG,WAAW,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;gBAC/C,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IACD,4CAA4C;IAC5C,OAAO,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;AACtD,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,uCAAuC,CACzD,WAAmB,EACnB,OAA6B;IAE7B,MAAM,MAAM,GAAG,OAAO,EAAE,MAAM,CAAC;IAC/B,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAI,UAAU,GAAG,EAAE,CAAC;IACpB,IAAI,SAAS,CAAC;IACd,IAAI,cAAc,CAAC;IACnB,IAAI,YAAY,CAAC,CAAC,aAAa;IAC/B,MAAM,OAAO,GAAG,IAAI,CAAC;IACrB,IAAI,CAAC;QACD,MAAM,YAAY,GAAG,IAAA,WAAI,EAAC,WAAW,EAAE,wBAAO,CAAC,MAAM,EAAE,yBAAQ,CAAC,QAAQ,CAAC,CAAC;QAC1E,MAAM,eAAe,GAAG,IAAA,oBAAK,EAAC,MAAM,aAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAa,CAAC;QACjG,YAAY,GAAG,eAAe,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,WAAW,CAAC,QAAQ,EAAE,YAA4B,CAAC;QAC3G,IAAI,GAAG,qBAAqB,IAAA,eAAQ,EAAC,WAAW,CAAC,EAAE,CAAC;QACpD,UAAU,GAAG,QAAQ,CAAC,CAAC,wDAAwD;QAC/E,SAAS,GAAG,MAAM,2BAA2B,CAAC,WAAW,CAAC,CAAC;QAC3D,MAAM,aAAa,GAAG,MAAM,IAAA,4BAAW,EAAC,WAAW,EAAE,yBAAQ,CAAC,OAAO,CAAC,CAAC;QACvE,4CAA4C;QAC5C,cAAc;YACV,aAAa,CAAC,oBAAoB,CAAwB,mBAAmB,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC;IAC9G,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,MAAM,EAAE,KAAK,CAAC,8DAA8D,WAAW,GAAG,CAAC,CAAC;IAChG,CAAC;IACD,OAAO;QACH,IAAI;QACJ,WAAW;QACX,YAAY;QACZ,UAAU;QACV,SAAS;QACT,cAAc;QACd,OAAO;KACV,CAAC;AACN,CAAC;AAlCD,0FAkCC"}

package/dist/types/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const FIORI_TOOLS_LAUNCH_CONFIG_HANDLER_ID = "fiori_tools";
+export declare const LAUNCH_JSON_FILE = "launch.json";
+export declare const RUN_SCRIPT = "run-script";
+//# sourceMappingURL=constants.d.ts.map

package/dist/types/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/types/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,oCAAoC,gBAAgB,CAAC;AAClE,eAAO,MAAM,gBAAgB,gBAAgB,CAAC;AAC9C,eAAO,MAAM,UAAU,eAAe,CAAC"}

package/dist/types/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RUN_SCRIPT = exports.LAUNCH_JSON_FILE = exports.FIORI_TOOLS_LAUNCH_CONFIG_HANDLER_ID = void 0;
+exports.FIORI_TOOLS_LAUNCH_CONFIG_HANDLER_ID = 'fiori_tools';
+exports.LAUNCH_JSON_FILE = 'launch.json';
+exports.RUN_SCRIPT = 'run-script';
+//# sourceMappingURL=constants.js.map

package/dist/types/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/types/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,oCAAoC,GAAG,aAAa,CAAC;AACrD,QAAA,gBAAgB,GAAG,aAAa,CAAC;AACjC,QAAA,UAAU,GAAG,YAAY,CAAC"}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types';
+export * from './constants';
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC"}

package/dist/types/index.js

@@ -0,0 +1,19 @@
+"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 });
+__exportStar(require("./types"), exports);
+__exportStar(require("./constants"), exports);
+//# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,8CAA4B"}

package/dist/types/types.d.ts

@@ -0,0 +1,54 @@
+import type { ODataVersion } from '@sap-ux/project-access';
+import type { FioriToolsProxyConfigBackend } from '@sap-ux/ui5-config';
+export declare enum Arguments {
+    FrameworkVersion = "--framework-version",
+    Open = "--open",
+    Config = "--config"
+}
+export interface FioriOptions {
+    name: string;
+    projectRoot: string;
+    oDataVersion?: ODataVersion;
+    useMockData?: boolean;
+    ui5Version?: string;
+    ui5VersionUri?: string;
+    ui5Local?: boolean;
+    ui5LocalVersion?: string;
+    startFile?: string;
+    backendConfigs?: FioriToolsProxyConfigBackend[];
+    urlParameters?: string;
+    visible?: boolean;
+}
+export interface LaunchJSON {
+    version: string;
+    configurations: LaunchConfig[];
+}
+export interface LaunchConfig {
+    name: string;
+    cwd: string;
+    runtimeArgs: string[];
+    type: 'node';
+    request: 'launch';
+    runtimeExecutable: string;
+    args?: string[];
+    windows: {
+        runtimeExecutable: string;
+        args?: string[];
+    };
+    console: 'internalConsole';
+    internalConsoleOptions: 'openOnSessionStart';
+    outputCapture: 'std';
+    env: LaunchConfigEnv;
+}
+export interface LaunchConfigEnv {
+    'run.config': string;
+    FIORI_TOOLS_UI5_VERSION?: string;
+    FIORI_TOOLS_UI5_URI?: string;
+    FIORI_TOOLS_BACKEND_CONFIG?: string;
+    FIORI_TOOLS_URL_PARAMS?: string;
+}
+export interface LaunchConfigInfo {
+    launchConfigs: LaunchConfig[];
+    filePath: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,oBAAoB,CAAC;AAEvE,oBAAY,SAAS;IACjB,gBAAgB,wBAAwB;IACxC,IAAI,WAAW;IACf,MAAM,aAAa;CACtB;AAED,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,4BAA4B,EAAE,CAAC;IAChD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,UAAU;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,YAAY,EAAE,CAAC;CAClC;AAED,MAAM,WAAW,YAAY;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,QAAQ,CAAC;IAClB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,EAAE;QACL,iBAAiB,EAAE,MAAM,CAAC;QAC1B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,CAAC;IACF,OAAO,EAAE,iBAAiB,CAAC;IAC3B,sBAAsB,EAAE,oBAAoB,CAAC;IAC7C,aAAa,EAAE,KAAK,CAAC;IACrB,GAAG,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,gBAAgB;IAC7B,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,QAAQ,EAAE,MAAM,CAAC;CACpB"}

package/dist/types/types.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Arguments = void 0;
+var Arguments;
+(function (Arguments) {
+    Arguments["FrameworkVersion"] = "--framework-version";
+    Arguments["Open"] = "--open";
+    Arguments["Config"] = "--config";
+})(Arguments || (exports.Arguments = Arguments = {}));
+//# sourceMappingURL=types.js.map

package/dist/types/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":";;;AAGA,IAAY,SAIX;AAJD,WAAY,SAAS;IACjB,qDAAwC,CAAA;IACxC,4BAAe,CAAA;IACf,gCAAmB,CAAA;AACvB,CAAC,EAJW,SAAS,yBAAT,SAAS,QAIpB"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@sap-ux/launch-config",
+  "version": "0.2.0",
+  "description": "SAP Fiori tools launch config administration",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/launch-config"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Alaunch-config"
+  },
+  "license": "Apache-2.0",
+  "private": false,
+  "main": "dist/index.js",
+  "files": [
+    "dist/",
+    "LICENSE",
+    "package.json"
+  ],
+  "engines": {
+    "node": ">=18.x"
+  },
+  "dependencies": {
+    "jsonc-parser": "3.2.0",
+    "mem-fs": "2.1.0",
+    "mem-fs-editor": "9.4.0",
+    "yargs-parser": "21.1.1",
+    "@sap-ux/project-access": "1.25.4",
+    "@sap-ux/ui5-config": "0.23.1",
+    "@sap-ux/ui5-info": "0.6.0"
+  },
+  "devDependencies": {
+    "@types/mem-fs": "1.1.2",
+    "@types/mem-fs-editor": "7.0.1",
+    "@types/yargs-parser": "21.0.3",
+    "@sap-ux/logger": "0.6.0"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rimraf --glob 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"
+  }
+}