sentisense 0.34.0 → 0.35.0

package/dist/index.d.mts

@@ -308,6 +308,11 @@ interface GetProfileOptions {
 }
 interface GetAISummaryOptions {
     depth?: "basic" | "deep";
+    /**
+     * @deprecated Has no effect and is no longer sent. Reports are curated and served
+     * as published, so there is nothing for a caller to regenerate on demand. Accepted
+     * only so existing code keeps compiling; drop it from your call.
+     */
     forceRefresh?: boolean;
 }
 interface GetMetricsBreakdownOptions {
@@ -1188,6 +1193,114 @@ interface TrackerSnapshotResponse {
     totalCount?: number;
     data: TrackerSnapshot;
 }
+/** Per-index discovery row returned by `client.indexes.list()`. */
+interface IndexListing {
+    indexId: string;
+    displayName: string;
+    /** One-sentence summary, suitable for a card subtitle. */
+    description: string;
+    /** Output scale: `"SENTIMENT"` (signed, -1 to +1) or `"PERCENT_0_100"`. Set axis bounds from this, not from the id. */
+    scale: string;
+    /** Access tier: `"free"` or `"pro"`. Every index is `"free"` today; read it rather than assuming. */
+    accessTier?: string;
+    /**
+     * Richest view of this index, which is NOT always the detail route. Market
+     * Mood points at `/api/v2/market-mood`, which carries a phase band, weekly
+     * change, per-signal breakdown and per-sector map that the shared envelope
+     * cannot hold. Every advertised `indexId` still resolves on
+     * {@link Indexes.get}, so a generic client can iterate the listing without
+     * special-casing anything.
+     */
+    canonicalUrl: string;
+}
+/** Discovery envelope returned by `client.indexes.list()`. */
+interface IndexListResponse {
+    indexes: IndexListing[];
+}
+/** One entity's row in a basket index's constituent breakdown. */
+interface IndexConstituent {
+    /** Ontology entity id, resolvable via the entities API. */
+    kbEntityId: string;
+    displayName: string;
+    /** The entity's role in this basket; the role is what carries the weight. */
+    role: string;
+    /** Relative weight on this date. `0` when `staleness` is `"OUT_OF_SEGMENT"`. */
+    weight: number;
+    /** The entity's own reading. */
+    value: number | null;
+    /** Mentions behind that reading in the lookback window. */
+    mentionsCount: number | null;
+    /**
+     * `"FRESH"` (mentioned inside the lookback), `"CARRIED_FORWARD"` (last known
+     * value standing in), `"EXCLUDED"` (no usable reading, renormalized out), or
+     * `"OUT_OF_SEGMENT"` (not in the basket on this date, reported only for
+     * transparency).
+     */
+    staleness: string;
+    /**
+     * Reserved. The API currently returns `null` here on every constituent, so do
+     * not build on it. To get the same number today, compute `weight * value`
+     * over the sum of `weight` across constituents whose `staleness` is not
+     * `"EXCLUDED"`.
+     */
+    contribution: number | null;
+    /** Detail page for the entity, or `null` when there is no resolvable target. */
+    link: string | null;
+}
+/**
+ * Latest reading for one index, returned by `client.indexes.get()`.
+ *
+ * Two archetypes share this envelope, and the difference is load-bearing. A
+ * **basket** index (`fed-sentiment`, `ai-sentiment`) weight-averages tracked
+ * entities, so `constituents`, `basketSize`, `coverage` and `totalMentions`
+ * describe how the headline was built. A **composite** index (`market-mood`) is
+ * built from signals rather than entities, so those four are `null` *by
+ * construction*, not because data is missing. Branch on them; never treat
+ * `null` there as an error.
+ */
+interface IndexSnapshot {
+    indexId: string;
+    displayName: string;
+    /** Date the reading covers, `"YYYY-MM-DD"`. Bucket start for weekly indexes. */
+    asOf: string;
+    /** The headline scalar, on `scale`. */
+    value: number | null;
+    scale: string;
+    /** Constituents that actually contributed. `null` on a composite index. */
+    coverage: number | null;
+    /** Constituents in the basket on this date. `null` on a composite index. */
+    basketSize: number | null;
+    /** Mentions behind the reading. `null` on a composite index. */
+    totalMentions: number | null;
+    /** How the value was computed, and what any `null` fields mean. */
+    methodologyNote: string;
+    /** Per-entity breakdown. `null` on a composite index. */
+    constituents: IndexConstituent[] | null;
+}
+/** One point on an index's scalar series. */
+interface IndexHistoryPoint {
+    /** `"YYYY-MM-DD"`. */
+    date: string;
+    value: number | null;
+}
+/**
+ * Historical series returned by `client.indexes.history()`.
+ *
+ * Point spacing follows the index, not the calendar: a weekly index emits one
+ * point per Monday-Sunday bucket, a daily index one per day, and Market Mood
+ * trading days only. Thin or low-coverage buckets are withheld rather than
+ * published, so `history` can be shorter than `days` and can contain gaps. Plot
+ * against `date`; never assume a fixed interval, and never read a missing date
+ * as zero.
+ */
+interface IndexHistoryResponse {
+    indexId: string;
+    displayName: string;
+    scale: string;
+    /** The window you requested, echoed back. */
+    days: number;
+    history: IndexHistoryPoint[];
+}
 
 interface AnalystConsensus {
     ticker: string;
@@ -1755,7 +1868,14 @@ declare class Stocks {
     getSentiment(ticker: string): Promise<PreviewResponse<StockSentiment>>;
     /** Get related KB entities (people, products, partners). */
     getEntities(ticker: string): Promise<StockEntity[]>;
-    /** Get AI-generated stock analysis report. Requires PRO tier. */
+    /**
+     * Get AI-generated stock analysis report. Requires PRO tier.
+     *
+     * `depth: "deep"` returns the full curated report and consumes one report view on
+     * metered tiers; the default `"basic"` returns the one-paragraph summary.
+     *
+     * The deprecated `forceRefresh` option is accepted and discarded, not forwarded.
+     */
     getAISummary(ticker: string, options?: GetAISummaryOptions): Promise<AISummary>;
     /** Get sentiment/mention metrics breakdown by entity. */
     getMetricsBreakdown(ticker: string, metricType: string, options?: GetMetricsBreakdownOptions): Promise<MetricsBreakdown>;
@@ -1823,6 +1943,54 @@ declare class Stocks {
     getKpiTypes(ticker: string): Promise<KpiTypeEntry[]>;
 }
 
+/**
+ * Indexes: composite scalars tracked over time, each blending its own inputs
+ * into one number on a stated scale. Every index answers on the same envelope,
+ * so you write one renderer and get every current and future SentiSense index.
+ *
+ * Two archetypes share that envelope. A **basket** index weight-averages
+ * tracked entities and fills `constituents` / `basketSize` / `coverage` /
+ * `totalMentions`; a **composite** index is built from signals instead and
+ * returns `null` for all four by construction. See {@link IndexSnapshot}.
+ *
+ * @see IndexSnapshot
+ */
+declare class Indexes {
+    private client;
+    constructor(client: APIClient);
+    /**
+     * List every index the platform publishes: id, display name, one-line
+     * description, the scale it lives on, its access tier, and where its richest
+     * view lives.
+     *
+     * Iterate this rather than hardcoding ids. Every `indexId` it advertises
+     * resolves on {@link get} and {@link history}.
+     */
+    list(): Promise<IndexListResponse>;
+    /**
+     * Latest reading for one index.
+     *
+     * Check `constituents` for `null` before iterating: it is `null` on a
+     * composite index like `market-mood`, which has no constituents by
+     * construction. For Market Mood this is the narrowed view; the phase band,
+     * weekly change, per-signal breakdown and per-sector map live on
+     * `client.marketMood.get()`, and both report the same headline number.
+     *
+     * @param indexId slug from {@link list}, e.g. `"fed-sentiment"`.
+     */
+    get(indexId: string): Promise<IndexSnapshot>;
+    /**
+     * Historical scalar series for one index, for charting.
+     *
+     * Thin or low-coverage buckets are withheld, so the series can be shorter
+     * than `days` and can contain gaps. Plot against each point's `date`.
+     *
+     * @param indexId slug from {@link list}.
+     * @param days days of history to return. Defaults to the API's own 180.
+     */
+    history(indexId: string, days?: number): Promise<IndexHistoryResponse>;
+}
+
 /**
  * Trackers: observational data products published as a standardized
  * `TrackerSnapshot` envelope. Every tracker (institution rankings,
@@ -1877,6 +2045,7 @@ declare class SentiSense implements APIClient {
     readonly marketMood: MarketMoodResource;
     readonly marketSummary: MarketSummaryResource;
     readonly kb: KB;
+    readonly indexes: Indexes;
     readonly trackers: Trackers;
     readonly calendar: Calendar;
     constructor(options?: SentiSenseOptions);
@@ -1924,6 +2093,6 @@ declare class APIError extends SentiSenseError {
     constructor(message: string, status: number, code?: string);
 }
 
-declare const VERSION = "0.34.0";
+declare const VERSION = "0.35.0";
 
-export { type AISummary, APIError, type AnalystAction, type AnalystConsensus, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarningsCalendarResponse, type EarningsEvent, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfSentimentAggregate, type EtfSentimentReading, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetPoliticianActivityOptions, type GetPoliticiansOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type Holder, type HolderNotableChanges, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionList, type InstitutionListResponse, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type PoliticianDetail, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockPrice, type StockProfile, type StockQuote, type Story, type StoryCluster, type TickerHolders, type TrackerEvent, type TrackerGeoEntry, type TrackerHeadlineMetric, type TrackerListResponse, type TrackerListing, type TrackerMetricValue, type TrackerSignal, type TrackerSnapshot, type TrackerSnapshotResponse, type TrackerSourceRef, type TrackerTableRow, type TrackerTimeSeriesPoint, type TtmFundamentals, VERSION, type WeightedConsensus, type WeightedNetFlow, SentiSense as default };
+export { type AISummary, APIError, type AnalystAction, type AnalystConsensus, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarningsCalendarResponse, type EarningsEvent, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfSentimentAggregate, type EtfSentimentReading, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetPoliticianActivityOptions, type GetPoliticiansOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type Holder, type HolderNotableChanges, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionList, type InstitutionListResponse, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type PoliticianDetail, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockPrice, type StockProfile, type StockQuote, type Story, type StoryCluster, type TickerHolders, type TrackerEvent, type TrackerGeoEntry, type TrackerHeadlineMetric, type TrackerListResponse, type TrackerListing, type TrackerMetricValue, type TrackerSignal, type TrackerSnapshot, type TrackerSnapshotResponse, type TrackerSourceRef, type TrackerTableRow, type TrackerTimeSeriesPoint, type TtmFundamentals, VERSION, type WeightedConsensus, type WeightedNetFlow, SentiSense as default };

package/dist/index.d.ts

@@ -308,6 +308,11 @@ interface GetProfileOptions {
 }
 interface GetAISummaryOptions {
     depth?: "basic" | "deep";
+    /**
+     * @deprecated Has no effect and is no longer sent. Reports are curated and served
+     * as published, so there is nothing for a caller to regenerate on demand. Accepted
+     * only so existing code keeps compiling; drop it from your call.
+     */
     forceRefresh?: boolean;
 }
 interface GetMetricsBreakdownOptions {
@@ -1188,6 +1193,114 @@ interface TrackerSnapshotResponse {
     totalCount?: number;
     data: TrackerSnapshot;
 }
+/** Per-index discovery row returned by `client.indexes.list()`. */
+interface IndexListing {
+    indexId: string;
+    displayName: string;
+    /** One-sentence summary, suitable for a card subtitle. */
+    description: string;
+    /** Output scale: `"SENTIMENT"` (signed, -1 to +1) or `"PERCENT_0_100"`. Set axis bounds from this, not from the id. */
+    scale: string;
+    /** Access tier: `"free"` or `"pro"`. Every index is `"free"` today; read it rather than assuming. */
+    accessTier?: string;
+    /**
+     * Richest view of this index, which is NOT always the detail route. Market
+     * Mood points at `/api/v2/market-mood`, which carries a phase band, weekly
+     * change, per-signal breakdown and per-sector map that the shared envelope
+     * cannot hold. Every advertised `indexId` still resolves on
+     * {@link Indexes.get}, so a generic client can iterate the listing without
+     * special-casing anything.
+     */
+    canonicalUrl: string;
+}
+/** Discovery envelope returned by `client.indexes.list()`. */
+interface IndexListResponse {
+    indexes: IndexListing[];
+}
+/** One entity's row in a basket index's constituent breakdown. */
+interface IndexConstituent {
+    /** Ontology entity id, resolvable via the entities API. */
+    kbEntityId: string;
+    displayName: string;
+    /** The entity's role in this basket; the role is what carries the weight. */
+    role: string;
+    /** Relative weight on this date. `0` when `staleness` is `"OUT_OF_SEGMENT"`. */
+    weight: number;
+    /** The entity's own reading. */
+    value: number | null;
+    /** Mentions behind that reading in the lookback window. */
+    mentionsCount: number | null;
+    /**
+     * `"FRESH"` (mentioned inside the lookback), `"CARRIED_FORWARD"` (last known
+     * value standing in), `"EXCLUDED"` (no usable reading, renormalized out), or
+     * `"OUT_OF_SEGMENT"` (not in the basket on this date, reported only for
+     * transparency).
+     */
+    staleness: string;
+    /**
+     * Reserved. The API currently returns `null` here on every constituent, so do
+     * not build on it. To get the same number today, compute `weight * value`
+     * over the sum of `weight` across constituents whose `staleness` is not
+     * `"EXCLUDED"`.
+     */
+    contribution: number | null;
+    /** Detail page for the entity, or `null` when there is no resolvable target. */
+    link: string | null;
+}
+/**
+ * Latest reading for one index, returned by `client.indexes.get()`.
+ *
+ * Two archetypes share this envelope, and the difference is load-bearing. A
+ * **basket** index (`fed-sentiment`, `ai-sentiment`) weight-averages tracked
+ * entities, so `constituents`, `basketSize`, `coverage` and `totalMentions`
+ * describe how the headline was built. A **composite** index (`market-mood`) is
+ * built from signals rather than entities, so those four are `null` *by
+ * construction*, not because data is missing. Branch on them; never treat
+ * `null` there as an error.
+ */
+interface IndexSnapshot {
+    indexId: string;
+    displayName: string;
+    /** Date the reading covers, `"YYYY-MM-DD"`. Bucket start for weekly indexes. */
+    asOf: string;
+    /** The headline scalar, on `scale`. */
+    value: number | null;
+    scale: string;
+    /** Constituents that actually contributed. `null` on a composite index. */
+    coverage: number | null;
+    /** Constituents in the basket on this date. `null` on a composite index. */
+    basketSize: number | null;
+    /** Mentions behind the reading. `null` on a composite index. */
+    totalMentions: number | null;
+    /** How the value was computed, and what any `null` fields mean. */
+    methodologyNote: string;
+    /** Per-entity breakdown. `null` on a composite index. */
+    constituents: IndexConstituent[] | null;
+}
+/** One point on an index's scalar series. */
+interface IndexHistoryPoint {
+    /** `"YYYY-MM-DD"`. */
+    date: string;
+    value: number | null;
+}
+/**
+ * Historical series returned by `client.indexes.history()`.
+ *
+ * Point spacing follows the index, not the calendar: a weekly index emits one
+ * point per Monday-Sunday bucket, a daily index one per day, and Market Mood
+ * trading days only. Thin or low-coverage buckets are withheld rather than
+ * published, so `history` can be shorter than `days` and can contain gaps. Plot
+ * against `date`; never assume a fixed interval, and never read a missing date
+ * as zero.
+ */
+interface IndexHistoryResponse {
+    indexId: string;
+    displayName: string;
+    scale: string;
+    /** The window you requested, echoed back. */
+    days: number;
+    history: IndexHistoryPoint[];
+}
 
 interface AnalystConsensus {
     ticker: string;
@@ -1755,7 +1868,14 @@ declare class Stocks {
     getSentiment(ticker: string): Promise<PreviewResponse<StockSentiment>>;
     /** Get related KB entities (people, products, partners). */
     getEntities(ticker: string): Promise<StockEntity[]>;
-    /** Get AI-generated stock analysis report. Requires PRO tier. */
+    /**
+     * Get AI-generated stock analysis report. Requires PRO tier.
+     *
+     * `depth: "deep"` returns the full curated report and consumes one report view on
+     * metered tiers; the default `"basic"` returns the one-paragraph summary.
+     *
+     * The deprecated `forceRefresh` option is accepted and discarded, not forwarded.
+     */
     getAISummary(ticker: string, options?: GetAISummaryOptions): Promise<AISummary>;
     /** Get sentiment/mention metrics breakdown by entity. */
     getMetricsBreakdown(ticker: string, metricType: string, options?: GetMetricsBreakdownOptions): Promise<MetricsBreakdown>;
@@ -1823,6 +1943,54 @@ declare class Stocks {
     getKpiTypes(ticker: string): Promise<KpiTypeEntry[]>;
 }
 
+/**
+ * Indexes: composite scalars tracked over time, each blending its own inputs
+ * into one number on a stated scale. Every index answers on the same envelope,
+ * so you write one renderer and get every current and future SentiSense index.
+ *
+ * Two archetypes share that envelope. A **basket** index weight-averages
+ * tracked entities and fills `constituents` / `basketSize` / `coverage` /
+ * `totalMentions`; a **composite** index is built from signals instead and
+ * returns `null` for all four by construction. See {@link IndexSnapshot}.
+ *
+ * @see IndexSnapshot
+ */
+declare class Indexes {
+    private client;
+    constructor(client: APIClient);
+    /**
+     * List every index the platform publishes: id, display name, one-line
+     * description, the scale it lives on, its access tier, and where its richest
+     * view lives.
+     *
+     * Iterate this rather than hardcoding ids. Every `indexId` it advertises
+     * resolves on {@link get} and {@link history}.
+     */
+    list(): Promise<IndexListResponse>;
+    /**
+     * Latest reading for one index.
+     *
+     * Check `constituents` for `null` before iterating: it is `null` on a
+     * composite index like `market-mood`, which has no constituents by
+     * construction. For Market Mood this is the narrowed view; the phase band,
+     * weekly change, per-signal breakdown and per-sector map live on
+     * `client.marketMood.get()`, and both report the same headline number.
+     *
+     * @param indexId slug from {@link list}, e.g. `"fed-sentiment"`.
+     */
+    get(indexId: string): Promise<IndexSnapshot>;
+    /**
+     * Historical scalar series for one index, for charting.
+     *
+     * Thin or low-coverage buckets are withheld, so the series can be shorter
+     * than `days` and can contain gaps. Plot against each point's `date`.
+     *
+     * @param indexId slug from {@link list}.
+     * @param days days of history to return. Defaults to the API's own 180.
+     */
+    history(indexId: string, days?: number): Promise<IndexHistoryResponse>;
+}
+
 /**
  * Trackers: observational data products published as a standardized
  * `TrackerSnapshot` envelope. Every tracker (institution rankings,
@@ -1877,6 +2045,7 @@ declare class SentiSense implements APIClient {
     readonly marketMood: MarketMoodResource;
     readonly marketSummary: MarketSummaryResource;
     readonly kb: KB;
+    readonly indexes: Indexes;
     readonly trackers: Trackers;
     readonly calendar: Calendar;
     constructor(options?: SentiSenseOptions);
@@ -1924,6 +2093,6 @@ declare class APIError extends SentiSenseError {
     constructor(message: string, status: number, code?: string);
 }
 
-declare const VERSION = "0.34.0";
+declare const VERSION = "0.35.0";
 
-export { type AISummary, APIError, type AnalystAction, type AnalystConsensus, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarningsCalendarResponse, type EarningsEvent, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfSentimentAggregate, type EtfSentimentReading, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetPoliticianActivityOptions, type GetPoliticiansOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type Holder, type HolderNotableChanges, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionList, type InstitutionListResponse, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type PoliticianDetail, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockPrice, type StockProfile, type StockQuote, type Story, type StoryCluster, type TickerHolders, type TrackerEvent, type TrackerGeoEntry, type TrackerHeadlineMetric, type TrackerListResponse, type TrackerListing, type TrackerMetricValue, type TrackerSignal, type TrackerSnapshot, type TrackerSnapshotResponse, type TrackerSourceRef, type TrackerTableRow, type TrackerTimeSeriesPoint, type TtmFundamentals, VERSION, type WeightedConsensus, type WeightedNetFlow, SentiSense as default };
+export { type AISummary, APIError, type AnalystAction, type AnalystConsensus, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, type AssetMetadata, AuthenticationError, type CalendarMeta, type ChartData, type ChartDataPoint, type ClusterBuy, type CompanyKpisData, type CongressTrade, DeepHistoryUnavailableError, type Document, type DocumentSearchResponse, type DocumentSource, type EarningsCalendarResponse, type EarningsEvent, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfSentimentAggregate, type EtfSentimentReading, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetPoliticianActivityOptions, type GetPoliticiansOptions, type GetStockInsightsRangeOptions, type GetUserInsightsOptions, type Holder, type HolderNotableChanges, type IndexConstituent, type IndexHistoryPoint, type IndexHistoryResponse, type IndexListResponse, type IndexListing, type IndexSnapshot, type InsiderActivityResponse, type InsiderActivitySummary, type InsiderTrade, type Insight, type InsightPreviewResponse, type InstitutionList, type InstitutionListResponse, type InstitutionSummary, type InstitutionalFlow, type InstitutionalFlows, type InstitutionalFlowsResponse, type KBEntity, type KpiCoverageEntry, type KpiCoverageResponse, type KpiDataPoint, type KpiSeries, type KpiTypeEntry, type ListInstitutionsOptions, type LockedInsight, type MarketMood, type MarketStatus, type MarketSummary, type MetricDistribution, type MetricDistributionOptions, type MetricType, type MetricsBreakdown, type MetricsOptions, NotFoundError, type PoliticianDetail, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockPrice, type StockProfile, type StockQuote, type Story, type StoryCluster, type TickerHolders, type TrackerEvent, type TrackerGeoEntry, type TrackerHeadlineMetric, type TrackerListResponse, type TrackerListing, type TrackerMetricValue, type TrackerSignal, type TrackerSnapshot, type TrackerSnapshotResponse, type TrackerSourceRef, type TrackerTableRow, type TrackerTimeSeriesPoint, type TtmFundamentals, VERSION, type WeightedConsensus, type WeightedNetFlow, SentiSense as default };

package/dist/index.mjs

@@ -519,7 +519,11 @@ var MarketMoodResource = class {
     return this.client.get("/api/v2/market-mood");
   }
   // TODO: accept a `days` param to control history length (the endpoint supports ?days=N).
-  // TODO: add a sibling `indexes` resource for /api/v1/indexes/{id} (+ /history), e.g. fed-sentiment.
+  //
+  // Market Mood is also reachable through `client.indexes`, which serves it in the shared
+  // index envelope alongside fed-sentiment and ai-sentiment. Use this resource when you want
+  // the phase band, weekly change, per-signal breakdown and per-sector map; use `indexes`
+  // when you want every index to answer the same shape. Both report the same headline number.
 };
 
 // src/resources/marketSummary.ts
@@ -614,9 +618,17 @@ var Stocks = class {
   async getEntities(ticker) {
     return this.client.get(`/api/v1/stocks/${encodeURIComponent(ticker)}/entities`);
   }
-  /** Get AI-generated stock analysis report. Requires PRO tier. */
+  /**
+   * Get AI-generated stock analysis report. Requires PRO tier.
+   *
+   * `depth: "deep"` returns the full curated report and consumes one report view on
+   * metered tiers; the default `"basic"` returns the one-paragraph summary.
+   *
+   * The deprecated `forceRefresh` option is accepted and discarded, not forwarded.
+   */
   async getAISummary(ticker, options) {
-    return this.client.get(`/api/v1/stocks/${encodeURIComponent(ticker)}/ai-summary`, options);
+    const { forceRefresh: _forceRefresh, ...params } = options ?? {};
+    return this.client.get(`/api/v1/stocks/${encodeURIComponent(ticker)}/ai-summary`, params);
   }
   /** Get sentiment/mention metrics breakdown by entity. */
   async getMetricsBreakdown(ticker, metricType, options) {
@@ -721,6 +733,53 @@ var Stocks = class {
   }
 };
 
+// src/resources/indexes.ts
+var Indexes = class {
+  constructor(client) {
+    this.client = client;
+  }
+  /**
+   * List every index the platform publishes: id, display name, one-line
+   * description, the scale it lives on, its access tier, and where its richest
+   * view lives.
+   *
+   * Iterate this rather than hardcoding ids. Every `indexId` it advertises
+   * resolves on {@link get} and {@link history}.
+   */
+  async list() {
+    return this.client.get("/api/v1/indexes");
+  }
+  /**
+   * Latest reading for one index.
+   *
+   * Check `constituents` for `null` before iterating: it is `null` on a
+   * composite index like `market-mood`, which has no constituents by
+   * construction. For Market Mood this is the narrowed view; the phase band,
+   * weekly change, per-signal breakdown and per-sector map live on
+   * `client.marketMood.get()`, and both report the same headline number.
+   *
+   * @param indexId slug from {@link list}, e.g. `"fed-sentiment"`.
+   */
+  async get(indexId) {
+    return this.client.get(`/api/v1/indexes/${indexId}`);
+  }
+  /**
+   * Historical scalar series for one index, for charting.
+   *
+   * Thin or low-coverage buckets are withheld, so the series can be shorter
+   * than `days` and can contain gaps. Plot against each point's `date`.
+   *
+   * @param indexId slug from {@link list}.
+   * @param days days of history to return. Defaults to the API's own 180.
+   */
+  async history(indexId, days) {
+    return this.client.get(
+      `/api/v1/indexes/${indexId}/history`,
+      days === void 0 ? void 0 : { days }
+    );
+  }
+};
+
 // src/resources/trackers.ts
 var Trackers = class {
   constructor(client) {
@@ -751,7 +810,7 @@ var Trackers = class {
 };
 
 // src/version.ts
-var VERSION = "0.34.0";
+var VERSION = "0.35.0";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://app.sentisense.ai";
@@ -793,6 +852,7 @@ var SentiSense = class {
     this.marketMood = new MarketMoodResource(this);
     this.marketSummary = new MarketSummaryResource(this);
     this.kb = new KB(this);
+    this.indexes = new Indexes(this);
     this.trackers = new Trackers(this);
     this.calendar = new Calendar(this);
   }