@contentstack/cli-cm-import 1.12.0 → 1.12.2

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.12.0 linux-x64 node-v18.18.2
+@contentstack/cli-cm-import/1.12.2 linux-x64 node-v18.19.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -82,6 +82,7 @@ FLAGS
   --import-webhook-status=<option>  [default: disable] [optional] Webhook state
                                     <options: disable|current>
   --replace-existing                Replaces the existing module in the target stack.
+  --skip-app-recreation             [optional] Skip private apps recreation if already exist
   --skip-existing                   Skips the module exists warning messages.
 
 DESCRIPTION
@@ -129,6 +130,7 @@ FLAGS
   --import-webhook-status=<option>  [default: disable] [optional] Webhook state
                                     <options: disable|current>
   --replace-existing                Replaces the existing module in the target stack.
+  --skip-app-recreation             [optional] Skip private apps recreation if already exist
   --skip-existing                   Skips the module exists warning messages.
 
 DESCRIPTION

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

@@ -4,7 +4,6 @@ const tslib_1 = require("tslib");
 const node_path_1 = tslib_1.__importDefault(require("node:path"));
 const cli_command_1 = require("@contentstack/cli-command");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
-const log_1 = require("../../../utils/log");
 const import_1 = require("../../../import");
 const utils_1 = require("../../../utils");
 class ImportCommand extends cli_command_1.Command {
@@ -26,7 +25,6 @@ class ImportCommand extends cli_command_1.Command {
             (0, utils_1.log)(importConfig, `The log has been stored at '${node_path_1.default.join(importConfig.backupDir, 'logs', 'import')}'`, 'success');
         }
         catch (error) {
-            (0, log_1.trace)(error, 'error', true);
             (0, utils_1.log)({ data: backupDir }, `Failed to import stack content - ${(0, utils_1.formatError)(error)}`, 'error');
             (0, utils_1.log)({ data: backupDir }, `The log has been stored at ${{ data: backupDir } ? node_path_1.default.join(backupDir || __dirname, 'logs', 'import') : node_path_1.default.join(__dirname, 'logs')}`, 'info');
         }
@@ -110,6 +108,9 @@ ImportCommand.flags = {
         required: false,
         description: '[optional] Override marketplace prompts',
     }),
+    'skip-app-recreation': cli_utilities_1.flags.boolean({
+        description: '[optional] Skip private apps recreation if already exist',
+    }),
     'replace-existing': cli_utilities_1.flags.boolean({
         required: false,
         description: 'Replaces the existing module in the target stack.',

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

@@ -63,7 +63,7 @@ export default class EntriesImport extends BaseClass {
         cTUid: string;
         locale: string;
     }): Promise<void>;
-    replaceEntriesHandler({ apiParams, element: entry, isLastRequest, }: {
+    replaceEntriesHandler({ apiParams, element: entry }: {
         apiParams: ApiOptions;
         element: Record<string, string>;
         isLastRequest: boolean;

package/lib/import/modules/entries.js

@@ -39,6 +39,7 @@ class EntriesImport extends base_class_1.default {
         this.failedEntries = [];
     }
     async start() {
+        var _a;
         try {
             this.cTs = utils_1.fsUtil.readFile(path.join(this.cTsPath, 'schema.json'));
             if (!this.cTs || (0, lodash_1.isEmpty)(this.cTs)) {
@@ -68,7 +69,7 @@ class EntriesImport extends base_class_1.default {
             }
             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) {
+            if (((_a = this.autoCreatedEntries) === null || _a === void 0 ? void 0 : _a.length) > 0) {
                 (0, utils_1.log)(this.importConfig, 'Removing entries from master language which got created by default', 'info');
                 await this.removeAutoCreatedEntries().catch((error) => {
                     (0, utils_1.log)(this.importConfig, `Error while removing auto created entries in master locale ${(0, utils_1.formatError)(error)}`, 'error');
@@ -409,7 +410,7 @@ class EntriesImport extends base_class_1.default {
             }
         }
     }
-    async replaceEntriesHandler({ apiParams, element: entry, isLastRequest, }) {
+    async replaceEntriesHandler({ apiParams, element: entry }) {
         const { additionalInfo: { cTUid, locale } = {} } = apiParams;
         return new Promise(async (resolve, reject) => {
             const { items: [entryInStack] = [] } = (await this.stack
@@ -538,6 +539,7 @@ class EntriesImport extends base_class_1.default {
             if (this.jsonRteCTs.indexOf(cTUid) > -1) {
                 // the entries stored in eSuccessFilePath, have the same uids as the entries from source data
                 entry = (0, utils_1.restoreJsonRteEntryRefs)(entry, sourceEntry, contentType.schema, {
+                    uidMapper: this.entriesUidMapper,
                     mappedAssetUids: this.assetUidMapper,
                     mappedAssetUrls: this.assetUrlMapper,
                 });
@@ -618,6 +620,7 @@ class EntriesImport extends base_class_1.default {
         });
     }
     async updateFieldRules() {
+        var _a, _b, _c;
         let cTsWithFieldRules = utils_1.fsUtil.readFile(path.join(this.cTsPath + '/field_rules_uid.json'));
         if (!cTsWithFieldRules || (cTsWithFieldRules === null || cTsWithFieldRules === void 0 ? void 0 : cTsWithFieldRules.length) === 0) {
             return;
@@ -627,13 +630,13 @@ class EntriesImport extends base_class_1.default {
             const contentType = (0, lodash_1.find)(cTs, { uid: cTUid });
             if (contentType.field_rules) {
                 const fieldDatatypeMap = {};
-                for (let i = 0; i < contentType.schema.length; i++) {
+                for (let i = 0; i < ((_a = contentType.schema) === null || _a === void 0 ? void 0 : _a.length); i++) {
                     const field = contentType.schema[i].uid;
                     fieldDatatypeMap[field] = contentType.schema[i].data_type;
                 }
-                let fieldRuleLength = contentType.field_rules.length;
+                let fieldRuleLength = (_b = contentType.field_rules) === null || _b === void 0 ? void 0 : _b.length;
                 for (let k = 0; k < fieldRuleLength; k++) {
-                    let fieldRuleConditionLength = contentType.field_rules[k].conditions.length;
+                    let fieldRuleConditionLength = (_c = contentType.field_rules[k].conditions) === null || _c === void 0 ? void 0 : _c.length;
                     for (let i = 0; i < fieldRuleConditionLength; i++) {
                         if (fieldDatatypeMap[contentType.field_rules[k].conditions[i].operand_field] === 'reference') {
                             let fieldRulesValue = contentType.field_rules[k].conditions[i].value;
@@ -723,13 +726,14 @@ class EntriesImport extends base_class_1.default {
      * @returns {ApiOptions} ApiOptions
      */
     serializePublishEntries(apiOptions) {
+        var _a;
         let { apiData: entry, additionalInfo } = apiOptions;
         const requestObject = {
             environments: [],
             locales: [],
             entryUid: this.entriesUidMapper[entry.uid],
         };
-        if (entry.publish_details && entry.publish_details.length > 0) {
+        if (entry.publish_details && ((_a = entry.publish_details) === null || _a === void 0 ? void 0 : _a.length) > 0) {
             (0, lodash_1.forEach)(entry.publish_details, (pubObject) => {
                 if (this.envs.hasOwnProperty(pubObject.environment) &&
                     (0, lodash_1.indexOf)(requestObject.environments, this.envs[pubObject.environment].name) === -1) {

package/lib/import/modules/index.js

@@ -1,18 +1,31 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const cli_utilities_1 = require("@contentstack/cli-utilities");
-const node_path_1 = require("node:path");
-const modules_js_1 = tslib_1.__importDefault(require("../modules-js"));
 async function startModuleImport(modulePayload) {
-    var _a;
-    // Todo: Remove below code when auto detect mechanism implemented for old and new module
-    if (modulePayload.moduleName === 'assets' &&
-        !new cli_utilities_1.FsUtility({ basePath: (0, node_path_1.join)((_a = modulePayload.importConfig) === null || _a === void 0 ? void 0 : _a.backupDir, 'assets') }).isNewFsStructure) {
-        return (0, modules_js_1.default)(modulePayload);
-    }
-    const { default: ModuleRunner } = await (_a = `./${modulePayload.moduleName}`, Promise.resolve().then(() => tslib_1.__importStar(require(_a))));
+    const { default: ModuleRunner } = await (_a = `./${modulePayload.moduleName}`, Promise.resolve().then(() => __importStar(require(_a))));
     const moduleRunner = new ModuleRunner(modulePayload);
     return moduleRunner.start();
 }

package/lib/import/modules/marketplace-apps.d.ts

@@ -1,43 +1,113 @@
-import { NodeCrypto, ContentstackClient } from '@contentstack/cli-utilities';
-import BaseClass from './base-class';
-import { ModuleClassParams } from '../../types';
-export default class ImportMarketplaceApps extends BaseClass {
+import { NodeCrypto, ContentstackMarketplaceClient } from '@contentstack/cli-utilities';
+import { ModuleClassParams, ImportConfig, Installation, Manifest } from '../../types';
+export default class ImportMarketplaceApps {
+    importConfig: ImportConfig;
     private mapperDirPath;
     private marketPlaceFolderPath;
     private marketPlaceUidMapperPath;
     private marketPlaceAppConfig;
     private marketplaceApps;
-    private httpClient;
     private appNameMapping;
     private appUidMapping;
     private installationUidMapping;
     private installedApps;
     private appOriginalName;
     developerHubBaseUrl: string;
-    sdkClient: ContentstackClient;
     nodeCrypto: NodeCrypto;
-    appSdkAxiosInstance: any;
-    constructor({ importConfig, stackAPIClient }: ModuleClassParams);
+    appSdk: ContentstackMarketplaceClient;
+    constructor({ importConfig }: ModuleClassParams);
     /**
-     * @method start
-     * @returns {Promise<void>} Promise<void>
+     * This function starts the process of importing marketplace apps.
+     * @returns The function `start()` returns a `Promise<void>`.
      */
     start(): Promise<void>;
-    setHttpClient(): Promise<void>;
     /**
-     * @method startInstallation
-     * @returns {Promise<void>}
+     * The function `importMarketplaceApps` installs marketplace apps, handles private app creation,
+     * validates app installation, and generates a UID mapper.
+     */
+    importMarketplaceApps(): Promise<void>;
+    /**
+     * The function `generateUidMapper` generates a mapping of extension UIDs from old metadata to new
+     * metadata based on the installed and marketplace apps.
+     * @returns The function `generateUidMapper` returns a Promise that resolves to a `Record<string,
+     * unknown>`.
      */
-    startInstallation(): Promise<void>;
     generateUidMapper(): Promise<Record<string, unknown>>;
+    /**
+     * The function `getAndValidateEncryptionKey` retrieves and validates an encryption key, with the
+     * option to retry a specified number of times.
+     * @param {string} defaultValue - The defaultValue parameter is a string that represents the default
+     * encryption key value to use if no valid encryption key is found in the marketplaceApps
+     * configuration.
+     * @param [retry=1] - The `retry` parameter is an optional parameter that specifies the number of
+     * times the function should retry getting and validating the encryption key if it fails. The default
+     * value is 1, meaning that if the function fails to get and validate the encryption key on the first
+     * attempt, it will not retry.
+     * @returns The function `getAndValidateEncryptionKey` returns a Promise that resolves to the
+     * encryption key.
+     */
     getAndValidateEncryptionKey(defaultValue: string, retry?: number): Promise<any>;
     /**
-     * @method handleAllPrivateAppsCreationProcess
-     * @returns {Promise<void>}
+     * The function `handleAllPrivateAppsCreationProcess` handles the creation process for all private
+     * apps in a developer hub, including checking for existing apps, getting confirmation from the user,
+     * and creating the apps if necessary.
+     * @returns a Promise that resolves to void.
      */
     handleAllPrivateAppsCreationProcess(): Promise<void>;
-    createPrivateApps(app: any, uidCleaned?: boolean, appSuffix?: number): Promise<any>;
-    updateManifestUILocations(locations: any, type?: string, appSuffix?: number): Promise<any[]>;
+    /**
+     * The function checks if a private app exists in the developer hub.
+     * @param {App} app - The `app` parameter is an object representing an application. It likely has
+     * properties such as `uid` which is a unique identifier for the app.
+     * @returns a boolean value. It returns true if the installation object is not empty, and false if
+     * the installation object is empty.
+     */
+    isPrivateAppExistInDeveloperHub(app: Installation): Promise<boolean>;
+    /**
+     * The function creates a private app in a marketplace, with an optional suffix for the app name and
+     * an option to update the UI location.
+     * @param {Manifest} app - The `app` parameter is an object that represents the manifest of the app
+     * being created. It contains various properties such as `name`, `ui_location`, and `uid`.
+     * @param [appSuffix=1] - The appSuffix parameter is an optional parameter that specifies a suffix to
+     * be added to the app's UI location. It is used when updating the UI location of the app.
+     * @param [updateUiLocation=false] - A boolean value indicating whether to update the UI location of
+     * the app.
+     * @returns the result of the `appCreationCallback` function, which takes in the `app`, `response`,
+     * and `appSuffix` as arguments.
+     */
+    createPrivateApp(app: Manifest, appSuffix?: number, updateUiLocation?: boolean): Promise<any>;
+    /**
+     * The function installs an app from a marketplace onto a target stack.
+     * @param {ImportConfig} config - The `config` parameter is an object that contains the configuration
+     * for the installation. It likely includes information such as the target stack UID and other
+     * relevant details.
+     * @param {string} [appManifestUid] - The `appManifestUid` parameter is the unique identifier of the
+     * app manifest. It is used to specify which app to install from the marketplace.
+     * @returns a Promise that resolves to an object.
+     */
+    installApp(config: ImportConfig, appManifestUid?: string): Promise<any>;
+    /**
+     * The function updates the names of locations in a manifest UI based on a given app suffix.
+     * @param {any} locations - An array of objects representing different locations in a manifest file.
+     * Each object has a "meta" property which is an array of objects representing metadata for that
+     * location.
+     * @param [appSuffix=1] - The `appSuffix` parameter is an optional parameter that specifies a suffix
+     * to be added to the app name. It is set to 1 by default.
+     * @returns The function `updateManifestUILocations` returns an updated array of `locations`.
+     */
+    updateManifestUILocations(locations: any, appSuffix?: number): any[];
+    /**
+     * The function `appCreationCallback` handles the creation of a new app and handles any conflicts or
+     * errors that may occur during the process.
+     * @param {any} app - The `app` parameter is an object representing the app that is being created. It
+     * contains various properties such as `uid` (unique identifier), `name`, and other app-specific
+     * details.
+     * @param {any} response - The `response` parameter is an object that contains the response received
+     * from an API call. It may have properties such as `statusText` and `message`.
+     * @param {number} appSuffix - The `appSuffix` parameter is a number that is used to generate a
+     * unique suffix for the app name in case of a name conflict. It is incremented each time a name
+     * conflict occurs to ensure that the new app name is unique.
+     * @returns a Promise.
+     */
     appCreationCallback(app: any, response: any, appSuffix: number): Promise<any>;
     /**
      * @method installApps
@@ -48,8 +118,10 @@ export default class ImportMarketplaceApps extends BaseClass {
      */
     installApps(app: any): Promise<void>;
     /**
-     * @method updateAppsConfig
-     * @returns {Promise<void>}
+     * The `updateAppsConfig` function updates the configuration and server configuration of an app in a
+     * marketplace.
+     * @param {Installation} app - The `app` parameter is an object that represents an installation of an
+     * app. It contains the following properties:
      */
-    updateAppsConfig(app: any): Promise<void>;
+    updateAppsConfig(app: Installation): Promise<void>;
 }