@app-connect/core 1.7.0-beta.4 → 1.7.0-beta.6

package/handlers/disposition.js

@@ -5,7 +5,7 @@ const { UserModel } = require('../models/userModel');
 const oauth = require('../lib/oauth');
 // const userCore = require('../handlers/user');
 const errorMessage = require('../lib/generalErrorMessage');
-const adapterRegistry = require('../adapter/registry');
+const connectorRegistry = require('../connector/registry');
 
 async function upsertCallDisposition({ platform, userId, sessionId, dispositions, additionalSubmission, userSettings }) {
     try {
@@ -35,7 +35,7 @@ async function upsertCallDisposition({ platform, userId, sessionId, dispositions
                 }
             }
         }
-        const platformModule = adapterRegistry.getAdapter(platform);
+        const platformModule = connectorRegistry.getConnector(platform);
         const authType = platformModule.getAuthType();
         let authHeader = '';
         switch (authType) {
@@ -126,7 +126,7 @@ async function upsertCallDisposition({ platform, userId, sessionId, dispositions
 //                 }
 //             }
 //         }
-//         const platformModule = adapterRegistry.getAdapter(platform);
+//         const platformModule = connectorRegistry.getConnector(platform);
 //         const authType = platformModule.getAuthType();
 //         let authHeader = '';
 //         switch (authType) {

package/handlers/log.js

@@ -4,8 +4,8 @@ const { MessageLogModel } = require('../models/messageLogModel');
 const { UserModel } = require('../models/userModel');
 const oauth = require('../lib/oauth');
 const errorMessage = require('../lib/generalErrorMessage');
-const { composeCallLog, getLogFormatType } = require('../lib/callLogComposer');
-const adapterRegistry = require('../adapter/registry');
+const { composeCallLog } = require('../lib/callLogComposer');
+const connectorRegistry = require('../connector/registry');
 const { LOG_DETAILS_FORMAT_TYPE } = require('../lib/constants');
 const { NoteCache } = require('../models/dynamo/noteCacheSchema');
 const moment = require('moment');
@@ -39,7 +39,7 @@ async function createCallLog({ platform, userId, incomingData, hashedAccountId,
                 }
             };
         }
-        const platformModule = adapterRegistry.getAdapter(platform);
+        const platformModule = connectorRegistry.getConnector(platform);
         const callLog = incomingData.logInfo;
         const additionalSubmission = incomingData.additionalSubmission;
         let note = incomingData.note;
@@ -84,7 +84,7 @@ async function createCallLog({ platform, userId, incomingData, hashedAccountId,
         };
 
         // Compose call log details centrally
-        const logFormat = getLogFormatType(platform);
+        const logFormat = platformModule.platformModule ? platformModule.getLogFormatType(platform) : LOG_DETAILS_FORMAT_TYPE.PLAIN_TEXT;
         let composedLogDetails = '';
         if (logFormat === LOG_DETAILS_FORMAT_TYPE.PLAIN_TEXT || logFormat === LOG_DETAILS_FORMAT_TYPE.HTML || logFormat === LOG_DETAILS_FORMAT_TYPE.MARKDOWN) {
             composedLogDetails = await composeCallLog({
@@ -189,7 +189,7 @@ async function getCallLog({ userId, sessionIds, platform, requireDetails }) {
             sessionIdsArray = sessionIdsArray.slice(0, 5);
         }
         if (requireDetails) {
-            const platformModule = adapterRegistry.getAdapter(platform);
+            const platformModule = connectorRegistry.getConnector(platform);
             const authType = platformModule.getAuthType();
             let authHeader = '';
             switch (authType) {
@@ -303,7 +303,7 @@ async function updateCallLog({ platform, userId, incomingData, hashedAccountId,
             }
         });
         if (existingCallLog) {
-            const platformModule = adapterRegistry.getAdapter(platform);
+            const platformModule = connectorRegistry.getConnector(platform);
             let user = await UserModel.findByPk(userId);
             if (!user || !user.accessToken) {
                 return { successful: false, message: `Contact not found` };
@@ -324,7 +324,7 @@ async function updateCallLog({ platform, userId, incomingData, hashedAccountId,
 
             // Fetch existing call log details once to avoid duplicate API calls
             let existingCallLogDetails = null;    // Compose updated call log details centrally
-            const logFormat = getLogFormatType(platform);
+            const logFormat = platformModule.platformModule ? platformModule.getLogFormatType(platform) : LOG_DETAILS_FORMAT_TYPE.PLAIN_TEXT;
             let composedLogDetails = '';
             if (logFormat === LOG_DETAILS_FORMAT_TYPE.PLAIN_TEXT || logFormat === LOG_DETAILS_FORMAT_TYPE.HTML || logFormat === LOG_DETAILS_FORMAT_TYPE.MARKDOWN) {
                 let existingBody = '';
@@ -455,7 +455,7 @@ async function createMessageLog({ platform, userId, incomingData }) {
                 }
             }
         }
-        const platformModule = adapterRegistry.getAdapter(platform);
+        const platformModule = connectorRegistry.getConnector(platform);
         const contactNumber = incomingData.logInfo.correspondents[0].phoneNumber;
         const additionalSubmission = incomingData.additionalSubmission;
         let user = await UserModel.findByPk(userId);

package/handlers/user.js

@@ -1,7 +1,7 @@
 const axios = require('axios');
 const { AdminConfigModel } = require('../models/adminConfigModel');
 const { getHashValue } = require('../lib/util');
-const adapterRegistry = require('../adapter/registry');
+const connectorRegistry = require('../connector/registry');
 
 async function getUserSettingsByAdmin({ rcAccessToken, rcAccountId }) {
     let hashedRcAccountId = null;
@@ -73,7 +73,7 @@ async function updateUserSettings({ user, userSettings, platformName }) {
     for (const k of keys) {
         updatedSettings[k] = userSettings[k];
     }
-    const platformModule = adapterRegistry.getAdapter(platformName);
+    const platformModule = connectorRegistry.getConnector(platformName);
     if (platformModule.onUpdateUserSettings) {
         const { successful, returnMessage } = await platformModule.onUpdateUserSettings({ user, userSettings, updatedSettings });
         if (successful) {

package/index.js

@@ -17,11 +17,11 @@ const authCore = require('./handlers/auth');
 const adminCore = require('./handlers/admin');
 const userCore = require('./handlers/user');
 const dispositionCore = require('./handlers/disposition');
-const mock = require('./adapter/mock');
+const mock = require('./connector/mock');
 const releaseNotes = require('./releaseNotes.json');
 const analytics = require('./lib/analytics');
 const util = require('./lib/util');
-const adapterRegistry = require('./adapter/registry');
+const connectorRegistry = require('./connector/registry');
 const calldown = require('./handlers/calldown');
 
 let packageJson = null;
@@ -75,13 +75,13 @@ function createCoreRouter() {
     // Move all app.get, app.post, etc. to router.get, router.post, etc.
     router.get('/releaseNotes', async function (req, res) {
         const globalReleaseNotes = releaseNotes;
-        const adapterReleaseNotes = adapterRegistry.getReleaseNotes();
+        const connectorReleaseNotes = connectorRegistry.getReleaseNotes();
         const mergedReleaseNotes = {};
-        const versions = Object.keys(adapterReleaseNotes);
+        const versions = Object.keys(connectorReleaseNotes);
         for (const version of versions) {
             mergedReleaseNotes[version] = {
                 global: globalReleaseNotes[version]?.global ?? {},
-                ...adapterReleaseNotes[version] ?? {}
+                ...connectorReleaseNotes[version] ?? {}
             };
         }
         res.json(mergedReleaseNotes);
@@ -91,7 +91,7 @@ function createCoreRouter() {
     router.get('/crmManifest', (req, res) => {
         try {
             const platformName = req.query.platformName || 'default';
-            const crmManifest = adapterRegistry.getManifest(platformName);
+            const crmManifest = connectorRegistry.getManifest(platformName);
             if (crmManifest) {
                 // Override app server url for local development
                 if (process.env.OVERRIDE_APP_SERVER) {
@@ -164,7 +164,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Check license status',
             interfaceName: 'checkLicenseStatus',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -219,7 +219,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Auth validation',
             interfaceName: 'authValidation',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -238,7 +238,7 @@ function createCoreRouter() {
 
     // Obsolete
     router.get('/serverVersionInfo', (req, res) => {
-        const defaultCrmManifest = adapterRegistry.getManifest('default');
+        const defaultCrmManifest = connectorRegistry.getManifest('default');
         res.send({ version: defaultCrmManifest?.version ?? 'unknown' });
     });
 
@@ -302,7 +302,7 @@ function createCoreRouter() {
                     }
                     else {
                         res.status(200).send({
-                            customAdapter: null,
+                            customConnector: null,
                             userSettings: {}
                         });
                     }
@@ -325,7 +325,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Get admin settings',
             interfaceName: 'getAdminSettings',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -377,7 +377,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Get user mapping',
             interfaceName: 'getUserMapping',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -423,7 +423,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Get server logging settings',
             interfaceName: 'getServerLoggingSettings',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -474,7 +474,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Set server logging settings',
             interfaceName: 'setServerLoggingSettings',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -539,7 +539,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Get user settings',
             interfaceName: 'getUserSettings',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -584,7 +584,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Set user settings',
             interfaceName: 'setUserSettings',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -671,7 +671,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'OAuth Callback',
             interfaceName: 'onOAuthCallback',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -722,7 +722,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'API Key Login',
             interfaceName: 'onApiKeyLogin',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -748,7 +748,7 @@ function createCoreRouter() {
                     res.status(400).send();
                     return;
                 }
-                const platformModule = adapterRegistry.getAdapter(unAuthData?.platform ?? 'Unknown');
+                const platformModule = connectorRegistry.getConnector(unAuthData?.platform ?? 'Unknown');
                 const { returnMessage } = await platformModule.unAuthorize({ user: userToLogout });
                 res.status(200).send({ returnMessage });
                 success = true;
@@ -767,7 +767,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Unauthorize',
             interfaceName: 'unAuthorize',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -832,7 +832,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Find contact',
             interfaceName: 'findContact',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -885,7 +885,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Create contact',
             interfaceName: 'createContact',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -932,7 +932,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Save note cache',
             interfaceName: 'saveNoteCache',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -976,7 +976,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Get call log',
             interfaceName: 'getCallLog',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -1028,7 +1028,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Create call log',
             interfaceName: 'createCallLog',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -1080,7 +1080,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Update call log',
             interfaceName: 'updateCallLog',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -1136,7 +1136,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Create call log',
             interfaceName: 'createCallLog',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -1189,7 +1189,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Create message log',
             interfaceName: 'createMessageLog',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -1230,7 +1230,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Schedule call down',
             interfaceName: 'scheduleCallDown',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -1271,7 +1271,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Get call down list',
             interfaceName: 'getCallDownList',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -1316,7 +1316,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Delete call down item',
             interfaceName: 'deleteCallDownItem',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -1360,7 +1360,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Mark call down called',
             interfaceName: 'markCallDownCalled',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -1405,7 +1405,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Contact Search by Name',
             interfaceName: 'contactSearchByName',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -1449,7 +1449,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Get admin report',
             interfaceName: 'getAdminReport',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -1490,7 +1490,7 @@ function createCoreRouter() {
         analytics.track({
             eventName: 'Get user report',
             interfaceName: 'getUserReport',
-            adapterName: platformName,
+            connectorName: platformName,
             accountId: hashedAccountId,
             extensionId: hashedExtensionId,
             success,
@@ -1625,4 +1625,4 @@ exports.createCoreRouter = createCoreRouter;
 exports.createCoreMiddleware = createCoreMiddleware;
 exports.createCoreApp = createCoreApp;
 exports.initializeCore = initializeCore;
-exports.adapterRegistry = adapterRegistry;
+exports.connectorRegistry = connectorRegistry;

package/lib/analytics.js

@@ -19,7 +19,7 @@ exports.init = function init() {
     mixpanel = Mixpanel.init(process.env.MIXPANEL_TOKEN);
 }
 
-exports.track = function track({ eventName, interfaceName, adapterName, accountId, extensionId, success, requestDuration, userAgent, ip, author, eventAddedVia, extras = null }) {
+exports.track = function track({ eventName, interfaceName, connectorName, accountId, extensionId, success, requestDuration, userAgent, ip, author, eventAddedVia, extras = null }) {
     if (!mixpanel || !extensionId) {
         return;
     }
@@ -27,13 +27,13 @@ exports.track = function track({ eventName, interfaceName, adapterName, accountI
     mixpanel.people.set_once(extensionId, {
         version,
         appName,
-        crmPlatform: adapterName
+        crmPlatform: connectorName
     });
     const ua = parser(userAgent);
     mixpanel.track(eventName, {
         distinct_id: extensionId,
         interfaceName,
-        adapterName,
+        connectorName,
         rcAccountId: accountId,
         extensionId,
         success,

package/lib/callLogComposer.js

@@ -1,11 +1,11 @@
 const moment = require('moment-timezone');
 const { secondsToHoursMinutesSeconds } = require('./util');
-const adapterRegistry = require('../adapter/registry');
+const connectorRegistry = require('../connector/registry');
 const { LOG_DETAILS_FORMAT_TYPE } = require('./constants');
 
 /**
  * Centralized call log composition module
- * Supports both plain text and HTML formats used across different CRM adapters
+ * Supports both plain text and HTML formats used across different CRM connectors
  */
 
 /**
@@ -615,27 +615,8 @@ function upsertLegs({ body, legs, logFormat }) {
     return result;
 }
 
-/**
- * Helper function to determine format type for a CRM platform
- * @param {string} platform - CRM platform name
- * @returns {string} Format type
- */
-function getLogFormatType(platform) {
-    if(process.env.LOG_FORMAT_PLAIN_TEXT_PLATFORMS.split(',').includes(platform)){
-        return LOG_DETAILS_FORMAT_TYPE.PLAIN_TEXT;
-    }
-    if(process.env.LOG_FORMAT_HTML_PLATFORMS.split(',').includes(platform)){
-        return LOG_DETAILS_FORMAT_TYPE.HTML;
-    }
-    if(process.env.LOG_FORMAT_MARKDOWN_PLATFORMS.split(',').includes(platform)){
-        return LOG_DETAILS_FORMAT_TYPE.MARKDOWN;
-    }
-    return LOG_DETAILS_FORMAT_TYPE.PLAIN_TEXT;
-}
-
 module.exports = {
     composeCallLog,
-    getLogFormatType,
     // Export individual upsert functions for backward compatibility
     upsertCallAgentNote,
     upsertCallSessionId,

package/lib/oauth.js

@@ -2,7 +2,7 @@
 const ClientOAuth2 = require('client-oauth2');
 const moment = require('moment');
 const { UserModel } = require('../models/userModel');
-const adapterRegistry = require('../adapter/registry');
+const connectorRegistry = require('../connector/registry');
 const dynamoose = require('dynamoose');
 
 // oauthApp strategy is default to 'code' which use credentials to get accessCode, then exchange for accessToken and refreshToken.
@@ -25,7 +25,7 @@ async function checkAndRefreshAccessToken(oauthApp, user, tokenLockTimeout = 20)
     const expiryBuffer = 2; // 2 minutes
     // Special case: Bullhorn
     if (user.platform) {
-        const platformModule = adapterRegistry.getAdapter(user.platform);
+        const platformModule = connectorRegistry.getConnector(user.platform);
         if (platformModule.checkAndRefreshAccessToken) {
             return platformModule.checkAndRefreshAccessToken(oauthApp, user, tokenLockTimeout);
         }

package/models/adminConfigModel.js

@@ -11,6 +11,7 @@ exports.AdminConfigModel = sequelize.define('adminConfigs', {
   userSettings: {
     type: Sequelize.JSON
   },
+  // Obsolete
   customAdapter: {
     type: Sequelize.JSON
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@app-connect/core",
-  "version": "1.7.0-beta.4",
+  "version": "1.7.0-beta.6",
   "description": "RingCentral App Connect Core",
   "main": "index.js",
   "repository": {