@defra/flood-webchat 0.0.1-alpha.2 → 0.0.1-alpha.4

package/src/server/client.js

@@ -0,0 +1,72 @@
+import querystring from 'querystring'
+import axios from 'axios'
+import { isWithinHours, extractTenantId } from './utils.js'
+
+export async function authenticate ({ authorisation, accessKey, accessSecret }) {
+  const uri = 'https://cxone.niceincontact.com/auth/token'
+
+  const config = {
+    signal: AbortSignal.timeout(3000),
+    headers: {
+      Host: 'eu1.niceincontact.com',
+      'Content-Type': 'application/x-www-form-urlencoded',
+      Authorization: authorisation
+    }
+  }
+
+  const body = querystring.stringify({
+    grant_type: 'password',
+    username: accessKey,
+    password: accessSecret
+  })
+  // Cache authentication and re-authenticate when needed (lasts 1 hour?)
+  const auth = await axios.post(uri, body, config)
+  return {
+    token: auth.data.access_token,
+    tokenType: auth.data.token_type,
+    tenantId: extractTenantId(auth.data.id_token)
+  }
+}
+
+export async function getHost ({ tenantId }) {
+  const uri = `https://cxone.niceincontact.com/.well-known/cxone-configuration?tenantId=${tenantId}`
+  const config = {
+    signal: AbortSignal.timeout(3000)
+  }
+  const api = await axios.get(uri, config)
+  return `api-${api.data.area}.niceincontact.com`
+}
+
+export async function getActivity ({ tokenType, token, host, skillEndpoint, maxQueueCount }) {
+  const config = {
+    signal: AbortSignal.timeout(3000),
+    headers: {
+      Host: host,
+      Authorization: `${tokenType} ${token}`,
+      'Content-Type': 'application/x-www-form-urlencoded'
+    }
+  }
+  const uri = `https://${host}${skillEndpoint}`
+  const skill = await axios.get(uri, config)
+  const activity = skill.data.skillActivity[0]
+  return {
+    hasCapacity: activity.queueCount < maxQueueCount,
+    hasAgentsAvailable: activity.agentsAvailable >= 1
+  }
+}
+
+export async function getIsOpen ({ host, token, tokenType, hoursEndpoint }) {
+  const config = {
+    signal: AbortSignal.timeout(3000),
+    headers: {
+      Host: 'api-l36.niceincontact.com',
+      Authorization: `${tokenType} ${token}`,
+      'Content-Type': 'application/x-www-form-urlencoded'
+    }
+  }
+
+  const uri = `https://${host}${hoursEndpoint}`
+  const hours = await axios.get(uri, config)
+  const days = hours.data.resultSet.hoursOfOperationProfiles[0].days
+  return isWithinHours(days)
+}

package/src/server/index.js

@@ -1,3 +1,46 @@
-export function foo (value) {
-  return value === 'bar'
+import { authenticate, getHost, getIsOpen, getActivity } from './client.js'
+
+/**
+ * Returns webchat availability
+ * @param options {object}
+ * @param options.clientId {string}
+ * @param options.clientSecret {string}
+ * @param options.accessKey {string}
+ * @param options.accessSecret {string}
+ * @param options.skillEndpoint {string}
+ * @param options.hoursEndpoint {string}
+ * @param options.maxQueueCount {string}
+ * @returns {Promise<{date: Date, availability: (string)}>}
+ */
+export default async function getAvailability ({
+  clientId,
+  clientSecret,
+  accessKey,
+  accessSecret,
+  skillEndpoint,
+  hoursEndpoint,
+  maxQueueCount
+}) {
+  const authorisation = 'Basic ' + Buffer.from(`${encodeURIComponent(clientId)}:${encodeURIComponent(clientSecret)}`).toString('base64')
+
+  // Cache authentication and re-authenticate when needed (lasts 1 hour?)
+  const { tenantId, token, tokenType } = await authenticate({ authorisation, accessKey, accessSecret })
+  const host = await getHost({ tenantId })
+
+  const [{ hasCapacity, hasAgentsAvailable }, isOpen] = await Promise.all([
+    getActivity({ tokenType, token, host, skillEndpoint, maxQueueCount }),
+    getIsOpen({ token, tokenType, host, hoursEndpoint })
+  ])
+
+  // Hours of operation
+
+  // Availability
+  const isAvailable = isOpen && hasAgentsAvailable && hasCapacity
+  const isExistingOnly = isOpen && hasAgentsAvailable && !hasCapacity
+  const availability = isAvailable ? 'AVAILABLE' : isExistingOnly ? 'EXISTING' : 'UNAVAILABLE'
+
+  return {
+    date: new Date(),
+    availability
+  }
 }

package/src/server/utils.js

@@ -0,0 +1,19 @@
+export const extractTenantId = (token) => {
+  const base64Url = token.split('.')[1]
+  const base64 = base64Url.replace(/-/g, '+').replace(/_/g, '/')
+  const jsonPayload = decodeURIComponent(Buffer.from(base64, 'base64').toString('ascii').split('').map(c => {
+    return '%' + ('00' + c.charCodeAt(0).toString(16)).slice(-2)
+  }).join(''))
+
+  return JSON.parse(jsonPayload).tenantId
+}
+
+export const isWithinHours = (days) => {
+  const now = new Date()
+  const name = now.toLocaleDateString('en-GB', { weekday: 'long' })
+  const day = days.find(d => d.day.toLowerCase() === name.toLowerCase())
+  const date = now.toLocaleDateString('en-GB').split('/')
+  const open = `${date[2]}-${date[1]}-${date[0]}T${day.openTime}`
+  const close = `${date[2]}-${date[1]}-${date[0]}T${day.closeTime}`
+  return now.getTime() >= Date.parse(open) && now.getTime() <= Date.parse(close)
+}