@contentstack/apps-cli 1.2.1 → 1.3.0

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @contentstack/apps-cli
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/apps-cli/1.2.1 darwin-arm64 node-v18.12.1
+@contentstack/apps-cli/1.3.0 darwin-arm64 node-v18.16.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -67,7 +67,7 @@ EXAMPLES
   $ csdx app:reinstall
 ```
 
-_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.2.1/src/commands/app/index.ts)_
+_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/index.ts)_
 
 ## `csdx app:create`
 
@@ -75,14 +75,16 @@ 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>]
+  $ csdx app:create [-n <value>] [--app-type stack|organization] [-c <value>] [-d <value>] [--boilerplate
+    <value>]
 
 FLAGS
   -c, --config=<value>    Path of the external config
   -d, --data-dir=<value>  Current working directory.
-  -n, --name=<value>      [default: app-boilerplate] Name of the app to be created
+  -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>
 
 DESCRIPTION
   Create a new app in Developer Hub and optionally clone a boilerplate locally.
@@ -95,9 +97,15 @@ EXAMPLES
   $ csdx app:create --name App-2 --app-type stack -d ./boilerplate
 
   $ csdx app:create --name App-3 --app-type organization --org <UID> -d ./boilerplate -c ./external-config.json
+
+  $ csdx app:create --name App-4 --app-type organization --org <UID> --boilerplate <App Boilerplate>
+
+  $ csdx app:create --name App-4 --app-type organization --org <UID> --boilerplate <DAM App Boilerplate>
+
+  $ 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.2.1/src/commands/app/create.ts)_
+_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/create.ts)_
 
 ## `csdx app:delete`
 
@@ -121,7 +129,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.2.1/src/commands/app/delete.ts)_
+_See code: [src/commands/app/delete.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/delete.ts)_
 
 ## `csdx app:deploy`
 
@@ -158,7 +166,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.2.1/src/commands/app/deploy.ts)_
+_See code: [src/commands/app/deploy.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/deploy.ts)_
 
 ## `csdx app:get`
 
@@ -187,7 +195,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.2.1/src/commands/app/get.ts)_
+_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/get.ts)_
 
 ## `csdx app:install`
 
@@ -212,7 +220,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.2.1/src/commands/app/install.ts)_
+_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/install.ts)_
 
 ## `csdx app:reinstall`
 
@@ -237,7 +245,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.2.1/src/commands/app/reinstall.ts)_
+_See code: [src/commands/app/reinstall.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/reinstall.ts)_
 
 ## `csdx app:uninstall`
 
@@ -263,7 +271,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.2.1/src/commands/app/uninstall.ts)_
+_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/uninstall.ts)_
 
 ## `csdx app:update`
 
@@ -285,5 +293,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.2.1/src/commands/app/update.ts)_
+_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.3.0/src/commands/app/update.ts)_
 <!-- commandsstop -->

package/lib/commands/app/create.js

@@ -27,6 +27,7 @@ class Create extends base_command_1.BaseCommand {
     async run() {
         this.sharedConfig.org = this.flags.org;
         this.sharedConfig.appName = this.flags.name;
+        this.sharedConfig.boilerplateName = this.flags.boilerplate;
         await this.flagsPromptQueue();
         this.tempAppData.name = this.sharedConfig.appName;
         this.tempAppData.target_type = this.flags["app-type"];
@@ -81,8 +82,27 @@ class Create extends base_command_1.BaseCommand {
      */
     async flagsPromptQueue() {
         var _a;
-        if ((0, isEmpty_1.default)(this.sharedConfig.appName)) {
-            this.sharedConfig.appName = await (0, util_1.getAppName)(this.sharedConfig.defaultAppName);
+        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)();
+        }
+        else {
+            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);
+            }
+            this.sharedConfig.boilerplateName = boilerplateName;
+            this.sharedConfig.appBoilerplateGithubUrl = boilerplate.link;
+            this.sharedConfig.appName = boilerplateName;
         }
         //Auto select org in case of oauth
         this.sharedConfig.org =
@@ -126,7 +146,10 @@ class Create extends base_command_1.BaseCommand {
         const zip = new adm_zip_1.default(filepath);
         const dataDir = (_a = this.flags["data-dir"]) !== null && _a !== void 0 ? _a : process.cwd();
         let targetPath = (0, path_1.resolve)(dataDir, this.sharedConfig.appName);
-        const sourcePath = (0, path_1.resolve)(dataDir, this.sharedConfig.boilerplateName);
+        // Get the directory inside the zip file
+        const zipEntries = zip.getEntries();
+        const firstEntry = zipEntries[0];
+        const sourcePath = (0, path_1.resolve)((0, util_1.sanitizePath)(dataDir), (0, util_1.sanitizePath)(firstEntry.entryName.split("/")[0]));
         if (this.flags["data-dir"] && !(0, fs_1.existsSync)(this.flags["data-dir"])) {
             (0, fs_1.mkdirSync)(this.flags["data-dir"], { recursive: true });
         }
@@ -156,7 +179,7 @@ class Create extends base_command_1.BaseCommand {
      */
     manageManifestToggeling() {
         // NOTE Use boilerplate manifest if exist
-        const manifestPath = (0, path_1.resolve)(this.sharedConfig.folderPath || "", "manifest.json");
+        const manifestPath = (0, path_1.resolve)(this.sharedConfig.folderPath, "manifest.json");
         if ((0, fs_1.existsSync)(manifestPath)) {
             this.sharedConfig.manifestPath = manifestPath;
         }
@@ -298,11 +321,13 @@ Create.examples = [
     "$ <%= config.bin %> <%= command.id %> --name App-1 --app-type stack",
     "$ <%= config.bin %> <%= command.id %> --name App-2 --app-type stack -d ./boilerplate",
     "$ <%= config.bin %> <%= command.id %> --name App-3 --app-type organization --org <UID> -d ./boilerplate -c ./external-config.json",
+    "$ <%= config.bin %> <%= command.id %> --name App-4 --app-type organization --org <UID> --boilerplate <App Boilerplate>",
+    "$ <%= 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({
         char: "n",
-        default: "app-boilerplate",
         description: messages_1.appCreate.NAME_DESCRIPTION,
     }),
     "app-type": cli_utilities_1.flags.string({
@@ -318,5 +343,8 @@ Create.flags = {
         char: "d",
         description: messages_1.commonMsg.CURRENT_WORKING_DIR,
     }),
+    boilerplate: cli_utilities_1.flags.string({
+        description: messages_1.appCreate.BOILERPLATE_TEMPLATES,
+    }),
 };
 exports.default = Create;

package/lib/config/index.d.ts

@@ -1,9 +1,9 @@
 declare const config: {
     defaultAppName: string;
     manifestPath: string;
-    boilerplateName: string;
     developerHubBaseUrl: string;
     appBoilerplateGithubUrl: string;
     defaultAppFileName: string;
+    boilerplatesUrl: string;
 };
 export default config;

package/lib/config/index.js

@@ -4,9 +4,9 @@ const path_1 = require("path");
 const config = {
     defaultAppName: "app-boilerplate",
     manifestPath: (0, path_1.resolve)(__dirname, "manifest.json"),
-    boilerplateName: "marketplace-app-boilerplate-main",
     developerHubBaseUrl: "",
     appBoilerplateGithubUrl: "https://codeload.github.com/contentstack/marketplace-app-boilerplate/zip/refs/heads/main",
     defaultAppFileName: "manifest",
+    boilerplatesUrl: 'https://marketplace-artifacts.contentstack.com/cli/starter-template.json'
 };
 exports.default = config;

package/lib/messages/index.d.ts

@@ -44,6 +44,8 @@ declare const appCreate: {
     CONFIRM_CLONE_BOILERPLATE: string;
     REGISTER_THE_APP_ON_DEVELOPER_HUB: string;
     START_APP_COMMAND: string;
+    BOILERPLATE_TEMPLATES: string;
+    SELECT_BOILERPLATE: string;
 };
 declare const getAppMsg: {
     CHOOSE_APP: string;

package/lib/messages/index.js

@@ -49,6 +49,8 @@ const appCreate = {
     CONFIRM_CLONE_BOILERPLATE: "Would you like to fetch the app template from GitHub?",
     REGISTER_THE_APP_ON_DEVELOPER_HUB: "Registering the app with the name {appName} on the Developer Hub...",
     START_APP_COMMAND: "Start the app using the following command: {command}",
+    BOILERPLATE_TEMPLATES: "Provide a boilerplate. <options: App Boilerplate|DAM App Boilerplate|Ecommerce App Boilerplate>",
+    SELECT_BOILERPLATE: "Select one from the following boilerplates:"
 };
 exports.appCreate = appCreate;
 const getAppMsg = {

package/lib/types/app.d.ts

@@ -122,3 +122,11 @@ export interface LaunchProjectRes {
     environmentUid: any;
     developerHubAppUid: any;
 }
+export interface BoilerplateAppType {
+    name: string;
+    description?: string;
+    link: string;
+    tags?: string[];
+    created_at?: string;
+    updated_at?: string;
+}

package/lib/util/common-utils.d.ts

@@ -35,4 +35,6 @@ declare function setupConfig(configPath: string): Record<string, string>;
 declare function disconnectApp(flags: FlagInput, orgUid: string, developerHubBaseUrl: string): Promise<any>;
 declare function formatUrl(url: string): string;
 declare const handleProjectNameConflict: (projectName: string, projects: any[], retry?: number) => Promise<string>;
-export { getOrganizations, getOrgAppUiLocation, fetchApps, fetchApp, fetchAppInstallations, deleteApp, installApp, getStacks, fetchStack, uninstallApp, fetchInstalledApps, reinstallApp, sanitizePath, updateApp, getProjects, getManifestDetails, setupConfig, disconnectApp, formatUrl, handleProjectNameConflict, };
+declare function fetchBoilerplateDetails(): Promise<Record<string, any>[]>;
+declare function validateBoilerplate(boilerplateName: string): Promise<Record<string, any>>;
+export { getOrganizations, getOrgAppUiLocation, fetchApps, fetchApp, fetchAppInstallations, deleteApp, installApp, getStacks, fetchStack, uninstallApp, fetchInstalledApps, reinstallApp, sanitizePath, updateApp, getProjects, getManifestDetails, setupConfig, disconnectApp, formatUrl, handleProjectNameConflict, fetchBoilerplateDetails, validateBoilerplate, };

package/lib/util/common-utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleProjectNameConflict = exports.formatUrl = exports.disconnectApp = exports.setupConfig = exports.getManifestDetails = exports.getProjects = exports.updateApp = exports.sanitizePath = exports.reinstallApp = exports.fetchInstalledApps = exports.uninstallApp = exports.fetchStack = exports.getStacks = exports.installApp = exports.deleteApp = exports.fetchAppInstallations = exports.fetchApp = exports.fetchApps = exports.getOrgAppUiLocation = exports.getOrganizations = void 0;
+exports.validateBoilerplate = exports.fetchBoilerplateDetails = exports.handleProjectNameConflict = exports.formatUrl = exports.disconnectApp = exports.setupConfig = exports.getManifestDetails = exports.getProjects = exports.updateApp = exports.sanitizePath = exports.reinstallApp = exports.fetchInstalledApps = exports.uninstallApp = exports.fetchStack = exports.getStacks = exports.installApp = exports.deleteApp = exports.fetchAppInstallations = exports.fetchApp = exports.fetchApps = exports.getOrgAppUiLocation = exports.getOrganizations = void 0;
 const tslib_1 = require("tslib");
 const map_1 = tslib_1.__importDefault(require("lodash/map"));
 const cli_utilities_1 = require("@contentstack/cli-utilities");
@@ -9,6 +9,8 @@ const api_request_handler_1 = require("./api-request-handler");
 const types_1 = require("../types");
 const inquirer_1 = require("./inquirer");
 const messages_1 = require("../messages");
+const config_1 = tslib_1.__importDefault(require("../config"));
+const find_1 = tslib_1.__importDefault(require("lodash/find"));
 async function getOrganizations(options, skip = 0, organizations = []) {
     const { log, managementSdk } = options;
     const response = await managementSdk
@@ -296,3 +298,23 @@ const handleProjectNameConflict = async (projectName, projects, retry = 1) => {
     return projectName;
 };
 exports.handleProjectNameConflict = handleProjectNameConflict;
+async function fetchBoilerplateDetails() {
+    var _a, _b;
+    try {
+        const content = await new cli_utilities_1.HttpClient().get(config_1.default.boilerplatesUrl);
+        return (_b = (_a = content === null || content === void 0 ? void 0 : content.data) === null || _a === void 0 ? void 0 : _a.templates) !== null && _b !== void 0 ? _b : [];
+    }
+    catch (error) {
+        throw error;
+    }
+}
+exports.fetchBoilerplateDetails = fetchBoilerplateDetails;
+async function validateBoilerplate(boilerplateName) {
+    const boilerplates = await fetchBoilerplateDetails();
+    const boilerplate = (0, find_1.default)(boilerplates, (boilerplate) => boilerplate.name === boilerplateName);
+    if (!boilerplate) {
+        throw new Error("Invalid boilerplate! Please select a boilerplate from the following options: App Boilerplate, DAM App Boilerplate or Ecommerce App Boilerplate");
+    }
+    return boilerplate;
+}
+exports.validateBoilerplate = validateBoilerplate;

package/lib/util/inquirer.d.ts

@@ -39,4 +39,6 @@ declare function selectProject(projects: LaunchProjectRes[]): Promise<LaunchProj
 declare const askProjectType: () => Promise<string>;
 declare function askConfirmation(): Promise<boolean>;
 declare const askProjectName: (projectName: string) => Promise<string>;
-export { getOrg, getAppName, getDirName, getDeveloperHubUrl, getApp, getInstalledApps, getStack, getInstallation, getHostingType, getAppUrl, askProjectType, askConfirmation, selectProject, askProjectName };
+declare const selectedBoilerplate: () => Promise<any>;
+declare const validateAppName: (name: string) => void;
+export { getOrg, getAppName, getDirName, getDeveloperHubUrl, getApp, getInstalledApps, getStack, getInstallation, getHostingType, getAppUrl, askProjectType, askConfirmation, selectProject, askProjectName, selectedBoilerplate, validateAppName, };

package/lib/util/inquirer.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.askProjectName = exports.selectProject = exports.askConfirmation = exports.askProjectType = exports.getAppUrl = exports.getHostingType = exports.getInstallation = exports.getStack = exports.getInstalledApps = exports.getApp = exports.getDeveloperHubUrl = exports.getDirName = exports.getAppName = exports.getOrg = void 0;
+exports.validateAppName = exports.selectedBoilerplate = exports.askProjectName = exports.selectProject = exports.askConfirmation = exports.askProjectType = exports.getAppUrl = exports.getHostingType = exports.getInstallation = exports.getStack = exports.getInstalledApps = exports.getApp = exports.getDeveloperHubUrl = exports.getDirName = exports.getAppName = exports.getOrg = void 0;
 const tslib_1 = require("tslib");
 const find_1 = tslib_1.__importDefault(require("lodash/find"));
 const isEmpty_1 = tslib_1.__importDefault(require("lodash/isEmpty"));
@@ -297,3 +297,23 @@ function inquireRequireValidation(input) {
     }
     return true;
 }
+const selectedBoilerplate = async () => {
+    const boilerplates = await (0, common_utils_1.fetchBoilerplateDetails)();
+    return await cli_utilities_1.cliux
+        .inquire({
+        type: "search-list",
+        name: "App",
+        choices: boilerplates.map((bp) => bp.name),
+        message: messages_1.appCreate.SELECT_BOILERPLATE,
+    })
+        .then((name) => {
+        return (0, find_1.default)(boilerplates, (boilerplate) => boilerplate.name === name);
+    });
+};
+exports.selectedBoilerplate = selectedBoilerplate;
+const validateAppName = (name) => {
+    if (name.length < 3 || name.length > 20) {
+        throw new Error((0, messages_1.$t)(messages_1.errors.INVALID_NAME, { min: "3", max: "20" }));
+    }
+};
+exports.validateAppName = validateAppName;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/apps-cli",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "App ClI",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/contentstack-apps-cli",