@contentstack/cli-cm-export 2.0.0-beta.13 → 2.0.0-beta.14

package/README.md

@@ -48,7 +48,7 @@ $ npm install -g @contentstack/cli-cm-export
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-export/2.0.0-beta.13 linux-x64 node-v22.22.1
+@contentstack/cli-cm-export/2.0.0-beta.14 linux-x64 node-v22.22.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/config/index.js

@@ -201,6 +201,7 @@ const config = {
         stack: {
             dirName: 'stack',
             fileName: 'stack.json',
+            invalidKeys: ['SYS_ACL', 'user_uids', 'owner_uid', 'description', 'master_key'],
         },
         dependency: {
             entries: ['stack', 'locales', 'content-types'],

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

@@ -8,6 +8,16 @@ export default class ExportStack extends BaseClass {
     start(): Promise<void>;
     getStack(): Promise<any>;
     getLocales(skip?: number): Promise<any>;
-    exportStack(): Promise<any>;
+    /**
+     * Reuse stack snapshot from `getStack()` when present so we do not call `stack.fetch()` twice
+     * (same GET /stacks payload as writing stack.json). Falls back to `this.stack.fetch()` otherwise.
+     */
+    exportStack(preloadedStack?: Record<string, any> | null): Promise<any>;
+    private isStackFetchPayload;
+    /**
+     * Management-token exports cannot use Stack CMA endpoints for full metadata; write api_key from config only.
+     */
+    private writeStackJsonFromConfigApiKeyOnly;
+    private persistStackJsonPayload;
     exportStackSettings(): Promise<any>;
 }

package/lib/export/modules/stack.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const find_1 = tslib_1.__importDefault(require("lodash/find"));
+const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
 const node_path_1 = require("node:path");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const constants_1 = require("../../constants");
@@ -17,35 +18,31 @@ class ExportStack extends base_class_1.default {
         this.currentModuleName = utils_1.MODULE_NAMES[utils_1.MODULE_CONTEXTS.STACK];
     }
     async start() {
+        var _a;
         try {
             cli_utilities_1.log.debug('Starting stack export process...', this.exportConfig.context);
-            // Initial analysis with loading spinner
+            // Initial analysis with loading spinner (skip getStack when using management token — no SDK snapshot)
             const [stackData] = await this.withLoadingSpinner('STACK: Analyzing stack configuration...', async () => {
-                const stackData = (0, cli_utilities_1.isAuthenticated)() ? await this.getStack() : null;
+                const stackData = this.exportConfig.management_token || !(0, cli_utilities_1.isAuthenticated)() ? null : await this.getStack();
                 return [stackData];
             });
             // Create nested progress manager
             const progress = this.createNestedProgress(this.currentModuleName);
-            // 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);
-                this.exportConfig.org_uid = stackData.org_uid;
+            const orgUid = (_a = stackData === null || stackData === void 0 ? void 0 : stackData.org_uid) !== null && _a !== void 0 ? _a : stackData === null || stackData === void 0 ? void 0 : stackData.organization_uid;
+            if (orgUid) {
+                cli_utilities_1.log.debug(`Found organization UID: '${orgUid}'.`, this.exportConfig.context);
+                this.exportConfig.org_uid = orgUid;
                 this.exportConfig.sourceStackName = stackData.name;
                 cli_utilities_1.log.debug(`Set source stack name: ${stackData.name}`, this.exportConfig.context);
             }
             if (!this.exportConfig.management_token) {
                 progress.addProcess(utils_1.PROCESS_NAMES.STACK_SETTINGS, 1);
-                processCount++;
             }
+            progress.addProcess(utils_1.PROCESS_NAMES.STACK_DETAILS, 1);
             if (!this.exportConfig.preserveStackVersion && !this.exportConfig.hasOwnProperty('master_locale')) {
                 progress.addProcess(utils_1.PROCESS_NAMES.STACK_LOCALE, 1);
-                processCount++;
-            }
-            else if (this.exportConfig.preserveStackVersion) {
-                progress.addProcess(utils_1.PROCESS_NAMES.STACK_DETAILS, 1);
-                processCount++;
             }
+            let stackDetailsExportResult;
             // Execute processes
             if (!this.exportConfig.management_token) {
                 progress
@@ -53,9 +50,19 @@ class ExportStack extends base_class_1.default {
                     .updateStatus(utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.STACK_SETTINGS].EXPORTING, utils_1.PROCESS_NAMES.STACK_SETTINGS);
                 await this.exportStackSettings();
                 progress.completeProcess(utils_1.PROCESS_NAMES.STACK_SETTINGS, true);
+                progress
+                    .startProcess(utils_1.PROCESS_NAMES.STACK_DETAILS)
+                    .updateStatus(utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.STACK_DETAILS].EXPORTING, utils_1.PROCESS_NAMES.STACK_DETAILS);
+                stackDetailsExportResult = await this.exportStack(stackData);
+                progress.completeProcess(utils_1.PROCESS_NAMES.STACK_DETAILS, true);
             }
             else {
                 cli_utilities_1.log.info('Skipping stack settings export: Operation is not supported when using a management token.', this.exportConfig.context);
+                progress
+                    .startProcess(utils_1.PROCESS_NAMES.STACK_DETAILS)
+                    .updateStatus(utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.STACK_DETAILS].EXPORTING, utils_1.PROCESS_NAMES.STACK_DETAILS);
+                stackDetailsExportResult = await this.writeStackJsonFromConfigApiKeyOnly();
+                progress.completeProcess(utils_1.PROCESS_NAMES.STACK_DETAILS, true);
             }
             if (!this.exportConfig.preserveStackVersion && !this.exportConfig.hasOwnProperty('master_locale')) {
                 progress
@@ -71,13 +78,8 @@ class ExportStack extends base_class_1.default {
                 return masterLocale;
             }
             else if (this.exportConfig.preserveStackVersion) {
-                progress
-                    .startProcess(utils_1.PROCESS_NAMES.STACK_DETAILS)
-                    .updateStatus(utils_1.PROCESS_STATUS[utils_1.PROCESS_NAMES.STACK_DETAILS].EXPORTING, utils_1.PROCESS_NAMES.STACK_DETAILS);
-                const stackResult = await this.exportStack();
-                progress.completeProcess(utils_1.PROCESS_NAMES.STACK_DETAILS, true);
                 this.completeProgress(true);
-                return stackResult;
+                return stackDetailsExportResult;
             }
             else {
                 cli_utilities_1.log.debug('Locale locale already set, skipping locale fetch', this.exportConfig.context);
@@ -161,22 +163,30 @@ class ExportStack extends base_class_1.default {
             throw error;
         });
     }
-    async exportStack() {
+    /**
+     * Reuse stack snapshot from `getStack()` when present so we do not call `stack.fetch()` twice
+     * (same GET /stacks payload as writing stack.json). Falls back to `this.stack.fetch()` otherwise.
+     */
+    async exportStack(preloadedStack) {
+        var _a;
         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);
+        if (this.isStackFetchPayload(preloadedStack)) {
+            cli_utilities_1.log.debug('Reusing stack payload from analysis step (no extra stack.fetch).', this.exportConfig.context);
+            try {
+                return this.persistStackJsonPayload(preloadedStack);
+            }
+            catch (error) {
+                (_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));
+                return undefined;
+            }
+        }
         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);
-            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.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;
+            return this.persistStackJsonPayload(resp);
         })
             .catch((error) => {
             var _a;
@@ -185,6 +195,40 @@ class ExportStack extends base_class_1.default {
             (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.exportConfig.context));
         });
     }
+    isStackFetchPayload(data) {
+        return (typeof data === 'object' &&
+            data !== null &&
+            !Array.isArray(data) &&
+            ('api_key' in data || 'uid' in data));
+    }
+    /**
+     * Management-token exports cannot use Stack CMA endpoints for full metadata; write api_key from config only.
+     */
+    async writeStackJsonFromConfigApiKeyOnly() {
+        var _a;
+        if (!this.exportConfig.apiKey || typeof this.exportConfig.apiKey !== 'string') {
+            throw new Error('Stack API key is required to write stack.json when using a management token.');
+        }
+        cli_utilities_1.log.debug('Writing config-based stack.json (api_key only, no stack fetch).', this.exportConfig.context);
+        await utils_1.fsUtil.makeDirectory(this.stackFolderPath);
+        const payload = { api_key: this.exportConfig.apiKey };
+        const stackFilePath = (0, node_path_1.resolve)(this.stackFolderPath, this.stackConfig.fileName);
+        utils_1.fsUtil.writeFile(stackFilePath, payload);
+        (_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 identifier written to stack.json from config for stack ${this.exportConfig.apiKey}`, this.exportConfig.context);
+        return payload;
+    }
+    persistStackJsonPayload(resp) {
+        var _a, _b;
+        const sanitized = (0, omit_1.default)(resp, (_a = this.stackConfig.invalidKeys) !== null && _a !== void 0 ? _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);
+        utils_1.fsUtil.writeFile(stackFilePath, sanitized);
+        (_b = this.progressManager) === null || _b === void 0 ? void 0 : _b.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 sanitized;
+    }
     async exportStackSettings() {
         cli_utilities_1.log.info('Exporting stack settings...', this.exportConfig.context);
         await utils_1.fsUtil.makeDirectory(this.stackFolderPath);

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

@@ -132,6 +132,7 @@ export default interface DefaultConfig {
         stack: {
             dirName: string;
             fileName: string;
+            invalidKeys: string[];
             dependencies?: Modules[];
         };
         dependency: {

package/lib/types/index.d.ts

@@ -93,6 +93,7 @@ export interface CustomRoleConfig {
 export interface StackConfig {
     dirName: string;
     fileName: string;
+    invalidKeys: string[];
     dependencies?: Modules[];
     limit?: number;
 }

package/oclif.manifest.json

@@ -121,5 +121,5 @@
       ]
     }
   },
-  "version": "2.0.0-beta.13"
+  "version": "2.0.0-beta.14"
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@contentstack/cli-cm-export",
   "description": "Contentstack CLI plugin to export content from stack",
-  "version": "2.0.0-beta.13",
+  "version": "2.0.0-beta.14",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "~2.0.0-beta.4",
-    "@contentstack/cli-utilities": "~2.0.0-beta.4",
-    "@contentstack/cli-variants": "~2.0.0-beta.10",
+    "@contentstack/cli-command": "~2.0.0-beta.5",
+    "@contentstack/cli-utilities": "~2.0.0-beta.5",
+    "@contentstack/cli-variants": "~2.0.0-beta.11",
     "@oclif/core": "^4.8.0",
     "async": "^3.2.6",
     "big-json": "^3.2.0",