@contentstack/apps-cli 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Contentstack
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,200 @@
+<!-- Insert Nodejs CI here -->
+<!-- Insert Apps CLI version here -->
+
+# @contentstack/apps-cli
+Contentstack lets you develop apps in your organization using the Developer Hub portal. With the Apps CLI plugin, Contentstack CLI allows you to perform the CRUD operations on your app in Developer Hub and then use the app in your organization or stack by installing or uninstalling your app as required.
+
+## How to install this plugin
+
+```shell
+$ csdx plugins:install @contentstack/apps-cli
+```
+
+## How to use this plugin
+
+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.0.0 darwin-arm64 node-v20.3.1
+$ csdx --help [COMMAND]
+USAGE
+  $ csdx COMMAND
+...
+```
+<!-- usagestop -->
+
+# Commands
+<!-- commands -->
+* [`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`
+
+Create a new app in Developer Hub and optionally clone a boilerplate locally.
+
+```
+USAGE
+  $ csdx app:create [--org <value>] [-n <value>] [--app-type stack|organization] [-c <value>] [-d <value>]
+
+FLAGS
+  -c, --config=<value>    Path of the external config
+  -d, --data-dir=<value>  Current working directory.
+  -n, --name=<value>      Name of the app to be created
+  --app-type=<option>     [default: stack] Type of App
+                          <options: stack|organization>
+  --org=<value>           Provide the organization UID
+
+DESCRIPTION
+  Create a new app in Developer Hub and optionally clone a boilerplate locally.
+
+EXAMPLES
+  $ csdx app:create
+
+  $ csdx app:create --name App-1 --app-type stack
+
+  $ 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
+```
+
+_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.0.0/src/commands/app/create.ts)_
+
+## `csdx app:delete`
+
+Delete app from marketplace
+
+```
+USAGE
+  $ csdx app:delete [--org <value>] [--app-uid <value>]
+
+FLAGS
+  --app-uid=<value>  Provide the app UID
+  --org=<value>      Provide the organization UID
+
+DESCRIPTION
+  Delete app from marketplace
+
+EXAMPLES
+  $ csdx app:delete
+
+  $ csdx app:delete --app-uid <value>
+
+  $ 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.0.0/src/commands/app/delete.ts)_
+
+## `csdx app:get`
+
+Get details of an app in developer hub
+
+```
+USAGE
+  $ csdx app:get [--org <value>] [--app-uid <value>] [--app-type stack|organization] [-d <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
+  --org=<value>           Provide the organization UID
+
+DESCRIPTION
+  Get details of an app in developer hub
+
+EXAMPLES
+  $ csdx app:get
+
+  $ csdx app:get --org <value> --app-uid <value>
+
+  $ csdx app:get --org <value> --app-uid <value> --app-type stack
+
+  $ 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.0.0/src/commands/app/get.ts)_
+
+## `csdx app:install`
+
+Install an app from the marketplace
+
+```
+USAGE
+  $ csdx app:install [--org <value>] [--app-uid <value>] [--stack-api-key <value>]
+
+FLAGS
+  --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/v1.0.0/src/commands/app/install.ts)_
+
+## `csdx app:uninstall`
+
+Uninstall an app
+
+```
+USAGE
+  $ csdx app:uninstall [--org <value>] [--app-uid <value>] [--installation-uid <value>]
+
+FLAGS
+  --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/v1.0.0/src/commands/app/uninstall.ts)_
+
+## `csdx app:update`
+
+Update the existing app in developer hub
+
+```
+USAGE
+  $ csdx app:update [--org <value>] [--app-manifest <value>]
+
+FLAGS
+  --app-manifest=<value>  Path to the app manifest.json file:
+  --org=<value>           Provide the organization UID
+
+DESCRIPTION
+  Update the existing app in developer hub
+
+EXAMPLES
+  $ csdx app:update
+
+  $ csdx app:update --app-manifest ./boilerplate/manifest.json
+```
+
+_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.0.0/src/commands/app/update.ts)_
+<!-- commandsstop -->

package/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+require("dotenv").config();
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require("ts-node").register({ project });
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/lib/commands/app/base-command.d.ts

@@ -0,0 +1,51 @@
+import { Command } from "@contentstack/cli-command";
+import { FlagInput, Interfaces, ContentstackClient, InquirePayload } from "@contentstack/cli-utilities";
+import { ConfigType, LogFn } from "../../types";
+import { Logger } from "../../util";
+import messages from "../../messages";
+export type Flags<T extends typeof Command> = Interfaces.InferredFlags<(typeof BaseCommand)["baseFlags"] & T["flags"]>;
+export type Args<T extends typeof Command> = Interfaces.InferredArgs<T["args"]>;
+export declare abstract class BaseCommand<T extends typeof Command> extends Command {
+    log: LogFn;
+    logger: Logger;
+    readonly $t: (msg: string, args: Record<string, string>) => string;
+    developerHubBaseUrl: string;
+    protected sharedConfig: ConfigType;
+    readonly messages: typeof messages;
+    protected managementSdk: ContentstackClient;
+    protected managementAppSdk: ContentstackClient;
+    protected flags: Flags<T>;
+    protected args: Args<T>;
+    static hidden: boolean;
+    static baseFlags: FlagInput;
+    init(): Promise<void>;
+    protected catch(err: Error & {
+        exitCode?: number;
+    }): Promise<any>;
+    protected finally(_: Error | undefined): Promise<any>;
+    /**
+     * @method registerConfig
+     *
+     * @memberof BaseCommand
+     */
+    registerConfig(): void;
+    /**
+     * @method initCmaSDK
+     *
+     * @memberof BaseCommand
+     */
+    initCmaSDK(): Promise<void>;
+    /**
+     * @method getValPrompt
+     *
+     * @param {(Partial<InquirePayload> & Record<string, any>)} [options={
+     *       validate: (val) => {
+     *         if (!val) return this.messages.NOT_EMPTY;
+     *         return true;
+     *       },
+     *     }]
+     * @return {*}  {(Promise<string | boolean>)}
+     * @memberof BaseCommand
+     */
+    getValPrompt(options?: Partial<InquirePayload> & Record<string, any>): Promise<string | boolean>;
+}

package/lib/commands/app/base-command.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseCommand = void 0;
+const tslib_1 = require("tslib");
+const omit_1 = tslib_1.__importDefault(require("lodash/omit"));
+const merge_1 = tslib_1.__importDefault(require("lodash/merge"));
+const fs_1 = require("fs");
+const cli_command_1 = require("@contentstack/cli-command");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const config_1 = tslib_1.__importDefault(require("../../config"));
+const util_1 = require("../../util");
+const messages_1 = tslib_1.__importStar(require("../../messages"));
+class BaseCommand extends cli_command_1.Command {
+    constructor() {
+        super(...arguments);
+        this.$t = messages_1.$t;
+        this.sharedConfig = Object.assign(Object.assign({}, config_1.default), { projectBasePath: process.cwd() });
+        this.messages = Object.assign({}, messages_1.default);
+    }
+    async init() {
+        await super.init();
+        const { args, flags } = await this.parse({
+            flags: this.ctor.flags,
+            baseFlags: super.ctor.baseFlags,
+            args: this.ctor.args,
+            strict: this.ctor.strict,
+        });
+        this.flags = flags;
+        this.args = args;
+        cli_utilities_1.cliux.registerSearchPlugin();
+        this.registerConfig();
+        this.developerHubBaseUrl =
+            this.sharedConfig.developerHubBaseUrl || (await (0, util_1.getDeveloperHubUrl)());
+        await this.initCmaSDK();
+        // Init logger
+        const logger = new util_1.Logger(this.sharedConfig);
+        this.log = logger.log.bind(logger);
+    }
+    async catch(err) {
+        // add any custom logic to handle errors from the command
+        // or simply return the parent class error handling
+        return super.catch(err);
+    }
+    async finally(_) {
+        // called after run and catch regardless of whether or not the command errored
+        return super.finally(_);
+    }
+    /**
+     * @method registerConfig
+     *
+     * @memberof BaseCommand
+     */
+    registerConfig() {
+        if (this.flags.config && (0, fs_1.existsSync)(this.flags.config)) {
+            try {
+                const config = JSON.parse((0, fs_1.readFileSync)(this.flags.config, { encoding: "utf-8" }));
+                const omitKeys = [
+                    "manifestPath",
+                    "boilerplateName",
+                    "developerHubUrls",
+                ];
+                this.sharedConfig = (0, merge_1.default)(this.sharedConfig, (0, omit_1.default)(config, omitKeys));
+            }
+            catch (error) { }
+        }
+    }
+    /**
+     * @method initCmaSDK
+     *
+     * @memberof BaseCommand
+     */
+    async initCmaSDK() {
+        cli_utilities_1.managementSDKInitiator.init(this.context);
+        this.managementSdk = await (0, cli_utilities_1.managementSDKClient)({
+            host: this.cmaHost,
+        });
+        this.managementAppSdk = await (0, cli_utilities_1.managementSDKClient)({
+            host: this.developerHubBaseUrl,
+        });
+    }
+    /**
+     * @method getValPrompt
+     *
+     * @param {(Partial<InquirePayload> & Record<string, any>)} [options={
+     *       validate: (val) => {
+     *         if (!val) return this.messages.NOT_EMPTY;
+     *         return true;
+     *       },
+     *     }]
+     * @return {*}  {(Promise<string | boolean>)}
+     * @memberof BaseCommand
+     */
+    getValPrompt(options = {
+        message: "Enter value",
+        validate: (val) => {
+            if (!val)
+                return this.$t(this.messages.NOT_EMPTY, { value: "Value" });
+            return true;
+        },
+    }) {
+        const { name = "getVal", message, validate } = options;
+        return cli_utilities_1.cliux.inquire({
+            validate,
+            name,
+            type: "input",
+            default: options === null || options === void 0 ? void 0 : options.default,
+            message: message,
+        });
+    }
+}
+exports.BaseCommand = BaseCommand;
+BaseCommand.hidden = true;
+// NOTE define flags that can be inherited by any command that extends BaseCommand
+BaseCommand.baseFlags = {
+    org: cli_utilities_1.Flags.string({
+        description: messages_1.commonMsg.PROVIDE_ORG_UID,
+    }),
+    yes: cli_utilities_1.Flags.boolean({
+        char: "y",
+        hidden: true,
+        description: messages_1.commonMsg.SKIP_CONFIRMATION,
+    }),
+};

package/lib/commands/app/create.d.ts

@@ -0,0 +1,68 @@
+import { BaseCommand } from "./base-command";
+export default class Create extends BaseCommand<typeof Create> {
+    private appData;
+    static hidden: boolean;
+    static description: string;
+    static examples: string[];
+    static flags: {
+        name: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "app-type": import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        config: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        "data-dir": import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    run(): Promise<void>;
+    /**
+     * @method boilerplateFlow
+     *
+     * @memberof Create
+     */
+    boilerplateFlow(): Promise<void>;
+    /**
+     * @method promptQueue
+     *
+     * @memberof Create
+     */
+    flagsPromptQueue(): Promise<void>;
+    /**
+     * @method cloneBoilerplate
+     *
+     * @return {*}  {Promise<string>}
+     * @memberof Create
+     */
+    cloneBoilerplate(): Promise<string>;
+    /**
+     * @method unZipBoilerplate
+     *
+     * @param {string} filepath
+     * @memberof Create
+     */
+    unZipBoilerplate(filepath: string): Promise<void>;
+    /**
+     * @method registerTheAppOnDeveloperHub
+     *
+     * @param {boolean} [saveManifest=true]
+     * @memberof Create
+     */
+    registerTheAppOnDeveloperHub(saveManifest?: boolean, retry?: number): Promise<void>;
+    /**
+     * @method rollbackBoilerplate
+     *
+     * @memberof Create
+     */
+    rollbackBoilerplate(): void;
+    /**
+     * @method manageNameConflict
+     *
+     * @param {boolean} saveManifest
+     * @param {number} retry
+     * @return {*}  {Promise<void>}
+     * @memberof Create
+     */
+    manageNameConflict(saveManifest: boolean, retry: number): Promise<void>;
+    /**
+     * @method installDependencies
+     *
+     * @memberof Create
+     */
+    installDependencies(): Promise<void>;
+}