@gloom-sh/terminal 0.18.5 → 0.19.1

package/README.md

@@ -50,7 +50,7 @@ The script downloads the prebuilt release from GitHub and checks its SHA-256 aga
 With [Bun](https://bun.sh), on any supported OS:
 
 ```bash
-bun install -g gloomberb
+bun install -g @gloom-sh/terminal
 ```
 
 Then run `gloom`. The command was called `gloomberb` before 0.18.4, and that name still works. For chart graphics, use a Kitty-compatible terminal such as Ghostty, Kitty, or WezTerm. Windows Terminal draws charts as text; the desktop app draws them in full.

package/README.zh-CN.md

@@ -62,7 +62,7 @@ curl -fsSL gloom.sh/install | bash
 也可在 macOS、Linux 或 Windows x64 上通过 [Bun](https://bun.sh) 安装：
 
 ```bash
-bun install -g gloomberb
+bun install -g @gloom-sh/terminal
 ```
 
 运行 `gloom` 即可启动。0.18.4 之前命令名为 `gloomberb`，该名称仍可使用。要显示图形，请使用兼容 Kitty 图形协议的终端，例如 Ghostty、Kitty 或 WezTerm。直接下载、安装位置与更新方式详见[安装指南（英文）](docs/installation.md)。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gloom-sh/terminal",
-  "version": "0.18.5",
+  "version": "0.19.1",
   "packageManager": "bun@1.3.11",
   "description": "Market research and portfolio tracker for the terminal",
   "module": "src/public/index.ts",

package/patches/electrobun@1.18.1.patch

@@ -1,3 +1,16 @@
+diff --git a/dist/api/browser/index.ts b/dist/api/browser/index.ts
+index 3e309b18fdbcec84a4a56f97df4debe7fb8246f8..03420222c1d9ba897835c5e7376c7153ede294fc 100644
+--- a/dist/api/browser/index.ts
++++ b/dist/api/browser/index.ts
+@@ -50,7 +50,7 @@ class Electroview<T extends RPCWithTransport> {
+ 		// Note: Using ws:// for localhost is intentional - all RPC messages are
+ 		// encrypted with per-webview AES-GCM keys, making TLS redundant
+ 		const socket = new WebSocket(
+-			`ws://localhost:${RPC_SOCKET_PORT}/socket?webviewId=${WEBVIEW_ID}`,
++			`ws://127.0.0.1:${RPC_SOCKET_PORT}/socket?webviewId=${WEBVIEW_ID}`,
+ 		);
+ 
+ 		this.bunSocket = socket;
 diff --git a/dist/api/bun/core/BrowserWindow.ts b/dist/api/bun/core/BrowserWindow.ts
 index c26c2c977ee1fc25a8dc144b85bac8626a45f572..8920a2905380228c23cba66c20d9bfd19ee13e02 100644
 --- a/dist/api/bun/core/BrowserWindow.ts
@@ -54,7 +67,7 @@ index c26c2c977ee1fc25a8dc144b85bac8626a45f572..8920a2905380228c23cba66c20d9bfd1
  				width: this.frame.width,
  				height: this.frame.height,
 diff --git a/dist/api/bun/core/Socket.ts b/dist/api/bun/core/Socket.ts
-index cdaa2bca0fabe577cb667056aa6f8f84211189c2..3839e5232742c2467180c344f51a30f1ff3c797f 100644
+index cdaa2bca0fabe577cb667056aa6f8f84211189c2..e9cdd82c934f6da58055dc8343ee3b953ec1ee81 100644
 --- a/dist/api/bun/core/Socket.ts
 +++ b/dist/api/bun/core/Socket.ts
 @@ -3,13 +3,8 @@ import { BrowserView } from "./BrowserView";
@@ -73,8 +86,17 @@ index cdaa2bca0fabe577cb667056aa6f8f84211189c2..3839e5232742c2467180c344f51a30f1
  }
  
  // Encrypt function
+@@ -65,6 +60,8 @@ const startRPCServer = () => {
+ 	while (port <= endPort) {
+ 		try {
+ 			server = Bun.serve<{ webviewId: number }>({
++				// Only this machine's webviews connect.
++				hostname: "127.0.0.1",
+ 				port,
+ 				fetch(req: Request, server: Server<{ webviewId: number }>) {
+ 					const url = new URL(req.url);
 diff --git a/dist/api/bun/core/Updater.ts b/dist/api/bun/core/Updater.ts
-index 39daf6d341780af8e30c2c50327162863f5977ec..65677cd1d642ef832cf4f90a315d3ffc977909a3 100644
+index 39daf6d341780af8e30c2c50327162863f5977ec..4f3d2bef8e4b41a13a5a522c0af8dd700879a5db 100644
 --- a/dist/api/bun/core/Updater.ts
 +++ b/dist/api/bun/core/Updater.ts
 @@ -132,6 +132,19 @@ let updateInfo: {
@@ -193,7 +215,52 @@ index 39daf6d341780af8e30c2c50327162863f5977ec..65677cd1d642ef832cf4f90a315d3ffc
  				emitStatus(
  					"fetching-patch",
  					`Checking for patch: ${currentHash.slice(0, 8)}`,
-@@ -612,12 +679,12 @@ const Updater = {
+@@ -498,11 +565,25 @@ const Updater = {
+ 				// - macOS/Windows: Resources/version.json (inside the app bundle directory)
+ 				// - Linux: metadata.json (alongside the app bundle)
+ 				const resourcesDir = "Resources";
+-				const patchedTarBytes = await Bun.file(
+-					tmpPatchedTarFilePath,
+-				).arrayBuffer();
+-				const patchedArchive = new Bun.Archive(patchedTarBytes);
+-				const patchedFiles = await patchedArchive.files();
++				let patchedFiles: Map<string, File>;
++				try {
++					const patchedTarBytes = await Bun.file(
++						tmpPatchedTarFilePath,
++					).arrayBuffer();
++					const patchedArchive = new Bun.Archive(patchedTarBytes);
++					patchedFiles = await patchedArchive.files();
++				} catch (error) {
++					// bspatch does not check what it patches: from a damaged tar it
++					// makes one that does not read, and would at every retry. The
++					// full download replaces both.
++					const message = error instanceof Error ? error.message : String(error);
++					emitStatus("patch-failed", `Patched tar does not read: ${message}`, {
++						currentHash,
++						errorMessage: message,
++					});
++					console.error("patched tar does not read", error);
++					break;
++				}
+ 
+ 				for (const [filePath] of patchedFiles) {
+ 					if (
+@@ -528,8 +609,11 @@ const Updater = {
+ 				}
+ 
+ 				const hashFile = patchedFiles.get(hashFilePath);
+-				const hashFileJson = JSON.parse(await hashFile!.text());
+-				const nextHash = hashFileJson.hash;
++				// Unreadable, it has no hash below and the full download follows.
++				const nextHash: string = await hashFile!
++					.text()
++					.then((text) => JSON.parse(text)?.hash)
++					.catch(() => "");
+ 
+ 				if (seenHashes.includes(nextHash)) {
+ 					emitStatus(
+@@ -612,12 +696,12 @@ const Updater = {
  
  				const cacheBuster = Math.random().toString(36).substring(7);
  				const platformPrefix = getPlatformPrefix(
@@ -208,7 +275,65 @@ index 39daf6d341780af8e30c2c50327162863f5977ec..65677cd1d642ef832cf4f90a315d3ffc
  				const prevVersionCompressedTarballPath = join(
  					appDataFolder,
  					"self-extraction",
-@@ -760,7 +827,12 @@ const Updater = {
+@@ -689,6 +773,13 @@ const Updater = {
+ 					emitStatus("error", updateInfo.error, { zstdPath });
+ 					console.error("zig-zstd not found:", zstdPath);
+ 				} else {
++					// Into a name of its own, renamed once whole: zig-zstd writes as
++					// it goes, and a run that failed (a download cut short) or never
++					// finished (the app quit) left part of a tar under the update's
++					// own name, which every later download took as done and every
++					// install then failed to unpack.
++					const partialTarPath = `${latestTarPath}.partial`;
++					rmSync(partialTarPath, { force: true });
+ 					const decompressResult = Bun.spawnSync(
+ 						[
+ 							zstdPath,
+@@ -696,7 +787,7 @@ const Updater = {
+ 							"-i",
+ 							prevVersionCompressedTarballPath,
+ 							"-o",
+-							latestTarPath,
++							partialTarPath,
+ 							"--no-timing",
+ 						],
+ 						{
+@@ -706,6 +797,7 @@ const Updater = {
+ 						},
+ 					);
+ 					if (!decompressResult.success) {
++						rmSync(partialTarPath, { force: true });
+ 						updateInfo.error = `zig-zstd failed with exit code ${decompressResult.exitCode}`;
+ 						emitStatus("error", updateInfo.error, {
+ 							zstdPath,
+@@ -716,6 +808,7 @@ const Updater = {
+ 							zstdPath,
+ 						});
+ 					} else {
++						renameSync(partialTarPath, latestTarPath);
+ 						emitStatus("decompressing", "Decompression complete");
+ 					}
+ 				}
+@@ -731,6 +824,8 @@ const Updater = {
+ 			// check for patch from that tar and apply it, until it matches the latest version
+ 			// as a fallback it should just download and unpack the latest version
+ 			updateInfo.updateReady = true;
++			// What failed on the way (a patch that did not apply) was recovered from.
++			updateInfo.error = "";
+ 			emitStatus(
+ 				"download-complete",
+ 				`Update ready to install (used ${usedPatchPath ? "patch" : "full download"} path)`,
+@@ -741,7 +836,8 @@ const Updater = {
+ 				},
+ 			);
+ 		} else {
+-			updateInfo.error = "Failed to download latest version";
++			// Why it failed (zig-zstd's exit), when that is known.
++			if (!updateInfo.error) updateInfo.error = "Failed to download latest version";
+ 			emitStatus("error", "Failed to download latest version", { latestHash });
+ 		}
+ 
+@@ -760,7 +856,12 @@ const Updater = {
  				mkdirSync(extractionFolder, { recursive: true });
  			}
  
@@ -222,7 +347,37 @@ index 39daf6d341780af8e30c2c50327162863f5977ec..65677cd1d642ef832cf4f90a315d3ffc
  			const latestTarPath = join(extractionFolder, `${latestHash}.tar`);
  
  			let appBundleSubpath: string = "";
-@@ -894,14 +966,7 @@ const Updater = {
+@@ -782,9 +883,26 @@ const Updater = {
+ 					mkdirSync(extractionDir, { recursive: true });
+ 				}
+ 
+-				const latestTarBytes = await Bun.file(latestTarPath).arrayBuffer();
+-				const latestArchive = new Bun.Archive(latestTarBytes);
+-				await latestArchive.extract(extractionDir);
++				try {
++					const latestTarBytes = await Bun.file(latestTarPath).arrayBuffer();
++					const latestArchive = new Bun.Archive(latestTarBytes);
++					await latestArchive.extract(extractionDir);
++				} catch (error) {
++					// The tar goes, with what it unpacked: left in place, every later
++					// download took it as the update again and every install failed
++					// here the same way. The next download fetches a fresh copy.
++					const message = `Failed to extract update: ${error instanceof Error ? error.message : String(error)}`;
++					try {
++						rmSync(latestTarPath, { force: true });
++					} catch (e) {
++						// Best effort, like the cleanup below.
++					}
++					cleanupExtractionFolder(extractionFolder, latestHash);
++					updateInfo.updateReady = false;
++					emitStatus("error", message, { errorMessage: message });
++					console.error("Failed to extract update", error);
++					return;
++				}
+ 
+ 				if (currentOS === "macos") {
+ 					// Find the .app bundle by scanning extracted directory
+@@ -894,14 +1012,7 @@ const Updater = {
  					emitStatus("replacing-app", "Removing old version...");
  
  					if (currentOS === "macos") {
@@ -238,7 +393,7 @@ index 39daf6d341780af8e30c2c50327162863f5977ec..65677cd1d642ef832cf4f90a315d3ffc
  
  						// Remove quarantine extended attributes to prevent "damaged" error
  						// The inner bundle is already signed/notarized, but macOS applies
-@@ -918,14 +983,7 @@ const Updater = {
+@@ -918,14 +1029,7 @@ const Updater = {
  						// On Linux, we now have directory bundles instead of AppImage files
  						// The app is stored in {appDataFolder}/app/
  						const appBundleDir = join(appDataFolder, "app");
@@ -254,7 +409,7 @@ index 39daf6d341780af8e30c2c50327162863f5977ec..65677cd1d642ef832cf4f90a315d3ffc
  
  						// Ensure launcher binary is executable
  						const launcherPath = join(appBundleDir, "bin", "launcher");
-@@ -1071,14 +1129,18 @@ del "%~f0"
+@@ -1071,14 +1175,18 @@ del "%~f0"
  					// current process has exited first. The detached shell survives our
  					// exit and polls until the process is gone.
  					const pid = process.pid;
@@ -275,7 +430,7 @@ index 39daf6d341780af8e30c2c50327162863f5977ec..65677cd1d642ef832cf4f90a315d3ffc
  							detached: true,
  							stdio: ["ignore", "ignore", "ignore"],
  						} as any,
-@@ -1087,7 +1149,8 @@ del "%~f0"
+@@ -1087,7 +1195,8 @@ del "%~f0"
  					// On Linux, launch the launcher binary inside the app directory
  					const launcherPath = join(runningAppBundlePath, "bin", "launcher");
  					// eslint-disable-next-line @typescript-eslint/no-explicit-any

package/src/api-client/app-attention.ts

@@ -1,3 +1,4 @@
+import type { CompanyFrom } from "../types/company-from"
 type AppStore = "app-store" | "google-play"
 export type AppChart = "free" | "paid" | "grossing" | "unranked"
 
@@ -97,6 +98,8 @@ interface AppSourceState {
 export interface AppAttentionPayload {
   generatedAt: string
   requestedSymbol?: string
+  /** The company's home line the data is read from, when not the listing asked (a receipt, a foreign line). */
+  companyFrom?: CompanyFrom
   page?: { offset: number; limit: number; total: number; nextOffset: number | null }
   symbol: string | null
   access: "pro" | "preview"

package/src/api-client/beneficial-owners.ts

@@ -1,3 +1,4 @@
+import type { CompanyFrom } from "../types/company-from";
 /**
  * Schedule 13D and 13G beneficial ownership reports about one issuer, as
  * `GET /cloud/sec/beneficial-owners` returns them. Percentages are percent
@@ -71,6 +72,8 @@ export interface BeneficialOwnersCoverage {
 
 export interface BeneficialOwnersPayload {
   ticker: string;
+  /** The company's home line the owners are read from, when not the listing asked (a foreign line). */
+  companyFrom?: CompanyFrom;
   cik: string;
   companyName: string;
   /** When the server assembled the list, an ISO time. */

package/src/api-client/company-kpis.ts

@@ -1,3 +1,4 @@
+import type { CompanyFrom } from "../types/company-from"
 import { listingAbroad, type IssuerListingParams } from "./paths";
 
 type QuoteMatchMode = "exact" | "whitespace" | "nfkc_whitespace";
@@ -132,6 +133,8 @@ export interface KpiSeries {
 }
 export interface KpisPayload {
   symbol: string
+  /** The company's home line the data is read from, when not the listing asked (a receipt, a foreign line). */
+  companyFrom?: CompanyFrom
   status: "available" | "unavailable"
   asOf: string | null
   coverage: KpiCoverage

package/src/api-client/cot.ts

@@ -1,5 +1,9 @@
-export type CotFamily = "legacy" | "disaggregated"
+/** The CFTC report: Legacy, Disaggregated, or Traders in Financial Futures (TFF). */
+export type CotFamily = "legacy" | "disaggregated" | "tff"
 export type CotClass = "noncommercial" | "commercial" | "producer" | "swap" | "managed-money" | "other-reportable" | "nonreportable"
+  | "dealer" | "asset-manager" | "leveraged-funds"
+/** Futures positions alone, or futures and options combined (options delta-adjusted, as the CFTC reports them). */
+export type CotPositions = "futures-only" | "combined"
 interface CotPosition { long: number | null; short: number | null; spreading: number | null }
 interface CotPercentile {
   value: number | null
@@ -34,7 +38,7 @@ interface CotMarket {
 }
 export interface CotPayloadBase {
   source: "CFTC"
-  scope: "futures-only"
+  scope: CotPositions
   reportFamily: CotFamily
   generatedAt: string
   /** Tuesday position observation date, distinct from publication/download time. */

package/src/api-client/credit-documents.ts

@@ -26,7 +26,10 @@ export interface CreditFact {
   status: "active" | "superseded" | "pending";
   supersedesId: string | null;
 }
+/** The party an instrument, covenant or wall bucket is of, when the filing names one other than the issuer. */
+export interface CreditObligor { name: string; role?: string | null }
 export interface CreditInstrument {
+  obligor?: CreditObligor | null;
   lifecycle?: string | null;
   id: string;
   key: string;
@@ -41,6 +44,7 @@ export interface CreditInstrument {
   history?: CreditFact[];
 }
 export interface CreditHeadroom {
+  obligor?: CreditObligor | null;
   id: string;
   instrumentId: string;
   instrumentName: string;
@@ -57,12 +61,14 @@ export interface CreditHeadroom {
   evidenceIds: string[];
 }
 export interface CreditMaturityBucket {
+  obligor?: CreditObligor | null;
   year: number;
   currency: string;
   principal: number;
   instruments: Array<{ id: string; name: string; principal: number; evidenceIds: string[] }>;
 }
 interface CreditControlExposure {
+  obligor?: CreditObligor | null;
   instrumentId: string;
   instrumentName: string;
   currency: string | null;

package/src/api-client/data.ts

@@ -7,7 +7,7 @@ import { companyDisclosurePath } from "./company-kpis";
 import { cloudExchangeAnnouncementsPath } from "./exchange-announcements";
 import type { PowerBoard, PowerDetail, PowerFilter, PowerHistory } from "./power";
 import type { PerpBoardPayload, PerpEquitiesPayload, PerpEquityListing, PerpHistoryPayload, PerpRankingsPayload, PerpBoardQuery, PerpHistoryQuery,
-  PerpMarketPayload } from "./perps";
+  PerpMarketPayload, PerpLiquidationsPayload, PerpDepthPayload } from "./perps";
 import type { ExposureRequest, ExposurePayload, ExposureScenario } from "./exposure";
 import type { SupplyChainPayload, SupplyOptions } from "./supply-chain";
 import { supplyGraphQuery, type GraphOptions, type GraphPayload } from "./supply-chain-graph";
@@ -44,7 +44,7 @@ import type { BeneficialOwnersPayload, CloudBeneficialOwnersParams } from "./ben
 import type { CloudInsiderSignalsParams, InsiderSignalsPayload } from "./insider-signals";
 import type { SocialMentionDayPosts, SocialMentionsPayload, SocialMentionsRange } from "./social-mentions";
 import type { FuturesContractTermsPayload, FuturesCurveAsOfPayload, FuturesCurvePayload } from "./futures-curve";
-import type { CotBoardPayload, CotContractPayload, CotFamily, CotClass } from "./cot";
+import type { CotBoardPayload, CotContractPayload, CotFamily, CotClass, CotPositions } from "./cot";
 import type { DoeBoardPayload, DoePricesPayload } from "./doe";
 import type { JodiBoardPayload, PsdBoardPayload } from "./commodity-balances";
 import type { CarbonBoard, CarbonHistory, EuropePowerBoard, EuropePowerHistory, GasStorageBoard, GasStorageHistory, GasStorageSeasonal } from "./europe-energy";
@@ -180,6 +180,7 @@ import type {
   CloudWorldVenueMapPayload,
   CloudYieldPointPayload,
   ScannerFlowHistoryPage,
+  ScannerFlowSession,
 } from "./types";
 import type { CloudApiRequest } from "./request";
 
@@ -594,12 +595,15 @@ export class CloudDataApi {
     return this.request<CloudShillerPayload>(cloudShillerPath());
   }
 
-  async getCloudCotBoard(report: CotFamily, traderClass: CotClass): Promise<CotBoardPayload> {
-    return this.request<CotBoardPayload>(`/cloud/cot/board?${new URLSearchParams({ report, traderClass })}`);
+  /** Futures-only positions unless `positions` asks for futures and options combined; the default request is unchanged. */
+  async getCloudCotBoard(report: CotFamily, traderClass: CotClass, positions: CotPositions = "futures-only"): Promise<CotBoardPayload> {
+    const query = new URLSearchParams({ report, traderClass, ...(positions === "combined" ? { scope: positions } : {}) });
+    return this.request<CotBoardPayload>(`/cloud/cot/board?${query}`);
   }
 
-  async getCloudCotContract(code: string, report: CotFamily): Promise<CotContractPayload> {
-    return this.request<CotContractPayload>(`/cloud/cot/contracts/${encodeURIComponent(code)}?${new URLSearchParams({ report })}`);
+  async getCloudCotContract(code: string, report: CotFamily, positions: CotPositions = "futures-only"): Promise<CotContractPayload> {
+    const query = new URLSearchParams({ report, ...(positions === "combined" ? { scope: positions } : {}) });
+    return this.request<CotContractPayload>(`/cloud/cot/contracts/${encodeURIComponent(code)}?${query}`);
   }
 
   /** Geo layers (the map's layers, entities and series); one prefix-scoped method, like EQS. */
@@ -692,6 +696,8 @@ export class CloudDataApi {
   }
   async getCloudPerpsRankings(): Promise<PerpRankingsPayload> { return this.request("/cloud/perps/rankings"); }
   async getCloudPerpsCompare(baseAsset: string): Promise<PerpBoardPayload> { return this.request(`/cloud/perps/compare?${new URLSearchParams({ baseAsset })}`); }
+  async getCloudPerpsLiquidations(baseAsset: string): Promise<PerpLiquidationsPayload> { return this.request(`/cloud/perps/liquidations?${new URLSearchParams({ baseAsset })}`); }
+  async getCloudPerpsDepth(baseAsset: string): Promise<PerpDepthPayload> { return this.request(`/cloud/perps/depth?${new URLSearchParams({ baseAsset })}`); }
   async getCloudPerpsEquity(symbol: string, exchange?: string): Promise<PerpBoardPayload> {
     const query = exchange === undefined ? "" : `?${new URLSearchParams({ identity: "listing", exchange })}`;
     return this.request(`/cloud/perps/equity/${encodeURIComponent(symbol)}${query}`);
@@ -916,6 +922,11 @@ export class CloudDataApi {
     return this.request<ScannerFlowHistoryPage>(`/market/scanner/flow/history?${search}`, { signal });
   }
 
+  /** The latest session's recorded FLOW prints summed by side, by time and by strike (Pro); the plugin builds `search`. */
+  getScannerFlowSession(search: string, signal?: AbortSignal) {
+    return this.request<ScannerFlowSession>(`/market/scanner/flow/session?${search}`, { signal });
+  }
+
   getMobileAlertHistory<T>(offset = 0) {
     return this.request<T>(`/mobile/alerts/history?offset=${offset}`);
   }
@@ -1273,8 +1284,9 @@ export class CloudDataApi {
     query: string,
     limit?: number,
     topics?: readonly string[],
+    options: { closest?: boolean; tickers?: readonly string[] } = {},
   ): Promise<CloudNewsListResponse> {
-    return this.request<CloudNewsListResponse>(cloudNewsSearchPath(query, limit, topics));
+    return this.request<CloudNewsListResponse>(cloudNewsSearchPath(query, limit, topics, options));
   }
 
   async getCloudNewsStory(storyId: string): Promise<CloudNewsPayload> {

package/src/api-client/equity-screener.ts

@@ -2,6 +2,27 @@
 export const KPI_FIELDS = ["kpiArr", "kpiNrrPercent", "kpiRpo", "kpiCrpo", "kpiSubscribers", "kpiDau", "kpiMau", "kpiGmv", "kpiTakeRatePercent", "kpiSameStoreSalesPercent", "kpiStores", "kpiBacklog", "kpiBookToBill", "kpiNimPercent", "kpiCet1Percent", "kpiCombinedRatioPercent", "kpiOccupancyPercent", "kpiLoadFactorPercent", "guideRevenueChangePercent", "guideEpsChangePercent"] as const;
 /** Payout ratio and dividend growth; listed only when asked (`include=dividends`), and omitted by a server from before them. */
 export const DIVIDEND_FIELDS = ["payoutRatioPercent", "dividendGrowth1YPercent", "dividendGrowth3YPercent"] as const;
+/**
+ * Technical readings of the stored daily bars at the last completed session; listed only when asked
+ * (`include=technical`), and omitted by a server from before them.
+ */
+export const TECHNICAL_FIELDS = [
+  "rsi14",
+  "priceVsSma20Percent", "priceVsSma50Percent", "priceVsSma200Percent",
+  "macdBullishCrossDays", "macdBearishCrossDays", "goldenCrossDays", "deathCrossDays",
+  "newHigh20dDays", "newLow20dDays", "newHigh52wDays", "newLow52wDays",
+  "bollingerWidthPercentile",
+] as const;
+/**
+ * IV30, its 52-week percentile and its moves in volatility points, and 20-session realized volatility with its
+ * 52-week rank; listed only when asked (`include=option-volatility`), and omitted by a server from before them.
+ */
+export const OPTION_VOLATILITY_FIELDS = ["iv30Percent", "ivPercentile", "iv30Change1d", "iv30Change5d", "hv20Percent", "hvRank"] as const;
+/**
+ * Shares outstanding, float, short % of float and 13F institutional ownership, each with the day it describes;
+ * listed only when asked (`include=ownership`), and omitted by a server from before them.
+ */
+export const OWNERSHIP_FIELDS = ["sharesOutstanding", "floatShares", "shortPercentOfFloat", "institutionalOwnershipPercent"] as const;
 export const NUMERIC_FIELDS = [
   ...KPI_FIELDS,
   "price",
@@ -42,6 +63,7 @@ export const NUMERIC_FIELDS = [
   "fromHigh52WPercent",
   "beta",
   "atrPercent",
+  ...TECHNICAL_FIELDS,
   "priceToBook",
   "evToEbitda",
   "roePercent",
@@ -49,6 +71,8 @@ export const NUMERIC_FIELDS = [
   "analystUpsidePercent",
   "ivRank",
   "ivToHv",
+  ...OPTION_VOLATILITY_FIELDS,
+  ...OWNERSHIP_FIELDS,
   "hiringOpenRoles", "hiringNetAddsWeek", "hiringRemotePercent", "hiringZScore",
   "appAttentionScore", "appRankVelocity7d", "appRatingDrift7d", "appRatingCountGrowth7d",
 ] as const;

package/src/api-client/fund-facts.ts

@@ -6,7 +6,15 @@ interface FundFact<T> {
   url?: string;
 }
 
-type FundStructure = "registered" | "trust";
+/**
+ * `registered`: a 1940 Act fund (an ETF or UIT). `trust`: an exchange-traded
+ * trust or pool outside the 1940 Act. `closed-end`: a registered closed-end
+ * fund (ECC, OXLC, PDI), found filing N-CEN, N-CSR, N-PORT or N-2. `bdc`: a
+ * business development company (ARCC, MAIN), found filing N-2 or its N-54A
+ * election beside its 10-Q and 10-K. Either's shares trade at their own
+ * premium or discount to NAV. Servers before them say null.
+ */
+export type FundStructure = "registered" | "trust" | "closed-end" | "bdc";
 type ExpenseRatioKind = "net" | "gross" | "sponsor-fee";
 /**
  * A bond fund as its sponsor classes it: `municipal` when its interest is
@@ -67,6 +75,22 @@ export interface FundMetalHoldings {
   stale: boolean;
 }
 
+/**
+ * The 1M change in an ETF's shares outstanding (creations less redemptions),
+ * from the sponsor's count on `from` to its count on `asOf`. `value` puts a
+ * dollar figure on it, each day's change at that day's NAV; null when a day
+ * in between had none.
+ */
+export interface FundFlows {
+  period: "1M";
+  shares: number;
+  value: number | null;
+  from: string;
+  asOf: string;
+  source: string;
+  url?: string;
+}
+
 /**
  * `not-collected-yet`: a source Gloom reads covers the fund, but it has no
  * figures yet. `not-published`: no source Gloom reads covers it. Servers
@@ -86,10 +110,23 @@ export interface FundFactsPayload {
   structure: FundStructure | null;
   /** `document`: read from the fund's prospectus filed with the SEC on `asOf`, not from its sponsor. */
   expenseRatio: (FundFact<number> & { kind: ExpenseRatioKind; document?: "prospectus" }) | null;
-  nav: FundFact<number> | null;
+  /**
+   * `period`: a `day`'s NAV, or a `month-end`'s (a closed-end fund's monthly
+   * estimate, or the NAV per share its filing states), which is its normal
+   * cadence rather than a lag. `estimate`: the range the sponsor published,
+   * whose midpoint `value` is. Servers before them leave both out.
+   */
+  nav: (FundFact<number> & { period?: "day" | "month-end"; estimate?: { low: number; high: number } }) | null;
+  /** Why a covered fund has no NAV, in one line. Absent when it has one, and from servers before it. */
+  navReason?: string;
+  /** Dated by its own session: a month end on a weekend is priced at the Friday before it. */
   closingPrice: FundFact<number> | null;
-  /** `published` by the sponsor, or `computed` from the closing price against the NAV. */
-  premiumDiscount: (FundFact<number> & { basis: "published" | "computed" }) | null;
+  /**
+   * `published` by the sponsor, or `computed` from the closing price against
+   * the NAV, dated by the NAV. `estimate`: computed against the midpoint of a
+   * NAV estimate, so an estimate too; absent from servers before it.
+   */
+  premiumDiscount: (FundFact<number> & { basis: "published" | "computed"; estimate?: true }) | null;
   /**
    * `period`: a `day`'s figure, or the last `month-end`'s (Vanguard and ARK
    * ETFs, N-PORT), which is not today's. `document`: the fund's N-PORT report
@@ -105,6 +142,10 @@ export interface FundFactsPayload {
   bond?: FundBondFacts | null;
   /** A metal trust's metal in trust; absent for any other fund, until its first read, and from servers before it. */
   metalHoldings?: FundMetalHoldings | null;
+  /** Shares outstanding as the sponsor's file states them, dated. Servers before it leave it out. */
+  sharesOutstanding?: FundFact<number> | null;
+  /** The 1M change in shares outstanding; null until a month of counts is kept. Servers before it leave it out. */
+  flows?: FundFlows | null;
   /** The newest NAV is older than a few US trading days: every figure is older than it looks. */
   stale: boolean;
   fetchedAt: string | null;

package/src/api-client/hiring.ts

@@ -1,3 +1,4 @@
+import type { CompanyFrom } from "../types/company-from"
 /** HIRING is an observed requisition series, not headcount or job creation. */
 interface HiringCompany {
   entityId: string
@@ -76,6 +77,8 @@ export interface HiringSummary extends HiringCompany {
 export interface HiringPayload extends HiringSummary {
   generatedAt: string
   requestedSymbol?: string
+  /** The company's home line the data is read from, when not the listing asked (a receipt, a foreign line). */
+  companyFrom?: CompanyFrom
   proRequired: true
   preview: boolean
   locked: { history: number; evidence: number; peers: number; signals: number; mix: number }

package/src/api-client/index.ts

@@ -24,6 +24,7 @@ import { CloudApiRequestTransport, putWithRevision } from "./request";
 import { CloudApiSocket } from "./socket";
 import { CloudCollectionsApi } from "./collections";
 import { CloudFeedbackApi } from "./feedback";
+import { CloudRoadmapApi } from "./roadmap";
 import { CloudNotesApi } from "./notes";
 import { CloudTeamsApi } from "./teams";
 import { CloudTelemetryApi } from "./telemetry";
@@ -154,6 +155,7 @@ class GloomApiClient {
   private readonly data: CloudDataApi = new CloudDataApi((path, options) => this.request(path, options));
   private readonly notes: CloudNotesApi = new CloudNotesApi((path, options) => this.request(path, options));
   private readonly feedback: CloudFeedbackApi = new CloudFeedbackApi((path, options) => this.request(path, options));
+  private readonly roadmap: CloudRoadmapApi = new CloudRoadmapApi((path, options) => this.request(path, options));
   private readonly telemetry: CloudTelemetryApi = new CloudTelemetryApi((path, options) => this.request(path, options));
   private readonly theses: CloudThesesApi = new CloudThesesApi((path, options) => this.request(path, options));
   private readonly collections: CloudCollectionsApi = new CloudCollectionsApi((path, options) => this.request(path, options));
@@ -225,6 +227,14 @@ class GloomApiClient {
     return !!this.transport.getSessionToken() || !!this.currentUser;
   }
 
+  /**
+   * Whether a request sent now carries a session: the token this client
+   * holds, or, in the browser, the cookie it cannot see and assumes is there.
+   */
+  hasSessionCredential(): boolean {
+    return this.transport.hasSessionCredential();
+  }
+
   /** Notifies when the user or credential changes, including plan and trial entitlement. */
   subscribeCurrentUser(listener: () => void): () => void {
     this.currentUserListeners.add(listener);
@@ -866,6 +876,8 @@ class GloomApiClient {
   putCloudNote = this.notes.putNote.bind(this.notes);
   submitFeedback = this.feedback.submitFeedback.bind(this.feedback);
   listFeedback = this.feedback.listFeedback.bind(this.feedback);
+  getRoadmap = this.roadmap.getRoadmap.bind(this.roadmap);
+  setRoadmapVote = this.roadmap.setRoadmapVote.bind(this.roadmap);
   reportCrashErrors = this.telemetry.reportCrashErrors.bind(this.telemetry);
   reportUsageCounts = this.telemetry.reportUsageCounts.bind(this.telemetry);
   reportAttentionCounts = this.telemetry.reportAttentionCounts.bind(this.telemetry);
@@ -946,6 +958,7 @@ class GloomApiClient {
   getCloudCentralBankRates = this.data.getCloudCentralBankRates.bind(this.data);
   getMobileAlertHistory = this.data.getMobileAlertHistory.bind(this.data);
   getScannerFlowHistory = this.data.getScannerFlowHistory.bind(this.data);
+  getScannerFlowSession = this.data.getScannerFlowSession.bind(this.data);
   getLiveScan = this.data.getLiveScan.bind(this.data);
   getCloudEstimateRevisions = this.data.getCloudEstimateRevisions.bind(this.data);
   getCloudMoneyMarkets = this.data.getCloudMoneyMarkets.bind(this.data);
@@ -1004,6 +1017,8 @@ class GloomApiClient {
   getCloudPerpsHistory = this.data.getCloudPerpsHistory.bind(this.data);
   getCloudPerpsRankings = this.data.getCloudPerpsRankings.bind(this.data);
   getCloudPerpsCompare = this.data.getCloudPerpsCompare.bind(this.data);
+  getCloudPerpsLiquidations = this.data.getCloudPerpsLiquidations.bind(this.data);
+  getCloudPerpsDepth = this.data.getCloudPerpsDepth.bind(this.data);
   getCloudPerpsEquity = this.data.getCloudPerpsEquity.bind(this.data);
   getCloudPerpsEquities = this.data.getCloudPerpsEquities.bind(this.data);
   getCloudPerpsMarket = this.data.getCloudPerpsMarket.bind(this.data);