zcatalyst-cli 1.18.0-beta.1 → 1.18.0-beta.10

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/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/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/job/sample.js

@@ -15,7 +15,6 @@ module.exports = (jobRequest, context) => {
 	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 jobpoolDetails = jobRequest.getJobpoolDetails(); // to get the current function job pool's 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

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

@@ -18,10 +18,6 @@ export interface JobRequest {
      * @returns Meta details of the current job
      */
     getJobMetaDetails: () => Record<string, unknown>;
-    /**
-     * @returns Job pool details of the current job
-     */
-    getJobpoolDetails: () => Record<string, unknown>;
     /**
      * @returns Capacity attributes of the current job
      */

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

@@ -11,7 +11,6 @@ def handler(job_request, context):
     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_pool_details = job_request.get_job_pool_details() # get the current functions job pool details
     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

package/templates/init.txt

@@ -7,7 +7,8 @@ catalyst.initApp({
 	zaid : "{{__ZAID__}}", //No I18N
 	auth_domain : "{{__AUTH_DOMAIN__}}",
 	is_appsail : "true",
-	api_domain : ""
+	api_domain : "",
+	stratus_domain: "{{_STRATUS_DOMAIN__}}"
 },{
 	org_id: "{{__ORG_ID__}}" //No I18N
 });