sentisense 0.79.0 → 0.81.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.mjs CHANGED
@@ -999,9 +999,10 @@ var Options = class {
999
999
  * `data` is `null` before the first nightly build populates it, which is a cold-start
1000
1000
  * state rather than an error.
1001
1001
  *
1002
- * Tiering: a PRO key receives every row. A FREE key receives the top 25 stock rows plus
1003
- * all the aggregates, with `isPreview` true and the envelope's `totalCount` reporting the
1004
- * full stock board; `data.etfTotalCount` does the same for the ETF board.
1002
+ * Tiering: a PRO key receives every row. A FREE key receives the top 25 rows of each board
1003
+ * and the top 3 session highlights of each board, plus every aggregate for both boards, with
1004
+ * `isPreview` true and the envelope's `totalCount` reporting the full stock board;
1005
+ * `data.etfTotalCount` does the same for the ETF board.
1005
1006
  *
1006
1007
  * Drill into any row with `client.stocks.getOptionsSummary(ticker)` for its full dossier,
1007
1008
  * or `client.stocks.getOptionsHistory(ticker)` to chart how a reading has trended.
@@ -1364,7 +1365,9 @@ var Stocks = class {
1364
1365
  * ten calls each calendar month and a headline-only preview after that, with `isPreview`
1365
1366
  * true; calls that return a null `data` never spend that allowance. The headline preview has
1366
1367
  * no nested objects: its readings arrive flat as `data.ivRank1y`, `data.atmIv`,
1367
- * `data.expectedMove1d`, `data.pcVol`, `data.pcVolPctl1y` and `data.maxPain`.
1368
+ * `data.expectedMove1d`, `data.pcVol`, `data.pcVolPctl1y` and `data.maxPain`. On a FREE key
1369
+ * the envelope's `dossierAllowance`, when available, says how many full dossiers are left
1370
+ * this calendar month and when the count resets.
1368
1371
  */
1369
1372
  async getOptionsSummary(ticker) {
1370
1373
  return this.client.get(
@@ -1410,8 +1413,10 @@ var Stocks = class {
1410
1413
  *
1411
1414
  * **No data is an empty `series`, not a null payload.** A weekend, a holiday, a session from
1412
1415
  * before the history was kept, a ticker outside the board and an unknown symbol all answer
1413
- * with `data.series` empty. `data.missingCycles` lists cycles whose stored point could not be
1414
- * read, which are unknown rather than absent. A malformed or future `session` rejects with
1416
+ * with `data.series` empty. `data.missingCycles` lists cycles with no stored history (a cycle
1417
+ * that published no board, or one whose history was lost), where the ticker's numbers are
1418
+ * unknown rather than zero. `data.cycles` counts the session's stored cycles, so `series` can
1419
+ * be shorter. A malformed or future `session` rejects with
1415
1420
  * an `APIError` (status 400, code `invalid_session`). A 503 means the stored series could
1416
1421
  * not be read; it is retried like any other 503 and never answered with a partial series.
1417
1422
  */
@@ -1557,7 +1562,7 @@ function serializeTrackerParams(params) {
1557
1562
  }
1558
1563
 
1559
1564
  // src/version.ts
1560
- var VERSION = "0.79.0";
1565
+ var VERSION = "0.81.0";
1561
1566
 
1562
1567
  // src/client.ts
1563
1568
  var DEFAULT_BASE_URL = "https://app.sentisense.ai";