gloomberb 0.20.2 → 0.20.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/README.zh-CN.md +1 -1
- package/package.json +2 -1
- package/src/account/auth-dialog.tsx +17 -0
- 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 +23 -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/fx-interventions.ts +64 -0
- package/src/api-client/index.ts +2 -0
- package/src/api-client/paths.ts +9 -1
- package/src/api-client/release-summaries.ts +21 -0
- package/src/api-client/social-mentions.ts +47 -0
- package/src/api-client/types/econ.ts +4 -0
- package/src/app/keybindings/actions.ts +2 -2
- package/src/app/pane-runtime/ticker-open-runtime.ts +245 -66
- package/src/app.tsx +11 -1
- package/src/cli/command-options.ts +2 -1
- package/src/cli/commands/market.ts +188 -30
- package/src/cli/commands/news-search.ts +1 -3
- package/src/cli/commands/options-chain.ts +23 -6
- package/src/cli/commands/overview.ts +13 -5
- package/src/cli/commands/plugins.ts +76 -23
- package/src/cli/commands/search.ts +25 -6
- package/src/cli/commands/system.ts +19 -3
- package/src/cli/commands/ticker.ts +64 -21
- 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 +14 -46
- 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 +26 -14
- 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 +40 -8
- package/src/cli/result.ts +21 -9
- 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/types.ts +2 -0
- package/src/cli/unknown-command.ts +88 -0
- package/src/components/chart/composite/axis-overlays.tsx +22 -0
- package/src/components/chart/composite/composite-chart.tsx +54 -13
- package/src/components/chart/composite/event-captions.ts +109 -0
- package/src/components/chart/composite/event-guides.ts +74 -0
- package/src/components/chart/composite/rasterizer.ts +2 -0
- package/src/components/chart/composite/text-renderer.ts +2 -0
- package/src/components/chart/composite/types.ts +31 -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/layout-items/focused-pane.ts +5 -5
- 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 +192 -33
- 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 +104 -6
- package/src/components/command-bar/routes/ticker-search/route.ts +3 -2
- 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/detached-pane-shell.tsx +1 -1
- package/src/components/layout/double-escape-close.ts +8 -5
- package/src/components/layout/floating-pane.tsx +5 -1
- 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 +44 -19
- package/src/components/layout/pane/footer/model.ts +52 -20
- package/src/components/layout/pane/header.tsx +3 -2
- package/src/components/layout/shell/action-menu-overlay.tsx +10 -5
- package/src/components/layout/shell/active-drag.ts +149 -105
- package/src/components/layout/shell/chrome.ts +15 -15
- package/src/components/layout/shell/drag/drop-zones.ts +162 -0
- package/src/components/layout/shell/drag/index.ts +47 -218
- package/src/components/layout/shell/drag/live.ts +10 -3
- package/src/components/layout/shell/drag/overlays.tsx +182 -5
- package/src/components/layout/shell/drag/runtime.ts +29 -6
- package/src/components/layout/shell/drag/shared-edges.ts +156 -0
- package/src/components/layout/shell/index.tsx +11 -6
- package/src/components/layout/shell/menu.ts +11 -2
- package/src/components/layout/shell/native/pointer-runtime.ts +25 -0
- package/src/components/layout/shell/native/window-state.ts +2 -2
- package/src/components/layout/shell/pane/layers.tsx +71 -7
- package/src/components/layout/shell/terminal-pointer-runtime.ts +18 -9
- package/src/components/layout/shell/window-mode/index.ts +8 -10
- package/src/components/layout/status-bar.tsx +8 -7
- package/src/components/layout/status-widget-space.ts +8 -0
- package/src/components/layout/window-edit/mode.ts +39 -7
- package/src/components/layout/window-edit/presentation.ts +1 -1
- 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 +19 -6
- package/src/components/onboarding/onboarding-wizard.tsx +69 -14
- 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 +15 -2
- package/src/components/ui/choice-dialog.tsx +1 -0
- package/src/components/ui/column-grid.tsx +18 -9
- package/src/components/ui/data-table/index.tsx +5 -4
- 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/list-view.tsx +7 -12
- package/src/components/ui/loading.tsx +10 -3
- package/src/components/ui/menu.tsx +9 -3
- package/src/components/ui/message-composer.tsx +2 -2
- package/src/components/ui/quote.ts +14 -1
- 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/layout.ts +5 -2
- package/src/data/config/store/normalize.ts +6 -0
- package/src/docs/snapshot.json +149 -74
- package/src/i18n/es.ts +33 -9
- package/src/i18n/ja.ts +33 -9
- package/src/i18n/ko.ts +33 -9
- package/src/i18n/zh-cn.ts +33 -9
- package/src/i18n/zh-tw.ts +33 -9
- package/src/layout/pane-manager/floating-actions.ts +17 -0
- package/src/layout/pane-manager/floating-stack.ts +187 -0
- package/src/layout/pane-manager/floating.ts +4 -2
- package/src/layout/pane-manager/gridlock.ts +16 -1
- package/src/layout/pane-manager/index.ts +11 -0
- package/src/layout/pane-manager/layout-state.ts +10 -3
- 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 +126 -1
- package/src/market-data/futures-contract.ts +21 -6
- package/src/market-data/fx-interventions.ts +270 -0
- 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/news/news-model.ts +44 -2
- 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 +223 -32
- 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 +39 -15
- package/src/plugins/builtin/alerts/headless.ts +30 -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 +161 -0
- package/src/plugins/builtin/alerts/move.ts +181 -0
- package/src/plugins/builtin/alerts/pane.tsx +50 -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 +22 -7
- package/src/plugins/builtin/alerts/types.ts +25 -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/changelog/index.tsx +292 -101
- package/src/plugins/builtin/changelog/versions.ts +293 -0
- 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/chart-composer/intervention-events.ts +105 -0
- package/src/plugins/builtin/chart-composer/pane.tsx +21 -7
- package/src/plugins/builtin/chat/message/render-state.ts +2 -5
- package/src/plugins/builtin/cloud/askg/attached-pane.tsx +10 -5
- package/src/plugins/builtin/cloud/askg/controller.ts +141 -5
- package/src/plugins/builtin/cloud/askg/executor.ts +113 -4
- package/src/plugins/builtin/cloud/askg/manifest.ts +28 -13
- package/src/plugins/builtin/cloud/askg/model.ts +14 -4
- package/src/plugins/builtin/cloud/askg/pane.tsx +70 -46
- package/src/plugins/builtin/cloud/askg/turn-parts.tsx +70 -0
- package/src/plugins/builtin/cloud/terminal-relay/engine.ts +50 -130
- package/src/plugins/builtin/cloud/terminal-relay/policy.ts +327 -7
- package/src/plugins/builtin/cloud/terminal-relay/prompts.tsx +2 -1
- package/src/plugins/builtin/cloud/terminal-relay/redact.ts +47 -6
- package/src/plugins/builtin/cloud/upgrade-status-widget.tsx +9 -2
- package/src/plugins/builtin/commodities-energy/index.tsx +1 -3
- package/src/plugins/builtin/commodities-energy/view-state.ts +3 -0
- package/src/plugins/builtin/cot/headless.ts +14 -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/earnings/index.tsx +2 -2
- 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/index.tsx +25 -4
- package/src/plugins/builtin/futures/model.ts +28 -32
- package/src/plugins/builtin/futures/series.ts +4 -3
- package/src/plugins/builtin/futures/table.tsx +17 -10
- package/src/plugins/builtin/futures/use-board-terms.ts +3 -3
- 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/help/index.tsx +3 -3
- package/src/plugins/builtin/help/keybindings-editor.tsx +18 -4
- 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/layout-manager/index.tsx +8 -8
- package/src/plugins/builtin/news/headless.ts +2 -2
- package/src/plugins/builtin/news/index.tsx +10 -16
- 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 +7 -4
- 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/plugin-marketplace/pane.tsx +11 -11
- 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/summary/index.tsx +3 -1
- 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/research/event-model.ts +9 -1
- package/src/plugins/builtin/research/event-sources.ts +22 -0
- package/src/plugins/builtin/research/headless.ts +3 -3
- 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/cloud-upgrade.ts +27 -3
- 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 +67 -6
- 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 +69 -19
- package/src/plugins/builtin/ticker-detail/pane.tsx +7 -2
- 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 +53 -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/remote/resources.ts +12 -1
- package/src/remote/schema.ts +1 -0
- package/src/remote/semantic-helpers.ts +29 -1
- package/src/remote/semantic-tree.tsx +32 -15
- 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/cloudflare/worker.ts +16 -1
- 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 +73 -19
- package/src/renderers/electrobun/bun/desktop/app-name.ts +1 -1
- package/src/renderers/opentui/host.tsx +2 -1
- package/src/renderers/share/layout-view.tsx +1 -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/news.ts +35 -12
- package/src/sources/gloomberb-cloud/normalizers.ts +29 -3
- package/src/sources/provider-router/cached-routes.ts +19 -7
- package/src/state/opening-ticker-panes.ts +47 -0
- package/src/state/pane-table-export-registry.ts +19 -6
- package/src/test-support/cli-context.ts +2 -0
- package/src/test-support/preload.ts +8 -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/instrument-kind.ts +23 -3
- 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 +13 -0
- package/src/types/context-menu.ts +2 -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/types/plugin-commands.ts +140 -0
- package/src/types/plugin-context.ts +125 -0
- package/src/types/plugin-contributions.ts +55 -0
- package/src/types/plugin-definition.ts +234 -0
- package/src/types/plugin-notifications.ts +38 -0
- package/src/types/plugin-pane-settings.ts +114 -0
- package/src/types/plugin-pane-templates.ts +160 -0
- package/src/types/plugin-panes.ts +221 -0
- package/src/types/plugin-reports.ts +35 -0
- package/src/types/plugin-shared.ts +14 -0
- package/src/types/plugin-state.ts +71 -0
- package/src/types/plugin.ts +14 -1169
- package/src/ui/host.tsx +8 -0
- package/src/ui/index.tsx +14 -3
- package/src/updater/github-releases.ts +23 -0
- package/src/utils/cli-output.ts +22 -9
- 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,114 @@
|
|
|
1
|
+
import type { AppConfig, LayoutConfig, PaneInstanceConfig } from "./config";
|
|
2
|
+
import type { AppNotificationRequest } from "./plugin-notifications";
|
|
3
|
+
|
|
4
|
+
export interface PaneSettingsContext {
|
|
5
|
+
config: AppConfig;
|
|
6
|
+
layout: LayoutConfig;
|
|
7
|
+
paneId: string;
|
|
8
|
+
paneType: string;
|
|
9
|
+
pane: PaneInstanceConfig;
|
|
10
|
+
settings: Record<string, unknown>;
|
|
11
|
+
paneState: Record<string, unknown>;
|
|
12
|
+
activeTicker: string | null;
|
|
13
|
+
activeCollectionId: string | null;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
export interface PaneSettingOption {
|
|
17
|
+
value: string;
|
|
18
|
+
label: string;
|
|
19
|
+
description?: string;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
interface PaneSettingFieldBase {
|
|
23
|
+
key: string;
|
|
24
|
+
label: string;
|
|
25
|
+
description?: string;
|
|
26
|
+
storage?: "pane" | "plugin";
|
|
27
|
+
/** Keys in the same storage scope that should be reset when this value changes. */
|
|
28
|
+
clearOnChange?: string[];
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
interface PaneSettingToggleField extends PaneSettingFieldBase {
|
|
32
|
+
type: "toggle";
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export interface PaneSettingTextField extends PaneSettingFieldBase {
|
|
36
|
+
type: "text";
|
|
37
|
+
placeholder?: string;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
interface PaneSettingSelectField extends PaneSettingFieldBase {
|
|
41
|
+
type: "select";
|
|
42
|
+
options: PaneSettingOption[];
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
interface PaneSettingMultiSelectField extends PaneSettingFieldBase {
|
|
46
|
+
type: "multi-select";
|
|
47
|
+
options: PaneSettingOption[];
|
|
48
|
+
/** A long list: a filter box, each description beside its label. */
|
|
49
|
+
searchable?: boolean;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
interface PaneSettingOrderedMultiSelectField extends PaneSettingFieldBase {
|
|
53
|
+
type: "ordered-multi-select";
|
|
54
|
+
options: PaneSettingOption[];
|
|
55
|
+
/** A long list: a filter box, each description beside its label and each selection's position. */
|
|
56
|
+
searchable?: boolean;
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
/** What an action row says of its own action (docs/pane-conventions.md, "Row messages"). */
|
|
60
|
+
export interface PaneSettingRowNote {
|
|
61
|
+
/** A short state, where the row's action label is: `Connecting…`, `Sign-in failed`. */
|
|
62
|
+
status: string;
|
|
63
|
+
/** The full reason or the next step, in place of the row's description. */
|
|
64
|
+
text?: string;
|
|
65
|
+
tone: "warning" | "negative";
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
export interface PaneSettingActionContext extends PaneSettingsContext {
|
|
69
|
+
surface: "pane-dialog" | "command-bar";
|
|
70
|
+
close(): void;
|
|
71
|
+
openCommandBar(query?: string): void;
|
|
72
|
+
notify(notification: AppNotificationRequest): void;
|
|
73
|
+
/**
|
|
74
|
+
* Says on the row the action runs from what it is doing or what stopped it,
|
|
75
|
+
* or clears that with null. A success the row's own description and label
|
|
76
|
+
* show once they change needs no note. False once the row is off screen
|
|
77
|
+
* (the dialog closed, or the action removed its own field): say it with
|
|
78
|
+
* `notify` then, as a row that has left a list is a toast. Older hosts do
|
|
79
|
+
* not pass it.
|
|
80
|
+
*/
|
|
81
|
+
setRowNote?(note: PaneSettingRowNote | null): boolean;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
export type PaneSettingActionHandler = (
|
|
85
|
+
context: PaneSettingActionContext,
|
|
86
|
+
) => void | Promise<void>;
|
|
87
|
+
|
|
88
|
+
export type PaneSettingActionField = Omit<PaneSettingFieldBase, "storage" | "clearOnChange"> & {
|
|
89
|
+
type: "action";
|
|
90
|
+
actionId: string;
|
|
91
|
+
actionLabel?: string;
|
|
92
|
+
disabled?: boolean;
|
|
93
|
+
action: PaneSettingActionHandler;
|
|
94
|
+
};
|
|
95
|
+
|
|
96
|
+
export type PaneSettingField =
|
|
97
|
+
| PaneSettingToggleField
|
|
98
|
+
| PaneSettingTextField
|
|
99
|
+
| PaneSettingSelectField
|
|
100
|
+
| PaneSettingMultiSelectField
|
|
101
|
+
| PaneSettingOrderedMultiSelectField
|
|
102
|
+
| PaneSettingActionField;
|
|
103
|
+
|
|
104
|
+
export interface PaneSettingsDef {
|
|
105
|
+
title?: string;
|
|
106
|
+
values?: Record<string, unknown>;
|
|
107
|
+
fields: PaneSettingField[];
|
|
108
|
+
applyValue?: (
|
|
109
|
+
settings: Record<string, unknown>,
|
|
110
|
+
field: PaneSettingField,
|
|
111
|
+
value: unknown,
|
|
112
|
+
context: PaneSettingsContext,
|
|
113
|
+
) => Record<string, unknown> | Promise<Record<string, unknown>>;
|
|
114
|
+
}
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
import type { AppConfig, LayoutConfig, PaneBinding, PaneInstanceConfig } from "./config";
|
|
2
|
+
import type { HeadlessPaneDefinition, HeadlessPaneFreshness } from "./headless";
|
|
3
|
+
import type { BrokerContractRef, InstrumentSearchResult, TickerListingRef } from "./instrument";
|
|
4
|
+
import type { WizardStep } from "./plugin-shared";
|
|
5
|
+
import type { TickerRecord } from "./ticker";
|
|
6
|
+
|
|
7
|
+
export interface PaneTemplateContext {
|
|
8
|
+
config: AppConfig;
|
|
9
|
+
layout: LayoutConfig;
|
|
10
|
+
focusedPaneId: string | null;
|
|
11
|
+
activeTicker: string | null;
|
|
12
|
+
activeInstrument?: BrokerContractRef | null;
|
|
13
|
+
activeListing?: TickerListingRef;
|
|
14
|
+
activeCollectionId: string | null;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
/** One value a shortcut argument accepts: `value` is typed after the prefix, `label` says what it is. */
|
|
18
|
+
export interface ShortcutArgOption {
|
|
19
|
+
value: string;
|
|
20
|
+
label: string;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/** Why a typed argument opens nothing: the row's text, and the line under it saying what to type instead. */
|
|
24
|
+
export interface ShortcutArgError {
|
|
25
|
+
message: string;
|
|
26
|
+
detail?: string;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
interface PaneTemplateShortcut {
|
|
30
|
+
prefix: string;
|
|
31
|
+
/** Other mnemonics for the same view (FFIP for WIRP). They open it when typed but are not listed as separate rows. */
|
|
32
|
+
aliases?: readonly string[];
|
|
33
|
+
/** Keep this shortcut executable when typed, but omit its pane from command-bar browse rows. Defaults to true. */
|
|
34
|
+
showInBrowse?: boolean;
|
|
35
|
+
/**
|
|
36
|
+
* What the shortcut takes after the prefix. Left out, it takes the argument
|
|
37
|
+
* the template's `headless` definition declares, as `gloom catalog` lists it.
|
|
38
|
+
*/
|
|
39
|
+
argPlaceholder?: string;
|
|
40
|
+
argKind?: "text" | "ticker" | "ticker-list";
|
|
41
|
+
/**
|
|
42
|
+
* For a ticker list, entries kept as typed instead of resolved as tickers:
|
|
43
|
+
* CORR keeps map series (`GEO:HORMUZ`) beside its tickers.
|
|
44
|
+
*/
|
|
45
|
+
keepArgToken?: (token: string) => boolean;
|
|
46
|
+
argOptional?: boolean;
|
|
47
|
+
/**
|
|
48
|
+
* The argument is a company the function reports on (CDS, TRACE): with
|
|
49
|
+
* none typed, the command bar opens it on the ticker in focus, and with no
|
|
50
|
+
* ticker in focus market-wide. `<ticker> <code>` opens it too.
|
|
51
|
+
*/
|
|
52
|
+
focusedIssuer?: boolean;
|
|
53
|
+
/**
|
|
54
|
+
* With no argument typed and none to infer from the active ticker, open
|
|
55
|
+
* the pane without one instead of asking for it (ERN alone is the market
|
|
56
|
+
* board). Without it an optional argument still falls back to the form.
|
|
57
|
+
*/
|
|
58
|
+
openWithoutArg?: boolean;
|
|
59
|
+
/**
|
|
60
|
+
* Named values the argument accepts, for an argument mostly drawn from a
|
|
61
|
+
* small set (a statistic, a futures root). The command-bar assistant picks
|
|
62
|
+
* from it instead of guessing the text; the command may accept others too.
|
|
63
|
+
*/
|
|
64
|
+
argOptions?: () => readonly ShortcutArgOption[];
|
|
65
|
+
/**
|
|
66
|
+
* Why a typed argument opens nothing, or null when it opens the view:
|
|
67
|
+
* `PF Nope` names no portfolio or watchlist. The command bar shows it in
|
|
68
|
+
* place of the function's row, and the pane does not open for it.
|
|
69
|
+
*/
|
|
70
|
+
argError?: (arg: string, context: PaneTemplateContext) => ShortcutArgError | null;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export interface PaneTemplateCreateOptions {
|
|
74
|
+
arg?: string;
|
|
75
|
+
values?: Record<string, string>;
|
|
76
|
+
symbol?: string | null;
|
|
77
|
+
symbols?: string[] | null;
|
|
78
|
+
ticker?: TickerRecord | null;
|
|
79
|
+
searchResult?: InstrumentSearchResult | null;
|
|
80
|
+
instrument?: BrokerContractRef | null;
|
|
81
|
+
listing?: TickerListingRef;
|
|
82
|
+
/** Template-owned, validated data restored from a public pane share. */
|
|
83
|
+
shareData?: unknown;
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
export interface PaneTemplateInstanceConfig {
|
|
87
|
+
instanceId?: string;
|
|
88
|
+
title?: string;
|
|
89
|
+
binding?: PaneBinding;
|
|
90
|
+
params?: Record<string, string>;
|
|
91
|
+
settings?: Record<string, unknown>;
|
|
92
|
+
placement?: "default" | "docked" | "floating";
|
|
93
|
+
relativeToPaneId?: string;
|
|
94
|
+
relativePosition?: "left" | "right" | "above" | "below";
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
export interface PaneTemplatePublicShareContext {
|
|
98
|
+
pane: PaneInstanceConfig;
|
|
99
|
+
paneState: Record<string, unknown>;
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
export interface PaneTemplatePublicShareSnapshot {
|
|
103
|
+
title: string;
|
|
104
|
+
description?: string;
|
|
105
|
+
data: Record<string, unknown>;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
export interface PaneTemplatePublicShareDef {
|
|
109
|
+
serialize(context: PaneTemplatePublicShareContext): PaneTemplatePublicShareSnapshot | null;
|
|
110
|
+
restore(data: Record<string, unknown>): PaneTemplateCreateOptions | null;
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
export interface PaneTemplateDef {
|
|
114
|
+
id: string;
|
|
115
|
+
paneId: string;
|
|
116
|
+
label: string;
|
|
117
|
+
description: string;
|
|
118
|
+
keywords?: string[];
|
|
119
|
+
shortcut?: PaneTemplateShortcut;
|
|
120
|
+
/**
|
|
121
|
+
* False leaves the function out of every list and search of functions
|
|
122
|
+
* (command-bar browse, search and assistant, Help, `gloom catalog` and
|
|
123
|
+
* search, the plugin directory, chat suggestions) while typing its code
|
|
124
|
+
* still opens it, `fn` and `shot` still run it and its help still answers.
|
|
125
|
+
* ATTN until it publishes (attention/listing.ts).
|
|
126
|
+
*/
|
|
127
|
+
listed?: boolean;
|
|
128
|
+
/** Template-specific headless model. Takes precedence over the pane-level model. */
|
|
129
|
+
headless?: HeadlessPaneDefinition;
|
|
130
|
+
/**
|
|
131
|
+
* A one-ticker template whose pane also opens on several at once (DVD's
|
|
132
|
+
* ranking): `fn` and `shot` pass a typed list (`shot DVD KO JNJ`) to
|
|
133
|
+
* createInstance as `symbols`. Any other one-ticker template gets the list
|
|
134
|
+
* as it always has, in `symbol` and `arg`.
|
|
135
|
+
*/
|
|
136
|
+
opensTickerList?: boolean;
|
|
137
|
+
/**
|
|
138
|
+
* Source and status of the view this template opens, for a template that
|
|
139
|
+
* opens one view of a pane hosting several (Fixed Income's Issuer Debt).
|
|
140
|
+
* Captures and rendered-view reports merge it over the pane's own
|
|
141
|
+
* `reportFreshness`: each field set here wins, the rest are the pane's. So
|
|
142
|
+
* they date the filings on screen, not the issuer's stock quote.
|
|
143
|
+
*/
|
|
144
|
+
reportFreshness?: Pick<HeadlessPaneFreshness, "source" | "status" | "basis" | "local">;
|
|
145
|
+
wizard?: WizardStep[];
|
|
146
|
+
canCreate?: (context: PaneTemplateContext, options?: PaneTemplateCreateOptions) => boolean;
|
|
147
|
+
/**
|
|
148
|
+
* Settings shown by catalog discovery without running createInstance. Supply
|
|
149
|
+
* these when opening a pane needs live data or has side effects. An empty
|
|
150
|
+
* object means there are no settings to describe before the pane is opened.
|
|
151
|
+
* When omitted, discovery derives settings from createInstance as before.
|
|
152
|
+
*/
|
|
153
|
+
catalogSettings?: Record<string, unknown>;
|
|
154
|
+
createInstance?: (
|
|
155
|
+
context: PaneTemplateContext,
|
|
156
|
+
options?: PaneTemplateCreateOptions,
|
|
157
|
+
) => PaneTemplateInstanceConfig | null | Promise<PaneTemplateInstanceConfig | null>;
|
|
158
|
+
/** Legacy v1 restoration or an explicit transformed snapshot; normal pane shares use portableShare. */
|
|
159
|
+
publicShare?: PaneTemplatePublicShareDef;
|
|
160
|
+
}
|
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
import type { ReactNode } from "react";
|
|
2
|
+
import type { PaneInstanceConfig } from "./config";
|
|
3
|
+
import type { HeadlessPaneArgumentDef, HeadlessPaneDefinition, HeadlessPaneFreshness } from "./headless";
|
|
4
|
+
import type { TickerInstrumentKind } from "./instrument";
|
|
5
|
+
import type { PaneSettingsContext, PaneSettingsDef } from "./plugin-pane-settings";
|
|
6
|
+
import type { PaneLock, PaneReportOptionDef } from "./plugin-reports";
|
|
7
|
+
import type { TickerRecord } from "./ticker";
|
|
8
|
+
|
|
9
|
+
export interface PaneProps {
|
|
10
|
+
paneId: string;
|
|
11
|
+
paneType: string;
|
|
12
|
+
focused: boolean;
|
|
13
|
+
width: number;
|
|
14
|
+
height: number;
|
|
15
|
+
close?: () => void;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
export type PaneSharePrivateFields = true | readonly string[];
|
|
19
|
+
|
|
20
|
+
export interface PanePortableShareDef {
|
|
21
|
+
/** Fields excluded before pane configuration or state leaves the device. */
|
|
22
|
+
private?: {
|
|
23
|
+
title?: boolean;
|
|
24
|
+
params?: PaneSharePrivateFields;
|
|
25
|
+
settings?: PaneSharePrivateFields;
|
|
26
|
+
state?: PaneSharePrivateFields;
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Rewrites the instance before it leaves the device, on every publish. The
|
|
30
|
+
* receiver has none of the sender's local ticker records, so anything
|
|
31
|
+
* resolved through them (a listing's venue, for example) must be pinned into
|
|
32
|
+
* the instance here; a layout published to the gallery passes none.
|
|
33
|
+
*/
|
|
34
|
+
prepare?(pane: PaneInstanceConfig, context: {
|
|
35
|
+
tickers: ReadonlyMap<string, TickerRecord>;
|
|
36
|
+
/** The moment the pane's layout tab has its crosshair pinned at, so a link opens there. */
|
|
37
|
+
pinnedTime?: number;
|
|
38
|
+
}): PaneInstanceConfig;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
export interface PaneDef {
|
|
42
|
+
id: string;
|
|
43
|
+
name: string;
|
|
44
|
+
icon?: string;
|
|
45
|
+
component: (props: PaneProps) => ReactNode;
|
|
46
|
+
defaultPosition: "left" | "right";
|
|
47
|
+
defaultWidth?: string;
|
|
48
|
+
defaultFloatingSize?: { width: number; height: number };
|
|
49
|
+
defaultMode?: "docked" | "floating";
|
|
50
|
+
/** Pane publishes its selected symbol as pane-state `cursorSymbol`, so ticker panes can follow it. */
|
|
51
|
+
tickerSource?: boolean;
|
|
52
|
+
/**
|
|
53
|
+
* Pane shows one ticker read through its binding (`usePaneTicker`, `usePaneTickerIdentity`), so
|
|
54
|
+
* its pane menu offers "Link to" each visible list, scanner, and other single-ticker pane, and
|
|
55
|
+
* it then follows that pane's selection. A function decides per instance (a chart with one
|
|
56
|
+
* security, not a comparison). A follower must never write its own `cursorSymbol`: that would
|
|
57
|
+
* win over the binding.
|
|
58
|
+
*/
|
|
59
|
+
tickerFollower?: boolean | ((pane: PaneInstanceConfig) => boolean);
|
|
60
|
+
/**
|
|
61
|
+
* A single-ticker pane that keeps its ticker somewhere besides its binding (a chart's series)
|
|
62
|
+
* moves it here when ticker search changes the ticker the pane shows. The host has already set
|
|
63
|
+
* the binding and the title; `previous` is the ticker the pane showed until now.
|
|
64
|
+
*/
|
|
65
|
+
retargetTicker?(pane: PaneInstanceConfig, symbol: string, previous: string | null): PaneInstanceConfig;
|
|
66
|
+
/**
|
|
67
|
+
* Instrument kinds this pane has data for, such as `["equity"]` for company
|
|
68
|
+
* data, as a research tab declares them. Bound to a ticker of another known
|
|
69
|
+
* kind (an index, an ETF), the pane says so in place of its data, and `fn`
|
|
70
|
+
* and `shot` answer before loading. Omit when every ticker has it.
|
|
71
|
+
*/
|
|
72
|
+
instruments?: readonly TickerInstrumentKind[];
|
|
73
|
+
/**
|
|
74
|
+
* For a pane type that two or more functions open (ERN and EVTS): the settings that say
|
|
75
|
+
* what a window shows, as against how (a range, a toggle, a column choice). Opening a
|
|
76
|
+
* function again focuses a window whose binding, params and settings match what the
|
|
77
|
+
* function opens; a window with a setting of its own that is not listed here is still that
|
|
78
|
+
* window, and one with a listed setting the function does not set belongs to another
|
|
79
|
+
* function and is left alone. Without it, a pane type opened by several functions is
|
|
80
|
+
* matched on its settings exactly, and a window that picked up any setting is not found.
|
|
81
|
+
* An empty list says binding and params alone name the window.
|
|
82
|
+
*/
|
|
83
|
+
identitySettings?: readonly string[];
|
|
84
|
+
/**
|
|
85
|
+
* The title a saved window of this pane has, from its params and settings,
|
|
86
|
+
* for lists that name windows without rendering them (the Layouts browser).
|
|
87
|
+
* A pane that titles itself by what it shows ("Curve \u00b7 BZ") gives the same
|
|
88
|
+
* title here, so two of its windows are told apart before either is opened.
|
|
89
|
+
*/
|
|
90
|
+
instanceTitle?(pane: PaneInstanceConfig): string | null;
|
|
91
|
+
/** Renderer-neutral data model used by CLI functions, automation, and hosted tools. */
|
|
92
|
+
headless?: HeadlessPaneDefinition;
|
|
93
|
+
/**
|
|
94
|
+
* Source and status a rendered-view report (`fn` on a pane without a
|
|
95
|
+
* `headless` model) cites, when "Gloom Cloud" with the state the footer
|
|
96
|
+
* shows would be wrong: local data, a calculator, filed records.
|
|
97
|
+
*/
|
|
98
|
+
reportFreshness?: Pick<HeadlessPaneFreshness, "source" | "status" | "basis" | "local">;
|
|
99
|
+
/**
|
|
100
|
+
* Options a rendered-view report takes (`fn OMON AAPL --strikes 10`):
|
|
101
|
+
* each sets the pane setting of its key, is checked by its `normalize`, and
|
|
102
|
+
* is listed with its example by `gloom catalog`.
|
|
103
|
+
*/
|
|
104
|
+
reportOptions?: readonly PaneReportOptionDef[];
|
|
105
|
+
/**
|
|
106
|
+
* A rendered-view report that takes its `reportOptions` and nothing else:
|
|
107
|
+
* any other option is refused with the ones it takes (`fn FUT --bogus 1`),
|
|
108
|
+
* as a `headless` report refuses one, instead of being set as a pane
|
|
109
|
+
* setting of that name.
|
|
110
|
+
*/
|
|
111
|
+
reportOptionsOnly?: boolean;
|
|
112
|
+
/**
|
|
113
|
+
* What a rendered-view report takes after the function, for a pane whose
|
|
114
|
+
* template reads it with no shortcut to say so (X Feed's query): the
|
|
115
|
+
* catalog lists it, and `fn` refuses an argument from a function that
|
|
116
|
+
* declares none here, in its shortcut or in a `headless` model.
|
|
117
|
+
*/
|
|
118
|
+
reportArgument?: Pick<HeadlessPaneArgumentDef, "kind" | "placeholder" | "description" | "optional"> & {
|
|
119
|
+
/**
|
|
120
|
+
* The argument names something the pane opens by its own id (the story
|
|
121
|
+
* pane's story id), never a symbol: `fn` does not look it up as a ticker.
|
|
122
|
+
* A query (X Feed's) leaves it unset and keeps its ticker reading.
|
|
123
|
+
*/
|
|
124
|
+
identifier?: boolean;
|
|
125
|
+
};
|
|
126
|
+
/**
|
|
127
|
+
* Lines a rendered-view report prints above its table, from the settings it
|
|
128
|
+
* ran with: what the default view leaves out and how to see more. `--json`
|
|
129
|
+
* carries them in `data.metadata.notices`.
|
|
130
|
+
*/
|
|
131
|
+
reportNotices?(settings: Readonly<Record<string, unknown>>): string[];
|
|
132
|
+
/**
|
|
133
|
+
* What a rendered-view report prints in place of the pane when a sign-in
|
|
134
|
+
* wall or the Pro lock covers all of it: what is locked, what can still be
|
|
135
|
+
* read without it and where, and how to unlock it. A `headless` pane's report
|
|
136
|
+
* prints it when the server refuses the read (401, 402 or 403). Without it
|
|
137
|
+
* the report prints the wall's own words, or the refusal. Either way it cites
|
|
138
|
+
* no source, since nothing was read. A free route it names must have data
|
|
139
|
+
* for the symbol (`lock.context` reads it), so the note may resolve later.
|
|
140
|
+
*/
|
|
141
|
+
reportLockNote?(lock: PaneLock): string | Promise<string>;
|
|
142
|
+
/**
|
|
143
|
+
* The sign-in wall covers the whole pane whenever there is no Gloom Cloud
|
|
144
|
+
* session (ASKG): a rendered-view report without one prints its
|
|
145
|
+
* `reportLockNote` at once rather than render the wall to read it.
|
|
146
|
+
*/
|
|
147
|
+
signInWall?: boolean;
|
|
148
|
+
/**
|
|
149
|
+
* What a rendered-view report needs before it shows anything, such as a
|
|
150
|
+
* sign-in: `gloom catalog` lists it under Requires, as it does a
|
|
151
|
+
* `headless` model's `discovery.dataRequirements`.
|
|
152
|
+
*/
|
|
153
|
+
reportRequirements?: readonly string[];
|
|
154
|
+
/**
|
|
155
|
+
* A `shot` without `--height` grows to the pane's natural height, up to the
|
|
156
|
+
* height limit, so a fixed board (FUT) shows every row instead of cutting
|
|
157
|
+
* the last ones. Leave it off for long or paged lists; a pane with tabs
|
|
158
|
+
* answers for the instance shown, so only its fixed board's tab grows.
|
|
159
|
+
*/
|
|
160
|
+
shotFitsRows?: true | ((pane: PaneInstanceConfig) => boolean);
|
|
161
|
+
/**
|
|
162
|
+
* A report of the pane grows to the whole text of the page its reader has
|
|
163
|
+
* open (a docs page), so it is not cut at the first screen. A list the reader
|
|
164
|
+
* opens from keeps its height.
|
|
165
|
+
*/
|
|
166
|
+
shotFitsReader?: true;
|
|
167
|
+
/** Add an Excel-compatible CSV action for the pane's single active DataTable. */
|
|
168
|
+
tableExport?: true;
|
|
169
|
+
settings?: PaneSettingsDef | ((context: PaneSettingsContext) => PaneSettingsDef | null);
|
|
170
|
+
/** Portable sharing is public by default; list the few pane-owned fields that must remain local. */
|
|
171
|
+
portableShare?: PanePortableShareDef;
|
|
172
|
+
/**
|
|
173
|
+
* The person's own data the pane shows, so copying a public link to it,
|
|
174
|
+
* posting its picture in a bug report and attaching it to an Ask Gloom
|
|
175
|
+
* question ask first. A function decides
|
|
176
|
+
* per instance from what it shows now (a chat pane on a public channel, a
|
|
177
|
+
* quote of a ticker not held), and a function that returns null opts that
|
|
178
|
+
* instance out. Leave it off for market data. A pane that says nothing is
|
|
179
|
+
* still asked about when its plugin connects a broker (`holdings`) or the
|
|
180
|
+
* pane keeps fields private when shared (`portableShare.private`,
|
|
181
|
+
* `personal`), for plugins written before this field existed; declare it
|
|
182
|
+
* to say exactly what the pane shows.
|
|
183
|
+
*/
|
|
184
|
+
personalData?: PanePersonalData | ((context: PanePersonalDataContext) => PanePersonalData | null);
|
|
185
|
+
/**
|
|
186
|
+
* Compact controls surfaced next to the pane title. A key references a
|
|
187
|
+
* toggle field in settings, or a two-option select field when `onValue` is set.
|
|
188
|
+
*/
|
|
189
|
+
quickSettings?: readonly PaneQuickSettingDef[];
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
/**
|
|
193
|
+
* Kinds of personal data a pane can show: `holdings` (positions, balances,
|
|
194
|
+
* orders, profit and loss), `account` (account numbers, email, plan),
|
|
195
|
+
* `messages` (private conversations) and `personal` (the person's own data
|
|
196
|
+
* of a kind the pane does not name).
|
|
197
|
+
*/
|
|
198
|
+
export type PanePersonalData = "holdings" | "account" | "messages" | "personal";
|
|
199
|
+
|
|
200
|
+
export interface PaneQuickSettingDef {
|
|
201
|
+
type: "toggle";
|
|
202
|
+
key: string;
|
|
203
|
+
icon: "zap" | "sqrt";
|
|
204
|
+
label?: string;
|
|
205
|
+
/**
|
|
206
|
+
* For a two-option select field: the option the control turns on. Turning
|
|
207
|
+
* it off picks the field's other option.
|
|
208
|
+
*/
|
|
209
|
+
onValue?: string;
|
|
210
|
+
/**
|
|
211
|
+
* Shows the control only where it changes something, for a setting that
|
|
212
|
+
* applies to some of what the pane can show. The field stays in the
|
|
213
|
+
* settings dialog either way.
|
|
214
|
+
*/
|
|
215
|
+
visible?: (context: PaneSettingsContext) => boolean;
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
/** What `PaneDef.personalData` decides from: the pane's settings context and the tickers with their positions. */
|
|
219
|
+
export interface PanePersonalDataContext extends PaneSettingsContext {
|
|
220
|
+
tickers: ReadonlyMap<string, TickerRecord>;
|
|
221
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import type { HeadlessPaneContext, HeadlessPaneOptionDef } from "./headless";
|
|
2
|
+
|
|
3
|
+
/** What covers a pane when a report of it is refused: see `PaneDef.reportLockNote`. */
|
|
4
|
+
export interface PaneLock {
|
|
5
|
+
/** Sign-in is the wall of a session that is missing or unverified; pro the one of a plan without access. */
|
|
6
|
+
gate: "sign-in" | "pro";
|
|
7
|
+
/** The first symbol the report was asked for, or null. */
|
|
8
|
+
symbol: string | null;
|
|
9
|
+
/** The function code the report was run for, for a pane that serves several (EM and GUID). */
|
|
10
|
+
token?: string;
|
|
11
|
+
/** The session is signed in and its email is not verified yet. */
|
|
12
|
+
verifyEmail?: boolean;
|
|
13
|
+
/**
|
|
14
|
+
* Reads data as the report does, so a note can check that a free route it
|
|
15
|
+
* would name has data for the symbol before naming it. Absent where nothing
|
|
16
|
+
* can be read.
|
|
17
|
+
*/
|
|
18
|
+
context?: HeadlessPaneContext;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* An option of a rendered-view report, which sets the pane setting of its key,
|
|
23
|
+
* or of `settingKey` when the flag reads better than the setting's name
|
|
24
|
+
* (`--columns` for `optionColumnIds`); with `pluginState`, the pane state the
|
|
25
|
+
* view reads it from (a workspace's tab), and the setting too when it also
|
|
26
|
+
* names a `settingKey`.
|
|
27
|
+
*/
|
|
28
|
+
export interface PaneReportOptionDef extends HeadlessPaneOptionDef {
|
|
29
|
+
/** The value's name in the catalog's flag, `--currencies <codes>`; the type when absent. */
|
|
30
|
+
placeholder?: string;
|
|
31
|
+
/** The option in use as typed after the function, such as `--currencies USD,ZAR,NGN`; the catalog shows it as an example. */
|
|
32
|
+
example?: string;
|
|
33
|
+
/** Checks a typed value and returns it as the pane reads it; throws an Error that names what is wrong. */
|
|
34
|
+
normalize?(value: string): string;
|
|
35
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
export interface WizardStep {
|
|
2
|
+
key: string;
|
|
3
|
+
label: string;
|
|
4
|
+
placeholder?: string;
|
|
5
|
+
defaultValue?: string;
|
|
6
|
+
required?: boolean;
|
|
7
|
+
type?: "text" | "password" | "info" | "select" | "number" | "textarea";
|
|
8
|
+
options?: Array<{ label: string; value: string }>;
|
|
9
|
+
/** Shown only while the earlier answer holds the value; with several, while every one does. */
|
|
10
|
+
dependsOn?: { key: string; value: string } | ReadonlyArray<{ key: string; value: string }>;
|
|
11
|
+
/** Later wizard values to clear when this selection changes from its default. */
|
|
12
|
+
clearOnChange?: string[];
|
|
13
|
+
body?: string[];
|
|
14
|
+
}
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
import type { CachePolicy, PersistedResourceValue } from "./persistence";
|
|
2
|
+
|
|
3
|
+
export interface PluginPersistence {
|
|
4
|
+
getState<T = unknown>(key: string, options?: { schemaVersion?: number }): T | null;
|
|
5
|
+
setState(key: string, value: unknown, options?: { schemaVersion?: number }): void;
|
|
6
|
+
deleteState(key: string): void;
|
|
7
|
+
getResource<T = unknown>(
|
|
8
|
+
kind: string,
|
|
9
|
+
key: string,
|
|
10
|
+
options?: { sourceKey?: string; schemaVersion?: number; allowExpired?: boolean },
|
|
11
|
+
): PersistedResourceValue<T> | null;
|
|
12
|
+
setResource<T = unknown>(
|
|
13
|
+
kind: string,
|
|
14
|
+
key: string,
|
|
15
|
+
value: T,
|
|
16
|
+
options: {
|
|
17
|
+
cachePolicy: CachePolicy;
|
|
18
|
+
sourceKey?: string;
|
|
19
|
+
schemaVersion?: number;
|
|
20
|
+
provenance?: unknown;
|
|
21
|
+
},
|
|
22
|
+
): PersistedResourceValue<T>;
|
|
23
|
+
deleteResource(kind: string, key: string, options?: { sourceKey?: string }): void;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
export interface PluginResumeState {
|
|
27
|
+
getState<T = unknown>(key: string, options?: { schemaVersion?: number }): T | null;
|
|
28
|
+
setState(key: string, value: unknown, options?: { schemaVersion?: number }): void;
|
|
29
|
+
deleteState(key: string): void;
|
|
30
|
+
getPaneState<T = unknown>(paneId: string, key: string): T | null;
|
|
31
|
+
setPaneState(paneId: string, key: string, value: unknown): void;
|
|
32
|
+
deletePaneState(paneId: string, key: string): void;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export interface PluginConfigState {
|
|
36
|
+
get<T = unknown>(key: string): T | null;
|
|
37
|
+
set(key: string, value: unknown): Promise<void>;
|
|
38
|
+
delete(key: string): Promise<void>;
|
|
39
|
+
keys(): string[];
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
export interface PluginTeamStateEntry<T> {
|
|
43
|
+
value: T;
|
|
44
|
+
revision: number;
|
|
45
|
+
updatedBy: string;
|
|
46
|
+
updatedAt: string;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Plugin-owned data shared with a team, keyed per plugin. Writes take the
|
|
51
|
+
* revision they expect and fail when a teammate wrote first, so nothing is
|
|
52
|
+
* overwritten silently. Scoped to the active team unless a teamId is given.
|
|
53
|
+
*/
|
|
54
|
+
export interface PluginTeamState {
|
|
55
|
+
activeTeamId(): string | null;
|
|
56
|
+
get<T>(key: string, options?: { teamId?: string }): Promise<PluginTeamStateEntry<T> | null>;
|
|
57
|
+
list<T>(options?: { teamId?: string }): Promise<Array<PluginTeamStateEntry<T> & { key: string }>>;
|
|
58
|
+
set<T>(key: string, value: T, options?: { teamId?: string; expectRevision?: number }): Promise<{ revision: number }>;
|
|
59
|
+
delete(key: string, options?: { teamId?: string }): Promise<void>;
|
|
60
|
+
subscribe<T>(
|
|
61
|
+
key: string,
|
|
62
|
+
listener: (entry: PluginTeamStateEntry<T> | null) => void,
|
|
63
|
+
options?: { teamId?: string },
|
|
64
|
+
): () => void;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
export interface PluginPaneSettingsState {
|
|
68
|
+
get<T = unknown>(paneId: string, key: string): T | null;
|
|
69
|
+
set(paneId: string, key: string, value: unknown): Promise<void>;
|
|
70
|
+
delete(paneId: string, key: string): Promise<void>;
|
|
71
|
+
}
|