@contentstack/cli-cm-import 1.7.1 → 1.8.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.7.1 linux-x64 node-v18.17.0
+@contentstack/cli-cm-import/1.8.0 linux-x64 node-v18.17.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/config/index.js

@@ -377,6 +377,8 @@ const config = {
         'content-types',
         'webhooks',
         'custom-roles',
+        'workflows',
+        'entries',
     ],
     rateLimit: 5,
     preserveStackVersion: false,

package/lib/import/module-importer.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
 const utils_1 = require("../utils");
 const modules_1 = tslib_1.__importDefault(require("./modules"));
 const modules_js_1 = tslib_1.__importDefault(require("./modules-js"));
@@ -17,6 +18,20 @@ class ModuleImporter {
         if (this.importConfig.branchName) {
             await (0, utils_1.validateBranch)(this.stackAPIClient, this.importConfig, this.importConfig.branchName);
         }
+        // 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://api.contentstack.io/v3/locales', {
+            locale: {
+                name: 'English',
+                code: 'en-us',
+            },
+        });
+        if (data.error_code === 161) {
+            throw new Error(data.error_message);
+        }
         if (!this.importConfig.master_locale) {
             let masterLocalResponse = await (0, utils_1.masterLocalDetails)(this.stackAPIClient);
             this.importConfig['master_locale'] = { code: masterLocalResponse.code };

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

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

@@ -105,10 +105,11 @@ class BaseClass {
      * @return {Promise} Promise<void>
      */
     makeAPICall(apiOptions, isLastRequest = false) {
+        var _a, _b;
         if (apiOptions.serializeData instanceof Function) {
             apiOptions = apiOptions.serializeData(apiOptions);
         }
-        const { uid, entity, reject, resolve, apiData, additionalInfo, includeParamOnCompletion } = apiOptions;
+        const { uid, entity, reject, resolve, apiData, additionalInfo = {}, includeParamOnCompletion } = apiOptions;
         const onSuccess = (response) => resolve({
             response,
             isLastRequest,
@@ -168,6 +169,9 @@ class BaseClass {
             case 'create-cts':
                 return this.stack.contentType().create(apiData).then(onSuccess).catch(onReject);
             case 'update-cts':
+                if (additionalInfo.skip) {
+                    return Promise.resolve(onSuccess(apiData));
+                }
                 return apiData.update().then(onSuccess).catch(onReject);
             case 'update-gfs':
                 return apiData.update().then(onSuccess).catch(onReject);
@@ -210,6 +214,32 @@ class BaseClass {
                     .create({ role: apiData })
                     .then(onSuccess)
                     .catch(onReject);
+            case 'create-entries':
+                return this.stack
+                    .contentType(additionalInfo.cTUid)
+                    .entry()
+                    .create({ entry: apiData }, { locale: additionalInfo.locale })
+                    .then(onSuccess)
+                    .catch(onReject);
+            case 'update-entries':
+                return apiData.update({ locale: additionalInfo.locale }).then(onSuccess).catch(onReject);
+            case 'publish-entries':
+                if (additionalInfo.skip) {
+                    return Promise.resolve(onSuccess(apiData));
+                }
+                return this.stack
+                    .contentType(additionalInfo.cTUid)
+                    .entry(additionalInfo.entryUid)
+                    .publish({ publishDetails: apiData, locale: additionalInfo.locale })
+                    .then(onSuccess)
+                    .catch(onReject);
+            case 'delete-entries':
+                return this.stack
+                    .contentType(apiData.cTUid)
+                    .entry(apiData.entryUid)
+                    .delete({ locale: (_b = (_a = this.importConfig) === null || _a === void 0 ? void 0 : _a.master_locale) === null || _b === void 0 ? void 0 : _b.code })
+                    .then(onSuccess)
+                    .catch(onReject);
             default:
                 return Promise.resolve();
         }

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

@@ -150,7 +150,7 @@ class ContentTypesImport extends base_class_1.default {
             (0, utils_1.log)(this.importConfig, `Updated the global field ${uid} with content type references`, 'info');
         };
         const onReject = ({ error, apiData: { uid } = undefined }) => {
-            (0, utils_1.log)(this.importConfig, `failed to update the global field ${uid} ${(0, utils_1.formatError)(error)}`, 'error');
+            (0, utils_1.log)(this.importConfig, `failed to update the global field '${uid}' ${(0, utils_1.formatError)(error)}`, 'error');
         };
         return await this.makeConcurrentCall({
             processName: 'Update pending global fields',

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

@@ -0,0 +1,93 @@
+/*!
+ * Contentstack Import
+ * Copyright (c) 2019 Contentstack LLC
+ * MIT Licensed
+ */
+import { ModuleClassParams } from '../../types';
+import BaseClass, { ApiOptions } from './base-class';
+export default class EntriesImport extends BaseClass {
+    private assetUidMapperPath;
+    private assetUidMapper;
+    private assetUrlMapper;
+    private assetUrlMapperPath;
+    private entriesMapperPath;
+    private envPath;
+    private entriesUIDMapperPath;
+    private uniqueUidMapperPath;
+    private modifiedCTsPath;
+    private marketplaceAppMapperPath;
+    private entriesConfig;
+    private cTsPath;
+    private localesPath;
+    private importConcurrency;
+    private entriesPath;
+    private cTs;
+    private modifiedCTs;
+    private refCTs;
+    private jsonRteCTs;
+    private jsonRteCTsWithRef;
+    private jsonRteEntries;
+    private installedExtensions;
+    private createdEntries;
+    private failedEntries;
+    private locales;
+    private entriesUidMapper;
+    private envs;
+    private autoCreatedEntries;
+    constructor({ importConfig, stackAPIClient }: ModuleClassParams);
+    start(): Promise<any>;
+    disableMandatoryCTReferences(): Promise<void>;
+    /**
+     * @method serializeUpdateCTs
+     * @param {ApiOptions} apiOptions ApiOptions
+     * @returns {ApiOptions} ApiOptions
+     */
+    serializeUpdateCTs(apiOptions: ApiOptions): ApiOptions;
+    populateEntryCreatePayload(): {
+        cTUid: string;
+        locale: string;
+    }[];
+    createEntries({ cTUid, locale }: {
+        cTUid: string;
+        locale: string;
+    }): Promise<void>;
+    /**
+     * @method serializeEntries
+     * @param {ApiOptions} apiOptions ApiOptions
+     * @returns {ApiOptions} ApiOptions
+     */
+    serializeEntries(apiOptions: ApiOptions): ApiOptions;
+    populateEntryUpdatePayload(): {
+        cTUid: string;
+        locale: string;
+    }[];
+    updateEntriesWithReferences({ cTUid, locale }: {
+        cTUid: string;
+        locale: string;
+    }): Promise<void>;
+    /**
+     * @method serializeUpdateEntries
+     * @param {ApiOptions} apiOptions ApiOptions
+     * @returns {ApiOptions} ApiOptions
+     */
+    serializeUpdateEntries(apiOptions: ApiOptions): ApiOptions;
+    enableMandatoryCTReferences(): Promise<void>;
+    /**
+     * @method serializeUpdateCTsWithRef
+     * @param {ApiOptions} apiOptions ApiOptions
+     * @returns {ApiOptions} ApiOptions
+     */
+    serializeUpdateCTsWithRef(apiOptions: ApiOptions): ApiOptions;
+    removeAutoCreatedEntries(): Promise<void>;
+    updateFieldRules(): Promise<void>;
+    publishEntries({ cTUid, locale }: {
+        cTUid: string;
+        locale: string;
+    }): Promise<void>;
+    /**
+     * @method serializeEntries
+     * @param {ApiOptions} apiOptions ApiOptions
+     * @returns {ApiOptions} ApiOptions
+     */
+    serializePublishEntries(apiOptions: ApiOptions): ApiOptions;
+}