@contentstack/cli-cm-import 1.10.0 → 1.10.1

package/README.md

@@ -47,7 +47,7 @@ $ npm install -g @contentstack/cli-cm-import
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-import/1.10.0 linux-x64 node-v18.18.2
+@contentstack/cli-cm-import/1.10.1 linux-x64 node-v18.18.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/commands/cm/stacks/import.js

@@ -4,6 +4,7 @@ const tslib_1 = require("tslib");
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const cli_command_1 = require("@contentstack/cli-command");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
+const log_1 = require("../../../utils/log");
 const import_1 = require("../../../import");
 const utils_1 = require("../../../utils");
 class ImportCommand extends cli_command_1.Command {
@@ -25,6 +26,7 @@ class ImportCommand extends cli_command_1.Command {
             (0, utils_1.log)(importConfig, `The log has been stored at '${node_path_1.default.join(importConfig.backupDir, 'logs', 'import')}'`, 'success');
         }
         catch (error) {
+            (0, log_1.trace)(error, 'error', true);
             (0, utils_1.log)({ data: backupDir }, `Failed to import stack content - ${(0, utils_1.formatError)(error)}`, 'error');
             (0, utils_1.log)({ data: backupDir }, `The log has been stored at ${{ data: backupDir } ? node_path_1.default.join(backupDir || __dirname, 'logs', 'import') : node_path_1.default.join(__dirname, 'logs')}`, 'info');
         }

package/lib/import/module-importer.js

@@ -2,9 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
-const utils_1 = require("../utils");
 const modules_1 = tslib_1.__importDefault(require("./modules"));
 const modules_js_1 = tslib_1.__importDefault(require("./modules-js"));
+const utils_1 = require("../utils");
 class ModuleImporter {
     constructor(managementAPIClient, importConfig) {
         this.managementAPIClient = managementAPIClient;
@@ -43,6 +43,8 @@ class ModuleImporter {
             // To support the old config
             this.importConfig.data = backupDir;
         }
+        // NOTE init log
+        (0, utils_1.initLogger)(this.importConfig);
         await (0, utils_1.sanitizeStack)(this.stackAPIClient);
         return this.import();
     }
@@ -58,7 +60,7 @@ class ModuleImporter {
         (0, utils_1.log)(this.importConfig, `Starting import of ${moduleName} module`, 'info');
         // import the modules by name
         // calls the module runner which inturn calls the module itself
-        // Todo: Implement a mechanism to determine whether module is new or old
+        // NOTE: Implement a mechanism to determine whether module is new or old
         if (this.importConfig.contentVersion === 2) {
             return (0, modules_1.default)({
                 stackAPIClient: this.stackAPIClient,

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

@@ -14,6 +14,7 @@ const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const toLower_1 = tslib_1.__importDefault(require("lodash/toLower"));
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
+const log_1 = require("../../utils/log");
 const interactive_1 = require("../../utils/interactive");
 const utils_1 = require("../../utils");
 class ImportMarketplaceApps extends base_class_1.default {
@@ -54,7 +55,7 @@ class ImportMarketplaceApps extends base_class_1.default {
         this.developerHubBaseUrl = this.importConfig.developerHubBaseUrl || (await (0, utils_1.getDeveloperHubUrl)(this.importConfig));
         this.sdkClient = await (0, cli_utilities_1.managementSDKClient)({ endpoint: this.developerHubBaseUrl });
         this.appSdkAxiosInstance = await (0, cli_utilities_1.managementSDKClient)({
-            host: this.developerHubBaseUrl.split('://').pop()
+            host: this.developerHubBaseUrl.split('://').pop(),
         });
         this.importConfig.org_uid = await (0, utils_1.getOrgUid)(this.importConfig);
         await this.setHttpClient();
@@ -223,6 +224,7 @@ class ImportMarketplaceApps extends base_class_1.default {
                 return this.createPrivateApps(updatedApp, true, appSuffix + 1);
             }
             else {
+                (0, log_1.trace)(response, 'error', true);
                 (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(message), 'error');
                 if (this.importConfig.forceStopMarketplaceAppsPrompt)
                     return Promise.resolve();
@@ -308,13 +310,17 @@ class ImportMarketplaceApps extends base_class_1.default {
         })
             .then(({ data }) => {
             if (data === null || data === void 0 ? void 0 : data.message) {
+                (0, log_1.trace)(data, 'error', true);
                 (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(data.message), 'success');
             }
             else {
                 (0, utils_1.log)(this.importConfig, `${app.manifest.name} app config updated successfully.!`, 'success');
             }
         })
-            .catch((error) => (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(error), 'error'));
+            .catch((error) => {
+            (0, log_1.trace)(error, 'error', true);
+            (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(error), 'error');
+        });
     }
 }
 exports.default = ImportMarketplaceApps;

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

@@ -9,8 +9,9 @@ const path = require('path');
 const chalk = require('chalk');
 const mkdirp = require('mkdirp');
 const { cliux, HttpClient, NodeCrypto, managementSDKClient, isAuthenticated, HttpClientDecorator, OauthDecorator, } = require('@contentstack/cli-utilities');
-const { log, fileHelper: { readFileSync, writeFile }, formatError, } = require('../../utils');
-let { default: config } = require('../../config');
+const { log, formatError, fileHelper: { readFileSync, writeFile }, } = require('../../utils');
+const { trace } = require('../../utils/log');
+const { default: config } = require('../../config');
 const { getDeveloperHubUrl, getAllStackSpecificApps } = require('../../utils/marketplace-app-helper');
 module.exports = class ImportMarketplaceApps {
     constructor(importConfig, stackAPIClient) {
@@ -306,6 +307,7 @@ module.exports = class ImportMarketplaceApps {
                 updateParam = Object.assign(Object.assign({ manifest: app.manifest }, installation), { configuration, server_configuration });
             }
             else if (installation.message) {
+                trace(installation, 'error', true);
                 log(this.config, formatError(installation.message), 'success');
                 await this.confirmToCloseProcess(installation);
             }
@@ -329,6 +331,7 @@ module.exports = class ImportMarketplaceApps {
                 .get(response.redirect_url)
                 .then(async ({ response }) => {
                 if (_.includes([501, 403], response.status)) {
+                    trace(response, 'error', true); // NOTE Log complete stack and hide on UI
                     log(this.config, `${appName} - ${response.statusText}, OAuth api call failed.!`, 'error');
                     log(this.config, formatError(response), 'error');
                     await this.confirmToCloseProcess({ message: response.data });
@@ -338,6 +341,7 @@ module.exports = class ImportMarketplaceApps {
                 }
             })
                 .catch((error) => {
+                trace(error, 'error', true);
                 if (_.includes([501, 403], error.status)) {
                     log(this.config, formatError(error), 'error');
                 }
@@ -403,13 +407,17 @@ module.exports = class ImportMarketplaceApps {
         })
             .then(({ data }) => {
             if (data.message) {
+                trace(data, 'error', true);
                 log(this.config, formatError(data.message), 'success');
             }
             else {
                 log(this.config, `${app.manifest.name} app config updated successfully.!`, 'success');
             }
         })
-            .catch((error) => log(this.config, formatError(error), 'error'));
+            .catch((error) => {
+            trace(data, 'error', true);
+            log(this.config, formatError(error), 'error');
+        });
     }
     validateAppName(name) {
         if (name.length < 3 || name.length > 20) {

package/lib/utils/backup-handler.d.ts

@@ -1,2 +1,2 @@
 import { ImportConfig } from '../types';
-export default function setupBackupDir(importConfig: ImportConfig): Promise<string>;
+export default function backupHandler(importConfig: ImportConfig): Promise<string>;

package/lib/utils/backup-handler.js

@@ -5,44 +5,45 @@ const path = tslib_1.__importStar(require("path"));
 const fs_extra_1 = require("fs-extra");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const index_1 = require("./index");
-function setupBackupDir(importConfig) {
-    return new Promise(async (resolve, reject) => {
-        if (importConfig.hasOwnProperty('useBackedupDir')) {
-            return resolve(importConfig.useBackedupDir);
-        }
-        const subDir = isSubDirectory(importConfig);
-        let backupDirPath;
-        if (subDir) {
-            backupDirPath = path.resolve(importConfig.contentDir, '..', '_backup_' + Math.floor(Math.random() * 1000));
-            if (importConfig.createBackupDir) {
-                cli_utilities_1.cliux.print(`Warning!!! Provided backup directory path is a sub directory of the content directory, Cannot copy to a sub directory. Hence new backup directory created - ${backupDirPath}`, {
-                    color: 'yellow',
-                });
-            }
+async function backupHandler(importConfig) {
+    if (importConfig.hasOwnProperty('useBackedupDir')) {
+        return importConfig.useBackedupDir;
+    }
+    let backupDirPath;
+    const subDir = isSubDirectory(importConfig);
+    if (subDir) {
+        backupDirPath = path.resolve(importConfig.contentDir, '..', '_backup_' + Math.floor(Math.random() * 1000));
+        if (importConfig.createBackupDir) {
+            cli_utilities_1.cliux.print(`Warning!!! Provided backup directory path is a sub directory of the content directory, Cannot copy to a sub directory. Hence new backup directory created - ${backupDirPath}`, {
+                color: 'yellow',
+            });
         }
-        else {
-            //NOTE: If the backup folder's directory is provided, create it at that location; otherwise, the default path (working directory).
-            backupDirPath = path.join(process.cwd(), '_backup_' + Math.floor(Math.random() * 1000));
-            if (importConfig.createBackupDir) {
-                if (index_1.fileHelper.fileExistsSync(importConfig.createBackupDir)) {
-                    index_1.fileHelper.removeDirSync(importConfig.createBackupDir);
-                }
-                index_1.fileHelper.makeDirectory(importConfig.createBackupDir);
-                backupDirPath = importConfig.createBackupDir;
+    }
+    else {
+        // NOTE: If the backup folder's directory is provided, create it at that location; otherwise, the default path (working directory).
+        backupDirPath = path.join(process.cwd(), '_backup_' + Math.floor(Math.random() * 1000));
+        if (importConfig.createBackupDir) {
+            if (index_1.fileHelper.fileExistsSync(importConfig.createBackupDir)) {
+                index_1.fileHelper.removeDirSync(importConfig.createBackupDir);
             }
+            index_1.fileHelper.makeDirectory(importConfig.createBackupDir);
+            backupDirPath = importConfig.createBackupDir;
         }
-        if (backupDirPath) {
-            cli_utilities_1.cliux.print('Copying content to the backup directory...');
+    }
+    if (backupDirPath) {
+        cli_utilities_1.cliux.print('Copying content to the backup directory...');
+        return new Promise((resolve, reject) => {
             return (0, fs_extra_1.copy)(importConfig.contentDir, backupDirPath, (error) => {
                 if (error) {
+                    (0, index_1.trace)(error, 'error', true);
                     return reject(error);
                 }
-                return resolve(backupDirPath);
+                resolve(backupDirPath);
             });
-        }
-    });
+        });
+    }
 }
-exports.default = setupBackupDir;
+exports.default = backupHandler;
 /**
  * Check whether provided backup directory path is sub directory or not
  * @param importConfig
@@ -53,8 +54,8 @@ function isSubDirectory(importConfig) {
     const child = importConfig.createBackupDir ? importConfig.createBackupDir : process.cwd();
     const relative = path.relative(parent, child);
     if (relative) {
-        return relative && !relative.startsWith('..') && !path.isAbsolute(relative);
+        return !relative.startsWith('..') && !path.isAbsolute(relative);
     }
-    //true if both parent and child have same path
+    // true if both parent and child have same path
     return true;
 }

package/lib/utils/index.d.ts

@@ -10,3 +10,4 @@ export { schemaTemplate, suppressSchemaReference, removeReferenceFields } from '
 export { lookupExtension } from './extension-helper';
 export { lookupEntries, removeUidsFromJsonRteFields, removeEntryRefsFromJSONRTE, restoreJsonRteEntryRefs, } from './entries-helper';
 export * from './common-helper';
+export * from './log';

package/lib/utils/index.js

@@ -40,3 +40,4 @@ Object.defineProperty(exports, "removeUidsFromJsonRteFields", { enumerable: true
 Object.defineProperty(exports, "removeEntryRefsFromJSONRTE", { enumerable: true, get: function () { return entries_helper_1.removeEntryRefsFromJSONRTE; } });
 Object.defineProperty(exports, "restoreJsonRteEntryRefs", { enumerable: true, get: function () { return entries_helper_1.restoreJsonRteEntryRefs; } });
 tslib_1.__exportStar(require("./common-helper"), exports);
+tslib_1.__exportStar(require("./log"), exports);

package/lib/utils/log.d.ts

@@ -0,0 +1,10 @@
+import { LogEntry } from 'winston/index';
+import { Logger } from '@contentstack/cli-utilities';
+import { LogsType, MessageType } from '@contentstack/cli-utilities/lib/logger';
+import { ImportConfig } from '../types';
+export declare function isImportConfig(config: ImportConfig | MessageType): config is ImportConfig;
+export declare function log(entry: LogEntry): void;
+export declare function log(error: MessageType, logType: LogsType): void;
+export declare function log(error: MessageType, logType: 'error', hidden: boolean): void;
+export declare function initLogger(config?: ImportConfig | undefined): Logger;
+export declare const trace: typeof log;

package/lib/utils/log.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.trace = exports.initLogger = exports.log = exports.isImportConfig = void 0;
+const path_1 = require("path");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+let logger;
+function isImportConfig(config) {
+    return config.data !== undefined && (config === null || config === void 0 ? void 0 : config.contentVersion) !== undefined;
+}
+exports.isImportConfig = isImportConfig;
+function log(entryOrMessage, logType, hidden) {
+    logger = initLogger();
+    if (logType === 'error') {
+        logger.log(entryOrMessage, logType, hidden);
+    }
+    else {
+        logger.log(entryOrMessage, logType);
+    }
+}
+exports.log = log;
+function initLogger(config) {
+    var _a;
+    if (!logger) {
+        const basePath = (0, path_1.join)((_a = config === null || config === void 0 ? void 0 : config.data) !== null && _a !== void 0 ? _a : process.cwd(), 'logs', 'import');
+        logger = new cli_utilities_1.Logger(Object.assign(config !== null && config !== void 0 ? config : {}, { basePath }));
+    }
+    return logger;
+}
+exports.initLogger = initLogger;
+exports.trace = log;

package/lib/utils/logger.js

@@ -9,7 +9,6 @@ exports.unlinkFileLogger = exports.log = void 0;
 const tslib_1 = require("tslib");
 const winston = tslib_1.__importStar(require("winston"));
 const path = tslib_1.__importStar(require("path"));
-const mkdirp_1 = tslib_1.__importDefault(require("mkdirp"));
 const slice = Array.prototype.slice;
 const ansiRegexPattern = [
     '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)',
@@ -55,9 +54,7 @@ let successTransport;
 let errorTransport;
 function init(_logPath) {
     if (!logger || !errorLogger) {
-        var logsDir = path.resolve(_logPath, 'logs', 'import');
-        // Create dir if doesn't already exist
-        mkdirp_1.default.sync(logsDir);
+        const logsDir = path.resolve(_logPath, 'logs', 'import');
         successTransport = {
             filename: path.join(logsDir, 'success.log'),
             maxFiles: 20,

package/lib/utils/marketplace-app-helper.js

@@ -9,12 +9,13 @@ const includes_1 = tslib_1.__importDefault(require("lodash/includes"));
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const logger_1 = require("./logger");
-const interactive_1 = require("./interactive");
+const log_1 = require("../utils/log");
 const utils_1 = require("../utils");
+const interactive_1 = require("./interactive");
 const interactive_2 = require("../utils/interactive");
 const getAllStackSpecificApps = async (developerHubBaseUrl, httpClient, config) => {
     const appSdkAxiosInstance = await (0, cli_utilities_1.managementSDKClient)({
-        host: developerHubBaseUrl.split('://').pop()
+        host: developerHubBaseUrl.split('://').pop(),
     });
     return await appSdkAxiosInstance.axiosInstance
         .get(`${developerHubBaseUrl}/installations?target_uids=${config.target_stack}`, {
@@ -23,7 +24,10 @@ const getAllStackSpecificApps = async (developerHubBaseUrl, httpClient, config)
         },
     })
         .then(({ data }) => data.data)
-        .catch((error) => (0, logger_1.log)(config, `Failed to export marketplace-apps ${(0, utils_1.formatError)(error)}`, 'error'));
+        .catch((error) => {
+        (0, log_1.trace)(error, 'error', true);
+        (0, logger_1.log)(config, `Failed to export marketplace-apps ${(0, utils_1.formatError)(error)}`, 'error');
+    });
 };
 exports.getAllStackSpecificApps = getAllStackSpecificApps;
 const getDeveloperHubUrl = async (config) => {
@@ -41,6 +45,7 @@ const getOrgUid = async (config) => {
         .stack({ api_key: config.target_stack })
         .fetch()
         .catch((error) => {
+        (0, log_1.trace)(error, 'error', true);
         (0, logger_1.log)(config, (0, utils_1.formatError)(error), 'error');
     });
     return (tempStackData === null || tempStackData === void 0 ? void 0 : tempStackData.org_uid) || '';
@@ -92,6 +97,7 @@ const makeRedirectUrlCall = async (response, appName, config) => {
             .get(response.redirect_url)
             .then(async ({ response }) => {
             if ((0, includes_1.default)([501, 403], response.status)) {
+                (0, log_1.trace)(response, 'error', true);
                 (0, logger_1.log)(config, `${appName} - ${response.statusText}, OAuth api call failed.!`, 'error');
                 (0, logger_1.log)(config, (0, utils_1.formatError)(response), 'error');
                 await (0, exports.confirmToCloseProcess)(response.data, config);
@@ -101,6 +107,7 @@ const makeRedirectUrlCall = async (response, appName, config) => {
             }
         })
             .catch((error) => {
+            (0, log_1.trace)(error, 'error', true);
             if ((0, includes_1.default)([501, 403], error.status)) {
                 (0, logger_1.log)(config, (0, utils_1.formatError)(error), 'error');
             }
@@ -145,6 +152,9 @@ const updateAppConfig = async (client, config, app, payload) => {
         var _a;
         (0, logger_1.log)(config, `${(_a = app === null || app === void 0 ? void 0 : app.manifest) === null || _a === void 0 ? void 0 : _a.name} app config updated successfully.!`, 'success');
     })
-        .catch((error) => (0, logger_1.log)(config, `Failed to update app config.${(0, utils_1.formatError)(error)}`, 'error'));
+        .catch((error) => {
+        (0, log_1.trace)(error, 'error', true);
+        (0, logger_1.log)(config, `Failed to update app config.${(0, utils_1.formatError)(error)}`, 'error');
+    });
 };
 exports.updateAppConfig = updateAppConfig;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.10.0",
+  "version": "1.10.1",
   "commands": {
     "cm:stacks:import": {
       "id": "cm:stacks:import",

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "1.10.0",
+  "version": "1.10.1",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "~1.2.14",
-    "@contentstack/cli-utilities": "~1.5.4",
-    "@contentstack/management": "~1.10.2",
+    "@contentstack/cli-command": "~1.2.15",
+    "@contentstack/cli-utilities": "~1.5.5",
+    "@contentstack/management": "~1.11.0",
     "@oclif/core": "^2.9.3",
+    "axios": "^1.6.0",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",
     "chalk": "^4.1.2",
@@ -96,4 +97,4 @@
     }
   },
   "repository": "https://github.com/contentstack/cli"
-}
+}