@linktr.ee/messaging-react 1.0.0 → 1.0.1

package/src/types.ts

@@ -0,0 +1,113 @@
+import type { Channel } from 'stream-chat';
+import type { MessagingUser, StreamChatServiceConfig } from '@linktr.ee/messaging-core';
+
+/**
+ * Generic participant interface for different host environments
+ */
+export interface Participant {
+  id: string;
+  name: string;
+  email?: string;
+  image?: string;
+  username?: string;
+  phone?: string;
+  metadata?: Record<string, any>;
+}
+
+/**
+ * Source for loading participants (followers, team members, etc.)
+ */
+export interface ParticipantSource {
+  loadParticipants: (options?: { 
+    search?: string; 
+    limit?: number; 
+    cursor?: string;
+  }) => Promise<{
+    participants: Participant[];
+    hasMore: boolean;
+    nextCursor?: string;
+  }>;
+  totalCount?: number;
+  loading?: boolean;
+}
+
+/**
+ * Messaging capabilities configuration
+ */
+export interface MessagingCapabilities {
+  showStartConversation?: boolean;
+  participantSource?: ParticipantSource;
+  participantLabel?: string; // e.g., "followers", "team members"
+}
+
+/**
+ * Customization options
+ */
+export interface MessagingCustomization {
+  theme?: 'light' | 'dark' | 'auto';
+  accentColor?: string;
+  showParticipantStatus?: boolean;
+}
+
+/**
+ * Main MessagingShell component props
+ */
+export interface MessagingShellProps {
+  capabilities?: MessagingCapabilities;
+  customization?: MessagingCustomization;
+  className?: string;
+  renderMessageInputActions?: (channel: Channel) => React.ReactNode;
+  onChannelSelect?: (channel: Channel) => void;
+  onParticipantSelect?: (participant: Participant) => void;
+}
+
+/**
+ * ChannelList component props
+ */
+export interface ChannelListProps {
+  onChannelSelect: (channel: Channel) => void;
+  selectedChannel?: Channel;
+  showStartConversation?: boolean;
+  onStartConversation?: () => void;
+  participantLabel?: string;
+  className?: string;
+}
+
+/**
+ * ChannelView component props
+ */
+export interface ChannelViewProps {
+  channel: Channel;
+  onBack?: () => void;
+  showBackButton?: boolean;
+  renderMessageInputActions?: (channel: Channel) => React.ReactNode;
+  onLeaveConversation?: (channel: Channel) => void;
+  onBlockParticipant?: (participantId?: string) => void;
+  className?: string;
+}
+
+/**
+ * ParticipantPicker component props
+ */
+export interface ParticipantPickerProps {
+  participantSource: ParticipantSource;
+  onSelectParticipant: (participant: Participant) => void;
+  onClose: () => void;
+  existingParticipantIds?: Set<string>;
+  participantLabel?: string;
+  searchPlaceholder?: string;
+  className?: string;
+}
+
+/**
+ * MessagingProvider component props
+ */
+export interface MessagingProviderProps {
+  children: React.ReactNode;
+  user: MessagingUser | null;
+  serviceConfig: Omit<StreamChatServiceConfig, 'apiKey'>;
+  apiKey: string;
+  capabilities?: MessagingCapabilities;
+  customization?: MessagingCustomization;
+  debug?: boolean;
+}