gloomberb 0.13.1 → 0.13.2

package/src/plugins/builtin/sec/headless.test.ts

@@ -0,0 +1,72 @@
+import { describe, expect, test } from "bun:test";
+import { createTestDataProvider } from "../../../test-support/data-provider";
+import { createDefaultConfig } from "../../../types/config";
+import type { SecFilingItem } from "../../../types/data-provider";
+import type { HeadlessPaneContext, HeadlessPaneLoadArgs } from "../../../types/plugin";
+import { createSecHeadless } from "./headless";
+
+const filings: SecFilingItem[] = [
+  {
+    accessionNumber: "0000320193-26-000100",
+    form: "8-K",
+    filingDate: new Date("2026-08-25T00:00:00.000Z"),
+    primaryDocDescription: "8-K Results of Operations",
+    items: "2.02,9.01",
+    cik: "0000320193",
+    filingUrl: "https://www.sec.gov/filing/one",
+  },
+  {
+    accessionNumber: "0000320193-26-000099",
+    form: "10-Q",
+    filingDate: new Date("2026-08-20T00:00:00.000Z"),
+    cik: "0000320193",
+    filingUrl: "https://www.sec.gov/filing/two",
+  },
+];
+
+function context(): HeadlessPaneContext {
+  return {
+    marketData: createTestDataProvider(),
+    apiClient: {} as HeadlessPaneContext["apiClient"],
+    config: createDefaultConfig("/tmp/gloomberb-headless-sec"),
+    signal: new AbortController().signal,
+  };
+}
+
+function args(limit: number): HeadlessPaneLoadArgs {
+  return {
+    rawArgument: "AAPL",
+    argument: "AAPL",
+    symbols: ["AAPL"],
+    options: { limit },
+  };
+}
+
+describe("SEC headless model", () => {
+  test("projects filing rows and honors the page limit", async () => {
+    const requestedLimits: number[] = [];
+    const headless = createSecHeadless({
+      loadFilings: async (_symbol, limit) => {
+        requestedLimits.push(limit);
+        return filings;
+      },
+    });
+
+    const first = await headless.load(args(1), context());
+    expect(first.rows).toEqual([{
+      filedAt: "2026-08-25T00:00:00.000Z",
+      acceptedAt: null,
+      form: "8-K",
+      filing: "8-K | Results of Operations | Current Report",
+      items: "2.02,9.01",
+      accessionNumber: "0000320193-26-000100",
+      primaryDocument: null,
+      cik: "0000320193",
+      url: "https://www.sec.gov/filing/one",
+    }]);
+
+    const both = await headless.load(args(2), context());
+    expect(both.rows).toHaveLength(2);
+    expect(requestedLimits).toEqual([1, 2]);
+  });
+});

package/src/plugins/builtin/sec/headless.ts

@@ -0,0 +1,69 @@
+import type {
+  HeadlessPaneColumn,
+  HeadlessPaneContext,
+  HeadlessPaneDefinition,
+  HeadlessPaneLoadArgs,
+} from "../../../types/plugin";
+import type { SecFilingItem } from "../../../types/data-provider";
+import { loadSecFilings } from "./client";
+import { buildSecFilingRows } from "./model";
+
+const SEC_COLUMNS: HeadlessPaneColumn[] = [
+  {
+    key: "filedAt",
+    header: "Filed",
+    format: (value) => typeof value === "string" ? value.slice(0, 10) : "-",
+  },
+  { key: "form", header: "Form" },
+  { key: "filing", header: "Filing" },
+  { key: "items", header: "Items" },
+  { key: "accessionNumber", header: "Accession" },
+];
+
+export interface SecHeadlessDependencies {
+  loadFilings(
+    symbol: string,
+    limit: number,
+    args: HeadlessPaneLoadArgs,
+    ctx: HeadlessPaneContext,
+  ): Promise<SecFilingItem[]>;
+}
+
+const defaultDependencies: SecHeadlessDependencies = {
+  loadFilings: (symbol, limit, _args, ctx) => loadSecFilings(ctx.marketData, symbol, limit),
+};
+
+export function createSecHeadless(
+  dependencies: SecHeadlessDependencies = defaultDependencies,
+): HeadlessPaneDefinition<"rows"> {
+  return {
+    shape: "rows",
+    argument: {
+      kind: "ticker",
+      placeholder: "ticker",
+      description: "US equity ticker.",
+    },
+    options: [{
+      key: "limit",
+      aliases: ["count", "rows"],
+      description: "Maximum recent filings.",
+      type: "integer",
+      defaultValue: 50,
+      minimum: 1,
+      maximum: 200,
+    }],
+    columns: SEC_COLUMNS,
+    describe: (args) => `SEC Filings | ${args.symbols[0]}`,
+    async load(args, ctx) {
+      const symbol = args.symbols[0]!;
+      const limit = Number(args.options.limit);
+      const filings = await dependencies.loadFilings(symbol, limit, args, ctx);
+      return {
+        rows: buildSecFilingRows(filings).slice(0, limit),
+        metadata: { symbol, returned: Math.min(filings.length, limit) },
+      };
+    },
+  };
+}
+
+export const secHeadless = createSecHeadless();

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

@@ -27,54 +27,19 @@ import {
   useSecFilingContentCache,
 } from "./filing-content";
 import { usePaneStatusLinkFooter } from "../shared/pane-footer";
+import { secHeadless } from "./headless";
+import {
+  getFilingDisplayTitle,
+  getFormDescription,
+  getMeaningfulPrimaryDescription,
+} from "./model";
+
+export { secHeadless } from "./headless";
 
 const SEC_FILING_FETCH_LIMIT = 20_000;
 const SEC_FILING_PAGE_SIZE = 50;
 const OWNERSHIP_FORMS = new Set(["3", "4", "5"]);
 
-function getDisplayFormLabel(form: string): string {
-  const trimmed = form.trim();
-  return /^\d+(?:\/[A-Z])?$/i.test(trimmed)
-    ? `FORM ${trimmed}`
-    : trimmed;
-}
-
-function normalizeComparableText(value: string): string {
-  return value
-    .toUpperCase()
-    .replace(/\bFORM\b/g, "")
-    .replace(/[^A-Z0-9]+/g, "");
-}
-
-function escapeRegExp(value: string): string {
-  return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-}
-
-function stripRedundantFormPrefix(form: string, description: string): string {
-  const pattern = escapeRegExp(form.trim()).replace(/\s+/g, "\\s+");
-  return description
-    .trim()
-    .replace(new RegExp(`^(?:FORM\\s+)?${pattern}(?:\\s*[:|-]\\s*|\\s+)`, "i"), "")
-    .trim();
-}
-
-function getMeaningfulPrimaryDescription(filing: SecFilingItem): string | undefined {
-  const description = filing.primaryDocDescription?.trim();
-  if (!description) return undefined;
-  if (normalizeComparableText(description) === normalizeComparableText(filing.form)) return undefined;
-
-  const stripped = stripRedundantFormPrefix(filing.form, description);
-  if (!stripped) return undefined;
-  if (normalizeComparableText(stripped) === normalizeComparableText(filing.form)) return undefined;
-  return stripped;
-}
-
-function getFilingDisplayTitle(filing: SecFilingItem): string {
-  const description = getMeaningfulPrimaryDescription(filing);
-  const formLabel = getDisplayFormLabel(filing.form);
-  return description ? `${formLabel} | ${description}` : formLabel;
-}
-
 function formatFiledAt(filing: SecFilingItem): string {
   return formatFilingMetaDate(filing.filingDate);
 }
@@ -161,29 +126,6 @@ function buildForm4Detail(content: string | null, filing: SecFilingItem): string
   return lines.join("\n");
 }
 
-function getFormDescription(form: string): string {
-  const f = form.trim().toUpperCase();
-  switch (f) {
-    case "10-K": return "Annual Report";
-    case "10-K/A": return "Annual Report (Amended)";
-    case "10-Q": return "Quarterly Report";
-    case "10-Q/A": return "Quarterly Report (Amended)";
-    case "8-K": return "Current Report";
-    case "8-K/A": return "Current Report (Amended)";
-    case "4": return "Insider Transaction";
-    case "3": return "Initial Insider Ownership";
-    case "5": return "Annual Insider Ownership";
-    case "SC 13G": return "Beneficial Ownership (Passive)";
-    case "SC 13G/A": return "Beneficial Ownership (Amended)";
-    case "SC 13D": return "Beneficial Ownership (Active)";
-    case "SC 13D/A": return "Beneficial Ownership (Amended)";
-    case "DEF 14A": return "Proxy Statement";
-    case "S-1": return "Registration Statement";
-    case "20-F": return "Annual Report (Foreign)";
-    default: return "";
-  }
-}
-
 function toFeedItems(
   filings: SecFilingItem[],
   selectedAccessionNumber: string | undefined,
@@ -360,15 +302,18 @@ export const secModule: PluginModule = {
   ],
 
   paneTemplates: [
-    createTickerSurfacePaneTemplate({
-      id: "sec-pane",
-      paneId: "sec",
-      label: "SEC",
-      description: "Recent SEC filings for the selected ticker.",
-      keywords: ["sec", "filings", "10-k", "10-q", "8-k"],
-      shortcut: "SEC",
-      canCreate: (_context, options) => !options?.ticker || isUsEquityTicker(options.ticker),
-    }),
+    {
+      ...createTickerSurfacePaneTemplate({
+        id: "sec-pane",
+        paneId: "sec",
+        label: "SEC",
+        description: "Recent SEC filings for the selected ticker.",
+        keywords: ["sec", "filings", "10-k", "10-q", "8-k"],
+        shortcut: "SEC",
+        canCreate: (_context, options) => !options?.ticker || isUsEquityTicker(options.ticker),
+      }),
+      headless: secHeadless,
+    },
   ],
 
   setup(ctx) {

package/src/plugins/builtin/sec/model.ts

@@ -0,0 +1,89 @@
+import type { SecFilingItem } from "../../../types/data-provider";
+
+export function getDisplayFormLabel(form: string): string {
+  const trimmed = form.trim();
+  return /^\d+(?:\/[A-Z])?$/i.test(trimmed)
+    ? `FORM ${trimmed}`
+    : trimmed;
+}
+
+function normalizeComparableText(value: string): string {
+  return value
+    .toUpperCase()
+    .replace(/\bFORM\b/g, "")
+    .replace(/[^A-Z0-9]+/g, "");
+}
+
+function escapeRegExp(value: string): string {
+  return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+
+function stripRedundantFormPrefix(form: string, description: string): string {
+  const pattern = escapeRegExp(form.trim()).replace(/\s+/g, "\\s+");
+  return description
+    .trim()
+    .replace(new RegExp(`^(?:FORM\\s+)?${pattern}(?:\\s*[:|-]\\s*|\\s+)`, "i"), "")
+    .trim();
+}
+
+export function getMeaningfulPrimaryDescription(filing: SecFilingItem): string | undefined {
+  const description = filing.primaryDocDescription?.trim();
+  if (!description) return undefined;
+  if (normalizeComparableText(description) === normalizeComparableText(filing.form)) return undefined;
+
+  const stripped = stripRedundantFormPrefix(filing.form, description);
+  if (!stripped) return undefined;
+  if (normalizeComparableText(stripped) === normalizeComparableText(filing.form)) return undefined;
+  return stripped;
+}
+
+export function getFilingDisplayTitle(filing: SecFilingItem): string {
+  const description = getMeaningfulPrimaryDescription(filing);
+  const formLabel = getDisplayFormLabel(filing.form);
+  return description ? `${formLabel} | ${description}` : formLabel;
+}
+
+export function getFormDescription(form: string): string {
+  const normalized = form.trim().toUpperCase();
+  switch (normalized) {
+    case "10-K": return "Annual Report";
+    case "10-K/A": return "Annual Report (Amended)";
+    case "10-Q": return "Quarterly Report";
+    case "10-Q/A": return "Quarterly Report (Amended)";
+    case "8-K": return "Current Report";
+    case "8-K/A": return "Current Report (Amended)";
+    case "4": return "Insider Transaction";
+    case "3": return "Initial Insider Ownership";
+    case "5": return "Annual Insider Ownership";
+    case "SC 13G": return "Beneficial Ownership (Passive)";
+    case "SC 13G/A": return "Beneficial Ownership (Amended)";
+    case "SC 13D": return "Beneficial Ownership (Active)";
+    case "SC 13D/A": return "Beneficial Ownership (Amended)";
+    case "DEF 14A": return "Proxy Statement";
+    case "S-1": return "Registration Statement";
+    case "20-F": return "Annual Report (Foreign)";
+    default: return "";
+  }
+}
+
+export function buildSecFilingRows(filings: readonly SecFilingItem[]) {
+  return filings.map((filing) => {
+    const displayTitle = getFilingDisplayTitle(filing);
+    const formDescription = getFormDescription(filing.form);
+    return {
+      filedAt: filing.filingDate instanceof Date
+        ? filing.filingDate.toISOString()
+        : String(filing.filingDate),
+      acceptedAt: filing.acceptedAt instanceof Date
+        ? filing.acceptedAt.toISOString()
+        : filing.acceptedAt ? String(filing.acceptedAt) : null,
+      form: filing.form,
+      filing: formDescription ? `${displayTitle} | ${formDescription}` : displayTitle,
+      items: filing.items ?? null,
+      accessionNumber: filing.accessionNumber,
+      primaryDocument: filing.primaryDocument ?? null,
+      cik: filing.cik,
+      url: filing.filingUrl,
+    };
+  });
+}

package/src/plugins/builtin/short-interest/client.ts

@@ -110,9 +110,12 @@ function normalizeCloudRecords(payload: CloudShortInterestPayload): ShortInteres
  * Yahoo carries the current and prior settlement plus percent of float, so it
  * stays as the fallback when the cloud route is unavailable.
  */
-export async function fetchShortInterest(symbol: string): Promise<ShortInterestRecord[]> {
+export async function fetchShortInterest(
+  symbol: string,
+  cloudClient: Pick<typeof apiClient, "getCloudShortInterest"> = apiClient,
+): Promise<ShortInterestRecord[]> {
   try {
-    const response = await apiClient.getCloudShortInterest(symbol);
+    const response = await cloudClient.getCloudShortInterest(symbol);
     const records = response.status === "success" && response.data
       ? normalizeCloudRecords(response.data)
       : [];

package/src/plugins/builtin/short-interest/headless.test.ts

@@ -0,0 +1,96 @@
+import { describe, expect, test } from "bun:test";
+import { CloudDataApi } from "../../../api-client/data";
+import type { CloudMarketResponse, CloudShortInterestPayload } from "../../../api-client/types";
+import { createTestDataProvider } from "../../../test-support/data-provider";
+import { createDefaultConfig } from "../../../types/config";
+import type { HeadlessPaneContext, HeadlessPaneLoadArgs } from "../../../types/plugin";
+import { fetchShortInterest } from "./client";
+import { createShortInterestHeadless } from "./headless";
+
+const records = [
+  {
+    settlementDate: new Date("2026-08-15T00:00:00.000Z"),
+    sharesShort: 12_000_000,
+    shortRatio: 2.5,
+    averageDailyVolume: 4_800_000,
+    shortPercentFloat: 3.2,
+  },
+  {
+    settlementDate: new Date("2026-08-31T00:00:00.000Z"),
+    sharesShort: 15_000_000,
+    shortRatio: 3,
+    averageDailyVolume: 5_000_000,
+    shortPercentFloat: 4.1,
+  },
+];
+
+function context(): HeadlessPaneContext {
+  return {
+    marketData: createTestDataProvider(),
+    apiClient: {} as HeadlessPaneContext["apiClient"],
+    config: createDefaultConfig("/tmp/gloomberb-headless-short-interest"),
+    signal: new AbortController().signal,
+  };
+}
+
+function args(overrides: Partial<HeadlessPaneLoadArgs["options"]> = {}): HeadlessPaneLoadArgs {
+  return {
+    rawArgument: "AMD",
+    argument: "AMD",
+    symbols: ["AMD"],
+    options: { order: "newest", limit: 24, ...overrides },
+  };
+}
+
+describe("short interest client", () => {
+  test("uses the served market route for FINRA history", async () => {
+    const paths: string[] = [];
+    const dataApi = new CloudDataApi(async <T>(path: string): Promise<T> => {
+      paths.push(path);
+      return {
+        status: "success",
+        data: {
+          symbol: "AAPL",
+          issueName: "Apple Inc.",
+          points: [{
+            settlementDate: "2026-08-31",
+            sharesShort: 15_000_000,
+            previousSharesShort: 12_000_000,
+            averageDailyVolume: 5_000_000,
+            daysToCover: 3,
+            changePercent: 25,
+            revised: false,
+          }],
+        },
+      } as CloudMarketResponse<CloudShortInterestPayload> as T;
+    });
+
+    const result = await fetchShortInterest("aapl", dataApi);
+
+    expect(paths).toEqual(["/market/short-interest?symbol=AAPL"]);
+    expect(result[0]).toMatchObject({ sharesShort: 15_000_000, shortRatio: 3 });
+  });
+});
+
+describe("short interest headless model", () => {
+  test("projects raw settlement values and applies order and limit", async () => {
+    const headless = createShortInterestHeadless({
+      loadRecords: async () => records,
+    });
+
+    const newest = await headless.load(args({ limit: 1 }), context());
+    expect(newest.rows).toEqual([{
+      settlementDate: "2026-08-31",
+      sharesShort: 15_000_000,
+      daysToCover: 3,
+      averageDailyVolume: 5_000_000,
+      shortPercentFloat: 4.1,
+    }]);
+
+    const oldest = await headless.load(args({ order: "oldest", limit: 1 }), context());
+    expect(oldest.rows[0]).toMatchObject({
+      settlementDate: "2026-08-15",
+      sharesShort: 12_000_000,
+    });
+  });
+});

package/src/plugins/builtin/short-interest/headless.ts

@@ -0,0 +1,111 @@
+import type {
+  HeadlessPaneColumn,
+  HeadlessPaneContext,
+  HeadlessPaneDefinition,
+  HeadlessPaneLoadArgs,
+} from "../../../types/plugin";
+import { formatCompact, formatNumber } from "../../../utils/format";
+import { fetchShortInterest } from "./client";
+import {
+  buildRows,
+  sortRows,
+  type SortPreference,
+} from "./model";
+import type { ShortInterestRecord } from "./types";
+
+const SHORT_INTEREST_COLUMNS: HeadlessPaneColumn[] = [
+  { key: "settlementDate", header: "Date" },
+  {
+    key: "sharesShort",
+    header: "Shares Short",
+    align: "right",
+    format: (value) => formatCompact(Number(value)),
+  },
+  {
+    key: "daysToCover",
+    header: "Days to Cover",
+    align: "right",
+    format: (value) => value == null ? "-" : formatNumber(Number(value), 2),
+  },
+  {
+    key: "averageDailyVolume",
+    header: "Avg Daily Vol",
+    align: "right",
+    format: (value) => value == null ? "-" : formatCompact(Number(value)),
+  },
+  {
+    key: "shortPercentFloat",
+    header: "% Float",
+    align: "right",
+    format: (value) => value == null ? "-" : `${formatNumber(Number(value), 2)}%`,
+  },
+];
+
+export interface ShortInterestHeadlessDependencies {
+  loadRecords(
+    symbol: string,
+    args: HeadlessPaneLoadArgs,
+    ctx: HeadlessPaneContext,
+  ): Promise<ShortInterestRecord[]>;
+}
+
+const defaultDependencies: ShortInterestHeadlessDependencies = {
+  loadRecords: (symbol, _args, ctx) => fetchShortInterest(symbol, ctx.apiClient),
+};
+
+export function createShortInterestHeadless(
+  dependencies: ShortInterestHeadlessDependencies = defaultDependencies,
+): HeadlessPaneDefinition<"rows"> {
+  return {
+    shape: "rows",
+    argument: {
+      kind: "ticker",
+      placeholder: "ticker",
+      description: "US equity ticker.",
+    },
+    options: [
+      {
+        key: "order",
+        description: "Settlement date order.",
+        type: "enum",
+        values: [{ value: "newest" }, { value: "oldest" }],
+        defaultValue: "newest",
+      },
+      {
+        key: "limit",
+        aliases: ["count", "rows"],
+        description: "Maximum settlement rows.",
+        type: "integer",
+        defaultValue: 24,
+        minimum: 1,
+        maximum: 100,
+      },
+    ],
+    columns: SHORT_INTEREST_COLUMNS,
+    describe: (args) => `Short Interest | ${args.symbols[0]}`,
+    async load(args, ctx) {
+      const symbol = args.symbols[0]!;
+      const records = await dependencies.loadRecords(symbol, args, ctx);
+      const preference: SortPreference = {
+        columnId: "settlementDate",
+        direction: args.options.order === "oldest" ? "asc" : "desc",
+      };
+      const limit = Number(args.options.limit);
+      const rows = sortRows(buildRows(records), preference)
+        .slice(0, limit)
+        .map((row) => ({
+          settlementDate: row.settlementDate,
+          sharesShort: row.record.sharesShort,
+          daysToCover: row.record.shortRatio,
+          averageDailyVolume: row.record.averageDailyVolume,
+          shortPercentFloat: row.record.shortPercentFloat,
+        }));
+      return {
+        rows,
+        metadata: { symbol, order: args.options.order },
+      };
+    },
+  };
+}
+
+export const shortInterestHeadless = createShortInterestHeadless();

package/src/plugins/builtin/short-interest/index.tsx

@@ -5,8 +5,11 @@ import {
   resetShortInterestHealth,
   YAHOO_SHORT_INTEREST_CONNECTION_ID,
 } from "./client";
+import { shortInterestHeadless } from "./headless";
 import { ShortInterestView } from "./pane";
 
+export { shortInterestHeadless } from "./headless";
+
 let disposeConnection: (() => void) | null = null;
 
 export const shortInterestModule: PluginModule = {
@@ -50,14 +53,17 @@ export const shortInterestModule: PluginModule = {
   ],
 
   paneTemplates: [
-    createTickerSurfacePaneTemplate({
-      id: "short-interest-pane",
-      paneId: "short-interest",
-      label: "Short Interest",
-      // Yahoo's key-statistics module only carries the current and prior settlement dates.
-      description: "Bi-monthly short interest settlements from FINRA with days to cover and average daily volume.",
-      keywords: ["short", "interest", "si", "shorts", "borrow", "days", "cover"],
-      shortcut: "SI",
-    }),
+    {
+      ...createTickerSurfacePaneTemplate({
+        id: "short-interest-pane",
+        paneId: "short-interest",
+        label: "Short Interest",
+        // Yahoo's key-statistics module only carries the current and prior settlement dates.
+        description: "Bi-monthly short interest settlements from FINRA with days to cover and average daily volume.",
+        keywords: ["short", "interest", "si", "shorts", "borrow", "days", "cover"],
+        shortcut: "SI",
+      }),
+      headless: shortInterestHeadless,
+    },
   ],
 };