@contentstack/cli-utilities 1.7.3 → 1.8.0

package/lib/auth-handler.js

@@ -4,6 +4,7 @@ const tslib_1 = require("tslib");
 const cli_ux_1 = tslib_1.__importDefault(require("./cli-ux"));
 const http_client_1 = tslib_1.__importDefault(require("./http-client"));
 const config_handler_1 = tslib_1.__importDefault(require("./config-handler"));
+const dotenv_1 = tslib_1.__importDefault(require("dotenv"));
 const ContentstackManagementSDK = tslib_1.__importStar(require("@contentstack/management"));
 const message_handler_1 = tslib_1.__importDefault(require("./message-handler"));
 const http = require('http');
@@ -11,6 +12,7 @@ const url = require('url');
 const open_1 = tslib_1.__importDefault(require("open"));
 const logger_1 = require("./logger");
 const crypto = require('crypto');
+dotenv_1.default.config();
 /**
  * @class
  * Auth handler

package/lib/authentication-handler.d.ts

@@ -0,0 +1,13 @@
+declare class AuthenticationHandler {
+    private authType;
+    private isOAuth;
+    private token;
+    constructor();
+    getAuthDetails(): Promise<void>;
+    get isOauthEnabled(): boolean;
+    get accessToken(): string;
+    refreshAccessToken(error: any, maxRetryCount?: number): Promise<void>;
+    refreshToken(hostName: string): Promise<boolean>;
+}
+declare const authenticationHandler: AuthenticationHandler;
+export default authenticationHandler;

package/lib/authentication-handler.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+class AuthenticationHandler {
+    constructor() {
+        this.token = null;
+        this.authType = index_1.configHandler.get('authorisationType');
+        this.isOAuth = this.authType === 'OAUTH';
+    }
+    async getAuthDetails() {
+        try {
+            switch (this.authType) {
+                case 'BASIC':
+                    this.token = index_1.configHandler.get('authtoken');
+                    break;
+                case 'OAUTH':
+                    await index_1.authHandler.compareOAuthExpiry();
+                    this.token = `Bearer ${index_1.configHandler.get('oauthAccessToken')}`;
+                    break;
+                default:
+                    const authToken = index_1.configHandler.get('authtoken');
+                    if (authToken) {
+                        this.token = authToken;
+                    }
+                    else {
+                        index_1.cliux.print('Session timed out, please login to proceed', {
+                            color: 'yellow',
+                        });
+                        process.exit(1);
+                    }
+                    break;
+            }
+        }
+        catch (error) {
+            index_1.cliux.print(`Error occurred while fetching auth details: ${error.message}`, {
+                color: 'red',
+            });
+            process.exit(1);
+        }
+    }
+    get isOauthEnabled() {
+        return this.isOAuth;
+    }
+    get accessToken() {
+        if (!this.token) {
+            throw new Error('Token is not available. Please authenticate first.');
+        }
+        return this.token;
+    }
+    async refreshAccessToken(error, maxRetryCount = 1) {
+        if (error.response && error.response.status) {
+            if (maxRetryCount >= 3) {
+                index_1.cliux.print('Max retry count reached, please login to proceed', {
+                    color: 'yellow',
+                });
+                process.exit(1);
+            }
+            maxRetryCount++; // Increment for the next retry attempt
+            switch (error.response.status) {
+                case 401:
+                    // NOTE: Refresh the token if the type is OAuth.
+                    const region = index_1.configHandler.get('region') || {};
+                    if (region === null || region === void 0 ? void 0 : region.cma) {
+                        let hostName = '';
+                        if (region.cma.startsWith('http')) {
+                            const u = new URL(region.cma);
+                            if (u.host)
+                                hostName = u.host;
+                        }
+                        hostName = hostName || region.cma;
+                        await this.refreshToken(hostName);
+                        return this.refreshAccessToken(error, maxRetryCount); // Retry after refreshing the token
+                    }
+                case 429:
+                case 408:
+                    // These cases require a wait, adding a delay before retrying
+                    await new Promise((resolve) => setTimeout(resolve, 1000)); // wait for 1 second
+                    return this.refreshAccessToken(error, maxRetryCount); // Retry
+                default:
+                    return; // Handle other cases if necessary
+            }
+        }
+    }
+    refreshToken(hostName) {
+        return new Promise((resolve) => {
+            if (this.authType === 'BASIC') {
+                // NOTE Handle basic auth 401 here
+                resolve(false);
+                index_1.cliux.print('Session timed out, please login to proceed', {
+                    color: 'yellow',
+                });
+                process.exit();
+            }
+            else if (this.authType === 'OAUTH') {
+                index_1.authHandler.host = hostName;
+                // NOTE Handle OAuth refresh token
+                index_1.authHandler
+                    .compareOAuthExpiry(true)
+                    .then(() => {
+                    this.token = `Bearer ${index_1.configHandler.get('oauthAccessToken')}`;
+                    resolve(true);
+                })
+                    .catch((error) => {
+                    console.log(error);
+                    resolve(false);
+                });
+            }
+            else {
+                resolve(false);
+                index_1.cliux.print('You do not have the permissions to perform this action, please login to proceed', {
+                    color: 'yellow',
+                });
+                process.exit();
+            }
+        });
+    }
+}
+const authenticationHandler = new AuthenticationHandler();
+exports.default = authenticationHandler;

package/lib/helpers.js

@@ -90,6 +90,18 @@ const formatError = function (error) {
     catch (e) {
         parsedError = error;
     }
+    // Check if parsedError is an empty object
+    if (parsedError && typeof parsedError === 'object' && Object.keys(parsedError).length === 0) {
+        return `An unknown error occurred. ${error}`;
+    }
+    // Check for specific SSL error
+    if ((parsedError === null || parsedError === void 0 ? void 0 : parsedError.code) === 'UNABLE_TO_GET_ISSUER_CERT_LOCALLY') {
+        return 'UNABLE_TO_GET_ISSUER_CERT_LOCALLY occurred during SSL certificate verification! Please check your certificate configuration.';
+    }
+    // Handle self signed certificate error
+    if ((parsedError === null || parsedError === void 0 ? void 0 : parsedError.code) === 'SELF_SIGNED_CERT_IN_CHAIN') {
+        return 'Self-signed certificate in the certificate chain! Please ensure your certificate configuration is correct and the necessary CA certificates are trusted.';
+    }
     // Determine the error message
     let message = parsedError.errorMessage || parsedError.error_message || parsedError.message || parsedError;
     if (typeof message === 'object') {

package/lib/index.d.ts

@@ -22,3 +22,4 @@ export { Args, CommandHelp, Config, Errors, Flags, loadHelpClass, Help, HelpBase
 export { FlagInput, ArgInput, FlagDefinition } from '@oclif/core/lib/interfaces/parser';
 export { default as TablePrompt } from './inquirer-table-prompt';
 export { Logger };
+export { default as authenticationHandler } from './authentication-handler';

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Logger = exports.TablePrompt = exports.stdout = exports.stderr = exports.execute = exports.ux = exports.flush = exports.settings = exports.toConfiguredId = exports.toStandardizedId = exports.run = exports.Plugin = exports.Parser = exports.Interfaces = exports.HelpBase = exports.Help = exports.loadHelpClass = exports.Flags = exports.Errors = exports.Config = exports.CommandHelp = exports.Args = exports.marketplaceSDKInitiator = exports.MarketplaceSDKInitiator = exports.marketplaceSDKClient = exports.Command = exports.flags = exports.args = exports.NodeCrypto = exports.printFlagDeprecation = exports.managementSDKInitiator = exports.managementSDKClient = exports.configHandler = exports.authHandler = exports.messageHandler = exports.CLIError = exports.cliux = exports.LoggerService = void 0;
+exports.authenticationHandler = exports.Logger = exports.TablePrompt = exports.stdout = exports.stderr = exports.execute = exports.ux = exports.flush = exports.settings = exports.toConfiguredId = exports.toStandardizedId = exports.run = exports.Plugin = exports.Parser = exports.Interfaces = exports.HelpBase = exports.Help = exports.loadHelpClass = exports.Flags = exports.Errors = exports.Config = exports.CommandHelp = exports.Args = exports.marketplaceSDKInitiator = exports.MarketplaceSDKInitiator = exports.marketplaceSDKClient = exports.Command = exports.flags = exports.args = exports.NodeCrypto = exports.printFlagDeprecation = exports.managementSDKInitiator = exports.managementSDKClient = exports.configHandler = exports.authHandler = exports.messageHandler = exports.CLIError = exports.cliux = exports.LoggerService = void 0;
 const tslib_1 = require("tslib");
 const logger_1 = tslib_1.__importDefault(require("./logger"));
 exports.Logger = logger_1.default;
@@ -62,3 +62,5 @@ Object.defineProperty(exports, "stderr", { enumerable: true, get: function () {
 Object.defineProperty(exports, "stdout", { enumerable: true, get: function () { return core_1.stdout; } });
 var inquirer_table_prompt_1 = require("./inquirer-table-prompt");
 Object.defineProperty(exports, "TablePrompt", { enumerable: true, get: function () { return tslib_1.__importDefault(inquirer_table_prompt_1).default; } });
+var authentication_handler_1 = require("./authentication-handler");
+Object.defineProperty(exports, "authenticationHandler", { enumerable: true, get: function () { return tslib_1.__importDefault(authentication_handler_1).default; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-utilities",
-  "version": "1.7.3",
+  "version": "1.8.0",
   "description": "Utilities for contentstack projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -41,6 +41,7 @@
     "cli-table": "^0.3.11",
     "conf": "^10.2.0",
     "debug": "^4.1.1",
+    "dotenv": "^16.4.5",
     "figures": "^3.2.0",
     "inquirer": "8.2.4",
     "inquirer-search-checkbox": "^1.0.0",