@gloom-sh/terminal 0.19.1 → 0.19.3

package/src/account/upgrade-personalization.ts

@@ -1,57 +0,0 @@
-import { useEffect, useMemo, useReducer } from "react";
-import { apiClient } from "../api-client";
-import { usePlanAccess } from "../api-client/plan-access";
-import { exposeUpgradePersonalized, knownUpgradePersonalized } from "../api-client/research-activity";
-import { useOptionalAppSelector } from "../state/app/context";
-import { useAppVisible } from "../state/app/activity";
-import type { TickerFinancials } from "../types/financials";
-import type { TickerRecord, Watchlist } from "../types/ticker";
-import { selectUpgradeTickers } from "./upgrade-tickers";
-
-const NO_TICKERS = new Map<string, TickerRecord>();
-const NO_FINANCIALS = new Map<string, TickerFinancials>();
-const NO_WATCHLISTS: Watchlist[] = [];
-
-/** This device's top tickers for an upgrade surface; stable while the selection is. */
-function useUpgradeTickers(): readonly string[] {
-  const tickers = useOptionalAppSelector((state) => state.tickers, NO_TICKERS);
-  const financials = useOptionalAppSelector((state) => state.financials, NO_FINANCIALS);
-  const watchlists = useOptionalAppSelector((state) => state.config.watchlists, NO_WATCHLISTS);
-  const key = useMemo(
-    () => selectUpgradeTickers(tickers.values(), financials, watchlists).join(","),
-    [financials, tickers, watchlists],
-  );
-  return useMemo(() => (key ? key.split(",") : []), [key]);
-}
-
-/**
- * The tickers to name on an upgrade surface, or null for the generic copy.
- * Asks for the `upgrade_personalized` arm once the surface is `shown` to a
- * signed-in free account with at least one usable ticker; everyone else, the
- * control arm, and anyone the API leaves out keep the generic copy. Until the
- * first answer of the session arrives the surface shows the generic copy.
- */
-export function useUpgradePersonalization(placement: string, shown: boolean): readonly string[] | null {
-  const tickers = useUpgradeTickers();
-  const access = usePlanAccess();
-  const visible = useAppVisible();
-  const accountId = access.signedIn ? apiClient.getCurrentUser()?.id ?? null : null;
-  const eligible = shown && visible && !!accountId && !access.hasProAccess && tickers.length > 0;
-  const [, refresh] = useReducer((revision: number) => revision + 1, 0);
-
-  useEffect(() => {
-    if (!eligible || !accountId) return;
-    let live = true;
-    void exposeUpgradePersonalized(placement).then(() => {
-      if (live) refresh();
-    });
-    return () => {
-      live = false;
-    };
-  }, [accountId, eligible, placement]);
-
-  if (!eligible) return null;
-  // Recheck the current account and privacy flags even after an earlier answer.
-  const arm = knownUpgradePersonalized();
-  return arm === "personalized" ? tickers : null;
-}

package/src/account/upgrade-tickers.ts

@@ -1,124 +0,0 @@
-/**
- * The tickers an upgrade surface may name for the `upgrade_personalized`
- * experiment: the account's own holdings, or with none, the tickers it chose
- * to watch, read from this device's portfolios and watchlists. They stay on
- * the device; nothing here is sent anywhere.
- */
-import { tf } from "../i18n";
-import type { TickerFinancials } from "../types/financials";
-import type { TickerRecord, Watchlist } from "../types/ticker";
-import { isUsListingExchange } from "../utils/exchanges";
-import { getPortfolioPositionValue } from "../portfolio/position-value";
-import { STARTER_SYMBOLS } from "../tickers/starter-symbols";
-
-const UPGRADE_TICKER_LIMIT = 3;
-/** One to five letters and an optional class letter: BRK.B, never BTC-USD, ES=F, ^GSPC, SHOP.TO or 7203. */
-const PLAIN_TICKER = /^[A-Z]{1,5}(?:\.[A-Z])?$/;
-/** Every candidate is a US listing, so values compare in dollars without a rate. */
-const DOLLARS = new Map([["USD", 1]]);
-/** Stocks and exchange-traded funds; not mutual funds, which have no intraday quote. */
-const LISTED_TYPES = new Set(["", "STK", "EQUITY", "COMMONSTOCK", "ADR", "DEPOSITARYRECEIPT", "ETF", "ETP", "CEF", "CLOSEDEND", "CLOSEDENDFUND"]);
-
-/** A stock or fund on a US listing exchange (not OTC), priced in dollars. */
-function isUsListedStockOrFund(ticker: TickerRecord): boolean {
-  const contract = ticker.metadata.broker_contracts?.[0];
-  const type = (contract?.secType ?? ticker.metadata.assetCategory ?? "").trim().toUpperCase().replace(/[\s_-]/g, "");
-  const currency = (contract?.currency ?? ticker.metadata.currency ?? "").trim().toUpperCase();
-  return LISTED_TYPES.has(type)
-    && (currency === "USD" || currency === "")
-    && [contract?.primaryExchange, contract?.exchange, ticker.metadata.exchange].some((exchange) => isUsListingExchange(exchange));
-}
-
-/**
- * The symbol when it is a plain US stock or fund someone can get a real-time
- * quote for: not cash, an option, a future, a crypto pair or a foreign listing.
- */
-function plainSymbol(ticker: TickerRecord): string | null {
-  const symbol = ticker.metadata.ticker.trim().toUpperCase();
-  if (!PLAIN_TICKER.test(symbol) || !isUsListedStockOrFund(ticker)) return null;
-  // A contract multiplier means the holding is an option or a future on it.
-  if (ticker.metadata.positions.some((position) => (position.multiplier ?? 1) !== 1)) return null;
-  return symbol;
-}
-
-interface Holding {
-  /** The market value is known on this device: a quote it already has, or the broker's own value. */
-  priced: boolean;
-  value: number;
-}
-
-/**
- * Gross market value of the shares held, valued like the portfolio pane from
- * what the device already has; null when none are held. Without a quote or a
- * broker value it falls back to what was paid, and says so with `priced`.
- */
-function heldValue(ticker: TickerRecord, financials: TickerFinancials | undefined): Holding | null {
-  const held = ticker.metadata.positions.filter((position) => position.shares !== 0);
-  if (held.length === 0) return null;
-  const value = getPortfolioPositionValue({
-    ticker,
-    financials: financials ?? null,
-    portfolioId: null,
-    baseCurrency: "USD",
-    exchangeRates: DOLLARS,
-  });
-  if (Number.isFinite(value)) return { priced: true, value };
-  const cost = held.reduce((total, position) => total + Math.abs(position.shares * (position.avgCost ?? 0)), 0);
-  return { priced: false, value: Number.isFinite(cost) ? cost : 0 };
-}
-
-/**
- * Up to three tickers, or none for the generic copy:
- * - the biggest holdings across every portfolio, those with a known market
- *   value first by that value, then any the device cannot value yet by cost;
- * - with nothing held, the first watchlist tickers in list order (lists in
- *   their order, each sorted by ticker as the pane shows it). Team lists and
- *   the names the app seeds on first run are skipped: nobody here picked them.
- */
-export function selectUpgradeTickers(
-  tickers: Iterable<TickerRecord>,
-  financials: ReadonlyMap<string, TickerFinancials>,
-  watchlists: readonly Watchlist[],
-): string[] {
-  const records = [...tickers];
-  const holdings = new Map<string, Holding>();
-  for (const ticker of records) {
-    const symbol = plainSymbol(ticker);
-    if (!symbol) continue;
-    const holding = heldValue(ticker, financials.get(ticker.metadata.ticker));
-    if (holding) holdings.set(symbol, holding);
-  }
-  if (holdings.size > 0) {
-    return [...holdings]
-      .sort(([leftSymbol, left], [rightSymbol, right]) => (
-        Number(right.priced) - Number(left.priced)
-        || right.value - left.value
-        || leftSymbol.localeCompare(rightSymbol)
-      ))
-      .slice(0, UPGRADE_TICKER_LIMIT)
-      .map(([symbol]) => symbol);
-  }
-
-  const picked: string[] = [];
-  for (const watchlist of watchlists) {
-    if (watchlist.teamId) continue;
-    const members = records
-      .filter((ticker) => ticker.metadata.watchlists.includes(watchlist.id))
-      .sort((left, right) => left.metadata.ticker.localeCompare(right.metadata.ticker));
-    for (const ticker of members) {
-      const symbol = plainSymbol(ticker);
-      if (!symbol || STARTER_SYMBOLS.has(symbol) || picked.includes(symbol)) continue;
-      picked.push(symbol);
-      if (picked.length === UPGRADE_TICKER_LIMIT) return picked;
-    }
-  }
-  return picked;
-}
-
-/** "NVDA", "NVDA and AAPL", "NVDA, AAPL and MSFT". */
-export function upgradeTickerList(tickers: readonly string[]): string {
-  const [first = "", second, third] = tickers;
-  if (third) return tf("{first}, {second} and {third}", { first, second: second!, third });
-  if (second) return tf("{first} and {second}", { first, second });
-  return first;
-}

package/src/api-client/upgrade-experiment.ts

@@ -1,91 +0,0 @@
-import { logFailure } from "../utils/log-failure";
-import type { ExperimentAnswer, StorageLike } from "./web-experiments";
-
-/**
- * `upgrade_personalized`: the upgrade sheet and onboarding's Pro step name
- * the account's own holdings, or the tickers it watches, instead of the
- * generic line. The registry, the arm and the stop
- * switch live with the API (gloomberb-platform `shared/experiments.ts`); the
- * unit is the signed-in free account, so the same person gets the same arm in
- * the terminal, the desktop app, the web terminal and on gloom.sh/cloud.
- *
- * The tickers never leave the device: the exposure carries the experiment and
- * where it was shown, nothing about the holdings.
- */
-export const UPGRADE_PERSONALIZED = "upgrade_personalized";
-
-export type UpgradePersonalizedVariant = "control" | "personalized";
-
-export interface UpgradeExperimentContext {
-  accountId?: string;
-  pro: boolean;
-  optedOut: boolean;
-  automated: boolean;
-  /** Keeps this session's answer across reloads where there is one (web, desktop). */
-  session?: StorageLike;
-}
-
-const SESSION_PREFIX = "gloomberb.upgrade-personalized.exposed:";
-
-function unit(context: UpgradeExperimentContext): string | undefined {
-  if (!context.accountId || context.pro || context.optedOut || context.automated) return undefined;
-  return `account:${context.accountId}`;
-}
-
-function isVariant(value: unknown): value is UpgradePersonalizedVariant {
-  return value === "control" || value === "personalized";
-}
-
-function read(storage: StorageLike | undefined, key: string): string | null {
-  try { return storage?.getItem(key) ?? null; } catch { /* Intentional ignore: Private browsing may deny optional experiment storage. */ return null; }
-}
-
-function write(storage: StorageLike | undefined, key: string, value: string): void {
-  try { storage?.setItem(key, value); } catch { /* Intentional ignore: Private browsing may deny optional experiment storage. */ }
-}
-
-/**
- * One exposure per account and session. An accepted arm, or the API's "not in
- * the experiment", is kept for the session; a failed request (offline, an API
- * that does not know the experiment yet, a timeout) is not an exposure and is
- * asked again by the next surface.
- */
-export function createUpgradeExperimentSession() {
-  const answers = new Map<string, UpgradePersonalizedVariant | null>();
-  const pending = new Map<string, Promise<UpgradePersonalizedVariant | null>>();
-
-  function known(context: UpgradeExperimentContext): UpgradePersonalizedVariant | null | undefined {
-    const identity = unit(context);
-    if (!identity) return null;
-    if (answers.has(identity)) return answers.get(identity);
-    const saved = read(context.session, `${SESSION_PREFIX}${identity}`);
-    if (saved === "excluded") return null;
-    return isVariant(saved) ? saved : undefined;
-  }
-
-  return {
-    /** The arm already answered in this session, null outside it, undefined when not asked yet. */
-    known,
-    expose(
-      context: UpgradeExperimentContext,
-      ask: () => Promise<ExperimentAnswer>,
-    ): Promise<UpgradePersonalizedVariant | null> {
-      const identity = unit(context);
-      if (!identity) return Promise.resolve(null);
-      const previous = known(context);
-      if (previous !== undefined) return Promise.resolve(previous);
-      const inFlight = pending.get(identity);
-      if (inFlight) return inFlight;
-      const request = (async () => {
-        let answer: ExperimentAnswer;
-        try { answer = await ask(); } catch (error) { logFailure("cloud-experiments", "Experiment exposure request failed")(error); return null; }
-        const variant = answer.accepted && isVariant(answer.variant) ? answer.variant : null;
-        answers.set(identity, variant);
-        write(context.session, `${SESSION_PREFIX}${identity}`, variant ?? "excluded");
-        return variant;
-      })().finally(() => pending.delete(identity));
-      pending.set(identity, request);
-      return request;
-    },
-  };
-}

package/src/plugins/builtin/cloud/browser.tsx

@@ -1,3 +0,0 @@
-import { createGloomberbCloudPlugin } from "./plugin";
-
-export const browserGloomberbCloudPlugin = createGloomberbCloudPlugin();