gloomberb 0.16.2 → 0.16.4

package/src/plugins/catalog-browser.ts

@@ -12,6 +12,7 @@ import { debtMaturitiesModule } from "./builtin/debt-maturities";
 import { revenueBreakdownModule } from "./builtin/revenue-breakdown";
 import { mnaModule } from "./builtin/mna";
 import { cryptoBoardModule } from "./builtin/crypto-board";
+import { shortInterestModule } from "./builtin/short-interest";
 import { shortVolumeModule } from "./builtin/short-volume";
 import { socialMentionsModule } from "./builtin/social-mentions";
 import { timeSalesModule } from "./builtin/time-sales";
@@ -93,11 +94,21 @@ import { moneyMarketsModule } from "./builtin/money-markets";
 import { ratePathModule } from "./builtin/rate-path";
 import {
   applicationPluginMeta,
-  macroPluginMeta,
-  marketOverviewPluginMeta,
+  creditPluginMeta,
+  earningsPluginMeta,
+  filingsPluginMeta,
+  optionsVolatilityPluginMeta,
+  ownershipPluginMeta,
+  ratesMacroPluginMeta,
+  tickerCorePluginMeta,
+  altDataPluginMeta,
+  cryptoPluginMeta,
+  futuresCommoditiesPluginMeta,
+  globalMarketsPluginMeta,
+  quantPluginMeta,
+  screenersPluginMeta,
   newsPluginMeta,
   portfolioPluginMeta,
-  tickerResearchPluginMeta,
 } from "./builtin/builtin-plugin-meta";
 
 const browserApplicationPlugin = composeBuiltinPlugin({
@@ -110,84 +121,107 @@ const browserPortfolioPlugin = composeBuiltinPlugin({
   modules: [portfolioListModule, portfolioAnalyticsModule, positionSizerModule],
 });
 
-const browserTickerResearchPlugin = composeBuiltinPlugin({
-  ...tickerResearchPluginMeta,
+// Ticker Research's successors with the modules it had on the web. Holders,
+// 13F funds and the Congress tab are terminal-only, so Ownership & Insiders
+// is smaller here.
+const browserTickerCorePlugin = composeBuiltinPlugin({
+  ...tickerCorePluginMeta,
   modules: [
     tickerDetailModule,
     chartComposerModule,
+    researchModule,
+    estimateRevisionsModule,
+    companyKpisModule,
+    revenueBreakdownModule,
+    browserDividendYieldModule,
+    reverseDcfModule,
+    peBandModule,
+    executivesModule,
+    timeSalesModule,
+  ],
+});
+
+const browserOptionsVolatilityPlugin = composeBuiltinPlugin({
+  ...optionsVolatilityPluginMeta,
+  modules: [
     optionsModule,
     optionsPositioningModule,
     optionsCalculatorModule,
     optionsScenarioModule,
     volSurfaceModule,
     realizedVolModule,
-    seasonalityModule,
-    earningsRippleModule,
-    reverseDcfModule,
-    peBandModule,
-    macroDayModule,
     ivHistoryModule,
-    backtestModule,
-    timeSalesModule,
-    estimateRevisionsModule,
-    researchModule,
-    shortVolumeModule,
-    socialMentionsModule,
-    debtMaturitiesModule,
-    revenueBreakdownModule,
-    supplyChainModule,
-    creditDocumentsModule,
-    companyAttentionModule,
-    catalystsModule,
-    companyKpisModule,
-    awardsModule,
-    exposureModule,
-    mnaModule,
-    browserDividendYieldModule,
-    earningsCallsModule,
-    executivesModule,
-    riskFactorsModule,
-    filingEventsModule,
-    // Filings and Form 4s come through Gloom Cloud, behind a sign-in wall.
-    secModule,
+  ],
+});
+
+const browserOwnershipPlugin = composeBuiltinPlugin({
+  ...ownershipPluginMeta,
+  description: "Insider trades, and short interest and volume.",
+  modules: [
+    // Form 4s come through Gloom Cloud, behind a sign-in wall.
     insiderModule,
-    // Hiring data is a Gloom Cloud Pro dataset.
-    jobsModule,
+    // Daily volume shares open this pane.
+    shortInterestModule,
+    shortVolumeModule,
   ],
 });
 
+const browserFilingsPlugin = composeBuiltinPlugin({
+  ...filingsPluginMeta,
+  // Filings come through Gloom Cloud, behind a sign-in wall.
+  modules: [secModule, riskFactorsModule, filingEventsModule, catalystsModule, mnaModule],
+});
+
 const browserNewsPlugin = composeBuiltinPlugin({
   ...newsPluginMeta,
   modules: [tickerNewsModule, browserNewsWireModule],
 });
 
-const browserMarketOverviewPlugin = composeBuiltinPlugin({
-  ...marketOverviewPluginMeta,
-  description: "Global indices, scanners, sectors, FX, futures, and correlations.",
+// Market Overview's successors with the modules it had on the web: all of
+// them but top movers.
+const browserGlobalMarketsPlugin = composeBuiltinPlugin({
+  ...globalMarketsPluginMeta,
+  modules: [worldIndicesModule, worldVenueMapModule, sectorsModule, fxMatrixModule, relativeRotationModule],
+});
+
+const browserScreenersPlugin = composeBuiltinPlugin({
+  ...screenersPluginMeta,
+  description: "Equity screener, session highs and lows, and unusual options flow.",
+  modules: [equityScreenerModule, scannerModule],
+});
+
+const browserFuturesCommoditiesPlugin = composeBuiltinPlugin({
+  ...futuresCommoditiesPluginMeta,
+  modules: [futuresModule, futuresCurveModule, cotModule, doeModule],
+});
+
+const browserCryptoPlugin = composeBuiltinPlugin({
+  ...cryptoPluginMeta,
+  modules: [cryptoBoardModule, perpsModule],
+});
+
+const browserAltDataPlugin = composeBuiltinPlugin({
+  ...altDataPluginMeta,
   modules: [
-    correlationModule,
-    relativeRotationModule,
-    equityScreenerModule,
-    worldIndicesModule,
-    worldVenueMapModule,
-    scannerModule,
-    sectorsModule,
-    fxMatrixModule,
-    futuresModule,
-    futuresCurveModule,
-    cotModule,
-    doeModule,
-    gpuModule,
-    attentionModule,
-    powerModule,
-    cryptoBoardModule,
-    perpsModule,
+    ...[attentionModule, gpuModule, powerModule].map((module) => ({ module, stateId: "market-overview" })),
+    supplyChainModule,
+    exposureModule,
+    awardsModule,
+    companyAttentionModule,
+    // Hiring data is a Gloom Cloud Pro dataset.
+    jobsModule,
+    socialMentionsModule,
   ],
 });
 
-const browserMacroPlugin = composeBuiltinPlugin({
-  ...macroPluginMeta,
-  description: "Economic calendar, rates, volatility, credit spreads, single-name, index and sovereign CDS, and Treasury auctions.",
+const browserQuantPlugin = composeBuiltinPlugin({
+  ...quantPluginMeta,
+  modules: [{ module: correlationModule, stateId: "market-overview" }, backtestModule, seasonalityModule, macroDayModule],
+});
+
+// The same panes as on the terminal.
+const browserRatesMacroPlugin = composeBuiltinPlugin({
+  ...ratesMacroPluginMeta,
   modules: [
     macroSharedResourcesModule,
     economicCalendarModule,
@@ -196,14 +230,34 @@ const browserMacroPlugin = composeBuiltinPlugin({
     yieldCurveModule,
     ratePathModule,
     moneyMarketsModule,
-    bondCalculatorModule,
     centralBankRatesModule,
     volatilityModule,
-    creditConditionsModule,
     marketValuationModule,
+  ],
+});
+
+const browserCreditPlugin = composeBuiltinPlugin({
+  ...creditPluginMeta,
+  modules: [
     cdsModule,
     creditBoardsModule,
+    creditConditionsModule,
     treasuryAuctionsModule,
+    bondCalculatorModule,
+    { module: creditDocumentsModule, stateId: "ticker-research" },
+    { module: debtMaturitiesModule, stateId: "ticker-research" },
+  ],
+});
+
+// The web app has never carried the earnings calendar. The call transcripts
+// and the ripple ran with Ticker Research here, so their pane state is under
+// its namespace, not Macro's as on the terminal.
+const browserEarningsPlugin = composeBuiltinPlugin({
+  ...earningsPluginMeta,
+  description: "Earnings call transcripts, and the earnings ripple through customers and suppliers.",
+  modules: [
+    { module: earningsCallsModule, stateId: "ticker-research" },
+    { module: earningsRippleModule, stateId: "ticker-research" },
   ],
 });
 
@@ -215,10 +269,18 @@ const browserMacroPlugin = composeBuiltinPlugin({
 export const browserBuiltinPlugins: readonly GloomPlugin[] = [
   browserGloomberbCloudPlugin,
   browserPortfolioPlugin,
-  browserTickerResearchPlugin,
+  browserTickerCorePlugin,
+  browserOptionsVolatilityPlugin,
+  browserOwnershipPlugin,
+  browserFilingsPlugin,
   browserApplicationPlugin,
   browserNewsPlugin,
-  browserMarketOverviewPlugin,
+  browserGlobalMarketsPlugin,
+  browserScreenersPlugin,
+  browserFuturesCommoditiesPlugin,
+  browserCryptoPlugin,
+  browserAltDataPlugin,
+  browserQuantPlugin,
   marketHeatmapPlugin,
   marketHaltsPlugin,
   fearGreedPlugin,
@@ -227,7 +289,9 @@ export const browserBuiltinPlugins: readonly GloomPlugin[] = [
   clinicalTrialsPlugin,
   commentLettersPlugin,
   openFdaPlugin,
-  browserMacroPlugin,
+  browserRatesMacroPlugin,
+  browserCreditPlugin,
+  browserEarningsPlugin,
   alertsPlugin,
   researchSearchPlugin,
 ];

package/src/plugins/catalog-manifest.ts

@@ -1,5 +1,10 @@
+import type { FunctionAccess } from "../cli/pane-functions/function-help";
+import type { GloomPlugin, PluginTarget } from "../types/plugin";
 import { ABSORBED_PLUGINS } from "./absorbed";
+import { highlightedCodes, pluginFunctions } from "./plugin-functions";
+import { BUILTIN_EDITORIAL } from "./builtin-editorial";
 import { getPluginCatalog } from "./catalog";
+import { browserBuiltinPlugins } from "./catalog-browser";
 
 /**
  * The public description of the plugins that ship inside Gloomberb.
@@ -8,71 +13,80 @@ import { getPluginCatalog } from "./catalog";
  * built-in has no repository to read metadata from. Hand-maintaining that half
  * elsewhere meant it silently drifted every time a built-in changed its panes
  * or description, so it is derived from the live catalog here instead and
- * checked against a committed snapshot in CI.
+ * checked against a committed snapshot in CI. Editorial copy the catalog does
+ * not carry lives in `builtin-editorial.ts`.
+ *
+ * Fields added since the first version are optional for the directory, which
+ * keeps reading a manifest without them.
  */
 
+/** A function the plugin adds, as the directory lists it. */
+interface BuiltinShortcutManifestEntry {
+  code: string;
+  name: string;
+  description: string;
+  /** Free gets only the upgrade (`pro`) or a preview (`preview`); absent when Free gets it all. */
+  access?: FunctionAccess;
+  /** Where it runs, when that is narrower than the plugin: a code the web app lacks. */
+  targets?: PluginTarget[];
+}
+
 interface BuiltinPluginManifestEntry {
   id: string;
   name: string;
   description: string;
+  /** Ten words at most, for a card. */
+  tagline?: string;
   /** Curated, since the catalog has no notion of categories. */
   categories: string[];
   toggleable: boolean;
   featured?: true;
   /** Path to artwork in this repo, resolved by the directory against HEAD. */
   icon?: string;
+  /** Everywhere the app runs, and the web when the browser catalog carries it. */
+  targets: PluginTarget[];
   contributes: {
     panes: string[];
     capabilities: string[];
     broker: boolean;
+    shortcuts?: BuiltinShortcutManifestEntry[];
   };
+  /** The codes a card shows. */
+  highlights?: string[];
+  /** Codes whose reviewed capture the directory shows, best first. */
+  screenshots?: string[];
 }
 
-/**
- * Editorial metadata the runtime catalog does not carry. Anything missing here
- * is reported by `generate-plugin-manifest.ts` rather than silently defaulted,
- * so a new built-in cannot slip into the directory uncategorised.
- */
-const EDITORIAL: Record<
-  string,
-  { categories: string[]; featured?: true; icon?: string }
-> = {
-  "gloomberb-cloud": {
-    categories: ["data", "cloud"],
-    featured: true,
-    icon: "plugin-icons/gloomberb-cloud.webp",
-  },
-  alerts: { categories: ["alerts"] },
-  application: { categories: ["core"] },
-  broker: { categories: ["broker"] },
-  "clinical-trials": { categories: ["research"] },
-  "comment-letters": { categories: ["research"] },
-  "custom-view": { categories: ["data", "productivity"] },
-  debug: { categories: ["developer"] },
-  "fear-greed": { categories: ["markets", "sentiment"], icon: "plugin-icons/fear-greed.webp" },
-  members: { categories: ["markets", "research"] },
-  "ipo-calendar": { categories: ["macro", "markets"], icon: "plugin-icons/ipo-calendar.webp" },
-  macro: { categories: ["macro"] },
-  "market-halts": { categories: ["markets"], icon: "plugin-icons/market-halts.webp" },
-  "market-heatmap": { categories: ["markets"], icon: "plugin-icons/market-heatmap.webp" },
-  "market-overview": { categories: ["markets"] },
-  news: { categories: ["news"] },
-  notes: { categories: ["productivity"] },
-  openfda: { categories: ["research"] },
-  portfolio: { categories: ["portfolio"] },
-  "research-search": { categories: ["research", "news"] },
-  "ticker-research": { categories: ["research"] },
-};
-
 export interface BuiltinManifest {
   version: 1;
   plugins: BuiltinPluginManifestEntry[];
   /** Built-in ids with no editorial entry; a non-empty list fails generation. */
   uncategorised: string[];
+  /** Editorial highlights or screenshots naming a code the plugin lacks, as `id:CODE`; these fail generation too. */
+  unknownCodes: string[];
+}
+
+const NATIVE_TARGETS: PluginTarget[] = ["cli", "tui", "desktop"];
+
+/**
+ * The codes a plugin's pane templates answer to. Commands a plugin registers
+ * while it sets up (ALRT, NOTE) are not known until it runs, so they are not
+ * listed; the Plugins pane reads them from the running app.
+ */
+function functionsOf(plugin: GloomPlugin) {
+  return pluginFunctions({
+    templates: (plugin.paneTemplates ?? []).map((template) => ({
+      label: template.label,
+      prefix: template.shortcut?.prefix,
+      description: template.description,
+    })),
+  });
 }
 
 export function buildBuiltinManifest(): BuiltinManifest {
   const uncategorised: string[] = [];
+  const unknownCodes: string[] = [];
+  const web = new Map(browserBuiltinPlugins.map((plugin) => [plugin.id, plugin]));
 
   const plugins = getPluginCatalog()
     // Built in again, but released apps from before that still install these
@@ -80,18 +94,34 @@ export function buildBuiltinManifest(): BuiltinManifest {
     // id a built-in claims. This build shows that row as its built-in, so they
     // join the manifest once those releases have updated.
     .filter(({ plugin }) => !ABSORBED_PLUGINS.some((absorbed) => absorbed.id === plugin.id))
-    .map(({ plugin }) => {
-      const editorial = EDITORIAL[plugin.id];
+    .map(({ plugin }): BuiltinPluginManifestEntry => {
+      const editorial = BUILTIN_EDITORIAL[plugin.id];
       if (!editorial) uncategorised.push(plugin.id);
 
+      // Some built-ins carry fewer functions in the web app.
+      const webPlugin = web.get(plugin.id);
+      const webCodes = new Set(webPlugin ? functionsOf(webPlugin).map((fn) => fn.code) : []);
+      const functions = functionsOf(plugin);
+      const shortcuts = functions.map((fn): BuiltinShortcutManifestEntry => ({
+        ...fn,
+        ...(webPlugin && !webCodes.has(fn.code) ? { targets: [...NATIVE_TARGETS] } : {}),
+      }));
+      const codes = new Set(functions.map((fn) => fn.code));
+      for (const code of [...editorial?.highlights ?? [], ...editorial?.screenshots ?? []]) {
+        if (!codes.has(code)) unknownCodes.push(`${plugin.id}:${code}`);
+      }
+      const screenshots = (editorial?.screenshots ?? []).filter((code) => codes.has(code));
+
       return {
         id: plugin.id,
         name: plugin.name,
         description: plugin.description ?? "",
+        ...(editorial?.tagline ? { tagline: editorial.tagline } : {}),
         categories: editorial?.categories ?? [],
         toggleable: plugin.toggleable === true,
         ...(editorial?.featured ? { featured: true as const } : {}),
         ...(editorial?.icon ? { icon: editorial.icon } : {}),
+        targets: webPlugin ? [...NATIVE_TARGETS, "web"] : [...NATIVE_TARGETS],
         contributes: {
           panes: (plugin.panes ?? []).map((pane) => pane.id).sort(),
           capabilities: (plugin.capabilities ?? [])
@@ -101,10 +131,13 @@ export function buildBuiltinManifest(): BuiltinManifest {
             })
             .sort(),
           broker: !!plugin.broker,
+          ...(shortcuts.length > 0 ? { shortcuts } : {}),
         },
+        ...(functions.length > 0 ? { highlights: highlightedCodes(plugin.id, functions) } : {}),
+        ...(screenshots.length > 0 ? { screenshots } : {}),
       };
     })
     .sort((left, right) => left.id.localeCompare(right.id));
 
-  return { version: 1, plugins, uncategorised: uncategorised.sort() };
+  return { version: 1, plugins, uncategorised: uncategorised.sort(), unknownCodes };
 }

package/src/plugins/catalog-ui.ts

@@ -15,24 +15,42 @@ import { clinicalTrialsPlugin } from "./builtin/clinical-trials";
 import { commentLettersPlugin } from "./builtin/comment-letters";
 import { openFdaPlugin } from "./builtin/openfda";
 import {
+  altDataPlugin,
   applicationPlugin,
   brokerPlugin,
-  macroPlugin,
-  marketOverviewPlugin,
+  creditPlugin,
+  cryptoPlugin,
+  earningsPlugin,
+  filingsPlugin,
+  futuresCommoditiesPlugin,
+  globalMarketsPlugin,
+  optionsVolatilityPlugin,
+  ownershipPlugin,
   portfolioPlugin,
-  tickerResearchPlugin,
+  quantPlugin,
+  ratesMacroPlugin,
+  screenersPlugin,
+  tickerCorePlugin,
 } from "./builtin/composite-plugins";
 
 export const uiBuiltinPlugins: GloomPlugin[] = [
   gloomberbCloudPlugin,
   portfolioPlugin,
-  tickerResearchPlugin,
+  tickerCorePlugin,
+  optionsVolatilityPlugin,
+  ownershipPlugin,
+  filingsPlugin,
   brokerPlugin,
   applicationPlugin,
   newsPlugin,
   notesPlugin,
   customViewPlugin,
-  marketOverviewPlugin,
+  globalMarketsPlugin,
+  screenersPlugin,
+  futuresCommoditiesPlugin,
+  cryptoPlugin,
+  altDataPlugin,
+  quantPlugin,
   marketHeatmapPlugin,
   marketHaltsPlugin,
   fearGreedPlugin,
@@ -41,7 +59,9 @@ export const uiBuiltinPlugins: GloomPlugin[] = [
   clinicalTrialsPlugin,
   commentLettersPlugin,
   openFdaPlugin,
-  macroPlugin,
+  ratesMacroPlugin,
+  creditPlugin,
+  earningsPlugin,
   alertsPlugin,
   researchSearchPlugin,
 ];

package/src/plugins/extracted-plugins.ts

@@ -4,6 +4,7 @@ import { join } from "path";
 import type { AppConfig } from "../types/config";
 import { debugLog } from "../utils/debug-log";
 import { getPluginsDir } from "./loader";
+import { encodeBuiltinDisabledPluginIds } from "./ownership";
 import { pluginDirectoryNames } from "./plugin-names";
 
 const log = debugLog.createLogger("plugin-seed");
@@ -63,7 +64,12 @@ export async function seedExtractedPlugins(
   pluginsDir: string = getPluginsDir(),
 ): Promise<SeedResult> {
   const alreadySeeded = new Set(config.seededPlugins ?? []);
-  const disabled = new Set(config.disabledPlugins ?? []);
+  // A previous owner that is now a group of built-ins counts as off only while
+  // all of them are, which is when its id is saved.
+  const disabled = new Set([
+    ...config.disabledPlugins ?? [],
+    ...encodeBuiltinDisabledPluginIds(config.disabledPlugins ?? []),
+  ]);
 
   const result: SeedResult = { installed: [], failed: [], seeded: [...alreadySeeded] };