@contentstack/cli-cm-import 1.9.0 → 1.10.0

package/README.md

@@ -2,7 +2,7 @@
 
 It is Contentstack’s CLI plugin to import content in the stack. To learn how to export and import content in Contentstack, refer to the [Migration guide](https://www.contentstack.com/docs/developers/cli/migration/).
 
-[![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)
+[![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)it -m 
 
 <!-- toc -->
 * [Usage](#usage)
@@ -47,7 +47,7 @@ $ npm install -g @contentstack/cli-cm-import
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-import/1.9.0 linux-x64 node-v18.18.0
+@contentstack/cli-cm-import/1.10.0 linux-x64 node-v18.18.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -81,6 +81,8 @@ FLAGS
   -y, --yes                         [optional] Override marketplace prompts
   --import-webhook-status=<option>  [default: disable] [optional] Webhook state
                                     <options: disable|current>
+  --replace-existing                Replaces the existing module in the target stack.
+  --skip-existing                   Skips the module exists warning messages.
 
 DESCRIPTION
   Import content from a stack
@@ -126,6 +128,8 @@ FLAGS
   -y, --yes                         [optional] Override marketplace prompts
   --import-webhook-status=<option>  [default: disable] [optional] Webhook state
                                     <options: disable|current>
+  --replace-existing                Replaces the existing module in the target stack.
+  --skip-existing                   Skips the module exists warning messages.
 
 DESCRIPTION
   Import content from a stack

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

@@ -11,14 +11,12 @@ class ImportCommand extends cli_command_1.Command {
         // setup import config
         // initialize the importer
         // start import
-        let contentDir;
         let backupDir;
         try {
             const { flags } = await this.parse(ImportCommand);
             let importConfig = await (0, utils_1.setupImportConfig)(flags);
             // Note setting host to create cma client
             importConfig.host = this.cmaHost;
-            contentDir = importConfig.contentDir;
             backupDir = importConfig.backupDir;
             const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)(importConfig);
             const moduleImporter = new import_1.ModuleImporter(managementAPIClient, importConfig);
@@ -84,6 +82,7 @@ ImportCommand.flags = {
         parse: (0, cli_utilities_1.printFlagDeprecation)(['-A', '--auth-token']),
     }),
     module: cli_utilities_1.flags.string({
+        required: false,
         char: 'm',
         description: '[optional] specific module name',
         parse: (0, cli_utilities_1.printFlagDeprecation)(['-m'], ['--module']),
@@ -109,6 +108,16 @@ ImportCommand.flags = {
         required: false,
         description: '[optional] Override marketplace prompts',
     }),
+    'replace-existing': cli_utilities_1.flags.boolean({
+        required: false,
+        description: 'Replaces the existing module in the target stack.',
+        dependsOn: ['module'],
+    }),
+    'skip-existing': cli_utilities_1.flags.boolean({
+        required: false,
+        default: false,
+        description: 'Skips the module exists warning messages.',
+    }),
 };
 ImportCommand.aliases = ['cm:import'];
 ImportCommand.usage = 'cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]';

package/lib/config/index.js

@@ -367,6 +367,7 @@ const config = {
         stacks: '/stacks/',
         labels: '/labels/',
     },
+    overwriteSupportedModules: ['extensions', 'global-fields', 'content-types'],
     rateLimit: 5,
     preserveStackVersion: false,
     entriesPublish: true,

package/lib/import/module-importer.js

@@ -23,7 +23,7 @@ class ModuleImporter {
         const httpClient = new cli_utilities_1.HttpClient({
             headers: { api_key: this.importConfig.apiKey, authorization: this.importConfig.management_token },
         });
-        const { data } = await httpClient.post('https://api.contentstack.io/v3/locales', {
+        const { data } = await httpClient.post(`https://${this.importConfig.host}/v3/locales`, {
             locale: {
                 name: 'English',
                 code: 'en-us',

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' | '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';
 export type ApiOptions = {
     uid?: string;
     url?: string;

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

@@ -57,6 +57,15 @@ export default class EntriesImport extends BaseClass {
      * @returns {ApiOptions} ApiOptions
      */
     serializeEntries(apiOptions: ApiOptions): ApiOptions;
+    replaceEntries({ cTUid, locale }: {
+        cTUid: string;
+        locale: string;
+    }): Promise<void>;
+    replaceEntriesHandler({ apiParams, element: entry, isLastRequest, }: {
+        apiParams: ApiOptions;
+        element: Record<string, string>;
+        isLastRequest: boolean;
+    }): Promise<unknown>;
     populateEntryUpdatePayload(): {
         cTUid: string;
         locale: string;

package/lib/import/modules/entries.js

@@ -56,6 +56,14 @@ class EntriesImport extends base_class_1.default {
             for (let entryRequestOption of entryRequestOptions) {
                 await this.createEntries(entryRequestOption);
             }
+            if (this.importConfig.replaceExisting && (0, lodash_1.indexOf)(this.importConfig.overwriteSupportedModules, 'entries') !== -1) {
+                // Note: Instead of using entryRequestOptions, we can prepare request options for replace, to avoid unnecessary operations
+                for (let entryRequestOption of entryRequestOptions) {
+                    await this.replaceEntries(entryRequestOption).catch((error) => {
+                        (0, utils_1.log)(this.importConfig, `Error while replacing the existing entries ${(0, utils_1.formatError)(error)}`, 'error');
+                    });
+                }
+            }
             await utils_1.fileHelper.writeLargeFile(path.join(this.entriesMapperPath, 'uid-mapping.json'), this.entriesUidMapper); // TBD: manages mapper in one file, should find an alternative
             utils_1.fsUtil.writeFile(path.join(this.entriesMapperPath, 'failed-entries.json'), this.failedEntries);
             if (this.autoCreatedEntries.length > 0) {
@@ -129,7 +137,8 @@ class EntriesImport extends base_class_1.default {
      * @returns {ApiOptions} ApiOptions
      */
     serializeUpdateCTs(apiOptions) {
-        const { apiData: contentType } = apiOptions;
+        const { apiData } = apiOptions;
+        const contentType = (0, lodash_1.cloneDeep)(apiData);
         if (contentType.field_rules) {
             delete contentType.field_rules;
         }
@@ -201,6 +210,15 @@ class EntriesImport extends base_class_1.default {
             keepMetadata: false,
             omitKeys: this.entriesConfig.invalidKeys,
         });
+        // create file instance for existing entries
+        const existingEntriesFileHelper = new cli_utilities_1.FsUtility({
+            moduleName: 'entries',
+            indexFileName: 'index.json',
+            basePath: path.join(this.entriesMapperPath, cTUid, locale, 'existing'),
+            chunkFileSize: this.entriesConfig.chunkFileSize,
+            keepMetadata: false,
+            omitKeys: this.entriesConfig.invalidKeys,
+        });
         const contentType = (0, lodash_1.find)(this.cTs, { uid: cTUid });
         const onSuccess = ({ response, apiData: entry, additionalInfo }) => {
             var _a, _b;
@@ -227,10 +245,33 @@ class EntriesImport extends base_class_1.default {
                 entriesCreateFileHelper.writeIntoFile({ [entry.uid]: entry }, { mapKeyVal: true });
             }
         };
-        const onReject = ({ error, apiData: { uid, title } }) => {
-            (0, utils_1.log)(this.importConfig, `${title} entry of content type ${cTUid} in locale ${locale} failed to create`, 'error');
-            (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(error), 'error');
-            this.failedEntries.push({ content_type: cTUid, locale, entry: { uid, title } });
+        const onReject = ({ error, apiData: entry, additionalInfo }) => {
+            var _a, _b;
+            const { title, uid } = entry;
+            //Note: write existing entries into files to handler later
+            if (error.errorCode === 119) {
+                if (((_a = error === null || error === void 0 ? void 0 : error.errors) === null || _a === void 0 ? void 0 : _a.title) || ((_b = error === null || error === void 0 ? void 0 : error.errors) === null || _b === void 0 ? void 0 : _b.uid)) {
+                    if (this.importConfig.replaceExisting &&
+                        (0, lodash_1.indexOf)(this.importConfig.overwriteSupportedModules, 'entries') !== -1) {
+                        entry.entryOldUid = uid;
+                        entry.sourceEntryFilePath = path.join(basePath, additionalInfo.entryFileName); // stores source file path temporarily
+                        existingEntriesFileHelper.writeIntoFile({ [uid]: entry }, { mapKeyVal: true });
+                    }
+                    if (!this.importConfig.skipExisting) {
+                        (0, utils_1.log)(this.importConfig, `Entry '${title}' already exists`, 'info');
+                    }
+                }
+                else {
+                    (0, utils_1.log)(this.importConfig, `${title} entry of content type ${cTUid} in locale ${locale} failed to create`, 'error');
+                    (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(error), 'error');
+                    this.failedEntries.push({ content_type: cTUid, locale, entry: { uid, title } });
+                }
+            }
+            else {
+                (0, utils_1.log)(this.importConfig, `${title} entry of content type ${cTUid} in locale ${locale} failed to create`, 'error');
+                (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(error), 'error');
+                this.failedEntries.push({ content_type: cTUid, locale, entry: { uid, title } });
+            }
         };
         for (const index in indexer) {
             const chunk = await fs.readChunkFiles.next().catch((error) => {
@@ -254,6 +295,7 @@ class EntriesImport extends base_class_1.default {
                     concurrencyLimit: this.importConcurrency,
                 }).then(() => {
                     entriesCreateFileHelper === null || entriesCreateFileHelper === void 0 ? void 0 : entriesCreateFileHelper.completeFile(true);
+                    existingEntriesFileHelper === null || existingEntriesFileHelper === void 0 ? void 0 : existingEntriesFileHelper.completeFile(true);
                     (0, utils_1.log)(this.importConfig, `Created entries for content type ${cTUid} in locale ${locale}`, 'success');
                 });
             }
@@ -287,7 +329,7 @@ class EntriesImport extends base_class_1.default {
                 apiOptions.apiData = entryResponse;
                 apiOptions.additionalInfo[entryResponse.uid] = {
                     isLocalized: true,
-                    entryOldUid: entry.uid
+                    entryOldUid: entry.uid,
                 };
                 return apiOptions;
             }
@@ -301,6 +343,118 @@ class EntriesImport extends base_class_1.default {
         }
         return apiOptions;
     }
+    async replaceEntries({ cTUid, locale }) {
+        const processName = 'Replace existing Entries';
+        const indexFileName = 'index.json';
+        const basePath = path.join(this.entriesMapperPath, cTUid, locale, 'existing');
+        const fs = new cli_utilities_1.FsUtility({ basePath, indexFileName });
+        const indexer = fs.indexFileContent;
+        const indexerCount = (0, lodash_1.values)(indexer).length;
+        if (indexerCount === 0) {
+            return Promise.resolve();
+        }
+        // Write updated entries
+        const entriesReplaceFileHelper = new cli_utilities_1.FsUtility({
+            moduleName: 'entries',
+            indexFileName: 'index.json',
+            basePath: path.join(this.entriesMapperPath, cTUid, locale),
+            chunkFileSize: this.entriesConfig.chunkFileSize,
+            keepMetadata: false,
+            useIndexer: true,
+            omitKeys: this.entriesConfig.invalidKeys,
+        });
+        // log(this.importConfig, `Starting to update entries with references for ${cTUid} in locale ${locale}`, 'info');
+        const contentType = (0, lodash_1.find)(this.cTs, { uid: cTUid });
+        const onSuccess = ({ response, apiData: entry, additionalInfo }) => {
+            (0, utils_1.log)(this.importConfig, `Replaced entry: '${entry.title}' of content type ${cTUid} in locale ${locale}`, 'info');
+            this.entriesUidMapper[entry.uid] = response.uid;
+            entriesReplaceFileHelper.writeIntoFile({ [entry.uid]: entry }, { mapKeyVal: true });
+        };
+        const onReject = ({ error, apiData: { uid, title } }) => {
+            (0, utils_1.log)(this.importConfig, `${title} entry of content type ${cTUid} in locale ${locale} failed to replace`, 'error');
+            (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(error), 'error');
+            this.failedEntries.push({
+                content_type: cTUid,
+                locale,
+                entry: { uid: this.entriesUidMapper[uid], title },
+                entryId: uid,
+            });
+        };
+        for (const index in indexer) {
+            const chunk = await fs.readChunkFiles.next().catch((error) => {
+                (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(error), 'error');
+            });
+            if (chunk) {
+                let apiContent = (0, lodash_1.values)(chunk);
+                await this.makeConcurrentCall({
+                    apiContent,
+                    processName,
+                    indexerCount,
+                    currentIndexer: +index,
+                    apiParams: {
+                        reject: onReject,
+                        resolve: onSuccess,
+                        entity: 'update-entries',
+                        includeParamOnCompletion: true,
+                        additionalInfo: { contentType, locale, cTUid },
+                    },
+                    concurrencyLimit: this.importConcurrency,
+                }, this.replaceEntriesHandler.bind(this)).then(() => {
+                    entriesReplaceFileHelper === null || entriesReplaceFileHelper === void 0 ? void 0 : entriesReplaceFileHelper.completeFile(true);
+                    (0, utils_1.log)(this.importConfig, `Replaced entries for content type ${cTUid} in locale ${locale}`, 'success');
+                });
+            }
+        }
+    }
+    async replaceEntriesHandler({ apiParams, element: entry, isLastRequest, }) {
+        const { additionalInfo: { cTUid, locale } = {} } = apiParams;
+        return new Promise(async (resolve, reject) => {
+            const { items: [entryInStack] = [] } = (await this.stack
+                .contentType(cTUid)
+                .entry()
+                .query({ query: { title: entry.title, locale } })
+                .findOne()
+                .catch((error) => {
+                apiParams.reject({
+                    error,
+                    apiData: entry,
+                });
+                reject(true);
+            })) || {};
+            if (entryInStack) {
+                const entryPayload = this.stack.contentType(cTUid).entry(entryInStack.uid);
+                Object.assign(entryPayload, entryInStack, (0, lodash_1.cloneDeep)(entry), {
+                    uid: entryInStack.uid,
+                    urlPath: entryInStack.urlPath,
+                    stackHeaders: entryInStack.stackHeaders,
+                    _version: entryInStack._version,
+                });
+                return entryPayload
+                    .update({ locale })
+                    .then((response) => {
+                    apiParams.resolve({
+                        response,
+                        apiData: entry,
+                    });
+                    resolve(true);
+                })
+                    .catch((error) => {
+                    apiParams.reject({
+                        error,
+                        apiData: entry,
+                    });
+                    reject(true);
+                });
+            }
+            else {
+                apiParams.reject({
+                    error: new Error(`Entry with title ${entry.title} not found in the stack`),
+                    apiData: entry,
+                });
+                reject(true);
+            }
+        });
+    }
     populateEntryUpdatePayload() {
         const requestOptions = [];
         for (let locale of this.locales) {
@@ -428,7 +582,8 @@ class EntriesImport extends base_class_1.default {
      * @returns {ApiOptions} ApiOptions
      */
     serializeUpdateCTsWithRef(apiOptions) {
-        const { apiData: contentType } = apiOptions;
+        const { apiData } = apiOptions;
+        const contentType = (0, lodash_1.cloneDeep)(apiData);
         if (contentType.field_rules) {
             delete contentType.field_rules;
         }

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

@@ -11,6 +11,7 @@ export default class ImportExtensions extends BaseClass {
     private extUidMapper;
     private extSuccess;
     private extFailed;
+    private existingExtensions;
     constructor({ importConfig, stackAPIClient }: ModuleClassParams);
     /**
      * @method start
@@ -18,10 +19,10 @@ export default class ImportExtensions extends BaseClass {
      */
     start(): Promise<void>;
     importExtensions(): Promise<any>;
-    /**
-     * @method serializeExtensions
-     * @param {ApiOptions} apiOptions ApiOptions
-     * @returns {ApiOptions} ApiOptions
-     */
-    serializeExtensions(apiOptions: ApiOptions): ApiOptions;
+    replaceExtensions(): Promise<any>;
+    replaceExtensionHandler({ apiParams, element: extension, isLastRequest, }: {
+        apiParams: ApiOptions;
+        element: Record<string, string>;
+        isLastRequest: boolean;
+    }): Promise<unknown>;
 }

package/lib/import/modules/extensions.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const values_1 = tslib_1.__importDefault(require("lodash/values"));
+const cloneDeep_1 = tslib_1.__importDefault(require("lodash/cloneDeep"));
 const node_path_1 = require("node:path");
 const utils_1 = require("../../utils");
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
@@ -17,6 +18,7 @@ class ImportExtensions extends base_class_1.default {
         this.extFailsPath = (0, node_path_1.join)(this.mapperDirPath, 'fails.json');
         this.extFailed = [];
         this.extSuccess = [];
+        this.existingExtensions = [];
         this.extUidMapper = {};
     }
     /**
@@ -39,6 +41,12 @@ class ImportExtensions extends base_class_1.default {
             ? utils_1.fsUtil.readFile((0, node_path_1.join)(this.extUidMapperPath), true)
             : {};
         await this.importExtensions();
+        // Note: if any extensions present, then update it
+        if (this.importConfig.replaceExisting && this.existingExtensions.length > 0) {
+            await this.replaceExtensions().catch((error) => {
+                (0, utils_1.log)(this.importConfig, `Error while replacing extensions ${(0, utils_1.formatError)(error)}`, 'error');
+            });
+        }
         if ((_a = this.extSuccess) === null || _a === void 0 ? void 0 : _a.length) {
             utils_1.fsUtil.writeFile(this.extSuccessPath, this.extSuccess);
         }
@@ -61,10 +69,14 @@ class ImportExtensions extends base_class_1.default {
         };
         const onReject = ({ error, apiData }) => {
             var _a;
-            const err = (error === null || error === void 0 ? void 0 : error.message) ? JSON.parse(error.message) : error;
             const { title } = apiData;
-            if ((_a = err === null || err === void 0 ? void 0 : err.errors) === null || _a === void 0 ? void 0 : _a.title) {
-                (0, utils_1.log)(this.importConfig, `Extension '${title}' already exists`, 'info');
+            if ((_a = error === null || error === void 0 ? void 0 : error.errors) === null || _a === void 0 ? void 0 : _a.title) {
+                if (this.importConfig.replaceExisting) {
+                    this.existingExtensions.push(apiData);
+                }
+                if (!this.importConfig.skipExisting) {
+                    (0, utils_1.log)(this.importConfig, `Extension '${title}' already exists`, 'info');
+                }
             }
             else {
                 this.extFailed.push(apiData);
@@ -76,7 +88,6 @@ class ImportExtensions extends base_class_1.default {
             apiContent,
             processName: 'import extensions',
             apiParams: {
-                serializeData: this.serializeExtensions.bind(this),
                 reject: onReject.bind(this),
                 resolve: onSuccess.bind(this),
                 entity: 'create-extensions',
@@ -85,21 +96,76 @@ class ImportExtensions extends base_class_1.default {
             concurrencyLimit: this.importConfig.concurrency || this.importConfig.fetchConcurrency || 1,
         }, undefined, false);
     }
-    /**
-     * @method serializeExtensions
-     * @param {ApiOptions} apiOptions ApiOptions
-     * @returns {ApiOptions} ApiOptions
-     */
-    serializeExtensions(apiOptions) {
-        const { apiData: extension } = apiOptions;
-        if (this.extUidMapper.hasOwnProperty(extension.uid)) {
-            (0, utils_1.log)(this.importConfig, `Extension '${extension.title}' already exists. Skipping it to avoid duplicates!`, 'info');
-            apiOptions.entity = undefined;
-        }
-        else {
-            apiOptions.apiData = extension;
-        }
-        return apiOptions;
+    async replaceExtensions() {
+        const onSuccess = ({ response, apiData: { uid, title } = { uid: null, title: '' } }) => {
+            this.extSuccess.push(response);
+            this.extUidMapper[uid] = response.uid;
+            (0, utils_1.log)(this.importConfig, `Extension '${title}' replaced successfully`, 'success');
+            utils_1.fsUtil.writeFile(this.extUidMapperPath, this.extUidMapper);
+        };
+        const onReject = ({ error, apiData }) => {
+            this.extFailed.push(apiData);
+            (0, utils_1.log)(this.importConfig, `Extension '${apiData.title}' failed to replace ${(0, utils_1.formatError)(error)}`, 'error');
+            (0, utils_1.log)(this.importConfig, error, 'error');
+        };
+        await this.makeConcurrentCall({
+            apiContent: this.existingExtensions,
+            processName: 'Replace extensions',
+            apiParams: {
+                reject: onReject.bind(this),
+                resolve: onSuccess.bind(this),
+                entity: 'update-extensions',
+                includeParamOnCompletion: true,
+            },
+            concurrencyLimit: this.importConfig.concurrency || this.importConfig.fetchConcurrency || 1,
+        }, this.replaceExtensionHandler.bind(this));
+    }
+    async replaceExtensionHandler({ apiParams, element: extension, isLastRequest, }) {
+        return new Promise(async (resolve, reject) => {
+            const { items: [extensionsInStack] = [] } = await this.stack
+                .extension()
+                .query({ query: { title: extension.title } })
+                .findOne()
+                .catch((error) => {
+                apiParams.reject({
+                    error,
+                    apiData: extension,
+                });
+                reject(true);
+            });
+            if (extensionsInStack) {
+                const extensionPayload = this.stack.extension(extension.uid);
+                Object.assign(extensionPayload, extensionsInStack, (0, cloneDeep_1.default)(extension), {
+                    uid: extensionsInStack.uid,
+                    urlPath: extensionsInStack.urlPath,
+                    _version: extensionsInStack._version,
+                    stackHeaders: extensionsInStack.stackHeaders,
+                });
+                return extensionPayload
+                    .update()
+                    .then((response) => {
+                    apiParams.resolve({
+                        response,
+                        apiData: extension,
+                    });
+                    resolve(true);
+                })
+                    .catch((error) => {
+                    apiParams.reject({
+                        error,
+                        apiData: extension,
+                    });
+                    reject(true);
+                });
+            }
+            else {
+                apiParams.reject({
+                    error: new Error(`Extension with title ${extension.title} not found in the stack`),
+                    apiData: extension,
+                });
+                reject(true);
+            }
+        });
     }
 }
 exports.default = ImportExtensions;

package/lib/import/modules/global-fields.d.ts

@@ -22,6 +22,7 @@ export default class ImportGlobalFields extends BaseClass {
     private marketplaceAppMapperPath;
     private reqConcurrency;
     private installedExtensions;
+    private existingGFs;
     private gFsConfig;
     constructor({ importConfig, stackAPIClient }: ModuleClassParams);
     start(): Promise<any>;
@@ -31,4 +32,11 @@ export default class ImportGlobalFields extends BaseClass {
         element: Record<string, string>;
         isLastRequest: boolean;
     }): Promise<unknown>;
+    replaceGFs(): Promise<any>;
+    /**
+     * @method serializeUpdateGFs
+     * @param {ApiOptions} apiOptions ApiOptions
+     * @returns {ApiOptions} ApiOptions
+     */
+    serializeReplaceGFs(apiOptions: ApiOptions): ApiOptions;
 }

package/lib/import/modules/global-fields.js

@@ -21,6 +21,7 @@ class ImportGlobalFields extends base_class_1.default {
         this.createdGFs = [];
         this.failedGFs = [];
         this.pendingGFs = [];
+        this.existingGFs = [];
         this.reqConcurrency = this.gFsConfig.writeConcurrency || this.config.writeConcurrency;
         this.gFsMapperPath = path.resolve(this.config.data, 'mapper', 'global_fields');
         this.gFsFolderPath = path.resolve(this.config.data, this.gFsConfig.dirName);
@@ -43,6 +44,11 @@ class ImportGlobalFields extends base_class_1.default {
         this.installedExtensions = ((await utils_1.fsUtil.readFile(this.marketplaceAppMapperPath)) || { extension_uid: {} }).extension_uid;
         await this.importGFs();
         utils_1.fsUtil.writeFile(this.gFsPendingPath, this.pendingGFs);
+        if (this.importConfig.replaceExisting && this.existingGFs.length > 0) {
+            await this.replaceGFs().catch((error) => {
+                (0, utils_1.log)(this.importConfig, `Error while replacing global fields ${(0, utils_1.formatError)(error)}`, 'error');
+            });
+        }
         (0, utils_1.log)(this.config, 'Global fields import has been completed!', 'info');
     }
     async importGFs() {
@@ -52,10 +58,22 @@ class ImportGlobalFields extends base_class_1.default {
             utils_1.fsUtil.writeFile(this.gFsUidMapperPath, this.gFsUidMapper);
             (0, utils_1.log)(this.config, 'Global field ' + uid + ' created successfully', 'success');
         };
-        const onReject = ({ error, apiData: { uid } = undefined }) => {
-            (0, utils_1.log)(this.importConfig, `Global fields '${uid}' failed to import`, 'error');
-            (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(error), 'error');
-            this.failedGFs.push({ uid });
+        const onReject = ({ error, apiData: globalField = undefined }) => {
+            var _a;
+            const uid = globalField.uid;
+            if ((_a = error === null || error === void 0 ? void 0 : error.errors) === null || _a === void 0 ? void 0 : _a.title) {
+                if (this.importConfig.replaceExisting) {
+                    this.existingGFs.push(globalField);
+                }
+                if (!this.importConfig.skipExisting) {
+                    (0, utils_1.log)(this.importConfig, `Global fields '${uid}' already exist`, 'info');
+                }
+            }
+            else {
+                (0, utils_1.log)(this.importConfig, `Global fields '${uid}' failed to import`, 'error');
+                (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(error), 'error');
+                this.failedGFs.push({ uid });
+            }
         };
         return await this.makeConcurrentCall({
             processName: 'Import global fields',
@@ -73,7 +91,7 @@ class ImportGlobalFields extends base_class_1.default {
         return new Promise(async (resolve, reject) => {
             (0, utils_1.lookupExtension)(this.config, globalField.schema, this.config.preserveStackVersion, this.installedExtensions);
             let flag = { supressed: false };
-            await (0, utils_1.removeReferenceFields)(globalField.schema, flag, this.stackAPIClient);
+            await (0, utils_1.removeReferenceFields)(globalField.schema, flag, this.stack);
             if (flag.supressed) {
                 this.pendingGFs.push(globalField.uid);
             }
@@ -96,5 +114,44 @@ class ImportGlobalFields extends base_class_1.default {
             });
         });
     }
+    async replaceGFs() {
+        const onSuccess = ({ response: globalField, apiData: { uid } = { uid: null } }) => {
+            this.createdGFs.push(globalField);
+            this.gFsUidMapper[uid] = globalField;
+            utils_1.fsUtil.writeFile(this.gFsUidMapperPath, this.gFsUidMapper);
+            (0, utils_1.log)(this.config, 'Global field ' + uid + ' replaced successfully', 'success');
+        };
+        const onReject = ({ error, apiData: { uid } }) => {
+            (0, utils_1.log)(this.importConfig, `Global fields '${uid}' failed to replace`, 'error');
+            (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(error), 'error');
+            this.failedGFs.push({ uid });
+        };
+        await this.makeConcurrentCall({
+            apiContent: this.existingGFs,
+            processName: 'Replace global fields',
+            apiParams: {
+                serializeData: this.serializeReplaceGFs.bind(this),
+                reject: onReject.bind(this),
+                resolve: onSuccess.bind(this),
+                entity: 'update-gfs',
+                includeParamOnCompletion: true,
+            },
+            concurrencyLimit: this.importConfig.concurrency || this.importConfig.fetchConcurrency || 1,
+        }, undefined, false);
+    }
+    /**
+     * @method serializeUpdateGFs
+     * @param {ApiOptions} apiOptions ApiOptions
+     * @returns {ApiOptions} ApiOptions
+     */
+    serializeReplaceGFs(apiOptions) {
+        const { apiData: globalField } = apiOptions;
+        const globalFieldPayload = this.stack.globalField(globalField.uid);
+        Object.assign(globalFieldPayload, (0, lodash_1.cloneDeep)(globalField), {
+            stackHeaders: globalFieldPayload.stackHeaders,
+        });
+        apiOptions.apiData = globalFieldPayload;
+        return apiOptions;
+    }
 }
 exports.default = ImportGlobalFields;

package/lib/import/modules/locales.js

@@ -102,8 +102,13 @@ class ImportLocales extends base_class_1.default {
             utils_1.fsUtil.writeFile(this.langUidMapperPath, this.langUidMapper);
         };
         const onReject = ({ error, apiData: { uid, code } = undefined }) => {
-            (0, utils_1.log)(this.importConfig, `Language '${code}' failed to import`, 'error');
-            (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(error), 'error');
+            if ((error === null || error === void 0 ? void 0 : error.errorCode) === 247) {
+                (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(error), 'info');
+            }
+            else {
+                (0, utils_1.log)(this.importConfig, `Language '${code}' failed to import`, 'error');
+                (0, utils_1.log)(this.importConfig, (0, utils_1.formatError)(error), 'error');
+            }
             this.failedLocales.push({ uid, code });
         };
         return await this.makeConcurrentCall({

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

@@ -139,4 +139,5 @@ export default interface DefaultConfig {
     marketplaceAppEncryptionKey: string;
     getEncryptionKeyMaxRetry: number;
     createBackupDir?: string;
+    overwriteSupportedModules: string[];
 }

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

@@ -42,6 +42,8 @@ export default interface ImportConfig extends DefaultConfig, ExternalConfig {
     destinationStackName?: string;
     org_uid?: string;
     contentVersion: number;
+    replaceExisting?: boolean;
+    skipExisting?: boolean;
 }
 type branch = {
     uid: string;

package/lib/types/index.d.ts

@@ -29,6 +29,7 @@ export type ModuleClassParams = {
 export interface Extensions {
     dirName: string;
     fileName: string;
+    validKeys: string[];
     dependencies?: Modules[];
 }
 export interface MarketplaceAppsConfig {

package/lib/types/index.js

@@ -1,4 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-;
-;

package/lib/utils/common-helper.js

@@ -98,22 +98,11 @@ const sanitizeStack = (importConfig) => {
 };
 exports.sanitizeStack = sanitizeStack;
 const masterLocalDetails = (stackAPIClient) => {
-    return new Promise((resolve, reject) => {
-        const result = stackAPIClient.locale().query();
-        result
-            .find()
-            .then((response) => {
-            const masterLocalObj = response.items.filter((obj) => {
-                if (obj.fallback_locale === null) {
-                    return obj;
-                }
-            });
-            return resolve(masterLocalObj[0]);
-        })
-            .catch((error) => {
-            return reject(error);
-        });
-    });
+    return stackAPIClient
+        .locale()
+        .query({ query: { fallback_locale: null } })
+        .find()
+        .then(({ items }) => items[0]);
 };
 exports.masterLocalDetails = masterLocalDetails;
 const field_rules_update = (importConfig, ctPath) => {

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

@@ -75,6 +75,11 @@ const setupConfig = async (importCmdFlags) => {
     }
     // Note to support old modules
     config.target_stack = config.apiKey;
+    config.replaceExisting = importCmdFlags['replace-existing'];
+    config.skipExisting = importCmdFlags['skip-existing'];
+    if (config.replaceExisting && !(0, lodash_1.includes)(config.overwriteSupportedModules, config.moduleName)) {
+        throw new Error(`Failed to overwrite ${config.moduleName} module! Currently, with the import command, you can overwrite the following modules: ${config.overwriteSupportedModules.join(',')}`);
+    }
     return config;
 };
 exports.default = setupConfig;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.9.0",
+  "version": "1.10.0",
   "commands": {
     "cm:stacks:import": {
       "id": "cm:stacks:import",
@@ -86,6 +86,7 @@
           "type": "option",
           "char": "m",
           "description": "[optional] specific module name",
+          "required": false,
           "multiple": false
         },
         "backup-dir": {
@@ -121,6 +122,23 @@
           "description": "[optional] Override marketplace prompts",
           "required": false,
           "allowNo": false
+        },
+        "replace-existing": {
+          "name": "replace-existing",
+          "type": "boolean",
+          "description": "Replaces the existing module in the target stack.",
+          "required": false,
+          "allowNo": false,
+          "dependsOn": [
+            "module"
+          ]
+        },
+        "skip-existing": {
+          "name": "skip-existing",
+          "type": "boolean",
+          "description": "Skips the module exists warning messages.",
+          "required": false,
+          "allowNo": false
         }
       },
       "args": {}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "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.12",
-    "@contentstack/cli-utilities": "~1.5.2",
     "@oclif/core": "^2.9.3",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",
@@ -92,8 +92,8 @@
     },
     "shortCommandName": {
       "cm:stacks:import": "IMPRT",
-      "cm:import": "IMPRT"
+      "cm:import": "O-IMPRT"
     }
   },
   "repository": "https://github.com/contentstack/cli"
-}
+}