zcatalyst-cli 1.18.0-beta.0 → 1.18.0-beta.2

package/templates/init/functions/java/job/.classpath

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+    <classpathentry including="**/*.java" kind="src" path="."/>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
+	<classpathentry kind="output" path=".output"/>
+</classpath>

package/templates/init/functions/java/job/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>{{_NAME_}}</name>
+	<comment></comment>
+	<projects>
+	</projects>
+    <buildSpec>
+        <buildCommand>
+            <name>org.eclipse.jdt.core.javabuilder</name>
+            <arguments>
+            </arguments>
+        </buildCommand>
+    </buildSpec>
+    <natures>
+        <nature>org.eclipse.jdt.core.javanature</nature>
+    </natures>
+</projectDescription>

package/templates/init/functions/java/job/catalyst-config.json

@@ -0,0 +1,11 @@
+{
+	"deployment": {
+		"name": "{{_NAME_}}",
+		"stack": "{{_STACK_}}",
+		"type": "{{_TYPE_}}",
+		"env_variables": {}
+	},
+	"execution": {
+		"main": "{{_CLASS_}}"
+	}
+}

package/templates/init/functions/java/job/sample.java

@@ -0,0 +1,34 @@
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import com.catalyst.Context;
+import com.catalyst.job.JOB_STATUS;
+import com.catalyst.job.JobRequest;
+import com.catalyst.job.CatalystJobHandler;
+
+ import com.zc.common.ZCProject;
+ import com.zc.component.cache.ZCCache;
+
+public class {{_CLASS_}} implements CatalystJobHandler {
+
+	private static final Logger LOGGER = Logger.getLogger({{_CLASS_}}.class.getName());
+
+	@Override
+	public JOB_STATUS handleJobExecute(JobRequest request, Context arg1) throws Exception {
+		try {
+			ZCProject.initProject();
+			Object eventData = request.getAllJobParams();
+			if(eventData != null) {
+				LOGGER.log(Level.SEVERE, "Data is" + eventData.toString());
+			}
+			LOGGER.log(Level.SEVERE, "Project Details " + request.getProjectDetails().toString());
+			ZCCache.getInstance().putCacheValue("JobSample", "Working", 1l);
+			LOGGER.log(Level.SEVERE, "Inserted SuccessFully:)");
+		} catch (Exception e) {
+			LOGGER.log(Level.SEVERE, "Exception in Job Function", e);
+			return JOB_STATUS.FAILURE;
+		}
+		return JOB_STATUS.SUCCESS;
+	}
+
+}

package/templates/init/functions/node/aio/package.json

@@ -4,6 +4,6 @@
 	"main": "{{_MAIN_}}",
 	"author": "{{_AUTHOR_}}",
 	"dependencies": {
-		"zcatalyst-sdk-node": "latest"
+		"zcatalyst-sdk-node": "beta"
 	}
 }

package/templates/init/functions/node/aio/sample.js

@@ -1,5 +1,12 @@
 'use strict';
 
+const { IncomingMessage, ServerResponse } = require("http");
+
+/**
+ * 
+ * @param {IncomingMessage} req 
+ * @param {ServerResponse} res 
+ */
 module.exports = (req, res) => {
 	var url = req.url;
 

package/templates/init/functions/node/bio/package.json

@@ -4,6 +4,6 @@
 	"main": "{{_MAIN_}}",
 	"author": "{{_AUTHOR_}}",
 	"dependencies": {
-		"zcatalyst-sdk-node": "latest"
+		"zcatalyst-sdk-node": "beta"
 	}
 }

package/templates/init/functions/node/bio/sample.js

@@ -1,3 +1,8 @@
+/**
+ * 
+ * @param {import('./types/basicio').Context} context 
+ * @param {import('./types/basicio').BasicIO} basicIO 
+ */
 module.exports = (context, basicIO) => {
 	/* 
         BASICIO FUNCTIONALITIES

package/templates/init/functions/node/bio/types/basicio.d.ts

@@ -0,0 +1,57 @@
+/**
+ * This is a utility file with the type declaration of the BasicIO function parameters
+ */
+
+/**
+ * Type of the BasicIO object. Contains the functional APIs of BasicIO
+ */
+export interface BasicIO {
+    /**
+     * Write to the BasicIO output
+     * @param value input string
+     * @returns 
+     */
+    write: (value: string) => void;
+    /**
+     * Set the BasicIO status code
+     * @param statusCode status code of BasicIO
+     * @returns 
+     */
+    setStatus: (statusCode: number) => void;
+    /**
+     * Get the input argument values of the BasicIO
+     * @param key argument name(key)
+     * @returns argument value as string
+     */
+    getArgument: (key: string) => string;
+    /**
+     * Get all input arguments
+     * @returns all arguments as key value pair
+     */
+    getAllArguments: () => Record<string, string>;
+}
+
+/**
+ * Type of the context object of the function
+ */
+export interface Context {
+    /**
+     * Contains catalyst auth headers (for internal use)
+     */
+    catalystHeaders: Record<string, string>;
+    /**
+     * To indicate the end of a function execution
+     * @returns 
+     */
+    close: () => void;
+    /**
+     * Fetch the remaining execution time of the function
+     * @returns remaining execution time in milliseconds
+     */
+    getRemainingExecutionTimeMs: () => number;
+    /**
+     * Fetch the maximum execution time of the function
+     * @returns maximum execution time in milliseconds
+     */
+    getMaxExecutionTimeMs: () => number;
+}

package/templates/init/functions/node/cron/package.json

@@ -4,6 +4,6 @@
 	"main": "{{_MAIN_}}",
 	"author": "{{_AUTHOR_}}",
 	"dependencies": {
-		"zcatalyst-sdk-node": "latest"
+		"zcatalyst-sdk-node": "beta"
 	}
 }

package/templates/init/functions/node/cron/sample.js

@@ -1,3 +1,8 @@
+/**
+ * 
+ * @param {import('./types/cron').CronDetails} cronDetails 
+ * @param {import('./types/cron').Context} context 
+ */
 module.exports = (cronDetails, context) => {
 	console.log('Hello from {{_MAIN_}}');
 

package/templates/init/functions/node/cron/types/cron.d.ts

@@ -0,0 +1,64 @@
+/**
+ * This is a utility file with the type declaration of the Cron function parameters
+ */
+
+/**
+ * Type of Cron Details object. Contains the details of the scheduled cron
+ */
+export interface CronDetails {
+    /**
+     * Get the input param value of the Cron function
+     * @returns input param value
+     */
+    getCronParam: () => string;
+    /**
+     * Get all input params of the Cron function
+     * @returns all input params as key value pairs
+     */ 
+    getAllCronParam: () => Record<string, string>;
+    /**
+     * Get the remaining execution count of the cron job
+     * @returns remaining execution count
+     */
+    getRemainingExecutionCount: () => number;
+    /**
+     * Get the details of the cron which executed the function
+     * @returns cron details
+     */
+    getCronDetails: () => Record<string, unknown>;
+    /**
+     * Get the current project details
+     * @returns project details
+     */
+    getProjectDetails: () => Record<string, unknown>;
+}
+
+/**
+ * Type of the Context object of the Cron function
+ */
+export interface Context {
+    /**
+     * Contains catalyst auth headers (for internal use)
+     */
+    catalystHeaders: Record<string, string>;
+    /**
+     * Close the Cron function with success response
+     * @returns 
+     */
+    closeWithSuccess: () => void;
+    /**
+     * Close the Cron function failure response
+     * @returns 
+     */
+    closeWithFailure: () => void;
+    /**
+     * Get the remaining execution time of the Cron function
+     * @returns remaining execution time in milliseconds
+     */
+    getRemainingExecutionTimeMs: () => number;
+    /**
+     * Get the maximum possible execution time of the Cron function
+     * @returns maximum possible execution time in milliseconds
+     */
+    getMaxExecutionTimeMs: () => number;
+}

package/templates/init/functions/node/event/package.json

@@ -4,6 +4,6 @@
 	"main": "{{_MAIN_}}",
 	"author": "{{_AUTHOR_}}",
 	"dependencies": {
-		"zcatalyst-sdk-node": "latest"
+		"zcatalyst-sdk-node": "beta"
 	}
 }

package/templates/init/functions/node/event/sample.js

@@ -1,20 +1,23 @@
+/**
+ * 
+ * @param {import('./types/event').EventDetails} event 
+ * @param {import('./types/event').Context} context 
+ */
 module.exports = (event, context) => {
 	/* 
         EVENT FUNCTIONALITIES
     */
-	// const DATA = event.data; //event data
-	// const TIME = event.time; //event occured time
+	// const DATA = event.getData(); //event data
+	// const TIME = event.getTime(); //event occurred time
 
-	// const SOURCE_DETAILS = event.getSourceDetails(); //event source details
-	// const SOURCE_ACTION = SOURCE_DETAILS.action; //(insert | fetch | invoke ...)
-	// const SOURCE_TYPE = SOURCE_DETAILS.type; //(datastore | cache | queue ...)
-	// const SOURCE_ENTITY_ID = SOURCE_DETAILS.entityId; //if type is datastore then entity id is tableid
+	// const ACTION = event.getAction(); //(insert | fetch | invoke ...)
+	// const SOURCE = event.getSource(); //(datastore | cache | queue ...)
+	// const SOURCE_ENTITY_ID = event.getSourceEntityId(); //if type is datastore then entity id is tableid
 
-	// const SOURCE_BUS_DETAILS = SOURCE_DETAILS.getBusDetails(); //event bus details
+	// const SOURCE_BUS_DETAILS = event.getBusDetails(); //event bus details
 	// const SOURCE_BUS_ID = SOURCE_BUS_DETAILS.id; //event bus id
 
 	// const PROJECT_DETAILS = event.getProjectDetails(); //event project details
-	// const FUNCTION_DETAILS = event.getFunctionDetails(); //event function details
 
 	console.log('Hello from {{_MAIN_}}');
 

package/templates/init/functions/node/event/types/event.d.ts

@@ -0,0 +1,82 @@
+/**
+ * This is a utility file with the type declaration of the Event function parameters
+ */
+
+/**
+ * Type of Event Details object. Contains the details of the triggered Event
+ */
+export interface EventDetails {
+    /**
+     * Event data
+     */
+    data: Record<string, unknown>;
+    /**
+     * Time of the event
+     */
+    time: number;
+    /**
+     * Get the project details of the event function
+     * @returns project details
+     */
+    getProjectDetails: () => Record<string, unknown>;
+    /**
+     * Functional API to get the data of the event
+     * @returns event data
+     */
+    getData: () => Record<string, unknown>;
+    /**
+     * Functional API to get the time of the event
+     * @returns event time
+     */
+    getTime: () => number;
+    /**
+     * Get the action that triggered the event
+     * @returns action
+     */
+    getAction: () => string;
+    /**
+     * Get the source of the event
+     * @returns event source
+     */
+    getSource: () => string;
+    /**
+     * Get the Id of the entity that triggered the event
+     * @returns source entity's Id
+     */
+    getSourceEntityId: () => string;
+    /**
+     * Get the details of the event bus
+     * @returns event bus details
+     */
+    getEventBusDetails: () => Record<string, unknown>;
+}
+
+/**
+ * Type of the Context object of the Event function
+ */
+export interface Context {
+    /**
+     * Contains catalyst auth headers (for internal use)
+     */
+    catalystHeaders: Record<string, string>;
+    /**
+     * Close the Event function with success response
+     * @returns 
+     */
+    closeWithSuccess: () => void;
+    /**
+     * Close the Event function failure response
+     * @returns 
+     */
+    closeWithFailure: () => void;
+    /**
+     * Get the remaining execution time of the Event function
+     * @returns remaining execution time in milliseconds
+     */
+    getRemainingExecutionTimeMs: () => number;
+    /**
+     * Get the maximum possible execution time of the Event function
+     * @returns maximum possible execution time in milliseconds
+     */
+    getMaxExecutionTimeMs: () => number;
+}

package/templates/init/functions/node/integ/cliq/package.json

@@ -6,6 +6,6 @@
 	"type": "module",
 	"dependencies": {
 		"zcatalyst-integ-cliq": "latest",
-		"zcatalyst-sdk-node": "^2.1.0"
+		"zcatalyst-sdk-node": "beta"
 	}
 }

package/templates/init/functions/node/integ/convokraft/package.json

@@ -5,6 +5,6 @@
 	"author": "{{_AUTHOR_}}",
 	"type": "module",
 	"dependencies": {
-		"zcatalyst-sdk-node": "^2.1.0"
+		"zcatalyst-sdk-node": "beta"
 	}
 }

package/templates/init/functions/node/{stream → job}/catalyst-config.json

@@ -2,9 +2,10 @@
 	"deployment": {
 		"name": "{{_NAME_}}",
 		"stack": "{{_STACK_}}",
-		"type": "{{_TYPE_}}"
+		"type": "{{_TYPE_}}",
+		"env_variables": {}
 	},
 	"execution": {
 		"main": "{{_MAIN_}}"
 	}
-}
+}

package/templates/init/functions/node/{stream → job}/package.json

@@ -4,6 +4,6 @@
 	"main": "{{_MAIN_}}",
 	"author": "{{_AUTHOR_}}",
 	"dependencies": {
-		"zcatalyst-sdk-node": "latest"
+		"zcatalyst-sdk-node": "beta"
 	}
 }

package/templates/init/functions/node/job/sample.js

@@ -0,0 +1,27 @@
+/**
+ * 
+ * @param {import("./types/job").JobRequest} jobRequest 
+ * @param {import("./types/job").Context} context 
+ */
+module.exports = (jobRequest, context) => {
+	console.log('Hello from {{_MAIN_}}');
+
+	// function input: { job_details: { job_meta_details: { params: { key: 'value' } } } }
+
+	/**
+	 * JOB REQUEST FUNCTIONALITIES
+	 */
+
+	const projectDetails = jobRequest.getProjectDetails(); // to get the current project details
+	const jobDetails = jobRequest.getJobDetails(); // to get the current job details
+	const jobMetaDetails = jobRequest.getJobMetaDetails(); // to get the current job's meta details
+	const getJobCapacityAttributes = jobRequest.getJobCapacityAttributes(); // to get the current jobs capacity
+	const allJobParams = jobRequest.getAllJobParams(); // to get all the parameters supplied to the job function
+	const jobParam = jobRequest.getJobParam('key'); // to get the value of a particular parameter supplied to the job function
+
+	/**
+	 * CONTEXT FUNCTIONALITIES
+	 */
+	context.closeWithSuccess(); //end of application with success
+	// context.closeWithFailure(); //end of application with failure
+};

package/templates/init/functions/node/job/types/job.d.ts

@@ -0,0 +1,62 @@
+/**
+ * This is a utility file with the type declaration of the job function parameters
+ */
+
+/**
+ * Type of the Job Request object. Contains the required details of the current job.
+ */
+export interface JobRequest {
+    /**
+     * @returns Current project details
+     */
+    getProjectDetails: () => Record<string, unknown>;
+    /**
+     * @returns Details of the current job
+     */
+    getJobDetails: () => Record<string, unknown>;
+    /**
+     * @returns Meta details of the current job
+     */
+    getJobMetaDetails: () => Record<string, unknown>;
+    /**
+     * @returns Capacity attributes of the current job
+     */
+    getJobCapacityAttributes: () => Record<string, string | number>;
+    /**
+     * 
+     * @returns All parameters passed to the job function
+     */
+    getAllJobParams: () => Record<string, string>;
+    /**
+     * @param key Name of the job param
+     * @returns Value of the job param
+     */
+    getJobParam: (key: string) => string | undefined;
+}
+
+/**
+ * Type of the context object. This object is used to initialize the Catalyst sdk
+ */
+export interface Context extends Record<string, unknown> {
+    /**
+     * Contains the necessary headers to initialize the sdk
+     */
+    catalystHeaders: Record<string, string | number>;
+    /**
+     * @returns Maximum allowed execution time of the function
+     */
+    getMaxExecutionTimeMs: () => number;
+    /**
+     * This values is the difference between time Maximum execution time and the current time
+     * @returns Remaining execution time of the function
+     */
+    getRemainingExecutionTimeMs: () => number;
+    /**
+     * Conclude the function execution with a success response
+     */
+    closeWithSuccess: () => void;
+    /**
+     * Conclude the function execution with a failure response
+     */
+    closeWithFailure: () => void;
+}

package/templates/init/functions/python/job/catalyst-config.json

@@ -0,0 +1,11 @@
+{
+	"deployment": {
+		"name": "{{_NAME_}}",
+		"stack": "{{_STACK_}}",
+		"type": "{{_TYPE_}}",
+		"env_variables": {}
+	},
+	"execution": {
+		"main": "{{_MAIN_}}"
+	}
+}

package/templates/init/functions/python/job/requirements.txt

@@ -0,0 +1 @@
+zcatalyst-sdk=={{_VERSION_}}

package/templates/init/functions/python/job/sample.py

@@ -0,0 +1,22 @@
+import logging
+
+
+def handler(job_request, context):
+    logger = logging.getLogger()
+    logger.info('Hello from {{_MAIN_}}')
+
+    # function input: { job_details: { job_meta_details: { params: { key: 'value' } } } }
+
+    '''JobRequest Functionalities'''
+    job_details = job_request.get_job_details() # get the details of the current job
+    project_details = job_request.get_project_details() # get the details of the current project
+    job_meta_details = job_request.get_job_meta_details() # get the job meta of the current job
+    job_capacity_attributes = job_request.get_job_capacity_attributes() # get the current jobs capacity
+    all_job_params = job_request.get_all_job_params() # get all the parameters supplied to the job function
+    job_param = job_request.get_job_param('key') # get the value of a particular parameter supplied to the job function
+
+    '''Context Functionalities'''
+    remaining_execution_time_ms = context.get_remaining_execution_time_ms() # get the maximum allowed execution time for the job functions
+    max_execution_time_ms = context.get_max_execution_time_ms() # get the remaining execution time for this job function
+    # context.close_with_failure() # conclude the function execution with a failure response
+    context.close_with_success() # conclude the function execution with a success response

package/templates/init.txt

@@ -0,0 +1,13 @@
+if (typeof catalyst === 'undefined'){
+	throw new Error('Catalyst Web SDK not included. You must include it before /__catalyst/sdk/init.js');
+}
+
+catalyst.initApp({
+	project_Id : "{{__PROJECT_ID__}}", //No I18N
+	zaid : "{{__ZAID__}}", //No I18N
+	auth_domain : "{{__AUTH_DOMAIN__}}",
+	is_appsail : "true",
+	api_domain : ""
+},{
+	org_id: "{{__ORG_ID__}}" //No I18N
+});