feature-book_content_viewer#

한마디로 (비개발자용)#

전자책 뷰어 화면을 처음부터 손으로 만드는 대신, 미리 짜둔 설계도로 한 번에 찍어내는 도구입니다. 마치 모델 하우스 골조를 자동으로 세워 주는 것처럼, 책을 넘기고 읽는 화면에 필요한 기본 뼈대와 부품(서버 연결, 화면, 데이터 저장 등)을 자동으로 만들어 줍니다. 개발자는 이 위에 세부 기능만 다듬으면 됩니다.

무엇을·언제 (비개발자용)#

• 무엇을 해 주나요: 전자책(PDF) 뷰어에 필요한 핵심 기능들을 한 번에 생성합니다. 예를 들어 페이지 넘기기(PDF 렌더링), 책갈피(북마크), 손글씨 메모(필기), 형광펜(마커), 어디까지 읽었는지 기록(읽기 진행률), 음성으로 읽어 주기(TTS), 앱 안에서 책을 구매하는 결제 기능까지 포함됩니다.
• 함께 만들어 주는 것: 화면(앱)뿐 아니라 뒤에서 데이터를 주고받는 서버 쪽 모듈도 같이 생성됩니다.
• 언제 쓰나요: 새 전자책 뷰어 기능을 처음 만들기 시작할 때, 또는 기존 뷰어 모듈을 확장하거나 비슷한 화면을 빠르게 또 하나 만들 때 사용합니다.
• 어떻게 시작하나요: 정해진 명령어(mason make ...) 한 줄을 실행하면, 책 이름이나 모듈 이름 같은 값에 맞춰 파일과 폴더가 자동으로 채워집니다.

핵심 용어 (비개발자용)#

Generates a Clean Architecture-based feature module for book content viewer functionality. A large-scale feature module that includes all core e-book viewer features such as PDF page rendering, bookmarks, scribbles, markers, reading progress management, TTS, and in-app purchases.

Quick Start#

mason make feature-book_content_viewer \
  --project_name my_app \
  --org_name myorg \
  --feature_name book_content_viewer

# Generate with custom entity name
mason make feature-book_content_viewer \
  --feature_name ebook_viewer \
  --primary_entity EbookContent \
  --secondary_entity ViewerProgress

Variables#

Generated Structure#

feature/application/{feature_name}/
├── lib/
│   ├── {feature_name}.dart
│   └── src/
│       ├── data/         # Repository implementation
│       ├── domain/       # Entity, UseCase, Repository Interface
│       ├── presentation/ # BLoC, Page, Widget
│       ├── route/        # GoRouter TypedRoute
│       └── di/           # Dependency Injection
└── test/                 # Unit, BDD tests

Backend Module#

A Serverpod backend module is generated alongside:

backend/ { { project_name } } _server/lib/src/feature/ { { feature_name } } /
├── endpoint/     # CRUD endpoints
├── service/      # Business logic
├── model/        # Entity, DTO (.spy.yaml)
├── exception/    # Exception handling
├── validation/   # Input validation
└── test/         # Tests

Modern path. Generate this feature full-stack with cob compose -m feature.yaml — the backend comes from the backend_feature brick (13 backend: file toggles) plus one b-entity per models.entities, and cob auto-registers routes + the melos workspace. See the plugin README → Generation Workflows.

Backend genericization (Epic #83). This feature has no dedicated has_X flag in the embedded serverpod_backend brick yet — Epic #83 wired backend has_X for store, chat, ai_chat, and book_content_reader only (broader frontend↔backend gating is a planned S2 follow-up, coco-de/bricks#85). A composed backend module is still produced via backend_feature when declared in feature.yaml.

primary_entity / secondary_entity are not raw Mason brick vars — pass them via cob apply --primary-entity/--secondary-entity or declare them under models.entities in feature.yaml.

Key Components#

Domain#

• Entities: PageViewModel, PdfImageCacheManager
• UseCases: Book(Get, CheckPurchase), Bookmark(Toggle, Get, Update, Delete), Scribble(Save/Load/Delete Local, Upload/Download Server, Merge/Split), Marker(Create, Update, Delete, GetPage, GetTotal), PDF(Download, Merge, ClearCache), Payment(ChargeWallet, GetPackages, GetBalance, GetCoupons, ValidateCoupon, Purchase), Progress(Get, Update), TTS(Speak, Stop), ScreenProtectToggle
• Repositories: IBookContentViewerRepository, IBookmarkRepository, IPdfMarkerRepository, IS3OperationRepository, IScribbleRepository, ITextHighlightRepository

Presentation#

• BLoC: BookContentViewerBloc, ScribbleBloc, ViewerPaymentBloc
• Pages: BookContentViewerPage

Customization#

Changing the feature_name variable automatically updates all file names, class names, and import paths:

mason make feature-book_content_viewer --feature_name pdf_viewer