@contentstack/cli-cm-export 2.0.0-beta.1 → 2.0.0-beta.10

package/lib/export/modules/stack.js

@@ -4,6 +4,7 @@ const tslib_1 = require("tslib");
 const find_1 = tslib_1.__importDefault(require("lodash/find"));
 const node_path_1 = require("node:path");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
+const constants_1 = require("../../constants");
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
 const utils_1 = require("../../utils");
 class ExportStack extends base_class_1.default {
@@ -11,7 +12,7 @@ class ExportStack extends base_class_1.default {
         super({ exportConfig, stackAPIClient });
         this.stackConfig = exportConfig.modules.stack;
         this.qs = { include_count: true };
-        this.stackFolderPath = (0, node_path_1.resolve)(this.exportConfig.data, this.exportConfig.branchName || '', this.stackConfig.dirName);
+        this.stackFolderPath = (0, node_path_1.resolve)(this.exportConfig.exportDir, this.exportConfig.branchName || '', this.stackConfig.dirName);
         this.exportConfig.context.module = utils_1.MODULE_CONTEXTS.STACK;
         this.currentModuleName = utils_1.MODULE_NAMES[utils_1.MODULE_CONTEXTS.STACK];
     }
@@ -28,7 +29,7 @@ class ExportStack extends base_class_1.default {
             // Add processes based on configuration
             let processCount = 0;
             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);
@@ -81,8 +82,7 @@ class ExportStack extends base_class_1.default {
             else {
                 cli_utilities_1.log.debug('Locale locale already set, skipping locale fetch', this.exportConfig.context);
             }
-            this.completeProgress(true);
-            cli_utilities_1.log.success('Stack export completed successfully', this.exportConfig.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             cli_utilities_1.log.debug('Error occurred during stack export', this.exportConfig.context);
@@ -92,30 +92,30 @@ class ExportStack extends base_class_1.default {
         }
     }
     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.apiKey}'...`, 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 })
+            .stack({ api_key: this.exportConfig.apiKey })
             .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.apiKey}'.`, 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.apiKey}'.`, 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)
@@ -123,7 +123,7 @@ class ExportStack extends base_class_1.default {
             .then(async (data) => {
             var _a;
             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);
                 // Track progress for each locale processed
@@ -131,17 +131,17 @@ class ExportStack extends base_class_1.default {
                 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(`Locale 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.error(`Locale locale not found in the stack ${this.exportConfig.apiKey}. Please ensure that the stack has a master locale.`, this.exportConfig.context);
+                    cli_utilities_1.log.debug('Completed search. Master locale not found.', this.exportConfig.context);
                     return;
                 }
                 else {
@@ -150,49 +150,49 @@ 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) => {
             var _a;
-            cli_utilities_1.log.debug(`Error occurred while fetching locales for stack: ${this.exportConfig.source_stack}`, this.exportConfig.context);
+            cli_utilities_1.log.debug(`Error occurred while fetching locales for stack: ${this.exportConfig.apiKey}`, this.exportConfig.context);
             (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.tick(false, 'locale fetch', (error === null || error === void 0 ? void 0 : error.message) || utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.STACK_LOCALE].FAILED, utils_1.PROCESS_NAMES.STACK_LOCALE);
-            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.exportConfig.context), `Failed to fetch locales for stack ${this.exportConfig.source_stack}`);
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.exportConfig.context), `Failed to fetch locales for stack ${this.exportConfig.apiKey}`);
             throw error;
         });
     }
     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.apiKey}'...`, 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) => {
             var _a;
             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);
             // Track progress for stack export completion
-            (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.tick(true, `stack: ${this.exportConfig.source_stack}`, null, utils_1.PROCESS_NAMES.STACK_DETAILS);
-            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);
+            (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.tick(true, `stack: ${this.exportConfig.apiKey}`, null, utils_1.PROCESS_NAMES.STACK_DETAILS);
+            cli_utilities_1.log.success(`Stack details exported successfully for stack ${this.exportConfig.apiKey}`, this.exportConfig.context);
+            cli_utilities_1.log.debug('Stack export completed successfully.', this.exportConfig.context);
             return resp;
         })
             .catch((error) => {
             var _a;
-            cli_utilities_1.log.debug(`Error occurred while exporting stack: ${this.exportConfig.source_stack}`, this.exportConfig.context);
+            cli_utilities_1.log.debug(`Error occurred while exporting stack: ${this.exportConfig.apiKey}`, this.exportConfig.context);
             (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.tick(false, 'stack export', (error === null || error === void 0 ? void 0 : error.message) || utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.STACK_DETAILS].FAILED, utils_1.PROCESS_NAMES.STACK_DETAILS);
             (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()
             .then((resp) => {
             var _a;
-            utils_1.fsUtil.writeFile((0, node_path_1.resolve)(this.stackFolderPath, 'settings.json'), resp);
+            utils_1.fsUtil.writeFile((0, node_path_1.resolve)(this.stackFolderPath, constants_1.PATH_CONSTANTS.FILES.SETTINGS), resp);
             // Track progress for stack settings completion
             (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.tick(true, 'stack settings', null, utils_1.PROCESS_NAMES.STACK_SETTINGS);
             cli_utilities_1.log.success('Exported stack settings successfully!', this.exportConfig.context);

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

@@ -2,21 +2,65 @@ import BaseClass from './base-class';
 import { ModuleClassParams } from '../../types';
 export default class ExportTaxonomies extends BaseClass {
     private taxonomies;
+    private taxonomiesByLocale;
     private taxonomiesConfig;
+    private isLocaleBasedExportSupported;
     private qs;
     taxonomiesFolderPath: string;
+    private localesFilePath;
     constructor({ exportConfig, stackAPIClient }: ModuleClassParams);
     start(): Promise<void>;
     /**
-     * Fetch in the provided stack
-     * @param {number} skip
-     * @returns {Promise<any>}
+     * Initialize export setup (create directories, get initial count)
      */
-    getAllTaxonomies(skip?: number): Promise<any>;
-    sanitizeTaxonomiesAttribs(taxonomies: Record<string, any>[]): void;
+    private initializeExport;
     /**
-     * Export all taxonomies details using metadata(this.taxonomies) and write it into respective <taxonomy-uid>.json file
-     * @returns {Promise<any>}
+     * Setup progress manager with processes
      */
-    exportTaxonomies(): Promise<any>;
+    private setupProgress;
+    /**
+     * Determine if locale-based export is supported
+     */
+    private determineExportStrategy;
+    /**
+     * Fetch all taxonomies based on export strategy
+     */
+    private fetchAllTaxonomies;
+    /**
+     * Export all taxonomies with detailed information
+     */
+    private exportAllTaxonomies;
+    /**
+     * Process and export taxonomies for a specific locale
+     */
+    processLocaleExport(localeCode: string): Promise<void>;
+    /**
+     * Write taxonomies metadata file
+     */
+    writeTaxonomiesMetadata(): Promise<void>;
+    /**
+     * Fetch taxonomies
+     *
+     * @async
+     * @param {?string} [localeCode]
+     * @param {boolean} [checkLocaleSupport=false]
+     * @returns {Promise<void>}
+     */
+    fetchTaxonomies(localeCode?: string, checkLocaleSupport?: boolean): Promise<void>;
+    /**
+     * remove invalid keys and write data into taxonomies
+     * @function sanitizeTaxonomiesAttribs
+     * @param {Record<string, string>[]} taxonomies
+     * @param {?string} [localeCode]
+     */
+    sanitizeTaxonomiesAttribs(taxonomies: Record<string, string>[], localeCode?: string): void;
+    /**
+     * Export taxonomies - supports both locale-based and legacy export
+     */
+    exportTaxonomies(localeCode?: string): Promise<void>;
+    /**
+     * Get all locales to export
+     */
+    getLocalesToExport(): string[];
+    private isLocalePlanLimitationError;
 }