@sap-ux/nodejs-utils 0.2.5 → 0.2.8

package/README.md

@@ -1,4 +1,6 @@
-# @sap-ux/nodejs-utils
+[![Changelog](https://img.shields.io/badge/changelog-8A2BE2)](https://github.com/SAP/open-ux-tools/blob/main/packages/nodejs-utils/CHANGELOG.md) [![Github repo](https://img.shields.io/badge/github-repo-blue)](https://github.com/SAP/open-ux-tools/tree/main/packages/nodejs-utils)
+
+# [`@sap-ux/nodejs-utils`](https://github.com/SAP/open-ux-tools/tree/main/packages/nodejs-utils)
 
 Nodejs utility wrappers
 
@@ -17,4 +19,4 @@ Pnpm
 see ./tests/unit/
 
 ## Keywords
-SAP Fiori tools library
+SAP Fiori tools library

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './commandRunner';
 export * from './installedCheck';
 export * from './httpsUtils';
+export * from './proxyCheck';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./commandRunner"), exports);
 __exportStar(require("./installedCheck"), exports);
 __exportStar(require("./httpsUtils"), exports);
+__exportStar(require("./proxyCheck"), exports);
 //# sourceMappingURL=index.js.map

package/dist/installedCheck.js

@@ -7,7 +7,7 @@ exports.findInstalledPackages = findInstalledPackages;
 const btp_utils_1 = require("@sap-ux/btp-utils");
 const commandRunner_1 = require("./commandRunner");
 const fast_glob_1 = __importDefault(require("fast-glob"));
-const path_1 = require("path");
+const node_path_1 = require("node:path");
 const read_pkg_up_1 = __importDefault(require("read-pkg-up"));
 const semver_1 = require("semver");
 /**
@@ -27,7 +27,7 @@ const getPackageInfo = async (searchPath, minVersion) => {
             return {
                 packageJsonPath: pkgInfo.path,
                 packageInfo: pkgInfo.packageJson,
-                path: (0, path_1.join)(searchPath, pkgInfo.packageJson.main ?? '/generators/app')
+                path: (0, node_path_1.join)(searchPath, pkgInfo.packageJson.main ?? '/generators/app')
             };
         }
     }
@@ -85,7 +85,7 @@ async function getNpmInstallPaths(vscWorkspaceConfig) {
         // App Wizard allows custom generator path install locations to be user configured
         const customGenInstallLoc = vscWorkspaceConfig?.get(appWizardInstallLocation);
         if (customGenInstallLoc) {
-            genSearchPaths.push((0, path_1.join)(customGenInstallLoc, 'node_modules'));
+            genSearchPaths.push((0, node_path_1.join)(customGenInstallLoc, 'node_modules'));
         }
     }
     // Npm global node modules path
@@ -100,7 +100,7 @@ async function getNpmInstallPaths(vscWorkspaceConfig) {
         return undefined;
     });
     if (rootNodeModules) {
-        genSearchPaths.push((0, path_1.join)(rootNodeModules.trim()));
+        genSearchPaths.push((0, node_path_1.join)(rootNodeModules.trim()));
     }
     // BAS recommend using NODE_PATH as the paths therein are used to locate all generators regardless of installation method
     if ((0, btp_utils_1.isAppStudio)() && process.env.NODE_PATH) {

package/dist/proxyCheck.d.ts

@@ -0,0 +1,23 @@
+export declare const ProxyValidationStatus: {
+    readonly NO_PROXY: "no-proxy";
+    readonly MATCH: "match";
+    readonly MISMATCH: "mismatch";
+    readonly ENV_ONLY: "env-only";
+    readonly PARAM_ONLY: "param-only";
+};
+export type ProxyValidationStatus = (typeof ProxyValidationStatus)[keyof typeof ProxyValidationStatus];
+export interface ProxyValidationResult {
+    isValid: boolean;
+    status: ProxyValidationStatus;
+    message: string;
+    envProxy?: string;
+    providedProxy?: string;
+}
+/**
+ * Validates if the proxy settings match against the process.env proxy settings. Typically used to ensure that the proxy settings in VSCode match those in the environment.
+ *
+ * @param {string} [proxy] - The proxy setting to validate. If not provided, it will check the environment variables.
+ * @returns {ProxyValidationResult} - An object containing the validation result, status, and messages.
+ */
+export declare function validateProxySettings(proxy?: string): ProxyValidationResult;
+//# sourceMappingURL=proxyCheck.d.ts.map

package/dist/proxyCheck.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProxyValidationStatus = void 0;
+exports.validateProxySettings = validateProxySettings;
+exports.ProxyValidationStatus = {
+    NO_PROXY: 'no-proxy',
+    MATCH: 'match',
+    MISMATCH: 'mismatch',
+    ENV_ONLY: 'env-only',
+    PARAM_ONLY: 'param-only'
+};
+const PROXY_ENV_VARS = ['HTTP_PROXY', 'http_proxy', 'HTTPS_PROXY', 'https_proxy'];
+const getEnvProxy = () => {
+    for (const envVar of PROXY_ENV_VARS) {
+        const value = process.env[envVar];
+        if (value && value.trim() !== '') {
+            return value;
+        }
+    }
+    return undefined;
+};
+const normalizeProxy = (value) => {
+    let result = value?.trim().toLowerCase();
+    while (result?.endsWith('/')) {
+        result = result.slice(0, -1);
+    }
+    return result || undefined;
+};
+/**
+ * Validates if the proxy settings match against the process.env proxy settings. Typically used to ensure that the proxy settings in VSCode match those in the environment.
+ *
+ * @param {string} [proxy] - The proxy setting to validate. If not provided, it will check the environment variables.
+ * @returns {ProxyValidationResult} - An object containing the validation result, status, and messages.
+ */
+function validateProxySettings(proxy) {
+    const envProxy = getEnvProxy();
+    const normalizedEnvProxy = normalizeProxy(envProxy);
+    const normalizedProxy = normalizeProxy(proxy);
+    // Exit early if no proxy settings are provided
+    if (!(normalizedEnvProxy || normalizedProxy)) {
+        return {
+            isValid: true,
+            status: exports.ProxyValidationStatus.NO_PROXY,
+            message: 'No proxy settings configured.',
+            providedProxy: undefined,
+            envProxy: envProxy
+        };
+    }
+    // Only environment proxy is set
+    if (normalizedEnvProxy && !normalizedProxy) {
+        return {
+            isValid: false,
+            status: exports.ProxyValidationStatus.ENV_ONLY,
+            message: 'Using environment proxy settings.',
+            envProxy: normalizedEnvProxy,
+            providedProxy: undefined
+        };
+    }
+    // Only provided proxy is set
+    if (!normalizedEnvProxy && normalizedProxy) {
+        return {
+            isValid: false,
+            status: exports.ProxyValidationStatus.PARAM_ONLY,
+            message: `Using provided (${normalizedProxy}) proxy settings.`,
+            envProxy: undefined,
+            providedProxy: normalizedProxy
+        };
+    }
+    // Both exist and match
+    if (normalizedEnvProxy === normalizedProxy) {
+        return {
+            isValid: true,
+            status: exports.ProxyValidationStatus.MATCH,
+            message: `Proxy settings match.`,
+            envProxy: normalizedEnvProxy,
+            providedProxy: normalizedProxy
+        };
+    }
+    // Both exist but don't match
+    return {
+        isValid: false,
+        status: exports.ProxyValidationStatus.MISMATCH,
+        message: `Proxy settings conflict between environment (${normalizedEnvProxy}) and parameter (${normalizedProxy}).`,
+        envProxy: normalizedEnvProxy,
+        providedProxy: normalizedProxy
+    };
+}
+//# sourceMappingURL=proxyCheck.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/nodejs-utils",
-  "version": "0.2.5",
+  "version": "0.2.8",
   "description": "Nodejs utility wrappers",
   "repository": {
     "type": "git",
@@ -17,13 +17,13 @@
     "fast-glob": "3.3.1",
     "read-pkg-up": "7.0.1",
     "semver": "7.5.4",
-    "@sap-ux/btp-utils": "1.1.3"
+    "@sap-ux/btp-utils": "1.1.5"
   },
   "devDependencies": {
     "@types/semver": "7.5.2",
     "@types/vscode": "1.73.1",
     "mock-spawn": "0.2.6",
-    "@sap-ux/logger": "0.7.0"
+    "@sap-ux/logger": "0.7.1"
   },
   "files": [
     "dist",