@contentstack/cli-cm-export 1.8.2 → 1.9.0

package/README.md

@@ -48,7 +48,7 @@ $ npm install -g @contentstack/cli-cm-export
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-export/1.8.2 linux-x64 node-v18.17.1
+@contentstack/cli-cm-export/1.9.0 linux-x64 node-v18.18.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

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

@@ -18,7 +18,9 @@ class ExportCommand extends cli_command_1.Command {
             const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)(exportConfig);
             const moduleExporter = new export_1.ModuleExporter(managementAPIClient, exportConfig);
             await moduleExporter.start();
+            (0, utils_1.writeExportMetaFile)(exportConfig);
             (0, utils_1.log)(exportConfig, `The content of the stack ${exportConfig.apiKey} has been exported successfully!`, 'success');
+            (0, utils_1.log)(exportConfig, `The log has been stored at '${path_1.default.join(exportDir, 'logs', 'export')}'`, 'success');
         }
         catch (error) {
             (0, utils_1.log)({ data: exportDir }, `Failed to export stack content - ${(0, utils_1.formatError)(error)}`, 'error');

package/lib/config/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const config = {
+    contentVersion: 2,
     versioning: false,
     host: 'https://api.contentstack.io/v3',
     developerHubUrls: {
@@ -96,8 +97,8 @@ const config = {
             invalidKeys: ['created_at', 'updated_at', 'created_by', 'updated_by', '_metadata', 'published'],
             // no of asset version files (of a single asset) that'll be downloaded parallel
             chunkFileSize: 1,
-            downloadLimit: 10,
-            fetchConcurrency: 10,
+            downloadLimit: 5,
+            fetchConcurrency: 5,
             assetsMetaKeys: [],
             securedAssets: false,
             displayExecutionTime: false,
@@ -369,20 +370,6 @@ const config = {
         'xh',
         'zu',
     ],
-    updatedModules: [
-        'assets',
-        'locales',
-        'extensions',
-        'marketplace-apps',
-        'labels',
-        'webhooks',
-        'custom-roles',
-        'global-fields',
-        'content-types',
-        'entries',
-        'workflows',
-        'stack',
-    ],
     apis: {
         userSession: '/user-session/',
         globalfields: '/global_fields/',
@@ -402,6 +389,5 @@ const config = {
     writeConcurrency: 5,
     developerHubBaseUrl: '',
     marketplaceAppEncryptionKey: 'nF2ejRQcTv',
-    useNewModuleStructure: false,
 };
 exports.default = config;

package/lib/export/module-exporter.js

@@ -41,6 +41,7 @@ class ModuleExporter {
         }
     }
     async export() {
+        (0, utils_1.log)(this.exportConfig, `Started to export content, version is ${this.exportConfig.contentVersion}`, 'info');
         // checks for single module or all modules
         if (this.exportConfig.singleModuleExport) {
             return this.exportSingleModule(this.exportConfig.moduleName);
@@ -52,7 +53,7 @@ class ModuleExporter {
         // export the modules by name
         // calls the module runner which inturn calls the module itself
         let exportedModuleResponse;
-        if (this.exportConfig.useNewModuleStructure && this.exportConfig.updatedModules.indexOf(moduleName) !== -1) {
+        if (this.exportConfig.contentVersion === 2) {
             exportedModuleResponse = await (0, modules_1.default)({
                 stackAPIClient: this.stackAPIClient,
                 exportConfig: this.exportConfig,

package/lib/export/modules/custom-roles.js

@@ -6,14 +6,13 @@ const find_1 = tslib_1.__importDefault(require("lodash/find"));
 const forEach_1 = tslib_1.__importDefault(require("lodash/forEach"));
 const values_1 = tslib_1.__importDefault(require("lodash/values"));
 const node_path_1 = require("node:path");
-const config_1 = tslib_1.__importDefault(require("../../config"));
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
 const utils_1 = require("../../utils");
 class ExportCustomRoles extends base_class_1.default {
     constructor({ exportConfig, stackAPIClient }) {
         super({ exportConfig, stackAPIClient });
         this.customRoles = {};
-        this.customRolesConfig = config_1.default.modules.customRoles;
+        this.customRolesConfig = exportConfig.modules.customRoles;
         this.existingRoles = { Admin: 1, Developer: 1, 'Content Manager': 1 };
         this.localesMap = {};
         this.sourceLocalesMap = {};

package/lib/export/modules/entries.js

@@ -27,7 +27,11 @@ class EntriesExport extends base_class_1.default {
             }
             const entryRequestOptions = this.createRequestObjects(locales, contentTypes);
             for (let entryRequestOption of entryRequestOptions) {
-                (0, utils_1.log)(this.exportConfig, `Starting export of entries of content type - ${entryRequestOption.contentType} locale - ${entryRequestOption.locale}`, 'info');
+                // log(
+                //   this.exportConfig,
+                //   `Starting export of entries of content type - ${entryRequestOption.contentType} locale - ${entryRequestOption.locale}`,
+                //   'info',
+                // );
                 await this.getEntries(entryRequestOption);
                 (_a = this.entriesFileHelper) === null || _a === void 0 ? void 0 : _a.completeFile(true);
                 (0, utils_1.log)(this.exportConfig, `Exported entries of type '${entryRequestOption.contentType}' locale '${entryRequestOption.locale}'`, 'success');

package/lib/export/modules/environments.js

@@ -4,14 +4,13 @@ const tslib_1 = require("tslib");
 const node_path_1 = require("node:path");
 const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
-const config_1 = tslib_1.__importDefault(require("../../config"));
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
 const utils_1 = require("../../utils");
 class ExportEnvironments extends base_class_1.default {
     constructor({ exportConfig, stackAPIClient }) {
         super({ exportConfig, stackAPIClient });
         this.environments = {};
-        this.environmentConfig = config_1.default.modules.environments;
+        this.environmentConfig = exportConfig.modules.environments;
         this.qs = { include_count: true };
     }
     async start() {

package/lib/export/modules/extensions.js

@@ -4,14 +4,13 @@ const tslib_1 = require("tslib");
 const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const node_path_1 = require("node:path");
-const config_1 = tslib_1.__importDefault(require("../../config"));
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
 const utils_1 = require("../../utils");
 class ExportExtensions extends base_class_1.default {
     constructor({ exportConfig, stackAPIClient }) {
         super({ exportConfig, stackAPIClient });
         this.extensions = {};
-        this.extensionConfig = config_1.default.modules.extensions;
+        this.extensionConfig = exportConfig.modules.extensions;
         this.qs = { include_count: true };
     }
     async start() {

package/lib/export/modules/labels.js

@@ -4,14 +4,13 @@ const tslib_1 = require("tslib");
 const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const node_path_1 = require("node:path");
-const config_1 = tslib_1.__importDefault(require("../../config"));
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
 const utils_1 = require("../../utils");
 class ExportLabels extends base_class_1.default {
     constructor({ exportConfig, stackAPIClient }) {
         super({ exportConfig, stackAPIClient });
         this.labels = {};
-        this.labelConfig = config_1.default.modules.labels;
+        this.labelConfig = exportConfig.modules.labels;
         this.qs = { include_count: true };
     }
     async start() {

package/lib/export/modules/marketplace-apps.js

@@ -8,14 +8,13 @@ const entries_1 = tslib_1.__importDefault(require("lodash/entries"));
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const node_path_1 = require("node:path");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
-const config_1 = tslib_1.__importDefault(require("../../config"));
 const utils_1 = require("../../utils");
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
 class ExportMarketplaceApps extends base_class_1.default {
     constructor({ exportConfig, stackAPIClient }) {
         super({ exportConfig, stackAPIClient });
         this.httpClient = new cli_utilities_1.HttpClient();
-        this.marketplaceAppConfig = config_1.default.modules.marketplace_apps;
+        this.marketplaceAppConfig = exportConfig.modules.marketplace_apps;
         this.listOfApps = [];
         this.installedApps = [];
     }

package/lib/export/modules/stack.js

@@ -4,13 +4,12 @@ const tslib_1 = require("tslib");
 const find_1 = tslib_1.__importDefault(require("lodash/find"));
 const node_path_1 = require("node:path");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
-const config_1 = tslib_1.__importDefault(require("../../config"));
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
 const utils_1 = require("../../utils");
 class ExportStack extends base_class_1.default {
     constructor({ exportConfig, stackAPIClient }) {
         super({ exportConfig, stackAPIClient });
-        this.stackConfig = config_1.default.modules.stack;
+        this.stackConfig = exportConfig.modules.stack;
         this.qs = { include_count: true };
         this.stackFolderPath = (0, node_path_1.resolve)(this.exportConfig.data, this.stackConfig.dirName);
     }
@@ -35,9 +34,7 @@ class ExportStack extends base_class_1.default {
         return await tempAPIClient
             .stack({ api_key: this.exportConfig.source_stack })
             .fetch()
-            .catch((error) => {
-            (0, utils_1.log)(this.exportConfig, `Failed to export stack. ${(0, utils_1.formatError)(error)}`, 'error');
-        });
+            .catch((error) => { });
     }
     async getLocales(skip = 0) {
         if (skip) {

package/lib/export/modules/webhooks.js

@@ -4,14 +4,13 @@ const tslib_1 = require("tslib");
 const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const node_path_1 = require("node:path");
-const config_1 = tslib_1.__importDefault(require("../../config"));
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
 const utils_1 = require("../../utils");
 class ExportWebhooks extends base_class_1.default {
     constructor({ exportConfig, stackAPIClient }) {
         super({ exportConfig, stackAPIClient });
         this.webhooks = {};
-        this.webhookConfig = config_1.default.modules.webhooks;
+        this.webhookConfig = exportConfig.modules.webhooks;
         this.qs = { include_count: true, asc: 'updated_at' };
     }
     async start() {

package/lib/export/modules/workflows.js

@@ -4,14 +4,13 @@ const tslib_1 = require("tslib");
 const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
 const node_path_1 = require("node:path");
-const config_1 = tslib_1.__importDefault(require("../../config"));
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
 const utils_1 = require("../../utils");
 class ExportWorkFlows extends base_class_1.default {
     constructor({ exportConfig, stackAPIClient }) {
         super({ exportConfig, stackAPIClient });
         this.workflows = {};
-        this.workflowConfig = config_1.default.modules.workflows;
+        this.workflowConfig = exportConfig.modules.workflows;
         this.qs = { include_count: true };
     }
     async start() {
@@ -36,10 +35,12 @@ class ExportWorkFlows extends base_class_1.default {
             .fetchAll(this.qs)
             .then(async (data) => {
             const { items, count } = data;
+            //NOTE - Handle the case where old workflow api is enabled in that case getting responses as objects.
+            const workflowCount = count !== undefined ? count : items.length;
             if (items === null || items === void 0 ? void 0 : items.length) {
                 await this.sanitizeAttribs(items);
                 skip += this.workflowConfig.limit || 100;
-                if (skip >= count) {
+                if (skip >= workflowCount) {
                     return;
                 }
                 return await this.getWorkflows(skip);

package/lib/export/modules-js/marketplace-apps.d.ts

@@ -13,6 +13,7 @@ declare class ExportMarketplaceApps {
         dependencies?: import("../../types").Modules[];
     };
     start(): Promise<void>;
+    appSdkAxiosInstance: any;
     getOrgUid(): Promise<void>;
     exportInstalledExtensions(): Promise<void>;
     getAllStackSpecificApps(listOfApps?: any[], skip?: number): any;

package/lib/export/modules-js/marketplace-apps.js

@@ -25,6 +25,9 @@ module.exports = class ExportMarketplaceApps {
             return Promise.resolve();
         }
         this.developerHubBaseUrl = this.config.developerHubBaseUrl || (await getDeveloperHubUrl(this.config));
+        this.appSdkAxiosInstance = await managementSDKClient({
+            host: this.developerHubBaseUrl.split('://').pop()
+        });
         await this.getOrgUid();
         const httpClient = new HttpClient();
         if (!this.config.auth_token) {
@@ -70,8 +73,12 @@ module.exports = class ExportMarketplaceApps {
         }
     }
     getAllStackSpecificApps(listOfApps = [], skip = 0) {
-        return this.httpClient
-            .get(`${this.developerHubBaseUrl}/installations?target_uids=${this.config.source_stack}&skip=${skip}`)
+        return this.appSdkAxiosInstance.axiosInstance
+            .get(`/installations?target_uids=${this.config.source_stack}&skip=${skip}`, {
+            headers: {
+                organization_uid: this.config.org_uid
+            },
+        })
             .then(async ({ data }) => {
             const { data: apps, count } = data;
             if (!this.nodeCrypto && _.find(apps, (app) => !_.isEmpty(app.configuration))) {
@@ -118,7 +125,7 @@ module.exports = class ExportMarketplaceApps {
                 log(this.config, `Error on exporting ${appName} app and it's config.`, 'error');
             }
         })
-            .catch(err => {
+            .catch((err) => {
             log(this.config, `Failed to export ${appName} app config ${formatError(err)}`, 'error');
         });
     }

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

@@ -1,5 +1,6 @@
 import { Modules } from '.';
 export default interface DefaultConfig {
+    contentVersion: number;
     versioning: boolean;
     host: string;
     cdn?: string;
@@ -135,7 +136,6 @@ export default interface DefaultConfig {
         };
     };
     languagesCode: string[];
-    updatedModules: string[];
     apis: {
         userSession: string;
         globalfields: string;
@@ -155,5 +155,4 @@ export default interface DefaultConfig {
     writeConcurrency: number;
     developerHubBaseUrl: string;
     marketplaceAppEncryptionKey: string;
-    useNewModuleStructure: boolean;
 }

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

@@ -3,9 +3,10 @@
  * Copyright (c) 2019 Contentstack LLC
  * MIT Licensed
  */
-import { ExternalConfig } from '../types';
+import { ExternalConfig, ExportConfig } from '../types';
 export declare const validateConfig: (config: ExternalConfig) => void;
 export declare const formatError: (error: any) => any;
 export declare const executeTask: (tasks: unknown[], handler: (task: unknown) => Promise<unknown>, options: {
     concurrency: number;
 }) => Promise<unknown[]>;
+export declare const writeExportMetaFile: (exportConfig: ExportConfig) => void;

package/lib/utils/common-helper.js

@@ -5,10 +5,12 @@
  * MIT Licensed
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.executeTask = exports.formatError = exports.validateConfig = void 0;
+exports.writeExportMetaFile = exports.executeTask = exports.formatError = exports.validateConfig = void 0;
 const tslib_1 = require("tslib");
 const promise_limit_1 = tslib_1.__importDefault(require("promise-limit"));
+const path = tslib_1.__importStar(require("path"));
 const cli_utilities_1 = require("@contentstack/cli-utilities");
+const file_helper_1 = require("./file-helper");
 const validateConfig = function (config) {
     if (!config.host || !config.cdn) {
         throw new Error('Host/CDN end point is missing from config');
@@ -76,3 +78,12 @@ const executeTask = function (tasks = [], handler, options) {
     }));
 };
 exports.executeTask = executeTask;
+// Note: we can add more useful details in meta file
+const writeExportMetaFile = (exportConfig) => {
+    const exportMeta = {
+        contentVersion: exportConfig.contentVersion,
+        logsPath: path.join(exportConfig.exportDir, 'logs', 'export'),
+    };
+    file_helper_1.fsUtil.writeFile(path.join(exportConfig.exportDir, exportConfig.branchName || '', 'export-info.json'), exportMeta);
+};
+exports.writeExportMetaFile = writeExportMetaFile;

package/lib/utils/logger.js

@@ -122,14 +122,14 @@ function init(_logPath) {
     };
 }
 const log = async (config, message, type) => {
-    config.data = config.data || path.join(__dirname, 'logs');
+    const logsPath = config.data || __dirname;
     // ignoring the type argument, as we are not using it to create a logfile anymore
     if (type !== 'error') {
         // removed type argument from init method
-        init(config.data).log(message);
+        init(logsPath).log(message);
     }
     else {
-        init(config.data).error(message);
+        init(logsPath).error(message);
     }
 };
 exports.log = log;

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

@@ -19,7 +19,7 @@ async function getOrgUid(config) {
         .stack({ api_key: config.source_stack })
         .fetch()
         .catch((error) => {
-        (0, utils_1.log)(this.config, (0, utils_1.formatError)(error), 'error');
+        (0, utils_1.log)(config, (0, utils_1.formatError)(error), 'error');
     });
     return tempStackData === null || tempStackData === void 0 ? void 0 : tempStackData.org_uid;
 }
@@ -47,8 +47,15 @@ async function createNodeCryptoInstance(config) {
 exports.createNodeCryptoInstance = createNodeCryptoInstance;
 const getStackSpecificApps = async (params) => {
     const { developerHubBaseUrl, httpClient, config, skip } = params;
-    return httpClient
-        .get(`${developerHubBaseUrl}/installations?target_uids=${config.source_stack}&skip=${skip}`)
+    const appSdkAxiosInstance = await (0, cli_utilities_1.managementSDKClient)({
+        host: developerHubBaseUrl.split('://').pop()
+    });
+    return appSdkAxiosInstance.axiosInstance
+        .get(`${developerHubBaseUrl}/installations?target_uids=${config.source_stack}&skip=${skip}`, {
+        headers: {
+            organization_uid: config.org_uid,
+        },
+    })
         .then((data) => data.data)
         .catch((error) => (0, utils_1.log)(config, `Failed to export marketplace-apps ${(0, utils_1.formatError)(error)}`, 'error'));
 };

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.8.2",
+  "version": "1.9.0",
   "commands": {
     "cm:stacks:export": {
       "id": "cm:stacks:export",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-cm-export",
   "description": "Contentstack CLI plugin to export content from stack",
-  "version": "1.8.2",
+  "version": "1.9.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
@@ -29,9 +29,9 @@
     "@contentstack/cli-dev-dependencies": "~1.2.3",
     "@oclif/plugin-help": "^5.1.19",
     "@oclif/test": "^1.2.6",
+    "@types/big-json": "^3.2.0",
     "@types/mkdirp": "^1.0.2",
     "@types/progress-stream": "^2.0.2",
-    "@types/mkdirp": "^1.0.2",
     "assert": "^2.0.0",
     "chai": "^4.2.0",
     "dotenv": "^16.0.1",
@@ -98,4 +98,4 @@
     }
   },
   "repository": "https://github.com/contentstack/cli"
-}
+}