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.cjs CHANGED
@@ -1034,9 +1034,10 @@ var Options = class {
1034
1034
  * `data` is `null` before the first nightly build populates it, which is a cold-start
1035
1035
  * state rather than an error.
1036
1036
  *
1037
- * Tiering: a PRO key receives every row. A FREE key receives the top 25 stock rows plus
1038
- * all the aggregates, with `isPreview` true and the envelope's `totalCount` reporting the
1039
- * full stock board; `data.etfTotalCount` does the same for the ETF board.
1037
+ * Tiering: a PRO key receives every row. A FREE key receives the top 25 rows of each board
1038
+ * and the top 3 session highlights of each board, plus every aggregate for both boards, with
1039
+ * `isPreview` true and the envelope's `totalCount` reporting the full stock board;
1040
+ * `data.etfTotalCount` does the same for the ETF board.
1040
1041
  *
1041
1042
  * Drill into any row with `client.stocks.getOptionsSummary(ticker)` for its full dossier,
1042
1043
  * or `client.stocks.getOptionsHistory(ticker)` to chart how a reading has trended.
@@ -1399,7 +1400,9 @@ var Stocks = class {
1399
1400
  * ten calls each calendar month and a headline-only preview after that, with `isPreview`
1400
1401
  * true; calls that return a null `data` never spend that allowance. The headline preview has
1401
1402
  * no nested objects: its readings arrive flat as `data.ivRank1y`, `data.atmIv`,
1402
- * `data.expectedMove1d`, `data.pcVol`, `data.pcVolPctl1y` and `data.maxPain`.
1403
+ * `data.expectedMove1d`, `data.pcVol`, `data.pcVolPctl1y` and `data.maxPain`. On a FREE key
1404
+ * the envelope's `dossierAllowance`, when available, says how many full dossiers are left
1405
+ * this calendar month and when the count resets.
1403
1406
  */
1404
1407
  async getOptionsSummary(ticker) {
1405
1408
  return this.client.get(
@@ -1445,8 +1448,10 @@ var Stocks = class {
1445
1448
  *
1446
1449
  * **No data is an empty `series`, not a null payload.** A weekend, a holiday, a session from
1447
1450
  * before the history was kept, a ticker outside the board and an unknown symbol all answer
1448
- * with `data.series` empty. `data.missingCycles` lists cycles whose stored point could not be
1449
- * read, which are unknown rather than absent. A malformed or future `session` rejects with
1451
+ * with `data.series` empty. `data.missingCycles` lists cycles with no stored history (a cycle
1452
+ * that published no board, or one whose history was lost), where the ticker's numbers are
1453
+ * unknown rather than zero. `data.cycles` counts the session's stored cycles, so `series` can
1454
+ * be shorter. A malformed or future `session` rejects with
1450
1455
  * an `APIError` (status 400, code `invalid_session`). A 503 means the stored series could
1451
1456
  * not be read; it is retried like any other 503 and never answered with a partial series.
1452
1457
  */
@@ -1592,7 +1597,7 @@ function serializeTrackerParams(params) {
1592
1597
  }
1593
1598
 
1594
1599
  // src/version.ts
1595
- var VERSION = "0.79.0";
1600
+ var VERSION = "0.81.0";
1596
1601
 
1597
1602
  // src/client.ts
1598
1603
  var DEFAULT_BASE_URL = "https://app.sentisense.ai";