@contentstack/apps-cli 1.3.0 → 1.3.1

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @contentstack/apps-cli
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/apps-cli/1.3.0 darwin-arm64 node-v18.16.0
+@contentstack/apps-cli/1.3.1 darwin-arm64 node-v18.20.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -54,20 +54,22 @@ DESCRIPTION
 EXAMPLES
   $ csdx app:create
 
-  $ csdx app:get
+  $ csdx app:delete
 
-  $ csdx app:update
+  $ csdx app:deploy
 
-  $ csdx app:delete
+  $ csdx app:get
 
   $ csdx app:install
 
+  $ csdx app:reinstall
+
   $ csdx app:uninstall
 
-  $ csdx app:reinstall
+  $ csdx app:update
 ```
 
-_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/index.ts)_
+_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.3.1/src/commands/app/index.ts)_
 
 ## `csdx app:create`
 
@@ -76,7 +78,7 @@ Create a new app in Developer Hub and optionally clone a boilerplate locally.
 ```
 USAGE
   $ csdx app:create [-n <value>] [--app-type stack|organization] [-c <value>] [-d <value>] [--boilerplate
-    <value>]
+    <value>] [--org <value>]
 
 FLAGS
   -c, --config=<value>    Path of the external config
@@ -84,7 +86,9 @@ FLAGS
   -n, --name=<value>      Name of the app to be created
   --app-type=<option>     [default: stack] Type of app
                           <options: stack|organization>
-  --boilerplate=<value>   Provide a boilerplate. <options: App Boilerplate|DAM App Boilerplate|Ecommerce App Boilerplate>
+  --boilerplate=<value>   Provide a boilerplate. <options: App Boilerplate|DAM App Boilerplate|Ecommerce App
+                          Boilerplate>
+  --org=<value>           Provide the organization UID to fetch the app details for the operation.
 
 DESCRIPTION
   Create a new app in Developer Hub and optionally clone a boilerplate locally.
@@ -105,7 +109,7 @@ EXAMPLES
   $ csdx app:create --name App-4 --app-type organization --org <UID> --boilerplate <Ecommerce App Boilerplate>
 ```
 
-_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/create.ts)_
+_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.3.1/src/commands/app/create.ts)_
 
 ## `csdx app:delete`
 
@@ -113,10 +117,11 @@ Delete app from marketplace
 
 ```
 USAGE
-  $ csdx app:delete [--app-uid <value>]
+  $ csdx app:delete [--app-uid <value>] [--org <value>]
 
 FLAGS
   --app-uid=<value>  Provide the app UID of an existing app.
+  --org=<value>      Provide the organization UID to fetch the app details for the operation.
 
 DESCRIPTION
   Delete app from marketplace
@@ -129,7 +134,7 @@ EXAMPLES
   $ csdx app:delete --app-uid <value> --org <value> -d ./boilerplate
 ```
 
-_See code: [src/commands/app/delete.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/delete.ts)_
+_See code: [src/commands/app/delete.ts](https://github.com/contentstack/apps-cli/blob/v1.3.1/src/commands/app/delete.ts)_
 
 ## `csdx app:deploy`
 
@@ -138,7 +143,7 @@ Deploy an app
 ```
 USAGE
   $ csdx app:deploy [--app-uid <value>] [--hosting-type Hosting with Launch|Custom Hosting] [--app-url <value>]
-    [--launch-project existing|new] [-c <value>]
+    [--launch-project existing|new] [-c <value>] [--org <value>]
 
 FLAGS
   -c, --config=<value>       [optional] Please enter the path of the config file.
@@ -148,6 +153,7 @@ FLAGS
                              <options: Hosting with Launch|Custom Hosting>
   --launch-project=<option>  Choose a new or an existing Launch project.
                              <options: existing|new>
+  --org=<value>              Provide the organization UID to fetch the app details for the operation.
 
 DESCRIPTION
   Deploy an app
@@ -166,7 +172,7 @@ EXAMPLES
   $ csdx app:deploy --org <UID> --app-uid <APP-UID-1> --hosting-type <Hosting with Launch> --launch-project <new> --config <config-path>
 ```
 
-_See code: [src/commands/app/deploy.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/deploy.ts)_
+_See code: [src/commands/app/deploy.ts](https://github.com/contentstack/apps-cli/blob/v1.3.1/src/commands/app/deploy.ts)_
 
 ## `csdx app:get`
 
@@ -174,13 +180,14 @@ Get details of an app in developer hub
 
 ```
 USAGE
-  $ csdx app:get [--app-uid <value>] [--app-type stack|organization] [-d <value>]
+  $ csdx app:get [--app-uid <value>] [--app-type stack|organization] [-d <value>] [--org <value>]
 
 FLAGS
   -d, --data-dir=<value>  Current working directory.
   --app-type=<option>     [default: stack] Type of app
                           <options: stack|organization>
   --app-uid=<value>       Provide the app UID of an existing app.
+  --org=<value>           Provide the organization UID to fetch the app details for the operation.
 
 DESCRIPTION
   Get details of an app in developer hub
@@ -195,7 +202,7 @@ EXAMPLES
   $ csdx app:get --org <value> --app-uid <value> --app-type organization
 ```
 
-_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/get.ts)_
+_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v1.3.1/src/commands/app/get.ts)_
 
 ## `csdx app:install`
 
@@ -203,10 +210,11 @@ Install an app from the marketplace
 
 ```
 USAGE
-  $ csdx app:install [--app-uid <value>] [--stack-api-key <value>]
+  $ csdx app:install [--app-uid <value>] [--stack-api-key <value>] [--org <value>]
 
 FLAGS
   --app-uid=<value>        Provide the app UID of an existing app.
+  --org=<value>            Provide the organization UID to fetch the app details for the operation.
   --stack-api-key=<value>  API key of the stack where the app operation is to be performed.
 
 DESCRIPTION
@@ -220,7 +228,7 @@ EXAMPLES
   $ 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/v1.3.0/src/commands/app/install.ts)_
+_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v1.3.1/src/commands/app/install.ts)_
 
 ## `csdx app:reinstall`
 
@@ -228,10 +236,11 @@ Reinstall an app from the marketplace
 
 ```
 USAGE
-  $ csdx app:reinstall [--app-uid <value>] [--stack-api-key <value>]
+  $ csdx app:reinstall [--app-uid <value>] [--stack-api-key <value>] [--org <value>]
 
 FLAGS
   --app-uid=<value>        Provide the app UID of an existing app.
+  --org=<value>            Provide the organization UID to fetch the app details for the operation.
   --stack-api-key=<value>  API key of the stack where the app operation is to be performed.
 
 DESCRIPTION
@@ -245,7 +254,7 @@ EXAMPLES
   $ csdx app:reinstall --org <UID> --app-uid <APP-UID-1> --stack-api-key <STACK-API-KEY-1>
 ```
 
-_See code: [src/commands/app/reinstall.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/reinstall.ts)_
+_See code: [src/commands/app/reinstall.ts](https://github.com/contentstack/apps-cli/blob/v1.3.1/src/commands/app/reinstall.ts)_
 
 ## `csdx app:uninstall`
 
@@ -253,11 +262,12 @@ Uninstall an app
 
 ```
 USAGE
-  $ csdx app:uninstall [--app-uid <value>] [--installation-uid <value>] [--uninstall-all]
+  $ csdx app:uninstall [--app-uid <value>] [--installation-uid <value>] [--uninstall-all] [--org <value>]
 
 FLAGS
   --app-uid=<value>           Provide the app UID of an existing app.
   --installation-uid=<value>  Provide the installation ID of the app that needs to be uninstalled.
+  --org=<value>               Provide the organization UID to fetch the app details for the operation.
   --uninstall-all             Please select stacks from where the app must be uninstalled.
 
 DESCRIPTION
@@ -271,7 +281,7 @@ EXAMPLES
   $ 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/v1.3.0/src/commands/app/uninstall.ts)_
+_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v1.3.1/src/commands/app/uninstall.ts)_
 
 ## `csdx app:update`
 
@@ -279,10 +289,11 @@ Update the existing app in developer hub
 
 ```
 USAGE
-  $ csdx app:update [--app-manifest <value>]
+  $ csdx app:update [--app-manifest <value>] [--org <value>]
 
 FLAGS
   --app-manifest=<value>  Path to the app manifest.json file:
+  --org=<value>           Provide the organization UID to fetch the app details for the operation.
 
 DESCRIPTION
   Update the existing app in developer hub
@@ -293,5 +304,5 @@ EXAMPLES
   $ csdx app:update --app-manifest ./boilerplate/manifest.json
 ```
 
-_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/update.ts)_
+_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.3.1/src/commands/app/update.ts)_
 <!-- commandsstop -->

package/lib/base-command.js

@@ -29,14 +29,14 @@ class BaseCommand extends cli_command_1.Command {
         this.args = args;
         cli_utilities_1.cliux.registerSearchPlugin();
         this.registerConfig();
-        this.developerHubBaseUrl =
-            this.sharedConfig.developerHubBaseUrl || (0, util_1.getDeveloperHubUrl)();
-        await this.initCmaSDK();
-        await this.initMarketplaceSDK();
         // Init logger
         const logger = new util_1.Logger(this.sharedConfig);
         this.log = logger.log.bind(logger);
         this.validateRegionAndAuth();
+        this.developerHubBaseUrl =
+            this.sharedConfig.developerHubBaseUrl || (0, util_1.getDeveloperHubUrl)();
+        await this.initCmaSDK();
+        await this.initMarketplaceSDK();
     }
     async catch(err) {
         // add any custom logic to handle errors from the command

package/lib/commands/app/create.js

@@ -325,26 +325,20 @@ Create.examples = [
     "$ <%= config.bin %> <%= command.id %> --name App-4 --app-type organization --org <UID> --boilerplate <DAM App Boilerplate>",
     "$ <%= config.bin %> <%= command.id %> --name App-4 --app-type organization --org <UID> --boilerplate <Ecommerce App Boilerplate>",
 ];
-Create.flags = {
-    name: cli_utilities_1.flags.string({
+Create.flags = Object.assign({ name: cli_utilities_1.flags.string({
         char: "n",
         description: messages_1.appCreate.NAME_DESCRIPTION,
-    }),
-    "app-type": cli_utilities_1.flags.string({
+    }), "app-type": cli_utilities_1.flags.string({
         default: "stack",
         options: ["stack", "organization"],
         description: messages_1.appCreate.APP_TYPE_DESCRIPTION,
-    }),
-    config: cli_utilities_1.flags.string({
+    }), config: cli_utilities_1.flags.string({
         char: "c",
         description: messages_1.commonMsg.CONFIG,
-    }),
-    "data-dir": cli_utilities_1.flags.string({
+    }), "data-dir": cli_utilities_1.flags.string({
         char: "d",
         description: messages_1.commonMsg.CURRENT_WORKING_DIR,
-    }),
-    boilerplate: cli_utilities_1.flags.string({
+    }), boilerplate: cli_utilities_1.flags.string({
         description: messages_1.appCreate.BOILERPLATE_TEMPLATES,
-    }),
-};
+    }) }, base_command_1.BaseCommand.baseFlags);
 exports.default = Create;

package/lib/commands/app/delete.js

@@ -67,9 +67,7 @@ Delete.examples = [
     "$ <%= config.bin %> <%= command.id %> --app-uid <value>",
     "$ <%= config.bin %> <%= command.id %> --app-uid <value> --org <value> -d ./boilerplate",
 ];
-Delete.flags = {
-    "app-uid": cli_utilities_1.flags.string({
+Delete.flags = Object.assign({ "app-uid": cli_utilities_1.flags.string({
         description: messages_1.commonMsg.APP_UID,
-    }),
-};
+    }) }, app_cli_base_command_1.AppCLIBaseCommand.baseFlags);
 exports.default = Delete;

package/lib/commands/app/deploy.js

@@ -208,26 +208,20 @@ Deploy.examples = [
     "$ <%= config.bin %> <%= command.id %> --org <UID> --app-uid <APP-UID-1> --hosting-type <Hosting with Launch> --launch-project <new>",
     "$ <%= config.bin %> <%= command.id %> --org <UID> --app-uid <APP-UID-1> --hosting-type <Hosting with Launch> --launch-project <new> --config <config-path>",
 ];
-Deploy.flags = {
-    "app-uid": cli_utilities_1.Flags.string({
+Deploy.flags = Object.assign({ "app-uid": cli_utilities_1.Flags.string({
         description: messages_1.commonMsg.APP_UID,
-    }),
-    "hosting-type": cli_utilities_1.Flags.string({
+    }), "hosting-type": cli_utilities_1.Flags.string({
         multiple: false,
         options: ["Hosting with Launch", "Custom Hosting"],
         description: messages_1.deployAppMsg.HOSTING_TYPE,
-    }),
-    "app-url": cli_utilities_1.Flags.string({
+    }), "app-url": cli_utilities_1.Flags.string({
         description: messages_1.deployAppMsg.APP_URL,
-    }),
-    "launch-project": cli_utilities_1.Flags.string({
+    }), "launch-project": cli_utilities_1.Flags.string({
         multiple: false,
         options: ["existing", "new"],
         description: messages_1.deployAppMsg.LAUNCH_PROJECT,
-    }),
-    config: cli_utilities_1.Flags.string({
+    }), config: cli_utilities_1.Flags.string({
         char: "c",
         description: messages_1.deployAppMsg.CONFIG_FILE,
-    }),
-};
+    }) }, app_cli_base_command_1.AppCLIBaseCommand.baseFlags);
 exports.default = Deploy;

package/lib/commands/app/get.js

@@ -42,18 +42,14 @@ Get.examples = [
     "$ <%= config.bin %> <%= command.id %> --org <value> --app-uid <value> --app-type stack",
     "$ <%= config.bin %> <%= command.id %> --org <value> --app-uid <value> --app-type organization",
 ];
-Get.flags = {
-    "app-uid": cli_utilities_1.flags.string({
+Get.flags = Object.assign({ "app-uid": cli_utilities_1.flags.string({
         description: messages_1.commonMsg.APP_UID,
-    }),
-    "app-type": cli_utilities_1.flags.string({
+    }), "app-type": cli_utilities_1.flags.string({
         default: "stack",
         options: ["stack", "organization"],
         description: messages_1.commonMsg.APP_TYPE_DESCRIPTION,
-    }),
-    "data-dir": cli_utilities_1.flags.string({
+    }), "data-dir": cli_utilities_1.flags.string({
         char: "d",
         description: messages_1.commonMsg.CURRENT_WORKING_DIR,
-    }),
-};
+    }) }, app_cli_base_command_1.AppCLIBaseCommand.baseFlags);
 exports.default = Get;

package/lib/commands/app/index.js

@@ -25,11 +25,12 @@ class App extends cli_utilities_1.Command {
 App.description = "Apps CLI plugin";
 App.examples = [
     "$ <%= config.bin %> <%= command.id %>:create",
-    "$ <%= config.bin %> <%= command.id %>:get",
-    "$ <%= config.bin %> <%= command.id %>:update",
     "$ <%= config.bin %> <%= command.id %>:delete",
+    "$ <%= config.bin %> <%= command.id %>:deploy",
+    "$ <%= config.bin %> <%= command.id %>:get",
     "$ <%= config.bin %> <%= command.id %>:install",
-    "$ <%= config.bin %> <%= command.id %>:uninstall",
     "$ <%= config.bin %> <%= command.id %>:reinstall",
+    "$ <%= config.bin %> <%= command.id %>:uninstall",
+    "$ <%= config.bin %> <%= command.id %>:update",
 ];
 exports.default = App;

package/lib/commands/app/install.js

@@ -109,12 +109,9 @@ Install.examples = [
     "$ <%= config.bin %> <%= command.id %> --org <UID> --app-uid <APP-UID-1>",
     "$ <%= config.bin %> <%= command.id %> --org <UID> --app-uid <APP-UID-1> --stack-api-key <STACK-API-KEY-1>",
 ];
-Install.flags = {
-    "app-uid": cli_utilities_1.flags.string({
+Install.flags = Object.assign({ "app-uid": cli_utilities_1.flags.string({
         description: messages_1.commonMsg.APP_UID,
-    }),
-    "stack-api-key": cli_utilities_1.flags.string({
+    }), "stack-api-key": cli_utilities_1.flags.string({
         description: messages_1.commonMsg.STACK_API_KEY,
-    }),
-};
+    }) }, app_cli_base_command_1.AppCLIBaseCommand.baseFlags);
 exports.default = Install;

package/lib/commands/app/reinstall.js

@@ -94,12 +94,9 @@ Reinstall.examples = [
     "$ <%= config.bin %> <%= command.id %> --org <UID> --app-uid <APP-UID-1>",
     "$ <%= config.bin %> <%= command.id %> --org <UID> --app-uid <APP-UID-1> --stack-api-key <STACK-API-KEY-1>",
 ];
-Reinstall.flags = {
-    "app-uid": cli_utilities_1.flags.string({
+Reinstall.flags = Object.assign({ "app-uid": cli_utilities_1.flags.string({
         description: messages_1.commonMsg.APP_UID,
-    }),
-    "stack-api-key": cli_utilities_1.flags.string({
+    }), "stack-api-key": cli_utilities_1.flags.string({
         description: messages_1.commonMsg.STACK_API_KEY,
-    }),
-};
+    }) }, app_cli_base_command_1.AppCLIBaseCommand.baseFlags);
 exports.default = Reinstall;

package/lib/commands/app/uninstall.js

@@ -39,15 +39,11 @@ Uninstall.examples = [
     "$ <%= config.bin %> <%= command.id %> --org <UID> --app-uid <APP-UID-1>",
     "$ <%= config.bin %> <%= command.id %> --org <UID> --app-uid <APP-UID-1> --installation-uid <INSTALLATION-UID-1>",
 ];
-Uninstall.flags = {
-    'app-uid': cli_utilities_1.flags.string({
+Uninstall.flags = Object.assign({ 'app-uid': cli_utilities_1.flags.string({
         description: messages_1.commonMsg.APP_UID,
-    }),
-    'installation-uid': cli_utilities_1.flags.string({
+    }), 'installation-uid': cli_utilities_1.flags.string({
         description: messages_1.uninstallAppMsg.INSTALLATION_UID
-    }),
-    'uninstall-all': cli_utilities_1.flags.boolean({
+    }), 'uninstall-all': cli_utilities_1.flags.boolean({
         description: messages_1.uninstallAppMsg.UNINSTALL_ALL,
-    }),
-};
+    }) }, app_cli_base_command_1.AppCLIBaseCommand.baseFlags);
 exports.default = Uninstall;

package/lib/commands/app/update.js

@@ -187,9 +187,7 @@ Update.examples = [
     "$ <%= config.bin %> <%= command.id %>",
     "$ <%= config.bin %> <%= command.id %> --app-manifest ./boilerplate/manifest.json",
 ];
-Update.flags = {
-    "app-manifest": cli_utilities_1.flags.string({
+Update.flags = Object.assign({ "app-manifest": cli_utilities_1.flags.string({
         description: (0, messages_1.$t)(messages_1.appUpdate.FILE_PATH, { fileName: "app manifest.json" }),
-    }),
-};
+    }) }, app_cli_base_command_1.AppCLIBaseCommand.baseFlags);
 exports.default = Update;

package/lib/util/inquirer.js

@@ -126,6 +126,9 @@ exports.getInstalledApps = getInstalledApps;
  */
 function getDeveloperHubUrl() {
     const { cma } = cli_utilities_1.configHandler.get("region") || {};
+    if (!cma) {
+        throw new Error("Region not configured. Please set the region with command $ csdx config:set:region");
+    }
     let developerHubBaseUrl = cma.replace("api", "developerhub-api");
     if (developerHubBaseUrl.startsWith("http")) {
         developerHubBaseUrl = developerHubBaseUrl.split("//")[1];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/apps-cli",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "App ClI",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/contentstack-apps-cli",
@@ -23,7 +23,7 @@
     "@apollo/client": "^3.7.9",
     "@contentstack/cli-command": "^1.2.18",
     "@contentstack/cli-launch": "^1.0.18",
-    "@contentstack/cli-utilities": "^1.6.2",
+    "@contentstack/cli-utilities": "^1.7.0",
     "adm-zip": "^0.5.10",
     "chalk": "^4.1.2",
     "lodash": "^4.17.21",