gloomberb 0.9.9 → 0.10.0

package/src/plugins/builtin/news/wire/index.tsx

@@ -1,8 +1,6 @@
-import type { PaneProps } from "../../../../types/plugin";
-import type { GloomPluginContext } from "../../../../types/plugin";
 import type { NewsQuery } from "../../../../news/types";
-import { createRssNewsCapability } from "./rss/source";
-import { IndustryPane } from "./industry-pane";
+import type { PaneProps } from "../../../../types/plugin";
+import type { PluginModule } from "../../plugin-module";
 import { BreakingPane } from "./breaking/pane";
 import {
   BREAKING_NEWS_NOTIFICATIONS_ENABLED_KEY,
@@ -14,9 +12,11 @@ import {
   loadNewsFeedSettings,
   saveNewsFeedSettings,
 } from "./feed-config";
-import { NEWS_QUERY_PRESETS } from "./news/query-presets";
+import { IndustryPane } from "./industry-pane";
 import { NewsPresetPane } from "./news/preset-pane";
+import { NEWS_QUERY_PRESETS } from "./news/query-presets";
 import type { NewsColumnId, NewsSortPreference } from "./news/table";
+import { createRssNewsCapability } from "./rss/source";
 
 interface NewsPresetPaneConfig {
   paneKey: string;
@@ -54,76 +54,86 @@ const FeedPane = createNewsPresetPane({
   emptyStateHint: "Try refreshing later as wire stories arrive.",
 });
 
-export function registerNewsWireFeatures(ctx: GloomPluginContext): () => void {
-  ctx.registerPane({ id: "news-top", name: "Top News", icon: "T", component: TopPane, defaultPosition: "right", defaultMode: "floating", defaultFloatingSize: { width: 90, height: 30 } });
-  ctx.registerPane({ id: "news-feed", name: "News Feed", icon: "N", component: FeedPane, defaultPosition: "right", defaultMode: "floating", defaultFloatingSize: { width: 100, height: 35 } });
-  ctx.registerPane({ id: "news-industry", name: "Sector News", icon: "S", component: IndustryPane, defaultPosition: "right", defaultMode: "floating", defaultFloatingSize: { width: 100, height: 35 } });
-  ctx.registerPane({
-    id: "news-breaking",
-    name: "Breaking News",
-    icon: "!",
-    component: BreakingPane,
-    defaultPosition: "right",
-    defaultMode: "floating",
-    defaultFloatingSize: { width: 85, height: 20 },
-    settings: {
-      title: "Breaking News Settings",
-      fields: [{
-        key: BREAKING_NEWS_NOTIFICATIONS_ENABLED_KEY,
-        label: "Notifications",
-        description: "Notify when new breaking stories arrive, even while this pane is closed.",
-        type: "toggle",
-        storage: "plugin",
-      }],
-    },
-  });
-
-  ctx.registerPaneTemplate({ id: "news-top-pane", paneId: "news-top", label: "Top News", description: "Curated top market stories ranked by importance", keywords: ["top", "news", "headlines", "stories"], shortcut: { prefix: "TOP" } });
-  ctx.registerPaneTemplate({ id: "news-feed-pane", paneId: "news-feed", label: "News Feed", description: "Chronological market news firehose", keywords: ["news", "feed", "firehose", "wire", "stream"], shortcut: { prefix: "N" } });
-  ctx.registerPaneTemplate({ id: "news-industry-pane", paneId: "news-industry", label: "Sector News", description: "Market news filtered by sector", keywords: ["news", "industry", "sector", "ni", "filter"], shortcut: { prefix: "NI" } });
-  ctx.registerPaneTemplate({ id: "news-breaking-pane", paneId: "news-breaking", label: "Breaking News", description: "Breaking and urgent market news", keywords: ["first", "breaking", "urgent", "alert", "flash"], shortcut: { prefix: "FIRST" } });
+let disposeBreakingNewsNotifications: (() => void) | null = null;
 
-  const initialSettings = loadNewsFeedSettings(ctx.configState);
-  if (initialSettings.migrated) {
-    void saveNewsFeedSettings(ctx.configState, initialSettings);
-  }
+export const newsWireModule: PluginModule = {
+  panes: [
+    { id: "news-top", name: "Top News", icon: "T", component: TopPane, defaultPosition: "right", defaultMode: "floating", defaultFloatingSize: { width: 90, height: 30 } },
+    { id: "news-feed", name: "News Feed", icon: "N", component: FeedPane, defaultPosition: "right", defaultMode: "floating", defaultFloatingSize: { width: 100, height: 35 } },
+    { id: "news-industry", name: "Sector News", icon: "S", component: IndustryPane, defaultPosition: "right", defaultMode: "floating", defaultFloatingSize: { width: 100, height: 35 } },
+    {
+      id: "news-breaking",
+      name: "Breaking News",
+      icon: "!",
+      component: BreakingPane,
+      defaultPosition: "right",
+      defaultMode: "floating",
+      defaultFloatingSize: { width: 85, height: 20 },
+      settings: {
+        title: "Breaking News Settings",
+        fields: [{
+          key: BREAKING_NEWS_NOTIFICATIONS_ENABLED_KEY,
+          label: "Notifications",
+          description: "Notify when new breaking stories arrive, even while this pane is closed.",
+          type: "toggle",
+          storage: "plugin",
+        }],
+      },
+    },
+  ],
+  paneTemplates: [
+    { id: "news-top-pane", paneId: "news-top", label: "Top News", description: "Curated top market stories ranked by importance", keywords: ["top", "news", "headlines", "stories"], shortcut: { prefix: "TOP" } },
+    { id: "news-feed-pane", paneId: "news-feed", label: "News Feed", description: "Chronological market news firehose", keywords: ["news", "feed", "firehose", "wire", "stream"], shortcut: { prefix: "N" } },
+    { id: "news-industry-pane", paneId: "news-industry", label: "Sector News", description: "Market news filtered by sector", keywords: ["news", "industry", "sector", "ni", "filter"], shortcut: { prefix: "NI" } },
+    { id: "news-breaking-pane", paneId: "news-breaking", label: "Breaking News", description: "Breaking and urgent market news", keywords: ["first", "breaking", "urgent", "alert", "flash"], shortcut: { prefix: "FIRST" } },
+  ],
+  setup(ctx) {
+    const initialSettings = loadNewsFeedSettings(ctx.configState);
+    if (initialSettings.migrated) {
+      void saveNewsFeedSettings(ctx.configState, initialSettings);
+    }
 
-  const source = createRssNewsCapability(
-    () => getEnabledNewsFeeds(loadNewsFeedSettings(ctx.configState)),
-    { persistence: ctx.persistence },
-  );
-  ctx.registerCapability(source);
+    const source = createRssNewsCapability(
+      () => getEnabledNewsFeeds(loadNewsFeedSettings(ctx.configState)),
+      { persistence: ctx.persistence },
+    );
+    ctx.registerCapability(source);
 
-  ctx.registerCommand({
-    id: "add-news-feed",
-    label: "Add News Feed",
-    keywords: ["news", "rss", "feed", "add", "source"],
-    category: "config",
-    description: "Add a custom RSS news feed",
-    wizardLayout: "form",
-    wizard: [
-      { key: "url", label: "Feed URL", type: "text", placeholder: "https://example.com/rss" },
-      { key: "name", label: "Feed Name", type: "text", placeholder: "My Feed" },
-      { key: "category", label: "Category", type: "select", options: [
-        { label: "General", value: "general" },
-        { label: "Tech", value: "tech" },
-        { label: "Energy", value: "energy" },
-        { label: "Finance", value: "finance" },
-        { label: "Healthcare", value: "healthcare" },
-        { label: "Macro", value: "macro" },
-        { label: "Crypto", value: "crypto" },
-      ]},
-    ],
-    async execute(values) {
-      const url = values?.url?.trim();
-      const name = values?.name?.trim();
-      const category = values?.category ?? "general";
-      if (!url || !name) return;
+    ctx.registerCommand({
+      id: "add-news-feed",
+      label: "Add News Feed",
+      keywords: ["news", "rss", "feed", "add", "source"],
+      category: "config",
+      description: "Add a custom RSS news feed",
+      wizardLayout: "form",
+      wizard: [
+        { key: "url", label: "Feed URL", type: "text", placeholder: "https://example.com/rss" },
+        { key: "name", label: "Feed Name", type: "text", placeholder: "My Feed" },
+        { key: "category", label: "Category", type: "select", options: [
+          { label: "General", value: "general" },
+          { label: "Tech", value: "tech" },
+          { label: "Energy", value: "energy" },
+          { label: "Finance", value: "finance" },
+          { label: "Healthcare", value: "healthcare" },
+          { label: "Macro", value: "macro" },
+          { label: "Crypto", value: "crypto" },
+        ]},
+      ],
+      async execute(values) {
+        const url = values?.url?.trim();
+        const name = values?.name?.trim();
+        const category = values?.category ?? "general";
+        if (!url || !name) return;
 
-      const feed = await addUserNewsFeed(ctx.configState, { url, name, category });
-      ctx.notify({ body: `Added news feed: ${feed.name}`, type: "success" });
-    },
-  });
+        const feed = await addUserNewsFeed(ctx.configState, { url, name, category });
+        ctx.notify({ body: `Added news feed: ${feed.name}`, type: "success" });
+      },
+    });
 
-  return setupBreakingNewsNotifications(ctx);
-}
+    disposeBreakingNewsNotifications = setupBreakingNewsNotifications(ctx);
+  },
+  dispose() {
+    disposeBreakingNewsNotifications?.();
+    disposeBreakingNewsNotifications = null;
+  },
+};

package/src/plugins/builtin/options/index.tsx

@@ -1,14 +1,8 @@
-import type { GloomPlugin } from "../../../types/plugin";
+import type { PluginModule } from "../plugin-module";
 import { createTickerSurfacePaneTemplate } from "../shared/ticker-surface";
 import { OptionsView } from "./view";
 
-export const optionsPlugin: GloomPlugin = {
-  id: "options",
-  name: "Options",
-  version: "1.0.0",
-  description: "View options chain for tickers",
-  toggleable: true,
-
+export const optionsModule: PluginModule = {
   panes: [
     {
       id: "options",

package/src/plugins/builtin/plugin-module.test.ts

@@ -0,0 +1,89 @@
+import { Children, isValidElement, type ReactElement } from "react";
+import { describe, expect, test } from "bun:test";
+import type { BrokerAdapter } from "../../types/broker";
+import type { GloomPluginContext } from "../../types/plugin";
+import {
+  composeBuiltinPlugin,
+  type PluginModule,
+} from "./plugin-module";
+
+function broker(id: string): BrokerAdapter {
+  return { id } as BrokerAdapter;
+}
+
+function context(registerBroker: (value: BrokerAdapter) => void = () => {}): GloomPluginContext {
+  return { registerBroker } as GloomPluginContext;
+}
+
+describe("composeBuiltinPlugin", () => {
+  test("combines every declarative contribution under the parent plugin", async () => {
+    const registeredBrokers: string[] = [];
+    const first: PluginModule = {
+      cliCommands: [{ name: "legacy", description: "Legacy", execute: () => {} }],
+      cli: { commands: [{ name: "typed", summary: "Typed" }] },
+      panes: [{ id: "one", name: "One", component: () => null, defaultPosition: "right" }],
+      paneTemplates: [{ id: "one-pane", paneId: "one", label: "One", description: "One" }],
+      capabilities: [{ id: "capability-one" } as never],
+      broker: broker("broker-one"),
+      slots: { "status:widget": () => "one" },
+    };
+    const second: PluginModule = {
+      panes: [{ id: "two", name: "Two", component: () => null, defaultPosition: "left" }],
+      broker: broker("broker-two"),
+      slots: { "status:widget": () => "two" },
+    };
+
+    const plugin = composeBuiltinPlugin({
+      id: "parent",
+      name: "Parent",
+      version: "1.0.0",
+      modules: [first, second],
+    });
+
+    expect(plugin.cliCommands?.map((command) => command.name)).toEqual(["legacy"]);
+    expect(plugin.cli?.commands?.map((command) => command.name)).toEqual(["typed"]);
+    expect(plugin.panes?.map((pane) => pane.id)).toEqual(["one", "two"]);
+    expect(plugin.paneTemplates?.map((template) => template.id)).toEqual(["one-pane"]);
+    expect(plugin.capabilities?.map((capability) => capability.id)).toEqual(["capability-one"]);
+
+    const slotOutput = plugin.slots?.["status:widget"]?.({});
+    expect(isValidElement(slotOutput)).toBe(true);
+    expect(Children.count((slotOutput as ReactElement<{ children: unknown }>).props.children)).toBe(2);
+
+    await plugin.setup?.(context((value) => registeredBrokers.push(value.id)));
+    expect(registeredBrokers).toEqual(["broker-one", "broker-two"]);
+    plugin.dispose?.();
+  });
+
+  test("disposes initialized and partially initialized modules in reverse order", async () => {
+    const lifecycle: string[] = [];
+    const plugin = composeBuiltinPlugin({
+      id: "parent",
+      name: "Parent",
+      version: "1.0.0",
+      modules: [
+        {
+          setup: () => { lifecycle.push("setup:first"); },
+          dispose: () => { lifecycle.push("dispose:first"); },
+        },
+        {
+          setup: () => {
+            lifecycle.push("setup:second");
+            throw new Error("setup failed");
+          },
+          dispose: () => { lifecycle.push("dispose:second"); },
+        },
+      ],
+    });
+
+    await expect(plugin.setup?.(context())).rejects.toThrow("setup failed");
+    plugin.dispose?.();
+
+    expect(lifecycle).toEqual([
+      "setup:first",
+      "setup:second",
+      "dispose:second",
+      "dispose:first",
+    ]);
+  });
+});

package/src/plugins/builtin/plugin-module.ts

@@ -0,0 +1,116 @@
+import { Fragment, createElement, type ReactNode } from "react";
+import type {
+  GloomPlugin,
+  GloomPluginContext,
+  PluginCliDescriptor,
+} from "../../types/plugin";
+
+type PluginMetadataKey = "id" | "name" | "version" | "description" | "toggleable" | "order";
+type PluginMetadata = Pick<GloomPlugin, PluginMetadataKey>;
+
+export type PluginModule = Omit<GloomPlugin, PluginMetadataKey>;
+
+const HANDLED_MODULE_KEYS = [
+  "cliCommands",
+  "cli",
+  "setup",
+  "dispose",
+  "panes",
+  "paneTemplates",
+  "broker",
+  "capabilities",
+  "slots",
+] as const satisfies readonly (keyof PluginModule)[];
+
+type MissingModuleKey = Exclude<keyof PluginModule, typeof HANDLED_MODULE_KEYS[number]>;
+type MissingCliDescriptorKey = Exclude<keyof PluginCliDescriptor, "commands">;
+const ALL_MODULE_KEYS_HANDLED: MissingModuleKey extends never ? true : never = true;
+const ALL_CLI_DESCRIPTOR_KEYS_HANDLED: MissingCliDescriptorKey extends never ? true : never = true;
+void ALL_MODULE_KEYS_HANDLED;
+void ALL_CLI_DESCRIPTOR_KEYS_HANDLED;
+
+interface CompositePluginOptions extends PluginMetadata {
+  modules: readonly PluginModule[];
+}
+
+function composeSlots(modules: readonly PluginModule[]): GloomPlugin["slots"] {
+  const renderersBySlot = new Map<string, Array<(props: unknown) => ReactNode>>();
+
+  for (const module of modules) {
+    for (const [slotName, renderer] of Object.entries(module.slots ?? {})) {
+      if (!renderer) continue;
+      const renderers = renderersBySlot.get(slotName) ?? [];
+      renderers.push(renderer as (props: unknown) => ReactNode);
+      renderersBySlot.set(slotName, renderers);
+    }
+  }
+
+  if (renderersBySlot.size === 0) return undefined;
+
+  const slots: Record<string, (props: unknown) => ReactNode> = {};
+  for (const [slotName, renderers] of renderersBySlot) {
+    slots[slotName] = (props) => createElement(
+      Fragment,
+      null,
+      ...renderers.map((render, index) => createElement(
+        Fragment,
+        { key: index },
+        render(props),
+      )),
+    );
+  }
+
+  return slots as GloomPlugin["slots"];
+}
+
+/**
+ * Combines implementation modules under one real plugin identity.
+ *
+ * Modules deliberately have no identity or toggle metadata. Every contribution
+ * is owned, persisted, enabled, and disposed through the returned parent plugin.
+ */
+export function composeBuiltinPlugin(options: CompositePluginOptions): GloomPlugin {
+  const { modules, ...metadata } = options;
+  const cliCommands = modules.flatMap((module) => module.cliCommands ?? []);
+  const cliDescriptors = modules.flatMap((module) => module.cli?.commands ?? []);
+  const panes = modules.flatMap((module) => module.panes ?? []);
+  const paneTemplates = modules.flatMap((module) => module.paneTemplates ?? []);
+  const capabilities = modules.flatMap((module) => module.capabilities ?? []);
+  const brokers = modules.flatMap((module) => module.broker ? [module.broker] : []);
+  const slots = composeSlots(modules);
+  let startedModules: PluginModule[] = [];
+
+  return {
+    ...metadata,
+    ...(cliCommands.length > 0 ? { cliCommands } : {}),
+    ...(cliDescriptors.length > 0 ? { cli: { commands: cliDescriptors } } : {}),
+    ...(panes.length > 0 ? { panes } : {}),
+    ...(paneTemplates.length > 0 ? { paneTemplates } : {}),
+    ...(capabilities.length > 0 ? { capabilities } : {}),
+    ...(slots ? { slots } : {}),
+
+    async setup(ctx: GloomPluginContext) {
+      startedModules = [];
+      for (const broker of brokers) {
+        ctx.registerBroker(broker);
+      }
+      for (const module of modules) {
+        startedModules.push(module);
+        await module.setup?.(ctx);
+      }
+    },
+
+    dispose() {
+      let firstError: unknown;
+      for (const module of startedModules.reverse()) {
+        try {
+          module.dispose?.();
+        } catch (error) {
+          firstError ??= error;
+        }
+      }
+      startedModules = [];
+      if (firstError) throw firstError;
+    },
+  };
+}

package/src/plugins/builtin/portfolio-list/header.tsx

@@ -1,5 +1,6 @@
 import { Box, ScrollBox, Text } from "../../../ui";
 import { useEffect, useMemo, useState } from "react";
+import { t } from "../../../i18n";
 import { TextAttributes } from "../../../ui";
 import type { AppState } from "../../../state/app/context";
 import { colors } from "../../../theme/colors";
@@ -100,7 +101,7 @@ export function PortfolioCashMarginDrawer({
           event.stopPropagation();
         }}
       >
-        <Text fg={colors.textBright} attributes={TextAttributes.BOLD}>{"▸ Cash & Margin"}</Text>
+        <Text fg={colors.textBright} attributes={TextAttributes.BOLD}>{`▸ ${t("Cash & Margin")}`}</Text>
         <Box flexGrow={1} />
         <Text fg={colors.textDim}>{padTo(previewText, Math.max(0, width - 17), "right")}</Text>
       </Box>
@@ -127,7 +128,7 @@ export function PortfolioCashMarginDrawer({
           event.stopPropagation();
         }}
       >
-        <Text fg={colors.textBright} attributes={TextAttributes.BOLD}>{"▾ Cash & Margin"}</Text>
+        <Text fg={colors.textBright} attributes={TextAttributes.BOLD}>{`▾ ${t("Cash & Margin")}`}</Text>
         <Box flexGrow={1} />
         <Text fg={colors.textDim}>{accountState.sourceLabel}</Text>
       </Box>
@@ -136,7 +137,7 @@ export function PortfolioCashMarginDrawer({
       </Box>
       <ScrollBox height={currencyRowsHeight} scrollY focusable={false}>
         {accountState.visibleCashBalances.length === 0 ? (
-          <Text fg={colors.textDim}>No non-zero cash balances.</Text>
+          <Text fg={colors.textDim}>{t("No non-zero cash balances.")}</Text>
         ) : (
           accountState.visibleCashBalances.map((balance) => (
             <Box key={balance.currency} height={1} flexDirection="row">

package/src/plugins/builtin/portfolio-list/index.test.ts

@@ -8,6 +8,7 @@ import { buildPortfolioSummarySegments } from "./summary";
 import { shouldToggleCashMarginDrawer } from ".";
 import { needsVisibleQuoteWatchdogRefresh, selectQuoteWarmupTickers, selectStreamTickers } from "./pane/data";
 import { buildPortfolioPaneSettingsDef, getPortfolioPaneSettings } from "./settings";
+import { getLanguage, setLanguage } from "../../../i18n";
 
 function ticker(symbol: string): TickerRecord {
   return {
@@ -60,6 +61,22 @@ describe("buildPortfolioSummarySegments", () => {
     expect(segments.map((segment) => segment.id)).toEqual(["netliq", "val"]);
   });
 
+  test("fits segments using translated terminal display widths", () => {
+    const previousLanguage = getLanguage();
+    try {
+      setLanguage("zh-CN");
+      const segments = buildPortfolioSummarySegments({
+        totals,
+        accountState: { account, sourceLabel: "Live" },
+        widthBudget: 22,
+      });
+
+      expect(segments.map((segment) => segment.id)).toEqual(["netliq"]);
+    } finally {
+      setLanguage(previousLanguage);
+    }
+  });
+
   test("uses broker gross position value for broker portfolio value", () => {
     const segments = buildPortfolioSummarySegments({
       totals,

package/src/plugins/builtin/portfolio-list/index.tsx

@@ -1,4 +1,5 @@
-import type { GloomPlugin, PaneTemplateContext, PaneTemplateInstanceConfig } from "../../../types/plugin";
+import type { PaneTemplateContext, PaneTemplateInstanceConfig } from "../../../types/plugin";
+import type { PluginModule } from "../plugin-module";
 import { PortfolioListPane } from "./pane";
 import { shouldToggleCashMarginDrawer } from "./header";
 import {
@@ -32,10 +33,7 @@ function createCollectionPaneInstance(
   return collectionId ? { params: { collectionId } } : null;
 }
 
-export const portfolioListPlugin: GloomPlugin = {
-  id: "portfolio-list",
-  name: "Portfolio List",
-  version: "1.0.0",
+export const portfolioListModule: PluginModule = {
   panes: [
     {
       id: "portfolio-list",

package/src/plugins/builtin/portfolio-list/pane/index.test.tsx

@@ -27,7 +27,7 @@ import { PluginRenderProvider, type PluginRuntimeAccess } from "../../../runtime
 import { PluginRegistry, setSharedMarketDataForTests, setSharedRegistryForTests } from "../../../registry";
 import type { BrokerAdapter } from "../../../../types/broker";
 import { colors } from "../../../../theme/colors";
-import { portfolioListPlugin } from "..";
+import { portfolioListModule } from "..";
 
 const TEST_PANE_ID = "portfolio-list:test";
 
@@ -38,7 +38,7 @@ let harnessState: ReturnType<typeof createInitialState> | null = null;
 const tempPaths: string[] = [];
 const tempPersistences: AppPersistence[] = [];
 
-const PortfolioPane = portfolioListPlugin.panes![0]!.component as (props: {
+const PortfolioPane = portfolioListModule.panes![0]!.component as (props: {
   paneId: string;
   paneType: string;
   focused: boolean;
@@ -307,7 +307,7 @@ function PortfolioHarness({
   return (
     <AppContext value={{ state, dispatch }}>
       <PaneInstanceProvider paneId={TEST_PANE_ID}>
-        <PluginRenderProvider pluginId="portfolio-list" runtime={runtime}>
+        <PluginRenderProvider pluginId="portfolio" runtime={runtime}>
           <PortfolioPane
             paneId={TEST_PANE_ID}
             paneType="portfolio-list"