sentisense 0.51.0 → 0.53.0

package/dist/index.d.mts

@@ -892,6 +892,37 @@ interface StoryCluster {
     averageSentiment: number;
     /** Unix timestamp in seconds when the cluster was assembled by our pipeline. */
     clusteredAt: number;
+    /**
+     * How the story was authored: `"ORIGINAL"` for an editorially authored SentiSense
+     * Original, `"AI"` for a pipeline-generated story. Optional because an older API
+     * build omits it, in which case it is `undefined` rather than `"AI"`.
+     */
+    storySource?: "ORIGINAL" | "AI";
+    /**
+     * True while the story is still being revised as the event develops. Optional
+     * because an older API build omits it, in which case it is `undefined` rather than
+     * `false`: read that as "not known", not as "settled".
+     */
+    isLive?: boolean;
+}
+/**
+ * One dated update on a live story, as served inside the story detail response's
+ * `timeline` array (newest first, empty when a story has none).
+ *
+ * `documents.getStoryDetail()` returns `unknown`, so this type is exported for callers
+ * that narrow the response themselves.
+ */
+interface StoryTimelineEntry {
+    /** Publication time of this update, Unix milliseconds. */
+    publishedAt: number;
+    /**
+     * `"INITIAL"`, `"UPDATE"` or `"CORRECTION"`. Left open: an unrecognised label is
+     * served through rather than rejected, so branch on the three known values and let
+     * anything else fall through to a neutral rendering.
+     */
+    updateType: "INITIAL" | "UPDATE" | "CORRECTION" | (string & {});
+    /** The update text, markdown. */
+    content: string;
 }
 interface Story {
     cluster: StoryCluster;
@@ -2607,7 +2638,14 @@ declare class Documents {
     getBySource(source: DocumentSource, options?: GetBySourceOptions): Promise<DocumentSearchResponse>;
     /** Get AI-curated news story clusters. */
     getStories(options?: GetStoriesOptions): Promise<Story[]>;
-    /** Get full story detail by cluster ID. */
+    /**
+     * Get full story detail by cluster ID.
+     *
+     * Deliberately untyped: narrow it yourself. The response carries `storySource` and
+     * `isLive` alongside the story body, plus a `timeline` array of dated updates,
+     * newest first and empty when the story has none. {@link StoryTimelineEntry} is
+     * exported for that array.
+     */
     getStoryDetail(clusterId: string): Promise<unknown>;
     /** Get stories for a specific stock. */
     getStoriesByTicker(ticker: string, options?: GetStoriesByTickerOptions): Promise<Story[]>;
@@ -3085,11 +3123,48 @@ declare class Institutional {
     getInstitutionDetail(slugOrCik: string): Promise<unknown>;
 }
 
+/** Public entity types the search `type` filter accepts, and that come back on a hit. */
+type EntitySearchType = "person" | "company" | "product" | "organization" | "etf" | "topic" | "country";
+/**
+ * One ranked match from {@link KB.searchEntities}.
+ *
+ * `urlSlug` is the handle the metric endpoints address an entity by, which is the reason
+ * this endpoint exists: it answers "what is the handle for the thing I typed".
+ */
+interface EntitySearchResult {
+    name: string;
+    /** Stable handle for this entity, or `null` when it has none. */
+    urlSlug: string | null;
+    /** `"person"`, `"company"`, `"product"`, `"organization"`, `"etf"`, `"topic"`, `"country"`. */
+    type: EntitySearchType | string | null;
+    /** The listed symbol for a tradeable entity, `null` for everything else. */
+    ticker: string | null;
+}
+interface SearchEntitiesOptions {
+    /** Narrow to one entity type. An unrecognised value is rejected with a 400. */
+    type?: EntitySearchType | string;
+    /** Matches to return, 1 to 25. Omitted, the API applies its own default of 10. */
+    limit?: number;
+}
 declare class KB {
     private client;
     constructor(client: APIClient);
     /** Get popular entities for search suggestions. */
     getPopularEntities(): Promise<KBEntity[]>;
+    /**
+     * Resolve a name, alias, ticker or slug to the entities we track, best match first.
+     *
+     * This is resolution, not enumeration: the query must be at least 2 characters and the
+     * result count is capped, so it answers "which handle did the user mean" rather than
+     * dumping the graph. Use it when someone typed "Tesla" and the rest of your code needs
+     * `TSLA`, or when you need the `urlSlug` an entity's metric series is addressed by.
+     *
+     * Returns a bare array, not a `PreviewResponse` envelope, and an empty array is the
+     * normal answer for a query that matches nothing.
+     *
+     * @param q What the user typed. At least 2 characters, or the API answers 400.
+     */
+    searchEntities(q: string, options?: SearchEntitiesOptions): Promise<EntitySearchResult[]>;
 }
 
 declare class MarketMoodResource {
@@ -3602,6 +3677,6 @@ declare class APIError extends SentiSenseError {
     constructor(message: string, status: number, code?: string);
 }
 
-declare const VERSION = "0.51.0";
+declare const VERSION = "0.53.0";
 
-export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystConsensus, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, 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 EarningsKpiHighlight, type EarningsQuarter, type EarningsSource, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystCallsOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRecentEarningsOptions, 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 OptionsAggregate, type OptionsContext, type OptionsHistory, type OptionsHistoryWindow, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, 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 AnalystCall, type AnalystConsensus, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, 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 EarningsKpiHighlight, type EarningsQuarter, type EarningsSource, type EntitySearchResult, type EntitySearchType, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystCallsOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRecentEarningsOptions, 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 OptionsAggregate, type OptionsContext, type OptionsHistory, type OptionsHistoryWindow, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, type SearchEntitiesOptions, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, type Story, type StoryCluster, type StoryTimelineEntry, 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

@@ -892,6 +892,37 @@ interface StoryCluster {
     averageSentiment: number;
     /** Unix timestamp in seconds when the cluster was assembled by our pipeline. */
     clusteredAt: number;
+    /**
+     * How the story was authored: `"ORIGINAL"` for an editorially authored SentiSense
+     * Original, `"AI"` for a pipeline-generated story. Optional because an older API
+     * build omits it, in which case it is `undefined` rather than `"AI"`.
+     */
+    storySource?: "ORIGINAL" | "AI";
+    /**
+     * True while the story is still being revised as the event develops. Optional
+     * because an older API build omits it, in which case it is `undefined` rather than
+     * `false`: read that as "not known", not as "settled".
+     */
+    isLive?: boolean;
+}
+/**
+ * One dated update on a live story, as served inside the story detail response's
+ * `timeline` array (newest first, empty when a story has none).
+ *
+ * `documents.getStoryDetail()` returns `unknown`, so this type is exported for callers
+ * that narrow the response themselves.
+ */
+interface StoryTimelineEntry {
+    /** Publication time of this update, Unix milliseconds. */
+    publishedAt: number;
+    /**
+     * `"INITIAL"`, `"UPDATE"` or `"CORRECTION"`. Left open: an unrecognised label is
+     * served through rather than rejected, so branch on the three known values and let
+     * anything else fall through to a neutral rendering.
+     */
+    updateType: "INITIAL" | "UPDATE" | "CORRECTION" | (string & {});
+    /** The update text, markdown. */
+    content: string;
 }
 interface Story {
     cluster: StoryCluster;
@@ -2607,7 +2638,14 @@ declare class Documents {
     getBySource(source: DocumentSource, options?: GetBySourceOptions): Promise<DocumentSearchResponse>;
     /** Get AI-curated news story clusters. */
     getStories(options?: GetStoriesOptions): Promise<Story[]>;
-    /** Get full story detail by cluster ID. */
+    /**
+     * Get full story detail by cluster ID.
+     *
+     * Deliberately untyped: narrow it yourself. The response carries `storySource` and
+     * `isLive` alongside the story body, plus a `timeline` array of dated updates,
+     * newest first and empty when the story has none. {@link StoryTimelineEntry} is
+     * exported for that array.
+     */
     getStoryDetail(clusterId: string): Promise<unknown>;
     /** Get stories for a specific stock. */
     getStoriesByTicker(ticker: string, options?: GetStoriesByTickerOptions): Promise<Story[]>;
@@ -3085,11 +3123,48 @@ declare class Institutional {
     getInstitutionDetail(slugOrCik: string): Promise<unknown>;
 }
 
+/** Public entity types the search `type` filter accepts, and that come back on a hit. */
+type EntitySearchType = "person" | "company" | "product" | "organization" | "etf" | "topic" | "country";
+/**
+ * One ranked match from {@link KB.searchEntities}.
+ *
+ * `urlSlug` is the handle the metric endpoints address an entity by, which is the reason
+ * this endpoint exists: it answers "what is the handle for the thing I typed".
+ */
+interface EntitySearchResult {
+    name: string;
+    /** Stable handle for this entity, or `null` when it has none. */
+    urlSlug: string | null;
+    /** `"person"`, `"company"`, `"product"`, `"organization"`, `"etf"`, `"topic"`, `"country"`. */
+    type: EntitySearchType | string | null;
+    /** The listed symbol for a tradeable entity, `null` for everything else. */
+    ticker: string | null;
+}
+interface SearchEntitiesOptions {
+    /** Narrow to one entity type. An unrecognised value is rejected with a 400. */
+    type?: EntitySearchType | string;
+    /** Matches to return, 1 to 25. Omitted, the API applies its own default of 10. */
+    limit?: number;
+}
 declare class KB {
     private client;
     constructor(client: APIClient);
     /** Get popular entities for search suggestions. */
     getPopularEntities(): Promise<KBEntity[]>;
+    /**
+     * Resolve a name, alias, ticker or slug to the entities we track, best match first.
+     *
+     * This is resolution, not enumeration: the query must be at least 2 characters and the
+     * result count is capped, so it answers "which handle did the user mean" rather than
+     * dumping the graph. Use it when someone typed "Tesla" and the rest of your code needs
+     * `TSLA`, or when you need the `urlSlug` an entity's metric series is addressed by.
+     *
+     * Returns a bare array, not a `PreviewResponse` envelope, and an empty array is the
+     * normal answer for a query that matches nothing.
+     *
+     * @param q What the user typed. At least 2 characters, or the API answers 400.
+     */
+    searchEntities(q: string, options?: SearchEntitiesOptions): Promise<EntitySearchResult[]>;
 }
 
 declare class MarketMoodResource {
@@ -3602,6 +3677,6 @@ declare class APIError extends SentiSenseError {
     constructor(message: string, status: number, code?: string);
 }
 
-declare const VERSION = "0.51.0";
+declare const VERSION = "0.53.0";
 
-export { type AISummary, APIError, type AnalystAction, type AnalystCall, type AnalystConsensus, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, 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 EarningsKpiHighlight, type EarningsQuarter, type EarningsSource, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystCallsOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRecentEarningsOptions, 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 OptionsAggregate, type OptionsContext, type OptionsHistory, type OptionsHistoryWindow, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, 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 AnalystCall, type AnalystConsensus, type AnalystCoverage, type AnalystCoverageAnalyst, type AnalystCoverageBookEntry, type AnalystCoverageFirm, type AnalystEarningsSurprise, type AnalystEstimate, type AnalystEstimatesResponse, type AnalystFirmRating, type AnalystFirmTenure, type AnalystNote, type AnalystProfile, type AnalystRatingBuckets, 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 EarningsKpiHighlight, type EarningsQuarter, type EarningsSource, type EntitySearchResult, type EntitySearchType, type EtfAggregateCoverage, type EtfAnalystAggregate, type EtfAnalystContributor, type EtfHolding, type EtfHoldings, type EtfInfo, type EtfInsiderAggregate, type EtfInsiderContributor, type EtfScreenerExecuteResponse, type EtfScreenerRow, type EtfSentimentAggregate, type EtfSentimentReading, type FeaturedScreen, type FloatInfo, type Fundamentals, type FundamentalsPeriod, type FundamentalsPeriodsResponse, type GetAnalystActionsOptions, type GetAnalystCallsOptions, type GetAnalystCoverageOptions, type GetAnalystMarketActivityOptions, type GetEarningsCalendarOptions, type GetEarningsSummariesOptions, type GetEtfInsiderAggregateOptions, type GetHoldersOptions, type GetInsiderOptions, type GetInsightsOptions, type GetLatestInsightsOptions, type GetOptionsHistoryOptions, type GetPoliticianActivityOptions, type GetPoliticianDirectoryOptions, type GetPoliticianMemberOptions, type GetPoliticiansOptions, type GetRecentEarningsOptions, 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 OptionsAggregate, type OptionsContext, type OptionsHistory, type OptionsHistoryWindow, type OptionsOiWalls, type OptionsOverview, type OptionsOverviewRow, type OptionsSummary, type OptionsUnusualContract, type OptionsWall, type PoliticianDetail, type PoliticianDirectory, type PoliticianDirectoryEntry, type PoliticianDirectoryResponse, type PoliticianSummary, type PreviewResponse, type Quarter, RateLimitError, type RatingBase, type RatingDimension, type RatingDimensionKey, type RatingFlag, type RatingNotRatedReason, type RatingSubLeg, type RecentEarningsEntry, type RiskAdjustment, type RiskCondition, type ScreenerExecuteOptions, type ScreenerExecuteResponse, type ScreenerFieldCatalog, type ScreenerFieldDescriptor, type ScreenerFieldOption, type ScreenerFilter, type ScreenerPlan, type ScreenerRow, type ScreenerScreensResponse, type ScreenerSort, type SearchEntitiesOptions, SentiSense, SentiSenseError, type SentiSenseOptions, type SentimentEntry, type ServingMetric, type ShortInterest, type ShortVolume, type SimilarStock, type StockDetail, type StockEntity, type StockImage, type StockNotRated, type StockPrice, type StockProfile, type StockQuote, type StockRating, type StockRatingResponse, type StockSocialDominance, type Story, type StoryCluster, type StoryTimelineEntry, 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

@@ -221,7 +221,14 @@ var Documents = class {
   async getStories(options) {
     return this.client.get("/api/v1/documents/stories", options);
   }
-  /** Get full story detail by cluster ID. */
+  /**
+   * Get full story detail by cluster ID.
+   *
+   * Deliberately untyped: narrow it yourself. The response carries `storySource` and
+   * `isLive` alongside the story body, plus a `timeline` array of dated updates,
+   * newest first and empty when the story has none. {@link StoryTimelineEntry} is
+   * exported for that array.
+   */
   async getStoryDetail(clusterId) {
     return this.client.get(`/api/v1/documents/stories/${encodeURIComponent(clusterId)}`);
   }
@@ -676,6 +683,22 @@ var KB = class {
   async getPopularEntities() {
     return this.client.get("/api/v1/kb/entities/popular");
   }
+  /**
+   * Resolve a name, alias, ticker or slug to the entities we track, best match first.
+   *
+   * This is resolution, not enumeration: the query must be at least 2 characters and the
+   * result count is capped, so it answers "which handle did the user mean" rather than
+   * dumping the graph. Use it when someone typed "Tesla" and the rest of your code needs
+   * `TSLA`, or when you need the `urlSlug` an entity's metric series is addressed by.
+   *
+   * Returns a bare array, not a `PreviewResponse` envelope, and an empty array is the
+   * normal answer for a query that matches nothing.
+   *
+   * @param q What the user typed. At least 2 characters, or the API answers 400.
+   */
+  async searchEntities(q, options) {
+    return this.client.get("/api/v1/kb/entities/search", { q, ...options });
+  }
 };
 
 // src/resources/marketMood.ts
@@ -1192,7 +1215,7 @@ var Trackers = class {
 };
 
 // src/version.ts
-var VERSION = "0.51.0";
+var VERSION = "0.53.0";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://app.sentisense.ai";