sentisense 0.52.0 → 0.53.0

package/README.md

@@ -241,6 +241,27 @@ client.documents.getStories({ limit: 10 })
 client.documents.getStoryDetail("cluster_abc123")
 ```
 
+A story's `cluster` says where it came from and whether it has settled. `storySource` is
+`"ORIGINAL"` for an editorially authored SentiSense Original and `"AI"` for a
+pipeline-generated story, and `isLive` is true while the story is still being revised as
+the event develops. Both are optional: against an API build that predates them they are
+`undefined`, which means "not known" rather than `"AI"` or `false`.
+
+`getStoryDetail` returns `unknown`, so narrow it yourself. It carries the same two fields
+plus a `timeline` array of dated updates, newest first and empty when a story has none.
+The `StoryTimelineEntry` type is exported for that array:
+
+```typescript
+import type { StoryTimelineEntry } from "sentisense";
+
+const detail = (await client.documents.getStoryDetail("cluster_abc123")) as {
+  timeline: StoryTimelineEntry[];
+};
+for (const update of detail.timeline) {
+  console.log(new Date(update.publishedAt), update.updateType, update.content);
+}
+```
+
 ### Institutional flows (13F)
 
 ```typescript

package/dist/cli.cjs

@@ -1324,7 +1324,7 @@ var flowsCommand = {
 };
 
 // src/version.ts
-var VERSION = "0.52.0";
+var VERSION = "0.53.0";
 
 // src/resources/analyst.ts
 var Analyst = class {
@@ -1507,7 +1507,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)}`);
   }

package/dist/index.cjs

@@ -255,7 +255,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)}`);
   }
@@ -1242,7 +1249,7 @@ var Trackers = class {
 };
 
 // src/version.ts
-var VERSION = "0.52.0";
+var VERSION = "0.53.0";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://app.sentisense.ai";