@cstar.help/js 0.4.0 → 0.5.1

package/package.json

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

package/dist/community/index.d.cts

@@ -1,115 +0,0 @@
-/** 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

@@ -1,115 +0,0 @@
-/** 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 };