@futdevpro/fsm-dynamo 1.14.14 → 1.14.16

package/src/_modules/messaging/README.md

@@ -0,0 +1,279 @@
+# Dynamo FSM Messaging Module [DyFM-MSG]
+
+TODO: The Entire Messaging system is AI generated, therefore we need to clean it up, and remove the unnecessary elements
+
+## Overview
+
+The Messaging module provides a unified messaging system for user↔user and user↔AI communication across all Dynamo Systems. It serves as the foundation for messaging functionality by defining core data models, enums, and interfaces that are shared across Dynamo packages (FSM, NTS, NGX).
+
+This module follows a **model-first approach**, providing type-safe interfaces and data models for the entire messaging infrastructure.
+
+## Import
+
+```typescript
+import * from '@futdevpro/fsm-dynamo/messaging';
+```
+
+## Key Features
+
+- **Unified Message Schema**: Single core for user↔user and user↔Assistant/Agent messaging
+- **Real-time Communication**: Socket-based event handling for live updates
+- **Agent Integration**: Support for AI agent process visualization and reasoning
+- **Message Types**: Text, attachments, reactions, mentions, threads
+- **Conversation Management**: Direct, group, assistant chat, agent process, channel conversations
+- **Participant Roles**: Owner, admin, member, viewer with permission management
+- **Message Status Tracking**: Draft, sending, sent, delivered, read, failed, deleted
+- **Attachment Support**: Images, videos, documents, audio, files
+- **Reaction System**: Emoji-based message reactions
+- **Thread Support**: Reply chains and conversation threading
+- **Agent Process Visualization**: Step-by-step AI reasoning display
+
+## Architecture
+
+The messaging module is organized into:
+
+- **Enums**: Type definitions and status enumerations
+- **Models**: Data models and interfaces
+- **Collections**: Module settings and constants
+- **Agent Module**: AI agent process tracking sub-module
+
+## Enums
+
+### `DyFM_Msg_Type`
+Defines message types:
+- `text` - Regular text message
+- `userToUser` - User-to-user message
+- `userToAi` - User-to-AI message
+- `aiToUser` - AI-to-user message
+- `system` - System-generated message
+- `agentProcess` - Agent process message
+
+### `DyFM_Msg_Status`
+Message status lifecycle:
+- `draft` - Message is being drafted
+- `sending` - Message is being sent
+- `sent` - Message was sent successfully
+- `delivered` - Message was delivered to recipient(s)
+- `read` - Message was read by recipient(s)
+- `failed` - Message sending failed
+- `deleted` - Message was deleted
+
+### `DyFM_Msg_ConversationType`
+Conversation type definitions:
+- `direct` - One-on-one conversation
+- `group` - Group conversation
+- `assistantChat` - Conversation with AI assistant
+- `agentProcess` - Agent process conversation
+- `channel` - Channel-based conversation
+
+### `DyFM_Msg_ParticipantRole`
+Participant role hierarchy:
+- `owner` - Conversation owner
+- `admin` - Conversation administrator
+- `member` - Regular member
+- `viewer` - Read-only viewer
+
+### `DyFM_Msg_AttachmentType`
+Attachment type definitions:
+- `image` - Image attachments
+- `video` - Video attachments
+- `document` - Document attachments
+- `audio` - Audio file attachments
+- `file` - Generic file attachments
+
+### `DyFM_Msg_EventKey`
+Socket event keys for real-time communication:
+- `messageSent` - New message sent
+- `messageUpdated` - Message updated
+- `messageDeleted` - Message deleted
+- `messageRead` - Message read
+- `typingStart` - User started typing
+- `typingStop` - User stopped typing
+- `reactionAdded` - Reaction added to message
+- `reactionRemoved` - Reaction removed from message
+- `conversationCreated` - New conversation created
+- `conversationUpdated` - Conversation updated
+- `conversationDeleted` - Conversation deleted
+- `participantAdded` - Participant added
+- `participantRemoved` - Participant removed
+
+## Models
+
+### `DyFM_Msg_Message`
+Core message data model with comprehensive message properties:
+
+```typescript
+class DyFM_Msg_Message extends DyFM_Metadata {
+  conversationId: string;
+  content: string;
+  type: DyFM_Msg_Type;
+  status: DyFM_Msg_Status;
+  senderId: string;
+  senderName?: string;
+  senderDisplayName?: string;
+  recipientIds?: string[];
+  parentMessageId?: string;
+  threadId?: string;
+  threadInfo?: DyFM_Msg_ThreadInfo;
+  attachments?: DyFM_Msg_Attachment[];
+  mentions?: DyFM_Msg_Mention[];
+  reactions?: DyFM_Msg_Reaction[];
+  aiProvider?: string;
+  aiModel?: string;
+  isAIGenerated?: boolean;
+  systemPrompt?: string;
+  agentProcessSteps?: DyFM_Agt_ProcessStep[];
+  platformSource?: string;
+  platformMessageId?: string;
+  deliveryStatus?: DyFM_Msg_DeliveryStatus;
+  // ... metadata fields
+}
+```
+
+### `DyFM_Msg_Conversation`
+Conversation data model:
+
+```typescript
+class DyFM_Msg_Conversation extends DyFM_Metadata {
+  type: DyFM_Msg_ConversationType;
+  name?: string;
+  participants: DyFM_Msg_Participant[];
+  lastMessage?: {
+    messageId: string;
+    content: string;
+    sentAt: Date;
+    senderId: string;
+  };
+  lastReadByUser?: Record<string, Date>;
+  // ... metadata fields
+}
+```
+
+### `DyFM_Msg_Participant`
+Participant interface:
+
+```typescript
+interface DyFM_Msg_Participant {
+  userId: string;
+  role: DyFM_Msg_ParticipantRole;
+  joinedAt: Date;
+  leftAt?: Date;
+  isMuted?: boolean;
+  isArchived?: boolean;
+}
+```
+
+### `DyFM_Msg_Attachment`
+Attachment interface:
+
+```typescript
+interface DyFM_Msg_Attachment {
+  id: string;
+  name: string;
+  type: DyFM_Msg_AttachmentType;
+  url: string;
+  size?: number;
+  mimeType?: string;
+  thumbnailUrl?: string;
+  uploadedAt: Date;
+}
+```
+
+### `DyFM_Msg_Reaction`
+Reaction interface:
+
+```typescript
+interface DyFM_Msg_Reaction {
+  emoji: string;
+  userId: string;
+  reactedAt: Date;
+}
+```
+
+### `DyFM_Msg_Mention`
+Mention interface:
+
+```typescript
+interface DyFM_Msg_Mention {
+  userId: string;
+  username?: string;
+  offset: number;
+  length: number;
+}
+```
+
+### `DyFM_Msg_ThreadInfo`
+Thread information interface:
+
+```typescript
+interface DyFM_Msg_ThreadInfo {
+  threadId: string;
+  replyCount: number;
+  lastReplyAt?: Date;
+}
+```
+
+## Agent Module
+
+The agent sub-module provides AI agent process tracking:
+
+### Enums
+
+- `DyFM_Agt_ProcessStepType` - Agent process step types
+- `DyFM_Agt_ToolStatus` - Tool usage status
+
+### Interfaces
+
+- `DyFM_Agt_ProcessStep` - Agent reasoning step
+- `DyFM_Agt_ReasoningInfo` - AI reasoning information
+- `DyFM_Agt_ToolUsage` - Tool usage tracking
+
+## Usage Examples
+
+### Creating a Message Model
+
+```typescript
+import { DyFM_Msg_Message, DyFM_Msg_Type, DyFM_Msg_Status } from '@futdevpro/fsm-dynamo/messaging';
+
+const message = new DyFM_Msg_Message({
+  conversationId: 'conv-123',
+  senderId: 'user-456',
+  content: 'Hello, world!',
+  type: DyFM_Msg_Type.text,
+  status: DyFM_Msg_Status.draft,
+  sentAt: new Date(),
+  __createdBy: 'user-456',
+});
+```
+
+### Creating a Conversation Model
+
+```typescript
+import { DyFM_Msg_Conversation, DyFM_Msg_ConversationType } from '@futdevpro/fsm-dynamo/messaging';
+
+const conversation = new DyFM_Msg_Conversation({
+  type: DyFM_Msg_ConversationType.direct,
+  participants: [
+    { userId: 'user-123', role: DyFM_Msg_ParticipantRole.member, joinedAt: new Date() },
+    { userId: 'user-456', role: DyFM_Msg_ParticipantRole.member, joinedAt: new Date() }
+  ],
+  __createdBy: 'user-123',
+});
+```
+
+## Integration
+
+This FSM module provides the foundation for:
+
+- **Dynamo NTS**: Backend implementation using these models
+- **Dynamo NGX**: Frontend Angular components using these types
+- **Bot Module**: Integration with bot providers
+- **Assistant Module**: AI assistant workflows
+
+All Dynamo packages import and extend these models for their specific implementations.
+
+## Related Documentation
+
+- [Dynamo NTS Messaging Module](../dynamo-nts/messaging/README.md)
+- [Dynamo NGX Messaging Module](../dynamo-ngx/messaging/README.md)
+- [Messaging System Architecture](../../../specifications/messaging-system-architecture.md)

package/src/_modules/messaging/_enums/msg-provider-type.enum.ts

@@ -0,0 +1,7 @@
+export enum DyNTS_Msg_Provider_Type {
+  discord = 'discord',
+  slack = 'slack',
+  teams = 'teams',
+  dynamo = 'dynamo',
+  custom = 'custom'
+}

package/src/_modules/messaging/index.ts

@@ -11,6 +11,7 @@ export * from './_enums/msg-status.enum';
 export * from './_enums/msg-delivery-status.enum';
 export * from './_enums/msg-conversation-type.enum';
 export * from './_enums/msg-participant-role.enum';
+export * from './_enums/msg-provider-type.enum';
 export * from './_enums/msg-attachment-type.enum';
 export * from './_enums/msg-event-key.enum';