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

package/src/extensions/channels/web/globals.d.ts

@@ -4,10 +4,12 @@
  * Full terms: see LICENSE.md.
  */
 
+import type { z } from 'zod';
+
 import {
   WEB_CHANNEL_NAME,
-  WEB_CHANNEL_SETTINGS_SCHEMA,
-} from './web-channel.settings';
+  WEB_CHANNEL_SOURCE_SETTINGS_SCHEMA,
+} from './settings.schema';
 
 declare global {
   interface SubscriberChannelDict {
@@ -23,7 +25,7 @@ declare module '@nestjs/event-emitter' {
   interface IHookExtensionsOperationMap {
     [WEB_CHANNEL_NAME]: TDefinition<
       object,
-      SettingMapByType<typeof WEB_CHANNEL_SETTINGS_SCHEMA>
+      z.infer<typeof WEB_CHANNEL_SOURCE_SETTINGS_SCHEMA>
     >;
   }
 }

package/src/extensions/channels/web/inbound/events/delivery.event.ts

@@ -4,9 +4,10 @@
  * Full terms: see LICENSE.md.
  */
 
+import { StdEventType } from '@hexabot-ai/types';
+
 import { ChannelInboundEventContext } from '@/channel/lib/inbound-events';
 import { ChannelName } from '@/channel/types';
-import { StdEventType } from '@/chat/types/message';
 
 import { Web } from '../../types';
 

package/src/extensions/channels/web/inbound/events/messages/attachment.event.ts

@@ -4,14 +4,18 @@
  * Full terms: see LICENSE.md.
  */
 
-import { Attachment } from '@/attachment/dto/attachment.dto';
+import type { Attachment } from '@hexabot-ai/types';
+import {
+  FileType,
+  PayloadType,
+  IncomingMessageType,
+  StdIncomingMessage,
+  Payload,
+} from '@hexabot-ai/types';
+
 import { AttachmentOrmEntity } from '@/attachment/entities/attachment.entity';
 import { ChannelInboundEventContext } from '@/channel/lib/inbound-events';
 import { ChannelName } from '@/channel/types';
-import { FileType } from '@/chat/types/attachment';
-import { PayloadType } from '@/chat/types/button';
-import { IncomingMessageType, StdIncomingMessage } from '@/chat/types/message';
-import { Payload } from '@/chat/types/quick-reply';
 
 import { Web } from '../../../types';
 
@@ -40,7 +44,7 @@ export class AttachmentMessageInboundEvent<
   }
 
   override getMessageType(): IncomingMessageType {
-    return IncomingMessageType.attachments;
+    return IncomingMessageType.attachment;
   }
 
   setUploadedAttachment(attachment: Attachment): void {
@@ -104,7 +108,7 @@ export class AttachmentMessageInboundEvent<
     const fileType = this.resolveFileType(attachment);
 
     return {
-      type: PayloadType.attachments,
+      type: PayloadType.attachment,
       attachment: {
         type: fileType,
         payload: {
@@ -120,12 +124,14 @@ export class AttachmentMessageInboundEvent<
     const attachmentName = this.resolveAttachmentName(attachment, fileType);
 
     return {
-      type: PayloadType.attachments,
-      serialized_text: `attachment:${fileType}:${attachmentName}`,
-      attachment: {
-        type: fileType,
-        payload: {
-          id: attachment.id,
+      type: IncomingMessageType.attachment,
+      data: {
+        serializedText: `attachment:${fileType}:${attachmentName}`,
+        attachment: {
+          type: fileType,
+          payload: {
+            id: attachment.id,
+          },
         },
       },
     };

package/src/extensions/channels/web/inbound/events/messages/location.event.ts

@@ -4,11 +4,15 @@
  * Full terms: see LICENSE.md.
  */
 
+import {
+  PayloadType,
+  IncomingMessageType,
+  StdIncomingMessage,
+  Payload,
+} from '@hexabot-ai/types';
+
 import { ChannelInboundEventContext } from '@/channel/lib/inbound-events';
 import { ChannelName } from '@/channel/types';
-import { PayloadType } from '@/chat/types/button';
-import { IncomingMessageType, StdIncomingMessage } from '@/chat/types/message';
-import { Payload } from '@/chat/types/quick-reply';
 
 import { Web } from '../../../types';
 
@@ -48,10 +52,12 @@ export class LocationMessageInboundEvent<
 
   override toStdIncomingMessage(): StdIncomingMessage {
     return {
-      type: PayloadType.location,
-      coordinates: {
-        lat: this.latitude,
-        lon: this.longitude,
+      type: IncomingMessageType.location,
+      data: {
+        coordinates: {
+          lat: this.latitude,
+          lon: this.longitude,
+        },
       },
     };
   }

package/src/extensions/channels/web/inbound/events/messages/payload.event.ts

@@ -4,10 +4,14 @@
  * Full terms: see LICENSE.md.
  */
 
+import {
+  IncomingMessageType,
+  StdIncomingMessage,
+  Payload,
+} from '@hexabot-ai/types';
+
 import { ChannelInboundEventContext } from '@/channel/lib/inbound-events';
 import { ChannelName } from '@/channel/types';
-import { IncomingMessageType, StdIncomingMessage } from '@/chat/types/message';
-import { Payload } from '@/chat/types/quick-reply';
 
 import { Web } from '../../../types';
 
@@ -27,7 +31,7 @@ export abstract class PayloadMessageInboundEvent<
     >,
     private readonly messageType:
       | IncomingMessageType.postback
-      | IncomingMessageType.quick_reply,
+      | IncomingMessageType.quickReply,
     private readonly payloadValue: string,
     private readonly text: string,
   ) {
@@ -44,8 +48,11 @@ export abstract class PayloadMessageInboundEvent<
 
   override toStdIncomingMessage(): StdIncomingMessage {
     return {
-      postback: this.payloadValue,
-      text: this.text,
+      type: this.messageType,
+      data: {
+        payload: this.payloadValue,
+        text: this.text,
+      },
     };
   }
 }

package/src/extensions/channels/web/inbound/events/messages/postback.event.ts

@@ -4,9 +4,10 @@
  * Full terms: see LICENSE.md.
  */
 
+import { IncomingMessageType } from '@hexabot-ai/types';
+
 import { ChannelInboundEventContext } from '@/channel/lib/inbound-events';
 import { ChannelName } from '@/channel/types';
-import { IncomingMessageType } from '@/chat/types/message';
 
 import { Web } from '../../../types';
 

package/src/extensions/channels/web/inbound/events/messages/quick-reply.event.ts

@@ -4,9 +4,10 @@
  * Full terms: see LICENSE.md.
  */
 
+import { IncomingMessageType } from '@hexabot-ai/types';
+
 import { ChannelInboundEventContext } from '@/channel/lib/inbound-events';
 import { ChannelName } from '@/channel/types';
-import { IncomingMessageType } from '@/chat/types/message';
 
 import { Web } from '../../../types';
 
@@ -24,7 +25,7 @@ export class QuickReplyInboundEvent<
     payloadValue: string,
     text: string,
   ) {
-    super(context, IncomingMessageType.quick_reply, payloadValue, text);
+    super(context, IncomingMessageType.quickReply, payloadValue, text);
   }
 }
 

package/src/extensions/channels/web/inbound/events/messages/text.event.ts

@@ -4,9 +4,10 @@
  * Full terms: see LICENSE.md.
  */
 
+import { IncomingMessageType, StdIncomingMessage } from '@hexabot-ai/types';
+
 import { ChannelInboundEventContext } from '@/channel/lib/inbound-events';
 import { ChannelName } from '@/channel/types';
-import { IncomingMessageType, StdIncomingMessage } from '@/chat/types/message';
 
 import { Web } from '../../../types';
 
@@ -30,12 +31,15 @@ export class TextMessageInboundEvent<
   }
 
   override getMessageType(): IncomingMessageType {
-    return IncomingMessageType.message;
+    return IncomingMessageType.text;
   }
 
   override toStdIncomingMessage(): StdIncomingMessage {
     return {
-      text: this.text,
+      type: IncomingMessageType.text,
+      data: {
+        text: this.text,
+      },
     };
   }
 }

package/src/extensions/channels/web/inbound/events/read.event.ts

@@ -4,9 +4,10 @@
  * Full terms: see LICENSE.md.
  */
 
+import { StdEventType } from '@hexabot-ai/types';
+
 import { ChannelInboundEventContext } from '@/channel/lib/inbound-events';
 import { ChannelName } from '@/channel/types';
-import { StdEventType } from '@/chat/types/message';
 
 import { Web } from '../../types';
 

package/src/extensions/channels/web/inbound/events/typing.event.ts

@@ -4,9 +4,10 @@
  * Full terms: see LICENSE.md.
  */
 
+import { StdEventType } from '@hexabot-ai/types';
+
 import { ChannelInboundEventContext } from '@/channel/lib/inbound-events';
 import { ChannelName } from '@/channel/types';
-import { StdEventType } from '@/chat/types/message';
 
 import { Web } from '../../types';
 

package/src/extensions/channels/web/inbound/events/unsupported.event.ts

@@ -4,9 +4,10 @@
  * Full terms: see LICENSE.md.
  */
 
+import { StdEventType } from '@hexabot-ai/types';
+
 import { ChannelInboundEventContext } from '@/channel/lib/inbound-events';
 import { ChannelName } from '@/channel/types';
-import { StdEventType } from '@/chat/types/message';
 
 import { Web } from '../../types';
 

package/src/extensions/channels/web/inbound/index.ts

@@ -11,3 +11,5 @@ export * from './events/base-web-inbound.event';
 export * from './events/unsupported.event';
 
 export * from './web-inbound-event-decoder';
+
+export * from './web-inbound-message-encoder';

package/src/extensions/channels/web/inbound/web-inbound-message-encoder.ts

@@ -0,0 +1,92 @@
+/*
+ * Hexabot — Fair Core License (FCL-1.0-ALv2)
+ * Copyright (c) 2026 Hexastack.
+ * Full terms: see LICENSE.md.
+ */
+
+import {
+  FileType,
+  IncomingMessageType,
+  type StdIncomingMessage,
+} from '@hexabot-ai/types';
+import { Injectable, Type } from '@nestjs/common';
+
+import { ChannelAttachmentService } from '@/channel/services/channel-attachment.service';
+
+import { Web } from '../types';
+
+export class WebInboundMessageEncoder {
+  constructor(
+    private readonly channelAttachmentService: Pick<
+      ChannelAttachmentService,
+      'getPublicUrl'
+    >,
+  ) {}
+
+  async encode(
+    message: StdIncomingMessage,
+    sourceId: string,
+  ): Promise<Web.InboundMessageBase> {
+    switch (message.type) {
+      case IncomingMessageType.text:
+        return {
+          type: Web.InboundMessageType.text,
+          data: message.data,
+        };
+      case IncomingMessageType.postback:
+        return {
+          type: Web.InboundMessageType.postback,
+          data: message.data,
+        };
+      case IncomingMessageType.quickReply:
+        return {
+          type: Web.InboundMessageType.quick_reply,
+          data: message.data,
+        };
+      case IncomingMessageType.location: {
+        const { lat, lon } = message.data.coordinates;
+
+        return {
+          type: Web.InboundMessageType.location,
+          data: { coordinates: { lat, lng: lon } },
+        };
+      }
+      case IncomingMessageType.attachment: {
+        const attachmentPayload = Array.isArray(message.data.attachment)
+          ? message.data.attachment[0]
+          : message.data.attachment;
+
+        return {
+          type: Web.InboundMessageType.file,
+          data: {
+            type: attachmentPayload?.type ?? FileType.unknown,
+            url: await this.channelAttachmentService.getPublicUrl(
+              sourceId,
+              attachmentPayload?.payload,
+            ),
+          },
+        };
+      }
+      default:
+        return {
+          type: Web.InboundMessageType.text,
+          data: { text: '' },
+        };
+    }
+  }
+}
+
+export function createWebInboundMessageEncoder(
+  _channelName: string,
+): Type<WebInboundMessageEncoder> {
+  @Injectable()
+  class BoundWebInboundMessageEncoder extends WebInboundMessageEncoder {
+    constructor(channelAttachmentService: ChannelAttachmentService) {
+      super(channelAttachmentService);
+    }
+  }
+
+  return BoundWebInboundMessageEncoder;
+}
+
+export default WebInboundMessageEncoder;

package/src/extensions/channels/web/index.channel.ts

@@ -7,13 +7,16 @@
 import { Injectable } from '@nestjs/common';
 
 import BaseWebChannelHandler from './base-web-channel';
-import { WEB_CHANNEL_NAME } from './web-channel.settings';
+import {
+  WEB_CHANNEL_NAME,
+  WEB_CHANNEL_SOURCE_SETTINGS_SCHEMA,
+} from './settings.schema';
 
 @Injectable()
 export default class WebChannelHandler extends BaseWebChannelHandler<
   typeof WEB_CHANNEL_NAME
 > {
   constructor() {
-    super(WEB_CHANNEL_NAME);
+    super(WEB_CHANNEL_NAME, WEB_CHANNEL_SOURCE_SETTINGS_SCHEMA);
   }
 }

package/src/extensions/channels/web/outbound/web-outbound-message-encoder.ts

@@ -4,39 +4,40 @@
  * Full terms: see LICENSE.md.
  */
 
+import {
+  ActionOptions,
+  AttachmentRef,
+  Button,
+  ButtonType,
+  ContentElement,
+  OutgoingMessageType,
+  StdOutgoingAttachmentMessageData,
+  StdOutgoingButtonsMessageData,
+  StdOutgoingListMessageData,
+  StdOutgoingMessageEnvelope,
+  StdOutgoingQuickRepliesMessageData,
+  StdOutgoingTextMessageData,
+} from '@hexabot-ai/types';
 import { Injectable, Type } from '@nestjs/common';
 
 import { ChannelOutboundMessageEncoder } from '@/channel/lib/outbound';
 import { ChannelAttachmentService } from '@/channel/services/channel-attachment.service';
-import { ChannelName } from '@/channel/types';
 import { VIEW_MORE_PAYLOAD } from '@/chat/helpers/constants';
-import { AttachmentRef } from '@/chat/types/attachment';
-import { Button, ButtonType } from '@/chat/types/button';
-import {
-  ContentElement,
-  OutgoingMessageFormat,
-  StdOutgoingAttachmentMessage,
-  StdOutgoingButtonsMessage,
-  StdOutgoingListMessage,
-  StdOutgoingMessageEnvelope,
-  StdOutgoingQuickRepliesMessage,
-  StdOutgoingTextMessage,
-} from '@/chat/types/message';
-import { ActionOptions } from '@/chat/types/options';
 import { ContentOrmEntity } from '@/cms/entities/content.entity';
 import { I18nService } from '@/i18n';
 import { LoggerService } from '@/logger';
 
 import { Web } from '../types';
 
-export type WebOutboundEncodeOptions = ActionOptions;
+export type WebSourceScopedEncodeOptions = ActionOptions & {
+  sourceId: string;
+};
 
 export class WebOutboundMessageEncoder extends ChannelOutboundMessageEncoder<
   Web.OutboundMessageBase,
-  WebOutboundEncodeOptions
+  WebSourceScopedEncodeOptions
 > {
   constructor(
-    private readonly channelName: ChannelName,
     private readonly i18n: I18nService,
     private readonly logger: LoggerService,
     private readonly channelAttachmentService: ChannelAttachmentService,
@@ -46,26 +47,29 @@ export class WebOutboundMessageEncoder extends ChannelOutboundMessageEncoder<
 
   async encode(
     envelope: StdOutgoingMessageEnvelope,
-    options: WebOutboundEncodeOptions = {},
+    options: WebSourceScopedEncodeOptions,
   ): Promise<Web.OutboundMessageBase> {
+    if (!options?.sourceId) {
+      throw new Error('Missing sourceId in outbound encode options');
+    }
+
     return await this.dispatchEnvelope(envelope, options, {
-      [OutgoingMessageFormat.text]: ({ message }) =>
-        this.encodeTextMessage(message),
-      [OutgoingMessageFormat.quickReplies]: ({ message }) =>
-        this.encodeQuickRepliesMessage(message),
-      [OutgoingMessageFormat.buttons]: ({ message }) =>
-        this.encodeButtonsMessage(message),
-      [OutgoingMessageFormat.attachment]: ({ message }) =>
-        this.encodeAttachmentMessage(message),
-      [OutgoingMessageFormat.list]: ({ message }, actionOptions) =>
-        this.encodeListMessage(message, actionOptions),
-      [OutgoingMessageFormat.carousel]: ({ message }, actionOptions) =>
-        this.encodeCarouselMessage(message, actionOptions),
+      [OutgoingMessageType.text]: ({ data }) => this.encodeTextMessage(data),
+      [OutgoingMessageType.quickReply]: ({ data }) =>
+        this.encodeQuickRepliesMessage(data),
+      [OutgoingMessageType.buttons]: ({ data }) =>
+        this.encodeButtonsMessage(data),
+      [OutgoingMessageType.attachment]: ({ data }, sourceOptions) =>
+        this.encodeAttachmentMessage(data, sourceOptions.sourceId),
+      [OutgoingMessageType.list]: ({ data }, actionOptions) =>
+        this.encodeListMessage(data, actionOptions),
+      [OutgoingMessageType.carousel]: ({ data }, actionOptions) =>
+        this.encodeCarouselMessage(data, actionOptions),
     });
   }
 
   protected encodeTextMessage(
-    message: StdOutgoingTextMessage,
+    message: StdOutgoingTextMessageData,
   ): Web.OutboundMessageBase {
     return {
       type: Web.OutboundMessageType.text,
@@ -74,7 +78,7 @@ export class WebOutboundMessageEncoder extends ChannelOutboundMessageEncoder<
   }
 
   protected encodeQuickRepliesMessage(
-    message: StdOutgoingQuickRepliesMessage,
+    message: StdOutgoingQuickRepliesMessageData,
   ): Web.OutboundMessageBase {
     return {
       type: Web.OutboundMessageType.quick_replies,
@@ -86,7 +90,7 @@ export class WebOutboundMessageEncoder extends ChannelOutboundMessageEncoder<
   }
 
   protected encodeButtonsMessage(
-    message: StdOutgoingButtonsMessage,
+    message: StdOutgoingButtonsMessageData,
   ): Web.OutboundMessageBase {
     return {
       type: Web.OutboundMessageType.buttons,
@@ -98,14 +102,15 @@ export class WebOutboundMessageEncoder extends ChannelOutboundMessageEncoder<
   }
 
   protected async encodeAttachmentMessage(
-    message: StdOutgoingAttachmentMessage,
+    message: StdOutgoingAttachmentMessageData,
+    sourceId: string,
   ): Promise<Web.OutboundMessageBase> {
     const payload: Web.OutboundMessageBase = {
       type: Web.OutboundMessageType.file,
       data: {
         type: message.attachment.type,
         url: await this.channelAttachmentService.getPublicUrl(
-          this.channelName,
+          sourceId,
           message.attachment.payload,
         ),
       },
@@ -125,7 +130,7 @@ export class WebOutboundMessageEncoder extends ChannelOutboundMessageEncoder<
 
   protected async encodeContentElements(
     data: ContentElement[],
-    options: ActionOptions,
+    options: WebSourceScopedEncodeOptions,
   ): Promise<Web.MessageElement[]> {
     if (!options.content || !options.content.fields) {
       throw new Error('Content options are missing the fields');
@@ -151,7 +156,7 @@ export class WebOutboundMessageEncoder extends ChannelOutboundMessageEncoder<
             ? { url: item[fields.image_url] }
             : (item[fields.image_url].payload as AttachmentRef);
         element.image_url = await this.channelAttachmentService.getPublicUrl(
-          this.channelName,
+          options.sourceId,
           attachmentRef,
         );
       }
@@ -200,8 +205,8 @@ export class WebOutboundMessageEncoder extends ChannelOutboundMessageEncoder<
   }
 
   protected async encodeListMessage(
-    message: StdOutgoingListMessage,
-    options: ActionOptions,
+    message: StdOutgoingListMessageData,
+    options: WebSourceScopedEncodeOptions,
   ): Promise<Web.OutboundMessageBase> {
     const data = message.elements || [];
     const pagination = message.pagination;
@@ -241,8 +246,8 @@ export class WebOutboundMessageEncoder extends ChannelOutboundMessageEncoder<
   }
 
   protected async encodeCarouselMessage(
-    message: StdOutgoingListMessage,
-    options: ActionOptions,
+    message: StdOutgoingListMessageData,
+    options: WebSourceScopedEncodeOptions,
   ): Promise<Web.OutboundMessageBase> {
     const data = message.elements || [];
     if (data.length === 0) {
@@ -264,7 +269,7 @@ export class WebOutboundMessageEncoder extends ChannelOutboundMessageEncoder<
 }
 
 export function createWebOutboundMessageEncoder(
-  channelName: ChannelName,
+  _channelName: string,
 ): Type<WebOutboundMessageEncoder> {
   @Injectable()
   class BoundWebOutboundMessageEncoder extends WebOutboundMessageEncoder {
@@ -273,7 +278,7 @@ export function createWebOutboundMessageEncoder(
       logger: LoggerService,
       channelAttachmentService: ChannelAttachmentService,
     ) {
-      super(channelName, i18n, logger, channelAttachmentService);
+      super(i18n, logger, channelAttachmentService);
     }
   }