- moved translate function from entityResolutionContext to baseContext

- added function getChannelType to baseContext
- added function addGlobalAction to message model

Author: stevendavelaar

MESSAGE_MODEL.md

@@ -96,7 +96,7 @@ const messageModel = context.getMessageModel();
 let keywords = [];
 keywords.push( messageModel.postbackKeyword(["1","first"], {"variables" : {"pizzaSize": "small"}}));
 keywords.push( messageModel.postbackKeyword(["2","second"], {"variables" : {"pizzaSize": "medium"}}));
-keywords.push( messageModel.postbackKeyword(["1","third"], {"variables" : {"pizzaSize": "large"}}));
+keywords.push( messageModel.postbackKeyword(["3","third"], {"variables" : {"pizzaSize": "large"}}));
 let textMessage = messageModel.textConversationMessage('What pizza size do you want?\n1. Small\n2. Medium\n3. Large', undefined, undefined, undefined, keywords);
 context.reply(textMessage);
 ```
@@ -180,7 +180,7 @@ module.exports = {
     name: 'orderConfirmation'
   }),
   invoke: (context, done) => {
-    if (context.getRequest().message.channelConversation.type ==='msteams') {
+    if (context.getChannelType() === 'msteams') {
       context.reply(context.getMessageModel().rawConversationMessage(card));
      } else {
       context.reply('Thank you for ordering a PEPPERONI piza, have a nice day!');
@@ -190,7 +190,7 @@ module.exports = {
   }
 };
 ```
-Because the skill might use multiple channels, only send the adaptve card for the `msteams` channel. 
+Because the skill might use multiple channels, we only send the adaptive card for the `msteams` channel. 
 The actual adaptive card payload is defined in `card.json`, which looks like this:
 
 ```javascript

RELEASE_NOTES.md

@@ -1,5 +1,6 @@
 # Release Notes
 
+- [Version 2.5.5](#v255)
 - [Version 2.5.4](#v254)
 - [Version 2.5.3](#v253)
 - [Version 2.5.2](#v252)
@@ -8,6 +9,14 @@
 - [Version 2.4.3](#v243)
 - [Version 2.4.2](#v242)
 
+## Version 2.5.5 <a name="v255">
+
+### New Features
+
+- **Support for resource bundles in custom components**: The `context.translate` function that was already available for entity event handlers, can now be used with custom components as well. The function takes a resource bundle key and optionally a list of sustitution variables. Note that use of this function requires digital assistant version 21.06 or higher.
+- **Convenience method to get channel type**: A new function `context.getChannelType` has been added for both custom components and entity event handler.
+- **Convenience method to add a global action**: A new function `messageModel.addGlobalAction` has been added to the message model. This method adds a single globl action without removing any existing global actions.
+
 ## Version 2.5.4 <a name="v254">
 
 ### Fixed Issues

lib/component/baseContext.js

@@ -174,6 +174,27 @@ class BaseContext {
     return this.variable(name,value);
   }
 
+  /**
+   * Get translated string using a resource bundle key defined in the skill.
+   * @return {string} resource bundle freemarker expression that will be resolved when event handler or custom component response is 
+   * received by dialog engine
+   * @param {string} rbKey - key of the resource bundle entry defined with the skill that should be used to translate
+   * @param {string} rbArgs - substitution variables
+   */
+  translate(rbKey, ...rbArgs) {
+    // create freemarker expression that will be resolved in runtime after event handler or custom component response is received
+    let exp = "${rb('"+rbKey+"','"+rbArgs.join('\',\'')+"')}";
+    return exp;
+  }  
+
+  /**
+   * Return the channel conversation type
+   * @return {string} the channel type
+   */
+  getChannelType() {
+    return this.getRequest().message.channelConversation.type;
+  }
+
   /**
    * Returns the MessageModel class for creating or validating messages to or from bots.
    * @see MessageModel.js

lib/entity/entityResolutionContext.js

@@ -398,19 +398,6 @@ class EntityResolutionContext extends BaseContext {
     this.getResponse().cancel = true;
   }
 
-  /**
-   * Get translated string using a resource bundle key defined in the skill.
-   * IMPORTANT: for this method to work the resource bundle must be defined as a context variable in the dialog flow using the name 'rb'. 
-   * @return {string} resource bundle freemarker expression that will be resolved when event handler response is received by dialog engine
-   * @param {string} rbKey - key of the resource bundle entry defined with the skill that should be used to translate
-   * @param {string} rbArgs - substitution variables
-   */
-  translate(rbKey, ...rbArgs) {
-    // create freemarker expression that will be resolved in runtime after event handler response is received
-    let exp = "${rb('"+rbKey+"','"+rbArgs.join('\',\'')+"')}";
-    return exp;
-  }  
-
   /**
    * Sets the value of a custom property that is stored in the entity resolution context. A custom property can be 
    * used to maintain custom state accross event handler calls while resolving the composite bag entity. 

lib/message/messageModel.js

@@ -418,7 +418,7 @@ class MessageModel {
   }
 
   /**
-   * Static method to add global actions to a payload object.
+   * Static method to add global actions to a message payload object. This method replaces any existing global actions.
    * @return {object} A ConversationMessage with global actions.
    * @param {object} message - The message to add global actions to.
    * @param {object} globalActions - The global actions to be added.
@@ -430,6 +430,19 @@ class MessageModel {
     return message;
   }
 
+  /**
+   * Static method to add a global action to a message payload object. 
+   * @return {object} A ConversationMessage with global actions.
+   * @param {object} message - The message to add the global action to.
+   * @param {object} globalAction - The global action to be added.
+   */
+  static addGlobalAction(message, globalAction) {
+    let globalActions = message.globalActions || [];
+    globalActions.push(globalAction);
+    message.globalActions = globalActions;
+    return message;
+  }
+
   /**
    * Static method to validate a common ConversationMessage
    * @return {boolean|object} true if valid; return Validation Error object (error & value) if invalid

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@oracle/bots-node-sdk",
-  "version": "2.5.4",
+  "version": "2.5.5",
   "description": "Oracle Bots SDK for custom component development and webhook integrations",
   "main": "index.js",
   "browser": "index-browser.js",

package.json

@@ -180,6 +180,27 @@ export abstract class BaseContext {
     return this.variable(name, value);
   }
 
+  /**
+   * Get translated string using a resource bundle key defined in the skill.
+   * @return {string} resource bundle freemarker expression that will be resolved when event handler or custom component response is 
+   * received by dialog engine
+   * @param {string} rbKey - key of the resource bundle entry defined with the skill that should be used to translate
+   * @param {string} rbArgs - substitution variables
+   */
+  translate(rbKey: string, ...rbArgs: string[]) {
+    // create freemarker expression that will be resolved in runtime after event handler or custom component response is received
+    let exp = '${rb(\'' + rbKey + '\',\'' + rbArgs.join('\', \'') + '\')}';
+    return exp;
+  }
+
+  /**
+   * Return the channel conversation type
+   * @return {string} the channel type
+   */
+  getChannelType(): string {
+    return this.getRequest().message.channelConversation.type;
+  }
+
   /**
    * Returns the MessageModel class for creating or validating messages to or from bots.
    * @see MessageModel.js

ts/lib/component/baseContext.ts

@@ -439,19 +439,6 @@ export class EntityResolutionContext extends BaseContext {
     this.getResponse().cancel = true;
   }
 
-  /**
-   * Get translated string using a resource bundle key defined in the skill.
-   * IMPORTANT: for this method to work the resource bundle must be defined as a context variable in the dialog flow using the name 'rb'.
-   * @return {string} resource bundle freemarker expression that will be resolved when event handler response is received by dialog engine
-   * @param {string} rbKey - key of the resource bundle entry defined with the skill that should be used to translate
-   * @param {string} rbArgs - substitution variables
-   */
-  translate(rbKey: string, ...rbArgs: string[]) {
-    // create freemarker expression that will be resolved in runtime after event handler response is received
-    let exp = '${rb(\'' + rbKey + '\',\'' + rbArgs.join('\', \'') + '\')}';
-    return exp;
-  }
-
   /**
    * Sets the value of a custom property that is stored in the entity resolution context. A custom property can be
    * used to maintain custom state accross event handler calls while resolving the composite bag entity.

ts/lib/entity/entityResolutionContext.ts

@@ -416,7 +416,7 @@ export class MessageModel {
   }
 
   /**
-   * Static utility method to add global actions to a payload
+   * Static method to add global actions to a message payload object. This method replaces any existing global actions.
    * @return A ConversationMessage with global actions.
    * @param message - The message to add global actions to.
    * @param globalActions - The global actions to be added.
@@ -428,6 +428,19 @@ export class MessageModel {
     return message;
   }
 
+  /**
+   * Static method to add a global action to a message payload object. 
+   * @return A ConversationMessage with global actions.
+   * @param message - The message to add the global action to.
+   * @param globalAction - The global action to be added.
+   */
+  static addGlobalAction(message: NonRawMessagePayload, globalAction: Action): NonRawMessagePayload {
+    let globalActions = message.globalActions || [];
+    globalActions.push(globalAction);
+    message.globalActions = globalActions;
+    return message;
+  }
+
   /**
    * Static utility method to validate a common ConversationMessage
    * @return true if valid; return Validation Error object (error & value) if invalid