@contentstack/cli-auth 1.3.9 → 1.3.10

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-auth
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-auth/1.3.9 linux-x64 node-v16.20.0
+@contentstack/cli-auth/1.3.10 linux-x64 node-v16.20.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/commands/auth/tokens/add.js

@@ -16,6 +16,7 @@ class TokensAddCommand extends cli_command_1.Command {
         let isDelivery = addTokenFlags.delivery;
         let isManagement = addTokenFlags.management;
         let environment = addTokenFlags.environment;
+        let branch = addTokenFlags.branch;
         const configKeyTokens = 'tokens';
         if (!isDelivery && !isManagement && !Boolean(environment)) {
             let tokenType = await (0, interactive_1.askTokenType)();
@@ -47,6 +48,36 @@ class TokensAddCommand extends cli_command_1.Command {
             if (!token) {
                 token = await cli_utilities_1.cliux.inquire({ type: 'input', message: 'CLI_AUTH_TOKENS_ADD_ENTER_TOKEN', name: 'token' });
             }
+            const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)({ host: this.cmaHost });
+            let doBranchesExistInPlan = false;
+            if (isManagement && apiKey && token) {
+                await managementAPIClient
+                    .stack({ api_key: apiKey, management_token: token })
+                    .branch()
+                    .query()
+                    .find()
+                    .then(() => (doBranchesExistInPlan = true))
+                    .catch((err) => {
+                    if (err.errorCode && err.errorMessage && branch) {
+                        throw new Error(err.errorMessage);
+                    }
+                });
+            }
+            else {
+                if (!apiKey) {
+                    throw new Error('Api key is required');
+                }
+                if (!token) {
+                    throw new Error('Token is required');
+                }
+            }
+            if (doBranchesExistInPlan && !branch) {
+                branch = await cli_utilities_1.cliux.inquire({
+                    type: 'input',
+                    message: 'CLI_AUTH_ENTER_BRANCH',
+                    name: 'branch',
+                });
+            }
             if (isDelivery && !environment) {
                 environment = await cli_utilities_1.cliux.inquire({
                     type: 'input',
@@ -56,11 +87,11 @@ class TokensAddCommand extends cli_command_1.Command {
             }
             let tokenValidationResult;
             if (type === 'delivery') {
-                tokenValidationResult = await utils_1.tokenValidation.validateDeliveryToken(this.deliveryAPIClient, apiKey, token, environment, this.region.name, this.cdaHost);
+                branch = branch || 'main';
+                tokenValidationResult = await utils_1.tokenValidation.validateDeliveryToken(this.deliveryAPIClient, apiKey, token, environment, this.region.name, this.cdaHost, branch);
             }
             else if (type === 'management') {
-                const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)({ host: this.cmaHost });
-                tokenValidationResult = await utils_1.tokenValidation.validateManagementToken(managementAPIClient, apiKey, token);
+                tokenValidationResult = await utils_1.tokenValidation.validateManagementToken(managementAPIClient, apiKey, token, doBranchesExistInPlan ? branch : null);
             }
             if (!tokenValidationResult.valid) {
                 throw new cli_utilities_1.CLIError(tokenValidationResult.message);
@@ -139,5 +170,11 @@ TokensAddCommand.flags = {
         description: 'Force adding',
         parse: (0, cli_utilities_1.printFlagDeprecation)(['-f', '--force'], ['-y', '--yes']),
     }),
+    branch: cli_utilities_1.flags.string({
+        required: false,
+        multiple: false,
+        description: 'Branch name',
+        hidden: true,
+    }),
 };
 TokensAddCommand.usage = 'auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]';

package/lib/utils/tokens-validation.d.ts

@@ -7,7 +7,7 @@
  * @param region
  * @returns
  */
-export declare const validateDeliveryToken: (contentStackClient: any, apiKey: string, deliveryToken: string, environment: string, region: string, host: string) => Promise<any>;
+export declare const validateDeliveryToken: (contentStackClient: any, apiKey: string, deliveryToken: string, environment: string, region: string, host: string, branch: string) => Promise<any>;
 /**
  * Validate environment
  * @param contentStackClient
@@ -24,7 +24,7 @@ export declare const validateEnvironment: (contentStackClient: any, apiKey: stri
  * @returns { valid: boolean; message: any }
  * Note: Fetching one content type using the management token to check whether it is valid or not
  */
-export declare const validateManagementToken: (contentStackClient: any, apiKey: string, managementToken: string) => Promise<any>;
+export declare const validateManagementToken: (contentStackClient: any, apiKey: string, managementToken: string, branch: string) => Promise<any>;
 /**
  * Validate API key
  * @param contentStackClient

package/lib/utils/tokens-validation.js

@@ -11,7 +11,7 @@ const cli_utilities_1 = require("@contentstack/cli-utilities");
  * @param region
  * @returns
  */
-const validateDeliveryToken = async (contentStackClient, apiKey, deliveryToken, environment, region, host) => {
+const validateDeliveryToken = async (contentStackClient, apiKey, deliveryToken, environment, region, host, branch) => {
     let result;
     try {
         const regionMap = {
@@ -20,13 +20,13 @@ const validateDeliveryToken = async (contentStackClient, apiKey, deliveryToken,
             AZURE_NA: 'azure-na',
             AZURE_EU: 'azure-eu',
         };
-        const stack = contentStackClient
-            .Stack({
+        const stack = contentStackClient.Stack({
             api_key: apiKey,
             delivery_token: deliveryToken,
             environment,
             region: regionMap[region],
             host,
+            branch,
         });
         const parsedHost = host.replace(/^https?:\/\//, '');
         stack.setHost(parsedHost);
@@ -47,6 +47,9 @@ const validateDeliveryToken = async (contentStackClient, apiKey, deliveryToken,
         else if (error.error_code === 141) {
             result = { valid: false, message: cli_utilities_1.messageHandler.parse('CLI_AUTH_TOKENS_VALIDATION_INVALID_ENVIRONMENT_NAME') };
         }
+        else if (error === null || error === void 0 ? void 0 : error.error_code) {
+            throw new Error(error === null || error === void 0 ? void 0 : error.error_message);
+        }
         else {
             result = { valid: false, message: cli_utilities_1.messageHandler.parse('CLI_AUTH_TOKENS_VALIDATION_INVALID_DELIVERY_TOKEN') };
         }
@@ -88,11 +91,12 @@ exports.validateEnvironment = validateEnvironment;
  * @returns { valid: boolean; message: any }
  * Note: Fetching one content type using the management token to check whether it is valid or not
  */
-const validateManagementToken = async (contentStackClient, apiKey, managementToken) => {
+const validateManagementToken = async (contentStackClient, apiKey, managementToken, branch) => {
+    var _a, _b;
     let result;
     try {
-        const validationResuslt = await contentStackClient.axiosInstance.get('/content_types?limit=1', {
-            headers: { api_key: apiKey, authorization: managementToken },
+        const validationResuslt = await contentStackClient.axiosInstance.get('/content_types?limit=1&include_branch=true', {
+            headers: { api_key: apiKey, authorization: managementToken, branch },
         });
         cli_utilities_1.logger.debug('Management validation result', validationResuslt);
         if (validationResuslt.status === 200) {
@@ -107,6 +111,9 @@ const validateManagementToken = async (contentStackClient, apiKey, managementTok
         if (error.response && error.response.status === 401) {
             result = { valid: false, message: cli_utilities_1.messageHandler.parse('CLI_AUTH_TOKENS_VALIDATION_INVALID_MANAGEMENT_TOKEN') };
         }
+        if ((_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.data) {
+            throw new Error((_b = error.response.data) === null || _b === void 0 ? void 0 : _b.error_message);
+        }
         else {
             result = { valid: false, message: cli_utilities_1.messageHandler.parse('CLI_AUTH_TOKENS_VALIDATION_INVALID_API_KEY') };
         }

package/messages/index.json

@@ -3,6 +3,7 @@
   "CLI_AUTH_LOGIN_ENTER_PASSWORD": "Enter your password",
   "CLI_AUTH_LOGIN_SUCCESS": "Successfully logged in!!",
   "CLI_AUTH_LOGIN_FAILED": "Login Error",
+  "CLI_AUTH_AUTHENTICATION_FAILED": "You need to login first. See: auth:login --help",
   "CLI_AUTH_LOGIN_DESCRIPTION": "User session login",
   "CLI_AUTH_LOGIN_FLAG_USERNAME": "User name",
   "CLI_AUTH_LOGIN_FLAG_PASSWORD": "Password",
@@ -43,5 +44,6 @@
   "CLI_AUTH_TOKENS_VALIDATION_INVALID_MANAGEMENT_TOKEN": "Invalid management token",
   "CLI_AUTH_TOKENS_VALIDATION_INVALID_API_KEY": "Invalid api key",
   "CLI_AUTH_EXIT_PROCESS": "Exiting the process...",
-  "CLI_SELECT_TOKEN_TYPE": "Select the type of token to add"
+  "CLI_SELECT_TOKEN_TYPE": "Select the type of token to add",
+  "CLI_AUTH_ENTER_BRANCH": "Enter branch name"
 }

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.9",
+  "version": "1.3.10",
   "commands": {
     "auth:login": {
       "id": "auth:login",
@@ -203,6 +203,14 @@
           "description": "Force adding",
           "hidden": true,
           "allowNo": false
+        },
+        "branch": {
+          "name": "branch",
+          "type": "option",
+          "description": "Branch name",
+          "hidden": true,
+          "required": false,
+          "multiple": false
         }
       },
       "args": {}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-auth",
   "description": "Contentstack CLI plugin for authentication activities",
-  "version": "1.3.9",
+  "version": "1.3.10",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "scripts": {
@@ -18,7 +18,8 @@
     "lint": "eslint src/**/*.ts",
     "format": "eslint src/**/*.ts --fix",
     "test:integration": "mocha --forbid-only \"test/integration/*.test.ts\"",
-    "test:unit": "mocha --forbid-only \"test/unit/*.test.ts\""
+    "test:unit": "mocha --forbid-only \"test/unit/**/*.test.ts\"",
+    "test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\""
   },
   "dependencies": {
     "@contentstack/cli-command": "^1.2.9",
@@ -85,4 +86,4 @@
     }
   },
   "repository": "contentstack/cli"
-}
+}