@hexabot-ai/api 3.1.3-alpha.0 → 3.2.0-alpha.0

package/src/channel/webhook.controller.ts

@@ -4,22 +4,12 @@
  * Full terms: see LICENSE.md.
  */
 
-import {
-  Controller,
-  Get,
-  NotFoundException,
-  Param,
-  Post,
-  Query,
-  Req,
-  Res,
-} from '@nestjs/common';
-import { Request, Response } from 'express'; // Import the Express request and response types
+import { Controller, Get, Param, Post, Query, Req, Res } from '@nestjs/common';
+import { Request, Response } from 'express';
 
 import { LoggerService } from '@/logger/logger.service';
 import { UuidParam } from '@/utils';
 import { Roles } from '@/utils/decorators/roles.decorator';
-import { WorkflowService } from '@/workflow/services/workflow.service';
 
 import { ChannelService } from './channel.service';
 import { ChannelDownloadService } from './services/channel-download.service';
@@ -29,119 +19,86 @@ export class WebhookController {
   constructor(
     private readonly channelService: ChannelService,
     private readonly channelDownloadService: ChannelDownloadService,
-    private readonly workflowService: WorkflowService,
     private readonly logger: LoggerService,
   ) {}
 
-  /**
-   * Handles GET requests to download a file
-   *
-   * @param channel - The name of the channel for which the request is being sent.
-   * @param filename - The name of the requested file
-   * @param t - The JWT Token query param.
-   * @param req - The HTTP express request object.
-   *
-   * @returns A promise that resolves a streamable file.
-   */
   @Roles('public')
-  @Get(':channel/download/:name')
+  @Get(':sourceRef/download/:name')
   async handleDownload(
-    @Param('channel') channel: string,
+    @Param('sourceRef') sourceRef: string,
     @Param('name') name: string,
     @Query('t') token: string,
     @Req() req: Request,
   ) {
-    this.logger.log('Channel download request: ', channel, name);
+    this.logger.log('Channel download request: ', sourceRef, name);
 
-    return await this.channelDownloadService.download(channel, token, req);
+    return await this.channelDownloadService.download(sourceRef, token, req);
   }
 
-  /**
-   * Handles GET requests of a specific channel.
-   * This endpoint is accessible to public access (messaging platforms).
-   * It logs the request method and the channel name, then delegates the request
-   * to the `channelService` for further handling.
-   *
-   * @param channel - The name of the channel for which the request is being sent.
-   * @param req - The HTTP request object.
-   * @param res - The HTTP response object.
-   *
-   * @returns A promise that resolves with the result of the `channelService.handle` method.
-   */
   @Roles('public')
-  @Get(':channel')
+  @Get(':sourceRef')
   async handleGet(
-    @Param('channel') channel: string,
+    @Param('sourceRef') sourceRef: string,
     @Req() req: Request,
     @Res() res: Response,
-  ): Promise<any> {
-    return await this.handleChannelRequest(channel, req, res);
+  ): Promise<void> {
+    return await this.handleSourceRequest(sourceRef, req, res);
   }
 
   @Roles('public')
-  @Get(':channel/not-found')
-  async handleNotFound(@Res() res: Response) {
+  @Get(':sourceRef/not-found')
+  async handleNotFound(
+    @Param('sourceRef') _sourceRef: string,
+    @Res() res: Response,
+  ) {
     return res.status(404).send({ error: 'Resource not found!' });
   }
 
   @Roles('public')
-  @Get(':channel/:workflowId')
+  @Get(':sourceRef/:workflowId')
   async handleGetWithWorkflow(
-    @Param('channel') channel: string,
+    @Param('sourceRef') sourceRef: string,
     @UuidParam('workflowId') workflowId: string,
     @Req() req: Request,
     @Res() res: Response,
-  ): Promise<any> {
-    return await this.handleChannelRequest(channel, req, res, workflowId);
+  ): Promise<void> {
+    return await this.handleSourceRequest(sourceRef, req, res, workflowId);
   }
 
-  /**
-   * Handles POST requests for a specific channel.
-   * This endpoint is accessible to public access (messaging platforms).
-   * It logs the request method and the channel name, then delegates the request
-   * to the `channelService` for further handling.
-   *
-   * @param channel - The name of the channel for which the notification is being sent.
-   * @param req - The HTTP request object.
-   * @param res - The HTTP response object.
-   *
-   * @returns A promise that resolves with the result of the `channelService.handle` method.
-   */
   @Roles('public')
-  @Post(':channel')
+  @Post(':sourceRef')
   async handlePost(
-    @Param('channel') channel: string,
+    @Param('sourceRef') sourceRef: string,
     @Req() req: Request,
     @Res() res: Response,
   ): Promise<void> {
-    return await this.handleChannelRequest(channel, req, res);
+    return await this.handleSourceRequest(sourceRef, req, res);
   }
 
   @Roles('public')
-  @Post(':channel/:workflowId')
+  @Post(':sourceRef/:workflowId')
   async handlePostWithWorkflow(
-    @Param('channel') channel: string,
+    @Param('sourceRef') sourceRef: string,
     @UuidParam('workflowId') workflowId: string,
     @Req() req: Request,
     @Res() res: Response,
   ): Promise<void> {
-    return await this.handleChannelRequest(channel, req, res, workflowId);
+    return await this.handleSourceRequest(sourceRef, req, res, workflowId);
   }
 
-  private async handleChannelRequest(
-    channel: string,
+  private async handleSourceRequest(
+    sourceRef: string,
     req: Request,
     res: Response,
     workflowId?: string,
   ): Promise<void> {
-    this.logger.log('Channel notification : ', req.method, channel, workflowId);
-    if (workflowId) {
-      const workflow = await this.workflowService.findOne(workflowId);
-      if (!workflow) {
-        throw new NotFoundException(`Workflow with ID ${workflowId} not found`);
-      }
-    }
+    this.logger.log(
+      'Channel notification : ',
+      req.method,
+      sourceRef,
+      workflowId,
+    );
 
-    return await this.channelService.handle(channel, req, res, workflowId);
+    return await this.channelService.handle(sourceRef, req, res, workflowId);
   }
 }

package/src/chat/controllers/label-group.controller.ts

@@ -4,6 +4,7 @@
  * Full terms: see LICENSE.md.
  */
 
+import { LabelGroup, LabelGroupFull } from '@hexabot-ai/types';
 import {
   Body,
   Controller,
@@ -23,9 +24,7 @@ import { PopulatePipe } from '@/utils/pipes/populate.pipe';
 import { TypeOrmSearchFilterPipe } from '@/utils/pipes/typeorm-search-filter.pipe';
 
 import {
-  LabelGroup,
   LabelGroupCreateDto,
-  LabelGroupFull,
   LabelGroupUpdateDto,
 } from '../dto/label-group.dto';
 import { LabelGroupOrmEntity } from '../entities/label-group.entity';

package/src/chat/controllers/label.controller.ts

@@ -4,6 +4,7 @@
  * Full terms: see LICENSE.md.
  */
 
+import { Label, LabelFull } from '@hexabot-ai/types';
 import {
   Body,
   Controller,
@@ -22,12 +23,7 @@ import { BaseOrmController } from '@/utils/generics/base-orm.controller';
 import { PopulatePipe } from '@/utils/pipes/populate.pipe';
 import { TypeOrmSearchFilterPipe } from '@/utils/pipes/typeorm-search-filter.pipe';
 
-import {
-  Label,
-  LabelCreateDto,
-  LabelFull,
-  LabelUpdateDto,
-} from '../dto/label.dto';
+import { LabelCreateDto, LabelUpdateDto } from '../dto/label.dto';
 import { LabelOrmEntity } from '../entities/label.entity';
 import { LabelService } from '../services/label.service';
 

package/src/chat/controllers/message.controller.ts

@@ -6,6 +6,13 @@
 
 import { randomUUID } from 'crypto';
 
+import {
+  Message,
+  MessageFull,
+  Thread,
+  IncomingMessageType,
+  OutgoingMessage,
+} from '@hexabot-ai/types';
 import {
   BadRequestException,
   Body,
@@ -31,20 +38,11 @@ import { BaseOrmController } from '@/utils/generics/base-orm.controller';
 import { PopulatePipe } from '@/utils/pipes/populate.pipe';
 import { TypeOrmSearchFilterPipe } from '@/utils/pipes/typeorm-search-filter.pipe';
 
-import { Message, MessageCreateDto, MessageFull } from '../dto/message.dto';
-import { Thread } from '../dto/thread.dto';
+import { MessageSendDto } from '../dto/message.dto';
 import { MessageOrmEntity } from '../entities/message.entity';
 import { MessageService } from '../services/message.service';
 import { SubscriberService } from '../services/subscriber.service';
 import { ThreadService } from '../services/thread.service';
-import {
-  IncomingMessageType,
-  OutgoingMessage,
-  OutgoingMessageFormat,
-  StdOutgoingEnvelope,
-  StdOutgoingMessage,
-  StdOutgoingTextMessage,
-} from '../types/message';
 
 @Controller('message')
 export class MessageController extends BaseOrmController<MessageOrmEntity> {
@@ -113,7 +111,7 @@ export class MessageController extends BaseOrmController<MessageOrmEntity> {
   }
 
   @Post()
-  async create(@Body() messageDto: MessageCreateDto, @Req() req: Request) {
+  async create(@Body() messageDto: MessageSendDto, @Req() req: Request) {
     if (!messageDto.thread) {
       throw new BadRequestException(
         'MessageController send : thread id is required',
@@ -143,15 +141,15 @@ export class MessageController extends BaseOrmController<MessageOrmEntity> {
     }
 
     const channelData = subscriber.channel;
-
-    if (!this.channelService.findChannel(channelData.name)) {
+    const channelName = channelData.name;
+    if (!channelName || !this.channelService.findChannel(channelName)) {
       throw new BadRequestException(`Subscriber channel not found`);
     }
+    if (!subscriber.foreignId) {
+      throw new BadRequestException(`Subscriber foreign ID is missing`);
+    }
 
-    const envelope: StdOutgoingEnvelope = {
-      format: OutgoingMessageFormat.text,
-      message: messageDto.message as StdOutgoingTextMessage,
-    };
+    const envelope = messageDto.message;
     const latestMessageId = messageDto.inReplyTo
       ? messageDto.inReplyTo
       : (
@@ -160,14 +158,15 @@ export class MessageController extends BaseOrmController<MessageOrmEntity> {
             1,
           )
         ).at(0)?.mid;
-    const channelName = channelData.name as ChannelName;
-    const channelHandler = this.channelService.getChannelHandler(channelName);
+    const typedChannelName = channelName as ChannelName;
+    const channelHandler =
+      this.channelService.getChannelHandler(typedChannelName);
     const eventContext = new ChannelInboundEventContext<
       ChannelName,
       Record<string, unknown>,
       Record<string, unknown>
     >(
-      channelName,
+      typedChannelName,
       {
         source: 'message-controller',
       },
@@ -180,10 +179,16 @@ export class MessageController extends BaseOrmController<MessageOrmEntity> {
     const event = new SyntheticMessageInboundEvent<
       ChannelName,
       Record<string, unknown>
-    >(eventContext, { text: '' }, IncomingMessageType.message, channelHandler);
+    >(
+      eventContext,
+      { type: IncomingMessageType.text, data: { text: '' } },
+      IncomingMessageType.text,
+      channelHandler,
+    );
 
     event.setInitiator(subscriber);
     event.setThreadId(thread.id);
+    event.setSourceContext(thread.source.id, thread.source.settings);
     try {
       const { mid } = await channelHandler.sendMessage(event, envelope, {});
       // Trigger sent message event
@@ -191,7 +196,7 @@ export class MessageController extends BaseOrmController<MessageOrmEntity> {
         mid,
         recipient: subscriber.id,
         thread: thread.id,
-        message: messageDto.message as StdOutgoingMessage,
+        message: messageDto.message,
         sentBy: req.session.passport?.user?.id,
         read: false,
         delivery: false,

package/src/chat/controllers/subscriber.controller.ts

@@ -4,6 +4,7 @@
  * Full terms: see LICENSE.md.
  */
 
+import { Subscriber, SubscriberFull } from '@hexabot-ai/types';
 import {
   Body,
   Controller,
@@ -22,11 +23,7 @@ import { generateInitialsAvatar } from '@/utils/helpers/avatar';
 import { PopulatePipe } from '@/utils/pipes/populate.pipe';
 import { TypeOrmSearchFilterPipe } from '@/utils/pipes/typeorm-search-filter.pipe';
 
-import {
-  Subscriber,
-  SubscriberFull,
-  SubscriberUpdateDto,
-} from '../dto/subscriber.dto';
+import { SubscriberUpdateDto } from '../dto/subscriber.dto';
 import { SubscriberOrmEntity } from '../entities/subscriber.entity';
 import { SubscriberService } from '../services/subscriber.service';
 
@@ -36,6 +33,7 @@ export const SUBSCRIBER_ALLOWED_FILTER_FIELDS: TFilterNestedKeysOfType<Subscribe
     'lastName',
     'assignedTo.id',
     'channel.name',
+    'source.id',
     // TODO : type need to be enhanced to include 'labels'
     'labels' as any,
   ];

package/src/chat/controllers/thread.controller.ts

@@ -4,7 +4,16 @@
  * Full terms: see LICENSE.md.
  */
 
-import { Body, Controller, Get, Patch, Post, Query } from '@nestjs/common';
+import { Thread, ThreadFull } from '@hexabot-ai/types';
+import {
+  BadRequestException,
+  Body,
+  Controller,
+  Get,
+  Patch,
+  Post,
+  Query,
+} from '@nestjs/common';
 import { FindManyOptions } from 'typeorm';
 
 import { UuidParam } from '@/utils';
@@ -13,12 +22,7 @@ import { PopulatePipe } from '@/utils/pipes/populate.pipe';
 import { TypeOrmSearchFilterPipe } from '@/utils/pipes/typeorm-search-filter.pipe';
 import { TFilterNestedKeysOfType } from '@/utils/types/filter.types';
 
-import {
-  Thread,
-  ThreadCreateDto,
-  ThreadFull,
-  ThreadUpdateDto,
-} from '../dto/thread.dto';
+import { ThreadCreateDto, ThreadUpdateDto } from '../dto/thread.dto';
 import { ThreadOrmEntity } from '../entities/thread.entity';
 import { ThreadService } from '../services/thread.service';
 
@@ -29,6 +33,7 @@ export const THREAD_ALLOWED_FILTER_FIELDS: TFilterNestedKeysOfType<ThreadOrmEnti
     'subscriber.lastName',
     'subscriber.channel.name',
     'subscriber.assignedTo.id',
+    'source.id',
     'status',
     'closeReason',
     'title',
@@ -88,6 +93,12 @@ export class ThreadController extends BaseOrmController<ThreadOrmEntity> {
     @UuidParam('id') id: string,
     @Body() threadUpdate: ThreadUpdateDto,
   ) {
+    if ('subscriber' in threadUpdate || 'source' in threadUpdate) {
+      throw new BadRequestException(
+        'Thread subscriber and source cannot be updated',
+      );
+    }
+
     return await this.threadService.updateOne(id, threadUpdate);
   }
 }

package/src/chat/dto/label-group.dto.ts

@@ -4,32 +4,11 @@
  * Full terms: see LICENSE.md.
  */
 
+import { labelGroupFullSchema, labelGroupSchema } from '@hexabot-ai/types';
 import { ApiProperty } from '@nestjs/swagger';
-import { Exclude, Expose, Type } from 'class-transformer';
 import { IsNotEmpty, IsString } from 'class-validator';
 
-import { BaseStub, TDto } from '@/utils/types/dto.types';
-
-import { Label } from './label.dto';
-
-@Exclude()
-export class LabelGroupStub extends BaseStub {
-  @Expose()
-  name!: string;
-}
-
-@Exclude()
-export class LabelGroup extends LabelGroupStub {
-  @Exclude()
-  labels?: never;
-}
-
-@Exclude()
-export class LabelGroupFull extends LabelGroupStub {
-  @Expose()
-  @Type(() => Label)
-  labels?: Label[];
-}
+import { TDto } from '@/utils/types/dto.types';
 
 export class LabelGroupCreateDto {
   @ApiProperty({ description: 'Label group name', type: String })
@@ -42,8 +21,8 @@ export class LabelGroupUpdateDto extends LabelGroupCreateDto {}
 
 export type LabelGroupDto = TDto<
   {
-    plain: typeof LabelGroup;
-    full: typeof LabelGroupFull;
+    plain: typeof labelGroupSchema;
+    full: typeof labelGroupFullSchema;
   },
   {
     create: LabelGroupCreateDto;

package/src/chat/dto/label.dto.ts

@@ -4,8 +4,8 @@
  * Full terms: see LICENSE.md.
  */
 
+import { labelFullSchema, labelSchema } from '@hexabot-ai/types';
 import { ApiProperty, ApiPropertyOptional, PartialType } from '@nestjs/swagger';
-import { Exclude, Expose, Transform, Type } from 'class-transformer';
 import {
   IsNotEmpty,
   IsObject,
@@ -15,50 +15,7 @@ import {
 } from 'class-validator';
 
 import { IsUUIDv4 } from '@/utils/decorators/is-uuid.decorator';
-import { BaseStub, TDto } from '@/utils/types/dto.types';
-
-import { LabelGroup } from './label-group.dto';
-import { Subscriber } from './subscriber.dto';
-
-@Exclude()
-export class LabelStub extends BaseStub {
-  @Expose()
-  title!: string;
-
-  @Expose()
-  name!: string;
-
-  @Expose()
-  @Transform(({ value }) => (value == null ? undefined : value))
-  label_id?: Record<string, any> | null;
-
-  @Expose()
-  @Transform(({ value }) => (value == null ? undefined : value))
-  description?: string | null;
-
-  @Expose()
-  builtin!: boolean;
-}
-
-@Exclude()
-export class Label extends LabelStub {
-  @Expose({ name: 'groupId' })
-  group?: string | null;
-
-  @Exclude()
-  users?: never;
-}
-
-@Exclude()
-export class LabelFull extends LabelStub {
-  @Expose()
-  @Type(() => Subscriber)
-  users?: Subscriber[];
-
-  @Expose()
-  @Type(() => LabelGroup)
-  group?: LabelGroup | null;
-}
+import { TDto } from '@/utils/types/dto.types';
 
 export class LabelCreateDto {
   @ApiProperty({ description: 'Label title', type: String })
@@ -97,8 +54,8 @@ export class LabelUpdateDto extends PartialType(LabelCreateDto) {}
 
 export type LabelDto = TDto<
   {
-    plain: typeof Label;
-    full: typeof LabelFull;
+    plain: typeof labelSchema;
+    full: typeof labelFullSchema;
   },
   {
     create: LabelCreateDto;

package/src/chat/dto/message.dto.ts

@@ -4,8 +4,14 @@
  * Full terms: see LICENSE.md.
  */
 
+import {
+  messageFullSchema,
+  messageSchema,
+  StdIncomingMessage,
+  StdOutgoingMessage,
+  stdOutgoingMessageSchema,
+} from '@hexabot-ai/types';
 import { ApiProperty, ApiPropertyOptional, PartialType } from '@nestjs/swagger';
-import { Exclude, Expose, Transform, Type } from 'class-transformer';
 import {
   IsBoolean,
   IsNotEmpty,
@@ -14,72 +20,9 @@ import {
   IsString,
 } from 'class-validator';
 
-import { User } from '@/user/dto/user.dto';
 import { IsUUIDv4 } from '@/utils/decorators/is-uuid.decorator';
 import { Validate } from '@/utils/decorators/validate.decorator';
-import { BaseStub, TDto } from '@/utils/types/dto.types';
-
-import {
-  StdIncomingMessage,
-  StdOutgoingMessage,
-  validMessageTextSchema,
-} from '../types/message';
-
-import { Subscriber } from './subscriber.dto';
-import { Thread } from './thread.dto';
-
-@Exclude()
-export class MessageStub extends BaseStub {
-  @Expose()
-  @Transform(({ value }) => (value == null ? undefined : value))
-  mid?: string | null;
-
-  @Expose()
-  message!: StdOutgoingMessage | StdIncomingMessage;
-
-  @Expose()
-  read!: boolean;
-
-  @Expose()
-  delivery!: boolean;
-
-  @Expose()
-  handover!: boolean;
-}
-
-@Exclude()
-export class Message extends MessageStub {
-  @Expose({ name: 'senderId' })
-  sender?: string | null;
-
-  @Expose({ name: 'recipientId' })
-  recipient?: string | null;
-
-  @Expose({ name: 'sentById' })
-  sentBy?: string | null;
-
-  @Expose({ name: 'threadId' })
-  thread!: string;
-}
-
-@Exclude()
-export class MessageFull extends MessageStub {
-  @Expose()
-  @Type(() => Subscriber)
-  sender?: Subscriber | null;
-
-  @Expose()
-  @Type(() => Subscriber)
-  recipient?: Subscriber | null;
-
-  @Expose()
-  @Type(() => User)
-  sentBy?: User | null;
-
-  @Expose()
-  @Type(() => Thread)
-  thread!: Thread;
-}
+import { TDto } from '@/utils/types/dto.types';
 
 export class MessageCreateDto {
   @ApiProperty({ description: 'Message id', type: String })
@@ -118,7 +61,7 @@ export class MessageCreateDto {
   @ApiProperty({ description: 'Message', type: Object })
   @IsObject()
   @IsNotEmpty()
-  @Validate(validMessageTextSchema)
+  @Validate(stdOutgoingMessageSchema)
   message: StdOutgoingMessage | StdIncomingMessage;
 
   @ApiPropertyOptional({ description: 'Message is read', type: Boolean })
@@ -141,10 +84,18 @@ export class MessageCreateDto {
 
 export class MessageUpdateDto extends PartialType(MessageCreateDto) {}
 
+export class MessageSendDto extends MessageCreateDto {
+  @ApiProperty({ description: 'Message', type: Object })
+  @IsObject()
+  @IsNotEmpty()
+  @Validate(stdOutgoingMessageSchema)
+  declare message: StdOutgoingMessage;
+}
+
 export type MessageDto = TDto<
   {
-    plain: typeof Message;
-    full: typeof MessageFull;
+    plain: typeof messageSchema;
+    full: typeof messageFullSchema;
   },
   {
     create: MessageCreateDto;