@contentstack/cli-cm-import 1.28.0 → 2.0.0-beta

package/lib/import/modules/locales.js

@@ -10,13 +10,14 @@ const tslib_1 = require("tslib");
 const path = tslib_1.__importStar(require("path"));
 const lodash_1 = require("lodash");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
-const utils_1 = require("../../utils");
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
+const utils_1 = require("../../utils");
 class ImportLocales extends base_class_1.default {
     constructor({ importConfig, stackAPIClient }) {
         super({ importConfig, stackAPIClient });
         this.config = importConfig;
-        this.config.context.module = 'locales';
+        this.config.context.module = utils_1.MODULE_CONTEXTS.LOCALES;
+        this.currentModuleName = utils_1.MODULE_NAMES[utils_1.MODULE_CONTEXTS.LOCALES];
         this.localeConfig = importConfig.modules.locales;
         this.masterLanguage = importConfig.masterLocale;
         this.masterLanguageConfig = importConfig.modules.masterLocale;
@@ -33,116 +34,65 @@ class ImportLocales extends base_class_1.default {
         this.langUidMapperPath = path.resolve((0, cli_utilities_1.sanitizePath)(this.config.data), 'mapper', 'languages', 'uid-mapper.json');
     }
     async start() {
-        cli_utilities_1.log.debug('Loading locales from file', this.config.context);
-        this.languages = utils_1.fsUtil.readFile(path.join(this.langFolderPath, this.localeConfig.fileName));
-        if (!this.languages || (0, lodash_1.isEmpty)(this.languages)) {
-            cli_utilities_1.log.info('No languages found to import', this.config.context);
-            return;
-        }
-        cli_utilities_1.log.debug(`Found ${(0, lodash_1.values)(this.languages).length} languages to import`, this.config.context);
-        cli_utilities_1.log.debug('Loading source master language configuration', this.config.context);
-        this.sourceMasterLanguage = utils_1.fsUtil.readFile(path.join(this.langFolderPath, this.masterLanguageConfig.fileName));
-        cli_utilities_1.log.debug('Loaded source master language configuration', this.config.context);
-        cli_utilities_1.log.debug('Creating languages mapper directory', this.config.context);
-        await utils_1.fileHelper.makeDirectory(this.langMapperPath);
-        cli_utilities_1.log.debug('Created languages mapper directory', this.config.context);
-        cli_utilities_1.log.debug('Loading existing language UID mappings', this.config.context);
-        if (utils_1.fileHelper.fileExistsSync(this.langUidMapperPath)) {
-            this.langUidMapper = utils_1.fsUtil.readFile(this.langUidMapperPath) || {};
-            const langUidCount = Object.keys(this.langUidMapper || {}).length;
-            cli_utilities_1.log.debug(`Loaded existing language UID data: ${langUidCount} items`, this.config.context);
-        }
-        else {
-            cli_utilities_1.log.debug('No existing language UID mappings found', this.config.context);
+        try {
+            cli_utilities_1.log.debug('Starting locales import process...', this.config.context);
+            const [localesCount] = await this.analyzeLocales();
+            if (localesCount === 0) {
+                cli_utilities_1.log.info('No languages found to import', this.config.context);
+                return;
+            }
+            const progress = this.setupLocalesProgress(localesCount);
+            this.prepareLocalesMapper();
+            await this.processMasterLocale(progress);
+            await this.processLocaleCreation(progress);
+            await this.processLocaleUpdate(progress);
+            cli_utilities_1.log.debug('Writing failed locales to file', this.config.context);
+            utils_1.fsUtil.writeFile(this.langFailsPath, this.failedLocales);
+            cli_utilities_1.log.debug(`Written ${this.failedLocales.length} failed locales to file`, this.config.context);
+            this.completeProgress(true);
+            cli_utilities_1.log.success('Languages have been imported successfully!', this.config.context);
         }
-        cli_utilities_1.log.debug('Checking and updating master locale', this.config.context);
-        await this.checkAndUpdateMasterLocale().catch((error) => {
-            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.config.context));
-        });
-        cli_utilities_1.log.debug('Creating locales', this.config.context);
-        await this.createLocales().catch((error) => {
-            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.config.context));
-            Promise.reject('Failed to import locales');
-        });
-        cli_utilities_1.log.debug('Writing failed locales to file', this.config.context);
-        utils_1.fsUtil.writeFile(this.langFailsPath, this.failedLocales);
-        cli_utilities_1.log.debug(`Written ${this.failedLocales.length} failed locales to file`, this.config.context);
-        cli_utilities_1.log.debug('Updating locales', this.config.context);
-        await this.updateLocales().catch((error) => {
+        catch (error) {
+            this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Locales import failed');
             (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.config.context));
-            Promise.reject('Failed to update locales');
-        });
-        cli_utilities_1.log.success('Languages have been imported successfully!', this.config.context);
+        }
     }
     async checkAndUpdateMasterLocale() {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c;
         cli_utilities_1.log.debug('Checking and updating master locale', this.config.context);
-        let sourceMasterLangDetails = (this.sourceMasterLanguage && Object.values(this.sourceMasterLanguage)) || [];
-        cli_utilities_1.log.debug(`Source master language details count: ${sourceMasterLangDetails.length}`, this.config.context);
-        if (((_a = sourceMasterLangDetails === null || sourceMasterLangDetails === void 0 ? void 0 : sourceMasterLangDetails[0]) === null || _a === void 0 ? void 0 : _a.code) === ((_b = this.masterLanguage) === null || _b === void 0 ? void 0 : _b.code)) {
-            cli_utilities_1.log.debug(`Master locale code matches: ${(_c = this.masterLanguage) === null || _c === void 0 ? void 0 : _c.code}`, this.config.context);
-            cli_utilities_1.log.debug('Fetching current master language details from stack', this.config.context);
-            let masterLangDetails = await this.stackAPIClient
-                .locale(this.masterLanguage['code'])
-                .fetch()
-                .catch((error) => {
-                cli_utilities_1.log.debug('Error fetching master language details', this.config.context);
-                (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.config.context));
-            });
-            if (((_d = masterLangDetails === null || masterLangDetails === void 0 ? void 0 : masterLangDetails.name) === null || _d === void 0 ? void 0 : _d.toString().toUpperCase()) !==
-                ((_e = sourceMasterLangDetails[0]['name']) === null || _e === void 0 ? void 0 : _e.toString().toUpperCase())) {
-                cli_utilities_1.log.debug('Master language name differs between source and destination', this.config.context);
-                cli_utilities_1.log.debug(`Current master language name: ${masterLangDetails['name']}`, this.config.context);
-                cli_utilities_1.log.debug(`Source master language name: ${sourceMasterLangDetails[0]['name']}`, this.config.context);
-                cli_utilities_1.cliux.print('WARNING!!! The master language name for the source and destination is different.', {
-                    color: 'yellow',
-                });
-                cli_utilities_1.cliux.print(`Old Master language name: ${masterLangDetails['name']}`, { color: 'red' });
-                cli_utilities_1.cliux.print(`New Master language name: ${sourceMasterLangDetails[0]['name']}`, { color: 'green' });
-                const langUpdateConfirmation = await cli_utilities_1.cliux.inquire({
-                    type: 'confirm',
-                    message: 'Are you sure you want to update name of master language?',
-                    name: 'confirmation',
-                });
-                if (langUpdateConfirmation) {
-                    cli_utilities_1.log.debug('User confirmed master language name update', this.config.context);
-                    let langUid = sourceMasterLangDetails[0] && sourceMasterLangDetails[0]['uid'];
-                    let sourceMasterLanguage = this.sourceMasterLanguage[langUid];
-                    if (!sourceMasterLanguage) {
-                        cli_utilities_1.log.info(`Master language details not found with id ${langUid} to update`, this.config.context);
-                    }
-                    cli_utilities_1.log.debug(`Updating master language name: ${sourceMasterLanguage.name}`, this.config.context);
-                    const langUpdateRequest = this.stackAPIClient.locale(sourceMasterLanguage.code);
-                    langUpdateRequest.name = sourceMasterLanguage.name;
-                    await langUpdateRequest.update().catch(function (error) {
-                        cli_utilities_1.log.debug('Error updating master language name', this.config.context);
-                        (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.config.context));
-                    });
-                    cli_utilities_1.log.success('Master Languages name have been updated successfully!', this.config.context);
-                }
-                else {
-                    cli_utilities_1.log.debug('User declined master language name update', this.config.context);
-                }
-            }
-            else {
-                cli_utilities_1.log.debug('Master language names match, no update needed', this.config.context);
-            }
+        const sourceMasterLangDetails = this.getSourceMasterLangDetails();
+        if (!sourceMasterLangDetails)
+            return;
+        if (((_a = this.masterLanguage) === null || _a === void 0 ? void 0 : _a.code) !== (sourceMasterLangDetails === null || sourceMasterLangDetails === void 0 ? void 0 : sourceMasterLangDetails.code)) {
+            this.logCodeMismatch(sourceMasterLangDetails.code);
+            return;
         }
-        else {
-            cli_utilities_1.log.debug('Master language codes do not match', this.config.context);
+        cli_utilities_1.log.debug(`Master locale code matches: ${this.masterLanguage.code}`, this.config.context);
+        const masterLangDetails = await this.fetchTargetMasterLocale();
+        if (!masterLangDetails)
+            return;
+        if (((_b = masterLangDetails === null || masterLangDetails === void 0 ? void 0 : masterLangDetails.name) === null || _b === void 0 ? void 0 : _b.toString().toUpperCase()) === ((_c = sourceMasterLangDetails['name']) === null || _c === void 0 ? void 0 : _c.toString().toUpperCase())) {
+            this.tickProgress(true, `${masterLangDetails.name} (no update needed)`);
+            cli_utilities_1.log.debug('Master language names match, no update required', this.config.context);
+            return;
         }
+        await this.handleNameMismatch(sourceMasterLangDetails, masterLangDetails);
     }
     async createLocales() {
         const languagesToCreate = (0, lodash_1.filter)((0, lodash_1.values)(this.languages), (lang) => lang.code !== this.masterLanguage.code);
         cli_utilities_1.log.debug(`Creating ${languagesToCreate.length} locales (excluding master locale)`, this.config.context);
         const onSuccess = ({ response = {}, apiData: { uid, code } = undefined }) => {
+            var _a;
             this.langUidMapper[uid] = response.uid;
             this.createdLocales.push((0, lodash_1.pick)(response, [...this.localeConfig.requiredKeys]));
+            (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.tick(true, `locale: ${code}`, null, utils_1.PROCESS_NAMES.LOCALES_CREATE);
             cli_utilities_1.log.info(`Created locale: '${code}'`, this.config.context);
             cli_utilities_1.log.debug(`Locale UID mapping: ${uid} → ${response.uid}`, this.config.context);
             utils_1.fsUtil.writeFile(this.langUidMapperPath, this.langUidMapper);
         };
         const onReject = ({ error, apiData: { uid, code } = undefined }) => {
+            var _a;
+            (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.tick(false, `locale: ${code}`, (error === null || error === void 0 ? void 0 : error.message) || `Language '${code}' failed to import`, utils_1.PROCESS_NAMES.LOCALES_CREATE);
             if ((error === null || error === void 0 ? void 0 : error.errorCode) === 247) {
                 cli_utilities_1.log.info((0, utils_1.formatError)(error), this.config.context);
             }
@@ -167,17 +117,21 @@ class ImportLocales extends base_class_1.default {
     async updateLocales() {
         cli_utilities_1.log.debug(`Updating ${(0, lodash_1.values)(this.languages).length} locales`, this.config.context);
         const onSuccess = ({ response = {}, apiData: { uid, code } = undefined }) => {
+            var _a;
             cli_utilities_1.log.info(`Updated locale: '${code}'`, this.config.context);
             cli_utilities_1.log.debug(`Locale update completed for: ${code}`, this.config.context);
+            (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.tick(true, `locale: ${code}`, null, utils_1.PROCESS_NAMES.LOCALES_UPDATE);
             utils_1.fsUtil.writeFile(this.langSuccessPath, this.createdLocales);
         };
         const onReject = ({ error, apiData: { uid, code } = undefined }) => {
+            var _a;
+            (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.tick(false, `locale: ${code}`, `Failed to update locale ${code}`, utils_1.PROCESS_NAMES.LOCALES_UPDATE);
             cli_utilities_1.log.error(`Language '${code}' failed to update`, this.config.context);
             (0, cli_utilities_1.handleAndLogError)(error, Object.assign(Object.assign({}, this.config.context), { code }));
             utils_1.fsUtil.writeFile(this.langFailsPath, this.failedLocales);
         };
         return await this.makeConcurrentCall({
-            processName: 'Update locales',
+            processName: 'Locale Update locales',
             apiContent: (0, lodash_1.values)(this.languages),
             apiParams: {
                 reject: onReject.bind(this),
@@ -188,5 +142,151 @@ class ImportLocales extends base_class_1.default {
             concurrencyLimit: this.reqConcurrency,
         });
     }
+    async analyzeLocales() {
+        return this.withLoadingSpinner('LOCALES: Analyzing import data...', async () => {
+            var _a;
+            cli_utilities_1.log.debug('Loading locales from file', this.config.context);
+            this.languages = utils_1.fsUtil.readFile(path.join(this.langFolderPath, this.localeConfig.fileName));
+            if (!this.languages || (0, lodash_1.isEmpty)(this.languages)) {
+                cli_utilities_1.log.info('No languages found to import', this.config.context);
+                return [0];
+            }
+            this.sourceMasterLanguage = utils_1.fsUtil.readFile(path.join(this.langFolderPath, this.masterLanguageConfig.fileName));
+            cli_utilities_1.log.debug('Loaded source master language configuration', this.config.context);
+            const localesCount = (_a = (0, lodash_1.keys)(this.languages || {})) === null || _a === void 0 ? void 0 : _a.length;
+            cli_utilities_1.log.debug(`Found ${localesCount} languages to import`, this.config.context);
+            return [localesCount];
+        });
+    }
+    setupLocalesProgress(localesCount) {
+        const progress = this.createNestedProgress(this.currentModuleName);
+        progress.addProcess(utils_1.PROCESS_NAMES.MASTER_LOCALE, 1);
+        if (localesCount > 0) {
+            progress.addProcess(utils_1.PROCESS_NAMES.LOCALES_CREATE, localesCount);
+            progress.addProcess(utils_1.PROCESS_NAMES.LOCALES_UPDATE, localesCount);
+        }
+        return progress;
+    }
+    async prepareLocalesMapper() {
+        cli_utilities_1.log.debug('Creating languages mapper directory', this.config.context);
+        utils_1.fileHelper.makeDirectory(this.langMapperPath);
+        cli_utilities_1.log.debug('Created languages mapper directory', this.config.context);
+        if (utils_1.fileHelper.fileExistsSync(this.langUidMapperPath)) {
+            this.langUidMapper = utils_1.fsUtil.readFile(this.langUidMapperPath) || {};
+            const langUidCount = Object.keys(this.langUidMapper || {}).length;
+            cli_utilities_1.log.debug(`Loaded existing language UID data: ${langUidCount} items`, this.config.context);
+        }
+        else {
+            cli_utilities_1.log.debug('No existing language UID mappings found', this.config.context);
+        }
+    }
+    async processMasterLocale(progress) {
+        progress
+            .startProcess(utils_1.PROCESS_NAMES.MASTER_LOCALE)
+            .updateStatus(utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.MASTER_LOCALE].PROCESSING, utils_1.PROCESS_NAMES.MASTER_LOCALE);
+        cli_utilities_1.log.debug('Checking and updating master locale', this.config.context);
+        try {
+            await this.checkAndUpdateMasterLocale();
+            progress.completeProcess(utils_1.PROCESS_NAMES.MASTER_LOCALE, true);
+        }
+        catch (error) {
+            progress.completeProcess(utils_1.PROCESS_NAMES.MASTER_LOCALE, false);
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.config.context));
+        }
+    }
+    async processLocaleCreation(progress) {
+        progress
+            .startProcess(utils_1.PROCESS_NAMES.LOCALES_CREATE)
+            .updateStatus(utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.LOCALES_CREATE].CREATING, utils_1.PROCESS_NAMES.LOCALES_CREATE);
+        cli_utilities_1.log.debug('Creating locales', this.config.context);
+        try {
+            await this.createLocales();
+            progress.completeProcess(utils_1.PROCESS_NAMES.LOCALES_CREATE, true);
+        }
+        catch (error) {
+            progress.completeProcess(utils_1.PROCESS_NAMES.LOCALES_CREATE, false);
+            throw error;
+        }
+    }
+    async processLocaleUpdate(progress) {
+        progress
+            .startProcess(utils_1.PROCESS_NAMES.LOCALES_UPDATE)
+            .updateStatus(utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.LOCALES_UPDATE].UPDATING, utils_1.PROCESS_NAMES.LOCALES_UPDATE);
+        cli_utilities_1.log.debug('Updating locales', this.config.context);
+        try {
+            await this.updateLocales();
+            progress.completeProcess(utils_1.PROCESS_NAMES.LOCALES_UPDATE, true);
+        }
+        catch (error) {
+            progress.completeProcess(utils_1.PROCESS_NAMES.LOCALES_UPDATE, false);
+            throw error;
+        }
+    }
+    getSourceMasterLangDetails() {
+        const details = this.sourceMasterLanguage && Object.values(this.sourceMasterLanguage);
+        const lang = details === null || details === void 0 ? void 0 : details[0];
+        if (!lang) {
+            cli_utilities_1.log.info('No source master language details found', this.config.context);
+            return null;
+        }
+        return lang;
+    }
+    async fetchTargetMasterLocale() {
+        try {
+            cli_utilities_1.log.debug('Fetching current master language details from stack', this.config.context);
+            return await this.stackAPIClient.locale(this.masterLanguage.code).fetch();
+        }
+        catch (error) {
+            cli_utilities_1.log.debug('Error fetching master language details', this.config.context);
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.config.context));
+            return null;
+        }
+    }
+    logCodeMismatch(sourceCode) {
+        var _a;
+        const targetCode = (_a = this.masterLanguage) === null || _a === void 0 ? void 0 : _a.code;
+        const message = `master locale: codes differ (${sourceCode} vs ${targetCode})`;
+        this.tickProgress(true, message);
+        cli_utilities_1.log.debug(`Master Locale language codes do not match. Source: ${sourceCode}, Target: ${targetCode}`, this.config.context);
+    }
+    async handleNameMismatch(source, target) {
+        cli_utilities_1.log.debug('Master Locale language name differs between source and destination', this.config.context);
+        cli_utilities_1.log.debug(`Current: ${target.name}, Source: ${source.name}`, this.config.context);
+        cli_utilities_1.cliux.print('WARNING!!! The master language name for the source and destination is different.', {
+            color: 'yellow',
+        });
+        cli_utilities_1.cliux.print('WARNING!!! The master language name for the source and destination is different.', {
+            color: 'yellow',
+        });
+        cli_utilities_1.cliux.print(`Old Master Locale language name: ${target.name}`, { color: 'red' });
+        cli_utilities_1.cliux.print(`New Master Locale language name: ${source.name}`, { color: 'green' });
+        const langUpdateConfirmation = await cli_utilities_1.cliux.inquire({
+            type: 'confirm',
+            message: 'Are you sure you want to update name of master language?',
+            name: 'confirmation',
+        });
+        if (!langUpdateConfirmation) {
+            this.tickProgress(true, `${target.name} (skipped update)`);
+            cli_utilities_1.log.info('Master Locale language update cancelled by user', this.config.context);
+            return;
+        }
+        cli_utilities_1.log.debug('User confirmed master language update', this.config.context);
+        try {
+            const updatePayload = Object.assign(Object.assign({}, source), { uid: target.uid });
+            const langUpdateRequest = this.stackAPIClient.locale(source.code);
+            langUpdateRequest.name = source.name;
+            await langUpdateRequest.update(updatePayload);
+            this.tickProgress(true, `${source.name} (updated)`);
+            cli_utilities_1.log.success(`Successfully updated master language name from '${target.name}' to '${source.name}'`, this.config.context);
+        }
+        catch (error) {
+            this.tickProgress(false, source === null || source === void 0 ? void 0 : source.name, (error === null || error === void 0 ? void 0 : error.message) || 'Failed to update master locale');
+            throw error;
+        }
+    }
+    tickProgress(success, message, error) {
+        var _a;
+        (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.tick(success, `master locale: ${message}`, error || null, utils_1.PROCESS_NAMES.MASTER_LOCALE);
+    }
 }
 exports.default = ImportLocales;

package/lib/import/modules/marketplace-apps.d.ts

@@ -1,7 +1,7 @@
 import { NodeCrypto, ContentstackMarketplaceClient } from '@contentstack/cli-utilities';
 import { ModuleClassParams, ImportConfig, Installation, Manifest } from '../../types';
-export default class ImportMarketplaceApps {
-    importConfig: ImportConfig;
+import BaseClass from './base-class';
+export default class ImportMarketplaceApps extends BaseClass {
     private mapperDirPath;
     private marketPlaceFolderPath;
     private marketPlaceUidMapperPath;
@@ -16,7 +16,7 @@ export default class ImportMarketplaceApps {
     nodeCrypto: NodeCrypto;
     appSdk: ContentstackMarketplaceClient;
     existingNames: Set<string>;
-    constructor({ importConfig }: ModuleClassParams);
+    constructor({ importConfig, stackAPIClient }: ModuleClassParams);
     /**
      * This function starts the process of importing marketplace apps.
      * @returns The function `start()` returns a `Promise<void>`.
@@ -125,4 +125,7 @@ export default class ImportMarketplaceApps {
      * app. It contains the following properties:
      */
     updateAppsConfig(app: Installation): Promise<void>;
+    private analyzeMarketplaceApps;
+    private prepareMarketplaceAppMapper;
+    private setupMarketplaceEnvironment;
 }