feat(api): Add AbstractGenerator type

src/api/src/create_book/generators/new_epub.py

@@ -5,9 +5,10 @@ from bs4 import BeautifulSoup
 from ebooklib import epub
 
 from ..models import Story
+from .types import AbstractGenerator
 
 
-class EPUBGenerator:
+class EPUBGenerator(AbstractGenerator):
     def __init__(
         self,
         metadata: Story,
@@ -23,6 +24,7 @@ class EPUBGenerator:
         self.book = epub.EpubBook()
 
     def add_metadata(self):
+        """Add metadata to epub."""
         self.book.add_author(self.story["user"]["username"])
 
         self.book.add_metadata("DC", "title", self.story["title"])
@@ -48,6 +50,7 @@ class EPUBGenerator:
         )
 
     def add_cover(self):
+        """Add cover to epub."""
         self.book.set_cover("cover.jpg", self.cover)
         cover_chapter = epub.EpubHtml(
             file_name="titlepage.xhtml",  # Standard for cover page
@@ -56,6 +59,7 @@ class EPUBGenerator:
         self.book.add_item(cover_chapter)
 
     def add_chapters(self):
+        """Add chapters to epub, replacing references to image urls to static image paths if images are provided during initialization."""
         chapters = []
 
         for idx, (part, tree) in enumerate(zip(self.story["parts"], self.parts)):

src/api/src/create_book/generators/types.py

@@ -0,0 +1,47 @@
+from io import BytesIO
+from tempfile import NamedTemporaryFile
+from typing import List, Literal
+
+from bs4 import BeautifulSoup
+from ebooklib.epub import EpubBook
+
+from ..models import Story
+
+
+class AbstractGenerator:
+    """Compile parsed part trees to a file.
+
+    Args:
+        metadata (Story): Story Metadata.
+        part_trees (List[BeautifulSoup]): Parsed part trees.
+        cover (bytes): Cover image.
+        images (List[List[bytes]] | None): An array of images for each chapter, if images have been downloaded.
+    """
+
+    def __init__(
+        self,
+        metadata: Story,
+        part_trees: List[BeautifulSoup],
+        cover: bytes,
+        images: List[List[bytes]] | None,
+    ):
+        self.story = metadata
+        self.parts = part_trees
+        self.cover = cover
+        self.images = images
+
+        self.book: EpubBook | NamedTemporaryFile = None
+
+    def compile(self) -> Literal[True]:
+        """Compile the part trees into the corresponding in-memory representation of the generator format.
+
+        Returns:
+            Literal[True]: Compiled successfully.
+        """
+        return True
+
+    def dump(self) -> BytesIO:
+        """Return a Buffer of the compiled file."""
+        buffer = BytesIO()
+
+        return buffer