@contrail/cli 3.4.0 → 3.4.2-alpha.1

package/dist/helpers/config/config.js

@@ -1,223 +1,223 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkTelemetry = exports.validateEnvironments = exports.getConfigContent = exports.getConfigFiles = exports.storeConfig = exports.getConfig = exports.writeConfig = exports.createConfig = exports.storeVibeIQConfig = exports.writeVibeIQConfig = exports.readVibeIQConfig = exports.initializeVibeIQConfig = exports.ENVIRONMENTS = void 0;
-const tslib_1 = require("tslib");
-const node_fs_1 = require("node:fs");
-const node_path_1 = require("node:path");
-const node_os_1 = require("node:os");
-const logger_1 = tslib_1.__importDefault(require("../../logger"));
-const configFileName = 'config.json';
-const defaultConfigFileName = 'default.json';
-const userHomeDir = (0, node_os_1.homedir)();
-const configDirectoryLocation = (0, node_path_1.join)(userHomeDir, '.vibeiq', 'configs');
-const configFileLocation = (0, node_path_1.join)(configDirectoryLocation, configFileName);
-const defaultConfigFileLocation = (0, node_path_1.join)(configDirectoryLocation, defaultConfigFileName);
-exports.ENVIRONMENTS = {
-    dev: 'https://api.dev.vibeiq.com/dev/api',
-    prod: 'https://api.vibeiq.com/prod/api',
-};
-async function initializeVibeIQConfig() {
-    try {
-        await node_fs_1.promises.mkdir(configDirectoryLocation, { recursive: true });
-    }
-    catch (error) {
-        logger_1.default.error('could not initialize vibeiq directory');
-        throw error;
-    }
-    try {
-        const config = {
-            configInUse: (0, node_path_1.parse)(defaultConfigFileName).name,
-            logLevel: 'debug',
-        };
-        await node_fs_1.promises.writeFile(configFileLocation, JSON.stringify(config, null, 2));
-        await node_fs_1.promises.writeFile(defaultConfigFileLocation, '{}');
-    }
-    catch (error) {
-        logger_1.default.error(`could not initialize config file (${configFileLocation}).`);
-        throw error;
-    }
-}
-exports.initializeVibeIQConfig = initializeVibeIQConfig;
-async function readVibeIQConfig() {
-    let fileContent;
-    try {
-        fileContent = await (await node_fs_1.promises.readFile(configFileLocation)).toString();
-    }
-    catch {
-        logger_1.default.debug(`failed to open config file (${configFileLocation}) for reading.`);
-        logger_1.default.debug('trying to initialize config file');
-        await initializeVibeIQConfig();
-        fileContent = await (await node_fs_1.promises.readFile(configFileLocation)).toString();
-    }
-    try {
-        return JSON.parse(fileContent);
-    }
-    catch {
-        logger_1.default.error(`Could not parse local vibeiq config. The file (${configFileLocation}) might be malformed`);
-    }
-}
-exports.readVibeIQConfig = readVibeIQConfig;
-async function writeVibeIQConfig(config) {
-    try {
-        await node_fs_1.promises.writeFile(configFileLocation, JSON.stringify(config, null, 2));
-    }
-    catch (error) {
-        logger_1.default.error(`Could not open config file (${configFileLocation}) for writing.`);
-        throw error;
-    }
-}
-exports.writeVibeIQConfig = writeVibeIQConfig;
-async function storeVibeIQConfig(incomingConfig) {
-    const config = {
-        ...(await readVibeIQConfig()),
-        ...incomingConfig,
-    };
-    await writeVibeIQConfig(config);
-}
-exports.storeVibeIQConfig = storeVibeIQConfig;
-async function createConfig(fileName) {
-    try {
-        await node_fs_1.promises.writeFile((0, node_path_1.join)(configDirectoryLocation, `${fileName}.json`), '{}');
-    }
-    catch (error) {
-        logger_1.default.error('Could not create config file.');
-        throw error;
-    }
-}
-exports.createConfig = createConfig;
-async function writeConfig(config, configName = null) {
-    try {
-        let configFileName = configName;
-        if (!configName) {
-            const fileContent = await readVibeIQConfig();
-            configFileName = fileContent.configInUse;
-        }
-        await node_fs_1.promises.writeFile((0, node_path_1.join)(configDirectoryLocation, `${configFileName}.json`), JSON.stringify(config, null, 2));
-    }
-    catch (error) {
-        logger_1.default.error('Could not open config file for writing.');
-        throw error;
-    }
-}
-exports.writeConfig = writeConfig;
-async function getConfig() {
-    let fileContent;
-    try {
-        fileContent = (await node_fs_1.promises.readFile(configFileLocation)).toString();
-    }
-    catch {
-        logger_1.default.debug(`failed to open config file (${configFileLocation}) for reading.`);
-        logger_1.default.debug('trying to initialize config file');
-        await initializeVibeIQConfig();
-        fileContent = (await node_fs_1.promises.readFile(configFileLocation)).toString();
-    }
-    try {
-        const configFileJSON = JSON.parse(fileContent);
-        return getConfigContent(configFileJSON.configInUse);
-    }
-    catch {
-        logger_1.default.error('Could not parse local vibeiq config.');
-    }
-}
-exports.getConfig = getConfig;
-async function storeConfig(incomingConfig, configName = null, merge = true) {
-    let configContent;
-    if (!configName) {
-        configContent = await getConfig();
-    }
-    else {
-        configContent = await getConfigContent(configName);
-    }
-    let config = {
-        ...configContent,
-        ...incomingConfig,
-    };
-    if (!merge) {
-        config = incomingConfig;
-    }
-    await writeConfig(config, configName);
-}
-exports.storeConfig = storeConfig;
-async function getConfigFiles() {
-    try {
-        const dirContent = (await node_fs_1.promises.readdir(configDirectoryLocation, { withFileTypes: true }))
-            .filter((content) => content.isFile() &&
-            content.name !== configFileName &&
-            (0, node_path_1.parse)(content.name).ext === '.json')
-            .map((content) => (0, node_path_1.parse)(content.name).name);
-        return dirContent;
-    }
-    catch {
-        logger_1.default.error(`Failed to open config directory (${configDirectoryLocation}) for getting files.`);
-    }
-}
-exports.getConfigFiles = getConfigFiles;
-async function getConfigContent(fileName) {
-    const configFilePath = (0, node_path_1.join)(configDirectoryLocation, `${fileName}.json`);
-    let fileContent;
-    try {
-        fileContent = (await node_fs_1.promises.readFile(configFilePath)).toString();
-        return JSON.parse(fileContent);
-    }
-    catch (error) {
-        logger_1.default.error(`Failed to open/parse config file (${fileName}) might be malformed or not found.`);
-    }
-}
-exports.getConfigContent = getConfigContent;
-async function validateEnvironments(envName = null) {
-    if (envName === 'development') {
-        envName = 'dev';
-    }
-    else if (envName === 'production') {
-        envName = 'prod';
-    }
-    if (envName && !exports.ENVIRONMENTS[envName]) {
-        throw new Error(`No environment found with name ${envName}`);
-    }
-    return envName ? exports.ENVIRONMENTS[envName] : true;
-}
-exports.validateEnvironments = validateEnvironments;
-async function checkTelemetry(cliVersion) {
-    try {
-        // TODO: remove comment when api is available so that we don't get errors
-        // const response = await axios.post('https://api.vibeiq.com/prod/api/telemetry/cli', {
-        //   cli_version: cliVersion,
-        // });
-        // const { deprecations, warnings, errors } = response.data;
-        // eg: how the response should look like
-        // const deprecations = [
-        //   { message: 'Deprecation 1' },
-        //   { message: 'Deprecation 2' },
-        //   { message: 'Deprecation 3' },
-        // ];
-        // const warnings = [{ message: 'Warning 1' }, { message: 'Warning 2' }, { message: 'Warning 3' }];
-        // const errors = [{ message: 'Error 1' }, { message: 'Error 2' }, { message: 'Error 3' }];
-        // TODO: Remove the hardcoded data when the API is available
-        const deprecations = [];
-        const warnings = [];
-        const errors = [];
-        if (errors.length > 0) {
-            const latestVersion = '2.4.0'; // TODO: Replace with the latest version of the CLI by calling the API
-            console.error(`Contrail CLI verison ${cliVersion} contains known critical bugs. Please upgrade to version ${latestVersion}.\n\nQuitting the CLI for safety.`);
-            errors.forEach((error) => {
-                logger_1.default.error(`${error.message}`);
-            });
-            const failed_exit_code = 1;
-            process.exit(failed_exit_code);
-        }
-        if (warnings.length > 0) {
-            warnings.forEach((warning) => {
-                logger_1.default.warn(`${warning.message}`);
-            });
-        }
-        if (deprecations.length > 0) {
-            deprecations.forEach((deprecation) => {
-                logger_1.default.warn(`${deprecation.message}`);
-            });
-        }
-    }
-    catch (error) {
-        console.error('Failed to check telemetry:', error.message);
-    }
-}
-exports.checkTelemetry = checkTelemetry;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkTelemetry = exports.validateEnvironments = exports.getConfigContent = exports.getConfigFiles = exports.storeConfig = exports.getConfig = exports.writeConfig = exports.createConfig = exports.storeVibeIQConfig = exports.writeVibeIQConfig = exports.readVibeIQConfig = exports.initializeVibeIQConfig = exports.ENVIRONMENTS = void 0;
+const tslib_1 = require("tslib");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const node_os_1 = require("node:os");
+const logger_1 = tslib_1.__importDefault(require("../../logger"));
+const configFileName = 'config.json';
+const defaultConfigFileName = 'default.json';
+const userHomeDir = (0, node_os_1.homedir)();
+const configDirectoryLocation = (0, node_path_1.join)(userHomeDir, '.vibeiq', 'configs');
+const configFileLocation = (0, node_path_1.join)(configDirectoryLocation, configFileName);
+const defaultConfigFileLocation = (0, node_path_1.join)(configDirectoryLocation, defaultConfigFileName);
+exports.ENVIRONMENTS = {
+    dev: 'https://api.dev.vibeiq.com/dev/api',
+    prod: 'https://api.vibeiq.com/prod/api',
+};
+async function initializeVibeIQConfig() {
+    try {
+        await node_fs_1.promises.mkdir(configDirectoryLocation, { recursive: true });
+    }
+    catch (error) {
+        logger_1.default.error('could not initialize vibeiq directory');
+        throw error;
+    }
+    try {
+        const config = {
+            configInUse: (0, node_path_1.parse)(defaultConfigFileName).name,
+            logLevel: 'debug',
+        };
+        await node_fs_1.promises.writeFile(configFileLocation, JSON.stringify(config, null, 2));
+        await node_fs_1.promises.writeFile(defaultConfigFileLocation, '{}');
+    }
+    catch (error) {
+        logger_1.default.error(`could not initialize config file (${configFileLocation}).`);
+        throw error;
+    }
+}
+exports.initializeVibeIQConfig = initializeVibeIQConfig;
+async function readVibeIQConfig() {
+    let fileContent;
+    try {
+        fileContent = await (await node_fs_1.promises.readFile(configFileLocation)).toString();
+    }
+    catch {
+        logger_1.default.debug(`failed to open config file (${configFileLocation}) for reading.`);
+        logger_1.default.debug('trying to initialize config file');
+        await initializeVibeIQConfig();
+        fileContent = await (await node_fs_1.promises.readFile(configFileLocation)).toString();
+    }
+    try {
+        return JSON.parse(fileContent);
+    }
+    catch {
+        logger_1.default.error(`Could not parse local vibeiq config. The file (${configFileLocation}) might be malformed`);
+    }
+}
+exports.readVibeIQConfig = readVibeIQConfig;
+async function writeVibeIQConfig(config) {
+    try {
+        await node_fs_1.promises.writeFile(configFileLocation, JSON.stringify(config, null, 2));
+    }
+    catch (error) {
+        logger_1.default.error(`Could not open config file (${configFileLocation}) for writing.`);
+        throw error;
+    }
+}
+exports.writeVibeIQConfig = writeVibeIQConfig;
+async function storeVibeIQConfig(incomingConfig) {
+    const config = {
+        ...(await readVibeIQConfig()),
+        ...incomingConfig,
+    };
+    await writeVibeIQConfig(config);
+}
+exports.storeVibeIQConfig = storeVibeIQConfig;
+async function createConfig(fileName) {
+    try {
+        await node_fs_1.promises.writeFile((0, node_path_1.join)(configDirectoryLocation, `${fileName}.json`), '{}');
+    }
+    catch (error) {
+        logger_1.default.error('Could not create config file.');
+        throw error;
+    }
+}
+exports.createConfig = createConfig;
+async function writeConfig(config, configName = null) {
+    try {
+        let configFileName = configName;
+        if (!configName) {
+            const fileContent = await readVibeIQConfig();
+            configFileName = fileContent.configInUse;
+        }
+        await node_fs_1.promises.writeFile((0, node_path_1.join)(configDirectoryLocation, `${configFileName}.json`), JSON.stringify(config, null, 2));
+    }
+    catch (error) {
+        logger_1.default.error('Could not open config file for writing.');
+        throw error;
+    }
+}
+exports.writeConfig = writeConfig;
+async function getConfig() {
+    let fileContent;
+    try {
+        fileContent = (await node_fs_1.promises.readFile(configFileLocation)).toString();
+    }
+    catch {
+        logger_1.default.debug(`failed to open config file (${configFileLocation}) for reading.`);
+        logger_1.default.debug('trying to initialize config file');
+        await initializeVibeIQConfig();
+        fileContent = (await node_fs_1.promises.readFile(configFileLocation)).toString();
+    }
+    try {
+        const configFileJSON = JSON.parse(fileContent);
+        return getConfigContent(configFileJSON.configInUse);
+    }
+    catch {
+        logger_1.default.error('Could not parse local vibeiq config.');
+    }
+}
+exports.getConfig = getConfig;
+async function storeConfig(incomingConfig, configName = null, merge = true) {
+    let configContent;
+    if (!configName) {
+        configContent = await getConfig();
+    }
+    else {
+        configContent = await getConfigContent(configName);
+    }
+    let config = {
+        ...configContent,
+        ...incomingConfig,
+    };
+    if (!merge) {
+        config = incomingConfig;
+    }
+    await writeConfig(config, configName);
+}
+exports.storeConfig = storeConfig;
+async function getConfigFiles() {
+    try {
+        const dirContent = (await node_fs_1.promises.readdir(configDirectoryLocation, { withFileTypes: true }))
+            .filter((content) => content.isFile() &&
+            content.name !== configFileName &&
+            (0, node_path_1.parse)(content.name).ext === '.json')
+            .map((content) => (0, node_path_1.parse)(content.name).name);
+        return dirContent;
+    }
+    catch {
+        logger_1.default.error(`Failed to open config directory (${configDirectoryLocation}) for getting files.`);
+    }
+}
+exports.getConfigFiles = getConfigFiles;
+async function getConfigContent(fileName) {
+    const configFilePath = (0, node_path_1.join)(configDirectoryLocation, `${fileName}.json`);
+    let fileContent;
+    try {
+        fileContent = (await node_fs_1.promises.readFile(configFilePath)).toString();
+        return JSON.parse(fileContent);
+    }
+    catch (error) {
+        logger_1.default.error(`Failed to open/parse config file (${fileName}) might be malformed or not found.`);
+    }
+}
+exports.getConfigContent = getConfigContent;
+async function validateEnvironments(envName = null) {
+    if (envName === 'development') {
+        envName = 'dev';
+    }
+    else if (envName === 'production') {
+        envName = 'prod';
+    }
+    if (envName && !exports.ENVIRONMENTS[envName]) {
+        throw new Error(`No environment found with name ${envName}`);
+    }
+    return envName ? exports.ENVIRONMENTS[envName] : true;
+}
+exports.validateEnvironments = validateEnvironments;
+async function checkTelemetry(cliVersion) {
+    try {
+        // TODO: remove comment when api is available so that we don't get errors
+        // const response = await axios.post('https://api.vibeiq.com/prod/api/telemetry/cli', {
+        //   cli_version: cliVersion,
+        // });
+        // const { deprecations, warnings, errors } = response.data;
+        // eg: how the response should look like
+        // const deprecations = [
+        //   { message: 'Deprecation 1' },
+        //   { message: 'Deprecation 2' },
+        //   { message: 'Deprecation 3' },
+        // ];
+        // const warnings = [{ message: 'Warning 1' }, { message: 'Warning 2' }, { message: 'Warning 3' }];
+        // const errors = [{ message: 'Error 1' }, { message: 'Error 2' }, { message: 'Error 3' }];
+        // TODO: Remove the hardcoded data when the API is available
+        const deprecations = [];
+        const warnings = [];
+        const errors = [];
+        if (errors.length > 0) {
+            const latestVersion = '2.4.0'; // TODO: Replace with the latest version of the CLI by calling the API
+            console.error(`Contrail CLI verison ${cliVersion} contains known critical bugs. Please upgrade to version ${latestVersion}.\n\nQuitting the CLI for safety.`);
+            errors.forEach((error) => {
+                logger_1.default.error(`${error.message}`);
+            });
+            const failed_exit_code = 1;
+            process.exit(failed_exit_code);
+        }
+        if (warnings.length > 0) {
+            warnings.forEach((warning) => {
+                logger_1.default.warn(`${warning.message}`);
+            });
+        }
+        if (deprecations.length > 0) {
+            deprecations.forEach((deprecation) => {
+                logger_1.default.warn(`${deprecation.message}`);
+            });
+        }
+    }
+    catch (error) {
+        console.error('Failed to check telemetry:', error.message);
+    }
+}
+exports.checkTelemetry = checkTelemetry;

package/dist/helpers/file-helpers.d.ts

@@ -1,2 +1,2 @@
-export declare function safeFileOverwrite(fileLocation: string, overwrite: boolean): Promise<boolean>;
-export declare function parseCSVData(data: string): any;
+export declare function safeFileOverwrite(fileLocation: string, overwrite: boolean): Promise<boolean>;
+export declare function parseCSVData(data: string): any;

package/dist/helpers/file-helpers.js

@@ -1,36 +1,36 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseCSVData = exports.safeFileOverwrite = void 0;
-const tslib_1 = require("tslib");
-const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
-const logger_1 = tslib_1.__importDefault(require("../logger"));
-const sync_1 = require("csv-parse/sync");
-const PASS_FORCE_TO_OVERWRITE = 'Pass --overwrite to overwrite without prompting';
-//throws an error if the user declines to overwrite the file
-async function safeFileOverwrite(fileLocation, overwrite) {
-    if (overwrite) {
-        logger_1.default.info(`overwriting ${fileLocation}`);
-        return true;
-    }
-    const answers = await inquirer_1.default.prompt([
-        {
-            type: 'confirm',
-            name: 'shouldOverwrite',
-            message: `The file ${fileLocation} already exists. Do you wish to overwrite it?\n${PASS_FORCE_TO_OVERWRITE}`,
-            default: false,
-        },
-    ]);
-    if (!answers.shouldOverwrite) {
-        throw new Error('File was not overwritten. Cancelling process...');
-    }
-}
-exports.safeFileOverwrite = safeFileOverwrite;
-function parseCSVData(data) {
-    return (0, sync_1.parse)(data, {
-        columns: true,
-        skip_empty_lines: true,
-        relax_quotes: true,
-        bom: true,
-    });
-}
-exports.parseCSVData = parseCSVData;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseCSVData = exports.safeFileOverwrite = void 0;
+const tslib_1 = require("tslib");
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+const logger_1 = tslib_1.__importDefault(require("../logger"));
+const sync_1 = require("csv-parse/sync");
+const PASS_FORCE_TO_OVERWRITE = 'Pass --overwrite to overwrite without prompting';
+//throws an error if the user declines to overwrite the file
+async function safeFileOverwrite(fileLocation, overwrite) {
+    if (overwrite) {
+        logger_1.default.info(`overwriting ${fileLocation}`);
+        return true;
+    }
+    const answers = await inquirer_1.default.prompt([
+        {
+            type: 'confirm',
+            name: 'shouldOverwrite',
+            message: `The file ${fileLocation} already exists. Do you wish to overwrite it?\n${PASS_FORCE_TO_OVERWRITE}`,
+            default: false,
+        },
+    ]);
+    if (!answers.shouldOverwrite) {
+        throw new Error('File was not overwritten. Cancelling process...');
+    }
+}
+exports.safeFileOverwrite = safeFileOverwrite;
+function parseCSVData(data) {
+    return (0, sync_1.parse)(data, {
+        columns: true,
+        skip_empty_lines: true,
+        relax_quotes: true,
+        bom: true,
+    });
+}
+exports.parseCSVData = parseCSVData;

package/dist/helpers/load/helpers.d.ts

@@ -1,20 +1,20 @@
-export declare enum FileExtension {
-    JSON = "JSON",
-    YAML = "YAML",
-    CSV = "CSV"
-}
-export declare function readFile(configFileName: any, fileExtensionType?: FileExtension): any;
-export declare function uploadAndLoadLocalFile(incomingFileName: string, configFileName: string): Promise<void>;
-export declare function loadLocalFile(configFileName: string): Promise<void>;
-export declare function getDuplicateFederatedIds(data: any[], federatedIdField: string): string[];
-/**
- * Returns federated IDs that have more than one unique mapping to the groupByField.
- */
-export declare function getConflictingFederatedIdsGroupedByField(data: any[], federatedIdField: string, groupByField: string): string[];
-/**
- * Returns all the conflicting (non-unique) field values when grouped by federated ID.
- */
-export declare function getConflictingFieldForFederatedId(data: any[], federatedIdField: string, field: string): {
-    federatedId: string;
-    values: string[];
-}[];
+export declare enum FileExtension {
+    JSON = "JSON",
+    YAML = "YAML",
+    CSV = "CSV"
+}
+export declare function readFile(configFileName: any, fileExtensionType?: FileExtension): any;
+export declare function uploadAndLoadLocalFile(incomingFileName: string, configFileName: string): Promise<void>;
+export declare function loadLocalFile(configFileName: string): Promise<void>;
+export declare function getDuplicateFederatedIds(data: any[], federatedIdField: string): string[];
+/**
+ * Returns federated IDs that have more than one unique mapping to the groupByField.
+ */
+export declare function getConflictingFederatedIdsGroupedByField(data: any[], federatedIdField: string, groupByField: string): string[];
+/**
+ * Returns all the conflicting (non-unique) field values when grouped by federated ID.
+ */
+export declare function getConflictingFieldForFederatedId(data: any[], federatedIdField: string, field: string): {
+    federatedId: string;
+    values: string[];
+}[];