zcatalyst-cli 1.18.0-beta.9 → 1.19.0

package/templates/init/functions/java/integ/cliq/com/handlers/MessageActionHandler.java

@@ -1,25 +1,23 @@
 //$Id$
 package com.handlers;
 
-import java.util.Map;
-
-import com.zc.cliq.enums.RESPONSE_TYPE;
+import com.zc.cliq.enums.MESSAGE_TYPE;
 import com.zc.cliq.objects.Message;
 import com.zc.cliq.requests.MessageActionHandlerRequest;
-import com.zc.cliq.util.ZCCliqUtil;
+import com.zc.cliq.responses.CoreResponse;
 
 public class MessageActionHandler implements com.zc.cliq.interfaces.MessageActionHandler {
 	@Override
-	public Map<String, Object> executionHandler(MessageActionHandlerRequest req) throws Exception {
-		RESPONSE_TYPE msgType = req.getMessage().getType();
+	public CoreResponse executionHandler(MessageActionHandlerRequest req) throws Exception {
+		MESSAGE_TYPE msgType = req.getMessage().getType();
 		String firstName = req.getUser() != null ? req.getUser().getFirstName() : "user";
 
-		String text = "Hey " + firstName + ", You have performed an action on a *" + msgType.getKey() + "*. Manipulate the message variable and perform your own action.";
+		String text = "Hey " + firstName + ", You have performed an action on a *" + msgType.getType() + "*. Manipulate the message variable and perform your own action.";
 
 		Message resp = Message.getInstance();
 		resp.setText(text);
 
-		return ZCCliqUtil.toMap(resp);
+		return resp;
 	}
 
 }

package/templates/init/functions/java/integ/cliq/sample.java

@@ -19,3 +19,13 @@ public class {{_CLASS_}} implements CatalystIntegFunctionHandler {
 		}
 	}
 }
+
+/*
+ * Response type supported by these interface:
+ * 		CoreResponse: BannerResponse,Message,PreviewUrlResponse,Form,VoidResponse
+ * 		FormChangeHandlerResponse: FormChangeHandlerResponse, FormError
+ * 		FormSubmitResponse: BannerResponse,Message,PreviewUrlResponse,Form,FormError,WidgetResponse,WidgetSection,VoidResponse
+ * 		WebhookHandlerResponse: Message,WebhookResponse,VoidResponse
+ * 		WidgetButtonResponse: BannerResponse,PreviewUrlResponse,Form,WidgetResponse,WidgetSection,VoidResponse
+ * 		ButtonFunctionResponse: BannerResponse,Message,PreviewUrlResponse,Form,WidgetResponse,WidgetSection,VoidResponse
+ */

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

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

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

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

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

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

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

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

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

@@ -8,6 +8,7 @@ module.exports = (event, context) => {
         EVENT FUNCTIONALITIES
     */
 	// const DATA = event.getData(); //event data
+	// const RAW_DATA = event.getRawData(): //raw data 
 	// const TIME = event.getTime(); //event occurred time
 
 	// const ACTION = event.getAction(); //(insert | fetch | invoke ...)

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

@@ -24,6 +24,13 @@ export interface EventDetails {
      * @returns event data
      */
     getData: () => Record<string, unknown>;
+    /**
+     * Functional API to get the raw data of the event function execution.
+     * 
+     * Useful when the event is from {@link https://docs.catalyst.zoho.com/en/signals/ Catalyst Signals}
+     * @returns raw event data
+     */
+    getRawData: () => Record<string, unknown>;
     /**
      * Functional API to get the time of the event
      * @returns event time

package/templates/init/functions/node/integ/cliq/handlers/bot-handler.js

@@ -180,6 +180,10 @@ botHandler.participationHandler(async (req, res) => {
     return res;
 });
 
+botHandler.callHandler(async (req, res) => {
+    // Logic for bot call post handling
+});
+
 function comp(var1, var2) {
     return var1.toUpperCase() === var2.toUpperCase();
 }

package/templates/init/functions/node/integ/cliq/handlers/command-handler.js

@@ -51,8 +51,8 @@ command.suggestionHandler(async (req, res) => {
         suggestion3.imageurl = 'https://www.zohowebstatic.com/sites/default/files/styles/product-home-page/public/catalyst-icon.png';
 
         res.push(suggestion1,suggestion2,suggestion3);
-        return res;
     }
+    return res;
 });
 
 function getForm() {
@@ -63,10 +63,8 @@ function getForm() {
     form.button_label = 'Raise Request';
     form.version = 1;
 
-    const actions = form.newFormActionsObject();
-    actions.submit = actions.newFormAction('formFunctionLatest');// ** ENTER YOUR FORM FUNCTION NAME HERE **
-
-    form.actions = actions;
+    const action = form.newFormAction('formFunctionLatest');// ** ENTER YOUR FORM FUNCTION NAME HERE **
+    form.action = action;
 
     const userName = form.newFormInput();
     userName.type = 'text';

package/templates/init/functions/node/integ/cliq/handlers/{installation-validator.js → extension-handler.js}

@@ -1,8 +1,8 @@
-'use strict'
+'use strict';
 import Cliq from 'zcatalyst-integ-cliq';
-const installationValidator = Cliq.installationValidator();
+const extensionHandler = Cliq.extensionHandler();
 
-installationValidator.validateInstallation(async (req, res) => {
+extensionHandler.validateInstallation(async (req, res) => {
     if(comp(req.user.first_name, '**INVALID_USER**') && comp(req.app_info.type, 'upgrade')) {
         res.status = 400;
         res.title = 'Update not allowed !';
@@ -13,6 +13,23 @@ installationValidator.validateInstallation(async (req, res) => {
     return res;
 });
 
+extensionHandler.handleInstallation(async (req, res) => {
+    /* 
+    // Logic for installation post handling
+    *{
+    *
+    *}
+    */
+
+   res.status = 200;
+   return res;
+});
+
+extensionHandler.handleUninstallation(async (req, res) => {
+    
+    // Logic for uninstallation post handling
+});
+
 function comp(var1, var2) {
     return var1.toUpperCase() === var2.toUpperCase();
 }

package/templates/init/functions/node/integ/cliq/handlers/function-handler.js

@@ -218,6 +218,48 @@ functionHandler.formDynamicFieldHandler(async (req, res) => {
     return res;
 });
 
+functionHandler.formViewHandler(async (req, res) => {
+    res.title = 'Asset Request';
+    res.hint = 'Raise your asset request';
+    res.name = 'ID';
+    res.button_label = 'Raise Request';
+    res.version = 1;
+
+    const userName = res.newFormInput();
+    userName.type = 'text';
+    userName.name = 'username';
+    userName.label = 'Name';
+    userName.hint = 'Please enter your name';
+    userName.placeholder = 'John Reese';
+    userName.mandatory = true;
+    userName.value = 'Harold Finch';
+    res.addInputs(userName);
+
+    const email = res.newFormInput();
+    email.type = 'text';
+    email.format = 'email';
+    email.name = 'email';
+    email.label = 'Email';
+    email.hint = 'Enter your email address';
+    email.placeholder = "johnreese@poi.com";
+    email.mandatory = true;
+    email.value = "haroldfinch@samaritan.com";
+    
+    const assetType = res.newFormInput();
+    assetType.type = 'select';
+    assetType.trigger_on_change = true;
+    assetType.name = 'asset-type';
+    assetType.label = "Asset Type";
+    assetType.hint = "Choose your request asset type";
+    assetType.placeholder = "Mobile";
+    assetType.mandatory = true;   
+    assetType.addOption(assetType.newFormValue('Laptop', 'laptop'));
+    assetType.addOption(assetType.newFormValue('Mobile', 'mobile'));
+    
+    res.addInputs(email, assetType);
+    return res;
+});
+
 functionHandler.widgetButtonHandler(async (req, res) => {
     const id = req.target.id;
     switch(id) {

package/templates/init/functions/node/integ/cliq/handlers/link-preview-handler.js

@@ -0,0 +1,73 @@
+'use strict';
+import Cliq from 'zcatalyst-integ-cliq';
+const linkPreviewHandler = Cliq.linkPreviewHandler();
+
+linkPreviewHandler.previewHandler(async (req, res) => {
+    res.title = 'Release checklist | Zoho Cliq';
+    res.type = 'link';
+    res.provider_url = 'https://www.zoho.com/cliq/';
+    res.description = 'Release checklist for Cliq 5.0 (Focused on Enterprise and Intelligence)';
+    res.dynamic_actions = true;
+
+    let fields = res.newOembedFields();
+    let fieldsData = [];
+    fieldsData.push(fields.newOembedFieldData('Created By','Scott fisher'));
+    fieldsData.push(fields.newOembedFieldData('Created On', '10 Aug, 2023'));
+    fieldsData.push(fields.newOembedFieldData('Last Modified On', '11 Aug, 2023'));
+    fieldsData.push(fields.newOembedFieldData('Tags', '#unfurling_via_extensions #images_and_cards #cliq_360 #Cliq_5.0'));
+    fields.data = fieldsData;
+    res.fields = fields;
+
+    let actions = [];
+    const action = res.newOembedActions();
+    action.type = 'button';
+    action.label = 'Add Comment';
+    const confirm = action.newConfirm();
+    confirm.title = 'Comment';
+    confirm.description = 'Add your comment to the notes';
+    confirm.input = 'Type here...';
+    action.confirm = confirm;
+    let params = {'action': 'add_comment'};
+    action.params = params;
+    actions.push(action);
+    res.actions = actions;
+
+    return res;
+});
+
+linkPreviewHandler.actionHandler(async (req, res) => {
+    const action = req.target.params.action;
+    let text;
+    if(action === "add_comment")
+	{
+		text = "Your comment has been added successfully";
+	}
+	else if(action === "delete_note")
+	{
+		text = "Release checklist | Zoho Cliq note has been deleted";
+	}
+	else if(action === "mark_as_favorite")
+	{
+		text = "Release checklist | Zoho Cliq note has been marked as favorite";
+	}
+    return res.newBanner(text,'success');
+});
+
+linkPreviewHandler.menuHandler(async (req, res) => {
+		
+    let action1 = linkPreviewHandler.newOembedActions('button');
+    action1.label = 'Delete';
+    action1.params = {'action': 'delete_note'};
+    res.push(action1);
+
+    let action2 = linkPreviewHandler.newOembedActions('button');
+    action2.label = 'Mark as Favorite';
+    action2.params = {'action': 'mark_as_favorite'};
+    res.push(action2);
+
+    return res;
+});
+
+linkPreviewHandler.afterSendHandler(async (req, res) => {
+    return res.newBanner('Release checklist | Zoho Cliq 5.0','success');
+});

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

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

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

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

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

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

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

@@ -7,12 +7,16 @@ def handler(event, context):
 
     '''Event Functionalities'''
     data = event.get_data()  # event data
+    raw_data = event.get_raw_data() # raw event data
     time = event.get_time()  # event occurred time
-    action = event.get_action()
-    source_details = event.get_source()
-    source_entity_id = event.get_source_entity_id()
-    event_bus_details = event.get_event_bus_details()
-    project_details = event.get_project_details()
+    action = event.get_action() # get event action
+    source_details = event.get_source() # get event source
+    source_entity_id = event.get_source_entity_id() # get the source entity id
+    event_bus_details = event.get_event_bus_details() # get event bus details
+    project_details = event.get_project_details() # get project details
+
+    logging.info('event data: ' + str(data))
+    logging.info('raw data: ' + str(raw_data))
 
     '''Context Functionalities'''
     # remaining_execution_time_ms = context.get_remaining_execution_time_ms()

package/templates/init/functions/python/integ/cliq/handlers/bot_handler.py

@@ -1,4 +1,6 @@
 import json
+import logging
+
 from zcatalyst_cliq.bot_handler import (
     welcome_handler,
     message_handler,
@@ -7,6 +9,7 @@ from zcatalyst_cliq.bot_handler import (
     menu_action_handler,
     webhook_handler,
     participation_handler,
+    call_handler,
     BotWelcomeHandlerRequest,
     BotMessageHandlerRequest,
     BotContextHandlerRequest,
@@ -14,10 +17,12 @@ from zcatalyst_cliq.bot_handler import (
     BotMenuActionHandlerRequest,
     BotParticipationHandlerRequest,
     BotWebHookHandlerRequest,
-    HandlerResponse
+    HandlerResponse, 
+    BotCallHandlerRequest
 )
-from zcatalyst_sdk.catalyst_app import CatalystApp
-import logging
+from zcatalyst_cliq.response_types import VoidResponse
+from zcatalyst_sdk import CatalystApp
+
 
 @welcome_handler
 def welcome_handler_fn(req: BotWelcomeHandlerRequest, res: HandlerResponse, *args):
@@ -172,3 +177,8 @@ def webhook_fn(req: BotWebHookHandlerRequest, res: HandlerResponse, *args):
     res.add_slides(gif_slide)
 
     return res
+
+@call_handler
+def call(req: BotCallHandlerRequest, res:VoidResponse):
+    # Logic for bot call post handling
+    return res

package/templates/init/functions/python/integ/cliq/handlers/command_handler.py

@@ -1,4 +1,5 @@
 from typing import List
+
 import zcatalyst_cliq.command_handler as command
 from zcatalyst_cliq.command_handler import (
     execution_handler,
@@ -12,7 +13,7 @@ from zcatalyst_cliq.command_handler import (
 def executor(req: CommandHandlerRequest, res: HandlerResponse, *args):
     text = ''
     cmd = req.name
-    if cmd == 'catalyst':
+    if cmd == 'catalystresource':
         suggestions = req.selections
         if not suggestions:
             text = 'Please select a suggestion from the command'
@@ -24,7 +25,7 @@ def executor(req: CommandHandlerRequest, res: HandlerResponse, *args):
                 text = prefix + '[CLI Documentation](https://www.zoho.com/catalyst/help/cli-command-reference.html)'
             else:
                 text = prefix + '[help documentation](https://www.zoho.com/catalyst/help/)'
-    elif cmd == 'raisereq':
+    elif cmd == 'getform':
         return get_form()
     else:
         text = 'Command executed successfully!'
@@ -34,7 +35,7 @@ def executor(req: CommandHandlerRequest, res: HandlerResponse, *args):
 
 @suggestion_handler
 def suggester(req: CommandHandlerRequest, res: List[CommandSuggestion], *args):
-    if req.name == 'catalyst':
+    if req.name == 'catalystresource':
         suggestion1 = command.new_command_suggestion()
         suggestion1.title = 'API doc'
         suggestion1.description = 'Catalyst API documentation'
@@ -52,6 +53,7 @@ def suggester(req: CommandHandlerRequest, res: List[CommandSuggestion], *args):
 
         res.extend([suggestion1,suggestion2,suggestion3])
         return res
+    return [command.new_command_suggestion()]
 
 
 def get_form():
@@ -62,10 +64,8 @@ def get_form():
     form.button_label = 'Raise Request'
     form.version = 1
 
-    actions = form.new_form_actions_obj()
-    actions.submit = actions.new_form_action('PyFnForm')  # ENTER YOUR FORM FUNCTION NAME HERE
-
-    form.actions = actions
+    action = form.new_form_action('formFunctionLatest') # ENTER YOUR FORM FUNCTION NAME HERE
+    form.action = action
 
     user_name = form.new_form_input()
     user_name.type = 'text'

package/templates/init/functions/python/integ/cliq/handlers/extension_handler.py

@@ -0,0 +1,25 @@
+from zcatalyst_cliq.extension_handler import validate_installation, ExtensionHandlerRequest, handle_installation, \
+    handle_uninstallation
+from zcatalyst_cliq.response_types import InstallationResponse, VoidResponse
+
+
+@validate_installation
+def validate_installation(req: ExtensionHandlerRequest,res: InstallationResponse, *args):
+    if req.user.first_name == '**INVALID_USER**' and req.app_info.type == 'upgrade':
+        res.status = 400
+        res.title = 'Update not allowed !'
+        res.message = 'Sorry. Update not allowed for the current app. Please contact admin.'
+    else:
+        res.status = 200
+    return res
+
+@handle_installation
+def installation_handler(req: ExtensionHandlerRequest, res: InstallationResponse, *args):
+    '''Logic for installation post handling'''
+    res.status = 200
+    return res
+
+@handle_uninstallation
+def handle_uninstallation(req: ExtensionHandlerRequest, res: VoidResponse, *args):
+    # Logic for uninstallation post handling
+    return res

package/templates/init/functions/python/integ/cliq/handlers/function_handler.py

@@ -1,4 +1,5 @@
 from datetime import datetime
+
 from zcatalyst_cliq import function_handler
 from zcatalyst_cliq.function_handler import (
     button_function_handler,
@@ -12,8 +13,10 @@ from zcatalyst_cliq.function_handler import (
     HandlerResponse,
     FormChangeResponse,
     FormDynamicFieldResponse,
-    WidgetResponse
+    WidgetResponse,
+    form_view_handler
 )
+from zcatalyst_cliq.response_types import Form
 
 
 @button_function_handler
@@ -221,6 +224,47 @@ def handle_dynamic_field(req: FormFunctionRequest, res: FormDynamicFieldResponse
                 res.add_options(res.new_form_value(mobile,mobile.lower().replace(' ','_')))
     return res
 
+@form_view_handler
+def form_view_handler(req: FormFunctionRequest, res: Form):
+    res.title = 'Asset Request'
+    res.hint = 'Raise your asset request'
+    res.name = 'ID'
+    res.button_label = 'Raise Request'
+    res.version = 1
+
+    user_name = res.new_form_input()
+    user_name.type = 'text'
+    user_name.name = 'username'
+    user_name.label = 'Name'
+    user_name.hint = 'Please enter your name'
+    user_name.placeholder = 'John Reese'
+    user_name.mandatory = True
+    user_name.value = 'Harold Finch'
+    res.add_inputs(user_name)
+
+    email = res.new_form_input()
+    email.type = 'text'
+    email.format = 'email'
+    email.name = 'email'
+    email.label = 'Email'
+    email.hint = 'Enter your email address'
+    email.placeholder = "johnreese@poi.com"
+    email.mandatory = True
+    email.value = "haroldfinch@samaritan.com"
+
+    asset_type = res.new_form_input()
+    asset_type.type = 'select'
+    asset_type.trigger_on_change = True
+    asset_type.name = 'asset_type'
+    asset_type.label = "Asset Type"
+    asset_type.hint = "Choose your request asset type"
+    asset_type.placeholder = "Mobile"
+    asset_type.mandatory = True
+    asset_type.add_options(asset_type.new_form_value('Laptop', 'laptop'))
+    asset_type.add_options(asset_type.new_form_value('Mobile', 'mobile'))
+
+    res.add_inputs(email, asset_type)
+    return res
 
 @widget_button_handler
 def widget_button(req: WidgetFunctionRequest, res: WidgetResponse, *args):
@@ -274,7 +318,7 @@ def widget_button(req: WidgetFunctionRequest, res: WidgetResponse, *args):
         input2.value = id
 
         form.add_inputs(input1, input2)
-        form.action = form.new_form_action('PyFnForm') # ** ENTER YOUR FORM FUNCTION NAME HERE **
+        form.action = form.new_form_action('appletForm') # ** ENTER YOUR FORM FUNCTION NAME HERE **
         return form
 
     elif id == 'breadcrumbs':
@@ -293,7 +337,7 @@ def widget_button(req: WidgetFunctionRequest, res: WidgetResponse, *args):
         first_nav = {
             'label': 'Page : ' + page,
             'type': 'invoke.function',
-            'name': 'PyFnWidgetButton',
+            'name': 'appletFunction',
             'id': 'breadcrumbs'
         }
 
@@ -306,7 +350,7 @@ def widget_button(req: WidgetFunctionRequest, res: WidgetResponse, *args):
         banner_button = {
             'label': 'Banner',
             'type': 'invoke.function',
-            'name': 'PyFnWidgetButton',
+            'name': 'appletFunction',
             'id': 'banner'
         }
 
@@ -352,7 +396,7 @@ def get_button_section():
     button2 = button_element1.new_widget_button()
     button2.label = 'Banner'
     button2.type = 'invoke.function'
-    button2.name = 'PyFnWidgetButton'
+    button2.name = 'appletFunction'
     button2.id = 'banner'
 
     button3 = button_element1.new_widget_button()
@@ -374,31 +418,31 @@ def get_button_section():
     button5 = button_element2.new_widget_button()
     button5.label = 'Edit Section'
     button5.type = 'invoke.function'
-    button5.name = 'PyFnWidgetButton'
+    button5.name = 'appletFunction'
     button5.id = 'section'
 
     button6 = button_element2.new_widget_button()
     button6.label = 'Form Edit Section'
     button6.type = 'invoke.function'
-    button6.name = 'PyFnWidgetButton'
+    button6.name = 'appletFunction'
     button6.id = 'formsection'
 
     button7 = button_element2.new_widget_button()
     button7.label = 'Banner'
     button7.type = 'invoke.function'
-    button7.name = 'PyFnWidgetButton'
+    button7.name = 'appletFunction'
     button7.id = 'banner'
 
     button8 = button_element2.new_widget_button()
     button8.label = 'Edit Whole Tab'
     button8.type = 'invoke.function'
-    button8.name = 'PyFnWidgetButton'
+    button8.name = 'appletFunction'
     button8.id = 'tab'
 
     button9 = button_element2.new_widget_button()
     button9.label = 'Form Edit Tab'
     button9.type = 'invoke.function'
-    button9.name = 'PyFnWidgetButton'
+    button9.name = 'appletFunction'
     button9.id = 'formTab'
 
     button_element2.add_widget_buttons(button5, button6, button7, button8, button9)