@peaske7/readit 0.1.7 → 0.2.0

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 (118) hide show
  1. package/README.md +0 -3
  2. package/biome.json +1 -1
  3. package/bun.lock +43 -185
  4. package/docs/perf-baseline.md +75 -0
  5. package/docs/superpowers/plans/2026-03-26-surgical-pruning.md +1176 -0
  6. package/e2e/perf/add-comment.spec.ts +118 -0
  7. package/e2e/perf/fixtures/generate.ts +331 -0
  8. package/e2e/perf/initial-load.spec.ts +49 -0
  9. package/e2e/perf/perf.setup.ts +23 -0
  10. package/e2e/perf/perf.teardown.ts +9 -0
  11. package/e2e/perf/scroll.spec.ts +39 -0
  12. package/e2e/perf/tab-switch.spec.ts +69 -0
  13. package/e2e/perf/text-selection.spec.ts +119 -0
  14. package/e2e/perf/utils/metrics.ts +286 -0
  15. package/e2e/perf/utils/perf-cli.ts +86 -0
  16. package/package.json +9 -18
  17. package/playwright.config.ts +12 -0
  18. package/src/App.tsx +133 -178
  19. package/src/{cli/index.ts → cli.ts} +211 -107
  20. package/src/components/ActionsMenu.tsx +6 -27
  21. package/src/components/DocumentViewer/DocumentViewer.tsx +78 -105
  22. package/src/components/DocumentViewer/MermaidDiagram.tsx +6 -7
  23. package/src/components/Header.tsx +9 -20
  24. package/src/components/InlineEditor.tsx +5 -5
  25. package/src/components/MarginNote.tsx +71 -93
  26. package/src/components/MarginNotes.tsx +7 -34
  27. package/src/components/RawModal.tsx +9 -8
  28. package/src/components/ReanchorConfirm.tsx +2 -2
  29. package/src/components/SettingsModal.tsx +11 -89
  30. package/src/components/TabBar.tsx +4 -4
  31. package/src/components/TableOfContents.tsx +5 -5
  32. package/src/components/comments/CommentInput.tsx +7 -35
  33. package/src/components/comments/CommentListItem.tsx +9 -11
  34. package/src/components/comments/CommentManager.tsx +53 -37
  35. package/src/components/comments/CommentNav.tsx +14 -14
  36. package/src/components/ui/ActionLink.tsx +14 -18
  37. package/src/components/ui/Button.tsx +42 -43
  38. package/src/components/ui/Dialog.tsx +73 -113
  39. package/src/components/ui/DropdownMenu.tsx +113 -69
  40. package/src/components/ui/Text.tsx +30 -37
  41. package/src/contexts/CommentContext.tsx +75 -106
  42. package/src/contexts/LocaleContext.tsx +45 -4
  43. package/src/contexts/PositionsContext.tsx +16 -0
  44. package/src/contexts/SettingsContext.tsx +133 -0
  45. package/src/hooks/useClickOutside.ts +0 -4
  46. package/src/hooks/useCommentNavigation.ts +6 -29
  47. package/src/hooks/useComments.ts +6 -18
  48. package/src/hooks/useDocument.ts +35 -34
  49. package/src/hooks/useHeadings.test.ts +8 -50
  50. package/src/hooks/useHeadings.ts +5 -88
  51. package/src/hooks/useScrollSpy.ts +10 -14
  52. package/src/hooks/useTextSelection.ts +1 -38
  53. package/src/lib/__fixtures__/bench-data.ts +1 -41
  54. package/src/lib/anchor.bench.ts +57 -67
  55. package/src/lib/anchor.test.ts +5 -1
  56. package/src/lib/anchor.ts +13 -93
  57. package/src/lib/comment-storage.test.ts +4 -4
  58. package/src/lib/comment-storage.ts +2 -46
  59. package/src/lib/export.ts +7 -13
  60. package/src/lib/highlight/core.test.ts +1 -1
  61. package/src/lib/highlight/dom.ts +5 -68
  62. package/src/lib/highlight/highlighter.ts +102 -262
  63. package/src/lib/highlight/resolver.ts +112 -0
  64. package/src/lib/highlight/types.ts +0 -35
  65. package/src/lib/highlight/worker.ts +45 -0
  66. package/src/lib/i18n/en.ts +1 -50
  67. package/src/lib/i18n/ja.ts +1 -50
  68. package/src/lib/i18n/types.ts +1 -49
  69. package/src/lib/margin-layout.ts +5 -27
  70. package/src/lib/positions.ts +150 -0
  71. package/src/lib/utils.ts +2 -19
  72. package/src/schema.ts +81 -0
  73. package/src/{server/index.ts → server.ts} +111 -81
  74. package/src/{store/index.ts → store.ts} +14 -46
  75. package/vite.config.ts +8 -0
  76. package/src/components/DocumentViewer/IframeContainer.tsx +0 -251
  77. package/src/components/DocumentViewer/InlineCode.tsx +0 -60
  78. package/src/components/DocumentViewer/index.ts +0 -1
  79. package/src/components/FloatingTOC.tsx +0 -61
  80. package/src/components/ShortcutCapture.tsx +0 -48
  81. package/src/components/ShortcutList.tsx +0 -198
  82. package/src/components/comments/CommentMinimap.tsx +0 -62
  83. package/src/components/ui/ActionBar.tsx +0 -16
  84. package/src/components/ui/SeparatorDot.tsx +0 -9
  85. package/src/contexts/LayoutContext.tsx +0 -88
  86. package/src/hooks/useClipboard.ts +0 -82
  87. package/src/hooks/useEditorScheme.ts +0 -51
  88. package/src/hooks/useFontPreference.ts +0 -59
  89. package/src/hooks/useKeybindings.ts +0 -108
  90. package/src/hooks/useKeyboardShortcuts.ts +0 -63
  91. package/src/hooks/useLayoutMode.ts +0 -44
  92. package/src/hooks/useLocalePreference.ts +0 -42
  93. package/src/hooks/useReanchorMode.ts +0 -33
  94. package/src/hooks/useScrollMetrics.ts +0 -56
  95. package/src/hooks/useThemePreference.ts +0 -66
  96. package/src/lib/comment-storage.bench.ts +0 -63
  97. package/src/lib/context.bench.ts +0 -41
  98. package/src/lib/context.test.ts +0 -224
  99. package/src/lib/context.ts +0 -193
  100. package/src/lib/editor-links.ts +0 -59
  101. package/src/lib/export.bench.ts +0 -35
  102. package/src/lib/highlight/colors.ts +0 -37
  103. package/src/lib/highlight/core.ts +0 -54
  104. package/src/lib/highlight/index.ts +0 -23
  105. package/src/lib/highlight/script-builder.ts +0 -485
  106. package/src/lib/html-processor.test.tsx +0 -170
  107. package/src/lib/html-processor.tsx +0 -95
  108. package/src/lib/i18n/completeness.test.ts +0 -51
  109. package/src/lib/i18n/translations.test.ts +0 -39
  110. package/src/lib/layout-constants.ts +0 -12
  111. package/src/lib/margin-layout.bench.ts +0 -28
  112. package/src/lib/scroll.test.ts +0 -118
  113. package/src/lib/scroll.ts +0 -47
  114. package/src/lib/shortcut-registry.test.ts +0 -173
  115. package/src/lib/shortcut-registry.ts +0 -209
  116. package/src/lib/utils.test.ts +0 -110
  117. package/src/store/index.test.ts +0 -242
  118. package/src/types/index.ts +0 -127
@@ -1,170 +0,0 @@
1
- import { render, screen } from "@testing-library/react";
2
- import { describe, expect, it } from "vitest";
3
- import { processHtml } from "./html-processor";
4
-
5
- describe("processHtml", () => {
6
- describe("basic HTML rendering", () => {
7
- it("renders simple HTML elements", () => {
8
- const result = processHtml("<p>Hello, world!</p>");
9
- render(result);
10
- expect(screen.getByText("Hello, world!")).toBeInTheDocument();
11
- });
12
-
13
- it("renders headings", () => {
14
- const result = processHtml("<h1>Title</h1><h2>Subtitle</h2>");
15
- render(result);
16
- expect(screen.getByRole("heading", { level: 1 })).toHaveTextContent(
17
- "Title",
18
- );
19
- expect(screen.getByRole("heading", { level: 2 })).toHaveTextContent(
20
- "Subtitle",
21
- );
22
- });
23
-
24
- it("renders links", () => {
25
- const result = processHtml('<a href="https://example.com">Link</a>');
26
- render(result);
27
- const link = screen.getByRole("link", { name: "Link" });
28
- expect(link).toHaveAttribute("href", "https://example.com");
29
- });
30
-
31
- it("renders lists", () => {
32
- const result = processHtml("<ul><li>Item 1</li><li>Item 2</li></ul>");
33
- render(result);
34
- expect(screen.getByText("Item 1")).toBeInTheDocument();
35
- expect(screen.getByText("Item 2")).toBeInTheDocument();
36
- });
37
- });
38
-
39
- describe("dangerous element stripping", () => {
40
- it("strips script tags and shows placeholder", () => {
41
- const result = processHtml('<script>alert("xss")</script>');
42
- render(result);
43
- expect(screen.getByText("<script> removed")).toBeInTheDocument();
44
- expect(screen.queryByText('alert("xss")')).not.toBeInTheDocument();
45
- });
46
-
47
- it("strips iframe tags and shows placeholder", () => {
48
- const result = processHtml('<iframe src="https://evil.com"></iframe>');
49
- render(result);
50
- expect(screen.getByText("<iframe> removed")).toBeInTheDocument();
51
- });
52
-
53
- it("strips object tags and shows placeholder", () => {
54
- const result = processHtml('<object data="malware.swf"></object>');
55
- render(result);
56
- expect(screen.getByText("<object> removed")).toBeInTheDocument();
57
- });
58
-
59
- it("strips embed tags and shows placeholder", () => {
60
- const result = processHtml('<embed src="malware.swf">');
61
- render(result);
62
- expect(screen.getByText("<embed> removed")).toBeInTheDocument();
63
- });
64
- });
65
-
66
- describe("dangerous attribute stripping", () => {
67
- it("strips onclick handlers", () => {
68
- const result = processHtml('<button onclick="alert(1)">Click</button>');
69
- render(result);
70
- const button = screen.getByRole("button", { name: "Click" });
71
- expect(button).not.toHaveAttribute("onclick");
72
- });
73
-
74
- it("strips onerror handlers", () => {
75
- const result = processHtml('<img src="x" onerror="alert(1)" alt="test">');
76
- render(result);
77
- const img = screen.getByRole("img", { name: "test" });
78
- expect(img).not.toHaveAttribute("onerror");
79
- });
80
-
81
- it("strips onload handlers", () => {
82
- const result = processHtml('<div onload="alert(1)">Content</div>');
83
- render(result);
84
- const div = screen.getByText("Content");
85
- expect(div).not.toHaveAttribute("onload");
86
- });
87
-
88
- it("strips onmouseover handlers", () => {
89
- const result = processHtml('<div onmouseover="alert(1)">Hover</div>');
90
- render(result);
91
- const div = screen.getByText("Hover");
92
- expect(div).not.toHaveAttribute("onmouseover");
93
- });
94
- });
95
-
96
- describe("dangerous URL neutralization", () => {
97
- it("neutralizes javascript: URLs in href", () => {
98
- const result = processHtml('<a href="javascript:alert(1)">Click</a>');
99
- render(result);
100
- const link = screen.getByRole("link", { name: "Click" });
101
- expect(link).toHaveAttribute("href", "#");
102
- });
103
-
104
- it("neutralizes javascript: URLs in src", () => {
105
- const result = processHtml(
106
- '<img src="javascript:alert(1)" alt="bad img">',
107
- );
108
- render(result);
109
- const img = screen.getByRole("img", { name: "bad img" });
110
- expect(img).toHaveAttribute("src", "#");
111
- });
112
-
113
- it("neutralizes data: URLs", () => {
114
- const result = processHtml(
115
- '<a href="data:text/html,<script>alert(1)</script>">Click</a>',
116
- );
117
- render(result);
118
- const link = screen.getByRole("link", { name: "Click" });
119
- expect(link).toHaveAttribute("href", "#");
120
- });
121
-
122
- it("neutralizes vbscript: URLs", () => {
123
- const result = processHtml('<a href="vbscript:msgbox(1)">Click</a>');
124
- render(result);
125
- const link = screen.getByRole("link", { name: "Click" });
126
- expect(link).toHaveAttribute("href", "#");
127
- });
128
-
129
- it("preserves safe URLs", () => {
130
- const result = processHtml('<a href="https://example.com">Safe</a>');
131
- render(result);
132
- const link = screen.getByRole("link", { name: "Safe" });
133
- expect(link).toHaveAttribute("href", "https://example.com");
134
- });
135
- });
136
-
137
- describe("mixed content", () => {
138
- it("handles complex HTML with multiple dangerous elements", () => {
139
- const html = `
140
- <div>
141
- <h1>Title</h1>
142
- <script>alert("xss")</script>
143
- <p onclick="steal()">Paragraph with handler</p>
144
- <a href="javascript:void(0)">Bad link</a>
145
- <a href="https://safe.com">Safe link</a>
146
- <iframe src="evil.com"></iframe>
147
- </div>
148
- `;
149
- render(processHtml(html));
150
-
151
- // Script tag replaced with placeholder
152
- expect(screen.getByText("<script> removed")).toBeInTheDocument();
153
-
154
- // Event handler stripped
155
- const paragraph = screen.getByText("Paragraph with handler");
156
- expect(paragraph).not.toHaveAttribute("onclick");
157
-
158
- // Dangerous URL neutralized
159
- const badLink = screen.getByRole("link", { name: "Bad link" });
160
- expect(badLink).toHaveAttribute("href", "#");
161
-
162
- // Safe URL preserved
163
- const safeLink = screen.getByRole("link", { name: "Safe link" });
164
- expect(safeLink).toHaveAttribute("href", "https://safe.com");
165
-
166
- // Iframe tag replaced with placeholder
167
- expect(screen.getByText("<iframe> removed")).toBeInTheDocument();
168
- });
169
- });
170
- });
@@ -1,95 +0,0 @@
1
- import type { Element, Root } from "hast";
2
- import { TriangleAlert } from "lucide-react";
3
- import type { ReactNode } from "react";
4
- import { Fragment, jsx, jsxs } from "react/jsx-runtime";
5
- import rehypeParse from "rehype-parse";
6
- import rehypeReact from "rehype-react";
7
- import { unified } from "unified";
8
- import { visit } from "unist-util-visit";
9
-
10
- /**
11
- * Placeholder component for stripped dangerous elements
12
- */
13
- function StrippedElement({ tagName }: { tagName: string }) {
14
- return (
15
- <span className="inline-flex items-center gap-1 px-3 py-1.5 text-sm bg-red-50 text-red-700 border border-red-200 rounded-md font-mono">
16
- <TriangleAlert className="w-4 h-4" />
17
- &lt;{tagName}&gt; removed
18
- </span>
19
- );
20
- }
21
-
22
- /**
23
- * Component mappings for dangerous elements - renders placeholders instead
24
- */
25
- const dangerousElementComponents = {
26
- script: () => <StrippedElement tagName="script" />,
27
- // Style tags targeting body/html/* can leak outside Shadow DOM, so strip them
28
- // Our base styles in ShadowContainer provide typography instead
29
- style: () => null,
30
- link: () => null, // External stylesheets break app styles
31
- iframe: () => <StrippedElement tagName="iframe" />,
32
- object: () => <StrippedElement tagName="object" />,
33
- embed: () => <StrippedElement tagName="embed" />,
34
- frame: () => <StrippedElement tagName="frame" />,
35
- frameset: () => <StrippedElement tagName="frameset" />,
36
- };
37
-
38
- /**
39
- * Rehype plugin to strip event handler attributes (onclick, onerror, etc.)
40
- * and dangerous href/src values (javascript:, data:, vbscript:)
41
- */
42
- function rehypeStripDangerousAttributes() {
43
- const dangerousSchemes = /^(javascript|vbscript|data):/i;
44
-
45
- return (tree: Root) => {
46
- visit(tree, "element", (node: Element) => {
47
- const props = node.properties;
48
- if (!props) return;
49
-
50
- for (const key of Object.keys(props)) {
51
- // Strip all event handlers (on*)
52
- if (key.startsWith("on") || key.startsWith("On")) {
53
- delete props[key];
54
- continue;
55
- }
56
-
57
- // Neutralize dangerous href/src schemes
58
- if (key === "href" || key === "src") {
59
- const value = props[key];
60
- if (
61
- typeof value === "string" &&
62
- dangerousSchemes.test(value.trim())
63
- ) {
64
- props[key] = "#";
65
- }
66
- }
67
- }
68
- });
69
- };
70
- }
71
-
72
- /**
73
- * Create the unified processor for HTML -> React conversion
74
- */
75
- const processor = unified()
76
- .use(rehypeParse, { fragment: true })
77
- .use(rehypeStripDangerousAttributes)
78
- .use(rehypeReact, {
79
- jsx,
80
- jsxs,
81
- Fragment,
82
- components: dangerousElementComponents,
83
- });
84
-
85
- /**
86
- * Process HTML content and return safe React elements
87
- *
88
- * - Dangerous tags (script, iframe, etc.) become visible placeholders
89
- * - Event handlers (onclick, onerror, etc.) are stripped
90
- * - Dangerous URLs (javascript:, data:, etc.) are neutralized
91
- */
92
- export function processHtml(content: string): ReactNode {
93
- const result = processor.processSync(content);
94
- return result.result as ReactNode;
95
- }
@@ -1,51 +0,0 @@
1
- import { describe, expect, it } from "vitest";
2
- import { en } from "./en";
3
- import { ja } from "./ja";
4
-
5
- describe("translation completeness", () => {
6
- const enKeys = Object.keys(en).sort();
7
- const jaKeys = Object.keys(ja).sort();
8
-
9
- it("en and ja have the same keys", () => {
10
- expect(enKeys).toEqual(jaKeys);
11
- });
12
-
13
- // Prefix/suffix keys may be intentionally empty in some locales
14
- // (e.g., Japanese has no prefix before the command)
15
- const ALLOW_EMPTY = new Set(["app.noDocumentsHintPrefix"]);
16
-
17
- it("no empty string values in en", () => {
18
- for (const [key, value] of Object.entries(en)) {
19
- if (ALLOW_EMPTY.has(key)) continue;
20
- expect(value, `en.${key} is empty`).not.toBe("");
21
- }
22
- });
23
-
24
- it("no empty string values in ja", () => {
25
- for (const [key, value] of Object.entries(ja)) {
26
- if (ALLOW_EMPTY.has(key)) continue;
27
- expect(value, `ja.${key} is empty`).not.toBe("");
28
- }
29
- });
30
-
31
- it("interpolation placeholders match between locales", () => {
32
- const placeholderPattern = /\{\{(\w+)\}\}/g;
33
-
34
- for (const key of enKeys) {
35
- const enValue = en[key as keyof typeof en];
36
- const jaValue = ja[key as keyof typeof ja];
37
-
38
- const enPlaceholders = [...enValue.matchAll(placeholderPattern)]
39
- .map((m) => m[1])
40
- .sort();
41
- const jaPlaceholders = [...jaValue.matchAll(placeholderPattern)]
42
- .map((m) => m[1])
43
- .sort();
44
-
45
- expect(
46
- enPlaceholders,
47
- `Placeholder mismatch for key "${key}": en has ${JSON.stringify(enPlaceholders)}, ja has ${JSON.stringify(jaPlaceholders)}`,
48
- ).toEqual(jaPlaceholders);
49
- }
50
- });
51
- });
@@ -1,39 +0,0 @@
1
- import { describe, expect, it } from "vitest";
2
- import { createT } from "./translations";
3
- import { Locales } from "./types";
4
-
5
- describe("createT", () => {
6
- it("returns English strings for en locale", () => {
7
- const t = createT(Locales.EN);
8
- expect(t("app.loading")).toBe("Loading...");
9
- expect(t("settings.title")).toBe("Settings");
10
- expect(t("comment.placeholder")).toBe("Add your comment...");
11
- });
12
-
13
- it("returns Japanese strings for ja locale", () => {
14
- const t = createT(Locales.JA);
15
- expect(t("app.loading")).toBe("読み込み中...");
16
- expect(t("settings.title")).toBe("設定");
17
- expect(t("comment.placeholder")).toBe("コメントを入力...");
18
- });
19
-
20
- it("interpolates {{placeholder}} params", () => {
21
- const tEn = createT(Locales.EN);
22
- expect(tEn("commentNav.of", { current: 1, total: 5 })).toBe("1 of 5");
23
-
24
- const tJa = createT(Locales.JA);
25
- expect(tJa("commentNav.of", { current: 1, total: 5 })).toBe("1 / 5");
26
- });
27
-
28
- it("interpolates multiple params", () => {
29
- const t = createT(Locales.EN);
30
- expect(t("commentManager.deleteAllConfirm", { count: 3 })).toBe(
31
- "Delete all 3 comments?",
32
- );
33
- });
34
-
35
- it("returns string unchanged when no params provided", () => {
36
- const t = createT(Locales.EN);
37
- expect(t("app.footer")).toBe("Made with ❤️ by Jay and Claude");
38
- });
39
- });
@@ -1,12 +0,0 @@
1
- // Layout constants for margin notes and document viewer
2
-
3
- export const HEADER_HEIGHT_PX = 48;
4
-
5
- // Minimum gap between margin notes (accounts for quote + comment + actions + padding)
6
- export const MARGIN_NOTE_MIN_GAP_PX = 150;
7
-
8
- // Height reserved for comment input form when selecting text
9
- export const COMMENT_INPUT_HEIGHT_PX = 160;
10
-
11
- // Minimap starts below the header
12
- export const MINIMAP_HEADER_OFFSET_PX = HEADER_HEIGHT_PX;
@@ -1,28 +0,0 @@
1
- import { bench, describe } from "vitest";
2
- import { makeHighlightPositions } from "./__fixtures__/bench-data";
3
- import { resolveMarginNotePositions } from "./margin-layout";
4
-
5
- // Pre-compute fixture data outside bench loops
6
- const ids5 = Array.from({ length: 5 }, (_, i) => `c${i}`);
7
- const pos5 = makeHighlightPositions(5);
8
-
9
- const ids50 = Array.from({ length: 50 }, (_, i) => `c${i}`);
10
- const pos50 = makeHighlightPositions(50);
11
-
12
- describe("resolveMarginNotePositions", () => {
13
- bench("5 notes, no input zone", () => {
14
- resolveMarginNotePositions(ids5, pos5, undefined);
15
- });
16
-
17
- bench("5 notes, with input zone collision", () => {
18
- resolveMarginNotePositions(ids5, pos5, 400);
19
- });
20
-
21
- bench("50 notes, no input zone", () => {
22
- resolveMarginNotePositions(ids50, pos50, undefined);
23
- });
24
-
25
- bench("50 notes, with input zone collision", () => {
26
- resolveMarginNotePositions(ids50, pos50, 3000);
27
- });
28
- });
@@ -1,118 +0,0 @@
1
- import { describe, expect, it } from "vitest";
2
- import { calculateScrollTarget, getElementTopInDocument } from "./scroll";
3
-
4
- describe("calculateScrollTarget", () => {
5
- it("positions element at 25% from top by default", () => {
6
- // Element at 1000px, viewport 800px
7
- // Target offset = 800 * 0.25 = 200px
8
- // Scroll target = 1000 - 200 = 800px
9
- expect(
10
- calculateScrollTarget({ elementTop: 1000, viewportHeight: 800 }),
11
- ).toBe(800);
12
- });
13
-
14
- it("respects custom offset percent", () => {
15
- // Element at 1000px, viewport 800px, offset 50%
16
- // Target offset = 800 * 0.5 = 400px
17
- // Scroll target = 1000 - 400 = 600px
18
- expect(
19
- calculateScrollTarget({
20
- elementTop: 1000,
21
- viewportHeight: 800,
22
- offsetPercent: 0.5,
23
- }),
24
- ).toBe(600);
25
- });
26
-
27
- it("returns 0 when element is near top", () => {
28
- // Element at 100px, viewport 800px
29
- // Target offset = 200px
30
- // Scroll target = max(0, 100 - 200) = 0
31
- expect(
32
- calculateScrollTarget({ elementTop: 100, viewportHeight: 800 }),
33
- ).toBe(0);
34
- });
35
-
36
- it("returns 0 for element at position 0", () => {
37
- expect(calculateScrollTarget({ elementTop: 0, viewportHeight: 800 })).toBe(
38
- 0,
39
- );
40
- });
41
-
42
- it("handles small viewport", () => {
43
- // Element at 500px, viewport 400px
44
- // Target offset = 100px
45
- // Scroll target = 500 - 100 = 400px
46
- expect(
47
- calculateScrollTarget({ elementTop: 500, viewportHeight: 400 }),
48
- ).toBe(400);
49
- });
50
-
51
- it("handles zero offset percent", () => {
52
- // Element at 1000px, no offset
53
- // Scroll target = 1000px (element at very top of viewport)
54
- expect(
55
- calculateScrollTarget({
56
- elementTop: 1000,
57
- viewportHeight: 800,
58
- offsetPercent: 0,
59
- }),
60
- ).toBe(1000);
61
- });
62
- });
63
-
64
- describe("getElementTopInDocument", () => {
65
- it("calculates position for element in main document (not scrolled)", () => {
66
- // Element at 500px from viewport top, no scroll
67
- const elementRect = { top: 500 };
68
- expect(getElementTopInDocument({ elementRect, scrollY: 0 })).toBe(500);
69
- });
70
-
71
- it("calculates position for element in main document (scrolled)", () => {
72
- // Element at 200px from viewport top, scrolled 300px
73
- // Absolute position = 300 + 200 = 500px
74
- const elementRect = { top: 200 };
75
- expect(getElementTopInDocument({ elementRect, scrollY: 300 })).toBe(500);
76
- });
77
-
78
- it("calculates position for element inside iframe", () => {
79
- // Iframe at 100px from viewport top
80
- // Element at 150px from iframe top (inside iframe)
81
- // Scrolled 50px
82
- // Absolute position = 50 + 100 + 150 = 300px
83
- const elementRect = { top: 150 };
84
- expect(
85
- getElementTopInDocument({
86
- elementRect,
87
- scrollY: 50,
88
- iframeTopOffset: 100,
89
- }),
90
- ).toBe(300);
91
- });
92
-
93
- it("handles element at viewport top with scroll", () => {
94
- // Element at 0px from viewport top, scrolled 1000px
95
- const elementRect = { top: 0 };
96
- expect(getElementTopInDocument({ elementRect, scrollY: 1000 })).toBe(1000);
97
- });
98
-
99
- it("handles negative element position (above viewport)", () => {
100
- // Element scrolled past viewport top
101
- const elementRect = { top: -100 };
102
- expect(getElementTopInDocument({ elementRect, scrollY: 500 })).toBe(400);
103
- });
104
-
105
- it("handles iframe with element above iframe viewport", () => {
106
- // Iframe at 200px, element at -50px within iframe (scrolled past)
107
- // scrollY = 100
108
- // Absolute position = 100 + 200 + (-50) = 250px
109
- const elementRect = { top: -50 };
110
- expect(
111
- getElementTopInDocument({
112
- elementRect,
113
- scrollY: 100,
114
- iframeTopOffset: 200,
115
- }),
116
- ).toBe(250);
117
- });
118
- });
package/src/lib/scroll.ts DELETED
@@ -1,47 +0,0 @@
1
- /**
2
- * Scroll calculation utilities for TOC navigation.
3
- * These pure functions enable unit testing of scroll position calculations.
4
- */
5
-
6
- /**
7
- * Parameters for scroll target calculation.
8
- * Using object destructuring per style guide §3.5 for clarity.
9
- */
10
- export interface CalculateScrollTargetParams {
11
- elementTop: number;
12
- viewportHeight: number;
13
- offsetPercent?: number;
14
- }
15
-
16
- export interface GetElementTopParams {
17
- elementRect: { top: number };
18
- scrollY: number;
19
- iframeTopOffset?: number;
20
- }
21
-
22
- /**
23
- * Calculate the scroll target position to place an element at a comfortable
24
- * reading position (default: 25% from top of viewport).
25
- */
26
- export function calculateScrollTarget({
27
- elementTop,
28
- viewportHeight,
29
- offsetPercent = 0.25,
30
- }: CalculateScrollTargetParams): number {
31
- const targetOffset = viewportHeight * offsetPercent;
32
- return Math.max(0, elementTop - targetOffset);
33
- }
34
-
35
- /**
36
- * Get an element's absolute position in the main document.
37
- *
38
- * For elements directly in the document: pass scrollY and the element.
39
- * For elements inside an iframe: also pass the iframe's top offset.
40
- */
41
- export function getElementTopInDocument({
42
- elementRect,
43
- scrollY,
44
- iframeTopOffset,
45
- }: GetElementTopParams): number {
46
- return scrollY + (iframeTopOffset ?? 0) + elementRect.top;
47
- }