toiljs 0.0.14 → 0.0.16

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 (225) hide show
  1. package/.babelrc +13 -13
  2. package/.gitattributes +2 -2
  3. package/.github/ISSUE_TEMPLATE/bug_report.md +38 -38
  4. package/.github/ISSUE_TEMPLATE/bug_report.yml +90 -90
  5. package/.github/ISSUE_TEMPLATE/config.yml +8 -8
  6. package/.github/ISSUE_TEMPLATE/feature_request.md +20 -20
  7. package/.github/PULL_REQUEST_TEMPLATE.md +43 -43
  8. package/.github/changelog-config.json +45 -45
  9. package/.github/dependabot.yml +27 -27
  10. package/.github/workflows/ci.yml +191 -191
  11. package/.prettierrc.json +11 -11
  12. package/.vscode/settings.json +9 -9
  13. package/CHANGELOG.md +5 -5
  14. package/LICENSE +187 -187
  15. package/README.md +339 -315
  16. package/as-pect.asconfig.json +34 -34
  17. package/as-pect.config.js +65 -65
  18. package/assets/logo.svg +36 -36
  19. package/build/backend/.tsbuildinfo +1 -1
  20. package/build/cli/.tsbuildinfo +1 -1
  21. package/build/cli/index.js +2926 -191
  22. package/build/client/.tsbuildinfo +1 -1
  23. package/build/client/dev/devtools.d.ts +6 -0
  24. package/build/client/dev/devtools.js +442 -0
  25. package/build/client/dev/error-overlay.d.ts +9 -0
  26. package/build/client/dev/error-overlay.js +19 -4
  27. package/build/client/head/metadata.d.ts +3 -1
  28. package/build/client/head/metadata.js +8 -0
  29. package/build/client/index.d.ts +4 -4
  30. package/build/client/index.js +2 -2
  31. package/build/client/navigation/navigation.d.ts +2 -0
  32. package/build/client/navigation/navigation.js +9 -1
  33. package/build/client/navigation/prefetch.d.ts +1 -0
  34. package/build/client/navigation/prefetch.js +35 -0
  35. package/build/client/routing/Router.js +1 -1
  36. package/build/client/routing/hooks.js +6 -2
  37. package/build/client/routing/loader.d.ts +25 -0
  38. package/build/client/routing/loader.js +53 -7
  39. package/build/client/routing/mount.js +4 -3
  40. package/build/compiler/.tsbuildinfo +1 -1
  41. package/build/compiler/config.d.ts +18 -0
  42. package/build/compiler/config.js +8 -0
  43. package/build/compiler/docs.js +16 -16
  44. package/build/compiler/generate.js +3 -0
  45. package/build/compiler/index.d.ts +2 -2
  46. package/build/compiler/index.js +3 -1
  47. package/build/compiler/plugin.js +156 -0
  48. package/build/compiler/prerender.d.ts +1 -0
  49. package/build/compiler/prerender.js +2 -1
  50. package/build/compiler/seo.d.ts +2 -2
  51. package/build/compiler/seo.js +8 -6
  52. package/build/compiler/ssg.d.ts +5 -0
  53. package/build/compiler/ssg.js +121 -0
  54. package/build/io/.tsbuildinfo +1 -1
  55. package/build/logger/.tsbuildinfo +1 -1
  56. package/build/shared/.tsbuildinfo +1 -1
  57. package/eslint.config.js +48 -48
  58. package/examples/basic/client/404.tsx +11 -11
  59. package/examples/basic/client/components/.gitkeep +1 -1
  60. package/examples/basic/client/global-error.tsx +13 -13
  61. package/examples/basic/client/layout.tsx +25 -25
  62. package/examples/basic/client/public/images/.gitkeep +1 -1
  63. package/examples/basic/client/public/images/logo.svg +36 -36
  64. package/examples/basic/client/public/robots.txt +2 -2
  65. package/examples/basic/client/routes/docs/[...slug].tsx +12 -12
  66. package/examples/basic/client/routes/features/error/error.tsx +16 -16
  67. package/examples/basic/client/routes/features/template/b.tsx +14 -14
  68. package/examples/basic/client/routes/files/[[...slug]].tsx +21 -21
  69. package/examples/basic/client/routes/gallery/layout.tsx +13 -13
  70. package/examples/basic/client/routes/io.tsx +24 -24
  71. package/examples/basic/client/routes/loader-demo/loading.tsx +13 -13
  72. package/examples/basic/client/routes/search.tsx +61 -61
  73. package/examples/basic/client/toil.tsx +5 -5
  74. package/package.json +155 -147
  75. package/presets/eslint.js +88 -88
  76. package/presets/no-uint8array-tostring.js +200 -200
  77. package/presets/prettier.json +18 -18
  78. package/presets/tsconfig.json +37 -37
  79. package/src/backend/index.ts +160 -160
  80. package/src/cli/proc.ts +50 -50
  81. package/src/cli/updates.ts +69 -69
  82. package/src/cli/validate.ts +31 -31
  83. package/src/client/channel/channel.ts +146 -146
  84. package/src/client/components/Form.tsx +65 -65
  85. package/src/client/components/Script.tsx +113 -113
  86. package/src/client/components/Slot.tsx +21 -21
  87. package/src/client/dev/devtools.tsx +973 -0
  88. package/src/client/dev/error-overlay.tsx +30 -4
  89. package/src/client/head/head.ts +167 -167
  90. package/src/client/head/metadata.ts +19 -1
  91. package/src/client/index.ts +19 -9
  92. package/src/client/navigation/NavLink.tsx +86 -86
  93. package/src/client/navigation/navigation.ts +25 -5
  94. package/src/client/navigation/prefetch.ts +169 -130
  95. package/src/client/navigation/scroll.ts +53 -53
  96. package/src/client/routing/Router.tsx +8 -2
  97. package/src/client/routing/action.ts +122 -122
  98. package/src/client/routing/error-boundary.tsx +43 -43
  99. package/src/client/routing/hooks.ts +21 -6
  100. package/src/client/routing/loader.ts +325 -225
  101. package/src/client/routing/match.ts +47 -47
  102. package/src/client/routing/mount.tsx +54 -52
  103. package/src/client/routing/params-context.ts +10 -10
  104. package/src/client/routing/slot-context.ts +7 -7
  105. package/src/client/search/search.ts +189 -189
  106. package/src/client/search/use-page-search.ts +73 -73
  107. package/src/client/types.ts +73 -73
  108. package/src/compiler/config.ts +47 -1
  109. package/src/compiler/docs.ts +228 -228
  110. package/src/compiler/generate.ts +394 -391
  111. package/src/compiler/index.ts +64 -54
  112. package/src/compiler/pages.ts +70 -70
  113. package/src/compiler/plugin.ts +170 -2
  114. package/src/compiler/prerender.ts +5 -1
  115. package/src/compiler/seo.ts +23 -7
  116. package/src/compiler/ssg.ts +162 -0
  117. package/src/io/BinaryReader.ts +340 -340
  118. package/src/io/BinaryWriter.ts +385 -385
  119. package/src/io/FastMap.ts +127 -127
  120. package/src/io/index.ts +11 -11
  121. package/src/io/lengths.ts +14 -14
  122. package/src/io/types.ts +18 -18
  123. package/src/logger/index.ts +22 -22
  124. package/src/server/index.ts +10 -10
  125. package/src/server/main.ts +13 -13
  126. package/src/server/tsconfig.json +4 -4
  127. package/src/shared/index.ts +10 -10
  128. package/std/client/index.d.ts +15 -15
  129. package/std/client/package.json +3 -3
  130. package/test/assembly/example.spec.ts +7 -7
  131. package/test/channel.test.ts +21 -21
  132. package/test/dom/Link.test.tsx +47 -47
  133. package/test/dom/NavLink.test.tsx +37 -37
  134. package/test/dom/error-overlay.test.tsx +44 -44
  135. package/test/dom/loader.test.tsx +121 -121
  136. package/test/dom/navigation.test.ts +59 -59
  137. package/test/dom/revalidate.test.tsx +38 -38
  138. package/test/dom/route-head.test.tsx +78 -78
  139. package/test/dom/router-loading.test.tsx +44 -44
  140. package/test/dom/scroll.test.ts +56 -56
  141. package/test/dom/use-metadata.test.tsx +58 -0
  142. package/test/io.test.ts +93 -93
  143. package/test/navlink.test.ts +28 -28
  144. package/test/placeholder.test.ts +9 -9
  145. package/test/routes.test.ts +76 -76
  146. package/test/seo.test.ts +175 -164
  147. package/test/slot-layouts.test.ts +69 -69
  148. package/test/ssg.test.ts +36 -0
  149. package/test/update.test.ts +44 -44
  150. package/test/validate.test.ts +42 -42
  151. package/toil-routes.d.ts +7 -0
  152. package/toilconfig.json +30 -30
  153. package/tsconfig.backend.json +13 -13
  154. package/tsconfig.base.json +35 -35
  155. package/tsconfig.cli.json +13 -13
  156. package/tsconfig.client.json +14 -14
  157. package/tsconfig.compiler.json +13 -13
  158. package/tsconfig.io.json +12 -12
  159. package/tsconfig.json +22 -22
  160. package/tsconfig.logger.json +12 -12
  161. package/tsconfig.server.json +10 -10
  162. package/tsconfig.shared.json +12 -12
  163. package/vitest.config.ts +26 -26
  164. package/.idea/codeStyles/Project.xml +0 -54
  165. package/.idea/codeStyles/codeStyleConfig.xml +0 -5
  166. package/.idea/inspectionProfiles/Project_Default.xml +0 -6
  167. package/.idea/modules.xml +0 -8
  168. package/.idea/prettier.xml +0 -7
  169. package/.idea/toiljs.iml +0 -8
  170. package/.idea/vcs.xml +0 -6
  171. package/.toil/entry.tsx +0 -9
  172. package/.toil/index.html +0 -12
  173. package/.toil/routes.ts +0 -9
  174. package/build/cli/configure.d.ts +0 -16
  175. package/build/cli/configure.js +0 -272
  176. package/build/cli/create.d.ts +0 -16
  177. package/build/cli/create.js +0 -420
  178. package/build/cli/diagnostics.d.ts +0 -55
  179. package/build/cli/diagnostics.js +0 -333
  180. package/build/cli/doctor.d.ts +0 -6
  181. package/build/cli/doctor.js +0 -249
  182. package/build/cli/features.d.ts +0 -25
  183. package/build/cli/features.js +0 -107
  184. package/build/cli/index.d.ts +0 -2
  185. package/build/cli/proc.d.ts +0 -6
  186. package/build/cli/proc.js +0 -31
  187. package/build/cli/ui.d.ts +0 -9
  188. package/build/cli/ui.js +0 -75
  189. package/build/cli/update.d.ts +0 -7
  190. package/build/cli/update.js +0 -117
  191. package/build/cli/updates.d.ts +0 -10
  192. package/build/cli/updates.js +0 -45
  193. package/build/cli/validate.d.ts +0 -4
  194. package/build/cli/validate.js +0 -19
  195. package/build/client/Link.d.ts +0 -8
  196. package/build/client/Link.js +0 -44
  197. package/build/client/NavLink.d.ts +0 -14
  198. package/build/client/NavLink.js +0 -37
  199. package/build/client/Router.d.ts +0 -7
  200. package/build/client/Router.js +0 -55
  201. package/build/client/channel.d.ts +0 -23
  202. package/build/client/channel.js +0 -94
  203. package/build/client/error-boundary.d.ts +0 -16
  204. package/build/client/error-boundary.js +0 -19
  205. package/build/client/head.d.ts +0 -26
  206. package/build/client/head.js +0 -87
  207. package/build/client/hooks.d.ts +0 -17
  208. package/build/client/hooks.js +0 -48
  209. package/build/client/lazy.d.ts +0 -16
  210. package/build/client/lazy.js +0 -53
  211. package/build/client/match.d.ts +0 -2
  212. package/build/client/match.js +0 -32
  213. package/build/client/mount.d.ts +0 -2
  214. package/build/client/mount.js +0 -13
  215. package/build/client/navigation.d.ts +0 -13
  216. package/build/client/navigation.js +0 -97
  217. package/build/client/params-context.d.ts +0 -2
  218. package/build/client/params-context.js +0 -2
  219. package/build/client/prefetch.d.ts +0 -11
  220. package/build/client/prefetch.js +0 -100
  221. package/build/client/runtime.d.ts +0 -31
  222. package/build/client/runtime.js +0 -112
  223. package/build/client/scroll.d.ts +0 -8
  224. package/build/client/scroll.js +0 -36
  225. package/toil-env.d.ts +0 -16
@@ -1,37 +1,37 @@
1
- // @vitest-environment jsdom
2
- import { cleanup, render } from '@testing-library/react';
3
- import { afterEach, describe, expect, it } from 'vitest';
4
-
5
- import { NavLink } from '../../src/client/navigation/NavLink';
6
-
7
- afterEach(cleanup);
8
-
9
- describe('NavLink', () => {
10
- it('adds the active class + aria-current on the current route', () => {
11
- window.history.replaceState({}, '', '/about');
12
- const { getByText } = render(<NavLink href="/about">about</NavLink>);
13
- const a = getByText('about') as HTMLAnchorElement;
14
- expect(a.className).toContain('active');
15
- expect(a.getAttribute('aria-current')).toBe('page');
16
- });
17
-
18
- it('is not active on a different route', () => {
19
- window.history.replaceState({}, '', '/home');
20
- const { getByText } = render(<NavLink href="/about">about</NavLink>);
21
- const a = getByText('about') as HTMLAnchorElement;
22
- expect(a.className).not.toContain('active');
23
- expect(a.getAttribute('aria-current')).toBeNull();
24
- });
25
-
26
- it('supports a function className', () => {
27
- window.history.replaceState({}, '', '/about');
28
- const { getByText } = render(
29
- <NavLink
30
- href="/about"
31
- className={({ isActive }) => (isActive ? 'on' : 'off')}>
32
- about
33
- </NavLink>,
34
- );
35
- expect((getByText('about') as HTMLAnchorElement).className).toBe('on');
36
- });
37
- });
1
+ // @vitest-environment jsdom
2
+ import { cleanup, render } from '@testing-library/react';
3
+ import { afterEach, describe, expect, it } from 'vitest';
4
+
5
+ import { NavLink } from '../../src/client/navigation/NavLink';
6
+
7
+ afterEach(cleanup);
8
+
9
+ describe('NavLink', () => {
10
+ it('adds the active class + aria-current on the current route', () => {
11
+ window.history.replaceState({}, '', '/about');
12
+ const { getByText } = render(<NavLink href="/about">about</NavLink>);
13
+ const a = getByText('about') as HTMLAnchorElement;
14
+ expect(a.className).toContain('active');
15
+ expect(a.getAttribute('aria-current')).toBe('page');
16
+ });
17
+
18
+ it('is not active on a different route', () => {
19
+ window.history.replaceState({}, '', '/home');
20
+ const { getByText } = render(<NavLink href="/about">about</NavLink>);
21
+ const a = getByText('about') as HTMLAnchorElement;
22
+ expect(a.className).not.toContain('active');
23
+ expect(a.getAttribute('aria-current')).toBeNull();
24
+ });
25
+
26
+ it('supports a function className', () => {
27
+ window.history.replaceState({}, '', '/about');
28
+ const { getByText } = render(
29
+ <NavLink
30
+ href="/about"
31
+ className={({ isActive }) => (isActive ? 'on' : 'off')}>
32
+ about
33
+ </NavLink>,
34
+ );
35
+ expect((getByText('about') as HTMLAnchorElement).className).toBe('on');
36
+ });
37
+ });
@@ -1,44 +1,44 @@
1
- // @vitest-environment jsdom
2
- import { act, cleanup, fireEvent, render } from '@testing-library/react';
3
- import { afterEach, describe, expect, it, vi } from 'vitest';
4
-
5
- import {
6
- DevErrorBoundary,
7
- DevErrorOverlay,
8
- initDevErrorOverlay,
9
- } from '../../src/client/dev/error-overlay';
10
-
11
- afterEach(cleanup);
12
-
13
- function Boom(): never {
14
- throw new Error('render boom');
15
- }
16
-
17
- describe('dev error overlay', () => {
18
- it('surfaces an uncaught render error', () => {
19
- // React logs caught boundary errors to console.error, silence it for a clean test run.
20
- const spy = vi.spyOn(console, 'error').mockImplementation(() => undefined);
21
- const { getByRole } = render(
22
- <>
23
- <DevErrorBoundary>
24
- <Boom />
25
- </DevErrorBoundary>
26
- <DevErrorOverlay />
27
- </>,
28
- );
29
- expect(getByRole('alert').textContent).toContain('render boom');
30
- spy.mockRestore();
31
- });
32
-
33
- it('surfaces an unhandled window error and dismisses it', async () => {
34
- initDevErrorOverlay();
35
- const { findByRole, queryByRole, getByText } = render(<DevErrorOverlay />);
36
- act(() => {
37
- window.dispatchEvent(new ErrorEvent('error', { error: new Error('async boom') }));
38
- });
39
- const alert = await findByRole('alert');
40
- expect(alert.textContent).toContain('async boom');
41
- fireEvent.click(getByText('Dismiss'));
42
- expect(queryByRole('alert')).toBeNull();
43
- });
44
- });
1
+ // @vitest-environment jsdom
2
+ import { act, cleanup, fireEvent, render } from '@testing-library/react';
3
+ import { afterEach, describe, expect, it, vi } from 'vitest';
4
+
5
+ import {
6
+ DevErrorBoundary,
7
+ DevErrorOverlay,
8
+ initDevErrorOverlay,
9
+ } from '../../src/client/dev/error-overlay';
10
+
11
+ afterEach(cleanup);
12
+
13
+ function Boom(): never {
14
+ throw new Error('render boom');
15
+ }
16
+
17
+ describe('dev error overlay', () => {
18
+ it('surfaces an uncaught render error', () => {
19
+ // React logs caught boundary errors to console.error, silence it for a clean test run.
20
+ const spy = vi.spyOn(console, 'error').mockImplementation(() => undefined);
21
+ const { getByRole } = render(
22
+ <>
23
+ <DevErrorBoundary>
24
+ <Boom />
25
+ </DevErrorBoundary>
26
+ <DevErrorOverlay />
27
+ </>,
28
+ );
29
+ expect(getByRole('alert').textContent).toContain('render boom');
30
+ spy.mockRestore();
31
+ });
32
+
33
+ it('surfaces an unhandled window error and dismisses it', async () => {
34
+ initDevErrorOverlay();
35
+ const { findByRole, queryByRole, getByText } = render(<DevErrorOverlay />);
36
+ act(() => {
37
+ window.dispatchEvent(new ErrorEvent('error', { error: new Error('async boom') }));
38
+ });
39
+ const alert = await findByRole('alert');
40
+ expect(alert.textContent).toContain('async boom');
41
+ fireEvent.click(getByText('Dismiss'));
42
+ expect(queryByRole('alert')).toBeNull();
43
+ });
44
+ });
@@ -1,121 +1,121 @@
1
- // @vitest-environment jsdom
2
- import { afterEach, beforeEach, describe, expect, expectTypeOf, it, vi } from 'vitest';
3
-
4
- import type { Revalidate } from '../../src/client/routing/loader';
5
- import {
6
- clearLoaderData,
7
- invalidateLoaderData,
8
- type LoaderData,
9
- loaderKey,
10
- readRouteData,
11
- } from '../../src/client/routing/loader';
12
- import type { RouteDef } from '../../src/client/types';
13
-
14
- /** Reads route data, awaiting the suspending promise once if it's pending. */
15
- async function read(route: RouteDef, key: string, epoch: number): Promise<unknown> {
16
- try {
17
- return readRouteData(route, {}, key, epoch).data;
18
- } catch (thrown) {
19
- if (thrown instanceof Promise) {
20
- await thrown;
21
- return readRouteData(route, {}, key, epoch).data;
22
- }
23
- throw thrown;
24
- }
25
- }
26
-
27
- /** A route whose `load()` count tells us how many times the loader actually ran. */
28
- function makeRoute(revalidate?: Revalidate): { route: RouteDef; loads: () => number } {
29
- let loads = 0;
30
- const route: RouteDef = {
31
- pattern: '/x',
32
- load: () => {
33
- loads += 1;
34
- return Promise.resolve({
35
- default: () => null,
36
- loader: () => ({ n: loads }),
37
- revalidate,
38
- });
39
- },
40
- };
41
- return { route, loads: () => loads };
42
- }
43
-
44
- beforeEach(() => {
45
- clearLoaderData();
46
- });
47
- afterEach(() => {
48
- vi.useRealTimers();
49
- });
50
-
51
- describe('loader caching', () => {
52
- it('reuses cached data on re-read within the same navigation (loader runs once)', async () => {
53
- const { route, loads } = makeRoute();
54
- const key = loaderKey('/x', '');
55
- await read(route, key, 1);
56
- await read(route, key, 1);
57
- expect(loads()).toBe(1);
58
- });
59
-
60
- it('a route with no loader stays cached across navigations (never re-suspends)', async () => {
61
- let loads = 0;
62
- const route: RouteDef = {
63
- pattern: '/p',
64
- load: () => {
65
- loads += 1;
66
- return Promise.resolve({ default: () => null });
67
- },
68
- };
69
- const key = loaderKey('/p', '');
70
- await read(route, key, 1);
71
- await read(route, key, 2);
72
- await read(route, key, 3);
73
- expect(loads).toBe(1);
74
- });
75
-
76
- it('refetches on a new navigation under the default policy', async () => {
77
- const { route, loads } = makeRoute();
78
- const key = loaderKey('/x', '');
79
- await read(route, key, 1);
80
- await read(route, key, 2);
81
- expect(loads()).toBe(2);
82
- });
83
-
84
- it('revalidate=false caches across navigations', async () => {
85
- const { route, loads } = makeRoute(false);
86
- const key = loaderKey('/x', '');
87
- await read(route, key, 1);
88
- await read(route, key, 2);
89
- expect(loads()).toBe(1);
90
- });
91
-
92
- it('numeric revalidate caches until the staleTime elapses', async () => {
93
- vi.useFakeTimers();
94
- const { route, loads } = makeRoute(1); // 1 second
95
- const key = loaderKey('/x', '');
96
- await read(route, key, 1);
97
- await read(route, key, 2); // still fresh
98
- expect(loads()).toBe(1);
99
- vi.advanceTimersByTime(1500); // now stale
100
- await read(route, key, 3);
101
- expect(loads()).toBe(2);
102
- });
103
-
104
- it('invalidateLoaderData(href) forces a refetch of that route', async () => {
105
- const { route, loads } = makeRoute(false);
106
- const key = loaderKey('/x', '');
107
- await read(route, key, 1);
108
- invalidateLoaderData('/x');
109
- await read(route, key, 1);
110
- expect(loads()).toBe(2);
111
- });
112
- });
113
-
114
- describe('useLoaderData type inference', () => {
115
- it('LoaderData<typeof loader> resolves to the loader return type', () => {
116
- const loader = async () => Promise.resolve({ a: 1, b: 'x' as string | null });
117
- expectTypeOf<LoaderData<typeof loader>>().toEqualTypeOf<{ a: number; b: string | null }>();
118
- // An explicit type still passes straight through.
119
- expectTypeOf<LoaderData<{ id: number }>>().toEqualTypeOf<{ id: number }>();
120
- });
121
- });
1
+ // @vitest-environment jsdom
2
+ import { afterEach, beforeEach, describe, expect, expectTypeOf, it, vi } from 'vitest';
3
+
4
+ import type { Revalidate } from '../../src/client/routing/loader';
5
+ import {
6
+ clearLoaderData,
7
+ invalidateLoaderData,
8
+ type LoaderData,
9
+ loaderKey,
10
+ readRouteData,
11
+ } from '../../src/client/routing/loader';
12
+ import type { RouteDef } from '../../src/client/types';
13
+
14
+ /** Reads route data, awaiting the suspending promise once if it's pending. */
15
+ async function read(route: RouteDef, key: string, epoch: number): Promise<unknown> {
16
+ try {
17
+ return readRouteData(route, {}, key, epoch).data;
18
+ } catch (thrown) {
19
+ if (thrown instanceof Promise) {
20
+ await thrown;
21
+ return readRouteData(route, {}, key, epoch).data;
22
+ }
23
+ throw thrown;
24
+ }
25
+ }
26
+
27
+ /** A route whose `load()` count tells us how many times the loader actually ran. */
28
+ function makeRoute(revalidate?: Revalidate): { route: RouteDef; loads: () => number } {
29
+ let loads = 0;
30
+ const route: RouteDef = {
31
+ pattern: '/x',
32
+ load: () => {
33
+ loads += 1;
34
+ return Promise.resolve({
35
+ default: () => null,
36
+ loader: () => ({ n: loads }),
37
+ revalidate,
38
+ });
39
+ },
40
+ };
41
+ return { route, loads: () => loads };
42
+ }
43
+
44
+ beforeEach(() => {
45
+ clearLoaderData();
46
+ });
47
+ afterEach(() => {
48
+ vi.useRealTimers();
49
+ });
50
+
51
+ describe('loader caching', () => {
52
+ it('reuses cached data on re-read within the same navigation (loader runs once)', async () => {
53
+ const { route, loads } = makeRoute();
54
+ const key = loaderKey('/x', '');
55
+ await read(route, key, 1);
56
+ await read(route, key, 1);
57
+ expect(loads()).toBe(1);
58
+ });
59
+
60
+ it('a route with no loader stays cached across navigations (never re-suspends)', async () => {
61
+ let loads = 0;
62
+ const route: RouteDef = {
63
+ pattern: '/p',
64
+ load: () => {
65
+ loads += 1;
66
+ return Promise.resolve({ default: () => null });
67
+ },
68
+ };
69
+ const key = loaderKey('/p', '');
70
+ await read(route, key, 1);
71
+ await read(route, key, 2);
72
+ await read(route, key, 3);
73
+ expect(loads).toBe(1);
74
+ });
75
+
76
+ it('refetches on a new navigation under the default policy', async () => {
77
+ const { route, loads } = makeRoute();
78
+ const key = loaderKey('/x', '');
79
+ await read(route, key, 1);
80
+ await read(route, key, 2);
81
+ expect(loads()).toBe(2);
82
+ });
83
+
84
+ it('revalidate=false caches across navigations', async () => {
85
+ const { route, loads } = makeRoute(false);
86
+ const key = loaderKey('/x', '');
87
+ await read(route, key, 1);
88
+ await read(route, key, 2);
89
+ expect(loads()).toBe(1);
90
+ });
91
+
92
+ it('numeric revalidate caches until the staleTime elapses', async () => {
93
+ vi.useFakeTimers();
94
+ const { route, loads } = makeRoute(1); // 1 second
95
+ const key = loaderKey('/x', '');
96
+ await read(route, key, 1);
97
+ await read(route, key, 2); // still fresh
98
+ expect(loads()).toBe(1);
99
+ vi.advanceTimersByTime(1500); // now stale
100
+ await read(route, key, 3);
101
+ expect(loads()).toBe(2);
102
+ });
103
+
104
+ it('invalidateLoaderData(href) forces a refetch of that route', async () => {
105
+ const { route, loads } = makeRoute(false);
106
+ const key = loaderKey('/x', '');
107
+ await read(route, key, 1);
108
+ invalidateLoaderData('/x');
109
+ await read(route, key, 1);
110
+ expect(loads()).toBe(2);
111
+ });
112
+ });
113
+
114
+ describe('useLoaderData type inference', () => {
115
+ it('LoaderData<typeof loader> resolves to the loader return type', () => {
116
+ const loader = async () => Promise.resolve({ a: 1, b: 'x' as string | null });
117
+ expectTypeOf<LoaderData<typeof loader>>().toEqualTypeOf<{ a: number; b: string | null }>();
118
+ // An explicit type still passes straight through.
119
+ expectTypeOf<LoaderData<{ id: number }>>().toEqualTypeOf<{ id: number }>();
120
+ });
121
+ });
@@ -1,59 +1,59 @@
1
- // @vitest-environment jsdom
2
- import { beforeEach, describe, expect, it } from 'vitest';
3
-
4
- import {
5
- back,
6
- isNavigationPending,
7
- navigate,
8
- navigationEpoch,
9
- settleNavigation,
10
- subscribeLocation,
11
- } from '../../src/client/navigation/navigation';
12
-
13
- beforeEach(() => {
14
- window.history.replaceState({}, '', '/');
15
- });
16
-
17
- describe('navigate', () => {
18
- it('updates the location and notifies subscribers', () => {
19
- let calls = 0;
20
- const off = subscribeLocation(() => {
21
- calls += 1;
22
- });
23
- navigate('/about');
24
- expect(window.location.pathname).toBe('/about');
25
- expect(calls).toBe(1);
26
- off();
27
- });
28
-
29
- it('replace updates the location too', () => {
30
- navigate('/replaced', { replace: true });
31
- expect(window.location.pathname).toBe('/replaced');
32
- });
33
-
34
- it('increments the navigation epoch', () => {
35
- const before = navigationEpoch();
36
- navigate('/a');
37
- expect(navigationEpoch()).toBe(before + 1);
38
- });
39
-
40
- it('is pending after navigate, settled after settleNavigation', () => {
41
- navigate('/pending');
42
- expect(isNavigationPending()).toBe(true);
43
- settleNavigation();
44
- expect(isNavigationPending()).toBe(false);
45
- });
46
-
47
- it('back() triggers a notification', () => {
48
- navigate('/one');
49
- navigate('/two');
50
- let popped = 0;
51
- const off = subscribeLocation(() => {
52
- popped += 1;
53
- });
54
- back();
55
- // jsdom fires popstate synchronously for history.back within the same task.
56
- expect(popped).toBeGreaterThanOrEqual(0);
57
- off();
58
- });
59
- });
1
+ // @vitest-environment jsdom
2
+ import { beforeEach, describe, expect, it } from 'vitest';
3
+
4
+ import {
5
+ back,
6
+ isNavigationPending,
7
+ navigate,
8
+ navigationEpoch,
9
+ settleNavigation,
10
+ subscribeLocation,
11
+ } from '../../src/client/navigation/navigation';
12
+
13
+ beforeEach(() => {
14
+ window.history.replaceState({}, '', '/');
15
+ });
16
+
17
+ describe('navigate', () => {
18
+ it('updates the location and notifies subscribers', () => {
19
+ let calls = 0;
20
+ const off = subscribeLocation(() => {
21
+ calls += 1;
22
+ });
23
+ navigate('/about');
24
+ expect(window.location.pathname).toBe('/about');
25
+ expect(calls).toBe(1);
26
+ off();
27
+ });
28
+
29
+ it('replace updates the location too', () => {
30
+ navigate('/replaced', { replace: true });
31
+ expect(window.location.pathname).toBe('/replaced');
32
+ });
33
+
34
+ it('increments the navigation epoch', () => {
35
+ const before = navigationEpoch();
36
+ navigate('/a');
37
+ expect(navigationEpoch()).toBe(before + 1);
38
+ });
39
+
40
+ it('is pending after navigate, settled after settleNavigation', () => {
41
+ navigate('/pending');
42
+ expect(isNavigationPending()).toBe(true);
43
+ settleNavigation();
44
+ expect(isNavigationPending()).toBe(false);
45
+ });
46
+
47
+ it('back() triggers a notification', () => {
48
+ navigate('/one');
49
+ navigate('/two');
50
+ let popped = 0;
51
+ const off = subscribeLocation(() => {
52
+ popped += 1;
53
+ });
54
+ back();
55
+ // jsdom fires popstate synchronously for history.back within the same task.
56
+ expect(popped).toBeGreaterThanOrEqual(0);
57
+ off();
58
+ });
59
+ });
@@ -1,38 +1,38 @@
1
- // @vitest-environment jsdom
2
- import { act, cleanup, render } from '@testing-library/react';
3
- import { afterEach, beforeEach, describe, it } from 'vitest';
4
-
5
- import { Router } from '../../src/client/routing/Router';
6
- import { clearLoaderData, revalidate, useLoaderData } from '../../src/client/routing/loader';
7
- import type { RouteDef } from '../../src/client/types';
8
-
9
- afterEach(cleanup);
10
- beforeEach(() => {
11
- clearLoaderData();
12
- window.history.replaceState({}, '', '/');
13
- });
14
-
15
- describe('revalidate refetches', () => {
16
- it('re-runs the loader and updates the rendered data', async () => {
17
- let n = 0;
18
- function Page(): React.ReactNode {
19
- const value = useLoaderData<number>();
20
- return <p>val:{String(value)}</p>;
21
- }
22
- const routes: RouteDef[] = [
23
- {
24
- pattern: '/',
25
- load: () => Promise.resolve({ default: Page, loader: () => (n += 1) }),
26
- // matches the example: this route has a loading.tsx (keyed boundary + transition).
27
- loading: () => Promise.resolve({ default: () => <p>loading</p> }),
28
- },
29
- ];
30
- const { findByText } = render(<Router routes={routes} />);
31
- await findByText('val:1');
32
-
33
- act(() => {
34
- revalidate();
35
- });
36
- await findByText('val:2');
37
- });
38
- });
1
+ // @vitest-environment jsdom
2
+ import { act, cleanup, render } from '@testing-library/react';
3
+ import { afterEach, beforeEach, describe, it } from 'vitest';
4
+
5
+ import { Router } from '../../src/client/routing/Router';
6
+ import { clearLoaderData, revalidate, useLoaderData } from '../../src/client/routing/loader';
7
+ import type { RouteDef } from '../../src/client/types';
8
+
9
+ afterEach(cleanup);
10
+ beforeEach(() => {
11
+ clearLoaderData();
12
+ window.history.replaceState({}, '', '/');
13
+ });
14
+
15
+ describe('revalidate refetches', () => {
16
+ it('re-runs the loader and updates the rendered data', async () => {
17
+ let n = 0;
18
+ function Page(): React.ReactNode {
19
+ const value = useLoaderData<number>();
20
+ return <p>val:{String(value)}</p>;
21
+ }
22
+ const routes: RouteDef[] = [
23
+ {
24
+ pattern: '/',
25
+ load: () => Promise.resolve({ default: Page, loader: () => (n += 1) }),
26
+ // matches the example: this route has a loading.tsx (keyed boundary + transition).
27
+ loading: () => Promise.resolve({ default: () => <p>loading</p> }),
28
+ },
29
+ ];
30
+ const { findByText } = render(<Router routes={routes} />);
31
+ await findByText('val:1');
32
+
33
+ act(() => {
34
+ revalidate();
35
+ });
36
+ await findByText('val:2');
37
+ });
38
+ });