New release 2.6.8 (#46)

New version 2.6.8: Fixed doc error on casting of message payload Added data query context methods for upcoming ODA version 23.08
oracle · Jul 25, 2023 · 3148e06 · 3148e06
1 parent bbe81e4
commit 3148e06
Show file tree

Hide file tree

Showing 14 changed files with 179 additions and 145 deletions.
diff --git a/MESSAGE_FACTORY.md b/MESSAGE_FACTORY.md
@@ -406,11 +406,11 @@ When using TypeScript, you can cast to the proper message subclass to get design
 if (context.getRequest().state === context.getRequest().previousState) {
   const um = context.getUserMessage();
   if (um instanceof TextMessage) {
-    const utm = um as typeof TextMessage;
+    const utm = um as TextMessage;
     const text = utm.getText();
     // handle text    
   } else if (um instanceof PostbackMessage) {
-    const upm = um as typeof PostbackMessage;
+    const upm = um as PostbackMessage;
     const postback = upm.getPostback();
     // handle postback payload      
     ...

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,5 +1,6 @@
 # Release Notes
 
+- [Version 2.6.8](#v268)
 - [Version 2.6.7](#v267)
 - [Version 2.6.6](#v266)
 - [Version 2.6.5](#v265)
@@ -17,6 +18,13 @@
 - [Version 2.4.3](#v243)
 - [Version 2.4.2](#v242)
 
+## Version 2.6.8 <a name="v268">
+
+### Fixed Issues
+
+- Documentation fixes
+- Fixed issue in baseContext.translate method for TypeScript.
+
 ## Version 2.6.7 <a name="v267">
 
 ### New Features

diff --git a/bin/templates/components/dataqueryeventhandler/template.js b/bin/templates/components/dataqueryeventhandler/template.js
diff --git a/bin/templates/components/dataqueryeventhandler/template.ts b/bin/templates/components/dataqueryeventhandler/template.ts
diff --git a/lib/dataquery/dataQueryContext.js b/lib/dataquery/dataQueryContext.js
@@ -176,6 +176,44 @@ class DataQueryContext extends BaseContext {
     return this.getVariable('system.isFollowupResponse');
   }
 
+  /**
+   * The end flow  action that is set that can be used to transition to a different flow by defining a mapping for this action in the main flow.
+   * @param {string} action - the end flow action that can be used to transition in the main flow
+   */
+  setEndFlowAction(action) {
+    this.setVariable('system.sqlDialog.endFlowAction', action);
+    this.getResponse().transitionAction = 'system.sqlDialog.endFlow';
+  }
+
+  /**
+   * Creates a postback action that ends the flow with the specified end flow action.
+   * @param {string} the label of the postback button 
+   * @param {string} action - the end flow action that can be used to transition in the main flow
+   */
+  createEndFlowPostbackAction(label, action) {
+    const mf = this.getMessageFactory();
+    return mf.createPostbackAction(label, {'action': 'system.sqlDialog.endFlow', 'variables': {'system.sqlDialog.endFlowAction': action}});
+  }
+
+  /**
+   * Invoke another flow
+   * @param {string} flowName - name of the flow to invoke
+   */
+  invokeFlow(flowName) {
+    this.setVariable('system.sqlDialog.invokeFlowName', flowName);
+    this.getResponse().transitionAction = 'system.sqlDialog.invokeFlow';
+  }
+
+  /**
+   * Creates a postback action that invokes the specified flow.
+   * @param {string} the label of the postback button 
+   * @param {string} flowName - name of the flow to invoke
+   */
+  createInvokeFlowPostbackAction(label, flowName) {
+    const mf = this.getMessageFactory();
+    return mf.createPostbackAction(label, {'action': 'system.sqlDialog.invokeFlow', 'variables': {'system.sqlDialog.invokeFlowName': flowName}});
+  }
+
 }
 
 module.exports = { DataQueryContext }
diff --git a/lib/restservice/restServiceContext.js b/lib/restservice/restServiceContext.js
@@ -79,6 +79,36 @@ class RestServiceContext extends BaseContext {
     this.getResponse().responsePayload = payload;
   }
 
+  /**
+   * Adds a message to the bot response sent to the user.
+   * NOTE: This method can only be used in the validateResponsePayload handler
+   * @param {object} payload - can take a string message, or a message created using the MessageFactory
+   */
+  addMessage(payload) {
+    this.getResponse().messages = this.getResponse().messages || [];
+    this.getResponse().messages.push(super.constructMessagePayload(payload));
+  }
+
+  /**
+   * Set a transition action. When you use this function, the dialog engine will transition to the state defined for this transition action.
+   * <p>
+   * NOTE: This method can only be used in the validateResponsePayload handler
+   * @param {string} action - name of the transition action
+   */
+  setTransitionAction(action) {
+    this.getResponse().transitionAction = action;
+  }
+
+  /**
+   * Sets an LLM prompt that will be sent to the LLM
+   * <p>
+   * NOTE: This method can only be used in the validateResponsePayload handler
+   * @param {string} prompt - the text of the prompt
+   */
+  setLLMPrompt(prompt) {
+    this.getResponse().llmPrompt = prompt;
+  }
+
 }
 
 module.exports = { RestServiceContext }
diff --git a/lib/restservice/utils.js b/lib/restservice/utils.js
@@ -16,22 +16,27 @@ async function invokeRestServiceEventHandlers(component, context) {
     // event handlers can be async (returning a promise), but we dont want to enforce
     // every event handler is async, hence Promise.resolve wrapping of invocation
     if (eventName === `transformRequestPayload`) {
-      let payload = context.getRequestPayload();
-      event.properties = {'payload': payload};
       logger.debug(`Invoking event handler ${eventName}`);
       let returnValue = await Promise.resolve(handler(event.properties, context));
       if (returnValue) {
         context.setRequestPayload(returnValue);
       }
     } else if (eventName === `transformResponsePayload` || eventName === `transformErrorResponsePayload`) {
-      let payload = context.getResponsePayload();
-      event.properties = {'payload': payload};
       logger.debug(`Invoking event handler ${eventName}`);
       let returnValue = await Promise.resolve(handler(event.properties, context));
       if (returnValue) {
         context.setResponsePayload(returnValue);
       }
+    } else if (eventName === `validateResponsePayload`) {
+      logger.debug(`Invoking event handler ${eventName}`);
+      let returnValue = await Promise.resolve(handler(event.properties, context));
+      // make sure return value is a boolean
+      let retValue = returnValue === undefined ? true : (returnValue + '' === 'true')
+      logger.debug(`${eventName} returned ${retValue}`);
+      context.getResponse().valid = retValue;
     }
+
+
   } else {
     logger.debug(`No handler found for event: ${eventName}`);
   }              

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@oracle/bots-node-sdk",
-  "version": "2.6.7",
+  "version": "2.6.8",
   "description": "Oracle Digital Assistant SDK for custom component development and webhook integrations",
   "main": "index.js",
   "browser": "index-browser.js",

diff --git a/ts/lib/component/baseContext.ts b/ts/lib/component/baseContext.ts
@@ -360,10 +360,10 @@ export abstract class BaseContext {
    */
   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 + '\'';
+    let exp = '${rb("' + rbKey + '"';
     for (let arg of rbArgs) {
       // MIECS-38051: only string args should be enclosed in quotes
-      typeof arg === 'string' ? exp += ',\'' + arg + '\'' : exp += ',' + arg;
+      typeof arg === 'string' ? exp += ',"' + arg + '"' : exp += ',' + arg;
     }
     exp += ')}';
     return exp;

diff --git a/ts/lib/dataquery/dataQueryContext.ts b/ts/lib/dataquery/dataQueryContext.ts
@@ -179,4 +179,43 @@ export class DataQueryContext extends BaseContext {
     return this.getVariable('system.isFollowupResponse');
   }
 
+  /**
+   * The end flow  action that is set that can be used to transition to a different flow by defining a mapping for this action in the
+   * main flow.
+   * @param {string} action - the end flow action that can be used to transition in the main flow
+   */
+  setEndFlowAction(action: string): void {
+    this.setVariable('system.sqlDialog.endFlowAction', action);
+    this.getResponse().transitionAction = 'system.sqlDialog.endFlow';
+  }
+
+  /**
+   * Creates a postback action that ends the flow with the specified end flow action.
+   * @param {string} the label of the postback button
+   * @param {string} action - the end flow action that can be used to transition in the main flow
+   */
+  createEndFlowPostbackAction(label: string, action: string): PostbackAction {
+    const mf = this.getMessageFactory();
+    return mf.createPostbackAction(label, {'action': 'system.sqlDialog.endFlow', 'variables': {'system.sqlDialog.endFlowAction': action}});
+  }
+
+  /**
+   * Invoke another flow
+   * @param {string} flowName - name of the flow to invoke
+   */
+  invokeFlow(flowName: string): void {
+    this.setVariable('system.sqlDialog.invokeFlowName', flowName);
+    this.getResponse().transitionAction = 'system.sqlDialog.invokeFlow';
+  }
+
+  /**
+   * Creates a postback action that invokes the specified flow.
+   * @param {string} the label of the postback button
+   * @param {string} flowName - name of the flow to invoke
+   */
+  createInvokeFlowPostbackAction(label, flowName): PostbackAction {
+    const mf = this.getMessageFactory();
+    return mf.createPostbackAction(label, {'action': 'system.sqlDialog.invokeFlow',
+      'variables': {'system.sqlDialog.invokeFlowName': flowName}});
+  }
 }