@contentstack/cli-cm-import 1.10.1 → 1.11.0

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

package/lib/config/index.js

@@ -18,7 +18,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',
     },
     modules: {
         apiConcurrency: 5,
@@ -26,6 +25,7 @@ const config = {
             'locales',
             'environments',
             'assets',
+            'taxonomies',
             'extensions',
             'marketplace-apps',
             'global-fields',
@@ -142,6 +142,14 @@ const config = {
             dirName: 'marketplace_apps',
             fileName: 'marketplace_apps.json',
         },
+        taxonomies: {
+            dirName: 'taxonomies',
+            fileName: 'taxonomies.json',
+        },
+        terms: {
+            dirName: 'terms',
+            fileName: 'terms.json',
+        },
     },
     languagesCode: [
         'af-za',
@@ -380,5 +388,6 @@ const config = {
     getEncryptionKeyMaxRetry: 3,
     // useBackedupDir: '',
     // backupConcurrency: 10,
+    onlyTSModules: ['taxonomies'],
 };
 exports.default = config;

package/lib/import/module-importer.js

@@ -68,11 +68,16 @@ class ModuleImporter {
                 moduleName,
             });
         }
-        return (0, modules_js_1.default)({
-            stackAPIClient: this.stackAPIClient,
-            importConfig: this.importConfig,
-            moduleName,
-        });
+        else {
+            //NOTE - new modules support only ts
+            if (this.importConfig.onlyTSModules.indexOf(moduleName) === -1) {
+                return (0, modules_js_1.default)({
+                    stackAPIClient: this.stackAPIClient,
+                    importConfig: this.importConfig,
+                    moduleName,
+                });
+            }
+        }
     }
     async importAllModules() {
         // use the algorithm to determine the parallel and sequential execution of modules

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

@@ -3,7 +3,7 @@ import { ImportConfig, ModuleClassParams } from '../../types';
 export type AdditionalKeys = {
     backupDir: string;
 };
-export type ApiModuleType = 'create-assets' | 'replace-assets' | 'publish-assets' | 'create-assets-folder' | 'create-extensions' | 'update-extensions' | 'create-locale' | 'update-locale' | 'create-gfs' | 'create-cts' | 'update-cts' | 'update-gfs' | 'create-environments' | 'create-labels' | 'update-labels' | 'create-webhooks' | 'create-workflows' | 'create-custom-role' | 'create-entries' | 'update-entries' | 'publish-entries' | 'delete-entries';
+export type ApiModuleType = 'create-assets' | 'replace-assets' | 'publish-assets' | 'create-assets-folder' | 'create-extensions' | 'update-extensions' | 'create-locale' | 'update-locale' | 'create-gfs' | 'create-cts' | 'update-cts' | 'update-gfs' | 'create-environments' | 'create-labels' | 'update-labels' | 'create-webhooks' | 'create-workflows' | 'create-custom-role' | 'create-entries' | 'update-entries' | 'publish-entries' | 'delete-entries' | 'create-taxonomies' | 'create-terms';
 export type ApiOptions = {
     uid?: string;
     url?: string;

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

@@ -255,6 +255,17 @@ class BaseClass {
                     .delete({ locale: additionalInfo.locale })
                     .then(onSuccess)
                     .catch(onReject);
+            case 'create-taxonomies':
+                return this.stack.taxonomy().create({ taxonomy: apiData }).then(onSuccess).catch(onReject);
+            case 'create-terms':
+                if (apiData === null || apiData === void 0 ? void 0 : apiData.taxonomy_uid) {
+                    return this.stack
+                        .taxonomy(apiData.taxonomy_uid)
+                        .terms()
+                        .create({ term: apiData })
+                        .then(onSuccess)
+                        .catch(onReject);
+                }
             default:
                 return Promise.resolve();
         }

package/lib/import/modules/content-types.d.ts

@@ -30,6 +30,8 @@ export default class ContentTypesImport extends BaseClass {
     private installedExtensions;
     private cTsConfig;
     private gFsConfig;
+    private taxonomiesPath;
+    taxonomies: Record<string, unknown>;
     constructor({ importConfig, stackAPIClient }: ModuleClassParams);
     start(): Promise<any>;
     seedCTs(): Promise<any>;

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

@@ -38,6 +38,7 @@ class ContentTypesImport extends base_class_1.default {
         this.gFs = [];
         this.createdGFs = [];
         this.pendingGFs = [];
+        this.taxonomiesPath = path.join(importConfig.data, 'mapper/taxonomies', 'success.json');
     }
     async start() {
         /**
@@ -54,6 +55,7 @@ class ContentTypesImport extends base_class_1.default {
         }
         await utils_1.fsUtil.makeDirectory(this.cTsMapperPath);
         this.installedExtensions = ((await utils_1.fsUtil.readFile(this.marketplaceAppMapperPath)) || { extension_uid: {} }).extension_uid;
+        this.taxonomies = utils_1.fsUtil.readFile(this.taxonomiesPath);
         await this.seedCTs();
         (0, utils_1.log)(this.importConfig, 'Created content types', 'success');
         await this.updateCTs();
@@ -108,7 +110,7 @@ class ContentTypesImport extends base_class_1.default {
     }
     async updateCTs() {
         const onSuccess = ({ response: contentType, apiData: { uid } }) => {
-            (0, utils_1.log)(this.importConfig, `${uid} updated with references`, 'success');
+            (0, utils_1.log)(this.importConfig, `'${uid}' updated with references`, 'success');
         };
         const onReject = ({ error, apiData: { uid } }) => {
             (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(error), 'error');
@@ -141,6 +143,8 @@ class ContentTypesImport extends base_class_1.default {
             }
             this.fieldRules.push(contentType.uid);
         }
+        //will remove taxonomy if taxonomy doesn't exists in stack
+        (0, utils_1.lookUpTaxonomy)(this.importConfig, contentType.schema, this.taxonomies);
         (0, utils_1.lookupExtension)(this.importConfig, contentType.schema, this.importConfig.preserveStackVersion, this.installedExtensions);
         const contentTypePayload = this.stack.contentType(contentType.uid);
         Object.assign(contentTypePayload, (0, lodash_1.cloneDeep)(contentType));

package/lib/import/modules/entries.d.ts

@@ -34,6 +34,8 @@ export default class EntriesImport extends BaseClass {
     private entriesUidMapper;
     private envs;
     private autoCreatedEntries;
+    private taxonomiesPath;
+    taxonomies: Record<string, unknown>;
     constructor({ importConfig, stackAPIClient }: ModuleClassParams);
     start(): Promise<any>;
     disableMandatoryCTReferences(): Promise<void>;

package/lib/import/modules/entries.js

@@ -23,6 +23,7 @@ class EntriesImport extends base_class_1.default {
         this.uniqueUidMapperPath = path.join(this.entriesMapperPath, 'unique-mapping.json');
         this.modifiedCTsPath = path.join(this.entriesMapperPath, 'modified-schemas.json');
         this.marketplaceAppMapperPath = path.join(this.importConfig.data, 'mapper', 'marketplace_apps', 'uid-mapping.json');
+        this.taxonomiesPath = path.join(this.importConfig.data, 'mapper', 'taxonomies', 'terms', 'success.json');
         this.entriesConfig = importConfig.modules.entries;
         this.entriesPath = path.resolve(importConfig.data, this.entriesConfig.dirName);
         this.cTsPath = path.resolve(importConfig.data, importConfig.modules['content-types'].dirName);
@@ -47,6 +48,7 @@ class EntriesImport extends base_class_1.default {
             this.installedExtensions = ((await utils_1.fsUtil.readFile(this.marketplaceAppMapperPath)) || { extension_uid: {} }).extension_uid;
             this.assetUidMapper = utils_1.fsUtil.readFile(this.assetUidMapperPath) || {};
             this.assetUrlMapper = utils_1.fsUtil.readFile(this.assetUrlMapperPath) || {};
+            this.taxonomies = utils_1.fsUtil.readFile(this.taxonomiesPath);
             utils_1.fsUtil.makeDirectory(this.entriesMapperPath);
             await this.disableMandatoryCTReferences();
             this.locales = (0, lodash_1.values)(utils_1.fsUtil.readFile(this.localesPath));
@@ -316,6 +318,8 @@ class EntriesImport extends base_class_1.default {
             if (this.jsonRteCTsWithRef.indexOf(cTUid) > -1) {
                 entry = (0, utils_1.removeEntryRefsFromJSONRTE)(entry, contentType.schema);
             }
+            //will remove term if term doesn't exists in taxonomy
+            (0, utils_1.lookUpTerms)(contentType === null || contentType === void 0 ? void 0 : contentType.schema, entry, this.taxonomies, this.importConfig);
             // will replace all old asset uid/urls with new ones
             entry = (0, utils_1.lookupAssets)({
                 content_type: contentType,

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

@@ -0,0 +1,63 @@
+import BaseClass, { ApiOptions } from './base-class';
+import { ModuleClassParams } from '../../types';
+export default class ImportTaxonomies extends BaseClass {
+    private taxonomiesMapperDirPath;
+    private taxonomiesFolderPath;
+    private taxSuccessPath;
+    private taxFailsPath;
+    private taxonomiesConfig;
+    private taxonomies;
+    private termsFolderPath;
+    private termsMapperDirPath;
+    private termsConfig;
+    private termsSuccessPath;
+    private termsFailsPath;
+    taxonomiesSuccess: Record<string, unknown>;
+    taxonomiesFailed: Record<string, unknown>;
+    termsSuccess: Record<string, Record<string, unknown>>;
+    termsFailed: Record<string, Record<string, unknown>>;
+    terms: Record<string, any>;
+    taxonomyUIDs: string[];
+    constructor({ importConfig, stackAPIClient }: ModuleClassParams);
+    /**
+     * @method start
+     * @returns {Promise<void>} Promise<void>
+     */
+    start(): Promise<void>;
+    /**
+     * create taxonomy and enter success & failure related data into taxonomies mapper file
+     * @method importTaxonomies
+     * @async
+     * @returns {Promise<any>} Promise<any>
+     */
+    importTaxonomies(): Promise<any>;
+    /**
+     * @method serializeTaxonomy
+     * @param {ApiOptions} apiOptions ApiOptions
+     * @returns {ApiOptions} ApiOptions
+     */
+    serializeTaxonomy(apiOptions: ApiOptions): ApiOptions;
+    /**
+     * create taxonomies success and fail in (mapper/taxonomies)
+     * @method createTaxonomySuccessAndFailedFile
+     */
+    createTaxonomySuccessAndFailedFile(): void;
+    /**
+     * create terms and enter success & failure related data into terms mapper file
+     * @method importTerms
+     * @async
+     * @returns {Promise<any>} Promise<any>
+     */
+    importTerms(): Promise<any>;
+    /**
+     * @method serializeTerms
+     * @param {ApiOptions} apiOptions ApiOptions
+     * @returns {ApiOptions} ApiOptions
+     */
+    serializeTerms(apiOptions: ApiOptions): ApiOptions;
+    /**
+     * create terms success and fail in (mapper/taxonomies/terms)
+     * @method createTermSuccessAndFailedFile
+     */
+    createTermSuccessAndFailedFile(): void;
+}

package/lib/import/modules/taxonomies.js

@@ -0,0 +1,217 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const keys_1 = tslib_1.__importDefault(require("lodash/keys"));
+const pick_1 = tslib_1.__importDefault(require("lodash/pick"));
+const node_path_1 = require("node:path");
+const values_1 = tslib_1.__importDefault(require("lodash/values"));
+const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
+const base_class_1 = tslib_1.__importDefault(require("./base-class"));
+const utils_1 = require("../../utils");
+class ImportTaxonomies extends base_class_1.default {
+    constructor({ importConfig, stackAPIClient }) {
+        super({ importConfig, stackAPIClient });
+        this.taxonomiesSuccess = {};
+        this.taxonomiesFailed = {};
+        this.termsSuccess = {};
+        this.termsFailed = {};
+        this.terms = [];
+        this.taxonomyUIDs = [];
+        this.taxonomiesConfig = importConfig.modules.taxonomies;
+        this.termsConfig = importConfig.modules.terms;
+        this.taxonomiesMapperDirPath = (0, node_path_1.join)(importConfig.backupDir, 'mapper', 'taxonomies');
+        this.termsMapperDirPath = (0, node_path_1.join)(this.taxonomiesMapperDirPath, 'terms');
+        this.taxonomiesFolderPath = (0, node_path_1.join)(importConfig.backupDir, this.taxonomiesConfig.dirName);
+        this.termsFolderPath = (0, node_path_1.join)(this.taxonomiesFolderPath, this.termsConfig.dirName);
+        this.taxSuccessPath = (0, node_path_1.join)(this.taxonomiesMapperDirPath, 'success.json');
+        this.taxFailsPath = (0, node_path_1.join)(this.taxonomiesMapperDirPath, 'fails.json');
+        this.termsSuccessPath = (0, node_path_1.join)(this.termsMapperDirPath, 'success.json');
+        this.termsFailsPath = (0, node_path_1.join)(this.termsMapperDirPath, 'fails.json');
+    }
+    /**
+     * @method start
+     * @returns {Promise<void>} Promise<void>
+     */
+    async start() {
+        (0, utils_1.log)(this.importConfig, 'Migrating taxonomies...', 'info');
+        //Step1 check folder exists or not
+        if (utils_1.fileHelper.fileExistsSync(this.taxonomiesFolderPath)) {
+            this.taxonomies = utils_1.fsUtil.readFile((0, node_path_1.join)(this.taxonomiesFolderPath, 'taxonomies.json'), true);
+        }
+        else {
+            (0, utils_1.log)(this.importConfig, `No such file or directory - '${this.taxonomiesFolderPath}'`, 'error');
+            return;
+        }
+        //Step 2 create taxonomies & terms mapper directory
+        await utils_1.fsUtil.makeDirectory(this.taxonomiesMapperDirPath);
+        await utils_1.fsUtil.makeDirectory(this.termsMapperDirPath);
+        //Step 3 import taxonomy and create success & failure file
+        await this.importTaxonomies();
+        this.createTaxonomySuccessAndFailedFile();
+        if (!utils_1.fileHelper.fileExistsSync(this.termsFolderPath)) {
+            (0, utils_1.log)(this.importConfig, `No such file or directory - '${this.termsFolderPath}'`, 'error');
+            return;
+        }
+        //Step 4 import terms and create success & failure file
+        await this.importTerms();
+        this.createTermSuccessAndFailedFile();
+        (0, utils_1.log)(this.importConfig, 'Taxonomies imported successfully!', 'success');
+    }
+    /**
+     * create taxonomy and enter success & failure related data into taxonomies mapper file
+     * @method importTaxonomies
+     * @async
+     * @returns {Promise<any>} Promise<any>
+     */
+    async importTaxonomies() {
+        if (this.taxonomies === undefined || (0, isEmpty_1.default)(this.taxonomies)) {
+            (0, utils_1.log)(this.importConfig, 'No Taxonomies Found!', 'info');
+            return;
+        }
+        const apiContent = (0, values_1.default)(this.taxonomies);
+        this.taxonomyUIDs = (0, keys_1.default)(this.taxonomies);
+        const onSuccess = ({ response }) => {
+            const { uid } = response;
+            this.taxonomiesSuccess[uid] = (0, pick_1.default)(response, ['name', 'description']);
+            (0, utils_1.log)(this.importConfig, `Taxonomy '${uid}' imported successfully!`, 'success');
+        };
+        const onReject = ({ error, apiData }) => {
+            var _a;
+            const err = (error === null || error === void 0 ? void 0 : error.message) ? JSON.parse(error.message) : error;
+            const { uid } = apiData;
+            if ((_a = err === null || err === void 0 ? void 0 : err.errors) === null || _a === void 0 ? void 0 : _a.taxonomy) {
+                this.taxonomiesFailed[uid] = apiData;
+                (0, utils_1.log)(this.importConfig, `Taxonomy '${uid}' failed to be import! ${err.errors.taxonomy}`, 'error');
+            }
+            else {
+                this.taxonomiesFailed[apiData.uid] = apiData;
+                (0, utils_1.log)(this.importConfig, `Taxonomy '${uid}' failed to be import! ${(0, utils_1.formatError)(error)}`, 'error');
+            }
+        };
+        await this.makeConcurrentCall({
+            apiContent,
+            processName: 'import taxonomies',
+            apiParams: {
+                serializeData: this.serializeTaxonomy.bind(this),
+                reject: onReject,
+                resolve: onSuccess,
+                entity: 'create-taxonomies',
+                includeParamOnCompletion: true,
+            },
+            concurrencyLimit: this.importConfig.concurrency || this.importConfig.fetchConcurrency || 1,
+        }, undefined, false);
+    }
+    /**
+     * @method serializeTaxonomy
+     * @param {ApiOptions} apiOptions ApiOptions
+     * @returns {ApiOptions} ApiOptions
+     */
+    serializeTaxonomy(apiOptions) {
+        const { apiData: taxonomy } = apiOptions;
+        apiOptions.apiData = taxonomy;
+        return apiOptions;
+    }
+    /**
+     * create taxonomies success and fail in (mapper/taxonomies)
+     * @method createTaxonomySuccessAndFailedFile
+     */
+    createTaxonomySuccessAndFailedFile() {
+        if (this.taxonomiesSuccess !== undefined && !(0, isEmpty_1.default)(this.taxonomiesSuccess)) {
+            utils_1.fsUtil.writeFile(this.taxSuccessPath, this.taxonomiesSuccess);
+        }
+        if (this.taxonomiesFailed !== undefined && !(0, isEmpty_1.default)(this.taxonomiesFailed)) {
+            utils_1.fsUtil.writeFile(this.taxFailsPath, this.taxonomiesFailed);
+        }
+    }
+    /**
+     * create terms and enter success & failure related data into terms mapper file
+     * @method importTerms
+     * @async
+     * @returns {Promise<any>} Promise<any>
+     */
+    async importTerms() {
+        var _a, _b;
+        if (!((_a = this.taxonomyUIDs) === null || _a === void 0 ? void 0 : _a.length)) {
+            return;
+        }
+        const onSuccess = ({ response, apiData: { taxonomy_uid } = { taxonomy_uid: null } }) => {
+            var _a;
+            const { uid } = response;
+            if (!((_a = this.termsSuccess) === null || _a === void 0 ? void 0 : _a[taxonomy_uid]))
+                this.termsSuccess[taxonomy_uid] = {};
+            this.termsSuccess[taxonomy_uid][uid] = (0, pick_1.default)(response, ['name']);
+            (0, utils_1.log)(this.importConfig, `Term '${uid}' imported successfully!`, 'success');
+        };
+        const onReject = ({ error, apiData }) => {
+            var _a, _b;
+            const { taxonomy_uid, uid } = apiData;
+            if (!((_a = this.termsFailed) === null || _a === void 0 ? void 0 : _a[taxonomy_uid]))
+                this.termsFailed[taxonomy_uid] = {};
+            const err = (error === null || error === void 0 ? void 0 : error.message) ? JSON.parse(error.message) : error;
+            if ((_b = err === null || err === void 0 ? void 0 : err.errors) === null || _b === void 0 ? void 0 : _b.term) {
+                this.termsFailed[taxonomy_uid][uid] = apiData;
+                (0, utils_1.log)(this.importConfig, `Term '${uid}' failed to be import! ${err.errors.term}`, 'error');
+            }
+            else {
+                this.termsFailed[taxonomy_uid][uid] = apiData;
+                (0, utils_1.log)(this.importConfig, `Term '${uid}' failed to be import! ${(0, utils_1.formatError)(error)}`, 'error');
+            }
+        };
+        for (const taxUID of this.taxonomyUIDs) {
+            //read terms from respective taxonomy
+            this.terms = utils_1.fsUtil.readFile((0, node_path_1.join)(this.termsFolderPath, `${taxUID}-${this.termsConfig.fileName}`), true);
+            if ((_b = this.terms) === null || _b === void 0 ? void 0 : _b.length) {
+                const apiContent = this.terms;
+                await this.makeConcurrentCall({
+                    apiContent,
+                    processName: 'import terms',
+                    apiParams: {
+                        serializeData: this.serializeTerms.bind(this),
+                        reject: onReject,
+                        resolve: onSuccess,
+                        entity: 'create-terms',
+                        includeParamOnCompletion: true,
+                    },
+                    concurrencyLimit: this.importConfig.concurrency || this.importConfig.fetchConcurrency || 1,
+                }, undefined, false);
+            }
+        }
+    }
+    /**
+     * @method serializeTerms
+     * @param {ApiOptions} apiOptions ApiOptions
+     * @returns {ApiOptions} ApiOptions
+     */
+    serializeTerms(apiOptions) {
+        var _a, _b;
+        const { apiData: term } = apiOptions;
+        const { parent_uid, taxonomy_uid } = term;
+        //check whether parent term exists or not in taxonomy
+        if (parent_uid !== null) {
+            if (!((_b = (_a = this.termsSuccess) === null || _a === void 0 ? void 0 : _a[taxonomy_uid]) === null || _b === void 0 ? void 0 : _b[parent_uid])) {
+                (0, utils_1.log)(this.importConfig, `Parent term '${term === null || term === void 0 ? void 0 : term.parent_uid}' does not exist! Skipping '${term.uid}' creation to avoid further issues.`, 'info');
+                apiOptions.apiData = undefined;
+            }
+            else {
+                apiOptions.apiData = term;
+            }
+        }
+        else {
+            apiOptions.apiData = term;
+        }
+        return apiOptions;
+    }
+    /**
+     * create terms success and fail in (mapper/taxonomies/terms)
+     * @method createTermSuccessAndFailedFile
+     */
+    createTermSuccessAndFailedFile() {
+        if (this.termsSuccess !== undefined && !(0, isEmpty_1.default)(this.termsSuccess)) {
+            utils_1.fsUtil.writeFile(this.termsSuccessPath, this.termsSuccess);
+        }
+        if (this.termsFailed !== undefined && !(0, isEmpty_1.default)(this.termsFailed)) {
+            utils_1.fsUtil.writeFile(this.termsFailsPath, this.termsFailed);
+        }
+    }
+}
+exports.default = ImportTaxonomies;

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

@@ -112,6 +112,16 @@ export default interface DefaultConfig {
             fileName: string;
             requiredKeys: string[];
         };
+        taxonomies: {
+            dirName: string;
+            fileName: string;
+            dependencies?: Modules[];
+        };
+        terms: {
+            dirName: string;
+            fileName: string;
+            dependencies?: Modules[];
+        };
     };
     languagesCode: string[];
     apis: {
@@ -140,4 +150,5 @@ export default interface DefaultConfig {
     getEncryptionKeyMaxRetry: number;
     createBackupDir?: string;
     overwriteSupportedModules: 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']>;
     importConfig: ImportConfig;
@@ -60,5 +60,15 @@ export interface CustomRoleConfig {
     fileName: string;
     customRolesLocalesFileName: string;
 }
+export interface TaxonomiesConfig {
+    dirName: string;
+    fileName: string;
+    dependencies?: Modules[];
+}
+export interface TermsConfig {
+    dirName: string;
+    fileName: string;
+    dependencies?: Modules[];
+}
 export { default as DefaultConfig } from './default-config';
 export { default as ImportConfig } from './import-config';

package/lib/utils/index.d.ts

@@ -11,3 +11,4 @@ export { lookupExtension } from './extension-helper';
 export { lookupEntries, removeUidsFromJsonRteFields, removeEntryRefsFromJSONRTE, restoreJsonRteEntryRefs, } from './entries-helper';
 export * from './common-helper';
 export * from './log';
+export { lookUpTaxonomy, lookUpTerms } from './taxonomies-helper';

package/lib/utils/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.restoreJsonRteEntryRefs = exports.removeEntryRefsFromJSONRTE = exports.removeUidsFromJsonRteFields = exports.lookupEntries = exports.lookupExtension = exports.removeReferenceFields = exports.suppressSchemaReference = exports.schemaTemplate = exports.updateAppConfig = exports.ifAppAlreadyExist = exports.getAllStackSpecificApps = exports.confirmToCloseProcess = exports.makeRedirectUrlCall = exports.installApp = exports.handleNameConflict = exports.createPrivateApp = exports.getConfirmationToCreateApps = exports.getOrgUid = exports.getDeveloperHubUrl = exports.lookupAssets = exports.uploadAssetHelper = exports.unlinkFileLogger = exports.log = exports.backupHandler = exports.fsUtil = exports.fileHelper = exports.setupImportConfig = exports.interactive = void 0;
+exports.lookUpTerms = exports.lookUpTaxonomy = exports.restoreJsonRteEntryRefs = exports.removeEntryRefsFromJSONRTE = exports.removeUidsFromJsonRteFields = exports.lookupEntries = exports.lookupExtension = exports.removeReferenceFields = exports.suppressSchemaReference = exports.schemaTemplate = exports.updateAppConfig = exports.ifAppAlreadyExist = exports.getAllStackSpecificApps = exports.confirmToCloseProcess = exports.makeRedirectUrlCall = exports.installApp = exports.handleNameConflict = exports.createPrivateApp = exports.getConfirmationToCreateApps = exports.getOrgUid = exports.getDeveloperHubUrl = exports.lookupAssets = exports.uploadAssetHelper = exports.unlinkFileLogger = exports.log = exports.backupHandler = exports.fsUtil = exports.fileHelper = exports.setupImportConfig = exports.interactive = void 0;
 const tslib_1 = require("tslib");
 exports.interactive = tslib_1.__importStar(require("./interactive"));
 var import_config_handler_1 = require("./import-config-handler");
@@ -41,3 +41,6 @@ Object.defineProperty(exports, "removeEntryRefsFromJSONRTE", { enumerable: true,
 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);
+var taxonomies_helper_1 = require("./taxonomies-helper");
+Object.defineProperty(exports, "lookUpTaxonomy", { enumerable: true, get: function () { return taxonomies_helper_1.lookUpTaxonomy; } });
+Object.defineProperty(exports, "lookUpTerms", { enumerable: true, get: function () { return taxonomies_helper_1.lookUpTerms; } });

package/lib/utils/logger.js

@@ -72,7 +72,9 @@ function init(_logPath) {
         logger = winston.createLogger({
             transports: [
                 new winston.transports.File(successTransport),
-                new winston.transports.Console({ format: winston.format.simple() }),
+                new winston.transports.Console({
+                    format: winston.format.combine(winston.format.simple(), winston.format.colorize({ all: true, colors: { warn: 'yellow', info: 'white' } })),
+                }),
             ],
             levels: myCustomLevels.levels,
         });
@@ -95,7 +97,7 @@ function init(_logPath) {
                 logger.log('info', logString);
             }
         },
-        warn: function () {
+        warn: function (message) {
             let args = slice.call(arguments);
             let logString = returnString(args);
             if (logString) {
@@ -123,7 +125,10 @@ const log = async (config, message, type) => {
     // ignoring the type argument, as we are not using it to create a logfile anymore
     if (type !== 'error') {
         // removed type argument from init method
-        init(config.data).log(message);
+        if (type === 'warn')
+            init(config.data).warn(message); //logged warning message in log file
+        else
+            init(config.data).log(message);
     }
     else {
         init(config.data).error(message);

package/lib/utils/taxonomies-helper.d.ts

@@ -0,0 +1,16 @@
+import { ImportConfig } from '../types';
+/**
+ * check and remove if referenced taxonomy doesn't exists in stack
+ * @param {any} schema content type schema
+ * @param {Record<string, unknown>} taxonomies created taxonomies
+ * @param {ImportConfig} importConfig
+ */
+export declare const lookUpTaxonomy: (importConfig: ImportConfig, schema: any, taxonomies: Record<string, unknown>) => void;
+/**
+ * check and remove if referenced terms doesn't exists in taxonomy
+ * @param {Record<string, any>[]} ctSchema content type schema
+ * @param {any} entry
+ * @param {Record<string, any>} taxonomiesAndTermData created taxonomies and terms
+ * @param {ImportConfig} importConfig
+ */
+export declare const lookUpTerms: (ctSchema: Record<string, any>[], entry: any, taxonomiesAndTermData: Record<string, any>, importConfig: ImportConfig) => void;

package/lib/utils/taxonomies-helper.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lookUpTerms = exports.lookUpTaxonomy = void 0;
+/**
+ * taxonomy lookup
+ */
+const _1 = require("./");
+/**
+ * check and remove if referenced taxonomy doesn't exists in stack
+ * @param {any} schema content type schema
+ * @param {Record<string, unknown>} taxonomies created taxonomies
+ * @param {ImportConfig} importConfig
+ */
+const lookUpTaxonomy = function (importConfig, schema, taxonomies) {
+    for (let i in schema) {
+        if (schema[i].data_type === 'taxonomy') {
+            const taxonomyFieldData = schema[i].taxonomies;
+            const { updatedTaxonomyData, isTaxonomyFieldRemoved } = verifyAndRemoveTaxonomy(taxonomyFieldData, taxonomies, importConfig);
+            //Handle API error -> The 'taxonomies' property must have atleast one taxonomy object. Remove taxonomy field from schema.
+            if (isTaxonomyFieldRemoved) {
+                schema.splice(i, 1);
+            }
+            else {
+                schema[i].taxonomies = updatedTaxonomyData;
+            }
+        }
+    }
+};
+exports.lookUpTaxonomy = lookUpTaxonomy;
+/**
+ * verify and remove referenced taxonomy with warning from respective content type
+ * @param {Record<string, any>[]} taxonomyFieldData
+ * @param {Record<string, unknown>} taxonomies created taxonomies
+ * @param {ImportConfig} importConfig
+ * @returns
+ */
+const verifyAndRemoveTaxonomy = function (taxonomyFieldData, taxonomies, importConfig) {
+    let isTaxonomyFieldRemoved = false;
+    for (let index = 0; index < (taxonomyFieldData === null || taxonomyFieldData === void 0 ? void 0 : taxonomyFieldData.length); index++) {
+        const taxonomyData = taxonomyFieldData[index];
+        if (taxonomies === undefined || !taxonomies.hasOwnProperty(taxonomyData === null || taxonomyData === void 0 ? void 0 : taxonomyData.taxonomy_uid)) {
+            // remove taxonomy from taxonomies field data with warning if respective taxonomy doesn't exists
+            (0, _1.log)(importConfig, `Taxonomy '${taxonomyData === null || taxonomyData === void 0 ? void 0 : taxonomyData.taxonomy_uid}' does not exist. Removing the data from the taxonomies field`, 'warn');
+            taxonomyFieldData.splice(index, 1);
+            --index;
+        }
+    }
+    if (!(taxonomyFieldData === null || taxonomyFieldData === void 0 ? void 0 : taxonomyFieldData.length)) {
+        (0, _1.log)(importConfig, 'Taxonomy does not exist. Removing the field from content type', 'warn');
+        isTaxonomyFieldRemoved = true;
+    }
+    return {
+        updatedTaxonomyData: taxonomyFieldData,
+        isTaxonomyFieldRemoved,
+    };
+};
+/**
+ * check and remove if referenced terms doesn't exists in taxonomy
+ * @param {Record<string, any>[]} ctSchema content type schema
+ * @param {any} entry
+ * @param {Record<string, any>} taxonomiesAndTermData created taxonomies and terms
+ * @param {ImportConfig} importConfig
+ */
+const lookUpTerms = function (ctSchema, entry, taxonomiesAndTermData, importConfig) {
+    for (let index = 0; index < (ctSchema === null || ctSchema === void 0 ? void 0 : ctSchema.length); index++) {
+        if (ctSchema[index].data_type === 'taxonomy') {
+            const taxonomyFieldData = entry[ctSchema[index].uid];
+            const updatedTaxonomyData = verifyAndRemoveTerms(taxonomyFieldData, taxonomiesAndTermData, importConfig);
+            entry[ctSchema[index].uid] = updatedTaxonomyData;
+        }
+    }
+};
+exports.lookUpTerms = lookUpTerms;
+/**
+ * verify and remove referenced term with warning from respective entry
+ * @param {Record<string, any>[]} taxonomyFieldData entry taxonomies data
+ * @param {Record<string, any>} taxonomiesAndTermData created taxonomies and terms
+ * @param {ImportConfig} importConfig
+ * @returns { Record<string, any>[]}
+ */
+const verifyAndRemoveTerms = function (taxonomyFieldData, taxonomiesAndTermData, importConfig) {
+    for (let index = 0; index < (taxonomyFieldData === null || taxonomyFieldData === void 0 ? void 0 : taxonomyFieldData.length); index++) {
+        const taxonomyData = taxonomyFieldData[index];
+        const taxUID = taxonomyData === null || taxonomyData === void 0 ? void 0 : taxonomyData.taxonomy_uid;
+        const termUID = taxonomyData === null || taxonomyData === void 0 ? void 0 : taxonomyData.term_uid;
+        if (taxonomiesAndTermData === undefined ||
+            !taxonomiesAndTermData.hasOwnProperty(taxUID) ||
+            (taxonomiesAndTermData.hasOwnProperty(taxUID) && !taxonomiesAndTermData[taxUID].hasOwnProperty(termUID))) {
+            // remove term from taxonomies field data with warning if respective term doesn't exists
+            (0, _1.log)(importConfig, `Term '${termUID}' does not exist. Removing it from taxonomy - '${taxUID}'`, 'warn');
+            taxonomyFieldData.splice(index, 1);
+            --index;
+        }
+    }
+    return taxonomyFieldData;
+};

package/oclif.manifest.json

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

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "1.10.1",
+  "version": "1.11.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
     "@contentstack/cli-command": "~1.2.15",
     "@contentstack/cli-utilities": "~1.5.5",
-    "@contentstack/management": "~1.11.0",
+    "@contentstack/management": "~1.12.0",
     "@oclif/core": "^2.9.3",
     "axios": "^1.6.0",
     "big-json": "^3.2.0",