@contentstack/cli-config 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 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,70 @@
+@contentstack/cli-config
+===
+
+The config namespace contains all the commands that you will need to configure the CLI as per your requirements. Contentstack currently supports three regions: North America, Europe and Azure North America. [Configure the CLI documentation](https://www.contentstack.com/docs/developers/cli/configure-the-cli)
+
+[![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @contentstack/cli-config
+$ csdx COMMAND
+running command...
+$ csdx (-v|--version|version)
+@contentstack/cli-config/1.0.0 linux-x64 node-v16.14.2
+$ csdx --help [COMMAND]
+USAGE
+  $ csdx COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`csdx config:get:region`](#csdx-configgetregion)
+* [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
+
+## `csdx config:get:region`
+
+Get current region set for CLI
+
+```
+USAGE
+  $ csdx config:get:region
+
+EXAMPLE
+  $ csdx config:get:region
+```
+
+_See code: [src/commands/config/get/region.ts](https://github.com/contentstack/cli/blob/v1.0.0/src/commands/config/get/region.ts)_
+
+## `csdx config:set:region [REGION]`
+
+Set region for CLI
+
+```
+USAGE
+  $ csdx config:set:region [REGION]
+
+OPTIONS
+  -d, --cda=cda    Custom host to set for content delivery API, if this flag is added then cma and name flags are
+                   required
+
+  -m, --cma=cma    Custom host to set for content management API, , if this flag is added then cda and name flags are
+                   required
+
+  -n, --name=name  Name for the region, if this flag is added then cda and cma flags are required
+
+EXAMPLES
+  $ csdx config:set:region
+  $ csdx config:set:region NA
+  $ csdx config:set:region NA
+  $ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --name "India"
+```
+
+_See code: [src/commands/config/set/region.ts](https://github.com/contentstack/cli/blob/v1.0.0/src/commands/config/set/region.ts)_
+<!-- commandsstop -->

package/bin/run

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+
+require('@oclif/command').run()
+.catch(require('@oclif/errors/handle'))

package/lib/commands/config/get/region.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_command_1 = require("@contentstack/cli-command");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+class RegionGetCommand extends cli_command_1.Command {
+    async run() {
+        let currentRegion = this.region;
+        if (!currentRegion) {
+            cli_utilities_1.logger.error('No region set');
+            cli_utilities_1.cliux.error('CLI_CONFIG_GET_REGION_NOT_FOUND');
+            this.exit();
+        }
+        cli_utilities_1.cliux.print(`Currently using ${currentRegion.name} region`);
+        cli_utilities_1.cliux.print(`CDA HOST: ${currentRegion.cda}`);
+        cli_utilities_1.cliux.print(`CMA HOST: ${currentRegion.cma}`);
+    }
+}
+exports.default = RegionGetCommand;
+RegionGetCommand.description = 'Get current region set for CLI';
+RegionGetCommand.examples = ['$ csdx config:get:region'];

package/lib/commands/config/set/region.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_command_1 = require("@contentstack/cli-command");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const utils_1 = require("../../../utils");
+class RegionSetCommand extends cli_command_1.Command {
+    async run() {
+        const { args, flags } = this.parse(RegionSetCommand);
+        let cda = flags.cda;
+        let cma = flags.cma;
+        let name = flags.name;
+        let selectedRegion = args.region;
+        if (!(cda && cma && name) && !selectedRegion) {
+            selectedRegion = await utils_1.interactive.askRegions();
+        }
+        if (selectedRegion === 'custom') {
+            const selectedCustomRegion = await utils_1.interactive.askCustomRegion();
+            name = selectedCustomRegion.name;
+            cda = selectedCustomRegion.cda;
+            cma = selectedCustomRegion.cma;
+        }
+        else if (selectedRegion === 'exit') {
+            this.exit();
+        }
+        // Custom flag will get first priority over region argument
+        if (cda && cma && name) {
+            try {
+                let customRegion = { cda, cma, name };
+                customRegion = utils_1.regionHandler.setCustomRegion(customRegion);
+                cli_utilities_1.cliux.success(`Custom region has been set to ${customRegion.name}`);
+                cli_utilities_1.cliux.success(`CMA HOST: ${customRegion.cma}`);
+                cli_utilities_1.cliux.success(`CDA HOST: ${customRegion.cda}`);
+            }
+            catch (error) {
+                cli_utilities_1.logger.error('failed to set the region', error);
+                cli_utilities_1.cliux.error(`Failed to set region due to: ${error.message}`);
+            }
+        }
+        else if (['NA', 'EU', 'AZURE-NA'].includes(selectedRegion)) {
+            const regionDetails = utils_1.regionHandler.setRegion(selectedRegion);
+            cli_utilities_1.cliux.success(`Region has been set to ${regionDetails.name}`);
+            cli_utilities_1.cliux.success(`CDA HOST: ${regionDetails.cda}`);
+            cli_utilities_1.cliux.success(`CMA HOST: ${regionDetails.cma}`);
+        }
+        else {
+            cli_utilities_1.cliux.error(`Invalid region is given`);
+        }
+    }
+}
+exports.default = RegionSetCommand;
+RegionSetCommand.description = 'Set region for CLI';
+RegionSetCommand.flags = {
+    cda: cli_command_1.flags.string({
+        char: 'd',
+        description: 'Custom host to set for content delivery API, if this flag is added then cma and name flags are required',
+        dependsOn: ['cma', 'name'],
+        parse: (0, cli_utilities_1.printFlagDeprecation)(['-d'], ['--cda']),
+    }),
+    cma: cli_command_1.flags.string({
+        char: 'm',
+        description: 'Custom host to set for content management API, , if this flag is added then cda and name flags are required',
+        dependsOn: ['cda', 'name'],
+        parse: (0, cli_utilities_1.printFlagDeprecation)(['-m'], ['--cma']),
+    }),
+    name: cli_command_1.flags.string({
+        char: 'n',
+        description: 'Name for the region, if this flag is added then cda and cma flags are required',
+        dependsOn: ['cda', 'cma'],
+    }),
+};
+RegionSetCommand.examples = [
+    '$ csdx config:set:region',
+    '$ csdx config:set:region NA',
+    '$ csdx config:set:region NA',
+    '$ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --name "India"',
+];
+RegionSetCommand.args = [
+    {
+        name: 'region',
+    },
+];

package/lib/config/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    logger: {
+        level: 'error',
+        silent: false,
+    },
+};

package/lib/interfaces/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utils/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.interactive = exports.regionHandler = void 0;
+var region_handler_1 = require("./region-handler");
+Object.defineProperty(exports, "regionHandler", { enumerable: true, get: function () { return region_handler_1.default; } });
+exports.interactive = require("./interactive");

package/lib/utils/interactive.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.askCustomRegion = exports.askRegions = void 0;
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const askRegions = async () => {
+    return cli_utilities_1.cliux.inquire({
+        type: 'list',
+        name: 'selectedRegion',
+        message: 'CLI_CONFIG_SELECT_REGION',
+        choices: [
+            { name: 'NA', value: 'NA' },
+            { name: 'EU', value: 'EU' },
+            { name: 'AZURE-NA', value: 'AZURE-NA' },
+            { name: 'Custom', value: 'custom' },
+            { name: 'exit', value: 'exit' },
+        ],
+    });
+};
+exports.askRegions = askRegions;
+const askCustomRegion = async () => {
+    const name = await cli_utilities_1.cliux.inquire({
+        type: 'input',
+        name: 'name',
+        message: 'CLI_CONFIG_INQUIRE_REGION_NAME',
+    });
+    const cma = await cli_utilities_1.cliux.inquire({
+        type: 'input',
+        name: 'cma',
+        message: 'CLI_CONFIG_INQUIRE_REGION_CMA',
+    });
+    const cda = await cli_utilities_1.cliux.inquire({
+        type: 'input',
+        name: 'cda',
+        message: 'CLI_CONFIG_INQUIRE_REGION_CDA',
+    });
+    return { name, cma, cda };
+};
+exports.askCustomRegion = askCustomRegion;

package/lib/utils/region-handler.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+function validURL(str) {
+    const pattern = new RegExp('^(https?:\\/\\/)?' + // protocol
+        '((([a-z\\d]([a-z\\d-]*[a-z\\d])*)\\.)+[a-z]{2,}|' + // domain name
+        '((\\d{1,3}\\.){3}\\d{1,3}))' + // OR ip (v4) address
+        '(\\:\\d+)?(\\/[-a-z\\d%_.~+]*)*' + // port and path
+        '(\\?[;&a-z\\d%_.~+=-]*)?' + // query string
+        '(\\#[-a-z\\d_]*)?$', 'i'); // fragment locator
+    return Boolean(pattern.test(str));
+}
+// Available region list
+const regions = {
+    NA: { cma: 'https://api.contentstack.io', cda: 'https://cdn.contentstack.io', name: 'NA' },
+    EU: { cma: 'https://eu-api.contentstack.com', cda: 'https://eu-cdn.contentstack.com', name: 'EU' },
+    'AZURE-NA': {
+        cma: 'https://azure-na-api.contentstack.com',
+        cda: 'https://azure-na-cdn.contentstack.com',
+        name: 'AZURE-NA',
+    },
+};
+class UserConfig {
+    /**
+     *
+     * Set region to config store
+     * @param {string} region It Can be NA, EU
+     * @returns {object} region object with cma, cda, region property
+     */
+    setRegion(region) {
+        let selectedRegion = regions[region];
+        if (selectedRegion) {
+            cli_utilities_1.configHandler.set('region', selectedRegion);
+            return selectedRegion;
+        }
+    }
+    /**
+     *
+     * Get current host set for CLI
+     * @returns { object } Object contains url for cma and cda, and region to which it is pointing to
+     */
+    getRegion() {
+        const regionDetails = cli_utilities_1.configHandler.get('region');
+        if (regionDetails)
+            return regionDetails;
+        // returns NA region if not found in config
+        return regions.NA;
+    }
+    /**
+     *
+     * Set region to config store
+     * @param {object} regionObject should contain cma, cda, region property
+     * @returns {object} region object with cma, cda, region(name of region) property
+     */
+    setCustomRegion(regionObject) {
+        if (this.validateRegion(regionObject)) {
+            regionObject = this.sanitizeRegionObject(regionObject);
+            cli_utilities_1.configHandler.set('region', regionObject);
+            return regionObject;
+        }
+        throw new TypeError('Custom region should include valid cma(URL), cda(URL), name(String) (Name for the Region) property.');
+    }
+    /**
+     *
+     * Set rateLimit to config store
+     * @param {object} rateLimitObject should contain rate limit property
+     * @returns {object} ratelimit object with limit property
+     */
+    // setCustomRateLimit(rateLimitObject) {
+    //   if(rateLimitObject !== undefined && isNaN(rateLimitObject)) {
+    //     throw new TypeError(rateLimitObject + " is not a number, Please provide number as a rate limit")
+    //  } else {
+    //   config.set('rate-limit', rateLimitObject)
+    //   return rateLimitObject
+    //  }
+    // }
+    /**
+     * Validate given region JSON object
+     * @param {*} regionObject JSON object needs to be validated
+     * @returns {boolean} True if contains cma, cda and region property otherwise false
+     */
+    validateRegion(regionObject) {
+        if (regionObject.cma && regionObject.cda && regionObject.name) {
+            if (validURL(regionObject.cma) && validURL(regionObject.cda))
+                return true;
+        }
+        return false;
+    }
+    /**
+     * Sanitize given region JSON object by removing any other properties than cma, cda and region
+     * @param { object } regionObject JSON object needs to be sanitized
+     * @returns { object } JSON object with only valid keys for region
+     */
+    sanitizeRegionObject(regionObject) {
+        let sanitizedRegion;
+        sanitizedRegion = {
+            cma: regionObject.cma,
+            cda: regionObject.cda,
+            name: regionObject.name,
+        };
+        return sanitizedRegion;
+    }
+}
+exports.default = new UserConfig();

package/oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"1.0.0","commands":{"config:get:region":{"id":"config:get:region","description":"Get current region set for CLI","pluginName":"@contentstack/cli-config","pluginType":"core","aliases":[],"examples":["$ csdx config:get:region"],"flags":{},"args":[]},"config:set:region":{"id":"config:set:region","description":"Set region for CLI","pluginName":"@contentstack/cli-config","pluginType":"core","aliases":[],"examples":["$ csdx config:set:region","$ csdx config:set:region NA","$ csdx config:set:region NA","$ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --name \"India\""],"flags":{"cda":{"name":"cda","type":"option","char":"d","description":"Custom host to set for content delivery API, if this flag is added then cma and name flags are required"},"cma":{"name":"cma","type":"option","char":"m","description":"Custom host to set for content management API, , if this flag is added then cda and name flags are required"},"name":{"name":"name","type":"option","char":"n","description":"Name for the region, if this flag is added then cda and cma flags are required"}},"args":[{"name":"region"}]}}}

package/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "@contentstack/cli-config",
+  "description": "Contentstack CLI plugin for configuration",
+  "version": "1.0.0",
+  "author": "Contentstack",
+  "bin": {
+    "csdx": "./bin/run"
+  },
+  "scripts": {
+    "build": "npm run clean && npm run compile",
+    "clean": "rm -rf ./lib && rm -rf tsconfig.build.tsbuildinfo",
+    "compile": "tsc -b tsconfig.json",
+    "postpack": "rm -f oclif.manifest.json",
+    "prepack": "npm run build && oclif-dev manifest && oclif-dev readme",
+    "version": "oclif-dev readme && git add README.md",
+    "test:report": "tsc -p test && nyc --reporter=lcov --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "pretest": "tsc -p test",
+    "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "posttest": "npm run lint",
+    "lint": "eslint src/**/*.ts",
+    "format": "eslint src/**/*.ts --fix"
+  },
+  "dependencies": {
+    "@contentstack/cli-command": "^1.0.0",
+    "@contentstack/cli-utilities": "^1.0.0",
+    "@oclif/command": "^1.8.16",
+    "@oclif/config": "^1.18.3",
+    "chalk": "^4.0.0",
+    "debug": "^4.1.1",
+    "inquirer": "^7.1.0",
+    "winston": "^3.7.2"
+  },
+  "devDependencies": {
+    "@oclif/dev-cli": "^1.22.2",
+    "@oclif/plugin-help": "^5.1.12",
+    "@oclif/test": "^1.2.8",
+    "@types/chai": "^4.2.18",
+    "@types/inquirer": "^7.3.1",
+    "@types/mkdirp": "^1.0.1",
+    "@types/mocha": "^8.2.2",
+    "@types/node": "^14.14.32",
+    "@types/sinon": "^10.0.2",
+    "@types/tar": "^4.0.3",
+    "@types/winston": "^2.4.4",
+    "chai": "^4.3.4",
+    "eslint": "^8.18.0",
+    "eslint-config-oclif": "^3.1.0",
+    "eslint-config-oclif-typescript": "^0.1.0",
+    "globby": "^10.0.2",
+    "mocha": "^9.2.2",
+    "nyc": "^15.1.0",
+    "rimraf": "^2.7.1",
+    "sinon": "^11.1.1",
+    "tmp": "^0.2.1",
+    "ts-node": "^8.10.2",
+    "typescript": "^4.7.4"
+  },
+  "engines": {
+    "node": ">=8.0.0"
+  },
+  "files": [
+    "/lib",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json"
+  ],
+  "homepage": "https://github.com/contentstack/cli",
+  "keywords": [
+    "contentstack",
+    "cli",
+    "plugin"
+  ],
+  "license": "MIT",
+  "oclif": {
+    "commands": "./lib/commands",
+    "bin": "csdx",
+    "devPlugins": [
+      "@oclif/plugin-help"
+    ],
+    "protected": [
+      "config:get:region"
+    ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm run lint"
+    }
+  },
+  "repository": "contentstack/cli"
+}