@futdevpro/fsm-dynamo 1.20.9 → 1.20.10

package/src/_modules/location/_collections/loc.util.ts

@@ -1,74 +0,0 @@
-
-import { DyFM_Error } from '../../../_models/control-models/error.control-model';
-import { DyFM_Trigonometry } from '../../../_collections/utils/math/trigonometry.util';
-import {
-  DyFM_LocationCoordinates
-} from '../_models/loc-coordinates.interface';
-
-/**
- * Helper utilities for geographic calculations.
- */
-export class DyFM_Location {
-  /**
-   * Calculates the distance between two coordinates using the haversine formula.
-   */
-  static getDistanceInKilometres(
-    from: DyFM_LocationCoordinates,
-    to: DyFM_LocationCoordinates
-  ): number {
-
-    const R = 6371; // kilometres
-    const φ1 = DyFM_Trigonometry.angleToRadians(from.latitude);
-    const φ2 = DyFM_Trigonometry.angleToRadians(to.latitude);
-    const Δφ = DyFM_Trigonometry.angleToRadians(to.latitude - from.latitude);
-    const Δλ = DyFM_Trigonometry.angleToRadians(to.longitude - from.longitude);
-
-    const a = Math.sin(Δφ / 2) * Math.sin(Δφ / 2) +
-              Math.cos(φ1) * Math.cos(φ2) *
-              Math.sin(Δλ / 2) * Math.sin(Δλ / 2);
-    const c = 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a));
-
-    return R * c;
-  }
-
-  /**
-   * Converts a distance in kilometers to degree difference for latitude or longitude.
-   * @param latiOrLong The direction to convert to degrees.
-   * @param distanceInKm The distance in kilometers.
-   * @param latitude The latitude to use for the conversion.
-   * @returns The degree difference.
-   * 
-   * @example
-   * ```ts
-   * const degreeChange = DyFM_Location.getLocationDegByKilometers('latitude', 110.574);
-   * console.log(degreeChange); // 1
-   * ```
-   */
-  static getLocationDegByKilometers(
-    latiOrLong: 'latitude' | 'longitude',
-    distanceInKm: number,
-    latitude?: number
-  ): number {
-    if (latiOrLong === 'latitude') {
-      return distanceInKm / 110.574;
-    } else {
-      if (latitude) {
-        return distanceInKm / (Math.cos(DyFM_Trigonometry.angleToRadians(latitude)) * 111.320);
-      } else {
-        throw new DyFM_Error({ 
-          status: 417, 
-          errorCode: 'FSM-DSS-505',
-          addECToUserMsg: true,
-          message: 
-            `When using getLocationDegByKilometers for longitude, you need to give latitude! ` +
-            `(latiOrLong: ${latiOrLong}, distanceInKm: ${distanceInKm}, latitude: ${latitude})`,
-          userMessage: 
-            `We encountered an uncought BackEnd Error, ` +
-            `please contact the responsible development team.`,
-        });
-      }
-    }
-  }
-}
-
-

package/src/_modules/location/_enums/loc-region.enum.ts

@@ -1,14 +0,0 @@
-
-
-
-/**
- * Continents and large geographic regions.
- */
-export enum DyFM_Region {
-  europe = 'Europe',
-  asia = 'Asia',
-  africa = 'Africa',
-  oceania = 'Oceania',
-  americas = 'Americas',
-}
-

package/src/_modules/location/_enums/loc-sub-region.enum.ts

@@ -1,31 +0,0 @@
-
-
-
-/**
- * List of geographic subregions.
- */
-export enum DyFM_SubRegion {
-  northernEurope = 'Northern Europe',
-  southernEurope = 'Southern Europe',
-  westernEurope = 'Western Europe',
-  easternEurope = 'Eastern Europe',
-
-  northernAfrica = 'Northern Africa',
-  subSaharanAfrica = 'Sub-Saharan Africa',
-
-  northernAmerica = 'Northern America',
-  latinAmericaAndTheCaribbean = 'Latin America and the Caribbean',
-
-  southEasternAsia = 'South-eastern Asia',
-  easternAsia = 'Eastern Asia',
-  southernAsia = 'Southern Asia',
-  
-  westernAsia = 'Western Asia',
-  centralAsia = 'Central Asia',
-
-  australiaAndNewZealand = 'Australia and New Zealand',
-  melanesia = 'Melanesia',
-  micronesia = 'Micronesia',
-  polynesia = 'Polynesia',
-}
-

package/src/_modules/location/_enums/loc-subdivision-region-type.enum.ts

@@ -1,47 +0,0 @@
-
-
-/**
- * Types of administrative divisions.
- */
-export enum DyFM_SubdivisionRegionType {
-  parish,                 // smaller church administrative region
-  emirate,               // territories ruled by an emir
-  province,              // first-level subdivision in many countries
-  dependency,            // territories dependent on another state
-  county,                // common administrative unit
-  city,                  // incorporated municipality
-  region,                // generic region type
-  state,                 // first-level political subdivision
-  territory,             // land under a jurisdiction
-  autonomousRepublic,    // self-governing republic inside a country
-  municipate,            // municipality-like entity
-  rayon,                 // district used in some post-Soviet states
-  division,              // general division level
-  district,              // smaller subdivision within a state
-  governorate,           // province headed by a governor
-  department,            // used in several countries like France
-  specialMunicipality,   // municipality with special status
-  federalDistrict,       // district under federal jurisdiction
-  island,                // geographic island region
-  town,                  // small urban area
-  oblast,                // administrative region in Slavic countries
-  commune,               // community-level division
-  prefecture,            // prefectural region as in Japan
-  economicPrefecture,    // economic focused prefecture
-  canton,                // administrative division, e.g., Switzerland
-  autonomousRegion,      // region with high autonomy
-  specialAdministrativeRegion, // SAR like Hong Kong
-  capitalDistrict,       // district for capital
-  geographicalRegion,    // purely geographic region
-  capitalCity,           // denotes the capital city
-  ruralMunicipality,     // rural municipality
-  urbanMunicipality,     // urban municipality
-  autonomousCommunity,   // e.g., Spain's communities
-  autonomousCity,        // autonomous city
-  administration,
-  regionalState,
-  metropolitanRegion,
-  overseasCollectivity,
-  // ... reduce specials // non-finished
-} 
-

package/src/_modules/location/_models/loc-coordinates.interface.ts

@@ -1,7 +0,0 @@
-
-
-/** Geographic coordinates with longitude and latitude. */
-export interface DyFM_LocationCoordinates {
-  longitude: number;
-  latitude: number;
-}

package/src/_modules/location/_models/loc-country-division.interface.ts

@@ -1,8 +0,0 @@
-
-
-
-export interface DyFM_CountryDivision {
-  iso: string;
-  code: string;
-  name: string;
-}

package/src/_modules/location/_models/loc-country-iso.interface.ts

@@ -1,23 +0,0 @@
-
-
-import { DyFM_Region } from '../_enums/loc-region.enum';
-import { DyFM_SubRegion } from '../_enums/loc-sub-region.enum';
-import { DyFM_CountryDivision } from './loc-country-division.interface';
-
-
-
-export interface DyFM_CountryISO {
-  name: string;
-  iso2: string;
-  iso3: string;
-  countryCode: string;
-  fullIso: string;
-  region: DyFM_Region;
-  regionCode: string;
-  subRegion: DyFM_SubRegion;
-  subRegionCode: string;
-  subdivisionRegion: string;
-  subdivisionRegionCode: string;
-  phoneCode?: string;
-  divisions?: DyFM_CountryDivision[];
-}

package/src/_modules/location/_models/loc-country-phone-code.interface.ts

@@ -1,9 +0,0 @@
-
-
-
-export interface DyFM_CountryPhoneCode {
-  iso: string;
-  country: string;
-  code: string;
-}
-

package/src/_modules/location/_models/loc-division-collection.interface.ts

@@ -1,12 +0,0 @@
-
-
-
-export interface DyFM_Division_Collection {
-  [iso2: string]: {
-    name: string;
-    divisions: {
-      [divisionCode: string]: string
-    }
-  }
-}
-

package/src/_modules/location/_models/loc-division-region-data.interface.ts

@@ -1,9 +0,0 @@
-import { DyFM_SubdivisionRegionType } from '../_enums/loc-subdivision-region-type.enum';
-import { DyFM_CountryISO } from './loc-country-iso.interface';
-
-
-export interface DyFM_SubdivisionRegionData extends DyFM_CountryISO {  
-  type?: DyFM_SubdivisionRegionType;
-}
-
-

package/src/_modules/location/_models/loc-geo-ip-location.interface.ts

@@ -1,27 +0,0 @@
-
-
-export interface DyFM_GeoIpLocation {
-  /** [ <low bound of IP block>, <high bound of IP block> ] */
-  range: [number, number];
-  /** 2 letter ISO-3166-1 country code https://www.iban.com/country-codes */
-  country: string;
-  /**
-   * Up to 3 alphanumeric variable length characters as ISO 3166-2 code
-   * For US states this is the 2 letter state
-   * For the United Kingdom this could be ENG as a country like “England
-   * FIPS 10-4 subcountry code
-   */
-  region: string;
-  /** 1 if the country is a member state of the European Union, 0 otherwise. */
-  eu: '1' | '0';
-  /** "Country/Zone" Timezone from IANA Time Zone Database */
-  timezone: string;
-  /** This is the full city name */
-  city: string;
-  /** The latitude and longitude of the city */
-  ll: [number, number];
-  /** Metro code */
-  metro: number;
-  /** The approximate accuracy radius (km), around the latitude and longitude */
-  area: number;
-}

package/src/_modules/location/index.ts

@@ -1,22 +0,0 @@
-
-// ENUMS
-export * from './_enums/loc-region.enum';
-export * from './_enums/loc-sub-region.enum';
-export * from './_enums/loc-subdivision-region-type.enum';
-
-// COLLECTIONS
-export * from './_collections/loc-country-divisions.const';
-export * from './_collections/loc-country-isos.const';
-export * from './_collections/loc.util';
-export * from './_collections/loc-regions.util';
-
-// INTERFACES
-export * from './_models/loc-country-division.interface';
-export * from './_models/loc-country-iso.interface';
-export * from './_models/loc-country-phone-code.interface';
-export * from './_models/loc-division-collection.interface';
-export * from './_models/loc-division-region-data.interface';
-export * from './_models/loc-geo-ip-location.interface';
-export * from './_models/loc-coordinates.interface';
-
-

package/src/_modules/messaging/README.md

@@ -1,279 +0,0 @@
-# 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/_collections/msg-module-settings.const.ts

@@ -1,46 +0,0 @@
-import { DyFM_Route_Settings } from '../../../_models/interfaces/route-settings.interface';
-
-/**
- * Available messaging routes/endpoints
- */
-export enum DyFM_MsgRoute {
-  getConversations = 'getConversations',
-  getConversation = 'getConversation',
-  createConversation = 'createConversation',
-  updateConversation = 'updateConversation',
-  deleteConversation = 'deleteConversation',
-  getMessages = 'getMessages',
-  sendMessage = 'sendMessage',
-  editMessage = 'editMessage',
-  deleteMessage = 'deleteMessage',
-  markAsRead = 'markAsRead',
-  addReaction = 'addReaction',
-  removeReaction = 'removeReaction',
-  addParticipant = 'addParticipant',
-  removeParticipant = 'removeParticipant',
-  getAgentProcess = 'getAgentProcess',
-}
-
-/**
- * Messaging module route settings
- */
-export const DyFM_msgModule_settings: DyFM_Route_Settings<DyFM_MsgRoute> = {
-  mainRoute: '/messaging',
-  endPoints: {
-    [DyFM_MsgRoute.getConversations]: '/conversations',
-    [DyFM_MsgRoute.getConversation]: '/conversations/:conversationId',
-    [DyFM_MsgRoute.createConversation]: '/conversations/create',
-    [DyFM_MsgRoute.updateConversation]: '/conversations/:conversationId',
-    [DyFM_MsgRoute.deleteConversation]: '/conversations/:conversationId',
-    [DyFM_MsgRoute.getMessages]: '/conversations/:conversationId/messages',
-    [DyFM_MsgRoute.sendMessage]: '/conversations/:conversationId/messages/send',
-    [DyFM_MsgRoute.editMessage]: '/messages/:messageId/edit',
-    [DyFM_MsgRoute.deleteMessage]: '/messages/:messageId',
-    [DyFM_MsgRoute.markAsRead]: '/messages/mark-read',
-    [DyFM_MsgRoute.addReaction]: '/messages/:messageId/reactions',
-    [DyFM_MsgRoute.removeReaction]: '/messages/:messageId/reactions/:emoji',
-    [DyFM_MsgRoute.addParticipant]: '/conversations/:conversationId/participants',
-    [DyFM_MsgRoute.removeParticipant]: '/conversations/:conversationId/participants/:userId',
-    [DyFM_MsgRoute.getAgentProcess]: '/messages/:messageId/agent-process',
-  },
-};

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

@@ -1,26 +0,0 @@
-/**
- * Message Attachment Type Enum
- * Defines the type of file attachment
- */
-export enum DyFM_Msg_AttachmentType {
-  /** Image files (jpg, png, gif, webp, etc.) */
-  image = 'image',
-  
-  /** Video files (mp4, webm, avi, etc.) */
-  video = 'video',
-  
-  /** Audio files (mp3, wav, ogg, etc.) */
-  audio = 'audio',
-  
-  /** Document files (pdf, doc, docx, txt, etc.) */
-  document = 'document',
-  
-  /** Archive files (zip, rar, 7z, etc.) */
-  archive = 'archive',
-  
-  /** Code files (js, ts, py, etc.) */
-  code = 'code',
-  
-  /** Generic file attachment */
-  file = 'file',
-}

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

@@ -1,20 +0,0 @@
-/**
- * Conversation Type Enum
- * Defines the type of conversation/chat
- */
-export enum DyFM_Msg_ConversationType {
-  /** Direct 1-on-1 conversation between two users */
-  direct = 'direct',
-  
-  /** Group conversation with multiple users */
-  group = 'group',
-  
-  /** User conversing with AI Assistant (simple LLM chat) */
-  assistantChat = 'assistant-chat',
-  
-  /** User conversing with AI Agent (with tool usage and reasoning) */
-  agentProcess = 'agent-process',
-  
-  /** Channel-based conversation (Discord, Slack, Teams) */
-  channel = 'channel',
-}

package/src/_modules/messaging/_enums/msg-delivery-status.enum.ts

@@ -1,17 +0,0 @@
-/**
- * Delivery Status Enum
- * Tracks delivery status per recipient
- */
-export enum DyFM_Msg_DeliveryStatus {
-  /** Pending delivery */
-  pending = 'pending',
-  
-  /** Delivered successfully */
-  delivered = 'delivered',
-  
-  /** Failed to deliver */
-  failed = 'failed',
-  
-  /** Recipient read the message */
-  read = 'read',
-}