@cstar.help/js 0.3.4 → 0.5.0

package/dist/community/index.d.ts

@@ -0,0 +1,115 @@
+/** Configuration for the CommunityClient. */
+interface CommunityConfig {
+    /** Team slug (e.g., 'acme'). Identifies the community to query. */
+    teamSlug: string;
+    /** Override the base URL (defaults to https://www.cstar.help). */
+    baseUrl?: string;
+}
+/** A discussion topic/category in the community. */
+interface CommunityTopic {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    icon: string;
+    visibility: 'public' | 'members_only';
+    sort_order: number;
+}
+/** A public community post. */
+interface CommunityPost {
+    id: string;
+    title: string;
+    slug: string;
+    body: string;
+    status: 'open' | 'answered' | 'officially_answered' | 'planned' | 'not_planned' | 'completed' | 'under_review';
+    visibility: 'public' | 'members_only';
+    voteCount: number;
+    commentCount: number;
+    isPinned: boolean;
+    isFeatured: boolean;
+    isLocked: boolean;
+    commentsEnabled: boolean;
+    topicName: string;
+    topicSlug: string;
+    authorName: string;
+    authorAvatar: string;
+    authorBio: string;
+    authorPostCount: number;
+    authorCommentCount: number;
+    isTeamMember: boolean;
+    lastActivityAt: string;
+    createdAt: string;
+}
+/** A comment on a community post. */
+interface CommunityComment {
+    id: string;
+    body: string;
+    isOfficial: boolean;
+    voteScore: number;
+    parentCommentId: string | null;
+    authorName: string;
+    authorAvatar: string;
+    authorBio: string;
+    authorPostCount: number;
+    authorCommentCount: number;
+    isTeamMember: boolean;
+    createdAt: string;
+}
+/** Parameters for listing posts. */
+interface CommunityPostListParams {
+    /** Filter by topic slug. */
+    topicSlug?: string;
+    /** Filter by status. */
+    status?: string;
+    /** Sort order (default: 'recent'). */
+    sort?: 'recent' | 'votes' | 'comments';
+    /** Max results per page. */
+    limit?: number;
+    /** Pagination offset. */
+    offset?: number;
+}
+/** Search results. */
+interface CommunitySearchResult {
+    data: CommunityPost[];
+    count: number;
+    query: string;
+}
+/** A single post with its comments. */
+interface CommunityPostDetail {
+    post: CommunityPost;
+    comments: CommunityComment[];
+}
+
+/**
+ * Public community client. No authentication required.
+ *
+ * ```typescript
+ * const community = new CommunityClient({ teamSlug: 'acme' });
+ * const topics = await community.topics();
+ * const posts = await community.posts({ topicSlug: 'feedback', sort: 'votes' });
+ * const post = await community.post('my-feature-request');
+ * const results = await community.search('dark mode');
+ * ```
+ */
+declare class CommunityClient {
+    private readonly baseUrl;
+    private readonly teamSlug;
+    constructor(config: CommunityConfig);
+    /** List all public community topics. */
+    topics(): Promise<CommunityTopic[]>;
+    /** List public posts, optionally filtered by topic, status, or sort order. */
+    posts(params?: CommunityPostListParams): Promise<{
+        posts: CommunityPost[];
+        count: number;
+    }>;
+    /** Get a single post by slug, including all comments. */
+    post(slug: string): Promise<CommunityPostDetail>;
+    /**
+     * Full-text search across post titles and bodies.
+     * Returns matching posts with relevance ranking.
+     */
+    search(query: string): Promise<CommunitySearchResult>;
+    private fetch;
+}
+
+export { CommunityClient, type CommunityComment, type CommunityConfig, type CommunityPost, type CommunityPostDetail, type CommunityPostListParams, type CommunitySearchResult, type CommunityTopic };

package/dist/community/index.js

@@ -0,0 +1,69 @@
+// src/community/index.ts
+var DEFAULT_BASE_URL = "https://www.cstar.help";
+var CommunityClient = class {
+  constructor(config) {
+    this.baseUrl = (config.baseUrl ?? DEFAULT_BASE_URL).replace(/\/+$/, "");
+    this.teamSlug = config.teamSlug;
+  }
+  /** List all public community topics. */
+  async topics() {
+    const response = await this.fetch(
+      `/api/community/${this.teamSlug}/topics`
+    );
+    return response.data;
+  }
+  /** List public posts, optionally filtered by topic, status, or sort order. */
+  async posts(params) {
+    const query = {};
+    if (params?.topicSlug) query.topicSlug = params.topicSlug;
+    if (params?.status) query.status = params.status;
+    if (params?.sort) query.sort = params.sort;
+    if (params?.limit) query.limit = String(params.limit);
+    if (params?.offset) query.offset = String(params.offset);
+    const response = await this.fetch(
+      `/api/community/${this.teamSlug}/posts`,
+      query
+    );
+    return { posts: response.data, count: response.count };
+  }
+  /** Get a single post by slug, including all comments. */
+  async post(slug) {
+    const response = await this.fetch(
+      `/api/community/${this.teamSlug}/posts/${slug}`
+    );
+    return response.data;
+  }
+  /**
+   * Full-text search across post titles and bodies.
+   * Returns matching posts with relevance ranking.
+   */
+  async search(query) {
+    return this.fetch(`/api/community/${this.teamSlug}/search`, {
+      q: query
+    });
+  }
+  async fetch(path, query) {
+    let url = `${this.baseUrl}${path}`;
+    if (query) {
+      const params = new URLSearchParams();
+      for (const [key, value] of Object.entries(query)) {
+        if (value !== void 0) params.set(key, value);
+      }
+      const qs = params.toString();
+      if (qs) url += `?${qs}`;
+    }
+    const response = await globalThis.fetch(url, {
+      method: "GET",
+      headers: { "Content-Type": "application/json" }
+    });
+    if (!response.ok) {
+      const errorBody = await response.json().catch(() => ({ error: { message: "Request failed" } }));
+      const message = typeof errorBody.error === "string" ? errorBody.error : errorBody.error?.message ?? `Community API error: ${response.status}`;
+      throw new Error(message);
+    }
+    return response.json();
+  }
+};
+export {
+  CommunityClient
+};