@contentstack/cli-cm-export 1.5.8 → 1.6.1

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.5.8 linux-x64 node-v16.20.0
+@contentstack/cli-cm-export/1.6.1 linux-x64 node-v18.16.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -146,5 +146,5 @@ EXAMPLES
   $ csdx cm:stacks:export --branch [optional] branch name
 ```
 
-_See code: [src/commands/cm/stacks/export.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/stacks/export.js)_
+_See code: [src/commands/cm/stacks/export.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/stacks/export.ts)_
 <!-- commandsstop -->

package/lib/commands/cm/stacks/export.d.ts

@@ -0,0 +1,10 @@
+import { Command } from '@contentstack/cli-command';
+import { FlagInput } from '@contentstack/cli-utilities';
+export default class ExportCommand extends Command {
+    static description: string;
+    static examples: string[];
+    static usage: string;
+    static flags: FlagInput;
+    static aliases: string[];
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const cli_command_1 = require("@contentstack/cli-command");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const export_1 = require("../../../export");
+const utils_1 = require("../../../utils");
+class ExportCommand extends cli_command_1.Command {
+    async run() {
+        let exportDir;
+        try {
+            const { flags } = await this.parse(ExportCommand);
+            let exportConfig = await (0, utils_1.setupExportConfig)(flags);
+            // Note setting host to create cma client
+            exportConfig.host = this.cmaHost;
+            exportDir = exportConfig.data || exportConfig.exportDir;
+            const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)(exportConfig);
+            const moduleExporter = new export_1.ModuleExporter(managementAPIClient, exportConfig);
+            await moduleExporter.start();
+            (0, utils_1.log)(exportConfig, `The content of the stack ${exportConfig.apiKey} has been exported successfully!`, 'success');
+        }
+        catch (error) {
+            (0, utils_1.log)({ data: exportDir }, `Failed to export stack content - ${(0, utils_1.formatError)(error)}`, 'error');
+            (0, utils_1.log)({ data: exportDir }, `The log has been stored at ${exportDir ? path_1.default.join(exportDir, 'logs', 'export') : path_1.default.join(__dirname, 'logs')}`, 'info');
+        }
+    }
+}
+exports.default = ExportCommand;
+ExportCommand.description = cli_utilities_1.messageHandler.parse('Export content from a stack');
+ExportCommand.examples = [
+    'csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>',
+    'csdx cm:stacks:export --config <path/to/config/dir>',
+    'csdx cm:stacks:export --alias <management_token_alias>',
+    'csdx cm:stacks:export --alias <management_token_alias> --data-dir <path/to/export/destination/dir>',
+    'csdx cm:stacks:export --alias <management_token_alias> --config <path/to/config/file>',
+    'csdx cm:stacks:export --module <single module name>',
+    'csdx cm:stacks:export --branch [optional] branch name',
+];
+ExportCommand.usage = 'cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]';
+ExportCommand.flags = {
+    config: cli_utilities_1.flags.string({
+        char: 'c',
+        description: '[optional] path of the config',
+    }),
+    'stack-uid': cli_utilities_1.flags.string({
+        char: 's',
+        description: 'API key of the source stack',
+        hidden: true,
+        parse: (0, cli_utilities_1.printFlagDeprecation)(['-s', '--stack-uid'], ['-k', '--stack-api-key']),
+    }),
+    'stack-api-key': cli_utilities_1.flags.string({
+        char: 'k',
+        description: 'API key of the source stack',
+    }),
+    data: cli_utilities_1.flags.string({
+        description: 'path or location to store the data',
+        hidden: true,
+        parse: (0, cli_utilities_1.printFlagDeprecation)(['--data'], ['--data-dir']),
+    }),
+    'data-dir': cli_utilities_1.flags.string({
+        char: 'd',
+        description: 'path or location to store the data',
+    }),
+    alias: cli_utilities_1.flags.string({
+        char: 'a',
+        description: 'alias of the management token',
+    }),
+    'management-token-alias': cli_utilities_1.flags.string({
+        description: 'alias of the management token',
+        hidden: true,
+        parse: (0, cli_utilities_1.printFlagDeprecation)(['--management-token-alias'], ['-a', '--alias']),
+    }),
+    'auth-token': cli_utilities_1.flags.boolean({
+        char: 'A',
+        description: 'to use auth token',
+        hidden: true,
+        parse: (0, cli_utilities_1.printFlagDeprecation)(['-A', '--auth-token']),
+    }),
+    module: cli_utilities_1.flags.string({
+        char: 'm',
+        description: '[optional] specific module name',
+        exclusive: ['content-types'],
+        parse: (0, cli_utilities_1.printFlagDeprecation)(['-m'], ['--module']),
+    }),
+    'content-types': cli_utilities_1.flags.string({
+        char: 't',
+        description: '[optional] content type',
+        multiple: true,
+        exclusive: ['module'],
+        parse: (0, cli_utilities_1.printFlagDeprecation)(['-t'], ['--content-types']),
+    }),
+    branch: cli_utilities_1.flags.string({
+        char: 'B',
+        // default: 'main',
+        description: '[optional] branch name',
+        parse: (0, cli_utilities_1.printFlagDeprecation)(['-B'], ['--branch']),
+    }),
+    'secured-assets': cli_utilities_1.flags.boolean({
+        description: '[optional] use when assets are secured',
+    }),
+    yes: cli_utilities_1.flags.boolean({
+        char: 'y',
+        required: false,
+        description: '[optional] Override marketplace apps related prompts',
+    }),
+};
+ExportCommand.aliases = ['cm:export'];

package/lib/config/index.d.ts

@@ -0,0 +1,3 @@
+import { DefaultConfig } from '../types';
+declare const config: DefaultConfig;
+export default config;

package/lib/config/index.js

@@ -0,0 +1,393 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config = {
+    versioning: false,
+    host: 'https://api.contentstack.io/v3',
+    developerHubUrls: {
+        // NOTE CDA url used as developer-hub url mapper to avoid conflict if user used any custom name
+        'https://api.contentstack.io': 'https://developerhub-api.contentstack.com',
+        'https://eu-api.contentstack.com': 'https://eu-developerhub-api.contentstack.com',
+        'https://azure-na-api.contentstack.com': 'https://azure-na-developerhub-api.contentstack.com',
+        'https://azure-eu-api.contentstack.com': 'https://azure-eu-developerhub-api.contentstack.com',
+        'https://stag-api.csnonprod.com': 'https://stag-developerhub-api.csnonprod.com',
+    },
+    // use below hosts for eu region
+    // host:'https://eu-api.contentstack.com/v3',
+    // use below hosts for azure-na region
+    // host:'https://azure-na-api.contentstack.com/v3',
+    // use below hosts for azure-eu region
+    // host:'https://azure-eu-api.contentstack.com/v3',
+    modules: {
+        types: [
+            'stack',
+            'assets',
+            'locales',
+            'environments',
+            'extensions',
+            'webhooks',
+            'global-fields',
+            'content-types',
+            'custom-roles',
+            'workflows',
+            'entries',
+            'labels',
+            'marketplace-apps',
+        ],
+        locales: {
+            dirName: 'locales',
+            fileName: 'locales.json',
+            requiredKeys: ['code', 'uid', 'name', 'fallback_locale'],
+        },
+        masterLocale: {
+            dirName: 'locales',
+            fileName: 'master-locale.json',
+            requiredKeys: ['code', 'uid', 'name'],
+        },
+        customRoles: {
+            dirName: 'custom-roles',
+            fileName: 'custom-roles.json',
+            customRolesLocalesFileName: 'custom-roles-locales.json',
+        },
+        'custom-roles': {
+            dirName: 'custom-roles',
+            fileName: 'custom-roles.json',
+            customRolesLocalesFileName: 'custom-roles-locales.json',
+        },
+        environments: {
+            dirName: 'environments',
+            fileName: 'environments.json',
+        },
+        labels: {
+            dirName: 'labels',
+            fileName: 'labels.json',
+            invalidKeys: ['stackHeaders', 'uid', 'urlPath', 'created_at', 'updated_at', 'created_by', 'updated_by'],
+        },
+        webhooks: {
+            dirName: 'webhooks',
+            fileName: 'webhooks.json',
+        },
+        releases: {
+            dirName: 'releases',
+            fileName: 'releases.json',
+            releasesList: 'releasesList.json',
+            invalidKeys: ['stackHeaders', 'urlPath', 'created_at', 'updated_at', 'created_by', 'updated_by'],
+        },
+        workflows: {
+            dirName: 'workflows',
+            fileName: 'workflows.json',
+            invalidKeys: ['stackHeaders', 'urlPath', 'created_at', 'updated_at', 'created_by', 'updated_by'],
+        },
+        globalfields: {
+            dirName: 'global_fields',
+            fileName: 'globalfields.json',
+            validKeys: ['title', 'uid', 'schema', 'options', 'singleton', 'description'],
+        },
+        'global-fields': {
+            dirName: 'global_fields',
+            fileName: 'globalfields.json',
+            validKeys: ['title', 'uid', 'schema', 'options', 'singleton', 'description'],
+        },
+        assets: {
+            dirName: 'assets',
+            fileName: 'assets.json',
+            // This is the total no. of asset objects fetched in each 'get assets' call
+            batchLimit: 20,
+            host: 'https://images.contentstack.io',
+            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,
+            assetsMetaKeys: [],
+            securedAssets: false,
+            displayExecutionTime: false,
+            enableDownloadStatus: false,
+            includeVersionedAssets: false,
+        },
+        content_types: {
+            dirName: 'content_types',
+            fileName: 'content_types.json',
+            validKeys: ['title', 'uid', 'field_rules', 'schema', 'options', 'singleton', 'description'],
+            // total no of content types fetched in each 'get content types' call
+            limit: 100,
+        },
+        'content-types': {
+            dirName: 'content_types',
+            fileName: 'content_types.json',
+            validKeys: ['title', 'uid', 'field_rules', 'schema', 'options', 'singleton', 'description'],
+            // total no of content types fetched in each 'get content types' call
+            limit: 100,
+        },
+        entries: {
+            dirName: 'entries',
+            fileName: 'entries.json',
+            invalidKeys: [
+                'stackHeaders',
+                'content_type_uid',
+                'urlPath',
+                'created_at',
+                'updated_at',
+                'created_by',
+                'updated_by',
+                '_metadata',
+                'published',
+            ],
+            batchLimit: 20,
+            downloadLimit: 5,
+            // total no of entries fetched in each content type in a single call
+            limit: 100,
+            dependencies: ['locales', 'content-types'],
+        },
+        extensions: {
+            dirName: 'extensions',
+            fileName: 'extensions.json',
+        },
+        stack: {
+            dirName: 'stack',
+            fileName: 'stack.json',
+        },
+        dependency: {
+            entries: ['stack', 'locales', 'content-types'],
+        },
+        marketplace_apps: {
+            dirName: 'marketplace_apps',
+            fileName: 'marketplace_apps.json',
+        },
+        'marketplace-apps': {
+            dirName: 'marketplace_apps',
+            fileName: 'marketplace_apps.json',
+        },
+    },
+    languagesCode: [
+        'af-za',
+        'sq-al',
+        'ar',
+        'ar-dz',
+        'ar-bh',
+        'ar-eg',
+        'ar-iq',
+        'ar-jo',
+        'ar-kw',
+        'ar-lb',
+        'ar-ly',
+        'ar-ma',
+        'ar-om',
+        'ar-qa',
+        'ar-sa',
+        'ar-sy',
+        'ar-tn',
+        'ar-ae',
+        'ar-ye',
+        'hy-am',
+        'az',
+        'cy-az-az',
+        'lt-az-az',
+        'eu-es',
+        'be-by',
+        'bs',
+        'bg-bg',
+        'ca-es',
+        'zh',
+        'zh-au',
+        'zh-cn',
+        'zh-hk',
+        'zh-mo',
+        'zh-my',
+        'zh-sg',
+        'zh-tw',
+        'zh-chs',
+        'zh-cht',
+        'hr-hr',
+        'cs',
+        'cs-cz',
+        'da-dk',
+        'div-mv',
+        'nl',
+        'nl-be',
+        'nl-nl',
+        'en',
+        'en-au',
+        'en-at',
+        'en-be',
+        'en-bz',
+        'en-ca',
+        'en-cb',
+        'en-cn',
+        'en-cz',
+        'en-dk',
+        'en-do',
+        'en-ee',
+        'en-fi',
+        'en-fr',
+        'en-de',
+        'en-gr',
+        'en-hk',
+        'en-hu',
+        'en-in',
+        'en-id',
+        'en-ie',
+        'en-it',
+        'en-jm',
+        'en-jp',
+        'en-kr',
+        'en-lv',
+        'en-lt',
+        'en-lu',
+        'en-my',
+        'en-mx',
+        'en-nz',
+        'en-no',
+        'en-ph',
+        'en-pl',
+        'en-pt',
+        'en-pr',
+        'en-ru',
+        'en-sg',
+        'en-sk',
+        'en-si',
+        'en-za',
+        'en-es',
+        'en-se',
+        'en-ch',
+        'en-th',
+        'en-nl',
+        'en-tt',
+        'en-gb',
+        'en-us',
+        'en-zw',
+        'et-ee',
+        'fo-fo',
+        'fa-ir',
+        'fi',
+        'fi-fi',
+        'fr',
+        'fr-be',
+        'fr-ca',
+        'fr-fr',
+        'fr-lu',
+        'fr-mc',
+        'fr-ch',
+        'fr-us',
+        'gd',
+        'gl-es',
+        'ka-ge',
+        'de',
+        'de-at',
+        'de-de',
+        'de-li',
+        'de-lu',
+        'de-ch',
+        'el-gr',
+        'gu-in',
+        'he-il',
+        'hi-in',
+        'hu-hu',
+        'is-is',
+        'id-id',
+        'it',
+        'it-it',
+        'it-ch',
+        'ja',
+        'ja-jp',
+        'kn-in',
+        'kk-kz',
+        'km-kh',
+        'kok-in',
+        'ko',
+        'ko-kr',
+        'ky-kz',
+        'lv-lv',
+        'lt-lt',
+        'mk-mk',
+        'ms',
+        'ms-bn',
+        'ms-my',
+        'ms-sg',
+        'mt',
+        'mr-in',
+        'mn-mn',
+        'no',
+        'no-no',
+        'nb-no',
+        'nn-no',
+        'pl-pl',
+        'pt',
+        'pt-br',
+        'pt-pt',
+        'pa-in',
+        'ro-ro',
+        'ru',
+        'ru-kz',
+        'ru-ru',
+        'ru-ua',
+        'sa-in',
+        'cy-sr-sp',
+        'lt-sr-sp',
+        'sr-me',
+        'sk-sk',
+        'sl-si',
+        'es',
+        'es-ar',
+        'es-bo',
+        'es-cl',
+        'es-co',
+        'es-cr',
+        'es-do',
+        'es-ec',
+        'es-sv',
+        'es-gt',
+        'es-hn',
+        'es-419',
+        'es-mx',
+        'es-ni',
+        'es-pa',
+        'es-py',
+        'es-pe',
+        'es-pr',
+        'es-es',
+        'es-us',
+        'es-uy',
+        'es-ve',
+        'sw-ke',
+        'sv',
+        'sv-fi',
+        'sv-se',
+        'syr-sy',
+        'tl',
+        'ta-in',
+        'tt-ru',
+        'te-in',
+        'th-th',
+        'tr-tr',
+        'uk-ua',
+        'ur-pk',
+        'uz',
+        'cy-uz-uz',
+        'lt-uz-uz',
+        'vi-vn',
+        'xh',
+        'zu',
+    ],
+    updatedModules: ['assets', 'locales'],
+    apis: {
+        userSession: '/user-session/',
+        globalfields: '/global_fields/',
+        locales: '/locales/',
+        labels: '/labels/',
+        environments: '/environments/',
+        assets: '/assets/',
+        content_types: '/content_types/',
+        entries: '/entries/',
+        users: '/stacks',
+        extension: '/extensions',
+        webhooks: '/webhooks/',
+        stacks: '/stacks/',
+    },
+    preserveStackVersion: false,
+    fetchConcurrency: 5,
+    writeConcurrency: 5,
+    developerHubBaseUrl: '',
+    marketplaceAppEncryptionKey: 'nF2ejRQcTv',
+    useNewModuleStructure: false,
+};
+exports.default = config;

package/lib/export/index.d.ts

@@ -0,0 +1 @@
+export { default as ModuleExporter } from './module-exporter';

package/lib/export/index.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModuleExporter = void 0;
+var module_exporter_1 = require("./module-exporter");
+Object.defineProperty(exports, "ModuleExporter", { enumerable: true, get: function () { return __importDefault(module_exporter_1).default; } });

package/lib/export/module-exporter.d.ts

@@ -0,0 +1,15 @@
+import { ContentstackClient } from '@contentstack/cli-utilities';
+import { ExportConfig, Modules } from '../types';
+declare class ModuleExporter {
+    private managementAPIClient;
+    private exportConfig;
+    private stackAPIClient;
+    constructor(managementAPIClient: ContentstackClient, exportConfig: ExportConfig);
+    start(): Promise<any>;
+    exportByBranches(): Promise<void>;
+    export(): Promise<any>;
+    exportByModuleByName(moduleName: Modules): Promise<void>;
+    exportSingleModule(moduleName: Modules): Promise<void>;
+    exportAllModules(): Promise<any>;
+}
+export default ModuleExporter;

package/lib/export/module-exporter.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const path = tslib_1.__importStar(require("path"));
+const utils_1 = require("../utils");
+const modules_1 = tslib_1.__importDefault(require("./modules"));
+const modules_js_1 = tslib_1.__importDefault(require("./modules-js"));
+class ModuleExporter {
+    constructor(managementAPIClient, exportConfig) {
+        this.managementAPIClient = managementAPIClient;
+        this.stackAPIClient = this.managementAPIClient.stack({
+            api_key: exportConfig.apiKey,
+            management_token: exportConfig.management_token,
+        });
+        this.exportConfig = exportConfig;
+    }
+    async start() {
+        // setup the branches
+        await (0, utils_1.setupBranches)(this.exportConfig, this.stackAPIClient);
+        await (0, utils_1.setupExportDir)(this.exportConfig);
+        // if branches available run it export by branches
+        if (this.exportConfig.branches) {
+            this.exportConfig.branchEnabled = true;
+            return this.exportByBranches();
+        }
+        return this.export();
+    }
+    async exportByBranches() {
+        // loop through the branches and export it parallel
+        for (const branch of this.exportConfig.branches) {
+            try {
+                this.exportConfig.branchName = branch.uid;
+                this.exportConfig.branchDir = path.join(this.exportConfig.exportDir, branch.uid);
+                await this.export();
+                (0, utils_1.log)(this.exportConfig, `The content of branch ${branch.uid} has been exported successfully!`, 'success');
+            }
+            catch (error) {
+                (0, utils_1.log)(this.exportConfig, (0, utils_1.formatError)(error), 'error');
+                throw new Error(`Failed to export contents from branch ${branch.uid}`);
+            }
+        }
+    }
+    async export() {
+        // checks for single module or all modules
+        if (this.exportConfig.singleModuleExport) {
+            return this.exportSingleModule(this.exportConfig.moduleName);
+        }
+        return this.exportAllModules();
+    }
+    async exportByModuleByName(moduleName) {
+        (0, utils_1.log)(this.exportConfig, `Starting export of ${moduleName} module`, 'info');
+        // 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) {
+            exportedModuleResponse = await (0, modules_1.default)({
+                stackAPIClient: this.stackAPIClient,
+                exportConfig: this.exportConfig,
+                moduleName,
+            });
+        }
+        else {
+            exportedModuleResponse = await (0, modules_js_1.default)({
+                stackAPIClient: this.stackAPIClient,
+                exportConfig: this.exportConfig,
+                moduleName,
+            });
+        }
+        // set master locale to config
+        if (moduleName === 'stack' && (exportedModuleResponse === null || exportedModuleResponse === void 0 ? void 0 : exportedModuleResponse.code)) {
+            this.exportConfig.master_locale = { code: exportedModuleResponse.code };
+        }
+    }
+    async exportSingleModule(moduleName) {
+        // Note stack is always exported
+        let exportModules = ['stack'];
+        const { modules: { [moduleName]: { dependencies = [] } = {} }, } = this.exportConfig;
+        if (dependencies.length > 0) {
+            exportModules = exportModules.concat(dependencies);
+        }
+        exportModules.push(moduleName);
+        for (const moduleName of exportModules) {
+            await this.exportByModuleByName(moduleName);
+        }
+    }
+    async exportAllModules() {
+        // use the algorithm to determine the parallel and sequential execution of modules
+        for (const moduleName of this.exportConfig.modules.types) {
+            await this.exportByModuleByName(moduleName);
+        }
+    }
+}
+exports.default = ModuleExporter;