@lightningjs/blits 1.30.2 → 1.31.0

package/scripts/prepush.js

@@ -1,78 +1,78 @@
-/*
- * If not stated otherwise in this file or this component's LICENSE file the
- * following copyright and licenses apply:
- *
- * Copyright 2023 Comcast
- *
- * 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.
- */
-
-import { execSync } from 'child_process'
-import { readFileSync } from 'fs'
-
-// Read the input provided by the pre-push hook
-const input = readFileSync(0, 'utf-8').trim().split(' ')
-if (input.length < 4) {
-  console.log('Insufficient input from pre-push hook. Skipping lint.')
-  process.exit(0)
-}
-
-const localSha = input[1] // The SHA being pushed
-const remoteSha = input[3] // The remote SHA, can be zeros for new branch
-
-// If remote is all zeros, it's a new branch
-const isNewBranch = remoteSha === '0000000000000000000000000000000000000000'
-
-let filesToLint
-
-try {
-  if (isNewBranch) {
-    // For a new branch, compare with dev
-    filesToLint = execSync(`git diff --name-only dev...${localSha} | grep '\\.js$'`, {
-      encoding: 'utf8',
-    })
-  } else {
-    // Only check files in the commits that are being pushed right now
-    filesToLint = execSync(`git diff --name-only ${remoteSha}..${localSha} | grep '\\.js$'`, {
-      encoding: 'utf8',
-    })
-  }
-} catch (error) {
-  // grep will exit with code 1 if it doesn't find anything
-  console.log('No JavaScript files changed. Nothing to lint.')
-  process.exit(0)
-}
-
-if (!filesToLint.trim()) {
-  console.log('No JavaScript files changed. Nothing to lint.')
-  process.exit(0)
-}
-
-const fileList = filesToLint.trim().split('\n')
-console.log(`Running ESLint on ${fileList.length} changed JavaScript files:\n`)
-console.log(filesToLint)
-
-try {
-  // Run ESLint on the changed files
-  execSync(`npx eslint ${fileList.join(' ')}`, { stdio: 'inherit' })
-  console.log('Linting passed successfully!\n')
-  process.exit(0)
-} catch (error) {
-  console.log('\n==========================================================================')
-  console.log('ESLint found issues in your code. Please fix them before pushing.')
-  console.log('You can run:\n')
-  console.log('npx eslint --fix "**/*.js"\n')
-  console.log('on the specific files to automatically fix some issues.')
-  console.log('==========================================================================\n')
-  process.exit(1)
-}
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2023 Comcast
+ *
+ * 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.
+ */
+
+import { execSync } from 'child_process'
+import { readFileSync } from 'fs'
+
+// Read the input provided by the pre-push hook
+const input = readFileSync(0, 'utf-8').trim().split(' ')
+if (input.length < 4) {
+  console.log('Insufficient input from pre-push hook. Skipping lint.')
+  process.exit(0)
+}
+
+const localSha = input[1] // The SHA being pushed
+const remoteSha = input[3] // The remote SHA, can be zeros for new branch
+
+// If remote is all zeros, it's a new branch
+const isNewBranch = remoteSha === '0000000000000000000000000000000000000000'
+
+let filesToLint
+
+try {
+  if (isNewBranch) {
+    // For a new branch, compare with dev
+    filesToLint = execSync(`git diff --name-only dev...${localSha} | grep '\\.js$'`, {
+      encoding: 'utf8',
+    })
+  } else {
+    // Only check files in the commits that are being pushed right now
+    filesToLint = execSync(`git diff --name-only ${remoteSha}..${localSha} | grep '\\.js$'`, {
+      encoding: 'utf8',
+    })
+  }
+} catch (error) {
+  // grep will exit with code 1 if it doesn't find anything
+  console.log('No JavaScript files changed. Nothing to lint.')
+  process.exit(0)
+}
+
+if (!filesToLint.trim()) {
+  console.log('No JavaScript files changed. Nothing to lint.')
+  process.exit(0)
+}
+
+const fileList = filesToLint.trim().split('\n')
+console.log(`Running ESLint on ${fileList.length} changed JavaScript files:\n`)
+console.log(filesToLint)
+
+try {
+  // Run ESLint on the changed files
+  execSync(`npx eslint ${fileList.join(' ')}`, { stdio: 'inherit' })
+  console.log('Linting passed successfully!\n')
+  process.exit(0)
+} catch (error) {
+  console.log('\n==========================================================================')
+  console.log('ESLint found issues in your code. Please fix them before pushing.')
+  console.log('You can run:\n')
+  console.log('npx eslint --fix "**/*.js"\n')
+  console.log('on the specific files to automatically fix some issues.')
+  console.log('==========================================================================\n')
+  process.exit(1)
+}

package/src/announcer/announcer.js

@@ -1,162 +1,162 @@
-/*
- * 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 speechSynthesis from './speechSynthesis.js'
-
-let active = false
-let count = 0
-const queue = []
-let isProcessing = false
-let currentId = null
-let debounce = null
-
-const noopAnnouncement = {
-  then() {},
-  done() {},
-  cancel() {},
-  stop() {},
-}
-
-const enable = () => {
-  active = true
-}
-
-const disable = () => {
-  active = false
-}
-
-const toggle = (v) => {
-  active = v ? true : false
-}
-
-const speak = (message, politeness = 'off') => {
-  if (active === false) return noopAnnouncement
-
-  return addToQueue(message, politeness)
-}
-
-const pause = (delay) => {
-  if (active === false) return noopAnnouncement
-
-  return addToQueue(undefined, undefined, delay)
-}
-
-const addToQueue = (message, politeness, delay = false) => {
-  // keep track of the id so message can be canceled
-  const id = count++
-
-  // setup a promise to allow developer to chain functionality
-  // when specific utterances are done
-  let resolveFn
-  const done = new Promise((resolve) => {
-    resolveFn = resolve
-  })
-
-  // augment the promise with a cancel function
-  done.cancel = () => {
-    const index = queue.findIndex((item) => item.id === id)
-    if (index !== -1) queue.splice(index, 1)
-    isProcessing = false
-    resolveFn('canceled')
-  }
-
-  // augment the promise with a stop function
-  done.stop = () => {
-    if (id === currentId) {
-      speechSynthesis.cancel()
-      isProcessing = false
-      resolveFn('interupted')
-    }
-  }
-
-  // add message of pause
-  if (delay === false) {
-    politeness === 'assertive'
-      ? queue.unshift({ message, resolveFn, id })
-      : queue.push({ message, resolveFn, id })
-  } else {
-    queue.push({ delay, resolveFn, id })
-  }
-
-  setTimeout(() => {
-    processQueue()
-  }, 100)
-
-  return done
-}
-
-const processQueue = async () => {
-  if (isProcessing === true || queue.length === 0) return
-  isProcessing = true
-
-  const { message, resolveFn, delay, id } = queue.shift()
-
-  currentId = id
-
-  if (delay) {
-    setTimeout(() => {
-      isProcessing = false
-      currentId = null
-      resolveFn('finished')
-      processQueue()
-    }, delay)
-  } else {
-    if (debounce !== null) clearTimeout(debounce)
-    // add some easing when speaking the messages to reduce stuttering
-    debounce = setTimeout(() => {
-      speechSynthesis
-        .speak({ message })
-        .then(() => {
-          isProcessing = false
-          currentId = null
-          resolveFn('finished')
-          processQueue()
-        })
-        .catch((e) => {
-          isProcessing = false
-          currentId = null
-          resolveFn(e.error)
-          processQueue()
-        })
-      debounce = null
-    }, 200)
-  }
-}
-
-const polite = (message) => speak(message, 'polite')
-
-const assertive = (message) => speak(message, 'assertive')
-
-const stop = () => {
-  speechSynthesis.cancel()
-}
-
-const clear = () => {
-  queue.length = 0
-}
-
-export default {
-  speak,
-  polite,
-  assertive,
-  stop,
-  enable,
-  disable,
-  toggle,
-  clear,
-  pause,
-}
+/*
+ * 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 speechSynthesis from './speechSynthesis.js'
+
+let active = false
+let count = 0
+const queue = []
+let isProcessing = false
+let currentId = null
+let debounce = null
+
+const noopAnnouncement = {
+  then() {},
+  done() {},
+  cancel() {},
+  stop() {},
+}
+
+const enable = () => {
+  active = true
+}
+
+const disable = () => {
+  active = false
+}
+
+const toggle = (v) => {
+  active = v ? true : false
+}
+
+const speak = (message, politeness = 'off') => {
+  if (active === false) return noopAnnouncement
+
+  return addToQueue(message, politeness)
+}
+
+const pause = (delay) => {
+  if (active === false) return noopAnnouncement
+
+  return addToQueue(undefined, undefined, delay)
+}
+
+const addToQueue = (message, politeness, delay = false) => {
+  // keep track of the id so message can be canceled
+  const id = count++
+
+  // setup a promise to allow developer to chain functionality
+  // when specific utterances are done
+  let resolveFn
+  const done = new Promise((resolve) => {
+    resolveFn = resolve
+  })
+
+  // augment the promise with a cancel function
+  done.cancel = () => {
+    const index = queue.findIndex((item) => item.id === id)
+    if (index !== -1) queue.splice(index, 1)
+    isProcessing = false
+    resolveFn('canceled')
+  }
+
+  // augment the promise with a stop function
+  done.stop = () => {
+    if (id === currentId) {
+      speechSynthesis.cancel()
+      isProcessing = false
+      resolveFn('interupted')
+    }
+  }
+
+  // add message of pause
+  if (delay === false) {
+    politeness === 'assertive'
+      ? queue.unshift({ message, resolveFn, id })
+      : queue.push({ message, resolveFn, id })
+  } else {
+    queue.push({ delay, resolveFn, id })
+  }
+
+  setTimeout(() => {
+    processQueue()
+  }, 100)
+
+  return done
+}
+
+const processQueue = async () => {
+  if (isProcessing === true || queue.length === 0) return
+  isProcessing = true
+
+  const { message, resolveFn, delay, id } = queue.shift()
+
+  currentId = id
+
+  if (delay) {
+    setTimeout(() => {
+      isProcessing = false
+      currentId = null
+      resolveFn('finished')
+      processQueue()
+    }, delay)
+  } else {
+    if (debounce !== null) clearTimeout(debounce)
+    // add some easing when speaking the messages to reduce stuttering
+    debounce = setTimeout(() => {
+      speechSynthesis
+        .speak({ message })
+        .then(() => {
+          isProcessing = false
+          currentId = null
+          resolveFn('finished')
+          processQueue()
+        })
+        .catch((e) => {
+          isProcessing = false
+          currentId = null
+          resolveFn(e.error)
+          processQueue()
+        })
+      debounce = null
+    }, 200)
+  }
+}
+
+const polite = (message) => speak(message, 'polite')
+
+const assertive = (message) => speak(message, 'assertive')
+
+const stop = () => {
+  speechSynthesis.cancel()
+}
+
+const clear = () => {
+  queue.length = 0
+}
+
+export default {
+  speak,
+  polite,
+  assertive,
+  stop,
+  enable,
+  disable,
+  toggle,
+  clear,
+  pause,
+}