@contentstack/cli-auth 1.3.13 → 1.3.15

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-auth
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-auth/1.3.13 linux-x64 node-v18.17.1
+@contentstack/cli-auth/1.3.15 linux-x64 node-v18.18.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/base-command.d.ts

@@ -0,0 +1,33 @@
+import { Command } from '@contentstack/cli-command';
+import { Interfaces, LoggerService } from '@contentstack/cli-utilities';
+export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
+export type Flags<T extends typeof Command> = Interfaces.InferredFlags<(typeof BaseCommand)['baseFlags'] & T['flags']>;
+export declare abstract class BaseCommand<T extends typeof Command> extends Command {
+    logger: LoggerService;
+    protected args: Args<T>;
+    protected flags: Flags<T>;
+    /**
+     * The `init` function initializes the command by parsing arguments and flags, registering search
+     * plugins, registering the configuration, and initializing the logger.
+     */
+    init(): Promise<void>;
+    /**
+     * The catch function is used to handle errors from a command, either by adding custom logic or
+     * returning the parent class error handling.
+     * @param err - The `err` parameter is of type `Error & { exitCode?: number }`. This means that it is
+     * an object that extends the `Error` class and may also have an optional property `exitCode` of type
+     * `number`.
+     * @returns The parent class error handling is being returned.
+     */
+    protected catch(err: Error & {
+        exitCode?: number;
+    }): Promise<any>;
+    /**
+     * The `finally` function is called after the `run` and `catch` functions, regardless of whether or not
+     * an error occurred.
+     * @param {Error | undefined} _ - The parameter "_" represents an error object or undefined.
+     * @returns The `finally` method is returning the result of calling the `finally` method of the
+     * superclass, which is a promise.
+     */
+    protected finally(_: Error | undefined): Promise<any>;
+}

package/lib/base-command.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseCommand = void 0;
+const cli_command_1 = require("@contentstack/cli-command");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+class BaseCommand extends cli_command_1.Command {
+    /**
+     * The `init` function initializes the command by parsing arguments and flags, registering search
+     * plugins, registering the configuration, and initializing the logger.
+     */
+    async init() {
+        await super.init();
+        // Init logger
+        this.logger = new cli_utilities_1.LoggerService(process.cwd(), 'cli-log');
+    }
+    /**
+     * The catch function is used to handle errors from a command, either by adding custom logic or
+     * returning the parent class error handling.
+     * @param err - The `err` parameter is of type `Error & { exitCode?: number }`. This means that it is
+     * an object that extends the `Error` class and may also have an optional property `exitCode` of type
+     * `number`.
+     * @returns The parent class error handling is being returned.
+     */
+    async catch(err) {
+        // add any custom logic to handle errors from the command
+        // or simply return the parent class error handling
+        return super.catch(err);
+    }
+    /**
+     * The `finally` function is called after the `run` and `catch` functions, regardless of whether or not
+     * an error occurred.
+     * @param {Error | undefined} _ - The parameter "_" represents an error object or undefined.
+     * @returns The `finally` method is returning the result of calling the `finally` method of the
+     * superclass, which is a promise.
+     */
+    async finally(_) {
+        // called after run and catch regardless of whether or not the command errored
+        return super.finally(_);
+    }
+}
+exports.BaseCommand = BaseCommand;

package/lib/commands/auth/login.d.ts

@@ -1,6 +1,6 @@
-import { Command } from '@contentstack/cli-command';
 import { FlagInput } from '@contentstack/cli-utilities';
-export default class LoginCommand extends Command {
+import { BaseCommand } from '../../base-command';
+export default class LoginCommand extends BaseCommand<typeof LoginCommand> {
     static run: any;
     static description: string;
     static examples: string[];

package/lib/commands/auth/login.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const cli_command_1 = require("@contentstack/cli-command");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const utils_1 = require("../../utils");
-class LoginCommand extends cli_command_1.Command {
+const base_command_1 = require("../../base-command");
+class LoginCommand extends base_command_1.BaseCommand {
     async run() {
         try {
             const managementAPIClient = await (0, cli_utilities_1.managementSDKClient)({ host: this.cmaHost, skipTokenValidity: true });
@@ -17,7 +17,7 @@ class LoginCommand extends cli_command_1.Command {
             else {
                 const username = (loginFlags === null || loginFlags === void 0 ? void 0 : loginFlags.username) || (await utils_1.interactive.askUsername());
                 const password = (loginFlags === null || loginFlags === void 0 ? void 0 : loginFlags.password) || (await utils_1.interactive.askPassword());
-                cli_utilities_1.logger.debug('username', username);
+                this.logger.debug('username', username);
                 await this.login(username, password);
             }
         }
@@ -36,7 +36,7 @@ class LoginCommand extends cli_command_1.Command {
                     errorMessage = error;
                 }
             }
-            cli_utilities_1.logger.error('login failed', errorMessage);
+            this.logger.error('login failed', errorMessage);
             cli_utilities_1.cliux.error('CLI_AUTH_LOGIN_FAILED');
             cli_utilities_1.cliux.error(errorMessage);
             process.exit();
@@ -49,7 +49,7 @@ class LoginCommand extends cli_command_1.Command {
                 throw new cli_utilities_1.CLIError('Failed to login - invalid response');
             }
             await cli_utilities_1.authHandler.setConfigData('basicAuth', user);
-            cli_utilities_1.logger.info('successfully logged in');
+            this.logger.info('successfully logged in');
             cli_utilities_1.cliux.success('CLI_AUTH_LOGIN_SUCCESS');
         }
         catch (error) {

package/lib/commands/auth/logout.d.ts

@@ -1,6 +1,6 @@
-import { Command } from '@contentstack/cli-command';
 import { FlagInput } from '@contentstack/cli-utilities';
-export default class LogoutCommand extends Command {
+import { BaseCommand } from '../../base-command';
+export default class LogoutCommand extends BaseCommand<typeof LogoutCommand> {
     static run: any;
     static description: string;
     static examples: string[];

package/lib/commands/auth/logout.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const cli_command_1 = require("@contentstack/cli-command");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const utils_1 = require("../../utils");
-class LogoutCommand extends cli_command_1.Command {
+const base_command_1 = require("../../base-command");
+class LogoutCommand extends base_command_1.BaseCommand {
     async run() {
         const { flags: logoutFlags } = await this.parse(LogoutCommand);
         let confirm = logoutFlags.force === true || logoutFlags.yes === true;
@@ -26,7 +26,7 @@ class LogoutCommand extends cli_command_1.Command {
                     await cli_utilities_1.authHandler.oauthLogout();
                 }
                 cli_utilities_1.cliux.loader('');
-                cli_utilities_1.logger.info('successfully logged out');
+                this.logger.info('successfully logged out');
                 cli_utilities_1.cliux.success('CLI_AUTH_LOGOUT_SUCCESS');
             }
             else {
@@ -48,7 +48,7 @@ class LogoutCommand extends cli_command_1.Command {
                     errorMessage = error;
                 }
             }
-            cli_utilities_1.logger.error('Logout failed', errorMessage);
+            this.logger.error('Logout failed', errorMessage);
             cli_utilities_1.cliux.print('CLI_AUTH_LOGOUT_FAILED', { color: 'yellow' });
             cli_utilities_1.cliux.print(errorMessage, { color: 'red' });
         }

package/lib/commands/auth/tokens/add.d.ts

@@ -1,6 +1,6 @@
-import { Command } from '@contentstack/cli-command';
 import { FlagInput } from '@contentstack/cli-utilities';
-export default class TokensAddCommand extends Command {
+import { BaseCommand } from '../../../base-command';
+export default class TokensAddCommand extends BaseCommand<typeof TokensAddCommand> {
     static description: string;
     static examples: string[];
     static flags: FlagInput;

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

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const cli_command_1 = require("@contentstack/cli-command");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const interactive_1 = require("../../../utils/interactive");
-class TokensAddCommand extends cli_command_1.Command {
+const base_command_1 = require("../../../base-command");
+class TokensAddCommand extends base_command_1.BaseCommand {
     async run() {
-        // @ts-ignore
         const { flags: addTokenFlags } = await this.parse(TokensAddCommand);
         let isAliasExist = false;
         const skipAliasReplaceConfirmation = addTokenFlags.force || addTokenFlags.yes;
@@ -15,7 +14,6 @@ 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)();
@@ -23,7 +21,7 @@ class TokensAddCommand extends cli_command_1.Command {
             isManagement = tokenType === 'management';
         }
         const type = isDelivery || Boolean(environment) ? 'delivery' : 'management';
-        cli_utilities_1.logger.info(`adding ${type} token`);
+        this.logger.info(`adding ${type} token`);
         try {
             if (!alias) {
                 alias = await cli_utilities_1.cliux.inquire({ type: 'input', message: 'CLI_AUTH_TOKENS_ADD_ASK_TOKEN_ALIAS', name: 'alias' });
@@ -36,7 +34,7 @@ class TokensAddCommand extends cli_command_1.Command {
                     name: 'confirm',
                 });
                 if (!shouldAliasReplace) {
-                    cli_utilities_1.logger.info('Exiting from the process of replacing the token');
+                    this.logger.info('Exiting from the process of replacing the token');
                     cli_utilities_1.cliux.print('CLI_AUTH_EXIT_PROCESS');
                     return;
                 }
@@ -79,7 +77,7 @@ class TokensAddCommand extends cli_command_1.Command {
             }
         }
         catch (error) {
-            cli_utilities_1.logger.error('token add error', error.message);
+            this.logger.error('token add error', error.message);
             cli_utilities_1.cliux.print('CLI_AUTH_TOKENS_ADD_FAILED', { color: 'yellow' });
             cli_utilities_1.cliux.error(error.message.message ? error.message.message : error.message);
         }
@@ -101,7 +99,7 @@ TokensAddCommand.examples = [
     '$ csdx auth:tokens:add --alias <alias> --stack-api-key <stack api key> --delivery -e <environment> --token <delivery token>',
 ];
 TokensAddCommand.flags = {
-    alias: cli_utilities_1.flags.string({ char: 'a', description: 'Name of the token alias' }),
+    alias: cli_utilities_1.Flags.string({ char: 'a', description: 'Name of the token alias' }),
     delivery: cli_utilities_1.flags.boolean({
         char: 'd',
         description: 'Set this flag to save delivery token',

package/lib/commands/auth/tokens/index.d.ts

@@ -1,5 +1,5 @@
-import { Command } from '@contentstack/cli-command';
-export default class TokensListCommand extends Command {
+import { BaseCommand } from '../../../base-command';
+export default class TokensListCommand extends BaseCommand<typeof TokensListCommand> {
     static aliases: string[];
     static examples: string[];
     static description: string;

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

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const cli_command_1 = require("@contentstack/cli-command");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
-class TokensListCommand extends cli_command_1.Command {
+const base_command_1 = require("../../../base-command");
+class TokensListCommand extends base_command_1.BaseCommand {
     async run() {
         try {
             const managementTokens = cli_utilities_1.configHandler.get('tokens');
@@ -41,7 +41,7 @@ class TokensListCommand extends cli_command_1.Command {
             }
         }
         catch (error) {
-            cli_utilities_1.logger.error('Token list error', error.message);
+            this.logger.error('Token list error', error.message);
             cli_utilities_1.cliux.print('CLI_AUTH_TOKENS_LIST_FAILED', { color: 'yellow' });
             cli_utilities_1.cliux.print(error.message, { color: 'red' });
         }

package/lib/commands/auth/tokens/remove.d.ts

@@ -1,6 +1,6 @@
-import { Command } from '@contentstack/cli-command';
 import { FlagInput } from '@contentstack/cli-utilities';
-export default class TokensRemoveCommand extends Command {
+import { BaseCommand } from '../../../base-command';
+export default class TokensRemoveCommand extends BaseCommand<typeof TokensRemoveCommand> {
     static description: string;
     static examples: string[];
     static flags: FlagInput;

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

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const cli_command_1 = require("@contentstack/cli-command");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
-class TokensRemoveCommand extends cli_command_1.Command {
+const base_command_1 = require("../../../base-command");
+class TokensRemoveCommand extends base_command_1.BaseCommand {
     async run() {
         const { flags: removeTokenFlags } = await this.parse(TokensRemoveCommand);
         const alias = removeTokenFlags.alias;
@@ -29,18 +29,21 @@ class TokensRemoveCommand extends cli_command_1.Command {
                 type: 'checkbox',
                 choices: tokenOptions,
             });
-            cli_utilities_1.logger.debug('selected tokens', selectedTokens);
             if (selectedTokens.length === 0) {
                 return;
             }
+            selectedTokens.forEach((ele) => {
+                this.logger.info('selected tokens', ele);
+            });
             selectedTokens.forEach((element) => {
                 const selectedToken = element.split(':')[0];
                 cli_utilities_1.configHandler.delete(`tokens.${selectedToken}`);
                 cli_utilities_1.cliux.success('CLI_AUTH_TOKENS_REMOVE_SUCCESS');
+                this.logger.info('Token removed successfully !!', element);
             });
         }
         catch (error) {
-            cli_utilities_1.logger.error('Token remove error', error.message);
+            this.logger.error('Token remove error', error.message);
             cli_utilities_1.cliux.print('CLI_AUTH_TOKENS_REMOVE_FAILED', { color: 'yellow' });
             cli_utilities_1.cliux.print(error.message, { color: 'red' });
         }

package/lib/commands/auth/whoami.d.ts

@@ -1,5 +1,5 @@
-import { Command } from '@contentstack/cli-command';
-export default class WhoamiCommand extends Command {
+import { BaseCommand } from '../../base-command';
+export default class WhoamiCommand extends BaseCommand<typeof WhoamiCommand> {
     static description: string;
     static examples: string[];
     static aliases: string[];

package/lib/commands/auth/whoami.js

@@ -1,21 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const cli_command_1 = require("@contentstack/cli-command");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
-class WhoamiCommand extends cli_command_1.Command {
+const base_command_1 = require("../../base-command");
+class WhoamiCommand extends base_command_1.BaseCommand {
     async run() {
         try {
             if (this.email) {
                 cli_utilities_1.cliux.print('CLI_AUTH_WHOAMI_LOGGED_IN_AS', { color: 'white' });
                 cli_utilities_1.cliux.print(this.email, { color: 'green' });
-                cli_utilities_1.logger.info('Currently logged in user', this.email);
+                this.logger.info('Currently logged in user', this.email);
             }
             else {
                 cli_utilities_1.cliux.error('CLI_AUTH_WHOAMI_FAILED');
             }
         }
         catch (error) {
-            cli_utilities_1.logger.error('whoami error', error.message);
+            this.logger.error('whoami error', error.message);
             cli_utilities_1.cliux.print('CLI_AUTH_WHOAMI_FAILED', { color: 'yellow' });
             cli_utilities_1.cliux.print(error.message, { color: 'red' });
         }

package/lib/utils/auth-handler.d.ts

@@ -1,4 +1,5 @@
 import { User } from '../interfaces';
+import { LoggerService } from '@contentstack/cli-utilities';
 /**
  * @class
  * Auth handler
@@ -6,8 +7,10 @@ import { User } from '../interfaces';
 declare class AuthHandler {
     private _client;
     private _host;
+    logger: LoggerService;
     set client(contentStackClient: any);
     set host(contentStackHost: any);
+    initLog(): void;
     /**
      *
      *

package/lib/utils/auth-handler.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const interactive_1 = require("./interactive");
+const cli_utilities_2 = require("@contentstack/cli-utilities");
 /**
  * @class
  * Auth handler
@@ -13,6 +14,9 @@ class AuthHandler {
     set host(contentStackHost) {
         this._host = contentStackHost;
     }
+    initLog() {
+        this.logger = new cli_utilities_2.LoggerService(process.cwd(), 'cli-log');
+    }
     /**
      *
      *
@@ -23,6 +27,7 @@ class AuthHandler {
      * TBD: take out the otp implementation from login and create a new method/function to handle otp
      */
     async login(email, password, tfaToken) {
+        this.initLog();
         return new Promise((resolve, reject) => {
             if (email && password) {
                 const loginPayload = { email, password };
@@ -32,7 +37,7 @@ class AuthHandler {
                 this._client
                     .login(loginPayload)
                     .then(async (result) => {
-                    cli_utilities_1.logger.debug('login result', result);
+                    this.logger.debug('login result', result);
                     if (result.user) {
                         resolve(result.user);
                     }
@@ -45,7 +50,7 @@ class AuthHandler {
                                 cli_utilities_1.cliux.print('CLI_AUTH_LOGIN_SECURITY_CODE_SEND_SUCCESS');
                             }
                             catch (error) {
-                                cli_utilities_1.logger.error('Failed to send the security code', error);
+                                this.logger.error('Failed to send the security code', error);
                                 reject(new cli_utilities_1.CLIError({ message: 'Failed to login - failed to send the security code' }));
                                 return;
                             }
@@ -55,7 +60,7 @@ class AuthHandler {
                             resolve(await this.login(email, password, tfToken));
                         }
                         catch (error) {
-                            cli_utilities_1.logger.error('Failed to login with tfa token', error);
+                            this.logger.error('Failed to login with tfa token', error);
                             reject(new cli_utilities_1.CLIError({ message: 'Failed to login with the tf token' }));
                         }
                     }
@@ -64,7 +69,7 @@ class AuthHandler {
                     }
                 })
                     .catch((error) => {
-                    cli_utilities_1.logger.error('Failed to login', error);
+                    this.logger.error('Failed to login', error);
                     reject(new cli_utilities_1.CLIError({ message: error.errorMessage }));
                 });
             }
@@ -79,6 +84,7 @@ class AuthHandler {
      * @returns {Promise} Promise object returns response object from Contentstack
      */
     async logout(authtoken) {
+        this.initLog();
         return new Promise((resolve, reject) => {
             if (authtoken) {
                 this._client
@@ -87,7 +93,7 @@ class AuthHandler {
                     return resolve(response);
                 })
                     .catch((error) => {
-                    cli_utilities_1.logger.error('Failed to logout', error);
+                    this.logger.error('Failed to logout', error);
                     return reject(new cli_utilities_1.CLIError({ message: 'Failed to logout - ' + error.message }));
                 });
             }
@@ -102,13 +108,14 @@ class AuthHandler {
      * @returns {Promise} Promise object returns response object from Contentstack
      */
     async validateAuthtoken(authtoken) {
+        this.initLog();
         return new Promise((resolve, reject) => {
             if (authtoken) {
                 this._client
                     .getUser()
                     .then((user) => resolve(user))
                     .catch((error) => {
-                    cli_utilities_1.logger.error('Failed to validate token', error);
+                    this.logger.error('Failed to validate token', error);
                     reject(new cli_utilities_1.CLIError({ message: 'Failed to validate token - ' + error.message }));
                 });
             }

package/lib/utils/tokens-validation.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateAPIKey = exports.validateEnvironment = void 0;
 const cli_utilities_1 = require("@contentstack/cli-utilities");
+const cli_utilities_2 = require("@contentstack/cli-utilities");
 /**
  * Validate environment
  * @param contentStackClient
@@ -10,10 +11,11 @@ const cli_utilities_1 = require("@contentstack/cli-utilities");
  * @returns
  */
 const validateEnvironment = async (contentStackClient, apiKey, environment) => {
+    const newLogger = new cli_utilities_2.LoggerService(process.cwd(), 'cli-log');
     let result;
     try {
         const validationResult = await contentStackClient.Stack({ api_key: apiKey }).environment(environment).fetch();
-        cli_utilities_1.logger.debug('environment validation result', validationResult);
+        newLogger.debug('environment validation result', validationResult);
         if (validationResult.name === environment) {
             result = { valid: true, message: validationResult };
         }
@@ -22,7 +24,7 @@ const validateEnvironment = async (contentStackClient, apiKey, environment) => {
         }
     }
     catch (error) {
-        cli_utilities_1.logger.error('validate environment error', error);
+        newLogger.error('validate environment error', error);
         result = { valid: false, message: 'CLI_AUTH_TOKENS_VALIDATION_INVALID_ENVIRONMENT_NAME' };
     }
     return result;
@@ -35,10 +37,11 @@ exports.validateEnvironment = validateEnvironment;
  * @returns
  */
 const validateAPIKey = async (contentStackClient, apiKey) => {
+    const newLogger = new cli_utilities_2.LoggerService(process.cwd(), 'cli-log');
     let result;
     try {
         const validateAPIKeyResult = await contentStackClient.stack({ api_key: apiKey }).fetch();
-        cli_utilities_1.logger.debug('api key validation result', validateAPIKeyResult);
+        newLogger.debug('api key validation result', validateAPIKeyResult);
         if (validateAPIKeyResult.api_key === apiKey) {
             result = { valid: true, message: validateAPIKeyResult };
         }
@@ -47,7 +50,7 @@ const validateAPIKey = async (contentStackClient, apiKey) => {
         }
     }
     catch (error) {
-        cli_utilities_1.logger.error('validate api key error', error);
+        newLogger.error('validate api key error', error);
         result = { valid: false, message: cli_utilities_1.messageHandler.parse('CLI_AUTH_TOKENS_VALIDATION_INVALID_API_KEY') };
     }
     return result;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.13",
+  "version": "1.3.15",
   "commands": {
     "auth:login": {
       "id": "auth:login",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-auth",
   "description": "Contentstack CLI plugin for authentication activities",
-  "version": "1.3.13",
+  "version": "1.3.15",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "scripts": {
@@ -22,8 +22,8 @@
     "test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\""
   },
   "dependencies": {
-    "@contentstack/cli-command": "~1.2.12",
-    "@contentstack/cli-utilities": "~1.5.2",
+    "@contentstack/cli-command": "~1.2.13",
+    "@contentstack/cli-utilities": "~1.5.4",
     "chalk": "^4.0.0",
     "debug": "^4.1.1",
     "inquirer": "8.2.4",