@kumologica/sdk 3.0.0-alpha4

package/README.md

@@ -0,0 +1,52 @@
+# kumologica-sdk
+
+Kumologica SDK consist of 4 products:
+- Kumologica designer
+- Kumologica runtime
+- Kumologica CLI
+- Kumologica nodes development kit
+
+## Installation
+
+To install kumologica sdk, run the following command:
+
+```bash
+npm install -g @kumologica/sdk
+```
+Note that node.js is required to run installation and kumologica sdk. To install node.js go to [nodejs.org](https://nodejs.org)
+### Upgrade
+Use the same command to upgrade kumologica sdk to the latest version.
+
+To upgrade kumologica sdk to the specific version or tag, use: 
+
+```bash
+npm install -g @kumologica/sdk@{version number}
+```
+
+## Getting started
+
+Kumologica sdk contains CLI that provides various commands.
+### Create sample project
+
+To create project with sample code and then open project in kumologica designer run following commands:
+```bash
+# create project with name firstproject
+kl create -p firstproject
+
+# open firstproject in kumologica designer 
+
+kl open firstproject
+```
+### Opening kumologica designer
+To open kumologica designer run command:
+
+```bash
+kl open
+```
+You can always create new project withing kumologica designer or choose existing project to open.
+
+## Next Steps
+
+- [Build your first api flow](https://docs.kumologica.com/docs/guide/GettingStarted.html#build-your-first-api-flow)
+- [Build your second api flow](https://docs.kumologica.com/docs/guide/GettingStarted.html#build-your-second-api-flow)
+- [Kumologica documentation](https://docs.kumologica.com/docs/guide/Intro.html)

package/bin/kl.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../cli/cli.js');

package/cli/KumologicaError.js

@@ -0,0 +1,17 @@
+'use strict';
+
+class KumologicaError extends Error {
+  constructor(message, code, options = {}) {
+    super(message);
+    this.code = code;
+    this.decoratedMessage = options.decoratedMessage;
+  }
+}
+
+Object.defineProperty(KumologicaError.prototype, 'name', {
+  value: KumologicaError.name,
+  configurable: true,
+  writable: true,
+});
+
+module.exports = KumologicaError;

package/cli/cli.js

@@ -0,0 +1,7 @@
+require('yargs/yargs')(process.argv.slice(2))
+  .commandDir('commands')
+  .demandCommand()
+  .help('help', 'Show usage information & exit')
+  .alias('help', 'h')
+ // .epilog("copyright 2021")
+  .argv

package/cli/commands/build-commands/aws.js

@@ -0,0 +1,49 @@
+exports.command = 'aws';
+exports.desc = `Builds aws lambda binaries: 
+* generates aws lambda artefacts
+* runs npm install
+* creates zip file
+
+Documentation: 
+  https://docs.kumologica.com/docs/references/cli/BuildAws.html`;
+
+exports.builder = {
+	"flow-file-name": {
+		describe: "The name of kumologica flow file.\n Auto search if not provided.\n ",
+		type: 'string',
+		alias: 'f',
+		nargs: 1
+	},
+	"project-directory": {
+		describe: "The root directory of project.\n Current working directory if not provided.\n",
+		type: 'string',
+		alias: 'd',
+		nargs: 1
+	},
+	"zip-file-name": {
+		describe: "The name of zip file to be created",
+		type: 'string',
+		default: 'lambda.zip',
+		alias: 'z',
+		nargs: 1
+	}
+}
+		
+function display(argv) {
+	console.log(`\nBuilding aws lambda artefacts with following parameters: \n`);
+	console.log('project-directory: %s', argv["project-directory"]||'');
+	console.log('flow-file-name:    %s', argv["flow-file-name"]||'');
+    console.log('zip-file-name:     %s', argv["zip-file-name"]||'');
+}
+
+exports.handler = function (argv) {
+	display(argv);
+
+	try {
+		const { build } = require('@kumologica/builder');
+		build('aws', argv);
+	} catch (e) {
+		console.log(`${e.message}`);
+		process.exit(1);
+	}
+}

package/cli/commands/build-commands/azure.js

@@ -0,0 +1,43 @@
+exports.command = 'azure';
+exports.desc = `Generate azure function artefacts and build zip file`;
+
+exports.builder = {
+	"flow-file-name": {
+		describe: "The name of kumologica flow file.\n Auto search if not provided.",
+		type: 'string',
+		alias: 'f',
+		nargs: 1
+	},
+	"project-directory": {
+		describe: "The root directory of project.\n Process directory if not provided.",
+		type: 'string',
+		alias: 'd',
+		nargs: 1
+	},
+	"zip-file-name": {
+		describe: "The name of zip file name",
+		type: 'string',
+		default: 'azure.zip',
+		alias: 'z',
+		nargs: 1
+	}
+}
+
+function display(argv) {
+	console.log(`\nBuilding azure function artefacts with following parameters: \n`);
+	console.log('project-directory: %s', argv["project-directory"] || '');
+	console.log('flow-file-name:    %s', argv["flow-file-name"] || '');
+	console.log('zip-file-name:     %s', argv["zip-file-name"] || '');
+}
+
+exports.handler = function (argv) {
+	display(argv);
+
+	try {
+		const { build } = require('@kumologica/builder');
+		build('azure', argv);
+	} catch (e) {
+		console.log(`${e.message}`);
+		process.exit(1);
+	}
+}

package/cli/commands/build-commands/kumohub.js

@@ -0,0 +1,49 @@
+exports.command = 'kumohub';
+exports.desc = `Builds kumohub binaries: 
+* generates kumohub artefacts
+* runs npm install
+* creates zip file
+
+Documentation: 
+  https://docs.kumologica.com/docs/references/cli/BuildKumohub.html`;
+
+exports.builder = {
+	"flow-file-name": {
+		describe: "The name of kumologica flow file.\n Auto search if not provided.\n ",
+		type: 'string',
+		alias: 'f',
+		nargs: 1
+	},
+	"project-directory": {
+		describe: "The root directory of project.\n Current working directory if not provided.\n",
+		type: 'string',
+		alias: 'd',
+		nargs: 1
+	},
+	"zip-file-name": {
+		describe: "The name of zip file to be created",
+		type: 'string',
+		default: 'lambda.zip',
+		alias: 'z',
+		nargs: 1
+	}
+}
+		
+function display(argv) {
+	console.log(`\nBuilding kumohub artefacts with following parameters: \n`);
+	console.log('project-directory: %s', argv["project-directory"]||'');
+	console.log('flow-file-name:    %s', argv["flow-file-name"]||'');
+  console.log('zip-file-name:     %s', argv["zip-file-name"]||'');
+}
+
+exports.handler = function (argv) {
+	display(argv);
+
+	try {
+		const { build } = require('@kumologica/builder');
+		build('kumohub', argv);
+	} catch (e) {
+		console.log(`${e.message}`);
+		process.exit(1);
+	}
+}

package/cli/commands/build.js

@@ -0,0 +1,6 @@
+exports.command = 'build <provider>'
+exports.desc = 'Build kumologica flow binaries'
+exports.builder = function (yargs) {
+  return yargs.commandDir('build-commands')
+}
+exports.handler = function (argv) {}

package/cli/commands/create-commands/create-project-iteratively.js

@@ -0,0 +1,49 @@
+const pathlib = require('path');
+const { prompt, Select } = require('enquirer');
+const { logNotice, logError } = require('../../utils/logger');
+const { downloadTemplateFromRepo, listAvailableTemplates } = require('../../utils/download-template-from-repo');
+
+async function createProjectIteratively() {
+    let availableTemplates;
+    try {
+        availableTemplates = await listAvailableTemplates();
+    } catch (err) {
+        logError('Error found while retrieving the list of available templates. Please ensure that your internet connection is active and try again');
+        process.exit(1);
+    }
+    // Project name
+    const projectNameResponse = await prompt({
+        type: 'input',
+        name: 'projectName',
+        message: 'Enter the name for the project'
+    });
+    let aProjectName = projectNameResponse.projectName;
+
+    // Target Path
+    const directoryResponse = await prompt({
+        type: 'input',
+        name: 'directory',
+        message: 'Enter the path where the project will be created '
+    });
+    let aProjectPath = directoryResponse.directory;
+
+    // Template name
+    const promptTemplate = new Select({
+        name: 'template',
+        message: 'Pick one of the available templates',
+        choices: availableTemplates
+    });
+
+    let aTemplateName = await promptTemplate.run();
+
+    try {
+        await downloadTemplateFromRepo(undefined, aTemplateName, aProjectPath, aProjectName);
+        logNotice(`Successfully created project: ${pathlib.join(aProjectPath, aProjectName)}`)
+    } catch (err) {
+        logError(`Error found while creating project due to: ${err.message}`);
+        process.exit(1);
+    }
+}
+
+
+module.exports = createProjectIteratively;

package/cli/commands/create-commands/index.js

@@ -0,0 +1,5 @@
+const createProjectIteratively  = require('./create-project-iteratively');
+
+module.exports = {
+    createProjectIteratively
+}

package/cli/commands/create.js

@@ -0,0 +1,66 @@
+const pathlib = require('path');
+const { codegen } = require('@kumologica/builder');
+
+const { logNotice, logError } = require('../utils/logger');
+const { downloadTemplateFromRepo, isPlainGitURL } = require('../utils/download-template-from-repo');
+const { createProjectIteratively } = require('./create-commands');
+
+exports.command = 'create [options]'
+exports.builder = (yargs) => {
+    yargs.option(`path`, {
+        describe: "The project path where the project will be created",
+        // demandOption: "The path is required.",
+        type: 'string',
+        alias: 'p',
+        nargs: 1
+    })
+    yargs.option(`template`, {
+        describe: `Template for the project`,
+        type: 'string',
+        alias: 't',
+        nargs: 1
+    })
+}
+
+
+exports.desc = 'Create a kumologica project. Do not pass any options to create iteratively.'
+exports.handler = async ({ path, template }) => {
+    const { version } = require('../../../sdk/package.json');
+
+    if (!path && !template) {
+        await createProjectIteratively();
+    } else if (!path && template) {
+        try {
+            await downloadTemplateFromRepo(undefined, template, process.cwd(), template);
+            logNotice(`Successfully created project: ${pathlib.join(process.cwd(), template)}`);
+        } catch (e) {
+            logError(e.message);
+        }
+    } else if (path && !template) {
+        try {
+            codegen.generateBoilerplateProject({
+                basePath: process.cwd(),
+                projectName: path,
+                runtimeVersion: version
+            });
+            logNotice(`Successfully created project: ${pathlib.join(process.cwd(), path)}`);
+        } catch (e) {
+            logError(e.message);
+        }
+    } else if (path && template) {
+        path = pathlib.resolve(path);
+        let projectPath = pathlib.dirname(path);
+        let projectName = pathlib.basename(path);
+        try {
+            if (isPlainGitURL(template)) {
+                await downloadTemplateFromRepo(template, undefined, projectPath, projectName);
+            } else {
+                await downloadTemplateFromRepo(undefined, template, projectPath, projectName);
+            }
+            logNotice(`Successfully created project: ${path}`);
+        } catch (e) {
+            logError(e.message);
+        }
+    }
+
+}

package/cli/commands/deploy-commands/kumohub.js

@@ -0,0 +1,114 @@
+exports.command = 'kumohub';
+exports.desc = `Deploy kumologica flow to kumohub.io account`;
+
+exports.builder = {
+	"flow-file-name": {
+		describe: "The name of kumologica flow file.\n Auto search if not provided.\n",
+		type: 'string',
+		alias: 'f',
+		nargs: 1
+	},
+	"service-name": {
+		describe: "The name of service.\n flow file name without extension if not provided.\n Service name will be sanitized to be compatible with aws lambda name restrictions.\n",
+		type: 'string',
+		nargs: 1
+	},
+	"project-directory": {
+		describe: "The root directory of project.\n Process working directory if not provided.\n",
+		type: 'string',
+		alias: 'd',
+		nargs: 1
+	},
+	"environment": {
+		describe: `Environment variables, JSON Syntax: '{"Variables": {"key": "value", ...}}'\n`,
+		type: 'string',
+		nargs: 1
+	},
+	"account": {
+		describe: "The name of kumohub.io account\n",
+		type: 'string',
+		required: true,
+		alias: 'a',
+		nargs: 1
+	},
+	"username": {
+		describe: "The username to login to kumohub.io account\n",
+		type: 'string',
+		required: true,
+		alias: 'u',
+		nargs: 1
+	},
+	"password": {
+		describe: "The username password to login to kumohub.io account\n",
+		type: 'string',
+		required: true,
+		alias: 'p',
+		nargs: 1
+	},
+	"workspace": {
+		describe: "The name of the workspace where flow to be deployed.\n",
+		type: 'string',
+		required: true,
+		alias: 'w',
+		nargs: 1
+	},
+	"stage": {
+		describe: "The name of the stage where flow to be deployed\n",
+		type: 'string',
+		required: true,
+		alias: 's',
+		nargs: 1
+	},
+	"policy": {
+		describe: "The name of security policy to assign to the flow.\n",
+		type: 'string',
+		required: true,
+		default: "Public",
+		nargs: 1
+	},
+	"memory": {
+		describe: "The amount of memory (MB) to be allocated to the flow. 128 MB to 10240 MB\n",
+		type: 'string',
+		nargs: 1,
+		default: "512"
+    },
+	"timeout": {
+		describe: "The amount of seconds flow should be run before timing out. Up to 900 seconds\n",
+		type: 'string',
+		nargs: 1,
+		default: "30" 
+	},
+	"description": {
+		describe: "The description of function.\n",
+		type: 'string',
+		nargs: 1
+	}
+}
+
+function display(argv) {
+	console.log(`\nDeploying flow to kumohub.io with following parameters: \n`);
+	console.log('project-directory: %s', argv["project-directory"] || '');
+	console.log('flow-file-name:    %s', argv["flow-file-name"] || '');
+	console.log('service-name:      %s', argv["service-name"] || '');
+	console.log('environment vars:  %s', argv["environment"] || '');
+	console.log('username:          %s', argv["username"] || '');
+	console.log('password:          %s', argv["password"]? "provided": "missing");
+	console.log('workspace:         %s', argv["workspace"] || '');
+	console.log('stage:             %s', argv["stage"] || '');
+	console.log('policy:            %s', argv["policy"] || '');
+	console.log('memory:            %s', argv["memory"] || '');
+	console.log('timeout:           %s', argv["timeout"] || '');
+	console.log('description:       %s', argv["description"] || '');
+}
+
+exports.handler = function (argv) {
+	display(argv);
+
+	try {
+		const { deploy } = require('@kumologica/builder');
+		deploy('kumohub', argv);
+	} catch (e) {
+		console.log(`${e.message}`);
+		process.exit(1);
+	}
+}

package/cli/commands/deploy.js

@@ -0,0 +1,6 @@
+exports.command = 'deploy <provider>'
+exports.desc = 'Deploy kumologica flow binaries'
+exports.builder = function (yargs) {
+  return yargs.commandDir('deploy-commands')
+}
+exports.handler = function (argv) {}

package/cli/commands/doc-commands/html.js

@@ -0,0 +1,60 @@
+exports.command = 'html';
+exports.desc = `Generates html documentation of kumologica flow.`;
+
+exports.builder = {			
+	"project-directory": {
+        describe: "\nThe root directory of kumologica project. Current working directory used if not provided.",
+        type: 'string',
+		alias: 'd',
+		nargs: 1
+	},
+	"flow-file-name": {
+        describe: "\nThe name of kumologica flow file to be created, must end with .json extension. Auto search if not provided.",
+        type: 'string',
+		alias: 'f',
+		nargs: 1
+	},
+	"documentation-directory": {
+        describe: "\nThe directory where documentation will be created.",
+        type: 'string',
+		alias: 'c',
+		default: 'docs',
+		nargs: 1
+	}
+}
+		
+function validate(argv) {
+	const chalk = require('chalk');
+
+	if (argv["flow-file-name"] && !argv["flow-file-name"].endsWith('.json')) {
+		console.log(`${chalk.redBright("Validation Error: flow-file-name must end with .json extension.")}`);
+		process.exit(1);
+	}
+}
+function display(argv) {
+	console.log('Parameters:');
+	console.log('  documentation-directory:  %s', argv["documentation-directory"]||'');
+	console.log('  project-directory:        %s', argv["project-directory"]||'');
+	console.log('  flow-file-name:           %s', argv["flow-file-name"]||'');
+}
+
+exports.handler = async function (argv) {
+	console.log('\nGenerating html documentation\n');
+	display(argv);
+	validate(argv);
+
+	const chalk = require('chalk');
+
+	try {
+		const { doc } = require('@kumologica/builder');
+		const docsDirectory = doc("html", argv);
+		console.log(chalk.greenBright('Documentation generated successfully:'));
+		console.log(chalk.greenBright(docsDirectory));
+	
+		process.exit(0);
+	} catch (e) {
+
+		console.log(`${chalk.redBright(e.message)}`);
+		process.exit(1);
+	}
+}

package/cli/commands/doc.js

@@ -0,0 +1,6 @@
+exports.command = 'doc <format>'
+exports.desc = 'Generate documentation for kumologica flow'
+exports.builder = function (yargs) {
+  return yargs.commandDir('doc-commands')
+}
+exports.handler = function (argv) {}