gloomberb 0.18.3 → 0.18.4

package/src/cli/base-converter.ts

@@ -1,9 +1,9 @@
 import type { DataProvider } from "../types/data-provider";
-import { fixedUsdRate } from "../utils/currency-units";
+import { fixedUsdRate, heldCurrencyUnit } from "../utils/currency-units";
 import { logFailure } from "../utils/log-failure";
 
 /** One rate a converter used: units of `baseCurrency` per unit of `currency`, and when it was observed. */
-export interface BaseConversion {
+interface BaseConversion {
   currency: string;
   baseCurrency: string;
   rate: number;
@@ -14,6 +14,8 @@ export interface BaseConversion {
 /** 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[];
+  /** A currency's US dollar rate as the converter reads it, so another conversion on the report uses the same rate; null when unusable. */
+  usdRate(currency: string): Promise<UsdRate | null>;
 };
 
 interface UsdRate {
@@ -56,22 +58,29 @@ export function createBaseConverter(
     return pending;
   };
 
+  // A minor unit converts as its major currency: pence (GBp, GBX) are a hundredth of a pound, and US cents of a dollar.
+  const base = heldCurrencyUnit(baseCurrency);
   const convert = async (value: number, fromCurrency: string): Promise<number> => {
-    const normalizedFrom = fromCurrency.toUpperCase();
-    const normalizedBase = baseCurrency.toUpperCase();
-    if (normalizedFrom === normalizedBase) return value;
+    const from = heldCurrencyUnit(fromCurrency);
+    if (from.currency === base.currency) return from.divisor === base.divisor ? value : (value / from.divisor) * base.divisor;
 
-    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,
+    const [fromRate, baseRate] = await Promise.all([getRate(from.currency), getRate(base.currency)]);
+    if (!Number.isFinite(fromRate.rate) || !Number.isFinite(baseRate.rate) || baseRate.rate <= 0) return Number.NaN;
+    const dates = [fromRate.asOf, baseRate.asOf].filter((time): time is number => time != null);
+    // The rate a report states is the major currencies' (GBP/USD), which pence convert at a hundredth of.
+    used.set(from.currency, {
+      currency: from.currency,
+      baseCurrency: base.currency,
+      rate: fromRate.rate / baseRate.rate,
       asOf: dates.length > 0 ? Math.min(...dates) : null,
     });
-    return (value * from.rate) / base.rate;
+    return (value / from.divisor * fromRate.rate) / baseRate.rate * base.divisor;
   };
 
-  return Object.assign(convert, { conversions: () => [...used.values()] });
+  const usdRate = async (currency: string): Promise<UsdRate | null> => {
+    const leg = await getRate(heldCurrencyUnit(currency).currency);
+    return Number.isFinite(leg.rate) && leg.rate > 0 ? leg : null;
+  };
+
+  return Object.assign(convert, { conversions: () => [...used.values()], usdRate });
 }

package/src/cli/central-bank-events.ts

@@ -19,5 +19,5 @@ export function centralBankEventsMessage(typed: string): string | null {
   if (!bank || LISTED_SYMBOLS.has(typed.trim().replace(/^\$/, "").toUpperCase())) return null;
   const next = bank.id === "US" ? " and the next FOMC date" : bank.id === "CN" ? " and the next LPR fixing"
     : bank.id === "SA" ? "" : " and the next decision";
-  return `${bank.id === "US" ? "Fed" : bank.short} meetings are not listed; CBR shows the rate${next} (gloomberb fn CBR).`;
+  return `${bank.id === "US" ? "Fed" : bank.short} meetings are not listed; CBR shows the rate${next} (gloom fn CBR).`;
 }

package/src/cli/command-options.ts

@@ -1,4 +1,5 @@
 import type { CliCommandDef } from "../types/plugin";
+import { foldTypedText } from "../utils/typed-text";
 import { fail } from "./errors";
 import { suggestCliOption } from "./help";
 
@@ -9,13 +10,26 @@ export interface BuiltinCliCommandDef extends CliCommandDef {
    * `history`; null for the rest. `args` are the command's, to name what it was given.
    */
   unknownOptionHint?(flag: string, args: readonly string[]): string | null;
+  /**
+   * Whether the argument at `index` of the command's positional arguments
+   * (options and their values left out) is taken exactly as typed: a path, a
+   * note's text, JSON. Every other argument is folded (`foldCommandArgs`).
+   */
+  keepsArgAsTyped?(positionals: readonly string[], index: number): boolean;
 }
 
 interface DeclaredOption {
   flag: string;
   takesValue: boolean;
+  /** The value names a file or a folder (`--file <path>`), which folding would rename. */
+  path: boolean;
 }
 
+/** A value placeholder that names a file or a folder. */
+const PATH_VALUE = /<(?:path|file|dir)>/i;
+/** Options whose value is a path on every command, including those that take any option (`fn`, `shot`). */
+const PATH_OPTIONS = new Set(["--file", "--output", "--out"]);
+
 /** `--range`, `--range=5Y`: an option. `-5`, `---`, `--` and plain words are not. */
 const OPTION_TOKEN = /^--[a-z]/i;
 
@@ -31,7 +45,7 @@ function declaredOptions(command: CliCommandDef): Map<string, DeclaredOption> |
       const trimmed = spelling.trim();
       if (trimmed.startsWith("--<")) return null;
       const match = /^(--?[a-z][\w-]*)(?:[ =](.+))?$/i.exec(trimmed);
-      if (match) declared.set(match[1]!, { flag: match[1]!, takesValue: match[2] != null });
+      if (match) declared.set(match[1]!, { flag: match[1]!, takesValue: match[2] != null, path: PATH_VALUE.test(match[2] ?? "") });
     }
   }
   return declared;
@@ -39,7 +53,7 @@ function declaredOptions(command: CliCommandDef): Map<string, DeclaredOption> |
 
 /** `--explain` on a command that has no glossary of its own points at the commands that do, and at the glossary. */
 const EXPLAIN_HINT = "--explain follows the reports of fn <function> and portfolio show. "
-  + "gloomberb catalog explain <term> prints what one term means; gloomberb catalog glossary lists every term.";
+  + "gloom catalog explain <term> prints what one term means; gloom catalog glossary lists every term.";
 
 function failUnknownOption(
   command: BuiltinCliCommandDef,
@@ -49,7 +63,7 @@ function failUnknownOption(
 ): never {
   const flags = [...declared.keys()];
   const suggestion = suggestCliOption(flag, flags);
-  const help = `See gloomberb help ${command.name}.`;
+  const help = `See gloom help ${command.name}.`;
   fail(`Unknown option ${flag} for ${command.name}.`, [
     command.unknownOptionHint?.(flag, args) ?? (flag === "--explain" ? EXPLAIN_HINT : ""),
     suggestion ? `Did you mean ${suggestion}?` : "",
@@ -79,8 +93,49 @@ export function checkCliCommandOptions(
     const option = declared.get(flag);
     if (!option) failUnknownOption(command, flag, declared, args);
     if (!option.takesValue && equals >= 0) {
-      fail(`${flag} takes no value.`, `Write it alone, as ${flag}. See gloomberb help ${command.name}.`);
+      fail(`${flag} takes no value.`, `Write it alone, as ${flag}. See gloom help ${command.name}.`);
     }
     if (option.takesValue && equals < 0) index += 1;
   }
 }
+
+/**
+ * A command's arguments as its lookups read them: each folded once, here,
+ * before any symbol, number, date or search reads it (`foldTypedText`), so
+ * `quote ＧＭＥ`, `--date ２０２６-１０-１３` and `fn SIW "ＧＭＥ　AMC"` read as
+ * typed in ASCII. A path (`--file <path>`, `--output`) and what the command
+ * keeps as typed (`keepsArgAsTyped`: a note's text, JSON) are left alone.
+ */
+export function foldCommandArgs(
+  command: BuiltinCliCommandDef,
+  args: readonly string[],
+  literalStart = args.length,
+): string[] {
+  const declared = declaredOptions(command);
+  const asTyped = new Set<number>();
+  const positionals: number[] = [];
+  for (let index = 0; index < args.length; index += 1) {
+    const arg = args[index]!;
+    if (index >= literalStart || !OPTION_TOKEN.test(arg)) {
+      positionals.push(index);
+      continue;
+    }
+    const equals = arg.indexOf("=");
+    const flag = equals >= 0 ? arg.slice(0, equals) : arg;
+    const option = declared?.get(flag);
+    const path = option?.path || PATH_OPTIONS.has(flag);
+    if (equals >= 0) {
+      if (path) asTyped.add(index);
+    } else if (option?.takesValue || path) {
+      if (path) asTyped.add(index + 1);
+      index += 1;
+    }
+  }
+  if (command.keepsArgAsTyped) {
+    const words = positionals.map((index) => foldTypedText(args[index]!));
+    positionals.forEach((index, at) => {
+      if (command.keepsArgAsTyped!(words, at)) asTyped.add(index);
+    });
+  }
+  return args.map((arg, index) => asTyped.has(index) ? arg : foldTypedText(arg));
+}

package/src/cli/commands/api.ts

@@ -1,4 +1,5 @@
 import type { CliCommandDef } from "../../types/plugin";
+import type { BuiltinCliCommandDef } from "../command-options";
 import { withCliServices } from "../context";
 import { parseJsonPayload, requireArg, takeOption } from "./command-utils";
 import { CLI_COMMAND_GROUPS } from "../help";
@@ -23,9 +24,11 @@ function parseOperationTarget(target: string, ctx: Parameters<CliCommandDef["exe
   }
 }
 
-export const apiCliCommand: CliCommandDef = {
+export const apiCliCommand: BuiltinCliCommandDef = {
   name: "api",
   description: "List, inspect, call, or subscribe to plugin capabilities",
+  // Capability ids and JSON payloads go to the plugin as typed.
+  keepsArgAsTyped: () => true,
   help: {
     group: CLI_COMMAND_GROUPS.app,
     usage: [
@@ -67,11 +70,11 @@ export const apiCliCommand: CliCommandDef = {
       }
 
       if (action === "get") {
-        const capabilityId = requireArg(args[0], "Usage: gloomberb api get <capability-id>", ctx);
+        const capabilityId = requireArg(args[0], "Usage: gloom api get <capability-id>", ctx);
         const manifest = services.services.pluginRegistry.capabilities
           .manifests()
           .find((entry) => entry.id === capabilityId);
-        if (!manifest) ctx.fail(`Capability "${capabilityId}" is not available.`, "Run gloomberb api list to see them.");
+        if (!manifest) ctx.fail(`Capability "${capabilityId}" is not available.`, "Run gloom api list to see them.");
         ctx.printResult({ data: manifest }, {
           text: (data) => [
             renderStats([
@@ -92,7 +95,7 @@ export const apiCliCommand: CliCommandDef = {
       }
 
       if (action === "invoke") {
-        const target = requireArg(args[0], "Usage: gloomberb api invoke <capability.operation> [json-payload]", ctx);
+        const target = requireArg(args[0], "Usage: gloom api invoke <capability.operation> [json-payload]", ctx);
         const operationTarget = parseOperationTarget(target, ctx);
         const payload = parseJsonPayload(args[1], ctx);
         const data = await services.services.pluginRegistry.capabilities.invoke(
@@ -105,7 +108,7 @@ export const apiCliCommand: CliCommandDef = {
       }
 
       if (action === "subscribe") {
-        const target = requireArg(args[0], "Usage: gloomberb api subscribe <capability.operation> [json-payload] [--limit n]", ctx);
+        const target = requireArg(args[0], "Usage: gloom api subscribe <capability.operation> [json-payload] [--limit n]", ctx);
         const operationTarget = parseOperationTarget(target, ctx);
         const limit = ctx.cliOptions.limit ?? 10;
         const payload = parseJsonPayload(args[1], ctx);
@@ -133,7 +136,7 @@ export const apiCliCommand: CliCommandDef = {
         return;
       }
 
-      ctx.fail("Usage: gloomberb api list|get|invoke|subscribe");
+      ctx.fail("Usage: gloom api list|get|invoke|subscribe");
     });
   },
 };

package/src/cli/commands/broker.ts

@@ -18,7 +18,7 @@ export const brokerCliCommand: CliCommandDef = {
     const type = takeOption(args, "--type");
     const action = args[0] ?? "list";
     if (action !== "list" && action !== "status") {
-      ctx.fail("Usage: gloomberb broker list|status [--type <broker>]");
+      ctx.fail("Usage: gloom broker list|status [--type <broker>]");
     }
     await withCliServices(ctx, async (services) => {
       ctx.printResult({
@@ -41,7 +41,7 @@ export const brokerCliCommand: CliCommandDef = {
   },
 };
 
-/** `gloomberb ibkr` predates `broker list --type`; old scripts still run it, but help leaves it out. */
+/** `gloom ibkr` predates `broker list --type`; old scripts still run it, but help leaves it out. */
 export const ibkrCliCommand: CliCommandDef = {
   name: "ibkr",
   description: "List Interactive Brokers profiles, like broker list --type ibkr",

package/src/cli/commands/command-utils.ts

@@ -60,7 +60,7 @@ export function rejectExtraArgs(
 ): void {
   if (args.length <= max) return;
   const command = usage.split(" ")[0];
-  ctx.fail(`${command} takes ${takes}; got ${args.join(" ")}.`, [advice, `Usage: gloomberb ${usage}`].filter(Boolean).join("\n"));
+  ctx.fail(`${command} takes ${takes}; got ${args.join(" ")}.`, [advice, `Usage: gloom ${usage}`].filter(Boolean).join("\n"));
 }
 
 /** The one argument a command takes, such as a symbol: missing fails with the usage line, extras are not dropped. */
@@ -70,7 +70,7 @@ export function requireOneArg(
   noun: string,
   ctx: CliCommandContext,
 ): string {
-  const value = requireArg(args[0], `Usage: gloomberb ${usage}`, ctx);
+  const value = requireArg(args[0], `Usage: gloom ${usage}`, ctx);
   rejectExtraArgs(args, 1, { usage, takes: `one ${noun}`, advice: `Run it once per ${noun}.` }, ctx);
   return value;
 }

package/src/cli/commands/crypto-hints.ts

@@ -1,30 +1,17 @@
 import { isCryptoInstrumentType } from "../../tickers/search/ranking";
 import { isCryptoVenuePerpetual } from "../../tickers/instrument-kind";
 import type { Quote } from "../../types/financials";
-import { isCryptoPairSymbol } from "../../utils/crypto-pair";
+import { isCryptoPairSymbol, MAJOR_COIN_NAMES } from "../../utils/crypto-pair";
 import { isNotATickerMessage } from "../not-a-ticker";
 import { groupByCompany } from "../../tickers/company-name";
+import { DATA_SERVICE_UNREACHABLE_MESSAGE } from "../../utils/network-failure";
 import type { TickerRecord } from "../../types/ticker";
 
 /** Where a crypto pair that will not load can still be read. `fn CRYP` takes no argument. */
-export const CRYPTO_BOARD_HINT = "Crypto prices may be briefly unavailable; the CRYP function (gloomberb fn CRYP) shows the crypto board.";
+export const CRYPTO_BOARD_HINT = "Crypto prices may be briefly unavailable; the CRYP function (gloom fn CRYP) shows the crypto board.";
 
-// The coins whose bare ticker is most often typed for the coin itself. The label is how the note
-// names the coin and what a listing's name has to say before the note applies.
-const MAJOR_COINS = new Map([
-  ["BTC", "bitcoin"],
-  ["ETH", "ethereum"],
-  ["SOL", "solana"],
-  ["XRP", "XRP"],
-  ["DOGE", "dogecoin"],
-  ["ADA", "cardano"],
-  ["LTC", "litecoin"],
-  ["BCH", "bitcoin cash"],
-  ["AVAX", "avalanche"],
-  ["DOT", "polkadot"],
-  ["LINK", "chainlink"],
-  ["BNB", "BNB"],
-]);
+// How the note names the coin, and what a listing's name has to say before the note applies.
+const MAJOR_COINS = MAJOR_COIN_NAMES;
 
 /**
  * A bare coin ticker usually resolves to a listed fund, not the coin. The note applies only when
@@ -83,7 +70,7 @@ function failureReason(message: string, symbol: string): string {
 
 /**
  * Text-mode notes under a quote table: one line per distinct failure reason (with the crypto board
- * pointer when a failed symbol is a crypto pair), then a line for each bare coin ticker that
+ * pointer when a failed symbol is a crypto pair, unless nothing could be reached), then a line for each bare coin ticker that
  * resolved to something else. `--exchange` names the listing on purpose, so it gets no coin note.
  */
 export function quoteNotes(results: QuoteNoteResult[], options: { exchange?: string } = {}): string[] {
@@ -98,7 +85,7 @@ export function quoteNotes(results: QuoteNoteResult[], options: { exchange?: str
     // "Not a ticker: APPLE." already names its symbol.
     isNotATickerMessage(reason)
       ? reason
-      : `${symbols.join(", ")}: ${reason}${symbols.some(isCryptoPairSymbol) ? `${/[.!?]$/.test(reason) ? "" : "."} ${CRYPTO_BOARD_HINT}` : ""}`
+      : `${symbols.join(", ")}: ${reason}${symbols.some(isCryptoPairSymbol) && reason !== DATA_SERVICE_UNREACHABLE_MESSAGE ? `${/[.!?]$/.test(reason) ? "" : "."} ${CRYPTO_BOARD_HINT}` : ""}`
   ));
   if (!options.exchange) {
     for (const result of results) {

package/src/cli/commands/fred-series.ts

@@ -13,6 +13,8 @@ export const DEFAULT_FRED_START = "2021-01-01";
  */
 const SPREAD_SERIES: ReadonlySet<string> = new Set([
   "T10Y2Y", "T10Y3M",
+  // The 30-year mortgage rate less the 10-year Treasury, which Gloom Cloud computes on each PMMS date.
+  "MORTGAGE30US10Y",
   ...ICE_SPREAD_SERIES.map((series) => series.seriesId),
 ]);
 
@@ -269,8 +271,8 @@ export function fredEmptyMessage(startDate: string, latest: { date: string; valu
 /** What an export of nothing on or after `--start` says to try instead: a start that reaches the latest observation. */
 export function fredEmptyAdvice(seriesId: string, latest: { date: string } | null): string {
   return latest
-    ? `Latest observation: ${latest.date}. Try: gloomberb fred ${seriesId} --start ${latest.date.slice(0, 4)}`
-    : `No observations came back for ${seriesId}. Try an earlier --start, or gloomberb fred --list for the series served.`;
+    ? `Latest observation: ${latest.date}. Try: gloom fred ${seriesId} --start ${latest.date.slice(0, 4)}`
+    : `No observations came back for ${seriesId}. Try an earlier --start, or gloom fred --list for the series served.`;
 }
 
 /** A series as `fred --list` shows it. */

package/src/cli/commands/keybindings.ts

@@ -49,12 +49,12 @@ export function applyKeybindingCliSet(config: AppConfig, key: string, rawValue:
   const target = rest.join(".");
   const value = rawValue.trim();
   if (!target) {
-    return { ok: false, message: `Usage: gloomberb config set ${KEYBINDINGS_CONFIG_KEY}.actions.<action> <chord> or ${KEYBINDINGS_CONFIG_KEY}.commands.<chord> <query>` };
+    return { ok: false, message: `Usage: gloom config set ${KEYBINDINGS_CONFIG_KEY}.actions.<action> <chord> or ${KEYBINDINGS_CONFIG_KEY}.commands.<chord> <query>` };
   }
 
   if (section === "actions") {
     if (!isCoreKeybindingActionId(target) && !target.startsWith(PLUGIN_ACTION_PREFIX)) {
-      return { ok: false, message: `"${target}" is not a keybinding action. Run "gloomberb config get keybindings" for the list.` };
+      return { ok: false, message: `"${target}" is not a keybinding action. Run "gloom config get keybindings" for the list.` };
     }
     const lowered = value.toLowerCase();
     if (DEFAULT_WORDS.has(lowered)) {