@contentstack/cli-cm-import 2.0.0-beta.5 → 2.0.0-beta.6

package/README.md

@@ -47,7 +47,7 @@ $ npm install -g @contentstack/cli-cm-import
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-import/2.0.0-beta.5 linux-x64 node-v22.22.0
+@contentstack/cli-cm-import/2.0.0-beta.6 linux-x64 node-v22.22.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/import/modules/base-class.d.ts

@@ -4,6 +4,12 @@ import { ImportConfig, ModuleClassParams } from '../../types';
 export type AdditionalKeys = {
     backupDir: string;
 };
+export type CompleteProgressOptions = {
+    moduleName?: string;
+    customSuccessMessage?: string;
+    customWarningMessage?: string;
+    context?: Record<string, any>;
+};
 export type ApiModuleType = 'create-assets' | 'replace-assets' | 'publish-assets' | 'create-assets-folder' | 'create-extensions' | 'update-extensions' | 'create-locale' | 'update-locale' | 'create-gfs' | 'create-cts' | 'update-cts' | 'update-gfs' | 'create-environments' | 'create-labels' | 'update-labels' | 'create-webhooks' | 'create-workflows' | 'create-custom-role' | 'create-entries' | 'update-entries' | 'publish-entries' | 'delete-entries' | 'create-taxonomies' | 'create-terms' | 'import-taxonomy';
 export type ApiOptions = {
     uid?: string;
@@ -55,6 +61,17 @@ export default abstract class BaseClass {
      * Complete progress manager
      */
     protected completeProgress(success?: boolean, error?: string): void;
+    /**
+     * Complete progress and log success/warning message based on errors
+     * Checks the progress manager's failure count to determine if errors occurred
+     * @param options - Options object containing:
+     *   - moduleName: The module name to generate the message (e.g., 'Content types', 'Entries')
+     *                 If not provided, uses this.currentModuleName
+     *   - customSuccessMessage: Optional custom success message. If not provided, generates: "{moduleName} have been imported successfully!"
+     *   - customWarningMessage: Optional custom warning message. If not provided, generates: "{moduleName} have been imported with some errors. Please check the logs for details."
+     *   - context: Optional context for logging
+     */
+    protected completeProgressWithMessage(options?: CompleteProgressOptions): void;
     protected withLoadingSpinner<T>(message: string, action: () => Promise<T>): Promise<T>;
     /**
      * @method delay

package/lib/import/modules/base-class.js

@@ -54,6 +54,33 @@ class BaseClass {
         (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.complete(success, error);
         this.progressManager = null;
     }
+    /**
+     * Complete progress and log success/warning message based on errors
+     * Checks the progress manager's failure count to determine if errors occurred
+     * @param options - Options object containing:
+     *   - moduleName: The module name to generate the message (e.g., 'Content types', 'Entries')
+     *                 If not provided, uses this.currentModuleName
+     *   - customSuccessMessage: Optional custom success message. If not provided, generates: "{moduleName} have been imported successfully!"
+     *   - customWarningMessage: Optional custom warning message. If not provided, generates: "{moduleName} have been imported with some errors. Please check the logs for details."
+     *   - context: Optional context for logging
+     */
+    completeProgressWithMessage(options) {
+        var _a, _b;
+        const logContext = (options === null || options === void 0 ? void 0 : options.context) || ((_a = this.importConfig) === null || _a === void 0 ? void 0 : _a.context) || {};
+        const failureCount = ((_b = this.progressManager) === null || _b === void 0 ? void 0 : _b.getFailureCount()) || 0;
+        const hasErrors = failureCount > 0;
+        const name = (options === null || options === void 0 ? void 0 : options.moduleName) || this.currentModuleName || 'Module';
+        // Generate default messages if not provided
+        const successMessage = (options === null || options === void 0 ? void 0 : options.customSuccessMessage) || `${name} have been imported successfully!`;
+        const warningMessage = (options === null || options === void 0 ? void 0 : options.customWarningMessage) || `${name} have been imported with some errors. Please check the logs for details.`;
+        this.completeProgress(true);
+        if (hasErrors) {
+            cli_utilities_1.log.warn(warningMessage, logContext);
+        }
+        else {
+            cli_utilities_1.log.success(successMessage, logContext);
+        }
+    }
     async withLoadingSpinner(message, action) {
         var _a;
         const logConfig = cli_utilities_1.configHandler.get('log') || {};

package/lib/import/modules/content-types.js

@@ -107,8 +107,7 @@ class ContentTypesImport extends base_class_1.default {
             if (this.pendingGFs.length > 0) {
                 await this.handlePendingGlobalFields(progress);
             }
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Content types have been imported successfully!', this.importConfig.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Content types import failed');

package/lib/import/modules/custom-roles.js

@@ -84,8 +84,7 @@ class ImportCustomRoles extends base_class_1.default {
             progress.updateStatus(utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.CUSTOM_ROLES_IMPORT].IMPORTING);
             await this.importCustomRoles();
             this.handleImportResults();
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Custom roles have been imported successfully!', this.importConfig.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Custom roles import failed');

package/lib/import/modules/entries.js

@@ -123,8 +123,7 @@ class EntriesImport extends base_class_1.default {
                 .updateStatus(utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.CLEANUP].CLEANING, utils_1.PROCESS_NAMES.CLEANUP);
             await this.processCleanup();
             progress.completeProcess(utils_1.PROCESS_NAMES.CLEANUP, true);
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Entries imported successfully', this.importConfig.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.createEntryDataForVariantEntry();

package/lib/import/modules/environments.js

@@ -39,8 +39,7 @@ class ImportEnvironments extends base_class_1.default {
             progress.updateStatus(utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.ENVIRONMENTS_IMPORT].IMPORTING);
             await this.importEnvironments();
             await this.processImportResults();
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Environments have been imported successfully!', this.importConfig.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Environments import failed');

package/lib/import/modules/extensions.js

@@ -60,8 +60,7 @@ class ImportExtensions extends base_class_1.default {
                 progress.completeProcess(utils_1.PROCESS_NAMES.EXTENSIONS_REPLACE_EXISTING, true);
             }
             await this.processExtensionResults();
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Extensions have been imported successfully!', this.importConfig.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Create failed');

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

@@ -76,8 +76,7 @@ class ImportGlobalFields extends base_class_1.default {
                 progress.completeProcess(utils_1.PROCESS_NAMES.GLOBAL_FIELDS_REPLACE_EXISTING, true);
             }
             await this.processGlobalFieldResults();
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Global fields import has been completed!', this.importConfig.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Global fields import failed');

package/lib/import/modules/labels.js

@@ -55,8 +55,7 @@ class ImportLabels extends base_class_1.default {
             await this.updateLabels();
             progress.completeProcess(utils_1.PROCESS_NAMES.LABELS_UPDATE, true);
             this.processLabelResults();
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Labels have been imported successfully!', this.importConfig.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Labels import failed');

package/lib/import/modules/locales.js

@@ -49,8 +49,7 @@ class ImportLocales extends base_class_1.default {
             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);
+            this.completeProgressWithMessage({ context: this.config.context });
         }
         catch (error) {
             this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Locales import failed');

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

@@ -85,8 +85,7 @@ class ImportMarketplaceApps extends base_class_1.default {
                 .updateStatus(utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.INSTALL_APPS].INSTALLING, utils_1.PROCESS_NAMES.INSTALL_APPS);
             await this.importMarketplaceApps();
             progress.completeProcess(utils_1.PROCESS_NAMES.INSTALL_APPS, true);
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Marketplace apps have been imported successfully!', this.importConfig.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Marketplace apps import failed');

package/lib/import/modules/personalize.js

@@ -46,8 +46,7 @@ class ImportPersonalize extends base_class_1.default {
             else {
                 cli_utilities_1.log.debug('No personalize modules configured for processing', this.config.context);
             }
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Personalize import completed successfully', this.config.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.personalizeConfig.importData = false; // Stop personalize import if project creation fails

package/lib/import/modules/stack.js

@@ -35,8 +35,7 @@ class ImportStack extends base_class_1.default {
             progress.updateStatus(utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.STACK_IMPORT].IMPORTING);
             cli_utilities_1.log.info('Starting stack settings import process', this.importConfig.context);
             await this.importStackSettings();
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Stack settings imported successfully!', this.importConfig.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.completeProgress(false, 'Stack settings import failed');

package/lib/import/modules/taxonomies.js

@@ -43,8 +43,7 @@ class ImportTaxonomies extends base_class_1.default {
             cli_utilities_1.log.debug('Starting taxonomies import', this.importConfig.context);
             await this.importTaxonomies();
             this.createSuccessAndFailedFile();
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Taxonomies imported successfully!', this.importConfig.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Taxonomies import failed');

package/lib/import/modules/variant-entries.js

@@ -34,8 +34,7 @@ class ImportVariantEntries extends base_class_1.default {
             progress.updateStatus(utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.VARIANT_ENTRIES_IMPORT].IMPORTING, utils_1.PROCESS_NAMES.VARIANT_ENTRIES_IMPORT);
             cli_utilities_1.log.info('Starting variant entries import process', this.config.context);
             await this.importVariantEntries();
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Variant entries imported successfully', this.config.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Variant entries import failed');

package/lib/import/modules/webhooks.js

@@ -40,8 +40,7 @@ class ImportWebhooks extends base_class_1.default {
             progress.updateStatus(utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.WEBHOOKS_IMPORT].IMPORTING);
             await this.importWebhooks();
             this.processWebhookResults();
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Webhooks have been imported successfully!', this.importConfig.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Webhooks import failed');

package/lib/import/modules/workflows.js

@@ -61,8 +61,7 @@ class ImportWorkflows extends base_class_1.default {
             await this.importWorkflows();
             progress.completeProcess(utils_1.PROCESS_NAMES.WORKFLOWS_CREATE, true);
             this.processWorkflowResults();
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Workflows have been imported successfully!', this.importConfig.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Workflows import failed');

package/oclif.manifest.json

@@ -168,5 +168,5 @@
       ]
     }
   },
-  "version": "2.0.0-beta.5"
+  "version": "2.0.0-beta.6"
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "2.0.0-beta.5",
+  "version": "2.0.0-beta.6",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-audit": "~2.0.0-beta.1",
-    "@contentstack/cli-command": "~1.7.0",
-    "@contentstack/cli-utilities": "~1.17.0",
+    "@contentstack/cli-audit": "~1.17.1",
+    "@contentstack/cli-command": "~1.7.1",
+    "@contentstack/cli-utilities": "~1.17.2",
     "@contentstack/management": "~1.27.3",
     "@contentstack/cli-variants": "~2.0.0-beta.4",
     "@oclif/core": "^4.3.0",