@contentstack/cli-cm-import 1.5.11 → 1.7.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.5.11 linux-x64 node-v16.20.1
+@contentstack/cli-cm-import/1.7.0 linux-x64 node-v18.17.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -63,7 +63,7 @@ USAGE
 
 ## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
 
-Import script for importing the content into the new stack
+Import content from a stack
 
 ```
 USAGE
@@ -83,11 +83,7 @@ FLAGS
                                     <options: disable|current>
 
 DESCRIPTION
-  Import script for importing the content into the new stack
-  ...
-  Once you export content from the source stack, import it to your destination stack by using the cm:stacks:import
-  command.
-
+  Import content from a stack
 
 ALIASES
   $ csdx cm:import
@@ -112,7 +108,7 @@ EXAMPLES
 
 ## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
 
-Import script for importing the content into the new stack
+Import content from a stack
 
 ```
 USAGE
@@ -132,11 +128,7 @@ FLAGS
                                     <options: disable|current>
 
 DESCRIPTION
-  Import script for importing the content into the new stack
-  ...
-  Once you export content from the source stack, import it to your destination stack by using the cm:stacks:import
-  command.
-
+  Import content from a stack
 
 ALIASES
   $ csdx cm:import
@@ -159,5 +151,5 @@ EXAMPLES
   $ csdx cm:stacks:import --branch <branch name>  --yes
 ```
 
-_See code: [src/commands/cm/stacks/import.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-import/src/commands/cm/stacks/import.js)_
+_See code: [src/commands/cm/stacks/import.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-import/src/commands/cm/stacks/import.ts)_
 <!-- commandsstop -->

package/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core');
+
+const path = require('path');
+const project = path.join(__dirname, '..', 'tsconfig.json');
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development';
+
+require('ts-node').register({ project });
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle);

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/run

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+(async () => {
+  const { execute } = require('@contentstack/cli-utilities');
+  await execute({ type: 'cjs', dir: __dirname });
+})();

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

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

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

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

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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 import_1 = require("../../../import");
+const utils_1 = require("../../../utils");
+class ImportCommand extends cli_command_1.Command {
+    async run() {
+        // setup import config
+        // initialize the importer
+        // start import
+        let contentDir;
+        try {
+            const { flags } = await this.parse(ImportCommand);
+            let importConfig = await (0, utils_1.setupImportConfig)(flags);
+            // Note setting host to create cma client
+            importConfig.host = this.cmaHost;
+            contentDir = importConfig.contentDir;
+            const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)(importConfig);
+            const moduleImporter = new import_1.ModuleImporter(managementAPIClient, importConfig);
+            await moduleImporter.start();
+            (0, utils_1.log)(importConfig, `The content has been imported to the stack ${importConfig.apiKey} successfully!`, 'success');
+        }
+        catch (error) {
+            (0, utils_1.log)({ data: contentDir }, `Failed to import stack content - ${(0, utils_1.formatError)(error)}`, 'error');
+            (0, utils_1.log)({ data: contentDir }, `The log has been stored at ${{ data: contentDir } ? node_path_1.default.join(contentDir || __dirname, 'logs', 'import') : node_path_1.default.join(__dirname, 'logs')}`, 'info');
+        }
+    }
+}
+exports.default = ImportCommand;
+ImportCommand.description = cli_utilities_1.messageHandler.parse('Import content from a stack');
+ImportCommand.examples = [
+    `csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>`,
+    `csdx cm:stacks:import --config <path/of/config/dir>`,
+    `csdx cm:stacks:import --module <single module name>`,
+    `csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>`,
+    `csdx cm:stacks:import --alias <management_token_alias>`,
+    `csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>`,
+    `csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>`,
+    `csdx cm:stacks:import --branch <branch name>  --yes`,
+];
+ImportCommand.flags = {
+    config: cli_utilities_1.flags.string({
+        char: 'c',
+        description: '[optional] path of config file',
+    }),
+    'stack-uid': cli_utilities_1.flags.string({
+        char: 's',
+        description: 'API key of the target 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 target stack',
+    }),
+    data: cli_utilities_1.flags.string({
+        description: 'path and location where data is stored',
+        hidden: true,
+        parse: (0, cli_utilities_1.printFlagDeprecation)(['--data'], ['--data-dir']),
+    }),
+    'data-dir': cli_utilities_1.flags.string({
+        char: 'd',
+        description: 'path and location where data is stored',
+    }),
+    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',
+        parse: (0, cli_utilities_1.printFlagDeprecation)(['-m'], ['--module']),
+    }),
+    'backup-dir': cli_utilities_1.flags.string({
+        char: 'b',
+        description: '[optional] backup directory name when using specific module',
+        parse: (0, cli_utilities_1.printFlagDeprecation)(['-b'], ['--backup-dir']),
+    }),
+    branch: cli_utilities_1.flags.string({
+        char: 'B',
+        description: '[optional] branch name',
+        parse: (0, cli_utilities_1.printFlagDeprecation)(['-B'], ['--branch']),
+    }),
+    'import-webhook-status': cli_utilities_1.flags.string({
+        description: '[optional] Webhook state',
+        options: ['disable', 'current'],
+        required: false,
+        default: 'disable',
+    }),
+    yes: cli_utilities_1.flags.boolean({
+        char: 'y',
+        required: false,
+        description: '[optional] Override marketplace prompts',
+    }),
+};
+ImportCommand.aliases = ['cm:import'];
+ImportCommand.usage = 'cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]';

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,395 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config = {
+    versioning: false,
+    // 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',
+    // pass locale, only to migrate entries from that locale
+    // not passing `locale` will migrate all the locales present
+    // locales: ['fr-fr'],
+    host: 'https://api.contentstack.io/v3',
+    extensionHost: 'https://app.contentstack.com',
+    developerHubUrls: {
+        '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',
+    },
+    modules: {
+        apiConcurrency: 5,
+        types: [
+            'locales',
+            'environments',
+            'assets',
+            'extensions',
+            'marketplace-apps',
+            'global-fields',
+            'content-types',
+            'custom-roles',
+            'workflows',
+            'entries',
+            'labels',
+            'webhooks',
+        ],
+        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',
+        },
+        environments: {
+            dirName: 'environments',
+            fileName: 'environments.json',
+        },
+        labels: {
+            dirName: 'labels',
+            fileName: 'labels.json',
+        },
+        extensions: {
+            dirName: 'extensions',
+            fileName: 'extensions.json',
+            validKeys: ['data_type', 'srcdoc', 'title', 'type', 'mutiple', 'config'],
+        },
+        webhooks: {
+            dirName: 'webhooks',
+            fileName: 'webhooks.json',
+        },
+        releases: {
+            dirName: 'releases',
+            fileName: 'releases.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'],
+        },
+        assets: {
+            dirName: 'assets',
+            assetBatchLimit: 1,
+            publishAssets: true,
+            fileName: 'assets.json',
+            importSameStructure: true,
+            uploadAssetsConcurrency: 10,
+            displayExecutionTime: false,
+            importFoldersConcurrency: 10,
+            includeVersionedAssets: false,
+            host: 'https://api.contentstack.io',
+            folderValidKeys: ['name', 'parent_uid'],
+            validKeys: ['title', 'parent_uid', 'description', 'tags'],
+        },
+        'assets-old': {
+            dirName: 'assets',
+            fileName: 'assets.json',
+            // This is the total no. of asset objects fetched in each 'get assets' call
+            limit: 100,
+            host: 'https://api.contentstack.io',
+            validKeys: ['uid', 'filename', 'url', 'status'],
+            assetBatchLimit: 1,
+            uploadAssetsConcurrency: 1,
+            importFoldersConcurrency: 1,
+        },
+        content_types: {
+            dirName: 'content_types',
+            fileName: 'content_types.json',
+            validKeys: ['title', 'uid', 'schema', 'options', 'singleton', 'description'],
+            limit: 100,
+        },
+        'content-types': {
+            dirName: 'content_types',
+            fileName: 'content_types.json',
+            validKeys: ['title', 'uid', 'schema', 'options', 'singleton', 'description'],
+            limit: 100,
+        },
+        entries: {
+            dirName: 'entries',
+            fileName: 'entries.json',
+            invalidKeys: ['created_at', 'updated_at', 'created_by', 'updated_by', '_metadata', 'published'],
+            limit: 50,
+            assetBatchLimit: 5,
+        },
+        globalfields: {
+            dirName: 'global_fields',
+            fileName: 'globalfields.json',
+            validKeys: ['title', 'uid', 'schema', 'options', 'singleton', 'description'],
+            limit: 100,
+        },
+        'global-fields': {
+            dirName: 'global_fields',
+            fileName: 'globalfields.json',
+            validKeys: ['title', 'uid', 'schema', 'options', 'singleton', 'description'],
+            limit: 100,
+        },
+        stack: {
+            dirName: 'stack',
+            fileName: 'stack.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',
+    ],
+    apis: {
+        userSession: '/user-session/',
+        locales: '/locales/',
+        environments: '/environments/',
+        assets: '/assets/',
+        content_types: '/content_types/',
+        entries: '/entries/',
+        extensions: '/extensions/',
+        webhooks: '/webhooks/',
+        globalfields: '/global_fields/',
+        folders: '/folders/',
+        stacks: '/stacks/',
+        labels: '/labels/',
+    },
+    updatedModules: [
+        'assets',
+        'extensions',
+        'locales',
+        'marketplace-apps',
+        'labels',
+        'global-fields',
+        'content-types',
+        'webhooks',
+        'custom-roles',
+    ],
+    rateLimit: 5,
+    preserveStackVersion: false,
+    entriesPublish: true,
+    concurrency: 1,
+    importConcurrency: 5,
+    fetchConcurrency: 5,
+    writeConcurrency: 5,
+    developerHubBaseUrl: '',
+    marketplaceAppEncryptionKey: 'nF2ejRQcTv',
+    getEncryptionKeyMaxRetry: 3,
+    useNewModuleStructure: false,
+    // useBackedupDir: '',
+    // backupConcurrency: 10,
+};
+exports.default = config;

package/lib/import/index.d.ts

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

package/lib/import/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.ModuleImporter = void 0;
+var module_importer_1 = require("./module-importer");
+Object.defineProperty(exports, "ModuleImporter", { enumerable: true, get: function () { return __importDefault(module_importer_1).default; } });

package/lib/import/module-importer.d.ts

@@ -0,0 +1,13 @@
+import { ContentstackClient } from '@contentstack/cli-utilities';
+import { ImportConfig, Modules } from '../types';
+declare class ModuleImporter {
+    private managementAPIClient;
+    private importConfig;
+    private stackAPIClient;
+    constructor(managementAPIClient: ContentstackClient, importConfig: ImportConfig);
+    start(): Promise<any>;
+    import(): Promise<any>;
+    importByModuleByName(moduleName: Modules): Promise<any>;
+    importAllModules(): Promise<any>;
+}
+export default ModuleImporter;