Skip to content
This repository has been archived by the owner on Sep 3, 2024. It is now read-only.

Latest commit

 

History

History
executable file
·
400 lines (291 loc) · 12.3 KB

CHANGELOG.md

File metadata and controls

executable file
·
400 lines (291 loc) · 12.3 KB

Teneo Web Chat - Changelog

v3.7.12 - Final Release

Important

This project has been retired and archived - this is the final release

May 2024

  • Supports MS Cognitive Speech if configured - and falls back to web speech if not
  • Additional parameters (eg. title, description) will again be read by the TTS
  • ASR Start / End sounds re-added
  • Allows for custom ASR / TTS integrations via the ASR / TTS events
  • Validation against normalised JSON Message schema
  • Supports normalised and legacy table message formats

Note

This release includes validation against a normalised JSON message schema. A JSON Schema document built from the message formats documented on teneo.ai.

  • In TWC v.3.7.11 an additional (undocumented) { data: { ... } } layer is required in the table or table-in-combo messages
  • v3.7.12 will now support either the documented or legacy forms in order to allow a smoother transition when preparing solutions for use with Teneo Web Widget

v3.7.11

March 2024

  • CSS refactoring
    • Review of hardcoded values and substitution for variables.
  • Carousel Bug:
    • Touch scrolling in Carousel.
  • Features:
    • TTS/ASR with WebSpeechAPI integration.
  • Bug Fixes
    • Rating message refactoring. Using maxValue message prop.
    • Solve long Messages overflow. Using word-break CSS property

v3.7.10

December-2023

  • Bug Fixes

    • Auto-scroll not working not scrolling all the way to the last message.

    • Replaced the scope of the following components

      • AudioMessage
      • Carousel Message
      • File Video Message
      • Form Message
      • Link Preview Message
      • Modal File
      • Modal Message
      • Quick Reply Message
      • System Message
      • Table Message
      • Typing Message
      • Upload Message
      • Vimeo Video Message
      • YouTube Video Message

    • Handle Output Hyperlink field for the Teneo response.

v3.7.9

October-2023

  • Bug Fixes
    • Auto-scroll not working if a bubble without additional parameters.
    • Hardcoded elements for upload file feature now configurable.
    • Scroll reset button as default.
    • Upload Panel Feature
      • Spellcheck in upload panel text.
      • Keyboard visibility issue on mobile.
      • Upload elements lose state after minimize.
      • Upload button outside drop area.
    • Target blank attributes added to link buttons.
    • Rating Message doesn't appear centered and distributed.
    • Placeholder property for textarea added.

v3.7.8

July-2023

  • Bug Fixes
    • Message does not scroll down automatically.
    • Carousel Scrolling Bug with Arrows.
    • Carousel Bug when Switching Cards.
    • ASR microphone button behaving erratically.
    • Hiding User input when upload panel is displayed.

v3.7.7

June-2023

  • Features

    • Attachment Messages.
    • Rating Messages.

  • CSS Refactoring

    • Attachment panel CSS
    • Uploading buttons CSS and new Colors
    • Card Message CSS
    • Carousel CSS
    • Upload Panel CSS

  • Bug Fixes

    • Attach from Camera in iOS closes FrontEnd.
    • Output is read simultaneously twice.
    • Attachments Feature.
    • IPhone Scrolling Bug.

v3.7.6

13-01-2023

  • Fixed expired buttons bug.

v3.7.5

17-11-2022

  • Fixed bug SDSA-225.
  • Sanitize user input on chat.

v3.7.4

21-03-2021

  • Enlarge images upon clicks in combo messages
  • Fixed a bug in the extensions framework preventing the assignment of multiple listeners to an event.

v3.7.3

18-01-2022

  • Bug fixes

v3.7.2

08-11-2021

  • Updated Dependencies
  • Fixed bug with .messages

v3.7.1

15-09-2021

  • Updated TIE-API to work with SaaS Platform
  • Fixed bug with .messages

v3.6.2

22-07-2021

  • Implemented voice selection in store and API. Better warnings and disabling ASR in insecure contexts.
  • Fixed issues with auto ASR and multiple bubbles
  • Added message type for table
  • Added message type for forms
  • Fixed carousel swiping issue
  • Sets ASR/TTS buttons to broken if error is encountered

v3.6.1

09-06-2021

  • Automatic ASR disabled after the first time it has been canceled
  • Detects when connection to backend server fails with error handler added
  • TTS now reads system messages
  • ASR and TTS can now be canceled

v3.6.0

05-05-2021

  • Fix reset title icon issue
  • Implemented ASR and TTS with Microsoft Azure Speech services as default provider, with other providers available through extensions

v3.5.0

21-01-2021

  • Allow html in body of cards
  • Added api's to display an upload button next to the send icon. An extension can then be used to handle the 'on upload_button_clicked' click event. The following api's were added to support this:
    • call set_upload_icon
    • call reset_upload_icon
    • call show_upload_button
    • call hide_upload_button
    • call disable_upload_button
    • call enable_upload_button
    • on upload_button_clicked

v3.4.0

07-01-2021

  • Added new api to add a callout message to the launch button to catch the web visitor's attention
  • Added new callback api 'reset' to intercept chat window reset events
  • Images can now be enlarged
  • Added css variables for lightbox colors used for enlarged images
  • When icons and window title are reset using the api, reset to init value instead of teneo web chat default value
  • Added config option to allow use of localStorage instead of sessionStorage
  • Added api to get the storage object
  • Added api to get locale
  • Use dedicated css variables for typing indicators
  • Use css variable for modal background color
  • Use Chinese Traditional if locale is set to just 'cn'
  • Added id's to teneo web chat container and send icon
  • Fix font size in Safari on macOS Big Sur
  • Fix issue with launch button and chat window dropping behind some layers
  • Fix URL validation issue

v3.3.0

9-11-2020

  • New: UI can be configured in multiple languages
  • New: Added option to add custom translations
  • Accessibility improvements
  • Minor bugfixes

v3.2.0

27-10-2020

  • New message type: Link buttons
  • New configuration setting: sendIconUrl
  • New api's: Set send icon and Reset send icon
  • New api: On send button clicked
  • New api: Set engine URL
  • Improved accessibility
  • Added 'twc-' prefix to the following classes:
    • active -> twc-active
    • disabled -> twc-disabled
    • expired -> twc-expired
    • selected -> twc-selected
    • bot -> twc-bot
    • user - twc-user
    • agent - twc-agent
  • Launch button now has an additional class 'twc-minimized' or 'twc-closed', depending on whether the window was minimized or closed.

For more details on the styles used by Teneo Web Chat, see the new page Styling Teneo Web Chat.

Note: as of this version, link_items in cards are deprecated. They still work but will be removed in the next major release of Teneo Web Chat. If your solution uses cards with link_items, please update them to use linkbutton_items instead.

v3.1.0

23-09-2020

  • Buttons, quick replies and clickable lists can now include engine input parameters
  • Added API-call 'Set chat window icon'
  • Reworked unit tests to use jest instead of mocha
  • Updated dependencies and removed obsolete dependencies

v3.0.1

09-09-2020

  • Support Dynamic Type on iOS - Font size in Teneo Web Chat will depend on Dynamic Type setting in iOS
  • Fixed a bug where session was not properly maintained in Safari
  • Improved keyboard handling on iOS

v3.0.0

02-09-2020

Caution

THIS VERSION CONTAINS BREAKING CHANGES

  • The file name of the Teneo Web Chat has been changed from main.js to teneo-web-chat.js.
  • CSS styles used by Teneo Web Chat are now prefixed with twc-. If you modified the look & feel by overriding the Teneo Web Chat CSS styles, you may need to rename some styles.
  • The code to embed Teneo Web Chat in your site has changed. When updating, make sure you update the embed code on all pages where Teneo Web Chat is made available.

NEW FEATURES

  • Javascript API
  • New message type 'Modal'
  • New message type 'System message'
  • Option to show both a minimize and close button in header
  • Text messages can now contain an avatar icon and a date line
  • Support for message author type 'agent' (in addition to the already existing author types 'bot' and 'user')
  • Support for typing indicators

JAVASCRIPT API

The new Teneo Web Chat Javascript API allows you to trigger Teneo Web Chat events, respond to events that happen inside Teneo Web Chat and get details from Teneo Web Chat. This lets you change or extend its behavior in ways that are not provided by the standard configuration.

  • Trigger events
    • Maximize
    • Minimize
    • Send input
    • End session
    • Clear chat history
    • Reset
    • Add message
    • Show typing indicator
    • Hide typing indicator
    • Set chat window title
    • Disable user input
    • Enable user input
  • Subscribe to events
    • On ready
    • On open button clicked
    • On minimize button clicked
    • On close button clicked
    • On visibility changed
    • On user typing
    • On input submitted
    • On message button clicked
    • On engine request
    • On engine response
    • On new message
  • Getters
    • Get state
    • Get message list
    • Get engine URL

IMPROVEMENTS AND FIXES

  • Icons used in the UI can now be configured
  • Improved support for iOS
  • Fix error in console about scrolling
  • Fix scrolling issue when displaying large images
  • Fix layout of buttons with long text
  • Streamlined initialization parameters
  • Updated dependencies

v2.5.1

17-06-2020

  • Fix: don't show scrolling animation when reopening chat window but start at bottom instantly
  • Improvement: show spinner after clicking buttons, quick replies etc

v2.5.0

10-06-2020

  • Support for splitting output into multiple text bubbles
  • Updated dependencies

v2.4.0

27-05-2020

  • Showing spinner while waiting for engine response
  • Updated dependencies

v2.3.0

25-05-2020

  • The chat window can now be reset programmatically, by calling the resetChat() function

v2.2.0

15-05-2020

  • IE11 support

v2.1.0

16-04-2020

  • Added new component for Audio playback
  • Ignore line breaks in answer texts
  • Gracefully handle invalid component JSON

v2.0.1

01-04-2020

  • Improved browser support
  • An optional map of parameters can now be included when Teneo Web Chat is initialized. These parameters will be included as input parameters in requests to engine
  • Minor UI improvements

v2.0.0

24-03-2020

  • Updated existing components/extensions and added many new components that can be used in the bot's response
    • Buttons
    • Cards
    • Clickable lists
    • Image
    • Quick replies
    • Videos (YouTube, Vimeo, mp4)
    • Combo (combine multiple of the above in a single response)
  • Updated header icon
  • Made header icon configurable
  • Updated dependencies

v1.1.0

22-08-2019

  • Improved

    • Added config option CLOSE_TIE_SESSION_ON_EXIT. If set to true, the Teneo Engine session will be killed when the chat UI is closed. Default setting is false.
    • Requests to the Teneo Engine now contain a parameter 'channel' with value 'teneo-webchat'

  • Fixed

    • Fixed .focus warnings