@contentstack/cli-cm-export-query 1.0.0-beta.3 → 1.0.0-beta.5

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

@@ -65,6 +65,11 @@ ExportQueryCommand.flags = {
     }),
     branch: cli_utilities_1.flags.string({
         description: 'Branch name to export from',
+        exclusive: ['branch-alias'],
+    }),
+    'branch-alias': cli_utilities_1.flags.string({
+        description: 'Alias of Branch to export from',
+        exclusive: ['branch'],
     }),
     query: cli_utilities_1.flags.string({
         required: true,

package/lib/types/index.d.ts

@@ -136,6 +136,7 @@ export interface QueryExportConfig extends DefaultConfig {
     stackApiKey: string;
     managementToken?: string;
     branchName: string;
+    branchAlias?: string;
     securedAssets: boolean;
     logsPath: string;
     dataPath: string;

package/lib/utils/branch-helper.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setupBranches = void 0;
+const cli_utilities_1 = require("@contentstack/cli-utilities");
 const logger_1 = require("./logger");
 /**
  * Validates and sets up branch configuration for the stack
@@ -11,9 +12,13 @@ const logger_1 = require("./logger");
  */
 const setupBranches = async (config, stackAPIClient) => {
     if (typeof config !== 'object') {
-        throw new Error('Invalid config to setup the branch');
+        throw new Error('The branch configuration is invalid.');
     }
     try {
+        if (config.branchAlias) {
+            config.branchName = await (0, cli_utilities_1.getBranchFromAlias)(stackAPIClient, config.branchAlias);
+            return;
+        }
         if (config.branchName) {
             // Check if the specified branch exists
             (0, logger_1.log)(config, `Validating branch: ${config.branchName}`, 'info');
@@ -28,7 +33,7 @@ const setupBranches = async (config, stackAPIClient) => {
                 (0, logger_1.log)(config, `Branch '${config.branchName}' found`, 'success');
             }
             else {
-                throw new Error(`No branch found with the name '${config.branchName}'`);
+                throw new Error(`No branch found named ${config.branchName}.`);
             }
         }
         else {

package/lib/utils/config-handler.js

@@ -12,6 +12,9 @@ async function setupQueryExportConfig(flags) {
     const exportQueryConfig = Object.assign(Object.assign({}, config_1.default), { exportDir, stackApiKey: flags['stack-api-key'] || '', managementToken: flags.alias ? (_a = cli_utilities_1.configHandler.get(`tokens.${flags.alias}`)) === null || _a === void 0 ? void 0 : _a.token : undefined, query: flags.query, skipReferences: flags['skip-references'] || false, skipDependencies: flags['skip-dependencies'] || false, branchName: flags.branch, securedAssets: flags['secured-assets'] || false, isQueryBasedExport: true, logsPath: exportDir, dataPath: exportDir, 
         // Todo: accept the path of the config file from the user
         externalConfigPath: path.join(__dirname, '../config/export-config.json') });
+    if (flags['branch-alias']) {
+        exportQueryConfig.branchAlias = flags['branch-alias'];
+    }
     // override the external config path if the user provides a config file
     if (flags.config) {
         exportQueryConfig.externalConfigPath = (0, cli_utilities_1.sanitizePath)(flags['config']);
@@ -22,17 +25,17 @@ async function setupQueryExportConfig(flags) {
         exportQueryConfig.managementToken = token;
         exportQueryConfig.stackApiKey = apiKey;
         if (!exportQueryConfig.managementToken) {
-            throw new Error(`No management token found on given alias ${flags.alias}`);
+            throw new Error(`No management token found for alias ${flags.alias}.`);
         }
     }
     if (!exportQueryConfig.managementToken) {
         if (!(0, cli_utilities_1.isAuthenticated)()) {
-            throw new Error('Please login or provide an alias for the management token');
+            throw new Error('Log in or provide an alias for the management token.');
         }
         else {
             exportQueryConfig.stackApiKey = flags['stack-api-key'] || (await (0, common_helper_1.askAPIKey)());
             if (typeof exportQueryConfig.stackApiKey !== 'string') {
-                throw new Error('Invalid API key received');
+                throw new Error('The API key is invalid.');
             }
         }
     }

package/lib/utils/dependency-resolver.js

@@ -46,7 +46,7 @@ class ContentTypeDependenciesHandler {
                 (0, logger_1.log)(this.exportQueryConfig, `Dependencies separated - Global Fields: ${dependencies.globalFields.size}, Extensions: ${dependencies.extensions.size}, Taxonomies: ${dependencies.taxonomies.size}, Marketplace Apps: ${dependencies.marketplaceApps.size}`, 'info');
             }
             catch (error) {
-                (0, logger_1.log)(this.exportQueryConfig, `Error separating extensions and marketplace apps: ${error.message}`, 'error');
+                (0, logger_1.log)(this.exportQueryConfig, `Failed to separate extensions and Marketplace apps: ${error.message}`, 'error');
                 // Keep original extensions if separation fails
             }
         }
@@ -87,7 +87,7 @@ class ContentTypeDependenciesHandler {
             return { extensions: regularExtensions, marketplaceApps };
         }
         catch (error) {
-            (0, logger_1.log)(this.exportQueryConfig, `Error fetching extensions and marketplace apps: ${error.message}`, 'error');
+            (0, logger_1.log)(this.exportQueryConfig, `Failed to fetch extensions and Marketplace apps: ${error.message}`, 'error');
             return { extensions: extensionUIDs, marketplaceApps: [] };
         }
     }

package/lib/utils/query-parser.js

@@ -26,7 +26,7 @@ class QueryParser {
             return JSON.parse(content);
         }
         catch (error) {
-            throw new cli_utilities_1.CLIError(`Failed to parse query file: ${error.message}`);
+            throw new cli_utilities_1.CLIError(`Failed to parse the query file: ${error.message}`);
         }
     }
     parseFromString(queryString) {
@@ -39,14 +39,14 @@ class QueryParser {
     }
     validate(query) {
         if (!query || typeof query !== 'object') {
-            throw new cli_utilities_1.CLIError('Query must be a valid JSON object');
+            throw new cli_utilities_1.CLIError('The query must be a valid JSON object.');
         }
         if (!query.modules || typeof query.modules !== 'object') {
-            throw new cli_utilities_1.CLIError('Query must contain a "modules" object');
+            throw new cli_utilities_1.CLIError('The query must contain a "modules" object.');
         }
         const modules = Object.keys(query.modules);
         if (modules.length === 0) {
-            throw new cli_utilities_1.CLIError('Query must contain at least one module');
+            throw new cli_utilities_1.CLIError('The query must contain at least one module.');
         }
         // Validate supported modules
         const queryableModules = this.config.modules.queryable;

package/lib/utils/referenced-asset-handler.js

@@ -37,7 +37,7 @@ class AssetReferenceHandler {
             return result;
         }
         catch (error) {
-            (0, logger_1.log)(this.exportQueryConfig, `Error extracting assets: ${error.message}`, 'error');
+            (0, logger_1.log)(this.exportQueryConfig, `Failed to extract assets: ${error.message}`, 'error');
             return [];
         }
     }
@@ -66,7 +66,7 @@ class AssetReferenceHandler {
             return entriesCount;
         }
         catch (error) {
-            (0, logger_1.log)(this.exportQueryConfig, `Error processing file ${filePath}: ${error.message}`, 'warn');
+            (0, logger_1.log)(this.exportQueryConfig, `Failed to process file ${filePath}: ${error.message}`, 'warn');
             return 0;
         }
     }
@@ -123,7 +123,7 @@ class AssetReferenceHandler {
             }
         }
         catch (error) {
-            (0, logger_1.log)(this.exportQueryConfig, `Error reading directory ${dir}: ${error.message}`, 'warn');
+            (0, logger_1.log)(this.exportQueryConfig, `Failed to read directory ${dir}: ${error.message}`, 'warn');
         }
         return jsonFiles;
     }

package/oclif.manifest.json

@@ -45,11 +45,24 @@
         },
         "branch": {
           "description": "Branch name to export from",
+          "exclusive": [
+            "branch-alias"
+          ],
           "name": "branch",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
         },
+        "branch-alias": {
+          "description": "Alias of Branch to export from",
+          "exclusive": [
+            "branch"
+          ],
+          "name": "branch-alias",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "query": {
           "description": "Query as JSON string or file path",
           "name": "query",
@@ -102,5 +115,5 @@
       ]
     }
   },
-  "version": "1.0.0-beta.3"
+  "version": "1.0.0-beta.5"
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@contentstack/cli-cm-export-query",
   "description": "Contentstack CLI plugin to export content from stack",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.5",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-cm-export": "~1.18.0",
-    "@contentstack/cli-command": "~1.6.0",
-    "@contentstack/cli-utilities": "~1.13.0",
+    "@contentstack/cli-cm-export": "~1.20.2",
+    "@contentstack/cli-command": "~1.6.1",
+    "@contentstack/cli-utilities": "~1.14.1",
     "@oclif/core": "^4.3.0",
     "async": "^3.2.6",
     "big-json": "^3.2.0",
@@ -21,21 +21,21 @@
     "winston": "^3.17.0"
   },
   "devDependencies": {
-    "@contentstack/cli-dev-dependencies": "~1.3.0",
-    "@oclif/plugin-help": "^6.2.28",
-    "@oclif/test": "^4.1.13",
+    "@contentstack/cli-dev-dependencies": "~1.3.1",
+    "@oclif/plugin-help": "^6.2.33",
+    "@oclif/test": "^4.1.14",
     "@types/big-json": "^3.2.5",
     "@types/chai": "^4.3.20",
     "@types/mkdirp": "^1.0.2",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^20.19.8",
+    "@types/node": "^20.19.17",
     "@types/progress-stream": "^2.0.5",
     "@types/sinon": "^17.0.4",
     "chai": "^4.5.0",
-    "dotenv": "^16.5.0",
+    "dotenv": "^16.6.1",
     "dotenv-expand": "^9.0.0",
     "eslint": "^8.57.1",
-    "eslint-config-oclif": "^6.0.62",
+    "eslint-config-oclif": "^6.0.104",
     "husky": "^9.1.7",
     "mocha": "10.8.2",
     "nyc": "^15.1.0",