@contentstack/cli-cm-import 1.6.0 → 1.7.1

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

@@ -1,10 +1,5 @@
 /**
  * extension lookup
  */
-/*!
- * Contentstack Import
- * Copyright (c) 2019 Contentstack LLC
- * MIT Licensed
- */
 import { ImportConfig } from '../types';
 export declare const lookupExtension: (config: ImportConfig, schema: any, preserveStackVersion: any, installedExtensions: any) => void;

package/lib/utils/extension-helper.js

@@ -4,15 +4,18 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.lookupExtension = void 0;
-// eslint-disable-next-line unicorn/filename-case
-let path = require('path');
-const _ = require('lodash');
-let helper = require('./file-helper');
+/*!
+ * Contentstack Import
+ * Copyright (c) 2019 Contentstack LLC
+ * MIT Licensed
+ */
+const node_path_1 = require("node:path");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
 // eslint-disable-next-line camelcase
 const lookupExtension = function (config, schema, preserveStackVersion, installedExtensions) {
-    const extensionPath = path.resolve(config.data, 'mapper/extensions', 'uid-mapping.json');
-    const globalfieldsPath = path.resolve(config.data, 'mapper/globalfields', 'uid-mapping.json');
-    const marketplaceAppPath = path.resolve(config.data, 'marketplace_apps', 'marketplace_apps.json');
+    const fs = new cli_utilities_1.FsUtility({ basePath: config.backupDir });
+    const extensionPath = (0, node_path_1.join)(config.backupDir, 'mapper/extensions', 'uid-mapping.json');
+    const globalfieldsPath = (0, node_path_1.join)(config.backupDir, 'mapper/globalfields', 'uid-mapping.json');
     for (let i in schema) {
         if (schema[i].data_type === 'group') {
             (0, exports.lookupExtension)(config, schema[i].schema, preserveStackVersion, installedExtensions);
@@ -37,16 +40,25 @@ const lookupExtension = function (config, schema, preserveStackVersion, installe
                 schema[i].field_metadata.ref_multiple_content_types = true;
             }
         }
+        else if (schema[i].data_type === 'reference' &&
+            schema[i].field_metadata.hasOwnProperty('ref_multiple_content_types') &&
+            installedExtensions &&
+            installedExtensions[schema[i].extension_uid]) {
+            schema[i].extension_uid = installedExtensions[schema[i].extension_uid];
+        }
+        else if (schema[i].data_type === 'text' && installedExtensions && installedExtensions[schema[i].extension_uid]) {
+            schema[i].extension_uid = installedExtensions[schema[i].extension_uid];
+        }
         else if (schema[i].data_type === 'global_field') {
-            let global_fields_key_value = schema[i].reference_to;
-            let global_fields_data = helper.readFileSync(path.join(globalfieldsPath));
+            const global_fields_key_value = schema[i].reference_to;
+            const global_fields_data = fs.readFile(globalfieldsPath);
             if (global_fields_data && global_fields_data.hasOwnProperty(global_fields_key_value)) {
                 schema[i].reference_to = global_fields_data[global_fields_key_value];
             }
         }
         else if (schema[i].hasOwnProperty('extension_uid')) {
             const extension_key_value = schema[i].extension_uid;
-            const data = helper.readFileSync(path.join(extensionPath));
+            const data = fs.readFile(extensionPath);
             if (data && data.hasOwnProperty(extension_key_value)) {
                 // eslint-disable-next-line camelcase
                 schema[i].extension_uid = data[extension_key_value];
@@ -59,7 +71,7 @@ const lookupExtension = function (config, schema, preserveStackVersion, installe
         }
         else if (schema[i].data_type === 'json' && schema[i].hasOwnProperty('plugins') && schema[i].plugins.length > 0) {
             const newPluginUidsArray = [];
-            const data = helper.readFileSync(path.join(extensionPath));
+            const data = fs.readFile(extensionPath);
             schema[i].plugins.forEach((extension_key_value) => {
                 if (data && data.hasOwnProperty(extension_key_value)) {
                     newPluginUidsArray.push(data[extension_key_value]);

package/lib/utils/index.d.ts

@@ -5,7 +5,7 @@ export { fsUtil } from './file-helper';
 export { default as backupHandler } from './backup-handler';
 export { log, unlinkFileLogger } from './logger';
 export { uploadAssetHelper, lookupAssets } from './asset-helper';
-export { getDeveloperHubUrl } from './marketplace-app-helper';
+export { getDeveloperHubUrl, getOrgUid, getConfirmationToCreateApps, createPrivateApp, handleNameConflict, installApp, makeRedirectUrlCall, confirmToCloseProcess, getAllStackSpecificApps, ifAppAlreadyExist, updateAppConfig } from './marketplace-app-helper';
 export { schemaTemplate, suppressSchemaReference, removeReferenceFields } from './content-type-helper';
 export { lookupExtension } from './extension-helper';
 export { lookupEntries } from './entries-helper';

package/lib/utils/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lookupEntries = exports.lookupExtension = exports.removeReferenceFields = exports.suppressSchemaReference = exports.schemaTemplate = exports.getDeveloperHubUrl = exports.lookupAssets = exports.uploadAssetHelper = exports.unlinkFileLogger = exports.log = exports.backupHandler = exports.fsUtil = exports.fileHelper = exports.setupImportConfig = exports.interactive = void 0;
+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");
@@ -18,6 +18,16 @@ Object.defineProperty(exports, "uploadAssetHelper", { enumerable: true, get: fun
 Object.defineProperty(exports, "lookupAssets", { enumerable: true, get: function () { return asset_helper_1.lookupAssets; } });
 var marketplace_app_helper_1 = require("./marketplace-app-helper");
 Object.defineProperty(exports, "getDeveloperHubUrl", { enumerable: true, get: function () { return marketplace_app_helper_1.getDeveloperHubUrl; } });
+Object.defineProperty(exports, "getOrgUid", { enumerable: true, get: function () { return marketplace_app_helper_1.getOrgUid; } });
+Object.defineProperty(exports, "getConfirmationToCreateApps", { enumerable: true, get: function () { return marketplace_app_helper_1.getConfirmationToCreateApps; } });
+Object.defineProperty(exports, "createPrivateApp", { enumerable: true, get: function () { return marketplace_app_helper_1.createPrivateApp; } });
+Object.defineProperty(exports, "handleNameConflict", { enumerable: true, get: function () { return marketplace_app_helper_1.handleNameConflict; } });
+Object.defineProperty(exports, "installApp", { enumerable: true, get: function () { return marketplace_app_helper_1.installApp; } });
+Object.defineProperty(exports, "makeRedirectUrlCall", { enumerable: true, get: function () { return marketplace_app_helper_1.makeRedirectUrlCall; } });
+Object.defineProperty(exports, "confirmToCloseProcess", { enumerable: true, get: function () { return marketplace_app_helper_1.confirmToCloseProcess; } });
+Object.defineProperty(exports, "getAllStackSpecificApps", { enumerable: true, get: function () { return marketplace_app_helper_1.getAllStackSpecificApps; } });
+Object.defineProperty(exports, "ifAppAlreadyExist", { enumerable: true, get: function () { return marketplace_app_helper_1.ifAppAlreadyExist; } });
+Object.defineProperty(exports, "updateAppConfig", { enumerable: true, get: function () { return marketplace_app_helper_1.updateAppConfig; } });
 var content_type_helper_1 = require("./content-type-helper");
 Object.defineProperty(exports, "schemaTemplate", { enumerable: true, get: function () { return content_type_helper_1.schemaTemplate; } });
 Object.defineProperty(exports, "suppressSchemaReference", { enumerable: true, get: function () { return content_type_helper_1.suppressSchemaReference; } });

package/lib/utils/interactive.d.ts

@@ -1,2 +1,7 @@
 export declare const askContentDir: () => Promise<string>;
 export declare const askAPIKey: () => Promise<string>;
+export declare const askDeveloperHubUrl: (regionName: string) => Promise<string>;
+export declare const askEncryptionKey: (defaultValue: unknown) => Promise<string>;
+export declare const askAppName: (app: any, appSuffix: number) => Promise<string>;
+export declare const getAppName: (name: string, appSuffix?: number) => string;
+export declare const selectConfiguration: () => Promise<string>;

package/lib/utils/interactive.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.askAPIKey = exports.askContentDir = void 0;
+exports.selectConfiguration = exports.getAppName = exports.askAppName = exports.askEncryptionKey = exports.askDeveloperHubUrl = exports.askAPIKey = exports.askContentDir = void 0;
 const tslib_1 = require("tslib");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const path = tslib_1.__importStar(require("path"));
+const first_1 = tslib_1.__importDefault(require("lodash/first"));
+const split_1 = tslib_1.__importDefault(require("lodash/split"));
 const askContentDir = async () => {
     const result = await cli_utilities_1.cliux.inquire({
         type: 'input',
@@ -21,3 +23,66 @@ const askAPIKey = async () => {
     });
 };
 exports.askAPIKey = askAPIKey;
+const askDeveloperHubUrl = async (regionName) => {
+    return await cli_utilities_1.cliux.inquire({
+        type: 'input',
+        name: 'name',
+        validate: (url) => {
+            if (!url)
+                return "Developer-hub URL can't be empty.";
+            return true;
+        },
+        message: `Enter the developer-hub base URL for the ${regionName} region -`,
+    });
+};
+exports.askDeveloperHubUrl = askDeveloperHubUrl;
+const askEncryptionKey = async (defaultValue) => {
+    return await cli_utilities_1.cliux.inquire({
+        type: 'input',
+        name: 'name',
+        default: defaultValue,
+        validate: (key) => {
+            if (!key)
+                return "Encryption key can't be empty.";
+            return true;
+        },
+        message: 'Enter marketplace app configurations encryption key',
+    });
+};
+exports.askEncryptionKey = askEncryptionKey;
+const askAppName = async (app, appSuffix) => {
+    return await cli_utilities_1.cliux.inquire({
+        type: 'input',
+        name: 'name',
+        validate: validateAppName,
+        default: (0, exports.getAppName)(app.name, appSuffix),
+        message: `${app.name} app already exist. Enter a new name to create an app.?`,
+    });
+};
+exports.askAppName = askAppName;
+const getAppName = (name, appSuffix = 1) => {
+    if (name.length >= 19)
+        name = name.slice(0, 18);
+    name = `${(0, first_1.default)((0, split_1.default)(name, '◈'))}◈${appSuffix}`;
+    return name;
+};
+exports.getAppName = getAppName;
+const validateAppName = (name) => {
+    if (name.length < 3 || name.length > 20) {
+        return 'The app name should be within 3-20 characters long.';
+    }
+    return true;
+};
+const selectConfiguration = async () => {
+    return await cli_utilities_1.cliux.inquire({
+        choices: [
+            'Update it with the new configuration.',
+            'Do not update the configuration (WARNING!!! If you do not update the configuration, there may be some issues with the content which you import).',
+            'Exit',
+        ],
+        type: 'list',
+        name: 'value',
+        message: 'Choose the option to proceed',
+    });
+};
+exports.selectConfiguration = selectConfiguration;

package/lib/utils/marketplace-app-helper.d.ts

@@ -1,4 +1,16 @@
-import { HttpClient } from '@contentstack/cli-utilities';
+import { HttpClient, ContentstackClient } from '@contentstack/cli-utilities';
 import { ImportConfig } from '../types';
 export declare const getAllStackSpecificApps: (developerHubBaseUrl: string, httpClient: HttpClient, config: ImportConfig) => Promise<any>;
 export declare const getDeveloperHubUrl: (config: ImportConfig) => Promise<string>;
+export declare const getOrgUid: (config: ImportConfig) => Promise<string>;
+export declare const getConfirmationToCreateApps: (privateApps: any, config: ImportConfig) => Promise<boolean>;
+export declare const createPrivateApp: (client: ContentstackClient, config: ImportConfig, app: any) => Promise<any>;
+export declare const installApp: (client: ContentstackClient, config: ImportConfig, appManifestUid?: string, mappedUid?: string) => Promise<any>;
+export declare const handleNameConflict: (app: any, appSuffix: number, config: ImportConfig) => Promise<any>;
+export declare const makeRedirectUrlCall: (response: any, appName: string, config: ImportConfig) => Promise<void>;
+export declare const confirmToCloseProcess: (installation: any, config: ImportConfig) => Promise<void>;
+export declare const ifAppAlreadyExist: (app: any, currentStackApp: any, config: ImportConfig) => Promise<{}>;
+export declare const updateAppConfig: (client: ContentstackClient, config: ImportConfig, app: any, payload: {
+    configuration: Record<string, unknown>;
+    server_configuration: Record<string, unknown>;
+}) => Promise<any>;

package/lib/utils/marketplace-app-helper.js

@@ -1,31 +1,143 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDeveloperHubUrl = exports.getAllStackSpecificApps = void 0;
+exports.updateAppConfig = exports.ifAppAlreadyExist = exports.confirmToCloseProcess = exports.makeRedirectUrlCall = exports.handleNameConflict = exports.installApp = exports.createPrivateApp = exports.getConfirmationToCreateApps = exports.getOrgUid = exports.getDeveloperHubUrl = exports.getAllStackSpecificApps = void 0;
+const tslib_1 = require("tslib");
+const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
+const map_1 = tslib_1.__importDefault(require("lodash/map"));
+const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
+const includes_1 = tslib_1.__importDefault(require("lodash/includes"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const logger_1 = require("./logger");
-const { formatError } = require('.');
-const getAllStackSpecificApps = (developerHubBaseUrl, httpClient, config) => {
-    return httpClient
+const interactive_1 = require("./interactive");
+const utils_1 = require("../utils");
+const interactive_2 = require("../utils/interactive");
+const getAllStackSpecificApps = async (developerHubBaseUrl, httpClient, config) => {
+    return await httpClient
         .get(`${developerHubBaseUrl}/installations?target_uids=${config.target_stack}`)
         .then(({ data }) => data.data)
-        .catch((error) => (0, logger_1.log)(config, `Failed to export marketplace-apps ${formatError(error)}`, 'error'));
+        .catch((error) => (0, logger_1.log)(config, `Failed to export marketplace-apps ${(0, utils_1.formatError)(error)}`, 'error'));
 };
 exports.getAllStackSpecificApps = getAllStackSpecificApps;
 const getDeveloperHubUrl = async (config) => {
     const { cma, name } = cli_utilities_1.configHandler.get('region') || {};
     let developerHubBaseUrl = config.developerHubUrls[cma];
     if (!developerHubBaseUrl) {
-        developerHubBaseUrl = await cli_utilities_1.cliux.inquire({
-            type: 'input',
-            name: 'name',
-            validate: (url) => {
-                if (!url)
-                    return "Developer-hub URL can't be empty.";
-                return true;
-            },
-            message: `Enter the developer-hub base URL for the ${name} region -`,
-        });
+        developerHubBaseUrl = await (0, interactive_1.askDeveloperHubUrl)(name);
     }
     return developerHubBaseUrl.startsWith('http') ? developerHubBaseUrl : `https://${developerHubBaseUrl}`;
 };
 exports.getDeveloperHubUrl = getDeveloperHubUrl;
+const getOrgUid = async (config) => {
+    const tempAPIClient = await (0, cli_utilities_1.managementSDKClient)({ host: config.host });
+    const tempStackData = await tempAPIClient
+        .stack({ api_key: config.target_stack })
+        .fetch()
+        .catch((error) => {
+        (0, logger_1.log)(config, (0, utils_1.formatError)(error), 'error');
+    });
+    return (tempStackData === null || tempStackData === void 0 ? void 0 : tempStackData.org_uid) || '';
+};
+exports.getOrgUid = getOrgUid;
+const getConfirmationToCreateApps = async (privateApps, config) => {
+    if (!config.forceStopMarketplaceAppsPrompt) {
+        if (!(await cli_utilities_1.cliux.confirm(chalk_1.default.yellow(`WARNING!!! The listed apps are private apps that are not available in the destination stack: \n\n${(0, map_1.default)(privateApps, ({ manifest: { name } }, index) => `${String(index + 1)}) ${name}`).join('\n')}\n\nWould you like to re-create the private app and then proceed with the installation? (y/n)`)))) {
+            if (await cli_utilities_1.cliux.confirm(chalk_1.default.yellow(`\nWARNING!!! Canceling the app re-creation may break the content type and entry import. Would you like to proceed without re-create the private app? (y/n)`))) {
+                return Promise.resolve(true);
+            }
+            if (!(await cli_utilities_1.cliux.confirm(chalk_1.default.yellow('\nWould you like to re-create the private app and then proceed with the installation? (y/n)')))) {
+                process.exit();
+            }
+        }
+    }
+};
+exports.getConfirmationToCreateApps = getConfirmationToCreateApps;
+const createPrivateApp = async (client, config, app) => {
+    const privateApp = (0, omit_1.default)(app, ['uid']);
+    return await client
+        .organization(config.org_uid)
+        .app()
+        .create(privateApp)
+        .catch((error) => error);
+};
+exports.createPrivateApp = createPrivateApp;
+const installApp = async (client, config, appManifestUid, mappedUid) => {
+    const appUid = mappedUid || appManifestUid;
+    return await client
+        .organization(config.org_uid)
+        .app(appUid)
+        .install({ targetUid: config.target_stack, targetType: 'stack' })
+        .catch((error) => error);
+};
+exports.installApp = installApp;
+const handleNameConflict = async (app, appSuffix, config) => {
+    const appName = config.forceStopMarketplaceAppsPrompt
+        ? (0, interactive_2.getAppName)(app.name, appSuffix)
+        : await (0, interactive_2.askAppName)(app, appSuffix);
+    app.name = appName;
+    return app;
+};
+exports.handleNameConflict = handleNameConflict;
+const makeRedirectUrlCall = async (response, appName, config) => {
+    if (response.redirect_url) {
+        (0, logger_1.log)(config, `${appName} - OAuth api call started.!`, 'info');
+        await new cli_utilities_1.HttpClient({ maxRedirects: 20, maxBodyLength: Infinity })
+            .get(response.redirect_url)
+            .then(async ({ response }) => {
+            if ((0, includes_1.default)([501, 403], response.status)) {
+                (0, logger_1.log)(config, `${appName} - ${response.statusText}, OAuth api call failed.!`, 'error');
+                (0, logger_1.log)(config, (0, utils_1.formatError)(response), 'error');
+                await (0, exports.confirmToCloseProcess)(response.data, config);
+            }
+            else {
+                (0, logger_1.log)(config, `${appName} - OAuth api call completed.!`, 'success');
+            }
+        })
+            .catch((error) => {
+            if ((0, includes_1.default)([501, 403], error.status)) {
+                (0, logger_1.log)(config, (0, utils_1.formatError)(error), 'error');
+            }
+        });
+    }
+};
+exports.makeRedirectUrlCall = makeRedirectUrlCall;
+const confirmToCloseProcess = async (installation, config) => {
+    cli_utilities_1.cliux.print(`\nWARNING!!! ${(0, utils_1.formatError)(installation.message)}\n`, { color: 'yellow' });
+    if (!config.forceStopMarketplaceAppsPrompt) {
+        if (!(await cli_utilities_1.cliux.confirm(chalk_1.default.yellow('WARNING!!! The above error may have an impact if the failed app is referenced in entries/content type. Would you like to proceed? (y/n)')))) {
+            process.exit();
+        }
+    }
+};
+exports.confirmToCloseProcess = confirmToCloseProcess;
+const ifAppAlreadyExist = async (app, currentStackApp, config) => {
+    let updateParam = {};
+    const { manifest: { name }, configuration, server_configuration, } = app;
+    if (!(0, isEmpty_1.default)(configuration) || !(0, isEmpty_1.default)(server_configuration)) {
+        cli_utilities_1.cliux.print(`\nWARNING!!! The ${name} app already exists and it may have its own configuration. But the current app you install has its own configuration which is used internally to manage content.\n`, { color: 'yellow' });
+        const configOption = config.forceStopMarketplaceAppsPrompt
+            ? 'Update it with the new configuration.'
+            : await (0, interactive_2.selectConfiguration)();
+        if (configOption === 'Exit') {
+            process.exit();
+        }
+        else if (configOption === 'Update it with the new configuration.') {
+            updateParam = Object.assign(Object.assign({ manifest: app.manifest }, currentStackApp), { configuration, server_configuration });
+        }
+    }
+    return updateParam;
+};
+exports.ifAppAlreadyExist = ifAppAlreadyExist;
+const updateAppConfig = async (client, config, app, payload) => {
+    var _a;
+    let installation = client.organization(config.org_uid).app((_a = app === null || app === void 0 ? void 0 : app.manifest) === null || _a === void 0 ? void 0 : _a.uid).installation(app === null || app === void 0 ? void 0 : app.uid);
+    installation = Object.assign(installation, payload);
+    return await installation
+        .update()
+        .then((data) => {
+        var _a;
+        (0, logger_1.log)(config, `${(_a = app === null || app === void 0 ? void 0 : app.manifest) === null || _a === void 0 ? void 0 : _a.name} app config updated successfully.!`, 'success');
+    })
+        .catch((error) => (0, logger_1.log)(config, `Failed to update app config.${(0, utils_1.formatError)(error)}`, 'error'));
+};
+exports.updateAppConfig = updateAppConfig;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.6.0",
+  "version": "1.7.1",
   "commands": {
     "cm:stacks:import": {
       "id": "cm:stacks:import",

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@contentstack/cli-cm-import",
   "description": "Contentstack CLI plugin to import content into stack",
-  "version": "1.6.0",
+  "version": "1.7.1",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "^1.2.0",
-    "@contentstack/cli-utilities": "^1.5.0",
-    "@contentstack/management": "^1.8.0",
+    "@contentstack/cli-command": "^1.2.11",
+    "@contentstack/cli-utilities": "^1.5.1",
+    "@contentstack/management":  "~1.10.0",
     "@oclif/config": "^1.18.3",
-    "@oclif/core": "^2.3.0",
+    "@oclif/core": "^2.9.3",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",
     "chalk": "^4.1.2",
@@ -96,4 +96,4 @@
     }
   },
   "repository": "https://github.com/contentstack/cli"
-}
+}