@cstar.help/js 0.5.2 → 0.6.1

package/dist/chat/index.d.cts

@@ -97,6 +97,13 @@ type MessageCallback = (message: WidgetMessage) => void;
 /** Callback for typing indicator events. */
 type TypingCallback = (payload: TypingPayload) => void;
 
+/** Attachment metadata for community posts and comments (images only, max 5MB each). */
+interface CommunityAttachment {
+    filename: string;
+    content_type: string;
+    size_bytes: number;
+    storage_path: string;
+}
 /** Parameters for creating a post as an identified customer. */
 interface CommunityCreatePostParams {
     /** Post title. */
@@ -105,6 +112,8 @@ interface CommunityCreatePostParams {
     body?: string;
     /** Topic UUID to post in. */
     topicId: string;
+    /** Image attachments (max 10, images only, 5MB each). */
+    attachments?: CommunityAttachment[];
 }
 /** Parameters for creating a comment as an identified customer. */
 interface CommunityCreateCommentParams {
@@ -112,6 +121,8 @@ interface CommunityCreateCommentParams {
     body: string;
     /** Parent comment ID for replies (optional, 1-level nesting). */
     parentCommentId?: string | null;
+    /** Image attachments (max 5, images only, 5MB each). */
+    attachments?: CommunityAttachment[];
 }
 /** Response from creating a post. */
 interface CommunityCreatedPost {

package/dist/chat/index.d.ts

@@ -97,6 +97,13 @@ type MessageCallback = (message: WidgetMessage) => void;
 /** Callback for typing indicator events. */
 type TypingCallback = (payload: TypingPayload) => void;
 
+/** Attachment metadata for community posts and comments (images only, max 5MB each). */
+interface CommunityAttachment {
+    filename: string;
+    content_type: string;
+    size_bytes: number;
+    storage_path: string;
+}
 /** Parameters for creating a post as an identified customer. */
 interface CommunityCreatePostParams {
     /** Post title. */
@@ -105,6 +112,8 @@ interface CommunityCreatePostParams {
     body?: string;
     /** Topic UUID to post in. */
     topicId: string;
+    /** Image attachments (max 10, images only, 5MB each). */
+    attachments?: CommunityAttachment[];
 }
 /** Parameters for creating a comment as an identified customer. */
 interface CommunityCreateCommentParams {
@@ -112,6 +121,8 @@ interface CommunityCreateCommentParams {
     body: string;
     /** Parent comment ID for replies (optional, 1-level nesting). */
     parentCommentId?: string | null;
+    /** Image attachments (max 5, images only, 5MB each). */
+    attachments?: CommunityAttachment[];
 }
 /** Response from creating a post. */
 interface CommunityCreatedPost {

package/dist/community/index.d.cts

@@ -0,0 +1,231 @@
+/** Attachment metadata for community posts and comments (images only, max 5MB each). */
+interface CommunityAttachment {
+    filename: string;
+    content_type: string;
+    size_bytes: number;
+    storage_path: string;
+}
+/** 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;
+}
+/** Parameters for creating a post as an identified customer. */
+interface CommunityCreatePostParams {
+    /** Post title. */
+    title: string;
+    /** Post body/content (optional). */
+    body?: string;
+    /** Topic UUID to post in. */
+    topicId: string;
+    /** Image attachments (max 10, images only, 5MB each). */
+    attachments?: CommunityAttachment[];
+}
+/** Parameters for creating a comment as an identified customer. */
+interface CommunityCreateCommentParams {
+    /** Comment body text. */
+    body: string;
+    /** Parent comment ID for replies (optional, 1-level nesting). */
+    parentCommentId?: string | null;
+    /** Image attachments (max 5, images only, 5MB each). */
+    attachments?: CommunityAttachment[];
+}
+/** Response from creating a post. */
+interface CommunityCreatedPost {
+    id: string;
+    title: string;
+    slug: string;
+    body: string;
+    status: string;
+    visibility: string;
+    voteCount: number;
+    commentCount: number;
+    topicName: string;
+    topicSlug: string;
+    authorName: string;
+    authorAvatar: string;
+    isTeamMember: boolean;
+    createdAt: string;
+}
+/** Response from creating a comment. */
+interface CommunityCreatedComment {
+    id: string;
+    body: string;
+    isOfficial: boolean;
+    voteScore: number;
+    parentCommentId: string | null;
+    authorName: string;
+    authorAvatar: string;
+    isTeamMember: boolean;
+    createdAt: string;
+}
+/** Response from toggling a vote. */
+interface CommunityVoteResult {
+    voted: boolean;
+    voteCount: number;
+}
+/** Response from toggling a follow. */
+interface CommunityFollowResult {
+    following: boolean;
+}
+/** 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;
+    attachments: CommunityAttachment[];
+    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;
+    attachments: CommunityAttachment[];
+    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;
+    private sessionToken;
+    private teamId;
+    constructor(config: CommunityConfig);
+    /**
+     * Set a session token from identity verification.
+     * This enables authenticated operations (create posts, vote, comment).
+     *
+     * The token is the same `sessionToken` returned by `ChatClient.identify()`.
+     */
+    setSessionToken(token: string, teamId?: string): void;
+    /** Clear the session token and return to read-only mode. */
+    clearSession(): void;
+    /** Whether the client has an active session token. */
+    get isAuthenticated(): boolean;
+    /** 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>;
+    /**
+     * Create a new community post. Requires an active session token.
+     *
+     * @throws Error if no session token is set or the request fails
+     */
+    createPost(params: CommunityCreatePostParams): Promise<CommunityCreatedPost>;
+    /**
+     * Toggle vote on a post. Returns new vote state and count.
+     * Requires an active session token.
+     */
+    vote(postId: string): Promise<CommunityVoteResult>;
+    /**
+     * Add a comment to a post. Requires an active session token.
+     */
+    comment(postId: string, params: CommunityCreateCommentParams): Promise<CommunityCreatedComment>;
+    /**
+     * Toggle follow on a post. Requires an active session token.
+     */
+    follow(postId: string): Promise<CommunityFollowResult>;
+    /**
+     * Check if the current user has voted on a specific post.
+     * Requires an active session token.
+     */
+    getVoteStatus(postId: string): Promise<boolean>;
+    /**
+     * Check vote status for multiple posts in a single request.
+     * Returns a map of postId → voted boolean.
+     * Requires an active session token.
+     */
+    bulkVoteStatus(postIds: string[]): Promise<Record<string, boolean>>;
+    /**
+     * Resolve team slug to team ID (cached after first call).
+     * For authenticated operations that require teamId.
+     */
+    private resolveTeamId;
+    private authenticatedFetch;
+    private fetch;
+}
+
+export { CommunityClient, type CommunityComment, type CommunityConfig, type CommunityCreateCommentParams, type CommunityCreatePostParams, type CommunityCreatedComment, type CommunityCreatedPost, type CommunityFollowResult, type CommunityPost, type CommunityPostDetail, type CommunityPostListParams, type CommunitySearchResult, type CommunityTopic, type CommunityVoteResult };

package/dist/community/index.d.ts

@@ -0,0 +1,231 @@
+/** Attachment metadata for community posts and comments (images only, max 5MB each). */
+interface CommunityAttachment {
+    filename: string;
+    content_type: string;
+    size_bytes: number;
+    storage_path: string;
+}
+/** 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;
+}
+/** Parameters for creating a post as an identified customer. */
+interface CommunityCreatePostParams {
+    /** Post title. */
+    title: string;
+    /** Post body/content (optional). */
+    body?: string;
+    /** Topic UUID to post in. */
+    topicId: string;
+    /** Image attachments (max 10, images only, 5MB each). */
+    attachments?: CommunityAttachment[];
+}
+/** Parameters for creating a comment as an identified customer. */
+interface CommunityCreateCommentParams {
+    /** Comment body text. */
+    body: string;
+    /** Parent comment ID for replies (optional, 1-level nesting). */
+    parentCommentId?: string | null;
+    /** Image attachments (max 5, images only, 5MB each). */
+    attachments?: CommunityAttachment[];
+}
+/** Response from creating a post. */
+interface CommunityCreatedPost {
+    id: string;
+    title: string;
+    slug: string;
+    body: string;
+    status: string;
+    visibility: string;
+    voteCount: number;
+    commentCount: number;
+    topicName: string;
+    topicSlug: string;
+    authorName: string;
+    authorAvatar: string;
+    isTeamMember: boolean;
+    createdAt: string;
+}
+/** Response from creating a comment. */
+interface CommunityCreatedComment {
+    id: string;
+    body: string;
+    isOfficial: boolean;
+    voteScore: number;
+    parentCommentId: string | null;
+    authorName: string;
+    authorAvatar: string;
+    isTeamMember: boolean;
+    createdAt: string;
+}
+/** Response from toggling a vote. */
+interface CommunityVoteResult {
+    voted: boolean;
+    voteCount: number;
+}
+/** Response from toggling a follow. */
+interface CommunityFollowResult {
+    following: boolean;
+}
+/** 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;
+    attachments: CommunityAttachment[];
+    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;
+    attachments: CommunityAttachment[];
+    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;
+    private sessionToken;
+    private teamId;
+    constructor(config: CommunityConfig);
+    /**
+     * Set a session token from identity verification.
+     * This enables authenticated operations (create posts, vote, comment).
+     *
+     * The token is the same `sessionToken` returned by `ChatClient.identify()`.
+     */
+    setSessionToken(token: string, teamId?: string): void;
+    /** Clear the session token and return to read-only mode. */
+    clearSession(): void;
+    /** Whether the client has an active session token. */
+    get isAuthenticated(): boolean;
+    /** 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>;
+    /**
+     * Create a new community post. Requires an active session token.
+     *
+     * @throws Error if no session token is set or the request fails
+     */
+    createPost(params: CommunityCreatePostParams): Promise<CommunityCreatedPost>;
+    /**
+     * Toggle vote on a post. Returns new vote state and count.
+     * Requires an active session token.
+     */
+    vote(postId: string): Promise<CommunityVoteResult>;
+    /**
+     * Add a comment to a post. Requires an active session token.
+     */
+    comment(postId: string, params: CommunityCreateCommentParams): Promise<CommunityCreatedComment>;
+    /**
+     * Toggle follow on a post. Requires an active session token.
+     */
+    follow(postId: string): Promise<CommunityFollowResult>;
+    /**
+     * Check if the current user has voted on a specific post.
+     * Requires an active session token.
+     */
+    getVoteStatus(postId: string): Promise<boolean>;
+    /**
+     * Check vote status for multiple posts in a single request.
+     * Returns a map of postId → voted boolean.
+     * Requires an active session token.
+     */
+    bulkVoteStatus(postIds: string[]): Promise<Record<string, boolean>>;
+    /**
+     * Resolve team slug to team ID (cached after first call).
+     * For authenticated operations that require teamId.
+     */
+    private resolveTeamId;
+    private authenticatedFetch;
+    private fetch;
+}
+
+export { CommunityClient, type CommunityComment, type CommunityConfig, type CommunityCreateCommentParams, type CommunityCreatePostParams, type CommunityCreatedComment, type CommunityCreatedPost, type CommunityFollowResult, type CommunityPost, type CommunityPostDetail, type CommunityPostListParams, type CommunitySearchResult, type CommunityTopic, type CommunityVoteResult };