@contentstack/cli-cm-export 1.16.3 → 1.18.0

package/lib/export/modules/stack.js

@@ -11,77 +11,142 @@ class ExportStack extends base_class_1.default {
         super({ exportConfig, stackAPIClient });
         this.stackConfig = exportConfig.modules.stack;
         this.qs = { include_count: true };
-        this.stackFolderPath = (0, node_path_1.resolve)(this.exportConfig.data, this.stackConfig.dirName);
+        this.stackFolderPath = (0, node_path_1.resolve)(this.exportConfig.data, this.exportConfig.branchName || '', this.stackConfig.dirName);
+        this.exportConfig.context.module = 'stack';
     }
     async start() {
+        cli_utilities_1.log.debug('Starting stack export process...', this.exportConfig.context);
         if ((0, cli_utilities_1.isAuthenticated)()) {
+            cli_utilities_1.log.debug('User is authenticated, fetching stack data...', this.exportConfig.context);
             const stackData = await this.getStack();
             if (stackData === null || stackData === void 0 ? void 0 : stackData.org_uid) {
+                cli_utilities_1.log.debug(`Found organization UID: ${stackData.org_uid}`, this.exportConfig.context);
                 this.exportConfig.org_uid = stackData.org_uid;
                 this.exportConfig.sourceStackName = stackData.name;
+                cli_utilities_1.log.debug(`Set source stack name: ${stackData.name}`, this.exportConfig.context);
             }
+            else {
+                cli_utilities_1.log.debug('No stack data found or missing org_uid', this.exportConfig.context);
+            }
+        }
+        else {
+            cli_utilities_1.log.debug('User is not authenticated, skipping stack data fetch', this.exportConfig.context);
+        }
+        if (this.exportConfig.management_token) {
+            cli_utilities_1.log.info('Skipping stack settings export: Operation is not supported when using a management token.', this.exportConfig.context);
+        }
+        else {
+            await this.exportStackSettings();
         }
         if (!this.exportConfig.preserveStackVersion && !this.exportConfig.hasOwnProperty('master_locale')) {
+            cli_utilities_1.log.debug('Preserve stack version is false and master locale not set, fetching locales...', this.exportConfig.context);
             //fetch master locale details
             return this.getLocales();
         }
         else if (this.exportConfig.preserveStackVersion) {
+            cli_utilities_1.log.debug('Preserve stack version is true, exporting stack...', this.exportConfig.context);
             return this.exportStack();
         }
+        else {
+            cli_utilities_1.log.debug('Master locale already set, skipping locale fetch', this.exportConfig.context);
+        }
     }
     async getStack() {
+        cli_utilities_1.log.debug(`Fetching stack data for stack: ${this.exportConfig.source_stack}`, this.exportConfig.context);
         const tempAPIClient = await (0, cli_utilities_1.managementSDKClient)({ host: this.exportConfig.host });
+        cli_utilities_1.log.debug(`Created management SDK client with host: ${this.exportConfig.host}`, this.exportConfig.context);
         return await tempAPIClient
             .stack({ api_key: this.exportConfig.source_stack })
             .fetch()
-            .catch((error) => { });
+            .then((data) => {
+            cli_utilities_1.log.debug(`Successfully fetched stack data for: ${this.exportConfig.source_stack}`, this.exportConfig.context);
+            return data;
+        })
+            .catch((error) => {
+            cli_utilities_1.log.debug(`Failed to fetch stack data for: ${this.exportConfig.source_stack}`, this.exportConfig.context);
+            return {};
+        });
     }
     async getLocales(skip = 0) {
         if (skip) {
             this.qs.skip = skip;
+            cli_utilities_1.log.debug(`Fetching locales with skip: ${skip}`, this.exportConfig.context);
+        }
+        else {
+            cli_utilities_1.log.debug('Fetching locales with initial query', this.exportConfig.context);
         }
+        cli_utilities_1.log.debug(`Query parameters: ${JSON.stringify(this.qs)}`, this.exportConfig.context);
         return await this.stack
             .locale()
             .query(this.qs)
             .find()
             .then(async (data) => {
             const { items, count } = data;
+            cli_utilities_1.log.debug(`Fetched ${(items === null || items === void 0 ? void 0 : items.length) || 0} locales out of total ${count}`, this.exportConfig.context);
             if (items === null || items === void 0 ? void 0 : items.length) {
+                cli_utilities_1.log.debug(`Processing ${items.length} locales to find master locale`, this.exportConfig.context);
                 skip += this.stackConfig.limit || 100;
                 const masterLocalObj = (0, find_1.default)(items, (locale) => {
                     if (locale.fallback_locale === null) {
+                        cli_utilities_1.log.debug(`Found master locale: ${locale.name} (${locale.code})`, this.exportConfig.context);
                         return locale;
                     }
                 });
                 if (masterLocalObj) {
+                    cli_utilities_1.log.debug(`Returning master locale: ${masterLocalObj.name}`, this.exportConfig.context);
                     return masterLocalObj;
                 }
                 else if (skip >= count) {
-                    (0, utils_1.log)(this.exportConfig, 'Master locale not found', 'error');
+                    cli_utilities_1.log.error(`Master locale not found in the stack ${this.exportConfig.source_stack}. Please ensure that the stack has a master locale.`, this.exportConfig.context);
+                    cli_utilities_1.log.debug('Completed searching all locales without finding master locale', this.exportConfig.context);
                     return;
                 }
                 else {
+                    cli_utilities_1.log.debug(`Master locale not found in current batch, continuing with skip: ${skip}`, this.exportConfig.context);
                     return await this.getLocales(skip);
                 }
             }
+            else {
+                cli_utilities_1.log.debug('No locales found to process', this.exportConfig.context);
+            }
         })
             .catch((error) => {
-            (0, utils_1.log)(this.exportConfig, `Failed to export locales. ${(0, utils_1.formatError)(error)}`, 'error');
-            (0, utils_1.log)(this.exportConfig, error, 'error');
+            cli_utilities_1.log.debug(`Error occurred while fetching locales for stack: ${this.exportConfig.source_stack}`, this.exportConfig.context);
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.exportConfig.context), `Failed to fetch locales for stack ${this.exportConfig.source_stack}`);
+            throw error;
         });
     }
     async exportStack() {
-        (0, utils_1.log)(this.exportConfig, 'Exporting stack details', 'success');
+        cli_utilities_1.log.debug(`Starting stack export for: ${this.exportConfig.source_stack}`, this.exportConfig.context);
         await utils_1.fsUtil.makeDirectory(this.stackFolderPath);
+        cli_utilities_1.log.debug(`Created stack directory at: ${this.stackFolderPath}`, this.exportConfig.context);
         return this.stack
             .fetch()
             .then((resp) => {
-            utils_1.fsUtil.writeFile((0, node_path_1.resolve)(this.stackFolderPath, this.stackConfig.fileName), resp);
-            (0, utils_1.log)(this.exportConfig, 'Exported stack details successfully!', 'success');
+            const stackFilePath = (0, node_path_1.resolve)(this.stackFolderPath, this.stackConfig.fileName);
+            cli_utilities_1.log.debug(`Writing stack data to: ${stackFilePath}`, this.exportConfig.context);
+            utils_1.fsUtil.writeFile(stackFilePath, resp);
+            cli_utilities_1.log.success(`Stack details exported successfully for stack ${this.exportConfig.source_stack}`, this.exportConfig.context);
+            cli_utilities_1.log.debug('Stack export completed successfully', this.exportConfig.context);
+            return resp;
+        })
+            .catch((error) => {
+            cli_utilities_1.log.debug(`Error occurred while exporting stack: ${this.exportConfig.source_stack}`, this.exportConfig.context);
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.exportConfig.context));
+        });
+    }
+    async exportStackSettings() {
+        cli_utilities_1.log.info('Exporting stack settings', this.exportConfig.context);
+        await utils_1.fsUtil.makeDirectory(this.stackFolderPath);
+        return this.stack
+            .settings()
+            .then((resp) => {
+            utils_1.fsUtil.writeFile((0, node_path_1.resolve)(this.stackFolderPath, 'settings.json'), resp);
+            cli_utilities_1.log.success('Exported stack settings successfully!', this.exportConfig.context);
             return resp;
         })
             .catch((error) => {
-            (0, utils_1.log)(this.exportConfig, `Failed to export stack. ${(0, utils_1.formatError)(error)}`, 'error');
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.exportConfig.context));
         });
     }
 }

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

@@ -24,5 +24,4 @@ export default class ExportTaxonomies extends BaseClass {
      * @returns {Promise<void>}
      */
     exportTaxonomies(): Promise<void>;
-    handleErrorMsg(err: any): void;
 }

package/lib/export/modules/taxonomies.js

@@ -5,6 +5,7 @@ const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
 const keys_1 = tslib_1.__importDefault(require("lodash/keys"));
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const node_path_1 = require("node:path");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
 const utils_1 = require("../../utils");
 class ExportTaxonomies extends base_class_1.default {
@@ -13,23 +14,32 @@ class ExportTaxonomies extends base_class_1.default {
         this.taxonomies = {};
         this.taxonomiesConfig = exportConfig.modules.taxonomies;
         this.qs = { include_count: true, limit: this.taxonomiesConfig.limit || 100, skip: 0 };
+        this.applyQueryFilters(this.qs, 'taxonomies');
+        this.exportConfig.context.module = 'taxonomies';
     }
     async start() {
-        (0, utils_1.log)(this.exportConfig, 'Starting taxonomies export', 'info');
+        cli_utilities_1.log.debug('Starting taxonomies export process...', this.exportConfig.context);
         //create taxonomies folder
         this.taxonomiesFolderPath = (0, node_path_1.resolve)(this.exportConfig.data, this.exportConfig.branchName || '', this.taxonomiesConfig.dirName);
+        cli_utilities_1.log.debug(`Taxonomies folder path: ${this.taxonomiesFolderPath}`, this.exportConfig.context);
         await utils_1.fsUtil.makeDirectory(this.taxonomiesFolderPath);
+        cli_utilities_1.log.debug('Created taxonomies directory', this.exportConfig.context);
         //fetch all taxonomies and write into taxonomies folder
+        cli_utilities_1.log.debug('Fetching all taxonomies...', this.exportConfig.context);
         await this.getAllTaxonomies();
+        cli_utilities_1.log.debug(`Retrieved ${Object.keys(this.taxonomies).length} taxonomies`, this.exportConfig.context);
         if (this.taxonomies === undefined || (0, isEmpty_1.default)(this.taxonomies)) {
-            (0, utils_1.log)(this.exportConfig, 'No taxonomies found!', 'info');
+            cli_utilities_1.log.info(cli_utilities_1.messageHandler.parse('TAXONOMY_NOT_FOUND'), this.exportConfig.context);
             return;
         }
         else {
-            utils_1.fsUtil.writeFile((0, node_path_1.resolve)(this.taxonomiesFolderPath, 'taxonomies.json'), this.taxonomies);
+            const taxonomiesFilePath = (0, node_path_1.resolve)(this.taxonomiesFolderPath, 'taxonomies.json');
+            cli_utilities_1.log.debug(`Writing taxonomies metadata to: ${taxonomiesFilePath}`, this.exportConfig.context);
+            utils_1.fsUtil.writeFile(taxonomiesFilePath, this.taxonomies);
+            cli_utilities_1.log.debug('Starting detailed taxonomy export...', this.exportConfig.context);
             await this.exportTaxonomies();
         }
-        (0, utils_1.log)(this.exportConfig, `All taxonomies exported successfully!`, 'success');
+        cli_utilities_1.log.success(cli_utilities_1.messageHandler.parse('TAXONOMY_EXPORT_COMPLETE', (0, keys_1.default)(this.taxonomies).length), this.exportConfig.context);
     }
     /**
      * fetch all taxonomies in the provided stack
@@ -39,7 +49,12 @@ class ExportTaxonomies extends base_class_1.default {
     async getAllTaxonomies(skip = 0) {
         if (skip) {
             this.qs.skip = skip;
+            cli_utilities_1.log.debug(`Fetching taxonomies with skip: ${skip}`, this.exportConfig.context);
         }
+        else {
+            cli_utilities_1.log.debug('Fetching taxonomies with initial query', this.exportConfig.context);
+        }
+        cli_utilities_1.log.debug(`Query parameters: ${JSON.stringify(this.qs)}`, this.exportConfig.context);
         await this.stack
             .taxonomy()
             .query(this.qs)
@@ -47,17 +62,25 @@ class ExportTaxonomies extends base_class_1.default {
             .then(async (data) => {
             const { items, count } = data;
             const taxonomiesCount = count !== undefined ? count : items === null || items === void 0 ? void 0 : items.length;
+            cli_utilities_1.log.debug(`Fetched ${(items === null || items === void 0 ? void 0 : items.length) || 0} taxonomies out of total ${taxonomiesCount}`, this.exportConfig.context);
             if (items === null || items === void 0 ? void 0 : items.length) {
+                cli_utilities_1.log.debug(`Processing ${items.length} taxonomies`, this.exportConfig.context);
                 this.sanitizeTaxonomiesAttribs(items);
                 skip += this.qs.limit || 100;
                 if (skip >= taxonomiesCount) {
+                    cli_utilities_1.log.debug('Completed fetching all taxonomies', this.exportConfig.context);
                     return;
                 }
+                cli_utilities_1.log.debug(`Continuing to fetch taxonomies with skip: ${skip}`, this.exportConfig.context);
                 return await this.getAllTaxonomies(skip);
             }
+            else {
+                cli_utilities_1.log.debug('No taxonomies found to process', this.exportConfig.context);
+            }
         })
             .catch((error) => {
-            this.handleErrorMsg(error);
+            cli_utilities_1.log.debug('Error occurred while fetching taxonomies', this.exportConfig.context);
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.exportConfig.context));
         });
     }
     /**
@@ -66,10 +89,15 @@ class ExportTaxonomies extends base_class_1.default {
      * @param taxonomies
      */
     sanitizeTaxonomiesAttribs(taxonomies) {
+        var _a;
+        cli_utilities_1.log.debug(`Sanitizing ${taxonomies.length} taxonomies`, this.exportConfig.context);
         for (let index = 0; index < (taxonomies === null || taxonomies === void 0 ? void 0 : taxonomies.length); index++) {
             const taxonomyUID = taxonomies[index].uid;
+            const taxonomyName = (_a = taxonomies[index]) === null || _a === void 0 ? void 0 : _a.name;
+            cli_utilities_1.log.debug(`Processing taxonomy: ${taxonomyName} (${taxonomyUID})`, this.exportConfig.context);
             this.taxonomies[taxonomyUID] = (0, omit_1.default)(taxonomies[index], this.taxonomiesConfig.invalidKeys);
         }
+        cli_utilities_1.log.debug(`Sanitization complete. Total taxonomies processed: ${Object.keys(this.taxonomies).length}`, this.exportConfig.context);
     }
     /**
      * Export all taxonomies details using metadata(this.taxonomies) and write it into respective <taxonomy-uid>.json file
@@ -77,26 +105,20 @@ class ExportTaxonomies extends base_class_1.default {
      */
     async exportTaxonomies() {
         const taxonomiesUID = (0, keys_1.default)(this.taxonomies) || [];
+        cli_utilities_1.log.debug(`Exporting detailed data for ${taxonomiesUID.length} taxonomies`, this.exportConfig.context);
         const onSuccess = ({ response, uid }) => {
             const filePath = (0, node_path_1.resolve)(this.taxonomiesFolderPath, `${uid}.json`);
+            cli_utilities_1.log.debug(`Writing detailed taxonomy data to: ${filePath}`, this.exportConfig.context);
             utils_1.fsUtil.writeFile(filePath, response);
-            (0, utils_1.log)(this.exportConfig, `'${uid}' taxonomy exported successfully!`, 'success');
+            cli_utilities_1.log.success(cli_utilities_1.messageHandler.parse('TAXONOMY_EXPORT_SUCCESS', uid), this.exportConfig.context);
         };
         const onReject = ({ error, uid }) => {
-            var _a, _b;
-            if (error === null || error === void 0 ? void 0 : error.errorMessage) {
-                (0, utils_1.log)(this.exportConfig, `Failed to export taxonomy - '${uid}'! ${error.errorMessage}`, 'error');
-            }
-            else if (error === null || error === void 0 ? void 0 : error.message) {
-                const errorMsg = ((_a = error === null || error === void 0 ? void 0 : error.errors) === null || _a === void 0 ? void 0 : _a.taxonomy) || ((_b = error === null || error === void 0 ? void 0 : error.errors) === null || _b === void 0 ? void 0 : _b.term) || (error === null || error === void 0 ? void 0 : error.message);
-                (0, utils_1.log)(this.exportConfig, `Failed to export taxonomy - '${uid}'! ${errorMsg}`, 'error');
-            }
-            else {
-                (0, utils_1.log)(this.exportConfig, `Failed to export taxonomy - '${uid}'! ${error}`, 'error');
-            }
+            cli_utilities_1.log.debug(`Failed to export detailed data for taxonomy: ${uid}`, this.exportConfig.context);
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign(Object.assign({}, this.exportConfig.context), { uid }));
         };
         for (let index = 0; index < (taxonomiesUID === null || taxonomiesUID === void 0 ? void 0 : taxonomiesUID.length); index++) {
             const taxonomyUID = taxonomiesUID[index];
+            cli_utilities_1.log.debug(`Processing detailed export for taxonomy: ${taxonomyUID}`, this.exportConfig.context);
             await this.makeAPICall({
                 reject: onReject,
                 resolve: onSuccess,
@@ -104,19 +126,7 @@ class ExportTaxonomies extends base_class_1.default {
                 module: 'export-taxonomy',
             });
         }
-    }
-    handleErrorMsg(err) {
-        var _a, _b;
-        if (err === null || err === void 0 ? void 0 : err.errorMessage) {
-            (0, utils_1.log)(this.exportConfig, `Failed to export! ${err.errorMessage}`, 'error');
-        }
-        else if (err === null || err === void 0 ? void 0 : err.message) {
-            const errorMsg = ((_a = err === null || err === void 0 ? void 0 : err.errors) === null || _a === void 0 ? void 0 : _a.taxonomy) || ((_b = err === null || err === void 0 ? void 0 : err.errors) === null || _b === void 0 ? void 0 : _b.term) || (err === null || err === void 0 ? void 0 : err.message);
-            (0, utils_1.log)(this.exportConfig, `Failed to export! ${errorMsg}`, 'error');
-        }
-        else {
-            (0, utils_1.log)(this.exportConfig, `Failed to export! ${err}`, 'error');
-        }
+        cli_utilities_1.log.debug('Completed detailed taxonomy export process', this.exportConfig.context);
     }
 }
 exports.default = ExportTaxonomies;

package/lib/export/modules/webhooks.js

@@ -4,6 +4,7 @@ const tslib_1 = require("tslib");
 const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const node_path_1 = require("node:path");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
 const utils_1 = require("../../utils");
 class ExportWebhooks extends base_class_1.default {
@@ -12,51 +13,72 @@ class ExportWebhooks extends base_class_1.default {
         this.webhooks = {};
         this.webhookConfig = exportConfig.modules.webhooks;
         this.qs = { include_count: true, asc: 'updated_at' };
+        this.exportConfig.context.module = 'webhooks';
     }
     async start() {
-        (0, utils_1.log)(this.exportConfig, 'Starting webhooks export', 'info');
+        cli_utilities_1.log.debug('Starting webhooks export process...', this.exportConfig.context);
         this.webhooksFolderPath = (0, node_path_1.resolve)(this.exportConfig.data, this.exportConfig.branchName || '', this.webhookConfig.dirName);
+        cli_utilities_1.log.debug(`Webhooks folder path: ${this.webhooksFolderPath}`, this.exportConfig.context);
         await utils_1.fsUtil.makeDirectory(this.webhooksFolderPath);
+        cli_utilities_1.log.debug('Created webhooks directory', this.exportConfig.context);
         await this.getWebhooks();
+        cli_utilities_1.log.debug(`Retrieved ${Object.keys(this.webhooks).length} webhooks`, this.exportConfig.context);
         if (this.webhooks === undefined || (0, isEmpty_1.default)(this.webhooks)) {
-            (0, utils_1.log)(this.exportConfig, 'No webhooks found', 'info');
+            cli_utilities_1.log.info(cli_utilities_1.messageHandler.parse('WEBHOOK_NOT_FOUND'), this.exportConfig.context);
         }
         else {
-            utils_1.fsUtil.writeFile((0, node_path_1.resolve)(this.webhooksFolderPath, this.webhookConfig.fileName), this.webhooks);
-            (0, utils_1.log)(this.exportConfig, 'All the webhooks have been exported successfully!', 'success');
+            const webhooksFilePath = (0, node_path_1.resolve)(this.webhooksFolderPath, this.webhookConfig.fileName);
+            cli_utilities_1.log.debug(`Writing webhooks to: ${webhooksFilePath}`, this.exportConfig.context);
+            utils_1.fsUtil.writeFile(webhooksFilePath, this.webhooks);
+            cli_utilities_1.log.success(cli_utilities_1.messageHandler.parse('WEBHOOK_EXPORT_COMPLETE', Object.keys(this.webhooks).length), this.exportConfig.context);
         }
     }
     async getWebhooks(skip = 0) {
         if (skip) {
             this.qs.skip = skip;
+            cli_utilities_1.log.debug(`Fetching webhooks with skip: ${skip}`, this.exportConfig.context);
         }
+        else {
+            cli_utilities_1.log.debug('Fetching webhooks with initial query', this.exportConfig.context);
+        }
+        cli_utilities_1.log.debug(`Query parameters: ${JSON.stringify(this.qs)}`, this.exportConfig.context);
         await this.stack
             .webhook()
             .fetchAll(this.qs)
             .then(async (data) => {
             const { items, count } = data;
+            cli_utilities_1.log.debug(`Fetched ${(items === null || items === void 0 ? void 0 : items.length) || 0} webhooks out of total ${count}`, this.exportConfig.context);
             if (items === null || items === void 0 ? void 0 : items.length) {
+                cli_utilities_1.log.debug(`Processing ${items.length} webhooks`, this.exportConfig.context);
                 this.sanitizeAttribs(items);
                 skip += this.webhookConfig.limit || 100;
                 if (skip >= count) {
+                    cli_utilities_1.log.debug('Completed fetching all webhooks', this.exportConfig.context);
                     return;
                 }
+                cli_utilities_1.log.debug(`Continuing to fetch webhooks with skip: ${skip}`, this.exportConfig.context);
                 return await this.getWebhooks(skip);
             }
+            else {
+                cli_utilities_1.log.debug('No webhooks found to process', this.exportConfig.context);
+            }
         })
             .catch((error) => {
-            (0, utils_1.log)(this.exportConfig, `Failed to export webhooks.${(0, utils_1.formatError)(error)}`, 'error');
-            (0, utils_1.log)(this.exportConfig, error, 'error');
+            cli_utilities_1.log.debug('Error occurred while fetching webhooks', this.exportConfig.context);
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.exportConfig.context));
         });
     }
     sanitizeAttribs(webhooks) {
         var _a;
+        cli_utilities_1.log.debug(`Sanitizing ${webhooks.length} webhooks`, this.exportConfig.context);
         for (let index = 0; index < (webhooks === null || webhooks === void 0 ? void 0 : webhooks.length); index++) {
             const webhookUid = webhooks[index].uid;
             const webhookName = (_a = webhooks[index]) === null || _a === void 0 ? void 0 : _a.name;
+            cli_utilities_1.log.debug(`Processing webhook: ${webhookName} (${webhookUid})`, this.exportConfig.context);
             this.webhooks[webhookUid] = (0, omit_1.default)(webhooks[index], ['SYS_ACL']);
-            (0, utils_1.log)(this.exportConfig, `'${webhookName}' webhook was exported successfully`, 'success');
+            cli_utilities_1.log.success(cli_utilities_1.messageHandler.parse('WEBHOOK_EXPORT_SUCCESS', webhookName), this.exportConfig.context);
         }
+        cli_utilities_1.log.debug(`Sanitization complete. Total webhooks processed: ${Object.keys(this.webhooks).length}`, this.exportConfig.context);
     }
 }
 exports.default = ExportWebhooks;

package/lib/export/modules/workflows.js

@@ -4,6 +4,7 @@ const tslib_1 = require("tslib");
 const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const node_path_1 = require("node:path");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
 const utils_1 = require("../../utils");
 class ExportWorkFlows extends base_class_1.default {
@@ -12,24 +13,31 @@ class ExportWorkFlows extends base_class_1.default {
         this.workflows = {};
         this.workflowConfig = exportConfig.modules.workflows;
         this.qs = { include_count: true };
+        this.exportConfig.context.module = 'workflows';
     }
     async start() {
-        (0, utils_1.log)(this.exportConfig, 'Starting workflows export', 'info');
         this.webhooksFolderPath = (0, node_path_1.resolve)(this.exportConfig.data, this.exportConfig.branchName || '', this.workflowConfig.dirName);
+        cli_utilities_1.log.debug(`Workflows folder path: ${this.webhooksFolderPath}`, this.exportConfig.context);
         await utils_1.fsUtil.makeDirectory(this.webhooksFolderPath);
+        cli_utilities_1.log.debug('Created workflows directory', this.exportConfig.context);
         await this.getWorkflows();
+        cli_utilities_1.log.debug(`Retrieved ${Object.keys(this.workflows).length} workflows`, this.exportConfig.context);
         if (this.workflows === undefined || (0, isEmpty_1.default)(this.workflows)) {
-            (0, utils_1.log)(this.exportConfig, 'No workflows found', 'info');
+            cli_utilities_1.log.info(cli_utilities_1.messageHandler.parse('WORKFLOW_NOT_FOUND'), this.exportConfig.context);
         }
         else {
-            utils_1.fsUtil.writeFile((0, node_path_1.resolve)(this.webhooksFolderPath, this.workflowConfig.fileName), this.workflows);
-            (0, utils_1.log)(this.exportConfig, 'All the workflows have been exported successfully!', 'success');
+            const workflowsFilePath = (0, node_path_1.resolve)(this.webhooksFolderPath, this.workflowConfig.fileName);
+            cli_utilities_1.log.debug(`Writing workflows to: ${workflowsFilePath}`, this.exportConfig.context);
+            utils_1.fsUtil.writeFile(workflowsFilePath, this.workflows);
+            cli_utilities_1.log.success(cli_utilities_1.messageHandler.parse('WORKFLOW_EXPORT_COMPLETE', Object.keys(this.workflows).length), this.exportConfig.context);
         }
     }
     async getWorkflows(skip = 0) {
         if (skip) {
             this.qs.skip = skip;
+            cli_utilities_1.log.debug(`Fetching workflows with skip: ${skip}`, this.exportConfig.context);
         }
+        cli_utilities_1.log.debug(`Query parameters: ${JSON.stringify(this.qs)}`, this.exportConfig.context);
         await this.stack
             .workflow()
             .fetchAll(this.qs)
@@ -37,46 +45,66 @@ class ExportWorkFlows extends base_class_1.default {
             const { items, count } = data;
             //NOTE - Handle the case where old workflow api is enabled in that case getting responses as objects.
             const workflowCount = count !== undefined ? count : items.length;
+            cli_utilities_1.log.debug(`Fetched ${(items === null || items === void 0 ? void 0 : items.length) || 0} workflows out of total ${workflowCount}`, this.exportConfig.context);
             if (items === null || items === void 0 ? void 0 : items.length) {
+                cli_utilities_1.log.debug(`Processing ${items.length} workflows`, this.exportConfig.context);
                 await this.sanitizeAttribs(items);
                 skip += this.workflowConfig.limit || 100;
                 if (skip >= workflowCount) {
+                    cli_utilities_1.log.debug('Completed fetching all workflows', this.exportConfig.context);
                     return;
                 }
+                cli_utilities_1.log.debug(`Continuing to fetch workflows with skip: ${skip}`, this.exportConfig.context);
                 return await this.getWorkflows(skip);
             }
+            else {
+                cli_utilities_1.log.debug('No workflows found to process', this.exportConfig.context);
+            }
         })
             .catch((error) => {
-            (0, utils_1.log)(this.exportConfig, `Failed to export workflows.${(0, utils_1.formatError)(error)}`, 'error');
-            (0, utils_1.log)(this.exportConfig, error, 'error');
+            cli_utilities_1.log.debug('Error occurred while fetching workflows', this.exportConfig.context);
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.exportConfig.context));
         });
     }
     async sanitizeAttribs(workflows) {
         var _a;
+        cli_utilities_1.log.debug(`Sanitizing ${workflows.length} workflows`, this.exportConfig.context);
         for (let index = 0; index < (workflows === null || workflows === void 0 ? void 0 : workflows.length); index++) {
-            await this.getWorkflowRoles(workflows[index]);
             const workflowUid = workflows[index].uid;
             const workflowName = ((_a = workflows[index]) === null || _a === void 0 ? void 0 : _a.name) || '';
+            cli_utilities_1.log.debug(`Processing workflow: ${workflowName} (${workflowUid})`, this.exportConfig.context);
+            await this.getWorkflowRoles(workflows[index]);
             this.workflows[workflowUid] = (0, omit_1.default)(workflows[index], this.workflowConfig.invalidKeys);
-            (0, utils_1.log)(this.exportConfig, `'${workflowName}' workflow was exported successfully`, 'success');
+            cli_utilities_1.log.success(cli_utilities_1.messageHandler.parse('WORKFLOW_EXPORT_SUCCESS', workflowName), this.exportConfig.context);
         }
+        cli_utilities_1.log.debug(`Sanitization complete. Total workflows processed: ${Object.keys(this.workflows).length}`, this.exportConfig.context);
     }
     async getWorkflowRoles(workflow) {
         var _a, _b, _c;
+        cli_utilities_1.log.debug(`Processing workflow roles for workflow: ${workflow.uid}`, this.exportConfig.context);
         for (const stage of workflow === null || workflow === void 0 ? void 0 : workflow.workflow_stages) {
+            cli_utilities_1.log.debug(`Processing workflow stage: ${stage.name}`, this.exportConfig.context);
             for (let i = 0; i < ((_c = (_b = (_a = stage === null || stage === void 0 ? void 0 : stage.SYS_ACL) === null || _a === void 0 ? void 0 : _a.roles) === null || _b === void 0 ? void 0 : _b.uids) === null || _c === void 0 ? void 0 : _c.length); i++) {
                 const roleUid = stage.SYS_ACL.roles.uids[i];
+                cli_utilities_1.log.debug(`Fetching role data for role UID: ${roleUid}`, this.exportConfig.context);
                 const roleData = await this.getRoles(roleUid);
                 stage.SYS_ACL.roles.uids[i] = roleData;
             }
         }
     }
     async getRoles(roleUid) {
+        cli_utilities_1.log.debug(`Fetching role with UID: ${roleUid}`, this.exportConfig.context);
         return await this.stack
             .role(roleUid)
             .fetch({ include_rules: true, include_permissions: true })
-            .then((data) => data)
-            .catch((err) => (0, utils_1.log)(this.exportConfig, `Failed to fetch roles.${(0, utils_1.formatError)(err)}`, 'error'));
+            .then((data) => {
+            cli_utilities_1.log.debug(`Successfully fetched role data for UID: ${roleUid}`, this.exportConfig.context);
+            return data;
+        })
+            .catch((err) => {
+            cli_utilities_1.log.debug(`Failed to fetch role data for UID: ${roleUid}`, this.exportConfig.context);
+            (0, cli_utilities_1.handleAndLogError)(err, Object.assign({}, this.exportConfig.context));
+        });
     }
 }
 exports.default = ExportWorkFlows;

package/lib/types/export-config.d.ts

@@ -1,6 +1,7 @@
-import { Modules, Region } from '.';
+import { Context, Modules, Region } from '.';
 import DefaultConfig from './default-config';
 export default interface ExportConfig extends DefaultConfig {
+    context: Context;
     cliLogsPath: string;
     exportDir: string;
     data: string;
@@ -17,6 +18,7 @@ export default interface ExportConfig extends DefaultConfig {
     singleModuleExport?: boolean;
     moduleName?: Modules;
     master_locale: masterLocale;
+    query?: any;
     headers?: {
         api_key: string;
         access_token?: string;
@@ -29,6 +31,9 @@ export default interface ExportConfig extends DefaultConfig {
     source_stack?: string;
     sourceStackName?: string;
     region: Region;
+    skipStackSettings?: boolean;
+    skipDependencies?: boolean;
+    authenticationMethod?: string;
 }
 type branch = {
     uid: string;

package/lib/types/index.d.ts

@@ -96,6 +96,17 @@ export interface StackConfig {
     dependencies?: Modules[];
     limit?: number;
 }
+export interface Context {
+    command: string;
+    module: string;
+    userId: string | undefined;
+    email: string | undefined;
+    sessionId: string | undefined;
+    clientId?: string | undefined;
+    apiKey: string;
+    orgId: string;
+    authenticationMethod?: string;
+}
 export { default as DefaultConfig } from './default-config';
 export { default as ExportConfig } from './export-config';
 export * from './marketplace-app';

package/lib/utils/basic-login.js

@@ -8,11 +8,10 @@
  * MIT Licensed
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-const logger_1 = require("./logger");
-const { managementSDKClient, isAuthenticated, cliux, configHandler, authHandler, } = require('@contentstack/cli-utilities');
+const cli_utilities_1 = require("@contentstack/cli-utilities");
 const login = async (config) => {
     var _a;
-    const client = await managementSDKClient(config);
+    const client = await (0, cli_utilities_1.managementSDKClient)(config);
     if (config.email && config.password) {
         const response = await client.login({ email: config.email, password: config.password }).catch(Promise.reject);
         if ((_a = response === null || response === void 0 ? void 0 : response.user) === null || _a === void 0 ? void 0 : _a.authtoken) {
@@ -22,18 +21,18 @@ const login = async (config) => {
                 authtoken: response.user.authtoken,
                 'X-User-Agent': 'contentstack-export/v',
             };
-            await authHandler.setConfigData('basicAuth', response.user);
-            (0, logger_1.log)(config, 'Contentstack account authenticated successfully!', 'success');
+            await cli_utilities_1.authHandler.setConfigData('basicAuth', response.user);
+            cli_utilities_1.log.success(`Contentstack account authenticated successfully!`, config.context);
             return config;
         }
         else {
-            (0, logger_1.log)(config, 'Failed to login, Invalid credentials', 'error');
+            cli_utilities_1.log.error(`Failed to login, Invalid credentials`, config.context);
             process.exit(1);
         }
     }
     else if (!config.email && !config.password && config.source_stack && config.access_token) {
-        (0, logger_1.log)(config, 'Content types, entries, assets, labels, global fields, extensions modules will be exported', 'success');
-        (0, logger_1.log)(config, 'Email, password, or management token is not set in the config, cannot export Webhook and label modules', 'success');
+        cli_utilities_1.log.info(`Content types, entries, assets, labels, global fields, extensions modules will be exported`, config.context);
+        cli_utilities_1.log.info(`Email, password, or management token is not set in the config, cannot export Webhook and label modules`, config.context);
         config.headers = {
             api_key: config.source_stack,
             access_token: config.access_token,

package/lib/utils/common-helper.js

@@ -7,11 +7,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.writeExportMetaFile = exports.executeTask = exports.formatError = exports.validateConfig = void 0;
 const tslib_1 = require("tslib");
-const promise_limit_1 = tslib_1.__importDefault(require("promise-limit"));
 const path = tslib_1.__importStar(require("path"));
+const promise_limit_1 = tslib_1.__importDefault(require("promise-limit"));
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const file_helper_1 = require("./file-helper");
-const cli_utilities_2 = require("@contentstack/cli-utilities");
 const validateConfig = function (config) {
     if (!config.host || !config.cdn) {
         throw new Error('Host/CDN end point is missing from config');
@@ -83,8 +82,8 @@ exports.executeTask = executeTask;
 const writeExportMetaFile = (exportConfig, metaFilePath) => {
     const exportMeta = {
         contentVersion: exportConfig.contentVersion,
-        logsPath: path.join((0, cli_utilities_2.sanitizePath)(exportConfig.exportDir), 'logs', 'export'),
+        logsPath: (0, cli_utilities_1.getLogPath)(),
     };
-    file_helper_1.fsUtil.writeFile(path.join((0, cli_utilities_2.sanitizePath)(metaFilePath || exportConfig.exportDir), 'export-info.json'), exportMeta);
+    file_helper_1.fsUtil.writeFile(path.join((0, cli_utilities_1.sanitizePath)(metaFilePath || exportConfig.exportDir), 'export-info.json'), exportMeta);
 };
 exports.writeExportMetaFile = writeExportMetaFile;