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

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Contentstack
+Copyright (c) 2026 Contentstack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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.1 linux-x64 node-v22.20.0
+@contentstack/cli-cm-export/2.0.0-beta.11 linux-x64 node-v22.22.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -59,93 +59,39 @@ USAGE
 # Commands
 
 <!-- commands -->
-* [`csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets)
-* [`csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets)
+* [`csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`](#csdx-cmstacksexport---config-value---stack-api-key-value---data-dir-value---alias-value---module-value---content-types-value---branch-value---secured-assets)
 
-## `csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`
+## `csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`
 
 Export content from a stack
 
 ```
 USAGE
-  $ csdx cm:export cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>]
-    [--content-types <value>] [--branch <value>] [--secured-assets]
+  $ csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>]
+    [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]
 
 FLAGS
-  -B, --branch=<value>            [optional] The name of the branch where you want to export your content. If you don't
-                                  mention the branch name, then by default the content will be exported from all the
-                                  branches of your stack.
   -a, --alias=<value>             The management token alias of the source stack from which you will export content.
   -c, --config=<value>            [optional] Path of the config
   -d, --data-dir=<value>          The path or the location in your file system to store the exported content. For e.g.,
                                   ./content
   -k, --stack-api-key=<value>     API Key of the source stack
-  -m, --module=<value>            [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.
-  -t, --content-types=<value>...  [optional]  The UID of the content type(s) whose content you want to export. In case
-                                  of multiple content types, specify the IDs separated by spaces.
   -y, --yes                       [optional] Force override all Marketplace prompts.
-      --branch-alias=<value>      (Optional) The alias of the branch from which you want to export content.
-      --secured-assets            [optional] Use this flag for assets that are secured.
-
-DESCRIPTION
-  Export content from a stack
-
-ALIASES
-  $ csdx cm:export
-
-EXAMPLES
-  $ csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
-
-  $ csdx cm:stacks:export --config <path/to/config/dir>
-
-  $ csdx cm:stacks:export --alias <management_token_alias>
-
-  $ csdx cm:stacks:export --alias <management_token_alias> --data-dir <path/to/export/destination/dir>
-
-  $ csdx cm:stacks:export --alias <management_token_alias> --config <path/to/config/file>
-
-  $ csdx cm:stacks:export --module <single module name>
-
-  $ csdx cm:stacks:export --branch [optional] branch name
-```
-
-## `csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`
-
-Export content from a stack
-
-```
-USAGE
-  $ csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types
-    <value>] [--branch <value>] [--secured-assets]
-
-FLAGS
-  -B, --branch=<value>            [optional] The name of the branch where you want to export your content. If you don't
+      --branch=<value>            [optional] The name of the branch where you want to export your content. If you don't
                                   mention the branch name, then by default the content will be exported from all the
                                   branches of your stack.
-  -a, --alias=<value>             The management token alias of the source stack from which you will export content.
-  -c, --config=<value>            [optional] Path of the config
-  -d, --data-dir=<value>          The path or the location in your file system to store the exported content. For e.g.,
-                                  ./content
-  -k, --stack-api-key=<value>     API Key of the source stack
-  -m, --module=<value>            [optional] Specific module name. If not specified, the export command will export all
+      --branch-alias=<value>      (Optional) The alias of the branch from which you want to export content.
+      --content-types=<value>...  [optional]  The UID of the content type(s) whose content you want to export. In case
+                                  of multiple content types, specify the IDs separated by spaces.
+      --module=<value>            [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.
-  -t, --content-types=<value>...  [optional]  The UID of the content type(s) whose content you want to export. In case
-                                  of multiple content types, specify the IDs separated by spaces.
-  -y, --yes                       [optional] Force override all Marketplace prompts.
-      --branch-alias=<value>      (Optional) The alias of the branch from which you want to export content.
+                                  workflows, custom-roles, taxonomies, and studio.
       --secured-assets            [optional] Use this flag for assets that are secured.
 
 DESCRIPTION
   Export content from a stack
 
-ALIASES
-  $ csdx cm:export
-
 EXAMPLES
   $ csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
 

package/lib/commands/cm/stacks/export.d.ts

@@ -5,7 +5,6 @@ export default class ExportCommand extends Command {
     static examples: string[];
     static usage: string;
     static flags: FlagInput;
-    static aliases: string[];
     run(): Promise<void>;
     private createExportContext;
     private assignExportConfig;

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

@@ -14,21 +14,21 @@ class ExportCommand extends cli_command_1.Command {
             // Prepare the context object
             const context = this.createExportContext(exportConfig.apiKey, exportConfig.authenticationMethod);
             exportConfig.context = Object.assign({}, context);
-            //log.info(`Using Cli Version: ${this.context?.cliVersion}`, exportConfig.context);
             // Assign exportConfig variables
             this.assignExportConfig(exportConfig);
-            exportDir = (0, cli_utilities_1.sanitizePath)(exportConfig.cliLogsPath || exportConfig.data || exportConfig.exportDir);
+            exportDir = (0, cli_utilities_1.sanitizePath)(exportConfig.cliLogsPath || exportConfig.exportDir);
             const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)(exportConfig);
             const moduleExporter = new export_1.ModuleExporter(managementAPIClient, exportConfig);
             await moduleExporter.start();
-            cli_utilities_1.log.success(`The content of the stack ${exportConfig.apiKey} has been exported successfully!`, exportConfig.context);
+            const sessionLogPath = (0, cli_utilities_1.getSessionLogPath)();
+            cli_utilities_1.log.success(`The content of the stack ${exportConfig.apiKey} has been exported successfully!`);
             cli_utilities_1.log.info(`The exported content has been stored at '${exportDir}'`, exportConfig.context);
-            cli_utilities_1.log.success(`The log has been stored at '${(0, cli_utilities_1.getLogPath)()}'`, exportConfig.context);
+            cli_utilities_1.log.success(`The log has been stored at '${sessionLogPath}'`, exportConfig.context);
             // Print comprehensive summary at the end
             if (!exportConfig.branches)
                 cli_utilities_1.CLIProgressManager.printGlobalSummary();
             if (!((_a = cli_utilities_1.configHandler.get('log')) === null || _a === void 0 ? void 0 : _a.showConsoleLogs)) {
-                cli_utilities_1.cliux.print(`The log has been stored at '${(0, cli_utilities_1.getLogPath)()}'`, { color: 'green' });
+                cli_utilities_1.cliux.print(`The log has been stored at '${sessionLogPath}'`, { color: 'green' });
             }
             // Clear progress module setting now that export is complete
             (0, cli_utilities_1.clearProgressModuleSetting)();
@@ -37,9 +37,10 @@ class ExportCommand extends cli_command_1.Command {
             // Clear progress module setting even on error
             (0, cli_utilities_1.clearProgressModuleSetting)();
             (0, cli_utilities_1.handleAndLogError)(error);
+            const sessionLogPath = (0, cli_utilities_1.getSessionLogPath)();
             if (!((_b = cli_utilities_1.configHandler.get('log')) === null || _b === void 0 ? void 0 : _b.showConsoleLogs)) {
                 cli_utilities_1.cliux.print(`Error: ${error}`, { color: 'red' });
-                cli_utilities_1.cliux.print(`The log has been stored at '${(0, cli_utilities_1.getLogPath)()}'`, { color: 'green' });
+                cli_utilities_1.cliux.print(`The log has been stored at '${sessionLogPath}'`, { color: 'green' });
             }
         }
     }
@@ -67,6 +68,9 @@ class ExportCommand extends cli_command_1.Command {
         if (this.personalizeUrl) {
             exportConfig.modules.personalize.baseURL[exportConfig.region.name] = this.personalizeUrl;
         }
+        if (this.composableStudioUrl) {
+            exportConfig.modules['composable-studio'].apiBaseUrl = this.composableStudioUrl;
+        }
     }
 }
 exports.default = ExportCommand;
@@ -80,27 +84,16 @@ ExportCommand.examples = [
     'csdx cm:stacks:export --module <single module name>',
     'csdx cm:stacks:export --branch [optional] branch name',
 ];
-ExportCommand.usage = 'cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]';
+ExportCommand.usage = 'cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]';
 ExportCommand.flags = {
     config: cli_utilities_1.flags.string({
         char: 'c',
         description: '[optional] Path of the config',
     }),
-    'stack-uid': cli_utilities_1.flags.string({
-        char: 's',
-        description: 'API key of the source stack',
-        hidden: true,
-        parse: (0, cli_utilities_1.printFlagDeprecation)(['-s', '--stack-uid'], ['-k', '--stack-api-key']),
-    }),
     'stack-api-key': cli_utilities_1.flags.string({
         char: 'k',
         description: 'API Key of the source stack',
     }),
-    data: cli_utilities_1.flags.string({
-        description: 'path or location to store the data',
-        hidden: true,
-        parse: (0, cli_utilities_1.printFlagDeprecation)(['--data'], ['--data-dir']),
-    }),
     'data-dir': cli_utilities_1.flags.string({
         char: 'd',
         description: 'The path or the location in your file system to store the exported content. For e.g., ./content',
@@ -109,33 +102,16 @@ ExportCommand.flags = {
         char: 'a',
         description: 'The management token alias of the source stack from which you will export content.',
     }),
-    'management-token-alias': cli_utilities_1.flags.string({
-        description: 'alias of the management token',
-        hidden: true,
-        parse: (0, cli_utilities_1.printFlagDeprecation)(['--management-token-alias'], ['-a', '--alias']),
-    }),
-    'auth-token': cli_utilities_1.flags.boolean({
-        char: 'A',
-        description: 'to use auth token',
-        hidden: true,
-        parse: (0, cli_utilities_1.printFlagDeprecation)(['-A', '--auth-token']),
-    }),
     module: cli_utilities_1.flags.string({
-        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.',
-        parse: (0, cli_utilities_1.printFlagDeprecation)(['-m'], ['--module']),
+        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 studio.',
     }),
     'content-types': cli_utilities_1.flags.string({
-        char: 't',
         description: '[optional]  The UID of the content type(s) whose content you want to export. In case of multiple content types, specify the IDs separated by spaces.',
         multiple: true,
-        parse: (0, cli_utilities_1.printFlagDeprecation)(['-t'], ['--content-types']),
     }),
     branch: cli_utilities_1.flags.string({
-        char: 'B',
         // default: 'main',
         description: "[optional] The name of the branch where you want to export your content. If you don't mention the branch name, then by default the content will be exported from all the branches of your stack.",
-        parse: (0, cli_utilities_1.printFlagDeprecation)(['-B'], ['--branch']),
         exclusive: ['branch-alias'],
     }),
     'branch-alias': cli_utilities_1.flags.string({
@@ -155,4 +131,3 @@ ExportCommand.flags = {
         hidden: true,
     }),
 };
-ExportCommand.aliases = ['cm:export'];

package/lib/config/index.js

@@ -39,6 +39,7 @@ const config = {
             'entries',
             'labels',
             'marketplace-apps',
+            'composable-studio',
         ],
         locales: {
             dirName: 'locales',
@@ -212,6 +213,12 @@ const config = {
             dirName: 'marketplace_apps',
             fileName: 'marketplace_apps.json',
         },
+        'composable-studio': {
+            dirName: 'composable_studio',
+            fileName: 'composable_studio.json',
+            apiBaseUrl: 'https://composable-studio-api.contentstack.com',
+            apiVersion: 'v1',
+        },
         taxonomies: {
             dirName: 'taxonomies',
             fileName: 'taxonomies.json',

package/lib/constants/index.d.ts

@@ -0,0 +1,57 @@
+export declare const PATH_CONSTANTS: {
+    /** Root mapper directory (contains module-specific mapper subdirs) */
+    readonly MAPPER: "mapper";
+    /** Common mapper file names */
+    readonly FILES: {
+        readonly SUCCESS: "success.json";
+        readonly FAILS: "fails.json";
+        readonly UID_MAPPING: "uid-mapping.json";
+        readonly URL_MAPPING: "url-mapping.json";
+        readonly UID_MAPPER: "uid-mapper.json";
+        readonly SCHEMA: "schema.json";
+        readonly SETTINGS: "settings.json";
+        readonly MODIFIED_SCHEMAS: "modified-schemas.json";
+        readonly UNIQUE_MAPPING: "unique-mapping.json";
+        readonly TAXONOMIES: "taxonomies.json";
+        readonly ENVIRONMENTS: "environments.json";
+        readonly PENDING_EXTENSIONS: "pending_extensions.js";
+        readonly PENDING_GLOBAL_FIELDS: "pending_global_fields.js";
+        readonly INDEX: "index.json";
+        readonly FOLDER_MAPPING: "folder-mapping.json";
+        readonly VERSIONED_ASSETS: "versioned-assets.json";
+    };
+    /** Module subdirectory names within mapper */
+    readonly MAPPER_MODULES: {
+        readonly ASSETS: "assets";
+        readonly ENTRIES: "entries";
+        readonly CONTENT_TYPES: "content_types";
+        readonly TAXONOMIES: "taxonomies";
+        readonly TAXONOMY_TERMS: "terms";
+        readonly GLOBAL_FIELDS: "global_fields";
+        readonly EXTENSIONS: "extensions";
+        readonly WORKFLOWS: "workflows";
+        readonly WEBHOOKS: "webhooks";
+        readonly LABELS: "labels";
+        readonly ENVIRONMENTS: "environments";
+        readonly MARKETPLACE_APPS: "marketplace_apps";
+        readonly CUSTOM_ROLES: "custom-roles";
+        readonly LANGUAGES: "languages";
+    };
+    /** Content directory names (used in both import and export) */
+    readonly CONTENT_DIRS: {
+        readonly ASSETS: "assets";
+        readonly ENTRIES: "entries";
+        readonly CONTENT_TYPES: "content_types";
+        readonly TAXONOMIES: "taxonomies";
+        readonly GLOBAL_FIELDS: "global_fields";
+        readonly EXTENSIONS: "extensions";
+        readonly WEBHOOKS: "webhooks";
+        readonly WORKFLOWS: "workflows";
+        readonly LABELS: "labels";
+        readonly ENVIRONMENTS: "environments";
+        readonly STACK: "stack";
+        readonly LOCALES: "locales";
+        readonly MARKETPLACE_APPS: "marketplace_apps";
+    };
+};
+export type PathConstants = typeof PATH_CONSTANTS;

package/lib/constants/index.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PATH_CONSTANTS = void 0;
+exports.PATH_CONSTANTS = {
+    /** Root mapper directory (contains module-specific mapper subdirs) */
+    MAPPER: 'mapper',
+    /** Common mapper file names */
+    FILES: {
+        SUCCESS: 'success.json',
+        FAILS: 'fails.json',
+        UID_MAPPING: 'uid-mapping.json',
+        URL_MAPPING: 'url-mapping.json',
+        UID_MAPPER: 'uid-mapper.json',
+        SCHEMA: 'schema.json',
+        SETTINGS: 'settings.json',
+        MODIFIED_SCHEMAS: 'modified-schemas.json',
+        UNIQUE_MAPPING: 'unique-mapping.json',
+        TAXONOMIES: 'taxonomies.json',
+        ENVIRONMENTS: 'environments.json',
+        PENDING_EXTENSIONS: 'pending_extensions.js',
+        PENDING_GLOBAL_FIELDS: 'pending_global_fields.js',
+        INDEX: 'index.json',
+        FOLDER_MAPPING: 'folder-mapping.json',
+        VERSIONED_ASSETS: 'versioned-assets.json',
+    },
+    /** Module subdirectory names within mapper */
+    MAPPER_MODULES: {
+        ASSETS: 'assets',
+        ENTRIES: 'entries',
+        CONTENT_TYPES: 'content_types',
+        TAXONOMIES: 'taxonomies',
+        TAXONOMY_TERMS: 'terms',
+        GLOBAL_FIELDS: 'global_fields',
+        EXTENSIONS: 'extensions',
+        WORKFLOWS: 'workflows',
+        WEBHOOKS: 'webhooks',
+        LABELS: 'labels',
+        ENVIRONMENTS: 'environments',
+        MARKETPLACE_APPS: 'marketplace_apps',
+        CUSTOM_ROLES: 'custom-roles',
+        LANGUAGES: 'languages',
+    },
+    /** Content directory names (used in both import and export) */
+    CONTENT_DIRS: {
+        ASSETS: 'assets',
+        ENTRIES: 'entries',
+        CONTENT_TYPES: 'content_types',
+        TAXONOMIES: 'taxonomies',
+        GLOBAL_FIELDS: 'global_fields',
+        EXTENSIONS: 'extensions',
+        WEBHOOKS: 'webhooks',
+        WORKFLOWS: 'workflows',
+        LABELS: 'labels',
+        ENVIRONMENTS: 'environments',
+        STACK: 'stack',
+        LOCALES: 'locales',
+        MARKETPLACE_APPS: 'marketplace_apps',
+    },
+};

package/lib/export/module-exporter.js

@@ -77,7 +77,7 @@ class ModuleExporter {
         return this.exportAllModules();
     }
     async exportByModuleByName(moduleName) {
-        cli_utilities_1.log.info(`Exporting module: ${moduleName}`, this.exportConfig.context);
+        cli_utilities_1.log.info(`Exporting module: '${moduleName}'...`, this.exportConfig.context);
         // export the modules by name
         // calls the module runner which inturn calls the module itself
         await (0, modules_1.default)({
@@ -93,7 +93,8 @@ class ModuleExporter {
             exportModules.push('stack');
         }
         if (!this.exportConfig.skipDependencies) {
-            const { modules: { [moduleName]: { dependencies = [] } = {} }, } = this.exportConfig;
+            const moduleConfig = this.exportConfig.modules[moduleName];
+            const dependencies = (moduleConfig === null || moduleConfig === void 0 ? void 0 : moduleConfig.dependencies) || [];
             if (dependencies.length > 0) {
                 exportModules = exportModules.concat(dependencies);
             }

package/lib/export/modules/assets.js

@@ -16,6 +16,7 @@ const progress_stream_1 = tslib_1.__importDefault(require("progress-stream"));
 const node_fs_1 = require("node:fs");
 const node_path_1 = require("node:path");
 const cli_utilities_1 = 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 utils_1 = require("../../utils");
@@ -36,7 +37,7 @@ class ExportAssets extends base_class_1.default {
         };
     }
     async start() {
-        this.assetsRootPath = (0, node_path_1.resolve)(this.exportConfig.data, this.exportConfig.branchName || '', this.assetConfig.dirName);
+        this.assetsRootPath = (0, node_path_1.resolve)(this.exportConfig.exportDir, this.exportConfig.branchName || '', this.assetConfig.dirName);
         cli_utilities_1.log.debug(`Assets root path resolved to: ${this.assetsRootPath}`, this.exportConfig.context);
         cli_utilities_1.log.debug('Fetching assets and folders count...', this.exportConfig.context);
         // NOTE step 1: Get assets and it's folder count in parallel
@@ -83,8 +84,7 @@ class ExportAssets extends base_class_1.default {
                 await this.downloadAssets();
                 progress.completeProcess(utils_1.PROCESS_NAMES.ASSET_DOWNLOADS, true);
             }
-            this.completeProgress(true);
-            cli_utilities_1.log.success(cli_utilities_1.messageHandler.parse('ASSET_EXPORT_COMPLETE'), this.exportConfig.context);
+            this.completeProgressWithMessage();
         }
         catch (error) {
             this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Asset export failed');
@@ -171,7 +171,7 @@ class ExportAssets extends base_class_1.default {
                 fs = new cli_utilities_1.FsUtility({
                     metaHandler,
                     moduleName: 'assets',
-                    indexFileName: 'assets.json',
+                    indexFileName: this.assetConfig.fileName,
                     basePath: this.assetsRootPath,
                     chunkFileSize: this.assetConfig.chunkFileSize,
                     metaPickKeys: (0, merge_1.default)(['uid', 'url', 'filename', 'parent_uid'], this.assetConfig.assetsMetaKeys),
@@ -236,7 +236,7 @@ class ExportAssets extends base_class_1.default {
             if (!fs && !(0, isEmpty_1.default)(response)) {
                 fs = new cli_utilities_1.FsUtility({
                     moduleName: 'assets',
-                    indexFileName: 'versioned-assets.json',
+                    indexFileName: constants_1.PATH_CONSTANTS.FILES.VERSIONED_ASSETS,
                     chunkFileSize: this.assetConfig.chunkFileSize,
                     basePath: (0, node_path_1.resolve)(this.assetsRootPath, 'versions'),
                     metaPickKeys: (0, merge_1.default)(['uid', 'url', 'filename', '_version', 'parent_uid'], this.assetConfig.assetsMetaKeys),

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

@@ -9,6 +9,12 @@ export type ApiOptions = {
     reject: (error: any) => void;
     additionalInfo?: Record<any, any>;
 };
+export type CompleteProgressOptions = {
+    moduleName?: string;
+    customSuccessMessage?: string;
+    customWarningMessage?: string;
+    context?: Record<string, any>;
+};
 export type EnvType = {
     module: string;
     totalCount: number;
@@ -44,6 +50,17 @@ export default abstract class BaseClass {
      * Complete progress manager
      */
     protected completeProgress(success?: boolean, error?: string): void;
+    /**
+     * Complete progress and log success/warning message based on errors
+     * Checks the progress manager's failure count to determine if errors occurred
+     * @param options - Options object containing:
+     *   - moduleName: The module name to generate the message (e.g., 'Assets', 'Entries')
+     *                 If not provided, uses this.currentModuleName
+     *   - customSuccessMessage: Optional custom success message. If not provided, generates: "{moduleName} have been exported successfully!"
+     *   - customWarningMessage: Optional custom warning message. If not provided, generates: "{moduleName} have been exported with some errors. Please check the logs at: {sessionLogPath}"
+     *   - context: Optional context for logging
+     */
+    protected completeProgressWithMessage(options?: CompleteProgressOptions): void;
     protected withLoadingSpinner<T>(message: string, action: () => Promise<T>): Promise<T>;
     get stack(): any;
     delay(ms: number): Promise<void>;

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

@@ -49,6 +49,34 @@ class BaseClass {
         (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.complete(success, error);
         this.progressManager = null;
     }
+    /**
+     * Complete progress and log success/warning message based on errors
+     * Checks the progress manager's failure count to determine if errors occurred
+     * @param options - Options object containing:
+     *   - moduleName: The module name to generate the message (e.g., 'Assets', 'Entries')
+     *                 If not provided, uses this.currentModuleName
+     *   - customSuccessMessage: Optional custom success message. If not provided, generates: "{moduleName} have been exported successfully!"
+     *   - customWarningMessage: Optional custom warning message. If not provided, generates: "{moduleName} have been exported with some errors. Please check the logs at: {sessionLogPath}"
+     *   - context: Optional context for logging
+     */
+    completeProgressWithMessage(options) {
+        var _a, _b;
+        const logContext = (options === null || options === void 0 ? void 0 : options.context) || ((_a = this.exportConfig) === null || _a === void 0 ? void 0 : _a.context) || {};
+        const failureCount = ((_b = this.progressManager) === null || _b === void 0 ? void 0 : _b.getFailureCount()) || 0;
+        const hasErrors = failureCount > 0;
+        const name = (options === null || options === void 0 ? void 0 : options.moduleName) || this.currentModuleName || 'Module';
+        // Generate default messages if not provided
+        const successMessage = (options === null || options === void 0 ? void 0 : options.customSuccessMessage) || `${name} have been exported successfully!`;
+        const sessionLogPath = (0, cli_utilities_1.getSessionLogPath)();
+        const warningMessage = (options === null || options === void 0 ? void 0 : options.customWarningMessage) || `${name} have been exported with some errors. Please check the logs at: ${sessionLogPath}`;
+        this.completeProgress(true);
+        if (hasErrors) {
+            cli_utilities_1.log.warn(warningMessage, logContext);
+        }
+        else {
+            cli_utilities_1.log.success(successMessage, logContext);
+        }
+    }
     async withLoadingSpinner(message, action) {
         var _a;
         const logConfig = cli_utilities_1.configHandler.get('log') || {};
@@ -158,7 +186,7 @@ class BaseClass {
             case 'export-taxonomy':
                 return this.stack
                     .taxonomy(uid)
-                    .export()
+                    .export(queryParam)
                     .then((response) => resolve({ response, uid }))
                     .catch((error) => reject({ error, uid }));
             default:

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

@@ -0,0 +1,15 @@
+import { HttpClient } from '@contentstack/cli-utilities';
+import { ModuleClassParams, ComposableStudioConfig, ExportConfig, ComposableStudioProject } from '../../types';
+export default class ExportComposableStudio {
+    protected composableStudioConfig: ComposableStudioConfig;
+    protected composableStudioProject: ComposableStudioProject | null;
+    protected apiClient: HttpClient;
+    composableStudioPath: string;
+    exportConfig: ExportConfig;
+    constructor({ exportConfig }: Omit<ModuleClassParams, 'stackAPIClient' | 'moduleName'>);
+    start(): Promise<void>;
+    /**
+     * Export Studio projects connected to the current stack
+     */
+    exportProjects(): Promise<void>;
+}

package/lib/export/modules/composable-studio.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_path_1 = require("node:path");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const utils_1 = require("../../utils");
+class ExportComposableStudio {
+    constructor({ exportConfig }) {
+        this.composableStudioProject = null;
+        this.exportConfig = exportConfig;
+        this.composableStudioConfig = exportConfig.modules['composable-studio'];
+        this.exportConfig.context.module = 'composable-studio';
+        // Initialize HttpClient with Studio API base URL
+        this.apiClient = new cli_utilities_1.HttpClient();
+        this.apiClient.baseUrl(`${this.composableStudioConfig.apiBaseUrl}/${this.composableStudioConfig.apiVersion}`);
+    }
+    async start() {
+        cli_utilities_1.log.debug('Starting Studio project export process...', this.exportConfig.context);
+        if (!(0, cli_utilities_1.isAuthenticated)()) {
+            cli_utilities_1.cliux.print('WARNING!!! To export Studio projects, you must be logged in. Please check csdx auth:login --help to log in', { color: 'yellow' });
+            return Promise.resolve();
+        }
+        this.composableStudioPath = (0, node_path_1.resolve)(this.exportConfig.exportDir, this.exportConfig.branchName || '', this.composableStudioConfig.dirName);
+        cli_utilities_1.log.debug(`Studio folder path: ${this.composableStudioPath}`, this.exportConfig.context);
+        await utils_1.fsUtil.makeDirectory(this.composableStudioPath);
+        cli_utilities_1.log.debug('Created Studio directory', this.exportConfig.context);
+        this.exportConfig.org_uid = this.exportConfig.org_uid || (await (0, utils_1.getOrgUid)(this.exportConfig));
+        cli_utilities_1.log.debug(`Organization UID: ${this.exportConfig.org_uid}`, this.exportConfig.context);
+        await this.exportProjects();
+        cli_utilities_1.log.debug('Studio project export process completed', this.exportConfig.context);
+    }
+    /**
+     * Export Studio projects connected to the current stack
+     */
+    async exportProjects() {
+        var _a, _b;
+        cli_utilities_1.log.debug('Starting Studio project export...', this.exportConfig.context);
+        try {
+            // Get authentication details - following personalization-api-adapter pattern
+            cli_utilities_1.log.debug('Initializing Studio API authentication...', this.exportConfig.context);
+            await cli_utilities_1.authenticationHandler.getAuthDetails();
+            const token = cli_utilities_1.authenticationHandler.accessToken;
+            cli_utilities_1.log.debug(`Authentication type: ${cli_utilities_1.authenticationHandler.isOauthEnabled ? 'OAuth' : 'Token'}`, this.exportConfig.context);
+            // Set authentication headers based on auth type
+            if (cli_utilities_1.authenticationHandler.isOauthEnabled) {
+                cli_utilities_1.log.debug('Setting OAuth authorization header', this.exportConfig.context);
+                this.apiClient.headers({ authorization: token });
+            }
+            else {
+                cli_utilities_1.log.debug('Setting authtoken header', this.exportConfig.context);
+                this.apiClient.headers({ authtoken: token });
+            }
+            // Set organization_uid header
+            this.apiClient.headers({
+                organization_uid: this.exportConfig.org_uid,
+                Accept: 'application/json',
+            });
+            const apiUrl = '/projects';
+            cli_utilities_1.log.debug(`Fetching projects from: ${this.composableStudioConfig.apiBaseUrl}${apiUrl}`, this.exportConfig.context);
+            // Make API call to fetch projects using HttpClient
+            const response = await this.apiClient.get(apiUrl);
+            if (response.status < 200 || response.status >= 300) {
+                throw new Error(`API call failed with status ${response.status}: ${JSON.stringify(response.data)}`);
+            }
+            const data = response.data;
+            cli_utilities_1.log.debug(`Fetched ${((_a = data.projects) === null || _a === void 0 ? void 0 : _a.length) || 0} total projects`, this.exportConfig.context);
+            // Filter projects connected to this stack
+            const connectedProject = (_b = data.projects) === null || _b === void 0 ? void 0 : _b.filter((project) => project.connectedStackApiKey === this.exportConfig.apiKey);
+            if (!connectedProject || connectedProject.length === 0) {
+                cli_utilities_1.log.info(cli_utilities_1.messageHandler.parse('COMPOSABLE_STUDIO_NOT_FOUND'), this.exportConfig.context);
+                return;
+            }
+            // Use the first connected project (stacks should have only one project)
+            this.composableStudioProject = connectedProject[0];
+            cli_utilities_1.log.debug(`Found Studio project: ${this.composableStudioProject.name}`, this.exportConfig.context);
+            // Write the project to file
+            const composableStudioFilePath = (0, node_path_1.resolve)(this.composableStudioPath, this.composableStudioConfig.fileName);
+            cli_utilities_1.log.debug(`Writing Studio project to: ${composableStudioFilePath}`, this.exportConfig.context);
+            utils_1.fsUtil.writeFile(composableStudioFilePath, this.composableStudioProject);
+            cli_utilities_1.log.success(cli_utilities_1.messageHandler.parse('COMPOSABLE_STUDIO_EXPORT_COMPLETE', this.composableStudioProject.name), this.exportConfig.context);
+        }
+        catch (error) {
+            cli_utilities_1.log.debug('Error occurred while exporting Studio project', this.exportConfig.context);
+            (0, cli_utilities_1.handleAndLogError)(error, Object.assign({}, this.exportConfig.context));
+        }
+    }
+}
+exports.default = ExportComposableStudio;