@lightningjs/blits 1.33.0 → 1.34.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+_10 Jul 2025_
+
+## v1.34.0
+
+- Added storage plugin
+- Improved test coverage
+- Fixed announcer plugin to work on RDK devices where early GC was happening
+- Added check to throttle only the same input key in a row
+- Updated docs on transitions
+- Added warning when using `hasFocus` in component state
+
 _08 Jul 2025_
 
 ## v1.33.0

package/NOTICE

@@ -10,3 +10,7 @@ within this component.
 This repository uses components from the Lightning-SDK. Any components from the Lightning-SDK are:
 Copyright (c) 2020 Metrological
 Licensed under the Apache License, Version 2.0
+
+This repository uses components from WebPlatformForEmbedded
+Copyright (c) 2019 Metrological
+Licensed under the Apache License, Version 2.0

package/index.d.ts

@@ -970,8 +970,10 @@ declare module '@lightningjs/blits' {
     /**
      * Input throttle time in milliseconds to prevent rapid successive inputs
      *
-     * Within the throttle window, only one input will be processed immediately  Subsequent
-     * inputs are ignored until the scheduled input is processed.
+     * Within the throttle window, only one input will be processed immediately.
+     * Subsequent inputs _of the same key_ are ignored until the scheduled input is processed.
+     *
+     * Pressing a different key will be processed immediately.
      *
      * Set to `0` to disable input throttling.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightningjs/blits",
-  "version": "1.33.0",
+  "version": "1.34.0",
   "description": "Blits: The Lightning 3 App Development Framework",
   "bin": "bin/index.js",
   "exports": {
@@ -13,7 +13,8 @@
     "./blitsFileConverter": "./src/lib/blitsfileconverter/blitsfileconverter.js"
   },
   "scripts": {
-    "test": "c8 npm run test:run",
+    "test": "c8 node scripts/runTests.js",
+    "test:ci": "c8 npm run test:run",
     "test:run": "node -r global-jsdom/register ./node_modules/.bin/tape '{,!(node_modules|packages)/**/}*.test.js' | tap-diff",
     "lint": "eslint '**/*.js'",
     "lint:fix": "eslint '**/*.js' --fix",
@@ -38,6 +39,7 @@
     "eslint": "^8.8.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
+    "fast-glob": "^3.3.3",
     "global-jsdom": "24.0.0",
     "husky": "^9.1.7",
     "jsdom": "24.0.0",

package/src/announcer/announcer.js

@@ -146,6 +146,7 @@ const stop = () => {
 }
 
 const clear = () => {
+  isProcessing = false
   queue.length = 0
 }
 

package/src/announcer/speechSynthesis.js

@@ -21,9 +21,17 @@ const syn = window.speechSynthesis
 
 const isAndroid = /android/i.test((window.navigator || {}).userAgent || '')
 
+const utterances = new Map() // Strong references with unique keys
+
 let initialized = false
 let infinityTimer = null
-const clear = () => infinityTimer && clearTimeout(infinityTimer)
+
+const clear = () => {
+  if (infinityTimer) {
+    clearTimeout(infinityTimer)
+    infinityTimer = null
+  }
+}
 
 const resumeInfinity = (target) => {
   if (!target || infinityTimer) {
@@ -31,7 +39,9 @@ const resumeInfinity = (target) => {
   }
 
   syn.pause()
-  syn.resume()
+  setTimeout(() => {
+    syn.resume()
+  }, 0)
 
   infinityTimer = setTimeout(() => {
     resumeInfinity(target)
@@ -47,18 +57,20 @@ const defaultUtteranceProps = {
 }
 
 const initialize = () => {
-  defaultUtteranceProps.voice = syn.getVoices()[0]
+  const voices = syn.getVoices()
+  defaultUtteranceProps.voice = voices[0] || null
   initialized = true
 }
 
 const speak = (options) => {
   const utterance = new SpeechSynthesisUtterance(options.message)
-
+  const id = Date.now() + Math.random() // Unique ID for tracking
   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
+  utterances.set(id, utterance) // Strong reference
 
   if (isAndroid === false) {
     utterance.onstart = () => {
@@ -72,9 +84,14 @@ const speak = (options) => {
 
   return new Promise((resolve, reject) => {
     utterance.onend = () => {
+      clear()
+      utterances.delete(id) // Cleanup
       resolve()
     }
+
     utterance.onerror = (e) => {
+      clear()
+      utterances.delete(id) // Cleanup
       reject(e)
     }
 

package/src/application.js

@@ -48,6 +48,7 @@ const Application = (config) => {
   let keyUpHandler
   let holdTimeout
   let lastInputTime = 0
+  let lastInputKey = null
 
   config.hooks[symbols.destroy] = function () {
     document.removeEventListener('keydown', keyDownHandler)
@@ -66,8 +67,11 @@ const Application = (config) => {
       const currentTime = performance.now()
 
       const key = keyMap[e.key] || keyMap[e.keyCode] || e.key || e.keyCode
+      const sameKey = lastInputKey === key
+      lastInputKey = key
       // execute immediately when no throttle is specified or event is internal (bubbled up by focus manager)
-      if (throttleMs === 0 || e[symbols.internalEvent] === true) {
+      // or key is different from the last used key
+      if (throttleMs === 0 || e[symbols.internalEvent] === true || sameKey === false) {
         return await processInput.call(this, e, key)
       }
 

package/src/component/setup/state.js

@@ -28,8 +28,14 @@ export default (component, state = () => {}) => {
   })
 
   const stateKeys = Object.keys(state.apply(component) || {})
-  // add built-in hasFocus key
-  stateKeys.push(['hasFocus'])
+  if (stateKeys.indexOf('hasFocus') > -1) {
+    Log.warn(
+      'State `hasFocus` already exists as a built-in Component variable (to indicate whether the component currently has focus). Avoid using your own `hasFocus` key in the Component state'
+    )
+  } else {
+    // add built-in hasFocus key
+    stateKeys.push(['hasFocus'])
+  }
   const stateKeysLength = stateKeys.length
 
   for (let i = 0; i < stateKeysLength; i++) {

package/src/plugins/index.js

@@ -18,3 +18,4 @@
 export { default as language } from './language.js'
 export { default as theme } from './theme.js'
 export { default as appState } from './appstate.js'
+export { default as storage } from './storage/storage.js'

package/src/plugins/storage/localCookie.js

@@ -0,0 +1,133 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2019 Metrological
+ *
+ * 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.
+ */
+
+// LocalStorage and Cookie storage library
+class localCookie {
+  constructor(options) {
+    options = options || {}
+    this.forceCookies = options.forceCookies || false
+
+    if (this._checkIfLocalStorageWorks() === true && options.forceCookies !== true)
+      return {
+        getItem: this._getItemLocalStorage,
+        setItem: this._setItemLocalStorage,
+        removeItem: this._removeItemLocalStorage,
+        clear: this._clearLocalStorage,
+        keys: this._getLocalStorageKeys,
+      }
+    else
+      return {
+        getItem: this._getItemCookie,
+        setItem: this._setItemCookie,
+        removeItem: this._removeItemCookie,
+        clear: this._clearCookies,
+        keys: this._getCookieKeys,
+      }
+  }
+
+  // Checks if local storage is available and works
+  _checkIfLocalStorageWorks() {
+    if (typeof localStorage !== 'undefined') {
+      try {
+        localStorage.setItem('feature_test', 'yes')
+        if (localStorage.getItem('feature_test') === 'yes') {
+          localStorage.removeItem('feature_test')
+          // localStorage is enabled
+          return true
+        } else {
+          // localStorage is disabled
+          return false
+        }
+      } catch (e) {
+        // localStorage is disabled
+        return false
+      }
+    } else {
+      // localStorage is not available
+      return false
+    }
+  }
+
+  /*
+   * Local Storage APIs
+   */
+  _getItemLocalStorage(key) {
+    return window.localStorage.getItem(key)
+  }
+
+  _setItemLocalStorage(key, value) {
+    return window.localStorage.setItem(key, value)
+  }
+
+  _removeItemLocalStorage(key) {
+    return window.localStorage.removeItem(key)
+  }
+
+  _clearLocalStorage() {
+    return window.localStorage.clear()
+  }
+
+  _getLocalStorageKeys() {
+    return Object.keys(window.localStorage)
+  }
+
+  /*
+   * Cookie APIs
+   */
+  _getItemCookie(key) {
+    /* eslint-disable */
+		function escape(s) { return s.replace(/([.*+?\^${}()|\[\]\/\\])/g, '\\$1'); };
+		var match = document.cookie.match(RegExp('(?:^|;\\s*)' + escape(key) + '=([^;]*)'));
+
+		//if value in key of the entire cookie is empty, its deleted
+		if (match && match[1] === '')
+			match[1] = null
+
+		return match ? match[1] : null;
+	}
+
+	_setItemCookie(key, value) {
+		var now = new Date()
+		var expires = new Date(now.getTime() +1000*60*60*24*365*5) // 5 years!
+		document.cookie = `${key}=${value}; expires=${expires.toUTCString()};`
+		return //return undefined just like localStorage
+	}
+
+	_removeItemCookie(key) {
+		// to delete an k/v set the key to empty
+		document.cookie = `${key}=;Max-Age=-99999999;`
+		return //return undefined just like localStorage
+	}
+
+	_clearCookies() {
+		// empty all key/values in cookies
+		// What about cookies we got from the server? ¯\_(ツ)_/¯
+		// They should have the HttpOnly flag, so we shouldn't be able to delete them
+		document.cookie.split(";").forEach( (c) => {
+			document.cookie = c.replace(/^ +/, "").replace(/=.*/, "=;expires=Max-Age=-99999999");
+		});
+
+		return //return undefined
+	}
+	_getCookieKeys() {
+		return document.cookie.split(";").map((item)=>item.split("=")[0])
+	}
+}
+
+export default localCookie

package/src/plugins/storage/storage.js

@@ -0,0 +1,49 @@
+/*
+ * 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 localCookie from './localCookie.js'
+
+let lc = new localCookie()
+
+export default {
+  name: 'storage',
+  plugin() {
+    return {
+      get(key) {
+        try {
+          return JSON.parse(lc.getItem(key))
+        } catch (e) {
+          return null
+        }
+      },
+      set(key, value) {
+        try {
+          lc.setItem(key, JSON.stringify(value))
+          return true
+        } catch (e) {
+          return false
+        }
+      },
+      remove(key) {
+        lc.removeItem(key)
+      },
+      clear() {
+        lc.clear()
+      },
+    }
+  },
+}