Merge pull request #74 from contentstack/fix/CS-40403

fix: handled errors and set hidden to false

Author: abhinav-from-contentstack

README.md

@@ -28,7 +28,7 @@ $ npm install -g @contentstack/apps-cli
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/apps-cli/0.0.0-alpha-1 darwin-arm64 node-v16.19.0
+@contentstack/apps-cli/0.0.0-alpha-1 darwin-arm64 node-v20.3.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -41,6 +41,8 @@ USAGE
 * [`csdx app:create`](#csdx-appcreate)
 * [`csdx app:delete`](#csdx-appdelete)
 * [`csdx app:get`](#csdx-appget)
+* [`csdx app:install`](#csdx-appinstall)
+* [`csdx app:uninstall`](#csdx-appuninstall)
 * [`csdx app:update`](#csdx-appupdate)
 
 ## `csdx app:create`
@@ -132,6 +134,60 @@ EXAMPLES
 
 _See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v0.0.0-alpha-1/src/commands/app/get.ts)_
 
+## `csdx app:install`
+
+Install an app from the marketplace
+
+```
+USAGE
+  $ csdx app:install [--org <value>] [-y] [--app-uid <value>] [--stack-api-key <value>]
+
+FLAGS
+  -y, --yes                Use this flag to skip the confirmation.
+  --app-uid=<value>        Provide the app UID
+  --org=<value>            Provide the organization UID
+  --stack-api-key=<value>  API key of the stack where the app is to be installed.
+
+DESCRIPTION
+  Install an app from the marketplace
+
+EXAMPLES
+  $ csdx app:install
+
+  $ csdx app:install --org <UID> --app-uid <APP-UID-1>
+
+  $ csdx app:install --org <UID> --app-uid <APP-UID-1> --stack-api-key <STACK-API-KEY-1>
+```
+
+_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v0.0.0-alpha-1/src/commands/app/install.ts)_
+
+## `csdx app:uninstall`
+
+Uninstall an app
+
+```
+USAGE
+  $ csdx app:uninstall [--org <value>] [-y] [--app-uid <value>] [--installation-uid <value>]
+
+FLAGS
+  -y, --yes                   Use this flag to skip the confirmation.
+  --app-uid=<value>           Provide the app UID
+  --installation-uid=<value>  Provide the installation ID of the app that needs to be uninstalled.
+  --org=<value>               Provide the organization UID
+
+DESCRIPTION
+  Uninstall an app
+
+EXAMPLES
+  $ csdx app:uninstall
+
+  $ csdx app:uninstall --org <UID> --app-uid <APP-UID-1>
+
+  $ csdx app:uninstall --org <UID> --app-uid <APP-UID-1> --installation-uid <INSTALLATION-UID-1>
+```
+
+_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v0.0.0-alpha-1/src/commands/app/uninstall.ts)_
+
 ## `csdx app:update`
 
 Update the existing app in developer hub

src/commands/app/delete.ts

@@ -53,7 +53,7 @@ export default class Delete extends BaseCommand<typeof Delete> {
         this.log(deleteAppMsg.APP_IS_INSTALLED, "error");
       }
     } catch (error: any) {
-      this.log(error.errorMessage, "error");
+      this.log(error?.errorMessage || error?.message || error, "error");
       if (error.status === 400) {
         // check for invalid app-uid
         this.log(deleteAppMsg.PLEASE_SELECT_APP_FROM_LIST);

src/commands/app/get.ts

@@ -55,8 +55,8 @@ export default class Get extends BaseCommand<typeof Get> {
         this.log
       );
     } catch (error: any) {
-      this.log(error.errorMessage, "error");
-      this.exit();
+      this.log(error?.errorMessage || error?.message || error, "error");
+      this.exit(1);
     }
   }
 }

src/commands/app/index.ts

@@ -14,6 +14,8 @@ export default class App extends Command {
     "$ <%= config.bin %> <%= command.id %>:get",
     "$ <%= config.bin %> <%= command.id %>:update",
     "$ <%= config.bin %> <%= command.id %>:delete",
+    "$ <%= config.bin %> <%= command.id %>:install",
+    "$ <%= config.bin %> <%= command.id %>:uninstall",
   ];
 
   async run(): Promise<void> {

src/commands/app/install.ts

@@ -5,6 +5,7 @@ import { getOrg, getApp, getStack, installApp, fetchApp, fetchStack} from "../..
 
 export default class Install extends BaseCommand<typeof Install> {
     static description: string | undefined = "Install an app from the marketplace";
+    static hidden: boolean = false;
 
     static examples = [
       "$ <%= config.bin %> <%= command.id %>",
@@ -67,15 +68,15 @@ export default class Install extends BaseCommand<typeof Install> {
           app: app?.name || app?.uid,
           type: appType,
           target: this.flags['stack-api-key'] || this.sharedConfig.org
-        }), "warn")
+        }), "info")
         await installApp(this.flags, this.sharedConfig.org, appType, {managementSdk: this.managementAppSdk, log: this.log})
         this.log($t(installAppMsg.APP_INSTALLED_SUCCESSFULLY, {
           app: app?.name || this.flags['app-uid'] as string,
           target: stack?.name || this.sharedConfig.org
         }), "info");
       } catch(error: any) {
         this.log(error?.errorMessage || error?.message || error, "error")
-        this.exit()
+        this.exit(1)
       }
     }
 }

src/commands/app/uninstall.ts

@@ -5,6 +5,7 @@ import { commonMsg, uninstallAppMsg } from "../../messages";
 
 export default class Uninstall extends BaseCommand<typeof Uninstall> {
     static description = "Uninstall an app";
+    static hidden: boolean = false;
 
     static examples = [
       "$ <%= config.bin %> <%= command.id %>",
@@ -17,7 +18,7 @@ export default class Uninstall extends BaseCommand<typeof Uninstall> {
         description: commonMsg.APP_UID,
       }),
       'installation-uid': flags.string({
-        description: uninstallAppMsg.CHOOSE_AN_INSTALLATION
+        description: uninstallAppMsg.INSTALLATION_UID
       })
     }
 
@@ -48,7 +49,7 @@ export default class Uninstall extends BaseCommand<typeof Uninstall> {
 
       } catch (error: any) {
         this.log(error?.errorMessage || error?.message || error, "error")
-        this.exit();
+        this.exit(1);
       }
     }
 

src/messages/index.ts

@@ -32,9 +32,9 @@ const commonMsg = {
     "Enter the Developer Hub Base URL for the {name} region: ",
   APP_UID: "Provide the app UID",
   APP_TYPE_DESCRIPTION: "Type of App",
-  CONTACT_SUPPORT: "Please contact support team.",
-  STACK_API_KEY: "Please provide api-key for the stack",
-  USER_TERMINATION: "Process terminated by user."
+  CONTACT_SUPPORT: "Please contact the support team.",
+  STACK_API_KEY: "API key of the stack where the app is to be installed.",
+  USER_TERMINATION: "Process terminated by the user."
 };
 
 const appCreate = {
@@ -75,26 +75,26 @@ const appUpdate = {
 };
 
 const deleteAppMsg = {
-  APP_IS_INSTALLED: "This app is installed in one of your stacks. Please uninstall to proceed with delete.",
-  APP_DELETED_SUCCESSFULLY: "{app} has been deleted successfully.",
-  APP_UID_INVALID: "app uid must be valid",
+  APP_IS_INSTALLED: "This app is installed in one of your stacks. Please uninstall the app from your stack to proceed with the delete operation.",
+  APP_DELETED_SUCCESSFULLY: "{app} deleted successfully.",
+  APP_UID_INVALID: "App UID must be valid.",
   PLEASE_SELECT_APP_FROM_LIST: "Please select an app from the list",
 }
 
 const installAppMsg = {
   CHOOSE_A_STACK: "Please select a stack",
-  APP_INSTALLED_SUCCESSFULLY: "{app} has been installed successfully on {target}.",
-  INSTALL_ORG_APP_TO_STACK: "{app} is an organization app, it cannot be installed to a stack. Do you want to proceed",
-  MISSING_STACK_API_KEY: "As {app} is a stack app, it can only be installed on a stack. Please select a stack.",
-  INSTALLING_APP_NOTICE: "Installing {app} on {type} {target}"
+  APP_INSTALLED_SUCCESSFULLY: "{app} installed successfully in {target}.",
+  INSTALL_ORG_APP_TO_STACK: "{app} is an organization app. It cannot be installed to a stack. Do you want to proceed?",
+  MISSING_STACK_API_KEY: "As {app} is a stack app, it can only be installed in a stack. Please select a stack.",
+  INSTALLING_APP_NOTICE: "Installing {app} on {type} {target}."
 }
 
 const uninstallAppMsg = {
-  CHOOSE_AN_INSTALLATION: "Please select where the app needs to be uninstalled",
-  INSTALLATION_UID: "Installation UID which needs to be uninstalled",
-  NO_INSTALLATIONS_FOUND: "No installations found for this app",
-  APP_UNINSTALLED: "{app} has been uninstalled successfully.",
-  UNINSTALLING_APP: "Uninstalling app from {type}"
+  CHOOSE_AN_INSTALLATION: "Please select the stack from where the app must be uninstalled",
+  INSTALLATION_UID: "Provide the installation ID of the app that needs to be uninstalled.",
+  NO_INSTALLATIONS_FOUND: "Cannot find any installations for this app.",
+  APP_UNINSTALLED: "{app} uninstalled successfully.",
+  UNINSTALLING_APP: "Uninstalling app from {type}..."
 }
 
 const messages: typeof errors &