@tiledesk/tiledesk-voice-twilio-connector 0.1.27 → 0.2.0-rc3

package/src/services/channels/TiledeskChannel.js

@@ -0,0 +1,269 @@
+const axios = require("axios").default;
+const jwt = require("jsonwebtoken");
+
+const utils = require('../../utils/utils-message.js');
+const { TYPE_MESSAGE, CHANNEL_NAME } = require('../../utils/constants');
+
+const winston = require("../../utils/logger");
+const voiceEventEmitter = require('../voiceEventEmitter');
+
+class TiledeskChannel {
+
+
+  constructor(config) {
+    
+    if (!config) {
+      throw new Error("[TiledeskChannel] config is mandatory");
+    }
+    if (!config.API_URL) {
+      throw new Error("[TiledeskChannel] config.API_URL is mandatory");
+    }
+    if (!config.redis_client) {
+      throw new Error("[TiledeskChannel] config.redis_client is mandatory");
+    }
+      
+    this.log = config.log || false;
+    this.API_URL = config.API_URL;
+    this.redis_client = config.redis_client;
+  }
+  
+
+  async signIn(user_id, settings) {
+    // ani = calling phone number
+
+    winston.debug('[TiledeskChannel] sigIn settings', settings)
+    
+    let payload = {
+      _id: CHANNEL_NAME + '-' + user_id,
+      firstname: user_id,
+      lastname: "",
+      phone: user_id,
+      sub: "userexternal",
+      aud: "https://tiledesk.com/subscriptions/" + settings.subscriptionId,
+    };
+    let customToken = jwt.sign(payload, settings.secret);
+
+    try {
+      const response = await axios({
+        url: this.API_URL + "/auth/signInWithCustomToken",
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: "JWT " + customToken,
+        },
+        data: {},
+        method: "POST",
+      });
+
+      if (!response.data) {
+        return null;
+      }
+      //response.data.token = await this.fixToken(response.data.token);
+      let token = await this.fixToken(response.data.token);
+
+      let data = {
+        token: token,
+        _id: response.data.user._id
+      };
+
+      return data;
+    } catch (err) {
+      winston.error("[TiledeskChannel] sign in error: ", err.response);
+      return null;
+    }
+  }
+  
+  async generateConversation(ani, callId, project_id){
+    return "support-group-" + project_id + "-" + ani + "-" + CHANNEL_NAME + "-" + callId;
+  }
+
+  async getConversation(ani, callId, token, project_id) {
+    let new_request_id = await this.generateConversation(ani, callId, project_id)
+
+    try {
+      const response = await axios({
+        url: this.API_URL + "/" + project_id + "/requests/me?channel=" + CHANNEL_NAME,
+        //url: this.API_URL + "/" + project_id + "/requests/me",
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: token,
+        },
+        method: "GET",
+      });
+
+      let request_id;
+      if (response.data.requests[0]) {
+        request_id = response.data.requests[0].request_id;
+        winston.debug("[TiledeskChannel] use already opened conversation: ", request_id);
+      } else {
+        request_id = new_request_id;
+        winston.debug("[TiledeskChannel] use new conversation: ", request_id);
+      }
+      return request_id;
+    } catch (err) {
+      winston.error("[TiledeskChannel] get requests error: ", err);
+      return null;
+    }
+  }
+  
+  async getDepartments(token, project_id) {
+
+    try {
+      const response = await axios({
+        url: this.API_URL + "/" + project_id + "/departments/allstatus",
+        headers: {
+          'Content-Type': 'application/json',
+          'Authorization': token 
+        },
+        method: 'GET'
+      });
+      winston.debug("[TiledeskChannel] get departments response.data: ", response.data);
+      return response.data;
+    } catch (err) {
+      winston.error("[TiledeskChannel] get departments error");
+      throw err;
+    }
+  }
+
+  async send(tiledeskMessage, token, conversation_id, project_id) {
+
+    try {
+      const response = await axios({
+        url: this.API_URL + `/${project_id}/requests/${conversation_id}/messages`,
+        headers: {
+          'Content-Type': 'application/json',
+          'Authorization': token
+        },
+        data: tiledeskMessage,
+        method: 'POST'
+      });
+      winston.debug("[TiledeskChannel] send message response: ", response.data);
+      return response.data;
+    } catch (err) {
+      winston.error("[TiledeskChannel] send message: ", err.response?.data);
+      return null;
+    }
+
+  }
+  
+  
+  /** ADD MESSAGE TO REDIS QUEUE **/
+  async addMessageToQueue(message){
+    
+    /*SKIP INFO MESSAGES*/
+    if(utils.messageType(TYPE_MESSAGE.INFO, message)){
+       winston.debug("> SKIPPING INFO message: " + JSON.stringify(message) );
+       return false;
+    }
+
+    /*SKIP CURRENT USER MESSAGES*/
+    if (message.sender.indexOf(CHANNEL_NAME) > -1) {
+      winston.debug("> SKIPPING ECHO message: " + JSON.stringify(message) );
+      return false;
+    }
+
+    winston.debug("> SAVE message TO QUEUE: " + JSON.stringify(message) );
+    const conversation_id = message.recipient;
+    const queueKey = `tiledesk:queue:${conversation_id}`;
+    
+    // Use pipeline for atomic push + expire (single round-trip)
+    await this.redis_client
+      .multi()
+      .rPush(queueKey, JSON.stringify(message))
+      .expire(queueKey, 86400)
+      .exec();
+    
+    // Emit event for real-time subscribers
+    voiceEventEmitter.emit(`tiledesk:conversation:${conversation_id}`, message);
+    
+    return true;
+  }
+
+  
+  /** GET MESSAGES FROM REDIS QUEUE LIST **/
+  async getMessagesFromQueue(conversation_id){
+    const queueKey = `tiledesk:queue:${conversation_id}`;
+    const queue = await this.redis_client.lRange(queueKey, 0, -1);
+    
+    if (!queue || queue.length === 0) {
+      return [];
+    }
+    
+    return queue.map(item => JSON.parse(item));
+  }
+
+  /** PUBLISH MESSAGE TO REDIS TOPIC  **/
+  async publishMessageToTopic(message){
+    
+    /*SKIP INFO MESSAGES*/
+    if(utils.messageType(TYPE_MESSAGE.INFO, message)){
+      winston.debug("> SKIPPING INFO message");
+      return;
+    }
+
+    /*SKIP CURRENT USER MESSAGES*/
+    if (message.sender.indexOf("vxml") > -1) {
+      winston.debug("> SKIPPING ECHO message");
+      return;
+    }
+
+    voiceEventEmitter.emit(`tiledesk:conversation:${message.recipient}`, message);
+  }
+
+  /** SUBSCRIBE TO REDIS TOPIC */
+  async subscribeToTopic(conversation_id){
+    const topic = `tiledesk:conversation:${conversation_id}`;
+    // console.log("subscribeToTopic: " + topic);
+
+    return new Promise((resolve, reject) => {
+      voiceEventEmitter.once(topic, (message) => {
+        resolve(message);
+      });
+    });
+  }
+  
+  /** REMOVE MESSAGE FROM REDIS QUEUE LIST (removes first message - FIFO) **/
+  async removeMessageFromQueue(conversation_id, message_id){
+    const queueKey = `tiledesk:queue:${conversation_id}`;
+    // Use lPop for FIFO queue - removes and returns first element
+    await this.redis_client.lPop(queueKey);
+  }
+  
+  /** CLEAR QUEUE FROM REDIS **/
+  async clearQueue(conversation_id){
+    if(conversation_id){
+      await this.redis_client.del(`tiledesk:queue:${conversation_id}`);
+    }
+  }
+  
+  
+  
+  
+  async generateWaitTdMessage(ani, delayTime){
+    
+    
+    return {
+      text: '',
+      senderFullname: ani,
+      attributes: {
+        commands:[
+          { type: 'wait', time: delayTime}
+        ]
+      },
+      channel: { name: CHANNEL_NAME }
+    }
+  }
+  
+  
+  async fixToken(token) {
+    let index = token.lastIndexOf("JWT ");
+    if (index != -1) {
+      let new_token = token.substring(index + 4);
+      return "JWT " + new_token;
+    } else {
+      return "JWT " + token;
+    }
+  }
+  
+}
+
+module.exports = { TiledeskChannel };

package/{tiledesk → src/services/channels}/VoiceChannel.js

@@ -1,12 +1,7 @@
 require('dotenv').config();
-const axios = require("axios").default;
-const jwt = require("jsonwebtoken");
-const { v4: uuidv4 } = require("uuid");
-const { promisify } = require('util');
+const winston = require("../../utils/logger");
 
-const winston = require("../winston");
-
-const voiceEventEmitter = require('./services/voiceEventEmitter');
+const voiceEventEmitter = require('../voiceEventEmitter');
 
 class VoiceChannel {
 
@@ -68,50 +63,23 @@ class VoiceChannel {
   
   /** ADD POOLING DELAY INDEX TO REDIS **/
   async saveDelayIndexForCallId(callId){
-
-    //get value for current callId
-    const index = await this.redis_client.get('tiledesk:voice:'+callId + ':delayIndex');
-    if(index){
-      //increment 
-      const delayIndex = (+index) +1
-      //save new index to redis
-      await this.redis_client.set('tiledesk:voice:'+callId + ':delayIndex', delayIndex, {'EX': 86400});
-      return;
-    }
-    //if index is not present: set to default (0)
-    await this.redis_client.set('tiledesk:voice:'+callId + ':delayIndex', 0, {'EX': 86400});
+    const key = `tiledesk:voice:${callId}:delayIndex`;
+    // Use INCR for atomic increment, initializes to 1 if key doesn't exist
+    await this.redis_client.incr(key);
+    await this.redis_client.expire(key, 86400);
   }
   
   /** RESET INDEX INTO REDIS DATA FOR CURRENT CALLID **/
   async clearDelayTimeForCallId(callId){
-    
-    //get value for current callId
-    const index = await this.redis_client.get('tiledesk:voice:'+callId + ':delayIndex');
-    winston.debug('clearDelayTimeForCallId: index -->'+index)
-    if(index){
-      //set index to default (0)
-      await this.redis_client.set('tiledesk:voice:'+callId + ':delayIndex', 0, {'EX': 86400});
-      return;
-    }
-    //if index is not present: set to default (0)
+    // Always reset to default (0) regardless of current state
     await this.redis_client.set('tiledesk:voice:'+callId + ':delayIndex', 0, {'EX': 86400});
   }
   
   
   async saveSettingsForCallId(attributes, callId){
-    
     winston.debug('[VoiceChannel] saveSettingsForCallId: attributes -->', attributes)
-    
-    const index = await this.redis_client.get('tiledesk:voice:'+callId + ':attributes');
-    winston.debug('[VoiceChannel] saveSettingsForCallId: attributes found -->'+index)
-    if(index){
-      //set index to default (0)
-      await this.redis_client.set('tiledesk:voice:'+callId + ':attributes', JSON.stringify(attributes), {'EX': 86400});
-      return;
-    }
-    //if index is not present: set to default (0)
+    // Always save/overwrite settings
     await this.redis_client.set('tiledesk:voice:'+callId + ':attributes', JSON.stringify(attributes), {'EX': 86400});
-  
   }
   
   
@@ -145,22 +113,15 @@ class VoiceChannel {
 
 
   async deleteCallKeys(callSid) {
-    const pattern = `tiledesk:voice:${callSid}:*`;
-    let cursor = 0;
-
-    do {
-      const reply = await this.redis_client.scan(cursor, {
-        MATCH: pattern,
-        COUNT: 100
-      });
-
-      cursor = reply.cursor;
-      const keys = reply.keys;
-
-      if (keys.length > 0) {
-        await this.redis_client.del(keys);
-      }
-    } while (cursor !== 0);
+    // Use known key patterns instead of SCAN for better performance
+    const keys = [
+      `tiledesk:voice:${callSid}:session`,
+      `tiledesk:voice:${callSid}:attributes`,
+      `tiledesk:voice:${callSid}:delayIndex`
+    ];
+    
+    // Use unlink for non-blocking delete
+    await this.redis_client.unlink(keys);
   }
   
   

package/src/services/clients/TiledeskSubscriptionClient.js

@@ -0,0 +1,78 @@
+const axios = require("axios").default;
+const winston = require('../../utils/logger')
+
+class TiledeskSubscriptionClient {
+
+  /**
+   * Constructor for TiledeskSubscriptionClient
+   *
+   * @example
+   * const { TiledeskSubscriptionClient } = require('tiledesk-subscription-client');
+   * const tdClient = new TiledeskSubscriptionClient({API_URL: tiledeskApiUrl, token: jwt_token, log: log});
+   * @param {Object} config JSON configuration.
+   * @param {string} config.API_URL Mandatory. The Tiledesk api url.
+   * @param {string} config.token Optional. Token required for authentication.
+   * @param {boolean} config.log Optional. If true HTTP requests are logged.
+   */
+  constructor(config) {
+    if (!config) {
+      throw new Error('[TiledeskSubscriptionClient] config is mandatory');
+    }
+
+    if (!config.API_URL) {
+      throw new Error('[TiledeskSubscriptionClient] config.API_URL is mandatory');
+    }
+
+    this.project_id = config.project_id
+    this.API_URL = config.API_URL;
+    this.token = config.token;
+    this.config = config;
+    this.log = false;
+    if (config.log) {
+      this.log = config.log;
+    }
+    
+  }
+
+  async subscribe(subscription_info) {
+    const URL = this.API_URL + `/${this.project_id}/subscriptions`;
+    try {
+      const response = await axios({
+        url: URL,
+        headers: {
+          'Content-Type': 'application/json',
+          'Authorization': this.token
+        },
+        data: subscription_info,
+        method: 'POST'
+      });
+      winston.debug("[TiledeskSubscriptionClient] Subscribed");
+      return response.data;
+    } catch (err) {
+      throw err;
+    }
+  }
+
+  async unsubscribe(subscriptionId) {
+    const URL = this.API_URL + `/${this.project_id}/subscriptions/${subscriptionId}`;
+    try {
+      const response = await axios({
+        url: URL,
+        headers: {
+          'Content-Type': 'application/json',
+          'Authorization': this.token
+        },
+        method: 'DELETE'
+      });
+      winston.debug("[TiledeskSubscriptionClient] Unsubscribed");
+      return response.data;
+    } catch (err) {
+      throw err;
+    }
+  }
+
+
+
+}
+
+module.exports = { TiledeskSubscriptionClient }

package/src/services/index.js

@@ -0,0 +1,45 @@
+/**
+ * Services Index
+ * 
+ * Central export point for all business logic services.
+ * Import from this file to access all services in one place.
+ */
+
+const { SessionService } = require('./SessionService');
+const { MessageService } = require('./MessageService');
+const { SpeechService } = require('./SpeechService');
+const { TwilioService } = require('./TwilioService');
+const { TiledeskMessageBuilder } = require('./TiledeskMessageBuilder');
+
+// Channel services
+const { TiledeskChannel } = require('./channels/TiledeskChannel');
+const { VoiceChannel } = require('./channels/VoiceChannel');
+
+// Translator services
+const { TiledeskTwilioTranslator } = require('./translators/TiledeskTwilioTranslator');
+
+// Integration services
+const { IntegrationService } = require('./IntegrationService');
+const { UploadService } = require('./UploadService');
+const { AiService } = require('./AiService');
+
+module.exports = {
+  // Core business services
+  SessionService,
+  MessageService,
+  SpeechService,
+  TwilioService,
+  TiledeskMessageBuilder,
+
+  // Channel services
+  TiledeskChannel,
+  VoiceChannel,
+
+  // Translator services
+  TiledeskTwilioTranslator,
+
+  // Integration services
+  IntegrationService,
+  UploadService,
+  AiService
+};