@contentstack/apps-cli 1.6.0 → 1.6.2

package/README.md

@@ -16,34 +16,31 @@ $ csdx plugins:install @contentstack/apps-cli
 This plugin requires you to be authenticated using [csdx auth:login](https://www.contentstack.com/docs/developers/cli/authenticate-with-the-cli/).
 
 <!-- usage -->
-
 ```sh-session
 $ npm install -g @contentstack/apps-cli
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/apps-cli/1.6.0 darwin-arm64 node-v22.13.1
+@contentstack/apps-cli/1.6.1 darwin-arm64 node-v18.20.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
 ...
 ```
-
 <!-- usagestop -->
 
 # Commands
 
 <!-- commands -->
-
-- [`csdx app`](#csdx-app)
-- [`csdx app:create`](#csdx-appcreate)
-- [`csdx app:delete`](#csdx-appdelete)
-- [`csdx app:deploy`](#csdx-appdeploy)
-- [`csdx app:get`](#csdx-appget)
-- [`csdx app:install`](#csdx-appinstall)
-- [`csdx app:reinstall`](#csdx-appreinstall)
-- [`csdx app:uninstall`](#csdx-appuninstall)
-- [`csdx app:update`](#csdx-appupdate)
+* [`csdx app`](#csdx-app)
+* [`csdx app:create`](#csdx-appcreate)
+* [`csdx app:delete`](#csdx-appdelete)
+* [`csdx app:deploy`](#csdx-appdeploy)
+* [`csdx app:get`](#csdx-appget)
+* [`csdx app:install`](#csdx-appinstall)
+* [`csdx app:reinstall`](#csdx-appreinstall)
+* [`csdx app:uninstall`](#csdx-appuninstall)
+* [`csdx app:update`](#csdx-appupdate)
 
 ## `csdx app`
 
@@ -74,7 +71,7 @@ EXAMPLES
   $ csdx app:update
 ```
 
-_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.6.0/src/commands/app/index.ts)_
+_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/index.ts)_
 
 ## `csdx app:create`
 
@@ -114,7 +111,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.6.0/src/commands/app/create.ts)_
+_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/create.ts)_
 
 ## `csdx app:delete`
 
@@ -139,7 +136,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.6.0/src/commands/app/delete.ts)_
+_See code: [src/commands/app/delete.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/delete.ts)_
 
 ## `csdx app:deploy`
 
@@ -177,7 +174,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.6.0/src/commands/app/deploy.ts)_
+_See code: [src/commands/app/deploy.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/deploy.ts)_
 
 ## `csdx app:get`
 
@@ -207,7 +204,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.6.0/src/commands/app/get.ts)_
+_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/get.ts)_
 
 ## `csdx app:install`
 
@@ -233,7 +230,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.6.0/src/commands/app/install.ts)_
+_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/install.ts)_
 
 ## `csdx app:reinstall`
 
@@ -259,7 +256,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.6.0/src/commands/app/reinstall.ts)_
+_See code: [src/commands/app/reinstall.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/reinstall.ts)_
 
 ## `csdx app:uninstall`
 
@@ -286,7 +283,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.6.0/src/commands/app/uninstall.ts)_
+_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/uninstall.ts)_
 
 ## `csdx app:update`
 
@@ -309,6 +306,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.6.0/src/commands/app/update.ts)_
-
+_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/update.ts)_
 <!-- commandsstop -->

package/lib/commands/app/create.js

@@ -92,9 +92,6 @@ class Create extends base_command_1.BaseCommand {
      */
     async flagsPromptQueue() {
         var _a;
-        if (this.sharedConfig.appName) {
-            (0, util_1.validateAppName)(this.sharedConfig.appName);
-        }
         let boilerplate = null;
         if ((0, isEmpty_1.default)(this.sharedConfig.boilerplateName)) {
             boilerplate = await (0, util_1.selectedBoilerplate)();
@@ -103,13 +100,20 @@ class Create extends base_command_1.BaseCommand {
             boilerplate = (await (0, util_1.validateBoilerplate)(this.sharedConfig.boilerplateName));
         }
         if (boilerplate) {
-            let boilerplateName = this.sharedConfig.appName || boilerplate.name;
-            if ((0, isEmpty_1.default)(this.sharedConfig.appName)) {
-                boilerplateName = boilerplateName
-                    .toLowerCase()
-                    .replace(/ /g, "-")
-                    .substring(0, 20);
+            let appName = this.sharedConfig.appName;
+            if (!appName) {
+                appName = await cli_utilities_1.cliux.inquire({
+                    type: "input",
+                    name: "appName",
+                    message: "Enter App Name",
+                    default: boilerplate.name,
+                });
             }
+            (0, util_1.validateAppName)(appName);
+            const boilerplateName = appName
+                .toLowerCase()
+                .replace(/ /g, "-")
+                .substring(0, 20);
             this.sharedConfig.boilerplateName = boilerplateName;
             this.sharedConfig.appBoilerplateGithubUrl = boilerplate.link;
             this.sharedConfig.appName = boilerplateName;

package/lib/commands/app/deploy.js

@@ -37,7 +37,7 @@ class Deploy extends app_cli_base_command_1.AppCLIBaseCommand {
                     await this.handleHostingWithLaunch(config, updateHostingPayload, projects);
                     break;
                 default:
-                    this.log("Please provide a valid Hosting Type.", "error");
+                    this.log("Provide a valid hosting type.", "error");
                     return;
             }
             if (this.flags["app-uid"]) {
@@ -125,7 +125,7 @@ class Deploy extends app_cli_base_command_1.AppCLIBaseCommand {
             url = await this.handleNewProject(config, updateHostingPayload);
         }
         else {
-            this.log("Please provide a valid launch project.", "error");
+            this.log("Provide a valid Launch project.", "error");
             return;
         }
         this.flags["app-url"] = (0, util_1.formatUrl)(url);

package/lib/commands/app/update.js

@@ -130,8 +130,8 @@ class Update extends app_cli_base_command_1.AppCLIBaseCommand {
      * @memberof Create
      */
     async updateAppOnDeveloperHub() {
-        let app = this.managementAppSdk
-            .organization(this.orgUid)
+        let app = this.marketplaceAppSdk
+            .marketplace(this.orgUid)
             .app(this.manifestData.uid);
         app = Object.assign(app, this.manifestData);
         await app

package/lib/messages/index.js

@@ -2,21 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deployAppMsg = exports.reinstallAppMsg = exports.uninstallAppMsg = exports.installAppMsg = exports.deleteAppMsg = exports.getAppMsg = exports.appUpdate = exports.appCreate = exports.commonMsg = exports.errors = exports.$t = void 0;
 const errors = {
-    NOT_EMPTY: "{value} cannot be empty.",
-    INVALID_APP_ID: "Please enter a valid app UID.",
+    NOT_EMPTY: "{value} is required and cannot be empty.",
+    INVALID_APP_ID: "Enter a valid app UID.",
     ORG_UID_NOT_FOUND: "Organization UID not found. Please enter a valid organization UID.",
-    BASE_URL_EMPTY: "Developer Hub URL cannot be empty.",
-    INVALID_ORG_UID: "Please enter a valid organization UID.",
-    PATH_NOT_FOUND: "Failed to locate the provided path '{path}'. Please enter a valid path.",
-    INVALID_NAME: "Please enter a valid name that is {min} to {max} characters long.",
-    FILE_GENERATION_FAILURE: "Failed to generate the file! Please try running the command again.",
-    APP_CREATION_FAILURE: "App could not be registered on Developer Hub.",
-    APP_UID_NOT_MATCH: "Provided app UID is not matching with the app manifest.json app UID",
-    APP_CREATION_CONSTRAINT_FAILURE: "App could not be registered. Please go through the constraints on the app name and try running the command again.",
-    APP_CREATE_FAILURE_AND_ROLLBACK: "App creation should fail and rollback",
-    APP_INVALID_ORG: "App could not be registered. Please verify the inputs and try again.",
-    DUPLICATE_APP_NAME: "The {appName} app already exists. Please create an app with a different name.",
-    INVALID_URL: "Please enter a valid URL. The URL should start with http:// or https://",
+    BASE_URL_EMPTY: "Developer Hub URL is required.",
+    INVALID_ORG_UID: "Enter a valid organization UID.",
+    PATH_NOT_FOUND: "Path {path} not found. Enter a valid path.",
+    INVALID_NAME: "Name must be between {min} and {max} characters.",
+    FILE_GENERATION_FAILURE: "File generation failed. Try running the command again.",
+    APP_CREATION_FAILURE: "Failed to register app on Developer Hub.",
+    APP_UID_NOT_MATCH: "App UID doesn't match the value in manifest.json.",
+    APP_CREATION_CONSTRAINT_FAILURE: "App registration failed. Check the name constraints and try again.",
+    APP_CREATE_FAILURE_AND_ROLLBACK: "App creation failed. Changes have been rolled back.",
+    APP_INVALID_ORG: "App registration failed. Verify the inputs and try again.",
+    DUPLICATE_APP_NAME: "App {appName} already exists. Use a different name.",
+    INVALID_URL: "Enter a valid URL starting with http:// or https://.",
 };
 exports.errors = errors;
 const commonMsg = {
@@ -29,10 +29,10 @@ const commonMsg = {
     DEVELOPER_HUB_URL_PROMPT: "Enter the Developer Hub Base URL for the {name} region: ",
     APP_UID: "Provide the app UID of an existing app.",
     APP_TYPE_DESCRIPTION: "Type of app",
-    CONTACT_SUPPORT: "Please contact the support team.",
+    CONTACT_SUPPORT: "Contact the support team for help.",
     STACK_API_KEY: "API key of the stack where the app operation is to be performed.",
     USER_TERMINATION: "Process terminated by the user.",
-    CLI_APP_CLI_LOGIN_FAILED: 'You are not logged in. Please login with command $ csdx auth:login'
+    CLI_APP_CLI_LOGIN_FAILED: "You're not logged in. Run $ csdx auth:login to continue."
 };
 exports.commonMsg = commonMsg;
 const appCreate = {
@@ -118,7 +118,7 @@ const deployAppMsg = {
     HOSTING_TYPE: "Choose a valid Hosting Type.",
     CONFIG_FILE: "[optional] Please enter the path of the config file.",
     APP_UPDATE_TERMINATION_MSG: "The app is already connected to the Launch project. Skipping the app hosting updates process.",
-    DISCONNECT_PROJECT: "Are you sure you wan to disconnect the Launch project?",
+    DISCONNECT_PROJECT: "Disconnect the Launch project? This action can't be undone.",
     PROJECT_NOT_FOUND: "We couldn't find the project. Please enter a valid project name.",
     PROJECT_NAME_CONFLICT_FAILED: "Unable to resolve the project name conflict."
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/apps-cli",
-  "version": "1.6.0",
+  "version": "1.6.2",
   "description": "App ClI",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/contentstack-apps-cli",
@@ -84,7 +84,8 @@
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif readme && git add README.md",
     "clean": "rm -rf ./lib tsconfig.tsbuildinfo oclif.manifest.json",
-    "test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\""
+    "test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\"",
+    "test:unit:report:json": "mocha --reporter json --reporter-options output=report.json --forbid-only \"test/unit/**/*.test.ts\" && nyc --reporter=clover --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\""
   },
   "engines": {
     "node": ">=16"