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

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

@@ -113,7 +113,6 @@ ImportCommand.flags = {
     '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,

package/lib/import/module-importer.js

@@ -20,17 +20,8 @@ class ModuleImporter {
         }
         // Temporarily adding this api call to verify management token has read and write permissions
         // TODO: CS-40354 - CLI | import rewrite | Migrate HTTP call to SDK call once fix is ready from SDK side
-        const httpClient = new cli_utilities_1.HttpClient({
-            headers: { api_key: this.importConfig.apiKey, authorization: this.importConfig.management_token },
-        });
-        const { data } = await httpClient.post(`https://${this.importConfig.host}/v3/locales`, {
-            locale: {
-                name: 'English',
-                code: 'en-us',
-            },
-        });
-        if (data.error_code === 161) {
-            throw new Error(data.error_message);
+        if (this.importConfig.management_token) {
+            await (0, cli_utilities_1.addLocale)(this.importConfig.apiKey, this.importConfig.management_token, this.importConfig.host);
         }
         if (!this.importConfig.master_locale) {
             let masterLocalResponse = await (0, utils_1.masterLocalDetails)(this.stackAPIClient);

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

@@ -26,6 +26,7 @@ export default class ImportAssets extends BaseClass {
     private assetsUidMap;
     private assetsUrlMap;
     private assetsFolderMap;
+    private rootFolder;
     constructor({ importConfig, stackAPIClient }: ModuleClassParams);
     /**
      * @method start

package/lib/import/modules/assets.js

@@ -10,6 +10,7 @@ const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const uniq_1 = tslib_1.__importDefault(require("lodash/uniq"));
 const node_fs_1 = require("node:fs");
 const includes_1 = tslib_1.__importDefault(require("lodash/includes"));
+const uuid_1 = require("uuid");
 const node_path_1 = require("node:path");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const config_1 = tslib_1.__importDefault(require("../../config"));
@@ -184,6 +185,10 @@ class ImportAssets extends base_class_1.default {
         if (asset.parent_uid) {
             asset.parent_uid = this.assetsFolderMap[asset.parent_uid];
         }
+        else if (this.importConfig.replaceExisting) {
+            // adds the root folder as parent for all assets in the root level
+            asset.parent_uid = this.assetsFolderMap[this.rootFolder.uid];
+        }
         apiOptions.apiData = asset;
         if (this.assetsUidMap[asset.uid] && this.assetConfig.importSameStructure) {
             apiOptions.entity = 'replace-assets';
@@ -249,19 +254,43 @@ class ImportAssets extends base_class_1.default {
      * @returns {Array<Record<string, any>>} Array<Record<string, any>>
      */
     constructFolderImportOrder(folders) {
-        let parentUid = [];
+        let parentUIds = [];
         // NOTE: Read root folder
         const importOrder = (0, filter_1.default)(folders, { parent_uid: null }).map(({ uid, name, parent_uid, created_at }) => {
-            parentUid.push(uid);
+            parentUIds.push(uid);
             return { uid, name, parent_uid, created_at };
         });
-        while (!(0, isEmpty_1.default)(parentUid)) {
+        while (!(0, isEmpty_1.default)(parentUIds)) {
             // NOTE: Read nested folders every iteration until we find empty folders
-            parentUid = (0, filter_1.default)(folders, ({ parent_uid }) => (0, includes_1.default)(parentUid, parent_uid)).map(({ uid, name, parent_uid, created_at }) => {
+            parentUIds = (0, filter_1.default)(folders, ({ parent_uid }) => (0, includes_1.default)(parentUIds, parent_uid)).map(({ uid, name, parent_uid, created_at }) => {
                 importOrder.push({ uid, name, parent_uid, created_at });
                 return uid;
             });
         }
+        if (this.importConfig.replaceExisting) {
+            // Note: adds a root folder to distinguish latest asset uploads
+            // Todo: This temporary approach should be updated with asset and folder overwrite strategy, which follows
+            // folder overwrite
+            // 1. Create folder trees, 2. Export all target stack folders, 3.Match the source to target folders and create a list of existing folders
+            // 4. Replace existing folders
+            // Asset overwrite
+            // 1. Search asset with title + filename + type
+            // 2. if there are multiple assets fetched with same query, then check the parent uid against mapper created while importing folders
+            // 3. Replace matched assets
+            this.rootFolder = {
+                uid: (0, uuid_1.v4)(),
+                name: `Import-${(0, utils_1.formatDate)()}`,
+                parent_uid: null,
+                created_at: null,
+            };
+            (0, filter_1.default)(importOrder, (folder, index) => {
+                if (!folder.parent_uid) {
+                    importOrder.splice(index, 1, Object.assign(Object.assign({}, folder), { parent_uid: this.rootFolder.uid }));
+                }
+            });
+            // NOTE: Adds root folder
+            importOrder.unshift(this.rootFolder);
+        }
         return importOrder;
     }
 }

package/lib/import/modules/entries.js

@@ -58,7 +58,7 @@ 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) {
+            if (this.importConfig.replaceExisting) {
                 // 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) => {
@@ -253,8 +253,7 @@ class EntriesImport extends base_class_1.default {
             //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) {
+                    if (this.importConfig.replaceExisting) {
                         entry.entryOldUid = uid;
                         entry.sourceEntryFilePath = path.join(basePath, additionalInfo.entryFileName); // stores source file path temporarily
                         existingEntriesFileHelper.writeIntoFile({ [uid]: entry }, { mapKeyVal: true });

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

@@ -18,3 +18,4 @@ export declare const executeTask: (tasks: unknown[], handler: (task: unknown) =>
     concurrency: number;
 }) => Promise<unknown[]>;
 export declare const validateBranch: (stackAPIClient: any, config: ImportConfig, branch: any) => Promise<unknown>;
+export declare const formatDate: (date?: Date) => string;

package/lib/utils/common-helper.js

@@ -6,7 +6,7 @@
  * MIT Licensed
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateBranch = exports.executeTask = exports.formatError = exports.getConfig = exports.field_rules_update = exports.masterLocalDetails = exports.sanitizeStack = exports.buildAppConfig = exports.validateConfig = exports.initialization = void 0;
+exports.formatDate = exports.validateBranch = exports.executeTask = exports.formatError = exports.getConfig = exports.field_rules_update = exports.masterLocalDetails = exports.sanitizeStack = exports.buildAppConfig = exports.validateConfig = exports.initialization = void 0;
 const tslib_1 = require("tslib");
 const _ = tslib_1.__importStar(require("lodash"));
 const path = tslib_1.__importStar(require("path"));
@@ -231,3 +231,18 @@ const validateBranch = async (stackAPIClient, config, branch) => {
     });
 };
 exports.validateBranch = validateBranch;
+const formatDate = (date = new Date()) => {
+    // Format the date manually
+    const formattedDate = `${date.getFullYear()}-${(date.getMonth() + 1).toString().padStart(2, '0')}-${date
+        .getDate()
+        .toString()
+        .padStart(2, '0')}T${date.getHours().toString().padStart(2, '0')}-${date
+        .getMinutes()
+        .toString()
+        .padStart(2, '0')}-${date.getSeconds().toString().padStart(2, '0')}-${date
+        .getMilliseconds()
+        .toString()
+        .padStart(3, '0')}Z`;
+    return formattedDate;
+};
+exports.formatDate = formatDate;

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

@@ -77,9 +77,6 @@ const setupConfig = async (importCmdFlags) => {
     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.11.1",
+  "version": "1.12.0",
   "commands": {
     "cm:stacks:import": {
       "id": "cm:stacks:import",
@@ -128,10 +128,7 @@
           "type": "boolean",
           "description": "Replaces the existing module in the target stack.",
           "required": false,
-          "allowNo": false,
-          "dependsOn": [
-            "module"
-          ]
+          "allowNo": false
         },
         "skip-existing": {
           "name": "skip-existing",

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "1.11.1",
+  "version": "1.12.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
     "@contentstack/cli-command": "~1.2.16",
-    "@contentstack/cli-utilities": "~1.5.7",
+    "@contentstack/cli-utilities": "~1.5.8",
     "@contentstack/management": "~1.12.0",
     "@oclif/core": "^2.9.3",
     "axios": "^1.6.0",
@@ -21,6 +21,7 @@
     "mkdirp": "^1.0.4",
     "promise-limit": "^2.7.0",
     "tslib": "^2.4.1",
+    "uuid": "^9.0.0",
     "winston": "^3.7.2"
   },
   "devDependencies": {
@@ -34,6 +35,7 @@
     "@types/node": "^14.14.32",
     "@types/sinon": "^10.0.2",
     "@types/tar": "^4.0.3",
+    "@types/uuid": "^9.0.7",
     "@typescript-eslint/eslint-plugin": "^5.48.2",
     "chai": "^4.2.0",
     "eslint": "^8.18.0",