gloomberb 0.20.2 → 0.20.4

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 (471) hide show
  1. package/README.md +1 -1
  2. package/README.zh-CN.md +1 -1
  3. package/package.json +2 -1
  4. package/src/account/auth-dialog.tsx +17 -0
  5. package/src/account/auth-form.tsx +13 -8
  6. package/src/account/upgrade-dialog.tsx +1 -1
  7. package/src/api-client/central-bank-rates.ts +5 -0
  8. package/src/api-client/data.ts +23 -4
  9. package/src/api-client/debt-maturities.ts +45 -2
  10. package/src/api-client/earnings.ts +4 -2
  11. package/src/api-client/errors.ts +21 -11
  12. package/src/api-client/fx-interventions.ts +64 -0
  13. package/src/api-client/index.ts +2 -0
  14. package/src/api-client/paths.ts +9 -1
  15. package/src/api-client/release-summaries.ts +21 -0
  16. package/src/api-client/social-mentions.ts +47 -0
  17. package/src/api-client/types/econ.ts +4 -0
  18. package/src/app/keybindings/actions.ts +2 -2
  19. package/src/app/pane-runtime/ticker-open-runtime.ts +245 -66
  20. package/src/app.tsx +11 -1
  21. package/src/cli/command-options.ts +2 -1
  22. package/src/cli/commands/market.ts +188 -30
  23. package/src/cli/commands/news-search.ts +1 -3
  24. package/src/cli/commands/options-chain.ts +23 -6
  25. package/src/cli/commands/overview.ts +13 -5
  26. package/src/cli/commands/plugins.ts +76 -23
  27. package/src/cli/commands/search.ts +25 -6
  28. package/src/cli/commands/system.ts +19 -3
  29. package/src/cli/commands/ticker.ts +64 -21
  30. package/src/cli/fx-quote-rate.ts +49 -1
  31. package/src/cli/glossary.ts +95 -15
  32. package/src/cli/history-rows.ts +9 -25
  33. package/src/cli/index.ts +14 -46
  34. package/src/cli/known-gaps.ts +3 -3
  35. package/src/cli/listing-arg.ts +78 -18
  36. package/src/cli/name-entries.ts +3 -2
  37. package/src/cli/not-a-ticker.ts +6 -2
  38. package/src/cli/pane-functions/capabilities.ts +12 -1
  39. package/src/cli/pane-functions/function-help.ts +26 -14
  40. package/src/cli/pane-functions/headless.ts +3 -1
  41. package/src/cli/pane-functions/index.ts +32 -4
  42. package/src/cli/pane-functions/market-session.ts +8 -3
  43. package/src/cli/pane-functions/resolver.ts +18 -11
  44. package/src/cli/pane-functions/screenshot-payload.ts +36 -6
  45. package/src/cli/pane-functions/screenshot-render.ts +4 -0
  46. package/src/cli/quote-answer.ts +10 -0
  47. package/src/cli/report-tables.ts +40 -8
  48. package/src/cli/result.ts +21 -9
  49. package/src/cli/spreadsheet-hint.ts +43 -0
  50. package/src/cli/symbol-list.ts +58 -4
  51. package/src/cli/symbol-rows.ts +49 -2
  52. package/src/cli/ticker-resolution.ts +98 -5
  53. package/src/cli/types.ts +2 -0
  54. package/src/cli/unknown-command.ts +88 -0
  55. package/src/components/chart/composite/axis-overlays.tsx +22 -0
  56. package/src/components/chart/composite/composite-chart.tsx +54 -13
  57. package/src/components/chart/composite/event-captions.ts +109 -0
  58. package/src/components/chart/composite/event-guides.ts +74 -0
  59. package/src/components/chart/composite/rasterizer.ts +2 -0
  60. package/src/components/chart/composite/text-renderer.ts +2 -0
  61. package/src/components/chart/composite/types.ts +31 -0
  62. package/src/components/command-bar/assist/model.ts +6 -1
  63. package/src/components/command-bar/commands/direct/index.ts +9 -1
  64. package/src/components/command-bar/commands/registry.ts +18 -0
  65. package/src/components/command-bar/layout-items/focused-pane.ts +5 -5
  66. package/src/components/command-bar/pane-actions.ts +30 -13
  67. package/src/components/command-bar/panel/index.tsx +6 -3
  68. package/src/components/command-bar/panel/prompt-binding.ts +4 -0
  69. package/src/components/command-bar/panel/types.ts +3 -0
  70. package/src/components/command-bar/routes/header-market.ts +108 -0
  71. package/src/components/command-bar/routes/root/command-items.ts +5 -0
  72. package/src/components/command-bar/routes/root/provider-search.ts +192 -33
  73. package/src/components/command-bar/routes/root/results.ts +3 -0
  74. package/src/components/command-bar/routes/root/runtime.ts +28 -5
  75. package/src/components/command-bar/routes/ticker-search/results.ts +104 -6
  76. package/src/components/command-bar/routes/ticker-search/route.ts +3 -2
  77. package/src/components/command-bar/routing/list-state.ts +38 -0
  78. package/src/components/command-bar/selection-hint.ts +28 -0
  79. package/src/components/command-bar/surface/index.tsx +41 -3
  80. package/src/components/command-bar/view-model.ts +15 -0
  81. package/src/components/command-bar/workflow/tickers.ts +3 -2
  82. package/src/components/company-logo.tsx +20 -2
  83. package/src/components/data-table/export.ts +13 -8
  84. package/src/components/feedback-dialog.tsx +2 -1
  85. package/src/components/form-modal/field-row.tsx +2 -1
  86. package/src/components/input-search-bar.tsx +2 -2
  87. package/src/components/layout/detached-pane-shell.tsx +1 -1
  88. package/src/components/layout/double-escape-close.ts +8 -5
  89. package/src/components/layout/floating-pane.tsx +5 -1
  90. package/src/components/layout/header.tsx +75 -44
  91. package/src/components/layout/market-summary.ts +322 -116
  92. package/src/components/layout/pane/footer/index.tsx +44 -19
  93. package/src/components/layout/pane/footer/model.ts +52 -20
  94. package/src/components/layout/pane/header.tsx +3 -2
  95. package/src/components/layout/shell/action-menu-overlay.tsx +10 -5
  96. package/src/components/layout/shell/active-drag.ts +149 -105
  97. package/src/components/layout/shell/chrome.ts +15 -15
  98. package/src/components/layout/shell/drag/drop-zones.ts +162 -0
  99. package/src/components/layout/shell/drag/index.ts +47 -218
  100. package/src/components/layout/shell/drag/live.ts +10 -3
  101. package/src/components/layout/shell/drag/overlays.tsx +182 -5
  102. package/src/components/layout/shell/drag/runtime.ts +29 -6
  103. package/src/components/layout/shell/drag/shared-edges.ts +156 -0
  104. package/src/components/layout/shell/index.tsx +11 -6
  105. package/src/components/layout/shell/menu.ts +11 -2
  106. package/src/components/layout/shell/native/pointer-runtime.ts +25 -0
  107. package/src/components/layout/shell/native/window-state.ts +2 -2
  108. package/src/components/layout/shell/pane/layers.tsx +71 -7
  109. package/src/components/layout/shell/terminal-pointer-runtime.ts +18 -9
  110. package/src/components/layout/shell/window-mode/index.ts +8 -10
  111. package/src/components/layout/status-bar.tsx +8 -7
  112. package/src/components/layout/status-widget-space.ts +8 -0
  113. package/src/components/layout/window-edit/mode.ts +39 -7
  114. package/src/components/layout/window-edit/presentation.ts +1 -1
  115. package/src/components/markdown-editor.tsx +2 -2
  116. package/src/components/onboarding/account-step/form-panel.tsx +0 -3
  117. package/src/components/onboarding/onboarding-keyboard.ts +19 -6
  118. package/src/components/onboarding/onboarding-wizard.tsx +69 -14
  119. package/src/components/onboarding/portfolio-step/broker-fields-panel.tsx +0 -1
  120. package/src/components/onboarding/portfolio-step/positions-panel.tsx +0 -2
  121. package/src/components/price-sparkline/model.ts +26 -10
  122. package/src/components/ticker/list-table-view.tsx +29 -4
  123. package/src/components/ui/button.tsx +15 -2
  124. package/src/components/ui/choice-dialog.tsx +1 -0
  125. package/src/components/ui/column-grid.tsx +18 -9
  126. package/src/components/ui/data-table/index.tsx +5 -4
  127. package/src/components/ui/data-table/opentui/index.tsx +2 -1
  128. package/src/components/ui/data-table/types.ts +18 -0
  129. package/src/components/ui/delayed-mark.tsx +3 -2
  130. package/src/components/ui/field-grid.tsx +0 -2
  131. package/src/components/ui/fields.tsx +7 -4
  132. package/src/components/ui/inline-quick-add.tsx +2 -2
  133. package/src/components/ui/key-hint-words.ts +153 -0
  134. package/src/components/ui/key-hints.tsx +73 -0
  135. package/src/components/ui/list-view.tsx +7 -12
  136. package/src/components/ui/loading.tsx +10 -3
  137. package/src/components/ui/menu.tsx +9 -3
  138. package/src/components/ui/message-composer.tsx +2 -2
  139. package/src/components/ui/quote.ts +14 -1
  140. package/src/components/ui/shortcut-hint.tsx +28 -3
  141. package/src/components/ui/tabs.tsx +7 -0
  142. package/src/components/ui/text-prompt-dialog.tsx +2 -1
  143. package/src/core/state/app/command-bar-launch.ts +3 -0
  144. package/src/data/config/layout.ts +5 -2
  145. package/src/data/config/store/normalize.ts +6 -0
  146. package/src/docs/snapshot.json +149 -74
  147. package/src/i18n/es.ts +33 -9
  148. package/src/i18n/ja.ts +33 -9
  149. package/src/i18n/ko.ts +33 -9
  150. package/src/i18n/zh-cn.ts +33 -9
  151. package/src/i18n/zh-tw.ts +33 -9
  152. package/src/layout/pane-manager/floating-actions.ts +17 -0
  153. package/src/layout/pane-manager/floating-stack.ts +187 -0
  154. package/src/layout/pane-manager/floating.ts +4 -2
  155. package/src/layout/pane-manager/gridlock.ts +16 -1
  156. package/src/layout/pane-manager/index.ts +11 -0
  157. package/src/layout/pane-manager/layout-state.ts +10 -3
  158. package/src/market-data/bars-per-year.ts +27 -9
  159. package/src/market-data/coordinator/quotes.ts +22 -3
  160. package/src/market-data/futures-board.ts +126 -1
  161. package/src/market-data/futures-contract.ts +21 -6
  162. package/src/market-data/fx-interventions.ts +270 -0
  163. package/src/market-data/market/change-basis.ts +2 -2
  164. package/src/market-data/market/dated-previous-close.ts +163 -47
  165. package/src/market-data/market/format.ts +14 -3
  166. package/src/market-data/market/freshness.ts +24 -7
  167. package/src/market-data/market/header-market.ts +154 -0
  168. package/src/market-data/market/index-level.ts +29 -0
  169. package/src/market-data/market/index-session-venues.ts +44 -0
  170. package/src/market-data/market/status.ts +7 -2
  171. package/src/market-data/market/venue-session.ts +72 -0
  172. package/src/market-data/model-dividend-yield.ts +23 -8
  173. package/src/market-data/options-alternatives.ts +39 -4
  174. package/src/market-data/published-apac-sessions.ts +40 -2
  175. package/src/market-data/quotes/export-identity.ts +76 -0
  176. package/src/market-data/quotes/freshness.ts +22 -0
  177. package/src/market-data/quotes/time.ts +42 -1
  178. package/src/market-data/realized-volatility.ts +11 -7
  179. package/src/market-data/tax-equivalent.ts +145 -27
  180. package/src/news/news-model.ts +44 -2
  181. package/src/plugins/builtin/account-management/pane.tsx +2 -2
  182. package/src/plugins/builtin/alerts/alert-engine.ts +12 -6
  183. package/src/plugins/builtin/alerts/alert-log.ts +6 -2
  184. package/src/plugins/builtin/alerts/calendar-events.ts +74 -12
  185. package/src/plugins/builtin/alerts/cli-forms.ts +11 -1
  186. package/src/plugins/builtin/alerts/cli-move.ts +234 -0
  187. package/src/plugins/builtin/alerts/cli.ts +223 -32
  188. package/src/plugins/builtin/alerts/command.ts +33 -6
  189. package/src/plugins/builtin/alerts/event-rows.ts +18 -4
  190. package/src/plugins/builtin/alerts/events-pane.tsx +6 -2
  191. package/src/plugins/builtin/alerts/events.ts +9 -0
  192. package/src/plugins/builtin/alerts/format.ts +39 -15
  193. package/src/plugins/builtin/alerts/headless.ts +30 -18
  194. package/src/plugins/builtin/alerts/history.ts +1 -0
  195. package/src/plugins/builtin/alerts/index.tsx +86 -12
  196. package/src/plugins/builtin/alerts/live.ts +2 -1
  197. package/src/plugins/builtin/alerts/move-checks.ts +161 -0
  198. package/src/plugins/builtin/alerts/move.ts +181 -0
  199. package/src/plugins/builtin/alerts/pane.tsx +50 -22
  200. package/src/plugins/builtin/alerts/price-text.ts +62 -0
  201. package/src/plugins/builtin/alerts/price.ts +17 -0
  202. package/src/plugins/builtin/alerts/quotes.ts +84 -3
  203. package/src/plugins/builtin/alerts/scheduled-check.ts +7 -1
  204. package/src/plugins/builtin/alerts/storage.ts +22 -7
  205. package/src/plugins/builtin/alerts/types.ts +25 -0
  206. package/src/plugins/builtin/analytics/risk-client.ts +60 -39
  207. package/src/plugins/builtin/analytics/risk-episodes.ts +18 -0
  208. package/src/plugins/builtin/analytics/risk-headless.ts +20 -4
  209. package/src/plugins/builtin/analytics/risk-model.ts +68 -1
  210. package/src/plugins/builtin/analytics/risk-pane.tsx +15 -3
  211. package/src/plugins/builtin/backtest/engine.ts +4 -2
  212. package/src/plugins/builtin/backtest/window.ts +3 -1
  213. package/src/plugins/builtin/broker-manager/sign-in-end.ts +1 -1
  214. package/src/plugins/builtin/central-bank-rates/client.ts +4 -0
  215. package/src/plugins/builtin/central-bank-rates/headless.ts +1 -1
  216. package/src/plugins/builtin/central-bank-rates/model.ts +18 -8
  217. package/src/plugins/builtin/central-bank-rates/pane.tsx +6 -3
  218. package/src/plugins/builtin/changelog/index.tsx +292 -101
  219. package/src/plugins/builtin/changelog/versions.ts +293 -0
  220. package/src/plugins/builtin/chart-composer/cli-options.ts +5 -0
  221. package/src/plugins/builtin/chart-composer/headless-schema.ts +17 -1
  222. package/src/plugins/builtin/chart-composer/headless.ts +2 -0
  223. package/src/plugins/builtin/chart-composer/intervention-events.ts +105 -0
  224. package/src/plugins/builtin/chart-composer/pane.tsx +21 -7
  225. package/src/plugins/builtin/chat/message/render-state.ts +2 -5
  226. package/src/plugins/builtin/cloud/askg/attached-pane.tsx +10 -5
  227. package/src/plugins/builtin/cloud/askg/controller.ts +141 -5
  228. package/src/plugins/builtin/cloud/askg/executor.ts +113 -4
  229. package/src/plugins/builtin/cloud/askg/manifest.ts +28 -13
  230. package/src/plugins/builtin/cloud/askg/model.ts +14 -4
  231. package/src/plugins/builtin/cloud/askg/pane.tsx +70 -46
  232. package/src/plugins/builtin/cloud/askg/turn-parts.tsx +70 -0
  233. package/src/plugins/builtin/cloud/terminal-relay/engine.ts +50 -130
  234. package/src/plugins/builtin/cloud/terminal-relay/policy.ts +327 -7
  235. package/src/plugins/builtin/cloud/terminal-relay/prompts.tsx +2 -1
  236. package/src/plugins/builtin/cloud/terminal-relay/redact.ts +47 -6
  237. package/src/plugins/builtin/cloud/upgrade-status-widget.tsx +9 -2
  238. package/src/plugins/builtin/commodities-energy/index.tsx +1 -3
  239. package/src/plugins/builtin/commodities-energy/view-state.ts +3 -0
  240. package/src/plugins/builtin/cot/headless.ts +14 -2
  241. package/src/plugins/builtin/crypto-board/headless.ts +82 -17
  242. package/src/plugins/builtin/crypto-board/index.tsx +24 -2
  243. package/src/plugins/builtin/crypto-board/model.ts +5 -2
  244. package/src/plugins/builtin/crypto-board/pane.tsx +4 -1
  245. package/src/plugins/builtin/debt-maturities/client.ts +111 -6
  246. package/src/plugins/builtin/debt-maturities/headless.ts +84 -1
  247. package/src/plugins/builtin/debt-maturities/model.ts +97 -14
  248. package/src/plugins/builtin/debt-maturities/pane.tsx +165 -15
  249. package/src/plugins/builtin/debt-maturities/series.ts +3 -1
  250. package/src/plugins/builtin/dividend-yield/client.ts +22 -6
  251. package/src/plugins/builtin/dividend-yield/headless.ts +113 -46
  252. package/src/plugins/builtin/dividend-yield/model.ts +5 -2
  253. package/src/plugins/builtin/dividend-yield/pane.tsx +6 -3
  254. package/src/plugins/builtin/dividend-yield/ranking-reads.ts +11 -4
  255. package/src/plugins/builtin/dividend-yield/ranking.ts +113 -18
  256. package/src/plugins/builtin/dividend-yield/types.ts +2 -0
  257. package/src/plugins/builtin/dividend-yield/view.ts +3 -0
  258. package/src/plugins/builtin/earnings/index.tsx +2 -2
  259. package/src/plugins/builtin/econ/calendar-model.ts +21 -3
  260. package/src/plugins/builtin/econ/detail-view.tsx +5 -3
  261. package/src/plugins/builtin/econ/figures.ts +13 -0
  262. package/src/plugins/builtin/econ/fred-catalog.ts +6 -3
  263. package/src/plugins/builtin/econ/index.tsx +5 -3
  264. package/src/plugins/builtin/econ/types.ts +5 -0
  265. package/src/plugins/builtin/equity-screener/footer.ts +45 -0
  266. package/src/plugins/builtin/equity-screener/pane.tsx +4 -18
  267. package/src/plugins/builtin/equity-screener/ticker-check.tsx +2 -1
  268. package/src/plugins/builtin/fixed-income/model.ts +1 -0
  269. package/src/plugins/builtin/futures/index.tsx +25 -4
  270. package/src/plugins/builtin/futures/model.ts +28 -32
  271. package/src/plugins/builtin/futures/series.ts +4 -3
  272. package/src/plugins/builtin/futures/table.tsx +17 -10
  273. package/src/plugins/builtin/futures/use-board-terms.ts +3 -3
  274. package/src/plugins/builtin/futures-curve/model.ts +3 -10
  275. package/src/plugins/builtin/help/function-card.tsx +2 -1
  276. package/src/plugins/builtin/help/function-index.ts +1 -0
  277. package/src/plugins/builtin/help/index.tsx +3 -3
  278. package/src/plugins/builtin/help/keybindings-editor.tsx +18 -4
  279. package/src/plugins/builtin/insider/client.ts +31 -14
  280. package/src/plugins/builtin/insider/signals-model.ts +2 -7
  281. package/src/plugins/builtin/iv-history/headless.ts +1 -2
  282. package/src/plugins/builtin/iv-history/model.ts +33 -23
  283. package/src/plugins/builtin/iv-history/screen-pane.tsx +0 -3
  284. package/src/plugins/builtin/kelly-sizer/headless.ts +64 -16
  285. package/src/plugins/builtin/kelly-sizer/history.ts +37 -28
  286. package/src/plugins/builtin/kelly-sizer/pane.tsx +43 -10
  287. package/src/plugins/builtin/kelly-sizer/sections.tsx +7 -2
  288. package/src/plugins/builtin/kelly-sizer/units.ts +29 -0
  289. package/src/plugins/builtin/layout-manager/index.tsx +8 -8
  290. package/src/plugins/builtin/news/headless.ts +2 -2
  291. package/src/plugins/builtin/news/index.tsx +10 -16
  292. package/src/plugins/builtin/news/overview-headlines.tsx +117 -0
  293. package/src/plugins/builtin/news/ticker-news.ts +35 -0
  294. package/src/plugins/builtin/news/wire/news/detail-view.tsx +8 -6
  295. package/src/plugins/builtin/news/wire/news/row.ts +49 -0
  296. package/src/plugins/builtin/news/wire/news/table.tsx +9 -20
  297. package/src/plugins/builtin/options/analytics.ts +7 -2
  298. package/src/plugins/builtin/options/live-quotes.ts +6 -1
  299. package/src/plugins/builtin/options/table.ts +3 -2
  300. package/src/plugins/builtin/options/view.tsx +11 -9
  301. package/src/plugins/builtin/options-scenario/client.ts +3 -0
  302. package/src/plugins/builtin/options-scenario/headless.ts +1 -1
  303. package/src/plugins/builtin/perps/client.ts +5 -4
  304. package/src/plugins/builtin/perps/headless.ts +134 -124
  305. package/src/plugins/builtin/perps/markets-section.tsx +7 -4
  306. package/src/plugins/builtin/perps/model.ts +8 -4
  307. package/src/plugins/builtin/perps/open-market.ts +4 -4
  308. package/src/plugins/builtin/perps/venue-markets.ts +3 -6
  309. package/src/plugins/builtin/plugin-marketplace/pane.tsx +11 -11
  310. package/src/plugins/builtin/portfolio-list/cell-version.ts +1 -0
  311. package/src/plugins/builtin/portfolio-list/cli/bulk-symbols.ts +34 -10
  312. package/src/plugins/builtin/portfolio-list/cli/period-report.ts +28 -2
  313. package/src/plugins/builtin/portfolio-list/cli/portfolio-command.ts +7 -3
  314. package/src/plugins/builtin/portfolio-list/cli/render.ts +66 -22
  315. package/src/plugins/builtin/portfolio-list/grid.tsx +5 -3
  316. package/src/plugins/builtin/portfolio-list/pane/data.ts +34 -1
  317. package/src/plugins/builtin/portfolio-list/pane/index.tsx +6 -0
  318. package/src/plugins/builtin/portfolio-list/pane/streaming.ts +15 -6
  319. package/src/plugins/builtin/portfolio-list/quick-add/resolution.ts +19 -7
  320. package/src/plugins/builtin/portfolio-list/summary/index.tsx +3 -1
  321. package/src/plugins/builtin/portfolio-list/table.tsx +30 -4
  322. package/src/plugins/builtin/realized-vol/evidence.ts +33 -6
  323. package/src/plugins/builtin/realized-vol/fx-proxy.ts +135 -0
  324. package/src/plugins/builtin/realized-vol/headless.ts +44 -8
  325. package/src/plugins/builtin/realized-vol/model.ts +9 -5
  326. package/src/plugins/builtin/realized-vol/pane.tsx +49 -15
  327. package/src/plugins/builtin/research/event-model.ts +9 -1
  328. package/src/plugins/builtin/research/event-sources.ts +22 -0
  329. package/src/plugins/builtin/research/headless.ts +3 -3
  330. package/src/plugins/builtin/sec/headless.ts +48 -6
  331. package/src/plugins/builtin/sec/index.tsx +6 -4
  332. package/src/plugins/builtin/sec/model.ts +4 -1
  333. package/src/plugins/builtin/shared/cloud-upgrade.ts +27 -3
  334. package/src/plugins/builtin/shared/earnings-calendar.ts +2 -0
  335. package/src/plugins/builtin/shared/market-cap-bands.ts +12 -0
  336. package/src/plugins/builtin/shared/report-freshness.ts +3 -1
  337. package/src/plugins/builtin/shared/use-quote-board.ts +5 -3
  338. package/src/plugins/builtin/shared/volatility/options.ts +63 -2
  339. package/src/plugins/builtin/social-mentions/headless.ts +72 -3
  340. package/src/plugins/builtin/social-mentions/index.tsx +8 -4
  341. package/src/plugins/builtin/social-mentions/lock-note.ts +6 -2
  342. package/src/plugins/builtin/social-mentions/outliers-client.ts +101 -0
  343. package/src/plugins/builtin/social-mentions/outliers-model.ts +162 -0
  344. package/src/plugins/builtin/social-mentions/outliers-names.ts +51 -0
  345. package/src/plugins/builtin/social-mentions/outliers.tsx +276 -0
  346. package/src/plugins/builtin/social-mentions/pane.tsx +32 -3
  347. package/src/plugins/builtin/supply-chain/graph-pane.tsx +2 -2
  348. package/src/plugins/builtin/thirteenf/api.ts +36 -2
  349. package/src/plugins/builtin/thirteenf/data.ts +4 -1
  350. package/src/plugins/builtin/thirteenf/headless.ts +14 -6
  351. package/src/plugins/builtin/thirteenf/model.ts +56 -1
  352. package/src/plugins/builtin/thirteenf/pane.tsx +8 -8
  353. package/src/plugins/builtin/thirteenf/report-notes.ts +11 -0
  354. package/src/plugins/builtin/thirteenf/table.ts +2 -1
  355. package/src/plugins/builtin/thirteenf/types.ts +6 -0
  356. package/src/plugins/builtin/ticker-detail/data-panes/historical-prices.tsx +23 -3
  357. package/src/plugins/builtin/ticker-detail/financials/model.ts +5 -0
  358. package/src/plugins/builtin/ticker-detail/headless-schema.ts +2 -1
  359. package/src/plugins/builtin/ticker-detail/headless.ts +21 -66
  360. package/src/plugins/builtin/ticker-detail/index.tsx +5 -0
  361. package/src/plugins/builtin/ticker-detail/overview/components.tsx +67 -6
  362. package/src/plugins/builtin/ticker-detail/overview/model.ts +6 -4
  363. package/src/plugins/builtin/ticker-detail/overview/pane.tsx +15 -0
  364. package/src/plugins/builtin/ticker-detail/overview/tax-equivalent.ts +69 -0
  365. package/src/plugins/builtin/ticker-detail/overview-tab.tsx +69 -19
  366. package/src/plugins/builtin/ticker-detail/pane.tsx +7 -2
  367. package/src/plugins/builtin/ticker-detail/quote-monitor/card.tsx +47 -24
  368. package/src/plugins/builtin/ticker-detail/quote-monitor/export.ts +46 -0
  369. package/src/plugins/builtin/ticker-detail/quote-monitor/index.tsx +20 -1
  370. package/src/plugins/builtin/ticker-detail/quote-monitor/rows.ts +120 -0
  371. package/src/plugins/builtin/ticker-detail/research-tabs.ts +1 -5
  372. package/src/plugins/builtin/ticker-detail/settings.ts +6 -6
  373. package/src/plugins/builtin/treasury-auctions/cache.ts +85 -19
  374. package/src/plugins/builtin/treasury-auctions/index.tsx +22 -11
  375. package/src/plugins/builtin/treasury-auctions/model.ts +23 -0
  376. package/src/plugins/builtin/treasury-auctions/treasury-direct.ts +128 -0
  377. package/src/plugins/builtin/world-indices/client.ts +2 -0
  378. package/src/plugins/compat.ts +15 -0
  379. package/src/plugins/host-link.ts +6 -1
  380. package/src/plugins/installer.ts +53 -3
  381. package/src/portfolio/column-values.ts +14 -4
  382. package/src/portfolio/listed-symbol.ts +78 -0
  383. package/src/portfolio/real-return.ts +172 -0
  384. package/src/public/__snapshots__/public-api.test.ts.snap +1 -0
  385. package/src/remote/resources.ts +12 -1
  386. package/src/remote/schema.ts +1 -0
  387. package/src/remote/semantic-helpers.ts +29 -1
  388. package/src/remote/semantic-tree.tsx +32 -15
  389. package/src/renderers/browser/config-host.ts +56 -15
  390. package/src/renderers/browser/main.tsx +3 -1
  391. package/src/renderers/browser/ui-host.tsx +1 -0
  392. package/src/renderers/cloudflare/http-proxy.ts +1 -0
  393. package/src/renderers/cloudflare/worker.ts +16 -1
  394. package/src/renderers/dom/boot-frame.ts +2 -2
  395. package/src/renderers/dom/data-table/row.tsx +4 -1
  396. package/src/renderers/dom/desktop/controls.tsx +4 -4
  397. package/src/renderers/dom/desktop/dialog-actions.tsx +60 -41
  398. package/src/renderers/dom/dom-ui-host.tsx +3 -1
  399. package/src/renderers/dom/host/input.tsx +4 -1
  400. package/src/renderers/dom/host/tabs.tsx +10 -1
  401. package/src/renderers/dom/styles.css +73 -19
  402. package/src/renderers/electrobun/bun/desktop/app-name.ts +1 -1
  403. package/src/renderers/opentui/host.tsx +2 -1
  404. package/src/renderers/share/layout-view.tsx +1 -1
  405. package/src/sources/gloomberb-cloud/fred-series.ts +12 -0
  406. package/src/sources/gloomberb-cloud/index.ts +31 -2
  407. package/src/sources/gloomberb-cloud/news.ts +35 -12
  408. package/src/sources/gloomberb-cloud/normalizers.ts +29 -3
  409. package/src/sources/provider-router/cached-routes.ts +19 -7
  410. package/src/state/opening-ticker-panes.ts +47 -0
  411. package/src/state/pane-table-export-registry.ts +19 -6
  412. package/src/test-support/cli-context.ts +2 -0
  413. package/src/test-support/preload.ts +8 -1
  414. package/src/theme/colors.ts +9 -1
  415. package/src/theme/themes.ts +62 -15
  416. package/src/theme/tone-contrast.ts +40 -0
  417. package/src/theme/ui-tokens.ts +23 -3
  418. package/src/tickers/batched-lookups.ts +57 -8
  419. package/src/tickers/company-name-listing.ts +156 -14
  420. package/src/tickers/company-name.ts +30 -6
  421. package/src/tickers/instrument-kind.ts +23 -3
  422. package/src/tickers/list.ts +7 -0
  423. package/src/tickers/search/home-listing.ts +31 -9
  424. package/src/tickers/search/index.ts +13 -3
  425. package/src/tickers/search/listing-index.ts +558 -0
  426. package/src/tickers/search/major-listings.chunk.ts +10 -0
  427. package/src/tickers/search/major-listings.json +3346 -0
  428. package/src/tickers/search/ranking.ts +68 -1
  429. package/src/tickers/search/types.ts +4 -0
  430. package/src/tickers/terminal-codes.ts +26 -1
  431. package/src/time-series/calendar-month-returns.ts +47 -0
  432. package/src/time-series/currency-conversion.ts +130 -0
  433. package/src/time-series/hooks.ts +2 -0
  434. package/src/time-series/price-comparison.ts +34 -11
  435. package/src/time-series/resolve-context.ts +3 -0
  436. package/src/time-series/resolve.ts +14 -2
  437. package/src/time-series/spec.ts +1 -0
  438. package/src/time-series/studies/indicators.ts +4 -1
  439. package/src/time-series/types.ts +8 -0
  440. package/src/types/config.ts +13 -0
  441. package/src/types/context-menu.ts +2 -0
  442. package/src/types/data-provider.ts +28 -0
  443. package/src/types/financials.ts +20 -2
  444. package/src/types/headless.ts +12 -0
  445. package/src/types/plugin-commands.ts +140 -0
  446. package/src/types/plugin-context.ts +125 -0
  447. package/src/types/plugin-contributions.ts +55 -0
  448. package/src/types/plugin-definition.ts +234 -0
  449. package/src/types/plugin-notifications.ts +38 -0
  450. package/src/types/plugin-pane-settings.ts +114 -0
  451. package/src/types/plugin-pane-templates.ts +160 -0
  452. package/src/types/plugin-panes.ts +221 -0
  453. package/src/types/plugin-reports.ts +35 -0
  454. package/src/types/plugin-shared.ts +14 -0
  455. package/src/types/plugin-state.ts +71 -0
  456. package/src/types/plugin.ts +14 -1169
  457. package/src/ui/host.tsx +8 -0
  458. package/src/ui/index.tsx +14 -3
  459. package/src/updater/github-releases.ts +23 -0
  460. package/src/utils/cli-output.ts +22 -9
  461. package/src/utils/datetime-format.ts +17 -3
  462. package/src/utils/display-number.ts +15 -0
  463. package/src/utils/double-escape-close.ts +61 -16
  464. package/src/utils/float32-price.ts +24 -0
  465. package/src/utils/forward-dividend.ts +81 -16
  466. package/src/utils/fx-market-hours.ts +11 -0
  467. package/src/utils/plugin-proxy-hosts.json +2 -1
  468. package/src/utils/price-history.ts +7 -6
  469. package/src/utils/report-timing.ts +62 -0
  470. package/src/utils/sec-filings.ts +32 -0
  471. package/src/utils/utc-time.ts +5 -0
@@ -1,7 +1,7 @@
1
1
  // Published full-day closures (weekend dates omitted) for Asia-Pacific venues, EGX and Wiener
2
2
  // Boerse, not a holiday-rule engine. A year a venue has not published is unknown, not
3
- // open: every weekday of it reads as a session. Half-day sessions (HKEX and
4
- // SGX eves, ASX's 14:10 closes) are not modelled. Checked 2026-10-09:
3
+ // open: every weekday of it reads as a session. The half-day sessions of HKEX, SGX and
4
+ // ASX are listed below the closures (PUBLISHED_APAC_EARLY_CLOSES). Checked 2026-10-09:
5
5
  // KRX, also KOSDAQ: http://open.krx.co.kr/contents/MKD/01/0110/01100305/MKD01100305.jsp
6
6
  // TWSE, whose closures TPEx shares: https://www.twse.com.tw/en/trading/holiday.html
7
7
  // (2027 not yet published; 12 and 13 Feb 2026 are clearing-only days without trading)
@@ -93,6 +93,44 @@ export const PUBLISHED_APAC_CLOSURES: Readonly<Record<string, Record<number, rea
93
93
  },
94
94
  };
95
95
 
96
+ const HKEX_HALF_DAY_CLOSE = 12 * 60 + 10;
97
+ const SGX_HALF_DAY_CLOSE = 12 * 60 + 20;
98
+ const ASX_EARLY_CLOSE = 14 * 60 + 15;
99
+
100
+ /**
101
+ * Half-day sessions, as the local close with the closing auction rounded up
102
+ * the way freshness.ts lists regular closes (a weekend eve has none):
103
+ * - HKEX trades its morning session only on the eves of Lunar New Year,
104
+ * Christmas and New Year, its closing auction ending by 12:10 (the circulars
105
+ * above, and hkex.com.hk Trading Hours, Securities Market).
106
+ * - SGX trades to 12:00 on the same eves, its closing routine and trade at
107
+ * close ending 12:16 (sgx.com/stock-exchange/trading; 2027 by that rule from
108
+ * the MOM holidays above).
109
+ * - ASX closes at 14:10 with its closing auction on the last business day
110
+ * before Christmas and the last of the year (ASX Notice 1245.26, Oct 2026,
111
+ * and the trading calendar above).
112
+ */
113
+ const PUBLISHED_APAC_EARLY_CLOSES: Readonly<Record<string, Record<number, Readonly<Record<string, number>>>>> = {
114
+ HKEX: {
115
+ 2026: { "02-16": HKEX_HALF_DAY_CLOSE, "12-24": HKEX_HALF_DAY_CLOSE, "12-31": HKEX_HALF_DAY_CLOSE },
116
+ 2027: { "02-05": HKEX_HALF_DAY_CLOSE, "12-24": HKEX_HALF_DAY_CLOSE, "12-31": HKEX_HALF_DAY_CLOSE },
117
+ },
118
+ SGX: {
119
+ 2026: { "02-16": SGX_HALF_DAY_CLOSE, "12-24": SGX_HALF_DAY_CLOSE, "12-31": SGX_HALF_DAY_CLOSE },
120
+ 2027: { "02-05": SGX_HALF_DAY_CLOSE, "12-24": SGX_HALF_DAY_CLOSE, "12-31": SGX_HALF_DAY_CLOSE },
121
+ },
122
+ ASX: {
123
+ 2026: { "12-24": ASX_EARLY_CLOSE, "12-31": ASX_EARLY_CLOSE },
124
+ 2027: { "12-24": ASX_EARLY_CLOSE, "12-31": ASX_EARLY_CLOSE },
125
+ },
126
+ };
127
+
128
+ /** The local close, in minutes of the day, of a published half-day session on `date`; undefined on any other day. */
129
+ export function publishedApacEarlyClose(exchange: string, date: string): number | undefined {
130
+ if (!Object.hasOwn(PUBLISHED_APAC_EARLY_CLOSES, exchange)) return undefined;
131
+ return PUBLISHED_APAC_EARLY_CLOSES[exchange]![Number(date.slice(0, 4))]?.[date.slice(5)];
132
+ }
133
+
96
134
  /** True only for a published full-day closure; unpublished years are unknown, not open. */
97
135
  export function isPublishedApacClosure(exchange: string, date: string): boolean {
98
136
  if (!Object.hasOwn(PUBLISHED_APAC_CLOSURES, exchange)) return false;
@@ -0,0 +1,76 @@
1
+ import type { Quote } from "../../types/financials";
2
+ import { isYieldIndexSymbol } from "../../tickers/index-roots";
3
+ import { currencyPairCode } from "../../utils/currency-pair";
4
+ import { parsePublicTickerKey } from "../../utils/exchanges";
5
+ import { INDEX_POINTS_EXPORT_UNIT, isIndexLevel, YIELD_INDEX_EXPORT_UNIT } from "../market/index-level";
6
+ import { quoteHeadlineTime, quoteSessionStateLabel } from "../market/status";
7
+ import { isQuoteStaleForCurrentSession } from "./freshness";
8
+
9
+ /** The quotes Gloom Cloud serves, which an export cites by that name. */
10
+ const CLOUD_PROVIDER_ID = "gloomberb-cloud";
11
+ const CLOUD_SOURCE = "Gloom Cloud";
12
+
13
+ /**
14
+ * The columns a pane's quote export ends each row with, as `quote --csv` does:
15
+ * the session and feed its figures are from, why a figure is missing, then
16
+ * what the row is (its listing with the venue, the unit its prices are in),
17
+ * where it comes from and when its price was observed.
18
+ */
19
+ export const QUOTE_EXPORT_IDENTITY_HEADERS = [
20
+ "Session", "Feed", "status", "symbol_or_series", "currency_or_unit", "interval", "source", "as_of",
21
+ ] as const;
22
+
23
+ /**
24
+ * The unit a quote's price is in, as `quote --csv` names it: index points for
25
+ * an index level, pct for a Cboe yield index, a pair's quote currency per base
26
+ * (JPY per USD), else its currency.
27
+ */
28
+ export function quoteExportUnit(symbol: string, quote: Pick<Quote, "currency" | "instrumentType"> | null | undefined): string | null {
29
+ const bare = parsePublicTickerKey(symbol).symbol;
30
+ if (isYieldIndexSymbol(bare)) return YIELD_INDEX_EXPORT_UNIT;
31
+ if (isIndexLevel(quote?.instrumentType)) return INDEX_POINTS_EXPORT_UNIT;
32
+ const currency = quote?.currency?.trim() || null;
33
+ const pair = currencyPairCode(bare.toUpperCase());
34
+ if (pair && currency === pair.slice(3)) return `${pair.slice(3)} per ${pair.slice(0, 3)}`;
35
+ return currency;
36
+ }
37
+
38
+ /** A broker's name by the id its quotes carry (`ibkr`: Interactive Brokers); null for no broker of that id. */
39
+ export type BrokerNameOf = (providerId: string) => string | null | undefined;
40
+
41
+ /**
42
+ * Where a quote is from, as an export's `source` names it: Gloom Cloud, or
43
+ * the broker whose feed it is, by its name. Blank for a source with no name
44
+ * to give, never its internal id.
45
+ */
46
+ export function quoteSourceName(quote: Pick<Quote, "providerId"> | null | undefined, brokerName?: BrokerNameOf): string {
47
+ if (!quote) return "";
48
+ if (!quote.providerId || quote.providerId === CLOUD_PROVIDER_ID) return CLOUD_SOURCE;
49
+ return brokerName?.(quote.providerId)?.trim() || "";
50
+ }
51
+
52
+ /** Whether a quote's feed is live, delayed or stale, as the Feed cell of `quote` says it. */
53
+ export function quoteExportFeed(quote: Quote | null | undefined, now = Date.now()): string {
54
+ if (!quote) return "";
55
+ if (isQuoteStaleForCurrentSession(quote, now)) return "stale";
56
+ return quote.dataSource === "live" || quote.dataSource === "delayed" ? quote.dataSource : "";
57
+ }
58
+
59
+ /**
60
+ * The cells `QUOTE_EXPORT_IDENTITY_HEADERS` name for one row: `listing` is the
61
+ * row's listing with its venue (BA:LSE), the as-of the ISO instant its Last
62
+ * was observed (each row its own: Hong Kong's close beside New York's).
63
+ */
64
+ export function quoteExportIdentityCells(listing: string, quote: Quote | null | undefined, now = Date.now(), brokerName?: BrokerNameOf): string[] {
65
+ const asOf = quote?.lastUpdated ? new Date(quoteHeadlineTime(quote)).toISOString() : "";
66
+ return [
67
+ quote ? quoteSessionStateLabel(quote, now) ?? "" : "",
68
+ quoteExportFeed(quote, now),
69
+ quote ? "" : "Last: no quote",
70
+ listing,
71
+ quoteExportUnit(listing, quote) ?? "",
72
+ "",
73
+ quoteSourceName(quote, brokerName),
74
+ asOf,
75
+ ];
76
+ }
@@ -5,6 +5,7 @@ import { getPublishedUsEquitySession } from "../published-us-sessions";
5
5
  import { quoteFutureToleranceMs } from "./clock";
6
6
  import {
7
7
  activeUsExtendedHoursSession,
8
+ delayedFeedLagMs,
8
9
  isAlwaysOpenExchange,
9
10
  isRegularSessionTime,
10
11
  isTimestampStaleForExchangeSession,
@@ -152,6 +153,27 @@ export function noPrintsTodaySince(quote: Quote | null | undefined, now = Date.n
152
153
  return open != null && printed < open ? printed : null;
153
154
  }
154
155
 
156
+ /** How long past a venue's open its delayed feed's first print may take, beyond the feed's own lag. */
157
+ const FIRST_DELAYED_PRINT_GRACE_MS = 5 * 60_000;
158
+
159
+ /**
160
+ * A venue abroad whose regular session has opened by its calendar while its
161
+ * delayed feed has not printed in it yet (LSE at 08:09 on a feed 15 minutes
162
+ * behind): the session is open, and the last price is the previous close
163
+ * until the first delayed print, due about `expected`. Null outside that
164
+ * wait, for a US listing (whose pre-market the service names) and for a
165
+ * quote that printed today.
166
+ */
167
+ export function awaitingFirstDelayedPrint(quote: Quote | null | undefined, now = Date.now()): { open: number; expected: number } | null {
168
+ if (!quote || quote.delisting || !Number.isFinite(quote.lastUpdated)) return null;
169
+ const venue = canonicalExchange(quote.listingExchangeName || quote.exchangeName);
170
+ if (!venue || isUsListingExchange(venue) || isRegularSessionTime(venue, now) !== true) return null;
171
+ const open = latestRegularSessionOpen(venue, now);
172
+ if (open == null || quote.lastUpdated >= open) return null;
173
+ const expected = open + delayedFeedLagMs(venue);
174
+ return now <= expected + FIRST_DELAYED_PRINT_GRACE_MS ? { open, expected } : null;
175
+ }
176
+
155
177
  /** `no prints today since Thu 22 Oct 05:30 UTC (20h 50m old)`, or null as noPrintsTodaySince. */
156
178
  export function noPrintsTodayText(quote: Quote | null | undefined, now = Date.now()): string | null {
157
179
  const since = noPrintsTodaySince(quote, now);
@@ -1,6 +1,10 @@
1
1
  import type { Quote } from "../../types/financials";
2
2
  import { getLanguage, tf } from "../../i18n";
3
- import { dailyNavDate } from "./freshness";
3
+ import { isPerpetualExchange } from "../../tickers/perpetual-listing";
4
+ import { formatUtcDayTime, formatUtcWeekdayTime } from "../../utils/utc-time";
5
+ import { delayedFeedLagMs } from "../market/freshness";
6
+ import { quoteHeadlineTime, quoteSessionStateLabel } from "../market/status";
7
+ import { dailyNavDate, isQuoteStaleForCurrentSession } from "./freshness";
4
8
 
5
9
  /** The published NAV session date, independent of local time and receipt time. */
6
10
  export function formatQuoteNavAsOf(quote: Quote | null | undefined, now = Date.now()): string | null {
@@ -16,6 +20,43 @@ export function formatQuoteNavAsOf(quote: Quote | null | undefined, now = Date.n
16
20
  return tf("NAV · as of {date}", { date: dateText });
17
21
  }
18
22
 
23
+ const CLOUD_PROVIDER_ID = "gloomberb-cloud";
24
+ const WEEK_MS = 7 * 86_400_000;
25
+
26
+ /** How current a quote's feed is: `15 min delayed` (Gloom Cloud knows each venue's lag), `delayed`, `real-time`. */
27
+ function quoteFeedWord(quote: Quote): string | null {
28
+ if (quote.dataSource === "live") return "real-time";
29
+ if (quote.dataSource !== "delayed") return null;
30
+ const exchange = quote.listingExchangeName || quote.exchangeName;
31
+ // A perpetual's venue is read about once a minute, not held back by a feed lag.
32
+ if (quote.providerId !== CLOUD_PROVIDER_ID || isPerpetualExchange(exchange)) return "delayed";
33
+ return `${Math.round(delayedFeedLagMs(exchange) / 60_000)} min delayed`;
34
+ }
35
+
36
+ /** `08:09 UTC` on today's UTC date, `Thu 08:09 UTC` within the week, `Thu 29 Oct 08:09 UTC` before it. */
37
+ function asOfClock(time: number, now: number): string {
38
+ const iso = new Date(time).toISOString();
39
+ if (iso.slice(0, 10) === new Date(now).toISOString().slice(0, 10)) return `${iso.slice(11, 16)} UTC`;
40
+ return `${now - time < WEEK_MS ? formatUtcWeekdayTime(time) : formatUtcDayTime({ time, dateOnly: false }, now)} UTC`;
41
+ }
42
+
43
+ /**
44
+ * What a quote card's price is as of: CLOSED while its market is, else how
45
+ * current its feed is, and when the price was observed (quoteHeadlineTime,
46
+ * as an export's as_of dates it): `CLOSED · 08:09 UTC` for Hong Kong's close
47
+ * beside `15 min delayed · 21:20 UTC` for New York's after hours. Null for a
48
+ * fund priced by its NAV (formatQuoteNavAsOf dates it), a listing that no
49
+ * longer trades and a quote stale for its session, whose own status says so.
50
+ */
51
+ export function formatQuoteSessionAsOf(quote: Quote | null | undefined, now = Date.now()): string | null {
52
+ if (!quote || quote.delisting || !(quote.lastUpdated > 0) || dailyNavDate(quote, now)) return null;
53
+ if (isQuoteStaleForCurrentSession(quote, now)) return null;
54
+ const session = quoteSessionStateLabel(quote, now);
55
+ const state = session === "CLOSED" ? session : quoteFeedWord(quote) ?? session;
56
+ const clock = asOfClock(Math.min(quoteHeadlineTime(quote), now), now);
57
+ return state ? `${state} · ${clock}` : clock;
58
+ }
59
+
19
60
  function clampQuoteTimestamp(lastUpdated: number | undefined, now = Date.now()): number | null {
20
61
  if (typeof lastUpdated !== "number" || !Number.isFinite(lastUpdated) || lastUpdated <= 0) {
21
62
  return null;
@@ -1,5 +1,5 @@
1
1
  import type { PricePoint } from "../types/financials";
2
- import { barsPerYear } from "./bars-per-year";
2
+ import { barsPerYear, type BarsPerYearInstrument } from "./bars-per-year";
3
3
  import {
4
4
  mergePriceHistoryIntegrity,
5
5
  pricePointIntegrity,
@@ -37,6 +37,8 @@ export interface RealizedVolatilityResult {
37
37
  export interface RollingRealizedVolatilityOptions {
38
38
  windows?: readonly number[];
39
39
  estimator?: RealizedVolatilityEstimator;
40
+ /** What the series is of, where that sets its year: a currency pair's is 260 bars (`barsPerYear`). */
41
+ instrument?: BarsPerYearInstrument;
40
42
  }
41
43
 
42
44
  export interface RollingRealizedVolatilityPoint {
@@ -219,14 +221,14 @@ function estimateWindow(
219
221
  return { value: Math.sqrt(Math.max(0, variance) * barsInYear) };
220
222
  }
221
223
 
222
- /** The series' own bars per year: 365 when it has weekend observations, else 252. */
223
- function seriesBarsPerYear(history: readonly Observation[]): number {
224
- return barsPerYear(history.map((point) => point.time));
224
+ /** The series' bars per year: 365 when it has weekend observations, 260 for a currency pair, else 252. */
225
+ function seriesBarsPerYear(history: readonly Observation[], instrument: BarsPerYearInstrument = {}): number {
226
+ return barsPerYear(history.map((point) => point.time), instrument);
225
227
  }
226
228
 
227
229
  /**
228
230
  * Latest n-bar estimate, annualised at the series' bars per year (365 for a
229
- * 24/7 series, 252 for exchange sessions). Close-to-close and Yang-Zhang need
231
+ * 24/7 series, 260 for a currency pair, 252 for exchange sessions). Close-to-close and Yang-Zhang need
230
232
  * n+1 observations; range estimators need n. Holidays and missing sessions cannot
231
233
  * be inferred without an exchange calendar. Supplied invalid observations remain
232
234
  * gaps, never bridges.
@@ -235,10 +237,12 @@ export function realizedVolatilityResult(
235
237
  points: readonly PricePoint[],
236
238
  window = 30,
237
239
  estimator: RealizedVolatilityEstimator = "close-to-close",
240
+ instrument: BarsPerYearInstrument = {},
238
241
  ): RealizedVolatilityResult {
239
242
  if (!validWindow(window)) return unavailable("invalid-window");
240
243
  const history = observations(points);
241
- return history === null ? unavailable("invalid-date") : estimateWindow(history, history.length - 1, window, estimator, seriesBarsPerYear(history));
244
+ return history === null ? unavailable("invalid-date")
245
+ : estimateWindow(history, history.length - 1, window, estimator, seriesBarsPerYear(history, instrument));
242
246
  }
243
247
 
244
248
  export function realizedVolatility(
@@ -258,7 +262,7 @@ export function rollingRealizedVolatility(
258
262
  if (history === null) return [];
259
263
  const windows = [...new Set(options.windows ?? REALIZED_VOLATILITY_WINDOWS)];
260
264
  const estimator = options.estimator ?? "close-to-close";
261
- const bars = seriesBarsPerYear(history);
265
+ const bars = seriesBarsPerYear(history, options.instrument);
262
266
  return history.map((point, index) => ({
263
267
  date: new Date(point.time),
264
268
  values: Object.fromEntries(windows.map((window) => [window, estimateWindow(history, index, window, estimator, bars).value])),
@@ -1,11 +1,12 @@
1
1
  import { apiClient } from "../api-client";
2
2
  import type { FundBondFacts } from "../api-client/fund-facts";
3
- import type { HeadlessPaneOptionDef } from "../types/headless";
3
+ import type { HeadlessPaneEntry, HeadlessPaneOptionDef } from "../types/headless";
4
4
  import { formatFundYield, NOT_SEC_YIELD } from "./bond-funds";
5
+ import { isUsListingExchange } from "../utils/exchanges";
5
6
 
6
7
  /**
7
- * Tax-equivalent yield and the muni/Treasury ratio, for `fundamentals` and
8
- * `fn DVD` with `--tax-rate`.
8
+ * Tax-equivalent yield and the muni/Treasury ratio, for `fundamentals`,
9
+ * `fn DVD`, `fn ETF` and `fn DES` with `--tax-rate`.
9
10
  *
10
11
  * tax-equivalent yield = yield / (1 - (federal rate + state rate))
11
12
  * muni/Treasury ratio = yield / Treasury par yield at the tenor nearest the fund's duration
@@ -18,9 +19,9 @@ import { formatFundYield, NOT_SEC_YIELD } from "./bond-funds";
18
19
  * fund's income is taxed by the state like a taxable bond's, so the state
19
20
  * rate cancels out. The two rates add up without netting a federal deduction
20
21
  * for state tax, which the SALT cap mostly removes: this is how iShares
21
- * computes the tax-equivalent yields it publishes (MUB 4.04% at 40.8%: 6.83%;
22
- * CMF 3.87% at 40.8% + 13.3% California: 8.43%). The ratio compares pre-tax
23
- * yields, the convention for muni/Treasury ratios.
22
+ * computes the tax-equivalent yields it publishes (on 2026-10-15, MUB 4.0418% at
23
+ * 40.8%: 6.83%; CMF 3.87% at 40.8% + 13.3% California: 8.43%). The ratio
24
+ * compares pre-tax yields, the convention for muni/Treasury ratios.
24
25
  */
25
26
  const TAX_EQUIVALENT_FORMULA = "tax-equivalent yield = yield / (1 - (federal rate + state rate)); the state rate counts only for a single-state muni fund of --state";
26
27
  const MUNI_TREASURY_RATIO_FORMULA = "muni/Treasury ratio = yield / Treasury par yield at the GC tenor nearest the fund's duration";
@@ -81,8 +82,8 @@ export function parseTaxRates(input: TaxRateInput): TaxRates | null {
81
82
  return { federal, state: { rate, code: normalizeStateCode(String(input.state)) } };
82
83
  }
83
84
 
84
- /** One fund with the options, as the catalog shows them: the options refuse a ranking of several. */
85
- export const TAX_RATE_EXAMPLES = ["MUB --tax-rate 40.8", "CMF --tax-rate 40.8 --state-rate 13.3 --state CA"] as const;
85
+ /** The options as the catalog shows them: one fund's report, and a ranking of several with their tax columns. */
86
+ export const TAX_RATE_EXAMPLES = ["MUB --tax-rate 40.8", "CMF --tax-rate 40.8 --state-rate 13.3 --state CA", "MUB VTEB SUB LQD --tax-rate 40.8"] as const;
86
87
 
87
88
  /** The options `fn DVD` takes for it; the pane does not draw them, the report adds its lines. */
88
89
  export const TAX_RATE_OPTIONS: HeadlessPaneOptionDef[] = [
@@ -112,6 +113,34 @@ export const TAX_RATE_OPTIONS: HeadlessPaneOptionDef[] = [
112
113
  },
113
114
  ];
114
115
 
116
+ /**
117
+ * The options as a pane that draws them takes them (`fn DES MUB --tax-rate
118
+ * 40.8`): each is set as the pane setting of its key, which the overview
119
+ * reads (taxRatesFromSettings).
120
+ */
121
+ export const TAX_RATE_PANE_OPTIONS = TAX_RATE_OPTIONS.map(({ shot: _shot, normalize, ...option }) => ({
122
+ ...option,
123
+ ...option.key === "tax-rate" ? { example: "--tax-rate 40.8" } : {},
124
+ ...normalize ? { normalize: (value: string) => String(normalize(value)) } : {},
125
+ }));
126
+
127
+ /**
128
+ * The rates a pane's settings ask for (TAX_RATE_PANE_OPTIONS): null without a
129
+ * tax rate, and the reason when they do not go together.
130
+ */
131
+ export function taxRatesFromSettings(settings: Record<string, unknown> | undefined): { rates: TaxRates } | { error: string } | null {
132
+ const value = (key: string) => {
133
+ const raw = settings?.[key];
134
+ return typeof raw === "string" || typeof raw === "number" ? String(raw) : undefined;
135
+ };
136
+ try {
137
+ const rates = parseTaxRates({ taxRate: value("tax-rate"), stateRate: value("state-rate"), state: value("state") });
138
+ return rates ? { rates } : null;
139
+ } catch (error) {
140
+ return { error: error instanceof Error ? error.message : String(error) };
141
+ }
142
+ }
143
+
115
144
  /** The same options in `gloom help fundamentals`. */
116
145
  export const TAX_RATE_HELP_OPTIONS = [
117
146
  {
@@ -138,6 +167,20 @@ export interface TreasuryTenor {
138
167
  years: number;
139
168
  yield: number;
140
169
  asOf: string | null;
170
+ /** The FRED series of the same constant-maturity yield (`DGS7`), null for a tenor FRED has none of. */
171
+ seriesId?: string | null;
172
+ }
173
+
174
+ /** FRED's constant-maturity Treasury series by tenor: the same par yields the Treasury publishes, under a stable id. */
175
+ const TREASURY_SERIES: Readonly<Record<string, string>> = {
176
+ "1M": "DGS1MO", "3M": "DGS3MO", "6M": "DGS6MO", "1Y": "DGS1", "2Y": "DGS2", "3Y": "DGS3",
177
+ "5Y": "DGS5", "7Y": "DGS7", "10Y": "DGS10", "20Y": "DGS20", "30Y": "DGS30",
178
+ };
179
+
180
+ /** `DGS7` for the 7Y tenor (`7Y`, `7y`, `7 Yr`); null for a tenor FRED has no series of (2M, 4M). */
181
+ export function treasurySeriesId(tenor: string): string | null {
182
+ const key = tenor.trim().toUpperCase().replace(/\s+/g, "").replace(/(?:YRS?|YEARS?)$/, "Y").replace(/(?:MOS?|MONTHS?)$/, "M");
183
+ return TREASURY_SERIES[key] ?? null;
141
184
  }
142
185
 
143
186
  /**
@@ -183,26 +226,66 @@ function formatRate(value: number): string {
183
226
  return `${Number(value.toFixed(2))}%`;
184
227
  }
185
228
 
229
+ /**
230
+ * A yield a formula is worked from, to the precision it was worked at, so the
231
+ * line adds up from what it shows: MUB's SEC yield of 3.7955% over (1 -
232
+ * 40.8%) is 6.41%, where `3.80%` would give 6.42%. Two decimals at least,
233
+ * four at most.
234
+ */
235
+ function formulaPercent(value: number): string {
236
+ const text = value.toFixed(4).replace(/0{1,2}$/, "");
237
+ return `${text}%`;
238
+ }
239
+
240
+ /** A muni/Treasury ratio as every view draws it: `80.8%`. */
241
+ export function formatMuniTreasuryRatio(ratio: number): string {
242
+ return `${(ratio * 100).toFixed(1)}%`;
243
+ }
244
+
245
+ /**
246
+ * Why `--tax-rate` has no bond fund figures to read for a listing, which it
247
+ * says in place of the tax-equivalent yield: a stock or anything else that is
248
+ * not a fund, or a fund listed outside the US, whose income US tax rates do
249
+ * not describe.
250
+ */
251
+ export type NoBondFigures = "not-a-fund" | "listed-abroad";
252
+
253
+ /** NoBondFigures for a listing of `kind` (resolveTickerInstrumentKind) on `exchange`; null for a fund listed in the US or on no known venue. */
254
+ export function noBondFigures(kind: string | null | undefined, exchange: string | null | undefined): NoBondFigures | null {
255
+ if (kind !== "fund") return "not-a-fund";
256
+ return exchange && !isUsListingExchange(exchange) ? "listed-abroad" : null;
257
+ }
258
+
259
+ /** `KO is not a fund`, or `--tax-rate does not apply to 3046, a fund listed outside the US`. */
260
+ function noBondFiguresText(symbol: string, reason: NoBondFigures): string {
261
+ return reason === "not-a-fund" ? `${symbol} is not a fund` : `--tax-rate does not apply to ${symbol}, a fund listed outside the US`;
262
+ }
263
+
186
264
  /**
187
265
  * A fund's tax-equivalent yield and muni/Treasury ratio from its bond facts,
188
266
  * the distribution yield it falls back to, and the Treasury curve. Only a
189
- * fund its sponsor classes as municipal has one; any other says why not.
267
+ * fund its sponsor classes as municipal has one; any other says why not, and
268
+ * a listing that is not a US fund (`noBondFigures`) says so rather than that
269
+ * its figures are not loaded.
190
270
  */
191
271
  export function analyzeTaxEquivalent({
192
- symbol, bond, rates, distribution, treasury, checkError,
272
+ symbol, bond, rates, distribution, treasury, checkError, noBondFigures: notFund,
193
273
  }: {
194
274
  symbol: string;
195
275
  bond: FundBondFacts | null | undefined;
196
276
  rates: TaxRates;
197
277
  checkError?: string;
278
+ /** Why the listing has no bond fund figures to read at all; absent for a US-listed fund. */
279
+ noBondFigures?: NoBondFigures | null;
198
280
  /** The distribution yield in percent and its label, for a fund without a SEC yield. */
199
281
  distribution?: YieldBasis | null;
200
282
  /** The Treasury curve's points, or null when it could not be read. */
201
283
  treasury?: readonly TreasuryTenor[] | null;
202
284
  }): TaxEquivalentAnalysis {
203
285
  if (checkError) return { symbol, rates, checkError };
286
+ if (notFund) return { symbol, rates, notApplicable: `no tax-equivalent yield: ${noBondFiguresText(symbol, notFund)}` };
204
287
  if (!bond) {
205
- return { symbol, rates, notApplicable: `no tax-equivalent yield: ${symbol} is not a bond fund with sponsor figures (iShares, Vanguard and SPDR bond ETFs have them)` };
288
+ return { symbol, rates, notApplicable: `no tax-equivalent yield: no sponsor bond figures are loaded for ${symbol} (they are for iShares, Vanguard, SPDR and VanEck bond ETFs)` };
206
289
  }
207
290
  if (bond.kind !== "municipal") {
208
291
  return { symbol, rates, notApplicable: `no tax-equivalent yield: ${symbol} is a taxable bond fund, its income is taxed` };
@@ -223,7 +306,7 @@ export function analyzeTaxEquivalent({
223
306
  }
224
307
  const durationYears = bond.duration?.value;
225
308
  const treasuryPoint = treasury ? nearestTenor(treasury, durationYears) : null;
226
- const ratioNote = durationYears == null ? `no ratio: ${symbol}'s sponsor publishes no duration to match a Treasury tenor`
309
+ const ratioNote = durationYears == null ? `no ratio: no sponsor duration is loaded for ${symbol} to match a Treasury tenor`
227
310
  : !treasuryPoint ? "no ratio: the Treasury curve could not be read" : undefined;
228
311
  return {
229
312
  symbol,
@@ -239,9 +322,9 @@ export function analyzeTaxEquivalent({
239
322
  };
240
323
  }
241
324
 
242
- /** A short form of the basis for the ratio line: `SEC yield 4.04%`, `distribution yield 3.27%`. */
325
+ /** A short form of the basis for the ratio line: `SEC yield 4.0418%`, `distribution yield 3.27%`. */
243
326
  function basisShort(basis: YieldBasis): string {
244
- return `${basis.kind === "sec" ? "SEC yield" : "distribution yield"} ${formatFundYield(basis.value)}`;
327
+ return `${basis.kind === "sec" ? "SEC yield" : "distribution yield"} ${formulaPercent(basis.value)}`;
245
328
  }
246
329
 
247
330
  /** One report line: its label, its text, and the raw value JSON keeps. */
@@ -251,18 +334,30 @@ export interface TaxEquivalentLine {
251
334
  text: string;
252
335
  value: number | null;
253
336
  unit?: string;
337
+ /**
338
+ * How an export writes it: the figure as drawn (`6.41%`) under the unit it
339
+ * names (`pct`), dated by the yield it was taken on; the reason alone when
340
+ * there is no figure.
341
+ */
342
+ export: { formatted: string; exportUnit?: string; asOf: string | null };
254
343
  }
255
344
 
345
+ /** `6.41%` for an export, the figure alone; its reason when there is none. */
346
+ const exportPercent = (text: string, asOf: string | null) => ({ formatted: text, exportUnit: "pct", asOf });
347
+
256
348
  /**
257
349
  * The analysis as report lines, each saying what it was computed from:
258
350
  *
259
351
  * Tax rate 40.8% (federal; MUB is a national fund, no state rate)
260
- * Tax-equivalent yield 6.83% (30-day SEC yield 4.04% as of 2026-10-15 / (1 - 40.8%))
261
- * Muni/Treasury ratio 81.0% (SEC yield 4.04% / 7Y Treasury 4.99% on 2026-10-16, the tenor nearest its 7.13-year duration)
352
+ * Tax-equivalent yield 6.83% (30-day SEC yield 4.0418% as of 2026-10-15 / (1 - 40.8%))
353
+ * Muni/Treasury ratio 81.0% (SEC yield 4.0418% / 7Y Treasury 4.99% on 2026-10-16, the tenor nearest its 7.13-year duration)
354
+ *
355
+ * Each yield in a formula is written as precisely as it was worked with
356
+ * (formulaPercent), so the line adds up from what it shows.
262
357
  */
263
358
  export function taxEquivalentLines(analysis: TaxEquivalentAnalysis): TaxEquivalentLine[] {
264
359
  if (analysis.checkError) {
265
- return [{ key: "taxEquivalentYield", label: "Tax-equivalent yield", text: analysis.checkError, value: null }];
360
+ return [{ key: "taxEquivalentYield", label: "Tax-equivalent yield", text: analysis.checkError, value: null, export: { formatted: analysis.checkError, asOf: null } }];
266
361
  }
267
362
  const { rates } = analysis;
268
363
  const stateText = !rates.state ? (analysis.notApplicable ? "federal" : "federal; no state rate given")
@@ -270,33 +365,54 @@ export function taxEquivalentLines(analysis: TaxEquivalentAnalysis): TaxEquivale
270
365
  : `federal; ${analysis.stateNote}`;
271
366
  const combined = analysis.combinedRate ?? rates.federal;
272
367
  const lines: TaxEquivalentLine[] = [
273
- { key: "taxRate", label: "Tax rate", text: `${formatRate(combined)} (${stateText})`, value: combined, unit: "%" },
368
+ { key: "taxRate", label: "Tax rate", text: `${formatRate(combined)} (${stateText})`, value: combined, unit: "%", export: exportPercent(formatRate(combined), null) },
274
369
  ];
275
370
  if (analysis.notApplicable || !analysis.basis || analysis.taxEquivalentYield == null) {
276
- lines.push({ key: "taxEquivalentYield", label: "Tax-equivalent yield", text: analysis.notApplicable ?? "—", value: null });
371
+ const reason = analysis.notApplicable ?? "—";
372
+ lines.push({ key: "taxEquivalentYield", label: "Tax-equivalent yield", text: reason, value: null, export: { formatted: reason, asOf: null } });
277
373
  return lines;
278
374
  }
279
375
  const basis = analysis.basis;
280
376
  lines.push({
281
377
  key: "taxEquivalentYield",
282
378
  label: "Tax-equivalent yield",
283
- text: `${formatFundYield(analysis.taxEquivalentYield)} (${basis.label} ${formatFundYield(basis.value)}${basis.asOf ? ` as of ${basis.asOf}` : ""} / (1 - ${formatRate(combined)}))`,
379
+ text: `${formatFundYield(analysis.taxEquivalentYield)} (${basis.label} ${formulaPercent(basis.value)}${basis.asOf ? ` as of ${basis.asOf}` : ""} / (1 - ${formatRate(combined)}))`,
284
380
  value: Math.round(analysis.taxEquivalentYield * 10_000) / 10_000,
285
381
  unit: "%",
382
+ export: exportPercent(formatFundYield(analysis.taxEquivalentYield), basis.asOf),
286
383
  });
287
384
  const ratio = analysis.ratio;
288
- lines.push(ratio
385
+ // The ratio is as old as the older of the two yields it divides.
386
+ const ratioAsOf = ratio ? [basis.asOf, ratio.treasury.asOf].filter((day): day is string => !!day).sort()[0] ?? null : null;
387
+ const ratioText = ratio ? formatMuniTreasuryRatio(ratio.value) : null;
388
+ lines.push(ratio && ratioText
289
389
  ? {
290
390
  key: "muniTreasuryRatio",
291
391
  label: "Muni/Treasury ratio",
292
- text: `${(ratio.value * 100).toFixed(1)}% (${basisShort(basis)} / ${ratio.treasury.tenor} Treasury ${formatFundYield(ratio.treasury.yield)}`
392
+ text: `${ratioText} (${basisShort(basis)} / ${ratio.treasury.tenor} Treasury ${formulaPercent(ratio.treasury.yield)}`
293
393
  + `${ratio.treasury.asOf ? ` on ${ratio.treasury.asOf}` : ""}, the tenor nearest its ${ratio.durationYears.toFixed(2)}-year duration)`,
294
394
  value: Math.round(ratio.value * 10_000) / 10_000,
395
+ export: exportPercent(ratioText, ratioAsOf),
295
396
  }
296
- : { key: "muniTreasuryRatio", label: "Muni/Treasury ratio", text: analysis.ratioNote ?? "—", value: null });
397
+ : { key: "muniTreasuryRatio", label: "Muni/Treasury ratio", text: analysis.ratioNote ?? "—", value: null, export: { formatted: analysis.ratioNote ?? "—", asOf: null } });
297
398
  return lines;
298
399
  }
299
400
 
401
+ /**
402
+ * The report section every function with `--tax-rate` shows (DVD, ETF,
403
+ * fundamentals): the text report's lines with their formulas, and the
404
+ * figures an export keeps, each a number in its unit dated by the yield it
405
+ * was taken on.
406
+ */
407
+ export function taxEquivalentSection(analysis: TaxEquivalentAnalysis): { title: string; entries: HeadlessPaneEntry[]; textEntries: HeadlessPaneEntry[] } {
408
+ const lines = taxEquivalentLines(analysis);
409
+ return {
410
+ title: "Tax-equivalent yield",
411
+ textEntries: lines.map((line) => ({ label: line.label, value: line.value, formatted: line.text })),
412
+ entries: lines.map((line) => ({ label: line.label, value: line.value, ...line.export })),
413
+ };
414
+ }
415
+
300
416
  /** The analysis as JSON keeps it: the rates, the yield it was taken on, the results and the formulas, without the text. */
301
417
  export function taxEquivalentJson(tax: TaxEquivalentAnalysis) {
302
418
  return {
@@ -306,8 +422,10 @@ export function taxEquivalentJson(tax: TaxEquivalentAnalysis) {
306
422
  basis: tax.basis ?? null,
307
423
  taxEquivalentYield: tax.taxEquivalentYield ?? null,
308
424
  muniTreasuryRatio: tax.ratio ? {
309
- value: tax.ratio.value, tenor: tax.ratio.treasury.tenor, treasuryYield: tax.ratio.treasury.yield,
310
- treasuryAsOf: tax.ratio.treasury.asOf, durationYears: tax.ratio.durationYears,
425
+ value: tax.ratio.value, tenor: tax.ratio.treasury.tenor,
426
+ // The constant-maturity series the tenor's yield is (DGS7), to read its history by.
427
+ seriesId: tax.ratio.treasury.seriesId ?? treasurySeriesId(tax.ratio.treasury.tenor),
428
+ treasuryYield: tax.ratio.treasury.yield, treasuryAsOf: tax.ratio.treasury.asOf, durationYears: tax.ratio.durationYears,
311
429
  } : null,
312
430
  ...(tax.checkError ? { checkError: tax.checkError } : {}),
313
431
  notes: [tax.checkError, tax.notApplicable, tax.stateNote, tax.ratioNote].filter((note): note is string => !!note),
@@ -339,11 +457,11 @@ export async function loadTreasuryTenors(
339
457
  try {
340
458
  const view = await client.getCloudCurve("us", null);
341
459
  return finite(view.points.flatMap((point) => point.yield == null ? []
342
- : [{ tenor: point.tenor, years: point.years, yield: point.yield, asOf: view.asOf ?? null }]));
460
+ : [{ tenor: point.tenor, years: point.years, yield: point.yield, asOf: view.asOf ?? null, seriesId: treasurySeriesId(point.tenor) }]));
343
461
  } catch {
344
462
  try {
345
463
  return finite((await client.getCloudYieldCurve()).flatMap((point) => point.yield == null ? []
346
- : [{ tenor: point.maturity, years: point.maturityYears, yield: point.yield, asOf: point.asOf ?? null }]));
464
+ : [{ tenor: point.maturity, years: point.maturityYears, yield: point.yield, asOf: point.asOf ?? null, seriesId: treasurySeriesId(point.maturity) }]));
347
465
  } catch {
348
466
  // Intentional ignore: the ratio line then says the Treasury curve could not be read.
349
467
  return null;
@@ -246,13 +246,55 @@ export function filterNewsArticlesForQuery(items: NewsArticle[], query: NewsQuer
246
246
  return filtered.slice(0, MAX_ARTICLES);
247
247
  }
248
248
 
249
+ /** Words that carry no news of their own: a summary made of them and the headline's words says nothing new. */
250
+ const FILLER_WORDS = new Set([
251
+ "a", "an", "the", "and", "or", "but", "of", "to", "in", "on", "at", "for", "from", "by", "with", "as", "into", "onto",
252
+ "over", "through", "about", "after", "amid", "than", "that", "this", "these", "those", "it", "its", "their", "his",
253
+ "her", "they", "is", "are", "was", "were", "be", "been", "being", "has", "have", "had", "will", "would", "could",
254
+ "may", "might", "can", "also", "which", "who", "while", "more", "some",
255
+ ]);
256
+
257
+ /** A word cut to its stem, near enough to match its other forms: seeking and seeks, restricts and restrictions. */
258
+ function wordStem(word: string): string {
259
+ const bare = word.replace(/['\u2019]s$/, "");
260
+ let stem = bare.length > 5 ? bare.replace(/(?:ing|ed)$/, "") : bare;
261
+ stem = stem.length > 3 ? stem.replace(/e?s$/, "") : stem;
262
+ return stem.length >= 3 ? stem : bare;
263
+ }
264
+
265
+ function newsWordStems(text: string): string[] {
266
+ return (text.toLowerCase().match(/[\p{L}\p{N}]+(?:['\u2019][\p{L}]+)?/gu) ?? [])
267
+ .filter((word) => !FILLER_WORDS.has(word))
268
+ .map(wordStem);
269
+ }
270
+
271
+ /** How much of a summary may be words its headline lacks and the summary still only restate it. */
272
+ const RESTATED_NEW_WORDS = 1 / 3;
273
+
274
+ /**
275
+ * Whether a story's summary only says its headline again, in other words or
276
+ * not: at most a third of its words (fillers aside) are words the headline
277
+ * lacks, in any of their forms. "Apple is seeking to raise about $7 billion
278
+ * through a bond sale, Bloomberg News reports." restates "Apple seeks about $7
279
+ * billion from bond sale, Bloomberg News reports"; a summary that adds the
280
+ * why or the numbers does not.
281
+ */
282
+ export function summaryRestatesHeadline(title: string, summary: string): boolean {
283
+ const headline = newsWordStems(title);
284
+ const words = newsWordStems(summary);
285
+ if (words.length === 0) return true;
286
+ const known = (word: string) => headline.some((stem) => stem === word
287
+ || (Math.min(stem.length, word.length) >= 4 && (stem.startsWith(word) || word.startsWith(stem))));
288
+ return words.filter((word) => !known(word)).length <= words.length * RESTATED_NEW_WORDS;
289
+ }
290
+
249
291
  /**
250
292
  * A story's summary as one line under its row in a text list (`news`,
251
293
  * `fn CN`): its whitespace and line breaks run together, null when it has
252
- * none or only repeats the headline.
294
+ * none or only restates the headline (summaryRestatesHeadline).
253
295
  */
254
296
  export function newsSummaryLine(article: Pick<NewsArticle, "title" | "summary">): string | null {
255
297
  const summary = article.summary?.replace(/\s+/g, " ").trim();
256
- if (!summary || summary.toLowerCase() === article.title.trim().toLowerCase()) return null;
298
+ if (!summary || summaryRestatesHeadline(article.title, summary)) return null;
257
299
  return summary;
258
300
  }