All files / lib/recognizer conversation-context.js

100% Statements 9/9
100% Branches 13/13
100% Functions 4/4
100% Lines 9/9

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78                                                                        52x                 65x           56x     9x   5x   4x             1x             1x       42x  
/*
 * Copyright (c) AXA Group Operations Spain S.A.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 
/**
 * Abstract class for a conversation context of a chatbot.
 * The conversation context is the responsible of storing and retrieving
 * the context scope variables based on the current conversation.
 * The getConversationContext receive the session of the chatbot, and must return
 * a promise with the context in the resolve.
 */
class ConversationContext {
  /**
   * Constructor of the class.
   * @param {Object} settings Settings for the instance.
   */
  constructor(settings) {
    this.settings = settings || {};
  }
 
  /**
   * Given a session instance of a chatbot, return the conversation identifier.
   * @param {Object} session Session instance of a message of chatbot.
   * @returns {String} Identifier of the conversation.
   */
  getConversationId(session) {
    if (
      session &&
      session.message &&
      session.message.address &&
      session.message.address.conversation
    ) {
      return session.message.address.conversation.id;
    }
    // eslint-disable-next-line no-underscore-dangle
    if (session && session._activity && session._activity.conversation) {
      // eslint-disable-next-line no-underscore-dangle
      return session._activity.conversation.id;
    }
    return undefined;
  }
 
  /**
   * Given a session, return a promise to resolve the conversation context.
   */
  getConversationContext() {
    throw new Error('This method must be implemented by child');
  }
 
  /**
   * Given a session, return a promise to set the conversation context.
   */
  setConversationContext() {
    throw new Error('This method must be implemented by child');
  }
}
 
module.exports = ConversationContext;