Merge pull request #124 from panacloud/dev

Merge Dev in to Main

Author: Muh-Hasan

README.md

@@ -3,13 +3,13 @@
 [![Downloads/week](https://img.shields.io/npm/dw/@panacloud/cli.svg)](https://www.npmjs.org/package/@panacloud/cli)
 [![License](https://img.shields.io/npm/l/@panacloud/cli.svg)](https://github.com/panacloud/cli/blob/master/package.json)
 
-# Panacloud Command Line Interface
+# Panacloud Command Line Interface (CLI)
 
-Panacloud is an unified API development, fundraising, and ownership economy platform. It provides services, libraries, tools, and frameworks for developing totally open multi-tenant, serverless cloud services with integrated multi-tenant billing, crowdfunding, and ownership economy constructs.  This allows developers to concentrate solely on creating specialised code related to their domain, leaving the rest to the Panacloud platform and services. This model has the potential to disrupt both the software and venture investment industries.
+In a recent [report](https://venturebeat.com/2021/12/09/report-75-of-devs-indicate-that-participating-in-api-economy-is-top-priority/) 75% of developers indicate that participating in API economy is ‘top priority’. Panacloud is an unified API development, fundraising, and ownership economy platform.  It provides services, libraries, tools, and frameworks for developing totally open multi-tenant, serverless cloud services with integrated multi-tenant billing, crowdfunding, and ownership economy constructs.  This allows developers to concentrate solely on creating specialised code related to their domain, leaving the rest to the Panacloud platform and services. This model has the potential to disrupt both the software and venture investment industries and making the API developers rich and owners of their own destiny and unicorn startups.
 
-Panacloud CLI accelerates the building of multi-tenant serverless SaaS APIs. The CLI applies the design-first paradigm and implements the best practices for designing GraphQL APIs using public cloud serverless and infrastructure as code technologies. The CLI takes a [GraphQL API](https://graphql.org/) [schema](https://graphql.org/learn/schema/) that has been augmented with Panacloud directives and creates [infrastructure as code (IaC)](https://acloudguru.com/blog/engineering/cloudformation-terraform-or-cdk-guide-to-iac-on-aws), mock lambdas, tests, and scaffolding for genuine lambdas that include business logic and database requests. It makes use of [AWS CDK](https://aws.amazon.com/cdk/) for IaC. It now only supports AWS, TypeScript and GraphQL, but future versions will also support Azure and Google Cloud, OpenAPI and other languages as well.
+Panacloud CLI accelerates the building of modern multi-tenant serverless SaaS APIs. The CLI applies the design-first paradigm and implements the best practices for designing GraphQL APIs using public cloud serverless and infrastructure as code technologies. The CLI takes a [GraphQL API](https://graphql.org/) [schema](https://graphql.org/learn/schema/) that has been augmented with Panacloud directives and creates [infrastructure as code (IaC)](https://acloudguru.com/blog/engineering/cloudformation-terraform-or-cdk-guide-to-iac-on-aws), mock lambdas, tests, and scaffolding for genuine lambdas that include business logic and database requests. It makes use of [AWS CDK](https://aws.amazon.com/cdk/) for IaC. It now only supports AWS, TypeScript and GraphQL, but future versions will also support Azure and Google Cloud, OpenAPI and other languages as well.
 
-![CLI Flow](cli.png "CLI Diagram")
+![CLI Flow](img/cli.png "CLI Diagram")
 
 
 The generated serverless SaaS API project supports multi-tenant usage based billing and monetering and is closely integrated with the [Panacloud portal](https://www.panacloud.org). The developer just needs to write the specific code required by the Multi-Tenant SaaS project. This greatly reduces custom developer coding and increases speed to market. GraphQL and Open REST APIs can be built by using the Panacloud CLI. The APIs may use Graph or Relational databases, etc.
@@ -60,12 +60,14 @@ USAGE
 ```
 <!-- usagestop -->
 
-# Commands
+# Panacloud Commands
 
 <!-- commands -->
 * [`panacloud help [COMMAND]`](#panacloud-help-command)
 * [`panacloud init`](#panacloud-init)
 * [`panacloud update`](#panacloud-update)
+* [`panacloud status`](#panacloud-status)
+* [`panacloud client`](#panacloud-client)
 * [`panacloud merge`](#panacloud-merge)
 
 ## `panacloud help [COMMAND]`
@@ -100,6 +102,7 @@ OPTIONS
 _See code: [src/commands/init.ts](https://github.com/panacloud/cli/commands/init.ts)_
 <!-- commandsstop -->
 
+
 ## `panacloud update`
 
 Update CDK code and mock lambdas based on the updated schema. This command doesnot overwrite code in the editiable_src directory.
@@ -115,6 +118,26 @@ OPTIONS
 _See code: [src/commands/update.ts](https://github.com/panacloud/cli/src/commands/update.ts)_
 <!-- commandsstop -->
 
+
+
+
+## `panacloud client`
+
+Open a API explorer in the browser to query the API.
+
+```
+USAGE
+  $ panacloud client
+
+OPTIONS
+  -h, --help  show CLI help
+```
+
+_See code: [src/commands/client.ts](https://github.com/panacloud/cli/src/commands/client.ts)_
+<!-- commandsstop -->
+
+
+
 ## `panacloud merge`
 
 Merges GraphQL schema files.
@@ -130,6 +153,19 @@ OPTIONS
 _See code: [src/commands/update.ts](https://github.com/panacloud/cli/src/commands/merge.ts)_
 <!-- commandsstop -->
 
+# Project NPM Commands
+
+Once the project is generated you may run the following npm scripts
+
+<!-- npm commands -->
+* `npm run deploy-dev` Deploy Development Stage
+* `npm run deploy-prd` Deploy Production Stage
+* `npm run destroy-dev` Destroy Development Stage
+* `npm run destroy-prd` Destroy Production Stage
+* `npm run test-dev` Run Tests for the Development Stage
+* `npm run test-prd` Run Tests for the Production Stage
+
+
 ## Details about the Project Generated by the CLI
 
 The CLI generates project for Multi-Tenant Serverless API development with [AWS Cloud Development Kit (CDK)](https://docs.aws.amazon.com/cdk/latest/guide/home.html) using TypeScript. It comes with all the necessary code to develop and deploy a Serverless GraphQL API in the AWS Cloud.  This includes the provisioning of cloud infrastructure in code and Serverless stubs where developers may easily include their business logic. The project also provides pre-built mock lambda functions and unit tests to test your deployed APIs. 
@@ -168,5 +204,26 @@ The `cdk.json` file tells the CDK Toolkit how to execute your app.
  8. Allow the stakeholders to cash out whenever they require liquidity by selling API tokens.
 
 
+ ## The Panacloud CLI Roadmap
+
+### First Public Release
+
+Expected Date: December 14, 2021
+
+Functionality: Auto-Generation of GraphQL API for AWS, Single Tenant, Mock API, Serverless Stubs, Database Support: Relational & Graph, API Testing, Staging, init, update, config, deploy, destroy, and client commands
+ 
+### Second Release
+
+Expected Date: January 1, 2022
+
+Functionality: Multi-Tenant monetering and billing data live streamed to Amazon Timestream Database deployed in Panacloud AWS Account. 
+
+### Third Release
+
+Expected Date: January 15, 2022
+
+Functionality: Basic OpenAPI speficication support. 
+
+
 
 

cli-3.drawio img/cli-3.drawio

@@ -1,6 +1,6 @@
 {
   "name": "@panacloud/cli",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "panacloud cli",
   "author": "Muhammad Hasan @muh_hasan",
   "bin": {
@@ -16,6 +16,7 @@
     "@oclif/config": "^1",
     "@oclif/plugin-help": "^3",
     "@types/inquirer": "^7.3.3",
+    "@types/valid-url": "^1.0.3",
     "await-exec": "^0.1.2",
     "axios": "^0.21.4",
     "chalk": "^4.1.1",
@@ -30,6 +31,7 @@
     "graphql": "^15.6.0",
     "graphql-schema-utilities": "^1.1.3",
     "graphql-to-json-converter": "^1.2.0",
+    "hidefile": "^3.0.0",
     "inquirer": "^8.1.2",
     "isomorphic-git": "^1.10.0",
     "lodash": "^4.17.21",
@@ -41,15 +43,18 @@
     "prettier": "^2.3.2",
     "random-name": "^0.1.2",
     "semver": "^7.3.5",
+    "supertest": "^6.1.6",
     "tslib": "^1",
     "typescript": "^3.9.10",
+    "valid-url": "^1.0.9",
     "yamljs": "^0.3.0"
   },
   "devDependencies": {
     "@oclif/dev-cli": "^1",
     "@oclif/test": "^1",
-    "@types/chai": "^4",
+    "@types/chai": "^4.2.22",
     "@types/fs-extra": "^9.0.13",
+    "@types/hidefile": "^3.0.0",
     "@types/mocha": "^5",
     "@types/node": "^16.11.6",
     "@types/random-name": "^0.1.0",
@@ -62,7 +67,7 @@
     "nyc": "^14",
     "rimraf": "^3.0.2",
     "ts-node": "^8",
-    "typescript": "^3.3"
+    "typescript": "^3.9.10"
   },
   "engines": {
     "node": ">=8.0.0"
@@ -110,10 +115,9 @@
   },
   "scripts": {
     "postpack": "rimraf oclif.manifest.json",
-    "posttest": "eslint . --ext .ts --config .eslintrc",
     "copy-files": "copyfiles -a -u 1 \"./src/lib/api/template/**/*\" \"./src/utils/*.graphql\" lib",
     "prepack": "rimraf lib && tsc -b && oclif-dev manifest && yarn copy-files",
-    "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "test": "ts-node test/test-scripts/script.ts",
     "version": "oclif-dev readme && git add README.md"
   },
   "types": "lib/index.d.ts",

cli.png img/cli.png

@@ -0,0 +1,99 @@
+import { Command, flags } from "@oclif/command";
+import chalk = require("chalk");
+import {
+  existsSync,
+  readFileSync,
+  writeJsonSync,
+} from "fs-extra";
+import { startSpinner} from "../lib/spinner";
+import * as validUrl from "valid-url";
+import { API, APITYPE } from "../utils/constants";
+import open = require("open");
+import inquirer = require("inquirer");
+const express = require("express");
+
+
+export default class Open extends Command {
+  static description = "describe the command here";
+
+  static flags = {
+    help: flags.help({ char: "h" }),
+  };
+
+  static args = [{ name: "file" }];
+  async run() {
+    const {stages} = JSON.parse(
+      readFileSync("./editable_src/panacloudconfig.json").toString()
+    )
+    const userInput =  await inquirer.prompt([
+      {
+        type: "list",
+        name: "stage",
+        message: "Select Stage",
+        choices: [...stages],
+        default: stages[0],
+        validate: Boolean,
+      },
+    ])
+    const { apiType, apiName }: API = JSON.parse(
+      readFileSync("./codegenconfig.json").toString()
+    ).api;
+    if (apiType === APITYPE.graphql) {
+      let API_URL;
+      let API_KEY;
+      if (!existsSync(`./cdk-${userInput.stage}-outputs.json`)) {
+        this.log(
+          chalk.red(
+            `${apiName}'s ${userInput.stage} stage is currently not deployed client cannot connect to API, give the command npm run deploy-${userInput.stage} to deploy it.`
+          )
+        );
+      } else {
+        let data = JSON.parse(readFileSync(`./cdk-${userInput.stage}-outputs.json`).toString());
+        const values: string[] = Object.values(
+          Object.entries(data)[0][1] as any
+        );
+        if (values.length === 0) {
+          this.log(
+            chalk.red(
+              `${apiName}'s ${userInput.stage} stage is currently not deployed client cannot connect to API, give the npm run deploy-${userInput.stage} to deploy it.`
+            )
+          );
+          return;
+        } else {
+          let urlPresent = false
+          values.forEach((val: string) => {
+            if (validUrl.isUri(val)) {
+              urlPresent = true
+              API_URL = val;
+            } else {
+              API_KEY = val;
+            }
+          });
+          if(urlPresent === false){
+            this.log(chalk.red("Correct url is not provided!!"))
+          }
+          if (API_URL && API_KEY) {
+            writeJsonSync(`./graphqlClient/data.json`, {
+              API_URL,
+              API_KEY,
+            });
+            this.runGraphqlClient();
+          }
+        }
+      }
+    }
+  }
+
+  async runGraphqlClient() {
+    const graphqlSpinner = startSpinner("Starting Grphql Client");
+    let app = express();
+    app.use(express.static(process.cwd() + "/graphqlClient/"));
+    let port = 8080;
+    app.listen(port);
+    open(`http://localhost:${port}`)
+    graphqlSpinner.stopAndPersist({
+      text: `Graphql client is running on http://localhost:${port} 🚀`,
+    });
+
+  }
+}