@cstar.help/js 0.3.4 → 0.4.0

package/README.md

@@ -4,7 +4,7 @@ Official TypeScript SDK for the [cStar](https://cstar.help) customer support pla
 
 - **Zero dependencies** — works with Node.js 18+ native `fetch`
 - **TypeScript-first** — full type definitions included
-- **Four entry points** — tree-shake what you don't need
+- **Five entry points** — tree-shake what you don't need
 - **ESM + CJS** — works everywhere
 
 ## Install
@@ -94,6 +94,61 @@ const results = await library.search('reset password');
 const article = await library.article('how-to-reset-password');
 ```
 
+### Public Community
+
+Browse and search your public community forum — no authentication required.
+
+```typescript
+import { CommunityClient } from '@cstar.help/js/community';
+
+const community = new CommunityClient({ teamSlug: 'acme' });
+
+// List discussion topics
+const topics = await community.topics();
+
+// List posts (with filters)
+const { posts, count } = await community.posts({
+	topicSlug: 'feature-requests',
+	sort: 'votes'
+});
+
+// Get a single post with all comments
+const { post, comments } = await community.post('dark-mode-support');
+
+// Search posts
+const results = await community.search('billing');
+```
+
+### Server-side Community (Admin)
+
+Manage community posts with your secret API key via `CStarClient`:
+
+```typescript
+const cstar = new CStarClient({ apiKey: 'sk_live_...', teamId: 'tm_...' });
+
+// List all posts (including hidden/unapproved)
+const { data: posts } = await cstar.community.posts.list({ status: 'open' });
+
+// Create a post
+const { data: post } = await cstar.community.posts.create({
+	title: 'New Feature: Dark Mode',
+	body: 'We just shipped dark mode!',
+	topicId: 'topic_abc123'
+});
+
+// Toggle vote on a post
+const { voted, voteCount } = await cstar.community.posts.vote('post_id');
+
+// Add a comment
+const comment = await cstar.community.posts.createComment('post_id', {
+	body: 'Great idea!',
+	isOfficial: true
+});
+
+// List topics
+const { data: topics } = await cstar.community.topics.list();
+```
+
 ### Webhook Verification
 
 Verify incoming webhook signatures on your server.
@@ -126,13 +181,15 @@ const event = await constructEventAsync(rawBody, signature, secret);
 
 ### CStarClient
 
-| Resource                 | Methods                                                                                         |
-| ------------------------ | ----------------------------------------------------------------------------------------------- |
-| `cstar.tickets`          | `.list()` `.get(id)` `.create(params)` `.update(id, params)` `.del(id)` `.listAutoPaginating()` |
-| `cstar.tickets.messages` | `.list(ticketId)` `.create(ticketId, params)`                                                   |
-| `cstar.customers`        | `.list()` `.get(id)` `.create(params)` `.update(id, params)` `.del(id)` `.listAutoPaginating()` |
-| `cstar.articles`         | `.list()` `.get(id)` `.create(params)` `.update(id, params)` `.del(id)` `.listAutoPaginating()` |
-| `cstar.webhooks`         | `.list()` `.get(id)` `.create(params)` `.update(id, params)` `.del(id)` `.test(id)`             |
+| Resource                 | Methods                                                                                                                                            |
+| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `cstar.tickets`          | `.list()` `.get(id)` `.create(params)` `.update(id, params)` `.del(id)` `.listAutoPaginating()`                                                    |
+| `cstar.tickets.messages` | `.list(ticketId)` `.create(ticketId, params)`                                                                                                      |
+| `cstar.customers`        | `.list()` `.get(id)` `.create(params)` `.update(id, params)` `.del(id)` `.listAutoPaginating()`                                                    |
+| `cstar.articles`         | `.list()` `.get(id)` `.create(params)` `.update(id, params)` `.del(id)` `.listAutoPaginating()`                                                    |
+| `cstar.webhooks`         | `.list()` `.get(id)` `.create(params)` `.update(id, params)` `.del(id)` `.test(id)`                                                                |
+| `cstar.community.posts`  | `.list()` `.get(id)` `.create(params)` `.update(id, params)` `.del(id)` `.vote(id)` `.follow(id)` `.listComments(id)` `.createComment(id, params)` |
+| `cstar.community.topics` | `.list()` `.get(id)`                                                                                                                               |
 
 ### Configuration
 

package/dist/community/index.cjs

@@ -0,0 +1,94 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/community/index.ts
+var community_exports = {};
+__export(community_exports, {
+  CommunityClient: () => CommunityClient
+});
+module.exports = __toCommonJS(community_exports);
+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();
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CommunityClient
+});

package/dist/community/index.d.cts

@@ -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.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
+};

package/dist/index.cjs

@@ -341,6 +341,49 @@ var CategoriesResource = class extends BaseResource {
   }
 };
 
+// src/resources/communityPosts.ts
+var CommunityPostsResource = class extends BaseResource {
+  constructor(client) {
+    super(client, "/community/posts");
+  }
+  /** Toggle vote on a post. Returns new vote state and count. */
+  async vote(postId) {
+    return this.client.request(
+      "POST",
+      `${this.basePath}/${postId}/vote`
+    );
+  }
+  /** Toggle follow on a post. Returns new follow state. */
+  async follow(postId) {
+    return this.client.request(
+      "POST",
+      `${this.basePath}/${postId}/follow`
+    );
+  }
+  /** List all comments on a post. */
+  async listComments(postId) {
+    return this.client.request(
+      "GET",
+      `${this.basePath}/${postId}/comments`
+    );
+  }
+  /** Add a comment to a post. */
+  async createComment(postId, params) {
+    return this.client.request(
+      "POST",
+      `${this.basePath}/${postId}/comments`,
+      { body: params }
+    );
+  }
+};
+
+// src/resources/communityTopics.ts
+var CommunityTopicsResource = class extends BaseResource {
+  constructor(client) {
+    super(client, "/community/topics");
+  }
+};
+
 // src/index.ts
 var CStarClient = class {
   constructor(config) {
@@ -350,6 +393,10 @@ var CStarClient = class {
     this.articles = new ArticlesResource(this.client);
     this.webhooks = new WebhooksResource(this.client);
     this.categories = new CategoriesResource(this.client);
+    this.community = {
+      posts: new CommunityPostsResource(this.client),
+      topics: new CommunityTopicsResource(this.client)
+    };
   }
   /** Whether this client is using test mode keys (sk_test_* or pk_test_*). */
   get isTestMode() {

package/dist/index.d.cts

@@ -471,6 +471,107 @@ declare class CategoriesResource extends BaseResource<Category, CategoryListPara
     constructor(client: HttpClient);
 }
 
+/** A community discussion topic (category/board). */
+interface CommunityTopic {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    icon: string;
+    visibility: 'public' | 'members_only';
+    sortOrder: number;
+    postCount: number;
+    createdAt: string;
+}
+/** A community discussion post. */
+interface CommunityPost {
+    id: string;
+    topicId: string;
+    topicName: string;
+    title: string;
+    slug: string;
+    body: string | null;
+    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;
+    authorName: string;
+    lastActivityAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** A comment on a community post. */
+interface CommunityComment {
+    id: string;
+    postId: string;
+    body: string;
+    isOfficial: boolean;
+    voteScore: number;
+    authorName: string;
+    parentCommentId: string | null;
+    createdAt: string;
+}
+/** Query parameters for listing community posts. */
+interface CommunityPostListParams {
+    topicId?: string;
+    status?: string;
+    sort?: 'recent' | 'votes' | 'comments';
+    page?: number;
+    pageSize?: number;
+}
+/** Parameters for creating a community post. */
+interface CommunityPostCreateParams {
+    title: string;
+    body?: string;
+    topicId: string;
+    visibility?: 'public' | 'members_only';
+}
+/** Parameters for updating a community post. */
+interface CommunityPostUpdateParams {
+    title?: string;
+    body?: string;
+    topicId?: string;
+    status?: string;
+    visibility?: string;
+    isPinned?: boolean;
+    isLocked?: boolean;
+    isHidden?: boolean;
+    commentsEnabled?: boolean;
+}
+/** Parameters for creating a comment on a community post. */
+interface CommunityCommentCreateParams {
+    body: string;
+    parentCommentId?: string;
+    isOfficial?: boolean;
+}
+
+/** Manage community discussion posts. */
+declare class CommunityPostsResource extends BaseResource<CommunityPost, CommunityPostListParams, CommunityPostCreateParams, CommunityPostUpdateParams> {
+    constructor(client: HttpClient);
+    /** Toggle vote on a post. Returns new vote state and count. */
+    vote(postId: string): Promise<ApiResponse<{
+        voted: boolean;
+        voteCount: number;
+    }>>;
+    /** Toggle follow on a post. Returns new follow state. */
+    follow(postId: string): Promise<ApiResponse<{
+        following: boolean;
+    }>>;
+    /** List all comments on a post. */
+    listComments(postId: string): Promise<ApiResponse<CommunityComment[]>>;
+    /** Add a comment to a post. */
+    createComment(postId: string, params: CommunityCommentCreateParams): Promise<ApiResponse<CommunityComment>>;
+}
+
+/** Manage community discussion topics. */
+declare class CommunityTopicsResource extends BaseResource<CommunityTopic, Record<string, never>, never, never> {
+    constructor(client: HttpClient);
+}
+
 /** Error type constants matching the cStar API. */
 declare const ErrorType: {
     readonly AUTHENTICATION_ERROR: "authentication_error";
@@ -554,10 +655,15 @@ declare class CStarClient {
     readonly webhooks: WebhooksResource;
     /** Manage article categories. */
     readonly categories: CategoriesResource;
+    /** Manage community posts and topics. */
+    readonly community: {
+        readonly posts: CommunityPostsResource;
+        readonly topics: CommunityTopicsResource;
+    };
     private readonly client;
     constructor(config: CStarClientConfig);
     /** Whether this client is using test mode keys (sk_test_* or pk_test_*). */
     get isTestMode(): boolean;
 }
 
-export { type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarError, CStarNotFoundError, CStarRateLimitError, CStarValidationError, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type Customer, type CustomerCreateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, ErrorType, type ListResponse, type Message, type MessageCreateParams, type Metadata, type PaginationInfo, type PaginationParams, type RequestOptions, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookTestResult, type WebhookUpdateParams };
+export { type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarError, CStarNotFoundError, CStarRateLimitError, CStarValidationError, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type Customer, type CustomerCreateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, ErrorType, type ListResponse, type Message, type MessageCreateParams, type Metadata, type PaginationInfo, type PaginationParams, type RequestOptions, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookTestResult, type WebhookUpdateParams };

package/dist/index.d.ts

@@ -471,6 +471,107 @@ declare class CategoriesResource extends BaseResource<Category, CategoryListPara
     constructor(client: HttpClient);
 }
 
+/** A community discussion topic (category/board). */
+interface CommunityTopic {
+    id: string;
+    name: string;
+    slug: string;
+    description: string | null;
+    icon: string;
+    visibility: 'public' | 'members_only';
+    sortOrder: number;
+    postCount: number;
+    createdAt: string;
+}
+/** A community discussion post. */
+interface CommunityPost {
+    id: string;
+    topicId: string;
+    topicName: string;
+    title: string;
+    slug: string;
+    body: string | null;
+    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;
+    authorName: string;
+    lastActivityAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** A comment on a community post. */
+interface CommunityComment {
+    id: string;
+    postId: string;
+    body: string;
+    isOfficial: boolean;
+    voteScore: number;
+    authorName: string;
+    parentCommentId: string | null;
+    createdAt: string;
+}
+/** Query parameters for listing community posts. */
+interface CommunityPostListParams {
+    topicId?: string;
+    status?: string;
+    sort?: 'recent' | 'votes' | 'comments';
+    page?: number;
+    pageSize?: number;
+}
+/** Parameters for creating a community post. */
+interface CommunityPostCreateParams {
+    title: string;
+    body?: string;
+    topicId: string;
+    visibility?: 'public' | 'members_only';
+}
+/** Parameters for updating a community post. */
+interface CommunityPostUpdateParams {
+    title?: string;
+    body?: string;
+    topicId?: string;
+    status?: string;
+    visibility?: string;
+    isPinned?: boolean;
+    isLocked?: boolean;
+    isHidden?: boolean;
+    commentsEnabled?: boolean;
+}
+/** Parameters for creating a comment on a community post. */
+interface CommunityCommentCreateParams {
+    body: string;
+    parentCommentId?: string;
+    isOfficial?: boolean;
+}
+
+/** Manage community discussion posts. */
+declare class CommunityPostsResource extends BaseResource<CommunityPost, CommunityPostListParams, CommunityPostCreateParams, CommunityPostUpdateParams> {
+    constructor(client: HttpClient);
+    /** Toggle vote on a post. Returns new vote state and count. */
+    vote(postId: string): Promise<ApiResponse<{
+        voted: boolean;
+        voteCount: number;
+    }>>;
+    /** Toggle follow on a post. Returns new follow state. */
+    follow(postId: string): Promise<ApiResponse<{
+        following: boolean;
+    }>>;
+    /** List all comments on a post. */
+    listComments(postId: string): Promise<ApiResponse<CommunityComment[]>>;
+    /** Add a comment to a post. */
+    createComment(postId: string, params: CommunityCommentCreateParams): Promise<ApiResponse<CommunityComment>>;
+}
+
+/** Manage community discussion topics. */
+declare class CommunityTopicsResource extends BaseResource<CommunityTopic, Record<string, never>, never, never> {
+    constructor(client: HttpClient);
+}
+
 /** Error type constants matching the cStar API. */
 declare const ErrorType: {
     readonly AUTHENTICATION_ERROR: "authentication_error";
@@ -554,10 +655,15 @@ declare class CStarClient {
     readonly webhooks: WebhooksResource;
     /** Manage article categories. */
     readonly categories: CategoriesResource;
+    /** Manage community posts and topics. */
+    readonly community: {
+        readonly posts: CommunityPostsResource;
+        readonly topics: CommunityTopicsResource;
+    };
     private readonly client;
     constructor(config: CStarClientConfig);
     /** Whether this client is using test mode keys (sk_test_* or pk_test_*). */
     get isTestMode(): boolean;
 }
 
-export { type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarError, CStarNotFoundError, CStarRateLimitError, CStarValidationError, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type Customer, type CustomerCreateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, ErrorType, type ListResponse, type Message, type MessageCreateParams, type Metadata, type PaginationInfo, type PaginationParams, type RequestOptions, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookTestResult, type WebhookUpdateParams };
+export { type ApiErrorBody, type ApiResponse, type Article, type ArticleCreateParams, type ArticleListParams, type ArticleUpdateParams, CStarAuthenticationError, CStarClient, type CStarClientConfig, CStarError, CStarNotFoundError, CStarRateLimitError, CStarValidationError, type Category, type CategoryCreateParams, type CategoryListParams, type CategoryUpdateParams, type CommunityComment, type CommunityCommentCreateParams, type CommunityPost, type CommunityPostCreateParams, type CommunityPostListParams, type CommunityPostUpdateParams, type CommunityTopic, type Customer, type CustomerCreateParams, type CustomerListParams, type CustomerUpdateParams, type DeleteResponse, ErrorType, type ListResponse, type Message, type MessageCreateParams, type Metadata, type PaginationInfo, type PaginationParams, type RequestOptions, type Ticket, type TicketCreateParams, type TicketCustomerSummary, type TicketListParams, type TicketUpdateParams, type Webhook, type WebhookCreateParams, type WebhookEvent, type WebhookEventData, type WebhookEventType, type WebhookListParams, type WebhookTestResult, type WebhookUpdateParams };

package/dist/index.js

@@ -309,6 +309,49 @@ var CategoriesResource = class extends BaseResource {
   }
 };
 
+// src/resources/communityPosts.ts
+var CommunityPostsResource = class extends BaseResource {
+  constructor(client) {
+    super(client, "/community/posts");
+  }
+  /** Toggle vote on a post. Returns new vote state and count. */
+  async vote(postId) {
+    return this.client.request(
+      "POST",
+      `${this.basePath}/${postId}/vote`
+    );
+  }
+  /** Toggle follow on a post. Returns new follow state. */
+  async follow(postId) {
+    return this.client.request(
+      "POST",
+      `${this.basePath}/${postId}/follow`
+    );
+  }
+  /** List all comments on a post. */
+  async listComments(postId) {
+    return this.client.request(
+      "GET",
+      `${this.basePath}/${postId}/comments`
+    );
+  }
+  /** Add a comment to a post. */
+  async createComment(postId, params) {
+    return this.client.request(
+      "POST",
+      `${this.basePath}/${postId}/comments`,
+      { body: params }
+    );
+  }
+};
+
+// src/resources/communityTopics.ts
+var CommunityTopicsResource = class extends BaseResource {
+  constructor(client) {
+    super(client, "/community/topics");
+  }
+};
+
 // src/index.ts
 var CStarClient = class {
   constructor(config) {
@@ -318,6 +361,10 @@ var CStarClient = class {
     this.articles = new ArticlesResource(this.client);
     this.webhooks = new WebhooksResource(this.client);
     this.categories = new CategoriesResource(this.client);
+    this.community = {
+      posts: new CommunityPostsResource(this.client),
+      topics: new CommunityTopicsResource(this.client)
+    };
   }
   /** Whether this client is using test mode keys (sk_test_* or pk_test_*). */
   get isTestMode() {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cstar.help/js",
-	"version": "0.3.4",
+	"version": "0.4.0",
 	"description": "Official TypeScript SDK for the cStar customer support platform",
 	"type": "module",
 	"main": "./dist/index.cjs",
@@ -47,6 +47,16 @@
 				"default": "./dist/webhook/index.cjs"
 			}
 		},
+		"./community": {
+			"import": {
+				"types": "./dist/community/index.d.ts",
+				"default": "./dist/community/index.js"
+			},
+			"require": {
+				"types": "./dist/community/index.d.cts",
+				"default": "./dist/community/index.cjs"
+			}
+		},
 		"./auth": {
 			"import": {
 				"types": "./dist/auth/index.d.ts",