@cstar.help/js 0.9.0 → 0.10.1

package/dist/library/index.d.cts

@@ -0,0 +1,135 @@
+/** Configuration for the LibraryClient. */
+interface LibraryConfig {
+    /** Team slug (e.g., 'acme'). Identifies the knowledge base to query. */
+    teamSlug: string;
+    /** Override the base URL (defaults to https://www.cstar.help). */
+    baseUrl?: string;
+}
+/** A published article in the public knowledge base. */
+interface LibraryArticle {
+    id: string;
+    team_id: string;
+    title: string;
+    slug: string;
+    excerpt: string;
+    content: string;
+    category: string;
+    tags: string[];
+    view_count: number;
+    published_at: string;
+    created_at: string;
+    updated_at: string;
+    meta_description?: string;
+}
+/** A category in the knowledge base. */
+interface Category {
+    id: string;
+    team_id: string;
+    name: string;
+    slug: string;
+    description?: string;
+    icon?: string;
+    color?: string;
+    sort_order: number;
+    is_public: boolean;
+    article_count: number;
+}
+/** Parameters for listing articles. */
+interface LibraryArticleListParams {
+    categorySlug?: string;
+    limit?: number;
+    offset?: number;
+}
+/** Parameters for searching articles. */
+interface LibrarySearchParams {
+    limit?: number;
+}
+/** Search results. */
+interface LibrarySearchResult {
+    data: LibraryArticle[];
+    count: number;
+    query: string;
+}
+/** Aggregate stats for a public knowledge base. */
+interface LibraryStats {
+    totalArticles: number;
+    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.
+ *
+ * ```typescript
+ * const library = new LibraryClient({ teamSlug: 'acme' });
+ * const categories = await library.categories();
+ * const results = await library.search('reset password');
+ * ```
+ */
+declare class LibraryClient {
+    private readonly baseUrl;
+    private readonly teamSlug;
+    private resolvedTeamId;
+    constructor(config: LibraryConfig);
+    /** List all public categories with article counts. */
+    categories(): Promise<Category[]>;
+    /** List published articles, optionally filtered by category. */
+    articles(params?: LibraryArticleListParams): Promise<LibraryArticle[]>;
+    /** Get a single article by slug. */
+    article(slug: string): Promise<LibraryArticle>;
+    /**
+     * Full-text search across article titles, excerpts, and content.
+     * Returns matching articles with relevance ranking.
+     */
+    search(query: string, params?: LibrarySearchParams): Promise<LibrarySearchResult>;
+    /**
+     * Record a view for an article. Call this from the client when an article
+     * page is displayed to track view counts accurately.
+     *
+     * ```typescript
+     * // On article page mount
+     * await library.recordView('getting-started');
+     * ```
+     */
+    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). */
+    stats(): Promise<LibraryStats>;
+    private fetch;
+}
+
+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

@@ -0,0 +1,135 @@
+/** Configuration for the LibraryClient. */
+interface LibraryConfig {
+    /** Team slug (e.g., 'acme'). Identifies the knowledge base to query. */
+    teamSlug: string;
+    /** Override the base URL (defaults to https://www.cstar.help). */
+    baseUrl?: string;
+}
+/** A published article in the public knowledge base. */
+interface LibraryArticle {
+    id: string;
+    team_id: string;
+    title: string;
+    slug: string;
+    excerpt: string;
+    content: string;
+    category: string;
+    tags: string[];
+    view_count: number;
+    published_at: string;
+    created_at: string;
+    updated_at: string;
+    meta_description?: string;
+}
+/** A category in the knowledge base. */
+interface Category {
+    id: string;
+    team_id: string;
+    name: string;
+    slug: string;
+    description?: string;
+    icon?: string;
+    color?: string;
+    sort_order: number;
+    is_public: boolean;
+    article_count: number;
+}
+/** Parameters for listing articles. */
+interface LibraryArticleListParams {
+    categorySlug?: string;
+    limit?: number;
+    offset?: number;
+}
+/** Parameters for searching articles. */
+interface LibrarySearchParams {
+    limit?: number;
+}
+/** Search results. */
+interface LibrarySearchResult {
+    data: LibraryArticle[];
+    count: number;
+    query: string;
+}
+/** Aggregate stats for a public knowledge base. */
+interface LibraryStats {
+    totalArticles: number;
+    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.
+ *
+ * ```typescript
+ * const library = new LibraryClient({ teamSlug: 'acme' });
+ * const categories = await library.categories();
+ * const results = await library.search('reset password');
+ * ```
+ */
+declare class LibraryClient {
+    private readonly baseUrl;
+    private readonly teamSlug;
+    private resolvedTeamId;
+    constructor(config: LibraryConfig);
+    /** List all public categories with article counts. */
+    categories(): Promise<Category[]>;
+    /** List published articles, optionally filtered by category. */
+    articles(params?: LibraryArticleListParams): Promise<LibraryArticle[]>;
+    /** Get a single article by slug. */
+    article(slug: string): Promise<LibraryArticle>;
+    /**
+     * Full-text search across article titles, excerpts, and content.
+     * Returns matching articles with relevance ranking.
+     */
+    search(query: string, params?: LibrarySearchParams): Promise<LibrarySearchResult>;
+    /**
+     * Record a view for an article. Call this from the client when an article
+     * page is displayed to track view counts accurately.
+     *
+     * ```typescript
+     * // On article page mount
+     * await library.recordView('getting-started');
+     * ```
+     */
+    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). */
+    stats(): Promise<LibraryStats>;
+    private fetch;
+}
+
+export { type ArticleFeedbackParams, type ArticleFeedbackResult, type Category, type LibraryArticle, type LibraryArticleListParams, LibraryClient, type LibraryConfig, type LibrarySearchParams, type LibrarySearchResult, type LibraryStats };