@pocketping/widget 1.1.0 → 1.2.0

package/dist/index.d.cts

@@ -65,6 +65,16 @@ interface PocketPingConfig {
     onVersionWarning?: (warning: VersionWarning) => void;
 }
 type MessageStatus = 'sending' | 'sent' | 'delivered' | 'read';
+type AttachmentStatus = 'pending' | 'uploading' | 'ready' | 'failed';
+interface Attachment {
+    id: string;
+    filename: string;
+    mimeType: string;
+    size: number;
+    url: string;
+    thumbnailUrl?: string;
+    status: AttachmentStatus;
+}
 interface Message {
     id: string;
     sessionId: string;
@@ -73,9 +83,12 @@ interface Message {
     timestamp: string;
     replyTo?: string;
     metadata?: Record<string, unknown>;
+    attachments?: Attachment[];
     status?: MessageStatus;
     deliveredAt?: string;
     readAt?: string;
+    editedAt?: string;
+    deletedAt?: string;
 }
 interface Session {
     sessionId: string;
@@ -191,10 +204,44 @@ declare class PocketPingClient {
     constructor(config: ResolvedPocketPingConfig);
     connect(): Promise<Session>;
     disconnect(): void;
-    sendMessage(content: string): Promise<Message>;
+    sendMessage(content: string, attachmentIds?: string[], replyTo?: string): Promise<Message>;
+    /**
+     * Upload a file attachment
+     * Returns the attachment data after successful upload
+     * @param file - File object to upload
+     * @param onProgress - Optional callback for upload progress (0-100)
+     * @example
+     * const attachment = await PocketPing.uploadFile(file, (progress) => {
+     *   console.log(`Upload ${progress}% complete`)
+     * })
+     * await PocketPing.sendMessage('Check this file', [attachment.id])
+     */
+    uploadFile(file: File, onProgress?: (progress: number) => void): Promise<Attachment>;
+    /**
+     * Upload multiple files at once
+     * @param files - Array of File objects to upload
+     * @param onProgress - Optional callback for overall progress (0-100)
+     * @returns Array of uploaded attachments
+     */
+    uploadFiles(files: File[], onProgress?: (progress: number) => void): Promise<Attachment[]>;
+    /**
+     * Upload file to presigned URL with progress tracking
+     */
+    private uploadToPresignedUrl;
     fetchMessages(after?: string): Promise<Message[]>;
     sendTyping(isTyping?: boolean): Promise<void>;
     sendReadStatus(messageIds: string[], status: MessageStatus): Promise<void>;
+    /**
+     * Edit a message (visitor can only edit their own messages)
+     * @param messageId - ID of the message to edit
+     * @param content - New content for the message
+     */
+    editMessage(messageId: string, content: string): Promise<Message>;
+    /**
+     * Delete a message (soft delete - visitor can only delete their own messages)
+     * @param messageId - ID of the message to delete
+     */
+    deleteMessage(messageId: string): Promise<boolean>;
     getPresence(): Promise<PresenceResponse>;
     /**
      * Identify the current user with metadata
@@ -315,7 +362,30 @@ declare function destroy(): void;
 declare function open(): void;
 declare function close(): void;
 declare function toggle(): void;
-declare function sendMessage(content: string): Promise<Message>;
+declare function sendMessage(content: string, attachmentIds?: string[]): Promise<Message>;
+/**
+ * Upload a file attachment
+ * Returns the attachment data after successful upload
+ * @param file - File object to upload
+ * @param onProgress - Optional callback for upload progress (0-100)
+ * @example
+ * const attachment = await PocketPing.uploadFile(file, (progress) => {
+ *   console.log(`Upload ${progress}% complete`)
+ * })
+ * await PocketPing.sendMessage('Check this file', [attachment.id])
+ */
+declare function uploadFile(file: File, onProgress?: (progress: number) => void): Promise<Attachment>;
+/**
+ * Upload multiple files at once
+ * @param files - Array of File objects to upload
+ * @param onProgress - Optional callback for overall progress (0-100)
+ * @returns Array of uploaded attachments
+ * @example
+ * const attachments = await PocketPing.uploadFiles(files)
+ * const ids = attachments.map(a => a.id)
+ * await PocketPing.sendMessage('Here are the files', ids)
+ */
+declare function uploadFiles(files: File[], onProgress?: (progress: number) => void): Promise<Attachment[]>;
 /**
  * Trigger a custom event to the backend
  * @param eventName - The name of the event (e.g., 'clicked_pricing', 'viewed_demo')
@@ -413,6 +483,8 @@ declare const _default: {
     close: typeof close;
     toggle: typeof toggle;
     sendMessage: typeof sendMessage;
+    uploadFile: typeof uploadFile;
+    uploadFiles: typeof uploadFiles;
     trigger: typeof trigger;
     onEvent: typeof onEvent;
     offEvent: typeof offEvent;
@@ -424,4 +496,4 @@ declare const _default: {
     getTrackedElements: typeof getTrackedElements;
 };
 
-export { type CustomEvent, type CustomEventHandler, type Message, type PocketPingConfig, type TrackedElement, type TriggerOptions, type UserIdentity, type VersionWarning, close, _default as default, destroy, getIdentity, getTrackedElements, identify, init, offEvent, on, onEvent, open, reset, sendMessage, setupTrackedElements, toggle, trigger };
+export { type Attachment, type CustomEvent, type CustomEventHandler, type Message, type PocketPingConfig, type TrackedElement, type TriggerOptions, type UserIdentity, type VersionWarning, close, _default as default, destroy, getIdentity, getTrackedElements, identify, init, offEvent, on, onEvent, open, reset, sendMessage, setupTrackedElements, toggle, trigger, uploadFile, uploadFiles };

package/dist/index.d.ts

@@ -65,6 +65,16 @@ interface PocketPingConfig {
     onVersionWarning?: (warning: VersionWarning) => void;
 }
 type MessageStatus = 'sending' | 'sent' | 'delivered' | 'read';
+type AttachmentStatus = 'pending' | 'uploading' | 'ready' | 'failed';
+interface Attachment {
+    id: string;
+    filename: string;
+    mimeType: string;
+    size: number;
+    url: string;
+    thumbnailUrl?: string;
+    status: AttachmentStatus;
+}
 interface Message {
     id: string;
     sessionId: string;
@@ -73,9 +83,12 @@ interface Message {
     timestamp: string;
     replyTo?: string;
     metadata?: Record<string, unknown>;
+    attachments?: Attachment[];
     status?: MessageStatus;
     deliveredAt?: string;
     readAt?: string;
+    editedAt?: string;
+    deletedAt?: string;
 }
 interface Session {
     sessionId: string;
@@ -191,10 +204,44 @@ declare class PocketPingClient {
     constructor(config: ResolvedPocketPingConfig);
     connect(): Promise<Session>;
     disconnect(): void;
-    sendMessage(content: string): Promise<Message>;
+    sendMessage(content: string, attachmentIds?: string[], replyTo?: string): Promise<Message>;
+    /**
+     * Upload a file attachment
+     * Returns the attachment data after successful upload
+     * @param file - File object to upload
+     * @param onProgress - Optional callback for upload progress (0-100)
+     * @example
+     * const attachment = await PocketPing.uploadFile(file, (progress) => {
+     *   console.log(`Upload ${progress}% complete`)
+     * })
+     * await PocketPing.sendMessage('Check this file', [attachment.id])
+     */
+    uploadFile(file: File, onProgress?: (progress: number) => void): Promise<Attachment>;
+    /**
+     * Upload multiple files at once
+     * @param files - Array of File objects to upload
+     * @param onProgress - Optional callback for overall progress (0-100)
+     * @returns Array of uploaded attachments
+     */
+    uploadFiles(files: File[], onProgress?: (progress: number) => void): Promise<Attachment[]>;
+    /**
+     * Upload file to presigned URL with progress tracking
+     */
+    private uploadToPresignedUrl;
     fetchMessages(after?: string): Promise<Message[]>;
     sendTyping(isTyping?: boolean): Promise<void>;
     sendReadStatus(messageIds: string[], status: MessageStatus): Promise<void>;
+    /**
+     * Edit a message (visitor can only edit their own messages)
+     * @param messageId - ID of the message to edit
+     * @param content - New content for the message
+     */
+    editMessage(messageId: string, content: string): Promise<Message>;
+    /**
+     * Delete a message (soft delete - visitor can only delete their own messages)
+     * @param messageId - ID of the message to delete
+     */
+    deleteMessage(messageId: string): Promise<boolean>;
     getPresence(): Promise<PresenceResponse>;
     /**
      * Identify the current user with metadata
@@ -315,7 +362,30 @@ declare function destroy(): void;
 declare function open(): void;
 declare function close(): void;
 declare function toggle(): void;
-declare function sendMessage(content: string): Promise<Message>;
+declare function sendMessage(content: string, attachmentIds?: string[]): Promise<Message>;
+/**
+ * Upload a file attachment
+ * Returns the attachment data after successful upload
+ * @param file - File object to upload
+ * @param onProgress - Optional callback for upload progress (0-100)
+ * @example
+ * const attachment = await PocketPing.uploadFile(file, (progress) => {
+ *   console.log(`Upload ${progress}% complete`)
+ * })
+ * await PocketPing.sendMessage('Check this file', [attachment.id])
+ */
+declare function uploadFile(file: File, onProgress?: (progress: number) => void): Promise<Attachment>;
+/**
+ * Upload multiple files at once
+ * @param files - Array of File objects to upload
+ * @param onProgress - Optional callback for overall progress (0-100)
+ * @returns Array of uploaded attachments
+ * @example
+ * const attachments = await PocketPing.uploadFiles(files)
+ * const ids = attachments.map(a => a.id)
+ * await PocketPing.sendMessage('Here are the files', ids)
+ */
+declare function uploadFiles(files: File[], onProgress?: (progress: number) => void): Promise<Attachment[]>;
 /**
  * Trigger a custom event to the backend
  * @param eventName - The name of the event (e.g., 'clicked_pricing', 'viewed_demo')
@@ -413,6 +483,8 @@ declare const _default: {
     close: typeof close;
     toggle: typeof toggle;
     sendMessage: typeof sendMessage;
+    uploadFile: typeof uploadFile;
+    uploadFiles: typeof uploadFiles;
     trigger: typeof trigger;
     onEvent: typeof onEvent;
     offEvent: typeof offEvent;
@@ -424,4 +496,4 @@ declare const _default: {
     getTrackedElements: typeof getTrackedElements;
 };
 
-export { type CustomEvent, type CustomEventHandler, type Message, type PocketPingConfig, type TrackedElement, type TriggerOptions, type UserIdentity, type VersionWarning, close, _default as default, destroy, getIdentity, getTrackedElements, identify, init, offEvent, on, onEvent, open, reset, sendMessage, setupTrackedElements, toggle, trigger };
+export { type Attachment, type CustomEvent, type CustomEventHandler, type Message, type PocketPingConfig, type TrackedElement, type TriggerOptions, type UserIdentity, type VersionWarning, close, _default as default, destroy, getIdentity, getTrackedElements, identify, init, offEvent, on, onEvent, open, reset, sendMessage, setupTrackedElements, toggle, trigger, uploadFile, uploadFiles };