@lightningjs/blits 1.30.2 → 1.31.0

package/src/announcer/speechSynthesis.js

@@ -1,107 +1,107 @@
-/*
- * Copyright 2024 Comcast Cable Communications Management, LLC
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import { Log } from '../lib/log.js'
-
-const syn = window.speechSynthesis
-
-const isAndroid = /android/i.test((window.navigator || {}).userAgent || '')
-
-let initialized = false
-let infinityTimer = null
-const clear = () => infinityTimer && clearTimeout(infinityTimer)
-
-const resumeInfinity = (target) => {
-  if (!target || infinityTimer) {
-    return clear()
-  }
-
-  syn.pause()
-  syn.resume()
-
-  infinityTimer = setTimeout(() => {
-    resumeInfinity(target)
-  }, 5000)
-}
-
-const defaultUtteranceProps = {
-  lang: 'en-US',
-  pitch: 1,
-  rate: 1,
-  voice: null,
-  volume: 1,
-}
-
-const initialize = () => {
-  defaultUtteranceProps.voice = syn.getVoices()[0]
-  initialized = true
-}
-
-const speak = (options) => {
-  const utterance = new SpeechSynthesisUtterance(options.message)
-
-  utterance.lang = options.lang || defaultUtteranceProps.lang
-  utterance.pitch = options.pitch || defaultUtteranceProps.pitch
-  utterance.rate = options.rate || defaultUtteranceProps.rate
-  utterance.voice = options.voice || defaultUtteranceProps.voice
-  utterance.volume = options.volume || defaultUtteranceProps.volume
-
-  if (isAndroid === false) {
-    utterance.onstart = () => {
-      resumeInfinity(utterance)
-    }
-
-    utterance.onresume = () => {
-      resumeInfinity(utterance)
-    }
-  }
-
-  return new Promise((resolve, reject) => {
-    utterance.onend = () => {
-      resolve()
-    }
-    utterance.onerror = (e) => {
-      reject(e)
-    }
-
-    syn.speak(utterance)
-  })
-}
-
-export default {
-  speak(options) {
-    if (syn !== undefined) {
-      if (initialized === false) {
-        initialize()
-      }
-      return speak(options)
-    } else {
-      Log.error('speechSynthesis web API not available')
-      return Promise.reject({ error: 'unavailable' })
-    }
-  },
-  cancel() {
-    if (syn !== undefined) {
-      syn.cancel()
-      clear()
-    }
-  },
-  // @todo
-  // getVoices() {
-  //   return syn.getVoices()
-  // },
-}
+/*
+ * Copyright 2024 Comcast Cable Communications Management, LLC
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { Log } from '../lib/log.js'
+
+const syn = window.speechSynthesis
+
+const isAndroid = /android/i.test((window.navigator || {}).userAgent || '')
+
+let initialized = false
+let infinityTimer = null
+const clear = () => infinityTimer && clearTimeout(infinityTimer)
+
+const resumeInfinity = (target) => {
+  if (!target || infinityTimer) {
+    return clear()
+  }
+
+  syn.pause()
+  syn.resume()
+
+  infinityTimer = setTimeout(() => {
+    resumeInfinity(target)
+  }, 5000)
+}
+
+const defaultUtteranceProps = {
+  lang: 'en-US',
+  pitch: 1,
+  rate: 1,
+  voice: null,
+  volume: 1,
+}
+
+const initialize = () => {
+  defaultUtteranceProps.voice = syn.getVoices()[0]
+  initialized = true
+}
+
+const speak = (options) => {
+  const utterance = new SpeechSynthesisUtterance(options.message)
+
+  utterance.lang = options.lang || defaultUtteranceProps.lang
+  utterance.pitch = options.pitch || defaultUtteranceProps.pitch
+  utterance.rate = options.rate || defaultUtteranceProps.rate
+  utterance.voice = options.voice || defaultUtteranceProps.voice
+  utterance.volume = options.volume || defaultUtteranceProps.volume
+
+  if (isAndroid === false) {
+    utterance.onstart = () => {
+      resumeInfinity(utterance)
+    }
+
+    utterance.onresume = () => {
+      resumeInfinity(utterance)
+    }
+  }
+
+  return new Promise((resolve, reject) => {
+    utterance.onend = () => {
+      resolve()
+    }
+    utterance.onerror = (e) => {
+      reject(e)
+    }
+
+    syn.speak(utterance)
+  })
+}
+
+export default {
+  speak(options) {
+    if (syn !== undefined) {
+      if (initialized === false) {
+        initialize()
+      }
+      return speak(options)
+    } else {
+      Log.error('speechSynthesis web API not available')
+      return Promise.reject({ error: 'unavailable' })
+    }
+  },
+  cancel() {
+    if (syn !== undefined) {
+      syn.cancel()
+      clear()
+    }
+  },
+  // @todo
+  // getVoices() {
+  //   return syn.getVoices()
+  // },
+}

package/src/application.js

@@ -1,100 +1,100 @@
-/*
- * Copyright 2023 Comcast Cable Communications Management, LLC
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import Component from './component.js'
-import { default as Focus, keyUpCallbacks } from './focus.js'
-import Settings from './settings.js'
-
-import symbols from './lib/symbols.js'
-import { DEFAULT_HOLD_TIMEOUT_MS } from './constants.js'
-
-const Application = (config) => {
-  const defaultKeyMap = {
-    ArrowLeft: 'left',
-    ArrowRight: 'right',
-    ArrowUp: 'up',
-    ArrowDown: 'down',
-    Enter: 'enter',
-    ' ': 'space',
-    Backspace: 'back',
-    Escape: 'escape',
-    37: 'left',
-    39: 'right',
-    38: 'up',
-    40: 'down',
-    13: 'enter',
-    32: 'space',
-    8: 'back',
-    27: 'escape',
-  }
-
-  config.hooks = config.hooks || {}
-
-  let keyDownHandler
-  let keyUpHandler
-  let holdTimeout
-
-  config.hooks[symbols.destroy] = function () {
-    document.removeEventListener('keydown', keyDownHandler)
-    document.removeEventListener('keyup', keyUpHandler)
-  }
-
-  config.hooks[symbols.init] = function () {
-    // set the initial activation state of the announcer based on launch setting
-    this.$announcer.toggle(Settings.get('announcer', false))
-    const keyMap = { ...defaultKeyMap, ...Settings.get('keymap', {}) }
-
-    keyDownHandler = async (e) => {
-      const key = keyMap[e.key] || keyMap[e.keyCode] || e.key || e.keyCode
-      // intercept key press if specified in main Application component
-      if (
-        this[symbols.inputEvents] !== undefined &&
-        this[symbols.inputEvents].intercept !== undefined
-      ) {
-        e = await this[symbols.inputEvents].intercept.call(this, e)
-        // only pass on the key press to focused component when keyboard event is returned
-        if (e instanceof KeyboardEvent === false) return
-      }
-
-      Focus.input(key, e)
-      clearTimeout(holdTimeout)
-      holdTimeout = setTimeout(() => {
-        Focus.hold = true
-      }, Settings.get('holdTimeout', DEFAULT_HOLD_TIMEOUT_MS))
-    }
-
-    keyUpHandler = (e) => {
-      const cb = keyUpCallbacks.get(e.code)
-      if (cb !== undefined && typeof cb === 'function') {
-        keyUpCallbacks.delete(e.code)
-        cb()
-      }
-      clearTimeout(holdTimeout)
-      Focus.hold = false
-    }
-
-    document.addEventListener('keydown', keyDownHandler)
-    document.addEventListener('keyup', keyUpHandler)
-
-    // next tick
-    setTimeout(() => Focus.set(this))
-  }
-
-  return Component('App', config)
-}
-
-export default Application
+/*
+ * Copyright 2023 Comcast Cable Communications Management, LLC
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import Component from './component.js'
+import { default as Focus, keyUpCallbacks } from './focus.js'
+import Settings from './settings.js'
+
+import symbols from './lib/symbols.js'
+import { DEFAULT_HOLD_TIMEOUT_MS } from './constants.js'
+
+const Application = (config) => {
+  const defaultKeyMap = {
+    ArrowLeft: 'left',
+    ArrowRight: 'right',
+    ArrowUp: 'up',
+    ArrowDown: 'down',
+    Enter: 'enter',
+    ' ': 'space',
+    Backspace: 'back',
+    Escape: 'escape',
+    37: 'left',
+    39: 'right',
+    38: 'up',
+    40: 'down',
+    13: 'enter',
+    32: 'space',
+    8: 'back',
+    27: 'escape',
+  }
+
+  config.hooks = config.hooks || {}
+
+  let keyDownHandler
+  let keyUpHandler
+  let holdTimeout
+
+  config.hooks[symbols.destroy] = function () {
+    document.removeEventListener('keydown', keyDownHandler)
+    document.removeEventListener('keyup', keyUpHandler)
+  }
+
+  config.hooks[symbols.init] = function () {
+    // set the initial activation state of the announcer based on launch setting
+    this.$announcer.toggle(Settings.get('announcer', false))
+    const keyMap = { ...defaultKeyMap, ...Settings.get('keymap', {}) }
+
+    keyDownHandler = async (e) => {
+      const key = keyMap[e.key] || keyMap[e.keyCode] || e.key || e.keyCode
+      // intercept key press if specified in main Application component
+      if (
+        this[symbols.inputEvents] !== undefined &&
+        this[symbols.inputEvents].intercept !== undefined
+      ) {
+        e = await this[symbols.inputEvents].intercept.call(this, e)
+        // only pass on the key press to focused component when keyboard event is returned
+        if (e instanceof KeyboardEvent === false) return
+      }
+
+      Focus.input(key, e)
+      clearTimeout(holdTimeout)
+      holdTimeout = setTimeout(() => {
+        Focus.hold = true
+      }, Settings.get('holdTimeout', DEFAULT_HOLD_TIMEOUT_MS))
+    }
+
+    keyUpHandler = (e) => {
+      const cb = keyUpCallbacks.get(e.code)
+      if (cb !== undefined && typeof cb === 'function') {
+        keyUpCallbacks.delete(e.code)
+        cb()
+      }
+      clearTimeout(holdTimeout)
+      Focus.hold = false
+    }
+
+    document.addEventListener('keydown', keyDownHandler)
+    document.addEventListener('keyup', keyUpHandler)
+
+    // next tick
+    setTimeout(() => Focus.set(this))
+  }
+
+  return Component('App', config)
+}
+
+export default Application

package/src/component/base/announcer.js

@@ -1,27 +1,27 @@
-/*
- * Copyright 2024 Comcast Cable Communications Management, LLC
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import Announcer from '../../announcer/announcer.js'
-
-export default {
-  $announcer: {
-    value: Announcer,
-    writable: false,
-    enumerable: true,
-    configurable: false,
-  },
-}
+/*
+ * Copyright 2024 Comcast Cable Communications Management, LLC
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import Announcer from '../../announcer/announcer.js'
+
+export default {
+  $announcer: {
+    value: Announcer,
+    writable: false,
+    enumerable: true,
+    configurable: false,
+  },
+}

package/src/component/base/events.js

@@ -1,69 +1,69 @@
-/*
- * Copyright 2024 Comcast Cable Communications Management, LLC
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import eventListeners from '../../lib/eventListeners.js'
-
-export default {
-  /**
-   * Emits an event to all registered listeners for the given event name.
-   *
-   * @param {string} event - The name of the event to emit.
-   * @param {any} params - The parameters to pass to the event listeners.
-   * @returns {boolean} True if all listeners executed, false otherwise.
-   */
-  $emit: {
-    value: function (event, params) {
-      // returning if all listeners executed
-      return eventListeners.executeListeners(event, params)
-    },
-    writable: false,
-    enumerable: true,
-    configurable: false,
-  },
-  /**
-   * Registers a listener callback for a specific event.
-   *
-   * @param {string} event - The name of the event to listen for.
-   * @param {Function} callback - The callback function to execute when the event is emitted.
-   * @param {number} [priority=0] - The priority of the listener (higher runs first).
-   * @returns {void}
-   */
-  $listen: {
-    value: function (event, callback, priority = 0) {
-      // early exit when component is marked as end of life
-      if (this.eol === true) return
-      eventListeners.registerListener(this, event, callback, priority)
-    },
-    writable: false,
-    enumerable: true,
-    configurable: false,
-  },
-  /**
-   * Deregisters a listener for a specific event.
-   *
-   * @param {string} event - The name of the event to stop listening for.
-   * @returns {void}
-   */
-  $unlisten: {
-    value: function (event) {
-      eventListeners.deregisterListener(this, event)
-    },
-    writable: false,
-    enumerable: true,
-    configurable: false,
-  },
-}
+/*
+ * Copyright 2024 Comcast Cable Communications Management, LLC
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import eventListeners from '../../lib/eventListeners.js'
+
+export default {
+  /**
+   * Emits an event to all registered listeners for the given event name.
+   *
+   * @param {string} event - The name of the event to emit.
+   * @param {any} params - The parameters to pass to the event listeners.
+   * @returns {boolean} True if all listeners executed, false otherwise.
+   */
+  $emit: {
+    value: function (event, params) {
+      // returning if all listeners executed
+      return eventListeners.executeListeners(event, params)
+    },
+    writable: false,
+    enumerable: true,
+    configurable: false,
+  },
+  /**
+   * Registers a listener callback for a specific event.
+   *
+   * @param {string} event - The name of the event to listen for.
+   * @param {Function} callback - The callback function to execute when the event is emitted.
+   * @param {number} [priority=0] - The priority of the listener (higher runs first).
+   * @returns {void}
+   */
+  $listen: {
+    value: function (event, callback, priority = 0) {
+      // early exit when component is marked as end of life
+      if (this.eol === true) return
+      eventListeners.registerListener(this, event, callback, priority)
+    },
+    writable: false,
+    enumerable: true,
+    configurable: false,
+  },
+  /**
+   * Deregisters a listener for a specific event.
+   *
+   * @param {string} event - The name of the event to stop listening for.
+   * @returns {void}
+   */
+  $unlisten: {
+    value: function (event) {
+      eventListeners.deregisterListener(this, event)
+    },
+    writable: false,
+    enumerable: true,
+    configurable: false,
+  },
+}

package/src/component/base/index.js

@@ -1,33 +1,33 @@
-/*
- * Copyright 2024 Comcast Cable Communications Management, LLC
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- *
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import methods from './methods.js'
-import scheduling from './timeouts_intervals.js'
-import events from './events.js'
-import router from './router.js'
-import announcer from './announcer.js'
-import utils from './utils.js'
-import symbols from '../../lib/symbols.js'
-
-export const shared = { ...events, ...router, ...announcer }
-
-export default Object.defineProperties(
-  {
-    [symbols['launched']]: false,
-  },
-  { ...methods, ...scheduling, ...shared, ...utils }
-)
+/*
+ * Copyright 2024 Comcast Cable Communications Management, LLC
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import methods from './methods.js'
+import scheduling from './timeouts_intervals.js'
+import events from './events.js'
+import router from './router.js'
+import announcer from './announcer.js'
+import utils from './utils.js'
+import symbols from '../../lib/symbols.js'
+
+export const shared = { ...events, ...router, ...announcer }
+
+export default Object.defineProperties(
+  {
+    [symbols['launched']]: false,
+  },
+  { ...methods, ...scheduling, ...shared, ...utils }
+)