@lightningjs/blits 1.30.0 → 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 -1005
  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,473 +1,473 @@
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 test from 'tape'
19
- import { matchHash, getHash, to } from './router.js'
20
-
21
- const routes = [
22
- {
23
- path: '/',
24
- },
25
- {
26
- path: '/page1',
27
- },
28
- {
29
- path: '/page1/subpage1',
30
- },
31
- {
32
- path: '/tv/:show/seasons/:season',
33
- },
34
- {
35
- path: '/movies/special',
36
- },
37
- {
38
- path: '/movies/:name',
39
- },
40
- {
41
- path: '/examples/*',
42
- },
43
- {
44
- path: '/route/with/trailing/slash/',
45
- },
46
- {
47
- path: '/dutchmovies/:id',
48
- },
49
- {
50
- path: '*',
51
- },
52
- ]
53
-
54
- test('Type of matchHash', (assert) => {
55
- const expected = 'function'
56
- const actual = typeof matchHash
57
-
58
- assert.equal(actual, expected, 'matchhash should be a function')
59
- assert.end()
60
- })
61
-
62
- test('Match paths with static routes that have an exact match', (assert) => {
63
- assert.equal(matchHash('', routes), routes[0], 'Should return the correct route object')
64
- assert.equal(matchHash('/', routes), routes[0], 'Should return the correct route object')
65
- assert.equal(matchHash('/page1', routes), routes[1], 'Should return the correct route object')
66
- assert.equal(
67
- matchHash('/page1/subpage1', routes),
68
- routes[2],
69
- 'Should return the correct route object'
70
- )
71
- assert.equal(
72
- matchHash('/movies/special', routes),
73
- routes[4],
74
- 'Should return the correct route object'
75
- )
76
- assert.end()
77
- })
78
-
79
- test('Match paths with dynamic route parts', (assert) => {
80
- assert.equal(
81
- matchHash('/tv/simpsons/seasons/first', routes),
82
- routes[3],
83
- 'Should return the correct route object'
84
- )
85
-
86
- assert.equal(
87
- matchHash('/tv/simpsons/season/first', routes),
88
- routes[9],
89
- 'Should return the correct route object'
90
- )
91
-
92
- assert.equal(
93
- matchHash('/examples/test/seasons/5', routes),
94
- routes[6],
95
- 'Should return the correct route object'
96
- )
97
-
98
- assert.equal(
99
- matchHash('/movies/avengers-endgame', routes),
100
- routes[5],
101
- 'Should return the correct route object'
102
- )
103
-
104
- assert.equal(
105
- matchHash('/movies/special-1', routes),
106
- routes[5],
107
- 'Should return the correct route object'
108
- )
109
-
110
- assert.equal(
111
- matchHash('/dutchmovies/123', routes),
112
- routes[8],
113
- 'Should return the correct route object'
114
- )
115
-
116
- assert.end()
117
- })
118
-
119
- test('Match paths with a wildcard asterix', (assert) => {
120
- assert.equal(
121
- matchHash('/examples/example1', routes),
122
- routes[6],
123
- 'Should return the correct route object'
124
- )
125
-
126
- assert.equal(
127
- matchHash('/examples/example1/subexample/and-another-page', routes),
128
- routes[6],
129
- 'Should return the correct route object'
130
- )
131
-
132
- assert.equal(matchHash('/404', routes), routes[9], 'Should return the correct route object')
133
-
134
- assert.equal(
135
- matchHash('/page1/non-existing-path', routes),
136
- routes[9],
137
- 'Should return the correct route object'
138
- )
139
-
140
- assert.equal(
141
- matchHash('/page1/subpage1/i-dont-exist', routes),
142
- routes[9],
143
- 'Should return the correct route object'
144
- )
145
-
146
- assert.equal(
147
- matchHash('/completely/unexpected/route', routes),
148
- routes[9],
149
- 'Should return the correct route object'
150
- )
151
-
152
- assert.end()
153
- })
154
-
155
- test('Add params to route for dynamic route matches', (assert) => {
156
- const match1 = matchHash('/tv/simpsons/seasons/first', routes)
157
-
158
- assert.deepEqual(
159
- match1.params,
160
- {
161
- show: 'simpsons',
162
- season: 'first',
163
- },
164
- 'Should return the correct params object'
165
- )
166
-
167
- const match2 = matchHash('/movies/avengers-endgame', routes)
168
- assert.deepEqual(
169
- match2.params,
170
- {
171
- name: 'avengers-endgame',
172
- },
173
- 'Should return the correct route object'
174
- )
175
-
176
- const match3 = matchHash('/dutchmovies/1', routes)
177
- assert.deepEqual(
178
- match3.params,
179
- {
180
- id: '1',
181
- },
182
- 'Should return the correct route object'
183
- )
184
-
185
- assert.end()
186
- })
187
-
188
- test('Add remaining path as param for wild card routes', (assert) => {
189
- const match1 = matchHash('/examples/example1', routes)
190
- assert.deepEqual(match1.params, { path: 'example1' }, 'Should return the correct route object')
191
-
192
- const match2 = matchHash('/examples/example1/subexample/and-another-page', routes)
193
- assert.deepEqual(
194
- match2.params,
195
- { path: 'example1/subexample/and-another-page' },
196
- 'Should return the correct params object'
197
- )
198
-
199
- const match3 = matchHash('/404', routes)
200
- assert.deepEqual(match3.params, { path: '404' }, 'Should return the correct params object')
201
-
202
- const match4 = matchHash('/page1/subpage1/i-dont-exist', routes)
203
- assert.deepEqual(
204
- match4.params,
205
- { path: 'page1/subpage1/i-dont-exist' },
206
- 'Should return the correct params object'
207
- )
208
-
209
- assert.end()
210
- })
211
-
212
- test('Work with trailing slashes', (assert) => {
213
- assert.equal(matchHash('/page1/', routes), routes[1], 'Should return the correct route object')
214
- assert.equal(
215
- matchHash('/page1//////', routes),
216
- routes[1],
217
- 'Should return the correct route object'
218
- )
219
- assert.equal(
220
- matchHash('/page1/subpage1/', routes),
221
- routes[2],
222
- 'Should return the correct route object'
223
- )
224
-
225
- assert.equal(
226
- matchHash('/route/with/trailing/slash', routes),
227
- routes[7],
228
- 'Should return the correct route object'
229
- )
230
-
231
- assert.equal(
232
- matchHash('/tv/simpsons/seasons/first', routes),
233
- routes[3],
234
- 'Should return the correct route object'
235
- )
236
-
237
- assert.end()
238
- })
239
-
240
- test('Work with and without leading slashes', (assert) => {
241
- assert.equal(matchHash('page1/', routes), routes[1], 'Should return the correct route object')
242
-
243
- assert.equal(matchHash('////page1', routes), routes[1], 'Should return the correct route object')
244
- assert.equal(
245
- matchHash('page1/subpage1/', routes),
246
- routes[2],
247
- 'Should return the correct route object'
248
- )
249
-
250
- assert.equal(
251
- matchHash('route/with/trailing/slash', routes),
252
- routes[7],
253
- 'Should return the correct route object'
254
- )
255
-
256
- assert.equal(
257
- matchHash('//tv/simpsons/seasons/first//', routes),
258
- routes[3],
259
- 'Should return the correct route object'
260
- )
261
-
262
- assert.end()
263
- })
264
-
265
- test('Match routes case insensitive', (assert) => {
266
- assert.equal(matchHash('/', routes), routes[0], 'Should return the correct route object')
267
- assert.equal(matchHash('/Page1', routes), routes[1], 'Should return the correct route object')
268
- assert.equal(
269
- matchHash('/pagE1/SUBpage1', routes),
270
- routes[2],
271
- 'Should return the correct route object'
272
- )
273
- assert.equal(
274
- matchHash('/Tv/SimpsonS/Seasons/First', routes),
275
- routes[3],
276
- 'Should return the correct route object'
277
- )
278
-
279
- assert.equal(
280
- matchHash('/Movies/Avengers-Endgame', routes),
281
- routes[5],
282
- 'Should return the correct route object'
283
- )
284
- assert.end()
285
- })
286
-
287
- test('Match routes case insensitive, but pass props with original casing', (assert) => {
288
- const match1 = matchHash('/Tv/SimpsonS/Seasons/First', routes)
289
- assert.deepEqual(
290
- match1.params,
291
- {
292
- show: 'SimpsonS',
293
- season: 'First',
294
- },
295
- 'Should return the correct params object'
296
- )
297
-
298
- const match2 = matchHash('/Movies/Avengers-Endgame', routes)
299
- assert.deepEqual(
300
- match2.params,
301
- {
302
- name: 'Avengers-Endgame',
303
- },
304
- 'Should return the correct params object'
305
- )
306
-
307
- const match3 = matchHash('/DutchMovies/ID_123', routes)
308
- assert.deepEqual(
309
- match3.params,
310
- {
311
- id: 'ID_123',
312
- },
313
- 'Should return the correct params object'
314
- )
315
-
316
- assert.end()
317
- })
318
-
319
- test('Match paths with dynamic route parts along with query string params', (assert) => {
320
- const hash1 = '#/tv/simpsons/seasons/first?token=123&ln=en'
321
- document.location.hash = hash1
322
-
323
- const { hash, path, queryParams } = getHash()
324
-
325
- assert.equal(hash, hash1, 'Should return correct hash')
326
- assert.equal(path, '/tv/simpsons/seasons/first', 'Should return the correct route path')
327
- assert.equal(matchHash(path, routes), routes[3], 'Should return the correct route object')
328
- assert.equal(
329
- queryParams.get('token'),
330
- '123',
331
- 'Should contain the correct query parameter key with value'
332
- )
333
- assert.equal(
334
- queryParams.get('ln'),
335
- 'en',
336
- 'Should contain the correct query parameter key with value'
337
- )
338
- assert.end()
339
- })
340
-
341
- test('Get the hash from the URL', (assert) => {
342
- const hash = '#/movies/action/the-avengers'
343
- document.location.hash = hash
344
-
345
- const result = getHash()
346
-
347
- assert.equal(
348
- result.hash,
349
- hash,
350
- 'The result object should contain a hash key with the correct location hash'
351
- )
352
-
353
- assert.equal(
354
- result.path,
355
- '/movies/action/the-avengers',
356
- 'The result object should contain a path key with the hash (stripped the # symbol)'
357
- )
358
-
359
- assert.end()
360
- })
361
-
362
- test('Get the hash from the URL and handle query params', (assert) => {
363
- const hash = '#/movies/comedy/the-hangover?category=1&item=2'
364
- document.location.hash = hash
365
-
366
- const result = getHash()
367
-
368
- assert.equal(
369
- result.hash,
370
- hash,
371
- 'The result object should contain a hash key with the correct location hash without the query params'
372
- )
373
-
374
- assert.equal(
375
- result.path,
376
- '/movies/comedy/the-hangover',
377
- 'The result object should contain a path key with the hash (stripped the # symbol)'
378
- )
379
-
380
- assert.equal(
381
- result.queryParams instanceof URLSearchParams,
382
- true,
383
- 'The result object should contain a queryParams key with an URLSearchParams object'
384
- )
385
-
386
- assert.equal(
387
- result.queryParams.get('category'),
388
- '1',
389
- 'The result object should contain a queryParams key with the correct route query param values'
390
- )
391
-
392
- assert.equal(
393
- result.queryParams.get('item'),
394
- '2',
395
- 'The result object should contain a queryParams key with the correct route query param values'
396
- )
397
-
398
- assert.end()
399
- })
400
-
401
- test('Get route object from Match hash when navigating using to() method', (assert) => {
402
- const hash = '/page1/subpage1'
403
-
404
- to(hash)
405
-
406
- const result = matchHash(hash, routes)
407
-
408
- assert.equal(
409
- result.path,
410
- 'page1/subpage1',
411
- 'The result object should contain a path key with path hash'
412
- )
413
- assert.equal(
414
- Object.keys(result.params).length,
415
- 0,
416
- 'The results object should contain a params key with zero props'
417
- )
418
- assert.equal(
419
- Object.keys(result.data).length,
420
- 0,
421
- 'The results object should contain a data key with zero props'
422
- )
423
- assert.equal(
424
- Object.keys(result.options).length,
425
- 0,
426
- 'The results object should contain a options key with zero props'
427
- )
428
- assert.end()
429
- })
430
-
431
- test('Get route object from Match hash when navigating using to() method with options', (assert) => {
432
- const hash = '/page1/subpage1'
433
-
434
- to(hash, undefined, { keepAlive: true })
435
-
436
- const result = matchHash(hash, routes)
437
-
438
- assert.equal(
439
- result.path,
440
- 'page1/subpage1',
441
- 'The result object should contain a path key with path hash'
442
- )
443
-
444
- assert.equal(
445
- result.options.keepAlive,
446
- true,
447
- 'The results object should contain a options key with keep alive as True'
448
- )
449
-
450
- assert.end()
451
- })
452
-
453
- test('Get Hash from URL when navigating using to() method', (assert) => {
454
- const hash = '#/movies/action/avengers'
455
-
456
- to(hash)
457
-
458
- const result = getHash()
459
-
460
- assert.equal(
461
- result.hash,
462
- hash,
463
- 'The result object key property should contain correct location hash'
464
- )
465
-
466
- assert.equal(
467
- result.path,
468
- '/movies/action/avengers',
469
- 'The result object should contain a path key with hash without #'
470
- )
471
-
472
- assert.end()
473
- })
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 test from 'tape'
19
+ import { matchHash, getHash, to } from './router.js'
20
+
21
+ const routes = [
22
+ {
23
+ path: '/',
24
+ },
25
+ {
26
+ path: '/page1',
27
+ },
28
+ {
29
+ path: '/page1/subpage1',
30
+ },
31
+ {
32
+ path: '/tv/:show/seasons/:season',
33
+ },
34
+ {
35
+ path: '/movies/special',
36
+ },
37
+ {
38
+ path: '/movies/:name',
39
+ },
40
+ {
41
+ path: '/examples/*',
42
+ },
43
+ {
44
+ path: '/route/with/trailing/slash/',
45
+ },
46
+ {
47
+ path: '/dutchmovies/:id',
48
+ },
49
+ {
50
+ path: '*',
51
+ },
52
+ ]
53
+
54
+ test('Type of matchHash', (assert) => {
55
+ const expected = 'function'
56
+ const actual = typeof matchHash
57
+
58
+ assert.equal(actual, expected, 'matchhash should be a function')
59
+ assert.end()
60
+ })
61
+
62
+ test('Match paths with static routes that have an exact match', (assert) => {
63
+ assert.equal(matchHash('', routes), routes[0], 'Should return the correct route object')
64
+ assert.equal(matchHash('/', routes), routes[0], 'Should return the correct route object')
65
+ assert.equal(matchHash('/page1', routes), routes[1], 'Should return the correct route object')
66
+ assert.equal(
67
+ matchHash('/page1/subpage1', routes),
68
+ routes[2],
69
+ 'Should return the correct route object'
70
+ )
71
+ assert.equal(
72
+ matchHash('/movies/special', routes),
73
+ routes[4],
74
+ 'Should return the correct route object'
75
+ )
76
+ assert.end()
77
+ })
78
+
79
+ test('Match paths with dynamic route parts', (assert) => {
80
+ assert.equal(
81
+ matchHash('/tv/simpsons/seasons/first', routes),
82
+ routes[3],
83
+ 'Should return the correct route object'
84
+ )
85
+
86
+ assert.equal(
87
+ matchHash('/tv/simpsons/season/first', routes),
88
+ routes[9],
89
+ 'Should return the correct route object'
90
+ )
91
+
92
+ assert.equal(
93
+ matchHash('/examples/test/seasons/5', routes),
94
+ routes[6],
95
+ 'Should return the correct route object'
96
+ )
97
+
98
+ assert.equal(
99
+ matchHash('/movies/avengers-endgame', routes),
100
+ routes[5],
101
+ 'Should return the correct route object'
102
+ )
103
+
104
+ assert.equal(
105
+ matchHash('/movies/special-1', routes),
106
+ routes[5],
107
+ 'Should return the correct route object'
108
+ )
109
+
110
+ assert.equal(
111
+ matchHash('/dutchmovies/123', routes),
112
+ routes[8],
113
+ 'Should return the correct route object'
114
+ )
115
+
116
+ assert.end()
117
+ })
118
+
119
+ test('Match paths with a wildcard asterix', (assert) => {
120
+ assert.equal(
121
+ matchHash('/examples/example1', routes),
122
+ routes[6],
123
+ 'Should return the correct route object'
124
+ )
125
+
126
+ assert.equal(
127
+ matchHash('/examples/example1/subexample/and-another-page', routes),
128
+ routes[6],
129
+ 'Should return the correct route object'
130
+ )
131
+
132
+ assert.equal(matchHash('/404', routes), routes[9], 'Should return the correct route object')
133
+
134
+ assert.equal(
135
+ matchHash('/page1/non-existing-path', routes),
136
+ routes[9],
137
+ 'Should return the correct route object'
138
+ )
139
+
140
+ assert.equal(
141
+ matchHash('/page1/subpage1/i-dont-exist', routes),
142
+ routes[9],
143
+ 'Should return the correct route object'
144
+ )
145
+
146
+ assert.equal(
147
+ matchHash('/completely/unexpected/route', routes),
148
+ routes[9],
149
+ 'Should return the correct route object'
150
+ )
151
+
152
+ assert.end()
153
+ })
154
+
155
+ test('Add params to route for dynamic route matches', (assert) => {
156
+ const match1 = matchHash('/tv/simpsons/seasons/first', routes)
157
+
158
+ assert.deepEqual(
159
+ match1.params,
160
+ {
161
+ show: 'simpsons',
162
+ season: 'first',
163
+ },
164
+ 'Should return the correct params object'
165
+ )
166
+
167
+ const match2 = matchHash('/movies/avengers-endgame', routes)
168
+ assert.deepEqual(
169
+ match2.params,
170
+ {
171
+ name: 'avengers-endgame',
172
+ },
173
+ 'Should return the correct route object'
174
+ )
175
+
176
+ const match3 = matchHash('/dutchmovies/1', routes)
177
+ assert.deepEqual(
178
+ match3.params,
179
+ {
180
+ id: '1',
181
+ },
182
+ 'Should return the correct route object'
183
+ )
184
+
185
+ assert.end()
186
+ })
187
+
188
+ test('Add remaining path as param for wild card routes', (assert) => {
189
+ const match1 = matchHash('/examples/example1', routes)
190
+ assert.deepEqual(match1.params, { path: 'example1' }, 'Should return the correct route object')
191
+
192
+ const match2 = matchHash('/examples/example1/subexample/and-another-page', routes)
193
+ assert.deepEqual(
194
+ match2.params,
195
+ { path: 'example1/subexample/and-another-page' },
196
+ 'Should return the correct params object'
197
+ )
198
+
199
+ const match3 = matchHash('/404', routes)
200
+ assert.deepEqual(match3.params, { path: '404' }, 'Should return the correct params object')
201
+
202
+ const match4 = matchHash('/page1/subpage1/i-dont-exist', routes)
203
+ assert.deepEqual(
204
+ match4.params,
205
+ { path: 'page1/subpage1/i-dont-exist' },
206
+ 'Should return the correct params object'
207
+ )
208
+
209
+ assert.end()
210
+ })
211
+
212
+ test('Work with trailing slashes', (assert) => {
213
+ assert.equal(matchHash('/page1/', routes), routes[1], 'Should return the correct route object')
214
+ assert.equal(
215
+ matchHash('/page1//////', routes),
216
+ routes[1],
217
+ 'Should return the correct route object'
218
+ )
219
+ assert.equal(
220
+ matchHash('/page1/subpage1/', routes),
221
+ routes[2],
222
+ 'Should return the correct route object'
223
+ )
224
+
225
+ assert.equal(
226
+ matchHash('/route/with/trailing/slash', routes),
227
+ routes[7],
228
+ 'Should return the correct route object'
229
+ )
230
+
231
+ assert.equal(
232
+ matchHash('/tv/simpsons/seasons/first', routes),
233
+ routes[3],
234
+ 'Should return the correct route object'
235
+ )
236
+
237
+ assert.end()
238
+ })
239
+
240
+ test('Work with and without leading slashes', (assert) => {
241
+ assert.equal(matchHash('page1/', routes), routes[1], 'Should return the correct route object')
242
+
243
+ assert.equal(matchHash('////page1', routes), routes[1], 'Should return the correct route object')
244
+ assert.equal(
245
+ matchHash('page1/subpage1/', routes),
246
+ routes[2],
247
+ 'Should return the correct route object'
248
+ )
249
+
250
+ assert.equal(
251
+ matchHash('route/with/trailing/slash', routes),
252
+ routes[7],
253
+ 'Should return the correct route object'
254
+ )
255
+
256
+ assert.equal(
257
+ matchHash('//tv/simpsons/seasons/first//', routes),
258
+ routes[3],
259
+ 'Should return the correct route object'
260
+ )
261
+
262
+ assert.end()
263
+ })
264
+
265
+ test('Match routes case insensitive', (assert) => {
266
+ assert.equal(matchHash('/', routes), routes[0], 'Should return the correct route object')
267
+ assert.equal(matchHash('/Page1', routes), routes[1], 'Should return the correct route object')
268
+ assert.equal(
269
+ matchHash('/pagE1/SUBpage1', routes),
270
+ routes[2],
271
+ 'Should return the correct route object'
272
+ )
273
+ assert.equal(
274
+ matchHash('/Tv/SimpsonS/Seasons/First', routes),
275
+ routes[3],
276
+ 'Should return the correct route object'
277
+ )
278
+
279
+ assert.equal(
280
+ matchHash('/Movies/Avengers-Endgame', routes),
281
+ routes[5],
282
+ 'Should return the correct route object'
283
+ )
284
+ assert.end()
285
+ })
286
+
287
+ test('Match routes case insensitive, but pass props with original casing', (assert) => {
288
+ const match1 = matchHash('/Tv/SimpsonS/Seasons/First', routes)
289
+ assert.deepEqual(
290
+ match1.params,
291
+ {
292
+ show: 'SimpsonS',
293
+ season: 'First',
294
+ },
295
+ 'Should return the correct params object'
296
+ )
297
+
298
+ const match2 = matchHash('/Movies/Avengers-Endgame', routes)
299
+ assert.deepEqual(
300
+ match2.params,
301
+ {
302
+ name: 'Avengers-Endgame',
303
+ },
304
+ 'Should return the correct params object'
305
+ )
306
+
307
+ const match3 = matchHash('/DutchMovies/ID_123', routes)
308
+ assert.deepEqual(
309
+ match3.params,
310
+ {
311
+ id: 'ID_123',
312
+ },
313
+ 'Should return the correct params object'
314
+ )
315
+
316
+ assert.end()
317
+ })
318
+
319
+ test('Match paths with dynamic route parts along with query string params', (assert) => {
320
+ const hash1 = '#/tv/simpsons/seasons/first?token=123&ln=en'
321
+ document.location.hash = hash1
322
+
323
+ const { hash, path, queryParams } = getHash()
324
+
325
+ assert.equal(hash, hash1, 'Should return correct hash')
326
+ assert.equal(path, '/tv/simpsons/seasons/first', 'Should return the correct route path')
327
+ assert.equal(matchHash(path, routes), routes[3], 'Should return the correct route object')
328
+ assert.equal(
329
+ queryParams.get('token'),
330
+ '123',
331
+ 'Should contain the correct query parameter key with value'
332
+ )
333
+ assert.equal(
334
+ queryParams.get('ln'),
335
+ 'en',
336
+ 'Should contain the correct query parameter key with value'
337
+ )
338
+ assert.end()
339
+ })
340
+
341
+ test('Get the hash from the URL', (assert) => {
342
+ const hash = '#/movies/action/the-avengers'
343
+ document.location.hash = hash
344
+
345
+ const result = getHash()
346
+
347
+ assert.equal(
348
+ result.hash,
349
+ hash,
350
+ 'The result object should contain a hash key with the correct location hash'
351
+ )
352
+
353
+ assert.equal(
354
+ result.path,
355
+ '/movies/action/the-avengers',
356
+ 'The result object should contain a path key with the hash (stripped the # symbol)'
357
+ )
358
+
359
+ assert.end()
360
+ })
361
+
362
+ test('Get the hash from the URL and handle query params', (assert) => {
363
+ const hash = '#/movies/comedy/the-hangover?category=1&item=2'
364
+ document.location.hash = hash
365
+
366
+ const result = getHash()
367
+
368
+ assert.equal(
369
+ result.hash,
370
+ hash,
371
+ 'The result object should contain a hash key with the correct location hash without the query params'
372
+ )
373
+
374
+ assert.equal(
375
+ result.path,
376
+ '/movies/comedy/the-hangover',
377
+ 'The result object should contain a path key with the hash (stripped the # symbol)'
378
+ )
379
+
380
+ assert.equal(
381
+ result.queryParams instanceof URLSearchParams,
382
+ true,
383
+ 'The result object should contain a queryParams key with an URLSearchParams object'
384
+ )
385
+
386
+ assert.equal(
387
+ result.queryParams.get('category'),
388
+ '1',
389
+ 'The result object should contain a queryParams key with the correct route query param values'
390
+ )
391
+
392
+ assert.equal(
393
+ result.queryParams.get('item'),
394
+ '2',
395
+ 'The result object should contain a queryParams key with the correct route query param values'
396
+ )
397
+
398
+ assert.end()
399
+ })
400
+
401
+ test('Get route object from Match hash when navigating using to() method', (assert) => {
402
+ const hash = '/page1/subpage1'
403
+
404
+ to(hash)
405
+
406
+ const result = matchHash(hash, routes)
407
+
408
+ assert.equal(
409
+ result.path,
410
+ 'page1/subpage1',
411
+ 'The result object should contain a path key with path hash'
412
+ )
413
+ assert.equal(
414
+ Object.keys(result.params).length,
415
+ 0,
416
+ 'The results object should contain a params key with zero props'
417
+ )
418
+ assert.equal(
419
+ Object.keys(result.data).length,
420
+ 0,
421
+ 'The results object should contain a data key with zero props'
422
+ )
423
+ assert.equal(
424
+ Object.keys(result.options).length,
425
+ 0,
426
+ 'The results object should contain a options key with zero props'
427
+ )
428
+ assert.end()
429
+ })
430
+
431
+ test('Get route object from Match hash when navigating using to() method with options', (assert) => {
432
+ const hash = '/page1/subpage1'
433
+
434
+ to(hash, undefined, { keepAlive: true })
435
+
436
+ const result = matchHash(hash, routes)
437
+
438
+ assert.equal(
439
+ result.path,
440
+ 'page1/subpage1',
441
+ 'The result object should contain a path key with path hash'
442
+ )
443
+
444
+ assert.equal(
445
+ result.options.keepAlive,
446
+ true,
447
+ 'The results object should contain a options key with keep alive as True'
448
+ )
449
+
450
+ assert.end()
451
+ })
452
+
453
+ test('Get Hash from URL when navigating using to() method', (assert) => {
454
+ const hash = '#/movies/action/avengers'
455
+
456
+ to(hash)
457
+
458
+ const result = getHash()
459
+
460
+ assert.equal(
461
+ result.hash,
462
+ hash,
463
+ 'The result object key property should contain correct location hash'
464
+ )
465
+
466
+ assert.equal(
467
+ result.path,
468
+ '/movies/action/avengers',
469
+ 'The result object should contain a path key with hash without #'
470
+ )
471
+
472
+ assert.end()
473
+ })