@gloom-sh/terminal 0.19.2 → 0.19.3

package/src/app/attention-notice.tsx

@@ -0,0 +1,94 @@
+import { useEffect, useRef, useSyncExternalStore } from "react";
+import { apiClient } from "../api-client";
+import { t } from "../i18n";
+import { useAppActive } from "../state/app/activity";
+import { useAppDispatch, useAppGetState, useAppSelector } from "../state/app/context";
+import { scheduleConfigSave } from "../state/config-save-scheduler";
+import { cloudSyncController } from "../sync/controller";
+import { attentionCollectionAvailable } from "../telemetry/attention-counts";
+import { ATTENTION_OFF_MESSAGE, attentionNoticeDue, withAttentionNoticeShown } from "../telemetry/attention-setting";
+import { reportTelemetryConfig } from "../telemetry/live-config";
+import type { TelemetryConfig } from "../types/config";
+import type { AppNotificationRequest } from "../types/plugin";
+
+/**
+ * The whole notice, with no title: the terminal draws none, and it has to
+ * name the setting its Turn off acts on and say plainly what leaves the app.
+ */
+const ATTENTION_NOTICE_TEXT = "Attention Counts is now on. Tickers you open are sent to Gloom with your account; only hourly totals of 20+ people are published.";
+
+/** The signed-in account with a verified email, or null; the same account the collector counts for. */
+function verifiedAccount(): string | null {
+  return apiClient.getVerifiedSessionIdentity() ? apiClient.getCurrentUser()?.id ?? null : null;
+}
+
+/** Where the account's synced settings come from; whether they were pulled this session. */
+export interface AccountSettingsSource {
+  subscribe(listener: () => void): () => void;
+  getStatus(): { lastPullAt: string | null };
+}
+
+/**
+ * The one-time notice that Attention Counts is on by default: a toast that
+ * stays until dismissed, with Turn off. It shows once per account on this
+ * installation, while the app is in front, to a verified account whose
+ * setting is untouched, and only after this session has pulled the
+ * account's synced settings, so an off made on another device arrives
+ * before it. Nothing is counted under the default until the toast has been
+ * drawn for that account; an explicit on or off never sees it.
+ */
+export function AttentionCountsNotice({
+  notify,
+  accountSettings = cloudSyncController,
+}: {
+  notify(request: AppNotificationRequest): void;
+  accountSettings?: AccountSettingsSource;
+}) {
+  const dispatch = useAppDispatch();
+  const getState = useAppGetState();
+  const telemetry = useAppSelector((state) => state.config.telemetry);
+  const account = useSyncExternalStore((onChange) => apiClient.subscribeCurrentUser(onChange), verifiedAccount, verifiedAccount);
+  const pulled = useSyncExternalStore(
+    (onChange) => accountSettings.subscribe(onChange),
+    () => accountSettings.getStatus().lastPullAt !== null,
+    () => accountSettings.getStatus().lastPullAt !== null,
+  );
+  const onScreen = useAppActive();
+  /** Accounts this session already showed it to, so a re-render never stacks a second toast. */
+  const asked = useRef(new Set<string>());
+  const due = pulled && attentionNoticeDue(telemetry, account) && attentionCollectionAvailable();
+
+  useEffect(() => {
+    if (!due || !onScreen || !account || asked.current.has(account)) return;
+    asked.current.add(account);
+    const save = (change: (telemetry: TelemetryConfig | undefined) => TelemetryConfig | undefined) => {
+      const current = getState().config;
+      const next = change(current.telemetry);
+      if (next === current.telemetry) return;
+      // Reported first, so turning off drops unsent counts before React commits.
+      reportTelemetryConfig(next);
+      dispatch({ type: "SET_CONFIG", config: { ...current, telemetry: next } });
+      scheduleConfigSave(() => {
+        const state = getState();
+        return { ...state.config, recentTickers: state.recentTickers };
+      });
+    };
+    notify({
+      body: t(ATTENTION_NOTICE_TEXT),
+      type: "info",
+      persistent: true,
+      action: {
+        label: t("Turn off"),
+        onClick: () => {
+          save((current) => ({ ...current, attention: false }));
+          notify({ body: t(ATTENTION_OFF_MESSAGE), type: "success" });
+        },
+      },
+      onShown: () => {
+        if (verifiedAccount() === account) save((current) => withAttentionNoticeShown(current, account));
+      },
+    });
+  }, [account, dispatch, due, getState, notify, onScreen]);
+
+  return null;
+}

package/src/app.tsx

@@ -20,6 +20,7 @@ import { DetachedPaneShell } from "./components/layout/detached-pane-shell";
 import { TransientLayoutProvider } from "./components/layout/transient-layout";
 import { CommandBar } from "./components/command-bar/surface";
 import { OnboardingWizard } from "./components/onboarding/onboarding-wizard";
+import { useRunSetupAgain } from "./components/onboarding/run-setup-again";
 import { CompanyPickerHost } from "./plugins/builtin/cloud/company-picker";
 import { TerminalRelayHost } from "./plugins/builtin/cloud/terminal-relay/host";
 import { SignInGate } from "./components/sign-in-gate";
@@ -30,7 +31,7 @@ import type { AppServicesFactory, AppTickerRepositoryPort } from "./core/app-ser
 import { useThemeColors } from "./theme/theme-context";
 import type { AppConfig } from "./types/config";
 import type { DesktopDeepLinkBridge } from "./types/desktop-deeplink";
-import type { CliLaunchRequest, GloomPlugin } from "./types/plugin";
+import type { AppNotificationRequest, CliLaunchRequest, GloomPlugin } from "./types/plugin";
 import type { DataProvider } from "./types/data-provider";
 import type { DesktopDockPreviewState, DesktopSharedStateSnapshot, DesktopThemePreviewState, DesktopWindowBridge } from "./types/desktop-window";
 import type { DesktopApplicationMenuBridge } from "./types/desktop-menu";
@@ -69,6 +70,7 @@ import { AppLanguageConfigObserver } from "./app/language-observer";
 import { isPaneShareHandoff } from "./shares/location";
 import { apiClient } from "./api-client";
 import { reportTelemetryConfig } from "./telemetry/live-config";
+import { AttentionCountsNotice } from "./app/attention-notice";
 import { recordFunctionOpen } from "./telemetry/usage-counts";
 
 const EMPTY_EXTERNAL_PLUGINS: LoadedExternalPlugin[] = [];
@@ -87,6 +89,8 @@ interface AppInnerProps {
   updatesEnabled?: boolean;
   onboardingActive?: boolean;
   onOnboardingComplete?: (config: AppConfig) => void | Promise<void>;
+  /** Shows setup again once Run Setup Again has saved its progress; absent where setup cannot run. */
+  onRunSetupAgain?: () => void;
   /** Hosted browser terminal: nothing is reachable until a session exists. */
   signInGateActive?: boolean;
   /** Fires once the startup state is in place and the first real layout can paint. */
@@ -127,6 +131,7 @@ function AppInner({
   updatesEnabled = true,
   onboardingActive = false,
   onOnboardingComplete,
+  onRunSetupAgain,
   signInGateActive = false,
   onInitialized,
   pluginsReady,
@@ -186,6 +191,8 @@ function AppInner({
   const dialog = useDialog();
   const toast = useToastHost();
   const isDetachedWindow = desktopWindowBridge?.kind === "detached";
+  // Not while setup is already showing.
+  const runSetupAgain = useRunSetupAgain(onboardingActive ? undefined : onRunSetupAgain);
   const detachedPaneId = isDetachedWindow ? desktopWindowBridge.paneId ?? null : null;
   const focusDetachedPane = useMemo(() => {
     const focus = desktopWindowBridge?.kind === "main" ? desktopWindowBridge.focusDetachedPane : undefined;
@@ -222,6 +229,7 @@ function AppInner({
             onClick: dismissAfter(() => notification.secondaryAction?.onClick()),
           }
           : undefined,
+        onShown: notification.onShown,
       };
       if (type === "success") toastId = toast.success(notification.body, options);
       else if (type === "error") toastId = toast.error(notification.body, options);
@@ -232,6 +240,9 @@ function AppInner({
   const notify = useCallback((body: string, options?: { type?: "info" | "success" | "error" }) => {
     pluginRegistry.notify({ body, ...options });
   }, [pluginRegistry]);
+  const notifyRequest = useCallback((request: AppNotificationRequest) => {
+    pluginRegistry.notify(request);
+  }, [pluginRegistry]);
 
   useEffect(() => {
     if (desktopWindowBridge?.kind !== "main" || !desktopWindowBridge.subscribeDockPreview) return;
@@ -489,6 +500,7 @@ function AppInner({
             />
           </TransientLayoutProvider>
           {!onboardingActive ? <CompanyPickerHost pluginRegistry={pluginRegistry} /> : null}
+          {initialized && !onboardingActive && !signInGateActive ? <AttentionCountsNotice notify={notifyRequest} /> : null}
           <TerminalRelayHost device={remoteControlAdapter?.terminalDevice} />
           {onboardingActive && onOnboardingComplete ? (
             <OnboardingWizard
@@ -505,6 +517,7 @@ function AppInner({
               pluginRegistry={pluginRegistry}
               quitApp={() => rendererHost.requestExit()}
               onCheckForUpdates={updatesEnabled ? runUpdateCommand : undefined}
+              onRunSetupAgain={runSetupAgain}
               onNativeOccluderChange={setCommandBarNativeOccluder}
             />
           )}
@@ -534,6 +547,11 @@ interface AppProps {
    * terminal sets this; desktop and the TUI keep sign-in optional.
    */
   requireSignIn?: boolean;
+  /**
+   * Settings can open setup again (Run Setup Again). The browser keeps no
+   * setup progress, so it turns this off.
+   */
+  setupEnabled?: boolean;
   /** Fires once the startup state is in place and the first real layout can paint. */
   onInitialized?: () => void;
 }
@@ -552,6 +570,7 @@ export function App({
   remoteControlAdapter,
   updatesEnabled = true,
   requireSignIn = false,
+  setupEnabled = true,
   onInitialized,
 }: AppProps) {
   useAppLanguage();
@@ -594,6 +613,8 @@ export function App({
     && (!effectiveInitialConfig.onboardingComplete || !!effectiveInitialConfig.onboardingProgress)
   ));
 
+  const showSetup = useCallback(() => setShowOnboarding(true), []);
+
   useEffect(() => bindAppActivity(renderer), [renderer]);
 
   const services = useMemo(() => {
@@ -656,6 +677,7 @@ export function App({
             setConfig(updatedConfig);
             setShowOnboarding(false);
           }}
+          onRunSetupAgain={setupEnabled && !shareHandoff ? showSetup : undefined}
         />
       </AppProvider>
     </RemoteUiRegistryProvider>

package/src/architecture/core-builtin-allowlist.json

@@ -9,7 +9,7 @@
   "src/cli/commands/options-chain.ts": ["options","options-calculator"],
   "src/cli/commands/options-leaps.ts": ["iv-history","options","vol-surface"],
   "src/cli/commands/overview.ts": ["correlation","econ","market-movers","sectors","world-indices"],
-  "src/cli/commands/ticker.ts": ["ipo-calendar","notes"],
+  "src/cli/commands/ticker.ts": ["ipo-calendar","notes","sec"],
   "src/cli/desktop-pane-shot.ts": ["market-valuation","time-sales"],
   "src/cli/pane-functions/data.ts": ["chart-composer","correlation","seasonality","ticker-detail"],
   "src/cli/pane-functions/financial-ratio-shot.ts": ["ticker-detail"],
@@ -28,6 +28,7 @@
   "src/components/onboarding/use-onboarding-upgrade.ts": ["chat"],
   "src/layout/desks.ts": ["chart-composer"],
   "src/plugins/catalog-browser.ts": ["alerts","analytics","attention","awards","backtest","bond-calculator","catalysts","cds","central-bank-rates","changelog","chart-composer","clinical-trials","cloud","comment-letters","commodities-energy","commodity-balances","company-attention","company-kpis","connections","correlation","cot","cpi","credit-boards","credit-conditions","credit-documents","crypto-board","crypto-etf-flows","debt-maturities","dividend-yield","docs","doe","earnings","earnings-calls","earnings-ripple","econ","econ-statistics","equity-screener","estimate-revisions","executives","exposure","fear-greed","filing-events","fixed-income","futures","futures-curve","fx-matrix","gpu","help","holders","insider","ipo-calendar","iv-history","jobs","jodi","kelly-sizer","layout-manager","macro-day","market-halts","market-heatmap","market-valuation","members","mna","money-markets","news","openfda","options","options-calculator","options-positioning","options-scenario","pe-band","perps","portfolio-list","power","primary-dealers","rate-path","realized-vol","relative-rotation","research","research-search","revenue-breakdown","reverse-dcf","risk-factors","roadmap","scanner","seasonality","sec","sectors","short-interest","short-volume","social-mentions","supply-chain","thirteenf","ticker-detail","time-sales","trace-bonds","treasury-auctions","treasury-daily","vol-surface","volatility","world-indices","world-venue-map","yield-curve"],
+  "src/plugins/catalog-cli.ts": ["alerts","fear-greed","news","notes","portfolio-list"],
   "src/plugins/catalog-ui.ts": ["alerts","clinical-trials","cloud","comment-letters","custom-view","fear-greed","ipo-calendar","market-halts","market-heatmap","members","news","notes","openfda","research-search"],
   "src/plugins/catalog.ts": ["debug"],
   "src/remote/controller.ts": ["custom-view"],

package/src/capabilities/factories.ts

@@ -36,6 +36,7 @@ export function assetDataProvider(provider: AssetDataProvider): AssetDataCapabil
     operations: {
       canProvide: op((input: any) => provider.canProvide?.(input.ticker, input.exchange, input.context) ?? true, "query"),
       primaryMarketSourceName: op(() => provider.primaryMarketSourceName?.() ?? provider.name, "query"),
+      batchesReads: op((input: any) => provider.batchesReads?.(input.method) ?? false, "query"),
       getCachedFinancialsForTargets: op((input: any) => provider.getCachedFinancialsForTargets?.(input.targets ?? [], input.options) ?? new Map()),
       getQuotesBatch: op((input: any) => provider.getQuotesBatch?.(input.targets ?? [], input.options) ?? Promise.resolve([])),
       getTickerFinancialsBatch: op((input: any) => provider.getTickerFinancialsBatch?.(input.targets ?? [], input.options) ?? Promise.resolve([])),

package/src/cli/ascii-output.ts

@@ -0,0 +1,42 @@
+import { format } from "util";
+import { asciiText } from "../utils/ascii-text";
+
+const NON_ASCII = /[^\x00-\x7F]/;
+
+type ConsoleMethod = "log" | "info" | "warn" | "error";
+const CONSOLE_STREAMS: ReadonlyArray<readonly [ConsoleMethod, "stdout" | "stderr"]> = [
+  ["log", "stdout"], ["info", "stdout"], ["warn", "stderr"], ["error", "stderr"],
+];
+
+/**
+ * Writes the command's text in ASCII while `enabled` says so (`cliAsciiEnabled`:
+ * plain output to a terminal that cannot show UTF-8), whichever way it is
+ * written: `process.stdout.write`, `process.stderr.write` or the console, which
+ * Bun writes without going through either stream. Tables are already ASCII
+ * when they are drawn, so their columns line up (`renderTable`); this catches
+ * the lines around them, such as a source line's `·`. A chunk that is not a
+ * string (a PNG on stdout) passes as it is, and so does all output while
+ * `enabled` is false.
+ */
+export function writeAsciiWhile(enabled: () => boolean): void {
+  const needsAscii = (text: string) => NON_ASCII.test(text) && enabled();
+  for (const name of ["stdout", "stderr"] as const) {
+    const stream = process[name];
+    const write = stream.write.bind(stream) as (chunk: unknown, ...rest: unknown[]) => boolean;
+    stream.write = ((chunk: unknown, ...rest: unknown[]) => write(
+      typeof chunk === "string" && needsAscii(chunk) ? asciiText(chunk) : chunk,
+      ...rest,
+    )) as typeof stream.write;
+  }
+  for (const [method, name] of CONSOLE_STREAMS) {
+    const original = console[method].bind(console);
+    console[method] = (...args: unknown[]) => {
+      const text = format(...args);
+      if (!needsAscii(text)) {
+        original(...args);
+        return;
+      }
+      process[name].write(`${asciiText(text)}\n`);
+    };
+  }
+}

package/src/cli/base-converter.ts

@@ -3,12 +3,14 @@ import { fixedUsdRate, heldCurrencyUnit } from "../utils/currency-units";
 import { logFailure } from "../utils/log-failure";
 
 /** One rate a converter used: units of `baseCurrency` per unit of `currency`, and when it was observed. */
-interface BaseConversion {
+export interface BaseConversion {
   currency: string;
   baseCurrency: string;
   rate: number;
   /** Epoch ms of the older leg's observation; null when the source did not date it. */
   asOf: number | null;
+  /** A leg is past its fresh window, or its refresh failed and the last copy stands. */
+  stale: boolean;
 }
 
 /** Converts an amount into the base currency, and lists the rates it used so a report can state them. */
@@ -21,6 +23,8 @@ export type BaseConverter = ((value: number, fromCurrency: string) => Promise<nu
 interface UsdRate {
   rate: number;
   asOf: number | null;
+  /** Past its fresh window, or kept after a failed refresh. */
+  stale?: boolean;
 }
 
 export function createBaseConverter(
@@ -38,7 +42,10 @@ export function createBaseConverter(
       if (dataProvider.getCachedQuery) {
         const entry = await dataProvider.getCachedQuery("getExchangeRate", [currency])
           .load({ background: dataProvider.revalidatesInBackground });
-        return { rate: Number.isFinite(entry.value) && entry.value > 0 ? entry.value : Number.NaN, asOf: entry.asOf ?? null };
+        return {
+          rate: Number.isFinite(entry.value) && entry.value > 0 ? entry.value : Number.NaN, asOf: entry.asOf ?? null,
+          stale: entry.refreshError != null || entry.staleAt <= Date.now(),
+        };
       }
       const rate = await dataProvider.getExchangeRate(currency);
       return { rate: Number.isFinite(rate) && rate > 0 ? rate : Number.NaN, asOf: null };
@@ -73,6 +80,7 @@ export function createBaseConverter(
       baseCurrency: base.currency,
       rate: fromRate.rate / baseRate.rate,
       asOf: dates.length > 0 ? Math.min(...dates) : null,
+      stale: fromRate.stale === true || baseRate.stale === true,
     });
     return (value / from.divisor * fromRate.rate) / baseRate.rate * base.divisor;
   };

package/src/cli/command-options.ts

@@ -55,6 +55,21 @@ function declaredOptions(command: CliCommandDef): Map<string, DeclaredOption> |
 const EXPLAIN_HINT = "--explain follows the reports of fn <function> and portfolio show. "
   + "gloom catalog explain <term> prints what one term means; gloom catalog glossary lists every term.";
 
+/** Options people reach for to see a price in another currency, which no command takes: `fx` converts. */
+const CURRENCY_OPTIONS = new Set(["--currency", "--ccy", "--cur", "--convert", "--fx", "--to-currency", "--in-currency"]);
+
+/**
+ * `quote SBLK --currency EUR`: prices are in each listing's currency, and
+ * `fx` converts an amount, so the error names it, with the code given.
+ */
+function currencyOptionHint(flag: string, args: readonly string[]): string | null {
+  if (!CURRENCY_OPTIONS.has(flag)) return null;
+  const at = args.findIndex((arg) => arg === flag || arg.startsWith(`${flag}=`));
+  const typed = (args[at]?.includes("=") ? args[at]!.slice(flag.length + 1) : args[at + 1] ?? "").trim().toUpperCase();
+  const code = /^[A-Z]{3}$/.test(typed) ? typed : "EUR";
+  return `Prices are in each listing's own currency. To convert an amount, use fx: gloom fx 100 USD/${code}.`;
+}
+
 function failUnknownOption(
   command: BuiltinCliCommandDef,
   flag: string,
@@ -65,7 +80,7 @@ function failUnknownOption(
   const suggestion = suggestCliOption(flag, flags);
   const help = `See gloom help ${command.name}.`;
   fail(`Unknown option ${flag} for ${command.name}.`, [
-    command.unknownOptionHint?.(flag, args) ?? (flag === "--explain" ? EXPLAIN_HINT : ""),
+    command.unknownOptionHint?.(flag, args) ?? currencyOptionHint(flag, args) ?? (flag === "--explain" ? EXPLAIN_HINT : ""),
     suggestion ? `Did you mean ${suggestion}?` : "",
     flags.length > 0 ? `Options: ${flags.join(", ")}. ${help}` : `${command.name} takes no options. ${help}`,
   ].filter(Boolean).join("\n"));

package/src/cli/commands/crypto-hints.ts

@@ -73,21 +73,32 @@ export function coinElsewhereNote(symbol: string, listings: ReadonlyArray<{ key:
   return `${symbol} is ${named}, not ${coin}. For ${coin} use ${symbol}-USD.`;
 }
 
+/** A top coin quoted in dollars (BTC-USD, or on the crypto venue BTC-USD:CCC), which the CRYP board lists. */
+function isBoardCoinPair(symbol: string): boolean {
+  const [pair = "", venue] = symbol.trim().toUpperCase().split(":");
+  const match = venue === undefined || venue === "CCC" ? /^([A-Z0-9]+)-USD$/.exec(pair) : null;
+  return !!match && MAJOR_COINS.has(match[1]!);
+}
+
 interface QuoteNoteResult {
   target: { symbol: string };
-  quote: Pick<Quote, "name" | "instrumentType"> | null;
+  quote: Pick<Quote, "name" | "instrumentType"> & Partial<Pick<Quote, "dataSource">> | null;
   error: string | null;
 }
 
 /**
- * The router words a failure as "<reason> for <symbol>"; drop the symbol so equal reasons group.
- * Any other line, such as a sentence the data service wrote, is kept as it reads.
+ * The router words a failure as "<reason> for <symbol>", alone or closing its
+ * first sentence ("Gloom's data service did not answer for X. Try again in a
+ * moment."); drop the symbol so equal reasons group. Any other line, such as a
+ * sentence the data service wrote, is kept as it reads.
  */
 function failureReason(message: string, symbol: string): string {
   const line = (message.split("\n")[0] ?? "").trim();
   const bare = line.replace(/\.+$/, "");
   const suffix = ` for ${symbol}`;
-  return bare.toLowerCase().endsWith(suffix.toLowerCase()) ? bare.slice(0, -suffix.length) : line;
+  if (bare.toLowerCase().endsWith(suffix.toLowerCase())) return bare.slice(0, -suffix.length);
+  const at = line.toLowerCase().indexOf(`${suffix.toLowerCase()}. `);
+  return at > 0 ? `${line.slice(0, at)}${line.slice(at + suffix.length)}` : line;
 }
 
 /**
@@ -112,6 +123,14 @@ export function quoteNotes(results: QuoteNoteResult[]): string[] {
   const perpetuals = results
     .filter((result) => result.quote && isCryptoVenuePerpetual(result.quote.instrumentType, result.quote.name))
     .map((result) => result.target.symbol);
+  // A top coin's delayed quote is live on the crypto board, which needs no plan to stream it.
+  const boardCoins = results
+    .filter((result) => result.quote?.dataSource === "delayed" && isCryptoInstrumentType(result.quote.instrumentType ?? "")
+      && isBoardCoinPair(result.target.symbol))
+    .map((result) => result.target.symbol);
+  if (boardCoins.length > 0) {
+    notes.push(`${boardCoins.join(", ")} ${boardCoins.length === 1 ? "streams" : "stream"} live on the CRYP board (gloom fn CRYP).`);
+  }
   if (perpetuals.length > 0) {
     notes.push(`${perpetuals.join(", ")}: perpetual futures ${perpetuals.length === 1 ? "price" : "prices"} on crypto venues, 24/7; not the listed future, not spot.`);
   }