@kumologica/sdk 3.2.0-beta8 → 3.2.0

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

@@ -1,4 +1,4 @@
-exports.command = 'kumohub';
+/*exports.command = 'kumohub';
 exports.desc = `Deploy kumologica flow to kumohub.io account`;
 
 exports.builder = {
@@ -111,4 +111,6 @@ exports.handler = function (argv) {
 		console.log(`${e.message}`);
 		process.exit(1);
 	}
-}
+}
+
+*/

package/cli/commands/deploy.js

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

package/cli/commands/export-commands/cloudformation.js

@@ -158,14 +158,15 @@ Examples:
 Cloudwatch Event:\n-----------------
 		* schedule - cron expression (minutes hours days-of-month month days-of-week year) or fixed rate expression, required.\n See more: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html
 		* name - the name of event, optional, default value: Event+timestamp if not provided
+		* state - state of event rule: ENABLED or DISABLED, default ENABLED
 		* reference - the reference property set for event listener node that should handle event. Optional
 
 Examples:
 1. Creates event trigger using cron expression that runs at 10am UTC every day:\n
 			{"event": {"expression": "cron(0 10 * * ? *)"}}
 			
-2. Creates event trigger using rate expression that runs every minute:\n
-			{"event": {"expression": "rate(1 minute)"}}\n
+2. Creates event trigger using rate expression that runs every minute and is initially disabled:\n
+			{"event": {"expression": "rate(1 minute), "state": "DISABLED"}}\n
 
 3. Creates event trigger using rate expression that runs every minute for event listener with reference "cleanup":\n
 			{"event": {"expression": "rate(1 minute)", "reference": "cleanup"}}\n

package/cli/commands/export-commands/github-commands/aws.js

@@ -0,0 +1,374 @@
+const { exp } = require('@kumologica/builder');
+
+exports.command = 'aws';
+exports.desc = `Export github workflow file to automate deployment of kumologica flow into AWS using github action workflow.`;
+
+exports.builder = {		
+		
+	"project-directory": {
+		describe: "\nThe location of kumologica project.\n Current working directory if not provided.",
+		type: 'string',
+		alias: 'd',
+		nargs: 1
+	},
+	"flow-file-name": {
+		describe: "\nThe name of kumologica flow file.\n Auto search if not provided.",
+		type: 'string',
+		alias: 'f',
+		nargs: 1
+	},
+	"lambda-name": {
+		describe: "\nThe name of lambda function,\n default to flow name",
+		type: 'string',
+		alias: 'l',
+		nargs: 1
+	},
+	"zip-file-name": {
+		describe: "\nThe name of zip file of built lambda. The zip file may not exists until 'aws cloudformation package' command is called." ,
+		demandOption: "The name of zip file is required.",
+		type: 'string',
+		alias: 'z',
+		nargs: 1
+	},
+	"role-name": {
+		describe: "\nThe name of lambda role, default to {lambda-name}-role",
+		type: 'string',
+		alias: 'o',
+		nargs: 1
+	},
+    "bucket-name": {
+		describe: "\nThe name of bucket where zipped lambda is loaded from",
+		demandOption: "The name of s3 bucket is required.",
+		type: 'string',
+		alias: 'b',
+		nargs: 1
+	},
+	timeout: {
+		describe: "\nThe time in seconds lambda is allowed to run, max: 900",
+		type: 'number',
+		alias: 't',
+		nargs: 1
+	},
+	"memory-size": {
+		describe: "\nThe amount of memory allocated to function, default 128 (MB), must be multiple of 64 (MB), max 4096 (MB)",
+		type: 'number',
+		default: 128,
+		alias: 'm',
+		nargs: 1
+	},
+	description: {
+		describe: "\nThe description of a function",
+		type: 'string',
+		nargs: 1
+	},
+	environment: {
+		describe: `\nEnvironment variables, JSON Syntax: '{"Variables": {"string": "string" ...}'}`,
+		type: 'string',
+		alias: 'e',
+		nargs: 1
+	},
+	tags: {
+		describe: `\nTags, JSON Syntax: '{"name": "value" ...}'`,
+		type: 'string',
+		alias: 'g',
+		nargs: 1
+	},
+	"tracing-config": {
+		describe: `\nX-Ray config, JSON Syntax: '{"Mode": "Active"|"PassThrough"}' `,
+		type: 'string',
+		alias: 'x',
+		nargs: 1
+	},
+	"kms-key-arn": {
+		describe: "\nThe ARN of KMS key to encrypt env variables",
+		type: 'string',
+		alias: 'k',
+		nargs: 1
+	},
+	"vpc-config": {
+		describe: `\nThe list of security groups and subnets of VPC, JSON syntax: '{ "SubnetIds": ["string", ...],"SecurityGroupIds": ["string", ...]}'`,
+		type: 'string',
+		alias: 'v',
+		nargs: 1
+	},
+	architectures: {
+		describe: "\nThe instruction set architecture that the function supports, a string array with one of x86_64, arm64. Default value: [x86_64].",
+		type: 'string',
+		nargs: 1
+	},
+	runtime: {
+		describe: "\nThe runtime, only nodejs runtimes allowed: nodejs12.x | nodejs14.x | nodejs16.x | ...",
+		type: 'string',
+		default: 'nodejs14.x',
+		alias: 'r',
+		nargs: 1
+	},
+	"dead-letter-config": {
+		describe: `\nThe arn of the dead letter queue or topic JSON Syntax: '{"TargetArn": "string"}'`,
+		type: 'string',
+		alias: 'q',
+		nargs: 1
+	},
+	"file-system-configs": {
+		describe: `\nAWS EFS config details, JSON Syntax: '[{"Arn": "string","LocalMountPath": "string"} ...]'`,
+		type: 'string',
+		nargs: 1
+	},
+	"log-retention-days": {
+		describe: '\nNumber of days logs to be retained',
+		type: 'number',
+		nargs: 1
+	},
+	"role-arn": {
+		describe: `\nThe arn of IAM role to assign to lambda, otherwise this command will generate role. \n Important!\n This parameter should only be used if this command is not able to generate sufficient role based on flow details.`,
+		type: 'string',
+		nargs: 1
+	},
+	"layers": {
+		describe: `\nList of arn of lambda layers to be added.`,
+		type: 'string',
+		nargs: 1
+	},
+	"policy": {
+		describe: `\nAdditional iam policy to add to the role. It must be in valid aws policy format, for example: '{"Effect": "Allow", "Resource": ["*"],"Action": ["sns:Publish"]}'. if policy is invalid, cloudformation stack will fail. The value can be single policy statement or array of statements if required. This parameter is ignored if role-arn is provided.`,
+		type: 'string',
+		nargs: 1
+	},
+	"strict-mode": {
+		describe: '\nFails script creation if insufficient resource definition is provided (string values or environment reference). If false, then resource will be substituted with "*" if missing.',
+		type: 'boolean',
+		nargs: 1,
+		default: true
+	},
+	triggers: {
+		describe: `\nArray of lambda triggers, JSON Syntax: '[{"api": {"apiId": "..",..}]'}
+
+		Supported triggers:
+
+Partner Event:\n-----------------
+		* partnerEventBusName - The name of partner event bus name
+		* name - the name of event, optional, default value: Event+timestamp if not provided
+		* detailType - the detail-type content of the event. Optional
+
+Examples:
+1. Creates partner event trigger for salesforce AccountChangeEvent event:\n
+		{"partnerEvent": {"detail-type": "AccountChangeEvent", "partnerEventBusName": "aws.partner/salesforce.com/444444444/555555"}}
+
+Cloudwatch Event:\n-----------------
+		* schedule - cron expression (minutes hours days-of-month month days-of-week year) or fixed rate expression, required.\n See more: https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-create-rule-schedule.html
+		* name - the name of event, optional, default value: Event+timestamp if not provided
+		* reference - the reference property set for event listener node that should handle event. Optional
+
+Examples:
+1. Creates event trigger using cron expression that runs at 10am UTC every day:\n
+			{"event": {"expression": "cron(0 10 * * ? *)"}}
+			
+2. Creates event trigger using rate expression that runs every minute:\n
+			{"event": {"expression": "rate(1 minute)"}}\n
+
+3. Creates event trigger using rate expression that runs every minute for event listener with reference "cleanup":\n
+			{"event": {"expression": "rate(1 minute)", "reference": "cleanup"}}\n
+
+SNS:\n----
+			* topicArn - the ARN of sns topic, required
+
+Example:
+			{"sns": {"topicArn": "arn:aws:sns: ..."}}
+
+SQS:\n----
+			* queueArn - the ARN of sqs queue, required
+			* batchSize - the size of batch, optional
+
+Example:
+			{"sqs": {"queueArn": "arn:aws:sqs: ..."}}
+
+DynamoDB Stream:\n----
+			* streamArn - the ARN of dynamodb stream, required
+			* batchSize - the size of batch, optional
+			* batchWindow - maximum batching window in seconds, optional
+			* startingPosition - either LATEST or TRIM_HORIZON, optional
+Example: 
+			{"dynamodb": {"streamArn": "arn:aws: ...", "startingPosition": "LATEST"}}
+
+Kinesis Stream:\n---------------
+			* streamArn - the ARN of kinesis stream, required
+			* batchSize - the size of batch, optional
+			* batchWindow - maximum batching window in seconds, optional
+			* startingPosition - either LATEST or TRIM_HORIZON, optional
+Example: 
+			{"kinesis": {"streamArn": "arn:aws: ...", "startingPosition": "LATEST"}}
+
+S3:\n---
+			* bucket - the name of the bucket, required
+			* sourceAccount - the account id
+			* eventType - the size of batch, optional
+			* prefix - maximum batching window in seconds, optional
+			* suffix - either LATEST or TRIM_HORIZON, optional
+Example: 
+			{"s3": {"bucket": "testBucket", "eventType": "ObjectCreated.*"}}
+
+Rest api gateway:\n-----------------
+			* apiId:    the id of rest api, required
+			* stage:    the stage name of api gateway, required
+			* parentId: the id of parent resource where lambda {proxy+} should be added, required
+			* resource: the name of resource linked to lambda, required if parentId is not root or lambda linked to non root in api gw
+			* authorizerType: the type of authorizer: TOKEN, COGNITO_USER_POOLS, REQUEST
+			* authorizerId: the if of authorizer, optional
+			* apiKeyRequired: true if api key is required. default false
+			* scopes:   array of scopes, optional
+
+Examples:
+
+1. Creates new api gateway, default: 'test' stage and root proxy resource:
+
+		{"api": {
+			"apiId": "create new",
+			"apiName": "booking api"\n}
+
+2. Creates new api gateway, default: 'test' stage and proxy resource under /users resource:
+			
+		{"api": {
+			"apiId": "create new",
+			"apiName": "users api",
+			"resource": "users"\n}\n}
+	
+3. Uses existing api gateway, 'test' stage, creates proxy resource under /users resource, attaches request authorizer to proxy and required OAuth scopes:
+			{"api": {
+			   "apiId": "fg4wsf",
+				"stage": "test",
+				"parentId": "vfgd24d",
+				"resource": "users",
+				"authorizerId": "3dgfd42",
+				"authorizerType": "REQUEST",
+				"scopes": ["users", "admins"]\n}
+
+4. Uses existing api gateway, 'test' stage, creates proxy resource under specified parent id:
+				{"api": {
+				\t"apiId": "fg4wsf",
+				\t"stage": "test",	
+				\t"parentId": "vfgd24d"\n}
+
+5. Creates new api gateway, default: 'test' stage, proxy resource under /users resource with required api key:
+			
+				{"api": {
+					"apiId": "create new",
+					"apiName": "users api",
+					"resource": "users",
+					"apiKeyRequired: true\n}\n}
+					`,
+		type: 'string',
+		nargs: 1
+	},
+
+}
+		
+function display(argv) {
+	console.log('Parameters:');
+	console.log('  flow-file-name:      %s', argv["flow-file-name"]||'');
+	console.log('  zip-file-name:       %s', argv["zip-file-name"]||'');
+	console.log('  lambda-name:         %s', argv["lambda-name"]||'');
+	console.log('  role-name:           %s', argv["role-name"]||'');
+	console.log('  bucket-name:         %s', argv["bucket-name"]);
+	console.log('  timeout:             %s', argv["timeout"]);
+	console.log('  memory-size:         %s', argv["memory-size"]||'');
+	console.log('  description:         %s', argv.description||'');
+	console.log('  environment:         %s', argv.environment||'');
+	console.log('  tags:                %s', argv["tags"]||'');
+	console.log('  tracing-config:      %s', argv["tracing-config"]||'');
+	console.log('  kms-key-arn:         %s', argv["kms-key-arn"]||'');
+	console.log('  vpc-config:          %s', argv["vpc-config"]||'');
+	console.log('  architectures:       %s', argv.architectures || '');
+	console.log('  runtime:             %s', argv.runtime||'');
+	console.log('  dead-letter-config:  %s', argv["dead-letter-config"]||'');
+	console.log('  file-system-configs: %s', argv["file-system-configs"]||'');
+	console.log('  log-retention-days:  %s', argv["log-retention-days"]||'');
+	console.log('  role-arn:            %s', argv["role-arn"]||'');
+	console.log('  policy:              %s', argv["policy"] || '');
+	console.log('  layers:              %s', argv["layers"] || '');
+	console.log(`  strict-mode:         ${argv["strict-mode"]}`);
+	console.log('  triggers:            %s', argv.triggers||'');	
+}
+
+function validateJson(name, s) {
+	if (typeof s !== 'string') {
+		throw new Error (`Validation error: parameter '${name}' value is not string: '${s}'`);
+	}
+	
+	let type;
+	try {
+		const result = JSON.parse(s);
+		type = Object.prototype.toString.call(result);
+	} catch (e) {
+		throw new Error (`Validation error: parameter '${name}': ${e.message}`);
+	}
+
+	if (!(type === '[object Object]' || type === '[object Array]')) {
+		throw new Error (`Validation error: parameter '${name}' value is not in JSON format: '${s}'`);
+	}
+}
+
+function validate(argv) {
+
+	const validator = require('../utils/validator');
+
+  if (argv.environment) {
+		validateJson("environment", argv.environment);
+	}
+	if (argv.tags) {
+		validateJson("tags", argv.tags);
+	}
+	if (argv["tracing-config"]) {
+		validateJson("tracing-config", argv["tracing-config"]);
+	}
+	if (argv["vpc-config"]) {
+		validateJson("vpc-config", argv["vpc-config"]);
+	}
+	if (argv["dead-letter-config"]) {
+		validateJson("dead-letter-config", argv["dead-letter-config"]);
+	}
+	if (argv["file-system-configs"]) {
+		validateJson("file-system-configs", argv["file-system-configs"]);
+	}
+	if (argv["policy"]) {
+		validateJson("policy", argv["policy"]);
+	}
+	if (argv["layers"]) {
+		validateJson("layers", argv["layers"]);
+	}
+	if (argv.triggers) {
+		validateJson("triggers", argv.triggers);
+		validator.validate("triggers", JSON.parse(argv.triggers));
+	}
+	if (argv.runtime) {
+		if (!argv.runtime.startsWith("nodejs")) {
+			throw new Error (`Validation error: parameter 'runtime' must be one of supported nodejs values: nodejs|nodejs4.3|nodejs6.10|nodejs8.10|nodejs10.x|nodejs12.x|...`);
+		}
+	}
+	if (argv.architectures ) {
+		argv.architectures = JSON.parse(argv.architectures);
+		if (!argv.architectures.length || argv.architectures.length != 1 || !["x86_64","arm64"].includes(argv.architectures[0])) {
+			throw new Error (`Validation error: parameter 'architectures' must be an array with one element, either x86_64 or arm64`);
+		}
+	}
+}
+
+exports.handler = function (argv) {
+	console.log('\nGenerating Github action workflow\n');
+	display(argv);
+	const chalk = require('chalk');
+
+	try {
+		validate(argv);
+
+		const { exp } = require('@kumologica/builder');
+		
+		exp('github', 'aws', argv);
+		console.log(chalk.greenBright('Github action workflow created successfully.'));
+	
+		process.exit(0);
+	} catch (e) {
+
+		console.log(`${chalk.redBright(e.message)}`);
+		process.exit(1);
+	}
+}

package/cli/commands/export-commands/github.js

@@ -0,0 +1,6 @@
+exports.command = 'github <platform>'
+exports.desc = 'Export github workflow for kumologica flow'
+exports.builder = function (yargs) {
+  return yargs.commandDir('github-commands')
+}
+exports.handler = function (argv) {}

package/cli/commands/export-commands/utils/validator.js

@@ -29,6 +29,12 @@ const triggersSchema = {
 						"title": "Event name", 
 						"type": "string"
 					},
+					"state": {
+						"$id": "#root/items/event/state", 
+						"title": "State", 
+						"type": "string",
+						"enum": ["DISABLED", "ENABLED"]
+					},
 					"reference": {
 						"$id": "#root/items/event/reference", 
 						"title": "Event Listener reference", 
@@ -168,8 +174,52 @@ const triggersSchema = {
 						}
 					}
 				}
+			},
+			"websocket": {
+				"$id": "#root/items/websocket", 
+				"title": "Api", 
+				"type": "object",
+				required: [],
+				additionalProperties: false,
+				required: ["apiId"],
+				"properties": {
+					"apiId": {
+						"$id": "#root/items/websocket/apiId", 
+						"title": "ApiId", 
+						"type": "string",			
+						"pattern": "^.*$"
+					},
+					"apiName": {
+						"$id": "#root/items/websocket/apiName", 
+						"title": "ApiName", 
+						"type": "string",
+						"pattern": "^.*$"
+					},
+					"stage": {
+						"$id": "#root/items/websocket/stage", 
+						"title": "Stage", 
+						"type": "string",
+						"pattern": "^.*$"
+					},
+					"authorizerId": {
+						"$id": "#root/items/websocket/authorizerId", 
+						"title": "Authorizerid", 
+						"type": "string",	
+						"pattern": "^.*$"
+					},
+					"authorizerType": {
+						"$id": "#root/items/websocket/authorizerType", 
+						"title": "AuthorizerType", 
+						"type": "string",	
+						"pattern": "^.*$"
+					},
+					"apiKeyRequired": {
+						"$id": "#root/items/websocket/apiKeyRequired", 
+						"title": "ApiKeyRequired", 
+						"type": "boolean"
+					}
+				}
 			}
-
 		}
 	}
 };

package/fixtures/hello/.kumologica/test-config.json

@@ -0,0 +1,23 @@
+{
+  "test": {
+    "testcase": "e8fb91dc.46c24",
+    "environment": "debug",
+    "environments": [
+      "; ===========================================================",
+      "; Environment variables must be defined under one section",
+      "; You can define as many sections as you need.",
+      "; (Remove the semicolons to uncomment the lines)",
+      "; ===========================================================",
+      "",
+      "; Example:",
+      "",
+      "[debug]",
+      "KUMOLOGICA_LOGLEVEL=DEBUG",
+      "",
+      "[trace]",
+      "KUMOLOGICA_LOGLEVEL=TRACE",
+      "; VAR_1=VALUE_1",
+      ""
+    ]
+  }
+}

package/fixtures/hello/config.json

@@ -0,0 +1,9 @@
+{
+  "version": "0.0.1",
+  "runtime": {
+    "loglevel": "info",
+    "middlewares": [],
+    "plugins": []
+    }
+}
+