@contentstack/cli-command 0.1.1-beta.6 → 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

@@ -1,6 +1,70 @@
-@contentstack/cli-command
-===================
+@contentstack/cli-auth
+===
+
+It is Contentstack’s CLI plugin to perform authentication-related activities. To get started with authenticating yourself with the CLI, refer to the [CLI’s Authentication documentation](https://www.contentstack.com/docs/developers/cli/authentication)
 
 [![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)
 
-Base class for Contentstack CLI commands. Built off of [oclif](https://oclif.io). To get started with Contentstack CLI, refer to the [CLI documentation](https://www.contentstack.com/docs/developers/cli/).
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @contentstack/cli-command-test
+$ csdx COMMAND
+running command...
+$ csdx (-v|--version|version)
+@contentstack/cli-command-test/0.1.1-beta.1 linux-x64 node-v12.22.1
+$ csdx --help [COMMAND]
+USAGE
+  $ csdx COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`csdx config:get:region`](#csdx-configgetregion)
+* [`csdx config:set:region`](#csdx-configsetregion)
+
+## `csdx config:get:region`
+
+Set region 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/v0.1.1-beta.1/src/commands/config/get/region.ts)_
+
+## `csdx config:set:region`
+
+Set region for CLI
+
+```
+USAGE
+  $ csdx config:set: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 EU
+  $ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --name "India"
+  $ csdx config:set:region --cma="https://in-api.contentstack.com" --cda="https://in-cda.contentstack.com" 
+  --name="India"
+```
+
+_See code: [src/commands/config/set/region.ts](https://github.com/contentstack/cli/blob/v0.1.1-beta.1/src/commands/config/set/region.ts)_
+<!-- commandsstop -->

package/lib/index.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.flags = exports.Command = void 0;
+const command_1 = require("@oclif/command");
+Object.defineProperty(exports, "flags", { enumerable: true, get: function () { return command_1.flags; } });
+const ContentstackManagementSDK = require("@contentstack/management");
+const ContentstackDeliverySDK = require("contentstack");
+const url = require("url");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const defaultRateLimit = 5;
+class ContentstackCommand extends command_1.Command {
+    get context() {
+        // @ts-ignore
+        return this.config.context;
+    }
+    get managementAPIClient() {
+        if (this._managementAPIClient)
+            return this._managementAPIClient;
+        this._managementAPIClient = ContentstackManagementSDK.client({ host: this.cmaHost });
+        return this._managementAPIClient;
+    }
+    set managementAPIClient(params) {
+        this._managementAPIClient = ContentstackManagementSDK.client(params);
+    }
+    get email() {
+        if (this._email)
+            return this._email;
+        this._email = cli_utilities_1.configHandler.get('email');
+        if (this._email)
+            return this._email;
+        throw new cli_utilities_1.CLIError('You are not logged in. Please login with command $ csdx auth:login');
+    }
+    get deliveryAPIClient() {
+        if (this._deliveryAPIClient)
+            return this._deliveryAPIClient;
+        this._deliveryAPIClient = ContentstackDeliverySDK;
+        return this._deliveryAPIClient;
+    }
+    get region() {
+        if (this._region)
+            return this._region;
+        this._region = cli_utilities_1.configHandler.get('region');
+        if (this._region)
+            return this._region;
+    }
+    get rateLimit() {
+        this._rateLimit = cli_utilities_1.configHandler.get('rate-limit');
+        if (this._rateLimit)
+            return this._rateLimit;
+        return defaultRateLimit;
+    }
+    get cmaHost() {
+        let cma = this.region.cma;
+        if (cma.startsWith('http')) {
+            const u = url.parse(cma);
+            if (u.host)
+                return u.host;
+        }
+        return cma;
+    }
+    get cdaHost() {
+        let cda = this.region.cda;
+        if (cda.startsWith('http')) {
+            const u = url.parse(cda);
+            if (u.host)
+                return u.host;
+        }
+        return cda;
+    }
+    get cdaAPIUrl() {
+        let cda = this.region.cda;
+        return cda.startsWith('http') ? cda : `https://${cda}`;
+    }
+    get cmaAPIUrl() {
+        let cma = this.region.cma;
+        return cma.startsWith('http') ? cma : `https://${cma}`;
+    }
+    get authToken() {
+        if (this._authToken)
+            return this._authToken;
+        this._authToken = cli_utilities_1.configHandler.get('authtoken');
+        if (this._authToken)
+            return this._authToken;
+        throw new cli_utilities_1.CLIError('You are not logged in. Please login with command $ csdx auth:login');
+    }
+    getToken(alias) {
+        if (alias) {
+            const token = cli_utilities_1.configHandler.get(`tokens.${alias}`);
+            if (token)
+                return token;
+        }
+        throw new cli_utilities_1.CLIError('No token found');
+    }
+}
+exports.Command = ContentstackCommand;
+module.exports = {
+    Command: ContentstackCommand,
+    flags: command_1.flags,
+};

package/lib/interfaces/index.js

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

package/package.json

@@ -1,30 +1,66 @@
 {
   "name": "@contentstack/cli-command",
-  "version": "0.1.1-beta.6",
-  "description": "Base class for Contentstack command",
-  "main": "./src/index.js",
+  "description": "Contentstack CLI plugin for configuration",
+  "version": "1.0.0",
   "author": "Contentstack",
+  "main": "lib/index.js",
+  "types": "./types/index.d.ts",
   "scripts": {
-    "test": "nyc mocha --forbid-only \\\"test/**/*.test.js\\\""
+    "prepack": "npm run clean && npm run compile",
+    "clean": "rm -rf ./lib && rm -rf tsconfig.build.tsbuildinfo",
+    "compile": "tsc -b tsconfig.json",
+    "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"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/contentstack/cli.git"
-  },
-  "files": [
-    "/src"
-  ],
-  "license": "MIT",
-  "bugs": "https://github.com/contentstack/cli/issues",
-  "homepage": "https://github.com/contentstack/cli#readme",
   "dependencies": {
+    "@contentstack/cli-utilities": "^1.0.0",
     "@contentstack/management": "^1.3.0",
-    "@oclif/command": "^1.8.0",
-    "@oclif/config": "^1.17.0",
-    "configstore": "^5.0.1",
+    "@oclif/command": "^1.8.16",
     "contentstack": "^3.10.1"
   },
+  "devDependencies": {
+    "@oclif/plugin-help": "^5.1.12",
+    "@oclif/test": "^1.2.8",
+    "@types/chai": "^4.2.18",
+    "@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",
+    "chai": "^4.3.4",
+    "eslint": "^8.18.0",
+    "eslint-config-oclif": "^3.1.0",
+    "eslint-config-oclif-typescript": "^0.1.0",
+    "mocha": "^9.2.2",
+    "nyc": "^15.1.0",
+    "rimraf": "^2.7.1",
+    "sinon": "^11.1.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",
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm run lint"
+    }
+  },
+  "repository": "contentstack/cli"
+}

package/src/custom-errors.js

@@ -1,23 +0,0 @@
-class TokenNotFound extends Error {
-	constructor(value) {
-		super()
-		this.value = value
-	  this.message = 'Token not found'
-	  this.toString = function () {
-	    return this.value + this.message
-	  }	
-	}
-}
-
-class NotLoggedIn extends Error {
-	constructor() {
-		super()
-		this.message = 'You are not logged in. Please login with command $ csdx auth:login'
-	  this.toString = function () {
-	    return this.message
-	  }	
-	}
-}
-
-module.exports.TokenNotFound = TokenNotFound
-module.exports.NotLoggedIn = NotLoggedIn

package/src/index.js

@@ -1,101 +0,0 @@
-const {Command, flags} = require('@oclif/command')
-const ContentstackManagementSDK = require('@contentstack/management')
-const ContentstackDeliverySDK = require('contentstack')
-const {TokenNotFound, NotLoggedIn} = require('./custom-errors')
-const Configstore = require('configstore')
-const config = new Configstore('contentstack_cli')
-const url = require('url')
-const defaultRegion = {cma: 'https://api.contentstack.io', cda: 'https://cdn.contentstack.io', name: 'NA'}
-const defaultRateLimit = 5
-
-
-class ContentstackCommand extends Command {
-
-  get managementAPIClient() {
-    if (this._managementAPIClient) return this._managementAPIClient
-    this._managementAPIClient = ContentstackManagementSDK.client({host:this.cmaHost})
-    return this._managementAPIClient
-  }
-
-  set managementAPIClient(params) {
-    if(params && params.host) {
-      //can not set host explicitly as CLI runs under constant host coming from config
-      params.host = this.cmaHost
-    }
-    this._managementAPIClient = ContentstackManagementSDK.client(params)
-  }
-  
-  get email() {
-    if (this._email) return this._email
-    this._email = config.get('email')
-    if(this._email) return this._email
-    throw new NotLoggedIn()
-  }
-
-  get deliveryAPIClient() {
-    if (this._deliveryAPIClient) return this._deliveryAPIClient
-    this._deliveryAPIClient = ContentstackDeliverySDK
-    return this._deliveryAPIClient
-  }
-
-  get region() {
-    if (this._region) return this._region
-    this._region = config.get('region')
-    if (this._region) return this._region
-    // return defaultRegion
-  }
-
-  get rateLimit() {
-    this._rateLimit = config.get('rate-limit')
-    if (this._rateLimit) return this._rateLimit
-    return defaultRateLimit
-  }
-
-  get cmaHost() {
-    let cma = this.region.cma
-    if (cma.startsWith('http')) {
-      const u = url.parse(cma)
-      if (u.host) return u.host
-    }
-    return cma
-  }
-
-  get cdaHost() {
-    let cda = this.region.cda
-    if (cda.startsWith('http')) {
-      const u = url.parse(cda)
-      if (u.host) return u.host
-    }
-    return cda
-  }
-
-  get cdaAPIUrl() {
-    let cda = this.region.cda
-    return cda.startsWith('http') ? cda : `https://${cda}`
-  }
-
-  get cmaAPIUrl() {
-    let cma = this.region.cma
-    return cma.startsWith('http') ? cma : `https://${cma}`
-  }
-
-  get authToken() {
-    if (this._authToken) return this._authToken
-    this._authToken = config.get('authtoken')
-    if (this._authToken)  return this._authToken
-    throw new NotLoggedIn()
-  }
-
-  getToken(alias) {
-    if (alias) {
-      const token = config.get(`tokens.${alias}`)
-      if (token)  return token
-    }
-    throw new TokenNotFound(alias)
-  }
-}
-
-module.exports = {
-  Command: ContentstackCommand,
-  flags
-}