gloomberb 0.20.2 → 0.20.3
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/README.md +1 -1
- package/README.zh-CN.md +1 -1
- package/package.json +2 -1
- package/src/account/auth-form.tsx +13 -8
- package/src/account/upgrade-dialog.tsx +1 -1
- package/src/api-client/central-bank-rates.ts +5 -0
- package/src/api-client/data.ts +17 -4
- package/src/api-client/debt-maturities.ts +45 -2
- package/src/api-client/earnings.ts +4 -2
- package/src/api-client/errors.ts +21 -11
- package/src/api-client/index.ts +1 -0
- package/src/api-client/paths.ts +9 -1
- package/src/api-client/social-mentions.ts +47 -0
- package/src/api-client/types/econ.ts +4 -0
- package/src/app.tsx +11 -1
- package/src/cli/command-options.ts +2 -1
- package/src/cli/commands/market.ts +111 -29
- package/src/cli/commands/options-chain.ts +23 -6
- package/src/cli/commands/overview.ts +13 -5
- package/src/cli/commands/plugins.ts +49 -18
- package/src/cli/commands/search.ts +25 -6
- package/src/cli/commands/ticker.ts +4 -2
- package/src/cli/fx-quote-rate.ts +49 -1
- package/src/cli/glossary.ts +95 -15
- package/src/cli/history-rows.ts +9 -25
- package/src/cli/index.ts +6 -38
- package/src/cli/known-gaps.ts +3 -3
- package/src/cli/listing-arg.ts +78 -18
- package/src/cli/name-entries.ts +3 -2
- package/src/cli/not-a-ticker.ts +6 -2
- package/src/cli/pane-functions/capabilities.ts +12 -1
- package/src/cli/pane-functions/function-help.ts +23 -11
- package/src/cli/pane-functions/headless.ts +3 -1
- package/src/cli/pane-functions/index.ts +32 -4
- package/src/cli/pane-functions/market-session.ts +8 -3
- package/src/cli/pane-functions/resolver.ts +18 -11
- package/src/cli/pane-functions/screenshot-payload.ts +36 -6
- package/src/cli/pane-functions/screenshot-render.ts +4 -0
- package/src/cli/quote-answer.ts +10 -0
- package/src/cli/report-tables.ts +22 -2
- package/src/cli/result.ts +7 -3
- package/src/cli/spreadsheet-hint.ts +43 -0
- package/src/cli/symbol-list.ts +58 -4
- package/src/cli/symbol-rows.ts +49 -2
- package/src/cli/ticker-resolution.ts +98 -5
- package/src/cli/unknown-command.ts +88 -0
- package/src/components/command-bar/assist/model.ts +6 -1
- package/src/components/command-bar/commands/direct/index.ts +9 -1
- package/src/components/command-bar/commands/registry.ts +18 -0
- package/src/components/command-bar/pane-actions.ts +30 -13
- package/src/components/command-bar/panel/index.tsx +6 -3
- package/src/components/command-bar/panel/prompt-binding.ts +4 -0
- package/src/components/command-bar/panel/types.ts +3 -0
- package/src/components/command-bar/routes/header-market.ts +108 -0
- package/src/components/command-bar/routes/root/command-items.ts +5 -0
- package/src/components/command-bar/routes/root/provider-search.ts +190 -32
- package/src/components/command-bar/routes/root/results.ts +3 -0
- package/src/components/command-bar/routes/root/runtime.ts +28 -5
- package/src/components/command-bar/routes/ticker-search/results.ts +53 -6
- package/src/components/command-bar/routing/list-state.ts +38 -0
- package/src/components/command-bar/selection-hint.ts +28 -0
- package/src/components/command-bar/surface/index.tsx +41 -3
- package/src/components/command-bar/view-model.ts +15 -0
- package/src/components/command-bar/workflow/tickers.ts +3 -2
- package/src/components/company-logo.tsx +20 -2
- package/src/components/data-table/export.ts +13 -8
- package/src/components/feedback-dialog.tsx +2 -1
- package/src/components/form-modal/field-row.tsx +2 -1
- package/src/components/input-search-bar.tsx +2 -2
- package/src/components/layout/double-escape-close.ts +8 -5
- package/src/components/layout/header.tsx +75 -44
- package/src/components/layout/market-summary.ts +322 -116
- package/src/components/layout/pane/footer/index.tsx +26 -8
- package/src/components/layout/pane/footer/model.ts +46 -20
- package/src/components/layout/pane/header.tsx +3 -2
- package/src/components/layout/shell/chrome.ts +15 -15
- package/src/components/layout/status-bar.tsx +8 -7
- package/src/components/layout/status-widget-space.ts +8 -0
- package/src/components/markdown-editor.tsx +2 -2
- package/src/components/onboarding/account-step/form-panel.tsx +0 -3
- package/src/components/onboarding/onboarding-keyboard.ts +15 -6
- package/src/components/onboarding/onboarding-wizard.tsx +61 -11
- package/src/components/onboarding/portfolio-step/broker-fields-panel.tsx +0 -1
- package/src/components/onboarding/portfolio-step/positions-panel.tsx +0 -2
- package/src/components/price-sparkline/model.ts +26 -10
- package/src/components/ticker/list-table-view.tsx +29 -4
- package/src/components/ui/button.tsx +13 -2
- package/src/components/ui/column-grid.tsx +18 -9
- package/src/components/ui/data-table/index.tsx +1 -1
- package/src/components/ui/data-table/opentui/index.tsx +2 -1
- package/src/components/ui/data-table/types.ts +18 -0
- package/src/components/ui/delayed-mark.tsx +3 -2
- package/src/components/ui/field-grid.tsx +0 -2
- package/src/components/ui/fields.tsx +7 -4
- package/src/components/ui/inline-quick-add.tsx +2 -2
- package/src/components/ui/key-hint-words.ts +153 -0
- package/src/components/ui/key-hints.tsx +73 -0
- package/src/components/ui/menu.tsx +3 -1
- package/src/components/ui/message-composer.tsx +2 -2
- package/src/components/ui/shortcut-hint.tsx +28 -3
- package/src/components/ui/tabs.tsx +7 -0
- package/src/components/ui/text-prompt-dialog.tsx +2 -1
- package/src/core/state/app/command-bar-launch.ts +3 -0
- package/src/data/config/store/normalize.ts +6 -0
- package/src/docs/snapshot.json +120 -69
- package/src/i18n/es.ts +24 -1
- package/src/i18n/ja.ts +24 -1
- package/src/i18n/ko.ts +24 -1
- package/src/i18n/zh-cn.ts +24 -1
- package/src/i18n/zh-tw.ts +24 -1
- package/src/layout/pane-manager/gridlock.ts +11 -0
- package/src/market-data/bars-per-year.ts +27 -9
- package/src/market-data/coordinator/quotes.ts +22 -3
- package/src/market-data/futures-board.ts +80 -0
- package/src/market-data/futures-contract.ts +9 -3
- package/src/market-data/market/change-basis.ts +2 -2
- package/src/market-data/market/dated-previous-close.ts +163 -47
- package/src/market-data/market/format.ts +14 -3
- package/src/market-data/market/freshness.ts +24 -7
- package/src/market-data/market/header-market.ts +154 -0
- package/src/market-data/market/index-level.ts +29 -0
- package/src/market-data/market/index-session-venues.ts +44 -0
- package/src/market-data/market/status.ts +7 -2
- package/src/market-data/market/venue-session.ts +72 -0
- package/src/market-data/model-dividend-yield.ts +23 -8
- package/src/market-data/options-alternatives.ts +39 -4
- package/src/market-data/published-apac-sessions.ts +40 -2
- package/src/market-data/quotes/export-identity.ts +76 -0
- package/src/market-data/quotes/freshness.ts +22 -0
- package/src/market-data/quotes/time.ts +42 -1
- package/src/market-data/realized-volatility.ts +11 -7
- package/src/market-data/tax-equivalent.ts +145 -27
- package/src/plugins/builtin/account-management/pane.tsx +2 -2
- package/src/plugins/builtin/alerts/alert-engine.ts +12 -6
- package/src/plugins/builtin/alerts/alert-log.ts +6 -2
- package/src/plugins/builtin/alerts/calendar-events.ts +74 -12
- package/src/plugins/builtin/alerts/cli-forms.ts +11 -1
- package/src/plugins/builtin/alerts/cli-move.ts +234 -0
- package/src/plugins/builtin/alerts/cli.ts +224 -33
- package/src/plugins/builtin/alerts/command.ts +33 -6
- package/src/plugins/builtin/alerts/event-rows.ts +18 -4
- package/src/plugins/builtin/alerts/events-pane.tsx +6 -2
- package/src/plugins/builtin/alerts/events.ts +9 -0
- package/src/plugins/builtin/alerts/format.ts +40 -15
- package/src/plugins/builtin/alerts/headless.ts +31 -18
- package/src/plugins/builtin/alerts/history.ts +1 -0
- package/src/plugins/builtin/alerts/index.tsx +86 -12
- package/src/plugins/builtin/alerts/live.ts +2 -1
- package/src/plugins/builtin/alerts/move-checks.ts +155 -0
- package/src/plugins/builtin/alerts/move.ts +160 -0
- package/src/plugins/builtin/alerts/pane.tsx +52 -22
- package/src/plugins/builtin/alerts/price-text.ts +62 -0
- package/src/plugins/builtin/alerts/price.ts +17 -0
- package/src/plugins/builtin/alerts/quotes.ts +84 -3
- package/src/plugins/builtin/alerts/scheduled-check.ts +7 -1
- package/src/plugins/builtin/alerts/storage.ts +20 -7
- package/src/plugins/builtin/alerts/types.ts +13 -0
- package/src/plugins/builtin/analytics/risk-client.ts +60 -39
- package/src/plugins/builtin/analytics/risk-episodes.ts +18 -0
- package/src/plugins/builtin/analytics/risk-headless.ts +20 -4
- package/src/plugins/builtin/analytics/risk-model.ts +68 -1
- package/src/plugins/builtin/analytics/risk-pane.tsx +15 -3
- package/src/plugins/builtin/backtest/engine.ts +4 -2
- package/src/plugins/builtin/backtest/window.ts +3 -1
- package/src/plugins/builtin/broker-manager/sign-in-end.ts +1 -1
- package/src/plugins/builtin/central-bank-rates/client.ts +4 -0
- package/src/plugins/builtin/central-bank-rates/headless.ts +1 -1
- package/src/plugins/builtin/central-bank-rates/model.ts +18 -8
- package/src/plugins/builtin/central-bank-rates/pane.tsx +6 -3
- package/src/plugins/builtin/chart-composer/cli-options.ts +5 -0
- package/src/plugins/builtin/chart-composer/headless-schema.ts +17 -1
- package/src/plugins/builtin/chart-composer/headless.ts +2 -0
- package/src/plugins/builtin/cloud/upgrade-status-widget.tsx +9 -2
- package/src/plugins/builtin/crypto-board/headless.ts +82 -17
- package/src/plugins/builtin/crypto-board/index.tsx +24 -2
- package/src/plugins/builtin/crypto-board/model.ts +5 -2
- package/src/plugins/builtin/crypto-board/pane.tsx +4 -1
- package/src/plugins/builtin/debt-maturities/client.ts +111 -6
- package/src/plugins/builtin/debt-maturities/headless.ts +84 -1
- package/src/plugins/builtin/debt-maturities/model.ts +97 -14
- package/src/plugins/builtin/debt-maturities/pane.tsx +165 -15
- package/src/plugins/builtin/debt-maturities/series.ts +3 -1
- package/src/plugins/builtin/dividend-yield/client.ts +22 -6
- package/src/plugins/builtin/dividend-yield/headless.ts +113 -46
- package/src/plugins/builtin/dividend-yield/model.ts +5 -2
- package/src/plugins/builtin/dividend-yield/pane.tsx +6 -3
- package/src/plugins/builtin/dividend-yield/ranking-reads.ts +11 -4
- package/src/plugins/builtin/dividend-yield/ranking.ts +113 -18
- package/src/plugins/builtin/dividend-yield/types.ts +2 -0
- package/src/plugins/builtin/dividend-yield/view.ts +3 -0
- package/src/plugins/builtin/econ/calendar-model.ts +21 -3
- package/src/plugins/builtin/econ/detail-view.tsx +5 -3
- package/src/plugins/builtin/econ/figures.ts +13 -0
- package/src/plugins/builtin/econ/fred-catalog.ts +6 -3
- package/src/plugins/builtin/econ/index.tsx +5 -3
- package/src/plugins/builtin/econ/types.ts +5 -0
- package/src/plugins/builtin/equity-screener/footer.ts +45 -0
- package/src/plugins/builtin/equity-screener/pane.tsx +4 -18
- package/src/plugins/builtin/equity-screener/ticker-check.tsx +2 -1
- package/src/plugins/builtin/fixed-income/model.ts +1 -0
- package/src/plugins/builtin/futures/table.tsx +1 -1
- package/src/plugins/builtin/futures-curve/model.ts +3 -10
- package/src/plugins/builtin/help/function-card.tsx +2 -1
- package/src/plugins/builtin/help/function-index.ts +1 -0
- package/src/plugins/builtin/insider/client.ts +31 -14
- package/src/plugins/builtin/insider/signals-model.ts +2 -7
- package/src/plugins/builtin/iv-history/headless.ts +1 -2
- package/src/plugins/builtin/iv-history/model.ts +33 -23
- package/src/plugins/builtin/iv-history/screen-pane.tsx +0 -3
- package/src/plugins/builtin/kelly-sizer/headless.ts +64 -16
- package/src/plugins/builtin/kelly-sizer/history.ts +37 -28
- package/src/plugins/builtin/kelly-sizer/pane.tsx +43 -10
- package/src/plugins/builtin/kelly-sizer/sections.tsx +7 -2
- package/src/plugins/builtin/kelly-sizer/units.ts +29 -0
- package/src/plugins/builtin/news/index.tsx +7 -13
- package/src/plugins/builtin/news/overview-headlines.tsx +117 -0
- package/src/plugins/builtin/news/ticker-news.ts +35 -0
- package/src/plugins/builtin/news/wire/news/detail-view.tsx +8 -6
- package/src/plugins/builtin/news/wire/news/row.ts +49 -0
- package/src/plugins/builtin/news/wire/news/table.tsx +9 -20
- package/src/plugins/builtin/options/analytics.ts +7 -2
- package/src/plugins/builtin/options/live-quotes.ts +6 -1
- package/src/plugins/builtin/options/table.ts +3 -2
- package/src/plugins/builtin/options/view.tsx +11 -9
- package/src/plugins/builtin/options-scenario/client.ts +3 -0
- package/src/plugins/builtin/options-scenario/headless.ts +1 -1
- package/src/plugins/builtin/perps/client.ts +5 -4
- package/src/plugins/builtin/perps/headless.ts +134 -124
- package/src/plugins/builtin/perps/markets-section.tsx +2 -2
- package/src/plugins/builtin/perps/model.ts +8 -4
- package/src/plugins/builtin/perps/open-market.ts +4 -4
- package/src/plugins/builtin/perps/venue-markets.ts +3 -6
- package/src/plugins/builtin/portfolio-list/cell-version.ts +1 -0
- package/src/plugins/builtin/portfolio-list/cli/bulk-symbols.ts +34 -10
- package/src/plugins/builtin/portfolio-list/cli/period-report.ts +28 -2
- package/src/plugins/builtin/portfolio-list/cli/portfolio-command.ts +7 -3
- package/src/plugins/builtin/portfolio-list/cli/render.ts +66 -22
- package/src/plugins/builtin/portfolio-list/grid.tsx +5 -3
- package/src/plugins/builtin/portfolio-list/pane/data.ts +34 -1
- package/src/plugins/builtin/portfolio-list/pane/index.tsx +6 -0
- package/src/plugins/builtin/portfolio-list/pane/streaming.ts +15 -6
- package/src/plugins/builtin/portfolio-list/quick-add/resolution.ts +19 -7
- package/src/plugins/builtin/portfolio-list/table.tsx +30 -4
- package/src/plugins/builtin/realized-vol/evidence.ts +33 -6
- package/src/plugins/builtin/realized-vol/fx-proxy.ts +135 -0
- package/src/plugins/builtin/realized-vol/headless.ts +44 -8
- package/src/plugins/builtin/realized-vol/model.ts +9 -5
- package/src/plugins/builtin/realized-vol/pane.tsx +49 -15
- package/src/plugins/builtin/sec/headless.ts +48 -6
- package/src/plugins/builtin/sec/index.tsx +6 -4
- package/src/plugins/builtin/sec/model.ts +4 -1
- package/src/plugins/builtin/shared/earnings-calendar.ts +2 -0
- package/src/plugins/builtin/shared/market-cap-bands.ts +12 -0
- package/src/plugins/builtin/shared/report-freshness.ts +3 -1
- package/src/plugins/builtin/shared/use-quote-board.ts +5 -3
- package/src/plugins/builtin/shared/volatility/options.ts +63 -2
- package/src/plugins/builtin/social-mentions/headless.ts +72 -3
- package/src/plugins/builtin/social-mentions/index.tsx +8 -4
- package/src/plugins/builtin/social-mentions/lock-note.ts +6 -2
- package/src/plugins/builtin/social-mentions/outliers-client.ts +101 -0
- package/src/plugins/builtin/social-mentions/outliers-model.ts +162 -0
- package/src/plugins/builtin/social-mentions/outliers-names.ts +51 -0
- package/src/plugins/builtin/social-mentions/outliers.tsx +276 -0
- package/src/plugins/builtin/social-mentions/pane.tsx +32 -3
- package/src/plugins/builtin/supply-chain/graph-pane.tsx +2 -2
- package/src/plugins/builtin/thirteenf/api.ts +36 -2
- package/src/plugins/builtin/thirteenf/data.ts +4 -1
- package/src/plugins/builtin/thirteenf/headless.ts +14 -6
- package/src/plugins/builtin/thirteenf/model.ts +56 -1
- package/src/plugins/builtin/thirteenf/pane.tsx +8 -8
- package/src/plugins/builtin/thirteenf/report-notes.ts +11 -0
- package/src/plugins/builtin/thirteenf/table.ts +2 -1
- package/src/plugins/builtin/thirteenf/types.ts +6 -0
- package/src/plugins/builtin/ticker-detail/data-panes/historical-prices.tsx +23 -3
- package/src/plugins/builtin/ticker-detail/financials/model.ts +5 -0
- package/src/plugins/builtin/ticker-detail/headless-schema.ts +2 -1
- package/src/plugins/builtin/ticker-detail/headless.ts +21 -66
- package/src/plugins/builtin/ticker-detail/index.tsx +5 -0
- package/src/plugins/builtin/ticker-detail/overview/components.tsx +13 -1
- package/src/plugins/builtin/ticker-detail/overview/model.ts +6 -4
- package/src/plugins/builtin/ticker-detail/overview/pane.tsx +15 -0
- package/src/plugins/builtin/ticker-detail/overview/tax-equivalent.ts +69 -0
- package/src/plugins/builtin/ticker-detail/overview-tab.tsx +41 -6
- package/src/plugins/builtin/ticker-detail/quote-monitor/card.tsx +47 -24
- package/src/plugins/builtin/ticker-detail/quote-monitor/export.ts +46 -0
- package/src/plugins/builtin/ticker-detail/quote-monitor/index.tsx +20 -1
- package/src/plugins/builtin/ticker-detail/quote-monitor/rows.ts +120 -0
- package/src/plugins/builtin/ticker-detail/research-tabs.ts +1 -5
- package/src/plugins/builtin/ticker-detail/settings.ts +6 -6
- package/src/plugins/builtin/treasury-auctions/cache.ts +85 -19
- package/src/plugins/builtin/treasury-auctions/index.tsx +22 -11
- package/src/plugins/builtin/treasury-auctions/model.ts +23 -0
- package/src/plugins/builtin/treasury-auctions/treasury-direct.ts +128 -0
- package/src/plugins/builtin/world-indices/client.ts +2 -0
- package/src/plugins/compat.ts +15 -0
- package/src/plugins/host-link.ts +6 -1
- package/src/plugins/installer.ts +8 -3
- package/src/portfolio/column-values.ts +14 -4
- package/src/portfolio/listed-symbol.ts +78 -0
- package/src/portfolio/real-return.ts +172 -0
- package/src/public/__snapshots__/public-api.test.ts.snap +1 -0
- package/src/renderers/browser/config-host.ts +56 -15
- package/src/renderers/browser/main.tsx +3 -1
- package/src/renderers/browser/ui-host.tsx +1 -0
- package/src/renderers/cloudflare/http-proxy.ts +1 -0
- package/src/renderers/dom/boot-frame.ts +2 -2
- package/src/renderers/dom/data-table/row.tsx +4 -1
- package/src/renderers/dom/desktop/controls.tsx +4 -4
- package/src/renderers/dom/desktop/dialog-actions.tsx +60 -41
- package/src/renderers/dom/dom-ui-host.tsx +3 -1
- package/src/renderers/dom/host/input.tsx +4 -1
- package/src/renderers/dom/host/tabs.tsx +10 -1
- package/src/renderers/dom/styles.css +33 -13
- package/src/renderers/electrobun/bun/desktop/app-name.ts +1 -1
- package/src/renderers/opentui/host.tsx +2 -1
- package/src/sources/gloomberb-cloud/fred-series.ts +12 -0
- package/src/sources/gloomberb-cloud/index.ts +31 -2
- package/src/sources/gloomberb-cloud/normalizers.ts +29 -3
- package/src/sources/provider-router/cached-routes.ts +19 -7
- package/src/state/pane-table-export-registry.ts +19 -6
- package/src/test-support/preload.ts +5 -1
- package/src/theme/colors.ts +9 -1
- package/src/theme/themes.ts +62 -15
- package/src/theme/tone-contrast.ts +40 -0
- package/src/theme/ui-tokens.ts +23 -3
- package/src/tickers/batched-lookups.ts +57 -8
- package/src/tickers/company-name-listing.ts +156 -14
- package/src/tickers/company-name.ts +30 -6
- package/src/tickers/list.ts +7 -0
- package/src/tickers/search/home-listing.ts +31 -9
- package/src/tickers/search/index.ts +13 -3
- package/src/tickers/search/listing-index.ts +558 -0
- package/src/tickers/search/major-listings.chunk.ts +10 -0
- package/src/tickers/search/major-listings.json +3346 -0
- package/src/tickers/search/ranking.ts +68 -1
- package/src/tickers/search/types.ts +4 -0
- package/src/tickers/terminal-codes.ts +26 -1
- package/src/time-series/calendar-month-returns.ts +47 -0
- package/src/time-series/currency-conversion.ts +130 -0
- package/src/time-series/hooks.ts +2 -0
- package/src/time-series/price-comparison.ts +34 -11
- package/src/time-series/resolve-context.ts +3 -0
- package/src/time-series/resolve.ts +14 -2
- package/src/time-series/spec.ts +1 -0
- package/src/time-series/studies/indicators.ts +4 -1
- package/src/time-series/types.ts +8 -0
- package/src/types/config.ts +8 -0
- package/src/types/data-provider.ts +28 -0
- package/src/types/financials.ts +20 -2
- package/src/types/headless.ts +12 -0
- package/src/ui/host.tsx +8 -0
- package/src/utils/datetime-format.ts +17 -3
- package/src/utils/display-number.ts +15 -0
- package/src/utils/double-escape-close.ts +61 -16
- package/src/utils/float32-price.ts +24 -0
- package/src/utils/forward-dividend.ts +81 -16
- package/src/utils/fx-market-hours.ts +11 -0
- package/src/utils/plugin-proxy-hosts.json +2 -1
- package/src/utils/price-history.ts +7 -6
- package/src/utils/report-timing.ts +62 -0
- package/src/utils/sec-filings.ts +32 -0
- package/src/utils/utc-time.ts +5 -0
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
import { apiClient } from "../../../api-client";
|
|
2
|
+
import type { BarsPerYearInstrument } from "../../../market-data/bars-per-year";
|
|
3
|
+
import { fxVolatilityPair, fxVolatilityProxyFund } from "../../../market-data/options-alternatives";
|
|
4
|
+
import type { PricePoint } from "../../../types/financials";
|
|
5
|
+
import { abortError } from "../../../utils/async-deadline";
|
|
6
|
+
import { errorMessage } from "../../../utils/errors";
|
|
7
|
+
import { loadIvHistory, type ImpliedVolatilityApi, type IvHistoryPayload, type IvMethod } from "../iv-history/client";
|
|
8
|
+
import { staleness } from "../iv-history/model";
|
|
9
|
+
import { realizedVolatilityResult } from "../shared/volatility";
|
|
10
|
+
import { createSurfaceDependencies, loadVolatilitySurface, type SurfaceLoaderDependencies } from "../vol-surface/client";
|
|
11
|
+
import type { SurfaceSnapshot } from "../vol-surface/model";
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* An FX pair has no option chain here, and OTC FX volatility is not served:
|
|
15
|
+
* the options of a currency fund that holds one side of it (USDJPY: FXY) are
|
|
16
|
+
* the listed proxy. A thin one: the fund's chains often price an ATM level on
|
|
17
|
+
* one or two expiries, and its IV reads above interbank FX volatility. So the
|
|
18
|
+
* proxy is shown with its date, how many of the fund's expiries priced, and
|
|
19
|
+
* how far its IV30 sits above the pair's own realized volatility.
|
|
20
|
+
*/
|
|
21
|
+
export interface FxVolProxy {
|
|
22
|
+
/** The pair the symbol is (USDJPY for USDJPY=X or 6J=F). */
|
|
23
|
+
pair: string;
|
|
24
|
+
/** The fund whose options stand in (FXY). */
|
|
25
|
+
fund: string;
|
|
26
|
+
/** The fund's stored 30-day IV on its latest ranked close; null when there is none. */
|
|
27
|
+
iv30: { value: number; date: string; method: IvMethod } | null;
|
|
28
|
+
/** The fund's listed expiries that price an ATM IV now, of those read; null when its chains could not be read. */
|
|
29
|
+
expiries: { usable: number; read: number } | null;
|
|
30
|
+
/** What could not be read, said once: the proxy's history or its chains. */
|
|
31
|
+
error: string | null;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export interface FxVolProxyDependencies {
|
|
35
|
+
iv: ImpliedVolatilityApi;
|
|
36
|
+
surface: SurfaceLoaderDependencies;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
const CANCELLED = "FX volatility proxy load was cancelled";
|
|
40
|
+
const usableAtm = (value: number | null) => value != null && Number.isFinite(value) && value > 0;
|
|
41
|
+
|
|
42
|
+
/** The fund's 30-day IV on the close its rank is read on, else its newest reading with one. */
|
|
43
|
+
function proxyIv30(payload: IvHistoryPayload): FxVolProxy["iv30"] {
|
|
44
|
+
const ranked = payload.stats?.iv30;
|
|
45
|
+
if (ranked && Number.isFinite(ranked.value) && ranked.value > 0) return { value: ranked.value, date: ranked.date, method: ranked.method };
|
|
46
|
+
const row = [...payload.series ?? []].reverse().find((point) => usableAtm(point.iv30));
|
|
47
|
+
return row ? { value: row.iv30!, date: row.sessionDate, method: row.method } : null;
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
/** The fund's spot for its chains: the newest stored reading's. */
|
|
51
|
+
function proxySpot(payload: IvHistoryPayload): number | null {
|
|
52
|
+
if (payload.latest?.spot && payload.latest.spot > 0) return payload.latest.spot;
|
|
53
|
+
return [...payload.series ?? []].reverse().find((point) => point.spot != null && point.spot > 0)?.spot ?? null;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/** How many expiries read price an ATM IV that is not stale or failed. */
|
|
57
|
+
function usableExpiries(surface: SurfaceSnapshot): FxVolProxy["expiries"] {
|
|
58
|
+
if (!surface.expiries.length) return null;
|
|
59
|
+
return { usable: surface.expiries.filter((expiry) => usableAtm(expiry.atmIV) && !expiry.stale && !expiry.error).length,
|
|
60
|
+
read: surface.expiries.length };
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/** Null for a symbol that is no FX pair or currency future, or a pair no single fund stands in for. */
|
|
64
|
+
export async function loadFxVolProxy(
|
|
65
|
+
request: { symbol: string; exchange?: string; signal?: AbortSignal },
|
|
66
|
+
dependencies: FxVolProxyDependencies = { iv: apiClient, surface: createSurfaceDependencies() },
|
|
67
|
+
): Promise<FxVolProxy | null> {
|
|
68
|
+
const pair = fxVolatilityPair(request.symbol, request.exchange);
|
|
69
|
+
const fund = pair ? fxVolatilityProxyFund(pair) : null;
|
|
70
|
+
if (!pair || !fund) return null;
|
|
71
|
+
if (request.signal?.aborted) throw abortError(CANCELLED);
|
|
72
|
+
let payload: IvHistoryPayload;
|
|
73
|
+
try {
|
|
74
|
+
payload = await loadIvHistory(fund, { signal: request.signal, days: 40 }, dependencies.iv);
|
|
75
|
+
} catch (error) {
|
|
76
|
+
if (request.signal?.aborted) throw abortError(CANCELLED);
|
|
77
|
+
return { pair, fund, iv30: null, expiries: null, error: `${fund} IV history: ${errorMessage(error)}` };
|
|
78
|
+
}
|
|
79
|
+
const iv30 = proxyIv30(payload);
|
|
80
|
+
const spot = proxySpot(payload);
|
|
81
|
+
let expiries: FxVolProxy["expiries"] = null;
|
|
82
|
+
let error: string | null = null;
|
|
83
|
+
if (spot != null) {
|
|
84
|
+
try {
|
|
85
|
+
expiries = usableExpiries(await loadVolatilitySurface({ instrument: { symbol: fund }, spot, signal: request.signal }, dependencies.surface));
|
|
86
|
+
} catch (failure) {
|
|
87
|
+
if (request.signal?.aborted) throw abortError(CANCELLED);
|
|
88
|
+
error = `${fund} options: ${errorMessage(failure)}`;
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
return { pair, fund, iv30, expiries, error: error ?? (iv30 ? null : `${fund} has no IV30 yet`) };
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
/** The day of a bar, UTC. */
|
|
95
|
+
const barDay = (point: PricePoint) => new Date(point.date).toISOString().slice(0, 10);
|
|
96
|
+
|
|
97
|
+
export interface FxProxyReading {
|
|
98
|
+
/** The pair's close-to-close HV20 on the proxy's IV30 close; null when the IV30 is stale or missing. */
|
|
99
|
+
hv20: number | null;
|
|
100
|
+
/** IV30 less that HV20; null as HV20 is. */
|
|
101
|
+
spread: number | null;
|
|
102
|
+
/**
|
|
103
|
+
* The IV30 is over 5 of the fund's sessions behind the pair's last bar, as HIVG
|
|
104
|
+
* counts a stale reading: FXB's IV30 of 18 May beside a November cone.
|
|
105
|
+
*/
|
|
106
|
+
stale: boolean;
|
|
107
|
+
/** What a stale IV30 says: "FXB has no IV30 since 2026-05-18". */
|
|
108
|
+
note: string | null;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* The proxy's IV30 read against the pair: its age against the pair's last bar
|
|
113
|
+
* (stale over 5 sessions, iv-history's `staleness`), and while it is current,
|
|
114
|
+
* the pair's 20-bar realized volatility on the IV30's close and the IV30 less
|
|
115
|
+
* it, HIVG's IV30 - HV20 with the fund's IV against the pair's own moves.
|
|
116
|
+
* Close to close, whatever the pane's estimator, as HIVG reads it, and over
|
|
117
|
+
* the pair's year (`instrument`: 260 bars for USDJPY=X, 252 for 6J=F). A stale
|
|
118
|
+
* IV30 is no reading of the pair now: IV30 - HV20 is left out.
|
|
119
|
+
*/
|
|
120
|
+
export function fxProxyIvLessRv(proxy: FxVolProxy | null, history: readonly PricePoint[], instrument: BarsPerYearInstrument = {}): FxProxyReading {
|
|
121
|
+
if (!proxy?.iv30) return { hv20: null, spread: null, stale: false, note: null };
|
|
122
|
+
const through = proxy.iv30.date;
|
|
123
|
+
const lastBar = history.length ? history.map(barDay).sort().at(-1)! : null;
|
|
124
|
+
if (staleness(through, lastBar).stale) {
|
|
125
|
+
return { hv20: null, spread: null, stale: true, note: `${proxy.fund} has no IV30 since ${through}` };
|
|
126
|
+
}
|
|
127
|
+
const upTo = history.filter((point) => barDay(point) <= through);
|
|
128
|
+
const hv20 = upTo.length ? realizedVolatilityResult(upTo, 20, "close-to-close", instrument).value : null;
|
|
129
|
+
return { hv20, spread: hv20 == null ? null : proxy.iv30.value - hv20, stale: false, note: null };
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
/** "FXY IV30", the label the proxy reads under in the pane, the chart legend and the report. */
|
|
133
|
+
export const fxProxyLabel = (proxy: Pick<FxVolProxy, "fund">) => `${proxy.fund} IV30`;
|
|
134
|
+
/** What the proxy is, said once: "FXY options, a thin ETF proxy". */
|
|
135
|
+
export const fxProxyNote = (proxy: Pick<FxVolProxy, "fund">) => `${proxy.fund} options, a thin ETF proxy`;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { barsPerYearLabel } from "../../../market-data/bars-per-year";
|
|
1
|
+
import { barsPerYearLabel, currencyPairInstrument } from "../../../market-data/bars-per-year";
|
|
2
2
|
import type { HeadlessPaneDefinition } from "../../../types/plugin";
|
|
3
3
|
import { createSurfaceDependencies } from "../vol-surface/client";
|
|
4
4
|
import { resolveHeadlessInstrument } from "../shared/headless-market-data";
|
|
@@ -7,6 +7,30 @@ import { atmIvObservedLabel, projectRealizedVolatility, type CurrentAtmIvSnapsho
|
|
|
7
7
|
import { ESTIMATOR_OPTIONS, selectedWindows } from "./settings";
|
|
8
8
|
import { DAILY_CLOSES } from "../shared/report-freshness";
|
|
9
9
|
import { listingAbroadVenue } from "../../../utils/sec";
|
|
10
|
+
import { fxVolatilityPair } from "../../../market-data/options-alternatives";
|
|
11
|
+
import { fxProxyIvLessRv, fxProxyLabel, fxProxyNote, loadFxVolProxy, type FxProxyReading, type FxVolProxy } from "./fx-proxy";
|
|
12
|
+
import type { HeadlessBundleSection } from "../../../types/headless";
|
|
13
|
+
|
|
14
|
+
const percent = (value: number | null | undefined) => value == null ? "--" : `${(value * 100).toFixed(2)}%`;
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* An FX pair's IV section: the fund whose options stand in, its IV30 and the
|
|
18
|
+
* close it is from, how many of its expiries price, and IV30 less the pair's
|
|
19
|
+
* HV20 on that close. There is no ATM IV of the pair's own to show.
|
|
20
|
+
*/
|
|
21
|
+
function fxProxySection(proxy: FxVolProxy, reading: FxProxyReading): HeadlessBundleSection {
|
|
22
|
+
const { hv20, spread, stale } = reading;
|
|
23
|
+
return { title: "FX vol proxy", entries: [
|
|
24
|
+
{ label: "Proxy", value: proxy.fund, formatted: fxProxyNote(proxy) },
|
|
25
|
+
{ label: fxProxyLabel(proxy), value: proxy.iv30?.value ?? null, formatted: percent(proxy.iv30?.value) },
|
|
26
|
+
{ label: "Close", value: proxy.iv30?.date ?? null,
|
|
27
|
+
formatted: proxy.iv30 ? `${proxy.iv30.date}${proxy.iv30.method === "quote-mid" ? " (quote mid)" : ""}${stale ? ", stale" : ""}` : "--" },
|
|
28
|
+
{ label: "Expiries with ATM IV", value: proxy.expiries?.usable ?? null,
|
|
29
|
+
formatted: proxy.expiries ? `${proxy.expiries.usable} of ${proxy.expiries.read}` : "--" },
|
|
30
|
+
{ label: "Pair HV20", value: hv20, formatted: percent(hv20) },
|
|
31
|
+
{ label: "IV30 - HV20", value: spread, formatted: spread == null ? "--" : `${spread >= 0 ? "+" : ""}${(spread * 100).toFixed(2)} pts` },
|
|
32
|
+
] };
|
|
33
|
+
}
|
|
10
34
|
|
|
11
35
|
export function realizedVolHeadless(initialView: "graph" | "cone"): HeadlessPaneDefinition<"bundle"> {
|
|
12
36
|
return {
|
|
@@ -30,8 +54,10 @@ export function realizedVolHeadless(initialView: "graph" | "cone"): HeadlessPane
|
|
|
30
54
|
const instrument = await resolveHeadlessInstrument(ctx, args.symbols[0]!);
|
|
31
55
|
// Options are US listings'; SAN:EPA has none, and bare SAN's chain is another company's.
|
|
32
56
|
const abroad = listingAbroadVenue(args.symbols[0]!) != null;
|
|
57
|
+
// An FX pair or currency future has no chain of its own: a currency fund's options stand in, labelled so.
|
|
58
|
+
const fx = fxVolatilityPair(instrument.symbol, instrument.exchange) != null;
|
|
33
59
|
const currentIv = async (): Promise<CurrentAtmIvSnapshot | null> => {
|
|
34
|
-
if (!args.options.showIv) return null;
|
|
60
|
+
if (!args.options.showIv || fx) return null;
|
|
35
61
|
if (abroad) return { reference: null, error: null, warnings: [], noOptionChain: true };
|
|
36
62
|
try {
|
|
37
63
|
const quote = await ctx.marketData.getQuote(instrument.symbol, instrument.exchange);
|
|
@@ -43,14 +69,19 @@ export function realizedVolHeadless(initialView: "graph" | "cone"): HeadlessPane
|
|
|
43
69
|
return { reference: null, warnings: [], error: `Current ATM IV: ${error instanceof Error ? error.message : String(error)}` };
|
|
44
70
|
}
|
|
45
71
|
};
|
|
46
|
-
const
|
|
72
|
+
const fxProxy = async (): Promise<FxVolProxy | null> => !args.options.showIv || !fx ? null
|
|
73
|
+
: loadFxVolProxy({ symbol: instrument.symbol, exchange: instrument.exchange, signal: ctx.signal },
|
|
74
|
+
{ iv: ctx.apiClient, surface: createSurfaceDependencies(ctx.marketData, ctx.apiClient) });
|
|
75
|
+
const [history, iv, proxy] = await Promise.all([
|
|
47
76
|
loadRealizedVolatilityHistory({ instrument, signal: ctx.signal }, createRealizedVolatilityDependencies(ctx.marketData)), currentIv(),
|
|
77
|
+
fxProxy(),
|
|
48
78
|
]);
|
|
49
79
|
ctx.signal.throwIfAborted();
|
|
50
|
-
const model = projectRealizedVolatility(history.history, { symbol: instrument.symbol,
|
|
80
|
+
const model = projectRealizedVolatility(history.history, { symbol: instrument.symbol, exchange: instrument.exchange,
|
|
51
81
|
estimator: ESTIMATOR_OPTIONS.find(({ value }) => value === args.options.estimator)?.value,
|
|
52
82
|
windows, lookbackYears: Number(args.options.lookbackYears) === 2 ? 2 : 1 });
|
|
53
83
|
const errors = [history.error, iv?.error].filter((value): value is string => !!value);
|
|
84
|
+
const proxyReading = proxy ? fxProxyIvLessRv(proxy, history.history, currencyPairInstrument(instrument.symbol, instrument.exchange)) : null;
|
|
54
85
|
// The cone rows are as of the last daily bar, not of when the report ran.
|
|
55
86
|
const lastBar = model.asOf && Number.isFinite(model.asOf.getTime()) ? model.asOf.toISOString().slice(0, 10) : null;
|
|
56
87
|
return {
|
|
@@ -65,7 +96,7 @@ export function realizedVolHeadless(initialView: "graph" | "cone"): HeadlessPane
|
|
|
65
96
|
{ key: "percentile", header: "Percentile", format: (value) => typeof value === "number" ? `${value.toFixed(1)}%` : "--" },
|
|
66
97
|
{ key: "sampleSize", header: "Samples" },
|
|
67
98
|
], rows: model.cone.map((row) => ({ ...row })) },
|
|
68
|
-
{ title: "Current IV", entries: [
|
|
99
|
+
...proxy && proxyReading ? [fxProxySection(proxy, proxyReading)] : fx ? [] : [{ title: "Current IV", entries: [
|
|
69
100
|
{ label: "ATM IV", value: iv?.reference?.value ?? null, formatted: iv?.reference ? `${(iv.reference.value * 100).toFixed(2)}%` : "--" },
|
|
70
101
|
{ label: "Expiry", value: iv?.reference?.expiration ?? null,
|
|
71
102
|
formatted: iv?.reference ? new Date(iv.reference.expiration * 1000).toISOString().slice(0, 10) : "--" },
|
|
@@ -74,15 +105,20 @@ export function realizedVolHeadless(initialView: "graph" | "cone"): HeadlessPane
|
|
|
74
105
|
// To the minute, as the pane reads it; the JSON keeps the chain's read time whole.
|
|
75
106
|
{ label: "Observed", value: iv?.reference?.date.toISOString() ?? null,
|
|
76
107
|
formatted: iv?.reference ? atmIvObservedLabel(iv.reference.date) : "--" },
|
|
77
|
-
] },
|
|
108
|
+
] }],
|
|
78
109
|
],
|
|
79
110
|
// A short history is whole: the windows it is too short for have no estimate yet, and the note says when it starts.
|
|
80
111
|
complete: model.cone.every((row) => row.current != null || model.shortWindows.includes(row.window))
|
|
81
112
|
&& model.warnings.length === 0 && !history.stale && errors.length === 0
|
|
82
|
-
&& (!args.options.showIv || iv?.reference != null || iv?.noOptionChain === true)
|
|
113
|
+
&& (!args.options.showIv || fx || iv?.reference != null || iv?.noOptionChain === true)
|
|
114
|
+
// A proxy IV30 over 5 sessions old is no current IV for the pair.
|
|
115
|
+
&& !proxyReading?.stale,
|
|
83
116
|
unavailableSymbols: model.history.length ? [] : [instrument.symbol], errors,
|
|
84
|
-
|
|
117
|
+
// A proxy that could not be read leaves the pair's own volatility whole: said, not failed.
|
|
118
|
+
notes: [barsPerYearLabel(model.barsPerYear), ...model.historyNote ? [model.historyNote] : [], ...proxy?.error ? [proxy.error] : [],
|
|
119
|
+
...proxyReading?.note ? [proxyReading.note] : []],
|
|
85
120
|
metadata: { unit: "decimal annualized volatility", annualization: model.barsPerYear, model, currentIv: iv,
|
|
121
|
+
...proxy ? { fxVolProxy: { ...proxy, ...proxyReading } } : {},
|
|
86
122
|
...(abroad && args.options.showIv ? { notices: [`Options data covers US listings only, so ${args.symbols[0]} has no current IV.`] } : {}),
|
|
87
123
|
source: history.source, stale: history.stale, fetchedAt: history.fetchedAt,
|
|
88
124
|
methodology: "docs/research-data.md#shared-volatility-calculations" },
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { barsPerYear, type BarsPerYear } from "../../../market-data/bars-per-year";
|
|
1
|
+
import { barsPerYear, currencyPairInstrument, type BarsPerYear } from "../../../market-data/bars-per-year";
|
|
2
2
|
import type { PricePoint } from "../../../types/financials";
|
|
3
3
|
import {
|
|
4
4
|
REALIZED_VOLATILITY_WINDOWS, realizedVolatilityCadenceIssue, realizedVolatilityResult, rollingRealizedVolatility, volatilityCone,
|
|
@@ -48,6 +48,8 @@ function windowsText(windows: readonly number[]): string {
|
|
|
48
48
|
|
|
49
49
|
export interface RealizedVolatilityProjectionOptions {
|
|
50
50
|
symbol: string;
|
|
51
|
+
/** The listing's exchange: a CCY listing is a currency pair, annualised at 260 bars as USDJPY=X is. */
|
|
52
|
+
exchange?: string;
|
|
51
53
|
estimator?: RealizedVolatilityEstimator;
|
|
52
54
|
lookbackYears?: 1 | 2;
|
|
53
55
|
windows?: readonly number[];
|
|
@@ -67,6 +69,8 @@ export function projectRealizedVolatility(
|
|
|
67
69
|
): RealizedVolatilityModel {
|
|
68
70
|
const estimator = options.estimator ?? "close-to-close";
|
|
69
71
|
const lookbackYears = options.lookbackYears === 2 ? 2 : 1;
|
|
72
|
+
// A currency pair's year is every weekday, however much of its history is loaded.
|
|
73
|
+
const instrument = currencyPairInstrument(options.symbol, options.exchange);
|
|
70
74
|
const windows = [...new Set(options.windows ?? REALIZED_VOLATILITY_WINDOWS)]
|
|
71
75
|
.filter((window) => REALIZED_VOLATILITY_WINDOWS.some((standard) => standard === window));
|
|
72
76
|
const warnings: string[] = [];
|
|
@@ -98,13 +102,13 @@ export function projectRealizedVolatility(
|
|
|
98
102
|
if (cadenceIssue) warnings.push(cadenceIssue);
|
|
99
103
|
const series = cadenceIssue
|
|
100
104
|
? history.map((point) => ({ date: point.date, values: Object.fromEntries(windows.map((window) => [window, null])) }))
|
|
101
|
-
: rollingRealizedVolatility(history, { windows, estimator });
|
|
102
|
-
const cone = volatilityCone(cadenceIssue ? [] : history, { estimator, lookbackYears });
|
|
105
|
+
: rollingRealizedVolatility(history, { windows, estimator, instrument });
|
|
106
|
+
const cone = volatilityCone(cadenceIssue ? [] : history, { estimator, lookbackYears, instrument });
|
|
103
107
|
const visible = history.filter((point) => point.date.getTime() > cutoff);
|
|
104
108
|
const visibleSeries = series.filter((point) => point.date.getTime() > cutoff);
|
|
105
109
|
if (history.length > 0 && history[0]!.date.getTime() > cutoff) shortLookback = true;
|
|
106
110
|
for (const window of history.length > 0 && !cadenceIssue ? REALIZED_VOLATILITY_WINDOWS : []) {
|
|
107
|
-
const result = realizedVolatilityResult(history, window, estimator);
|
|
111
|
+
const result = realizedVolatilityResult(history, window, estimator, instrument);
|
|
108
112
|
if (result.reason === "insufficient-history") shortWindows.push(window);
|
|
109
113
|
else if (result.reason) warnings.push(`HV${window} unavailable: ${result.reason.replaceAll("-", " ")}`);
|
|
110
114
|
}
|
|
@@ -122,7 +126,7 @@ export function projectRealizedVolatility(
|
|
|
122
126
|
? `${windowsText(shortWindows)} need${shortWindows.length === 1 ? "s" : ""} more`
|
|
123
127
|
: "the long windows' cone covers part of the lookback"}`;
|
|
124
128
|
return { symbol: options.symbol.trim().toUpperCase(), estimator, lookbackYears, windows,
|
|
125
|
-
history: visible, series: visibleSeries, cone, asOf, barsPerYear: barsPerYear(history.map((point) => point.date)),
|
|
129
|
+
history: visible, series: visibleSeries, cone, asOf, barsPerYear: barsPerYear(history.map((point) => point.date), instrument),
|
|
126
130
|
warnings: [...new Set(warnings)], shortWindows, historyNote, formingNote };
|
|
127
131
|
}
|
|
128
132
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
|
|
2
2
|
import { DataTableView, EmptyState, PaneStatusBody, QueryBar, StatGrid, statGridRows, useChartTableSelection, usePaneFooter, usePaneNoticeFooter, usePaneTabs,
|
|
3
3
|
usePaneTicker, type DataTableColumn, type StatItem } from "../../../components";
|
|
4
|
-
import { barsPerYearLabel } from "../../../market-data/bars-per-year";
|
|
4
|
+
import { barsPerYearLabel, currencyPairInstrument } from "../../../market-data/bars-per-year";
|
|
5
5
|
import { instrumentFromTicker, quoteSubscriptionTargetFromTicker } from "../../../market-data/request-types";
|
|
6
6
|
import { useQuoteUpdates } from "../../../state/hooks/quote-streaming";
|
|
7
7
|
import { useAsyncResource } from "../../../react/async-resource";
|
|
@@ -24,11 +24,14 @@ import { coneWindowDate } from "./chart-model";
|
|
|
24
24
|
import type { RealizedVolEvidenceStatus } from "./evidence";
|
|
25
25
|
import { DEFAULT_WINDOWS, ESTIMATOR_OPTIONS, selectedWindows } from "./settings";
|
|
26
26
|
import { priceSeriesUnit } from "../../../market-data/market/index-level";
|
|
27
|
+
import { fxVolatilityPair } from "../../../market-data/options-alternatives";
|
|
28
|
+
import { fxProxyIvLessRv, fxProxyLabel, fxProxyNote, loadFxVolProxy } from "./fx-proxy";
|
|
27
29
|
|
|
28
30
|
/** In session, while visible, the current ATM IV reference re-reads its expiry this often. */
|
|
29
31
|
const ATM_IV_REFRESH_MS = 60_000;
|
|
30
32
|
const TABS = [{ value: "graph", label: "History" }, { value: "cone", label: "Cone" }];
|
|
31
33
|
const percent = (value: number | null | undefined) => value == null ? "--" : `${(value * 100).toFixed(2)}%`;
|
|
34
|
+
const points = (value: number) => `${value >= 0 ? "+" : ""}${(value * 100).toFixed(2)}`;
|
|
32
35
|
const NO_CONE: VolatilityConeStatistics[] = [];
|
|
33
36
|
const coneRowId = (row: VolatilityConeStatistics) => String(row.window);
|
|
34
37
|
const coneRowDate = (row: VolatilityConeStatistics) => coneWindowDate(row.window);
|
|
@@ -56,6 +59,8 @@ export function RealizedVolPane({ width, height, focused }: PaneProps) {
|
|
|
56
59
|
const windows = useMemo(() => selectedWindows(windowValue), [windowValue]);
|
|
57
60
|
const instrument = instrumentFromTicker(ticker, symbol);
|
|
58
61
|
const instrumentKey = JSON.stringify(instrument);
|
|
62
|
+
// An FX pair or currency future has no chain: a currency fund's IV30 stands in for its ATM IV, labelled as a thin proxy.
|
|
63
|
+
const fxPair = !!symbol && fxVolatilityPair(symbol, instrument?.exchange) != null;
|
|
59
64
|
const historyController = useRef<AbortController | null>(null);
|
|
60
65
|
const ivController = useRef<AbortController | null>(null);
|
|
61
66
|
const historyLoader = useCallback(async (force: boolean) => {
|
|
@@ -78,12 +83,22 @@ export function RealizedVolPane({ width, height, focused }: PaneProps) {
|
|
|
78
83
|
return loadCurrentAtmIv({ instrument: instrument!, spot: currentQuote.price, spotAsOf: currentQuote.lastUpdated,
|
|
79
84
|
forceRefresh: force, signal: controller.signal });
|
|
80
85
|
}, [instrumentKey, spotAvailable]);
|
|
86
|
+
const proxyController = useRef<AbortController | null>(null);
|
|
87
|
+
const proxyLoader = useCallback(async () => {
|
|
88
|
+
proxyController.current?.abort();
|
|
89
|
+
const controller = new AbortController();
|
|
90
|
+
proxyController.current = controller;
|
|
91
|
+
return loadFxVolProxy({ symbol: instrument!.symbol, exchange: instrument!.exchange, signal: controller.signal });
|
|
92
|
+
}, [instrumentKey]);
|
|
81
93
|
const history = useAsyncResource(instrument ? historyLoader : null);
|
|
82
|
-
const loadedIv = useAsyncResource(instrument && showIv && spotAvailable ? ivLoader : null);
|
|
94
|
+
const loadedIv = useAsyncResource(instrument && showIv && spotAvailable && !fxPair ? ivLoader : null);
|
|
95
|
+
const proxy = useAsyncResource(instrument && showIv && fxPair ? proxyLoader : null);
|
|
83
96
|
useEffect(() => () => historyController.current?.abort(), [historyLoader]);
|
|
84
97
|
useEffect(() => () => ivController.current?.abort(), [ivLoader, showIv]);
|
|
98
|
+
useEffect(() => () => proxyController.current?.abort(), [proxyLoader, showIv]);
|
|
85
99
|
useAutoRefresh(history.updatedAt, history.load);
|
|
86
100
|
useAutoRefresh(loadedIv.updatedAt, loadedIv.load);
|
|
101
|
+
useAutoRefresh(proxy.updatedAt, proxy.load);
|
|
87
102
|
// The pane subscribes its own quote: the IV reference is fitted at the live
|
|
88
103
|
// price even when no other pane streams this ticker. The price is only
|
|
89
104
|
// sampled at each refresh, so the slow off-screen cadence is enough.
|
|
@@ -109,17 +124,24 @@ export function RealizedVolPane({ width, height, focused }: PaneProps) {
|
|
|
109
124
|
const refreshedCurrent = refreshedIv?.owner === ivLoader && refreshedIv.at > (loadedIv.updatedAt ?? 0) ? refreshedIv.data : null;
|
|
110
125
|
const iv = { ...loadedIv, data: refreshedCurrent ?? loadedIv.data };
|
|
111
126
|
ivDataRef.current = iv.data;
|
|
112
|
-
const ivRefresh = useLiveSessionRefresh(refreshIv, ATM_IV_REFRESH_MS, showIv && spotAvailable && !!iv.data?.reference && !loadedIv.loading,
|
|
127
|
+
const ivRefresh = useLiveSessionRefresh(refreshIv, ATM_IV_REFRESH_MS, showIv && spotAvailable && !fxPair && !!iv.data?.reference && !loadedIv.loading,
|
|
113
128
|
loadedIv.updatedAt);
|
|
129
|
+
const proxyData = showIv && fxPair ? proxy.data ?? null : null;
|
|
130
|
+
// The proxy's IV30 is a dated close: drawn on its session, as the ATM IV is on its observation.
|
|
131
|
+
const proxyPoint = proxyData?.iv30
|
|
132
|
+
? { value: proxyData.iv30.value, date: new Date(`${proxyData.iv30.date}T00:00:00Z`), label: fxProxyLabel(proxyData) } : null;
|
|
133
|
+
const proxySpread = useMemo(() => fxProxyIvLessRv(proxyData, history.data?.history ?? [],
|
|
134
|
+
currencyPairInstrument(instrument?.symbol, instrument?.exchange)), [proxyData, history.data, instrumentKey]);
|
|
114
135
|
const model = useMemo(() => history.data ? projectRealizedVolatility(history.data.history, {
|
|
115
|
-
symbol: history.data.symbol, estimator, windows, lookbackYears: Number(lookback) === 2 ? 2 : 1,
|
|
136
|
+
symbol: history.data.symbol, exchange: instrument?.exchange, estimator, windows, lookbackYears: Number(lookback) === 2 ? 2 : 1,
|
|
116
137
|
}) : null, [history.data, estimator, windows, lookback]);
|
|
117
138
|
const chartInput = useMemo(() => model ? { history: model.history, rolling: model.series, windows: model.windows,
|
|
118
|
-
priceUnit: priceSeriesUnit(quote?.currency ?? "", quote?.instrumentType, quote?.priceBasis), iv: showIv ? iv.data?.reference ??
|
|
119
|
-
[model, quote?.currency, quote?.instrumentType, quote?.priceBasis, showIv, iv.data]);
|
|
139
|
+
priceUnit: priceSeriesUnit(quote?.currency ?? "", quote?.instrumentType, quote?.priceBasis), iv: showIv ? iv.data?.reference ?? proxyPoint : null } : null,
|
|
140
|
+
[model, quote?.currency, quote?.instrumentType, quote?.priceBasis, showIv, iv.data, proxyPoint?.value, proxyPoint?.label, proxyPoint?.date.getTime()]);
|
|
120
141
|
const notices = [identityError, history.error, history.data?.error, iv.error, ivRefresh.error, iv.data?.error,
|
|
121
142
|
...(model?.warnings ?? []), model?.historyNote, model?.formingNote, ...(showIv ? iv.data?.warnings ?? [] : []),
|
|
122
|
-
...(showIv && symbol && !spotAvailable ? ["Current ATM IV unavailable: underlying quote is missing or stale"] : []),
|
|
143
|
+
...(showIv && symbol && !spotAvailable && !fxPair ? ["Current ATM IV unavailable: underlying quote is missing or stale"] : []),
|
|
144
|
+
proxy.error, proxyData?.error, proxySpread.note,
|
|
123
145
|
].filter((value): value is string => !!value);
|
|
124
146
|
usePaneNoticeFooter({ registrationId: "realized-vol-notices", notices: [...new Set(notices)], focused });
|
|
125
147
|
const cycleView = () => setView(view === "graph" ? "cone" : "graph");
|
|
@@ -131,7 +153,7 @@ export function RealizedVolPane({ width, height, focused }: PaneProps) {
|
|
|
131
153
|
// is the pane's own key.
|
|
132
154
|
usePaneRefreshKey(() => {
|
|
133
155
|
void history.reload();
|
|
134
|
-
if (showIv) void iv.reload();
|
|
156
|
+
if (showIv) void (fxPair ? proxy.reload() : iv.reload());
|
|
135
157
|
}, { focused });
|
|
136
158
|
usePaneFooter("realized-vol", () => ({ info: [
|
|
137
159
|
...(history.loading ? [{ id: "loading", parts: [{ text: "loading history", tone: "muted" as const }] }] : []),
|
|
@@ -141,11 +163,12 @@ export function RealizedVolPane({ width, height, focused }: PaneProps) {
|
|
|
141
163
|
}] }] : []),
|
|
142
164
|
...(model?.asOf ? [{ id: "date", parts: [{ text: model.asOf.toISOString().slice(0, 10), tone: "muted" as const }] }] : []),
|
|
143
165
|
...(showIv && iv.loading ? [{ id: "iv-loading", parts: [{ text: "loading ATM IV", tone: "muted" as const }] }] : []),
|
|
166
|
+
...(showIv && proxy.loading ? [{ id: "proxy-loading", parts: [{ text: "loading FX vol proxy", tone: "muted" as const }] }] : []),
|
|
144
167
|
], hints: [
|
|
145
168
|
{ id: "view", key: "v", label: "iew", onPress: cycleView },
|
|
146
169
|
{ id: "iv", key: "i", label: showIv ? "v off" : "v on", onPress: () => setShowIv(!showIv) },
|
|
147
170
|
...(symbol ? [{ id: "surface", key: "s", label: "urface", onPress: openSurface }] : []),
|
|
148
|
-
] }), [history.loading, history.data, model?.asOf, model?.barsPerYear, iv.loading, showIv, view, symbol, iv.data]);
|
|
171
|
+
] }), [history.loading, history.data, model?.asOf, model?.barsPerYear, iv.loading, proxy.loading, showIv, view, symbol, iv.data]);
|
|
149
172
|
// The cone's legend reads the selected row, or the last one when that window has none.
|
|
150
173
|
const legendWindow = view === "cone" && model?.cone.length
|
|
151
174
|
? (model.cone.find((row) => row.window === selected) ?? model.cone.at(-1)!).window : null;
|
|
@@ -154,12 +177,12 @@ export function RealizedVolPane({ width, height, focused }: PaneProps) {
|
|
|
154
177
|
role: "report-notice", label: "Chart window",
|
|
155
178
|
getMetadata: () => ({ text: `Chart legend: ${legendWindow}-bar window`, key: "legendWindow", value: legendWindow }),
|
|
156
179
|
} : null);
|
|
157
|
-
const ivErrors = showIv ? [...new Set([iv.error, ivRefresh.error, iv.data?.error, !iv.data?.reference ? "Current ATM IV unavailable" : null]
|
|
180
|
+
const ivErrors = showIv && !fxPair ? [...new Set([iv.error, ivRefresh.error, iv.data?.error, !iv.data?.reference ? "Current ATM IV unavailable" : null]
|
|
158
181
|
.filter((value): value is string => !!value))] : [];
|
|
159
182
|
const evidence: RealizedVolEvidenceStatus = {
|
|
160
183
|
symbol: model?.symbol ?? symbol ?? "", view: view === "cone" ? "cone" : "graph", estimator, legendWindow,
|
|
161
184
|
windows, lookbackYears: Number(lookback) === 2 ? 2 : 1, showIv, shortWindows: model?.shortWindows ?? [],
|
|
162
|
-
loading: history.loading || (showIv && iv.loading),
|
|
185
|
+
loading: history.loading || (showIv && (iv.loading || proxy.loading)),
|
|
163
186
|
stale: history.data?.stale ?? false, source: history.data?.source ?? null,
|
|
164
187
|
asOf: model?.asOf?.toISOString() ?? null,
|
|
165
188
|
errors: [...new Set([history.error, history.data?.error, ...(model?.warnings ?? []), ...ivErrors]
|
|
@@ -168,12 +191,23 @@ export function RealizedVolPane({ width, height, focused }: PaneProps) {
|
|
|
168
191
|
currentIv: showIv && iv.data?.reference ? { value: iv.data.reference.value * 100,
|
|
169
192
|
date: iv.data.reference.date.toISOString(), label: iv.data.reference.label,
|
|
170
193
|
source: iv.data.reference.source, expiration: iv.data.reference.expiration } : null,
|
|
194
|
+
...(fxPair ? { fxPair, proxyIv: showIv && proxyPoint && proxyData
|
|
195
|
+
? { fund: proxyData.fund, value: proxyPoint.value * 100, date: proxyPoint.date.toISOString() } : null,
|
|
196
|
+
proxyStale: showIv && proxySpread.stale } : {}),
|
|
171
197
|
};
|
|
172
198
|
const { strip: tabStrip, rows: tabRows } = usePaneTabs({ tabs: TABS, activeValue: view, onSelect: setView, focused, dense: true });
|
|
173
199
|
const reference = showIv ? iv.data?.reference ?? null : null;
|
|
174
|
-
// The cone has no IV line of its own, so the dated ATM IV it is read against sits above it
|
|
175
|
-
|
|
176
|
-
|
|
200
|
+
// The cone has no IV line of its own, so the dated ATM IV it is read against sits above it; for an FX pair,
|
|
201
|
+
// the proxy fund's IV30 with its close, how many of the fund's expiries price at the money, and IV30 less the pair's HV20.
|
|
202
|
+
const coneStats: StatItem[] = view !== "cone" || !model ? []
|
|
203
|
+
: reference ? [{ id: "atm-iv", label: "ATM IV", value: percent(reference.value), detail: `${Math.round(reference.daysToExpiry)}d` }]
|
|
204
|
+
: proxyData ? [
|
|
205
|
+
// A stale IV30 is marked here and said in the footer ("FXB has no IV30 since 2026-05-18").
|
|
206
|
+
{ id: "proxy-iv", label: fxProxyLabel(proxyData), value: percent(proxyData.iv30?.value), detail: proxyData.iv30?.date,
|
|
207
|
+
tone: proxySpread.stale ? "warning" : undefined },
|
|
208
|
+
{ id: "proxy-spread", label: "IV30 - HV20", value: proxySpread.spread == null ? "--" : points(proxySpread.spread), detail: "pts" },
|
|
209
|
+
{ id: "proxy-expiries", label: "Expiries with ATM IV", value: proxyData.expiries ? `${proxyData.expiries.usable} of ${proxyData.expiries.read}` : "--" },
|
|
210
|
+
] : [];
|
|
177
211
|
const contentHeight = Math.max(4, height - 1 - tabRows - statGridRows(coneStats, width));
|
|
178
212
|
// The table's selected window is the chart's cursor, so its legend reads that row's figures.
|
|
179
213
|
const coneSelection = useChartTableSelection({ rows: model?.cone ?? NO_CONE, getId: coneRowId, getDate: coneRowDate,
|
|
@@ -185,7 +219,7 @@ export function RealizedVolPane({ width, height, focused }: PaneProps) {
|
|
|
185
219
|
<QueryBar width={width} filters={[
|
|
186
220
|
{ id: "estimator", label: "Estimator", value: estimator, options: ESTIMATOR_OPTIONS, onChange: (value: string) => setEstimator(value as RealizedVolatilityEstimator) },
|
|
187
221
|
{ id: "lookback", label: "Lookback", value: String(lookback), options: [{ value: "1", label: "1Y" }, { value: "2", label: "2Y" }], onChange: setLookback },
|
|
188
|
-
]} meta={reference ? `ATM IV observed ${atmIvObservedLabel(reference.date)}` : "Annualized %"} />
|
|
222
|
+
]} meta={reference ? `ATM IV observed ${atmIvObservedLabel(reference.date)}` : proxyData ? fxProxyNote(proxyData) : "Annualized %"} />
|
|
189
223
|
{!symbol ? <EmptyState title="Select a ticker." /> : <PaneStatusBody subject="realized volatility" loading={history.loading && !model}
|
|
190
224
|
error={!model ? history.error ?? identityError ?? null : null} empty={!!model && !model.history.length}>
|
|
191
225
|
{model && view === "cone" ? <>
|
|
@@ -22,6 +22,10 @@ import { REPORT_ROWS } from "../shared/headless-options";
|
|
|
22
22
|
import { fundAbroadProfile, venueAbroad, type FundAbroadProfile } from "./fund-abroad";
|
|
23
23
|
import { listingAnnouncementsPage } from "../../../utils/exchange-announcements";
|
|
24
24
|
import { companyDataNotes } from "../../../types/company-from";
|
|
25
|
+
import {
|
|
26
|
+
analyzeTaxEquivalent, distributionBasis, loadTreasuryTenors, parseTaxRates, TAX_RATE_EXAMPLES, TAX_RATE_OPTIONS, taxEquivalentJson, taxEquivalentSection,
|
|
27
|
+
type TaxEquivalentAnalysis, type TreasuryTenor, type YieldBasis,
|
|
28
|
+
} from "../../../market-data/tax-equivalent";
|
|
25
29
|
|
|
26
30
|
const SEC_COLUMNS: HeadlessPaneColumn[] = [
|
|
27
31
|
{
|
|
@@ -163,11 +167,20 @@ export const secHeadless = createSecHeadless();
|
|
|
163
167
|
export interface FundHeadlessDependencies extends SecHeadlessDependencies {
|
|
164
168
|
loadFacts(symbol: string, ctx: HeadlessPaneContext): Promise<FundFactsPayload>;
|
|
165
169
|
loadAbroadProfile?(key: string, ctx: HeadlessPaneContext): Promise<FundAbroadProfile | null>;
|
|
170
|
+
/** With `--tax-rate`: the Treasury par curve GC shows, for the muni/Treasury ratio; null when it cannot be read. */
|
|
171
|
+
loadTreasury?(ctx: HeadlessPaneContext): Promise<TreasuryTenor[] | null>;
|
|
172
|
+
/** With `--tax-rate`, for a muni fund whose sponsor publishes no SEC yield: its distribution yield, as `fundamentals` states it. */
|
|
173
|
+
loadDistribution?(symbol: string, ctx: HeadlessPaneContext): Promise<YieldBasis | null>;
|
|
166
174
|
}
|
|
167
175
|
|
|
168
176
|
const defaultFundDependencies = {
|
|
169
177
|
...defaultDependencies,
|
|
170
178
|
loadFacts: (symbol: string, ctx: HeadlessPaneContext) => fetchFundFacts(symbol, ctx.apiClient),
|
|
179
|
+
loadTreasury: (ctx: HeadlessPaneContext) => loadTreasuryTenors(ctx.apiClient),
|
|
180
|
+
async loadDistribution(symbol: string, ctx: HeadlessPaneContext): Promise<YieldBasis | null> {
|
|
181
|
+
const fundamentals = (await ctx.marketData.getTickerFinancials(symbol, "")).fundamentals;
|
|
182
|
+
return distributionBasis(fundamentals?.dividendYield, fundamentals?.dividendYieldBasis === "trailing" ? "trailing" : "forward");
|
|
183
|
+
},
|
|
171
184
|
async loadAbroadProfile(key: string, ctx: HeadlessPaneContext): Promise<FundAbroadProfile | null> {
|
|
172
185
|
const { symbol, exchange } = parsePublicTickerKey(key);
|
|
173
186
|
return fundAbroadProfile(await ctx.marketData.getTickerFinancials(symbol, exchange));
|
|
@@ -232,7 +245,8 @@ export function createFundHeadless(dependencies: FundHeadlessDependencies = defa
|
|
|
232
245
|
return {
|
|
233
246
|
shape: "bundle",
|
|
234
247
|
freshness: { source: "Fund sponsors and SEC EDGAR", status: "not-a-feed", basis: "published fund data" },
|
|
235
|
-
argument: { kind: "ticker", placeholder: "ticker", description: "US-listed fund ticker. A fund listed abroad gets its issuer's page."
|
|
248
|
+
argument: { kind: "ticker", placeholder: "ticker", description: "US-listed fund ticker. A fund listed abroad gets its issuer's page.",
|
|
249
|
+
examples: TAX_RATE_EXAMPLES.slice(0, 2) },
|
|
236
250
|
options: [{
|
|
237
251
|
key: "limit",
|
|
238
252
|
shot: REPORT_ROWS,
|
|
@@ -242,30 +256,41 @@ export function createFundHeadless(dependencies: FundHeadlessDependencies = defa
|
|
|
242
256
|
defaultValue: 50,
|
|
243
257
|
minimum: 1,
|
|
244
258
|
maximum: 200,
|
|
245
|
-
}],
|
|
259
|
+
}, ...TAX_RATE_OPTIONS],
|
|
246
260
|
discovery: { limitations: ["Fund facts cover the sponsors Gloom collects; other funds point to their SEC filings."] },
|
|
247
261
|
describe: (args) => `ETF | ${args.symbols[0]}`,
|
|
248
262
|
async load(args, ctx) {
|
|
249
263
|
const symbol = args.symbols[0]!;
|
|
264
|
+
// Checked before anything is read: a state rate without its state is refused, not ignored.
|
|
265
|
+
const rates = parseTaxRates({ taxRate: args.options["tax-rate"], stateRate: args.options["state-rate"], state: args.options.state });
|
|
250
266
|
const abroad = venueAbroad(symbol);
|
|
251
267
|
if (abroad) {
|
|
268
|
+
// --tax-rate reads US tax on a US fund's income: a fund listed abroad says it does not apply rather than drop it.
|
|
269
|
+
const taxed = (result: HeadlessBundleResult): HeadlessBundleResult => {
|
|
270
|
+
if (!rates) return result;
|
|
271
|
+
const tax = analyzeTaxEquivalent({ symbol: symbol.toUpperCase(), bond: null, rates, noBondFigures: "listed-abroad" });
|
|
272
|
+
return { ...result, sections: [...result.sections, taxEquivalentSection(tax)],
|
|
273
|
+
metadata: { ...result.metadata, taxEquivalent: taxEquivalentJson(tax) } };
|
|
274
|
+
};
|
|
252
275
|
// A Hong Kong spot coin fund has its issuer's figures; any other fund abroad, or a server without them, keeps the issuer link.
|
|
253
276
|
const facts = hasFundFactsAbroad(abroad)
|
|
254
277
|
? await dependencies.loadFacts(symbol, ctx).catch(logFailure("sec.fund-headless", "Read fund facts abroad failed", null))
|
|
255
278
|
: null;
|
|
256
|
-
if (facts?.covered) return fundAbroadFactsResult(symbol, abroad, facts);
|
|
279
|
+
if (facts?.covered) return taxed(fundAbroadFactsResult(symbol, abroad, facts));
|
|
257
280
|
try {
|
|
258
281
|
const profile = await (dependencies.loadAbroadProfile ?? defaultFundDependencies.loadAbroadProfile)(symbol, ctx);
|
|
259
|
-
return fundAbroadResult(symbol, abroad, profile);
|
|
282
|
+
return taxed(fundAbroadResult(symbol, abroad, profile));
|
|
260
283
|
} catch (error) {
|
|
261
|
-
return {
|
|
284
|
+
return taxed({
|
|
262
285
|
...fundAbroadResult(symbol, abroad, null),
|
|
263
286
|
complete: false,
|
|
264
287
|
errors: [`Fund profile unavailable: ${errorMessage(error)}`],
|
|
265
|
-
};
|
|
288
|
+
});
|
|
266
289
|
}
|
|
267
290
|
}
|
|
268
291
|
const limit = Number(args.options.limit);
|
|
292
|
+
const treasury = rates ? (dependencies.loadTreasury ?? defaultFundDependencies.loadTreasury)(ctx)
|
|
293
|
+
.catch(logFailure("sec.fund-headless", "Read Treasury curve for tax-equivalent yield failed", null)) : null;
|
|
269
294
|
const [factsResult, filingsResult] = await Promise.allSettled([
|
|
270
295
|
dependencies.loadFacts(symbol, ctx),
|
|
271
296
|
dependencies.loadFilings(symbol, SEC_FILING_FETCH_LIMIT, args, ctx),
|
|
@@ -288,9 +313,25 @@ export function createFundHeadless(dependencies: FundHeadlessDependencies = defa
|
|
|
288
313
|
: fundFactsEmpty(symbol, facts, !filingsPointToSec) };
|
|
289
314
|
const publishers = facts?.covered ? fundFactPublishers(facts) : [];
|
|
290
315
|
const filingRows = buildSecFilingRows(filings);
|
|
316
|
+
// With --tax-rate, the section DVD and fundamentals show, on the sponsor's SEC yield (else the distribution yield).
|
|
317
|
+
let tax: TaxEquivalentAnalysis | null = null;
|
|
318
|
+
if (rates) {
|
|
319
|
+
const bond = facts?.covered ? facts.bond ?? null : null;
|
|
320
|
+
const distribution = bond?.kind === "municipal" && !bond.secYield
|
|
321
|
+
? await (dependencies.loadDistribution ?? defaultFundDependencies.loadDistribution)(symbol, ctx)
|
|
322
|
+
.catch(logFailure("sec.fund-headless", "Read distribution yield for tax-equivalent yield failed", null))
|
|
323
|
+
: null;
|
|
324
|
+
tax = analyzeTaxEquivalent({
|
|
325
|
+
symbol: symbol.toUpperCase(), bond, rates, distribution, treasury: await treasury,
|
|
326
|
+
...factsResult.status === "rejected" ? { checkError: `no tax-equivalent yield: ${fundFactsErrorText(factsResult.reason)}` } : {},
|
|
327
|
+
// A stock (fn ETF KO) is not on the SEC's lists of funds, and says so rather than that no bond figures are loaded.
|
|
328
|
+
noBondFigures: facts?.status === "not-a-fund" ? "not-a-fund" : null,
|
|
329
|
+
});
|
|
330
|
+
}
|
|
291
331
|
return {
|
|
292
332
|
sections: [
|
|
293
333
|
factsSection,
|
|
334
|
+
...tax ? [taxEquivalentSection(tax)] : [],
|
|
294
335
|
{ title: "Fund filings", columns: SEC_COLUMNS, textColumns: fundFilingTextColumns(filingRows), rows: filingRows, ...(filings.length === 0 ? { empty: filingsEmpty } : {}) },
|
|
295
336
|
],
|
|
296
337
|
complete: !!facts?.covered && filingsResult.status === "fulfilled" && searchedAll,
|
|
@@ -316,6 +357,7 @@ export function createFundHeadless(dependencies: FundHeadlessDependencies = defa
|
|
|
316
357
|
forms: [...ETF_FILING_FORMS],
|
|
317
358
|
searchedFilings: issuerFilings.length,
|
|
318
359
|
issuers: secFilingIssuers(filings),
|
|
360
|
+
...tax ? { taxEquivalent: taxEquivalentJson(tax) } : {},
|
|
319
361
|
},
|
|
320
362
|
};
|
|
321
363
|
},
|
|
@@ -24,7 +24,7 @@ import { publicTickerKey } from "../../../utils/exchanges";
|
|
|
24
24
|
import { fundFactsAbroadKey, hasFundFactsAbroad, mayBeFundViewTicker, mayBeUsEquityOrFundTicker, mayBeUsEquityTicker, secFilingItemCodes, US_FUND_FACTS_ONLY } from "../../../utils/sec";
|
|
25
25
|
import { fundAbroadProfile, venueAbroad, type FundAbroadProfile } from "./fund-abroad";
|
|
26
26
|
import { listingAnnouncementsPage } from "../../../utils/exchange-announcements";
|
|
27
|
-
import { pricingSupplementTest } from "../../../utils/sec-filings";
|
|
27
|
+
import { form4TradeText, isOtherIssuerForm4, pricingSupplementTest } from "../../../utils/sec-filings";
|
|
28
28
|
import { formatInsiderName } from "../insider/display";
|
|
29
29
|
import { parseForm4Xml } from "../insider/insider-data";
|
|
30
30
|
import { createTickerSurfacePaneTemplate } from "../shared/ticker-surface";
|
|
@@ -217,13 +217,15 @@ function toFeedItems(
|
|
|
217
217
|
const enrichedTitle = formDesc
|
|
218
218
|
? `${displayTitle} — ${formDesc}`
|
|
219
219
|
: displayTitle;
|
|
220
|
-
|
|
220
|
+
// A Form 4 the company filed as an owner of another company's shares names that company only in its trade.
|
|
221
|
+
const summary = (isOtherIssuerForm4(filing) ? form4TradeText(filing) : null) ?? readSummary?.title ?? getFilingColumnText(filing);
|
|
222
|
+
const direction = readSummary?.direction ?? (filing.form4?.side === "buy" || filing.form4?.side === "sell" ? filing.form4.side : null);
|
|
221
223
|
const items = secFilingItemCodes(filing.items);
|
|
222
224
|
const facts: DetailFact[] = [
|
|
223
225
|
{ label: "Issuer", value: filing.companyName || "Name unavailable" },
|
|
224
226
|
...(issuerTicker ? [{ label: "Ticker", value: issuerTicker.symbol, link: { label: `Open ${issuerTicker.symbol}`, onOpen: issuerTicker.open } }] : []),
|
|
225
227
|
{ label: "CIK", value: filing.cik },
|
|
226
|
-
{ label: "Form", value: formDesc ? `${filing.form} · ${formDesc}` : filing.form, color: toneColor(filingTone(filing,
|
|
228
|
+
{ label: "Form", value: formDesc ? `${filing.form} · ${formDesc}` : filing.form, color: toneColor(filingTone(filing, direction), colors) },
|
|
227
229
|
{ label: "Filed", value: formatFiledAt(filing) },
|
|
228
230
|
...(acceptedAt ? [{ label: "SEC-reported acceptance", value: acceptedAt }] : []),
|
|
229
231
|
...(items ? [{ label: "Items", value: items }] : []),
|
|
@@ -233,7 +235,7 @@ function toFeedItems(
|
|
|
233
235
|
return {
|
|
234
236
|
id: filing.accessionNumber,
|
|
235
237
|
eyebrow: filing.form,
|
|
236
|
-
eyebrowColor: toneColor(filingTone(filing,
|
|
238
|
+
eyebrowColor: toneColor(filingTone(filing, direction), colors),
|
|
237
239
|
// A ticker shared by several filers names the filer on each row.
|
|
238
240
|
title: showIssuer && filing.companyName ? `${filing.companyName}: ${summary}` : summary,
|
|
239
241
|
timestamp: filing.filingDate,
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { SecFilingItem } from "../../../types/data-provider";
|
|
2
2
|
import { secFilingItemCodes } from "../../../utils/sec";
|
|
3
|
-
import { currentReportItemNames, isCurrentReportForm as isCurrentReport } from "../../../utils/sec-filings";
|
|
3
|
+
import { currentReportItemNames, form4TradeText, isCurrentReportForm as isCurrentReport } from "../../../utils/sec-filings";
|
|
4
4
|
|
|
5
5
|
function getDisplayFormLabel(form: string): string {
|
|
6
6
|
const trimmed = form.trim();
|
|
@@ -66,6 +66,9 @@ function periodicReportPeriod(filing: Pick<SecFilingItem, "form" | "primaryDocum
|
|
|
66
66
|
|
|
67
67
|
/** The adjacent FORM column already identifies the form. Keep its meaning here: what the filing reports. */
|
|
68
68
|
export function getFilingColumnText(filing: SecFilingItem): string {
|
|
69
|
+
// A Form 4 Gloom Cloud read says its trade, and whose shares when they are another company's.
|
|
70
|
+
const trade = form4TradeText(filing);
|
|
71
|
+
if (trade) return trade;
|
|
69
72
|
const description = getMeaningfulPrimaryDescription(filing);
|
|
70
73
|
const meaning = getFormDescription(filing.form);
|
|
71
74
|
if (!description) {
|