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
|
@@ -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
|
|
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.
|
|
22
|
-
* CMF 3.87% at 40.8% + 13.3% California: 8.43%). The ratio
|
|
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
|
-
/**
|
|
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:
|
|
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:
|
|
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.
|
|
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"} ${
|
|
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.
|
|
261
|
-
* Muni/Treasury ratio 81.0% (SEC yield 4.
|
|
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
|
-
|
|
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} ${
|
|
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
|
-
|
|
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: `${
|
|
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,
|
|
310
|
-
|
|
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;
|
|
@@ -19,7 +19,7 @@ import { displayWidth } from "../../../utils/format";
|
|
|
19
19
|
import { useChartQueries, useFxRatesMap } from "../../../market-data/hooks";
|
|
20
20
|
import { buildPortfolioFinancialsMap } from "../../../market-data/portfolio-financials";
|
|
21
21
|
import { useLiveTickerFinancialsMap, useSampledValue } from "../../../state/hooks/live-ticker-financials";
|
|
22
|
-
import { blendHex, colors } from "../../../theme/colors";
|
|
22
|
+
import { blendHex, colors, placeholderText } from "../../../theme/colors";
|
|
23
23
|
import type { PaneProps } from "../../../types/plugin";
|
|
24
24
|
import {
|
|
25
25
|
Box,
|
|
@@ -936,7 +936,7 @@ export function AccountManagementPane({ focused, width, height }: PaneProps) {
|
|
|
936
936
|
placeholder={t("Short profile bio")}
|
|
937
937
|
focused={focused && activeField === "bio"}
|
|
938
938
|
textColor={colors.text}
|
|
939
|
-
placeholderColor={
|
|
939
|
+
placeholderColor={placeholderText()}
|
|
940
940
|
backgroundColor={nativePaneChrome ? "transparent" : colors.panel}
|
|
941
941
|
flexGrow={1}
|
|
942
942
|
wrapText
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { metricDescription, readAlertMetric, validMetricRule } from "./metric-model";
|
|
2
2
|
import type { AlertCondition, AlertRule } from "./types";
|
|
3
3
|
import { alertListing } from "./format";
|
|
4
|
-
import {
|
|
4
|
+
import { alertListingKey, alertPriceText } from "./price-text";
|
|
5
|
+
import { moveRuleWords } from "./move";
|
|
5
6
|
import { logFailure } from "../../../utils/log-failure";
|
|
6
7
|
|
|
7
8
|
export type { AlertRule };
|
|
@@ -43,6 +44,7 @@ export function editAlert(
|
|
|
43
44
|
// The listing's currency and venue stay with it; a new symbol learns its own at its first check.
|
|
44
45
|
...(sameListing && alert.lastQuoteCurrency ? { lastQuoteCurrency: alert.lastQuoteCurrency } : {}),
|
|
45
46
|
...(sameListing && alert.lastQuoteExchange ? { lastQuoteExchange: alert.lastQuoteExchange } : {}),
|
|
47
|
+
...(sameListing && alert.lastQuotePence ? { lastQuotePence: alert.lastQuotePence } : {}),
|
|
46
48
|
condition,
|
|
47
49
|
targetPrice,
|
|
48
50
|
createdAt: alert.createdAt,
|
|
@@ -50,6 +52,8 @@ export function editAlert(
|
|
|
50
52
|
status: "active",
|
|
51
53
|
message: alert.message,
|
|
52
54
|
...(alert.metric ? { metric: alert.metric } : {}),
|
|
55
|
+
// A move rule stays one; the session it went off in is dropped, so it can go off again.
|
|
56
|
+
...(alert.move ? { move: true } : {}),
|
|
53
57
|
};
|
|
54
58
|
}
|
|
55
59
|
|
|
@@ -63,15 +67,15 @@ export function rearmAlert(alert: AlertRule): AlertRule {
|
|
|
63
67
|
* from the symbol alone. A second add of one names the first and adds nothing.
|
|
64
68
|
*/
|
|
65
69
|
export function sameLevelRule(a: AlertRule, b: AlertRule): boolean {
|
|
66
|
-
|
|
67
|
-
return a
|
|
68
|
-
&& (venue(a) === venue(b) || alertListing(a) === alertListing(b))
|
|
70
|
+
// One key per listing: 7203.T, `7203 JP` and 7203:JPX are one listing, as is AAPL read on NASDAQ.
|
|
71
|
+
return alertListingKey(a) === alertListingKey(b) && !!a.move === !!b.move
|
|
69
72
|
&& a.condition === b.condition && a.targetPrice === b.targetPrice
|
|
70
73
|
&& JSON.stringify(readAlertMetric(a.metric)) === JSON.stringify(readAlertMetric(b.metric));
|
|
71
74
|
}
|
|
72
75
|
|
|
73
76
|
export function evaluateAlert(alert: AlertRule, currentPrice: number): boolean {
|
|
74
|
-
|
|
77
|
+
// A move from the previous close is judged on the quote's move (`judgeMove`), never on its price.
|
|
78
|
+
if (alert.metric || alert.move || alert.status !== "active") return false;
|
|
75
79
|
|
|
76
80
|
switch (alert.condition) {
|
|
77
81
|
case "above":
|
|
@@ -91,9 +95,11 @@ export function evaluateAlert(alert: AlertRule, currentPrice: number): boolean {
|
|
|
91
95
|
|
|
92
96
|
export function formatAlertDescription(alert: AlertRule): string {
|
|
93
97
|
if (alert.metric) return metricDescription(alert);
|
|
98
|
+
if (alert.move) return `${alertListing({ symbol: alert.symbol, exchange: alert.exchange })} ${moveRuleWords(alert)} from the previous close`;
|
|
94
99
|
const prefix = alert.condition === "above" ? ">"
|
|
95
100
|
: alert.condition === "below" ? "<" : "↕";
|
|
96
|
-
|
|
101
|
+
// The listing as it was kept (7203:JPX, AAPL), its target at the instrument's precision (1.33750, 70.00p).
|
|
102
|
+
return `${alertListing({ symbol: alert.symbol, exchange: alert.exchange })} ${prefix} ${alertPriceText(alert, alert.targetPrice)}`;
|
|
97
103
|
}
|
|
98
104
|
|
|
99
105
|
export function serializeAlerts(alerts: AlertRule[]): string {
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
import { moveRuleWords } from "./move";
|
|
2
|
+
import { alertPriceText } from "./price-text";
|
|
1
3
|
import { metricDescription } from "./metric-model";
|
|
2
4
|
import { eventAlertTarget, type EventAlertRule } from "./events";
|
|
3
5
|
import { alertChangeEntry, appendFiredAlert, readFiredAlerts, type AlertLogAction, type FiredAlert } from "./fired-log";
|
|
@@ -13,8 +15,10 @@ import type { AlertRule } from "./types";
|
|
|
13
15
|
export function alertLogRule(rule: AlertRule | EventAlertRule) {
|
|
14
16
|
if ("symbol" in rule) {
|
|
15
17
|
return {
|
|
16
|
-
kind: rule.metric?.kind ?? "price", ruleId: rule.id,
|
|
17
|
-
rule: rule.metric ? metricDescription(rule) : `${alertListing(rule)} ${rule
|
|
18
|
+
kind: rule.metric?.kind ?? (rule.move ? "move" : "price"), ruleId: rule.id,
|
|
19
|
+
rule: rule.metric ? metricDescription(rule) : rule.move ? `${alertListing(rule)} ${moveRuleWords(rule)}`
|
|
20
|
+
// The level at its instrument's precision and in its unit: below 1.33750, below 70.00p.
|
|
21
|
+
: `${alertListing(rule)} ${rule.condition} ${alertPriceText(rule, rule.targetPrice).replaceAll(",", "")}`,
|
|
18
22
|
symbol: rule.symbol, ...rule.exchange ? { exchange: rule.exchange } : {},
|
|
19
23
|
};
|
|
20
24
|
}
|
|
@@ -3,7 +3,9 @@
|
|
|
3
3
|
// release's rows as the calendar's feeds name it from week to week, and the
|
|
4
4
|
// notifications sent before it and once its figures are out. CPI and FOMC are
|
|
5
5
|
// two cases of the same alert, whose dates come from their own calendars.
|
|
6
|
-
import {
|
|
6
|
+
import {
|
|
7
|
+
dateKey, econEventName, eventCountry, eventSearchNames, eventSeriesId, matchesCountry, matchesEventSearch, type CountryFilter,
|
|
8
|
+
} from "../econ/calendar-model";
|
|
7
9
|
import { isAllDayEvent, hasNoReleaseTime, type EconEvent, type EconImpact } from "../econ/types";
|
|
8
10
|
import { RENAMED_RELEASES } from "../shared/macro-releases";
|
|
9
11
|
import { MACRO_EVENT_NAMES } from "./research-builder";
|
|
@@ -130,8 +132,25 @@ type RankedChoice = CalendarEventChoice & {
|
|
|
130
132
|
words: string[];
|
|
131
133
|
/** The words of the name `econ` shows it under, when that is not the feed's (the Fed's rate as its upper bound). */
|
|
132
134
|
shownWords: string[];
|
|
135
|
+
/** The words of every name the release is listed under (Non Farm Payrolls and Non-Farm Employment Change). */
|
|
136
|
+
names: string[][];
|
|
137
|
+
/** Its rows, which `econ --search` reads by their names, ECST's names for their series and their publisher. */
|
|
138
|
+
rows: EconEvent[];
|
|
133
139
|
};
|
|
134
140
|
|
|
141
|
+
/** The qualifier words a name carries (prelim, core, flash): two names of one series that differ in them are two releases. */
|
|
142
|
+
const qualifierWords = (words: readonly string[]) => words.filter((word) => SERIES_QUALIFIERS.has(word)).sort().join(" ");
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* The series a row is a release of, with its qualifiers, so one release
|
|
146
|
+
* listed under two names is one (Non Farm Payrolls one month, Non-Farm
|
|
147
|
+
* Employment Change the next); null for a row of no known series.
|
|
148
|
+
*/
|
|
149
|
+
function releaseSeriesKey(event: Pick<EconEvent, "country" | "event">): string | null {
|
|
150
|
+
const series = eventSeriesId(event);
|
|
151
|
+
return series ? `${eventCountry(event)}|series:${series}|${qualifierWords(calendarNameWords(event.event))}` : null;
|
|
152
|
+
}
|
|
153
|
+
|
|
135
154
|
/**
|
|
136
155
|
* The calendar's releases, one per country and name, each with its next row
|
|
137
156
|
* still to come at `now`, named as that row (or the latest one) names it.
|
|
@@ -141,7 +160,7 @@ function calendarChoices(events: readonly EconEvent[], now: number): RankedChoic
|
|
|
141
160
|
for (const event of [...events].sort((left, right) => left.date.getTime() - right.date.getTime())) {
|
|
142
161
|
const words = calendarNameWords(event.event);
|
|
143
162
|
if (words.length === 0) continue;
|
|
144
|
-
const key = `${eventCountry(event)}|${words.join(" ")}`;
|
|
163
|
+
const key = releaseSeriesKey(event) ?? `${eventCountry(event)}|${words.join(" ")}`;
|
|
145
164
|
groups.set(key, [...groups.get(key) ?? [], event]);
|
|
146
165
|
}
|
|
147
166
|
return [...groups.values()].map((rows) => {
|
|
@@ -155,6 +174,8 @@ function calendarChoices(events: readonly EconEvent[], now: number): RankedChoic
|
|
|
155
174
|
next,
|
|
156
175
|
words: calendarNameWords(named.event),
|
|
157
176
|
shownWords: calendarNameWords(econEventName(named)),
|
|
177
|
+
names: [...new Set(rows.map((event) => nameKey(event.event)))].map((name) => name.split(" ")),
|
|
178
|
+
rows,
|
|
158
179
|
};
|
|
159
180
|
});
|
|
160
181
|
}
|
|
@@ -251,14 +272,18 @@ function matchCalendarWords(
|
|
|
251
272
|
now: number,
|
|
252
273
|
): CalendarEventMatch {
|
|
253
274
|
const choices = calendarChoices(country ? events.filter((event) => matchesCountry(event, country)) : events, now);
|
|
254
|
-
// The name as
|
|
255
|
-
const exact = choices.filter((choice) => [choice.
|
|
256
|
-
const naming = (typed: readonly string[], loose: boolean) => typed.length === 0 ? [] : choices.filter((choice) =>
|
|
257
|
-
typed.every((word) => loose ? wordFound(word,
|
|
275
|
+
// The name as a feed gives it, or as `econ` shows it: the alert keeps the feed's, which the calendar's rows carry.
|
|
276
|
+
const exact = choices.filter((choice) => [...choice.names, choice.shownWords].some((name) => name.join(" ") === words.join(" ")));
|
|
277
|
+
const naming = (typed: readonly string[], loose: boolean) => typed.length === 0 ? [] : choices.filter((choice) => choice.names.some((name) =>
|
|
278
|
+
typed.every((word) => loose ? wordFound(word, name) : name.includes(word))));
|
|
258
279
|
// CPI by the name one feed gives it everywhere but the US (China's Inflation Rate YoY).
|
|
259
280
|
const aliased = words.flatMap((word) => QUERY_ALIASES[word] ?? [word]);
|
|
260
281
|
const typed = exact.length > 0 ? exact : naming(words, words.length > 1);
|
|
261
|
-
const
|
|
282
|
+
const worded = typed.length > 0 || aliased.join(" ") === words.join(" ") ? typed : naming(aliased, false);
|
|
283
|
+
// As `econ --search` finds it, by ECST's names for its series too: NFP, nonfarm payrolls and the jobs report are
|
|
284
|
+
// Non-Farm Employment Change. A name typed in full is that release; words read either way rank together.
|
|
285
|
+
const searched = exact.length > 0 ? [] : searchedChoices(words, choices);
|
|
286
|
+
const named = [...new Set([...worded, ...searched])];
|
|
262
287
|
if (named.length === 0) {
|
|
263
288
|
// Each typed word a slip from one of the name's (NBP PMI), or the name as a whole near what was typed.
|
|
264
289
|
const slipped = choices.filter((choice) => words.length > 0
|
|
@@ -272,22 +297,57 @@ function matchCalendarWords(
|
|
|
272
297
|
const ranked = slipped.sort((left, right) => IMPACT_RANK[left.impact] - IMPACT_RANK[right.impact] || left.words.length - right.words.length);
|
|
273
298
|
return { kind: "none", suggestions: [...ranked, ...alike].slice(0, 3).map(strip) };
|
|
274
299
|
}
|
|
275
|
-
const
|
|
300
|
+
const rank = (list: readonly RankedChoice[]) => [...list].sort((left, right) => IMPACT_RANK[left.impact] - IMPACT_RANK[right.impact]
|
|
276
301
|
|| (left.next ? 0 : 1) - (right.next ? 0 : 1)
|
|
277
302
|
|| (left.words.length - right.words.length)
|
|
278
303
|
|| (left.next?.date.getTime() ?? 0) - (right.next?.date.getTime() ?? 0)
|
|
279
304
|
|| left.name.localeCompare(right.name));
|
|
305
|
+
// A word for one series' headline release is that release (`employment` is US payrolls), the rest it names after it.
|
|
306
|
+
const series = HEADLINE_WORDS[words.join(" ")];
|
|
307
|
+
const headlined = series ? named.filter((choice) => choice.rows.some((row) => eventSeriesId(row) === series)) : [];
|
|
308
|
+
// Otherwise the releases listed ahead are what an alert follows: `GDP` is a GDP release still to come, never one
|
|
309
|
+
// whose next print the calendar does not list yet, which is only offered beside it.
|
|
310
|
+
const dated = named.filter((choice) => choice.next);
|
|
311
|
+
const ranked = rank(headlined.length > 0 ? headlined : dated.length > 0 ? dated : named);
|
|
312
|
+
const rest = rank(named.filter((choice) => !ranked.includes(choice)));
|
|
280
313
|
const countries = [...new Set(ranked.map((choice) => choice.country))];
|
|
281
|
-
|
|
314
|
+
// A high-impact headline release outranking every other country's is the one meant (US payrolls over France's
|
|
315
|
+
// quarterly private payrolls), and the match names the rest; releases alike in impact ask which country.
|
|
316
|
+
const best = ranked[0]!;
|
|
317
|
+
const headline = headlined.length > 0
|
|
318
|
+
|| (best.impact === "high" && ranked.every((choice) => choice.country === best.country || IMPACT_RANK[choice.impact] > IMPACT_RANK.high));
|
|
319
|
+
if (countries.length > 1 && !headline) {
|
|
282
320
|
return { kind: "countries", choices: countries.map((code) => strip(ranked.find((choice) => choice.country === code)!)) };
|
|
283
321
|
}
|
|
284
|
-
return { kind: "match", choice: strip(
|
|
322
|
+
return { kind: "match", choice: strip(best), others: [...ranked.slice(1), ...rest].map(strip) };
|
|
285
323
|
}
|
|
286
324
|
|
|
287
|
-
|
|
325
|
+
/**
|
|
326
|
+
* Words that name one series' headline release when typed alone, as a reader
|
|
327
|
+
* means them: `employment` is the jobs report's payrolls (Non-Farm
|
|
328
|
+
* Employment Change), not every country's employment change.
|
|
329
|
+
*/
|
|
330
|
+
const HEADLINE_WORDS: Readonly<Record<string, string>> = { employment: "PAYEMS" };
|
|
331
|
+
|
|
332
|
+
function strip({ words: _words, shownWords: _shown, names: _names, rows: _rows, ...choice }: RankedChoice): CalendarEventChoice {
|
|
288
333
|
return choice;
|
|
289
334
|
}
|
|
290
335
|
|
|
336
|
+
/**
|
|
337
|
+
* The releases `econ --search` finds for typed words: one whose series ECST
|
|
338
|
+
* names so (`nfp`, `jobs report`), or, of words of four letters and more,
|
|
339
|
+
* one with every word in its names or its publisher's (`nonfarm payrolls`).
|
|
340
|
+
* A short word alone (`man`) finds only a name it is, so a slip is offered
|
|
341
|
+
* rather than read.
|
|
342
|
+
*/
|
|
343
|
+
function searchedChoices(words: readonly string[], choices: readonly RankedChoice[]): RankedChoice[] {
|
|
344
|
+
if (words.length === 0) return [];
|
|
345
|
+
const compact = words.join("");
|
|
346
|
+
const loose = words.every((word) => word.length >= 4);
|
|
347
|
+
return choices.filter((choice) => choice.rows.some((row) => eventSearchNames(row).includes(compact))
|
|
348
|
+
|| (loose && choice.rows.some((row) => matchesEventSearch(row, words.join(" ")))));
|
|
349
|
+
}
|
|
350
|
+
|
|
291
351
|
/** "NBS Manufacturing PMI (CN)": a release as lists and notifications name it. */
|
|
292
352
|
export function calendarEventLabel(event: Pick<CalendarReleaseTarget, "event" | "country">): string {
|
|
293
353
|
return `${event.event} (${event.country})`;
|
|
@@ -325,7 +385,9 @@ function releaseRows(target: CalendarReleaseTarget, events: readonly EconEvent[]
|
|
|
325
385
|
// An alert kept under a series' former name follows the rows under its current one.
|
|
326
386
|
const keys = new Set([words.join(" "), withCurrentName(words)?.words.join(" ")]);
|
|
327
387
|
const own = events.filter((event) => eventCountry(event) === target.country);
|
|
328
|
-
|
|
388
|
+
// And the rows of its series under another feed's name: Non Farm Payrolls one month, Non-Farm Employment Change the next.
|
|
389
|
+
const series = releaseSeriesKey({ event: target.event, country: target.country });
|
|
390
|
+
const named = own.filter((event) => keys.has(nameKey(event.event)) || (series != null && releaseSeriesKey(event) === series));
|
|
329
391
|
if (!target.publisher) return named;
|
|
330
392
|
const namedDays = new Set(named.map((event) => dateKey(event.date)));
|
|
331
393
|
const renamed = own.flatMap((event) => {
|
|
@@ -15,6 +15,7 @@ export interface AlertAddForm {
|
|
|
15
15
|
|
|
16
16
|
export const ALERT_ADD_FORMS: readonly AlertAddForm[] = [
|
|
17
17
|
{ name: "price", usage: "<symbol> <above|below|crosses> <price>" },
|
|
18
|
+
{ name: "move from the previous close", usage: "<symbol...|--watchlist <name>> <moves|up|down> <percent>" },
|
|
18
19
|
{ name: "P/E, P/S or RSI", usage: "<symbol> <pe|ps|rsi(14)> <above|below> <level>" },
|
|
19
20
|
{ name: "moving average crossover", usage: "<symbol> ma(50) crosses <above|below> ma(200)" },
|
|
20
21
|
{ name: "close against a moving average", usage: "<symbol> closes <above|below> ma(200)" },
|
|
@@ -28,7 +29,7 @@ export const ALERT_ADD_FORMS: readonly AlertAddForm[] = [
|
|
|
28
29
|
{ name: "IV spike", usage: "<OCC contract> iv spike <points>" },
|
|
29
30
|
{ name: "52-week range", usage: "<symbol> 52-week <high|low>" },
|
|
30
31
|
{ name: "unusual volume", usage: "<symbol> unusual volume [<multiple>x]" },
|
|
31
|
-
{ name: "SEC filing", usage: "<symbol> filing [8-K|10-K|10-Q|S-1|13D|13D/A|13G|13G/A|6-K|20-F]" },
|
|
32
|
+
{ name: "SEC filing", usage: "<symbol> filing [8-K|10-K|10-Q|S-1|13D|13D/A|13G|13G/A|6-K|20-F|13F]" },
|
|
32
33
|
{ name: "insider trade", usage: "<symbol> insider [buy|sell]" },
|
|
33
34
|
{ name: "short interest", usage: "<symbol> short interest [increase|decrease] [<percent>%]" },
|
|
34
35
|
{ name: "analyst change", usage: "<symbol> analyst [upgrade|downgrade]" },
|
|
@@ -58,6 +59,11 @@ export interface RuleAddRequest {
|
|
|
58
59
|
/** Where that symbol may list: in the US, as Gloom Cloud's research rules follow, or anywhere (hiring, a catalyst's company). */
|
|
59
60
|
listing: "us" | "any";
|
|
60
61
|
values: Record<string, string>;
|
|
62
|
+
/**
|
|
63
|
+
* A 13F typed as a filing form (`BRK.B filing 13F`): the 13F alert on the
|
|
64
|
+
* fund the symbol's company files as, its CIK read from its SEC filings.
|
|
65
|
+
*/
|
|
66
|
+
thirteenFFilerOf?: true;
|
|
61
67
|
}
|
|
62
68
|
|
|
63
69
|
/** Who checks a rule and how it reaches you, as docs/usage.md states it. */
|
|
@@ -117,6 +123,10 @@ function symbolRule(symbol: string, words: readonly string[]): RuleAddRequest |
|
|
|
117
123
|
}
|
|
118
124
|
if (kind === "filing" || kind === "filings") {
|
|
119
125
|
const typed = words.slice(1).join(" ");
|
|
126
|
+
// A 13F is a fund's holdings report, which the 13F alert follows by the fund's CIK: the company's own, read when it is added.
|
|
127
|
+
if (/^13\s*F(?:\s*-?\s*HR)?(?:\/A)?$/i.test(typed.trim())) {
|
|
128
|
+
return { kind: "rule", event: "thirteenf-fund", symbol, listing: "us", values: {}, thirteenFFilerOf: true };
|
|
129
|
+
}
|
|
120
130
|
const form = readFilingForm(typed);
|
|
121
131
|
if (!form) throw new Error(`A filing alert follows one form: ${FILING_FORMS_TEXT}, not "${typed}": ${example("filing 8-K")}.`);
|
|
122
132
|
return rule("filing_type", { form });
|