@app-connect/core 1.6.4 → 1.7.0-beta.1

package/lib/ringcentral.js

@@ -0,0 +1,275 @@
+
+const fetch = require('node-fetch');
+
+const DEFAULT_RENEW_HANDICAP_MS = 60 * 1000; // 1 minute
+
+function stringifyQuery(query) {
+  const queryParams = new URLSearchParams(query);
+  return queryParams.toString();
+}
+
+const REFRESH_RENEW_HANDICAP_MS = 10 * 1000; // 10s
+function isRefreshTokenValid(token, handicap = REFRESH_RENEW_HANDICAP_MS) {
+  const expireTime = token.refresh_token_expire_time;
+  return expireTime - handicap > Date.now();
+}
+
+function isAccessTokenValid(token, handicap = DEFAULT_RENEW_HANDICAP_MS) {
+  const expireTime = token.expire_time;
+  return expireTime - handicap > Date.now();
+}
+
+class RingCentral {
+  constructor(options) {
+    this._options = options;
+  }
+
+  loginUrl({
+    state,
+  }) {
+    const query = {
+      response_type: 'code',
+      redirect_uri: this._options.redirectUri,
+      client_id: this._options.clientId,
+      response_hint: 'brand_id contracted_country_code',
+    };
+    if (state) {
+      query.state = state;
+    }
+    return `${this._options.server}/restapi/oauth/authorize?${stringifyQuery(query)}`;
+  }
+
+  async generateToken({ code }) {
+    const body = {
+      code,
+      grant_type: 'authorization_code',
+      redirect_uri: this._options.redirectUri,
+    };
+    const response = await this._tokenRequest('/restapi/oauth/token', body);
+    if (Number.parseInt(response.status, 10) >= 400) {
+      throw new Error('Generate Token error', response.status);
+    }
+    const {
+      expires_in,
+      refresh_token_expires_in,
+      scope,
+      endpoint_id, // do no save this field into db to reduce db size
+      ...token
+    } = await response.json();
+    return {
+      ...token,
+      expire_time: Date.now() + parseInt(expires_in, 10) * 1000,
+      refresh_token_expire_time: Date.now() + parseInt(refresh_token_expires_in, 10) * 1000,
+    };
+  }
+
+  async refreshToken(token) {
+    const body = {
+      grant_type: 'refresh_token',
+      refresh_token: token.refresh_token,
+      access_token_ttl: token.expires_in,
+      refresh_token_ttl: token.refresh_token_expires_in,
+    };
+    const response = await this._tokenRequest('/restapi/oauth/token', body);
+    if (Number.parseInt(response.status, 10) >= 400) {
+      const error = new Error('Refresh Token error', response.status);
+      error.response = response;
+      throw error;
+    }
+    const {
+      expires_in,
+      refresh_token_expires_in,
+      scope,
+      endpoint_id, // do no save this field into db to reduce db size
+      ...newToken
+    } = await response.json();
+    return {
+      ...newToken,
+      expire_time: Date.now() + parseInt(expires_in, 10) * 1000,
+      refresh_token_expire_time: Date.now() + parseInt(refresh_token_expires_in, 10) * 1000,
+    }
+  }
+
+  async revokeToken(token) {
+    const body = {
+      token: token.access_token,
+    };
+    const response = await this._tokenRequest('/restapi/oauth/revoke', body);
+    if (Number.parseInt(response.status, 10) >= 400) {
+      throw new Error('Revoke Token error', response.status);
+    }
+  }
+
+  async _tokenRequest(path, body) {
+    const authorization = `${this._options.clientId}:${this._options.clientSecret}`;
+    const response = await fetch(
+      `${this._options.server}${path}`, {
+      method: 'POST',
+      body: stringifyQuery(body),
+      headers: {
+        'Accept': 'application/json',
+        'Content-Type': 'application/x-www-form-urlencoded',
+        'Authorization': `Basic ${Buffer.from(authorization).toString('base64')}`
+      },
+    }
+    );
+    return response;
+  }
+
+  async request({
+    server = this._options.server,
+    path,
+    query,
+    body,
+    method,
+    accept = 'application/json',
+  }, token) {
+    let uri = `${server}${path}`;
+    if (query) {
+      uri = uri + (uri.includes('?') ? '&' : '?') + stringifyQuery(query);
+    }
+    const response = await fetch(uri, {
+      method,
+      body: body ? JSON.stringify(body) : body,
+      headers: {
+        'Accept': accept,
+        'Content-Type': 'application/json',
+        'Authorization': `${token.token_type} ${token.access_token}`,
+      },
+    });
+    if (Number.parseInt(response.status, 10) >= 400) {
+      const error = new Error(`request data error ${response.status}`);
+      const errorText = await response.text();
+      error.message = errorText;
+      error.response = response;
+      throw error;
+    }
+    return response;
+  }
+
+  async createSubscription({
+    eventFilters,
+    webhookUri,
+  }, token) {
+    const response = await this.request({
+      method: 'POST',
+      path: '/restapi/v1.0/subscription',
+      body: {
+        eventFilters,
+        deliveryMode: {
+          transportType: 'WebHook',
+          address: webhookUri,
+        },
+        expiresIn: 7 * 24 * 3600, // 7 days
+      },
+    }, token);
+    const {
+      uri,
+      creationTime,
+      deliveryMode,
+      status, // do no save those field into db to reduce db size
+      ...subscription
+    } = await response.json();
+    return subscription;
+  }
+
+  async getExtensionInfo(extensionId, token) {
+    const response = await this.request({
+      method: 'GET',
+      path: `/restapi/v1.0/account/~/extension/${extensionId}`,
+    }, token);
+    return response.json();
+  }
+
+  async getAccountInfo(token) {
+    const response = await this.request({
+      method: 'GET',
+      path: `/restapi/v1.0/account/~`,
+    }, token);
+    return response.json();
+  }
+
+  async getCallsAggregationData({ token, timezone, timeFrom, timeTo }) {
+    const body = {
+      grouping: {
+        groupBy: "Company"
+      },
+      timeSettings: {
+        timeZone: timezone,
+        timeRange: {
+          timeFrom: timeFrom,
+          timeTo: timeTo
+        }
+      },
+      responseOptions: {
+        counters: {
+          callsByDirection: {
+            aggregationType: "Sum"
+          },
+          callsByResponse: {
+            aggregationType: "Sum"
+          }
+        },
+        timers: {
+          allCallsDuration: {
+            aggregationType: "Sum"
+          }
+        }
+      }
+    }
+    const response = await this.request({
+      method: 'POST',
+      path: `/analytics/calls/v1/accounts/~/aggregation/fetch`,
+      body,
+      accept: 'application/json'
+    }, token);
+    return response.json();
+  }
+
+  async getCallLogData({ extensionId = '~', token, timezone, timeFrom, timeTo }) {
+    let pageStart = 1;
+    let isFinalPage = false;
+    let callLogResponse = null;
+    let result = { records: [] };
+    while (!isFinalPage) {
+      callLogResponse = await this.request({
+        method: 'GET',
+        path: `/restapi/v1.0/account/~/extension/${extensionId}/call-log?dateFrom=${timeFrom}&dateTo=${timeTo}&page=${pageStart}&view=Simple&perPage=1000`,
+      }, token);
+      const resultJson = await callLogResponse.json();
+      result.records.push(...resultJson.records);
+      if (resultJson.navigation?.nextPage) {
+        pageStart++;
+      }
+      else {
+        isFinalPage = true;
+      }
+    }
+    return result;
+  }
+  async getSMSData({ extensionId = '~', token, timezone, timeFrom, timeTo }) {
+    let pageStart = 1;
+    let isFinalPage = false;
+    let smsLogResponse = null;
+    let result = { records: [] };
+    while (!isFinalPage) {
+      smsLogResponse = await this.request({
+        method: 'GET',
+        path: `/restapi/v1.0/account/~/extension/${extensionId}/message-store?dateFrom=${timeFrom}&dateTo=${timeTo}&page=${pageStart}&perPage=100`,
+      }, token);
+      const resultJson = await smsLogResponse.json();
+      result.records.push(...resultJson.records);
+      if (resultJson.navigation?.nextPage) {
+        pageStart++;
+      }
+      else {
+        isFinalPage = true;
+      }
+    }
+    return result;
+  }
+}
+
+exports.RingCentral = RingCentral;
+exports.isRefreshTokenValid = isRefreshTokenValid;
+exports.isAccessTokenValid = isAccessTokenValid;

package/lib/util.js

@@ -37,7 +37,32 @@ function secondsToHoursMinutesSeconds(seconds) {
     return resultString;
 }
 
+function getMostRecentDate({ allDateValues }) {
+    var result = 0;
+    for (const date of allDateValues) {
+        if(!date)
+        {
+            continue;
+        }
+        if (date > result) {
+            result = date;
+        }
+    }
+    return result;
+}
+
+// media reader link: https://ringcentral.github.io/ringcentral-media-reader/?media=https://media.ringcentral.com/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{contentId}
+// platform media link: https://media.ringcentral.com/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{contentId}
+function getMediaReaderLinkByPlatformMediaLink(platformMediaLink){
+    if(!platformMediaLink){
+        return null;
+    }
+    const encodedPlatformMediaLink = encodeURIComponent(platformMediaLink);
+    return `https://ringcentral.github.io/ringcentral-media-reader/?media=${encodedPlatformMediaLink}`;
+}
+
 exports.getTimeZone = getTimeZone;
 exports.getHashValue = getHashValue;
 exports.secondsToHoursMinutesSeconds = secondsToHoursMinutesSeconds;
-
+exports.getMostRecentDate = getMostRecentDate;
+exports.getMediaReaderLinkByPlatformMediaLink = getMediaReaderLinkByPlatformMediaLink;

package/models/adminConfigModel.js

@@ -1,7 +1,7 @@
 const Sequelize = require('sequelize');
 const { sequelize } = require('./sequelize');
 
-// Model for User data
+// Model for Admin data
 exports.AdminConfigModel = sequelize.define('adminConfigs', {
   // hashed rc account ID
   id: {
@@ -13,5 +13,22 @@ exports.AdminConfigModel = sequelize.define('adminConfigs', {
   },
   customAdapter: {
     type: Sequelize.JSON
+  },
+  adminAccessToken: {
+    type: Sequelize.STRING(512),
+  },
+  adminRefreshToken: {
+    type: Sequelize.STRING(512),
+  },
+  adminTokenExpiry: {
+    type: Sequelize.DATE
+  },
+    // Array of:
+  // {
+  //   crmUserId: string,
+  //   rcExtensionId: array of strings
+  // }
+  userMappings: {
+    type: Sequelize.JSON
   }
 });

package/models/callDownListModel.js

@@ -0,0 +1,35 @@
+const Sequelize = require('sequelize');
+const { sequelize } = require('./sequelize');
+
+exports.CallDownListModel = sequelize.define('callDownLists', {
+    id: {
+        type: Sequelize.STRING,
+        primaryKey: true,
+    },
+    userId: {
+        type: Sequelize.STRING,
+    },
+    contactId: {
+        type: Sequelize.STRING,
+    },
+    contactType: {
+        type: Sequelize.STRING,
+    },
+    status: {
+        type: Sequelize.STRING,
+    },
+    scheduledAt: {
+        type: Sequelize.DATE,
+    },
+    lastCallAt: {
+        type: Sequelize.DATE,
+    }
+}, {
+    timestamps: true,
+    indexes: [
+        { fields: ['userId'] },
+        { fields: ['status'] },
+        { fields: ['scheduledAt'] },
+        { fields: ['userId', 'status'] }
+    ]
+});

package/models/userModel.js

@@ -3,10 +3,14 @@ const { sequelize } = require('./sequelize');
 
 // Model for User data
 exports.UserModel = sequelize.define('users', {
+  // id = {crmName}-{crmUserId}
   id: {
     type: Sequelize.STRING,
     primaryKey: true,
   },
+  rcAccountId: {
+    type: Sequelize.STRING,
+  },
   hostname: {
     type: Sequelize.STRING,
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@app-connect/core",
-  "version": "1.6.4",
+  "version": "1.7.0-beta.1",
   "description": "RingCentral App Connect Core",
   "main": "index.js",
   "repository": {
@@ -14,7 +14,7 @@
   "author": "RingCentral Labs",
   "license": "MIT",
   "peerDependencies": {
-    "axios": "^1.1.2",
+    "axios": "^1.12.2",
     "express": "^4.21.2",
     "pg": "^8.8.0",
     "sequelize": "^6.29.0",
@@ -44,7 +44,7 @@
   "devDependencies": {
     "@eslint/js": "^9.22.0",
     "@octokit/rest": "^19.0.5",
-    "axios": "^1.1.2",
+    "axios": "^1.12.2",
     "express": "^4.21.2",
     "eslint": "^9.22.0",
     "globals": "^16.0.0",

package/releaseNotes.json

@@ -1,4 +1,48 @@
 {
+    "1.6.7": {
+        "global": [
+            {
+                "type": "New",
+                "description": "- Clio now supports image/video media link in message logs"
+            }
+        ]
+    },
+    "1.6.6": {
+        "global": [
+            {
+                "type": "New",
+                "description": "- Server-side call logging now supports user mapping configuration in the admin tab, allowing admin users to log calls on behalf of other users."
+            },
+            {
+                "type": "New",
+                "description": "- Separate enable domains for click-to-dial and quick access button"
+            },
+            {
+                "type": "Fix",
+                "description": "- Server-side call logging now displays RingCentral user names in the correct order within log details."
+            },
+            {
+                "type": "Fix",
+                "description": "- Server-side call logging now shows the correct RingCentral user name instead of displaying the Caller ID"
+            }
+        ]
+    },
+    "1.6.5": {
+        "global": [
+            {
+                "type": "New",
+                "description": "- Support call journey in call logging details with server side logging [Details](https://appconnect.labs.ringcentral.com/users/logging/#controlling-what-information-gets-logged)"
+            },
+            {
+                "type": "Better",
+                "description": "- Tabs orders updated"
+            },
+            {
+                "type": "Fix",
+                "description": "- Date/Time display issue"
+            }
+        ]
+    },
     "1.6.4": {
         "global": [
             {