gloomberb 0.15.2 → 0.15.4

package/src/api-client/social-mentions.ts

@@ -0,0 +1,63 @@
+export type SocialMentionsRange = "1y" | "5y" | "max";
+
+export interface SocialMentionDay {
+  /** UTC day. */
+  day: string;
+  mentions: number;
+  /** False while the day is still being counted. */
+  closed: boolean;
+}
+
+export interface SocialMentionPost {
+  id: string;
+  day: string;
+  author: string;
+  text: string;
+  postedAt: string;
+  /** Null before X showed view counts (2022-12-22). */
+  views: number | null;
+  likes: number | null;
+  reposts: number | null;
+  replies: number | null;
+  url: string;
+  /** Jev bullish minus bearish probability, -1..1. */
+  stance: number | null;
+}
+
+export interface SocialMentionsPayload {
+  symbol: string;
+  range: SocialMentionsRange;
+  asOf: string;
+  x: {
+    days: SocialMentionDay[];
+    historyFrom: string | null;
+    completeThrough: string | null;
+    /** Median posts per closed day over the last 30. */
+    baseline: number | null;
+    refreshedAt: string | null;
+  };
+  /** View-weighted stance of each day's top posts. */
+  stance: Array<{ day: string; score: number; posts: number }>;
+  topPosts: SocialMentionPost[];
+  /** Daily user views of the company's English Wikipedia article; absent on older servers. */
+  wikipedia?: {
+    article: string | null;
+    days: Array<{ day: string; views: number }>;
+    /** Median views over the 30 days ending at the last stored day. */
+    baseline: number | null;
+  };
+  /** Posts and comments naming the ticker in finance subreddits, per finished UTC day; absent on older servers. */
+  reddit?: {
+    days: Array<{ day: string; mentions: number }>;
+    baseline: number | null;
+  };
+  /** Parts still filling on the server; ask again shortly. */
+  pending: Array<"history" | "posts">;
+  warnings: string[];
+}
+
+export interface SocialMentionDayPosts {
+  symbol: string;
+  day: string;
+  posts: SocialMentionPost[];
+}

package/src/api-client/teams.ts

@@ -4,7 +4,6 @@ import type {
   ChatChannel,
   TeamAccentColor,
   TeamInviteLink,
-  TeamInvitePreview,
   TeamMember,
   TeamNotification,
   TeamReceivedInvitation,
@@ -14,8 +13,7 @@ import type {
   TeamUpdatedEvent,
   TeamUsernameInvitation,
 } from "./types";
-
-type CloudApiRequest = <T>(path: string, options?: RequestInit) => Promise<T>;
+import type { CloudApiRequest } from "./request";
 type TeamNotificationListener = (notification: TeamNotification) => void;
 type CloudEventListener = (data: unknown) => void;
 
@@ -91,22 +89,6 @@ export class CloudTeamsApi {
     );
   }
 
-  async previewTeamInviteLink(token: string): Promise<TeamInvitePreview> {
-    return this.options.request<TeamInvitePreview>(
-      `/teams/join/${encodeURIComponent(token)}`,
-    );
-  }
-
-  async joinTeamThroughLink(token: string): Promise<TeamSummary> {
-    return this.options.request<TeamSummary>(
-      `/teams/join/${encodeURIComponent(token)}`,
-      {
-        method: "POST",
-        body: JSON.stringify({}),
-      },
-    );
-  }
-
   async getTeamNotifications(): Promise<TeamNotification[]> {
     const body = await this.options.request<{
       notifications: TeamNotification[];
@@ -199,13 +181,6 @@ export class CloudTeamsApi {
     });
   }
 
-  async listTeamChannels(teamId: string): Promise<ChatChannel[]> {
-    const body = await this.options.request<{ channels: ChatChannel[] }>(
-      `/teams/${encodeURIComponent(teamId)}/channels`,
-    );
-    return body.channels;
-  }
-
   async createTeamChannel(teamId: string, name: string): Promise<ChatChannel> {
     return this.options.request<ChatChannel>(
       `/teams/${encodeURIComponent(teamId)}/channels`,

package/src/api-client/telemetry.ts

@@ -0,0 +1,180 @@
+import { withDeadline } from "../utils/async-deadline";
+import type { CloudApiRequest } from "./request";
+
+/** A report is fire-and-forget; a slow uplink must not hold anything open for long. */
+const REPORT_TIMEOUT_MS = 5_000;
+
+export type CrashReportSurface = "terminal" | "desktop" | "web" | "mobile";
+export type CrashReportKind = "uncaught" | "unhandled-rejection" | "render" | "plugin";
+
+export interface CrashReportError {
+  kind: CrashReportKind;
+  type: string;
+  message: string;
+  stack?: string;
+  plugin?: string;
+  pane?: string;
+}
+
+/** Body of `POST /telemetry/errors`. The server forwards each error to error tracking. */
+export interface CrashReportsPayload {
+  installId: string;
+  surface: CrashReportSurface;
+  appVersion: string;
+  os?: string;
+  errors: CrashReportError[];
+}
+
+export type UsageCountsSurface = "terminal" | "desktop" | "web";
+
+/** One function's counts since the last batch; `fn` is its mnemonic, or `plugin`. */
+export interface FunctionUsageCount {
+  fn: string;
+  opened: number;
+  restored: number;
+}
+
+/** Body of `POST /telemetry/usage`. The server adds the plan and forwards each count to analytics. */
+export interface UsageCountsPayload {
+  installId: string;
+  surface: UsageCountsSurface;
+  appVersion: string;
+  os?: string;
+  counts: FunctionUsageCount[];
+}
+
+/** How one visit to the command bar ended. */
+export type CommandSearchOutcome = "chosen" | "dismissed";
+
+/** The row a command-bar search ended on. */
+export interface CommandSearchChoice {
+  /** The row's kind, or a tag for how it ran: `shortcut`, `assist`, `ask-gloom`. */
+  kind: string;
+  label: string;
+  /** The command text that ran, for an AI candidate or a typed shortcut. */
+  input?: string;
+  /** Position in the list on screen, from 0. */
+  rank: number;
+  category?: string;
+  /** The row was one of the AI's answers. */
+  fromAssist: boolean;
+}
+
+/** Body of `POST /assist/searches`. */
+export interface CommandSearchReport {
+  query: string;
+  /** The `/assist/command` answer for this same query, when there was one. */
+  searchId?: string;
+  outcome: CommandSearchOutcome;
+  /** Only sent with `chosen`. */
+  choice?: CommandSearchChoice;
+  appVersion?: string;
+}
+
+/** Server caps for `/assist/searches`; text is cut here so a report is never refused for length. */
+const SEARCH_QUERY_MAX_LENGTH = 200;
+const SEARCH_KIND_MAX_LENGTH = 24;
+const SEARCH_LABEL_MAX_LENGTH = 120;
+const SEARCH_CATEGORY_MAX_LENGTH = 40;
+const SEARCH_APP_VERSION_MAX_LENGTH = 32;
+const SEARCH_RANK_MAX = 200;
+
+/** One line of at most `max` characters. */
+function fitText(text: string, max: number): string {
+  return text.replace(/\s+/g, " ").trim().slice(0, max);
+}
+
+function fitCommandSearchChoice(choice: CommandSearchChoice): CommandSearchChoice {
+  const input = choice.input ? fitText(choice.input, SEARCH_QUERY_MAX_LENGTH) : "";
+  const category = choice.category ? fitText(choice.category, SEARCH_CATEGORY_MAX_LENGTH) : "";
+  const rank = Number.isFinite(choice.rank) ? Math.round(choice.rank) : 0;
+  return {
+    kind: fitText(choice.kind, SEARCH_KIND_MAX_LENGTH),
+    label: fitText(choice.label, SEARCH_LABEL_MAX_LENGTH),
+    ...(input ? { input } : {}),
+    rank: Math.min(Math.max(rank, 0), SEARCH_RANK_MAX),
+    ...(category ? { category } : {}),
+    fromAssist: choice.fromAssist,
+  };
+}
+
+/** The report as the server takes it, or null when there is no query to send. */
+function fitCommandSearchReport(report: CommandSearchReport): CommandSearchReport | null {
+  const query = fitText(report.query, SEARCH_QUERY_MAX_LENGTH);
+  if (!query) return null;
+  const appVersion = report.appVersion ? fitText(report.appVersion, SEARCH_APP_VERSION_MAX_LENGTH) : "";
+  return {
+    query,
+    ...(report.searchId ? { searchId: report.searchId } : {}),
+    outcome: report.outcome,
+    ...(report.outcome === "chosen" && report.choice ? { choice: fitCommandSearchChoice(report.choice) } : {}),
+    ...(appVersion ? { appVersion } : {}),
+  };
+}
+
+export class CloudTelemetryApi {
+  constructor(private readonly request: CloudApiRequest) {}
+
+  /**
+   * Sends a batch of app errors. The session goes along when one exists, so
+   * a signed-in report is tied to the account; a signed-out one is identified
+   * by the install id only. `keepalive` lets a browser finish the request
+   * after the page unloads.
+   */
+  reportCrashErrors(payload: CrashReportsPayload): Promise<void> {
+    const controller = new AbortController();
+    return withDeadline(
+      this.request<void>("/telemetry/errors", {
+        method: "POST",
+        body: JSON.stringify(payload),
+        keepalive: true,
+        signal: controller.signal,
+      }),
+      REPORT_TIMEOUT_MS,
+      "Crash report timed out.",
+      (error) => controller.abort(error),
+    );
+  }
+
+  /**
+   * Sends a batch of function usage counts. The server reads the plan from
+   * the session and otherwise keeps the batch anonymous: it is filed under
+   * the install id, never the account.
+   */
+  reportUsageCounts(payload: UsageCountsPayload): Promise<void> {
+    const controller = new AbortController();
+    return withDeadline(
+      this.request<void>("/telemetry/usage", {
+        method: "POST",
+        body: JSON.stringify(payload),
+        keepalive: true,
+        signal: controller.signal,
+      }),
+      REPORT_TIMEOUT_MS,
+      "Usage counts timed out.",
+      (error) => controller.abort(error),
+    );
+  }
+
+  /**
+   * Stores how a command-bar search ended. The session goes along, since the
+   * row is the account's; the caller checks it exists and that the Usage
+   * setting allows the report.
+   */
+  reportCommandSearch(report: CommandSearchReport): Promise<void> {
+    const body = fitCommandSearchReport(report);
+    if (!body) return Promise.resolve();
+    const controller = new AbortController();
+    return withDeadline(
+      this.request<void>("/assist/searches", {
+        method: "POST",
+        body: JSON.stringify(body),
+        keepalive: true,
+        signal: controller.signal,
+      }),
+      REPORT_TIMEOUT_MS,
+      "Search report timed out.",
+      (error) => controller.abort(error),
+    );
+  }
+}

package/src/api-client/theses.ts

@@ -1,26 +1,19 @@
-import { ApiRequestError } from "./errors";
+import { ApiRequestError, RevisionConflictError } from "./errors";
+import { scopeQuery } from "./notes";
+import { putWithRevision, type CloudApiRequest } from "./request";
 import type {
   CloudNoteScope,
   CloudThesis,
   ThesisDocument,
   ThesisDraft,
   ThesisPatch,
-  ThesisRevision,
   ThesisSignal,
   ThesisStatus,
 } from "./types";
 
-type CloudApiRequest = <T>(path: string, options?: RequestInit) => Promise<T>;
-
 /** A save refused because the thesis changed since it was loaded. */
-export class ThesisConflictError extends Error {
-  constructor(
-    message: string,
-    public readonly current: CloudThesis | null,
-  ) {
-    super(message);
-    this.name = "ThesisConflictError";
-  }
+export class ThesisConflictError extends RevisionConflictError<CloudThesis> {
+  override name = "ThesisConflictError";
 }
 
 /** A revision the server refused because a fired kill condition was moved without a note. */
@@ -36,12 +29,6 @@ export class ThesisGoalpostError extends Error {
 
 export type ThesisListScope = CloudNoteScope | { scope: "all" };
 
-function scopeQuery(scope: ThesisListScope): string {
-  const params = new URLSearchParams({ scope: scope.scope });
-  if ("teamId" in scope && scope.teamId) params.set("teamId", scope.teamId);
-  return params.toString();
-}
-
 function encode(id: string): string {
   return encodeURIComponent(id);
 }
@@ -94,16 +81,12 @@ export class CloudThesesApi {
    */
   async updateThesis(id: string, patch: ThesisPatch, expectedRevision?: number): Promise<CloudThesis> {
     try {
-      return await this.request<CloudThesis>(`/theses/${encode(id)}`, {
-        method: "PUT",
-        headers: expectedRevision ? { "if-match": String(expectedRevision) } : {},
-        body: JSON.stringify(patch),
+      return await putWithRevision<CloudThesis, CloudThesis>(this.request, `/theses/${encode(id)}`, patch, {
+        expected: expectedRevision,
+        loadCurrent: () => this.getThesis(id),
+        conflict: ThesisConflictError,
       });
     } catch (error) {
-      if (error instanceof ApiRequestError && error.status === 412) {
-        const current = await this.getThesis(id).catch(() => null);
-        throw new ThesisConflictError(error.message, current);
-      }
       if (error instanceof ApiRequestError && error.status === 400 && /kill condition/i.test(error.message)) {
         throw new ThesisGoalpostError(error.message, []);
       }
@@ -120,16 +103,6 @@ export class CloudThesesApi {
     }
   }
 
-  async listThesisRevisions(id: string): Promise<ThesisRevision[]> {
-    const body = await this.request<{ items: ThesisRevision[] }>(`/theses/${encode(id)}/revisions`);
-    return body.items;
-  }
-
-  async listThesisSignals(id: string): Promise<ThesisSignal[]> {
-    const body = await this.request<{ items: ThesisSignal[] }>(`/theses/${encode(id)}/signals`);
-    return body.items;
-  }
-
   createThesisSignal(id: string, input: {
     targetKind: "pillar" | "kill" | "catalyst" | "thesis";
     targetId: string | null;

package/src/api-client/types.ts

@@ -1,8 +1,6 @@
 import type {
   AnalystResearchData,
-  CompanyProfile,
   CorporateActionsData,
-  Fundamentals,
   HolderData,
   HolderRecord,
   OptionsChain,
@@ -136,6 +134,8 @@ export interface AccountProfile {
 export interface PublicPortfolioAnalytics {
   oneYearReturn?: number | null;
   spyBeta?: number | null;
+  /** "account": the broker's own returns. "holdings": estimated from today's holdings. */
+  basis?: "account" | "holdings" | null;
 }
 
 export interface BuildoutAccountResponse {
@@ -174,16 +174,21 @@ export interface BuildoutTokenResponse {
 export interface CloudPricingTier {
   /** Charged amount, in integer cents. */
   amount: number;
-  /** List price the charged amount is discounted from, in integer cents. */
-  anchorAmount: number;
+}
+
+/** `/account/cloud`, reduced to the plan fields the apps read. */
+export interface CloudAccountPlan {
+  effectivePlan?: "free" | "pro";
+  /** Whether a checkout started now comes with the free trial attached. */
+  trialAvailable?: boolean;
+  /** The last charge failed; checkout opens the unpaid invoice instead. */
+  paymentFailed?: boolean;
 }
 
 /** Public `/pricing` payload; no session required. */
 export interface CloudPricing {
   currency: "usd";
   trialDays: number;
-  /** When false the anchor amount is the price, so it is shown without a strikethrough. */
-  founding: boolean;
   monthly: CloudPricingTier;
   yearly: CloudPricingTier;
 }
@@ -196,6 +201,10 @@ export interface AssistCommandDescriptor {
   arg?: {
     placeholder?: string;
     kind: "text" | "ticker" | "ticker-list";
+    /** The command also runs with no argument at all. */
+    optional?: boolean;
+    /** Named values the argument accepts; a command may take others too (COT takes any CFTC code). */
+    options?: { value: string; label: string }[];
   };
 }
 
@@ -210,6 +219,11 @@ export interface AssistCommandCandidate {
 
 export interface AssistCommandResponse {
   candidates: AssistCommandCandidate[];
+  /**
+   * The server's record of this ask, for the command-search report to point
+   * at. Only present when the ask was sent with `log: true`.
+   */
+  searchId?: string;
 }
 
 export type AccountProfileUpdate = Partial<{
@@ -243,15 +257,6 @@ export interface CloudSyncPushResponse {
   settings: SyncSettings;
 }
 
-export interface CloudRoundupPreviewResponse {
-  subject: string;
-  text: string;
-  html: string;
-  sender: string;
-  replyTo: string;
-  recipient: string;
-}
-
 export interface CloudQuotePayload extends Omit<Quote, "change" | "changePercent"> {
   // JSON encodes the provider's unavailable numeric values as null.
   change?: number | null;
@@ -292,10 +297,6 @@ export interface CloudOptionsChainPayload extends OptionsChain {
   providerId: "gloomberb-cloud";
 }
 
-export interface CloudCompanyProfile extends CompanyProfile {}
-
-export interface CloudFundamentals extends Fundamentals {}
-
 interface CloudHolderPayload extends HolderRecord {
   providerId: "gloomberb-cloud";
   ownerType: "institution";
@@ -315,6 +316,7 @@ export interface CloudCorporateActionsPayload extends CorporateActionsData {
 }
 
 export interface CloudPricePointPayload {
+  /** @deprecated No longer read; a history's boundary is its response `coverage`. */
   historySource?: PriceHistorySource;
   date: string;
   open?: number;
@@ -420,6 +422,28 @@ export interface CloudCdsResponse {
   trades: CloudCdsTradePayload[];
 }
 
+/** One New York trade date of an issuer's on-the-run 5Y spread. */
+export interface CloudCdsHistoryPointPayload {
+  date: string;
+  /** Median of the day's prints in basis points. */
+  spreadBp: number;
+  prints: number;
+  /** Prints that reported the spread; the rest were converted from their upfront. */
+  reported: number;
+  /** The contract on the run that day, e.g. "2031-12-20". */
+  maturity: string;
+}
+
+export interface CloudCdsHistoryResponse {
+  source: string;
+  /** The matched reference entity, or null when nothing on the tape matched. */
+  issuer: string | null;
+  tenor: string;
+  currency: string | null;
+  asOf: string | null;
+  points: CloudCdsHistoryPointPayload[];
+}
+
 export interface CloudShortInterestPointPayload {
   settlementDate: string;
   sharesShort: number;
@@ -1134,7 +1158,11 @@ export interface CloudNewsPayload {
   firstSeenAt: string;
   lastSeenAt: string;
   primaryUrl: string;
+  /** Routing key of the representative item, for source filters. */
   primarySource: string;
+  /** Who published the representative item (FT, SEC, @unusual_whales). */
+  primaryPublisher?: string;
+  publishers?: string[];
   scores?: {
     importance?: number;
     urgency?: number;
@@ -1228,6 +1256,21 @@ type CloudMarketStatus =
   | "retryable_error"
   | "fatal_error";
 
+/** The dates a history source vouches for. Which boundary fields appear depends on the reason. */
+export interface CloudHistoryCoverage {
+  source: string;
+  reasonCode?: string;
+  /** First date (YYYY-MM-DD) whose share lineage the source verified. */
+  verifiedLineageStart?: string;
+  /** First bar date (YYYY-MM-DD) the source serves, such as a fund's inception. */
+  firstAllowedBarDate?: string;
+  inceptionDate?: string;
+  sourceUrl: string;
+  firstBarDate: string | null;
+  lastBarDate: string | null;
+  barCount: number;
+}
+
 export interface CloudMarketResponse<T> {
   status: CloudMarketStatus;
   data: T | null;
@@ -1240,23 +1283,8 @@ export interface CloudMarketResponse<T> {
   historyRetention?: unknown;
   /** Source-declared history semantics; validated separately from quote metadata. */
   historySession?: unknown;
-  coverage?: {
-    inceptionDate: string;
-    firstAllowedBarDate: string;
-    source: "issuer";
-    sourceUrl: string;
-    firstBarDate: string | null;
-    lastBarDate: string | null;
-    barCount: number;
-  } | {
-    source: "yahoo" | "twelvedata";
-    reasonCode: "UNVERIFIED_PREDECESSOR_LINEAGE";
-    verifiedLineageStart: "2005-07-21";
-    sourceUrl: string;
-    firstBarDate: string | null;
-    lastBarDate: string | null;
-    barCount: number;
-  };
+  /** Untrusted until the history adapter validates its boundary dates. */
+  coverage?: CloudHistoryCoverage;
   providerMeta?: {
     provider?: string;
     upstream?: string;
@@ -1553,6 +1581,8 @@ export interface TeamSummary {
   accentColor: TeamAccentColor;
   shortName: string;
   allowMemberInvites: boolean;
+  /** Seats the team can fill; a Team plan deal sets it, otherwise 25. */
+  memberLimit?: number;
   channelId: string;
   createdAt: string;
   role: TeamRole;
@@ -1577,18 +1607,6 @@ export interface TeamInviteLink {
   createdAt: string;
 }
 
-export interface TeamInvitePreview {
-  team: {
-    id: string;
-    name: string;
-    accentColor: TeamAccentColor;
-    shortName: string;
-    memberCount: number;
-  };
-  expiresAt: string;
-  viewer: { signedIn: boolean; emailVerified: boolean; role: TeamRole | null };
-}
-
 /** A Better Auth organization invitation as returned by /auth/organization/* endpoints. */
 export interface TeamUser {
   id: string;
@@ -1831,19 +1849,6 @@ export interface ThesisSignal {
   snoozedUntil: string | null;
 }
 
-export interface ThesisRevision {
-  id: string;
-  thesisId: string;
-  revision: number;
-  title: string;
-  status: ThesisStatus;
-  conviction: number;
-  document: ThesisDocument;
-  note: string | null;
-  createdBy: ThesisEditor;
-  createdAt: string;
-}
-
 export interface ThesisDraft extends ThesisDocument {
   title: string;
   horizon: string | null;