@kumologica/sdk 3.2.2 → 3.3.0-beta2

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

@@ -0,0 +1,73 @@
+const path = require('path');
+const _ = require('lodash');
+const { prompt, Select } = require('enquirer');
+const { logNotice, logError } = require('../../utils/logger');
+
+const { codegen } = require('@kumologica/devkit')
+
+/**
+ * ensureNodeNamingConvention - will generate a tuple with first part being the node nade (capitalized), and second with the
+ * fully qualified name (kumologica-contrib-<name>)
+ * @param {} nodeName 
+ * @returns {[string, string]} - A tuple with two strings: simpleNodeName and fqNodeName.
+ */
+function ensureNodeNamingConvention(nodeName){
+    if (!nodeName){
+        return ["Default", "kumologica-contrib-default"];
+    }
+    if (nodeName.includes('kumologica-contrib-')){
+        const [, simpleName] = nodeName.split('kumologica-contrib-');
+        return [_.capitalize(simpleName), nodeName]; // return [NodeName, kumologica-contrib-nodeName]
+    }
+    return [_.capitalize(nodeName), `kumologica-contrib-${nodeName}`];
+
+}
+
+async function createNodeIteratively(){
+    // Name name
+    const nodeNameResponse = await prompt({
+        type: 'input',
+        name: 'name',
+        message: 'Enter the name for the node. (It will be prefixed with "kumologica-contrib-<name>")'
+    });
+
+    const [simpleNodeName, fqNodeName] = ensureNodeNamingConvention(nodeNameResponse.name);
+
+    // Node Category 
+    const answerCategory = await prompt({
+        type: 'input',
+        name: 'category',
+        message: 'Enter the name for the category of the node. (Default: "misc")'
+    });
+
+    const nodeCategory = answerCategory.category || 'misc';
+
+    // Base Path
+    const answerDirectory = await prompt({
+        type: 'input',
+        name: 'directory',
+        message: 'Enter the path where the project will be created. (Default: current directory)'
+    });
+    let basePath = answerDirectory.directory || process.cwd();
+
+    // Final Project Path
+    let projectDir = path.join(basePath, fqNodeName);
+
+    try{
+        codegen.generateBoilerplateCodeContribNode({ 
+            projectDir, 
+            simpleNodeName,
+            fqNodeName,
+            nodeCategory
+        });
+
+        logNotice(`Contrib node project created in: "${projectDir}"`)
+    } catch (err){
+        throw err;
+    }
+}
+    
+
+module.exports = {
+    createNodeIteratively
+}

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

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

package/cli/commands/create-node.js

@@ -0,0 +1,14 @@
+const { logError } = require('../utils/logger');
+const { createNodeIteratively } = require('./create-node-commands');
+
+exports.command = 'create-node'
+exports.desc = 'Create the boilerplate code for a new contrib node.'
+
+exports.handler = async () => {
+    try{
+        await createNodeIteratively();
+    }catch(err){
+        logError(`Error found while creating kumologica node project due to: ${err.message}`)
+        throw err;
+    }
+}

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

@@ -1,3 +1,7 @@
+// kl doc html --serve
+const express = require('express');
+const chalk = require('chalk');
+
 exports.command = 'html';
 exports.desc = `Generates html documentation of kumologica flow.`;
 
@@ -20,7 +24,13 @@ exports.builder = {
 		alias: 'c',
 		default: 'docs',
 		nargs: 1
-	}
+	},
+	"serve": {
+        describe: "\nServe the resulting documentation via an HTTP server (port: 3000).",
+        type: 'boolean',
+        alias: 's',
+        default: false
+    }
 }
 		
 function validate(argv) {
@@ -34,27 +44,38 @@ function validate(argv) {
 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"]||'');
+	console.log('        project-directory:  %s', argv["project-directory"]||`${__dirname}`);
+	console.log('           flow-file-name:  %s', argv["flow-file-name"]||'(auto-search)');
+	console.log('                    serve:  %s', argv["serve"]||'false');
 }
 
 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);
+		console.log(chalk.greenBright(`Documentation generated successfully: ${docsDirectory}`));
+		if (argv.serve){
+			serve(docsDirectory);
+		}else{
+			process.exit(0);
+		}
+		
+		
 	} catch (e) {
 
 		console.log(`${chalk.redBright(e.message)}`);
 		process.exit(1);
 	}
+}
+
+function serve(websiteDir) {
+	const app = express();
+	const port = 3000;
+	app.use(express.static(websiteDir));
+	app.listen(port, () => {
+		console.log(chalk.yellowBright(`Documentation available at http://localhost:${port}`));
+	})
 }

package/package.json

@@ -3,7 +3,7 @@
   "productName": "Kumologica Designer",
   "copyright": "Copyright 2020 Kumologica Pty Ltd, All Rights Reserved.",
   "author": "Kumologica Pty Ltd <contact@kumologica.com>",
-  "version": "3.2.2",
+  "version": "3.3.0-beta2",
   "description": "Kumologica Designer, harnessing Serverless for your cloud integration needs",
   "main": "src/app/main.js",
   "files": [
@@ -64,9 +64,9 @@
   "license": "Proprietary",
   "dependencies": {
     "@electron/remote": "^2.0.8",
-    "@kumologica/builder": "3.2.2",
-    "@kumologica/devkit": "3.2.2",
-    "@kumologica/runtime": "3.2.2",
+    "@kumologica/builder": "3.3.0-beta2",
+    "@kumologica/devkit": "3.3.0-beta2",
+    "@kumologica/runtime": "3.3.0-beta2",
     "adm-zip": "0.4.13",
     "ajv": "8.10.0",
     "archive-type": "^4.0.0",