|
| 1 | +/* |
| 2 | + * If not stated otherwise in this file or this component's LICENSE file the |
| 3 | + * following copyright and licenses apply: |
| 4 | + * |
| 5 | + * Copyright 2020 Metrological |
| 6 | + * |
| 7 | + * Licensed under the Apache License, Version 2.0 (the License); |
| 8 | + * you may not use this file except in compliance with the License. |
| 9 | + * You may obtain a copy of the License at |
| 10 | + * |
| 11 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 12 | + * |
| 13 | + * Unless required by applicable law or agreed to in writing, software |
| 14 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 15 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 16 | + * See the License for the specific language governing permissions and |
| 17 | + * limitations under the License. |
| 18 | + */ |
| 19 | + |
| 20 | +import Speech from './Speech.js' |
| 21 | +import { debounce, getElmName } from './utils.js' |
| 22 | + |
| 23 | +const defaultOptions = { |
| 24 | + voiceOutDelay: 500, |
| 25 | + announcerFocusDebounce: 400, |
| 26 | + announcerTimeout: 5 * 60 * 1000, //Five Minutes |
| 27 | +} |
| 28 | + |
| 29 | +export default function Announcer(Base, speak = Speech, announcerOptions = {}) { |
| 30 | + const options = { ...defaultOptions, ...announcerOptions } |
| 31 | + |
| 32 | + return class extends Base { |
| 33 | + _construct() { |
| 34 | + this._debounceAnnounceFocusChanges = debounce( |
| 35 | + this._announceFocusChanges.bind(this), |
| 36 | + options.announcerFocusDebounce |
| 37 | + ) |
| 38 | + |
| 39 | + this._resetFocusTimer = debounce(() => { |
| 40 | + // Reset focus path for full announce |
| 41 | + this._lastFocusPath = undefined |
| 42 | + }, options.announcerTimeout) |
| 43 | + |
| 44 | + // Lightning only calls Focus Change on second focus |
| 45 | + this._focusChange() |
| 46 | + } |
| 47 | + |
| 48 | + _voiceOut(toSpeak) { |
| 49 | + if (this._voiceOutDisabled) { |
| 50 | + return |
| 51 | + } |
| 52 | + |
| 53 | + const speech = speak(toSpeak) |
| 54 | + // event using speech synthesis api promise |
| 55 | + if (speech && speech.series) { |
| 56 | + speech.series.then(() => { |
| 57 | + this.stage.emit('announceEnded') |
| 58 | + }) |
| 59 | + } |
| 60 | + |
| 61 | + // event in case speech synthesis api is flakey, |
| 62 | + // assume the ammount of time it takes to read each word |
| 63 | + const toAnnounceStr = Array.isArray(toSpeak) ? toSpeak.concat().join(' ') : toSpeak |
| 64 | + const toAnnounceWords = toAnnounceStr.split(' ') |
| 65 | + const timeoutDelay = toAnnounceWords.length * options.voiceOutDelay |
| 66 | + clearTimeout(this._announceEndedTimeout) |
| 67 | + this._announceEndedTimeout = setTimeout(() => { |
| 68 | + this.stage.emit('announceTimeoutEnded') |
| 69 | + }, timeoutDelay) |
| 70 | + |
| 71 | + return speech |
| 72 | + } |
| 73 | + |
| 74 | + _disable() { |
| 75 | + clearTimeout(this._announceEndedTimeout) |
| 76 | + this.stage.emit('announceEnded') |
| 77 | + this.stage.emit('announceTimeoutEnded') |
| 78 | + } |
| 79 | + |
| 80 | + set announcerEnabled(val) { |
| 81 | + this._announcerEnabled = val |
| 82 | + this._focusChange() |
| 83 | + } |
| 84 | + |
| 85 | + get announcerEnabled() { |
| 86 | + return this._announcerEnabled |
| 87 | + } |
| 88 | + |
| 89 | + _focusChange() { |
| 90 | + if (!this._resetFocusTimer) { |
| 91 | + return |
| 92 | + } |
| 93 | + |
| 94 | + this._resetFocusTimer() |
| 95 | + this.$announcerCancel() |
| 96 | + this._debounceAnnounceFocusChanges() |
| 97 | + } |
| 98 | + |
| 99 | + _announceFocusChanges() { |
| 100 | + const focusPath = this.application.focusPath || [] |
| 101 | + const lastFocusPath = this._lastFocusPath || [] |
| 102 | + const loaded = focusPath.every(elm => !elm.loading) |
| 103 | + const focusDiff = focusPath.filter(elm => !lastFocusPath.includes(elm)) |
| 104 | + |
| 105 | + if (!loaded) { |
| 106 | + this._debounceAnnounceFocusChanges() |
| 107 | + return |
| 108 | + } |
| 109 | + |
| 110 | + this._lastFocusPath = focusPath.slice(0) |
| 111 | + // Provide hook for focus diff for things like TextBanner |
| 112 | + this.focusDiffHook = focusDiff |
| 113 | + |
| 114 | + if (!this.announcerEnabled) { |
| 115 | + return |
| 116 | + } |
| 117 | + |
| 118 | + let toAnnounce = focusDiff.reduce((acc, elm) => { |
| 119 | + if (elm.announce) { |
| 120 | + acc.push([getElmName(elm), 'Announce', elm.announce]) |
| 121 | + } else if (elm.title) { |
| 122 | + acc.push([getElmName(elm), 'Title', elm.title || '']) |
| 123 | + } |
| 124 | + return acc |
| 125 | + }, []) |
| 126 | + |
| 127 | + focusDiff.reverse().reduce((acc, elm) => { |
| 128 | + if (elm.announceContext) { |
| 129 | + acc.push([getElmName(elm), 'Context', elm.announceContext]) |
| 130 | + } else { |
| 131 | + acc.push([getElmName(elm), 'No Context', '']) |
| 132 | + } |
| 133 | + return acc |
| 134 | + }, toAnnounce) |
| 135 | + |
| 136 | + if (this.debug) { |
| 137 | + console.table(toAnnounce) |
| 138 | + } |
| 139 | + |
| 140 | + toAnnounce = toAnnounce.reduce((acc, a) => { |
| 141 | + const txt = a[2] |
| 142 | + txt && acc.push(txt) |
| 143 | + return acc |
| 144 | + }, []) |
| 145 | + |
| 146 | + if (toAnnounce.length) { |
| 147 | + this.$announcerCancel() |
| 148 | + this._currentlySpeaking = this._voiceOut( |
| 149 | + toAnnounce.reduce((acc, val) => acc.concat(val), []) |
| 150 | + ) |
| 151 | + } |
| 152 | + } |
| 153 | + |
| 154 | + $announce(toAnnounce, { append = false, notification = false } = {}) { |
| 155 | + if (this.announcerEnabled) { |
| 156 | + this._debounceAnnounceFocusChanges.flush() |
| 157 | + if (append && this._currentlySpeaking && this._currentlySpeaking.active) { |
| 158 | + this._currentlySpeaking.append(toAnnounce) |
| 159 | + } else { |
| 160 | + this.$announcerCancel() |
| 161 | + this._currentlySpeaking = this._voiceOut(toAnnounce) |
| 162 | + } |
| 163 | + |
| 164 | + if (notification) { |
| 165 | + this._voiceOutDisabled = true |
| 166 | + this._currentlySpeaking.series.finally(() => { |
| 167 | + this._voiceOutDisabled = false |
| 168 | + this.$announcerRefresh() |
| 169 | + }) |
| 170 | + } |
| 171 | + } |
| 172 | + } |
| 173 | + |
| 174 | + $announcerCancel() { |
| 175 | + this._currentlySpeaking && this._currentlySpeaking.cancel() |
| 176 | + } |
| 177 | + |
| 178 | + $announcerRefresh(depth = 0) { |
| 179 | + this._lastFocusPath = this._lastFocusPath.slice(0, depth) |
| 180 | + this._resetFocusTimer() |
| 181 | + this._focusChange() |
| 182 | + } |
| 183 | + } |
| 184 | +} |
0 commit comments