@lightningjs/blits 1.30.1 → 1.30.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (149) hide show
  1. package/.editorconfig +7 -7
  2. package/.eslintignore +1 -1
  3. package/.eslintrc.cjs +65 -65
  4. package/.github/workflows/comment-lint-results.yml +124 -124
  5. package/.github/workflows/comment-test-results.yml +108 -108
  6. package/.github/workflows/deploy-docs.yml +27 -27
  7. package/.github/workflows/run-blits-tests.yml +141 -141
  8. package/.github/workflows/run-lint.yml +127 -127
  9. package/.husky/pre-commit +1 -1
  10. package/.vscode/extensions.json +7 -7
  11. package/.vscode/settings.json +9 -9
  12. package/CHANGELOG.md +1019 -1012
  13. package/COPYING +1 -0
  14. package/LICENSE +202 -202
  15. package/NOTICE +12 -12
  16. package/README.md +33 -33
  17. package/bin/index.js +8 -8
  18. package/blits.d.ts +6 -6
  19. package/docs/README.md +19 -19
  20. package/docs/_sidebar.md +37 -37
  21. package/docs/built-in/directives.md +50 -50
  22. package/docs/built-in/for-loop.md +203 -203
  23. package/docs/built-in/layout.md +168 -168
  24. package/docs/components/component_state.md +90 -90
  25. package/docs/components/computed_properties.md +45 -45
  26. package/docs/components/lifecycle_events.md +42 -42
  27. package/docs/components/methods.md +45 -45
  28. package/docs/components/props.md +56 -56
  29. package/docs/components/user_input.md +186 -186
  30. package/docs/components/utility_methods.md +320 -320
  31. package/docs/components/watchers.md +34 -34
  32. package/docs/essentials/application_root.md +19 -19
  33. package/docs/essentials/components.md +68 -68
  34. package/docs/essentials/displaying_images.md +67 -67
  35. package/docs/essentials/displaying_text.md +135 -135
  36. package/docs/essentials/element_attributes.md +195 -195
  37. package/docs/essentials/settings.md +117 -117
  38. package/docs/essentials/template_syntax.md +83 -83
  39. package/docs/getting_started/file_structure.md +58 -58
  40. package/docs/getting_started/getting_started.md +45 -45
  41. package/docs/getting_started/intro.md +20 -20
  42. package/docs/index.html +47 -47
  43. package/docs/performance/lazy-loading.md +161 -161
  44. package/docs/plugins/global_app_state.md +98 -98
  45. package/docs/plugins/language.md +172 -172
  46. package/docs/plugins/text-to-speech-announcer.md +119 -119
  47. package/docs/plugins/theme.md +176 -176
  48. package/docs/router/basics.md +175 -175
  49. package/docs/router/hooks.md +70 -70
  50. package/docs/router/transitions.md +146 -146
  51. package/docs/sidebar.json +171 -171
  52. package/docs/transitions_animations/transitions.md +150 -150
  53. package/index.d.ts +1099 -1099
  54. package/index.js +28 -28
  55. package/jsconfig.json +12 -12
  56. package/package.json +56 -56
  57. package/public/assets/fps_sprite.base64.js +1 -1
  58. package/scripts/postpublish.js +59 -59
  59. package/scripts/prepublishOnly.js +84 -84
  60. package/scripts/prepush.js +78 -78
  61. package/src/announcer/announcer.js +162 -162
  62. package/src/announcer/speechSynthesis.js +107 -107
  63. package/src/application.js +100 -100
  64. package/src/component/base/announcer.js +27 -27
  65. package/src/component/base/events.js +69 -69
  66. package/src/component/base/index.js +33 -33
  67. package/src/component/base/methods.js +244 -244
  68. package/src/component/base/router.js +41 -41
  69. package/src/component/base/timeouts_intervals.js +99 -99
  70. package/src/component/base/utils.js +72 -72
  71. package/src/component/setup/computed.js +48 -48
  72. package/src/component/setup/index.js +62 -62
  73. package/src/component/setup/input.js +30 -30
  74. package/src/component/setup/methods.js +37 -37
  75. package/src/component/setup/props.js +62 -62
  76. package/src/component/setup/props.test.js +238 -238
  77. package/src/component/setup/routes.js +42 -42
  78. package/src/component/setup/state.js +59 -59
  79. package/src/component/setup/watch.js +35 -35
  80. package/src/component.js +437 -437
  81. package/src/component.test.js +388 -388
  82. package/src/components/Circle.js +73 -73
  83. package/src/components/Circle.orig.js +31 -31
  84. package/src/components/FPScounter.js +1510 -1510
  85. package/src/components/FPScounter.orig.js +121 -121
  86. package/src/components/RouterView.js +81 -81
  87. package/src/components/RouterView.orig.js +54 -54
  88. package/src/components/Sprite.js +94 -94
  89. package/src/components/Sprite.orig.js +58 -58
  90. package/src/components/index.js +28 -28
  91. package/src/components/index.orig.js +28 -28
  92. package/src/constants.js +21 -21
  93. package/src/engine.js +1 -1
  94. package/src/engines/L3/element.js +744 -744
  95. package/src/engines/L3/element.test.js +579 -579
  96. package/src/engines/L3/fontLoader.js +38 -38
  97. package/src/engines/L3/index.js +7 -7
  98. package/src/engines/L3/launch.js +123 -123
  99. package/src/engines/L3/shaderLoader.js +12 -12
  100. package/src/engines/index.js +1 -1
  101. package/src/focus.js +90 -90
  102. package/src/helpers/deepEqualArray.js +50 -50
  103. package/src/helpers/deepEqualArray.test.js +127 -127
  104. package/src/helpers/fetchJson.js +34 -34
  105. package/src/helpers/sequence.js +26 -26
  106. package/src/launch.js +123 -123
  107. package/src/lib/blitsfileconverter/blitsfileconverter.js +52 -52
  108. package/src/lib/codegenerator/generator.js +788 -788
  109. package/src/lib/codegenerator/generator.test.js +3801 -3801
  110. package/src/lib/colors/colors.js +92 -92
  111. package/src/lib/colors/colors.test.js +290 -290
  112. package/src/lib/colors/htmlColors.js +168 -168
  113. package/src/lib/componentId.js +49 -49
  114. package/src/lib/componentId.test.js +84 -84
  115. package/src/lib/eventListeners.js +123 -123
  116. package/src/lib/eventListeners.test.js +236 -236
  117. package/src/lib/hooks.js +59 -59
  118. package/src/lib/lifecycle.js +85 -85
  119. package/src/lib/log.js +117 -117
  120. package/src/lib/precompiler/precompiler.js +73 -73
  121. package/src/lib/reactivity/effect.js +93 -93
  122. package/src/lib/reactivity/effect.test.js +35 -35
  123. package/src/lib/reactivity/reactive.js +208 -208
  124. package/src/lib/reactivity/reactive.test.js +27 -27
  125. package/src/lib/reactivityguard/computedprops.js +218 -218
  126. package/src/lib/symbols.js +108 -108
  127. package/src/lib/templateparser/parser.js +386 -386
  128. package/src/lib/templateparser/parser.test.js +1411 -1411
  129. package/src/lib/utils.js +27 -27
  130. package/src/plugin.js +27 -27
  131. package/src/plugins/appstate.js +26 -26
  132. package/src/plugins/index.js +20 -20
  133. package/src/plugins/language.js +152 -152
  134. package/src/plugins/log.js +25 -25
  135. package/src/plugins/theme.js +94 -94
  136. package/src/router/router.js +514 -514
  137. package/src/router/router.test.js +473 -473
  138. package/src/router/transitions/fadeIn.js +27 -27
  139. package/src/router/transitions/fadeInOut.js +33 -33
  140. package/src/router/transitions/index.js +21 -21
  141. package/src/router/transitions/slideIn.js +28 -28
  142. package/src/router/transitions/slideInOut.js +33 -33
  143. package/src/settings.js +40 -40
  144. package/vite/blitsFileConverter.js +67 -67
  145. package/vite/index.js +28 -28
  146. package/vite/msdfGenerator.js +269 -269
  147. package/vite/preCompiler.js +42 -42
  148. package/vite/reactivityGuard.js +45 -45
  149. package/vscode/data/template-attributes.json +589 -589
@@ -1,107 +1,107 @@
1
- /*
2
- * Copyright 2024 Comcast Cable Communications Management, LLC
3
- * Licensed under the Apache License, Version 2.0 (the "License");
4
- * you may not use this file except in compliance with the License.
5
- * You may obtain a copy of the License at
6
- *
7
- * http://www.apache.org/licenses/LICENSE-2.0
8
- *
9
- * Unless required by applicable law or agreed to in writing, software
10
- * distributed under the License is distributed on an "AS IS" BASIS,
11
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- * See the License for the specific language governing permissions and
13
- * limitations under the License.
14
- *
15
- * SPDX-License-Identifier: Apache-2.0
16
- */
17
-
18
- import { Log } from '../lib/log.js'
19
-
20
- const syn = window.speechSynthesis
21
-
22
- const isAndroid = /android/i.test((window.navigator || {}).userAgent || '')
23
-
24
- let initialized = false
25
- let infinityTimer = null
26
- const clear = () => infinityTimer && clearTimeout(infinityTimer)
27
-
28
- const resumeInfinity = (target) => {
29
- if (!target || infinityTimer) {
30
- return clear()
31
- }
32
-
33
- syn.pause()
34
- syn.resume()
35
-
36
- infinityTimer = setTimeout(() => {
37
- resumeInfinity(target)
38
- }, 5000)
39
- }
40
-
41
- const defaultUtteranceProps = {
42
- lang: 'en-US',
43
- pitch: 1,
44
- rate: 1,
45
- voice: null,
46
- volume: 1,
47
- }
48
-
49
- const initialize = () => {
50
- defaultUtteranceProps.voice = syn.getVoices()[0]
51
- initialized = true
52
- }
53
-
54
- const speak = (options) => {
55
- const utterance = new SpeechSynthesisUtterance(options.message)
56
-
57
- utterance.lang = options.lang || defaultUtteranceProps.lang
58
- utterance.pitch = options.pitch || defaultUtteranceProps.pitch
59
- utterance.rate = options.rate || defaultUtteranceProps.rate
60
- utterance.voice = options.voice || defaultUtteranceProps.voice
61
- utterance.volume = options.volume || defaultUtteranceProps.volume
62
-
63
- if (isAndroid === false) {
64
- utterance.onstart = () => {
65
- resumeInfinity(utterance)
66
- }
67
-
68
- utterance.onresume = () => {
69
- resumeInfinity(utterance)
70
- }
71
- }
72
-
73
- return new Promise((resolve, reject) => {
74
- utterance.onend = () => {
75
- resolve()
76
- }
77
- utterance.onerror = (e) => {
78
- reject(e)
79
- }
80
-
81
- syn.speak(utterance)
82
- })
83
- }
84
-
85
- export default {
86
- speak(options) {
87
- if (syn !== undefined) {
88
- if (initialized === false) {
89
- initialize()
90
- }
91
- return speak(options)
92
- } else {
93
- Log.error('speechSynthesis web API not available')
94
- return Promise.reject({ error: 'unavailable' })
95
- }
96
- },
97
- cancel() {
98
- if (syn !== undefined) {
99
- syn.cancel()
100
- clear()
101
- }
102
- },
103
- // @todo
104
- // getVoices() {
105
- // return syn.getVoices()
106
- // },
107
- }
1
+ /*
2
+ * Copyright 2024 Comcast Cable Communications Management, LLC
3
+ * Licensed under the Apache License, Version 2.0 (the "License");
4
+ * you may not use this file except in compliance with the License.
5
+ * You may obtain a copy of the License at
6
+ *
7
+ * http://www.apache.org/licenses/LICENSE-2.0
8
+ *
9
+ * Unless required by applicable law or agreed to in writing, software
10
+ * distributed under the License is distributed on an "AS IS" BASIS,
11
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ * See the License for the specific language governing permissions and
13
+ * limitations under the License.
14
+ *
15
+ * SPDX-License-Identifier: Apache-2.0
16
+ */
17
+
18
+ import { Log } from '../lib/log.js'
19
+
20
+ const syn = window.speechSynthesis
21
+
22
+ const isAndroid = /android/i.test((window.navigator || {}).userAgent || '')
23
+
24
+ let initialized = false
25
+ let infinityTimer = null
26
+ const clear = () => infinityTimer && clearTimeout(infinityTimer)
27
+
28
+ const resumeInfinity = (target) => {
29
+ if (!target || infinityTimer) {
30
+ return clear()
31
+ }
32
+
33
+ syn.pause()
34
+ syn.resume()
35
+
36
+ infinityTimer = setTimeout(() => {
37
+ resumeInfinity(target)
38
+ }, 5000)
39
+ }
40
+
41
+ const defaultUtteranceProps = {
42
+ lang: 'en-US',
43
+ pitch: 1,
44
+ rate: 1,
45
+ voice: null,
46
+ volume: 1,
47
+ }
48
+
49
+ const initialize = () => {
50
+ defaultUtteranceProps.voice = syn.getVoices()[0]
51
+ initialized = true
52
+ }
53
+
54
+ const speak = (options) => {
55
+ const utterance = new SpeechSynthesisUtterance(options.message)
56
+
57
+ utterance.lang = options.lang || defaultUtteranceProps.lang
58
+ utterance.pitch = options.pitch || defaultUtteranceProps.pitch
59
+ utterance.rate = options.rate || defaultUtteranceProps.rate
60
+ utterance.voice = options.voice || defaultUtteranceProps.voice
61
+ utterance.volume = options.volume || defaultUtteranceProps.volume
62
+
63
+ if (isAndroid === false) {
64
+ utterance.onstart = () => {
65
+ resumeInfinity(utterance)
66
+ }
67
+
68
+ utterance.onresume = () => {
69
+ resumeInfinity(utterance)
70
+ }
71
+ }
72
+
73
+ return new Promise((resolve, reject) => {
74
+ utterance.onend = () => {
75
+ resolve()
76
+ }
77
+ utterance.onerror = (e) => {
78
+ reject(e)
79
+ }
80
+
81
+ syn.speak(utterance)
82
+ })
83
+ }
84
+
85
+ export default {
86
+ speak(options) {
87
+ if (syn !== undefined) {
88
+ if (initialized === false) {
89
+ initialize()
90
+ }
91
+ return speak(options)
92
+ } else {
93
+ Log.error('speechSynthesis web API not available')
94
+ return Promise.reject({ error: 'unavailable' })
95
+ }
96
+ },
97
+ cancel() {
98
+ if (syn !== undefined) {
99
+ syn.cancel()
100
+ clear()
101
+ }
102
+ },
103
+ // @todo
104
+ // getVoices() {
105
+ // return syn.getVoices()
106
+ // },
107
+ }
@@ -1,100 +1,100 @@
1
- /*
2
- * Copyright 2023 Comcast Cable Communications Management, LLC
3
- * Licensed under the Apache License, Version 2.0 (the "License");
4
- * you may not use this file except in compliance with the License.
5
- * You may obtain a copy of the License at
6
- *
7
- * http://www.apache.org/licenses/LICENSE-2.0
8
- *
9
- * Unless required by applicable law or agreed to in writing, software
10
- * distributed under the License is distributed on an "AS IS" BASIS,
11
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- * See the License for the specific language governing permissions and
13
- * limitations under the License.
14
- *
15
- * SPDX-License-Identifier: Apache-2.0
16
- */
17
-
18
- import Component from './component.js'
19
- import { default as Focus, keyUpCallbacks } from './focus.js'
20
- import Settings from './settings.js'
21
-
22
- import symbols from './lib/symbols.js'
23
- import { DEFAULT_HOLD_TIMEOUT_MS } from './constants.js'
24
-
25
- const Application = (config) => {
26
- const defaultKeyMap = {
27
- ArrowLeft: 'left',
28
- ArrowRight: 'right',
29
- ArrowUp: 'up',
30
- ArrowDown: 'down',
31
- Enter: 'enter',
32
- ' ': 'space',
33
- Backspace: 'back',
34
- Escape: 'escape',
35
- 37: 'left',
36
- 39: 'right',
37
- 38: 'up',
38
- 40: 'down',
39
- 13: 'enter',
40
- 32: 'space',
41
- 8: 'back',
42
- 27: 'escape',
43
- }
44
-
45
- config.hooks = config.hooks || {}
46
-
47
- let keyDownHandler
48
- let keyUpHandler
49
- let holdTimeout
50
-
51
- config.hooks[symbols.destroy] = function () {
52
- document.removeEventListener('keydown', keyDownHandler)
53
- document.removeEventListener('keyup', keyUpHandler)
54
- }
55
-
56
- config.hooks[symbols.init] = function () {
57
- // set the initial activation state of the announcer based on launch setting
58
- this.$announcer.toggle(Settings.get('announcer', false))
59
- const keyMap = { ...defaultKeyMap, ...Settings.get('keymap', {}) }
60
-
61
- keyDownHandler = async (e) => {
62
- const key = keyMap[e.key] || keyMap[e.keyCode] || e.key || e.keyCode
63
- // intercept key press if specified in main Application component
64
- if (
65
- this[symbols.inputEvents] !== undefined &&
66
- this[symbols.inputEvents].intercept !== undefined
67
- ) {
68
- e = await this[symbols.inputEvents].intercept.call(this, e)
69
- // only pass on the key press to focused component when keyboard event is returned
70
- if (e instanceof KeyboardEvent === false) return
71
- }
72
-
73
- Focus.input(key, e)
74
- clearTimeout(holdTimeout)
75
- holdTimeout = setTimeout(() => {
76
- Focus.hold = true
77
- }, Settings.get('holdTimeout', DEFAULT_HOLD_TIMEOUT_MS))
78
- }
79
-
80
- keyUpHandler = (e) => {
81
- const cb = keyUpCallbacks.get(e.code)
82
- if (cb !== undefined && typeof cb === 'function') {
83
- keyUpCallbacks.delete(e.code)
84
- cb()
85
- }
86
- clearTimeout(holdTimeout)
87
- Focus.hold = false
88
- }
89
-
90
- document.addEventListener('keydown', keyDownHandler)
91
- document.addEventListener('keyup', keyUpHandler)
92
-
93
- // next tick
94
- setTimeout(() => Focus.set(this))
95
- }
96
-
97
- return Component('App', config)
98
- }
99
-
100
- export default Application
1
+ /*
2
+ * Copyright 2023 Comcast Cable Communications Management, LLC
3
+ * Licensed under the Apache License, Version 2.0 (the "License");
4
+ * you may not use this file except in compliance with the License.
5
+ * You may obtain a copy of the License at
6
+ *
7
+ * http://www.apache.org/licenses/LICENSE-2.0
8
+ *
9
+ * Unless required by applicable law or agreed to in writing, software
10
+ * distributed under the License is distributed on an "AS IS" BASIS,
11
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ * See the License for the specific language governing permissions and
13
+ * limitations under the License.
14
+ *
15
+ * SPDX-License-Identifier: Apache-2.0
16
+ */
17
+
18
+ import Component from './component.js'
19
+ import { default as Focus, keyUpCallbacks } from './focus.js'
20
+ import Settings from './settings.js'
21
+
22
+ import symbols from './lib/symbols.js'
23
+ import { DEFAULT_HOLD_TIMEOUT_MS } from './constants.js'
24
+
25
+ const Application = (config) => {
26
+ const defaultKeyMap = {
27
+ ArrowLeft: 'left',
28
+ ArrowRight: 'right',
29
+ ArrowUp: 'up',
30
+ ArrowDown: 'down',
31
+ Enter: 'enter',
32
+ ' ': 'space',
33
+ Backspace: 'back',
34
+ Escape: 'escape',
35
+ 37: 'left',
36
+ 39: 'right',
37
+ 38: 'up',
38
+ 40: 'down',
39
+ 13: 'enter',
40
+ 32: 'space',
41
+ 8: 'back',
42
+ 27: 'escape',
43
+ }
44
+
45
+ config.hooks = config.hooks || {}
46
+
47
+ let keyDownHandler
48
+ let keyUpHandler
49
+ let holdTimeout
50
+
51
+ config.hooks[symbols.destroy] = function () {
52
+ document.removeEventListener('keydown', keyDownHandler)
53
+ document.removeEventListener('keyup', keyUpHandler)
54
+ }
55
+
56
+ config.hooks[symbols.init] = function () {
57
+ // set the initial activation state of the announcer based on launch setting
58
+ this.$announcer.toggle(Settings.get('announcer', false))
59
+ const keyMap = { ...defaultKeyMap, ...Settings.get('keymap', {}) }
60
+
61
+ keyDownHandler = async (e) => {
62
+ const key = keyMap[e.key] || keyMap[e.keyCode] || e.key || e.keyCode
63
+ // intercept key press if specified in main Application component
64
+ if (
65
+ this[symbols.inputEvents] !== undefined &&
66
+ this[symbols.inputEvents].intercept !== undefined
67
+ ) {
68
+ e = await this[symbols.inputEvents].intercept.call(this, e)
69
+ // only pass on the key press to focused component when keyboard event is returned
70
+ if (e instanceof KeyboardEvent === false) return
71
+ }
72
+
73
+ Focus.input(key, e)
74
+ clearTimeout(holdTimeout)
75
+ holdTimeout = setTimeout(() => {
76
+ Focus.hold = true
77
+ }, Settings.get('holdTimeout', DEFAULT_HOLD_TIMEOUT_MS))
78
+ }
79
+
80
+ keyUpHandler = (e) => {
81
+ const cb = keyUpCallbacks.get(e.code)
82
+ if (cb !== undefined && typeof cb === 'function') {
83
+ keyUpCallbacks.delete(e.code)
84
+ cb()
85
+ }
86
+ clearTimeout(holdTimeout)
87
+ Focus.hold = false
88
+ }
89
+
90
+ document.addEventListener('keydown', keyDownHandler)
91
+ document.addEventListener('keyup', keyUpHandler)
92
+
93
+ // next tick
94
+ setTimeout(() => Focus.set(this))
95
+ }
96
+
97
+ return Component('App', config)
98
+ }
99
+
100
+ export default Application
@@ -1,27 +1,27 @@
1
- /*
2
- * Copyright 2024 Comcast Cable Communications Management, LLC
3
- * Licensed under the Apache License, Version 2.0 (the "License");
4
- * you may not use this file except in compliance with the License.
5
- * You may obtain a copy of the License at
6
- *
7
- * http://www.apache.org/licenses/LICENSE-2.0
8
- *
9
- * Unless required by applicable law or agreed to in writing, software
10
- * distributed under the License is distributed on an "AS IS" BASIS,
11
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- * See the License for the specific language governing permissions and
13
- * limitations under the License.
14
- *
15
- * SPDX-License-Identifier: Apache-2.0
16
- */
17
-
18
- import Announcer from '../../announcer/announcer.js'
19
-
20
- export default {
21
- $announcer: {
22
- value: Announcer,
23
- writable: false,
24
- enumerable: true,
25
- configurable: false,
26
- },
27
- }
1
+ /*
2
+ * Copyright 2024 Comcast Cable Communications Management, LLC
3
+ * Licensed under the Apache License, Version 2.0 (the "License");
4
+ * you may not use this file except in compliance with the License.
5
+ * You may obtain a copy of the License at
6
+ *
7
+ * http://www.apache.org/licenses/LICENSE-2.0
8
+ *
9
+ * Unless required by applicable law or agreed to in writing, software
10
+ * distributed under the License is distributed on an "AS IS" BASIS,
11
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ * See the License for the specific language governing permissions and
13
+ * limitations under the License.
14
+ *
15
+ * SPDX-License-Identifier: Apache-2.0
16
+ */
17
+
18
+ import Announcer from '../../announcer/announcer.js'
19
+
20
+ export default {
21
+ $announcer: {
22
+ value: Announcer,
23
+ writable: false,
24
+ enumerable: true,
25
+ configurable: false,
26
+ },
27
+ }
@@ -1,69 +1,69 @@
1
- /*
2
- * Copyright 2024 Comcast Cable Communications Management, LLC
3
- * Licensed under the Apache License, Version 2.0 (the "License");
4
- * you may not use this file except in compliance with the License.
5
- * You may obtain a copy of the License at
6
- *
7
- * http://www.apache.org/licenses/LICENSE-2.0
8
- *
9
- * Unless required by applicable law or agreed to in writing, software
10
- * distributed under the License is distributed on an "AS IS" BASIS,
11
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- * See the License for the specific language governing permissions and
13
- * limitations under the License.
14
- *
15
- * SPDX-License-Identifier: Apache-2.0
16
- */
17
-
18
- import eventListeners from '../../lib/eventListeners.js'
19
-
20
- export default {
21
- /**
22
- * Emits an event to all registered listeners for the given event name.
23
- *
24
- * @param {string} event - The name of the event to emit.
25
- * @param {any} params - The parameters to pass to the event listeners.
26
- * @returns {boolean} True if all listeners executed, false otherwise.
27
- */
28
- $emit: {
29
- value: function (event, params) {
30
- // returning if all listeners executed
31
- return eventListeners.executeListeners(event, params)
32
- },
33
- writable: false,
34
- enumerable: true,
35
- configurable: false,
36
- },
37
- /**
38
- * Registers a listener callback for a specific event.
39
- *
40
- * @param {string} event - The name of the event to listen for.
41
- * @param {Function} callback - The callback function to execute when the event is emitted.
42
- * @param {number} [priority=0] - The priority of the listener (higher runs first).
43
- * @returns {void}
44
- */
45
- $listen: {
46
- value: function (event, callback, priority = 0) {
47
- // early exit when component is marked as end of life
48
- if (this.eol === true) return
49
- eventListeners.registerListener(this, event, callback, priority)
50
- },
51
- writable: false,
52
- enumerable: true,
53
- configurable: false,
54
- },
55
- /**
56
- * Deregisters a listener for a specific event.
57
- *
58
- * @param {string} event - The name of the event to stop listening for.
59
- * @returns {void}
60
- */
61
- $unlisten: {
62
- value: function (event) {
63
- eventListeners.deregisterListener(this, event)
64
- },
65
- writable: false,
66
- enumerable: true,
67
- configurable: false,
68
- },
69
- }
1
+ /*
2
+ * Copyright 2024 Comcast Cable Communications Management, LLC
3
+ * Licensed under the Apache License, Version 2.0 (the "License");
4
+ * you may not use this file except in compliance with the License.
5
+ * You may obtain a copy of the License at
6
+ *
7
+ * http://www.apache.org/licenses/LICENSE-2.0
8
+ *
9
+ * Unless required by applicable law or agreed to in writing, software
10
+ * distributed under the License is distributed on an "AS IS" BASIS,
11
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ * See the License for the specific language governing permissions and
13
+ * limitations under the License.
14
+ *
15
+ * SPDX-License-Identifier: Apache-2.0
16
+ */
17
+
18
+ import eventListeners from '../../lib/eventListeners.js'
19
+
20
+ export default {
21
+ /**
22
+ * Emits an event to all registered listeners for the given event name.
23
+ *
24
+ * @param {string} event - The name of the event to emit.
25
+ * @param {any} params - The parameters to pass to the event listeners.
26
+ * @returns {boolean} True if all listeners executed, false otherwise.
27
+ */
28
+ $emit: {
29
+ value: function (event, params) {
30
+ // returning if all listeners executed
31
+ return eventListeners.executeListeners(event, params)
32
+ },
33
+ writable: false,
34
+ enumerable: true,
35
+ configurable: false,
36
+ },
37
+ /**
38
+ * Registers a listener callback for a specific event.
39
+ *
40
+ * @param {string} event - The name of the event to listen for.
41
+ * @param {Function} callback - The callback function to execute when the event is emitted.
42
+ * @param {number} [priority=0] - The priority of the listener (higher runs first).
43
+ * @returns {void}
44
+ */
45
+ $listen: {
46
+ value: function (event, callback, priority = 0) {
47
+ // early exit when component is marked as end of life
48
+ if (this.eol === true) return
49
+ eventListeners.registerListener(this, event, callback, priority)
50
+ },
51
+ writable: false,
52
+ enumerable: true,
53
+ configurable: false,
54
+ },
55
+ /**
56
+ * Deregisters a listener for a specific event.
57
+ *
58
+ * @param {string} event - The name of the event to stop listening for.
59
+ * @returns {void}
60
+ */
61
+ $unlisten: {
62
+ value: function (event) {
63
+ eventListeners.deregisterListener(this, event)
64
+ },
65
+ writable: false,
66
+ enumerable: true,
67
+ configurable: false,
68
+ },
69
+ }
@@ -1,33 +1,33 @@
1
- /*
2
- * Copyright 2024 Comcast Cable Communications Management, LLC
3
- * Licensed under the Apache License, Version 2.0 (the "License");
4
- * you may not use this file except in compliance with the License.
5
- * You may obtain a copy of the License at
6
- *
7
- * http://www.apache.org/licenses/LICENSE-2.0
8
- *
9
- * Unless required by applicable law or agreed to in writing, software
10
- * distributed under the License is distributed on an "AS IS" BASIS,
11
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- * See the License for the specific language governing permissions and
13
- * limitations under the License.
14
- *
15
- * SPDX-License-Identifier: Apache-2.0
16
- */
17
-
18
- import methods from './methods.js'
19
- import scheduling from './timeouts_intervals.js'
20
- import events from './events.js'
21
- import router from './router.js'
22
- import announcer from './announcer.js'
23
- import utils from './utils.js'
24
- import symbols from '../../lib/symbols.js'
25
-
26
- export const shared = { ...events, ...router, ...announcer }
27
-
28
- export default Object.defineProperties(
29
- {
30
- [symbols['launched']]: false,
31
- },
32
- { ...methods, ...scheduling, ...shared, ...utils }
33
- )
1
+ /*
2
+ * Copyright 2024 Comcast Cable Communications Management, LLC
3
+ * Licensed under the Apache License, Version 2.0 (the "License");
4
+ * you may not use this file except in compliance with the License.
5
+ * You may obtain a copy of the License at
6
+ *
7
+ * http://www.apache.org/licenses/LICENSE-2.0
8
+ *
9
+ * Unless required by applicable law or agreed to in writing, software
10
+ * distributed under the License is distributed on an "AS IS" BASIS,
11
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ * See the License for the specific language governing permissions and
13
+ * limitations under the License.
14
+ *
15
+ * SPDX-License-Identifier: Apache-2.0
16
+ */
17
+
18
+ import methods from './methods.js'
19
+ import scheduling from './timeouts_intervals.js'
20
+ import events from './events.js'
21
+ import router from './router.js'
22
+ import announcer from './announcer.js'
23
+ import utils from './utils.js'
24
+ import symbols from '../../lib/symbols.js'
25
+
26
+ export const shared = { ...events, ...router, ...announcer }
27
+
28
+ export default Object.defineProperties(
29
+ {
30
+ [symbols['launched']]: false,
31
+ },
32
+ { ...methods, ...scheduling, ...shared, ...utils }
33
+ )