@lightningjs/blits 1.30.2 → 1.31.0

package/src/lib/log.js

@@ -1,117 +1,117 @@
-/*
- * 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 Settings from '../settings.js'
-
-const n = () => {}
-
-/**
- * Returns the current time as a locale time string (hh:mm:ss).
- * @returns {string} The current time string.
- */
-const time = () =>
-  new Date().toLocaleTimeString([], {
-    hour: '2-digit',
-    minute: '2-digit',
-    second: '2-digit',
-  })
-
-/**
- * Returns a logger object for the given context, with info, warn, debug, and error methods.
- * Logging methods are no-ops if the debug level does not match.
- *
- * @param {string} context - The context label for log messages.
- * @returns {Object} Logger object with info, warn, debug, and error methods.
- */
-const logger = (context) => {
-  const level = Settings.get('debugLevel')
-  const log = {}
-
-  Object.defineProperty(log, 'info', {
-    get() {
-      return (
-        ((level >= 1 || (Array.isArray(level) && level.indexOf('info') > -1)) &&
-          console.info.bind(
-            window.console,
-            `%c ⚡️ ${context} %c ${time()}`,
-            'background-color: #0284c7; color: white; padding: 3px 6px 3px 1px; border-radius: 3px',
-            'color: ##94a3b8;'
-          )) ||
-        n
-      )
-    },
-  })
-
-  Object.defineProperty(log, 'warn', {
-    get() {
-      return (
-        ((level >= 1 || (Array.isArray(level) && level.indexOf('warn') > -1)) &&
-          console.warn.bind(
-            window.console,
-            `%c ⚡️ ${context} %c ${time()}`,
-            'background-color: #fbbf24; color: white; padding: 3px 6px 3px 1px; border-radius: 3px',
-            'color: ##94a3b8;'
-          )) ||
-        n
-      )
-    },
-  })
-
-  Object.defineProperty(log, 'error', {
-    get() {
-      return (
-        ((level >= 1 || (Array.isArray(level) && level.indexOf('error') > -1)) &&
-          console.error.bind(
-            window.console,
-            `%c ⚡️ ${context} %c ${time()}`,
-            'background-color: #dc2626; color: white; padding: 3px 6px 3px 1px; border-radius: 3px',
-            'color: ##94a3b8;'
-          )) ||
-        n
-      )
-    },
-  })
-
-  Object.defineProperty(log, 'debug', {
-    get() {
-      return (
-        ((level >= 2 || (Array.isArray(level) && level.indexOf('debug') > -1)) &&
-          console.debug.bind(
-            window.console,
-            `%c ⚡️ ${context} %c (${new Date().toLocaleTimeString([], {
-              hour: '2-digit',
-              minute: '2-digit',
-              second: '2-digit',
-            })})`,
-            'background-color: #e2e8f0; color: #334155; padding: 3px 6px 3px 1px; border-radius: 3px',
-            'color: ##94a3b8;'
-          )) ||
-        n
-      )
-    },
-  })
-
-  return log
-}
-
-export default logger
-
-export let Log
-// review this pattern
-export const initLog = () => {
-  Log = logger('Blits')
-}
+/*
+ * 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 Settings from '../settings.js'
+
+const n = () => {}
+
+/**
+ * Returns the current time as a locale time string (hh:mm:ss).
+ * @returns {string} The current time string.
+ */
+const time = () =>
+  new Date().toLocaleTimeString([], {
+    hour: '2-digit',
+    minute: '2-digit',
+    second: '2-digit',
+  })
+
+/**
+ * Returns a logger object for the given context, with info, warn, debug, and error methods.
+ * Logging methods are no-ops if the debug level does not match.
+ *
+ * @param {string} context - The context label for log messages.
+ * @returns {Object} Logger object with info, warn, debug, and error methods.
+ */
+const logger = (context) => {
+  const level = Settings.get('debugLevel')
+  const log = {}
+
+  Object.defineProperty(log, 'info', {
+    get() {
+      return (
+        ((level >= 1 || (Array.isArray(level) && level.indexOf('info') > -1)) &&
+          console.info.bind(
+            window.console,
+            `%c ⚡️ ${context} %c ${time()}`,
+            'background-color: #0284c7; color: white; padding: 3px 6px 3px 1px; border-radius: 3px',
+            'color: ##94a3b8;'
+          )) ||
+        n
+      )
+    },
+  })
+
+  Object.defineProperty(log, 'warn', {
+    get() {
+      return (
+        ((level >= 1 || (Array.isArray(level) && level.indexOf('warn') > -1)) &&
+          console.warn.bind(
+            window.console,
+            `%c ⚡️ ${context} %c ${time()}`,
+            'background-color: #fbbf24; color: white; padding: 3px 6px 3px 1px; border-radius: 3px',
+            'color: ##94a3b8;'
+          )) ||
+        n
+      )
+    },
+  })
+
+  Object.defineProperty(log, 'error', {
+    get() {
+      return (
+        ((level >= 1 || (Array.isArray(level) && level.indexOf('error') > -1)) &&
+          console.error.bind(
+            window.console,
+            `%c ⚡️ ${context} %c ${time()}`,
+            'background-color: #dc2626; color: white; padding: 3px 6px 3px 1px; border-radius: 3px',
+            'color: ##94a3b8;'
+          )) ||
+        n
+      )
+    },
+  })
+
+  Object.defineProperty(log, 'debug', {
+    get() {
+      return (
+        ((level >= 2 || (Array.isArray(level) && level.indexOf('debug') > -1)) &&
+          console.debug.bind(
+            window.console,
+            `%c ⚡️ ${context} %c (${new Date().toLocaleTimeString([], {
+              hour: '2-digit',
+              minute: '2-digit',
+              second: '2-digit',
+            })})`,
+            'background-color: #e2e8f0; color: #334155; padding: 3px 6px 3px 1px; border-radius: 3px',
+            'color: ##94a3b8;'
+          )) ||
+        n
+      )
+    },
+  })
+
+  return log
+}
+
+export default logger
+
+export let Log
+// review this pattern
+export const initLog = () => {
+  Log = logger('Blits')
+}

package/src/lib/precompiler/precompiler.js

@@ -1,73 +1,73 @@
-/*
- * 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 parser from '../templateparser/parser.js'
-import generator from '../codegenerator/generator.js'
-
-export default (source, filePath, mode) => {
-  if (
-    source.indexOf('Blits.Component(') > -1 ||
-    source.indexOf('Blits.Application(') > -1 ||
-    /=>\s*Component\(['"][A-Za-z]+['"],/s.test(source) || // blits component
-    /\{.*?template\s*:\s*(['"`])((?:\\?.)*?)\1.*?\}/s.test(source) // object with template key
-  ) {
-    const templates = source.matchAll(/(?<!\/\/\s*)template\s*:\s*(['"`])((?:\\?.)*?)\1/gs)
-    let newSource = source
-    /*
-      if there are multiple templates in the file, we need to keep
-      track of the offset caused by the previous replacements
-    */
-    let offset = 0
-
-    for (const template of templates) {
-      if (template[2]) {
-        const templateContent = template[2]
-
-        // Only process if it looks like a Blits template
-        if (templateContent.match(/^\s*(<!--[\s\S]*?-->|<[A-Za-z][^>]*>)/s)) {
-          const templateStartIndex = template.index + offset
-          const templateEndIndex = templateStartIndex + template[0].length
-
-          // Parse the template
-          let resourceName = 'Blits.Application'
-          if (source.indexOf('Blits.Component(') > -1) {
-            resourceName = source.match(/Blits\.Component\(['"](.*)['"]\s*,/)[1]
-          }
-
-          const parsed = parser(templateContent, resourceName, null, filePath)
-
-          // Generate the code
-          const code = generator.call({ components: {} }, parsed, mode === 'development')
-
-          // Insert the code in the component using the 'code' key, replacing the template key
-          const replacement = `/* eslint-disable no-unused-vars */ \ncode: { render: ${code.render.toString()}, effects: [${code.effects.map(
-            (fn) => fn.toString()
-          )}], context: {}}`
-
-          offset += replacement.length - template[0].length
-
-          newSource =
-            newSource.substring(0, templateStartIndex) +
-            replacement +
-            newSource.substring(templateEndIndex)
-        }
-      }
-    }
-    return newSource
-  }
-  return source
-}
+/*
+ * 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 parser from '../templateparser/parser.js'
+import generator from '../codegenerator/generator.js'
+
+export default (source, filePath, mode) => {
+  if (
+    source.indexOf('Blits.Component(') > -1 ||
+    source.indexOf('Blits.Application(') > -1 ||
+    /=>\s*Component\(['"][A-Za-z]+['"],/s.test(source) || // blits component
+    /\{.*?template\s*:\s*(['"`])((?:\\?.)*?)\1.*?\}/s.test(source) // object with template key
+  ) {
+    const templates = source.matchAll(/(?<!\/\/\s*)template\s*:\s*(['"`])((?:\\?.)*?)\1/gs)
+    let newSource = source
+    /*
+      if there are multiple templates in the file, we need to keep
+      track of the offset caused by the previous replacements
+    */
+    let offset = 0
+
+    for (const template of templates) {
+      if (template[2]) {
+        const templateContent = template[2]
+
+        // Only process if it looks like a Blits template
+        if (templateContent.match(/^\s*(<!--[\s\S]*?-->|<[A-Za-z][^>]*>)/s)) {
+          const templateStartIndex = template.index + offset
+          const templateEndIndex = templateStartIndex + template[0].length
+
+          // Parse the template
+          let resourceName = 'Blits.Application'
+          if (source.indexOf('Blits.Component(') > -1) {
+            resourceName = source.match(/Blits\.Component\(['"](.*)['"]\s*,/)[1]
+          }
+
+          const parsed = parser(templateContent, resourceName, null, filePath)
+
+          // Generate the code
+          const code = generator.call({ components: {} }, parsed, mode === 'development')
+
+          // Insert the code in the component using the 'code' key, replacing the template key
+          const replacement = `/* eslint-disable no-unused-vars */ \ncode: { render: ${code.render.toString()}, effects: [${code.effects.map(
+            (fn) => fn.toString()
+          )}], context: {}}`
+
+          offset += replacement.length - template[0].length
+
+          newSource =
+            newSource.substring(0, templateStartIndex) +
+            replacement +
+            newSource.substring(templateEndIndex)
+        }
+      }
+    }
+    return newSource
+  }
+  return source
+}

package/src/lib/reactivity/effect.js

@@ -1,93 +1,93 @@
-/*
- * 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
- */
-
-let currentEffect = null
-let currentKey = null
-
-let paused = false
-
-export const pauseTracking = () => {
-  paused = true
-}
-
-export const resumeTracking = () => {
-  paused = false
-}
-
-const objectMap = new WeakMap()
-const globalEffectsMap = new Map()
-
-export const removeGlobalEffects = (effectsToRemove) => {
-  if (globalEffectsMap.size === 0) return
-  for (const [effect, target] of globalEffectsMap) {
-    if (effectsToRemove.indexOf(effect) === -1) continue
-    const effectsSet = objectMap.get(target)
-    if (effectsSet === undefined) continue
-    for (const set of effectsSet.values()) {
-      set.delete(effect)
-      globalEffectsMap.delete(effect)
-    }
-  }
-}
-
-export const track = (target, key, global = false) => {
-  if (currentEffect !== null) {
-    if (paused) {
-      return
-    }
-    // note: nesting the conditions like this seems to perform better ¯\_(ツ)_/¯
-    if (Array.isArray(currentKey) === true) {
-      if (currentKey.includes(key) === false) return
-    } else if (currentKey !== null && key !== currentKey) return
-
-    let effectsMap = objectMap.get(target)
-    if (effectsMap === undefined) {
-      effectsMap = new Map()
-      objectMap.set(target, effectsMap)
-    }
-    let effects = effectsMap.get(key)
-    if (effects === undefined) {
-      effects = new Set()
-      effectsMap.set(key, effects)
-    }
-    effects.add(currentEffect)
-
-    if (global === true) globalEffectsMap.set(currentEffect, target)
-  }
-}
-
-export const trigger = (target, key, force = false) => {
-  if (paused === true) return
-  const effectsMap = objectMap.get(target)
-  if (effectsMap === undefined) {
-    return
-  }
-  const effects = effectsMap.get(key)
-  if (effects !== undefined) {
-    for (let effect of effects) {
-      effect(force)
-    }
-  }
-}
-
-export const effect = (effect, key = null) => {
-  currentEffect = effect
-  currentKey = key
-  currentEffect()
-  currentEffect = null
-  currentKey = null
-}
+/*
+ * 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
+ */
+
+let currentEffect = null
+let currentKey = null
+
+let paused = false
+
+export const pauseTracking = () => {
+  paused = true
+}
+
+export const resumeTracking = () => {
+  paused = false
+}
+
+const objectMap = new WeakMap()
+const globalEffectsMap = new Map()
+
+export const removeGlobalEffects = (effectsToRemove) => {
+  if (globalEffectsMap.size === 0) return
+  for (const [effect, target] of globalEffectsMap) {
+    if (effectsToRemove.indexOf(effect) === -1) continue
+    const effectsSet = objectMap.get(target)
+    if (effectsSet === undefined) continue
+    for (const set of effectsSet.values()) {
+      set.delete(effect)
+      globalEffectsMap.delete(effect)
+    }
+  }
+}
+
+export const track = (target, key, global = false) => {
+  if (currentEffect !== null) {
+    if (paused) {
+      return
+    }
+    // note: nesting the conditions like this seems to perform better ¯\_(ツ)_/¯
+    if (Array.isArray(currentKey) === true) {
+      if (currentKey.includes(key) === false) return
+    } else if (currentKey !== null && key !== currentKey) return
+
+    let effectsMap = objectMap.get(target)
+    if (effectsMap === undefined) {
+      effectsMap = new Map()
+      objectMap.set(target, effectsMap)
+    }
+    let effects = effectsMap.get(key)
+    if (effects === undefined) {
+      effects = new Set()
+      effectsMap.set(key, effects)
+    }
+    effects.add(currentEffect)
+
+    if (global === true) globalEffectsMap.set(currentEffect, target)
+  }
+}
+
+export const trigger = (target, key, force = false) => {
+  if (paused === true) return
+  const effectsMap = objectMap.get(target)
+  if (effectsMap === undefined) {
+    return
+  }
+  const effects = effectsMap.get(key)
+  if (effects !== undefined) {
+    for (let effect of effects) {
+      effect(force)
+    }
+  }
+}
+
+export const effect = (effect, key = null) => {
+  currentEffect = effect
+  currentKey = key
+  currentEffect()
+  currentEffect = null
+  currentKey = null
+}