sentisense 0.50.0 → 0.52.0

package/dist/index.cjs

@@ -710,6 +710,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
@@ -1114,10 +1130,10 @@ var Stocks = class {
    * security. `disclaimer` carries the wording to display alongside a grade. Methodology:
    * https://sentisense.ai/methodology/#sentisense-rating
    *
-   * **A discriminated union on `rated`.** `if (rating.rated)` narrows to `letter`,
-   * `percentile`, `composite`, `ratedCount` and `methodologyVersion`; the `else` branch
-   * narrows to `reason`, `dimensionsPresent` and `presentDimensions`. Branch on the flag
-   * rather than testing a field for `undefined`.
+   * **A discriminated union on `rated`.** `if (rating.rated)` narrows to `score`,
+   * `letter`, `percentile`, `composite`, `ratedCount` and `methodologyVersion`; the
+   * `else` branch narrows to `reason`, `dimensionsPresent` and `presentDimensions`.
+   * Branch on the flag rather than testing a field for `undefined`.
    *
    * **Having no grade is a normal 200, not a 404.** ETFs and tickers outside the swept
    * universe answer with `rated` false, and the composition still arrives so a card can
@@ -1127,11 +1143,22 @@ var Stocks = class {
    *
    * `dimensions` always holds all six rows in a fixed order, including the ones with no
    * data, which arrive with `present` false and a `null` percentile. Read `present` first
-   * and never read a missing percentile as zero. `letter` is served as stored rather than
-   * derived from `percentile`, so read it instead of computing your own bucket edges.
-   *
-   * For the daily history of a stock's percentile, ask `client.entityMetrics.getMetrics`
-   * for the `sentisense_rating` metric.
+   * and never read a missing percentile as zero.
+   *
+   * **`score` and `percentile` are different numbers.** `percentile` is the rank of the
+   * blended signals against the day's rated set, and
+   * `score = percentile - sum(riskAdjustments.map((a) => a.points))`, floored at 10 when
+   * fewer than five dimensions are available and at 0 otherwise. `letter` is the band
+   * `score` falls in, at edges 90, 70, 30 and 10, while `bucketLetter` is the band the
+   * percentile alone would fall in, so a difference between the two letters is exactly
+   * what the conditions cost. `riskConditions` names the active ones, `riskAdjustments`
+   * gives the points each cost (graded, up to 12 apiece), and `penaltyPoints` is their
+   * sum. `letter` is served as stored, so read it instead of computing your own bucket
+   * edges. The five fields arrive from the next API deploy onward and are optional, so a
+   * response served before then still parses.
+   *
+   * For the daily history of a stock's score, ask `client.entityMetrics.getMetrics` for
+   * the `sentisense_rating` metric.
    */
   async getRating(ticker) {
     return this.client.get(`/api/v1/rating/${encodeURIComponent(ticker.toUpperCase())}`);
@@ -1215,7 +1242,7 @@ var Trackers = class {
 };
 
 // src/version.ts
-var VERSION = "0.50.0";
+var VERSION = "0.52.0";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://app.sentisense.ai";