fix: add attachments support (#304)

sirily11 · web-flow · commit 799f03f856aa · 2025-01-09T02:46:42.000Z
diff --git a/packages/common/src/adapter.interface.ts b/packages/common/src/adapter.interface.ts
@@ -301,7 +301,10 @@ export interface AdapterInterface<
    * @param message
    * @param options Options for creating the container.
    */
-  createContainer: (message: Message, options: CreateContainerOptions) => C;
+  createContainer: (
+    message: Message,
+    options: CreateContainerOptions,
+  ) => Promise<C>;
 
   /**
    * Authorizes the request.
diff --git a/packages/common/src/attachment.interface.ts b/packages/common/src/attachment.interface.ts
@@ -0,0 +1,154 @@
+/**
+ * Add more attachment types as needed.
+ */
+export enum AttachmentType {
+  /**
+   * An image attachment.
+   */
+  Image = "image",
+  /**
+   * A video attachment.
+   */
+  Video = "video",
+  /**
+   * An audio attachment.
+   */
+  Audio = "audio",
+  /**
+   * A file attachment.
+   */
+  File = "file",
+  /**
+   * A user recorded voice attachment.
+   */
+  Voice = "voice",
+  /**
+   * A sticker attachment.
+   */
+  Sticker = "sticker",
+  /**
+   * A contact attachment.
+   */
+  Contact = "contact",
+  /**
+   * A location attachment.
+   */
+  Location = "location",
+  /**
+   * A poll attachment.
+   */
+  Poll = "poll",
+  /**
+   * A quiz attachment.
+   */
+  Quiz = "quiz",
+  /**
+   * A button attachment.
+   */
+  Button = "button",
+}
+
+export type BaseAttachment = {
+  type: AttachmentType;
+};
+
+export type ImageAttachment = BaseAttachment & {
+  type: AttachmentType.Image;
+  url: string;
+};
+
+export type VideoAttachment = BaseAttachment & {
+  type: AttachmentType.Video;
+  url: string;
+  thumbnail?: string;
+};
+
+export type AudioAttachment = BaseAttachment & {
+  type: AttachmentType.Audio;
+  url: string;
+  duration?: number;
+};
+
+export type FileAttachment = BaseAttachment & {
+  type: AttachmentType.File;
+  url: string;
+  size?: number;
+  mimeType?: string;
+};
+
+export type VoiceAttachment = BaseAttachment & {
+  type: AttachmentType.Voice;
+  url: string;
+  duration: number;
+};
+
+export type StickerAttachment = BaseAttachment & {
+  type: AttachmentType.Sticker;
+  url: string;
+};
+
+// Data-based attachments
+export type ContactAttachment = BaseAttachment & {
+  type: AttachmentType.Contact;
+  data: {
+    name: string;
+    phoneNumber: string;
+    email?: string;
+  };
+};
+
+export type LocationAttachment = BaseAttachment & {
+  type: AttachmentType.Location;
+  data: {
+    latitude: number;
+    longitude: number;
+    address?: string;
+  };
+};
+
+export type PollAttachment = BaseAttachment & {
+  type: AttachmentType.Poll;
+  data: {
+    question: string;
+    options: {
+      text: string;
+      votes: number;
+    }[];
+    multipleChoice?: boolean;
+    endTime?: string;
+  };
+};
+
+export type QuizAttachment = BaseAttachment & {
+  type: AttachmentType.Quiz;
+  data: {
+    question: string;
+    options: string[];
+    correctAnswer: number;
+    explanation?: string;
+  };
+};
+
+export type ButtonAttachment = BaseAttachment & {
+  type: AttachmentType.Button;
+  data: {
+    text: string;
+    url?: string;
+    action?: string;
+    payload?: Record<string, unknown>;
+  };
+};
+
+// Union type of all possible attachments
+export type Attachment =
+  | ImageAttachment
+  | VideoAttachment
+  | AudioAttachment
+  | FileAttachment
+  | VoiceAttachment
+  | StickerAttachment
+  | ContactAttachment
+  | LocationAttachment
+  | PollAttachment
+  | QuizAttachment
+  | ButtonAttachment;
diff --git a/packages/common/src/container.interface.ts b/packages/common/src/container.interface.ts
@@ -1,4 +1,5 @@
 import type React from "react";
+import { Attachment } from "./attachment.interface";
 
 export enum ContainerType {
   ROOT = "ROOT",
@@ -46,4 +47,9 @@ export interface Container<
    * For example, in `Telegram`, if user type `@bot_name`, the bot will be mentioned.
    */
   hasBeenMentioned: boolean;
+
+  /**
+   * Attachments that are sent with the message.
+   */
+  attachments: Attachment[];
 }
diff --git a/packages/common/src/index.ts b/packages/common/src/index.ts
@@ -10,3 +10,4 @@ export * from "./router.interface";
 export * from "./storage.interface";
 export * from "./page.interface";
 export * from "./compiler.interface";
+export * from "./attachment.interface";
diff --git a/packages/common/src/page.interface.ts b/packages/common/src/page.interface.ts
@@ -1,4 +1,5 @@
 import type { ReactNode } from "react";
+import { Attachment } from "./attachment.interface";
 import { RouteInfoFile } from "./router.interface";
 import { StorageClientInterface } from "./storage.interface";
 
@@ -65,6 +66,11 @@ export interface PageProps {
    * The chatroom id of the current chatroom.
    */
   chatroomId: string;
+
+  /**
+   * Attachments that are sent with the message.
+   */
+  attachments: Attachment[];
 }
 
 export interface ErrorPageProps {
diff --git a/packages/core/src/components/builder/componentBuilder.spec.ts b/packages/core/src/components/builder/componentBuilder.spec.ts
@@ -20,6 +20,7 @@ describe("should be able to build component", () => {
         type: ContainerType.ROOT,
         hasBeenMentioned: false,
         isInGroup: false,
+        attachments: [],
       },
       {},
     );
@@ -39,6 +40,7 @@ describe("should be able to build component", () => {
         type: ContainerType.ROOT,
         hasBeenMentioned: false,
         isInGroup: false,
+        attachments: [],
       },
       {},
     );
@@ -55,6 +57,7 @@ describe("should be able to build component", () => {
         type: ContainerType.ROOT,
         hasBeenMentioned: false,
         isInGroup: false,
+        attachments: [],
       },
       {},
     );
@@ -75,6 +78,7 @@ describe("should be able to build component", () => {
           type: ContainerType.ROOT,
           hasBeenMentioned: false,
           isInGroup: false,
+          attachments: [],
         },
         {},
       ),
@@ -94,6 +98,7 @@ describe("should be able to build component", () => {
           type: ContainerType.ROOT,
           hasBeenMentioned: false,
           isInGroup: false,
+          attachments: [],
         },
         {},
       ),
@@ -113,6 +118,7 @@ describe("should be able to build component", () => {
           type: ContainerType.ROOT,
           hasBeenMentioned: false,
           isInGroup: false,
+          attachments: [],
         },
         {},
       ),
@@ -133,6 +139,7 @@ describe("should be able to build component", () => {
           type: ContainerType.ROOT,
           hasBeenMentioned: false,
           isInGroup: false,
+          attachments: [],
         },
         {},
       ),
@@ -149,6 +156,7 @@ describe("should be able to build component", () => {
           type: ContainerType.ROOT,
           hasBeenMentioned: false,
           isInGroup: false,
+          attachments: [],
         },
         {},
       ),
diff --git a/packages/core/src/core/core.spec.tsx b/packages/core/src/core/core.spec.tsx
@@ -102,6 +102,7 @@ describe.skip("Reconciler(Suspendable)", () => {
       children: [],
       hasBeenMentioned: false,
       isInGroup: false,
+      attachments: [],
     });
 
     expect(mockAdapter.messages).toHaveLength(0);
@@ -124,6 +125,7 @@ describe.skip("Reconciler(Suspendable)", () => {
       message: undefined,
       hasBeenMentioned: false,
       isInGroup: false,
+      attachments: [],
     });
 
     await new Promise((resolve) => setTimeout(resolve, 1000));
diff --git a/packages/core/src/core/core.tsx b/packages/core/src/core/core.tsx
@@ -189,15 +189,15 @@ export class Core<T extends Container<BaseChatroomInfo, BaseMessage>>
         return container;
       },
       clientRedirectTo: async (message, path, options) => {
-        const container = this.adapter.createContainer(message, {
+        const container = await this.adapter.createContainer(message, {
           renderNewMessage: options.renderNewMessage ?? true,
           userId: options.userId,
         });
         await this.redirect(container, { route: path }, options);
         return container;
       },
       reload: async (message: BaseMessage, options: ReloadOptions) => {
-        const container = this.adapter.createContainer(message, {
+        const container = await this.adapter.createContainer(message, {
           renderNewMessage: options.shouldRenderNewMessage ?? false,
         });
         // get the current route
@@ -283,10 +283,17 @@ export class Core<T extends Container<BaseChatroomInfo, BaseMessage>>
   }
 
   async handleMessageUpdate(request: Request, message: BaseMessage) {
-    await this.adapter.authorize(request);
-    await this.adapter.handleMessageUpdate(message);
-    this.updateLastCommitUpdateTime();
-    return this.waitForMessageToBeSent();
+    try {
+      await this.adapter.authorize(request);
+      await this.adapter.handleMessageUpdate(message);
+      this.updateLastCommitUpdateTime();
+      return this.waitForMessageToBeSent();
+    } catch (e) {
+      if (e instanceof SkipError) {
+        return;
+      }
+      throw e;
+    }
   }
 
   async redirect(container: T, routeOrObject: any, options?: RedirectOptions) {
@@ -504,6 +511,7 @@ export class Core<T extends Container<BaseChatroomInfo, BaseMessage>>
       hasBeenMentioned: container.hasBeenMentioned,
       messageId: container.chatroomInfo.messageId?.toString() as any,
       chatroomId: container.chatroomInfo.id.toString() as any,
+      attachments: container.attachments,
       ...this.element.props,
       ...oldProps,
       storage: {
diff --git a/packages/telegram-adapter/src/adapter.spec.ts b/packages/telegram-adapter/src/adapter.spec.ts
@@ -1,9 +1,9 @@
 import { Menu } from "@rx-lab/common";
+import { AuthorizationError } from "@rx-lab/errors";
 import * as TelegramBot from "node-telegram-bot-api";
 import { TGContainer, TelegramAdapter } from "./adapter";
 import { renderElement } from "./renderer";
 import { DEFAULT_ROOT_PATH } from "./types";
-import { AuthorizationError } from "@rx-lab/errors";
 
 jest.mock("node-telegram-bot-api");
 jest.mock("./callbackParser");
@@ -34,6 +34,7 @@ describe("TelegramAdapter", () => {
         hasUpdated: false,
         hasBeenMentioned: false,
         isInGroup: false,
+        attachments: [],
       };
 
       const result = await adapter.adapt(container as any, false);
@@ -52,6 +53,7 @@ describe("TelegramAdapter", () => {
         hasUpdated: true,
         hasBeenMentioned: false,
         isInGroup: false,
+        attachments: [],
       };
 
       const result = await adapter.adapt(container as any, false);
@@ -73,6 +75,7 @@ describe("TelegramAdapter", () => {
         hasUpdated: true,
         hasBeenMentioned: false,
         isInGroup: false,
+        attachments: [],
       };
 
       await adapter.adapt(container as any, false);
@@ -129,6 +132,7 @@ describe("TelegramAdapter", () => {
         hasUpdated: true,
         hasBeenMentioned: false,
         isInGroup: false,
+        attachments: [],
       };
 
       const result = await adapter.adapt(container as any, false);
diff --git a/packages/telegram-adapter/src/adapter.ts b/packages/telegram-adapter/src/adapter.ts
