@mks2508/telegram-message-builder 0.2.0 → 0.3.1

package/src/builder/media.test.ts

@@ -0,0 +1,664 @@
+import { describe, it, expect } from "bun:test";
+import { TelegramMediaBuilder } from "./media";
+import type { MediaSource, MediaType, IMediaBuildResult } from "../types";
+
+describe("TelegramMediaBuilder", () => {
+  describe("Static Factory Methods", () => {
+    it("should create photo builder", () => {
+      const builder = TelegramMediaBuilder.photo("photo.jpg");
+      const result = builder.build();
+
+      expect(result.type).toBe("photo");
+      expect(result.media).toBe("photo.jpg");
+    });
+
+    it("should create video builder", () => {
+      const builder = TelegramMediaBuilder.video("video.mp4");
+      const result = builder.build();
+
+      expect(result.type).toBe("video");
+      expect(result.media).toBe("video.mp4");
+    });
+
+    it("should create document builder", () => {
+      const builder = TelegramMediaBuilder.document("doc.pdf");
+      const result = builder.build();
+
+      expect(result.type).toBe("document");
+      expect(result.media).toBe("doc.pdf");
+    });
+
+    it("should create audio builder", () => {
+      const builder = TelegramMediaBuilder.audio("audio.mp3");
+      const result = builder.build();
+
+      expect(result.type).toBe("audio");
+      expect(result.media).toBe("audio.mp3");
+    });
+
+    it("should create voice builder", () => {
+      const builder = TelegramMediaBuilder.voice("voice.ogg");
+      const result = builder.build();
+
+      expect(result.type).toBe("voice");
+      expect(result.media).toBe("voice.ogg");
+    });
+
+    it("should accept Buffer as media source", () => {
+      const buffer = Buffer.from("test");
+      const builder = TelegramMediaBuilder.photo(buffer);
+      const result = builder.build();
+
+      expect(result.media).toBe(buffer);
+    });
+
+    it("should accept URL as media source", () => {
+      const url = "https://example.com/photo.jpg";
+      const builder = TelegramMediaBuilder.photo(url);
+      const result = builder.build();
+
+      expect(result.media).toBe(url);
+    });
+
+    it("should accept file_id as media source", () => {
+      const fileId = "AgACAgIAAxkBAAI...";
+      const builder = TelegramMediaBuilder.photo(fileId);
+      const result = builder.build();
+
+      expect(result.media).toBe(fileId);
+    });
+  });
+
+  describe("Common Methods", () => {
+    it("should set caption", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("My photo")
+        .build();
+
+      expect(result.caption).toBe("My photo");
+    });
+
+    it("should set parse mode to html", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("Test")
+        .setParseMode("html")
+        .build();
+
+      expect(result.parse_mode).toBe("html");
+    });
+
+    it("should set parse mode to markdown", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("Test")
+        .setParseMode("markdown")
+        .build();
+
+      expect(result.parse_mode).toBe("markdown");
+    });
+
+    it("should set parse mode to markdownv2", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("Test")
+        .setParseMode("markdownv2")
+        .build();
+
+      expect(result.parse_mode).toBe("markdownv2");
+    });
+
+    it("should set custom option", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .setOption("protect_content", true)
+        .build();
+
+      expect(result.protect_content).toBe(true);
+    });
+
+    it("should set multiple options", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .setOptions({
+          protect_content: true,
+          disable_notification: true,
+        })
+        .build();
+
+      expect(result.protect_content).toBe(true);
+      expect(result.disable_notification).toBe(true);
+    });
+
+    it("should build with all options", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("My photo")
+        .setParseMode("html")
+        .setOption("protect_content", true)
+        .build();
+
+      expect(result.type).toBe("photo");
+      expect(result.media).toBe("photo.jpg");
+      expect(result.caption).toBe("My photo");
+      expect(result.parse_mode).toBe("html");
+      expect(result.protect_content).toBe(true);
+    });
+  });
+
+  describe("Photo Builder", () => {
+    it("should set thumbnail with string", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .thumbnail("thumb.jpg")
+        .build();
+
+      expect(result.thumb).toBe("thumb.jpg");
+    });
+
+    it("should set thumbnail with Buffer", () => {
+      const thumb = Buffer.from("thumbnail");
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .thumbnail(thumb)
+        .build();
+
+      expect(result.thumb).toBe(thumb);
+    });
+
+    it("should build photo message", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("Beautiful sunset")
+        .thumbnail("thumb.jpg")
+        .build();
+
+      expect(result.type).toBe("photo");
+      expect(result.media).toBe("photo.jpg");
+      expect(result.caption).toBe("Beautiful sunset");
+      expect(result.thumb).toBe("thumb.jpg");
+    });
+
+    it("should support all photo options", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("Photo caption")
+        .setParseMode("markdown")
+        .thumbnail("thumb.jpg")
+        .setOption("show_caption_above_media", true)
+        .setOption("protect_content", true)
+        .build();
+
+      expect(result.caption).toBe("Photo caption");
+      expect(result.parse_mode).toBe("markdown");
+      expect(result.thumb).toBe("thumb.jpg");
+      expect(result.show_caption_above_media).toBe(true);
+      expect(result.protect_content).toBe(true);
+    });
+  });
+
+  describe("Video Builder", () => {
+    it("should set duration", () => {
+      const result = TelegramMediaBuilder.video("video.mp4")
+        .duration(120)
+        .build();
+
+      expect(result.duration).toBe(120);
+    });
+
+    it("should set width", () => {
+      const result = TelegramMediaBuilder.video("video.mp4")
+        .width(1920)
+        .build();
+
+      expect(result.width).toBe(1920);
+    });
+
+    it("should set height", () => {
+      const result = TelegramMediaBuilder.video("video.mp4")
+        .height(1080)
+        .build();
+
+      expect(result.height).toBe(1080);
+    });
+
+    it("should set thumbnail", () => {
+      const result = TelegramMediaBuilder.video("video.mp4")
+        .thumbnail("thumb.jpg")
+        .build();
+
+      expect(result.thumb).toBe("thumb.jpg");
+    });
+
+    it("should enable streaming", () => {
+      const result = TelegramMediaBuilder.video("video.mp4")
+        .enableStreaming()
+        .build();
+
+      expect(result.support_streaming).toBe(true);
+    });
+
+    it("should build video message", () => {
+      const result = TelegramMediaBuilder.video("video.mp4")
+        .caption("My video")
+        .duration(120)
+        .width(1920)
+        .height(1080)
+        .thumbnail("thumb.jpg")
+        .build();
+
+      expect(result.type).toBe("video");
+      expect(result.media).toBe("video.mp4");
+      expect(result.caption).toBe("My video");
+      expect(result.duration).toBe(120);
+      expect(result.width).toBe(1920);
+      expect(result.height).toBe(1080);
+      expect(result.thumb).toBe("thumb.jpg");
+    });
+  });
+
+  describe("Document Builder", () => {
+    it("should set thumbnail", () => {
+      const result = TelegramMediaBuilder.document("doc.pdf")
+        .thumbnail("thumb.jpg")
+        .build();
+
+      expect(result.thumb).toBe("thumb.jpg");
+    });
+
+    it("should set filename", () => {
+      const result = TelegramMediaBuilder.document("doc.pdf")
+        .fileName("report.pdf")
+        .build();
+
+      expect(result.file_name).toBe("report.pdf");
+    });
+
+    it("should set mime type", () => {
+      const result = TelegramMediaBuilder.document("doc.pdf")
+        .mimeType("application/pdf")
+        .build();
+
+      expect(result.mime_type).toBe("application/pdf");
+    });
+
+    it("should disable content type detection", () => {
+      const result = TelegramMediaBuilder.document("file.bin")
+        .disableContentTypeDetection()
+        .build();
+
+      expect(result.disable_content_type_detection).toBe(true);
+    });
+
+    it("should build document message", () => {
+      const result = TelegramMediaBuilder.document("report.pdf")
+        .caption("Q4 Report")
+        .fileName("q4_2024.pdf")
+        .mimeType("application/pdf")
+        .disableContentTypeDetection()
+        .build();
+
+      expect(result.type).toBe("document");
+      expect(result.media).toBe("report.pdf");
+      expect(result.caption).toBe("Q4 Report");
+      expect(result.file_name).toBe("q4_2024.pdf");
+      expect(result.mime_type).toBe("application/pdf");
+      expect(result.disable_content_type_detection).toBe(true);
+    });
+  });
+
+  describe("Audio Builder", () => {
+    it("should set duration", () => {
+      const result = TelegramMediaBuilder.audio("song.mp3")
+        .duration(180)
+        .build();
+
+      expect(result.duration).toBe(180);
+    });
+
+    it("should set performer", () => {
+      const result = TelegramMediaBuilder.audio("song.mp3")
+        .performer("Artist Name")
+        .build();
+
+      expect(result.performer).toBe("Artist Name");
+    });
+
+    it("should set title", () => {
+      const result = TelegramMediaBuilder.audio("song.mp3")
+        .title("Song Title")
+        .build();
+
+      expect(result.title).toBe("Song Title");
+    });
+
+    it("should set thumbnail", () => {
+      const result = TelegramMediaBuilder.audio("song.mp3")
+        .thumbnail("album_art.jpg")
+        .build();
+
+      expect(result.thumb).toBe("album_art.jpg");
+    });
+
+    it("should build audio message", () => {
+      const result = TelegramMediaBuilder.audio("song.mp3")
+        .caption("My favorite song")
+        .duration(180)
+        .performer("Artist Name")
+        .title("Song Title")
+        .thumbnail("album_art.jpg")
+        .build();
+
+      expect(result.type).toBe("audio");
+      expect(result.media).toBe("song.mp3");
+      expect(result.caption).toBe("My favorite song");
+      expect(result.duration).toBe(180);
+      expect(result.performer).toBe("Artist Name");
+      expect(result.title).toBe("Song Title");
+      expect(result.thumb).toBe("album_art.jpg");
+    });
+  });
+
+  describe("Voice Builder", () => {
+    it("should set duration", () => {
+      const result = TelegramMediaBuilder.voice("voice.ogg")
+        .duration(30)
+        .build();
+
+      expect(result.duration).toBe(30);
+    });
+
+    it("should build voice message", () => {
+      const result = TelegramMediaBuilder.voice("voice.ogg")
+        .caption("Listen to this")
+        .duration(30)
+        .build();
+
+      expect(result.type).toBe("voice");
+      expect(result.media).toBe("voice.ogg");
+      expect(result.caption).toBe("Listen to this");
+      expect(result.duration).toBe(30);
+    });
+  });
+
+  describe("Caption Formatting", () => {
+    it("should format caption in HTML mode (default)", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("<b>My photo</b>")
+        .build();
+
+      expect(result.caption).toBe("&lt;b&gt;My photo&lt;/b&gt;");
+      expect(result.parse_mode).toBe("html");
+    });
+
+    it("should format caption in Markdown mode", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("*My photo*")
+        .setParseMode("markdown")
+        .build();
+
+      expect(result.caption).toBe("\\*My photo\\*");
+      expect(result.parse_mode).toBe("markdown");
+    });
+
+    it("should format caption in MarkdownV2 mode", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("_My photo_")
+        .setParseMode("markdownv2")
+        .build();
+
+      expect(result.caption).toBe("\\_My photo\\_");
+      expect(result.parse_mode).toBe("markdownv2");
+    });
+
+    it("should escape HTML entities in caption", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("<script>alert('xss')</script>")
+        .build();
+
+      expect(result.caption).toContain("&lt;");
+      expect(result.caption).toContain("&gt;");
+    });
+
+    it("should escape special chars in MDv2 caption", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("_*[]()~`>#+-=|{}.!")
+        .setParseMode("markdownv2")
+        .build();
+
+      expect(result.caption).toContain("\\_");
+      expect(result.caption).toContain("\\*");
+      expect(result.caption).toContain("\\~");
+    });
+  });
+
+  describe("Fluent API", () => {
+    it("should support method chaining", () => {
+      const result = TelegramMediaBuilder.video("video.mp4")
+        .caption("My video")
+        .duration(120)
+        .width(1920)
+        .height(1080)
+        .thumbnail("thumb.jpg")
+        .enableStreaming()
+        .setParseMode("markdown")
+        .setOption("protect_content", true)
+        .build();
+
+      expect(result.type).toBe("video");
+      expect(result.caption).toBe("My video");
+      expect(result.duration).toBe(120);
+      expect(result.width).toBe(1920);
+      expect(result.height).toBe(1080);
+      expect(result.thumb).toBe("thumb.jpg");
+      expect(result.support_streaming).toBe(true);
+      expect(result.parse_mode).toBe("markdown");
+      expect(result.protect_content).toBe(true);
+    });
+
+    it("should build complex message", () => {
+      const result = TelegramMediaBuilder.document("report.pdf")
+        .caption("*Q4 2024 Report*")
+        .setParseMode("markdownv2")
+        .fileName("q4_2024.pdf")
+        .mimeType("application/pdf")
+        .thumbnail("thumb.jpg")
+        .disableContentTypeDetection()
+        .setOptions({
+          protect_content: true,
+          disable_notification: false,
+        })
+        .build();
+
+      expect(result.type).toBe("document");
+      expect(result.caption).toContain("\\*");
+      expect(result.parse_mode).toBe("markdownv2");
+      expect(result.file_name).toBe("q4_2024.pdf");
+      expect(result.mime_type).toBe("application/pdf");
+      expect(result.thumb).toBe("thumb.jpg");
+      expect(result.disable_content_type_detection).toBe(true);
+      expect(result.protect_content).toBe(true);
+      expect(result.disable_notification).toBe(false);
+    });
+  });
+
+  describe("Edge Cases", () => {
+    it("should handle empty caption", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("")
+        .build();
+
+      expect(result.caption).toBe("");
+    });
+
+    it("should handle no caption", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg").build();
+
+      expect(result.caption).toBeUndefined();
+      expect(result.parse_mode).toBeUndefined();
+    });
+
+    it("should handle special characters in caption", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("Special: <>&\"'")
+        .build();
+
+      expect(result.caption).toContain("&lt;");
+      expect(result.caption).toContain("&gt;");
+      expect(result.caption).toContain("&quot;");
+      expect(result.caption).toContain("&amp;");
+    });
+
+    it("should handle unicode in caption", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption("🎉 Party! 🎊")
+        .build();
+
+      expect(result.caption).toContain("🎉");
+      expect(result.caption).toContain("🎊");
+    });
+
+    it("should handle very long captions (up to 1024 chars)", () => {
+      const longCaption = "A".repeat(1024);
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .caption(longCaption)
+        .build();
+
+      expect(result.caption).toHaveLength(1024);
+    });
+
+    it("should handle Buffer as media source", () => {
+      const buffer = Buffer.from("test data");
+      const result = TelegramMediaBuilder.photo(buffer).caption("Test").build();
+
+      expect(result.media).toBe(buffer);
+      expect(Buffer.isBuffer(result.media)).toBe(true);
+    });
+
+    it("should handle URL as media source", () => {
+      const url = "https://example.com/path/to/photo.jpg";
+      const result = TelegramMediaBuilder.photo(url)
+        .caption("From URL")
+        .build();
+
+      expect(result.media).toBe(url);
+      expect(result.type).toBe("photo");
+      expect(result.caption).toBe("From URL");
+    });
+
+    it("should handle file_id as media source", () => {
+      const fileId = "AgACAgIAAxkBAAI...";
+      const result = TelegramMediaBuilder.photo(fileId)
+        .caption("Existing file")
+        .build();
+
+      expect(result.media).toBe(fileId);
+      expect(result.type).toBe("photo");
+      expect(result.caption).toBe("Existing file");
+    });
+
+    it("should handle empty options", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .setOptions({})
+        .build();
+
+      expect(result.type).toBe("photo");
+      expect(result.media).toBe("photo.jpg");
+    });
+
+    it("should override options when set multiple times", () => {
+      const result = TelegramMediaBuilder.photo("photo.jpg")
+        .setOption("protect_content", false)
+        .setOption("protect_content", true)
+        .build();
+
+      expect(result.protect_content).toBe(true);
+    });
+
+    it("should handle zero duration", () => {
+      const result = TelegramMediaBuilder.video("video.mp4")
+        .duration(0)
+        .build();
+
+      expect(result.duration).toBe(0);
+    });
+
+    it("should handle negative duration", () => {
+      const result = TelegramMediaBuilder.audio("audio.mp3")
+        .duration(-1)
+        .build();
+
+      expect(result.duration).toBe(-1);
+    });
+
+    it("should handle zero dimensions", () => {
+      const result = TelegramMediaBuilder.video("video.mp4")
+        .width(0)
+        .height(0)
+        .build();
+
+      expect(result.width).toBe(0);
+      expect(result.height).toBe(0);
+    });
+
+    it("should handle large dimensions", () => {
+      const result = TelegramMediaBuilder.video("video.mp4")
+        .width(4096)
+        .height(2160)
+        .build();
+
+      expect(result.width).toBe(4096);
+      expect(result.height).toBe(2160);
+    });
+  });
+
+  describe("Return Type Validation", () => {
+    it("should return IMediaBuildResult structure", () => {
+      const result: IMediaBuildResult =
+        TelegramMediaBuilder.photo("photo.jpg").build();
+
+      expect(result).toHaveProperty("media");
+      expect(result).toHaveProperty("type");
+      expect(typeof result.media).toBe("string" as keyof MediaSource);
+      expect(typeof result.type).toBe("string");
+    });
+
+    it("should have correct media type for each builder", () => {
+      const photo = TelegramMediaBuilder.photo("p").build();
+      const video = TelegramMediaBuilder.video("v").build();
+      const document = TelegramMediaBuilder.document("d").build();
+      const audio = TelegramMediaBuilder.audio("a").build();
+      const voice = TelegramMediaBuilder.voice("v").build();
+
+      expect(photo.type).toBe("photo");
+      expect(video.type).toBe("video");
+      expect(document.type).toBe("document");
+      expect(audio.type).toBe("audio");
+      expect(voice.type).toBe("voice");
+    });
+  });
+
+  describe("Type Safety", () => {
+    it("should infer media type from factory method", () => {
+      const photoBuilder = TelegramMediaBuilder.photo("photo.jpg");
+      const videoBuilder = TelegramMediaBuilder.video("video.mp4");
+
+      type PhotoType =
+        typeof photoBuilder extends TelegramMediaBuilder<infer T> ? T : never;
+      type VideoType =
+        typeof videoBuilder extends TelegramMediaBuilder<infer T> ? T : never;
+
+      const photoType: PhotoType = "photo";
+      const videoType: VideoType = "video";
+
+      expect(photoType).toBe("photo");
+      expect(videoType).toBe("video");
+    });
+
+    it("should accept only valid media types", () => {
+      const validTypes: MediaType[] = [
+        "photo",
+        "video",
+        "document",
+        "audio",
+        "voice",
+      ];
+
+      validTypes.forEach((type) => {
+        expect(["photo", "video", "document", "audio", "voice"]).toContain(
+          type,
+        );
+      });
+    });
+  });
+});