@kookee/sdk 0.0.40 → 0.0.41

package/README.md

@@ -125,8 +125,11 @@ const articles = await kookee.help.list({ page: 1, limit: 10 });
 // Filter by category slug
 const categoryArticles = await kookee.help.list({ category: 'getting-started' });
 
-// Semantic search
+// Semantic search — results include a matched text snippet when available
 const results = await kookee.help.search({ query: 'how to reset password', limit: 5 });
+for (const result of results) {
+  console.log(result.title, result.matchedChunk); // matched text snippet or null
+}
 
 // Get single article
 const article = await kookee.help.getBySlug('getting-started');
@@ -392,7 +395,8 @@ interface PaginatedResponse<T> {
 
 Entry endpoints come in two flavours with **different shapes**:
 
-- **List responses** (`blog.list()`, `help.search()`, `entries.list()`, …) return `*ListItem` types — these do **not** include `contentHtml`. Use `excerptHtml` instead for previews.
+- **List responses** (`blog.list()`, `entries.list()`, …) return `*ListItem` types — these do **not** include `contentHtml`. Use `excerptHtml` instead for previews.
+- **Search responses** (`help.search()`) return `HelpSearchResult` which extends the list item with `matchedChunk: string | null` — a plain-text snippet from the best matching section of the article.
 - **Detail responses** (`blog.getBySlug()`, `help.getById()`, …) return `*Detail` types — these include `contentHtml` for full content rendering.
 
 ```typescript

package/dist/index.d.cts

@@ -360,12 +360,13 @@ type AnyEntryDetail = TypedEntryDetail | GenericEntryDetail;
 /**
  * Help search result — returned by `GET /v1/help/search`.
  *
- * The server returns the exact same shape as a help article list response,
- * so we alias it to `HelpArticleListItem`. There is no nested `category`
- * object or `matchedChunk` field on this response (SDK <= 0.0.36 lied
- * about both).
+ * Extends `HelpArticleListItem` with `matchedChunk` — a plain-text snippet
+ * from the article that best matched the search query (via embedding similarity).
+ * When the server falls back to text search, `matchedChunk` is `null`.
  */
-type HelpSearchResult = HelpArticleListItem;
+interface HelpSearchResult extends HelpArticleListItem {
+    matchedChunk: string | null;
+}
 /**
  * Translation summary returned by the translations endpoints.
  *

package/dist/index.d.ts

@@ -360,12 +360,13 @@ type AnyEntryDetail = TypedEntryDetail | GenericEntryDetail;
 /**
  * Help search result — returned by `GET /v1/help/search`.
  *
- * The server returns the exact same shape as a help article list response,
- * so we alias it to `HelpArticleListItem`. There is no nested `category`
- * object or `matchedChunk` field on this response (SDK <= 0.0.36 lied
- * about both).
+ * Extends `HelpArticleListItem` with `matchedChunk` — a plain-text snippet
+ * from the article that best matched the search query (via embedding similarity).
+ * When the server falls back to text search, `matchedChunk` is `null`.
  */
-type HelpSearchResult = HelpArticleListItem;
+interface HelpSearchResult extends HelpArticleListItem {
+    matchedChunk: string | null;
+}
 /**
  * Translation summary returned by the translations endpoints.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kookee/sdk",
-  "version": "0.0.40",
+  "version": "0.0.41",
   "description": "Official Kookee SDK - Access your blog, changelog, help center, and more",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",