@contentstack/cli-cm-export 1.9.3 → 1.10.0

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.9.3 linux-x64 node-v18.18.2
+@contentstack/cli-cm-export/1.10.0 linux-x64 node-v18.18.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/config/index.js

@@ -10,7 +10,6 @@ const config = {
         'https://eu-api.contentstack.com': 'https://eu-developerhub-api.contentstack.com',
         'https://azure-na-api.contentstack.com': 'https://azure-na-developerhub-api.contentstack.com',
         'https://azure-eu-api.contentstack.com': 'https://azure-eu-developerhub-api.contentstack.com',
-        'https://stag-api.csnonprod.com': 'https://stag-developerhub-api.csnonprod.com',
     },
     // use below hosts for eu region
     // host:'https://eu-api.contentstack.com/v3',
@@ -26,6 +25,7 @@ const config = {
             'environments',
             'extensions',
             'webhooks',
+            'taxonomies',
             'global-fields',
             'content-types',
             'custom-roles',
@@ -159,6 +159,16 @@ const config = {
             dirName: 'marketplace_apps',
             fileName: 'marketplace_apps.json',
         },
+        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'],
+        },
     },
     languagesCode: [
         'af-za',
@@ -389,5 +399,6 @@ const config = {
     writeConcurrency: 5,
     developerHubBaseUrl: '',
     marketplaceAppEncryptionKey: 'nF2ejRQcTv',
+    onlyTSModules: ['taxonomies'],
 };
 exports.default = config;

package/lib/export/module-exporter.js

@@ -63,11 +63,14 @@ class ModuleExporter {
             });
         }
         else {
-            exportedModuleResponse = await (0, modules_js_1.default)({
-                stackAPIClient: this.stackAPIClient,
-                exportConfig: this.exportConfig,
-                moduleName,
-            });
+            //NOTE - new modules support only ts
+            if (this.exportConfig.onlyTSModules.indexOf(moduleName) === -1) {
+                exportedModuleResponse = await (0, modules_js_1.default)({
+                    stackAPIClient: this.stackAPIClient,
+                    exportConfig: this.exportConfig,
+                    moduleName,
+                });
+            }
         }
         // set master locale to config
         if (moduleName === 'stack' && (exportedModuleResponse === null || exportedModuleResponse === void 0 ? void 0 : exportedModuleResponse.code)) {

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

@@ -0,0 +1,45 @@
+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>;
+    /**
+     * fetch all taxonomies in the provided stack
+     * @param {number} skip
+     * @returns {Promise<any>}
+     */
+    getAllTaxonomies(skip?: number): Promise<any>;
+    /**
+     * remove invalid keys and write data into taxonomies
+     * @function sanitizeTaxonomiesAttribs
+     * @param taxonomies
+     */
+    sanitizeTaxonomiesAttribs(taxonomies: Record<string, string>[]): void;
+    /**
+     * fetch all terms of respective taxonomy and write it into <taxonomy-uid>-terms 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;
+    handleErrorMsg(err: any): void;
+}

package/lib/export/modules/taxonomies.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+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 base_class_1 = tslib_1.__importDefault(require("./base-class"));
+const utils_1 = require("../../utils");
+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
+        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)) {
+            (0, utils_1.log)(this.exportConfig, 'No taxonomies found!', 'info');
+            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');
+        }
+        //fetch all terms of respective and write into taxonomies/terms folder
+        await this.getAllTerms();
+    }
+    /**
+     * fetch all taxonomies in the provided stack
+     * @param {number} skip
+     * @returns {Promise<any>}
+     */
+    async getAllTaxonomies(skip = 0) {
+        if (skip) {
+            this.qs.skip = skip;
+        }
+        await this.stack
+            .taxonomy()
+            .query(this.qs)
+            .find()
+            .then(async (data) => {
+            const { items, count } = data;
+            const taxonomiesCount = count !== undefined ? count : items === null || items === void 0 ? void 0 : items.length;
+            if (items === null || items === void 0 ? void 0 : items.length) {
+                this.sanitizeTaxonomiesAttribs(items);
+                skip += this.taxonomiesConfig.limit || 100;
+                if (skip >= taxonomiesCount) {
+                    return;
+                }
+                return await this.getAllTaxonomies(skip);
+            }
+        })
+            .catch((error) => {
+            this.handleErrorMsg(error);
+        });
+    }
+    /**
+     * remove invalid keys and write data into taxonomies
+     * @function sanitizeTaxonomiesAttribs
+     * @param taxonomies
+     */
+    sanitizeTaxonomiesAttribs(taxonomies) {
+        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
+     * @returns {Promise<void>}
+     */
+    async getAllTerms() {
+        var _a;
+        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');
+            }
+            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');
+            }
+        }
+        (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);
+            }
+        })
+            .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);
+        }
+    }
+    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');
+        }
+    }
+}
+exports.default = ExportTaxonomies;

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

@@ -134,6 +134,18 @@ export default interface DefaultConfig {
             fileName: string;
             requiredKeys: string[];
         };
+        taxonomies: {
+            dirName: string;
+            fileName: string;
+            invalidKeys: string[];
+            dependencies?: Modules[];
+        };
+        terms: {
+            dirName: string;
+            fileName: string;
+            invalidKeys: string[];
+            dependencies?: Modules[];
+        };
     };
     languagesCode: string[];
     apis: {
@@ -155,4 +167,5 @@ export default interface DefaultConfig {
     writeConcurrency: number;
     developerHubBaseUrl: string;
     marketplaceAppEncryptionKey: string;
+    onlyTSModules: string[];
 }

package/lib/types/index.d.ts

@@ -20,7 +20,7 @@ export interface User {
     email: string;
     authtoken: string;
 }
-export type Modules = 'stack' | 'assets' | 'locales' | 'environments' | 'extensions' | 'webhooks' | 'global-fields' | 'entries' | 'content-types' | 'custom-roles' | 'workflows' | 'labels' | 'marketplace-apps';
+export type Modules = 'stack' | 'assets' | 'locales' | 'environments' | 'extensions' | 'webhooks' | 'global-fields' | 'entries' | 'content-types' | 'custom-roles' | 'workflows' | 'labels' | 'marketplace-apps' | 'taxonomies';
 export type ModuleClassParams = {
     stackAPIClient: ReturnType<ContentstackClient['stack']>;
     exportConfig: ExportConfig;
@@ -90,5 +90,19 @@ export interface StackConfig {
     dependencies?: Modules[];
     limit?: number;
 }
+export interface TaxonomiesConfig {
+    dirName: string;
+    fileName: string;
+    invalidKeys: string[];
+    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';

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.9.3",
+  "version": "1.10.0",
   "commands": {
     "cm:stacks:export": {
       "id": "cm:stacks:export",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-cm-export",
   "description": "Contentstack CLI plugin to export content from stack",
-  "version": "1.9.3",
+  "version": "1.10.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {