sentisense 0.59.0 → 0.60.0

package/README.md

@@ -477,11 +477,16 @@ client.entityMetrics.getMetrics("AAPL", {
   maxDataPoints: 100,
 })
 
-// Distribution by source
-client.entityMetrics.getDistribution("AAPL", "sentiment")
+// Share of mentions by source (valueType "SHARE_PERCENT")
+client.entityMetrics.getDistribution("AAPL", "mentions")
 client.entityMetrics.getDistribution("AAPL", "mentions", { dimension: "source" })
+
+// Mean sentiment by source, in [-1, 1] (valueType "MEAN")
+client.entityMetrics.getDistribution("AAPL", "sentiment")
 ```
 
+In a distribution, `valueType` says what each number is. For a count metric such as `mentions` or `creators` it is `"SHARE_PERCENT"`: each value is that source's percentage share of the total, summing to about 100. For `sentiment` it is `"MEAN"`: each value is that source's mean polarity over the window, in [-1, 1], the same numbers as `GET /api/v2/metrics/entity/{symbol}/metric/sentiment/mean-by/source` in the [API reference](https://sentisense.ai/docs/api/metrics/). `sentisense_score` has no per-source split and answers with an empty distribution.
+
 Available metric types: `mentions`, `sentiment`, `sentisense_score`, `sentisense_rating`, `social_dominance`, `creators`. `sentisense` is an alias for `sentisense_score`; either spelling returns the same series, and keys are case-insensitive. Responses always name the canonical type, so a `sentisense` request answers with `SENTISENSE_SCORE`. `sentisense_rating` is the SentiSense Rating score and is a time series only: it has no source breakdown, so `getDistribution` answers with an empty distribution for it.
 
 ### Options
@@ -529,6 +534,7 @@ All five are optional: a response served before they shipped omits them. For the
 
 ```typescript
 client.marketMood.get()             // Composite market sentiment with sub-signals
+client.marketMood.get({ days: 30 }) // Same, with 30 days of history (default 180)
 client.kb.getPopularEntities()      // Most-tracked entities
 client.kb.searchEntities("Tesla")   // Resolve a name, alias, ticker or slug to what we track
 ```

package/dist/cli.cjs

@@ -1331,7 +1331,7 @@ var flowsCommand = {
 };
 
 // src/version.ts
-var VERSION = "0.59.0";
+var VERSION = "0.60.0";
 
 // src/resources/analyst.ts
 var Analyst = class {
@@ -1694,10 +1694,16 @@ var EntityMetrics = class {
     );
   }
   /**
-   * Get distribution data for a metric, broken down by a dimension (default: source).
+   * Get a metric broken down by dimension (default dimension: source).
+   *
+   * `valueType` on the response says what each number in `distribution` is. For a count metric
+   * such as `"mentions"` it is `"SHARE_PERCENT"`: each source's percentage share of the total,
+   * summing to about 100. For `"sentiment"` it is `"MEAN"`: each source's mean polarity over the
+   * window, in [-1, 1]. `"sentisense_score"` has no per-source split and answers with an empty
+   * distribution.
    *
    * @param symbol     Ticker symbol (e.g. "AAPL") or entity urlSlug.
-   * @param metricType The metric to break down (e.g. "mentions", "sentiment").
+   * @param metricType The metric to break down (e.g. "mentions" or "sentiment").
    * @param options    Optional dimension parameter.
    */
   async getDistribution(symbol, metricType, options = {}) {
@@ -2088,12 +2094,13 @@ var MarketMoodResource = class {
   constructor(client) {
     this.client = client;
   }
-  /** Get market mood data (scores, history, sectors). */
-  async get() {
-    return this.client.get("/api/v2/market-mood");
+  async get(options) {
+    const days = options?.days;
+    return this.client.get(
+      "/api/v2/market-mood",
+      days === void 0 ? void 0 : { days }
+    );
   }
-  // TODO: accept a `days` param to control history length (the endpoint supports ?days=N).
-  //
   // 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`

package/dist/index.cjs

@@ -443,10 +443,16 @@ var EntityMetrics = class {
     );
   }
   /**
-   * Get distribution data for a metric, broken down by a dimension (default: source).
+   * Get a metric broken down by dimension (default dimension: source).
+   *
+   * `valueType` on the response says what each number in `distribution` is. For a count metric
+   * such as `"mentions"` it is `"SHARE_PERCENT"`: each source's percentage share of the total,
+   * summing to about 100. For `"sentiment"` it is `"MEAN"`: each source's mean polarity over the
+   * window, in [-1, 1]. `"sentisense_score"` has no per-source split and answers with an empty
+   * distribution.
    *
    * @param symbol     Ticker symbol (e.g. "AAPL") or entity urlSlug.
-   * @param metricType The metric to break down (e.g. "mentions", "sentiment").
+   * @param metricType The metric to break down (e.g. "mentions" or "sentiment").
    * @param options    Optional dimension parameter.
    */
   async getDistribution(symbol, metricType, options = {}) {
@@ -837,12 +843,13 @@ var MarketMoodResource = class {
   constructor(client) {
     this.client = client;
   }
-  /** Get market mood data (scores, history, sectors). */
-  async get() {
-    return this.client.get("/api/v2/market-mood");
+  async get(options) {
+    const days = options?.days;
+    return this.client.get(
+      "/api/v2/market-mood",
+      days === void 0 ? void 0 : { days }
+    );
   }
-  // TODO: accept a `days` param to control history length (the endpoint supports ?days=N).
-  //
   // 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`
@@ -1346,7 +1353,7 @@ var Trackers = class {
 };
 
 // src/version.ts
-var VERSION = "0.59.0";
+var VERSION = "0.60.0";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://app.sentisense.ai";