Webbook

Learner webbook viewer — theme resolution / progress calculation / content mode decision (Pure) (Layer 3 Domain).

Status

Key	Value
Layer	domain
Tier	L1
Status	wip
Version	0.9.0
Price	Free (free)
Category	Content

Overview

Overview

Webbook is a Layer 3 Domain Plugin of multi-saas-kit. It provides the core decision logic for the learner viewer — theme / progress / content mode — as Pure services without model dependencies.

Layer atop DocumentProcessor (HtmlRenderer) and Annotation (anchor visibility).

Core Components (3 Pure Services)

ThemeResolver

Extracted from academy.how's WebbookController::resolveEffectiveTheme. 4-level priority:

1. URL ?theme=xxx (operator preview)
2. Book.theme (per-book mood)
3. Tenant.settings.academy.default_theme (organization default)
4. config default ('system')

Allowed whitelist enforced at each level — disallowed values fall through.

ProgressCalculator + LessonProgress DTO

Extracted from WebbookController::showLesson. Computes progress / prev / next from lesson id array + current id alone.

Output: currentIndex (0-based), total, progressPercent, prevId, nextId, toArray() with current_position (1-based).

ContentModeResolver

Extracted from WebbookController::showLesson's image | html branch.

• Input: ?content=xxx + hasActiveHtml: bool
• 'html' requested + no active html → fallback to 'image'
• Disallowed → default

Configuration

return [
    'enabled' => env('PLG_WEBBOOK_ENABLED', true),
    'theme' => [
        'allowed' => ['system', 'light', 'dark', 'sepia', 'high_contrast', 'soft', 'ocean', 'forest'],
        'default' => 'system',
    ],
    'content_mode' => [
        'allowed' => ['image', 'html'],
        'default' => 'image',
    ],
];

Usage

$theme = ThemeResolver::fromConfig(config('webbook'))->resolve(
    $request->query('theme'),
    $book->theme,
    $tenant?->settings,
);

$progress = (new ProgressCalculator)->calculate(
    $allLessons->pluck('id')->all(),
    $currentLesson->id,
);

$contentMode = ContentModeResolver::fromConfig(config('webbook'))->resolve(
    $request->query('content'),
    hasActiveHtml: $activeHtml !== null,
);

Origin

Extracted from academy.how's WebbookController. Eloquent Book/Lesson/Page/Asset model dependencies remain in the project; only model-free decision logic was extracted.

Dependencies

• DocumentProcessor — caller uses HtmlRenderer / activeDocument
• Annotation — caller renders anchor tips/notes

Plugin Relationships

• LessonThread — embed thread widget in lesson page (optional)

Roadmap (Phase 3+)

• Standard Book / Lesson / Page Model + Migration (opt-in)
• Filament Resource
• Vue/React viewer SDK
• Pattern composition + tip injection integration

License

MIT

Dependencies

• DocumentProcessor
• Annotation

Demos

• Platform 관리자 패널에서 메타 확인 🔒 Login required
• 사용 예시 (PHP)

---

🛒 View on Plugin Store: store.codebase.how/plugins/webbook