gloomberb 0.15.2 → 0.15.4

package/src/api-client/market-movers.ts

@@ -0,0 +1,60 @@
+/**
+ * Pre-market, after-hours and gap lists for MOST, served by the market
+ * screener route beside gainers, losers and most active. Methodology:
+ * docs/quote-board-data.md.
+ */
+
+export type CloudSessionMoversCategory = "premarket" | "afterhours" | "gaps";
+
+/** Up and down moves, or the most shares traded; gaps have no active list. */
+export type CloudSessionMoversSide = "up" | "down" | "active";
+
+/** What is trading in New York when the list was built. */
+export type CloudSessionPhase = "pre" | "regular" | "post" | "closed";
+
+/** A trading halt, an 8-K, or a news story in the list's own window (see docs/quote-board-data.md). */
+export type CloudSessionCatalyst = "halt" | "filing" | "news";
+
+export interface CloudSessionMoverItem {
+  rank: number;
+  symbol: string;
+  name: string;
+  exchange: string;
+  currency: string;
+  /** Latest price in the list's session. */
+  price: number;
+  change: number;
+  changePercent: number;
+  /** What the change is measured from: the prior regular close, or the day's official close after hours. */
+  referenceClose: number;
+  /** Shares traded in the session: pre-market, after hours, or the day so far for gaps. */
+  volume: number;
+  /** Volume so far against the average by the same time of day. */
+  relativeVolume: number | null;
+  /** Open against the prior close; before the open, the last pre-market price. */
+  gapPercent: number | null;
+  open: number | null;
+  /** Regular-session VWAP. */
+  vwap: number | null;
+  vwapPercent: number | null;
+  floatShares: number | null;
+  catalysts: CloudSessionCatalyst[];
+  lastUpdated: number;
+}
+
+export interface CloudSessionMoversPayload {
+  view: CloudSessionMoversCategory;
+  side: CloudSessionMoversSide;
+  /** Trading date of the list; before the pre-market opens it is the previous session's. */
+  session: string | null;
+  phase: CloudSessionPhase;
+  asOf: string;
+  stale?: boolean;
+  items: CloudSessionMoverItem[];
+}
+
+const SESSION_CATEGORIES = new Set<string>(["premarket", "afterhours", "gaps"]);
+
+export function isSessionMoversCategory(category: string): category is CloudSessionMoversCategory {
+  return SESSION_CATEGORIES.has(category);
+}

package/src/api-client/mna.ts

@@ -0,0 +1,118 @@
+/**
+ * Mergers and acquisitions read from news, press releases and SEC filings.
+ * A deal is one target and one buyer; a target with competing bidders has a
+ * deal per bidder.
+ */
+
+/** Reported talks, a signed or launched deal, or its end. */
+export type MnaStatus = "talks" | "pending" | "completed" | "terminated";
+
+export type MnaConsideration = "cash" | "stock" | "mixed" | "undisclosed";
+
+export interface MnaParty {
+  name: string;
+  /** Listing symbol, suffixed outside the US (`RXL.PA`); null for a private company. */
+  symbol: string | null;
+  /** ISO 3166 alpha-2 country of the company's head office, when known. */
+  country: string | null;
+}
+
+export interface MnaTerms {
+  consideration: MnaConsideration;
+  /** Cash per target share, in `currency`. */
+  cashPerShare: number | null;
+  /** Acquirer shares per target share. */
+  exchangeRatio: number | null;
+  /** The listing the exchange ratio pays in, usually the acquirer's. */
+  ratioSymbol: string | null;
+  currency: string | null;
+  /** A contingent value right rides on top of the per-share terms. */
+  cvr: boolean;
+  /** The offer is for part of the shares, so the spread applies to a prorated slice. */
+  partial: boolean;
+}
+
+export interface MnaDeal {
+  id: string;
+  target: MnaParty;
+  /** Null while a sale is reported without a named buyer. */
+  acquirer: MnaParty | null;
+  status: MnaStatus;
+  /** Where a pending deal stands, e.g. "Tender offer", "Shareholder vote". */
+  stage: string | null;
+  hostile: boolean;
+  terms: MnaTerms;
+  /** Headline transaction value in `valueCurrency`. */
+  value: number | null;
+  valueCurrency: string | null;
+  /** The same value in US dollars, for sorting and the size filter. */
+  valueUsd: number | null;
+  /** Day the deal or the talks were first reported. */
+  announced: string;
+  /** Expected close as the parties state it, e.g. "2026-12-31" or "Q1 2027". */
+  expectedClose: string | null;
+  closed: string | null;
+  /** One line on the latest development. */
+  headline: string;
+  updatedAt: string;
+  /** The last day a story or filing reported on the deal. */
+  lastReported: string;
+  /** A pending private deal with no news for six months; nothing will report it closing. */
+  stale: boolean;
+}
+
+export type MnaStatusFilter = MnaStatus | "all";
+export type MnaTargetFilter = "all" | "public" | "private";
+export type MnaRegionFilter = "all" | "us" | "intl";
+
+export interface MnaDealsParams {
+  status?: MnaStatusFilter;
+  target?: MnaTargetFilter;
+  region?: MnaRegionFilter;
+  /** Deals where this symbol is the target or the buyer. */
+  symbol?: string;
+  query?: string;
+  offset?: number;
+  limit?: number;
+}
+
+export interface MnaDealsPayload {
+  deals: MnaDeal[];
+  hasMore: boolean;
+  nextOffset: number;
+  /** "delayed" hides deals first reported within `delayDays` from a free account. */
+  access: "full" | "delayed";
+  delayDays: number;
+  /** Deals the delay hides from this list. */
+  lockedDeals: number;
+  asOf: string;
+}
+
+export type MnaEventKind =
+  | "talks"
+  | "announced"
+  | "amended"
+  | "filing"
+  | "tender"
+  | "vote"
+  | "regulatory"
+  | "completed"
+  | "terminated"
+  | "update";
+
+export interface MnaDealEvent {
+  id: string;
+  /** Calendar day of the event. */
+  date: string;
+  kind: MnaEventKind;
+  title: string;
+  /** SEC form or the publisher of the story. */
+  source: string;
+  url: string | null;
+}
+
+export interface MnaDealPayload {
+  deal: MnaDeal;
+  events: MnaDealEvent[];
+  access: "full" | "delayed";
+}

package/src/api-client/normalizers.ts

@@ -31,13 +31,6 @@ export function normalizeSavedSearchResponse(
   return search;
 }
 
-export function normalizeSavedSearchHits(response: unknown): CloudSearchHit[] {
-  const hits = (response as { hits?: unknown } | null)?.hits;
-  return Array.isArray(hits)
-    ? (hits as CloudSearchHit[]).map(normalizeSearchHit)
-    : [];
-}
-
 /**
  * A wire story or filing need not name an issuer, and the server sends `ticker:
  * null` when it does not. Coerced to an empty string at the boundary so the

package/src/api-client/notes.ts

@@ -1,20 +1,14 @@
-import { ApiRequestError } from "./errors";
+import { ApiRequestError, RevisionConflictError } from "./errors";
+import { putWithRevision, type CloudApiRequest } from "./request";
 import type { CloudNote, CloudNoteScope, CloudNoteSummary, NoteKind } from "./types";
 
-type CloudApiRequest = <T>(path: string, options?: RequestInit) => Promise<T>;
-
 /** A save refused because the note changed since it was loaded. */
-export class NoteConflictError extends Error {
-  constructor(
-    message: string,
-    public readonly current: CloudNote | null,
-  ) {
-    super(message);
-    this.name = "NoteConflictError";
-  }
+export class NoteConflictError extends RevisionConflictError<CloudNote> {
+  override name = "NoteConflictError";
 }
 
-function scopeQuery(scope: CloudNoteScope): string {
+/** The owner query shared by note and thesis lists. */
+export function scopeQuery(scope: { scope: string; teamId?: string }): string {
   const params = new URLSearchParams({ scope: scope.scope });
   if (scope.teamId) params.set("teamId", scope.teamId);
   return params.toString();
@@ -49,28 +43,20 @@ export class CloudNotesApi {
     content: string;
     expectedRevision?: number;
   }): Promise<CloudNote> {
-    try {
-      return await this.request<CloudNote>("/notes", {
-        method: "PUT",
-        headers: input.expectedRevision ? { "if-match": String(input.expectedRevision) } : {},
-        body: JSON.stringify({
-          scope: input.scope.scope,
-          ...(input.scope.teamId ? { teamId: input.scope.teamId } : {}),
-          kind: input.kind,
-          key: input.key,
-          ...(input.title !== undefined ? { title: input.title } : {}),
-          content: input.content,
-        }),
-      });
-    } catch (error) {
-      if (error instanceof ApiRequestError && error.status === 412) {
-        // The 412 body carries the current note, but the transport keeps only
-        // the message. One extra read gets the editor's name and content.
-        const current = await this.findNote(input.scope, input.kind, input.key).catch(() => null);
-        throw new NoteConflictError(error.message, current);
-      }
-      throw error;
-    }
+    return putWithRevision<CloudNote, CloudNote>(this.request, "/notes", {
+      scope: input.scope.scope,
+      ...(input.scope.teamId ? { teamId: input.scope.teamId } : {}),
+      kind: input.kind,
+      key: input.key,
+      ...(input.title !== undefined ? { title: input.title } : {}),
+      content: input.content,
+    }, {
+      expected: input.expectedRevision,
+      // The 412 body carries the current note, but the transport keeps only
+      // the message. One extra read gets the editor's name and content.
+      loadCurrent: () => this.findNote(input.scope, input.kind, input.key),
+      conflict: NoteConflictError,
+    });
   }
 
   async deleteNote(id: string): Promise<void> {

package/src/api-client/paths.ts

@@ -3,7 +3,7 @@ import type {
   CloudSearchSort,
   CloudTweetQueryType,
 } from "./types";
-import { normalizeSymbol, parsePublicTickerKey, publicTickerKey } from "../utils/exchanges";
+import { isUsListingExchange, normalizeSymbol, parsePublicTickerKey, publicTickerKey } from "../utils/exchanges";
 import type { HistoryRetention } from "../sources/history-retention";
 
 export type CloudHistoryParams = {
@@ -29,6 +29,12 @@ export type CloudCdsParams = {
   limit?: number;
 };
 
+export type CloudCdsHistoryParams = {
+  /** Company name; the backend matches it to one reference entity. */
+  issuer: string;
+  days?: number;
+};
+
 export type CloudCongressChamber = "all" | "house" | "senate";
 
 export type CloudCongressHouseParams = {
@@ -153,16 +159,6 @@ export function cloudOptionsChainPath(
   return appendQuery("/market/options", search);
 }
 
-export function cloudStatementsPath(
-  symbol: string,
-  exchange: string | undefined,
-  period: "annual" | "quarterly" | "both",
-): string {
-  const search = new URLSearchParams({ symbol, period });
-  if (exchange) search.set("exchange", exchange);
-  return appendQuery("/market/statements", search);
-}
-
 export function cloudHistoryPath(
   symbol: string,
   exchange: string,
@@ -214,6 +210,19 @@ export function cloudCdsPath(params: CloudCdsParams = {}): string {
   return appendQuery("/cloud/credit/cds", search);
 }
 
+export function cloudCdsHistoryPath(params: CloudCdsHistoryParams): string {
+  const search = new URLSearchParams({ issuer: params.issuer.trim() });
+  if (params.days != null) search.set("days", String(params.days));
+  return appendQuery("/cloud/credit/cds/history", search);
+}
+
+/** `/cloud/credit/cdx` or `/cloud/credit/sovr`. */
+export function cloudCreditBoardPath(board: "cdx" | "sovr", params: { days?: number } = {}): string {
+  const search = new URLSearchParams();
+  if (params.days != null) search.set("days", String(params.days));
+  return appendQuery(`/cloud/credit/${board}`, search);
+}
+
 export type CloudSecFilingsParams = {
   ticker: string;
   limit?: number;
@@ -250,13 +259,10 @@ export function cloudCongressHousePath(
   return appendQuery(`/cloud/congress/${params.chamber ?? "house"}`, search);
 }
 
-const US_ISSUER_LISTINGS = new Set(["NASDAQ", "NYSE", "AMEX", "ARCA", "BATS"]);
-
 /** Issuer endpoints accept US ticker symbols, not the pane's listing key. */
 export function normalizeIssuerResearchTicker(ticker: string): string {
   const parsed = parsePublicTickerKey(ticker);
-  return parsed.exchange && US_ISSUER_LISTINGS.has(parsed.exchange)
-    ? parsed.symbol : normalizeSymbol(ticker);
+  return isUsListingExchange(parsed.exchange) ? parsed.symbol : normalizeSymbol(ticker);
 }
 
 export function cloudJobsPath(ticker: string, name?: string | null): string {
@@ -438,10 +444,6 @@ export function cloudSavedSearchPath(id: string): string {
   return `/cloud/search/saved/${encodeURIComponent(id)}`;
 }
 
-export function cloudSavedSearchHitsPath(id: string): string {
-  return `${cloudSavedSearchPath(id)}/hits`;
-}
-
 export function cloudNewsPath(params: CloudNewsParams = {}): string {
   const search = new URLSearchParams();
   if (params.feed) search.set("feed", params.feed);

package/src/api-client/plan-access.ts

@@ -0,0 +1,27 @@
+import { useSyncExternalStore } from "react";
+import { apiClient } from "./index";
+import { resolvePlanAccess, type PlanAccess } from "./plan-rules";
+
+export * from "./plan-rules";
+
+function planAccessKey(): string {
+  const user = apiClient.getCurrentUser();
+  if (!user) return "anonymous";
+  return [
+    user.id,
+    user.emailVerified === true ? "verified" : "unverified",
+    user.plan ?? "",
+    user.effectivePlan ?? "",
+    user.trialEndsAt ?? "",
+  ].join(":");
+}
+
+/** Plan state of the signed-in cloud session, refreshed whenever the session changes. */
+export function usePlanAccess(): PlanAccess {
+  useSyncExternalStore(
+    (onChange) => apiClient.subscribeCurrentUser(onChange),
+    planAccessKey,
+    planAccessKey,
+  );
+  return resolvePlanAccess(apiClient.getCurrentUser());
+}

package/src/api-client/plan-rules.ts

@@ -0,0 +1,87 @@
+// The plan rules alone, free of React and the API client, so the provider
+// router can gate real-time routing on the same entitlement the panes show.
+
+/**
+ * Minimum shape the plan helpers need. Both `AuthUser` (from `/auth/get-session`)
+ * and `AccountProfile` (from `/account/profile`) satisfy it.
+ */
+export interface PlanAccessUser {
+  emailVerified?: boolean;
+  plan?: "free" | "pro" | null;
+  /** Server-computed entitlement: "pro" while a trial runs or a subscription is active. */
+  effectivePlan?: "free" | "pro" | null;
+  /** ISO timestamp the free Pro trial ends; null once it lapsed or never started. */
+  trialEndsAt?: string | null;
+}
+
+export interface PlanAccess {
+  signedIn: boolean;
+  /** Signed in *and* verified, i.e. account-gated cloud features will answer. */
+  emailVerified: boolean;
+  /** Real-time entitlement right now: paying subscriber or an active trial. */
+  hasProAccess: boolean;
+  /** Paying subscriber, i.e. an upgrade CTA is no longer relevant. */
+  isPayingPro: boolean;
+  isTrialActive: boolean;
+  /** Whole days remaining, rounded up; 1 on the final day, 0 when no trial runs. */
+  trialDaysLeft: number;
+  trialEndsAt: Date | null;
+}
+
+/** Delay the cloud applies to free-tier equity and options quotes. */
+export const CLOUD_QUOTE_DELAY_MINUTES = 15;
+/** Delay the cloud applies to free-tier news wire articles. */
+export const CLOUD_NEWS_DELAY_HOURS = 12;
+
+const MS_PER_DAY = 24 * 60 * 60 * 1000;
+
+export function resolveTrialEndsAt(user: PlanAccessUser | null | undefined): Date | null {
+  if (!user?.trialEndsAt) return null;
+  const endsAt = new Date(user.trialEndsAt);
+  return Number.isNaN(endsAt.getTime()) ? null : endsAt;
+}
+
+export function isTrialActive(user: PlanAccessUser | null | undefined, now = Date.now()): boolean {
+  if (user?.emailVerified !== true) return false;
+  // Card-backed trials run as plan "pro" with a trialing subscription; the server
+  // only sends `trialEndsAt` while the subscription is actually in its trial.
+  const endsAt = resolveTrialEndsAt(user);
+  return !!endsAt && endsAt.getTime() > now;
+}
+
+export function trialDaysLeft(user: PlanAccessUser | null | undefined, now = Date.now()): number {
+  const endsAt = resolveTrialEndsAt(user);
+  if (!endsAt) return 0;
+  const remainingMs = endsAt.getTime() - now;
+  if (remainingMs <= 0) return 0;
+  return Math.max(1, Math.ceil(remainingMs / MS_PER_DAY));
+}
+
+/**
+ * Whether the account is entitled to real-time cloud data. `effectivePlan` is the
+ * server's answer, but the trial clock is re-checked locally so a session captured
+ * before the trial lapsed cannot keep claiming Pro. Sessions from older servers
+ * (no `effectivePlan`) fall back to the legacy verified-and-paid check.
+ */
+export function hasProAccess(user: PlanAccessUser | null | undefined, now = Date.now()): boolean {
+  if (user?.emailVerified !== true) return false;
+  if (user.plan === "pro") return true;
+  if (isTrialActive(user, now)) return true;
+  return user.effectivePlan === "pro" && !user.trialEndsAt;
+}
+
+export function resolvePlanAccess(
+  user: PlanAccessUser | null | undefined,
+  now = Date.now(),
+): PlanAccess {
+  const trialActive = isTrialActive(user, now);
+  return {
+    signedIn: !!user,
+    emailVerified: user?.emailVerified === true,
+    hasProAccess: hasProAccess(user, now),
+    isPayingPro: user?.emailVerified === true && user.plan === "pro" && !trialActive,
+    isTrialActive: trialActive,
+    trialDaysLeft: trialActive ? trialDaysLeft(user, now) : 0,
+    trialEndsAt: resolveTrialEndsAt(user),
+  };
+}

package/src/api-client/request.ts

@@ -2,8 +2,10 @@ import { httpFetch, isHttpFetchStreaming } from "../utils/http-transport";
 import { withDeadline } from "../utils/async-deadline";
 import {
   ApiRequestError,
+  parseApiErrorCode,
   parseApiErrorMessage,
   parseRetryAfterMs,
+  type RevisionConflictError,
 } from "./errors";
 import {
   connectionHealth,
@@ -11,15 +13,12 @@ import {
   GLOOM_CLOUD_HTTP_CONNECTION_ID,
   type ConnectionHealthRegistry,
 } from "../core/connection-health";
+import { SESSION_COOKIE_NAMES } from "./session-cookie";
 
 const DEFAULT_API_URL = "https://api.gloom.sh";
 const DEFAULT_MARKET_REQUEST_TIMEOUT_MS = 10_000;
 /** Local status for "this runtime cannot stream", never returned by the server. */
 export const STREAMING_UNSUPPORTED_STATUS = 0;
-const SESSION_COOKIE_NAMES = [
-  "__Secure-gloomberb.session_token",
-  "gloomberb.session_token",
-] as const;
 
 type CloudApiResponse = Pick<Response, "ok" | "status" | "headers" | "text">;
 type CloudApiFetchTransport = (
@@ -95,6 +94,37 @@ export function getCloudApiBaseUrl(): string {
   return process.env.GLOOMBERB_API_URL ?? DEFAULT_API_URL;
 }
 
+/** How a sub-API calls the cloud: a path under the API base, resolving to the parsed body. */
+export type CloudApiRequest = <T>(path: string, options?: RequestInit) => Promise<T>;
+
+/**
+ * PUTs `body` with the expected revision as If-Match. On a 412 it reads back
+ * what the server holds now (null if that read fails too) and throws it as a
+ * `conflict`, whose revision falls back to the one after the expected one.
+ */
+export async function putWithRevision<T, Current extends { revision: number }>(
+  request: CloudApiRequest,
+  path: string,
+  body: unknown,
+  revision: {
+    expected: number | undefined;
+    loadCurrent: () => Promise<Current | null>;
+    conflict: new (message: string, current: Current | null, currentRevision: number) => RevisionConflictError<Current>;
+  },
+): Promise<T> {
+  try {
+    return await request<T>(path, {
+      method: "PUT",
+      headers: revision.expected ? { "if-match": String(revision.expected) } : {},
+      body: JSON.stringify(body),
+    });
+  } catch (error) {
+    if (!(error instanceof ApiRequestError) || error.status !== 412) throw error;
+    const current = await revision.loadCurrent().catch(() => null);
+    throw new revision.conflict(error.message, current, current?.revision ?? (revision.expected ?? 0) + 1);
+  }
+}
+
 function throwIfRequestAborted(signal: AbortSignal | null | undefined): void {
   if (!signal?.aborted) return;
   throw (
@@ -214,6 +244,7 @@ export class CloudApiRequestTransport {
             parseApiErrorMessage(text),
             response.status,
             parseRetryAfterMs(response.headers.get("Retry-After")),
+            parseApiErrorCode(text),
           );
         }
         return response;
@@ -292,6 +323,7 @@ export class CloudApiRequestTransport {
           msg,
           res.status,
           parseRetryAfterMs(res.headers.get("Retry-After")),
+          parseApiErrorCode(text),
         );
       }
 
@@ -303,6 +335,10 @@ export class CloudApiRequestTransport {
       }
       return parsed as T;
     };
+    // Crash reports, usage counts and command-search reports are background
+    // traffic: a rate-limited, timed-out or missing one must not show up as a
+    // Cloud outage in the connections pane.
+    if (path.startsWith("/telemetry/") || path === "/assist/searches") return request();
     return this.connectionHealth.track(
       GLOOM_CLOUD_HTTP_CONNECTION_ID,
       operation,

package/src/api-client/research-activity.ts

@@ -5,6 +5,8 @@ import type { DesktopDeepLinkBridge } from "../types/desktop-deeplink";
 export type ResearchActivity =
   | "workspace_opened"
   | "research_viewed"
+  // A ticker research (DES) tab someone stayed on. Keep in sync with the server's list.
+  | "research_tab_viewed"
   | "ticker_saved"
   | "pro_feature_used"
   | "upgrade_intent"
@@ -36,6 +38,8 @@ const ATTRIBUTION_WINDOW_MS = 30 * 24 * 60 * 60 * 1000;
 /** Another device's clock may run slightly ahead; a touch from a minute in the future is still fresh. */
 const CLOCK_SKEW_MS = 5 * 60 * 1000;
 const ANONYMOUS_ID = /^[a-f0-9-]{36}$/;
+/** The server accepts a tab id only in this shape. */
+const RESEARCH_TAB_ID = /^[a-z0-9][a-z0-9-]{0,39}$/;
 const CAMPAIGN_KEYS = [
   "utm_source",
   "utm_medium",
@@ -319,12 +323,13 @@ function attributionPayload(): Record<string, string> | undefined {
 export function recordResearchActivity(
   event: ResearchActivity,
   feature?: ResearchFeature,
+  tab?: string,
 ): void {
   const target = getCurrentPluginTarget();
   const user = apiClient.getCurrentUser();
   if (!user && !anonymousId) return;
   if (!user && target !== "web" && target !== "desktop") return;
-  const key = `${user?.id ?? "guest"}:${event}:${feature ?? ""}`;
+  const key = `${user?.id ?? "guest"}:${event}:${feature ?? ""}:${tab ?? ""}`;
   if (sent.has(key)) return;
   sent.add(key);
   if (event !== "workspace_opened") recordResearchActivity("workspace_opened");
@@ -336,12 +341,23 @@ export function recordResearchActivity(
       anonymousId: target === "web" || target === "desktop" ? anonymousId : undefined,
       attribution: attributionPayload(),
       feature,
+      tab,
     })
     .catch(() => {
       sent.delete(key);
     });
 }
 
+/**
+ * Counts a ticker research tab by its id, once per session like every
+ * milestone. External plugin tabs are sent only as "plugin", so the plugins
+ * someone installed stay private; so is any id the server would refuse.
+ */
+export function recordResearchTabView(tabId: string, fromExternalPlugin: boolean): void {
+  const tab = !fromExternalPlugin && RESEARCH_TAB_ID.test(tabId) ? tabId : "plugin";
+  recordResearchActivity("research_tab_viewed", undefined, tab);
+}
+
 /**
  * Ties the visitor to the account right after sign-up or sign-in. Milestones
  * are keyed by account, so the first one under the new user id carries the

package/src/api-client/revenue-breakdown.ts

@@ -0,0 +1,36 @@
+export type RevenueBreakdownView = "product" | "segment" | "region";
+
+export interface RevenueBreakdownPeriod {
+  /** Period end, rounded to the month end as the SEC data sets do. */
+  end: string;
+  fiscalYear: number;
+  fiscalQuarter: number;
+}
+
+export interface RevenueBreakdownRow {
+  key: string;
+  label: string;
+  /** Oldest to newest, aligned with `periods`. */
+  values: (number | null)[];
+  ttm: number | null;
+  /** Fraction, e.g. 0.217 for +21.7%. */
+  yoy: number | null;
+  /** Fraction of the latest quarter's total revenue. */
+  share: number | null;
+}
+
+export interface RevenueBreakdownPayload {
+  symbol: string;
+  cik: string;
+  currency: "USD";
+  view: RevenueBreakdownView;
+  views: RevenueBreakdownView[];
+  periods: RevenueBreakdownPeriod[];
+  total: (number | null)[];
+  rows: RevenueBreakdownRow[];
+  /** Date of the latest filing read for the company. */
+  filed: string | null;
+  access: "full" | "preview";
+  /** Rows withheld from a preview. */
+  lockedRows: number;
+}

package/src/api-client/session-cookie.ts

@@ -0,0 +1,6 @@
+/**
+ * The cloud session cookie, under the `__Secure-` name the API sets over HTTPS
+ * and the plain one. Kept free of imports so the web worker and the browser
+ * bundles can share it without pulling in the API client.
+ */
+export const SESSION_COOKIE_NAMES = ["__Secure-gloomberb.session_token", "gloomberb.session_token"] as const;