gloomberb 0.18.1 → 0.18.3

package/src/brokers/logos.ts

@@ -0,0 +1,66 @@
+/**
+ * The logo a broker is listed with on the desktop and the web: the icon of the
+ * plugin that registered it (its gloom.json `icon`), else the app's own for a
+ * broker Gloom connects for you (a signed-in broker, which no plugin owns),
+ * else none, and the list draws the broker's initial instead (LogoMark).
+ */
+import type { BrokerAdapter } from "../types/broker";
+import type { BrokerInstanceConfig } from "../types/config";
+import type { Portfolio } from "../types/ticker";
+import type { BrokerDirectoryEntry } from "./directory";
+
+function svg(markup: string): string {
+  return `data:image/svg+xml,${encodeURIComponent(markup)}`;
+}
+
+/**
+ * The marks the official plugins ship as their icon, for the same brokers
+ * when Gloom connects them, keyed by the backend's broker id.
+ */
+const SIGNED_IN_BROKER_LOGOS: Readonly<Record<string, string>> = {
+  ibkr: svg('<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64"><defs><linearGradient id="t" x1="0" y1="0" x2="0" y2="64" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#262626"/><stop offset="1" stop-color="#0F0F0F"/></linearGradient><linearGradient id="m" gradientUnits="userSpaceOnUse" x1="3633.335" y1="66.0445" x2="3671.0737" y2="66.0445" gradientTransform="matrix(-1 0 0 1 3673.7529 0)"><stop offset="0" stop-color="#D71F27"/><stop offset="1" stop-color="#971B1E"/></linearGradient></defs><rect width="64" height="64" fill="url(#t)"/><g transform="translate(20.4 8.2) scale(0.539)"><polygon points="40.4,86.8 2.7,86.8 2.7,45.3" fill="url(#m)"/><polygon points="40.4,1.5 2.7,45.3 2.7,86.8" fill="#D71F27"/><circle cx="35.2" cy="55.5" r="11.3" fill="#D71F27"/></g></svg>'),
+  robinhood: svg('<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64"><rect width="64" height="64" fill="#CCFF00"/><path transform="translate(14 14) scale(1.5)" d="M2.84 24h.53c.096 0 .192-.048.224-.128C7.591 13.696 11.94 8.656 14.67 5.638c.112-.128.064-.225-.096-.225h-4.88a.55.55 0 0 0-.45.225L5.746 9.972c-.514.642-.642 1.236-.642 2.086v4.43c-1.14 3.194-1.862 5.361-2.392 7.32-.032.125.016.192.129.192M20.447.646c-.754-.802-4.157-.834-5.73-.224a3 3 0 0 0-.786.465 41 41 0 0 0-3.323 3.178c-.112.113-.064.225.097.225h5.409c.497 0 .786.289.786.786v6.1c0 .16.128.208.225.064l3.258-4.254c.53-.69.69-.898.835-1.861.192-1.413.08-3.58-.77-4.479m-6.982 16.18 2.231-3.676a.7.7 0 0 0 .064-.29V6.73c0-.16-.112-.225-.224-.097-3.355 3.74-5.971 7.672-8.395 12.407-.06.12.016.225.16.177l5.009-1.54c.565-.174.882-.402 1.155-.852" fill="#1A1A1A"/></svg>'),
+};
+
+/** The plugin icon of a broker adapter (`getBrokerLogo` on the plugin runtime). */
+export type BrokerPluginLogo = (brokerType: string) => string | null;
+
+function logoFor(brokerKey: string, pluginIcon: string | null): string | null {
+  return pluginIcon ?? SIGNED_IN_BROKER_LOGOS[brokerKey] ?? null;
+}
+
+/** A broker in Add Broker's list: the icon of the plugin that connects it on this device, else Gloom's own. */
+export function brokerDirectoryLogo(entry: BrokerDirectoryEntry, pluginLogo: BrokerPluginLogo): string | null {
+  const device = entry.methods.find((method) => method.kind === "device");
+  return logoFor(entry.key, device ? pluginLogo(device.adapter.id) : null);
+}
+
+/** A broker profile: its adapter's plugin icon, or the logo of the broker a signed-in profile connects. */
+export function brokerProfileLogo(
+  instance: BrokerInstanceConfig,
+  adapter: BrokerAdapter | null,
+  pluginLogo: BrokerPluginLogo,
+): string | null {
+  const brokerKey = adapter?.portfolioBrokerId?.(instance) || instance.brokerType;
+  return logoFor(brokerKey, pluginLogo(instance.brokerType));
+}
+
+/**
+ * The broker a portfolio's account is at, for its tab: the logo and the name
+ * its initial stands in for. Null for a portfolio no broker fills.
+ */
+export function brokerPortfolioLogo(
+  portfolio: Pick<Portfolio, "brokerId" | "brokerInstanceId">,
+  instances: readonly BrokerInstanceConfig[],
+  getAdapter: (brokerType: string) => BrokerAdapter | null,
+  pluginLogo: BrokerPluginLogo,
+): { src: string | null; name: string } | null {
+  if (!portfolio.brokerInstanceId) return null;
+  const instance = instances.find((candidate) => candidate.id === portfolio.brokerInstanceId);
+  if (!instance) {
+    return portfolio.brokerId ? { src: logoFor(portfolio.brokerId, null), name: portfolio.brokerId } : null;
+  }
+  const adapter = getAdapter(instance.brokerType);
+  const name = adapter?.describeInstance?.(instance).brokerName ?? adapter?.name ?? instance.label;
+  return { src: brokerProfileLogo(instance, adapter, pluginLogo), name };
+}

package/src/brokers/profile-form.ts

@@ -6,6 +6,8 @@ import { t, tf } from "../i18n";
 export interface BrokerProfileDraft {
   label: string;
   enabled: boolean;
+  /** Keep the connection's data on this device, out of Gloom Cloud sync. */
+  localOnly: boolean;
   values: Record<string, string>;
 }
 
@@ -47,6 +49,7 @@ export function createBrokerProfileDraft(
   return {
     label: instance?.label || adapter.name,
     enabled: instance?.enabled !== false,
+    localOnly: instance?.localOnly === true,
     values: flattenBrokerConfigValues(adapter, instance),
   };
 }

package/src/brokers/remote-broker-adapter.ts

@@ -1,6 +1,6 @@
 import type { TimeRange } from "../time-series/range";
 import type { ManualChartResolution } from "../time-series/resolution";
-import type { BrokerAdapter, BrokerConnectionStatus } from "../types/broker";
+import type { BrokerAdapter, BrokerConnectionStatus, BrokerHistoryOptions, BrokerOrderListener } from "../types/broker";
 import type { BrokerInstanceConfig } from "../types/config";
 import type { QuoteSubscriptionTarget } from "../types/data-provider";
 import type { BrokerContractRef } from "../types/instrument";
@@ -15,6 +15,7 @@ export interface BrokerRemoteClient {
     targets: QuoteSubscriptionTarget[],
     onQuote: (target: QuoteSubscriptionTarget, quote: any) => void,
   ): () => void;
+  subscribeOrders(instanceId: string, listener: BrokerOrderListener): () => void;
   removeInstance(instanceId: string): Promise<void>;
   destroyAll(): Promise<void>;
 }
@@ -73,7 +74,8 @@ export function createRemoteBrokerAdapter(adapter: BrokerAdapter): BrokerAdapter
       bufferRange: TimeRange,
       resolution: ManualChartResolution,
       instrument?: BrokerContractRef | null,
-    ) => invoke(instance, "getPriceHistoryForResolution", [ticker, exchange, bufferRange, resolution, instrument]),
+      options?: BrokerHistoryOptions,
+    ) => invoke(instance, "getPriceHistoryForResolution", [ticker, exchange, bufferRange, resolution, instrument, ...(options ? [options] : [])]),
     getDetailedPriceHistory: (
       ticker,
       instance,
@@ -82,7 +84,8 @@ export function createRemoteBrokerAdapter(adapter: BrokerAdapter): BrokerAdapter
       endDate: Date,
       barSize: string,
       instrument?: BrokerContractRef | null,
-    ) => invoke(instance, "getDetailedPriceHistory", [ticker, exchange, startDate, endDate, barSize, instrument]),
+      options?: BrokerHistoryOptions,
+    ) => invoke(instance, "getDetailedPriceHistory", [ticker, exchange, startDate, endDate, barSize, instrument, ...(options ? [options] : [])]),
     getChartResolutionSupport: (ticker, instance, exchange?: string, instrument?: BrokerContractRef | null) =>
       invoke(instance, "getChartResolutionSupport", [ticker, exchange, instrument]),
     getChartResolutionCapabilities: (ticker, instance, exchange?: string, instrument?: BrokerContractRef | null) =>
@@ -95,7 +98,14 @@ export function createRemoteBrokerAdapter(adapter: BrokerAdapter): BrokerAdapter
     subscribeQuotes: adapter.subscribeQuotes
       ? (instance, targets, onQuote) => getBrokerRemoteClient()?.subscribeQuotes(instance.id, targets, onQuote) ?? (() => {})
       : undefined,
+    subscribeOrders: adapter.subscribeOrders
+      ? (instance, listener) => getBrokerRemoteClient()?.subscribeOrders(instance.id, listener) ?? (() => {})
+      : undefined,
     listOpenOrders: (instance) => invoke(instance, "listOpenOrders"),
+    // The view's own adapter has no session: a ticket confirming an order must ask the one that placed it.
+    getOrderStatus: adapter.getOrderStatus
+      ? (instance, orderId: number) => invoke(instance, "getOrderStatus", [orderId])
+      : undefined,
     listExecutions: (instance) => invoke(instance, "listExecutions"),
     previewOrder: (instance, request: BrokerOrderRequest) => invoke(instance, "previewOrder", [request]),
     placeOrder: (instance, request: BrokerOrderRequest) => invoke(instance, "placeOrder", [request]),

package/src/capabilities/index.ts

@@ -25,7 +25,7 @@ export {
   AI_RUNNER_CAPABILITY_ID, BROKER_CAPABILITY_ID, NOTES_FILES_CAPABILITY_ID,
 } from "./service-capabilities";
 export type {
-  AiAuthProgressEvent, AiRunnerAgentMessage, AiRunnerEvent, BrokerQuoteEvent, BrokerRemoteEvent,
+  AiAuthProgressEvent, AiRunnerAgentMessage, AiRunnerEvent, BrokerOrderEvent, BrokerQuoteEvent, BrokerRemoteEvent,
   BrokerStatusEvent,
 } from "./service-capabilities";
 export {

package/src/capabilities/service-capabilities.ts

@@ -1,6 +1,7 @@
 import type { BrokerConnectionStatus } from "../types/broker";
 import type { QuoteSubscriptionTarget } from "../types/data-provider";
 import type { Quote } from "../types/financials";
+import type { BrokerOrder } from "../types/trading";
 
 export const BROKER_CAPABILITY_ID = "broker.core";
 export const NOTES_FILES_CAPABILITY_ID = "notes.files";
@@ -18,7 +19,12 @@ export type BrokerQuoteEvent = {
   quote: Quote;
 };
 
-export type BrokerRemoteEvent = BrokerStatusEvent | BrokerQuoteEvent;
+/** An order change, or the order stream going live or quiet, from `BrokerAdapter.subscribeOrders`. */
+export type BrokerOrderEvent =
+  | { kind: "order"; order: BrokerOrder }
+  | { kind: "orders-live"; live: boolean };
+
+export type BrokerRemoteEvent = BrokerStatusEvent | BrokerQuoteEvent | BrokerOrderEvent;
 
 /**
  * What an AI runtime reports while it signs an account in.

package/src/cli/base-converter.ts

@@ -2,34 +2,76 @@ import type { DataProvider } from "../types/data-provider";
 import { fixedUsdRate } from "../utils/currency-units";
 import { logFailure } from "../utils/log-failure";
 
-export function createBaseConverter(dataProvider: Pick<DataProvider, "getExchangeRate">, baseCurrency: string) {
-  const rateCache = new Map<string, number>([["USD", 1]]);
+/** One rate a converter used: units of `baseCurrency` per unit of `currency`, and when it was observed. */
+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;
+}
 
-  const getRate = async (currency: string): Promise<number> => {
-    const normalizedCurrency = currency.toUpperCase();
-    const cached = rateCache.get(normalizedCurrency) ?? fixedUsdRate(normalizedCurrency);
-    if (cached != null) return cached;
+/** Converts an amount into the base currency, and lists the rates it used so a report can state them. */
+export type BaseConverter = ((value: number, fromCurrency: string) => Promise<number>) & {
+  conversions(): BaseConversion[];
+};
+
+interface UsdRate {
+  rate: number;
+  asOf: number | null;
+}
+
+export function createBaseConverter(
+  dataProvider: Pick<DataProvider, "getExchangeRate" | "getCachedQuery" | "revalidatesInBackground">,
+  baseCurrency: string,
+): BaseConverter {
+  const rateCache = new Map<string, Promise<UsdRate>>();
+  const used = new Map<string, BaseConversion>();
+
+  /** USD per unit, dated when the cached query says when it was observed (as `fx` dates it). */
+  const loadRate = async (currency: string): Promise<UsdRate> => {
+    const fixed = fixedUsdRate(currency);
+    if (fixed != null) return { rate: fixed, asOf: null };
     try {
-      const rate = await dataProvider.getExchangeRate(normalizedCurrency);
-      const validRate = Number.isFinite(rate) && rate > 0 ? rate : Number.NaN;
-      rateCache.set(normalizedCurrency, validRate);
-      return validRate;
+      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 };
+      }
+      const rate = await dataProvider.getExchangeRate(currency);
+      return { rate: Number.isFinite(rate) && rate > 0 ? rate : Number.NaN, asOf: null };
     } catch (error) {
       logFailure("cli-base-converter", "Could not load base conversion exchange rate")(error);
-      return Number.NaN;
+      return { rate: Number.NaN, asOf: null };
     }
   };
 
-  return async (value: number, fromCurrency: string): Promise<number> => {
+  const getRate = (currency: string): Promise<UsdRate> => {
+    const normalizedCurrency = currency.toUpperCase();
+    let pending = rateCache.get(normalizedCurrency);
+    if (!pending) {
+      pending = loadRate(normalizedCurrency);
+      rateCache.set(normalizedCurrency, pending);
+    }
+    return pending;
+  };
+
+  const convert = async (value: number, fromCurrency: string): Promise<number> => {
     const normalizedFrom = fromCurrency.toUpperCase();
     const normalizedBase = baseCurrency.toUpperCase();
     if (normalizedFrom === normalizedBase) return value;
 
-    const [fromRate, baseRate] = await Promise.all([
-      getRate(normalizedFrom),
-      getRate(normalizedBase),
-    ]);
-    if (!Number.isFinite(fromRate) || !Number.isFinite(baseRate) || baseRate <= 0) return Number.NaN;
-    return (value * fromRate) / baseRate;
+    const [from, base] = await Promise.all([getRate(normalizedFrom), getRate(normalizedBase)]);
+    if (!Number.isFinite(from.rate) || !Number.isFinite(base.rate) || base.rate <= 0) return Number.NaN;
+    const dates = [from.asOf, base.asOf].filter((time): time is number => time != null);
+    used.set(normalizedFrom, {
+      currency: normalizedFrom,
+      baseCurrency: normalizedBase,
+      rate: from.rate / base.rate,
+      asOf: dates.length > 0 ? Math.min(...dates) : null,
+    });
+    return (value * from.rate) / base.rate;
   };
+
+  return Object.assign(convert, { conversions: () => [...used.values()] });
 }