@lightningjs/blits 1.30.1 → 1.30.2

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
+}

package/src/lib/reactivity/effect.test.js

@@ -1,35 +1,35 @@
-/*
- * 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 test from 'tape'
-import { trigger, track } from './effect.js'
-
-test('Trigger - type', (assert) => {
-  const expected = 'function'
-  const actual = typeof trigger
-
-  assert.equal(actual, expected, 'Trigger should be a function')
-  assert.end()
-})
-
-test('Track type', (assert) => {
-  const expected = 'function'
-  const actual = typeof track
-
-  assert.equal(actual, expected, 'Track should be a function')
-  assert.end()
-})
+/*
+ * 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 test from 'tape'
+import { trigger, track } from './effect.js'
+
+test('Trigger - type', (assert) => {
+  const expected = 'function'
+  const actual = typeof trigger
+
+  assert.equal(actual, expected, 'Trigger should be a function')
+  assert.end()
+})
+
+test('Track type', (assert) => {
+  const expected = 'function'
+  const actual = typeof track
+
+  assert.equal(actual, expected, 'Track should be a function')
+  assert.end()
+})

package/src/lib/reactivity/reactive.js

@@ -1,208 +1,208 @@
-/*
- * 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 { track, trigger, pauseTracking, resumeTracking } from './effect.js'
-import symbols from '../symbols.js'
-import deepEqualArray from '../../helpers/deepEqualArray.js'
-
-const arrayPatchMethods = ['push', 'pop', 'shift', 'unshift', 'splice', 'sort']
-
-const proxyMap = new WeakMap()
-
-export const getRaw = (value) => {
-  const raw = value && value[symbols.raw]
-  return raw ? getRaw(raw) : value
-}
-
-const reactiveProxy = (original, _parent = null, _key, global) => {
-  // only create a proxy for plain objects. Other classes, Blits components, renderer textures etc
-  // are returned unmodified and will not become reactive
-  if (
-    typeof original === 'object' &&
-    Array.isArray(original) === false &&
-    Object.getPrototypeOf(original) !== Object.prototype
-  ) {
-    return original
-  }
-  // if original object is already a proxy, don't create a new one but return the existing one instead
-  const existingProxy = proxyMap.get(original)
-  if (existingProxy !== undefined) {
-    return existingProxy
-  }
-
-  const handler = {
-    get(target, key, receiver) {
-      // return the original object instead of the proxied
-      if (key === symbols.raw) {
-        return original
-      }
-
-      // handling arrays
-      if (Array.isArray(target) === true) {
-        if (typeof target[key] === 'object' && target[key] !== null) {
-          if (Array.isArray(target[key]) === true) {
-            track(target, key, global)
-          }
-          // create a new reactive proxy
-          return reactiveProxy(getRaw(target[key]), target, key)
-        }
-        // augment array path methods (that change the length of the array)
-        if (arrayPatchMethods.indexOf(key) !== -1) {
-          return function (...args) {
-            pauseTracking()
-            const result = target[key].apply(this, args)
-            resumeTracking()
-            // trigger a change on the parent object and the key
-            // i.e. when pushing a new item to `obj.data`, _parent will equal `obj`
-            // and _key will equal `data`
-            trigger(_parent, _key)
-            return result
-          }
-        }
-        if (key === 'length') {
-          return original.length
-        }
-
-        return Reflect.get(target, key, receiver)
-      }
-
-      // handling objects (but not null values, which have object type in JS)
-      if (typeof target[key] === 'object' && target[key] !== null) {
-        if (Array.isArray(target[key]) === true) {
-          track(target, key, global)
-        }
-        // create a new reactive proxy
-        return reactiveProxy(getRaw(target[key]), target, key)
-      }
-
-      // handling all other types
-      // track the key on the target
-      track(target, key, global)
-      // return the reflected value
-      return Reflect.get(target, key, receiver)
-    },
-    set(target, key, value, receiver) {
-      // get the raw values (without proxy wrapper) so we can compare them
-      const oldRawValue = getRaw(target[key])
-      const rawValue = getRaw(value)
-
-      let result = true
-      let isEqual = false
-
-      // We need to check that the oldRawValue is also an array before we do the deep equal check
-      if (Array.isArray(rawValue) === true && Array.isArray(oldRawValue) === true) {
-        isEqual = deepEqualArray(oldRawValue, rawValue)
-      } else if (oldRawValue === rawValue) {
-        isEqual = true
-      }
-
-      if (isEqual === false) {
-        if (typeof value === 'object') {
-          if (Array.isArray(value) === true) {
-            value = getRaw(value).slice(0)
-          } else if (
-            value !== null &&
-            target[key] !== null &&
-            target[key] !== undefined &&
-            Array.isArray(target) === false &&
-            Object.getPrototypeOf(value) === Object.prototype
-          ) {
-            value = Object.assign(receiver[key], value)
-          }
-        }
-        result = Reflect.set(target, key, value, receiver)
-      }
-
-      if (result === true && isEqual === false) {
-        // if we're assigning an array key directly trigger reactivity on the parent key as well
-        if (Array.isArray(target) === true && key in target === true) {
-          trigger(_parent, _key, true)
-        }
-        trigger(target, key, true)
-      }
-      return result
-    },
-  }
-
-  const proxy = new Proxy(original, handler)
-  proxyMap.set(original, proxy)
-  return proxy
-}
-
-const reactiveDefineProperty = (target, global) => {
-  Object.keys(target).forEach((key) => {
-    let internalValue = target[key]
-
-    if (target[key] !== null && typeof target[key] === 'object') {
-      if (Object.getPrototypeOf(target[key]) === Object.prototype) {
-        return reactiveDefineProperty(target[key])
-      } else if (Array.isArray(target[key]) === true) {
-        for (let i = 0; i < arrayPatchMethods.length - 1; i++) {
-          target[key][arrayPatchMethods[i]] = function (v) {
-            Array.prototype[arrayPatchMethods[i]].call(this, v)
-            trigger(target, key)
-          }
-        }
-      }
-    }
-
-    Object.defineProperty(target, key, {
-      enumerable: true,
-      configurable: true,
-      get() {
-        track(target, key, global)
-        return internalValue
-      },
-      set(newValue) {
-        // todo: support assigning array (as we do with proxies)
-        let oldValue = internalValue
-        if (oldValue !== newValue) {
-          internalValue = newValue
-          trigger(target, key)
-        }
-      },
-    })
-  })
-
-  return target
-}
-
-const hasProxySupport = typeof Proxy !== 'undefined'
-
-export const reactive = (target, mode = 'Proxy', global = false) => {
-  // force defineProperty reactivity mode when no proxy support
-  if (hasProxySupport === false) {
-    mode = 'defineProperty'
-  }
-  return mode === 'defineProperty'
-    ? reactiveDefineProperty(target, global)
-    : reactiveProxy(target, undefined, undefined, global)
-}
-
-export const memo = (raw) => {
-  const r = {
-    get value() {
-      track(r, 'value')
-      return raw
-    },
-    set value(v) {
-      raw = v
-      trigger(r, 'value')
-    },
-  }
-  return r
-}
+/*
+ * 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 { track, trigger, pauseTracking, resumeTracking } from './effect.js'
+import symbols from '../symbols.js'
+import deepEqualArray from '../../helpers/deepEqualArray.js'
+
+const arrayPatchMethods = ['push', 'pop', 'shift', 'unshift', 'splice', 'sort']
+
+const proxyMap = new WeakMap()
+
+export const getRaw = (value) => {
+  const raw = value && value[symbols.raw]
+  return raw ? getRaw(raw) : value
+}
+
+const reactiveProxy = (original, _parent = null, _key, global) => {
+  // only create a proxy for plain objects. Other classes, Blits components, renderer textures etc
+  // are returned unmodified and will not become reactive
+  if (
+    typeof original === 'object' &&
+    Array.isArray(original) === false &&
+    Object.getPrototypeOf(original) !== Object.prototype
+  ) {
+    return original
+  }
+  // if original object is already a proxy, don't create a new one but return the existing one instead
+  const existingProxy = proxyMap.get(original)
+  if (existingProxy !== undefined) {
+    return existingProxy
+  }
+
+  const handler = {
+    get(target, key, receiver) {
+      // return the original object instead of the proxied
+      if (key === symbols.raw) {
+        return original
+      }
+
+      // handling arrays
+      if (Array.isArray(target) === true) {
+        if (typeof target[key] === 'object' && target[key] !== null) {
+          if (Array.isArray(target[key]) === true) {
+            track(target, key, global)
+          }
+          // create a new reactive proxy
+          return reactiveProxy(getRaw(target[key]), target, key)
+        }
+        // augment array path methods (that change the length of the array)
+        if (arrayPatchMethods.indexOf(key) !== -1) {
+          return function (...args) {
+            pauseTracking()
+            const result = target[key].apply(this, args)
+            resumeTracking()
+            // trigger a change on the parent object and the key
+            // i.e. when pushing a new item to `obj.data`, _parent will equal `obj`
+            // and _key will equal `data`
+            trigger(_parent, _key)
+            return result
+          }
+        }
+        if (key === 'length') {
+          return original.length
+        }
+
+        return Reflect.get(target, key, receiver)
+      }
+
+      // handling objects (but not null values, which have object type in JS)
+      if (typeof target[key] === 'object' && target[key] !== null) {
+        if (Array.isArray(target[key]) === true) {
+          track(target, key, global)
+        }
+        // create a new reactive proxy
+        return reactiveProxy(getRaw(target[key]), target, key)
+      }
+
+      // handling all other types
+      // track the key on the target
+      track(target, key, global)
+      // return the reflected value
+      return Reflect.get(target, key, receiver)
+    },
+    set(target, key, value, receiver) {
+      // get the raw values (without proxy wrapper) so we can compare them
+      const oldRawValue = getRaw(target[key])
+      const rawValue = getRaw(value)
+
+      let result = true
+      let isEqual = false
+
+      // We need to check that the oldRawValue is also an array before we do the deep equal check
+      if (Array.isArray(rawValue) === true && Array.isArray(oldRawValue) === true) {
+        isEqual = deepEqualArray(oldRawValue, rawValue)
+      } else if (oldRawValue === rawValue) {
+        isEqual = true
+      }
+
+      if (isEqual === false) {
+        if (typeof value === 'object') {
+          if (Array.isArray(value) === true) {
+            value = getRaw(value).slice(0)
+          } else if (
+            value !== null &&
+            target[key] !== null &&
+            target[key] !== undefined &&
+            Array.isArray(target) === false &&
+            Object.getPrototypeOf(value) === Object.prototype
+          ) {
+            value = Object.assign(receiver[key], value)
+          }
+        }
+        result = Reflect.set(target, key, value, receiver)
+      }
+
+      if (result === true && isEqual === false) {
+        // if we're assigning an array key directly trigger reactivity on the parent key as well
+        if (Array.isArray(target) === true && key in target === true) {
+          trigger(_parent, _key, true)
+        }
+        trigger(target, key, true)
+      }
+      return result
+    },
+  }
+
+  const proxy = new Proxy(original, handler)
+  proxyMap.set(original, proxy)
+  return proxy
+}
+
+const reactiveDefineProperty = (target, global) => {
+  Object.keys(target).forEach((key) => {
+    let internalValue = target[key]
+
+    if (target[key] !== null && typeof target[key] === 'object') {
+      if (Object.getPrototypeOf(target[key]) === Object.prototype) {
+        return reactiveDefineProperty(target[key])
+      } else if (Array.isArray(target[key]) === true) {
+        for (let i = 0; i < arrayPatchMethods.length - 1; i++) {
+          target[key][arrayPatchMethods[i]] = function (v) {
+            Array.prototype[arrayPatchMethods[i]].call(this, v)
+            trigger(target, key)
+          }
+        }
+      }
+    }
+
+    Object.defineProperty(target, key, {
+      enumerable: true,
+      configurable: true,
+      get() {
+        track(target, key, global)
+        return internalValue
+      },
+      set(newValue) {
+        // todo: support assigning array (as we do with proxies)
+        let oldValue = internalValue
+        if (oldValue !== newValue) {
+          internalValue = newValue
+          trigger(target, key)
+        }
+      },
+    })
+  })
+
+  return target
+}
+
+const hasProxySupport = typeof Proxy !== 'undefined'
+
+export const reactive = (target, mode = 'Proxy', global = false) => {
+  // force defineProperty reactivity mode when no proxy support
+  if (hasProxySupport === false) {
+    mode = 'defineProperty'
+  }
+  return mode === 'defineProperty'
+    ? reactiveDefineProperty(target, global)
+    : reactiveProxy(target, undefined, undefined, global)
+}
+
+export const memo = (raw) => {
+  const r = {
+    get value() {
+      track(r, 'value')
+      return raw
+    },
+    set value(v) {
+      raw = v
+      trigger(r, 'value')
+    },
+  }
+  return r
+}