@sap-ux/environment-check 0.1.0

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,60 @@
+# @sap-ux/environment-check
+
+Environment check for Business Application Studio destinations.
+
+## Installation
+Npm
+`npm install --save @sap-ux/environment-check`
+
+Yarn
+`yarn add @sap-ux/environment-check`
+
+Pnpm
+`pnpm add @sap-ux/environment-check`
+
+## Usage
+
+```javascript
+import {
+    getEnvironment,
+    checkBASDestinations,
+    checkBASDestination
+} from '@sap/ux-environment-check';
+
+/**
+ * Returns the environment, including ide, versions ...
+ */
+const environmentResults = await getEnvironment();
+
+/**
+ * Checks the destinations and returns a list
+ */
+const destinationResults = await checkBASDestinations();
+
+/**
+ * Check a BAS destination for v2 & v4 catalog service 
+ */
+const destResult = await checkBASDestination(destination, username, password);
+
+```
+
+## CLI
+
+A CLI application is also available to investigate the environment and destinations.
+
+## Usage
+
+```
+$ envcheck --help
+
+Usage 
+    $ envheck --destination <DESTINATION> --output <OUTPUT> <WORKSPACE_ROOT>
+
+Options
+    --destination       destination to perform deep check, multiple destionations can be passed
+    --output            json | markdown | verbose | zip format for output, if not specified all messages   except 'info' are shown
+
+    <WORKSPACE_ROOT*>   path the root folder of a workspace. Multiple roots can be defined. We search for apps with destinations in workspaces
+```
+## Keywords
+SAP Fiori Tools

package/bin/envcheck

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../dist/cli/index.js');

package/dist/checks/destination.d.ts

@@ -0,0 +1,30 @@
+import type { Destination, DestinationResults, ResultMessage } from '../types';
+/**
+ * Check a BAS destination, like catalog service v2 & v4.
+ *
+ * @param destination - Destination from list of all destinations
+ * @param username username
+ * @param password password
+ * @returns messages and destination results
+ */
+export declare function checkBASDestination(destination: Destination, username?: string | undefined, password?: string | undefined): Promise<{
+    messages: ResultMessage[];
+    destinationResults: DestinationResults;
+}>;
+/**
+ * Returns whether a given destination requires username/password.
+ *
+ * @param destination - the destination to check
+ * @returns boolean if basic auth is required
+ */
+export declare function needsUsernamePassword(destination: Destination): boolean;
+/**
+ * Checks the destinations and returns a list. Optionally, deep dive into a list of passed destinations.
+ *
+ * @returns messages, destinations
+ */
+export declare function checkBASDestinations(): Promise<{
+    messages: ResultMessage[];
+    destinations: Destination[];
+}>;
+//# sourceMappingURL=destination.d.ts.map

package/dist/checks/destination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"destination.d.ts","sourceRoot":"","sources":["../../src/checks/destination.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,WAAW,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAa/E;;;;;;;GAOG;AACH,wBAAsB,mBAAmB,CACrC,WAAW,EAAE,WAAW,EACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,EAC7B,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,GAC9B,OAAO,CAAC;IAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;IAAC,kBAAkB,EAAE,kBAAkB,CAAA;CAAE,CAAC,CAWhF;AA8GD;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAEvE;AAED;;;;GAIG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC;IAClD,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,YAAY,EAAE,WAAW,EAAE,CAAC;CAC/B,CAAC,CAsDD"}

package/dist/checks/destination.js

@@ -0,0 +1,264 @@
+"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.checkBASDestinations = exports.needsUsernamePassword = exports.checkBASDestination = void 0;
+const bas_sdk_1 = require("@sap/bas-sdk");
+const axios_1 = __importDefault(require("axios"));
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const logger_1 = require("../logger");
+const formatter_1 = require("../formatter");
+const i18n_1 = require("../i18n");
+const axios_extension_1 = require("@sap-ux/axios-extension");
+const catalogMessages = {
+    401: (destination, odataVersion) => i18n_1.t('error.401', { odataVersion, destination: destination.Name }),
+    403: (destination, odataVersion) => i18n_1.t('error.403', { odataVersion, destination: destination.Name })
+};
+/**
+ * Check a BAS destination, like catalog service v2 & v4.
+ *
+ * @param destination - Destination from list of all destinations
+ * @param username username
+ * @param password password
+ * @returns messages and destination results
+ */
+function checkBASDestination(destination, username, password) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const logger = logger_1.getLogger();
+        logger.info(i18n_1.t('checkingDestination', { destination: destination.Name }));
+        const { messages, result: destinationResults } = yield checkCatalogServices(destination, username, password);
+        logger.push(...messages);
+        return {
+            messages: logger.getMessages(),
+            destinationResults
+        };
+    });
+}
+exports.checkBASDestination = checkBASDestination;
+/**
+ * Checks for services from catalog requests.
+ *
+ * @param destination sap detination
+ * @param username username
+ * @param password password
+ * @returns Result messages and results of catalog requests
+ */
+function checkCatalogServices(destination, username, password) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const messages = [];
+        const v2results = yield catalogRequest(axios_extension_1.ODataVersion.v2, destination, username, password);
+        messages.push(...v2results.messages);
+        const v4results = yield catalogRequest(axios_extension_1.ODataVersion.v4, destination, username, password);
+        messages.push(...v4results.messages);
+        const html5DynamicDestination = !!destination['HTML5.DynamicDestination'];
+        if (!html5DynamicDestination) {
+            messages.push({
+                severity: "error" /* Error */,
+                text: i18n_1.t('error.missingDynamicDestProperty', { destination: destination.Name })
+            });
+        }
+        const result = {
+            v2: { results: v2results.result, status: v2results.responseStatus },
+            v4: { results: v4results.result, status: v4results.responseStatus },
+            HTML5DynamicDestination: html5DynamicDestination
+        };
+        return {
+            messages,
+            result
+        };
+    });
+}
+/**
+ * Performs a catalog request for the given odata version and destination.
+ *
+ * @param odataVersion odataVersion to be used
+ * @param destination destination to be checked
+ * @param username username
+ * @param password password
+ * @returns messages, catalog results, response status
+ */
+function catalogRequest(odataVersion, destination, username, password) {
+    var _a, _b, _c, _d;
+    return __awaiter(this, void 0, void 0, function* () {
+        const logger = logger_1.getLogger();
+        let result;
+        let url;
+        let responseStatus;
+        try {
+            const auth = username !== undefined && password !== undefined
+                ? {
+                    username,
+                    password
+                }
+                : undefined;
+            const axiosConfig = {
+                baseURL: destination.Host,
+                auth: auth
+            };
+            const provider = axios_extension_1.createForDestination(axiosConfig, destination);
+            const catalog = provider.catalog(odataVersion);
+            result = yield catalog.listServices();
+            if (result.length > 0) {
+                const numberOfServices = formatter_1.countNumberOfServices(result);
+                logger.info(i18n_1.t('info.numServicesForDestination', {
+                    odataVersion,
+                    destination: destination.Name,
+                    numServicesForDest: formatter_1.getServiceCountText(numberOfServices)
+                }));
+            }
+        }
+        catch (error) {
+            responseStatus = ((_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.status) || ((_b = error === null || error === void 0 ? void 0 : error.cause) === null || _b === void 0 ? void 0 : _b.status);
+            logger.error(catalogMessages[responseStatus]
+                ? catalogMessages[responseStatus](destination, odataVersion)
+                : i18n_1.t('error.queryFailure', { odataVersion, destination: destination.Name }));
+            const errorJson = error.toJSON ? error.toJSON() : {};
+            if ((_d = (_c = errorJson === null || errorJson === void 0 ? void 0 : errorJson.config) === null || _c === void 0 ? void 0 : _c.auth) === null || _d === void 0 ? void 0 : _d.password) {
+                delete errorJson.config.auth.password;
+            }
+            logger.debug(i18n_1.t('error.urlRequestFailure', { url, error: error.message, errorObj: error }));
+        }
+        return {
+            messages: logger.getMessages(),
+            result,
+            responseStatus
+        };
+    });
+}
+/**
+ * Returns whether a given destination requires username/password.
+ *
+ * @param destination - the destination to check
+ * @returns boolean if basic auth is required
+ */
+function needsUsernamePassword(destination) {
+    return !!destination && destination.Authentication === 'NoAuthentication';
+}
+exports.needsUsernamePassword = needsUsernamePassword;
+/**
+ * Checks the destinations and returns a list. Optionally, deep dive into a list of passed destinations.
+ *
+ * @returns messages, destinations
+ */
+function checkBASDestinations() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const logger = logger_1.getLogger();
+        const destinations = [];
+        let url;
+        // Reload request
+        try {
+            yield axios_1.default.get(btp_utils_1.getAppStudioProxyURL() + '/reload');
+        }
+        catch (error) {
+            logger.warn(i18n_1.t('warning.reloadFailure'));
+            logger.debug(i18n_1.t('info.urlRequestFailure', {
+                url: `${btp_utils_1.getAppStudioProxyURL() + '/reload'}`,
+                error: error.message,
+                errorObj: error.toJSON ? JSON.stringify(error.toJSON(), null, 4) : error
+            }));
+        }
+        // Destinations request
+        try {
+            let retrievedDestinations = [];
+            if (btp_utils_1.isAppStudio()) {
+                const response = yield bas_sdk_1.destinations.getDestinations();
+                retrievedDestinations = transformDestination(response);
+            }
+            else {
+                // Destination check for VSCode would go here
+            }
+            for (const destination of retrievedDestinations) {
+                destination.UrlServiceType = getUrlServiceTypeForDest(destination);
+                destinations.push(destination);
+            }
+            const destinationNumber = Object.keys(destinations).length;
+            if (destinationNumber > 0) {
+                logger.info(i18n_1.t('info.numDestinationsFound', { destinationNumber }));
+            }
+            else {
+                logger.warn(i18n_1.t('warning.noDestinationsFound'));
+            }
+        }
+        catch (error) {
+            logger.error(i18n_1.t('error.retrievingDestinations', { error: error.message }));
+            logger.debug(i18n_1.t('info.urlRequestFailure', {
+                url: url,
+                error: error.message,
+                errorObj: error.toJSON ? JSON.stringify(error.toJSON(), null, 4) : error
+            }));
+        }
+        return {
+            messages: logger.getMessages(),
+            destinations
+        };
+    });
+}
+exports.checkBASDestinations = checkBASDestinations;
+/**
+ * Return the URL service type for a given destination.
+ *
+ * @param destination - destination to check
+ * @returns - URL service type, like 'Full Service URL', 'Catalog Service', 'Partial URL'
+ */
+function getUrlServiceTypeForDest(destination) {
+    var _a, _b;
+    let urlServiceType = "Invalid URL" /* InvalidUrl */;
+    const odataGen = !!((_a = destination.WebIDEUsage) === null || _a === void 0 ? void 0 : _a.split(',').find((entry) => entry.trim() === 'odata_gen'));
+    const odataAbap = !!((_b = destination.WebIDEUsage) === null || _b === void 0 ? void 0 : _b.split(',').find((entry) => entry.trim() === 'odata_abap'));
+    const fullUrl = destination.WebIDEAdditionalData === 'full_url';
+    if (odataGen && fullUrl && !odataAbap) {
+        urlServiceType = "Full Service URL" /* FullServiceUrl */;
+    }
+    else if (!odataGen && !fullUrl && odataAbap) {
+        urlServiceType = "Catalog Service" /* CatalogServiceUrl */;
+    }
+    else if (odataGen && !fullUrl && !odataAbap) {
+        urlServiceType = "Partial URL" /* PartialUrl */;
+    }
+    return urlServiceType;
+}
+/**
+ * Transforms the destination format to align with @sap-ux/btp-utils Destination type.
+ *
+ * @param destinationInfo DestinationListInfo[] from '@sap/bas-sdk'
+ * @returns list of destinations in new (flat) format
+ */
+function transformDestination(destinationInfo) {
+    var _a, _b, _c, _d;
+    const destinations = [];
+    for (const destInfo of destinationInfo) {
+        const answerDestination = {
+            Name: destInfo.name,
+            Type: 'HTTP',
+            Authentication: destInfo.credentials.authentication,
+            ProxyType: destInfo.proxyType,
+            Description: destInfo.description,
+            Host: destInfo.host
+        };
+        if ((_a = destInfo.basProperties) === null || _a === void 0 ? void 0 : _a.additionalData) {
+            answerDestination.WebIDEAdditionalData = destInfo.basProperties.additionalData;
+        }
+        if ((_b = destInfo.basProperties) === null || _b === void 0 ? void 0 : _b.usage) {
+            answerDestination.WebIDEUsage = String(destInfo.basProperties.usage);
+        }
+        if ((_c = destInfo.basProperties) === null || _c === void 0 ? void 0 : _c.sapClient) {
+            answerDestination['sap-client'] = destInfo.basProperties.sapClient;
+        }
+        if (((_d = destInfo.basProperties) === null || _d === void 0 ? void 0 : _d.html5DynamicDestination) !== undefined) {
+            answerDestination['HTML5.DynamicDestination'] = destInfo.basProperties.html5DynamicDestination;
+        }
+        destinations.push(answerDestination);
+    }
+    return destinations;
+}
+//# sourceMappingURL=destination.js.map

package/dist/checks/destination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"destination.js","sourceRoot":"","sources":["../../src/checks/destination.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,0CAA+D;AAC/D,kDAA0B;AAC1B,iDAAsE;AACtE,sCAAsC;AACtC,4CAA0E;AAG1E,kCAA4B;AAC5B,6DAA6E;AAG7E,MAAM,eAAe,GAAG;IACpB,GAAG,EAAE,CAAC,WAAwB,EAAE,YAA0B,EAAU,EAAE,CAClE,QAAC,CAAC,WAAW,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;IACnE,GAAG,EAAE,CAAC,WAAwB,EAAE,YAA0B,EAAU,EAAE,CAClE,QAAC,CAAC,WAAW,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;CACtE,CAAC;AAEF;;;;;;;GAOG;AACH,SAAsB,mBAAmB,CACrC,WAAwB,EACxB,QAA6B,EAC7B,QAA6B;;QAE7B,MAAM,MAAM,GAAG,kBAAS,EAAE,CAAC;QAC3B,MAAM,CAAC,IAAI,CAAC,QAAC,CAAC,qBAAqB,EAAE,EAAE,WAAW,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QAEzE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,oBAAoB,CAAC,WAAW,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAE7G,MAAM,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;QACzB,OAAO;YACH,QAAQ,EAAE,MAAM,CAAC,WAAW,EAAE;YAC9B,kBAAkB;SACrB,CAAC;IACN,CAAC;CAAA;AAfD,kDAeC;AAED;;;;;;;GAOG;AACH,SAAe,oBAAoB,CAC/B,WAAwB,EACxB,QAA6B,EAC7B,QAA6B;;QAE7B,MAAM,QAAQ,GAAoB,EAAE,CAAC;QAErC,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC,8BAAY,CAAC,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACzF,QAAQ,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;QAErC,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC,8BAAY,CAAC,EAAE,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;QACzF,QAAQ,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;QAErC,MAAM,uBAAuB,GAAG,CAAC,CAAC,WAAW,CAAC,0BAA0B,CAAC,CAAC;QAE1E,IAAI,CAAC,uBAAuB,EAAE;YAC1B,QAAQ,CAAC,IAAI,CAAC;gBACV,QAAQ,qBAAgB;gBACxB,IAAI,EAAE,QAAC,CAAC,kCAAkC,EAAE,EAAE,WAAW,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC;aACjF,CAAC,CAAC;SACN;QAED,MAAM,MAAM,GAAuB;YAC/B,EAAE,EAAE,EAAE,OAAO,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,cAAc,EAAE;YACnE,EAAE,EAAE,EAAE,OAAO,EAAE,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,cAAc,EAAE;YACnE,uBAAuB,EAAE,uBAAuB;SACnD,CAAC;QAEF,OAAO;YACH,QAAQ;YACR,MAAM;SACT,CAAC;IACN,CAAC;CAAA;AAED;;;;;;;;GAQG;AACH,SAAe,cAAc,CACzB,YAA0B,EAC1B,WAAwB,EACxB,QAA6B,EAC7B,QAA6B;;;QAE7B,MAAM,MAAM,GAAG,kBAAS,EAAE,CAAC;QAC3B,IAAI,MAA0B,CAAC;QAC/B,IAAI,GAAW,CAAC;QAChB,IAAI,cAAsB,CAAC;QAC3B,IAAI;YACA,MAAM,IAAI,GACN,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS;gBAC5C,CAAC,CAAC;oBACI,QAAQ;oBACR,QAAQ;iBACX;gBACH,CAAC,CAAC,SAAS,CAAC;YAEpB,MAAM,WAAW,GAAuB;gBACpC,OAAO,EAAE,WAAW,CAAC,IAAI;gBACzB,IAAI,EAAE,IAAI;aACb,CAAC;YAEF,MAAM,QAAQ,GAAwB,sCAAoB,CAAC,WAAW,EAAE,WAAW,CAAwB,CAAC;YAC5G,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;YAC/C,MAAM,GAAG,MAAM,OAAO,CAAC,YAAY,EAAE,CAAC;YACtC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;gBACnB,MAAM,gBAAgB,GAAG,iCAAqB,CAAC,MAAM,CAAC,CAAC;gBACvD,MAAM,CAAC,IAAI,CACP,QAAC,CAAC,gCAAgC,EAAE;oBAChC,YAAY;oBACZ,WAAW,EAAE,WAAW,CAAC,IAAI;oBAC7B,kBAAkB,EAAE,+BAAmB,CAAC,gBAAgB,CAAC;iBAC5D,CAAC,CACL,CAAC;aACL;SACJ;QAAC,OAAO,KAAK,EAAE;YACZ,cAAc,GAAG,OAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,0CAAE,MAAM,YAAI,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,0CAAE,MAAM,CAAA,CAAC;YACjE,MAAM,CAAC,KAAK,CACR,eAAe,CAAC,cAAc,CAAC;gBAC3B,CAAC,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC,WAAW,EAAE,YAAY,CAAC;gBAC5D,CAAC,CAAC,QAAC,CAAC,oBAAoB,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,CAAC,IAAI,EAAE,CAAC,CACjF,CAAC;YACF,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACrD,gBAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM,0CAAE,IAAI,0CAAE,QAAQ,EAAE;gBACnC,OAAO,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;aACzC;YACD,MAAM,CAAC,KAAK,CAAC,QAAC,CAAC,yBAAyB,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;SAC9F;QACD,OAAO;YACH,QAAQ,EAAE,MAAM,CAAC,WAAW,EAAE;YAC9B,MAAM;YACN,cAAc;SACjB,CAAC;;CACL;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,WAAwB;IAC1D,OAAO,CAAC,CAAC,WAAW,IAAI,WAAW,CAAC,cAAc,KAAK,kBAAkB,CAAC;AAC9E,CAAC;AAFD,sDAEC;AAED;;;;GAIG;AACH,SAAsB,oBAAoB;;QAItC,MAAM,MAAM,GAAG,kBAAS,EAAE,CAAC;QAC3B,MAAM,YAAY,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAW,CAAC;QAEhB,iBAAiB;QACjB,IAAI;YACA,MAAM,eAAK,CAAC,GAAG,CAAC,gCAAoB,EAAE,GAAG,SAAS,CAAC,CAAC;SACvD;QAAC,OAAO,KAAK,EAAE;YACZ,MAAM,CAAC,IAAI,CAAC,QAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC;YACxC,MAAM,CAAC,KAAK,CACR,QAAC,CAAC,wBAAwB,EAAE;gBACxB,GAAG,EAAE,GAAG,gCAAoB,EAAE,GAAG,SAAS,EAAE;gBAC5C,KAAK,EAAE,KAAK,CAAC,OAAO;gBACpB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;aAC3E,CAAC,CACL,CAAC;SACL;QACD,uBAAuB;QACvB,IAAI;YACA,IAAI,qBAAqB,GAAkB,EAAE,CAAC;YAE9C,IAAI,uBAAW,EAAE,EAAE;gBACf,MAAM,QAAQ,GAAG,MAAM,sBAAe,CAAC,eAAe,EAAE,CAAC;gBACzD,qBAAqB,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC;aAC1D;iBAAM;gBACH,6CAA6C;aAChD;YAED,KAAK,MAAM,WAAW,IAAI,qBAAqB,EAAE;gBAC7C,WAAW,CAAC,cAAc,GAAG,wBAAwB,CAAC,WAAW,CAAC,CAAC;gBACnE,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;aAClC;YAED,MAAM,iBAAiB,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC;YAC3D,IAAI,iBAAiB,GAAG,CAAC,EAAE;gBACvB,MAAM,CAAC,IAAI,CAAC,QAAC,CAAC,2BAA2B,EAAE,EAAE,iBAAiB,EAAE,CAAC,CAAC,CAAC;aACtE;iBAAM;gBACH,MAAM,CAAC,IAAI,CAAC,QAAC,CAAC,6BAA6B,CAAC,CAAC,CAAC;aACjD;SACJ;QAAC,OAAO,KAAK,EAAE;YACZ,MAAM,CAAC,KAAK,CAAC,QAAC,CAAC,8BAA8B,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YAC1E,MAAM,CAAC,KAAK,CACR,QAAC,CAAC,wBAAwB,EAAE;gBACxB,GAAG,EAAE,GAAG;gBACR,KAAK,EAAE,KAAK,CAAC,OAAO;gBACpB,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK;aAC3E,CAAC,CACL,CAAC;SACL;QACD,OAAO;YACH,QAAQ,EAAE,MAAM,CAAC,WAAW,EAAE;YAC9B,YAAY;SACf,CAAC;IACN,CAAC;CAAA;AAzDD,oDAyDC;AAED;;;;;GAKG;AACH,SAAS,wBAAwB,CAAC,WAAwB;;IACtD,IAAI,cAAc,iCAA4C,CAAC;IAC/D,MAAM,QAAQ,GAAG,CAAC,QAAC,WAAW,CAAC,WAAW,0CAAE,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,WAAW,EAAC,CAAC;IACrG,MAAM,SAAS,GAAG,CAAC,QAAC,WAAW,CAAC,WAAW,0CAAE,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,YAAY,EAAC,CAAC;IACvG,MAAM,OAAO,GAAG,WAAW,CAAC,oBAAoB,KAAK,UAAU,CAAC;IAEhE,IAAI,QAAQ,IAAI,OAAO,IAAI,CAAC,SAAS,EAAE;QACnC,cAAc,0CAAgC,CAAC;KAClD;SAAM,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO,IAAI,SAAS,EAAE;QAC3C,cAAc,4CAAmC,CAAC;KACrD;SAAM,IAAI,QAAQ,IAAI,CAAC,OAAO,IAAI,CAAC,SAAS,EAAE;QAC3C,cAAc,iCAA4B,CAAC;KAC9C;IACD,OAAO,cAAc,CAAC;AAC1B,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB,CAAC,eAAe;;IACzC,MAAM,YAAY,GAAkB,EAAE,CAAC;IAEvC,KAAK,MAAM,QAAQ,IAAI,eAAe,EAAE;QACpC,MAAM,iBAAiB,GAAgB;YACnC,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,IAAI,EAAE,MAAM;YACZ,cAAc,EAAE,QAAQ,CAAC,WAAW,CAAC,cAAc;YACnD,SAAS,EAAE,QAAQ,CAAC,SAAS;YAC7B,WAAW,EAAE,QAAQ,CAAC,WAAW;YACjC,IAAI,EAAE,QAAQ,CAAC,IAAI;SACtB,CAAC;QAEF,UAAI,QAAQ,CAAC,aAAa,0CAAE,cAAc,EAAE;YACxC,iBAAiB,CAAC,oBAAoB,GAAG,QAAQ,CAAC,aAAa,CAAC,cAAc,CAAC;SAClF;QAED,UAAI,QAAQ,CAAC,aAAa,0CAAE,KAAK,EAAE;YAC/B,iBAAiB,CAAC,WAAW,GAAG,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SACxE;QAED,UAAI,QAAQ,CAAC,aAAa,0CAAE,SAAS,EAAE;YACnC,iBAAiB,CAAC,YAAY,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC;SACtE;QAED,IAAI,OAAA,QAAQ,CAAC,aAAa,0CAAE,uBAAuB,MAAK,SAAS,EAAE;YAC/D,iBAAiB,CAAC,0BAA0B,CAAC,GAAG,QAAQ,CAAC,aAAa,CAAC,uBAAuB,CAAC;SAClG;QAED,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;KACxC;IACD,OAAO,YAAY,CAAC;AACxB,CAAC"}

package/dist/checks/environment.d.ts

@@ -0,0 +1,18 @@
+import type { CheckEnvironmentOptions, Environment, EnvironmentCheckResult, ResultMessage } from '../types';
+/**
+ * Return the environment.
+ *
+ * @returns environment, including ide, versions, ...
+ */
+export declare function getEnvironment(): Promise<{
+    environment: Environment;
+    messages: ResultMessage[];
+}>;
+/**
+ * Check environment includes process.env, list of destinations, details about destinations.
+ *
+ * @param options - see type CheckEnvironmentOptions, includes destination for deep dive, workspace roots, ...
+ * @returns the result, currently as JSON
+ */
+export declare function checkEnvironment(options?: CheckEnvironmentOptions): Promise<EnvironmentCheckResult>;
+//# sourceMappingURL=environment.d.ts.map

package/dist/checks/environment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.d.ts","sourceRoot":"","sources":["../../src/checks/environment.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAER,uBAAuB,EAEvB,WAAW,EACX,sBAAsB,EACtB,aAAa,EAChB,MAAM,UAAU,CAAC;AAIlB;;;;GAIG;AACH,wBAAsB,cAAc,IAAI,OAAO,CAAC;IAAE,WAAW,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,aAAa,EAAE,CAAA;CAAE,CAAC,CAsBvG;AAuFD;;;;;GAKG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,CAAC,EAAE,uBAAuB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CA6BzG"}