@futdevpro/nts-dynamo 1.14.8 → 1.14.9

package/src/_modules/bot/_modules/slack-bot/_services/slb-provider.service.ts

@@ -0,0 +1,152 @@
+import { DyNTS_Bot_Provider, DyNTS_Bot_Provider_Config } from '../../../_models/bot-provider.interface';
+import { DyNTS_Bot_LastMessageDate } from '../../../_models/bot-last-message-date.interface';
+import { DyNTS_Bot_LastMentionDate } from '../../../_models/bot-last-mention-date.interface';
+import { DyNTS_Bot_Provider_Type } from '../../../_enums/bot-provider.enum';
+import { DyNTS_SlB_Message, DyNTS_SlB_Channel, DyNTS_SlB_User } from '../_models/slb-platform.types';
+
+export class DyNTS_SlB_Provider implements DyNTS_Bot_Provider<
+  DyNTS_SlB_Channel,
+  DyNTS_SlB_Message,
+  DyNTS_SlB_User
+> {
+  private isInitialized: boolean = false;
+  private config: DyNTS_Bot_Provider_Config;
+  
+  // Event handlers
+  private messageHandlers: Array<(message: DyNTS_SlB_Message, issuer: string) => void> = [];
+  private readyHandlers: Array<() => void> = [];
+  private errorHandlers: Array<(error: Error) => void> = [];
+
+  async initialize(config: DyNTS_Bot_Provider_Config): Promise<void> {
+    this.config = config;
+    
+    if (config.provider !== DyNTS_Bot_Provider_Type.slack) {
+      throw new Error(`Invalid provider type: ${config.provider}. Expected 'slack'`);
+    }
+
+    if (!config.slack) {
+      throw new Error('Slack configuration is required');
+    }
+
+    this.isInitialized = true;
+    // TODO: Initialize Slack client
+  }
+
+  async login(token: string): Promise<void> {
+    if (!this.isInitialized) {
+      throw new Error('Provider not initialized. Call initialize() first.');
+    }
+    // TODO: Implement Slack login
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  // Channel operations
+  async getChannelByName(name: string): Promise<DyNTS_SlB_Channel> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  async sendMessageToChannelByName(channelName: string, message: string): Promise<DyNTS_SlB_Message> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  async getMessagesFromChannelByChannelName(channelName: string, limit?: number): Promise<DyNTS_SlB_Message[]> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  async getLastMessageInChannel(channelName: string): Promise<DyNTS_SlB_Message> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  async clearChannel(channelId: string): Promise<void> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  // Message operations
+  async sendMessage(channelId: string, content: string): Promise<DyNTS_SlB_Message> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  async replyToMessage(messageId: string, channelId: string, content: string): Promise<DyNTS_SlB_Message> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  async sendTyping(channelId: string): Promise<void> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  async fetchMessages(channelId: string, limit: number): Promise<DyNTS_SlB_Message[]> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  async fetchAllMessagesWithPaging(channelId: string, maxFetch?: number): Promise<DyNTS_SlB_Message[]> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  async deleteMessage(messageId: string, channelId: string): Promise<void> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  // User operations
+  async getUserByName(username: string): Promise<DyNTS_SlB_User> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  getUserMention(userId: string): string {
+    return `<@${userId}>`;
+  }
+
+  async readMembersInChannel(channelName: string): Promise<DyNTS_SlB_User[]> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  async readMemberNamesInChannel(channelName: string): Promise<string[]> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  // Advanced message queries
+  async getLastMessageSentBy(channelName: string, username: string): Promise<DyNTS_SlB_Message> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  async getLastMentionOf(channelName: string, username: string): Promise<DyNTS_SlB_Message> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  async readLastMessageDatesByMembers(channelName: string, memberNames: string[]): Promise<DyNTS_Bot_LastMessageDate[]> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  async readLastMessageWithMemberNamePingInIt(channelName: string, users: DyNTS_SlB_User[]): Promise<DyNTS_Bot_LastMentionDate[]> {
+    throw new Error('Slack provider not yet implemented');
+  }
+
+  // Event binding
+  onMessage(handler: (message: DyNTS_SlB_Message, issuer: string) => void): void {
+    this.messageHandlers.push(handler);
+  }
+
+  onReady(handler: () => void): void {
+    this.readyHandlers.push(handler);
+  }
+
+  onError(handler: (error: Error) => void): void {
+    this.errorHandlers.push(handler);
+  }
+
+  // Metadata
+  getBotId(): string {
+    return 'slack-bot-stub';
+  }
+
+  getBotDisplayName(): string {
+    return 'Slack Bot (Stub)';
+  }
+
+  getProviderName(): string {
+    return 'slack';
+  }
+
+  isReady(): boolean {
+    return this.isInitialized;
+  }
+}

package/src/_modules/bot/_modules/slack-bot/index.ts

@@ -0,0 +1,14 @@
+//
+// Slack Bot Provider
+//
+// This module provides Slack-specific implementation of the Bot provider interface
+//
+
+// TYPES
+export * from './_models/slb-platform.types';
+
+// SERVICES
+export * from './_services/slb-provider.service';
+
+// COLLECTIONS
+export * from './_collections/slb-operations.util';

package/src/_modules/bot/_modules/teams-bot/_collections/teb-operations.util.ts

@@ -0,0 +1,18 @@
+import { DyNTS_Bot_Operations_Util } from '../../../_collections/bot-operations.util';
+import { DyNTS_TeB_Message, DyNTS_TeB_Channel, DyNTS_TeB_User } from '../_models/teb-platform.types';
+import { DyNTS_TeB_Provider } from '../_services/teb-provider.service';
+
+/**
+ * Teams Bot Operations Utility
+ * 
+ * Platform-specific implementation of bot operations for Teams
+ */
+export class DyNTS_TeB_Operations_Util extends DyNTS_Bot_Operations_Util<
+  DyNTS_TeB_Channel,
+  DyNTS_TeB_Message,
+  DyNTS_TeB_User,
+  DyNTS_TeB_Provider
+> {
+  // Teams-specific operations can be added here
+  // All base operations are inherited from the generic class
+}

package/src/_modules/bot/_modules/teams-bot/_models/teb-platform.types.ts

@@ -0,0 +1,9 @@
+import { DyNTS_Bot_Message } from '../../../_models/bot-message.interface';
+import { DyNTS_Bot_Channel } from '../../../_models/bot-channel.interface';
+import { DyNTS_Bot_User } from '../../../_models/bot-user.interface';
+
+// Teams Bot Platform-Specific Types
+// TODO: Replace 'any' with actual Teams SDK types when implementing
+export type DyNTS_TeB_Message = DyNTS_Bot_Message<any>;
+export type DyNTS_TeB_Channel = DyNTS_Bot_Channel<any>;
+export type DyNTS_TeB_User = DyNTS_Bot_User<any>;

package/src/_modules/bot/_modules/teams-bot/_services/teb-provider.service.ts

@@ -0,0 +1,152 @@
+import { DyNTS_Bot_Provider, DyNTS_Bot_Provider_Config } from '../../../_models/bot-provider.interface';
+import { DyNTS_Bot_LastMessageDate } from '../../../_models/bot-last-message-date.interface';
+import { DyNTS_Bot_LastMentionDate } from '../../../_models/bot-last-mention-date.interface';
+import { DyNTS_Bot_Provider_Type } from '../../../_enums/bot-provider.enum';
+import { DyNTS_TeB_Message, DyNTS_TeB_Channel, DyNTS_TeB_User } from '../_models/teb-platform.types';
+
+export class DyNTS_TeB_Provider implements DyNTS_Bot_Provider<
+  DyNTS_TeB_Channel,
+  DyNTS_TeB_Message,
+  DyNTS_TeB_User
+> {
+  private isInitialized: boolean = false;
+  private config: DyNTS_Bot_Provider_Config;
+  
+  // Event handlers
+  private messageHandlers: Array<(message: DyNTS_TeB_Message, issuer: string) => void> = [];
+  private readyHandlers: Array<() => void> = [];
+  private errorHandlers: Array<(error: Error) => void> = [];
+
+  async initialize(config: DyNTS_Bot_Provider_Config): Promise<void> {
+    this.config = config;
+    
+    if (config.provider !== DyNTS_Bot_Provider_Type.teams) {
+      throw new Error(`Invalid provider type: ${config.provider}. Expected 'teams'`);
+    }
+
+    if (!config.teams) {
+      throw new Error('Teams configuration is required');
+    }
+
+    this.isInitialized = true;
+    // TODO: Initialize Teams client
+  }
+
+  async login(token: string): Promise<void> {
+    if (!this.isInitialized) {
+      throw new Error('Provider not initialized. Call initialize() first.');
+    }
+    // TODO: Implement Teams login
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  // Channel operations
+  async getChannelByName(name: string): Promise<DyNTS_TeB_Channel> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  async sendMessageToChannelByName(channelName: string, message: string): Promise<DyNTS_TeB_Message> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  async getMessagesFromChannelByChannelName(channelName: string, limit?: number): Promise<DyNTS_TeB_Message[]> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  async getLastMessageInChannel(channelName: string): Promise<DyNTS_TeB_Message> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  async clearChannel(channelId: string): Promise<void> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  // Message operations
+  async sendMessage(channelId: string, content: string): Promise<DyNTS_TeB_Message> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  async replyToMessage(messageId: string, channelId: string, content: string): Promise<DyNTS_TeB_Message> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  async sendTyping(channelId: string): Promise<void> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  async fetchMessages(channelId: string, limit: number): Promise<DyNTS_TeB_Message[]> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  async fetchAllMessagesWithPaging(channelId: string, maxFetch?: number): Promise<DyNTS_TeB_Message[]> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  async deleteMessage(messageId: string, channelId: string): Promise<void> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  // User operations
+  async getUserByName(username: string): Promise<DyNTS_TeB_User> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  getUserMention(userId: string): string {
+    return `<@${userId}>`;
+  }
+
+  async readMembersInChannel(channelName: string): Promise<DyNTS_TeB_User[]> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  async readMemberNamesInChannel(channelName: string): Promise<string[]> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  // Advanced message queries
+  async getLastMessageSentBy(channelName: string, username: string): Promise<DyNTS_TeB_Message> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  async getLastMentionOf(channelName: string, username: string): Promise<DyNTS_TeB_Message> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  async readLastMessageDatesByMembers(channelName: string, memberNames: string[]): Promise<DyNTS_Bot_LastMessageDate[]> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  async readLastMessageWithMemberNamePingInIt(channelName: string, users: DyNTS_TeB_User[]): Promise<DyNTS_Bot_LastMentionDate[]> {
+    throw new Error('Teams provider not yet implemented');
+  }
+
+  // Event binding
+  onMessage(handler: (message: DyNTS_TeB_Message, issuer: string) => void): void {
+    this.messageHandlers.push(handler);
+  }
+
+  onReady(handler: () => void): void {
+    this.readyHandlers.push(handler);
+  }
+
+  onError(handler: (error: Error) => void): void {
+    this.errorHandlers.push(handler);
+  }
+
+  // Metadata
+  getBotId(): string {
+    return 'teams-bot-stub';
+  }
+
+  getBotDisplayName(): string {
+    return 'Teams Bot (Stub)';
+  }
+
+  getProviderName(): string {
+    return 'teams';
+  }
+
+  isReady(): boolean {
+    return this.isInitialized;
+  }
+}

package/src/_modules/bot/_modules/teams-bot/index.ts

@@ -0,0 +1,14 @@
+//
+// Teams Bot Provider
+//
+// This module provides Teams-specific implementation of the Bot provider interface
+//
+
+// TYPES
+export * from './_models/teb-platform.types';
+
+// SERVICES
+export * from './_services/teb-provider.service';
+
+// COLLECTIONS
+export * from './_collections/teb-operations.util';

package/src/_modules/bot/_services/bot-commands.control-service.ts

@@ -0,0 +1,126 @@
+import { DyFM_Error } from '@futdevpro/fsm-dynamo';
+
+import { DyNTS_SingletonService } from '../../../_services/base/singleton.service';
+import { DyNTS_Bot_Main_ControlService } from './bot-main.control-service';
+import { DyNTS_global_settings } from '../../../_collections/global-settings.const';
+import { DyNTS_Bot_Message } from '../_models/bot-message.interface';
+import { DyNTS_Bot_Global_Settings } from '../_models/bot-global-settings.interface';
+import { DyNTS_Bot_User } from '../_models/bot-user.interface';
+import { DyNTS_Bot_Channel } from '../_models/bot-channel.interface';
+import { DyNTS_Bot_Provider, DyNTS_Bot_Provider_Config } from '../_models/bot-provider.interface';
+
+export abstract class DyNTS_Bot_Commands_ControlService<
+  T_PlatformMessage extends DyNTS_Bot_Message<any> = DyNTS_Bot_Message<any>,
+  T_PlatformChannel extends DyNTS_Bot_Channel<any> = DyNTS_Bot_Channel<any>,
+  T_PlatformUser extends DyNTS_Bot_User<any> = DyNTS_Bot_User<any>,
+  T_PlatformProvider extends DyNTS_Bot_Provider<
+    T_PlatformChannel, 
+    T_PlatformMessage, 
+    T_PlatformUser
+  > = DyNTS_Bot_Provider<T_PlatformChannel, T_PlatformMessage, T_PlatformUser>
+> extends DyNTS_SingletonService {
+
+  static getInstance<T_PlatformMessage extends DyNTS_Bot_Message<any>>(): DyNTS_Bot_Commands_ControlService<T_PlatformMessage> {
+    return DyNTS_Bot_Commands_ControlService.getSingletonInstance();
+  }
+
+  protected abstract getMainBotControlService(): DyNTS_Bot_Main_ControlService<T_PlatformChannel, T_PlatformMessage, T_PlatformUser, T_PlatformProvider>;
+  protected readonly mainBot_CS: DyNTS_Bot_Main_ControlService<T_PlatformChannel, T_PlatformMessage, T_PlatformUser, T_PlatformProvider> = 
+    this.getMainBotControlService();
+
+  get provider(): T_PlatformProvider {
+    return this.mainBot_CS?.provider;
+  }
+
+  protected constructor() {
+    super();
+
+    if (!this.provider) {
+      throw new DyFM_Error({
+        ...this.getDefaultErrorSettings(
+          'constructor', 
+          new Error(
+            'Bot provider not yet initialized, ' +
+            'should only be called after DyNTS_Bot_Main_ControlService.start'
+          ), 
+          'system-init'
+        ),
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-Bot-CCS-C00`,
+      })
+    }
+  }
+
+  async handleCommand(message: T_PlatformMessage, issuer: string): Promise<void> {
+    try {
+      const botSettings = DyNTS_global_settings.bot_settings as DyNTS_Bot_Provider_Config;
+      let haveCommandOperator = false;
+      let msg = message.content.replace(
+        `<@${this.mainBot_CS.botClientId}>`, ''
+      ).trim();
+
+      if (!botSettings?.commandSettings?.commandOperator) {
+        haveCommandOperator = true;
+      } else if (
+        msg.startsWith(botSettings.commandSettings.commandOperator)
+      ) {
+        haveCommandOperator = true;
+        msg = msg.replace(botSettings.commandSettings.commandOperator, '');
+      }
+
+      if (!haveCommandOperator) {
+        throw new DyFM_Error({
+          ...this.getDefaultErrorSettings(
+            'handleCommand', 
+            new Error('No command operator found in the message'), 
+            issuer
+          ),
+          errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-Bot-CCS-HC1`,
+        })
+      }
+
+      const commandExists = botSettings?.commandSettings?.commands?.find(
+        (command) => msg.startsWith(command.command)
+      );
+
+      if (!commandExists) {
+        throw new DyFM_Error({
+          ...this.getDefaultErrorSettings(
+            'handleCommand', 
+            new Error(`Command not found: "${msg.split(' ')[0]}"`), 
+            issuer
+          ),
+          errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-Bot-CCS-HC2`,
+        })
+      }
+
+      if (commandExists.permissionNeeded) {
+        const permissionNeeded = await commandExists.permissionNeeded(message);
+
+        if (!permissionNeeded) {
+          throw new DyFM_Error({
+            ...this.getDefaultErrorSettings(
+              'handleCommand', 
+              new Error('Permission needed'), 
+              issuer
+            ),
+            errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-Bot-CCS-HC3`,
+          })
+        }
+      }
+
+      await commandExists.commandHandler(message);
+    } catch (error) {
+      this.provider.replyToMessage(
+        message.id,
+        message.channelId,
+        `Error occurred while handling the command:\n` +
+        DyFM_Error.getAnyMessage(error)
+      )
+
+      throw new DyFM_Error({
+        ...this.getDefaultErrorSettings('handleCommand', error, issuer),
+        errorCode: `${DyNTS_global_settings.systemShortCodeName}|DyNTS-Bot-CCS-HC0`,
+      })
+    }
+  }
+}