@contentstack/cli-cm-import 1.28.3 → 1.30.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.28.3 linux-x64 node-v22.20.0
+@contentstack/cli-cm-import/1.30.0 linux-x64 node-v22.21.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -71,39 +71,68 @@ USAGE
     [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]
 
 FLAGS
-  -B, --branch=<value>                    The name of the branch where you want to import your content. If you don't
-                                          mention the branch name, then by default the content will be imported to the
-                                          main branch.
-  -a, --alias=<value>                     The management token of the destination stack where you will import the
-                                          content.
-  -b, --backup-dir=<value>                [optional] Backup directory name when using specific module.
-  -c, --config=<value>                    [optional] The path of the configuration JSON file containing all the options
-                                          for a single run.
-  -d, --data-dir=<value>                  The path or the location in your file system where the content, you intend to
-                                          import, is stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the
-                                          export folder has branches involved, then the path should point till the
-                                          particular branch. For example, “-d
-                                          "C:\Users\Name\Desktop\cli\content\branch_name"
-  -k, --stack-api-key=<value>             API Key of the target stack
-  -m, --module=<value>                    [optional] Specify the module to import into the target stack. If not
-                                          specified, the import command will import all the modules into the stack. The
-                                          available modules are assets, content-types, entries, environments,
-                                          extensions, marketplace-apps, global-fields, labels, locales, webhooks,
-                                          workflows, custom-roles, personalize projects, and taxonomies.
-  -y, --yes                               [optional] Force override all Marketplace prompts.
-      --branch-alias=<value>              Specify the branch alias where you want to import your content. If not
-                                          specified, the content is imported into the main branch by default.
-      --exclude-global-modules            Excludes the branch-independent module from the import operation.
-      --import-webhook-status=<option>    [default: disable] [default: disable] (optional) This webhook state keeps the
-                                          same state of webhooks as the source stack. <options: disable|current>
-                                          <options: disable|current>
-      --personalize-project-name=<value>  (optional) Provide a unique name for the Personalize project.
-      --replace-existing                  Replaces the existing module in the target stack.
-      --skip-app-recreation               (optional) Skips the recreation of private apps if they already exist.
-      --skip-assets-publish               Skips asset publishing during the import process.
-      --skip-audit                        Skips the audit fix that occurs during an import operation.
-      --skip-entries-publish              Skips entry publishing during the import process
-      --skip-existing                     Skips the module exists warning messages.
+  -B, --branch=<value>
+      The name of the branch where you want to import your content. If you don't mention the branch name, then by default
+      the content will be imported to the main branch.
+
+  -a, --alias=<value>
+      The management token of the destination stack where you will import the content.
+
+  -b, --backup-dir=<value>
+      [optional] Backup directory name when using specific module.
+
+  -c, --config=<value>
+      [optional] The path of the configuration JSON file containing all the options for a single run.
+
+  -d, --data-dir=<value>
+      The path or the location in your file system where the content, you intend to import, is stored. For example, -d
+      "C:\Users\Name\Desktop\cli\content". If the export folder has branches involved, then the path should point till the
+      particular branch. For example, “-d "C:\Users\Name\Desktop\cli\content\branch_name"
+
+  -k, --stack-api-key=<value>
+      API Key of the target stack
+
+  -m, --module=<value>
+      [optional] Specify the module to import into the target stack. If not specified, the import command will import all
+      the modules into the stack. The available modules are assets, content-types, entries, environments, extensions,
+      marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, personalize projects,
+      taxonomies, and composable-studio.
+
+  -y, --yes
+      [optional] Force override all Marketplace prompts.
+
+  --branch-alias=<value>
+      Specify the branch alias where you want to import your content. If not specified, the content is imported into the
+      main branch by default.
+
+  --exclude-global-modules
+      Excludes the branch-independent module from the import operation.
+
+  --import-webhook-status=<option>
+      [default: disable] [default: disable] (optional) This webhook state keeps the same state of webhooks as the source
+      stack. <options: disable|current>
+      <options: disable|current>
+
+  --personalize-project-name=<value>
+      (optional) Provide a unique name for the Personalize project.
+
+  --replace-existing
+      Replaces the existing module in the target stack.
+
+  --skip-app-recreation
+      (optional) Skips the recreation of private apps if they already exist.
+
+  --skip-assets-publish
+      Skips asset publishing during the import process.
+
+  --skip-audit
+      Skips the audit fix that occurs during an import operation.
+
+  --skip-entries-publish
+      Skips entry publishing during the import process
+
+  --skip-existing
+      Skips the module exists warning messages.
 
 DESCRIPTION
   Import content from a stack
@@ -139,39 +168,68 @@ USAGE
     <value>] [--branch <value>] [--import-webhook-status disable|current]
 
 FLAGS
-  -B, --branch=<value>                    The name of the branch where you want to import your content. If you don't
-                                          mention the branch name, then by default the content will be imported to the
-                                          main branch.
-  -a, --alias=<value>                     The management token of the destination stack where you will import the
-                                          content.
-  -b, --backup-dir=<value>                [optional] Backup directory name when using specific module.
-  -c, --config=<value>                    [optional] The path of the configuration JSON file containing all the options
-                                          for a single run.
-  -d, --data-dir=<value>                  The path or the location in your file system where the content, you intend to
-                                          import, is stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the
-                                          export folder has branches involved, then the path should point till the
-                                          particular branch. For example, “-d
-                                          "C:\Users\Name\Desktop\cli\content\branch_name"
-  -k, --stack-api-key=<value>             API Key of the target stack
-  -m, --module=<value>                    [optional] Specify the module to import into the target stack. If not
-                                          specified, the import command will import all the modules into the stack. The
-                                          available modules are assets, content-types, entries, environments,
-                                          extensions, marketplace-apps, global-fields, labels, locales, webhooks,
-                                          workflows, custom-roles, personalize projects, and taxonomies.
-  -y, --yes                               [optional] Force override all Marketplace prompts.
-      --branch-alias=<value>              Specify the branch alias where you want to import your content. If not
-                                          specified, the content is imported into the main branch by default.
-      --exclude-global-modules            Excludes the branch-independent module from the import operation.
-      --import-webhook-status=<option>    [default: disable] [default: disable] (optional) This webhook state keeps the
-                                          same state of webhooks as the source stack. <options: disable|current>
-                                          <options: disable|current>
-      --personalize-project-name=<value>  (optional) Provide a unique name for the Personalize project.
-      --replace-existing                  Replaces the existing module in the target stack.
-      --skip-app-recreation               (optional) Skips the recreation of private apps if they already exist.
-      --skip-assets-publish               Skips asset publishing during the import process.
-      --skip-audit                        Skips the audit fix that occurs during an import operation.
-      --skip-entries-publish              Skips entry publishing during the import process
-      --skip-existing                     Skips the module exists warning messages.
+  -B, --branch=<value>
+      The name of the branch where you want to import your content. If you don't mention the branch name, then by default
+      the content will be imported to the main branch.
+
+  -a, --alias=<value>
+      The management token of the destination stack where you will import the content.
+
+  -b, --backup-dir=<value>
+      [optional] Backup directory name when using specific module.
+
+  -c, --config=<value>
+      [optional] The path of the configuration JSON file containing all the options for a single run.
+
+  -d, --data-dir=<value>
+      The path or the location in your file system where the content, you intend to import, is stored. For example, -d
+      "C:\Users\Name\Desktop\cli\content". If the export folder has branches involved, then the path should point till the
+      particular branch. For example, “-d "C:\Users\Name\Desktop\cli\content\branch_name"
+
+  -k, --stack-api-key=<value>
+      API Key of the target stack
+
+  -m, --module=<value>
+      [optional] Specify the module to import into the target stack. If not specified, the import command will import all
+      the modules into the stack. The available modules are assets, content-types, entries, environments, extensions,
+      marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, personalize projects,
+      taxonomies, and composable-studio.
+
+  -y, --yes
+      [optional] Force override all Marketplace prompts.
+
+  --branch-alias=<value>
+      Specify the branch alias where you want to import your content. If not specified, the content is imported into the
+      main branch by default.
+
+  --exclude-global-modules
+      Excludes the branch-independent module from the import operation.
+
+  --import-webhook-status=<option>
+      [default: disable] [default: disable] (optional) This webhook state keeps the same state of webhooks as the source
+      stack. <options: disable|current>
+      <options: disable|current>
+
+  --personalize-project-name=<value>
+      (optional) Provide a unique name for the Personalize project.
+
+  --replace-existing
+      Replaces the existing module in the target stack.
+
+  --skip-app-recreation
+      (optional) Skips the recreation of private apps if they already exist.
+
+  --skip-assets-publish
+      Skips asset publishing during the import process.
+
+  --skip-audit
+      Skips the audit fix that occurs during an import operation.
+
+  --skip-entries-publish
+      Skips entry publishing during the import process
+
+  --skip-existing
+      Skips the module exists warning messages.
 
 DESCRIPTION
   Import content from a stack

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

@@ -17,7 +17,7 @@ class ImportCommand extends cli_command_1.Command {
             // Prepare the context object
             const context = this.createImportContext(importConfig.apiKey, importConfig.authenticationMethod);
             importConfig.context = Object.assign({}, context);
-            //log.info(`Using Cli Version: ${this.context?.cliVersion}`, importConfig.context);
+            // log.info(`Using CLI version: ${this.context?.cliVersion}`, importConfig.context);
             // Note setting host to create cma client
             importConfig.host = this.cmaHost;
             importConfig.region = this.region;
@@ -25,6 +25,8 @@ class ImportCommand extends cli_command_1.Command {
                 importConfig.developerHubBaseUrl = this.developerHubUrl;
             if (this.personalizeUrl)
                 importConfig.modules.personalize.baseURL[importConfig.region.name] = this.personalizeUrl;
+            if (this.composableStudioUrl)
+                importConfig.modules['composable-studio'].apiBaseUrl = this.composableStudioUrl;
             const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)(importConfig);
             const moduleImporter = new import_1.ModuleImporter(managementAPIClient, importConfig);
             const result = await moduleImporter.start();
@@ -35,14 +37,14 @@ class ImportCommand extends cli_command_1.Command {
                     : `The content has been imported to the stack ${importConfig.apiKey} successfully!`;
                 cli_utilities_1.log.success(successMessage, importConfig.context);
             }
-            cli_utilities_1.log.success(`The log has been stored at '${(0, cli_utilities_1.getLogPath)()}'`, importConfig.context);
-            cli_utilities_1.log.info(`The backup content has been stored at '${backupDir}'`, importConfig.context);
+            cli_utilities_1.log.success(`The log has been stored at: ${(0, cli_utilities_1.getLogPath)()}`, importConfig.context);
+            cli_utilities_1.log.info(`The backup content has been stored at: ${backupDir}`, importConfig.context);
         }
         catch (error) {
             (0, cli_utilities_1.handleAndLogError)(error);
             cli_utilities_1.log.info(`The log has been stored at '${(0, cli_utilities_1.getLogPath)()}'`);
             if (importConfig === null || importConfig === void 0 ? void 0 : importConfig.backupDir) {
-                cli_utilities_1.log.info(`The backup content has been stored at '${importConfig === null || importConfig === void 0 ? void 0 : importConfig.backupDir}'`);
+                cli_utilities_1.log.info(`The backup content has been stored at: ${importConfig === null || importConfig === void 0 ? void 0 : importConfig.backupDir}`);
             }
             else {
                 cli_utilities_1.log.info('No backup directory was created due to early termination');
@@ -118,7 +120,7 @@ ImportCommand.flags = {
     module: cli_utilities_1.flags.string({
         required: false,
         char: 'm',
-        description: '[optional] Specify the module to import into the target stack. If not specified, the import command will import all the modules into the stack. The available modules are assets, content-types, entries, environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, personalize projects, and taxonomies.',
+        description: '[optional] Specify the module to import into the target stack. If not specified, the import command will import all the modules into the stack. The available modules are assets, content-types, entries, environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, personalize projects, taxonomies, and composable-studio.',
         parse: (0, cli_utilities_1.printFlagDeprecation)(['-m'], ['--module']),
     }),
     'backup-dir': cli_utilities_1.flags.string({
@@ -133,7 +135,7 @@ ImportCommand.flags = {
         exclusive: ['branch-alias'],
     }),
     'branch-alias': cli_utilities_1.flags.string({
-        description: "Specify the branch alias where you want to import your content. If not specified, the content is imported into the main branch by default.",
+        description: 'Specify the branch alias where you want to import your content. If not specified, the content is imported into the main branch by default.',
         exclusive: ['branch'],
     }),
     'import-webhook-status': cli_utilities_1.flags.string({

package/lib/config/index.js

@@ -44,6 +44,7 @@ const config = {
             'variant-entries',
             'labels',
             'webhooks',
+            'composable-studio',
         ],
         locales: {
             dirName: 'locales',
@@ -199,6 +200,12 @@ const config = {
                 locale: 'en-us',
             },
         },
+        'composable-studio': {
+            dirName: 'composable_studio',
+            fileName: 'composable_studio.json',
+            apiBaseUrl: 'https://composable-studio-api.contentstack.com',
+            apiVersion: 'v1',
+        },
     },
     languagesCode: [
         'af-za',

package/lib/import/modules/assets.js

@@ -41,25 +41,25 @@ class ImportAssets extends base_class_1.default {
     async start() {
         try {
             // NOTE Step 1: Import folders and create uid mapping file
-            cli_utilities_1.log.debug('Starting folder import process', this.importConfig.context);
+            cli_utilities_1.log.debug('Starting folder import process...', this.importConfig.context);
             await this.importFolders();
             // NOTE Step 2: Import versioned assets and create it mapping files (uid, url)
             if (this.assetConfig.includeVersionedAssets) {
                 const versionsPath = `${this.assetsPath}/versions`;
                 if ((0, node_fs_1.existsSync)(versionsPath)) {
-                    cli_utilities_1.log.debug('Starting versioned assets import', this.importConfig.context);
+                    cli_utilities_1.log.debug('Starting versioned assets import...', this.importConfig.context);
                     await this.importAssets(true);
                 }
                 else {
-                    cli_utilities_1.log.info('No Versioned assets found to import', this.importConfig.context);
+                    cli_utilities_1.log.info('No versioned assets found to import.', this.importConfig.context);
                 }
             }
             // NOTE Step 3: Import Assets and create it mapping files (uid, url)
-            cli_utilities_1.log.debug('Starting assets import', this.importConfig.context);
+            cli_utilities_1.log.debug('Starting assets import...', this.importConfig.context);
             await this.importAssets();
             // NOTE Step 4: Publish assets
             if (!this.importConfig.skipAssetsPublish) {
-                cli_utilities_1.log.debug('Starting assets publishing', this.importConfig.context);
+                cli_utilities_1.log.debug('Starting assets publishing...', this.importConfig.context);
                 await this.publish();
             }
             cli_utilities_1.log.success('Assets imported successfully!', this.importConfig.context);
@@ -77,19 +77,19 @@ class ImportAssets extends base_class_1.default {
         cli_utilities_1.log.debug(`Reading folders from: ${foldersPath}`, this.importConfig.context);
         const folders = this.fs.readFile(foldersPath);
         if ((0, isEmpty_1.default)(folders)) {
-            cli_utilities_1.log.info('No folders found to import', this.importConfig.context);
+            cli_utilities_1.log.info('No folders found to import.', this.importConfig.context);
             return;
         }
-        cli_utilities_1.log.debug(`Found ${folders.length} folders to import`, this.importConfig.context);
+        cli_utilities_1.log.debug(`Found ${folders.length} folders to import.`, this.importConfig.context);
         const batches = this.constructFolderImportOrder(folders);
-        cli_utilities_1.log.debug(`Organized folders into ${batches.length} batches for import`, this.importConfig.context);
+        cli_utilities_1.log.debug(`Organized folders into ${batches.length} batches for import.`, this.importConfig.context);
         const onSuccess = ({ response, apiData: { uid, name } = { uid: null, name: '' } }) => {
             this.assetsFolderMap[uid] = response.uid;
-            cli_utilities_1.log.debug(`Created folder: ${name} (Mapped ${uid} → ${response.uid})`, this.importConfig.context);
+            cli_utilities_1.log.debug(`Created folder: ${name} (Mapped ${uid} → ${response.uid}).`, this.importConfig.context);
             cli_utilities_1.log.success(`Created folder: '${name}'`, this.importConfig.context);
         };
         const onReject = ({ error, apiData: { name } = { name: '' } }) => {
-            cli_utilities_1.log.error(`${name} folder creation failed.!`, this.importConfig.context);
+            cli_utilities_1.log.error(`${name} folder creation failed.`, this.importConfig.context);
             (0, cli_utilities_1.handleAndLogError)(error, Object.assign(Object.assign({}, this.importConfig.context), { name }));
         };
         const serializeData = (apiOptions) => {
@@ -101,7 +101,7 @@ class ImportAssets extends base_class_1.default {
             return apiOptions;
         };
         const batch = (0, map_1.default)((0, unionBy_1.default)(batches, 'parent_uid'), 'parent_uid');
-        cli_utilities_1.log.debug(`Processing ${batch.length} folder batches`, this.importConfig.context);
+        cli_utilities_1.log.debug(`Processing ${batch.length} folder batches.`, this.importConfig.context);
         for (const parent_uid of batch) {
             const currentBatch = (0, filter_1.default)(batches, { parent_uid });
             cli_utilities_1.log.debug(`Processing batch with parent_uid: ${parent_uid} (${currentBatch.length} folders)`, this.importConfig.context);
@@ -146,7 +146,7 @@ class ImportAssets extends base_class_1.default {
             cli_utilities_1.log.success(`Created asset: '${title}'`, this.importConfig.context);
         };
         const onReject = ({ error, apiData: { title } = undefined }) => {
-            cli_utilities_1.log.error(`${title} asset upload failed.!`, this.importConfig.context);
+            cli_utilities_1.log.error(`${title} asset upload failed.`, this.importConfig.context);
             (0, cli_utilities_1.handleAndLogError)(error, Object.assign(Object.assign({}, this.importConfig.context), { title }));
         };
         /* eslint-disable @typescript-eslint/no-unused-vars, guard-for-in */
@@ -159,7 +159,7 @@ class ImportAssets extends base_class_1.default {
                 let apiContent = (0, orderBy_1.default)((0, values_1.default)(chunk), '_version');
                 cli_utilities_1.log.debug(`Processing ${apiContent.length} assets in chunk`, this.importConfig.context);
                 if (isVersion && this.assetConfig.importSameStructure) {
-                    cli_utilities_1.log.debug('Processing version 1 assets first', this.importConfig.context);
+                    cli_utilities_1.log.debug('Processing version 1 assets first...', this.importConfig.context);
                     const versionOneAssets = (0, filter_1.default)(apiContent, ({ _version }) => _version === 1);
                     await this.makeConcurrentCall({
                         processName,
@@ -247,7 +247,7 @@ class ImportAssets extends base_class_1.default {
     async publish() {
         const fs = new cli_utilities_1.FsUtility({ basePath: this.assetsPath, indexFileName: 'assets.json' });
         if ((0, isEmpty_1.default)(this.assetsUidMap)) {
-            cli_utilities_1.log.debug('Loading asset UID mappings from file', this.importConfig.context);
+            cli_utilities_1.log.debug('Loading asset UID mappings from file...', this.importConfig.context);
             this.assetsUidMap = fs.readFile(this.assetUidMapperPath, true);
         }
         const indexer = fs.indexFileContent;
@@ -270,7 +270,7 @@ class ImportAssets extends base_class_1.default {
                 const environments = (0, uniq_1.default)((0, map_1.default)(publishDetails, ({ environment }) => this.environments[environment].name));
                 const locales = (0, uniq_1.default)((0, map_1.default)(publishDetails, 'locale'));
                 if (environments.length === 0 || locales.length === 0) {
-                    cli_utilities_1.log.debug(`Skipping publish for asset ${asset.uid} - no valid environments/locales`, this.importConfig.context);
+                    cli_utilities_1.log.debug(`Skipping publish for asset ${asset.uid}: no valid environments/locales`, this.importConfig.context);
                     apiOptions.entity = undefined;
                     return apiOptions;
                 }
@@ -281,7 +281,7 @@ class ImportAssets extends base_class_1.default {
             }
             apiOptions.uid = this.assetsUidMap[asset.uid];
             if (!apiOptions.uid) {
-                cli_utilities_1.log.debug(`Skipping publish for asset ${asset.uid} - no UID mapping found`, this.importConfig.context);
+                cli_utilities_1.log.debug(`Skipping publish for asset ${asset.uid}: no UID mapping found.`, this.importConfig.context);
                 apiOptions.entity = undefined;
             }
             return apiOptions;
@@ -328,7 +328,7 @@ class ImportAssets extends base_class_1.default {
             });
         }
         if (this.importConfig.replaceExisting) {
-            cli_utilities_1.log.debug('Setting up root folder for import', this.importConfig.context);
+            cli_utilities_1.log.debug('Setting up root folder for import...', this.importConfig.context);
             // Note: adds a root folder to distinguish latest asset uploads
             // Todo: This temporary approach should be updated with asset and folder overwrite strategy, which follows
             // folder overwrite
@@ -350,7 +350,7 @@ class ImportAssets extends base_class_1.default {
                 }
             });
             importOrder.unshift(this.rootFolder);
-            cli_utilities_1.log.debug('Added root folder to import order', this.importConfig.context);
+            cli_utilities_1.log.debug('Added root folder to import order.', this.importConfig.context);
         }
         return importOrder;
     }

package/lib/import/modules/base-class.d.ts

@@ -9,6 +9,7 @@ export type ApiOptions = {
     url?: string;
     entity: ApiModuleType;
     apiData?: Record<any, any> | any;
+    queryParam?: Record<any, any>;
     resolve: (value: any) => Promise<void> | void;
     reject: (error: any) => Promise<void> | void;
     additionalInfo?: Record<any, any>;

package/lib/import/modules/base-class.js

@@ -292,7 +292,9 @@ class BaseClass {
                 if (!apiData || !apiData.filePath) {
                     return Promise.resolve();
                 }
-                return this.stack.taxonomy(uid).import({ taxonomy: apiData.filePath }).then(onSuccess).catch(onReject);
+                const importParams = { taxonomy: apiData.filePath };
+                const importQueryParam = apiOptions.queryParam || {};
+                return this.stack.taxonomy(uid).import(importParams, importQueryParam).then(onSuccess).catch(onReject);
             default:
                 return Promise.resolve();
         }

package/lib/import/modules/composable-studio.d.ts

@@ -0,0 +1,43 @@
+import { ModuleClassParams, ComposableStudioProject } from '../../types';
+export default class ImportComposableStudio {
+    private importConfig;
+    private composableStudioConfig;
+    private composableStudioPath;
+    private composableStudioFilePath;
+    private apiClient;
+    private envUidMapperPath;
+    private envUidMapper;
+    constructor({ importConfig }: ModuleClassParams);
+    /**
+     * Entry point for Composable Studio import
+     */
+    start(): Promise<void>;
+    /**
+     * Initialize authentication headers for API calls
+     */
+    addAuthHeaders(): Promise<boolean>;
+    /**
+     * Load environment UID mapper from backup directory
+     */
+    loadEnvironmentMapper(): Promise<void>;
+    /**
+     * Read exported project from file system
+     */
+    readExportedProject(): Promise<ComposableStudioProject | null>;
+    /**
+     * Check if target stack already has a connected project
+     */
+    getExistingProject(): Promise<ComposableStudioProject | null>;
+    /**
+     * Import project with name conflict handling
+     */
+    importProject(exportedProject: ComposableStudioProject): Promise<void>;
+    /**
+     * Map environment UID from source to target
+     */
+    mapEnvironmentUid(sourceEnvUid: string): string;
+    /**
+     * Prompt user for a new project name when conflict occurs
+     */
+    promptForNewProjectName(currentName: string): Promise<string>;
+}