@cstar.help/js 0.3.2 → 0.3.3

package/dist/library/index.cjs

@@ -89,6 +89,34 @@ var LibraryClient = class {
     const body = await response.json();
     return { viewCount: body.viewCount };
   }
+  /**
+   * Submit feedback for an article ("Was this helpful?").
+   *
+   * ```typescript
+   * // User clicked "Yes, helpful"
+   * await library.submitFeedback('getting-started', { isHelpful: true });
+   *
+   * // With optional text and fingerprint to prevent duplicates
+   * await library.submitFeedback('getting-started', {
+   *   isHelpful: false,
+   *   feedbackText: 'The code example was outdated',
+   *   userFingerprint: sessionId
+   * });
+   * ```
+   */
+  async submitFeedback(slug, params) {
+    const url = `${this.baseUrl}/api/library/${this.teamSlug}/articles/${slug}/feedback`;
+    const response = await globalThis.fetch(url, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(params)
+    });
+    const body = await response.json();
+    if (!response.ok) {
+      throw new Error(body.error ?? `Feedback submission failed: ${response.status}`);
+    }
+    return body;
+  }
   /** Get the most viewed articles, sorted by view count descending. */
   async popularArticles(limit = 5) {
     const articles = await this.articles({ limit: 50 });

package/dist/library/index.d.cts

@@ -56,6 +56,21 @@ interface LibraryStats {
     totalCategories: number;
     totalViews: number;
 }
+/** Parameters for submitting article feedback. */
+interface ArticleFeedbackParams {
+    /** Whether the article was helpful. */
+    isHelpful: boolean;
+    /** Optional text feedback from the user. */
+    feedbackText?: string;
+    /** Optional fingerprint to prevent duplicate votes (e.g., session ID or hashed IP). */
+    userFingerprint?: string;
+}
+/** Result of submitting article feedback. */
+interface ArticleFeedbackResult {
+    success: boolean;
+    message?: string;
+    error?: string;
+}
 
 /**
  * Public knowledge base client. No authentication required.
@@ -94,6 +109,22 @@ declare class LibraryClient {
     recordView(slug: string): Promise<{
         viewCount: number;
     }>;
+    /**
+     * Submit feedback for an article ("Was this helpful?").
+     *
+     * ```typescript
+     * // User clicked "Yes, helpful"
+     * await library.submitFeedback('getting-started', { isHelpful: true });
+     *
+     * // With optional text and fingerprint to prevent duplicates
+     * await library.submitFeedback('getting-started', {
+     *   isHelpful: false,
+     *   feedbackText: 'The code example was outdated',
+     *   userFingerprint: sessionId
+     * });
+     * ```
+     */
+    submitFeedback(slug: string, params: ArticleFeedbackParams): Promise<ArticleFeedbackResult>;
     /** Get the most viewed articles, sorted by view count descending. */
     popularArticles(limit?: number): Promise<LibraryArticle[]>;
     /** Get aggregate stats for this knowledge base (article count, category count, total views). */
@@ -101,4 +132,4 @@ declare class LibraryClient {
     private fetch;
 }
 
-export { type Category, type LibraryArticle, type LibraryArticleListParams, LibraryClient, type LibraryConfig, type LibrarySearchParams, type LibrarySearchResult, type LibraryStats };
+export { type ArticleFeedbackParams, type ArticleFeedbackResult, type Category, type LibraryArticle, type LibraryArticleListParams, LibraryClient, type LibraryConfig, type LibrarySearchParams, type LibrarySearchResult, type LibraryStats };

package/dist/library/index.d.ts

@@ -56,6 +56,21 @@ interface LibraryStats {
     totalCategories: number;
     totalViews: number;
 }
+/** Parameters for submitting article feedback. */
+interface ArticleFeedbackParams {
+    /** Whether the article was helpful. */
+    isHelpful: boolean;
+    /** Optional text feedback from the user. */
+    feedbackText?: string;
+    /** Optional fingerprint to prevent duplicate votes (e.g., session ID or hashed IP). */
+    userFingerprint?: string;
+}
+/** Result of submitting article feedback. */
+interface ArticleFeedbackResult {
+    success: boolean;
+    message?: string;
+    error?: string;
+}
 
 /**
  * Public knowledge base client. No authentication required.
@@ -94,6 +109,22 @@ declare class LibraryClient {
     recordView(slug: string): Promise<{
         viewCount: number;
     }>;
+    /**
+     * Submit feedback for an article ("Was this helpful?").
+     *
+     * ```typescript
+     * // User clicked "Yes, helpful"
+     * await library.submitFeedback('getting-started', { isHelpful: true });
+     *
+     * // With optional text and fingerprint to prevent duplicates
+     * await library.submitFeedback('getting-started', {
+     *   isHelpful: false,
+     *   feedbackText: 'The code example was outdated',
+     *   userFingerprint: sessionId
+     * });
+     * ```
+     */
+    submitFeedback(slug: string, params: ArticleFeedbackParams): Promise<ArticleFeedbackResult>;
     /** Get the most viewed articles, sorted by view count descending. */
     popularArticles(limit?: number): Promise<LibraryArticle[]>;
     /** Get aggregate stats for this knowledge base (article count, category count, total views). */
@@ -101,4 +132,4 @@ declare class LibraryClient {
     private fetch;
 }
 
-export { type Category, type LibraryArticle, type LibraryArticleListParams, LibraryClient, type LibraryConfig, type LibrarySearchParams, type LibrarySearchResult, type LibraryStats };
+export { type ArticleFeedbackParams, type ArticleFeedbackResult, type Category, type LibraryArticle, type LibraryArticleListParams, LibraryClient, type LibraryConfig, type LibrarySearchParams, type LibrarySearchResult, type LibraryStats };

package/dist/library/index.js

@@ -65,6 +65,34 @@ var LibraryClient = class {
     const body = await response.json();
     return { viewCount: body.viewCount };
   }
+  /**
+   * Submit feedback for an article ("Was this helpful?").
+   *
+   * ```typescript
+   * // User clicked "Yes, helpful"
+   * await library.submitFeedback('getting-started', { isHelpful: true });
+   *
+   * // With optional text and fingerprint to prevent duplicates
+   * await library.submitFeedback('getting-started', {
+   *   isHelpful: false,
+   *   feedbackText: 'The code example was outdated',
+   *   userFingerprint: sessionId
+   * });
+   * ```
+   */
+  async submitFeedback(slug, params) {
+    const url = `${this.baseUrl}/api/library/${this.teamSlug}/articles/${slug}/feedback`;
+    const response = await globalThis.fetch(url, {
+      method: "POST",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify(params)
+    });
+    const body = await response.json();
+    if (!response.ok) {
+      throw new Error(body.error ?? `Feedback submission failed: ${response.status}`);
+    }
+    return body;
+  }
   /** Get the most viewed articles, sorted by view count descending. */
   async popularArticles(limit = 5) {
     const articles = await this.articles({ limit: 50 });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cstar.help/js",
-	"version": "0.3.2",
+	"version": "0.3.3",
 	"description": "Official TypeScript SDK for the cStar customer support platform",
 	"type": "module",
 	"main": "./dist/index.cjs",