@kabmo-labs/kabmo 0.17.0 → 0.18.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.
- package/dist/client/index.html +1 -1
- package/dist/client/index.js +538 -457
- package/dist/client/static/js/index-hp75vsv9.css +1 -0
- package/dist/client/static/js/{index-rerjq5th.js → index-tc09dtca.js} +823 -814
- package/package.json +1 -1
- package/src/client/components/common/MarkdownRenderer.tsx +136 -89
- package/src/client/components/common/anchored-menu/index.test.tsx +141 -0
- package/src/client/components/common/anchored-menu/index.tsx +143 -0
- package/src/client/components/common/markdown-review/ReviewPopover.tsx +144 -0
- package/src/client/components/common/markdown-review/ReviewSummary.tsx +108 -0
- package/src/client/components/common/markdown-review/index.tsx +129 -0
- package/src/client/components/common/server-control/Panel.tsx +33 -23
- package/src/client/components/common/server-control/index.test.tsx +11 -5
- package/src/client/components/common/server-control/index.tsx +10 -8
- package/src/client/components/layout/session-sidebar/CategoryHeader.tsx +42 -21
- package/src/client/components/layout/session-sidebar/CategoryHeader.worktree.test.tsx +36 -17
- package/src/client/components/layout/session-sidebar/CategoryItem.tsx +8 -7
- package/src/client/components/layout/session-sidebar/about-modal/NotesDialog.tsx +94 -0
- package/src/client/components/layout/session-sidebar/about-modal/VersionLine.test.tsx +68 -0
- package/src/client/components/layout/session-sidebar/about-modal/VersionLine.tsx +36 -0
- package/src/client/components/layout/session-sidebar/about-modal/index.tsx +57 -34
- package/src/client/components/layout/session-sidebar/modern/WorkspaceHeader.tsx +28 -10
- package/src/client/components/layout/session-sidebar/modern/WorkspaceSection.tsx +7 -6
- package/src/client/components/layout/session-sidebar/modern/workspace-header.test.tsx +1 -1
- package/src/client/components/layout/update-popup/ReleaseNotes.tsx +8 -3
- package/src/client/components/layout/update-popup/index.tsx +5 -1
- package/src/client/components/mobile/mobile-right-sidebar/FullEditor.tsx +13 -15
- package/src/client/components/mobile/mobile-right-sidebar/Header.tsx +23 -1
- package/src/client/components/mobile/mobile-right-sidebar/MissingFileBanner.tsx +30 -0
- package/src/client/components/mobile/mobile-right-sidebar/PreviewScroller.tsx +18 -2
- package/src/client/components/mobile/mobile-session-sidebar/Item.tsx +22 -67
- package/src/client/components/mobile/mobile-session-sidebar/ItemMenu.tsx +110 -0
- package/src/client/components/settings/SettingsSidebarList.tsx +20 -0
- package/src/client/components/settings/categories/AgentSettings.tsx +23 -50
- package/src/client/components/settings/categories/CommandSettings.tsx +2 -2
- package/src/client/components/settings/categories/McpSettings.tsx +4 -21
- package/src/client/components/settings/categories/OmpSettings.tsx +147 -194
- package/src/client/components/settings/categories/SkillSettings.tsx +2 -2
- package/src/client/components/settings/categories/TokenUsageSettings.tsx +211 -229
- package/src/client/components/settings/categories/agent-settings/DetailPane.tsx +229 -237
- package/src/client/components/settings/categories/agent-settings/ModelPicker.tsx +71 -0
- package/src/client/components/settings/categories/agent-settings/SidebarList.tsx +9 -2
- package/src/client/components/settings/categories/agent-settings/levels.ts +38 -0
- package/src/client/components/settings/categories/behavior-settings/Editor.tsx +27 -7
- package/src/client/components/settings/categories/chat-settings/ToolRenderSection.tsx +23 -5
- package/src/client/components/settings/categories/command-settings/DetailPane.tsx +75 -33
- package/src/client/components/settings/categories/command-settings/SidebarList.tsx +7 -0
- package/src/client/components/settings/categories/mcp-settings/DetailPane.tsx +91 -76
- package/src/client/components/settings/categories/mcp-settings/EnvVarsSection.tsx +83 -0
- package/src/client/components/settings/categories/mcp-settings/ImportModal.tsx +26 -13
- package/src/client/components/settings/categories/mcp-settings/SidebarList.tsx +20 -0
- package/src/client/components/settings/categories/omp-settings/ConfigTabs.tsx +97 -36
- package/src/client/components/settings/categories/omp-settings/EngineHeader.tsx +151 -0
- package/src/client/components/settings/categories/omp-settings/ExtensionsPanel.tsx +68 -32
- package/src/client/components/settings/categories/omp-settings/OrderedChips.tsx +119 -0
- package/src/client/components/settings/categories/omp-settings/PresetBar.tsx +14 -7
- package/src/client/components/settings/categories/omp-settings/RoleEditor.tsx +15 -6
- package/src/client/components/settings/categories/omp-settings/RowEditor.tsx +165 -226
- package/src/client/components/settings/categories/omp-settings/types.ts +28 -0
- package/src/client/components/settings/categories/skill-settings/DetailHeader.tsx +35 -7
- package/src/client/components/settings/categories/skill-settings/DetailPane.tsx +34 -14
- package/src/client/components/settings/categories/skill-settings/SidebarList.tsx +21 -0
- package/src/client/components/settings/categories/skill-settings/pane.test.tsx +15 -6
- package/src/client/components/settings/categories/token-usage-settings/Breakdown.tsx +242 -102
- package/src/client/components/settings/categories/token-usage-settings/Chart.tsx +130 -56
- package/src/client/components/settings/categories/token-usage-settings/Controls.tsx +135 -0
- package/src/client/components/settings/categories/token-usage-settings/MetricsGrid.tsx +55 -33
- package/src/client/components/settings/categories/token-usage-settings/Provenance.tsx +59 -0
- package/src/client/components/settings/categories/token-usage-settings/panel.test.tsx +239 -0
- package/src/client/components/workspace/browser-panel/Screencast.test.ts +1 -0
- package/src/client/components/workspace/browser-panel/Screencast.tsx +17 -22
- package/src/client/components/workspace/browser-panel/TabStrip.test.tsx +158 -0
- package/src/client/components/workspace/browser-panel/TabStrip.tsx +90 -0
- package/src/client/components/workspace/browser-panel/index.tsx +50 -4
- package/src/client/components/workspace/browser-toolbar/index.tsx +41 -1
- package/src/client/components/workspace/chat-timeline/ThinkingSection.tsx +3 -1
- package/src/client/components/workspace/chat-timeline/ToolCallingSection.tsx +2 -0
- package/src/client/components/workspace/chat-timeline/block-chrome.test.tsx +13 -2
- package/src/client/components/workspace/chat-timeline/tool-renderers/panels/Bash.test.ts +88 -0
- package/src/client/components/workspace/chat-timeline/tool-renderers/panels/Bash.tsx +24 -1
- package/src/client/components/workspace/chat-timeline/tool-renderers/panels/Read.test.ts +34 -0
- package/src/client/components/workspace/chat-timeline/tool-renderers/panels/Read.tsx +5 -1
- package/src/client/components/workspace/chat-timeline/tool-renderers/shared/ArtifactChip.tsx +7 -6
- package/src/client/components/workspace/chat-timeline/tool-renderers/styles/Tui.test.tsx +237 -0
- package/src/client/components/workspace/chat-timeline/tool-renderers/styles/Tui.tsx +191 -0
- package/src/client/components/workspace/chat-timeline/tool-renderers/styles/styles.test.tsx +1 -1
- package/src/client/components/workspace/diff-panel/MergeDiffView.tsx +21 -7
- package/src/client/components/workspace/diff-panel/changes.test.ts +51 -0
- package/src/client/components/workspace/diff-panel/changes.ts +28 -12
- package/src/client/components/workspace/diff-panel/merge.test.ts +28 -0
- package/src/client/components/workspace/diff-panel/merge.ts +21 -1
- package/src/client/components/workspace/editor/Body.tsx +7 -0
- package/src/client/components/workspace/editor/FileDocument.tsx +15 -21
- package/src/client/components/workspace/editor/FilePane.tsx +12 -0
- package/src/client/components/workspace/editor/PreviewPane.tsx +70 -0
- package/src/client/components/workspace/editor/Toolbar.tsx +17 -1
- package/src/client/components/workspace/editor/index.tsx +25 -22
- package/src/client/components/workspace/editor/toolbar-clusters.test.ts +14 -0
- package/src/client/components/workspace/editor/toolbar-clusters.tsx +12 -86
- package/src/client/components/workspace/editor/toolbar-toggle.tsx +53 -0
- package/src/client/components/workspace/editor/toolbar-write-clusters.tsx +112 -0
- package/src/client/components/workspace/git-panel/commit-modal.test.ts +5 -3
- package/src/client/components/workspace/user-browser-panel/AddressBar.tsx +5 -0
- package/src/client/components/workspace/user-browser-panel/AnnotateBar.test.tsx +201 -0
- package/src/client/components/workspace/user-browser-panel/AnnotateBar.tsx +112 -0
- package/src/client/components/workspace/user-browser-panel/AnnotateLayer.test.tsx +225 -0
- package/src/client/components/workspace/user-browser-panel/AnnotateLayer.tsx +217 -0
- package/src/client/components/workspace/user-browser-panel/AnnotateTarget.tsx +99 -0
- package/src/client/components/workspace/user-browser-panel/Frame.tsx +30 -1
- package/src/client/components/workspace/user-browser-panel/index.tsx +81 -2
- package/src/client/data/agent-data/builtin.ts +0 -10
- package/src/client/data/agent-data/orchestrator.ts +0 -45
- package/src/client/data/agent-data/specialist.ts +0 -100
- package/src/client/data/mock/token-usage.ts +170 -120
- package/src/client/data/settings/omp-schema.json +33 -1
- package/src/client/hooks/browser/use-annotate.test.ts +143 -0
- package/src/client/hooks/browser/use-annotate.ts +98 -0
- package/src/client/hooks/browser/use-close-tab.test.ts +148 -0
- package/src/client/hooks/browser/use-close-tab.ts +67 -0
- package/src/client/hooks/browser/use-screencast.ts +13 -1
- package/src/client/hooks/chat/composer/browser-context.test.ts +117 -0
- package/src/client/hooks/chat/composer/browser-context.ts +40 -16
- package/src/client/hooks/chat/composer/items.test.ts +1 -1
- package/src/client/hooks/chat/composer/review-context.ts +38 -0
- package/src/client/hooks/chat/composer/use-draft.test.ts +132 -0
- package/src/client/hooks/chat/composer/use-draft.ts +31 -2
- package/src/client/hooks/chat/timeline/row-window.test.ts +15 -2
- package/src/client/hooks/editor/use-document-annotations.ts +124 -0
- package/src/client/hooks/editor/use-editor-panel-ui.ts +52 -0
- package/src/client/hooks/editor/use-file-review-mode.ts +35 -0
- package/src/client/hooks/editor/use-preview-review.ts +148 -0
- package/src/client/hooks/settings/agents.ts +149 -0
- package/src/client/hooks/settings/crud-list.test.ts +28 -6
- package/src/client/hooks/settings/crud-list.ts +96 -57
- package/src/client/hooks/settings/omp-config.ts +164 -0
- package/src/client/hooks/settings/useTokenUsage.ts +125 -0
- package/src/client/hooks/settings/write-feedback.test.ts +104 -0
- package/src/client/hooks/settings/write-feedback.ts +63 -0
- package/src/client/hooks/ui/markdown-hydration.ts +125 -0
- package/src/client/hooks/ui/updates/index.test.ts +100 -1
- package/src/client/hooks/ui/updates/index.ts +50 -0
- package/src/client/hooks/ui/updates/notes.test.ts +138 -0
- package/src/client/hooks/ui/updates/notes.ts +57 -0
- package/src/client/lib/browser/element-at.test.ts +229 -0
- package/src/client/lib/browser/element-at.ts +139 -0
- package/src/client/lib/review/client.ts +73 -0
- package/src/client/lib/router/search-params.ts +42 -20
- package/src/client/tailwind.css +65 -0
- package/src/server/lib/btw/lifecycle.server.ts +2 -2
- package/src/server/lib/db/schema.ts +7 -0
- package/src/server/lib/db/seed-terminal.test.ts +4 -0
- package/src/server/lib/omp/config/agent-definitions.test.ts +273 -0
- package/src/server/lib/omp/config/agents.ts +231 -61
- package/src/server/lib/omp/config/definitions.test.ts +9 -105
- package/src/server/lib/omp/config/extensions.ts +16 -7
- package/src/server/lib/omp/config/omp-config-files.test.ts +27 -0
- package/src/server/lib/omp/rpc/constants.test.ts +11 -0
- package/src/server/lib/omp/rpc/constants.ts +15 -0
- package/src/server/lib/omp/rpc/process.ts +11 -14
- package/src/server/lib/omp/rpc/session-commands.ts +6 -3
- package/src/server/lib/omp/rpc/utility-agent-dir.test.ts +134 -0
- package/src/server/lib/omp/rpc/utility-agent-dir.ts +138 -0
- package/src/server/lib/omp/rpc/utility.ts +12 -0
- package/src/server/lib/review/schema.server.ts +45 -0
- package/src/server/lib/review/store.server.ts +138 -0
- package/src/server/lib/terminal/attach-replay.test.ts +132 -0
- package/src/server/lib/terminal/output.test.ts +166 -0
- package/src/server/lib/terminal/output.ts +104 -0
- package/src/server/lib/terminal/runtime.server.ts +5 -0
- package/src/server/lib/terminal/send-result.test.ts +33 -0
- package/src/server/lib/terminal/send-result.ts +32 -0
- package/src/server/lib/terminal/session.server.ts +45 -11
- package/src/server/lib/terminal/store-liveness.test.ts +4 -0
- package/src/server/lib/updates/active-notes.test.ts +149 -0
- package/src/server/lib/updates/active-notes.ts +75 -0
- package/src/server/lib/updates/changelog-file.ts +42 -11
- package/src/server/lib/updates/changelog.test.ts +15 -1
- package/src/server/lib/updates/omp.ts +42 -15
- package/src/server/lib/updates/release-url.ts +27 -1
- package/src/server/lib/usage/index-parse.test.ts +200 -0
- package/src/server/lib/usage/index-parse.ts +178 -0
- package/src/server/lib/usage/index-query.server.ts +248 -0
- package/src/server/lib/usage/index-scan.server.ts +343 -0
- package/src/server/lib/usage/index-schema.server.ts +82 -0
- package/src/server/lib/usage/index.test.ts +234 -0
- package/src/server/lib/usage/providers.server.ts +4 -53
- package/src/server/routes/browser/index.ts +3 -0
- package/src/server/routes/browser/stream.ts +31 -2
- package/src/server/routes/browser/tabs.test.ts +94 -0
- package/src/server/routes/browser/tabs.ts +85 -0
- package/src/server/routes/index.ts +2 -0
- package/src/server/routes/review/bindings.ts +11 -0
- package/src/server/routes/review/index.ts +127 -0
- package/src/server/routes/review/routes.test.ts +191 -0
- package/src/server/routes/settings/agents.test.ts +180 -0
- package/src/server/routes/settings/agents.ts +95 -102
- package/src/server/routes/settings/mcp.test.ts +135 -0
- package/src/server/routes/settings/mcp.ts +14 -6
- package/src/server/routes/settings/settings-store-routes.test.ts +6 -113
- package/src/server/routes/telemetry/tokens.test.ts +145 -0
- package/src/server/routes/telemetry/tokens.ts +70 -149
- package/src/server/routes/terminal/ws.ts +6 -5
- package/src/server/routes/updates/index.ts +2 -0
- package/src/server/routes/updates/notes.ts +34 -0
- package/src/server/routes/updates/routes.test.ts +49 -0
- package/src/shared/lib/browser/annotate.test.ts +283 -0
- package/src/shared/lib/browser/annotate.ts +231 -0
- package/src/shared/lib/browser/browser-viewer.test.ts +26 -4
- package/src/shared/lib/browser/frame-gate.test.ts +91 -0
- package/src/shared/lib/browser/frame-gate.ts +69 -0
- package/src/shared/lib/browser/frame-params.test.ts +43 -0
- package/src/shared/lib/browser/frame-params.ts +60 -0
- package/src/shared/lib/browser/frame-pipeline.test.ts +132 -0
- package/src/shared/lib/browser/frame-pipeline.ts +80 -0
- package/src/shared/lib/browser/page-context.ts +60 -4
- package/src/shared/lib/browser/snapshot.test.ts +115 -0
- package/src/shared/lib/browser/snapshot.ts +112 -0
- package/src/shared/lib/browser/tab-close.test.ts +74 -0
- package/src/shared/lib/browser/tab-close.ts +77 -0
- package/src/shared/lib/browser/viewer.ts +45 -26
- package/src/shared/lib/chat/timeline/block-chrome.ts +19 -0
- package/src/shared/lib/chat/timeline/tool-render-mode.ts +17 -4
- package/src/shared/lib/chat/tool/artifact.ts +55 -20
- package/src/shared/lib/chat/tool/bash-facts.ts +96 -0
- package/src/shared/lib/chat/tool/minimized.test.ts +98 -0
- package/src/shared/lib/chat/tool/minimized.ts +64 -0
- package/src/shared/lib/chat/tool/summary.test.ts +28 -8
- package/src/shared/lib/chat/tool/summary.ts +3 -32
- package/src/shared/lib/markdown/blocks/anchor.ts +63 -0
- package/src/shared/lib/markdown/blocks/blocks.test.ts +141 -0
- package/src/shared/lib/markdown/blocks/renderer.ts +120 -0
- package/src/shared/lib/markdown/blocks/scan.ts +100 -0
- package/src/shared/lib/markdown/blocks/types.ts +62 -0
- package/src/shared/lib/markdown/marked.ts +58 -147
- package/src/shared/lib/markdown/math-extensions.ts +168 -0
- package/src/shared/lib/markdown/review/prompt.ts +77 -0
- package/src/shared/lib/markdown/review/reconcile.ts +55 -0
- package/src/shared/lib/markdown/review/review.test.ts +96 -0
- package/src/shared/lib/markdown/xml-sections.test.ts +140 -0
- package/src/shared/lib/markdown/xml-sections.ts +139 -0
- package/src/shared/lib/models/provider/label.ts +57 -0
- package/src/shared/lib/omp/config/agent-file.test.ts +54 -0
- package/src/shared/lib/omp/config/agent-file.ts +43 -0
- package/src/shared/lib/omp/config/row-value.test.ts +95 -0
- package/src/shared/lib/omp/config/row-value.ts +97 -0
- package/src/shared/lib/omp/config/schema.test.ts +31 -0
- package/src/shared/lib/omp/config/schema.ts +6 -0
- package/src/shared/lib/omp/rpc/frame.test.ts +48 -47
- package/src/shared/lib/omp/rpc/frame.ts +49 -40
- package/src/shared/lib/ui/menu-anchor.test.ts +69 -0
- package/src/shared/lib/ui/menu-anchor.ts +89 -0
- package/src/shared/lib/usage/breakdown.test.ts +197 -0
- package/src/shared/lib/usage/breakdown.ts +241 -0
- package/src/shared/lib/usage/range.test.ts +204 -0
- package/src/shared/lib/usage/range.ts +240 -0
- package/src/shared/lib/usage/view.test.ts +85 -0
- package/src/shared/lib/usage/view.ts +74 -0
- package/src/shared/types/browser.ts +78 -0
- package/src/shared/types/index.ts +1 -0
- package/src/shared/types/settings/agent.ts +28 -6
- package/src/shared/types/settings/state.ts +4 -3
- package/src/shared/types/settings/write.ts +6 -0
- package/src/shared/types/tokenUsage.ts +128 -21
- package/src/shared/types/updates.ts +20 -0
- package/dist/client/static/js/index-3ve31rzx.css +0 -1
- package/src/server/lib/omp/session/usage/aggregate-shaping.test.ts +0 -149
- package/src/server/lib/omp/session/usage/aggregate.test.ts +0 -243
- package/src/server/lib/omp/session/usage/aggregate.ts +0 -330
- package/src/server/lib/omp/session/usage/shaping.ts +0 -130
|
@@ -38,6 +38,23 @@ export interface UseUpdatesOptions {
|
|
|
38
38
|
restart?: RestartWatchDeps;
|
|
39
39
|
}
|
|
40
40
|
|
|
41
|
+
/**
|
|
42
|
+
* How often a console left open re-reads the update status.
|
|
43
|
+
*
|
|
44
|
+
* The mount check alone was the published-release gap users hit: a server that
|
|
45
|
+
* booted before `vX` reached npm kept that answer for the life of the page, so
|
|
46
|
+
* the "update available" popup never appeared until a restart. Half an hour is
|
|
47
|
+
* the cost of one registry read plus one `omp --version` spawn per open console.
|
|
48
|
+
*/
|
|
49
|
+
export const UPDATE_RECHECK_INTERVAL_MS = 30 * 60_000;
|
|
50
|
+
|
|
51
|
+
/**
|
|
52
|
+
* Floor between automatic re-checks. `focus` and `visibilitychange` both fire
|
|
53
|
+
* on the same return to the app, and a burst of them must not become a burst of
|
|
54
|
+
* registry reads; the manual "Check again" button bypasses this.
|
|
55
|
+
*/
|
|
56
|
+
export const UPDATE_RECHECK_MIN_GAP_MS = 60_000;
|
|
57
|
+
|
|
41
58
|
function responseMessage(payload: unknown, fallback: string): string {
|
|
42
59
|
if (typeof payload !== 'object' || payload === null) return fallback;
|
|
43
60
|
|
|
@@ -65,12 +82,14 @@ export function useUpdates(options: UseUpdatesOptions = {}): UseUpdatesResult {
|
|
|
65
82
|
const [progress, setProgress] = useState<UpdateLogState | null>(null);
|
|
66
83
|
const [error, setError] = useState<string | null>(null);
|
|
67
84
|
const inFlightCheckRef = useRef<Promise<void> | null>(null);
|
|
85
|
+
const lastCheckAtRef = useRef(0);
|
|
68
86
|
const didAutoCheckRef = useRef(false);
|
|
69
87
|
const applyAbortRef = useRef<AbortController | null>(null);
|
|
70
88
|
|
|
71
89
|
const check = useCallback(() => {
|
|
72
90
|
if (inFlightCheckRef.current) return inFlightCheckRef.current;
|
|
73
91
|
|
|
92
|
+
lastCheckAtRef.current = Date.now();
|
|
74
93
|
const request = (async () => {
|
|
75
94
|
setChecking(true);
|
|
76
95
|
setError(null);
|
|
@@ -239,6 +258,37 @@ export function useUpdates(options: UseUpdatesOptions = {}): UseUpdatesResult {
|
|
|
239
258
|
void check();
|
|
240
259
|
}, [check]);
|
|
241
260
|
|
|
261
|
+
/**
|
|
262
|
+
* Re-read the status without a reload.
|
|
263
|
+
*
|
|
264
|
+
* Two triggers because a console has two ways of being away and coming back:
|
|
265
|
+
* a browser tab reports `visibilitychange`, and a native shell window reports
|
|
266
|
+
* `focus` (the WKWebView/WebView keeps `visibilityState: visible` while the
|
|
267
|
+
* app is in the background). The interval is the fallback for a console that
|
|
268
|
+
* never left the screen — the page that stays open for days is exactly the
|
|
269
|
+
* one the mount check used to strand.
|
|
270
|
+
*/
|
|
271
|
+
useEffect(() => {
|
|
272
|
+
const recheck = () => {
|
|
273
|
+
if (document.visibilityState === 'hidden') return;
|
|
274
|
+
if (Date.now() - lastCheckAtRef.current < UPDATE_RECHECK_MIN_GAP_MS) return;
|
|
275
|
+
void check();
|
|
276
|
+
};
|
|
277
|
+
const onVisibilityChange = () => {
|
|
278
|
+
if (document.visibilityState === 'visible') recheck();
|
|
279
|
+
};
|
|
280
|
+
|
|
281
|
+
document.addEventListener('visibilitychange', onVisibilityChange);
|
|
282
|
+
window.addEventListener('focus', recheck);
|
|
283
|
+
const timer = window.setInterval(recheck, UPDATE_RECHECK_INTERVAL_MS);
|
|
284
|
+
|
|
285
|
+
return () => {
|
|
286
|
+
document.removeEventListener('visibilitychange', onVisibilityChange);
|
|
287
|
+
window.removeEventListener('focus', recheck);
|
|
288
|
+
window.clearInterval(timer);
|
|
289
|
+
};
|
|
290
|
+
}, [check]);
|
|
291
|
+
|
|
242
292
|
useEffect(() => () => applyAbortRef.current?.abort(), []);
|
|
243
293
|
|
|
244
294
|
return {
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* SPDX-License-Identifier: MIT
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* `useActiveReleaseNotes` — the About modal's per-target "What's new" read.
|
|
8
|
+
*
|
|
9
|
+
* The contract that matters: the only thing sent is WHICH product (both
|
|
10
|
+
* versions are derived server-side), the payload's own `error` field is what the
|
|
11
|
+
* dialog shows, and a closed dialog makes no request at all. Stubbed `fetch`
|
|
12
|
+
* records the URL, so a target mix-up cannot pass as a rendering detail.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { afterAll, afterEach, beforeAll, describe, expect, test } from 'bun:test';
|
|
16
|
+
import { Window } from 'happy-dom';
|
|
17
|
+
import { h, render } from 'preact';
|
|
18
|
+
import { act } from 'preact/test-utils';
|
|
19
|
+
|
|
20
|
+
import { useActiveReleaseNotes } from '@/client/hooks/ui/updates/notes';
|
|
21
|
+
import { installDomGlobals, restoreDomGlobals } from '@/test-support/pristine-globals';
|
|
22
|
+
import type { ActiveReleaseNotes, UpdateTarget } from '@/shared/types/updates';
|
|
23
|
+
|
|
24
|
+
let container: HTMLElement;
|
|
25
|
+
const originalFetch = Bun.fetch;
|
|
26
|
+
|
|
27
|
+
/** The runner's own globals are restored in `afterAll`; `fetch` is not a DOM global. */
|
|
28
|
+
function Harness({ target }: { target: UpdateTarget | null }) {
|
|
29
|
+
const notes = useActiveReleaseNotes(target);
|
|
30
|
+
return h(
|
|
31
|
+
'span',
|
|
32
|
+
{ id: 'out' },
|
|
33
|
+
JSON.stringify({
|
|
34
|
+
version: notes.data?.version ?? null,
|
|
35
|
+
note: notes.data?.note?.version ?? null,
|
|
36
|
+
loading: notes.loading,
|
|
37
|
+
error: notes.error,
|
|
38
|
+
}),
|
|
39
|
+
);
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
function payload(overrides: Partial<ActiveReleaseNotes> = {}): ActiveReleaseNotes {
|
|
43
|
+
return {
|
|
44
|
+
target: 'kabmo',
|
|
45
|
+
version: '3.9.0',
|
|
46
|
+
note: { version: '3.9.0', date: '2026-01-01', url: 'https://example.test/v3.9.0', body: '* notes' },
|
|
47
|
+
changelogUrl: 'https://example.test/CHANGELOG.md',
|
|
48
|
+
error: null,
|
|
49
|
+
...overrides,
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
/** A fetch double that records the URLs asked and answers one payload. */
|
|
54
|
+
function stubFetch(asked: string[], body: unknown, status = 200): void {
|
|
55
|
+
globalThis.fetch = (async (input: string | URL | Request) => {
|
|
56
|
+
asked.push(String(input));
|
|
57
|
+
return { ok: status < 400, status, json: async () => body } as Response;
|
|
58
|
+
}) as unknown as typeof fetch;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
async function mount(target: UpdateTarget | null): Promise<Record<string, unknown>> {
|
|
62
|
+
await act(async () => {
|
|
63
|
+
render(h(Harness, { target }), container);
|
|
64
|
+
});
|
|
65
|
+
// The read is an effect: let its promise settle and re-render.
|
|
66
|
+
for (let i = 0; i < 20; i += 1) await act(async () => {});
|
|
67
|
+
return JSON.parse(container.querySelector('#out')?.textContent ?? '{}') as Record<string, unknown>;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
beforeAll(() => {
|
|
71
|
+
installDomGlobals(new Window({ url: 'http://localhost' }));
|
|
72
|
+
container = document.createElement('div');
|
|
73
|
+
document.body.appendChild(container);
|
|
74
|
+
});
|
|
75
|
+
|
|
76
|
+
afterEach(() => {
|
|
77
|
+
act(() => render(null, container));
|
|
78
|
+
globalThis.fetch = originalFetch;
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
afterAll(() => {
|
|
82
|
+
container.remove();
|
|
83
|
+
restoreDomGlobals();
|
|
84
|
+
globalThis.fetch = originalFetch;
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
describe('useActiveReleaseNotes', () => {
|
|
88
|
+
test('asks for the target and reports the section for the running version', async () => {
|
|
89
|
+
const asked: string[] = [];
|
|
90
|
+
stubFetch(asked, payload());
|
|
91
|
+
|
|
92
|
+
const out = await mount('kabmo');
|
|
93
|
+
|
|
94
|
+
expect(asked).toEqual(['/api/updates/notes?target=kabmo']);
|
|
95
|
+
expect(out).toMatchObject({ version: '3.9.0', note: '3.9.0', loading: false, error: null });
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
test('the per-target URL is the product, never a caller-supplied version', async () => {
|
|
99
|
+
const asked: string[] = [];
|
|
100
|
+
stubFetch(asked, payload({ target: 'omp', version: '18.3.0' }));
|
|
101
|
+
|
|
102
|
+
await mount('omp');
|
|
103
|
+
|
|
104
|
+
expect(asked).toEqual(['/api/updates/notes?target=omp']);
|
|
105
|
+
});
|
|
106
|
+
|
|
107
|
+
test('a payload error is what the dialog shows', async () => {
|
|
108
|
+
stubFetch([], payload({ version: '9.9.9', note: null, error: 'No changelog section for v9.9.9' }));
|
|
109
|
+
|
|
110
|
+
const out = await mount('omp');
|
|
111
|
+
|
|
112
|
+
expect(out).toMatchObject({
|
|
113
|
+
version: '9.9.9',
|
|
114
|
+
note: null,
|
|
115
|
+
loading: false,
|
|
116
|
+
error: 'No changelog section for v9.9.9',
|
|
117
|
+
});
|
|
118
|
+
});
|
|
119
|
+
|
|
120
|
+
test('a non-ok response is reported instead of rendering nothing', async () => {
|
|
121
|
+
stubFetch([], { error: 'Unknown update target' }, 400);
|
|
122
|
+
|
|
123
|
+
const out = await mount('kabmo');
|
|
124
|
+
|
|
125
|
+
expect(out.error).toBe('Could not load release notes (HTTP 400)');
|
|
126
|
+
expect(out.loading).toBe(false);
|
|
127
|
+
});
|
|
128
|
+
|
|
129
|
+
test('a closed dialog makes no request', async () => {
|
|
130
|
+
const asked: string[] = [];
|
|
131
|
+
stubFetch(asked, payload());
|
|
132
|
+
|
|
133
|
+
const out = await mount(null);
|
|
134
|
+
|
|
135
|
+
expect(asked).toEqual([]);
|
|
136
|
+
expect(out).toMatchObject({ version: null, note: null, loading: false, error: null });
|
|
137
|
+
});
|
|
138
|
+
});
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The About modal's per-target "What's new": the changelog section for the
|
|
3
|
+
* version this install is running.
|
|
4
|
+
*
|
|
5
|
+
* One request per target when its dialog opens — the payload is one release
|
|
6
|
+
* section, which cannot change while the dialog is on screen. The server derives
|
|
7
|
+
* both versions itself, so the only thing this hook sends is WHICH product.
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
import { useEffect, useRef, useState } from 'preact/hooks';
|
|
11
|
+
import type { ActiveReleaseNotes, UpdateTarget } from '@/shared/types/updates';
|
|
12
|
+
|
|
13
|
+
export interface UseActiveReleaseNotesResult {
|
|
14
|
+
data: ActiveReleaseNotes | null;
|
|
15
|
+
loading: boolean;
|
|
16
|
+
error: string | null;
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
export function useActiveReleaseNotes(target: UpdateTarget | null): UseActiveReleaseNotesResult {
|
|
20
|
+
const [data, setData] = useState<ActiveReleaseNotes | null>(null);
|
|
21
|
+
const [loading, setLoading] = useState(false);
|
|
22
|
+
const [error, setError] = useState<string | null>(null);
|
|
23
|
+
const abortRef = useRef<AbortController | null>(null);
|
|
24
|
+
|
|
25
|
+
useEffect(() => {
|
|
26
|
+
if (!target) {
|
|
27
|
+
setData(null);
|
|
28
|
+
setLoading(false);
|
|
29
|
+
setError(null);
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
const controller = new AbortController();
|
|
34
|
+
abortRef.current = controller;
|
|
35
|
+
setLoading(true);
|
|
36
|
+
setError(null);
|
|
37
|
+
|
|
38
|
+
void (async () => {
|
|
39
|
+
try {
|
|
40
|
+
const response = await fetch(`/api/updates/notes?target=${target}`, { signal: controller.signal });
|
|
41
|
+
const payload = (await response.json()) as ActiveReleaseNotes;
|
|
42
|
+
if (!response.ok) throw new Error(`Could not load release notes (HTTP ${response.status})`);
|
|
43
|
+
setData(payload);
|
|
44
|
+
setError(payload.error);
|
|
45
|
+
} catch (cause) {
|
|
46
|
+
if (controller.signal.aborted) return;
|
|
47
|
+
setError(cause instanceof Error ? cause.message : 'Could not load release notes');
|
|
48
|
+
} finally {
|
|
49
|
+
if (!controller.signal.aborted) setLoading(false);
|
|
50
|
+
}
|
|
51
|
+
})();
|
|
52
|
+
|
|
53
|
+
return () => controller.abort();
|
|
54
|
+
}, [target]);
|
|
55
|
+
|
|
56
|
+
return { data, loading, error };
|
|
57
|
+
}
|
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* SPDX-License-Identifier: MIT
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Reading the element under a mark.
|
|
8
|
+
*
|
|
9
|
+
* Two rules are pinned here, and they are the ones that keep the panel honest:
|
|
10
|
+
*
|
|
11
|
+
* - A cross-origin frame answers a REASON, never an element and never a blank.
|
|
12
|
+
* Measured in Chromium, `127.0.0.1:7101` embedding `127.0.0.1:7102` reports
|
|
13
|
+
* `contentDocument === null`; the same origin reports a live document.
|
|
14
|
+
* - A `<select>` reports its CHOSEN VALUE and option count. That is the fact a
|
|
15
|
+
* screenshot cannot give an agent and a user would have to type out — and it
|
|
16
|
+
* is why the user-browser panel asks for elements at all.
|
|
17
|
+
*/
|
|
18
|
+
|
|
19
|
+
import { afterAll, beforeAll, beforeEach, describe, expect, test } from 'bun:test';
|
|
20
|
+
import { Window } from 'happy-dom';
|
|
21
|
+
|
|
22
|
+
import { describeElement, elementAtPoint, elementPath, frameReadability } from '@/client/lib/browser/element-at';
|
|
23
|
+
|
|
24
|
+
const DOM_GLOBALS = ['window', 'document', 'navigator', 'Node', 'Element', 'HTMLElement', 'HTMLSelectElement'] as const;
|
|
25
|
+
const native: Partial<Record<(typeof DOM_GLOBALS)[number], unknown>> = {};
|
|
26
|
+
|
|
27
|
+
let win: Window;
|
|
28
|
+
/**
|
|
29
|
+
* The fixture document, typed as the runner's `lib.dom` `Document`.
|
|
30
|
+
*
|
|
31
|
+
* The cast is the whole point of the harness: happy-dom's `Document` is a
|
|
32
|
+
* different type from `lib.dom`'s (it lacks `currentCSSZoom`, `part` and the
|
|
33
|
+
* rest), while at runtime it is the object `highlight` reads. Typing it as
|
|
34
|
+
* happy-dom's own class would force every `createElement` result through a
|
|
35
|
+
* second cast.
|
|
36
|
+
*/
|
|
37
|
+
let doc: Document;
|
|
38
|
+
|
|
39
|
+
beforeAll(() => {
|
|
40
|
+
win = new Window({ url: 'http://localhost' });
|
|
41
|
+
const target = globalThis as unknown as Record<string, unknown>;
|
|
42
|
+
for (const key of DOM_GLOBALS) {
|
|
43
|
+
if (!(key in native)) native[key] = target[key];
|
|
44
|
+
target[key] = (win as unknown as Record<string, unknown>)[key];
|
|
45
|
+
}
|
|
46
|
+
});
|
|
47
|
+
|
|
48
|
+
afterAll(() => {
|
|
49
|
+
const target = globalThis as unknown as Record<string, unknown>;
|
|
50
|
+
for (const key of DOM_GLOBALS) {
|
|
51
|
+
if (native[key] === undefined) delete target[key];
|
|
52
|
+
else target[key] = native[key];
|
|
53
|
+
}
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
/** A readable iframe: its `contentDocument` IS the fixture document. */
|
|
57
|
+
function readableFrame(): HTMLIFrameElement {
|
|
58
|
+
return { contentDocument: doc, contentWindow: win } as unknown as HTMLIFrameElement;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/** A frame whose document this origin cannot touch — the real production case. */
|
|
62
|
+
function crossOriginFrame(): HTMLIFrameElement {
|
|
63
|
+
return { contentDocument: null, contentWindow: null } as unknown as HTMLIFrameElement;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
beforeEach(() => {
|
|
67
|
+
doc = win.document as unknown as Document;
|
|
68
|
+
doc.body.innerHTML = '';
|
|
69
|
+
// happy-dom has no layout, so the frame's viewport is stated and
|
|
70
|
+
// `elementFromPoint` is answered from the point these cases aim at.
|
|
71
|
+
Object.defineProperty(win, 'innerWidth', { value: 1000, configurable: true });
|
|
72
|
+
Object.defineProperty(win, 'innerHeight', { value: 500, configurable: true });
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
/** Make `elementFromPoint` answer whatever sits at the given fractions. */
|
|
76
|
+
function hitAt(fractions: { x: number; y: number }, element: Element | null): { asked: string[] } {
|
|
77
|
+
const asked: string[] = [];
|
|
78
|
+
(doc as unknown as Record<string, unknown>).elementFromPoint = (x: number, y: number) => {
|
|
79
|
+
asked.push(`${x},${y}`);
|
|
80
|
+
const matchesX = Math.abs(x - fractions.x * 1000) < 1;
|
|
81
|
+
const matchesY = Math.abs(y - fractions.y * 500) < 1;
|
|
82
|
+
return matchesX && matchesY ? element : null;
|
|
83
|
+
};
|
|
84
|
+
return { asked };
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
describe('frameReadability', () => {
|
|
88
|
+
test('a live document is readable', () => {
|
|
89
|
+
expect(frameReadability(readableFrame())).toBe('readable');
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
test('a null document is cross-origin, not an error', () => {
|
|
93
|
+
expect(frameReadability(crossOriginFrame())).toBe('cross-origin');
|
|
94
|
+
});
|
|
95
|
+
|
|
96
|
+
test('a frame that throws while being read is treated as cross-origin', () => {
|
|
97
|
+
const trap = Object.defineProperty({}, 'contentDocument', {
|
|
98
|
+
get() {
|
|
99
|
+
throw new Error('SecurityError');
|
|
100
|
+
},
|
|
101
|
+
}) as unknown as HTMLIFrameElement;
|
|
102
|
+
expect(frameReadability(trap)).toBe('cross-origin');
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
test('no frame at all is its own reason', () => {
|
|
106
|
+
expect(frameReadability(null)).toBe('no-frame');
|
|
107
|
+
});
|
|
108
|
+
});
|
|
109
|
+
|
|
110
|
+
describe('elementAtPoint', () => {
|
|
111
|
+
test('a cross-origin frame answers a reason and never guesses an element', () => {
|
|
112
|
+
const result = elementAtPoint(crossOriginFrame(), { x: 0.5, y: 0.5 });
|
|
113
|
+
expect(result).toEqual({ ok: false, reason: 'cross-origin' });
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
test('a mark over empty space is no-element, which is not the same fact', () => {
|
|
117
|
+
hitAt({ x: 0.5, y: 0.5 }, null);
|
|
118
|
+
expect(elementAtPoint(readableFrame(), { x: 0.5, y: 0.5 })).toEqual({ ok: false, reason: 'no-element' });
|
|
119
|
+
});
|
|
120
|
+
|
|
121
|
+
test('the marked point maps onto the FRAME viewport, not the panel box', () => {
|
|
122
|
+
const button = doc.createElement('button');
|
|
123
|
+
button.id = 'pay';
|
|
124
|
+
doc.body.appendChild(button);
|
|
125
|
+
const probe = hitAt({ x: 0.25, y: 0.4 }, button);
|
|
126
|
+
const result = elementAtPoint(readableFrame(), { x: 0.25, y: 0.4 });
|
|
127
|
+
expect(result.ok).toBe(true);
|
|
128
|
+
// 25% of a 1000px viewport, 40% of a 500px one.
|
|
129
|
+
expect(probe.asked).toEqual(['250,200']);
|
|
130
|
+
});
|
|
131
|
+
|
|
132
|
+
test('a section reports its aria-label in the path', () => {
|
|
133
|
+
const section = doc.createElement('section');
|
|
134
|
+
section.setAttribute('aria-label', 'Ringkasan pesanan');
|
|
135
|
+
doc.body.appendChild(section);
|
|
136
|
+
hitAt({ x: 0.5, y: 0.5 }, section);
|
|
137
|
+
const result = elementAtPoint(readableFrame(), { x: 0.5, y: 0.5 });
|
|
138
|
+
expect(result.ok).toBe(true);
|
|
139
|
+
if (!result.ok) return;
|
|
140
|
+
expect(result.element.path).toContain('section[aria-label="Ringkasan pesanan"]');
|
|
141
|
+
expect(result.element.tag).toBe('section');
|
|
142
|
+
});
|
|
143
|
+
|
|
144
|
+
test('a select reports its chosen value and option count', () => {
|
|
145
|
+
const select = doc.createElement('select');
|
|
146
|
+
select.id = 'prov';
|
|
147
|
+
for (const name of ['Aceh', 'Jawa Barat', 'Bali']) {
|
|
148
|
+
const option = doc.createElement('option');
|
|
149
|
+
option.value = name.toLowerCase();
|
|
150
|
+
option.textContent = name;
|
|
151
|
+
select.appendChild(option);
|
|
152
|
+
}
|
|
153
|
+
select.value = 'jawa barat';
|
|
154
|
+
doc.body.appendChild(select);
|
|
155
|
+
hitAt({ x: 0.3, y: 0.3 }, select);
|
|
156
|
+
const result = elementAtPoint(readableFrame(), { x: 0.3, y: 0.3 });
|
|
157
|
+
expect(result.ok).toBe(true);
|
|
158
|
+
if (!result.ok) return;
|
|
159
|
+
expect(result.element.tag).toBe('select');
|
|
160
|
+
expect(result.element.state).toContain('nilai "Jawa Barat"');
|
|
161
|
+
expect(result.element.state).toContain('3 opsi');
|
|
162
|
+
});
|
|
163
|
+
|
|
164
|
+
test('a disabled control says so, which is the bug users report most', () => {
|
|
165
|
+
const button = doc.createElement('button');
|
|
166
|
+
button.textContent = 'Bayar';
|
|
167
|
+
button.setAttribute('disabled', '');
|
|
168
|
+
doc.body.appendChild(button);
|
|
169
|
+
hitAt({ x: 0.5, y: 0.5 }, button);
|
|
170
|
+
const result = elementAtPoint(readableFrame(), { x: 0.5, y: 0.5 });
|
|
171
|
+
expect(result.ok).toBe(true);
|
|
172
|
+
if (!result.ok) return;
|
|
173
|
+
expect(result.element.state).toContain('nonaktif');
|
|
174
|
+
expect(result.element.text).toBe('Bayar');
|
|
175
|
+
});
|
|
176
|
+
|
|
177
|
+
test('a password input never reports its value', () => {
|
|
178
|
+
const input = doc.createElement('input');
|
|
179
|
+
input.type = 'password';
|
|
180
|
+
input.value = 'rahasia-sekali';
|
|
181
|
+
doc.body.appendChild(input);
|
|
182
|
+
hitAt({ x: 0.5, y: 0.5 }, input);
|
|
183
|
+
const result = elementAtPoint(readableFrame(), { x: 0.5, y: 0.5 });
|
|
184
|
+
expect(result.ok).toBe(true);
|
|
185
|
+
if (!result.ok) return;
|
|
186
|
+
expect(JSON.stringify(result.element)).not.toContain('rahasia-sekali');
|
|
187
|
+
expect(result.element.state).toContain('tipe password');
|
|
188
|
+
});
|
|
189
|
+
|
|
190
|
+
test('body and html are not "an element under the mark"', () => {
|
|
191
|
+
hitAt({ x: 0.5, y: 0.5 }, doc.body);
|
|
192
|
+
expect(elementAtPoint(readableFrame(), { x: 0.5, y: 0.5 })).toEqual({ ok: false, reason: 'no-element' });
|
|
193
|
+
});
|
|
194
|
+
});
|
|
195
|
+
|
|
196
|
+
describe('elementPath', () => {
|
|
197
|
+
test('keeps at most four levels and stops at html', () => {
|
|
198
|
+
const outer = doc.createElement('main');
|
|
199
|
+
const middle = doc.createElement('section');
|
|
200
|
+
const inner = doc.createElement('div');
|
|
201
|
+
const leaf = doc.createElement('button');
|
|
202
|
+
inner.appendChild(leaf);
|
|
203
|
+
middle.appendChild(inner);
|
|
204
|
+
outer.appendChild(middle);
|
|
205
|
+
doc.body.appendChild(outer);
|
|
206
|
+
const path = elementPath(leaf);
|
|
207
|
+
expect(path.split(' > ')).toHaveLength(4);
|
|
208
|
+
expect(path.endsWith('button')).toBe(true);
|
|
209
|
+
expect(path).not.toContain('html');
|
|
210
|
+
});
|
|
211
|
+
|
|
212
|
+
test('an id wins over a tag alone', () => {
|
|
213
|
+
const node = doc.createElement('div');
|
|
214
|
+
node.id = 'cart';
|
|
215
|
+
doc.body.appendChild(node);
|
|
216
|
+
expect(elementPath(node)).toContain('div#cart');
|
|
217
|
+
});
|
|
218
|
+
});
|
|
219
|
+
|
|
220
|
+
describe('describeElement', () => {
|
|
221
|
+
test('collapses whitespace and cuts long text', () => {
|
|
222
|
+
const node = doc.createElement('p');
|
|
223
|
+
node.textContent = ` ${'kata '.repeat(40)} `;
|
|
224
|
+
doc.body.appendChild(node);
|
|
225
|
+
const info = describeElement(node);
|
|
226
|
+
expect(info.text?.length).toBeLessThanOrEqual(60);
|
|
227
|
+
expect(info.text?.startsWith('kata kata')).toBe(true);
|
|
228
|
+
});
|
|
229
|
+
});
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* SPDX-License-Identifier: MIT
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Reading what is under a mark, when the page allows it at all.
|
|
8
|
+
*
|
|
9
|
+
* The panel renders the user's page in an iframe, and a real dev server is a
|
|
10
|
+
* DIFFERENT ORIGIN from Kabmo even on the same host: measured in Chromium, a
|
|
11
|
+
* page on `127.0.0.1:7101` embedding `127.0.0.1:7102` reports
|
|
12
|
+
* `contentDocument === null` (no throw — the check is free), while the same
|
|
13
|
+
* origin reports a live document whose `elementFromPoint` answers `H2`.
|
|
14
|
+
*
|
|
15
|
+
* So this module has exactly two honest outcomes, and it never guesses:
|
|
16
|
+
* an element, or a stated reason. A mark with no element is still a complete
|
|
17
|
+
* mark — the user's label and note carry it — and the prompt says the page was
|
|
18
|
+
* not readable instead of silently looking less capable.
|
|
19
|
+
*
|
|
20
|
+
* Coordinates arrive normalized to the panel (0..1) because that is what the
|
|
21
|
+
* overlay stores. Inside the frame they map onto the frame's own viewport,
|
|
22
|
+
* which is the one box `zoom` and a viewport preset never change the meaning of.
|
|
23
|
+
*/
|
|
24
|
+
|
|
25
|
+
import type { AnnotateElement, AnnotatePoint } from '@/shared/types';
|
|
26
|
+
|
|
27
|
+
/** Why a mark carries no element, or that it does. */
|
|
28
|
+
export type ElementAtResult =
|
|
29
|
+
| { ok: true; element: AnnotateElement }
|
|
30
|
+
| { ok: false; reason: 'no-frame' | 'cross-origin' | 'no-element' };
|
|
31
|
+
|
|
32
|
+
/** Longest visible text kept from a marked element, in UTF-16 units. */
|
|
33
|
+
const ELEMENT_TEXT_MAX_LEN = 60;
|
|
34
|
+
/** Levels of ancestry kept in a path; deeper paths stop telling the agent more. */
|
|
35
|
+
const ELEMENT_PATH_MAX_DEPTH = 4;
|
|
36
|
+
|
|
37
|
+
/** Whether the frame's document is readable at all — the whole game for this module. */
|
|
38
|
+
export function frameReadability(frame: HTMLIFrameElement | null): 'readable' | 'cross-origin' | 'no-frame' {
|
|
39
|
+
if (!frame) return 'no-frame';
|
|
40
|
+
try {
|
|
41
|
+
return frame.contentDocument ? 'readable' : 'cross-origin';
|
|
42
|
+
} catch {
|
|
43
|
+
// A frame that throws is as unreadable as one that answers null.
|
|
44
|
+
return 'cross-origin';
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/** Collapse whitespace and cut to the stored maximum, ending with an ellipsis. */
|
|
49
|
+
function shortText(value: string): string {
|
|
50
|
+
const collapsed = value.replace(/\s+/g, ' ').trim();
|
|
51
|
+
return collapsed.length > ELEMENT_TEXT_MAX_LEN
|
|
52
|
+
? `${collapsed.slice(0, ELEMENT_TEXT_MAX_LEN - 1)}…`
|
|
53
|
+
: collapsed;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/** One step of a path: id wins, then the one identifying attribute, then the tag. */
|
|
57
|
+
function pathStep(element: Element): string {
|
|
58
|
+
const tag = element.tagName.toLowerCase();
|
|
59
|
+
if (element.id) return `${tag}#${element.id}`;
|
|
60
|
+
for (const attribute of ['data-testid', 'data-test', 'aria-label']) {
|
|
61
|
+
const value = element.getAttribute(attribute);
|
|
62
|
+
if (value) return `${tag}[${attribute}="${shortText(value)}"]`;
|
|
63
|
+
}
|
|
64
|
+
const role = element.getAttribute('role');
|
|
65
|
+
if (role) return `${tag}[role="${role}"]`;
|
|
66
|
+
return tag;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
/** `html > body > section … > select`, at most `ELEMENT_PATH_MAX_DEPTH` steps. */
|
|
70
|
+
export function elementPath(element: Element): string {
|
|
71
|
+
const steps: string[] = [];
|
|
72
|
+
let current: Element | null = element;
|
|
73
|
+
while (current && steps.length < ELEMENT_PATH_MAX_DEPTH) {
|
|
74
|
+
if (current.tagName.toLowerCase() === 'html') break;
|
|
75
|
+
steps.unshift(pathStep(current));
|
|
76
|
+
current = current.parentElement;
|
|
77
|
+
}
|
|
78
|
+
return steps.join(' > ');
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* The state a form control is in — the part a screenshot could not tell the
|
|
83
|
+
* agent and a user would have to type out by hand.
|
|
84
|
+
*/
|
|
85
|
+
function controlState(element: Element): string | undefined {
|
|
86
|
+
const parts: string[] = [];
|
|
87
|
+
if ((element as HTMLInputElement).disabled) parts.push('nonaktif');
|
|
88
|
+
if (element instanceof HTMLSelectElement || element.tagName.toLowerCase() === 'select') {
|
|
89
|
+
const select = element as HTMLSelectElement;
|
|
90
|
+
const chosen = select.selectedOptions?.[0];
|
|
91
|
+
const value = chosen?.textContent?.trim() || select.value;
|
|
92
|
+
if (value) parts.push(`nilai "${shortText(value)}"`);
|
|
93
|
+
const count = select.options?.length ?? 0;
|
|
94
|
+
if (count > 0) parts.push(`${count} opsi`);
|
|
95
|
+
} else if (element.tagName.toLowerCase() === 'input') {
|
|
96
|
+
const input = element as HTMLInputElement;
|
|
97
|
+
if (input.type) parts.push(`tipe ${input.type}`);
|
|
98
|
+
// A password's value is never read; a placeholder is what the user sees.
|
|
99
|
+
if (input.type !== 'password' && input.placeholder) parts.push(`placeholder "${shortText(input.placeholder)}"`);
|
|
100
|
+
}
|
|
101
|
+
return parts.length > 0 ? parts.join(', ') : undefined;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
/** The element summary, without the coordinate work. */
|
|
105
|
+
export function describeElement(element: Element): AnnotateElement {
|
|
106
|
+
const info: AnnotateElement = { path: elementPath(element), tag: element.tagName.toLowerCase() };
|
|
107
|
+
const role = element.getAttribute('role');
|
|
108
|
+
if (role) info.role = role;
|
|
109
|
+
const text = shortText((element as HTMLElement).innerText ?? element.textContent ?? '');
|
|
110
|
+
if (text) info.text = text;
|
|
111
|
+
const state = controlState(element);
|
|
112
|
+
if (state) info.state = state;
|
|
113
|
+
return info;
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* The element under a normalized point of the panel.
|
|
118
|
+
*
|
|
119
|
+
* `no-element` is a real answer: a mark over empty space has nothing beneath it,
|
|
120
|
+
* and that is not the same fact as an unreadable page.
|
|
121
|
+
*/
|
|
122
|
+
export function elementAtPoint(frame: HTMLIFrameElement | null, point: AnnotatePoint): ElementAtResult {
|
|
123
|
+
const readability = frameReadability(frame);
|
|
124
|
+
if (readability !== 'readable') return { ok: false, reason: readability };
|
|
125
|
+
const win = frame!.contentWindow;
|
|
126
|
+
const doc = frame!.contentDocument;
|
|
127
|
+
if (!win || !doc) return { ok: false, reason: 'cross-origin' };
|
|
128
|
+
try {
|
|
129
|
+
// The frame's own viewport is the box the normalized point is a fraction of;
|
|
130
|
+
// the panel's CSS zoom and its viewport preset never enter this mapping.
|
|
131
|
+
const x = Math.min(Math.max(point.x, 0), 1) * win.innerWidth;
|
|
132
|
+
const y = Math.min(Math.max(point.y, 0), 1) * win.innerHeight;
|
|
133
|
+
const hit = doc.elementFromPoint(x, y);
|
|
134
|
+
if (!hit || hit === doc.documentElement || hit === doc.body) return { ok: false, reason: 'no-element' };
|
|
135
|
+
return { ok: true, element: describeElement(hit) };
|
|
136
|
+
} catch {
|
|
137
|
+
return { ok: false, reason: 'cross-origin' };
|
|
138
|
+
}
|
|
139
|
+
}
|