@apso/cli 0.0.4 → 0.0.43

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Salesforce
+
+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,95 +1,355 @@
-apso
-========
+# Apso CLI
 
+- [Apso CLI](#apso-cli)
+- [Prerequisites](#prerequisites)
+- [Usage](#usage)
+- [Local Development](#local-development)
+- [Debugging](##debugging)
+- [Commands](#commands)
 
+# Prerequisites
 
-[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
-[![Version](https://img.shields.io/npm/v/apso.svg)](https://npmjs.org/package/apso)
-[![Downloads/week](https://img.shields.io/npm/dw/apso.svg)](https://npmjs.org/package/apso)
-[![License](https://img.shields.io/npm/l/apso.svg)](https://github.com/mavric/apso/blob/master/package.json)
+You need to have setup access to Mavric's private NPM packages.
+Find out how [here](https://github.com/mavric/.github-private/blob/main/how-to/private-npm.md)
 
-<!-- toc -->
-* [Usage](#usage)
-* [Commands](#commands)
-<!-- tocstop -->
 # Usage
-<!-- usage -->
+
 ```sh-session
-$ npm install -g @apso/cli
+$ npm install -g @mavric/apso-cli
 $ apso COMMAND
 running command...
-$ apso (-v|--version|version)
-@apso/cli/0.0.4 darwin-x64 node-v12.18.0
+$ apso (--version)
+@mavric/apso-cli/0.0.26 linux-x64 node-v18.20.2
 $ apso --help [COMMAND]
 USAGE
   $ apso COMMAND
 ...
 ```
-<!-- usagestop -->
+
+# Local Development
+
+Clone apso-cli on your machine. Navigate to the repo in your code editor and run the below commands
+
+```sh-session
+npm install
+npm run build && npm link
+```
+
+This will build the apso cli and make it available for use globally on your machine. Now make a new directory where you want to setup a new backend service. Run the below command in order to create a new service boilerplate. This will clone the apso-service-template from github.
+
+Incase you face permission denied issue make sure that you have SSH key added in github and your local machine. Follow this [link](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) for SSH keys generation.
+
+```sh-session
+apso server new -n <project-name>
+```
+
+Then navigate to the newly created service and update the apsorc file according to your project entities and relations.
+
+Sample of apsorc files for both v1 and v2 are given in apso-cli code at "test/apsorc-json" so you can check it out in order to make sure that your apsorc file follows the right pattern.
+
+You can also provide the key "apiType" in the apsorc file e.g (Rest, Graphql) incase you want to generate the GraphQL backend by default it would be REST.
+
+Install the npm modules before continuing further.
+
+Now we will run the scaffold command which will generate the all the relevant modules for us.
+
+```sh-session
+apso server scaffold
+```
+
+## Debugging
+
+For debugging we would use the debug package so you need to import the package in file where you want to debug any code.
+
+```sh-session
+var debug = require("debug")("{name of your choice}");
+```
+
+Then just add the debug statements wherever you want.
+
+```sh-session
+debug(`variable1 value is:`, variable1);
+```
+
+Now inorder to see the debug output you need to run the cli in debug mode like this.
+
+```sh-session
+env DEBUG=\* ./bin/run server scaffold
+```
+
+So we are setting the env variable DEBUG and then giving the path of the bin/run file and then next will be your cli commmand.
+
+Note: Whenever you make a change you need to rebuild the cli before running it in order to reflect the changes.
+
+```sh-session
+npm run build
+```
+
 # Commands
-<!-- commands -->
-* [`apso help [COMMAND]`](#apso-help-command)
-* [`apso new [WEB] [SERVER] [SERVERLESS] [NAME]`](#apso-new-web-server-serverless-name)
-* [`apso scaffold [WEB] [SERVER] [ENTITY]`](#apso-scaffold-web-server-entity)
 
-## `apso help [COMMAND]`
+- [`apso help [COMMANDS]`](#apso-help-commands)
+- [`apso plugins`](#apso-plugins)
+- [`apso plugins:install PLUGIN...`](#apso-pluginsinstall-plugin)
+- [`apso plugins:inspect PLUGIN...`](#apso-pluginsinspect-plugin)
+- [`apso plugins:install PLUGIN...`](#apso-pluginsinstall-plugin-1)
+- [`apso plugins:link PLUGIN`](#apso-pluginslink-plugin)
+- [`apso plugins:uninstall PLUGIN...`](#apso-pluginsuninstall-plugin)
+- [`apso plugins:uninstall PLUGIN...`](#apso-pluginsuninstall-plugin-1)
+- [`apso plugins:uninstall PLUGIN...`](#apso-pluginsuninstall-plugin-2)
+- [`apso plugins update`](#apso-plugins-update)
+
+## `apso help [COMMANDS]`
 
-display help for apso
+Display help for apso.
 
 ```
 USAGE
-  $ apso help [COMMAND]
+  $ apso help [COMMANDS] [-n]
 
 ARGUMENTS
-  COMMAND  command to show help for
+  COMMANDS  Command to show help for.
 
-OPTIONS
-  --all  see all commands in CLI
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for apso.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.0.1/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
 
-## `apso new [WEB] [SERVER] [SERVERLESS] [NAME]`
+## `apso plugins`
 
-Initialize your server or client project
+List installed plugins.
 
 ```
 USAGE
-  $ apso new [WEB] [SERVER] [SERVERLESS] [NAME]
+  $ apso plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
 
-OPTIONS
-  -S, --serverless  initialize serverless application
-  -f, --force
-  -h, --help        show CLI help
-  -n, --name=name   name of application
-  -s, --server      initialize server application
-  -w, --web         initialize web application
+GLOBAL FLAGS
+  --json  Format output as json.
 
-EXAMPLE
-  $ apso new --web
-  hello world from ./src/hello.ts!
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ apso plugins
 ```
 
-_See code: [src/commands/new.ts](https://github.com/mavric/apso/blob/v0.0.4/src/commands/new.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.1.2/src/commands/plugins/index.ts)_
 
-## `apso scaffold [WEB] [SERVER] [ENTITY]`
+## `apso plugins:install PLUGIN...`
 
-Create new models for Server or Client
+Installs a plugin into the CLI.
 
 ```
 USAGE
-  $ apso scaffold [WEB] [SERVER] [ENTITY]
+  $ apso plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ apso plugins add
+
+EXAMPLES
+  $ apso plugins:install myplugin
 
-OPTIONS
-  -h, --help           show CLI help
-  -m, --entity=entity  model name
-  -s, --server         initialize server application
-  -w, --web            initialize web application
+  $ apso plugins:install https://github.com/someuser/someplugin
 
-EXAMPLE
-  $ apso scaffold
-  hello world from ./src/hello.ts!
+  $ apso plugins:install someuser/someplugin
 ```
 
-_See code: [src/commands/scaffold.ts](https://github.com/mavric/apso/blob/v0.0.4/src/commands/scaffold.ts)_
-<!-- commandsstop -->
+## `apso plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ apso plugins:inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ apso plugins:inspect myplugin
+```
+
+## `apso plugins:install PLUGIN...`
+
+Installs a plugin into the CLI.
+
+```
+USAGE
+  $ apso plugins:install PLUGIN...
+
+ARGUMENTS
+  PLUGIN  Plugin to install.
+
+FLAGS
+  -f, --force    Run yarn install with force flag.
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Installs a plugin into the CLI.
+  Can be installed from npm or a git url.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
+  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
+  the CLI without the need to patch and update the whole CLI.
+
+
+ALIASES
+  $ apso plugins add
+
+EXAMPLES
+  $ apso plugins:install myplugin
+
+  $ apso plugins:install https://github.com/someuser/someplugin
+
+  $ apso plugins:install someuser/someplugin
+```
+
+## `apso plugins:link PLUGIN`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ apso plugins:link PLUGIN
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ apso plugins:link myplugin
+```
+
+## `apso plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ apso plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ apso plugins unlink
+  $ apso plugins remove
+```
+
+## `apso plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ apso plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ apso plugins unlink
+  $ apso plugins remove
+```
+
+## `apso plugins:uninstall PLUGIN...`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ apso plugins:uninstall PLUGIN...
+
+ARGUMENTS
+  PLUGIN  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ apso plugins unlink
+  $ apso plugins remove
+```
+
+## `apso plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ apso plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```

package/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+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

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

package/dist/commands/server/new.d.ts

@@ -0,0 +1,22 @@
+import BaseCommand from "../../lib/base-command";
+export default class New extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    private CURR_DIR;
+    static flags: {
+        name: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        type: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    static args: {
+        name: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+    };
+    installModules(path: string): Promise<void>;
+    formatApp(root: string): Promise<void>;
+    startApp(root: string): Promise<void>;
+    cloneTemplate(projectPath: string): Promise<void>;
+    run(): Promise<void>;
+    validateFlags(): Promise<{
+        projectName: string;
+        apiType: string;
+    }>;
+}

package/dist/commands/server/new.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const child_process_1 = require("child_process");
+const fs = tslib_1.__importStar(require("fs"));
+const shelljs_1 = tslib_1.__importDefault(require("shelljs"));
+const base_command_1 = tslib_1.__importDefault(require("../../lib/base-command"));
+const path = tslib_1.__importStar(require("path"));
+class New extends base_command_1.default {
+    constructor() {
+        super(...arguments);
+        this.CURR_DIR = process.cwd();
+    }
+    async installModules(path) {
+        this.log("installing modules");
+        await this.runNpmCommand(["install", "--force", "--prefix", path]);
+    }
+    async formatApp(root) {
+        this.log("cleaning up");
+        shelljs_1.default.cd(root);
+        await this.runNpmCommand(["run", "format", "--prefix", root]);
+    }
+    async startApp(root) {
+        return new Promise((resolve, reject) => {
+            const command = "npm";
+            const args = ["start"];
+            // Explicitly set cwd() to work around issues like
+            // https://github.com/facebook/create-react-app/issues/3326.
+            // Unfortunately we can only do this for Yarn because npm support for
+            // equivalent --prefix flag doesn't help with this issue.
+            // This is why for npm, we run checkThatNpmCanReadCwd() early instead.
+            // args.push('--cwd')
+            // args.push(root)
+            // args.push('--verbose')
+            const child = (0, child_process_1.spawn)(command, args, { stdio: "inherit", cwd: root });
+            child.on("close", (code) => {
+                if (code !== 0) {
+                    reject({
+                        command: `${command} ${args.join(" ")}`,
+                    });
+                    return;
+                }
+                resolve();
+            });
+        });
+    }
+    async cloneTemplate(projectPath) {
+        this.log("Creating project in current folder.");
+        if (!fs.existsSync(projectPath) && this.CURR_DIR !== projectPath) {
+            fs.mkdirSync(projectPath);
+        }
+        shelljs_1.default.cd(projectPath);
+        if (process.env.APSO_GIT_PAT) {
+            shelljs_1.default.exec(`git clone --depth=1 --branch=main https://${process.env.APSO_GIT_PAT}:@github.com/mavric/apso-service-template.git ${projectPath}`);
+        }
+        else {
+            shelljs_1.default.exec(`git clone --depth=1 --branch=main git@github.com:mavric/apso-service-template.git ${projectPath}`);
+        }
+        shelljs_1.default.exec(`rm -rf ${projectPath}/.git`);
+        shelljs_1.default.cd(this.CURR_DIR);
+    }
+    async run() {
+        this.log("Initializing New Apso Server...");
+        const { projectName,
+        // apiType,
+         } = await this.validateFlags();
+        const CURR_DIR = process.cwd();
+        const projectPath = path.join(CURR_DIR, projectName);
+        await this.cloneTemplate(projectPath);
+        await this.installModules(projectPath);
+        await this.formatApp(projectPath);
+    }
+    async validateFlags() {
+        var _a;
+        const { flags } = await this.parse(New);
+        let projectName = flags.name;
+        let apiType = (_a = flags.type) === null || _a === void 0 ? void 0 : _a.toLowerCase();
+        if (typeof projectName === "undefined") {
+            // this.error("`name` must be set (e.g. WoofyApp)");
+            projectName = '';
+        }
+        if (typeof apiType === "undefined") {
+            apiType = "rest";
+        }
+        if (apiType !== "rest" && apiType !== "graphql") {
+            this.error("`apiType` must be set (e.g. rest or graphql)");
+        }
+        return { projectName, apiType };
+    }
+}
+New.description = "Initialize your server project";
+New.examples = [`$ apso server new --name TestProject`];
+New.flags = {
+    name: core_1.Flags.string({
+        char: "n",
+        description: "name of application",
+    }),
+    type: core_1.Flags.string({
+        char: "t",
+        description: "api type (rest or graphql)",
+    }),
+};
+New.args = { name: core_1.Args.string() };
+exports.default = New;

package/dist/commands/server/scaffold.d.ts

@@ -0,0 +1,14 @@
+import { Entity, RelationshipMap } from "../../lib";
+import BaseCommand from "../../lib/base-command";
+export default class Scaffold extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    };
+    static args: {};
+    scaffoldServer(dir: string, entity: Entity, relationshipMap: RelationshipMap, apiType: string): Promise<void>;
+    setupRestFiles(dir: string, entity: Entity, relationshipMap: RelationshipMap): Promise<void>;
+    setupGraphqlFiles(dir: string, entity: Entity, relationshipMap: RelationshipMap): Promise<void>;
+    run(): Promise<void>;
+}

package/dist/commands/server/scaffold.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const path = tslib_1.__importStar(require("path"));
+const lib_1 = require("../../lib");
+const base_command_1 = tslib_1.__importDefault(require("../../lib/base-command"));
+const apsorc_parser_1 = require("../../lib/apsorc-parser");
+class Scaffold extends base_command_1.default {
+    async scaffoldServer(dir, entity, relationshipMap, apiType) {
+        this.log(`Building... ${entity.name}`);
+        const entityName = entity.name;
+        const filePath = path.join(dir, entityName);
+        const entityRelationships = relationshipMap[entity.name] || [];
+        await (0, lib_1.createEntity)(filePath, entity, entityRelationships, apiType);
+        switch (apiType) {
+            case apsorc_parser_1.ApiType.Graphql:
+                await this.setupGraphqlFiles(dir, entity, relationshipMap);
+                break;
+            case apsorc_parser_1.ApiType.Rest:
+                await this.setupRestFiles(dir, entity, relationshipMap);
+                break;
+            default:
+                break;
+        }
+        await (0, lib_1.createModule)(filePath, entityName, apiType);
+    }
+    async setupRestFiles(dir, entity, relationshipMap) {
+        const filePath = path.join(dir, entity.name);
+        const entityRelationships = relationshipMap[entity.name] || [];
+        await (0, lib_1.createDto)(filePath, entity, entityRelationships);
+        await (0, lib_1.createService)(filePath, entity.name);
+        await (0, lib_1.createController)(filePath, entity, relationshipMap);
+    }
+    async setupGraphqlFiles(dir, entity, relationshipMap) {
+        const filePath = path.join(dir, entity.name);
+        const entityRelationships = relationshipMap[entity.name] || [];
+        await (0, lib_1.createGqlDTO)(filePath, entity, entityRelationships);
+    }
+    async run() {
+        const { rootFolder, entities, relationshipMap, apiType } = (0, lib_1.parseApsorc)();
+        const rootPath = path.join(process.cwd(), rootFolder);
+        const autogenPath = path.join(rootPath, "autogen");
+        const lowerCaseApiType = apiType.toLowerCase();
+        await (0, lib_1.createEnums)(autogenPath, entities, lowerCaseApiType);
+        entities.forEach((entity) => {
+            const scaffoldModel = this.scaffoldServer.bind(this);
+            scaffoldModel(autogenPath, entity, relationshipMap, lowerCaseApiType);
+        });
+        await (0, lib_1.createIndexAppModule)(autogenPath, entities, lowerCaseApiType);
+        await this.runNpmCommand(["run", "format"]);
+    }
+}
+Scaffold.description = "Setup new entities and interfaces for an Apso Server";
+Scaffold.examples = [`$ apso server scaffold`];
+Scaffold.flags = {
+    help: core_1.Flags.help({ char: "h" }),
+};
+Scaffold.args = {};
+exports.default = Scaffold;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from "@oclif/core";

package/{lib → dist}/index.js

@@ -1,4 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var command_1 = require("@oclif/command");
-Object.defineProperty(exports, "run", { enumerable: true, get: function () { return command_1.run; } });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });