Skip to content
Capell CMS

Frontend Authoring

Package docs status

Section titled “Package docs status”

This page is generated from package source documentation in the Capell packages repository and the checked-in manifest. Source documentation is not distribution status. Before running a Composer command, verify that the exact package and compatible 1.x release are available through public Packagist or the authenticated marketplace account.

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 ^1.0
Catalogue role extension
Release channel Beta
Source repository capell-app/packages
Source path packages/frontend-authoring
Docs source packages/frontend-authoring/docs
Manifest capell.json

What This Plugin Adds

Section titled “What This Plugin Adds”

Frontend Authoring is an Available, No schema impact Capell package in the Capell Foundation product group. It ships as capell-app/frontend-authoring and extends these surfaces: frontend, console.

Frontend Authoring adds in-page editing through an admin-only beacon that returns editable regions and signed editor URLs after an ordinary public page has loaded.

Authorized admins see post-load edit controls on the live page, while anonymous and non-admin visitors receive no authoring payload, markers, model identifiers, or editor URLs.

Evidence: capell.json, routes/web.php, src/Actions/BuildBeaconResponseAction.php, src/Providers/FrontendAuthoringServiceProvider.php, docs/screenshots.json, src/Http/Controllers/BeaconController.php, tests/Feature/BeaconControllerTest.php, tests/Unit/Support/FrontendAuthoringRuntimeManifestContributorTest.php.

Status details:

  • Status: Available
  • Tier: free
  • Bundle: foundation
  • Composer package: capell-app/frontend-authoring
  • Namespace: Capell\FrontendAuthoring
  • Theme key: not applicable

Why It Matters

Section titled “Why It Matters”

For developers: Editable-region registries, authorization and validation Actions, signed URLs, and targeted cache invalidation keep editing behavior outside public rendering and cached HTML.

For teams: Editors can make contextual page changes without searching through the admin, using either direct updates or the configured approval workflow.

Evidence: src/Support/EditableRegionRegistry.php, src/Actions/AuthorizeEditableRegionAction.php, src/Actions/ValidateEditableRegionPayloadAction.php, tests/Feature/EditableRegionEditingTest.php, docs/overview.admin.md, config/capell-frontend-authoring.php, src/Actions/UpdateEditableRegionAction.php, tests/Feature/EditRegionFieldTest.php.

Screens And Workflow

Section titled “Screens And Workflow”

Screenshot contract: docs/screenshots.json.

Capell app frontend authoring working on the public homepage Capell app frontend authoring working on the public homepage Capell app frontend authoring working on mobile Capell app frontend authoring working on mobile
  • Frontend page with authoring enabled for admins (frontend, supplementary evidence).
  • Capell app frontend authoring working on the public homepage (frontend, required evidence).
  • Capell app frontend authoring working on mobile (frontend, required evidence).
  • Beacon network request (admin, supplementary evidence).
  • Frontend authoring enabled/disabled configuration proof (admin, supplementary evidence).
  • Beacon network request with admin sidebar menu open (admin, supplementary evidence).

Technical Shape

Section titled “Technical Shape”
  • Service providers: Capell\FrontendAuthoring\Providers\FrontendAuthoringServiceProvider.
  • Config files: packages/frontend-authoring/config/capell-frontend-authoring.php.
  • Livewire components: EditRegionField.
  • Route files: packages/frontend-authoring/routes/web.php.
  • Extension contracts: EditableRegionApprovalWorkflow, EditableRegionEditorSurface.
  • Actions: AuthorizeEditableRegionAction, BuildAuthoringBannerContextAction, BuildBeaconResponseAction, BuildEditableRegionManifestAction, ClearAffectedCachedUrlsAction, CollectAffectedCachedUrlsAction, UpdateEditableRegionAction, ValidateEditableRegionPayloadAction.
  • Data objects: EditableRegionData, EditableRegionPayloadData.
  • Manifest contributions: route: Capell\FrontendAuthoring\Manifest\FrontendAuthoringRoutesContribution.
  • Health checks: Capell\FrontendAuthoring\Health\FrontendAuthoringHealthCheck.
  • Blade views: packages/frontend-authoring/resources/views/authoring/bootstrap-script.blade.php, packages/frontend-authoring/resources/views/components/page-data.blade.php, packages/frontend-authoring/resources/views/editor/filament-shell-assets.blade.php, packages/frontend-authoring/resources/views/editor/region.blade.php, packages/frontend-authoring/resources/views/livewire/edit-region-field.blade.php.
  • Cache tags: frontend-authoring.

Data Model

Section titled “Data Model”

This package has no schema impact. It extends Capell through route contributions instead of declaring package-owned tables.

Install Impact

Section titled “Install Impact”
  • Required packages: capell-app/admin, capell-app/core, capell-app/frontend, capell-app/html-cache.
  • Admin navigation: no admin page or resource contribution is declared.
  • Admin/editor extensions: none declared.
  • Permissions: frontend-authoring.edit.
  • Public routes: loads routes/web.php; registers FrontendAuthoringRoutesContribution.
  • Database changes: no package migrations declared.
  • Config: config/capell-frontend-authoring.php.
  • Settings: no package settings declared.
  • Queues or schedules: none declared.
  • Cache tags: frontend-authoring.
  • Commands: none declared.

Common Pitfalls

Section titled “Common Pitfalls”
  • Keep required Capell packages on compatible v4 releases: capell-app/admin, capell-app/core, capell-app/frontend, capell-app/html-cache.
  • Review package configuration before production-like verification: config/capell-frontend-authoring.php.
  • Review middleware, throttling, signatures, and public-output safety in routes/web.php before exposing routes.
  • Keep public Blade and cached HTML free of authoring markers, model IDs, permissions, signed editor URLs, and lazy database queries.
  • Custom write integrations must preserve invalidation for frontend-authoring cache tags.

Troubleshooting

Section titled “Troubleshooting”
Symptom Likely cause Check Fix
Package surface is missing after install Provider or manifest is not loaded Confirm capell.json, package composer.json, and provider registration Reinstall the package, refresh Composer autoload, and clear host caches
Route returns unexpected output Route cache, middleware, or signed URL setup does not match the package route file Check the route files listed in Technical Shape Clear route cache and verify middleware before exposing public routes
Public output leaks unexpected state Render data, cache variation, or authoring boundary has regressed Check public Blade, cache tags, and public-output safety tests Move data loading out of Blade and rerun the package public-output tests

Quick Start

Section titled “Quick Start”
  1. Install the package: composer require capell-app/frontend-authoring.
  2. Review config/capell-frontend-authoring.php before enabling the package.
  3. Open / and confirm the public output renders without admin state.

Next Steps

Section titled “Next Steps”