@lightningjs/blits 1.30.2 → 1.31.0

package/src/lib/utils.js

@@ -1,27 +1,27 @@
-/**
- * A mapping of common screen resolution names to their scale factors relative to 1080p (Full HD).
- *
- * @type {Object<string|number, number>}
- * @property {number} hd - 0.666... (720p)
- * @property {number} '720p' - 0.666... (720p)
- * @property {number} 720 - 0.666... (720p)
- * @property {number} fhd - 1 (Full HD)
- * @property {number} fullhd - 1 (Full HD)
- * @property {number} '1080p' - 1 (Full HD)
- * @property {number} 1080 - 1 (Full HD)
- * @property {number} '4k' - 2 (2160p)
- * @property {number} '2160p' - 2 (2160p)
- * @property {number} 2160 - 2 (2160p)
- */
-export const screenResolutions = {
-  hd: 0.66666667,
-  '720p': 0.66666667,
-  720: 0.66666667,
-  fhd: 1,
-  fullhd: 1,
-  '1080p': 1,
-  1080: 1,
-  '4k': 2,
-  '2160p': 2,
-  2160: 2,
-}
+/**
+ * A mapping of common screen resolution names to their scale factors relative to 1080p (Full HD).
+ *
+ * @type {Object<string|number, number>}
+ * @property {number} hd - 0.666... (720p)
+ * @property {number} '720p' - 0.666... (720p)
+ * @property {number} 720 - 0.666... (720p)
+ * @property {number} fhd - 1 (Full HD)
+ * @property {number} fullhd - 1 (Full HD)
+ * @property {number} '1080p' - 1 (Full HD)
+ * @property {number} 1080 - 1 (Full HD)
+ * @property {number} '4k' - 2 (2160p)
+ * @property {number} '2160p' - 2 (2160p)
+ * @property {number} 2160 - 2 (2160p)
+ */
+export const screenResolutions = {
+  hd: 0.66666667,
+  '720p': 0.66666667,
+  720: 0.66666667,
+  fhd: 1,
+  fullhd: 1,
+  '1080p': 1,
+  1080: 1,
+  '4k': 2,
+  '2160p': 2,
+  2160: 2,
+}

package/src/plugin.js

@@ -1,27 +1,27 @@
-import log from './plugins/log.js'
-
-export const plugins = {
-  // log plugin added by default
-  log,
-}
-
-const registerPlugin = (plugin, nameOrOptions = '', options = {}) => {
-  // map name and options depending on the arguments provided
-  let name = undefined
-  if (typeof nameOrOptions === 'object') {
-    options = nameOrOptions
-  } else {
-    name = nameOrOptions
-  }
-
-  if (typeof plugin === 'function') {
-    if (name === undefined) {
-      throw Error('Error registering plugin: name is required for plugin')
-    }
-    plugins[name] = { plugin, options }
-  } else if (plugin.plugin) {
-    registerPlugin(plugin.plugin, name || plugin.name, options)
-  }
-}
-
-export default registerPlugin
+import log from './plugins/log.js'
+
+export const plugins = {
+  // log plugin added by default
+  log,
+}
+
+const registerPlugin = (plugin, nameOrOptions = '', options = {}) => {
+  // map name and options depending on the arguments provided
+  let name = undefined
+  if (typeof nameOrOptions === 'object') {
+    options = nameOrOptions
+  } else {
+    name = nameOrOptions
+  }
+
+  if (typeof plugin === 'function') {
+    if (name === undefined) {
+      throw Error('Error registering plugin: name is required for plugin')
+    }
+    plugins[name] = { plugin, options }
+  } else if (plugin.plugin) {
+    registerPlugin(plugin.plugin, name || plugin.name, options)
+  }
+}
+
+export default registerPlugin

package/src/plugins/appstate.js

@@ -1,26 +1,26 @@
-/*
- * 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 { reactive } from '../lib/reactivity/reactive'
-import Settings from '../settings.js'
-
-export default {
-  name: 'appState',
-  plugin(state = {}) {
-    return reactive(state, Settings.get('reactivityMode'), true)
-  },
-}
+/*
+ * 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 { reactive } from '../lib/reactivity/reactive'
+import Settings from '../settings.js'
+
+export default {
+  name: 'appState',
+  plugin(state = {}) {
+    return reactive(state, Settings.get('reactivityMode'), true)
+  },
+}

package/src/plugins/index.js

@@ -1,20 +1,20 @@
-/*
- * 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
- */
-
-export { default as language } from './language.js'
-export { default as theme } from './theme.js'
-export { default as appState } from './appstate.js'
+/*
+ * 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
+ */
+
+export { default as language } from './language.js'
+export { default as theme } from './theme.js'
+export { default as appState } from './appstate.js'

package/src/plugins/language.js

@@ -1,152 +1,152 @@
-/*
- * 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 fetchJson from '../helpers/fetchJson'
-import { Log } from '../lib/log'
-import { reactive } from '../lib/reactivity/reactive'
-
-import Settings from '../settings.js'
-
-export default {
-  name: 'language',
-  plugin(options = {}) {
-    let translations = {}
-    let dictionary = {}
-
-    const state = reactive(
-      {
-        language: '',
-        loaded: 0,
-      },
-      Settings.get('reactivityMode'),
-      true
-    )
-
-    const setLanguage = (language) => {
-      const warningMsg =
-        Object.keys(translations).length === 0
-          ? 'No translations loaded. Please load a file with translations or specify a translations object manually'
-          : language in translations === false
-          ? `Language ${language} not available in the loaded translations`
-          : false
-      if (warningMsg) {
-        Log.warn(warningMsg)
-        // set the current language in the reactive state
-        state.language = language
-      } else {
-        setDict(language).then(() => {
-          state.language = language
-        })
-      }
-    }
-
-    const setDict = (language) => {
-      return new Promise((resolve) => {
-        const translationObj = translations[language]
-        if (typeof translationObj === 'object') {
-          dictionary = translationObj
-          resolve()
-        } else if (typeof translationObj === 'string') {
-          fetchJson(translationObj)
-            .then((result) => {
-              // save the translations for this language (to prevent loading twice)
-              translations[language] = result
-              // define the dictionary
-              dictionary = result
-              resolve()
-            })
-            .catch((e) => {
-              Log.error(e)
-            })
-        }
-      })
-    }
-
-    const loadLanguageFile = (filePath) => {
-      return fetchJson(filePath)
-        .then((result) => {
-          setTranslations(result)
-        })
-        .catch((e) => {
-          Log.error(e)
-        })
-    }
-
-    const setTranslations = (translationsObject) => {
-      translations = translationsObject
-      setDict(state.language).then(() => {
-        state.loaded++
-      })
-    }
-
-    if ('file' in options) {
-      loadLanguageFile(options.file).then(() => {
-        if ('language' in options) {
-          setLanguage(options.language)
-        }
-      })
-    } else if ('language' in options) {
-      setLanguage(options.language)
-    }
-
-    // Public API language plugin
-    return {
-      translate(key) {
-        // reference state.language, to trigger reactive effects for
-        // translate functions when language is modified
-        state.language
-
-        // reference state.loaded, to trigger reactive effects for
-        // translate functions when language is modified
-        state.loaded
-
-        let replacements = [...arguments].slice(1)
-
-        // no replacements so just translated string
-        if (replacements.length === 0) {
-          return (dictionary && dictionary[key]) || key
-        } else {
-          if (replacements.length === 1 && typeof replacements[0] === 'object') {
-            replacements = replacements.pop()
-          }
-
-          return Object.keys(
-            // maps array input to an object {0: 'item1', 1: 'item2'}
-            Array.isArray(replacements) ? Object.assign({}, replacements) : replacements
-          ).reduce((text, replacementKey) => {
-            return text.replace(
-              new RegExp('{\\s?' + replacementKey + '\\s?}', 'g'),
-              replacements[replacementKey]
-            )
-          }, (dictionary && dictionary[key]) || key)
-        }
-      },
-      get language() {
-        return state.language
-      },
-      set(language) {
-        setLanguage(language)
-      },
-      translations(translationsObject) {
-        setTranslations(translationsObject)
-      },
-      load(file) {
-        return loadLanguageFile(file)
-      },
-    }
-  },
-}
+/*
+ * 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 fetchJson from '../helpers/fetchJson'
+import { Log } from '../lib/log'
+import { reactive } from '../lib/reactivity/reactive'
+
+import Settings from '../settings.js'
+
+export default {
+  name: 'language',
+  plugin(options = {}) {
+    let translations = {}
+    let dictionary = {}
+
+    const state = reactive(
+      {
+        language: '',
+        loaded: 0,
+      },
+      Settings.get('reactivityMode'),
+      true
+    )
+
+    const setLanguage = (language) => {
+      const warningMsg =
+        Object.keys(translations).length === 0
+          ? 'No translations loaded. Please load a file with translations or specify a translations object manually'
+          : language in translations === false
+          ? `Language ${language} not available in the loaded translations`
+          : false
+      if (warningMsg) {
+        Log.warn(warningMsg)
+        // set the current language in the reactive state
+        state.language = language
+      } else {
+        setDict(language).then(() => {
+          state.language = language
+        })
+      }
+    }
+
+    const setDict = (language) => {
+      return new Promise((resolve) => {
+        const translationObj = translations[language]
+        if (typeof translationObj === 'object') {
+          dictionary = translationObj
+          resolve()
+        } else if (typeof translationObj === 'string') {
+          fetchJson(translationObj)
+            .then((result) => {
+              // save the translations for this language (to prevent loading twice)
+              translations[language] = result
+              // define the dictionary
+              dictionary = result
+              resolve()
+            })
+            .catch((e) => {
+              Log.error(e)
+            })
+        }
+      })
+    }
+
+    const loadLanguageFile = (filePath) => {
+      return fetchJson(filePath)
+        .then((result) => {
+          setTranslations(result)
+        })
+        .catch((e) => {
+          Log.error(e)
+        })
+    }
+
+    const setTranslations = (translationsObject) => {
+      translations = translationsObject
+      setDict(state.language).then(() => {
+        state.loaded++
+      })
+    }
+
+    if ('file' in options) {
+      loadLanguageFile(options.file).then(() => {
+        if ('language' in options) {
+          setLanguage(options.language)
+        }
+      })
+    } else if ('language' in options) {
+      setLanguage(options.language)
+    }
+
+    // Public API language plugin
+    return {
+      translate(key) {
+        // reference state.language, to trigger reactive effects for
+        // translate functions when language is modified
+        state.language
+
+        // reference state.loaded, to trigger reactive effects for
+        // translate functions when language is modified
+        state.loaded
+
+        let replacements = [...arguments].slice(1)
+
+        // no replacements so just translated string
+        if (replacements.length === 0) {
+          return (dictionary && dictionary[key]) || key
+        } else {
+          if (replacements.length === 1 && typeof replacements[0] === 'object') {
+            replacements = replacements.pop()
+          }
+
+          return Object.keys(
+            // maps array input to an object {0: 'item1', 1: 'item2'}
+            Array.isArray(replacements) ? Object.assign({}, replacements) : replacements
+          ).reduce((text, replacementKey) => {
+            return text.replace(
+              new RegExp('{\\s?' + replacementKey + '\\s?}', 'g'),
+              replacements[replacementKey]
+            )
+          }, (dictionary && dictionary[key]) || key)
+        }
+      },
+      get language() {
+        return state.language
+      },
+      set(language) {
+        setLanguage(language)
+      },
+      translations(translationsObject) {
+        setTranslations(translationsObject)
+      },
+      load(file) {
+        return loadLanguageFile(file)
+      },
+    }
+  },
+}

package/src/plugins/log.js

@@ -1,25 +1,25 @@
-/*
- * 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 { default as log } from '../lib/log.js'
-
-export default {
-  name: 'log',
-  plugin() {
-    return log('App')
-  },
-}
+/*
+ * 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 { default as log } from '../lib/log.js'
+
+export default {
+  name: 'log',
+  plugin() {
+    return log('App')
+  },
+}