@cstar.help/js 0.16.0 → 0.17.0

package/dist/chat/index.d.cts

@@ -1,3 +1,5 @@
+import { C as CommunityCreatePostParams, a as CommunityCreatedPost, b as CommunityUpdatePostParams, c as CommunityUpdateCommentParams, d as CommunityCreatedComment, e as CommunityVoteResult, f as CommunityCreateCommentParams, g as CommunityFollowResult } from '../types-DF7GprCV.cjs';
+
 /** Configuration for the ChatClient. */
 interface ChatConfig {
     /** Team slug (e.g., 'acme'). Used to identify the team. */
@@ -142,6 +144,25 @@ interface Message {
     /** Whether this message was sent by an AI agent. */
     is_bot?: boolean;
 }
+/** A confirmed customer's message attachment. Never a Storage path or URL. */
+interface CustomerAttachmentReference {
+    readonly ticketId: string;
+    readonly messageId: string;
+    readonly attachmentIndex: number;
+}
+interface AttachmentDownloadOptions {
+    signal?: AbortSignal;
+    /** Request download disposition by default; false allows supported preview types. */
+    download?: boolean;
+}
+/** Authenticated file bytes. The host owns any object URLs it creates for display. */
+interface DownloadedAttachment {
+    blob: Blob;
+    filename: string;
+    contentType: string;
+    /** Actual downloaded byte count, not an unverified metadata size. */
+    size: number;
+}
 /** Parameters for listing tickets. */
 interface TicketListParams {
     limit?: number;
@@ -163,87 +184,11 @@ type MessageCallback = (message: Message) => 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. */
-    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;
+/** Customer file access through the authenticated saved-message boundary. */
+declare class AttachmentsApi {
+    private readonly chat;
+    constructor(chat: ChatClient);
+    download(reference: CustomerAttachmentReference, options?: AttachmentDownloadOptions): Promise<DownloadedAttachment>;
 }
 
 /**
@@ -374,7 +319,8 @@ declare class ChatClient {
     private teamId;
     private customerId;
     private authMode;
-    private pollingTimers;
+    private sessionGeneration;
+    private pollingSubscriptions;
     private stateListeners;
     private realtimeManager;
     private presenceManager;
@@ -384,6 +330,8 @@ declare class ChatClient {
     readonly tickets: TicketsApi;
     /** Sub-resource for managing messages. */
     readonly messages: MessagesApi;
+    /** Authenticated downloads of files on this customer's public messages. */
+    readonly attachments: AttachmentsApi;
     /** Sub-resource for community actions (create posts, vote, comment). Uses the same session as chat. */
     readonly community: ChatCommunityApi;
     constructor(config: ChatConfig);
@@ -418,6 +366,7 @@ declare class ChatClient {
      * every request — there is no client-side validation here.
      */
     loginWithSession(params: LoginWithSessionParams): Promise<void>;
+    private applySession;
     /**
      * Subscribe to client state changes (auth mode flips, identify, disconnect).
      * Fires after the mutation, so listeners reading `getAuthMode()` /
@@ -456,6 +405,10 @@ declare class ChatClient {
     sendTyping(ticketId: string, isTyping: boolean): Promise<void>;
     /** Disconnect all subscriptions and clean up. */
     disconnect(): void;
+    private retireSession;
+    private assertSession;
+    /** @internal Keep a public operation owned across its asynchronous prerequisites. */
+    captureSession(): () => void;
     /**
      * @internal Make an authenticated request to the widget API.
      *
@@ -472,6 +425,9 @@ declare class ChatClient {
         method: string;
         body?: unknown;
         query?: Record<string, string | undefined>;
+        signal?: AbortSignal;
+        cache?: RequestCache;
+        readBody?: (response: Response) => Promise<T>;
     }): Promise<T>;
     /**
      * Look up the team UUID from the configured `teamSlug`. Used by
@@ -496,7 +452,7 @@ declare class ChatClient {
      * `"Missing teamId"` when the chat client was teamSlug-only because the
      * tickets sub-resource read `getTeamId()` synchronously and bailed.
      */
-    ensureTeamId(): Promise<string>;
+    ensureTeamId(signal?: AbortSignal): Promise<string>;
     /** @internal Set team ID from identify response or other source. */
     setTeamId(teamId: string): void;
     /** @internal Wait for realtime to be initialized (for testing). */
@@ -553,4 +509,4 @@ declare class MessagesApi {
     send(ticketId: string, content: string): Promise<Message>;
 }
 
-export { type ChatAuthMode, ChatClient, ChatClientAuthError, ChatClientError, ChatClientNetworkError, ChatClientRateLimitError, ChatClientServerError, type ChatConfig, type ChatStateListener, type IdentifyParams, type IdentifyResult, type LoginWithCredentialsParams, type LoginWithCredentialsResult, type LoginWithSessionParams, type Message, type MessageCallback, type RealtimeTokenResponse, type Ticket, type TicketCreateParams, type TicketListParams, type TicketListResponse, type TypingCallback, type TypingPayload };
+export { type AttachmentDownloadOptions, type ChatAuthMode, ChatClient, ChatClientAuthError, ChatClientError, ChatClientNetworkError, ChatClientRateLimitError, ChatClientServerError, type ChatConfig, type ChatStateListener, type CustomerAttachmentReference, type DownloadedAttachment, type IdentifyParams, type IdentifyResult, type LoginWithCredentialsParams, type LoginWithCredentialsResult, type LoginWithSessionParams, type Message, type MessageCallback, type RealtimeTokenResponse, type Ticket, type TicketCreateParams, type TicketListParams, type TicketListResponse, type TypingCallback, type TypingPayload };

package/dist/chat/index.d.ts

@@ -1,3 +1,5 @@
+import { C as CommunityCreatePostParams, a as CommunityCreatedPost, b as CommunityUpdatePostParams, c as CommunityUpdateCommentParams, d as CommunityCreatedComment, e as CommunityVoteResult, f as CommunityCreateCommentParams, g as CommunityFollowResult } from '../types-DF7GprCV.js';
+
 /** Configuration for the ChatClient. */
 interface ChatConfig {
     /** Team slug (e.g., 'acme'). Used to identify the team. */
@@ -142,6 +144,25 @@ interface Message {
     /** Whether this message was sent by an AI agent. */
     is_bot?: boolean;
 }
+/** A confirmed customer's message attachment. Never a Storage path or URL. */
+interface CustomerAttachmentReference {
+    readonly ticketId: string;
+    readonly messageId: string;
+    readonly attachmentIndex: number;
+}
+interface AttachmentDownloadOptions {
+    signal?: AbortSignal;
+    /** Request download disposition by default; false allows supported preview types. */
+    download?: boolean;
+}
+/** Authenticated file bytes. The host owns any object URLs it creates for display. */
+interface DownloadedAttachment {
+    blob: Blob;
+    filename: string;
+    contentType: string;
+    /** Actual downloaded byte count, not an unverified metadata size. */
+    size: number;
+}
 /** Parameters for listing tickets. */
 interface TicketListParams {
     limit?: number;
@@ -163,87 +184,11 @@ type MessageCallback = (message: Message) => 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. */
-    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;
+/** Customer file access through the authenticated saved-message boundary. */
+declare class AttachmentsApi {
+    private readonly chat;
+    constructor(chat: ChatClient);
+    download(reference: CustomerAttachmentReference, options?: AttachmentDownloadOptions): Promise<DownloadedAttachment>;
 }
 
 /**
@@ -374,7 +319,8 @@ declare class ChatClient {
     private teamId;
     private customerId;
     private authMode;
-    private pollingTimers;
+    private sessionGeneration;
+    private pollingSubscriptions;
     private stateListeners;
     private realtimeManager;
     private presenceManager;
@@ -384,6 +330,8 @@ declare class ChatClient {
     readonly tickets: TicketsApi;
     /** Sub-resource for managing messages. */
     readonly messages: MessagesApi;
+    /** Authenticated downloads of files on this customer's public messages. */
+    readonly attachments: AttachmentsApi;
     /** Sub-resource for community actions (create posts, vote, comment). Uses the same session as chat. */
     readonly community: ChatCommunityApi;
     constructor(config: ChatConfig);
@@ -418,6 +366,7 @@ declare class ChatClient {
      * every request — there is no client-side validation here.
      */
     loginWithSession(params: LoginWithSessionParams): Promise<void>;
+    private applySession;
     /**
      * Subscribe to client state changes (auth mode flips, identify, disconnect).
      * Fires after the mutation, so listeners reading `getAuthMode()` /
@@ -456,6 +405,10 @@ declare class ChatClient {
     sendTyping(ticketId: string, isTyping: boolean): Promise<void>;
     /** Disconnect all subscriptions and clean up. */
     disconnect(): void;
+    private retireSession;
+    private assertSession;
+    /** @internal Keep a public operation owned across its asynchronous prerequisites. */
+    captureSession(): () => void;
     /**
      * @internal Make an authenticated request to the widget API.
      *
@@ -472,6 +425,9 @@ declare class ChatClient {
         method: string;
         body?: unknown;
         query?: Record<string, string | undefined>;
+        signal?: AbortSignal;
+        cache?: RequestCache;
+        readBody?: (response: Response) => Promise<T>;
     }): Promise<T>;
     /**
      * Look up the team UUID from the configured `teamSlug`. Used by
@@ -496,7 +452,7 @@ declare class ChatClient {
      * `"Missing teamId"` when the chat client was teamSlug-only because the
      * tickets sub-resource read `getTeamId()` synchronously and bailed.
      */
-    ensureTeamId(): Promise<string>;
+    ensureTeamId(signal?: AbortSignal): Promise<string>;
     /** @internal Set team ID from identify response or other source. */
     setTeamId(teamId: string): void;
     /** @internal Wait for realtime to be initialized (for testing). */
@@ -553,4 +509,4 @@ declare class MessagesApi {
     send(ticketId: string, content: string): Promise<Message>;
 }
 
-export { type ChatAuthMode, ChatClient, ChatClientAuthError, ChatClientError, ChatClientNetworkError, ChatClientRateLimitError, ChatClientServerError, type ChatConfig, type ChatStateListener, type IdentifyParams, type IdentifyResult, type LoginWithCredentialsParams, type LoginWithCredentialsResult, type LoginWithSessionParams, type Message, type MessageCallback, type RealtimeTokenResponse, type Ticket, type TicketCreateParams, type TicketListParams, type TicketListResponse, type TypingCallback, type TypingPayload };
+export { type AttachmentDownloadOptions, type ChatAuthMode, ChatClient, ChatClientAuthError, ChatClientError, ChatClientNetworkError, ChatClientRateLimitError, ChatClientServerError, type ChatConfig, type ChatStateListener, type CustomerAttachmentReference, type DownloadedAttachment, type IdentifyParams, type IdentifyResult, type LoginWithCredentialsParams, type LoginWithCredentialsResult, type LoginWithSessionParams, type Message, type MessageCallback, type RealtimeTokenResponse, type Ticket, type TicketCreateParams, type TicketListParams, type TicketListResponse, type TypingCallback, type TypingPayload };