@contentstack/cli-cm-export 1.10.5 → 1.11.1

package/README.md

@@ -48,7 +48,7 @@ $ npm install -g @contentstack/cli-cm-export
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-export/1.10.5 linux-x64 node-v18.19.0
+@contentstack/cli-cm-export/1.11.1 linux-x64 node-v18.19.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

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

@@ -9,7 +9,7 @@ const utils_1 = require("../../../utils");
 class ExportCommand extends cli_command_1.Command {
     async run() {
         var _a;
-        let exportDir;
+        let exportDir = (0, cli_utilities_1.pathValidator)('logs');
         try {
             const { flags } = await this.parse(ExportCommand);
             let exportConfig = await (0, utils_1.setupExportConfig)(flags);
@@ -23,11 +23,11 @@ class ExportCommand extends cli_command_1.Command {
                 (0, utils_1.writeExportMetaFile)(exportConfig);
             }
             (0, utils_1.log)(exportConfig, `The content of the stack ${exportConfig.apiKey} has been exported successfully!`, 'success');
-            (0, utils_1.log)(exportConfig, `The log has been stored at '${path_1.default.join(exportDir, 'logs', 'export')}'`, 'success');
+            (0, utils_1.log)(exportConfig, `The log has been stored at '${(0, cli_utilities_1.pathValidator)(path_1.default.join(exportDir, 'logs', 'export'))}'`, 'success');
         }
         catch (error) {
             (0, utils_1.log)({ data: exportDir }, `Failed to export stack content - ${(0, utils_1.formatError)(error)}`, 'error');
-            (0, utils_1.log)({ data: exportDir }, `The log has been stored at ${exportDir ? path_1.default.join(exportDir, 'logs', 'export') : path_1.default.join(__dirname, 'logs')}`, 'info');
+            (0, utils_1.log)({ data: exportDir }, `The log has been stored at ${exportDir}`, 'info');
         }
     }
 }

package/lib/config/index.js

@@ -165,13 +165,8 @@ const config = {
         taxonomies: {
             dirName: 'taxonomies',
             fileName: 'taxonomies.json',
-            invalidKeys: ['updated_at', 'created_by', 'updated_by', 'stackHeaders', 'urlPath'],
-        },
-        terms: {
-            dirName: 'terms',
-            fileName: 'terms.json',
-            invalidKeys: ['updated_at', 'created_by', 'updated_by', 'stackHeaders', 'urlPath'],
-        },
+            invalidKeys: ['updated_at', 'created_by', 'updated_by', 'stackHeaders', 'urlPath', 'created_at'],
+        }
     },
     languagesCode: [
         'af-za',

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

@@ -23,7 +23,7 @@ export type CustomPromiseHandlerInput = {
     isLastRequest: boolean;
 };
 export type CustomPromiseHandler = (input: CustomPromiseHandlerInput) => Promise<any>;
-export type ApiModuleType = 'stack' | 'asset' | 'assets' | 'entry' | 'entries' | 'content-type' | 'content-types' | 'stacks' | 'versioned-entries' | 'download-asset';
+export type ApiModuleType = 'stack' | 'asset' | 'assets' | 'entry' | 'entries' | 'content-type' | 'content-types' | 'stacks' | 'versioned-entries' | 'download-asset' | 'export-taxonomy';
 export default abstract class BaseClass {
     readonly client: any;
     exportConfig: ExportConfig;

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

@@ -110,6 +110,12 @@ class BaseClass {
                     .download({ url, responseType: 'stream' })
                     .then((response) => resolve({ response, isLastRequest, additionalInfo }))
                     .catch((error) => reject({ error, isLastRequest, additionalInfo }));
+            case 'export-taxonomy':
+                return this.stack
+                    .taxonomy(uid)
+                    .export()
+                    .then((response) => resolve({ response, uid }))
+                    .catch((error) => reject({ error, uid }));
             default:
                 return Promise.resolve();
         }

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

@@ -2,12 +2,9 @@ import BaseClass from './base-class';
 import { ModuleClassParams } from '../../types';
 export default class ExportTaxonomies extends BaseClass {
     private taxonomies;
-    private terms;
     private taxonomiesConfig;
-    private termsConfig;
     private qs;
     taxonomiesFolderPath: string;
-    termsFolderPath: string;
     constructor({ exportConfig, stackAPIClient }: ModuleClassParams);
     start(): Promise<void>;
     /**
@@ -23,23 +20,9 @@ export default class ExportTaxonomies extends BaseClass {
      */
     sanitizeTaxonomiesAttribs(taxonomies: Record<string, string>[]): void;
     /**
-     * fetch all terms of respective taxonomy and write it into <taxonomy-uid>-terms file
+     * Export all taxonomies details using metadata(this.taxonomies) and write it into respective <taxonomy-uid>.json file
      * @returns {Promise<void>}
      */
-    getAllTerms(): Promise<void>;
-    /**
-     * fetch all terms of the provided taxonomy uid
-     * @async
-     * @param {string} taxonomyUID
-     * @param {number} skip
-     * @returns {Promise<any>}
-     */
-    fetchTermsOfTaxonomy(taxonomyUID: string, skip?: number): Promise<any>;
-    /**
-     * remove invalid keys and write data into taxonomies
-     * @function sanitizeTaxonomiesAttribs
-     * @param terms
-     */
-    sanitizeTermsAttribs(terms: Record<string, string>[]): void;
+    exportTaxonomies(): Promise<void>;
     handleErrorMsg(err: any): void;
 }

package/lib/export/modules/taxonomies.js

@@ -11,18 +11,13 @@ class ExportTaxonomies extends base_class_1.default {
     constructor({ exportConfig, stackAPIClient }) {
         super({ exportConfig, stackAPIClient });
         this.taxonomies = {};
-        this.terms = [];
         this.taxonomiesConfig = exportConfig.modules.taxonomies;
-        this.termsConfig = exportConfig.modules.terms;
-        this.qs = { include_count: true, skip: 0, asc: 'created_at' };
     }
     async start() {
         (0, utils_1.log)(this.exportConfig, 'Starting taxonomies export', 'info');
-        //create taxonomies and terms folder in data directory path
+        //create taxonomies folder
         this.taxonomiesFolderPath = (0, node_path_1.resolve)(this.exportConfig.data, this.exportConfig.branchName || '', this.taxonomiesConfig.dirName);
         await utils_1.fsUtil.makeDirectory(this.taxonomiesFolderPath);
-        this.termsFolderPath = (0, node_path_1.resolve)(this.taxonomiesFolderPath, this.termsConfig.dirName);
-        await utils_1.fsUtil.makeDirectory(this.termsFolderPath);
         //fetch all taxonomies and write into taxonomies folder
         await this.getAllTaxonomies();
         if (this.taxonomies === undefined || (0, isEmpty_1.default)(this.taxonomies)) {
@@ -30,11 +25,10 @@ class ExportTaxonomies extends base_class_1.default {
             return;
         }
         else {
-            utils_1.fsUtil.writeFile((0, node_path_1.resolve)(this.taxonomiesFolderPath, this.taxonomiesConfig.fileName), this.taxonomies);
-            (0, utils_1.log)(this.exportConfig, 'All taxonomies exported successfully!', 'success');
+            utils_1.fsUtil.writeFile((0, node_path_1.resolve)(this.taxonomiesFolderPath, 'taxonomies.json'), this.taxonomies);
+            await this.exportTaxonomies();
         }
-        //fetch all terms of respective and write into taxonomies/terms folder
-        await this.getAllTerms();
+        (0, utils_1.log)(this.exportConfig, `All taxonomies exported successfully!`, 'success');
     }
     /**
      * fetch all taxonomies in the provided stack
@@ -74,72 +68,40 @@ class ExportTaxonomies extends base_class_1.default {
         for (let index = 0; index < (taxonomies === null || taxonomies === void 0 ? void 0 : taxonomies.length); index++) {
             const taxonomyUID = taxonomies[index].uid;
             this.taxonomies[taxonomyUID] = (0, omit_1.default)(taxonomies[index], this.taxonomiesConfig.invalidKeys);
-            (0, utils_1.log)(this.exportConfig, `'${taxonomyUID}' taxonomy exported successfully!`, 'success');
         }
     }
     /**
-     * fetch all terms of respective taxonomy and write it into <taxonomy-uid>-terms file
+     * Export all taxonomies details using metadata(this.taxonomies) and write it into respective <taxonomy-uid>.json file
      * @returns {Promise<void>}
      */
-    async getAllTerms() {
-        var _a;
+    async exportTaxonomies() {
         const taxonomiesUID = (0, keys_1.default)(this.taxonomies) || [];
-        this.qs.depth = 0;
-        for (let index = 0; index < (taxonomiesUID === null || taxonomiesUID === void 0 ? void 0 : taxonomiesUID.length); index++) {
-            const taxonomyUID = taxonomiesUID[index];
-            this.terms = [];
-            await this.fetchTermsOfTaxonomy(taxonomyUID);
-            if (!((_a = this.terms) === null || _a === void 0 ? void 0 : _a.length)) {
-                (0, utils_1.log)(this.exportConfig, `No terms found for taxonomy - '${taxonomyUID}'!`, 'info');
+        const onSuccess = ({ response, uid }) => {
+            const filePath = (0, node_path_1.resolve)(this.taxonomiesFolderPath, `${uid}.json`);
+            utils_1.fsUtil.writeFile(filePath, response);
+            (0, utils_1.log)(this.exportConfig, `'${uid}' taxonomy exported successfully!`, 'success');
+        };
+        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 {
-                utils_1.fsUtil.writeFile((0, node_path_1.resolve)(this.termsFolderPath, `${taxonomyUID}-${this.termsConfig.fileName}`), this.terms);
-                (0, utils_1.log)(this.exportConfig, `Terms from taxonomy '${taxonomyUID}' exported successfully!`, 'success');
+            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');
             }
-        }
-        (0, utils_1.log)(this.exportConfig, `All the terms exported successfully!`, 'success');
-    }
-    /**
-     * fetch all terms of the provided taxonomy uid
-     * @async
-     * @param {string} taxonomyUID
-     * @param {number} skip
-     * @returns {Promise<any>}
-     */
-    async fetchTermsOfTaxonomy(taxonomyUID, skip = 0) {
-        if (skip) {
-            this.qs.skip = skip;
-        }
-        await this.stack
-            .taxonomy(taxonomyUID)
-            .terms()
-            .query(this.qs)
-            .find()
-            .then(async (data) => {
-            const { items, count } = data;
-            const termsCount = count !== undefined ? count : items === null || items === void 0 ? void 0 : items.length;
-            if (items === null || items === void 0 ? void 0 : items.length) {
-                this.sanitizeTermsAttribs(items);
-                skip += this.taxonomiesConfig.limit || 100;
-                if (skip >= termsCount) {
-                    return;
-                }
-                return await this.fetchTermsOfTaxonomy(taxonomyUID, skip);
+            else {
+                (0, utils_1.log)(this.exportConfig, `Failed to export taxonomy - '${uid}'! ${error}`, 'error');
             }
-        })
-            .catch((error) => {
-            this.handleErrorMsg(error);
-        });
-    }
-    /**
-     * remove invalid keys and write data into taxonomies
-     * @function sanitizeTaxonomiesAttribs
-     * @param terms
-     */
-    sanitizeTermsAttribs(terms) {
-        for (let index = 0; index < (terms === null || terms === void 0 ? void 0 : terms.length); index++) {
-            const term = (0, omit_1.default)(terms[index], this.termsConfig.invalidKeys);
-            this.terms.push(term);
+        };
+        for (let index = 0; index < (taxonomiesUID === null || taxonomiesUID === void 0 ? void 0 : taxonomiesUID.length); index++) {
+            const taxonomyUID = taxonomiesUID[index];
+            await this.makeAPICall({
+                reject: onReject,
+                resolve: onSuccess,
+                uid: taxonomyUID,
+                module: 'export-taxonomy',
+            });
         }
     }
     handleErrorMsg(err) {

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

@@ -140,12 +140,6 @@ export default interface DefaultConfig {
             invalidKeys: string[];
             dependencies?: Modules[];
         };
-        terms: {
-            dirName: string;
-            fileName: string;
-            invalidKeys: string[];
-            dependencies?: Modules[];
-        };
     };
     languagesCode: string[];
     apis: {

package/lib/types/index.d.ts

@@ -97,13 +97,6 @@ export interface TaxonomiesConfig {
     dependencies?: Modules[];
     limit?: number;
 }
-export interface TermsConfig {
-    dirName: string;
-    fileName: string;
-    invalidKeys: string[];
-    dependencies?: Modules[];
-    limit?: number;
-}
 export { default as DefaultConfig } from './default-config';
 export { default as ExportConfig } from './export-config';
 export * from './marketplace-app';

package/lib/utils/export-config-handler.js

@@ -17,6 +17,14 @@ const setupConfig = async (exportCmdFlags) => {
         config = merge_1.default.recursive(config, externalConfig);
     }
     config.exportDir = exportCmdFlags['data'] || exportCmdFlags['data-dir'] || config.data || (await (0, interactive_1.askExportDir)());
+    const pattern = /[*$%#<>{}!&?]/g;
+    if (pattern.test(config.exportDir)) {
+        cli_utilities_1.cliux.print(`\nPlease add a directory path without any of the special characters: (*,&,{,},[,],$,%,<,>,?,!)`, {
+            color: 'yellow',
+        });
+        config.exportDir = await (0, interactive_1.askExportDir)();
+    }
+    config.exportDir = config.exportDir.replace(/['"]/g, '');
     config.exportDir = path.resolve(config.exportDir);
     //Note to support the old key
     config.data = config.exportDir;

package/lib/utils/interactive.d.ts

@@ -4,4 +4,3 @@ export declare const askOTP: () => Promise<string>;
 export declare const askUsername: () => Promise<string>;
 export declare const askExportDir: () => Promise<string>;
 export declare const askAPIKey: () => Promise<string>;
-export declare const askDeveloperHub: (regionName: string) => Promise<string>;

package/lib/utils/interactive.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.askDeveloperHub = exports.askAPIKey = exports.askExportDir = exports.askUsername = exports.askOTP = exports.askOTPChannel = exports.askPassword = void 0;
+exports.askAPIKey = exports.askExportDir = exports.askUsername = exports.askOTP = exports.askOTPChannel = exports.askPassword = void 0;
 const tslib_1 = require("tslib");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const path = tslib_1.__importStar(require("path"));
@@ -48,15 +48,17 @@ const askUsername = async () => {
 };
 exports.askUsername = askUsername;
 const askExportDir = async () => {
-    const result = await cli_utilities_1.cliux.inquire({
+    let result = await cli_utilities_1.cliux.inquire({
         type: 'input',
         message: 'Enter the path for storing the content: (current folder)',
         name: 'dir',
+        validate: cli_utilities_1.validatePath,
     });
     if (!result) {
         return process.cwd();
     }
     else {
+        result = result.replace(/['"]/g, '');
         return path.resolve(result);
     }
 };
@@ -69,16 +71,3 @@ const askAPIKey = async () => {
     });
 };
 exports.askAPIKey = askAPIKey;
-const askDeveloperHub = async (regionName) => {
-    return await cli_utilities_1.cliux.inquire({
-        type: 'input',
-        name: 'name',
-        validate: (url) => {
-            if (!url)
-                return "Developer-hub URL can't be empty.";
-            return true;
-        },
-        message: `Enter the developer-hub base URL for the ${regionName} region - `,
-    });
-};
-exports.askDeveloperHub = askDeveloperHub;

package/lib/utils/logger.js

@@ -122,7 +122,7 @@ function init(_logPath) {
     };
 }
 const log = async (config, message, type) => {
-    const logsPath = config.data || __dirname;
+    const logsPath = config.data;
     // ignoring the type argument, as we are not using it to create a logfile anymore
     if (type !== 'error') {
         // removed type argument from init method

package/lib/utils/marketplace-app-helper.d.ts

@@ -1,5 +1,5 @@
 import { NodeCrypto } from '@contentstack/cli-utilities';
 import { ExportConfig } from '../types';
-export declare const getDeveloperHubUrl: (exportConfig: ExportConfig) => Promise<any>;
+export declare const getDeveloperHubUrl: (exportConfig: ExportConfig) => Promise<string>;
 export declare function getOrgUid(config: ExportConfig): Promise<string>;
 export declare function createNodeCryptoInstance(config: ExportConfig): Promise<NodeCrypto>;

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

@@ -3,14 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createNodeCryptoInstance = exports.getOrgUid = exports.getDeveloperHubUrl = void 0;
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const utils_1 = require("../utils");
-const interactive_1 = require("./interactive");
 const getDeveloperHubUrl = async (exportConfig) => {
-    const { cma, name } = cli_utilities_1.configHandler.get('region') || {};
-    let developerHubBaseUrl = exportConfig === null || exportConfig === void 0 ? void 0 : exportConfig.developerHubUrls[cma];
-    if (!developerHubBaseUrl) {
-        developerHubBaseUrl = await (0, interactive_1.askDeveloperHub)(name);
-    }
-    return developerHubBaseUrl.startsWith('http') ? developerHubBaseUrl : `https://${developerHubBaseUrl}`;
+    return (0, cli_utilities_1.createDeveloperHubUrl)(exportConfig.host);
 };
 exports.getDeveloperHubUrl = getDeveloperHubUrl;
 async function getOrgUid(config) {

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.10.5",
+  "version": "1.11.1",
   "commands": {
     "cm:stacks:export": {
       "id": "cm:stacks:export",

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@contentstack/cli-cm-export",
   "description": "Contentstack CLI plugin to export content from stack",
-  "version": "1.10.5",
+  "version": "1.11.1",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
     "@contentstack/cli-command": "~1.2.16",
-    "@contentstack/cli-utilities": "~1.5.11",
+    "@contentstack/cli-utilities": "~1.6.0",
     "@oclif/core": "^2.9.3",
     "async": "^3.2.4",
     "big-json": "^3.2.0",