@contentstack/cli-cm-export 2.0.0-beta.15 → 2.0.0-beta.16

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.15 linux-x64 node-v22.22.2
+@contentstack/cli-cm-export/2.0.0-beta.16 linux-x64 node-v22.22.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/config/index.js

@@ -112,6 +112,11 @@ const config = {
             enableDownloadStatus: false,
             includeVersionedAssets: false,
         },
+        'asset-management': {
+            chunkFileSizeMb: 1,
+            apiConcurrency: 5,
+            downloadAssetsConcurrency: 5,
+        },
         content_types: {
             dirName: 'content_types',
             fileName: 'content_types.json',

package/lib/export/module-exporter.js

@@ -35,6 +35,7 @@ class ModuleExporter {
         }
     }
     async exportByBranches() {
+        var _a;
         let targetBranch;
         if (this.exportConfig.branchName) {
             // User specified a branch - export only that branch
@@ -62,8 +63,10 @@ class ModuleExporter {
             cli_utilities_1.log.success(`The content of branch ${targetBranch.uid} has been exported successfully!`, this.exportConfig.context);
         }
         catch (error) {
-            (0, cli_utilities_1.handleAndLogError)(error, Object.assign(Object.assign({}, this.exportConfig.context), { branch: targetBranch === null || targetBranch === void 0 ? void 0 : targetBranch.uid }), cli_utilities_1.messageHandler.parse('FAILED_EXPORT_CONTENT_BRANCH', { branch: targetBranch === null || targetBranch === void 0 ? void 0 : targetBranch.uid }));
-            throw new Error(cli_utilities_1.messageHandler.parse('FAILED_EXPORT_CONTENT_BRANCH', { branch: targetBranch === null || targetBranch === void 0 ? void 0 : targetBranch.uid }));
+            const originalMessage = (_a = error === null || error === void 0 ? void 0 : error.message) !== null && _a !== void 0 ? _a : '';
+            const errorMessage = originalMessage || cli_utilities_1.messageHandler.parse('FAILED_EXPORT_CONTENT_BRANCH', { branch: targetBranch === null || targetBranch === void 0 ? void 0 : targetBranch.uid });
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign(Object.assign({}, this.exportConfig.context), { branch: targetBranch === null || targetBranch === void 0 ? void 0 : targetBranch.uid }), errorMessage);
+            throw new Error(errorMessage);
         }
     }
     async export() {

package/lib/export/modules/assets.js

@@ -19,6 +19,7 @@ const cli_utilities_2 = require("@contentstack/cli-utilities");
 const constants_1 = require("../../constants");
 const config_1 = tslib_1.__importDefault(require("../../config"));
 const base_class_1 = tslib_1.__importDefault(require("./base-class"));
+const cli_asset_management_1 = require("@contentstack/cli-asset-management");
 const utils_1 = require("../../utils");
 class ExportAssets extends base_class_1.default {
     constructor({ exportConfig, stackAPIClient }) {
@@ -37,7 +38,50 @@ class ExportAssets extends base_class_1.default {
         };
     }
     async start() {
-        this.assetsRootPath = (0, node_path_1.resolve)((0, utils_1.getExportBasePath)(this.exportConfig), this.assetConfig.dirName);
+        var _a, _b, _c, _d;
+        const linkedWorkspaces = (_a = this.exportConfig.linkedWorkspaces) !== null && _a !== void 0 ? _a : [];
+        if (linkedWorkspaces.length > 0) {
+            const assetManagementUrl = (_b = this.exportConfig.region) === null || _b === void 0 ? void 0 : _b.assetManagementUrl;
+            if (!assetManagementUrl) {
+                (0, cli_utilities_2.handleAndLogError)(new Error('Asset Management URL is required for AM 2.0 export. Ensure your region is configured with assetManagementUrl.'), Object.assign(Object.assign({}, this.exportConfig.context), { message: 'Asset Management URL is required for AM 2.0 export. Ensure your region is configured with assetManagementUrl.' }));
+                this.completeProgressWithMessage({
+                    moduleName: 'Asset Management 2.0',
+                    customWarningMessage: 'Asset Management 2.0 export was skipped: assetManagementUrl is not configured. AM 2.0 assets will not be exported.',
+                    context: this.exportConfig.context,
+                });
+                cli_utilities_1.cliux.print('Asset Management URL is required for AM 2.0 export. Ensure your region is configured with assetManagementUrl.', { color: 'yellow' });
+                return;
+            }
+            cli_utilities_2.log.debug(`Exporting with AM 2.0: ${assetManagementUrl} (linked_workspaces from exportConfig)`, this.exportConfig.context);
+            this.exportConfig.org_uid = this.exportConfig.org_uid || (await (0, utils_1.getOrgUid)(this.exportConfig));
+            const progress = this.createNestedProgress(this.currentModuleName);
+            try {
+                const assetManagementModuleConfig = this.exportConfig.modules['asset-management'];
+                const exporter = new cli_asset_management_1.ExportSpaces({
+                    linkedWorkspaces,
+                    exportDir: this.exportConfig.exportDir,
+                    branchName: this.exportConfig.branchName || 'main',
+                    assetManagementUrl,
+                    org_uid: (_c = this.exportConfig.org_uid) !== null && _c !== void 0 ? _c : '',
+                    apiKey: this.exportConfig.apiKey,
+                    context: this.exportConfig.context,
+                    securedAssets: this.exportConfig.securedAssets,
+                    chunkFileSizeMb: assetManagementModuleConfig === null || assetManagementModuleConfig === void 0 ? void 0 : assetManagementModuleConfig.chunkFileSizeMb,
+                    apiConcurrency: assetManagementModuleConfig === null || assetManagementModuleConfig === void 0 ? void 0 : assetManagementModuleConfig.apiConcurrency,
+                    downloadAssetsConcurrency: assetManagementModuleConfig === null || assetManagementModuleConfig === void 0 ? void 0 : assetManagementModuleConfig.downloadAssetsConcurrency,
+                });
+                exporter.setParentProgressManager(progress);
+                await exporter.start();
+                this.completeProgressWithMessage();
+            }
+            catch (error) {
+                this.completeProgress(false, (_d = error === null || error === void 0 ? void 0 : error.message) !== null && _d !== void 0 ? _d : 'Asset Management export failed');
+                throw error;
+            }
+            return;
+        }
+        cli_utilities_2.log.debug('Using legacy asset export (no linked_workspaces in exportConfig)', this.exportConfig.context);
+        this.assetsRootPath = (0, node_path_1.resolve)(this.exportConfig.exportDir, this.exportConfig.branchName || '', (this.assetsRootPath = (0, node_path_1.resolve)((0, utils_1.getExportBasePath)(this.exportConfig), this.assetConfig.dirName)));
         cli_utilities_2.log.debug(`Assets root path resolved to: ${this.assetsRootPath}`, this.exportConfig.context);
         cli_utilities_2.log.debug('Fetching assets and folders count...', this.exportConfig.context);
         // NOTE step 1: Get assets and it's folder count in parallel

package/lib/export/modules/stack.js

@@ -196,10 +196,7 @@ class ExportStack extends base_class_1.default {
         });
     }
     isStackFetchPayload(data) {
-        return (typeof data === 'object' &&
-            data !== null &&
-            !Array.isArray(data) &&
-            ('api_key' in data || 'uid' in 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.
@@ -234,13 +231,17 @@ class ExportStack extends base_class_1.default {
         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, constants_1.PATH_CONSTANTS.FILES.SETTINGS), resp);
+            .then(async (resp) => {
+            var _a, _b;
+            const linked = await (0, utils_1.getLinkedWorkspacesForBranch)(this.stack, this.exportConfig.branchName || 'main', this.exportConfig.context);
+            const settings = Object.assign(Object.assign({}, resp), { am_v2: Object.assign(Object.assign({}, ((_a = resp.am_v2) !== null && _a !== void 0 ? _a : {})), { linked_workspaces: linked }) });
+            utils_1.fsUtil.writeFile((0, node_path_1.resolve)(this.stackFolderPath, constants_1.PATH_CONSTANTS.FILES.SETTINGS), settings);
+            this.exportConfig.linkedWorkspaces = linked;
             // 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);
+            (_b = this.progressManager) === null || _b === void 0 ? void 0 : _b.tick(true, 'stack settings', null, utils_1.PROCESS_NAMES.STACK_SETTINGS);
+            cli_utilities_1.log.debug(`Included ${linked.length} linked workspace(s) in settings`, this.exportConfig.context);
             cli_utilities_1.log.success('Exported stack settings successfully!', this.exportConfig.context);
-            return resp;
+            return settings;
         })
             .catch((error) => {
             var _a;

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

@@ -84,6 +84,15 @@ export default interface DefaultConfig {
             includeVersionedAssets: boolean;
             dependencies?: Modules[];
         };
+        'asset-management': {
+            /** Passed to FsUtility chunkFileSize (MB) when writing chunked export JSON. */
+            chunkFileSizeMb: number;
+            /** Shared export concurrency fallback used by AM 2.0 export. */
+            apiConcurrency: number;
+            /** Parallel downloads per AM workspace export. */
+            downloadAssetsConcurrency: number;
+            dependencies?: Modules[];
+        };
         content_types: {
             dirName: string;
             fileName: string;

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

@@ -34,6 +34,11 @@ export default interface ExportConfig extends DefaultConfig {
     skipStackSettings?: boolean;
     skipDependencies?: boolean;
     authenticationMethod?: string;
+    linkedWorkspaces?: Array<{
+        uid: string;
+        space_uid: string;
+        is_default: boolean;
+    }>;
 }
 type branch = {
     uid: string;

package/lib/types/index.d.ts

@@ -25,6 +25,7 @@ export interface Region {
     cma: string;
     cda: string;
     uiHost: string;
+    assetManagementUrl?: string;
 }
 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 = {

package/lib/utils/constants.d.ts

@@ -2,6 +2,9 @@ export declare const PROCESS_NAMES: {
     readonly ASSET_FOLDERS: "Folders";
     readonly ASSET_METADATA: "Metadata";
     readonly ASSET_DOWNLOADS: "Downloads";
+    /** Used when Assets module runs Asset Management 2.0 path (spaces, metadata, folders, assets, downloads). */
+    readonly ASSET_MANAGEMENT_SPACES: "Spaces & assets";
+    readonly ASSET_MANAGEMENT_EXPORT: "Asset Management 2.0";
     readonly FETCH_ROLES: "Fetch Roles";
     readonly FETCH_LOCALES: "Fetch Locales";
     readonly PROCESS_MAPPINGS: "Process Mappings";
@@ -23,6 +26,7 @@ export declare const PROCESS_NAMES: {
 };
 export declare const MODULE_CONTEXTS: {
     readonly ASSETS: "assets";
+    readonly ASSET_MANAGEMENT: "asset-management";
     readonly CONTENT_TYPES: "content-types";
     readonly CUSTOM_ROLES: "custom-roles";
     readonly ENTRIES: "entries";
@@ -40,6 +44,7 @@ export declare const MODULE_CONTEXTS: {
 };
 export declare const MODULE_NAMES: {
     readonly assets: "Assets";
+    readonly "asset-management": "Asset Management 2.0";
     readonly "content-types": "Content Types";
     readonly "custom-roles": "Custom Roles";
     readonly entries: "Entries";
@@ -69,6 +74,14 @@ export declare const PROCESS_STATUS: {
         DOWNLOADING: string;
         FAILED: string;
     };
+    "Spaces & assets": {
+        EXPORTING: string;
+        FAILED: string;
+    };
+    "Asset Management 2.0": {
+        EXPORTING: string;
+        FAILED: string;
+    };
     "Fetch Roles": {
         FETCHING: string;
         FAILED: string;

package/lib/utils/constants.js

@@ -6,6 +6,10 @@ exports.PROCESS_NAMES = {
     ASSET_FOLDERS: 'Folders',
     ASSET_METADATA: 'Metadata',
     ASSET_DOWNLOADS: 'Downloads',
+    /** Used when Assets module runs Asset Management 2.0 path (spaces, metadata, folders, assets, downloads). */
+    ASSET_MANAGEMENT_SPACES: 'Spaces & assets',
+    // Asset Management 2.0 module
+    ASSET_MANAGEMENT_EXPORT: 'Asset Management 2.0',
     // Custom Roles module
     FETCH_ROLES: 'Fetch Roles',
     FETCH_LOCALES: 'Fetch Locales',
@@ -33,6 +37,7 @@ exports.PROCESS_NAMES = {
 };
 exports.MODULE_CONTEXTS = {
     ASSETS: 'assets',
+    ASSET_MANAGEMENT: 'asset-management',
     CONTENT_TYPES: 'content-types',
     CUSTOM_ROLES: 'custom-roles',
     ENTRIES: 'entries',
@@ -51,6 +56,7 @@ exports.MODULE_CONTEXTS = {
 // Display names for modules to avoid scattering user-facing strings
 exports.MODULE_NAMES = {
     [exports.MODULE_CONTEXTS.ASSETS]: 'Assets',
+    [exports.MODULE_CONTEXTS.ASSET_MANAGEMENT]: 'Asset Management 2.0',
     [exports.MODULE_CONTEXTS.CONTENT_TYPES]: 'Content Types',
     [exports.MODULE_CONTEXTS.CUSTOM_ROLES]: 'Custom Roles',
     [exports.MODULE_CONTEXTS.ENTRIES]: 'Entries',
@@ -81,6 +87,15 @@ exports.PROCESS_STATUS = {
         FAILED: 'Failed to download asset:',
     },
     // Custom Roles
+    [exports.PROCESS_NAMES.ASSET_MANAGEMENT_SPACES]: {
+        EXPORTING: 'Exporting spaces & assets...',
+        FAILED: 'Failed to export spaces & assets.',
+    },
+    // Asset Management 2.0
+    [exports.PROCESS_NAMES.ASSET_MANAGEMENT_EXPORT]: {
+        EXPORTING: 'Exporting...',
+        FAILED: 'Asset Management export failed.',
+    },
     [exports.PROCESS_NAMES.FETCH_ROLES]: {
         FETCHING: 'Fetching custom roles...',
         FAILED: 'Failed to fetch custom roles.',

package/lib/utils/get-linked-workspaces.d.ts

@@ -0,0 +1,13 @@
+import type { LinkedWorkspace } from '@contentstack/cli-asset-management';
+/** Stack client with branch().fetch() for CMA branch details */
+type StackWithBranch = {
+    branch: (name: string) => {
+        fetch: (params?: Record<string, unknown>) => Promise<unknown>;
+    };
+};
+/**
+ * Fetch branch details with include_settings: true and return linked workspaces (am_v2).
+ * Reused by stack export (included in settings.json) and asset-management module.
+ */
+export declare function getLinkedWorkspacesForBranch(stack: StackWithBranch, branchName: string, context?: Record<string, unknown>): Promise<LinkedWorkspace[]>;
+export {};

package/lib/utils/get-linked-workspaces.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLinkedWorkspacesForBranch = void 0;
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+/**
+ * Fetch branch details with include_settings: true and return linked workspaces (am_v2).
+ * Reused by stack export (included in settings.json) and asset-management module.
+ */
+async function getLinkedWorkspacesForBranch(stack, branchName, context) {
+    var _a, _b;
+    cli_utilities_1.log.debug(`Fetching branch details for: ${branchName}`, context);
+    try {
+        const branch = await stack.branch(branchName).fetch({ include_settings: true });
+        const linked = (_b = (_a = branch === null || branch === void 0 ? void 0 : branch.settings) === null || _a === void 0 ? void 0 : _a.am_v2) === null || _b === void 0 ? void 0 : _b.linked_workspaces;
+        if (!Array.isArray(linked)) {
+            cli_utilities_1.log.debug('No linked_workspaces in branch settings', context);
+            return [];
+        }
+        cli_utilities_1.log.info(`Found ${linked.length} linked workspace(s) for branch ${branchName}`, context);
+        return linked;
+    }
+    catch (error) {
+        const err = error;
+        if ((err === null || err === void 0 ? void 0 : err.status) === 412 || (err === null || err === void 0 ? void 0 : err.errorCode) === 412) {
+            cli_utilities_1.log.warn('Branch settings not found, please check if the branches are enabled in your stack', context);
+            return [];
+        }
+        (0, cli_utilities_1.handleAndLogError)(error, context, 'Failed to fetch branch settings');
+        return [];
+    }
+}
+exports.getLinkedWorkspacesForBranch = getLinkedWorkspacesForBranch;

package/lib/utils/index.d.ts

@@ -9,4 +9,5 @@ export { log, unlinkFileLogger } from './logger';
 export { default as login } from './basic-login';
 export * from './common-helper';
 export * from './marketplace-app-helper';
+export { getLinkedWorkspacesForBranch } from './get-linked-workspaces';
 export { MODULE_CONTEXTS, MODULE_NAMES, PROCESS_NAMES, PROCESS_STATUS } from './constants';

package/lib/utils/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PROCESS_STATUS = exports.PROCESS_NAMES = exports.MODULE_NAMES = exports.MODULE_CONTEXTS = exports.login = exports.unlinkFileLogger = exports.log = exports.getExportBasePath = exports.setupExportDir = exports.setupBranches = exports.fsUtil = exports.fileHelper = exports.setupExportConfig = exports.interactive = void 0;
+exports.PROCESS_STATUS = exports.PROCESS_NAMES = exports.MODULE_NAMES = exports.MODULE_CONTEXTS = exports.getLinkedWorkspacesForBranch = exports.login = exports.unlinkFileLogger = exports.log = exports.getExportBasePath = exports.setupExportDir = exports.setupBranches = exports.fsUtil = exports.fileHelper = exports.setupExportConfig = exports.interactive = void 0;
 const tslib_1 = require("tslib");
 exports.interactive = tslib_1.__importStar(require("./interactive"));
 var export_config_handler_1 = require("./export-config-handler");
@@ -21,6 +21,8 @@ var basic_login_1 = require("./basic-login");
 Object.defineProperty(exports, "login", { enumerable: true, get: function () { return tslib_1.__importDefault(basic_login_1).default; } });
 tslib_1.__exportStar(require("./common-helper"), exports);
 tslib_1.__exportStar(require("./marketplace-app-helper"), exports);
+var get_linked_workspaces_1 = require("./get-linked-workspaces");
+Object.defineProperty(exports, "getLinkedWorkspacesForBranch", { enumerable: true, get: function () { return get_linked_workspaces_1.getLinkedWorkspacesForBranch; } });
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "MODULE_CONTEXTS", { enumerable: true, get: function () { return constants_1.MODULE_CONTEXTS; } });
 Object.defineProperty(exports, "MODULE_NAMES", { enumerable: true, get: function () { return constants_1.MODULE_NAMES; } });

package/lib/utils/progress-strategy-registry.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const cli_asset_management_1 = require("@contentstack/cli-asset-management");
 const constants_1 = require("./constants");
 /**
  * Progress Strategy Registrations for Export Modules
@@ -22,6 +23,23 @@ try {
                 failures: downloadsProcess.failureCount,
             };
         }
+        // Asset Management 2.0 path (process name owned by AM package)
+        const amProcess = processes.get(cli_asset_management_1.AM_MAIN_PROCESS_NAME);
+        if (amProcess) {
+            return {
+                total: amProcess.total,
+                success: amProcess.successCount,
+                failures: amProcess.failureCount,
+            };
+        }
+        const spacesProcess = processes.get(constants_1.PROCESS_NAMES.ASSET_MANAGEMENT_SPACES);
+        if (spacesProcess) {
+            return {
+                total: spacesProcess.total,
+                success: spacesProcess.successCount,
+                failures: spacesProcess.failureCount,
+            };
+        }
         // Fallback to metadata process if downloads don't exist
         const metadataProcess = processes.get(constants_1.PROCESS_NAMES.ASSET_METADATA);
         if (metadataProcess) {

package/oclif.manifest.json

@@ -121,5 +121,5 @@
       ]
     }
   },
-  "version": "2.0.0-beta.15"
+  "version": "2.0.0-beta.16"
 }

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@contentstack/cli-cm-export",
   "description": "Contentstack CLI plugin to export content from stack",
-  "version": "2.0.0-beta.15",
+  "version": "2.0.0-beta.16",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
     "@contentstack/cli-command": "~2.0.0-beta.6",
     "@contentstack/cli-utilities": "~2.0.0-beta.7",
     "@contentstack/cli-variants": "~2.0.0-beta.12",
+    "@contentstack/cli-asset-management": "~1.0.0-beta.0",
     "@oclif/core": "^4.8.0",
     "async": "^3.2.6",
     "big-json": "^3.2.0",
@@ -18,14 +19,14 @@
     "mkdirp": "^1.0.4",
     "progress-stream": "^2.0.0",
     "promise-limit": "^2.7.0",
-    "winston": "^3.17.0"
+    "winston": "^3.19.0"
   },
   "devDependencies": {
     "@contentstack/cli-auth": "~2.0.0-beta.9",
     "@contentstack/cli-config": "~2.0.0-beta.5",
     "@contentstack/cli-dev-dependencies": "~2.0.0-beta.0",
     "@oclif/plugin-help": "^6.2.28",
-    "@oclif/test": "^4.1.13",
+    "@oclif/test": "^4.1.18",
     "@types/big-json": "^3.2.5",
     "@types/chai": "^4.3.11",
     "@types/mkdirp": "^1.0.2",
@@ -94,4 +95,4 @@
     }
   },
   "repository": "https://github.com/contentstack/cli"
-}
+}