@contentstack/cli-cm-export 1.21.0 → 1.22.0

package/lib/export/modules/stack.js

@@ -17,20 +17,20 @@ class ExportStack extends base_class_1.default {
     async start() {
         cli_utilities_1.log.debug('Starting stack export process...', this.exportConfig.context);
         if ((0, cli_utilities_1.isAuthenticated)()) {
-            cli_utilities_1.log.debug('User is authenticated, fetching stack data...', this.exportConfig.context);
+            cli_utilities_1.log.debug('User authenticated.', this.exportConfig.context);
             const stackData = await this.getStack();
             if (stackData === null || stackData === void 0 ? void 0 : stackData.org_uid) {
-                cli_utilities_1.log.debug(`Found organization UID: ${stackData.org_uid}`, this.exportConfig.context);
+                cli_utilities_1.log.debug(`Found organization UID: '${stackData.org_uid}'.`, this.exportConfig.context);
                 this.exportConfig.org_uid = stackData.org_uid;
                 this.exportConfig.sourceStackName = stackData.name;
-                cli_utilities_1.log.debug(`Set source stack name: ${stackData.name}`, this.exportConfig.context);
+                cli_utilities_1.log.debug(`Set source stack name: '${stackData.name}'.`, this.exportConfig.context);
             }
             else {
-                cli_utilities_1.log.debug('No stack data found or missing org_uid', this.exportConfig.context);
+                cli_utilities_1.log.debug('No stack data found or missing organization UID.', this.exportConfig.context);
             }
         }
         else {
-            cli_utilities_1.log.debug('User is not authenticated, skipping stack data fetch', this.exportConfig.context);
+            cli_utilities_1.log.debug('User is not authenticated.', this.exportConfig.context);
         }
         if (this.exportConfig.management_token) {
             cli_utilities_1.log.info('Skipping stack settings export: Operation is not supported when using a management token.', this.exportConfig.context);
@@ -44,61 +44,61 @@ class ExportStack extends base_class_1.default {
             return this.getLocales();
         }
         else if (this.exportConfig.preserveStackVersion) {
-            cli_utilities_1.log.debug('Preserve stack version is true, exporting stack...', this.exportConfig.context);
+            cli_utilities_1.log.debug('Preserve stack version is set to true.', this.exportConfig.context);
             return this.exportStack();
         }
         else {
-            cli_utilities_1.log.debug('Master locale already set, skipping locale fetch', this.exportConfig.context);
+            cli_utilities_1.log.debug('Master locale is already set.', this.exportConfig.context);
         }
     }
     async getStack() {
-        cli_utilities_1.log.debug(`Fetching stack data for stack: ${this.exportConfig.source_stack}`, this.exportConfig.context);
+        cli_utilities_1.log.debug(`Fetching stack data for: '${this.exportConfig.source_stack}'...`, this.exportConfig.context);
         const tempAPIClient = await (0, cli_utilities_1.managementSDKClient)({ host: this.exportConfig.host });
-        cli_utilities_1.log.debug(`Created management SDK client with host: ${this.exportConfig.host}`, this.exportConfig.context);
+        cli_utilities_1.log.debug(`Created Management SDK client with host: '${this.exportConfig.host}'.`, this.exportConfig.context);
         return await tempAPIClient
             .stack({ api_key: this.exportConfig.source_stack })
             .fetch()
             .then((data) => {
-            cli_utilities_1.log.debug(`Successfully fetched stack data for: ${this.exportConfig.source_stack}`, this.exportConfig.context);
+            cli_utilities_1.log.debug(`Successfully fetched stack data for: '${this.exportConfig.source_stack}'.`, this.exportConfig.context);
             return data;
         })
             .catch((error) => {
-            cli_utilities_1.log.debug(`Failed to fetch stack data for: ${this.exportConfig.source_stack}`, this.exportConfig.context);
+            cli_utilities_1.log.debug(`Failed to fetch stack data for: '${this.exportConfig.source_stack}'.`, this.exportConfig.context);
             return {};
         });
     }
     async getLocales(skip = 0) {
         if (skip) {
             this.qs.skip = skip;
-            cli_utilities_1.log.debug(`Fetching locales with skip: ${skip}`, this.exportConfig.context);
+            cli_utilities_1.log.debug(`Fetching locales with skip: ${skip}.`, this.exportConfig.context);
         }
         else {
-            cli_utilities_1.log.debug('Fetching locales with initial query', this.exportConfig.context);
+            cli_utilities_1.log.debug('Fetching locales with initial query...', this.exportConfig.context);
         }
-        cli_utilities_1.log.debug(`Query parameters: ${JSON.stringify(this.qs)}`, this.exportConfig.context);
+        cli_utilities_1.log.debug(`Query parameters: ${JSON.stringify(this.qs)}.`, this.exportConfig.context);
         return await this.stack
             .locale()
             .query(this.qs)
             .find()
             .then(async (data) => {
             const { items, count } = data;
-            cli_utilities_1.log.debug(`Fetched ${(items === null || items === void 0 ? void 0 : items.length) || 0} locales out of total ${count}`, this.exportConfig.context);
+            cli_utilities_1.log.debug(`Fetched ${(items === null || items === void 0 ? void 0 : items.length) || 0} locales out of ${count}.`, this.exportConfig.context);
             if (items === null || items === void 0 ? void 0 : items.length) {
-                cli_utilities_1.log.debug(`Processing ${items.length} locales to find master locale`, this.exportConfig.context);
+                cli_utilities_1.log.debug(`Processing ${items.length} locales to find the master locale...`, this.exportConfig.context);
                 skip += this.stackConfig.limit || 100;
                 const masterLocalObj = (0, find_1.default)(items, (locale) => {
                     if (locale.fallback_locale === null) {
-                        cli_utilities_1.log.debug(`Found master locale: ${locale.name} (${locale.code})`, this.exportConfig.context);
+                        cli_utilities_1.log.debug(`Found master locale: '${locale.name}' (code: ${locale.code}).`, this.exportConfig.context);
                         return locale;
                     }
                 });
                 if (masterLocalObj) {
-                    cli_utilities_1.log.debug(`Returning master locale: ${masterLocalObj.name}`, this.exportConfig.context);
+                    cli_utilities_1.log.debug(`Returning master locale: '${masterLocalObj.name}'.`, this.exportConfig.context);
                     return masterLocalObj;
                 }
                 else if (skip >= count) {
                     cli_utilities_1.log.error(`Master locale not found in the stack ${this.exportConfig.source_stack}. Please ensure that the stack has a master locale.`, this.exportConfig.context);
-                    cli_utilities_1.log.debug('Completed searching all locales without finding master locale', this.exportConfig.context);
+                    cli_utilities_1.log.debug('Completed search. Master locale not found.', this.exportConfig.context);
                     return;
                 }
                 else {
@@ -107,7 +107,7 @@ class ExportStack extends base_class_1.default {
                 }
             }
             else {
-                cli_utilities_1.log.debug('No locales found to process', this.exportConfig.context);
+                cli_utilities_1.log.debug('No locales found to process.', this.exportConfig.context);
             }
         })
             .catch((error) => {
@@ -117,26 +117,26 @@ class ExportStack extends base_class_1.default {
         });
     }
     async exportStack() {
-        cli_utilities_1.log.debug(`Starting stack export for: ${this.exportConfig.source_stack}`, this.exportConfig.context);
+        cli_utilities_1.log.debug(`Starting stack export for: '${this.exportConfig.source_stack}'...`, this.exportConfig.context);
         await utils_1.fsUtil.makeDirectory(this.stackFolderPath);
-        cli_utilities_1.log.debug(`Created stack directory at: ${this.stackFolderPath}`, this.exportConfig.context);
+        cli_utilities_1.log.debug(`Created stack directory at: '${this.stackFolderPath}'`, this.exportConfig.context);
         return this.stack
             .fetch()
             .then((resp) => {
             const stackFilePath = (0, node_path_1.resolve)(this.stackFolderPath, this.stackConfig.fileName);
-            cli_utilities_1.log.debug(`Writing stack data to: ${stackFilePath}`, this.exportConfig.context);
+            cli_utilities_1.log.debug(`Writing stack data to: '${stackFilePath}'`, this.exportConfig.context);
             utils_1.fsUtil.writeFile(stackFilePath, resp);
             cli_utilities_1.log.success(`Stack details exported successfully for stack ${this.exportConfig.source_stack}`, this.exportConfig.context);
-            cli_utilities_1.log.debug('Stack export completed successfully', this.exportConfig.context);
+            cli_utilities_1.log.debug('Stack export completed successfully.', this.exportConfig.context);
             return resp;
         })
             .catch((error) => {
-            cli_utilities_1.log.debug(`Error occurred while exporting stack: ${this.exportConfig.source_stack}`, this.exportConfig.context);
+            cli_utilities_1.log.debug(`An error occurred while exporting stack: '${this.exportConfig.source_stack}'.`, this.exportConfig.context);
             (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.exportConfig.context));
         });
     }
     async exportStackSettings() {
-        cli_utilities_1.log.info('Exporting stack settings', this.exportConfig.context);
+        cli_utilities_1.log.info('Exporting stack settings...', this.exportConfig.context);
         await utils_1.fsUtil.makeDirectory(this.stackFolderPath);
         return this.stack
             .settings()

package/lib/export/modules/taxonomies.d.ts

@@ -42,4 +42,5 @@ export default class ExportTaxonomies extends BaseClass {
      * Get all locales to export
      */
     getLocalesToExport(): string[];
+    private isLocalePlanLimitationError;
 }

package/lib/export/modules/taxonomies.js

@@ -22,12 +22,12 @@ class ExportTaxonomies extends base_class_1.default {
     }
     async start() {
         var _a;
-        cli_utilities_1.log.debug('Starting taxonomies export process...', this.exportConfig.context);
+        cli_utilities_1.log.debug('Starting export process for taxonomies...', this.exportConfig.context);
         //create taxonomies folder
         this.taxonomiesFolderPath = (0, node_path_1.resolve)(this.exportConfig.data, this.exportConfig.branchName || '', this.taxonomiesConfig.dirName);
-        cli_utilities_1.log.debug(`Taxonomies folder path: ${this.taxonomiesFolderPath}`, this.exportConfig.context);
+        cli_utilities_1.log.debug(`Taxonomies folder path: '${this.taxonomiesFolderPath}'`, this.exportConfig.context);
         await utils_1.fsUtil.makeDirectory(this.taxonomiesFolderPath);
-        cli_utilities_1.log.debug('Created taxonomies directory', this.exportConfig.context);
+        cli_utilities_1.log.debug('Created taxonomies directory.', this.exportConfig.context);
         const localesToExport = this.getLocalesToExport();
         cli_utilities_1.log.debug(`Will attempt to export taxonomies for ${localesToExport.length} locale(s): ${localesToExport.join(', ')}`, this.exportConfig.context);
         if (localesToExport.length === 0) {
@@ -38,7 +38,10 @@ class ExportTaxonomies extends base_class_1.default {
         const masterLocale = (_a = this.exportConfig.master_locale) === null || _a === void 0 ? void 0 : _a.code;
         await this.fetchTaxonomies(masterLocale, true);
         if (!this.isLocaleBasedExportSupported) {
-            cli_utilities_1.log.debug('Localization disabled, falling back to legacy export method', this.exportConfig.context);
+            this.taxonomies = {};
+            this.taxonomiesByLocale = {};
+            // Fetch taxonomies without locale parameter
+            await this.fetchTaxonomies();
             await this.exportTaxonomies();
             await this.writeTaxonomiesMetadata();
         }
@@ -122,10 +125,18 @@ class ExportTaxonomies extends base_class_1.default {
             }
             catch (error) {
                 cli_utilities_1.log.debug(`Error fetching taxonomies ${localeInfo}`, this.exportConfig.context);
-                (0, cli_utilities_1.handleAndLogError)(error, Object.assign(Object.assign({}, this.exportConfig.context), (localeCode && { locale: localeCode })));
-                if (checkLocaleSupport) {
+                if (checkLocaleSupport && this.isLocalePlanLimitationError(error)) {
+                    cli_utilities_1.log.debug('Taxonomy localization is not included in your plan. Falling back to non-localized export.', this.exportConfig.context);
                     this.isLocaleBasedExportSupported = false;
                 }
+                else if (checkLocaleSupport) {
+                    cli_utilities_1.log.debug('Locale-based taxonomy export not supported, will use legacy method', this.exportConfig.context);
+                    this.isLocaleBasedExportSupported = false;
+                }
+                else {
+                    // Log actual errors during normal fetch (not locale check)
+                    (0, cli_utilities_1.handleAndLogError)(error, Object.assign(Object.assign({}, this.exportConfig.context), (localeCode && { locale: localeCode })));
+                }
                 // Break to avoid infinite retry loop on errors
                 break;
             }
@@ -234,5 +245,11 @@ class ExportTaxonomies extends base_class_1.default {
         cli_utilities_1.log.debug(`Total unique locales to export: ${localesToExport.length}`, this.exportConfig.context);
         return localesToExport;
     }
+    isLocalePlanLimitationError(error) {
+        var _a, _b;
+        return ((error === null || error === void 0 ? void 0 : error.status) === 403 &&
+            ((_b = (_a = error === null || error === void 0 ? void 0 : error.errors) === null || _a === void 0 ? void 0 : _a.taxonomies) === null || _b === void 0 ? void 0 : _b.some((msg) => msg.toLowerCase().includes('taxonomy localization') &&
+                msg.toLowerCase().includes('not included in your plan'))));
+    }
 }
 exports.default = ExportTaxonomies;

package/lib/export/modules-js/assets.js

@@ -240,7 +240,7 @@ module.exports = class ExportAssets {
         const assetVersionInfo = bucket || [];
         return new Promise((resolve, reject) => {
             if (self.assetDownloadRetry[uid + version] > self.assetDownloadRetryLimit) {
-                console.log('Reached max', self.assetDownloadRetry[uid + version]);
+                console.log('Reached the maximum limit.', self.assetDownloadRetry[uid + version]);
                 return reject(new Error('Asset Max download retry limit exceeded! ' + uid));
             }
             if (version <= 0) {
@@ -274,7 +274,7 @@ module.exports = class ExportAssets {
                 .catch((error) => {
                 log(self.config, error, 'error');
                 if (error.status === 408) {
-                    console.log('retrying', uid);
+                    console.log('Retrying...', uid);
                     // retrying when timeout
                     self.assetDownloadRetry[uid + version]
                         ? ++self.assetDownloadRetry[uid + version]
@@ -313,7 +313,7 @@ module.exports = class ExportAssets {
                         length: assetStreamRequest.headers['content-length'],
                     });
                     str.on('progress', (progressData) => {
-                        console.log(`${asset.filename}: ${Math.round(progressData.percentage)}%`);
+                        console.log(`${asset.filename}: ${Math.round(progressData.percentage)}% complete`);
                     });
                     assetStreamRequest.pipe(str).pipe(assetFileStream);
                 }

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

@@ -148,6 +148,12 @@ export default interface DefaultConfig {
             fileName: string;
             dependencies?: Modules[];
         };
+        'composable-studio': {
+            dirName: string;
+            fileName: string;
+            apiBaseUrl: string;
+            apiVersion: string;
+        };
         masterLocale: {
             dirName: string;
             fileName: string;

package/lib/types/index.d.ts

@@ -26,7 +26,7 @@ export interface Region {
     cda: string;
     uiHost: string;
 }
-export type Modules = 'stack' | 'assets' | 'locales' | 'environments' | 'extensions' | 'webhooks' | 'global-fields' | 'entries' | 'content-types' | 'custom-roles' | 'workflows' | 'labels' | 'marketplace-apps' | 'taxonomies' | 'personalize';
+export type Modules = 'stack' | 'assets' | 'locales' | 'environments' | 'extensions' | 'webhooks' | 'global-fields' | 'entries' | 'content-types' | 'custom-roles' | 'workflows' | 'labels' | 'marketplace-apps' | 'taxonomies' | 'personalize' | 'composable-studio';
 export type ModuleClassParams = {
     stackAPIClient: ReturnType<ContentstackClient['stack']>;
     exportConfig: ExportConfig;
@@ -96,6 +96,32 @@ export interface StackConfig {
     dependencies?: Modules[];
     limit?: number;
 }
+export interface ComposableStudioConfig {
+    dirName: string;
+    fileName: string;
+    apiBaseUrl: string;
+    apiVersion: string;
+}
+export interface ComposableStudioProject {
+    name: string;
+    description: string;
+    canvasUrl: string;
+    connectedStackApiKey: string;
+    contentTypeUid: string;
+    organizationUid: string;
+    settings: {
+        configuration: {
+            environment: string;
+            locale: string;
+        };
+    };
+    createdBy: string;
+    updatedBy: string;
+    deletedAt: boolean;
+    createdAt: string;
+    updatedAt: string;
+    uid: string;
+}
 export interface Context {
     command: string;
     module: string;

package/lib/utils/basic-login.js

@@ -26,7 +26,7 @@ const login = async (config) => {
             return config;
         }
         else {
-            cli_utilities_1.log.error(`Failed to login, Invalid credentials`, config.context);
+            cli_utilities_1.log.error(`Failed to log in!`, config.context);
             process.exit(1);
         }
     }

package/lib/utils/export-config-handler.js

@@ -16,14 +16,14 @@ const setupConfig = async (exportCmdFlags) => {
     cli_utilities_1.log.debug('Setting up export configuration');
     // setup the config
     if (exportCmdFlags['config']) {
-        cli_utilities_1.log.debug('Loading external configuration file', { configFile: exportCmdFlags['config'] });
+        cli_utilities_1.log.debug('Loading external configuration file...', { configFile: exportCmdFlags['config'] });
         const externalConfig = await (0, file_helper_1.readFile)(exportCmdFlags['config']);
         config = merge_1.default.recursive(config, externalConfig);
     }
     config.exportDir = (0, cli_utilities_1.sanitizePath)(exportCmdFlags['data'] || exportCmdFlags['data-dir'] || config.data || (await (0, interactive_1.askExportDir)()));
     const pattern = /[*$%#<>{}!&?]/g;
     if (pattern.test(config.exportDir)) {
-        cli_utilities_1.cliux.print(`\nPlease add a directory path without any of the special characters: (*,&,{,},[,],$,%,<,>,?,!)`, {
+        cli_utilities_1.cliux.print(`\nPlease enter a directory path without any special characters: (*,&,{,},[,],$,%,<,>,?,!)`, {
             color: 'yellow',
         });
         config.exportDir = (0, cli_utilities_1.sanitizePath)(await (0, interactive_1.askExportDir)());
@@ -40,7 +40,7 @@ const setupConfig = async (exportCmdFlags) => {
         config.apiKey = apiKey;
         authenticationMethod = 'Management Token';
         if (!config.management_token) {
-            cli_utilities_1.log.debug('Management token not found for alias', { alias: managementTokenAlias });
+            cli_utilities_1.log.debug('Management token not found for alias!', { alias: managementTokenAlias });
             throw new Error(`No management token found on given alias ${managementTokenAlias}`);
         }
         cli_utilities_1.log.debug('Management token configuration successful');
@@ -73,7 +73,7 @@ const setupConfig = async (exportCmdFlags) => {
             config.apiKey =
                 exportCmdFlags['stack-uid'] || exportCmdFlags['stack-api-key'] || config.source_stack || (await (0, interactive_1.askAPIKey)());
             if (typeof config.apiKey !== 'string') {
-                cli_utilities_1.log.debug('Invalid API key received', { apiKey: config.apiKey });
+                cli_utilities_1.log.debug('Invalid API key received!', { apiKey: config.apiKey });
                 throw new Error('Invalid API key received');
             }
         }
@@ -121,7 +121,7 @@ const setupConfig = async (exportCmdFlags) => {
     }
     // Add authentication details to config for context tracking
     config.authenticationMethod = authenticationMethod;
-    cli_utilities_1.log.debug('Export configuration setup completed', Object.assign({}, config));
+    cli_utilities_1.log.debug('Export configuration setup completed.', Object.assign({}, config));
     return config;
 };
 exports.default = setupConfig;

package/lib/utils/file-helper.js

@@ -51,7 +51,7 @@ const readLargeFile = function (filePath, options = {}) {
                 resolve(data);
             });
             parseStream.on('error', (error) => {
-                console.log('error', error);
+                console.log('Error', error);
                 reject(error);
             });
             readStream.pipe(parseStream);

package/messages/index.json

@@ -57,6 +57,12 @@
 "MARKETPLACE_APP_CONFIG_EXPORT_FAILED": "Failed to export configuration for app '%s'",
 "MARKETPLACE_APP_MANIFEST_EXPORT_FAILED": "Failed to export manifest for app '%s'",
 
+"COMPOSABLE_STUDIO_EXPORT_START": "Starting Composable Studio project export...",
+"COMPOSABLE_STUDIO_NOT_FOUND": "No Composable Studio project found for this stack",
+"COMPOSABLE_STUDIO_EXPORT_COMPLETE": "Successfully exported Composable Studio project '%s'",
+"COMPOSABLE_STUDIO_EXPORT_FAILED": "Failed to export Composable Studio project: %s",
+"COMPOSABLE_STUDIO_AUTH_REQUIRED": "To export Composable Studio projects, you must be logged in",
+
 "ENTRIES_EXPORT_COMPLETE": "Successfully exported entries (Content Type: %s, Locale: %s)",
 "ENTRIES_EXPORT_SUCCESS": "All entries exported successfully",
 "ENTRIES_VERSIONED_EXPORT_SUCCESS": "Successfully exported versioned entry (Content Type: %s, UID: %s, Locale: %s)",

package/oclif.manifest.json

@@ -83,7 +83,7 @@
         },
         "module": {
           "char": "m",
-          "description": "[optional] Specific module name. If not specified, the export command will export all the modules to the stack. The available modules are assets, content-types, entries, environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, and taxonomies.",
+          "description": "[optional] Specific module name. If not specified, the export command will export all the modules to the stack. The available modules are assets, content-types, entries, environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, taxonomies, and composable-studio.",
           "name": "module",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -159,5 +159,5 @@
       ]
     }
   },
-  "version": "1.21.0"
+  "version": "1.22.0"
 }

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@contentstack/cli-cm-export",
   "description": "Contentstack CLI plugin to export content from stack",
-  "version": "1.21.0",
+  "version": "1.22.0",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "~1.6.1",
-    "@contentstack/cli-variants": "~1.3.4",
+    "@contentstack/cli-command": "~1.7.0",
     "@oclif/core": "^4.3.3",
-    "@contentstack/cli-utilities": "~1.14.4",
+    "@contentstack/cli-variants": "~1.3.5",
+    "@contentstack/cli-utilities": "~1.15.0",
     "async": "^3.2.6",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",
@@ -21,8 +21,8 @@
     "winston": "^3.17.0"
   },
   "devDependencies": {
-    "@contentstack/cli-auth": "~1.6.1",
-    "@contentstack/cli-config": "~1.15.1",
+    "@contentstack/cli-auth": "~1.6.2",
+    "@contentstack/cli-config": "~1.15.3",
     "@contentstack/cli-dev-dependencies": "~1.3.1",
     "@oclif/plugin-help": "^6.2.28",
     "@oclif/test": "^4.1.13",