@defra/flood-webchat 0.0.1-beta.8 → 1.0.1

package/src/client/components/panel/panel.jsx

@@ -1,106 +1,163 @@
 import React, { useEffect, useState, useCallback } from 'react'
 import { createPortal } from 'react-dom'
+import { classnames } from '../../lib/classnames.js'
 
-import { PanelHeader } from './panel-header.jsx'
 import { PreChat } from '../screens/pre-chat.jsx'
 import { RequestChat } from '../screens/request-chat.jsx'
-
-export const setAriaHidden = (bool) => {
-  for (const node of document.body.children) {
-    if (node.id !== 'wc-panel') {
-      (bool) ? node.setAttribute('aria-hidden', 'true') : node.removeAttribute('aria-hidden')
-    }
-  }
-}
-
-export const getFocusableElements = () => {
-  const selectors = [
-    '#wc-panel a:not([disabled])',
-    '#wc-panel button:not([disabled])',
-    '#wc-panel select:not([disabled])',
-    '#wc-panel input:not([disabled])',
-    '#wc-panel textarea:not([disabled])',
-    '#wc-panel *[tabindex="0"]:not([disabled])'
-  ]
-
-  const elements = document.body.querySelectorAll(selectors.join(','))
-  return Array.from(elements).filter(e => !e.closest('[hidden]') && !e.closest('[aria-hidden="true"]'))
-}
-
-export function Panel ({ screenNumber, onClose }) {
-  const [screen, setScreen] = useState(screenNumber)
-  const [panelElements, setPanelElements] = useState([])
-
-  const onKeyDown = useCallback((e) => {
-    if (e.key === 'Escape' || e.key === 'Esc') return onClose()
-
-    if (e.key === 'Tab') {
-      const webchatPanelElement = document.querySelector('#wc-panel')
-
-      if (webchatPanelElement && !document.activeElement.closest('#wc-panel')) {
-        webchatPanelElement.focus()
+import { Chat } from '../chat/chat.jsx'
+import { Unavailable } from '../screens/unavailable.jsx'
+import { EndChat } from '../screens/end-chat.jsx'
+import { Settings } from '../screens/settings.jsx'
+import { Feedback } from '../screens/feedback.jsx'
+import { LiveRegion } from '../live-region.jsx'
+
+import { useApp } from '../../store/useApp.js'
+import { useChatSdk } from '../../store/useChatSdk.js'
+import { useFocusedElements } from '../../hooks/useFocusedElements.js'
+import { historyReplaceState } from '../../lib/history.js'
+
+export function Panel () {
+  const { sdk, availability, instigatorId, thread, threadId, setThread, setThreadId, setChatVisibility, setMessages, setUnseenCount, isMobile, isKeyboard } = useApp()
+  const { fetchThread, fetchMessages } = useChatSdk(sdk)
+
+  const [screen, setScreen] = useState(threadId ? 2 : 0)
+
+  useFocusedElements(screen)
+
+  const onEscapeKey = useCallback(e => {
+    if (e.key === 'Escape' || e.key === 'Esc') {
+      if (threadId) {
+        thread?.lastMessageSeen()
+        setUnseenCount(0)
       }
+      setChatVisibility(false)
+      historyReplaceState()
+    }
+  }, [thread, threadId, setUnseenCount, setChatVisibility])
 
-      if (e.shiftKey) {
-        if (document.activeElement === panelElements[0]) {
-          panelElements[panelElements.length - 1].focus()
-          e.preventDefault()
-        } else if (document.activeElement === document.querySelector('#wc-panel')) {
-          panelElements[panelElements.length - 1]?.focus()
-          e.preventDefault()
-        }
-      } else if (document.activeElement === panelElements[panelElements.length - 1]) {
-        panelElements[0].focus()
-        e.preventDefault()
-      }
+  /**
+   * Focus previously focused element when closing the webchat
+   */
+  useEffect(() => {
+    return () => {
+      document.getElementById(instigatorId)?.focus()
     }
-  }, [panelElements])
+  }, [])
 
+  /**
+  * We need ammend classes on the body element to handle mobile behaviour
+  */
   useEffect(() => {
-    setPanelElements(getFocusableElements())
-  }, [screen])
+    document.body.classList.remove('wc-u-hidden')
+    document.getElementsByTagName('html')[0].classList.add('wc-u-html')
+    document.body.classList.add('wc-u-body')
+    return () => {
+      document.getElementsByTagName('html')[0].classList.remove('wc-u-html')
+      document.body.classList.remove('wc-u-body')
+    }
+  }, [isMobile])
 
+  /**
+   * Initializes the eventListener for pressing the escape key
+   */
   useEffect(() => {
-    setAriaHidden(true)
-    document.querySelector('#wc-panel').focus()
-    document.addEventListener('keydown', onKeyDown)
+    document.addEventListener('keydown', onEscapeKey)
 
     return () => {
-      setAriaHidden()
-      document.body.querySelector('.wc-availability__link')?.focus()
-      document.removeEventListener('keydown', onKeyDown)
+      document.removeEventListener('keydown', onEscapeKey)
     }
-  }, [panelElements])
+  }, [onEscapeKey, setChatVisibility])
 
-  const onBack = (e) => {
+  /**
+   * Recovers the thread if there is a threadId but no thread loaded in to state
+   */
+  useEffect(() => {
+    const recover = async () => {
+      try {
+        const fetchedThread = await fetchThread(threadId)
+        setThread(fetchedThread)
+
+        const fetchedMessages = await fetchMessages(fetchedThread, threadId)
+        setMessages(fetchedMessages)
+      } catch (err) {
+        console.log('[Chat Error] fetchThread', err)
+
+        setThreadId()
+        setThread()
+        setScreen(0)
+      }
+    }
+
+    if (threadId) {
+      if (thread) {
+        thread.lastMessageSeen()
+        setUnseenCount(0)
+        setScreen(2)
+      } else {
+        recover()
+      }
+    }
+  }, [thread, threadId])
+
+  const handleScreenChange = newScreen => e => {
     e.preventDefault()
-    setScreen(screen - 1)
+    setScreen(newScreen)
   }
 
+  const goToPreChatScreen = handleScreenChange(0)
+  const goToRequestChatScreen = handleScreenChange(1)
+  const goToChatScreen = handleScreenChange(2)
+  const goToEndChatScreen = handleScreenChange(3)
+  const goToFeedbackScreen = handleScreenChange(4)
+  const goToSettingsScreen = handleScreenChange(5)
+
   let ScreenComponent
 
   switch (screen) {
     case 0:
-      ScreenComponent = <PreChat screen={screen} setScreen={setScreen} />
+      ScreenComponent = <PreChat onContinue={goToRequestChatScreen} />
       break
     case 1:
-      ScreenComponent = <RequestChat onBack={onBack} />
+      ScreenComponent = <RequestChat onPreChatScreen={goToPreChatScreen} />
+      break
+    case 2:
+      ScreenComponent = <Chat onSettingsScreen={goToSettingsScreen} onEndChatScreen={goToEndChatScreen} />
+      break
+    case 3:
+      ScreenComponent = <EndChat onChatScreen={goToChatScreen} onEndChatConfirm={goToFeedbackScreen} />
+      break
+    case 4:
+      ScreenComponent = (
+        <Feedback onCancel={() => {
+          setChatVisibility(false)
+          historyReplaceState()
+        }}
+        />
+      )
+      break
+    case 5:
+      ScreenComponent = <Settings onCancel={goToChatScreen} />
       break
     default:
-      ScreenComponent = <PreChat screen={screen} setScreen={setScreen} />
+      ScreenComponent = <PreChat onContinue={goToRequestChatScreen} />
   }
 
-  const Component = (
-    <div id='wc-panel' className='wc-panel' role='dialog' tabIndex='-1' aria-modal='true' aria-labelledby='wc-header-title'>
-      <PanelHeader screen={screen} isConnected={false} onBack={onBack} onClose={onClose} />
+  if (availability === 'UNAVAILABLE') {
+    ScreenComponent = <Unavailable />
+  }
 
-      <div className='wc-body'>
-        <div className='wc-content govuk-body-s'>
-          {ScreenComponent}
-        </div>
+  const Component = (
+    <div id='wc-panel' role='dialog' className={classnames('wc-panel', isKeyboard && 'wc-focus-visible')} tabIndex='-1' aria-modal='true' aria-labelledby='wc-header wc-subtitle'>
+      <div className='wc-panel__inner'>
+        {ScreenComponent}
       </div>
+      <LiveRegion />
     </div>
   )
 
-  return createPortal(Component, document.body)
+  return (
+    <>
+      {createPortal(Component, document.body)}
+    </>
+  )
 }

package/src/client/components/panel/panel.scss

@@ -1,26 +1,51 @@
 .wc-panel {
   display: flex;
-  flex-direction: column;
   position: fixed;
-  bottom: 0;
-  right: 0;
+  flex-wrap: nowrap;
+  z-index: 999;
   top: 0;
+  right: 0;
+  bottom: 0;
   left: 0;
-  width: 100%;
-  height: 100%;
-  background-color: govuk-colour('white');
-  z-index: 999;
-  outline: none;
-
-  @include mq ($from: 'tablet') {
-    bottom: 0;
-    right: 0;
+  padding: 0;
+  box-sizing: border-box;
+  -webkit-overflow-scrolling: touch;
+  touch-action: pan-x pan-y;
+  background-color: #ffffff;
+  @include mq ($from: tablet) {
     top: auto;
     left: auto;
     width: 400px;
     height: 540px;
-    margin-bottom: 10px;
     margin-right: 10px;
+    margin-bottom: 10px;
+  }
+
+  &:focus {
+    outline: none;
+  }
+
+  &:focus.wc-focus-visible::after {
+    @include focus($glow: 5px, $strong: 2px, $background: 0, $inset: 0);
+    left: 4px;
+    right: 4px;
+    top: 4px;
+    bottom: 4px;
+  }
+
+  &__inner {
+    position: relative;
+    flex: 0 0 100%;
+    display: flex;
+    flex-wrap: nowrap;
+    flex-direction: column;
+    background-color: transparent;
+    border: 0;
+    outline: 0;
+    @include mq ($from: tablet) {
+      border: 1px solid govuk-colour('black');
+    }
+    box-sizing: border-box;
   }
 }
 
@@ -29,43 +54,59 @@
   flex-direction: row;
   align-items: center;
   background-color: govuk-colour('black');
+  border-bottom: 1px solid govuk-colour('black');
+  padding: 3px;
 
   &__link {
     margin: 0 govuk-spacing(2);
   }
 
   &__title {
-    padding: 0 0 0 govuk-spacing(2);
+    @extend %govuk-heading-s;
+    font-size: 19px;
+    padding: 0 0 0 10px;
+    @include mq ($from: tablet) {
+      padding-left: 7px;
+    }
     color: govuk-colour('white');
     margin-bottom: 0;
   }
 
-  &__close {
+  &__close,
+  &__hide,
+  &__back {
     display: flex;
     justify-content: center;
     color: govuk-colour('white');
     background: none;
     border: 0;
-    padding: govuk-spacing(2);
+    padding: 7px;
     margin: 0 0 0 auto;
     cursor: pointer;
 
     &:focus {
-      @include govuk-focused-text;
+      outline: 3px solid $govuk-focus-colour;
+    }
+  }
+
+  &__back {
+    margin: 0;
+    display: flex;
+
+    @include mq ($from: 'tablet') {
+      display: none
     }
   }
 }
 
 .wc-body {
-  @include govuk-responsive-padding(3);
-
+  font-size: 16px;
   flex: 1;
   position: relative;
   overflow-y: auto;
   overscroll-behavior: contain;
-  border: 1px solid govuk-colour('black');
 }
 
-.wc-back-link {
-  margin: govuk-spacing(1) 0 govuk-spacing(6) 0;
+.wc-content {
+  padding: 20px 15px;
 }

package/src/client/components/screens/end-chat.jsx

@@ -0,0 +1,77 @@
+import React, { useEffect } from 'react'
+import { PanelHeader } from '../panel/panel-header.jsx'
+import { useApp } from '../../store/useApp.js'
+
+export function EndChat ({ onChatScreen, onEndChatConfirm }) {
+  const { setCustomerId, setThreadId, setMessages, agentStatus, thread, threadId, setUnseenCount, isKeyboard } = useApp()
+
+  const confirmEndChat = async e => {
+    e.preventDefault()
+
+    window.localStorage.setItem('tmpThreadId', threadId)
+    setThreadId()
+    setMessages([])
+    setCustomerId()
+    thread.lastMessageSeen()
+    setUnseenCount(0)
+
+    // End chat if still open
+    if (agentStatus !== 'closed') {
+      thread.endChat()
+    }
+
+    onEndChatConfirm(e)
+  }
+
+  useEffect(() => {
+    if (isKeyboard) {
+      setTimeout(() => {
+        document.querySelector('#confirm-endchat').focus()
+      }, 10)
+    }
+  }, [])
+
+  const handleKeyPress = e => {
+    if ((e.key === 'Enter' || e.key === ' ') && e.target.id === 'confirm-endchat') {
+      confirmEndChat(e)
+    }
+    if ((e.key === 'Enter' || e.key === ' ') && e.target.id === 'resume-chat') {
+      onChatScreen(e)
+    }
+  }
+
+  return (
+    <>
+      <PanelHeader />
+      <div className='wc-body'>
+        <div className='wc-content'>
+          <h3 id='wc-subtitle' className='wc-heading' aria-live='polite'>Are you sure you want to end the chat?</h3>
+          <div className='govuk-button-group'>
+            <a
+              id='confirm-endchat'
+              href='#endChat'
+              role='button'
+              className='wc-button govuk-button'
+              data-module='govuk-button'
+              onClick={confirmEndChat}
+              onKeyDown={handleKeyPress}
+            >
+              Yes, end chat
+            </a>
+            <a
+              id='resume-chat'
+              href='#resumeChat'
+              role='button'
+              className='wc-link govuk-link'
+              data-module='govuk-button'
+              onClick={onChatScreen}
+              onKeyDown={handleKeyPress}
+            >
+              No, resume chat
+            </a>
+          </div>
+        </div>
+      </div>
+    </>
+  )
+}

package/src/client/components/screens/feedback.jsx

@@ -0,0 +1,65 @@
+import React from 'react'
+import { PanelHeader } from '../panel/panel-header.jsx'
+
+export function Feedback ({ onCancel }) {
+  const feedbackSend = () => {
+    const tmpThreadId = window.localStorage.getItem('tmpThreadId')
+    window.location.href = `https://defragroup.eu.qualtrics.com/jfe/form/SV_8dgFSJcxxIfqx5Y?Id=${tmpThreadId}&Source=${window.location.href}`
+    window.localStorage.removeItem('tmpThreadId')
+  }
+
+  const feedbackClose = async e => {
+    window.localStorage.removeItem('tmpThreadId')
+    onCancel(e)
+  }
+
+  const handleKeyPress = e => {
+    if (e.key === 'Enter' || e.key === ' ') {
+      if (e.target.id === 'feedback-close') {
+        feedbackClose(e)
+      }
+      if (e.target.id === 'feedback-send') {
+        feedbackSend()
+      }
+    }
+  }
+
+  return (
+    <>
+      <PanelHeader />
+
+      <div className='wc-body'>
+        <div className='wc-content'>
+          <h3 id='wc-subtitle' className='wc-heading'>Give feedback on Floodline webchat</h3>
+          <p>We're running webchat as a trial. you can&nbsp;
+            <a
+              id='feedback-send'
+              className='govuk-link'
+              href='#'
+              target='_blank'
+              rel='noreferrer'
+              onKeyDown={handleKeyPress}
+              onClick={feedbackSend}
+            >
+              give feedback
+            </a>
+            &nbsp;to help us improve it.
+          </p>
+          <p>
+            <a
+              id='feedback-close'
+              className='wc-link govuk-link'
+              href='#'
+              data-module='govuk-button'
+              role='button'
+              onKeyDown={handleKeyPress}
+              onClick={feedbackClose}
+            >
+              Close
+            </a>
+          </p>
+        </div>
+      </div>
+    </>
+  )
+}

package/src/client/components/screens/pre-chat.jsx

@@ -1,42 +1,62 @@
 import React from 'react'
+import { PanelHeader } from '../panel/panel-header.jsx'
 
-export function PreChat ({ screen, setScreen }) {
-  const onContinue = (e) => {
-    e.preventDefault()
-    setScreen(screen + 1)
-  }
-
+export function PreChat ({ onContinue }) {
   return (
     <>
-      <h3 className='govuk-heading-s'>What you can use webchat for</h3>
-      <p className='govuk-body-s'>Webchat lets you talk directly to a Floodline adviser.</p>
+      <PanelHeader />
 
-      <p className='govuk-body-s'>You can use webchat to get:</p>
-      <ul className='govuk-list govuk-list--bullet govuk-body-s'>
-        <li>current flood warnings and alerts in your area</li>
-        <li>information on the flood warning service</li>
-        <li>advice on what to do before, during and after a flood</li>
-      </ul>
+      <div className='wc-body'>
+        <div className='wc-content'>
+          <h3 id='wc-subtitle' className='wc-heading' aria-live='polite'>What you can use webchat for</h3>
+          <p>Webchat lets you talk directly to a Floodline adviser.</p>
 
-      <p className='govuk-body-s'>There are other ways to <a className='govuk-link' href='https://www.gov.uk/sign-up-for-flood-warnings'>sign up for flood warnings</a> and <a className='govuk-link' href='https://www.fws.environment-agency.gov.uk/app/olr/login'>manage your flood warnings account</a>.</p>
-      <p className='govuk-body-s'>Do not use webchat to <a className='govuk-link' href='https://www.gov.uk/report-flood-cause'>report a flood</a>.</p>
+          <p>You can use webchat to get:</p>
+          <ul className='wc-list'>
+            <li>current flood warnings and alerts in your area</li>
+            <li>information on the flood warning service</li>
+            <li>advice on what to do before, during and after a flood</li>
+          </ul>
+          <p>
+            There are other ways to&nbsp;
+            <a className='govuk-link' href='https://www.gov.uk/sign-up-for-flood-warnings' target='_blank' rel='noreferrer'>
+              sign up for flood warnings
+            </a>
+            &nbsp;and&nbsp;
+            <a className='govuk-link' href='https://www.fws.environment-agency.gov.uk/app/olr/login' target='_blank' rel='noreferrer'>
+              manage your flood warnings account
+            </a>.
+          </p>
+          <p>
+            Do not use webchat to&nbsp;
+            <a
+              className='govuk-link'
+              href='https://www.gov.uk/report-flood-cause'
+              target='_blank'
+              rel='noreferrer'
+            >
+              report a flood
+            </a>.
+          </p>
 
-      <button className='govuk-button' data-module='govuk-button' onClick={onContinue}>Continue</button>
+          <button className='govuk-button wc-button govuk-!-margin-top-1' data-module='govuk-button' onClick={onContinue}>Continue</button>
 
-      <h3 className='govuk-heading-s'>Other flood information</h3>
+          <h3 className='wc-heading'>Other flood information</h3>
 
-      <p className='govuk-body-s'>Call Floodline for all other flood and flood warning information.</p>
-      <p className='govuk-body-s'>
-        <strong>Floodline helpline</strong>
-        <br />
-        Telephone: 0345 988 1188
-        <br />
-        Textphone: 0345 602 6340
-        <br />
-        Open 24 hours a day, 7 days a week
-        <br />
-        <a className='govuk-link' href='https://gov.uk/call-charges'>Find out more about call charges</a>
-      </p>
+          <p>Call Floodline for all other flood and flood warning information.</p>
+          <p>
+            <strong>Floodline helpline</strong>
+            <br />
+            Telephone: 0345 988 1188
+            <br />
+            Textphone: 0345 602 6340
+            <br />
+            Open 24 hours a day, 7 days a week
+            <br />
+            <a className='govuk-link' href='https://gov.uk/call-charges' target='_blank' rel='noreferrer'>Find out more about call charges</a>
+          </p>
+        </div>
+      </div>
     </>
   )
 }