@cstar.help/js 0.16.1 → 0.17.2

package/dist/types-DF7GprCV.d.ts

@@ -0,0 +1,190 @@
+/** 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;
+    /**
+     * Optional publishable key (`pk_test_*` or `pk_live_*`). When provided,
+     * the client switches data scope to match the key's mode (test vs live).
+     * Without a key, defaults to live — backwards-compatible with existing
+     * widget integrations. See `LibraryConfig.publishableKey` for the full
+     * test/live story.
+     */
+    publishableKey?: 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;
+    /** Custom field values keyed by field definition ID. */
+    customFields?: Record<string, string>;
+    /** Image attachments (max 10, images only, 5MB each). */
+    attachments?: CommunityAttachment[];
+}
+/** Parameters for updating a post as the original author. */
+interface CommunityUpdatePostParams {
+    /** Updated post title. */
+    title?: string;
+    /** Updated post body/content. */
+    body?: string;
+    /** Updated custom field values keyed by field definition ID. */
+    customFields?: Record<string, string>;
+}
+/** Parameters for updating a comment as the original author. */
+interface CommunityUpdateCommentParams {
+    /** Updated comment body text. */
+    body: string;
+}
+/** 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;
+    customFields: Record<string, string>;
+    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;
+}
+/** Resolved custom field definition for a topic. */
+interface TopicCustomField {
+    id: string;
+    label: string;
+    type: 'text' | 'number' | 'date' | 'select' | 'checkbox' | 'url';
+    required: boolean;
+    options?: Array<{
+        value: string;
+        label: string;
+    }>;
+    defaultValue?: 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;
+    postCount: number;
+    customFields: TopicCustomField[];
+}
+/** 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;
+    customFields: Record<string, string>;
+    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[];
+}
+
+export type { CommunityCreatePostParams as C, CommunityCreatedPost as a, CommunityUpdatePostParams as b, CommunityUpdateCommentParams as c, CommunityCreatedComment as d, CommunityVoteResult as e, CommunityCreateCommentParams as f, CommunityFollowResult as g, CommunityConfig as h, CommunityTopic as i, CommunityPostListParams as j, CommunityPost as k, CommunityPostDetail as l, CommunitySearchResult as m, CommunityComment as n };

package/dist/webhook/index.d.cts

@@ -1,436 +1,4 @@
-/** Every webhook event type cStar can dispatch. */
-type WebhookEventType = 'agent.preferences_updated' | 'article.created' | 'article.deleted' | 'article.published' | 'article.updated' | 'boss.damaged' | 'boss.defeated' | 'boss.spawned' | 'community_post.commented' | 'community_post.created' | 'community_post.deleted' | 'community_post.status_changed' | 'community_post.updated' | 'community_post.voted' | 'customer.created' | 'customer.deleted' | 'customer.updated' | 'customer_group.created' | 'customer_group.deleted' | 'customer_group.updated' | 'player.achievement_unlocked' | 'player.level_up' | 'player.quest_completed' | 'player.streak_milestone' | 'player.xp_gained' | 'social.high_five_sent' | 'social.one_up_sent' | 'survey.submitted' | 'team.preferences_updated' | 'ticket.assigned' | 'ticket.closed' | 'ticket.created' | 'ticket.deleted' | 'ticket.message_added' | 'ticket.updated';
-/** Payload for `agent.preferences_updated` events. */
-interface AgentPreferencesUpdatedPayload {
-    team_id: string;
-    member_id: string;
-    agent_id: string;
-    changed: Array<string>;
-    preferences: {
-        boringMode: boolean;
-    };
-}
-/** Payload for `article.created` events. */
-interface ArticleCreatedPayload {
-    article: {
-        id: string;
-        title: string;
-        slug: string;
-        is_public: boolean;
-        created_at: string;
-    };
-}
-/** Payload for `article.deleted` events. */
-interface ArticleDeletedPayload {
-    id: string;
-}
-/** Payload for `article.published` events. */
-interface ArticlePublishedPayload {
-    article: {
-        id: string;
-        title: string;
-        slug: string;
-        is_public: boolean;
-        published_at: string;
-    };
-}
-/** Payload for `article.updated` events. */
-interface ArticleUpdatedPayload {
-    article: {
-        id: string;
-        title: string;
-        slug: string;
-        is_public: boolean;
-    };
-}
-/** Payload for `boss.damaged` events. */
-interface BossDamagedPayload {
-    boss: {
-        id: string;
-        current_hp: number;
-    };
-    damage: number;
-    by: {
-        agent_id: string;
-        name: string;
-    };
-}
-/** Payload for `boss.defeated` events. */
-interface BossDefeatedPayload {
-    boss: {
-        id: string;
-        name: string;
-    };
-    final_blow_by: {
-        agent_id: string;
-        name: string;
-    };
-    team_xp_awarded: number;
-}
-/** Payload for `boss.spawned` events. */
-interface BossSpawnedPayload {
-    boss: {
-        id: string;
-        name: string;
-        level: number;
-        max_hp: number;
-    };
-}
-/** Payload for `community_post.commented` events. */
-interface CommunityPostCommentedPayload {
-    comment: {
-        id: string;
-        post_id: string;
-        content: string;
-        author_id: string;
-        created_at: string;
-    };
-}
-/** Payload for `community_post.created` events. */
-interface CommunityPostCreatedPayload {
-    post: {
-        id: string;
-        prefixed_id: string;
-        title: string;
-        status: string;
-        visibility: string;
-        topic: string;
-        created_at: string;
-    };
-}
-/** Payload for `community_post.deleted` events. */
-interface CommunityPostDeletedPayload {
-    post: {
-        id: string;
-        prefixed_id?: string;
-        title?: string;
-    };
-}
-/** Payload for `community_post.status_changed` events. */
-interface CommunityPostStatusChangedPayload {
-    post: {
-        id: string;
-        title: string;
-        status: string;
-        visibility: string;
-    };
-}
-/** Payload for `community_post.updated` events. */
-interface CommunityPostUpdatedPayload {
-    post: {
-        id: string;
-        title: string;
-        status: string;
-        visibility: string;
-    };
-}
-/** Payload for `community_post.voted` events. */
-interface CommunityPostVotedPayload {
-    post: {
-        id: string;
-        vote_count: number;
-    };
-    voter: {
-        id: string;
-    };
-    direction: string;
-}
-/** Payload for `customer.created` events. */
-interface CustomerCreatedPayload {
-    customer: {
-        id: string;
-        name: string;
-        email: string;
-        status: string;
-        tags: Array<string>;
-        created_at: string;
-    };
-}
-/** Payload for `customer.deleted` events. */
-interface CustomerDeletedPayload {
-    id: string;
-}
-/** Payload for `customer.updated` events. */
-interface CustomerUpdatedPayload {
-    customer: {
-        id: string;
-        name: string;
-        email: string;
-        status: string;
-        tags: Array<string>;
-    };
-    changes: {
-        tags: {
-            from: Array<string>;
-            to: Array<string>;
-        };
-    };
-}
-/** Payload for `customer_group.created` events. */
-interface CustomerGroupCreatedPayload {
-    group: {
-        id: string;
-        name: string;
-        color: string;
-        member_count: number;
-    };
-}
-/** Payload for `customer_group.deleted` events. */
-interface CustomerGroupDeletedPayload {
-    customer_group: {
-        id: string;
-    };
-}
-/** Payload for `customer_group.updated` events. */
-interface CustomerGroupUpdatedPayload {
-    group: {
-        id: string;
-        name: string;
-        color: string;
-        member_count: number;
-    };
-}
-/** Payload for `player.achievement_unlocked` events. */
-interface PlayerAchievementUnlockedPayload {
-    player: {
-        agent_id: string;
-        name: string;
-    };
-    achievement: {
-        id: string;
-        name: string;
-        xp: number;
-    };
-}
-/** Payload for `player.level_up` events. */
-interface PlayerLevelUpPayload {
-    player: {
-        agent_id: string;
-        name: string;
-    };
-    level: {
-        from: number;
-        to: number;
-    };
-    title_unlocked: string;
-}
-/** Payload for `player.quest_completed` events. */
-interface PlayerQuestCompletedPayload {
-    player: {
-        agent_id: string;
-        name: string;
-    };
-    quest: {
-        id: string;
-        name: string;
-        xp: number;
-    };
-}
-/** Payload for `player.streak_milestone` events. */
-interface PlayerStreakMilestonePayload {
-    player: {
-        agent_id: string;
-        name: string;
-    };
-    streak_days: number;
-    milestone: number;
-}
-/** Payload for `player.xp_gained` events. */
-interface PlayerXpGainedPayload {
-    player: {
-        agent_id: string;
-        name: string;
-    };
-    amount: number;
-    reason: string;
-    ticket_id: string;
-}
-/** Payload for `social.high_five_sent` events. */
-interface SocialHighFiveSentPayload {
-    from_team: {
-        id: string;
-        name: string;
-    };
-    to_team: {
-        id: string;
-        name: string;
-    };
-    message: string;
-}
-/** Payload for `social.one_up_sent` events. */
-interface SocialOneUpSentPayload {
-    from: {
-        agent_id: string;
-        name: string;
-    };
-    to: {
-        agent_id: string;
-        name: string;
-    };
-    ticket_id: string;
-    message: string;
-}
-/** Payload for `survey.submitted` events. */
-interface SurveySubmittedPayload {
-    survey: {
-        id: string;
-        ticket_id: string;
-        score: number;
-        comment: string;
-        submitted_at: string;
-    };
-    customer: {
-        id: string;
-        email: string;
-    };
-}
-/** Payload for `team.preferences_updated` events. */
-interface TeamPreferencesUpdatedPayload {
-    team_id: string;
-    changed: Array<string>;
-    preferences: {
-        bossBattlesEnabled: boolean;
-    };
-}
-/** Payload for `ticket.assigned` events. */
-interface TicketAssignedPayload {
-    ticket: {
-        id: string;
-        prefixed_id: string;
-    };
-    assignee: {
-        id: string;
-        name: string;
-        email: string;
-    };
-    previous_assignee: null;
-}
-/** Payload for `ticket.closed` events. */
-interface TicketClosedPayload {
-    ticket: {
-        id: string;
-        prefixed_id: string;
-        title: string;
-        status: string;
-        priority: string;
-        channel: string;
-        resolved_at: string;
-    };
-    changes?: Record<string, {
-        from: string;
-        to: string;
-    }>;
-}
-/** Payload for `ticket.created` events. */
-interface TicketCreatedPayload {
-    ticket: {
-        id: string;
-        prefixed_id: string;
-        title: string;
-        status: string;
-        priority: string;
-        channel: string;
-        customer_id: string;
-        created_at: string;
-    };
-    customer: {
-        id: string;
-        name: string;
-        email: string;
-    };
-}
-/** Payload for `ticket.deleted` events. */
-interface TicketDeletedPayload {
-    id: string;
-}
-/** Payload for `ticket.message_added` events. */
-interface TicketMessageAddedPayload {
-    ticket: {
-        id: string;
-        dashboard_url: string | null;
-    };
-    message: {
-        id: string;
-        sender: string;
-        sender_name: string | null;
-        content: string;
-        created_at: string;
-    };
-    customer?: {
-        id: string;
-        name: string | null;
-        email: string | null;
-    };
-}
-/** Payload for `ticket.updated` events. */
-interface TicketUpdatedPayload {
-    ticket: {
-        id: string;
-        prefixed_id: string;
-        title: string;
-        status: string;
-        priority: string;
-        channel: string;
-    };
-    changes?: Record<string, {
-        from: string;
-        to: string;
-    } | {
-        from: Array<string>;
-        to: Array<string>;
-    }>;
-}
-/** Maps each event type to its payload interface — used internally for the discriminated union. */
-interface WebhookEventDataMap {
-    'agent.preferences_updated': AgentPreferencesUpdatedPayload;
-    'article.created': ArticleCreatedPayload;
-    'article.deleted': ArticleDeletedPayload;
-    'article.published': ArticlePublishedPayload;
-    'article.updated': ArticleUpdatedPayload;
-    'boss.damaged': BossDamagedPayload;
-    'boss.defeated': BossDefeatedPayload;
-    'boss.spawned': BossSpawnedPayload;
-    'community_post.commented': CommunityPostCommentedPayload;
-    'community_post.created': CommunityPostCreatedPayload;
-    'community_post.deleted': CommunityPostDeletedPayload;
-    'community_post.status_changed': CommunityPostStatusChangedPayload;
-    'community_post.updated': CommunityPostUpdatedPayload;
-    'community_post.voted': CommunityPostVotedPayload;
-    'customer.created': CustomerCreatedPayload;
-    'customer.deleted': CustomerDeletedPayload;
-    'customer.updated': CustomerUpdatedPayload;
-    'customer_group.created': CustomerGroupCreatedPayload;
-    'customer_group.deleted': CustomerGroupDeletedPayload;
-    'customer_group.updated': CustomerGroupUpdatedPayload;
-    'player.achievement_unlocked': PlayerAchievementUnlockedPayload;
-    'player.level_up': PlayerLevelUpPayload;
-    'player.quest_completed': PlayerQuestCompletedPayload;
-    'player.streak_milestone': PlayerStreakMilestonePayload;
-    'player.xp_gained': PlayerXpGainedPayload;
-    'social.high_five_sent': SocialHighFiveSentPayload;
-    'social.one_up_sent': SocialOneUpSentPayload;
-    'survey.submitted': SurveySubmittedPayload;
-    'team.preferences_updated': TeamPreferencesUpdatedPayload;
-    'ticket.assigned': TicketAssignedPayload;
-    'ticket.closed': TicketClosedPayload;
-    'ticket.created': TicketCreatedPayload;
-    'ticket.deleted': TicketDeletedPayload;
-    'ticket.message_added': TicketMessageAddedPayload;
-    'ticket.updated': TicketUpdatedPayload;
-}
-/** A webhook event delivered to your endpoint. */
-interface WebhookEvent<T extends WebhookEventType = WebhookEventType> {
-    /** Unique event ID (idempotency key). */
-    id: string;
-    /** Event type. */
-    type: T;
-    /** When the event was created (ISO 8601). */
-    created_at: string;
-    /** Team that owns this event. */
-    team_id: string;
-    /** Event-specific payload. */
-    data: WebhookEventDataMap[T];
-}
+import { d as WebhookEvent } from '../webhookEvents-1N2i2GcQ.cjs';
 
 /** Default replay window for Stripe-style signatures: 5 minutes (300s). */
 declare const DEFAULT_TOLERANCE_SECONDS = 300;
@@ -481,4 +49,4 @@ declare function constructEventAsync(rawBody: string, signature: string, secret:
  */
 declare function verifySignatureAsync(rawBody: string, signature: string, secret: string, options?: VerifyOptions): Promise<boolean>;
 
-export { DEFAULT_TOLERANCE_SECONDS, type VerifyOptions, type WebhookEvent, WebhookSignatureVerificationError, constructEventAsync, signPayloadStripeAsync, verifySignatureAsync };
+export { DEFAULT_TOLERANCE_SECONDS, type VerifyOptions, WebhookEvent, WebhookSignatureVerificationError, constructEventAsync, signPayloadStripeAsync, verifySignatureAsync };