@contentstack/cli-cm-import-setup 1.7.2 → 2.0.0-beta.2

package/lib/import/modules/entries.js

@@ -1,20 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const utils_1 = require("../../utils");
 const base_setup_1 = tslib_1.__importDefault(require("./base-setup"));
-const cli_utilities_1 = require("@contentstack/cli-utilities");
+const utils_2 = require("../../utils");
 class EntriesImportSetup extends base_setup_1.default {
     constructor(options) {
         super(options);
-        this.initializeContext('entries');
+        this.currentModuleName = utils_2.MODULE_NAMES[utils_2.MODULE_CONTEXTS.ENTRIES];
     }
     async start() {
+        var _a;
         try {
+            const progress = this.createSimpleProgress(this.currentModuleName, 1);
+            progress.updateStatus('Setting up dependencies...');
             await this.setupDependencies();
-            cli_utilities_1.log.success(`The required setup files for entries have been generated successfully.`);
+            (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.tick(true, 'entries mapper setup', null);
+            this.completeProgress(true);
+            (0, utils_1.log)(this.config, `The required setup files for entries have been generated successfully.`, 'success');
         }
         catch (error) {
-            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.config.context), 'Error occurred while generating the entry mapper');
+            this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Entries mapper generation failed');
+            (0, utils_1.log)(this.config, `Error occurred while generating the entry mapper: ${error.message}.`, 'error');
         }
     }
 }

package/lib/import/modules/extensions.d.ts

@@ -1,15 +1,12 @@
 import { ModuleClassParams } from '../../types';
-export default class ExtensionImportSetup {
-    private config;
+import BaseImportSetup from './base-setup';
+export default class ExtensionImportSetup extends BaseImportSetup {
     private extensionsFilePath;
     private extensionMapper;
-    private stackAPIClient;
-    private dependencies;
     private extensionsConfig;
-    private mapperDirPath;
     private extensionsFolderPath;
     private extUidMapperPath;
-    constructor({ config, stackAPIClient, dependencies }: ModuleClassParams);
+    constructor({ config, stackAPIClient }: ModuleClassParams);
     /**
      * Start the extension import setup
      * This method reads the extensions from the content folder and generates a mapper file

package/lib/import/modules/extensions.js

@@ -1,16 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
 const utils_1 = require("../../utils");
 const path_1 = require("path");
 const lodash_1 = require("lodash");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
-class ExtensionImportSetup {
-    constructor({ config, stackAPIClient, dependencies }) {
-        this.config = config;
-        if (this.config.context) {
-            this.config.context.module = 'extensions';
-        }
-        this.stackAPIClient = stackAPIClient;
+const base_setup_1 = tslib_1.__importDefault(require("./base-setup"));
+const utils_2 = require("../../utils");
+class ExtensionImportSetup extends base_setup_1.default {
+    constructor({ config, stackAPIClient }) {
+        super({ config, stackAPIClient, dependencies: [] });
+        this.currentModuleName = utils_2.MODULE_NAMES[utils_2.MODULE_CONTEXTS.EXTENSIONS];
         this.extensionsFilePath = (0, path_1.join)((0, cli_utilities_1.sanitizePath)(this.config.contentDir), 'extensions', 'extensions.json');
         this.extensionsConfig = config.modules.extensions;
         this.extUidMapperPath = (0, path_1.join)((0, cli_utilities_1.sanitizePath)(this.config.backupDir), 'mapper', 'extensions', 'uid-mapping.json');
@@ -22,33 +22,49 @@ class ExtensionImportSetup {
      * @returns {Promise<void>}
      */
     async start() {
+        var _a, _b, _c;
         try {
-            if (!utils_1.fileHelper.fileExistsSync(this.extensionsFilePath)) {
-                cli_utilities_1.log.info('No extensions found in the content folder.');
-                return;
-            }
-            const extensions = await utils_1.fsUtil.readFile(this.extensionsFilePath);
+            const extensions = await this.withLoadingSpinner('EXTENSIONS: Analyzing import data...', async () => {
+                return await utils_1.fsUtil.readFile(this.extensionsFilePath);
+            });
             if (!(0, lodash_1.isEmpty)(extensions)) {
-                // 2. Create mapper directory
+                const extensionsArray = Object.values(extensions);
+                const progress = this.createNestedProgress(this.currentModuleName);
+                // Add process
+                progress.addProcess(utils_2.PROCESS_NAMES.EXTENSIONS_MAPPER_GENERATION, extensionsArray.length);
+                // Create mapper directory
                 const mapperFilePath = (0, path_1.join)((0, cli_utilities_1.sanitizePath)(this.config.backupDir), 'mapper', 'extensions');
-                utils_1.fsUtil.makeDirectory(mapperFilePath); // Use fsUtil
-                for (const extension of Object.values(extensions)) {
-                    const targetExtension = await this.getExtension(extension);
-                    if (!targetExtension) {
-                        cli_utilities_1.log.info(`Extension with the title '${extension.title}' not found in the stack.`);
-                        continue;
+                utils_1.fsUtil.makeDirectory(mapperFilePath);
+                progress
+                    .startProcess(utils_2.PROCESS_NAMES.EXTENSIONS_MAPPER_GENERATION)
+                    .updateStatus(utils_2.PROCESS_STATUS.EXTENSIONS_MAPPER_GENERATION.GENERATING, utils_2.PROCESS_NAMES.EXTENSIONS_MAPPER_GENERATION);
+                for (const extension of extensionsArray) {
+                    try {
+                        const targetExtension = await this.getExtension(extension);
+                        if (!targetExtension) {
+                            (0, utils_1.log)(this.config, `Extension with the title '${extension.title}' not found in the stack.`, 'info');
+                            (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.tick(false, `extension: ${extension.title}`, 'Not found in stack', utils_2.PROCESS_NAMES.EXTENSIONS_MAPPER_GENERATION);
+                            continue;
+                        }
+                        this.extensionMapper[extension.uid] = targetExtension.uid;
+                        (_b = this.progressManager) === null || _b === void 0 ? void 0 : _b.tick(true, `extension: ${extension.title}`, null, utils_2.PROCESS_NAMES.EXTENSIONS_MAPPER_GENERATION);
+                    }
+                    catch (error) {
+                        (_c = this.progressManager) === null || _c === void 0 ? void 0 : _c.tick(false, `extension: ${extension.title}`, (0, cli_utilities_1.formatError)(error), utils_2.PROCESS_NAMES.EXTENSIONS_MAPPER_GENERATION);
                     }
-                    this.extensionMapper[extension.uid] = targetExtension.uid;
                 }
                 await utils_1.fsUtil.writeFile(this.extUidMapperPath, this.extensionMapper);
-                cli_utilities_1.log.success(`The required setup files for extensions have been generated successfully.`);
+                progress.completeProcess(utils_2.PROCESS_NAMES.EXTENSIONS_MAPPER_GENERATION, true);
+                this.completeProgress(true);
+                (0, utils_1.log)(this.config, `The required setup files for extensions have been generated successfully.`, 'success');
             }
             else {
-                cli_utilities_1.log.info('No extensions found in the content folder.');
+                (0, utils_1.log)(this.config, 'No extensions found in the content folder.', 'info');
             }
         }
         catch (error) {
-            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.config.context), 'Error occurred while generating the extension mapper');
+            this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Extensions mapper generation failed');
+            (0, utils_1.log)(this.config, `Error occurred while generating the extension mapper: ${(0, cli_utilities_1.formatError)(error)}.`, 'error');
         }
     }
     async getExtension(extension) {

package/lib/import/modules/global-fields.js

@@ -1,20 +1,42 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const utils_1 = require("../../utils");
 const base_setup_1 = tslib_1.__importDefault(require("./base-setup"));
-const cli_utilities_1 = require("@contentstack/cli-utilities");
+const utils_2 = require("../../utils");
 class GlobalFieldsImportSetup extends base_setup_1.default {
     constructor(options) {
         super(options);
-        this.initializeContext('global-fields');
+        this.currentModuleName = utils_2.MODULE_NAMES[utils_2.MODULE_CONTEXTS.GLOBAL_FIELDS];
     }
     async start() {
+        var _a, _b, _c;
         try {
-            await this.setupDependencies();
-            cli_utilities_1.log.success(`The required setup files for global fields have been generated successfully.`);
+            const progress = this.createNestedProgress(this.currentModuleName);
+            // Add processes
+            progress.addProcess(utils_2.PROCESS_NAMES.GLOBAL_FIELDS_DEPENDENCY_SETUP, ((_a = this.dependencies) === null || _a === void 0 ? void 0 : _a.length) || 0);
+            progress.addProcess(utils_2.PROCESS_NAMES.GLOBAL_FIELDS_MAPPER_GENERATION, 1);
+            // Setup dependencies
+            if (this.dependencies && this.dependencies.length > 0) {
+                progress
+                    .startProcess(utils_2.PROCESS_NAMES.GLOBAL_FIELDS_DEPENDENCY_SETUP)
+                    .updateStatus(utils_2.PROCESS_STATUS.GLOBAL_FIELDS_DEPENDENCY_SETUP.SETTING_UP, utils_2.PROCESS_NAMES.GLOBAL_FIELDS_DEPENDENCY_SETUP);
+                await this.setupDependencies();
+                (_b = this.progressManager) === null || _b === void 0 ? void 0 : _b.tick(true, 'dependencies setup', null, utils_2.PROCESS_NAMES.GLOBAL_FIELDS_DEPENDENCY_SETUP);
+                progress.completeProcess(utils_2.PROCESS_NAMES.GLOBAL_FIELDS_DEPENDENCY_SETUP, true);
+            }
+            // Mapper generation
+            progress
+                .startProcess(utils_2.PROCESS_NAMES.GLOBAL_FIELDS_MAPPER_GENERATION)
+                .updateStatus(utils_2.PROCESS_STATUS.GLOBAL_FIELDS_MAPPER_GENERATION.GENERATING, utils_2.PROCESS_NAMES.GLOBAL_FIELDS_MAPPER_GENERATION);
+            (_c = this.progressManager) === null || _c === void 0 ? void 0 : _c.tick(true, 'mapper generation', null, utils_2.PROCESS_NAMES.GLOBAL_FIELDS_MAPPER_GENERATION);
+            progress.completeProcess(utils_2.PROCESS_NAMES.GLOBAL_FIELDS_MAPPER_GENERATION, true);
+            this.completeProgress(true);
+            (0, utils_1.log)(this.config, `The required setup files for global fields have been generated successfully.`, 'success');
         }
         catch (error) {
-            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.config.context), 'Error occurred while generating the global field mapper');
+            this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Global fields mapper generation failed');
+            (0, utils_1.log)(this.config, `Error occurred while generating the global field mapper: ${error.message}.`, 'error');
         }
     }
 }

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

@@ -1,11 +1,9 @@
 import { ModuleClassParams } from '../../types';
 import { ContentstackMarketplaceClient, NodeCrypto } from '@contentstack/cli-utilities';
-export default class marketplaceAppImportSetup {
-    private config;
+import BaseImportSetup from './base-setup';
+export default class marketplaceAppImportSetup extends BaseImportSetup {
     private marketplaceAppsFilePath;
     private marketplaceAppMapper;
-    private stackAPIClient;
-    private dependencies;
     private marketplaceAppsConfig;
     private mapperDirPath;
     private marketplaceAppsFolderPath;
@@ -14,7 +12,7 @@ export default class marketplaceAppImportSetup {
     marketplaceAppPath: string;
     nodeCrypto: NodeCrypto;
     appSdk: ContentstackMarketplaceClient;
-    constructor({ config, stackAPIClient, dependencies }: ModuleClassParams);
+    constructor({ config, stackAPIClient }: ModuleClassParams);
     /**
      * Start the marketplaceApp import setup
      * This method reads the marketplaceApps from the content folder and generates a mapper file

package/lib/import/modules/marketplace-apps.js

@@ -1,16 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
 const utils_1 = require("../../utils");
 const path_1 = require("path");
 const lodash_1 = require("lodash");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
-class marketplaceAppImportSetup {
-    constructor({ config, stackAPIClient, dependencies }) {
-        this.config = config;
-        if (this.config.context) {
-            this.config.context.module = 'marketplace-apps';
-        }
-        this.stackAPIClient = stackAPIClient;
+const base_setup_1 = tslib_1.__importDefault(require("./base-setup"));
+const utils_2 = require("../../utils");
+class marketplaceAppImportSetup extends base_setup_1.default {
+    constructor({ config, stackAPIClient }) {
+        super({ config, stackAPIClient, dependencies: [] });
+        this.currentModuleName = utils_2.MODULE_NAMES[utils_2.MODULE_CONTEXTS.MARKETPLACE_APPS];
         this.marketplaceAppsFilePath = (0, path_1.join)((0, cli_utilities_1.sanitizePath)(this.config.contentDir), 'marketplace_apps', 'marketplace_apps.json');
         this.marketplaceAppsConfig = config.modules['marketplace-apps'];
         this.marketplaceAppsUidMapperPath = (0, path_1.join)((0, cli_utilities_1.sanitizePath)(this.config.backupDir), 'mapper', 'marketplace_apps');
@@ -22,29 +22,47 @@ class marketplaceAppImportSetup {
      * @returns {Promise<void>}
      */
     async start() {
+        var _a, _b;
         try {
-            if (!utils_1.fileHelper.fileExistsSync(this.marketplaceAppsFilePath)) {
-                cli_utilities_1.log.info('No Marketplace apps found in the content folder.');
-                return;
-            }
-            const sourceMarketplaceApps = await utils_1.fsUtil.readFile(this.marketplaceAppsFilePath);
+            const sourceMarketplaceApps = await this.withLoadingSpinner('MARKETPLACE APPS: Analyzing import data...', async () => {
+                return await utils_1.fsUtil.readFile(this.marketplaceAppsFilePath);
+            });
             if (!(0, lodash_1.isEmpty)(sourceMarketplaceApps)) {
-                utils_1.fsUtil.makeDirectory(this.marketplaceAppsUidMapperPath); // Use fsUtil
+                const appsArray = Array.isArray(sourceMarketplaceApps) ? sourceMarketplaceApps : Object.values(sourceMarketplaceApps);
+                const progress = this.createNestedProgress(this.currentModuleName);
+                // Add processes
+                progress.addProcess(utils_2.PROCESS_NAMES.MARKETPLACE_APPS_MAPPER_GENERATION, 1);
+                progress.addProcess(utils_2.PROCESS_NAMES.MARKETPLACE_APPS_FETCH, appsArray.length);
+                // Create mapper directory
+                progress
+                    .startProcess(utils_2.PROCESS_NAMES.MARKETPLACE_APPS_MAPPER_GENERATION)
+                    .updateStatus(utils_2.PROCESS_STATUS.MARKETPLACE_APPS_MAPPER_GENERATION.GENERATING, utils_2.PROCESS_NAMES.MARKETPLACE_APPS_MAPPER_GENERATION);
+                utils_1.fsUtil.makeDirectory(this.marketplaceAppsUidMapperPath);
+                (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.tick(true, 'mapper directory created', null, utils_2.PROCESS_NAMES.MARKETPLACE_APPS_MAPPER_GENERATION);
+                progress.completeProcess(utils_2.PROCESS_NAMES.MARKETPLACE_APPS_MAPPER_GENERATION, true);
+                // Fetch marketplace apps
+                progress
+                    .startProcess(utils_2.PROCESS_NAMES.MARKETPLACE_APPS_FETCH)
+                    .updateStatus(utils_2.PROCESS_STATUS.MARKETPLACE_APPS_FETCH.FETCHING, utils_2.PROCESS_NAMES.MARKETPLACE_APPS_FETCH);
                 this.developerHubBaseUrl = this.config.developerHubBaseUrl || (await (0, cli_utilities_1.createDeveloperHubUrl)(this.config.host));
                 // NOTE init marketplace app sdk
                 const host = this.developerHubBaseUrl.split('://').pop();
                 this.appSdk = await (0, cli_utilities_1.marketplaceSDKClient)({ host });
                 const targetMarketplaceApps = await this.getMarketplaceApps();
+                (_b = this.progressManager) === null || _b === void 0 ? void 0 : _b.tick(true, 'marketplace apps fetched', null, utils_2.PROCESS_NAMES.MARKETPLACE_APPS_FETCH);
                 this.createMapper(sourceMarketplaceApps, targetMarketplaceApps);
                 await utils_1.fsUtil.writeFile((0, path_1.join)(this.marketplaceAppsUidMapperPath, 'uid-mapping.json'), this.marketplaceAppMapper);
-                cli_utilities_1.log.success(`The required setup files for Marketplace apps have been generated successfully.`);
+                progress.completeProcess(utils_2.PROCESS_NAMES.MARKETPLACE_APPS_FETCH, true);
+                this.completeProgress(true);
+                (0, utils_1.log)(this.config, `The required setup files for Marketplace apps have been generated successfully.`, 'success');
             }
             else {
-                cli_utilities_1.log.info('No Marketplace apps found in the content folder.');
+                (0, utils_1.log)(this.config, 'No Marketplace apps found in the content folder.', 'info');
             }
         }
         catch (error) {
-            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.config.context), 'Error occurred while generating the Marketplace app mapper');
+            this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Marketplace apps mapper generation failed');
+            (0, utils_1.log)(this.config, `Error occurred while generating the Marketplace app mapper: ${error.message}.`, 'error');
         }
     }
     async getMarketplaceApps() {
@@ -61,7 +79,9 @@ class marketplaceAppImportSetup {
         });
     }
     createMapper(sourceMarketplaceApps, targetMarketplaceApps) {
-        sourceMarketplaceApps.forEach((sourceApp) => {
+        const appsArray = Array.isArray(sourceMarketplaceApps) ? sourceMarketplaceApps : Object.values(sourceMarketplaceApps);
+        appsArray.forEach((sourceApp) => {
+            var _a, _b;
             // Find matching target item based on manifest.name
             // TBD: This logic is not foolproof, need to find a better way to match source and target apps
             // Reason: While importing apps, if an app exist in the target with the same name, it will be a conflict and will not be imported
@@ -86,9 +106,11 @@ class marketplaceAppImportSetup {
                         });
                     }
                 });
+                (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.tick(true, `app: ${sourceAppName}`, null, utils_2.PROCESS_NAMES.MARKETPLACE_APPS_FETCH);
             }
             else {
-                cli_utilities_1.log.info(`No matching Marketplace app found in the target stack with name ${sourceAppName}`);
+                (_b = this.progressManager) === null || _b === void 0 ? void 0 : _b.tick(false, `app: ${sourceAppName}`, 'Not found in target stack', utils_2.PROCESS_NAMES.MARKETPLACE_APPS_FETCH);
+                (0, utils_1.log)(this.config, `No matching Marketplace app found in the target stack with name ${sourceAppName}`, 'info');
             }
         });
     }

package/lib/import/modules/taxonomies.d.ts

@@ -1,11 +1,9 @@
 /// <reference types="lodash" />
 import { ModuleClassParams } from '../../types';
-export default class TaxonomiesImportSetup {
-    private config;
+import BaseImportSetup from './base-setup';
+export default class TaxonomiesImportSetup extends BaseImportSetup {
     private taxonomiesFilePath;
     private taxonomiesFolderPath;
-    private stackAPIClient;
-    private dependencies;
     private taxonomiesConfig;
     private termsSuccessPath;
     private taxSuccessPath;
@@ -16,7 +14,7 @@ export default class TaxonomiesImportSetup {
     taxonomiesMapper: Record<string, unknown>;
     termsMapper: Record<string, unknown>;
     masterLocaleFilePath: string;
-    constructor({ config, stackAPIClient, dependencies }: ModuleClassParams);
+    constructor({ config, stackAPIClient }: ModuleClassParams);
     /**
      * Start the taxonomies import setup
      * This method reads the taxonomies from the content folder and generates a mapper file
@@ -26,12 +24,12 @@ export default class TaxonomiesImportSetup {
     /**
      * Setup taxonomies using legacy format (root-level taxonomy files)
      */
-    setupTaxonomiesLegacy(taxonomies: any): Promise<void>;
+    setupTaxonomiesLegacy(taxonomies: any, progress: any): Promise<void>;
     /**
      * Setup taxonomies using locale-based format (taxonomies organized by locale)
      * For locale-based structure, we query the target stack for each taxonomy+locale combination
      */
-    setupTaxonomiesByLocale(taxonomies: any): Promise<void>;
+    setupTaxonomiesByLocale(taxonomies: any, progress: any): Promise<void>;
     /**
      * Detect if locale-based folder structure exists
      * @returns {boolean} true if locale-based structure detected, false otherwise