Frontend Authoring
Package docs status
Section titled “Package docs status”This page is generated from public package documentation in capell-4/packages and the package manifest checked into the source repository.
| Field | Value |
|---|---|
| Composer package | capell-app/frontend-authoring |
| Package slug | frontend-authoring |
| Product group | Capell Foundation |
| Tier | free |
| Bundle | foundation |
| Runtime contexts | frontend, console |
| Capell version | ^4.0 |
| Source repository | capell-app/packages |
| Source path | packages/frontend-authoring |
| Docs source | packages/frontend-authoring/docs |
| Manifest | capell.json |
Frontend authoring bridge and in-page editing for Capell frontend.
At A Glance
Section titled “At A Glance”- Package:
capell-app/frontend-authoring - Namespace:
Capell\FrontendAuthoring\ - Surfaces: Livewire, HTTP
- Service providers:
packages/frontend-authoring/src/Providers/FrontendAuthoringServiceProvider.php - Capell dependencies:
capell-app/admin,capell-app/frontend,capell-app/html-cache - Third-party dependencies:
spatie/laravel-package-tools
Why It Helps Your Capell Workflow
Section titled “Why It Helps Your Capell Workflow”- Lets authenticated admins edit page fields from the public site context without exposing authoring controls to anonymous visitors.
- Protects static caching because the public page loads as ordinary HTML and the admin-only beacon adds editing affordances later.
- Helps editors fix content in place while developers keep signed edit URLs, permissions, and field paths out of public Blade.
Best Used With
Section titled “Best Used With”What It Adds
Section titled “What It Adds”- Frontend authoring bridge and in-page editing for Capell frontend.
- Livewire components:
EditRegionField.
Built With
Section titled “Built With”This package makes its Composer dependencies visible because they are part of the value proposition, not just plumbing. When an upstream package has a public repository, its linked preview card points readers back to the maintainers so their work gets proper credit.
Capell packages used here
Open-source packages used here
- Spatie Laravel Package Tools - Laravel package bootstrapping for config, migrations, commands, translations, and service provider setup.
Linked package previews
Screens And Workflow
Section titled “Screens And Workflow”Screenshots are generated from docs/screenshots.json during package deployment.
The documentation screenshots include the package working inside capell-app: the runner logs in as an admin, opens the public homepage, waits for the beacon to decorate editable regions, and hovers the first region so the edit control is visible.
Code Map
Section titled “Code Map”| Area | Path | Purpose |
|---|---|---|
| Actions | packages/frontend-authoring/src/Actions | Domain operations. Test these directly where possible. |
| Data | packages/frontend-authoring/src/Data | Structured payloads, form state, view models, and integration data. |
| Livewire | packages/frontend-authoring/src/Livewire | Interactive frontend or admin components. |
| HTTP | packages/frontend-authoring/src/Http | Controllers, middleware, and request handling. |
| Providers | packages/frontend-authoring/src/Providers | Registration, extension hooks, routes, migrations, and resources. |
| Resources | packages/frontend-authoring/resources | Views, translations, assets, and package resources. |
| Routes | packages/frontend-authoring/routes | Route files loaded by the service provider. |
| Config | packages/frontend-authoring/config | Package configuration and publishable config. |
| Tests | packages/frontend-authoring/tests | Package-level Pest coverage. |
Runtime Surface
Section titled “Runtime Surface”- Livewire:
EditRegionField. - Controllers:
BeaconController,EditRegionController. - Routes:
packages/frontend-authoring/routes/web.php.
Data And Persistence
Section titled “Data And Persistence”- Config:
packages/frontend-authoring/config/capell-frontend-authoring.php. - Data objects live in
src/Data/; use them for payloads, form state, and view models.
Extension Points
Section titled “Extension Points”- Register Capell extension points, routes, migrations, settings, render hooks, and resources from service providers.
Install And Setup
Section titled “Install And Setup”- Install with
composer require capell-app/frontend-authoringin the host Capell application. - In this repository, verify package changes with
vendor/bin/pest; do not usephp artisan.
Testing
Section titled “Testing”Run package tests from the repository root:
vendor/bin/pest packages/frontend-authoring/tests --configuration=phpunit.xmlMaintenance Notes
Section titled “Maintenance Notes”- Never render authoring controls, model identifiers, field paths, selectors, signed editor URLs, or package hints into public HTML. Add editing affordances only after an authenticated admin beacon response.
- Put behaviour changes in
src/Actions/; UI classes, commands, and controllers should call actions instead of owning domain logic. - Use package
Dataclasses at boundaries instead of passing anonymous arrays between layers.